12 #define SHOW_ME_VAPPEND_PRINTF
15 #include "webserver.h"
17 extern char *static_dirs[PATH_MAX]; /* Disk representation */
19 HashList *WirelessTemplateCache;
20 HashList *WirelessLocalTemplateCache;
21 HashList *TemplateCache;
22 HashList *LocalTemplateCache;
26 HashList *Conditionals;
29 int DumpTemplateI18NStrings = 0;
30 int LoadTemplates = 0;
31 int dbg_bactrace_template_errors = 0;
32 WCTemplputParams NoCtx;
33 StrBuf *I18nDump = NULL;
35 const char EmptyStr[]="";
38 #define SV_CONDITIONAL 2
39 #define SV_NEG_CONDITIONAL 3
40 #define SV_CUST_STR_CONDITIONAL 4
42 #define SV_PREEVALUATED 6
46 * Dynamic content for variable substitution in templates
48 typedef struct _wcsubst {
50 int wcs_type; /* which type of Substitution are we */
51 char wcs_key[32]; /* copy of our hashkey for debugging */
52 StrBuf *wcs_value; /* if we're a string, keep it here */
53 long lvalue; /* type long? keep data here */
54 WCHandlerFunc wcs_function; /* funcion hook ???*/
58 typedef struct _WCTemplate {
64 WCTemplateToken **Tokens;
67 typedef struct _HashHandler {
69 WCPreevalFunc PreEvalFunc;
70 WCHandlerFunc HandlerFunc;
73 void *load_template(StrBuf *filename, StrBuf *Key, HashList *PutThere);
74 int EvaluateConditional(StrBuf *Target, int Neg, int state, WCTemplputParams *TP);
78 typedef struct _SortStruct {
83 CompareFunc GroupChange;
88 const char *CtxNames[] = {
102 "Context LONGVECTOR",
107 "Context DavNamespace",
113 void DestroySortStruct(void *vSort)
115 SortStruct *Sort = (SortStruct*) vSort;
116 FreeStrBuf(&Sort->Name);
117 FreeStrBuf(&Sort->PrefPrepend);
121 const char *ContextName(int ContextType)
123 if (ContextType < CTX_UNKNOWN)
124 return CtxNames[ContextType];
126 return CtxNames[CTX_UNKNOWN];
129 void LogTemplateError (StrBuf *Target, const char *Type, int ErrorPos, WCTemplputParams *TP, const char *Format, ...)
136 const char *Err = NULL;
141 va_start(arg_ptr, Format);
142 StrBufVAppendPrintf(Error, Format, arg_ptr);
147 case ERR_NAME: /* the main token name... */
148 Err = (TP->Tokens!= NULL)? TP->Tokens->pName:"";
151 Err = ((TP->Tokens!= NULL) &&
152 (TP->Tokens->nParameters > 0))?
153 TP->Tokens->Params[0]->Start : "";
156 Err = ((TP->Tokens!= NULL) &&
157 (TP->Tokens->nParameters > 1))?
158 TP->Tokens->Params[1]->Start : "";
161 if (TP->Tokens != NULL)
163 lprintf(1, "%s [%s] (in '%s' line %ld); %s; [%s]\n",
166 ChrPtr(TP->Tokens->FileName),
169 ChrPtr(TP->Tokens->FlatToken));
173 lprintf(1, "%s: %s;\n",
188 Header = NewStrBuf();
189 if (TP->Tokens != NULL)
194 "<pre>\n%s [%s] (in '%s' line %ld); %s\n[%s]\n</pre>\n",
197 ChrPtr(TP->Tokens->FileName),
200 ChrPtr(TP->Tokens->FlatToken));
202 StrBufPrintf(Info, "%s [%s] %s; [%s]",
206 ChrPtr(TP->Tokens->FlatToken));
209 SerializeJson(Header, WildFireException(SKEY(TP->Tokens->FileName),
214 SerializeJson(Header, WildFireMessage(SKEY(TP->Tokens->FileName),
219 WildFireSerializePayload(Header, WCC->HBuf, &WCC->Hdr->nWildfireHeaders, NULL);
226 "<pre>\n%s: %s\n</pre>\n",
230 StrBufPrintf(Info, "%s [%s] %s; [%s]",
234 ChrPtr(TP->Tokens->FlatToken));
235 SerializeJson(Header, WildFireException(HKEY(__FILE__), __LINE__, Info, 1), 1);
236 WildFireSerializePayload(Header, WCC->HBuf, &WCC->Hdr->nWildfireHeaders, NULL);
242 if (dbg_bactrace_template_errors)
250 void LogError (StrBuf *Target, const char *Type, const char *Format, ...)
261 va_start(arg_ptr, Format);
262 StrBufVAppendPrintf(Error, Format, arg_ptr);
265 lprintf(1, ChrPtr(Error));
268 Header = NewStrBuf();
271 SerializeJson(Header, WildFireException(Type, strlen(Type),
275 WildFireSerializePayload(Header, WCC->HBuf, &WCC->Hdr->nWildfireHeaders, NULL);
281 if (dbg_bactrace_template_errors)
287 void RegisterNS(const char *NSName,
291 WCHandlerFunc HandlerFunc,
292 WCPreevalFunc PreevalFunc,
295 HashHandler *NewHandler;
297 NewHandler = (HashHandler*) malloc(sizeof(HashHandler));
298 memset(NewHandler, 0, sizeof(HashHandler));
299 NewHandler->Filter.nMinArgs = nMinArgs;
300 NewHandler->Filter.nMaxArgs = nMaxArgs;
301 NewHandler->Filter.ContextType = ContextRequired;
302 NewHandler->Filter.ControlContextType = CTX_NONE;
304 NewHandler->PreEvalFunc = PreevalFunc;
305 NewHandler->HandlerFunc = HandlerFunc;
306 Put(GlobalNS, NSName, len, NewHandler, NULL);
309 void RegisterControlNS(const char *NSName,
313 WCHandlerFunc HandlerFunc,
314 int ControlContextRequired)
316 HashHandler *NewHandler;
318 NewHandler = (HashHandler*) malloc(sizeof(HashHandler));
319 memset(NewHandler, 0, sizeof(HashHandler));
320 NewHandler->Filter.nMinArgs = nMinArgs;
321 NewHandler->Filter.nMaxArgs = nMaxArgs;
322 NewHandler->Filter.ContextType = CTX_NONE;
323 NewHandler->Filter.ControlContextType = ControlContextRequired;
324 NewHandler->HandlerFunc = HandlerFunc;
325 Put(GlobalNS, NSName, len, NewHandler, NULL);
330 int CheckContext(StrBuf *Target, ContextFilter *Need, WCTemplputParams *TP, const char *ErrType)
332 if ((Need->ContextType != CTX_NONE) &&
333 (Need->ContextType != TP->Filter.ContextType)) {
335 Target, ErrType, ERR_PARM1, TP,
336 " WARNING: requires Context: [%s], have [%s]!",
337 ContextName(Need->ContextType),
338 ContextName(TP->Filter.ContextType));
342 if ((Need->ControlContextType != CTX_NONE) &&
343 (Need->ControlContextType != TP->Filter.ControlContextType)) {
345 Target, ErrType, ERR_PARM1, TP,
346 " WARNING: requires Control Context: [%s], have [%s]!",
347 ContextName(Need->ControlContextType),
348 ContextName(TP->Filter.ControlContextType));
352 if (TP->Tokens->nParameters < Need->nMinArgs) {
353 LogTemplateError(Target, ErrType, ERR_NAME, TP,
354 "needs at least %ld params, have %ld",
356 TP->Tokens->nParameters);
360 else if (TP->Tokens->nParameters > Need->nMaxArgs) {
361 LogTemplateError(Target, ErrType, ERR_NAME, TP,
362 "just needs %ld params, you gave %ld",
364 TP->Tokens->nParameters);
372 void FreeToken(WCTemplateToken **Token)
375 FreeStrBuf(&(*Token)->FlatToken);
376 if ((*Token)->HaveParameters)
377 for (i = 0; i < (*Token)->nParameters; i++)
378 free((*Token)->Params[i]);
385 void FreeWCTemplate(void *vFreeMe)
388 WCTemplate *FreeMe = (WCTemplate*)vFreeMe;
390 if (FreeMe->TokenSpace > 0) {
391 for (i = 0; i < FreeMe->nTokensUsed; i ++) {
392 FreeToken(&FreeMe->Tokens[i]);
394 free(FreeMe->Tokens);
396 FreeStrBuf(&FreeMe->FileName);
397 FreeStrBuf(&FreeMe->Data);
398 FreeStrBuf(&FreeMe->MimeType);
404 * debugging function to print array to log
406 void VarPrintTransition(void *vVar1, void *vVar2, int odd){}
409 * debugging function to print array to log
411 void VarPrintEntry(const char *Key, void *vSubst, int odd)
414 lprintf(1,"Subst[%s] : ", Key);
415 ptr = (wcsubst*) vSubst;
417 switch(ptr->wcs_type) {
419 lprintf(1, " -> %s\n", ChrPtr(ptr->wcs_value));
422 lprintf(1, " -> Server [%s]\n", ChrPtr(ptr->wcs_value));
425 lprintf(1, " -> function at [%0xd]\n", ptr->wcs_function);
428 lprintf(1," WARNING: invalid type: [%ld]!\n", ptr->wcs_type);
435 * Clear out the list of substitution variables local to this session
437 void clear_substs(wcsession *wc) {
439 if (wc->vars != NULL) {
440 DeleteHash(&wc->vars);
445 * Clear out the list of substitution variables local to this session
447 void clear_local_substs(void) {
466 void FlushPayload(wcsubst *ptr, int reusestrbuf, int type)
468 int NeedNew = NeedNewBuf(type);
469 switch(ptr->wcs_type) {
473 if (reusestrbuf && NeedNew) {
474 FlushStrBuf(ptr->wcs_value);
478 FreeStrBuf(&ptr->wcs_value);
479 ptr->wcs_value = NULL;
483 ptr->wcs_function = NULL;
484 if (reusestrbuf && NeedNew)
485 ptr->wcs_value = NewStrBuf();
488 ptr->wcs_value = NULL;
489 if (reusestrbuf && NeedNew)
490 ptr->wcs_value = NewStrBuf();
494 if (reusestrbuf && NeedNew)
495 ptr->wcs_value = NewStrBuf();
498 if (reusestrbuf && NeedNew)
499 ptr->wcs_value = NewStrBuf();
506 * destructor; kill one entry.
508 void deletevar(void *data)
510 wcsubst *ptr = (wcsubst*)data;
511 FlushPayload(ptr, 0, ptr->wcs_type);
516 wcsubst *NewSubstVar(const char *keyname, int keylen, int type)
521 ptr = (wcsubst *) malloc(sizeof(wcsubst));
522 memset(ptr, 0, sizeof(wcsubst));
524 ptr->wcs_type = type;
525 safestrncpy(ptr->wcs_key, keyname, sizeof ptr->wcs_key);
526 Put(WCC->vars, keyname, keylen, ptr, deletevar);
528 switch(ptr->wcs_type) {
531 ptr->wcs_value = NewStrBuf();
545 * Add a substitution variable (local to this session) (strlen version...)
546 * keyname the replacementstring to substitute
547 * keytype the kind of the key
548 * format the format string ala printf
549 * ... the arguments to substitute in the formatstring
551 void SVPRINTF(char *keyname, int keytype, const char *format,...)
559 keylen = strlen(keyname);
561 * First look if we're doing a replacement of
564 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
565 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
566 ptr = (wcsubst*)vPtr;
567 FlushPayload(ptr, keytype, keytype);
568 ptr->wcs_type = keytype;
570 else /** Otherwise allocate a new one */
572 ptr = NewSubstVar(keyname, keylen, keytype);
575 /* Format the string */
576 va_start(arg_ptr, format);
577 StrBufVAppendPrintf(ptr->wcs_value, format, arg_ptr);
582 * Add a substitution variable (local to this session)
583 * keyname the replacementstring to substitute
584 * keytype the kind of the key
585 * format the format string ala printf
586 * ... the arguments to substitute in the formatstring
588 void svprintf(char *keyname, size_t keylen, int keytype, const char *format,...)
596 * First look if we're doing a replacement of
599 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
600 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
601 ptr = (wcsubst*)vPtr;
602 FlushPayload(ptr, 1, keytype);
603 ptr->wcs_type = keytype;
605 else /** Otherwise allocate a new one */
607 ptr = NewSubstVar(keyname, keylen, keytype);
610 /** Format the string and save it */
611 va_start(arg_ptr, format);
612 StrBufVAppendPrintf(ptr->wcs_value, format, arg_ptr);
617 * Add a substitution variable (local to this session)
618 * keyname the replacementstring to substitute
619 * keytype the kind of the key
620 * format the format string ala printf
621 * ... the arguments to substitute in the formatstring
623 void SVPut(char *keyname, size_t keylen, int keytype, char *Data)
631 * First look if we're doing a replacement of
634 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
635 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
636 ptr = (wcsubst*)vPtr;
637 FlushPayload(ptr, 1, keytype);
638 ptr->wcs_type = keytype;
640 else /** Otherwise allocate a new one */
642 ptr = NewSubstVar(keyname, keylen, keytype);
644 StrBufAppendBufPlain(ptr->wcs_value, Data, -1, 0);
648 * \brief Add a substitution variable (local to this session)
649 * \param keyname the replacementstring to substitute
650 * \param keytype the kind of the key
651 * \param format the format string ala printf
652 * \param ... the arguments to substitute in the formatstring
654 void SVPutLong(char *keyname, size_t keylen, long Data)
662 * First look if we're doing a replacement of
665 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
666 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
667 ptr = (wcsubst*)vPtr;
668 FlushPayload(ptr, 1, WCS_LONG);
669 ptr->wcs_type = WCS_LONG;
671 else /** Otherwise allocate a new one */
673 ptr = NewSubstVar(keyname, keylen, WCS_LONG);
679 * \brief Add a substitution variable (local to this session) that does a callback
680 * \param keyname the keystring to substitute
681 * \param fcn_ptr the function callback to give the substitution string
683 void SVCallback(char *keyname, size_t keylen, WCHandlerFunc fcn_ptr)
690 * First look if we're doing a replacement of
693 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
694 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
695 ptr = (wcsubst*)vPtr;
696 FlushPayload(ptr, 1, WCS_FUNCTION);
697 ptr->wcs_type = WCS_FUNCTION;
699 else /** Otherwise allocate a new one */
701 ptr = NewSubstVar(keyname, keylen, WCS_FUNCTION);
704 ptr->wcs_function = fcn_ptr;
706 inline void SVCALLBACK(char *keyname, WCHandlerFunc fcn_ptr)
708 SVCallback(keyname, strlen(keyname), fcn_ptr);
713 void SVPUTBuf(const char *keyname, int keylen, const StrBuf *Buf, int ref)
720 * First look if we're doing a replacement of
723 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
724 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
725 ptr = (wcsubst*)vPtr;
726 FlushPayload(ptr, 0, (ref)?WCS_STRBUF_REF:WCS_STRBUF);
727 ptr->wcs_type = (ref)?WCS_STRBUF_REF:WCS_STRBUF;
729 else /** Otherwise allocate a new one */
731 ptr = NewSubstVar(keyname, keylen, (ref)?WCS_STRBUF_REF:WCS_STRBUF);
733 ptr->wcs_value = (StrBuf*)Buf;
737 * \brief back end for print_value_of() ... does a server command
738 * \param servcmd server command to execute on the citadel server
740 void pvo_do_cmd(StrBuf *Target, StrBuf *servcmd) {
744 serv_puts(ChrPtr(servcmd));
745 len = serv_getln(buf, sizeof buf);
751 StrBufAppendPrintf(Target, "%s\n", &buf[4]);
754 _fmout(Target, "CENTER");
757 StrBufAppendPrintf(Target, "%s\n", &buf[4]);
763 void GetTemplateTokenString(StrBuf *Target,
764 WCTemplputParams *TP,
770 WCTemplputParams SubTP;
772 if (TP->Tokens->nParameters < N) {
773 LogTemplateError(Target,
774 "TokenParameter", N, TP,
775 "invalid token %d. this shouldn't have come till here.\n", N);
781 switch (TP->Tokens->Params[N]->Type) {
784 *Value = TP->Tokens->Params[N]->Start;
785 *len = TP->Tokens->Params[N]->len;
788 if (TP->Tokens->Params[N]->len == 0) {
789 LogTemplateError(Target,
790 "TokenParameter", N, TP,
791 "Requesting parameter %d; of type BSTR, empty lookup string not admitted.", N);
796 Buf = (StrBuf*) SBstr(TKEY(N));
797 *Value = ChrPtr(Buf);
798 *len = StrLength(Buf);
801 if (TP->Tokens->Params[N]->len == 0) {
802 LogTemplateError(Target,
803 "TokenParameter", N, TP,
804 "Requesting parameter %d; of type PREFSTR, empty lookup string not admitted.", N);
809 get_PREFERENCE(TKEY(N), &Buf);
810 *Value = ChrPtr(Buf);
811 *len = StrLength(Buf);
814 LogTemplateError(Target,
815 "TokenParameter", N, TP,
816 "Requesting parameter %d; of type LONG, want string.", N);
819 LogTemplateError(Target,
820 "TokenParameter", N, TP,
821 "Requesting parameter %d; of type PREFINT, want string.", N);
824 *Value = _(TP->Tokens->Params[N]->Start);
825 *len = strlen(*Value);
827 case TYPE_SUBTEMPLATE:
828 if (TP->Tokens->Params[N]->len == 0) {
829 LogTemplateError(Target,
830 "TokenParameter", N, TP,
831 "Requesting parameter %d; of type SUBTEMPLATE, empty lookup string not admitted.", N);
837 memset(&SubTP, 0, sizeof(WCTemplputParams *));
838 SubTP.Context = TP->Context;
839 SubTP.Filter.ContextType = TP->Filter.ContextType;
841 DoTemplate(TKEY(N), Buf, &SubTP);
842 *Value = ChrPtr(Buf);
843 *len = StrLength(Buf);
844 /* we can't free it here, so we put it into the subst so its discarded later on. */
845 SVPUTBuf(TKEY(N), Buf, 0);
849 LogTemplateError(Target,
850 "TokenParameter", N, TP,
851 "unknown param type %d; [%d]", N, TP->Tokens->Params[N]->Type);
856 long GetTemplateTokenNumber(StrBuf *Target, WCTemplputParams *TP, int N, long dflt)
859 if (TP->Tokens->nParameters < N) {
860 LogTemplateError(Target,
861 "TokenParameter", N, TP,
862 "invalid token %d. this shouldn't have come till here.\n", N);
867 switch (TP->Tokens->Params[N]->Type) {
870 return atol(TP->Tokens->Params[N]->Start);
873 if (TP->Tokens->Params[N]->len == 0) {
874 LogTemplateError(Target,
875 "TokenParameter", N, TP,
876 "Requesting parameter %d; of type BSTR, empty lookup string not admitted.", N);
879 return LBstr(TKEY(N));
882 LogTemplateError(Target,
883 "TokenParameter", N, TP,
884 "requesting a prefstring in param %d want a number", N);
885 if (TP->Tokens->Params[N]->len == 0) {
886 LogTemplateError(Target,
887 "TokenParameter", N, TP,
888 "Requesting parameter %d; of type PREFSTR, empty lookup string not admitted.", N);
891 if (get_PREF_LONG(TKEY(N), &Ret, dflt))
895 return TP->Tokens->Params[N]->lvalue;
897 if (TP->Tokens->Params[N]->len == 0) {
898 LogTemplateError(Target,
899 "TokenParameter", N, TP,
900 "Requesting parameter %d; of type PREFINT, empty lookup string not admitted.", N);
903 if (get_PREF_LONG(TKEY(N), &Ret, dflt))
907 LogTemplateError(Target,
908 "TokenParameter", N, TP,
909 "requesting a I18N string in param %d; want a number", N);
911 case TYPE_SUBTEMPLATE:
912 LogTemplateError(Target,
913 "TokenParameter", N, TP,
914 "requesting a subtemplate in param %d; not supported for numbers", N);
917 LogTemplateError(Target,
918 "TokenParameter", N, TP,
919 "unknown param type %d; [%d]", N, TP->Tokens->Params[N]->Type);
927 * \brief Print the value of a variable
928 * \param keyname get a key to print
930 void print_value_of(StrBuf *Target, WCTemplputParams *TP)
937 /*if (WCC->vars != NULL) PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
938 /* TODO: depricated! */
939 if (TP->Tokens->pName[0] == '=') {
940 DoTemplate(TP->Tokens->pName+1, TP->Tokens->NameEnd - 1, NULL, &NoCtx);
942 /*/////TODO: if param[1] == "U" -> urlescape
944 /** Page-local variables */
945 if ((WCC->vars!= NULL) && GetHash(WCC->vars, TP->Tokens->pName, TP->Tokens->NameEnd, &vVar)) {
946 ptr = (wcsubst*) vVar;
947 switch(ptr->wcs_type) {
949 StrBufAppendBuf(Target, ptr->wcs_value, 0);
952 pvo_do_cmd(Target, ptr->wcs_value);
955 (*ptr->wcs_function) (Target, TP);
959 StrBufAppendBuf(Target, ptr->wcs_value, 0);
962 StrBufAppendPrintf(Target, "%ld", ptr->lvalue);
966 Target, "Subst", ERR_NAME, TP,
967 "WARNING: invalid value in SV-Hash at %s!", TP->Tokens->pName);
972 Target, "Token", ERR_NAME, TP,
973 "didn't find Handler \"%s\"", TP->Tokens->pName);
978 int CompareSubstToToken(TemplateParam *ParamToCompare, TemplateParam *ParamToLookup)
984 if ((WCC->vars!= NULL) && GetHash(WCC->vars, ParamToLookup->Start,
985 ParamToLookup->len, &vVar)) {
986 ptr = (wcsubst*) vVar;
987 switch(ptr->wcs_type) {
991 if (ParamToCompare->Type == TYPE_STR)
992 return ((ParamToCompare->len == StrLength(ptr->wcs_value)) &&
993 (strcmp(ParamToCompare->Start, ChrPtr(ptr->wcs_value)) == 0));
995 return ParamToCompare->lvalue == StrTol(ptr->wcs_value);
1003 if (ParamToCompare->Type == TYPE_STR)
1006 return ParamToCompare->lvalue == ptr->lvalue;
1009 lprintf(1,"WARNING: invalid value in SV-Hash at %s!\n",
1010 ParamToLookup->Start);
1016 int CompareSubstToStrBuf(StrBuf *Compare, TemplateParam *ParamToLookup)
1018 wcsession *WCC = WC;
1022 if ((WCC->vars!= NULL) && GetHash(WCC->vars, ParamToLookup->Start,
1023 ParamToLookup->len, &vVar)) {
1024 ptr = (wcsubst*) vVar;
1025 switch(ptr->wcs_type) {
1028 case WCS_STRBUF_REF:
1029 return ((StrLength(Compare) == StrLength(ptr->wcs_value)) &&
1030 (strcmp(ChrPtr(Compare), ChrPtr(ptr->wcs_value)) == 0));
1037 return StrTol(Compare) == ptr->lvalue;
1039 lprintf(1,"WARNING: invalid value in SV-Hash at %s!\n",
1040 ParamToLookup->Start);
1049 * \brief puts string into the template and computes which escape methon we should use
1050 * \param Source the string we should put into the template
1051 * \param FormatTypeIndex where should we look for escape types if?
1053 void StrBufAppendTemplate(StrBuf *Target,
1054 WCTemplputParams *TP,
1055 const StrBuf *Source, int FormatTypeIndex)
1058 char EscapeAs = ' ';
1060 if ((FormatTypeIndex < TP->Tokens->nParameters) &&
1061 (TP->Tokens->Params[FormatTypeIndex]->Type == TYPE_STR) &&
1062 (TP->Tokens->Params[FormatTypeIndex]->len == 1)) {
1063 EscapeAs = *TP->Tokens->Params[FormatTypeIndex]->Start;
1070 StrEscAppend(Target, Source, NULL, 0, 2);
1073 StrEscAppend(Target, Source, NULL, 0, 0);
1076 StrECMAEscAppend(Target, Source, NULL);
1079 StrHtmlEcmaEscAppend(Target, Source, NULL, 0, 0);
1082 StrBufUrlescAppend(Target, Source, NULL);
1085 StrBufAppendBuf(Target, Source, 0);
1090 void PutNewToken(WCTemplate *Template, WCTemplateToken *NewToken)
1092 if (Template->nTokensUsed + 1 >= Template->TokenSpace) {
1093 if (Template->TokenSpace <= 0) {
1094 Template->Tokens = (WCTemplateToken**)malloc(
1095 sizeof(WCTemplateToken*) * 10);
1096 memset(Template->Tokens, 0, sizeof(WCTemplateToken*));
1097 Template->TokenSpace = 10;
1100 WCTemplateToken **NewTokens;
1101 NewTokens= (WCTemplateToken**)malloc(
1102 sizeof(WCTemplateToken*) *
1103 Template->TokenSpace * 2);
1104 memcpy(NewTokens, Template->Tokens,
1105 sizeof(WCTemplateToken*) * Template->nTokensUsed);
1106 free(Template->Tokens);
1107 Template->TokenSpace *= 2;
1108 Template->Tokens = NewTokens;
1111 Template->Tokens[(Template->nTokensUsed)++] = NewToken;
1114 TemplateParam *GetNextParameter(StrBuf *Buf, const char **pCh, const char *pe, WCTemplateToken *Tokens, WCTemplate *pTmpl)
1116 const char *pch = *pCh;
1117 const char *pchs, *pche;
1118 TemplateParam *Parm;
1122 Parm = (TemplateParam *) malloc(sizeof(TemplateParam));
1123 memset(Parm, 0, sizeof(TemplateParam));
1124 Parm->Type = TYPE_STR;
1126 /* Skip leading whitespaces */
1127 while ((*pch == ' ' )||
1130 (*pch == '\n')) pch ++;
1133 Parm->Type = TYPE_PREFSTR;
1140 else if (*pch == ';') {
1141 Parm->Type = TYPE_PREFINT;
1148 else if (*pch == '_') {
1149 Parm->Type = TYPE_GETTEXT;
1156 else if (*pch == 'B') {
1157 Parm->Type = TYPE_BSTR;
1164 else if (*pch == '=') {
1165 Parm->Type = TYPE_SUBTEMPLATE;
1176 else if (*pch == '\'')
1178 if (quote != '\0') {
1183 ( (pch > pchs) && (*(pch - 1) == '\\'))
1188 if (*pch != quote) {
1189 lprintf(1, "Error (in '%s' line %ld); "
1190 "evaluating template param [%s] in Token [%s]\n",
1191 ChrPtr(pTmpl->FileName),
1193 ChrPtr(Tokens->FlatToken),
1200 StrBufPeek(Buf, pch, -1, '\0');
1201 if (LoadTemplates > 1) {
1202 lprintf(1, "DBG: got param [%s] %ld %ld\n",
1203 pchs, pche - pchs, strlen(pchs));
1206 Parm->len = pche - pchs;
1207 pch ++; /* move after trailing quote */
1208 if (ParamBrace && (*pch == ')')) {
1215 Parm->Type = TYPE_LONG;
1217 while ((pch <= pe) &&
1223 if (pch - pchs > 1){
1224 StrBufPeek(Buf, pch, -1, '\0');
1225 Parm->lvalue = atol(pchs);
1232 lprintf(1, "Error (in '%s' line %ld); "
1233 "evaluating long template param [%s] in Token [%s]\n",
1234 ChrPtr(pTmpl->FileName),
1236 ChrPtr(Tokens->FlatToken),
1243 while ((*pch == ' ' )||
1247 (*pch == '\n')) pch ++;
1249 if (DumpTemplateI18NStrings && (Parm->Type == TYPE_GETTEXT)) {
1250 StrBufAppendPrintf(I18nDump, "_(\"%s\");\n", Parm->Start);
1256 WCTemplateToken *NewTemplateSubstitute(StrBuf *Buf,
1258 const char *pTmplStart,
1259 const char *pTmplEnd,
1265 TemplateParam *Param;
1266 WCTemplateToken *NewToken;
1267 WCTemplputParams TP;
1269 NewToken = (WCTemplateToken*)malloc(sizeof(WCTemplateToken));
1270 memset(NewToken, 0, sizeof(WCTemplateToken));
1271 TP.Tokens = NewToken;
1272 NewToken->FileName = pTmpl->FileName; /* to print meaningfull log messages... */
1273 NewToken->Flags = 0;
1274 NewToken->Line = Line + 1;
1275 NewToken->pTokenStart = pTmplStart;
1276 NewToken->TokenStart = pTmplStart - pStart;
1277 NewToken->TokenEnd = (pTmplEnd - pStart) - NewToken->TokenStart;
1278 NewToken->pTokenEnd = pTmplEnd;
1279 NewToken->NameEnd = NewToken->TokenEnd - 2;
1280 NewToken->PreEval = NULL;
1281 NewToken->FlatToken = NewStrBufPlain(pTmplStart + 2, pTmplEnd - pTmplStart - 2);
1282 StrBufShrinkToFit(NewToken->FlatToken, 1);
1284 StrBufPeek(Buf, pTmplStart, + 1, '\0');
1285 StrBufPeek(Buf, pTmplEnd, -1, '\0');
1286 pch = NewToken->pName = pTmplStart + 2;
1288 NewToken->HaveParameters = 0;;
1289 NewToken->nParameters = 0;
1291 while (pch < pTmplEnd - 1) {
1293 StrBufPeek(Buf, pch, -1, '\0');
1294 NewToken->NameEnd = pch - NewToken->pName;
1296 if (*(pTmplEnd - 1) != ')') {
1298 NULL, "Parseerror", ERR_NAME, &TP,
1299 "Warning, Non welformed Token; missing right parenthesis");
1301 while (pch < pTmplEnd - 1) {
1302 Param = GetNextParameter(Buf, &pch, pTmplEnd - 1, NewToken, pTmpl);
1303 if (Param != NULL) {
1304 NewToken->HaveParameters = 1;
1305 if (NewToken->nParameters > MAXPARAM) {
1307 NULL, "Parseerror", ERR_NAME, &TP,
1308 "only [%d] Params allowed in Tokens",
1312 FreeToken(&NewToken);
1315 NewToken->Params[NewToken->nParameters++] = Param;
1319 if((NewToken->NameEnd == 1) &&
1320 (NewToken->HaveParameters == 1))
1323 if (*(NewToken->pName) == '_')
1324 NewToken->Flags = SV_GETTEXT;
1325 else if (*(NewToken->pName) == '=')
1326 NewToken->Flags = SV_SUBTEMPL;
1327 else if (*(NewToken->pName) == '%')
1328 NewToken->Flags = SV_CUST_STR_CONDITIONAL;
1329 else if (*(NewToken->pName) == '?')
1330 NewToken->Flags = SV_CONDITIONAL;
1331 else if (*(NewToken->pName) == '!')
1332 NewToken->Flags = SV_NEG_CONDITIONAL;
1338 switch (NewToken->Flags) {
1340 /* If we're able to find out more about the token, do it now while its fresh. */
1341 if (GetHash(GlobalNS, NewToken->pName, NewToken->NameEnd, &vVar)) {
1342 HashHandler *Handler;
1343 Handler = (HashHandler*) vVar;
1344 if ((NewToken->nParameters < Handler->Filter.nMinArgs) ||
1345 (NewToken->nParameters > Handler->Filter.nMaxArgs)) {
1347 NULL, "Token", ERR_NAME, &TP,
1348 "doesn't work with %d params",
1349 NewToken->nParameters);
1353 NewToken->PreEval = Handler;
1354 NewToken->Flags = SV_PREEVALUATED;
1355 if (Handler->PreEvalFunc != NULL)
1356 Handler->PreEvalFunc(NewToken);
1361 if (NewToken->nParameters !=1) {
1363 NULL, "Gettext", ERR_NAME, &TP,
1364 "requires exactly 1 parameter, you gave %d params",
1365 NewToken->nParameters);
1366 NewToken->Flags = 0;
1369 if (DumpTemplateI18NStrings) {
1370 StrBufAppendPrintf(I18nDump, "_(\"%s\");\n", NewToken->Params[0]->Start);
1374 if (NewToken->nParameters != 1) {
1376 NULL, "Subtemplates", ERR_NAME, &TP,
1377 "require exactly 1 parameter, you gave %d params",
1378 NewToken->nParameters);
1382 case SV_CUST_STR_CONDITIONAL:
1383 case SV_CONDITIONAL:
1384 case SV_NEG_CONDITIONAL:
1385 if (NewToken->nParameters <2) {
1387 NULL, "Conditional", ERR_NAME, &TP,
1388 "require at least 2 parameters, you gave %d params",
1389 NewToken->nParameters);
1390 NewToken->Flags = 0;
1393 if (NewToken->Params[1]->lvalue == 0) {
1395 NULL, "Conditional", ERR_NAME, &TP,
1396 "Conditional ID (Parameter 1) mustn't be 0!");
1397 NewToken->Flags = 0;
1400 if (!GetHash(Conditionals,
1401 NewToken->Params[0]->Start,
1402 NewToken->Params[0]->len,
1405 if ((NewToken->Params[0]->len == 1) &&
1406 (NewToken->Params[0]->Start[0] == 'X'))
1409 NULL, "Conditional", ERR_NAME, &TP,
1412 NewToken->Error = NewStrBuf();
1415 "<pre>\nConditional [%s] (in '%s' line %ld); Not found!\n[%s]\n</pre>\n",
1416 NewToken->Params[0]->Start,
1417 ChrPtr(pTmpl->FileName),
1419 ChrPtr(NewToken->FlatToken));
1423 NewToken->PreEval = vVar;
1435 * \brief Display a variable-substituted template
1436 * \param templatename template file to load
1438 void *prepare_template(StrBuf *filename, StrBuf *Key, HashList *PutThere)
1440 WCTemplate *NewTemplate;
1442 NewTemplate = (WCTemplate *) malloc(sizeof(WCTemplate));
1443 memset(NewTemplate, 0, sizeof(WCTemplate));
1444 NewTemplate->Data = NULL;
1445 NewTemplate->FileName = NewStrBufDup(filename);
1446 StrBufShrinkToFit(NewTemplate->FileName, 1);
1447 NewTemplate->nTokensUsed = 0;
1448 NewTemplate->TokenSpace = 0;
1449 NewTemplate->Tokens = NULL;
1450 NewTemplate->MimeType = NewStrBufPlain(GuessMimeByFilename (SKEY(NewTemplate->FileName)), -1);
1451 if (strstr(ChrPtr(NewTemplate->MimeType), "text") != NULL) {
1452 StrBufAppendBufPlain(NewTemplate->MimeType, HKEY("; charset=utf-8"), 0);
1455 Put(PutThere, ChrPtr(Key), StrLength(Key), NewTemplate, FreeWCTemplate);
1460 * \brief Display a variable-substituted template
1461 * \param templatename template file to load
1463 void *load_template(StrBuf *filename, StrBuf *Key, HashList *PutThere)
1466 struct stat statbuf;
1467 const char *pS, *pE, *pch, *Err;
1470 WCTemplate *NewTemplate;
1472 fd = open(ChrPtr(filename), O_RDONLY);
1474 lprintf(1, "ERROR: could not open template '%s' - %s\n",
1475 ChrPtr(filename), strerror(errno));
1479 if (fstat(fd, &statbuf) == -1) {
1480 lprintf(1, "ERROR: could not stat template '%s' - %s\n",
1481 ChrPtr(filename), strerror(errno));
1485 NewTemplate = (WCTemplate *) malloc(sizeof(WCTemplate));
1486 memset(NewTemplate, 0, sizeof(WCTemplate));
1487 NewTemplate->Data = NewStrBufPlain(NULL, statbuf.st_size);
1488 NewTemplate->FileName = NewStrBufDup(filename);
1489 NewTemplate->nTokensUsed = 0;
1490 NewTemplate->TokenSpace = 0;
1491 NewTemplate->Tokens = NULL;
1492 NewTemplate->MimeType = NewStrBufPlain(GuessMimeByFilename (SKEY(NewTemplate->FileName)), -1);
1493 if (strstr(ChrPtr(NewTemplate->MimeType), "text") != NULL) {
1494 StrBufAppendBufPlain(NewTemplate->MimeType, HKEY("; charset=utf-8"), 0);
1497 if (StrBufReadBLOB(NewTemplate->Data, &fd, 1, statbuf.st_size, &Err) < 0) {
1499 FreeWCTemplate(NewTemplate);
1500 lprintf(1, "ERROR: reading template '%s' - %s<br />\n",
1501 ChrPtr(filename), strerror(errno));
1507 StrBufShrinkToFit(NewTemplate->Data, 1);
1508 StrBufShrinkToFit(NewTemplate->MimeType, 1);
1509 pS = pch = ChrPtr(NewTemplate->Data);
1510 pE = pS + StrLength(NewTemplate->Data);
1512 const char *pts, *pte;
1514 int InDoubleQuotes = 0;
1516 /** Find one <? > */
1518 for (; pch < pE; pch ++) {
1519 if ((*pch=='<')&&(*(pch + 1)=='?') &&
1520 !((pch == pS) && /* we must ommit a <?xml */
1521 (*(pch + 2) == 'x') &&
1522 (*(pch + 3) == 'm') &&
1523 (*(pch + 4) == 'l')))
1525 if (*pch=='\n') Line ++;
1531 /** Found one? parse it. */
1532 for (; pch <= pE - 1; pch ++) {
1534 InDoubleQuotes = ! InDoubleQuotes;
1535 else if (*pch == '\'')
1536 InQuotes = ! InQuotes;
1537 else if ((!InQuotes && !InDoubleQuotes) &&
1538 ((*pch!='\\')&&(*(pch + 1)=='>'))) {
1546 PutNewToken(NewTemplate,
1547 NewTemplateSubstitute(NewTemplate->Data, pS, pts, pte, Line, NewTemplate));
1550 if (LoadTemplates == 0)
1551 Put(PutThere, ChrPtr(Key), StrLength(Key), NewTemplate, FreeWCTemplate);
1556 const char* PrintTemplate(void *vSubst)
1558 WCTemplate *Tmpl = vSubst;
1560 return ChrPtr(Tmpl->FileName);
1564 int LoadTemplateDir(const char *DirName, HashList *wireless, HashList *big)
1569 DIR *filedir = NULL;
1570 struct dirent *filedir_entry;
1576 StrBufPrintf(Dir, "%s/t", DirName);
1577 filedir = opendir (ChrPtr(Dir));
1578 if (filedir == NULL) {
1583 FileName = NewStrBuf();
1585 while ((filedir_entry = readdir(filedir)))
1589 #ifdef _DIRENT_HAVE_D_NAMELEN
1590 d_namelen = filedir_entry->d_namelen;
1592 d_namelen = strlen(filedir_entry->d_name);
1594 d_without_ext = d_namelen;
1595 while ((d_without_ext > 0) && (filedir_entry->d_name[d_without_ext] != '.'))
1597 if ((d_without_ext == 0) || (d_namelen < 3))
1599 if ((d_namelen > 1) && filedir_entry->d_name[d_namelen - 1] == '~')
1600 continue; /* Ignore backup files... */
1602 IsMobile = (strstr(filedir_entry->d_name, ".m.html")!= NULL);
1603 PStart = filedir_entry->d_name;
1604 StrBufPrintf(FileName, "%s/%s", ChrPtr(Dir), filedir_entry->d_name);
1605 MinorPtr = strchr(filedir_entry->d_name, '.');
1606 if (MinorPtr != NULL)
1608 StrBufPlain(Tag, filedir_entry->d_name, MinorPtr - filedir_entry->d_name);
1610 if (LoadTemplates > 1)
1611 lprintf(1, "%s %d %s\n",ChrPtr(FileName), IsMobile, ChrPtr(Tag));
1612 if (LoadTemplates == 0)
1613 load_template(FileName, Tag, (IsMobile)?wireless:big);
1615 prepare_template(FileName, Tag, (IsMobile)?wireless:big);
1618 FreeStrBuf(&FileName);
1624 void InitTemplateCache(void)
1626 LoadTemplateDir(static_dirs[0],
1627 WirelessTemplateCache,
1629 LoadTemplateDir(static_dirs[1],
1630 WirelessLocalTemplateCache,
1631 LocalTemplateCache);
1636 /*-----------------------------------------------------------------------------
1637 * Filling & processing Templates
1640 * \brief executes one token
1641 * \param Target buffer to append to
1642 * \param Token da to process.
1643 * \param Template we're iterating
1644 * \param Context Contextpoointer to pass in
1645 * \param state are we in conditional state?
1646 * \param ContextType what type of information does context giv us?
1648 int EvaluateToken(StrBuf *Target, int state, WCTemplputParams *TP)
1650 const char *AppendMe;
1652 HashHandler *Handler;
1655 /* much output, since pName is not terminated...
1656 lprintf(1,"Doing token: %s\n",Token->pName);
1659 switch (TP->Tokens->Flags) {
1661 TmplGettext(Target, TP);
1663 case SV_CONDITIONAL: /** Forward conditional evaluation */
1664 return EvaluateConditional(Target, 1, state, TP);
1666 case SV_NEG_CONDITIONAL: /** Reverse conditional evaluation */
1667 return EvaluateConditional(Target, 0, state, TP);
1669 case SV_CUST_STR_CONDITIONAL: /** Conditional put custom strings from params */
1670 if (TP->Tokens->nParameters >= 6) {
1671 if (EvaluateConditional(Target, 0, state, TP)) {
1672 GetTemplateTokenString(Target, TP, 5, &AppendMe, &AppendMeLen);
1673 StrBufAppendBufPlain(Target,
1679 GetTemplateTokenString(Target, TP, 4, &AppendMe, &AppendMeLen);
1680 StrBufAppendBufPlain(Target,
1688 Target, "Conditional", ERR_NAME, TP,
1689 "needs at least 6 Params!");
1693 if (TP->Tokens->nParameters == 1)
1694 DoTemplate(TKEY(0), Target, TP);
1696 case SV_PREEVALUATED:
1697 Handler = (HashHandler*) TP->Tokens->PreEval;
1698 if (!CheckContext(Target, &Handler->Filter, TP, "Token")) {
1701 Handler->HandlerFunc(Target, TP);
1704 if (GetHash(GlobalNS, TP->Tokens->pName, TP->Tokens->NameEnd, &vVar)) {
1705 Handler = (HashHandler*) vVar;
1706 if (!CheckContext(Target, &Handler->Filter, TP, "Token")) {
1710 Handler->HandlerFunc(Target, TP);
1714 print_value_of(Target, TP);
1722 const StrBuf *ProcessTemplate(WCTemplate *Tmpl, StrBuf *Target, WCTemplputParams *CallingTP)
1724 WCTemplate *pTmpl = Tmpl;
1727 const char *pData, *pS;
1729 WCTemplputParams TP;
1731 memcpy(&TP.Filter, &CallingTP->Filter, sizeof(ContextFilter));
1733 TP.Context = CallingTP->Context;
1734 TP.ControlContext = CallingTP->ControlContext;
1736 if (LoadTemplates != 0) {
1737 if (LoadTemplates > 1)
1738 lprintf(1, "DBG: ----- loading: [%s] ------ \n",
1739 ChrPtr(Tmpl->FileName));
1741 pTmpl = load_template(Tmpl->FileName, NULL, NULL);
1745 "<pre>\nError loading Template [%s]\n See Logfile for details\n</pre>\n",
1746 ChrPtr(Tmpl->FileName));
1752 pS = pData = ChrPtr(pTmpl->Data);
1753 len = StrLength(pTmpl->Data);
1757 if (i >= pTmpl->nTokensUsed) {
1758 StrBufAppendBufPlain(Target,
1760 len - (pData - pS), 0);
1764 StrBufAppendBufPlain(
1766 pTmpl->Tokens[i]->pTokenStart - pData, 0);
1767 TP.Tokens = pTmpl->Tokens[i];
1768 TP.nArgs = pTmpl->Tokens[i]->nParameters;
1769 state = EvaluateToken(Target, state, &TP);
1771 while ((state != 0) && (i+1 < pTmpl->nTokensUsed)) {
1772 /* condition told us to skip till its end condition */
1774 TP.Tokens = pTmpl->Tokens[i];
1775 TP.nArgs = pTmpl->Tokens[i]->nParameters;
1776 if ((pTmpl->Tokens[i]->Flags == SV_CONDITIONAL) ||
1777 (pTmpl->Tokens[i]->Flags == SV_NEG_CONDITIONAL)) {
1778 if (state == EvaluateConditional(
1780 pTmpl->Tokens[i]->Flags,
1786 pData = pTmpl->Tokens[i++]->pTokenEnd + 1;
1787 if (i > pTmpl->nTokensUsed)
1791 if (LoadTemplates != 0) {
1792 FreeWCTemplate(pTmpl);
1794 return Tmpl->MimeType;
1799 * \brief Display a variable-substituted template
1800 * \param templatename template file to load
1801 * \returns the mimetype of the template its doing
1803 const StrBuf *DoTemplate(const char *templatename, long len, StrBuf *Target, WCTemplputParams *TP)
1805 WCTemplputParams LocalTP;
1807 HashList *StaticLocal;
1813 memset(&LocalTP, 0, sizeof(WCTemplputParams));
1817 if (WC->is_mobile) {
1818 Static = WirelessTemplateCache;
1819 StaticLocal = WirelessLocalTemplateCache;
1822 Static = TemplateCache;
1823 StaticLocal = LocalTemplateCache;
1828 lprintf (1, "Can't to load a template with empty name!\n");
1829 StrBufAppendPrintf(Target, "<pre>\nCan't to load a template with empty name!\n</pre>");
1833 if (!GetHash(StaticLocal, templatename, len, &vTmpl) &&
1834 !GetHash(Static, templatename, len, &vTmpl)) {
1835 lprintf (1, "didn't find Template [%s] %ld %ld\n", templatename, len , (long)strlen(templatename));
1836 StrBufAppendPrintf(Target, "<pre>\ndidn't find Template [%s] %ld %ld\n</pre>",
1838 (long)strlen(templatename));
1840 dbg_PrintHash(Static, PrintTemplate, NULL);
1841 PrintHash(Static, VarPrintTransition, PrintTemplate);
1847 return ProcessTemplate(vTmpl, Target, TP);
1851 /*-----------------------------------------------------------------------------
1854 typedef struct _HashIterator {
1855 HashList *StaticList;
1856 int AdditionalParams;
1858 int XPectContextType;
1860 RetrieveHashlistFunc GetHash;
1861 HashDestructorFunc Destructor;
1862 SubTemplFunc DoSubTemplate;
1865 void RegisterITERATOR(const char *Name, long len,
1866 int AdditionalParams,
1867 HashList *StaticList,
1868 RetrieveHashlistFunc GetHash,
1869 SubTemplFunc DoSubTempl,
1870 HashDestructorFunc Destructor,
1872 int XPectContextType,
1877 It = (HashIterator*)malloc(sizeof(HashIterator));
1878 memset(It, 0, sizeof(HashIterator));
1879 It->StaticList = StaticList;
1880 It->AdditionalParams = AdditionalParams;
1881 It->GetHash = GetHash;
1882 It->DoSubTemplate = DoSubTempl;
1883 It->Destructor = Destructor;
1884 It->ContextType = ContextType;
1885 It->XPectContextType = XPectContextType;
1887 Put(Iterators, Name, len, It, NULL);
1890 typedef struct _iteratestruct {
1899 int preeval_iterate(WCTemplateToken *Token)
1901 WCTemplputParams TPP;
1902 WCTemplputParams *TP;
1905 memset(&TPP, 0, sizeof(WCTemplputParams));
1908 if (!GetHash(Iterators, TKEY(0), &vIt)) {
1910 NULL, "Iterator", ERR_NAME, TP,
1914 Token->Preeval2 = vIt;
1918 void tmpl_iterate_subtmpl(StrBuf *Target, WCTemplputParams *TP)
1923 SortStruct *SortBy = NULL;
1925 int DetectGroupChange = 0;
1928 void *vLastContext = NULL;
1930 WCTemplputParams SubTP;
1931 IterateStruct Status;
1937 memset(&Status, 0, sizeof(IterateStruct));
1938 memcpy (&SubTP, &TP, sizeof(WCTemplputParams));
1940 It = (HashIterator*) TP->Tokens->Preeval2;
1943 Target, "Iterator", ERR_PARM1, TP, "Unknown!");
1947 if (TP->Tokens->nParameters < It->AdditionalParams + 2) {
1949 Target, "Iterator", ERR_PARM1, TP,
1950 "doesn't work with %d params",
1951 TP->Tokens->nParameters);
1955 if ((It->XPectContextType != CTX_NONE) &&
1956 (It->XPectContextType != TP->Filter.ContextType)) {
1958 Target, "Iterator", ERR_PARM1, TP,
1959 "requires context of type %d, have %d",
1960 It->XPectContextType,
1961 TP->Filter.ContextType);
1966 if (It->StaticList == NULL)
1967 List = It->GetHash(Target, TP);
1969 List = It->StaticList;
1971 DetectGroupChange = (It->Flags & IT_FLAG_DETECT_GROUPCHANGE) != 0;
1972 if (DetectGroupChange) {
1973 const StrBuf *BSort;
1974 DetectGroupChange = 0;
1975 if (havebstr("SortBy")) {
1976 BSort = sbstr("SortBy");
1977 if (GetHash(SortHash, SKEY(BSort), &vSortBy) &&
1978 (vSortBy != NULL)) {
1979 SortBy = (SortStruct*)vSortBy;
1980 /** Ok, its us, lets see in which direction we should sort... */
1981 if (havebstr("SortOrder")) {
1983 SortOrder = LBSTR("SortOrder");
1985 DetectGroupChange = 1;
1990 nMembersUsed = GetCount(List);
1991 SubBuf = NewStrBuf();
1992 SubTP.Filter.ContextType = It->ContextType;
1993 SubTP.Filter.ControlContextType = CTX_ITERATE;
1994 SubTP.ControlContext = &Status;
1996 if (HAVE_PARAM(2)) {
1997 StartAt = GetTemplateTokenNumber(Target, TP, 2, 0);
1999 if (HAVE_PARAM(3)) {
2000 StepWidth = GetTemplateTokenNumber(Target, TP, 3, 0);
2002 if (HAVE_PARAM(4)) {
2003 StopAt = GetTemplateTokenNumber(Target, TP, 4, -1);
2005 it = GetNewHashPos(List, StepWidth);
2007 StopAt = GetCount(List);
2009 while (GetNextHashPos(List, it, &Status.KeyLen, &Status.Key, &vContext)) {
2010 if ((Status.n >= StartAt) && (Status.n <= StopAt)) {
2011 if (DetectGroupChange && Status.n > 0) {
2012 Status.GroupChange = SortBy->GroupChange(vContext, vLastContext);
2014 Status.LastN = (Status.n + 1) == nMembersUsed;
2015 SubTP.Context = vContext;
2016 if (It->DoSubTemplate != NULL)
2017 It->DoSubTemplate(SubBuf, &SubTP);
2018 DoTemplate(TKEY(1), SubBuf, &SubTP);
2020 StrBufAppendBuf(Target, SubBuf, 0);
2021 FlushStrBuf(SubBuf);
2022 Status.oddeven = ! Status.oddeven;
2023 vLastContext = vContext;
2027 FreeStrBuf(&SubBuf);
2029 if (It->Destructor != NULL)
2030 It->Destructor(&List);
2034 int conditional_ITERATE_ISGROUPCHANGE(StrBuf *Target, WCTemplputParams *TP)
2036 IterateStruct *Ctx = CCTX;
2037 if (TP->Tokens->nParameters < 3)
2038 return Ctx->GroupChange;
2040 return TP->Tokens->Params[2]->lvalue == Ctx->GroupChange;
2043 void tmplput_ITERATE_ODDEVEN(StrBuf *Target, WCTemplputParams *TP)
2045 IterateStruct *Ctx = CCTX;
2047 StrBufAppendBufPlain(Target, HKEY("odd"), 0);
2049 StrBufAppendBufPlain(Target, HKEY("even"), 0);
2053 void tmplput_ITERATE_KEY(StrBuf *Target, WCTemplputParams *TP)
2055 IterateStruct *Ctx = CCTX;
2057 StrBufAppendBufPlain(Target, Ctx->Key, Ctx->KeyLen, 0);
2061 void tmplput_ITERATE_LASTN(StrBuf *Target, WCTemplputParams *TP)
2063 IterateStruct *Ctx = CCTX;
2064 StrBufAppendPrintf(Target, "%d", Ctx->n);
2067 int conditional_ITERATE_FIRSTN(StrBuf *Target, WCTemplputParams *TP)
2069 IterateStruct *Ctx = CCTX;
2073 int conditional_ITERATE_LASTN(StrBuf *Target, WCTemplputParams *TP)
2075 IterateStruct *Ctx = CCTX;
2081 /*-----------------------------------------------------------------------------
2084 int EvaluateConditional(StrBuf *Target, int Neg, int state, WCTemplputParams *TP)
2086 ConditionalStruct *Cond;
2088 if ((TP->Tokens->Params[0]->len == 1) &&
2089 (TP->Tokens->Params[0]->Start[0] == 'X'))
2090 return (state != 0)?TP->Tokens->Params[1]->lvalue:0;
2092 Cond = (ConditionalStruct *) TP->Tokens->PreEval;
2095 Target, "Conditional", ERR_PARM1, TP,
2100 if (!CheckContext(Target, &Cond->Filter, TP, "Conditional")) {
2104 if (Cond->CondF(Target, TP) == Neg)
2105 return TP->Tokens->Params[1]->lvalue;
2109 int ConditionalVar(StrBuf *Target, WCTemplputParams *TP)
2114 if (!GetHash(WC->vars, TKEY(2), &vsubst))
2116 subst = (wcsubst*) vsubst;
2118 switch(subst->wcs_type) {
2120 return (subst->wcs_function!=NULL);
2122 lprintf(1, " -> Server [%s]\n", subst->wcs_value);/* TODO */
2126 case WCS_STRBUF_REF:
2127 if (TP->Tokens->nParameters < 4)
2129 return (strcmp(TP->Tokens->Params[3]->Start, ChrPtr(subst->wcs_value)) == 0);
2131 if (TP->Tokens->nParameters < 4)
2132 return (subst->lvalue != 0);
2133 return (subst->lvalue == TP->Tokens->Params[3]->lvalue);
2135 lprintf(1," WARNING: invalid type: [%ld]!\n", subst->wcs_type);
2141 void RegisterConditional(const char *Name, long len,
2143 WCConditionalFunc CondF,
2144 int ContextRequired)
2146 ConditionalStruct *Cond;
2148 Cond = (ConditionalStruct*)malloc(sizeof(ConditionalStruct));
2149 memset(Cond, 0, sizeof(ConditionalStruct));
2150 Cond->PlainName = Name;
2151 Cond->Filter.nMaxArgs = nParams;
2152 Cond->Filter.nMinArgs = nParams;
2153 Cond->CondF = CondF;
2154 Cond->Filter.ContextType = ContextRequired;
2155 Cond->Filter.ControlContextType = CTX_NONE;
2156 Put(Conditionals, Name, len, Cond, NULL);
2159 void RegisterControlConditional(const char *Name, long len,
2161 WCConditionalFunc CondF,
2162 int ControlContextRequired)
2164 ConditionalStruct *Cond;
2166 Cond = (ConditionalStruct*)malloc(sizeof(ConditionalStruct));
2167 memset(Cond, 0, sizeof(ConditionalStruct));
2168 Cond->PlainName = Name;
2169 Cond->Filter.nMaxArgs = nParams;
2170 Cond->Filter.nMinArgs = nParams;
2171 Cond->CondF = CondF;
2172 Cond->Filter.ContextType = CTX_NONE;
2173 Cond->Filter.ControlContextType = ControlContextRequired;
2174 Put(Conditionals, Name, len, Cond, NULL);
2177 /*-----------------------------------------------------------------------------
2180 void tmplput_ContextString(StrBuf *Target, WCTemplputParams *TP)
2182 StrBufAppendTemplate(Target, TP, (StrBuf*)CTX, 0);
2184 int ConditionalContextStr(StrBuf *Target, WCTemplputParams *TP)
2186 StrBuf *TokenText = (StrBuf*) CTX;
2187 const char *CompareToken;
2190 GetTemplateTokenString(Target, TP, 2, &CompareToken, &len);
2191 return strcmp(ChrPtr(TokenText), CompareToken) == 0;
2194 /*-----------------------------------------------------------------------------
2198 void tmpl_do_boxed(StrBuf *Target, WCTemplputParams *TP)
2200 WCTemplputParams SubTP;
2203 if (TP->Tokens->nParameters == 2) {
2204 if (TP->Tokens->Params[1]->Type == TYPE_STR) {
2205 Headline = NewStrBuf();
2206 DoTemplate(TKEY(1), Headline, TP);
2211 GetTemplateTokenString(Target,
2216 Headline = NewStrBufPlain(Ch, len);
2219 memcpy (&SubTP, TP, sizeof(WCTemplputParams));
2220 SubTP.Context = Headline;
2221 SubTP.Filter.ContextType = CTX_STRBUF;
2222 DoTemplate(HKEY("beginbox"), Target, &SubTP);
2223 DoTemplate(TKEY(0), Target, TP);
2224 DoTemplate(HKEY("endbox"), Target, TP);
2225 FreeStrBuf(&Headline);
2228 /*-----------------------------------------------------------------------------
2232 void tmpl_do_tabbed(StrBuf *Target, WCTemplputParams *TP)
2235 int i, ntabs, nTabs;
2237 nTabs = ntabs = TP->Tokens->nParameters / 2;
2238 TabNames = (StrBuf **) malloc(ntabs * sizeof(StrBuf*));
2239 memset(TabNames, 0, ntabs * sizeof(StrBuf*));
2241 for (i = 0; i < ntabs; i++) {
2242 if ((TP->Tokens->Params[i * 2]->Type == TYPE_STR) &&
2243 (TP->Tokens->Params[i * 2]->len > 0)) {
2244 TabNames[i] = NewStrBuf();
2245 DoTemplate(TKEY(i * 2), TabNames[i], TP);
2247 else if (TP->Tokens->Params[i * 2]->Type == TYPE_GETTEXT) {
2250 GetTemplateTokenString(Target,
2255 TabNames[i] = NewStrBufPlain(Ch, -1);
2258 /** A Tab without subject? we can't count that, add it as silent */
2263 StrTabbedDialog(Target, nTabs, TabNames);
2264 for (i = 0; i < ntabs; i++) {
2265 StrBeginTab(Target, i, nTabs);
2266 DoTemplate(TKEY(i * 2 + 1), Target, TP);
2267 StrEndTab(Target, i, nTabs);
2272 /*-----------------------------------------------------------------------------
2277 void RegisterSortFunc(const char *name, long len,
2278 const char *prepend, long preplen,
2279 CompareFunc Forward,
2280 CompareFunc Reverse,
2281 CompareFunc GroupChange,
2284 SortStruct *NewSort;
2286 NewSort = (SortStruct*) malloc(sizeof(SortStruct));
2287 memset(NewSort, 0, sizeof(SortStruct));
2288 NewSort->Name = NewStrBufPlain(name, len);
2289 if (prepend != NULL)
2290 NewSort->PrefPrepend = NewStrBufPlain(prepend, preplen);
2292 NewSort->PrefPrepend = NULL;
2293 NewSort->Forward = Forward;
2294 NewSort->Reverse = Reverse;
2295 NewSort->GroupChange = GroupChange;
2296 NewSort->ContextType = ContextType;
2297 Put(SortHash, name, len, NewSort, DestroySortStruct);
2300 CompareFunc RetrieveSort(WCTemplputParams *TP,
2301 const char *OtherPrefix, long OtherPrefixLen,
2302 const char *Default, long ldefault, long DefaultDirection)
2305 const StrBuf *BSort = NULL;
2308 long SortOrder = -1;
2310 if (havebstr("SortBy")) {
2311 BSort = sbstr("SortBy");
2312 if (OtherPrefix == NULL) {
2313 set_room_pref("sort", NewStrBufDup(BSort), 0);
2316 set_X_PREFS(HKEY("sort"), OtherPrefix, OtherPrefixLen, NewStrBufDup(BSort), 0);
2319 else { /** Try to fallback to our remembered values... */
2320 if (OtherPrefix == NULL) {
2321 BSort = get_room_pref("sort");
2324 BSort = get_X_PREFS(HKEY("sort"), OtherPrefix, OtherPrefixLen);
2327 putbstr("SortBy", NewStrBufDup(BSort));
2331 BSort = Buf = NewStrBufPlain(Default, ldefault);
2332 putbstr("SortBy", Buf);
2336 if (!GetHash(SortHash, SKEY(BSort), &vSortBy) ||
2337 (vSortBy == NULL)) {
2339 if (!GetHash(SortHash, Default, ldefault, &vSortBy) ||
2340 (vSortBy == NULL)) {
2342 NULL, "Sorting", ERR_PARM1, TP,
2343 "Illegal default sort: [%s]", Default);
2347 SortBy = (SortStruct*)vSortBy;
2349 /** Ok, its us, lets see in which direction we should sort... */
2350 if (havebstr("SortOrder")) {
2351 SortOrder = LBSTR("SortOrder");
2353 else { /** Try to fallback to our remembered values... */
2355 if (SortBy->PrefPrepend == NULL) {
2356 Buf = get_room_pref("SortOrder");
2357 SortOrder = StrTol(Buf);
2360 BSort = get_X_PREFS(HKEY("SortOrder"), OtherPrefix, OtherPrefixLen);
2364 SortOrder = DefaultDirection;
2366 Buf = NewStrBufPlain(NULL, 64);
2367 StrBufPrintf(Buf, "%ld", SortOrder);
2368 putbstr("SortOrder", Buf);
2370 switch (SortOrder) {
2375 return SortBy->Forward;
2377 return SortBy->Reverse;
2389 ConstStr SortIcons[] = {
2390 {HKEY("static/sort_none.gif")},
2391 {HKEY("static/up_pointer.gif")},
2392 {HKEY("static/down_pointer.gif")},
2395 ConstStr SortNextOrder[] = {
2402 int GetSortMetric(WCTemplputParams *TP, SortStruct **Next, SortStruct **Param, long *SortOrder, int N)
2404 int bSortError = eNOT_SPECIFIED;
2405 const StrBuf *BSort;
2410 if (!GetHash(SortHash, TKEY(0), &vSort) ||
2412 return eNO_SUCH_SORT;
2413 *Param = (SortStruct*) vSort;
2416 if (havebstr("SortBy")) {
2417 BSort = sbstr("SortBy");
2418 bSortError = eINVALID_PARAM;
2419 if ((*Param)->PrefPrepend == NULL) {
2420 set_room_pref("sort", NewStrBufDup(BSort), 0);
2423 set_X_PREFS(HKEY("sort"), TKEY(N), NewStrBufDup(BSort), 0);
2426 else { /** Try to fallback to our remembered values... */
2427 if ((*Param)->PrefPrepend == NULL) {
2428 BSort = get_room_pref("sort");
2431 BSort = get_X_PREFS(HKEY("sort"), TKEY(N));
2435 if (!GetHash(SortHash, SKEY(BSort), &vSort) ||
2439 *Next = (SortStruct*) vSort;
2441 /** Ok, its us, lets see in which direction we should sort... */
2442 if (havebstr("SortOrder")) {
2443 *SortOrder = LBSTR("SortOrder");
2445 else { /** Try to fallback to our remembered values... */
2446 if ((*Param)->PrefPrepend == NULL) {
2447 *SortOrder = StrTol(get_room_pref("SortOrder"));
2450 *SortOrder = StrTol(get_X_PREFS(HKEY("SortOrder"), TKEY(N)));
2460 void tmplput_SORT_ICON(StrBuf *Target, WCTemplputParams *TP)
2465 const ConstStr *SortIcon;
2467 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2470 Target, "Sorter", ERR_PARM1, TP,
2471 " Sorter [%s] unknown!",
2472 TP->Tokens->Params[0]->Start);
2474 case eINVALID_PARAM:
2475 LogTemplateError(NULL, "Sorter", ERR_PARM1, TP,
2476 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2478 case eNOT_SPECIFIED:
2480 if (Next == Param) {
2481 SortIcon = &SortIcons[SortOrder];
2483 else { /** Not Us... */
2484 SortIcon = &SortIcons[0];
2486 StrBufAppendBufPlain(Target, SortIcon->Key, SortIcon->len, 0);
2490 void tmplput_SORT_NEXT(StrBuf *Target, WCTemplputParams *TP)
2496 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2499 Target, "Sorter", ERR_PARM1, TP,
2500 " Sorter [%s] unknown!",
2501 TP->Tokens->Params[0]->Start);
2503 case eINVALID_PARAM:
2505 NULL, "Sorter", ERR_PARM1, TP,
2506 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2508 case eNOT_SPECIFIED:
2510 StrBufAppendBuf(Target, Param->Name, 0);
2515 void tmplput_SORT_ORDER(StrBuf *Target, WCTemplputParams *TP)
2518 const ConstStr *SortOrderStr;
2522 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2525 Target, "Sorter", ERR_PARM1, TP,
2526 " Sorter [%s] unknown!",
2527 TP->Tokens->Params[0]->Start);
2529 case eINVALID_PARAM:
2531 NULL, "Sorter", ERR_PARM1, TP,
2532 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2534 case eNOT_SPECIFIED:
2536 if (Next == Param) {
2537 SortOrderStr = &SortNextOrder[SortOrder];
2539 else { /** Not Us... */
2540 SortOrderStr = &SortNextOrder[0];
2542 StrBufAppendBufPlain(Target, SortOrderStr->Key, SortOrderStr->len, 0);
2547 void tmplput_long_vector(StrBuf *Target, WCTemplputParams *TP)
2549 long *LongVector = (long*) CTX;
2551 if ((TP->Tokens->Params[0]->Type == TYPE_LONG) &&
2552 (TP->Tokens->Params[0]->lvalue <= LongVector[0]))
2554 StrBufAppendPrintf(Target, "%ld", LongVector[TP->Tokens->Params[0]->lvalue]);
2558 if (TP->Tokens->Params[0]->Type != TYPE_LONG) {
2560 Target, "Longvector", ERR_NAME, TP,
2561 "needs a numerical Parameter!");
2565 Target, "LongVector", ERR_PARM1, TP,
2566 "doesn't have %ld Parameters, its just the size of %ld!",
2567 TP->Tokens->Params[0]->lvalue,
2573 void dbg_print_longvector(long *LongVector)
2575 StrBuf *Buf = NewStrBufPlain(HKEY("Longvector: ["));
2576 int nItems = LongVector[0];
2579 for (i = 0; i < nItems; i++) {
2581 StrBufAppendPrintf(Buf, "%d: %ld | ", i, LongVector[i]);
2583 StrBufAppendPrintf(Buf, "%d: %ld]\n", i, LongVector[i]);
2586 lprintf(1, ChrPtr(Buf));
2590 int ConditionalLongVector(StrBuf *Target, WCTemplputParams *TP)
2592 long *LongVector = (long*) CTX;
2594 if ((TP->Tokens->Params[2]->Type == TYPE_LONG) &&
2595 (TP->Tokens->Params[2]->lvalue <= LongVector[0])&&
2596 (TP->Tokens->Params[3]->Type == TYPE_LONG) &&
2597 (TP->Tokens->Params[3]->lvalue <= LongVector[0]))
2599 return LongVector[TP->Tokens->Params[2]->lvalue] ==
2600 LongVector[TP->Tokens->Params[3]->lvalue];
2604 if ((TP->Tokens->Params[2]->Type == TYPE_LONG) ||
2605 (TP->Tokens->Params[2]->Type == TYPE_LONG)) {
2607 Target, "ConditionalLongvector", ERR_PARM1, TP,
2608 "needs two long Parameter!");
2612 Target, "Longvector", ERR_PARM1, TP,
2613 "doesn't have %ld / %ld Parameters, its just the size of %ld!",
2614 TP->Tokens->Params[2]->lvalue,
2615 TP->Tokens->Params[3]->lvalue,
2626 memset(&NoCtx, 0, sizeof(WCTemplputParams));
2627 RegisterNamespace("SORT:ICON", 1, 2, tmplput_SORT_ICON, NULL, CTX_NONE);
2628 RegisterNamespace("SORT:ORDER", 1, 2, tmplput_SORT_ORDER, NULL, CTX_NONE);
2629 RegisterNamespace("SORT:NEXT", 1, 2, tmplput_SORT_NEXT, NULL, CTX_NONE);
2630 RegisterNamespace("CONTEXTSTR", 0, 1, tmplput_ContextString, NULL, CTX_STRBUF);
2631 RegisterNamespace("ITERATE", 2, 100, tmpl_iterate_subtmpl, preeval_iterate, CTX_NONE);
2632 RegisterNamespace("DOBOXED", 1, 2, tmpl_do_boxed, NULL, CTX_NONE);
2633 RegisterNamespace("DOTABBED", 2, 100, tmpl_do_tabbed, NULL, CTX_NONE);
2634 RegisterNamespace("LONGVECTOR", 1, 1, tmplput_long_vector, NULL, CTX_LONGVECTOR);
2635 RegisterConditional(HKEY("COND:SUBST"), 3, ConditionalVar, CTX_NONE);
2636 RegisterConditional(HKEY("COND:CONTEXTSTR"), 3, ConditionalContextStr, CTX_STRBUF);
2637 RegisterConditional(HKEY("COND:LONGVECTOR"), 4, ConditionalLongVector, CTX_LONGVECTOR);
2639 RegisterControlConditional(HKEY("COND:ITERATE:ISGROUPCHANGE"), 2,
2640 conditional_ITERATE_ISGROUPCHANGE,
2642 RegisterControlConditional(HKEY("COND:ITERATE:LASTN"), 2,
2643 conditional_ITERATE_LASTN,
2645 RegisterControlConditional(HKEY("COND:ITERATE:FIRSTN"), 2,
2646 conditional_ITERATE_FIRSTN,
2649 RegisterControlNS(HKEY("ITERATE:ODDEVEN"), 0, 0, tmplput_ITERATE_ODDEVEN, CTX_ITERATE);
2650 RegisterControlNS(HKEY("ITERATE:KEY"), 0, 0, tmplput_ITERATE_KEY, CTX_ITERATE);
2651 RegisterControlNS(HKEY("ITERATE:N"), 0, 0, tmplput_ITERATE_LASTN, CTX_ITERATE);
2655 ServerStartModule_SUBST
2658 WirelessTemplateCache = NewHash(1, NULL);
2659 WirelessLocalTemplateCache = NewHash(1, NULL);
2660 LocalTemplateCache = NewHash(1, NULL);
2661 TemplateCache = NewHash(1, NULL);
2663 GlobalNS = NewHash(1, NULL);
2664 Iterators = NewHash(1, NULL);
2665 Conditionals = NewHash(1, NULL);
2666 SortHash = NewHash(1, NULL);
2670 FinalizeModule_SUBST
2677 ServerShutdownModule_SUBST
2680 DeleteHash(&WirelessTemplateCache);
2681 DeleteHash(&WirelessLocalTemplateCache);
2682 DeleteHash(&TemplateCache);
2683 DeleteHash(&LocalTemplateCache);
2685 DeleteHash(&GlobalNS);
2686 DeleteHash(&Iterators);
2687 DeleteHash(&Conditionals);
2688 DeleteHash(&SortHash);
2694 SessionNewModule_SUBST
2701 SessionAttachModule_SUBST
2704 sess->vars = NewHash(1,NULL);
2708 SessionDetachModule_SUBST
2711 DeleteHash(&sess->vars);
2715 SessionDestroyModule_SUBST