modules/m_trace.c

   1 /*
   2  *  ircd-ratbox: A slightly useful ircd.
   3  *  m_trace.c: Traces a path to a client/server.
   4  *
   5  *  Copyright (C) 1990 Jarkko Oikarinen and University of Oulu, Co Center
   6  *  Copyright (C) 1996-2002 Hybrid Development Team
   7  *  Copyright (C) 2002-2005 ircd-ratbox development team
   8  *
   9  *  This program is free software; you can redistribute it and/or modify
  10  *  it under the terms of the GNU General Public License as published by
  11  *  the Free Software Foundation; either version 2 of the License, or
  12  *  (at your option) any later version.
  13  *
  14  *  This program is distributed in the hope that it will be useful,
  15  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  *  GNU General Public License for more details.
  18  *
  19  *  You should have received a copy of the GNU General Public License
  20  *  along with this program; if not, write to the Free Software
  21  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307
  22  *  USA
  23  */
  24
  25 #include "stdinc.h"
  26 #include "class.h"
  27 #include "hook.h"
  28 #include "client.h"
  29 #include "hash.h"
  30 #include "hash.h"
  31 #include "match.h"
  32 #include "ircd.h"
  33 #include "numeric.h"
  34 #include "s_serv.h"
  35 #include "s_conf.h"
  36 #include "s_newconf.h"
  37 #include "send.h"
  38 #include "msg.h"
  39 #include "parse.h"
  40 #include "modules.h"
  41
  42 static const char trace_desc[] =
  43         "Provides the TRACE command to trace the route to a client or server";
  44
  45 static void m_trace(struct MsgBuf *, struct Client *, struct Client *, int, const char **);
  46
  47 static void trace_spy(struct Client *, struct Client *);
  48
  49 struct Message trace_msgtab = {
  50         "TRACE", 0, 0, 0, 0,
  51         {mg_unreg, {m_trace, 0}, {m_trace, 0}, mg_ignore, mg_ignore, {m_trace, 0}}
  52 };
  53
  54 int doing_trace_hook;
  55
  56 mapi_clist_av1 trace_clist[] = { &trace_msgtab, NULL };
  57 mapi_hlist_av1 trace_hlist[] = {
  58         { "doing_trace",        &doing_trace_hook },
  59         { NULL, NULL }
  60 };
  61 DECLARE_MODULE_AV2(trace, NULL, NULL, trace_clist, trace_hlist, NULL, NULL, NULL, trace_desc);
  62
  63 static void count_downlinks(struct Client *server_p, int *pservcount, int *pusercount);
  64 static int report_this_status(struct Client *source_p, struct Client *target_p);
  65
  66 static const char *empty_sockhost = "255.255.255.255";
  67
  68 /*
  69  * m_trace
  70  *      parv[1] = servername
  71  */
  72 static void
  73 m_trace(struct MsgBuf *msgbuf_p, struct Client *client_p, struct Client *source_p, int parc, const char *parv[])
  74 {
  75         struct Client *target_p = NULL;
  76         struct Class *cltmp;
  77         const char *tname;
  78         bool doall = false, wilds, dow;
  79         int cnt = 0;
  80         rb_dlink_node *ptr;
  81
  82         if(parc > 1)
  83         {
  84                 tname = parv[1];
  85
  86                 if(parc > 2)
  87                 {
  88                         if(hunt_server(client_p, source_p, ":%s TRACE %s :%s", 2, parc, parv) !=
  89                                         HUNTED_ISME)
  90                                 return;
  91                 }
  92         }
  93         else
  94                 tname = me.name;
  95
  96         /* if we have 3 parameters, then the command is directed at us.  So
  97          * we shouldnt be forwarding it anywhere.
  98          */
  99         if(parc < 3)
 100         {
 101                 switch (hunt_server(client_p, source_p, ":%s TRACE :%s", 1, parc, parv))
 102                 {
 103                 case HUNTED_PASS:       /* note: gets here only if parv[1] exists */
 104                 {
 105                         struct Client *ac2ptr;
 106
 107                         if(MyClient(source_p))
 108                                 ac2ptr = find_named_client(tname);
 109                         else
 110                                 ac2ptr = find_client(tname);
 111
 112                         if(ac2ptr == NULL)
 113                         {
 114                                 RB_DLINK_FOREACH(ptr, global_serv_list.head)
 115                                 {
 116                                         ac2ptr = ptr->data;
 117
 118                                         if(match(tname, ac2ptr->name))
 119                                                 break;
 120                                         else
 121                                                 ac2ptr = NULL;
 122                                 }
 123                         }
 124
 125                         /* giving this out with flattened links defeats the
 126                          * object --fl
 127                          */
 128                         if(IsOper(source_p) || IsExemptShide(source_p) ||
 129                            !ConfigServerHide.flatten_links)
 130                                 sendto_one_numeric(source_p, RPL_TRACELINK,
 131                                                    form_str(RPL_TRACELINK),
 132                                                    ircd_version,
 133                                                    ac2ptr ? ac2ptr->name : tname,
 134                                                    ac2ptr ? ac2ptr->from->name : "EEK!");
 135
 136                         return;
 137                 }
 138
 139                 case HUNTED_ISME:
 140                         break;
 141
 142                 default:
 143                         return;
 144                 }
 145         }
 146
 147         if(match(tname, me.name))
 148         {
 149                 doall = true;
 150         }
 151         /* if theyre tracing our SID, we need to move tname to our name so
 152          * we dont give the sid in ENDOFTRACE
 153          */
 154         else if(!MyClient(source_p) && !strcmp(tname, me.id))
 155         {
 156                 doall = true;
 157                 tname = me.name;
 158         }
 159
 160         wilds = strchr(tname, '*') || strchr(tname, '?');
 161         dow = wilds || doall;
 162
 163         /* specific trace */
 164         if(!dow)
 165         {
 166                 if(MyClient(source_p) || parc > 2)
 167                         target_p = find_named_person(tname);
 168                 else
 169                         target_p = find_person(tname);
 170
 171                 /* tname could be pointing to an ID at this point, so reset
 172                  * it to target_p->name if we have a target --fl
 173                  */
 174                 if(target_p != NULL)
 175                 {
 176                         report_this_status(source_p, target_p);
 177                         tname = target_p->name;
 178                 }
 179
 180                 trace_spy(source_p, target_p);
 181
 182                 sendto_one_numeric(source_p, RPL_ENDOFTRACE,
 183                                    form_str(RPL_ENDOFTRACE), tname);
 184                 return;
 185         }
 186
 187         trace_spy(source_p, NULL);
 188
 189         /* give non-opers a limited trace output of themselves (if local),
 190          * opers and servers (if no shide) --fl
 191          */
 192         if(!IsOper(source_p))
 193         {
 194                 if(MyClient(source_p))
 195                 {
 196                         if(doall || (wilds && match(tname, source_p->name)))
 197                                 report_this_status(source_p, source_p);
 198                 }
 199
 200                 RB_DLINK_FOREACH(ptr, local_oper_list.head)
 201                 {
 202                         target_p = ptr->data;
 203
 204                         if(!doall && wilds && (match(tname, target_p->name) == 0))
 205                                 continue;
 206
 207                         report_this_status(source_p, target_p);
 208                 }
 209
 210                 if (IsExemptShide(source_p) || !ConfigServerHide.flatten_links)
 211                 {
 212                         RB_DLINK_FOREACH(ptr, serv_list.head)
 213                         {
 214                                 target_p = ptr->data;
 215
 216                                 if(!doall && wilds && !match(tname, target_p->name))
 217                                         continue;
 218
 219                                 report_this_status(source_p, target_p);
 220                         }
 221                 }
 222
 223                 sendto_one_numeric(source_p, RPL_ENDOFTRACE,
 224                                    form_str(RPL_ENDOFTRACE), tname);
 225                 return;
 226         }
 227
 228         /* source_p is opered */
 229
 230         /* report all direct connections */
 231         RB_DLINK_FOREACH(ptr, lclient_list.head)
 232         {
 233                 target_p = ptr->data;
 234
 235                 /* dont show invisible users to remote opers */
 236                 if(IsInvisible(target_p) && dow && !MyConnect(source_p) && !IsOper(target_p))
 237                         continue;
 238
 239                 if(!doall && wilds && !match(tname, target_p->name))
 240                         continue;
 241
 242                 /* remote opers may not see invisible normal users */
 243                 if(dow && !MyConnect(source_p) && !IsOper(target_p) &&
 244                                 IsInvisible(target_p))
 245                         continue;
 246
 247                 cnt = report_this_status(source_p, target_p);
 248         }
 249
 250         RB_DLINK_FOREACH(ptr, serv_list.head)
 251         {
 252                 target_p = ptr->data;
 253
 254                 if(!doall && wilds && !match(tname, target_p->name))
 255                         continue;
 256
 257                 cnt = report_this_status(source_p, target_p);
 258         }
 259
 260         if(MyConnect(source_p))
 261         {
 262                 RB_DLINK_FOREACH(ptr, unknown_list.head)
 263                 {
 264                         target_p = ptr->data;
 265
 266                         if(!doall && wilds && !match(tname, target_p->name))
 267                                 continue;
 268
 269                         cnt = report_this_status(source_p, target_p);
 270                 }
 271         }
 272
 273         if(!cnt)
 274         {
 275                 sendto_one_numeric(source_p, ERR_NOSUCHSERVER, form_str(ERR_NOSUCHSERVER),
 276                                         tname);
 277
 278                 /* let the user have some idea that its at the end of the
 279                  * trace
 280                  */
 281                 sendto_one_numeric(source_p, RPL_ENDOFTRACE,
 282                                    form_str(RPL_ENDOFTRACE), tname);
 283                 return;
 284         }
 285
 286         if(doall)
 287         {
 288                 RB_DLINK_FOREACH(ptr, class_list.head)
 289                 {
 290                         cltmp = ptr->data;
 291
 292                         if(CurrUsers(cltmp) > 0)
 293                                 sendto_one_numeric(source_p, RPL_TRACECLASS,
 294                                                    form_str(RPL_TRACECLASS),
 295                                                    ClassName(cltmp), CurrUsers(cltmp));
 296                 }
 297         }
 298
 299         sendto_one_numeric(source_p, RPL_ENDOFTRACE, form_str(RPL_ENDOFTRACE), tname);
 300 }
 301
 302 /*
 303  * count_downlinks
 304  *
 305  * inputs       - pointer to server to count
 306  *              - pointers to server and user count
 307  * output       - NONE
 308  * side effects - server and user counts are added to given values
 309  */
 310 static void
 311 count_downlinks(struct Client *server_p, int *pservcount, int *pusercount)
 312 {
 313         rb_dlink_node *ptr;
 314
 315         (*pservcount)++;
 316         *pusercount += rb_dlink_list_length(&server_p->serv->users);
 317         RB_DLINK_FOREACH(ptr, server_p->serv->servers.head)
 318         {
 319                 count_downlinks(ptr->data, pservcount, pusercount);
 320         }
 321 }
 322
 323 /*
 324  * report_this_status
 325  *
 326  * inputs       - pointer to client to report to
 327  *              - pointer to client to report about
 328  * output       - counter of number of hits
 329  * side effects - NONE
 330  */
 331 static int
 332 report_this_status(struct Client *source_p, struct Client *target_p)
 333 {
 334         const char *name;
 335         const char *class_name;
 336         char ip[HOSTIPLEN];
 337         int cnt = 0;
 338
 339         /* sanity check - should never happen */
 340         if(!MyConnect(target_p))
 341                 return 0;
 342
 343         rb_inet_ntop_sock((struct sockaddr *)&target_p->localClient->ip, ip, sizeof(ip));
 344         class_name = get_client_class(target_p);
 345
 346         if(IsAnyServer(target_p))
 347                 name = target_p->name;
 348         else
 349                 name = get_client_name(target_p, HIDE_IP);
 350
 351         switch (target_p->status)
 352         {
 353         case STAT_CONNECTING:
 354                 sendto_one_numeric(source_p, RPL_TRACECONNECTING,
 355                                 form_str(RPL_TRACECONNECTING),
 356                                 class_name, name);
 357                 cnt++;
 358                 break;
 359
 360         case STAT_HANDSHAKE:
 361                 sendto_one_numeric(source_p, RPL_TRACEHANDSHAKE,
 362                                 form_str(RPL_TRACEHANDSHAKE),
 363                                 class_name, name);
 364                 cnt++;
 365                 break;
 366
 367         case STAT_ME:
 368                 break;
 369
 370         case STAT_UNKNOWN:
 371                 /* added time -Taner */
 372                 sendto_one_numeric(source_p, RPL_TRACEUNKNOWN,
 373                                    form_str(RPL_TRACEUNKNOWN),
 374                                    class_name, name, ip,
 375                                    (unsigned long)(rb_current_time() - target_p->localClient->firsttime));
 376                 cnt++;
 377                 break;
 378
 379         case STAT_CLIENT:
 380                 {
 381                         sendto_one_numeric(source_p,
 382                                         IsOper(target_p) ? RPL_TRACEOPERATOR : RPL_TRACEUSER,
 383                                         IsOper(target_p) ? form_str(RPL_TRACEOPERATOR) : form_str(RPL_TRACEUSER),
 384                                         class_name, name,
 385                                         show_ip(source_p, target_p) ? ip : empty_sockhost,
 386                                         (unsigned long)(rb_current_time() - target_p->localClient->lasttime),
 387                                         (unsigned long)(rb_current_time() - target_p->localClient->last));
 388
 389                         cnt++;
 390                 }
 391                 break;
 392
 393         case STAT_SERVER:
 394                 {
 395                         int usercount = 0;
 396                         int servcount = 0;
 397
 398                         count_downlinks(target_p, &servcount, &usercount);
 399
 400                         sendto_one_numeric(source_p, RPL_TRACESERVER, form_str(RPL_TRACESERVER),
 401                                    class_name, servcount, usercount, name,
 402                                    *(target_p->serv->by) ? target_p->serv->by : "*", "*",
 403                                    me.name,
 404                                    (unsigned long)(rb_current_time() - target_p->localClient->lasttime));
 405                         cnt++;
 406
 407                 }
 408                 break;
 409
 410         default:                /* ...we actually shouldn't come here... --msa */
 411                 sendto_one_numeric(source_p, RPL_TRACENEWTYPE,
 412                                    form_str(RPL_TRACENEWTYPE), name);
 413                 cnt++;
 414                 break;
 415         }
 416
 417         return (cnt);
 418 }
 419
 420 /* trace_spy()
 421  *
 422  * input        - pointer to client
 423  * output       - none
 424  * side effects - hook event doing_trace is called
 425  */
 426 static void
 427 trace_spy(struct Client *source_p, struct Client *target_p)
 428 {
 429         hook_data_client hdata;
 430
 431         hdata.client = source_p;
 432         hdata.target = target_p;
 433
 434         call_hook(doing_trace_hook, &hdata);
 435 }