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