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 /**
  24  * @defgroup Constants MediaWiki constants
  25  */
  26
  27 /**@{
  28  * Database related constants
  29  */
  30 define( 'DBO_DEBUG', 1 );
  31 define( 'DBO_NOBUFFER', 2 );
  32 define( 'DBO_IGNORE', 4 );
  33 define( 'DBO_TRX', 8 ); // automatically start transaction on first query
  34 define( 'DBO_DEFAULT', 16 );
  35 define( 'DBO_PERSISTENT', 32 );
  36 define( 'DBO_SYSDBA', 64 ); // for oracle maintenance
  37 define( 'DBO_DDLMODE', 128 ); // when using schema files: mostly for Oracle
  38 define( 'DBO_SSL', 256 );
  39 define( 'DBO_COMPRESS', 512 );
  40 /**@}*/
  41
  42 /**@{
  43  * Valid database indexes
  44  * Operation-based indexes
  45  */
  46 define( 'DB_REPLICA', -1 );     # Read from a replica (or only server)
  47 define( 'DB_MASTER', -2 );    # Write to master (or only server)
  48 /**@}*/
  49
  50 # Obsolete aliases
  51 define( 'DB_SLAVE', -1 );
  52
  53 /**@{
  54  * Virtual namespaces; don't appear in the page database
  55  */
  56 define( 'NS_MEDIA', -2 );
  57 define( 'NS_SPECIAL', -1 );
  58 /**@}*/
  59
  60 /**@{
  61  * Real namespaces
  62  *
  63  * Number 100 and beyond are reserved for custom namespaces;
  64  * DO NOT assign standard namespaces at 100 or beyond.
  65  * DO NOT Change integer values as they are most probably hardcoded everywhere
  66  * see bug #696 which talked about that.
  67  */
  68 define( 'NS_MAIN', 0 );
  69 define( 'NS_TALK', 1 );
  70 define( 'NS_USER', 2 );
  71 define( 'NS_USER_TALK', 3 );
  72 define( 'NS_PROJECT', 4 );
  73 define( 'NS_PROJECT_TALK', 5 );
  74 define( 'NS_FILE', 6 );
  75 define( 'NS_FILE_TALK', 7 );
  76 define( 'NS_MEDIAWIKI', 8 );
  77 define( 'NS_MEDIAWIKI_TALK', 9 );
  78 define( 'NS_TEMPLATE', 10 );
  79 define( 'NS_TEMPLATE_TALK', 11 );
  80 define( 'NS_HELP', 12 );
  81 define( 'NS_HELP_TALK', 13 );
  82 define( 'NS_CATEGORY', 14 );
  83 define( 'NS_CATEGORY_TALK', 15 );
  84
  85 /**
  86  * NS_IMAGE and NS_IMAGE_TALK are the pre-v1.14 names for NS_FILE and
  87  * NS_FILE_TALK respectively, and are kept for compatibility.
  88  *
  89  * When writing code that should be compatible with older MediaWiki
  90  * versions, either stick to the old names or define the new constants
  91  * yourself, if they're not defined already.
  92  */
  93 define( 'NS_IMAGE', NS_FILE );
  94 define( 'NS_IMAGE_TALK', NS_FILE_TALK );
  95 /**@}*/
  96
  97 /**@{
  98  * Cache type
  99  */
 100 define( 'CACHE_ANYTHING', -1 );  // Use anything, as long as it works
 101 define( 'CACHE_NONE', 0 );       // Do not cache
 102 define( 'CACHE_DB', 1 );         // Store cache objects in the DB
 103 define( 'CACHE_MEMCACHED', 2 );  // MemCached, must specify servers in $wgMemCacheServers
 104 define( 'CACHE_ACCEL', 3 );      // APC, XCache or WinCache
 105 /**@}*/
 106
 107 /**@{
 108  * Media types.
 109  * This defines constants for the value returned by File::getMediaType()
 110  */
 111 // unknown format
 112 define( 'MEDIATYPE_UNKNOWN', 'UNKNOWN' );
 113 // some bitmap image or image source (like psd, etc). Can't scale up.
 114 define( 'MEDIATYPE_BITMAP', 'BITMAP' );
 115 // some vector drawing (SVG, WMF, PS, ...) or image source (oo-draw, etc). Can scale up.
 116 define( 'MEDIATYPE_DRAWING', 'DRAWING' );
 117 // simple audio file (ogg, mp3, wav, midi, whatever)
 118 define( 'MEDIATYPE_AUDIO', 'AUDIO' );
 119 // simple video file (ogg, mpg, etc;
 120 // no not include formats here that may contain executable sections or scripts!)
 121 define( 'MEDIATYPE_VIDEO', 'VIDEO' );
 122 // Scriptable Multimedia (flash, advanced video container formats, etc)
 123 define( 'MEDIATYPE_MULTIMEDIA', 'MULTIMEDIA' );
 124 // Office Documents, Spreadsheets (office formats possibly containing apples, scripts, etc)
 125 define( 'MEDIATYPE_OFFICE', 'OFFICE' );
 126 // Plain text (possibly containing program code or scripts)
 127 define( 'MEDIATYPE_TEXT', 'TEXT' );
 128 // binary executable
 129 define( 'MEDIATYPE_EXECUTABLE', 'EXECUTABLE' );
 130 // archive file (zip, tar, etc)
 131 define( 'MEDIATYPE_ARCHIVE', 'ARCHIVE' );
 132 /**@}*/
 133
 134 /**@{
 135  * Antivirus result codes, for use in $wgAntivirusSetup.
 136  */
 137 define( 'AV_NO_VIRUS', 0 );  # scan ok, no virus found
 138 define( 'AV_VIRUS_FOUND', 1 );  # virus found!
 139 define( 'AV_SCAN_ABORTED', -1 );  # scan aborted, the file is probably immune
 140 define( 'AV_SCAN_FAILED', false );  # scan failed (scanner not found or error in scanner)
 141 /**@}*/
 142
 143 /**@{
 144  * Anti-lock flags
 145  * Was used by $wgAntiLockFlags, which was removed with 1.25
 146  * Constants kept to not have warnings when used in LocalSettings
 147  */
 148 define( 'ALF_PRELOAD_LINKS', 1 ); // unused
 149 define( 'ALF_PRELOAD_EXISTENCE', 2 ); // unused
 150 define( 'ALF_NO_LINK_LOCK', 4 ); // unused
 151 define( 'ALF_NO_BLOCK_LOCK', 8 ); // unused
 152 /**@}*/
 153
 154 /**@{
 155  * Date format selectors; used in user preference storage and by
 156  * Language::date() and co.
 157  */
 158 define( 'MW_DATE_DEFAULT', 'default' );
 159 define( 'MW_DATE_MDY', 'mdy' );
 160 define( 'MW_DATE_DMY', 'dmy' );
 161 define( 'MW_DATE_YMD', 'ymd' );
 162 define( 'MW_DATE_ISO', 'ISO 8601' );
 163 /**@}*/
 164
 165 /**@{
 166  * RecentChange type identifiers
 167  */
 168 define( 'RC_EDIT', 0 );
 169 define( 'RC_NEW', 1 );
 170 define( 'RC_LOG', 3 );
 171 define( 'RC_EXTERNAL', 5 );
 172 define( 'RC_CATEGORIZE', 6 );
 173 /**@}*/
 174
 175 /**@{
 176  * Article edit flags
 177  */
 178 define( 'EDIT_NEW', 1 );
 179 define( 'EDIT_UPDATE', 2 );
 180 define( 'EDIT_MINOR', 4 );
 181 define( 'EDIT_SUPPRESS_RC', 8 );
 182 define( 'EDIT_FORCE_BOT', 16 );
 183 define( 'EDIT_DEFER_UPDATES', 32 ); // Unused since 1.27
 184 define( 'EDIT_AUTOSUMMARY', 64 );
 185 define( 'EDIT_INTERNAL', 128 );
 186 /**@}*/
 187
 188 /**@{
 189  * Flags for Database::makeList()
 190  * These are also available as Database class constants
 191  */
 192 define( 'LIST_COMMA', 0 );
 193 define( 'LIST_AND', 1 );
 194 define( 'LIST_SET', 2 );
 195 define( 'LIST_NAMES', 3 );
 196 define( 'LIST_OR', 4 );
 197 /**@}*/
 198
 199 /**
 200  * Unicode and normalisation related
 201  */
 202 require_once __DIR__ . '/compat/normal/UtfNormalDefines.php';
 203
 204 /**@{
 205  * Hook support constants
 206  */
 207 define( 'MW_SUPPORTS_PARSERFIRSTCALLINIT', 1 );
 208 define( 'MW_SUPPORTS_LOCALISATIONCACHE', 1 );
 209 define( 'MW_SUPPORTS_CONTENTHANDLER', 1 );
 210 define( 'MW_EDITFILTERMERGED_SUPPORTS_API', 1 );
 211 /**@}*/
 212
 213 /** Support for $wgResourceModules */
 214 define( 'MW_SUPPORTS_RESOURCE_MODULES', 1 );
 215
 216 /**@{
 217  * Allowed values for Parser::$mOutputType
 218  * Parameter to Parser::startExternalParse().
 219  * Use of Parser consts is preferred:
 220  * - Parser::OT_HTML
 221  * - Parser::OT_WIKI
 222  * - Parser::OT_PREPROCESS
 223  * - Parser::OT_MSG
 224  * - Parser::OT_PLAIN
 225  */
 226 define( 'OT_HTML', 1 );
 227 define( 'OT_WIKI', 2 );
 228 define( 'OT_PREPROCESS', 3 );
 229 define( 'OT_MSG', 3 );  // b/c alias for OT_PREPROCESS
 230 define( 'OT_PLAIN', 4 );
 231 /**@}*/
 232
 233 /**@{
 234  * Flags for Parser::setFunctionHook
 235  * Use of Parser consts is preferred:
 236  * - Parser::SFH_NO_HASH
 237  * - Parser::SFH_OBJECT_ARGS
 238  */
 239 define( 'SFH_NO_HASH', 1 );
 240 define( 'SFH_OBJECT_ARGS', 2 );
 241 /**@}*/
 242
 243 /**@{
 244  * Autopromote conditions (must be here and not in Autopromote.php, so that
 245  * they're loaded for DefaultSettings.php before AutoLoader.php)
 246  */
 247 define( 'APCOND_EDITCOUNT', 1 );
 248 define( 'APCOND_AGE', 2 );
 249 define( 'APCOND_EMAILCONFIRMED', 3 );
 250 define( 'APCOND_INGROUPS', 4 );
 251 define( 'APCOND_ISIP', 5 );
 252 define( 'APCOND_IPINRANGE', 6 );
 253 define( 'APCOND_AGE_FROM_EDIT', 7 );
 254 define( 'APCOND_BLOCKED', 8 );
 255 define( 'APCOND_ISBOT', 9 );
 256 /**@}*/
 257
 258 /** @{
 259  * Protocol constants for wfExpandUrl()
 260  */
 261 define( 'PROTO_HTTP', 'http://' );
 262 define( 'PROTO_HTTPS', 'https://' );
 263 define( 'PROTO_RELATIVE', '//' );
 264 define( 'PROTO_CURRENT', null );
 265 define( 'PROTO_CANONICAL', 1 );
 266 define( 'PROTO_INTERNAL', 2 );
 267 /**@}*/
 268
 269 /**@{
 270  * Content model ids, used by Content and ContentHandler.
 271  * These IDs will be exposed in the API and XML dumps.
 272  *
 273  * Extensions that define their own content model IDs should take
 274  * care to avoid conflicts. Using the extension name as a prefix is recommended,
 275  * for example 'myextension-somecontent'.
 276  */
 277 define( 'CONTENT_MODEL_WIKITEXT', 'wikitext' );
 278 define( 'CONTENT_MODEL_JAVASCRIPT', 'javascript' );
 279 define( 'CONTENT_MODEL_CSS', 'css' );
 280 define( 'CONTENT_MODEL_TEXT', 'text' );
 281 define( 'CONTENT_MODEL_JSON', 'json' );
 282 /**@}*/
 283
 284 /**@{
 285  * Content formats, used by Content and ContentHandler.
 286  * These should be MIME types, and will be exposed in the API and XML dumps.
 287  *
 288  * Extensions are free to use the below formats, or define their own.
 289  * It is recommended to stick with the conventions for MIME types.
 290  */
 291 // wikitext
 292 define( 'CONTENT_FORMAT_WIKITEXT', 'text/x-wiki' );
 293 // for js pages
 294 define( 'CONTENT_FORMAT_JAVASCRIPT', 'text/javascript' );
 295 // for css pages
 296 define( 'CONTENT_FORMAT_CSS', 'text/css' );
 297 // for future use, e.g. with some plain-html messages.
 298 define( 'CONTENT_FORMAT_TEXT', 'text/plain' );
 299 // for future use, e.g. with some plain-html messages.
 300 define( 'CONTENT_FORMAT_HTML', 'text/html' );
 301 // for future use with the api and for extensions
 302 define( 'CONTENT_FORMAT_SERIALIZED', 'application/vnd.php.serialized' );
 303 // for future use with the api, and for use by extensions
 304 define( 'CONTENT_FORMAT_JSON', 'application/json' );
 305 // for future use with the api, and for use by extensions
 306 define( 'CONTENT_FORMAT_XML', 'application/xml' );
 307 /**@}*/
 308
 309 /**@{
 310  * Max string length for shell invocations; based on binfmts.h
 311  */
 312 define( 'SHELL_MAX_ARG_STRLEN', '100000' );
 313 /**@}*/