Split up plugin API header files somewhat.
This commit is contained in:
parent
70a1fd543d
commit
a761d4eec5
@ -20,7 +20,11 @@
|
|||||||
#ifndef HAVE_UHUB_ADC_CONSTANTS_H
|
#ifndef HAVE_UHUB_ADC_CONSTANTS_H
|
||||||
#define HAVE_UHUB_ADC_CONSTANTS_H
|
#define HAVE_UHUB_ADC_CONSTANTS_H
|
||||||
|
|
||||||
|
#ifndef SID_T_DEFINED
|
||||||
typedef uint32_t sid_t;
|
typedef uint32_t sid_t;
|
||||||
|
#define SID_T_DEFINED
|
||||||
|
#endif
|
||||||
|
|
||||||
typedef uint32_t fourcc_t;
|
typedef uint32_t fourcc_t;
|
||||||
|
|
||||||
/* Internal uhub limit */
|
/* Internal uhub limit */
|
||||||
|
@ -20,69 +20,14 @@
|
|||||||
#ifndef HAVE_UHUB_PLUGIN_HANDLE_H
|
#ifndef HAVE_UHUB_PLUGIN_HANDLE_H
|
||||||
#define HAVE_UHUB_PLUGIN_HANDLE_H
|
#define HAVE_UHUB_PLUGIN_HANDLE_H
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This file describes the interface a uhub uses to interact with plugins.
|
||||||
|
*/
|
||||||
|
|
||||||
#include "system.h"
|
#include "system.h"
|
||||||
#include "util/credentials.h"
|
#include "util/credentials.h"
|
||||||
#include "util/ipcalc.h"
|
#include "util/ipcalc.h"
|
||||||
|
#include "plugin_api/types.h"
|
||||||
#define PLUGIN_API_VERSION 1
|
|
||||||
|
|
||||||
#ifndef MAX_NICK_LEN
|
|
||||||
#define MAX_NICK_LEN 64
|
|
||||||
#endif
|
|
||||||
|
|
||||||
#ifndef MAX_PASS_LEN
|
|
||||||
#define MAX_PASS_LEN 64
|
|
||||||
#endif
|
|
||||||
|
|
||||||
#ifndef MAX_CID_LEN
|
|
||||||
#define MAX_CID_LEN 39
|
|
||||||
#endif
|
|
||||||
|
|
||||||
|
|
||||||
struct plugin_handle;
|
|
||||||
|
|
||||||
struct plugin_user
|
|
||||||
{
|
|
||||||
unsigned int sid;
|
|
||||||
const char* nick;
|
|
||||||
const char* cid;
|
|
||||||
const char* user_agent;
|
|
||||||
struct ip_addr_encap addr;
|
|
||||||
enum auth_credentials credentials;
|
|
||||||
};
|
|
||||||
|
|
||||||
enum plugin_status
|
|
||||||
{
|
|
||||||
st_default = 0, /* Use default */
|
|
||||||
st_allow = 1, /* Allow action */
|
|
||||||
st_deny = -1, /* Deny action */
|
|
||||||
};
|
|
||||||
|
|
||||||
typedef enum plugin_status plugin_st;
|
|
||||||
|
|
||||||
struct auth_info
|
|
||||||
{
|
|
||||||
char nickname[MAX_NICK_LEN+1];
|
|
||||||
char password[MAX_PASS_LEN+1];
|
|
||||||
enum auth_credentials credentials;
|
|
||||||
};
|
|
||||||
|
|
||||||
enum ban_flags
|
|
||||||
{
|
|
||||||
ban_nickname = 0x01, /* Nickname is banned */
|
|
||||||
ban_cid = 0x02, /* CID is banned */
|
|
||||||
ban_ip = 0x04, /* IP address (range) is banned */
|
|
||||||
};
|
|
||||||
|
|
||||||
struct ban_info
|
|
||||||
{
|
|
||||||
unsigned int flags; /* See enum ban_flags. */
|
|
||||||
char nickname[MAX_NICK_LEN+1]; /* Nickname - only defined if (ban_nickname & flags). */
|
|
||||||
char cid[MAX_CID_LEN+1]; /* CID - only defined if (ban_cid & flags). */
|
|
||||||
struct ip_addr_encap ip_addr_lo; /* Low IP address of an IP range */
|
|
||||||
struct ip_addr_encap ip_addr_hi; /* High IP address of an IP range */
|
|
||||||
time_t expiry; /* Time when the ban record expires */
|
|
||||||
};
|
|
||||||
|
|
||||||
typedef plugin_st (*on_chat_msg_t)(struct plugin_handle*, struct plugin_user* from, const char* message);
|
typedef plugin_st (*on_chat_msg_t)(struct plugin_handle*, struct plugin_user* from, const char* message);
|
||||||
typedef plugin_st (*on_private_msg_t)(struct plugin_handle*, struct plugin_user* from, struct plugin_user* to, const char* message);
|
typedef plugin_st (*on_private_msg_t)(struct plugin_handle*, struct plugin_user* from, struct plugin_user* to, const char* message);
|
||||||
@ -142,7 +87,6 @@ struct plugin_funcs
|
|||||||
// Login check functions
|
// Login check functions
|
||||||
on_check_ip_early_t login_check_ip_early;
|
on_check_ip_early_t login_check_ip_early;
|
||||||
on_check_ip_late_t login_check_ip_late;
|
on_check_ip_late_t login_check_ip_late;
|
||||||
|
|
||||||
};
|
};
|
||||||
|
|
||||||
struct plugin_handle
|
struct plugin_handle
|
||||||
@ -158,6 +102,7 @@ struct plugin_handle
|
|||||||
struct plugin_funcs funcs;
|
struct plugin_funcs funcs;
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|
||||||
#define PLUGIN_INITIALIZE(PTR, NAME, VERSION, DESCRIPTION) \
|
#define PLUGIN_INITIALIZE(PTR, NAME, VERSION, DESCRIPTION) \
|
||||||
do { \
|
do { \
|
||||||
PTR->name = NAME; \
|
PTR->name = NAME; \
|
||||||
|
91
src/plugin_api/types.h
Normal file
91
src/plugin_api/types.h
Normal file
@ -0,0 +1,91 @@
|
|||||||
|
/*
|
||||||
|
* uhub - A tiny ADC p2p connection hub
|
||||||
|
* Copyright (C) 2007-2010, Jan Vidar Krey
|
||||||
|
*
|
||||||
|
* This program is free software; you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU General Public License as published by
|
||||||
|
* the Free Software Foundation; either version 3 of the License, or
|
||||||
|
* (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program 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 General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU General Public License
|
||||||
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
#ifndef HAVE_UHUB_PLUGIN_TYPES_H
|
||||||
|
#define HAVE_UHUB_PLUGIN_TYPES_H
|
||||||
|
|
||||||
|
#define PLUGIN_API_VERSION 1
|
||||||
|
|
||||||
|
#ifndef MAX_NICK_LEN
|
||||||
|
#define MAX_NICK_LEN 64
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#ifndef MAX_PASS_LEN
|
||||||
|
#define MAX_PASS_LEN 64
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#ifndef MAX_CID_LEN
|
||||||
|
#define MAX_CID_LEN 39
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#ifndef MAX_UA_LEN
|
||||||
|
#define MAX_UA_LEN 32
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#ifndef SID_T_DEFINED
|
||||||
|
typedef uint32_t sid_t;
|
||||||
|
#define SID_T_DEFINED
|
||||||
|
#endif
|
||||||
|
|
||||||
|
struct plugin_handle;
|
||||||
|
|
||||||
|
struct plugin_user
|
||||||
|
{
|
||||||
|
sid_t sid;
|
||||||
|
char nick[MAX_NICK_LEN+1];
|
||||||
|
char cid[MAX_CID_LEN+1];
|
||||||
|
char user_agent[MAX_UA_LEN+1];
|
||||||
|
struct ip_addr_encap addr;
|
||||||
|
enum auth_credentials credentials;
|
||||||
|
};
|
||||||
|
|
||||||
|
enum plugin_status
|
||||||
|
{
|
||||||
|
st_default = 0, /* Use default */
|
||||||
|
st_allow = 1, /* Allow action */
|
||||||
|
st_deny = -1, /* Deny action */
|
||||||
|
};
|
||||||
|
|
||||||
|
typedef enum plugin_status plugin_st;
|
||||||
|
|
||||||
|
struct auth_info
|
||||||
|
{
|
||||||
|
char nickname[MAX_NICK_LEN+1];
|
||||||
|
char password[MAX_PASS_LEN+1];
|
||||||
|
enum auth_credentials credentials;
|
||||||
|
};
|
||||||
|
|
||||||
|
enum ban_flags
|
||||||
|
{
|
||||||
|
ban_nickname = 0x01, /* Nickname is banned */
|
||||||
|
ban_cid = 0x02, /* CID is banned */
|
||||||
|
ban_ip = 0x04, /* IP address (range) is banned */
|
||||||
|
};
|
||||||
|
|
||||||
|
struct ban_info
|
||||||
|
{
|
||||||
|
unsigned int flags; /* See enum ban_flags. */
|
||||||
|
char nickname[MAX_NICK_LEN+1]; /* Nickname - only defined if (ban_nickname & flags). */
|
||||||
|
char cid[MAX_CID_LEN+1]; /* CID - only defined if (ban_cid & flags). */
|
||||||
|
struct ip_addr_encap ip_addr_lo; /* Low IP address of an IP range */
|
||||||
|
struct ip_addr_encap ip_addr_hi; /* High IP address of an IP range */
|
||||||
|
time_t expiry; /* Time when the ban record expires */
|
||||||
|
};
|
||||||
|
|
||||||
|
#endif /* HAVE_UHUB_PLUGIN_TYPES_H */
|
Loading…
Reference in New Issue
Block a user