diff options
| author | 2020-05-05 22:03:14 +0100 | |
|---|---|---|
| committer | 2020-05-05 22:03:14 +0100 | |
| commit | b755d2a778e0adb86c3b10757083c169eedb6de6 (patch) | |
| tree | 3d737ea47c535c4b60076feb26055e68f7d8aec5 /include | |
| parent | Revert "Convert UserType to an enum class". (diff) | |
| parent | Fix shuns not being applied correctly. (diff) | |
Merge branch 'insp3' into master.
Diffstat (limited to 'include')
| -rw-r--r-- | include/base.h | 1 | ||||
| -rw-r--r-- | include/channels.h | 6 | ||||
| -rw-r--r-- | include/clientprotocol.h | 2 | ||||
| -rw-r--r-- | include/clientprotocolmsg.h | 2 | ||||
| -rw-r--r-- | include/command_parse.h | 10 | ||||
| -rw-r--r-- | include/configreader.h | 8 | ||||
| -rw-r--r-- | include/convto.h | 1 | ||||
| -rw-r--r-- | include/ctables.h | 4 | ||||
| -rw-r--r-- | include/dynamic.h | 2 | ||||
| -rw-r--r-- | include/extensible.h | 4 | ||||
| -rw-r--r-- | include/hashcomp.h | 10 | ||||
| -rw-r--r-- | include/inspircd.h | 2 | ||||
| -rw-r--r-- | include/inspstring.h | 2 | ||||
| -rw-r--r-- | include/logger.h | 4 | ||||
| -rw-r--r-- | include/mode.h | 12 | ||||
| -rw-r--r-- | include/modules.h | 35 | ||||
| -rw-r--r-- | include/modules/ircv3_batch.h | 2 | ||||
| -rw-r--r-- | include/modules/ircv3_replies.h | 2 | ||||
| -rw-r--r-- | include/modules/sql.h | 2 | ||||
| -rw-r--r-- | include/modules/ssl.h | 5 | ||||
| -rw-r--r-- | include/numericbuilder.h | 2 | ||||
| -rw-r--r-- | include/numerics.h | 2 | ||||
| -rw-r--r-- | include/protocol.h | 4 | ||||
| -rw-r--r-- | include/serialize.h | 2 | ||||
| -rw-r--r-- | include/server.h | 2 | ||||
| -rw-r--r-- | include/socketengine.h | 8 | ||||
| -rw-r--r-- | include/typedefs.h | 2 | ||||
| -rw-r--r-- | include/usermanager.h | 4 | ||||
| -rw-r--r-- | include/users.h | 10 | ||||
| -rw-r--r-- | include/xline.h | 10 |
30 files changed, 83 insertions, 79 deletions
diff --git a/include/base.h b/include/base.h index 5831132d3..efe3bbb4d 100644 --- a/include/base.h +++ b/include/base.h @@ -1,6 +1,7 @@ /* * InspIRCd -- Internet Relay Chat Daemon * + * Copyright (C) 2020 Matt Schatz <genius3000@g3k.solutions> * Copyright (C) 2013, 2015 Attila Molnar <attilamolnar@hush.com> * Copyright (C) 2012-2013, 2017 Sadie Powell <sadie@witchery.services> * Copyright (C) 2012 Robby <robby@chatbelgie.be> diff --git a/include/channels.h b/include/channels.h index 1876c4073..920b74a55 100644 --- a/include/channels.h +++ b/include/channels.h @@ -33,7 +33,7 @@ * This class contains a single element in a channel list, such as a banlist. */ -/** Holds all relevent information for a channel. +/** Holds all relevant information for a channel. * This class represents a channel, and contains its name, modes, topic, topic set time, * etc, and an instance of the BanList type. */ @@ -158,7 +158,7 @@ class CoreExport Channel : public Extensible * @param user The user to add * * The data inserted into the reference list is a table as it is - * an arbitary pointer compared to other users by its memory address, + * an arbitrary pointer compared to other users by its memory address, * as this is a very fast 32 or 64 bit integer comparison. */ Membership* AddUser(User* user); @@ -228,7 +228,7 @@ class CoreExport Channel : public Extensible /** Join a user to an existing channel, without doing any permission checks * @param user The user to join to the channel - * @param privs Priviliges (prefix mode letters) to give to this user, may be NULL + * @param privs Privileges (prefix mode letters) to give to this user, may be NULL * @param bursting True if this join is the result of a netburst (passed to modules in the OnUserJoin hook) * @param created_by_local True if this channel was just created by a local user (passed to modules in the OnUserJoin hook) * @return A newly created Membership object, or NULL if the user was already inside the channel or if the user is a server user diff --git a/include/clientprotocol.h b/include/clientprotocol.h index 7320525a8..64383e0a6 100644 --- a/include/clientprotocol.h +++ b/include/clientprotocol.h @@ -690,7 +690,7 @@ class CoreExport ClientProtocol::Serializer : public DataProvider * @param tagname Name of the tag. * @param tagvalue Tag value, may be empty. * @param tags TagMap to place the tag into, if it gets accepted. - * @return True if no error occured, false if the tag name is invalid or if this tag already exists. + * @return True if no error occurred, false if the tag name is invalid or if this tag already exists. */ bool HandleTag(LocalUser* user, const std::string& tagname, std::string& tagvalue, TagMap& tags) const; diff --git a/include/clientprotocolmsg.h b/include/clientprotocolmsg.h index b828934d4..863cdf8b2 100644 --- a/include/clientprotocolmsg.h +++ b/include/clientprotocolmsg.h @@ -1,7 +1,7 @@ /* * InspIRCd -- Internet Relay Chat Daemon * - * Copyright (C) 2018 Sadie Powell <sadie@witchery.services> + * Copyright (C) 2018, 2020 Sadie Powell <sadie@witchery.services> * Copyright (C) 2018 Attila Molnar <attilamolnar@hush.com> * * This file is part of InspIRCd. InspIRCd is free software: you can diff --git a/include/command_parse.h b/include/command_parse.h index 596fa6a9c..f44fd2db9 100644 --- a/include/command_parse.h +++ b/include/command_parse.h @@ -28,7 +28,7 @@ /** This class handles command management and parsing. * It allows you to add and remove commands from the map, - * call command handlers by name, and chop up comma seperated + * call command handlers by name, and chop up comma separated * parameters into multiple calls. */ class CoreExport CommandParser @@ -78,7 +78,7 @@ class CoreExport CommandParser */ Command* GetHandler(const std::string &commandname); - /** LoopCall is used to call a command handler repeatedly based on the contents of a comma seperated list. + /** LoopCall is used to call a command handler repeatedly based on the contents of a comma separated list. * There are two ways to call this method, either with one potential list or with two potential lists. * We need to handle two potential lists for JOIN, because a JOIN may contain two lists of items at once: * the channel names and their keys as follows: @@ -101,15 +101,15 @@ class CoreExport CommandParser * If there are two lists and the second list runs out of tokens before the first list then parameters[extra] * will be an EMPTY string when Handle() is called for the remaining tokens in the first list, even if it is * in the middle of parameters[]! Moreover, empty tokens in the second list are allowed, and those will also - * result in the appropiate entry being empty in parameters[]. + * result in the appropriate entry being empty in parameters[]. * This is different than what command handlers usually expect; the command parser only allows an empty param * as the last item in the vector. * * @param user The user who sent the command * @param handler The command handler to call for each parameter in the list * @param parameters Parameter list as a vector of strings - * @param splithere The first parameter index to split as a comma seperated list - * @param extra The second parameter index to split as a comma seperated list, or -1 (the default) if there is only one list + * @param splithere The first parameter index to split as a comma separated list + * @param extra The second parameter index to split as a comma separated list, or -1 (the default) if there is only one list * @param usemax True to limit the command to MaxTargets targets (default), or false to process all tokens * @return This function returns true when it identified a list in the given parameter and finished calling the * command handler for each entry on the list. When this occurs, the caller should return without doing anything, diff --git a/include/configreader.h b/include/configreader.h index a9a1f12e4..e82be9dbc 100644 --- a/include/configreader.h +++ b/include/configreader.h @@ -5,7 +5,7 @@ * Copyright (C) 2018 Chris Novakovic <chrisnovakovic@users.noreply.github.com> * Copyright (C) 2013-2014, 2016 Attila Molnar <attilamolnar@hush.com> * Copyright (C) 2013 Daniel Vassdal <shutter@canternet.org> - * Copyright (C) 2012-2014, 2016-2019 Sadie Powell <sadie@witchery.services> + * Copyright (C) 2012-2014, 2016-2020 Sadie Powell <sadie@witchery.services> * Copyright (C) 2012, 2019 Robby <robby@chatbelgie.be> * Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org> * Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org> @@ -313,12 +313,12 @@ class CoreExport ServerConfig CommandLineConf cmdline; /** Clones CIDR range for ipv4 (0-32) - * Defaults to 32 (checks clones on all IPs seperately) + * Defaults to 32 (checks clones on all IPs separately) */ unsigned char c_ipv4_range; /** Clones CIDR range for ipv6 (0-128) - * Defaults to 128 (checks on all IPs seperately) + * Defaults to 128 (checks on all IPs separately) */ unsigned char c_ipv6_range; @@ -332,7 +332,7 @@ class CoreExport ServerConfig std::string XLineMessage; /* Holds the network name the local server - * belongs to. This is an arbitary field defined + * belongs to. This is an arbitrary field defined * by the administrator. */ std::string Network; diff --git a/include/convto.h b/include/convto.h index 1fc684829..9bad62b93 100644 --- a/include/convto.h +++ b/include/convto.h @@ -1,6 +1,7 @@ /* * InspIRCd -- Internet Relay Chat Daemon * + * Copyright (C) 2020 Matt Schatz <genius3000@g3k.solutions> * Copyright (C) 2017-2019 Sadie Powell <sadie@witchery.services> * Copyright (C) 2016 Attila Molnar <attilamolnar@hush.com> * diff --git a/include/ctables.h b/include/ctables.h index c2b2382f5..9da201113 100644 --- a/include/ctables.h +++ b/include/ctables.h @@ -2,7 +2,7 @@ * InspIRCd -- Internet Relay Chat Daemon * * Copyright (C) 2012-2015, 2018 Attila Molnar <attilamolnar@hush.com> - * Copyright (C) 2012-2013, 2017-2018 Sadie Powell <sadie@witchery.services> + * Copyright (C) 2012-2013, 2017-2018, 2020 Sadie Powell <sadie@witchery.services> * Copyright (C) 2012 Robby <robby@chatbelgie.be> * Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org> * Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org> @@ -187,7 +187,7 @@ class CoreExport CommandBase : public ServiceProvider * @param cmd Command name. This must be UPPER CASE. * @param minpara Minimum parameters required for the command. * @param maxpara Maximum number of parameters this command may have - extra parameters - * will be tossed into one last space-seperated param. + * will be tossed into one last space-separated param. */ CommandBase(Module* me, const std::string& cmd, unsigned int minpara = 0, unsigned int maxpara = 0); diff --git a/include/dynamic.h b/include/dynamic.h index ad995042a..9ffcbf499 100644 --- a/include/dynamic.h +++ b/include/dynamic.h @@ -1,7 +1,7 @@ /* * InspIRCd -- Internet Relay Chat Daemon * - * Copyright (C) 2013, 2019 Sadie Powell <sadie@witchery.services> + * Copyright (C) 2013, 2019-2020 Sadie Powell <sadie@witchery.services> * Copyright (C) 2012 Robby <robby@chatbelgie.be> * Copyright (C) 2012 ChrisTX <xpipe@hotmail.de> * Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org> diff --git a/include/extensible.h b/include/extensible.h index 1ac013402..4955fd924 100644 --- a/include/extensible.h +++ b/include/extensible.h @@ -1,7 +1,7 @@ /* * InspIRCd -- Internet Relay Chat Daemon * - * Copyright (C) 2013, 2017-2019 Sadie Powell <sadie@witchery.services> + * Copyright (C) 2013, 2017-2020 Sadie Powell <sadie@witchery.services> * Copyright (C) 2012, 2014-2015 Attila Molnar <attilamolnar@hush.com> * Copyright (C) 2012 Robby <robby@chatbelgie.be> * Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org> @@ -120,7 +120,7 @@ class CoreExport ExtensionItem : public ServiceProvider, public usecountbase * a map associated with the object. In this way modules can store their own custom information within user * objects, channel objects and server objects, without breaking other modules (this is more sensible than using * a flags variable, and each module defining bits within the flag as 'theirs' as it is less prone to conflict and - * supports arbitary data storage). + * supports arbitrary data storage). */ class CoreExport Extensible : public classbase diff --git a/include/hashcomp.h b/include/hashcomp.h index 431c2d946..ffcc51aa6 100644 --- a/include/hashcomp.h +++ b/include/hashcomp.h @@ -51,7 +51,7 @@ * mapping arrays internally. *******************************************************/ -/** Seperate from the other casemap tables so that code *can* still exclusively rely on RFC casemapping +/** Separate from the other casemap tables so that code *can* still exclusively rely on RFC casemapping * if it must. * * This is provided as a pointer so that modules can change it to their custom mapping tables, @@ -109,7 +109,7 @@ namespace irc bool CoreExport operator()(const std::string& a, const std::string& b) const; }; - /** irc::sepstream allows for splitting token seperated lists. + /** irc::sepstream allows for splitting token separated lists. * Each successive call to sepstream::GetToken() returns * the next token, until none remain, at which point the method returns * false. @@ -172,7 +172,7 @@ namespace irc bool Contains(const std::string& value); }; - /** A derived form of sepstream, which seperates on commas + /** A derived form of sepstream, which separates on commas */ class CoreExport commasepstream : public sepstream { @@ -184,7 +184,7 @@ namespace irc } }; - /** A derived form of sepstream, which seperates on spaces + /** A derived form of sepstream, which separates on spaces */ class CoreExport spacesepstream : public sepstream { @@ -237,7 +237,7 @@ namespace irc bool GetTrailing(std::string& token); }; - /** The portparser class seperates out a port range into integers. + /** The portparser class separates out a port range into integers. * A port range may be specified in the input string in the form * "6660,6661,6662-6669,7020". The end of the stream is indicated by * a return value of 0 from portparser::GetToken(). If you attempt diff --git a/include/inspircd.h b/include/inspircd.h index 8dfda7853..7ee938c71 100644 --- a/include/inspircd.h +++ b/include/inspircd.h @@ -208,7 +208,7 @@ class CoreExport InspIRCd * Reason for it: * kludge alert! * SendMode expects a User* to send the numeric replies - * back to, so we create it a fake user that isnt in the user + * back to, so we create it a fake user that isn't in the user * hash and set its descriptor to FD_MAGIC_NUMBER so the data * falls into the abyss :p */ diff --git a/include/inspstring.h b/include/inspstring.h index 050a375e1..de0f8be42 100644 --- a/include/inspstring.h +++ b/include/inspstring.h @@ -31,7 +31,7 @@ #include "config.h" #include <cstring> -/** Sets ret to the formated string. last is the last parameter before ..., and format is the format in printf-style */ +/** Sets ret to the formatted string. last is the last parameter before ..., and format is the format in printf-style */ #define VAFORMAT(ret, last, format) \ do { \ va_list _vaList; \ diff --git a/include/logger.h b/include/logger.h index ab2902099..05303e3ea 100644 --- a/include/logger.h +++ b/include/logger.h @@ -50,7 +50,7 @@ class CoreExport FileWriter */ unsigned int flush; - /** Number of write operations that have occured + /** Number of write operations that have occurred */ unsigned int writeops = 0; @@ -126,7 +126,7 @@ typedef std::map<FileWriter*, int> FileLogMap; class CoreExport LogManager { private: - /** Lock variable, set to true when a log is in progress, which prevents further loggging from happening and creating a loop. + /** Lock variable, set to true when a log is in progress, which prevents further logging from happening and creating a loop. */ bool Logging = false; diff --git a/include/mode.h b/include/mode.h index 8878f9f79..6def758cc 100644 --- a/include/mode.h +++ b/include/mode.h @@ -137,7 +137,7 @@ class CoreExport ModeHandler : public ServiceProvider * inside the mode parser as in the 1.0 api, * so the only use of this value (along with * IsListMode()) is for the core to determine - * wether your module can produce 'lists' or not + * whether your module can produce 'lists' or not * (e.g. banlists, etc) */ bool list = false; @@ -163,7 +163,7 @@ class CoreExport ModeHandler : public ServiceProvider public: /** - * The constructor for ModeHandler initalizes the mode handler. + * The constructor for ModeHandler initializes the mode handler. * The constructor of any class you derive from ModeHandler should * probably call this constructor with the parameters set correctly. * @param me The module which created this mode @@ -293,7 +293,7 @@ class CoreExport ModeHandler : public ServiceProvider /** * If your mode is a listmode, this method will be called to display an empty list (just the end of list numeric) * @param user The user issuing the command - * @param channel The channel tehy're requesting an item list of (e.g. a banlist, or an exception list etc) + * @param channel The channel they're requesting an item list of (e.g. a banlist, or an exception list etc) */ virtual void DisplayEmptyList(User* user, Channel* channel); @@ -311,7 +311,7 @@ class CoreExport ModeHandler : public ServiceProvider /** * When a MODETYPE_USER mode handler is being removed, the core will call this method for every user on the server. - * The usermode will be removed using the appropiate server mode using InspIRCd::SendMode(). + * The usermode will be removed using the appropriate server mode using InspIRCd::SendMode(). * @param user The user which the server wants to remove your mode from */ void RemoveMode(User* user); @@ -766,7 +766,7 @@ class CoreExport ModeParser /** Find the mode handler for a given mode and type. * @param modeletter mode letter to search for * @param mt type of mode to search for, user or channel - * @returns a pointer to a ModeHandler class, or NULL of there isnt a handler for the given mode + * @returns a pointer to a ModeHandler class, or NULL of there isn't a handler for the given mode */ ModeHandler* FindMode(unsigned const char modeletter, ModeType mt); @@ -783,7 +783,7 @@ class CoreExport ModeParser */ PrefixMode* FindPrefix(unsigned const char pfxletter); - /** Generates a list of modes, comma seperated by type: + /** Generates a list of modes, comma separated by type: * 1; Listmodes EXCEPT those with a prefix * 2; Modes that take a param when adding or removing * 3; Modes that only take a param when adding diff --git a/include/modules.h b/include/modules.h index 87874f971..18b4ed487 100644 --- a/include/modules.h +++ b/include/modules.h @@ -1,10 +1,11 @@ /* * InspIRCd -- Internet Relay Chat Daemon * + * Copyright (C) 2020 Matt Schatz <genius3000@g3k.solutions> * Copyright (C) 2019 iwalkalone <iwalkalone69@gmail.com> * Copyright (C) 2013 Adam <Adam@anope.org> * Copyright (C) 2012-2016, 2018 Attila Molnar <attilamolnar@hush.com> - * Copyright (C) 2012-2013, 2016-2020 Sadie Powell <sadie@witchery.services> + * Copyright (C) 2012-2013, 2017-2020 Sadie Powell <sadie@witchery.services> * Copyright (C) 2012 Robby <robby@chatbelgie.be> * Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org> * Copyright (C) 2009 Uli Schlachter <psychon@inspircd.org> @@ -202,7 +203,7 @@ enum Implementation /** Base class for all InspIRCd modules * This class is the base class for InspIRCd modules. All modules must inherit from this class, * its methods will be called when irc server events occur. class inherited from module must be - * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised. + * instantiated by the ModuleFactory class (see relevant section) for the module to be initialised. */ class CoreExport Module : public classbase, public usecountbase { @@ -426,7 +427,7 @@ class CoreExport Module : public classbase, public usecountbase /** Called after a user opers locally. * This is identical to Module::OnOper(), except it is called after OnOper so that other modules - * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent + * can be guaranteed to already have processed the oper-up, for example m_spanningtree has sent * out the OPERTYPE, etc. * @param user The user who is opering up * @param opername The name of the oper that the user is opering up to. Only valid locally. Empty string otherwise. @@ -452,7 +453,7 @@ class CoreExport Module : public classbase, public usecountbase virtual ModResult OnUserPreInvite(User* source,User* dest,Channel* channel, time_t timeout); /** Called after a user has been successfully invited to a channel. - * You cannot prevent the invite from occuring using this function, to do that, + * You cannot prevent the invite from occurring using this function, to do that, * use OnUserPreInvite instead. * @param source The user who is issuing the INVITE * @param dest The user being invited @@ -639,7 +640,7 @@ class CoreExport Module : public classbase, public usecountbase * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly * recommended that modules do *NOT* bail if they cannot satisfy dependencies, * but instead operate under reduced functionality, unless the dependency is - * absolutely neccessary (e.g. a module that extends the features of another + * absolutely necessary (e.g. a module that extends the features of another * module). * @param mod A pointer to the new module */ @@ -652,7 +653,7 @@ class CoreExport Module : public classbase, public usecountbase * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly * recommended that modules do *NOT* bail if they cannot satisfy dependencies, * but instead operate under reduced functionality, unless the dependency is - * absolutely neccessary (e.g. a module that extends the features of another + * absolutely necessary (e.g. a module that extends the features of another * module). * @param mod Pointer to the module being unloaded (still valid) */ @@ -660,18 +661,18 @@ class CoreExport Module : public classbase, public usecountbase /** Called once every five seconds for background processing. * This timer can be used to control timed features. Its period is not accurate - * enough to be used as a clock, but it is gauranteed to be called at least once in + * enough to be used as a clock, but it is guaranteed to be called at least once in * any five second period, directly from the main loop of the server. * @param curtime The current timer derived from time(2) */ virtual void OnBackgroundTimer(time_t curtime); /** Called whenever any command is about to be executed. - * This event occurs for all registered commands, wether they are registered in the core, + * This event occurs for all registered commands, whether they are registered in the core, * or another module, and for invalid commands. Invalid commands may only be sent to this * function when the value of validated is false. By returning 1 from this method you may prevent the * command being executed. If you do this, no output is created by the core, and it is - * down to your module to produce any output neccessary. + * down to your module to produce any output necessary. * Note that unless you return 1, you should not destroy any structures (e.g. by using * InspIRCd::QuitUser) otherwise when the command's handler function executes after your * method returns, it will be passed an invalid pointer to the user object and crash!) @@ -685,7 +686,7 @@ class CoreExport Module : public classbase, public usecountbase virtual ModResult OnPreCommand(std::string& command, CommandBase::Params& parameters, LocalUser* user, bool validated); /** Called after any command has been executed. - * This event occurs for all registered commands, wether they are registered in the core, + * This event occurs for all registered commands, whether they are registered in the core, * or another module, but it will not occur for invalid commands (e.g. ones which do not * exist within the command table). The result code returned by the command handler is * provided. @@ -742,7 +743,7 @@ class CoreExport Module : public classbase, public usecountbase virtual ModResult OnUserRegister(LocalUser* user); /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not. - * This method will always be called for each join, wether or not the channel is actually +i, and + * This method will always be called for each join, whether or not the channel is actually +i, and * determines the outcome of an if statement around the whole section of invite checking code. * return 1 to explicitly allow the join to go ahead or 0 to ignore the event. * @param user The user joining the channel @@ -765,7 +766,7 @@ class CoreExport Module : public classbase, public usecountbase virtual ModResult OnRawMode(User* user, Channel* chan, ModeHandler* mh, const std::string& param, bool adding); /** Called whenever a user joins a channel, to determine if key checks should go ahead or not. - * This method will always be called for each join, wether or not the channel is actually +k, and + * This method will always be called for each join, whether or not the channel is actually +k, and * determines the outcome of an if statement around the whole section of key checking code. * if the user specified no key, the keygiven string will be a valid but empty value. * return 1 to explicitly allow the join to go ahead or 0 to ignore the event. @@ -777,7 +778,7 @@ class CoreExport Module : public classbase, public usecountbase virtual ModResult OnCheckKey(User* user, Channel* chan, const std::string &keygiven); /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not. - * This method will always be called for each join, wether or not the channel is actually +l, and + * This method will always be called for each join, whether or not the channel is actually +l, and * determines the outcome of an if statement around the whole section of channel limit checking code. * return 1 to explicitly allow the join to go ahead or 0 to ignore the event. * @param user The user joining the channel @@ -1031,17 +1032,17 @@ class CoreExport ModuleManager void SetPriority(Module* mod, Priority s); /** Attach an event to a module. - * You may later detatch the event with ModuleManager::Detach(). - * If your module is unloaded, all events are automatically detatched. + * You may later detach the event with ModuleManager::Detach(). + * If your module is unloaded, all events are automatically detached. * @param i Event type to attach * @param mod Module to attach event to * @return True if the event was attached */ bool Attach(Implementation i, Module* mod); - /** Detatch an event from a module. + /** Detach an event from a module. * This is not required when your module unloads, as the core will - * automatically detatch your module from all events it is attached to. + * automatically detach your module from all events it is attached to. * @param i Event type to detach * @param mod Module to detach event from * @return True if the event was detached diff --git a/include/modules/ircv3_batch.h b/include/modules/ircv3_batch.h index 9e64c4fcc..073fb535f 100644 --- a/include/modules/ircv3_batch.h +++ b/include/modules/ircv3_batch.h @@ -1,7 +1,7 @@ /* * InspIRCd -- Internet Relay Chat Daemon * - * Copyright (C) 2018-2019 Sadie Powell <sadie@witchery.services> + * Copyright (C) 2018-2020 Sadie Powell <sadie@witchery.services> * Copyright (C) 2018 Attila Molnar <attilamolnar@hush.com> * * This file is part of InspIRCd. InspIRCd is free software: you can diff --git a/include/modules/ircv3_replies.h b/include/modules/ircv3_replies.h index 3ff462ad7..4666f002a 100644 --- a/include/modules/ircv3_replies.h +++ b/include/modules/ircv3_replies.h @@ -1,7 +1,7 @@ /* * InspIRCd -- Internet Relay Chat Daemon * - * Copyright (C) 2019 Sadie Powell <sadie@witchery.services> + * Copyright (C) 2019-2020 Sadie Powell <sadie@witchery.services> * * This file is part of InspIRCd. InspIRCd is free software: you can * redistribute it and/or modify it under the terms of the GNU General Public diff --git a/include/modules/sql.h b/include/modules/sql.h index 927d54ee7..47da6f6bf 100644 --- a/include/modules/sql.h +++ b/include/modules/sql.h @@ -107,7 +107,7 @@ class SQL::Result : public classbase /** * Return the number of rows in the result. * - * Note that if you have perfomed an INSERT or UPDATE query or other + * Note that if you have performed an INSERT or UPDATE query or other * query which will not return rows, this will return the number of * affected rows. In this case you SHOULD NEVER access any of the result * set rows, as there aren't any! diff --git a/include/modules/ssl.h b/include/modules/ssl.h index bd418736b..bbee38867 100644 --- a/include/modules/ssl.h +++ b/include/modules/ssl.h @@ -1,6 +1,7 @@ /* * InspIRCd -- Internet Relay Chat Daemon * + * Copyright (C) 2020 Matt Schatz <genius3000@g3k.solutions> * Copyright (C) 2019 B00mX0r <b00mx0r@aureus.pw> * Copyright (C) 2018 Dylan Frank <b00mx0r@aureus.pw> * Copyright (C) 2013, 2017-2019 Sadie Powell <sadie@witchery.services> @@ -66,7 +67,7 @@ class ssl_cert : public refcountbase return issuer; } - /** Get error string if an error has occured + /** Get error string if an error has occurred * @return The error associated with this users certificate, * or an empty string if there is no error. */ @@ -303,7 +304,7 @@ class UserCertificateAPIBase : public DataProvider } }; -/** API implemented by m_sslinfo that allows modules to retrive the TLS (SSL) certificate +/** API implemented by m_sslinfo that allows modules to retrieve the TLS (SSL) certificate * information of local and remote users. It can also be used to find out whether a * user is using TLS (SSL) or not. */ diff --git a/include/numericbuilder.h b/include/numericbuilder.h index 11dec023b..3a49d1e76 100644 --- a/include/numericbuilder.h +++ b/include/numericbuilder.h @@ -1,7 +1,7 @@ /* * InspIRCd -- Internet Relay Chat Daemon * - * Copyright (C) 2018-2019 Sadie Powell <sadie@witchery.services> + * Copyright (C) 2018-2020 Sadie Powell <sadie@witchery.services> * Copyright (C) 2015-2016 Attila Molnar <attilamolnar@hush.com> * * This file is part of InspIRCd. InspIRCd is free software: you can diff --git a/include/numerics.h b/include/numerics.h index 6126c4d58..a882dd560 100644 --- a/include/numerics.h +++ b/include/numerics.h @@ -3,7 +3,7 @@ * * Copyright (C) 2017 B00mX0r <b00mx0r@aureus.pw> * Copyright (C) 2016 Attila Molnar <attilamolnar@hush.com> - * Copyright (C) 2013, 2015-2018 Sadie Powell <sadie@witchery.services> + * Copyright (C) 2013, 2015-2018, 2020 Sadie Powell <sadie@witchery.services> * Copyright (C) 2013 Adam <Adam@anope.org> * Copyright (C) 2012, 2019 Robby <robby@chatbelgie.be> * Copyright (C) 2009 Uli Schlachter <psychon@inspircd.org> diff --git a/include/protocol.h b/include/protocol.h index 64b453464..d8ff45472 100644 --- a/include/protocol.h +++ b/include/protocol.h @@ -62,7 +62,7 @@ class CoreExport ProtocolInterface * See the protocol documentation for the purpose of ENCAP. * @param targetmask The target server mask (can contain wildcards) * @param cmd The ENCAP subcommand - * @param params List of string parameters which are dependant on the subcommand + * @param params List of string parameters which are dependent on the subcommand * @param source The source of the message (prefix), must be a local user or NULL which means use local server * @return Always true if the target mask contains wildcards; otherwise true if the server name was found, * and the message was sent, false if it was not found. @@ -73,7 +73,7 @@ class CoreExport ProtocolInterface /** Send an ENCAP message to all servers. * See the protocol documentation for the purpose of ENCAP. * @param cmd The ENCAP subcommand - * @param params List of string parameters which are dependant on the subcommand + * @param params List of string parameters which are dependent on the subcommand * @param source The source of the message (prefix), must be a local user or a user behind 'omit' * or NULL which is equivalent to the local server * @param omit If non-NULL the message won't be sent in the direction of this server, useful for forwarding messages diff --git a/include/serialize.h b/include/serialize.h index b6eb16934..192fd29d3 100644 --- a/include/serialize.h +++ b/include/serialize.h @@ -1,7 +1,7 @@ /* * InspIRCd -- Internet Relay Chat Daemon * - * Copyright (C) 2019 Sadie Powell <sadie@witchery.services> + * Copyright (C) 2019-2020 Sadie Powell <sadie@witchery.services> * * This file is part of InspIRCd. InspIRCd is free software: you can * redistribute it and/or modify it under the terms of the GNU General Public diff --git a/include/server.h b/include/server.h index 6caed03b6..107ad69e9 100644 --- a/include/server.h +++ b/include/server.h @@ -1,7 +1,7 @@ /* * InspIRCd -- Internet Relay Chat Daemon * - * Copyright (C) 2019 Sadie Powell <sadie@witchery.services> + * Copyright (C) 2019-2020 Sadie Powell <sadie@witchery.services> * Copyright (C) 2018 Matt Schatz <genius3000@g3k.solutions> * Copyright (C) 2014 Attila Molnar <attilamolnar@hush.com> * diff --git a/include/socketengine.h b/include/socketengine.h index e27599818..f89a432fb 100644 --- a/include/socketengine.h +++ b/include/socketengine.h @@ -3,7 +3,7 @@ * * Copyright (C) 2013-2016 Attila Molnar <attilamolnar@hush.com> * Copyright (C) 2013-2014 Adam <Adam@anope.org> - * Copyright (C) 2012-2013, 2017-2019 Sadie Powell <sadie@witchery.services> + * Copyright (C) 2012-2013, 2017-2020 Sadie Powell <sadie@witchery.services> * Copyright (C) 2012 Robby <robby@chatbelgie.be> * Copyright (C) 2009 Uli Schlachter <psychon@inspircd.org> * Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org> @@ -187,7 +187,7 @@ class CoreExport EventHandler : public classbase inline int GetEventMask() const { return event_mask; } - /** Set a new file desciptor + /** Set a new file descriptor * @param FD The new file descriptor. Do not call this method without * first deleting the object from the SocketEngine if you have * added it to a SocketEngine instance. @@ -388,7 +388,7 @@ public: static bool HasFd(int fd); /** Returns the EventHandler attached to a specific fd. - * If the fd isnt in the socketengine, returns NULL. + * If the fd isn't in the socketengine, returns NULL. * @param fd The event handler to look for * @return A pointer to the event handler, or NULL */ @@ -399,7 +399,7 @@ public: * number of events which occurred during this call. This method will * dispatch events to their handlers by calling their * EventHandler::OnEventHandler*() methods. - * @return The number of events which have occured. + * @return The number of events which have occurred. */ static int DispatchEvents(); diff --git a/include/typedefs.h b/include/typedefs.h index 1c9ca0555..d0337bdef 100644 --- a/include/typedefs.h +++ b/include/typedefs.h @@ -134,7 +134,7 @@ typedef std::map<std::string, XLineLookup > XLineContainer; */ typedef XLineContainer::iterator ContainerIter; -/** An interator in an XLineLookup +/** An iterator in an XLineLookup */ typedef XLineLookup::iterator LookupIter; diff --git a/include/usermanager.h b/include/usermanager.h index 413494804..48990e05e 100644 --- a/include/usermanager.h +++ b/include/usermanager.h @@ -3,7 +3,7 @@ * * Copyright (C) 2015 Adam <Adam@anope.org> * Copyright (C) 2013-2016 Attila Molnar <attilamolnar@hush.com> - * Copyright (C) 2012-2013, 2017, 2019 Sadie Powell <sadie@witchery.services> + * Copyright (C) 2012-2013, 2017, 2019-2020 Sadie Powell <sadie@witchery.services> * Copyright (C) 2012 Robby <robby@chatbelgie.be> * Copyright (C) 2010 Craig Edwards <brain@inspircd.org> * Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org> @@ -149,7 +149,7 @@ class CoreExport UserManager */ const CloneCounts& GetCloneCounts(User* user) const; - /** Return a map containg IP addresses and their clone counts + /** Return a map containing IP addresses and their clone counts * @return The clone count map */ const CloneMap& GetCloneMap() const { return clonemap; } diff --git a/include/users.h b/include/users.h index 8f87dfbef..eeec0295a 100644 --- a/include/users.h +++ b/include/users.h @@ -1,11 +1,11 @@ /* * InspIRCd -- Internet Relay Chat Daemon * + * Copyright (C) 2019-2020 Matt Schatz <genius3000@g3k.solutions> * Copyright (C) 2019 linuxdaemon <linuxdaemon.irc@gmail.com> - * Copyright (C) 2019 Matt Schatz <genius3000@g3k.solutions> * Copyright (C) 2013 Daniel Vassdal <shutter@canternet.org> * Copyright (C) 2012-2016, 2018 Attila Molnar <attilamolnar@hush.com> - * Copyright (C) 2012-2013, 2016-2019 Sadie Powell <sadie@witchery.services> + * Copyright (C) 2012-2013, 2016-2020 Sadie Powell <sadie@witchery.services> * Copyright (C) 2012, 2018-2019 Robby <robby@chatbelgie.be> * Copyright (C) 2012 DjSlash <djslash@djslash.org> * Copyright (C) 2012 ChrisTX <xpipe@hotmail.de> @@ -70,7 +70,7 @@ enum UserType { USERTYPE_SERVER = 3 }; -/** Holds information relevent to <connect allow> and <connect deny> tags in the config file. +/** Holds information relevant to <connect allow> and <connect deny> tags in the config file. */ struct CoreExport ConnectClass : public refcountbase { @@ -361,13 +361,13 @@ class CoreExport User : public Extensible /** If this is set to true, then all socket operations for the user * are dropped into the bit-bucket. - * This value is set by QuitUser, and is not needed seperately from that call. + * This value is set by QuitUser, and is not needed separately from that call. * Please note that setting this value alone will NOT cause the user to quit. */ unsigned int quitting:1; /** What type of user is this? */ - const UserType usertype:2; + const unsigned int usertype:2; /** Get client IP string from sockaddr, using static internal buffer * @return The IP string diff --git a/include/xline.h b/include/xline.h index 72816e4e4..dc202a2d2 100644 --- a/include/xline.h +++ b/include/xline.h @@ -2,8 +2,8 @@ * InspIRCd -- Internet Relay Chat Daemon * * Copyright (C) 2019 Matt Schatz <genius3000@g3k.solutions> - * Copyright (C) 2013, 2016 Attila Molnar <attilamolnar@hush.com> - * Copyright (C) 2012-2013, 2017-2018 Sadie Powell <sadie@witchery.services> + * Copyright (C) 2013 Attila Molnar <attilamolnar@hush.com> + * Copyright (C) 2012-2013, 2017-2018, 2020 Sadie Powell <sadie@witchery.services> * Copyright (C) 2012, 2018-2019 Robby <robby@chatbelgie.be> * Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org> * Copyright (C) 2007-2008 Robin Burchell <robin+git@viroteck.net> @@ -29,7 +29,7 @@ /** XLine is the base class for ban lines such as G-lines and K-lines. * Modules may derive from this, and their xlines will automatically be * handled as expected by any protocol modules (e.g. m_spanningtree will - * propogate them using AddLine). The process of translating a type+pattern + * propagate them using AddLine). The process of translating a type+pattern * to a known line type is done by means of an XLineFactory object (see * below). */ @@ -127,7 +127,7 @@ class CoreExport XLine : public classbase */ time_t set_time; - /** The duration of the ban, or 0 if permenant + /** The duration of the ban, or 0 if permanent */ unsigned long duration; @@ -434,7 +434,7 @@ class CoreExport XLineManager */ ~XLineManager(); - /** Split an ident and host into two seperate strings. + /** Split an ident and host into two separate strings. * This allows for faster matching. */ IdentHostPair IdentSplit(const std::string &ident_and_host); |
