libraries/config.values.php

   1 <?php
   2 /**
   3  * Database with allowed values for configuration stored in the $cfg array,
   4  * used by setup script and user preferences to generate forms.
   5  */
   6 declare(strict_types=1);
   7
   8 if (! defined('PHPMYADMIN')) {
   9     exit;
  10 }
  11
  12 /**
  13  * Value meaning:
  14  * o array - select field, array contains allowed values
  15  * o string - type override
  16  *
  17  * Use normal array, paths won't be expanded
  18  */
  19 return [
  20     'Servers' => [
  21         1 => [
  22             'port' => 'integer',
  23             'auth_type' => [
  24                 'config',
  25                 'http',
  26                 'signon',
  27                 'cookie',
  28             ],
  29             'AllowDeny' => [
  30                 'order' => [
  31                     '',
  32                     'deny,allow',
  33                     'allow,deny',
  34                     'explicit',
  35                 ],
  36             ],
  37             'only_db' => 'array',
  38         ],
  39     ],
  40     'RecodingEngine' => [
  41         'auto',
  42         'iconv',
  43         'recode',
  44         'mb',
  45         'none',
  46     ],
  47     'OBGzip' => [
  48         'auto',
  49         true,
  50         false,
  51     ],
  52     'MemoryLimit' => 'short_string',
  53     'NavigationLogoLinkWindow' => [
  54         'main',
  55         'new',
  56     ],
  57     'NavigationTreeDefaultTabTable' => [
  58         // fields list
  59         'structure' => __('Structure'),
  60         // SQL form
  61         'sql' => __('SQL'),
  62         // search page
  63         'search' => __('Search'),
  64         // insert row page
  65         'insert' => __('Insert'),
  66         // browse page
  67         'browse' => __('Browse'),
  68     ],
  69     'NavigationTreeDefaultTabTable2' => [
  70         //don't display
  71         '' => '',
  72         // fields list
  73         'structure' => __('Structure'),
  74         // SQL form
  75         'sql' => __('SQL'),
  76         // search page
  77         'search' => __('Search'),
  78         // insert row page
  79         'insert' => __('Insert'),
  80         // browse page
  81         'browse' => __('Browse'),
  82     ],
  83     'NavigationTreeDbSeparator' => 'short_string',
  84     'NavigationTreeTableSeparator' => 'short_string',
  85     'NavigationWidth' => 'integer',
  86     'TableNavigationLinksMode' => [
  87         'icons' => __('Icons'),
  88         'text' => __('Text'),
  89         'both' => __('Both'),
  90     ],
  91     'MaxRows' => [
  92         25,
  93         50,
  94         100,
  95         250,
  96         500,
  97     ],
  98     'Order' => [
  99         'ASC',
 100         'DESC',
 101         'SMART',
 102     ],
 103     'RowActionLinks' => [
 104         'none' => __('Nowhere'),
 105         'left' => __('Left'),
 106         'right' => __('Right'),
 107         'both' => __('Both'),
 108     ],
 109     'TablePrimaryKeyOrder' => [
 110         'NONE' => __('None'),
 111         'ASC' => __('Ascending'),
 112         'DESC' => __('Descending'),
 113     ],
 114     'ProtectBinary' => [
 115         false,
 116         'blob',
 117         'noblob',
 118         'all',
 119     ],
 120     'CharEditing' => [
 121         'input',
 122         'textarea',
 123     ],
 124     'TabsMode' => [
 125         'icons' => __('Icons'),
 126         'text' => __('Text'),
 127         'both' => __('Both'),
 128     ],
 129     'PDFDefaultPageSize' => [
 130         'A3' => 'A3',
 131         'A4' => 'A4',
 132         'A5' => 'A5',
 133         'letter' => 'letter',
 134         'legal' => 'legal',
 135     ],
 136     'ActionLinksMode' => [
 137         'icons' => __('Icons'),
 138         'text' => __('Text'),
 139         'both' => __('Both'),
 140     ],
 141     'GridEditing' => [
 142         'click' => __('Click'),
 143         'double-click' => __('Double click'),
 144         'disabled' => __('Disabled'),
 145     ],
 146     'RelationalDisplay' => [
 147         'K' => __('key'),
 148         'D' => __('display column'),
 149     ],
 150     'DefaultTabServer' => [
 151         // the welcome page (recommended for multiuser setups)
 152         'welcome' => __('Welcome'),
 153         // list of databases
 154         'databases' => __('Databases'),
 155         // runtime information
 156         'status' => __('Status'),
 157         // MySQL server variables
 158         'variables' => __('Variables'),
 159         // user management
 160         'privileges' => __('Privileges'),
 161     ],
 162     'DefaultTabDatabase' => [
 163         // tables list
 164         'structure' => __('Structure'),
 165         // SQL form
 166         'sql' => __('SQL'),
 167         // search query
 168         'search' => __('Search'),
 169         // operations on database
 170         'operations' => __('Operations'),
 171     ],
 172     'DefaultTabTable' => [
 173         // fields list
 174         'structure' => __('Structure'),
 175         // SQL form
 176         'sql' => __('SQL'),
 177         // search page
 178         'search' => __('Search'),
 179         // insert row page
 180         'insert' => __('Insert'),
 181         // browse page
 182         'browse' => __('Browse'),
 183     ],
 184     'InitialSlidersState' => [
 185         'open' => __('Open'),
 186         'closed' => __('Closed'),
 187         'disabled' => __('Disabled'),
 188     ],
 189     'FirstDayOfCalendar' => [
 190         '1' => __('Monday'),
 191         '2' => __('Tuesday'),
 192         '3' => __('Wednesday'),
 193         '4' => __('Thursday'),
 194         '5' => __('Friday'),
 195         '6' => __('Saturday'),
 196         '7' => __('Sunday'),
 197     ],
 198     'SendErrorReports' => [
 199         'ask' => __('Ask before sending error reports'),
 200         'always' => __('Always send error reports'),
 201         'never' => __('Never send error reports'),
 202     ],
 203     'DefaultForeignKeyChecks' => [
 204         'default' => __('Server default'),
 205         'enable' => __('Enable'),
 206         'disable' => __('Disable'),
 207     ],
 208
 209     'Import' => [
 210         'format' => [
 211             // CSV
 212             'csv',
 213             // DocSQL
 214             'docsql',
 215             // CSV using LOAD DATA
 216             'ldi',
 217             // SQL
 218             'sql',
 219         ],
 220         'charset' => array_merge(
 221             [''],
 222             $GLOBALS['cfg']['AvailableCharsets']
 223         ),
 224         'sql_compatibility' => [
 225             'NONE',
 226             'ANSI',
 227             'DB2',
 228             'MAXDB',
 229             'MYSQL323',
 230             'MYSQL40',
 231             'MSSQL',
 232             'ORACLE',
 233             // removed; in MySQL 5.0.33, this produces exports that
 234             // can't be read by POSTGRESQL (see our bug #1596328)
 235             //'POSTGRESQL',
 236             'TRADITIONAL',
 237         ],
 238         'csv_terminated' => 'short_string',
 239         'csv_enclosed' => 'short_string',
 240         'csv_escaped' => 'short_string',
 241         'ldi_terminated' => 'short_string',
 242         'ldi_enclosed' => 'short_string',
 243         'ldi_escaped' => 'short_string',
 244         'ldi_local_option' => [
 245             'auto',
 246             true,
 247             false,
 248         ],
 249     ],
 250
 251     'Export' => [
 252         '_sod_select' => [
 253             'structure' => __('structure'),
 254             'data' => __('data'),
 255             'structure_and_data' => __('structure and data'),
 256         ],
 257         'method' => [
 258             'quick' => __('Quick - display only the minimal options to configure'),
 259             'custom' => __('Custom - display all possible options to configure'),
 260             'custom-no-form' => __(
 261                 'Custom - like above, but without the quick/custom choice'
 262             ),
 263         ],
 264         'format' => [
 265             'codegen',
 266             'csv',
 267             'excel',
 268             'htmlexcel',
 269             'htmlword',
 270             'latex',
 271             'ods',
 272             'odt',
 273             'pdf',
 274             'sql',
 275             'texytext',
 276             'xml',
 277             'yaml',
 278         ],
 279         'compression' => [
 280             'none',
 281             'zip',
 282             'gzip',
 283         ],
 284         'charset' => array_merge(
 285             [''],
 286             $GLOBALS['cfg']['AvailableCharsets']
 287         ),
 288         'sql_compatibility' => [
 289             'NONE',
 290             'ANSI',
 291             'DB2',
 292             'MAXDB',
 293             'MYSQL323',
 294             'MYSQL40',
 295             'MSSQL',
 296             'ORACLE',
 297             // removed; in MySQL 5.0.33, this produces exports that
 298             // can't be read by POSTGRESQL (see our bug #1596328)
 299             //'POSTGRESQL',
 300             'TRADITIONAL',
 301         ],
 302         'codegen_format' => [
 303             '#',
 304             'NHibernate C# DO',
 305             'NHibernate XML',
 306         ],
 307         'csv_separator' => 'short_string',
 308         'csv_terminated' => 'short_string',
 309         'csv_enclosed' => 'short_string',
 310         'csv_escaped' => 'short_string',
 311         'csv_null' => 'short_string',
 312         'excel_null' => 'short_string',
 313         'excel_edition' => [
 314             'win' => 'Windows',
 315             'mac_excel2003' => 'Excel 2003 / Macintosh',
 316             'mac_excel2008' => 'Excel 2008 / Macintosh',
 317         ],
 318         'sql_structure_or_data' => [
 319             'structure' => __('structure'),
 320             'data' => __('data'),
 321             'structure_and_data' => __('structure and data'),
 322         ],
 323         'sql_type' => [
 324             'INSERT',
 325             'UPDATE',
 326             'REPLACE',
 327         ],
 328         'sql_insert_syntax' => [
 329             'complete' => __('complete inserts'),
 330             'extended' => __('extended inserts'),
 331             'both' => __('both of the above'),
 332             'none' => __('neither of the above'),
 333         ],
 334         'htmlword_structure_or_data' => [
 335             'structure' => __('structure'),
 336             'data' => __('data'),
 337             'structure_and_data' => __('structure and data'),
 338         ],
 339         'htmlword_null' => 'short_string',
 340         'ods_null' => 'short_string',
 341         'odt_null' => 'short_string',
 342         'odt_structure_or_data' => [
 343             'structure' => __('structure'),
 344             'data' => __('data'),
 345             'structure_and_data' => __('structure and data'),
 346         ],
 347         'texytext_structure_or_data' => [
 348             'structure' => __('structure'),
 349             'data' => __('data'),
 350             'structure_and_data' => __('structure and data'),
 351         ],
 352         'texytext_null' => 'short_string',
 353     ],
 354
 355     'Console' => [
 356         'Mode' => [
 357             'info',
 358             'show',
 359             'collapse',
 360         ],
 361         'OrderBy' => [
 362             'exec',
 363             'time',
 364             'count',
 365         ],
 366         'Order' => [
 367             'asc',
 368             'desc',
 369         ],
 370     ],
 371
 372     /**
 373      * Default values overrides
 374      * Use only full paths
 375      */
 376     '_overrides' => [],
 377
 378     /**
 379      * Basic validator assignments (functions from libraries/config/Validator.php
 380      * and 'validators' object in js/config.js)
 381      * Use only full paths and form ids
 382      */
 383     '_validators' => [
 384         'Console/Height' => 'validateNonNegativeNumber',
 385         'CharTextareaCols' => 'validatePositiveNumber',
 386         'CharTextareaRows' => 'validatePositiveNumber',
 387         'ExecTimeLimit' => 'validateNonNegativeNumber',
 388         'Export/sql_max_query_size' => 'validatePositiveNumber',
 389         'FirstLevelNavigationItems' => 'validatePositiveNumber',
 390         'ForeignKeyMaxLimit' => 'validatePositiveNumber',
 391         'Import/csv_enclosed' => [
 392             [
 393                 'validateByRegex',
 394                 '/^.?$/',
 395             ],
 396         ],
 397         'Import/csv_escaped' => [
 398             [
 399                 'validateByRegex',
 400                 '/^.$/',
 401             ],
 402         ],
 403         'Import/csv_terminated' => [
 404             [
 405                 'validateByRegex',
 406                 '/^.$/',
 407             ],
 408         ],
 409         'Import/ldi_enclosed' => [
 410             [
 411                 'validateByRegex',
 412                 '/^.?$/',
 413             ],
 414         ],
 415         'Import/ldi_escaped' => [
 416             [
 417                 'validateByRegex',
 418                 '/^.$/',
 419             ],
 420         ],
 421         'Import/ldi_terminated' => [
 422             [
 423                 'validateByRegex',
 424                 '/^.$/',
 425             ],
 426         ],
 427         'Import/skip_queries' => 'validateNonNegativeNumber',
 428         'InsertRows' => 'validatePositiveNumber',
 429         'NumRecentTables' => 'validateNonNegativeNumber',
 430         'NumFavoriteTables' => 'validateNonNegativeNumber',
 431         'LimitChars' => 'validatePositiveNumber',
 432         'LoginCookieValidity' => 'validatePositiveNumber',
 433         'LoginCookieStore' => 'validateNonNegativeNumber',
 434         'MaxDbList' => 'validatePositiveNumber',
 435         'MaxNavigationItems' => 'validatePositiveNumber',
 436         'MaxCharactersInDisplayedSQL' => 'validatePositiveNumber',
 437         'MaxRows' => 'validatePositiveNumber',
 438         'MaxSizeForInputField' => 'validatePositiveNumber',
 439         'MinSizeForInputField' => 'validateNonNegativeNumber',
 440         'MaxTableList' => 'validatePositiveNumber',
 441         'MemoryLimit' => [
 442             [
 443                 'validateByRegex',
 444                 '/^(-1|(\d+(?:[kmg])?))$/i',
 445             ],
 446         ],
 447         'NavigationTreeDisplayItemFilterMinimum' => 'validatePositiveNumber',
 448         'NavigationTreeTableLevel' => 'validatePositiveNumber',
 449         'NavigationWidth' => 'validateNonNegativeNumber',
 450         'QueryHistoryMax' => 'validatePositiveNumber',
 451         'RepeatCells' => 'validateNonNegativeNumber',
 452         'Server' => 'validateServer',
 453         'Server_pmadb' => 'validatePMAStorage',
 454         'Servers/1/port' => 'validatePortNumber',
 455         'Servers/1/hide_db' => 'validateRegex',
 456         'TextareaCols' => 'validatePositiveNumber',
 457         'TextareaRows' => 'validatePositiveNumber',
 458         'TrustedProxies' => 'validateTrustedProxies',
 459     ],
 460
 461     /**
 462      * Additional validators used for user preferences
 463      */
 464     '_userValidators' => [
 465         'MaxDbList' => [
 466             [
 467                 'validateUpperBound',
 468                 'value:MaxDbList',
 469             ],
 470         ],
 471         'MaxTableList' => [
 472             [
 473                 'validateUpperBound',
 474                 'value:MaxTableList',
 475             ],
 476         ],
 477         'QueryHistoryMax' => [
 478             [
 479                 'validateUpperBound',
 480                 'value:QueryHistoryMax',
 481             ],
 482         ],
 483     ],
 484 ];