MediaWiki REL1_31
Defines.php
Go to the documentation of this file.
1<?php
23require_once __DIR__ . '/libs/mime/defines.php';
24require_once __DIR__ . '/libs/rdbms/defines.php';
25require_once __DIR__ . '/compat/normal/UtfNormalDefines.php';
26
28
40define( 'MW_VERSION', '1.31.16' );
41
42# Obsolete aliases
46define( 'DB_SLAVE', -1 );
47
52define( 'LIST_COMMA', IDatabase::LIST_COMMA );
53define( 'LIST_AND', IDatabase::LIST_AND );
54define( 'LIST_SET', IDatabase::LIST_SET );
55define( 'LIST_NAMES', IDatabase::LIST_NAMES );
56define( 'LIST_OR', IDatabase::LIST_OR );
62define( 'NS_MEDIA', -2 );
63define( 'NS_SPECIAL', -1 );
74define( 'NS_MAIN', 0 );
75define( 'NS_TALK', 1 );
76define( 'NS_USER', 2 );
77define( 'NS_USER_TALK', 3 );
78define( 'NS_PROJECT', 4 );
79define( 'NS_PROJECT_TALK', 5 );
80define( 'NS_FILE', 6 );
81define( 'NS_FILE_TALK', 7 );
82define( 'NS_MEDIAWIKI', 8 );
83define( 'NS_MEDIAWIKI_TALK', 9 );
84define( 'NS_TEMPLATE', 10 );
85define( 'NS_TEMPLATE_TALK', 11 );
86define( 'NS_HELP', 12 );
87define( 'NS_HELP_TALK', 13 );
88define( 'NS_CATEGORY', 14 );
89define( 'NS_CATEGORY_TALK', 15 );
90
101define( 'NS_IMAGE', NS_FILE );
105define( 'NS_IMAGE_TALK', NS_FILE_TALK );
111define( 'CACHE_ANYTHING', -1 ); // Use anything, as long as it works
112define( 'CACHE_NONE', 0 ); // Do not cache
113define( 'CACHE_DB', 1 ); // Store cache objects in the DB
114define( 'CACHE_MEMCACHED', 2 ); // MemCached, must specify servers in $wgMemCacheServers
115define( 'CACHE_ACCEL', 3 ); // APC or WinCache
121define( 'AV_NO_VIRUS', 0 ); # scan ok, no virus found
122define( 'AV_VIRUS_FOUND', 1 ); # virus found!
123define( 'AV_SCAN_ABORTED', -1 ); # scan aborted, the file is probably immune
124define( 'AV_SCAN_FAILED', false ); # scan failed (scanner not found or error in scanner)
132define( 'ALF_PRELOAD_LINKS', 1 ); // unused
133define( 'ALF_PRELOAD_EXISTENCE', 2 ); // unused
134define( 'ALF_NO_LINK_LOCK', 4 ); // unused
135define( 'ALF_NO_BLOCK_LOCK', 8 ); // unused
142define( 'MW_DATE_DEFAULT', 'default' );
143define( 'MW_DATE_MDY', 'mdy' );
144define( 'MW_DATE_DMY', 'dmy' );
145define( 'MW_DATE_YMD', 'ymd' );
146define( 'MW_DATE_ISO', 'ISO 8601' );
152define( 'RC_EDIT', 0 );
153define( 'RC_NEW', 1 );
154define( 'RC_LOG', 3 );
155define( 'RC_EXTERNAL', 5 );
156define( 'RC_CATEGORIZE', 6 );
162define( 'EDIT_NEW', 1 );
163define( 'EDIT_UPDATE', 2 );
164define( 'EDIT_MINOR', 4 );
165define( 'EDIT_SUPPRESS_RC', 8 );
166define( 'EDIT_FORCE_BOT', 16 );
167define( 'EDIT_DEFER_UPDATES', 32 ); // Unused since 1.27
168define( 'EDIT_AUTOSUMMARY', 64 );
169define( 'EDIT_INTERNAL', 128 );
183
194define( 'OT_HTML', 1 );
195define( 'OT_WIKI', 2 );
196define( 'OT_PREPROCESS', 3 );
197define( 'OT_MSG', 3 ); // b/c alias for OT_PREPROCESS
198define( 'OT_PLAIN', 4 );
207define( 'SFH_NO_HASH', 1 );
208define( 'SFH_OBJECT_ARGS', 2 );
215define( 'APCOND_EDITCOUNT', 1 );
216define( 'APCOND_AGE', 2 );
218define( 'APCOND_INGROUPS', 4 );
219define( 'APCOND_ISIP', 5 );
220define( 'APCOND_IPINRANGE', 6 );
221define( 'APCOND_AGE_FROM_EDIT', 7 );
222define( 'APCOND_BLOCKED', 8 );
223define( 'APCOND_ISBOT', 9 );
229define( 'PROTO_HTTP', 'http://' );
230define( 'PROTO_HTTPS', 'https://' );
231define( 'PROTO_RELATIVE', '//' );
232define( 'PROTO_CURRENT', null );
233define( 'PROTO_CANONICAL', 1 );
234define( 'PROTO_INTERNAL', 2 );
245define( 'CONTENT_MODEL_WIKITEXT', 'wikitext' );
246define( 'CONTENT_MODEL_JAVASCRIPT', 'javascript' );
247define( 'CONTENT_MODEL_CSS', 'css' );
248define( 'CONTENT_MODEL_TEXT', 'text' );
259// wikitext
260define( 'CONTENT_FORMAT_WIKITEXT', 'text/x-wiki' );
261// for js pages
262define( 'CONTENT_FORMAT_JAVASCRIPT', 'text/javascript' );
263// for css pages
264define( 'CONTENT_FORMAT_CSS', 'text/css' );
265// for future use, e.g. with some plain-html messages.
266define( 'CONTENT_FORMAT_TEXT', 'text/plain' );
267// for future use, e.g. with some plain-html messages.
268define( 'CONTENT_FORMAT_HTML', 'text/html' );
269// for future use with the api and for extensions
270define( 'CONTENT_FORMAT_SERIALIZED', 'application/vnd.php.serialized' );
271// for future use with the api, and for use by extensions
272define( 'CONTENT_FORMAT_JSON', 'application/json' );
273// for future use with the api, and for use by extensions
274define( 'CONTENT_FORMAT_XML', 'application/xml' );
280define( 'SHELL_MAX_ARG_STRLEN', '100000' );
302define( 'MIGRATION_OLD', 0 );
303define( 'MIGRATION_WRITE_BOTH', 1 );
304define( 'MIGRATION_WRITE_NEW', 2 );
305define( 'MIGRATION_NEW', 3 );
Apache License January http
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
const MW_SUPPORTS_RESOURCE_MODULES
Support for $wgResourceModules.
Definition Defines.php:182
The package json
Definition README.txt:1
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
const APCOND_BLOCKED
Definition Defines.php:222
const CONTENT_FORMAT_JAVASCRIPT
Definition Defines.php:262
const OT_WIKI
Definition Defines.php:195
const SFH_NO_HASH
Definition Defines.php:207
const ALF_PRELOAD_LINKS
Definition Defines.php:132
const CONTENT_FORMAT_HTML
Definition Defines.php:268
const CONTENT_FORMAT_JSON
Definition Defines.php:272
const PROTO_CANONICAL
Definition Defines.php:233
const EDIT_FORCE_BOT
Definition Defines.php:166
const APCOND_AGE
Definition Defines.php:216
const ALF_NO_BLOCK_LOCK
Definition Defines.php:135
const ALF_PRELOAD_EXISTENCE
Definition Defines.php:133
const APCOND_EMAILCONFIRMED
Definition Defines.php:217
const SFH_OBJECT_ARGS
Definition Defines.php:208
const EDIT_DEFER_UPDATES
Definition Defines.php:167
const EDIT_INTERNAL
Definition Defines.php:169
const EDIT_UPDATE
Definition Defines.php:163
const PROTO_HTTPS
Definition Defines.php:230
const APCOND_IPINRANGE
Definition Defines.php:220
const MW_SUPPORTS_CONTENTHANDLER
Definition Defines.php:177
const CONTENT_MODEL_CSS
Definition Defines.php:247
const APCOND_INGROUPS
Definition Defines.php:218
const NS_FILE
Definition Defines.php:80
const RC_NEW
Definition Defines.php:153
const PROTO_CURRENT
Definition Defines.php:232
const MW_EDITFILTERMERGED_SUPPORTS_API
Definition Defines.php:178
const PROTO_INTERNAL
Definition Defines.php:234
const CONTENT_FORMAT_TEXT
Definition Defines.php:266
const APCOND_ISBOT
Definition Defines.php:223
const APCOND_AGE_FROM_EDIT
Definition Defines.php:221
const NS_FILE_TALK
Definition Defines.php:81
const EDIT_SUPPRESS_RC
Definition Defines.php:165
const MW_DATE_MDY
Definition Defines.php:143
const CONTENT_FORMAT_CSS
Definition Defines.php:264
const OT_PLAIN
Definition Defines.php:198
const MW_DATE_DMY
Definition Defines.php:144
const MW_SUPPORTS_LOCALISATIONCACHE
Definition Defines.php:176
const OT_PREPROCESS
Definition Defines.php:196
const APCOND_ISIP
Definition Defines.php:219
const CONTENT_MODEL_WIKITEXT
Definition Defines.php:245
const MIGRATION_WRITE_NEW
Definition Defines.php:304
const CONTENT_MODEL_JSON
Definition Defines.php:249
const MIGRATION_NEW
Definition Defines.php:305
const RC_LOG
Definition Defines.php:154
const RC_EXTERNAL
Definition Defines.php:155
const MW_DATE_YMD
Definition Defines.php:145
const CONTENT_FORMAT_WIKITEXT
Definition Defines.php:260
const PROTO_HTTP
Definition Defines.php:229
const OT_HTML
Definition Defines.php:194
const CONTENT_MODEL_TEXT
Definition Defines.php:248
const SHELL_MAX_ARG_STRLEN
Definition Defines.php:280
const APCOND_EDITCOUNT
Definition Defines.php:215
const MW_DATE_ISO
Definition Defines.php:146
const PROTO_RELATIVE
Definition Defines.php:231
const MW_DATE_DEFAULT
Definition Defines.php:142
const CONTENT_FORMAT_SERIALIZED
Definition Defines.php:270
const MIGRATION_WRITE_BOTH
Definition Defines.php:303
const RC_EDIT
Definition Defines.php:152
const MIGRATION_OLD
Definition Defines.php:302
const MW_SUPPORTS_PARSERFIRSTCALLINIT
Definition Defines.php:175
const EDIT_MINOR
Definition Defines.php:164
const CONTENT_FORMAT_XML
Definition Defines.php:274
const CONTENT_MODEL_JAVASCRIPT
Definition Defines.php:246
const EDIT_AUTOSUMMARY
Definition Defines.php:168
const ALF_NO_LINK_LOCK
Definition Defines.php:134
const OT_MSG
Definition Defines.php:197
const EDIT_NEW
Definition Defines.php:162
const RC_CATEGORIZE
Definition Defines.php:156
either a plain
Definition hooks.txt:2056
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:106
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:37
Basic database interface for live and lazy-loaded relation database handles.
Definition IDatabase.php:38