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);
283 * \brief back end for print_value_of() ... does a server command
284 * \param servcmd server command to execute on the citadel server
286 void pvo_do_cmd(char *servcmd) {
290 serv_getln(buf, sizeof buf);
296 wprintf("%s\n", &buf[4]);
302 wprintf("%s\n", &buf[4]);
309 * \brief Print the value of a variable
310 * \param keyname get a key to print
312 void print_value_of(const char *keyname, size_t keylen) {
313 struct wcsession *WCC = WC;
318 /*if (WCC->vars != NULL) PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
319 if (keyname[0] == '=') {
320 DoTemplate(keyname+1, keylen - 1, NULL, NULL);
322 /** Page-local variables */
323 if ((WCC->vars!= NULL) && GetHash(WCC->vars, keyname, keylen, &vVar)) {
324 ptr = (wcsubst*) vVar;
325 switch(ptr->wcs_type) {
327 wprintf("%s", (const char*)ptr->wcs_value);
330 pvo_do_cmd(ptr->wcs_value);
333 (*ptr->wcs_function) ();
336 lprintf(1,"WARNING: invalid value in SV-Hash at %s!", keyname);
342 void PutNewToken(WCTemplate *Template, WCTemplateToken *NewToken)
344 if (Template->nTokensUsed + 1 >= Template->TokenSpace) {
345 if (Template->TokenSpace <= 0) {
346 Template->Tokens = (WCTemplateToken**)malloc(
347 sizeof(WCTemplateToken*) * 10);
348 Template->TokenSpace = 10;
351 WCTemplateToken **NewTokens;
352 NewTokens= (WCTemplateToken**)malloc(
353 sizeof(WCTemplateToken*) *
354 Template->TokenSpace * 2);
355 memcpy(NewTokens, Template->Tokens,
356 sizeof(WCTemplateToken) * Template->nTokensUsed);
357 free(Template->Tokens);
358 Template->TokenSpace *= 2;
359 Template->Tokens = NewTokens;
362 Template->Tokens[(Template->nTokensUsed)++] = NewToken;
365 TemplateParam *GetNextParamter(StrBuf *Buf, const char **pCh, const char *pe)
367 const char *pch = *pCh;
368 const char *pchs, *pche;
369 TemplateParam *Parm = (TemplateParam *) malloc(sizeof(TemplateParam));
372 /* Skip leading whitespaces */
373 while ((*pch == ' ' )||
376 (*pch == '\n')) pch ++;
379 else if (*pch == '\'')
384 Parm->Type = TYPE_STR;
387 ( (pch > pchs) && (*(pch - 1) == '\\'))
393 lprintf(1, "Error evaluating template param [%s]\n", *pCh);
399 StrBufPeek(Buf, pch, -1, '\0');
401 Parm->len = pche - pchs;
402 pch ++; /* move after trailing quote */
406 Parm->Type = TYPE_LONG;
408 while ((pch <= pe) &&
415 StrBufPeek(Buf, pch, -1, '\0');
416 Parm->lvalue = atol(pchs);
422 lprintf(1, "Error evalating template long param [%s]", *pCh);
427 while ((*pch == ' ' )||
430 (*pch == '\n')) pch ++;
436 WCTemplateToken *NewTemplateSubstitute(StrBuf *Buf,
438 const char *pTmplStart,
439 const char *pTmplEnd)
442 TemplateParam *Param;
443 WCTemplateToken *NewToken = (WCTemplateToken*)malloc(sizeof(WCTemplateToken));
445 NewToken->IsGettext = 0;
446 NewToken->pTokenStart = pTmplStart;
447 NewToken->TokenStart = pTmplStart - pStart;
448 NewToken->TokenEnd = (pTmplEnd - pStart) - NewToken->TokenStart;
449 NewToken->pTokenEnd = pTmplEnd;
450 NewToken->NameEnd = NewToken->TokenEnd - 2;
452 StrBufPeek(Buf, pTmplStart, + 1, '\0');
453 StrBufPeek(Buf, pTmplEnd, -1, '\0');
454 pch = NewToken->pName = pTmplStart + 2;
456 NewToken->HaveParameters = 0;;
457 NewToken->nParameters = 0;
459 while (pch <= pTmplEnd - 1) {
461 StrBufPeek(Buf, pch, -1, '\0');
462 NewToken->NameEnd = pch - NewToken->pName;
464 while (pch <= pTmplEnd - 1) {
465 Param = GetNextParamter(Buf, &pch, pTmplEnd - 1);
467 NewToken->HaveParameters = 1;
468 if (NewToken->nParameters > MAXPARAM) {
469 lprintf(1, "Only %ld Tokens supported!\n", MAXPARAM);
472 NewToken->Params[NewToken->nParameters++] = Param;
476 if((NewToken->NameEnd == 1) &&
477 (NewToken->HaveParameters == 1) &&
478 (NewToken->nParameters == 1) &&
479 (*(NewToken->pName) == '_'))
480 NewToken->IsGettext = 1;
487 void FreeWCTemplate(void *vFreeMe)
490 WCTemplate *FreeMe = (WCTemplate*)vFreeMe;
492 if (FreeMe->TokenSpace > 0) {
493 for (i = 0; i < FreeMe->nTokensUsed; i ++) {
494 free(FreeMe->Tokens[i]);
496 free(FreeMe->Tokens);
501 void EvaluateToken(StrBuf *Target, WCTemplateToken *Token, void *Context)
504 // much output, since pName is not terminated...
505 // lprintf(1,"Doing token: %s\n",Token->pName);
506 if (Token->IsGettext)
507 TmplGettext(Target, Token->nParameters, Token);
508 else if (GetHash(GlobalNS, Token->pName, Token->NameEnd, &vVar)) {
509 HashHandler *Handler;
510 Handler = (HashHandler*) vVar;
511 if ((Token->nParameters < Handler->nMinArgs) ||
512 (Token->nParameters < Handler->nMaxArgs)) {
513 lprintf(1, "Handler [%s] doesn't work with %ld params",
518 Handler->HandlerFunc(Target,
521 Context); /*TODO: subset of that */
527 print_value_of(Token->pName, Token->NameEnd);
531 void ProcessTemplate(WCTemplate *Tmpl, StrBuf *Target, void *Context)
535 const char *pData, *pS;
538 pS = pData = ChrPtr(Tmpl->Data);
539 len = StrLength(Tmpl->Data);
542 if (i >= Tmpl->nTokensUsed) {
543 StrBufAppendBufPlain(Target, pData, len, 0);
547 StrBufAppendBufPlain(
549 Tmpl->Tokens[i]->pTokenStart - pData, 0);
550 EvaluateToken(Target, Tmpl->Tokens[i], Context);
551 pData = Tmpl->Tokens[i++]->pTokenEnd + 1;
559 * \brief Display a variable-substituted template
560 * \param templatename template file to load
562 void *load_template(StrBuf *filename, StrBuf *Key, HashList *PutThere)
566 const char *pS, *pE, *pch, *Err;
568 WCTemplate *NewTemplate;
570 fd = open(ChrPtr(filename), O_RDONLY);
572 lprintf(1, "ERROR: could not open template '%s' - %s\n",
573 ChrPtr(filename), strerror(errno));
577 if (fstat(fd, &statbuf) == -1) {
578 lprintf(1, "ERROR: could not stat template '%s' - %s\n",
579 ChrPtr(filename), strerror(errno));
583 NewTemplate = (WCTemplate *) malloc(sizeof(WCTemplate));
584 NewTemplate->Data = NewStrBufPlain(NULL, statbuf.st_size);
585 NewTemplate->nTokensUsed = 0;
586 NewTemplate->TokenSpace = 0;
587 NewTemplate->Tokens = NULL;
588 if (StrBufReadBLOB(NewTemplate->Data, &fd, 1, statbuf.st_size, &Err) < 0) {
590 FreeWCTemplate(NewTemplate);
591 lprintf(1, "ERROR: reading template '%s' - %s<br />\n",
592 ChrPtr(filename), strerror(errno));
597 pS = pch = ChrPtr(NewTemplate->Data);
598 pE = pS + StrLength(NewTemplate->Data);
600 const char *pts, *pte;
602 int InDoubleQuotes = 0;
604 for (; pch < pE; pch ++) {
605 if ((*pch=='<')&&(*(pch + 1)=='?'))
611 for (; pch < pE - 1; pch ++) {
613 InDoubleQuotes = ! InDoubleQuotes;
614 else if (*pch == '\'')
615 InQuotes = ! InQuotes;
616 else if ((!InQuotes && !InDoubleQuotes) &&
617 ((*pch!='\\')&&(*(pch + 1)=='>'))) {
625 PutNewToken(NewTemplate,
626 NewTemplateSubstitute(NewTemplate->Data, pS, pts, pte));
629 Put(PutThere, ChrPtr(Key), StrLength(Key), NewTemplate, FreeWCTemplate);
634 * \brief Display a variable-substituted template
635 * \param templatename template file to load
637 void DoTemplate(const char *templatename, long len, void *Context, StrBuf *Target)
640 HashList *StaticLocal;
644 Static = WirelessTemplateCache;
645 StaticLocal = WirelessLocalTemplateCache;
648 Static = TemplateCache;
649 StaticLocal = LocalTemplateCache;
652 if (!GetHash(StaticLocal, templatename, len, &vTmpl) &&
653 !GetHash(Static, templatename, len, &vTmpl)) {
654 printf ("didn't find %s\n", templatename);
659 ProcessTemplate(vTmpl, WC->WBuf, Context);
662 int LoadTemplateDir(const char *DirName, HashList *wireless, HashList *big)
668 struct dirent *filedir_entry;
674 StrBufPrintf(Dir, "%s/t", DirName);
675 filedir = opendir (ChrPtr(Dir));
676 if (filedir == NULL) {
680 FileName = NewStrBuf();
682 while ((filedir_entry = readdir(filedir)))
686 #ifdef _DIRENT_HAVE_D_NAMELEN
687 d_namelen = filedir_entry->d_namelen;
689 d_namelen = strlen(filedir_entry->d_name);
691 d_without_ext = d_namelen;
692 while ((d_without_ext > 0) && (filedir_entry->d_name[d_without_ext] != '.'))
694 if ((d_without_ext == 0) || (d_namelen < 3))
697 IsMobile = (strstr(filedir_entry->d_name, ".m.html")!= NULL);
698 PStart = filedir_entry->d_name;
699 StrBufPrintf(FileName, "%s/%s", ChrPtr(Dir), filedir_entry->d_name);
700 MinorPtr = strchr(filedir_entry->d_name, '.');
701 if (MinorPtr != NULL)
703 StrBufPlain(Tag, filedir_entry->d_name, MinorPtr - filedir_entry->d_name);
706 printf("%s %d %s\n",ChrPtr(FileName), IsMobile, ChrPtr(Tag));
707 load_template(FileName, Tag, (IsMobile)?wireless:big);
710 FreeStrBuf(&FileName);
716 void InitTemplateCache(void)
718 LoadTemplateDir(static_dirs[0],
719 WirelessTemplateCache,
721 LoadTemplateDir(static_dirs[1],
722 WirelessLocalTemplateCache,
726 void tmplput_serv_ip(StrBuf *Target, int nArgs, WCTemplateToken *Tokens, void *Context)
728 StrBufAppendPrintf(Target, "%d", WC->ctdl_pid);
731 void tmplput_serv_nodename(StrBuf *Target, int nArgs, WCTemplateToken *Tokens, void *Context)
733 escputs(serv_info.serv_nodename); ////TODO: respcect Target
736 void tmplput_serv_humannode(StrBuf *Target, int nArgs, WCTemplateToken *Tokens, void *Context)
738 escputs(serv_info.serv_humannode);////TODO: respcect Target
741 void tmplput_serv_fqdn(StrBuf *Target, int nArgs, WCTemplateToken *Tokens, void *Context)
743 escputs(serv_info.serv_fqdn);////TODO: respcect Target
746 void tmmplput_serv_software(StrBuf *Target, int nArgs, WCTemplateToken *Tokens, void *Context)
748 escputs(serv_info.serv_software);////TODO: respcect Target
751 void tmplput_serv_rev_level(StrBuf *Target, int nArgs, WCTemplateToken *Tokens, void *Context)
753 StrBufAppendPrintf(Target, "%d.%02d",
754 serv_info.serv_rev_level / 100,
755 serv_info.serv_rev_level % 100);
758 void tmmplput_serv_bbs_city(StrBuf *Target, int nArgs, WCTemplateToken *Tokens, void *Context)
760 escputs(serv_info.serv_bbs_city);////TODO: respcect Target
763 void tmplput_current_user(StrBuf *Target, int nArgs, WCTemplateToken *Tokens, void *Context)
765 escputs(WC->wc_fullname);////TODO: respcect Target
768 void tmplput_current_room(StrBuf *Target, int nArgs, WCTemplateToken *Tokens, void *Context)
770 escputs(WC->wc_roomname);////TODO: respcect Target
774 typedef struct _HashIterator {
775 HashList *StaticList;
776 RetrieveHashlistFunc GetHash;
777 HashDestructorFunc Destructor;
778 SubTemplFunc DoSubTemplate;
781 void tmpl_iterate_subtmpl(StrBuf *Target, int nArgs, WCTemplateToken *Tokens, void *Context)
792 if (!GetHash(Iterators,
793 Tokens->Params[0]->Start,
794 Tokens->Params[0]->len,
797 It = (HashIterator*) vIt;
798 if (It->StaticList == NULL)
799 List = It->GetHash();
801 List = It->StaticList;
803 SubBuf = NewStrBuf();
804 it = GetNewHashPos();
805 while (GetNextHashPos(List, it, &len, &Key, &vContext)) {
806 It->DoSubTemplate(SubBuf, vContext);
807 DoTemplate(Tokens->Params[0]->Start,
808 Tokens->Params[0]->len,
811 StrBufAppendBuf(Target, SubBuf, 0);
815 It->Destructor(List);
819 void RegisterITERATOR(const char *Name, long len,
820 HashList *StaticList,
821 RetrieveHashlistFunc GetHash,
822 SubTemplFunc DoSubTempl,
823 HashDestructorFunc Destructor)
825 HashIterator *It = (HashIterator*)malloc(sizeof(HashIterator));
826 It->StaticList = StaticList;
827 It->GetHash = GetHash;
828 It->DoSubTemplate = DoSubTempl;
829 It->Destructor = Destructor;
830 Put(Iterators, Name, len, It, NULL);
837 RegisterNamespace("SERV_PID", 0, 0, tmplput_serv_ip);
838 RegisterNamespace("SERV_NODENAME", 0, 0, tmplput_serv_nodename);
839 RegisterNamespace("SERV_HUMANNODE", 0, 0, tmplput_serv_humannode);
840 RegisterNamespace("SERV_FQDN", 0, 0, tmplput_serv_fqdn);
841 RegisterNamespace("SERV_SOFTWARE", 0, 0, tmmplput_serv_software);
842 RegisterNamespace("SERV_REV_LEVEL", 0, 0, tmplput_serv_rev_level);
843 RegisterNamespace("SERV_BBS_CITY", 0, 0, tmmplput_serv_bbs_city);
844 RegisterNamespace("CURRENT_USER", 0, 0, tmplput_current_user);
845 RegisterNamespace("CURRENT_ROOM", 0, 0, tmplput_current_room);
846 RegisterNamespace("ITERATE", 2, 4, tmpl_iterate_subtmpl);