src/Console.php

   1 <?php
   2 /**
   3  * Used to render the console of PMA's pages
   4  */
   5
   6 declare(strict_types=1);
   7
   8 namespace PhpMyAdmin;
   9
  10 use PhpMyAdmin\Bookmarks\BookmarkRepository;
  11 use PhpMyAdmin\ConfigStorage\Relation;
  12
  13 use function __;
  14 use function _ngettext;
  15 use function count;
  16 use function sprintf;
  17
  18 /**
  19  * Class used to output the console
  20  */
  21 class Console
  22 {
  23     /**
  24      * Whether to display anything
  25      */
  26     private bool $isEnabled = true;
  27
  28     /**
  29      * Whether we are servicing an ajax request.
  30      */
  31     private bool $isAjax = false;
  32     private readonly Config $config;
  33
  34     public function __construct(
  35         private readonly Relation $relation,
  36         private readonly Template $template,
  37         private readonly BookmarkRepository $bookmarkRepository,
  38     ) {
  39         $this->config = Config::getInstance();
  40     }
  41
  42     /**
  43      * Set the ajax flag to indicate whether
  44      * we are servicing an ajax request
  45      *
  46      * @param bool $isAjax Whether we are servicing an ajax request
  47      */
  48     public function setAjax(bool $isAjax): void
  49     {
  50         $this->isAjax = $isAjax;
  51     }
  52
  53     /**
  54      * Disables the rendering of the footer
  55      */
  56     public function disable(): void
  57     {
  58         $this->isEnabled = false;
  59     }
  60
  61     /**
  62      * Renders the bookmark content
  63      */
  64     public function getBookmarkContent(): string
  65     {
  66         $bookmarkFeature = $this->relation->getRelationParameters()->bookmarkFeature;
  67         if ($bookmarkFeature === null) {
  68             return '';
  69         }
  70
  71         $bookmarks = $this->bookmarkRepository->getList($this->config->selectedServer['user']);
  72         $countBookmarks = count($bookmarks);
  73         if ($countBookmarks > 0) {
  74             $welcomeMessage = sprintf(
  75                 _ngettext(
  76                     'Showing %1$d bookmark (both private and shared)',
  77                     'Showing %1$d bookmarks (both private and shared)',
  78                     $countBookmarks,
  79                 ),
  80                 $countBookmarks,
  81             );
  82         } else {
  83             $welcomeMessage = __('No bookmarks');
  84         }
  85
  86         return $this->template->render('console/bookmark_content', [
  87             'welcome_message' => $welcomeMessage,
  88             'bookmarks' => $bookmarks,
  89         ]);
  90     }
  91
  92     /**
  93      * Returns the list of JS scripts required by console
  94      *
  95      * @return string[] list of scripts
  96      */
  97     public function getScripts(): array
  98     {
  99         return ['console.js'];
 100     }
 101
 102     /**
 103      * Renders the console
 104      */
 105     public function getDisplay(): string
 106     {
 107         if ($this->isAjax || ! $this->isEnabled) {
 108             return '';
 109         }
 110
 111         $bookmarkFeature = $this->relation->getRelationParameters()->bookmarkFeature;
 112         $sqlHistory = $this->relation->getHistory($this->config->selectedServer['user']);
 113         $bookmarkContent = $this->getBookmarkContent();
 114
 115         return $this->template->render('console/display', [
 116             'settings' => $this->config->config->Console->asArray(),
 117             'has_bookmark_feature' => $bookmarkFeature !== null,
 118             'sql_history' => $sqlHistory,
 119             'bookmark_content' => $bookmarkContent,
 120             'debug' => $this->config->config->debug->sql,
 121         ]);
 122     }
 123 }