src/modules/m_callerid.cpp

   1 #include "inspircd.h"
   2 #include "users.h"
   3 #include "channels.h"
   4 #include "modules.h"
   5
   6 #include <set>
   7
   8 #include <sstream>
   9
  10 #include <algorithm>
  11
  12 /* $ModDesc: Implementation of callerid (umode +g & /accept, ala hybrid etc) */
  13
  14 class callerid_data : public classbase
  15 {
  16  public:
  17         time_t lastnotify;
  18         std::set<User*> accepting;
  19
  20         callerid_data() : lastnotify(0) { }
  21         callerid_data(const std::string& str, InspIRCd* ServerInstance)
  22         {
  23                 irc::commasepstream s(str);
  24                 std::string tok;
  25                 if (s.GetToken(tok))
  26                 {
  27                         lastnotify = ConvToInt(tok);
  28                 }
  29                 while (s.GetToken(tok))
  30                 {
  31                         if (tok.empty())
  32                         {
  33                                 continue;
  34                         }
  35                         User* u = ServerInstance->FindUUID(tok);
  36                         if (!u)
  37                         {
  38                                 u = ServerInstance->FindNick(tok);
  39                         }
  40                         if (!u)
  41                         {
  42                                 continue;
  43                         }
  44                         accepting.insert(u);
  45                 }
  46         }
  47
  48         std::string ToString(bool displayable) const
  49         {
  50                 std::ostringstream oss;
  51                 oss << lastnotify;
  52                 for (std::set<User*>::iterator i = accepting.begin(); i != accepting.end(); ++i)
  53                 {
  54                         // Encode UIDs.
  55                         oss << "," << (displayable ? (*i)->nick : (*i)->uuid);
  56                 }
  57                 oss << std::ends;
  58                 return oss.str();
  59         }
  60 };
  61
  62 callerid_data* GetData(User* who, bool extend = true)
  63 {
  64         callerid_data* dat;
  65         if (who->GetExt("callerid_data", dat))
  66                 return dat;
  67         else
  68         {
  69                 if (extend)
  70                 {
  71                         dat = new callerid_data;
  72                         who->Extend("callerid_data", dat);
  73                         return dat;
  74                 }
  75                 else
  76                         return NULL;
  77         }
  78 }
  79
  80 void RemoveData(User* who)
  81 {
  82         callerid_data* dat;
  83         who->GetExt("callerid_data", dat);
  84
  85         if (!dat)
  86                 return;
  87
  88         who->Shrink("callerid_data");
  89         delete dat;
  90 }
  91
  92 void RemoveFromAllAccepts(InspIRCd* ServerInstance, User* who)
  93 {
  94         for (user_hash::iterator i = ServerInstance->Users->clientlist->begin(); i != ServerInstance->Users->clientlist->end(); ++i)
  95         {
  96                 callerid_data* dat = GetData(i->second, false);
  97
  98                 if (!dat)
  99                         continue;
 100
 101                 std::set<User*>::iterator iter = dat->accepting.find(who);
 102
 103                 if (iter == dat->accepting.end())
 104                         continue;
 105
 106                 dat->accepting.erase(iter);
 107         }
 108 }
 109
 110 class User_g : public SimpleUserModeHandler
 111 {
 112 public:
 113         User_g(InspIRCd* Instance) : SimpleUserModeHandler(Instance, 'g') { }
 114 };
 115
 116 class CommandAccept : public Command
 117 {
 118 private:
 119         unsigned int& maxaccepts;
 120 public:
 121         CommandAccept(InspIRCd* Instance, unsigned int& max) : Command(Instance, "ACCEPT", 0, 1), maxaccepts(max)
 122         {
 123                 source = "m_callerid.so";
 124                 syntax = "{[+|-]<nicks>}|*}";
 125                 TRANSLATE2(TR_CUSTOM, TR_END);
 126         }
 127
 128         virtual void EncodeParameter(std::string& parameter, int index)
 129         {
 130                 if (index != 0)
 131                         return;
 132                 std::string out = "";
 133                 irc::commasepstream nicks(parameter);
 134                 std::string tok;
 135                 while (nicks.GetToken(tok))
 136                 {
 137                         if (tok == "*")
 138                         {
 139                                 continue; // Drop list requests, since remote servers ignore them anyway.
 140                         }
 141                         if (!out.empty())
 142                                 out.append(",");
 143                         bool dash = false;
 144                         if (tok[0] == '-')
 145                         {
 146                                 dash = true;
 147                                 tok.erase(0, 1); // Remove the dash.
 148                         }
 149                         User* u = ServerInstance->FindNick(tok);
 150                         if (u)
 151                         {
 152                                 if (dash)
 153                                         out.append("-");
 154                                 out.append(u->uuid);
 155                         }
 156                         else
 157                         {
 158                                 if (dash)
 159                                         out.append("-");
 160                                 out.append(tok);
 161                         }
 162                 }
 163                 parameter = out;
 164         }
 165
 166         /** Will take any number of nicks (up to MaxTargets), which can be seperated by commas.
 167          * - in front of any nick removes, and an * lists. This effectively means you can do:
 168          * /accept nick1,nick2,nick3,*
 169          * to add 3 nicks and then show your list
 170          */
 171         CmdResult Handle(const std::vector<std::string> &parameters, User* user)
 172         {
 173                 if (ServerInstance->Parser->LoopCall(user, this, parameters, 0))
 174                         return CMD_SUCCESS;
 175                 /* Even if callerid mode is not set, we let them manage their ACCEPT list so that if they go +g they can
 176                  * have a list already setup. */
 177                 bool atleastonechange = false;
 178
 179                 if (tok == "*")
 180                 {
 181                         if (IS_LOCAL(user))
 182                                 ListAccept(user);
 183                         return CMD_LOCALONLY;
 184                 }
 185                 else if (tok[0] == '-')
 186                 {
 187                         User* whotoremove = ServerInstance->FindNick(tok.substr(1));
 188                         if (whotoremove)
 189                                 return (RemoveAccept(user, whotoremove, false) ? CMD_SUCCESS : CMD_FAILURE);
 190                 }
 191                 else
 192                 {
 193                         User* whotoadd = ServerInstance->FindNick(tok[0] == '+' ? tok.substr(1) : tok);
 194                         if (whotoadd)
 195                                 return (AddAccept(user, whotoadd, false) ? CMD_SUCCESS : CMD_FAILURE);
 196                         else
 197                         {
 198                                 user->WriteNumeric(401, "%s %s :No such nick/channel", user->nick.c_str(), tok.c_str());
 199                                 return CMD_FAILURE;
 200                         }
 201                 }
 202         }
 203
 204         void ListAccept(User* user)
 205         {
 206                 callerid_data* dat = GetData(user, false);
 207                 if (dat)
 208                 {
 209                         for (std::set<User*>::iterator i = dat->accepting.begin(); i != dat->accepting.end(); ++i)
 210                                 user->WriteNumeric(281, "%s %s", user->nick.c_str(), (*i)->nick.c_str());
 211                 }
 212                 user->WriteNumeric(282, "%s :End of ACCEPT list", user->nick.c_str());
 213         }
 214
 215         bool AddAccept(User* user, User* whotoadd, bool quiet)
 216         {
 217                 callerid_data* dat = GetData(user, true);
 218                 if (dat->accepting.size() >= maxaccepts)
 219                 {
 220                         if (!quiet)
 221                                 user->WriteNumeric(456, "%s :Accept list is full (limit is %d)", user->nick.c_str(), maxaccepts);
 222
 223                         return false;
 224                 }
 225                 if (!dat->accepting.insert(whotoadd).second)
 226                 {
 227                         if (!quiet)
 228                                 user->WriteNumeric(457, "%s %s :is already on your accept list", user->nick.c_str(), whotoadd->nick.c_str());
 229
 230                         return false;
 231                 }
 232                 return true;
 233         }
 234
 235         bool RemoveAccept(User* user, User* whotoremove, bool quiet)
 236         {
 237                 callerid_data* dat = GetData(user, false);
 238                 if (!dat)
 239                 {
 240                         if (!quiet)
 241                                 user->WriteNumeric(458, "%s %s :is not on your accept list", user->nick.c_str(), whotoremove->nick.c_str());
 242
 243                         return false;
 244                 }
 245                 std::set<User*>::iterator i = dat->accepting.find(whotoremove);
 246                 if (i == dat->accepting.end())
 247                 {
 248                         if (!quiet)
 249                                 user->WriteNumeric(458, "%s %s :is not on your accept list", user->nick.c_str(), whotoremove->nick.c_str());
 250
 251                         return false;
 252                 }
 253                 dat->accepting.erase(i);
 254                 return true;
 255         }
 256 };
 257
 258 class ModuleCallerID : public Module
 259 {
 260 private:
 261         CommandAccept *mycommand;
 262         User_g* myumode;
 263
 264         // Configuration variables:
 265         unsigned int maxaccepts; // Maximum ACCEPT entries.
 266         bool operoverride; // Operators can override callerid.
 267         bool tracknick; // Allow ACCEPT entries to update with nick changes.
 268         unsigned int notify_cooldown; // Seconds between notifications.
 269
 270 public:
 271         ModuleCallerID(InspIRCd* Me) : Module(Me)
 272         {
 273                 OnRehash(NULL, "");
 274                 mycommand = new CommandAccept(ServerInstance, maxaccepts);
 275                 myumode = new User_g(ServerInstance);
 276
 277                 if (!ServerInstance->Modes->AddMode(myumode))
 278                 {
 279                         delete mycommand;
 280                         delete myumode;
 281                         throw ModuleException("Could not add usermode +g");
 282                 }
 283                 try
 284                 {
 285                         ServerInstance->AddCommand(mycommand);
 286                 }
 287                 catch (const ModuleException& e)
 288                 {
 289                         delete mycommand;
 290                         delete myumode;
 291                         throw ModuleException("Could not add command!");
 292                 }
 293
 294                 Implementation eventlist[] = { I_OnRehash, I_OnUserPreNick, I_OnUserQuit, I_On005Numeric, I_OnUserPreNotice, I_OnUserPreMessage, I_OnCleanup };
 295                 ServerInstance->Modules->Attach(eventlist, this, 7);
 296         }
 297
 298         virtual ~ModuleCallerID()
 299         {
 300                 ServerInstance->Modes->DelMode(myumode);
 301                 delete myumode;
 302         }
 303
 304         virtual Version GetVersion()
 305         {
 306                 return Version(1, 2, 0, 0, VF_COMMON | VF_VENDOR, API_VERSION);
 307         }
 308
 309         virtual void On005Numeric(std::string& output)
 310         {
 311                 output += " CALLERID=g";
 312         }
 313
 314         int PreText(User* user, User* dest, std::string& text, bool notice)
 315         {
 316                 if (!dest->IsModeSet('g'))
 317                         return 0;
 318
 319                 if (operoverride && IS_OPER(user))
 320                         return 0;
 321
 322                 callerid_data* dat = GetData(dest, true);
 323                 std::set<User*>::iterator i = dat->accepting.find(dest);
 324
 325                 if (i == dat->accepting.end())
 326                 {
 327                         time_t now = time(NULL);
 328                         /* +g and *not* accepted */
 329                         user->WriteNumeric(716, "%s %s :is in +g mode (server-side ignore).", user->nick.c_str(), dest->nick.c_str());
 330                         if (now > (dat->lastnotify + (time_t)notify_cooldown))
 331                         {
 332                                 user->WriteNumeric(717, "%s %s :has been informed that you messaged them.", user->nick.c_str(), dest->nick.c_str());
 333                                 dest->WriteNumeric(718, "%s %s %s@%s :is messaging you, and you have umode +g", dest->nick.c_str(), user->nick.c_str(), user->ident.c_str(), user->dhost.c_str());
 334                                 dat->lastnotify = now;
 335                         }
 336                         return 1;
 337                 }
 338                 return 0;
 339         }
 340
 341         virtual int OnUserPreMessage(User* user, void* dest, int target_type, std::string& text, char status, CUList &exempt_list)
 342         {
 343                 if (IS_LOCAL(user) && target_type == TYPE_USER)
 344                         return PreText(user, (User*)dest, text, true);
 345
 346                 return 0;
 347         }
 348
 349         virtual int OnUserPreNotice(User* user, void* dest, int target_type, std::string& text, char status, CUList &exempt_list)
 350         {
 351                 if (IS_LOCAL(user) && target_type == TYPE_USER)
 352                         return PreText(user, (User*)dest, text, true);
 353
 354                 return 0;
 355         }
 356
 357         virtual void OnCleanup(int type, void* item)
 358         {
 359                 if (type != TYPE_USER)
 360                         return;
 361
 362                 User* u = (User*)item;
 363                 /* Cleanup only happens on unload (before dtor), so keep this O(n) instead of O(n^2) which deferring to OnUserQuit would do.  */
 364                 RemoveData(u);
 365         }
 366
 367         virtual void OnSyncUserMetaData(User* user, Module* proto, void* opaque, const std::string& extname, bool displayable)
 368         {
 369                 if (extname == "callerid_data")
 370                 {
 371                         callerid_data* dat = GetData(user, false);
 372                         if (dat)
 373                         {
 374                                 std::string str = dat->ToString(displayable);
 375                                 proto->ProtoSendMetaData(opaque, TYPE_USER, user, extname, str);
 376                         }
 377                 }
 378         }
 379
 380         virtual void OnDecodeMetaData(int target_type, void* target, const std::string& extname, const std::string& extdata)
 381         {
 382                 if (target_type == TYPE_USER && extname == "callerid_data")
 383                 {
 384                         User* u = (User*)target;
 385                         callerid_data* dat = new callerid_data(extdata, ServerInstance);
 386                         u->Extend("callerid_data", dat);
 387                 }
 388         }
 389
 390         virtual int OnUserPreNick(User* user, const std::string& newnick)
 391         {
 392                 if (!tracknick)
 393                         RemoveFromAllAccepts(ServerInstance, user);
 394                 return 0;
 395         }
 396
 397         virtual void OnUserQuit(User* user, const std::string& message, const std::string& oper_message)
 398         {
 399                 RemoveData(user);
 400                 RemoveFromAllAccepts(ServerInstance, user);
 401         }
 402
 403         virtual void OnRehash(User* user, const std::string& parameter)
 404         {
 405                 ConfigReader Conf(ServerInstance);
 406                 maxaccepts = Conf.ReadInteger("callerid", "maxaccepts", "16", 0, true);
 407                 operoverride = Conf.ReadFlag("callerid", "operoverride", "0", 0);
 408                 tracknick = Conf.ReadFlag("callerid", "tracknick", "0", 0);
 409                 notify_cooldown = Conf.ReadInteger("callerid", "cooldown", "60", 0, true);
 410         }
 411 };
 412
 413 MODULE_INIT(ModuleCallerID)
 414
 415