src/modcmd.h

   1 /* modcmd.h - NeonServ v5.3
   2  * Copyright (C) 2011-2012  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 #define CMDFLAG_NO_CROSSCHAN            0x8000
  39
  40 struct ClientSocket;
  41 struct UserNode;
  42 struct ChanNode;
  43 struct Event;
  44
  45 #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))
  46 typedef void cmd_bind_t(struct ClientSocket *client, struct UserNode *user, struct ChanNode *chan, char **argv, char argc, struct Event *event);
  47 typedef void trigger_callback_t(int clientid, struct ChanNode *chan, char *trigger);
  48
  49 struct cmd_function {
  50     char *name;
  51     int botid;
  52     cmd_bind_t *func;
  53     unsigned int flags;
  54     int paramcount;
  55     int global_access;
  56     char *channel_access;
  57
  58     struct cmd_function *next;
  59 };
  60
  61 struct cmd_binding {
  62     char *cmd;
  63     int botid;
  64     int clientid;
  65     struct cmd_function *func;
  66     unsigned int flags;
  67     char *parameters[MAXPARAMETERS];
  68     int paramcount;
  69     int global_access;
  70     char *channel_access;
  71     int triggered;
  72
  73     struct cmd_binding *next;
  74 };
  75
  76 #define BIND_FLAGS(BIND) (BIND->flags | BIND->func->flags)
  77
  78 struct trigger_cache {
  79     int botid;
  80     int clientid;
  81     char *trigger;
  82
  83     struct trigger_cache *next;
  84 };
  85
  86 extern int statistics_commands;
  87
  88 void init_modcmd();
  89 void free_modcmd();
  90
  91 #define get_prefered_bot(BOTID) get_botwise_prefered_bot(BOTID, 0)
  92 struct ClientSocket* get_botwise_prefered_bot(int botid, int clientid);
  93
  94 int register_command(int botid, char *name, cmd_bind_t *func, int paramcount, char *channel_access, int global_access, unsigned int flags);
  95 int set_trigger_callback(int botid, trigger_callback_t *func);
  96
  97 int flush_trigger_cache(int botid, int clientid);
  98
  99 #define changeChannelTrigger(BOTID,CHAN,NEW) changeBotwiseChannelTrigger(BOTID, 0, CHAN, NEW)
 100 int changeBotwiseChannelTrigger(int botid, int clientid, struct ChanNode *chan, char *new_trigger);
 101
 102 #define bind_cmd_to_function(BOTID,CMD,FUNC) bind_botwise_cmd_to_function(BOTID, 0, CMD, FUNC)
 103 int bind_botwise_cmd_to_function(int botid, int clientid, char *cmd, struct cmd_function *func);
 104
 105 #define bind_cmd_to_command(BOTID,CMD,FUNC) bind_botwise_cmd_to_command(BOTID, 0, CMD, FUNC)
 106 int bind_botwise_cmd_to_command(int botid, int clientid, char *cmd, char *func);
 107
 108 #define unbind_cmd(BOTID,CMD) unbind_botwise_cmd(BOTID, 0, CMD)
 109 int unbind_botwise_cmd(int botid, int clientid, char *cmd);
 110
 111 int unbind_botwise_allcmd(int clientid);
 112
 113 #define bind_set_parameters(BOTID,CMD,PARAMETERS) bind_botwise_set_parameters(BOTID, 0, CMD, PARAMETERS)
 114 void bind_botwise_set_parameters(int botid, int clientid, char *cmd, char *parameters);
 115
 116 #define bind_set_global_access(BOTID,CMD,GACCESS) bind_botwise_set_global_access(BOTID, 0, CMD, GACCESS)
 117 void bind_botwise_set_global_access(int botid, int clientid, char *cmd, int gaccess);
 118
 119 #define bind_set_channel_access(BOTID,CMD,CACCESS) bind_botwise_set_channel_access(BOTID, 0, CMD, CACCESS)
 120 void bind_botwise_set_channel_access(int botid, int clientid, char *cmd, char *chanaccess);
 121
 122 #define bind_set_bind_flags(BOTID,CMD,FLAGS) bind_botwise_set_bind_flags(BOTID, 0, CMD, FLAGS)
 123 void bind_botwise_set_bind_flags(int botid, int clientid, char *cmd, unsigned int flags);
 124
 125 #define find_cmd_binding(BOTID,CMD) find_botwise_cmd_binding(BOTID, 0, CMD)
 126 struct cmd_binding *find_botwise_cmd_binding(int botid, int clientid, char *cmd);
 127
 128 #define bind_unbound_required_functions(BOTID) bind_botwise_unbound_required_functions(BOTID, 0)
 129 void bind_botwise_unbound_required_functions(int botid, int clientid);
 130
 131 struct cmd_function *find_cmd_function(int botid, char *name);
 132 struct ClientSocket *getTextBot();
 133 void register_command_alias(int botid, char *alias);
 134 struct cmd_binding *getAllBinds(struct cmd_binding *last);
 135
 136 #endif