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