src/modcmd.h

   1 /* modcmd.h - NeonServ v5.3
   2  * Copyright (C) 2011  Philipp Kreil (pk910)
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  16  */
  17 #ifndef _modcmd_h
  18 #define _modcmd_h
  19 #include "main.h"
  20
  21 #define MAXPARAMETERS 50
  22
  23 #define CMDFLAG_REQUIRE_CHAN            0x0001
  24 #define CMDFLAG_REQUIRE_AUTH            0x0002
  25 #define CMDFLAG_REQUIRE_GOD             0x0004
  26 #define CMDFLAG_CHECK_AUTH              0x0008
  27 #define CMDFLAG_REGISTERED_CHAN         0x0010
  28 #define CMDFLAG_OVERRIDE_GLOBAL_ACCESS  0x0020
  29 #define CMDFLAG_OVERRIDE_CHANNEL_ACCESS 0x0040
  30 #define CMDFLAG_CHAN_PARAM              0x0080
  31 #define CMDFLAG_LOG                     0x0100
  32 #define CMDFLAG_OPLOG                   0x0200
  33 #define CMDFLAG_EMPTY_ARGS              0x0400
  34 #define CMDFLAG_REQUIRED                0x0800
  35 #define CMDFLAG_TEMPONARY_BIND          0x1000
  36 #define CMDFLAG_FUNCMD                  0x2000
  37 #define CMDFLAG_ESCAPE_ARGS             0x4000
  38
  39 struct ClientSocket;
  40 struct UserNode;
  41 struct ChanNode;
  42 struct Event;
  43
  44 #define CMD_BIND(NAME) void NAME(UNUSED_ARG(struct ClientSocket *client), UNUSED_ARG(struct UserNode *user), UNUSED_ARG(struct ChanNode *chan), UNUSED_ARG(char **argv), UNUSED_ARG(char argc), UNUSED_ARG(struct Event *event))
  45 typedef void cmd_bind_t(struct ClientSocket *client, struct UserNode *user, struct ChanNode *chan, char **argv, char argc, struct Event *event);
  46 typedef void trigger_callback_t(int clientid, struct ChanNode *chan, char *trigger);
  47
  48 struct cmd_function {
  49     char *name;
  50     int botid;
  51     cmd_bind_t *func;
  52     unsigned int flags;
  53     int paramcount;
  54     int global_access;
  55     char *channel_access;
  56
  57     struct cmd_function *next;
  58 };
  59
  60 struct cmd_binding {
  61     char *cmd;
  62     int botid;
  63     int clientid;
  64     struct cmd_function *func;
  65     unsigned int flags;
  66     char *parameters[MAXPARAMETERS];
  67     int paramcount;
  68     int global_access;
  69     char *channel_access;
  70     int triggered;
  71
  72     struct cmd_binding *next;
  73 };
  74
  75 #define BIND_FLAGS(BIND) (BIND->flags | BIND->func->flags)
  76
  77 struct trigger_cache {
  78     int botid;
  79     int clientid;
  80     char *trigger;
  81
  82     struct trigger_cache *next;
  83 };
  84
  85 extern int statistics_commands;
  86
  87 void init_modcmd();
  88 void free_modcmd();
  89
  90 #define get_prefered_bot(BOTID) get_botwise_prefered_bot(BOTID, 0)
  91 struct ClientSocket* get_botwise_prefered_bot(int botid, int clientid);
  92
  93 int register_command(int botid, char *name, cmd_bind_t *func, int paramcount, char *channel_access, int global_access, unsigned int flags);
  94 int set_trigger_callback(int botid, trigger_callback_t *func);
  95
  96 int flush_trigger_cache(int botid, int clientid);
  97
  98 #define changeChannelTrigger(BOTID,CHAN,NEW) changeBotwiseChannelTrigger(BOTID, 0, CHAN, NEW)
  99 int changeBotwiseChannelTrigger(int botid, int clientid, struct ChanNode *chan, char *new_trigger);
 100
 101 #define bind_cmd_to_function(BOTID,CMD,FUNC) bind_botwise_cmd_to_function(BOTID, 0, CMD, FUNC)
 102 int bind_botwise_cmd_to_function(int botid, int clientid, char *cmd, struct cmd_function *func);
 103
 104 #define bind_cmd_to_command(BOTID,CMD,FUNC) bind_botwise_cmd_to_command(BOTID, 0, CMD, FUNC)
 105 int bind_botwise_cmd_to_command(int botid, int clientid, char *cmd, char *func);
 106
 107 #define unbind_cmd(BOTID,CMD) unbind_botwise_cmd(BOTID, 0, CMD)
 108 int unbind_botwise_cmd(int botid, int clientid, char *cmd);
 109
 110 int unbind_botwise_allcmd(int clientid);
 111
 112 #define bind_set_parameters(BOTID,CMD,PARAMETERS) bind_botwise_set_parameters(BOTID, 0, CMD, PARAMETERS)
 113 void bind_botwise_set_parameters(int botid, int clientid, char *cmd, char *parameters);
 114
 115 #define bind_set_global_access(BOTID,CMD,GACCESS) bind_botwise_set_global_access(BOTID, 0, CMD, GACCESS)
 116 void bind_botwise_set_global_access(int botid, int clientid, char *cmd, int gaccess);
 117
 118 #define bind_set_channel_access(BOTID,CMD,CACCESS) bind_botwise_set_channel_access(BOTID, 0, CMD, CACCESS)
 119 void bind_botwise_set_channel_access(int botid, int clientid, char *cmd, char *chanaccess);
 120
 121 #define bind_set_bind_flags(BOTID,CMD,FLAGS) bind_botwise_set_bind_flags(BOTID, 0, CMD, FLAGS)
 122 void bind_botwise_set_bind_flags(int botid, int clientid, char *cmd, unsigned int flags);
 123
 124 #define find_cmd_binding(BOTID,CMD) find_botwise_cmd_binding(BOTID, 0, CMD)
 125 struct cmd_binding *find_botwise_cmd_binding(int botid, int clientid, char *cmd);
 126
 127 #define bind_unbound_required_functions(BOTID) bind_botwise_unbound_required_functions(BOTID, 0)
 128 void bind_botwise_unbound_required_functions(int botid, int clientid);
 129
 130 struct cmd_function *find_cmd_function(int botid, char *name);
 131 struct ClientSocket *getTextBot();
 132 void register_command_alias(int botid, char *alias);
 133 struct cmd_binding *getAllBinds(struct cmd_binding *last);
 134
 135 #endif