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