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