apps/silcd/command.h

   1 /*
   2
   3   servercommand.h
   4
   5   Author: Pekka Riikonen <priikone@poseidon.pspt.fi>
   6
   7   Copyright (C) 1997 - 2001 Pekka Riikonen
   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 */
  20
  21 #ifndef COMMAND_H
  22 #define COMMAND_H
  23
  24 /*
  25    Structure holding one command and pointer to its function.
  26
  27    SilcCommandCb cb
  28
  29        Callback function called when this command is executed.
  30
  31    SilcCommand cmd
  32
  33        The actual command. Defined in silccore/silccommand.h
  34
  35    SilcCommandFlag flags
  36
  37        Flags for the command. These set how command behaves on different
  38        situations.
  39
  40 */
  41 typedef struct {
  42   SilcCommandCb cb;
  43   SilcCommand cmd;
  44   SilcCommandFlag flags;
  45 } SilcServerCommand;
  46
  47 /* All server commands */
  48 extern SilcServerCommand silc_command_list[];
  49
  50 /* Context sent as argument to all commands */
  51 typedef struct {
  52   SilcServer server;
  53   SilcSocketConnection sock;
  54   SilcCommandPayload payload;
  55   SilcArgumentPayload args;
  56   SilcPacketContext *packet;
  57   int pending;                  /* Command is being re-processed when TRUE */
  58   int users;                    /* Reference counter */
  59 } *SilcServerCommandContext;
  60
  61 /* Structure holding pending commands. If command is pending it will be
  62    executed after command reply has been received and executed. */
  63 typedef struct SilcServerCommandPendingStruct {
  64   SilcServer server;
  65   SilcCommand reply_cmd;
  66   SilcCommandCb callback;
  67   void *context;
  68   SilcUInt16 ident;
  69   struct SilcServerCommandPendingStruct *next;
  70 } SilcServerCommandPending;
  71
  72 #include "command_reply.h"
  73
  74 /* Macros */
  75
  76 /* Macro used for command declaration in command list structure */
  77 #define SILC_SERVER_CMD(func, cmd, flags) \
  78 { silc_server_command_##func, SILC_COMMAND_##cmd, flags }
  79
  80 /* Macro used to declare command functions. The `context' will be the
  81    SilcServerCommandContext and the `context2' is the
  82    SilcServerCommandReplyContext if this function is called from the
  83    command reply as pending command callback. Otherwise `context2'
  84    is NULL. */
  85 #define SILC_SERVER_CMD_FUNC(func) \
  86 void silc_server_command_##func(void *context, void *context2)
  87
  88 /* Executed pending command. The first argument to the callback function
  89    is the user specified context. The second argument is always the
  90    SilcServerCommandReply context. */
  91 #define SILC_SERVER_PENDING_EXEC(ctx, cmd)                              \
  92 do {                                                                    \
  93   int _i;                                                               \
  94   for (_i = 0; _i < ctx->callbacks_count; _i++)                         \
  95     if (ctx->callbacks[_i].callback)                                    \
  96       (*ctx->callbacks[_i].callback)(ctx->callbacks[_i].context, ctx);  \
  97   silc_server_command_pending_del(ctx->server, cmd, ctx->ident);        \
  98 } while(0)
  99
 100 /* Prototypes */
 101 void silc_server_command_process(SilcServer server,
 102                                  SilcSocketConnection sock,
 103                                  SilcPacketContext *packet);
 104 SilcServerCommandContext silc_server_command_alloc();
 105 void silc_server_command_free(SilcServerCommandContext ctx);
 106 SilcServerCommandContext
 107 silc_server_command_dup(SilcServerCommandContext ctx);
 108 bool silc_server_command_pending(SilcServer server,
 109                                  SilcCommand reply_cmd,
 110                                  SilcUInt16 ident,
 111                                  SilcCommandCb callback,
 112                                  void *context);
 113 void silc_server_command_pending_del(SilcServer server,
 114                                      SilcCommand reply_cmd,
 115                                      SilcUInt16 ident);
 116 SilcServerCommandPendingCallbacks
 117 silc_server_command_pending_check(SilcServer server,
 118                                   SilcServerCommandReplyContext ctx,
 119                                   SilcCommand command,
 120                                   SilcUInt16 ident,
 121                                   SilcUInt32 *callbacks_count);
 122 SILC_SERVER_CMD_FUNC(whois);
 123 SILC_SERVER_CMD_FUNC(whowas);
 124 SILC_SERVER_CMD_FUNC(identify);
 125 SILC_SERVER_CMD_FUNC(newuser);
 126 SILC_SERVER_CMD_FUNC(nick);
 127 SILC_SERVER_CMD_FUNC(list);
 128 SILC_SERVER_CMD_FUNC(topic);
 129 SILC_SERVER_CMD_FUNC(invite);
 130 SILC_SERVER_CMD_FUNC(quit);
 131 SILC_SERVER_CMD_FUNC(kill);
 132 SILC_SERVER_CMD_FUNC(info);
 133 SILC_SERVER_CMD_FUNC(connect);
 134 SILC_SERVER_CMD_FUNC(ping);
 135 SILC_SERVER_CMD_FUNC(oper);
 136 SILC_SERVER_CMD_FUNC(pass);
 137 SILC_SERVER_CMD_FUNC(admin);
 138 SILC_SERVER_CMD_FUNC(join);
 139 SILC_SERVER_CMD_FUNC(motd);
 140 SILC_SERVER_CMD_FUNC(umode);
 141 SILC_SERVER_CMD_FUNC(cmode);
 142 SILC_SERVER_CMD_FUNC(cumode);
 143 SILC_SERVER_CMD_FUNC(kick);
 144 SILC_SERVER_CMD_FUNC(ignore);
 145 SILC_SERVER_CMD_FUNC(ban);
 146 SILC_SERVER_CMD_FUNC(close);
 147 SILC_SERVER_CMD_FUNC(shutdown);
 148 SILC_SERVER_CMD_FUNC(silcoper);
 149 SILC_SERVER_CMD_FUNC(leave);
 150 SILC_SERVER_CMD_FUNC(users);
 151 SILC_SERVER_CMD_FUNC(getkey);
 152
 153 #endif