MediaWiki REL1_28
Defines.php
Go to the documentation of this file.
1<?php
27# Obsolete aliases
28define( 'DB_SLAVE', -1 );
29
34define( 'LIST_COMMA', IDatabase::LIST_COMMA );
35define( 'LIST_AND', IDatabase::LIST_AND );
36define( 'LIST_SET', IDatabase::LIST_SET );
37define( 'LIST_NAMES', IDatabase::LIST_NAMES );
38define( 'LIST_OR', IDatabase::LIST_OR );
44define( 'NS_MEDIA', -2 );
45define( 'NS_SPECIAL', -1 );
56define( 'NS_MAIN', 0 );
57define( 'NS_TALK', 1 );
58define( 'NS_USER', 2 );
59define( 'NS_USER_TALK', 3 );
60define( 'NS_PROJECT', 4 );
61define( 'NS_PROJECT_TALK', 5 );
62define( 'NS_FILE', 6 );
63define( 'NS_FILE_TALK', 7 );
64define( 'NS_MEDIAWIKI', 8 );
65define( 'NS_MEDIAWIKI_TALK', 9 );
66define( 'NS_TEMPLATE', 10 );
67define( 'NS_TEMPLATE_TALK', 11 );
68define( 'NS_HELP', 12 );
69define( 'NS_HELP_TALK', 13 );
70define( 'NS_CATEGORY', 14 );
71define( 'NS_CATEGORY_TALK', 15 );
72
83define( 'NS_IMAGE', NS_FILE );
87define( 'NS_IMAGE_TALK', NS_FILE_TALK );
93define( 'CACHE_ANYTHING', -1 ); // Use anything, as long as it works
94define( 'CACHE_NONE', 0 ); // Do not cache
95define( 'CACHE_DB', 1 ); // Store cache objects in the DB
96define( 'CACHE_MEMCACHED', 2 ); // MemCached, must specify servers in $wgMemCacheServers
97define( 'CACHE_ACCEL', 3 ); // APC, XCache or WinCache
100require_once __DIR__ . '/libs/mime/defines.php';
101
105define( 'AV_NO_VIRUS', 0 ); # scan ok, no virus found
106define( 'AV_VIRUS_FOUND', 1 ); # virus found!
107define( 'AV_SCAN_ABORTED', -1 ); # scan aborted, the file is probably immune
108define( 'AV_SCAN_FAILED', false ); # scan failed (scanner not found or error in scanner)
116define( 'ALF_PRELOAD_LINKS', 1 ); // unused
117define( 'ALF_PRELOAD_EXISTENCE', 2 ); // unused
118define( 'ALF_NO_LINK_LOCK', 4 ); // unused
119define( 'ALF_NO_BLOCK_LOCK', 8 ); // unused
126define( 'MW_DATE_DEFAULT', 'default' );
127define( 'MW_DATE_MDY', 'mdy' );
128define( 'MW_DATE_DMY', 'dmy' );
129define( 'MW_DATE_YMD', 'ymd' );
130define( 'MW_DATE_ISO', 'ISO 8601' );
136define( 'RC_EDIT', 0 );
137define( 'RC_NEW', 1 );
138define( 'RC_LOG', 3 );
139define( 'RC_EXTERNAL', 5 );
140define( 'RC_CATEGORIZE', 6 );
146define( 'EDIT_NEW', 1 );
147define( 'EDIT_UPDATE', 2 );
148define( 'EDIT_MINOR', 4 );
149define( 'EDIT_SUPPRESS_RC', 8 );
150define( 'EDIT_FORCE_BOT', 16 );
151define( 'EDIT_DEFER_UPDATES', 32 ); // Unused since 1.27
152define( 'EDIT_AUTOSUMMARY', 64 );
153define( 'EDIT_INTERNAL', 128 );
159require_once __DIR__ . '/libs/rdbms/defines.php';
160
164require_once __DIR__ . '/compat/normal/UtfNormalDefines.php';
165
177
188define( 'OT_HTML', 1 );
189define( 'OT_WIKI', 2 );
190define( 'OT_PREPROCESS', 3 );
191define( 'OT_MSG', 3 ); // b/c alias for OT_PREPROCESS
192define( 'OT_PLAIN', 4 );
201define( 'SFH_NO_HASH', 1 );
202define( 'SFH_OBJECT_ARGS', 2 );
209define( 'APCOND_EDITCOUNT', 1 );
210define( 'APCOND_AGE', 2 );
212define( 'APCOND_INGROUPS', 4 );
213define( 'APCOND_ISIP', 5 );
214define( 'APCOND_IPINRANGE', 6 );
215define( 'APCOND_AGE_FROM_EDIT', 7 );
216define( 'APCOND_BLOCKED', 8 );
217define( 'APCOND_ISBOT', 9 );
223define( 'PROTO_HTTP', 'http://' );
224define( 'PROTO_HTTPS', 'https://' );
225define( 'PROTO_RELATIVE', '//' );
226define( 'PROTO_CURRENT', null );
227define( 'PROTO_CANONICAL', 1 );
228define( 'PROTO_INTERNAL', 2 );
239define( 'CONTENT_MODEL_WIKITEXT', 'wikitext' );
240define( 'CONTENT_MODEL_JAVASCRIPT', 'javascript' );
241define( 'CONTENT_MODEL_CSS', 'css' );
242define( 'CONTENT_MODEL_TEXT', 'text' );
253// wikitext
254define( 'CONTENT_FORMAT_WIKITEXT', 'text/x-wiki' );
255// for js pages
256define( 'CONTENT_FORMAT_JAVASCRIPT', 'text/javascript' );
257// for css pages
258define( 'CONTENT_FORMAT_CSS', 'text/css' );
259// for future use, e.g. with some plain-html messages.
260define( 'CONTENT_FORMAT_TEXT', 'text/plain' );
261// for future use, e.g. with some plain-html messages.
262define( 'CONTENT_FORMAT_HTML', 'text/html' );
263// for future use with the api and for extensions
264define( 'CONTENT_FORMAT_SERIALIZED', 'application/vnd.php.serialized' );
265// for future use with the api, and for use by extensions
266define( 'CONTENT_FORMAT_JSON', 'application/json' );
267// for future use with the api, and for use by extensions
268define( 'CONTENT_FORMAT_XML', 'application/xml' );
274define( 'SHELL_MAX_ARG_STRLEN', '100000' );
Apache License January http
const MW_SUPPORTS_RESOURCE_MODULES
Support for $wgResourceModules.
Definition Defines.php:176
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
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 normal(non-web) applications -- they might conflict with distributors' policies
const APCOND_BLOCKED
Definition Defines.php:216
const CONTENT_FORMAT_JAVASCRIPT
Definition Defines.php:256
const OT_WIKI
Definition Defines.php:189
const SFH_NO_HASH
Definition Defines.php:201
const ALF_PRELOAD_LINKS
Definition Defines.php:116
const CONTENT_FORMAT_HTML
Definition Defines.php:262
const CONTENT_FORMAT_JSON
Definition Defines.php:266
const PROTO_CANONICAL
Definition Defines.php:227
const EDIT_FORCE_BOT
Definition Defines.php:150
const APCOND_AGE
Definition Defines.php:210
const ALF_NO_BLOCK_LOCK
Definition Defines.php:119
const ALF_PRELOAD_EXISTENCE
Definition Defines.php:117
const APCOND_EMAILCONFIRMED
Definition Defines.php:211
const SFH_OBJECT_ARGS
Definition Defines.php:202
const EDIT_DEFER_UPDATES
Definition Defines.php:151
const EDIT_INTERNAL
Definition Defines.php:153
const EDIT_UPDATE
Definition Defines.php:147
const PROTO_HTTPS
Definition Defines.php:224
const APCOND_IPINRANGE
Definition Defines.php:214
const MW_SUPPORTS_CONTENTHANDLER
Definition Defines.php:171
const CONTENT_MODEL_CSS
Definition Defines.php:241
const APCOND_INGROUPS
Definition Defines.php:212
const NS_FILE
Definition Defines.php:62
const RC_NEW
Definition Defines.php:137
const PROTO_CURRENT
Definition Defines.php:226
const MW_EDITFILTERMERGED_SUPPORTS_API
Definition Defines.php:172
const PROTO_INTERNAL
Definition Defines.php:228
const CONTENT_FORMAT_TEXT
Definition Defines.php:260
const APCOND_ISBOT
Definition Defines.php:217
const APCOND_AGE_FROM_EDIT
Definition Defines.php:215
const NS_FILE_TALK
Definition Defines.php:63
const EDIT_SUPPRESS_RC
Definition Defines.php:149
const MW_DATE_MDY
Definition Defines.php:127
const CONTENT_FORMAT_CSS
Definition Defines.php:258
const OT_PLAIN
Definition Defines.php:192
const MW_DATE_DMY
Definition Defines.php:128
const MW_SUPPORTS_LOCALISATIONCACHE
Definition Defines.php:170
const OT_PREPROCESS
Definition Defines.php:190
const APCOND_ISIP
Definition Defines.php:213
const CONTENT_MODEL_WIKITEXT
Definition Defines.php:239
const CONTENT_MODEL_JSON
Definition Defines.php:243
const RC_LOG
Definition Defines.php:138
const RC_EXTERNAL
Definition Defines.php:139
const MW_DATE_YMD
Definition Defines.php:129
const CONTENT_FORMAT_WIKITEXT
Definition Defines.php:254
const PROTO_HTTP
Definition Defines.php:223
const OT_HTML
Definition Defines.php:188
const CONTENT_MODEL_TEXT
Definition Defines.php:242
const SHELL_MAX_ARG_STRLEN
Definition Defines.php:274
const APCOND_EDITCOUNT
Definition Defines.php:209
const MW_DATE_ISO
Definition Defines.php:130
const PROTO_RELATIVE
Definition Defines.php:225
const MW_DATE_DEFAULT
Definition Defines.php:126
const CONTENT_FORMAT_SERIALIZED
Definition Defines.php:264
const RC_EDIT
Definition Defines.php:136
const MW_SUPPORTS_PARSERFIRSTCALLINIT
Database related.
Definition Defines.php:169
const EDIT_MINOR
Definition Defines.php:148
const CONTENT_FORMAT_XML
Definition Defines.php:268
const CONTENT_MODEL_JAVASCRIPT
Definition Defines.php:240
const EDIT_AUTOSUMMARY
Definition Defines.php:152
const ALF_NO_LINK_LOCK
Definition Defines.php:118
const OT_MSG
Definition Defines.php:191
const EDIT_NEW
Definition Defines.php:146
const RC_CATEGORIZE
Definition Defines.php:140
either a plain
Definition hooks.txt:1990
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:108
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