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