Merge pull request #13966 from agileware/CIVICRM-1168
[civicrm-core.git] / CRM / Mailing / Selector / Browse.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 *
30 * @package CRM
31 * @copyright CiviCRM LLC (c) 2004-2019
32 */
33
34 /**
35 * This class is used to browse past mailings.
36 */
37 class CRM_Mailing_Selector_Browse extends CRM_Core_Selector_Base implements CRM_Core_Selector_API {
38
39 /**
40 * Array of supported links, currently null
41 *
42 * @var array
43 */
44 public static $_links = NULL;
45
46 /**
47 * We use desc to remind us what that column is, name is used in the tpl
48 *
49 * @var array
50 */
51 public static $_columnHeaders;
52
53 protected $_parent;
54
55 /**
56 * Class constructor.
57 *
58 *
59 * @return \CRM_Mailing_Selector_Browse
60 */
61 public function __construct() {
62 }
63
64 /**
65 * This method returns the links that are given for each search row.
66 *
67 * @return array
68 */
69 public static function &links() {
70 return self::$_links;
71 }
72
73 /**
74 * Getter for array of the parameters required for creating pager.
75 *
76 * @param $action
77 * @param array $params
78 */
79 public function getPagerParams($action, &$params) {
80 $params['csvString'] = NULL;
81 $params['rowCount'] = CRM_Utils_Pager::ROWCOUNT;
82 $params['status'] = ts('Mailings %%StatusMessage%%');
83 $params['buttonTop'] = 'PagerTopButton';
84 $params['buttonBottom'] = 'PagerBottomButton';
85 }
86
87 /**
88 * Returns the column headers as an array of tuples:
89 * (name, sortName (key to the sort array))
90 *
91 * @param string $action
92 * The action being performed.
93 * @param string $output
94 * What should the result set include (web/email/csv).
95 *
96 * @return array
97 * the column headers that need to be displayed
98 */
99 public function &getColumnHeaders($action = NULL, $output = NULL) {
100 $mailing = CRM_Mailing_BAO_Mailing::getTableName();
101 $job = CRM_Mailing_BAO_MailingJob::getTableName();
102 if (!isset(self::$_columnHeaders)) {
103 $completedOrder = NULL;
104
105 // Set different default sort depending on type of mailings (CRM-7652)
106 $unscheduledOrder = $scheduledOrder = $archivedOrder = CRM_Utils_Sort::DONTCARE;
107 if ($this->_parent->get('unscheduled')) {
108 $unscheduledOrder = CRM_Utils_Sort::DESCENDING;
109 }
110 elseif ($this->_parent->get('scheduled')) {
111 $scheduledOrder = CRM_Utils_Sort::DESCENDING;
112 }
113 else {
114 // sort by completed date for archived and undefined get
115 $completedOrder = CRM_Utils_Sort::DESCENDING;
116 }
117 $nameHeaderLabel = ($this->_parent->get('sms')) ? ts('SMS Name') : ts('Mailing Name');
118
119 self::$_columnHeaders = [
120 [
121 'name' => $nameHeaderLabel,
122 'sort' => 'name',
123 'direction' => CRM_Utils_Sort::DONTCARE,
124 ],
125 ];
126
127 if (CRM_Core_I18n::isMultilingual()) {
128 self::$_columnHeaders = array_merge(
129 self::$_columnHeaders,
130 [
131 [
132 'name' => ts('Language'),
133 'sort' => 'language',
134 'direction' => CRM_Utils_Sort::DONTCARE,
135 ],
136 ]
137 );
138 }
139
140 self::$_columnHeaders = array_merge(
141 self::$_columnHeaders,
142 [
143 [
144 'name' => ts('Status'),
145 'sort' => 'status',
146 'direction' => CRM_Utils_Sort::DONTCARE,
147 ],
148 [
149 'name' => ts('Created By'),
150 'sort' => 'created_by',
151 'direction' => CRM_Utils_Sort::DONTCARE,
152 ],
153 [
154 'name' => ts('Created Date'),
155 'sort' => 'created_date',
156 'direction' => $unscheduledOrder,
157 ],
158 [
159 'name' => ts('Sent By'),
160 'sort' => 'scheduled_by',
161 'direction' => CRM_Utils_Sort::DONTCARE,
162 ],
163 [
164 'name' => ts('Scheduled'),
165 'sort' => 'scheduled_date',
166 'direction' => $scheduledOrder,
167 ],
168 [
169 'name' => ts('Started'),
170 'sort' => 'start_date',
171 'direction' => CRM_Utils_Sort::DONTCARE,
172 ],
173 [
174 'name' => ts('Completed'),
175 'sort' => 'end_date',
176 'direction' => $completedOrder,
177 ],
178 ]
179 );
180
181 if (CRM_Campaign_BAO_Campaign::isCampaignEnable()) {
182 self::$_columnHeaders[] = [
183 'name' => ts('Campaign'),
184 'sort' => 'campaign_id',
185 'direction' => CRM_Utils_Sort::DONTCARE,
186 ];
187 }
188
189 if ($output != CRM_Core_Selector_Controller::EXPORT) {
190 self::$_columnHeaders[] = ['name' => ts('Action')];
191 }
192 }
193
194 CRM_Core_Smarty::singleton()->assign('multilingual', CRM_Core_I18n::isMultilingual());
195 return self::$_columnHeaders;
196 }
197
198 /**
199 * Returns total number of rows for the query.
200 *
201 * @param string $action
202 *
203 * @return int
204 * Total number of rows
205 */
206 public function getTotalCount($action) {
207 $job = CRM_Mailing_BAO_MailingJob::getTableName();
208 $mailing = CRM_Mailing_BAO_Mailing::getTableName();
209 $mailingACL = CRM_Mailing_BAO_Mailing::mailingACL();
210
211 // get the where clause.
212 $params = [];
213 $whereClause = "$mailingACL AND " . $this->whereClause($params);
214
215 // CRM-11919 added addition ON clauses to mailing_job to match getRows
216 $query = "
217 SELECT COUNT( DISTINCT $mailing.id ) as count
218 FROM $mailing
219 LEFT JOIN $job ON ( $mailing.id = $job.mailing_id AND civicrm_mailing_job.is_test = 0 AND civicrm_mailing_job.parent_id IS NULL )
220 LEFT JOIN civicrm_contact createdContact ON ( $mailing.created_id = createdContact.id )
221 LEFT JOIN civicrm_contact scheduledContact ON ( $mailing.scheduled_id = scheduledContact.id )
222 WHERE $whereClause";
223
224 return CRM_Core_DAO::singleValueQuery($query, $params);
225 }
226
227 /**
228 * Returns all the rows in the given offset and rowCount.
229 *
230 * @param string $action
231 * The action being performed.
232 * @param int $offset
233 * The row number to start from.
234 * @param int $rowCount
235 * The number of rows to return.
236 * @param string $sort
237 * The sql string that describes the sort order.
238 * @param string $output
239 * What should the result set include (web/email/csv).
240 *
241 * @return int
242 * the total number of rows for this action
243 */
244 public function &getRows($action, $offset, $rowCount, $sort, $output = NULL) {
245 static $actionLinks = NULL;
246 if (empty($actionLinks)) {
247 $cancelExtra = ts('Are you sure you want to cancel this mailing?');
248 $deleteExtra = ts('Are you sure you want to delete this mailing?');
249 $archiveExtra = ts('Are you sure you want to archive this mailing?');
250
251 $actionLinks = [
252 CRM_Core_Action::ENABLE => [
253 'name' => ts('Approve/Reject'),
254 'url' => 'civicrm/mailing/approve',
255 'qs' => 'mid=%%mid%%&reset=1',
256 'title' => ts('Approve/Reject Mailing'),
257 ],
258 CRM_Core_Action::VIEW => [
259 'name' => ts('Report'),
260 'url' => 'civicrm/mailing/report',
261 'qs' => 'mid=%%mid%%&reset=1',
262 'title' => ts('View Mailing Report'),
263 ],
264 CRM_Core_Action::UPDATE => [
265 'name' => ts('Re-Use'),
266 'url' => 'civicrm/mailing/send',
267 'qs' => 'mid=%%mid%%&reset=1',
268 'title' => ts('Re-Send Mailing'),
269 ],
270 CRM_Core_Action::DISABLE => [
271 'name' => ts('Cancel'),
272 'url' => 'civicrm/mailing/browse',
273 'qs' => 'action=disable&mid=%%mid%%&reset=1',
274 'extra' => 'onclick="if (confirm(\'' . $cancelExtra . '\')) this.href+=\'&amp;confirmed=1\'; else return false;"',
275 'title' => ts('Cancel Mailing'),
276 ],
277 CRM_Core_Action::PREVIEW => [
278 'name' => ts('Continue'),
279 'url' => 'civicrm/mailing/send',
280 'qs' => 'mid=%%mid%%&continue=true&reset=1',
281 'title' => ts('Continue Mailing'),
282 ],
283 CRM_Core_Action::DELETE => [
284 'name' => ts('Delete'),
285 'url' => 'civicrm/mailing/browse',
286 'qs' => 'action=delete&mid=%%mid%%&reset=1',
287 'extra' => 'onclick="if (confirm(\'' . $deleteExtra . '\')) this.href+=\'&amp;confirmed=1\'; else return false;"',
288 'title' => ts('Delete Mailing'),
289 ],
290 CRM_Core_Action::RENEW => [
291 'name' => ts('Archive'),
292 'url' => 'civicrm/mailing/browse/archived',
293 'qs' => 'action=renew&mid=%%mid%%&reset=1',
294 'extra' => 'onclick="if (confirm(\'' . $archiveExtra . '\')) this.href+=\'&amp;confirmed=1\'; else return false;"',
295 'title' => ts('Archive Mailing'),
296 ],
297 CRM_Core_Action::REOPEN => [
298 'name' => ts('Resume'),
299 'url' => 'civicrm/mailing/browse',
300 'qs' => 'action=reopen&mid=%%mid%%&reset=1',
301 'title' => ts('Resume mailing'),
302 ],
303 CRM_Core_Action::CLOSE => [
304 'name' => ts('Pause'),
305 'url' => 'civicrm/mailing/browse',
306 'qs' => 'action=close&mid=%%mid%%&reset=1',
307 'title' => ts('Pause mailing'),
308 ],
309 ];
310 }
311
312 $allAccess = TRUE;
313 $workFlow = $showApprovalLinks = $showScheduleLinks = $showCreateLinks = FALSE;
314 if (CRM_Mailing_Info::workflowEnabled()) {
315 $allAccess = FALSE;
316 $workFlow = TRUE;
317 // supercedes all permission
318 if (CRM_Core_Permission::check('access CiviMail')) {
319 $allAccess = TRUE;
320 }
321
322 if (CRM_Core_Permission::check('approve mailings')) {
323 $showApprovalLinks = TRUE;
324 }
325
326 if (CRM_Core_Permission::check('create mailings')) {
327 $showCreateLinks = TRUE;
328 }
329
330 if (CRM_Core_Permission::check('schedule mailings')) {
331 $showScheduleLinks = TRUE;
332 }
333 }
334 $mailing = new CRM_Mailing_BAO_Mailing();
335
336 $params = [];
337
338 $whereClause = ' AND ' . $this->whereClause($params);
339
340 if (empty($params)) {
341 $this->_parent->assign('isSearch', 0);
342 }
343 else {
344 $this->_parent->assign('isSearch', 1);
345 }
346 $rows = &$mailing->getRows($offset, $rowCount, $sort, $whereClause, $params);
347
348 // get the search base mailing Ids, CRM-3711.
349 $searchMailings = $mailing->searchMailingIDs();
350
351 // check for delete CRM-4418
352 $allowToDelete = CRM_Core_Permission::check('delete in CiviMail');
353
354 if ($output != CRM_Core_Selector_Controller::EXPORT) {
355
356 // create the appropriate $op to use for hook_civicrm_links
357 $pageTypes = ['view', 'mailing', 'browse'];
358 if ($this->_parent->_unscheduled) {
359 $pageTypes[] = 'unscheduled';
360 }
361 if ($this->_parent->_scheduled) {
362 $pageTypes[] = 'scheduled';
363 }
364 if ($this->_parent->_archived) {
365 $pageTypes[] = 'archived';
366 }
367 $opString = implode('.', $pageTypes);
368
369 // get languages for later conversion
370 $languages = CRM_Core_I18n::languages();
371
372 foreach ($rows as $key => $row) {
373 $actionMask = NULL;
374 if ($row['sms_provider_id']) {
375 $actionLinks[CRM_Core_Action::PREVIEW]['url'] = 'civicrm/sms/send';
376 }
377
378 if (!($row['status'] == 'Not scheduled') && !$row['sms_provider_id']) {
379 if ($allAccess || $showCreateLinks) {
380 $actionMask = CRM_Core_Action::VIEW;
381 }
382
383 if (!in_array($row['id'], $searchMailings)) {
384 if ($allAccess || $showCreateLinks) {
385 $actionMask |= CRM_Core_Action::UPDATE;
386 }
387 }
388 }
389 else {
390 if ($allAccess || ($showCreateLinks || $showScheduleLinks)) {
391 $actionMask = CRM_Core_Action::PREVIEW;
392 }
393 }
394 if (in_array($row['status'], [
395 'Scheduled',
396 'Running',
397 'Paused',
398 ])) {
399 if ($allAccess ||
400 ($showApprovalLinks && $showCreateLinks && $showScheduleLinks)
401 ) {
402
403 $actionMask |= CRM_Core_Action::DISABLE;
404 if ($row['status'] == "Paused") {
405 $actionMask |= CRM_Core_Action::REOPEN;
406 }
407 else {
408 $actionMask |= CRM_Core_Action::CLOSE;
409 }
410 }
411 if ($row['status'] == 'Scheduled' &&
412 empty($row['approval_status_id'])
413 ) {
414 if ($workFlow && ($allAccess || $showApprovalLinks)) {
415 $actionMask |= CRM_Core_Action::ENABLE;
416 }
417 }
418 }
419
420 if (in_array($row['status'], ['Complete', 'Canceled']) &&
421 !$row['archived']
422 ) {
423 if ($allAccess || $showCreateLinks) {
424 $actionMask |= CRM_Core_Action::RENEW;
425 }
426 }
427
428 // check for delete permission.
429 if ($allowToDelete) {
430 $actionMask |= CRM_Core_Action::DELETE;
431 }
432
433 if ($actionMask == NULL) {
434 $actionMask = CRM_Core_Action::ADD;
435 }
436 // get status strings as per locale settings CRM-4411.
437 $rows[$key]['status'] = CRM_Mailing_BAO_MailingJob::status($row['status']);
438
439 // get language string
440 $rows[$key]['language'] = (isset($row['language']) ? $languages[$row['language']] : NULL);
441
442 $validLinks = $actionLinks;
443 if (($mailingUrl = CRM_Mailing_BAO_Mailing::getPublicViewUrl($row['id'])) != FALSE) {
444 $validLinks[CRM_Core_Action::BROWSE] = [
445 'name' => ts('Public View'),
446 'url' => 'civicrm/mailing/view',
447 'qs' => 'id=%%mid%%&reset=1',
448 'title' => ts('Public View'),
449 'fe' => TRUE,
450 ];
451 $actionMask |= CRM_Core_Action::BROWSE;
452 }
453
454 $rows[$key]['action'] = CRM_Core_Action::formLink(
455 $validLinks,
456 $actionMask,
457 ['mid' => $row['id']],
458 "more",
459 FALSE,
460 $opString,
461 "Mailing",
462 $row['id']
463 );
464
465 // unset($rows[$key]['id']);
466 // if the scheduled date is 0, replace it with an empty string
467 if ($rows[$key]['scheduled_iso'] == '0000-00-00 00:00:00') {
468 $rows[$key]['scheduled'] = '';
469 }
470 unset($rows[$key]['scheduled_iso']);
471 }
472 }
473
474 // also initialize the AtoZ pager
475 $this->pagerAtoZ();
476 return $rows;
477 }
478
479 /**
480 * Name of export file.
481 *
482 * @param string $output
483 * Type of output.
484 *
485 * @return string
486 * name of the file
487 */
488 public function getExportFileName($output = 'csv') {
489 return ts('CiviMail Mailings');
490 }
491
492 /**
493 * @param $parent
494 */
495 public function setParent($parent) {
496 $this->_parent = $parent;
497 }
498
499 /**
500 * @param array $params
501 * @param bool $sortBy
502 *
503 * @return int|string
504 */
505 public function whereClause(&$params, $sortBy = TRUE) {
506 $values = $clauses = [];
507 $isFormSubmitted = $this->_parent->get('hidden_find_mailings');
508
509 $title = $this->_parent->get('mailing_name');
510 if ($title) {
511 $clauses[] = 'name LIKE %1';
512 if (strpos($title, '%') !== FALSE) {
513 $params[1] = [$title, 'String', FALSE];
514 }
515 else {
516 $params[1] = [$title, 'String', TRUE];
517 }
518 }
519
520 $dateClause1 = $dateClause2 = [];
521 $from = $this->_parent->get('mailing_from');
522 if (!CRM_Utils_System::isNull($from)) {
523 if ($this->_parent->get('unscheduled')) {
524 $dateClause1[] = 'civicrm_mailing.created_date >= %2';
525 }
526 else {
527 $dateClause1[] = 'civicrm_mailing_job.start_date >= %2';
528 $dateClause2[] = 'civicrm_mailing_job.scheduled_date >= %2';
529 }
530 $params[2] = [$from, 'String'];
531 }
532
533 $to = $this->_parent->get('mailing_to');
534 if (!CRM_Utils_System::isNull($to)) {
535 if ($this->_parent->get('unscheduled')) {
536 $dateClause1[] = ' civicrm_mailing.created_date <= %3 ';
537 }
538 else {
539 $dateClause1[] = 'civicrm_mailing_job.start_date <= %3';
540 $dateClause2[] = 'civicrm_mailing_job.scheduled_date <= %3';
541 }
542 $params[3] = [$to, 'String'];
543 }
544
545 $dateClauses = [];
546 if (!empty($dateClause1)) {
547 $dateClauses[] = implode(' AND ', $dateClause1);
548 }
549 if (!empty($dateClause2)) {
550 $dateClauses[] = implode(' AND ', $dateClause2);
551 }
552 $dateClauses = implode(' OR ', $dateClauses);
553 if (!empty($dateClauses)) {
554 $clauses[] = "({$dateClauses})";
555 }
556
557 if ($this->_parent->get('sms')) {
558 $clauses[] = "civicrm_mailing.sms_provider_id IS NOT NULL";
559 }
560 else {
561 $clauses[] = "civicrm_mailing.sms_provider_id IS NULL";
562 }
563
564 // get values submitted by form
565 $isDraft = $this->_parent->get('status_unscheduled');
566 $isArchived = $this->_parent->get('is_archived');
567 $mailingStatus = $this->_parent->get('mailing_status');
568
569 if (!$isFormSubmitted && $this->_parent->get('scheduled')) {
570 // mimic default behavior for scheduled screen
571 $isArchived = 0;
572 $mailingStatus = ['Scheduled' => 1, 'Complete' => 1, 'Running' => 1, 'Paused' => 1, 'Canceled' => 1];
573 }
574 if (!$isFormSubmitted && $this->_parent->get('archived')) {
575 // mimic default behavior for archived screen
576 $isArchived = 1;
577 }
578 if (!$isFormSubmitted && $this->_parent->get('unscheduled')) {
579 // mimic default behavior for draft screen
580 $isDraft = 1;
581 }
582
583 $statusClauses = [];
584 if ($isDraft) {
585 $statusClauses[] = "civicrm_mailing.scheduled_id IS NULL";
586 }
587 if (!empty($mailingStatus)) {
588 $statusClauses[] = "civicrm_mailing_job.status IN ('" . implode("', '", array_keys($mailingStatus)) . "')";
589 }
590 if (!empty($statusClauses)) {
591 $clauses[] = "(" . implode(' OR ', $statusClauses) . ")";
592 }
593
594 if (isset($isArchived)) {
595 if ($isArchived) {
596 $clauses[] = "civicrm_mailing.is_archived = 1";
597 }
598 else {
599 $clauses[] = "(civicrm_mailing.is_archived IS NULL OR civicrm_mailing.is_archived = 0)";
600 }
601 }
602
603 if ($sortBy &&
604 $this->_parent->_sortByCharacter !== NULL
605 ) {
606 $clauses[] = "name LIKE '" . strtolower(CRM_Core_DAO::escapeWildCardString($this->_parent->_sortByCharacter)) . "%'";
607 }
608
609 // dont do a the below assignement when doing a
610 // AtoZ pager clause
611 if ($sortBy) {
612 if (count($clauses) > 1) {
613 $this->_parent->assign('isSearch', 1);
614 }
615 else {
616 $this->_parent->assign('isSearch', 0);
617 }
618 }
619
620 $createOrSentBy = $this->_parent->get('sort_name');
621 if (!CRM_Utils_System::isNull($createOrSentBy)) {
622 $clauses[] = '(createdContact.sort_name LIKE %4 OR scheduledContact.sort_name LIKE %4)';
623 $params[4] = ['%' . $createOrSentBy . '%', 'String'];
624 }
625
626 $createdId = $this->_parent->get('createdId');
627 if ($createdId) {
628 $clauses[] = "(created_id = {$createdId})";
629 $params[5] = [$createdId, 'Integer'];
630 }
631
632 $campainIds = $this->_parent->get('campaign_id');
633 if (!CRM_Utils_System::isNull($campainIds)) {
634 if (!is_array($campainIds)) {
635 $campaignIds = [$campaignIds];
636 }
637 $clauses[] = '( campaign_id IN ( ' . implode(' , ', array_values($campainIds)) . ' ) )';
638 }
639
640 if ($language = $this->_parent->get('language')) {
641 $clauses[] = "civicrm_mailing.language = %6";
642 $params[6] = [$language, 'String'];
643 }
644
645 if (empty($clauses)) {
646 return 1;
647 }
648
649 return implode(' AND ', $clauses);
650 }
651
652 public function pagerAtoZ() {
653
654 $params = [];
655 $whereClause = $this->whereClause($params, FALSE);
656
657 $query = "
658 SELECT DISTINCT UPPER(LEFT(name, 1)) as sort_name
659 FROM civicrm_mailing
660 LEFT JOIN civicrm_mailing_job ON (civicrm_mailing_job.mailing_id = civicrm_mailing.id)
661 LEFT JOIN civicrm_contact createdContact ON ( civicrm_mailing.created_id = createdContact.id )
662 LEFT JOIN civicrm_contact scheduledContact ON ( civicrm_mailing.scheduled_id = scheduledContact.id )
663 WHERE $whereClause
664 ORDER BY UPPER(LEFT(name, 1))
665 ";
666
667 $dao = CRM_Core_DAO::executeQuery($query, $params);
668
669 $aToZBar = CRM_Utils_PagerAToZ::getAToZBar($dao, $this->_parent->_sortByCharacter, TRUE);
670 $this->_parent->assign('aToZ', $aToZBar);
671 }
672
673 }