Configuration.cs

//This is a source code or part of Huggle project
//
//This file contains code for configuration

/// <DOCUMENTATION>
/// This file contains runtime configs
/// </DOCUMENTATION>

//Copyright (C) 2011-2012 Huggle team

//This program is free software: you can redistribute it and/or modify
//it under the terms of the GNU General Public License as published by
//the Free Software Foundation, either version 3 of the License, or
//(at your option) any later version.

//This program is distributed in the hope that it will be useful,
//but WITHOUT ANY WARRANTY; without even the implied warranty of
//MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//GNU General Public License for more details.


using System;
using System.Collections.Generic;
using System.Text.RegularExpressions;
using System.Text;

namespace huggle3
{
    /// <summary>
    /// Config
    /// </summary>
    static class Config
    {
        /// <summary>
        /// The size of the contribs block.
        /// </summary>
        public readonly static int ContribsBlockSize  = 100;
        /// <summary>
        /// The size of the history block.
        /// </summary>
        public readonly static int HistoryBlockSize  = 200;
        /// <summary>
        /// The history scroll speed.
        /// </summary>
        public readonly static int HistoryScrollSpeed = 40;
        /// <summary>
        /// The full size of the history block.
        /// </summary>
        public readonly static int FullHistoryBlockSize = 500;
        /// <summary>
        /// The irc connection timeout.
        /// </summary>
        public readonly static int IrcConnectionTimeout = 60000;
        /// <summary>
        /// The local config location.
        /// </summary>
        public readonly static string LocalConfigLocation = "config.txt";
        /// <summary>
        /// The request timeout.
        /// </summary>
        public readonly static int RequestTimeout = 30000;
        /// <summary>
        /// The size of the queue.
        /// </summary>
        public static int QueueSize = 5000;
        /// <summary>
        /// The history lenght.
        /// </summary>
        public static int HistoryLenght = 1000;
        /// <summary>
        /// The history trim.
        /// </summary>
        public static int HistoryTrim = 400;
        /// <summary>
        /// The width of the queue.
        /// </summary>
        public static int QueueWidth = 160; // main form
        /// <summary>
        /// The request attempts.
        /// </summary>
        public static int RequestAttempts = 3;
        /// <summary>
        /// The request retry interval.
        /// </summary>
        public static int RequestRetryInterval = 1000;
        /// <summary>
        /// Short path for wiki
        /// </summary>
        public readonly static string ShortWikiPath = "wiki/";
        /// <summary>
        /// Location of the global config file
        /// </summary>
        public readonly static string GlobalConfigLocation = "Huggle/Config";
        /// <summary>
        /// Short path for root of wiki
        /// </summary>
        public readonly static string WikiPath = "w/";
        /// <summary>
        /// URL to metawiki
        /// </summary>
        public static string Metawiki = "http://meta.wikimedia.org/";
        /// <summary>
        /// The current whitelist
        /// </summary>
        public static List<string> Whitelist = new List<string>();
        /// <summary>
        /// All lists
        /// </summary>
        public static Dictionary<string, List<string>> AllLists = new Dictionary<string,List<string>>();
        
        // Be carefull when changing anything below, never use those variables unless you know what you do:
        // !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
        /// <summary>
        /// Always true on testing or devel
        /// </summary>
        public readonly  static bool Beta = true;
        /// <summary>
        /// never commit changes to this unless you are release manager
        /// </summary>
        public static platform _Platform = platform.windows32;
        /// <summary>
        /// if this is true huggle will bypass some stuff and produce special output
        /// </summary>
        public static bool devs = true;
        
        // !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
        
        /// <summary>
        /// Dirrent types of wiki edit
        /// </summary>
        public readonly static string[] EditTypes = { "blocknote", "deletenote", "deletetag", "deletereq", "manual", "message", "note", "prodtag", "protectreq", "report", "revert", "speedytag", "tag", "warning" };
        /// <summary>
        /// location of queue
        /// </summary>
        public static int QueueTop = 80;
        /// <summary>
        /// queue left.
        /// </summary>
        public static int QueueLeft = 20;
        
        
        //////////
        //Values only used at runtime
        //////////
        
        /// <summary>
        /// Has the user config changed
        /// </summary>
        public static bool ConfigChanged = false;
        /// <summary>
        /// The config version.
        /// </summary>
        public static Version ConfigVersion = new Version(0, 0, 0);
        /// <summary>
        /// Default Language
        /// </summary>
        public static string DefaultLanguage = "en";
        /// <summary>
        /// Pending requests
        /// </summary>
        public static List<RequestCore.Request> PendingRequests = new List<RequestCore.Request>();
        /// <summary>
        /// Languages info
        /// </summary>
        public static List<string> Languages = new List<string>();
        /// <summary>
        /// Latest version of huggle
        /// </summary>
        public static Version LatestVersion = new Version(0, 0, 0);
        /// <summary>
        /// Content of languages
        /// </summary>
        public static Dictionary<string, Dictionary<string, string>> Messages = new Dictionary<string,Dictionary<string,string>>();
        /// <summary>
        /// User password preconfigured with something, to avoid potential
        /// issue with mw api (it must not be blank)
        /// </summary>
        public static string Password = "xx";
        /// <summary>
        /// The warning messages list
        /// </summary>
        public static Dictionary<string, string> WarningMessages = new Dictionary<string,string>();
        
        //////////
        //Values stored in local config file
        //////////
        
        /// <summary>
        /// Language to be used by huggle
        /// </summary>
        public static string Language = "en";
        /// <summary>
        /// Proxy Username
        /// </summary>
        public static string ProxyUsername = "";
        /// <summary>
        /// Proxy User domain
        /// </summary>
        public static string ProxyUserDomain = "";
        /// <summary>
        /// Proxy Server
        /// </summary>
        public static string ProxyServer = "";
        /// <summary>
        /// Proxy Port
        /// </summary>
        public static string ProxyPort = "";
        /// <summary>
        /// Is the proxy enabled
        /// </summary>
        public static bool ProxyEnabled = false;
        /// <summary>
        /// SSL
        /// </summary>
        public static bool UseSsl = true;
        /// <summary>
        /// Remeber the user username on login
        /// </summary>
        public static bool RememberMe = true;
        /// <summary>
        /// remeber the user password on login
        /// </summary>
        public static bool RememberPassword = false;
        /// <summary>
        /// Username
        /// </summary>
        public static string Username = "";
        /// <summary>
        /// State
        /// </summary>
        public static bool WindowMaximize = true;
        /// <summary>
        /// Position of main
        /// </summary>
        public static System.Drawing.Point WindowPosition = new System.Drawing.Point();
        /// <summary>
        /// Size
        /// </summary>
        public static System.Drawing.Size WindowSize = new System.Drawing.Size();
        /// <summary>
        /// Size
        /// </summary>
        public static int ItemSize = 17;
        
        
        //////////
        //Values changeable through global / project / user config pages
        //////////
        
        /// <summary>
        /// If requires an approval on special page
        /// </summary>
        public static bool Approval = false;
        /// <summary>
        /// Automaticaly advance
        /// </summary>
        public static bool AutoAdvance = false;
        /// <summary>
        /// Report users without prompt
        /// </summary>
        public static bool AutoReport = true;
        /// <summary>
        /// Automaticaly submit messages to talk
        /// </summary>
        public static bool AutoWarn = true;
        /// <summary>
        /// Comment me (better :))
        /// </summary>
        public static bool AutoWhitelist = true; // Update whitelist
        /// <summary>
        /// Block is allowed over huggle
        /// </summary>
        public static bool Block = false;
        /// <summary>
        /// Summaries of others
        /// </summary>
        public static List<string> AssistedSummaries = new List<string>();  
        /// <summary>
        /// Options for block
        /// </summary>
        public static List<string> BlockExpiryOptions = new List<string>();
        /// <summary>
        /// Block message
        /// </summary>
        public static string BlockMessage; 
        /// <summary>
        /// Use default message instead of preconfigured ones
        /// </summary>
        public static bool BlockMessageDefault = true;
        /// <summary>
        /// Message for indefinite block
        /// </summary>
        public static string BlockMessageIndef = "";
        /// <summary>
        /// Default block reason
        /// </summary>
        public static string BlockReason = "";
        /// <summary>
        /// Summary
        /// </summary>
        public static string BlockSummary = "";
        /// <summary>
        /// Block time
        /// </summary>
        public static string BlockTime = "indefinite";
        /// <summary>
        /// block time
        /// </summary>
        public static string BlockTimeAnon = "24 hours";
        /// <summary>
        /// Summary for config
        /// </summary>
        public static string ConfigSummary = "";
        /// <summary>
        /// Confirm if revert ignored user
        /// </summary>
        public static bool ConfirmIgnored = true;
        /// <summary>
        /// Confirm if do action on more users
        /// </summary>
        public static bool ConfirmMultiple = false;
        /// <summary>
        /// Confirm page
        /// </summary>
        public static bool ConfirmPage = true;
        /// <summary>
        /// Confirm if user belong to same ip range
        /// </summary>
        public static bool ConfirmRange = true;
        /// <summary>
        /// If slow irc mode is active
        /// </summary>
        public static bool SlowIrc = true;
        /// <summary>
        /// Confirm if revert to same id
        /// </summary>
        public static bool ConfirmSame = true;
        /// <summary>
        /// Confirm self
        /// </summary>
        public static bool ConfirmSelfRevert = true;
        /// <summary>
        /// Confirm revert of warned user
        /// </summary>
        public static bool ConfirmWarned = true;
        /// <summary>
        /// Count batch size
        /// </summary>
        public static int CountBatchSize = 20;
        /// <summary>
        /// Custom revert summ
        /// </summary>
        public static List<string> CustomRevertSummaries = new List<string>();
        /// <summary>
        /// Default queue
        /// </summary>
        public static string DefaultQueue = "";
        /// <summary>
        /// Whitelist
        /// </summary>
        public static string WhitelistUrl = "http://huggle.wmflabs.org/data/wl.php";
        /// <summary>
        /// Default
        /// </summary>
        public static string DefaultQueue2;
        /// <summary>
        /// Default summary for all edits
        /// </summary>
        public static string DefaultSummary = "";
        /// <summary>
        /// If deleting using huggle is available
        /// </summary>
        public static bool Delete = false;
        /// <summary>
        /// DEPRECATED: platform id
        /// </summary>
        public static Int32 Platform = 86;
        /// <summary>
        /// Size of font
        /// </summary>
        public static string DiffFontSize = "8";
        /// <summary>
        /// Location of manual
        /// </summary>
        public static string DocsLocation = "http://www.mediawiki.org/wiki/Manual:Huggle";
        /// <summary>
        /// DEPRECATED
        /// </summary>
        public static string DownloadLocation = "http://huggle.googlecode.com/files/huggle $1.exe";
        /// <summary>
        /// DEPRECATED
        /// </summary>
        public static string Downloadloc64 = "http://huggle.googlecode.com/files/huggle $1x64.exe"; // Download of x64, deprecated
        /// <summary>
        /// Emails
        /// </summary>
        public static bool Email;
        /// <summary>
        /// Default subject of email
        /// </summary>
        public static string EmailSubject = "";
        /// <summary>
        /// URL of test wiki
        /// </summary>
        public static string TestWp = "http://huggle.wmflabs.org/";
        /// <summary>
        /// If huggle is enabled
        /// </summary>
        public static bool Enabled;
        /// <summary>
        /// If huggle is enabled on global
        /// </summary>
        public static bool EnabledForAll = false;
        /// <summary>
        /// If reports should be extended
        /// </summary>
        public static bool ExtendReports = false;
        /// <summary>
        /// Location of feedback page
        /// </summary>
        public static string FeedbackLocation = "http://en.wikipedia.org/wiki/WT:HG";
        /// <summary>
        /// List
        /// </summary>
        public static List<string> GoToPages = new List<string>();
        /// <summary>
        /// Location of icons
        /// </summary>
        public static string IconsLocation = "http://en.wikipedia.org/wiki/Wikipedia:Huggle/Icons";
        /// <summary>
        /// Location of IFD
        /// </summary>
        public static string IfdLocation = "";
        /// <summary>
        /// Ignored pages
        /// </summary>
        public static List<string> IgnoredPages = new List<string>();
        /// <summary>
        /// If huggle is loaded
        /// </summary>
        public static bool Initialised = false;
        /// <summary>
        /// IRC channel for feed
        /// </summary>
        public static string IrcChannel = "";
        /// <summary>
        /// If IRC feed is enabled
        /// </summary>
        public static bool IrcMode = false;
        /// <summary>
        /// Irc port
        /// </summary>
        public static int IrcPort = 6667;
        /// <summary>
        /// Server name
        /// </summary>
        public static string IrcServer = "";
        /// <summary>
        /// Server ident
        /// </summary>
        public static string IrcServerName = "";
        /// <summary>
        /// User name
        /// </summary>
        public static string IrcUsername = "";
        /// <summary>
        /// Localization
        /// </summary>
        public static string LocalizatonPath = "Huggle/Localization/";
        /// <summary>
        /// Log file
        /// </summary>
        public static string LogFile = "";
        /// <summary>
        /// Links
        /// </summary>
        public static int MaxReportLinks = 6;
        /// <summary>
        /// Minor
        /// </summary>
        public static Dictionary<string, bool> Minor = new Dictionary<string,bool>(); // Minor edits
        /// <summary>
        /// Minimal allowed version for use on project
        /// </summary>
        public static Version MinVersion = new Version(3, 0, 0, 0);
        /// <summary>
        /// Wait between issue of warning
        /// </summary>
        public static int MinWarningWait = 10;
        /// <summary>
        /// If headers are allowed on project
        /// </summary>
        public static bool MonthHeadings = false;
        /// <summary>
        /// Parts of multiple revert
        /// </summary>
        public static List<string> MultipleRevertSummaryParts = new List<string>();
        /// <summary>
        /// Maximum number of messages in ring log
        /// </summary>
        public static int RingSize = 200000;
        /// <summary>
        /// If links should be opened in a browser
        /// </summary>
        public static bool OpenInBrowser = false;
        /// <summary>
        /// Regex for blanked page
        /// </summary>
        public static Regex PageBlankedPattern = null; // blanked
        /// <summary>
        /// Regex for created page
        /// </summary>
        public static Regex PageCreatedPattern = null;
        /// <summary>
        /// Regex for redirect
        /// </summary>
        public static Regex PageRedirectedPattern = null;
        /// <summary>
        /// Regex for replaced page
        /// </summary>
        public static Regex PageReplacedPattern = null;
        /// <summary>
        /// If patroling is allowed
        /// </summary>
        public static bool Patrol = false;
        /// <summary>
        /// If speedy patroling is enabled
        /// </summary>
        public static bool PatrolSpeedy = false;
        /// <summary>
        /// Preloads n
        /// </summary>
        public static int Preloads = 2;
        /// <summary>
        /// Active wiki
        /// </summary>
        public static string Project = "";
        /// <summary>
        /// List of projects which are available
        /// </summary>
        public static Dictionary<string, string> Projects = new Dictionary<string, string>(); //  wikis
        /// <summary>
        /// Location of config
        /// </summary>
        public static string ProjectConfigLocation = null; // Location of config
        /// <summary>
        /// Confirmation when you want to block someone
        /// </summary>
        public static bool PromptForBlock = true;
        /// <summary>
        /// Confirmation for reporting of user
        /// </summary>
        public static bool PromptForReport = false; // Prompt
        /// <summary>
        /// Protection allowed
        /// </summary>
        public static bool Protect = false; // If protecting is used
        /// <summary>
        /// Protection default
        /// </summary>
        public static string ProtectionReason = ""; // Reason
        /// <summary>
        /// Default
        /// </summary>
        public static string ProtectionTime = "indefinite"; // no comment
        /// <summary>
        /// Limit of how many queues can be created
        /// </summary>
        public static int QueueBuilderLimit = 10;
        /// <summary>
        /// Quick sight
        /// </summary>
        public static bool QuickSight = false;
        /// <summary>
        /// Insert diffs to report
        /// </summary>
        public static bool ReportLinkDiffs = true;
        /// <summary>
        /// Default report summary
        /// </summary>
        public static string ReportSummary = "";
        /// <summary>
        /// Require admin/sysop
        /// </summary>
        public static bool RequireAdmin = false;
        /// <summary>
        /// Require auto confirmed status
        /// </summary>
        public static bool RequireAutoconfirmed = false;
        /// <summary>
        /// Require config
        /// </summary>
        public static bool RequireConfig = true;
        /// <summary>
        /// Require edits
        /// </summary>
        public static int RequireEdits = 0;
        /// <summary>
        /// Require review
        /// </summary>
        public static bool RequireRev = false;
        /// <summary>
        /// Require rollback
        /// </summary>
        public static bool RequireRollback = false;
        /// <summary>
        /// Require time
        /// </summary>
        public static int RequireTime = 0;
        /// <summary>
        /// Revert regex to detect
        /// </summary>
        public static List<Regex> RevertPatterns = new List<Regex>();
        /// <summary>
        /// Default summary
        /// </summary>
        public static string RevertSummary = "";
        /// <summary>
        /// Revert summaries
        /// </summary>
        public static List<string> RevertSummaries = new List<string>(); // Summary
        /// <summary>
        /// Align queue on right
        /// </summary>
        public static bool RightAlignQueue = false;
        /// <summary>
        /// Current user's rights
        /// </summary>
        public static List<string> Rights = new List<string>();
        /// <summary>
        /// Default rollback summary
        /// </summary>
        public static string RollbackSummary = "";
        /// <summary>
        /// Save config
        /// </summary>
        public static bool SaveConfig = true;
        /// <summary>
        /// Sensitive addresses for block
        /// </summary>
        public static Dictionary<string, string> SensitiveAddresses = new Dictionary<string, string>();
        /// <summary>
        /// Shared ip templates
        /// </summary>
        public static List<string> SharedIPTemplates = new List<string>();
        /// <summary>
        /// Show new edits
        /// </summary>
        public static bool ShowNewEdits = true;
        /// <summary>
        /// Display logs
        /// </summary>
        public static bool ShowLog = true;
        /// <summary>
        /// Show new msg
        /// </summary>
        public static bool ShowNewMessages = true;
        /// <summary>
        /// Display queue
        /// </summary>
        public static bool ShowQueue = true;
        /// <summary>
        /// Display tips
        /// </summary>
        public static bool ShowToolTips = true;
        /// <summary>
        /// Display both queues
        /// </summary>
        public static bool ShowTwoQueues = false;
        /// <summary>
        /// Sighting is enabled
        /// </summary>
        public static bool Sight = false;
        /// <summary>
        /// Single revert summary
        /// </summary>
        public static string SingleRevertSummary = null;
        /// <summary>
        /// Speedy criteria
        /// </summary>
        public static Dictionary<string, Page.SpeedyCriterion> SpeedyCriteria = new Dictionary<string,Page.SpeedyCriterion>();
        /// <summary>
        /// Startup page
        /// </summary>
        public static string StartupPage = "Project:HG";
        /// <summary>
        /// Summary
        /// </summary>
        public static string Summary = "";
        /// <summary>
        /// Tags
        /// </summary>
        public static List<string> Tags = new List<string>();
        /// <summary>
        /// Summaries
        /// </summary>
        public static List<string> TagSummaries = new List<string>();
        /// <summary>
        /// Template summary
        /// </summary>
        public static string TemplateMessageSummary = null;
        /// <summary>
        /// Template messages
        /// </summary>
        public static List<string> TemplateMessages = new List<string>();
        /// <summary>
        /// Global
        /// </summary>
        public static List<string> TemplateMessagesGlobal = new List<string>();
        /// <summary>
        /// Template edit summary
        /// </summary>
        public static Dictionary<string, string> TemplateSummary = new Dictionary<string, string>();
        /// <summary>
        /// Global
        /// </summary>
        public static Dictionary<string, string> GlobalSumm = new Dictionary<string, string>();
        /// <summary>
        /// Localization url
        /// </summary>
        public static string TranslateLocation = "http://meta.wikimedia.org/wiki/Huggle/Localization";
        /// <summary>
        /// Display tray icon
        /// </summary>
        public static bool TrayIcon = true;
        /// <summary>
        /// Summary
        /// </summary>
        public static string UndoSummary = null;
        /// <summary>
        /// Update whitelist is needed
        /// </summary>
        public static bool UpdateWhitelist = false;
        /// <summary>
        /// Manual update only
        /// </summary>
        public static bool UpdateWhitelistManual = false;
        /// <summary>
        /// Use sysop ft
        /// </summary>
        public static bool UseAdminFunctions = true;
        /// <summary>
        /// User agent
        /// </summary>
        public static string UserAgent = null;
        /// <summary>
        /// User config xml
        /// </summary>
        public static string UserConfigLocation_Xml = "Special:Mypage/huggle.xml.css";
        /// <summary>
        /// User config location
        /// </summary>
        public static string UserConfigLocation = "Special:Mypage/huggle.css";
        /// <summary>
        /// User list
        /// </summary>
        public static string UserListLocation = null;
        /// <summary>
        /// Summary for update of user list
        /// </summary>
        public static string UserListUpdateSummary = "";
        /// <summary>
        /// If username is listed
        /// </summary>
        public static bool UsernameListed = false;
        /// <summary>
        /// IRC
        /// </summary>
        public static bool UseIrc = true;
        /// <summary>
        /// User rollback
        /// </summary>
        public static bool UseRollback = true;
        /// <summary>
        /// Agf
        /// </summary>
        public static List<string> Agf = new List<string>();
        /// <summary>
        /// Enable PC
        /// </summary>
        public static bool UsePending = false;
        /// <summary>
        /// Summaries for talk
        /// </summary>
        public static Dictionary<Regex, User.UserLevel> UserTalkSummaries = new Dictionary<Regex, User.UserLevel>();
        /// <summary>
        /// Custom summaries
        /// </summary>
        public static bool UseCSummaries = false;
        /// <summary>
        /// Warning max age
        /// </summary>
        public static int WarningAge = 36;
        /// <summary>
        /// IM as default
        /// </summary>
        public static bool WarningImLevel = false;
        /// <summary>
        /// Warning mode
        /// </summary>
        public static string WarningMode = "";
        //public static Dictionary<string> WarningTypes;
        //public static Dictionary<> Watch;
        /// <summary>
        /// Edit count required for ignore
        /// </summary>
        public static int WhitelistEditCount = 500;
        /// <summary>
        /// OBSOLETE
        /// </summary>
        public static readonly string WhitelistLocation = "";
        /// <summary>
        /// OBSOLETE
        /// </summary>
        public static bool WhitelistSplit = false;
        /// <summary>
        /// Timestamps
        /// </summary>
        public static Dictionary<string, string> WhitelistTimestamps = new Dictionary<string, string>(); 
        /// <summary>
        /// OBSOLETE
        /// </summary>
        public static readonly string WhitelistUpdateSummary = ""; 
        /// <summary>
        /// Size of RC feed in case we want to retrieve it by hand
        /// </summary>
        public static int FeedSize = 100;
        
        public static int RefreshInterval = 1000;
        /// <summary>
        /// Template
        /// </summary>
        public static bool TemplatePs = false;
        /// <summary>
        /// Insert user to list
        /// </summary>
        public static bool WriteUser = false; 
        /// <summary>
        /// Revision access
        /// </summary>
        public static bool RevisionAccess = false; 
        /// <summary>
        /// Revision count
        /// </summary>
        public static bool RevisionR = false;
        /// <summary>
        /// Summaries
        /// </summary>
        public static string WarnSummary = "";
        /// <summary>
        /// The warn summary2.
        /// </summary>
        public static string WarnSummary2 = "";
        /// <summary>
        /// The warn summary3.
        /// </summary>
        public static string WarnSummary3 = "";
        /// <summary>
        /// The warn summary4.
        /// </summary>
        public static string WarnSummary4 = "";
        
        /// <summary>
        /// Watch page
        /// </summary>
        public static bool WatchDelete = false;
        
        public enum platform
        {
            windows32,
            linux32,
            unix32,
            macos32,
            windows64,
            linux64,
            macos64
        }
    }
    
    
}