CRM/Core/Page.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.4                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  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.   |
  13  |                                                                    |
  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.        |
  18  |                                                                    |
  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  +--------------------------------------------------------------------+
  26 */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2013
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * A Page is basically data in a nice pretty format.
  38  *
  39  * Pages should not have any form actions / elements in them. If they
  40  * do, make sure you use CRM_Core_Form and the related structures. You can
  41  * embed simple forms in Page and do your own form handling.
  42  *
  43  */
  44 class CRM_Core_Page {
  45
  46   /**
  47    * The name of the page (auto generated from class name)
  48    *
  49    * @var string
  50    * @access protected
  51    */
  52   protected $_name;
  53
  54   /**
  55    * the title associated with this page
  56    *
  57    * @var object
  58    * @access protected
  59    */
  60   protected $_title;
  61
  62   /**
  63    * A page can have multiple modes. (i.e. displays
  64    * a different set of data based on the input
  65    * @var int
  66    * @access protected
  67    */
  68   protected $_mode;
  69
  70   /**
  71    * Is this object being embedded in another object. If
  72    * so the display routine needs to not do any work. (The
  73    * parent object takes care of the display)
  74    *
  75    * @var boolean
  76    * @access protected
  77    */
  78   protected $_embedded = FALSE;
  79
  80   /**
  81    * Are we in print mode? if so we need to modify the display
  82    * functionality to do a minimal display :)
  83    *
  84    * @var boolean
  85    * @access protected
  86    */
  87   protected $_print = FALSE;
  88
  89   /**
  90    * cache the smarty template for efficiency reasons
  91    *
  92    * @var CRM_Core_Smarty
  93    * @access protected
  94    * @static
  95    */
  96   static protected $_template;
  97
  98   /**
  99    * cache the session for efficiency reasons
 100    *
 101    * @var CRM_Core_Session
 102    * @access protected
 103    * @static
 104    */
 105   static protected $_session;
 106
 107   /**
 108    * What to return to the client if in ajax mode (snippet=json)
 109    *
 110    * @var array
 111    */
 112   public $ajaxResponse = array();
 113
 114   /**
 115    * Url path used to reach this page
 116    *
 117    * @var array
 118    */
 119   public $urlPath = array();
 120
 121   /**
 122    * class constructor
 123    *
 124    * @param string $title title of the page
 125    * @param int    $mode  mode of the page
 126    *
 127    * @return CRM_Core_Page
 128    */
 129   function __construct($title = NULL, $mode = NULL) {
 130     $this->_name  = CRM_Utils_System::getClassName($this);
 131     $this->_title = $title;
 132     $this->_mode  = $mode;
 133
 134     // let the constructor initialize this, should happen only once
 135     if (!isset(self::$_template)) {
 136       self::$_template = CRM_Core_Smarty::singleton();
 137       self::$_session = CRM_Core_Session::singleton();
 138     }
 139
 140     // FIXME - why are we messing with 'snippet'? Why not just pass it directly into $this->_print?
 141     if (!empty($_REQUEST['snippet'])) {
 142       if ($_REQUEST['snippet'] == CRM_Core_Smarty::PRINT_PDF) {
 143         $this->_print = CRM_Core_Smarty::PRINT_PDF;
 144       }
 145       // FIXME - why does this number not match the constant?
 146       elseif ($_REQUEST['snippet'] == 5) {
 147         $this->_print = CRM_Core_Smarty::PRINT_NOFORM;
 148       }
 149       // Support 'json' as well as legacy value '6'
 150       elseif (in_array($_REQUEST['snippet'], array(CRM_Core_Smarty::PRINT_JSON, 6))) {
 151         $this->_print = CRM_Core_Smarty::PRINT_JSON;
 152       }
 153       else {
 154         $this->_print = CRM_Core_Smarty::PRINT_SNIPPET;
 155       }
 156     }
 157
 158     // if the request has a reset value, initialize the controller session
 159     if (!empty($_REQUEST['reset'])) {
 160       $this->reset();
 161     }
 162   }
 163
 164   /**
 165    * This function takes care of all the things common to all
 166    * pages. This typically involves assigning the appropriate
 167    * smarty variable :)
 168    *
 169    * @return string The content generated by running this page
 170    */
 171   function run() {
 172     if ($this->_embedded) {
 173       return;
 174     }
 175
 176     self::$_template->assign('mode', $this->_mode);
 177
 178     $pageTemplateFile = $this->getHookedTemplateFileName();
 179     self::$_template->assign('tplFile', $pageTemplateFile);
 180
 181     // invoke the pagRun hook, CRM-3906
 182     CRM_Utils_Hook::pageRun($this);
 183
 184     if ($this->_print) {
 185       if (in_array( $this->_print, array( CRM_Core_Smarty::PRINT_SNIPPET,
 186         CRM_Core_Smarty::PRINT_PDF, CRM_Core_Smarty::PRINT_NOFORM, CRM_Core_Smarty::PRINT_JSON ))) {
 187         $content = self::$_template->fetch('CRM/common/snippet.tpl');
 188       }
 189       else {
 190         $content = self::$_template->fetch('CRM/common/print.tpl');
 191       }
 192
 193       CRM_Utils_System::appendTPLFile($pageTemplateFile,
 194         $content,
 195         $this->overrideExtraTemplateFileName()
 196       );
 197
 198       //its time to call the hook.
 199       CRM_Utils_Hook::alterContent($content, 'page', $pageTemplateFile, $this);
 200
 201       if ($this->_print == CRM_Core_Smarty::PRINT_PDF) {
 202         CRM_Utils_PDF_Utils::html2pdf($content, "{$this->_name}.pdf", FALSE,
 203           array('paper_size' => 'a3', 'orientation' => 'landscape')
 204         );
 205       }
 206       elseif ($this->_print == CRM_Core_Smarty::PRINT_JSON) {
 207         $this->ajaxResponse['content'] = $content;
 208         CRM_Core_Page_AJAX::returnJsonResponse($this->ajaxResponse);
 209       }
 210       else {
 211         echo $content;
 212       }
 213       CRM_Utils_System::civiExit();
 214     }
 215
 216     $config = CRM_Core_Config::singleton();
 217
 218     // TODO: Is there a better way to ensure these actions don't happen during AJAX requests?
 219     if (empty($_GET['snippet'])) {
 220       // Version check and intermittent alert to admins
 221       CRM_Utils_VersionCheck::singleton()->versionAlert();
 222       CRM_Utils_Check_Security::singleton()->showPeriodicAlerts();
 223
 224       // Debug msg once per hour
 225       if ($config->debug && CRM_Core_Permission::check('administer CiviCRM') && CRM_Core_Session::singleton()->timer('debug_alert', 3600)) {
 226         $msg = ts('Warning: Debug is enabled in <a href="%1">system settings</a>. This should not be enabled on production servers.', array(1 => CRM_Utils_System::url('civicrm/admin/setting/debug', 'reset=1')));
 227         CRM_Core_Session::setStatus($msg, ts('Debug Mode'));
 228       }
 229     }
 230
 231     $content = self::$_template->fetch('CRM/common/' . strtolower($config->userFramework) . '.tpl');
 232
 233     // Render page header
 234     if (!defined('CIVICRM_UF_HEAD') && $region = CRM_Core_Region::instance('html-header', FALSE)) {
 235       CRM_Utils_System::addHTMLHead($region->render(''));
 236     }
 237     CRM_Utils_System::appendTPLFile($pageTemplateFile, $content);
 238
 239     //its time to call the hook.
 240     CRM_Utils_Hook::alterContent($content, 'page', $pageTemplateFile, $this);
 241
 242     echo CRM_Utils_System::theme($content, $this->_print);
 243     return;
 244   }
 245
 246   /**
 247    * Store the variable with the value in the form scope
 248    *
 249    * @param  string|array $name  name  of the variable or an assoc array of name/value pairs
 250    * @param  mixed        $value value of the variable if string
 251    *
 252    * @access public
 253    *
 254    * @return void
 255    *
 256    */
 257   function set($name, $value = NULL) {
 258     self::$_session->set($name, $value, $this->_name);
 259   }
 260
 261   /**
 262    * Get the variable from the form scope
 263    *
 264    * @param  string name  : name  of the variable
 265    *
 266    * @access public
 267    *
 268    * @return mixed
 269    *
 270    */
 271   function get($name) {
 272     return self::$_session->get($name, $this->_name);
 273   }
 274
 275   /**
 276    * assign value to name in template
 277    *
 278    * @param array|string $name  name  of variable
 279    * @param mixed $value value of varaible
 280    *
 281    * @return void
 282    * @access public
 283    */
 284   function assign($var, $value = NULL) {
 285     self::$_template->assign($var, $value);
 286   }
 287
 288   /**
 289    * assign value to name in template by reference
 290    *
 291    * @param array|string $name  name  of variable
 292    * @param mixed $value (reference) value of varaible
 293    *
 294    * @return void
 295    * @access public
 296    */
 297   function assign_by_ref($var, &$value) {
 298     self::$_template->assign_by_ref($var, $value);
 299   }
 300
 301   /**
 302    * appends values to template variables
 303    *
 304    * @param array|string $tpl_var the template variable name(s)
 305    * @param mixed $value the value to append
 306    * @param bool $merge
 307    */
 308   function append($tpl_var, $value=NULL, $merge=FALSE) {
 309     self::$_template->append($tpl_var, $value, $merge);
 310   }
 311
 312   /**
 313    * Returns an array containing template variables
 314    *
 315    * @param string $name
 316    * @param string $type
 317    * @return array
 318    */
 319   function get_template_vars($name=null) {
 320     return self::$_template->get_template_vars($name);
 321   }
 322
 323   /**
 324    * function to destroy all the session state of this page.
 325    *
 326    * @access public
 327    *
 328    * @return void
 329    */
 330   function reset() {
 331     self::$_session->resetScope($this->_name);
 332   }
 333
 334   /**
 335    * Use the form name to create the tpl file name
 336    *
 337    * @return string
 338    * @access public
 339    */
 340   function getTemplateFileName() {
 341     return str_replace('_',
 342       DIRECTORY_SEPARATOR,
 343       CRM_Utils_System::getClassName($this)
 344     ) . '.tpl';
 345   }
 346
 347   /**
 348    * A wrapper for getTemplateFileName that includes calling the hook to
 349    * prevent us from having to copy & paste the logic of calling the hook
 350    */
 351   function getHookedTemplateFileName() {
 352     $pageTemplateFile = $this->getTemplateFileName();
 353     CRM_Utils_Hook::alterTemplateFile(get_class($this), $this, 'page', $pageTemplateFile);
 354     return $pageTemplateFile;
 355   }
 356
 357   /**
 358    * Default extra tpl file basically just replaces .tpl with .extra.tpl
 359    * i.e. we dont override
 360    *
 361    * @return string
 362    * @access public
 363    */
 364   function overrideExtraTemplateFileName() {
 365     return NULL;
 366   }
 367
 368   /**
 369    * setter for embedded
 370    *
 371    * @param boolean $embedded
 372    *
 373    * @return void
 374    * @access public
 375    */
 376   function setEmbedded($embedded) {
 377     $this->_embedded = $embedded;
 378   }
 379
 380   /**
 381    * getter for embedded
 382    *
 383    * @return boolean return the embedded value
 384    * @access public
 385    */
 386   function getEmbedded() {
 387     return $this->_embedded;
 388   }
 389
 390   /**
 391    * setter for print
 392    *
 393    * @param boolean $print
 394    *
 395    * @return void
 396    * @access public
 397    */
 398   function setPrint($print) {
 399     $this->_print = $print;
 400   }
 401
 402   /**
 403    * getter for print
 404    *
 405    * @return boolean return the print value
 406    * @access public
 407    */
 408   function getPrint() {
 409     return $this->_print;
 410   }
 411
 412   static function &getTemplate() {
 413     return self::$_template;
 414   }
 415
 416   function getVar($name) {
 417     return isset($this->$name) ? $this->$name : NULL;
 418   }
 419
 420   function setVar($name, $value) {
 421     $this->$name = $value;
 422   }
 423 }
 424