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