Merge pull request #7032 from mlutfy/4.7-crm17432
[civicrm-core.git] / CRM / Contribute / Page / ContributionPage.php
1 <?php
2 /*
3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
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-2015
32 */
33
34 /**
35 * Create a page for displaying Contribute Pages
36 * Contribute Pages are pages that are used to display
37 * contributions of different types. Pages consist
38 * of many customizable sections which can be
39 * accessed.
40 *
41 * This page provides a top level browse view
42 * of all the contribution pages in the system.
43 *
44 */
45 class CRM_Contribute_Page_ContributionPage extends CRM_Core_Page {
46
47 /**
48 * The action links that we need to display for the browse screen.
49 *
50 * @var array
51 */
52 private static $_actionLinks;
53 private static $_contributionLinks;
54 private static $_configureActionLinks;
55 private static $_onlineContributionLinks;
56
57 /**
58 * @var CRM_Utils_Pager
59 */
60 protected $_pager = NULL;
61
62 /**
63 * @var string
64 */
65 protected $_sortByCharacter;
66
67 /**
68 * Get the action links for this page.
69 *
70 * @return array
71 */
72 public function &actionLinks() {
73 // check if variable _actionsLinks is populated
74 if (!isset(self::$_actionLinks)) {
75 // helper variable for nicer formatting
76 $deleteExtra = ts('Are you sure you want to delete this Contribution page?');
77 $copyExtra = ts('Are you sure you want to make a copy of this Contribution page?');
78
79 self::$_actionLinks = array(
80 CRM_Core_Action::COPY => array(
81 'name' => ts('Make a Copy'),
82 'url' => CRM_Utils_System::currentPath(),
83 'qs' => 'action=copy&gid=%%id%%',
84 'title' => ts('Make a Copy of CiviCRM Contribution Page'),
85 'extra' => 'onclick = "return confirm(\'' . $copyExtra . '\');"',
86 ),
87 CRM_Core_Action::DISABLE => array(
88 'name' => ts('Disable'),
89 'title' => ts('Disable'),
90 'ref' => 'crm-enable-disable',
91 ),
92 CRM_Core_Action::ENABLE => array(
93 'name' => ts('Enable'),
94 'ref' => 'crm-enable-disable',
95 'title' => ts('Enable'),
96 ),
97 CRM_Core_Action::DELETE => array(
98 'name' => ts('Delete'),
99 'url' => CRM_Utils_System::currentPath(),
100 'qs' => 'action=delete&reset=1&id=%%id%%',
101 'title' => ts('Delete Custom Field'),
102 'extra' => 'onclick = "return confirm(\'' . $deleteExtra . '\');"',
103 ),
104 );
105 }
106 return self::$_actionLinks;
107 }
108
109 /**
110 * Get the configure action links for this page.
111 *
112 * @return array
113 */
114 public function &configureActionLinks() {
115 // check if variable _actionsLinks is populated
116 if (!isset(self::$_configureActionLinks)) {
117 $urlString = 'civicrm/admin/contribute/';
118 $urlParams = 'reset=1&action=update&id=%%id%%';
119
120 self::$_configureActionLinks = array(
121 CRM_Core_Action::ADD => array(
122 'name' => ts('Title and Settings'),
123 'title' => ts('Title and Settings'),
124 'url' => $urlString . 'settings',
125 'qs' => $urlParams,
126 'uniqueName' => 'settings',
127 ),
128 CRM_Core_Action::UPDATE => array(
129 'name' => ts('Contribution Amounts'),
130 'title' => ts('Contribution Amounts'),
131 'url' => $urlString . 'amount',
132 'qs' => $urlParams,
133 'uniqueName' => 'amount',
134 ),
135 CRM_Core_Action::VIEW => array(
136 'name' => ts('Membership Settings'),
137 'title' => ts('Membership Settings'),
138 'url' => $urlString . 'membership',
139 'qs' => $urlParams,
140 'uniqueName' => 'membership',
141 ),
142 CRM_Core_Action::EXPORT => array(
143 'name' => ts('Thank-you and Receipting'),
144 'title' => ts('Thank-you and Receipting'),
145 'url' => $urlString . 'thankyou',
146 'qs' => $urlParams,
147 'uniqueName' => 'thankyou',
148 ),
149 CRM_Core_Action::BASIC => array(
150 'name' => ts('Tell a Friend'),
151 'title' => ts('Tell a Friend'),
152 'url' => $urlString . 'friend',
153 'qs' => $urlParams,
154 'uniqueName' => 'friend',
155 ),
156 CRM_Core_Action::PROFILE => array(
157 'name' => ts('Include Profiles'),
158 'title' => ts('Include Profiles'),
159 'url' => $urlString . 'custom',
160 'qs' => $urlParams,
161 'uniqueName' => 'custom',
162 ),
163 CRM_Core_Action::MAP => array(
164 'name' => ts('Contribution Widget'),
165 'title' => ts('Contribution Widget'),
166 'url' => $urlString . 'widget',
167 'qs' => $urlParams,
168 'uniqueName' => 'widget',
169 ),
170 CRM_Core_Action::FOLLOWUP => array(
171 'name' => ts('Premiums'),
172 'title' => ts('Premiums'),
173 'url' => $urlString . 'premium',
174 'qs' => $urlParams,
175 'uniqueName' => 'premium',
176 ),
177 CRM_Core_Action::ADVANCED => array(
178 'name' => ts('Personal Campaign Pages'),
179 'title' => ts('Personal Campaign Pages'),
180 'url' => $urlString . 'pcp',
181 'qs' => $urlParams,
182 'uniqueName' => 'pcp',
183 ),
184 );
185 }
186
187 return self::$_configureActionLinks;
188 }
189
190 /**
191 * Get the online contribution links.
192 *
193 * @return array
194 */
195 public function &onlineContributionLinks() {
196 if (!isset(self::$_onlineContributionLinks)) {
197 $urlString = 'civicrm/contribute/transact';
198 $urlParams = 'reset=1&id=%%id%%';
199 self::$_onlineContributionLinks = array(
200 CRM_Core_Action::RENEW => array(
201 'name' => ts('Live Page'),
202 'title' => ts('Live Page'),
203 'url' => $urlString,
204 'qs' => $urlParams,
205 'fe' => TRUE,
206 'uniqueName' => 'live_page',
207 ),
208 CRM_Core_Action::PREVIEW => array(
209 'name' => ts('Test-drive'),
210 'title' => ts('Test-drive'),
211 'url' => $urlString,
212 'qs' => $urlParams . '&action=preview',
213 'uniqueName' => 'test_drive',
214 ),
215 );
216 }
217
218 return self::$_onlineContributionLinks;
219 }
220
221 /**
222 * Get the contributions links.
223 *
224 * @return array
225 */
226 public function &contributionLinks() {
227 if (!isset(self::$_contributionLinks)) {
228 //get contribution dates.
229 $dates = CRM_Contribute_BAO_Contribution::getContributionDates();
230 $now = $dates['now'];
231 $yearDate = $dates['yearDate'];
232 $monthDate = $dates['monthDate'];
233 $yearNow = $yearDate + 10000;
234
235 $urlString = 'civicrm/contribute/search';
236 $urlParams = 'reset=1&pid=%%id%%&force=1&test=0';
237
238 self::$_contributionLinks = array(
239 CRM_Core_Action::DETACH => array(
240 'name' => ts('Current Month-To-Date'),
241 'title' => ts('Current Month-To-Date'),
242 'url' => $urlString,
243 'qs' => "{$urlParams}&start={$monthDate}&end={$now}",
244 'uniqueName' => 'current_month_to_date',
245 ),
246 CRM_Core_Action::REVERT => array(
247 'name' => ts('Fiscal Year-To-Date'),
248 'title' => ts('Fiscal Year-To-Date'),
249 'url' => $urlString,
250 'qs' => "{$urlParams}&start={$yearDate}&end={$yearNow}",
251 'uniqueName' => 'fiscal_year_to_date',
252 ),
253 CRM_Core_Action::BROWSE => array(
254 'name' => ts('Cumulative'),
255 'title' => ts('Cumulative'),
256 'url' => $urlString,
257 'qs' => "{$urlParams}&start=&end=$now",
258 'uniqueName' => 'cumulative',
259 ),
260 );
261 }
262
263 return self::$_contributionLinks;
264 }
265
266 /**
267 * Run the page.
268 *
269 * This method is called after the page is created. It checks for the
270 * type of action and executes that action.
271 * Finally it calls the parent's run method.
272 *
273 * @return mixed
274 */
275 public function run() {
276 // get the requested action
277 $action = CRM_Utils_Request::retrieve('action', 'String',
278 // default to 'browse'
279 $this, FALSE, 'browse'
280 );
281
282 // assign vars to templates
283 $this->assign('action', $action);
284 $id = CRM_Utils_Request::retrieve('id', 'Positive',
285 $this, FALSE, 0
286 );
287
288 // set breadcrumb to append to 2nd layer pages
289 $breadCrumb = array(
290 array(
291 'title' => ts('Manage Contribution Pages'),
292 'url' => CRM_Utils_System::url(CRM_Utils_System::currentPath(),
293 'reset=1'
294 ),
295 ),
296 );
297
298 // what action to take ?
299 if ($action & CRM_Core_Action::ADD) {
300 $session = CRM_Core_Session::singleton();
301 $session->pushUserContext(CRM_Utils_System::url(CRM_Utils_System::currentPath(),
302 'action=browse&reset=1'
303 ));
304
305 $controller = new CRM_Contribute_Controller_ContributionPage(NULL, $action);
306 CRM_Utils_System::setTitle(ts('Manage Contribution Page'));
307 CRM_Utils_System::appendBreadCrumb($breadCrumb);
308 return $controller->run();
309 }
310 elseif ($action & CRM_Core_Action::UPDATE) {
311 $config = CRM_Core_Config::singleton();
312
313 // assign vars to templates
314 $this->assign('id', $id);
315 $this->assign('title', CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_ContributionPage', $id, 'title'));
316 $this->assign('is_active', CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_ContributionPage', $id, 'is_active'));
317 if (in_array('CiviMember', $config->enableComponents)) {
318 $this->assign('CiviMember', TRUE);
319 }
320 }
321 elseif ($action & CRM_Core_Action::COPY) {
322 // @todo Unused local variable can be safely removed.
323 // But are there any side effects of CRM_Core_Session::singleton() that we
324 // need to preserve?
325 $session = CRM_Core_Session::singleton();
326 CRM_Core_Session::setStatus(ts('A copy of the contribution page has been created'), ts('Successfully Copied'), 'success');
327 $this->copy();
328 }
329 elseif ($action & CRM_Core_Action::DELETE) {
330 CRM_Utils_System::appendBreadCrumb($breadCrumb);
331
332 $session = CRM_Core_Session::singleton();
333 $session->pushUserContext(CRM_Utils_System::url(CRM_Utils_System::currentPath(),
334 'reset=1&action=browse'
335 ));
336
337 $id = CRM_Utils_Request::retrieve('id', 'Positive',
338 $this, FALSE, 0
339 );
340 $query = "
341 SELECT ccp.title
342 FROM civicrm_contribution_page ccp
343 JOIN civicrm_pcp cp ON ccp.id = cp.page_id
344 WHERE cp.page_id = {$id}
345 AND cp.page_type = 'contribute'
346 ";
347
348 if ($pageTitle = CRM_Core_DAO::singleValueQuery($query)) {
349 CRM_Core_Session::setStatus(ts('The \'%1\' cannot be deleted! You must Delete all Personal Campaign Page(s) related with this contribution page prior to deleting the page.', array(1 => $pageTitle)), ts('Deletion Error'), 'error');
350
351 CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/admin/contribute', 'reset=1'));
352 }
353
354 $controller = new CRM_Core_Controller_Simple('CRM_Contribute_Form_ContributionPage_Delete',
355 'Delete Contribution Page',
356 CRM_Core_Action::DELETE
357 );
358 $controller->set('id', $id);
359 $controller->process();
360 return $controller->run();
361 }
362 else {
363 // finally browse the contribution pages
364 $this->browse();
365
366 CRM_Utils_System::setTitle(ts('Manage Contribution Pages'));
367 }
368
369 return parent::run();
370 }
371
372 /**
373 * Make a copy of a contribution page, including all the fields in the page.
374 */
375 public function copy() {
376 $gid = CRM_Utils_Request::retrieve('gid', 'Positive',
377 $this, TRUE, 0, 'GET'
378 );
379
380 CRM_Contribute_BAO_ContributionPage::copy($gid);
381
382 CRM_Utils_System::redirect(CRM_Utils_System::url(CRM_Utils_System::currentPath(), 'reset=1'));
383 }
384
385 /**
386 * Browse all contribution pages.
387 *
388 * @param mixed $action
389 * Unused parameter.
390 */
391 public function browse($action = NULL) {
392 Civi::resources()->addStyleFile('civicrm', 'css/searchForm.css', 1, 'html-header');
393
394 $this->_sortByCharacter = CRM_Utils_Request::retrieve('sortByCharacter',
395 'String',
396 $this
397 );
398 // @todo Unused local variable can be safely removed.
399 // But are there any side effects of CRM_Utils_Request::retrieve() that we
400 // need to preserve?
401 $createdId = CRM_Utils_Request::retrieve('cid', 'Positive',
402 $this, FALSE, 0
403 );
404
405 if ($this->_sortByCharacter == 'all' ||
406 !empty($_POST)
407 ) {
408 $this->_sortByCharacter = '';
409 $this->set('sortByCharacter', '');
410 }
411
412 $this->search();
413
414 $params = array();
415
416 $whereClause = $this->whereClause($params, FALSE);
417 $this->pagerAToZ($whereClause, $params);
418
419 $params = array();
420 $whereClause = $this->whereClause($params, TRUE);
421 $this->pager($whereClause, $params);
422
423 list($offset, $rowCount) = $this->_pager->getOffsetAndRowCount();
424
425 //check for delete CRM-4418
426 $allowToDelete = CRM_Core_Permission::check('delete in CiviContribute');
427
428 $query = "
429 SELECT id
430 FROM civicrm_contribution_page
431 WHERE $whereClause
432 ORDER BY is_active desc, title asc
433 LIMIT $offset, $rowCount";
434 $contribPage = CRM_Core_DAO::executeQuery($query, $params, TRUE, 'CRM_Contribute_DAO_ContributionPage');
435 $contribPageIds = array();
436 while ($contribPage->fetch()) {
437 $contribPageIds[$contribPage->id] = $contribPage->id;
438 }
439 //get all section info.
440 $contriPageSectionInfo = CRM_Contribute_BAO_ContributionPage::getSectionInfo($contribPageIds);
441
442 $query = "
443 SELECT *
444 FROM civicrm_contribution_page
445 WHERE $whereClause
446 ORDER BY is_active desc, title asc
447 LIMIT $offset, $rowCount";
448
449 $dao = CRM_Core_DAO::executeQuery($query, $params, TRUE, 'CRM_Contribute_DAO_ContributionPage');
450
451 //get all campaigns.
452 $allCampaigns = CRM_Campaign_BAO_Campaign::getCampaigns(NULL, NULL, FALSE, FALSE, FALSE, TRUE);
453
454 //get configure actions links.
455 $configureActionLinks = self::configureActionLinks();
456
457 while ($dao->fetch()) {
458 $contribution[$dao->id] = array();
459 CRM_Core_DAO::storeValues($dao, $contribution[$dao->id]);
460
461 // form all action links
462 $action = array_sum(array_keys($this->actionLinks()));
463
464 //add configure actions links.
465 $action += array_sum(array_keys($configureActionLinks));
466
467 //add online contribution links.
468 $action += array_sum(array_keys(self::onlineContributionLinks()));
469
470 //add contribution search links.
471 $action += array_sum(array_keys(self::contributionLinks()));
472
473 if ($dao->is_active) {
474 $action -= (int) CRM_Core_Action::ENABLE;
475 }
476 else {
477 $action -= (int) CRM_Core_Action::DISABLE;
478 }
479
480 //CRM-4418
481 if (!$allowToDelete) {
482 $action -= (int) CRM_Core_Action::DELETE;
483 }
484
485 //build the configure links.
486 $sectionsInfo = CRM_Utils_Array::value($dao->id, $contriPageSectionInfo, array());
487 $contribution[$dao->id]['configureActionLinks'] = CRM_Core_Action::formLink(self::formatConfigureLinks($sectionsInfo),
488 $action,
489 array('id' => $dao->id),
490 ts('Configure'),
491 TRUE,
492 'contributionpage.configure.actions',
493 'ContributionPage',
494 $dao->id
495 );
496
497 //build the contributions links.
498 $contribution[$dao->id]['contributionLinks'] = CRM_Core_Action::formLink(self::contributionLinks(),
499 $action,
500 array('id' => $dao->id),
501 ts('Contributions'),
502 TRUE,
503 'contributionpage.contributions.search',
504 'ContributionPage',
505 $dao->id
506 );
507
508 //build the online contribution links.
509 $contribution[$dao->id]['onlineContributionLinks'] = CRM_Core_Action::formLink(self::onlineContributionLinks(),
510 $action,
511 array('id' => $dao->id),
512 ts('Links'),
513 TRUE,
514 'contributionpage.online.links',
515 'ContributionPage',
516 $dao->id
517 );
518
519 //build the normal action links.
520 $contribution[$dao->id]['action'] = CRM_Core_Action::formLink(self::actionLinks(),
521 $action,
522 array('id' => $dao->id),
523 ts('more'),
524 TRUE,
525 'contributionpage.action.links',
526 'ContributionPage',
527 $dao->id
528 );
529
530 //show campaigns on selector.
531 $contribution[$dao->id]['campaign'] = CRM_Utils_Array::value($dao->campaign_id, $allCampaigns);
532 }
533
534 if (isset($contribution)) {
535 $this->assign('rows', $contribution);
536 }
537 }
538
539 public function search() {
540 if (isset($this->_action) & (CRM_Core_Action::ADD |
541 CRM_Core_Action::UPDATE |
542 CRM_Core_Action::DELETE
543 )
544 ) {
545 return;
546 }
547
548 $form = new CRM_Core_Controller_Simple('CRM_Contribute_Form_SearchContribution',
549 ts('Search Contribution'),
550 CRM_Core_Action::ADD
551 );
552 $form->setEmbedded(TRUE);
553 $form->setParent($this);
554 $form->process();
555 $form->run();
556 }
557
558 /**
559 * @param array $params
560 * @param bool $sortBy
561 *
562 * @return int|string
563 */
564 public function whereClause(&$params, $sortBy = TRUE) {
565 // @todo Unused local variable can be safely removed.
566 $values = $clauses = array();
567 $title = $this->get('title');
568 $createdId = $this->get('cid');
569
570 if ($createdId) {
571 $clauses[] = "(created_id = {$createdId})";
572 }
573
574 if ($title) {
575 $clauses[] = "title LIKE %1";
576 if (strpos($title, '%') !== FALSE) {
577 $params[1] = array(trim($title), 'String', FALSE);
578 }
579 else {
580 $params[1] = array(trim($title), 'String', TRUE);
581 }
582 }
583
584 $value = $this->get('financial_type_id');
585 $val = array();
586 if ($value) {
587 if (is_array($value)) {
588 foreach ($value as $k => $v) {
589 if ($v) {
590 $val[$k] = $k;
591 }
592 }
593 $type = implode(',', $val);
594 }
595 // @todo Variable 'type' might not have been defined.
596 $clauses[] = "financial_type_id IN ({$type})";
597 }
598
599 if ($sortBy && $this->_sortByCharacter !== NULL) {
600 $clauses[] = "title LIKE '" . strtolower(CRM_Core_DAO::escapeWildCardString($this->_sortByCharacter)) . "%'";
601 }
602
603 $campaignIds = $this->getCampaignIds();
604 if (count($campaignIds) >= 1) {
605 $clauses[] = '( campaign_id IN ( ' . implode(' , ', $campaignIds) . ' ) )';
606 }
607
608 if (empty($clauses)) {
609 // Let template know if user has run a search or not
610 $this->assign('isSearch', 0);
611 return 1;
612 }
613 else {
614 $this->assign('isSearch', 1);
615 }
616
617 return implode(' AND ', $clauses);
618 }
619
620 /**
621 * Gets the campaign ids from the session.
622 *
623 * @return int[]
624 */
625 public function getCampaignIds() {
626 // The unfiltered value from the session cannot be trusted, it needs to be
627 // processed to get a clean array of positive integers.
628 $ids = array();
629 foreach ((array) $this->get('campaign_id') as $id) {
630 if ((string) (int) $id === (string) $id && $id > 0) {
631 $ids[] = $id;
632 }
633 }
634 return $ids;
635 }
636
637 /**
638 * @param $whereClause
639 * @param array $whereParams
640 */
641 public function pager($whereClause, $whereParams) {
642
643 $params['status'] = ts('Contribution %%StatusMessage%%');
644 $params['csvString'] = NULL;
645 $params['buttonTop'] = 'PagerTopButton';
646 $params['buttonBottom'] = 'PagerBottomButton';
647 $params['rowCount'] = $this->get(CRM_Utils_Pager::PAGE_ROWCOUNT);
648 if (!$params['rowCount']) {
649 $params['rowCount'] = CRM_Utils_Pager::ROWCOUNT;
650 }
651
652 $query = "
653 SELECT count(id)
654 FROM civicrm_contribution_page
655 WHERE $whereClause";
656
657 $params['total'] = CRM_Core_DAO::singleValueQuery($query, $whereParams);
658
659 $this->_pager = new CRM_Utils_Pager($params);
660 $this->assign_by_ref('pager', $this->_pager);
661 }
662
663 /**
664 * @param $whereClause
665 * @param array $whereParams
666 */
667 public function pagerAtoZ($whereClause, $whereParams) {
668
669 $query = "
670 SELECT DISTINCT UPPER(LEFT(title, 1)) as sort_name
671 FROM civicrm_contribution_page
672 WHERE $whereClause
673 ORDER BY LEFT(title, 1)
674 ";
675 $dao = CRM_Core_DAO::executeQuery($query, $whereParams);
676
677 $aToZBar = CRM_Utils_PagerAToZ::getAToZBar($dao, $this->_sortByCharacter, TRUE);
678 $this->assign('aToZ', $aToZBar);
679 }
680
681 /**
682 * @param array $sectionsInfo
683 *
684 * @return array
685 */
686 public function formatConfigureLinks($sectionsInfo) {
687 // build the formatted configure links.
688 $formattedConfLinks = self::configureActionLinks();
689 foreach ($formattedConfLinks as $act => & $link) {
690 $sectionName = CRM_Utils_Array::value('uniqueName', $link);
691 if (!$sectionName) {
692 continue;
693 }
694
695 if (empty($sectionsInfo[$sectionName])) {
696 $classes = array();
697 if (isset($link['class'])) {
698 $classes = $link['class'];
699 }
700 $link['class'] = array_merge($classes, array('disabled'));
701 }
702 }
703
704 return $formattedConfLinks;
705 }
706
707 }