src/BrowseForeigners.php

   1 <?php
   2 /**
   3  * Contains functions used by browse foreigners
   4  */
   5
   6 declare(strict_types=1);
   7
   8 namespace PhpMyAdmin;
   9
  10 use PhpMyAdmin\Config\Settings;
  11 use PhpMyAdmin\Theme\ThemeManager;
  12
  13 use function __;
  14 use function array_keys;
  15 use function asort;
  16 use function ceil;
  17 use function floor;
  18 use function htmlspecialchars;
  19 use function is_array;
  20 use function mb_strlen;
  21 use function mb_substr;
  22
  23 /**
  24  * PhpMyAdmin\BrowseForeigners class
  25  */
  26 class BrowseForeigners
  27 {
  28     private Settings $settings;
  29
  30     public function __construct(public Template $template, Config $config, private readonly ThemeManager $themeManager)
  31     {
  32         $this->settings = $config->getSettings();
  33     }
  34
  35     /**
  36      * Function to get html for one relational key
  37      *
  38      * @param int     $horizontalCount    the current horizontal count
  39      * @param string  $header             table header
  40      * @param mixed[] $keys               all the keys
  41      * @param int     $indexByKeyname     index by keyname
  42      * @param mixed[] $descriptions       descriptions
  43      * @param int     $indexByDescription index by description
  44      * @param string  $currentValue       current value on the edit form
  45      *
  46      * @return array{string, int, int} the generated html
  47      */
  48     private function getHtmlForOneKey(
  49         int $horizontalCount,
  50         string $header,
  51         array $keys,
  52         int $indexByKeyname,
  53         array $descriptions,
  54         int $indexByDescription,
  55         string $currentValue,
  56     ): array {
  57         $horizontalCount++;
  58         $output = '';
  59
  60         // whether the key name corresponds to the selected value in the form
  61         $rightKeynameIsSelected = false;
  62         $leftKeynameIsSelected = false;
  63
  64         if ($this->settings->repeatCells > 0 && $horizontalCount > $this->settings->repeatCells) {
  65             $output .= $header;
  66             $horizontalCount = 0;
  67         }
  68
  69         // key names and descriptions for the left section,
  70         // sorted by key names
  71         $leftKeyname = $keys[$indexByKeyname];
  72         [$leftDescription, $leftDescriptionTitle] = $this->getDescriptionAndTitle($descriptions[$indexByKeyname]);
  73
  74         // key names and descriptions for the right section,
  75         // sorted by descriptions
  76         $rightKeyname = $keys[$indexByDescription];
  77         [
  78             $rightDescription,
  79             $rightDescriptionTitle,
  80         ] = $this->getDescriptionAndTitle($descriptions[$indexByDescription]);
  81
  82         $indexByDescription++;
  83
  84         if ($currentValue !== '') {
  85             $rightKeynameIsSelected = $rightKeyname == $currentValue;
  86             $leftKeynameIsSelected = $leftKeyname == $currentValue;
  87         }
  88
  89         $output .= '<tr class="noclick">';
  90
  91         $output .= $this->template->render('table/browse_foreigners/column_element', [
  92             'keyname' => $leftKeyname,
  93             'description' => $leftDescription,
  94             'title' => $leftDescriptionTitle,
  95             'is_selected' => $leftKeynameIsSelected,
  96             'nowrap' => true,
  97         ]);
  98         $output .= $this->template->render('table/browse_foreigners/column_element', [
  99             'keyname' => $leftKeyname,
 100             'description' => $leftDescription,
 101             'title' => $leftDescriptionTitle,
 102             'is_selected' => $leftKeynameIsSelected,
 103             'nowrap' => false,
 104         ]);
 105
 106         $output .= '<td width="20%"><img src="'
 107             . $this->themeManager->theme->getImgPath('spacer.png')
 108             . '" alt="" width="1" height="1"></td>';
 109
 110         $output .= $this->template->render('table/browse_foreigners/column_element', [
 111             'keyname' => $rightKeyname,
 112             'description' => $rightDescription,
 113             'title' => $rightDescriptionTitle,
 114             'is_selected' => $rightKeynameIsSelected,
 115             'nowrap' => false,
 116         ]);
 117         $output .= $this->template->render('table/browse_foreigners/column_element', [
 118             'keyname' => $rightKeyname,
 119             'description' => $rightDescription,
 120             'title' => $rightDescriptionTitle,
 121             'is_selected' => $rightKeynameIsSelected,
 122             'nowrap' => true,
 123         ]);
 124
 125         $output .= '</tr>';
 126
 127         return [$output, $horizontalCount, $indexByDescription];
 128     }
 129
 130     /**
 131      * Function to get html for relational field selection
 132      *
 133      * @param string      $db           current database
 134      * @param string      $table        current table
 135      * @param string      $field        field
 136      * @param mixed[]     $foreignData  foreign column data
 137      * @param string|null $fieldKey     field key
 138      * @param string      $currentValue current columns's value
 139      */
 140     public function getHtmlForRelationalFieldSelection(
 141         string $db,
 142         string $table,
 143         string $field,
 144         array $foreignData,
 145         string|null $fieldKey,
 146         string $currentValue,
 147     ): string {
 148         $gotoPage = $this->getHtmlForGotoPage($foreignData);
 149         $foreignShowAll = $this->template->render('table/browse_foreigners/show_all', [
 150             'foreign_data' => $foreignData,
 151             'show_all' => $this->settings->showAll,
 152             'max_rows' => $this->settings->maxRows,
 153         ]);
 154
 155         $output = '<form class="ajax" '
 156             . 'id="browse_foreign_form" name="browse_foreign_from" action="'
 157             . Url::getFromRoute('/browse-foreigners')
 158             . '" method="post"><fieldset class="row g-3 align-items-center mb-3">' . "\n"
 159             . Url::getHiddenInputs($db, $table) . "\n"
 160             . '<input type="hidden" name="field" value="' . htmlspecialchars($field) . '">' . "\n"
 161             . '<input type="hidden" name="fieldkey" value="'
 162             . (isset($fieldKey) ? htmlspecialchars($fieldKey) : '') . '">' . "\n";
 163
 164         if (isset($_POST['rownumber'])) {
 165             $output .= '<input type="hidden" name="rownumber" value="'
 166                 . htmlspecialchars((string) $_POST['rownumber']) . '">';
 167         }
 168
 169         $filterValue = isset($_POST['foreign_filter'])
 170             ? htmlspecialchars($_POST['foreign_filter'])
 171             : '';
 172         $output .= '<div class="col-auto">'
 173             . '<label class="form-label" for="input_foreign_filter">' . __('Search:') . '</label></div>' . "\n"
 174             . '<div class="col-auto"><input class="form-control" type="text" name="foreign_filter" '
 175             . 'id="input_foreign_filter" '
 176             . 'value="' . $filterValue . '" data-old="' . $filterValue . '">' . "\n"
 177             . '</div><div class="col-auto">'
 178             . '<input class="btn btn-primary" type="submit" name="submit_foreign_filter" value="'
 179             . __('Go') . '">'
 180             . '</div>' . "\n"
 181             . '<div class="col-auto">' . $gotoPage . '</div>'
 182             . '<div class="col-auto">' . $foreignShowAll . '</div>'
 183             . '</fieldset>'
 184             . '</form>' . "\n";
 185
 186         $output .= '<table class="table table-striped table-hover" id="browse_foreign_table">' . "\n";
 187
 188         if (! is_array($foreignData['disp_row'])) {
 189             return $output . '</tbody>'
 190                 . '</table>';
 191         }
 192
 193         $header = '<tr>
 194             <th>' . __('Keyname') . '</th>
 195             <th>' . __('Description') . '</th>
 196             <td width="20%"></td>
 197             <th>' . __('Description') . '</th>
 198             <th>' . __('Keyname') . '</th>
 199         </tr>' . "\n";
 200
 201         $output .= '<thead>' . $header . '</thead>' . "\n"
 202             . '<tfoot>' . $header . '</tfoot>' . "\n"
 203             . '<tbody>' . "\n";
 204
 205         $descriptions = [];
 206         $keys = [];
 207         foreach ($foreignData['disp_row'] as $relrow) {
 208             if ($foreignData['foreign_display'] != false) {
 209                 $descriptions[] = $relrow[$foreignData['foreign_display']] ?? '';
 210             } else {
 211                 $descriptions[] = '';
 212             }
 213
 214             $keys[] = $relrow[$foreignData['foreign_field']];
 215         }
 216
 217         asort($keys);
 218
 219         $horizontalCount = 0;
 220         $indexByDescription = 0;
 221
 222         foreach (array_keys($keys) as $indexByKeyname) {
 223             [$html, $horizontalCount, $indexByDescription] = $this->getHtmlForOneKey(
 224                 $horizontalCount,
 225                 $header,
 226                 $keys,
 227                 $indexByKeyname,
 228                 $descriptions,
 229                 $indexByDescription,
 230                 $currentValue,
 231             );
 232             $output .= $html . "\n";
 233         }
 234
 235         $output .= '</tbody></table>';
 236
 237         return $output;
 238     }
 239
 240     /**
 241      * Get the description (possibly truncated) and the title
 242      *
 243      * @param string $description the key name's description
 244      *
 245      * @return array<int,string> the new description and title
 246      */
 247     private function getDescriptionAndTitle(string $description): array
 248     {
 249         if (mb_strlen($description) <= $this->settings->limitChars) {
 250             $descriptionTitle = '';
 251         } else {
 252             $descriptionTitle = $description;
 253             $description = mb_substr($description, 0, $this->settings->limitChars) . '...';
 254         }
 255
 256         return [$description, $descriptionTitle];
 257     }
 258
 259     /**
 260      * Function to get html for the goto page option
 261      *
 262      * @param mixed[]|null $foreignData foreign data
 263      */
 264     private function getHtmlForGotoPage(array|null $foreignData): string
 265     {
 266         isset($_POST['pos']) ? $pos = $_POST['pos'] : $pos = 0;
 267         if ($foreignData === null || ! is_array($foreignData['disp_row'])) {
 268             return '';
 269         }
 270
 271         $pageNow = (int) floor($pos / $this->settings->maxRows) + 1;
 272         $nbTotalPage = (int) ceil($foreignData['the_total'] / $this->settings->maxRows);
 273
 274         if ($foreignData['the_total'] > $this->settings->maxRows) {
 275             return Util::pageselector(
 276                 'pos',
 277                 $this->settings->maxRows,
 278                 $pageNow,
 279                 $nbTotalPage,
 280                 200,
 281                 5,
 282                 5,
 283                 20,
 284                 10,
 285                 __('Page number:'),
 286             );
 287         }
 288
 289         return '';
 290     }
 291
 292     /**
 293      * Function to get foreign limit
 294      *
 295      * @param string|null $foreignShowAll foreign navigation
 296      */
 297     public function getForeignLimit(string|null $foreignShowAll): string|null
 298     {
 299         if ($foreignShowAll === __('Show all')) {
 300             return null;
 301         }
 302
 303         isset($_POST['pos']) ? $pos = $_POST['pos'] : $pos = 0;
 304
 305         return 'LIMIT ' . $pos . ', ' . $this->settings->maxRows . ' ';
 306     }
 307 }