CRM/Mailing/Info.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  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.   |
  13  |                                                                    |
  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.        |
  18  |                                                                    |
  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  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  * This class introduces component to the system and provides all the
  30  * information about it. It needs to extend CRM_Core_Component_Info
  31  * abstract class.
  32  *
  33  * @package CRM
  34  * @copyright CiviCRM LLC (c) 2004-2019
  35  */
  36 class CRM_Mailing_Info extends CRM_Core_Component_Info {
  37
  38   /**
  39    * @inheritDoc
  40    */
  41   protected $keyword = 'mailing';
  42
  43
  44   /**
  45    * @inheritDoc
  46    * @return array
  47    */
  48   public function getInfo() {
  49     return [
  50       'name' => 'CiviMail',
  51       'translatedName' => ts('CiviMail'),
  52       'title' => ts('CiviCRM Mailing Engine'),
  53       'search' => 1,
  54       'showActivitiesInCore' => 1,
  55     ];
  56   }
  57
  58   /**
  59    * Get AngularJS modules and their dependencies.
  60    *
  61    * @return array
  62    *   list of modules; same format as CRM_Utils_Hook::angularModules(&$angularModules)
  63    * @see CRM_Utils_Hook::angularModules
  64    */
  65   public function getAngularModules() {
  66     // load angular files only if valid permissions are granted to the user
  67     if (!CRM_Core_Permission::check('access CiviMail')
  68       && !CRM_Core_Permission::check('create mailings')
  69       && !CRM_Core_Permission::check('schedule mailings')
  70       && !CRM_Core_Permission::check('approve mailings')
  71     ) {
  72       return [];
  73     }
  74     global $civicrm_root;
  75
  76     $reportIds = [];
  77     $reportTypes = ['detail', 'opened', 'bounce', 'clicks'];
  78     foreach ($reportTypes as $report) {
  79       $result = civicrm_api3('ReportInstance', 'get', [
  80         'sequential' => 1,
  81         'report_id' => 'mailing/' . $report]);
  82       if (!empty($result['values'])) {
  83         $reportIds[$report] = $result['values'][0]['id'];
  84       }
  85     }
  86     $result = [];
  87     $result['crmMailing'] = include "$civicrm_root/ang/crmMailing.ang.php";
  88     $result['crmMailingAB'] = include "$civicrm_root/ang/crmMailingAB.ang.php";
  89     $result['crmD3'] = include "$civicrm_root/ang/crmD3.ang.php";
  90
  91     $config = CRM_Core_Config::singleton();
  92     $session = CRM_Core_Session::singleton();
  93     $contactID = $session->get('userID');
  94
  95     // Generic params.
  96     $params = [
  97       'options' => ['limit' => 0],
  98       'sequential' => 1,
  99     ];
 100     $groupNames = civicrm_api3('Group', 'get', $params + [
 101       'is_active' => 1,
 102       'check_permissions' => TRUE,
 103       'return' => ['title', 'visibility', 'group_type', 'is_hidden'],
 104     ]);
 105     $headerfooterList = civicrm_api3('MailingComponent', 'get', $params + [
 106       'is_active' => 1,
 107       'return' => ['name', 'component_type', 'is_default', 'body_html', 'body_text'],
 108     ]);
 109
 110     $emailAdd = civicrm_api3('Email', 'get', [
 111       'sequential' => 1,
 112       'return' => "email",
 113       'contact_id' => $contactID,
 114     ]);
 115
 116     $mesTemplate = civicrm_api3('MessageTemplate', 'get', $params + [
 117       'sequential' => 1,
 118       'is_active' => 1,
 119       'return' => ["id", "msg_title"],
 120       'workflow_id' => ['IS NULL' => ""],
 121     ]);
 122     $mailTokens = civicrm_api3('Mailing', 'gettokens', [
 123       'entity' => ['contact', 'mailing'],
 124       'sequential' => 1,
 125     ]);
 126     $fromAddress = civicrm_api3('OptionValue', 'get', $params + [
 127       'option_group_id' => "from_email_address",
 128       'domain_id' => CRM_Core_Config::domainID(),
 129     ]);
 130     $enabledLanguages = CRM_Core_I18n::languages(TRUE);
 131     $isMultiLingual = (count($enabledLanguages) > 1);
 132     // FlexMailer is a refactoring of CiviMail which provides new hooks/APIs/docs. If the sysadmin has opted to enable it, then use that instead of CiviMail.
 133     $requiredTokens = defined('CIVICRM_FLEXMAILER_HACK_REQUIRED_TOKENS') ? Civi\Core\Resolver::singleton()->call(CIVICRM_FLEXMAILER_HACK_REQUIRED_TOKENS, []) : CRM_Utils_Token::getRequiredTokens();
 134     CRM_Core_Resources::singleton()
 135       ->addSetting([
 136         'crmMailing' => [
 137           'templateTypes' => CRM_Mailing_BAO_Mailing::getTemplateTypes(),
 138           'civiMails' => [],
 139           'campaignEnabled' => in_array('CiviCampaign', $config->enableComponents),
 140           'groupNames' => [],
 141           // @todo this is not used in core. Remove once Mosaico no longer depends on it.
 142           'testGroupNames' => $groupNames['values'],
 143           'headerfooterList' => $headerfooterList['values'],
 144           'mesTemplate' => $mesTemplate['values'],
 145           'emailAdd' => $emailAdd['values'],
 146           'mailTokens' => $mailTokens['values'],
 147           'contactid' => $contactID,
 148           'requiredTokens' => $requiredTokens,
 149           'enableReplyTo' => (int) Civi::settings()->get('replyTo'),
 150           'disableMandatoryTokensCheck' => (int) Civi::settings()->get('disable_mandatory_tokens_check'),
 151           'fromAddress' => $fromAddress['values'],
 152           'defaultTestEmail' => civicrm_api3('Contact', 'getvalue', [
 153               'id' => 'user_contact_id',
 154               'return' => 'email',
 155             ]),
 156           'visibility' => CRM_Utils_Array::makeNonAssociative(CRM_Core_SelectValues::groupVisibility()),
 157           'workflowEnabled' => CRM_Mailing_Info::workflowEnabled(),
 158           'reportIds' => $reportIds,
 159           'enabledLanguages' => $enabledLanguages,
 160           'isMultiLingual' => $isMultiLingual,
 161         ],
 162       ])
 163       ->addPermissions([
 164         'view all contacts',
 165         'edit all contacts',
 166         'access CiviMail',
 167         'create mailings',
 168         'schedule mailings',
 169         'approve mailings',
 170         'delete in CiviMail',
 171         'edit message templates',
 172       ]);
 173
 174     return $result;
 175   }
 176
 177   /**
 178    * @return bool
 179    */
 180   public static function workflowEnabled() {
 181     $config = CRM_Core_Config::singleton();
 182
 183     // early exit, since not true for most
 184     if (!$config->userSystem->is_drupal ||
 185       !function_exists('module_exists')
 186     ) {
 187       return FALSE;
 188     }
 189
 190     if (!module_exists('rules')) {
 191       return FALSE;
 192     }
 193
 194     $enableWorkflow = Civi::settings()->get('civimail_workflow');
 195
 196     return ($enableWorkflow &&
 197       $config->userSystem->is_drupal
 198     ) ? TRUE : FALSE;
 199   }
 200
 201   /**
 202    * @inheritDoc
 203    * @param bool $getAllUnconditionally
 204    * @param bool $descriptions
 205    *   Whether to return permission descriptions
 206    *
 207    * @return array
 208    */
 209   public function getPermissions($getAllUnconditionally = FALSE, $descriptions = FALSE) {
 210     $permissions = [
 211       'access CiviMail' => [
 212         ts('access CiviMail'),
 213       ],
 214       'access CiviMail subscribe/unsubscribe pages' => [
 215         ts('access CiviMail subscribe/unsubscribe pages'),
 216         ts('Subscribe/unsubscribe from mailing list group'),
 217       ],
 218       'delete in CiviMail' => [
 219         ts('delete in CiviMail'),
 220         ts('Delete Mailing'),
 221       ],
 222       'view public CiviMail content' => [
 223         ts('view public CiviMail content'),
 224       ],
 225     ];
 226
 227     if (self::workflowEnabled() || $getAllUnconditionally) {
 228       $permissions['create mailings'] = [
 229         ts('create mailings'),
 230       ];
 231       $permissions['schedule mailings'] = [
 232         ts('schedule mailings'),
 233       ];
 234       $permissions['approve mailings'] = [
 235         ts('approve mailings'),
 236       ];
 237     }
 238
 239     if (!$descriptions) {
 240       foreach ($permissions as $name => $attr) {
 241         $permissions[$name] = array_shift($attr);
 242       }
 243     }
 244
 245     return $permissions;
 246   }
 247
 248
 249   /**
 250    * @inheritDoc
 251    * @return null
 252    */
 253   public function getUserDashboardElement() {
 254     // no dashboard element for this component
 255     return NULL;
 256   }
 257
 258   /**
 259    * @return null
 260    */
 261   public function getUserDashboardObject() {
 262     // no dashboard element for this component
 263     return NULL;
 264   }
 265
 266   /**
 267    * @inheritDoc
 268    * @return array
 269    */
 270   public function registerTab() {
 271     return [
 272       'title' => ts('Mailings'),
 273       'id' => 'mailing',
 274       'url' => 'mailing',
 275       'weight' => 45,
 276     ];
 277   }
 278
 279   /**
 280    * @inheritDoc
 281    * @return string
 282    */
 283   public function getIcon() {
 284     return 'crm-i fa-envelope-o';
 285   }
 286
 287   /**
 288    * @inheritDoc
 289    * @return array
 290    */
 291   public function registerAdvancedSearchPane() {
 292     return [
 293       'title' => ts('Mailings'),
 294       'weight' => 20,
 295     ];
 296   }
 297
 298   /**
 299    * @inheritDoc
 300    * @return null
 301    */
 302   public function getActivityTypes() {
 303     return NULL;
 304   }
 305
 306   /**
 307    * add shortcut to Create New.
 308    * @param $shortCuts
 309    */
 310   public function creatNewShortcut(&$shortCuts) {
 311   }
 312
 313 }