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
191 CRM_Utils_Request
::retrieve('entryURL', 'String', $this);
193 // add a unique validable key to the name
194 $name = CRM_Utils_System
::getClassName($this);
195 if ($name == 'CRM_Core_Controller_Simple' && !empty($scope)) {
196 // use form name if we have, since its a lot better and
197 // definitely different for different forms
200 $name = $name . '_' . $this->key($name, $addSequence, $ignoreKey);
201 $this->_title
= $title;
203 $this->_scope
= $scope;
206 $this->_scope
= CRM_Utils_System
::getClassName($this);
208 $this->_scope
= $this->_scope
. '_' . $this->_key
;
210 // only use the civicrm cache if we have a valid key
211 // else we clash with other users CRM-7059
212 if (!empty($this->_key
)) {
213 CRM_Core_Session
::registerAndRetrieveSessionObjects(array(
214 "_{$name}_container",
215 array('CiviCRM', $this->_scope
),
219 $this->HTML_QuickForm_Controller($name, $modal);
221 $snippet = CRM_Utils_Array
::value('snippet', $_REQUEST);
224 $this->_print
= CRM_Core_Smarty
::PRINT_PDF
;
226 elseif ($snippet == 4) {
227 // this is used to embed fragments of a form
228 $this->_print
= CRM_Core_Smarty
::PRINT_NOFORM
;
229 self
::$_template->assign('suppressForm', TRUE);
230 $this->_generateQFKey
= FALSE;
232 elseif ($snippet == 5) {
233 // this is used for popups and inlined ajax forms
234 // also used for the various tabs via TabHeader
235 $this->_print
= CRM_Core_Smarty
::PRINT_NOFORM
;
237 // Respond with JSON if in AJAX context (also support legacy value '6')
238 elseif (in_array($snippet, array(CRM_Core_Smarty
::PRINT_JSON
, 6))) {
239 $this->_print
= CRM_Core_Smarty
::PRINT_JSON
;
240 $this->_QFResponseType
= 'json';
243 $this->_print
= CRM_Core_Smarty
::PRINT_SNIPPET
;
247 // if the request has a reset value, initialize the controller session
248 if (!empty($_GET['reset'])) {
251 // in this case we'll also cache the url as a hidden form variable, this allows us to
252 // redirect in case the session has disappeared on us
253 $this->_entryURL
= CRM_Utils_System
::makeURL(NULL, TRUE, FALSE, NULL, TRUE);
254 $this->set('entryURL', $this->_entryURL
);
257 // set the key in the session
258 // do this at the end so we have initialized the object
259 // and created the scope etc
260 $this->set('qfKey', $this->_key
);
263 // also retrieve and store destination in session
264 $this->_destination
= CRM_Utils_Request
::retrieve(
265 'civicrmDestination',
275 CRM_Core_BAO_Cache
::storeSessionToCache(array(
276 "_{$this->_name}_container",
277 array('CiviCRM', $this->_scope
),
283 function key($name, $addSequence = FALSE, $ignoreKey = FALSE) {
284 $config = CRM_Core_Config
::singleton();
288 (isset($config->keyDisable
) && $config->keyDisable
)
293 $key = CRM_Utils_Array
::value('qfKey', $_REQUEST, NULL);
294 if (!$key && $_SERVER['REQUEST_METHOD'] === 'GET') {
295 $key = CRM_Core_Key
::get($name, $addSequence);
298 $key = CRM_Core_Key
::validate($key, $name, $addSequence);
311 * Process the request, overrides the default QFC run method
312 * This routine actually checks if the QFC is modal and if it
313 * is the first invalid page, if so it call the requested action
314 * if not, it calls the display action on the first invalid page
315 * avoids the issue of users hitting the back button and getting
318 * This run is basically a composition of the original run and the
323 // the names of the action and page should be saved
324 // note that this is split into two, because some versions of
325 // php 5.x core dump on the triple assignment :)
326 $this->_actionName
= $this->getActionName();
327 list($pageName, $action) = $this->_actionName
;
329 if ($this->isModal()) {
330 if (!$this->isValid($pageName)) {
331 $pageName = $this->findInvalid();
336 // note that based on action, control might not come back!!
337 // e.g. if action is a valid JUMP, u basically do a redirect
338 // to the appropriate place
339 $this->wizardHeader($pageName);
340 return $this->_pages
[$pageName]->handle($action);
343 function validate() {
344 $this->_actionName
= $this->getActionName();
345 list($pageName, $action) = $this->_actionName
;
347 $page = &$this->_pages
[$pageName];
349 $data = &$this->container();
350 $this->applyDefaults($pageName);
351 $page->isFormBuilt() or $page->buildForm();
352 // We use defaults and constants as if they were submitted
353 $data['values'][$pageName] = $page->exportValues();
354 $page->loadValues($data['values'][$pageName]);
355 // Is the page now valid?
356 if (TRUE === ($data['valid'][$pageName] = $page->validate())) {
359 return $page->_errors
;
363 * Helper function to add all the needed default actions. Note that the framework
364 * redefines all of the default QFC actions
366 * @param string directory to store all the uploaded files
367 * @param array names for the various upload buttons (note u can have more than 1 upload)
374 function addActions($uploadDirectory = NULL, $uploadNames = NULL) {
376 'display' => 'CRM_Core_QuickForm_Action_Display',
377 'next' => 'CRM_Core_QuickForm_Action_Next',
378 'back' => 'CRM_Core_QuickForm_Action_Back',
379 'process' => 'CRM_Core_QuickForm_Action_Process',
380 'cancel' => 'CRM_Core_QuickForm_Action_Cancel',
381 'refresh' => 'CRM_Core_QuickForm_Action_Refresh',
382 'reload' => 'CRM_Core_QuickForm_Action_Reload',
383 'done' => 'CRM_Core_QuickForm_Action_Done',
384 'jump' => 'CRM_Core_QuickForm_Action_Jump',
385 'submit' => 'CRM_Core_QuickForm_Action_Submit',
388 foreach ($names as $name => $classPath) {
389 $action = new $classPath($this->_stateMachine
);
390 $this->addAction($name, $action);
393 $this->addUploadAction($uploadDirectory, $uploadNames);
397 * getter method for stateMachine
402 function getStateMachine() {
403 return $this->_stateMachine
;
407 * setter method for stateMachine
409 * @param object a stateMachineObject
414 function setStateMachine($stateMachine) {
415 $this->_stateMachine
= $stateMachine;
419 * add pages to the controller. Note that the controller does not really care
420 * the order in which the pages are added
422 * @param object $stateMachine the state machine object
423 * @param int $action the mode in which the state machine is operating
424 * typicaly this will be add/view/edit
430 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') && isset($_GET[CRM_Core_Config
::singleton()->userFrameworkURLVar
])) {
459 $
$stateName->urlPath
= explode('/', $_GET[CRM_Core_Config
::singleton()->userFrameworkURLVar
]);
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'.
476 * @return string the name of the button that has been pressed by the user
479 function getButtonName() {
480 $data = &$this->container();
481 return CRM_Utils_Array
::value('_qf_button_name', $data);
485 * function to destroy all the session state of the controller.
492 $this->container(TRUE);
493 self
::$_session->resetScope($this->_scope
);
497 * virtual function to do any processing of data.
498 * Sometimes it is useful for the controller to actually process data.
499 * This is typically used when we need the controller to figure out
500 * what pages are potentially involved in this wizard. (this is dynamic
501 * and can change based on the arguments
506 function process() {}
509 * Store the variable with the value in the form scope
511 * @param string|array $name name of the variable or an assoc array of name/value pairs
512 * @param mixed $value value of the variable if string
519 function set($name, $value = NULL) {
520 self
::$_session->set($name, $value, $this->_scope
);
524 * Get the variable from the form scope
526 * @param string name : name of the variable
534 function get($name) {
535 return self
::$_session->get($name, $this->_scope
);
539 * Create the header for the wizard from the list of pages
540 * Store the created header in smarty
542 * @param string $currentPageName name of the page being displayed
547 function wizardHeader($currentPageName) {
549 $wizard['steps'] = array();
551 foreach ($this->_pages
as $name => $page) {
553 $wizard['steps'][] = array(
555 'title' => $page->getTitle(),
556 //'link' => $page->getLink ( ),
560 'stepNumber' => $count,
561 'collapsed' => FALSE,
564 if ($name == $currentPageName) {
565 $wizard['currentStepNumber'] = $count;
566 $wizard['currentStepName'] = $name;
567 $wizard['currentStepTitle'] = $page->getTitle();
571 $wizard['stepCount'] = $count;
573 $this->addWizardStyle($wizard);
575 $this->assign('wizard', $wizard);
579 function addWizardStyle(&$wizard) {
580 $wizard['style'] = array(
582 'stepPrefixCurrent' => '»',
583 'stepPrefixPast' => '√',
584 'stepPrefixFuture' => ' ',
585 'subStepPrefixCurrent' => ' ',
586 'subStepPrefixPast' => ' ',
587 'subStepPrefixFuture' => ' ',
593 * assign value to name in template
595 * @param array|string $name name of variable
596 * @param mixed $value value of varaible
601 function assign($var, $value = NULL) {
602 self
::$_template->assign($var, $value);
606 * assign value to name in template by reference
608 * @param array|string $name name of variable
609 * @param mixed $value (reference) value of varaible
614 function assign_by_ref($var, &$value) {
615 self
::$_template->assign_by_ref($var, $value);
619 * appends values to template variables
621 * @param array|string $tpl_var the template variable name(s)
622 * @param mixed $value the value to append
625 function append($tpl_var, $value=NULL, $merge=FALSE) {
626 self
::$_template->append($tpl_var, $value, $merge);
630 * Returns an array containing template variables
632 * @param string $name
633 * @param string $type
636 function get_template_vars($name=null) {
637 return self
::$_template->get_template_vars($name);
641 * setter for embedded
643 * @param boolean $embedded
648 function setEmbedded($embedded) {
649 $this->_embedded
= $embedded;
653 * getter for embedded
655 * @return boolean return the embedded value
658 function getEmbedded() {
659 return $this->_embedded
;
663 * setter for skipRedirection
665 * @param boolean $skipRedirection
670 function setSkipRedirection($skipRedirection) {
671 $this->_skipRedirection
= $skipRedirection;
675 * getter for skipRedirection
677 * @return boolean return the skipRedirection value
680 function getSkipRedirection() {
681 return $this->_skipRedirection
;
684 function setWord($fileName = NULL) {
685 //Mark as a CSV file.
686 header('Content-Type: application/vnd.ms-word');
688 //Force a download and name the file using the current timestamp.
690 $fileName = 'Contacts_' . $_SERVER['REQUEST_TIME'] . '.doc';
692 header("Content-Disposition: attachment; filename=Contacts_$fileName");
695 function setExcel($fileName = NULL) {
696 //Mark as an excel file.
697 header('Content-Type: application/vnd.ms-excel');
699 //Force a download and name the file using the current timestamp.
701 $fileName = 'Contacts_' . $_SERVER['REQUEST_TIME'] . '.xls';
704 header("Content-Disposition: attachment; filename=Contacts_$fileName");
710 * @param boolean $print
715 function setPrint($print) {
716 if ($print == "xls") {
719 elseif ($print == "doc") {
722 $this->_print
= $print;
728 * @return boolean return the print value
731 function getPrint() {
732 return $this->_print
;
735 function getTemplateFile() {
737 if ($this->_print
== CRM_Core_Smarty
::PRINT_PAGE
) {
738 return 'CRM/common/print.tpl';
740 elseif ($this->_print
== 'xls' ||
$this->_print
== 'doc') {
741 return 'CRM/Contact/Form/Task/Excel.tpl';
744 return 'CRM/common/snippet.tpl';
748 $config = CRM_Core_Config
::singleton();
749 return 'CRM/common/' . strtolower($config->userFramework
) . '.tpl';
753 public function addUploadAction($uploadDir, $uploadNames) {
754 if (empty($uploadDir)) {
755 $config = CRM_Core_Config
::singleton();
756 $uploadDir = $config->uploadDir
;
759 if (empty($uploadNames)) {
760 $uploadNames = $this->get('uploadNames');
761 if (!empty($uploadNames)) {
762 $uploadNames = array_merge($uploadNames,
763 CRM_Core_BAO_File
::uploadNames()
767 $uploadNames = CRM_Core_BAO_File
::uploadNames();
771 $action = new CRM_Core_QuickForm_Action_Upload($this->_stateMachine
,
775 $this->addAction('upload', $action);
778 public function setParent($parent) {
779 $this->_parent
= $parent;
782 public function getParent() {
783 return $this->_parent
;
786 public function getDestination() {
787 return $this->_destination
;
790 public function setDestination($url = NULL, $setToReferer = FALSE) {
793 $url = $_SERVER['HTTP_REFERER'];
796 $config = CRM_Core_Config
::singleton();
797 $url = $config->userFrameworkBaseURL
;
801 $this->_destination
= $url;
802 $this->set('civicrmDestination', $this->_destination
);
805 public function cancelAction() {
806 $actionName = $this->getActionName();
807 list($pageName, $action) = $actionName;
808 return $this->_pages
[$pageName]->cancelAction();
812 * Write a simple fatal error message. Other controllers can decide to do something else
813 * and present the user a better message and/or redirect to the same page with a reset url
818 public function invalidKey() {
819 self
::invalidKeyCommon();
822 public function invalidKeyCommon() {
823 $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.');
824 CRM_Core_Error
::fatal($msg);
828 * Instead of outputting a fatal error message, we'll just redirect to the entryURL if present
832 public function invalidKeyRedirect() {
833 if ($this->_entryURL
) {
834 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.'));
835 return CRM_Utils_System
::redirect($this->_entryURL
);
838 self
::invalidKeyCommon();