3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2016 |
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-2016
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(array(
218 "_{$name}_container",
219 array('CiviCRM', $this->_scope
),
223 $this->HTML_QuickForm_Controller($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, array(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(array(
279 "_{$this->_name}_container",
280 array('CiviCRM', $this->_scope
),
287 * @param string $name
288 * @param bool $addSequence
289 * @param bool $ignoreKey
291 * @return mixed|string
293 public function key($name, $addSequence = FALSE, $ignoreKey = FALSE) {
294 $config = CRM_Core_Config
::singleton();
298 (isset($config->keyDisable
) && $config->keyDisable
)
303 $key = CRM_Utils_Array
::value('qfKey', $_REQUEST, NULL);
304 if (!$key && $_SERVER['REQUEST_METHOD'] === 'GET') {
305 $key = CRM_Core_Key
::get($name, $addSequence);
308 $key = CRM_Core_Key
::validate($key, $name, $addSequence);
321 * Process the request, overrides the default QFC run method
322 * This routine actually checks if the QFC is modal and if it
323 * is the first invalid page, if so it call the requested action
324 * if not, it calls the display action on the first invalid page
325 * avoids the issue of users hitting the back button and getting
328 * This run is basically a composition of the original run and the
333 public function run() {
334 // the names of the action and page should be saved
335 // note that this is split into two, because some versions of
336 // php 5.x core dump on the triple assignment :)
337 $this->_actionName
= $this->getActionName();
338 list($pageName, $action) = $this->_actionName
;
340 if ($this->isModal()) {
341 if (!$this->isValid($pageName)) {
342 $pageName = $this->findInvalid();
347 // note that based on action, control might not come back!!
348 // e.g. if action is a valid JUMP, u basically do a redirect
349 // to the appropriate place
350 $this->wizardHeader($pageName);
351 return $this->_pages
[$pageName]->handle($action);
357 public function validate() {
358 $this->_actionName
= $this->getActionName();
359 list($pageName, $action) = $this->_actionName
;
361 $page = &$this->_pages
[$pageName];
363 $data = &$this->container();
364 $this->applyDefaults($pageName);
365 $page->isFormBuilt() or $page->buildForm();
366 // We use defaults and constants as if they were submitted
367 $data['values'][$pageName] = $page->exportValues();
368 $page->loadValues($data['values'][$pageName]);
369 // Is the page now valid?
370 if (TRUE === ($data['valid'][$pageName] = $page->validate())) {
373 return $page->_errors
;
377 * Helper function to add all the needed default actions.
379 * Note that the framework redefines all of the default QFC actions.
381 * @param string $uploadDirectory to store all the uploaded files
382 * @param array $uploadNames for the various upload buttons (note u can have more than 1 upload)
384 public function addActions($uploadDirectory = NULL, $uploadNames = NULL) {
386 'display' => 'CRM_Core_QuickForm_Action_Display',
387 'next' => 'CRM_Core_QuickForm_Action_Next',
388 'back' => 'CRM_Core_QuickForm_Action_Back',
389 'process' => 'CRM_Core_QuickForm_Action_Process',
390 'cancel' => 'CRM_Core_QuickForm_Action_Cancel',
391 'refresh' => 'CRM_Core_QuickForm_Action_Refresh',
392 'reload' => 'CRM_Core_QuickForm_Action_Reload',
393 'done' => 'CRM_Core_QuickForm_Action_Done',
394 'jump' => 'CRM_Core_QuickForm_Action_Jump',
395 'submit' => 'CRM_Core_QuickForm_Action_Submit',
398 foreach ($names as $name => $classPath) {
399 $action = new $classPath($this->_stateMachine
);
400 $this->addAction($name, $action);
403 $this->addUploadAction($uploadDirectory, $uploadNames);
407 * Getter method for stateMachine.
409 * @return CRM_Core_StateMachine
411 public function getStateMachine() {
412 return $this->_stateMachine
;
416 * Setter method for stateMachine.
418 * @param CRM_Core_StateMachine $stateMachine
420 public function setStateMachine($stateMachine) {
421 $this->_stateMachine
= $stateMachine;
425 * Add pages to the controller. Note that the controller does not really care
426 * the order in which the pages are added
428 * @param CRM_Core_StateMachine $stateMachine
429 * @param \const|int $action the mode in which the state machine is operating
430 * typically this will be add/view/edit
432 public function addPages(&$stateMachine, $action = CRM_Core_Action
::NONE
) {
433 $pages = $stateMachine->getPages();
434 foreach ($pages as $name => $value) {
435 $className = CRM_Utils_Array
::value('className', $value, $name);
436 $title = CRM_Utils_Array
::value('title', $value);
437 $options = CRM_Utils_Array
::value('options', $value);
438 $stateName = CRM_Utils_String
::getClassName($className);
439 if (!empty($value['className'])) {
443 $formName = CRM_Utils_String
::getClassName($name);
446 $ext = CRM_Extension_System
::singleton()->getMapper();
447 if ($ext->isExtensionClass($className)) {
448 require_once $ext->classToPath($className);
451 require_once str_replace('_', DIRECTORY_SEPARATOR
, $className) . '.php';
453 $
$stateName = new $className($stateMachine->find($className), $action, 'post', $formName);
455 $
$stateName->setTitle($title);
458 $
$stateName->setOptions($options);
460 if (property_exists($
$stateName, 'urlPath') && isset($_GET[CRM_Core_Config
::singleton()->userFrameworkURLVar
])) {
461 $
$stateName->urlPath
= explode('/', $_GET[CRM_Core_Config
::singleton()->userFrameworkURLVar
]);
463 $this->addPage($
$stateName);
464 $this->addAction($stateName, new HTML_QuickForm_Action_Direct());
466 //CRM-6342 -we need kill the reference here,
467 //as we have deprecated reference object creation.
473 * QFC does not provide native support to have different 'submit' buttons.
474 * We introduce this notion to QFC by using button specific data. Thus if
475 * we have two submit buttons, we could have one displayed as a button and
476 * the other as an image, both are of type 'submit'.
479 * the name of the button that has been pressed by the user
481 public function getButtonName() {
482 $data = &$this->container();
483 return CRM_Utils_Array
::value('_qf_button_name', $data);
487 * Destroy all the session state of the controller.
489 public function reset() {
490 $this->container(TRUE);
491 self
::$_session->resetScope($this->_scope
);
495 * Virtual function to do any processing of data.
497 * Sometimes it is useful for the controller to actually process data.
498 * This is typically used when we need the controller to figure out
499 * what pages are potentially involved in this wizard. (this is dynamic
500 * and can change based on the arguments
502 public function process() {
506 * Store the variable with the value in the form scope.
508 * @param string|array $name name of the variable or an assoc array of name/value pairs
509 * @param mixed $value
510 * Value of the variable if string.
512 public function set($name, $value = NULL) {
513 self
::$_session->set($name, $value, $this->_scope
);
517 * Get the variable from the form scope.
519 * @param string $name
520 * name of the variable.
524 public function get($name) {
525 return self
::$_session->get($name, $this->_scope
);
529 * Create the header for the wizard from the list of pages.
530 * Store the created header in smarty
532 * @param string $currentPageName
533 * Name of the page being displayed.
537 public function wizardHeader($currentPageName) {
539 $wizard['steps'] = array();
541 foreach ($this->_pages
as $name => $page) {
543 $wizard['steps'][] = array(
545 'title' => $page->getTitle(),
546 //'link' => $page->getLink ( ),
550 'stepNumber' => $count,
551 'collapsed' => FALSE,
554 if ($name == $currentPageName) {
555 $wizard['currentStepNumber'] = $count;
556 $wizard['currentStepName'] = $name;
557 $wizard['currentStepTitle'] = $page->getTitle();
561 $wizard['stepCount'] = $count;
563 $this->addWizardStyle($wizard);
565 $this->assign('wizard', $wizard);
570 * @param array $wizard
572 public function addWizardStyle(&$wizard) {
573 $wizard['style'] = array(
575 'stepPrefixCurrent' => '»',
576 'stepPrefixPast' => '✔',
577 'stepPrefixFuture' => ' ',
578 'subStepPrefixCurrent' => ' ',
579 'subStepPrefixPast' => ' ',
580 'subStepPrefixFuture' => ' ',
586 * Assign value to name in template.
589 * @param mixed $value
592 public function assign($var, $value = NULL) {
593 self
::$_template->assign($var, $value);
597 * Assign value to name in template by reference.
600 * @param mixed $value
601 * (reference) value of variable.
603 public function assign_by_ref($var, &$value) {
604 self
::$_template->assign_by_ref($var, $value);
608 * Appends values to template variables.
610 * @param array|string $tpl_var the template variable name(s)
611 * @param mixed $value
612 * The value to append.
615 public function append($tpl_var, $value = NULL, $merge = FALSE) {
616 self
::$_template->append($tpl_var, $value, $merge);
620 * Returns an array containing template variables.
622 * @param string $name
626 public function get_template_vars($name = NULL) {
627 return self
::$_template->get_template_vars($name);
631 * Setter for embedded.
633 * @param bool $embedded
635 public function setEmbedded($embedded) {
636 $this->_embedded
= $embedded;
640 * Getter for embedded.
643 * return the embedded value
645 public function getEmbedded() {
646 return $this->_embedded
;
650 * Setter for skipRedirection.
652 * @param bool $skipRedirection
654 public function setSkipRedirection($skipRedirection) {
655 $this->_skipRedirection
= $skipRedirection;
659 * Getter for skipRedirection.
662 * return the skipRedirection value
664 public function getSkipRedirection() {
665 return $this->_skipRedirection
;
669 * @param null $fileName
671 public function setWord($fileName = NULL) {
672 //Mark as a CSV file.
673 CRM_Utils_System
::setHttpHeader('Content-Type', 'application/vnd.ms-word');
675 //Force a download and name the file using the current timestamp.
677 $fileName = 'Contacts_' . $_SERVER['REQUEST_TIME'] . '.doc';
679 CRM_Utils_System
::setHttpHeader("Content-Disposition", "attachment; filename=Contacts_$fileName");
683 * @param null $fileName
685 public function setExcel($fileName = NULL) {
686 //Mark as an excel file.
687 CRM_Utils_System
::setHttpHeader('Content-Type', 'application/vnd.ms-excel');
689 //Force a download and name the file using the current timestamp.
691 $fileName = 'Contacts_' . $_SERVER['REQUEST_TIME'] . '.xls';
694 CRM_Utils_System
::setHttpHeader("Content-Disposition", "attachment; filename=Contacts_$fileName");
702 public function setPrint($print) {
703 if ($print == "xls") {
706 elseif ($print == "doc") {
709 $this->_print
= $print;
716 * return the print value
718 public function getPrint() {
719 return $this->_print
;
725 public function getTemplateFile() {
727 if ($this->_print
== CRM_Core_Smarty
::PRINT_PAGE
) {
728 return 'CRM/common/print.tpl';
730 elseif ($this->_print
== 'xls' ||
$this->_print
== 'doc') {
731 return 'CRM/Contact/Form/Task/Excel.tpl';
734 return 'CRM/common/snippet.tpl';
738 $config = CRM_Core_Config
::singleton();
739 return 'CRM/common/' . strtolower($config->userFramework
) . '.tpl';
745 * @param $uploadNames
747 public function addUploadAction($uploadDir, $uploadNames) {
748 if (empty($uploadDir)) {
749 $config = CRM_Core_Config
::singleton();
750 $uploadDir = $config->uploadDir
;
753 if (empty($uploadNames)) {
754 $uploadNames = $this->get('uploadNames');
755 if (!empty($uploadNames)) {
756 $uploadNames = array_merge($uploadNames,
757 CRM_Core_BAO_File
::uploadNames()
761 $uploadNames = CRM_Core_BAO_File
::uploadNames();
765 $action = new CRM_Core_QuickForm_Action_Upload($this->_stateMachine
,
769 $this->addAction('upload', $action);
775 public function setParent($parent) {
776 $this->_parent
= $parent;
782 public function getParent() {
783 return $this->_parent
;
789 public function getDestination() {
790 return $this->_destination
;
795 * @param bool $setToReferer
797 public function setDestination($url = NULL, $setToReferer = FALSE) {
800 $url = $_SERVER['HTTP_REFERER'];
803 $config = CRM_Core_Config
::singleton();
804 $url = $config->userFrameworkBaseURL
;
808 $this->_destination
= $url;
809 $this->set('civicrmDestination', $this->_destination
);
815 public function cancelAction() {
816 $actionName = $this->getActionName();
817 list($pageName, $action) = $actionName;
818 return $this->_pages
[$pageName]->cancelAction();
822 * Write a simple fatal error message.
824 * Other controllers can decide to do something else and present the user a better message
825 * and/or redirect to the same page with a reset url
827 public function invalidKey() {
828 self
::invalidKeyCommon();
831 public function invalidKeyCommon() {
832 $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.');
833 CRM_Core_Error
::fatal($msg);
837 * Instead of outputting a fatal error message, we'll just redirect
838 * to the entryURL if present
840 public function invalidKeyRedirect() {
841 if ($this->_entryURL
&& $url_parts = parse_url($this->_entryURL
)) {
842 // CRM-16832: Ensure local redirects only.
843 if (!empty($url_parts['path'])) {
844 // Prepend a slash, but don't duplicate it.
845 $redirect_url = '/' . ltrim($url_parts['path'], '/');
846 if (!empty($url_parts['query'])) {
847 $redirect_url .= '?' . $url_parts['query'];
849 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.'));
850 return CRM_Utils_System
::redirect($redirect_url);
853 self
::invalidKeyCommon();