MediaWiki  1.30.0
Defines.php
Go to the documentation of this file.
1 <?php
23 require_once __DIR__ . '/libs/mime/defines.php';
24 require_once __DIR__ . '/libs/rdbms/defines.php';
25 require_once __DIR__ . '/compat/normal/UtfNormalDefines.php';
26 
28 
33 # Obsolete aliases
34 
37 define( 'DB_SLAVE', -1 );
38 
43 define( 'LIST_COMMA', IDatabase::LIST_COMMA );
44 define( 'LIST_AND', IDatabase::LIST_AND );
45 define( 'LIST_SET', IDatabase::LIST_SET );
46 define( 'LIST_NAMES', IDatabase::LIST_NAMES );
47 define( 'LIST_OR', IDatabase::LIST_OR );
53 define( 'NS_MEDIA', -2 );
54 define( 'NS_SPECIAL', -1 );
65 define( 'NS_MAIN', 0 );
66 define( 'NS_TALK', 1 );
67 define( 'NS_USER', 2 );
68 define( 'NS_USER_TALK', 3 );
69 define( 'NS_PROJECT', 4 );
70 define( 'NS_PROJECT_TALK', 5 );
71 define( 'NS_FILE', 6 );
72 define( 'NS_FILE_TALK', 7 );
73 define( 'NS_MEDIAWIKI', 8 );
74 define( 'NS_MEDIAWIKI_TALK', 9 );
75 define( 'NS_TEMPLATE', 10 );
76 define( 'NS_TEMPLATE_TALK', 11 );
77 define( 'NS_HELP', 12 );
78 define( 'NS_HELP_TALK', 13 );
79 define( 'NS_CATEGORY', 14 );
80 define( 'NS_CATEGORY_TALK', 15 );
81 
92 define( 'NS_IMAGE', NS_FILE );
96 define( 'NS_IMAGE_TALK', NS_FILE_TALK );
102 define( 'CACHE_ANYTHING', -1 ); // Use anything, as long as it works
103 define( 'CACHE_NONE', 0 ); // Do not cache
104 define( 'CACHE_DB', 1 ); // Store cache objects in the DB
105 define( 'CACHE_MEMCACHED', 2 ); // MemCached, must specify servers in $wgMemCacheServers
106 define( 'CACHE_ACCEL', 3 ); // APC, XCache or WinCache
112 define( 'AV_NO_VIRUS', 0 ); # scan ok, no virus found
113 define( 'AV_VIRUS_FOUND', 1 ); # virus found!
114 define( 'AV_SCAN_ABORTED', -1 ); # scan aborted, the file is probably immune
115 define( 'AV_SCAN_FAILED', false ); # scan failed (scanner not found or error in scanner)
123 define( 'ALF_PRELOAD_LINKS', 1 ); // unused
124 define( 'ALF_PRELOAD_EXISTENCE', 2 ); // unused
125 define( 'ALF_NO_LINK_LOCK', 4 ); // unused
126 define( 'ALF_NO_BLOCK_LOCK', 8 ); // unused
133 define( 'MW_DATE_DEFAULT', 'default' );
134 define( 'MW_DATE_MDY', 'mdy' );
135 define( 'MW_DATE_DMY', 'dmy' );
136 define( 'MW_DATE_YMD', 'ymd' );
137 define( 'MW_DATE_ISO', 'ISO 8601' );
143 define( 'RC_EDIT', 0 );
144 define( 'RC_NEW', 1 );
145 define( 'RC_LOG', 3 );
146 define( 'RC_EXTERNAL', 5 );
147 define( 'RC_CATEGORIZE', 6 );
153 define( 'EDIT_NEW', 1 );
154 define( 'EDIT_UPDATE', 2 );
155 define( 'EDIT_MINOR', 4 );
156 define( 'EDIT_SUPPRESS_RC', 8 );
157 define( 'EDIT_FORCE_BOT', 16 );
158 define( 'EDIT_DEFER_UPDATES', 32 ); // Unused since 1.27
159 define( 'EDIT_AUTOSUMMARY', 64 );
160 define( 'EDIT_INTERNAL', 128 );
174 
185 define( 'OT_HTML', 1 );
186 define( 'OT_WIKI', 2 );
187 define( 'OT_PREPROCESS', 3 );
188 define( 'OT_MSG', 3 ); // b/c alias for OT_PREPROCESS
189 define( 'OT_PLAIN', 4 );
198 define( 'SFH_NO_HASH', 1 );
199 define( 'SFH_OBJECT_ARGS', 2 );
206 define( 'APCOND_EDITCOUNT', 1 );
207 define( 'APCOND_AGE', 2 );
208 define( 'APCOND_EMAILCONFIRMED', 3 );
209 define( 'APCOND_INGROUPS', 4 );
210 define( 'APCOND_ISIP', 5 );
211 define( 'APCOND_IPINRANGE', 6 );
212 define( 'APCOND_AGE_FROM_EDIT', 7 );
213 define( 'APCOND_BLOCKED', 8 );
214 define( 'APCOND_ISBOT', 9 );
220 define( 'PROTO_HTTP', 'http://' );
221 define( 'PROTO_HTTPS', 'https://' );
222 define( 'PROTO_RELATIVE', '//' );
223 define( 'PROTO_CURRENT', null );
224 define( 'PROTO_CANONICAL', 1 );
225 define( 'PROTO_INTERNAL', 2 );
236 define( 'CONTENT_MODEL_WIKITEXT', 'wikitext' );
237 define( 'CONTENT_MODEL_JAVASCRIPT', 'javascript' );
238 define( 'CONTENT_MODEL_CSS', 'css' );
239 define( 'CONTENT_MODEL_TEXT', 'text' );
240 define( 'CONTENT_MODEL_JSON', 'json' );
250 // wikitext
252 // for js pages
253 define( 'CONTENT_FORMAT_JAVASCRIPT', 'text/javascript' );
254 // for css pages
255 define( 'CONTENT_FORMAT_CSS', 'text/css' );
256 // for future use, e.g. with some plain-html messages.
258 // for future use, e.g. with some plain-html messages.
259 define( 'CONTENT_FORMAT_HTML', 'text/html' );
260 // for future use with the api and for extensions
261 define( 'CONTENT_FORMAT_SERIALIZED', 'application/vnd.php.serialized' );
262 // for future use with the api, and for use by extensions
263 define( 'CONTENT_FORMAT_JSON', 'application/json' );
264 // for future use with the api, and for use by extensions
265 define( 'CONTENT_FORMAT_XML', 'application/xml' );
271 define( 'SHELL_MAX_ARG_STRLEN', '100000' );
293 define( 'MIGRATION_OLD', 0 );
294 define( 'MIGRATION_WRITE_BOTH', 1 );
295 define( 'MIGRATION_WRITE_NEW', 2 );
296 define( 'MIGRATION_NEW', 3 );
OT_MSG
const OT_MSG
Definition: Defines.php:188
CONTENT_MODEL_JSON
const CONTENT_MODEL_JSON
Definition: Defines.php:240
MW_DATE_DMY
const MW_DATE_DMY
Definition: Defines.php:135
MW_SUPPORTS_PARSERFIRSTCALLINIT
const MW_SUPPORTS_PARSERFIRSTCALLINIT
Definition: Defines.php:166
file
We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going and make changes or fix bugs In we can take all the code that deals with the little used title reversing we can concentrate it all in an extension file
Definition: hooks.txt:91
RC_EXTERNAL
const RC_EXTERNAL
Definition: Defines.php:146
PROTO_CANONICAL
const PROTO_CANONICAL
Definition: Defines.php:224
APCOND_ISBOT
const APCOND_ISBOT
Definition: Defines.php:214
CONTENT_FORMAT_HTML
const CONTENT_FORMAT_HTML
Definition: Defines.php:259
PROTO_INTERNAL
const PROTO_INTERNAL
Definition: Defines.php:225
EDIT_FORCE_BOT
const EDIT_FORCE_BOT
Definition: Defines.php:157
is
We use the convention $dbr for read and $dbw for write to help you keep track of whether the database object is a the world will explode Or to be a subsequent write query which succeeded on the master may fail when replicated to the slave due to a unique key collision Replication on the slave will stop and it may take hours to repair the database and get it back online Setting read_only in my cnf on the slave will avoid this but given the dire we prefer to have as many checks as possible We provide a but the wrapper functions like please read the documentation for except in special pages derived from QueryPage It s a common pitfall for new developers to submit code containing SQL queries which examine huge numbers of rows Remember that COUNT * is(N), counting rows in atable is like counting beans in a bucket.------------------------------------------------------------------------ Replication------------------------------------------------------------------------The largest installation of MediaWiki, Wikimedia, uses a large set ofslave MySQL servers replicating writes made to a master MySQL server. Itis important to understand the issues associated with this setup if youwant to write code destined for Wikipedia.It 's often the case that the best algorithm to use for a given taskdepends on whether or not replication is in use. Due to our unabashedWikipedia-centrism, we often just use the replication-friendly version, but if you like, you can use wfGetLB() ->getServerCount() > 1 tocheck to see if replication is in use.===Lag===Lag primarily occurs when large write queries are sent to the master.Writes on the master are executed in parallel, but they are executed inserial when they are replicated to the slaves. The master writes thequery to the binlog when the transaction is committed. The slaves pollthe binlog and start executing the query as soon as it appears. They canservice reads while they are performing a write query, but will not readanything more from the binlog and thus will perform no more writes. Thismeans that if the write query runs for a long time, the slaves will lagbehind the master for the time it takes for the write query to complete.Lag can be exacerbated by high read load. MediaWiki 's load balancer willstop sending reads to a slave when it is lagged by more than 30 seconds.If the load ratios are set incorrectly, or if there is too much loadgenerally, this may lead to a slave permanently hovering around 30seconds lag.If all slaves are lagged by more than 30 seconds, MediaWiki will stopwriting to the database. All edits and other write operations will berefused, with an error returned to the user. This gives the slaves achance to catch up. Before we had this mechanism, the slaves wouldregularly lag by several minutes, making review of recent editsdifficult.In addition to this, MediaWiki attempts to ensure that the user seesevents occurring on the wiki in chronological order. A few seconds of lagcan be tolerated, as long as the user sees a consistent picture fromsubsequent requests. This is done by saving the master binlog positionin the session, and then at the start of each request, waiting for theslave to catch up to that position before doing any reads from it. Ifthis wait times out, reads are allowed anyway, but the request isconsidered to be in "lagged slave mode". Lagged slave mode can bechecked by calling wfGetLB() ->getLaggedSlaveMode(). The onlypractical consequence at present is a warning displayed in the pagefooter.===Lag avoidance===To avoid excessive lag, queries which write large numbers of rows shouldbe split up, generally to write one row at a time. Multi-row INSERT ...SELECT queries are the worst offenders should be avoided altogether.Instead do the select first and then the insert.===Working with lag===Despite our best efforts, it 's not practical to guarantee a low-lagenvironment. Lag will usually be less than one second, but mayoccasionally be up to 30 seconds. For scalability, it 's very importantto keep load on the master low, so simply sending all your queries tothe master is not the answer. So when you have a genuine need forup-to-date data, the following approach is advised:1) Do a quick query to the master for a sequence number or timestamp 2) Run the full query on the slave and check if it matches the data you gotfrom the master 3) If it doesn 't, run the full query on the masterTo avoid swamping the master every time the slaves lag, use of thisapproach should be kept to a minimum. In most cases you should just readfrom the slave and let the user deal with the delay.------------------------------------------------------------------------ Lock contention------------------------------------------------------------------------Due to the high write rate on Wikipedia(and some other wikis), MediaWiki developers need to be very careful to structure their writesto avoid long-lasting locks. By default, MediaWiki opens a transactionat the first query, and commits it before the output is sent. Locks willbe held from the time when the query is done until the commit. So youcan reduce lock time by doing as much processing as possible before youdo your write queries.Often this approach is not good enough, and it becomes necessary toenclose small groups of queries in their own transaction. Use thefollowing syntax:$dbw=wfGetDB(DB_MASTER
ALF_PRELOAD_LINKS
const ALF_PRELOAD_LINKS
Definition: Defines.php:123
EDIT_INTERNAL
const EDIT_INTERNAL
Definition: Defines.php:160
MW_DATE_YMD
const MW_DATE_YMD
Definition: Defines.php:136
ALF_NO_BLOCK_LOCK
const ALF_NO_BLOCK_LOCK
Definition: Defines.php:126
text
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add text
Definition: design.txt:12
ALF_NO_LINK_LOCK
const ALF_NO_LINK_LOCK
Definition: Defines.php:125
CONTENT_MODEL_CSS
const CONTENT_MODEL_CSS
Definition: Defines.php:238
wiki
Prior to maintenance scripts were a hodgepodge of code that had no cohesion or formal method of action Beginning maintenance scripts have been cleaned up to use a unified class Directory structure How to run a script How to write your own DIRECTORY STRUCTURE The maintenance directory of a MediaWiki installation contains several all of which have unique purposes HOW TO RUN A SCRIPT Ridiculously just call php someScript php that s in the top level maintenance directory if not default wiki
Definition: maintenance.txt:1
RC_LOG
const RC_LOG
Definition: Defines.php:145
MIGRATION_NEW
const MIGRATION_NEW
Definition: Defines.php:296
use
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
ALF_PRELOAD_EXISTENCE
const ALF_PRELOAD_EXISTENCE
Definition: Defines.php:124
APCOND_EDITCOUNT
const APCOND_EDITCOUNT
Definition: Defines.php:206
SFH_OBJECT_ARGS
const SFH_OBJECT_ARGS
Definition: Defines.php:199
OT_PREPROCESS
const OT_PREPROCESS
Definition: Defines.php:187
NS_FILE
const NS_FILE
Definition: Defines.php:71
OT_PLAIN
const OT_PLAIN
Definition: Defines.php:189
MIGRATION_WRITE_BOTH
const MIGRATION_WRITE_BOTH
Definition: Defines.php:294
RC_EDIT
const RC_EDIT
Definition: Defines.php:143
APCOND_AGE
const APCOND_AGE
Definition: Defines.php:207
CONTENT_FORMAT_CSS
const CONTENT_FORMAT_CSS
Definition: Defines.php:255
CONTENT_MODEL_WIKITEXT
const CONTENT_MODEL_WIKITEXT
Definition: Defines.php:236
http
Apache License January http
Definition: APACHE-LICENSE-2.0.txt:3
default
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such and we might be restricted by PHP settings such as safe mode or open_basedir We cannot assume that the software even has read access anywhere useful Many shared hosts run all users web applications under the same so they can t rely on Unix and must forbid reads to even standard directories like tmp lest users read each others files We cannot assume that the user has the ability to install or run any programs not written as web accessible PHP scripts Since anything that works on cheap shared hosting will work if you have shell or root access MediaWiki s design is based around catering to the lowest common denominator Although we support higher end setups as the way many things work by default is tailored toward shared hosting These defaults are unconventional from the point of view of and they certainly aren t ideal for someone who s installing MediaWiki as MediaWiki does not conform to normal Unix filesystem layout Hopefully we ll offer direct support for standard layouts in the but for now *any change to the location of files is unsupported *Moving things and leaving symlinks will *probably *not break but it is *strongly *advised not to try any more intrusive changes to get MediaWiki to conform more closely to your filesystem hierarchy Any such attempt will almost certainly result in unnecessary bugs The standard recommended location to install relative to the web is it should be possible to enable the appropriate rewrite rules by default
Definition: distributors.txt:53
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
LIST_AND
const LIST_AND
Definition: Defines.php:44
MW_EDITFILTERMERGED_SUPPORTS_API
const MW_EDITFILTERMERGED_SUPPORTS_API
Definition: Defines.php:169
Wikimedia\Rdbms\IDatabase
Basic database interface for live and lazy-loaded relation database handles.
Definition: IDatabase.php:40
MIGRATION_WRITE_NEW
const MIGRATION_WRITE_NEW
Definition: Defines.php:295
CONTENT_FORMAT_XML
const CONTENT_FORMAT_XML
Definition: Defines.php:265
LIST_OR
const LIST_OR
Definition: Defines.php:47
APCOND_AGE_FROM_EDIT
const APCOND_AGE_FROM_EDIT
Definition: Defines.php:212
CONTENT_FORMAT_JSON
const CONTENT_FORMAT_JSON
Definition: Defines.php:263
in
null for the wiki Added in
Definition: hooks.txt:1581
APCOND_ISIP
const APCOND_ISIP
Definition: Defines.php:210
not
if not
Definition: COPYING.txt:307
CONTENT_FORMAT_SERIALIZED
const CONTENT_FORMAT_SERIALIZED
Definition: Defines.php:261
SHELL_MAX_ARG_STRLEN
const SHELL_MAX_ARG_STRLEN
Definition: Defines.php:271
LIST_SET
const LIST_SET
Definition: Defines.php:45
APCOND_BLOCKED
const APCOND_BLOCKED
Definition: Defines.php:213
PROTO_CURRENT
const PROTO_CURRENT
Definition: Defines.php:223
CONTENT_FORMAT_TEXT
const CONTENT_FORMAT_TEXT
Definition: Defines.php:257
OT_WIKI
const OT_WIKI
Definition: Defines.php:186
CONTENT_FORMAT_WIKITEXT
const CONTENT_FORMAT_WIKITEXT
Definition: Defines.php:251
json
The package json
Definition: README.txt:1
PROTO_HTTPS
const PROTO_HTTPS
Definition: Defines.php:221
MW_DATE_DEFAULT
const MW_DATE_DEFAULT
Definition: Defines.php:133
LIST_COMMA
const LIST_COMMA
Definition: Defines.php:43
MIGRATION_OLD
const MIGRATION_OLD
Definition: Defines.php:293
or
or
Definition: COPYING.txt:140
MW_SUPPORTS_CONTENTHANDLER
const MW_SUPPORTS_CONTENTHANDLER
Definition: Defines.php:168
EDIT_UPDATE
const EDIT_UPDATE
Definition: Defines.php:154
MW_DATE_ISO
const MW_DATE_ISO
Definition: Defines.php:137
PROTO_HTTP
const PROTO_HTTP
Definition: Defines.php:220
PROTO_RELATIVE
const PROTO_RELATIVE
Definition: Defines.php:222
EDIT_DEFER_UPDATES
const EDIT_DEFER_UPDATES
Definition: Defines.php:158
RC_NEW
const RC_NEW
Definition: Defines.php:144
plain
either a plain
Definition: hooks.txt:2026
SFH_NO_HASH
const SFH_NO_HASH
Definition: Defines.php:198
EDIT_NEW
const EDIT_NEW
Definition: Defines.php:153
APCOND_INGROUPS
const APCOND_INGROUPS
Definition: Defines.php:209
OT_HTML
const OT_HTML
Definition: Defines.php:185
MW_SUPPORTS_RESOURCE_MODULES
const MW_SUPPORTS_RESOURCE_MODULES
Support for $wgResourceModules.
Definition: Defines.php:173
EDIT_AUTOSUMMARY
const EDIT_AUTOSUMMARY
Definition: Defines.php:159
https
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at https
Definition: design.txt:12
error
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults error
Definition: hooks.txt:2581
CONTENT_MODEL_JAVASCRIPT
const CONTENT_MODEL_JAVASCRIPT
Definition: Defines.php:237
RC_CATEGORIZE
const RC_CATEGORIZE
Definition: Defines.php:147
CONTENT_FORMAT_JAVASCRIPT
const CONTENT_FORMAT_JAVASCRIPT
Definition: Defines.php:253
MW_DATE_MDY
const MW_DATE_MDY
Definition: Defines.php:134
EDIT_MINOR
const EDIT_MINOR
Definition: Defines.php:155
EDIT_SUPPRESS_RC
const EDIT_SUPPRESS_RC
Definition: Defines.php:156
LIST_NAMES
const LIST_NAMES
Definition: Defines.php:46
CONTENT_MODEL_TEXT
const CONTENT_MODEL_TEXT
Definition: Defines.php:239
NS_FILE_TALK
const NS_FILE_TALK
Definition: Defines.php:72
MW_SUPPORTS_LOCALISATIONCACHE
const MW_SUPPORTS_LOCALISATIONCACHE
Definition: Defines.php:167
APCOND_EMAILCONFIRMED
const APCOND_EMAILCONFIRMED
Definition: Defines.php:208
APCOND_IPINRANGE
const APCOND_IPINRANGE
Definition: Defines.php:211