Manual:MediaWiki architecture/cs

Od začátku byla MediaWiki vyvíjena speciálně jako software Wikipedie. Vývojáři pracovali na usnadnění opětovného použití uživateli třetích stran, ale vliv a zaujatost Wikipedie utvářely architekturu MediaWiki v celé její historii.

Wikipedia je jednou z deseti nejlepších webových stránek na světě, která v současnosti navštěvuje asi 400 milionů unikátních návštěvníků měsíčně. Získává více než 100 000 přístupů za sekundu. Wikipedie není komerčně podporována reklamami. Je zcela podporována neziskovou organizací Wikimedia Foundation, která se spoléhá na dary jako svůj primární model financování. To znamená, že MediaWiki musí nejen provozovat top ten web, ale také to dělat s omezeným rozpočtem. Pro splnění těchto požadavků má MediaWiki velký důraz na výkon, ukládání do mezipaměti a optimalizaci. Drahé funkce, které nelze na Wikipedii povolit, jsou buď vráceny nebo zakázány prostřednictvím konfigurační proměnné. Existuje nekonečná rovnováha mezi výkonem a funkcemi.

Vliv Wikipedie na architekturu MediaWiki není omezen na výkon. Na rozdíl od obecných CMS byla MediaWiki původně napsána pro velmi specifický účel: Podpora komunity, která vytváří a spravuje volně znovu použitelné znalosti na otevřené platformě. To například znamená, že MediaWiki nezahrnuje běžné funkce nacházející se v podnikových CMS (jako je snadný publikační postup nebo ACL), ale nabízí řadu nástrojů pro řešení spamu a vandalismu.

Potřeby a činy neustále se vyvíjející komunity účastníků Wikipedie tedy od začátku ovlivnily vývoj MediaWiki a naopak. Architektura MediaWiki byla mnohokrát ovlivněna iniciativami zahájenými nebo požadovanými komunitou, jako je vytvoření Wikimedia Commons nebo funkce Flagged Revisions. Vývojáři provedli velké architektonické změny, jako je preprocesor MediaWiki 1.12, protože způsob, jakým byla MediaWiki používána wikipedisty, to vyžadoval.

MediaWiki si také získala solidní externí uživatelskou základnu tím, že je od začátku open source software. Pravidelní uživatelé třetích stran vědí, že pokud tak vysoce profilovaný web jako Wikipedie používá MediaWiki, bude software udržován a vylepšován. MediaWiki se dříve skutečně zaměřovala na stránky Wikimedie, ale bylo vynaloženo úsilí, aby byla obecnější a lépe vyhovovala potřebám těchto uživatelů třetích stran. Například MediaWiki se dodává s vynikajícím webovým instalátorem, díky kterému je proces instalace mnohem méně bolestivý, než když se vše muselo dělat přes příkazový řádek a software obsahoval pevně zakódované cesty pro Wikipedii.

Přesto MediaWiki je a zůstává softwarem Wikipedie, což se projevuje v celé její historii a architektuře.



PHP
PHP bylo vybráno jako rámec pro software "Phase II" Wikipedie v roce 2001. MediaWiki od té doby organicky rostla a stále se vyvíjí. Většina vývojářů MediaWiki jsou dobrovolníci přispívající ve svém volném čase a v prvních letech jich bylo velmi málo. Některá rozhodnutí o návrhu softwaru nebo opomenutí se mohou při zpětném pohledu zdát nesprávná, ale je těžké kritizovat zakladatele za to, že neimplementovali nějakou abstrakci, která se nyní považuje za kritickou, když počáteční kódová základna byla tak malá a čas potřebný k jejímu vývoji tak krátký. .

Například MediaWiki používá názvy tříd bez předpon, což může způsobit konflikty, když vývojáři jádra PHP a PECL přidávají nové třídy. V důsledku toho musela být třída MediaWiki  přejmenována na , aby byla kompatibilní s PHP 5.3. Důsledné používání předpony pro všechny třídy (např. " ") by usnadnilo vložení MediaWiki do jiné aplikace nebo knihovny.

Spoléhat se na PHP pravděpodobně nebylo tou nejlepší volbou pro výkon, protože nemělo prospěch z vylepšení, která zaznamenaly některé jiné dynamické jazyky. Použití Java by bylo mnohem lepší pro výkon a zjednodušené škálování provádění pro úlohy údržby back-endu. Na druhou stranu je PHP velmi oblíbené, což usnadňuje nábor nových vývojářů.

I když MediaWiki stále obsahuje "ošklivý" starší kód, v průběhu let došlo k zásadním vylepšením a do MediaWiki byly během celé její historie zavedeny nové architektonické prvky. Zahrnují třídy,   a  , třídu   a hierarchii tříd  ,   a   hierarchii. MediaWiki začala bez těchto věcí, ale všechny podporují funkce, které existují od začátku. Mnoho vývojářů se zajímá především o vývoj funkcí a architektura často zůstává pozadu, aby ji později dohnala, protože náklady na práci s neadekvátní architekturou se projeví.

Zabezpečení
Vzhledem k tomu, že MediaWiki je platformou pro vysoce profilované weby, jako je Wikipedie, hlavní vývojáři a recenzenti kódu prosadili přísná bezpečnostní pravidla. Aby bylo psaní zabezpečeného kódu snazší, poskytuje MediaWiki vývojářům obálky kolem výstupu HTML a databázových dotazů, aby zvládli escapování. K vyčištění uživatelského vstupu se používá třída, která analyzuje data předaná v URL nebo prostřednictvím POSTed formuláře. Odstraňuje "magické uvozovky" lomítka, odstraňuje nelegální vstupní znaky a normalizuje sekvence Unicode. Falšování požadavků mezi weby (CSRF) se vyhýbá používání tokenů a skriptování mezi weby (XSS) ověřováním vstupů a únikovými výstupy, obvykle pomocí funkce PHP. MediaWiki také poskytuje (a používá) HTML sanitizer s třídou  a databázové funkce, které zabraňují vkládání SQL.

Konfigurace
MediaWiki nabízí stovky konfiguračních nastavení uložených v globálních proměnných PHP. Jejich výchozí hodnota je nastavena na  a správce systému je může přepsat úpravou.

MediaWiki bývala příliš závislá na globálních proměnných, včetně konfigurace a zpracování kontextu. Globals způsobují vážné bezpečnostní důsledky s funkcí  PHP (kterou MediaWiki od verze 1.2 nepotřebuje). Tento systém také omezuje potenciální abstrakce pro konfiguraci a ztěžuje optimalizaci procesu spouštění. Navíc je konfigurační jmenný prostor sdílen s proměnnými používanými pro registraci a kontext objektu, což vede k potenciálním konfliktům. Z uživatelského hlediska se kvůli globálním konfiguračním proměnným také zdá, že konfigurace a údržba MediaWiki je obtížná. Vývoj MediaWiki byl příběhem pomalu se přesouvajícího kontextu z globálních proměnných do objektů. Uložení kontextu zpracování do proměnných členů objektu umožňuje opakované použití těchto objektů mnohem flexibilnějším způsobem.



Databáze a textové úložiště


MediaWiki používá back-end relační databáze od Phase II softwaru. Výchozí (a nejlépe podporovaný) DBMS pro MediaWiki je MySQL, což je ta, kterou používají všechny stránky Wikimedie, ale jiné DBMS (jako PostgreSQL, Oracle a SQLite) mají implementace podporované komunitou. Sysadmin si může vybrat DBMS při instalaci MediaWiki a MediaWiki poskytuje jak databázovou abstrakci, tak vrstvu abstrakce dotazů, které vývojářům zjednodušují přístup k databázi.

Aktuální rozložení obsahuje desítky tabulek. Mnohé se týkají obsahu wikin (např.,  ,   a  ). Další tabulky obsahují mimo jiné data o uživatelích, mediálních souborech , ukládání do mezipaměti a interních nástrojích (  pro frontu úloh). Indexy a souhrnné tabulky jsou v MediaWiki široce používány, protože SQL dotazy, které skenují obrovské množství řádků, mohou být velmi cenné, zejména na stránkách Wikimedie. Neindexované dotazy obvykle nedoporučujeme.

Databáze prošla v průběhu let desítkami změn schématu, z nichž nejpozoruhodnější bylo oddělení ukládání textu a sledování revizí v MediaWiki 1.5.



V modelu 1.4 byl obsah uložen ve dvou důležitých tabulkách  (obsahující text a metadata aktuální revize stránky) a   (obsahující předchozí revize). Smazané stránky byly zachovány v. Když byla provedena úprava, předchozí aktuální revize byla zkopírována do tabulky  a nová úprava byla uložena do. Když byla stránka přejmenována, název stránky musel být aktualizován v metadatech všech  revizí, což mohla být dlouhá operace. Když byla stránka smazána, její položky v tabulkách  a   musely být před smazáním zkopírovány do tabulky. To znamenalo přesunout text všech revizí, které mohly být velmi rozsáhlé, a tím zabrat čas.

V modelu 1.5 byla metadata revize a text revize rozdělena: tabulky  a   byly nahrazeny   (metadata stránek),   (metadata pro všechny revize, staré nebo aktuální) a   (text všech revizí, staré, aktuální nebo smazáno). Nyní, když je provedena úprava, není třeba metadata revize kopírovat mimo tabulek: Stačí vložit nový záznam a aktualizovat ukazatel. Metadata revize již také nezahrnují název stránky, pouze její ID: To odstraňuje potřebu přejmenovávat všechny revize při přejmenování stránky.

Tabulka  ukládá metadata pro každou revizi, ale ne jejich text. Místo toho obsahují textové ID ukazující na tabulku, která obsahuje skutečný text. Když je stránka odstraněna, text všech revizí stránky tam zůstane a není třeba jej přesouvat do jiné tabulky. Tabulka  se skládá z mapování ID na textové bloby. Pole příznaků udává, zda je textový objekt blob zazipován (z důvodu úspory místa) nebo zda je textový objekt blob pouze ukazatelem na externí textové úložiště. Stránky Wikimedie používají externí cluster úložiště podporovaný MySQL s bloby několika desítek revizí. První revize objektu blob je uložena celá a následující revize stejné stránky jsou uloženy jako rozdíly vzhledem k předchozí revizi. Bloby jsou pak gzipovány. Protože jsou revize seskupeny po stránce, mají tendenci být podobné, takže rozdíly jsou relativně malé a gzip funguje dobře. Kompresní poměr dosažený na stránkách Wikimedie se blíží 98 %.

MediaWiki má také vestavěnou podporu pro vyrovnávání zátěže, která byla přidána již v roce 2004 v MediaWiki 1.2 (když Wikipedie získala svůj druhý server – v té době velký problém). Load Balancer (PHP kód MediaWiki, který rozhoduje, ke kterému serveru se připojíte) je nyní kritickou součástí infrastruktury Wikimedie, což vysvětluje jeho vliv na některá rozhodnutí o algoritmech v kódu. Správce systému může v konfiguraci MediaWiki určit, že existuje jeden hlavní databázový server a libovolný počet podřízených databázových serverů. Každému serveru lze přiřadit váhu. Load Balancer odešle všechny zápisy do masteru a bude vyvažovat čtení podle váhy. Sleduje také zpoždění replikace každého slave zařízení. Pokud zpoždění replikace podřízeného zařízení překročí 30 sekund, neobdrží žádné čtecí dotazy, které by mu umožnily dohnat zameškané. Pokud jsou všechny podřízené jednotky zpožděny o více než 30 sekund, MediaWiki se automaticky přepne do režimu pouze pro čtení.

"Chronology protector" MediaWiki zajišťuje, že zpoždění replikace nikdy nezpůsobí, že uživatel uvidí stránku, která tvrdí, že akce, kterou právě provedl, se ještě nestala. To se provádí uložením pozice mastera v relaci uživatele, pokud požadavek, který podal, vedl k dotazu na zápis. Když uživatel příště zadá požadavek na čtení, nástroj pro vyrovnávání zatížení přečte tuto pozici z relace a pokusí se vybrat slave zařízení, které dostihlo tuto pozici replikace, aby požadavek obsluhovalo. Pokud žádná není k dispozici, počká, dokud nebude. Ostatním uživatelům se to může zdát, jako by se akce ještě nestala, ale chronologie zůstává pro každého uživatele konzistentní.



Požadavky, ukládání do mezipaměti a doručení


Pracovní postup provádění webového požadavku
je hlavní přístupový bod pro MediaWiki a zpracovává většinu požadavků zpracovávaných aplikačními servery (tj. požadavky, které nebyly obsluhovány infrastrukturou caching. Viz níže). Kód spouštěný z  provede bezpečnostní kontroly, načte výchozí konfigurační nastavení z , uhodne konfiguraci s   a poté použije nastavení webu obsažená v. Poté vytvoří instanci objektu   a vytvoří objekt    v závislosti na názvu a parametrech akce z požadavku.

může v požadavku URL provádět různé parametry akce. Výchozí akce je, která ukazuje běžné zobrazení obsahu článku. Například požadavek  zobrazí obsah článku "Apple" na anglické Wikipedii. Mezi další časté akce patří  (otevření článku pro úpravy),   (pro zobrazení náhledu nebo uložení článku),   (pro zobrazení historie článku) a   (pro přidání článku do seznamu sledovaných uživatelů). Administrativní akce zahrnují  (smazání článku) a   (zabránění úpravám článku).

Poté je zavolán, který zpracuje většinu požadavku URL. Kontroluje špatné názvy, omezení čtení, lokální přesměrování interwiki a smyčky přesměrování a určuje, zda je požadavek na normální nebo speciální stránku.

Normální požadavky na stránku jsou předány, aby se pro stránku vytvořil objekt   , a poté  , který zpracovává "standardní" akce. Jakmile je akce dokončena,  dokončí požadavek potvrzením DB transakcí, výstupem HTML a spuštěním odložených aktualizací prostřednictvím fronty úloh. potvrdí odložené aktualizace a elegantně zavře úlohu.

Pokud je požadovaná stránka speciální stránkou (tj. ne běžnou stránkou s obsahem wiki, ale speciální stránkou související se softwarem, jako je ), zavolá se   místo. Poté se zavolá odpovídající PHP skript. Speciální stránky dokážou dělat nejrůznější magické věci a každá má svůj specifický účel, obvykle nezávislý na jednom článku nebo jeho obsahu. Speciální stránky zahrnují různé druhy zpráv (poslední změny, protokoly, nezařazené stránky) a nástroje pro správu wiki (blokování uživatelů, změny uživatelských práv) a další. Jejich pracovní postup závisí na jejich funkci.

Mnoho funkcí obsahuje profilovací kód, který umožňuje sledovat pracovní postup provádění pro ladění, pokud je profilování povoleno. Profilování se provádí voláním funkcí  a   pro spuštění a zastavení profilování funkce. Obě funkce berou jako parametr název funkce. Na stránkách Wikimedie se profilování provádí pro procento všech požadavků, aby se zachoval výkon. MediaWiki posílá UDP pakety na centrální server, který je shromažďuje a vytváří profilovací data.



Sestavení stránky bez mezipaměti
Při prohlížení stránky může být HTML kód převzat z mezipaměti (viz níže). Pokud ne, nejprve se rozbalí šablony, funkce analyzátoru a proměnné. To dává expanded wikitext, mezivýsledek, který lze vidět s Special:ExpandTemplates a závisí na:
 * wikitextu;
 * šablonách, na které se přímo nebo nepřímo odkazuje;
 * funkcích analyzátoru, na které se přímo nebo nepřímo odkazuje;
 * hodnotách proměnných, na které se přímo nebo nepřímo odkazuje.

Dále je tento rozšířený wikitext převeden na HTML kód. Odešle se uživateli a obsahuje odkazy na CSS, JavaScript a soubory obrázků. Uživatel může vidět tento mezivýsledek použitím možnosti "zobrazit zdroj" (view source) prohlížeče. HTML kód pro danou stránku závisí na:
 * rozšířeném wikitextu;
 * režimu, jako je prohlížení nebo úpravy (viz níže);
 * existenci interně propojených stránek (umožňuje zobrazit nebo upravit odkaz);
 * vzhledu a dalších uživatelských preferencích;
 * jménu uživatele;
 * stavu uživatele (více odkazů, pokud je sysop, atd.);
 * jmenném prostoru (určuje odkaz na stránku Talk nebo v případě stránky Talk na příslušnou stránku);
 * zda je stránka sledována uživatelem (poskytuje čas sledování nebo ukončení sledování odkazu);
 * zda byla uživatelova stránka Talk nedávno upravena (vydává zprávu).

Nakonec prohlížeč vykreslí HTML pomocí souborů, na které odkazuje. Výsledek, který uživatel vidí na obrazovce, závisí na:
 * HTML kódu;
 * souborech, na které odkazuje kód HTML, jako jsou vložené obrázky, soubory CSS na straně serveru a soubory JavaScript;
 * nastavení prohlížeče a prohlížeče, případně včetně místního souboru CSS, a rozlišení obrazovky.

Pokud JavaScript reaguje na událost, jako je kliknutí myší, závisí stránka na obrazovce také na těchto událostech. To platí například v případě tříditelné tabulky.

Když uživatel vybere záložku upravit, odešle se mu samotný wikitext, a to celé stránky nebo pouze jedné sekce. Když uživatel stiskne Zobrazit náhled, jeho nová verze wikitextu je odeslána na server, který odešle odpovídající novou verzi HTML kódu, která je znovu vykreslena a zobrazena nad nebo pod uživatelovou novou verzí wikitextu. (které server také vrátil). Po případných dalších změnách a dalších náhledech uživatel stiskne Uložit stránku, čímž odešle uživatelovu "finální" verzi na server, který nyní zaznamená úpravu a odešle HTML nové verze (opět). V některých případech v této fázi také probíhá automatická konverze wikitextu.

Ukládání do mezipaměti
Samotná MediaWiki je vylepšena z hlediska výkonu, protože hraje ústřední roli na stránkách Wikimedie, ale je také součástí většího provozního ekosystému, který ovlivnil její architekturu. Mezipaměťová infrastruktura Wikimedia zavedla omezení v MediaWiki. Vývojáři se s těmito problémy zabývali nikoli tím, že by se pokusili vytvořit rozsáhle optimalizovanou infrastrukturu mezipaměti Wikimedie kolem MediaWiki, ale spíše tím, že učinili MediaWiki flexibilnější, aby mohla fungovat v rámci této infrastruktury, aniž by došlo ke snížení výkonu a potřeb ukládání do mezipaměti.

Na stránkách Wikimedie je většina požadavků zpracována proxy servery pro zpětné ukládání do mezipaměti (Squids) a nikdy se ani nedostanou na aplikační servery MediaWiki. Squids obsahují statické verze celých vykreslených stránek, které slouží k jednoduchému čtení uživatelům, kteří nejsou na webu přihlášeni. MediaWiki nativně podporuje Squid a Varnish a integruje se s touto vrstvou mezipaměti například tím, že je upozorní, aby vyčistili stránku z mezipaměti, když byla změněna. Pro přihlášené uživatele a další požadavky, které Squids nemůže obsloužit, Squid předá požadavky na webový server (Apache).

Druhá úroveň ukládání do mezipaměti nastává, když MediaWiki vykresluje a sestavuje stránku z více objektů, z nichž mnohé lze uložit do mezipaměti, aby se minimalizovalo budoucí volání. Mezi takové objekty patří rozhraní stránky (boční panel, nabídky, text uživatelského rozhraní) a vlastní obsah, analyzovaný z wikitextu. Mezipaměť objektů v paměti je v MediaWiki dostupná od rané verze 1.1 (2003) a je zvláště důležitá, aby se zabránilo opětovné analýze dlouhých a složitých stránek.

Data přihlašovacích relací mohou být také uložena v memcached, což umožňuje relacím pracovat transparentně na více front-endových webových serverech v nastavení vyrovnávání zátěže (Wikimedie se silně spoléhá na vyvažování zátěže pomocí LVS s PyBal).

Od verze 1.16 používá MediaWiki vyhrazenou mezipaměť objektů pro lokalizovaný text uživatelského rozhraní. To bylo přidáno poté, co jsme si všimli, že velká část objektů uložených v memcached sestávala ze zpráv uživatelského rozhraní lokalizovaných do jazyka uživatele. Systém je založen na rychlém načítání jednotlivých zpráv z konstantních databází (CDB), tedy souborů s páry klíč-hodnota. CDB minimalizují režii paměti a dobu spouštění v typickém případě. Jsou také používány pro mezipaměť interwiki.

Poslední mezipaměťovou vrstvu tvoří mezipaměť operačních kódů PHP, která se běžně používá pro urychlení aplikací PHP. Kompilace může být zdlouhavý proces. Aby se zabránilo kompilaci skriptů PHP do operačních kódů pokaždé, když jsou vyvolány, lze použít akcelerátor PHP k uložení zkompilovaného operačního kódu a jeho přímému spuštění bez kompilace. MediaWiki bude "jen fungovat" s mnoha akcelerátory jako je APC, PHP akcelerátor.

Díky své zaujatosti Wikimedia je MediaWiki optimalizována pro tuto kompletní, vícevrstvou, distribuovanou infrastrukturu ukládání do mezipaměti. Nicméně také nativně podporuje alternativní nastavení pro menší weby. Nabízí například volitelný zjednodušený systém ukládání souborů do mezipaměti, který ukládá výstup plně vykreslených stránek, jako to dělá Squid. Vrstva pro ukládání abstraktních objektů do mezipaměti MediaWiki také umožňuje ukládat objekty uložené v mezipaměti na několik míst, včetně systému souborů, databáze nebo mezipaměti operačních kódů.

Stejně jako v mnoha webových aplikacích se rozhraní MediaWiki v průběhu let stalo interaktivnějším a pohotovějším, většinou díky použití JavaScriptu. Úsilí o použitelnost zahájené v roce 2008, stejně jako pokročilá manipulace s médii (např. online editace videosouborů), si vyžádaly vyhrazené vylepšení výkonu front-endu.

Pro optimalizaci doručování aktiv JavaScriptu a CSS byl vyvinut modul ResourceLoader. Zahájeno v roce 2009, dokončeno v roce 2011 a od verze 1.17 je základní funkcí MediaWiki. ResourceLoader funguje tak, že na vyžádání načte aktiva JS a CSS, čímž se zkrátí doba načítání a analýzy nepoužívaných funkcí, například ve starších prohlížečích. Minimalizuje také kód, seskupuje zdroje pro ukládání požadavků a může vkládat obrázky jako datové URI.

Jazyky


Kontext a zdůvodnění
Ústřední součástí efektivního přispívání a šíření bezplatných znalostí všem je poskytovat je v co největším počtu jazyků. Wikipedie je dostupná ve více než 280 jazycích a články encyklopedie v angličtině představují méně než 20 % všech článků. Protože Wikipedie a její sesterské stránky existují v mnoha jazycích, je důležité nejen poskytovat obsah v rodném jazyce čtenářů, ale také poskytovat lokalizované rozhraní a účinné nástroje pro zadávání a konverzi, aby účastníci mohli přispívat obsahem.

Z tohoto důvodu jsou lokalizace a internacionalizace (l10n & i18n) ústřední součástí MediaWiki. Systém i18n je všudypřítomný a ovlivňuje mnoho částí softwaru. Je také jedním z nejflexibilnějších a nejbohatších na funkce. Pohodlí překladatele je obvykle preferováno před pohodlím pro vývojáře, ale předpokládá se, že je to přijatelná cena.

MediaWiki je v současnosti lokalizována do více než 350 jazyků, včetně jazyků mimo latinku a jazyků se zprava doleva (RTL), s různou úrovní dokončení. Rozhraní a obsah mohou být v různých jazycích a mohou mít smíšenou směrovost.



Jazyk obsahu
MediaWiki původně používala kódování pro jednotlivé jazyky, což vedlo k mnoha problémům. Například v názvech stránek nebylo možné použít cizí skripty. Místo toho bylo přijato UTF-8. Podpora pro znakové sady jiné než UTF-8 byla zrušena v roce 2005 spolu s hlavní změnou schématu databáze v MediaWiki 1.5. Obsah musí být nyní kódován v UTF-8.

Znaky, které nejsou dostupné na klávesnici editoru, lze upravit a vložit pomocí MediaWiki, což je zpráva rozhraní, která se objeví pod editačním oknem. Jeho verze JavaScriptu automaticky vloží znak, na který jste klikli, do okna úprav. The extension for MediaWiki, developed as part of a usability effort, merges special characters with the edit toolbar. Another extension, called, provides additional input methods and key mapping features for non-ASCII characters.

Recent and future improvements include better support for right-to-left text, bidirectional text (LTR and RTL text on the same page) and.



Jazyk rozhraní
Interface messages have been stored in PHP arrays of key-values pairs since the Phase III software was created. Each message is identified by a unique key, which is assigned different values across languages. Keys are determined by developers, who are encouraged to use prefixes for extensions; for example, message keys for the UploadWizard extension will start with, where   stands for MediaWiki extension.

Zprávy MediaWiki mohou vkládat parametry poskytované softwarem, které často ovlivní gramatiku zprávy. Aby bylo možné podporovat prakticky jakýkoli možný jazyk, lokalizační systém MediaWiki byl postupem času vylepšován a komplexován tak, aby vyhovoval jejich specifickým rysům a výjimkám, které anglicky mluvící často považují za zvláštnosti.

Například přídavná jména jsou v angličtině neměnná slova, ale jazyky jako francouzština vyžadují shodu přídavných jmen s podstatnými jmény. If the user profile has gender preferences set, the  switch can be used in interface messages to appropriately address them (more info). Other switches include, for "simple" plurals and languages like Arabic with dual, trial or paucal numbers, and  , providing grammatical transformation functions for languages like Finnish whose grammatical cases cause alterations or inflections.

Rozlišení pohlaví lze také použít v názvech uživatelských jmenných prostorů závislých na pohlaví, aby název a adresa URL stránky správně odkazovaly na uživatele. Standard MediaWiki namespaces' gender variants are defined via  in each language's MessagesXx.php, while  can be used for wiki-specific namespaces. As of, 13 languages use this feature by default: , , , , , , , , , , , ,.



Lokalizace zpráv
Localized interface messages for MediaWiki reside in  files, where   is the ISO-639 code of the language (e.g.   for French); default messages are in English and stored in. MediaWiki extensions use a similar system, or host all localized messages in an  file. Spolu s překlady obsahují soubory zpráv také informace závislé na jazyce, jako jsou formáty data.

Contributing translations used to be done by submitting PHP patches for the  files. In December 2003, MediaWiki 1.1 introduced "database messages", a subset of wiki pages in the MediaWiki namespace containing interface messages. The content of the wiki page  is the message's text, and overrides its value in the PHP file. Localized versions of the message are at, e.g..

This feature has allowed power users to translate (and customize) interface messages locally on their wiki, but the process doesn't update i18n files shipping with MediaWiki. In 2006, Niklas Laxström created a special, heavily hacked MediaWiki website (now hosted at ) where translators can easily localize interface messages in all languages, simply by editing a wiki page. The  files are then updated in the MediaWiki code repository, where they can be automatically fetched by any wiki, and updated using the LocalisationUpdate extension. On Wikimedia sites, database messages are now only used for customization, and not for localization any more. MediaWiki extensions and some related programs, such as bots, are also localized at translatewiki.net.

To help translators understand the context and meaning of an interface message, it is considered a good practice in MediaWiki to provide documentation for every message. This documentation is stored is a special Message file, with the  language code, which doesn't correspond to a real language. The documentation for each message is then displayed in the translation interface on translatewiki.net. Another helpful tool is the  language code: when used with the   parameter to display a wiki page (e.g.  ), MediaWiki will display the message keys instead of their values in the user interface; this is very useful to identify which message to translate or change.

Registered users can set their own interface language in their preferences, in which case it overrides the site's default interface language. MediaWiki also supports fallback languages: if a message isn't available in the chosen language, it will be displayed in the closest possible language, and not necessarily in English. For example, the fallback language for Breton is French.

Uživatelé
Users are represented in the code using instances from the  class, which encapsulates all of the user-specific settings (user id, name, rights, password, email address, etc.). Client classes use accessors to access these fields; they do all the work of determining whether the user is logged in, and whether the requested option can be satisfied from cookies or whether a database query is needed. Most of the settings needed for rendering normal pages are set in the cookie to minimize use of the database.

MediaWiki provides a very granular permissions system, with basically a user permission for every possible action. For example, to perform the "Rollback" action (i.e. to "quickly rollback the edits of the last user who edited a particular page"), a user needs the  permission, included by default in MediaWiki's   user group. But it can also be added to other user groups, or have a dedicated user group only providing this permission (this is the case on the English Wikipedia, with the  group). Customization of user rights is done by editing the  array in  ; for instance,   allows all registered users to rename files. A user can belong to several groups, and inherits the highest rights associated with each of them.

However, MediaWiki's user permissions system was really designed with Wikipedia in mind, i.e. a site whose content is accessible to all, and only certain actions are restricted to some users. MediaWiki lacks a unified, pervasive permissions concept; it doesn't provide traditional CMS features like restricting read or write access by namespace, category, etc. A few MediaWiki extensions provide such features to some extent.

Obsah


Struktura obsahu
The concept of namespaces was used in the UseModWiki era of Wikipedia, where talk pages were at the title "[article name]/Talk". Namespaces were formally introduced in Magnus Manske's first "PHP script". They were reimplemented a few times over the years, but have kept the same function: to separate different kinds of content. They consist of a prefix, separated from the page title by a colon (e.g.  or   and  ); the main content namespace has no prefix. Wikipedia users quickly adopted them, and they provided the community with different spaces to evolve. Namespaces have proven to be an important feature of MediaWiki, as they create the necessary preconditions for a wiki's community and set up meta-level discussions, community processes, portals, user profiles, etc.

The default configuration for MediaWiki's main content namespace is to be flat (no subpages), because it's how Wikipedia works, but it is trivial to enable them. They are enabled in other namespaces (e.g., where people can for instance work on draft articles) and display breadcrumbs.

Namespaces separate content by type; within a same namespace, pages can be organized by topic using categories, a pseudo-hierarchical organization scheme introduced in MediaWiki 1.3.



Zpracování obsahu: Značkovací jazyk MediaWiki & Parser
The user-generated content stored by MediaWiki isn't in HTML, but in a markup language specific to MediaWiki, sometimes called "wikitext". It allows users to make formatting changes (e.g. bold, italic using quotes), add links (using square brackets), include templates, insert context-dependent content (like a date or signature), and make an incredible number of other magical things happen.

To display a page, this content needs to be parsed, assembled from all the external or dynamic pieces it calls, and converted to proper HTML. The parser is one of the most essential parts of MediaWiki, which also makes it difficult to change or improve. Because hundreds of millions of wiki pages worldwide depend on the parser to continue outputting HTML the way it always has, it has to remain extremely stable.

The markup language wasn't formally spec'd from the beginning; it started based on UseModWiki's markup, then morphed and evolved as needs have demanded. For example, the usage of a ThreadMode format for discussions made Magnus Manske implement the 3 or 4 tildes ( ~ ) as a shortcut to sign one's posts in unstructured text. Tildes were chosen as it resembled his father's hand-written signature.

In the absence of a formal specification, the MediaWiki markup language has become a complex and idiosyncratic language, basically only compatible with MediaWiki's parser; it can't be represented as a formal grammar using BNF, EBNF or ANTLR syntaxes. The current parser's specification is jokingly referred to as "whatever the parser spits out from wikitext, plus a few hundred test cases".

There have been many attempts at alternative parsers, but none has succeeded so far. In 2004, an experimental tokenizer was written by Jens Frank to parse wikitext, and enabled on Wikipedia; it had to be disabled three days later, because of the poor performance of PHP array memory allocations. Since then, most of the parsing has been done with a huge pile of regular expressions, and a ton of helper functions. The wiki markup, and all the special cases the parser needs to support, have also become considerably more complex, making future attempts even more difficult.

A notable improvement was Tim Starling's preprocessor rewrite in MediaWiki 1.12, whose main motivation was to improve the parsing performance on pages with complex templates. The preprocessor converts wikitext to an XML DOM tree representing parts of the document (template invocations, parser functions, tag hooks, section headings, and a few other structures), but can skip "dead branches" in template expansion, such as unfollowed  cases and unused defaults for template arguments. The parser then iterates through the DOM structure and converts its content to HTML.

Recent work on a visual editor for MediaWiki has made it necessary to improve the parsing process (and make it faster), so work has resumed on the parser and intermediate layers between MediaWiki markup and final HTML (see Future, below).



Kouzelná slova a šablony
MediaWiki offers "Magic words" that modify the general behavior of the page or include dynamic content into it. They consist of: behavior switches like  (to hide the automatic table of content) or   (to tell search engines not to index the page); variables like   or  ; and parser functions, i.e. magic words that can take parameters, like   (to output   in lowercase). Constructs like,   and  , used to localize the UI, are parser functions.

The most common way to include content from other pages in a MediaWiki page is to use templates. Templates were really intended to be used to include the same content on different pages, e.g. navigation panels or maintenance banners on Wikipedia articles; having the ability to create partial page layouts and reuse them in thousands of articles with central maintenance made a huge impact on sites like Wikipedia.

However, templates have also been used (and abused) by users for a completely different purpose. MediaWiki 1.3 made it possible for templates to take parameters that change their output; the ability to add a default parameter (introduced in MediaWiki 1.6) enabled the construction of a functional programming language implemented on top of PHP, which was ultimately one of the most costly features in terms of performance.

Tim Starling then developed additional parser functions (the ParserFunctions extension), as a stopgap measure against insane constructs created by Wikipedia users with templates. This set of functions included logical structures like  and , and other functions like   (to evaluate mathematical expressions) and   (for time formatting).

Soon enough, Wikipedia users started to create even more complex templates using the new functions, which considerably degraded the parsing performance on template-heavy pages. The new preprocessor introduced in MediaWiki 1.12 (a major architectural change) was implemented to partly remedy this issue. Later, MediaWiki developers discussed the possibility of using an actual scripting language to improve performance. The Lua extension was added in February of 2013.



Mediální soubory
Users upload files through the  page; administrators can configure the allowed file types through an extension whitelist. Once uploaded, files are stored in a folder on the file system, and thumbnails in a dedicated  directory.

Because of Wikimedia's educational mission, MediaWiki supports file types that may be uncommon in other web applications or CMSes, like SVG vector images, and multipage PDFs & DjVus. They are rendered as PNG files, and can be thumbnailed and displayed inline, as are more common image files like GIFs, JPGs and PNGs.

When a file is uploaded, it is assigned a  page containing information entered by the uploader; this is free text, which usually includes copyright information (author, license) and items describing or classifying the content of the file (description, location, date, categories, etc.). While private wikis may not care much about this information, on media libraries like Wikimedia Commons they are critical to organise the collection and ensure the legality of sharing these files. It has been argued that most of these metadata should, in fact, be stored in a queryable structure like a database table. This would considerably facilitate search, but also attribution and reuse by third parties — for example, through the API.

Most Wikimedia sites also allow "local" uploads to each wiki, but the community tries to store freely-licensed media files in Wikimedia's free media library, Wikimedia Commons. Any Wikimedia site can display a file hosted on Commons as if it were hosted locally. This custom avoids having to upload a file to every wiki to use it there.

As a consequence, MediaWiki natively supports foreign media repositories, i.e., the ability to access media files hosted on another wiki through its API and the  system. Since version 1.16, any MediaWiki website can easily use files from Wikimedia Commons through the  feature. When using a foreign repository, thumbnails are stored locally to save bandwidth. However, it is not (yet) possible to upload to a foreign media repository from another wiki.



Úrovně
MediaWiki's architecture provides different ways to customize and extend the software. This can be done at different levels of access: External programs can also communicate with MediaWiki through its machine API, if it's enabled, basically making any feature and data accessible to the user.
 * System administrators can install extensions and skins, and configure the wiki's separate helper programs (e.g. for image thumbnailing and TeX rendering) and global settings (see Configuration above).
 * Wiki sysops (sometimes called "administrators" too) can edit site-wide gadgets, JavaScript and CSS settings.
 * Any registered user can customize their own experience and interface using their preferences (for existing settings, skins and gadgets) or make their own modifications (using their personal JS and CSS pages).



JavaScript a CSS
MediaWiki can read and apply site-wide or skin-wide JavaScript and CSS using custom wiki pages; these pages are in the  namespace, and thus can only be edited by sysops; for example, JavaScript modifications from   apply to all skins, CSS from   applies to all skins, but   only applies to users with the Vector skin.

Users can do the same types of changes, which will only apply to their own interface, by editing subpages of their user page (e.g.  for JavaScript on all skins,   for CSS on all skins, or   for CSS modifications that only apply to the Vector skin).

If the Gadgets extension is installed, sysops can also edit gadgets, i.e. snippets of JavaScript code providing features that can be turned on and off by users in their preferences. Upcoming developments on gadgets will make it possible to share gadgets across wikis, thus avoiding duplication.

This set of tools has had a huge impact and greatly increased the democratization of MediaWiki's software development. Individual users are empowered to add features for themselves; power users can share them with others, both informally and through globally-configurable sysop-controlled systems. This framework is ideal for small, self-contained modifications, and presents a lower barrier of entry than heavier code modifications done through hooks and extensions.



Rozšíření a vzhledy
When JavaScript and CSS modifications are not enough, MediaWiki provides a system of hooks that let third-party developers run custom PHP code before, after, or instead of MediaWiki code for particular events. MediaWiki extensions use hooks to plug into the code.

Before hooks existed in MediaWiki, adding custom PHP code meant modifying the core code, which was neither easy nor recommended. The first hooks were proposed and added in 2004 by Evan Prodromou; many more have been added over the years when needed. Using hooks, it is even possible to extend MediaWiki's wiki markup with additional capabilities, using tag extensions.

The extension system isn't perfect: extension registration is based on code execution at startup, rather than cacheable data, which limits abstraction and optimization and hurts MediaWiki's performance. But overall, the extension architecture is now a fairly flexible infrastructure that has helped make specialized code more modular, keeping the core software from expanding (too) much, and making it easier for third-party users to build custom functionality on top of MediaWiki.

Conversely, it's very difficult to write a new skin for MediaWiki without reinventing the wheel. In MediaWiki, skins are PHP classes each extending the parent  class; they contain functions that gather the information needed to generate the HTML. The long-lived "MonoBook" skin was difficult to customize because it contained a lot of browser-specific CSS to support old browsers; editing the template or CSS required many subsequent changes to reflect the change for all browsers and platforms.

API
The other main access point for MediaWiki, besides, is  , used to access its machine-readable query API (Application Programming Interface).

Wikipedia users originally created "bots" that worked by screen scraping the HTML content served by MediaWiki; this method was very unreliable and broke many times. To improve this situation, developers introduced a read-only interface (located at ), which then evolved into a full-fledged read and write machine API providing direct, high-level access to the data contained in the MediaWiki database.

Client programs can use the API to login, get data, and post changes. The API supports thin web-based JavaScript clients and end-user applications. Almost anything that can be done via the web interface can basically be done through the API. Client libraries implementing the MediaWiki API are available in many languages, including Python and .NET.

Budoucnost
What started as a summer project done by a single volunteer PHP developer has grown into MediaWiki, a mature, stable wiki engine powering a top-ten website with a ridiculously small operational infrastructure. This has been made possible by constant optimization for performance, iterative architectural changes and a team of awesome developers.

The evolution of web technologies, and the growth of Wikipedia, call for ongoing improvements and new features, some of which require major changes to MediaWiki's architecture. This is, for example, the case for the ongoing visual editor project, which has prompted renewed work on the parser and on the wiki markup language, the DOM and final HTML conversion.

MediaWiki is a tool that is used for varied purposes. Within Wikimedia projects, for instance, it's used to create and curate an encyclopedia (Wikipedia), to power a huge media library (Wikimedia Commons) or to transcribe scanned reference texts (Wikisource); and so on. In other contexts, MediaWiki is used as a corporate CMS, or as a data repository, sometimes combined with a semantic framework. These specialized uses that weren't planned for will probably continue to drive constant adjustments to the software's internal structure. As such, MediaWiki's architecture is very much alive, just like the immense community of users it supports.

<span id="Notes_and_references">

Poznámky a odkazy
<span id="Further_reading">

Další informace

 * MediaWiki documentation and support: https://www.mediawiki.org
 * Automatically-generated MediaWiki documentation: https://doc.wikimedia.org
 * Domas Mituzas, Wikipedia: site internals, configuration, code examples and management issues, MySQL Users conference, 2007. Full text available at http://dom.as/talks/
 * Faidon Liambotis, The Wikimedia infrastructure, dotScale 2014. (YouTube video)

<span id="See_also">

Související odkazy

 * How to become a MediaWiki hacker
 * Manual:Architectural modules