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 (umode +g & /accept, ala hybrid etc) */
  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         callerid_data(const std::string& str)
  42         {
  43                 irc::commasepstream s(str);
  44                 std::string tok;
  45                 if (s.GetToken(tok))
  46                 {
  47                         lastnotify = ConvToInt(tok);
  48                 }
  49                 while (s.GetToken(tok))
  50                 {
  51                         if (tok.empty())
  52                         {
  53                                 continue;
  54                         }
  55
  56                         User *u = ServerInstance->FindNick(tok);
  57                         if (!u)
  58                         {
  59                                 continue;
  60                         }
  61                         accepting.insert(u);
  62                 }
  63         }
  64
  65         std::string ToString(SerializeFormat format) const
  66         {
  67                 std::ostringstream oss;
  68                 oss << lastnotify;
  69                 for (std::set<User*>::const_iterator i = accepting.begin(); i != accepting.end(); ++i)
  70                 {
  71                         User* u = *i;
  72                         // Encode UIDs.
  73                         oss << "," << (format == FORMAT_USER ? u->nick : u->uuid);
  74                 }
  75                 return oss.str();
  76         }
  77 };
  78
  79 struct CallerIDExtInfo : public ExtensionItem
  80 {
  81         CallerIDExtInfo(Module* parent)
  82                 : ExtensionItem("callerid_data", parent)
  83         {
  84         }
  85
  86         std::string serialize(SerializeFormat format, const Extensible* container, void* item) const
  87         {
  88                 callerid_data* dat = static_cast<callerid_data*>(item);
  89                 return dat->ToString(format);
  90         }
  91
  92         void unserialize(SerializeFormat format, Extensible* container, const std::string& value)
  93         {
  94                 callerid_data* dat = new callerid_data(value);
  95                 set_raw(container, dat);
  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                                 continue; // shouldn't happen, but oh well.
 120
 121                         std::list<callerid_data*>::iterator it2 = std::find(targ->wholistsme.begin(), targ->wholistsme.end(), dat);
 122                         if (it2 != targ->wholistsme.end())
 123                                 targ->wholistsme.erase(it2);
 124                 }
 125         }
 126 };
 127
 128 class User_g : public SimpleUserModeHandler
 129 {
 130 public:
 131         User_g(Module* Creator) : SimpleUserModeHandler(Creator, "callerid", 'g') { }
 132 };
 133
 134 class CommandAccept : public Command
 135 {
 136 public:
 137         CallerIDExtInfo extInfo;
 138         unsigned int maxaccepts;
 139         CommandAccept(Module* Creator) : Command(Creator, "ACCEPT", 1),
 140                 extInfo(Creator)
 141         {
 142                 syntax = "{[+|-]<nicks>}|*}";
 143                 TRANSLATE2(TR_CUSTOM, TR_END);
 144         }
 145
 146         virtual void EncodeParameter(std::string& parameter, int index)
 147         {
 148                 if (index != 0)
 149                         return;
 150                 std::string out = "";
 151                 irc::commasepstream nicks(parameter);
 152                 std::string tok;
 153                 while (nicks.GetToken(tok))
 154                 {
 155                         if (tok == "*")
 156                         {
 157                                 continue; // Drop list requests, since remote servers ignore them anyway.
 158                         }
 159                         if (!out.empty())
 160                                 out.append(",");
 161                         bool dash = false;
 162                         if (tok[0] == '-')
 163                         {
 164                                 dash = true;
 165                                 tok.erase(0, 1); // Remove the dash.
 166                         }
 167                         User* u = ServerInstance->FindNick(tok);
 168                         if (u)
 169                         {
 170                                 if (dash)
 171                                         out.append("-");
 172                                 out.append(u->uuid);
 173                         }
 174                         else
 175                         {
 176                                 if (dash)
 177                                         out.append("-");
 178                                 out.append(tok);
 179                         }
 180                 }
 181                 parameter = out;
 182         }
 183
 184         /** Will take any number of nicks (up to MaxTargets), which can be seperated by commas.
 185          * - in front of any nick removes, and an * lists. This effectively means you can do:
 186          * /accept nick1,nick2,nick3,*
 187          * to add 3 nicks and then show your list
 188          */
 189         CmdResult Handle(const std::vector<std::string> &parameters, User* user)
 190         {
 191                 if (ServerInstance->Parser->LoopCall(user, this, parameters, 0))
 192                         return CMD_SUCCESS;
 193                 /* Even if callerid mode is not set, we let them manage their ACCEPT list so that if they go +g they can
 194                  * have a list already setup. */
 195
 196                 std::string tok = parameters[0];
 197
 198                 if (tok == "*")
 199                 {
 200                         if (IS_LOCAL(user))
 201                                 ListAccept(user);
 202                         return CMD_SUCCESS;
 203                 }
 204                 else if (tok[0] == '-')
 205                 {
 206                         User* whotoremove = ServerInstance->FindNick(tok.substr(1));
 207                         if (whotoremove)
 208                                 return (RemoveAccept(user, whotoremove, false) ? CMD_SUCCESS : CMD_FAILURE);
 209                         else
 210                                 return CMD_FAILURE;
 211                 }
 212                 else
 213                 {
 214                         User* whotoadd = ServerInstance->FindNick(tok[0] == '+' ? tok.substr(1) : tok);
 215                         if (whotoadd)
 216                                 return (AddAccept(user, whotoadd, false) ? CMD_SUCCESS : CMD_FAILURE);
 217                         else
 218                         {
 219                                 user->WriteNumeric(401, "%s %s :No such nick/channel", user->nick.c_str(), tok.c_str());
 220                                 return CMD_FAILURE;
 221                         }
 222                 }
 223         }
 224
 225         RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
 226         {
 227                 return ROUTE_BROADCAST;
 228         }
 229
 230         void ListAccept(User* user)
 231         {
 232                 callerid_data* dat = extInfo.get(user, false);
 233                 if (dat)
 234                 {
 235                         for (std::set<User*>::iterator i = dat->accepting.begin(); i != dat->accepting.end(); ++i)
 236                                 user->WriteNumeric(281, "%s %s", user->nick.c_str(), (*i)->nick.c_str());
 237                 }
 238                 user->WriteNumeric(282, "%s :End of ACCEPT list", user->nick.c_str());
 239         }
 240
 241         bool AddAccept(User* user, User* whotoadd, bool quiet)
 242         {
 243                 // Add this user to my accept list first, so look me up..
 244                 callerid_data* dat = extInfo.get(user, true);
 245                 if (dat->accepting.size() >= maxaccepts)
 246                 {
 247                         if (!quiet)
 248                                 user->WriteNumeric(456, "%s :Accept list is full (limit is %d)", user->nick.c_str(), maxaccepts);
 249
 250                         return false;
 251                 }
 252                 if (!dat->accepting.insert(whotoadd).second)
 253                 {
 254                         if (!quiet)
 255                                 user->WriteNumeric(457, "%s %s :is already on your accept list", user->nick.c_str(), whotoadd->nick.c_str());
 256
 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, bool quiet)
 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                         if (!quiet)
 275                                 user->WriteNumeric(458, "%s %s :is not on your accept list", user->nick.c_str(), whotoremove->nick.c_str());
 276
 277                         return false;
 278                 }
 279                 std::set<User*>::iterator i = dat->accepting.find(whotoremove);
 280                 if (i == dat->accepting.end())
 281                 {
 282                         if (!quiet)
 283                                 user->WriteNumeric(458, "%s %s :is not on your accept list", user->nick.c_str(), whotoremove->nick.c_str());
 284
 285                         return false;
 286                 }
 287
 288                 dat->accepting.erase(i);
 289
 290                 // Look up their list to remove me.
 291                 callerid_data *dat2 = extInfo.get(whotoremove, false);
 292                 if (!dat2)
 293                 {
 294                         // How the fuck is this possible.
 295                         return false;
 296                 }
 297
 298                 std::list<callerid_data*>::iterator it = std::find(dat2->wholistsme.begin(), dat2->wholistsme.end(), dat);
 299                 if (it != dat2->wholistsme.end())
 300                         // Found me!
 301                         dat2->wholistsme.erase(it);
 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                 }
 340
 341                 userdata->wholistsme.clear();
 342         }
 343
 344 public:
 345         ModuleCallerID() : cmd(this), myumode(this)
 346         {
 347         }
 348
 349         void init()
 350         {
 351                 OnRehash(NULL);
 352
 353                 ServerInstance->Modules->AddService(myumode);
 354                 ServerInstance->Modules->AddService(cmd);
 355                 ServerInstance->Modules->AddService(cmd.extInfo);
 356
 357                 Implementation eventlist[] = { I_OnRehash, I_OnUserPreNick, I_OnUserQuit, I_On005Numeric, I_OnUserPreNotice, I_OnUserPreMessage };
 358                 ServerInstance->Modules->Attach(eventlist, this, 6);
 359         }
 360
 361         virtual ~ModuleCallerID()
 362         {
 363         }
 364
 365         virtual Version GetVersion()
 366         {
 367                 return Version("Implementation of callerid (umode +g & /accept, ala hybrid etc)", VF_COMMON | VF_VENDOR);
 368         }
 369
 370         virtual void On005Numeric(std::string& output)
 371         {
 372                 output += " CALLERID=g";
 373         }
 374
 375         ModResult PreText(User* user, User* dest, std::string& text, bool notice)
 376         {
 377                 if (!dest->IsModeSet('g'))
 378                         return MOD_RES_PASSTHRU;
 379
 380                 if (operoverride && IS_OPER(user))
 381                         return MOD_RES_PASSTHRU;
 382
 383                 callerid_data* dat = cmd.extInfo.get(dest, true);
 384                 std::set<User*>::iterator i = dat->accepting.find(user);
 385
 386                 if (i == dat->accepting.end())
 387                 {
 388                         time_t now = ServerInstance->Time();
 389                         /* +g and *not* accepted */
 390                         user->WriteNumeric(716, "%s %s :is in +g mode (server-side ignore).", user->nick.c_str(), dest->nick.c_str());
 391                         if (now > (dat->lastnotify + (time_t)notify_cooldown))
 392                         {
 393                                 user->WriteNumeric(717, "%s %s :has been informed that you messaged them.", user->nick.c_str(), dest->nick.c_str());
 394                                 dest->SendText(":%s 718 %s %s %s@%s :is messaging you, and you have umode +g. Use /ACCEPT +%s to allow.",
 395                                         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());
 396                                 dat->lastnotify = now;
 397                         }
 398                         return MOD_RES_DENY;
 399                 }
 400                 return MOD_RES_PASSTHRU;
 401         }
 402
 403         virtual ModResult OnUserPreMessage(User* user, void* dest, int target_type, std::string& text, char status, CUList &exempt_list)
 404         {
 405                 if (IS_LOCAL(user) && target_type == TYPE_USER)
 406                         return PreText(user, (User*)dest, text, true);
 407
 408                 return MOD_RES_PASSTHRU;
 409         }
 410
 411         virtual ModResult OnUserPreNotice(User* user, void* dest, int target_type, std::string& text, char status, CUList &exempt_list)
 412         {
 413                 if (IS_LOCAL(user) && target_type == TYPE_USER)
 414                         return PreText(user, (User*)dest, text, true);
 415
 416                 return MOD_RES_PASSTHRU;
 417         }
 418
 419         ModResult OnUserPreNick(User* user, const std::string& newnick)
 420         {
 421                 if (!tracknick)
 422                         RemoveFromAllAccepts(user);
 423                 return MOD_RES_PASSTHRU;
 424         }
 425
 426         void OnUserQuit(User* user, const std::string& message, const std::string& oper_message)
 427         {
 428                 RemoveFromAllAccepts(user);
 429         }
 430
 431         virtual void OnRehash(User* user)
 432         {
 433                 ConfigReader Conf;
 434                 cmd.maxaccepts = Conf.ReadInteger("callerid", "maxaccepts", "16", 0, true);
 435                 operoverride = Conf.ReadFlag("callerid", "operoverride", "0", 0);
 436                 tracknick = Conf.ReadFlag("callerid", "tracknick", "0", 0);
 437                 notify_cooldown = Conf.ReadInteger("callerid", "cooldown", "60", 0, true);
 438         }
 439 };
 440
 441 MODULE_INIT(ModuleCallerID)
 442
 443