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         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) && (u->registered == REG_ALL) && (!u->quitting) && (!IS_SERVER(u)))
  58                                 accepting.insert(u);
  59                 }
  60         }
  61
  62         std::string ToString(SerializeFormat format) const
  63         {
  64                 std::ostringstream oss;
  65                 oss << lastnotify;
  66                 for (std::set<User*>::const_iterator i = accepting.begin(); i != accepting.end(); ++i)
  67                 {
  68                         User* u = *i;
  69                         // Encode UIDs.
  70                         oss << "," << (format == FORMAT_USER ? u->nick : u->uuid);
  71                 }
  72                 return oss.str();
  73         }
  74 };
  75
  76 struct CallerIDExtInfo : public ExtensionItem
  77 {
  78         CallerIDExtInfo(Module* parent)
  79                 : ExtensionItem("callerid_data", parent)
  80         {
  81         }
  82
  83         std::string serialize(SerializeFormat format, const Extensible* container, void* item) const
  84         {
  85                 callerid_data* dat = static_cast<callerid_data*>(item);
  86                 return dat->ToString(format);
  87         }
  88
  89         void unserialize(SerializeFormat format, Extensible* container, const std::string& value)
  90         {
  91                 callerid_data* dat = new callerid_data(value);
  92                 set_raw(container, dat);
  93         }
  94
  95         callerid_data* get(User* user, bool create)
  96         {
  97                 callerid_data* dat = static_cast<callerid_data*>(get_raw(user));
  98                 if (create && !dat)
  99                 {
 100                         dat = new callerid_data;
 101                         set_raw(user, dat);
 102                 }
 103                 return dat;
 104         }
 105
 106         void free(void* item)
 107         {
 108                 callerid_data* dat = static_cast<callerid_data*>(item);
 109
 110                 // We need to walk the list of users on our accept list, and remove ourselves from their wholistsme.
 111                 for (std::set<User *>::iterator it = dat->accepting.begin(); it != dat->accepting.end(); it++)
 112                 {
 113                         callerid_data *targ = this->get(*it, false);
 114
 115                         if (!targ)
 116                                 continue; // shouldn't happen, but oh well.
 117
 118                         std::list<callerid_data*>::iterator it2 = std::find(targ->wholistsme.begin(), targ->wholistsme.end(), dat);
 119                         if (it2 != targ->wholistsme.end())
 120                                 targ->wholistsme.erase(it2);
 121                 }
 122                 delete dat;
 123         }
 124 };
 125
 126 class User_g : public SimpleUserModeHandler
 127 {
 128 public:
 129         User_g(Module* Creator) : SimpleUserModeHandler(Creator, "callerid", 'g') { }
 130 };
 131
 132 class CommandAccept : public Command
 133 {
 134 public:
 135         CallerIDExtInfo extInfo;
 136         unsigned int maxaccepts;
 137         CommandAccept(Module* Creator) : Command(Creator, "ACCEPT", 1),
 138                 extInfo(Creator)
 139         {
 140                 allow_empty_last_param = false;
 141                 syntax = "{[+|-]<nicks>}|*}";
 142                 TRANSLATE2(TR_CUSTOM, TR_END);
 143         }
 144
 145         virtual void EncodeParameter(std::string& parameter, int index)
 146         {
 147                 if (index != 0)
 148                         return;
 149                 std::string out;
 150                 irc::commasepstream nicks(parameter);
 151                 std::string tok;
 152                 while (nicks.GetToken(tok))
 153                 {
 154                         if (tok == "*")
 155                         {
 156                                 continue; // Drop list requests, since remote servers ignore them anyway.
 157                         }
 158                         if (!out.empty())
 159                                 out.append(",");
 160                         bool dash = false;
 161                         if (tok[0] == '-')
 162                         {
 163                                 dash = true;
 164                                 tok.erase(0, 1); // Remove the dash.
 165                         }
 166                         User* u = ServerInstance->FindNick(tok);
 167                         if ((!u) || (u->registered != REG_ALL) || (u->quitting) || (IS_SERVER(u)))
 168                                 continue;
 169
 170                         if (dash)
 171                                 out.append("-");
 172                         out.append(u->uuid);
 173                 }
 174                 parameter = out;
 175         }
 176
 177         /** Will take any number of nicks (up to MaxTargets), which can be seperated by commas.
 178          * - in front of any nick removes, and an * lists. This effectively means you can do:
 179          * /accept nick1,nick2,nick3,*
 180          * to add 3 nicks and then show your list
 181          */
 182         CmdResult Handle(const std::vector<std::string> &parameters, User* user)
 183         {
 184                 if (ServerInstance->Parser->LoopCall(user, this, parameters, 0))
 185                         return CMD_SUCCESS;
 186                 /* Even if callerid mode is not set, we let them manage their ACCEPT list so that if they go +g they can
 187                  * have a list already setup. */
 188
 189                 std::string tok = parameters[0];
 190
 191                 if (tok == "*")
 192                 {
 193                         if (IS_LOCAL(user))
 194                                 ListAccept(user);
 195                         return CMD_SUCCESS;
 196                 }
 197                 else if (tok[0] == '-')
 198                 {
 199                         User* whotoremove = ServerInstance->FindNick(tok.substr(1));
 200                         if (whotoremove)
 201                                 return (RemoveAccept(user, whotoremove) ? CMD_SUCCESS : CMD_FAILURE);
 202                         else
 203                                 return CMD_FAILURE;
 204                 }
 205                 else
 206                 {
 207                         User* whotoadd = ServerInstance->FindNick(tok[0] == '+' ? tok.substr(1) : tok);
 208                         if ((whotoadd) && (whotoadd->registered == REG_ALL) && (!whotoadd->quitting) && (!IS_SERVER(whotoadd)))
 209                                 return (AddAccept(user, whotoadd) ? CMD_SUCCESS : CMD_FAILURE);
 210                         else
 211                         {
 212                                 user->WriteNumeric(401, "%s %s :No such nick/channel", user->nick.c_str(), tok.c_str());
 213                                 return CMD_FAILURE;
 214                         }
 215                 }
 216         }
 217
 218         RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
 219         {
 220                 return ROUTE_BROADCAST;
 221         }
 222
 223         void ListAccept(User* user)
 224         {
 225                 callerid_data* dat = extInfo.get(user, false);
 226                 if (dat)
 227                 {
 228                         for (std::set<User*>::iterator i = dat->accepting.begin(); i != dat->accepting.end(); ++i)
 229                                 user->WriteNumeric(281, "%s %s", user->nick.c_str(), (*i)->nick.c_str());
 230                 }
 231                 user->WriteNumeric(282, "%s :End of ACCEPT list", user->nick.c_str());
 232         }
 233
 234         bool AddAccept(User* user, User* whotoadd)
 235         {
 236                 // Add this user to my accept list first, so look me up..
 237                 callerid_data* dat = extInfo.get(user, true);
 238                 if (dat->accepting.size() >= maxaccepts)
 239                 {
 240                         user->WriteNumeric(456, "%s :Accept list is full (limit is %d)", user->nick.c_str(), maxaccepts);
 241                         return false;
 242                 }
 243                 if (!dat->accepting.insert(whotoadd).second)
 244                 {
 245                         user->WriteNumeric(457, "%s %s :is already on your accept list", user->nick.c_str(), whotoadd->nick.c_str());
 246                         return false;
 247                 }
 248
 249                 // Now, look them up, and add me to their list
 250                 callerid_data *targ = extInfo.get(whotoadd, true);
 251                 targ->wholistsme.push_back(dat);
 252
 253                 user->WriteServ("NOTICE %s :%s is now on your accept list", user->nick.c_str(), whotoadd->nick.c_str());
 254                 return true;
 255         }
 256
 257         bool RemoveAccept(User* user, User* whotoremove)
 258         {
 259                 // Remove them from my list, so look up my list..
 260                 callerid_data* dat = extInfo.get(user, false);
 261                 if (!dat)
 262                 {
 263                         user->WriteNumeric(458, "%s %s :is not on your accept list", user->nick.c_str(), whotoremove->nick.c_str());
 264                         return false;
 265                 }
 266                 std::set<User*>::iterator i = dat->accepting.find(whotoremove);
 267                 if (i == dat->accepting.end())
 268                 {
 269                         user->WriteNumeric(458, "%s %s :is not on your accept list", user->nick.c_str(), whotoremove->nick.c_str());
 270                         return false;
 271                 }
 272
 273                 dat->accepting.erase(i);
 274
 275                 // Look up their list to remove me.
 276                 callerid_data *dat2 = extInfo.get(whotoremove, false);
 277                 if (!dat2)
 278                 {
 279                         // How the fuck is this possible.
 280                         return false;
 281                 }
 282
 283                 std::list<callerid_data*>::iterator it = std::find(dat2->wholistsme.begin(), dat2->wholistsme.end(), dat);
 284                 if (it != dat2->wholistsme.end())
 285                         // Found me!
 286                         dat2->wholistsme.erase(it);
 287
 288                 user->WriteServ("NOTICE %s :%s is no longer on your accept list", user->nick.c_str(), whotoremove->nick.c_str());
 289                 return true;
 290         }
 291 };
 292
 293 class ModuleCallerID : public Module
 294 {
 295         CommandAccept cmd;
 296         User_g myumode;
 297
 298         // Configuration variables:
 299         bool operoverride; // Operators can override callerid.
 300         bool tracknick; // Allow ACCEPT entries to update with nick changes.
 301         unsigned int notify_cooldown; // Seconds between notifications.
 302
 303         /** Removes a user from all accept lists
 304          * @param who The user to remove from accepts
 305          */
 306         void RemoveFromAllAccepts(User* who)
 307         {
 308                 // First, find the list of people who have me on accept
 309                 callerid_data *userdata = cmd.extInfo.get(who, false);
 310                 if (!userdata)
 311                         return;
 312
 313                 // Iterate over the list of people who accept me, and remove all entries
 314                 for (std::list<callerid_data *>::iterator it = userdata->wholistsme.begin(); it != userdata->wholistsme.end(); it++)
 315                 {
 316                         callerid_data *dat = *(it);
 317
 318                         // Find me on their callerid list
 319                         std::set<User *>::iterator it2 = dat->accepting.find(who);
 320
 321                         if (it2 != dat->accepting.end())
 322                                 dat->accepting.erase(it2);
 323                 }
 324
 325                 userdata->wholistsme.clear();
 326         }
 327
 328 public:
 329         ModuleCallerID() : cmd(this), myumode(this)
 330         {
 331         }
 332
 333         void init()
 334         {
 335                 OnRehash(NULL);
 336
 337                 ServerInstance->Modules->AddService(myumode);
 338                 ServerInstance->Modules->AddService(cmd);
 339                 ServerInstance->Modules->AddService(cmd.extInfo);
 340
 341                 Implementation eventlist[] = { I_OnRehash, I_OnUserPostNick, I_OnUserQuit, I_On005Numeric, I_OnUserPreNotice, I_OnUserPreMessage };
 342                 ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
 343         }
 344
 345         virtual Version GetVersion()
 346         {
 347                 return Version("Implementation of callerid, usermode +g, /accept", VF_COMMON | VF_VENDOR);
 348         }
 349
 350         virtual void On005Numeric(std::map<std::string, std::string>& tokens)
 351         {
 352                 tokens["CALLERID"] = "g";
 353         }
 354
 355         ModResult PreText(User* user, User* dest, std::string& text)
 356         {
 357                 if (!dest->IsModeSet('g'))
 358                         return MOD_RES_PASSTHRU;
 359
 360                 if (operoverride && user->IsOper())
 361                         return MOD_RES_PASSTHRU;
 362
 363                 callerid_data* dat = cmd.extInfo.get(dest, true);
 364                 std::set<User*>::iterator i = dat->accepting.find(user);
 365
 366                 if (i == dat->accepting.end())
 367                 {
 368                         time_t now = ServerInstance->Time();
 369                         /* +g and *not* accepted */
 370                         user->WriteNumeric(716, "%s %s :is in +g mode (server-side ignore).", user->nick.c_str(), dest->nick.c_str());
 371                         if (now > (dat->lastnotify + (time_t)notify_cooldown))
 372                         {
 373                                 user->WriteNumeric(717, "%s %s :has been informed that you messaged them.", user->nick.c_str(), dest->nick.c_str());
 374                                 dest->SendText(":%s 718 %s %s %s@%s :is messaging you, and you have umode +g. Use /ACCEPT +%s to allow.",
 375                                         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());
 376                                 dat->lastnotify = now;
 377                         }
 378                         return MOD_RES_DENY;
 379                 }
 380                 return MOD_RES_PASSTHRU;
 381         }
 382
 383         virtual ModResult OnUserPreMessage(User* user, void* dest, int target_type, std::string& text, char status, CUList &exempt_list)
 384         {
 385                 if (IS_LOCAL(user) && target_type == TYPE_USER)
 386                         return PreText(user, (User*)dest, text);
 387
 388                 return MOD_RES_PASSTHRU;
 389         }
 390
 391         virtual ModResult OnUserPreNotice(User* user, void* dest, int target_type, std::string& text, char status, CUList &exempt_list)
 392         {
 393                 if (IS_LOCAL(user) && target_type == TYPE_USER)
 394                         return PreText(user, (User*)dest, text);
 395
 396                 return MOD_RES_PASSTHRU;
 397         }
 398
 399         void OnUserPostNick(User* user, const std::string& oldnick)
 400         {
 401                 if (!tracknick)
 402                         RemoveFromAllAccepts(user);
 403         }
 404
 405         void OnUserQuit(User* user, const std::string& message, const std::string& oper_message)
 406         {
 407                 RemoveFromAllAccepts(user);
 408         }
 409
 410         virtual void OnRehash(User* user)
 411         {
 412                 ConfigTag* tag = ServerInstance->Config->ConfValue("callerid");
 413                 cmd.maxaccepts = tag->getInt("maxaccepts", 16);
 414                 operoverride = tag->getBool("operoverride");
 415                 tracknick = tag->getBool("tracknick");
 416                 notify_cooldown = tag->getInt("cooldown", 60);
 417         }
 418 };
 419
 420 MODULE_INIT(ModuleCallerID)