5 * \defgroup Subst Variable substitution type stuff
6 * \ingroup CitadelConfig
12 #include <sys/types.h>
19 #include "webserver.h"
21 extern char *static_dirs[PATH_MAX]; /**< Disk representation */
23 HashList *WirelessTemplateCache;
24 HashList *WirelessLocalTemplateCache;
25 HashList *TemplateCache;
26 HashList *LocalTemplateCache;
30 typedef struct _WCTemplate {
34 WCTemplateToken **Tokens;
37 typedef struct _HashHandler {
40 WCHandlerFunc HandlerFunc;
43 void RegisterNS(const char *NSName, long len, int nMinArgs, int nMaxArgs, WCHandlerFunc HandlerFunc)
45 HashHandler *NewHandler;
47 NewHandler = (HashHandler*) malloc(sizeof(HashHandler));
48 NewHandler->nMinArgs = nMinArgs;
49 NewHandler->nMaxArgs = nMaxArgs;
50 NewHandler->HandlerFunc = HandlerFunc;
51 Put(GlobalNS, NSName, len, NewHandler, NULL);
56 * \brief debugging function to print array to log
58 void VarPrintTransition(void *vVar1, void *vVar2, int odd){}
60 * \brief debugging function to print array to log
62 void VarPrintEntry(const char *Key, void *vSubst, int odd)
65 lprintf(1,"Subst[%s] : ", Key);
66 ptr = (wcsubst*) vSubst;
68 switch(ptr->wcs_type) {
70 lprintf(1, " -> %s\n", ptr->wcs_value);
73 lprintf(1, " -> Server [%s]\n", ptr->wcs_value);
76 lprintf(1, " -> function at [%0xd]\n", ptr->wcs_function);
79 lprintf(1," WARNING: invalid type: [%ld]!\n", ptr->wcs_type);
86 * \brief Clear out the list of substitution variables local to this session
88 void clear_substs(struct wcsession *wc) {
90 if (wc->vars != NULL) {
92 DeleteHash(&wc->vars);
97 * \brief Clear out the list of substitution variables local to this session
99 void clear_local_substs(void) {
104 * \brief destructor; kill one entry.
106 void deletevar(void *data)
108 wcsubst *ptr = (wcsubst*)data;
109 // if ((wc->vars->wcs_type == WCS_STRING)
110 // || (wc->vars->wcs_type == WCS_SERVCMD)) {
111 if (ptr->wcs_type != WCS_FUNCTION)
112 free(ptr->wcs_value);
117 * \brief Add a substitution variable (local to this session) (strlen version...)
118 * \param keyname the replacementstring to substitute
119 * \param keytype the kind of the key
120 * \param format the format string ala printf
121 * \param ... the arguments to substitute in the formatstring
123 void SVPRINTF(char *keyname, int keytype, const char *format,...)
130 struct wcsession *WCC = WC;
132 keylen = strlen(keyname);
134 * First look if we're doing a replacement of
137 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
138 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
139 ptr = (wcsubst*)vPtr;
140 if (ptr->wcs_value != NULL)
141 free(ptr->wcs_value);
143 else /** Otherwise allocate a new one */
145 ptr = (wcsubst *) malloc(sizeof(wcsubst));
146 safestrncpy(ptr->wcs_key, keyname, sizeof ptr->wcs_key);
147 Put(WCC->vars, keyname, keylen, ptr, deletevar);
150 /** Format the string and save it */
152 va_start(arg_ptr, format);
153 vsnprintf(wbuf, sizeof wbuf, format, arg_ptr);
156 ptr->wcs_function = NULL;
157 ptr->wcs_type = keytype;
158 ptr->wcs_value = strdup(wbuf);
162 * \brief Add a substitution variable (local to this session)
163 * \param keyname the replacementstring to substitute
164 * \param keytype the kind of the key
165 * \param format the format string ala printf
166 * \param ... the arguments to substitute in the formatstring
168 void svprintf(char *keyname, size_t keylen, int keytype, const char *format,...)
174 struct wcsession *WCC = WC;
178 * First look if we're doing a replacement of
181 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
182 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
183 ptr = (wcsubst*)vPtr;
184 if (ptr->wcs_value != NULL)
185 free(ptr->wcs_value);
187 else /** Otherwise allocate a new one */
189 ptr = (wcsubst *) malloc(sizeof(wcsubst));
190 safestrncpy(ptr->wcs_key, keyname, sizeof ptr->wcs_key);
191 Put(WCC->vars, keyname, keylen, ptr, deletevar);
194 /** Format the string and save it */
196 va_start(arg_ptr, format);
197 len = vsnprintf(wbuf, sizeof wbuf, format, arg_ptr);
200 ptr->wcs_value = (char*) malloc(len + 1);
201 memcpy(ptr->wcs_value, wbuf, len + 1);
202 ptr->wcs_function = NULL;
203 ptr->wcs_type = keytype;
207 * \brief Add a substitution variable (local to this session)
208 * \param keyname the replacementstring to substitute
209 * \param keytype the kind of the key
210 * \param format the format string ala printf
211 * \param ... the arguments to substitute in the formatstring
213 void SVPut(char *keyname, size_t keylen, int keytype, char *Data)
217 struct wcsession *WCC = WC;
221 * First look if we're doing a replacement of
224 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
225 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
226 ptr = (wcsubst*)vPtr;
227 if (ptr->wcs_value != NULL)
228 free(ptr->wcs_value);
230 else /** Otherwise allocate a new one */
232 ptr = (wcsubst *) malloc(sizeof(wcsubst));
233 safestrncpy(ptr->wcs_key, keyname, sizeof ptr->wcs_key);
234 Put(WCC->vars, keyname, keylen, ptr, deletevar);
237 ptr->wcs_function = NULL;
238 ptr->wcs_type = keytype;
239 ptr->wcs_value = strdup(Data);
243 * \brief Add a substitution variable (local to this session) that does a callback
244 * \param keyname the keystring to substitute
245 * \param fcn_ptr the function callback to give the substitution string
247 void SVCallback(char *keyname, size_t keylen, var_callback_fptr fcn_ptr)
251 struct wcsession *WCC = WC;
254 * First look if we're doing a replacement of
257 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
258 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
259 ptr = (wcsubst*)vPtr;
260 if (ptr->wcs_value != NULL)
261 free(ptr->wcs_value);
263 else /** Otherwise allocate a new one */
265 ptr = (wcsubst *) malloc(sizeof(wcsubst));
266 safestrncpy(ptr->wcs_key, keyname, sizeof ptr->wcs_key);
267 Put(WCC->vars, keyname, keylen, ptr, deletevar);
270 ptr->wcs_value = NULL;
271 ptr->wcs_type = WCS_FUNCTION;
272 ptr->wcs_function = fcn_ptr;
274 inline void SVCALLBACK(char *keyname, var_callback_fptr fcn_ptr)
276 SVCallback(keyname, strlen(keyname), fcn_ptr);
282 * \brief back end for print_value_of() ... does a server command
283 * \param servcmd server command to execute on the citadel server
285 void pvo_do_cmd(char *servcmd) {
289 serv_getln(buf, sizeof buf);
295 wprintf("%s\n", &buf[4]);
301 wprintf("%s\n", &buf[4]);
308 * \brief Print the value of a variable
309 * \param keyname get a key to print
311 void print_value_of(const char *keyname, size_t keylen) {
312 struct wcsession *WCC = WC;
317 /*if (WCC->vars != NULL) PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
318 if (keyname[0] == '=') {
319 DoTemplate(keyname+1, keylen - 1, NULL);
321 /** Page-local variables */
322 if ((WCC->vars!= NULL) && GetHash(WCC->vars, keyname, keylen, &vVar)) {
323 ptr = (wcsubst*) vVar;
324 switch(ptr->wcs_type) {
326 wprintf("%s", (const char*)ptr->wcs_value);
329 pvo_do_cmd(ptr->wcs_value);
332 (*ptr->wcs_function) ();
335 lprintf(1,"WARNING: invalid value in SV-Hash at %s!", keyname);
341 void PutNewToken(WCTemplate *Template, WCTemplateToken *NewToken)
343 if (Template->nTokensUsed + 1 >= Template->TokenSpace) {
344 if (Template->TokenSpace <= 0) {
345 Template->Tokens = (WCTemplateToken**)malloc(
346 sizeof(WCTemplateToken*) * 10);
347 Template->TokenSpace = 10;
350 WCTemplateToken **NewTokens;
351 NewTokens= (WCTemplateToken**)malloc(
352 sizeof(WCTemplateToken*) *
353 Template->TokenSpace * 2);
354 memcpy(NewTokens, Template->Tokens,
355 sizeof(WCTemplateToken) * Template->nTokensUsed);
356 free(Template->Tokens);
357 Template->TokenSpace *= 2;
358 Template->Tokens = NewTokens;
361 Template->Tokens[(Template->nTokensUsed)++] = NewToken;
364 TemplateParam *GetNextParamter(StrBuf *Buf, const char **pCh, const char *pe)
366 const char *pch = *pCh;
367 const char *pchs, *pche;
368 TemplateParam *Parm = (TemplateParam *) malloc(sizeof(TemplateParam));
371 /* Skip leading whitespaces */
372 while ((*pch == ' ' )||
375 (*pch == '\n')) pch ++;
378 else if (*pch == '\'')
383 Parm->Type = TYPE_STR;
386 ( (pch > pchs) && (*(pch - 1) == '\\'))
392 lprintf(1, "Error evaluating template param [%s]\n", *pCh);
398 StrBufPeek(Buf, pch, -1, '\0');
400 Parm->len = pche - pchs;
401 pch ++; /* move after trailing quote */
405 Parm->Type = TYPE_LONG;
407 while ((pch <= pe) &&
414 StrBufPeek(Buf, pch, -1, '\0');
415 Parm->lvalue = atol(pchs);
421 lprintf(1, "Error evalating template long param [%s]", *pCh);
426 while ((*pch == ' ' )||
429 (*pch == '\n')) pch ++;
435 WCTemplateToken *NewTemplateSubstitute(StrBuf *Buf,
437 const char *pTmplStart,
438 const char *pTmplEnd)
441 TemplateParam *Param;
442 WCTemplateToken *NewToken = (WCTemplateToken*)malloc(sizeof(WCTemplateToken));
444 NewToken->IsGettext = 0;
445 NewToken->pTokenStart = pTmplStart;
446 NewToken->TokenStart = pTmplStart - pStart;
447 NewToken->TokenEnd = (pTmplEnd - pStart) - NewToken->TokenStart;
448 NewToken->pTokenEnd = pTmplEnd;
449 NewToken->NameEnd = NewToken->TokenEnd - 2;
451 StrBufPeek(Buf, pTmplStart, + 1, '\0');
452 StrBufPeek(Buf, pTmplEnd, -1, '\0');
453 pch = NewToken->pName = pTmplStart + 2;
455 NewToken->HaveParameters = 0;;
456 NewToken->nParameters = 0;
458 while (pch <= pTmplEnd - 1) {
460 StrBufPeek(Buf, pch, -1, '\0');
461 NewToken->NameEnd = pch - NewToken->pName;
463 while (pch <= pTmplEnd - 1) {
464 Param = GetNextParamter(Buf, &pch, pTmplEnd - 1);
466 NewToken->HaveParameters = 1;
467 if (NewToken->nParameters > MAXPARAM) {
468 lprintf(1, "Only %ld Tokens supported!\n", MAXPARAM);
471 NewToken->Params[NewToken->nParameters++] = Param;
475 if((NewToken->NameEnd == 1) &&
476 (NewToken->HaveParameters == 1) &&
477 (NewToken->nParameters == 1) &&
478 (*(NewToken->pName) == '_'))
479 NewToken->IsGettext = 1;
486 void FreeWCTemplate(void *vFreeMe)
489 WCTemplate *FreeMe = (WCTemplate*)vFreeMe;
491 if (FreeMe->TokenSpace > 0) {
492 for (i = 0; i < FreeMe->nTokensUsed; i ++) {
493 free(FreeMe->Tokens[i]);
495 free(FreeMe->Tokens);
500 void EvaluateToken(StrBuf *Target, WCTemplateToken *Token, void *Context)
503 // much output, since pName is not terminated...
504 // lprintf(1,"Doing token: %s\n",Token->pName);
505 if (Token->IsGettext)
506 TmplGettext(Target, Token->nParameters, Token);
507 else if (GetHash(GlobalNS, Token->pName, Token->NameEnd, &vVar)) {
508 HashHandler *Handler;
509 Handler = (HashHandler*) vVar;
510 if ((Token->nParameters < Handler->nMinArgs) ||
511 (Token->nParameters < Handler->nMaxArgs)) {
512 lprintf(1, "Handler [%s] doesn't work with %ld params",
517 Handler->HandlerFunc(Target,
520 Context); /*TODO: subset of that */
526 print_value_of(Token->pName, Token->NameEnd);
530 void ProcessTemplate(WCTemplate *Tmpl, StrBuf *Target, void *Context)
534 const char *pData, *pS;
537 pS = pData = ChrPtr(Tmpl->Data);
538 len = StrLength(Tmpl->Data);
541 if (i >= Tmpl->nTokensUsed) {
542 StrBufAppendBufPlain(Target, pData, len, 0);
546 StrBufAppendBufPlain(
548 Tmpl->Tokens[i]->pTokenStart - pData, 0);
549 EvaluateToken(Target, Tmpl->Tokens[i], Context);
550 pData = Tmpl->Tokens[i++]->pTokenEnd + 1;
558 * \brief Display a variable-substituted template
559 * \param templatename template file to load
561 void *load_template(StrBuf *filename, StrBuf *Key, HashList *PutThere)
565 const char *pS, *pE, *pch, *Err;
567 WCTemplate *NewTemplate;
569 fd = open(ChrPtr(filename), O_RDONLY);
571 lprintf(1, "ERROR: could not open template '%s' - %s\n",
572 ChrPtr(filename), strerror(errno));
576 if (fstat(fd, &statbuf) == -1) {
577 lprintf(1, "ERROR: could not stat template '%s' - %s\n",
578 ChrPtr(filename), strerror(errno));
582 NewTemplate = (WCTemplate *) malloc(sizeof(WCTemplate));
583 NewTemplate->Data = NewStrBufPlain(NULL, statbuf.st_size);
584 NewTemplate->nTokensUsed = 0;
585 NewTemplate->TokenSpace = 0;
586 NewTemplate->Tokens = NULL;
587 if (StrBufReadBLOB(NewTemplate->Data, &fd, 1, statbuf.st_size, &Err) < 0) {
589 FreeWCTemplate(NewTemplate);
590 lprintf(1, "ERROR: reading template '%s' - %s<br />\n",
591 ChrPtr(filename), strerror(errno));
596 pS = pch = ChrPtr(NewTemplate->Data);
597 pE = pS + StrLength(NewTemplate->Data);
599 const char *pts, *pte;
601 int InDoubleQuotes = 0;
603 for (; pch < pE; pch ++) {
604 if ((*pch=='<')&&(*(pch + 1)=='?'))
610 for (; pch < pE - 1; pch ++) {
612 InDoubleQuotes = ! InDoubleQuotes;
613 else if (*pch == '\'')
614 InQuotes = ! InQuotes;
615 else if ((!InQuotes && !InDoubleQuotes) &&
616 ((*pch!='\\')&&(*(pch + 1)=='>'))) {
624 PutNewToken(NewTemplate,
625 NewTemplateSubstitute(NewTemplate->Data, pS, pts, pte));
628 Put(PutThere, ChrPtr(Key), StrLength(Key), NewTemplate, FreeWCTemplate);
633 * \brief Display a variable-substituted template
634 * \param templatename template file to load
636 void DoTemplate(const char *templatename, long len, void *Context)
639 HashList *StaticLocal;
643 Static = WirelessTemplateCache;
644 StaticLocal = WirelessLocalTemplateCache;
647 Static = TemplateCache;
648 StaticLocal = LocalTemplateCache;
651 if (!GetHash(StaticLocal, templatename, len, &vTmpl) &&
652 !GetHash(Static, templatename, len, &vTmpl)) {
653 printf ("didn't find %s\n", templatename);
658 ProcessTemplate(vTmpl, WC->WBuf, Context);
661 int LoadTemplateDir(const char *DirName, HashList *wireless, HashList *big)
667 struct dirent *filedir_entry;
673 StrBufPrintf(Dir, "%s/t", DirName);
674 filedir = opendir (ChrPtr(Dir));
675 if (filedir == NULL) {
679 FileName = NewStrBuf();
681 while ((filedir_entry = readdir(filedir)))
685 #ifdef _DIRENT_HAVE_D_NAMELEN
686 d_namelen = filedir_entry->d_namelen;
688 d_namelen = strlen(filedir_entry->d_name);
690 d_without_ext = d_namelen;
691 while ((d_without_ext > 0) && (filedir_entry->d_name[d_without_ext] != '.'))
693 if ((d_without_ext == 0) || (d_namelen < 3))
696 IsMobile = (strstr(filedir_entry->d_name, ".m.html")!= NULL);
697 PStart = filedir_entry->d_name;
698 StrBufPrintf(FileName, "%s/%s", ChrPtr(Dir), filedir_entry->d_name);
699 MinorPtr = strchr(filedir_entry->d_name, '.');
700 if (MinorPtr != NULL)
702 StrBufPlain(Tag, filedir_entry->d_name, MinorPtr - filedir_entry->d_name);
705 printf("%s %d %s\n",ChrPtr(FileName), IsMobile, ChrPtr(Tag));
706 load_template(FileName, Tag, (IsMobile)?wireless:big);
709 FreeStrBuf(&FileName);
715 void InitTemplateCache(void)
717 LoadTemplateDir(static_dirs[0],
718 WirelessTemplateCache,
720 LoadTemplateDir(static_dirs[1],
721 WirelessLocalTemplateCache,
725 void tmplput_serv_ip(StrBuf *Target, int nArgs, WCTemplateToken *Tokens, void *Context)
727 StrBufAppendPrintf(Target, "%d", WC->ctdl_pid);
730 void tmplput_serv_nodename(StrBuf *Target, int nArgs, WCTemplateToken *Tokens, void *Context)
732 escputs(serv_info.serv_nodename); ////TODO: respcect Target
735 void tmplput_serv_humannode(StrBuf *Target, int nArgs, WCTemplateToken *Tokens, void *Context)
737 escputs(serv_info.serv_humannode);////TODO: respcect Target
740 void tmplput_serv_fqdn(StrBuf *Target, int nArgs, WCTemplateToken *Tokens, void *Context)
742 escputs(serv_info.serv_fqdn);////TODO: respcect Target
745 void tmmplput_serv_software(StrBuf *Target, int nArgs, WCTemplateToken *Tokens, void *Context)
747 escputs(serv_info.serv_software);////TODO: respcect Target
750 void tmplput_serv_rev_level(StrBuf *Target, int nArgs, WCTemplateToken *Tokens, void *Context)
752 StrBufAppendPrintf(Target, "%d.%02d",
753 serv_info.serv_rev_level / 100,
754 serv_info.serv_rev_level % 100);
757 void tmmplput_serv_bbs_city(StrBuf *Target, int nArgs, WCTemplateToken *Tokens, void *Context)
759 escputs(serv_info.serv_bbs_city);////TODO: respcect Target
762 void tmplput_current_user(StrBuf *Target, int nArgs, WCTemplateToken *Tokens, void *Context)
764 escputs(WC->wc_fullname);////TODO: respcect Target
767 void tmplput_current_room(StrBuf *Target, int nArgs, WCTemplateToken *Tokens, void *Context)
769 escputs(WC->wc_roomname);////TODO: respcect Target
776 RegisterNS(HKEY("SERV_PID"), 0, 0, tmplput_serv_ip);
777 RegisterNS(HKEY("SERV_NODENAME"), 0, 0, tmplput_serv_nodename);
778 RegisterNS(HKEY("SERV_HUMANNODE"), 0, 0, tmplput_serv_humannode);
779 RegisterNS(HKEY("SERV_FQDN"), 0, 0, tmplput_serv_fqdn);
780 RegisterNS(HKEY("SERV_SOFTWARE"), 0, 0, tmmplput_serv_software);
781 RegisterNS(HKEY("SERV_REV_LEVEL"), 0, 0, tmplput_serv_rev_level);
782 RegisterNS(HKEY("SERV_BBS_CITY"), 0, 0, tmmplput_serv_bbs_city);
783 RegisterNS(HKEY("CURRENT_USER"), 0, 0, tmplput_current_user);
784 RegisterNS(HKEY("CURRENT_ROOM"), 0, 0, tmplput_current_room);