5 * \defgroup Subst Variable substitution type stuff
6 * \ingroup CitadelConfig
12 #include <sys/types.h>
18 #define SHOW_ME_VAPPEND_PRINTF
21 #include "webserver.h"
23 extern char *static_dirs[PATH_MAX]; /**< Disk representation */
25 HashList *WirelessTemplateCache;
26 HashList *WirelessLocalTemplateCache;
27 HashList *TemplateCache;
28 HashList *LocalTemplateCache;
32 HashList *Conditionals;
34 int LoadTemplates = 0;
37 #define SV_CONDITIONAL 2
38 #define SV_NEG_CONDITIONAL 3
39 #define SV_CUST_STR_CONDITIONAL 4
41 #define SV_PREEVALUATED 6
43 typedef struct _WCTemplate {
48 WCTemplateToken **Tokens;
51 typedef struct _HashHandler {
55 WCHandlerFunc HandlerFunc;
58 void *load_template(StrBuf *filename, StrBuf *Key, HashList *PutThere);
60 void RegisterNS(const char *NSName,
64 WCHandlerFunc HandlerFunc,
67 HashHandler *NewHandler;
69 NewHandler = (HashHandler*) malloc(sizeof(HashHandler));
70 NewHandler->nMinArgs = nMinArgs;
71 NewHandler->nMaxArgs = nMaxArgs;
72 NewHandler->HandlerFunc = HandlerFunc;
73 NewHandler->ContextRequired = ContextRequired;
74 Put(GlobalNS, NSName, len, NewHandler, NULL);
77 void FreeToken(WCTemplateToken **Token)
80 FreeStrBuf(&(*Token)->FlatToken);
81 if ((*Token)->HaveParameters)
82 for (i = 0; i < (*Token)->nParameters; i++)
83 free((*Token)->Params[i]);
90 void FreeWCTemplate(void *vFreeMe)
93 WCTemplate *FreeMe = (WCTemplate*)vFreeMe;
95 if (FreeMe->TokenSpace > 0) {
96 for (i = 0; i < FreeMe->nTokensUsed; i ++) {
97 FreeToken(&FreeMe->Tokens[i]);
101 FreeStrBuf(&FreeMe->FileName);
102 FreeStrBuf(&FreeMe->Data);
108 * \brief debugging function to print array to log
110 void VarPrintTransition(void *vVar1, void *vVar2, int odd){}
112 * \brief debugging function to print array to log
114 void VarPrintEntry(const char *Key, void *vSubst, int odd)
117 lprintf(1,"Subst[%s] : ", Key);
118 ptr = (wcsubst*) vSubst;
120 switch(ptr->wcs_type) {
122 lprintf(1, " -> %s\n", ChrPtr(ptr->wcs_value));
125 lprintf(1, " -> Server [%s]\n", ChrPtr(ptr->wcs_value));
128 lprintf(1, " -> function at [%0xd]\n", ptr->wcs_function);
131 lprintf(1," WARNING: invalid type: [%ld]!\n", ptr->wcs_type);
138 * \brief Clear out the list of substitution variables local to this session
140 void clear_substs(struct wcsession *wc) {
142 if (wc->vars != NULL) {
143 DeleteHash(&wc->vars);
148 * \brief Clear out the list of substitution variables local to this session
150 void clear_local_substs(void) {
169 void FlushPayload(wcsubst *ptr, int reusestrbuf, int type)
171 int NeedNew = NeedNewBuf(type);
172 switch(ptr->wcs_type) {
176 if (reusestrbuf && NeedNew) {
177 FlushStrBuf(ptr->wcs_value);
181 FreeStrBuf(&ptr->wcs_value);
182 ptr->wcs_value = NULL;
186 ptr->wcs_function = NULL;
187 if (reusestrbuf && NeedNew)
188 ptr->wcs_value = NewStrBuf();
191 ptr->wcs_value = NULL;
192 if (reusestrbuf && NeedNew)
193 ptr->wcs_value = NewStrBuf();
197 if (reusestrbuf && NeedNew)
198 ptr->wcs_value = NewStrBuf();
201 if (reusestrbuf && NeedNew)
202 ptr->wcs_value = NewStrBuf();
209 * \brief destructor; kill one entry.
211 void deletevar(void *data)
213 wcsubst *ptr = (wcsubst*)data;
214 FlushPayload(ptr, 0, ptr->wcs_type);
219 wcsubst *NewSubstVar(const char *keyname, int keylen, int type)
222 struct wcsession *WCC = WC;
224 ptr = (wcsubst *) malloc(sizeof(wcsubst));
225 memset(ptr, 0, sizeof(wcsubst));
227 ptr->wcs_type = type;
228 safestrncpy(ptr->wcs_key, keyname, sizeof ptr->wcs_key);
229 Put(WCC->vars, keyname, keylen, ptr, deletevar);
231 switch(ptr->wcs_type) {
234 ptr->wcs_value = NewStrBuf();
248 * \brief Add a substitution variable (local to this session) (strlen version...)
249 * \param keyname the replacementstring to substitute
250 * \param keytype the kind of the key
251 * \param format the format string ala printf
252 * \param ... the arguments to substitute in the formatstring
254 void SVPRINTF(char *keyname, int keytype, const char *format,...)
260 struct wcsession *WCC = WC;
262 keylen = strlen(keyname);
264 * First look if we're doing a replacement of
267 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
268 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
269 ptr = (wcsubst*)vPtr;
270 FlushPayload(ptr, keytype, keytype);
271 ptr->wcs_type = keytype;
273 else /** Otherwise allocate a new one */
275 ptr = NewSubstVar(keyname, keylen, keytype);
278 /** Format the string */
279 va_start(arg_ptr, format);
280 StrBufVAppendPrintf(ptr->wcs_value, format, arg_ptr);
285 * \brief Add a substitution variable (local to this session)
286 * \param keyname the replacementstring to substitute
287 * \param keytype the kind of the key
288 * \param format the format string ala printf
289 * \param ... the arguments to substitute in the formatstring
291 void svprintf(char *keyname, size_t keylen, int keytype, const char *format,...)
296 struct wcsession *WCC = WC;
299 * First look if we're doing a replacement of
302 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
303 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
304 ptr = (wcsubst*)vPtr;
305 FlushPayload(ptr, 1, keytype);
306 ptr->wcs_type = keytype;
308 else /** Otherwise allocate a new one */
310 ptr = NewSubstVar(keyname, keylen, keytype);
313 /** Format the string and save it */
314 va_start(arg_ptr, format);
315 StrBufVAppendPrintf(ptr->wcs_value, format, arg_ptr);
320 * \brief Add a substitution variable (local to this session)
321 * \param keyname the replacementstring to substitute
322 * \param keytype the kind of the key
323 * \param format the format string ala printf
324 * \param ... the arguments to substitute in the formatstring
326 void SVPut(char *keyname, size_t keylen, int keytype, char *Data)
330 struct wcsession *WCC = WC;
334 * First look if we're doing a replacement of
337 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
338 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
339 ptr = (wcsubst*)vPtr;
340 FlushPayload(ptr, 1, keytype);
341 ptr->wcs_type = keytype;
343 else /** Otherwise allocate a new one */
345 ptr = NewSubstVar(keyname, keylen, keytype);
347 StrBufAppendBufPlain(ptr->wcs_value, Data, -1, 0);
351 * \brief Add a substitution variable (local to this session)
352 * \param keyname the replacementstring to substitute
353 * \param keytype the kind of the key
354 * \param format the format string ala printf
355 * \param ... the arguments to substitute in the formatstring
357 void SVPutLong(char *keyname, size_t keylen, long Data)
361 struct wcsession *WCC = WC;
365 * First look if we're doing a replacement of
368 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
369 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
370 ptr = (wcsubst*)vPtr;
371 FlushPayload(ptr, 1, WCS_LONG);
372 ptr->wcs_type = WCS_LONG;
374 else /** Otherwise allocate a new one */
376 ptr = NewSubstVar(keyname, keylen, WCS_LONG);
382 * \brief Add a substitution variable (local to this session) that does a callback
383 * \param keyname the keystring to substitute
384 * \param fcn_ptr the function callback to give the substitution string
386 void SVCallback(char *keyname, size_t keylen, WCHandlerFunc fcn_ptr)
390 struct wcsession *WCC = WC;
393 * First look if we're doing a replacement of
396 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
397 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
398 ptr = (wcsubst*)vPtr;
399 FlushPayload(ptr, 1, WCS_FUNCTION);
400 ptr->wcs_type = WCS_FUNCTION;
402 else /** Otherwise allocate a new one */
404 ptr = NewSubstVar(keyname, keylen, WCS_FUNCTION);
407 ptr->wcs_function = fcn_ptr;
409 inline void SVCALLBACK(char *keyname, WCHandlerFunc fcn_ptr)
411 SVCallback(keyname, strlen(keyname), fcn_ptr);
416 void SVPUTBuf(const char *keyname, int keylen, const StrBuf *Buf, int ref)
420 struct wcsession *WCC = WC;
423 * First look if we're doing a replacement of
426 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
427 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
428 ptr = (wcsubst*)vPtr;
429 FlushPayload(ptr, 0, (ref)?WCS_STRBUF_REF:WCS_STRBUF);
430 ptr->wcs_type = (ref)?WCS_STRBUF_REF:WCS_STRBUF;
432 else /** Otherwise allocate a new one */
434 ptr = NewSubstVar(keyname, keylen, (ref)?WCS_STRBUF_REF:WCS_STRBUF);
436 ptr->wcs_value = (StrBuf*)Buf;
440 * \brief back end for print_value_of() ... does a server command
441 * \param servcmd server command to execute on the citadel server
443 void pvo_do_cmd(StrBuf *Target, StrBuf *servcmd) {
447 serv_puts(ChrPtr(servcmd));
448 len = serv_getln(buf, sizeof buf);
454 StrBufAppendPrintf(Target, "%s\n", &buf[4]);
457 _fmout(Target, "CENTER");
460 StrBufAppendPrintf(Target, "%s\n", &buf[4]);
468 * \brief puts string into the template and computes which escape methon we should use
469 * \param Source the string we should put into the template
470 * \param FormatTypeIndex where should we look for escape types if?
472 void StrBufAppendTemplate(StrBuf *Target,
474 WCTemplateToken *Tokens,
475 void *Context, int ContextType,
476 const StrBuf *Source, int FormatTypeIndex)
478 struct wcsession *WCC;
482 if ((FormatTypeIndex < Tokens->nParameters) &&
483 (Tokens->Params[FormatTypeIndex]->Type == TYPE_STR) &&
484 (Tokens->Params[FormatTypeIndex]->len == 1)) {
485 EscapeAs = *Tokens->Params[FormatTypeIndex]->Start;
492 Buf = NewStrBufPlain(NULL, StrLength(Buf));
493 StrBuf_RFC822_to_Utf8(Buf,
495 (WCC!=NULL)? WCC->DefaultCharset : NULL,
497 StrEscAppend(Target, Buf, NULL, 0, 0);
501 StrEscAppend(Target, Source, NULL, 0, 0);
504 StrBufAppendBuf(Target, Source, 0);
510 * \brief Print the value of a variable
511 * \param keyname get a key to print
513 void print_value_of(StrBuf *Target, WCTemplateToken *Token, void *Context, int ContextType) {
514 struct wcsession *WCC = WC;
518 /*if (WCC->vars != NULL) PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
519 /// TODO: debricated!
520 if (Token->pName[0] == '=') {
521 DoTemplate(Token->pName+1, Token->NameEnd - 1, NULL, NULL, 0);
524 //////TODO: if param[1] == "U" -> urlescape
526 /** Page-local variables */
527 if ((WCC->vars!= NULL) && GetHash(WCC->vars, Token->pName, Token->NameEnd, &vVar)) {
528 ptr = (wcsubst*) vVar;
529 switch(ptr->wcs_type) {
531 StrBufAppendBuf(Target, ptr->wcs_value, 0);
534 pvo_do_cmd(Target, ptr->wcs_value);
537 (*ptr->wcs_function) (Target, Token->nParameters, Token, Context, ContextType);
541 StrBufAppendBuf(Target, ptr->wcs_value, 0);
544 StrBufAppendPrintf(Target, "%ld", ptr->lvalue);
547 lprintf(1,"WARNING: invalid value in SV-Hash at %s!\n", Token->pName);
548 StrBufAppendPrintf(Target, "<pre>WARNING: \ninvalid value in SV-Hash at %s!\n</pre>", Token->pName);
552 lprintf(1, "didn't find Handler [%s] (in '%s' line %ld); "
555 ChrPtr(Token->FileName),
557 ChrPtr(Token->FlatToken));
562 int CompareSubstToToken(TemplateParam *ParamToCompare, TemplateParam *ParamToLookup)
564 struct wcsession *WCC = WC;
568 if ((WCC->vars!= NULL) && GetHash(WCC->vars, ParamToLookup->Start,
569 ParamToLookup->len, &vVar)) {
570 ptr = (wcsubst*) vVar;
571 switch(ptr->wcs_type) {
575 if (ParamToCompare->Type == TYPE_STR)
576 return ((ParamToCompare->len == StrLength(ptr->wcs_value)) &&
577 (strcmp(ParamToCompare->Start, ChrPtr(ptr->wcs_value)) == 0));
579 return ParamToCompare->lvalue == StrTol(ptr->wcs_value);
587 if (ParamToCompare->Type == TYPE_STR)
590 return ParamToCompare->lvalue == ptr->lvalue;
593 lprintf(1,"WARNING: invalid value in SV-Hash at %s!\n",
594 ParamToLookup->Start);
600 int CompareSubstToStrBuf(StrBuf *Compare, TemplateParam *ParamToLookup)
602 struct wcsession *WCC = WC;
606 if ((WCC->vars!= NULL) && GetHash(WCC->vars, ParamToLookup->Start,
607 ParamToLookup->len, &vVar)) {
608 ptr = (wcsubst*) vVar;
609 switch(ptr->wcs_type) {
613 return ((StrLength(Compare) == StrLength(ptr->wcs_value)) &&
614 (strcmp(ChrPtr(Compare), ChrPtr(ptr->wcs_value)) == 0));
621 return StrTol(Compare) == ptr->lvalue;
623 lprintf(1,"WARNING: invalid value in SV-Hash at %s!\n",
624 ParamToLookup->Start);
631 void PutNewToken(WCTemplate *Template, WCTemplateToken *NewToken)
633 if (Template->nTokensUsed + 1 >= Template->TokenSpace) {
634 if (Template->TokenSpace <= 0) {
635 Template->Tokens = (WCTemplateToken**)malloc(
636 sizeof(WCTemplateToken*) * 10);
637 Template->TokenSpace = 10;
640 WCTemplateToken **NewTokens;
641 NewTokens= (WCTemplateToken**)malloc(
642 sizeof(WCTemplateToken*) *
643 Template->TokenSpace * 2);
644 memcpy(NewTokens, Template->Tokens,
645 sizeof(WCTemplateToken*) * Template->nTokensUsed);
646 free(Template->Tokens);
647 Template->TokenSpace *= 2;
648 Template->Tokens = NewTokens;
651 Template->Tokens[(Template->nTokensUsed)++] = NewToken;
654 TemplateParam *GetNextParameter(StrBuf *Buf, const char **pCh, const char *pe, WCTemplateToken *Token, WCTemplate *pTmpl)
656 const char *pch = *pCh;
657 const char *pchs, *pche;
658 TemplateParam *Parm = (TemplateParam *) malloc(sizeof(TemplateParam));
661 /* Skip leading whitespaces */
662 while ((*pch == ' ' )||
665 (*pch == '\n')) pch ++;
668 else if (*pch == '\'')
673 Parm->Type = TYPE_STR;
676 ( (pch > pchs) && (*(pch - 1) == '\\'))
682 lprintf(1, "Error (in '%s' line %ld); "
683 "evaluating template param [%s] in Token [%s]\n",
684 ChrPtr(pTmpl->FileName),
686 ChrPtr(Token->FlatToken),
693 StrBufPeek(Buf, pch, -1, '\0');
694 if (LoadTemplates > 1) {
695 lprintf(1, "DBG: got param [%s] %ld %ld\n",
696 pchs, pche - pchs, strlen(pchs));
699 Parm->len = pche - pchs;
700 pch ++; /* move after trailing quote */
704 Parm->Type = TYPE_LONG;
706 while ((pch <= pe) &&
713 StrBufPeek(Buf, pch, -1, '\0');
714 Parm->lvalue = atol(pchs);
720 lprintf(1, "Error (in '%s' line %ld); "
721 "evaluating long template param [%s] in Token [%s]\n",
722 ChrPtr(pTmpl->FileName),
724 ChrPtr(Token->FlatToken),
730 while ((*pch == ' ' )||
734 (*pch == '\n')) pch ++;
740 WCTemplateToken *NewTemplateSubstitute(StrBuf *Buf,
742 const char *pTmplStart,
743 const char *pTmplEnd,
749 TemplateParam *Param;
750 WCTemplateToken *NewToken = (WCTemplateToken*)malloc(sizeof(WCTemplateToken));
752 NewToken->FileName = pTmpl->FileName; /* to print meaningfull log messages... */
754 NewToken->Line = Line + 1;
755 NewToken->pTokenStart = pTmplStart;
756 NewToken->TokenStart = pTmplStart - pStart;
757 NewToken->TokenEnd = (pTmplEnd - pStart) - NewToken->TokenStart;
758 NewToken->pTokenEnd = pTmplEnd;
759 NewToken->NameEnd = NewToken->TokenEnd - 2;
760 NewToken->PreEval = NULL;
761 NewToken->FlatToken = NewStrBufPlain(pTmplStart + 2, pTmplEnd - pTmplStart - 2);
763 StrBufPeek(Buf, pTmplStart, + 1, '\0');
764 StrBufPeek(Buf, pTmplEnd, -1, '\0');
765 pch = NewToken->pName = pTmplStart + 2;
767 NewToken->HaveParameters = 0;;
768 NewToken->nParameters = 0;
770 while (pch < pTmplEnd - 1) {
772 StrBufPeek(Buf, pch, -1, '\0');
773 NewToken->NameEnd = pch - NewToken->pName;
775 if (*(pTmplEnd - 1) != ')') {
776 lprintf(1, "Warning, Non welformed Token; missing right parenthesis (in '%s' line %ld); "
778 ChrPtr(pTmpl->FileName),
780 ChrPtr(NewToken->FlatToken));
782 while (pch < pTmplEnd - 1) {
783 Param = GetNextParameter(Buf, &pch, pTmplEnd - 1, NewToken, pTmpl);
785 NewToken->HaveParameters = 1;
786 if (NewToken->nParameters > MAXPARAM) {
787 lprintf(1, "Error (in '%s' line %ld); "
788 "only [%ld] Params allowed in Tokens [%s]\n",
789 ChrPtr(pTmpl->FileName),
792 ChrPtr(NewToken->FlatToken));
794 FreeToken(&NewToken);
797 NewToken->Params[NewToken->nParameters++] = Param;
801 if((NewToken->NameEnd == 1) &&
802 (NewToken->HaveParameters == 1))
805 if (*(NewToken->pName) == '_')
806 NewToken->Flags = SV_GETTEXT;
807 else if (*(NewToken->pName) == '=')
808 NewToken->Flags = SV_SUBTEMPL;
809 else if (*(NewToken->pName) == '%')
810 NewToken->Flags = SV_CUST_STR_CONDITIONAL;
811 else if (*(NewToken->pName) == '?')
812 NewToken->Flags = SV_CONDITIONAL;
813 else if (*(NewToken->pName) == '!')
814 NewToken->Flags = SV_NEG_CONDITIONAL;
820 switch (NewToken->Flags) {
822 /* If we're able to find out more about the token, do it now while its fresh. */
823 if (GetHash(GlobalNS, NewToken->pName, NewToken->NameEnd, &vVar)) {
824 HashHandler *Handler;
825 Handler = (HashHandler*) vVar;
826 if ((NewToken->nParameters < Handler->nMinArgs) ||
827 (NewToken->nParameters > Handler->nMaxArgs)) {
828 lprintf(1, "Handler [%s] (in '%s' line %ld); "
829 "doesn't work with %ld params [%s]\n",
831 ChrPtr(pTmpl->FileName),
833 NewToken->nParameters,
834 ChrPtr(NewToken->FlatToken));
837 NewToken->PreEval = Handler;
838 NewToken->Flags = SV_PREEVALUATED;
843 if (NewToken->nParameters !=1) {
844 lprintf(1, "Gettext (in '%s' line %ld); "
845 "requires exactly 1 parameter, you gave %ld params [%s]\n",
846 ChrPtr(pTmpl->FileName),
848 NewToken->nParameters,
849 ChrPtr(NewToken->FlatToken));
855 if (NewToken->nParameters != 1) {
856 lprintf(1, "Subtemplates (in '%s' line %ld); "
857 "require exactly 1 parameter, you gave %ld params [%s]\n",
858 ChrPtr(pTmpl->FileName),
860 NewToken->nParameters,
861 ChrPtr(NewToken->FlatToken));
865 case SV_CUST_STR_CONDITIONAL:
867 case SV_NEG_CONDITIONAL:
868 if (NewToken->nParameters <2) {
869 lprintf(1, "Conditional (in '%s' line %ld); "
870 "require at least 2 parameters, you gave %ld params [%s]\n",
871 ChrPtr(pTmpl->FileName),
873 NewToken->nParameters,
874 ChrPtr(NewToken->FlatToken));
878 if (!GetHash(Conditionals,
879 NewToken->Params[0]->Start,
880 NewToken->Params[0]->len,
883 if ((NewToken->Params[0]->len == 1) &&
884 (NewToken->Params[0]->Start[0] == 'X'))
886 lprintf(1, "Conditional [%s] (in '%s' line %ld); Not found![%s]\n",
887 NewToken->Params[0]->Start,
888 ChrPtr(pTmpl->FileName),
890 ChrPtr(NewToken->FlatToken));
892 NewToken->Error = NewStrBuf();
895 "<pre>\nConditional [%s] (in '%s' line %ld); Not found!\n[%s]\n</pre>\n",
896 NewToken->Params[0]->Start,
897 ChrPtr(pTmpl->FileName),
899 ChrPtr(NewToken->FlatToken));
903 NewToken->PreEval = vVar;
912 int EvaluateConditional(StrBuf *Target, WCTemplateToken *Token, WCTemplate *pTmpl, void *Context, int Neg, int state, int ContextType)
914 ConditionalStruct *Cond;
916 if ((Token->Params[0]->len == 1) &&
917 (Token->Params[0]->Start[0] == 'X'))
918 return (state != 0)?Token->Params[1]->lvalue:0;
920 Cond = (ConditionalStruct *) Token->PreEval;
922 lprintf(1, "Conditional [%s] (in '%s' line %ld); unknown![%s]\n",
923 Token->Params[0]->Start,
924 ChrPtr(pTmpl->FileName),
926 ChrPtr(Token->FlatToken));
930 if (Token->nParameters < Cond->nParams) {
931 lprintf(1, "Conditional [%s] (in '%s' line %ld); needs %ld Params![%s]\n",
932 Token->Params[0]->Start,
933 ChrPtr(pTmpl->FileName),
936 ChrPtr(Token->FlatToken));
939 "<pre>\nConditional [%s] (in '%s' line %ld); needs %ld Params!\n[%s]\n</pre>\n",
940 Token->Params[0]->Start,
941 ChrPtr(pTmpl->FileName),
944 ChrPtr(Token->FlatToken));
947 if (Cond->CondF(Token, Context, ContextType) == Neg)
948 return Token->Params[1]->lvalue;
953 * \brief executes one token
954 * \param Target buffer to append to
955 * \param Token da to process.
956 * \param Template we're iterating
957 * \param Context Contextpoointer to pass in
958 * \param state are we in conditional state?
959 * \param ContextType what type of information does context giv us?
961 int EvaluateToken(StrBuf *Target, WCTemplateToken *Token, WCTemplate *pTmpl, void *Context, int state, int ContextType)
963 HashHandler *Handler;
965 // much output, since pName is not terminated...
966 // lprintf(1,"Doing token: %s\n",Token->pName);
968 switch (Token->Flags) {
970 TmplGettext(Target, Token->nParameters, Token);
972 case SV_CONDITIONAL: /** Forward conditional evaluation */
973 return EvaluateConditional(Target, Token, pTmpl, Context, 1, state, ContextType);
975 case SV_NEG_CONDITIONAL: /** Reverse conditional evaluation */
976 return EvaluateConditional(Target, Token, pTmpl, Context, 0, state, ContextType);
978 case SV_CUST_STR_CONDITIONAL: /** Conditional put custom strings from params */
979 if (Token->nParameters >= 6) {
980 if (EvaluateConditional(Target, Token, pTmpl, Context, 0, state, ContextType))
981 StrBufAppendBufPlain(Target,
982 Token->Params[5]->Start,
983 Token->Params[5]->len,
986 StrBufAppendBufPlain(Target,
987 Token->Params[4]->Start,
988 Token->Params[4]->len,
993 if (Token->nParameters == 1)
994 DoTemplate(Token->Params[0]->Start, Token->Params[0]->len, NULL, NULL, ContextType);
996 case SV_PREEVALUATED:
997 Handler = (HashHandler*) Token->PreEval;
998 if ((Handler->ContextRequired != CTX_NONE) &&
999 (Handler->ContextRequired != ContextType)) {
1000 lprintf(1, "Handler [%s] (in '%s' line %ld); "
1001 "requires context of type %ld, have %ld [%s]\n",
1003 ChrPtr(pTmpl->FileName),
1005 Handler->ContextRequired,
1007 ChrPtr(Token->FlatToken));
1010 "<pre>\nHandler [%s] (in '%s' line %ld);"
1011 " requires context of type %ld, have %ld!\n[%s]\n</pre>\n",
1013 ChrPtr(pTmpl->FileName),
1015 Handler->ContextRequired,
1017 ChrPtr(Token->FlatToken));
1021 Handler->HandlerFunc(Target,
1028 if (GetHash(GlobalNS, Token->pName, Token->NameEnd, &vVar)) {
1029 Handler = (HashHandler*) vVar;
1030 if ((Handler->ContextRequired != CTX_NONE) &&
1031 (Handler->ContextRequired != ContextType)) {
1032 lprintf(1, "Handler [%s] (in '%s' line %ld); "
1033 "requires context of type %ld, have %ld [%s]\n",
1035 ChrPtr(pTmpl->FileName),
1037 Handler->ContextRequired,
1039 ChrPtr(Token->FlatToken));
1042 "<pre>\nHandler [%s] (in '%s' line %ld);"
1043 " requires context of type %ld, have %ld!\n[%s]\n</pre>\n",
1045 ChrPtr(pTmpl->FileName),
1047 Handler->ContextRequired,
1049 ChrPtr(Token->FlatToken));
1052 else if ((Token->nParameters < Handler->nMinArgs) ||
1053 (Token->nParameters > Handler->nMaxArgs)) {
1054 lprintf(1, "Handler [%s] (in '%s' line %ld); "
1055 "doesn't work with %ld params [%s]\n",
1057 ChrPtr(pTmpl->FileName),
1060 ChrPtr(Token->FlatToken));
1063 "<pre>\nHandler [%s] (in '%s' line %ld);"
1064 " doesn't work with %ld params!\n[%s]\n</pre>\n",
1066 ChrPtr(pTmpl->FileName),
1069 ChrPtr(Token->FlatToken));
1072 Handler->HandlerFunc(Target,
1076 ContextType); /*TODO: subset of that */
1081 print_value_of(Target, Token, Context, ContextType);
1087 void ProcessTemplate(WCTemplate *Tmpl, StrBuf *Target, void *Context, int ContextType)
1089 WCTemplate *pTmpl = Tmpl;
1092 const char *pData, *pS;
1095 if (LoadTemplates != 0) {
1096 if (LoadTemplates > 1)
1097 lprintf(1, "DBG: ----- loading: [%s] ------ \n",
1098 ChrPtr(Tmpl->FileName));
1100 pTmpl = load_template(Tmpl->FileName, NULL, NULL);
1104 "<pre>\nError loading Template [%s]\n See Logfile for details\n</pre>\n",
1105 ChrPtr(Tmpl->FileName));
1111 pS = pData = ChrPtr(pTmpl->Data);
1112 len = StrLength(pTmpl->Data);
1116 if (i >= pTmpl->nTokensUsed) {
1117 StrBufAppendBufPlain(Target,
1119 len - (pData - pS), 0);
1123 StrBufAppendBufPlain(
1125 pTmpl->Tokens[i]->pTokenStart - pData, 0);
1126 state = EvaluateToken(Target, pTmpl->Tokens[i], pTmpl, Context, state, ContextType);
1127 while ((state != 0) && (i+1 < pTmpl->nTokensUsed)) {
1128 /* condition told us to skip till its end condition */
1130 if ((pTmpl->Tokens[i]->Flags == SV_CONDITIONAL) ||
1131 (pTmpl->Tokens[i]->Flags == SV_NEG_CONDITIONAL)) {
1132 if (state == EvaluateConditional(
1137 pTmpl->Tokens[i]->Flags,
1143 pData = pTmpl->Tokens[i++]->pTokenEnd + 1;
1144 if (i > pTmpl->nTokensUsed)
1148 if (LoadTemplates != 0) {
1149 FreeWCTemplate(pTmpl);
1155 * \brief Display a variable-substituted template
1156 * \param templatename template file to load
1158 void *prepare_template(StrBuf *filename, StrBuf *Key, HashList *PutThere)
1160 WCTemplate *NewTemplate;
1161 NewTemplate = (WCTemplate *) malloc(sizeof(WCTemplate));
1162 NewTemplate->Data = NULL;
1163 NewTemplate->FileName = NewStrBufDup(filename);
1164 NewTemplate->nTokensUsed = 0;
1165 NewTemplate->TokenSpace = 0;
1166 NewTemplate->Tokens = NULL;
1168 Put(PutThere, ChrPtr(Key), StrLength(Key), NewTemplate, FreeWCTemplate);
1173 * \brief Display a variable-substituted template
1174 * \param templatename template file to load
1176 void *load_template(StrBuf *filename, StrBuf *Key, HashList *PutThere)
1179 struct stat statbuf;
1180 const char *pS, *pE, *pch, *Err;
1183 WCTemplate *NewTemplate;
1185 fd = open(ChrPtr(filename), O_RDONLY);
1187 lprintf(1, "ERROR: could not open template '%s' - %s\n",
1188 ChrPtr(filename), strerror(errno));
1192 if (fstat(fd, &statbuf) == -1) {
1193 lprintf(1, "ERROR: could not stat template '%s' - %s\n",
1194 ChrPtr(filename), strerror(errno));
1198 NewTemplate = (WCTemplate *) malloc(sizeof(WCTemplate));
1199 NewTemplate->Data = NewStrBufPlain(NULL, statbuf.st_size);
1200 NewTemplate->FileName = NewStrBufDup(filename);
1201 NewTemplate->nTokensUsed = 0;
1202 NewTemplate->TokenSpace = 0;
1203 NewTemplate->Tokens = NULL;
1204 if (StrBufReadBLOB(NewTemplate->Data, &fd, 1, statbuf.st_size, &Err) < 0) {
1206 FreeWCTemplate(NewTemplate);
1207 lprintf(1, "ERROR: reading template '%s' - %s<br />\n",
1208 ChrPtr(filename), strerror(errno));
1214 pS = pch = ChrPtr(NewTemplate->Data);
1215 pE = pS + StrLength(NewTemplate->Data);
1217 const char *pts, *pte;
1219 int InDoubleQuotes = 0;
1221 /** Find one <? > */
1223 for (; pch < pE; pch ++) {
1224 if ((*pch=='<')&&(*(pch + 1)=='?'))
1226 if (*pch=='\n') Line ++;
1232 /** Found one? parse it. */
1233 for (; pch < pE - 1; pch ++) {
1235 InDoubleQuotes = ! InDoubleQuotes;
1236 else if (*pch == '\'')
1237 InQuotes = ! InQuotes;
1238 else if ((!InQuotes && !InDoubleQuotes) &&
1239 ((*pch!='\\')&&(*(pch + 1)=='>'))) {
1247 PutNewToken(NewTemplate,
1248 NewTemplateSubstitute(NewTemplate->Data, pS, pts, pte, Line, NewTemplate));
1251 if (LoadTemplates == 0)
1252 Put(PutThere, ChrPtr(Key), StrLength(Key), NewTemplate, FreeWCTemplate);
1257 ///void PrintTemplate(const char *Key, void *vSubst, int odd)
1258 const char* PrintTemplate(void *vSubst)
1260 WCTemplate *Tmpl = vSubst;
1262 return ChrPtr(Tmpl->FileName);
1268 * \brief Display a variable-substituted template
1269 * \param templatename template file to load
1271 void DoTemplate(const char *templatename, long len, StrBuf *Target, void *Context, int ContextType)
1274 HashList *StaticLocal;
1279 if (WC->is_mobile) {
1280 Static = WirelessTemplateCache;
1281 StaticLocal = WirelessLocalTemplateCache;
1284 Static = TemplateCache;
1285 StaticLocal = LocalTemplateCache;
1290 lprintf (1, "Can't to load a template with empty name!\n");
1291 StrBufAppendPrintf(Target, "<pre>\nCan't to load a template with empty name!\n</pre>");
1295 if (!GetHash(StaticLocal, templatename, len, &vTmpl) &&
1296 !GetHash(Static, templatename, len, &vTmpl)) {
1297 lprintf (1, "didn't find Template [%s] %ld %ld\n", templatename, len , (long)strlen(templatename));
1298 StrBufAppendPrintf(Target, "<pre>\ndidn't find Template [%s] %ld %ld\n</pre>",
1300 (long)strlen(templatename));
1301 /// dbg_PrintHash(Static, PrintTemplate, NULL);
1302 // PrintHash(Static, VarPrintTransition, PrintTemplate);
1307 ProcessTemplate(vTmpl, Target, Context, ContextType);
1310 int LoadTemplateDir(const char *DirName, HashList *wireless, HashList *big)
1315 DIR *filedir = NULL;
1316 struct dirent *filedir_entry;
1322 StrBufPrintf(Dir, "%s/t", DirName);
1323 filedir = opendir (ChrPtr(Dir));
1324 if (filedir == NULL) {
1329 FileName = NewStrBuf();
1331 while ((filedir_entry = readdir(filedir)))
1335 #ifdef _DIRENT_HAVE_D_NAMELEN
1336 d_namelen = filedir_entry->d_namelen;
1338 d_namelen = strlen(filedir_entry->d_name);
1340 d_without_ext = d_namelen;
1341 while ((d_without_ext > 0) && (filedir_entry->d_name[d_without_ext] != '.'))
1343 if ((d_without_ext == 0) || (d_namelen < 3))
1345 if ((d_namelen > 1) && filedir_entry->d_name[d_namelen - 1] == '~')
1346 continue; /* Ignore backup files... */
1348 IsMobile = (strstr(filedir_entry->d_name, ".m.html")!= NULL);
1349 PStart = filedir_entry->d_name;
1350 StrBufPrintf(FileName, "%s/%s", ChrPtr(Dir), filedir_entry->d_name);
1351 MinorPtr = strchr(filedir_entry->d_name, '.');
1352 if (MinorPtr != NULL)
1354 StrBufPlain(Tag, filedir_entry->d_name, MinorPtr - filedir_entry->d_name);
1356 if (LoadTemplates > 1)
1357 lprintf(1, "%s %d %s\n",ChrPtr(FileName), IsMobile, ChrPtr(Tag));
1358 if (LoadTemplates == 0)
1359 load_template(FileName, Tag, (IsMobile)?wireless:big);
1361 prepare_template(FileName, Tag, (IsMobile)?wireless:big);
1364 FreeStrBuf(&FileName);
1370 void InitTemplateCache(void)
1372 LoadTemplateDir(static_dirs[0],
1373 WirelessTemplateCache,
1375 LoadTemplateDir(static_dirs[1],
1376 WirelessLocalTemplateCache,
1377 LocalTemplateCache);
1382 typedef struct _HashIterator {
1383 HashList *StaticList;
1384 int AdditionalParams;
1386 int XPectContextType;
1387 RetrieveHashlistFunc GetHash;
1388 HashDestructorFunc Destructor;
1389 SubTemplFunc DoSubTemplate;
1392 void tmpl_iterate_subtmpl(StrBuf *Target, int nArgs, WCTemplateToken *Tokens, void *Context, int ContextType)
1404 if (!GetHash(Iterators,
1405 Tokens->Params[0]->Start,
1406 Tokens->Params[0]->len,
1408 lprintf(1, "unknown Iterator [%s] (in '%s' line %ld); "
1410 Tokens->Params[0]->Start,
1411 ChrPtr(Tokens->FileName),
1413 ChrPtr(Tokens->FlatToken));
1416 "<pre>\nunknown Iterator [%s] (in '%s' line %ld); \n"
1418 Tokens->Params[0]->Start,
1419 ChrPtr(Tokens->FileName),
1421 ChrPtr(Tokens->FlatToken));
1425 It = (HashIterator*) vIt;
1427 if (Tokens->nParameters < It->AdditionalParams + 2) {
1428 lprintf(1, "Iterator [%s] (in '%s' line %ld); "
1429 "doesn't work with %ld params [%s]\n",
1430 Tokens->Params[0]->Start,
1431 ChrPtr(Tokens->FileName),
1433 Tokens->nParameters,
1434 ChrPtr(Tokens->FlatToken));
1437 "<pre>Iterator [%s] \n(in '%s' line %ld);\n"
1438 "doesn't work with %ld params \n[%s]\n</pre>",
1439 Tokens->Params[0]->Start,
1440 ChrPtr(Tokens->FileName),
1442 Tokens->nParameters,
1443 ChrPtr(Tokens->FlatToken));
1447 if ((It->XPectContextType != CTX_NONE) &&
1448 (It->XPectContextType != ContextType)) {
1449 lprintf(1, "Iterator [%s] (in '%s' line %ld); "
1450 "requires context of type %ld, have %ld [%s]\n",
1452 ChrPtr(Tokens->FileName),
1454 It->XPectContextType,
1456 ChrPtr(Tokens->FlatToken));
1459 "<pre>\nIterator [%s] (in '%s' line %ld);"
1460 " requires context of type %ld, have %ld!\n[%s]\n</pre>\n",
1462 ChrPtr(Tokens->FileName),
1464 It->XPectContextType,
1466 ChrPtr(Tokens->FlatToken));
1474 if (It->StaticList == NULL)
1475 List = It->GetHash(Target, nArgs, Tokens, Context, ContextType);
1477 List = It->StaticList;
1479 SubBuf = NewStrBuf();
1480 it = GetNewHashPos();
1481 while (GetNextHashPos(List, it, &len, &Key, &vContext)) {
1482 svprintf(HKEY("ITERATE:ODDEVEN"), WCS_STRING, "%s",
1483 (oddeven) ? "odd" : "even");
1484 svprintf(HKEY("ITERATE:KEY"), WCS_STRING, "%s", Key);
1486 if (It->DoSubTemplate != NULL)
1487 It->DoSubTemplate(SubBuf, vContext, Tokens);
1488 DoTemplate(Tokens->Params[1]->Start,
1489 Tokens->Params[1]->len,
1493 StrBufAppendBuf(Target, SubBuf, 0);
1494 FlushStrBuf(SubBuf);
1495 oddeven = ~ oddeven;
1497 FreeStrBuf(&SubBuf);
1499 if (It->Destructor != NULL)
1500 It->Destructor(&List);
1503 int ConditionalVar(WCTemplateToken *Tokens, void *Context, int ContextType)
1508 if (!GetHash(WC->vars,
1509 Tokens->Params[2]->Start,
1510 Tokens->Params[2]->len,
1513 subst = (wcsubst*) vsubst;
1514 if ((subst->ContextRequired != CTX_NONE) &&
1515 (subst->ContextRequired != ContextType)) {
1516 lprintf(1," WARNING: Conditional requires Context: [%ld]!\n", Tokens->Params[2]->Start);
1520 switch(subst->wcs_type) {
1522 return (subst->wcs_function!=NULL);
1524 lprintf(1, " -> Server [%s]\n", subst->wcs_value);////todo
1528 case WCS_STRBUF_REF:
1529 if (Tokens->nParameters < 4)
1531 return (strcmp(Tokens->Params[3]->Start, ChrPtr(subst->wcs_value)) == 0);
1533 if (Tokens->nParameters < 4)
1534 return (subst->lvalue != 0);
1535 return (subst->lvalue == Tokens->Params[3]->lvalue);
1537 lprintf(1," WARNING: invalid type: [%ld]!\n", subst->wcs_type);
1543 void RegisterITERATOR(const char *Name, long len,
1544 int AdditionalParams,
1545 HashList *StaticList,
1546 RetrieveHashlistFunc GetHash,
1547 SubTemplFunc DoSubTempl,
1548 HashDestructorFunc Destructor,
1550 int XPectContextType)
1552 HashIterator *It = (HashIterator*)malloc(sizeof(HashIterator));
1553 It->StaticList = StaticList;
1554 It->AdditionalParams = AdditionalParams;
1555 It->GetHash = GetHash;
1556 It->DoSubTemplate = DoSubTempl;
1557 It->Destructor = Destructor;
1558 It->ContextType = ContextType;
1559 It->XPectContextType = XPectContextType;
1560 Put(Iterators, Name, len, It, NULL);
1563 void RegisterConditional(const char *Name, long len,
1565 WCConditionalFunc CondF,
1566 int ContextRequired)
1568 ConditionalStruct *Cond = (ConditionalStruct*)malloc(sizeof(ConditionalStruct));
1569 Cond->nParams = nParams;
1570 Cond->CondF = CondF;
1571 Cond->ContextRequired = ContextRequired;
1572 Put(Conditionals, Name, len, Cond, NULL);
1575 void tmpl_do_boxed(StrBuf *Target, int nArgs, WCTemplateToken *Tokens, void *Context, int ContextType)
1578 StrBuf *Headline = NewStrBuf();
1579 DoTemplate(Tokens->Params[1]->Start,
1580 Tokens->Params[1]->len,
1584 SVPutBuf("BOXTITLE", Headline, 0);
1587 DoTemplate(HKEY("beginbox"), Target, Context, ContextType);
1588 DoTemplate(Tokens->Params[0]->Start,
1589 Tokens->Params[0]->len,
1593 DoTemplate(HKEY("endbox"), Target, Context, ContextType);
1596 void tmpl_do_tabbed(StrBuf *Target, int nArgs, WCTemplateToken *Tokens, void *Context, int ContextType)
1599 int i, ntabs, nTabs;
1601 nTabs = ntabs = Tokens->nParameters / 2;
1602 TabNames = (StrBuf **) malloc(ntabs * sizeof(StrBuf*));
1604 for (i = 0; i < ntabs; i++) {
1605 TabNames[i] = NewStrBuf();
1606 if (Tokens->Params[i * 2]->len > 0) {
1607 DoTemplate(Tokens->Params[i * 2]->Start,
1608 Tokens->Params[i * 2]->len,
1614 /** A Tab without subject? we can't count that, add it as silent */
1619 StrTabbedDialog(Target, nTabs, TabNames);
1620 for (i = 0; i < ntabs; i++) {
1621 StrBeginTab(Target, i, nTabs);
1623 DoTemplate(Tokens->Params[i * 2 + 1]->Start,
1624 Tokens->Params[i * 2 + 1]->len,
1628 StrEndTab(Target, i, nTabs);
1636 RegisterNamespace("ITERATE", 2, 100, tmpl_iterate_subtmpl, CTX_NONE);
1637 RegisterNamespace("DOBOXED", 1, 2, tmpl_do_boxed, CTX_NONE);
1638 RegisterNamespace("DOTABBED", 2, 100, tmpl_do_tabbed, CTX_NONE);
1639 RegisterConditional(HKEY("COND:SUBST"), 3, ConditionalVar, CTX_NONE);