includes/Defines.php

   1 <?php
   2 /**
   3  * A few constants that might be needed during LocalSettings.php.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  */
  22
  23 require_once __DIR__ . '/libs/mime/defines.php';
  24 require_once __DIR__ . '/libs/rdbms/defines.php';
  25
  26 use Wikimedia\Rdbms\IDatabase;
  27
  28 /**
  29  * @defgroup Constants MediaWiki constants
  30  */
  31
  32 # Obsolete aliases
  33
  34 /**@{
  35  * Obsolete IDatabase::makeList() constants
  36  * These are also available as Database class constants
  37  */
  38 define( 'LIST_COMMA', IDatabase::LIST_COMMA );
  39 define( 'LIST_AND', IDatabase::LIST_AND );
  40 define( 'LIST_SET', IDatabase::LIST_SET );
  41 define( 'LIST_NAMES', IDatabase::LIST_NAMES );
  42 define( 'LIST_OR', IDatabase::LIST_OR );
  43 /**@}*/
  44
  45 /**@{
  46  * Virtual namespaces; don't appear in the page database
  47  */
  48 define( 'NS_MEDIA', -2 );
  49 define( 'NS_SPECIAL', -1 );
  50 /**@}*/
  51
  52 /**@{
  53  * Real namespaces
  54  *
  55  * Number 100 and beyond are reserved for custom namespaces;
  56  * DO NOT assign standard namespaces at 100 or beyond.
  57  * DO NOT Change integer values as they are most probably hardcoded everywhere
  58  * see T2696 which talked about that.
  59  */
  60 define( 'NS_MAIN', 0 );
  61 define( 'NS_TALK', 1 );
  62 define( 'NS_USER', 2 );
  63 define( 'NS_USER_TALK', 3 );
  64 define( 'NS_PROJECT', 4 );
  65 define( 'NS_PROJECT_TALK', 5 );
  66 define( 'NS_FILE', 6 );
  67 define( 'NS_FILE_TALK', 7 );
  68 define( 'NS_MEDIAWIKI', 8 );
  69 define( 'NS_MEDIAWIKI_TALK', 9 );
  70 define( 'NS_TEMPLATE', 10 );
  71 define( 'NS_TEMPLATE_TALK', 11 );
  72 define( 'NS_HELP', 12 );
  73 define( 'NS_HELP_TALK', 13 );
  74 define( 'NS_CATEGORY', 14 );
  75 define( 'NS_CATEGORY_TALK', 15 );
  76 /**@}*/
  77
  78 /**@{
  79  * Cache type
  80  */
  81 define( 'CACHE_ANYTHING', -1 );  // Use anything, as long as it works
  82 define( 'CACHE_NONE', 0 );       // Do not cache
  83 define( 'CACHE_DB', 1 );         // Store cache objects in the DB
  84 define( 'CACHE_MEMCACHED', 2 );  // MemCached, must specify servers in $wgMemCacheServers
  85 define( 'CACHE_ACCEL', 3 );      // APC or WinCache
  86 /**@}*/
  87
  88 /**@{
  89  * Antivirus result codes, for use in $wgAntivirusSetup.
  90  */
  91 define( 'AV_NO_VIRUS', 0 );  # scan ok, no virus found
  92 define( 'AV_VIRUS_FOUND', 1 );  # virus found!
  93 define( 'AV_SCAN_ABORTED', -1 );  # scan aborted, the file is probably immune
  94 define( 'AV_SCAN_FAILED', false );  # scan failed (scanner not found or error in scanner)
  95 /**@}*/
  96
  97 /**@{
  98  * Anti-lock flags
  99  * Was used by $wgAntiLockFlags, which was removed with 1.25
 100  * Constants kept to not have warnings when used in LocalSettings
 101  */
 102 define( 'ALF_PRELOAD_LINKS', 1 ); // unused
 103 define( 'ALF_PRELOAD_EXISTENCE', 2 ); // unused
 104 define( 'ALF_NO_LINK_LOCK', 4 ); // unused
 105 define( 'ALF_NO_BLOCK_LOCK', 8 ); // unused
 106 /**@}*/
 107
 108 /**@{
 109  * Date format selectors; used in user preference storage and by
 110  * Language::date() and co.
 111  */
 112 define( 'MW_DATE_DEFAULT', 'default' );
 113 define( 'MW_DATE_MDY', 'mdy' );
 114 define( 'MW_DATE_DMY', 'dmy' );
 115 define( 'MW_DATE_YMD', 'ymd' );
 116 define( 'MW_DATE_ISO', 'ISO 8601' );
 117 /**@}*/
 118
 119 /**@{
 120  * RecentChange type identifiers
 121  */
 122 define( 'RC_EDIT', 0 );
 123 define( 'RC_NEW', 1 );
 124 define( 'RC_LOG', 3 );
 125 define( 'RC_EXTERNAL', 5 );
 126 define( 'RC_CATEGORIZE', 6 );
 127 /**@}*/
 128
 129 /**@{
 130  * Article edit flags
 131  */
 132 define( 'EDIT_NEW', 1 );
 133 define( 'EDIT_UPDATE', 2 );
 134 define( 'EDIT_MINOR', 4 );
 135 define( 'EDIT_SUPPRESS_RC', 8 );
 136 define( 'EDIT_FORCE_BOT', 16 );
 137 define( 'EDIT_DEFER_UPDATES', 32 ); // Unused since 1.27
 138 define( 'EDIT_AUTOSUMMARY', 64 );
 139 define( 'EDIT_INTERNAL', 128 );
 140 /**@}*/
 141
 142 /**@{
 143  * Hook support constants
 144  */
 145 define( 'MW_SUPPORTS_PARSERFIRSTCALLINIT', 1 );
 146 define( 'MW_SUPPORTS_LOCALISATIONCACHE', 1 );
 147 define( 'MW_SUPPORTS_CONTENTHANDLER', 1 );
 148 define( 'MW_EDITFILTERMERGED_SUPPORTS_API', 1 );
 149 /**@}*/
 150
 151 /** Support for $wgResourceModules */
 152 define( 'MW_SUPPORTS_RESOURCE_MODULES', 1 );
 153
 154 /**@{
 155  * Allowed values for Parser::$mOutputType
 156  * Parameter to Parser::startExternalParse().
 157  * Use of Parser consts is preferred:
 158  * - Parser::OT_HTML
 159  * - Parser::OT_WIKI
 160  * - Parser::OT_PREPROCESS
 161  * - Parser::OT_MSG
 162  * - Parser::OT_PLAIN
 163  */
 164 define( 'OT_HTML', 1 );
 165 define( 'OT_WIKI', 2 );
 166 define( 'OT_PREPROCESS', 3 );
 167 define( 'OT_MSG', 3 );  // b/c alias for OT_PREPROCESS
 168 define( 'OT_PLAIN', 4 );
 169 /**@}*/
 170
 171 /**@{
 172  * Flags for Parser::setFunctionHook
 173  * Use of Parser consts is preferred:
 174  * - Parser::SFH_NO_HASH
 175  * - Parser::SFH_OBJECT_ARGS
 176  */
 177 define( 'SFH_NO_HASH', 1 );
 178 define( 'SFH_OBJECT_ARGS', 2 );
 179 /**@}*/
 180
 181 /**@{
 182  * Autopromote conditions (must be here and not in Autopromote.php, so that
 183  * they're loaded for DefaultSettings.php before AutoLoader.php)
 184  */
 185 define( 'APCOND_EDITCOUNT', 1 );
 186 define( 'APCOND_AGE', 2 );
 187 define( 'APCOND_EMAILCONFIRMED', 3 );
 188 define( 'APCOND_INGROUPS', 4 );
 189 define( 'APCOND_ISIP', 5 );
 190 define( 'APCOND_IPINRANGE', 6 );
 191 define( 'APCOND_AGE_FROM_EDIT', 7 );
 192 define( 'APCOND_BLOCKED', 8 );
 193 define( 'APCOND_ISBOT', 9 );
 194 /**@}*/
 195
 196 /** @{
 197  * Protocol constants for wfExpandUrl()
 198  */
 199 define( 'PROTO_HTTP', 'http://' );
 200 define( 'PROTO_HTTPS', 'https://' );
 201 define( 'PROTO_RELATIVE', '//' );
 202 define( 'PROTO_CURRENT', null );
 203 define( 'PROTO_CANONICAL', 1 );
 204 define( 'PROTO_INTERNAL', 2 );
 205 /**@}*/
 206
 207 /**@{
 208  * Content model ids, used by Content and ContentHandler.
 209  * These IDs will be exposed in the API and XML dumps.
 210  *
 211  * Extensions that define their own content model IDs should take
 212  * care to avoid conflicts. Using the extension name as a prefix is recommended,
 213  * for example 'myextension-somecontent'.
 214  */
 215 define( 'CONTENT_MODEL_WIKITEXT', 'wikitext' );
 216 define( 'CONTENT_MODEL_JAVASCRIPT', 'javascript' );
 217 define( 'CONTENT_MODEL_CSS', 'css' );
 218 define( 'CONTENT_MODEL_TEXT', 'text' );
 219 define( 'CONTENT_MODEL_JSON', 'json' );
 220 /**@}*/
 221
 222 /**@{
 223  * Content formats, used by Content and ContentHandler.
 224  * These should be MIME types, and will be exposed in the API and XML dumps.
 225  *
 226  * Extensions are free to use the below formats, or define their own.
 227  * It is recommended to stick with the conventions for MIME types.
 228  */
 229 // wikitext
 230 define( 'CONTENT_FORMAT_WIKITEXT', 'text/x-wiki' );
 231 // for js pages
 232 define( 'CONTENT_FORMAT_JAVASCRIPT', 'text/javascript' );
 233 // for css pages
 234 define( 'CONTENT_FORMAT_CSS', 'text/css' );
 235 // for future use, e.g. with some plain-html messages.
 236 define( 'CONTENT_FORMAT_TEXT', 'text/plain' );
 237 // for future use, e.g. with some plain-html messages.
 238 define( 'CONTENT_FORMAT_HTML', 'text/html' );
 239 // for future use with the api and for extensions
 240 define( 'CONTENT_FORMAT_SERIALIZED', 'application/vnd.php.serialized' );
 241 // for future use with the api, and for use by extensions
 242 define( 'CONTENT_FORMAT_JSON', 'application/json' );
 243 // for future use with the api, and for use by extensions
 244 define( 'CONTENT_FORMAT_XML', 'application/xml' );
 245 /**@}*/
 246
 247 /**@{
 248  * Max string length for shell invocations; based on binfmts.h
 249  */
 250 define( 'SHELL_MAX_ARG_STRLEN', '100000' );
 251 /**@}*/
 252
 253 /**@{
 254  * Schema compatibility flags.
 255  *
 256  * Used as flags in a bit field that indicates whether the old or new schema (or both)
 257  * are read or written.
 258  *
 259  * - SCHEMA_COMPAT_WRITE_OLD: Whether information is written to the old schema.
 260  * - SCHEMA_COMPAT_READ_OLD: Whether information stored in the old schema is read.
 261  * - SCHEMA_COMPAT_WRITE_NEW: Whether information is written to the new schema.
 262  * - SCHEMA_COMPAT_READ_NEW: Whether information stored in the new schema is read.
 263  */
 264 define( 'SCHEMA_COMPAT_WRITE_OLD', 0x01 );
 265 define( 'SCHEMA_COMPAT_READ_OLD', 0x02 );
 266 define( 'SCHEMA_COMPAT_WRITE_NEW', 0x10 );
 267 define( 'SCHEMA_COMPAT_READ_NEW', 0x20 );
 268 define( 'SCHEMA_COMPAT_WRITE_BOTH', SCHEMA_COMPAT_WRITE_OLD | SCHEMA_COMPAT_WRITE_NEW );
 269 define( 'SCHEMA_COMPAT_READ_BOTH', SCHEMA_COMPAT_READ_OLD | SCHEMA_COMPAT_READ_NEW );
 270 define( 'SCHEMA_COMPAT_OLD', SCHEMA_COMPAT_WRITE_OLD | SCHEMA_COMPAT_READ_OLD );
 271 define( 'SCHEMA_COMPAT_NEW', SCHEMA_COMPAT_WRITE_NEW | SCHEMA_COMPAT_READ_NEW );
 272 /**@}*/
 273
 274 /**@{
 275  * Schema change migration flags.
 276  *
 277  * Used as values of a feature flag for an orderly transition from an old
 278  * schema to a new schema. The numeric values of these constants are compatible with the
 279  * SCHEMA_COMPAT_XXX bitfield semantics. High bits are used to ensure that the numeric
 280  * ordering follows the order in which the migration stages should be used.
 281  *
 282  * - MIGRATION_OLD: Only read and write the old schema. The new schema need not
 283  *   even exist. This is used from when the patch is merged until the schema
 284  *   change is actually applied to the database.
 285  * - MIGRATION_WRITE_BOTH: Write both the old and new schema. Read the new
 286  *   schema preferentially, falling back to the old. This is used while the
 287  *   change is being tested, allowing easy roll-back to the old schema.
 288  * - MIGRATION_WRITE_NEW: Write only the new schema. Read the new schema
 289  *   preferentially, falling back to the old. This is used while running the
 290  *   maintenance script to migrate existing entries in the old schema to the
 291  *   new schema.
 292  * - MIGRATION_NEW: Only read and write the new schema. The old schema (and the
 293  *   feature flag) may now be removed.
 294  */
 295 define( 'MIGRATION_OLD', 0x00000000 | SCHEMA_COMPAT_OLD );
 296 define( 'MIGRATION_WRITE_BOTH', 0x10000000 | SCHEMA_COMPAT_READ_BOTH | SCHEMA_COMPAT_WRITE_BOTH );
 297 define( 'MIGRATION_WRITE_NEW', 0x20000000 | SCHEMA_COMPAT_READ_BOTH | SCHEMA_COMPAT_WRITE_NEW );
 298 define( 'MIGRATION_NEW', 0x30000000 | SCHEMA_COMPAT_NEW );
 299 /**@}*/
 300
 301 /**@{
 302  * XML dump schema versions, for use with XmlDumpWriter.
 303  * See also the corresponding export-nnnn.xsd files in the docs directory,
 304  * which are also listed at <https://www.mediawiki.org/xml/>.
 305  * Note that not all old schema versions are represented here, as several
 306  * were already unsupported at the time these constants were introduced.
 307  */
 308 define( 'XML_DUMP_SCHEMA_VERSION_10', '0.10' );
 309 define( 'XML_DUMP_SCHEMA_VERSION_11', '0.11' );
 310 /**@}*/