plugin_handler.h

/*
===========================================================================
    Copyright (C) 2010-2013  Ninja and TheKelm of the IceOps-Team

    This file is part of CoD4X17a-Server source code.

    CoD4X17a-Server source code is free software: you can redistribute it and/or modify
    it under the terms of the GNU Affero General Public License as
    published by the Free Software Foundation, either version 3 of the
    License, or (at your option) any later version.

    CoD4X17a-Server source code is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Affero General Public License for more details.

    You should have received a copy of the GNU Affero General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>
===========================================================================
*/



#ifndef PLUGIN_HANDLER_H
#define PLUGIN_HANDLER_H

/*==========================================*
 *                                          *
 *         Plugin Handler's header          *
 *                                          *
 *   Contains all necessary prototypes      *
 *  and types for using the Plugin Handler. *
 *                                          *
 *==========================================*/

#define MAX_PLUGINS 25 // Maximum number of loaded plugins, hardcoded for better performance

typedef void convariable_t; //For plugins

#define P_P_F __attribute__((__noinline__)) __attribute__((__cdecl__))

#include <stdarg.h>
#include <stdlib.h>
#include <string.h>
#include <dlfcn.h>
#include <execinfo.h>

#include "cmd.h"        // xcommand_t
#include "sys_net.h"    // netadr
#include "msg.h"        // msg_t
#include "g_shared.h"   // level
#include "qcommon_io.h" // Com_Printf
#include "server.h"     // client_t
#include "sys_net.h"    // Tcp stuff

#include "plugins/plugin_declarations.h"
#include "plugin_events.h"

#define PLUGIN_MAX_MALLOCS 50
#define PLUGIN_MAX_SOCKETS 4

// plugins com
#define PLUGIN_COM_MAXNAMELEN 28    // Max 27 chars + \0
#define PLUGIN_MAX_EXPORTS 50       // Maximum count of exported functions, each takes 32B of mem = 1kB per plugin

// ----------------------------//
//  Plugin Handler's own types //
// ----------------------------//

enum {
    PLUGIN_UNKNOWN = -1
};

typedef struct{
    char name[32];
    xcommand_t xcommand;
}pluginCmd_t;

typedef struct{
    size_t size;
    void *ptr;
}pluginMem_t;

typedef struct{
    char name[PLUGIN_COM_MAXNAMELEN];
    void *(*function)();
}pluginExport_t;

typedef struct{
    int sock;
    netadr_t remote;
    qboolean (*packetEventHandler)(netadr_t *from, msg_t* msg);
}pluginTcpClientSocket_t;

typedef struct{
    int (*OnInit)();            // Initialization function
    void (*OnInfoRequest)();    // Info gathering function

    void (*OnEvent[PLUGINS_ITEMCOUNT])();
    void (*OnUnload)();    // De-initialization function

    pluginCmd_t cmd[20];
    pluginCmd_t scriptFunction[32];
    pluginCmd_t scriptMethod[32];
    int cmds;
    int scriptfunctions;
    int scriptmethods;
    
    char name[20];
    
    pluginMem_t memory[PLUGIN_MAX_MALLOCS];
    pluginTcpClientSocket_t sockets[PLUGIN_MAX_SOCKETS];
    
    pluginExport_t exportedFunctions[PLUGIN_MAX_EXPORTS];
    int exports;
    
    size_t usedMem;
    int mallocs;
    
    qboolean loaded;
    qboolean enabled;

    void *lib_handle;
    void *lib_start;
    long lib_size;

}plugin_t;

typedef struct{
    plugin_t plugins[MAX_PLUGINS];
    int loadedPlugins;
    qboolean enabled;
    qboolean initializing_plugin;
}pluginWrapper_t;

extern pluginWrapper_t pluginFunctions; // defined in plugin_handler.c

// --------------------------------//
//  Plugin Handler's own functions //
// --------------------------------//

void PHandler_Load(char*,size_t);
void PHandler_Unload(int id);
void PHandler_Event(int, ...);
void PHandler_Init();
void *PHandler_Malloc(int,size_t);
void PHandler_Free(int,void *);
void PHandler_FreeAll(int);
void PHandler_Error(int,int, char *);
qboolean PHandler_TcpConnect(int,const char *,int);
int PHandler_TcpGetData(int, int, void*, int);
qboolean PHandler_TcpSendData(int,int, void*, int);
void PHandler_TcpCloseConnection(int,int);
int PHandler_CallerID();
void PHandler_ChatPrintf(int,char *,...);
void PHandler_CmdExecute_f( void ); // fake server command for use in plugin commands

// --------------------------------------//
//  Plugin Handler's own server commands //
// --------------------------------------//

void PHandler_LoadPlugin_f( void );
void PHandler_UnLoadPlugin_f( void );
void PHandler_PluginList_f( void );
void PHandler_PluginInfo_f( void );

#endif /*PLUGIN_HANDLER_H*/