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 enum
  26 {
  27         RPL_ACCEPTLIST = 281,
  28         RPL_ENDOFACCEPT = 282,
  29         ERR_ACCEPTFULL = 456,
  30         ERR_ACCEPTEXIST = 457,
  31         ERR_ACCEPTNOT = 458,
  32         ERR_TARGUMODEG = 716,
  33         RPL_TARGNOTIFY = 717,
  34         RPL_UMODEGMSG = 718
  35 };
  36
  37 class callerid_data
  38 {
  39  public:
  40         typedef insp::flat_set<User*> UserSet;
  41         typedef std::vector<callerid_data*> CallerIdDataSet;
  42
  43         time_t lastnotify;
  44
  45         /** Users I accept messages from
  46          */
  47         UserSet accepting;
  48
  49         /** Users who list me as accepted
  50          */
  51         CallerIdDataSet wholistsme;
  52
  53         callerid_data() : lastnotify(0) { }
  54
  55         std::string ToString(SerializeFormat format) const
  56         {
  57                 std::ostringstream oss;
  58                 oss << lastnotify;
  59                 for (UserSet::const_iterator i = accepting.begin(); i != accepting.end(); ++i)
  60                 {
  61                         User* u = *i;
  62                         // Encode UIDs.
  63                         oss << "," << (format == FORMAT_USER ? u->nick : u->uuid);
  64                 }
  65                 return oss.str();
  66         }
  67 };
  68
  69 struct CallerIDExtInfo : public ExtensionItem
  70 {
  71         CallerIDExtInfo(Module* parent)
  72                 : ExtensionItem("callerid_data", ExtensionItem::EXT_USER, parent)
  73         {
  74         }
  75
  76         std::string serialize(SerializeFormat format, const Extensible* container, void* item) const
  77         {
  78                 std::string ret;
  79                 if (format != FORMAT_NETWORK)
  80                 {
  81                         callerid_data* dat = static_cast<callerid_data*>(item);
  82                         ret = dat->ToString(format);
  83                 }
  84                 return ret;
  85         }
  86
  87         void unserialize(SerializeFormat format, Extensible* container, const std::string& value)
  88         {
  89                 if (format == FORMAT_NETWORK)
  90                         return;
  91
  92                 void* old = get_raw(container);
  93                 if (old)
  94                         this->free(old);
  95                 callerid_data* dat = new callerid_data;
  96                 set_raw(container, dat);
  97
  98                 irc::commasepstream s(value);
  99                 std::string tok;
 100                 if (s.GetToken(tok))
 101                         dat->lastnotify = ConvToInt(tok);
 102
 103                 while (s.GetToken(tok))
 104                 {
 105                         User *u = ServerInstance->FindNick(tok);
 106                         if ((u) && (u->registered == REG_ALL) && (!u->quitting))
 107                         {
 108                                 if (dat->accepting.insert(u).second)
 109                                 {
 110                                         callerid_data* other = this->get(u, true);
 111                                         other->wholistsme.push_back(dat);
 112                                 }
 113                         }
 114                 }
 115         }
 116
 117         callerid_data* get(User* user, bool create)
 118         {
 119                 callerid_data* dat = static_cast<callerid_data*>(get_raw(user));
 120                 if (create && !dat)
 121                 {
 122                         dat = new callerid_data;
 123                         set_raw(user, dat);
 124                 }
 125                 return dat;
 126         }
 127
 128         void free(void* item)
 129         {
 130                 callerid_data* dat = static_cast<callerid_data*>(item);
 131
 132                 // We need to walk the list of users on our accept list, and remove ourselves from their wholistsme.
 133                 for (callerid_data::UserSet::iterator it = dat->accepting.begin(); it != dat->accepting.end(); ++it)
 134                 {
 135                         callerid_data *targ = this->get(*it, false);
 136
 137                         if (!targ)
 138                         {
 139                                 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "ERROR: Inconsistency detected in callerid state, please report (1)");
 140                                 continue; // shouldn't happen, but oh well.
 141                         }
 142
 143                         if (!stdalgo::vector::swaperase(targ->wholistsme, dat))
 144                                 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "ERROR: Inconsistency detected in callerid state, please report (2)");
 145                 }
 146                 delete dat;
 147         }
 148 };
 149
 150 class User_g : public SimpleUserModeHandler
 151 {
 152 public:
 153         User_g(Module* Creator) : SimpleUserModeHandler(Creator, "callerid", 'g') { }
 154 };
 155
 156 class CommandAccept : public Command
 157 {
 158         /** Pair: first is the target, second is true to add, false to remove
 159          */
 160         typedef std::pair<User*, bool> ACCEPTAction;
 161
 162         static ACCEPTAction GetTargetAndAction(std::string& tok, User* cmdfrom = NULL)
 163         {
 164                 bool remove = (tok[0] == '-');
 165                 if ((remove) || (tok[0] == '+'))
 166                         tok.erase(tok.begin());
 167
 168                 User* target;
 169                 if (!cmdfrom || !IS_LOCAL(cmdfrom))
 170                         target = ServerInstance->FindNick(tok);
 171                 else
 172                         target = ServerInstance->FindNickOnly(tok);
 173
 174                 if ((!target) || (target->registered != REG_ALL) || (target->quitting))
 175                         target = NULL;
 176
 177                 return std::make_pair(target, !remove);
 178         }
 179
 180 public:
 181         CallerIDExtInfo extInfo;
 182         unsigned int maxaccepts;
 183         CommandAccept(Module* Creator) : Command(Creator, "ACCEPT", 1),
 184                 extInfo(Creator)
 185         {
 186                 allow_empty_last_param = false;
 187                 syntax = "*|(+|-)<nick>[,(+|-)<nick> ...]";
 188                 TRANSLATE1(TR_CUSTOM);
 189         }
 190
 191         void EncodeParameter(std::string& parameter, int index)
 192         {
 193                 // Send lists as-is (part of 2.0 compat)
 194                 if (parameter.find(',') != std::string::npos)
 195                         return;
 196
 197                 // Convert a [+|-]<nick> into a [-]<uuid>
 198                 ACCEPTAction action = GetTargetAndAction(parameter);
 199                 if (!action.first)
 200                         return;
 201
 202                 parameter = (action.second ? "" : "-") + action.first->uuid;
 203         }
 204
 205         /** Will take any number of nicks (up to MaxTargets), which can be seperated by commas.
 206          * - in front of any nick removes, and an * lists. This effectively means you can do:
 207          * /accept nick1,nick2,nick3,*
 208          * to add 3 nicks and then show your list
 209          */
 210         CmdResult Handle(const std::vector<std::string> &parameters, User* user)
 211         {
 212                 if (CommandParser::LoopCall(user, this, parameters, 0))
 213                         return CMD_SUCCESS;
 214
 215                 /* Even if callerid mode is not set, we let them manage their ACCEPT list so that if they go +g they can
 216                  * have a list already setup. */
 217
 218                 if (parameters[0] == "*")
 219                 {
 220                         ListAccept(user);
 221                         return CMD_SUCCESS;
 222                 }
 223
 224                 std::string tok = parameters[0];
 225                 ACCEPTAction action = GetTargetAndAction(tok, user);
 226                 if (!action.first)
 227                 {
 228                         user->WriteNumeric(Numerics::NoSuchNick(tok));
 229                         return CMD_FAILURE;
 230                 }
 231
 232                 if ((!IS_LOCAL(user)) && (!IS_LOCAL(action.first)))
 233                         // Neither source nor target is local, forward the command to the server of target
 234                         return CMD_SUCCESS;
 235
 236                 // The second item in the pair is true if the first char is a '+' (or nothing), false if it's a '-'
 237                 if (action.second)
 238                         return (AddAccept(user, action.first) ? CMD_SUCCESS : CMD_FAILURE);
 239                 else
 240                         return (RemoveAccept(user, action.first) ? CMD_SUCCESS : CMD_FAILURE);
 241         }
 242
 243         RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
 244         {
 245                 // There is a list in parameters[0] in two cases:
 246                 // Either when the source is remote, this happens because 2.0 servers send comma seperated uuid lists,
 247                 // we don't split those but broadcast them, as before.
 248                 //
 249                 // Or if the source is local then LoopCall() runs OnPostCommand() after each entry in the list,
 250                 // meaning the linking module has sent an ACCEPT already for each entry in the list to the
 251                 // appropiate server and the ACCEPT with the list of nicks (this) doesn't need to be sent anywhere.
 252                 if ((!IS_LOCAL(user)) && (parameters[0].find(',') != std::string::npos))
 253                         return ROUTE_BROADCAST;
 254
 255                 // Find the target
 256                 std::string targetstring = parameters[0];
 257                 ACCEPTAction action = GetTargetAndAction(targetstring, user);
 258                 if (!action.first)
 259                         // Target is a "*" or source is local and the target is a list of nicks
 260                         return ROUTE_LOCALONLY;
 261
 262                 // Route to the server of the target
 263                 return ROUTE_UNICAST(action.first->server);
 264         }
 265
 266         void ListAccept(User* user)
 267         {
 268                 callerid_data* dat = extInfo.get(user, false);
 269                 if (dat)
 270                 {
 271                         for (callerid_data::UserSet::iterator i = dat->accepting.begin(); i != dat->accepting.end(); ++i)
 272                                 user->WriteNumeric(RPL_ACCEPTLIST, (*i)->nick);
 273                 }
 274                 user->WriteNumeric(RPL_ENDOFACCEPT, "End of ACCEPT list");
 275         }
 276
 277         bool AddAccept(User* user, User* whotoadd)
 278         {
 279                 // Add this user to my accept list first, so look me up..
 280                 callerid_data* dat = extInfo.get(user, true);
 281                 if (dat->accepting.size() >= maxaccepts)
 282                 {
 283                         user->WriteNumeric(ERR_ACCEPTFULL, InspIRCd::Format("Accept list is full (limit is %d)", maxaccepts));
 284                         return false;
 285                 }
 286                 if (!dat->accepting.insert(whotoadd).second)
 287                 {
 288                         user->WriteNumeric(ERR_ACCEPTEXIST, whotoadd->nick, "is already on your accept list");
 289                         return false;
 290                 }
 291
 292                 // Now, look them up, and add me to their list
 293                 callerid_data *targ = extInfo.get(whotoadd, true);
 294                 targ->wholistsme.push_back(dat);
 295
 296                 user->WriteNotice(whotoadd->nick + " is now on your accept list");
 297                 return true;
 298         }
 299
 300         bool RemoveAccept(User* user, User* whotoremove)
 301         {
 302                 // Remove them from my list, so look up my list..
 303                 callerid_data* dat = extInfo.get(user, false);
 304                 if (!dat)
 305                 {
 306                         user->WriteNumeric(ERR_ACCEPTNOT, whotoremove->nick, "is not on your accept list");
 307                         return false;
 308                 }
 309                 if (!dat->accepting.erase(whotoremove))
 310                 {
 311                         user->WriteNumeric(ERR_ACCEPTNOT, whotoremove->nick, "is not on your accept list");
 312                         return false;
 313                 }
 314
 315                 // Look up their list to remove me.
 316                 callerid_data *dat2 = extInfo.get(whotoremove, false);
 317                 if (!dat2)
 318                 {
 319                         // How the fuck is this possible.
 320                         ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "ERROR: Inconsistency detected in callerid state, please report (3)");
 321                         return false;
 322                 }
 323
 324                 if (!stdalgo::vector::swaperase(dat2->wholistsme, dat))
 325                         ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "ERROR: Inconsistency detected in callerid state, please report (4)");
 326
 327
 328                 user->WriteNotice(whotoremove->nick + " is no longer on your accept list");
 329                 return true;
 330         }
 331 };
 332
 333 class ModuleCallerID : public Module
 334 {
 335         CommandAccept cmd;
 336         User_g myumode;
 337
 338         // Configuration variables:
 339         bool operoverride; // Operators can override callerid.
 340         bool tracknick; // Allow ACCEPT entries to update with nick changes.
 341         unsigned int notify_cooldown; // Seconds between notifications.
 342
 343         /** Removes a user from all accept lists
 344          * @param who The user to remove from accepts
 345          */
 346         void RemoveFromAllAccepts(User* who)
 347         {
 348                 // First, find the list of people who have me on accept
 349                 callerid_data *userdata = cmd.extInfo.get(who, false);
 350                 if (!userdata)
 351                         return;
 352
 353                 // Iterate over the list of people who accept me, and remove all entries
 354                 for (callerid_data::CallerIdDataSet::iterator it = userdata->wholistsme.begin(); it != userdata->wholistsme.end(); ++it)
 355                 {
 356                         callerid_data *dat = *(it);
 357
 358                         // Find me on their callerid list
 359                         if (!dat->accepting.erase(who))
 360                                 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "ERROR: Inconsistency detected in callerid state, please report (5)");
 361                 }
 362
 363                 userdata->wholistsme.clear();
 364         }
 365
 366 public:
 367         ModuleCallerID() : cmd(this), myumode(this)
 368         {
 369         }
 370
 371         Version GetVersion() CXX11_OVERRIDE
 372         {
 373                 return Version("Implementation of callerid, usermode +g, /accept", VF_COMMON | VF_VENDOR);
 374         }
 375
 376         void On005Numeric(std::map<std::string, std::string>& tokens) CXX11_OVERRIDE
 377         {
 378                 tokens["CALLERID"] = "g";
 379         }
 380
 381         ModResult OnUserPreMessage(User* user, void* voiddest, int target_type, std::string& text, char status, CUList& exempt_list, MessageType msgtype) CXX11_OVERRIDE
 382         {
 383                 if (!IS_LOCAL(user) || target_type != TYPE_USER)
 384                         return MOD_RES_PASSTHRU;
 385
 386                 User* dest = static_cast<User*>(voiddest);
 387                 if (!dest->IsModeSet(myumode) || (user == dest))
 388                         return MOD_RES_PASSTHRU;
 389
 390                 if (operoverride && user->IsOper())
 391                         return MOD_RES_PASSTHRU;
 392
 393                 callerid_data* dat = cmd.extInfo.get(dest, true);
 394                 if (!dat->accepting.count(user))
 395                 {
 396                         time_t now = ServerInstance->Time();
 397                         /* +g and *not* accepted */
 398                         user->WriteNumeric(ERR_TARGUMODEG, dest->nick, "is in +g mode (server-side ignore).");
 399                         if (now > (dat->lastnotify + (time_t)notify_cooldown))
 400                         {
 401                                 user->WriteNumeric(RPL_TARGNOTIFY, dest->nick, "has been informed that you messaged them.");
 402                                 dest->WriteRemoteNumeric(RPL_UMODEGMSG, user->nick, InspIRCd::Format("%s@%s", user->ident.c_str(), user->dhost.c_str()), InspIRCd::Format("is messaging you, and you have umode +g. Use /ACCEPT +%s to allow.",
 403                                                 user->nick.c_str()));
 404                                 dat->lastnotify = now;
 405                         }
 406                         return MOD_RES_DENY;
 407                 }
 408                 return MOD_RES_PASSTHRU;
 409         }
 410
 411         void OnUserPostNick(User* user, const std::string& oldnick) CXX11_OVERRIDE
 412         {
 413                 if (!tracknick)
 414                         RemoveFromAllAccepts(user);
 415         }
 416
 417         void OnUserQuit(User* user, const std::string& message, const std::string& oper_message) CXX11_OVERRIDE
 418         {
 419                 RemoveFromAllAccepts(user);
 420         }
 421
 422         void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
 423         {
 424                 ConfigTag* tag = ServerInstance->Config->ConfValue("callerid");
 425                 cmd.maxaccepts = tag->getInt("maxaccepts", 16);
 426                 operoverride = tag->getBool("operoverride");
 427                 tracknick = tag->getBool("tracknick");
 428                 notify_cooldown = tag->getInt("cooldown", 60);
 429         }
 430
 431         void Prioritize() CXX11_OVERRIDE
 432         {
 433                 // Want to be after modules like silence or services_account
 434                 ServerInstance->Modules->SetPriority(this, I_OnUserPreMessage, PRIORITY_LAST);
 435         }
 436 };
 437
 438 MODULE_INIT(ModuleCallerID)