include/configreader.h

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