Voir la source de Initiation au Lua avec Scribunto/Librairie Site

{{Chapitre
  | idfaculté  = informatique
  | précédent  = [[../Librairie Message/]]
  | suivant    = [[../Quelques compléments/]]
  | page_liée  = Exercices/Sur les librairies Scribunto
  | numéro     = 18
  | niveau     = 10
}}
__TOC__
{{Clr}}
== Présentation de la librairie Site  ==

La librairie Site permet d'obtenir des renseignements sur le projet sur lequel le programme Lua tourne.

<br />

== Objets de la librairie Site  ==

Les exemples de ce chapitre se trouveront dans le [[Module:Site]]


Nous commencerons par visualiser le contenu de la librairie Site grâce au programme suivant :

<syntaxhighlight lang="lua">
local p = {}

function p.visualisation(frame)
	reponse = ""
	for index, objet in pairs(mw.site) do
		reponse = reponse.."<br />À la clé "..index..", on trouve un objet de type : "..type(objet)
	end
	return reponse
end

return p
</syntaxhighlight>


'''<nowiki>{{#invoke:Site|visualisation}}</nowiki>''' nous donne : {{#invoke:Site|visualisation}}


Nous voyons que nous avons une fonction, 5 tables et 5 chaînes de caractères.


Étudions ces objets :


==== mw.site.stats ====

'''mw.site.stats''' est une table contenant diverses statistiques. Pour nous mettre en appétit, nous commencerons donc par un programme permettant de visualiser le contenu de cette table.

<syntaxhighlight lang="lua">
local p = {}

function p.visustat()
	reponse = ""
	for index, objet in pairs(mw.site.stats) do
		reponse = reponse.."<br />À la clé "..index..", on trouve un objet de type : "..type(objet)
	end
	return reponse
end

return p
</syntaxhighlight>


'''<nowiki>{{#invoke:Site|visustat}}</nowiki>''' nous donne : {{#invoke:Site|visustat}}


Nous voyons déjà qu’il y a 7 nombres. En fait, il aurait pu y en avoir 8.


Les nombres disponibles de cette table sont :
* '''pages''' : nombre de pages dans le wiki
* '''articles''' : nombre d’articles dans le wiki
* '''files''' : nombre de fichiers dans le wiki
* '''edits''' : nombre d'éditions dans le wiki
* '''views''' : nombre de visualisation dans le wiki. Non disponible si [[mw:Manual:$wgDisableCounters|$wgDisableCounters]] est présent
* '''users''' : nombre d'utilisateurs dans le wiki
* '''activeUsers''' : nombre d'utilisateurs actifs dans le wiki
* '''admins''' : nombre d'utilisateurs dans le groupe 'sysop' dans le wiki


Par curiosité, écrivons donc un autre programme donnant les statistiques de la Wikiversité :

<syntaxhighlight lang="lua">
local p = {}

function p.visuversite()
	reponse = "La Wikiversité comprend :<br />"
	reponse = reponse..mw.site.stats.pages.." pages.<br />"
	reponse = reponse..mw.site.stats.articles.." articles.<br />"
	reponse = reponse..mw.site.stats.files.." fichiers.<br />"
	reponse = reponse..mw.site.stats.edits.." éditions.<br />"
	reponse = reponse..mw.site.stats.users.." utilisateurs.<br />"
	reponse = reponse..mw.site.stats.activeUsers.." utilisateurs actifs.<br />"
	reponse = reponse..mw.site.stats.admins.." arministrateurs.<br />"
	return reponse
end

return p
</syntaxhighlight>

'''<nowiki>{{#invoke:Site|visuversite}}</nowiki>''' nous donne : {{#invoke:Site|visuversite}}


Dans notre table '''mw.site.stats''', nous avons vu qu’il y avait aussi trois fonctions. Les trois prochains paragraphes seront consacrés à étudier ces trois fonctions :

<br />

==== mw.site.stats.usersInGroup ====

{{...}}

<code style="white-space:nowrap">mw.site.stats.usersInGroup( group )</code>

Retourne le nombre d'utilisateurs dans le groupe indiqué.

<br />

==== mw.site.stats.pagesInCategory ====

{{...}}

<code style="white-space:nowrap">mw.site.stats.pagesInCategory( category, which )</code>

: '''Cette fonction est [[mw:Manual:$wgExpensiveParserFunctionLimit|coûteuse]]'''

Retourne des statistiques sur la catégorie. Si <code>which</code> est non précisé, vaut ''nil'', ou "*", cette fonction retourne une table avec les éléments suivants :
* '''all''' : total des éléments ci-dessous
* '''subcats''' : nombre de sous-catégories
* '''files''' : nombre de fichiers
* '''pages''' : nombre de pages

Si <code>which</code> est l'une des clés ci-dessus seule la valeur correspondante est retournée, sous forme de nombre.

Chaque appel à cette fonction incrémente le compteur de « fonctions coûteuses ».

<br />

==== mw.site.stats.pagesInNamespace ====

<code style="white-space:nowrap">mw.site.stats.pagesInNamespace( ns )</code>

Retourne le nombre de pages dans l'espace de noms indiqué (indiqué par son numéro).

Nous allons enfin savoir combien il y a de pages dans chaque espace de la Wikiversité.

<syntaxhighlight lang="lua">
local p = {}

function p.visuespace()
	reponse = "La Wikiversité comprend :<br />"
	reponse = reponse..mw.site.stats.pagesInNamespace(0).." pages dans l'espace principal.<br />"
	reponse = reponse..mw.site.stats.pagesInNamespace(1).." pages dans l'espace discussion.<br />"
	reponse = reponse..mw.site.stats.pagesInNamespace(2).." pages dans l'espace utilisateur.<br />"
	reponse = reponse..mw.site.stats.pagesInNamespace(3).." pages dans l'espace discussion utilisateur.<br />"
	reponse = reponse..mw.site.stats.pagesInNamespace(4).." pages dans l'espace Wikiversité.<br />"
	reponse = reponse..mw.site.stats.pagesInNamespace(5).." pages dans l'espace discussion Wikiversité.<br />"
	reponse = reponse..mw.site.stats.pagesInNamespace(6).." pages dans l'espace fichier.<br />"
	reponse = reponse..mw.site.stats.pagesInNamespace(7).." pages dans l'espace discussion fichier.<br />"
	reponse = reponse..mw.site.stats.pagesInNamespace(8).." pages dans l'espace Média Wiki.<br />"
	reponse = reponse..mw.site.stats.pagesInNamespace(9).." pages dans l'espace discussion Média Wiki.<br />"
	reponse = reponse..mw.site.stats.pagesInNamespace(10).." pages dans l'espace modèle.<br />"
	reponse = reponse..mw.site.stats.pagesInNamespace(11).." pages dans l'espace discussion modèle.<br />"
	reponse = reponse..mw.site.stats.pagesInNamespace(12).." pages dans l'espace aide.<br />"
	reponse = reponse..mw.site.stats.pagesInNamespace(13).." pages dans l'espace discussion aide.<br />"
	reponse = reponse..mw.site.stats.pagesInNamespace(14).." pages dans l'espace catégorie.<br />"
	reponse = reponse..mw.site.stats.pagesInNamespace(15).." pages dans l'espace discussion catégorie.<br />"
	reponse = reponse..mw.site.stats.pagesInNamespace(102).." pages dans l'espace projet.<br />"
	reponse = reponse..mw.site.stats.pagesInNamespace(103).." pages dans l'espace discussion projet.<br />"
	reponse = reponse..mw.site.stats.pagesInNamespace(104).." pages dans l'espace recherche.<br />"
	reponse = reponse..mw.site.stats.pagesInNamespace(105).." pages dans l'espace discussion recherche.<br />"
	reponse = reponse..mw.site.stats.pagesInNamespace(106).." pages dans l'espace Faculté.<br />"
	reponse = reponse..mw.site.stats.pagesInNamespace(107).." pages dans l'espace discussion Faculté.<br />"
	reponse = reponse..mw.site.stats.pagesInNamespace(108).." pages dans l'espace Département.<br />"
	reponse = reponse..mw.site.stats.pagesInNamespace(109).." pages dans l'espace discussion Département.<br />"
	reponse = reponse..mw.site.stats.pagesInNamespace(110).." pages dans l'espace Transwiki.<br />"
	reponse = reponse..mw.site.stats.pagesInNamespace(111).." pages dans l'espace discussion Transwiki.<br />"
	reponse = reponse..mw.site.stats.pagesInNamespace(828).." pages dans l'espace module.<br />"
	reponse = reponse..mw.site.stats.pagesInNamespace(829).." pages dans l'espace discussion module.<br />"
	return reponse
end

return p
</syntaxhighlight>

'''<nowiki>{{#invoke:Site|visuespace}}</nowiki>''' nous donne : {{#invoke:Site|visuespace}}

'''Remarque :''' Contrairement à ce que l’on voit ci-dessus, le mot magique <nowiki>{{NUMBEROFARTICLES}}</nowiki> nous indique seulement {{NUMBEROFARTICLES}} pages dans l'espace principal. C'est parce-que les redirections ne sont pas comptées.

<br />

==== mw.site.siteName ====

{{...}}

La valeur de [[mw:Manual:$wgSitename|$wgSitename]].

<br />

==== mw.site.currentVersion ====

{{...}}

Une chaîne contenant la version actuelle de MediaWiki.

<br />

==== mw.site.interwikiMap ====

{{...}}

<code style="white-space:nowrap">mw.site.interwikiMap( filter )</code>

Returns a table holding data about available [[Manual:Interwiki|interwiki]] prefixes. If <code>filter</code> is the string "local", then only data for local interwiki prefixes is returned. If <code>filter</code> is the string "!local", then only data for non-local prefixes is returned. If no filter is specified, data for all prefixes is returned. A "local" prefix in this context is one that is for the same project. For example, on the English Wikipedia, other-language Wikipedias are considered local, while Wiktionary and such are not.

Keys in the table returned by this function are interwiki prefixes, and the values are subtables with the following properties:

* '''prefix''' - the interwiki prefix.
* '''url''' - the URL that the interwiki points to. The page name is represented by the parameter $1.
* '''isProtocolRelative''' - a boolean showing whether the URL is stored as a protocol-relative URL in the database. Note that if this is true, the URL in the "url" parameter will not be protocol-relative. Instead it will start with "http" or "https" depending on the protocol that the page is accessed with.
* '''isLocal''' - whether the URL is for a site in the current project.
* '''isCurrentWiki''' - whether the URL is for the current wiki.
* '''isTranscludable''' - whether pages using this interwiki prefix are [[mw:Transclusion|transcludable]].
* '''isExtraLanguageLink''' - whether the interwiki is listed in [[mw:Manual:$wgExtraInterlanguageLinkPrefixes|$wgExtraInterlanguageLinkPrefixes]].
* '''displayText''' - for links listed in $wgExtraInterlanguageLinkPrefixes, this is the display text shown for the interlanguage link. Nil if not specified.
* '''tooltip''' - for links listed in $wgExtraInterlanguageLinkPrefixes, this is the tooltip text shown when users hover over the interlanguage link. Nil if not specified.

<br />

==== mw.site.talkNamespaces ====

{{...}}

Table contenant uniquement les espaces de nom de discussion, indexé par leur numéro. Voir [[#mw.site.namespaces|mw.site.namespaces]].

<br />

==== mw.site.scriptPath ====

{{...}}

La valeur de [[mw:Manual:$wgScriptPath|$wgScriptPath]].

<br />

==== mw.site.server ====

{{...}}

La valeur de [[mw:Manual:$wgServer|$wgServer]].

<br />

==== mw.site.stylePath ====

{{...}}

La valeur de [[mw:Manual:$wgStylePath|$wgStylePath]].

<br />

==== mw.site.namespaces ====

{{...}}

Table contenant les informations sur tous les espaces de noms, indexés par leur numéro :
* '''id''' : numéro de l'espace de noms
* '''name''' : nom local de l'espace de noms
* '''canonicalName''' : nom générique de l'espace de noms
* '''displayName''' : fixé pour l'espace de noms 0 : le nom à utiliser pour affichage, car ''name'' vaut la chaîne vide sur la plupart des wikis
* '''hasSubpages''' : est-ce que les sous-pages sont actives pour cet espace de noms
* '''hasGenderDistinction''' : est-ce que l'espace de noms a des alias différents selon le genre
* '''isCapitalized''' : est-ce que la première lettre des pages de cet espace de noms doit être mise en majuscule
* '''isContent''' : est-ce un espace de noms pour du ''contenu''
* '''isIncludable''' : est-ce que les pages de cet espace de noms peuvent être transclues
* '''isMovable''' : est-ce que les pages de cet espace de noms peuvent être déplacées
* '''isSubject''' : est-ce que c’est un espace de noms de sujet (''subject namespace'')
* '''isTalk''' : est un espace de noms de discussion
* '''defaultContentModel''' : Le type de contenu par défaut pour l'espace de noms, sous forme de chaîne. (Voir [[mw:Manual:ContentHandler]].)
* '''aliases''' : liste des alias pour cet espace de noms
* '''subject''' : référence vers l'espace de noms sujet de cet espace de noms
* '''talk''' : référence vers l'espace de noms de discussion de cet espace de noms
* '''associated''' : référence à l'espace de noms associé (Discussion MediaWiki pour MediaWiki par exemple, et vice-versa)

Une méta-table est présente pour permettre de chercher un espace de noms par son nom (localisé ou générique). Par exemple <code>mw.site.namespaces[4]</code> et <code>mw.site.namespaces.Project</code> retourneront la même chose.

<br />

==== mw.site.subjectNamespaces ====

{{...}}

Table contenant uniquement les espaces de nom de sujets, indexés par leur numéro. Voir [[#mw.site.namespaces|mw.site.namespaces]].

<br />

==== mw.site.contentNamespaces ====

{{...}}

Table contenant uniquement les espaces de nom de contenu, indexés par leur numéro. Voir [[#mw.site.namespaces|mw.site.namespaces]].

<br />

{{Bas de page
  | idfaculté  = informatique
  | précédent  = [[../Librairie Message/]]
  | suivant    = [[../Quelques compléments/]]
}}