1 // This is a template substitution engine, which began with good intentions, but ended up becoming
2 // more complex and unmaintainable than what it replaced. We are barely hanging on with this until
3 // webcit-ng replaces webcit classic.
15 #define SHOW_ME_VAPPEND_PRINTF
20 extern char *static_dirs[PATH_MAX]; /* Disk representation */
22 HashList *TemplateCache;
23 HashList *LocalTemplateCache;
27 HashList *Conditionals;
31 int DumpTemplateI18NStrings = 0;
32 int LoadTemplates = 0;
33 int dbg_backtrace_template_errors = 0;
34 WCTemplputParams NoCtx;
35 StrBuf *I18nDump = NULL;
37 const char EmptyStr[]="";
40 #define SV_CONDITIONAL 2
41 #define SV_NEG_CONDITIONAL 3
42 #define SV_CUST_STR_CONDITIONAL 4
44 #define SV_PREEVALUATED 6
49 * Dynamic content for variable substitution in templates
51 typedef struct _wcsubst {
53 int wcs_type; /* which type of Substitution are we */
54 char wcs_key[32]; /* copy of our hashkey for debugging */
55 StrBuf *wcs_value; /* if we're a string, keep it here */
56 long lvalue; /* type long? keep data here */
57 WCHandlerFunc wcs_function; /* funcion hook ???*/
61 typedef struct _WCTemplate {
67 WCTemplateToken **Tokens;
70 typedef struct _HashHandler {
72 WCPreevalFunc PreEvalFunc;
73 WCHandlerFunc HandlerFunc;
76 typedef enum _estate {
81 void *load_template(StrBuf *Target, WCTemplate *NewTemplate);
82 int EvaluateConditional(StrBuf *Target, int Neg, int state, WCTemplputParams **TPP);
86 typedef struct _SortStruct {
91 CompareFunc GroupChange;
96 HashList *CtxList = NULL;
98 static CtxType CtxCounter = CTX_NONE;
100 CtxType CTX_STRBUF = CTX_NONE;
101 CtxType CTX_STRBUFARR = CTX_NONE;
102 CtxType CTX_LONGVECTOR = CTX_NONE;
104 CtxType CTX_ITERATE = CTX_NONE;
105 CtxType CTX_TAB = CTX_NONE;
107 void HFreeContextType(void *pCtx)
109 CtxTypeStruct *FreeStruct = (CtxTypeStruct *) pCtx;
110 FreeStrBuf(&FreeStruct->Name);
113 void PutContextType(const char *name, long len, CtxType TheCtx)
115 CtxTypeStruct *NewStruct;
117 NewStruct = (CtxTypeStruct*) malloc(sizeof(CtxTypeStruct));
118 NewStruct->Name = NewStrBufPlain(name, len);
119 NewStruct->Type = TheCtx;
121 Put(CtxList, IKEY(NewStruct->Type), NewStruct, HFreeContextType);
123 void RegisterContextType(const char *name, long len, CtxType *TheCtx)
125 if (*TheCtx != CTX_NONE)
128 *TheCtx = ++CtxCounter;
129 PutContextType(name, len, *TheCtx);
132 CtxTypeStruct *GetContextType(CtxType Type)
135 GetHash(CtxList, IKEY(Type), &pv);
139 const char *UnknownContext = "CTX_UNKNOWN";
141 const char *ContextName(CtxType ContextType)
145 pCtx = GetContextType(ContextType);
148 return ChrPtr(pCtx->Name);
150 return UnknownContext;
153 void StackDynamicContext(WCTemplputParams *Super,
154 WCTemplputParams *Sub,
158 WCTemplateToken *Tokens,
159 WCConditionalFunc ExitCtx,
162 memset(Sub, 0, sizeof(WCTemplputParams));
165 Sub->Sub = Super->Sub;
168 if (Sub->Sub != NULL)
169 Sub->Sub->Super = Sub;
172 Sub->Context = Context;
173 Sub->Filter.ContextType = ContextType;
175 Sub->Tokens = Tokens;
176 Sub->ExitCtx = ExitCtx;
177 Sub->ExitCTXID = ExitCTXID;
180 void UnStackContext(WCTemplputParams *Sub)
182 if (Sub->Super != NULL)
184 Sub->Super->Sub = Sub->Sub;
186 if (Sub->Sub != NULL)
188 Sub->Sub->Super = Sub->Super;
191 void UnStackDynamicContext(StrBuf *Target, WCTemplputParams **TPP)
193 WCTemplputParams *TP = *TPP;
194 WCTemplputParams *Super = TP->Super;
195 TP->ExitCtx(Target, TP);
199 void *GetContextPayload(WCTemplputParams *TP, CtxType ContextType)
201 WCTemplputParams *whichTP = TP;
203 if (ContextType == CTX_NONE)
206 while ((whichTP != NULL) && (whichTP->Filter.ContextType != ContextType))
207 whichTP = whichTP->Super;
209 return whichTP->Context;
212 void DestroySortStruct(void *vSort)
214 SortStruct *Sort = (SortStruct*) vSort;
215 FreeStrBuf(&Sort->Name);
216 FreeStrBuf(&Sort->PrefPrepend);
221 void LogTemplateError (StrBuf *Target, const char *Type, int ErrorPos, WCTemplputParams *TP, const char *Format, ...)
226 const char *Err = NULL;
231 va_start(arg_ptr, Format);
232 StrBufVAppendPrintf(Error, Format, arg_ptr);
236 case ERR_NAME: /* the main token name... */
237 Err = (TP->Tokens!= NULL)? TP->Tokens->pName:"";
240 Err = ((TP->Tokens!= NULL) &&
241 (TP->Tokens->nParameters > ErrorPos - 1))?
242 TP->Tokens->Params[ErrorPos - 1]->Start : "";
245 if (TP->Tokens != NULL)
247 syslog(LOG_WARNING, "%s [%s] (in '%s' line %ld); %s; [%s]\n",
250 ChrPtr(TP->Tokens->FileName),
253 ChrPtr(TP->Tokens->FlatToken));
257 syslog(LOG_WARNING, "%s: %s;\n",
267 if (WC->WFBuf == NULL) WC->WFBuf = NewStrBuf();
268 if (TP->Tokens != NULL)
273 "<pre>\n%s [%s] (in '%s' line %ld); %s\n[%s]\n</pre>\n",
276 ChrPtr(TP->Tokens->FileName),
279 ChrPtr(TP->Tokens->FlatToken));
281 StrBufPrintf(Info, "%s [%s] %s; [%s]",
285 ChrPtr(TP->Tokens->FlatToken));
288 SerializeJson(WC->WFBuf, WildFireException(SKEY(TP->Tokens->FileName),
294 StrBufPrintf(Info, "%s [%s] %s; [%s]",
298 ChrPtr(TP->Tokens->FlatToken));
299 SerializeJson(WC->WFBuf, WildFireException(HKEY(__FILE__), __LINE__, Info, 1), 1);
306 void LogError (StrBuf *Target, const char *Type, const char *Format, ...) {
314 va_start(arg_ptr, Format);
315 StrBufVAppendPrintf(Error, Format, arg_ptr);
318 syslog(LOG_WARNING, "%s", ChrPtr(Error));
320 if (WC->WFBuf == NULL) WC->WFBuf = NewStrBuf();
322 SerializeJson(WC->WFBuf, WildFireException(Type, strlen(Type),
332 void RegisterNS(const char *NSName,
336 WCHandlerFunc HandlerFunc,
337 WCPreevalFunc PreevalFunc,
338 CtxType ContextRequired)
340 HashHandler *NewHandler;
342 NewHandler = (HashHandler*) malloc(sizeof(HashHandler));
343 memset(NewHandler, 0, sizeof(HashHandler));
344 NewHandler->Filter.nMinArgs = nMinArgs;
345 NewHandler->Filter.nMaxArgs = nMaxArgs;
346 NewHandler->Filter.ContextType = ContextRequired;
348 NewHandler->PreEvalFunc = PreevalFunc;
349 NewHandler->HandlerFunc = HandlerFunc;
350 Put(GlobalNS, NSName, len, NewHandler, NULL);
355 int CheckContext(StrBuf *Target, ContextFilter *Need, WCTemplputParams *TP, const char *ErrType)
357 WCTemplputParams *TPP = TP;
359 if ((Need != NULL) &&
360 (Need->ContextType != CTX_NONE) &&
361 (Need->ContextType != TPP->Filter.ContextType)) {
363 while ((TPP != NULL) &&
364 (Need->ContextType != TPP->Filter.ContextType))
373 Target, ErrType, ERR_NAME, TP,
374 " WARNING: requires Context: [%s], have [%s]!",
375 ContextName(Need->ContextType),
376 ContextName(TP->Filter.ContextType));
382 void FreeToken(WCTemplateToken **Token) {
384 FreeStrBuf(&(*Token)->FlatToken);
385 if ((*Token)->HaveParameters)
386 for (i = 0; i < (*Token)->nParameters; i++)
387 free((*Token)->Params[i]);
393 void FreeWCTemplate(void *vFreeMe) {
395 WCTemplate *FreeMe = (WCTemplate*)vFreeMe;
397 if (FreeMe->TokenSpace > 0) {
398 for (i = 0; i < FreeMe->nTokensUsed; i ++) {
399 FreeToken(&FreeMe->Tokens[i]);
401 free(FreeMe->Tokens);
403 FreeStrBuf(&FreeMe->FileName);
404 FreeStrBuf(&FreeMe->Data);
405 FreeStrBuf(&FreeMe->MimeType);
409 int HaveTemplateTokenString(StrBuf *Target,
410 WCTemplputParams *TP,
415 if (N >= TP->Tokens->nParameters) {
419 switch (TP->Tokens->Params[N]->Type) {
424 case TYPE_ROOMPREFSTR:
426 case TYPE_SUBTEMPLATE:
435 void GetTemplateTokenString(StrBuf *Target, WCTemplputParams *TP, int N, const char **Value, long *len) {
438 if (N >= TP->Tokens->nParameters) {
439 LogTemplateError(Target,
440 "TokenParameter", N, TP,
441 "invalid token %d. this shouldn't have come till here.\n", N);
447 switch (TP->Tokens->Params[N]->Type) {
451 *Value = TP->Tokens->Params[N]->Start;
452 *len = TP->Tokens->Params[N]->len;
455 if (TP->Tokens->Params[N]->len == 0) {
456 LogTemplateError(Target,
457 "TokenParameter", N, TP,
458 "Requesting parameter %d; of type BSTR, empty lookup string not admitted.", N);
463 Buf = (StrBuf*) SBstr(TKEY(N));
464 *Value = ChrPtr(Buf);
465 *len = StrLength(Buf);
468 if (TP->Tokens->Params[N]->len == 0) {
469 LogTemplateError(Target,
470 "TokenParameter", N, TP,
471 "Requesting parameter %d; of type PREFSTR, empty lookup string not admitted.", N);
476 get_PREFERENCE(TKEY(N), &Buf);
477 *Value = ChrPtr(Buf);
478 *len = StrLength(Buf);
480 case TYPE_ROOMPREFSTR:
481 if (TP->Tokens->Params[N]->len == 0) {
482 LogTemplateError(Target,
483 "TokenParameter", N, TP,
484 "Requesting parameter %d; of type PREFSTR, empty lookup string not admitted.", N);
489 Buf = get_ROOM_PREFS(TKEY(N));
490 *Value = ChrPtr(Buf);
491 *len = StrLength(Buf);
494 LogTemplateError(Target,
495 "TokenParameter", N, TP,
496 "Requesting parameter %d; of type LONG, want string.", N);
499 LogTemplateError(Target,
500 "TokenParameter", N, TP,
501 "Requesting parameter %d; of type PREFINT, want string.", N);
504 *Value = _(TP->Tokens->Params[N]->Start);
505 *len = strlen(*Value);
507 case TYPE_SUBTEMPLATE:
508 if (TP->Tokens->Params[N]->len == 0) {
509 LogTemplateError(Target,
510 "TokenParameter", N, TP,
511 "Requesting parameter %d; of type SUBTEMPLATE, empty lookup string not admitted.", N);
518 DoTemplate(TKEY(N), Buf, TP);
520 *Value = ChrPtr(Buf);
521 *len = StrLength(Buf);
522 /* we can't free it here, so we put it into the subst so its discarded later on. */
523 PutRequestLocalMem(Buf, HFreeStrBuf);
527 LogTemplateError(Target,
528 "TokenParameter", N, TP,
529 "unknown param type %d; [%d]", N, TP->Tokens->Params[N]->Type);
534 long GetTemplateTokenNumber(StrBuf *Target, WCTemplputParams *TP, int N, long dflt) {
536 if (N >= TP->Tokens->nParameters) {
537 LogTemplateError(Target,
538 "TokenParameter", N, TP,
539 "invalid token %d. this shouldn't have come till here.\n", N);
540 wc_backtrace(LOG_DEBUG);
544 switch (TP->Tokens->Params[N]->Type) {
547 return atol(TP->Tokens->Params[N]->Start);
550 if (TP->Tokens->Params[N]->len == 0) {
551 LogTemplateError(Target,
552 "TokenParameter", N, TP,
553 "Requesting parameter %d; of type BSTR, empty lookup string not admitted.", N);
556 return LBstr(TKEY(N));
559 LogTemplateError(Target,
560 "TokenParameter", N, TP,
561 "requesting a prefstring in param %d want a number", N);
562 if (TP->Tokens->Params[N]->len == 0) {
563 LogTemplateError(Target,
564 "TokenParameter", N, TP,
565 "Requesting parameter %d; of type PREFSTR, empty lookup string not admitted.", N);
568 if (get_PREF_LONG(TKEY(N), &Ret, dflt))
571 case TYPE_ROOMPREFSTR:
572 LogTemplateError(Target,
573 "TokenParameter", N, TP,
574 "requesting a prefstring in param %d want a number", N);
575 if (TP->Tokens->Params[N]->len == 0) {
576 LogTemplateError(Target,
577 "TokenParameter", N, TP,
578 "Requesting parameter %d; of type PREFSTR, empty lookup string not admitted.", N);
581 if (get_ROOM_PREFS_LONG(TKEY(N), &Ret, dflt))
586 return TP->Tokens->Params[N]->lvalue;
588 if (TP->Tokens->Params[N]->len == 0) {
589 LogTemplateError(Target,
590 "TokenParameter", N, TP,
591 "Requesting parameter %d; of type PREFINT, empty lookup string not admitted.", N);
594 if (get_PREF_LONG(TKEY(N), &Ret, dflt))
598 LogTemplateError(Target,
599 "TokenParameter", N, TP,
600 "requesting a I18N string in param %d; want a number", N);
602 case TYPE_SUBTEMPLATE:
603 LogTemplateError(Target,
604 "TokenParameter", N, TP,
605 "requesting a subtemplate in param %d; not supported for numbers", N);
608 LogTemplateError(Target,
609 "TokenParameter", N, TP,
610 "unknown param type %d; [%d]", N, TP->Tokens->Params[N]->Type);
617 * puts string into the template and computes which escape methon we should use
618 * Source = the string we should put into the template
619 * FormatTypeIndex = where should we look for escape types if?
621 void StrBufAppendTemplate(StrBuf *Target,
622 WCTemplputParams *TP,
623 const StrBuf *Source, int FormatTypeIndex)
625 const char *pFmt = NULL;
628 if ((FormatTypeIndex < TP->Tokens->nParameters) &&
629 (TP->Tokens->Params[FormatTypeIndex] != NULL) &&
630 (TP->Tokens->Params[FormatTypeIndex]->Type == TYPE_STR) &&
631 (TP->Tokens->Params[FormatTypeIndex]->len >= 1)) {
632 pFmt = TP->Tokens->Params[FormatTypeIndex]->Start;
639 StrEscAppend(Target, Source, NULL, 0, 2);
642 if (!IsEmptyStr(ChrPtr(Source))) {
643 StrEscAppend(Target, Source, NULL, 0, 0);
645 StrBufAppendBufPlain(Target, pFmt, -1, 1);
650 StrECMAEscAppend(Target, Source, NULL);
653 StrHtmlEcmaEscAppend(Target, Source, NULL, 0, 0);
656 StrBufUrlescAppend(Target, Source, NULL);
659 if (pFmt != NULL) pFmt++;
660 else pFmt = "JUSTIFY";
661 if (*pFmt == '\0') pFmt = "JUSTIFY";
662 FmOut(Target, pFmt, Source);
665 StrBufAppendBuf(Target, Source, 0);
670 * puts string into the template and computes which escape methon we should use
671 * Source = the string we should put into the template
672 * FormatTypeIndex = where should we look for escape types if?
674 void StrBufAppendTemplateStr(StrBuf *Target,
675 WCTemplputParams *TP,
676 const char *Source, int FormatTypeIndex)
678 const char *pFmt = NULL;
681 if ((FormatTypeIndex < TP->Tokens->nParameters) &&
682 (TP->Tokens->Params[FormatTypeIndex]->Type == TYPE_STR) &&
683 (TP->Tokens->Params[FormatTypeIndex]->len >= 1)) {
684 pFmt = TP->Tokens->Params[FormatTypeIndex]->Start;
691 StrEscAppend(Target, NULL, Source, 0, 2);
694 StrEscAppend(Target, NULL, Source, 0, 0);
697 StrECMAEscAppend(Target, NULL, Source);
700 StrHtmlEcmaEscAppend(Target, NULL, Source, 0, 0);
703 StrBufUrlescAppend(Target, NULL, Source);
707 if (pFmt != NULL) pFmt++;
708 else pFmt = "JUSTIFY";
709 if (*pFmt == '\0') pFmt = "JUSTIFY";
710 FmOut(Target, pFmt, Source);
714 StrBufAppendBufPlain(Target, Source, -1, 0);
719 void PutNewToken(WCTemplate *Template, WCTemplateToken *NewToken)
721 if (Template->nTokensUsed + 1 >= Template->TokenSpace) {
722 if (Template->TokenSpace <= 0) {
723 Template->Tokens = (WCTemplateToken**)malloc(
724 sizeof(WCTemplateToken*) * 10);
725 memset(Template->Tokens, 0, sizeof(WCTemplateToken*) * 10);
726 Template->TokenSpace = 10;
729 WCTemplateToken **NewTokens;
731 NewTokens= (WCTemplateToken**) malloc(
732 sizeof(WCTemplateToken*) * Template->TokenSpace * 2);
735 0, sizeof(WCTemplateToken*) * Template->TokenSpace * 2);
739 sizeof(WCTemplateToken*) * Template->nTokensUsed);
741 free(Template->Tokens);
742 Template->TokenSpace *= 2;
743 Template->Tokens = NewTokens;
746 Template->Tokens[(Template->nTokensUsed)++] = NewToken;
749 int GetNextParameter(StrBuf *Buf,
752 WCTemplateToken *Tokens,
754 WCTemplputParams *TP,
755 TemplateParam **pParm)
757 const char *pch = *pCh;
758 const char *pchs, *pche;
763 *pParm = Parm = (TemplateParam *) malloc(sizeof(TemplateParam));
764 memset(Parm, 0, sizeof(TemplateParam));
765 Parm->Type = TYPE_STR;
767 /* Skip leading whitespaces */
768 while ((*pch == ' ' )||
771 (*pch == '\n')) pch ++;
774 Parm->Type = TYPE_PREFSTR;
781 else if (*pch == '.') {
782 Parm->Type = TYPE_ROOMPREFSTR;
789 else if (*pch == ';') {
790 Parm->Type = TYPE_PREFINT;
797 else if (*pch == '#') {
798 Parm->Type = TYPE_INTDEFINE;
801 else if (*pch == '_') {
802 Parm->Type = TYPE_GETTEXT;
809 else if (*pch == 'B') {
810 Parm->Type = TYPE_BSTR;
817 else if (*pch == '=') {
818 Parm->Type = TYPE_SUBTEMPLATE;
829 else if (*pch == '\'')
836 ( (pch > pchs) && (*(pch - 1) == '\\'))
842 syslog(LOG_WARNING, "Error (in '%s' line %ld); "
843 "evaluating template param [%s] in Token [%s]\n",
844 ChrPtr(pTmpl->FileName),
846 ChrPtr(Tokens->FlatToken),
854 StrBufPeek(Buf, pch, -1, '\0');
855 if (LoadTemplates > 1) {
857 "DBG: got param [%s] "SIZE_T_FMT" "SIZE_T_FMT"\n",
858 pchs, pche - pchs, strlen(pchs)
862 Parm->len = pche - pchs;
863 pch ++; /* move after trailing quote */
864 if (ParamBrace && (*pch == ')')) {
871 Parm->Type = TYPE_LONG;
873 while ((pch <= pe) &&
880 StrBufPeek(Buf, pch, -1, '\0');
881 Parm->lvalue = atol(pchs);
888 syslog(LOG_DEBUG, "Error (in '%s' line %ld); "
889 "evaluating long template param [%s] in Token [%s]\n",
890 ChrPtr(pTmpl->FileName),
892 ChrPtr(Tokens->FlatToken),
900 while ((*pch == ' ' )||
904 (*pch == '\n')) pch ++;
909 if (DumpTemplateI18NStrings) {
910 StrBufAppendPrintf(I18nDump, "_(\"%s\");\n", Parm->Start);
913 case TYPE_INTDEFINE: {
916 if (GetHash(Defines, Parm->Start, Parm->len, &vPVal) &&
920 PVal = (long*) vPVal;
922 Parm->lvalue = *PVal;
924 else if (strchr(Parm->Start, '|') != NULL)
931 pToken = NewStrBufPlain (Parm->Start, Parm->len);
932 Match = NewStrBufPlain (NULL, Parm->len);
933 Pos = ChrPtr(pToken);
935 while ((Pos != NULL) && (Pos != StrBufNOTNULL))
937 StrBufExtract_NextToken(Match, pToken, &Pos, '|');
939 if (StrLength (Match) > 0)
941 if (GetHash(Defines, SKEY(Match), &vPVal) &&
945 PVal = (long*) vPVal;
947 Parm->lvalue |= *PVal;
950 LogTemplateError(NULL, "Define",
962 else if (strchr(Parm->Start, '&') != NULL)
969 pToken = NewStrBufPlain (Parm->Start, Parm->len);
970 Match = NewStrBufPlain (NULL, Parm->len);
971 Pos = ChrPtr(pToken);
973 while ((Pos != NULL) && (Pos != StrBufNOTNULL))
975 StrBufExtract_NextToken(Match, pToken, &Pos, '&');
977 if (StrLength (Match) > 0)
979 if (GetHash(Defines, SKEY(Match), &vPVal) &&
983 PVal = (long*) vPVal;
985 Parm->lvalue |= *PVal;
988 LogTemplateError(NULL, "Define",
1003 LogTemplateError(NULL, "Define",
1004 Tokens->nParameters,
1010 case TYPE_SUBTEMPLATE:{
1012 /* well, we don't check the mobile stuff here... */
1013 if (!GetHash(LocalTemplateCache, Parm->Start, Parm->len, &vTmpl) &&
1014 !GetHash(TemplateCache, Parm->Start, Parm->len, &vTmpl)) {
1015 LogTemplateError(NULL,
1017 Tokens->nParameters,
1019 "referenced here doesn't exist");
1027 WCTemplateToken *NewTemplateSubstitute(StrBuf *Buf,
1029 const char *pTokenStart,
1030 const char *pTokenEnd,
1036 WCTemplateToken *NewToken;
1037 WCTemplputParams TP;
1039 NewToken = (WCTemplateToken*)malloc(sizeof(WCTemplateToken));
1040 memset(NewToken, 0, sizeof(WCTemplateToken));
1041 TP.Tokens = NewToken;
1042 NewToken->FileName = pTmpl->FileName; /* to print meaningfull log messages... */
1043 NewToken->Flags = 0;
1044 NewToken->Line = Line + 1;
1045 NewToken->pTokenStart = pTokenStart;
1046 NewToken->TokenStart = pTokenStart - pStart;
1047 NewToken->TokenEnd = (pTokenEnd - pStart) - NewToken->TokenStart;
1048 NewToken->pTokenEnd = pTokenEnd;
1049 NewToken->NameEnd = NewToken->TokenEnd - 2;
1050 NewToken->PreEval = NULL;
1051 NewToken->FlatToken = NewStrBufPlain(pTokenStart + 2, pTokenEnd - pTokenStart - 2);
1052 StrBufShrinkToFit(NewToken->FlatToken, 1);
1054 StrBufPeek(Buf, pTokenStart, + 1, '\0');
1055 StrBufPeek(Buf, pTokenEnd, -1, '\0');
1056 pch = NewToken->pName = pTokenStart + 2;
1058 NewToken->HaveParameters = 0;;
1059 NewToken->nParameters = 0;
1061 while (pch < pTokenEnd - 1) {
1063 StrBufPeek(Buf, pch, -1, '\0');
1064 NewToken->NameEnd = pch - NewToken->pName;
1066 if (*(pTokenEnd - 1) != ')') {
1068 NULL, "Parseerror", ERR_NAME, &TP,
1069 "Warning, Non welformed Token; missing right parenthesis");
1071 while (pch < pTokenEnd - 1) {
1072 NewToken->nParameters++;
1073 if (GetNextParameter(Buf,
1079 &NewToken->Params[NewToken->nParameters - 1]))
1081 NewToken->HaveParameters = 1;
1082 if (NewToken->nParameters >= MAXPARAM) {
1084 NULL, "Parseerror", ERR_NAME, &TP,
1085 "only [%d] Params allowed in Tokens",
1088 FreeToken(&NewToken);
1094 if((NewToken->NameEnd == 1) &&
1095 (NewToken->HaveParameters == 1))
1098 if (*(NewToken->pName) == '_')
1099 NewToken->Flags = SV_GETTEXT;
1100 else if (*(NewToken->pName) == '=')
1101 NewToken->Flags = SV_SUBTEMPL;
1102 else if (*(NewToken->pName) == '%')
1103 NewToken->Flags = SV_CUST_STR_CONDITIONAL;
1104 else if (*(NewToken->pName) == '?')
1105 NewToken->Flags = SV_CONDITIONAL;
1106 else if (*(NewToken->pName) == '!')
1107 NewToken->Flags = SV_NEG_CONDITIONAL;
1113 switch (NewToken->Flags) {
1115 /* If we're able to find out more about the token, do it now while its fresh. */
1116 pch = NewToken->pName;
1117 while (pch < NewToken->pName + NewToken->NameEnd)
1119 if (((*pch >= 'A') && (*pch <= 'Z')) ||
1120 ((*pch >= '0') && (*pch <= '9')) ||
1128 NULL, "Token Name", ERR_NAME, &TP,
1129 "contains illegal char: '%c'",
1135 if (GetHash(GlobalNS, NewToken->pName, NewToken->NameEnd, &vVar)) {
1136 HashHandler *Handler;
1137 Handler = (HashHandler*) vVar;
1138 if ((NewToken->nParameters < Handler->Filter.nMinArgs) ||
1139 (NewToken->nParameters > Handler->Filter.nMaxArgs)) {
1141 NULL, "Token", ERR_NAME, &TP,
1142 "doesn't work with %d params",
1143 NewToken->nParameters);
1147 NewToken->PreEval = Handler;
1148 NewToken->Flags = SV_PREEVALUATED;
1149 if (Handler->PreEvalFunc != NULL)
1150 Handler->PreEvalFunc(NewToken);
1154 NULL, "Token ", ERR_NAME, &TP,
1155 " isn't known to us.");
1159 if ((NewToken->nParameters < 1) || (NewToken->nParameters > 2)) {
1161 NULL, "Gettext", ERR_NAME, &TP,
1162 "requires 1 or 2 parameter, you gave %d params",
1163 NewToken->nParameters);
1164 NewToken->Flags = 0;
1167 if (DumpTemplateI18NStrings) {
1168 StrBufAppendPrintf(I18nDump, "_(\"%s\");\n", NewToken->Params[0]->Start);
1172 if (NewToken->nParameters != 1) {
1174 NULL, "Subtemplates", ERR_NAME, &TP,
1175 "require exactly 1 parameter, you gave %d params",
1176 NewToken->nParameters);
1181 /* well, we don't check the mobile stuff here... */
1182 if (!GetHash(LocalTemplateCache,
1183 NewToken->Params[0]->Start,
1184 NewToken->Params[0]->len,
1186 !GetHash(TemplateCache,
1187 NewToken->Params[0]->Start,
1188 NewToken->Params[0]->len,
1191 NULL, "SubTemplate", ERR_PARM1, &TP,
1196 case SV_CUST_STR_CONDITIONAL:
1197 case SV_CONDITIONAL:
1198 case SV_NEG_CONDITIONAL:
1199 if (NewToken->nParameters <2) {
1201 NULL, "Conditional", ERR_PARM1, &TP,
1202 "require at least 2 parameters, you gave %d params",
1203 NewToken->nParameters);
1204 NewToken->Flags = 0;
1207 if (NewToken->Params[1]->lvalue == 0) {
1209 NULL, "Conditional", ERR_PARM1, &TP,
1210 "Conditional ID (Parameter 1) mustn't be 0!");
1211 NewToken->Flags = 0;
1214 if (!GetHash(Conditionals,
1215 NewToken->Params[0]->Start,
1216 NewToken->Params[0]->len,
1219 if ((NewToken->Params[0]->len == 1) &&
1220 (NewToken->Params[0]->Start[0] == 'X'))
1223 NULL, "Conditional", ERR_PARM1, &TP,
1226 NewToken->Error = NewStrBuf();
1229 "<pre>\nConditional [%s] (in '%s' line %ld); Not found!\n[%s]\n</pre>\n",
1230 NewToken->Params[0]->Start,
1231 ChrPtr(pTmpl->FileName),
1233 ChrPtr(NewToken->FlatToken));
1237 NewToken->PreEval = vVar;
1249 * Display a variable-substituted template
1250 * templatename template file to load
1252 void *prepare_template(StrBuf *filename, StrBuf *Key, HashList *PutThere) {
1253 WCTemplate *NewTemplate;
1255 NewTemplate = (WCTemplate *) malloc(sizeof(WCTemplate));
1256 memset(NewTemplate, 0, sizeof(WCTemplate));
1257 NewTemplate->Data = NULL;
1258 NewTemplate->FileName = NewStrBufDup(filename);
1259 StrBufShrinkToFit(NewTemplate->FileName, 1);
1260 NewTemplate->nTokensUsed = 0;
1261 NewTemplate->TokenSpace = 0;
1262 NewTemplate->Tokens = NULL;
1263 NewTemplate->MimeType = NewStrBufPlain(GuessMimeByFilename (SKEY(NewTemplate->FileName)), -1);
1264 if (strstr(ChrPtr(NewTemplate->MimeType), "text") != NULL) {
1265 StrBufAppendBufPlain(NewTemplate->MimeType, HKEY("; charset=utf-8"), 0);
1268 if (strstr(ChrPtr(NewTemplate->MimeType), "text") != NULL) {
1269 StrBufAppendBufPlain(NewTemplate->MimeType, HKEY("; charset=utf-8"), 0);
1272 Put(PutThere, ChrPtr(Key), StrLength(Key), NewTemplate, FreeWCTemplate);
1277 * Display a variable-substituted template
1278 * templatename template file to load
1280 void *duplicate_template(WCTemplate *OldTemplate) {
1281 WCTemplate *NewTemplate;
1283 NewTemplate = (WCTemplate *) malloc(sizeof(WCTemplate));
1284 memset(NewTemplate, 0, sizeof(WCTemplate));
1285 NewTemplate->Data = NULL;
1286 NewTemplate->FileName = NewStrBufDup(OldTemplate->FileName);
1287 StrBufShrinkToFit(NewTemplate->FileName, 1);
1288 NewTemplate->nTokensUsed = 0;
1289 NewTemplate->TokenSpace = 0;
1290 NewTemplate->Tokens = NULL;
1291 NewTemplate->MimeType = NewStrBufDup(OldTemplate->MimeType);
1296 void SanityCheckTemplate(StrBuf *Target, WCTemplate *CheckMe) {
1299 int FoundConditionalEnd;
1301 for (i = 0; i < CheckMe->nTokensUsed; i++) {
1302 switch(CheckMe->Tokens[i]->Flags) {
1303 case SV_CONDITIONAL:
1304 case SV_NEG_CONDITIONAL:
1305 FoundConditionalEnd = 0;
1306 if ((CheckMe->Tokens[i]->Params[0]->len == 1) &&
1307 (CheckMe->Tokens[i]->Params[0]->Start[0] == 'X'))
1309 for (j = i + 1; j < CheckMe->nTokensUsed; j++)
1311 if (((CheckMe->Tokens[j]->Flags == SV_CONDITIONAL) ||
1312 (CheckMe->Tokens[j]->Flags == SV_NEG_CONDITIONAL)) &&
1313 (CheckMe->Tokens[i]->Params[1]->lvalue ==
1314 CheckMe->Tokens[j]->Params[1]->lvalue))
1316 FoundConditionalEnd = 1;
1321 if (!FoundConditionalEnd)
1323 WCTemplputParams TP;
1324 memset(&TP, 0, sizeof(WCTemplputParams));
1325 TP.Tokens = CheckMe->Tokens[i];
1327 Target, "Token", ERR_PARM1, &TP,
1328 "Conditional without Endconditional"
1339 * Display a variable-substituted template
1340 * templatename template file to load
1342 void *load_template(StrBuf *Target, WCTemplate *NewTemplate)
1345 struct stat statbuf;
1346 const char *pS, *pE, *pch, *Err;
1349 fd = open(ChrPtr(NewTemplate->FileName), O_RDONLY);
1351 syslog(LOG_WARNING, "ERROR: could not open template '%s' - %s\n",
1352 ChrPtr(NewTemplate->FileName), strerror(errno));
1356 if (fstat(fd, &statbuf) == -1) {
1357 syslog(LOG_WARNING, "ERROR: could not stat template '%s' - %s\n",
1358 ChrPtr(NewTemplate->FileName), strerror(errno));
1362 NewTemplate->Data = NewStrBufPlain(NULL, statbuf.st_size + 1);
1363 if (StrBufReadBLOB(NewTemplate->Data, &fd, 1, statbuf.st_size, &Err) < 0) {
1365 syslog(LOG_WARNING, "ERROR: reading template '%s' - %s<br>\n",
1366 ChrPtr(NewTemplate->FileName), strerror(errno));
1372 StrBufShrinkToFit(NewTemplate->Data, 1);
1373 StrBufShrinkToFit(NewTemplate->MimeType, 1);
1374 pS = pch = ChrPtr(NewTemplate->Data);
1375 pE = pS + StrLength(NewTemplate->Data);
1377 const char *pts, *pte;
1378 char InQuotes = '\0';
1381 /** Find one <? > */
1382 for (; pch < pE; pch ++) {
1383 if ((*pch=='<')&&(*(pch + 1)=='?') &&
1384 !((pch == pS) && /* we must ommit a <?xml */
1385 (*(pch + 2) == 'x') &&
1386 (*(pch + 3) == 'm') &&
1387 (*(pch + 4) == 'l')))
1389 if (*pch=='\n') Line ++;
1395 /** Found one? parse it. */
1396 for (; pch <= pE - 1; pch ++) {
1398 ((*pch == '\'') || (*pch == '"')))
1402 else if (InQuotes && (InQuotes == *pch))
1406 else if ((InQuotes) &&
1408 (*(pch + 1) == InQuotes))
1412 else if ((!InQuotes) &&
1421 pv = NewTemplateSubstitute(NewTemplate->Data, pS, pts, pte, Line, NewTemplate);
1423 PutNewToken(NewTemplate, pv);
1428 SanityCheckTemplate(NULL, NewTemplate);
1433 const char* PrintTemplate(void *vSubst)
1435 WCTemplate *Tmpl = vSubst;
1437 return ChrPtr(Tmpl->FileName);
1441 int LoadTemplateDir(const StrBuf *DirName, HashList *big, const StrBuf *BaseKey)
1447 StrBuf *SubDirectory;
1448 DIR *filedir = NULL;
1449 struct dirent *filedir_entry;
1455 d = (struct dirent *)malloc(offsetof(struct dirent, d_name) + PATH_MAX + 1);
1460 filedir = opendir (ChrPtr(DirName));
1461 if (filedir == NULL) {
1466 Toplevel = StrLength(BaseKey) == 0;
1467 SubDirectory = NewStrBuf();
1468 SubKey = NewStrBuf();
1469 FileName = NewStrBufPlain(NULL, PATH_MAX);
1471 while ((readdir_r(filedir, d, &filedir_entry) == 0) &&
1472 (filedir_entry != NULL))
1476 #ifdef _DIRENT_HAVE_D_NAMLEN
1477 d_namelen = filedir_entry->d_namlen;
1479 d_namelen = strlen(filedir_entry->d_name);
1482 #ifdef _DIRENT_HAVE_D_TYPE
1483 d_type = filedir_entry->d_type;
1487 #define DT_UNKNOWN 0
1492 #define IFTODT(mode) (((mode) & 0170000) >> 12)
1493 #define DTTOIF(dirtype) ((dirtype) << 12)
1495 d_type = DT_UNKNOWN;
1497 d_without_ext = d_namelen;
1499 if ((d_namelen > 1) && filedir_entry->d_name[d_namelen - 1] == '~')
1500 continue; /* Ignore backup files... */
1502 if ((d_namelen == 1) &&
1503 (filedir_entry->d_name[0] == '.'))
1506 if ((d_namelen == 2) &&
1507 (filedir_entry->d_name[0] == '.') &&
1508 (filedir_entry->d_name[1] == '.'))
1511 if (d_type == DT_UNKNOWN) {
1513 char path[PATH_MAX];
1514 snprintf(path, PATH_MAX, "%s/%s",
1515 ChrPtr(DirName), filedir_entry->d_name);
1516 if (lstat(path, &s) == 0) {
1517 d_type = IFTODT(s.st_mode);
1523 /* Skip directories we are not interested in... */
1524 if (strcmp(filedir_entry->d_name, ".svn") == 0)
1527 FlushStrBuf(SubKey);
1529 /* If we're not toplevel, the upper dirs count as foo_bar_<local name>*/
1530 StrBufAppendBuf(SubKey, BaseKey, 0);
1531 StrBufAppendBufPlain(SubKey, HKEY("_"), 0);
1533 StrBufAppendBufPlain(SubKey, filedir_entry->d_name, d_namelen, 0);
1535 FlushStrBuf(SubDirectory);
1536 StrBufAppendBuf(SubDirectory, DirName, 0);
1537 if (ChrPtr(SubDirectory)[StrLength(SubDirectory) - 1] != '/')
1538 StrBufAppendBufPlain(SubDirectory, HKEY("/"), 0);
1539 StrBufAppendBufPlain(SubDirectory, filedir_entry->d_name, d_namelen, 0);
1541 LoadTemplateDir(SubDirectory, big, SubKey);
1548 while ((d_without_ext > 0) && (filedir_entry->d_name[d_without_ext] != '.'))
1550 if ((d_without_ext == 0) || (d_namelen < 3))
1552 if (((d_namelen > 1) && filedir_entry->d_name[d_namelen - 1] == '~') ||
1553 (strcmp(&filedir_entry->d_name[d_without_ext], ".orig") == 0) ||
1554 (strcmp(&filedir_entry->d_name[d_without_ext], ".swp") == 0))
1555 continue; /* Ignore backup files... */
1556 StrBufPrintf(FileName, "%s/%s", ChrPtr(DirName), filedir_entry->d_name);
1557 MinorPtr = strchr(filedir_entry->d_name, '.');
1558 if (MinorPtr != NULL)
1562 /* If we're not toplevel, the upper dirs count as foo_bar_<local name>*/
1563 StrBufAppendBuf(Key, BaseKey, 0);
1564 StrBufAppendBufPlain(Key, HKEY("_"), 0);
1566 StrBufAppendBufPlain(Key, filedir_entry->d_name, MinorPtr - filedir_entry->d_name, 0);
1568 if (LoadTemplates >= 1)
1569 syslog(LOG_DEBUG, "%s %s\n", ChrPtr(FileName), ChrPtr(Key));
1570 prepare_template(FileName, Key, big);
1577 FreeStrBuf(&FileName);
1579 FreeStrBuf(&SubDirectory);
1580 FreeStrBuf(&SubKey);
1584 void InitTemplateCache(void)
1589 HashList *Templates[2];
1594 /* Primary Template set... */
1595 StrBufPrintf(Dir, "%s/t", static_dirs[0]);
1596 LoadTemplateDir(Dir, TemplateCache, Key);
1598 /* User local Template set */
1599 StrBufPrintf(Dir, "%s/t", static_dirs[1]);
1600 LoadTemplateDir(Dir, LocalTemplateCache, Key);
1602 /* Debug Templates, just to be loaded while debugging. */
1604 StrBufPrintf(Dir, "%s/dbg", static_dirs[0]);
1605 LoadTemplateDir(Dir, TemplateCache, Key);
1606 Templates[0] = TemplateCache;
1607 Templates[1] = LocalTemplateCache;
1610 if (LoadTemplates == 0)
1611 for (i=0; i < 2; i++) {
1617 At = GetNewHashPos(Templates[i], 0);
1618 while (GetNextHashPos(Templates[i], At, &KLen, &Key, &vTemplate) && (vTemplate != NULL)) {
1619 load_template(NULL, (WCTemplate *)vTemplate);
1631 /*-----------------------------------------------------------------------------
1632 * Filling & processing Templates
1635 * \brief executes one token
1636 * \param Target buffer to append to
1637 * \param Token da to process.
1638 * \param Template we're iterating
1639 * \param Context Contextpoointer to pass in
1640 * \param state are we in conditional state?
1641 * \param ContextType what type of information does context giv us?
1643 int EvaluateToken(StrBuf *Target, int state, WCTemplputParams **TPP)
1645 const char *AppendMe;
1647 HashHandler *Handler;
1649 WCTemplputParams *TP = *TPP;
1651 /* much output, since pName is not terminated...
1652 syslog(LOG_DEBUG,"Doing token: %s\n",Token->pName);
1655 switch (TP->Tokens->Flags) {
1657 TmplGettext(Target, TP);
1659 case SV_CONDITIONAL: /** Forward conditional evaluation */
1660 Handler = (HashHandler*) TP->Tokens->PreEval;
1661 if (!CheckContext(Target, &Handler->Filter, TP, "Conditional")) {
1664 return EvaluateConditional(Target, 1, state, TPP);
1666 case SV_NEG_CONDITIONAL: /** Reverse conditional evaluation */
1667 Handler = (HashHandler*) TP->Tokens->PreEval;
1668 if (!CheckContext(Target, &Handler->Filter, TP, "Conditional")) {
1671 return EvaluateConditional(Target, 0, state, TPP);
1673 case SV_CUST_STR_CONDITIONAL: /** Conditional put custom strings from params */
1674 Handler = (HashHandler*) TP->Tokens->PreEval;
1675 if (!CheckContext(Target, &Handler->Filter, TP, "Conditional")) {
1678 if (TP->Tokens->nParameters >= 6) {
1679 if (EvaluateConditional(Target, 0, state, TPP)) {
1680 GetTemplateTokenString(Target, TP, 5, &AppendMe, &AppendMeLen);
1681 StrBufAppendBufPlain(Target, AppendMe, AppendMeLen, 0);
1684 GetTemplateTokenString(Target, TP, 4, &AppendMe, &AppendMeLen);
1685 StrBufAppendBufPlain(Target, AppendMe, AppendMeLen, 0);
1689 UnStackDynamicContext(Target, TPP);
1693 LogTemplateError( Target, "Conditional", ERR_NAME, TP, "needs at least 6 Params!");
1697 if (TP->Tokens->nParameters == 1)
1698 DoTemplate(TKEY(0), Target, TP);
1700 case SV_PREEVALUATED:
1701 Handler = (HashHandler*) TP->Tokens->PreEval;
1702 if (!CheckContext(Target, &Handler->Filter, TP, "Token")) {
1705 Handler->HandlerFunc(Target, TP);
1708 if (GetHash(GlobalNS, TP->Tokens->pName, TP->Tokens->NameEnd, &vVar)) {
1709 Handler = (HashHandler*) vVar;
1710 if (!CheckContext(Target, &Handler->Filter, TP, "Token")) {
1714 Handler->HandlerFunc(Target, TP);
1719 Target, "Token UNKNOWN", ERR_NAME, TP,
1720 "You've specified a token that isn't known to webcit.!");
1728 const StrBuf *ProcessTemplate(WCTemplate *Tmpl, StrBuf *Target, WCTemplputParams *CallingTP)
1730 WCTemplate *pTmpl = Tmpl;
1734 const char *pData, *pS;
1736 WCTemplputParams TP;
1737 WCTemplputParams *TPtr = &TP;
1739 memset(TPtr, 0, sizeof(WCTemplputParams));
1741 memcpy(&TP.Filter, &CallingTP->Filter, sizeof(ContextFilter));
1743 TP.Context = CallingTP->Context;
1744 TP.Sub = CallingTP->Sub;
1745 TP.Super = CallingTP->Super;
1747 if (LoadTemplates != 0) {
1748 if (LoadTemplates > 1)
1749 syslog(LOG_DEBUG, "DBG: ----- loading: [%s] ------ \n",
1750 ChrPtr(Tmpl->FileName));
1751 pTmpl = duplicate_template(Tmpl);
1752 if(load_template(Target, pTmpl) == NULL) {
1753 StrBufAppendPrintf( Target,
1754 "<pre>\nError loading Template [%s]\n See Logfile for details\n</pre>\n",
1755 ChrPtr(Tmpl->FileName));
1756 FreeWCTemplate(pTmpl);
1762 pS = pData = ChrPtr(pTmpl->Data);
1763 len = StrLength(pTmpl->Data);
1767 if (i >= pTmpl->nTokensUsed) {
1768 StrBufAppendBufPlain(Target, pData, len - (pData - pS), 0);
1774 StrBufAppendBufPlain( Target, pData, pTmpl->Tokens[i]->pTokenStart - pData, 0);
1775 TPtr->Tokens = pTmpl->Tokens[i];
1776 TPtr->nArgs = pTmpl->Tokens[i]->nParameters;
1778 TokenRc = EvaluateToken(Target, TokenRc, &TPtr);
1780 state = eSkipTilEnd;
1782 else if (TokenRc < 0) {
1783 if ((TPtr != &TP) && (TPtr->ExitCTXID == -TokenRc)) {
1784 UnStackDynamicContext(Target, &TPtr);
1789 while ((state != eNext) && (i+1 < pTmpl->nTokensUsed)) {
1790 /* condition told us to skip till its end condition */
1792 TPtr->Tokens = pTmpl->Tokens[i];
1793 TPtr->nArgs = pTmpl->Tokens[i]->nParameters;
1794 if ((pTmpl->Tokens[i]->Flags == SV_CONDITIONAL) ||
1795 (pTmpl->Tokens[i]->Flags == SV_NEG_CONDITIONAL))
1798 rc = EvaluateConditional(
1800 pTmpl->Tokens[i]->Flags,
1803 if (-rc == TokenRc) {
1806 if ((TPtr != &TP) && (TPtr->ExitCTXID == - rc)) {
1807 UnStackDynamicContext(Target, &TPtr);
1813 pData = pTmpl->Tokens[i++]->pTokenEnd + 1;
1814 if (i > pTmpl->nTokensUsed)
1818 if (LoadTemplates != 0) {
1819 FreeWCTemplate(pTmpl);
1821 return Tmpl->MimeType;
1826 StrBuf *textPlainType;
1828 * \brief Display a variable-substituted template
1829 * \param templatename template file to load
1830 * \returns the mimetype of the template its doing
1832 const StrBuf *DoTemplate(const char *templatename, long len, StrBuf *Target, WCTemplputParams *TP)
1834 WCTemplputParams LocalTP;
1836 HashList *StaticLocal;
1842 memset(&LocalTP, 0, sizeof(WCTemplputParams));
1846 Static = TemplateCache;
1847 StaticLocal = LocalTemplateCache;
1850 syslog(LOG_WARNING, "Can't to load a template with empty name!\n");
1851 StrBufAppendPrintf(Target, "<pre>\nCan't to load a template with empty name!\n</pre>");
1852 return textPlainType;
1855 if (!GetHash(StaticLocal, templatename, len, &vTmpl) &&
1856 !GetHash(Static, templatename, len, &vTmpl)) {
1857 StrBuf *escapedString = NewStrBufPlain(NULL, len);
1859 StrHtmlEcmaEscAppend(escapedString, NULL, templatename, 1, 1);
1860 syslog(LOG_WARNING, "didn't find Template [%s] %ld %ld\n", ChrPtr(escapedString), len , (long)strlen(templatename));
1861 StrBufAppendPrintf(Target, "<pre>\ndidn't find Template [%s] %ld %ld\n</pre>",
1862 ChrPtr(escapedString), len,
1863 (long)strlen(templatename));
1866 dbg_PrintHash(Static, PrintTemplate, NULL);
1867 PrintHash(Static, VarPrintTransition, PrintTemplate);
1869 FreeStrBuf(&escapedString);
1870 return textPlainType;
1873 return textPlainType;
1874 return ProcessTemplate(vTmpl, Target, TP);
1879 void tmplput_Comment(StrBuf *Target, WCTemplputParams *TP)
1881 if (LoadTemplates != 0)
1887 GetTemplateTokenString(Target, TP, 0, &pch, &len);
1888 Comment = NewStrBufPlain(pch, len);
1889 StrBufAppendBufPlain(Target, HKEY("<!--"), 0);
1890 StrBufAppendTemplate(Target, TP, Comment, 1);
1891 StrBufAppendBufPlain(Target, HKEY("-->"), 0);
1892 FreeStrBuf(&Comment);
1896 /*-----------------------------------------------------------------------------
1899 typedef struct _HashIterator {
1900 HashList *StaticList;
1901 int AdditionalParams;
1902 CtxType ContextType;
1903 CtxType XPectContextType;
1905 RetrieveHashlistFunc GetHash;
1906 HashDestructorFunc Destructor;
1907 SubTemplFunc DoSubTemplate;
1908 FilterByParamFunc Filter;
1911 void RegisterITERATOR(const char *Name, long len,
1912 int AdditionalParams,
1913 HashList *StaticList,
1914 RetrieveHashlistFunc GetHash,
1915 SubTemplFunc DoSubTempl,
1916 HashDestructorFunc Destructor,
1917 FilterByParamFunc Filter,
1918 CtxType ContextType,
1919 CtxType XPectContextType,
1924 It = (HashIterator*)malloc(sizeof(HashIterator));
1925 memset(It, 0, sizeof(HashIterator));
1926 It->StaticList = StaticList;
1927 It->AdditionalParams = AdditionalParams;
1928 It->GetHash = GetHash;
1929 It->DoSubTemplate = DoSubTempl;
1930 It->Destructor = Destructor;
1931 It->Filter = Filter;
1932 It->ContextType = ContextType;
1933 It->XPectContextType = XPectContextType;
1935 Put(Iterators, Name, len, It, NULL);
1938 typedef struct _iteratestruct {
1947 int preeval_iterate(WCTemplateToken *Token)
1949 WCTemplputParams TPP;
1950 WCTemplputParams *TP;
1955 memset(&TPP, 0, sizeof(WCTemplputParams));
1958 if (!GetHash(Iterators, TKEY(0), &vIt)) {
1960 NULL, "Iterator", ERR_PARM1, TP,
1964 if (TP->Tokens->Params[1]->Type != TYPE_SUBTEMPLATE) {
1965 LogTemplateError(NULL, "Iterator", ERR_PARM1, TP,
1966 "Need token with type Subtemplate as param 1, have %s",
1967 TP->Tokens->Params[1]->Start);
1970 /* well, we don't check the mobile stuff here... */
1971 if (!GetHash(LocalTemplateCache, TKEY(1), &vTmpl) &&
1972 !GetHash(TemplateCache, TKEY(1), &vTmpl)) {
1973 LogTemplateError(NULL, "SubTemplate", ERR_PARM1, TP,
1974 "referenced here doesn't exist");
1976 Token->Preeval2 = vIt;
1977 It = (HashIterator *) vIt;
1979 if (TP->Tokens->nParameters < It->AdditionalParams + 2) {
1981 NULL, "Iterator", ERR_PARM1, TP,
1982 "doesn't work with %d params",
1983 TP->Tokens->nParameters);
1990 void tmpl_iterate_subtmpl(StrBuf *Target, WCTemplputParams *TP)
1995 SortStruct *SortBy = NULL;
1997 int DetectGroupChange = 0;
2000 void *vLastContext = NULL;
2002 WCTemplputParams IterateTP;
2003 WCTemplputParams SubTP;
2004 IterateStruct Status;
2010 memset(&Status, 0, sizeof(IterateStruct));
2012 It = (HashIterator*) TP->Tokens->Preeval2;
2015 Target, "Iterator", ERR_PARM1, TP, "Unknown!");
2019 if (TP->Tokens->nParameters < It->AdditionalParams + 2) {
2021 Target, "Iterator", ERR_PARM1, TP,
2022 "doesn't work with %d params",
2023 TP->Tokens->nParameters - 1);
2027 if ((It->XPectContextType != CTX_NONE) &&
2028 (It->XPectContextType != TP->Filter.ContextType)) {
2030 Target, "Iterator", ERR_PARM1, TP,
2031 "requires context of type %s, have %s",
2032 ContextName(It->XPectContextType),
2033 ContextName(TP->Filter.ContextType));
2038 if (It->StaticList == NULL)
2039 List = It->GetHash(Target, TP);
2041 List = It->StaticList;
2043 DetectGroupChange = (It->Flags & IT_FLAG_DETECT_GROUPCHANGE) != 0;
2044 if (DetectGroupChange) {
2045 const StrBuf *BSort;
2046 DetectGroupChange = 0;
2047 if (havebstr("SortBy")) {
2048 BSort = sbstr("SortBy");
2049 if (GetHash(SortHash, SKEY(BSort), &vSortBy) &&
2050 (vSortBy != NULL)) {
2051 SortBy = (SortStruct*)vSortBy;
2052 /* first check whether its intended for us... */
2053 if ((SortBy->ContextType == It->ContextType)&&
2054 /** Ok, its us, lets see in which direction we should sort... */
2055 (havebstr("SortOrder"))) {
2057 SortOrder = lbstr("SortOrder");
2059 DetectGroupChange = 1;
2064 nMembersUsed = GetCount(List);
2066 StackContext (TP, &IterateTP, &Status, CTX_ITERATE, 0, TP->Tokens);
2068 SubBuf = NewStrBuf();
2070 if (HAVE_PARAM(2)) {
2071 StartAt = GetTemplateTokenNumber(Target, TP, 2, 0);
2073 if (HAVE_PARAM(3)) {
2074 StepWidth = GetTemplateTokenNumber(Target, TP, 3, 0);
2076 if (HAVE_PARAM(4)) {
2077 StopAt = GetTemplateTokenNumber(Target, TP, 4, -1);
2079 it = GetNewHashPos(List, StepWidth);
2081 StopAt = GetCount(List);
2083 while (GetNextHashPos(List, it, &Status.KeyLen, &Status.Key, &vContext)) {
2084 if ((Status.n >= StartAt) && (Status.n <= StopAt)) {
2086 if ((It->Filter != NULL) &&
2087 !It->Filter(Status.Key, Status.KeyLen, vContext, Target, TP))
2092 if (DetectGroupChange && Status.n > 0) {
2093 Status.GroupChange = SortBy->GroupChange(vContext, vLastContext);
2095 Status.LastN = (Status.n + 1) == nMembersUsed;
2096 StackContext(&IterateTP, &SubTP, vContext, It->ContextType, 0, NULL);
2098 if (It->DoSubTemplate != NULL)
2099 It->DoSubTemplate(SubBuf, &SubTP);
2100 DoTemplate(TKEY(1), SubBuf, &SubTP);
2102 StrBufAppendBuf(Target, SubBuf, 0);
2103 FlushStrBuf(SubBuf);
2105 UnStackContext(&SubTP);
2106 Status.oddeven = ! Status.oddeven;
2107 vLastContext = vContext;
2112 UnStackContext(&IterateTP);
2113 FreeStrBuf(&SubBuf);
2115 if (It->Destructor != NULL)
2116 It->Destructor(&List);
2120 int conditional_ITERATE_ISGROUPCHANGE(StrBuf *Target, WCTemplputParams *TP)
2122 IterateStruct *Ctx = CTX(CTX_ITERATE);
2123 if (TP->Tokens->nParameters < 3)
2124 return Ctx->GroupChange;
2126 return TP->Tokens->Params[2]->lvalue == Ctx->GroupChange;
2129 void tmplput_ITERATE_ODDEVEN(StrBuf *Target, WCTemplputParams *TP)
2131 IterateStruct *Ctx = CTX(CTX_ITERATE);
2133 StrBufAppendBufPlain(Target, HKEY("odd"), 0);
2135 StrBufAppendBufPlain(Target, HKEY("even"), 0);
2139 void tmplput_ITERATE_KEY(StrBuf *Target, WCTemplputParams *TP)
2141 IterateStruct *Ctx = CTX(CTX_ITERATE);
2143 StrBufAppendBufPlain(Target, Ctx->Key, Ctx->KeyLen, 0);
2146 void tmplput_ITERATE_N_DIV(StrBuf *Target, WCTemplputParams *TP)
2148 IterateStruct *Ctx = CTX(CTX_ITERATE);
2150 long divisor = GetTemplateTokenNumber(Target, TP, 0, 1);
2151 ///TODO divisor == 0 -> log error exit
2152 div = Ctx->n / divisor;
2153 StrBufAppendPrintf(Target, "%ld", div);
2156 void tmplput_ITERATE_N(StrBuf *Target, WCTemplputParams *TP)
2158 IterateStruct *Ctx = CTX(CTX_ITERATE);
2159 StrBufAppendPrintf(Target, "%d", Ctx->n);
2162 int conditional_ITERATE_FIRSTN(StrBuf *Target, WCTemplputParams *TP)
2164 IterateStruct *Ctx = CTX(CTX_ITERATE);
2168 int conditional_ITERATE_LASTN(StrBuf *Target, WCTemplputParams *TP)
2170 IterateStruct *Ctx = CTX(CTX_ITERATE);
2174 int conditional_ITERATE_ISMOD(StrBuf *Target, WCTemplputParams *TP)
2176 IterateStruct *Ctx = CTX(CTX_ITERATE);
2178 long divisor = GetTemplateTokenNumber(Target, TP, 2, 1);
2179 long expectRemainder = GetTemplateTokenNumber(Target, TP, 3, 0);
2181 return Ctx->n % divisor == expectRemainder;
2186 /*-----------------------------------------------------------------------------
2189 int EvaluateConditional(StrBuf *Target, int Neg, int state, WCTemplputParams **TPP)
2191 ConditionalStruct *Cond;
2194 WCTemplputParams *TP = *TPP;
2196 if ((TP->Tokens->Params[0]->len == 1) &&
2197 (TP->Tokens->Params[0]->Start[0] == 'X'))
2199 return - (TP->Tokens->Params[1]->lvalue);
2202 Cond = (ConditionalStruct *) TP->Tokens->PreEval;
2205 Target, "Conditional", ERR_PARM1, TP,
2210 if (!CheckContext(Target, &Cond->Filter, TP, "Conditional")) {
2214 res = Cond->CondF(Target, TP);
2216 rc = TP->Tokens->Params[1]->lvalue;
2218 if (LoadTemplates > 5)
2219 syslog(LOG_DEBUG, "<%s> : %d %d==%d\n",
2220 ChrPtr(TP->Tokens->FlatToken),
2223 if (TP->Sub != NULL)
2230 void RegisterContextConditional(const char *Name, long len,
2232 WCConditionalFunc CondF,
2233 WCConditionalFunc ExitCtxCond,
2234 int ContextRequired)
2236 ConditionalStruct *Cond;
2238 Cond = (ConditionalStruct*)malloc(sizeof(ConditionalStruct));
2239 memset(Cond, 0, sizeof(ConditionalStruct));
2240 Cond->PlainName = Name;
2241 Cond->Filter.nMaxArgs = nParams;
2242 Cond->Filter.nMinArgs = nParams;
2243 Cond->CondF = CondF;
2244 Cond->CondExitCtx = ExitCtxCond;
2245 Cond->Filter.ContextType = ContextRequired;
2246 Put(Conditionals, Name, len, Cond, NULL);
2249 void RegisterTokenParamDefine(const char *Name, long len,
2254 PVal = (long*)malloc(sizeof(long));
2256 Put(Defines, Name, len, PVal, NULL);
2259 long GetTokenDefine(const char *Name, long len,
2264 if (GetHash(Defines, Name, len, &vPVal) &&
2267 return *(long*) vPVal;
2275 void tmplput_DefStr(StrBuf *Target, WCTemplputParams *TP)
2279 GetTemplateTokenString(Target, TP, 2, &Str, &len);
2281 StrBufAppendBufPlain(Target, Str, len, 0);
2284 void tmplput_DefVal(StrBuf *Target, WCTemplputParams *TP)
2288 val = GetTemplateTokenNumber(Target, TP, 0, 0);
2289 StrBufAppendPrintf(Target, "%d", val);
2294 /*-----------------------------------------------------------------------------
2297 void tmplput_ContextString(StrBuf *Target, WCTemplputParams *TP)
2299 StrBufAppendTemplate(Target, TP, (StrBuf*)CTX(CTX_STRBUF), 0);
2301 int ConditionalContextStr(StrBuf *Target, WCTemplputParams *TP)
2303 StrBuf *TokenText = (StrBuf*) CTX((CTX_STRBUF));
2304 const char *CompareToken;
2307 GetTemplateTokenString(Target, TP, 2, &CompareToken, &len);
2308 return strcmp(ChrPtr(TokenText), CompareToken) == 0;
2311 void tmplput_ContextStringArray(StrBuf *Target, WCTemplputParams *TP)
2313 HashList *Arr = (HashList*) CTX(CTX_STRBUFARR);
2317 val = GetTemplateTokenNumber(Target, TP, 0, 0);
2318 if (GetHash(Arr, IKEY(val), &pV) &&
2320 StrBufAppendTemplate(Target, TP, (StrBuf*)pV, 1);
2323 int ConditionalContextStrinArray(StrBuf *Target, WCTemplputParams *TP)
2325 HashList *Arr = (HashList*) CTX(CTX_STRBUFARR);
2328 const char *CompareToken;
2331 GetTemplateTokenString(Target, TP, 2, &CompareToken, &len);
2332 val = GetTemplateTokenNumber(Target, TP, 0, 0);
2333 if (GetHash(Arr, IKEY(val), &pV) &&
2335 return strcmp(ChrPtr((StrBuf*)pV), CompareToken) == 0;
2341 /*-----------------------------------------------------------------------------
2345 void tmpl_do_boxed(StrBuf *Target, WCTemplputParams *TP)
2347 WCTemplputParams SubTP;
2349 StrBuf *Headline = NULL;
2350 if (TP->Tokens->nParameters == 2) {
2351 if (TP->Tokens->Params[1]->Type == TYPE_STR) {
2352 Headline = NewStrBuf();
2353 DoTemplate(TKEY(1), Headline, TP);
2358 GetTemplateTokenString(Target,
2363 Headline = NewStrBufPlain(Ch, len);
2366 /* else TODO error? logging? */
2368 StackContext (TP, &SubTP, Headline, CTX_STRBUF, 0, NULL);
2370 DoTemplate(HKEY("box_begin"), Target, &SubTP);
2372 UnStackContext(&SubTP);
2373 DoTemplate(TKEY(0), Target, TP);
2374 DoTemplate(HKEY("box_end"), Target, TP);
2375 FreeStrBuf(&Headline);
2378 /*-----------------------------------------------------------------------------
2382 typedef struct _tab_struct {
2387 int preeval_do_tabbed(WCTemplateToken *Token)
2389 WCTemplputParams TPP;
2390 WCTemplputParams *TP;
2395 memset(&TPP, 0, sizeof(WCTemplputParams));
2398 nTabs = TP->Tokens->nParameters / 2 - 1;
2399 if (TP->Tokens->nParameters % 2 != 0)
2401 LogTemplateError(NULL, "TabbedApi", ERR_PARM1, TP,
2402 "need even number of arguments");
2406 else for (i = 0; i < nTabs; i++) {
2407 if (!HaveTemplateTokenString(NULL,
2412 (TP->Tokens->Params[i * 2]->len == 0))
2414 LogTemplateError(NULL, "TabbedApi", ERR_PARM1, TP,
2415 "Tab-Subject %d needs to be able to produce a string, have %s",
2416 i, TP->Tokens->Params[i * 2]->Start);
2419 if (!HaveTemplateTokenString(NULL,
2424 (TP->Tokens->Params[i * 2 + 1]->len == 0))
2426 LogTemplateError(NULL, "TabbedApi", ERR_PARM1, TP,
2427 "Tab-Content %d needs to be able to produce a string, have %s",
2428 i, TP->Tokens->Params[i * 2 + 1]->Start);
2433 if (!HaveTemplateTokenString(NULL,
2438 (TP->Tokens->Params[i * 2 + 1]->len == 0))
2440 LogTemplateError(NULL, "TabbedApi", ERR_PARM1, TP,
2441 "Tab-Content %d needs to be able to produce a string, have %s",
2442 i, TP->Tokens->Params[i * 2 + 1]->Start);
2449 void tmpl_do_tabbed(StrBuf *Target, WCTemplputParams *TP)
2452 int i, ntabs, nTabs;
2454 WCTemplputParams SubTP;
2456 memset(&TS, 0, sizeof(tab_struct));
2458 nTabs = ntabs = TP->Tokens->nParameters / 2;
2459 TabNames = (StrBuf **) malloc(ntabs * sizeof(StrBuf*));
2460 memset(TabNames, 0, ntabs * sizeof(StrBuf*));
2462 for (i = 0; i < ntabs; i++) {
2463 if ((TP->Tokens->Params[i * 2]->Type == TYPE_STR) &&
2464 (TP->Tokens->Params[i * 2]->len > 0)) {
2465 TabNames[i] = NewStrBuf();
2466 DoTemplate(TKEY(i * 2), TabNames[i], TP);
2468 else if (TP->Tokens->Params[i * 2]->Type == TYPE_GETTEXT) {
2471 GetTemplateTokenString(Target,
2476 TabNames[i] = NewStrBufPlain(Ch, -1);
2479 /** A Tab without subject? we can't count that, add it as silent */
2483 StackContext (TP, &SubTP, &TS, CTX_TAB, 0, NULL);
2485 StrTabbedDialog(Target, nTabs, TabNames);
2486 for (i = 0; i < ntabs; i++) {
2487 memset(&TS, 0, sizeof(tab_struct));
2489 TS.TabTitle = TabNames[i];
2490 StrBeginTab(Target, i, nTabs, TabNames);
2491 DoTemplate(TKEY(i * 2 + 1), Target, &SubTP);
2492 StrEndTab(Target, i, nTabs);
2494 for (i = 0; i < ntabs; i++)
2495 FreeStrBuf(&TabNames[i]);
2498 UnStackContext(&SubTP);
2501 void tmplput_TAB_N(StrBuf *Target, WCTemplputParams *TP)
2503 tab_struct *Ctx = CTX(CTX_TAB);
2505 StrBufAppendPrintf(Target, "%d", Ctx->CurrentTab);
2508 void tmplput_TAB_TITLE(StrBuf *Target, WCTemplputParams *TP)
2510 tab_struct *Ctx = CTX(CTX_TAB);
2511 StrBufAppendTemplate(Target, TP, Ctx->TabTitle, 0);
2514 /*-----------------------------------------------------------------------------
2519 void RegisterSortFunc(const char *name, long len,
2520 const char *prepend, long preplen,
2521 CompareFunc Forward,
2522 CompareFunc Reverse,
2523 CompareFunc GroupChange,
2524 CtxType ContextType)
2526 SortStruct *NewSort;
2528 NewSort = (SortStruct*) malloc(sizeof(SortStruct));
2529 memset(NewSort, 0, sizeof(SortStruct));
2530 NewSort->Name = NewStrBufPlain(name, len);
2531 if (prepend != NULL)
2532 NewSort->PrefPrepend = NewStrBufPlain(prepend, preplen);
2534 NewSort->PrefPrepend = NULL;
2535 NewSort->Forward = Forward;
2536 NewSort->Reverse = Reverse;
2537 NewSort->GroupChange = GroupChange;
2538 NewSort->ContextType = ContextType;
2539 if (ContextType == CTX_NONE) {
2540 syslog(LOG_WARNING, "sorting requires a context. CTX_NONE won't make it.\n");
2544 Put(SortHash, name, len, NewSort, DestroySortStruct);
2547 CompareFunc RetrieveSort(WCTemplputParams *TP,
2548 const char *OtherPrefix, long OtherPrefixLen,
2549 const char *Default, long ldefault, long DefaultDirection)
2551 const StrBuf *BSort = NULL;
2554 long SortOrder = -1;
2556 if (havebstr("SortBy")) {
2557 BSort = sbstr("SortBy");
2558 if (OtherPrefix == NULL) {
2559 set_room_pref("sort", NewStrBufDup(BSort), 0);
2562 set_X_PREFS(HKEY("sort"), OtherPrefix, OtherPrefixLen, NewStrBufDup(BSort), 0);
2565 else { /** Try to fallback to our remembered values... */
2566 if (OtherPrefix == NULL) {
2567 BSort = get_room_pref("sort");
2570 BSort = get_X_PREFS(HKEY("sort"), OtherPrefix, OtherPrefixLen);
2573 putbstr("SortBy", NewStrBufDup(BSort));
2577 BSort = Buf = NewStrBufPlain(Default, ldefault);
2578 putbstr("SortBy", Buf);
2582 if (!GetHash(SortHash, SKEY(BSort), &vSortBy) ||
2583 (vSortBy == NULL)) {
2584 if (!GetHash(SortHash, Default, ldefault, &vSortBy) ||
2585 (vSortBy == NULL)) {
2587 NULL, "Sorting", ERR_PARM1, TP,
2588 "Illegal default sort: [%s]", Default);
2589 wc_backtrace(LOG_WARNING);
2592 SortBy = (SortStruct*)vSortBy;
2594 if (SortBy->ContextType != TP->Filter.ContextType)
2597 /** Ok, its us, lets see in which direction we should sort... */
2598 if (havebstr("SortOrder")) {
2599 SortOrder = lbstr("SortOrder");
2601 else { /** Try to fallback to our remembered values... */
2603 if (SortBy->PrefPrepend == NULL) {
2604 Buf = get_room_pref("SortOrder");
2605 SortOrder = StrTol(Buf);
2608 BSort = get_X_PREFS(HKEY("SortOrder"), OtherPrefix, OtherPrefixLen);
2612 SortOrder = DefaultDirection;
2614 Buf = NewStrBufPlain(NULL, 64);
2615 StrBufPrintf(Buf, "%ld", SortOrder);
2616 putbstr("SortOrder", Buf);
2618 switch (SortOrder) {
2623 return SortBy->Forward;
2625 return SortBy->Reverse;
2637 ConstStr SortIcons[] = {
2638 {HKEY("static/webcit_icons/sort_none.gif")},
2639 {HKEY("static/webcit_icons/up_pointer.gif")},
2640 {HKEY("static/webcit_icons/down_pointer.gif")},
2643 ConstStr SortNextOrder[] = {
2650 int GetSortMetric(WCTemplputParams *TP, SortStruct **Next, SortStruct **Param, long *SortOrder, int N)
2652 int bSortError = eNOT_SPECIFIED;
2653 const StrBuf *BSort;
2658 if (!GetHash(SortHash, TKEY(0), &vSort) ||
2660 return eNO_SUCH_SORT;
2661 *Param = (SortStruct*) vSort;
2664 if (havebstr("SortBy")) {
2665 BSort = sbstr("SortBy");
2666 bSortError = eINVALID_PARAM;
2667 if ((*Param)->PrefPrepend == NULL) {
2668 set_room_pref("sort", NewStrBufDup(BSort), 0);
2671 set_X_PREFS(HKEY("sort"), TKEY(N), NewStrBufDup(BSort), 0);
2674 else { /** Try to fallback to our remembered values... */
2675 if ((*Param)->PrefPrepend == NULL) {
2676 BSort = get_room_pref("sort");
2679 BSort = get_X_PREFS(HKEY("sort"), TKEY(N));
2683 if (!GetHash(SortHash, SKEY(BSort), &vSort) ||
2687 *Next = (SortStruct*) vSort;
2689 /** Ok, its us, lets see in which direction we should sort... */
2690 if (havebstr("SortOrder")) {
2691 *SortOrder = lbstr("SortOrder");
2693 else { /** Try to fallback to our remembered values... */
2694 if ((*Param)->PrefPrepend == NULL) {
2695 *SortOrder = StrTol(get_room_pref("SortOrder"));
2698 *SortOrder = StrTol(get_X_PREFS(HKEY("SortOrder"), TKEY(N)));
2708 void tmplput_SORT_ICON(StrBuf *Target, WCTemplputParams *TP)
2713 const ConstStr *SortIcon;
2715 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2718 Target, "Sorter", ERR_PARM1, TP,
2719 " Sorter [%s] unknown!",
2720 TP->Tokens->Params[0]->Start);
2722 case eINVALID_PARAM:
2723 LogTemplateError(NULL, "Sorter", ERR_PARM1, TP,
2724 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2726 case eNOT_SPECIFIED:
2728 if (Next == Param) {
2729 SortIcon = &SortIcons[SortOrder];
2731 else { /** Not Us... */
2732 SortIcon = &SortIcons[0];
2734 StrBufAppendBufPlain(Target, SortIcon->Key, SortIcon->len, 0);
2738 void tmplput_SORT_NEXT(StrBuf *Target, WCTemplputParams *TP)
2744 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2747 Target, "Sorter", ERR_PARM1, TP,
2748 " Sorter [%s] unknown!",
2749 TP->Tokens->Params[0]->Start);
2751 case eINVALID_PARAM:
2753 NULL, "Sorter", ERR_PARM1, TP,
2754 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2756 case eNOT_SPECIFIED:
2758 StrBufAppendBuf(Target, Param->Name, 0);
2763 void tmplput_SORT_ORDER(StrBuf *Target, WCTemplputParams *TP)
2766 const ConstStr *SortOrderStr;
2770 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2773 Target, "Sorter", ERR_PARM1, TP,
2774 " Sorter [%s] unknown!",
2775 TP->Tokens->Params[0]->Start);
2777 case eINVALID_PARAM:
2779 NULL, "Sorter", ERR_PARM1, TP,
2780 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2782 case eNOT_SPECIFIED:
2784 if (Next == Param) {
2785 SortOrderStr = &SortNextOrder[SortOrder];
2787 else { /** Not Us... */
2788 SortOrderStr = &SortNextOrder[0];
2790 StrBufAppendBufPlain(Target, SortOrderStr->Key, SortOrderStr->len, 0);
2795 void tmplput_long_vector(StrBuf *Target, WCTemplputParams *TP)
2797 long *LongVector = (long*) CTX(CTX_LONGVECTOR);
2799 if ((TP->Tokens->Params[0]->Type == TYPE_LONG) &&
2800 (TP->Tokens->Params[0]->lvalue <= LongVector[0]))
2802 StrBufAppendPrintf(Target, "%ld", LongVector[TP->Tokens->Params[0]->lvalue]);
2806 if (TP->Tokens->Params[0]->Type != TYPE_LONG) {
2808 Target, "Longvector", ERR_NAME, TP,
2809 "needs a numerical Parameter!");
2813 Target, "LongVector", ERR_PARM1, TP,
2814 "doesn't have %ld Parameters, its just the size of %ld!",
2815 TP->Tokens->Params[0]->lvalue,
2821 void dbg_print_longvector(long *LongVector)
2823 StrBuf *Buf = NewStrBufPlain(HKEY("Longvector: ["));
2824 int nItems = LongVector[0];
2827 for (i = 0; i < nItems; i++) {
2829 StrBufAppendPrintf(Buf, "%d: %ld | ", i, LongVector[i]);
2831 StrBufAppendPrintf(Buf, "%d: %ld]\n", i, LongVector[i]);
2834 syslog(LOG_DEBUG, "%s", ChrPtr(Buf));
2838 int ConditionalLongVector(StrBuf *Target, WCTemplputParams *TP)
2840 long *LongVector = (long*) CTX(CTX_LONGVECTOR);
2842 if ((TP->Tokens->Params[2]->Type == TYPE_LONG) &&
2843 (TP->Tokens->Params[2]->lvalue <= LongVector[0])&&
2844 (TP->Tokens->Params[3]->Type == TYPE_LONG) &&
2845 (TP->Tokens->Params[3]->lvalue <= LongVector[0]))
2847 return LongVector[TP->Tokens->Params[2]->lvalue] ==
2848 LongVector[TP->Tokens->Params[3]->lvalue];
2852 if ((TP->Tokens->Params[2]->Type == TYPE_LONG) ||
2853 (TP->Tokens->Params[2]->Type == TYPE_LONG)) {
2855 Target, "ConditionalLongvector", ERR_PARM1, TP,
2856 "needs two long Parameter!");
2860 Target, "Longvector", ERR_PARM1, TP,
2861 "doesn't have %ld / %ld Parameters, its just the size of %ld!",
2862 TP->Tokens->Params[2]->lvalue,
2863 TP->Tokens->Params[3]->lvalue,
2871 void tmplput_CURRENT_FILE(StrBuf *Target, WCTemplputParams *TP)
2873 StrBufAppendTemplate(Target, TP, TP->Tokens->FileName, 0);
2880 RegisterCTX(CTX_TAB);
2881 RegisterCTX(CTX_ITERATE);
2883 memset(&NoCtx, 0, sizeof(WCTemplputParams));
2884 RegisterNamespace("--", 0, 2, tmplput_Comment, NULL, CTX_NONE);
2885 RegisterNamespace("SORT:ICON", 1, 2, tmplput_SORT_ICON, NULL, CTX_NONE);
2886 RegisterNamespace("SORT:ORDER", 1, 2, tmplput_SORT_ORDER, NULL, CTX_NONE);
2887 RegisterNamespace("SORT:NEXT", 1, 2, tmplput_SORT_NEXT, NULL, CTX_NONE);
2888 RegisterNamespace("CONTEXTSTR", 0, 1, tmplput_ContextString, NULL, CTX_STRBUF);
2889 RegisterNamespace("CONTEXTSTRARR", 1, 2, tmplput_ContextStringArray, NULL, CTX_STRBUFARR);
2890 RegisterNamespace("ITERATE", 2, 100, tmpl_iterate_subtmpl, preeval_iterate, CTX_NONE);
2891 RegisterNamespace("DOBOXED", 1, 2, tmpl_do_boxed, NULL, CTX_NONE);
2892 RegisterNamespace("DOTABBED", 2, 100, tmpl_do_tabbed, preeval_do_tabbed, CTX_NONE);
2893 RegisterNamespace("TAB:N", 0, 0, tmplput_TAB_N, NULL, CTX_TAB);
2894 RegisterNamespace("TAB:SUBJECT", 0, 1, tmplput_TAB_TITLE, NULL, CTX_TAB);
2897 RegisterNamespace("LONGVECTOR", 1, 1, tmplput_long_vector, NULL, CTX_LONGVECTOR);
2900 RegisterConditional("COND:CONTEXTSTR", 3, ConditionalContextStr, CTX_STRBUF);
2901 RegisterConditional("COND:CONTEXTSTRARR", 4, ConditionalContextStrinArray, CTX_STRBUFARR);
2902 RegisterConditional("COND:LONGVECTOR", 4, ConditionalLongVector, CTX_LONGVECTOR);
2905 RegisterConditional("COND:ITERATE:ISGROUPCHANGE", 2,
2906 conditional_ITERATE_ISGROUPCHANGE,
2908 RegisterConditional("COND:ITERATE:LASTN", 2,
2909 conditional_ITERATE_LASTN,
2911 RegisterConditional("COND:ITERATE:FIRSTN", 2,
2912 conditional_ITERATE_FIRSTN,
2914 RegisterConditional("COND:ITERATE:ISMOD", 3,
2915 conditional_ITERATE_ISMOD,
2918 RegisterNamespace("ITERATE:ODDEVEN", 0, 0, tmplput_ITERATE_ODDEVEN, NULL, CTX_ITERATE);
2919 RegisterNamespace("ITERATE:KEY", 0, 0, tmplput_ITERATE_KEY, NULL, CTX_ITERATE);
2920 RegisterNamespace("ITERATE:N", 0, 0, tmplput_ITERATE_N, NULL, CTX_ITERATE);
2921 RegisterNamespace("ITERATE:N:DIV", 1, 1, tmplput_ITERATE_N_DIV, NULL, CTX_ITERATE);
2922 RegisterNamespace("CURRENTFILE", 0, 1, tmplput_CURRENT_FILE, NULL, CTX_NONE);
2923 RegisterNamespace("DEF:STR", 1, 1, tmplput_DefStr, NULL, CTX_NONE);
2924 RegisterNamespace("DEF:VAL", 1, 1, tmplput_DefVal, NULL, CTX_NONE);
2932 ServerStartModule_SUBST
2935 textPlainType = NewStrBufPlain(HKEY("text/plain"));
2936 LocalTemplateCache = NewHash(1, NULL);
2937 TemplateCache = NewHash(1, NULL);
2938 GlobalNS = NewHash(1, NULL);
2939 Iterators = NewHash(1, NULL);
2940 Conditionals = NewHash(1, NULL);
2941 SortHash = NewHash(1, NULL);
2942 Defines = NewHash(1, NULL);
2943 CtxList = NewHash(1, NULL);
2945 PutContextType(HKEY("CTX_NONE"), 0);
2947 RegisterCTX(CTX_STRBUF);
2948 RegisterCTX(CTX_STRBUFARR);
2949 RegisterCTX(CTX_LONGVECTOR);
2953 FinalizeModule_SUBST
2960 ServerShutdownModule_SUBST
2963 FreeStrBuf(&textPlainType);
2965 DeleteHash(&TemplateCache);
2966 DeleteHash(&LocalTemplateCache);
2968 DeleteHash(&GlobalNS);
2969 DeleteHash(&Iterators);
2970 DeleteHash(&Conditionals);
2971 DeleteHash(&SortHash);
2972 DeleteHash(&Defines);
2973 DeleteHash(&CtxList);
2978 SessionNewModule_SUBST
2985 SessionAttachModule_SUBST
2991 SessionDetachModule_SUBST
2994 FreeStrBuf(&sess->WFBuf);
2998 SessionDestroyModule_SUBST