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 #include "token_list.h"
  35
  36 /** Structure representing a single \<tag> in config */
  37 class CoreExport ConfigTag : public refcountbase
  38 {
  39         ConfigItems items;
  40  public:
  41         const std::string tag;
  42         const std::string src_name;
  43         const int src_line;
  44
  45         /** Get the value of an option, using def if it does not exist */
  46         std::string getString(const std::string& key, const std::string& def, const TR1NS::function<bool(const std::string&)>& validator);
  47         /** Get the value of an option, using def if it does not exist */
  48         std::string getString(const std::string& key, const std::string& def = "", size_t minlen = 0, size_t maxlen = UINT32_MAX);
  49         /** Get the value of an option, using def if it does not exist */
  50         long getInt(const std::string& key, long def, long min = LONG_MIN, long max = LONG_MAX);
  51         /** Get the value of an option, using def if it does not exist */
  52         unsigned long getUInt(const std::string& key, unsigned long def, unsigned long min = 0, unsigned long max = ULONG_MAX);
  53         /** Get the value of an option, using def if it does not exist */
  54         double getFloat(const std::string& key, double def, double min = DBL_MIN, double max = DBL_MAX);
  55         /** Get the value of an option, using def if it does not exist */
  56         bool getBool(const std::string& key, bool def = false);
  57
  58         /** Get the value in seconds of a duration that is in the user-friendly "1h2m3s" format,
  59          * using a default value if it does not exist or is out of bounds.
  60          * @param key The config key name
  61          * @param def Default value (optional)
  62          * @param min Minimum acceptable value (optional)
  63          * @param max Maximum acceptable value (optional)
  64          * @return The duration in seconds
  65          */
  66         unsigned long getDuration(const std::string& key, unsigned long def, unsigned long min = 0, unsigned long max = ULONG_MAX);
  67
  68         /** Get the value of an option
  69          * @param key The option to get
  70          * @param value The location to store the value (unmodified if does not exist)
  71          * @param allow_newline Allow newlines in the option (normally replaced with spaces)
  72          * @return true if the option exists
  73          */
  74         bool readString(const std::string& key, std::string& value, bool allow_newline = false);
  75
  76         std::string getTagLocation();
  77
  78         inline const ConfigItems& getItems() const { return items; }
  79
  80         /** Create a new ConfigTag, giving access to the private ConfigItems item list */
  81         static ConfigTag* create(const std::string& Tag, const std::string& file, int line, ConfigItems*& Items);
  82  private:
  83         ConfigTag(const std::string& Tag, const std::string& file, int line);
  84 };
  85
  86 /** Defines the server's length limits on various length-limited
  87  * items such as topics, nicknames, channel names etc.
  88  */
  89 class ServerLimits
  90 {
  91  public:
  92         /** Maximum nickname length */
  93         size_t NickMax;
  94         /** Maximum channel length */
  95         size_t ChanMax;
  96         /** Maximum number of modes per line */
  97         size_t MaxModes;
  98         /** Maximum length of ident, not including ~ etc */
  99         size_t IdentMax;
 100         /** Maximum length of a quit message */
 101         size_t MaxQuit;
 102         /** Maximum topic length */
 103         size_t MaxTopic;
 104         /** Maximum kick message length */
 105         size_t MaxKick;
 106         /** Maximum real name length */
 107         size_t MaxReal;
 108         /** Maximum away message length */
 109         size_t MaxAway;
 110         /** Maximum line length */
 111         size_t MaxLine;
 112         /** Maximum hostname length */
 113         size_t MaxHost;
 114
 115         /** Read all limits from a config tag. Limits which aren't specified in the tag are set to a default value.
 116          * @param tag Configuration tag to read the limits from
 117          */
 118         ServerLimits(ConfigTag* tag);
 119
 120         /** Maximum length of a n!u\@h mask */
 121         size_t GetMaxMask() const { return NickMax + 1 + IdentMax + 1 + MaxHost; }
 122 };
 123
 124 struct CommandLineConf
 125 {
 126         /** If this value is true, the owner of the
 127          * server specified -nofork on the command
 128          * line, causing the daemon to stay in the
 129          * foreground.
 130          */
 131         bool nofork;
 132
 133         /** If this value if true then all log
 134          * messages will be output, regardless of
 135          * the level given in the config file.
 136          * This is set with the -debug commandline
 137          * option.
 138          */
 139         bool forcedebug;
 140
 141         /** If this is true then log output will be
 142          * written to the logfile. This is the default.
 143          * If you put -nolog on the commandline then
 144          * the logfile will not be written.
 145          * This is meant to be used in conjunction with
 146          * -debug for debugging without filling up the
 147          * hard disk.
 148          */
 149         bool writelog;
 150
 151         /** If this is true, a PID file will be written
 152          * to the file given in the "file" variable of
 153          * the \<pid> tag in the config file. This is
 154          * the default.
 155          * Passing --nopid as a command line argument
 156          * sets this to false; in this case, a PID file
 157          * will not be written, even the default PID
 158          * file that is usually written when the \<pid>
 159          * tag is not defined in the config file.
 160          */
 161         bool writepid;
 162
 163         /* Whether the --runasroot option was specified at boot. */
 164         bool runasroot;
 165
 166         /** Saved argc from startup. */
 167         int argc;
 168
 169         /** Saved argv from startup. */
 170         char** argv;
 171 };
 172
 173 class CoreExport OperInfo : public refcountbase
 174 {
 175  public:
 176         TokenList AllowedOperCommands;
 177         TokenList AllowedPrivs;
 178
 179         /** Allowed user modes from oper classes. */
 180         std::bitset<64> AllowedUserModes;
 181
 182         /** Allowed channel modes from oper classes. */
 183         std::bitset<64> AllowedChanModes;
 184
 185         /** \<oper> block used for this oper-up. May be NULL. */
 186         reference<ConfigTag> oper_block;
 187         /** \<type> block used for this oper-up. Valid for local users, may be NULL on remote */
 188         reference<ConfigTag> type_block;
 189         /** \<class> blocks referenced from the \<type> block. These define individual permissions */
 190         std::vector<reference<ConfigTag> > class_blocks;
 191         /** Name of the oper type; i.e. the one shown in WHOIS */
 192         std::string name;
 193
 194         /** Creates a new OperInfo with the specified oper type name.
 195          * @param Name The name of the oper type.
 196          */
 197         OperInfo(const std::string& Name);
 198
 199         /** Get a configuration item, searching in the oper, type, and class blocks (in that order) */
 200         std::string getConfig(const std::string& key);
 201         void init();
 202 };
 203
 204 /** This class holds the bulk of the runtime configuration for the ircd.
 205  * It allows for reading new config values, accessing configuration files,
 206  * and storage of the configuration data needed to run the ircd, such as
 207  * the servername, connect classes, /ADMIN data, MOTDs and filenames etc.
 208  */
 209 class CoreExport ServerConfig
 210 {
 211   private:
 212         void CrossCheckOperClassType();
 213         void CrossCheckConnectBlocks(ServerConfig* current);
 214
 215  public:
 216         /** How to treat a user in a channel who is banned. */
 217         enum BannedUserTreatment
 218         {
 219                 /** Don't treat a banned user any different to normal. */
 220                 BUT_NORMAL,
 221
 222                 /** Restrict the actions of a banned user. */
 223                 BUT_RESTRICT_SILENT,
 224
 225                 /** Restrict the actions of a banned user and notify them of their treatment. */
 226                 BUT_RESTRICT_NOTIFY
 227         };
 228
 229         class ServerPaths
 230         {
 231          public:
 232                 /** Config path */
 233                 std::string Config;
 234
 235                 /** Data path */
 236                 std::string Data;
 237
 238                 /** Log path */
 239                 std::string Log;
 240
 241                 /** Module path */
 242                 std::string Module;
 243
 244                 ServerPaths(ConfigTag* tag);
 245
 246                 std::string PrependConfig(const std::string& fn) const { return FileSystem::ExpandPath(Config, fn); }
 247                 std::string PrependData(const std::string& fn) const { return FileSystem::ExpandPath(Data, fn); }
 248                 std::string PrependLog(const std::string& fn) const { return FileSystem::ExpandPath(Log, fn); }
 249                 std::string PrependModule(const std::string& fn) const { return FileSystem::ExpandPath(Module, fn); }
 250         };
 251
 252         /** Holds a complete list of all connect blocks
 253          */
 254         typedef std::vector<reference<ConnectClass> > ClassVector;
 255
 256         /** Index of valid oper blocks and types
 257          */
 258         typedef insp::flat_map<std::string, reference<OperInfo> > OperIndex;
 259
 260         /** Get a configuration tag by name. If one or more tags are present then the first is returned.
 261          * @param tag The name of the tag to get.
 262          * @returns Either a tag from the config or EmptyTag.
 263          */
 264         ConfigTag* ConfValue(const std::string& tag);
 265
 266         /** Get a list of configuration tags by name.
 267          * @param tag The name of the tags to get.
 268          * @returns Either a list of tags from the config or an empty ConfigTagList.
 269          */
 270         ConfigTagList ConfTags(const std::string& tag);
 271
 272         /** An empty configuration tag. */
 273         ConfigTag* EmptyTag;
 274
 275         /** Error stream, contains error output from any failed configuration parsing.
 276          */
 277         std::stringstream errstr;
 278
 279         /** True if this configuration is valid enough to run with */
 280         bool valid;
 281
 282         /** Bind to IPv6 by default */
 283         bool WildcardIPv6;
 284
 285         /** This holds all the information in the config file,
 286          * it's indexed by tag name to a vector of key/values.
 287          */
 288         ConfigDataHash config_data;
 289
 290         /** This holds all extra files that have been read in the configuration
 291          * (for example, MOTD and RULES files are stored here)
 292          */
 293         ConfigFileCache Files;
 294
 295         /** Length limits, see definition of ServerLimits class
 296          */
 297         ServerLimits Limits;
 298
 299         /** Locations of various types of file (config, module, etc). */
 300         ServerPaths Paths;
 301
 302         /** Configuration parsed from the command line.
 303          */
 304         CommandLineConf cmdline;
 305
 306         /** Clones CIDR range for ipv4 (0-32)
 307          * Defaults to 32 (checks clones on all IPs seperately)
 308          */
 309         unsigned char c_ipv4_range;
 310
 311         /** Clones CIDR range for ipv6 (0-128)
 312          * Defaults to 128 (checks on all IPs seperately)
 313          */
 314         unsigned char c_ipv6_range;
 315
 316         /** Holds the server name of the local server
 317          * as defined by the administrator.
 318          */
 319         std::string ServerName;
 320
 321         /** Notice to give to users when they are banned by an XLine
 322          */
 323         std::string XLineMessage;
 324
 325         /* Holds the network name the local server
 326          * belongs to. This is an arbitary field defined
 327          * by the administrator.
 328          */
 329         std::string Network;
 330
 331         /** Holds the description of the local server
 332          * as defined by the administrator.
 333          */
 334         std::string ServerDesc;
 335
 336         /** How to treat a user in a channel who is banned. */
 337         BannedUserTreatment RestrictBannedUsers;
 338
 339         /** The size of the read() buffer in the user
 340          * handling code, used to read data into a user's
 341          * recvQ.
 342          */
 343         int NetBufferSize;
 344
 345         /** The value to be used for listen() backlogs
 346          * as default.
 347          */
 348         int MaxConn;
 349
 350         /** If we should check for clones during CheckClass() in AddUser()
 351          * Setting this to false allows to not trigger on maxclones for users
 352          * that may belong to another class after DNS-lookup is complete.
 353          * It does, however, make the server spend more time on users we may potentially not want.
 354          */
 355         bool CCOnConnect;
 356
 357         /** The soft limit value assigned to the irc server.
 358          * The IRC server will not allow more than this
 359          * number of local users.
 360          */
 361         unsigned int SoftLimit;
 362
 363         /** Maximum number of targets for a multi target command
 364          * such as PRIVMSG or KICK
 365          */
 366         unsigned int MaxTargets;
 367
 368         /** The number of seconds that the server clock can skip by before server operators are warned. */
 369         time_t TimeSkipWarn;
 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         /** True if raw I/O is being logged */
 377         bool RawLog;
 378
 379         /** Set to a non-empty string to obfuscate server names. */
 380         std::string HideServer;
 381
 382         /** The full pathname and filename of the PID
 383          * file as defined in the configuration.
 384          */
 385         std::string PID;
 386
 387         /** The connect classes in use by the IRC server.
 388          */
 389         ClassVector Classes;
 390
 391         /** Default channel modes
 392          */
 393         std::string DefaultModes;
 394
 395         /** Custom version string, which if defined can replace the system info in VERSION.
 396          */
 397         std::string CustomVersion;
 398
 399         /** If set to true, provide syntax hints for unknown commands
 400          */
 401         bool SyntaxHints;
 402
 403         /** The name of the casemapping method used by this server.
 404          */
 405         std::string CaseMapping;
 406
 407         /** If set to true, the full nick!user\@host will be shown in the TOPIC command
 408          * for who set the topic last. If false, only the nick is shown.
 409          */
 410         bool FullHostInTopic;
 411
 412         /** Oper blocks keyed by their name
 413          */
 414         OperIndex oper_blocks;
 415
 416         /** Oper types keyed by their name
 417          */
 418         OperIndex OperTypes;
 419
 420         /** Default value for <connect:maxchans>, deprecated in 3.0
 421          */
 422         unsigned int MaxChans;
 423
 424         /** Default value for <oper:maxchans>, deprecated in 3.0
 425          */
 426         unsigned int OperMaxChans;
 427
 428         /** TS6-like server ID.
 429          * NOTE: 000...999 are usable for InspIRCd servers. This
 430          * makes code simpler. 0AA, 1BB etc with letters are reserved
 431          * for services use.
 432          */
 433         std::string sid;
 434
 435         /** Construct a new ServerConfig
 436          */
 437         ServerConfig();
 438
 439         ~ServerConfig();
 440
 441         /** Get server ID as string with required leading zeroes
 442          */
 443         const std::string& GetSID() const { return sid; }
 444
 445         /** Read the entire configuration into memory
 446          * and initialize this class. All other methods
 447          * should be used only by the core.
 448          */
 449         void Read();
 450
 451         /** Apply configuration changes from the old configuration.
 452          */
 453         void Apply(ServerConfig* old, const std::string &useruid);
 454         void ApplyModules(User* user);
 455
 456         void Fill();
 457
 458         /** Escapes a value for storage in a configuration key.
 459          * @param str The string to escape.
 460          * @param xml Are we using the XML config format?
 461          */
 462         static std::string Escape(const std::string& str, bool xml = true);
 463
 464         /** If this value is true, snotices will not stack when repeats are sent
 465          */
 466         bool NoSnoticeStack;
 467 };
 468
 469 /** The background thread for config reading, so that reading from executable includes
 470  * does not block.
 471  */
 472 class CoreExport ConfigReaderThread : public Thread
 473 {
 474         ServerConfig* Config;
 475         volatile bool done;
 476  public:
 477         const std::string TheUserUID;
 478         ConfigReaderThread(const std::string &useruid)
 479                 : Config(new ServerConfig), done(false), TheUserUID(useruid)
 480         {
 481         }
 482
 483         virtual ~ConfigReaderThread()
 484         {
 485                 delete Config;
 486         }
 487
 488         void Run() CXX11_OVERRIDE;
 489         /** Run in the main thread to apply the configuration */
 490         void Finish();
 491         bool IsDone() { return done; }
 492 };
 493
 494 /** Represents the status of a config load. */
 495 class CoreExport ConfigStatus
 496 {
 497  public:
 498         /** Whether this is the initial config load. */
 499         bool const initial;
 500
 501         /** The user who initiated the config load or NULL if not initiated by a user. */
 502         User* const srcuser;
 503
 504         /** Initializes a new instance of the ConfigStatus class.
 505          * @param user The user who initiated the config load or NULL if not initiated by a user.
 506          * @param isinitial Whether this is the initial config load.
 507          */
 508         ConfigStatus(User* user = NULL, bool isinitial = false)
 509                 : initial(isinitial)
 510                 , srcuser(user)
 511         {
 512         }
 513 };