3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
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-2015
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 public function __construct(
181 $addSequence = FALSE,
184 // this has to true for multiple tab session fix
187 // let the constructor initialize this, should happen only once
188 if (!isset(self
::$_template)) {
189 self
::$_template = CRM_Core_Smarty
::singleton();
190 self
::$_session = CRM_Core_Session
::singleton();
193 // lets try to get it from the session and/or the request vars
194 // we do this early on in case there is a fatal error in retrieving the
195 // key and/or session
197 = CRM_Utils_Request
::retrieve('entryURL', 'String', $this);
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 // mode deprecated in favor of json
240 // still used by dashlets, probably nothing else
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 (!empty($_GET['reset'])) {
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
);
268 // also retrieve and store destination in session
269 $this->_destination
= CRM_Utils_Request
::retrieve(
270 'civicrmDestination',
279 public function fini() {
280 CRM_Core_BAO_Cache
::storeSessionToCache(array(
281 "_{$this->_name}_container",
282 array('CiviCRM', $this->_scope
),
289 * @param string $name
290 * @param bool $addSequence
291 * @param bool $ignoreKey
293 * @return mixed|string
295 public function key($name, $addSequence = FALSE, $ignoreKey = FALSE) {
296 $config = CRM_Core_Config
::singleton();
300 (isset($config->keyDisable
) && $config->keyDisable
)
305 $key = CRM_Utils_Array
::value('qfKey', $_REQUEST, NULL);
306 if (!$key && $_SERVER['REQUEST_METHOD'] === 'GET') {
307 $key = CRM_Core_Key
::get($name, $addSequence);
310 $key = CRM_Core_Key
::validate($key, $name, $addSequence);
323 * Process the request, overrides the default QFC run method
324 * This routine actually checks if the QFC is modal and if it
325 * is the first invalid page, if so it call the requested action
326 * if not, it calls the display action on the first invalid page
327 * avoids the issue of users hitting the back button and getting
330 * This run is basically a composition of the original run and the
335 public function run() {
336 // the names of the action and page should be saved
337 // note that this is split into two, because some versions of
338 // php 5.x core dump on the triple assignment :)
339 $this->_actionName
= $this->getActionName();
340 list($pageName, $action) = $this->_actionName
;
342 if ($this->isModal()) {
343 if (!$this->isValid($pageName)) {
344 $pageName = $this->findInvalid();
349 // note that based on action, control might not come back!!
350 // e.g. if action is a valid JUMP, u basically do a redirect
351 // to the appropriate place
352 $this->wizardHeader($pageName);
353 return $this->_pages
[$pageName]->handle($action);
359 public function validate() {
360 $this->_actionName
= $this->getActionName();
361 list($pageName, $action) = $this->_actionName
;
363 $page = &$this->_pages
[$pageName];
365 $data = &$this->container();
366 $this->applyDefaults($pageName);
367 $page->isFormBuilt() or $page->buildForm();
368 // We use defaults and constants as if they were submitted
369 $data['values'][$pageName] = $page->exportValues();
370 $page->loadValues($data['values'][$pageName]);
371 // Is the page now valid?
372 if (TRUE === ($data['valid'][$pageName] = $page->validate())) {
375 return $page->_errors
;
379 * Helper function to add all the needed default actions. Note that the framework
380 * redefines all of the default QFC actions
382 * @param string $uploadDirectory to store all the uploaded files
383 * @param array $uploadNames for the various upload buttons (note u can have more than 1 upload)
388 public function addActions($uploadDirectory = NULL, $uploadNames = NULL) {
390 'display' => 'CRM_Core_QuickForm_Action_Display',
391 'next' => 'CRM_Core_QuickForm_Action_Next',
392 'back' => 'CRM_Core_QuickForm_Action_Back',
393 'process' => 'CRM_Core_QuickForm_Action_Process',
394 'cancel' => 'CRM_Core_QuickForm_Action_Cancel',
395 'refresh' => 'CRM_Core_QuickForm_Action_Refresh',
396 'reload' => 'CRM_Core_QuickForm_Action_Reload',
397 'done' => 'CRM_Core_QuickForm_Action_Done',
398 'jump' => 'CRM_Core_QuickForm_Action_Jump',
399 'submit' => 'CRM_Core_QuickForm_Action_Submit',
402 foreach ($names as $name => $classPath) {
403 $action = new $classPath($this->_stateMachine
);
404 $this->addAction($name, $action);
407 $this->addUploadAction($uploadDirectory, $uploadNames);
411 * Getter method for stateMachine.
413 * @return CRM_Core_StateMachine
415 public function getStateMachine() {
416 return $this->_stateMachine
;
420 * Setter method for stateMachine.
422 * @param CRM_Core_StateMachine $stateMachine
426 public function setStateMachine($stateMachine) {
427 $this->_stateMachine
= $stateMachine;
431 * Add pages to the controller. Note that the controller does not really care
432 * the order in which the pages are added
434 * @param CRM_Core_StateMachine $stateMachine
435 * @param \const|int $action the mode in which the state machine is operating
436 * typically this will be add/view/edit
440 public function addPages(&$stateMachine, $action = CRM_Core_Action
::NONE
) {
441 $pages = $stateMachine->getPages();
442 foreach ($pages as $name => $value) {
443 $className = CRM_Utils_Array
::value('className', $value, $name);
444 $title = CRM_Utils_Array
::value('title', $value);
445 $options = CRM_Utils_Array
::value('options', $value);
446 $stateName = CRM_Utils_String
::getClassName($className);
447 if (!empty($value['className'])) {
451 $formName = CRM_Utils_String
::getClassName($name);
454 $ext = CRM_Extension_System
::singleton()->getMapper();
455 if ($ext->isExtensionClass($className)) {
456 require_once $ext->classToPath($className);
459 require_once str_replace('_', DIRECTORY_SEPARATOR
, $className) . '.php';
461 $
$stateName = new $className($stateMachine->find($className), $action, 'post', $formName);
463 $
$stateName->setTitle($title);
466 $
$stateName->setOptions($options);
468 if (property_exists($
$stateName, 'urlPath') && isset($_GET[CRM_Core_Config
::singleton()->userFrameworkURLVar
])) {
469 $
$stateName->urlPath
= explode('/', $_GET[CRM_Core_Config
::singleton()->userFrameworkURLVar
]);
471 $this->addPage($
$stateName);
472 $this->addAction($stateName, new HTML_QuickForm_Action_Direct());
474 //CRM-6342 -we need kill the reference here,
475 //as we have deprecated reference object creation.
481 * QFC does not provide native support to have different 'submit' buttons.
482 * We introduce this notion to QFC by using button specific data. Thus if
483 * we have two submit buttons, we could have one displayed as a button and
484 * the other as an image, both are of type 'submit'.
487 * the name of the button that has been pressed by the user
489 public function getButtonName() {
490 $data = &$this->container();
491 return CRM_Utils_Array
::value('_qf_button_name', $data);
495 * Destroy all the session state of the controller.
500 public function reset() {
501 $this->container(TRUE);
502 self
::$_session->resetScope($this->_scope
);
506 * Virtual function to do any processing of data.
507 * Sometimes it is useful for the controller to actually process data.
508 * This is typically used when we need the controller to figure out
509 * what pages are potentially involved in this wizard. (this is dynamic
510 * and can change based on the arguments
514 public function process() {
518 * Store the variable with the value in the form scope.
520 * @param string|array $name name of the variable or an assoc array of name/value pairs
521 * @param mixed $value
522 * Value of the variable if string.
527 public function set($name, $value = NULL) {
528 self
::$_session->set($name, $value, $this->_scope
);
532 * Get the variable from the form scope.
534 * @param string $name
535 * name of the variable.
540 public function get($name) {
541 return self
::$_session->get($name, $this->_scope
);
545 * Create the header for the wizard from the list of pages.
546 * Store the created header in smarty
548 * @param string $currentPageName
549 * Name of the page being displayed.
553 public function wizardHeader($currentPageName) {
555 $wizard['steps'] = array();
557 foreach ($this->_pages
as $name => $page) {
559 $wizard['steps'][] = array(
561 'title' => $page->getTitle(),
562 //'link' => $page->getLink ( ),
566 'stepNumber' => $count,
567 'collapsed' => FALSE,
570 if ($name == $currentPageName) {
571 $wizard['currentStepNumber'] = $count;
572 $wizard['currentStepName'] = $name;
573 $wizard['currentStepTitle'] = $page->getTitle();
577 $wizard['stepCount'] = $count;
579 $this->addWizardStyle($wizard);
581 $this->assign('wizard', $wizard);
586 * @param array $wizard
588 public function addWizardStyle(&$wizard) {
589 $wizard['style'] = array(
591 'stepPrefixCurrent' => '»',
592 'stepPrefixPast' => '✔',
593 'stepPrefixFuture' => ' ',
594 'subStepPrefixCurrent' => ' ',
595 'subStepPrefixPast' => ' ',
596 'subStepPrefixFuture' => ' ',
602 * Assign value to name in template.
605 * @param mixed $value
610 public function assign($var, $value = NULL) {
611 self
::$_template->assign($var, $value);
615 * Assign value to name in template by reference.
618 * @param mixed $value
619 * (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
632 * The value to append.
635 public function append($tpl_var, $value = NULL, $merge = FALSE) {
636 self
::$_template->append($tpl_var, $value, $merge);
640 * Returns an array containing template variables.
642 * @param string $name
646 public function get_template_vars($name = NULL) {
647 return self
::$_template->get_template_vars($name);
651 * Setter for embedded.
653 * @param bool $embedded
657 public function setEmbedded($embedded) {
658 $this->_embedded
= $embedded;
662 * Getter for embedded.
665 * return the embedded value
667 public function getEmbedded() {
668 return $this->_embedded
;
672 * Setter for skipRedirection.
674 * @param bool $skipRedirection
678 public function setSkipRedirection($skipRedirection) {
679 $this->_skipRedirection
= $skipRedirection;
683 * Getter for skipRedirection.
686 * return the skipRedirection value
688 public function getSkipRedirection() {
689 return $this->_skipRedirection
;
693 * @param null $fileName
695 public function setWord($fileName = NULL) {
696 //Mark as a CSV file.
697 header('Content-Type: application/vnd.ms-word');
699 //Force a download and name the file using the current timestamp.
701 $fileName = 'Contacts_' . $_SERVER['REQUEST_TIME'] . '.doc';
703 header("Content-Disposition: attachment; filename=Contacts_$fileName");
707 * @param null $fileName
709 public function setExcel($fileName = NULL) {
710 //Mark as an excel file.
711 header('Content-Type: application/vnd.ms-excel');
713 //Force a download and name the file using the current timestamp.
715 $fileName = 'Contacts_' . $_SERVER['REQUEST_TIME'] . '.xls';
718 header("Content-Disposition: attachment; filename=Contacts_$fileName");
728 public function setPrint($print) {
729 if ($print == "xls") {
732 elseif ($print == "doc") {
735 $this->_print
= $print;
742 * return the print value
744 public function getPrint() {
745 return $this->_print
;
751 public function getTemplateFile() {
753 if ($this->_print
== CRM_Core_Smarty
::PRINT_PAGE
) {
754 return 'CRM/common/print.tpl';
756 elseif ($this->_print
== 'xls' ||
$this->_print
== 'doc') {
757 return 'CRM/Contact/Form/Task/Excel.tpl';
760 return 'CRM/common/snippet.tpl';
764 $config = CRM_Core_Config
::singleton();
765 return 'CRM/common/' . strtolower($config->userFramework
) . '.tpl';
771 * @param $uploadNames
773 public function addUploadAction($uploadDir, $uploadNames) {
774 if (empty($uploadDir)) {
775 $config = CRM_Core_Config
::singleton();
776 $uploadDir = $config->uploadDir
;
779 if (empty($uploadNames)) {
780 $uploadNames = $this->get('uploadNames');
781 if (!empty($uploadNames)) {
782 $uploadNames = array_merge($uploadNames,
783 CRM_Core_BAO_File
::uploadNames()
787 $uploadNames = CRM_Core_BAO_File
::uploadNames();
791 $action = new CRM_Core_QuickForm_Action_Upload($this->_stateMachine
,
795 $this->addAction('upload', $action);
801 public function setParent($parent) {
802 $this->_parent
= $parent;
808 public function getParent() {
809 return $this->_parent
;
815 public function getDestination() {
816 return $this->_destination
;
821 * @param bool $setToReferer
823 public function setDestination($url = NULL, $setToReferer = FALSE) {
826 $url = $_SERVER['HTTP_REFERER'];
829 $config = CRM_Core_Config
::singleton();
830 $url = $config->userFrameworkBaseURL
;
834 $this->_destination
= $url;
835 $this->set('civicrmDestination', $this->_destination
);
841 public function cancelAction() {
842 $actionName = $this->getActionName();
843 list($pageName, $action) = $actionName;
844 return $this->_pages
[$pageName]->cancelAction();
848 * Write a simple fatal error message. Other controllers can decide to do something else
849 * and present the user a better message and/or redirect to the same page with a reset url
853 public function invalidKey() {
854 self
::invalidKeyCommon();
857 public function invalidKeyCommon() {
858 $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 administrator 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.');
859 CRM_Core_Error
::fatal($msg);
863 * Instead of outputting a fatal error message, we'll just redirect to the entryURL if present
867 public function invalidKeyRedirect() {
868 if ($this->_entryURL
) {
869 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.'));
870 return CRM_Utils_System
::redirect($this->_entryURL
);
873 self
::invalidKeyCommon();