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