3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
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-2013
46 require_once 'HTML/QuickForm/Controller.php';
47 require_once 'HTML/QuickForm/Action/Direct.php';
49 class CRM_Core_Controller
extends HTML_QuickForm_Controller
{
52 * the title associated with this controller
59 * The key associated with this controller
66 * the name of the session scope where values are stored
73 * the state machine associated with this controller
77 protected $_stateMachine;
80 * Is this object being embedded in another object. If
81 * so the display routine needs to not do any work. (The
82 * parent object takes care of the display)
86 protected $_embedded = FALSE;
89 * After entire form execution complete,
90 * do we want to skip control redirection.
91 * Default - It get redirect to user context.
93 * Useful when we run form in non civicrm context
94 * and we need to transfer control back.(eg. drupal)
98 protected $_skipRedirection = FALSE;
101 * Are we in print mode? if so we need to modify the display
102 * functionality to do a minimal display :)
109 * Should we generate a qfKey, true by default
113 public $_generateQFKey = TRUE;
118 public $_QFResponseType = 'html';
121 * cache the smarty template for efficiency reasons
123 * @var CRM_Core_Smarty
125 static protected $_template;
128 * cache the session for efficiency reasons
130 * @var CRM_Core_Session
132 static protected $_session;
135 * The parent of this form if embedded
139 protected $_parent = NULL;
142 * The destination if set will override the destination the code wants to send it to
146 public $_destination = NULL;
149 * The entry url for a top level form or wizard. Typically the URL with a reset=1
150 * used to redirect back to when we land into some session wierdness
154 public $_entryURL = NULL;
157 * All CRM single or multi page pages should inherit from this class.
159 * @param string title descriptive title of the controller
160 * @param boolean whether controller is modal
161 * @param string scope name of session if we want unique scope, used only by Controller_Simple
162 * @param boolean addSequence should we add a unique sequence number to the end of the key
163 * @param boolean ignoreKey should we not set a qfKey for this controller (for standalone forms)
170 function __construct(
175 $addSequence = FALSE,
178 // this has to true for multiple tab session fix
181 // let the constructor initialize this, should happen only once
182 if (!isset(self
::$_template)) {
183 self
::$_template = CRM_Core_Smarty
::singleton();
184 self
::$_session = CRM_Core_Session
::singleton();
187 // lets try to get it from the session and/or the request vars
188 // we do this early on in case there is a fatal error in retrieving the
189 // key and/or session
190 $this->_entryURL
= CRM_Utils_Request
::retrieve(
199 // add a unique validable key to the name
200 $name = CRM_Utils_System
::getClassName($this);
201 if ($name == 'CRM_Core_Controller_Simple' && !empty($scope)) {
202 // use form name if we have, since its a lot better and
203 // definitely different for different forms
206 $name = $name . '_' . $this->key($name, $addSequence, $ignoreKey);
207 $this->_title
= $title;
209 $this->_scope
= $scope;
212 $this->_scope
= CRM_Utils_System
::getClassName($this);
214 $this->_scope
= $this->_scope
. '_' . $this->_key
;
216 // only use the civicrm cache if we have a valid key
217 // else we clash with other users CRM-7059
218 if (!empty($this->_key
)) {
219 CRM_Core_Session
::registerAndRetrieveSessionObjects(array(
220 "_{$name}_container",
221 array('CiviCRM', $this->_scope
),
225 $this->HTML_QuickForm_Controller($name, $modal);
227 $snippet = CRM_Utils_Array
::value('snippet', $_REQUEST);
230 $this->_print
= CRM_Core_Smarty
::PRINT_PDF
;
232 elseif ($snippet == 4) {
233 // this is used to embed fragments of a form
234 $this->_print
= CRM_Core_Smarty
::PRINT_NOFORM
;
235 self
::$_template->assign('suppressForm', TRUE);
236 $this->_generateQFKey
= FALSE;
238 elseif ($snippet == 5) {
239 // this is used for popups and inlined ajax forms
240 // also used for the various tabs via TabHeader
241 $this->_print
= CRM_Core_Smarty
::PRINT_NOFORM
;
243 elseif ($snippet == 6) {
244 $this->_print
= CRM_Core_Smarty
::PRINT_NOFORM
;
245 $this->_QFResponseType
= 'json';
248 $this->_print
= CRM_Core_Smarty
::PRINT_SNIPPET
;
252 // if the request has a reset value, initialize the controller session
253 if (CRM_Utils_Array
::value('reset', $_GET)) {
256 // in this case we'll also cache the url as a hidden form variable, this allows us to
257 // redirect in case the session has disappeared on us
258 $this->_entryURL
= CRM_Utils_System
::makeURL(NULL, TRUE, FALSE, NULL, TRUE);
259 $this->set('entryURL', $this->_entryURL
);
262 // set the key in the session
263 // do this at the end so we have initialized the object
264 // and created the scope etc
265 $this->set('qfKey', $this->_key
);
268 // also retrieve and store destination in session
269 $this->_destination
= CRM_Utils_Request
::retrieve(
270 'civicrmDestination',
280 CRM_Core_BAO_Cache
::storeSessionToCache(array(
281 "_{$this->_name}_container",
282 array('CiviCRM', $this->_scope
),
288 function key($name, $addSequence = FALSE, $ignoreKey = FALSE) {
289 $config = CRM_Core_Config
::singleton();
293 (isset($config->keyDisable
) && $config->keyDisable
)
298 $key = CRM_Utils_Array
::value('qfKey', $_REQUEST, NULL);
299 if (!$key && $_SERVER['REQUEST_METHOD'] === 'GET') {
300 $key = CRM_Core_Key
::get($name, $addSequence);
303 $key = CRM_Core_Key
::validate($key, $name, $addSequence);
316 * Process the request, overrides the default QFC run method
317 * This routine actually checks if the QFC is modal and if it
318 * is the first invalid page, if so it call the requested action
319 * if not, it calls the display action on the first invalid page
320 * avoids the issue of users hitting the back button and getting
323 * This run is basically a composition of the original run and the
328 // the names of the action and page should be saved
329 // note that this is split into two, because some versions of
330 // php 5.x core dump on the triple assignment :)
331 $this->_actionName
= $this->getActionName();
332 list($pageName, $action) = $this->_actionName
;
334 if ($this->isModal()) {
335 if (!$this->isValid($pageName)) {
336 $pageName = $this->findInvalid();
341 // note that based on action, control might not come back!!
342 // e.g. if action is a valid JUMP, u basically do a redirect
343 // to the appropriate place
344 $this->wizardHeader($pageName);
345 return $this->_pages
[$pageName]->handle($action);
348 function validate() {
349 $this->_actionName
= $this->getActionName();
350 list($pageName, $action) = $this->_actionName
;
352 $page = &$this->_pages
[$pageName];
354 $data = &$this->container();
355 $this->applyDefaults($pageName);
356 $page->isFormBuilt() or $page->buildForm();
357 // We use defaults and constants as if they were submitted
358 $data['values'][$pageName] = $page->exportValues();
359 $page->loadValues($data['values'][$pageName]);
360 // Is the page now valid?
361 if (TRUE === ($data['valid'][$pageName] = $page->validate())) {
364 return $page->_errors
;
368 * Helper function to add all the needed default actions. Note that the framework
369 * redefines all of the default QFC actions
371 * @param string directory to store all the uploaded files
372 * @param array names for the various upload buttons (note u can have more than 1 upload)
379 function addActions($uploadDirectory = NULL, $uploadNames = NULL) {
381 'display' => 'CRM_Core_QuickForm_Action_Display',
382 'next' => 'CRM_Core_QuickForm_Action_Next',
383 'back' => 'CRM_Core_QuickForm_Action_Back',
384 'process' => 'CRM_Core_QuickForm_Action_Process',
385 'cancel' => 'CRM_Core_QuickForm_Action_Cancel',
386 'refresh' => 'CRM_Core_QuickForm_Action_Refresh',
387 'reload' => 'CRM_Core_QuickForm_Action_Reload',
388 'done' => 'CRM_Core_QuickForm_Action_Done',
389 'jump' => 'CRM_Core_QuickForm_Action_Jump',
390 'submit' => 'CRM_Core_QuickForm_Action_Submit',
393 foreach ($names as $name => $classPath) {
394 $action = new $classPath($this->_stateMachine
);
395 $this->addAction($name, $action);
398 $this->addUploadAction($uploadDirectory, $uploadNames);
402 * getter method for stateMachine
407 function getStateMachine() {
408 return $this->_stateMachine
;
412 * setter method for stateMachine
414 * @param object a stateMachineObject
419 function setStateMachine($stateMachine) {
420 $this->_stateMachine
= $stateMachine;
424 * add pages to the controller. Note that the controller does not really care
425 * the order in which the pages are added
427 * @param object $stateMachine the state machine object
428 * @param int $action the mode in which the state machine is operating
429 * typicaly this will be add/view/edit
435 function addPages(&$stateMachine, $action = CRM_Core_Action
::NONE
) {
436 $pages = $stateMachine->getPages();
437 foreach ($pages as $name => $value) {
438 $className = CRM_Utils_Array
::value('className', $value, $name);
439 $title = CRM_Utils_Array
::value('title', $value);
440 $options = CRM_Utils_Array
::value('options', $value);
441 $stateName = CRM_Utils_String
::getClassName($className);
442 if (CRM_Utils_Array
::value('className', $value)) {
446 $formName = CRM_Utils_String
::getClassName($name);
449 $ext = CRM_Extension_System
::singleton()->getMapper();
450 if ($ext->isExtensionClass($className)) {
451 require_once ($ext->classToPath($className));
454 require_once (str_replace('_', DIRECTORY_SEPARATOR
, $className) . '.php');
456 $
$stateName = new $className($stateMachine->find($className), $action, 'post', $formName);
458 $
$stateName->setTitle($title);
461 $
$stateName->setOptions($options);
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'.
478 * @return string the name of the button that has been pressed by the user
481 function getButtonName() {
482 $data = &$this->container();
483 return CRM_Utils_Array
::value('_qf_button_name', $data);
487 * function to destroy all the session state of the controller.
494 $this->container(TRUE);
495 self
::$_session->resetScope($this->_scope
);
499 * virtual function to do any processing of data.
500 * Sometimes it is useful for the controller to actually process data.
501 * This is typically used when we need the controller to figure out
502 * what pages are potentially involved in this wizard. (this is dynamic
503 * and can change based on the arguments
508 function process() {}
511 * Store the variable with the value in the form scope
513 * @param string|array $name name of the variable or an assoc array of name/value pairs
514 * @param mixed $value value of the variable if string
521 function set($name, $value = NULL) {
522 self
::$_session->set($name, $value, $this->_scope
);
526 * Get the variable from the form scope
528 * @param string name : name of the variable
536 function get($name) {
537 return self
::$_session->get($name, $this->_scope
);
541 * Create the header for the wizard from the list of pages
542 * Store the created header in smarty
544 * @param string $currentPageName name of the page being displayed
549 function wizardHeader($currentPageName) {
551 $wizard['steps'] = array();
553 foreach ($this->_pages
as $name => $page) {
555 $wizard['steps'][] = array(
557 'title' => $page->getTitle(),
558 //'link' => $page->getLink ( ),
562 'stepNumber' => $count,
563 'collapsed' => FALSE,
566 if ($name == $currentPageName) {
567 $wizard['currentStepNumber'] = $count;
568 $wizard['currentStepName'] = $name;
569 $wizard['currentStepTitle'] = $page->getTitle();
573 $wizard['stepCount'] = $count;
575 $this->addWizardStyle($wizard);
577 $this->assign('wizard', $wizard);
581 function addWizardStyle(&$wizard) {
582 $wizard['style'] = array(
584 'stepPrefixCurrent' => '»',
585 'stepPrefixPast' => '√',
586 'stepPrefixFuture' => ' ',
587 'subStepPrefixCurrent' => ' ',
588 'subStepPrefixPast' => ' ',
589 'subStepPrefixFuture' => ' ',
595 * assign value to name in template
597 * @param array|string $name name of variable
598 * @param mixed $value value of varaible
603 function assign($var, $value = NULL) {
604 self
::$_template->assign($var, $value);
607 function assign_by_ref($var, &$value) {
608 self
::$_template->assign_by_ref($var, $value);
612 * setter for embedded
614 * @param boolean $embedded
619 function setEmbedded($embedded) {
620 $this->_embedded
= $embedded;
624 * getter for embedded
626 * @return boolean return the embedded value
629 function getEmbedded() {
630 return $this->_embedded
;
634 * setter for skipRedirection
636 * @param boolean $skipRedirection
641 function setSkipRedirection($skipRedirection) {
642 $this->_skipRedirection
= $skipRedirection;
646 * getter for skipRedirection
648 * @return boolean return the skipRedirection value
651 function getSkipRedirection() {
652 return $this->_skipRedirection
;
655 function setWord($fileName = NULL) {
656 //Mark as a CSV file.
657 header('Content-Type: application/vnd.ms-word');
659 //Force a download and name the file using the current timestamp.
661 $fileName = 'Contacts_' . $_SERVER['REQUEST_TIME'] . '.doc';
663 header("Content-Disposition: attachment; filename=Contacts_$fileName");
666 function setExcel($fileName = NULL) {
667 //Mark as an excel file.
668 header('Content-Type: application/vnd.ms-excel');
670 //Force a download and name the file using the current timestamp.
672 $fileName = 'Contacts_' . $_SERVER['REQUEST_TIME'] . '.xls';
675 header("Content-Disposition: attachment; filename=Contacts_$fileName");
681 * @param boolean $print
686 function setPrint($print) {
687 if ($print == "xls") {
690 elseif ($print == "doc") {
693 $this->_print
= $print;
699 * @return boolean return the print value
702 function getPrint() {
703 return $this->_print
;
706 function getTemplateFile() {
708 if ($this->_print
== CRM_Core_Smarty
::PRINT_PAGE
) {
709 return 'CRM/common/print.tpl';
711 elseif ($this->_print
== 'xls' ||
$this->_print
== 'doc') {
712 return 'CRM/Contact/Form/Task/Excel.tpl';
715 return 'CRM/common/snippet.tpl';
719 $config = CRM_Core_Config
::singleton();
720 return 'CRM/common/' . strtolower($config->userFramework
) . '.tpl';
724 public function addUploadAction($uploadDir, $uploadNames) {
725 if (empty($uploadDir)) {
726 $config = CRM_Core_Config
::singleton();
727 $uploadDir = $config->uploadDir
;
730 if (empty($uploadNames)) {
731 $uploadNames = $this->get('uploadNames');
732 if (!empty($uploadNames)) {
733 $uploadNames = array_merge($uploadNames,
734 CRM_Core_BAO_File
::uploadNames()
738 $uploadNames = CRM_Core_BAO_File
::uploadNames();
742 $action = new CRM_Core_QuickForm_Action_Upload($this->_stateMachine
,
746 $this->addAction('upload', $action);
749 public function setParent($parent) {
750 $this->_parent
= $parent;
753 public function getParent() {
754 return $this->_parent
;
757 public function getDestination() {
758 return $this->_destination
;
761 public function setDestination($url = NULL, $setToReferer = FALSE) {
764 $url = $_SERVER['HTTP_REFERER'];
767 $config = CRM_Core_Config
::singleton();
768 $url = $config->userFrameworkBaseURL
;
772 $this->_destination
= $url;
773 $this->set('civicrmDestination', $this->_destination
);
776 public function cancelAction() {
777 $actionName = $this->getActionName();
778 list($pageName, $action) = $actionName;
779 return $this->_pages
[$pageName]->cancelAction();
783 * Write a simple fatal error message. Other controllers can decide to do something else
784 * and present the user a better message and/or redirect to the same page with a reset url
789 public function invalidKey() {
790 self
::invalidKeyCommon();
793 public function invalidKeyCommon() {
794 $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 adminstrator 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.');
795 CRM_Core_Error
::fatal($msg);
799 * Instead of outputting a fatal error message, we'll just redirect to the entryURL if present
803 public function invalidKeyRedirect() {
804 if ($this->_entryURL
) {
805 CRM_Core_Session
::setStatus(ts('We have lost your user session and are unable to complete your form submission. We have returned you to the initial step in the form which you can complete and resubmit. If you experience continued difficulties, please contact us for assistance.'));
806 return CRM_Utils_System
::redirect($this->_entryURL
);
809 self
::invalidKeyCommon();