3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
29 * This class acts as our base controller class and adds additional
30 * functionality and smarts to the base QFC. Specifically we create
31 * our own action classes and handle the transitions ourselves by
32 * simulating a state machine. We also create direct jump links to any
33 * page that can be used universally.
35 * This concept has been discussed on the PEAR list and the QFC FAQ
36 * goes into a few details. Please check
37 * http://pear.php.net/manual/en/package.html.html-quickform-controller.faq.php
38 * for other useful tips and suggestions
41 * @copyright CiviCRM LLC (c) 2004-2019
44 require_once 'HTML/QuickForm/Controller.php';
45 require_once 'HTML/QuickForm/Action/Direct.php';
48 * Class CRM_Core_Controller
50 class CRM_Core_Controller
extends HTML_QuickForm_Controller
{
53 * The title associated with this controller.
60 * The key associated with this controller.
67 * The name of the session scope where values are stored.
74 * The state machine associated with this controller.
78 protected $_stateMachine;
81 * Is this object being embedded in another object. If
82 * so the display routine needs to not do any work. (The
83 * parent object takes care of the display)
87 protected $_embedded = FALSE;
90 * After entire form execution complete,
91 * do we want to skip control redirection.
92 * Default - It get redirect to user context.
94 * Useful when we run form in non civicrm context
95 * and we need to transfer control back.(eg. drupal)
99 protected $_skipRedirection = FALSE;
102 * Are we in print mode? if so we need to modify the display
103 * functionality to do a minimal display :)
110 * Should we generate a qfKey, true by default
114 public $_generateQFKey = TRUE;
121 public $_QFResponseType = 'html';
124 * Cache the smarty template for efficiency reasons.
126 * @var CRM_Core_Smarty
128 static protected $_template;
131 * Cache the session for efficiency reasons.
133 * @var CRM_Core_Session
135 static protected $_session;
138 * The parent of this form if embedded.
142 protected $_parent = NULL;
145 * The destination if set will override the destination the code wants to send it to.
149 public $_destination = NULL;
152 * The entry url for a top level form or wizard. Typically the URL with a reset=1
153 * used to redirect back to when we land into some session wierdness
157 public $_entryURL = NULL;
160 * All CRM single or multi page pages should inherit from this class.
162 * @param string $title
163 * Descriptive title of the controller.
165 * Whether controller is modal.
167 * @param string $scope
168 * Name of session if we want unique scope, used only by Controller_Simple.
169 * @param bool $addSequence
170 * Should we add a unique sequence number to the end of the key.
171 * @param bool $ignoreKey
172 * Should we not set a qfKey for this controller (for standalone forms).
174 public function __construct(
179 $addSequence = FALSE,
182 // this has to true for multiple tab session fix
185 // let the constructor initialize this, should happen only once
186 if (!isset(self
::$_template)) {
187 self
::$_template = CRM_Core_Smarty
::singleton();
188 self
::$_session = CRM_Core_Session
::singleton();
191 // lets try to get it from the session and/or the request vars
192 // we do this early on in case there is a fatal error in retrieving the
193 // key and/or session
195 = CRM_Utils_Request
::retrieve('entryURL', 'String', $this);
197 // add a unique validable key to the name
198 $name = CRM_Utils_System
::getClassName($this);
199 if ($name == 'CRM_Core_Controller_Simple' && !empty($scope)) {
200 // use form name if we have, since its a lot better and
201 // definitely different for different forms
204 $name = $name . '_' . $this->key($name, $addSequence, $ignoreKey);
205 $this->_title
= $title;
207 $this->_scope
= $scope;
210 $this->_scope
= CRM_Utils_System
::getClassName($this);
212 $this->_scope
= $this->_scope
. '_' . $this->_key
;
214 // only use the civicrm cache if we have a valid key
215 // else we clash with other users CRM-7059
216 if (!empty($this->_key
)) {
217 CRM_Core_Session
::registerAndRetrieveSessionObjects([
218 "_{$name}_container",
219 ['CiviCRM', $this->_scope
],
223 parent
::__construct($name, $modal);
225 $snippet = CRM_Utils_Array
::value('snippet', $_REQUEST);
228 $this->_print
= CRM_Core_Smarty
::PRINT_PDF
;
230 elseif ($snippet == 4) {
231 // this is used to embed fragments of a form
232 $this->_print
= CRM_Core_Smarty
::PRINT_NOFORM
;
233 self
::$_template->assign('suppressForm', TRUE);
234 $this->_generateQFKey
= FALSE;
236 elseif ($snippet == 5) {
237 // mode deprecated in favor of json
238 // still used by dashlets, probably nothing else
239 $this->_print
= CRM_Core_Smarty
::PRINT_NOFORM
;
241 // Respond with JSON if in AJAX context (also support legacy value '6')
242 elseif (in_array($snippet, [CRM_Core_Smarty
::PRINT_JSON
, 6])) {
243 $this->_print
= CRM_Core_Smarty
::PRINT_JSON
;
244 $this->_QFResponseType
= 'json';
247 $this->_print
= CRM_Core_Smarty
::PRINT_SNIPPET
;
251 // if the request has a reset value, initialize the controller session
252 if (!empty($_GET['reset'])) {
255 // in this case we'll also cache the url as a hidden form variable, this allows us to
256 // redirect in case the session has disappeared on us
257 $this->_entryURL
= CRM_Utils_System
::makeURL(NULL, TRUE, FALSE, NULL, TRUE);
258 $this->set('entryURL', $this->_entryURL
);
261 // set the key in the session
262 // do this at the end so we have initialized the object
263 // and created the scope etc
264 $this->set('qfKey', $this->_key
);
266 // also retrieve and store destination in session
267 $this->_destination
= CRM_Utils_Request
::retrieve(
268 'civicrmDestination',
277 public function fini() {
278 CRM_Core_BAO_Cache
::storeSessionToCache([
279 "_{$this->_name}_container",
280 ['CiviCRM', $this->_scope
],
285 * @param string $name
286 * @param bool $addSequence
287 * @param bool $ignoreKey
289 * @return mixed|string
291 public function key($name, $addSequence = FALSE, $ignoreKey = FALSE) {
292 $config = CRM_Core_Config
::singleton();
296 (isset($config->keyDisable
) && $config->keyDisable
)
301 $key = CRM_Utils_Array
::value('qfKey', $_REQUEST, NULL);
302 if (!$key && $_SERVER['REQUEST_METHOD'] === 'GET') {
303 $key = CRM_Core_Key
::get($name, $addSequence);
306 $key = CRM_Core_Key
::validate($key, $name, $addSequence);
319 * Process the request, overrides the default QFC run method
320 * This routine actually checks if the QFC is modal and if it
321 * is the first invalid page, if so it call the requested action
322 * if not, it calls the display action on the first invalid page
323 * avoids the issue of users hitting the back button and getting
326 * This run is basically a composition of the original run and the
331 public function run() {
332 // the names of the action and page should be saved
333 // note that this is split into two, because some versions of
334 // php 5.x core dump on the triple assignment :)
335 $this->_actionName
= $this->getActionName();
336 list($pageName, $action) = $this->_actionName
;
338 if ($this->isModal()) {
339 if (!$this->isValid($pageName)) {
340 $pageName = $this->findInvalid();
345 // note that based on action, control might not come back!!
346 // e.g. if action is a valid JUMP, u basically do a redirect
347 // to the appropriate place
348 $this->wizardHeader($pageName);
349 return $this->_pages
[$pageName]->handle($action);
355 public function validate() {
356 $this->_actionName
= $this->getActionName();
357 list($pageName, $action) = $this->_actionName
;
359 $page = &$this->_pages
[$pageName];
361 $data = &$this->container();
362 $this->applyDefaults($pageName);
363 $page->isFormBuilt() or $page->buildForm();
364 // We use defaults and constants as if they were submitted
365 $data['values'][$pageName] = $page->exportValues();
366 $page->loadValues($data['values'][$pageName]);
367 // Is the page now valid?
368 if (TRUE === ($data['valid'][$pageName] = $page->validate())) {
371 return $page->_errors
;
375 * Helper function to add all the needed default actions.
377 * Note that the framework redefines all of the default QFC actions.
379 * @param string $uploadDirectory to store all the uploaded files
380 * @param array $uploadNames for the various upload buttons (note u can have more than 1 upload)
382 public function addActions($uploadDirectory = NULL, $uploadNames = NULL) {
384 'display' => 'CRM_Core_QuickForm_Action_Display',
385 'next' => 'CRM_Core_QuickForm_Action_Next',
386 'back' => 'CRM_Core_QuickForm_Action_Back',
387 'process' => 'CRM_Core_QuickForm_Action_Process',
388 'cancel' => 'CRM_Core_QuickForm_Action_Cancel',
389 'refresh' => 'CRM_Core_QuickForm_Action_Refresh',
390 'reload' => 'CRM_Core_QuickForm_Action_Reload',
391 'done' => 'CRM_Core_QuickForm_Action_Done',
392 'jump' => 'CRM_Core_QuickForm_Action_Jump',
393 'submit' => 'CRM_Core_QuickForm_Action_Submit',
396 foreach ($names as $name => $classPath) {
397 $action = new $classPath($this->_stateMachine
);
398 $this->addAction($name, $action);
401 $this->addUploadAction($uploadDirectory, $uploadNames);
405 * Getter method for stateMachine.
407 * @return CRM_Core_StateMachine
409 public function getStateMachine() {
410 return $this->_stateMachine
;
414 * Setter method for stateMachine.
416 * @param CRM_Core_StateMachine $stateMachine
418 public function setStateMachine($stateMachine) {
419 $this->_stateMachine
= $stateMachine;
423 * Add pages to the controller. Note that the controller does not really care
424 * the order in which the pages are added
426 * @param CRM_Core_StateMachine $stateMachine
427 * @param \const|int $action the mode in which the state machine is operating
428 * typically this will be add/view/edit
430 public function addPages(&$stateMachine, $action = CRM_Core_Action
::NONE
) {
431 $pages = $stateMachine->getPages();
432 foreach ($pages as $name => $value) {
433 $className = CRM_Utils_Array
::value('className', $value, $name);
434 $title = CRM_Utils_Array
::value('title', $value);
435 $options = CRM_Utils_Array
::value('options', $value);
436 $stateName = CRM_Utils_String
::getClassName($className);
437 if (!empty($value['className'])) {
441 $formName = CRM_Utils_String
::getClassName($name);
444 $ext = CRM_Extension_System
::singleton()->getMapper();
445 if ($ext->isExtensionClass($className)) {
446 require_once $ext->classToPath($className);
449 require_once str_replace('_', DIRECTORY_SEPARATOR
, $className) . '.php';
451 $
$stateName = new $className($stateMachine->find($className), $action, 'post', $formName);
453 $
$stateName->setTitle($title);
456 $
$stateName->setOptions($options);
458 if (property_exists($
$stateName, 'urlPath')) {
459 $
$stateName->urlPath
= explode('/', (string) CRM_Utils_System
::getUrlPath());
461 $this->addPage($
$stateName);
462 $this->addAction($stateName, new HTML_QuickForm_Action_Direct());
464 //CRM-6342 -we need kill the reference here,
465 //as we have deprecated reference object creation.
471 * QFC does not provide native support to have different 'submit' buttons.
472 * We introduce this notion to QFC by using button specific data. Thus if
473 * we have two submit buttons, we could have one displayed as a button and
474 * the other as an image, both are of type 'submit'.
477 * the name of the button that has been pressed by the user
479 public function getButtonName() {
480 $data = &$this->container();
481 return CRM_Utils_Array
::value('_qf_button_name', $data);
485 * Destroy all the session state of the controller.
487 public function reset() {
488 $this->container(TRUE);
489 self
::$_session->resetScope($this->_scope
);
493 * Virtual function to do any processing of data.
495 * Sometimes it is useful for the controller to actually process data.
496 * This is typically used when we need the controller to figure out
497 * what pages are potentially involved in this wizard. (this is dynamic
498 * and can change based on the arguments
500 public function process() {
504 * Store the variable with the value in the form scope.
506 * @param string|array $name name of the variable or an assoc array of name/value pairs
507 * @param mixed $value
508 * Value of the variable if string.
510 public function set($name, $value = NULL) {
511 self
::$_session->set($name, $value, $this->_scope
);
515 * Get the variable from the form scope.
517 * @param string $name
518 * name of the variable.
522 public function get($name) {
523 return self
::$_session->get($name, $this->_scope
);
527 * Create the header for the wizard from the list of pages.
528 * Store the created header in smarty
530 * @param string $currentPageName
531 * Name of the page being displayed.
535 public function wizardHeader($currentPageName) {
537 $wizard['steps'] = [];
539 foreach ($this->_pages
as $name => $page) {
541 $wizard['steps'][] = [
543 'title' => $page->getTitle(),
544 //'link' => $page->getLink ( ),
548 'stepNumber' => $count,
549 'collapsed' => FALSE,
552 if ($name == $currentPageName) {
553 $wizard['currentStepNumber'] = $count;
554 $wizard['currentStepName'] = $name;
555 $wizard['currentStepTitle'] = $page->getTitle();
559 $wizard['stepCount'] = $count;
561 $this->addWizardStyle($wizard);
563 $this->assign('wizard', $wizard);
568 * @param array $wizard
570 public function addWizardStyle(&$wizard) {
573 'stepPrefixCurrent' => '»',
574 'stepPrefixPast' => '✔',
575 'stepPrefixFuture' => ' ',
576 'subStepPrefixCurrent' => ' ',
577 'subStepPrefixPast' => ' ',
578 'subStepPrefixFuture' => ' ',
584 * Assign value to name in template.
587 * @param mixed $value
590 public function assign($var, $value = NULL) {
591 self
::$_template->assign($var, $value);
595 * Assign value to name in template by reference.
598 * @param mixed $value
599 * (reference) value of variable.
601 public function assign_by_ref($var, &$value) {
602 self
::$_template->assign_by_ref($var, $value);
606 * Appends values to template variables.
608 * @param array|string $tpl_var the template variable name(s)
609 * @param mixed $value
610 * The value to append.
613 public function append($tpl_var, $value = NULL, $merge = FALSE) {
614 self
::$_template->append($tpl_var, $value, $merge);
618 * Returns an array containing template variables.
620 * @param string $name
624 public function get_template_vars($name = NULL) {
625 return self
::$_template->get_template_vars($name);
629 * Setter for embedded.
631 * @param bool $embedded
633 public function setEmbedded($embedded) {
634 $this->_embedded
= $embedded;
638 * Getter for embedded.
641 * return the embedded value
643 public function getEmbedded() {
644 return $this->_embedded
;
648 * Setter for skipRedirection.
650 * @param bool $skipRedirection
652 public function setSkipRedirection($skipRedirection) {
653 $this->_skipRedirection
= $skipRedirection;
657 * Getter for skipRedirection.
660 * return the skipRedirection value
662 public function getSkipRedirection() {
663 return $this->_skipRedirection
;
667 * @param null $fileName
669 public function setWord($fileName = NULL) {
670 //Mark as a CSV file.
671 CRM_Utils_System
::setHttpHeader('Content-Type', 'application/vnd.ms-word');
673 //Force a download and name the file using the current timestamp.
675 $fileName = 'Contacts_' . $_SERVER['REQUEST_TIME'] . '.doc';
677 CRM_Utils_System
::setHttpHeader("Content-Disposition", "attachment; filename=Contacts_$fileName");
681 * @param null $fileName
683 public function setExcel($fileName = NULL) {
684 //Mark as an excel file.
685 CRM_Utils_System
::setHttpHeader('Content-Type', 'application/vnd.ms-excel');
687 //Force a download and name the file using the current timestamp.
689 $fileName = 'Contacts_' . $_SERVER['REQUEST_TIME'] . '.xls';
692 CRM_Utils_System
::setHttpHeader("Content-Disposition", "attachment; filename=Contacts_$fileName");
700 public function setPrint($print) {
701 if ($print == "xls") {
704 elseif ($print == "doc") {
707 $this->_print
= $print;
714 * return the print value
716 public function getPrint() {
717 return $this->_print
;
723 public function getTemplateFile() {
725 if ($this->_print
== CRM_Core_Smarty
::PRINT_PAGE
) {
726 return 'CRM/common/print.tpl';
728 elseif ($this->_print
== 'xls' ||
$this->_print
== 'doc') {
729 return 'CRM/Contact/Form/Task/Excel.tpl';
732 return 'CRM/common/snippet.tpl';
736 $config = CRM_Core_Config
::singleton();
737 return 'CRM/common/' . strtolower($config->userFramework
) . '.tpl';
743 * @param $uploadNames
745 public function addUploadAction($uploadDir, $uploadNames) {
746 if (empty($uploadDir)) {
747 $config = CRM_Core_Config
::singleton();
748 $uploadDir = $config->uploadDir
;
751 if (empty($uploadNames)) {
752 $uploadNames = $this->get('uploadNames');
753 if (!empty($uploadNames)) {
754 $uploadNames = array_merge($uploadNames,
755 CRM_Core_BAO_File
::uploadNames()
759 $uploadNames = CRM_Core_BAO_File
::uploadNames();
763 $action = new CRM_Core_QuickForm_Action_Upload($this->_stateMachine
,
767 $this->addAction('upload', $action);
773 public function setParent($parent) {
774 $this->_parent
= $parent;
780 public function getParent() {
781 return $this->_parent
;
787 public function getDestination() {
788 return $this->_destination
;
793 * @param bool $setToReferer
795 public function setDestination($url = NULL, $setToReferer = FALSE) {
798 $url = $_SERVER['HTTP_REFERER'];
801 $config = CRM_Core_Config
::singleton();
802 $url = $config->userFrameworkBaseURL
;
806 $this->_destination
= $url;
807 $this->set('civicrmDestination', $this->_destination
);
813 public function cancelAction() {
814 $actionName = $this->getActionName();
815 list($pageName, $action) = $actionName;
816 return $this->_pages
[$pageName]->cancelAction();
820 * Write a simple fatal error message.
822 * Other controllers can decide to do something else and present the user a better message
823 * and/or redirect to the same page with a reset url
825 public function invalidKey() {
826 self
::invalidKeyCommon();
829 public function invalidKeyCommon() {
830 $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.');
831 CRM_Core_Error
::fatal($msg);
835 * Instead of outputting a fatal error message, we'll just redirect
836 * to the entryURL if present
838 public function invalidKeyRedirect() {
839 if ($this->_entryURL
&& $url_parts = parse_url($this->_entryURL
)) {
840 // CRM-16832: Ensure local redirects only.
841 if (!empty($url_parts['path'])) {
842 // Prepend a slash, but don't duplicate it.
843 $redirect_url = '/' . ltrim($url_parts['path'], '/');
844 if (!empty($url_parts['query'])) {
845 $redirect_url .= '?' . $url_parts['query'];
847 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.'));
848 return CRM_Utils_System
::redirect($redirect_url);
851 self
::invalidKeyCommon();