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  * NS_IMAGE and NS_IMAGE_TALK are the pre-v1.14 names for NS_FILE and
  79  * NS_FILE_TALK respectively, and are kept for compatibility.
  80  *
  81  * When writing code that should be compatible with older MediaWiki
  82  * versions, either stick to the old names or define the new constants
  83  * yourself, if they're not defined already.
  84  *
  85  * @deprecated since 1.14
  86  */
  87 define( 'NS_IMAGE', NS_FILE );
  88 /**
  89  * @deprecated since 1.14
  90  */
  91 define( 'NS_IMAGE_TALK', NS_FILE_TALK );
  92 /**@}*/
  93
  94 /**@{
  95  * Cache type
  96  */
  97 define( 'CACHE_ANYTHING', -1 );  // Use anything, as long as it works
  98 define( 'CACHE_NONE', 0 );       // Do not cache
  99 define( 'CACHE_DB', 1 );         // Store cache objects in the DB
 100 define( 'CACHE_MEMCACHED', 2 );  // MemCached, must specify servers in $wgMemCacheServers
 101 define( 'CACHE_ACCEL', 3 );      // APC or WinCache
 102 /**@}*/
 103
 104 /**@{
 105  * Antivirus result codes, for use in $wgAntivirusSetup.
 106  */
 107 define( 'AV_NO_VIRUS', 0 );  # scan ok, no virus found
 108 define( 'AV_VIRUS_FOUND', 1 );  # virus found!
 109 define( 'AV_SCAN_ABORTED', -1 );  # scan aborted, the file is probably immune
 110 define( 'AV_SCAN_FAILED', false );  # scan failed (scanner not found or error in scanner)
 111 /**@}*/
 112
 113 /**@{
 114  * Anti-lock flags
 115  * Was used by $wgAntiLockFlags, which was removed with 1.25
 116  * Constants kept to not have warnings when used in LocalSettings
 117  */
 118 define( 'ALF_PRELOAD_LINKS', 1 ); // unused
 119 define( 'ALF_PRELOAD_EXISTENCE', 2 ); // unused
 120 define( 'ALF_NO_LINK_LOCK', 4 ); // unused
 121 define( 'ALF_NO_BLOCK_LOCK', 8 ); // unused
 122 /**@}*/
 123
 124 /**@{
 125  * Date format selectors; used in user preference storage and by
 126  * Language::date() and co.
 127  */
 128 define( 'MW_DATE_DEFAULT', 'default' );
 129 define( 'MW_DATE_MDY', 'mdy' );
 130 define( 'MW_DATE_DMY', 'dmy' );
 131 define( 'MW_DATE_YMD', 'ymd' );
 132 define( 'MW_DATE_ISO', 'ISO 8601' );
 133 /**@}*/
 134
 135 /**@{
 136  * RecentChange type identifiers
 137  */
 138 define( 'RC_EDIT', 0 );
 139 define( 'RC_NEW', 1 );
 140 define( 'RC_LOG', 3 );
 141 define( 'RC_EXTERNAL', 5 );
 142 define( 'RC_CATEGORIZE', 6 );
 143 /**@}*/
 144
 145 /**@{
 146  * Article edit flags
 147  */
 148 define( 'EDIT_NEW', 1 );
 149 define( 'EDIT_UPDATE', 2 );
 150 define( 'EDIT_MINOR', 4 );
 151 define( 'EDIT_SUPPRESS_RC', 8 );
 152 define( 'EDIT_FORCE_BOT', 16 );
 153 define( 'EDIT_DEFER_UPDATES', 32 ); // Unused since 1.27
 154 define( 'EDIT_AUTOSUMMARY', 64 );
 155 define( 'EDIT_INTERNAL', 128 );
 156 /**@}*/
 157
 158 /**@{
 159  * Hook support constants
 160  */
 161 define( 'MW_SUPPORTS_PARSERFIRSTCALLINIT', 1 );
 162 define( 'MW_SUPPORTS_LOCALISATIONCACHE', 1 );
 163 define( 'MW_SUPPORTS_CONTENTHANDLER', 1 );
 164 define( 'MW_EDITFILTERMERGED_SUPPORTS_API', 1 );
 165 /**@}*/
 166
 167 /** Support for $wgResourceModules */
 168 define( 'MW_SUPPORTS_RESOURCE_MODULES', 1 );
 169
 170 /**@{
 171  * Allowed values for Parser::$mOutputType
 172  * Parameter to Parser::startExternalParse().
 173  * Use of Parser consts is preferred:
 174  * - Parser::OT_HTML
 175  * - Parser::OT_WIKI
 176  * - Parser::OT_PREPROCESS
 177  * - Parser::OT_MSG
 178  * - Parser::OT_PLAIN
 179  */
 180 define( 'OT_HTML', 1 );
 181 define( 'OT_WIKI', 2 );
 182 define( 'OT_PREPROCESS', 3 );
 183 define( 'OT_MSG', 3 );  // b/c alias for OT_PREPROCESS
 184 define( 'OT_PLAIN', 4 );
 185 /**@}*/
 186
 187 /**@{
 188  * Flags for Parser::setFunctionHook
 189  * Use of Parser consts is preferred:
 190  * - Parser::SFH_NO_HASH
 191  * - Parser::SFH_OBJECT_ARGS
 192  */
 193 define( 'SFH_NO_HASH', 1 );
 194 define( 'SFH_OBJECT_ARGS', 2 );
 195 /**@}*/
 196
 197 /**@{
 198  * Autopromote conditions (must be here and not in Autopromote.php, so that
 199  * they're loaded for DefaultSettings.php before AutoLoader.php)
 200  */
 201 define( 'APCOND_EDITCOUNT', 1 );
 202 define( 'APCOND_AGE', 2 );
 203 define( 'APCOND_EMAILCONFIRMED', 3 );
 204 define( 'APCOND_INGROUPS', 4 );
 205 define( 'APCOND_ISIP', 5 );
 206 define( 'APCOND_IPINRANGE', 6 );
 207 define( 'APCOND_AGE_FROM_EDIT', 7 );
 208 define( 'APCOND_BLOCKED', 8 );
 209 define( 'APCOND_ISBOT', 9 );
 210 /**@}*/
 211
 212 /** @{
 213  * Protocol constants for wfExpandUrl()
 214  */
 215 define( 'PROTO_HTTP', 'http://' );
 216 define( 'PROTO_HTTPS', 'https://' );
 217 define( 'PROTO_RELATIVE', '//' );
 218 define( 'PROTO_CURRENT', null );
 219 define( 'PROTO_CANONICAL', 1 );
 220 define( 'PROTO_INTERNAL', 2 );
 221 /**@}*/
 222
 223 /**@{
 224  * Content model ids, used by Content and ContentHandler.
 225  * These IDs will be exposed in the API and XML dumps.
 226  *
 227  * Extensions that define their own content model IDs should take
 228  * care to avoid conflicts. Using the extension name as a prefix is recommended,
 229  * for example 'myextension-somecontent'.
 230  */
 231 define( 'CONTENT_MODEL_WIKITEXT', 'wikitext' );
 232 define( 'CONTENT_MODEL_JAVASCRIPT', 'javascript' );
 233 define( 'CONTENT_MODEL_CSS', 'css' );
 234 define( 'CONTENT_MODEL_TEXT', 'text' );
 235 define( 'CONTENT_MODEL_JSON', 'json' );
 236 /**@}*/
 237
 238 /**@{
 239  * Content formats, used by Content and ContentHandler.
 240  * These should be MIME types, and will be exposed in the API and XML dumps.
 241  *
 242  * Extensions are free to use the below formats, or define their own.
 243  * It is recommended to stick with the conventions for MIME types.
 244  */
 245 // wikitext
 246 define( 'CONTENT_FORMAT_WIKITEXT', 'text/x-wiki' );
 247 // for js pages
 248 define( 'CONTENT_FORMAT_JAVASCRIPT', 'text/javascript' );
 249 // for css pages
 250 define( 'CONTENT_FORMAT_CSS', 'text/css' );
 251 // for future use, e.g. with some plain-html messages.
 252 define( 'CONTENT_FORMAT_TEXT', 'text/plain' );
 253 // for future use, e.g. with some plain-html messages.
 254 define( 'CONTENT_FORMAT_HTML', 'text/html' );
 255 // for future use with the api and for extensions
 256 define( 'CONTENT_FORMAT_SERIALIZED', 'application/vnd.php.serialized' );
 257 // for future use with the api, and for use by extensions
 258 define( 'CONTENT_FORMAT_JSON', 'application/json' );
 259 // for future use with the api, and for use by extensions
 260 define( 'CONTENT_FORMAT_XML', 'application/xml' );
 261 /**@}*/
 262
 263 /**@{
 264  * Max string length for shell invocations; based on binfmts.h
 265  */
 266 define( 'SHELL_MAX_ARG_STRLEN', '100000' );
 267 /**@}*/
 268
 269 /**@{
 270  * Schema compatibility flags.
 271  *
 272  * Used as flags in a bit field that indicates whether the old or new schema (or both)
 273  * are read or written.
 274  *
 275  * - SCHEMA_COMPAT_WRITE_OLD: Whether information is written to the old schema.
 276  * - SCHEMA_COMPAT_READ_OLD: Whether information stored in the old schema is read.
 277  * - SCHEMA_COMPAT_WRITE_NEW: Whether information is written to the new schema.
 278  * - SCHEMA_COMPAT_READ_NEW: Whether information stored in the new schema is read.
 279  */
 280 define( 'SCHEMA_COMPAT_WRITE_OLD', 0x01 );
 281 define( 'SCHEMA_COMPAT_READ_OLD', 0x02 );
 282 define( 'SCHEMA_COMPAT_WRITE_NEW', 0x10 );
 283 define( 'SCHEMA_COMPAT_READ_NEW', 0x20 );
 284 define( 'SCHEMA_COMPAT_WRITE_BOTH', SCHEMA_COMPAT_WRITE_OLD | SCHEMA_COMPAT_WRITE_NEW );
 285 define( 'SCHEMA_COMPAT_READ_BOTH', SCHEMA_COMPAT_READ_OLD | SCHEMA_COMPAT_READ_NEW );
 286 define( 'SCHEMA_COMPAT_OLD', SCHEMA_COMPAT_WRITE_OLD | SCHEMA_COMPAT_READ_OLD );
 287 define( 'SCHEMA_COMPAT_NEW', SCHEMA_COMPAT_WRITE_NEW | SCHEMA_COMPAT_READ_NEW );
 288 /**@}*/
 289
 290 /**@{
 291  * Schema change migration flags.
 292  *
 293  * Used as values of a feature flag for an orderly transition from an old
 294  * schema to a new schema. The numeric values of these constants are compatible with the
 295  * SCHEMA_COMPAT_XXX bitfield semantics. High bits are used to ensure that the numeric
 296  * ordering follows the order in which the migration stages should be used.
 297  *
 298  * - MIGRATION_OLD: Only read and write the old schema. The new schema need not
 299  *   even exist. This is used from when the patch is merged until the schema
 300  *   change is actually applied to the database.
 301  * - MIGRATION_WRITE_BOTH: Write both the old and new schema. Read the new
 302  *   schema preferentially, falling back to the old. This is used while the
 303  *   change is being tested, allowing easy roll-back to the old schema.
 304  * - MIGRATION_WRITE_NEW: Write only the new schema. Read the new schema
 305  *   preferentially, falling back to the old. This is used while running the
 306  *   maintenance script to migrate existing entries in the old schema to the
 307  *   new schema.
 308  * - MIGRATION_NEW: Only read and write the new schema. The old schema (and the
 309  *   feature flag) may now be removed.
 310  */
 311 define( 'MIGRATION_OLD', 0x00000000 | SCHEMA_COMPAT_OLD );
 312 define( 'MIGRATION_WRITE_BOTH', 0x10000000 | SCHEMA_COMPAT_READ_BOTH | SCHEMA_COMPAT_WRITE_BOTH );
 313 define( 'MIGRATION_WRITE_NEW', 0x20000000 | SCHEMA_COMPAT_READ_BOTH | SCHEMA_COMPAT_WRITE_NEW );
 314 define( 'MIGRATION_NEW', 0x30000000 | SCHEMA_COMPAT_NEW );
 315 /**@}*/
 316
 317 /**@{
 318  * XML dump schema versions, for use with XmlDumpWriter.
 319  * See also the corresponding export-nnnn.xsd files in the docs directory,
 320  * which are also listed at <https://www.mediawiki.org/xml/>.
 321  * Note that not all old schema versions are represented here, as several
 322  * were already unsupported at the time these constants were introduced.
 323  */
 324 define( 'XML_DUMP_SCHEMA_VERSION_10', '0.10' );
 325 define( 'XML_DUMP_SCHEMA_VERSION_11', '0.11' );
 326 /**@}*/