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 // Respond with JSON if in AJAX context (also support legacy value '6')
244 elseif (in_array($snippet, array(CRM_Core_Smarty
::PRINT_JSON
, 6))) {
245 $this->_print
= CRM_Core_Smarty
::PRINT_JSON
;
246 $this->_QFResponseType
= 'json';
249 $this->_print
= CRM_Core_Smarty
::PRINT_SNIPPET
;
253 // if the request has a reset value, initialize the controller session
254 if (CRM_Utils_Array
::value('reset', $_GET)) {
257 // in this case we'll also cache the url as a hidden form variable, this allows us to
258 // redirect in case the session has disappeared on us
259 $this->_entryURL
= CRM_Utils_System
::makeURL(NULL, TRUE, FALSE, NULL, TRUE);
260 $this->set('entryURL', $this->_entryURL
);
263 // set the key in the session
264 // do this at the end so we have initialized the object
265 // and created the scope etc
266 $this->set('qfKey', $this->_key
);
269 // also retrieve and store destination in session
270 $this->_destination
= CRM_Utils_Request
::retrieve(
271 'civicrmDestination',
281 CRM_Core_BAO_Cache
::storeSessionToCache(array(
282 "_{$this->_name}_container",
283 array('CiviCRM', $this->_scope
),
289 function key($name, $addSequence = FALSE, $ignoreKey = FALSE) {
290 $config = CRM_Core_Config
::singleton();
294 (isset($config->keyDisable
) && $config->keyDisable
)
299 $key = CRM_Utils_Array
::value('qfKey', $_REQUEST, NULL);
300 if (!$key && $_SERVER['REQUEST_METHOD'] === 'GET') {
301 $key = CRM_Core_Key
::get($name, $addSequence);
304 $key = CRM_Core_Key
::validate($key, $name, $addSequence);
317 * Process the request, overrides the default QFC run method
318 * This routine actually checks if the QFC is modal and if it
319 * is the first invalid page, if so it call the requested action
320 * if not, it calls the display action on the first invalid page
321 * avoids the issue of users hitting the back button and getting
324 * This run is basically a composition of the original run and the
329 // the names of the action and page should be saved
330 // note that this is split into two, because some versions of
331 // php 5.x core dump on the triple assignment :)
332 $this->_actionName
= $this->getActionName();
333 list($pageName, $action) = $this->_actionName
;
335 if ($this->isModal()) {
336 if (!$this->isValid($pageName)) {
337 $pageName = $this->findInvalid();
342 // note that based on action, control might not come back!!
343 // e.g. if action is a valid JUMP, u basically do a redirect
344 // to the appropriate place
345 $this->wizardHeader($pageName);
346 return $this->_pages
[$pageName]->handle($action);
349 function validate() {
350 $this->_actionName
= $this->getActionName();
351 list($pageName, $action) = $this->_actionName
;
353 $page = &$this->_pages
[$pageName];
355 $data = &$this->container();
356 $this->applyDefaults($pageName);
357 $page->isFormBuilt() or $page->buildForm();
358 // We use defaults and constants as if they were submitted
359 $data['values'][$pageName] = $page->exportValues();
360 $page->loadValues($data['values'][$pageName]);
361 // Is the page now valid?
362 if (TRUE === ($data['valid'][$pageName] = $page->validate())) {
365 return $page->_errors
;
369 * Helper function to add all the needed default actions. Note that the framework
370 * redefines all of the default QFC actions
372 * @param string directory to store all the uploaded files
373 * @param array names for the various upload buttons (note u can have more than 1 upload)
380 function addActions($uploadDirectory = NULL, $uploadNames = NULL) {
382 'display' => 'CRM_Core_QuickForm_Action_Display',
383 'next' => 'CRM_Core_QuickForm_Action_Next',
384 'back' => 'CRM_Core_QuickForm_Action_Back',
385 'process' => 'CRM_Core_QuickForm_Action_Process',
386 'cancel' => 'CRM_Core_QuickForm_Action_Cancel',
387 'refresh' => 'CRM_Core_QuickForm_Action_Refresh',
388 'reload' => 'CRM_Core_QuickForm_Action_Reload',
389 'done' => 'CRM_Core_QuickForm_Action_Done',
390 'jump' => 'CRM_Core_QuickForm_Action_Jump',
391 'submit' => 'CRM_Core_QuickForm_Action_Submit',
394 foreach ($names as $name => $classPath) {
395 $action = new $classPath($this->_stateMachine
);
396 $this->addAction($name, $action);
399 $this->addUploadAction($uploadDirectory, $uploadNames);
403 * getter method for stateMachine
408 function getStateMachine() {
409 return $this->_stateMachine
;
413 * setter method for stateMachine
415 * @param object a stateMachineObject
420 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 object $stateMachine the state machine object
429 * @param int $action the mode in which the state machine is operating
430 * typicaly this will be add/view/edit
436 function addPages(&$stateMachine, $action = CRM_Core_Action
::NONE
) {
437 $pages = $stateMachine->getPages();
438 foreach ($pages as $name => $value) {
439 $className = CRM_Utils_Array
::value('className', $value, $name);
440 $title = CRM_Utils_Array
::value('title', $value);
441 $options = CRM_Utils_Array
::value('options', $value);
442 $stateName = CRM_Utils_String
::getClassName($className);
443 if (CRM_Utils_Array
::value('className', $value)) {
447 $formName = CRM_Utils_String
::getClassName($name);
450 $ext = CRM_Extension_System
::singleton()->getMapper();
451 if ($ext->isExtensionClass($className)) {
452 require_once ($ext->classToPath($className));
455 require_once (str_replace('_', DIRECTORY_SEPARATOR
, $className) . '.php');
457 $
$stateName = new $className($stateMachine->find($className), $action, 'post', $formName);
459 $
$stateName->setTitle($title);
462 $
$stateName->setOptions($options);
464 $this->addPage($
$stateName);
465 $this->addAction($stateName, new HTML_QuickForm_Action_Direct());
467 //CRM-6342 -we need kill the reference here,
468 //as we have deprecated reference object creation.
474 * QFC does not provide native support to have different 'submit' buttons.
475 * We introduce this notion to QFC by using button specific data. Thus if
476 * we have two submit buttons, we could have one displayed as a button and
477 * the other as an image, both are of type 'submit'.
479 * @return string the name of the button that has been pressed by the user
482 function getButtonName() {
483 $data = &$this->container();
484 return CRM_Utils_Array
::value('_qf_button_name', $data);
488 * function to destroy all the session state of the controller.
495 $this->container(TRUE);
496 self
::$_session->resetScope($this->_scope
);
500 * virtual function to do any processing of data.
501 * Sometimes it is useful for the controller to actually process data.
502 * This is typically used when we need the controller to figure out
503 * what pages are potentially involved in this wizard. (this is dynamic
504 * and can change based on the arguments
509 function process() {}
512 * Store the variable with the value in the form scope
514 * @param string|array $name name of the variable or an assoc array of name/value pairs
515 * @param mixed $value value of the variable if string
522 function set($name, $value = NULL) {
523 self
::$_session->set($name, $value, $this->_scope
);
527 * Get the variable from the form scope
529 * @param string name : name of the variable
537 function get($name) {
538 return self
::$_session->get($name, $this->_scope
);
542 * Create the header for the wizard from the list of pages
543 * Store the created header in smarty
545 * @param string $currentPageName name of the page being displayed
550 function wizardHeader($currentPageName) {
552 $wizard['steps'] = array();
554 foreach ($this->_pages
as $name => $page) {
556 $wizard['steps'][] = array(
558 'title' => $page->getTitle(),
559 //'link' => $page->getLink ( ),
563 'stepNumber' => $count,
564 'collapsed' => FALSE,
567 if ($name == $currentPageName) {
568 $wizard['currentStepNumber'] = $count;
569 $wizard['currentStepName'] = $name;
570 $wizard['currentStepTitle'] = $page->getTitle();
574 $wizard['stepCount'] = $count;
576 $this->addWizardStyle($wizard);
578 $this->assign('wizard', $wizard);
582 function addWizardStyle(&$wizard) {
583 $wizard['style'] = array(
585 'stepPrefixCurrent' => '»',
586 'stepPrefixPast' => '√',
587 'stepPrefixFuture' => ' ',
588 'subStepPrefixCurrent' => ' ',
589 'subStepPrefixPast' => ' ',
590 'subStepPrefixFuture' => ' ',
596 * assign value to name in template
598 * @param array|string $name name of variable
599 * @param mixed $value value of varaible
604 function assign($var, $value = NULL) {
605 self
::$_template->assign($var, $value);
609 * assign value to name in template by reference
611 * @param array|string $name name of variable
612 * @param mixed $value (reference) value of varaible
617 function assign_by_ref($var, &$value) {
618 self
::$_template->assign_by_ref($var, $value);
622 * appends values to template variables
624 * @param array|string $tpl_var the template variable name(s)
625 * @param mixed $value the value to append
628 function append($tpl_var, $value=NULL, $merge=FALSE) {
629 self
::$_template->append($tpl_var, $value, $merge);
633 * Returns an array containing template variables
635 * @param string $name
636 * @param string $type
639 function get_template_vars($name=null) {
640 return self
::$_template->get_template_vars($name);
644 * setter for embedded
646 * @param boolean $embedded
651 function setEmbedded($embedded) {
652 $this->_embedded
= $embedded;
656 * getter for embedded
658 * @return boolean return the embedded value
661 function getEmbedded() {
662 return $this->_embedded
;
666 * setter for skipRedirection
668 * @param boolean $skipRedirection
673 function setSkipRedirection($skipRedirection) {
674 $this->_skipRedirection
= $skipRedirection;
678 * getter for skipRedirection
680 * @return boolean return the skipRedirection value
683 function getSkipRedirection() {
684 return $this->_skipRedirection
;
687 function setWord($fileName = NULL) {
688 //Mark as a CSV file.
689 header('Content-Type: application/vnd.ms-word');
691 //Force a download and name the file using the current timestamp.
693 $fileName = 'Contacts_' . $_SERVER['REQUEST_TIME'] . '.doc';
695 header("Content-Disposition: attachment; filename=Contacts_$fileName");
698 function setExcel($fileName = NULL) {
699 //Mark as an excel file.
700 header('Content-Type: application/vnd.ms-excel');
702 //Force a download and name the file using the current timestamp.
704 $fileName = 'Contacts_' . $_SERVER['REQUEST_TIME'] . '.xls';
707 header("Content-Disposition: attachment; filename=Contacts_$fileName");
713 * @param boolean $print
718 function setPrint($print) {
719 if ($print == "xls") {
722 elseif ($print == "doc") {
725 $this->_print
= $print;
731 * @return boolean return the print value
734 function getPrint() {
735 return $this->_print
;
738 function getTemplateFile() {
740 if ($this->_print
== CRM_Core_Smarty
::PRINT_PAGE
) {
741 return 'CRM/common/print.tpl';
743 elseif ($this->_print
== 'xls' ||
$this->_print
== 'doc') {
744 return 'CRM/Contact/Form/Task/Excel.tpl';
747 return 'CRM/common/snippet.tpl';
751 $config = CRM_Core_Config
::singleton();
752 return 'CRM/common/' . strtolower($config->userFramework
) . '.tpl';
756 public function addUploadAction($uploadDir, $uploadNames) {
757 if (empty($uploadDir)) {
758 $config = CRM_Core_Config
::singleton();
759 $uploadDir = $config->uploadDir
;
762 if (empty($uploadNames)) {
763 $uploadNames = $this->get('uploadNames');
764 if (!empty($uploadNames)) {
765 $uploadNames = array_merge($uploadNames,
766 CRM_Core_BAO_File
::uploadNames()
770 $uploadNames = CRM_Core_BAO_File
::uploadNames();
774 $action = new CRM_Core_QuickForm_Action_Upload($this->_stateMachine
,
778 $this->addAction('upload', $action);
781 public function setParent($parent) {
782 $this->_parent
= $parent;
785 public function getParent() {
786 return $this->_parent
;
789 public function getDestination() {
790 return $this->_destination
;
793 public function setDestination($url = NULL, $setToReferer = FALSE) {
796 $url = $_SERVER['HTTP_REFERER'];
799 $config = CRM_Core_Config
::singleton();
800 $url = $config->userFrameworkBaseURL
;
804 $this->_destination
= $url;
805 $this->set('civicrmDestination', $this->_destination
);
808 public function cancelAction() {
809 $actionName = $this->getActionName();
810 list($pageName, $action) = $actionName;
811 return $this->_pages
[$pageName]->cancelAction();
815 * Write a simple fatal error message. Other controllers can decide to do something else
816 * and present the user a better message and/or redirect to the same page with a reset url
821 public function invalidKey() {
822 self
::invalidKeyCommon();
825 public function invalidKeyCommon() {
826 $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.');
827 CRM_Core_Error
::fatal($msg);
831 * Instead of outputting a fatal error message, we'll just redirect to the entryURL if present
835 public function invalidKeyRedirect() {
836 if ($this->_entryURL
) {
837 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.'));
838 return CRM_Utils_System
::redirect($this->_entryURL
);
841 self
::invalidKeyCommon();