-/* +------------------------------------+
- * | Inspire Internet Relay Chat Daemon |
- * +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
*
- * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
- * E-mail:
- * <brain@chatspike.net>
- * <Craig@chatspike.net>
+ * Copyright (C) 2019 linuxdaemon <linuxdaemon.irc@gmail.com>
+ * Copyright (C) 2013, 2018-2019 Sadie Powell <sadie@witchery.services>
+ * Copyright (C) 2013 Adam <Adam@anope.org>
+ * Copyright (C) 2012-2013, 2016 Attila Molnar <attilamolnar@hush.com>
+ * Copyright (C) 2012 Robby <robby@chatbelgie.be>
+ * Copyright (C) 2009 Uli Schlachter <psychon@inspircd.org>
+ * Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
+ * Copyright (C) 2008-2009 Robin Burchell <robin+git@viroteck.net>
+ * Copyright (C) 2008 Pippijn van Steenhoven <pip88nl@gmail.com>
+ * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
+ * Copyright (C) 2005-2010 Craig Edwards <brain@inspircd.org>
*
- * Written by Craig Edwards, Craig McLure, and others.
- * This program is free but copyrighted software; see
- * the file COPYING for details.
+ * 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
+ * License as published by the Free Software Foundation, version 2.
*
- * ---------------------------------------------------
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-#ifndef _HASHCOMP_H_
-#define _HASHCOMP_H_
-#include "inspircd_config.h"
-#include "socket.h"
-#include "hash_map.h"
+#pragma once
+
+#include "inspircd.h"
+#include "convto.h"
/*******************************************************
* This file contains classes and templates that deal
* treat [ identical to {, ] identical to }, and \
* as identical to |.
*
- * Our hashing functions are designed to accept
- * std::string and compare/hash them as type irc::string
- * by converting them internally. This makes them
- * backwards compatible with other code which is not
- * aware of irc::string.
+ * There are functors that accept std::string and
+ * compare/hash them as type irc::string by using
+ * mapping arrays internally.
*******************************************************/
-
-using namespace std;
-using irc::sockets::insp_aton;
-using irc::sockets::insp_ntoa;
-using irc::sockets::insp_inaddr;
-
-#ifndef LOWERMAP
-#define LOWERMAP
+
+/** 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,
+ * e.g. for national character support.
+ */
+CoreExport extern unsigned const char *national_case_insensitive_map;
+
/** A mapping of uppercase to lowercase, including scandinavian
* 'oddities' as specified by RFC1459, e.g. { -> [, and | -> \
*/
-unsigned const char lowermap[256] = { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, /* 0-19 */
- 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, /* 20-39 */
- 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, /* 40-59 */
- 60, 61, 62, 63, 64, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, /* 60-79 */
- 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 94, 95, 96, 97, 98, 99, /* 80-99 */
- 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, /* 100-119 */
- 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, /* 120-139 */
- 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, /* 140-159 */
- 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, /* 160-179 */
- 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, /* 180-199 */
- 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, /* 200-219 */
- 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239, /* 220-239 */
- 240, 241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251, 252, 253, 254, 255 /* 240-255 */
-};
-#endif
-
-/** Because of weirdness in g++, before 3.x this was namespace std. It's now __gnu_cxx.
- * This is a #define'd alias.
- */
-namespace nspace
-{
- /** Convert a string to lower case respecting RFC1459
- * @param n A string to lowercase
- */
- void strlower(char *n);
-
- /** Hashing function to hash insp_inaddr structs
- */
- template<> struct hash<insp_inaddr>
- {
- /** Hash an insp_inaddr
- * @param a An insp_inaddr to hash
- * @return The hash value
- */
- size_t operator()(const insp_inaddr &a) const;
- };
+CoreExport extern unsigned const char rfc_case_insensitive_map[256];
- /** Hashing function to hash std::string without respect to case
- */
- template<> struct hash<std::string>
- {
- /** Hash a std::string using RFC1459 case sensitivity rules
- * @param s A string to hash
- * @return The hash value
- */
- size_t operator()(const string &s) const;
- };
-}
+/** Case insensitive map, ASCII rules.
+ * That is;
+ * [ != {, but A == a.
+ */
+CoreExport extern unsigned const char ascii_case_insensitive_map[256];
/** The irc namespace contains a number of helper classes.
*/
namespace irc
{
+ /** Check if two IRC object (e.g. nick or channel) names are equal.
+ * This function uses national_case_insensitive_map to determine equality, which, by default does comparison
+ * according to RFC 1459, treating certain otherwise non-identical characters as identical.
+ * @param s1 First string to compare
+ * @param s2 Second string to compare
+ * @return True if the two names are equal, false otherwise
+ */
+ CoreExport bool equals(const std::string& s1, const std::string& s2);
+
+ /** Check whether \p needle exists within \p haystack.
+ * @param haystack The string to search within.
+ * @param needle The string to search for.
+ * @return Either the index at which \p needle was found or std::string::npos.
+ */
+ CoreExport size_t find(const std::string& haystack, const std::string& needle);
/** This class returns true if two strings match.
* Case sensitivity is ignored, and the RFC 'character set'
{
/** The operator () does the actual comparison in hash_map
*/
- bool operator()(const std::string& s1, const std::string& s2) const;
+ bool operator()(const std::string& s1, const std::string& s2) const
+ {
+ return equals(s1, s2);
+ }
};
+ struct insensitive
+ {
+ size_t CoreExport operator()(const std::string &s) const;
+ };
- /** This class returns true if two insp_inaddr structs match.
- * Checking is done by copying both into a size_t then doing a
- * numeric comparison of the two.
- */
- struct InAddr_HashComp
+ struct insensitive_swo
{
- /** The operator () does the actual comparison in hash_map
- */
- bool operator()(const insp_inaddr &s1, const insp_inaddr &s2) const;
+ bool CoreExport operator()(const std::string& a, const std::string& b) const;
};
- /** irc::stringjoiner joins string lists into a string, using
- * the given seperator string.
- * This class can join a vector of std::string, a deque of
- * std::string, or a const char** array, using overloaded
- * constructors.
+ /** 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.
*/
- class stringjoiner
+ class CoreExport sepstream
{
- private:
- /** Output string
+ protected:
+ /** Original string.
*/
- std::string joined;
+ std::string tokens;
+ /** Separator value
+ */
+ char sep;
+ /** Current string position
+ */
+ size_t pos;
+ /** If set then GetToken() can return an empty string
+ */
+ bool allow_empty;
public:
- /** Join elements of a vector, between (and including) begin and end
- * @param seperator The string to seperate values with
- * @param sequence One or more items to seperate
- * @param begin The starting element in the sequence to be joined
- * @param end The ending element in the sequence to be joined
+ /** Create a sepstream and fill it with the provided data
+ */
+ sepstream(const std::string &source, char separator, bool allowempty = false);
+
+ /** Fetch the next token from the stream
+ * @param token The next token from the stream is placed here
+ * @return True if tokens still remain, false if there are none left
*/
- stringjoiner(const std::string &seperator, const std::vector<std::string> &sequence, int begin, int end);
- /** Join elements of a deque, between (and including) begin and end
- * @param seperator The string to seperate values with
- * @param sequence One or more items to seperate
- * @param begin The starting element in the sequence to be joined
- * @param end The ending element in the sequence to be joined
+ bool GetToken(std::string& token);
+
+ /** Fetch the next numeric token from the stream
+ * @param token The next token from the stream is placed here
+ * @return True if tokens still remain, false if there are none left
+ */
+ template<typename Numeric>
+ bool GetNumericToken(Numeric& token)
+ {
+ std::string str;
+ if (!GetToken(str))
+ return false;
+
+ token = ConvToNum<Numeric>(str);
+ return true;
+ }
+
+ /** Fetch the entire remaining stream, without tokenizing
+ * @return The remaining part of the stream
*/
- stringjoiner(const std::string &seperator, const std::deque<std::string> &sequence, int begin, int end);
- /** Join elements of an array of char arrays, between (and including) begin and end
- * @param seperator The string to seperate values with
- * @param sequence One or more items to seperate
- * @param begin The starting element in the sequence to be joined
- * @param end The ending element in the sequence to be joined
+ const std::string GetRemaining();
+
+ /** Returns true if the end of the stream has been reached
+ * @return True if the end of the stream has been reached, otherwise false
*/
- stringjoiner(const std::string &seperator, const char** sequence, int begin, int end);
+ bool StreamEnd();
- /** Get the joined sequence
- * @return A reference to the joined string
+ /** Returns true if the specified value exists in the stream
+ * @param value The value to search for
+ * @return True if the value was found, False otherwise
*/
- std::string& GetJoined();
+ bool Contains(const std::string& value);
};
- /** irc::modestacker stacks mode sequences into a list.
- * It can then reproduce this list, clamped to a maximum of MAXMODES
- * values per line.
+ /** A derived form of sepstream, which separates on commas
*/
- class modestacker
+ class CoreExport commasepstream : public sepstream
{
- private:
- /** The mode sequence and its parameters
- */
- std::deque<std::string> sequence;
- /** True if the mode sequence is initially adding
- * characters, false if it is initially removing
- * them
- */
- bool adding;
public:
- /** Construct a new modestacker.
- * @param add True if the stack is adding modes,
- * false if it is removing them
+ /** Initialize with comma separator
*/
- modestacker(bool add);
- /** Push a modeletter and its parameter onto the stack.
- * No checking is performed as to if this mode actually
- * requires a parameter. If you stack invalid mode
- * sequences, they will be tidied if and when they are
- * passed to a mode parser.
- * @param modeletter The mode letter to insert
- * @param parameter The parameter for the mode
- */
- void Push(char modeletter, const std::string ¶meter);
- /** Push a modeletter without parameter onto the stack.
- * No checking is performed as to if this mode actually
- * requires a parameter. If you stack invalid mode
- * sequences, they will be tidied if and when they are
- * passed to a mode parser.
- * @param modeletter The mode letter to insert
- */
- void Push(char modeletter);
- /** Push a '+' symbol onto the stack.
- */
- void PushPlus();
- /** Push a '-' symbol onto the stack.
- */
- void PushMinus();
- /** Return zero or more elements which form the
- * mode line. This will be clamped to a max of
- * MAXMODES+1 items (MAXMODES mode parameters and
- * one mode sequence string).
- * @param result The deque to populate. This will
- * be cleared before it is used.
- * @return The number of elements in the deque
+ commasepstream(const std::string &source, bool allowempty = false) : sepstream(source, ',', allowempty)
+ {
+ }
+ };
+
+ /** A derived form of sepstream, which separates on spaces
+ */
+ class CoreExport spacesepstream : public sepstream
+ {
+ public:
+ /** Initialize with space separator
*/
- int GetStackedLine(std::deque<std::string> &result);
+ spacesepstream(const std::string &source, bool allowempty = false) : sepstream(source, ' ', allowempty)
+ {
+ }
};
/** irc::tokenstream reads a string formatted as per RFC1459 and RFC2812.
* list will be ":item". This is to allow for parsing 'source' fields
* from data.
*/
- class tokenstream
+ class CoreExport tokenstream
{
- private:
- /** Original string
- */
- std::string tokens;
- /** Last position of a seperator token
- */
- std::string::iterator last_starting_position;
- /** Current string position
- */
- std::string::iterator n;
- /** True if the last value was an ending value
- */
- bool last_pushed;
- public:
- /** Create a tokenstream and fill it with the provided data
- */
- tokenstream(const std::string &source);
- ~tokenstream();
+ private:
+ /** The message we are parsing tokens from. */
+ std::string message;
- /** Fetch the next token from the stream
- * @return The next token is returned, or an empty string if none remain
- */
- const std::string GetToken();
- };
+ /** The current position within the message. */
+ size_t position;
- /** irc::sepstream allows for splitting token seperated lists.
- * Each successive call to sepstream::GetToken() returns
- * the next token, until none remain, at which point the method returns
- * an empty string.
- */
- class sepstream : public classbase
- {
- private:
- /** Original string
- */
- std::string tokens;
- /** Last position of a seperator token
- */
- std::string::iterator last_starting_position;
- /** Current string position
- */
- std::string::iterator n;
- /** Seperator value
- */
- char sep;
public:
- /** Create a sepstream and fill it with the provided data
- */
- sepstream(const std::string &source, char seperator);
- virtual ~sepstream();
+ /** Create a tokenstream and fill it with the provided data. */
+ tokenstream(const std::string& msg, size_t start = 0, size_t end = std::string::npos);
- /** Fetch the next token from the stream
- * @return The next token is returned, or an empty string if none remain
- */
- virtual const std::string GetToken();
- };
+ /** Retrieves the underlying message. */
+ std::string& GetMessage() { return message; }
- /** A derived form of sepstream, which seperates on commas
- */
- class commasepstream : public sepstream
- {
- public:
- commasepstream(const std::string &source) : sepstream(source, ',')
- {
- }
- };
+ /** Retrieve the next \<middle> token in the token stream.
+ * @param token The next token available, or an empty string if none remain.
+ * @return True if tokens are left to be read, false if the last token was just retrieved.
+ */
+ bool GetMiddle(std::string& token);
- /** A derived form of sepstream, which seperates on spaces
- */
- class spacesepstream : public sepstream
- {
- public:
- spacesepstream(const std::string &source) : sepstream(source, ' ')
- {
- }
+ /** Retrieve the next \<trailing> token in the token stream.
+ * @param token The next token available, or an empty string if none remain.
+ * @return True if tokens are left to be read, false if the last token was just retrieved.
+ */
+ 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
* start or end < 0) then GetToken() will return the first element
* of the pair of numbers.
*/
- class portparser : public classbase
+ class CoreExport portparser
{
private:
+
/** Used to split on commas
*/
- commasepstream* sep;
+ commasepstream sep;
+
/** Current position in a range of ports
*/
long in_range;
+
/** Starting port in a range of ports
*/
long range_begin;
+
/** Ending port in a range of ports
*/
long range_end;
+
/** Allow overlapped port ranges
*/
bool overlapped;
+
/** Used to determine overlapping of ports
* without O(n) algorithm being used
*/
- std::map<long, bool> overlap_set;
+ std::set<long> overlap_set;
+
/** Returns true if val overlaps an existing range
*/
bool Overlaps(long val);
public:
+
/** Create a portparser and fill it with the provided data
* @param source The source text to parse from
* @param allow_overlapped Allow overlapped ranges
*/
portparser(const std::string &source, bool allow_overlapped = true);
- /** Frees the internal commasepstream object
- */
- ~portparser();
+
/** Fetch the next token from the stream
* @return The next port number is returned, or 0 if none remain
*/
long GetToken();
};
-
- /** Used to hold a bitfield definition in dynamicbitmask.
- * You must be allocated one of these by dynamicbitmask::Allocate(),
- * you should not fill the values yourself!
- */
- typedef std::pair<size_t, unsigned char> bitfield;
-
- /** The irc::dynamicbitmask class is used to maintain a bitmap of
- * boolean values, which can grow to any reasonable size no matter
- * how many bitfields are in it.
- *
- * It starts off at 32 bits in size, large enough to hold 32 boolean
- * values, with a memory allocation of 8 bytes. If you allocate more
- * than 32 bits, the class will grow the bitmap by 8 bytes at a time
- * for each set of 8 bitfields you allocate with the Allocate()
- * method.
- *
- * This method is designed so that multiple modules can be allocated
- * bit values in a bitmap dynamically, rather than having to define
- * costs in a fixed size unsigned integer and having the possibility
- * of collisions of values in different third party modules.
- */
- class dynamicbitmask : public classbase
- {
- private:
- /** Data bits. We start with four of these,
- * and we grow the bitfield as we allocate
- * more than 32 entries with Allocate().
- */
- unsigned char* bits;
- /** A bitmask containing 1's for allocated
- * bits and 0's for free bits. When we
- * allocate a bit using Allocate(), we OR
- * its position in here to 1.
- */
- unsigned char* freebits;
- /** Current set size (size of freebits and bits).
- * Both freebits and bits will ALWAYS be the
- * same length.
- */
- size_t bits_size;
- public:
- /** Allocate the initial memory for bits and
- * freebits and zero the memory.
- */
- dynamicbitmask();
-
- /** Free the memory used by bits and freebits
- */
- ~dynamicbitmask();
-
- /** Allocate an irc::bitfield.
- * @return An irc::bitfield which can be used
- * with Get, Deallocate and Toggle methods.
- * @throw Can throw std::bad_alloc if there is
- * no ram left to grow the bitmask.
- */
- bitfield Allocate();
-
- /** Deallocate an irc::bitfield.
- * @param An irc::bitfield to deallocate.
- * @return True if the bitfield could be
- * deallocated, false if it could not.
- */
- bool Deallocate(bitfield &pos);
-
- /** Toggle the value of a bitfield.
- * @param pos A bitfield to allocate, previously
- * allocated by dyamicbitmask::Allocate().
- * @param state The state to set the field to.
- */
- void Toggle(bitfield &pos, bool state);
-
- /** Get the value of a bitfield.
- * @param pos A bitfield to retrieve, previously
- * allocated by dyamicbitmask::Allocate().
- * @return The value of the bitfield.
- * @throw Will throw ModuleException if the bitfield
- * you provide is outside of the range
- * 0 >= bitfield.first < size_bits.
- */
- bool Get(bitfield &pos);
-
- /** Return the size in bytes allocated to the bits
- * array.
- * Note that the actual allocation is twice this,
- * as there are an equal number of bytes allocated
- * for the freebits array.
- */
- size_t GetSize();
- };
-
- /** The irc_char_traits class is used for RFC-style comparison of strings.
- * This class is used to implement irc::string, a case-insensitive, RFC-
- * comparing string class.
- */
- struct irc_char_traits : std::char_traits<char> {
-
- /** Check if two chars match
- */
- static bool eq(char c1st, char c2nd);
-
- /** Check if two chars do NOT match
- */
- static bool ne(char c1st, char c2nd);
-
- /** Check if one char is less than another
- */
- static bool lt(char c1st, char c2nd);
-
- /** Compare two strings of size n
- */
- static int compare(const char* str1, const char* str2, size_t n);
-
- /** Find a char within a string up to position n
- */
- static const char* find(const char* s1, int n, char c);
- };
-
- std::string hex(const unsigned char *raw, size_t rawsz);
-
- /** This typedef declares irc::string based upon irc_char_traits
- */
- typedef basic_string<char, irc_char_traits, allocator<char> > string;
-
- const char* Spacify(char* n);
}
-
-/* Define operators for using >> and << with irc::string to an ostream on an istream. */
-/* This was endless fun. No. Really. */
-/* It was also the first core change Ommeh made, if anyone cares */
-std::ostream& operator<<(std::ostream &os, const irc::string &str);
-std::istream& operator>>(std::istream &is, irc::string &str);
-
-/* Define operators for + and == with irc::string to std::string for easy assignment
- * and comparison - Brain
- */
-std::string operator+ (std::string& leftval, irc::string& rightval);
-irc::string operator+ (irc::string& leftval, std::string& rightval);
-bool operator== (std::string& leftval, irc::string& rightval);
-bool operator== (irc::string& leftval, std::string& rightval);
-
-#endif
projects / user / henk / code / inspircd.git / blobdiff