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);
  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 of an option
  54          * @param key The option to get
  55          * @param value The location to store the value (unmodified if does not exist)
  56          * @param allow_newline Allow newlines in the option (normally replaced with spaces)
  57          * @return true if the option exists
  58          */
  59         bool readString(const std::string& key, std::string& value, bool allow_newline = false);
  60
  61         std::string getTagLocation();
  62
  63         inline const std::vector<KeyVal>& getItems() const { return items; }
  64
  65         /** Create a new ConfigTag, giving access to the private KeyVal item list */
  66         static ConfigTag* create(const std::string& Tag, const std::string& file, int line,
  67                 std::vector<KeyVal>*&items);
  68  private:
  69         ConfigTag(const std::string& Tag, const std::string& file, int line);
  70 };
  71
  72 /** Defines the server's length limits on various length-limited
  73  * items such as topics, nicknames, channel names etc.
  74  */
  75 class ServerLimits
  76 {
  77  public:
  78         /** Maximum nickname length */
  79         size_t NickMax;
  80         /** Maximum channel length */
  81         size_t ChanMax;
  82         /** Maximum number of modes per line */
  83         size_t MaxModes;
  84         /** Maximum length of ident, not including ~ etc */
  85         size_t IdentMax;
  86         /** Maximum length of a quit message */
  87         size_t MaxQuit;
  88         /** Maximum topic length */
  89         size_t MaxTopic;
  90         /** Maximum kick message length */
  91         size_t MaxKick;
  92         /** Maximum GECOS (real name) length */
  93         size_t MaxGecos;
  94         /** Maximum away message length */
  95         size_t MaxAway;
  96         /** Maximum line length */
  97         size_t MaxLine;
  98
  99         /** Creating the class initialises it to the defaults
 100          * as in 1.1's ./configure script. Reading other values
 101          * from the config will change these values.
 102          */
 103         ServerLimits() : NickMax(31), ChanMax(64), MaxModes(20), IdentMax(12),
 104                 MaxQuit(255), MaxTopic(307), MaxKick(255), MaxGecos(128), MaxAway(200),
 105                 MaxLine(512) { }
 106 };
 107
 108 struct CommandLineConf
 109 {
 110         /** If this value is true, the owner of the
 111          * server specified -nofork on the command
 112          * line, causing the daemon to stay in the
 113          * foreground.
 114          */
 115         bool nofork;
 116
 117         /** If this value if true then all log
 118          * messages will be output, regardless of
 119          * the level given in the config file.
 120          * This is set with the -debug commandline
 121          * option.
 122          */
 123         bool forcedebug;
 124
 125         /** If this is true then log output will be
 126          * written to the logfile. This is the default.
 127          * If you put -nolog on the commandline then
 128          * the logfile will not be written.
 129          * This is meant to be used in conjunction with
 130          * -debug for debugging without filling up the
 131          * hard disk.
 132          */
 133         bool writelog;
 134
 135         /** True if we have been told to run the testsuite from the commandline,
 136          * rather than entering the mainloop.
 137          */
 138         bool TestSuite;
 139
 140         /** Saved argc from startup
 141          */
 142         int argc;
 143
 144         /** Saved argv from startup
 145          */
 146         char** argv;
 147 };
 148
 149 class CoreExport OperInfo : public refcountbase
 150 {
 151  public:
 152         std::set<std::string> AllowedOperCommands;
 153         std::set<std::string> AllowedPrivs;
 154
 155         /** Allowed user modes from oper classes. */
 156         std::bitset<64> AllowedUserModes;
 157
 158         /** Allowed channel modes from oper classes. */
 159         std::bitset<64> AllowedChanModes;
 160
 161         /** \<oper> block used for this oper-up. May be NULL. */
 162         reference<ConfigTag> oper_block;
 163         /** \<type> block used for this oper-up. Valid for local users, may be NULL on remote */
 164         reference<ConfigTag> type_block;
 165         /** \<class> blocks referenced from the \<type> block. These define individual permissions */
 166         std::vector<reference<ConfigTag> > class_blocks;
 167         /** Name of the oper type; i.e. the one shown in WHOIS */
 168         std::string name;
 169
 170         /** Get a configuration item, searching in the oper, type, and class blocks (in that order) */
 171         std::string getConfig(const std::string& key);
 172         void init();
 173 };
 174
 175 /** This class holds the bulk of the runtime configuration for the ircd.
 176  * It allows for reading new config values, accessing configuration files,
 177  * and storage of the configuration data needed to run the ircd, such as
 178  * the servername, connect classes, /ADMIN data, MOTDs and filenames etc.
 179  */
 180 class CoreExport ServerConfig
 181 {
 182   private:
 183         void CrossCheckOperClassType();
 184         void CrossCheckConnectBlocks(ServerConfig* current);
 185
 186  public:
 187
 188         /** Get a configuration tag
 189          * @param tag The name of the tag to get
 190          */
 191         ConfigTag* ConfValue(const std::string& tag);
 192
 193         ConfigTagList ConfTags(const std::string& tag);
 194
 195         /** Error stream, contains error output from any failed configuration parsing.
 196          */
 197         std::stringstream errstr;
 198
 199         /** True if this configuration is valid enough to run with */
 200         bool valid;
 201
 202         /** Bind to IPv6 by default */
 203         bool WildcardIPv6;
 204
 205         /** Used to indicate who we announce invites to on a channel */
 206         enum InviteAnnounceState { INVITE_ANNOUNCE_NONE, INVITE_ANNOUNCE_ALL, INVITE_ANNOUNCE_OPS, INVITE_ANNOUNCE_DYNAMIC };
 207         enum OperSpyWhoisState { SPYWHOIS_NONE, SPYWHOIS_SINGLEMSG, SPYWHOIS_SPLITMSG };
 208
 209         /** This holds all the information in the config file,
 210          * it's indexed by tag name to a vector of key/values.
 211          */
 212         ConfigDataHash config_data;
 213
 214         /** This holds all extra files that have been read in the configuration
 215          * (for example, MOTD and RULES files are stored here)
 216          */
 217         ConfigFileCache Files;
 218
 219         /** Length limits, see definition of ServerLimits class
 220          */
 221         ServerLimits Limits;
 222
 223         /** Configuration parsed from the command line.
 224          */
 225         CommandLineConf cmdline;
 226
 227         /** Clones CIDR range for ipv4 (0-32)
 228          * Defaults to 32 (checks clones on all IPs seperately)
 229          */
 230         int c_ipv4_range;
 231
 232         /** Clones CIDR range for ipv6 (0-128)
 233          * Defaults to 128 (checks on all IPs seperately)
 234          */
 235         int c_ipv6_range;
 236
 237         /** Holds the server name of the local server
 238          * as defined by the administrator.
 239          */
 240         std::string ServerName;
 241
 242         /** Notice to give to users when they are Xlined
 243          */
 244         std::string MoronBanner;
 245
 246         /* Holds the network name the local server
 247          * belongs to. This is an arbitary field defined
 248          * by the administrator.
 249          */
 250         std::string Network;
 251
 252         /** Holds the description of the local server
 253          * as defined by the administrator.
 254          */
 255         std::string ServerDesc;
 256
 257         /** Holds the admin's name, for output in
 258          * the /ADMIN command.
 259          */
 260         std::string AdminName;
 261
 262         /** Holds the email address of the admin,
 263          * for output in the /ADMIN command.
 264          */
 265         std::string AdminEmail;
 266
 267         /** Holds the admin's nickname, for output
 268          * in the /ADMIN command
 269          */
 270         std::string AdminNick;
 271
 272         /** The admin-configured /DIE password
 273          */
 274         std::string diepass;
 275
 276         /** The admin-configured /RESTART password
 277          */
 278         std::string restartpass;
 279
 280         /** The hash method for *BOTH* the die and restart passwords.
 281          */
 282         std::string powerhash;
 283
 284         /** The pathname and filename of the message of the
 285          * day file, as defined by the administrator.
 286          */
 287         std::string motd;
 288
 289         /** The pathname and filename of the rules file,
 290          * as defined by the administrator.
 291          */
 292         std::string rules;
 293
 294         /** The quit prefix in use, or an empty string
 295          */
 296         std::string PrefixQuit;
 297
 298         /** The quit suffix in use, or an empty string
 299          */
 300         std::string SuffixQuit;
 301
 302         /** The fixed quit message in use, or an empty string
 303          */
 304         std::string FixedQuit;
 305
 306         /** The part prefix in use, or an empty string
 307          */
 308         std::string PrefixPart;
 309
 310         /** The part suffix in use, or an empty string
 311          */
 312         std::string SuffixPart;
 313
 314         /** The fixed part message in use, or an empty string
 315          */
 316         std::string FixedPart;
 317
 318         /** Pretend disabled commands don't exist.
 319          */
 320         bool DisabledDontExist;
 321
 322         /** This variable contains a space-seperated list
 323          * of commands which are disabled by the
 324          * administrator of the server for non-opers.
 325          */
 326         std::string DisabledCommands;
 327
 328         /** This variable identifies which usermodes have been diabled.
 329          */
 330         char DisabledUModes[64];
 331
 332         /** This variable identifies which chanmodes have been disabled.
 333          */
 334         char DisabledCModes[64];
 335
 336         /** The full path to the modules directory.
 337          * This is either set at compile time, or
 338          * overridden in the configuration file via
 339          * the \<path> tag.
 340          */
 341         std::string ModPath;
 342
 343         /** If set to true, then all opers on this server are
 344          * shown with a generic 'is an IRC operator' line rather
 345          * than the oper type. Oper types are still used internally.
 346          */
 347         bool GenericOper;
 348
 349         /** If this value is true, banned users (+b, not extbans) will not be able to change nick
 350          * if banned on any channel, nor to message them.
 351          */
 352         bool RestrictBannedUsers;
 353
 354         /** If this is set to true, then mode lists (e.g
 355          * MODE \#chan b) are hidden from unprivileged
 356          * users.
 357          */
 358         bool HideModeLists[256];
 359
 360         /** The number of seconds the DNS subsystem
 361          * will wait before timing out any request.
 362          */
 363         int dns_timeout;
 364
 365         /** The size of the read() buffer in the user
 366          * handling code, used to read data into a user's
 367          * recvQ.
 368          */
 369         int NetBufferSize;
 370
 371         /** The value to be used for listen() backlogs
 372          * as default.
 373          */
 374         int MaxConn;
 375
 376         /** The soft limit value assigned to the irc server.
 377          * The IRC server will not allow more than this
 378          * number of local users.
 379          */
 380         unsigned int SoftLimit;
 381
 382         /** Maximum number of targets for a multi target command
 383          * such as PRIVMSG or KICK
 384          */
 385         unsigned int MaxTargets;
 386
 387         /** True if we're going to hide netsplits as *.net *.split for non-opers
 388          */
 389         bool HideSplits;
 390
 391         /** True if we're going to hide ban reasons for non-opers (e.g. G-Lines,
 392          * K-Lines, Z-Lines)
 393          */
 394         bool HideBans;
 395
 396         /** Announce invites to the channel with a server notice
 397          */
 398         InviteAnnounceState AnnounceInvites;
 399
 400         /** If this is enabled then operators will
 401          * see invisible (+i) channels in /whois.
 402          */
 403         OperSpyWhoisState OperSpyWhois;
 404
 405         /** True if raw I/O is being logged */
 406         bool RawLog;
 407
 408         /** Set to a non-empty string to obfuscate the server name of users in WHOIS
 409          */
 410         std::string HideWhoisServer;
 411
 412         /** Set to a non empty string to obfuscate nicknames prepended to a KILL.
 413          */
 414         std::string HideKillsServer;
 415
 416         /** The full pathname and filename of the PID
 417          * file as defined in the configuration.
 418          */
 419         std::string PID;
 420
 421         /** The connect classes in use by the IRC server.
 422          */
 423         ClassVector Classes;
 424
 425         /** STATS characters in this list are available
 426          * only to operators.
 427          */
 428         std::string UserStats;
 429
 430         /** Default channel modes
 431          */
 432         std::string DefaultModes;
 433
 434         /** Custom version string, which if defined can replace the system info in VERSION.
 435          */
 436         std::string CustomVersion;
 437
 438         /** List of u-lined servers
 439          */
 440         std::map<irc::string, bool> ulines;
 441
 442         /** If set to true, provide syntax hints for unknown commands
 443          */
 444         bool SyntaxHints;
 445
 446         /** If set to true, users appear to quit then rejoin when their hosts change.
 447          * This keeps clients synchronized properly.
 448          */
 449         bool CycleHosts;
 450
 451         /** If set to true, the CycleHosts mode change will be sourced from the user,
 452          * rather than the server
 453          */
 454         bool CycleHostsFromUser;
 455
 456         /** If set to true, prefixed channel NOTICEs and PRIVMSGs will have the prefix
 457          *  added to the outgoing text for undernet style msg prefixing.
 458          */
 459         bool UndernetMsgPrefix;
 460
 461         /** If set to true, the full nick!user\@host will be shown in the TOPIC command
 462          * for who set the topic last. If false, only the nick is shown.
 463          */
 464         bool FullHostInTopic;
 465
 466         /** Oper block and type index.
 467          * For anonymous oper blocks (type only), prefix with a space.
 468          */
 469         OperIndex oper_blocks;
 470
 471         /** Max channels per user
 472          */
 473         unsigned int MaxChans;
 474
 475         /** Oper max channels per user
 476          */
 477         unsigned int OperMaxChans;
 478
 479         /** TS6-like server ID.
 480          * NOTE: 000...999 are usable for InspIRCd servers. This
 481          * makes code simpler. 0AA, 1BB etc with letters are reserved
 482          * for services use.
 483          */
 484         std::string sid;
 485
 486         /** Construct a new ServerConfig
 487          */
 488         ServerConfig();
 489
 490         /** Get server ID as string with required leading zeroes
 491          */
 492         const std::string& GetSID() const { return sid; }
 493
 494         /** Read the entire configuration into memory
 495          * and initialize this class. All other methods
 496          * should be used only by the core.
 497          */
 498         void Read();
 499
 500         /** Apply configuration changes from the old configuration.
 501          */
 502         void Apply(ServerConfig* old, const std::string &useruid);
 503         void ApplyModules(User* user);
 504
 505         void Fill();
 506
 507         /** Returns true if the given string starts with a windows drive letter
 508          */
 509         bool StartsWithWindowsDriveLetter(const std::string &path);
 510
 511         bool ApplyDisabledCommands(const std::string& data);
 512
 513         /** Clean a filename, stripping the directories (and drives) from string.
 514          * @param name Directory to tidy
 515          * @return The cleaned filename
 516          */
 517         static const char* CleanFilename(const char* name);
 518
 519         /** Check if a file exists.
 520          * @param file The full path to a file
 521          * @return True if the file exists and is readable.
 522          */
 523         static bool FileExists(const char* file);
 524
 525         /** Escapes a value for storage in a configuration key.
 526          * @param str The string to escape.
 527          * @param xml Are we using the XML config format?
 528          */
 529         static std::string Escape(const std::string& str, bool xml = true);
 530
 531         /** If this value is true, invites will bypass more than just +i
 532          */
 533         bool InvBypassModes;
 534
 535         /** If this value is true, snotices will not stack when repeats are sent
 536          */
 537         bool NoSnoticeStack;
 538 };
 539
 540 /** The background thread for config reading, so that reading from executable includes
 541  * does not block.
 542  */
 543 class CoreExport ConfigReaderThread : public Thread
 544 {
 545         ServerConfig* Config;
 546         volatile bool done;
 547  public:
 548         const std::string TheUserUID;
 549         ConfigReaderThread(const std::string &useruid)
 550                 : Config(new ServerConfig), done(false), TheUserUID(useruid)
 551         {
 552         }
 553
 554         virtual ~ConfigReaderThread()
 555         {
 556                 delete Config;
 557         }
 558
 559         void Run();
 560         /** Run in the main thread to apply the configuration */
 561         void Finish();
 562         bool IsDone() { return done; }
 563 };