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;
123 public $_QFResponseType = 'html';
126 * Cache the smarty template for efficiency reasons
128 * @var CRM_Core_Smarty
130 static protected $_template;
133 * Cache the session for efficiency reasons
135 * @var CRM_Core_Session
137 static protected $_session;
140 * The parent of this form if embedded
144 protected $_parent = NULL;
147 * The destination if set will override the destination the code wants to send it to
151 public $_destination = NULL;
154 * The entry url for a top level form or wizard. Typically the URL with a reset=1
155 * used to redirect back to when we land into some session wierdness
159 public $_entryURL = NULL;
162 * All CRM single or multi page pages should inherit from this class.
164 * @param string $title
165 * Descriptive title of the controller.
167 * Whether controller is modal.
169 * @param string $scope
170 * Name of session if we want unique scope, used only by Controller_Simple.
171 * @param bool $addSequence
172 * Should we add a unique sequence number to the end of the key.
173 * @param bool $ignoreKey
174 * Should we not set a qfKey for this controller (for standalone forms).
176 * @internal param bool $whether controller is modal
178 function __construct(
183 $addSequence = FALSE,
186 // this has to true for multiple tab session fix
189 // let the constructor initialize this, should happen only once
190 if (!isset(self
::$_template)) {
191 self
::$_template = CRM_Core_Smarty
::singleton();
192 self
::$_session = CRM_Core_Session
::singleton();
195 // lets try to get it from the session and/or the request vars
196 // we do this early on in case there is a fatal error in retrieving the
197 // key and/or session
199 CRM_Utils_Request
::retrieve('entryURL', 'String', $this);
201 // add a unique validable key to the name
202 $name = CRM_Utils_System
::getClassName($this);
203 if ($name == 'CRM_Core_Controller_Simple' && !empty($scope)) {
204 // use form name if we have, since its a lot better and
205 // definitely different for different forms
208 $name = $name . '_' . $this->key($name, $addSequence, $ignoreKey);
209 $this->_title
= $title;
211 $this->_scope
= $scope;
214 $this->_scope
= CRM_Utils_System
::getClassName($this);
216 $this->_scope
= $this->_scope
. '_' . $this->_key
;
218 // only use the civicrm cache if we have a valid key
219 // else we clash with other users CRM-7059
220 if (!empty($this->_key
)) {
221 CRM_Core_Session
::registerAndRetrieveSessionObjects(array(
222 "_{$name}_container",
223 array('CiviCRM', $this->_scope
),
227 $this->HTML_QuickForm_Controller($name, $modal);
229 $snippet = CRM_Utils_Array
::value('snippet', $_REQUEST);
232 $this->_print
= CRM_Core_Smarty
::PRINT_PDF
;
234 elseif ($snippet == 4) {
235 // this is used to embed fragments of a form
236 $this->_print
= CRM_Core_Smarty
::PRINT_NOFORM
;
237 self
::$_template->assign('suppressForm', TRUE);
238 $this->_generateQFKey
= FALSE;
240 elseif ($snippet == 5) {
241 // mode deprecated in favor of json
242 // still used by dashlets, probably nothing else
243 $this->_print
= CRM_Core_Smarty
::PRINT_NOFORM
;
245 // Respond with JSON if in AJAX context (also support legacy value '6')
246 elseif (in_array($snippet, array(CRM_Core_Smarty
::PRINT_JSON
, 6))) {
247 $this->_print
= CRM_Core_Smarty
::PRINT_JSON
;
248 $this->_QFResponseType
= 'json';
251 $this->_print
= CRM_Core_Smarty
::PRINT_SNIPPET
;
255 // if the request has a reset value, initialize the controller session
256 if (!empty($_GET['reset'])) {
259 // in this case we'll also cache the url as a hidden form variable, this allows us to
260 // redirect in case the session has disappeared on us
261 $this->_entryURL
= CRM_Utils_System
::makeURL(NULL, TRUE, FALSE, NULL, TRUE);
262 $this->set('entryURL', $this->_entryURL
);
265 // set the key in the session
266 // do this at the end so we have initialized the object
267 // and created the scope etc
268 $this->set('qfKey', $this->_key
);
271 // also retrieve and store destination in session
272 $this->_destination
= CRM_Utils_Request
::retrieve(
273 'civicrmDestination',
282 public function fini() {
283 CRM_Core_BAO_Cache
::storeSessionToCache(array(
284 "_{$this->_name}_container",
285 array('CiviCRM', $this->_scope
),
292 * @param string $name
293 * @param bool $addSequence
294 * @param bool $ignoreKey
296 * @return mixed|string
298 public function key($name, $addSequence = FALSE, $ignoreKey = FALSE) {
299 $config = CRM_Core_Config
::singleton();
303 (isset($config->keyDisable
) && $config->keyDisable
)
308 $key = CRM_Utils_Array
::value('qfKey', $_REQUEST, NULL);
309 if (!$key && $_SERVER['REQUEST_METHOD'] === 'GET') {
310 $key = CRM_Core_Key
::get($name, $addSequence);
313 $key = CRM_Core_Key
::validate($key, $name, $addSequence);
326 * Process the request, overrides the default QFC run method
327 * This routine actually checks if the QFC is modal and if it
328 * is the first invalid page, if so it call the requested action
329 * if not, it calls the display action on the first invalid page
330 * avoids the issue of users hitting the back button and getting
333 * This run is basically a composition of the original run and the
338 public function run() {
339 // the names of the action and page should be saved
340 // note that this is split into two, because some versions of
341 // php 5.x core dump on the triple assignment :)
342 $this->_actionName
= $this->getActionName();
343 list($pageName, $action) = $this->_actionName
;
345 if ($this->isModal()) {
346 if (!$this->isValid($pageName)) {
347 $pageName = $this->findInvalid();
352 // note that based on action, control might not come back!!
353 // e.g. if action is a valid JUMP, u basically do a redirect
354 // to the appropriate place
355 $this->wizardHeader($pageName);
356 return $this->_pages
[$pageName]->handle($action);
362 public function validate() {
363 $this->_actionName
= $this->getActionName();
364 list($pageName, $action) = $this->_actionName
;
366 $page = &$this->_pages
[$pageName];
368 $data = &$this->container();
369 $this->applyDefaults($pageName);
370 $page->isFormBuilt() or $page->buildForm();
371 // We use defaults and constants as if they were submitted
372 $data['values'][$pageName] = $page->exportValues();
373 $page->loadValues($data['values'][$pageName]);
374 // Is the page now valid?
375 if (TRUE === ($data['valid'][$pageName] = $page->validate())) {
378 return $page->_errors
;
382 * Helper function to add all the needed default actions. Note that the framework
383 * redefines all of the default QFC actions
385 * @param string directory to store all the uploaded files
386 * @param array names for the various upload buttons (note u can have more than 1 upload)
392 public function addActions($uploadDirectory = NULL, $uploadNames = NULL) {
394 'display' => 'CRM_Core_QuickForm_Action_Display',
395 'next' => 'CRM_Core_QuickForm_Action_Next',
396 'back' => 'CRM_Core_QuickForm_Action_Back',
397 'process' => 'CRM_Core_QuickForm_Action_Process',
398 'cancel' => 'CRM_Core_QuickForm_Action_Cancel',
399 'refresh' => 'CRM_Core_QuickForm_Action_Refresh',
400 'reload' => 'CRM_Core_QuickForm_Action_Reload',
401 'done' => 'CRM_Core_QuickForm_Action_Done',
402 'jump' => 'CRM_Core_QuickForm_Action_Jump',
403 'submit' => 'CRM_Core_QuickForm_Action_Submit',
406 foreach ($names as $name => $classPath) {
407 $action = new $classPath($this->_stateMachine
);
408 $this->addAction($name, $action);
411 $this->addUploadAction($uploadDirectory, $uploadNames);
415 * Getter method for stateMachine
417 * @return CRM_Core_StateMachine
419 public function getStateMachine() {
420 return $this->_stateMachine
;
424 * Setter method for stateMachine
426 * @param CRM_Core_StateMachine $stateMachine
430 public function setStateMachine($stateMachine) {
431 $this->_stateMachine
= $stateMachine;
435 * Add pages to the controller. Note that the controller does not really care
436 * the order in which the pages are added
438 * @param CRM_Core_StateMachine $stateMachine
439 * @param \const|int $action the mode in which the state machine is operating
440 * typicaly this will be add/view/edit
444 public function addPages(&$stateMachine, $action = CRM_Core_Action
::NONE
) {
445 $pages = $stateMachine->getPages();
446 foreach ($pages as $name => $value) {
447 $className = CRM_Utils_Array
::value('className', $value, $name);
448 $title = CRM_Utils_Array
::value('title', $value);
449 $options = CRM_Utils_Array
::value('options', $value);
450 $stateName = CRM_Utils_String
::getClassName($className);
451 if (!empty($value['className'])) {
455 $formName = CRM_Utils_String
::getClassName($name);
458 $ext = CRM_Extension_System
::singleton()->getMapper();
459 if ($ext->isExtensionClass($className)) {
460 require_once ($ext->classToPath($className));
463 require_once (str_replace('_', DIRECTORY_SEPARATOR
, $className) . '.php');
465 $
$stateName = new $className($stateMachine->find($className), $action, 'post', $formName);
467 $
$stateName->setTitle($title);
470 $
$stateName->setOptions($options);
472 if (property_exists($
$stateName, 'urlPath') && isset($_GET[CRM_Core_Config
::singleton()->userFrameworkURLVar
])) {
473 $
$stateName->urlPath
= explode('/', $_GET[CRM_Core_Config
::singleton()->userFrameworkURLVar
]);
475 $this->addPage($
$stateName);
476 $this->addAction($stateName, new HTML_QuickForm_Action_Direct());
478 //CRM-6342 -we need kill the reference here,
479 //as we have deprecated reference object creation.
485 * QFC does not provide native support to have different 'submit' buttons.
486 * We introduce this notion to QFC by using button specific data. Thus if
487 * we have two submit buttons, we could have one displayed as a button and
488 * the other as an image, both are of type 'submit'.
490 * @return string the name of the button that has been pressed by the user
492 public function getButtonName() {
493 $data = &$this->container();
494 return CRM_Utils_Array
::value('_qf_button_name', $data);
498 * Destroy all the session state of the controller.
503 public function reset() {
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
517 public function process() {}
520 * Store the variable with the value in the form scope
522 * @param string|array $name name of the variable or an assoc array of name/value pairs
523 * @param mixed $value value of the variable if string
529 public function set($name, $value = NULL) {
530 self
::$_session->set($name, $value, $this->_scope
);
534 * Get the variable from the form scope
536 * @param string $name : name of the variable
543 public function get($name) {
544 return self
::$_session->get($name, $this->_scope
);
548 * Create the header for the wizard from the list of pages
549 * Store the created header in smarty
551 * @param string $currentPageName name of the page being displayed
555 public function wizardHeader($currentPageName) {
557 $wizard['steps'] = array();
559 foreach ($this->_pages
as $name => $page) {
561 $wizard['steps'][] = array(
563 'title' => $page->getTitle(),
564 //'link' => $page->getLink ( ),
568 'stepNumber' => $count,
569 'collapsed' => FALSE,
572 if ($name == $currentPageName) {
573 $wizard['currentStepNumber'] = $count;
574 $wizard['currentStepName'] = $name;
575 $wizard['currentStepTitle'] = $page->getTitle();
579 $wizard['stepCount'] = $count;
581 $this->addWizardStyle($wizard);
583 $this->assign('wizard', $wizard);
588 * @param array $wizard
590 public function addWizardStyle(&$wizard) {
591 $wizard['style'] = array(
593 'stepPrefixCurrent' => '»',
594 'stepPrefixPast' => '✔',
595 'stepPrefixFuture' => ' ',
596 'subStepPrefixCurrent' => ' ',
597 'subStepPrefixPast' => ' ',
598 'subStepPrefixFuture' => ' ',
604 * Assign value to name in template
607 * @param mixed $value value of varaible
611 public function assign($var, $value = NULL) {
612 self
::$_template->assign($var, $value);
616 * Assign value to name in template by reference
619 * @param mixed $value (reference) value of varaible
623 public function assign_by_ref($var, &$value) {
624 self
::$_template->assign_by_ref($var, $value);
628 * Appends values to template variables
630 * @param array|string $tpl_var the template variable name(s)
631 * @param mixed $value the value to append
634 public function append($tpl_var, $value=NULL, $merge=FALSE) {
635 self
::$_template->append($tpl_var, $value, $merge);
639 * Returns an array containing template variables
641 * @param string $name
645 public function get_template_vars($name=null) {
646 return self
::$_template->get_template_vars($name);
650 * Setter for embedded
652 * @param boolean $embedded
656 public function setEmbedded($embedded) {
657 $this->_embedded
= $embedded;
661 * Getter for embedded
663 * @return boolean return the embedded value
665 public function getEmbedded() {
666 return $this->_embedded
;
670 * Setter for skipRedirection
672 * @param boolean $skipRedirection
676 public function setSkipRedirection($skipRedirection) {
677 $this->_skipRedirection
= $skipRedirection;
681 * Getter for skipRedirection
683 * @return boolean return the skipRedirection value
685 public function getSkipRedirection() {
686 return $this->_skipRedirection
;
690 * @param null $fileName
692 public function setWord($fileName = NULL) {
693 //Mark as a CSV file.
694 header('Content-Type: application/vnd.ms-word');
696 //Force a download and name the file using the current timestamp.
698 $fileName = 'Contacts_' . $_SERVER['REQUEST_TIME'] . '.doc';
700 header("Content-Disposition: attachment; filename=Contacts_$fileName");
704 * @param null $fileName
706 public function setExcel($fileName = NULL) {
707 //Mark as an excel file.
708 header('Content-Type: application/vnd.ms-excel');
710 //Force a download and name the file using the current timestamp.
712 $fileName = 'Contacts_' . $_SERVER['REQUEST_TIME'] . '.xls';
715 header("Content-Disposition: attachment; filename=Contacts_$fileName");
721 * @param boolean $print
725 public function setPrint($print) {
726 if ($print == "xls") {
729 elseif ($print == "doc") {
732 $this->_print
= $print;
738 * @return boolean return the print value
740 public function getPrint() {
741 return $this->_print
;
747 public function getTemplateFile() {
749 if ($this->_print
== CRM_Core_Smarty
::PRINT_PAGE
) {
750 return 'CRM/common/print.tpl';
752 elseif ($this->_print
== 'xls' ||
$this->_print
== 'doc') {
753 return 'CRM/Contact/Form/Task/Excel.tpl';
756 return 'CRM/common/snippet.tpl';
760 $config = CRM_Core_Config
::singleton();
761 return 'CRM/common/' . strtolower($config->userFramework
) . '.tpl';
767 * @param $uploadNames
769 public function addUploadAction($uploadDir, $uploadNames) {
770 if (empty($uploadDir)) {
771 $config = CRM_Core_Config
::singleton();
772 $uploadDir = $config->uploadDir
;
775 if (empty($uploadNames)) {
776 $uploadNames = $this->get('uploadNames');
777 if (!empty($uploadNames)) {
778 $uploadNames = array_merge($uploadNames,
779 CRM_Core_BAO_File
::uploadNames()
783 $uploadNames = CRM_Core_BAO_File
::uploadNames();
787 $action = new CRM_Core_QuickForm_Action_Upload($this->_stateMachine
,
791 $this->addAction('upload', $action);
797 public function setParent($parent) {
798 $this->_parent
= $parent;
804 public function getParent() {
805 return $this->_parent
;
811 public function getDestination() {
812 return $this->_destination
;
817 * @param bool $setToReferer
819 public function setDestination($url = NULL, $setToReferer = FALSE) {
822 $url = $_SERVER['HTTP_REFERER'];
825 $config = CRM_Core_Config
::singleton();
826 $url = $config->userFrameworkBaseURL
;
830 $this->_destination
= $url;
831 $this->set('civicrmDestination', $this->_destination
);
837 public function cancelAction() {
838 $actionName = $this->getActionName();
839 list($pageName, $action) = $actionName;
840 return $this->_pages
[$pageName]->cancelAction();
844 * Write a simple fatal error message. Other controllers can decide to do something else
845 * and present the user a better message and/or redirect to the same page with a reset url
850 public function invalidKey() {
851 self
::invalidKeyCommon();
854 public function invalidKeyCommon() {
855 $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.');
856 CRM_Core_Error
::fatal($msg);
860 * Instead of outputting a fatal error message, we'll just redirect to the entryURL if present
864 public function invalidKeyRedirect() {
865 if ($this->_entryURL
) {
866 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.'));
867 return CRM_Utils_System
::redirect($this->_entryURL
);
870 self
::invalidKeyCommon();