include/configreader.h

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
   5  *   Copyright (C) 2007, 2009 Dennis Friis <peavey@inspircd.org>
   6  *   Copyright (C) 2006-2008 Craig Edwards <craigedwards@brainbox.cc>
   7  *   Copyright (C) 2006-2008 Robin Burchell <robin+git@viroteck.net>
   8  *   Copyright (C) 2006 Oliver Lupton <oliverlupton@gmail.com>
   9  *
  10  * This file is part of InspIRCd.  InspIRCd is free software: you can
  11  * redistribute it and/or modify it under the terms of the GNU General Public
  12  * License as published by the Free Software Foundation, version 2.
  13  *
  14  * This program is distributed in the hope that it will be useful, but WITHOUT
  15  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  16  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  17  * details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  */
  22
  23
  24 #pragma once
  25
  26 #include <sstream>
  27 #include <string>
  28 #include <vector>
  29 #include <map>
  30 #include "inspircd.h"
  31 #include "modules.h"
  32 #include "socketengine.h"
  33 #include "socket.h"
  34
  35 /** Structure representing a single \<tag> in config */
  36 class CoreExport ConfigTag : public refcountbase
  37 {
  38         std::vector<KeyVal> items;
  39  public:
  40         const std::string tag;
  41         const std::string src_name;
  42         const int src_line;
  43
  44         /** Get the value of an option, using def if it does not exist */
  45         std::string getString(const std::string& key, const std::string& def = "");
  46         /** Get the value of an option, using def if it does not exist */
  47         long getInt(const std::string& key, long def = 0, long min = LONG_MIN, long max = LONG_MAX);
  48         /** Get the value of an option, using def if it does not exist */
  49         double getFloat(const std::string& key, double def = 0);
  50         /** Get the value of an option, using def if it does not exist */
  51         bool getBool(const std::string& key, bool def = false);
  52
  53         /** Get the value in seconds of a duration that is in the user-friendly "1h2m3s" format,
  54          * using a default value if it does not exist or is out of bounds.
  55          * @param key The config key name
  56          * @param def Default value (optional)
  57          * @param min Minimum acceptable value (optional)
  58          * @param max Maximum acceptable value (optional)
  59          * @return The duration in seconds
  60          */
  61         long getDuration(const std::string& key, long def = 0, long min = LONG_MIN, long max = LONG_MAX);
  62
  63         /** Get the value of an option
  64          * @param key The option to get
  65          * @param value The location to store the value (unmodified if does not exist)
  66          * @param allow_newline Allow newlines in the option (normally replaced with spaces)
  67          * @return true if the option exists
  68          */
  69         bool readString(const std::string& key, std::string& value, bool allow_newline = false);
  70
  71         /** Check for an out of range value. If the value falls outside the boundaries a warning is
  72          * logged and the value is corrected (set to def).
  73          * @param key The key name, used in the warning message
  74          * @param res The value to verify and modify if needed
  75          * @param def The default value, res will be set to this if (min <= res <= max) doesn't hold true
  76          * @param min Minimum accepted value for res
  77          * @param max Maximum accepted value for res
  78          */
  79         void CheckRange(const std::string& key, long& res, long def, long min, long max);
  80
  81         std::string getTagLocation();
  82
  83         inline const std::vector<KeyVal>& getItems() const { return items; }
  84
  85         /** Create a new ConfigTag, giving access to the private KeyVal item list */
  86         static ConfigTag* create(const std::string& Tag, const std::string& file, int line, std::vector<KeyVal>*& Items);
  87  private:
  88         ConfigTag(const std::string& Tag, const std::string& file, int line);
  89 };
  90
  91 /** Defines the server's length limits on various length-limited
  92  * items such as topics, nicknames, channel names etc.
  93  */
  94 class ServerLimits
  95 {
  96  public:
  97         /** Maximum nickname length */
  98         size_t NickMax;
  99         /** Maximum channel length */
 100         size_t ChanMax;
 101         /** Maximum number of modes per line */
 102         size_t MaxModes;
 103         /** Maximum length of ident, not including ~ etc */
 104         size_t IdentMax;
 105         /** Maximum length of a quit message */
 106         size_t MaxQuit;
 107         /** Maximum topic length */
 108         size_t MaxTopic;
 109         /** Maximum kick message length */
 110         size_t MaxKick;
 111         /** Maximum GECOS (real name) length */
 112         size_t MaxGecos;
 113         /** Maximum away message length */
 114         size_t MaxAway;
 115         /** Maximum line length */
 116         size_t MaxLine;
 117         /** Maximum hostname length */
 118         size_t MaxHost;
 119
 120         /** Creating the class initialises it to the defaults
 121          * as in 1.1's ./configure script. Reading other values
 122          * from the config will change these values.
 123          */
 124         ServerLimits() : NickMax(31), ChanMax(64), MaxModes(20), IdentMax(12),
 125                 MaxQuit(255), MaxTopic(307), MaxKick(255), MaxGecos(128), MaxAway(200),
 126                 MaxLine(512), MaxHost(64) { }
 127 };
 128
 129 struct CommandLineConf
 130 {
 131         /** If this value is true, the owner of the
 132          * server specified -nofork on the command
 133          * line, causing the daemon to stay in the
 134          * foreground.
 135          */
 136         bool nofork;
 137
 138         /** If this value if true then all log
 139          * messages will be output, regardless of
 140          * the level given in the config file.
 141          * This is set with the -debug commandline
 142          * option.
 143          */
 144         bool forcedebug;
 145
 146         /** If this is true then log output will be
 147          * written to the logfile. This is the default.
 148          * If you put -nolog on the commandline then
 149          * the logfile will not be written.
 150          * This is meant to be used in conjunction with
 151          * -debug for debugging without filling up the
 152          * hard disk.
 153          */
 154         bool writelog;
 155
 156         /** Saved argc from startup
 157          */
 158         int argc;
 159
 160         /** Saved argv from startup
 161          */
 162         char** argv;
 163 };
 164
 165 class CoreExport OperInfo : public refcountbase
 166 {
 167  public:
 168         std::set<std::string> AllowedOperCommands;
 169         std::set<std::string> AllowedPrivs;
 170
 171         /** Allowed user modes from oper classes. */
 172         std::bitset<64> AllowedUserModes;
 173
 174         /** Allowed channel modes from oper classes. */
 175         std::bitset<64> AllowedChanModes;
 176
 177         /** \<oper> block used for this oper-up. May be NULL. */
 178         reference<ConfigTag> oper_block;
 179         /** \<type> block used for this oper-up. Valid for local users, may be NULL on remote */
 180         reference<ConfigTag> type_block;
 181         /** \<class> blocks referenced from the \<type> block. These define individual permissions */
 182         std::vector<reference<ConfigTag> > class_blocks;
 183         /** Name of the oper type; i.e. the one shown in WHOIS */
 184         std::string name;
 185
 186         /** Get a configuration item, searching in the oper, type, and class blocks (in that order) */
 187         std::string getConfig(const std::string& key);
 188         void init();
 189 };
 190
 191 /** This class holds the bulk of the runtime configuration for the ircd.
 192  * It allows for reading new config values, accessing configuration files,
 193  * and storage of the configuration data needed to run the ircd, such as
 194  * the servername, connect classes, /ADMIN data, MOTDs and filenames etc.
 195  */
 196 class CoreExport ServerConfig
 197 {
 198   private:
 199         void CrossCheckOperClassType();
 200         void CrossCheckConnectBlocks(ServerConfig* current);
 201
 202  public:
 203         class ServerPaths
 204         {
 205          public:
 206                 /** Config path */
 207                 std::string Config;
 208
 209                 /** Data path */
 210                 std::string Data;
 211
 212                 /** Log path */
 213                 std::string Log;
 214
 215                 /** Module path */
 216                 std::string Module;
 217
 218                 ServerPaths()
 219                         : Config(INSPIRCD_CONFIG_PATH)
 220                         , Data(INSPIRCD_DATA_PATH)
 221                         , Log(INSPIRCD_LOG_PATH)
 222                         , Module(INSPIRCD_MODULE_PATH) { }
 223
 224                 std::string PrependConfig(const std::string& fn) const { return FileSystem::ExpandPath(Config, fn); }
 225                 std::string PrependData(const std::string& fn) const { return FileSystem::ExpandPath(Data, fn); }
 226                 std::string PrependLog(const std::string& fn) const { return FileSystem::ExpandPath(Log, fn); }
 227                 std::string PrependModule(const std::string& fn) const { return FileSystem::ExpandPath(Module, fn); }
 228         };
 229
 230         /** Get a configuration tag
 231          * @param tag The name of the tag to get
 232          */
 233         ConfigTag* ConfValue(const std::string& tag);
 234
 235         ConfigTagList ConfTags(const std::string& tag);
 236
 237         /** Error stream, contains error output from any failed configuration parsing.
 238          */
 239         std::stringstream errstr;
 240
 241         /** True if this configuration is valid enough to run with */
 242         bool valid;
 243
 244         /** Bind to IPv6 by default */
 245         bool WildcardIPv6;
 246
 247         /** Used to indicate who we announce invites to on a channel */
 248         enum InviteAnnounceState { INVITE_ANNOUNCE_NONE, INVITE_ANNOUNCE_ALL, INVITE_ANNOUNCE_OPS, INVITE_ANNOUNCE_DYNAMIC };
 249         enum OperSpyWhoisState { SPYWHOIS_NONE, SPYWHOIS_SINGLEMSG, SPYWHOIS_SPLITMSG };
 250
 251         /** This holds all the information in the config file,
 252          * it's indexed by tag name to a vector of key/values.
 253          */
 254         ConfigDataHash config_data;
 255
 256         /** This holds all extra files that have been read in the configuration
 257          * (for example, MOTD and RULES files are stored here)
 258          */
 259         ConfigFileCache Files;
 260
 261         /** Length limits, see definition of ServerLimits class
 262          */
 263         ServerLimits Limits;
 264
 265         /** Locations of various types of file (config, module, etc). */
 266         ServerPaths Paths;
 267
 268         /** Configuration parsed from the command line.
 269          */
 270         CommandLineConf cmdline;
 271
 272         /** Clones CIDR range for ipv4 (0-32)
 273          * Defaults to 32 (checks clones on all IPs seperately)
 274          */
 275         int c_ipv4_range;
 276
 277         /** Clones CIDR range for ipv6 (0-128)
 278          * Defaults to 128 (checks on all IPs seperately)
 279          */
 280         int c_ipv6_range;
 281
 282         /** Holds the server name of the local server
 283          * as defined by the administrator.
 284          */
 285         std::string ServerName;
 286
 287         /** Notice to give to users when they are banned by an XLine
 288          */
 289         std::string XLineMessage;
 290
 291         /* Holds the network name the local server
 292          * belongs to. This is an arbitary field defined
 293          * by the administrator.
 294          */
 295         std::string Network;
 296
 297         /** Holds the description of the local server
 298          * as defined by the administrator.
 299          */
 300         std::string ServerDesc;
 301
 302         /** Pretend disabled commands don't exist.
 303          */
 304         bool DisabledDontExist;
 305
 306         /** This variable contains a space-seperated list
 307          * of commands which are disabled by the
 308          * administrator of the server for non-opers.
 309          */
 310         std::string DisabledCommands;
 311
 312         /** This variable identifies which usermodes have been diabled.
 313          */
 314         char DisabledUModes[64];
 315
 316         /** This variable identifies which chanmodes have been disabled.
 317          */
 318         char DisabledCModes[64];
 319
 320         /** If set to true, then all opers on this server are
 321          * shown with a generic 'is an IRC operator' line rather
 322          * than the oper type. Oper types are still used internally.
 323          */
 324         bool GenericOper;
 325
 326         /** If this value is true, banned users (+b, not extbans) will not be able to change nick
 327          * if banned on any channel, nor to message them.
 328          */
 329         bool RestrictBannedUsers;
 330
 331         /** If this is set to true, then mode lists (e.g
 332          * MODE \#chan b) are hidden from unprivileged
 333          * users.
 334          */
 335         bool HideModeLists[256];
 336
 337         /** The number of seconds the DNS subsystem
 338          * will wait before timing out any request.
 339          */
 340         int dns_timeout;
 341
 342         /** The size of the read() buffer in the user
 343          * handling code, used to read data into a user's
 344          * recvQ.
 345          */
 346         int NetBufferSize;
 347
 348         /** The value to be used for listen() backlogs
 349          * as default.
 350          */
 351         int MaxConn;
 352
 353         /** If we should check for clones during CheckClass() in AddUser()
 354          * Setting this to false allows to not trigger on maxclones for users
 355          * that may belong to another class after DNS-lookup is complete.
 356          * It does, however, make the server spend more time on users we may potentially not want.
 357          */
 358         bool CCOnConnect;
 359
 360         /** The soft limit value assigned to the irc server.
 361          * The IRC server will not allow more than this
 362          * number of local users.
 363          */
 364         unsigned int SoftLimit;
 365
 366         /** Maximum number of targets for a multi target command
 367          * such as PRIVMSG or KICK
 368          */
 369         unsigned int MaxTargets;
 370
 371         /** True if we're going to hide netsplits as *.net *.split for non-opers
 372          */
 373         bool HideSplits;
 374
 375         /** True if we're going to hide ban reasons for non-opers (e.g. G-Lines,
 376          * K-Lines, Z-Lines)
 377          */
 378         bool HideBans;
 379
 380         /** Announce invites to the channel with a server notice
 381          */
 382         InviteAnnounceState AnnounceInvites;
 383
 384         /** If this is enabled then operators will
 385          * see invisible (+i) channels in /whois.
 386          */
 387         OperSpyWhoisState OperSpyWhois;
 388
 389         /** True if raw I/O is being logged */
 390         bool RawLog;
 391
 392         /** Set to a non-empty string to obfuscate the server name of users in WHOIS
 393          */
 394         std::string HideWhoisServer;
 395
 396         /** Set to a non empty string to obfuscate nicknames prepended to a KILL.
 397          */
 398         std::string HideKillsServer;
 399
 400         /** The full pathname and filename of the PID
 401          * file as defined in the configuration.
 402          */
 403         std::string PID;
 404
 405         /** The connect classes in use by the IRC server.
 406          */
 407         ClassVector Classes;
 408
 409         /** STATS characters in this list are available
 410          * only to operators.
 411          */
 412         std::string UserStats;
 413
 414         /** Default channel modes
 415          */
 416         std::string DefaultModes;
 417
 418         /** Custom version string, which if defined can replace the system info in VERSION.
 419          */
 420         std::string CustomVersion;
 421
 422         /** If set to true, provide syntax hints for unknown commands
 423          */
 424         bool SyntaxHints;
 425
 426         /** If set to true, the CycleHosts mode change will be sourced from the user,
 427          * rather than the server
 428          */
 429         bool CycleHostsFromUser;
 430
 431         /** If set to true, prefixed channel NOTICEs and PRIVMSGs will have the prefix
 432          *  added to the outgoing text for undernet style msg prefixing.
 433          */
 434         bool UndernetMsgPrefix;
 435
 436         /** If set to true, the full nick!user\@host will be shown in the TOPIC command
 437          * for who set the topic last. If false, only the nick is shown.
 438          */
 439         bool FullHostInTopic;
 440
 441         /** Oper blocks keyed by their name
 442          */
 443         OperIndex oper_blocks;
 444
 445         /** Oper types keyed by their name
 446          */
 447         OperIndex OperTypes;
 448
 449         /** Default value for <connect:maxchans>, deprecated in 2.2
 450          */
 451         unsigned int MaxChans;
 452
 453         /** Default value for <oper:maxchans>, deprecated in 2.2
 454          */
 455         unsigned int OperMaxChans;
 456
 457         /** TS6-like server ID.
 458          * NOTE: 000...999 are usable for InspIRCd servers. This
 459          * makes code simpler. 0AA, 1BB etc with letters are reserved
 460          * for services use.
 461          */
 462         std::string sid;
 463
 464         /** Construct a new ServerConfig
 465          */
 466         ServerConfig();
 467
 468         /** Get server ID as string with required leading zeroes
 469          */
 470         const std::string& GetSID() const { return sid; }
 471
 472         /** Read the entire configuration into memory
 473          * and initialize this class. All other methods
 474          * should be used only by the core.
 475          */
 476         void Read();
 477
 478         /** Apply configuration changes from the old configuration.
 479          */
 480         void Apply(ServerConfig* old, const std::string &useruid);
 481         void ApplyModules(User* user);
 482
 483         void Fill();
 484
 485         bool ApplyDisabledCommands(const std::string& data);
 486
 487         /** Escapes a value for storage in a configuration key.
 488          * @param str The string to escape.
 489          * @param xml Are we using the XML config format?
 490          */
 491         static std::string Escape(const std::string& str, bool xml = true);
 492
 493         /** If this value is true, invites will bypass more than just +i
 494          */
 495         bool InvBypassModes;
 496
 497         /** If this value is true, snotices will not stack when repeats are sent
 498          */
 499         bool NoSnoticeStack;
 500 };
 501
 502 /** The background thread for config reading, so that reading from executable includes
 503  * does not block.
 504  */
 505 class CoreExport ConfigReaderThread : public Thread
 506 {
 507         ServerConfig* Config;
 508         volatile bool done;
 509  public:
 510         const std::string TheUserUID;
 511         ConfigReaderThread(const std::string &useruid)
 512                 : Config(new ServerConfig), done(false), TheUserUID(useruid)
 513         {
 514         }
 515
 516         virtual ~ConfigReaderThread()
 517         {
 518                 delete Config;
 519         }
 520
 521         void Run();
 522         /** Run in the main thread to apply the configuration */
 523         void Finish();
 524         bool IsDone() { return done; }
 525 };
 526
 527 class CoreExport ConfigStatus
 528 {
 529  public:
 530         User* const srcuser;
 531
 532         ConfigStatus(User* user = NULL)
 533                 : srcuser(user)
 534         {
 535         }
 536 };