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         /** Saved argc from startup
 164          */
 165         int argc;
 166
 167         /** Saved argv from startup
 168          */
 169         char** argv;
 170 };
 171
 172 class CoreExport OperInfo : public refcountbase
 173 {
 174  public:
 175         TokenList AllowedOperCommands;
 176         TokenList AllowedPrivs;
 177
 178         /** Allowed user modes from oper classes. */
 179         std::bitset<64> AllowedUserModes;
 180
 181         /** Allowed channel modes from oper classes. */
 182         std::bitset<64> AllowedChanModes;
 183
 184         /** \<oper> block used for this oper-up. May be NULL. */
 185         reference<ConfigTag> oper_block;
 186         /** \<type> block used for this oper-up. Valid for local users, may be NULL on remote */
 187         reference<ConfigTag> type_block;
 188         /** \<class> blocks referenced from the \<type> block. These define individual permissions */
 189         std::vector<reference<ConfigTag> > class_blocks;
 190         /** Name of the oper type; i.e. the one shown in WHOIS */
 191         std::string name;
 192
 193         /** Creates a new OperInfo with the specified oper type name.
 194          * @param Name The name of the oper type.
 195          */
 196         OperInfo(const std::string& Name);
 197
 198         /** Get a configuration item, searching in the oper, type, and class blocks (in that order) */
 199         std::string getConfig(const std::string& key);
 200         void init();
 201 };
 202
 203 /** This class holds the bulk of the runtime configuration for the ircd.
 204  * It allows for reading new config values, accessing configuration files,
 205  * and storage of the configuration data needed to run the ircd, such as
 206  * the servername, connect classes, /ADMIN data, MOTDs and filenames etc.
 207  */
 208 class CoreExport ServerConfig
 209 {
 210   private:
 211         void CrossCheckOperClassType();
 212         void CrossCheckConnectBlocks(ServerConfig* current);
 213
 214  public:
 215         /** How to treat a user in a channel who is banned. */
 216         enum BannedUserTreatment
 217         {
 218                 /** Don't treat a banned user any different to normal. */
 219                 BUT_NORMAL,
 220
 221                 /** Restrict the actions of a banned user. */
 222                 BUT_RESTRICT_SILENT,
 223
 224                 /** Restrict the actions of a banned user and notify them of their treatment. */
 225                 BUT_RESTRICT_NOTIFY
 226         };
 227
 228         class ServerPaths
 229         {
 230          public:
 231                 /** Config path */
 232                 std::string Config;
 233
 234                 /** Data path */
 235                 std::string Data;
 236
 237                 /** Log path */
 238                 std::string Log;
 239
 240                 /** Module path */
 241                 std::string Module;
 242
 243                 ServerPaths(ConfigTag* tag);
 244
 245                 std::string PrependConfig(const std::string& fn) const { return FileSystem::ExpandPath(Config, fn); }
 246                 std::string PrependData(const std::string& fn) const { return FileSystem::ExpandPath(Data, fn); }
 247                 std::string PrependLog(const std::string& fn) const { return FileSystem::ExpandPath(Log, fn); }
 248                 std::string PrependModule(const std::string& fn) const { return FileSystem::ExpandPath(Module, fn); }
 249         };
 250
 251         /** Holds a complete list of all connect blocks
 252          */
 253         typedef std::vector<reference<ConnectClass> > ClassVector;
 254
 255         /** Index of valid oper blocks and types
 256          */
 257         typedef insp::flat_map<std::string, reference<OperInfo> > OperIndex;
 258
 259         /** Get a configuration tag by name. If one or more tags are present then the first is returned.
 260          * @param tag The name of the tag to get.
 261          * @returns Either a tag from the config or EmptyTag.
 262          */
 263         ConfigTag* ConfValue(const std::string& tag);
 264
 265         /** Get a list of configuration tags by name.
 266          * @param tag The name of the tags to get.
 267          * @returns Either a list of tags from the config or an empty ConfigTagList.
 268          */
 269         ConfigTagList ConfTags(const std::string& tag);
 270
 271         /** An empty configuration tag. */
 272         ConfigTag* EmptyTag;
 273
 274         /** Error stream, contains error output from any failed configuration parsing.
 275          */
 276         std::stringstream errstr;
 277
 278         /** True if this configuration is valid enough to run with */
 279         bool valid;
 280
 281         /** Bind to IPv6 by default */
 282         bool WildcardIPv6;
 283
 284         /** This holds all the information in the config file,
 285          * it's indexed by tag name to a vector of key/values.
 286          */
 287         ConfigDataHash config_data;
 288
 289         /** This holds all extra files that have been read in the configuration
 290          * (for example, MOTD and RULES files are stored here)
 291          */
 292         ConfigFileCache Files;
 293
 294         /** Length limits, see definition of ServerLimits class
 295          */
 296         ServerLimits Limits;
 297
 298         /** Locations of various types of file (config, module, etc). */
 299         ServerPaths Paths;
 300
 301         /** Configuration parsed from the command line.
 302          */
 303         CommandLineConf cmdline;
 304
 305         /** Clones CIDR range for ipv4 (0-32)
 306          * Defaults to 32 (checks clones on all IPs seperately)
 307          */
 308         unsigned char c_ipv4_range;
 309
 310         /** Clones CIDR range for ipv6 (0-128)
 311          * Defaults to 128 (checks on all IPs seperately)
 312          */
 313         unsigned char c_ipv6_range;
 314
 315         /** Holds the server name of the local server
 316          * as defined by the administrator.
 317          */
 318         std::string ServerName;
 319
 320         /** Notice to give to users when they are banned by an XLine
 321          */
 322         std::string XLineMessage;
 323
 324         /* Holds the network name the local server
 325          * belongs to. This is an arbitary field defined
 326          * by the administrator.
 327          */
 328         std::string Network;
 329
 330         /** Holds the description of the local server
 331          * as defined by the administrator.
 332          */
 333         std::string ServerDesc;
 334
 335         /** How to treat a user in a channel who is banned. */
 336         BannedUserTreatment 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         /** The number of seconds that the server clock can skip by before server operators are warned. */
 368         time_t TimeSkipWarn;
 369
 370         /** True if we're going to hide ban reasons for non-opers (e.g. G-lines,
 371          * K-lines, Z-lines)
 372          */
 373         bool HideBans;
 374
 375         /** True if raw I/O is being logged */
 376         bool RawLog;
 377
 378         /** Set to a non-empty string to obfuscate server names. */
 379         std::string HideServer;
 380
 381         /** The full pathname and filename of the PID
 382          * file as defined in the configuration.
 383          */
 384         std::string PID;
 385
 386         /** The connect classes in use by the IRC server.
 387          */
 388         ClassVector Classes;
 389
 390         /** Default channel modes
 391          */
 392         std::string DefaultModes;
 393
 394         /** Custom version string, which if defined can replace the system info in VERSION.
 395          */
 396         std::string CustomVersion;
 397
 398         /** If set to true, provide syntax hints for unknown commands
 399          */
 400         bool SyntaxHints;
 401
 402         /** The name of the casemapping method used by this server.
 403          */
 404         std::string CaseMapping;
 405
 406         /** If set to true, the full nick!user\@host will be shown in the TOPIC command
 407          * for who set the topic last. If false, only the nick is shown.
 408          */
 409         bool FullHostInTopic;
 410
 411         /** Oper blocks keyed by their name
 412          */
 413         OperIndex oper_blocks;
 414
 415         /** Oper types keyed by their name
 416          */
 417         OperIndex OperTypes;
 418
 419         /** Default value for <connect:maxchans>, deprecated in 3.0
 420          */
 421         unsigned int MaxChans;
 422
 423         /** Default value for <oper:maxchans>, deprecated in 3.0
 424          */
 425         unsigned int OperMaxChans;
 426
 427         /** TS6-like server ID.
 428          * NOTE: 000...999 are usable for InspIRCd servers. This
 429          * makes code simpler. 0AA, 1BB etc with letters are reserved
 430          * for services use.
 431          */
 432         std::string sid;
 433
 434         /** Construct a new ServerConfig
 435          */
 436         ServerConfig();
 437
 438         ~ServerConfig();
 439
 440         /** Get server ID as string with required leading zeroes
 441          */
 442         const std::string& GetSID() const { return sid; }
 443
 444         /** Read the entire configuration into memory
 445          * and initialize this class. All other methods
 446          * should be used only by the core.
 447          */
 448         void Read();
 449
 450         /** Apply configuration changes from the old configuration.
 451          */
 452         void Apply(ServerConfig* old, const std::string &useruid);
 453         void ApplyModules(User* user);
 454
 455         void Fill();
 456
 457         /** Escapes a value for storage in a configuration key.
 458          * @param str The string to escape.
 459          * @param xml Are we using the XML config format?
 460          */
 461         static std::string Escape(const std::string& str, bool xml = true);
 462
 463         /** If this value is true, snotices will not stack when repeats are sent
 464          */
 465         bool NoSnoticeStack;
 466 };
 467
 468 /** The background thread for config reading, so that reading from executable includes
 469  * does not block.
 470  */
 471 class CoreExport ConfigReaderThread : public Thread
 472 {
 473         ServerConfig* Config;
 474         volatile bool done;
 475  public:
 476         const std::string TheUserUID;
 477         ConfigReaderThread(const std::string &useruid)
 478                 : Config(new ServerConfig), done(false), TheUserUID(useruid)
 479         {
 480         }
 481
 482         virtual ~ConfigReaderThread()
 483         {
 484                 delete Config;
 485         }
 486
 487         void Run() CXX11_OVERRIDE;
 488         /** Run in the main thread to apply the configuration */
 489         void Finish();
 490         bool IsDone() { return done; }
 491 };
 492
 493 class CoreExport ConfigStatus
 494 {
 495  public:
 496         User* const srcuser;
 497
 498         ConfigStatus(User* user = NULL)
 499                 : srcuser(user)
 500         {
 501         }
 502 };