modules/m_admin.c

   1 /*
   2  *  ircd-ratbox: A slightly useful ircd.
   3  *  m_admin.c: Sends administrative information to a user.
   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 "client.h"
  27 #include "ircd.h"
  28 #include "numeric.h"
  29 #include "s_conf.h"
  30 #include "s_serv.h"
  31 #include "send.h"
  32 #include "msg.h"
  33 #include "parse.h"
  34 #include "hook.h"
  35 #include "modules.h"
  36
  37 static int m_admin(struct MsgBuf *, struct Client *, struct Client *, int, const char **);
  38 static int mr_admin(struct MsgBuf *, struct Client *, struct Client *, int, const char **);
  39 static int ms_admin(struct MsgBuf *, struct Client *, struct Client *, int, const char **);
  40 static void do_admin(struct Client *source_p);
  41
  42 static void admin_spy(struct Client *);
  43
  44 struct Message admin_msgtab = {
  45         "ADMIN", 0, 0, 0, 0,
  46         {{mr_admin, 0}, {m_admin, 0}, {ms_admin, 0}, mg_ignore, mg_ignore, {ms_admin, 0}}
  47 };
  48
  49 int doing_admin_hook;
  50
  51 mapi_clist_av1 admin_clist[] = { &admin_msgtab, NULL };
  52 mapi_hlist_av1 admin_hlist[] = {
  53         { "doing_admin",        &doing_admin_hook },
  54         { NULL, NULL }
  55 };
  56
  57 const char admin_desc[] =
  58         "Provides the ADMIN command to show server administrator information";
  59
  60 DECLARE_MODULE_AV2(admin, NULL, NULL, admin_clist, admin_hlist, NULL, NULL, NULL, admin_desc);
  61
  62 /*
  63  * mr_admin - ADMIN command handler
  64  *      parv[1] = servername
  65  */
  66 static int
  67 mr_admin(struct MsgBuf *msgbuf_p, struct Client *client_p, struct Client *source_p, int parc, const char *parv[])
  68 {
  69         static time_t last_used = 0L;
  70
  71         if((last_used + ConfigFileEntry.pace_wait) > rb_current_time())
  72         {
  73                 sendto_one(source_p, form_str(RPL_LOAD2HI),
  74                            me.name,
  75                            EmptyString(source_p->name) ? "*" : source_p->name,
  76                            "ADMIN");
  77                 return 0;
  78         }
  79         else
  80                 last_used = rb_current_time();
  81
  82         do_admin(source_p);
  83
  84         return 0;
  85 }
  86
  87 /*
  88  * m_admin - ADMIN command handler
  89  *      parv[1] = servername
  90  */
  91 static int
  92 m_admin(struct MsgBuf *msgbuf_p, struct Client *client_p, struct Client *source_p, int parc, const char *parv[])
  93 {
  94         static time_t last_used = 0L;
  95
  96         if(parc > 1)
  97         {
  98                 if((last_used + ConfigFileEntry.pace_wait) > rb_current_time())
  99                 {
 100                         sendto_one(source_p, form_str(RPL_LOAD2HI),
 101                                    me.name, source_p->name, "ADMIN");
 102                         return 0;
 103                 }
 104                 else
 105                         last_used = rb_current_time();
 106
 107                 if(hunt_server(client_p, source_p, ":%s ADMIN :%s", 1, parc, parv) != HUNTED_ISME)
 108                         return 0;
 109         }
 110
 111         do_admin(source_p);
 112
 113         return 0;
 114 }
 115
 116
 117 /*
 118  * ms_admin - ADMIN command handler, used for OPERS as well
 119  *      parv[1] = servername
 120  */
 121 static int
 122 ms_admin(struct MsgBuf *msgbuf_p, struct Client *client_p, struct Client *source_p, int parc, const char *parv[])
 123 {
 124         if(hunt_server(client_p, source_p, ":%s ADMIN :%s", 1, parc, parv) != HUNTED_ISME)
 125                 return 0;
 126
 127         do_admin(source_p);
 128
 129         return 0;
 130 }
 131
 132
 133 /*
 134  * do_admin
 135  *
 136  * inputs       - pointer to client to report to
 137  * output       - none
 138  * side effects - admin info is sent to client given
 139  */
 140 static void
 141 do_admin(struct Client *source_p)
 142 {
 143         if(IsPerson(source_p))
 144                 admin_spy(source_p);
 145
 146         sendto_one_numeric(source_p, RPL_ADMINME, form_str(RPL_ADMINME), me.name);
 147         if(AdminInfo.name != NULL)
 148                 sendto_one_numeric(source_p, RPL_ADMINLOC1, form_str(RPL_ADMINLOC1), AdminInfo.name);
 149         if(AdminInfo.description != NULL)
 150                 sendto_one_numeric(source_p, RPL_ADMINLOC2, form_str(RPL_ADMINLOC2), AdminInfo.description);
 151         if(AdminInfo.email != NULL)
 152                 sendto_one_numeric(source_p, RPL_ADMINEMAIL, form_str(RPL_ADMINEMAIL), AdminInfo.email);
 153 }
 154
 155 /* admin_spy()
 156  *
 157  * input        - pointer to client
 158  * output       - none
 159  * side effects - event doing_admin is called
 160  */
 161 static void
 162 admin_spy(struct Client *source_p)
 163 {
 164         hook_data hd;
 165
 166         hd.client = source_p;
 167         hd.arg1 = hd.arg2 = NULL;
 168
 169         call_hook(doing_admin_hook, &hd);
 170 }