phpmyadmin/libraries/Footer.class.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * Used to render the footer of PMA's pages
   5  *
   6  * @package PhpMyAdmin
   7  */
   8 if (! defined('PHPMYADMIN')) {
   9     exit;
  10 }
  11
  12 require_once 'libraries/Scripts.class.php';
  13
  14 /**
  15  * Class used to output the footer
  16  *
  17  * @package PhpMyAdmin
  18  */
  19 class PMA_Footer
  20 {
  21     /**
  22      * PMA_Scripts instance
  23      *
  24      * @access private
  25      * @var PMA_Scripts
  26      */
  27     private $_scripts;
  28     /**
  29      * Whether we are servicing an ajax request.
  30      * We can't simply use $GLOBALS['is_ajax_request']
  31      * here since it may have not been initialised yet.
  32      *
  33      * @access private
  34      * @var bool
  35      */
  36     private $_isAjax;
  37     /**
  38      * Whether to only close the BODY and HTML tags
  39      * or also include scripts, errors and links
  40      *
  41      * @access private
  42      * @var bool
  43      */
  44     private $_isMinimal;
  45     /**
  46      * Whether to display anything
  47      *
  48      * @access private
  49      * @var bool
  50      */
  51     private $_isEnabled;
  52
  53     /**
  54      * Creates a new class instance
  55      */
  56     public function __construct()
  57     {
  58         $this->_isEnabled = true;
  59         $this->_scripts   = new PMA_Scripts();
  60         $this->_isMinimal = false;
  61     }
  62
  63     /**
  64      * Returns the message for demo server to error messages
  65      *
  66      * @return string
  67      */
  68     private function _getDemoMessage()
  69     {
  70         $message = '<a href="/">' . __('phpMyAdmin Demo Server') . '</a>: ';
  71         if (file_exists('./revision-info.php')) {
  72             include './revision-info.php';
  73             $message .= sprintf(
  74                 __('Currently running Git revision %1$s from the %2$s branch.'),
  75                 '<a target="_blank" href="' . $repobase . $fullrevision . '">'
  76                 . $revision . '</a>',
  77                 '<a target="_blank" href="' . $repobranchbase . $branch . '">'
  78                 . $branch . '</a>'
  79             );
  80         } else {
  81             $message .= __('Git information missing!');
  82         }
  83
  84         return PMA_Message::notice($message)->getDisplay();
  85     }
  86
  87     /**
  88      * Remove recursions and iterator objects from an object
  89      *
  90      * @param object|array &$object Object to clean
  91      * @param array        $stack   Stack used to keep track of recursion,
  92      *                              need not be passed for the first time
  93      *
  94      * @return object Reference passed object
  95      */
  96     private static function _removeRecursion(&$object, $stack = array())
  97     {
  98         if ((is_object($object) || is_array($object)) && $object) {
  99             if ($object instanceof Traversable) {
 100                 $object = "***ITERATOR***";
 101             } else if (!in_array($object, $stack, true)) {
 102                 $stack[] = $object;
 103                 foreach ($object as &$subobject) {
 104                     self::_removeRecursion($subobject, $stack);
 105                 }
 106             } else {
 107                 $object = "***RECURSION***";
 108             }
 109         }
 110         return $object;
 111     }
 112
 113     /**
 114      * Renders the debug messages
 115      *
 116      * @return string
 117      */
 118     public function getDebugMessage()
 119     {
 120         $retval = '\'null\'';
 121         if ($GLOBALS['cfg']['DBG']['sql']
 122             && empty($_REQUEST['no_debug'])
 123             && !empty($_SESSION['debug'])
 124         ) {
 125             // Remove recursions and iterators from $_SESSION['debug']
 126             self::_removeRecursion($_SESSION['debug']);
 127
 128             $retval = JSON_encode($_SESSION['debug']);
 129             $_SESSION['debug'] = array();
 130             return json_last_error() ? '\'false\'' : $retval;
 131         }
 132         $_SESSION['debug'] = array();
 133         return $retval;
 134     }
 135
 136     /**
 137      * Returns the url of the current page
 138      *
 139      * @param string|null $encode See PMA_URL_getCommon()
 140      *
 141      * @return string
 142      */
 143     public function getSelfUrl($encode = 'html')
 144     {
 145         $db = ! empty($GLOBALS['db']) ? $GLOBALS['db'] : '';
 146         $table = ! empty($GLOBALS['table']) ? $GLOBALS['table'] : '';
 147         $target = ! empty($_REQUEST['target']) ? $_REQUEST['target'] : '';
 148         $params = array(
 149             'db' => $db,
 150             'table' => $table,
 151             'server' => $GLOBALS['server'],
 152             'target' => $target
 153         );
 154         // needed for server privileges tabs
 155         if (isset($_REQUEST['viewing_mode'])
 156             && in_array($_REQUEST['viewing_mode'], array('server', 'db', 'table'))
 157         ) {
 158             $params['viewing_mode'] = $_REQUEST['viewing_mode'];
 159         }
 160         /*
 161          * @todo    coming from server_privileges.php, here $db is not set,
 162          *          add the following condition below when that is fixed
 163          *          && $_REQUEST['checkprivsdb'] == $db
 164          */
 165         if (isset($_REQUEST['checkprivsdb'])
 166         ) {
 167             $params['checkprivsdb'] = $_REQUEST['checkprivsdb'];
 168         }
 169         /*
 170          * @todo    coming from server_privileges.php, here $table is not set,
 171          *          add the following condition below when that is fixed
 172          *          && $_REQUEST['checkprivstable'] == $table
 173          */
 174         if (isset($_REQUEST['checkprivstable'])
 175         ) {
 176             $params['checkprivstable'] = $_REQUEST['checkprivstable'];
 177         }
 178         if (isset($_REQUEST['single_table'])
 179             && in_array($_REQUEST['single_table'], array(true, false))
 180         ) {
 181             $params['single_table'] = $_REQUEST['single_table'];
 182         }
 183         return basename(PMA_getenv('SCRIPT_NAME')) . PMA_URL_getCommon(
 184             $params,
 185             $encode
 186         );
 187     }
 188
 189     /**
 190      * Renders the link to open a new page
 191      *
 192      * @param string $url The url of the page
 193      *
 194      * @return string
 195      */
 196     private function _getSelfLink($url)
 197     {
 198         $retval  = '';
 199         $retval .= '<div id="selflink" class="print_ignore">';
 200         $retval .= '<a href="' . $url . '"'
 201             . ' title="' . __('Open new phpMyAdmin window') . '" target="_blank">';
 202         if (PMA_Util::showIcons('TabsMode')) {
 203             $retval .= PMA_Util::getImage(
 204                 'window-new.png',
 205                 __('Open new phpMyAdmin window')
 206             );
 207         } else {
 208             $retval .=  __('Open new phpMyAdmin window');
 209         }
 210         $retval .= '</a>';
 211         $retval .= '</div>';
 212         return $retval;
 213     }
 214
 215     /**
 216      * Renders the link to open a new page
 217      *
 218      * @return string
 219      */
 220     public function getErrorMessages()
 221     {
 222         $retval = '<div class="clearfloat" id="pma_errors">';
 223         if ($GLOBALS['error_handler']->hasDisplayErrors()) {
 224             $retval .= $GLOBALS['error_handler']->getDispErrors();
 225         }
 226         $retval .= '</div>';
 227
 228         /**
 229          * Report php errors
 230          */
 231         $GLOBALS['error_handler']->reportErrors();
 232
 233         return $retval;
 234     }
 235
 236     /**
 237      * Saves query in history
 238      *
 239      * @return void
 240      */
 241     private function _setHistory()
 242     {
 243         if (! PMA_isValid($_REQUEST['no_history'])
 244             && empty($GLOBALS['error_message'])
 245             && ! empty($GLOBALS['sql_query'])
 246         ) {
 247             PMA_setHistory(
 248                 PMA_ifSetOr($GLOBALS['db'], ''),
 249                 PMA_ifSetOr($GLOBALS['table'], ''),
 250                 $GLOBALS['cfg']['Server']['user'],
 251                 $GLOBALS['sql_query']
 252             );
 253         }
 254     }
 255
 256     /**
 257      * Disables the rendering of the footer
 258      *
 259      * @return void
 260      */
 261     public function disable()
 262     {
 263         $this->_isEnabled = false;
 264     }
 265
 266     /**
 267      * Set the ajax flag to indicate whether
 268      * we are servicing an ajax request
 269      *
 270      * @param bool $isAjax Whether we are servicing an ajax request
 271      *
 272      * @return void
 273      */
 274     public function setAjax($isAjax)
 275     {
 276         $this->_isAjax = !!$isAjax;
 277     }
 278
 279     /**
 280      * Turn on minimal display mode
 281      *
 282      * @return void
 283      */
 284     public function setMinimal()
 285     {
 286         $this->_isMinimal = true;
 287     }
 288
 289     /**
 290      * Returns the PMA_Scripts object
 291      *
 292      * @return PMA_Scripts object
 293      */
 294     public function getScripts()
 295     {
 296         return $this->_scripts;
 297     }
 298
 299     /**
 300      * Renders the footer
 301      *
 302      * @return string
 303      */
 304     public function getDisplay()
 305     {
 306         $retval = '';
 307         $this->_setHistory();
 308         if ($this->_isEnabled) {
 309             if (! $this->_isAjax) {
 310                 $retval .= "</div>";
 311             }
 312             if (! $this->_isAjax && ! $this->_isMinimal) {
 313                 if (PMA_getenv('SCRIPT_NAME')
 314                     && empty($_POST)
 315                     && empty($GLOBALS['checked_special'])
 316                     && ! $this->_isAjax
 317                 ) {
 318                     $url = $this->getSelfUrl('unencoded');
 319                     $header = PMA_Response::getInstance()->getHeader();
 320                     $scripts = $header->getScripts()->getFiles();
 321                     $menuHash = $header->getMenu()->getHash();
 322                     // prime the client-side cache
 323                     $this->_scripts->addCode(
 324                         sprintf(
 325                             'if (! (history && history.pushState)) '
 326                             . 'PMA_MicroHistory.primer = {'
 327                             . ' url: "%s",'
 328                             . ' scripts: %s,'
 329                             . ' menuHash: "%s"'
 330                             . '};',
 331                             PMA_escapeJsString($url),
 332                             json_encode($scripts),
 333                             PMA_escapeJsString($menuHash)
 334                         )
 335                     );
 336                 }
 337                 if (PMA_getenv('SCRIPT_NAME')
 338                     && ! $this->_isAjax
 339                 ) {
 340                     $url = $this->getSelfUrl();
 341                     $retval .= $this->_getSelfLink($url);
 342                 }
 343                 $this->_scripts->addCode(
 344                     'var debugSQLInfo = ' . $this->getDebugMessage() . ';'
 345                 );
 346                 $retval .= $this->getErrorMessages();
 347                 $retval .= $this->_scripts->getDisplay();
 348                 if ($GLOBALS['cfg']['DBG']['demo']) {
 349                     $retval .= '<div id="pma_demo">';
 350                     $retval .= $this->_getDemoMessage();
 351                     $retval .= '</div>';
 352                 }
 353                 // Include possible custom footers
 354                 if (file_exists(CUSTOM_FOOTER_FILE)) {
 355                     $retval .= '<div id="pma_footer">';
 356                     ob_start();
 357                     include CUSTOM_FOOTER_FILE;
 358                     $retval .= ob_get_contents();
 359                     ob_end_clean();
 360                     $retval .= '</div>';
 361                 }
 362             }
 363             if (! $this->_isAjax) {
 364                 $retval .= "</body></html>";
 365             }
 366         }
 367
 368         return $retval;
 369     }
 370 }