From 7225b474b62392ec5579fd74ef8cd04ca835135e Mon Sep 17 00:00:00 2001 From: Spoike Date: Fri, 2 Aug 2013 00:51:07 +0000 Subject: [PATCH] tiny fix for nq and a small tweak for the libqtv builds to be a little easier to work with. git-svn-id: https://svn.code.sf.net/p/fteqw/code/trunk@4451 fc73d0e0-1445-4013-8a0c-d673dee63da5 --- fteqtv/dotnet2005/libqtv.vcproj | 15 ++++-- fteqtv/net_qtv.h | 77 ++++++++++++++++++++++++++++++ fteqtv/nq_api.c | 83 +++++++++++++++------------------ fteqtv/parse.c | 18 +++---- 4 files changed, 135 insertions(+), 58 deletions(-) create mode 100644 fteqtv/net_qtv.h diff --git a/fteqtv/dotnet2005/libqtv.vcproj b/fteqtv/dotnet2005/libqtv.vcproj index a07f0e94e..a2b4d895a 100644 --- a/fteqtv/dotnet2005/libqtv.vcproj +++ b/fteqtv/dotnet2005/libqtv.vcproj @@ -16,7 +16,7 @@ @@ -112,10 +114,9 @@ + + diff --git a/fteqtv/net_qtv.h b/fteqtv/net_qtv.h new file mode 100644 index 000000000..312dd08f7 --- /dev/null +++ b/fteqtv/net_qtv.h @@ -0,0 +1,77 @@ +/* +This file is intended as a set of exports for an NQ-based engine. +This is supported _purely_ for clients, and will not work for servers (safe no-op). + + + +[EndUser] how to use: +to join a qw server: connect "udp:127.0.0.1:27500" +to watch a qtv stream: connect "tcp:3@127.0.0.1:27599" (where '3' is the streamid) +to watch an mvd demo: connect "demo:blahblah.mvd" - the demo will be loaded from $WORKINGDIR/qw/demos/ - note that $WORKINGDIR is NOT always the same dir + as your engine is running from. The -basedir argument will break it, or engines that hunt down a 'proper' installation of quake instead. + + +[Developer] how to incorporate into an nq engine: +copy this file (net_qtv.h) into your source directory, next to your other net_*.h files +load up net_win.c +find the #include "net_wins.h" line. +dupe it, call it net_qtv.h +find the net_landrivers array. Dupe the first block, then edit the first block to be all QTV_foo functions. +bump net_numlandrivers. +For non-window operating systems, you'll need to do the same, just figure out which net_win.c equivelent function it uses first. :P +certain engines may do weird things with the port. probably its best to just use Cmd_Args() for the connect command instead of Cmd_Argv(1), and to add + port parsing to XXXX_GetAddrFromName instead of messing around with port cvars etc and ruining server configs. + If your engine already has weird port behaviour, then its entirely your problem to fix. :P +You probably want to tweak your menus a little to clean up the nq/qw/qtv connection distinctions. +If you do want to make changes to libqtv, please consider joining the FTE team (or at least the irc channel) in order to contribute without forking. + +[Developer] how to compile libqtv: +cflags MUST define 'LIBQTV' or it won't compile properly. +The relevent exports are all tagged as 'EXPORT void PUBLIC fname(...)' (dllexport+cdecl in windows), feel free to define those properly if you're making a linux shared object without exporting all (potentially conflicting) internals. +This means you can compile it as a dll without any issues, one with a standardized interface. Any libqtv-specific bugfixes can be released independantly from engine(s). +Compiling a dll with msvc will generally automatically produce a .lib which you can directly link against. Alternatively, include both projects in your workspace and set up dependancies properly and it'll be automatically imported. + +[PowerUser] issues: +its a full qtv proxy, but you can't get admin/rcon access to it. +it doesn't read any configs, and has no console, thus you cannot set an rcon password/port. +without console/rcon, you cannot enable any listening ports for other users. +if you need a public qtv proxy, use a standalone version. +*/ + +//#define EXPORT is defined declspec export for dll builds. +#ifdef _WIN32 +#define PUBLIC __cdecl +#endif + +#ifndef EXPORT +#define EXPORT +#endif +#ifndef PUBLIC +#define PUBLIC +#endif +#define PUBEXPORT EXPORT + +//vanilla 'net_win.c' datagram driver function listings +PUBEXPORT int PUBLIC QTV_Init (void); +PUBEXPORT void PUBLIC QTV_Shutdown (void); +PUBEXPORT void PUBLIC QTV_Listen (qboolean state); +PUBEXPORT int PUBLIC QTV_OpenSocket (int port); +PUBEXPORT int PUBLIC QTV_CloseSocket (int socket); +PUBEXPORT int PUBLIC QTV_Connect (int socket, struct qsockaddr *addr); +PUBEXPORT int PUBLIC QTV_CheckNewConnections (void); +PUBEXPORT int PUBLIC QTV_Read (int socket, byte *buf, int len, struct qsockaddr *addr); +PUBEXPORT int PUBLIC QTV_Write (int socket, byte *buf, int len, struct qsockaddr *addr); +PUBEXPORT int PUBLIC QTV_Broadcast (int socket, byte *buf, int len); +PUBEXPORT char *PUBLIC QTV_AddrToString (struct qsockaddr *addr); +PUBEXPORT int PUBLIC QTV_StringToAddr (char *string, struct qsockaddr *addr); //port is part of the string. libqtv will use its own default port. +PUBEXPORT int PUBLIC QTV_GetSocketAddr (int socket, struct qsockaddr *addr); +PUBEXPORT int PUBLIC QTV_GetNameFromAddr (struct qsockaddr *addr, char *name); +PUBEXPORT int PUBLIC QTV_GetAddrFromName (char *name, struct qsockaddr *addr); +PUBEXPORT int PUBLIC QTV_AddrCompare (struct qsockaddr *addr1, struct qsockaddr *addr2); +PUBEXPORT int PUBLIC QTV_GetSocketPort (struct qsockaddr *addr); +PUBEXPORT int PUBLIC QTV_SetSocketPort (struct qsockaddr *addr, int port); + +//additional functions for enhanced engines that changed the net_dgrm system api or other uses. +PUBEXPORT void PUBLIC QTV_Command (char *command, char *resulttext, int resultlen); //sends a console command to the qtv proxy. you can make it a formal proxy with this. must have been inited. +PUBEXPORT void PUBLIC QTV_RunFrame (void); //runs a proxy frame without needing a connection to be active. +PUBEXPORT int PUBLIC QTV_StringPortToAddr (char *string, int port, struct qsockaddr *addr); //port may be part of the string. the specified port will be used, or just pass 0 for libqtv to make it up. generally you'll want to pass the 'port' cvar for port, and the exact argument that was typed in the string arg. \ No newline at end of file diff --git a/fteqtv/nq_api.c b/fteqtv/nq_api.c index 4d75307b0..b6f65d409 100644 --- a/fteqtv/nq_api.c +++ b/fteqtv/nq_api.c @@ -2,40 +2,7 @@ This file is intended as a set of exports for an NQ-based engine. This is supported _purely_ for clients, and will not work for servers. - - -[EndUser] how to use: -to join a qw server: connect "udp:127.0.0.1:27500" -to watch a qtv stream: connect "tcp:3@127.0.0.1:27599" (where '3' is the streamid) -to watch an mvd demo: connect "demo:blahblah.mvd" - the demo will be loaded from $WORKINGDIR/qw/demos/ - note that $WORKINGDIR is NOT always the same dir - as your engine is running from. The -basedir argument will break it, or engines that hunt down a 'proper' installation of quake instead. - - -[Developer] how to incorporate into an nq engine: -load up net_win.c -find the #include "net_wins.h" line. -dupe it, call it net_qtv.h -dupe the header itself too, changing all WINS_foo to QTV_foo. -find the net_landrivers array. Dupe the first block, then edit the first block to be all QTV_foo functions. -bump net_numlandrivers. -For non-window operating systems, you'll need to do the same, just figure out which net_win.c equivelent function it uses first. :P -certain engines may do weird things with the port. probably its best to just use Cmd_Args() for the connect command instead of Cmd_Argv(1), and to add - port parsing to XXXX_GetAddrFromName instead of messing around with port cvars etc and ruining server configs. - If your engine already has weird port behaviour, then its entirely your problem to fix. :P -You probably want to tweak your menus a little to clean up the nq/qw/qtv connection distinctions. -If you do want to make changes to libqtv, please consider joining the FTE team (or at least the irc channel) in order to contribute without forking. - -[Developer] how to compile libqtv: -cflags MUST define 'LIBQTV' or it won't compile properly. -The relevent exports are all tagged as 'EXPORT void PUBLIC fname(...)' (dllexport+cdecl in windows), feel free to define those properly if you're making a linux shared object without exporting all (potentially conflicting) internals. -This means you can compile it as a dll without any issues, one with a standardized interface. Any libqtv-specific bugfixes can be released independantly from engine(s). -Compiling a dll with msvc will generally automatically produce a .lib which you can directly link against. Alternatively, include both projects in your workspace and set up dependancies properly and it'll be automatically imported. - -[PowerUser] issues: -its a full qtv proxy, but you can't get admin/rcon access to it. -it doesn't read any configs, and has no console, thus you cannot set an rcon password/port. -without console/rcon, you cannot enable any listening ports for other users. -if you need a public qtv proxy, use a standalone version. +documentation can be found inside net_qtv.h */ @@ -51,22 +18,35 @@ struct qsockaddr { int ipid; }; -char resolvedadrstring[128]; -int lastadrid; +static char resolvedadrstring[128]; +static int lastadrid; #ifdef _WIN32 #define EXPORT __declspec(dllexport) -#define PUBLIC __cdecl -#endif -#ifndef EXPORT -#define EXPORT -#endif -#ifndef PUBLIC -#define PUBLIC #endif +#include "net_qtv.h" + + +PUBEXPORT void PUBLIC QTV_Command (char *command, char *results, int resultlen) +{ + if (!cluster) + return; + Rcon_Command(cluster, NULL, command, results, resultlen, true); +} +PUBEXPORT void PUBLIC QTV_RunFrame (void) +{ + if (!cluster) + return; + Cluster_Run(cluster, false); +} + + EXPORT int PUBLIC QTV_Init (void) { + if (cluster) + return 0; + cluster = malloc(sizeof(*cluster)); if (cluster) { @@ -194,16 +174,29 @@ EXPORT char *PUBLIC QTV_AddrToString (struct qsockaddr *addr) { return 0; } -EXPORT int PUBLIC QTV_StringToAddr (char *string, struct qsockaddr *addr) +EXPORT int PUBLIC QTV_StringPortToAddr (char *string, int port, struct qsockaddr *addr) { - if (!strncmp(string, "udp:", 4) || !strncmp(string, "tcp:", 4) || !strncmp(string, "file:", 5)) + if (!strncmp(string, "file:", 5) || !strncmp(string, "demo:", 5)) { snprintf(resolvedadrstring, sizeof(resolvedadrstring), "%s", string); addr->ipid = ++lastadrid; return 0; } + if (!strncmp(string, "qw:", 3) || !strncmp(string, "udp:", 4) || !strncmp(string, "tcp:", 4)) + { + if (port) + snprintf(resolvedadrstring, sizeof(resolvedadrstring), "%s:%i", string, port); + else + snprintf(resolvedadrstring, sizeof(resolvedadrstring), "%s", string); + addr->ipid = ++lastadrid; + return 0; + } return -1; } +EXPORT int PUBLIC QTV_StringToAddr (char *string, struct qsockaddr *addr) +{ + return QTV_StringPortToAddr(string, 0, addr); +} EXPORT int PUBLIC QTV_GetSocketAddr (int socket, struct qsockaddr *addr) { return 0; diff --git a/fteqtv/parse.c b/fteqtv/parse.c index 61ff52ed7..d98a4a478 100644 --- a/fteqtv/parse.c +++ b/fteqtv/parse.c @@ -473,7 +473,7 @@ static void ParseServerinfo(sv_t *tv, netmsg_t *m) static void ParsePrint(sv_t *tv, netmsg_t *m, int to, unsigned int mask) { char text[1024]; - char buffer[1024]; + char nqbuffer[1024]; int level; level = ReadByte(m); @@ -491,19 +491,21 @@ static void ParsePrint(sv_t *tv, netmsg_t *m, int to, unsigned int mask) if (colon) { //de-fuck qqshka's extra gibberish. - snprintf(buffer, sizeof(buffer), "%c%c[QTV]%s\n", svc_print, 3, colon+1); - Multicast(tv, buffer, strlen(buffer)+1, to, mask, QW|CONNECTING); + snprintf(nqbuffer, sizeof(nqbuffer), "%c%c[QTV]%s\n", svc_print, 3, colon+1); + Multicast(tv, nqbuffer, strlen(nqbuffer)+1, to, mask, QW|CONNECTING); + snprintf(nqbuffer, sizeof(nqbuffer), "%c%c[QTV]%s\n", svc_print, 1, colon+1); + Multicast(tv, nqbuffer, strlen(nqbuffer)+1, to, mask, NQ|CONNECTING); return; } } - strcpy(buffer+2, text); - buffer[1] = 1; + strlcpy(nqbuffer+2, text, sizeof(nqbuffer)-2); + nqbuffer[1] = 1; //nq chat is prefixed with a 1 } else { - strcpy(buffer+1, text); + strlcpy(nqbuffer+1, text, sizeof(nqbuffer)-1); } - buffer[0] = svc_print; + nqbuffer[0] = svc_print; if ((to&dem_mask) == dem_all || to == dem_read) { @@ -514,7 +516,7 @@ static void ParsePrint(sv_t *tv, netmsg_t *m, int to, unsigned int mask) } Multicast(tv, (char*)m->data+m->startpos, m->readpos - m->startpos, to, mask, QW|CONNECTING); -// Multicast(tv, buffer, strlen(buffer)+1, to, mask, NQ); + Multicast(tv, nqbuffer, strlen(nqbuffer)+1, to, mask, NQ|CONNECTING); } static void ParseCenterprint(sv_t *tv, netmsg_t *m, int to, unsigned int mask) {