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. Rozšíření pro MediaWiki, vyvinuté jako součást úsilí o použitelnost, spojuje speciální znaky s panelem nástrojů pro úpravy. Další rozšíření, nazvané, poskytuje další metody zadávání a funkce mapování klíčů pro jiné znaky než ASCII.

Nedávná a budoucí vylepšení zahrnují lepší podporu pro text zprava doleva, obousměrný text (text LTR a RTL na stejné stránce) a.



Jazyk rozhraní
Zprávy rozhraní byly od vytvoření softwaru Phase III uloženy v polích PHP páry klíč-hodnota. Každá zpráva je identifikována jedinečným klíčem, kterému jsou v různých jazycích přiřazeny různé hodnoty. Klíče určují vývojáři, kterým se doporučuje používat předpony pro rozšíření. Například klíče zpráv pro rozšíření UploadWizard budou začínat, kde   znamená 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. Pokud má uživatelský profil nastavené preference pohlaví, lze přepínač  použít ve zprávách rozhraní k jejich vhodnému adresování (více informací). Mezi další přepínače patří  pro "jednoduchá" množná čísla a jazyky jako arabština s duálními, zkušebními nebo paucal čísly a , které poskytují gramatické transformační funkce pro jazyky, jako je finština, jejichž gramatické případy způsobují změny nebo skloňování.

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. Pohlavní varianty standardních jmenných prostorů MediaWiki jsou definovány pomocí  v MessagesXx.php každého jazyka, zatímco  lze použít pro jmenné prostory specifické pro wiki. Od používá tuto funkci ve výchozím nastavení 13 jazyků:





Lokalizace zpráv
Lokalizované zprávy rozhraní pro MediaWiki jsou uloženy v souborech, kde   je kód ISO-639 jazyka (např.   pro francouzštinu). Výchozí zprávy jsou v angličtině a jsou uloženy v. Rozšíření MediaWiki používají podobný systém nebo hostují všechny lokalizované zprávy v souboru. Spolu s překlady obsahují soubory zpráv také informace závislé na jazyce, jako jsou formáty data.

Přispívající překlady se dříve prováděly odesláním oprav PHP pro soubory. V prosinci 2003 představila MediaWiki 1.1 "databázové zprávy", podmnožinu wiki stránek ve jmenném prostoru MediaWiki obsahující zprávy rozhraní. Obsahem wiki stránky je text zprávy a přepíše její hodnotu v souboru PHP. Lokalizované verze zprávy jsou na adrese, např. .

Tato funkce umožnila pokročilým uživatelům překládat (a přizpůsobovat) zprávy rozhraní lokálně na jejich wiki, ale tento proces neaktualizuje soubory i18n dodávané s MediaWiki. V roce 2006 vytvořil Niklas Laxström speciální, silně hacknutý web MediaWiki (nyní hostovaný na ), kde mohou překladatelé snadno lokalizovat zprávy rozhraní do všech jazyků, jednoduše úpravou wiki stránky. Soubory  jsou poté aktualizovány v úložišti kódu MediaWiki, odkud je může automaticky načíst jakákoli wiki a aktualizovat pomocí rozšíření LocalisationUpdate. Na stránkách Wikimedie se nyní databázové zprávy používají pouze pro přizpůsobení a již ne pro lokalizaci. Rozšíření MediaWiki a některé související programy, jako jsou roboti, jsou také lokalizovány na translatewiki.net.

Aby překladatelé porozuměli kontextu a významu zprávy rozhraní, je v MediaWiki považováno za osvědčený postup poskytnout dokumentaci ke každé zprávě. Tato dokumentace je uložena jako speciální soubor zpráv s kódem jazyka, který neodpovídá skutečnému jazyku. Dokumentace ke každé zprávě se pak zobrazí v překladovém rozhraní na translatewiki.net. Dalším užitečným nástrojem je kód jazyka : Při použití s ​​parametrem   k zobrazení wiki stránky (např.  ), MediaWiki zobrazí v uživatelském rozhraní namísto jejich hodnot klíče zpráv. To je velmi užitečné pro identifikaci, kterou zprávu přeložit nebo změnit.

Registrovaní uživatelé si mohou ve svých preferencích nastavit svůj vlastní jazyk rozhraní. V takovém případě přepíše výchozí jazyk rozhraní webu. MediaWiki také podporuje záložní jazyky: Pokud zpráva není dostupná ve zvoleném jazyce, zobrazí se v nejbližším možném jazyce, a ne nutně v angličtině. Například záložním jazykem pro bretonštinu je francouzština.

Uživatelé
Uživatelé jsou v kódu zastoupeni pomocí žádostí z třídy, která zahrnuje všechna uživatelská nastavení (ID uživatele, jméno, práva, heslo, e-mailová adresa atd.). Třídy klientů používají pro přístup k těmto polím přístupové objekty. Vykonávají veškerou práci při zjišťování, zda je uživatel přihlášen a zda lze požadovanou možnost uspokojit z cookies nebo zda je potřeba dotaz do databáze. Většina nastavení potřebných pro vykreslování normálních stránek je nastavena v cookie, aby se minimalizovalo používání databáze.

MediaWiki poskytuje velmi podrobný systém oprávnění, v podstatě s uživatelským oprávněním pro každou možnou akci. Například k provedení akce "Rollback" (tj. "rychle vrátit zpět úpravy posledního uživatele, který upravoval konkrétní stránku"), potřebuje uživatel oprávnění, které je standardně zahrnuto ve skupině   uživatelů MediaWiki. Může být ale také přidán do jiných uživatelských skupin nebo mít vyhrazenou uživatelskou skupinu poskytující pouze toto oprávnění (to je případ anglické Wikipedie se skupinou ). Přizpůsobení uživatelských práv se provádí úpravou pole  v. Například  umožňuje všem registrovaným uživatelům přejmenovat soubory. Uživatel může patřit do několika skupin a zdědí nejvyšší práva spojená s každou z nich.

Systém uživatelských oprávnění MediaWiki byl však skutečně navržen s ohledem na Wikipedii, tzn. web, jehož obsah je přístupný všem a pouze některé akce jsou omezeny na některé uživatele. MediaWiki postrádá jednotný, všudypřítomný koncept oprávnění. Neposkytuje tradiční funkce CMS, jako je omezení přístupu pro čtení nebo zápis podle jmenného prostoru, kategorie atd. Několik rozšíření MediaWiki takové funkce do určité míry poskytuje.

Obsah


Struktura obsahu
Koncept jmenných prostorů byl použit v éře UseModWiki Wikipedie, kde diskusní stránky měly název "". Jmenné prostory byly formálně zavedeny v prvním "PHP skriptu" Magnuse Manskeho. V průběhu let byly několikrát reimplementovány, ale zachovaly si stejnou funkci: Oddělit různé druhy obsahu. Skládají se z předpony oddělené od názvu stránky dvojtečkou (např.  nebo   a  ). Jmenný prostor hlavního obsahu nemá žádnou předponu. Uživatelé Wikipedie si je rychle osvojili a poskytli komunitě různé prostory k rozvoji. Jmenné prostory se ukázaly jako důležitá vlastnost MediaWiki, protože vytvářejí nezbytné předpoklady pro komunitu wikin a nastavují metaúrovňové diskuse, komunitní procesy, portály, uživatelské profily atd.

Výchozí konfigurace hlavního jmenného prostoru MediaWiki je plochá (žádné podstránky), protože tak funguje Wikipedie, ale je triviální je povolit. Jsou povoleny v jiných jmenných prostorech (např., kde lidé mohou například pracovat na konceptech článků) a zobrazují podrobnosti.

Jmenné prostory oddělují obsah podle typu. V rámci stejného jmenného prostoru lze stránky organizovat podle témat pomocí kategorií, což je pseudohierarchické organizační schéma zavedené v MediaWiki 1.3.



Zpracování obsahu: Značkovací jazyk MediaWiki & Parser
Uživatelsky generovaný obsah uložený na MediaWiki není v HTML, ale ve značkovém jazyce specifickém pro MediaWiki, někdy nazývaném "wikitext". Umožňuje uživatelům provádět změny formátování (např. tučné písmo, kurzívu pomocí uvozovek), přidávat odkazy (pomocí hranatých závorek), vkládat šablony, vkládat kontextově závislý obsah (jako je datum nebo podpis) a provádět neuvěřitelné množství dalších magických věcí. .

K zobrazení stránky je třeba tento obsah analyzovat, sestavit ze všech externích nebo dynamických částí, které volá, a převést do správného HTML. Analyzátor je jednou z nejdůležitějších částí MediaWiki, což také ztěžuje změny nebo vylepšení. Protože stovky milionů wiki stránek po celém světě závisí na analyzátoru, aby pokračoval ve výstupu HTML tak, jak to bylo vždy, musí zůstat extrémně stabilní.

Značkovací jazyk nebyl od začátku formálně specifikován. Začalo to na základě značky UseModWiki, pak se měnilo a vyvíjelo podle potřeb. Například použití formátu ThreadMode pro diskuse přimělo Magnuse Manskeho implementovat 3 nebo 4 vlnovky ( ~ ) jako zkratku pro podepisování příspěvků nestrukturovaným textem. Tildy byly vybrány, protože se podobaly vlastnoručně psanému podpisu jeho otce.

Při absenci formální specifikace se stal značkovací jazyk MediaWiki komplexním a svérázným jazykem, v zásadě kompatibilním pouze s analyzátorem MediaWiki. Nelze jej reprezentovat jako formální gramatiku pomocí syntaxe BNF, EBNF nebo ANTLR. Aktuální specifikace analyzátoru je vtipně označována jako "cokoli, co analyzátor vyplivne z wikitextu, plus několik stovek testovacích případů".

Bylo mnoho pokusů o alternativní parsery, ale žádný zatím neuspěl. V roce 2004 Jens Frank napsal experimentální tokenizér pro analýzu wikitextu a aktivoval ho na Wikipedii. Musel být deaktivován o tři dny později kvůli špatnému výkonu přidělování paměti pole PHP. Od té doby byla většina analýzy provedena pomocí obrovské hromady regulárních výrazů a spousty pomocných funkcí. Značení wiki a všechny speciální případy, které musí parser podporovat, se také značně zkomplikovaly, takže budoucí pokusy jsou ještě obtížnější.

Významným zlepšením bylo přepsání preprocesoru Timem Starlingem v MediaWiki 1.12, jehož hlavní motivací bylo zlepšit výkon analýzy na stránkách se složitými šablonami. Preprocesor převádí wikitext na strom XML DOM představující části dokumentu (vyvolání šablony, funkce analyzátoru, háčky tagů, záhlaví sekcí a několik dalších struktur), ale může přeskočit "mrtvé větve" při rozšiřování šablony, jako jsou nesledované případy  a nepoužité výchozí hodnoty pro argumenty šablony. Analyzátor poté prochází strukturou DOM a převádí její obsah do HTML.

Nedávné práce na vizuálním editoru pro MediaWiki si vyžádaly zlepšení procesu analýzy (a zrychlení), takže byla obnovena práce na analyzátoru a mezivrstvách mezi značkami MediaWiki a finálním HTML (viz Budoucnost, níže).



Kouzelná slova a šablony
MediaWiki nabízí "kouzelná slova", která upravují obecné chování stránky nebo do ní vkládají dynamický obsah. Skládají se z: Přepínačů chování jako  (pro skrytí automatického obsahu) nebo   (aby řekl vyhledávačům, aby stránku neindexovaly). Proměnné jako  nebo. A funkce parseru, tj. magická slova, která mohou mít parametry, jako  (pro výstup   malými písmeny). Konstrukty jako,   a  , používané k lokalizaci uživatelského rozhraní, jsou funkcemi analyzátoru.

Nejběžnějším způsobem, jak zahrnout obsah z jiných stránek na stránku MediaWiki, je použití šablon. Šablony byly skutečně určeny k použití k zahrnutí stejného obsahu na různé stránky, např. navigační panely nebo bannery údržby u článků Wikipedie. Schopnost vytvářet částečná rozvržení stránek a znovu je používat v tisících článků s centrální údržbou měla obrovský dopad na weby, jako je Wikipedie.

Šablony však také uživatelé používali (a zneužívali) ke zcela jinému účelu. MediaWiki 1.3 umožnila šablonám přebírat parametry, které mění jejich výstup. Možnost přidat výchozí parametr (zavedený v MediaWiki 1.6) umožnila konstrukci funkcionálního programovacího jazyka implementovaného nad PHP, což byla nakonec jedna z nejnáročnějších funkcí z hlediska výkonu.

Tim Starling poté vyvinul další funkce analyzátoru (rozšíření ParserFunctions), jako opatření proti šíleným konstrukcím vytvořeným uživateli Wikipedie pomocí šablon. Tato sada funkcí zahrnovala logické struktury jako  a   a další funkce jako   (pro vyhodnocení matematických výrazů) a   (pro formátování času).

Uživatelé Wikipedie začali brzy vytvářet ještě složitější šablony pomocí nových funkcí, což značně snížilo výkon analýzy na šablonově náročných stránkách. Nový preprocesor představený v MediaWiki 1.12 (velká architektonická změna) byl implementován, aby tento problém částečně napravil. Později vývojáři MediaWiki diskutovali o možnosti použití skutečného skriptovacího jazyka ke zlepšení výkonu. V únoru 2013 bylo přidáno.



Mediální soubory
Uživatelé nahrávají soubory prostřednictvím stránky. Administrátoři mohou nakonfigurovat povolené typy souborů prostřednictvím seznamu povolených přípon. Po nahrání se soubory uloží do složky v systému souborů a miniatury do vyhrazeného adresáře.

Kvůli vzdělávacímu poslání Wikimedie podporuje MediaWiki typy souborů, které mohou být neobvyklé v jiných webových aplikacích nebo CMS, jako jsou vektorové obrázky SVG a vícestránkové soubory PDF a DjVus. Jsou vykreslovány jako soubory PNG a lze je zobrazit v miniaturách a zobrazit v řádku, stejně jako běžnější obrázkové soubory, jako jsou GIF, JPG a PNG.

Když je soubor nahrán, je mu přiřazena stránka  obsahující informace zadané uživatelem, který jej nahrál. Jde o volný text, který obvykle obsahuje informace o autorských právech (autor, licence) a položky popisující nebo klasifikující obsah souboru (popis, umístění, datum, kategorie atd.). Zatímco soukromé wikiny se o tyto informace nemusí moc zajímat, v knihovnách médií, jako je Wikimedia Commons, jsou zásadní pro organizaci sbírky a zajištění zákonnosti sdílení těchto souborů. Tvrdilo se, že většina těchto metadat by ve skutečnosti měla být uložena v dotazovatelné struktuře, jako je tabulka databáze. To by značně usnadnilo vyhledávání, ale také přiřazení a opětovné použití třetími stranami – například prostřednictvím API.

Většina stránek Wikimedie také umožňuje „lokální“ nahrávání na každou wiki, ale komunita se snaží ukládat volně licencované mediální soubory do bezplatné knihovny médií Wikimedie, Wikimedia Commons. Jakýkoli web Wikimedie může zobrazit soubor hostovaný na Commons, jako by byl hostován lokálně. Tento zvyk se vyhne nutnosti nahrávat soubor na každou wiki, abyste jej tam mohli použít.

V důsledku toho MediaWiki nativně podporuje cizí úložiště médií, tj. možnost přístupu k mediálním souborům hostovaným na jiné wiki prostřednictvím jejího API a systému. Od verze 1.16 může jakýkoli web MediaWiki snadno používat soubory z Wikimedia Commons prostřednictvím funkce. Při použití cizího úložiště se miniatury ukládají lokálně, aby se ušetřila šířka pásma. Nahrát do cizího úložiště médií z jiné wiki však (zatím) není možné.



Úrovně
Architektura MediaWiki poskytuje různé způsoby přizpůsobení a rozšíření softwaru. To lze provést na různých úrovních přístupu:


 * Správci systému mohou instalovat rozšíření a vzhledy a konfigurovat samostatné pomocné programy wiki (např. pro miniatury obrázků a vykreslování TeXu) a globální nastavení (viz Konfigurace výše).
 * Wiki sysops (někdy také nazývaní "administrátoři") mohou upravovat gadgety pro celý web, JavaScript a nastavení CSS.
 * Každý registrovaný uživatel si může přizpůsobit své vlastní prostředí a rozhraní pomocí svých preferencí (pro stávající nastavení, vzhledy a gadgety) nebo provést své vlastní úpravy (pomocí svých osobních stránek JS a CSS). Externí programy mohou také komunikovat s MediaWiki prostřednictvím jeho strojového API, pokud je povoleno, v podstatě zpřístupňují jakoukoli funkci a data uživateli.



JavaScript a CSS
MediaWiki umí číst a používat JavaScript a CSS pro celý web nebo skin pomocí vlastních wiki stránek. Tyto stránky jsou ve jmenném prostoru, a proto je mohou upravovat pouze sysops. Například úpravy JavaScriptu od  platí pro všechny vzhledy, CSS od   platí pro všechny vzhledy, ale   platí pouze pro uživatele se zobrazením Vector.

Uživatelé mohou provádět stejné typy změn, které se budou týkat pouze jejich vlastního rozhraní, úpravou podstránek své uživatelské stránky (např.  na JavaScript na všech vzhledech,   na CSS na všech vzhledech nebo   na úpravy CSS, které se týkají pouze zobrazení Vector).

Pokud je nainstalováno rozšíření Gadgets, mohou sysops také upravovat miniaplikace, tzn. úryvky kódu JavaScript poskytující funkce, které mohou uživatelé zapínat a vypínat ve svých preferencích. Nadcházející vývoj nápadů umožní sdílet gadgety napříč wikinami, čímž se zabrání duplicitě.

Tato sada nástrojů měla obrovský dopad a výrazně zvýšila demokratizaci vývoje softwaru MediaWiki. Jednotliví uživatelé jsou oprávněni přidávat funkce pro sebe. Pokročilí uživatelé je mohou sdílet s ostatními, a to jak neformálně, tak prostřednictvím globálně konfigurovatelných systémů řízených sysopem. Tento rámec je ideální pro malé, samostatné úpravy a představuje nižší překážku vstupu než těžší úpravy kódu prováděné pomocí háčků a rozšíření.



Rozšíření a vzhledy
Když úpravy JavaScriptu a CSS nestačí, MediaWiki poskytuje systém háčků, který umožňuje vývojářům třetích stran spouštět vlastní PHP kód před, po nebo místo kódu MediaWiki pro konkrétní události. Rozšíření MediaWiki používají k připojení do kódu háčky.

Než v MediaWiki existovaly háčky, znamenalo přidání vlastního kódu PHP úpravu základního kódu, což nebylo snadné ani doporučené. První háčky byly navrženy a přidány v roce 2004 Evanem Prodromou. Mnoho dalších bylo přidáno v průběhu let, když bylo potřeba. Pomocí háčků je dokonce možné rozšířit značkování wiki MediaWiki o další možnosti pomocí rozšíření značek.

Systém rozšíření není dokonalý: Registrace rozšíření je založena na spuštění kódu při spuštění, spíše než na datech uložených do mezipaměti, což omezuje abstrakci a optimalizaci a poškozuje výkon MediaWiki. Celkově je ale architektura rozšíření nyní poměrně flexibilní infrastrukturou, která pomohla učinit specializovaný kód modulárnějším, což brání tomu, aby se základní software (příliš) rozšiřoval, a uživatelům třetích stran usnadňuje vytváření vlastních funkcí nad MediaWiki.

Naopak je velmi obtížné napsat nový vzhled pro MediaWiki, aniž byste znovu vynalezli kolo. V MediaWiki jsou vzhledy třídy PHP, z nichž každá rozšiřuje nadřazenou třídu. Obsahují funkce, které shromažďují informace potřebné pro generování HTML. Dlouhotrvající vzhled "MonoBook" bylo obtížné přizpůsobit, protože obsahoval spoustu CSS specifických pro prohlížeč pro podporu starých prohlížečů. Úprava šablony nebo CSS vyžadovala mnoho následných změn, aby změny odrážely všechny prohlížeče a platformy.

API
Dalším hlavním přístupovým bodem pro MediaWiki, kromě, je  , používaný pro přístup k jeho strojově čitelnému dotazovacímu API (Application Programming Interface).

Uživatelé Wikipedie původně vytvářeli "roboty", kteří fungovali pomocí snímání obrazovky obsahu HTML obsluhovaného MediaWiki. Tato metoda byla velmi nespolehlivá a mnohokrát se pokazila. Aby vývojáři tuto situaci zlepšili, představili rozhraní pouze pro čtení (umístěné na ), které se poté vyvinulo v plnohodnotné API pro čtení a zápis poskytující přímý přístup na vysoké úrovni k datům obsaženým v databázi MediaWiki.

Klientské programy mohou používat API k přihlášení, získávání dat a odesílání změn. Rozhraní API podporuje slabé webové klienty JavaScriptu a aplikace pro koncové uživatele. Téměř vše, co lze provést přes webové rozhraní, lze v podstatě provést prostřednictvím API. Klientské knihovny implementující MediaWiki API jsou dostupné v mnoha jazycích, včetně Pythonu a .NETu.

Budoucnost
To, co začalo jako letní projekt jednoho dobrovolného vývojáře PHP, se rozrostlo do MediaWiki, vyspělého, stabilního wiki motoru, který pohání top ten web se směšně malou provozní infrastrukturou. To bylo umožněno neustálou optimalizací výkonu, iterativními architektonickými změnami a týmem úžasných vývojářů.

Vývoj webových technologií a růst Wikipedie vyžadují neustálá vylepšování a nové funkce, z nichž některé vyžadují zásadní změny v architektuře MediaWiki. To je například případ probíhajícího projektu vizuálního editoru, který rychle obnovil práci na parseru a značkovacím jazyce wiki, DOM a finální konverzi HTML.

MediaWiki je nástroj, který se používá pro různé účely. V rámci projektů Wikimedie se například používá k vytváření a správě encyklopedie (Wikipedia), k napájení obrovské knihovny médií (Wikimedia Commons) nebo k přepisu naskenovaných referenčních textů (Wikisource); a tak dále. V jiných kontextech se MediaWiki používá jako firemní CMS nebo jako úložiště dat, někdy v kombinaci se sémantickým rámcem. Tato specializovaná použití, která nebyla plánována, budou pravděpodobně i nadále vést k neustálým úpravám vnitřní struktury softwaru. Architektura MediaWiki jako taková je velmi živá, stejně jako obrovská komunita uživatelů, které podporuje.

<span id="Notes_and_references">

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

Další informace

 * Dokumentace a podpora MediaWiki: https://www.mediawiki.org
 * Automaticky generovaná dokumentace MediaWiki: https://doc.wikimedia.org
 * Domas Mituzas, Wikipedie: interny webu, konfigurace, příklady kódu a problémy se správou, MySQL Users Conference, 2007. Celý text dostupný za http://dom.as/talks/
 * Faidon Liambotis, Infrastruktura Wikimedie, dotScale 2014. (video na YouTube)

<span id="See_also">

Související odkazy

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