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
  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         /** Holds the server name of the local server
 243          * as defined by the administrator.
 244          */
 245         std::string ServerName;
 246
 247         /** Notice to give to users when they are Xlined
 248          */
 249         std::string MoronBanner;
 250
 251         /* Holds the network name the local server
 252          * belongs to. This is an arbitary field defined
 253          * by the administrator.
 254          */
 255         std::string Network;
 256
 257         /** Holds the description of the local server
 258          * as defined by the administrator.
 259          */
 260         std::string ServerDesc;
 261
 262         /** Holds the admin's name, for output in
 263          * the /ADMIN command.
 264          */
 265         std::string AdminName;
 266
 267         /** Holds the email address of the admin,
 268          * for output in the /ADMIN command.
 269          */
 270         std::string AdminEmail;
 271
 272         /** Holds the admin's nickname, for output
 273          * in the /ADMIN command
 274          */
 275         std::string AdminNick;
 276
 277         /** The admin-configured /DIE password
 278          */
 279         std::string diepass;
 280
 281         /** The admin-configured /RESTART password
 282          */
 283         std::string restartpass;
 284
 285         /** The hash method for *BOTH* the die and restart passwords.
 286          */
 287         std::string powerhash;
 288
 289         /** The pathname and filename of the message of the
 290          * day file, as defined by the administrator.
 291          */
 292         std::string motd;
 293
 294         /** The pathname and filename of the rules file,
 295          * as defined by the administrator.
 296          */
 297         std::string rules;
 298
 299         /** The quit prefix in use, or an empty string
 300          */
 301         std::string PrefixQuit;
 302
 303         /** The quit suffix in use, or an empty string
 304          */
 305         std::string SuffixQuit;
 306
 307         /** The fixed quit message in use, or an empty string
 308          */
 309         std::string FixedQuit;
 310
 311         /** The part prefix in use, or an empty string
 312          */
 313         std::string PrefixPart;
 314
 315         /** The part suffix in use, or an empty string
 316          */
 317         std::string SuffixPart;
 318
 319         /** The fixed part message in use, or an empty string
 320          */
 321         std::string FixedPart;
 322
 323         /** The DNS server to use for DNS queries
 324          */
 325         std::string DNSServer;
 326
 327         /** Pretend disabled commands don't exist.
 328          */
 329         bool DisabledDontExist;
 330
 331         /** This variable contains a space-seperated list
 332          * of commands which are disabled by the
 333          * administrator of the server for non-opers.
 334          */
 335         std::string DisabledCommands;
 336
 337         /** This variable identifies which usermodes have been diabled.
 338          */
 339         char DisabledUModes[64];
 340
 341         /** This variable identifies which chanmodes have been disabled.
 342          */
 343         char DisabledCModes[64];
 344
 345         /** The full path to the modules directory.
 346          * This is either set at compile time, or
 347          * overridden in the configuration file via
 348          * the \<path> tag.
 349          */
 350         std::string ModPath;
 351
 352         /** If set to true, then all opers on this server are
 353          * shown with a generic 'is an IRC operator' line rather
 354          * than the oper type. Oper types are still used internally.
 355          */
 356         bool GenericOper;
 357
 358         /** If this value is true, banned users (+b, not extbans) will not be able to change nick
 359          * if banned on any channel, nor to message them.
 360          */
 361         bool RestrictBannedUsers;
 362
 363         /** If this is set to true, then mode lists (e.g
 364          * MODE \#chan b) are hidden from unprivileged
 365          * users.
 366          */
 367         bool HideModeLists[256];
 368
 369         /** The number of seconds the DNS subsystem
 370          * will wait before timing out any request.
 371          */
 372         int dns_timeout;
 373
 374         /** The size of the read() buffer in the user
 375          * handling code, used to read data into a user's
 376          * recvQ.
 377          */
 378         int NetBufferSize;
 379
 380         /** The value to be used for listen() backlogs
 381          * as default.
 382          */
 383         int MaxConn;
 384
 385         /** The soft limit value assigned to the irc server.
 386          * The IRC server will not allow more than this
 387          * number of local users.
 388          */
 389         unsigned int SoftLimit;
 390
 391         /** Maximum number of targets for a multi target command
 392          * such as PRIVMSG or KICK
 393          */
 394         unsigned int MaxTargets;
 395
 396         /** True if we're going to hide netsplits as *.net *.split for non-opers
 397          */
 398         bool HideSplits;
 399
 400         /** True if we're going to hide ban reasons for non-opers (e.g. G-Lines,
 401          * K-Lines, Z-Lines)
 402          */
 403         bool HideBans;
 404
 405         /** Announce invites to the channel with a server notice
 406          */
 407         InviteAnnounceState AnnounceInvites;
 408
 409         /** If this is enabled then operators will
 410          * see invisible (+i) channels in /whois.
 411          */
 412         OperSpyWhoisState OperSpyWhois;
 413
 414         /** True if raw I/O is being logged */
 415         bool RawLog;
 416
 417         /** Set to a non-empty string to obfuscate the server name of users in WHOIS
 418          */
 419         std::string HideWhoisServer;
 420
 421         /** Set to a non empty string to obfuscate nicknames prepended to a KILL.
 422          */
 423         std::string HideKillsServer;
 424
 425         /** The full pathname and filename of the PID
 426          * file as defined in the configuration.
 427          */
 428         std::string PID;
 429
 430         /** The connect classes in use by the IRC server.
 431          */
 432         ClassVector Classes;
 433
 434         /** STATS characters in this list are available
 435          * only to operators.
 436          */
 437         std::string UserStats;
 438
 439         /** Default channel modes
 440          */
 441         std::string DefaultModes;
 442
 443         /** Custom version string, which if defined can replace the system info in VERSION.
 444          */
 445         std::string CustomVersion;
 446
 447         /** List of u-lined servers
 448          */
 449         std::map<irc::string, bool> ulines;
 450
 451         /** If set to true, no user DNS lookups are to be performed
 452          */
 453         bool NoUserDns;
 454
 455         /** If set to true, provide syntax hints for unknown commands
 456          */
 457         bool SyntaxHints;
 458
 459         /** If set to true, users appear to quit then rejoin when their hosts change.
 460          * This keeps clients synchronized properly.
 461          */
 462         bool CycleHosts;
 463
 464         /** If set to true, the CycleHosts mode change will be sourced from the user,
 465          * rather than the server
 466          */
 467         bool CycleHostsFromUser;
 468
 469         /** If set to true, prefixed channel NOTICEs and PRIVMSGs will have the prefix
 470          *  added to the outgoing text for undernet style msg prefixing.
 471          */
 472         bool UndernetMsgPrefix;
 473
 474         /** If set to true, the full nick!user\@host will be shown in the TOPIC command
 475          * for who set the topic last. If false, only the nick is shown.
 476          */
 477         bool FullHostInTopic;
 478
 479         /** Oper block and type index.
 480          * For anonymous oper blocks (type only), prefix with a space.
 481          */
 482         OperIndex oper_blocks;
 483
 484         /** Max channels per user
 485          */
 486         unsigned int MaxChans;
 487
 488         /** Oper max channels per user
 489          */
 490         unsigned int OperMaxChans;
 491
 492         /** TS6-like server ID.
 493          * NOTE: 000...999 are usable for InspIRCd servers. This
 494          * makes code simpler. 0AA, 1BB etc with letters are reserved
 495          * for services use.
 496          */
 497         std::string sid;
 498
 499         /** Construct a new ServerConfig
 500          */
 501         ServerConfig();
 502
 503         /** Get server ID as string with required leading zeroes
 504          */
 505         const std::string& GetSID();
 506
 507         /** Read the entire configuration into memory
 508          * and initialize this class. All other methods
 509          * should be used only by the core.
 510          */
 511         void Read();
 512
 513         /** Apply configuration changes from the old configuration.
 514          */
 515         void Apply(ServerConfig* old, const std::string &useruid);
 516         void ApplyModules(User* user);
 517
 518         void Fill();
 519
 520         /** Returns true if the given string starts with a windows drive letter
 521          */
 522         bool StartsWithWindowsDriveLetter(const std::string &path);
 523
 524         bool ApplyDisabledCommands(const std::string& data);
 525
 526         /** Clean a filename, stripping the directories (and drives) from string.
 527          * @param name Directory to tidy
 528          * @return The cleaned filename
 529          */
 530         static const char* CleanFilename(const char* name);
 531
 532         /** Check if a file exists.
 533          * @param file The full path to a file
 534          * @return True if the file exists and is readable.
 535          */
 536         static bool FileExists(const char* file);
 537
 538         /** If this value is true, invites will bypass more than just +i
 539          */
 540         bool InvBypassModes;
 541
 542         /** If this value is true, snotices will not stack when repeats are sent
 543          */
 544         bool NoSnoticeStack;
 545 };
 546
 547 /** The background thread for config reading, so that reading from executable includes
 548  * does not block.
 549  */
 550 class CoreExport ConfigReaderThread : public Thread
 551 {
 552         ServerConfig* Config;
 553         volatile bool done;
 554  public:
 555         const std::string TheUserUID;
 556         ConfigReaderThread(const std::string &useruid)
 557                 : Config(new ServerConfig), done(false), TheUserUID(useruid)
 558         {
 559         }
 560
 561         virtual ~ConfigReaderThread()
 562         {
 563                 delete Config;
 564         }
 565
 566         void Run();
 567         /** Run in the main thread to apply the configuration */
 568         void Finish();
 569         bool IsDone() { return done; }
 570 };