libraries/Response.class.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * Manages the rendering of pages in PMA
   5  *
   6  * @package PhpMyAdmin
   7  */
   8 if (! defined('PHPMYADMIN')) {
   9     exit;
  10 }
  11
  12 require_once 'libraries/OutputBuffering.class.php';
  13 require_once 'libraries/Header.class.php';
  14 require_once 'libraries/Footer.class.php';
  15
  16 /**
  17  * Singleton class used to manage the rendering of pages in PMA
  18  *
  19  * @package PhpMyAdmin
  20  */
  21 class PMA_Response
  22 {
  23     /**
  24      * PMA_Response instance
  25      *
  26      * @access private
  27      * @static
  28      * @var object
  29      */
  30     private static $_instance;
  31     /**
  32      * PMA_Header instance
  33      *
  34      * @access private
  35      * @var object
  36      */
  37     private $_header;
  38     /**
  39      * HTML data to be used in the response
  40      *
  41      * @access private
  42      * @var string
  43      */
  44     private $_HTML;
  45     /**
  46      * An array of JSON key-value pairs
  47      * to be sent back for ajax requests
  48      *
  49      * @access private
  50      * @var array
  51      */
  52     private $_JSON;
  53     /**
  54      * PMA_Footer instance
  55      *
  56      * @access private
  57      * @var object
  58      */
  59     private $_footer;
  60     /**
  61      * Whether we are servicing an ajax request.
  62      * We can't simply use $GLOBALS['is_ajax_request']
  63      * here since it may have not been initialised yet.
  64      *
  65      * @access private
  66      * @var bool
  67      */
  68     private $_isAjax;
  69     /**
  70      * Whether we are servicing an ajax request for a page
  71      * that was fired using the generic page handler in JS.
  72      *
  73      * @access private
  74      * @var bool
  75      */
  76     private $_isAjaxPage;
  77     /**
  78      * Whether there were any errors druing the processing of the request
  79      * Only used for ajax responses
  80      *
  81      * @access private
  82      * @var bool
  83      */
  84     private $_isSuccess;
  85     /**
  86      * Workaround for PHP bug
  87      *
  88      * @access private
  89      * @var bool
  90      */
  91     private $_CWD;
  92
  93     /**
  94      * Creates a new class instance
  95      *
  96      * @return new PMA_Response object
  97      */
  98     private function __construct()
  99     {
 100         if (! defined('TESTSUITE')) {
 101             $buffer = PMA_OutputBuffering::getInstance();
 102             $buffer->start();
 103         }
 104         $this->_header = new PMA_Header();
 105         $this->_HTML   = '';
 106         $this->_JSON   = array();
 107         $this->_footer = new PMA_Footer();
 108
 109         $this->_isSuccess  = true;
 110         $this->_isAjax     = false;
 111         $this->_isAjaxPage = false;
 112         if (isset($_REQUEST['ajax_request']) && $_REQUEST['ajax_request'] == true) {
 113             $this->_isAjax = true;
 114         }
 115         if (isset($_REQUEST['ajax_page_request'])
 116             && $_REQUEST['ajax_page_request'] == true
 117         ) {
 118             $this->_isAjaxPage = true;
 119         }
 120         $this->_header->setAjax($this->_isAjax);
 121         $this->_footer->setAjax($this->_isAjax);
 122         $this->_CWD = getcwd();
 123     }
 124
 125     /**
 126      * Returns the singleton PMA_Response object
 127      *
 128      * @return PMA_Response object
 129      */
 130     public static function getInstance()
 131     {
 132         if (empty(self::$_instance)) {
 133             self::$_instance = new PMA_Response();
 134         }
 135         return self::$_instance;
 136     }
 137
 138     /**
 139      * Set the status of an ajax response,
 140      * whether it is a success or an error
 141      *
 142      * @param bool $state Whether the request was successfully processed
 143      *
 144      * @return void
 145      */
 146     public function isSuccess($state)
 147     {
 148         $this->_isSuccess = ($state == true);
 149     }
 150
 151     /**
 152      * Returns true or false depending on whether
 153      * we are servicing an ajax request
 154      *
 155      * @return bool
 156      */
 157     public function isAjax()
 158     {
 159         return $this->_isAjax;
 160     }
 161
 162     /**
 163      * Returns the path to the current working directory
 164      * Necessary to work around a PHP bug where the CWD is
 165      * reset after the initial script exits
 166      *
 167      * @return string
 168      */
 169     public function getCWD()
 170     {
 171         return $this->_CWD;
 172     }
 173
 174     /**
 175      * Disables the rendering of the header
 176      * and the footer in responses
 177      *
 178      * @return void
 179      */
 180     public function disable()
 181     {
 182         $this->_header->disable();
 183         $this->_footer->disable();
 184     }
 185
 186     /**
 187      * Returns a PMA_Header object
 188      *
 189      * @return object
 190      */
 191     public function getHeader()
 192     {
 193         return $this->_header;
 194     }
 195
 196     /**
 197      * Returns a PMA_Footer object
 198      *
 199      * @return object
 200      */
 201     public function getFooter()
 202     {
 203         return $this->_footer;
 204     }
 205
 206     /**
 207      * Add HTML code to the response
 208      *
 209      * @param string $content A string to be appended to
 210      *                        the current output buffer
 211      *
 212      * @return void
 213      */
 214     public function addHTML($content)
 215     {
 216         if (is_array($content)) {
 217             foreach ($content as $msg) {
 218                 $this->addHTML($msg);
 219             }
 220         } elseif ($content instanceof PMA_Message) {
 221             $this->_HTML .= $content->getDisplay();
 222         } else {
 223             $this->_HTML .= $content;
 224         }
 225     }
 226
 227     /**
 228      * Add JSON code to the response
 229      *
 230      * @param mixed $json  Either a key (string) or an
 231      *                     array or key-value pairs
 232      * @param mixed $value Null, if passing an array in $json otherwise
 233      *                     it's a string value to the key
 234      *
 235      * @return void
 236      */
 237     public function addJSON($json, $value = null)
 238     {
 239         if (is_array($json)) {
 240             foreach ($json as $key => $value) {
 241                 $this->addJSON($key, $value);
 242             }
 243         } else {
 244             if ($value instanceof PMA_Message) {
 245                 $this->_JSON[$json] = $value->getDisplay();
 246             } else {
 247                 $this->_JSON[$json] = $value;
 248             }
 249         }
 250
 251     }
 252
 253     /**
 254      * Renders the HTML response text
 255      *
 256      * @return string
 257      */
 258     private function _getDisplay()
 259     {
 260         // The header may contain nothing at all,
 261         // if it's content was already rendered
 262         // and, in this case, the header will be
 263         // in the content part of the request
 264         $retval  = $this->_header->getDisplay();
 265         $retval .= $this->_HTML;
 266         $retval .= $this->_footer->getDisplay();
 267         return $retval;
 268     }
 269
 270     /**
 271      * Sends an HTML response to the browser
 272      *
 273      * @return void
 274      */
 275     private function _htmlResponse()
 276     {
 277         echo $this->_getDisplay();
 278     }
 279
 280     /**
 281      * Sends a JSON response to the browser
 282      *
 283      * @return void
 284      */
 285     private function _ajaxResponse()
 286     {
 287         if (! isset($this->_JSON['message'])) {
 288             $this->_JSON['message'] = $this->_getDisplay();
 289         } else if ($this->_JSON['message'] instanceof PMA_Message) {
 290             $this->_JSON['message'] = $this->_JSON['message']->getDisplay();
 291         }
 292
 293         if ($this->_isSuccess) {
 294             $this->_JSON['success'] = true;
 295         } else {
 296             $this->_JSON['success'] = false;
 297             $this->_JSON['error']   = $this->_JSON['message'];
 298             unset($this->_JSON['message']);
 299         }
 300
 301         if ($this->_isAjaxPage && $this->_isSuccess) {
 302             $this->addJSON('_title', $this->getHeader()->getTitleTag());
 303
 304             $menuHash = $this->getHeader()->getMenu()->getHash();
 305             $this->addJSON('_menuHash', $menuHash);
 306             $hashes = array();
 307             if (isset($_REQUEST['menuHashes'])) {
 308                 $hashes = explode('-', $_REQUEST['menuHashes']);
 309             }
 310             if (! in_array($menuHash, $hashes)) {
 311                 $this->addJSON('_menu', $this->getHeader()->getMenu()->getDisplay());
 312             }
 313
 314             $this->addJSON('_scripts', $this->getHeader()->getScripts()->getFiles());
 315             $this->addJSON('_selflink', $this->getFooter()->getSelfUrl('unencoded'));
 316             $this->addJSON('_displayMessage', $this->getHeader()->getMessage());
 317             $errors = $this->_footer->getErrorMessages();
 318             if (strlen($errors)) {
 319                 $this->addJSON('_errors', $errors);
 320             }
 321             if (empty($GLOBALS['error_message'])) {
 322                 // set current db, table and sql query in the querywindow
 323                 $query = '';
 324                 if (isset($GLOBALS['sql_query'])
 325                     && strlen($GLOBALS['sql_query']) < $GLOBALS['cfg']['MaxCharactersInDisplayedSQL']
 326                 ) {
 327                     $query = PMA_escapeJsString($GLOBALS['sql_query']);
 328                 }
 329                 $this->addJSON(
 330                     '_reloadQuerywindow',
 331                     array(
 332                         'db' => PMA_ifSetOr($GLOBALS['db'], ''),
 333                         'table' => PMA_ifSetOr($GLOBALS['table'], ''),
 334                         'sql_query' => $query
 335                     )
 336                 );
 337                 if (! empty($GLOBALS['focus_querywindow'])) {
 338                     $this->addJSON('_focusQuerywindow', $query);
 339                 }
 340                 if (! empty($GLOBALS['reload'])) {
 341                     $this->addJSON('_reloadNavigation', 1);
 342                 }
 343                 $this->addJSON('_params', $this->getHeader()->getJsParams());
 344             }
 345         }
 346
 347         // Set the Content-Type header to JSON so that jQuery parses the
 348         // response correctly.
 349         if (! defined('TESTSUITE')) {
 350             header('Cache-Control: no-cache');
 351             header('Content-Type: application/json');
 352         }
 353
 354         echo json_encode($this->_JSON);
 355     }
 356
 357     /**
 358      * Sends an HTML response to the browser
 359      *
 360      * @static
 361      * @return void
 362      */
 363     public static function response()
 364     {
 365         $response = PMA_Response::getInstance();
 366         chdir($response->getCWD());
 367         $buffer = PMA_OutputBuffering::getInstance();
 368         if (empty($response->_HTML)) {
 369             $response->_HTML = $buffer->getContents();
 370         }
 371         if ($response->isAjax()) {
 372             $response->_ajaxResponse();
 373         } else {
 374             $response->_htmlResponse();
 375         }
 376         $buffer->flush();
 377         exit;
 378     }
 379 }
 380
 381 ?>