info.bliki.wiki.filter

Class MagicWord

java.lang.Object

info.bliki.wiki.filter.MagicWord

public class MagicWord
extends Object

See Help:Magic words for a list of Mediawiki magic words.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MagicWord.MagicWordE Type of storing user contributions in the DB.

Field Summary

Fields

Modifier and Type	Field and Description
protected static HashMap<String,MagicWord.MagicWordE>	MAGIC_WORDS Magic words in lower case.

Constructor Summary

Constructors

Constructor and Description
MagicWord()

Method Summary

Modifier and Type	Method and Description
protected static String	getBasePageName(String parameter, IWikiModel model) Gets the base page name of a given non-null parameter or the current model's pagename and namespace.
protected static String	getFullpagename(String parameter, IWikiModel model) Gets the full page's name of a given non-null parameter or the current model's pagename and namespace.
static MagicWord.MagicWordE	getMagicWord(String name) Determine if a template name corresponds to a magic word requiring special handling.
protected static String	getNamespace(String parameter, IWikiModel model) Helper to get the namespace of either a given non-null parameter or the current model's namespace.
protected static INamespace.INamespaceValue	getNamespaceHelper(String parameter, IWikiModel model) Helper to get the namespace of either a given non-null parameter or the current model's namespace.
protected static String	getPagenameHelper(String parameter, IWikiModel model) Helper to get the pagename (excluding the namespace) of either a given non-null parameter or the current model's pagename.
protected static String[]	getPagenameHelper2(String parameter, IWikiModel model) Helper to get the pagename and the namespace of either a given non- null parameter or the current model's pagename and namespace.
protected static String	getSubjectpage(String parameter, IWikiModel model) Gets the talkpage's name of a given non-null parameter or the current model's pagename and namespace.
protected static String	getSubjectSpace(String parameter, IWikiModel model) Gets the subject/articlespace of a given non-null parameter or the current model's namespace.
protected static String	getSubPageName(String parameter, IWikiModel model) Gets the sub page name of a given non-null parameter or the current model's pagename and namespace.
protected static String	getTalkpage(String parameter, IWikiModel model) Gets the talkpage's name of a given non-null parameter or the current model's pagename and namespace.
protected static String	getTalkspace(String parameter, IWikiModel model) Gets the talkspace of a given non-null parameter or the current model's namespace.
static boolean	isMagicWord(String name) Determine if a template name corresponds to a magic word requiring special handling.
static String	processMagicWord(MagicWord.MagicWordE magicWord, String parameter, IWikiModel model) Process a magic word, returning the value corresponding to the magic word value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MAGIC_WORDS

protected static final HashMap<String,MagicWord.MagicWordE> MAGIC_WORDS

Magic words in lower case. Note: MediaWiki tolerates some variations in the case but they do not seem consistent, e.g. {{CURRENTYEAR}} {{currentyear}} {{Currentyear}} return the current year, {{CURRENTYeAR}} {{cURRENTYEAR}} don't. The following variations of {{SERVERNAME}} however all return the server name: {{SERVERNAME}} {{SERVeRNAMe}} {{sERVERNAME}} {{servername}} {{Servername}} Therefore, tolerate any case here and use lower-case in this hashmap.

Constructor Detail

MagicWord

public MagicWord()

Method Detail

isMagicWord

public static boolean isMagicWord(String name)

Determine if a template name corresponds to a magic word requiring special handling. See Help:Magic words for a list of Mediawiki magic words.

Parameters:

name - the potential magic word

Returns:

true if name was a magic word, false otherwise

getMagicWord

public static MagicWord.MagicWordE getMagicWord(String name)

Determine if a template name corresponds to a magic word requiring special handling. See Help:Magic words for a list of Mediawiki magic words.

Parameters:

name - the potential magic word

Returns:

if name was a magic word: the corresponding MagicWord.MagicWordE, otherwise null

processMagicWord

public static String processMagicWord(MagicWord.MagicWordE magicWord,
                                      String parameter,
                                      IWikiModel model)

Process a magic word, returning the value corresponding to the magic word value. See Help:Magic words for a list of Mediawiki magic words.

Parameters:

magicWord - the magic word to process

parameter - the parameter of the magic word (may be null if no parameter supplied)

model - the wiki model to use while rendering

Returns:

the processed magic word content or its name if unprocessed

getSubPageName

protected static String getSubPageName(String parameter,
                                       IWikiModel model)

Gets the sub page name of a given non-null parameter or the current model's pagename and namespace.

Parameters:

parameter - the parameter of the magic word

model - the model being used

Returns:

the sub page name (or the pagename if there is no sub-page)

getBasePageName

protected static String getBasePageName(String parameter,
                                        IWikiModel model)

Gets the base page name of a given non-null parameter or the current model's pagename and namespace.

Parameters:

parameter - the parameter of the magic word

model - the model being used

Returns:

the base page name

getFullpagename

protected static String getFullpagename(String parameter,
                                        IWikiModel model)

Gets the full page's name of a given non-null parameter or the current model's pagename and namespace.

Parameters:

parameter - the parameter of the magic word (may be null)

model - the model being used

Returns:

the (normalised) name of the page

getSubjectpage

protected static String getSubjectpage(String parameter,
                                       IWikiModel model)

Gets the talkpage's name of a given non-null parameter or the current model's pagename and namespace.

Parameters:

parameter - the parameter of the magic word (may be null)

model - the model being used

Returns:

the name of the talkpage

getTalkpage

protected static String getTalkpage(String parameter,
                                    IWikiModel model)

Gets the talkpage's name of a given non-null parameter or the current model's pagename and namespace.

Parameters:

parameter - the parameter of the magic word (may be null)

model - the model being used

Returns:

the name of the talkpage

getTalkspace

protected static String getTalkspace(String parameter,
                                     IWikiModel model)

Gets the talkspace of a given non-null parameter or the current model's namespace.

Parameters:

parameter - the parameter of the magic word (may be null)

model - the model being used

Returns:

the talkspace

getSubjectSpace

protected static String getSubjectSpace(String parameter,
                                        IWikiModel model)

Gets the subject/articlespace of a given non-null parameter or the current model's namespace.

Parameters:

parameter - the parameter of the magic word (may be null)

model - the model being used

Returns:

the subjectspace

getNamespace

protected static String getNamespace(String parameter,
                                     IWikiModel model)

Helper to get the namespace of either a given non-null parameter or the current model's namespace.

Parameters:

parameter - the parameter of the magic word (may be null)

model - the model being used

Returns:

the extracted namespace or "" if the parameter was empty

getNamespaceHelper

protected static INamespace.INamespaceValue getNamespaceHelper(String parameter,
                                                               IWikiModel model)

Helper to get the namespace of either a given non-null parameter or the current model's namespace.

Parameters:

parameter - the parameter of the magic word (may be null)

model - the model being used

Returns:

the extracted namespace or null if the parameter was empty

getPagenameHelper

protected static String getPagenameHelper(String parameter,
                                          IWikiModel model)

Helper to get the pagename (excluding the namespace) of either a given non-null parameter or the current model's pagename.

Parameters:

parameter - the parameter of the magic word (may be null)

model - the model being used

Returns:

the extracted pagename or null if the parameter was empty

getPagenameHelper2

protected static String[] getPagenameHelper2(String parameter,
                                             IWikiModel model)

Helper to get the pagename and the namespace of either a given non- null parameter or the current model's pagename and namespace.

Parameters:

parameter - the parameter of the magic word (may be null)

model - the model being used

Returns:

a 2-element array with the namespace (index 0) and the page title (index 1) or null if the parameter was empty