3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
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 +--------------------------------------------------------------------+
13 * This class acts as our base controller class and adds additional
14 * functionality and smarts to the base QFC. Specifically we create
15 * our own action classes and handle the transitions ourselves by
16 * simulating a state machine. We also create direct jump links to any
17 * page that can be used universally.
19 * This concept has been discussed on the PEAR list and the QFC FAQ
20 * goes into a few details. Please check
21 * http://pear.php.net/manual/en/package.html.html-quickform-controller.faq.php
22 * for other useful tips and suggestions
25 * @copyright CiviCRM LLC https://civicrm.org/licensing
28 require_once 'HTML/QuickForm/Controller.php';
29 require_once 'HTML/QuickForm/Action/Direct.php';
32 * Class CRM_Core_Controller
34 class CRM_Core_Controller
extends HTML_QuickForm_Controller
{
37 * The title associated with this controller.
44 * The key associated with this controller.
51 * The name of the session scope where values are stored.
58 * The state machine associated with this controller.
62 protected $_stateMachine;
65 * Is this object being embedded in another object. If
66 * so the display routine needs to not do any work. (The
67 * parent object takes care of the display)
71 protected $_embedded = FALSE;
74 * After entire form execution complete,
75 * do we want to skip control redirection.
76 * Default - It get redirect to user context.
78 * Useful when we run form in non civicrm context
79 * and we need to transfer control back.(eg. drupal)
83 protected $_skipRedirection = FALSE;
86 * Are we in print mode? if so we need to modify the display
87 * functionality to do a minimal display :)
94 * Should we generate a qfKey, true by default
98 public $_generateQFKey = TRUE;
105 public $_QFResponseType = 'html';
108 * Cache the smarty template for efficiency reasons.
110 * @var CRM_Core_Smarty
112 static protected $_template;
115 * Cache the session for efficiency reasons.
117 * @var CRM_Core_Session
119 static protected $_session;
122 * The parent of this form if embedded.
126 protected $_parent = NULL;
129 * The destination if set will override the destination the code wants to send it to.
133 public $_destination = NULL;
136 * The entry url for a top level form or wizard. Typically the URL with a reset=1
137 * used to redirect back to when we land into some session wierdness
141 public $_entryURL = NULL;
144 * All CRM single or multi page pages should inherit from this class.
146 * @param string $title
147 * Descriptive title of the controller.
149 * Whether controller is modal.
151 * @param string $scope
152 * Name of session if we want unique scope, used only by Controller_Simple.
153 * @param bool $addSequence
154 * Should we add a unique sequence number to the end of the key.
155 * @param bool $ignoreKey
156 * Should we not set a qfKey for this controller (for standalone forms).
158 * @throws \CRM_Core_Exception
160 public function __construct(
165 $addSequence = FALSE,
168 // this has to true for multiple tab session fix
171 // let the constructor initialize this, should happen only once
172 if (!isset(self
::$_template)) {
173 self
::$_template = CRM_Core_Smarty
::singleton();
174 self
::$_session = CRM_Core_Session
::singleton();
177 // lets try to get it from the session and/or the request vars
178 // we do this early on in case there is a fatal error in retrieving the
179 // key and/or session
181 = CRM_Utils_Request
::retrieve('entryURL', 'String', $this);
183 // add a unique validable key to the name
184 $name = CRM_Utils_System
::getClassName($this);
185 if ($name == 'CRM_Core_Controller_Simple' && !empty($scope)) {
186 // use form name if we have, since its a lot better and
187 // definitely different for different forms
190 $name = $name . '_' . $this->key($name, $addSequence, $ignoreKey);
191 $this->_title
= $title;
193 $this->_scope
= $scope;
196 $this->_scope
= CRM_Utils_System
::getClassName($this);
198 $this->_scope
= $this->_scope
. '_' . $this->_key
;
200 // only use the civicrm cache if we have a valid key
201 // else we clash with other users CRM-7059
202 if (!empty($this->_key
)) {
203 CRM_Core_Session
::registerAndRetrieveSessionObjects([
204 "_{$name}_container",
205 ['CiviCRM', $this->_scope
],
209 parent
::__construct($name, $modal);
211 $snippet = $_REQUEST['snippet'] ??
NULL;
214 $this->_print
= CRM_Core_Smarty
::PRINT_PDF
;
216 elseif ($snippet == 4) {
217 // this is used to embed fragments of a form
218 $this->_print
= CRM_Core_Smarty
::PRINT_NOFORM
;
219 self
::$_template->assign('suppressForm', TRUE);
220 $this->_generateQFKey
= FALSE;
222 elseif ($snippet == 5) {
223 // mode deprecated in favor of json
224 // still used by dashlets, probably nothing else
225 $this->_print
= CRM_Core_Smarty
::PRINT_NOFORM
;
227 // Respond with JSON if in AJAX context (also support legacy value '6')
228 elseif (in_array($snippet, [CRM_Core_Smarty
::PRINT_JSON
, 6])) {
229 $this->_print
= CRM_Core_Smarty
::PRINT_JSON
;
230 $this->_QFResponseType
= 'json';
233 $this->_print
= CRM_Core_Smarty
::PRINT_SNIPPET
;
237 // if the request has a reset value, initialize the controller session
238 if (!empty($_GET['reset'])) {
241 // in this case we'll also cache the url as a hidden form variable, this allows us to
242 // redirect in case the session has disappeared on us
243 $this->_entryURL
= CRM_Utils_System
::makeURL(NULL, TRUE, FALSE, NULL, TRUE);
244 $this->set('entryURL', $this->_entryURL
);
247 // set the key in the session
248 // do this at the end so we have initialized the object
249 // and created the scope etc
250 $this->set('qfKey', $this->_key
);
252 // also retrieve and store destination in session
253 $this->_destination
= CRM_Utils_Request
::retrieve(
254 'civicrmDestination',
263 public function fini() {
264 CRM_Core_BAO_Cache
::storeSessionToCache([
265 "_{$this->_name}_container",
266 ['CiviCRM', $this->_scope
],
271 * @param string $name
272 * @param bool $addSequence
273 * @param bool $ignoreKey
275 * @return mixed|string
277 public function key($name, $addSequence = FALSE, $ignoreKey = FALSE) {
278 $config = CRM_Core_Config
::singleton();
282 (isset($config->keyDisable
) && $config->keyDisable
)
287 // We need a form key. Check _POST first, then _GET.
288 // @todo Note: we currently have to check $_REQUEST, too, since that
289 // is currently overwritten by civicrm_api3_contribution_page_validate.
290 // It's bad form to use $_REQUEST because it's ambiguous; and it's bad form
291 // to change superglobals anyway. If PR
292 // https://github.com/civicrm/civicrm-core/pull/17324
293 // and/or related get merged, then we should remove the REQUEST reference here.
294 $key = $_POST['qfKey'] ??
$_GET['qfKey'] ??
$_REQUEST['qfKey'] ??
NULL;
295 if (!$key && in_array($_SERVER['REQUEST_METHOD'], ['GET', 'HEAD'])) {
296 // Generate a key if this is an initial request without one.
297 // We allow HEAD here because it is used by bots to validate URLs, so if
298 // we issue a 500 server error to them they may think the site is broken.
299 $key = CRM_Core_Key
::get($name, $addSequence);
302 // Other requests that usually change data (POST, but feasibly DELETE,
303 // PUT, PATCH...) always require a valid key.
304 $key = CRM_Core_Key
::validate($key, $name, $addSequence);
317 * Process the request, overrides the default QFC run method
318 * This routine actually checks if the QFC is modal and if it
319 * is the first invalid page, if so it call the requested action
320 * if not, it calls the display action on the first invalid page
321 * avoids the issue of users hitting the back button and getting
324 * This run is basically a composition of the original run and the
329 public function run() {
330 // the names of the action and page should be saved
331 // note that this is split into two, because some versions of
332 // php 5.x core dump on the triple assignment :)
333 $this->_actionName
= $this->getActionName();
334 list($pageName, $action) = $this->_actionName
;
336 if ($this->isModal()) {
337 if (!$this->isValid($pageName)) {
338 $pageName = $this->findInvalid();
343 // note that based on action, control might not come back!!
344 // e.g. if action is a valid JUMP, u basically do a redirect
345 // to the appropriate place
346 $this->wizardHeader($pageName);
347 return $this->_pages
[$pageName]->handle($action);
353 public function validate() {
354 $this->_actionName
= $this->getActionName();
355 list($pageName, $action) = $this->_actionName
;
357 $page = &$this->_pages
[$pageName];
359 $data = &$this->container();
360 $this->applyDefaults($pageName);
361 $page->isFormBuilt() or $page->buildForm();
362 // We use defaults and constants as if they were submitted
363 $data['values'][$pageName] = $page->exportValues();
364 $page->loadValues($data['values'][$pageName]);
365 // Is the page now valid?
366 if (TRUE === ($data['valid'][$pageName] = $page->validate())) {
369 return $page->_errors
;
373 * Helper function to add all the needed default actions.
375 * Note that the framework redefines all of the default QFC actions.
377 * @param string $uploadDirectory to store all the uploaded files
378 * @param array $uploadNames for the various upload buttons (note u can have more than 1 upload)
380 public function addActions($uploadDirectory = NULL, $uploadNames = NULL) {
382 'display' => 'CRM_Core_QuickForm_Action_Display',
383 'next' => 'CRM_Core_QuickForm_Action_Next',
384 'back' => 'CRM_Core_QuickForm_Action_Back',
385 'process' => 'CRM_Core_QuickForm_Action_Process',
386 'cancel' => 'CRM_Core_QuickForm_Action_Cancel',
387 'refresh' => 'CRM_Core_QuickForm_Action_Refresh',
388 'reload' => 'CRM_Core_QuickForm_Action_Reload',
389 'done' => 'CRM_Core_QuickForm_Action_Done',
390 'jump' => 'CRM_Core_QuickForm_Action_Jump',
391 'submit' => 'CRM_Core_QuickForm_Action_Submit',
394 foreach ($names as $name => $classPath) {
395 $action = new $classPath($this->_stateMachine
);
396 $this->addAction($name, $action);
399 $this->addUploadAction($uploadDirectory, $uploadNames);
403 * Getter method for stateMachine.
405 * @return CRM_Core_StateMachine
407 public function getStateMachine() {
408 return $this->_stateMachine
;
412 * Setter method for stateMachine.
414 * @param CRM_Core_StateMachine $stateMachine
416 public function setStateMachine($stateMachine) {
417 $this->_stateMachine
= $stateMachine;
421 * Add pages to the controller. Note that the controller does not really care
422 * the order in which the pages are added
424 * @param CRM_Core_StateMachine $stateMachine
425 * @param \const|int $action the mode in which the state machine is operating
426 * typically this will be add/view/edit
428 public function addPages(&$stateMachine, $action = CRM_Core_Action
::NONE
) {
429 $pages = $stateMachine->getPages();
430 foreach ($pages as $name => $value) {
431 $className = CRM_Utils_Array
::value('className', $value, $name);
432 $title = $value['title'] ??
NULL;
433 $options = $value['options'] ??
NULL;
434 $stateName = CRM_Utils_String
::getClassName($className);
435 if (!empty($value['className'])) {
439 $formName = CRM_Utils_String
::getClassName($name);
442 $ext = CRM_Extension_System
::singleton()->getMapper();
443 if ($ext->isExtensionClass($className)) {
444 require_once $ext->classToPath($className);
447 require_once str_replace('_', DIRECTORY_SEPARATOR
, $className) . '.php';
449 $
$stateName = new $className($stateMachine->find($className), $action, 'post', $formName);
451 $
$stateName->setTitle($title);
454 $
$stateName->setOptions($options);
456 if (property_exists($
$stateName, 'urlPath')) {
457 $
$stateName->urlPath
= explode('/', (string) CRM_Utils_System
::currentPath());
459 $this->addPage($
$stateName);
460 $this->addAction($stateName, new HTML_QuickForm_Action_Direct());
462 //CRM-6342 -we need kill the reference here,
463 //as we have deprecated reference object creation.
469 * QFC does not provide native support to have different 'submit' buttons.
470 * We introduce this notion to QFC by using button specific data. Thus if
471 * we have two submit buttons, we could have one displayed as a button and
472 * the other as an image, both are of type 'submit'.
475 * the name of the button that has been pressed by the user
477 public function getButtonName() {
478 $data = &$this->container();
479 return $data['_qf_button_name'] ??
NULL;
483 * Destroy all the session state of the controller.
485 public function reset() {
486 $this->container(TRUE);
487 self
::$_session->resetScope($this->_scope
);
491 * Virtual function to do any processing of data.
493 * Sometimes it is useful for the controller to actually process data.
494 * This is typically used when we need the controller to figure out
495 * what pages are potentially involved in this wizard. (this is dynamic
496 * and can change based on the arguments
498 public function process() {
502 * Store the variable with the value in the form scope.
504 * @param string|array $name name of the variable or an assoc array of name/value pairs
505 * @param mixed $value
506 * Value of the variable if string.
508 public function set($name, $value = NULL) {
509 self
::$_session->set($name, $value, $this->_scope
);
513 * Get the variable from the form scope.
515 * @param string $name
516 * name of the variable.
520 public function get($name) {
521 return self
::$_session->get($name, $this->_scope
);
525 * Create the header for the wizard from the list of pages.
526 * Store the created header in smarty
528 * @param string $currentPageName
529 * Name of the page being displayed.
533 public function wizardHeader($currentPageName) {
535 $wizard['steps'] = [];
537 foreach ($this->_pages
as $name => $page) {
539 $wizard['steps'][] = [
541 'title' => $page->getTitle(),
542 //'link' => $page->getLink ( ),
546 'stepNumber' => $count,
547 'collapsed' => FALSE,
550 if ($name == $currentPageName) {
551 $wizard['currentStepNumber'] = $count;
552 $wizard['currentStepName'] = $name;
553 $wizard['currentStepTitle'] = $page->getTitle();
557 $wizard['stepCount'] = $count;
559 $this->addWizardStyle($wizard);
561 $this->assign('wizard', $wizard);
566 * @param array $wizard
568 public function addWizardStyle(&$wizard) {
571 'stepPrefixCurrent' => '<i class="crm-i fa-chevron-right" aria-hidden="true"></i> ',
572 'stepPrefixPast' => '<i class="crm-i fa-check" aria-hidden="true"></i> ',
573 'stepPrefixFuture' => ' ',
574 'subStepPrefixCurrent' => ' ',
575 'subStepPrefixPast' => ' ',
576 'subStepPrefixFuture' => ' ',
582 * Assign value to name in template.
585 * @param mixed $value
588 public function assign($var, $value = NULL) {
589 self
::$_template->assign($var, $value);
593 * Assign value to name in template by reference.
596 * @param mixed $value
597 * (reference) value of variable.
599 public function assign_by_ref($var, &$value) {
600 self
::$_template->assign_by_ref($var, $value);
604 * Appends values to template variables.
606 * @param array|string $tpl_var the template variable name(s)
607 * @param mixed $value
608 * The value to append.
611 public function append($tpl_var, $value = NULL, $merge = FALSE) {
612 self
::$_template->append($tpl_var, $value, $merge);
616 * Returns an array containing template variables.
618 * @param string $name
622 public function get_template_vars($name = NULL) {
623 return self
::$_template->get_template_vars($name);
627 * Setter for embedded.
629 * @param bool $embedded
631 public function setEmbedded($embedded) {
632 $this->_embedded
= $embedded;
636 * Getter for embedded.
639 * return the embedded value
641 public function getEmbedded() {
642 return $this->_embedded
;
646 * Setter for skipRedirection.
648 * @param bool $skipRedirection
650 public function setSkipRedirection($skipRedirection) {
651 $this->_skipRedirection
= $skipRedirection;
655 * Getter for skipRedirection.
658 * return the skipRedirection value
660 public function getSkipRedirection() {
661 return $this->_skipRedirection
;
665 * @param null $fileName
667 public function setWord($fileName = NULL) {
668 //Mark as a CSV file.
669 CRM_Utils_System
::setHttpHeader('Content-Type', 'application/vnd.ms-word');
671 //Force a download and name the file using the current timestamp.
673 $fileName = 'Contacts_' . $_SERVER['REQUEST_TIME'] . '.doc';
675 CRM_Utils_System
::setHttpHeader("Content-Disposition", "attachment; filename=Contacts_$fileName");
679 * @param null $fileName
681 public function setExcel($fileName = NULL) {
682 //Mark as an excel file.
683 CRM_Utils_System
::setHttpHeader('Content-Type', 'application/vnd.ms-excel');
685 //Force a download and name the file using the current timestamp.
687 $fileName = 'Contacts_' . $_SERVER['REQUEST_TIME'] . '.xls';
690 CRM_Utils_System
::setHttpHeader("Content-Disposition", "attachment; filename=Contacts_$fileName");
698 public function setPrint($print) {
699 if ($print == "xls") {
702 elseif ($print == "doc") {
705 $this->_print
= $print;
712 * return the print value
714 public function getPrint() {
715 return $this->_print
;
721 public function getTemplateFile() {
723 if ($this->_print
== CRM_Core_Smarty
::PRINT_PAGE
) {
724 return 'CRM/common/print.tpl';
726 elseif ($this->_print
== 'xls' ||
$this->_print
== 'doc') {
727 return 'CRM/Contact/Form/Task/Excel.tpl';
730 return 'CRM/common/snippet.tpl';
734 $config = CRM_Core_Config
::singleton();
735 return 'CRM/common/' . strtolower($config->userFramework
) . '.tpl';
741 * @param $uploadNames
743 public function addUploadAction($uploadDir, $uploadNames) {
744 if (empty($uploadDir)) {
745 $config = CRM_Core_Config
::singleton();
746 $uploadDir = $config->uploadDir
;
749 if (empty($uploadNames)) {
750 $uploadNames = $this->get('uploadNames');
751 if (!empty($uploadNames)) {
752 $uploadNames = array_merge($uploadNames,
753 CRM_Core_BAO_File
::uploadNames()
757 $uploadNames = CRM_Core_BAO_File
::uploadNames();
761 $action = new CRM_Core_QuickForm_Action_Upload($this->_stateMachine
,
765 $this->addAction('upload', $action);
771 public function setParent($parent) {
772 $this->_parent
= $parent;
778 public function getParent() {
779 return $this->_parent
;
785 public function getDestination() {
786 return $this->_destination
;
791 * @param bool $setToReferer
793 public function setDestination($url = NULL, $setToReferer = FALSE) {
796 $url = $_SERVER['HTTP_REFERER'];
799 $config = CRM_Core_Config
::singleton();
800 $url = $config->userFrameworkBaseURL
;
804 $this->_destination
= $url;
805 $this->set('civicrmDestination', $this->_destination
);
811 public function cancelAction() {
812 $actionName = $this->getActionName();
813 list($pageName, $action) = $actionName;
814 return $this->_pages
[$pageName]->cancelAction();
818 * Write a simple fatal error message.
820 * Other controllers can decide to do something else and present the user a better message
821 * and/or redirect to the same page with a reset url
823 public function invalidKey() {
824 self
::invalidKeyCommon();
827 public function invalidKeyCommon() {
828 $msg = ts("We can't load the requested web page. This page requires cookies to be enabled in your browser settings. Please check this setting and enable cookies (if they are not enabled). Then try again. If this error persists, contact the site administrator for assistance.") . '<br /><br />' . ts('Site Administrators: This error may indicate that users are accessing this page using a domain or URL other than the configured Base URL. EXAMPLE: Base URL is http://example.org, but some users are accessing the page via http://www.example.org or a domain alias like http://myotherexample.org.') . '<br /><br />' . ts('Error type: Could not find a valid session key.');
829 throw new CRM_Core_Exception($msg);
833 * Instead of outputting a fatal error message, we'll just redirect
834 * to the entryURL if present
836 public function invalidKeyRedirect() {
837 if ($this->_entryURL
&& $url_parts = parse_url($this->_entryURL
)) {
838 // CRM-16832: Ensure local redirects only.
839 if (!empty($url_parts['path'])) {
840 // Prepend a slash, but don't duplicate it.
841 $redirect_url = '/' . ltrim($url_parts['path'], '/');
842 if (!empty($url_parts['query'])) {
843 $redirect_url .= '?' . $url_parts['query'];
845 CRM_Core_Session
::setStatus(ts('Your browser session has expired and we are unable to complete your form submission. We have returned you to the initial step so you can complete and resubmit the form. If you experience continued difficulties, please contact us for assistance.'));
846 return CRM_Utils_System
::redirect($redirect_url);
849 self
::invalidKeyCommon();