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);
398 * \brief back end for print_value_of() ... does a server command
399 * \param servcmd server command to execute on the citadel server
401 void pvo_do_cmd(StrBuf *Target, StrBuf *servcmd) {
405 serv_puts(ChrPtr(servcmd));
406 len = serv_getln(buf, sizeof buf);
412 StrBufAppendPrintf(Target, "%s\n", &buf[4]);
415 _fmout(Target, "CENTER");
418 StrBufAppendPrintf(Target, "%s\n", &buf[4]);
424 int HaveTemplateTokenString(StrBuf *Target,
425 WCTemplputParams *TP,
430 if (N >= TP->Tokens->nParameters) {
434 switch (TP->Tokens->Params[N]->Type) {
440 case TYPE_SUBTEMPLATE:
449 void GetTemplateTokenString(StrBuf *Target,
450 WCTemplputParams *TP,
456 WCTemplputParams SubTP;
458 if (N >= TP->Tokens->nParameters) {
459 LogTemplateError(Target,
460 "TokenParameter", N, TP,
461 "invalid token %d. this shouldn't have come till here.\n", N);
467 switch (TP->Tokens->Params[N]->Type) {
471 *Value = TP->Tokens->Params[N]->Start;
472 *len = TP->Tokens->Params[N]->len;
475 if (TP->Tokens->Params[N]->len == 0) {
476 LogTemplateError(Target,
477 "TokenParameter", N, TP,
478 "Requesting parameter %d; of type BSTR, empty lookup string not admitted.", N);
483 Buf = (StrBuf*) SBstr(TKEY(N));
484 *Value = ChrPtr(Buf);
485 *len = StrLength(Buf);
488 if (TP->Tokens->Params[N]->len == 0) {
489 LogTemplateError(Target,
490 "TokenParameter", N, TP,
491 "Requesting parameter %d; of type PREFSTR, empty lookup string not admitted.", N);
496 get_PREFERENCE(TKEY(N), &Buf);
497 *Value = ChrPtr(Buf);
498 *len = StrLength(Buf);
501 LogTemplateError(Target,
502 "TokenParameter", N, TP,
503 "Requesting parameter %d; of type LONG, want string.", N);
506 LogTemplateError(Target,
507 "TokenParameter", N, TP,
508 "Requesting parameter %d; of type PREFINT, want string.", N);
511 *Value = _(TP->Tokens->Params[N]->Start);
512 *len = strlen(*Value);
514 case TYPE_SUBTEMPLATE:
515 if (TP->Tokens->Params[N]->len == 0) {
516 LogTemplateError(Target,
517 "TokenParameter", N, TP,
518 "Requesting parameter %d; of type SUBTEMPLATE, empty lookup string not admitted.", N);
524 memset(&SubTP, 0, sizeof(WCTemplputParams *));
525 SubTP.Context = TP->Context;
526 SubTP.Filter.ContextType = TP->Filter.ContextType;
528 DoTemplate(TKEY(N), Buf, &SubTP);
529 *Value = ChrPtr(Buf);
530 *len = StrLength(Buf);
531 /* we can't free it here, so we put it into the subst so its discarded later on. */
532 PutRequestLocalMem(Buf, HFreeStrBuf);
536 LogTemplateError(Target,
537 "TokenParameter", N, TP,
538 "unknown param type %d; [%d]", N, TP->Tokens->Params[N]->Type);
543 long GetTemplateTokenNumber(StrBuf *Target, WCTemplputParams *TP, int N, long dflt)
546 if (N >= TP->Tokens->nParameters) {
547 LogTemplateError(Target,
548 "TokenParameter", N, TP,
549 "invalid token %d. this shouldn't have come till here.\n", N);
554 switch (TP->Tokens->Params[N]->Type) {
557 return atol(TP->Tokens->Params[N]->Start);
560 if (TP->Tokens->Params[N]->len == 0) {
561 LogTemplateError(Target,
562 "TokenParameter", N, TP,
563 "Requesting parameter %d; of type BSTR, empty lookup string not admitted.", N);
566 return LBstr(TKEY(N));
569 LogTemplateError(Target,
570 "TokenParameter", N, TP,
571 "requesting a prefstring in param %d want a number", N);
572 if (TP->Tokens->Params[N]->len == 0) {
573 LogTemplateError(Target,
574 "TokenParameter", N, TP,
575 "Requesting parameter %d; of type PREFSTR, empty lookup string not admitted.", N);
578 if (get_PREF_LONG(TKEY(N), &Ret, dflt))
583 return TP->Tokens->Params[N]->lvalue;
585 if (TP->Tokens->Params[N]->len == 0) {
586 LogTemplateError(Target,
587 "TokenParameter", N, TP,
588 "Requesting parameter %d; of type PREFINT, empty lookup string not admitted.", N);
591 if (get_PREF_LONG(TKEY(N), &Ret, dflt))
595 LogTemplateError(Target,
596 "TokenParameter", N, TP,
597 "requesting a I18N string in param %d; want a number", N);
599 case TYPE_SUBTEMPLATE:
600 LogTemplateError(Target,
601 "TokenParameter", N, TP,
602 "requesting a subtemplate in param %d; not supported for numbers", N);
605 LogTemplateError(Target,
606 "TokenParameter", N, TP,
607 "unknown param type %d; [%d]", N, TP->Tokens->Params[N]->Type);
614 * \brief puts string into the template and computes which escape methon we should use
615 * \param Source the string we should put into the template
616 * \param FormatTypeIndex where should we look for escape types if?
618 void StrBufAppendTemplate(StrBuf *Target,
619 WCTemplputParams *TP,
620 const StrBuf *Source, int FormatTypeIndex)
623 const char *pFmt = NULL;
626 if ((FormatTypeIndex < TP->Tokens->nParameters) &&
627 (TP->Tokens->Params[FormatTypeIndex]->Type == TYPE_STR) &&
628 (TP->Tokens->Params[FormatTypeIndex]->len >= 1)) {
629 pFmt = TP->Tokens->Params[FormatTypeIndex]->Start;
637 StrEscAppend(Target, Source, NULL, 0, 2);
640 StrEscAppend(Target, Source, NULL, 0, 0);
643 StrECMAEscAppend(Target, Source, NULL);
646 StrHtmlEcmaEscAppend(Target, Source, NULL, 0, 0);
649 StrBufUrlescAppend(Target, Source, NULL);
652 if (pFmt != NULL) pFmt++;
653 else pFmt = "JUSTIFY";
654 if (*pFmt == '\0') pFmt = "JUSTIFY";
655 FmOut(Target, pFmt, Source);
658 StrBufAppendBuf(Target, Source, 0);
663 void PutNewToken(WCTemplate *Template, WCTemplateToken *NewToken)
665 if (Template->nTokensUsed + 1 >= Template->TokenSpace) {
666 if (Template->TokenSpace <= 0) {
667 Template->Tokens = (WCTemplateToken**)malloc(
668 sizeof(WCTemplateToken*) * 10);
669 memset(Template->Tokens, 0, sizeof(WCTemplateToken*) * 10);
670 Template->TokenSpace = 10;
673 WCTemplateToken **NewTokens;
675 NewTokens= (WCTemplateToken**) malloc(
676 sizeof(WCTemplateToken*) * Template->TokenSpace * 2);
679 0, sizeof(WCTemplateToken*) * Template->TokenSpace * 2);
683 sizeof(WCTemplateToken*) * Template->nTokensUsed);
685 free(Template->Tokens);
686 Template->TokenSpace *= 2;
687 Template->Tokens = NewTokens;
690 Template->Tokens[(Template->nTokensUsed)++] = NewToken;
693 int GetNextParameter(StrBuf *Buf,
696 WCTemplateToken *Tokens,
698 WCTemplputParams *TP,
699 TemplateParam **pParm)
701 const char *pch = *pCh;
702 const char *pchs, *pche;
707 *pParm = Parm = (TemplateParam *) malloc(sizeof(TemplateParam));
708 memset(Parm, 0, sizeof(TemplateParam));
709 Parm->Type = TYPE_STR;
711 /* Skip leading whitespaces */
712 while ((*pch == ' ' )||
715 (*pch == '\n')) pch ++;
718 Parm->Type = TYPE_PREFSTR;
725 else if (*pch == ';') {
726 Parm->Type = TYPE_PREFINT;
733 else if (*pch == '#') {
734 Parm->Type = TYPE_INTDEFINE;
737 else if (*pch == '_') {
738 Parm->Type = TYPE_GETTEXT;
745 else if (*pch == 'B') {
746 Parm->Type = TYPE_BSTR;
753 else if (*pch == '=') {
754 Parm->Type = TYPE_SUBTEMPLATE;
765 else if (*pch == '\'')
772 ( (pch > pchs) && (*(pch - 1) == '\\'))
778 syslog(1, "Error (in '%s' line %ld); "
779 "evaluating template param [%s] in Token [%s]\n",
780 ChrPtr(pTmpl->FileName),
782 ChrPtr(Tokens->FlatToken),
790 StrBufPeek(Buf, pch, -1, '\0');
791 if (LoadTemplates > 1) {
792 syslog(1, "DBG: got param [%s] %ld %ld\n",
793 pchs, pche - pchs, strlen(pchs));
796 Parm->len = pche - pchs;
797 pch ++; /* move after trailing quote */
798 if (ParamBrace && (*pch == ')')) {
805 Parm->Type = TYPE_LONG;
807 while ((pch <= pe) &&
814 StrBufPeek(Buf, pch, -1, '\0');
815 Parm->lvalue = atol(pchs);
822 syslog(1, "Error (in '%s' line %ld); "
823 "evaluating long template param [%s] in Token [%s]\n",
824 ChrPtr(pTmpl->FileName),
826 ChrPtr(Tokens->FlatToken),
834 while ((*pch == ' ' )||
838 (*pch == '\n')) pch ++;
843 if (DumpTemplateI18NStrings) {
844 StrBufAppendPrintf(I18nDump, "_(\"%s\");\n", Parm->Start);
847 case TYPE_INTDEFINE: {
850 if (GetHash(Defines, Parm->Start, Parm->len, &vPVal) &&
854 PVal = (long*) vPVal;
856 Parm->lvalue = *PVal;
858 else if (strchr(Parm->Start, '|') != NULL)
865 pToken = NewStrBufPlain (Parm->Start, Parm->len);
866 Match = NewStrBufPlain (NULL, Parm->len);
867 Pos = ChrPtr(pToken);
869 while ((Pos != NULL) && (Pos != StrBufNOTNULL))
871 StrBufExtract_NextToken(Match, pToken, &Pos, '|');
873 if (StrLength (Match) > 0)
875 if (GetHash(Defines, SKEY(Match), &vPVal) &&
879 PVal = (long*) vPVal;
881 Parm->lvalue |= *PVal;
884 LogTemplateError(NULL, "Define",
896 else if (strchr(Parm->Start, '&') != NULL)
903 pToken = NewStrBufPlain (Parm->Start, Parm->len);
904 Match = NewStrBufPlain (NULL, Parm->len);
905 Pos = ChrPtr(pToken);
907 while ((Pos != NULL) && (Pos != StrBufNOTNULL))
909 StrBufExtract_NextToken(Match, pToken, &Pos, '&');
911 if (StrLength (Match) > 0)
913 if (GetHash(Defines, SKEY(Match), &vPVal) &&
917 PVal = (long*) vPVal;
919 Parm->lvalue |= *PVal;
922 LogTemplateError(NULL, "Define",
937 LogTemplateError(NULL, "Define",
944 case TYPE_SUBTEMPLATE:{
946 /* well, we don't check the mobile stuff here... */
947 if (!GetHash(LocalTemplateCache, Parm->Start, Parm->len, &vTmpl) &&
948 !GetHash(TemplateCache, Parm->Start, Parm->len, &vTmpl)) {
949 LogTemplateError(NULL,
953 "referenced here doesn't exist");
961 WCTemplateToken *NewTemplateSubstitute(StrBuf *Buf,
963 const char *pTokenStart,
964 const char *pTokenEnd,
970 WCTemplateToken *NewToken;
973 NewToken = (WCTemplateToken*)malloc(sizeof(WCTemplateToken));
974 memset(NewToken, 0, sizeof(WCTemplateToken));
975 TP.Tokens = NewToken;
976 NewToken->FileName = pTmpl->FileName; /* to print meaningfull log messages... */
978 NewToken->Line = Line + 1;
979 NewToken->pTokenStart = pTokenStart;
980 NewToken->TokenStart = pTokenStart - pStart;
981 NewToken->TokenEnd = (pTokenEnd - pStart) - NewToken->TokenStart;
982 NewToken->pTokenEnd = pTokenEnd;
983 NewToken->NameEnd = NewToken->TokenEnd - 2;
984 NewToken->PreEval = NULL;
985 NewToken->FlatToken = NewStrBufPlain(pTokenStart + 2, pTokenEnd - pTokenStart - 2);
986 StrBufShrinkToFit(NewToken->FlatToken, 1);
988 StrBufPeek(Buf, pTokenStart, + 1, '\0');
989 StrBufPeek(Buf, pTokenEnd, -1, '\0');
990 pch = NewToken->pName = pTokenStart + 2;
992 NewToken->HaveParameters = 0;;
993 NewToken->nParameters = 0;
995 while (pch < pTokenEnd - 1) {
997 StrBufPeek(Buf, pch, -1, '\0');
998 NewToken->NameEnd = pch - NewToken->pName;
1000 if (*(pTokenEnd - 1) != ')') {
1002 NULL, "Parseerror", ERR_NAME, &TP,
1003 "Warning, Non welformed Token; missing right parenthesis");
1005 while (pch < pTokenEnd - 1) {
1006 NewToken->nParameters++;
1007 if (GetNextParameter(Buf,
1013 &NewToken->Params[NewToken->nParameters - 1]))
1015 NewToken->HaveParameters = 1;
1016 if (NewToken->nParameters >= MAXPARAM) {
1018 NULL, "Parseerror", ERR_NAME, &TP,
1019 "only [%d] Params allowed in Tokens",
1022 FreeToken(&NewToken);
1028 if((NewToken->NameEnd == 1) &&
1029 (NewToken->HaveParameters == 1))
1032 if (*(NewToken->pName) == '_')
1033 NewToken->Flags = SV_GETTEXT;
1034 else if (*(NewToken->pName) == '=')
1035 NewToken->Flags = SV_SUBTEMPL;
1036 else if (*(NewToken->pName) == '%')
1037 NewToken->Flags = SV_CUST_STR_CONDITIONAL;
1038 else if (*(NewToken->pName) == '?')
1039 NewToken->Flags = SV_CONDITIONAL;
1040 else if (*(NewToken->pName) == '!')
1041 NewToken->Flags = SV_NEG_CONDITIONAL;
1047 switch (NewToken->Flags) {
1049 /* If we're able to find out more about the token, do it now while its fresh. */
1050 if (GetHash(GlobalNS, NewToken->pName, NewToken->NameEnd, &vVar)) {
1051 HashHandler *Handler;
1052 Handler = (HashHandler*) vVar;
1053 if ((NewToken->nParameters < Handler->Filter.nMinArgs) ||
1054 (NewToken->nParameters > Handler->Filter.nMaxArgs)) {
1056 NULL, "Token", ERR_NAME, &TP,
1057 "doesn't work with %d params",
1058 NewToken->nParameters);
1062 NewToken->PreEval = Handler;
1063 NewToken->Flags = SV_PREEVALUATED;
1064 if (Handler->PreEvalFunc != NULL)
1065 Handler->PreEvalFunc(NewToken);
1070 if (NewToken->nParameters !=1) {
1072 NULL, "Gettext", ERR_NAME, &TP,
1073 "requires exactly 1 parameter, you gave %d params",
1074 NewToken->nParameters);
1075 NewToken->Flags = 0;
1078 if (DumpTemplateI18NStrings) {
1079 StrBufAppendPrintf(I18nDump, "_(\"%s\");\n", NewToken->Params[0]->Start);
1083 if (NewToken->nParameters != 1) {
1085 NULL, "Subtemplates", ERR_NAME, &TP,
1086 "require exactly 1 parameter, you gave %d params",
1087 NewToken->nParameters);
1092 /* well, we don't check the mobile stuff here... */
1093 if (!GetHash(LocalTemplateCache,
1094 NewToken->Params[0]->Start,
1095 NewToken->Params[0]->len,
1097 !GetHash(TemplateCache,
1098 NewToken->Params[0]->Start,
1099 NewToken->Params[0]->len,
1102 NULL, "SubTemplate", ERR_PARM1, &TP,
1107 case SV_CUST_STR_CONDITIONAL:
1108 case SV_CONDITIONAL:
1109 case SV_NEG_CONDITIONAL:
1110 if (NewToken->nParameters <2) {
1112 NULL, "Conditional", ERR_PARM1, &TP,
1113 "require at least 2 parameters, you gave %d params",
1114 NewToken->nParameters);
1115 NewToken->Flags = 0;
1118 if (NewToken->Params[1]->lvalue == 0) {
1120 NULL, "Conditional", ERR_PARM1, &TP,
1121 "Conditional ID (Parameter 1) mustn't be 0!");
1122 NewToken->Flags = 0;
1125 if (!GetHash(Conditionals,
1126 NewToken->Params[0]->Start,
1127 NewToken->Params[0]->len,
1130 if ((NewToken->Params[0]->len == 1) &&
1131 (NewToken->Params[0]->Start[0] == 'X'))
1134 NULL, "Conditional", ERR_PARM1, &TP,
1137 NewToken->Error = NewStrBuf();
1140 "<pre>\nConditional [%s] (in '%s' line %ld); Not found!\n[%s]\n</pre>\n",
1141 NewToken->Params[0]->Start,
1142 ChrPtr(pTmpl->FileName),
1144 ChrPtr(NewToken->FlatToken));
1148 NewToken->PreEval = vVar;
1160 * \brief Display a variable-substituted template
1161 * \param templatename template file to load
1163 void *prepare_template(StrBuf *filename, StrBuf *Key, HashList *PutThere)
1165 WCTemplate *NewTemplate;
1167 NewTemplate = (WCTemplate *) malloc(sizeof(WCTemplate));
1168 memset(NewTemplate, 0, sizeof(WCTemplate));
1169 NewTemplate->Data = NULL;
1170 NewTemplate->FileName = NewStrBufDup(filename);
1171 StrBufShrinkToFit(NewTemplate->FileName, 1);
1172 NewTemplate->nTokensUsed = 0;
1173 NewTemplate->TokenSpace = 0;
1174 NewTemplate->Tokens = NULL;
1175 NewTemplate->MimeType = NewStrBufPlain(GuessMimeByFilename (SKEY(NewTemplate->FileName)), -1);
1176 if (strstr(ChrPtr(NewTemplate->MimeType), "text") != NULL) {
1177 StrBufAppendBufPlain(NewTemplate->MimeType, HKEY("; charset=utf-8"), 0);
1180 if (strstr(ChrPtr(NewTemplate->MimeType), "text") != NULL) {
1181 StrBufAppendBufPlain(NewTemplate->MimeType, HKEY("; charset=utf-8"), 0);
1184 Put(PutThere, ChrPtr(Key), StrLength(Key), NewTemplate, FreeWCTemplate);
1189 * \brief Display a variable-substituted template
1190 * \param templatename template file to load
1192 void *duplicate_template(WCTemplate *OldTemplate)
1194 WCTemplate *NewTemplate;
1196 NewTemplate = (WCTemplate *) malloc(sizeof(WCTemplate));
1197 memset(NewTemplate, 0, sizeof(WCTemplate));
1198 NewTemplate->Data = NULL;
1199 NewTemplate->FileName = NewStrBufDup(OldTemplate->FileName);
1200 StrBufShrinkToFit(NewTemplate->FileName, 1);
1201 NewTemplate->nTokensUsed = 0;
1202 NewTemplate->TokenSpace = 0;
1203 NewTemplate->Tokens = NULL;
1204 NewTemplate->MimeType = NewStrBufDup(OldTemplate->MimeType);
1209 * \brief Display a variable-substituted template
1210 * \param templatename template file to load
1212 void *load_template(WCTemplate *NewTemplate)
1215 struct stat statbuf;
1216 const char *pS, *pE, *pch, *Err;
1220 fd = open(ChrPtr(NewTemplate->FileName), O_RDONLY);
1222 syslog(1, "ERROR: could not open template '%s' - %s\n",
1223 ChrPtr(NewTemplate->FileName), strerror(errno));
1227 if (fstat(fd, &statbuf) == -1) {
1228 syslog(1, "ERROR: could not stat template '%s' - %s\n",
1229 ChrPtr(NewTemplate->FileName), strerror(errno));
1233 NewTemplate->Data = NewStrBufPlain(NULL, statbuf.st_size + 1);
1234 if (StrBufReadBLOB(NewTemplate->Data, &fd, 1, statbuf.st_size, &Err) < 0) {
1236 syslog(1, "ERROR: reading template '%s' - %s<br>\n",
1237 ChrPtr(NewTemplate->FileName), strerror(errno));
1238 //FreeWCTemplate(NewTemplate);/////tODO
1244 StrBufShrinkToFit(NewTemplate->Data, 1);
1245 StrBufShrinkToFit(NewTemplate->MimeType, 1);
1246 pS = pch = ChrPtr(NewTemplate->Data);
1247 pE = pS + StrLength(NewTemplate->Data);
1249 const char *pts, *pte;
1251 int InDoubleQuotes = 0;
1254 /** Find one <? > */
1256 for (; pch < pE; pch ++) {
1257 if ((*pch=='<')&&(*(pch + 1)=='?') &&
1258 !((pch == pS) && /* we must ommit a <?xml */
1259 (*(pch + 2) == 'x') &&
1260 (*(pch + 3) == 'm') &&
1261 (*(pch + 4) == 'l')))
1263 if (*pch=='\n') Line ++;
1269 /** Found one? parse it. */
1270 for (; pch <= pE - 1; pch ++) {
1272 InDoubleQuotes = ! InDoubleQuotes;
1273 else if (*pch == '\'')
1274 InQuotes = ! InQuotes;
1275 else if ((!InQuotes && !InDoubleQuotes) &&
1276 ((*pch!='\\')&&(*(pch + 1)=='>'))) {
1284 pv = NewTemplateSubstitute(NewTemplate->Data, pS, pts, pte, Line, NewTemplate);
1286 PutNewToken(NewTemplate, pv);
1294 const char* PrintTemplate(void *vSubst)
1296 WCTemplate *Tmpl = vSubst;
1298 return ChrPtr(Tmpl->FileName);
1302 int LoadTemplateDir(const StrBuf *DirName, HashList *big, const StrBuf *BaseKey)
1308 StrBuf *SubDirectory;
1309 DIR *filedir = NULL;
1310 struct dirent *filedir_entry;
1316 d = (struct dirent *)malloc(offsetof(struct dirent, d_name) + PATH_MAX + 1);
1321 filedir = opendir (ChrPtr(DirName));
1322 if (filedir == NULL) {
1327 Toplevel = StrLength(BaseKey) == 0;
1328 SubDirectory = NewStrBuf();
1329 SubKey = NewStrBuf();
1330 FileName = NewStrBufPlain(NULL, PATH_MAX);
1332 while ((readdir_r(filedir, d, &filedir_entry) == 0) &&
1333 (filedir_entry != NULL))
1337 #ifdef _DIRENT_HAVE_D_NAMELEN
1338 d_namelen = filedir_entry->d_namelen;
1339 d_type = filedir_entry->d_type;
1343 #define DT_UNKNOWN 0
1348 #define IFTODT(mode) (((mode) & 0170000) >> 12)
1349 #define DTTOIF(dirtype) ((dirtype) << 12)
1351 d_namelen = strlen(filedir_entry->d_name);
1352 d_type = DT_UNKNOWN;
1354 d_without_ext = d_namelen;
1356 if ((d_namelen > 1) && filedir_entry->d_name[d_namelen - 1] == '~')
1357 continue; /* Ignore backup files... */
1359 if ((d_namelen == 1) &&
1360 (filedir_entry->d_name[0] == '.'))
1363 if ((d_namelen == 2) &&
1364 (filedir_entry->d_name[0] == '.') &&
1365 (filedir_entry->d_name[1] == '.'))
1368 if (d_type == DT_UNKNOWN) {
1370 char path[PATH_MAX];
1371 snprintf(path, PATH_MAX, "%s/%s",
1372 ChrPtr(DirName), filedir_entry->d_name);
1373 if (stat(path, &s) == 0) {
1374 d_type = IFTODT(s.st_mode);
1380 /* Skip directories we are not interested in... */
1381 if (strcmp(filedir_entry->d_name, ".svn") == 0)
1384 FlushStrBuf(SubKey);
1386 /* If we're not toplevel, the upper dirs count as foo_bar_<local name>*/
1387 StrBufAppendBuf(SubKey, BaseKey, 0);
1388 StrBufAppendBufPlain(SubKey, HKEY("_"), 0);
1390 StrBufAppendBufPlain(SubKey, filedir_entry->d_name, d_namelen, 0);
1392 FlushStrBuf(SubDirectory);
1393 StrBufAppendBuf(SubDirectory, DirName, 0);
1394 if (ChrPtr(SubDirectory)[StrLength(SubDirectory) - 1] != '/')
1395 StrBufAppendBufPlain(SubDirectory, HKEY("/"), 0);
1396 StrBufAppendBufPlain(SubDirectory, filedir_entry->d_name, d_namelen, 0);
1398 LoadTemplateDir(SubDirectory, big, SubKey);
1401 case DT_LNK: /* TODO: check whether its a file or a directory */
1405 while ((d_without_ext > 0) && (filedir_entry->d_name[d_without_ext] != '.'))
1407 if ((d_without_ext == 0) || (d_namelen < 3))
1409 if (((d_namelen > 1) && filedir_entry->d_name[d_namelen - 1] == '~') ||
1410 (strcmp(&filedir_entry->d_name[d_without_ext], ".orig") == 0) ||
1411 (strcmp(&filedir_entry->d_name[d_without_ext], ".swp") == 0))
1412 continue; /* Ignore backup files... */
1413 PStart = filedir_entry->d_name;
1414 StrBufPrintf(FileName, "%s/%s", ChrPtr(DirName), filedir_entry->d_name);
1415 MinorPtr = strchr(filedir_entry->d_name, '.');
1416 if (MinorPtr != NULL)
1420 /* If we're not toplevel, the upper dirs count as foo_bar_<local name>*/
1421 StrBufAppendBuf(Key, BaseKey, 0);
1422 StrBufAppendBufPlain(Key, HKEY("_"), 0);
1424 StrBufAppendBufPlain(Key, filedir_entry->d_name, MinorPtr - filedir_entry->d_name, 0);
1426 if (LoadTemplates >= 1)
1427 syslog(1, "%s %s\n", ChrPtr(FileName), ChrPtr(Key));
1428 prepare_template(FileName, Key, big);
1435 FreeStrBuf(&FileName);
1437 FreeStrBuf(&SubDirectory);
1438 FreeStrBuf(&SubKey);
1442 void InitTemplateCache(void)
1447 HashList *Templates[2];
1452 /* Primary Template set... */
1453 StrBufPrintf(Dir, "%s/t", static_dirs[0]);
1454 LoadTemplateDir(Dir,
1458 /* User local Template set */
1459 StrBufPrintf(Dir, "%s/t", static_dirs[1]);
1460 LoadTemplateDir(Dir,
1464 /* Debug Templates, just to be loaded while debugging. */
1466 StrBufPrintf(Dir, "%s/dbg", static_dirs[0]);
1467 LoadTemplateDir(Dir,
1470 Templates[0] = TemplateCache;
1471 Templates[1] = LocalTemplateCache;
1474 if (LoadTemplates == 0)
1475 for (i=0; i < 2; i++) {
1481 At = GetNewHashPos(Templates[i], 0);
1482 while (GetNextHashPos(Templates[i],
1487 (vTemplate != NULL))
1489 load_template((WCTemplate *)vTemplate);
1501 /*-----------------------------------------------------------------------------
1502 * Filling & processing Templates
1505 * \brief executes one token
1506 * \param Target buffer to append to
1507 * \param Token da to process.
1508 * \param Template we're iterating
1509 * \param Context Contextpoointer to pass in
1510 * \param state are we in conditional state?
1511 * \param ContextType what type of information does context giv us?
1513 int EvaluateToken(StrBuf *Target, int state, WCTemplputParams *TP)
1515 const char *AppendMe;
1517 HashHandler *Handler;
1520 /* much output, since pName is not terminated...
1521 syslog(1,"Doing token: %s\n",Token->pName);
1524 switch (TP->Tokens->Flags) {
1526 TmplGettext(Target, TP);
1528 case SV_CONDITIONAL: /** Forward conditional evaluation */
1529 return EvaluateConditional(Target, 1, state, TP);
1531 case SV_NEG_CONDITIONAL: /** Reverse conditional evaluation */
1532 return EvaluateConditional(Target, 0, state, TP);
1534 case SV_CUST_STR_CONDITIONAL: /** Conditional put custom strings from params */
1535 if (TP->Tokens->nParameters >= 6) {
1536 if (EvaluateConditional(Target, 0, state, TP)) {
1537 GetTemplateTokenString(Target, TP, 5, &AppendMe, &AppendMeLen);
1538 StrBufAppendBufPlain(Target,
1544 GetTemplateTokenString(Target, TP, 4, &AppendMe, &AppendMeLen);
1545 StrBufAppendBufPlain(Target,
1553 Target, "Conditional", ERR_NAME, TP,
1554 "needs at least 6 Params!");
1558 if (TP->Tokens->nParameters == 1)
1559 DoTemplate(TKEY(0), Target, TP);
1561 case SV_PREEVALUATED:
1562 Handler = (HashHandler*) TP->Tokens->PreEval;
1563 if (!CheckContext(Target, &Handler->Filter, TP, "Token")) {
1566 Handler->HandlerFunc(Target, TP);
1569 if (GetHash(GlobalNS, TP->Tokens->pName, TP->Tokens->NameEnd, &vVar)) {
1570 Handler = (HashHandler*) vVar;
1571 if (!CheckContext(Target, &Handler->Filter, TP, "Token")) {
1575 Handler->HandlerFunc(Target, TP);
1580 Target, "Token UNKNOWN", ERR_NAME, TP,
1581 "You've specified a token that isn't known to webcit.!");
1589 const StrBuf *ProcessTemplate(WCTemplate *Tmpl, StrBuf *Target, WCTemplputParams *CallingTP)
1591 WCTemplate *pTmpl = Tmpl;
1594 const char *pData, *pS;
1596 WCTemplputParams TP;
1598 memcpy(&TP.Filter, &CallingTP->Filter, sizeof(ContextFilter));
1600 TP.Context = CallingTP->Context;
1601 TP.ControlContext = CallingTP->ControlContext;
1603 if (LoadTemplates != 0) {
1604 if (LoadTemplates > 1)
1605 syslog(1, "DBG: ----- loading: [%s] ------ \n",
1606 ChrPtr(Tmpl->FileName));
1607 pTmpl = duplicate_template(Tmpl);
1608 if(load_template(pTmpl) == NULL) {
1611 "<pre>\nError loading Template [%s]\n See Logfile for details\n</pre>\n",
1612 ChrPtr(Tmpl->FileName));
1613 FreeWCTemplate(pTmpl);
1619 pS = pData = ChrPtr(pTmpl->Data);
1620 len = StrLength(pTmpl->Data);
1624 if (i >= pTmpl->nTokensUsed) {
1625 StrBufAppendBufPlain(Target,
1627 len - (pData - pS), 0);
1631 StrBufAppendBufPlain(
1633 pTmpl->Tokens[i]->pTokenStart - pData, 0);
1634 TP.Tokens = pTmpl->Tokens[i];
1635 TP.nArgs = pTmpl->Tokens[i]->nParameters;
1636 state = EvaluateToken(Target, state, &TP);
1638 while ((state != 0) && (i+1 < pTmpl->nTokensUsed)) {
1639 /* condition told us to skip till its end condition */
1641 TP.Tokens = pTmpl->Tokens[i];
1642 TP.nArgs = pTmpl->Tokens[i]->nParameters;
1643 if ((pTmpl->Tokens[i]->Flags == SV_CONDITIONAL) ||
1644 (pTmpl->Tokens[i]->Flags == SV_NEG_CONDITIONAL)) {
1645 if (state == EvaluateConditional(
1647 pTmpl->Tokens[i]->Flags,
1653 pData = pTmpl->Tokens[i++]->pTokenEnd + 1;
1654 if (i > pTmpl->nTokensUsed)
1658 if (LoadTemplates != 0) {
1659 FreeWCTemplate(pTmpl);
1661 return Tmpl->MimeType;
1666 * \brief Display a variable-substituted template
1667 * \param templatename template file to load
1668 * \returns the mimetype of the template its doing
1670 const StrBuf *DoTemplate(const char *templatename, long len, StrBuf *Target, WCTemplputParams *TP)
1672 WCTemplputParams LocalTP;
1674 HashList *StaticLocal;
1680 memset(&LocalTP, 0, sizeof(WCTemplputParams));
1684 Static = TemplateCache;
1685 StaticLocal = LocalTemplateCache;
1689 syslog(1, "Can't to load a template with empty name!\n");
1690 StrBufAppendPrintf(Target, "<pre>\nCan't to load a template with empty name!\n</pre>");
1694 if (!GetHash(StaticLocal, templatename, len, &vTmpl) &&
1695 !GetHash(Static, templatename, len, &vTmpl)) {
1696 syslog(1, "didn't find Template [%s] %ld %ld\n", templatename, len , (long)strlen(templatename));
1697 StrBufAppendPrintf(Target, "<pre>\ndidn't find Template [%s] %ld %ld\n</pre>",
1699 (long)strlen(templatename));
1701 dbg_PrintHash(Static, PrintTemplate, NULL);
1702 PrintHash(Static, VarPrintTransition, PrintTemplate);
1708 return ProcessTemplate(vTmpl, Target, TP);
1713 void tmplput_Comment(StrBuf *Target, WCTemplputParams *TP)
1715 if (LoadTemplates != 0)
1721 GetTemplateTokenString(Target, TP, 0, &pch, &len);
1722 Comment = NewStrBufPlain(pch, len);
1723 StrBufAppendBufPlain(Target, HKEY("<!--"), 0);
1724 StrBufAppendTemplate(Target, TP, Comment, 1);
1725 StrBufAppendBufPlain(Target, HKEY("-->"), 0);
1726 FreeStrBuf(&Comment);
1730 /*-----------------------------------------------------------------------------
1733 typedef struct _HashIterator {
1734 HashList *StaticList;
1735 int AdditionalParams;
1737 int XPectContextType;
1739 RetrieveHashlistFunc GetHash;
1740 HashDestructorFunc Destructor;
1741 SubTemplFunc DoSubTemplate;
1744 void RegisterITERATOR(const char *Name, long len,
1745 int AdditionalParams,
1746 HashList *StaticList,
1747 RetrieveHashlistFunc GetHash,
1748 SubTemplFunc DoSubTempl,
1749 HashDestructorFunc Destructor,
1751 int XPectContextType,
1756 It = (HashIterator*)malloc(sizeof(HashIterator));
1757 memset(It, 0, sizeof(HashIterator));
1758 It->StaticList = StaticList;
1759 It->AdditionalParams = AdditionalParams;
1760 It->GetHash = GetHash;
1761 It->DoSubTemplate = DoSubTempl;
1762 It->Destructor = Destructor;
1763 It->ContextType = ContextType;
1764 It->XPectContextType = XPectContextType;
1766 Put(Iterators, Name, len, It, NULL);
1769 typedef struct _iteratestruct {
1778 int preeval_iterate(WCTemplateToken *Token)
1780 WCTemplputParams TPP;
1781 WCTemplputParams *TP;
1786 memset(&TPP, 0, sizeof(WCTemplputParams));
1789 if (!GetHash(Iterators, TKEY(0), &vIt)) {
1791 NULL, "Iterator", ERR_PARM1, TP,
1795 if (TP->Tokens->Params[1]->Type != TYPE_SUBTEMPLATE) {
1796 LogTemplateError(NULL, "Iterator", ERR_PARM1, TP,
1797 "Need token with type Subtemplate as param 1, have %s",
1798 TP->Tokens->Params[1]->Start);
1801 /* well, we don't check the mobile stuff here... */
1802 if (!GetHash(LocalTemplateCache, TKEY(1), &vTmpl) &&
1803 !GetHash(TemplateCache, TKEY(1), &vTmpl)) {
1804 LogTemplateError(NULL, "SubTemplate", ERR_PARM1, TP,
1805 "referenced here doesn't exist");
1807 Token->Preeval2 = vIt;
1808 It = (HashIterator *) vIt;
1810 if (TP->Tokens->nParameters < It->AdditionalParams + 2) {
1812 NULL, "Iterator", ERR_PARM1, TP,
1813 "doesn't work with %d params",
1814 TP->Tokens->nParameters);
1821 void tmpl_iterate_subtmpl(StrBuf *Target, WCTemplputParams *TP)
1826 SortStruct *SortBy = NULL;
1828 int DetectGroupChange = 0;
1831 void *vLastContext = NULL;
1833 WCTemplputParams SubTP;
1834 IterateStruct Status;
1840 memset(&Status, 0, sizeof(IterateStruct));
1841 memcpy (&SubTP, &TP, sizeof(WCTemplputParams));
1843 It = (HashIterator*) TP->Tokens->Preeval2;
1846 Target, "Iterator", ERR_PARM1, TP, "Unknown!");
1850 if (TP->Tokens->nParameters < It->AdditionalParams + 2) {
1852 Target, "Iterator", ERR_PARM1, TP,
1853 "doesn't work with %d params",
1854 TP->Tokens->nParameters - 1);
1858 if ((It->XPectContextType != CTX_NONE) &&
1859 (It->XPectContextType != TP->Filter.ContextType)) {
1861 Target, "Iterator", ERR_PARM1, TP,
1862 "requires context of type %s, have %s",
1863 ContextName(It->XPectContextType),
1864 ContextName(TP->Filter.ContextType));
1869 if (It->StaticList == NULL)
1870 List = It->GetHash(Target, TP);
1872 List = It->StaticList;
1874 DetectGroupChange = (It->Flags & IT_FLAG_DETECT_GROUPCHANGE) != 0;
1875 if (DetectGroupChange) {
1876 const StrBuf *BSort;
1877 DetectGroupChange = 0;
1878 if (havebstr("SortBy")) {
1879 BSort = sbstr("SortBy");
1880 if (GetHash(SortHash, SKEY(BSort), &vSortBy) &&
1881 (vSortBy != NULL)) {
1882 SortBy = (SortStruct*)vSortBy;
1883 /* first check whether its intended for us... */
1884 if ((SortBy->ContextType == It->ContextType)&&
1885 /** Ok, its us, lets see in which direction we should sort... */
1886 (havebstr("SortOrder"))) {
1888 SortOrder = LBSTR("SortOrder");
1890 DetectGroupChange = 1;
1895 nMembersUsed = GetCount(List);
1896 SubBuf = NewStrBuf();
1897 SubTP.Filter.ContextType = It->ContextType;
1898 SubTP.Filter.ControlContextType = CTX_ITERATE;
1899 SubTP.ControlContext = &Status;
1901 if (HAVE_PARAM(2)) {
1902 StartAt = GetTemplateTokenNumber(Target, TP, 2, 0);
1904 if (HAVE_PARAM(3)) {
1905 StepWidth = GetTemplateTokenNumber(Target, TP, 3, 0);
1907 if (HAVE_PARAM(4)) {
1908 StopAt = GetTemplateTokenNumber(Target, TP, 4, -1);
1910 it = GetNewHashPos(List, StepWidth);
1912 StopAt = GetCount(List);
1914 while (GetNextHashPos(List, it, &Status.KeyLen, &Status.Key, &vContext)) {
1915 if ((Status.n >= StartAt) && (Status.n <= StopAt)) {
1916 if (DetectGroupChange && Status.n > 0) {
1917 Status.GroupChange = SortBy->GroupChange(vContext, vLastContext);
1919 Status.LastN = (Status.n + 1) == nMembersUsed;
1920 SubTP.Context = vContext;
1921 if (It->DoSubTemplate != NULL)
1922 It->DoSubTemplate(SubBuf, &SubTP);
1923 DoTemplate(TKEY(1), SubBuf, &SubTP);
1925 StrBufAppendBuf(Target, SubBuf, 0);
1926 FlushStrBuf(SubBuf);
1927 Status.oddeven = ! Status.oddeven;
1928 vLastContext = vContext;
1932 FreeStrBuf(&SubBuf);
1934 if (It->Destructor != NULL)
1935 It->Destructor(&List);
1939 int conditional_ITERATE_ISGROUPCHANGE(StrBuf *Target, WCTemplputParams *TP)
1941 IterateStruct *Ctx = CCTX;
1942 if (TP->Tokens->nParameters < 3)
1943 return Ctx->GroupChange;
1945 return TP->Tokens->Params[2]->lvalue == Ctx->GroupChange;
1948 void tmplput_ITERATE_ODDEVEN(StrBuf *Target, WCTemplputParams *TP)
1950 IterateStruct *Ctx = CCTX;
1952 StrBufAppendBufPlain(Target, HKEY("odd"), 0);
1954 StrBufAppendBufPlain(Target, HKEY("even"), 0);
1958 void tmplput_ITERATE_KEY(StrBuf *Target, WCTemplputParams *TP)
1960 IterateStruct *Ctx = CCTX;
1962 StrBufAppendBufPlain(Target, Ctx->Key, Ctx->KeyLen, 0);
1966 void tmplput_ITERATE_LASTN(StrBuf *Target, WCTemplputParams *TP)
1968 IterateStruct *Ctx = CCTX;
1969 StrBufAppendPrintf(Target, "%d", Ctx->n);
1972 int conditional_ITERATE_FIRSTN(StrBuf *Target, WCTemplputParams *TP)
1974 IterateStruct *Ctx = CCTX;
1978 int conditional_ITERATE_LASTN(StrBuf *Target, WCTemplputParams *TP)
1980 IterateStruct *Ctx = CCTX;
1986 /*-----------------------------------------------------------------------------
1989 int EvaluateConditional(StrBuf *Target, int Neg, int state, WCTemplputParams *TP)
1991 ConditionalStruct *Cond;
1995 if ((TP->Tokens->Params[0]->len == 1) &&
1996 (TP->Tokens->Params[0]->Start[0] == 'X'))
1997 return (state != 0)?TP->Tokens->Params[1]->lvalue:0;
1999 Cond = (ConditionalStruct *) TP->Tokens->PreEval;
2002 Target, "Conditional", ERR_PARM1, TP,
2007 if (!CheckContext(Target, &Cond->Filter, TP, "Conditional")) {
2010 res = Cond->CondF(Target, TP);
2012 rc = TP->Tokens->Params[1]->lvalue;
2013 if (LoadTemplates > 5)
2014 syslog(1, "<%s> : %d %d==%d\n",
2015 ChrPtr(TP->Tokens->FlatToken),
2020 void RegisterConditional(const char *Name, long len,
2022 WCConditionalFunc CondF,
2023 int ContextRequired)
2025 ConditionalStruct *Cond;
2027 Cond = (ConditionalStruct*)malloc(sizeof(ConditionalStruct));
2028 memset(Cond, 0, sizeof(ConditionalStruct));
2029 Cond->PlainName = Name;
2030 Cond->Filter.nMaxArgs = nParams;
2031 Cond->Filter.nMinArgs = nParams;
2032 Cond->CondF = CondF;
2033 Cond->Filter.ContextType = ContextRequired;
2034 Cond->Filter.ControlContextType = CTX_NONE;
2035 Put(Conditionals, Name, len, Cond, NULL);
2038 void RegisterControlConditional(const char *Name, long len,
2040 WCConditionalFunc CondF,
2041 int ControlContextRequired)
2043 ConditionalStruct *Cond;
2045 Cond = (ConditionalStruct*)malloc(sizeof(ConditionalStruct));
2046 memset(Cond, 0, sizeof(ConditionalStruct));
2047 Cond->PlainName = Name;
2048 Cond->Filter.nMaxArgs = nParams;
2049 Cond->Filter.nMinArgs = nParams;
2050 Cond->CondF = CondF;
2051 Cond->Filter.ContextType = CTX_NONE;
2052 Cond->Filter.ControlContextType = ControlContextRequired;
2053 Put(Conditionals, Name, len, Cond, NULL);
2056 void RegisterTokenParamDefine(const char *Name, long len,
2061 PVal = (long*)malloc(sizeof(long));
2063 Put(Defines, Name, len, PVal, NULL);
2066 long GetTokenDefine(const char *Name, long len,
2071 if (GetHash(Defines, Name, len, &vPVal) &&
2074 return *(long*) vPVal;
2082 void tmplput_DefStr(StrBuf *Target, WCTemplputParams *TP)
2086 GetTemplateTokenString(Target, TP, 2, &Str, &len);
2088 StrBufAppendBufPlain(Target, Str, len, 0);
2091 void tmplput_DefVal(StrBuf *Target, WCTemplputParams *TP)
2095 val = GetTemplateTokenNumber(Target, TP, 0, 0);
2096 StrBufAppendPrintf(Target, "%d", val);
2101 /*-----------------------------------------------------------------------------
2104 void tmplput_ContextString(StrBuf *Target, WCTemplputParams *TP)
2106 StrBufAppendTemplate(Target, TP, (StrBuf*)CTX, 0);
2108 int ConditionalContextStr(StrBuf *Target, WCTemplputParams *TP)
2110 StrBuf *TokenText = (StrBuf*) CTX;
2111 const char *CompareToken;
2114 GetTemplateTokenString(Target, TP, 2, &CompareToken, &len);
2115 return strcmp(ChrPtr(TokenText), CompareToken) == 0;
2118 void tmplput_ContextStringArray(StrBuf *Target, WCTemplputParams *TP)
2120 HashList *Arr = (HashList*) CTX;
2124 val = GetTemplateTokenNumber(Target, TP, 0, 0);
2125 if (GetHash(Arr, IKEY(val), &pV) &&
2127 StrBufAppendTemplate(Target, TP, (StrBuf*)pV, 1);
2130 int ConditionalContextStrinArray(StrBuf *Target, WCTemplputParams *TP)
2132 HashList *Arr = (HashList*) CTX;
2135 const char *CompareToken;
2138 GetTemplateTokenString(Target, TP, 2, &CompareToken, &len);
2139 val = GetTemplateTokenNumber(Target, TP, 0, 0);
2140 if (GetHash(Arr, IKEY(val), &pV) &&
2142 return strcmp(ChrPtr((StrBuf*)pV), CompareToken) == 0;
2148 /*-----------------------------------------------------------------------------
2152 void tmpl_do_boxed(StrBuf *Target, WCTemplputParams *TP)
2154 WCTemplputParams SubTP;
2156 StrBuf *Headline = NULL;
2157 if (TP->Tokens->nParameters == 2) {
2158 if (TP->Tokens->Params[1]->Type == TYPE_STR) {
2159 Headline = NewStrBuf();
2160 DoTemplate(TKEY(1), Headline, TP);
2165 GetTemplateTokenString(Target,
2170 Headline = NewStrBufPlain(Ch, len);
2173 /* else TODO error? logging? */
2174 memcpy (&SubTP, TP, sizeof(WCTemplputParams));
2175 SubTP.Context = Headline;
2176 SubTP.Filter.ContextType = CTX_STRBUF;
2177 DoTemplate(HKEY("box_begin"), Target, &SubTP);
2178 DoTemplate(TKEY(0), Target, TP);
2179 DoTemplate(HKEY("box_end"), Target, TP);
2180 FreeStrBuf(&Headline);
2183 /*-----------------------------------------------------------------------------
2187 typedef struct _tab_struct {
2192 int preeval_do_tabbed(WCTemplateToken *Token)
2194 WCTemplputParams TPP;
2195 WCTemplputParams *TP;
2201 memset(&TPP, 0, sizeof(WCTemplputParams));
2204 nTabs = TP->Tokens->nParameters / 2 - 1;
2205 if (TP->Tokens->nParameters % 2 != 0)
2207 LogTemplateError(NULL, "TabbedApi", ERR_PARM1, TP,
2208 "need even number of arguments");
2212 else for (i = 0; i < nTabs; i++) {
2213 if (!HaveTemplateTokenString(NULL,
2218 (TP->Tokens->Params[i * 2]->len == 0))
2220 LogTemplateError(NULL, "TabbedApi", ERR_PARM1, TP,
2221 "Tab-Subject %d needs to be able to produce a string, have %s",
2222 i, TP->Tokens->Params[i * 2]->Start);
2225 if (!HaveTemplateTokenString(NULL,
2230 (TP->Tokens->Params[i * 2 + 1]->len == 0))
2232 LogTemplateError(NULL, "TabbedApi", ERR_PARM1, TP,
2233 "Tab-Content %d needs to be able to produce a string, have %s",
2234 i, TP->Tokens->Params[i * 2 + 1]->Start);
2239 if (!HaveTemplateTokenString(NULL,
2244 (TP->Tokens->Params[i * 2 + 1]->len == 0))
2246 LogTemplateError(NULL, "TabbedApi", ERR_PARM1, TP,
2247 "Tab-Content %d needs to be able to produce a string, have %s",
2248 i, TP->Tokens->Params[i * 2 + 1]->Start);
2255 void tmpl_do_tabbed(StrBuf *Target, WCTemplputParams *TP)
2258 int i, ntabs, nTabs;
2260 WCTemplputParams SubTP;
2262 memset(&TS, 0, sizeof(tab_struct));
2263 memcpy (&SubTP, &TP, sizeof(WCTemplputParams));
2265 nTabs = ntabs = TP->Tokens->nParameters / 2;
2266 TabNames = (StrBuf **) malloc(ntabs * sizeof(StrBuf*));
2267 memset(TabNames, 0, ntabs * sizeof(StrBuf*));
2269 for (i = 0; i < ntabs; i++) {
2270 if ((TP->Tokens->Params[i * 2]->Type == TYPE_STR) &&
2271 (TP->Tokens->Params[i * 2]->len > 0)) {
2272 TabNames[i] = NewStrBuf();
2273 DoTemplate(TKEY(i * 2), TabNames[i], TP);
2275 else if (TP->Tokens->Params[i * 2]->Type == TYPE_GETTEXT) {
2278 GetTemplateTokenString(Target,
2283 TabNames[i] = NewStrBufPlain(Ch, -1);
2286 /** A Tab without subject? we can't count that, add it as silent */
2290 memcpy (&SubTP, TP, sizeof(WCTemplputParams));
2291 SubTP.Filter.ControlContextType = CTX_TAB;
2292 SubTP.ControlContext = &TS;
2294 StrTabbedDialog(Target, nTabs, TabNames);
2295 for (i = 0; i < ntabs; i++) {
2296 memset(&TS, 0, sizeof(tab_struct));
2298 TS.TabTitle = TabNames[i];
2299 StrBeginTab(Target, i, nTabs, TabNames);
2300 DoTemplate(TKEY(i * 2 + 1), Target, &SubTP);
2301 StrEndTab(Target, i, nTabs);
2303 for (i = 0; i < ntabs; i++)
2304 FreeStrBuf(&TabNames[i]);
2307 void tmplput_TAB_N(StrBuf *Target, WCTemplputParams *TP)
2309 tab_struct *Ctx = CCTX;
2311 StrBufAppendPrintf(Target, "%d", Ctx->CurrentTab);
2314 void tmplput_TAB_TITLE(StrBuf *Target, WCTemplputParams *TP)
2316 tab_struct *Ctx = CCTX;
2317 StrBufAppendTemplate(Target, TP, Ctx->TabTitle, 0);
2320 /*-----------------------------------------------------------------------------
2325 void RegisterSortFunc(const char *name, long len,
2326 const char *prepend, long preplen,
2327 CompareFunc Forward,
2328 CompareFunc Reverse,
2329 CompareFunc GroupChange,
2332 SortStruct *NewSort;
2334 NewSort = (SortStruct*) malloc(sizeof(SortStruct));
2335 memset(NewSort, 0, sizeof(SortStruct));
2336 NewSort->Name = NewStrBufPlain(name, len);
2337 if (prepend != NULL)
2338 NewSort->PrefPrepend = NewStrBufPlain(prepend, preplen);
2340 NewSort->PrefPrepend = NULL;
2341 NewSort->Forward = Forward;
2342 NewSort->Reverse = Reverse;
2343 NewSort->GroupChange = GroupChange;
2344 NewSort->ContextType = ContextType;
2345 if (ContextType == CTX_NONE) {
2346 syslog(1, "sorting requires a context. CTX_NONE won't make it.\n");
2350 Put(SortHash, name, len, NewSort, DestroySortStruct);
2353 CompareFunc RetrieveSort(WCTemplputParams *TP,
2354 const char *OtherPrefix, long OtherPrefixLen,
2355 const char *Default, long ldefault, long DefaultDirection)
2358 const StrBuf *BSort = NULL;
2361 long SortOrder = -1;
2363 if (havebstr("SortBy")) {
2364 BSort = sbstr("SortBy");
2365 if (OtherPrefix == NULL) {
2366 set_room_pref("sort", NewStrBufDup(BSort), 0);
2369 set_X_PREFS(HKEY("sort"), OtherPrefix, OtherPrefixLen, NewStrBufDup(BSort), 0);
2372 else { /** Try to fallback to our remembered values... */
2373 if (OtherPrefix == NULL) {
2374 BSort = get_room_pref("sort");
2377 BSort = get_X_PREFS(HKEY("sort"), OtherPrefix, OtherPrefixLen);
2380 putbstr("SortBy", NewStrBufDup(BSort));
2384 BSort = Buf = NewStrBufPlain(Default, ldefault);
2385 putbstr("SortBy", Buf);
2389 if (!GetHash(SortHash, SKEY(BSort), &vSortBy) ||
2390 (vSortBy == NULL)) {
2392 if (!GetHash(SortHash, Default, ldefault, &vSortBy) ||
2393 (vSortBy == NULL)) {
2395 NULL, "Sorting", ERR_PARM1, TP,
2396 "Illegal default sort: [%s]", Default);
2400 SortBy = (SortStruct*)vSortBy;
2402 if (SortBy->ContextType != TP->Filter.ContextType)
2405 /** Ok, its us, lets see in which direction we should sort... */
2406 if (havebstr("SortOrder")) {
2407 SortOrder = LBSTR("SortOrder");
2409 else { /** Try to fallback to our remembered values... */
2411 if (SortBy->PrefPrepend == NULL) {
2412 Buf = get_room_pref("SortOrder");
2413 SortOrder = StrTol(Buf);
2416 BSort = get_X_PREFS(HKEY("SortOrder"), OtherPrefix, OtherPrefixLen);
2420 SortOrder = DefaultDirection;
2422 Buf = NewStrBufPlain(NULL, 64);
2423 StrBufPrintf(Buf, "%ld", SortOrder);
2424 putbstr("SortOrder", Buf);
2426 switch (SortOrder) {
2431 return SortBy->Forward;
2433 return SortBy->Reverse;
2445 ConstStr SortIcons[] = {
2446 {HKEY("static/webcit_icons/sort_none.gif")},
2447 {HKEY("static/webcit_icons/up_pointer.gif")},
2448 {HKEY("static/webcit_icons/down_pointer.gif")},
2451 ConstStr SortNextOrder[] = {
2458 int GetSortMetric(WCTemplputParams *TP, SortStruct **Next, SortStruct **Param, long *SortOrder, int N)
2460 int bSortError = eNOT_SPECIFIED;
2461 const StrBuf *BSort;
2466 if (!GetHash(SortHash, TKEY(0), &vSort) ||
2468 return eNO_SUCH_SORT;
2469 *Param = (SortStruct*) vSort;
2472 if (havebstr("SortBy")) {
2473 BSort = sbstr("SortBy");
2474 bSortError = eINVALID_PARAM;
2475 if ((*Param)->PrefPrepend == NULL) {
2476 set_room_pref("sort", NewStrBufDup(BSort), 0);
2479 set_X_PREFS(HKEY("sort"), TKEY(N), NewStrBufDup(BSort), 0);
2482 else { /** Try to fallback to our remembered values... */
2483 if ((*Param)->PrefPrepend == NULL) {
2484 BSort = get_room_pref("sort");
2487 BSort = get_X_PREFS(HKEY("sort"), TKEY(N));
2491 if (!GetHash(SortHash, SKEY(BSort), &vSort) ||
2495 *Next = (SortStruct*) vSort;
2497 /** Ok, its us, lets see in which direction we should sort... */
2498 if (havebstr("SortOrder")) {
2499 *SortOrder = LBSTR("SortOrder");
2501 else { /** Try to fallback to our remembered values... */
2502 if ((*Param)->PrefPrepend == NULL) {
2503 *SortOrder = StrTol(get_room_pref("SortOrder"));
2506 *SortOrder = StrTol(get_X_PREFS(HKEY("SortOrder"), TKEY(N)));
2516 void tmplput_SORT_ICON(StrBuf *Target, WCTemplputParams *TP)
2521 const ConstStr *SortIcon;
2523 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2526 Target, "Sorter", ERR_PARM1, TP,
2527 " Sorter [%s] unknown!",
2528 TP->Tokens->Params[0]->Start);
2530 case eINVALID_PARAM:
2531 LogTemplateError(NULL, "Sorter", ERR_PARM1, TP,
2532 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2534 case eNOT_SPECIFIED:
2536 if (Next == Param) {
2537 SortIcon = &SortIcons[SortOrder];
2539 else { /** Not Us... */
2540 SortIcon = &SortIcons[0];
2542 StrBufAppendBufPlain(Target, SortIcon->Key, SortIcon->len, 0);
2546 void tmplput_SORT_NEXT(StrBuf *Target, WCTemplputParams *TP)
2552 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2555 Target, "Sorter", ERR_PARM1, TP,
2556 " Sorter [%s] unknown!",
2557 TP->Tokens->Params[0]->Start);
2559 case eINVALID_PARAM:
2561 NULL, "Sorter", ERR_PARM1, TP,
2562 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2564 case eNOT_SPECIFIED:
2566 StrBufAppendBuf(Target, Param->Name, 0);
2571 void tmplput_SORT_ORDER(StrBuf *Target, WCTemplputParams *TP)
2574 const ConstStr *SortOrderStr;
2578 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2581 Target, "Sorter", ERR_PARM1, TP,
2582 " Sorter [%s] unknown!",
2583 TP->Tokens->Params[0]->Start);
2585 case eINVALID_PARAM:
2587 NULL, "Sorter", ERR_PARM1, TP,
2588 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2590 case eNOT_SPECIFIED:
2592 if (Next == Param) {
2593 SortOrderStr = &SortNextOrder[SortOrder];
2595 else { /** Not Us... */
2596 SortOrderStr = &SortNextOrder[0];
2598 StrBufAppendBufPlain(Target, SortOrderStr->Key, SortOrderStr->len, 0);
2603 void tmplput_long_vector(StrBuf *Target, WCTemplputParams *TP)
2605 long *LongVector = (long*) CTX;
2607 if ((TP->Tokens->Params[0]->Type == TYPE_LONG) &&
2608 (TP->Tokens->Params[0]->lvalue <= LongVector[0]))
2610 StrBufAppendPrintf(Target, "%ld", LongVector[TP->Tokens->Params[0]->lvalue]);
2614 if (TP->Tokens->Params[0]->Type != TYPE_LONG) {
2616 Target, "Longvector", ERR_NAME, TP,
2617 "needs a numerical Parameter!");
2621 Target, "LongVector", ERR_PARM1, TP,
2622 "doesn't have %ld Parameters, its just the size of %ld!",
2623 TP->Tokens->Params[0]->lvalue,
2629 void dbg_print_longvector(long *LongVector)
2631 StrBuf *Buf = NewStrBufPlain(HKEY("Longvector: ["));
2632 int nItems = LongVector[0];
2635 for (i = 0; i < nItems; i++) {
2637 StrBufAppendPrintf(Buf, "%d: %ld | ", i, LongVector[i]);
2639 StrBufAppendPrintf(Buf, "%d: %ld]\n", i, LongVector[i]);
2642 syslog(1, "%s", ChrPtr(Buf));
2646 int ConditionalLongVector(StrBuf *Target, WCTemplputParams *TP)
2648 long *LongVector = (long*) CTX;
2650 if ((TP->Tokens->Params[2]->Type == TYPE_LONG) &&
2651 (TP->Tokens->Params[2]->lvalue <= LongVector[0])&&
2652 (TP->Tokens->Params[3]->Type == TYPE_LONG) &&
2653 (TP->Tokens->Params[3]->lvalue <= LongVector[0]))
2655 return LongVector[TP->Tokens->Params[2]->lvalue] ==
2656 LongVector[TP->Tokens->Params[3]->lvalue];
2660 if ((TP->Tokens->Params[2]->Type == TYPE_LONG) ||
2661 (TP->Tokens->Params[2]->Type == TYPE_LONG)) {
2663 Target, "ConditionalLongvector", ERR_PARM1, TP,
2664 "needs two long Parameter!");
2668 Target, "Longvector", ERR_PARM1, TP,
2669 "doesn't have %ld / %ld Parameters, its just the size of %ld!",
2670 TP->Tokens->Params[2]->lvalue,
2671 TP->Tokens->Params[3]->lvalue,
2679 void tmplput_CURRENT_FILE(StrBuf *Target, WCTemplputParams *TP)
2681 StrBufAppendTemplate(Target, TP, TP->Tokens->FileName, 0);
2688 memset(&NoCtx, 0, sizeof(WCTemplputParams));
2689 RegisterNamespace("--", 0, 2, tmplput_Comment, NULL, CTX_NONE);
2690 RegisterNamespace("SORT:ICON", 1, 2, tmplput_SORT_ICON, NULL, CTX_NONE);
2691 RegisterNamespace("SORT:ORDER", 1, 2, tmplput_SORT_ORDER, NULL, CTX_NONE);
2692 RegisterNamespace("SORT:NEXT", 1, 2, tmplput_SORT_NEXT, NULL, CTX_NONE);
2693 RegisterNamespace("CONTEXTSTR", 0, 1, tmplput_ContextString, NULL, CTX_STRBUF);
2694 RegisterNamespace("CONTEXTSTRARR", 1, 2, tmplput_ContextStringArray, NULL, CTX_STRBUFARR);
2695 RegisterNamespace("ITERATE", 2, 100, tmpl_iterate_subtmpl, preeval_iterate, CTX_NONE);
2696 RegisterNamespace("DOBOXED", 1, 2, tmpl_do_boxed, NULL, CTX_NONE);
2697 RegisterNamespace("DOTABBED", 2, 100, tmpl_do_tabbed, preeval_do_tabbed, CTX_NONE);
2698 RegisterControlNS(HKEY("TAB:N"), 0, 0, tmplput_TAB_N, CTX_TAB);
2699 RegisterControlNS(HKEY("TAB:SUBJECT"), 0, 1, tmplput_TAB_TITLE, CTX_TAB);
2702 RegisterNamespace("LONGVECTOR", 1, 1, tmplput_long_vector, NULL, CTX_LONGVECTOR);
2705 RegisterConditional(HKEY("COND:CONTEXTSTR"), 3, ConditionalContextStr, CTX_STRBUF);
2706 RegisterConditional(HKEY("COND:CONTEXTSTRARR"), 4, ConditionalContextStrinArray, CTX_STRBUFARR);
2707 RegisterConditional(HKEY("COND:LONGVECTOR"), 4, ConditionalLongVector, CTX_LONGVECTOR);
2710 RegisterControlConditional(HKEY("COND:ITERATE:ISGROUPCHANGE"), 2,
2711 conditional_ITERATE_ISGROUPCHANGE,
2713 RegisterControlConditional(HKEY("COND:ITERATE:LASTN"), 2,
2714 conditional_ITERATE_LASTN,
2716 RegisterControlConditional(HKEY("COND:ITERATE:FIRSTN"), 2,
2717 conditional_ITERATE_FIRSTN,
2720 RegisterControlNS(HKEY("ITERATE:ODDEVEN"), 0, 0, tmplput_ITERATE_ODDEVEN, CTX_ITERATE);
2721 RegisterControlNS(HKEY("ITERATE:KEY"), 0, 0, tmplput_ITERATE_KEY, CTX_ITERATE);
2722 RegisterControlNS(HKEY("ITERATE:N"), 0, 0, tmplput_ITERATE_LASTN, CTX_ITERATE);
2723 RegisterNamespace("CURRENTFILE", 0, 1, tmplput_CURRENT_FILE, NULL, CTX_NONE);
2724 RegisterNamespace("DEF:STR", 1, 1, tmplput_DefStr, NULL, CTX_NONE);
2725 RegisterNamespace("DEF:VAL", 1, 1, tmplput_DefVal, NULL, CTX_NONE);
2733 ServerStartModule_SUBST
2736 LocalTemplateCache = NewHash(1, NULL);
2737 TemplateCache = NewHash(1, NULL);
2739 GlobalNS = NewHash(1, NULL);
2740 Iterators = NewHash(1, NULL);
2741 Conditionals = NewHash(1, NULL);
2742 SortHash = NewHash(1, NULL);
2743 Defines = NewHash(1, NULL);
2747 FinalizeModule_SUBST
2754 ServerShutdownModule_SUBST
2757 DeleteHash(&TemplateCache);
2758 DeleteHash(&LocalTemplateCache);
2760 DeleteHash(&GlobalNS);
2761 DeleteHash(&Iterators);
2762 DeleteHash(&Conditionals);
2763 DeleteHash(&SortHash);
2764 DeleteHash(&Defines);
2769 SessionNewModule_SUBST
2776 SessionAttachModule_SUBST
2782 SessionDetachModule_SUBST
2785 FreeStrBuf(&sess->WFBuf);
2789 SessionDestroyModule_SUBST