3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
46 require_once 'HTML/QuickForm/Controller.php';
47 require_once 'HTML/QuickForm/Action/Direct.php';
50 * Class CRM_Core_Controller
52 class CRM_Core_Controller
extends HTML_QuickForm_Controller
{
55 * The title associated with this controller
62 * The key associated with this controller
69 * The name of the session scope where values are stored
76 * The state machine associated with this controller
80 protected $_stateMachine;
83 * Is this object being embedded in another object. If
84 * so the display routine needs to not do any work. (The
85 * parent object takes care of the display)
89 protected $_embedded = FALSE;
92 * After entire form execution complete,
93 * do we want to skip control redirection.
94 * Default - It get redirect to user context.
96 * Useful when we run form in non civicrm context
97 * and we need to transfer control back.(eg. drupal)
101 protected $_skipRedirection = FALSE;
104 * Are we in print mode? if so we need to modify the display
105 * functionality to do a minimal display :)
112 * Should we generate a qfKey, true by default
116 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 descriptive title of the controller
163 * @param bool $modal whether controller is modal
165 * @param string $scope name of session if we want unique scope, used only by Controller_Simple
166 * @param bool $addSequence should we add a unique sequence number to the end of the key
167 * @param bool $ignoreKey should we not set a qfKey for this controller (for standalone forms)
171 * @return CRM_Core_Controller
173 function __construct(
178 $addSequence = FALSE,
181 // this has to true for multiple tab session fix
184 // let the constructor initialize this, should happen only once
185 if (!isset(self
::$_template)) {
186 self
::$_template = CRM_Core_Smarty
::singleton();
187 self
::$_session = CRM_Core_Session
::singleton();
190 // lets try to get it from the session and/or the request vars
191 // we do this early on in case there is a fatal error in retrieving the
192 // key and/or session
194 CRM_Utils_Request
::retrieve('entryURL', 'String', $this);
196 // add a unique validable key to the name
197 $name = CRM_Utils_System
::getClassName($this);
198 if ($name == 'CRM_Core_Controller_Simple' && !empty($scope)) {
199 // use form name if we have, since its a lot better and
200 // definitely different for different forms
203 $name = $name . '_' . $this->key($name, $addSequence, $ignoreKey);
204 $this->_title
= $title;
206 $this->_scope
= $scope;
209 $this->_scope
= CRM_Utils_System
::getClassName($this);
211 $this->_scope
= $this->_scope
. '_' . $this->_key
;
213 // only use the civicrm cache if we have a valid key
214 // else we clash with other users CRM-7059
215 if (!empty($this->_key
)) {
216 CRM_Core_Session
::registerAndRetrieveSessionObjects(array(
217 "_{$name}_container",
218 array('CiviCRM', $this->_scope
),
222 $this->HTML_QuickForm_Controller($name, $modal);
224 $snippet = CRM_Utils_Array
::value('snippet', $_REQUEST);
227 $this->_print
= CRM_Core_Smarty
::PRINT_PDF
;
229 elseif ($snippet == 4) {
230 // this is used to embed fragments of a form
231 $this->_print
= CRM_Core_Smarty
::PRINT_NOFORM
;
232 self
::$_template->assign('suppressForm', TRUE);
233 $this->_generateQFKey
= FALSE;
235 elseif ($snippet == 5) {
236 // mode deprecated in favor of json
237 // still used by dashlets, probably nothing else
238 $this->_print
= CRM_Core_Smarty
::PRINT_NOFORM
;
240 // Respond with JSON if in AJAX context (also support legacy value '6')
241 elseif (in_array($snippet, array(CRM_Core_Smarty
::PRINT_JSON
, 6))) {
242 $this->_print
= CRM_Core_Smarty
::PRINT_JSON
;
243 $this->_QFResponseType
= 'json';
246 $this->_print
= CRM_Core_Smarty
::PRINT_SNIPPET
;
250 // if the request has a reset value, initialize the controller session
251 if (!empty($_GET['reset'])) {
254 // in this case we'll also cache the url as a hidden form variable, this allows us to
255 // redirect in case the session has disappeared on us
256 $this->_entryURL
= CRM_Utils_System
::makeURL(NULL, TRUE, FALSE, NULL, TRUE);
257 $this->set('entryURL', $this->_entryURL
);
260 // set the key in the session
261 // do this at the end so we have initialized the object
262 // and created the scope etc
263 $this->set('qfKey', $this->_key
);
266 // also retrieve and store destination in session
267 $this->_destination
= CRM_Utils_Request
::retrieve(
268 'civicrmDestination',
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 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 // the names of the action and page should be saved
334 // note that this is split into two, because some versions of
335 // php 5.x core dump on the triple assignment :)
336 $this->_actionName
= $this->getActionName();
337 list($pageName, $action) = $this->_actionName
;
339 if ($this->isModal()) {
340 if (!$this->isValid($pageName)) {
341 $pageName = $this->findInvalid();
346 // note that based on action, control might not come back!!
347 // e.g. if action is a valid JUMP, u basically do a redirect
348 // to the appropriate place
349 $this->wizardHeader($pageName);
350 return $this->_pages
[$pageName]->handle($action);
356 function validate() {
357 $this->_actionName
= $this->getActionName();
358 list($pageName, $action) = $this->_actionName
;
360 $page = &$this->_pages
[$pageName];
362 $data = &$this->container();
363 $this->applyDefaults($pageName);
364 $page->isFormBuilt() or $page->buildForm();
365 // We use defaults and constants as if they were submitted
366 $data['values'][$pageName] = $page->exportValues();
367 $page->loadValues($data['values'][$pageName]);
368 // Is the page now valid?
369 if (TRUE === ($data['valid'][$pageName] = $page->validate())) {
372 return $page->_errors
;
376 * Helper function to add all the needed default actions. Note that the framework
377 * redefines all of the default QFC actions
379 * @param string directory to store all the uploaded files
380 * @param array names for the various upload buttons (note u can have more than 1 upload)
387 function addActions($uploadDirectory = NULL, $uploadNames = NULL) {
389 'display' => 'CRM_Core_QuickForm_Action_Display',
390 'next' => 'CRM_Core_QuickForm_Action_Next',
391 'back' => 'CRM_Core_QuickForm_Action_Back',
392 'process' => 'CRM_Core_QuickForm_Action_Process',
393 'cancel' => 'CRM_Core_QuickForm_Action_Cancel',
394 'refresh' => 'CRM_Core_QuickForm_Action_Refresh',
395 'reload' => 'CRM_Core_QuickForm_Action_Reload',
396 'done' => 'CRM_Core_QuickForm_Action_Done',
397 'jump' => 'CRM_Core_QuickForm_Action_Jump',
398 'submit' => 'CRM_Core_QuickForm_Action_Submit',
401 foreach ($names as $name => $classPath) {
402 $action = new $classPath($this->_stateMachine
);
403 $this->addAction($name, $action);
406 $this->addUploadAction($uploadDirectory, $uploadNames);
410 * Getter method for stateMachine
412 * @return CRM_Core_StateMachine
415 function getStateMachine() {
416 return $this->_stateMachine
;
420 * Setter method for stateMachine
422 * @param CRM_Core_StateMachine $stateMachine
427 function setStateMachine($stateMachine) {
428 $this->_stateMachine
= $stateMachine;
432 * Add pages to the controller. Note that the controller does not really care
433 * the order in which the pages are added
435 * @param CRM_Core_StateMachine $stateMachine
436 * @param \const|int $action the mode in which the state machine is operating
437 * typicaly this will be add/view/edit
442 function addPages(&$stateMachine, $action = CRM_Core_Action
::NONE
) {
443 $pages = $stateMachine->getPages();
444 foreach ($pages as $name => $value) {
445 $className = CRM_Utils_Array
::value('className', $value, $name);
446 $title = CRM_Utils_Array
::value('title', $value);
447 $options = CRM_Utils_Array
::value('options', $value);
448 $stateName = CRM_Utils_String
::getClassName($className);
449 if (!empty($value['className'])) {
453 $formName = CRM_Utils_String
::getClassName($name);
456 $ext = CRM_Extension_System
::singleton()->getMapper();
457 if ($ext->isExtensionClass($className)) {
458 require_once ($ext->classToPath($className));
461 require_once (str_replace('_', DIRECTORY_SEPARATOR
, $className) . '.php');
463 $
$stateName = new $className($stateMachine->find($className), $action, 'post', $formName);
465 $
$stateName->setTitle($title);
468 $
$stateName->setOptions($options);
470 if (property_exists($
$stateName, 'urlPath') && isset($_GET[CRM_Core_Config
::singleton()->userFrameworkURLVar
])) {
471 $
$stateName->urlPath
= explode('/', $_GET[CRM_Core_Config
::singleton()->userFrameworkURLVar
]);
473 $this->addPage($
$stateName);
474 $this->addAction($stateName, new HTML_QuickForm_Action_Direct());
476 //CRM-6342 -we need kill the reference here,
477 //as we have deprecated reference object creation.
483 * QFC does not provide native support to have different 'submit' buttons.
484 * We introduce this notion to QFC by using button specific data. Thus if
485 * we have two submit buttons, we could have one displayed as a button and
486 * the other as an image, both are of type 'submit'.
488 * @return string the name of the button that has been pressed by the user
491 function getButtonName() {
492 $data = &$this->container();
493 return CRM_Utils_Array
::value('_qf_button_name', $data);
497 * Destroy all the session state of the controller.
504 $this->container(TRUE);
505 self
::$_session->resetScope($this->_scope
);
509 * Virtual function to do any processing of data.
510 * Sometimes it is useful for the controller to actually process data.
511 * This is typically used when we need the controller to figure out
512 * what pages are potentially involved in this wizard. (this is dynamic
513 * and can change based on the arguments
518 function process() {}
521 * Store the variable with the value in the form scope
523 * @param string|array $name name of the variable or an assoc array of name/value pairs
524 * @param mixed $value value of the variable if string
531 function set($name, $value = NULL) {
532 self
::$_session->set($name, $value, $this->_scope
);
536 * Get the variable from the form scope
538 * @param string $name : name of the variable
546 function get($name) {
547 return self
::$_session->get($name, $this->_scope
);
551 * Create the header for the wizard from the list of pages
552 * Store the created header in smarty
554 * @param string $currentPageName name of the page being displayed
559 function wizardHeader($currentPageName) {
561 $wizard['steps'] = array();
563 foreach ($this->_pages
as $name => $page) {
565 $wizard['steps'][] = array(
567 'title' => $page->getTitle(),
568 //'link' => $page->getLink ( ),
572 'stepNumber' => $count,
573 'collapsed' => FALSE,
576 if ($name == $currentPageName) {
577 $wizard['currentStepNumber'] = $count;
578 $wizard['currentStepName'] = $name;
579 $wizard['currentStepTitle'] = $page->getTitle();
583 $wizard['stepCount'] = $count;
585 $this->addWizardStyle($wizard);
587 $this->assign('wizard', $wizard);
592 * @param array $wizard
594 function addWizardStyle(&$wizard) {
595 $wizard['style'] = array(
597 'stepPrefixCurrent' => '»',
598 'stepPrefixPast' => '√',
599 'stepPrefixFuture' => ' ',
600 'subStepPrefixCurrent' => ' ',
601 'subStepPrefixPast' => ' ',
602 'subStepPrefixFuture' => ' ',
608 * Assign value to name in template
611 * @param mixed $value value of varaible
616 function assign($var, $value = NULL) {
617 self
::$_template->assign($var, $value);
621 * Assign value to name in template by reference
624 * @param mixed $value (reference) value of varaible
629 function assign_by_ref($var, &$value) {
630 self
::$_template->assign_by_ref($var, $value);
634 * Appends values to template variables
636 * @param array|string $tpl_var the template variable name(s)
637 * @param mixed $value the value to append
640 function append($tpl_var, $value=NULL, $merge=FALSE) {
641 self
::$_template->append($tpl_var, $value, $merge);
645 * Returns an array containing template variables
647 * @param string $name
651 function get_template_vars($name=null) {
652 return self
::$_template->get_template_vars($name);
656 * Setter for embedded
658 * @param boolean $embedded
663 function setEmbedded($embedded) {
664 $this->_embedded
= $embedded;
668 * Getter for embedded
670 * @return boolean return the embedded value
673 function getEmbedded() {
674 return $this->_embedded
;
678 * Setter for skipRedirection
680 * @param boolean $skipRedirection
685 function setSkipRedirection($skipRedirection) {
686 $this->_skipRedirection
= $skipRedirection;
690 * Getter for skipRedirection
692 * @return boolean return the skipRedirection value
695 function getSkipRedirection() {
696 return $this->_skipRedirection
;
700 * @param null $fileName
702 function setWord($fileName = NULL) {
703 //Mark as a CSV file.
704 header('Content-Type: application/vnd.ms-word');
706 //Force a download and name the file using the current timestamp.
708 $fileName = 'Contacts_' . $_SERVER['REQUEST_TIME'] . '.doc';
710 header("Content-Disposition: attachment; filename=Contacts_$fileName");
714 * @param null $fileName
716 function setExcel($fileName = NULL) {
717 //Mark as an excel file.
718 header('Content-Type: application/vnd.ms-excel');
720 //Force a download and name the file using the current timestamp.
722 $fileName = 'Contacts_' . $_SERVER['REQUEST_TIME'] . '.xls';
725 header("Content-Disposition: attachment; filename=Contacts_$fileName");
731 * @param boolean $print
736 function setPrint($print) {
737 if ($print == "xls") {
740 elseif ($print == "doc") {
743 $this->_print
= $print;
749 * @return boolean return the print value
752 function getPrint() {
753 return $this->_print
;
759 function getTemplateFile() {
761 if ($this->_print
== CRM_Core_Smarty
::PRINT_PAGE
) {
762 return 'CRM/common/print.tpl';
764 elseif ($this->_print
== 'xls' ||
$this->_print
== 'doc') {
765 return 'CRM/Contact/Form/Task/Excel.tpl';
768 return 'CRM/common/snippet.tpl';
772 $config = CRM_Core_Config
::singleton();
773 return 'CRM/common/' . strtolower($config->userFramework
) . '.tpl';
779 * @param $uploadNames
781 public function addUploadAction($uploadDir, $uploadNames) {
782 if (empty($uploadDir)) {
783 $config = CRM_Core_Config
::singleton();
784 $uploadDir = $config->uploadDir
;
787 if (empty($uploadNames)) {
788 $uploadNames = $this->get('uploadNames');
789 if (!empty($uploadNames)) {
790 $uploadNames = array_merge($uploadNames,
791 CRM_Core_BAO_File
::uploadNames()
795 $uploadNames = CRM_Core_BAO_File
::uploadNames();
799 $action = new CRM_Core_QuickForm_Action_Upload($this->_stateMachine
,
803 $this->addAction('upload', $action);
809 public function setParent($parent) {
810 $this->_parent
= $parent;
816 public function getParent() {
817 return $this->_parent
;
823 public function getDestination() {
824 return $this->_destination
;
829 * @param bool $setToReferer
831 public function setDestination($url = NULL, $setToReferer = FALSE) {
834 $url = $_SERVER['HTTP_REFERER'];
837 $config = CRM_Core_Config
::singleton();
838 $url = $config->userFrameworkBaseURL
;
842 $this->_destination
= $url;
843 $this->set('civicrmDestination', $this->_destination
);
849 public function cancelAction() {
850 $actionName = $this->getActionName();
851 list($pageName, $action) = $actionName;
852 return $this->_pages
[$pageName]->cancelAction();
856 * Write a simple fatal error message. Other controllers can decide to do something else
857 * and present the user a better message and/or redirect to the same page with a reset url
862 public function invalidKey() {
863 self
::invalidKeyCommon();
866 public function invalidKeyCommon() {
867 $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.');
868 CRM_Core_Error
::fatal($msg);
872 * Instead of outputting a fatal error message, we'll just redirect to the entryURL if present
876 public function invalidKeyRedirect() {
877 if ($this->_entryURL
) {
878 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.'));
879 return CRM_Utils_System
::redirect($this->_entryURL
);
882 self
::invalidKeyCommon();