14 #define SHOW_ME_VAPPEND_PRINTF
17 #include "webserver.h"
19 extern char *static_dirs[PATH_MAX]; /* Disk representation */
21 HashList *TemplateCache;
22 HashList *LocalTemplateCache;
26 HashList *Conditionals;
30 int DumpTemplateI18NStrings = 0;
31 int LoadTemplates = 0;
32 int dbg_backtrace_template_errors = 0;
33 WCTemplputParams NoCtx;
34 StrBuf *I18nDump = NULL;
36 const char EmptyStr[]="";
39 #define SV_CONDITIONAL 2
40 #define SV_NEG_CONDITIONAL 3
41 #define SV_CUST_STR_CONDITIONAL 4
43 #define SV_PREEVALUATED 6
47 * Dynamic content for variable substitution in templates
49 typedef struct _wcsubst {
51 int wcs_type; /* which type of Substitution are we */
52 char wcs_key[32]; /* copy of our hashkey for debugging */
53 StrBuf *wcs_value; /* if we're a string, keep it here */
54 long lvalue; /* type long? keep data here */
55 WCHandlerFunc wcs_function; /* funcion hook ???*/
59 typedef struct _WCTemplate {
65 WCTemplateToken **Tokens;
68 typedef struct _HashHandler {
70 WCPreevalFunc PreEvalFunc;
71 WCHandlerFunc HandlerFunc;
74 void *load_template(WCTemplate *NewTemplate);
75 int EvaluateConditional(StrBuf *Target, int Neg, int state, WCTemplputParams *TP);
79 typedef struct _SortStruct {
84 CompareFunc GroupChange;
89 const char *CtxNames[] = {
100 "Context MIME_ATACH",
104 "Context LONGVECTOR",
109 "Context DavNamespace",
112 "Context SIEVE List",
113 "Context SIEVE Script",
119 void DestroySortStruct(void *vSort)
121 SortStruct *Sort = (SortStruct*) vSort;
122 FreeStrBuf(&Sort->Name);
123 FreeStrBuf(&Sort->PrefPrepend);
127 const char *ContextName(int ContextType)
129 if (ContextType < CTX_UNKNOWN)
130 return CtxNames[ContextType];
132 return CtxNames[CTX_UNKNOWN];
135 void LogTemplateError (StrBuf *Target, const char *Type, int ErrorPos, WCTemplputParams *TP, const char *Format, ...)
141 const char *Err = NULL;
146 va_start(arg_ptr, Format);
147 StrBufVAppendPrintf(Error, Format, arg_ptr);
151 case ERR_NAME: /* the main token name... */
152 Err = (TP->Tokens!= NULL)? TP->Tokens->pName:"";
155 Err = ((TP->Tokens!= NULL) &&
156 (TP->Tokens->nParameters > ErrorPos - 1))?
157 TP->Tokens->Params[ErrorPos - 1]->Start : "";
160 if (TP->Tokens != NULL)
162 syslog(1, "%s [%s] (in '%s' line %ld); %s; [%s]\n",
165 ChrPtr(TP->Tokens->FileName),
168 ChrPtr(TP->Tokens->FlatToken));
172 syslog(1, "%s: %s;\n",
187 if (WCC->WFBuf == NULL) WCC->WFBuf = NewStrBuf();
188 if (TP->Tokens != NULL)
193 "<pre>\n%s [%s] (in '%s' line %ld); %s\n[%s]\n</pre>\n",
196 ChrPtr(TP->Tokens->FileName),
199 ChrPtr(TP->Tokens->FlatToken));
201 StrBufPrintf(Info, "%s [%s] %s; [%s]",
205 ChrPtr(TP->Tokens->FlatToken));
208 SerializeJson(WCC->WFBuf, WildFireException(SKEY(TP->Tokens->FileName),
213 SerializeJson(Header, WildFireMessage(SKEY(TP->Tokens->FileName),
225 "<pre>\n%s: %s\n</pre>\n",
229 StrBufPrintf(Info, "%s [%s] %s; [%s]",
233 ChrPtr(TP->Tokens->FlatToken));
234 SerializeJson(WCC->WFBuf, WildFireException(HKEY(__FILE__), __LINE__, Info, 1), 1);
239 if (dbg_backtrace_template_errors)
247 void LogError (StrBuf *Target, const char *Type, const char *Format, ...)
257 va_start(arg_ptr, Format);
258 StrBufVAppendPrintf(Error, Format, arg_ptr);
261 syslog(1, "%s", ChrPtr(Error));
264 if (WCC->WFBuf == NULL) WCC->WFBuf = NewStrBuf();
266 SerializeJson(WCC->WFBuf, WildFireException(Type, strlen(Type),
274 if (dbg_backtrace_template_errors)
280 void RegisterNS(const char *NSName,
284 WCHandlerFunc HandlerFunc,
285 WCPreevalFunc PreevalFunc,
288 HashHandler *NewHandler;
290 NewHandler = (HashHandler*) malloc(sizeof(HashHandler));
291 memset(NewHandler, 0, sizeof(HashHandler));
292 NewHandler->Filter.nMinArgs = nMinArgs;
293 NewHandler->Filter.nMaxArgs = nMaxArgs;
294 NewHandler->Filter.ContextType = ContextRequired;
295 NewHandler->Filter.ControlContextType = CTX_NONE;
297 NewHandler->PreEvalFunc = PreevalFunc;
298 NewHandler->HandlerFunc = HandlerFunc;
299 Put(GlobalNS, NSName, len, NewHandler, NULL);
302 void RegisterControlNS(const char *NSName,
306 WCHandlerFunc HandlerFunc,
307 int ControlContextRequired)
309 HashHandler *NewHandler;
311 NewHandler = (HashHandler*) malloc(sizeof(HashHandler));
312 memset(NewHandler, 0, sizeof(HashHandler));
313 NewHandler->Filter.nMinArgs = nMinArgs;
314 NewHandler->Filter.nMaxArgs = nMaxArgs;
315 NewHandler->Filter.ContextType = CTX_NONE;
316 NewHandler->Filter.ControlContextType = ControlContextRequired;
317 NewHandler->HandlerFunc = HandlerFunc;
318 Put(GlobalNS, NSName, len, NewHandler, NULL);
323 int CheckContext(StrBuf *Target, ContextFilter *Need, WCTemplputParams *TP, const char *ErrType)
325 if ((Need->ContextType != CTX_NONE) &&
326 (Need->ContextType != TP->Filter.ContextType)) {
328 Target, ErrType, ERR_PARM1, TP,
329 " WARNING: requires Context: [%s], have [%s]!",
330 ContextName(Need->ContextType),
331 ContextName(TP->Filter.ContextType));
335 if ((Need->ControlContextType != CTX_NONE) &&
336 (Need->ControlContextType != TP->Filter.ControlContextType)) {
338 Target, ErrType, ERR_PARM1, TP,
339 " WARNING: requires Control Context: [%s], have [%s]!",
340 ContextName(Need->ControlContextType),
341 ContextName(TP->Filter.ControlContextType));
345 if (TP->Tokens->nParameters < Need->nMinArgs) {
346 LogTemplateError(Target, ErrType, ERR_NAME, TP,
347 "needs at least %ld params, have %ld",
349 TP->Tokens->nParameters);
353 else if (TP->Tokens->nParameters > Need->nMaxArgs) {
354 LogTemplateError(Target, ErrType, ERR_NAME, TP,
355 "just needs %ld params, you gave %ld",
357 TP->Tokens->nParameters);
365 void FreeToken(WCTemplateToken **Token)
368 FreeStrBuf(&(*Token)->FlatToken);
369 if ((*Token)->HaveParameters)
370 for (i = 0; i < (*Token)->nParameters; i++)
371 free((*Token)->Params[i]);
378 void FreeWCTemplate(void *vFreeMe)
381 WCTemplate *FreeMe = (WCTemplate*)vFreeMe;
383 if (FreeMe->TokenSpace > 0) {
384 for (i = 0; i < FreeMe->nTokensUsed; i ++) {
385 FreeToken(&FreeMe->Tokens[i]);
387 free(FreeMe->Tokens);
389 FreeStrBuf(&FreeMe->FileName);
390 FreeStrBuf(&FreeMe->Data);
391 FreeStrBuf(&FreeMe->MimeType);
395 int HaveTemplateTokenString(StrBuf *Target,
396 WCTemplputParams *TP,
401 if (N >= TP->Tokens->nParameters) {
405 switch (TP->Tokens->Params[N]->Type) {
411 case TYPE_SUBTEMPLATE:
420 void GetTemplateTokenString(StrBuf *Target,
421 WCTemplputParams *TP,
427 WCTemplputParams SubTP;
429 if (N >= TP->Tokens->nParameters) {
430 LogTemplateError(Target,
431 "TokenParameter", N, TP,
432 "invalid token %d. this shouldn't have come till here.\n", N);
438 switch (TP->Tokens->Params[N]->Type) {
442 *Value = TP->Tokens->Params[N]->Start;
443 *len = TP->Tokens->Params[N]->len;
446 if (TP->Tokens->Params[N]->len == 0) {
447 LogTemplateError(Target,
448 "TokenParameter", N, TP,
449 "Requesting parameter %d; of type BSTR, empty lookup string not admitted.", N);
454 Buf = (StrBuf*) SBstr(TKEY(N));
455 *Value = ChrPtr(Buf);
456 *len = StrLength(Buf);
459 if (TP->Tokens->Params[N]->len == 0) {
460 LogTemplateError(Target,
461 "TokenParameter", N, TP,
462 "Requesting parameter %d; of type PREFSTR, empty lookup string not admitted.", N);
467 get_PREFERENCE(TKEY(N), &Buf);
468 *Value = ChrPtr(Buf);
469 *len = StrLength(Buf);
472 LogTemplateError(Target,
473 "TokenParameter", N, TP,
474 "Requesting parameter %d; of type LONG, want string.", N);
477 LogTemplateError(Target,
478 "TokenParameter", N, TP,
479 "Requesting parameter %d; of type PREFINT, want string.", N);
482 *Value = _(TP->Tokens->Params[N]->Start);
483 *len = strlen(*Value);
485 case TYPE_SUBTEMPLATE:
486 if (TP->Tokens->Params[N]->len == 0) {
487 LogTemplateError(Target,
488 "TokenParameter", N, TP,
489 "Requesting parameter %d; of type SUBTEMPLATE, empty lookup string not admitted.", N);
495 memset(&SubTP, 0, sizeof(WCTemplputParams *));
496 SubTP.Context = TP->Context;
497 SubTP.Filter.ContextType = TP->Filter.ContextType;
499 DoTemplate(TKEY(N), Buf, &SubTP);
500 *Value = ChrPtr(Buf);
501 *len = StrLength(Buf);
502 /* we can't free it here, so we put it into the subst so its discarded later on. */
503 PutRequestLocalMem(Buf, HFreeStrBuf);
507 LogTemplateError(Target,
508 "TokenParameter", N, TP,
509 "unknown param type %d; [%d]", N, TP->Tokens->Params[N]->Type);
514 long GetTemplateTokenNumber(StrBuf *Target, WCTemplputParams *TP, int N, long dflt)
517 if (N >= TP->Tokens->nParameters) {
518 LogTemplateError(Target,
519 "TokenParameter", N, TP,
520 "invalid token %d. this shouldn't have come till here.\n", N);
525 switch (TP->Tokens->Params[N]->Type) {
528 return atol(TP->Tokens->Params[N]->Start);
531 if (TP->Tokens->Params[N]->len == 0) {
532 LogTemplateError(Target,
533 "TokenParameter", N, TP,
534 "Requesting parameter %d; of type BSTR, empty lookup string not admitted.", N);
537 return LBstr(TKEY(N));
540 LogTemplateError(Target,
541 "TokenParameter", N, TP,
542 "requesting a prefstring in param %d want a number", N);
543 if (TP->Tokens->Params[N]->len == 0) {
544 LogTemplateError(Target,
545 "TokenParameter", N, TP,
546 "Requesting parameter %d; of type PREFSTR, empty lookup string not admitted.", N);
549 if (get_PREF_LONG(TKEY(N), &Ret, dflt))
554 return TP->Tokens->Params[N]->lvalue;
556 if (TP->Tokens->Params[N]->len == 0) {
557 LogTemplateError(Target,
558 "TokenParameter", N, TP,
559 "Requesting parameter %d; of type PREFINT, empty lookup string not admitted.", N);
562 if (get_PREF_LONG(TKEY(N), &Ret, dflt))
566 LogTemplateError(Target,
567 "TokenParameter", N, TP,
568 "requesting a I18N string in param %d; want a number", N);
570 case TYPE_SUBTEMPLATE:
571 LogTemplateError(Target,
572 "TokenParameter", N, TP,
573 "requesting a subtemplate in param %d; not supported for numbers", N);
576 LogTemplateError(Target,
577 "TokenParameter", N, TP,
578 "unknown param type %d; [%d]", N, TP->Tokens->Params[N]->Type);
585 * \brief puts string into the template and computes which escape methon we should use
586 * \param Source the string we should put into the template
587 * \param FormatTypeIndex where should we look for escape types if?
589 void StrBufAppendTemplate(StrBuf *Target,
590 WCTemplputParams *TP,
591 const StrBuf *Source, int FormatTypeIndex)
593 const char *pFmt = NULL;
596 if ((FormatTypeIndex < TP->Tokens->nParameters) &&
597 (TP->Tokens->Params[FormatTypeIndex]->Type == TYPE_STR) &&
598 (TP->Tokens->Params[FormatTypeIndex]->len >= 1)) {
599 pFmt = TP->Tokens->Params[FormatTypeIndex]->Start;
606 StrEscAppend(Target, Source, NULL, 0, 2);
609 StrEscAppend(Target, Source, NULL, 0, 0);
612 StrECMAEscAppend(Target, Source, NULL);
615 StrHtmlEcmaEscAppend(Target, Source, NULL, 0, 0);
618 StrBufUrlescAppend(Target, Source, NULL);
621 if (pFmt != NULL) pFmt++;
622 else pFmt = "JUSTIFY";
623 if (*pFmt == '\0') pFmt = "JUSTIFY";
624 FmOut(Target, pFmt, Source);
627 StrBufAppendBuf(Target, Source, 0);
632 void PutNewToken(WCTemplate *Template, WCTemplateToken *NewToken)
634 if (Template->nTokensUsed + 1 >= Template->TokenSpace) {
635 if (Template->TokenSpace <= 0) {
636 Template->Tokens = (WCTemplateToken**)malloc(
637 sizeof(WCTemplateToken*) * 10);
638 memset(Template->Tokens, 0, sizeof(WCTemplateToken*) * 10);
639 Template->TokenSpace = 10;
642 WCTemplateToken **NewTokens;
644 NewTokens= (WCTemplateToken**) malloc(
645 sizeof(WCTemplateToken*) * Template->TokenSpace * 2);
648 0, sizeof(WCTemplateToken*) * Template->TokenSpace * 2);
652 sizeof(WCTemplateToken*) * Template->nTokensUsed);
654 free(Template->Tokens);
655 Template->TokenSpace *= 2;
656 Template->Tokens = NewTokens;
659 Template->Tokens[(Template->nTokensUsed)++] = NewToken;
662 int GetNextParameter(StrBuf *Buf,
665 WCTemplateToken *Tokens,
667 WCTemplputParams *TP,
668 TemplateParam **pParm)
670 const char *pch = *pCh;
671 const char *pchs, *pche;
676 *pParm = Parm = (TemplateParam *) malloc(sizeof(TemplateParam));
677 memset(Parm, 0, sizeof(TemplateParam));
678 Parm->Type = TYPE_STR;
680 /* Skip leading whitespaces */
681 while ((*pch == ' ' )||
684 (*pch == '\n')) pch ++;
687 Parm->Type = TYPE_PREFSTR;
694 else if (*pch == ';') {
695 Parm->Type = TYPE_PREFINT;
702 else if (*pch == '#') {
703 Parm->Type = TYPE_INTDEFINE;
706 else if (*pch == '_') {
707 Parm->Type = TYPE_GETTEXT;
714 else if (*pch == 'B') {
715 Parm->Type = TYPE_BSTR;
722 else if (*pch == '=') {
723 Parm->Type = TYPE_SUBTEMPLATE;
734 else if (*pch == '\'')
741 ( (pch > pchs) && (*(pch - 1) == '\\'))
747 syslog(1, "Error (in '%s' line %ld); "
748 "evaluating template param [%s] in Token [%s]\n",
749 ChrPtr(pTmpl->FileName),
751 ChrPtr(Tokens->FlatToken),
759 StrBufPeek(Buf, pch, -1, '\0');
760 if (LoadTemplates > 1) {
761 syslog(1, "DBG: got param [%s] %ld %ld\n",
762 pchs, pche - pchs, strlen(pchs));
765 Parm->len = pche - pchs;
766 pch ++; /* move after trailing quote */
767 if (ParamBrace && (*pch == ')')) {
774 Parm->Type = TYPE_LONG;
776 while ((pch <= pe) &&
783 StrBufPeek(Buf, pch, -1, '\0');
784 Parm->lvalue = atol(pchs);
791 syslog(1, "Error (in '%s' line %ld); "
792 "evaluating long template param [%s] in Token [%s]\n",
793 ChrPtr(pTmpl->FileName),
795 ChrPtr(Tokens->FlatToken),
803 while ((*pch == ' ' )||
807 (*pch == '\n')) pch ++;
812 if (DumpTemplateI18NStrings) {
813 StrBufAppendPrintf(I18nDump, "_(\"%s\");\n", Parm->Start);
816 case TYPE_INTDEFINE: {
819 if (GetHash(Defines, Parm->Start, Parm->len, &vPVal) &&
823 PVal = (long*) vPVal;
825 Parm->lvalue = *PVal;
827 else if (strchr(Parm->Start, '|') != NULL)
834 pToken = NewStrBufPlain (Parm->Start, Parm->len);
835 Match = NewStrBufPlain (NULL, Parm->len);
836 Pos = ChrPtr(pToken);
838 while ((Pos != NULL) && (Pos != StrBufNOTNULL))
840 StrBufExtract_NextToken(Match, pToken, &Pos, '|');
842 if (StrLength (Match) > 0)
844 if (GetHash(Defines, SKEY(Match), &vPVal) &&
848 PVal = (long*) vPVal;
850 Parm->lvalue |= *PVal;
853 LogTemplateError(NULL, "Define",
865 else if (strchr(Parm->Start, '&') != NULL)
872 pToken = NewStrBufPlain (Parm->Start, Parm->len);
873 Match = NewStrBufPlain (NULL, Parm->len);
874 Pos = ChrPtr(pToken);
876 while ((Pos != NULL) && (Pos != StrBufNOTNULL))
878 StrBufExtract_NextToken(Match, pToken, &Pos, '&');
880 if (StrLength (Match) > 0)
882 if (GetHash(Defines, SKEY(Match), &vPVal) &&
886 PVal = (long*) vPVal;
888 Parm->lvalue |= *PVal;
891 LogTemplateError(NULL, "Define",
906 LogTemplateError(NULL, "Define",
913 case TYPE_SUBTEMPLATE:{
915 /* well, we don't check the mobile stuff here... */
916 if (!GetHash(LocalTemplateCache, Parm->Start, Parm->len, &vTmpl) &&
917 !GetHash(TemplateCache, Parm->Start, Parm->len, &vTmpl)) {
918 LogTemplateError(NULL,
922 "referenced here doesn't exist");
930 WCTemplateToken *NewTemplateSubstitute(StrBuf *Buf,
932 const char *pTokenStart,
933 const char *pTokenEnd,
939 WCTemplateToken *NewToken;
942 NewToken = (WCTemplateToken*)malloc(sizeof(WCTemplateToken));
943 memset(NewToken, 0, sizeof(WCTemplateToken));
944 TP.Tokens = NewToken;
945 NewToken->FileName = pTmpl->FileName; /* to print meaningfull log messages... */
947 NewToken->Line = Line + 1;
948 NewToken->pTokenStart = pTokenStart;
949 NewToken->TokenStart = pTokenStart - pStart;
950 NewToken->TokenEnd = (pTokenEnd - pStart) - NewToken->TokenStart;
951 NewToken->pTokenEnd = pTokenEnd;
952 NewToken->NameEnd = NewToken->TokenEnd - 2;
953 NewToken->PreEval = NULL;
954 NewToken->FlatToken = NewStrBufPlain(pTokenStart + 2, pTokenEnd - pTokenStart - 2);
955 StrBufShrinkToFit(NewToken->FlatToken, 1);
957 StrBufPeek(Buf, pTokenStart, + 1, '\0');
958 StrBufPeek(Buf, pTokenEnd, -1, '\0');
959 pch = NewToken->pName = pTokenStart + 2;
961 NewToken->HaveParameters = 0;;
962 NewToken->nParameters = 0;
964 while (pch < pTokenEnd - 1) {
966 StrBufPeek(Buf, pch, -1, '\0');
967 NewToken->NameEnd = pch - NewToken->pName;
969 if (*(pTokenEnd - 1) != ')') {
971 NULL, "Parseerror", ERR_NAME, &TP,
972 "Warning, Non welformed Token; missing right parenthesis");
974 while (pch < pTokenEnd - 1) {
975 NewToken->nParameters++;
976 if (GetNextParameter(Buf,
982 &NewToken->Params[NewToken->nParameters - 1]))
984 NewToken->HaveParameters = 1;
985 if (NewToken->nParameters >= MAXPARAM) {
987 NULL, "Parseerror", ERR_NAME, &TP,
988 "only [%d] Params allowed in Tokens",
991 FreeToken(&NewToken);
997 if((NewToken->NameEnd == 1) &&
998 (NewToken->HaveParameters == 1))
1001 if (*(NewToken->pName) == '_')
1002 NewToken->Flags = SV_GETTEXT;
1003 else if (*(NewToken->pName) == '=')
1004 NewToken->Flags = SV_SUBTEMPL;
1005 else if (*(NewToken->pName) == '%')
1006 NewToken->Flags = SV_CUST_STR_CONDITIONAL;
1007 else if (*(NewToken->pName) == '?')
1008 NewToken->Flags = SV_CONDITIONAL;
1009 else if (*(NewToken->pName) == '!')
1010 NewToken->Flags = SV_NEG_CONDITIONAL;
1016 switch (NewToken->Flags) {
1018 /* If we're able to find out more about the token, do it now while its fresh. */
1019 if (GetHash(GlobalNS, NewToken->pName, NewToken->NameEnd, &vVar)) {
1020 HashHandler *Handler;
1021 Handler = (HashHandler*) vVar;
1022 if ((NewToken->nParameters < Handler->Filter.nMinArgs) ||
1023 (NewToken->nParameters > Handler->Filter.nMaxArgs)) {
1025 NULL, "Token", ERR_NAME, &TP,
1026 "doesn't work with %d params",
1027 NewToken->nParameters);
1031 NewToken->PreEval = Handler;
1032 NewToken->Flags = SV_PREEVALUATED;
1033 if (Handler->PreEvalFunc != NULL)
1034 Handler->PreEvalFunc(NewToken);
1039 if (NewToken->nParameters !=1) {
1041 NULL, "Gettext", ERR_NAME, &TP,
1042 "requires exactly 1 parameter, you gave %d params",
1043 NewToken->nParameters);
1044 NewToken->Flags = 0;
1047 if (DumpTemplateI18NStrings) {
1048 StrBufAppendPrintf(I18nDump, "_(\"%s\");\n", NewToken->Params[0]->Start);
1052 if (NewToken->nParameters != 1) {
1054 NULL, "Subtemplates", ERR_NAME, &TP,
1055 "require exactly 1 parameter, you gave %d params",
1056 NewToken->nParameters);
1061 /* well, we don't check the mobile stuff here... */
1062 if (!GetHash(LocalTemplateCache,
1063 NewToken->Params[0]->Start,
1064 NewToken->Params[0]->len,
1066 !GetHash(TemplateCache,
1067 NewToken->Params[0]->Start,
1068 NewToken->Params[0]->len,
1071 NULL, "SubTemplate", ERR_PARM1, &TP,
1076 case SV_CUST_STR_CONDITIONAL:
1077 case SV_CONDITIONAL:
1078 case SV_NEG_CONDITIONAL:
1079 if (NewToken->nParameters <2) {
1081 NULL, "Conditional", ERR_PARM1, &TP,
1082 "require at least 2 parameters, you gave %d params",
1083 NewToken->nParameters);
1084 NewToken->Flags = 0;
1087 if (NewToken->Params[1]->lvalue == 0) {
1089 NULL, "Conditional", ERR_PARM1, &TP,
1090 "Conditional ID (Parameter 1) mustn't be 0!");
1091 NewToken->Flags = 0;
1094 if (!GetHash(Conditionals,
1095 NewToken->Params[0]->Start,
1096 NewToken->Params[0]->len,
1099 if ((NewToken->Params[0]->len == 1) &&
1100 (NewToken->Params[0]->Start[0] == 'X'))
1103 NULL, "Conditional", ERR_PARM1, &TP,
1106 NewToken->Error = NewStrBuf();
1109 "<pre>\nConditional [%s] (in '%s' line %ld); Not found!\n[%s]\n</pre>\n",
1110 NewToken->Params[0]->Start,
1111 ChrPtr(pTmpl->FileName),
1113 ChrPtr(NewToken->FlatToken));
1117 NewToken->PreEval = vVar;
1129 * \brief Display a variable-substituted template
1130 * \param templatename template file to load
1132 void *prepare_template(StrBuf *filename, StrBuf *Key, HashList *PutThere)
1134 WCTemplate *NewTemplate;
1136 NewTemplate = (WCTemplate *) malloc(sizeof(WCTemplate));
1137 memset(NewTemplate, 0, sizeof(WCTemplate));
1138 NewTemplate->Data = NULL;
1139 NewTemplate->FileName = NewStrBufDup(filename);
1140 StrBufShrinkToFit(NewTemplate->FileName, 1);
1141 NewTemplate->nTokensUsed = 0;
1142 NewTemplate->TokenSpace = 0;
1143 NewTemplate->Tokens = NULL;
1144 NewTemplate->MimeType = NewStrBufPlain(GuessMimeByFilename (SKEY(NewTemplate->FileName)), -1);
1145 if (strstr(ChrPtr(NewTemplate->MimeType), "text") != NULL) {
1146 StrBufAppendBufPlain(NewTemplate->MimeType, HKEY("; charset=utf-8"), 0);
1149 if (strstr(ChrPtr(NewTemplate->MimeType), "text") != NULL) {
1150 StrBufAppendBufPlain(NewTemplate->MimeType, HKEY("; charset=utf-8"), 0);
1153 Put(PutThere, ChrPtr(Key), StrLength(Key), NewTemplate, FreeWCTemplate);
1158 * \brief Display a variable-substituted template
1159 * \param templatename template file to load
1161 void *duplicate_template(WCTemplate *OldTemplate)
1163 WCTemplate *NewTemplate;
1165 NewTemplate = (WCTemplate *) malloc(sizeof(WCTemplate));
1166 memset(NewTemplate, 0, sizeof(WCTemplate));
1167 NewTemplate->Data = NULL;
1168 NewTemplate->FileName = NewStrBufDup(OldTemplate->FileName);
1169 StrBufShrinkToFit(NewTemplate->FileName, 1);
1170 NewTemplate->nTokensUsed = 0;
1171 NewTemplate->TokenSpace = 0;
1172 NewTemplate->Tokens = NULL;
1173 NewTemplate->MimeType = NewStrBufDup(OldTemplate->MimeType);
1178 * \brief Display a variable-substituted template
1179 * \param templatename template file to load
1181 void *load_template(WCTemplate *NewTemplate)
1184 struct stat statbuf;
1185 const char *pS, *pE, *pch, *Err;
1188 fd = open(ChrPtr(NewTemplate->FileName), O_RDONLY);
1190 syslog(1, "ERROR: could not open template '%s' - %s\n",
1191 ChrPtr(NewTemplate->FileName), strerror(errno));
1195 if (fstat(fd, &statbuf) == -1) {
1196 syslog(1, "ERROR: could not stat template '%s' - %s\n",
1197 ChrPtr(NewTemplate->FileName), strerror(errno));
1201 NewTemplate->Data = NewStrBufPlain(NULL, statbuf.st_size + 1);
1202 if (StrBufReadBLOB(NewTemplate->Data, &fd, 1, statbuf.st_size, &Err) < 0) {
1204 syslog(1, "ERROR: reading template '%s' - %s<br>\n",
1205 ChrPtr(NewTemplate->FileName), strerror(errno));
1211 StrBufShrinkToFit(NewTemplate->Data, 1);
1212 StrBufShrinkToFit(NewTemplate->MimeType, 1);
1213 pS = pch = ChrPtr(NewTemplate->Data);
1214 pE = pS + StrLength(NewTemplate->Data);
1216 const char *pts, *pte;
1218 int InDoubleQuotes = 0;
1221 /** Find one <? > */
1222 for (; pch < pE; pch ++) {
1223 if ((*pch=='<')&&(*(pch + 1)=='?') &&
1224 !((pch == pS) && /* we must ommit a <?xml */
1225 (*(pch + 2) == 'x') &&
1226 (*(pch + 3) == 'm') &&
1227 (*(pch + 4) == 'l')))
1229 if (*pch=='\n') Line ++;
1235 /** Found one? parse it. */
1236 for (; pch <= pE - 1; pch ++) {
1238 InDoubleQuotes = ! InDoubleQuotes;
1239 else if (*pch == '\'')
1240 InQuotes = ! InQuotes;
1241 else if ((!InQuotes && !InDoubleQuotes) &&
1242 ((*pch!='\\')&&(*(pch + 1)=='>'))) {
1250 pv = NewTemplateSubstitute(NewTemplate->Data, pS, pts, pte, Line, NewTemplate);
1252 PutNewToken(NewTemplate, pv);
1260 const char* PrintTemplate(void *vSubst)
1262 WCTemplate *Tmpl = vSubst;
1264 return ChrPtr(Tmpl->FileName);
1268 int LoadTemplateDir(const StrBuf *DirName, HashList *big, const StrBuf *BaseKey)
1274 StrBuf *SubDirectory;
1275 DIR *filedir = NULL;
1276 struct dirent *filedir_entry;
1282 d = (struct dirent *)malloc(offsetof(struct dirent, d_name) + PATH_MAX + 1);
1287 filedir = opendir (ChrPtr(DirName));
1288 if (filedir == NULL) {
1293 Toplevel = StrLength(BaseKey) == 0;
1294 SubDirectory = NewStrBuf();
1295 SubKey = NewStrBuf();
1296 FileName = NewStrBufPlain(NULL, PATH_MAX);
1298 while ((readdir_r(filedir, d, &filedir_entry) == 0) &&
1299 (filedir_entry != NULL))
1303 #ifdef _DIRENT_HAVE_D_NAMELEN
1304 d_namelen = filedir_entry->d_namelen;
1305 d_type = filedir_entry->d_type;
1309 #define DT_UNKNOWN 0
1314 #define IFTODT(mode) (((mode) & 0170000) >> 12)
1315 #define DTTOIF(dirtype) ((dirtype) << 12)
1317 d_namelen = strlen(filedir_entry->d_name);
1318 d_type = DT_UNKNOWN;
1320 d_without_ext = d_namelen;
1322 if ((d_namelen > 1) && filedir_entry->d_name[d_namelen - 1] == '~')
1323 continue; /* Ignore backup files... */
1325 if ((d_namelen == 1) &&
1326 (filedir_entry->d_name[0] == '.'))
1329 if ((d_namelen == 2) &&
1330 (filedir_entry->d_name[0] == '.') &&
1331 (filedir_entry->d_name[1] == '.'))
1334 if (d_type == DT_UNKNOWN) {
1336 char path[PATH_MAX];
1337 snprintf(path, PATH_MAX, "%s/%s",
1338 ChrPtr(DirName), filedir_entry->d_name);
1339 if (stat(path, &s) == 0) {
1340 d_type = IFTODT(s.st_mode);
1346 /* Skip directories we are not interested in... */
1347 if (strcmp(filedir_entry->d_name, ".svn") == 0)
1350 FlushStrBuf(SubKey);
1352 /* If we're not toplevel, the upper dirs count as foo_bar_<local name>*/
1353 StrBufAppendBuf(SubKey, BaseKey, 0);
1354 StrBufAppendBufPlain(SubKey, HKEY("_"), 0);
1356 StrBufAppendBufPlain(SubKey, filedir_entry->d_name, d_namelen, 0);
1358 FlushStrBuf(SubDirectory);
1359 StrBufAppendBuf(SubDirectory, DirName, 0);
1360 if (ChrPtr(SubDirectory)[StrLength(SubDirectory) - 1] != '/')
1361 StrBufAppendBufPlain(SubDirectory, HKEY("/"), 0);
1362 StrBufAppendBufPlain(SubDirectory, filedir_entry->d_name, d_namelen, 0);
1364 LoadTemplateDir(SubDirectory, big, SubKey);
1367 case DT_LNK: /* TODO: check whether its a file or a directory */
1371 while ((d_without_ext > 0) && (filedir_entry->d_name[d_without_ext] != '.'))
1373 if ((d_without_ext == 0) || (d_namelen < 3))
1375 if (((d_namelen > 1) && filedir_entry->d_name[d_namelen - 1] == '~') ||
1376 (strcmp(&filedir_entry->d_name[d_without_ext], ".orig") == 0) ||
1377 (strcmp(&filedir_entry->d_name[d_without_ext], ".swp") == 0))
1378 continue; /* Ignore backup files... */
1379 StrBufPrintf(FileName, "%s/%s", ChrPtr(DirName), filedir_entry->d_name);
1380 MinorPtr = strchr(filedir_entry->d_name, '.');
1381 if (MinorPtr != NULL)
1385 /* If we're not toplevel, the upper dirs count as foo_bar_<local name>*/
1386 StrBufAppendBuf(Key, BaseKey, 0);
1387 StrBufAppendBufPlain(Key, HKEY("_"), 0);
1389 StrBufAppendBufPlain(Key, filedir_entry->d_name, MinorPtr - filedir_entry->d_name, 0);
1391 if (LoadTemplates >= 1)
1392 syslog(1, "%s %s\n", ChrPtr(FileName), ChrPtr(Key));
1393 prepare_template(FileName, Key, big);
1400 FreeStrBuf(&FileName);
1402 FreeStrBuf(&SubDirectory);
1403 FreeStrBuf(&SubKey);
1407 void InitTemplateCache(void)
1412 HashList *Templates[2];
1417 /* Primary Template set... */
1418 StrBufPrintf(Dir, "%s/t", static_dirs[0]);
1419 LoadTemplateDir(Dir,
1423 /* User local Template set */
1424 StrBufPrintf(Dir, "%s/t", static_dirs[1]);
1425 LoadTemplateDir(Dir,
1429 /* Debug Templates, just to be loaded while debugging. */
1431 StrBufPrintf(Dir, "%s/dbg", static_dirs[0]);
1432 LoadTemplateDir(Dir,
1435 Templates[0] = TemplateCache;
1436 Templates[1] = LocalTemplateCache;
1439 if (LoadTemplates == 0)
1440 for (i=0; i < 2; i++) {
1446 At = GetNewHashPos(Templates[i], 0);
1447 while (GetNextHashPos(Templates[i],
1452 (vTemplate != NULL))
1454 load_template((WCTemplate *)vTemplate);
1466 /*-----------------------------------------------------------------------------
1467 * Filling & processing Templates
1470 * \brief executes one token
1471 * \param Target buffer to append to
1472 * \param Token da to process.
1473 * \param Template we're iterating
1474 * \param Context Contextpoointer to pass in
1475 * \param state are we in conditional state?
1476 * \param ContextType what type of information does context giv us?
1478 int EvaluateToken(StrBuf *Target, int state, WCTemplputParams *TP)
1480 const char *AppendMe;
1482 HashHandler *Handler;
1485 /* much output, since pName is not terminated...
1486 syslog(1,"Doing token: %s\n",Token->pName);
1489 switch (TP->Tokens->Flags) {
1491 TmplGettext(Target, TP);
1493 case SV_CONDITIONAL: /** Forward conditional evaluation */
1494 return EvaluateConditional(Target, 1, state, TP);
1496 case SV_NEG_CONDITIONAL: /** Reverse conditional evaluation */
1497 return EvaluateConditional(Target, 0, state, TP);
1499 case SV_CUST_STR_CONDITIONAL: /** Conditional put custom strings from params */
1500 if (TP->Tokens->nParameters >= 6) {
1501 if (EvaluateConditional(Target, 0, state, TP)) {
1502 GetTemplateTokenString(Target, TP, 5, &AppendMe, &AppendMeLen);
1503 StrBufAppendBufPlain(Target,
1509 GetTemplateTokenString(Target, TP, 4, &AppendMe, &AppendMeLen);
1510 StrBufAppendBufPlain(Target,
1518 Target, "Conditional", ERR_NAME, TP,
1519 "needs at least 6 Params!");
1523 if (TP->Tokens->nParameters == 1)
1524 DoTemplate(TKEY(0), Target, TP);
1526 case SV_PREEVALUATED:
1527 Handler = (HashHandler*) TP->Tokens->PreEval;
1528 if (!CheckContext(Target, &Handler->Filter, TP, "Token")) {
1531 Handler->HandlerFunc(Target, TP);
1534 if (GetHash(GlobalNS, TP->Tokens->pName, TP->Tokens->NameEnd, &vVar)) {
1535 Handler = (HashHandler*) vVar;
1536 if (!CheckContext(Target, &Handler->Filter, TP, "Token")) {
1540 Handler->HandlerFunc(Target, TP);
1545 Target, "Token UNKNOWN", ERR_NAME, TP,
1546 "You've specified a token that isn't known to webcit.!");
1554 const StrBuf *ProcessTemplate(WCTemplate *Tmpl, StrBuf *Target, WCTemplputParams *CallingTP)
1556 WCTemplate *pTmpl = Tmpl;
1559 const char *pData, *pS;
1561 WCTemplputParams TP;
1563 memcpy(&TP.Filter, &CallingTP->Filter, sizeof(ContextFilter));
1565 TP.Context = CallingTP->Context;
1566 TP.ControlContext = CallingTP->ControlContext;
1568 if (LoadTemplates != 0) {
1569 if (LoadTemplates > 1)
1570 syslog(1, "DBG: ----- loading: [%s] ------ \n",
1571 ChrPtr(Tmpl->FileName));
1572 pTmpl = duplicate_template(Tmpl);
1573 if(load_template(pTmpl) == NULL) {
1576 "<pre>\nError loading Template [%s]\n See Logfile for details\n</pre>\n",
1577 ChrPtr(Tmpl->FileName));
1578 FreeWCTemplate(pTmpl);
1584 pS = pData = ChrPtr(pTmpl->Data);
1585 len = StrLength(pTmpl->Data);
1589 if (i >= pTmpl->nTokensUsed) {
1590 StrBufAppendBufPlain(Target,
1592 len - (pData - pS), 0);
1596 StrBufAppendBufPlain(
1598 pTmpl->Tokens[i]->pTokenStart - pData, 0);
1599 TP.Tokens = pTmpl->Tokens[i];
1600 TP.nArgs = pTmpl->Tokens[i]->nParameters;
1601 state = EvaluateToken(Target, state, &TP);
1603 while ((state != 0) && (i+1 < pTmpl->nTokensUsed)) {
1604 /* condition told us to skip till its end condition */
1606 TP.Tokens = pTmpl->Tokens[i];
1607 TP.nArgs = pTmpl->Tokens[i]->nParameters;
1608 if ((pTmpl->Tokens[i]->Flags == SV_CONDITIONAL) ||
1609 (pTmpl->Tokens[i]->Flags == SV_NEG_CONDITIONAL)) {
1610 if (state == EvaluateConditional(
1612 pTmpl->Tokens[i]->Flags,
1618 pData = pTmpl->Tokens[i++]->pTokenEnd + 1;
1619 if (i > pTmpl->nTokensUsed)
1623 if (LoadTemplates != 0) {
1624 FreeWCTemplate(pTmpl);
1626 return Tmpl->MimeType;
1631 * \brief Display a variable-substituted template
1632 * \param templatename template file to load
1633 * \returns the mimetype of the template its doing
1635 const StrBuf *DoTemplate(const char *templatename, long len, StrBuf *Target, WCTemplputParams *TP)
1637 WCTemplputParams LocalTP;
1639 HashList *StaticLocal;
1645 memset(&LocalTP, 0, sizeof(WCTemplputParams));
1649 Static = TemplateCache;
1650 StaticLocal = LocalTemplateCache;
1654 syslog(1, "Can't to load a template with empty name!\n");
1655 StrBufAppendPrintf(Target, "<pre>\nCan't to load a template with empty name!\n</pre>");
1659 if (!GetHash(StaticLocal, templatename, len, &vTmpl) &&
1660 !GetHash(Static, templatename, len, &vTmpl)) {
1661 syslog(1, "didn't find Template [%s] %ld %ld\n", templatename, len , (long)strlen(templatename));
1662 StrBufAppendPrintf(Target, "<pre>\ndidn't find Template [%s] %ld %ld\n</pre>",
1664 (long)strlen(templatename));
1666 dbg_PrintHash(Static, PrintTemplate, NULL);
1667 PrintHash(Static, VarPrintTransition, PrintTemplate);
1673 return ProcessTemplate(vTmpl, Target, TP);
1678 void tmplput_Comment(StrBuf *Target, WCTemplputParams *TP)
1680 if (LoadTemplates != 0)
1686 GetTemplateTokenString(Target, TP, 0, &pch, &len);
1687 Comment = NewStrBufPlain(pch, len);
1688 StrBufAppendBufPlain(Target, HKEY("<!--"), 0);
1689 StrBufAppendTemplate(Target, TP, Comment, 1);
1690 StrBufAppendBufPlain(Target, HKEY("-->"), 0);
1691 FreeStrBuf(&Comment);
1695 /*-----------------------------------------------------------------------------
1698 typedef struct _HashIterator {
1699 HashList *StaticList;
1700 int AdditionalParams;
1702 int XPectContextType;
1704 RetrieveHashlistFunc GetHash;
1705 HashDestructorFunc Destructor;
1706 SubTemplFunc DoSubTemplate;
1709 void RegisterITERATOR(const char *Name, long len,
1710 int AdditionalParams,
1711 HashList *StaticList,
1712 RetrieveHashlistFunc GetHash,
1713 SubTemplFunc DoSubTempl,
1714 HashDestructorFunc Destructor,
1716 int XPectContextType,
1721 It = (HashIterator*)malloc(sizeof(HashIterator));
1722 memset(It, 0, sizeof(HashIterator));
1723 It->StaticList = StaticList;
1724 It->AdditionalParams = AdditionalParams;
1725 It->GetHash = GetHash;
1726 It->DoSubTemplate = DoSubTempl;
1727 It->Destructor = Destructor;
1728 It->ContextType = ContextType;
1729 It->XPectContextType = XPectContextType;
1731 Put(Iterators, Name, len, It, NULL);
1734 typedef struct _iteratestruct {
1743 int preeval_iterate(WCTemplateToken *Token)
1745 WCTemplputParams TPP;
1746 WCTemplputParams *TP;
1751 memset(&TPP, 0, sizeof(WCTemplputParams));
1754 if (!GetHash(Iterators, TKEY(0), &vIt)) {
1756 NULL, "Iterator", ERR_PARM1, TP,
1760 if (TP->Tokens->Params[1]->Type != TYPE_SUBTEMPLATE) {
1761 LogTemplateError(NULL, "Iterator", ERR_PARM1, TP,
1762 "Need token with type Subtemplate as param 1, have %s",
1763 TP->Tokens->Params[1]->Start);
1766 /* well, we don't check the mobile stuff here... */
1767 if (!GetHash(LocalTemplateCache, TKEY(1), &vTmpl) &&
1768 !GetHash(TemplateCache, TKEY(1), &vTmpl)) {
1769 LogTemplateError(NULL, "SubTemplate", ERR_PARM1, TP,
1770 "referenced here doesn't exist");
1772 Token->Preeval2 = vIt;
1773 It = (HashIterator *) vIt;
1775 if (TP->Tokens->nParameters < It->AdditionalParams + 2) {
1777 NULL, "Iterator", ERR_PARM1, TP,
1778 "doesn't work with %d params",
1779 TP->Tokens->nParameters);
1786 void tmpl_iterate_subtmpl(StrBuf *Target, WCTemplputParams *TP)
1791 SortStruct *SortBy = NULL;
1793 int DetectGroupChange = 0;
1796 void *vLastContext = NULL;
1798 WCTemplputParams SubTP;
1799 IterateStruct Status;
1805 memset(&Status, 0, sizeof(IterateStruct));
1806 memcpy (&SubTP, &TP, sizeof(WCTemplputParams));
1808 It = (HashIterator*) TP->Tokens->Preeval2;
1811 Target, "Iterator", ERR_PARM1, TP, "Unknown!");
1815 if (TP->Tokens->nParameters < It->AdditionalParams + 2) {
1817 Target, "Iterator", ERR_PARM1, TP,
1818 "doesn't work with %d params",
1819 TP->Tokens->nParameters - 1);
1823 if ((It->XPectContextType != CTX_NONE) &&
1824 (It->XPectContextType != TP->Filter.ContextType)) {
1826 Target, "Iterator", ERR_PARM1, TP,
1827 "requires context of type %s, have %s",
1828 ContextName(It->XPectContextType),
1829 ContextName(TP->Filter.ContextType));
1834 if (It->StaticList == NULL)
1835 List = It->GetHash(Target, TP);
1837 List = It->StaticList;
1839 DetectGroupChange = (It->Flags & IT_FLAG_DETECT_GROUPCHANGE) != 0;
1840 if (DetectGroupChange) {
1841 const StrBuf *BSort;
1842 DetectGroupChange = 0;
1843 if (havebstr("SortBy")) {
1844 BSort = sbstr("SortBy");
1845 if (GetHash(SortHash, SKEY(BSort), &vSortBy) &&
1846 (vSortBy != NULL)) {
1847 SortBy = (SortStruct*)vSortBy;
1848 /* first check whether its intended for us... */
1849 if ((SortBy->ContextType == It->ContextType)&&
1850 /** Ok, its us, lets see in which direction we should sort... */
1851 (havebstr("SortOrder"))) {
1853 SortOrder = LBSTR("SortOrder");
1855 DetectGroupChange = 1;
1860 nMembersUsed = GetCount(List);
1861 SubBuf = NewStrBuf();
1862 SubTP.Filter.ContextType = It->ContextType;
1863 SubTP.Filter.ControlContextType = CTX_ITERATE;
1864 SubTP.ControlContext = &Status;
1866 if (HAVE_PARAM(2)) {
1867 StartAt = GetTemplateTokenNumber(Target, TP, 2, 0);
1869 if (HAVE_PARAM(3)) {
1870 StepWidth = GetTemplateTokenNumber(Target, TP, 3, 0);
1872 if (HAVE_PARAM(4)) {
1873 StopAt = GetTemplateTokenNumber(Target, TP, 4, -1);
1875 it = GetNewHashPos(List, StepWidth);
1877 StopAt = GetCount(List);
1879 while (GetNextHashPos(List, it, &Status.KeyLen, &Status.Key, &vContext)) {
1880 if ((Status.n >= StartAt) && (Status.n <= StopAt)) {
1881 if (DetectGroupChange && Status.n > 0) {
1882 Status.GroupChange = SortBy->GroupChange(vContext, vLastContext);
1884 Status.LastN = (Status.n + 1) == nMembersUsed;
1885 SubTP.Context = vContext;
1886 if (It->DoSubTemplate != NULL)
1887 It->DoSubTemplate(SubBuf, &SubTP);
1888 DoTemplate(TKEY(1), SubBuf, &SubTP);
1890 StrBufAppendBuf(Target, SubBuf, 0);
1891 FlushStrBuf(SubBuf);
1892 Status.oddeven = ! Status.oddeven;
1893 vLastContext = vContext;
1897 FreeStrBuf(&SubBuf);
1899 if (It->Destructor != NULL)
1900 It->Destructor(&List);
1904 int conditional_ITERATE_ISGROUPCHANGE(StrBuf *Target, WCTemplputParams *TP)
1906 IterateStruct *Ctx = CCTX;
1907 if (TP->Tokens->nParameters < 3)
1908 return Ctx->GroupChange;
1910 return TP->Tokens->Params[2]->lvalue == Ctx->GroupChange;
1913 void tmplput_ITERATE_ODDEVEN(StrBuf *Target, WCTemplputParams *TP)
1915 IterateStruct *Ctx = CCTX;
1917 StrBufAppendBufPlain(Target, HKEY("odd"), 0);
1919 StrBufAppendBufPlain(Target, HKEY("even"), 0);
1923 void tmplput_ITERATE_KEY(StrBuf *Target, WCTemplputParams *TP)
1925 IterateStruct *Ctx = CCTX;
1927 StrBufAppendBufPlain(Target, Ctx->Key, Ctx->KeyLen, 0);
1931 void tmplput_ITERATE_LASTN(StrBuf *Target, WCTemplputParams *TP)
1933 IterateStruct *Ctx = CCTX;
1934 StrBufAppendPrintf(Target, "%d", Ctx->n);
1937 int conditional_ITERATE_FIRSTN(StrBuf *Target, WCTemplputParams *TP)
1939 IterateStruct *Ctx = CCTX;
1943 int conditional_ITERATE_LASTN(StrBuf *Target, WCTemplputParams *TP)
1945 IterateStruct *Ctx = CCTX;
1951 /*-----------------------------------------------------------------------------
1954 int EvaluateConditional(StrBuf *Target, int Neg, int state, WCTemplputParams *TP)
1956 ConditionalStruct *Cond;
1960 if ((TP->Tokens->Params[0]->len == 1) &&
1961 (TP->Tokens->Params[0]->Start[0] == 'X'))
1962 return (state != 0)?TP->Tokens->Params[1]->lvalue:0;
1964 Cond = (ConditionalStruct *) TP->Tokens->PreEval;
1967 Target, "Conditional", ERR_PARM1, TP,
1972 if (!CheckContext(Target, &Cond->Filter, TP, "Conditional")) {
1975 res = Cond->CondF(Target, TP);
1977 rc = TP->Tokens->Params[1]->lvalue;
1978 if (LoadTemplates > 5)
1979 syslog(1, "<%s> : %d %d==%d\n",
1980 ChrPtr(TP->Tokens->FlatToken),
1985 void RegisterConditional(const char *Name, long len,
1987 WCConditionalFunc CondF,
1988 int ContextRequired)
1990 ConditionalStruct *Cond;
1992 Cond = (ConditionalStruct*)malloc(sizeof(ConditionalStruct));
1993 memset(Cond, 0, sizeof(ConditionalStruct));
1994 Cond->PlainName = Name;
1995 Cond->Filter.nMaxArgs = nParams;
1996 Cond->Filter.nMinArgs = nParams;
1997 Cond->CondF = CondF;
1998 Cond->Filter.ContextType = ContextRequired;
1999 Cond->Filter.ControlContextType = CTX_NONE;
2000 Put(Conditionals, Name, len, Cond, NULL);
2003 void RegisterControlConditional(const char *Name, long len,
2005 WCConditionalFunc CondF,
2006 int ControlContextRequired)
2008 ConditionalStruct *Cond;
2010 Cond = (ConditionalStruct*)malloc(sizeof(ConditionalStruct));
2011 memset(Cond, 0, sizeof(ConditionalStruct));
2012 Cond->PlainName = Name;
2013 Cond->Filter.nMaxArgs = nParams;
2014 Cond->Filter.nMinArgs = nParams;
2015 Cond->CondF = CondF;
2016 Cond->Filter.ContextType = CTX_NONE;
2017 Cond->Filter.ControlContextType = ControlContextRequired;
2018 Put(Conditionals, Name, len, Cond, NULL);
2021 void RegisterTokenParamDefine(const char *Name, long len,
2026 PVal = (long*)malloc(sizeof(long));
2028 Put(Defines, Name, len, PVal, NULL);
2031 long GetTokenDefine(const char *Name, long len,
2036 if (GetHash(Defines, Name, len, &vPVal) &&
2039 return *(long*) vPVal;
2047 void tmplput_DefStr(StrBuf *Target, WCTemplputParams *TP)
2051 GetTemplateTokenString(Target, TP, 2, &Str, &len);
2053 StrBufAppendBufPlain(Target, Str, len, 0);
2056 void tmplput_DefVal(StrBuf *Target, WCTemplputParams *TP)
2060 val = GetTemplateTokenNumber(Target, TP, 0, 0);
2061 StrBufAppendPrintf(Target, "%d", val);
2066 /*-----------------------------------------------------------------------------
2069 void tmplput_ContextString(StrBuf *Target, WCTemplputParams *TP)
2071 StrBufAppendTemplate(Target, TP, (StrBuf*)CTX, 0);
2073 int ConditionalContextStr(StrBuf *Target, WCTemplputParams *TP)
2075 StrBuf *TokenText = (StrBuf*) CTX;
2076 const char *CompareToken;
2079 GetTemplateTokenString(Target, TP, 2, &CompareToken, &len);
2080 return strcmp(ChrPtr(TokenText), CompareToken) == 0;
2083 void tmplput_ContextStringArray(StrBuf *Target, WCTemplputParams *TP)
2085 HashList *Arr = (HashList*) CTX;
2089 val = GetTemplateTokenNumber(Target, TP, 0, 0);
2090 if (GetHash(Arr, IKEY(val), &pV) &&
2092 StrBufAppendTemplate(Target, TP, (StrBuf*)pV, 1);
2095 int ConditionalContextStrinArray(StrBuf *Target, WCTemplputParams *TP)
2097 HashList *Arr = (HashList*) CTX;
2100 const char *CompareToken;
2103 GetTemplateTokenString(Target, TP, 2, &CompareToken, &len);
2104 val = GetTemplateTokenNumber(Target, TP, 0, 0);
2105 if (GetHash(Arr, IKEY(val), &pV) &&
2107 return strcmp(ChrPtr((StrBuf*)pV), CompareToken) == 0;
2113 /*-----------------------------------------------------------------------------
2117 void tmpl_do_boxed(StrBuf *Target, WCTemplputParams *TP)
2119 WCTemplputParams SubTP;
2121 StrBuf *Headline = NULL;
2122 if (TP->Tokens->nParameters == 2) {
2123 if (TP->Tokens->Params[1]->Type == TYPE_STR) {
2124 Headline = NewStrBuf();
2125 DoTemplate(TKEY(1), Headline, TP);
2130 GetTemplateTokenString(Target,
2135 Headline = NewStrBufPlain(Ch, len);
2138 /* else TODO error? logging? */
2139 memcpy (&SubTP, TP, sizeof(WCTemplputParams));
2140 SubTP.Context = Headline;
2141 SubTP.Filter.ContextType = CTX_STRBUF;
2142 DoTemplate(HKEY("box_begin"), Target, &SubTP);
2143 DoTemplate(TKEY(0), Target, TP);
2144 DoTemplate(HKEY("box_end"), Target, TP);
2145 FreeStrBuf(&Headline);
2148 /*-----------------------------------------------------------------------------
2152 typedef struct _tab_struct {
2157 int preeval_do_tabbed(WCTemplateToken *Token)
2159 WCTemplputParams TPP;
2160 WCTemplputParams *TP;
2166 memset(&TPP, 0, sizeof(WCTemplputParams));
2169 nTabs = TP->Tokens->nParameters / 2 - 1;
2170 if (TP->Tokens->nParameters % 2 != 0)
2172 LogTemplateError(NULL, "TabbedApi", ERR_PARM1, TP,
2173 "need even number of arguments");
2177 else for (i = 0; i < nTabs; i++) {
2178 if (!HaveTemplateTokenString(NULL,
2183 (TP->Tokens->Params[i * 2]->len == 0))
2185 LogTemplateError(NULL, "TabbedApi", ERR_PARM1, TP,
2186 "Tab-Subject %d needs to be able to produce a string, have %s",
2187 i, TP->Tokens->Params[i * 2]->Start);
2190 if (!HaveTemplateTokenString(NULL,
2195 (TP->Tokens->Params[i * 2 + 1]->len == 0))
2197 LogTemplateError(NULL, "TabbedApi", ERR_PARM1, TP,
2198 "Tab-Content %d needs to be able to produce a string, have %s",
2199 i, TP->Tokens->Params[i * 2 + 1]->Start);
2204 if (!HaveTemplateTokenString(NULL,
2209 (TP->Tokens->Params[i * 2 + 1]->len == 0))
2211 LogTemplateError(NULL, "TabbedApi", ERR_PARM1, TP,
2212 "Tab-Content %d needs to be able to produce a string, have %s",
2213 i, TP->Tokens->Params[i * 2 + 1]->Start);
2220 void tmpl_do_tabbed(StrBuf *Target, WCTemplputParams *TP)
2223 int i, ntabs, nTabs;
2225 WCTemplputParams SubTP;
2227 memset(&TS, 0, sizeof(tab_struct));
2228 memcpy (&SubTP, &TP, sizeof(WCTemplputParams));
2230 nTabs = ntabs = TP->Tokens->nParameters / 2;
2231 TabNames = (StrBuf **) malloc(ntabs * sizeof(StrBuf*));
2232 memset(TabNames, 0, ntabs * sizeof(StrBuf*));
2234 for (i = 0; i < ntabs; i++) {
2235 if ((TP->Tokens->Params[i * 2]->Type == TYPE_STR) &&
2236 (TP->Tokens->Params[i * 2]->len > 0)) {
2237 TabNames[i] = NewStrBuf();
2238 DoTemplate(TKEY(i * 2), TabNames[i], TP);
2240 else if (TP->Tokens->Params[i * 2]->Type == TYPE_GETTEXT) {
2243 GetTemplateTokenString(Target,
2248 TabNames[i] = NewStrBufPlain(Ch, -1);
2251 /** A Tab without subject? we can't count that, add it as silent */
2255 memcpy (&SubTP, TP, sizeof(WCTemplputParams));
2256 SubTP.Filter.ControlContextType = CTX_TAB;
2257 SubTP.ControlContext = &TS;
2259 StrTabbedDialog(Target, nTabs, TabNames);
2260 for (i = 0; i < ntabs; i++) {
2261 memset(&TS, 0, sizeof(tab_struct));
2263 TS.TabTitle = TabNames[i];
2264 StrBeginTab(Target, i, nTabs, TabNames);
2265 DoTemplate(TKEY(i * 2 + 1), Target, &SubTP);
2266 StrEndTab(Target, i, nTabs);
2268 for (i = 0; i < ntabs; i++)
2269 FreeStrBuf(&TabNames[i]);
2272 void tmplput_TAB_N(StrBuf *Target, WCTemplputParams *TP)
2274 tab_struct *Ctx = CCTX;
2276 StrBufAppendPrintf(Target, "%d", Ctx->CurrentTab);
2279 void tmplput_TAB_TITLE(StrBuf *Target, WCTemplputParams *TP)
2281 tab_struct *Ctx = CCTX;
2282 StrBufAppendTemplate(Target, TP, Ctx->TabTitle, 0);
2285 /*-----------------------------------------------------------------------------
2290 void RegisterSortFunc(const char *name, long len,
2291 const char *prepend, long preplen,
2292 CompareFunc Forward,
2293 CompareFunc Reverse,
2294 CompareFunc GroupChange,
2297 SortStruct *NewSort;
2299 NewSort = (SortStruct*) malloc(sizeof(SortStruct));
2300 memset(NewSort, 0, sizeof(SortStruct));
2301 NewSort->Name = NewStrBufPlain(name, len);
2302 if (prepend != NULL)
2303 NewSort->PrefPrepend = NewStrBufPlain(prepend, preplen);
2305 NewSort->PrefPrepend = NULL;
2306 NewSort->Forward = Forward;
2307 NewSort->Reverse = Reverse;
2308 NewSort->GroupChange = GroupChange;
2309 NewSort->ContextType = ContextType;
2310 if (ContextType == CTX_NONE) {
2311 syslog(1, "sorting requires a context. CTX_NONE won't make it.\n");
2315 Put(SortHash, name, len, NewSort, DestroySortStruct);
2318 CompareFunc RetrieveSort(WCTemplputParams *TP,
2319 const char *OtherPrefix, long OtherPrefixLen,
2320 const char *Default, long ldefault, long DefaultDirection)
2322 const StrBuf *BSort = NULL;
2325 long SortOrder = -1;
2327 if (havebstr("SortBy")) {
2328 BSort = sbstr("SortBy");
2329 if (OtherPrefix == NULL) {
2330 set_room_pref("sort", NewStrBufDup(BSort), 0);
2333 set_X_PREFS(HKEY("sort"), OtherPrefix, OtherPrefixLen, NewStrBufDup(BSort), 0);
2336 else { /** Try to fallback to our remembered values... */
2337 if (OtherPrefix == NULL) {
2338 BSort = get_room_pref("sort");
2341 BSort = get_X_PREFS(HKEY("sort"), OtherPrefix, OtherPrefixLen);
2344 putbstr("SortBy", NewStrBufDup(BSort));
2348 BSort = Buf = NewStrBufPlain(Default, ldefault);
2349 putbstr("SortBy", Buf);
2353 if (!GetHash(SortHash, SKEY(BSort), &vSortBy) ||
2354 (vSortBy == NULL)) {
2355 if (!GetHash(SortHash, Default, ldefault, &vSortBy) ||
2356 (vSortBy == NULL)) {
2358 NULL, "Sorting", ERR_PARM1, TP,
2359 "Illegal default sort: [%s]", Default);
2363 SortBy = (SortStruct*)vSortBy;
2365 if (SortBy->ContextType != TP->Filter.ContextType)
2368 /** Ok, its us, lets see in which direction we should sort... */
2369 if (havebstr("SortOrder")) {
2370 SortOrder = LBSTR("SortOrder");
2372 else { /** Try to fallback to our remembered values... */
2374 if (SortBy->PrefPrepend == NULL) {
2375 Buf = get_room_pref("SortOrder");
2376 SortOrder = StrTol(Buf);
2379 BSort = get_X_PREFS(HKEY("SortOrder"), OtherPrefix, OtherPrefixLen);
2383 SortOrder = DefaultDirection;
2385 Buf = NewStrBufPlain(NULL, 64);
2386 StrBufPrintf(Buf, "%ld", SortOrder);
2387 putbstr("SortOrder", Buf);
2389 switch (SortOrder) {
2394 return SortBy->Forward;
2396 return SortBy->Reverse;
2408 ConstStr SortIcons[] = {
2409 {HKEY("static/webcit_icons/sort_none.gif")},
2410 {HKEY("static/webcit_icons/up_pointer.gif")},
2411 {HKEY("static/webcit_icons/down_pointer.gif")},
2414 ConstStr SortNextOrder[] = {
2421 int GetSortMetric(WCTemplputParams *TP, SortStruct **Next, SortStruct **Param, long *SortOrder, int N)
2423 int bSortError = eNOT_SPECIFIED;
2424 const StrBuf *BSort;
2429 if (!GetHash(SortHash, TKEY(0), &vSort) ||
2431 return eNO_SUCH_SORT;
2432 *Param = (SortStruct*) vSort;
2435 if (havebstr("SortBy")) {
2436 BSort = sbstr("SortBy");
2437 bSortError = eINVALID_PARAM;
2438 if ((*Param)->PrefPrepend == NULL) {
2439 set_room_pref("sort", NewStrBufDup(BSort), 0);
2442 set_X_PREFS(HKEY("sort"), TKEY(N), NewStrBufDup(BSort), 0);
2445 else { /** Try to fallback to our remembered values... */
2446 if ((*Param)->PrefPrepend == NULL) {
2447 BSort = get_room_pref("sort");
2450 BSort = get_X_PREFS(HKEY("sort"), TKEY(N));
2454 if (!GetHash(SortHash, SKEY(BSort), &vSort) ||
2458 *Next = (SortStruct*) vSort;
2460 /** Ok, its us, lets see in which direction we should sort... */
2461 if (havebstr("SortOrder")) {
2462 *SortOrder = LBSTR("SortOrder");
2464 else { /** Try to fallback to our remembered values... */
2465 if ((*Param)->PrefPrepend == NULL) {
2466 *SortOrder = StrTol(get_room_pref("SortOrder"));
2469 *SortOrder = StrTol(get_X_PREFS(HKEY("SortOrder"), TKEY(N)));
2479 void tmplput_SORT_ICON(StrBuf *Target, WCTemplputParams *TP)
2484 const ConstStr *SortIcon;
2486 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2489 Target, "Sorter", ERR_PARM1, TP,
2490 " Sorter [%s] unknown!",
2491 TP->Tokens->Params[0]->Start);
2493 case eINVALID_PARAM:
2494 LogTemplateError(NULL, "Sorter", ERR_PARM1, TP,
2495 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2497 case eNOT_SPECIFIED:
2499 if (Next == Param) {
2500 SortIcon = &SortIcons[SortOrder];
2502 else { /** Not Us... */
2503 SortIcon = &SortIcons[0];
2505 StrBufAppendBufPlain(Target, SortIcon->Key, SortIcon->len, 0);
2509 void tmplput_SORT_NEXT(StrBuf *Target, WCTemplputParams *TP)
2515 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2518 Target, "Sorter", ERR_PARM1, TP,
2519 " Sorter [%s] unknown!",
2520 TP->Tokens->Params[0]->Start);
2522 case eINVALID_PARAM:
2524 NULL, "Sorter", ERR_PARM1, TP,
2525 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2527 case eNOT_SPECIFIED:
2529 StrBufAppendBuf(Target, Param->Name, 0);
2534 void tmplput_SORT_ORDER(StrBuf *Target, WCTemplputParams *TP)
2537 const ConstStr *SortOrderStr;
2541 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2544 Target, "Sorter", ERR_PARM1, TP,
2545 " Sorter [%s] unknown!",
2546 TP->Tokens->Params[0]->Start);
2548 case eINVALID_PARAM:
2550 NULL, "Sorter", ERR_PARM1, TP,
2551 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2553 case eNOT_SPECIFIED:
2555 if (Next == Param) {
2556 SortOrderStr = &SortNextOrder[SortOrder];
2558 else { /** Not Us... */
2559 SortOrderStr = &SortNextOrder[0];
2561 StrBufAppendBufPlain(Target, SortOrderStr->Key, SortOrderStr->len, 0);
2566 void tmplput_long_vector(StrBuf *Target, WCTemplputParams *TP)
2568 long *LongVector = (long*) CTX;
2570 if ((TP->Tokens->Params[0]->Type == TYPE_LONG) &&
2571 (TP->Tokens->Params[0]->lvalue <= LongVector[0]))
2573 StrBufAppendPrintf(Target, "%ld", LongVector[TP->Tokens->Params[0]->lvalue]);
2577 if (TP->Tokens->Params[0]->Type != TYPE_LONG) {
2579 Target, "Longvector", ERR_NAME, TP,
2580 "needs a numerical Parameter!");
2584 Target, "LongVector", ERR_PARM1, TP,
2585 "doesn't have %ld Parameters, its just the size of %ld!",
2586 TP->Tokens->Params[0]->lvalue,
2592 void dbg_print_longvector(long *LongVector)
2594 StrBuf *Buf = NewStrBufPlain(HKEY("Longvector: ["));
2595 int nItems = LongVector[0];
2598 for (i = 0; i < nItems; i++) {
2600 StrBufAppendPrintf(Buf, "%d: %ld | ", i, LongVector[i]);
2602 StrBufAppendPrintf(Buf, "%d: %ld]\n", i, LongVector[i]);
2605 syslog(1, "%s", ChrPtr(Buf));
2609 int ConditionalLongVector(StrBuf *Target, WCTemplputParams *TP)
2611 long *LongVector = (long*) CTX;
2613 if ((TP->Tokens->Params[2]->Type == TYPE_LONG) &&
2614 (TP->Tokens->Params[2]->lvalue <= LongVector[0])&&
2615 (TP->Tokens->Params[3]->Type == TYPE_LONG) &&
2616 (TP->Tokens->Params[3]->lvalue <= LongVector[0]))
2618 return LongVector[TP->Tokens->Params[2]->lvalue] ==
2619 LongVector[TP->Tokens->Params[3]->lvalue];
2623 if ((TP->Tokens->Params[2]->Type == TYPE_LONG) ||
2624 (TP->Tokens->Params[2]->Type == TYPE_LONG)) {
2626 Target, "ConditionalLongvector", ERR_PARM1, TP,
2627 "needs two long Parameter!");
2631 Target, "Longvector", ERR_PARM1, TP,
2632 "doesn't have %ld / %ld Parameters, its just the size of %ld!",
2633 TP->Tokens->Params[2]->lvalue,
2634 TP->Tokens->Params[3]->lvalue,
2642 void tmplput_CURRENT_FILE(StrBuf *Target, WCTemplputParams *TP)
2644 StrBufAppendTemplate(Target, TP, TP->Tokens->FileName, 0);
2651 memset(&NoCtx, 0, sizeof(WCTemplputParams));
2652 RegisterNamespace("--", 0, 2, tmplput_Comment, NULL, CTX_NONE);
2653 RegisterNamespace("SORT:ICON", 1, 2, tmplput_SORT_ICON, NULL, CTX_NONE);
2654 RegisterNamespace("SORT:ORDER", 1, 2, tmplput_SORT_ORDER, NULL, CTX_NONE);
2655 RegisterNamespace("SORT:NEXT", 1, 2, tmplput_SORT_NEXT, NULL, CTX_NONE);
2656 RegisterNamespace("CONTEXTSTR", 0, 1, tmplput_ContextString, NULL, CTX_STRBUF);
2657 RegisterNamespace("CONTEXTSTRARR", 1, 2, tmplput_ContextStringArray, NULL, CTX_STRBUFARR);
2658 RegisterNamespace("ITERATE", 2, 100, tmpl_iterate_subtmpl, preeval_iterate, CTX_NONE);
2659 RegisterNamespace("DOBOXED", 1, 2, tmpl_do_boxed, NULL, CTX_NONE);
2660 RegisterNamespace("DOTABBED", 2, 100, tmpl_do_tabbed, preeval_do_tabbed, CTX_NONE);
2661 RegisterControlNS(HKEY("TAB:N"), 0, 0, tmplput_TAB_N, CTX_TAB);
2662 RegisterControlNS(HKEY("TAB:SUBJECT"), 0, 1, tmplput_TAB_TITLE, CTX_TAB);
2665 RegisterNamespace("LONGVECTOR", 1, 1, tmplput_long_vector, NULL, CTX_LONGVECTOR);
2668 RegisterConditional(HKEY("COND:CONTEXTSTR"), 3, ConditionalContextStr, CTX_STRBUF);
2669 RegisterConditional(HKEY("COND:CONTEXTSTRARR"), 4, ConditionalContextStrinArray, CTX_STRBUFARR);
2670 RegisterConditional(HKEY("COND:LONGVECTOR"), 4, ConditionalLongVector, CTX_LONGVECTOR);
2673 RegisterControlConditional(HKEY("COND:ITERATE:ISGROUPCHANGE"), 2,
2674 conditional_ITERATE_ISGROUPCHANGE,
2676 RegisterControlConditional(HKEY("COND:ITERATE:LASTN"), 2,
2677 conditional_ITERATE_LASTN,
2679 RegisterControlConditional(HKEY("COND:ITERATE:FIRSTN"), 2,
2680 conditional_ITERATE_FIRSTN,
2683 RegisterControlNS(HKEY("ITERATE:ODDEVEN"), 0, 0, tmplput_ITERATE_ODDEVEN, CTX_ITERATE);
2684 RegisterControlNS(HKEY("ITERATE:KEY"), 0, 0, tmplput_ITERATE_KEY, CTX_ITERATE);
2685 RegisterControlNS(HKEY("ITERATE:N"), 0, 0, tmplput_ITERATE_LASTN, CTX_ITERATE);
2686 RegisterNamespace("CURRENTFILE", 0, 1, tmplput_CURRENT_FILE, NULL, CTX_NONE);
2687 RegisterNamespace("DEF:STR", 1, 1, tmplput_DefStr, NULL, CTX_NONE);
2688 RegisterNamespace("DEF:VAL", 1, 1, tmplput_DefVal, NULL, CTX_NONE);
2696 ServerStartModule_SUBST
2699 LocalTemplateCache = NewHash(1, NULL);
2700 TemplateCache = NewHash(1, NULL);
2702 GlobalNS = NewHash(1, NULL);
2703 Iterators = NewHash(1, NULL);
2704 Conditionals = NewHash(1, NULL);
2705 SortHash = NewHash(1, NULL);
2706 Defines = NewHash(1, NULL);
2710 FinalizeModule_SUBST
2717 ServerShutdownModule_SUBST
2720 DeleteHash(&TemplateCache);
2721 DeleteHash(&LocalTemplateCache);
2723 DeleteHash(&GlobalNS);
2724 DeleteHash(&Iterators);
2725 DeleteHash(&Conditionals);
2726 DeleteHash(&SortHash);
2727 DeleteHash(&Defines);
2732 SessionNewModule_SUBST
2739 SessionAttachModule_SUBST
2745 SessionDetachModule_SUBST
2748 FreeStrBuf(&sess->WFBuf);
2752 SessionDestroyModule_SUBST