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