Done with doxygenizing
[citadel.git] / webcit / subst.c
index d3b6af925c897cb96c4258be3f1a7f310a3d9375..6bcaf0fb395741e7d138e7cd78fe569f5d36852e 100644 (file)
@@ -1,39 +1,18 @@
 /*
  * $Id$
- *
- * Variable substitution type stuff
+ */
+/**
+ * \defgroup Subst Variable substitution type stuff
  *
  */
 
+/*@{*/
 
-
-#include <ctype.h>
-#include <stdlib.h>
-#include <unistd.h>
-#include <stdio.h>
-#include <fcntl.h>
-#include <signal.h>
-#include <sys/types.h>
-#include <sys/wait.h>
-#include <sys/socket.h>
-#include <sys/time.h>
-#include <sys/stat.h>
-#include <limits.h>
-#include <netinet/in.h>
-#include <netdb.h>
-#include <string.h>
-#include <pwd.h>
-#include <errno.h>
-#include <stdarg.h>
-#include <pthread.h>
-#include <signal.h>
 #include "webcit.h"
 
-struct wcsubst *global_subst = NULL;
-
 
-/*
- * Clear out the list of substitution variables local to this session
+/**
+ * \brief Clear out the list of substitution variables local to this session
  */
 void clear_local_substs(void) {
        struct wcsubst *ptr;
@@ -41,59 +20,181 @@ void clear_local_substs(void) {
        while (WC->vars != NULL) {
                ptr = WC->vars->next;
 
-               if (WC->vars->wcs_type == WCS_STRING) {
+               if ((WC->vars->wcs_type == WCS_STRING)
+                  || (WC->vars->wcs_type == WCS_SERVCMD)) {
                        free(WC->vars->wcs_value);
                }
 
                free(WC->vars);
                WC->vars = ptr;
        }
+
+       WC->vars = NULL;
 }
 
 
 /*
- * Add a substitution variable (local to this session)
+ * \brief Add a substitution variable (local to this session)
+ * \param keyname the replacementstring to substitute
+ * \param keytype the kind of the key
+ * \param format the format string ala printf
+ * \param ... the arguments to substitute in the formatstring
  */
-void svprintf(char *keyname, const char *format,...)
+void svprintf(char *keyname, int keytype, const char *format,...)
 {
        va_list arg_ptr;
-       char wbuf[1024];
-       struct wcsubst *ptr;
+       char wbuf[SIZ];
+       struct wcsubst *ptr = NULL;
+       struct wcsubst *scan;
+
+       /**
+        * First scan through to see if we're doing a replacement of
+        * an existing key
+        */
+       for (scan=WC->vars; scan!=NULL; scan=scan->next) {
+               if (!strcasecmp(scan->wcs_key, keyname)) {
+                       ptr = scan;
+                       free(ptr->wcs_value);
+               }
+       }
+
+       /** Otherwise allocate a new one */
+       if (ptr == NULL) {
+               ptr = (struct wcsubst *) malloc(sizeof(struct wcsubst));
+               ptr->next = WC->vars;
+               safestrncpy(ptr->wcs_key, keyname, sizeof ptr->wcs_key);
+               WC->vars = ptr;
+       }
+
+       /** Format the string and save it */
 
        va_start(arg_ptr, format);
-       vsprintf(wbuf, format, arg_ptr);
+       vsnprintf(wbuf, sizeof wbuf, format, arg_ptr);
        va_end(arg_ptr);
 
+       ptr->wcs_type = keytype;
+       ptr->wcs_value = strdup(wbuf);
+}
+
+/**
+ * \brief Add a substitution variable (local to this session) that does a callback
+ * \param keyname the keystring to substitute
+ * \param fcn_ptr the function callback to give the substitution string
+ */
+void svcallback(char *keyname, void (*fcn_ptr)() )
+{
+       struct wcsubst *ptr;
+
        ptr = (struct wcsubst *) malloc(sizeof(struct wcsubst));
        ptr->next = WC->vars;
-       ptr->wcs_type = WCS_STRING;
+       ptr->wcs_type = WCS_FUNCTION;
        strcpy(ptr->wcs_key, keyname);
-       ptr->wcs_value = malloc(strlen(wbuf)+1);
-       strcpy(ptr->wcs_value, wbuf);
+       ptr->wcs_function = fcn_ptr;
        WC->vars = ptr;
 }
 
 
 
-/*
- * Print the value of a variable
+/**
+ * \brief back end for print_value_of() ... does a server command
+ * \param servcmd server command to execute on the citadel server
+ */
+void pvo_do_cmd(char *servcmd) {
+       char buf[SIZ];
+
+       serv_puts(servcmd);
+       serv_getln(buf, sizeof buf);
+
+       switch(buf[0]) {
+               case '2':
+               case '3':
+               case '5':
+                       wprintf("%s\n", &buf[4]);
+                       break;
+               case '1':
+                       fmout("CENTER");
+                       break;
+               case '4':
+                       wprintf("%s\n", &buf[4]);
+                       serv_puts("000");
+                       break;
+       }
+}
+
+
+
+/**
+ * \brief Print the value of a variable
+ * \param keyname get a key to print
  */
 void print_value_of(char *keyname) {
-       struct wbsubst *ptr;
+       struct wcsubst *ptr;
+       void *fcn();
 
-       for (ptr = WC->vars; ptr != NULL; ptr = ptr->next) {
+       if (keyname[0] == '=') {
+               do_template(&keyname[1]);
+       }
+
+       if (!strcasecmp(keyname, "SERV_PID")) {
+               wprintf("%d", WC->ctdl_pid);
+       }
+
+       else if (!strcasecmp(keyname, "SERV_NODENAME")) {
+               escputs(serv_info.serv_nodename);
+       }
+
+       else if (!strcasecmp(keyname, "SERV_HUMANNODE")) {
+               escputs(serv_info.serv_humannode);
+       }
+
+       else if (!strcasecmp(keyname, "SERV_FQDN")) {
+               escputs(serv_info.serv_fqdn);
+       }
+
+       else if (!strcasecmp(keyname, "SERV_SOFTWARE")) {
+               escputs(serv_info.serv_software);
+       }
+
+       else if (!strcasecmp(keyname, "SERV_REV_LEVEL")) {
+               wprintf("%d.%02d",
+                       serv_info.serv_rev_level / 100,
+                       serv_info.serv_rev_level % 100
+               );
+       }
+
+       else if (!strcasecmp(keyname, "SERV_BBS_CITY")) {
+               escputs(serv_info.serv_bbs_city);
+       }
+
+       else if (!strcasecmp(keyname, "CURRENT_USER")) {
+               escputs(WC->wc_fullname);
+       }
+
+       else if (!strcasecmp(keyname, "CURRENT_ROOM")) {
+               escputs(WC->wc_roomname);
+       }
+
+       /** Page-local variables */
+       else for (ptr = WC->vars; ptr != NULL; ptr = ptr->next) {
                if (!strcasecmp(ptr->wcs_key, keyname)) {
                        if (ptr->wcs_type == WCS_STRING) {
                                wprintf("%s", ptr->wcs_value);
                        }
+                       else if (ptr->wcs_type == WCS_SERVCMD) {
+                               pvo_do_cmd(ptr->wcs_value);
+                       }
+                       else if (ptr->wcs_type == WCS_FUNCTION) {
+                               (*ptr->wcs_function) ();
+                       }
                }
        }
 }
 
 
 
-/*
- * Display a variable-substituted template
+/**
+ * \brief Display a variable-substituted template
+ * \param templatename template file to load
  */
 void do_template(void *templatename) {
        char filename[PATH_MAX];
@@ -101,16 +202,19 @@ void do_template(void *templatename) {
        char inbuf[1024];
        char outbuf[sizeof inbuf];
        char key[sizeof inbuf];
-       int i, j, pos;
-       int olen;
+       int i, pos;
 
        strcpy(filename, "static/");
        strcat(filename, templatename);
+       if (WC->is_wap)
+               strcat(filename, ".wml");
+       else
+               strcat(filename, ".html");
        
        fp = fopen(filename, "r");
        if (fp == NULL) {
-               wprintf("<BLINK>ERROR</BLINK> - could not open template ");
-               wprintf("'%s' - %s<BR>\n",
+               wprintf(_("ERROR: could not open template "));
+               wprintf("'%s' - %s<br />\n",
                        templatename, strerror(errno));
                return;
        }
@@ -119,31 +223,36 @@ void do_template(void *templatename) {
 
        while (fgets(inbuf, sizeof inbuf, fp) != NULL) {
                strcpy(outbuf, "");
-               olen = 0;
 
-               for (i=0; i<strlen(inbuf); ++i) {
-                       if (strncmp(&inbuf[i], "<?", 2)) {
-                               outbuf[olen] = inbuf[i];
-                               outbuf[++olen] = 0;
+               while (strlen(inbuf) > 0) {
+                       pos = (-1);
+                       for (i=strlen(inbuf); i>=0; --i) {
+                               if ((inbuf[i]=='<')&&(inbuf[i+1]=='?')) pos = i;
+                       }
+                       if (pos < 0) {
+                               wprintf("%s", inbuf);
+                               strcpy(inbuf, "");
                        }
                        else {
-                               pos = (-1);
-                               for (j=strlen(inbuf); j>=i;  --j)  {
-                                       if (inbuf[j]=='>') pos = j;
-                               }
-                               if (pos > 0) {
-                                       strncpy(key, &inbuf[i+2], pos-i-2);
-                                       print_value_of(key);
-                                       olen = strlen(outbuf);
-                                       i = pos;
-                               }
-                               else {
-                                       i = i + 2;
+                               strncpy(outbuf, inbuf, pos);
+                               outbuf[pos] = 0;
+                               wprintf("%s", outbuf);
+                               strcpy(inbuf, &inbuf[pos]);
+                               pos = 1;
+                               for (i=strlen(inbuf); i>=0; --i) {
+                                       if (inbuf[i]=='>') pos = i;
                                }
+                               strncpy(key, &inbuf[2], pos-2);
+                               key[pos-2] = 0;
+                               print_value_of(key);
+                               strcpy(inbuf, &inbuf[pos+1]);
                        }
                }
-               wprintf("%s", outbuf);
        }
 
        fclose(fp);
 }
+
+
+
+/*@}*/