src/coremods/core_who.cpp

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
   5  *   Copyright (C) 2007-2008 Robin Burchell <robin+git@viroteck.net>
   6  *
   7  * This file is part of InspIRCd.  InspIRCd is free software: you can
   8  * redistribute it and/or modify it under the terms of the GNU General Public
   9  * License as published by the Free Software Foundation, version 2.
  10  *
  11  * This program is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  13  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  14  * details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20
  21 #include "inspircd.h"
  22
  23 /** Handle /WHO.
  24  */
  25 class CommandWho : public Command
  26 {
  27         bool CanView(Channel* chan, User* user);
  28         bool opt_viewopersonly;
  29         bool opt_showrealhost;
  30         bool opt_realname;
  31         bool opt_mode;
  32         bool opt_ident;
  33         bool opt_metadata;
  34         bool opt_port;
  35         bool opt_away;
  36         bool opt_local;
  37         bool opt_far;
  38         bool opt_time;
  39         ChanModeReference secretmode;
  40         ChanModeReference privatemode;
  41         UserModeReference invisiblemode;
  42
  43         Membership* get_first_visible_channel(User* u)
  44         {
  45                 for (UCListIter i = u->chans.begin(); i != u->chans.end(); ++i)
  46                 {
  47                         Membership* memb = *i;
  48                         if (!memb->chan->IsModeSet(secretmode))
  49                                 return memb;
  50                 }
  51                 return NULL;
  52         }
  53
  54  public:
  55         /** Constructor for who.
  56          */
  57         CommandWho(Module* parent)
  58                 : Command(parent, "WHO", 1)
  59                 , secretmode(parent, "secret")
  60                 , privatemode(parent, "private")
  61                 , invisiblemode(parent, "invisible")
  62         {
  63                 syntax = "<server>|<nickname>|<channel>|<realname>|<host>|0 [ohurmMiaplf]";
  64         }
  65
  66         void SendWhoLine(User* user, const std::vector<std::string>& parms, const std::string& initial, Membership* memb, User* u, std::vector<std::string>& whoresults);
  67         /** Handle command.
  68          * @param parameters The parameters to the command
  69          * @param user The user issuing the command
  70          * @return A value from CmdResult to indicate command success or failure.
  71          */
  72         CmdResult Handle(const std::vector<std::string>& parameters, User *user);
  73         bool whomatch(User* cuser, User* user, const char* matchtext);
  74 };
  75
  76 bool CommandWho::whomatch(User* cuser, User* user, const char* matchtext)
  77 {
  78         bool match = false;
  79         bool positive = false;
  80
  81         if (user->registered != REG_ALL)
  82                 return false;
  83
  84         if (opt_local && !IS_LOCAL(user))
  85                 return false;
  86         else if (opt_far && IS_LOCAL(user))
  87                 return false;
  88
  89         if (opt_mode)
  90         {
  91                 for (const char* n = matchtext; *n; n++)
  92                 {
  93                         if (*n == '+')
  94                         {
  95                                 positive = true;
  96                                 continue;
  97                         }
  98                         else if (*n == '-')
  99                         {
 100                                 positive = false;
 101                                 continue;
 102                         }
 103                         if (user->IsModeSet(*n) != positive)
 104                                 return false;
 105                 }
 106                 return true;
 107         }
 108         else
 109         {
 110                 /*
 111                  * This was previously one awesome pile of ugly nested if, when really, it didn't need
 112                  * to be, since only one condition was ever checked, a chained if works just fine.
 113                  * -- w00t
 114                  */
 115                 if (opt_metadata)
 116                 {
 117                         match = false;
 118                         const Extensible::ExtensibleStore& list = user->GetExtList();
 119                         for(Extensible::ExtensibleStore::const_iterator i = list.begin(); i != list.end(); ++i)
 120                                 if (InspIRCd::Match(i->first->name, matchtext))
 121                                         match = true;
 122                 }
 123                 else if (opt_realname)
 124                         match = InspIRCd::Match(user->fullname, matchtext);
 125                 else if (opt_showrealhost)
 126                         match = InspIRCd::Match(user->host, matchtext, ascii_case_insensitive_map);
 127                 else if (opt_ident)
 128                         match = InspIRCd::Match(user->ident, matchtext, ascii_case_insensitive_map);
 129                 else if (opt_port)
 130                 {
 131                         irc::portparser portrange(matchtext, false);
 132                         long portno = -1;
 133                         while ((portno = portrange.GetToken()))
 134                                 if (IS_LOCAL(user) && portno == IS_LOCAL(user)->GetServerPort())
 135                                 {
 136                                         match = true;
 137                                         break;
 138                                 }
 139                 }
 140                 else if (opt_away)
 141                         match = InspIRCd::Match(user->awaymsg, matchtext);
 142                 else if (opt_time)
 143                 {
 144                         long seconds = InspIRCd::Duration(matchtext);
 145
 146                         // Okay, so time matching, we want all users connected `seconds' ago
 147                         if (user->age >= ServerInstance->Time() - seconds)
 148                                 match = true;
 149                 }
 150
 151                 /*
 152                  * Once the conditionals have been checked, only check dhost/nick/server
 153                  * if they didn't match this user -- and only match if we don't find a match.
 154                  *
 155                  * This should make things minutely faster, and again, less ugly.
 156                  * -- w00t
 157                  */
 158                 if (!match)
 159                         match = InspIRCd::Match(user->dhost, matchtext, ascii_case_insensitive_map);
 160
 161                 if (!match)
 162                         match = InspIRCd::Match(user->nick, matchtext);
 163
 164                 /* Don't allow server name matches if HideWhoisServer is enabled, unless the command user has the priv */
 165                 if (!match && (ServerInstance->Config->HideWhoisServer.empty() || cuser->HasPrivPermission("users/auspex")))
 166                         match = InspIRCd::Match(user->server->GetName(), matchtext);
 167
 168                 return match;
 169         }
 170 }
 171
 172 bool CommandWho::CanView(Channel* chan, User* user)
 173 {
 174         if (!user || !chan)
 175                 return false;
 176
 177         /* Bug #383 - moved higher up the list, because if we are in the channel
 178          * we can see all its users
 179          */
 180         if (chan->HasUser(user))
 181                 return true;
 182         /* Opers see all */
 183         if (user->HasPrivPermission("users/auspex"))
 184                 return true;
 185         /* Cant see inside a +s or a +p channel unless we are a member (see above) */
 186         else if (!chan->IsModeSet(secretmode) && !chan->IsModeSet(privatemode))
 187                 return true;
 188
 189         return false;
 190 }
 191
 192 void CommandWho::SendWhoLine(User* user, const std::vector<std::string>& parms, const std::string& initial, Membership* memb, User* u, std::vector<std::string>& whoresults)
 193 {
 194         if (!memb)
 195                 memb = get_first_visible_channel(u);
 196
 197         std::string wholine = initial + (memb ? memb->chan->name : "*") + " " + u->ident + " " +
 198                 (opt_showrealhost ? u->host : u->dhost) + " ";
 199         if (!ServerInstance->Config->HideWhoisServer.empty() && !user->HasPrivPermission("servers/auspex"))
 200                 wholine.append(ServerInstance->Config->HideWhoisServer);
 201         else
 202                 wholine.append(u->server->GetName());
 203
 204         wholine.append(" " + u->nick + " ");
 205
 206         /* away? */
 207         if (u->IsAway())
 208         {
 209                 wholine.append("G");
 210         }
 211         else
 212         {
 213                 wholine.append("H");
 214         }
 215
 216         /* oper? */
 217         if (u->IsOper())
 218         {
 219                 wholine.push_back('*');
 220         }
 221
 222         if (memb)
 223                 wholine.push_back(memb->GetPrefixChar());
 224
 225         wholine.append(" :0 " + u->fullname);
 226
 227         FOREACH_MOD(OnSendWhoLine, (user, parms, u, memb, wholine));
 228
 229         if (!wholine.empty())
 230                 whoresults.push_back(wholine);
 231 }
 232
 233 CmdResult CommandWho::Handle (const std::vector<std::string>& parameters, User *user)
 234 {
 235         /*
 236          * XXX - RFC says:
 237          *   The <name> passed to WHO is matched against users' host, server, real
 238          *   name and nickname
 239          * Currently, we support WHO #chan, WHO nick, WHO 0, WHO *, and the addition of a 'o' flag, as per RFC.
 240          */
 241
 242         /* WHO options */
 243         opt_viewopersonly = false;
 244         opt_showrealhost = false;
 245         opt_realname = false;
 246         opt_mode = false;
 247         opt_ident = false;
 248         opt_metadata = false;
 249         opt_port = false;
 250         opt_away = false;
 251         opt_local = false;
 252         opt_far = false;
 253         opt_time = false;
 254
 255         std::vector<std::string> whoresults;
 256         std::string initial = "352 " + user->nick + " ";
 257
 258         /* Change '0' into '*' so the wildcard matcher can grok it */
 259         std::string matchtext = ((parameters[0] == "0") ? "*" : parameters[0]);
 260
 261         // WHO flags count as a wildcard
 262         bool usingwildcards = ((parameters.size() > 1) || (matchtext.find_first_of("*?.") != std::string::npos));
 263
 264         if (parameters.size() > 1)
 265         {
 266                 for (std::string::const_iterator iter = parameters[1].begin(); iter != parameters[1].end(); ++iter)
 267                 {
 268                         switch (*iter)
 269                         {
 270                                 case 'o':
 271                                         opt_viewopersonly = true;
 272                                         break;
 273                                 case 'h':
 274                                         if (user->HasPrivPermission("users/auspex"))
 275                                                 opt_showrealhost = true;
 276                                         break;
 277                                 case 'r':
 278                                         opt_realname = true;
 279                                         break;
 280                                 case 'm':
 281                                         if (user->HasPrivPermission("users/auspex"))
 282                                                 opt_mode = true;
 283                                         break;
 284                                 case 'M':
 285                                         if (user->HasPrivPermission("users/auspex"))
 286                                                 opt_metadata = true;
 287                                         break;
 288                                 case 'i':
 289                                         opt_ident = true;
 290                                         break;
 291                                 case 'p':
 292                                         if (user->HasPrivPermission("users/auspex"))
 293                                                 opt_port = true;
 294                                         break;
 295                                 case 'a':
 296                                         opt_away = true;
 297                                         break;
 298                                 case 'l':
 299                                         if (user->HasPrivPermission("users/auspex") || ServerInstance->Config->HideWhoisServer.empty())
 300                                                 opt_local = true;
 301                                         break;
 302                                 case 'f':
 303                                         if (user->HasPrivPermission("users/auspex") || ServerInstance->Config->HideWhoisServer.empty())
 304                                                 opt_far = true;
 305                                         break;
 306                                 case 't':
 307                                         opt_time = true;
 308                                         break;
 309                         }
 310                 }
 311         }
 312
 313
 314         /* who on a channel? */
 315         Channel* ch = ServerInstance->FindChan(matchtext);
 316
 317         if (ch)
 318         {
 319                 if (CanView(ch,user))
 320                 {
 321                         bool inside = ch->HasUser(user);
 322
 323                         /* who on a channel. */
 324                         const UserMembList *cu = ch->GetUsers();
 325
 326                         for (UserMembCIter i = cu->begin(); i != cu->end(); i++)
 327                         {
 328                                 /* None of this applies if we WHO ourselves */
 329                                 if (user != i->first)
 330                                 {
 331                                         /* opers only, please */
 332                                         if (opt_viewopersonly && !i->first->IsOper())
 333                                                 continue;
 334
 335                                         /* If we're not inside the channel, hide +i users */
 336                                         if (i->first->IsModeSet(invisiblemode) && !inside && !user->HasPrivPermission("users/auspex"))
 337                                                 continue;
 338                                 }
 339
 340                                 SendWhoLine(user, parameters, initial, i->second, i->first, whoresults);
 341                         }
 342                 }
 343         }
 344         else
 345         {
 346                 /* Match against wildcard of nick, server or host */
 347                 if (opt_viewopersonly)
 348                 {
 349                         /* Showing only opers */
 350                         const UserManager::OperList& opers = ServerInstance->Users->all_opers;
 351                         for (UserManager::OperList::const_iterator i = opers.begin(); i != opers.end(); ++i)
 352                         {
 353                                 User* oper = *i;
 354
 355                                 if (whomatch(user, oper, matchtext.c_str()))
 356                                 {
 357                                         if (!user->SharesChannelWith(oper))
 358                                         {
 359                                                 if (usingwildcards && (!oper->IsModeSet(invisiblemode)) && (!user->HasPrivPermission("users/auspex")))
 360                                                         continue;
 361                                         }
 362
 363                                         SendWhoLine(user, parameters, initial, NULL, oper, whoresults);
 364                                 }
 365                         }
 366                 }
 367                 else
 368                 {
 369                         const user_hash& users = ServerInstance->Users->GetUsers();
 370                         for (user_hash::const_iterator i = users.begin(); i != users.end(); ++i)
 371                         {
 372                                 if (whomatch(user, i->second, matchtext.c_str()))
 373                                 {
 374                                         if (!user->SharesChannelWith(i->second))
 375                                         {
 376                                                 if (usingwildcards && (i->second->IsModeSet(invisiblemode)) && (!user->HasPrivPermission("users/auspex")))
 377                                                         continue;
 378                                         }
 379
 380                                         SendWhoLine(user, parameters, initial, NULL, i->second, whoresults);
 381                                 }
 382                         }
 383                 }
 384         }
 385         /* Send the results out */
 386         for (std::vector<std::string>::const_iterator n = whoresults.begin(); n != whoresults.end(); n++)
 387                 user->WriteServ(*n);
 388         user->WriteNumeric(RPL_ENDOFWHO, "%s :End of /WHO list.", *parameters[0].c_str() ? parameters[0].c_str() : "*");
 389
 390         // Penalize the user a bit for large queries
 391         // (add one unit of penalty per 200 results)
 392         if (IS_LOCAL(user))
 393                 IS_LOCAL(user)->CommandFloodPenalty += whoresults.size() * 5;
 394         return CMD_SUCCESS;
 395 }
 396
 397 COMMAND_INIT(CommandWho)