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         ConfigItems 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 = "", size_t minlen = 0, size_t maxlen = UINT32_MAX);
  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 ConfigItems& getItems() const { return items; }
  84
  85         /** Create a new ConfigTag, giving access to the private ConfigItems item list */
  86         static ConfigTag* create(const std::string& Tag, const std::string& file, int line, ConfigItems*& 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         /** Read all limits from a config tag. Limits which aren't specified in the tag are set to a default value.
 121          * @param tag Configuration tag to read the limits from
 122          */
 123         ServerLimits(ConfigTag* tag);
 124
 125         /** Maximum length of a n!u\@h mask */
 126         size_t GetMaxMask() const { return NickMax + 1 + IdentMax + 1 + MaxHost; }
 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         typedef insp::flat_set<std::string> PrivSet;
 169         PrivSet AllowedOperCommands;
 170         PrivSet AllowedPrivs;
 171
 172         /** Allowed user modes from oper classes. */
 173         std::bitset<64> AllowedUserModes;
 174
 175         /** Allowed channel modes from oper classes. */
 176         std::bitset<64> AllowedChanModes;
 177
 178         /** \<oper> block used for this oper-up. May be NULL. */
 179         reference<ConfigTag> oper_block;
 180         /** \<type> block used for this oper-up. Valid for local users, may be NULL on remote */
 181         reference<ConfigTag> type_block;
 182         /** \<class> blocks referenced from the \<type> block. These define individual permissions */
 183         std::vector<reference<ConfigTag> > class_blocks;
 184         /** Name of the oper type; i.e. the one shown in WHOIS */
 185         std::string name;
 186
 187         /** Creates a new OperInfo with the specified oper type name.
 188          * @param Name The name of the oper type.
 189          */
 190         OperInfo(const std::string& Name);
 191
 192         /** Get a configuration item, searching in the oper, type, and class blocks (in that order) */
 193         std::string getConfig(const std::string& key);
 194         void init();
 195 };
 196
 197 /** This class holds the bulk of the runtime configuration for the ircd.
 198  * It allows for reading new config values, accessing configuration files,
 199  * and storage of the configuration data needed to run the ircd, such as
 200  * the servername, connect classes, /ADMIN data, MOTDs and filenames etc.
 201  */
 202 class CoreExport ServerConfig
 203 {
 204   private:
 205         void CrossCheckOperClassType();
 206         void CrossCheckConnectBlocks(ServerConfig* current);
 207
 208  public:
 209         class ServerPaths
 210         {
 211          public:
 212                 /** Config path */
 213                 std::string Config;
 214
 215                 /** Data path */
 216                 std::string Data;
 217
 218                 /** Log path */
 219                 std::string Log;
 220
 221                 /** Module path */
 222                 std::string Module;
 223
 224                 ServerPaths(ConfigTag* tag);
 225
 226                 std::string PrependConfig(const std::string& fn) const { return FileSystem::ExpandPath(Config, fn); }
 227                 std::string PrependData(const std::string& fn) const { return FileSystem::ExpandPath(Data, fn); }
 228                 std::string PrependLog(const std::string& fn) const { return FileSystem::ExpandPath(Log, fn); }
 229                 std::string PrependModule(const std::string& fn) const { return FileSystem::ExpandPath(Module, fn); }
 230         };
 231
 232         /** Holds a complete list of all connect blocks
 233          */
 234         typedef std::vector<reference<ConnectClass> > ClassVector;
 235
 236         /** Index of valid oper blocks and types
 237          */
 238         typedef insp::flat_map<std::string, reference<OperInfo> > OperIndex;
 239
 240         /** Get a configuration tag
 241          * @param tag The name of the tag to get
 242          */
 243         ConfigTag* ConfValue(const std::string& tag);
 244
 245         ConfigTagList ConfTags(const std::string& tag);
 246
 247         /** An empty configuration tag. */
 248         ConfigTag* EmptyTag;
 249
 250         /** Error stream, contains error output from any failed configuration parsing.
 251          */
 252         std::stringstream errstr;
 253
 254         /** True if this configuration is valid enough to run with */
 255         bool valid;
 256
 257         /** Bind to IPv6 by default */
 258         bool WildcardIPv6;
 259
 260         /** Used to indicate who we announce invites to on a channel */
 261         enum InviteAnnounceState { INVITE_ANNOUNCE_NONE, INVITE_ANNOUNCE_ALL, INVITE_ANNOUNCE_OPS, INVITE_ANNOUNCE_DYNAMIC };
 262         enum OperSpyWhoisState { SPYWHOIS_NONE, SPYWHOIS_SINGLEMSG, SPYWHOIS_SPLITMSG };
 263
 264         /** This holds all the information in the config file,
 265          * it's indexed by tag name to a vector of key/values.
 266          */
 267         ConfigDataHash config_data;
 268
 269         /** This holds all extra files that have been read in the configuration
 270          * (for example, MOTD and RULES files are stored here)
 271          */
 272         ConfigFileCache Files;
 273
 274         /** Length limits, see definition of ServerLimits class
 275          */
 276         ServerLimits Limits;
 277
 278         /** Locations of various types of file (config, module, etc). */
 279         ServerPaths Paths;
 280
 281         /** Configuration parsed from the command line.
 282          */
 283         CommandLineConf cmdline;
 284
 285         /** Clones CIDR range for ipv4 (0-32)
 286          * Defaults to 32 (checks clones on all IPs seperately)
 287          */
 288         int c_ipv4_range;
 289
 290         /** Clones CIDR range for ipv6 (0-128)
 291          * Defaults to 128 (checks on all IPs seperately)
 292          */
 293         int c_ipv6_range;
 294
 295         /** Holds the server name of the local server
 296          * as defined by the administrator.
 297          */
 298         std::string ServerName;
 299
 300         /** Notice to give to users when they are banned by an XLine
 301          */
 302         std::string XLineMessage;
 303
 304         /* Holds the network name the local server
 305          * belongs to. This is an arbitary field defined
 306          * by the administrator.
 307          */
 308         std::string Network;
 309
 310         /** Holds the description of the local server
 311          * as defined by the administrator.
 312          */
 313         std::string ServerDesc;
 314
 315         /** Pretend disabled commands don't exist.
 316          */
 317         bool DisabledDontExist;
 318
 319         /** This variable identifies which usermodes have been diabled.
 320          */
 321         std::bitset<64> DisabledUModes;
 322
 323         /** This variable identifies which chanmodes have been disabled.
 324          */
 325         std::bitset<64> DisabledCModes;
 326
 327         /** If set to true, then all opers on this server are
 328          * shown with a generic 'is an IRC operator' line rather
 329          * than the oper type. Oper types are still used internally.
 330          */
 331         bool GenericOper;
 332
 333         /** If this value is true, banned users (+b, not extbans) will not be able to change nick
 334          * if banned on any channel, nor to message them.
 335          */
 336         bool RestrictBannedUsers;
 337
 338         /** The size of the read() buffer in the user
 339          * handling code, used to read data into a user's
 340          * recvQ.
 341          */
 342         int NetBufferSize;
 343
 344         /** The value to be used for listen() backlogs
 345          * as default.
 346          */
 347         int MaxConn;
 348
 349         /** If we should check for clones during CheckClass() in AddUser()
 350          * Setting this to false allows to not trigger on maxclones for users
 351          * that may belong to another class after DNS-lookup is complete.
 352          * It does, however, make the server spend more time on users we may potentially not want.
 353          */
 354         bool CCOnConnect;
 355
 356         /** The soft limit value assigned to the irc server.
 357          * The IRC server will not allow more than this
 358          * number of local users.
 359          */
 360         unsigned int SoftLimit;
 361
 362         /** Maximum number of targets for a multi target command
 363          * such as PRIVMSG or KICK
 364          */
 365         unsigned int MaxTargets;
 366
 367         /** True if we're going to hide netsplits as *.net *.split for non-opers
 368          */
 369         bool HideSplits;
 370
 371         /** True if we're going to hide ban reasons for non-opers (e.g. G-Lines,
 372          * K-Lines, Z-Lines)
 373          */
 374         bool HideBans;
 375
 376         /** Announce invites to the channel with a server notice
 377          */
 378         InviteAnnounceState AnnounceInvites;
 379
 380         /** If this is enabled then operators will
 381          * see invisible (+i) channels in /whois.
 382          */
 383         OperSpyWhoisState OperSpyWhois;
 384
 385         /** True if raw I/O is being logged */
 386         bool RawLog;
 387
 388         /** Set to a non-empty string to obfuscate the server name of users in WHOIS
 389          */
 390         std::string HideWhoisServer;
 391
 392         /** Set to a non empty string to obfuscate nicknames prepended to a KILL.
 393          */
 394         std::string HideKillsServer;
 395
 396         /** Set to hide kills from clients of ulined servers in snotices.
 397          */
 398         bool HideULineKills;
 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         /** The name of the casemapping method used by this server.
 427          */
 428         std::string CaseMapping;
 429
 430         /** If set to true, the CycleHosts mode change will be sourced from the user,
 431          * rather than the server
 432          */
 433         bool CycleHostsFromUser;
 434
 435         /** If set to true, the full nick!user\@host will be shown in the TOPIC command
 436          * for who set the topic last. If false, only the nick is shown.
 437          */
 438         bool FullHostInTopic;
 439
 440         /** Oper blocks keyed by their name
 441          */
 442         OperIndex oper_blocks;
 443
 444         /** Oper types keyed by their name
 445          */
 446         OperIndex OperTypes;
 447
 448         /** Default value for <connect:maxchans>, deprecated in 3.0
 449          */
 450         unsigned int MaxChans;
 451
 452         /** Default value for <oper:maxchans>, deprecated in 3.0
 453          */
 454         unsigned int OperMaxChans;
 455
 456         /** TS6-like server ID.
 457          * NOTE: 000...999 are usable for InspIRCd servers. This
 458          * makes code simpler. 0AA, 1BB etc with letters are reserved
 459          * for services use.
 460          */
 461         std::string sid;
 462
 463         /** Construct a new ServerConfig
 464          */
 465         ServerConfig();
 466
 467         ~ServerConfig();
 468
 469         /** Get server ID as string with required leading zeroes
 470          */
 471         const std::string& GetSID() const { return sid; }
 472
 473         /** Read the entire configuration into memory
 474          * and initialize this class. All other methods
 475          * should be used only by the core.
 476          */
 477         void Read();
 478
 479         /** Apply configuration changes from the old configuration.
 480          */
 481         void Apply(ServerConfig* old, const std::string &useruid);
 482         void ApplyModules(User* user);
 483
 484         void Fill();
 485
 486         /** Disables the commands specified in <disabled:commands>. */
 487         bool ApplyDisabledCommands();
 488
 489         /** Escapes a value for storage in a configuration key.
 490          * @param str The string to escape.
 491          * @param xml Are we using the XML config format?
 492          */
 493         static std::string Escape(const std::string& str, bool xml = true);
 494
 495         /** If this value is true, snotices will not stack when repeats are sent
 496          */
 497         bool NoSnoticeStack;
 498 };
 499
 500 /** The background thread for config reading, so that reading from executable includes
 501  * does not block.
 502  */
 503 class CoreExport ConfigReaderThread : public Thread
 504 {
 505         ServerConfig* Config;
 506         volatile bool done;
 507  public:
 508         const std::string TheUserUID;
 509         ConfigReaderThread(const std::string &useruid)
 510                 : Config(new ServerConfig), done(false), TheUserUID(useruid)
 511         {
 512         }
 513
 514         virtual ~ConfigReaderThread()
 515         {
 516                 delete Config;
 517         }
 518
 519         void Run();
 520         /** Run in the main thread to apply the configuration */
 521         void Finish();
 522         bool IsDone() { return done; }
 523 };
 524
 525 class CoreExport ConfigStatus
 526 {
 527  public:
 528         User* const srcuser;
 529
 530         ConfigStatus(User* user = NULL)
 531                 : srcuser(user)
 532         {
 533         }
 534 };