]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/helperfuncs.cpp
Change the syntax of FOREACH macros to be less dumb.
[user/henk/code/inspircd.git] / src / helperfuncs.cpp
index d2c4c7c3ecd32760b847bba117f06047f0452676..2626da6bbd6132518866946809e73fd181503909 100644 (file)
@@ -1,28 +1,42 @@
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2006-2008 Robin Burchell <robin+git@viroteck.net>
+ *   Copyright (C) 2005-2008 Craig Edwards <craigedwards@brainbox.cc>
+ *   Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
+ *   Copyright (C) 2006-2007 Oliver Lupton <oliverlupton@gmail.com>
+ *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
  *
- * 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/>.
  */
 
-/* $Core: libIRCDhelper */
+
+#ifdef _WIN32
+#define _CRT_RAND_S
+#include <stdlib.h>
+#endif
 
 #include "inspircd.h"
-#include "wildcard.h"
 #include "xline.h"
 #include "exitcodes.h"
+#include <iostream>
 
-std::string InspIRCd::GetServerDescription(const char* servername)
+std::string InspIRCd::GetServerDescription(const std::string& servername)
 {
        std::string description;
 
-       FOREACH_MOD_I(this,I_OnGetServerDescription,OnGetServerDescription(servername,description));
+       FOREACH_MOD(OnGetServerDescription, (servername,description));
 
        if (!description.empty())
        {
@@ -50,19 +64,6 @@ User* InspIRCd::FindNick(const std::string &nick)
        return iter->second;
 }
 
-User* InspIRCd::FindNick(const char* nick)
-{
-       if (isdigit(*nick))
-               return FindUUID(nick);
-
-       user_hash::iterator iter = this->Users->clientlist->find(nick);
-       
-       if (iter == this->Users->clientlist->end())
-               return NULL;
-
-       return iter->second;
-}
-
 User* InspIRCd::FindNickOnly(const std::string &nick)
 {
        user_hash::iterator iter = this->Users->clientlist->find(nick);
@@ -73,22 +74,7 @@ User* InspIRCd::FindNickOnly(const std::string &nick)
        return iter->second;
 }
 
-User* InspIRCd::FindNickOnly(const char* nick)
-{
-       user_hash::iterator iter = this->Users->clientlist->find(nick);
-
-       if (iter == this->Users->clientlist->end())
-               return NULL;
-
-       return iter->second;
-}
-
 User *InspIRCd::FindUUID(const std::string &uid)
-{
-       return FindUUID(uid.c_str());
-}
-
-User *InspIRCd::FindUUID(const char *uid)
 {
        user_hash::iterator finduuid = this->Users->uuidlist->find(uid);
 
@@ -97,18 +83,7 @@ User *InspIRCd::FindUUID(const char *uid)
 
        return finduuid->second;
 }
-
 /* find a channel record by channel name and return a pointer to it */
-Channel* InspIRCd::FindChan(const char* chan)
-{
-       chan_hash::iterator iter = chanlist->find(chan);
-
-       if (iter == chanlist->end())
-               /* Couldn't find it */
-               return NULL;
-
-       return iter->second;
-}
 
 Channel* InspIRCd::FindChan(const std::string &chan)
 {
@@ -124,38 +99,28 @@ Channel* InspIRCd::FindChan(const std::string &chan)
 /* Send an error notice to all users, registered or not */
 void InspIRCd::SendError(const std::string &s)
 {
-       for (std::vector<User*>::const_iterator i = this->Users->local_users.begin(); i != this->Users->local_users.end(); i++)
+       for (LocalUserList::const_iterator i = this->Users->local_users.begin(); i != this->Users->local_users.end(); i++)
        {
-               if ((*i)->registered == REG_ALL)
+               User* u = *i;
+               if (u->registered == REG_ALL)
                {
-                       (*i)->WriteServ("NOTICE %s :%s",(*i)->nick.c_str(),s.c_str());
-               }
+                       u->WriteNotice(s);
+               }
                else
                {
                        /* Unregistered connections receive ERROR, not a NOTICE */
-                       (*i)->Write("ERROR :" + s);
+                       u->Write("ERROR :" + s);
                }
-               /* This might generate a whole load of EAGAIN, but we dont really
-                * care about this, as if we call SendError something catastrophic
-                * has occured anyway, and we wont receive the events for these.
-                */
-               (*i)->FlushWriteBuf();
        }
 }
 
-/* return channel count */
-long InspIRCd::ChannelCount()
-{
-       return chanlist->size();
-}
-
 bool InspIRCd::IsValidMask(const std::string &mask)
 {
-       char* dest = (char*)mask.c_str();
+       const char* dest = mask.c_str();
        int exclamation = 0;
        int atsign = 0;
 
-       for (char* i = dest; *i; i++)
+       for (const char* i = dest; *i; i++)
        {
                /* out of range character, bad mask */
                if (*i < 32 || *i > 126)
@@ -178,51 +143,126 @@ bool InspIRCd::IsValidMask(const std::string &mask)
        if (exclamation != 1 || atsign != 1)
                return false;
 
+       if (mask.length() > 250)
+               return false;
+
        return true;
 }
 
-/* true for valid channel name, false else */
-bool IsChannelHandler::Call(const char *chname, size_t max)
+void InspIRCd::StripColor(std::string &sentence)
 {
-       const char *c = chname + 1;
+       /* refactor this completely due to SQUIT bug since the old code would strip last char and replace with \0 --peavey */
+       int seq = 0;
 
-       /* check for no name - don't check for !*chname, as if it is empty, it won't be '#'! */
-       if (!chname || *chname != '#')
+       for (std::string::iterator i = sentence.begin(); i != sentence.end();)
        {
-               return false;
+               if (*i == 3)
+                       seq = 1;
+               else if (seq && (( ((*i >= '0') && (*i <= '9')) || (*i == ',') ) ))
+               {
+                       seq++;
+                       if ( (seq <= 4) && (*i == ',') )
+                               seq = 1;
+                       else if (seq > 3)
+                               seq = 0;
+               }
+               else
+                       seq = 0;
+
+               if (seq || ((*i == 2) || (*i == 15) || (*i == 22) || (*i == 21) || (*i == 31)))
+                       i = sentence.erase(i);
+               else
+                       ++i;
        }
+}
 
-       while (*c)
+void InspIRCd::ProcessColors(file_cache& input)
+{
+       /*
+        * Replace all color codes from the special[] array to actual
+        * color code chars using C++ style escape sequences. You
+        * can append other chars to replace if you like -- Justasic
+        */
+       static struct special_chars
+       {
+               std::string character;
+               std::string replace;
+               special_chars(const std::string &c, const std::string &r) : character(c), replace(r) { }
+       }
+
+       special[] = {
+               special_chars("\\002", "\002"),  // Bold
+               special_chars("\\037", "\037"),  // underline
+               special_chars("\\003", "\003"),  // Color
+               special_chars("\\017", "\017"), // Stop colors
+               special_chars("\\u", "\037"),    // Alias for underline
+               special_chars("\\b", "\002"),    // Alias for Bold
+               special_chars("\\x", "\017"),    // Alias for stop
+               special_chars("\\c", "\003"),    // Alias for color
+               special_chars("", "")
+       };
+
+       for(file_cache::iterator it = input.begin(), it_end = input.end(); it != it_end; it++)
        {
-               switch (*c)
+               std::string ret = *it;
+               for(int i = 0; special[i].character.empty() == false; ++i)
                {
-                       case ' ':
-                       case ',':
-                       case 7:
-                               return false;
+                       std::string::size_type pos = ret.find(special[i].character);
+                       if(pos == std::string::npos) // Couldn't find the character, skip this line
+                               continue;
+
+                       if((pos > 0) && (ret[pos-1] == '\\') && (ret[pos] == '\\'))
+                               continue; // Skip double slashes.
+
+                       // Replace all our characters in the array
+                       while(pos != std::string::npos)
+                       {
+                               ret = ret.substr(0, pos) + special[i].replace + ret.substr(pos + special[i].character.size());
+                               pos = ret.find(special[i].character, pos + special[i].replace.size());
+                       }
                }
 
-               c++;
+               // Replace double slashes with a single slash before we return
+               std::string::size_type pos = ret.find("\\\\");
+               while(pos != std::string::npos)
+               {
+                       ret = ret.substr(0, pos) + "\\" + ret.substr(pos + 2);
+                       pos = ret.find("\\\\", pos + 1);
+               }
+               *it = ret;
        }
+}
 
-       size_t len = c - chname;        
-       /* too long a name - note funky pointer arithmetic here. */
-       if (len > max)
+/* true for valid channel name, false else */
+bool IsChannelHandler::Call(const std::string& chname)
+{
+       if (chname.empty() || chname.length() > ServerInstance->Config->Limits.ChanMax)
+               return false;
+
+       if (chname[0] != '#')
+               return false;
+
+       for (std::string::const_iterator i = chname.begin()+1; i != chname.end(); ++i)
        {
-                       return false;
+               switch (*i)
+               {
+                       case ' ':
+                       case ',':
+                       case 7:
+                               return false;
+               }
        }
 
        return true;
 }
 
 /* true for valid nickname, false else */
-bool IsNickHandler::Call(const char* n, size_t max)
+bool IsNickHandler::Call(const std::string& n)
 {
-       if (!n || !*n)
+       if (n.empty() || n.length() > ServerInstance->Config->Limits.NickMax)
                return false;
-       unsigned int p = 0;
-       for (const char* i = n; *i; i++, p++)
+
+       for (std::string::const_iterator i = n.begin(); i != n.end(); ++i)
        {
                if ((*i >= 'A') && (*i <= '}'))
                {
@@ -230,7 +270,7 @@ bool IsNickHandler::Call(const char* n, size_t max)
                        continue;
                }
 
-               if ((((*i >= '0') && (*i <= '9')) || (*i == '-')) && (i > n))
+               if ((((*i >= '0') && (*i <= '9')) || (*i == '-')) && (i != n.begin()))
                {
                        /* "0"-"9", "-" can occur anywhere BUT the first char of a nickname */
                        continue;
@@ -240,17 +280,16 @@ bool IsNickHandler::Call(const char* n, size_t max)
                return false;
        }
 
-       /* too long? or not -- pointer arithmetic rocks */
-       return (p < max);
+       return true;
 }
 
 /* return true for good ident, false else */
-bool IsIdentHandler::Call(const char* n)
+bool IsIdentHandler::Call(const std::string& n)
 {
-       if (!n || !*n)
+       if (n.empty())
                return false;
 
-       for (const char* i = n; *i; i++)
+       for (std::string::const_iterator i = n.begin(); i != n.end(); ++i)
        {
                if ((*i >= 'A') && (*i <= '}'))
                {
@@ -268,7 +307,7 @@ bool IsIdentHandler::Call(const char* n)
        return true;
 }
 
-bool IsSIDHandler::Call(const std::string &str)
+bool InspIRCd::IsSID(const std::string &str)
 {
        /* Returns true if the string given is exactly 3 characters long,
         * starts with a digit, and the other two characters are A-Z or digits
@@ -278,135 +317,40 @@ bool IsSIDHandler::Call(const std::string &str)
                         ((str[2] >= 'A' && str[2] <= 'Z') || isdigit(str[2])));
 }
 
-/* open the proper logfile */
-bool InspIRCd::OpenLog(char**, int)
-{
-       /* This function only happens at startup now */
-       if (Config->nofork)
-       {
-               this->Logs->SetupNoFork();
-       }
-       Config->MyDir = Config->GetFullProgDir();
-
-       /* Attempt to find home directory, portable to windows */
-       const char* home = getenv("HOME");
-       if (!home)
-       {
-               /* No $HOME, log to %USERPROFILE% */
-               home = getenv("USERPROFILE");
-               if (!home)
-               {
-                       /* Nothing could be found at all, log to current dir */
-                       Config->logpath = "./startup.log";
-               }
-       }
-
-       if (!Config->writelog) return true; // Skip opening default log if -nolog
-
-       if (!*this->LogFileName)
-       {
-               if (Config->logpath.empty())
-               {
-                       std::string path = std::string(home) + "/.inspircd";
-                       // This tries to create the ~/.inspircd. If it succeeds, then we go ahead and use it.
-                       // If it fails due to an existing target, then we use it anyway.
-                       // Either way, we make sure we can get write access to the log at this point.
-                       if (!mkdir(path.c_str(), 0700) || errno == EEXIST)
-                       {
-                               /* Log to ~/.inspircd/ircd.log */
-                               Config->logpath = path + "/startup.log";
-                               FILE* fd = fopen(Config->logpath.c_str(), "a+");
-                               if (!fd)
-                               {
-                                       // Could not get write access... Why?
-                                       if (errno == ENOTDIR)
-                                               // ~/.inspircd is not actually a directory!
-                                               printf("\nWARNING: Unable to create directory: %s (Exists and is not a directory)\n", path.c_str());
-                                       else
-                                               // Not writable for some other reason (no +w access, readonly fs, file too big, whatever).
-                                               printf("\nWARNING: No write access to %s (%s)\n", Config->logpath.c_str(), strerror(errno));
-                                       Config->logpath = "./startup.log";
-                               }
-                               else
-                               {
-                                       Config->log_file = fd;
-                               }
-                       }
-                       else
-                       {
-                               /* Couldn't make ~/.inspircd directory, log to current dir */
-                               Config->logpath = "./startup.log";
-                               printf("\nWARNING: Unable to create directory: %s (%s)\n", path.c_str(), strerror(errno));
-                       }
-               }
-
-               if (!Config->log_file)
-                       Config->log_file = fopen(Config->logpath.c_str(),"a+");
-       }
-       else
-       {
-               Config->log_file = fopen(this->LogFileName,"a+");
-       }
-
-       if (!Config->log_file)
-       {
-               return false;
-       }
-
-       FileWriter* fw = new FileWriter(this, Config->log_file);
-       FileLogStream *f = new FileLogStream(this, (Config->forcedebug ? DEBUG : DEFAULT), fw);
-
-       this->Logs->AddLogType("*", f, true);
-
-       return true;
-}
-
 void InspIRCd::CheckRoot()
 {
+#ifndef _WIN32
        if (geteuid() == 0)
        {
-               printf("WARNING!!! You are running an irc server as ROOT!!! DO NOT DO THIS!!!\n\n");
-               this->Logs->Log("STARTUP",DEFAULT,"Cant start as root");
+               std::cout << "ERROR: You are running an irc server as root! DO NOT DO THIS!" << std::endl << std::endl;
+               this->Logs->Log("STARTUP", LOG_DEFAULT, "Can't start as root");
                Exit(EXIT_STATUS_ROOT);
        }
-}
-
-void InspIRCd::CheckDie()
-{
-       if (*Config->DieValue)
-       {
-               printf("WARNING: %s\n\n",Config->DieValue);
-               this->Logs->Log("CONFIG",DEFAULT,"Died because of <die> tag: %s",Config->DieValue);
-               Exit(EXIT_STATUS_DIETAG);
-       }
+#endif
 }
 
 void InspIRCd::SendWhoisLine(User* user, User* dest, int numeric, const std::string &text)
 {
        std::string copy_text = text;
 
-       int MOD_RESULT = 0;
-       FOREACH_RESULT_I(this, I_OnWhoisLine, OnWhoisLine(user, dest, numeric, copy_text));
+       ModResult MOD_RESULT;
+       FIRST_MOD_RESULT(OnWhoisLine, MOD_RESULT, (user, dest, numeric, copy_text));
 
-       if (!MOD_RESULT)
+       if (MOD_RESULT != MOD_RES_DENY)
                user->WriteServ("%d %s", numeric, copy_text.c_str());
 }
 
 void InspIRCd::SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...)
 {
-       char textbuffer[MAXBUF];
-       va_list argsPtr;
-       va_start (argsPtr, format);
-       vsnprintf(textbuffer, MAXBUF, format, argsPtr);
-       va_end(argsPtr);
-
-       this->SendWhoisLine(user, dest, numeric, std::string(textbuffer));
+       std::string textbuffer;
+       VAFORMAT(textbuffer, format, format)
+       this->SendWhoisLine(user, dest, numeric, textbuffer);
 }
 
-/** Refactored by Brain, Jun 2008. Much faster with some clever O(1) array
+/** Refactored by Brain, Jun 2009. Much faster with some clever O(1) array
  * lookups and pointer maths.
  */
-long InspIRCd::Duration(const std::string &str)
+unsigned long InspIRCd::Duration(const std::string &str)
 {
        unsigned char multiplier = 0;
        long total = 0;
@@ -446,22 +390,49 @@ long InspIRCd::Duration(const std::string &str)
        return total + subtotal;
 }
 
-bool InspIRCd::ULine(const char* sserver)
+const char* InspIRCd::Format(va_list &vaList, const char* formatString)
 {
-       if (!sserver)
-               return false;
-       if (!*sserver)
+       static std::vector<char> formatBuffer(1024);
+
+       while (true)
+       {
+               va_list dst;
+               va_copy(dst, vaList);
+
+               int vsnret = vsnprintf(&formatBuffer[0], formatBuffer.size(), formatString, dst);
+               if (vsnret > 0 && static_cast<unsigned>(vsnret) < formatBuffer.size())
+               {
+                       return &formatBuffer[0];
+               }
+
+               formatBuffer.resize(formatBuffer.size() * 2);
+       }
+
+       throw CoreException();
+}
+
+const char* InspIRCd::Format(const char* formatString, ...)
+{
+       const char* ret;
+       VAFORMAT(ret, formatString, formatString);
+       return ret;
+}
+
+bool InspIRCd::ULine(const std::string& sserver)
+{
+       if (sserver.empty())
                return true;
 
-       return (Config->ulines.find(sserver) != Config->ulines.end());
+       return (Config->ulines.find(sserver.c_str()) != Config->ulines.end());
 }
 
-bool InspIRCd::SilentULine(const char* sserver)
+bool InspIRCd::SilentULine(const std::string& sserver)
 {
-       std::map<irc::string,bool>::iterator n = Config->ulines.find(sserver);
+       std::map<irc::string,bool>::iterator n = Config->ulines.find(sserver.c_str());
        if (n != Config->ulines.end())
                return n->second;
-       else return false;
+       else
+               return false;
 }
 
 std::string InspIRCd::TimeString(time_t curtime)
@@ -469,16 +440,65 @@ std::string InspIRCd::TimeString(time_t curtime)
        return std::string(ctime(&curtime),24);
 }
 
-// You should only pass a single character to this.
-void InspIRCd::AddExtBanChar(const char *c)
+std::string InspIRCd::GenRandomStr(int length, bool printable)
+{
+       char* buf = new char[length];
+       GenRandom(buf, length);
+       std::string rv;
+       rv.resize(length);
+       for(int i=0; i < length; i++)
+               rv[i] = printable ? 0x3F + (buf[i] & 0x3F) : buf[i];
+       delete[] buf;
+       return rv;
+}
+
+// NOTE: this has a slight bias for lower values if max is not a power of 2.
+// Don't use it if that matters.
+unsigned long InspIRCd::GenRandomInt(unsigned long max)
 {
-       std::string &tok = Config->data005;
-       
-       if (tok.find(" EXTBAN=:") == std::string::npos)
+       unsigned long rv;
+       GenRandom((char*)&rv, sizeof(rv));
+       return rv % max;
+}
+
+// This is overridden by a higher-quality algorithm when SSL support is loaded
+void GenRandomHandler::Call(char *output, size_t max)
+{
+       for(unsigned int i=0; i < max; i++)
+#ifdef _WIN32
        {
-               tok.append(" EXTBAN=:");
-               tok.append(c);
+               unsigned int uTemp;
+               if(rand_s(&uTemp) != 0)
+                       output[i] = rand();
+               else
+                       output[i] = uTemp;
        }
-       else
-               tok.insert(tok.find(" EXTBAN=:") + 9, c);
+#else
+               output[i] = random();
+#endif
+}
+
+ModResult OnCheckExemptionHandler::Call(User* user, Channel* chan, const std::string& restriction)
+{
+       unsigned int mypfx = chan->GetPrefixValue(user);
+       char minmode = 0;
+       std::string current;
+
+       irc::spacesepstream defaultstream(ServerInstance->Config->ConfValue("options")->getString("exemptchanops"));
+
+       while (defaultstream.GetToken(current))
+       {
+               std::string::size_type pos = current.find(':');
+               if (pos == std::string::npos)
+                       continue;
+               if (current.substr(0,pos) == restriction)
+                       minmode = current[pos+1];
+       }
+
+       ModeHandler* mh = ServerInstance->Modes->FindMode(minmode, MODETYPE_CHANNEL);
+       if (mh && mypfx >= mh->GetPrefixRank())
+               return MOD_RES_ALLOW;
+       if (mh || minmode == '*')
+               return MOD_RES_DENY;
+       return MOD_RES_PASSTHRU;
 }