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 pch = NewToken->pName;
1020 while (pch < NewToken->pName + NewToken->NameEnd)
1022 if (((*pch >= 'A') && (*pch <= 'Z')) ||
1023 ((*pch >= '0') && (*pch <= '9')) ||
1031 NULL, "Token Name", ERR_NAME, &TP,
1032 "contains illegal char: '%c'",
1038 if (GetHash(GlobalNS, NewToken->pName, NewToken->NameEnd, &vVar)) {
1039 HashHandler *Handler;
1040 Handler = (HashHandler*) vVar;
1041 if ((NewToken->nParameters < Handler->Filter.nMinArgs) ||
1042 (NewToken->nParameters > Handler->Filter.nMaxArgs)) {
1044 NULL, "Token", ERR_NAME, &TP,
1045 "doesn't work with %d params",
1046 NewToken->nParameters);
1050 NewToken->PreEval = Handler;
1051 NewToken->Flags = SV_PREEVALUATED;
1052 if (Handler->PreEvalFunc != NULL)
1053 Handler->PreEvalFunc(NewToken);
1058 if (NewToken->nParameters !=1) {
1060 NULL, "Gettext", ERR_NAME, &TP,
1061 "requires exactly 1 parameter, you gave %d params",
1062 NewToken->nParameters);
1063 NewToken->Flags = 0;
1066 if (DumpTemplateI18NStrings) {
1067 StrBufAppendPrintf(I18nDump, "_(\"%s\");\n", NewToken->Params[0]->Start);
1071 if (NewToken->nParameters != 1) {
1073 NULL, "Subtemplates", ERR_NAME, &TP,
1074 "require exactly 1 parameter, you gave %d params",
1075 NewToken->nParameters);
1080 /* well, we don't check the mobile stuff here... */
1081 if (!GetHash(LocalTemplateCache,
1082 NewToken->Params[0]->Start,
1083 NewToken->Params[0]->len,
1085 !GetHash(TemplateCache,
1086 NewToken->Params[0]->Start,
1087 NewToken->Params[0]->len,
1090 NULL, "SubTemplate", ERR_PARM1, &TP,
1095 case SV_CUST_STR_CONDITIONAL:
1096 case SV_CONDITIONAL:
1097 case SV_NEG_CONDITIONAL:
1098 if (NewToken->nParameters <2) {
1100 NULL, "Conditional", ERR_PARM1, &TP,
1101 "require at least 2 parameters, you gave %d params",
1102 NewToken->nParameters);
1103 NewToken->Flags = 0;
1106 if (NewToken->Params[1]->lvalue == 0) {
1108 NULL, "Conditional", ERR_PARM1, &TP,
1109 "Conditional ID (Parameter 1) mustn't be 0!");
1110 NewToken->Flags = 0;
1113 if (!GetHash(Conditionals,
1114 NewToken->Params[0]->Start,
1115 NewToken->Params[0]->len,
1118 if ((NewToken->Params[0]->len == 1) &&
1119 (NewToken->Params[0]->Start[0] == 'X'))
1122 NULL, "Conditional", ERR_PARM1, &TP,
1125 NewToken->Error = NewStrBuf();
1128 "<pre>\nConditional [%s] (in '%s' line %ld); Not found!\n[%s]\n</pre>\n",
1129 NewToken->Params[0]->Start,
1130 ChrPtr(pTmpl->FileName),
1132 ChrPtr(NewToken->FlatToken));
1136 NewToken->PreEval = vVar;
1148 * \brief Display a variable-substituted template
1149 * \param templatename template file to load
1151 void *prepare_template(StrBuf *filename, StrBuf *Key, HashList *PutThere)
1153 WCTemplate *NewTemplate;
1155 NewTemplate = (WCTemplate *) malloc(sizeof(WCTemplate));
1156 memset(NewTemplate, 0, sizeof(WCTemplate));
1157 NewTemplate->Data = NULL;
1158 NewTemplate->FileName = NewStrBufDup(filename);
1159 StrBufShrinkToFit(NewTemplate->FileName, 1);
1160 NewTemplate->nTokensUsed = 0;
1161 NewTemplate->TokenSpace = 0;
1162 NewTemplate->Tokens = NULL;
1163 NewTemplate->MimeType = NewStrBufPlain(GuessMimeByFilename (SKEY(NewTemplate->FileName)), -1);
1164 if (strstr(ChrPtr(NewTemplate->MimeType), "text") != NULL) {
1165 StrBufAppendBufPlain(NewTemplate->MimeType, HKEY("; charset=utf-8"), 0);
1168 if (strstr(ChrPtr(NewTemplate->MimeType), "text") != NULL) {
1169 StrBufAppendBufPlain(NewTemplate->MimeType, HKEY("; charset=utf-8"), 0);
1172 Put(PutThere, ChrPtr(Key), StrLength(Key), NewTemplate, FreeWCTemplate);
1177 * \brief Display a variable-substituted template
1178 * \param templatename template file to load
1180 void *duplicate_template(WCTemplate *OldTemplate)
1182 WCTemplate *NewTemplate;
1184 NewTemplate = (WCTemplate *) malloc(sizeof(WCTemplate));
1185 memset(NewTemplate, 0, sizeof(WCTemplate));
1186 NewTemplate->Data = NULL;
1187 NewTemplate->FileName = NewStrBufDup(OldTemplate->FileName);
1188 StrBufShrinkToFit(NewTemplate->FileName, 1);
1189 NewTemplate->nTokensUsed = 0;
1190 NewTemplate->TokenSpace = 0;
1191 NewTemplate->Tokens = NULL;
1192 NewTemplate->MimeType = NewStrBufDup(OldTemplate->MimeType);
1197 * \brief Display a variable-substituted template
1198 * \param templatename template file to load
1200 void *load_template(WCTemplate *NewTemplate)
1203 struct stat statbuf;
1204 const char *pS, *pE, *pch, *Err;
1207 fd = open(ChrPtr(NewTemplate->FileName), O_RDONLY);
1209 syslog(1, "ERROR: could not open template '%s' - %s\n",
1210 ChrPtr(NewTemplate->FileName), strerror(errno));
1214 if (fstat(fd, &statbuf) == -1) {
1215 syslog(1, "ERROR: could not stat template '%s' - %s\n",
1216 ChrPtr(NewTemplate->FileName), strerror(errno));
1220 NewTemplate->Data = NewStrBufPlain(NULL, statbuf.st_size + 1);
1221 if (StrBufReadBLOB(NewTemplate->Data, &fd, 1, statbuf.st_size, &Err) < 0) {
1223 syslog(1, "ERROR: reading template '%s' - %s<br>\n",
1224 ChrPtr(NewTemplate->FileName), strerror(errno));
1230 StrBufShrinkToFit(NewTemplate->Data, 1);
1231 StrBufShrinkToFit(NewTemplate->MimeType, 1);
1232 pS = pch = ChrPtr(NewTemplate->Data);
1233 pE = pS + StrLength(NewTemplate->Data);
1235 const char *pts, *pte;
1236 char InQuotes = '\0';
1239 /** Find one <? > */
1240 for (; pch < pE; pch ++) {
1241 if ((*pch=='<')&&(*(pch + 1)=='?') &&
1242 !((pch == pS) && /* we must ommit a <?xml */
1243 (*(pch + 2) == 'x') &&
1244 (*(pch + 3) == 'm') &&
1245 (*(pch + 4) == 'l')))
1247 if (*pch=='\n') Line ++;
1253 /** Found one? parse it. */
1254 for (; pch <= pE - 1; pch ++) {
1256 ((*pch == '\'') || (*pch == '"')))
1260 else if (InQuotes && (InQuotes == *pch))
1264 else if ((InQuotes) &&
1266 (*(pch + 1) == InQuotes))
1270 else if ((!InQuotes) &&
1279 pv = NewTemplateSubstitute(NewTemplate->Data, pS, pts, pte, Line, NewTemplate);
1281 PutNewToken(NewTemplate, pv);
1289 const char* PrintTemplate(void *vSubst)
1291 WCTemplate *Tmpl = vSubst;
1293 return ChrPtr(Tmpl->FileName);
1297 int LoadTemplateDir(const StrBuf *DirName, HashList *big, const StrBuf *BaseKey)
1303 StrBuf *SubDirectory;
1304 DIR *filedir = NULL;
1305 struct dirent *filedir_entry;
1311 d = (struct dirent *)malloc(offsetof(struct dirent, d_name) + PATH_MAX + 1);
1316 filedir = opendir (ChrPtr(DirName));
1317 if (filedir == NULL) {
1322 Toplevel = StrLength(BaseKey) == 0;
1323 SubDirectory = NewStrBuf();
1324 SubKey = NewStrBuf();
1325 FileName = NewStrBufPlain(NULL, PATH_MAX);
1327 while ((readdir_r(filedir, d, &filedir_entry) == 0) &&
1328 (filedir_entry != NULL))
1332 #ifdef _DIRENT_HAVE_D_NAMELEN
1333 d_namelen = filedir_entry->d_namelen;
1334 d_type = filedir_entry->d_type;
1338 #define DT_UNKNOWN 0
1343 #define IFTODT(mode) (((mode) & 0170000) >> 12)
1344 #define DTTOIF(dirtype) ((dirtype) << 12)
1346 d_namelen = strlen(filedir_entry->d_name);
1347 d_type = DT_UNKNOWN;
1349 d_without_ext = d_namelen;
1351 if ((d_namelen > 1) && filedir_entry->d_name[d_namelen - 1] == '~')
1352 continue; /* Ignore backup files... */
1354 if ((d_namelen == 1) &&
1355 (filedir_entry->d_name[0] == '.'))
1358 if ((d_namelen == 2) &&
1359 (filedir_entry->d_name[0] == '.') &&
1360 (filedir_entry->d_name[1] == '.'))
1363 if (d_type == DT_UNKNOWN) {
1365 char path[PATH_MAX];
1366 snprintf(path, PATH_MAX, "%s/%s",
1367 ChrPtr(DirName), filedir_entry->d_name);
1368 if (stat(path, &s) == 0) {
1369 d_type = IFTODT(s.st_mode);
1375 /* Skip directories we are not interested in... */
1376 if (strcmp(filedir_entry->d_name, ".svn") == 0)
1379 FlushStrBuf(SubKey);
1381 /* If we're not toplevel, the upper dirs count as foo_bar_<local name>*/
1382 StrBufAppendBuf(SubKey, BaseKey, 0);
1383 StrBufAppendBufPlain(SubKey, HKEY("_"), 0);
1385 StrBufAppendBufPlain(SubKey, filedir_entry->d_name, d_namelen, 0);
1387 FlushStrBuf(SubDirectory);
1388 StrBufAppendBuf(SubDirectory, DirName, 0);
1389 if (ChrPtr(SubDirectory)[StrLength(SubDirectory) - 1] != '/')
1390 StrBufAppendBufPlain(SubDirectory, HKEY("/"), 0);
1391 StrBufAppendBufPlain(SubDirectory, filedir_entry->d_name, d_namelen, 0);
1393 LoadTemplateDir(SubDirectory, big, SubKey);
1396 case DT_LNK: /* TODO: check whether its a file or a directory */
1400 while ((d_without_ext > 0) && (filedir_entry->d_name[d_without_ext] != '.'))
1402 if ((d_without_ext == 0) || (d_namelen < 3))
1404 if (((d_namelen > 1) && filedir_entry->d_name[d_namelen - 1] == '~') ||
1405 (strcmp(&filedir_entry->d_name[d_without_ext], ".orig") == 0) ||
1406 (strcmp(&filedir_entry->d_name[d_without_ext], ".swp") == 0))
1407 continue; /* Ignore backup files... */
1408 StrBufPrintf(FileName, "%s/%s", ChrPtr(DirName), filedir_entry->d_name);
1409 MinorPtr = strchr(filedir_entry->d_name, '.');
1410 if (MinorPtr != NULL)
1414 /* If we're not toplevel, the upper dirs count as foo_bar_<local name>*/
1415 StrBufAppendBuf(Key, BaseKey, 0);
1416 StrBufAppendBufPlain(Key, HKEY("_"), 0);
1418 StrBufAppendBufPlain(Key, filedir_entry->d_name, MinorPtr - filedir_entry->d_name, 0);
1420 if (LoadTemplates >= 1)
1421 syslog(1, "%s %s\n", ChrPtr(FileName), ChrPtr(Key));
1422 prepare_template(FileName, Key, big);
1429 FreeStrBuf(&FileName);
1431 FreeStrBuf(&SubDirectory);
1432 FreeStrBuf(&SubKey);
1436 void InitTemplateCache(void)
1441 HashList *Templates[2];
1446 /* Primary Template set... */
1447 StrBufPrintf(Dir, "%s/t", static_dirs[0]);
1448 LoadTemplateDir(Dir,
1452 /* User local Template set */
1453 StrBufPrintf(Dir, "%s/t", static_dirs[1]);
1454 LoadTemplateDir(Dir,
1458 /* Debug Templates, just to be loaded while debugging. */
1460 StrBufPrintf(Dir, "%s/dbg", static_dirs[0]);
1461 LoadTemplateDir(Dir,
1464 Templates[0] = TemplateCache;
1465 Templates[1] = LocalTemplateCache;
1468 if (LoadTemplates == 0)
1469 for (i=0; i < 2; i++) {
1475 At = GetNewHashPos(Templates[i], 0);
1476 while (GetNextHashPos(Templates[i],
1481 (vTemplate != NULL))
1483 load_template((WCTemplate *)vTemplate);
1495 /*-----------------------------------------------------------------------------
1496 * Filling & processing Templates
1499 * \brief executes one token
1500 * \param Target buffer to append to
1501 * \param Token da to process.
1502 * \param Template we're iterating
1503 * \param Context Contextpoointer to pass in
1504 * \param state are we in conditional state?
1505 * \param ContextType what type of information does context giv us?
1507 int EvaluateToken(StrBuf *Target, int state, WCTemplputParams *TP)
1509 const char *AppendMe;
1511 HashHandler *Handler;
1514 /* much output, since pName is not terminated...
1515 syslog(1,"Doing token: %s\n",Token->pName);
1518 switch (TP->Tokens->Flags) {
1520 TmplGettext(Target, TP);
1522 case SV_CONDITIONAL: /** Forward conditional evaluation */
1523 return EvaluateConditional(Target, 1, state, TP);
1525 case SV_NEG_CONDITIONAL: /** Reverse conditional evaluation */
1526 return EvaluateConditional(Target, 0, state, TP);
1528 case SV_CUST_STR_CONDITIONAL: /** Conditional put custom strings from params */
1529 if (TP->Tokens->nParameters >= 6) {
1530 if (EvaluateConditional(Target, 0, state, TP)) {
1531 GetTemplateTokenString(Target, TP, 5, &AppendMe, &AppendMeLen);
1532 StrBufAppendBufPlain(Target,
1538 GetTemplateTokenString(Target, TP, 4, &AppendMe, &AppendMeLen);
1539 StrBufAppendBufPlain(Target,
1547 Target, "Conditional", ERR_NAME, TP,
1548 "needs at least 6 Params!");
1552 if (TP->Tokens->nParameters == 1)
1553 DoTemplate(TKEY(0), Target, TP);
1555 case SV_PREEVALUATED:
1556 Handler = (HashHandler*) TP->Tokens->PreEval;
1557 if (!CheckContext(Target, &Handler->Filter, TP, "Token")) {
1560 Handler->HandlerFunc(Target, TP);
1563 if (GetHash(GlobalNS, TP->Tokens->pName, TP->Tokens->NameEnd, &vVar)) {
1564 Handler = (HashHandler*) vVar;
1565 if (!CheckContext(Target, &Handler->Filter, TP, "Token")) {
1569 Handler->HandlerFunc(Target, TP);
1574 Target, "Token UNKNOWN", ERR_NAME, TP,
1575 "You've specified a token that isn't known to webcit.!");
1583 const StrBuf *ProcessTemplate(WCTemplate *Tmpl, StrBuf *Target, WCTemplputParams *CallingTP)
1585 WCTemplate *pTmpl = Tmpl;
1588 const char *pData, *pS;
1590 WCTemplputParams TP;
1592 memcpy(&TP.Filter, &CallingTP->Filter, sizeof(ContextFilter));
1594 TP.Context = CallingTP->Context;
1595 TP.ControlContext = CallingTP->ControlContext;
1597 if (LoadTemplates != 0) {
1598 if (LoadTemplates > 1)
1599 syslog(1, "DBG: ----- loading: [%s] ------ \n",
1600 ChrPtr(Tmpl->FileName));
1601 pTmpl = duplicate_template(Tmpl);
1602 if(load_template(pTmpl) == NULL) {
1605 "<pre>\nError loading Template [%s]\n See Logfile for details\n</pre>\n",
1606 ChrPtr(Tmpl->FileName));
1607 FreeWCTemplate(pTmpl);
1613 pS = pData = ChrPtr(pTmpl->Data);
1614 len = StrLength(pTmpl->Data);
1618 if (i >= pTmpl->nTokensUsed) {
1619 StrBufAppendBufPlain(Target,
1621 len - (pData - pS), 0);
1625 StrBufAppendBufPlain(
1627 pTmpl->Tokens[i]->pTokenStart - pData, 0);
1628 TP.Tokens = pTmpl->Tokens[i];
1629 TP.nArgs = pTmpl->Tokens[i]->nParameters;
1630 state = EvaluateToken(Target, state, &TP);
1632 while ((state != 0) && (i+1 < pTmpl->nTokensUsed)) {
1633 /* condition told us to skip till its end condition */
1635 TP.Tokens = pTmpl->Tokens[i];
1636 TP.nArgs = pTmpl->Tokens[i]->nParameters;
1637 if ((pTmpl->Tokens[i]->Flags == SV_CONDITIONAL) ||
1638 (pTmpl->Tokens[i]->Flags == SV_NEG_CONDITIONAL)) {
1639 if (state == EvaluateConditional(
1641 pTmpl->Tokens[i]->Flags,
1647 pData = pTmpl->Tokens[i++]->pTokenEnd + 1;
1648 if (i > pTmpl->nTokensUsed)
1652 if (LoadTemplates != 0) {
1653 FreeWCTemplate(pTmpl);
1655 return Tmpl->MimeType;
1660 * \brief Display a variable-substituted template
1661 * \param templatename template file to load
1662 * \returns the mimetype of the template its doing
1664 const StrBuf *DoTemplate(const char *templatename, long len, StrBuf *Target, WCTemplputParams *TP)
1666 WCTemplputParams LocalTP;
1668 HashList *StaticLocal;
1674 memset(&LocalTP, 0, sizeof(WCTemplputParams));
1678 Static = TemplateCache;
1679 StaticLocal = LocalTemplateCache;
1683 syslog(1, "Can't to load a template with empty name!\n");
1684 StrBufAppendPrintf(Target, "<pre>\nCan't to load a template with empty name!\n</pre>");
1688 if (!GetHash(StaticLocal, templatename, len, &vTmpl) &&
1689 !GetHash(Static, templatename, len, &vTmpl)) {
1690 syslog(1, "didn't find Template [%s] %ld %ld\n", templatename, len , (long)strlen(templatename));
1691 StrBufAppendPrintf(Target, "<pre>\ndidn't find Template [%s] %ld %ld\n</pre>",
1693 (long)strlen(templatename));
1695 dbg_PrintHash(Static, PrintTemplate, NULL);
1696 PrintHash(Static, VarPrintTransition, PrintTemplate);
1702 return ProcessTemplate(vTmpl, Target, TP);
1707 void tmplput_Comment(StrBuf *Target, WCTemplputParams *TP)
1709 if (LoadTemplates != 0)
1715 GetTemplateTokenString(Target, TP, 0, &pch, &len);
1716 Comment = NewStrBufPlain(pch, len);
1717 StrBufAppendBufPlain(Target, HKEY("<!--"), 0);
1718 StrBufAppendTemplate(Target, TP, Comment, 1);
1719 StrBufAppendBufPlain(Target, HKEY("-->"), 0);
1720 FreeStrBuf(&Comment);
1724 /*-----------------------------------------------------------------------------
1727 typedef struct _HashIterator {
1728 HashList *StaticList;
1729 int AdditionalParams;
1731 int XPectContextType;
1733 RetrieveHashlistFunc GetHash;
1734 HashDestructorFunc Destructor;
1735 SubTemplFunc DoSubTemplate;
1738 void RegisterITERATOR(const char *Name, long len,
1739 int AdditionalParams,
1740 HashList *StaticList,
1741 RetrieveHashlistFunc GetHash,
1742 SubTemplFunc DoSubTempl,
1743 HashDestructorFunc Destructor,
1745 int XPectContextType,
1750 It = (HashIterator*)malloc(sizeof(HashIterator));
1751 memset(It, 0, sizeof(HashIterator));
1752 It->StaticList = StaticList;
1753 It->AdditionalParams = AdditionalParams;
1754 It->GetHash = GetHash;
1755 It->DoSubTemplate = DoSubTempl;
1756 It->Destructor = Destructor;
1757 It->ContextType = ContextType;
1758 It->XPectContextType = XPectContextType;
1760 Put(Iterators, Name, len, It, NULL);
1763 typedef struct _iteratestruct {
1772 int preeval_iterate(WCTemplateToken *Token)
1774 WCTemplputParams TPP;
1775 WCTemplputParams *TP;
1780 memset(&TPP, 0, sizeof(WCTemplputParams));
1783 if (!GetHash(Iterators, TKEY(0), &vIt)) {
1785 NULL, "Iterator", ERR_PARM1, TP,
1789 if (TP->Tokens->Params[1]->Type != TYPE_SUBTEMPLATE) {
1790 LogTemplateError(NULL, "Iterator", ERR_PARM1, TP,
1791 "Need token with type Subtemplate as param 1, have %s",
1792 TP->Tokens->Params[1]->Start);
1795 /* well, we don't check the mobile stuff here... */
1796 if (!GetHash(LocalTemplateCache, TKEY(1), &vTmpl) &&
1797 !GetHash(TemplateCache, TKEY(1), &vTmpl)) {
1798 LogTemplateError(NULL, "SubTemplate", ERR_PARM1, TP,
1799 "referenced here doesn't exist");
1801 Token->Preeval2 = vIt;
1802 It = (HashIterator *) vIt;
1804 if (TP->Tokens->nParameters < It->AdditionalParams + 2) {
1806 NULL, "Iterator", ERR_PARM1, TP,
1807 "doesn't work with %d params",
1808 TP->Tokens->nParameters);
1815 void tmpl_iterate_subtmpl(StrBuf *Target, WCTemplputParams *TP)
1820 SortStruct *SortBy = NULL;
1822 int DetectGroupChange = 0;
1825 void *vLastContext = NULL;
1827 WCTemplputParams SubTP;
1828 IterateStruct Status;
1834 memset(&Status, 0, sizeof(IterateStruct));
1835 memcpy (&SubTP, &TP, sizeof(WCTemplputParams));
1837 It = (HashIterator*) TP->Tokens->Preeval2;
1840 Target, "Iterator", ERR_PARM1, TP, "Unknown!");
1844 if (TP->Tokens->nParameters < It->AdditionalParams + 2) {
1846 Target, "Iterator", ERR_PARM1, TP,
1847 "doesn't work with %d params",
1848 TP->Tokens->nParameters - 1);
1852 if ((It->XPectContextType != CTX_NONE) &&
1853 (It->XPectContextType != TP->Filter.ContextType)) {
1855 Target, "Iterator", ERR_PARM1, TP,
1856 "requires context of type %s, have %s",
1857 ContextName(It->XPectContextType),
1858 ContextName(TP->Filter.ContextType));
1863 if (It->StaticList == NULL)
1864 List = It->GetHash(Target, TP);
1866 List = It->StaticList;
1868 DetectGroupChange = (It->Flags & IT_FLAG_DETECT_GROUPCHANGE) != 0;
1869 if (DetectGroupChange) {
1870 const StrBuf *BSort;
1871 DetectGroupChange = 0;
1872 if (havebstr("SortBy")) {
1873 BSort = sbstr("SortBy");
1874 if (GetHash(SortHash, SKEY(BSort), &vSortBy) &&
1875 (vSortBy != NULL)) {
1876 SortBy = (SortStruct*)vSortBy;
1877 /* first check whether its intended for us... */
1878 if ((SortBy->ContextType == It->ContextType)&&
1879 /** Ok, its us, lets see in which direction we should sort... */
1880 (havebstr("SortOrder"))) {
1882 SortOrder = LBSTR("SortOrder");
1884 DetectGroupChange = 1;
1889 nMembersUsed = GetCount(List);
1890 SubBuf = NewStrBuf();
1891 SubTP.Filter.ContextType = It->ContextType;
1892 SubTP.Filter.ControlContextType = CTX_ITERATE;
1893 SubTP.ControlContext = &Status;
1895 if (HAVE_PARAM(2)) {
1896 StartAt = GetTemplateTokenNumber(Target, TP, 2, 0);
1898 if (HAVE_PARAM(3)) {
1899 StepWidth = GetTemplateTokenNumber(Target, TP, 3, 0);
1901 if (HAVE_PARAM(4)) {
1902 StopAt = GetTemplateTokenNumber(Target, TP, 4, -1);
1904 it = GetNewHashPos(List, StepWidth);
1906 StopAt = GetCount(List);
1908 while (GetNextHashPos(List, it, &Status.KeyLen, &Status.Key, &vContext)) {
1909 if ((Status.n >= StartAt) && (Status.n <= StopAt)) {
1910 if (DetectGroupChange && Status.n > 0) {
1911 Status.GroupChange = SortBy->GroupChange(vContext, vLastContext);
1913 Status.LastN = (Status.n + 1) == nMembersUsed;
1914 SubTP.Context = vContext;
1915 if (It->DoSubTemplate != NULL)
1916 It->DoSubTemplate(SubBuf, &SubTP);
1917 DoTemplate(TKEY(1), SubBuf, &SubTP);
1919 StrBufAppendBuf(Target, SubBuf, 0);
1920 FlushStrBuf(SubBuf);
1921 Status.oddeven = ! Status.oddeven;
1922 vLastContext = vContext;
1926 FreeStrBuf(&SubBuf);
1928 if (It->Destructor != NULL)
1929 It->Destructor(&List);
1933 int conditional_ITERATE_ISGROUPCHANGE(StrBuf *Target, WCTemplputParams *TP)
1935 IterateStruct *Ctx = CCTX;
1936 if (TP->Tokens->nParameters < 3)
1937 return Ctx->GroupChange;
1939 return TP->Tokens->Params[2]->lvalue == Ctx->GroupChange;
1942 void tmplput_ITERATE_ODDEVEN(StrBuf *Target, WCTemplputParams *TP)
1944 IterateStruct *Ctx = CCTX;
1946 StrBufAppendBufPlain(Target, HKEY("odd"), 0);
1948 StrBufAppendBufPlain(Target, HKEY("even"), 0);
1952 void tmplput_ITERATE_KEY(StrBuf *Target, WCTemplputParams *TP)
1954 IterateStruct *Ctx = CCTX;
1956 StrBufAppendBufPlain(Target, Ctx->Key, Ctx->KeyLen, 0);
1960 void tmplput_ITERATE_LASTN(StrBuf *Target, WCTemplputParams *TP)
1962 IterateStruct *Ctx = CCTX;
1963 StrBufAppendPrintf(Target, "%d", Ctx->n);
1966 int conditional_ITERATE_FIRSTN(StrBuf *Target, WCTemplputParams *TP)
1968 IterateStruct *Ctx = CCTX;
1972 int conditional_ITERATE_LASTN(StrBuf *Target, WCTemplputParams *TP)
1974 IterateStruct *Ctx = CCTX;
1980 /*-----------------------------------------------------------------------------
1983 int EvaluateConditional(StrBuf *Target, int Neg, int state, WCTemplputParams *TP)
1985 ConditionalStruct *Cond;
1989 if ((TP->Tokens->Params[0]->len == 1) &&
1990 (TP->Tokens->Params[0]->Start[0] == 'X'))
1991 return (state != 0)?TP->Tokens->Params[1]->lvalue:0;
1993 Cond = (ConditionalStruct *) TP->Tokens->PreEval;
1996 Target, "Conditional", ERR_PARM1, TP,
2001 if (!CheckContext(Target, &Cond->Filter, TP, "Conditional")) {
2004 res = Cond->CondF(Target, TP);
2006 rc = TP->Tokens->Params[1]->lvalue;
2007 if (LoadTemplates > 5)
2008 syslog(1, "<%s> : %d %d==%d\n",
2009 ChrPtr(TP->Tokens->FlatToken),
2014 void RegisterConditional(const char *Name, long len,
2016 WCConditionalFunc CondF,
2017 int ContextRequired)
2019 ConditionalStruct *Cond;
2021 Cond = (ConditionalStruct*)malloc(sizeof(ConditionalStruct));
2022 memset(Cond, 0, sizeof(ConditionalStruct));
2023 Cond->PlainName = Name;
2024 Cond->Filter.nMaxArgs = nParams;
2025 Cond->Filter.nMinArgs = nParams;
2026 Cond->CondF = CondF;
2027 Cond->Filter.ContextType = ContextRequired;
2028 Cond->Filter.ControlContextType = CTX_NONE;
2029 Put(Conditionals, Name, len, Cond, NULL);
2032 void RegisterControlConditional(const char *Name, long len,
2034 WCConditionalFunc CondF,
2035 int ControlContextRequired)
2037 ConditionalStruct *Cond;
2039 Cond = (ConditionalStruct*)malloc(sizeof(ConditionalStruct));
2040 memset(Cond, 0, sizeof(ConditionalStruct));
2041 Cond->PlainName = Name;
2042 Cond->Filter.nMaxArgs = nParams;
2043 Cond->Filter.nMinArgs = nParams;
2044 Cond->CondF = CondF;
2045 Cond->Filter.ContextType = CTX_NONE;
2046 Cond->Filter.ControlContextType = ControlContextRequired;
2047 Put(Conditionals, Name, len, Cond, NULL);
2050 void RegisterTokenParamDefine(const char *Name, long len,
2055 PVal = (long*)malloc(sizeof(long));
2057 Put(Defines, Name, len, PVal, NULL);
2060 long GetTokenDefine(const char *Name, long len,
2065 if (GetHash(Defines, Name, len, &vPVal) &&
2068 return *(long*) vPVal;
2076 void tmplput_DefStr(StrBuf *Target, WCTemplputParams *TP)
2080 GetTemplateTokenString(Target, TP, 2, &Str, &len);
2082 StrBufAppendBufPlain(Target, Str, len, 0);
2085 void tmplput_DefVal(StrBuf *Target, WCTemplputParams *TP)
2089 val = GetTemplateTokenNumber(Target, TP, 0, 0);
2090 StrBufAppendPrintf(Target, "%d", val);
2095 /*-----------------------------------------------------------------------------
2098 void tmplput_ContextString(StrBuf *Target, WCTemplputParams *TP)
2100 StrBufAppendTemplate(Target, TP, (StrBuf*)CTX, 0);
2102 int ConditionalContextStr(StrBuf *Target, WCTemplputParams *TP)
2104 StrBuf *TokenText = (StrBuf*) CTX;
2105 const char *CompareToken;
2108 GetTemplateTokenString(Target, TP, 2, &CompareToken, &len);
2109 return strcmp(ChrPtr(TokenText), CompareToken) == 0;
2112 void tmplput_ContextStringArray(StrBuf *Target, WCTemplputParams *TP)
2114 HashList *Arr = (HashList*) CTX;
2118 val = GetTemplateTokenNumber(Target, TP, 0, 0);
2119 if (GetHash(Arr, IKEY(val), &pV) &&
2121 StrBufAppendTemplate(Target, TP, (StrBuf*)pV, 1);
2124 int ConditionalContextStrinArray(StrBuf *Target, WCTemplputParams *TP)
2126 HashList *Arr = (HashList*) CTX;
2129 const char *CompareToken;
2132 GetTemplateTokenString(Target, TP, 2, &CompareToken, &len);
2133 val = GetTemplateTokenNumber(Target, TP, 0, 0);
2134 if (GetHash(Arr, IKEY(val), &pV) &&
2136 return strcmp(ChrPtr((StrBuf*)pV), CompareToken) == 0;
2142 /*-----------------------------------------------------------------------------
2146 void tmpl_do_boxed(StrBuf *Target, WCTemplputParams *TP)
2148 WCTemplputParams SubTP;
2150 StrBuf *Headline = NULL;
2151 if (TP->Tokens->nParameters == 2) {
2152 if (TP->Tokens->Params[1]->Type == TYPE_STR) {
2153 Headline = NewStrBuf();
2154 DoTemplate(TKEY(1), Headline, TP);
2159 GetTemplateTokenString(Target,
2164 Headline = NewStrBufPlain(Ch, len);
2167 /* else TODO error? logging? */
2168 memcpy (&SubTP, TP, sizeof(WCTemplputParams));
2169 SubTP.Context = Headline;
2170 SubTP.Filter.ContextType = CTX_STRBUF;
2171 DoTemplate(HKEY("box_begin"), Target, &SubTP);
2172 DoTemplate(TKEY(0), Target, TP);
2173 DoTemplate(HKEY("box_end"), Target, TP);
2174 FreeStrBuf(&Headline);
2177 /*-----------------------------------------------------------------------------
2181 typedef struct _tab_struct {
2186 int preeval_do_tabbed(WCTemplateToken *Token)
2188 WCTemplputParams TPP;
2189 WCTemplputParams *TP;
2195 memset(&TPP, 0, sizeof(WCTemplputParams));
2198 nTabs = TP->Tokens->nParameters / 2 - 1;
2199 if (TP->Tokens->nParameters % 2 != 0)
2201 LogTemplateError(NULL, "TabbedApi", ERR_PARM1, TP,
2202 "need even number of arguments");
2206 else for (i = 0; i < nTabs; i++) {
2207 if (!HaveTemplateTokenString(NULL,
2212 (TP->Tokens->Params[i * 2]->len == 0))
2214 LogTemplateError(NULL, "TabbedApi", ERR_PARM1, TP,
2215 "Tab-Subject %d needs to be able to produce a string, have %s",
2216 i, TP->Tokens->Params[i * 2]->Start);
2219 if (!HaveTemplateTokenString(NULL,
2224 (TP->Tokens->Params[i * 2 + 1]->len == 0))
2226 LogTemplateError(NULL, "TabbedApi", ERR_PARM1, TP,
2227 "Tab-Content %d needs to be able to produce a string, have %s",
2228 i, TP->Tokens->Params[i * 2 + 1]->Start);
2233 if (!HaveTemplateTokenString(NULL,
2238 (TP->Tokens->Params[i * 2 + 1]->len == 0))
2240 LogTemplateError(NULL, "TabbedApi", ERR_PARM1, TP,
2241 "Tab-Content %d needs to be able to produce a string, have %s",
2242 i, TP->Tokens->Params[i * 2 + 1]->Start);
2249 void tmpl_do_tabbed(StrBuf *Target, WCTemplputParams *TP)
2252 int i, ntabs, nTabs;
2254 WCTemplputParams SubTP;
2256 memset(&TS, 0, sizeof(tab_struct));
2257 memcpy (&SubTP, &TP, sizeof(WCTemplputParams));
2259 nTabs = ntabs = TP->Tokens->nParameters / 2;
2260 TabNames = (StrBuf **) malloc(ntabs * sizeof(StrBuf*));
2261 memset(TabNames, 0, ntabs * sizeof(StrBuf*));
2263 for (i = 0; i < ntabs; i++) {
2264 if ((TP->Tokens->Params[i * 2]->Type == TYPE_STR) &&
2265 (TP->Tokens->Params[i * 2]->len > 0)) {
2266 TabNames[i] = NewStrBuf();
2267 DoTemplate(TKEY(i * 2), TabNames[i], TP);
2269 else if (TP->Tokens->Params[i * 2]->Type == TYPE_GETTEXT) {
2272 GetTemplateTokenString(Target,
2277 TabNames[i] = NewStrBufPlain(Ch, -1);
2280 /** A Tab without subject? we can't count that, add it as silent */
2284 memcpy (&SubTP, TP, sizeof(WCTemplputParams));
2285 SubTP.Filter.ControlContextType = CTX_TAB;
2286 SubTP.ControlContext = &TS;
2288 StrTabbedDialog(Target, nTabs, TabNames);
2289 for (i = 0; i < ntabs; i++) {
2290 memset(&TS, 0, sizeof(tab_struct));
2292 TS.TabTitle = TabNames[i];
2293 StrBeginTab(Target, i, nTabs, TabNames);
2294 DoTemplate(TKEY(i * 2 + 1), Target, &SubTP);
2295 StrEndTab(Target, i, nTabs);
2297 for (i = 0; i < ntabs; i++)
2298 FreeStrBuf(&TabNames[i]);
2301 void tmplput_TAB_N(StrBuf *Target, WCTemplputParams *TP)
2303 tab_struct *Ctx = CCTX;
2305 StrBufAppendPrintf(Target, "%d", Ctx->CurrentTab);
2308 void tmplput_TAB_TITLE(StrBuf *Target, WCTemplputParams *TP)
2310 tab_struct *Ctx = CCTX;
2311 StrBufAppendTemplate(Target, TP, Ctx->TabTitle, 0);
2314 /*-----------------------------------------------------------------------------
2319 void RegisterSortFunc(const char *name, long len,
2320 const char *prepend, long preplen,
2321 CompareFunc Forward,
2322 CompareFunc Reverse,
2323 CompareFunc GroupChange,
2326 SortStruct *NewSort;
2328 NewSort = (SortStruct*) malloc(sizeof(SortStruct));
2329 memset(NewSort, 0, sizeof(SortStruct));
2330 NewSort->Name = NewStrBufPlain(name, len);
2331 if (prepend != NULL)
2332 NewSort->PrefPrepend = NewStrBufPlain(prepend, preplen);
2334 NewSort->PrefPrepend = NULL;
2335 NewSort->Forward = Forward;
2336 NewSort->Reverse = Reverse;
2337 NewSort->GroupChange = GroupChange;
2338 NewSort->ContextType = ContextType;
2339 if (ContextType == CTX_NONE) {
2340 syslog(1, "sorting requires a context. CTX_NONE won't make it.\n");
2344 Put(SortHash, name, len, NewSort, DestroySortStruct);
2347 CompareFunc RetrieveSort(WCTemplputParams *TP,
2348 const char *OtherPrefix, long OtherPrefixLen,
2349 const char *Default, long ldefault, long DefaultDirection)
2351 const StrBuf *BSort = NULL;
2354 long SortOrder = -1;
2356 if (havebstr("SortBy")) {
2357 BSort = sbstr("SortBy");
2358 if (OtherPrefix == NULL) {
2359 set_room_pref("sort", NewStrBufDup(BSort), 0);
2362 set_X_PREFS(HKEY("sort"), OtherPrefix, OtherPrefixLen, NewStrBufDup(BSort), 0);
2365 else { /** Try to fallback to our remembered values... */
2366 if (OtherPrefix == NULL) {
2367 BSort = get_room_pref("sort");
2370 BSort = get_X_PREFS(HKEY("sort"), OtherPrefix, OtherPrefixLen);
2373 putbstr("SortBy", NewStrBufDup(BSort));
2377 BSort = Buf = NewStrBufPlain(Default, ldefault);
2378 putbstr("SortBy", Buf);
2382 if (!GetHash(SortHash, SKEY(BSort), &vSortBy) ||
2383 (vSortBy == NULL)) {
2384 if (!GetHash(SortHash, Default, ldefault, &vSortBy) ||
2385 (vSortBy == NULL)) {
2387 NULL, "Sorting", ERR_PARM1, TP,
2388 "Illegal default sort: [%s]", Default);
2392 SortBy = (SortStruct*)vSortBy;
2394 if (SortBy->ContextType != TP->Filter.ContextType)
2397 /** Ok, its us, lets see in which direction we should sort... */
2398 if (havebstr("SortOrder")) {
2399 SortOrder = LBSTR("SortOrder");
2401 else { /** Try to fallback to our remembered values... */
2403 if (SortBy->PrefPrepend == NULL) {
2404 Buf = get_room_pref("SortOrder");
2405 SortOrder = StrTol(Buf);
2408 BSort = get_X_PREFS(HKEY("SortOrder"), OtherPrefix, OtherPrefixLen);
2412 SortOrder = DefaultDirection;
2414 Buf = NewStrBufPlain(NULL, 64);
2415 StrBufPrintf(Buf, "%ld", SortOrder);
2416 putbstr("SortOrder", Buf);
2418 switch (SortOrder) {
2423 return SortBy->Forward;
2425 return SortBy->Reverse;
2437 ConstStr SortIcons[] = {
2438 {HKEY("static/webcit_icons/sort_none.gif")},
2439 {HKEY("static/webcit_icons/up_pointer.gif")},
2440 {HKEY("static/webcit_icons/down_pointer.gif")},
2443 ConstStr SortNextOrder[] = {
2450 int GetSortMetric(WCTemplputParams *TP, SortStruct **Next, SortStruct **Param, long *SortOrder, int N)
2452 int bSortError = eNOT_SPECIFIED;
2453 const StrBuf *BSort;
2458 if (!GetHash(SortHash, TKEY(0), &vSort) ||
2460 return eNO_SUCH_SORT;
2461 *Param = (SortStruct*) vSort;
2464 if (havebstr("SortBy")) {
2465 BSort = sbstr("SortBy");
2466 bSortError = eINVALID_PARAM;
2467 if ((*Param)->PrefPrepend == NULL) {
2468 set_room_pref("sort", NewStrBufDup(BSort), 0);
2471 set_X_PREFS(HKEY("sort"), TKEY(N), NewStrBufDup(BSort), 0);
2474 else { /** Try to fallback to our remembered values... */
2475 if ((*Param)->PrefPrepend == NULL) {
2476 BSort = get_room_pref("sort");
2479 BSort = get_X_PREFS(HKEY("sort"), TKEY(N));
2483 if (!GetHash(SortHash, SKEY(BSort), &vSort) ||
2487 *Next = (SortStruct*) vSort;
2489 /** Ok, its us, lets see in which direction we should sort... */
2490 if (havebstr("SortOrder")) {
2491 *SortOrder = LBSTR("SortOrder");
2493 else { /** Try to fallback to our remembered values... */
2494 if ((*Param)->PrefPrepend == NULL) {
2495 *SortOrder = StrTol(get_room_pref("SortOrder"));
2498 *SortOrder = StrTol(get_X_PREFS(HKEY("SortOrder"), TKEY(N)));
2508 void tmplput_SORT_ICON(StrBuf *Target, WCTemplputParams *TP)
2513 const ConstStr *SortIcon;
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:
2523 LogTemplateError(NULL, "Sorter", ERR_PARM1, TP,
2524 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2526 case eNOT_SPECIFIED:
2528 if (Next == Param) {
2529 SortIcon = &SortIcons[SortOrder];
2531 else { /** Not Us... */
2532 SortIcon = &SortIcons[0];
2534 StrBufAppendBufPlain(Target, SortIcon->Key, SortIcon->len, 0);
2538 void tmplput_SORT_NEXT(StrBuf *Target, WCTemplputParams *TP)
2544 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2547 Target, "Sorter", ERR_PARM1, TP,
2548 " Sorter [%s] unknown!",
2549 TP->Tokens->Params[0]->Start);
2551 case eINVALID_PARAM:
2553 NULL, "Sorter", ERR_PARM1, TP,
2554 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2556 case eNOT_SPECIFIED:
2558 StrBufAppendBuf(Target, Param->Name, 0);
2563 void tmplput_SORT_ORDER(StrBuf *Target, WCTemplputParams *TP)
2566 const ConstStr *SortOrderStr;
2570 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2573 Target, "Sorter", ERR_PARM1, TP,
2574 " Sorter [%s] unknown!",
2575 TP->Tokens->Params[0]->Start);
2577 case eINVALID_PARAM:
2579 NULL, "Sorter", ERR_PARM1, TP,
2580 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2582 case eNOT_SPECIFIED:
2584 if (Next == Param) {
2585 SortOrderStr = &SortNextOrder[SortOrder];
2587 else { /** Not Us... */
2588 SortOrderStr = &SortNextOrder[0];
2590 StrBufAppendBufPlain(Target, SortOrderStr->Key, SortOrderStr->len, 0);
2595 void tmplput_long_vector(StrBuf *Target, WCTemplputParams *TP)
2597 long *LongVector = (long*) CTX;
2599 if ((TP->Tokens->Params[0]->Type == TYPE_LONG) &&
2600 (TP->Tokens->Params[0]->lvalue <= LongVector[0]))
2602 StrBufAppendPrintf(Target, "%ld", LongVector[TP->Tokens->Params[0]->lvalue]);
2606 if (TP->Tokens->Params[0]->Type != TYPE_LONG) {
2608 Target, "Longvector", ERR_NAME, TP,
2609 "needs a numerical Parameter!");
2613 Target, "LongVector", ERR_PARM1, TP,
2614 "doesn't have %ld Parameters, its just the size of %ld!",
2615 TP->Tokens->Params[0]->lvalue,
2621 void dbg_print_longvector(long *LongVector)
2623 StrBuf *Buf = NewStrBufPlain(HKEY("Longvector: ["));
2624 int nItems = LongVector[0];
2627 for (i = 0; i < nItems; i++) {
2629 StrBufAppendPrintf(Buf, "%d: %ld | ", i, LongVector[i]);
2631 StrBufAppendPrintf(Buf, "%d: %ld]\n", i, LongVector[i]);
2634 syslog(1, "%s", ChrPtr(Buf));
2638 int ConditionalLongVector(StrBuf *Target, WCTemplputParams *TP)
2640 long *LongVector = (long*) CTX;
2642 if ((TP->Tokens->Params[2]->Type == TYPE_LONG) &&
2643 (TP->Tokens->Params[2]->lvalue <= LongVector[0])&&
2644 (TP->Tokens->Params[3]->Type == TYPE_LONG) &&
2645 (TP->Tokens->Params[3]->lvalue <= LongVector[0]))
2647 return LongVector[TP->Tokens->Params[2]->lvalue] ==
2648 LongVector[TP->Tokens->Params[3]->lvalue];
2652 if ((TP->Tokens->Params[2]->Type == TYPE_LONG) ||
2653 (TP->Tokens->Params[2]->Type == TYPE_LONG)) {
2655 Target, "ConditionalLongvector", ERR_PARM1, TP,
2656 "needs two long Parameter!");
2660 Target, "Longvector", ERR_PARM1, TP,
2661 "doesn't have %ld / %ld Parameters, its just the size of %ld!",
2662 TP->Tokens->Params[2]->lvalue,
2663 TP->Tokens->Params[3]->lvalue,
2671 void tmplput_CURRENT_FILE(StrBuf *Target, WCTemplputParams *TP)
2673 StrBufAppendTemplate(Target, TP, TP->Tokens->FileName, 0);
2680 memset(&NoCtx, 0, sizeof(WCTemplputParams));
2681 RegisterNamespace("--", 0, 2, tmplput_Comment, NULL, CTX_NONE);
2682 RegisterNamespace("SORT:ICON", 1, 2, tmplput_SORT_ICON, NULL, CTX_NONE);
2683 RegisterNamespace("SORT:ORDER", 1, 2, tmplput_SORT_ORDER, NULL, CTX_NONE);
2684 RegisterNamespace("SORT:NEXT", 1, 2, tmplput_SORT_NEXT, NULL, CTX_NONE);
2685 RegisterNamespace("CONTEXTSTR", 0, 1, tmplput_ContextString, NULL, CTX_STRBUF);
2686 RegisterNamespace("CONTEXTSTRARR", 1, 2, tmplput_ContextStringArray, NULL, CTX_STRBUFARR);
2687 RegisterNamespace("ITERATE", 2, 100, tmpl_iterate_subtmpl, preeval_iterate, CTX_NONE);
2688 RegisterNamespace("DOBOXED", 1, 2, tmpl_do_boxed, NULL, CTX_NONE);
2689 RegisterNamespace("DOTABBED", 2, 100, tmpl_do_tabbed, preeval_do_tabbed, CTX_NONE);
2690 RegisterControlNS(HKEY("TAB:N"), 0, 0, tmplput_TAB_N, CTX_TAB);
2691 RegisterControlNS(HKEY("TAB:SUBJECT"), 0, 1, tmplput_TAB_TITLE, CTX_TAB);
2694 RegisterNamespace("LONGVECTOR", 1, 1, tmplput_long_vector, NULL, CTX_LONGVECTOR);
2697 RegisterConditional(HKEY("COND:CONTEXTSTR"), 3, ConditionalContextStr, CTX_STRBUF);
2698 RegisterConditional(HKEY("COND:CONTEXTSTRARR"), 4, ConditionalContextStrinArray, CTX_STRBUFARR);
2699 RegisterConditional(HKEY("COND:LONGVECTOR"), 4, ConditionalLongVector, CTX_LONGVECTOR);
2702 RegisterControlConditional(HKEY("COND:ITERATE:ISGROUPCHANGE"), 2,
2703 conditional_ITERATE_ISGROUPCHANGE,
2705 RegisterControlConditional(HKEY("COND:ITERATE:LASTN"), 2,
2706 conditional_ITERATE_LASTN,
2708 RegisterControlConditional(HKEY("COND:ITERATE:FIRSTN"), 2,
2709 conditional_ITERATE_FIRSTN,
2712 RegisterControlNS(HKEY("ITERATE:ODDEVEN"), 0, 0, tmplput_ITERATE_ODDEVEN, CTX_ITERATE);
2713 RegisterControlNS(HKEY("ITERATE:KEY"), 0, 0, tmplput_ITERATE_KEY, CTX_ITERATE);
2714 RegisterControlNS(HKEY("ITERATE:N"), 0, 0, tmplput_ITERATE_LASTN, CTX_ITERATE);
2715 RegisterNamespace("CURRENTFILE", 0, 1, tmplput_CURRENT_FILE, NULL, CTX_NONE);
2716 RegisterNamespace("DEF:STR", 1, 1, tmplput_DefStr, NULL, CTX_NONE);
2717 RegisterNamespace("DEF:VAL", 1, 1, tmplput_DefVal, NULL, CTX_NONE);
2725 ServerStartModule_SUBST
2728 LocalTemplateCache = NewHash(1, NULL);
2729 TemplateCache = NewHash(1, NULL);
2731 GlobalNS = NewHash(1, NULL);
2732 Iterators = NewHash(1, NULL);
2733 Conditionals = NewHash(1, NULL);
2734 SortHash = NewHash(1, NULL);
2735 Defines = NewHash(1, NULL);
2739 FinalizeModule_SUBST
2746 ServerShutdownModule_SUBST
2749 DeleteHash(&TemplateCache);
2750 DeleteHash(&LocalTemplateCache);
2752 DeleteHash(&GlobalNS);
2753 DeleteHash(&Iterators);
2754 DeleteHash(&Conditionals);
2755 DeleteHash(&SortHash);
2756 DeleteHash(&Defines);
2761 SessionNewModule_SUBST
2768 SessionAttachModule_SUBST
2774 SessionDetachModule_SUBST
2777 FreeStrBuf(&sess->WFBuf);
2781 SessionDestroyModule_SUBST