3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
29 * This class introduces component to the system and provides all the
30 * information about it. It needs to extend CRM_Core_Component_Info
34 * @copyright CiviCRM LLC (c) 2004-2015
38 class CRM_Mailing_Info
extends CRM_Core_Component_Info
{
43 protected $keyword = 'mailing';
50 public function getInfo() {
53 'translatedName' => ts('CiviMail'),
54 'title' => 'CiviCRM Mailing Engine',
56 'showActivitiesInCore' => 1,
61 * Get AngularJS modules and their dependencies
64 * list of modules; same format as CRM_Utils_Hook::angularModules(&$angularModules)
65 * @see CRM_Utils_Hook::angularModules
67 public function getAngularModules() {
69 $result['crmMailing'] = array(
73 'ang/crmMailing/*.js',
75 'css' => array('ang/crmMailing.css'),
76 'partials' => array('ang/crmMailing'),
78 $result['crmMailingAB'] = array(
81 'ang/crmMailingAB.js',
82 'ang/crmMailingAB/*.js',
83 'ang/crmMailingAB/*/*.js',
85 'css' => array('ang/crmMailingAB.css'),
86 'partials' => array('ang/crmMailingAB'),
88 $result['crmD3'] = array(
92 'bower_components/d3/d3.min.js',
96 $config = CRM_Core_Config
::singleton();
97 $session = CRM_Core_Session
::singleton();
98 $contactID = $session->get('userID');
101 // CRM-16155 - Limit to a reasonable number
102 $civiMails = civicrm_api3('Mailing', 'get', array(
104 'mailing_type' => array('IN' => array('standalone', 'winner')),
105 'return' => array('id', 'name', 'scheduled_date'),
109 'sort' => 'is_archived asc, scheduled_date desc',
114 'options' => array('limit' => 0),
118 $groupNames = civicrm_api3('Group', 'get', $params +
array(
120 'return' => array('title', 'visibility', 'group_type', 'is_hidden'),
122 $headerfooterList = civicrm_api3('MailingComponent', 'get', $params +
array(
124 'return' => array('name', 'component_type', 'is_default', 'body_html', 'body_text'),
127 $emailAdd = civicrm_api3('Email', 'get', array(
130 'contact_id' => $contactID,
133 // FIXME: Loading the contents of every template into the dom does not scale well
134 $mesTemplate = civicrm_api3('MessageTemplate', 'get', $params +
array(
137 'return' => array("msg_html", "id", "msg_title", "msg_subject", "msg_text"),
138 'workflow_id' => array('IS NULL' => ""),
140 $mailTokens = civicrm_api3('Mailing', 'gettokens', array(
141 'entity' => array('contact', 'mailing'),
144 $fromAddress = civicrm_api3('OptionValue', 'get', $params +
array(
145 'option_group_id' => "from_email_address",
147 CRM_Core_Resources
::singleton()
149 'crmMailing' => array(
150 'civiMails' => $civiMails['values'],
151 'campaignEnabled' => in_array('CiviCampaign', $config->enableComponents
),
152 'groupNames' => $groupNames['values'],
153 'headerfooterList' => $headerfooterList['values'],
154 'mesTemplate' => $mesTemplate['values'],
155 'emailAdd' => $emailAdd['values'],
156 'mailTokens' => $mailTokens['values'],
157 'contactid' => $contactID,
158 'requiredTokens' => CRM_Utils_Token
::getRequiredTokens(),
159 'enableReplyTo' => (int) CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::MAILING_PREFERENCES_NAME
, 'replyTo'),
160 'disableMandatoryTokensCheck' => (int) CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::MAILING_PREFERENCES_NAME
, 'disable_mandatory_tokens_check'),
161 'fromAddress' => $fromAddress['values'],
162 'defaultTestEmail' => civicrm_api3('Contact', 'getvalue', array(
163 'id' => 'user_contact_id',
166 'visibility' => CRM_Utils_Array
::makeNonAssociative(CRM_Core_SelectValues
::groupVisibility()),
167 'workflowEnabled' => CRM_Mailing_Info
::workflowEnabled(),
170 ->addPermissions(array(
176 'delete in CiviMail',
185 public static function workflowEnabled() {
186 $config = CRM_Core_Config
::singleton();
188 // early exit, since not true for most
189 if (!$config->userSystem
->is_drupal ||
190 !function_exists('module_exists')
195 if (!module_exists('rules')) {
199 $enableWorkflow = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::MAILING_PREFERENCES_NAME
,
205 return ($enableWorkflow &&
206 $config->userSystem
->is_drupal
212 * @param bool $getAllUnconditionally
213 * @param bool $descriptions
214 * Whether to return permission descriptions
218 public function getPermissions($getAllUnconditionally = FALSE, $descriptions = FALSE) {
219 $permissions = array(
220 'access CiviMail' => array(
221 ts('access CiviMail'),
223 'access CiviMail subscribe/unsubscribe pages' => array(
224 ts('access CiviMail subscribe/unsubscribe pages'),
225 ts('Subscribe/unsubscribe from mailing list group'),
227 'delete in CiviMail' => array(
228 ts('delete in CiviMail'),
229 ts('Delete Mailing'),
231 'view public CiviMail content' => array(
232 ts('view public CiviMail content'),
236 if (self
::workflowEnabled() ||
$getAllUnconditionally) {
237 $permissions[] = array(
238 'create mailings' => array(
239 ts('create mailings'),
242 $permissions[] = array(
243 'schedule mailings' => array(
244 ts('schedule mailings'),
247 $permissions[] = array(
248 'approve mailings' => array(
249 ts('approve mailings'),
254 if (!$descriptions) {
255 foreach ($permissions as $name => $attr) {
256 $permissions[$name] = array_shift($attr);
268 public function getUserDashboardElement() {
269 // no dashboard element for this component
276 public function getUserDashboardObject() {
277 // no dashboard element for this component
285 public function registerTab() {
287 'title' => ts('Mailings'),
298 public function registerAdvancedSearchPane() {
300 'title' => ts('Mailings'),
309 public function getActivityTypes() {
314 * add shortcut to Create New.
317 public function creatNewShortcut(&$shortCuts) {