[Summary view] [Print] [Text view]

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