| 1 | <?php |
| 2 | /* |
| 3 | +--------------------------------------------------------------------+ |
| 4 | | Copyright CiviCRM LLC. All rights reserved. | |
| 5 | | | |
| 6 | | This work is published under the GNU AGPLv3 license with some | |
| 7 | | permitted exceptions and without any warranty. For full license | |
| 8 | | and copyright information, see https://civicrm.org/licensing | |
| 9 | +--------------------------------------------------------------------+ |
| 10 | */ |
| 11 | |
| 12 | /** |
| 13 | * |
| 14 | * @package CRM |
| 15 | * @copyright CiviCRM LLC https://civicrm.org/licensing |
| 16 | */ |
| 17 | |
| 18 | /** |
| 19 | * Class to represent the actions that can be performed on a group of contacts used by the search forms. |
| 20 | */ |
| 21 | class CRM_Contact_Task extends CRM_Core_Task { |
| 22 | |
| 23 | /** |
| 24 | * Contact tasks |
| 25 | */ |
| 26 | const |
| 27 | HOUSEHOLD_CONTACTS = 101, |
| 28 | ORGANIZATION_CONTACTS = 102, |
| 29 | RECORD_CONTACTS = 103, |
| 30 | MAP_CONTACTS = 104, |
| 31 | ADD_EVENT = 105, |
| 32 | MERGE_CONTACTS = 106, |
| 33 | EMAIL_UNHOLD = 107, |
| 34 | RESTORE = 108, |
| 35 | COMMUNICATION_PREFS = 109, |
| 36 | INDIVIDUAL_CONTACTS = 110, |
| 37 | ADD_TO_CASE = 111; |
| 38 | |
| 39 | /** |
| 40 | * @var string |
| 41 | */ |
| 42 | public static $objectType = 'contact'; |
| 43 | |
| 44 | public static function tasks() { |
| 45 | if (!self::$_tasks) { |
| 46 | self::$_tasks = [ |
| 47 | self::GROUP_ADD => [ |
| 48 | 'title' => ts('Group - add contacts'), |
| 49 | 'class' => 'CRM_Contact_Form_Task_AddToGroup', |
| 50 | 'url' => 'civicrm/task/add-to-group', |
| 51 | 'icon' => 'fa-user-plus', |
| 52 | ], |
| 53 | self::GROUP_REMOVE => [ |
| 54 | 'title' => ts('Group - remove contacts'), |
| 55 | 'class' => 'CRM_Contact_Form_Task_RemoveFromGroup', |
| 56 | 'url' => 'civicrm/task/remove-from-group', |
| 57 | 'icon' => 'fa-user-plus', |
| 58 | ], |
| 59 | self::TAG_ADD => [ |
| 60 | 'title' => ts('Tag - add to contacts'), |
| 61 | 'class' => 'CRM_Contact_Form_Task_AddToTag', |
| 62 | 'url' => 'civicrm/task/add-to-tag', |
| 63 | 'icon' => 'fa-tags', |
| 64 | ], |
| 65 | self::TAG_REMOVE => [ |
| 66 | 'title' => ts('Tag - remove from contacts'), |
| 67 | 'class' => 'CRM_Contact_Form_Task_RemoveFromTag', |
| 68 | 'url' => 'civicrm/task/remove-from-tag', |
| 69 | 'icon' => 'fa-tag', |
| 70 | ], |
| 71 | self::TASK_EXPORT => [ |
| 72 | 'title' => ts('Export contacts'), |
| 73 | 'class' => [ |
| 74 | 'CRM_Contact_Export_Form_Select', |
| 75 | 'CRM_Contact_Export_Form_Map', |
| 76 | ], |
| 77 | 'result' => FALSE, |
| 78 | ], |
| 79 | self::TASK_EMAIL => [ |
| 80 | 'title' => ts('Email - send now (to %1 or less)', [ |
| 81 | 1 => Civi::settings() |
| 82 | ->get('simple_mail_limit'), |
| 83 | ]), |
| 84 | 'class' => 'CRM_Contact_Form_Task_Email', |
| 85 | 'result' => TRUE, |
| 86 | 'url' => 'civicrm/task/send-email', |
| 87 | 'icon' => 'fa-paper-plane-o', |
| 88 | ], |
| 89 | self::TASK_DELETE => [ |
| 90 | 'title' => ts('Delete contacts'), |
| 91 | 'class' => 'CRM_Contact_Form_Task_Delete', |
| 92 | 'result' => FALSE, |
| 93 | 'url' => 'civicrm/task/delete-contact', |
| 94 | 'icon' => 'fa-trash', |
| 95 | ], |
| 96 | self::RECORD_CONTACTS => [ |
| 97 | 'title' => ts('Add activity'), |
| 98 | 'class' => 'CRM_Activity_Form_Activity', |
| 99 | ], |
| 100 | self::SAVE_SEARCH => [ |
| 101 | 'title' => ts('Group - create smart group'), |
| 102 | 'class' => 'CRM_Contact_Form_Task_SaveSearch', |
| 103 | 'result' => TRUE, |
| 104 | ], |
| 105 | self::SAVE_SEARCH_UPDATE => [ |
| 106 | 'title' => ts('Group - update smart group'), |
| 107 | 'class' => 'CRM_Contact_Form_Task_SaveSearch_Update', |
| 108 | 'result' => TRUE, |
| 109 | ], |
| 110 | self::TASK_PRINT => [ |
| 111 | 'title' => ts('Print selected rows'), |
| 112 | 'class' => 'CRM_Contact_Form_Task_Print', |
| 113 | 'result' => FALSE, |
| 114 | ], |
| 115 | self::LABEL_CONTACTS => [ |
| 116 | 'title' => ts('Mailing labels - print'), |
| 117 | 'class' => 'CRM_Contact_Form_Task_Label', |
| 118 | 'result' => TRUE, |
| 119 | 'url' => 'civicrm/task/make-mailing-label', |
| 120 | 'icon' => 'fa-print', |
| 121 | ], |
| 122 | self::BATCH_UPDATE => [ |
| 123 | 'title' => ts('Update multiple contacts'), |
| 124 | 'class' => [ |
| 125 | 'CRM_Contact_Form_Task_PickProfile', |
| 126 | 'CRM_Contact_Form_Task_Batch', |
| 127 | ], |
| 128 | 'result' => TRUE, |
| 129 | 'url' => 'civicrm/task/pick-profile', |
| 130 | 'icon' => 'fa-pencil', |
| 131 | ], |
| 132 | self::PDF_LETTER => [ |
| 133 | 'title' => ts('Print/merge document'), |
| 134 | 'class' => 'CRM_Contact_Form_Task_PDF', |
| 135 | 'result' => TRUE, |
| 136 | 'url' => 'civicrm/task/print-document', |
| 137 | 'icon' => 'fa-file-pdf-o', |
| 138 | ], |
| 139 | self::EMAIL_UNHOLD => [ |
| 140 | 'title' => ts('Email - unhold addresses'), |
| 141 | 'class' => 'CRM_Contact_Form_Task_Unhold', |
| 142 | 'url' => 'civicrm/task/unhold-email', |
| 143 | 'icon' => 'fa-unlock', |
| 144 | ], |
| 145 | self::COMMUNICATION_PREFS => [ |
| 146 | 'title' => ts('Communication preferences - alter'), |
| 147 | 'class' => 'CRM_Contact_Form_Task_AlterPreferences', |
| 148 | 'url' => 'civicrm/task/alter-contact-preference', |
| 149 | 'icon' => 'fa-check-square-o', |
| 150 | ], |
| 151 | self::RESTORE => [ |
| 152 | 'title' => ts('Restore contacts from trash'), |
| 153 | 'class' => 'CRM_Contact_Form_Task_Delete', |
| 154 | 'result' => FALSE, |
| 155 | ], |
| 156 | self::DELETE_PERMANENTLY => [ |
| 157 | 'title' => ts('Delete permanently'), |
| 158 | 'class' => 'CRM_Contact_Form_Task_Delete', |
| 159 | 'result' => FALSE, |
| 160 | ], |
| 161 | ]; |
| 162 | |
| 163 | //CRM-16329, if SMS provider is configured show sms action. |
| 164 | $providersCount = CRM_SMS_BAO_Provider::activeProviderCount(); |
| 165 | if ($providersCount && CRM_Core_Permission::check('send SMS')) { |
| 166 | self::$_tasks[self::TASK_SMS] = [ |
| 167 | 'title' => ts('SMS - schedule/send'), |
| 168 | 'class' => 'CRM_Contact_Form_Task_SMS', |
| 169 | 'result' => TRUE, |
| 170 | ]; |
| 171 | } |
| 172 | |
| 173 | if (CRM_Contact_BAO_ContactType::isActive('Individual')) { |
| 174 | $label = CRM_Contact_BAO_ContactType::getLabel('Individual'); |
| 175 | self::$_tasks[self::INDIVIDUAL_CONTACTS] = [ |
| 176 | 'title' => ts('Add relationship - to %1', |
| 177 | [1 => $label] |
| 178 | ), |
| 179 | 'class' => 'CRM_Contact_Form_Task_AddToIndividual', |
| 180 | ]; |
| 181 | } |
| 182 | |
| 183 | if (CRM_Contact_BAO_ContactType::isActive('Household')) { |
| 184 | $label = CRM_Contact_BAO_ContactType::getLabel('Household'); |
| 185 | self::$_tasks[self::HOUSEHOLD_CONTACTS] = [ |
| 186 | 'title' => ts('Add relationship - to %1', |
| 187 | [1 => $label] |
| 188 | ), |
| 189 | 'class' => 'CRM_Contact_Form_Task_AddToHousehold', |
| 190 | ]; |
| 191 | } |
| 192 | |
| 193 | if (CRM_Contact_BAO_ContactType::isActive('Organization')) { |
| 194 | $label = CRM_Contact_BAO_ContactType::getLabel('Organization'); |
| 195 | self::$_tasks[self::ORGANIZATION_CONTACTS] = [ |
| 196 | 'title' => ts('Add relationship - to %1', |
| 197 | [1 => $label] |
| 198 | ), |
| 199 | 'class' => 'CRM_Contact_Form_Task_AddToOrganization', |
| 200 | ]; |
| 201 | } |
| 202 | |
| 203 | if (CRM_Core_Permission::check('merge duplicate contacts')) { |
| 204 | self::$_tasks[self::MERGE_CONTACTS] = [ |
| 205 | 'title' => ts('Merge contacts'), |
| 206 | 'class' => 'CRM_Contact_Form_Task_Merge', |
| 207 | 'result' => TRUE, |
| 208 | ]; |
| 209 | } |
| 210 | |
| 211 | //CRM-4418, check for delete |
| 212 | if (!CRM_Core_Permission::check('delete contacts')) { |
| 213 | unset(self::$_tasks[self::TASK_DELETE]); |
| 214 | } |
| 215 | |
| 216 | //show map action only if map provider and geoprovider are set (Google doesn't need geoprovider) |
| 217 | // should fix this to be more flexible as providers are added ?? |
| 218 | $config = CRM_Core_Config::singleton(); |
| 219 | |
| 220 | if ($config->mapProvider && |
| 221 | ($config->mapProvider == 'Google' || |
| 222 | ($config->mapProvider == 'OpenStreetMaps' || |
| 223 | $config->geoProvider == 'Google' |
| 224 | ) |
| 225 | ) |
| 226 | ) { |
| 227 | self::$_tasks[self::MAP_CONTACTS] = [ |
| 228 | 'title' => ts('Map contacts'), |
| 229 | 'class' => 'CRM_Contact_Form_Task_Map', |
| 230 | 'result' => FALSE, |
| 231 | 'url' => 'civicrm/contact/map', |
| 232 | 'icon' => 'fa-map', |
| 233 | ]; |
| 234 | } |
| 235 | |
| 236 | if (CRM_Core_Permission::access('CiviEvent')) { |
| 237 | self::$_tasks[self::ADD_EVENT] = [ |
| 238 | 'title' => ts('Register participants for event'), |
| 239 | 'class' => 'CRM_Event_Form_Task_Register', |
| 240 | ]; |
| 241 | } |
| 242 | |
| 243 | if (CRM_Core_Permission::access('CiviMail') |
| 244 | || (CRM_Mailing_Info::workflowEnabled() && CRM_Core_Permission::check('create mailings')) |
| 245 | ) { |
| 246 | self::$_tasks[self::CREATE_MAILING] = [ |
| 247 | 'title' => ts('Email - schedule/send via CiviMail'), |
| 248 | 'class' => 'CRM_Mailing_Form_Task_AdhocMailing', |
| 249 | 'result' => FALSE, |
| 250 | ]; |
| 251 | } |
| 252 | |
| 253 | if (CRM_Core_Permission::access('CiviCase')) { |
| 254 | self::$_tasks[self::ADD_TO_CASE] = [ |
| 255 | 'title' => ts('Add to case as role'), |
| 256 | 'class' => 'CRM_Case_Form_AddToCaseAsRole', |
| 257 | 'result' => FALSE, |
| 258 | ]; |
| 259 | } |
| 260 | |
| 261 | parent::tasks(); |
| 262 | } |
| 263 | |
| 264 | return self::$_tasks; |
| 265 | } |
| 266 | |
| 267 | /** |
| 268 | * Show tasks selectively based on the permission level |
| 269 | * of the user |
| 270 | * |
| 271 | * @param int $permission |
| 272 | * @param array $params |
| 273 | * bool deletedContacts: Are these tasks for operating on deleted contacts?. |
| 274 | * |
| 275 | * @return array |
| 276 | * set of tasks that are valid for the user |
| 277 | */ |
| 278 | public static function permissionedTaskTitles($permission, $params = []) { |
| 279 | if (!isset($params['deletedContacts'])) { |
| 280 | $params['deletedContacts'] = FALSE; |
| 281 | } |
| 282 | self::tasks(); |
| 283 | $tasks = []; |
| 284 | if ($params['deletedContacts']) { |
| 285 | if (CRM_Core_Permission::check('access deleted contacts')) { |
| 286 | $tasks[self::RESTORE] = self::$_tasks[self::RESTORE]['title']; |
| 287 | if (CRM_Core_Permission::check('delete contacts')) { |
| 288 | $tasks[self::DELETE_PERMANENTLY] = self::$_tasks[self::DELETE_PERMANENTLY]['title']; |
| 289 | } |
| 290 | } |
| 291 | } |
| 292 | elseif ($permission == CRM_Core_Permission::EDIT) { |
| 293 | $tasks = self::taskTitles(); |
| 294 | } |
| 295 | else { |
| 296 | $tasks = [ |
| 297 | self::TASK_EXPORT => self::$_tasks[self::TASK_EXPORT]['title'], |
| 298 | self::TASK_EMAIL => self::$_tasks[self::TASK_EMAIL]['title'], |
| 299 | self::LABEL_CONTACTS => self::$_tasks[self::LABEL_CONTACTS]['title'], |
| 300 | ]; |
| 301 | |
| 302 | foreach ([ |
| 303 | self::MAP_CONTACTS, |
| 304 | self::CREATE_MAILING, |
| 305 | self::TASK_SMS, |
| 306 | ] as $task) { |
| 307 | if (isset(self::$_tasks[$task]) && |
| 308 | !empty(self::$_tasks[$task]['title']) |
| 309 | ) { |
| 310 | $tasks[$task] = self::$_tasks[$task]['title']; |
| 311 | } |
| 312 | } |
| 313 | } |
| 314 | |
| 315 | $tasks = parent::corePermissionedTaskTitles($tasks, $permission, $params); |
| 316 | return $tasks; |
| 317 | } |
| 318 | |
| 319 | /** |
| 320 | * @param $value |
| 321 | * |
| 322 | * @return array |
| 323 | */ |
| 324 | public static function getTask($value) { |
| 325 | self::tasks(); |
| 326 | |
| 327 | if (empty(self::$_tasks[$value])) { |
| 328 | // make it the print task by default |
| 329 | $value = self::TASK_PRINT; |
| 330 | } |
| 331 | return parent::getTask($value); |
| 332 | } |
| 333 | |
| 334 | } |