CRM/Contact/Task.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  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2014
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * class to represent the actions that can be performed on a group of contacts
  38  * used by the search forms
  39  *
  40  */
  41 class CRM_Contact_Task {
  42   const
  43     GROUP_CONTACTS = 1,
  44     REMOVE_CONTACTS = 2,
  45     TAG_CONTACTS = 3,
  46     REMOVE_TAGS = 4,
  47     EXPORT_CONTACTS = 5,
  48     EMAIL_CONTACTS = 6,
  49     SMS_CONTACTS = 7,
  50     DELETE_CONTACTS = 8,
  51     HOUSEHOLD_CONTACTS = 9,
  52     ORGANIZATION_CONTACTS = 10,
  53     RECORD_CONTACTS = 11,
  54     MAP_CONTACTS = 12,
  55     SAVE_SEARCH = 13,
  56     SAVE_SEARCH_UPDATE = 14,
  57     PRINT_CONTACTS = 15,
  58     LABEL_CONTACTS = 16,
  59     BATCH_UPDATE = 17,
  60     ADD_EVENT = 18,
  61     PRINT_FOR_CONTACTS = 19,
  62     CREATE_MAILING = 20,
  63     MERGE_CONTACTS = 21,
  64     EMAIL_UNHOLD = 22,
  65     RESTORE = 23,
  66     DELETE_PERMANENTLY = 24,
  67     COMMUNICATION_PREFS = 25;
  68
  69   /**
  70    * The task array
  71    *
  72    * @var array
  73    */
  74   static $_tasks = NULL;
  75
  76   /**
  77    * The optional task array
  78    *
  79    * @var array
  80    */
  81   static $_optionalTasks = NULL;
  82
  83   public static function initTasks() {
  84     if (!self::$_tasks) {
  85       self::$_tasks = array(
  86         self::GROUP_CONTACTS => array(
  87           'title' => ts('Add Contacts to Group'),
  88           'class' => 'CRM_Contact_Form_Task_AddToGroup',
  89         ),
  90         self::REMOVE_CONTACTS => array(
  91           'title' => ts('Remove Contacts from Group'),
  92           'class' => 'CRM_Contact_Form_Task_RemoveFromGroup',
  93         ),
  94         self::TAG_CONTACTS => array(
  95           'title' => ts('Tag Contacts (assign tags)'),
  96           'class' => 'CRM_Contact_Form_Task_AddToTag',
  97         ),
  98         self::REMOVE_TAGS => array(
  99           'title' => ts('Untag Contacts (remove tags)'),
 100           'class' => 'CRM_Contact_Form_Task_RemoveFromTag',
 101         ),
 102         self::EXPORT_CONTACTS => array(
 103           'title' => ts('Export Contacts'),
 104           'class' => array(
 105             'CRM_Export_Form_Select',
 106             'CRM_Export_Form_Map',
 107           ),
 108           'result' => FALSE,
 109         ),
 110         self::EMAIL_CONTACTS => array(
 111           'title' => ts('Send Email to Contacts'),
 112           'class' => 'CRM_Contact_Form_Task_Email',
 113           'result' => TRUE,
 114         ),
 115         self::SMS_CONTACTS => array(
 116           'title' => ts('Send SMS to Contacts'),
 117           'class' => 'CRM_Contact_Form_Task_SMS',
 118           'result' => TRUE,
 119         ),
 120         self::DELETE_CONTACTS => array(
 121           'title' => ts('Delete Contacts'),
 122           'class' => 'CRM_Contact_Form_Task_Delete',
 123           'result' => FALSE,
 124         ),
 125         self::RECORD_CONTACTS => array(
 126           'title' => ts('Record Activity for Contacts'),
 127           'class' => 'CRM_Activity_Form_Activity',
 128         ),
 129         self::SAVE_SEARCH => array(
 130           'title' => ts('New Smart Group'),
 131           'class' => 'CRM_Contact_Form_Task_SaveSearch',
 132           'result' => TRUE,
 133         ),
 134         self::SAVE_SEARCH_UPDATE => array(
 135           'title' => ts('Update Smart Group'),
 136           'class' => 'CRM_Contact_Form_Task_SaveSearch_Update',
 137           'result' => TRUE,
 138         ),
 139         self::PRINT_CONTACTS => array(
 140           'title' => ts('Print Selected Rows'),
 141           'class' => 'CRM_Contact_Form_Task_Print',
 142           'result' => FALSE,
 143         ),
 144         self::LABEL_CONTACTS => array(
 145           'title' => ts('Mailing Labels'),
 146           'class' => 'CRM_Contact_Form_Task_Label',
 147           'result' => TRUE,
 148         ),
 149         self::BATCH_UPDATE => array(
 150           'title' => ts('Batch Update via Profile'),
 151           'class' => array(
 152             'CRM_Contact_Form_Task_PickProfile',
 153             'CRM_Contact_Form_Task_Batch',
 154           ),
 155           'result' => TRUE,
 156         ),
 157         self::PRINT_FOR_CONTACTS => array(
 158           'title' => ts('Print PDF Letter for Contacts'),
 159           'class' => 'CRM_Contact_Form_Task_PDF',
 160           'result' => TRUE,
 161         ),
 162         self::EMAIL_UNHOLD => array(
 163           'title' => ts('Unhold Emails'),
 164           'class' => 'CRM_Contact_Form_Task_Unhold',
 165         ),
 166         self::COMMUNICATION_PREFS => array(
 167           'title' => ts('Alter Contact Communication Preferences'),
 168           'class' => 'CRM_Contact_Form_Task_AlterPreferences',
 169         ),
 170         self::RESTORE => array(
 171           'title' => ts('Restore Contacts'),
 172           'class' => 'CRM_Contact_Form_Task_Delete',
 173           'result' => FALSE,
 174         ),
 175         self::DELETE_PERMANENTLY => array(
 176           'title' => ts('Delete Permanently'),
 177           'class' => 'CRM_Contact_Form_Task_Delete',
 178           'result' => FALSE,
 179         ),
 180       );
 181
 182       if (CRM_Contact_BAO_ContactType::isActive('Household')) {
 183         $label = CRM_Contact_BAO_ContactType::getLabel('Household');
 184         self::$_tasks[self::HOUSEHOLD_CONTACTS] = array(
 185           'title' => ts('Add Contacts to %1',
 186             array(1 => $label)
 187           ),
 188           'class' => 'CRM_Contact_Form_Task_AddToHousehold',
 189         );
 190       }
 191
 192       if (CRM_Contact_BAO_ContactType::isActive('Organization')) {
 193         $label = CRM_Contact_BAO_ContactType::getLabel('Organization');
 194         self::$_tasks[self::ORGANIZATION_CONTACTS] = array(
 195           'title' => ts('Add Contacts to %1',
 196             array(1 => $label)
 197           ),
 198           'class' => 'CRM_Contact_Form_Task_AddToOrganization',
 199         );
 200       }
 201
 202       if (CRM_Core_Permission::check('merge duplicate contacts')) {
 203         self::$_tasks[self::MERGE_CONTACTS] = array(
 204           'title' => ts('Merge Contacts'),
 205           'class' => 'CRM_Contact_Form_Task_Merge',
 206           'result' => TRUE,
 207         );
 208       }
 209
 210       //CRM-4418, check for delete
 211       if (!CRM_Core_Permission::check('delete contacts')) {
 212         unset(self::$_tasks[self::DELETE_CONTACTS]);
 213       }
 214
 215       //show map action only if map provider and geoprovider are set (Google doesn't need geoprovider)
 216       // should fix this to be more flexible as providers are added ??
 217       $config = CRM_Core_Config::singleton();
 218
 219       if ($config->mapProvider &&
 220         ($config->mapProvider == 'Google' ||
 221           ($config->mapProvider == 'OpenStreetMaps' ||
 222             $config->geoProvider == 'Google'
 223           )
 224         )
 225       ) {
 226         self::$_tasks[self::MAP_CONTACTS] = array(
 227           'title' => ts('Map Contacts'),
 228           'class' => 'CRM_Contact_Form_Task_Map',
 229           'result' => FALSE,
 230         );
 231       }
 232
 233       if (CRM_Core_Permission::access('CiviEvent')) {
 234         self::$_tasks[self::ADD_EVENT] = array(
 235           'title' => ts('Add Contacts to Event'),
 236           'class' => 'CRM_Event_Form_Participant',
 237         );
 238       }
 239
 240       if (CRM_Core_Permission::access('CiviMail')) {
 241         self::$_tasks[self::CREATE_MAILING] = array(
 242           'title' => ts('Schedule/Send a Mass Mailing'),
 243           'class' => array(
 244             'CRM_Mailing_Form_Group',
 245             'CRM_Mailing_Form_Settings',
 246             'CRM_Mailing_Form_Upload',
 247             'CRM_Mailing_Form_Test',
 248             'CRM_Mailing_Form_Schedule',
 249           ),
 250           'result' => FALSE,
 251         );
 252       }
 253       elseif (CRM_Mailing_Info::workflowEnabled() &&
 254         CRM_Core_Permission::check('create mailings')
 255       ) {
 256         self::$_tasks[self::CREATE_MAILING] = array(
 257           'title' => ts('Create a Mass Mailing'),
 258           'class' => array(
 259             'CRM_Mailing_Form_Group',
 260             'CRM_Mailing_Form_Settings',
 261             'CRM_Mailing_Form_Upload',
 262             'CRM_Mailing_Form_Test',
 263           ),
 264           'result' => FALSE,
 265         );
 266       }
 267
 268       self::$_tasks += CRM_Core_Component::taskList();
 269
 270       CRM_Utils_Hook::searchTasks('contact', self::$_tasks);
 271
 272       asort(self::$_tasks);
 273     }
 274   }
 275
 276   /**
 277    * These tasks are the core set of tasks that the user can perform
 278    * on a contact / group of contacts
 279    *
 280    * @return array
 281    *   the set of tasks for a group of contacts
 282    */
 283   public static function &taskTitles() {
 284     self::initTasks();
 285
 286     $titles = array();
 287     foreach (self::$_tasks as $id => $value) {
 288       $titles[$id] = $value['title'];
 289     }
 290
 291     // hack unset update saved search
 292     unset($titles[self::SAVE_SEARCH_UPDATE]);
 293
 294     if (!CRM_Utils_Mail::validOutBoundMail()) {
 295       unset($titles[self::EMAIL_CONTACTS]);
 296       unset($titles[self::CREATE_MAILING]);
 297     }
 298
 299     // CRM-6806
 300     if (!CRM_Core_Permission::check('access deleted contacts') ||
 301       !CRM_Core_Permission::check('delete contacts')
 302     ) {
 303       unset($titles[self::DELETE_PERMANENTLY]);
 304     }
 305     asort($titles);
 306     return $titles;
 307   }
 308
 309   /**
 310    * Show tasks selectively based on the permission level
 311    * of the user
 312    *
 313    * @param int $permission
 314    * @param bool $deletedContacts
 315    *   Are these tasks for operating on deleted contacts?.
 316    *
 317    * @return array
 318    *   set of tasks that are valid for the user
 319    */
 320   public static function &permissionedTaskTitles($permission, $deletedContacts = FALSE) {
 321     self::initTasks();
 322     $tasks = array();
 323     if ($deletedContacts) {
 324       if (CRM_Core_Permission::check('access deleted contacts')) {
 325         $tasks[self::RESTORE] = self::$_tasks[self::RESTORE]['title'];
 326         if (CRM_Core_Permission::check('delete contacts')) {
 327           $tasks[self::DELETE_PERMANENTLY] = self::$_tasks[self::DELETE_PERMANENTLY]['title'];
 328         }
 329       }
 330     }
 331     elseif ($permission == CRM_Core_Permission::EDIT) {
 332       $tasks = self::taskTitles();
 333     }
 334     else {
 335       $tasks = array(
 336         self::EXPORT_CONTACTS => self::$_tasks[self::EXPORT_CONTACTS]['title'],
 337         self::EMAIL_CONTACTS => self::$_tasks[self::EMAIL_CONTACTS]['title'],
 338         self::LABEL_CONTACTS => self::$_tasks[self::LABEL_CONTACTS]['title'],
 339       );
 340
 341       if (isset(self::$_tasks[self::MAP_CONTACTS]) &&
 342         !empty(self::$_tasks[self::MAP_CONTACTS]['title'])
 343       ) {
 344         $tasks[self::MAP_CONTACTS] = self::$_tasks[self::MAP_CONTACTS]['title'];
 345       }
 346
 347       if (isset(self::$_tasks[self::CREATE_MAILING]) &&
 348         !empty(self::$_tasks[self::CREATE_MAILING]['title'])
 349       ) {
 350         $tasks[self::CREATE_MAILING] = self::$_tasks[self::CREATE_MAILING]['title'];
 351       }
 352     }
 353     return $tasks;
 354   }
 355
 356   /**
 357    * These tasks get added based on the context the user is in
 358    *
 359    * @return array
 360    *   the set of optional tasks for a group of contacts
 361    */
 362   public static function &optionalTaskTitle() {
 363     $tasks = array(
 364       self::SAVE_SEARCH_UPDATE => self::$_tasks[self::SAVE_SEARCH_UPDATE]['title'],
 365     );
 366     return $tasks;
 367   }
 368
 369   /**
 370    * @param $value
 371    *
 372    * @return array
 373    */
 374   public static function getTask($value) {
 375     self::initTasks();
 376
 377     if (!CRM_Utils_Array::value($value, self::$_tasks)) {
 378       // make it the print task by default
 379       $value = self::PRINT_CONTACTS;
 380     }
 381     return array(
 382       CRM_Utils_Array::value('class', self::$_tasks[$value]),
 383       CRM_Utils_Array::value('result', self::$_tasks[$value]),
 384     );
 385   }
 386
 387 }