src/modules/m_callerid.cpp

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
   5  *   Copyright (C) 2008-2009 Robin Burchell <robin+git@viroteck.net>
   6  *   Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
   7  *   Copyright (C) 2008 Craig Edwards <craigedwards@brainbox.cc>
   8  *
   9  * This file is part of InspIRCd.  InspIRCd is free software: you can
  10  * redistribute it and/or modify it under the terms of the GNU General Public
  11  * License as published by the Free Software Foundation, version 2.
  12  *
  13  * This program is distributed in the hope that it will be useful, but WITHOUT
  14  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  15  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  16  * details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20  */
  21
  22
  23 #include "inspircd.h"
  24
  25 /* $ModDesc: Implementation of callerid, usermode +g, /accept */
  26
  27 class callerid_data
  28 {
  29  public:
  30         time_t lastnotify;
  31
  32         /** Users I accept messages from
  33          */
  34         std::set<User*> accepting;
  35
  36         /** Users who list me as accepted
  37          */
  38         std::list<callerid_data *> wholistsme;
  39
  40         callerid_data() : lastnotify(0) { }
  41
  42         std::string ToString(SerializeFormat format) const
  43         {
  44                 std::ostringstream oss;
  45                 oss << lastnotify;
  46                 for (std::set<User*>::const_iterator i = accepting.begin(); i != accepting.end(); ++i)
  47                 {
  48                         User* u = *i;
  49                         // Encode UIDs.
  50                         oss << "," << (format == FORMAT_USER ? u->nick : u->uuid);
  51                 }
  52                 return oss.str();
  53         }
  54 };
  55
  56 struct CallerIDExtInfo : public ExtensionItem
  57 {
  58         CallerIDExtInfo(Module* parent)
  59                 : ExtensionItem("callerid_data", parent)
  60         {
  61         }
  62
  63         std::string serialize(SerializeFormat format, const Extensible* container, void* item) const
  64         {
  65                 callerid_data* dat = static_cast<callerid_data*>(item);
  66                 return dat->ToString(format);
  67         }
  68
  69         void unserialize(SerializeFormat format, Extensible* container, const std::string& value)
  70         {
  71                 callerid_data* dat = new callerid_data;
  72                 irc::commasepstream s(value);
  73                 std::string tok;
  74                 if (s.GetToken(tok))
  75                         dat->lastnotify = ConvToInt(tok);
  76
  77                 while (s.GetToken(tok))
  78                 {
  79                         if (tok.empty())
  80                                 continue;
  81
  82                         User *u = ServerInstance->FindNick(tok);
  83                         if ((u) && (u->registered == REG_ALL) && (!u->quitting) && (!IS_SERVER(u)))
  84                         {
  85                                 if (dat->accepting.insert(u).second)
  86                                 {
  87                                         callerid_data* other = this->get(u, true);
  88                                         other->wholistsme.push_back(dat);
  89                                 }
  90                         }
  91                 }
  92
  93                 void* old = set_raw(container, dat);
  94                 if (old)
  95                         this->free(old);
  96         }
  97
  98         callerid_data* get(User* user, bool create)
  99         {
 100                 callerid_data* dat = static_cast<callerid_data*>(get_raw(user));
 101                 if (create && !dat)
 102                 {
 103                         dat = new callerid_data;
 104                         set_raw(user, dat);
 105                 }
 106                 return dat;
 107         }
 108
 109         void free(void* item)
 110         {
 111                 callerid_data* dat = static_cast<callerid_data*>(item);
 112
 113                 // We need to walk the list of users on our accept list, and remove ourselves from their wholistsme.
 114                 for (std::set<User *>::iterator it = dat->accepting.begin(); it != dat->accepting.end(); it++)
 115                 {
 116                         callerid_data *targ = this->get(*it, false);
 117
 118                         if (!targ)
 119                         {
 120                                 ServerInstance->Logs->Log("m_callerid", DEFAULT, "ERROR: Inconsistency detected in callerid state, please report (1)");
 121                                 continue; // shouldn't happen, but oh well.
 122                         }
 123
 124                         std::list<callerid_data*>::iterator it2 = std::find(targ->wholistsme.begin(), targ->wholistsme.end(), dat);
 125                         if (it2 != targ->wholistsme.end())
 126                                 targ->wholistsme.erase(it2);
 127                         else
 128                                 ServerInstance->Logs->Log("m_callerid", DEFAULT, "ERROR: Inconsistency detected in callerid state, please report (2)");
 129                 }
 130                 delete dat;
 131         }
 132 };
 133
 134 class User_g : public SimpleUserModeHandler
 135 {
 136 public:
 137         User_g(Module* Creator) : SimpleUserModeHandler(Creator, "callerid", 'g') { }
 138 };
 139
 140 class CommandAccept : public Command
 141 {
 142 public:
 143         CallerIDExtInfo extInfo;
 144         unsigned int maxaccepts;
 145         CommandAccept(Module* Creator) : Command(Creator, "ACCEPT", 1),
 146                 extInfo(Creator)
 147         {
 148                 allow_empty_last_param = false;
 149                 syntax = "{[+|-]<nicks>}|*}";
 150                 TRANSLATE2(TR_CUSTOM, TR_END);
 151         }
 152
 153         virtual void EncodeParameter(std::string& parameter, int index)
 154         {
 155                 if (index != 0)
 156                         return;
 157                 std::string out;
 158                 irc::commasepstream nicks(parameter);
 159                 std::string tok;
 160                 while (nicks.GetToken(tok))
 161                 {
 162                         if (tok == "*")
 163                         {
 164                                 continue; // Drop list requests, since remote servers ignore them anyway.
 165                         }
 166                         if (!out.empty())
 167                                 out.append(",");
 168                         bool dash = false;
 169                         if (tok[0] == '-')
 170                         {
 171                                 dash = true;
 172                                 tok.erase(0, 1); // Remove the dash.
 173                         }
 174                         else if (tok[0] == '+')
 175                                 tok.erase(0, 1);
 176
 177                         User* u = ServerInstance->FindNick(tok);
 178                         if ((!u) || (u->registered != REG_ALL) || (u->quitting) || (IS_SERVER(u)))
 179                                 continue;
 180
 181                         if (dash)
 182                                 out.append("-");
 183                         out.append(u->uuid);
 184                 }
 185                 parameter = out;
 186         }
 187
 188         /** Will take any number of nicks (up to MaxTargets), which can be seperated by commas.
 189          * - in front of any nick removes, and an * lists. This effectively means you can do:
 190          * /accept nick1,nick2,nick3,*
 191          * to add 3 nicks and then show your list
 192          */
 193         CmdResult Handle(const std::vector<std::string> &parameters, User* user)
 194         {
 195                 if (ServerInstance->Parser->LoopCall(user, this, parameters, 0))
 196                         return CMD_SUCCESS;
 197                 /* Even if callerid mode is not set, we let them manage their ACCEPT list so that if they go +g they can
 198                  * have a list already setup. */
 199
 200                 std::string tok = parameters[0];
 201
 202                 if (tok == "*")
 203                 {
 204                         if (IS_LOCAL(user))
 205                                 ListAccept(user);
 206                         return CMD_SUCCESS;
 207                 }
 208                 else if (tok[0] == '-')
 209                 {
 210                         User* whotoremove = ServerInstance->FindNick(tok.substr(1));
 211                         if (whotoremove)
 212                                 return (RemoveAccept(user, whotoremove) ? CMD_SUCCESS : CMD_FAILURE);
 213                         else
 214                                 return CMD_FAILURE;
 215                 }
 216                 else
 217                 {
 218                         User* whotoadd = ServerInstance->FindNick(tok[0] == '+' ? tok.substr(1) : tok);
 219                         if ((whotoadd) && (whotoadd->registered == REG_ALL) && (!whotoadd->quitting) && (!IS_SERVER(whotoadd)))
 220                                 return (AddAccept(user, whotoadd) ? CMD_SUCCESS : CMD_FAILURE);
 221                         else
 222                         {
 223                                 user->WriteNumeric(401, "%s %s :No such nick/channel", user->nick.c_str(), tok.c_str());
 224                                 return CMD_FAILURE;
 225                         }
 226                 }
 227         }
 228
 229         RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
 230         {
 231                 return ROUTE_BROADCAST;
 232         }
 233
 234         void ListAccept(User* user)
 235         {
 236                 callerid_data* dat = extInfo.get(user, false);
 237                 if (dat)
 238                 {
 239                         for (std::set<User*>::iterator i = dat->accepting.begin(); i != dat->accepting.end(); ++i)
 240                                 user->WriteNumeric(281, "%s %s", user->nick.c_str(), (*i)->nick.c_str());
 241                 }
 242                 user->WriteNumeric(282, "%s :End of ACCEPT list", user->nick.c_str());
 243         }
 244
 245         bool AddAccept(User* user, User* whotoadd)
 246         {
 247                 // Add this user to my accept list first, so look me up..
 248                 callerid_data* dat = extInfo.get(user, true);
 249                 if (dat->accepting.size() >= maxaccepts)
 250                 {
 251                         user->WriteNumeric(456, "%s :Accept list is full (limit is %d)", user->nick.c_str(), maxaccepts);
 252                         return false;
 253                 }
 254                 if (!dat->accepting.insert(whotoadd).second)
 255                 {
 256                         user->WriteNumeric(457, "%s %s :is already on your accept list", user->nick.c_str(), whotoadd->nick.c_str());
 257                         return false;
 258                 }
 259
 260                 // Now, look them up, and add me to their list
 261                 callerid_data *targ = extInfo.get(whotoadd, true);
 262                 targ->wholistsme.push_back(dat);
 263
 264                 user->WriteServ("NOTICE %s :%s is now on your accept list", user->nick.c_str(), whotoadd->nick.c_str());
 265                 return true;
 266         }
 267
 268         bool RemoveAccept(User* user, User* whotoremove)
 269         {
 270                 // Remove them from my list, so look up my list..
 271                 callerid_data* dat = extInfo.get(user, false);
 272                 if (!dat)
 273                 {
 274                         user->WriteNumeric(458, "%s %s :is not on your accept list", user->nick.c_str(), whotoremove->nick.c_str());
 275                         return false;
 276                 }
 277                 std::set<User*>::iterator i = dat->accepting.find(whotoremove);
 278                 if (i == dat->accepting.end())
 279                 {
 280                         user->WriteNumeric(458, "%s %s :is not on your accept list", user->nick.c_str(), whotoremove->nick.c_str());
 281                         return false;
 282                 }
 283
 284                 dat->accepting.erase(i);
 285
 286                 // Look up their list to remove me.
 287                 callerid_data *dat2 = extInfo.get(whotoremove, false);
 288                 if (!dat2)
 289                 {
 290                         // How the fuck is this possible.
 291                         ServerInstance->Logs->Log("m_callerid", DEFAULT, "ERROR: Inconsistency detected in callerid state, please report (3)");
 292                         return false;
 293                 }
 294
 295                 std::list<callerid_data*>::iterator it = std::find(dat2->wholistsme.begin(), dat2->wholistsme.end(), dat);
 296                 if (it != dat2->wholistsme.end())
 297                         // Found me!
 298                         dat2->wholistsme.erase(it);
 299                 else
 300                         ServerInstance->Logs->Log("m_callerid", DEFAULT, "ERROR: Inconsistency detected in callerid state, please report (4)");
 301
 302
 303                 user->WriteServ("NOTICE %s :%s is no longer on your accept list", user->nick.c_str(), whotoremove->nick.c_str());
 304                 return true;
 305         }
 306 };
 307
 308 class ModuleCallerID : public Module
 309 {
 310 private:
 311         CommandAccept cmd;
 312         User_g myumode;
 313
 314         // Configuration variables:
 315         bool operoverride; // Operators can override callerid.
 316         bool tracknick; // Allow ACCEPT entries to update with nick changes.
 317         unsigned int notify_cooldown; // Seconds between notifications.
 318
 319         /** Removes a user from all accept lists
 320          * @param who The user to remove from accepts
 321          */
 322         void RemoveFromAllAccepts(User* who)
 323         {
 324                 // First, find the list of people who have me on accept
 325                 callerid_data *userdata = cmd.extInfo.get(who, false);
 326                 if (!userdata)
 327                         return;
 328
 329                 // Iterate over the list of people who accept me, and remove all entries
 330                 for (std::list<callerid_data *>::iterator it = userdata->wholistsme.begin(); it != userdata->wholistsme.end(); it++)
 331                 {
 332                         callerid_data *dat = *(it);
 333
 334                         // Find me on their callerid list
 335                         std::set<User *>::iterator it2 = dat->accepting.find(who);
 336
 337                         if (it2 != dat->accepting.end())
 338                                 dat->accepting.erase(it2);
 339                         else
 340                                 ServerInstance->Logs->Log("m_callerid", DEFAULT, "ERROR: Inconsistency detected in callerid state, please report (5)");
 341                 }
 342
 343                 userdata->wholistsme.clear();
 344         }
 345
 346 public:
 347         ModuleCallerID() : cmd(this), myumode(this)
 348         {
 349         }
 350
 351         void init()
 352         {
 353                 OnRehash(NULL);
 354
 355                 ServerInstance->Modules->AddService(myumode);
 356                 ServerInstance->Modules->AddService(cmd);
 357                 ServerInstance->Modules->AddService(cmd.extInfo);
 358
 359                 Implementation eventlist[] = { I_OnRehash, I_OnUserPostNick, I_OnUserQuit, I_On005Numeric, I_OnUserPreNotice, I_OnUserPreMessage };
 360                 ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
 361         }
 362
 363         virtual ~ModuleCallerID()
 364         {
 365         }
 366
 367         virtual Version GetVersion()
 368         {
 369                 return Version("Implementation of callerid, usermode +g, /accept", VF_COMMON | VF_VENDOR);
 370         }
 371
 372         virtual void On005Numeric(std::string& output)
 373         {
 374                 output += " CALLERID=g";
 375         }
 376
 377         ModResult PreText(User* user, User* dest, std::string& text)
 378         {
 379                 if (!dest->IsModeSet('g') || (user == dest))
 380                         return MOD_RES_PASSTHRU;
 381
 382                 if (operoverride && IS_OPER(user))
 383                         return MOD_RES_PASSTHRU;
 384
 385                 callerid_data* dat = cmd.extInfo.get(dest, true);
 386                 std::set<User*>::iterator i = dat->accepting.find(user);
 387
 388                 if (i == dat->accepting.end())
 389                 {
 390                         time_t now = ServerInstance->Time();
 391                         /* +g and *not* accepted */
 392                         user->WriteNumeric(716, "%s %s :is in +g mode (server-side ignore).", user->nick.c_str(), dest->nick.c_str());
 393                         if (now > (dat->lastnotify + (time_t)notify_cooldown))
 394                         {
 395                                 user->WriteNumeric(717, "%s %s :has been informed that you messaged them.", user->nick.c_str(), dest->nick.c_str());
 396                                 dest->SendText(":%s 718 %s %s %s@%s :is messaging you, and you have umode +g. Use /ACCEPT +%s to allow.",
 397                                         ServerInstance->Config->ServerName.c_str(), dest->nick.c_str(), user->nick.c_str(), user->ident.c_str(), user->dhost.c_str(), user->nick.c_str());
 398                                 dat->lastnotify = now;
 399                         }
 400                         return MOD_RES_DENY;
 401                 }
 402                 return MOD_RES_PASSTHRU;
 403         }
 404
 405         virtual ModResult OnUserPreMessage(User* user, void* dest, int target_type, std::string& text, char status, CUList &exempt_list)
 406         {
 407                 if (IS_LOCAL(user) && target_type == TYPE_USER)
 408                         return PreText(user, (User*)dest, text);
 409
 410                 return MOD_RES_PASSTHRU;
 411         }
 412
 413         virtual ModResult OnUserPreNotice(User* user, void* dest, int target_type, std::string& text, char status, CUList &exempt_list)
 414         {
 415                 if (IS_LOCAL(user) && target_type == TYPE_USER)
 416                         return PreText(user, (User*)dest, text);
 417
 418                 return MOD_RES_PASSTHRU;
 419         }
 420
 421         void OnUserPostNick(User* user, const std::string& oldnick)
 422         {
 423                 if (!tracknick)
 424                         RemoveFromAllAccepts(user);
 425         }
 426
 427         void OnUserQuit(User* user, const std::string& message, const std::string& oper_message)
 428         {
 429                 RemoveFromAllAccepts(user);
 430         }
 431
 432         virtual void OnRehash(User* user)
 433         {
 434                 ConfigTag* tag = ServerInstance->Config->ConfValue("callerid");
 435                 cmd.maxaccepts = tag->getInt("maxaccepts", 16);
 436                 operoverride = tag->getBool("operoverride");
 437                 tracknick = tag->getBool("tracknick");
 438                 notify_cooldown = tag->getInt("cooldown", 60);
 439         }
 440 };
 441
 442 MODULE_INIT(ModuleCallerID)
 443
 444