CRM/Mailing/Info.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  35  * $Id$
  36  *
  37  */
  38 class CRM_Mailing_Info extends CRM_Core_Component_Info {
  39
  40   /**
  41    * @inheritDoc
  42    */
  43   protected $keyword = 'mailing';
  44
  45
  46   /**
  47    * @inheritDoc
  48    * @return array
  49    */
  50   public function getInfo() {
  51     return array(
  52       'name' => 'CiviMail',
  53       'translatedName' => ts('CiviMail'),
  54       'title' => 'CiviCRM Mailing Engine',
  55       'search' => 1,
  56       'showActivitiesInCore' => 1,
  57     );
  58   }
  59
  60   /**
  61    * EXPERIMENTAL: Get a list of AngularJS modules
  62    *
  63    * @return array
  64    *   list of modules; same format as CRM_Utils_Hook::angularModules(&$angularModules)
  65    * @see CRM_Utils_Hook::angularModules
  66    */
  67   public function getAngularModules() {
  68     $result = array();
  69     $result['crmMailing'] = array(
  70       'ext' => 'civicrm',
  71       'js' => array(
  72         'js/angular-crmMailing.js',
  73         'js/angular-crmMailing/*.js',
  74       ),
  75       'css' => array('css/angular-crmMailing.css'),
  76       'partials' => array('partials/crmMailing'),
  77     );
  78     $result['crmMailingAB'] = array(
  79       'ext' => 'civicrm',
  80       'js' => array(
  81         'js/angular-crmMailingAB.js',
  82         'js/angular-crmMailingAB/*.js',
  83       ),
  84       'css' => array('css/angular-crmMailingAB.css'),
  85       'partials' => array('partials/crmMailingAB'),
  86     );
  87     $result['crmD3'] = array(
  88       'ext' => 'civicrm',
  89       'js' => array(
  90         'js/angular-crmD3.js',
  91         'bower_components/d3/d3.min.js',
  92       ),
  93     );
  94
  95     $config = CRM_Core_Config::singleton();
  96     $session = CRM_Core_Session::singleton();
  97     $contactID = $session->get('userID');
  98     $civiMails = civicrm_api3('Mailing', 'get', array());
  99     $campNames = civicrm_api3('Campaign', 'get', array());
 100     $mailingabNames = civicrm_api3('MailingAB', 'get', array());
 101     $mailStatus = civicrm_api3('MailingJob', 'get', array());
 102     $groupNames = civicrm_api3('Group', 'get', array());
 103     $headerfooterList = civicrm_api3('MailingComponent', 'get', array());
 104
 105     $emailAdd = civicrm_api3('Email', 'get', array(
 106       'sequential' => 1,
 107       'return' => "email",
 108       'contact_id' => $contactID,
 109     ));
 110     $mesTemplate = civicrm_api3('MessageTemplate', 'get', array(
 111       'sequential' => 1,
 112       'return' => array("msg_html", "id", "msg_title", "msg_subject", "msg_text"),
 113       'is_active' => 1,
 114       'workflow_id' => array('IS NULL' => ""),
 115     ));
 116     $mailGrp = civicrm_api3('MailingGroup', 'get', array());
 117     $mailTokens = civicrm_api3('Mailing', 'gettokens', array('entity' => array('contact', 'mailing'), 'sequential' => 1));
 118     $fromAddress = civicrm_api3('OptionGroup', 'get', array(
 119       'sequential' => 1,
 120       'name' => "from_email_address",
 121       'api.OptionValue.get' => array(),
 122     ));
 123     CRM_Core_Resources::singleton()->addSetting(array(
 124       'crmMailing' => array(
 125         'mailingabNames' => array_values($mailingabNames['values']),
 126         'civiMails' => array_values($civiMails['values']),
 127         'campNames' => array_values($campNames['values']),
 128         'mailStatus' => array_values($mailStatus['values']),
 129         'groupNames' => array_values($groupNames['values']),
 130         'headerfooterList' => array_values($headerfooterList['values']),
 131         'mesTemplate' => array_values($mesTemplate['values']),
 132         'emailAdd' => array_values($emailAdd['values']),
 133         'mailGrp' => array_values($mailGrp['values']),
 134         'mailTokens' => $mailTokens['values'],
 135         'contactid' => $contactID,
 136         'requiredTokens' => CRM_Utils_Token::getRequiredTokens(),
 137         'enableReplyTo' => isset($config->replyTo) ? $config->replyTo : 0,
 138         'fromAddress' => array_values($fromAddress['values'][0]['api.OptionValue.get']['values']),
 139         'defaultTestEmail' => civicrm_api3('Contact', 'getvalue', array(
 140             'id' => 'user_contact_id',
 141             'return' => 'email',
 142           )),
 143         'visibility' => array(
 144           array('value' => 'Public Pages', 'label' => ts('Public Pages')),
 145           array('value' => 'User and User Admin Only', 'label' => ts('User and User Admin Only')),
 146         ),
 147       ),
 148     ));
 149     CRM_Core_Resources::singleton()->addPermissions(array(
 150       'view all contacts',
 151     ));
 152
 153     return $result;
 154   }
 155
 156   /**
 157    * @return bool
 158    */
 159   public static function workflowEnabled() {
 160     $config = CRM_Core_Config::singleton();
 161
 162     // early exit, since not true for most
 163     if (!$config->userSystem->is_drupal ||
 164       !function_exists('module_exists')
 165     ) {
 166       return FALSE;
 167     }
 168
 169     if (!module_exists('rules')) {
 170       return FALSE;
 171     }
 172
 173     $enableWorkflow = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::MAILING_PREFERENCES_NAME,
 174       'civimail_workflow',
 175       NULL,
 176       FALSE
 177     );
 178
 179     return ($enableWorkflow &&
 180       $config->userSystem->is_drupal
 181     ) ? TRUE : FALSE;
 182   }
 183
 184   /**
 185    * @inheritDoc
 186    * @param bool $getAllUnconditionally
 187    *
 188    * @return array
 189    */
 190   public function getPermissions($getAllUnconditionally = FALSE) {
 191     $permissions = array(
 192       'access CiviMail',
 193       'access CiviMail subscribe/unsubscribe pages',
 194       'delete in CiviMail',
 195       'view public CiviMail content',
 196     );
 197
 198     if (self::workflowEnabled() || $getAllUnconditionally) {
 199       $permissions[] = 'create mailings';
 200       $permissions[] = 'schedule mailings';
 201       $permissions[] = 'approve mailings';
 202     }
 203
 204     return $permissions;
 205   }
 206
 207
 208   /**
 209    * @inheritDoc
 210    * @return null
 211    */
 212   public function getUserDashboardElement() {
 213     // no dashboard element for this component
 214     return NULL;
 215   }
 216
 217   /**
 218    * @return null
 219    */
 220   public function getUserDashboardObject() {
 221     // no dashboard element for this component
 222     return NULL;
 223   }
 224
 225   /**
 226    * @inheritDoc
 227    * @return array
 228    */
 229   public function registerTab() {
 230     return array(
 231       'title' => ts('Mailings'),
 232       'id' => 'mailing',
 233       'url' => 'mailing',
 234       'weight' => 45,
 235     );
 236   }
 237
 238   /**
 239    * @inheritDoc
 240    * @return array
 241    */
 242   public function registerAdvancedSearchPane() {
 243     return array(
 244       'title' => ts('Mailings'),
 245       'weight' => 20,
 246     );
 247   }
 248
 249   /**
 250    * @inheritDoc
 251    * @return null
 252    */
 253   public function getActivityTypes() {
 254     return NULL;
 255   }
 256
 257   /**
 258    * add shortcut to Create New.
 259    * @param $shortCuts
 260    */
 261   public function creatNewShortcut(&$shortCuts) {
 262   }
 263
 264 }