1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
7 * <brain@chatspike.net>
8 * <Craig@chatspike.net>
10 * Written by Craig Edwards, Craig McLure, and others.
11 * This program is free but copyrighted software; see
12 * the file COPYING for details.
14 * ---------------------------------------------------
21 #include <ext/hash_map>
22 #define nspace __gnu_cxx
24 /******************************************************
26 * The hash functions of InspIRCd are the centrepoint
27 * of the entire system. If these functions are
28 * inefficient or wasteful, the whole program suffers
29 * as a result. A lot of C programmers in the ircd
30 * scene spend a lot of time debating (arguing) about
31 * the best way to write hash functions to hash irc
32 * nicknames, channels etc.
33 * We are lucky as C++ developers as hash_map does
34 * a lot of this for us. It does intellegent memory
35 * requests, bucketing, search functions, insertion
36 * and deletion etc. All we have to do is write some
37 * overloaded comparison and hash value operators which
38 * cause it to act in an irc-like way. The features we
39 * add to the standard hash_map are:
41 * Case insensitivity: The hash_map will be case
44 * Scandanavian Comparisons: The characters [, ], \ will
45 * be considered the lowercase of {, } and |.
47 * This file also contains hashing methods for hashing
48 * insp_inaddr structs, we use this if we want to cache IP
51 ******************************************************/
54 using namespace irc::sockets;
56 /* convert a string to lowercase. Note following special circumstances
57 * taken from RFC 1459. Many "official" server branches still hold to this
60 * Because of IRC's scandanavian origin, the characters {}| are
61 * considered to be the lower case equivalents of the characters []\,
62 * respectively. This is a critical issue when determining the
63 * equivalence of two nicknames.
65 void nspace::strlower(char *n)
69 for (char* t = n; *t; t++)
70 *t = lowermap[(unsigned char)*t];
74 size_t nspace::hash<insp_inaddr>::operator()(const insp_inaddr &a) const
77 memcpy(&q,&a,sizeof(size_t));
81 size_t nspace::hash<string>::operator()(const string &s) const
83 /* XXX: NO DATA COPIES! :)
84 * The hash function here is practically
85 * a copy of the one in STL's hash_fun.h,
86 * only with *x replaced with lowermap[*x].
87 * This avoids a copy to use hash<const char*>
89 register size_t t = 0;
90 for (std::string::const_iterator x = s.begin(); x != s.end(); ++x) /* ++x not x++, as its faster */
91 t = 5 * t + lowermap[(unsigned char)*x];
95 size_t nspace::hash<irc::string>::operator()(const irc::string &s) const
97 register size_t t = 0;
98 for (irc::string::const_iterator x = s.begin(); x != s.end(); ++x) /* ++x not x++, as its faster */
99 t = 5 * t + lowermap[(unsigned char)*x];
103 bool irc::StrHashComp::operator()(const std::string& s1, const std::string& s2) const
105 unsigned char* n1 = (unsigned char*)s1.c_str();
106 unsigned char* n2 = (unsigned char*)s2.c_str();
107 for (; *n1 && *n2; n1++, n2++)
108 if (lowermap[*n1] != lowermap[*n2])
110 return (lowermap[*n1] == lowermap[*n2]);
113 bool irc::InAddr_HashComp::operator()(const insp_inaddr &s1, const insp_inaddr &s2) const
116 for (int n = 0; n < 16; n++)
117 if (s2.s6_addr[n] != s1.s6_addr[n])
121 return (s1.s_addr == s1.s_addr);
125 /******************************************************
127 * This is the implementation of our special irc::string
128 * class which is a case-insensitive equivalent to
129 * std::string which is not only case-insensitive but
130 * can also do scandanavian comparisons, e.g. { = [, etc.
132 * This class depends on the const array 'lowermap'.
134 ******************************************************/
136 bool irc::irc_char_traits::eq(char c1st, char c2nd)
138 return lowermap[(unsigned char)c1st] == lowermap[(unsigned char)c2nd];
141 bool irc::irc_char_traits::ne(char c1st, char c2nd)
143 return lowermap[(unsigned char)c1st] != lowermap[(unsigned char)c2nd];
146 bool irc::irc_char_traits::lt(char c1st, char c2nd)
148 return lowermap[(unsigned char)c1st] < lowermap[(unsigned char)c2nd];
151 int irc::irc_char_traits::compare(const char* str1, const char* str2, size_t n)
153 for(unsigned int i = 0; i < n; i++)
155 if(lowermap[(unsigned char)*str1] > lowermap[(unsigned char)*str2])
158 if(lowermap[(unsigned char)*str1] < lowermap[(unsigned char)*str2])
161 if(*str1 == 0 || *str2 == 0)
170 std::string operator+ (std::string& leftval, irc::string& rightval)
172 return leftval + std::string(rightval.c_str());
175 irc::string operator+ (irc::string& leftval, std::string& rightval)
177 return leftval + irc::string(rightval.c_str());
180 bool operator== (std::string& leftval, irc::string& rightval)
182 return (leftval.c_str() == rightval);
185 bool operator== (irc::string& leftval, std::string& rightval)
187 return (leftval == rightval.c_str());
190 const char* irc::irc_char_traits::find(const char* s1, int n, char c)
192 while(n-- > 0 && lowermap[(unsigned char)*s1] != lowermap[(unsigned char)c])
197 /* See hashcomp.h if you care about these... */
198 std::ostream& operator<<(std::ostream &os, const irc::string &str)
200 return os << str.c_str();
203 std::istream& operator>>(std::istream &is, irc::string &str)
211 irc::tokenstream::tokenstream(const std::string &source) : tokens(source), last_pushed(false)
213 /* Record starting position and current position */
214 last_starting_position = tokens.begin();
218 irc::tokenstream::~tokenstream()
222 const std::string irc::tokenstream::GetToken()
224 std::string::iterator lsp = last_starting_position;
226 while (n != tokens.end())
228 /** Skip multi space, converting " " into " "
230 while ((n+1 != tokens.end()) && (*n == ' ') && (*(n+1) == ' '))
233 if ((last_pushed) && (*n == ':'))
235 /* If we find a token thats not the first and starts with :,
236 * this is the last token on the line
238 std::string::iterator curr = ++n;
240 return std::string(curr, tokens.end());
245 if ((*n == ' ') || (n+1 == tokens.end()))
247 /* If we find a space, or end of string, this is the end of a token.
249 last_starting_position = n+1;
252 std::string strip(lsp, n+1 == tokens.end() ? n+1 : n++);
253 while ((strip.length()) && (strip.find_last_of(' ') == strip.length() - 1))
254 strip.erase(strip.end() - 1);
264 irc::sepstream::sepstream(const std::string &source, char seperator) : tokens(source), sep(seperator)
266 last_starting_position = tokens.begin();
270 const std::string irc::sepstream::GetToken()
272 std::string::iterator lsp = last_starting_position;
274 while (n != tokens.end())
276 if ((*n == sep) || (n+1 == tokens.end()))
278 last_starting_position = n+1;
279 std::string strip = std::string(lsp, n+1 == tokens.end() ? n+1 : n++);
281 while ((strip.length()) && (strip.find_last_of(sep) == strip.length() - 1))
282 strip.erase(strip.end() - 1);
293 irc::sepstream::~sepstream()
297 std::string irc::hex(const unsigned char *raw, size_t rawsz)
302 /* EWW! This used to be using sprintf, which is WAY inefficient. -Special */
304 const char *hex = "0123456789abcdef";
309 for (i = 0, j = 0; j < rawsz; ++j)
311 buf[i++] = hex[raw[j] / 16];
312 buf[i++] = hex[raw[j] % 16];
319 const char* irc::Spacify(char* n)
321 static char x[MAXBUF];
323 for (char* y = x; *y; y++)
330 irc::modestacker::modestacker(bool add) : adding(add)
333 sequence.push_back("");
336 void irc::modestacker::Push(char modeletter, const std::string ¶meter)
338 *(sequence.begin()) += modeletter;
339 sequence.push_back(parameter);
342 void irc::modestacker::Push(char modeletter)
344 this->Push(modeletter,"");
347 void irc::modestacker::PushPlus()
352 void irc::modestacker::PushMinus()
357 int irc::modestacker::GetStackedLine(std::deque<std::string> &result)
361 result.push_back(adding ? "+" : "-");
363 while (!sequence[0].empty() && (sequence.size() > 1) && (result.size() < MAXMODES+1))
365 result[0] += *(sequence[0].begin());
366 if (!sequence[1].empty())
367 result.push_back(sequence[1]);
368 sequence[0].erase(sequence[0].begin());
369 sequence.erase(sequence.begin() + 1);
376 irc::stringjoiner::stringjoiner(const std::string &seperator, const std::vector<std::string> &sequence, int begin, int end)
378 for (int v = begin; v < end; v++)
379 joined.append(sequence[v]).append(seperator);
380 joined.append(sequence[end]);
383 irc::stringjoiner::stringjoiner(const std::string &seperator, const std::deque<std::string> &sequence, int begin, int end)
385 for (int v = begin; v < end; v++)
386 joined.append(sequence[v]).append(seperator);
387 joined.append(sequence[end]);
390 irc::stringjoiner::stringjoiner(const std::string &seperator, const char** sequence, int begin, int end)
392 for (int v = begin; v < end; v++)
393 joined.append(sequence[v]).append(seperator);
394 joined.append(sequence[end]);
397 std::string& irc::stringjoiner::GetJoined()
402 irc::portparser::portparser(const std::string &source, bool allow_overlapped) : in_range(0), range_begin(0), range_end(0), overlapped(allow_overlapped)
404 sep = new irc::commasepstream(source);
408 irc::portparser::~portparser()
413 bool irc::portparser::Overlaps(long val)
418 if (overlap_set.find(val) == overlap_set.end())
420 overlap_set[val] = true;
427 long irc::portparser::GetToken()
432 if (in_range <= range_end)
434 if (!Overlaps(in_range))
440 while (((Overlaps(in_range)) && (in_range <= range_end)))
443 if (in_range <= range_end)
451 std::string x = sep->GetToken();
456 while (Overlaps(atoi(x.c_str())))
464 std::string::size_type dash = x.rfind('-');
465 if (dash != std::string::npos)
467 std::string sbegin = x.substr(0, dash);
468 std::string send = x.substr(dash+1, x.length());
469 range_begin = atoi(sbegin.c_str());
470 range_end = atoi(send.c_str());
472 if ((range_begin > 0) && (range_end > 0) && (range_begin < 65536) && (range_end < 65536) && (range_begin < range_end))
474 in_range = range_begin;
479 /* Assume its just the one port */
480 return atoi(sbegin.c_str());
485 return atoi(x.c_str());
489 irc::dynamicbitmask::dynamicbitmask() : bits_size(4)
491 /* We start with 4 bytes allocated which is room
492 * for 4 items. Something makes me doubt its worth
493 * allocating less than 4 bytes.
495 bits = new unsigned char[bits_size];
496 memset(bits, 0, bits_size);
499 irc::dynamicbitmask::~dynamicbitmask()
501 /* Tidy up the entire used memory on delete */
505 irc::bitfield irc::dynamicbitmask::Allocate()
507 /* Yeah, this isnt too efficient, however a module or the core
508 * should only be allocating bitfields on load, the Toggle and
509 * Get methods are O(1) as these are called much more often.
511 unsigned char* freebits = this->GetFreeBits();
512 for (unsigned char i = 0; i < bits_size; i++)
514 /* Yes, this is right. You'll notice we terminate the loop when !current_pos,
515 * this is because we logic shift our bit off the end of unsigned char, and its
516 * lost, making the loop counter 0 when we're done.
518 for (unsigned char current_pos = 1; current_pos; current_pos = current_pos << 1)
520 if (!(freebits[i] & current_pos))
522 freebits[i] |= current_pos;
523 return std::make_pair(i, current_pos);
527 /* We dont have any free space left, increase by one */
529 if (bits_size == 255)
530 /* Oh dear, cant grow it any further */
531 throw std::bad_alloc();
533 unsigned char old_bits_size = bits_size;
535 /* Allocate new bitfield space */
536 unsigned char* temp_bits = new unsigned char[bits_size];
537 unsigned char* temp_freebits = new unsigned char[bits_size];
538 /* Copy the old data in */
539 memcpy(temp_bits, bits, old_bits_size);
540 memcpy(temp_freebits, freebits, old_bits_size);
541 /* Delete the old data pointers */
544 /* Swap the pointers over so now the new
545 * pointers point to our member values
548 freebits = temp_freebits;
549 this->SetFreeBits(freebits);
550 /* Initialize the new byte on the end of
551 * the bitfields, pre-allocate the one bit
552 * for this allocation
554 bits[old_bits_size] = 0;
555 freebits[old_bits_size] = 1;
556 /* We already know where we just allocated
557 * the bitfield, so no loop needed
559 return std::make_pair(old_bits_size, 1);
562 bool irc::dynamicbitmask::Deallocate(irc::bitfield &pos)
564 /* We dont bother to shrink the bitfield
565 * on deallocation, the most we could do
566 * is save one byte (!) and this would cost
567 * us a loop (ugly O(n) stuff) so we just
568 * clear the bit and leave the memory
569 * claimed -- nobody will care about one
572 if (pos.first < bits_size)
574 this->GetFreeBits()[pos.first] &= ~pos.second;
577 /* They gave a bitfield outside of the
578 * length of our array. BAD programmer.
583 void irc::dynamicbitmask::Toggle(irc::bitfield &pos, bool state)
585 /* Range check the value */
586 if (pos.first < bits_size)
589 /* Set state, OR the state in */
590 bits[pos.first] |= pos.second;
592 /* Clear state, AND the !state out */
593 bits[pos.first] &= ~pos.second;
597 bool irc::dynamicbitmask::Get(irc::bitfield &pos)
599 /* Range check the value */
600 if (pos.first < bits_size)
601 return (bits[pos.first] & pos.second);
603 /* We can't return false, otherwise we can't
604 * distinguish between failure and a cleared bit!
605 * Our only sensible choice is to throw (ew).
607 throw ModuleException("irc::dynamicbitmask::Get(): Invalid bitfield, out of range");
610 unsigned char irc::dynamicbitmask::GetSize()
615 std::string assign(const irc::string &other)
617 return other.c_str();
620 irc::string assign(const std::string &other)
622 return other.c_str();