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 'check_permissions' => TRUE,
121 'return' => array('title', 'visibility', 'group_type', 'is_hidden'),
123 $headerfooterList = civicrm_api3('MailingComponent', 'get', $params +
array(
125 'return' => array('name', 'component_type', 'is_default', 'body_html', 'body_text'),
128 $emailAdd = civicrm_api3('Email', 'get', array(
131 'contact_id' => $contactID,
134 // FIXME: Loading the contents of every template into the dom does not scale well
135 $mesTemplate = civicrm_api3('MessageTemplate', 'get', $params +
array(
138 'return' => array("msg_html", "id", "msg_title", "msg_subject", "msg_text"),
139 'workflow_id' => array('IS NULL' => ""),
141 $mailTokens = civicrm_api3('Mailing', 'gettokens', array(
142 'entity' => array('contact', 'mailing'),
145 $fromAddress = civicrm_api3('OptionValue', 'get', $params +
array(
146 'option_group_id' => "from_email_address",
147 'domain_id' => CRM_Core_Config
::domainID(),
149 CRM_Core_Resources
::singleton()
151 'crmMailing' => array(
152 'civiMails' => $civiMails['values'],
153 'campaignEnabled' => in_array('CiviCampaign', $config->enableComponents
),
154 'groupNames' => $groupNames['values'],
155 'headerfooterList' => $headerfooterList['values'],
156 'mesTemplate' => $mesTemplate['values'],
157 'emailAdd' => $emailAdd['values'],
158 'mailTokens' => $mailTokens['values'],
159 'contactid' => $contactID,
160 'requiredTokens' => CRM_Utils_Token
::getRequiredTokens(),
161 'enableReplyTo' => (int) CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::MAILING_PREFERENCES_NAME
, 'replyTo'),
162 'disableMandatoryTokensCheck' => (int) CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::MAILING_PREFERENCES_NAME
, 'disable_mandatory_tokens_check'),
163 'fromAddress' => $fromAddress['values'],
164 'defaultTestEmail' => civicrm_api3('Contact', 'getvalue', array(
165 'id' => 'user_contact_id',
168 'visibility' => CRM_Utils_Array
::makeNonAssociative(CRM_Core_SelectValues
::groupVisibility()),
169 'workflowEnabled' => CRM_Mailing_Info
::workflowEnabled(),
172 ->addPermissions(array(
178 'delete in CiviMail',
187 public static function workflowEnabled() {
188 $config = CRM_Core_Config
::singleton();
190 // early exit, since not true for most
191 if (!$config->userSystem
->is_drupal ||
192 !function_exists('module_exists')
197 if (!module_exists('rules')) {
201 $enableWorkflow = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::MAILING_PREFERENCES_NAME
,
207 return ($enableWorkflow &&
208 $config->userSystem
->is_drupal
214 * @param bool $getAllUnconditionally
215 * @param bool $descriptions
216 * Whether to return permission descriptions
220 public function getPermissions($getAllUnconditionally = FALSE, $descriptions = FALSE) {
221 $permissions = array(
222 'access CiviMail' => array(
223 ts('access CiviMail'),
225 'access CiviMail subscribe/unsubscribe pages' => array(
226 ts('access CiviMail subscribe/unsubscribe pages'),
227 ts('Subscribe/unsubscribe from mailing list group'),
229 'delete in CiviMail' => array(
230 ts('delete in CiviMail'),
231 ts('Delete Mailing'),
233 'view public CiviMail content' => array(
234 ts('view public CiviMail content'),
238 if (self
::workflowEnabled() ||
$getAllUnconditionally) {
239 $permissions[] = array(
240 'create mailings' => array(
241 ts('create mailings'),
244 $permissions[] = array(
245 'schedule mailings' => array(
246 ts('schedule mailings'),
249 $permissions[] = array(
250 'approve mailings' => array(
251 ts('approve mailings'),
256 if (!$descriptions) {
257 foreach ($permissions as $name => $attr) {
258 $permissions[$name] = array_shift($attr);
270 public function getUserDashboardElement() {
271 // no dashboard element for this component
278 public function getUserDashboardObject() {
279 // no dashboard element for this component
287 public function registerTab() {
289 'title' => ts('Mailings'),
300 public function registerAdvancedSearchPane() {
302 'title' => ts('Mailings'),
311 public function getActivityTypes() {
316 * add shortcut to Create New.
319 public function creatNewShortcut(&$shortCuts) {