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;
31 typedef struct _WCTemplate {
35 WCTemplateToken **Tokens;
38 typedef struct _HashHandler {
41 WCHandlerFunc HandlerFunc;
44 void RegisterNS(const char *NSName, long len, int nMinArgs, int nMaxArgs, WCHandlerFunc HandlerFunc)
46 HashHandler *NewHandler;
48 NewHandler = (HashHandler*) malloc(sizeof(HashHandler));
49 NewHandler->nMinArgs = nMinArgs;
50 NewHandler->nMaxArgs = nMaxArgs;
51 NewHandler->HandlerFunc = HandlerFunc;
52 Put(GlobalNS, NSName, len, NewHandler, NULL);
57 * \brief debugging function to print array to log
59 void VarPrintTransition(void *vVar1, void *vVar2, int odd){}
61 * \brief debugging function to print array to log
63 void VarPrintEntry(const char *Key, void *vSubst, int odd)
66 lprintf(1,"Subst[%s] : ", Key);
67 ptr = (wcsubst*) vSubst;
69 switch(ptr->wcs_type) {
71 lprintf(1, " -> %s\n", ptr->wcs_value);
74 lprintf(1, " -> Server [%s]\n", ptr->wcs_value);
77 lprintf(1, " -> function at [%0xd]\n", ptr->wcs_function);
80 lprintf(1," WARNING: invalid type: [%ld]!\n", ptr->wcs_type);
87 * \brief Clear out the list of substitution variables local to this session
89 void clear_substs(struct wcsession *wc) {
91 if (wc->vars != NULL) {
93 DeleteHash(&wc->vars);
98 * \brief Clear out the list of substitution variables local to this session
100 void clear_local_substs(void) {
105 * \brief destructor; kill one entry.
107 void deletevar(void *data)
109 wcsubst *ptr = (wcsubst*)data;
110 // if ((wc->vars->wcs_type == WCS_STRING)
111 // || (wc->vars->wcs_type == WCS_SERVCMD)) {
112 if (ptr->wcs_type != WCS_FUNCTION)
113 free(ptr->wcs_value);
118 * \brief Add a substitution variable (local to this session) (strlen version...)
119 * \param keyname the replacementstring to substitute
120 * \param keytype the kind of the key
121 * \param format the format string ala printf
122 * \param ... the arguments to substitute in the formatstring
124 void SVPRINTF(char *keyname, int keytype, const char *format,...)
131 struct wcsession *WCC = WC;
133 keylen = strlen(keyname);
135 * First look if we're doing a replacement of
138 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
139 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
140 ptr = (wcsubst*)vPtr;
141 if (ptr->wcs_value != NULL)
142 free(ptr->wcs_value);
144 else /** Otherwise allocate a new one */
146 ptr = (wcsubst *) malloc(sizeof(wcsubst));
147 safestrncpy(ptr->wcs_key, keyname, sizeof ptr->wcs_key);
148 Put(WCC->vars, keyname, keylen, ptr, deletevar);
151 /** Format the string and save it */
153 va_start(arg_ptr, format);
154 vsnprintf(wbuf, sizeof wbuf, format, arg_ptr);
157 ptr->wcs_function = NULL;
158 ptr->wcs_type = keytype;
159 ptr->wcs_value = strdup(wbuf);
163 * \brief Add a substitution variable (local to this session)
164 * \param keyname the replacementstring to substitute
165 * \param keytype the kind of the key
166 * \param format the format string ala printf
167 * \param ... the arguments to substitute in the formatstring
169 void svprintf(char *keyname, size_t keylen, int keytype, const char *format,...)
175 struct wcsession *WCC = WC;
179 * First look if we're doing a replacement of
182 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
183 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
184 ptr = (wcsubst*)vPtr;
185 if (ptr->wcs_value != NULL)
186 free(ptr->wcs_value);
188 else /** Otherwise allocate a new one */
190 ptr = (wcsubst *) malloc(sizeof(wcsubst));
191 safestrncpy(ptr->wcs_key, keyname, sizeof ptr->wcs_key);
192 Put(WCC->vars, keyname, keylen, ptr, deletevar);
195 /** Format the string and save it */
197 va_start(arg_ptr, format);
198 len = vsnprintf(wbuf, sizeof wbuf, format, arg_ptr);
201 ptr->wcs_value = (char*) malloc(len + 1);
202 memcpy(ptr->wcs_value, wbuf, len + 1);
203 ptr->wcs_function = NULL;
204 ptr->wcs_type = keytype;
208 * \brief Add a substitution variable (local to this session)
209 * \param keyname the replacementstring to substitute
210 * \param keytype the kind of the key
211 * \param format the format string ala printf
212 * \param ... the arguments to substitute in the formatstring
214 void SVPut(char *keyname, size_t keylen, int keytype, char *Data)
218 struct wcsession *WCC = WC;
222 * First look if we're doing a replacement of
225 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
226 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
227 ptr = (wcsubst*)vPtr;
228 if (ptr->wcs_value != NULL)
229 free(ptr->wcs_value);
231 else /** Otherwise allocate a new one */
233 ptr = (wcsubst *) malloc(sizeof(wcsubst));
234 safestrncpy(ptr->wcs_key, keyname, sizeof ptr->wcs_key);
235 Put(WCC->vars, keyname, keylen, ptr, deletevar);
238 ptr->wcs_function = NULL;
239 ptr->wcs_type = keytype;
240 ptr->wcs_value = strdup(Data);
244 * \brief Add a substitution variable (local to this session) that does a callback
245 * \param keyname the keystring to substitute
246 * \param fcn_ptr the function callback to give the substitution string
248 void SVCallback(char *keyname, size_t keylen, var_callback_fptr fcn_ptr)
252 struct wcsession *WCC = WC;
255 * First look if we're doing a replacement of
258 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
259 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
260 ptr = (wcsubst*)vPtr;
261 if (ptr->wcs_value != NULL)
262 free(ptr->wcs_value);
264 else /** Otherwise allocate a new one */
266 ptr = (wcsubst *) malloc(sizeof(wcsubst));
267 safestrncpy(ptr->wcs_key, keyname, sizeof ptr->wcs_key);
268 Put(WCC->vars, keyname, keylen, ptr, deletevar);
271 ptr->wcs_value = NULL;
272 ptr->wcs_type = WCS_FUNCTION;
273 ptr->wcs_function = fcn_ptr;
275 inline void SVCALLBACK(char *keyname, var_callback_fptr fcn_ptr)
277 SVCallback(keyname, strlen(keyname), fcn_ptr);
282 void SVPUTBuf(const char *keyname, int keylen, StrBuf *Buf, int ref)
286 struct wcsession *WCC = WC;
289 * First look if we're doing a replacement of
292 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
293 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
294 ptr = (wcsubst*)vPtr;
295 if (ptr->wcs_value != NULL)
296 free(ptr->wcs_value);///TODO: respect type
298 else /** Otherwise allocate a new one */
300 ptr = (wcsubst *) malloc(sizeof(wcsubst));
301 safestrncpy(ptr->wcs_key, keyname, sizeof ptr->wcs_key);
302 Put(WCC->vars, keyname, keylen, ptr, deletevar);
305 ptr->wcs_value = NULL;
306 ptr->wcs_type = (ref)?WCS_STRBUF:WCS_STRBUF_REF;
307 ptr->wcs_function = (var_callback_fptr) Buf; ////TODO
311 * \brief back end for print_value_of() ... does a server command
312 * \param servcmd server command to execute on the citadel server
314 void pvo_do_cmd(StrBuf *Target, char *servcmd) {
319 len = serv_getln(buf, sizeof buf);
325 StrBufAppendPrintf(Target, "%s\n", &buf[4]);
328 _fmout(Target, "CENTER");
331 StrBufAppendPrintf(Target, "%s\n", &buf[4]);
338 * \brief Print the value of a variable
339 * \param keyname get a key to print
341 void print_value_of(StrBuf *Target, const char *keyname, size_t keylen) {
342 struct wcsession *WCC = WC;
347 /*if (WCC->vars != NULL) PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
348 if (keyname[0] == '=') {
349 DoTemplate(keyname+1, keylen - 1, NULL, NULL);
351 /** Page-local variables */
352 if ((WCC->vars!= NULL) && GetHash(WCC->vars, keyname, keylen, &vVar)) {
353 ptr = (wcsubst*) vVar;
354 switch(ptr->wcs_type) {
356 StrBufAppendBufPlain(Target, (const char*)ptr->wcs_value, -1, 0);
359 pvo_do_cmd(Target, ptr->wcs_value);
362 (*ptr->wcs_function) ();
366 StrBufAppendBuf(Target, (StrBuf*) ptr->wcs_function, 0);
369 lprintf(1,"WARNING: invalid value in SV-Hash at %s!", keyname);
375 void PutNewToken(WCTemplate *Template, WCTemplateToken *NewToken)
377 if (Template->nTokensUsed + 1 >= Template->TokenSpace) {
378 if (Template->TokenSpace <= 0) {
379 Template->Tokens = (WCTemplateToken**)malloc(
380 sizeof(WCTemplateToken*) * 10);
381 Template->TokenSpace = 10;
384 WCTemplateToken **NewTokens;
385 NewTokens= (WCTemplateToken**)malloc(
386 sizeof(WCTemplateToken*) *
387 Template->TokenSpace * 2);
388 memcpy(NewTokens, Template->Tokens,
389 sizeof(WCTemplateToken) * Template->nTokensUsed);
390 free(Template->Tokens);
391 Template->TokenSpace *= 2;
392 Template->Tokens = NewTokens;
395 Template->Tokens[(Template->nTokensUsed)++] = NewToken;
398 TemplateParam *GetNextParamter(StrBuf *Buf, const char **pCh, const char *pe)
400 const char *pch = *pCh;
401 const char *pchs, *pche;
402 TemplateParam *Parm = (TemplateParam *) malloc(sizeof(TemplateParam));
405 /* Skip leading whitespaces */
406 while ((*pch == ' ' )||
409 (*pch == '\n')) pch ++;
412 else if (*pch == '\'')
417 Parm->Type = TYPE_STR;
420 ( (pch > pchs) && (*(pch - 1) == '\\'))
426 lprintf(1, "Error evaluating template param [%s]\n", *pCh);
432 StrBufPeek(Buf, pch, -1, '\0');
433 lprintf(1, "DBG: got param [%s]\n", pchs);
435 Parm->len = pche - pchs;
436 pch ++; /* move after trailing quote */
440 Parm->Type = TYPE_LONG;
442 while ((pch <= pe) &&
449 StrBufPeek(Buf, pch, -1, '\0');
450 Parm->lvalue = atol(pchs);
456 lprintf(1, "Error evaluating template long param [%s]", *pCh);
461 while ((*pch == ' ' )||
465 (*pch == '\n')) pch ++;
471 WCTemplateToken *NewTemplateSubstitute(StrBuf *Buf,
473 const char *pTmplStart,
474 const char *pTmplEnd)
477 TemplateParam *Param;
478 WCTemplateToken *NewToken = (WCTemplateToken*)malloc(sizeof(WCTemplateToken));
480 NewToken->IsGettext = 0;
481 NewToken->pTokenStart = pTmplStart;
482 NewToken->TokenStart = pTmplStart - pStart;
483 NewToken->TokenEnd = (pTmplEnd - pStart) - NewToken->TokenStart;
484 NewToken->pTokenEnd = pTmplEnd;
485 NewToken->NameEnd = NewToken->TokenEnd - 2;
487 StrBufPeek(Buf, pTmplStart, + 1, '\0');
488 StrBufPeek(Buf, pTmplEnd, -1, '\0');
489 pch = NewToken->pName = pTmplStart + 2;
491 NewToken->HaveParameters = 0;;
492 NewToken->nParameters = 0;
494 while (pch < pTmplEnd - 1) {
496 StrBufPeek(Buf, pch, -1, '\0');
497 NewToken->NameEnd = pch - NewToken->pName;
499 while (pch < pTmplEnd - 1) {
500 Param = GetNextParamter(Buf, &pch, pTmplEnd - 1);
502 NewToken->HaveParameters = 1;
503 if (NewToken->nParameters > MAXPARAM) {
504 lprintf(1, "Only %ld Tokens supported!\n", MAXPARAM);
507 NewToken->Params[NewToken->nParameters++] = Param;
511 if((NewToken->NameEnd == 1) &&
512 (NewToken->HaveParameters == 1) &&
513 (NewToken->nParameters == 1) &&
514 (*(NewToken->pName) == '_'))
515 NewToken->IsGettext = 1;
522 void FreeWCTemplate(void *vFreeMe)
525 WCTemplate *FreeMe = (WCTemplate*)vFreeMe;
527 if (FreeMe->TokenSpace > 0) {
528 for (i = 0; i < FreeMe->nTokensUsed; i ++) {
529 free(FreeMe->Tokens[i]);
531 free(FreeMe->Tokens);
536 void EvaluateToken(StrBuf *Target, WCTemplateToken *Token, void *Context)
539 // much output, since pName is not terminated...
540 // lprintf(1,"Doing token: %s\n",Token->pName);
541 if (Token->IsGettext)
542 TmplGettext(Target, Token->nParameters, Token);
543 else if (GetHash(GlobalNS, Token->pName, Token->NameEnd, &vVar)) {
544 HashHandler *Handler;
545 Handler = (HashHandler*) vVar;
546 if ((Token->nParameters < Handler->nMinArgs) ||
547 (Token->nParameters > Handler->nMaxArgs)) {
548 lprintf(1, "Handler [%s] doesn't work with %ld params",
553 Handler->HandlerFunc(Target,
556 Context); /*TODO: subset of that */
562 print_value_of(Target, Token->pName, Token->NameEnd);
566 void ProcessTemplate(WCTemplate *Tmpl, StrBuf *Target, void *Context)
570 const char *pData, *pS;
573 pS = pData = ChrPtr(Tmpl->Data);
574 len = StrLength(Tmpl->Data);
577 if (i >= Tmpl->nTokensUsed) {
578 StrBufAppendBufPlain(Target,
580 len - (pData - pS), 0);
584 StrBufAppendBufPlain(
586 Tmpl->Tokens[i]->pTokenStart - pData, 0);
587 EvaluateToken(Target, Tmpl->Tokens[i], Context);
588 pData = Tmpl->Tokens[i++]->pTokenEnd + 1;
596 * \brief Display a variable-substituted template
597 * \param templatename template file to load
599 void *load_template(StrBuf *filename, StrBuf *Key, HashList *PutThere)
603 const char *pS, *pE, *pch, *Err;
605 WCTemplate *NewTemplate;
607 fd = open(ChrPtr(filename), O_RDONLY);
609 lprintf(1, "ERROR: could not open template '%s' - %s\n",
610 ChrPtr(filename), strerror(errno));
614 if (fstat(fd, &statbuf) == -1) {
615 lprintf(1, "ERROR: could not stat template '%s' - %s\n",
616 ChrPtr(filename), strerror(errno));
620 NewTemplate = (WCTemplate *) malloc(sizeof(WCTemplate));
621 NewTemplate->Data = NewStrBufPlain(NULL, statbuf.st_size);
622 NewTemplate->nTokensUsed = 0;
623 NewTemplate->TokenSpace = 0;
624 NewTemplate->Tokens = NULL;
625 if (StrBufReadBLOB(NewTemplate->Data, &fd, 1, statbuf.st_size, &Err) < 0) {
627 FreeWCTemplate(NewTemplate);
628 lprintf(1, "ERROR: reading template '%s' - %s<br />\n",
629 ChrPtr(filename), strerror(errno));
634 pS = pch = ChrPtr(NewTemplate->Data);
635 pE = pS + StrLength(NewTemplate->Data);
637 const char *pts, *pte;
639 int InDoubleQuotes = 0;
641 for (; pch < pE; pch ++) {
642 if ((*pch=='<')&&(*(pch + 1)=='?'))
648 for (; pch < pE - 1; pch ++) {
650 InDoubleQuotes = ! InDoubleQuotes;
651 else if (*pch == '\'')
652 InQuotes = ! InQuotes;
653 else if ((!InQuotes && !InDoubleQuotes) &&
654 ((*pch!='\\')&&(*(pch + 1)=='>'))) {
662 PutNewToken(NewTemplate,
663 NewTemplateSubstitute(NewTemplate->Data, pS, pts, pte));
666 Put(PutThere, ChrPtr(Key), StrLength(Key), NewTemplate, FreeWCTemplate);
671 * \brief Display a variable-substituted template
672 * \param templatename template file to load
674 void DoTemplate(const char *templatename, long len, void *Context, StrBuf *Target)
677 HashList *StaticLocal;
683 Static = WirelessTemplateCache;
684 StaticLocal = WirelessLocalTemplateCache;
687 Static = TemplateCache;
688 StaticLocal = LocalTemplateCache;
691 if (!GetHash(StaticLocal, templatename, len, &vTmpl) &&
692 !GetHash(Static, templatename, len, &vTmpl)) {
693 printf ("didn't find %s\n", templatename);
698 ProcessTemplate(vTmpl, Target, Context);
701 int LoadTemplateDir(const char *DirName, HashList *wireless, HashList *big)
707 struct dirent *filedir_entry;
713 StrBufPrintf(Dir, "%s/t", DirName);
714 filedir = opendir (ChrPtr(Dir));
715 if (filedir == NULL) {
719 FileName = NewStrBuf();
721 while ((filedir_entry = readdir(filedir)))
725 #ifdef _DIRENT_HAVE_D_NAMELEN
726 d_namelen = filedir_entry->d_namelen;
728 d_namelen = strlen(filedir_entry->d_name);
730 d_without_ext = d_namelen;
731 while ((d_without_ext > 0) && (filedir_entry->d_name[d_without_ext] != '.'))
733 if ((d_without_ext == 0) || (d_namelen < 3))
736 IsMobile = (strstr(filedir_entry->d_name, ".m.html")!= NULL);
737 PStart = filedir_entry->d_name;
738 StrBufPrintf(FileName, "%s/%s", ChrPtr(Dir), filedir_entry->d_name);
739 MinorPtr = strchr(filedir_entry->d_name, '.');
740 if (MinorPtr != NULL)
742 StrBufPlain(Tag, filedir_entry->d_name, MinorPtr - filedir_entry->d_name);
745 printf("%s %d %s\n",ChrPtr(FileName), IsMobile, ChrPtr(Tag));
746 load_template(FileName, Tag, (IsMobile)?wireless:big);
749 FreeStrBuf(&FileName);
755 void InitTemplateCache(void)
757 LoadTemplateDir(static_dirs[0],
758 WirelessTemplateCache,
760 LoadTemplateDir(static_dirs[1],
761 WirelessLocalTemplateCache,
765 void tmplput_serv_ip(StrBuf *Target, int nArgs, WCTemplateToken *Tokens, void *Context)
767 StrBufAppendPrintf(Target, "%d", WC->ctdl_pid);
770 void tmplput_serv_nodename(StrBuf *Target, int nArgs, WCTemplateToken *Tokens, void *Context)
772 escputs(serv_info.serv_nodename); ////TODO: respcect Target
775 void tmplput_serv_humannode(StrBuf *Target, int nArgs, WCTemplateToken *Tokens, void *Context)
777 escputs(serv_info.serv_humannode);////TODO: respcect Target
780 void tmplput_serv_fqdn(StrBuf *Target, int nArgs, WCTemplateToken *Tokens, void *Context)
782 escputs(serv_info.serv_fqdn);////TODO: respcect Target
785 void tmmplput_serv_software(StrBuf *Target, int nArgs, WCTemplateToken *Tokens, void *Context)
787 escputs(serv_info.serv_software);////TODO: respcect Target
790 void tmplput_serv_rev_level(StrBuf *Target, int nArgs, WCTemplateToken *Tokens, void *Context)
792 StrBufAppendPrintf(Target, "%d.%02d",
793 serv_info.serv_rev_level / 100,
794 serv_info.serv_rev_level % 100);
797 void tmmplput_serv_bbs_city(StrBuf *Target, int nArgs, WCTemplateToken *Tokens, void *Context)
799 escputs(serv_info.serv_bbs_city);////TODO: respcect Target
802 void tmplput_current_user(StrBuf *Target, int nArgs, WCTemplateToken *Tokens, void *Context)
804 escputs(WC->wc_fullname);////TODO: respcect Target
807 void tmplput_current_room(StrBuf *Target, int nArgs, WCTemplateToken *Tokens, void *Context)
809 escputs(WC->wc_roomname);////TODO: respcect Target
813 typedef struct _HashIterator {
814 HashList *StaticList;
815 RetrieveHashlistFunc GetHash;
816 HashDestructorFunc Destructor;
817 SubTemplFunc DoSubTemplate;
820 void tmpl_iterate_subtmpl(StrBuf *Target, int nArgs, WCTemplateToken *Tokens, void *Context)
831 if (!GetHash(Iterators,
832 Tokens->Params[0]->Start,
833 Tokens->Params[0]->len,
836 It = (HashIterator*) vIt;
837 if (It->StaticList == NULL)
838 List = It->GetHash();
840 List = It->StaticList;
842 SubBuf = NewStrBuf();
843 it = GetNewHashPos();
844 while (GetNextHashPos(List, it, &len, &Key, &vContext)) {
845 It->DoSubTemplate(SubBuf, vContext);
846 DoTemplate(Tokens->Params[1]->Start,
847 Tokens->Params[1]->len,
850 StrBufAppendBuf(Target, SubBuf, 0);
854 It->Destructor(List);
858 void RegisterITERATOR(const char *Name, long len,
859 HashList *StaticList,
860 RetrieveHashlistFunc GetHash,
861 SubTemplFunc DoSubTempl,
862 HashDestructorFunc Destructor)
864 HashIterator *It = (HashIterator*)malloc(sizeof(HashIterator));
865 It->StaticList = StaticList;
866 It->GetHash = GetHash;
867 It->DoSubTemplate = DoSubTempl;
868 It->Destructor = Destructor;
869 Put(Iterators, Name, len, It, NULL);
876 RegisterNamespace("SERV_PID", 0, 0, tmplput_serv_ip);
877 RegisterNamespace("SERV_NODENAME", 0, 0, tmplput_serv_nodename);
878 RegisterNamespace("SERV_HUMANNODE", 0, 0, tmplput_serv_humannode);
879 RegisterNamespace("SERV_FQDN", 0, 0, tmplput_serv_fqdn);
880 RegisterNamespace("SERV_SOFTWARE", 0, 0, tmmplput_serv_software);
881 RegisterNamespace("SERV_REV_LEVEL", 0, 0, tmplput_serv_rev_level);
882 RegisterNamespace("SERV_BBS_CITY", 0, 0, tmmplput_serv_bbs_city);
883 RegisterNamespace("CURRENT_USER", 0, 0, tmplput_current_user);
884 RegisterNamespace("CURRENT_ROOM", 0, 0, tmplput_current_room);
885 RegisterNamespace("ITERATE", 2, 4, tmpl_iterate_subtmpl);