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