Wikipedia:Lua/Modul/AccountUtl/en

Vorlagenprogrammierung Diskussionen Lua Test Unterseiten
Modul Deutsch English Modul: Dokumentation

AccountUtl – Library module with functions about user accounts.

Functions for templates

All these functions expect just one parameter, which submits a presumable account name for analysis.

The is… return

isAnon
Is username an anonymous account, matching either IP or temporary scheme?
isIP
Is this a valid IP, as IPv4 or IPv6, and formatted as submitted by Wiki software?
isTemp
Is this a temporary account as created by Wiki software?
isUser
Is this any valid account?
isValid
Is this name valid for registration?
scope
Type of a presumed account name
  • R – registration
  • I – IP
  • T – temporary
  • empty – invalid
signer
account name
  • empty – invalid
failsafe

The Failsafe interface is heading for version management of globally distributed Lua modules. It enables modules equipped with this interface to

  • ensure, that a library module required by a template or another module available as local copy does support certain functionality, or complain if not.
  • administrate global updating and linking of module codes via Wikidata.

The Failsafe interface is present both at template level and for direct Lua access.

The functions in detail are (not all supported yet completely by every library):

Parameter
Value Result current
nothing
false
local version ID »2026-09-08«
Minimal version version ID required at least
date in ISO format

It will be compared whether the current local implementation matches this version or later.

  • empty, if minimal version not achieved
  • 2001-01-01 → »2026-09-08«
  • 2099-01-01 → »«
wikidata version ID of global upstream
  • version ID at Wikidata
  • local, if not found there
»2026-09-08«
item ID of the Wikidata item
  • empty if not defined
Q139309150
~ Corresponding version ID locally and registered at Wikidata
  • empty, if up to date
  • version ID at Wikidata, if not equal
»«
@ Is the current (module) page linked correctly with Wikidata item?
  • empty, if linked to the item which is supposed
  • Iitem ID, if not
The return value is in template programming empty or under Lua false, otherwis a non-empty string as described.

Examples (test page)

A test page illustrates practical use.

Functions for Lua modules (API)

All functions described above can be used by other modules:

local lucky, AccountUtl = pcall( require, "Module:AccountUtl" )
if type( AccountUtl ) == "table" then
    AccountUtl = AccountUtl()
else
    -- error case; AccountUtl contains error message
    return "<span class=\"error\">" .. AccountUtl .. "</span>"
end

Subsequently there are available:

AccountUtl.isAnon( ask )
AccountUtl.isIP( ask )
AccountUtl.isTemp( ask )
AccountUtl.isUser( ask )
AccountUtl.isValid( ask )
AccountUtl.scope( ask )
AccountUtl.signer( ask )
AccountUtl.failsafe( atleast )
Versioning interface
  1. atleast
    optional
    nil or minimum version or wikidata or ~ for synchronisation
returns: Version ID as string or false

Usage

General library; no limitations.

Dependencies

No modules.