Huggle  build:^490^dce1e5c
 All Classes Namespaces Functions Variables Enumerations Enumerator Pages
Huggle::Configuration Class Reference

Run time configuration of huggle. More...

#include <configuration.hpp>

Static Public Member Functions

static QString Bool2String (bool b)
 Bool2String Convert a bool to string. More...
 
static QString ConfigurationParse (QString key, QString content, QString missing="")
 Parse a string from configuration which has format used by huggle 2x. More...
 
static QStringList ConfigurationParse_QL (QString key, QString content, bool CS=false)
 ConfigurationParse_QL Parses a QStringList of values for a given key. More...
 
static QStringList ConfigurationParse_QL (QString key, QString content, QStringList list, bool CS=false)
 
static QString GetConfigurationPath ()
 Return a configuration path.
 
static QString GetDefaultRevertSummary (QString source)
 GetDefaultRevertSummary Retrieve default summary. More...
 
static QString GetURLProtocolPrefix ()
 Return a prefix for url.
 
static void InsertConfig (QString key, QString value, QXmlStreamWriter *s)
 InsertConfig. More...
 
static void LoadConfig ()
 Load the local configuration from disk.
 
static QString MakeLocalUserConfig ()
 This function creates a user configuration that is stored on wiki.
 
static void NormalizeConf ()
 
static bool ParseGlobalConfig (QString config)
 Parse all information from global config on meta.
 
static bool ParseLocalConfig (QString config)
 Parse all information from local config, this function is used in login. More...
 
static bool ParseUserConfig (QString config)
 
static bool SafeBool (QString value, bool defaultvalue=false)
 
static void SaveConfig ()
 Save the local configuration to file.
 

Static Public Attributes

static bool _SafeMode = false
 If this is true some functionalities will be disabled.
 
static bool AskUserBeforeReport = true
 Ask user if they really want to report someone.
 
static bool AutomaticallyResolveConflicts = false
 Resolve edit conflict without asking user.
 
static int Cache_InfoSize = 200
 Size of info cache.
 
static QString DefaultRevertSummary = "Reverted edits by $1 identified as vandalism"
 
static double EditCounter = 0
 Number of edits made since you logged in.
 
static QStringList EditRegexOfTools
 Regexes that other tools can be identified with.
 
static QString EditSuffixOfHuggle = "([[WP:HG]])"
 Suffix used by huggle.
 
static bool EnforceManualSoftwareRollback = false
 If this is true huggle will always use software rollback even if user has the rollback privileges.
 
static int FontSize = 10
 Size of fonts in diff.
 
static QString GlobalConfig_DocumentationPath = "https://www.mediawiki.org/wiki/Manual:Huggle"
 
static bool GlobalConfig_EnableAll = true
 
static QString GlobalConfig_FeedbackPath = "http://en.wikipedia.org/wiki/Wikipedia:Huggle/Feedback"
 
static QString GlobalConfig_LocalConfigWikiPath = "Project:Huggle/Config"
 
static QString GlobalConfig_MinVersion = HUGGLE_VERSION
 
static QString GlobalConfig_UserConf = "User:$1/huggle.css"
 
static QString GlobalConfigurationWikiAddress = "meta.wikimedia.org/w/"
 URL of wiki that contains a global config.
 
static bool GlobalConfigWasLoaded = false
 
static int HistorySize = 20
 Number of edits to keep in history stack.
 
static QString HomePath = QDir::currentPath()
 Path where huggle contains its data.
 
static QString HuggleVersion = HUGGLE_VERSION
 Version.
 
static QString IRCIdent = "huggle"
 Ident.
 
static QString IRCNick = "huggle"
 Nick.
 
static quint16 IRCPort = 6667
 Port.
 
static QString IRCServer = "irc.wikimedia.org"
 Server.
 
static QString Language = "en"
 Language selected by user this is only a language of interface.
 
static QString LocalConfig_AgfRevert = "Reverted good faith edits"
 
static bool LocalConfig_AIV = false
 
static bool LocalConfig_AIVExtend = true
 
static QStringList LocalConfig_Assisted
 
static QStringList LocalConfig_BlockExpiryOptions
 
static QString LocalConfig_BlockMessage = "{{subst:huggle/block|1=$1|2=$2}}"
 
static QString LocalConfig_BlockMessageIndef = "{{subst:huggle/block-indef|1=$1}}"
 
static QString LocalConfig_BlockReason = "[[WP:VAND|Vandalism]]"
 
static QString LocalConfig_BlockSummary = "Notification: Blocked"
 
static QString LocalConfig_BlockTime = "indefinite"
 
static QString LocalConfig_BlockTimeAnon = "31 hours"
 
static int LocalConfig_BotScore = -200
 
static QString LocalConfig_ClearTalkPageTemp = "{{Huggle/Cleared}}"
 
static bool LocalConfig_ConfirmMultipleEdits = false
 
static bool LocalConfig_ConfirmPage = false
 
static bool LocalConfig_ConfirmRange = false
 
static bool LocalConfig_ConfirmSame = false
 
static bool LocalConfig_ConfirmWarned = false
 
static QString LocalConfig_DefaultSummary = "Reverted edits by [[Special:Contributions/$1|$1]] ([[User talk:$1|talk]]) to last revision by $2"
 
static QStringList LocalConfig_DeletionTemplates
 
static bool LocalConfig_EnableAll = false
 
static bool LocalConfig_GlobalRequired = true
 
static QStringList LocalConfig_IgnorePatterns
 
static QStringList LocalConfig_Ignores
 
static int LocalConfig_IPScore = 800
 
static QString LocalConfig_IPVTemplateReport = ""
 IP vandals.
 
static QString LocalConfig_MinimalVersion = "3.0.0.0"
 Minimal version of huggle required to use it.
 
static QString LocalConfig_MultipleRevertSummary = "Reverted,edit by,edits by,and,other users,to last revision by,to an older version by"
 
static QString LocalConfig_NSCategory = MEDIAWIKI_DEFAULT_NS_CATEGORY
 
static QString LocalConfig_NSCategoryTalk = MEDIAWIKI_DEFAULT_NS_CATEGORYTALK
 
static QString LocalConfig_NSFile = MEDIAWIKI_DEFAULT_NS_FILE
 
static QString LocalConfig_NSFileTalk = MEDIAWIKI_DEFAULT_NS_FILETALK
 
static QString LocalConfig_NSHelp = MEDIAWIKI_DEFAULT_NS_HELP
 
static QString LocalConfig_NSHelpTalk = MEDIAWIKI_DEFAULT_NS_HELPTALK
 
static QString LocalConfig_NSMediaWiki = MEDIAWIKI_DEFAULT_NS_MEDIAWIKI
 
static QString LocalConfig_NSMediaWikiTalk = MEDIAWIKI_DEFAULT_NS_MEDIAWIKITALK
 
static QString LocalConfig_NSPortal = MEDIAWIKI_DEFAULT_NS_PORTAL
 
static QString LocalConfig_NSPortalTalk = MEDIAWIKI_DEFAULT_NS_PORTALTALK
 
static QString LocalConfig_NSProject = MEDIAWIKI_DEFAULT_NS_PROJECT
 
static QString LocalConfig_NSProjectTalk = MEDIAWIKI_DEFAULT_NS_PROJECTTALK
 
static QString LocalConfig_NSTalk = MEDIAWIKI_DEFAULT_NS_TALK
 
static QString LocalConfig_NSTemplate
 
static QString LocalConfig_NSTemplateTalk
 
static QString LocalConfig_NSUser = MEDIAWIKI_DEFAULT_NS_USER
 
static QString LocalConfig_NSUserTalk = MEDIAWIKI_DEFAULT_NS_USERTALK
 
static QString LocalConfig_ProtectReason = "Persistent [[WP:VAND|vandalism]]"
 
static QString LocalConfig_ReportPath = ""
 
static int LocalConfig_ReportSt = 0
 Section of report page to append template to.
 
static QString LocalConfig_ReportSummary = "Reporting user"
 
static bool LocalConfig_RequireAdmin = false
 
static int LocalConfig_RequireEdits = 0
 
static bool LocalConfig_RequireRollback = false
 
static QStringList LocalConfig_RevertPatterns
 
static QStringList LocalConfig_RevertSummaries
 
static QString LocalConfig_RollbackSummary = "Reverted edits by [[Special:Contributions/$1|$1]] ([[User talk:$1|talk]]) to last revision by $2"
 
static QString LocalConfig_RUTemplateReport = ""
 Regular users.
 
static int LocalConfig_ScoreChange = 100
 Score that is added for every edit that has really big size.
 
static int LocalConfig_ScoreFlag = -20000
 
static QList< ScoreWordLocalConfig_ScoreParts
 
static QList< ScoreWordLocalConfig_ScoreWords
 
static QString LocalConfig_SingleRevert = "Reverted edits by [[Special:Contributions/$1|$1]] ([[User talk:$1|talk]])"
 
static QString LocalConfig_SoftwareRevertDefaultSummary = "Reverted edits by [[Special:Contributions/$1|$1]] ([[User talk:$1|talk]]) to last revision by $2 using huggle software rollback (reverted by $3 revisions to revision $4)"
 
static int LocalConfig_TalkPageWarningScore = -800
 
static int LocalConfig_TemplateAge = -30
 
static QStringList LocalConfig_Templates
 
static bool LocalConfig_UAAavailable = false
 
static QString LocalConfig_UAAPath = "Project:Usernames for administrator attention"
 
static QString LocalConfig_UAATemplate = "* {{user-uaa|1=$1}} $2 ~~~~"
 
static QString LocalConfig_UndoSummary = "Undid edit by [[Special:Contributions/$1|$1]] ([[User talk:$1|talk]])"
 
static bool LocalConfig_UseIrc = false
 
static QStringList LocalConfig_WarningDefs
 
static int LocalConfig_WarningScore = 2000
 
static QStringList LocalConfig_WarningTemplates
 
static QStringList LocalConfig_WarningTypes
 
static QString LocalConfig_WarnSummary = "Warning (level 1)"
 
static QString LocalConfig_WarnSummary2 = "Warning (level 2)"
 
static QString LocalConfig_WarnSummary3 = "Warning (level 3)"
 
static QString LocalConfig_WarnSummary4 = "Warning (level 4)"
 
static QString LocalConfig_WelcomeAnon = "{{subst:Welcome-anon}} ~~~~"
 
static bool LocalConfig_WelcomeGood = true
 
static QString LocalConfig_WelcomeSummary = "Welcoming user"
 
static QString LocalConfig_WelcomeTitle = "Welcome"
 
static QStringList LocalConfig_WelcomeTypes
 
static int LocalConfig_WhitelistScore = -800
 
static bool NextOnRv = true
 
static QString Password = ""
 Password.
 
static WikiSite Project
 currently selected project
 
static QList< WikiSite * > ProjectList
 List of projects.
 
static int ProviderCache = 200
 Size of feed.
 
static bool PythonEngine = false
 Whether python is available.
 
static int QueryListTimeLimit = 2
 Number of seconds for which the processed queries remain in list of processes.
 
static bool QueueNewEditsUp = false
 Whether new edits go to top or bottom.
 
static int ReadTimeout = 60
 Timeout for queries.
 
static bool Restricted = false
 When this is true most of functions will not work.
 
static QStringList Rights
 
static int RingLogMaxSize = 2000
 Maximum size of ringlog.
 
static double RvCounter = 0
 Number of reverts made since you logged in.
 
static bool TrimOldWarnings = true
 This is experimental feature that removes the old templates from talk pages when they are being read.
 
static QString UserName = "User"
 User name.
 
static bool UsingIRC = true
 Whether IRC is being used.
 
static bool UsingSSL = true
 If SSL is being used.
 
static QString VandalNw_Ident
 
static bool VandalNw_Login = true
 
static QString VandalNw_Server = "hub.tm-irc.org"
 
static unsigned int Verbosity = 0
 Verbosity for debugging to terminal etc, can be switched with parameter –verbosity.
 
static bool WarnUserSpaceRoll = true
 Warn you in case you want to revert a user page.
 
static bool WelcomeEmpty = true
 Send a message to user on good edit.
 
static QString WelcomeMP = "Project:Huggle/Message"
 Where the welcome message is stored.
 
static QStringList WhiteList
 Data of wl.
 
static bool WhitelistDisabled = false
 Whitelist is not useable.
 
static QString WikiDB = Configuration::GetConfigurationPath() + "wikidb.xml"
 Path to a file where information about wikis are stored.
 
static QString WmfOAuthConsumerKey = "56a6d6de895e3b859faa57b677f6cd21"
 Consumer key. More...
 
static int WriteTimeout = 200
 Timeout for write / update queries.
 

Detailed Description

Run time configuration of huggle.

Definition at line 89 of file configuration.hpp.

Member Function Documentation

QString Configuration::Bool2String ( bool  b)
static

Bool2String Convert a bool to string.

Parameters
bbool
Returns
string

Definition at line 205 of file configuration.cpp.

Referenced by MakeLocalUserConfig(), and SaveConfig().

QString Configuration::ConfigurationParse ( QString  key,
QString  content,
QString  missing = "" 
)
static

Parse a string from configuration which has format used by huggle 2x.

Parameters
keyKey
contentText to parse from
missingDefault value in case this key is missing in text
Returns
Value of key

Definition at line 709 of file configuration.cpp.

Referenced by ParseGlobalConfig(), ParseLocalConfig(), and ParseUserConfig().

QStringList Configuration::ConfigurationParse_QL ( QString  key,
QString  content,
bool  CS = false 
)
static

ConfigurationParse_QL Parses a QStringList of values for a given key.

Parameters
keyKey
contentText to parse key from
CSWhether the values are separated by comma
Returns
List of values from text or empty list

Definition at line 410 of file configuration.cpp.

References Huggle::Core::Trim().

Referenced by ParseLocalConfig(), and ParseUserConfig().

QString Configuration::GetDefaultRevertSummary ( QString  source)
static

GetDefaultRevertSummary Retrieve default summary.

Parameters
sourceUser who should be replaced instead of $1
Returns
Default revert summary

Definition at line 198 of file configuration.cpp.

References EditSuffixOfHuggle.

Referenced by Huggle::RevertQuery::Rollback().

void Configuration::InsertConfig ( QString  key,
QString  value,
QXmlStreamWriter *  s 
)
static

InsertConfig.

Parameters
keyConfiguration key
valueValue of key
sStream writer

Definition at line 734 of file configuration.cpp.

Referenced by SaveConfig().

bool Configuration::ParseLocalConfig ( QString  config)
static
bool Configuration::ParseUserConfig ( QString  config)
static
Todo:
Lot of configuration options are missing

Definition at line 687 of file configuration.cpp.

References AutomaticallyResolveConflicts, ConfigurationParse(), ConfigurationParse_QL(), and EnforceManualSoftwareRollback.

Referenced by Huggle::Login::RetrievePrivateConfig().

Member Data Documentation

QString Configuration::WmfOAuthConsumerKey = "56a6d6de895e3b859faa57b677f6cd21"
static

Consumer key.

This is a consumer key for "huggle" on wmf wikis.

Definition at line 294 of file configuration.hpp.


The documentation for this class was generated from the following files: