From a761d4eec5b6a5bca19ded007a771b964558c061 Mon Sep 17 00:00:00 2001 From: Jan Vidar Krey Date: Fri, 12 Nov 2010 18:39:12 +0100 Subject: [PATCH] Split up plugin API header files somewhat. --- src/adc/adcconst.h | 4 ++ src/plugin_api/handle.h | 67 +++--------------------------- src/plugin_api/types.h | 91 +++++++++++++++++++++++++++++++++++++++++ 3 files changed, 101 insertions(+), 61 deletions(-) create mode 100644 src/plugin_api/types.h diff --git a/src/adc/adcconst.h b/src/adc/adcconst.h index 35d6564..f78db84 100644 --- a/src/adc/adcconst.h +++ b/src/adc/adcconst.h @@ -20,7 +20,11 @@ #ifndef HAVE_UHUB_ADC_CONSTANTS_H #define HAVE_UHUB_ADC_CONSTANTS_H +#ifndef SID_T_DEFINED typedef uint32_t sid_t; +#define SID_T_DEFINED +#endif + typedef uint32_t fourcc_t; /* Internal uhub limit */ diff --git a/src/plugin_api/handle.h b/src/plugin_api/handle.h index f9004f0..39d1e83 100644 --- a/src/plugin_api/handle.h +++ b/src/plugin_api/handle.h @@ -20,69 +20,14 @@ #ifndef 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 "util/credentials.h" #include "util/ipcalc.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 */ -}; +#include "plugin_api/types.h" 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); @@ -142,7 +87,6 @@ struct plugin_funcs // Login check functions on_check_ip_early_t login_check_ip_early; on_check_ip_late_t login_check_ip_late; - }; struct plugin_handle @@ -158,6 +102,7 @@ struct plugin_handle struct plugin_funcs funcs; }; + #define PLUGIN_INITIALIZE(PTR, NAME, VERSION, DESCRIPTION) \ do { \ PTR->name = NAME; \ diff --git a/src/plugin_api/types.h b/src/plugin_api/types.h new file mode 100644 index 0000000..2094144 --- /dev/null +++ b/src/plugin_api/types.h @@ -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 . + * + */ + +#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 */