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)
625 if ((FormatTypeIndex < TP->Tokens->nParameters) &&
626 (TP->Tokens->Params[FormatTypeIndex]->Type == TYPE_STR) &&
627 (TP->Tokens->Params[FormatTypeIndex]->len == 1)) {
628 EscapeAs = *TP->Tokens->Params[FormatTypeIndex]->Start;
635 StrEscAppend(Target, Source, NULL, 0, 2);
638 StrEscAppend(Target, Source, NULL, 0, 0);
641 StrECMAEscAppend(Target, Source, NULL);
644 StrHtmlEcmaEscAppend(Target, Source, NULL, 0, 0);
647 StrBufUrlescAppend(Target, Source, NULL);
650 StrBufAppendBuf(Target, Source, 0);
655 void PutNewToken(WCTemplate *Template, WCTemplateToken *NewToken)
657 if (Template->nTokensUsed + 1 >= Template->TokenSpace) {
658 if (Template->TokenSpace <= 0) {
659 Template->Tokens = (WCTemplateToken**)malloc(
660 sizeof(WCTemplateToken*) * 10);
661 memset(Template->Tokens, 0, sizeof(WCTemplateToken*) * 10);
662 Template->TokenSpace = 10;
665 WCTemplateToken **NewTokens;
667 NewTokens= (WCTemplateToken**) malloc(
668 sizeof(WCTemplateToken*) * Template->TokenSpace * 2);
671 0, sizeof(WCTemplateToken*) * Template->TokenSpace * 2);
675 sizeof(WCTemplateToken*) * Template->nTokensUsed);
677 free(Template->Tokens);
678 Template->TokenSpace *= 2;
679 Template->Tokens = NewTokens;
682 Template->Tokens[(Template->nTokensUsed)++] = NewToken;
685 int GetNextParameter(StrBuf *Buf,
688 WCTemplateToken *Tokens,
690 WCTemplputParams *TP,
691 TemplateParam **pParm)
693 const char *pch = *pCh;
694 const char *pchs, *pche;
699 *pParm = Parm = (TemplateParam *) malloc(sizeof(TemplateParam));
700 memset(Parm, 0, sizeof(TemplateParam));
701 Parm->Type = TYPE_STR;
703 /* Skip leading whitespaces */
704 while ((*pch == ' ' )||
707 (*pch == '\n')) pch ++;
710 Parm->Type = TYPE_PREFSTR;
717 else if (*pch == ';') {
718 Parm->Type = TYPE_PREFINT;
725 else if (*pch == '#') {
726 Parm->Type = TYPE_INTDEFINE;
729 else if (*pch == '_') {
730 Parm->Type = TYPE_GETTEXT;
737 else if (*pch == 'B') {
738 Parm->Type = TYPE_BSTR;
745 else if (*pch == '=') {
746 Parm->Type = TYPE_SUBTEMPLATE;
757 else if (*pch == '\'')
764 ( (pch > pchs) && (*(pch - 1) == '\\'))
770 syslog(1, "Error (in '%s' line %ld); "
771 "evaluating template param [%s] in Token [%s]\n",
772 ChrPtr(pTmpl->FileName),
774 ChrPtr(Tokens->FlatToken),
782 StrBufPeek(Buf, pch, -1, '\0');
783 if (LoadTemplates > 1) {
784 syslog(1, "DBG: got param [%s] %ld %ld\n",
785 pchs, pche - pchs, strlen(pchs));
788 Parm->len = pche - pchs;
789 pch ++; /* move after trailing quote */
790 if (ParamBrace && (*pch == ')')) {
797 Parm->Type = TYPE_LONG;
799 while ((pch <= pe) &&
806 StrBufPeek(Buf, pch, -1, '\0');
807 Parm->lvalue = atol(pchs);
814 syslog(1, "Error (in '%s' line %ld); "
815 "evaluating long template param [%s] in Token [%s]\n",
816 ChrPtr(pTmpl->FileName),
818 ChrPtr(Tokens->FlatToken),
826 while ((*pch == ' ' )||
830 (*pch == '\n')) pch ++;
835 if (DumpTemplateI18NStrings) {
836 StrBufAppendPrintf(I18nDump, "_(\"%s\");\n", Parm->Start);
839 case TYPE_INTDEFINE: {
842 if (GetHash(Defines, Parm->Start, Parm->len, &vPVal) &&
846 PVal = (long*) vPVal;
848 Parm->lvalue = *PVal;
850 else if (strchr(Parm->Start, '|') != NULL)
857 pToken = NewStrBufPlain (Parm->Start, Parm->len);
858 Match = NewStrBufPlain (NULL, Parm->len);
859 Pos = ChrPtr(pToken);
861 while ((Pos != NULL) && (Pos != StrBufNOTNULL))
863 StrBufExtract_NextToken(Match, pToken, &Pos, '|');
865 if (StrLength (Match) > 0)
867 if (GetHash(Defines, SKEY(Match), &vPVal) &&
871 PVal = (long*) vPVal;
873 Parm->lvalue |= *PVal;
876 LogTemplateError(NULL, "Define",
888 else if (strchr(Parm->Start, '&') != NULL)
895 pToken = NewStrBufPlain (Parm->Start, Parm->len);
896 Match = NewStrBufPlain (NULL, Parm->len);
897 Pos = ChrPtr(pToken);
899 while ((Pos != NULL) && (Pos != StrBufNOTNULL))
901 StrBufExtract_NextToken(Match, pToken, &Pos, '&');
903 if (StrLength (Match) > 0)
905 if (GetHash(Defines, SKEY(Match), &vPVal) &&
909 PVal = (long*) vPVal;
911 Parm->lvalue |= *PVal;
914 LogTemplateError(NULL, "Define",
929 LogTemplateError(NULL, "Define",
936 case TYPE_SUBTEMPLATE:{
938 /* well, we don't check the mobile stuff here... */
939 if (!GetHash(LocalTemplateCache, Parm->Start, Parm->len, &vTmpl) &&
940 !GetHash(TemplateCache, Parm->Start, Parm->len, &vTmpl)) {
941 LogTemplateError(NULL,
945 "referenced here doesn't exist");
953 WCTemplateToken *NewTemplateSubstitute(StrBuf *Buf,
955 const char *pTokenStart,
956 const char *pTokenEnd,
962 WCTemplateToken *NewToken;
965 NewToken = (WCTemplateToken*)malloc(sizeof(WCTemplateToken));
966 memset(NewToken, 0, sizeof(WCTemplateToken));
967 TP.Tokens = NewToken;
968 NewToken->FileName = pTmpl->FileName; /* to print meaningfull log messages... */
970 NewToken->Line = Line + 1;
971 NewToken->pTokenStart = pTokenStart;
972 NewToken->TokenStart = pTokenStart - pStart;
973 NewToken->TokenEnd = (pTokenEnd - pStart) - NewToken->TokenStart;
974 NewToken->pTokenEnd = pTokenEnd;
975 NewToken->NameEnd = NewToken->TokenEnd - 2;
976 NewToken->PreEval = NULL;
977 NewToken->FlatToken = NewStrBufPlain(pTokenStart + 2, pTokenEnd - pTokenStart - 2);
978 StrBufShrinkToFit(NewToken->FlatToken, 1);
980 StrBufPeek(Buf, pTokenStart, + 1, '\0');
981 StrBufPeek(Buf, pTokenEnd, -1, '\0');
982 pch = NewToken->pName = pTokenStart + 2;
984 NewToken->HaveParameters = 0;;
985 NewToken->nParameters = 0;
987 while (pch < pTokenEnd - 1) {
989 StrBufPeek(Buf, pch, -1, '\0');
990 NewToken->NameEnd = pch - NewToken->pName;
992 if (*(pTokenEnd - 1) != ')') {
994 NULL, "Parseerror", ERR_NAME, &TP,
995 "Warning, Non welformed Token; missing right parenthesis");
997 while (pch < pTokenEnd - 1) {
998 NewToken->nParameters++;
999 if (GetNextParameter(Buf,
1005 &NewToken->Params[NewToken->nParameters - 1]))
1007 NewToken->HaveParameters = 1;
1008 if (NewToken->nParameters >= MAXPARAM) {
1010 NULL, "Parseerror", ERR_NAME, &TP,
1011 "only [%d] Params allowed in Tokens",
1014 FreeToken(&NewToken);
1020 if((NewToken->NameEnd == 1) &&
1021 (NewToken->HaveParameters == 1))
1024 if (*(NewToken->pName) == '_')
1025 NewToken->Flags = SV_GETTEXT;
1026 else if (*(NewToken->pName) == '=')
1027 NewToken->Flags = SV_SUBTEMPL;
1028 else if (*(NewToken->pName) == '%')
1029 NewToken->Flags = SV_CUST_STR_CONDITIONAL;
1030 else if (*(NewToken->pName) == '?')
1031 NewToken->Flags = SV_CONDITIONAL;
1032 else if (*(NewToken->pName) == '!')
1033 NewToken->Flags = SV_NEG_CONDITIONAL;
1039 switch (NewToken->Flags) {
1041 /* If we're able to find out more about the token, do it now while its fresh. */
1042 if (GetHash(GlobalNS, NewToken->pName, NewToken->NameEnd, &vVar)) {
1043 HashHandler *Handler;
1044 Handler = (HashHandler*) vVar;
1045 if ((NewToken->nParameters < Handler->Filter.nMinArgs) ||
1046 (NewToken->nParameters > Handler->Filter.nMaxArgs)) {
1048 NULL, "Token", ERR_NAME, &TP,
1049 "doesn't work with %d params",
1050 NewToken->nParameters);
1054 NewToken->PreEval = Handler;
1055 NewToken->Flags = SV_PREEVALUATED;
1056 if (Handler->PreEvalFunc != NULL)
1057 Handler->PreEvalFunc(NewToken);
1062 if (NewToken->nParameters !=1) {
1064 NULL, "Gettext", ERR_NAME, &TP,
1065 "requires exactly 1 parameter, you gave %d params",
1066 NewToken->nParameters);
1067 NewToken->Flags = 0;
1070 if (DumpTemplateI18NStrings) {
1071 StrBufAppendPrintf(I18nDump, "_(\"%s\");\n", NewToken->Params[0]->Start);
1075 if (NewToken->nParameters != 1) {
1077 NULL, "Subtemplates", ERR_NAME, &TP,
1078 "require exactly 1 parameter, you gave %d params",
1079 NewToken->nParameters);
1084 /* well, we don't check the mobile stuff here... */
1085 if (!GetHash(LocalTemplateCache,
1086 NewToken->Params[0]->Start,
1087 NewToken->Params[0]->len,
1089 !GetHash(TemplateCache,
1090 NewToken->Params[0]->Start,
1091 NewToken->Params[0]->len,
1094 NULL, "SubTemplate", ERR_PARM1, &TP,
1099 case SV_CUST_STR_CONDITIONAL:
1100 case SV_CONDITIONAL:
1101 case SV_NEG_CONDITIONAL:
1102 if (NewToken->nParameters <2) {
1104 NULL, "Conditional", ERR_PARM1, &TP,
1105 "require at least 2 parameters, you gave %d params",
1106 NewToken->nParameters);
1107 NewToken->Flags = 0;
1110 if (NewToken->Params[1]->lvalue == 0) {
1112 NULL, "Conditional", ERR_PARM1, &TP,
1113 "Conditional ID (Parameter 1) mustn't be 0!");
1114 NewToken->Flags = 0;
1117 if (!GetHash(Conditionals,
1118 NewToken->Params[0]->Start,
1119 NewToken->Params[0]->len,
1122 if ((NewToken->Params[0]->len == 1) &&
1123 (NewToken->Params[0]->Start[0] == 'X'))
1126 NULL, "Conditional", ERR_PARM1, &TP,
1129 NewToken->Error = NewStrBuf();
1132 "<pre>\nConditional [%s] (in '%s' line %ld); Not found!\n[%s]\n</pre>\n",
1133 NewToken->Params[0]->Start,
1134 ChrPtr(pTmpl->FileName),
1136 ChrPtr(NewToken->FlatToken));
1140 NewToken->PreEval = vVar;
1152 * \brief Display a variable-substituted template
1153 * \param templatename template file to load
1155 void *prepare_template(StrBuf *filename, StrBuf *Key, HashList *PutThere)
1157 WCTemplate *NewTemplate;
1159 NewTemplate = (WCTemplate *) malloc(sizeof(WCTemplate));
1160 memset(NewTemplate, 0, sizeof(WCTemplate));
1161 NewTemplate->Data = NULL;
1162 NewTemplate->FileName = NewStrBufDup(filename);
1163 StrBufShrinkToFit(NewTemplate->FileName, 1);
1164 NewTemplate->nTokensUsed = 0;
1165 NewTemplate->TokenSpace = 0;
1166 NewTemplate->Tokens = NULL;
1167 NewTemplate->MimeType = NewStrBufPlain(GuessMimeByFilename (SKEY(NewTemplate->FileName)), -1);
1168 if (strstr(ChrPtr(NewTemplate->MimeType), "text") != NULL) {
1169 StrBufAppendBufPlain(NewTemplate->MimeType, HKEY("; charset=utf-8"), 0);
1172 if (strstr(ChrPtr(NewTemplate->MimeType), "text") != NULL) {
1173 StrBufAppendBufPlain(NewTemplate->MimeType, HKEY("; charset=utf-8"), 0);
1176 Put(PutThere, ChrPtr(Key), StrLength(Key), NewTemplate, FreeWCTemplate);
1181 * \brief Display a variable-substituted template
1182 * \param templatename template file to load
1184 void *duplicate_template(WCTemplate *OldTemplate)
1186 WCTemplate *NewTemplate;
1188 NewTemplate = (WCTemplate *) malloc(sizeof(WCTemplate));
1189 memset(NewTemplate, 0, sizeof(WCTemplate));
1190 NewTemplate->Data = NULL;
1191 NewTemplate->FileName = NewStrBufDup(OldTemplate->FileName);
1192 StrBufShrinkToFit(NewTemplate->FileName, 1);
1193 NewTemplate->nTokensUsed = 0;
1194 NewTemplate->TokenSpace = 0;
1195 NewTemplate->Tokens = NULL;
1196 NewTemplate->MimeType = NewStrBufDup(OldTemplate->MimeType);
1201 * \brief Display a variable-substituted template
1202 * \param templatename template file to load
1204 void *load_template(WCTemplate *NewTemplate)
1207 struct stat statbuf;
1208 const char *pS, *pE, *pch, *Err;
1212 fd = open(ChrPtr(NewTemplate->FileName), O_RDONLY);
1214 syslog(1, "ERROR: could not open template '%s' - %s\n",
1215 ChrPtr(NewTemplate->FileName), strerror(errno));
1219 if (fstat(fd, &statbuf) == -1) {
1220 syslog(1, "ERROR: could not stat template '%s' - %s\n",
1221 ChrPtr(NewTemplate->FileName), strerror(errno));
1225 NewTemplate->Data = NewStrBufPlain(NULL, statbuf.st_size + 1);
1226 if (StrBufReadBLOB(NewTemplate->Data, &fd, 1, statbuf.st_size, &Err) < 0) {
1228 syslog(1, "ERROR: reading template '%s' - %s<br>\n",
1229 ChrPtr(NewTemplate->FileName), strerror(errno));
1230 //FreeWCTemplate(NewTemplate);/////tODO
1236 StrBufShrinkToFit(NewTemplate->Data, 1);
1237 StrBufShrinkToFit(NewTemplate->MimeType, 1);
1238 pS = pch = ChrPtr(NewTemplate->Data);
1239 pE = pS + StrLength(NewTemplate->Data);
1241 const char *pts, *pte;
1243 int InDoubleQuotes = 0;
1246 /** Find one <? > */
1248 for (; pch < pE; pch ++) {
1249 if ((*pch=='<')&&(*(pch + 1)=='?') &&
1250 !((pch == pS) && /* we must ommit a <?xml */
1251 (*(pch + 2) == 'x') &&
1252 (*(pch + 3) == 'm') &&
1253 (*(pch + 4) == 'l')))
1255 if (*pch=='\n') Line ++;
1261 /** Found one? parse it. */
1262 for (; pch <= pE - 1; pch ++) {
1264 InDoubleQuotes = ! InDoubleQuotes;
1265 else if (*pch == '\'')
1266 InQuotes = ! InQuotes;
1267 else if ((!InQuotes && !InDoubleQuotes) &&
1268 ((*pch!='\\')&&(*(pch + 1)=='>'))) {
1276 pv = NewTemplateSubstitute(NewTemplate->Data, pS, pts, pte, Line, NewTemplate);
1278 PutNewToken(NewTemplate, pv);
1286 const char* PrintTemplate(void *vSubst)
1288 WCTemplate *Tmpl = vSubst;
1290 return ChrPtr(Tmpl->FileName);
1294 int LoadTemplateDir(const StrBuf *DirName, HashList *big, const StrBuf *BaseKey)
1300 StrBuf *SubDirectory;
1301 DIR *filedir = NULL;
1302 struct dirent *filedir_entry;
1308 d = (struct dirent *)malloc(offsetof(struct dirent, d_name) + PATH_MAX + 1);
1313 filedir = opendir (ChrPtr(DirName));
1314 if (filedir == NULL) {
1319 Toplevel = StrLength(BaseKey) == 0;
1320 SubDirectory = NewStrBuf();
1321 SubKey = NewStrBuf();
1322 FileName = NewStrBufPlain(NULL, PATH_MAX);
1324 while ((readdir_r(filedir, d, &filedir_entry) == 0) &&
1325 (filedir_entry != NULL))
1329 #ifdef _DIRENT_HAVE_D_NAMELEN
1330 d_namelen = filedir_entry->d_namelen;
1331 d_type = filedir_entry->d_type;
1335 #define DT_UNKNOWN 0
1340 #define IFTODT(mode) (((mode) & 0170000) >> 12)
1341 #define DTTOIF(dirtype) ((dirtype) << 12)
1343 d_namelen = strlen(filedir_entry->d_name);
1344 d_type = DT_UNKNOWN;
1346 d_without_ext = d_namelen;
1348 if ((d_namelen > 1) && filedir_entry->d_name[d_namelen - 1] == '~')
1349 continue; /* Ignore backup files... */
1351 if ((d_namelen == 1) &&
1352 (filedir_entry->d_name[0] == '.'))
1355 if ((d_namelen == 2) &&
1356 (filedir_entry->d_name[0] == '.') &&
1357 (filedir_entry->d_name[1] == '.'))
1360 if (d_type == DT_UNKNOWN) {
1362 char path[PATH_MAX];
1363 snprintf(path, PATH_MAX, "%s/%s",
1364 ChrPtr(DirName), filedir_entry->d_name);
1365 if (stat(path, &s) == 0) {
1366 d_type = IFTODT(s.st_mode);
1372 /* Skip directories we are not interested in... */
1373 if (strcmp(filedir_entry->d_name, ".svn") == 0)
1376 FlushStrBuf(SubKey);
1378 /* If we're not toplevel, the upper dirs count as foo_bar_<local name>*/
1379 StrBufAppendBuf(SubKey, BaseKey, 0);
1380 StrBufAppendBufPlain(SubKey, HKEY("_"), 0);
1382 StrBufAppendBufPlain(SubKey, filedir_entry->d_name, d_namelen, 0);
1384 FlushStrBuf(SubDirectory);
1385 StrBufAppendBuf(SubDirectory, DirName, 0);
1386 if (ChrPtr(SubDirectory)[StrLength(SubDirectory) - 1] != '/')
1387 StrBufAppendBufPlain(SubDirectory, HKEY("/"), 0);
1388 StrBufAppendBufPlain(SubDirectory, filedir_entry->d_name, d_namelen, 0);
1390 LoadTemplateDir(SubDirectory, big, SubKey);
1393 case DT_LNK: /* TODO: check whether its a file or a directory */
1397 while ((d_without_ext > 0) && (filedir_entry->d_name[d_without_ext] != '.'))
1399 if ((d_without_ext == 0) || (d_namelen < 3))
1401 if (((d_namelen > 1) && filedir_entry->d_name[d_namelen - 1] == '~') ||
1402 (strcmp(&filedir_entry->d_name[d_without_ext], ".orig") == 0) ||
1403 (strcmp(&filedir_entry->d_name[d_without_ext], ".swp") == 0))
1404 continue; /* Ignore backup files... */
1405 PStart = filedir_entry->d_name;
1406 StrBufPrintf(FileName, "%s/%s", ChrPtr(DirName), filedir_entry->d_name);
1407 MinorPtr = strchr(filedir_entry->d_name, '.');
1408 if (MinorPtr != NULL)
1412 /* If we're not toplevel, the upper dirs count as foo_bar_<local name>*/
1413 StrBufAppendBuf(Key, BaseKey, 0);
1414 StrBufAppendBufPlain(Key, HKEY("_"), 0);
1416 StrBufAppendBufPlain(Key, filedir_entry->d_name, MinorPtr - filedir_entry->d_name, 0);
1418 if (LoadTemplates >= 1)
1419 syslog(1, "%s %s\n", ChrPtr(FileName), ChrPtr(Key));
1420 prepare_template(FileName, Key, big);
1427 FreeStrBuf(&FileName);
1429 FreeStrBuf(&SubDirectory);
1430 FreeStrBuf(&SubKey);
1434 void InitTemplateCache(void)
1439 HashList *Templates[2];
1444 /* Primary Template set... */
1445 StrBufPrintf(Dir, "%s/t", static_dirs[0]);
1446 LoadTemplateDir(Dir,
1450 /* User local Template set */
1451 StrBufPrintf(Dir, "%s/t", static_dirs[1]);
1452 LoadTemplateDir(Dir,
1456 /* Debug Templates, just to be loaded while debugging. */
1458 StrBufPrintf(Dir, "%s/dbg", static_dirs[0]);
1459 LoadTemplateDir(Dir,
1462 Templates[0] = TemplateCache;
1463 Templates[1] = LocalTemplateCache;
1466 if (LoadTemplates == 0)
1467 for (i=0; i < 2; i++) {
1473 At = GetNewHashPos(Templates[i], 0);
1474 while (GetNextHashPos(Templates[i],
1479 (vTemplate != NULL))
1481 load_template((WCTemplate *)vTemplate);
1493 /*-----------------------------------------------------------------------------
1494 * Filling & processing Templates
1497 * \brief executes one token
1498 * \param Target buffer to append to
1499 * \param Token da to process.
1500 * \param Template we're iterating
1501 * \param Context Contextpoointer to pass in
1502 * \param state are we in conditional state?
1503 * \param ContextType what type of information does context giv us?
1505 int EvaluateToken(StrBuf *Target, int state, WCTemplputParams *TP)
1507 const char *AppendMe;
1509 HashHandler *Handler;
1512 /* much output, since pName is not terminated...
1513 syslog(1,"Doing token: %s\n",Token->pName);
1516 switch (TP->Tokens->Flags) {
1518 TmplGettext(Target, TP);
1520 case SV_CONDITIONAL: /** Forward conditional evaluation */
1521 return EvaluateConditional(Target, 1, state, TP);
1523 case SV_NEG_CONDITIONAL: /** Reverse conditional evaluation */
1524 return EvaluateConditional(Target, 0, state, TP);
1526 case SV_CUST_STR_CONDITIONAL: /** Conditional put custom strings from params */
1527 if (TP->Tokens->nParameters >= 6) {
1528 if (EvaluateConditional(Target, 0, state, TP)) {
1529 GetTemplateTokenString(Target, TP, 5, &AppendMe, &AppendMeLen);
1530 StrBufAppendBufPlain(Target,
1536 GetTemplateTokenString(Target, TP, 4, &AppendMe, &AppendMeLen);
1537 StrBufAppendBufPlain(Target,
1545 Target, "Conditional", ERR_NAME, TP,
1546 "needs at least 6 Params!");
1550 if (TP->Tokens->nParameters == 1)
1551 DoTemplate(TKEY(0), Target, TP);
1553 case SV_PREEVALUATED:
1554 Handler = (HashHandler*) TP->Tokens->PreEval;
1555 if (!CheckContext(Target, &Handler->Filter, TP, "Token")) {
1558 Handler->HandlerFunc(Target, TP);
1561 if (GetHash(GlobalNS, TP->Tokens->pName, TP->Tokens->NameEnd, &vVar)) {
1562 Handler = (HashHandler*) vVar;
1563 if (!CheckContext(Target, &Handler->Filter, TP, "Token")) {
1567 Handler->HandlerFunc(Target, TP);
1572 Target, "Token UNKNOWN", ERR_NAME, TP,
1573 "You've specified a token that isn't known to webcit.!");
1581 const StrBuf *ProcessTemplate(WCTemplate *Tmpl, StrBuf *Target, WCTemplputParams *CallingTP)
1583 WCTemplate *pTmpl = Tmpl;
1586 const char *pData, *pS;
1588 WCTemplputParams TP;
1590 memcpy(&TP.Filter, &CallingTP->Filter, sizeof(ContextFilter));
1592 TP.Context = CallingTP->Context;
1593 TP.ControlContext = CallingTP->ControlContext;
1595 if (LoadTemplates != 0) {
1596 if (LoadTemplates > 1)
1597 syslog(1, "DBG: ----- loading: [%s] ------ \n",
1598 ChrPtr(Tmpl->FileName));
1599 pTmpl = duplicate_template(Tmpl);
1600 if(load_template(pTmpl) == NULL) {
1603 "<pre>\nError loading Template [%s]\n See Logfile for details\n</pre>\n",
1604 ChrPtr(Tmpl->FileName));
1605 FreeWCTemplate(pTmpl);
1611 pS = pData = ChrPtr(pTmpl->Data);
1612 len = StrLength(pTmpl->Data);
1616 if (i >= pTmpl->nTokensUsed) {
1617 StrBufAppendBufPlain(Target,
1619 len - (pData - pS), 0);
1623 StrBufAppendBufPlain(
1625 pTmpl->Tokens[i]->pTokenStart - pData, 0);
1626 TP.Tokens = pTmpl->Tokens[i];
1627 TP.nArgs = pTmpl->Tokens[i]->nParameters;
1628 state = EvaluateToken(Target, state, &TP);
1630 while ((state != 0) && (i+1 < pTmpl->nTokensUsed)) {
1631 /* condition told us to skip till its end condition */
1633 TP.Tokens = pTmpl->Tokens[i];
1634 TP.nArgs = pTmpl->Tokens[i]->nParameters;
1635 if ((pTmpl->Tokens[i]->Flags == SV_CONDITIONAL) ||
1636 (pTmpl->Tokens[i]->Flags == SV_NEG_CONDITIONAL)) {
1637 if (state == EvaluateConditional(
1639 pTmpl->Tokens[i]->Flags,
1645 pData = pTmpl->Tokens[i++]->pTokenEnd + 1;
1646 if (i > pTmpl->nTokensUsed)
1650 if (LoadTemplates != 0) {
1651 FreeWCTemplate(pTmpl);
1653 return Tmpl->MimeType;
1658 * \brief Display a variable-substituted template
1659 * \param templatename template file to load
1660 * \returns the mimetype of the template its doing
1662 const StrBuf *DoTemplate(const char *templatename, long len, StrBuf *Target, WCTemplputParams *TP)
1664 WCTemplputParams LocalTP;
1666 HashList *StaticLocal;
1672 memset(&LocalTP, 0, sizeof(WCTemplputParams));
1676 Static = TemplateCache;
1677 StaticLocal = LocalTemplateCache;
1681 syslog(1, "Can't to load a template with empty name!\n");
1682 StrBufAppendPrintf(Target, "<pre>\nCan't to load a template with empty name!\n</pre>");
1686 if (!GetHash(StaticLocal, templatename, len, &vTmpl) &&
1687 !GetHash(Static, templatename, len, &vTmpl)) {
1688 syslog(1, "didn't find Template [%s] %ld %ld\n", templatename, len , (long)strlen(templatename));
1689 StrBufAppendPrintf(Target, "<pre>\ndidn't find Template [%s] %ld %ld\n</pre>",
1691 (long)strlen(templatename));
1693 dbg_PrintHash(Static, PrintTemplate, NULL);
1694 PrintHash(Static, VarPrintTransition, PrintTemplate);
1700 return ProcessTemplate(vTmpl, Target, TP);
1705 void tmplput_Comment(StrBuf *Target, WCTemplputParams *TP)
1707 if (LoadTemplates != 0)
1713 GetTemplateTokenString(Target, TP, 0, &pch, &len);
1714 Comment = NewStrBufPlain(pch, len);
1715 StrBufAppendBufPlain(Target, HKEY("<!--"), 0);
1716 StrBufAppendTemplate(Target, TP, Comment, 1);
1717 StrBufAppendBufPlain(Target, HKEY("-->"), 0);
1718 FreeStrBuf(&Comment);
1722 /*-----------------------------------------------------------------------------
1725 typedef struct _HashIterator {
1726 HashList *StaticList;
1727 int AdditionalParams;
1729 int XPectContextType;
1731 RetrieveHashlistFunc GetHash;
1732 HashDestructorFunc Destructor;
1733 SubTemplFunc DoSubTemplate;
1736 void RegisterITERATOR(const char *Name, long len,
1737 int AdditionalParams,
1738 HashList *StaticList,
1739 RetrieveHashlistFunc GetHash,
1740 SubTemplFunc DoSubTempl,
1741 HashDestructorFunc Destructor,
1743 int XPectContextType,
1748 It = (HashIterator*)malloc(sizeof(HashIterator));
1749 memset(It, 0, sizeof(HashIterator));
1750 It->StaticList = StaticList;
1751 It->AdditionalParams = AdditionalParams;
1752 It->GetHash = GetHash;
1753 It->DoSubTemplate = DoSubTempl;
1754 It->Destructor = Destructor;
1755 It->ContextType = ContextType;
1756 It->XPectContextType = XPectContextType;
1758 Put(Iterators, Name, len, It, NULL);
1761 typedef struct _iteratestruct {
1770 int preeval_iterate(WCTemplateToken *Token)
1772 WCTemplputParams TPP;
1773 WCTemplputParams *TP;
1778 memset(&TPP, 0, sizeof(WCTemplputParams));
1781 if (!GetHash(Iterators, TKEY(0), &vIt)) {
1783 NULL, "Iterator", ERR_PARM1, TP,
1787 if (TP->Tokens->Params[1]->Type != TYPE_SUBTEMPLATE) {
1788 LogTemplateError(NULL, "Iterator", ERR_PARM1, TP,
1789 "Need token with type Subtemplate as param 1, have %s",
1790 TP->Tokens->Params[1]->Start);
1793 /* well, we don't check the mobile stuff here... */
1794 if (!GetHash(LocalTemplateCache, TKEY(1), &vTmpl) &&
1795 !GetHash(TemplateCache, TKEY(1), &vTmpl)) {
1796 LogTemplateError(NULL, "SubTemplate", ERR_PARM1, TP,
1797 "referenced here doesn't exist");
1799 Token->Preeval2 = vIt;
1800 It = (HashIterator *) vIt;
1802 if (TP->Tokens->nParameters < It->AdditionalParams + 2) {
1804 NULL, "Iterator", ERR_PARM1, TP,
1805 "doesn't work with %d params",
1806 TP->Tokens->nParameters);
1813 void tmpl_iterate_subtmpl(StrBuf *Target, WCTemplputParams *TP)
1818 SortStruct *SortBy = NULL;
1820 int DetectGroupChange = 0;
1823 void *vLastContext = NULL;
1825 WCTemplputParams SubTP;
1826 IterateStruct Status;
1832 memset(&Status, 0, sizeof(IterateStruct));
1833 memcpy (&SubTP, &TP, sizeof(WCTemplputParams));
1835 It = (HashIterator*) TP->Tokens->Preeval2;
1838 Target, "Iterator", ERR_PARM1, TP, "Unknown!");
1842 if (TP->Tokens->nParameters < It->AdditionalParams + 2) {
1844 Target, "Iterator", ERR_PARM1, TP,
1845 "doesn't work with %d params",
1846 TP->Tokens->nParameters - 1);
1850 if ((It->XPectContextType != CTX_NONE) &&
1851 (It->XPectContextType != TP->Filter.ContextType)) {
1853 Target, "Iterator", ERR_PARM1, TP,
1854 "requires context of type %s, have %s",
1855 ContextName(It->XPectContextType),
1856 ContextName(TP->Filter.ContextType));
1861 if (It->StaticList == NULL)
1862 List = It->GetHash(Target, TP);
1864 List = It->StaticList;
1866 DetectGroupChange = (It->Flags & IT_FLAG_DETECT_GROUPCHANGE) != 0;
1867 if (DetectGroupChange) {
1868 const StrBuf *BSort;
1869 DetectGroupChange = 0;
1870 if (havebstr("SortBy")) {
1871 BSort = sbstr("SortBy");
1872 if (GetHash(SortHash, SKEY(BSort), &vSortBy) &&
1873 (vSortBy != NULL)) {
1874 SortBy = (SortStruct*)vSortBy;
1875 /* first check whether its intended for us... */
1876 if ((SortBy->ContextType == It->ContextType)&&
1877 /** Ok, its us, lets see in which direction we should sort... */
1878 (havebstr("SortOrder"))) {
1880 SortOrder = LBSTR("SortOrder");
1882 DetectGroupChange = 1;
1887 nMembersUsed = GetCount(List);
1888 SubBuf = NewStrBuf();
1889 SubTP.Filter.ContextType = It->ContextType;
1890 SubTP.Filter.ControlContextType = CTX_ITERATE;
1891 SubTP.ControlContext = &Status;
1893 if (HAVE_PARAM(2)) {
1894 StartAt = GetTemplateTokenNumber(Target, TP, 2, 0);
1896 if (HAVE_PARAM(3)) {
1897 StepWidth = GetTemplateTokenNumber(Target, TP, 3, 0);
1899 if (HAVE_PARAM(4)) {
1900 StopAt = GetTemplateTokenNumber(Target, TP, 4, -1);
1902 it = GetNewHashPos(List, StepWidth);
1904 StopAt = GetCount(List);
1906 while (GetNextHashPos(List, it, &Status.KeyLen, &Status.Key, &vContext)) {
1907 if ((Status.n >= StartAt) && (Status.n <= StopAt)) {
1908 if (DetectGroupChange && Status.n > 0) {
1909 Status.GroupChange = SortBy->GroupChange(vContext, vLastContext);
1911 Status.LastN = (Status.n + 1) == nMembersUsed;
1912 SubTP.Context = vContext;
1913 if (It->DoSubTemplate != NULL)
1914 It->DoSubTemplate(SubBuf, &SubTP);
1915 DoTemplate(TKEY(1), SubBuf, &SubTP);
1917 StrBufAppendBuf(Target, SubBuf, 0);
1918 FlushStrBuf(SubBuf);
1919 Status.oddeven = ! Status.oddeven;
1920 vLastContext = vContext;
1924 FreeStrBuf(&SubBuf);
1926 if (It->Destructor != NULL)
1927 It->Destructor(&List);
1931 int conditional_ITERATE_ISGROUPCHANGE(StrBuf *Target, WCTemplputParams *TP)
1933 IterateStruct *Ctx = CCTX;
1934 if (TP->Tokens->nParameters < 3)
1935 return Ctx->GroupChange;
1937 return TP->Tokens->Params[2]->lvalue == Ctx->GroupChange;
1940 void tmplput_ITERATE_ODDEVEN(StrBuf *Target, WCTemplputParams *TP)
1942 IterateStruct *Ctx = CCTX;
1944 StrBufAppendBufPlain(Target, HKEY("odd"), 0);
1946 StrBufAppendBufPlain(Target, HKEY("even"), 0);
1950 void tmplput_ITERATE_KEY(StrBuf *Target, WCTemplputParams *TP)
1952 IterateStruct *Ctx = CCTX;
1954 StrBufAppendBufPlain(Target, Ctx->Key, Ctx->KeyLen, 0);
1958 void tmplput_ITERATE_LASTN(StrBuf *Target, WCTemplputParams *TP)
1960 IterateStruct *Ctx = CCTX;
1961 StrBufAppendPrintf(Target, "%d", Ctx->n);
1964 int conditional_ITERATE_FIRSTN(StrBuf *Target, WCTemplputParams *TP)
1966 IterateStruct *Ctx = CCTX;
1970 int conditional_ITERATE_LASTN(StrBuf *Target, WCTemplputParams *TP)
1972 IterateStruct *Ctx = CCTX;
1978 /*-----------------------------------------------------------------------------
1981 int EvaluateConditional(StrBuf *Target, int Neg, int state, WCTemplputParams *TP)
1983 ConditionalStruct *Cond;
1987 if ((TP->Tokens->Params[0]->len == 1) &&
1988 (TP->Tokens->Params[0]->Start[0] == 'X'))
1989 return (state != 0)?TP->Tokens->Params[1]->lvalue:0;
1991 Cond = (ConditionalStruct *) TP->Tokens->PreEval;
1994 Target, "Conditional", ERR_PARM1, TP,
1999 if (!CheckContext(Target, &Cond->Filter, TP, "Conditional")) {
2002 res = Cond->CondF(Target, TP);
2004 rc = TP->Tokens->Params[1]->lvalue;
2005 if (LoadTemplates > 5)
2006 syslog(1, "<%s> : %d %d==%d\n",
2007 ChrPtr(TP->Tokens->FlatToken),
2012 void RegisterConditional(const char *Name, long len,
2014 WCConditionalFunc CondF,
2015 int ContextRequired)
2017 ConditionalStruct *Cond;
2019 Cond = (ConditionalStruct*)malloc(sizeof(ConditionalStruct));
2020 memset(Cond, 0, sizeof(ConditionalStruct));
2021 Cond->PlainName = Name;
2022 Cond->Filter.nMaxArgs = nParams;
2023 Cond->Filter.nMinArgs = nParams;
2024 Cond->CondF = CondF;
2025 Cond->Filter.ContextType = ContextRequired;
2026 Cond->Filter.ControlContextType = CTX_NONE;
2027 Put(Conditionals, Name, len, Cond, NULL);
2030 void RegisterControlConditional(const char *Name, long len,
2032 WCConditionalFunc CondF,
2033 int ControlContextRequired)
2035 ConditionalStruct *Cond;
2037 Cond = (ConditionalStruct*)malloc(sizeof(ConditionalStruct));
2038 memset(Cond, 0, sizeof(ConditionalStruct));
2039 Cond->PlainName = Name;
2040 Cond->Filter.nMaxArgs = nParams;
2041 Cond->Filter.nMinArgs = nParams;
2042 Cond->CondF = CondF;
2043 Cond->Filter.ContextType = CTX_NONE;
2044 Cond->Filter.ControlContextType = ControlContextRequired;
2045 Put(Conditionals, Name, len, Cond, NULL);
2048 void RegisterTokenParamDefine(const char *Name, long len,
2053 PVal = (long*)malloc(sizeof(long));
2055 Put(Defines, Name, len, PVal, NULL);
2058 long GetTokenDefine(const char *Name, long len,
2063 if (GetHash(Defines, Name, len, &vPVal) &&
2066 return *(long*) vPVal;
2074 void tmplput_DefStr(StrBuf *Target, WCTemplputParams *TP)
2078 GetTemplateTokenString(Target, TP, 2, &Str, &len);
2080 StrBufAppendBufPlain(Target, Str, len, 0);
2083 void tmplput_DefVal(StrBuf *Target, WCTemplputParams *TP)
2087 val = GetTemplateTokenNumber(Target, TP, 0, 0);
2088 StrBufAppendPrintf(Target, "%d", val);
2093 /*-----------------------------------------------------------------------------
2096 void tmplput_ContextString(StrBuf *Target, WCTemplputParams *TP)
2098 StrBufAppendTemplate(Target, TP, (StrBuf*)CTX, 0);
2100 int ConditionalContextStr(StrBuf *Target, WCTemplputParams *TP)
2102 StrBuf *TokenText = (StrBuf*) CTX;
2103 const char *CompareToken;
2106 GetTemplateTokenString(Target, TP, 2, &CompareToken, &len);
2107 return strcmp(ChrPtr(TokenText), CompareToken) == 0;
2110 void tmplput_ContextStringArray(StrBuf *Target, WCTemplputParams *TP)
2112 HashList *Arr = (HashList*) CTX;
2116 val = GetTemplateTokenNumber(Target, TP, 0, 0);
2117 if (GetHash(Arr, IKEY(val), &pV) &&
2119 StrBufAppendTemplate(Target, TP, (StrBuf*)pV, 1);
2122 int ConditionalContextStrinArray(StrBuf *Target, WCTemplputParams *TP)
2124 HashList *Arr = (HashList*) CTX;
2127 const char *CompareToken;
2130 GetTemplateTokenString(Target, TP, 2, &CompareToken, &len);
2131 val = GetTemplateTokenNumber(Target, TP, 0, 0);
2132 if (GetHash(Arr, IKEY(val), &pV) &&
2134 return strcmp(ChrPtr((StrBuf*)pV), CompareToken) == 0;
2140 /*-----------------------------------------------------------------------------
2144 void tmpl_do_boxed(StrBuf *Target, WCTemplputParams *TP)
2146 WCTemplputParams SubTP;
2148 StrBuf *Headline = NULL;
2149 if (TP->Tokens->nParameters == 2) {
2150 if (TP->Tokens->Params[1]->Type == TYPE_STR) {
2151 Headline = NewStrBuf();
2152 DoTemplate(TKEY(1), Headline, TP);
2157 GetTemplateTokenString(Target,
2162 Headline = NewStrBufPlain(Ch, len);
2165 /* else TODO error? logging? */
2166 memcpy (&SubTP, TP, sizeof(WCTemplputParams));
2167 SubTP.Context = Headline;
2168 SubTP.Filter.ContextType = CTX_STRBUF;
2169 DoTemplate(HKEY("beginbox"), Target, &SubTP);
2170 DoTemplate(TKEY(0), Target, TP);
2171 DoTemplate(HKEY("endbox"), Target, TP);
2172 FreeStrBuf(&Headline);
2175 /*-----------------------------------------------------------------------------
2179 typedef struct _tab_struct {
2184 int preeval_do_tabbed(WCTemplateToken *Token)
2186 WCTemplputParams TPP;
2187 WCTemplputParams *TP;
2193 memset(&TPP, 0, sizeof(WCTemplputParams));
2196 nTabs = TP->Tokens->nParameters / 2 - 1;
2197 if (TP->Tokens->nParameters % 2 != 0)
2199 LogTemplateError(NULL, "TabbedApi", ERR_PARM1, TP,
2200 "need even number of arguments");
2204 else for (i = 0; i < nTabs; i++) {
2205 if (!HaveTemplateTokenString(NULL,
2210 (TP->Tokens->Params[i * 2]->len == 0))
2212 LogTemplateError(NULL, "TabbedApi", ERR_PARM1, TP,
2213 "Tab-Subject %d needs to be able to produce a string, have %s",
2214 i, TP->Tokens->Params[i * 2]->Start);
2217 if (!HaveTemplateTokenString(NULL,
2222 (TP->Tokens->Params[i * 2 + 1]->len == 0))
2224 LogTemplateError(NULL, "TabbedApi", ERR_PARM1, TP,
2225 "Tab-Content %d needs to be able to produce a string, have %s",
2226 i, TP->Tokens->Params[i * 2 + 1]->Start);
2231 if (!HaveTemplateTokenString(NULL,
2236 (TP->Tokens->Params[i * 2 + 1]->len == 0))
2238 LogTemplateError(NULL, "TabbedApi", ERR_PARM1, TP,
2239 "Tab-Content %d needs to be able to produce a string, have %s",
2240 i, TP->Tokens->Params[i * 2 + 1]->Start);
2247 void tmpl_do_tabbed(StrBuf *Target, WCTemplputParams *TP)
2250 int i, ntabs, nTabs;
2252 WCTemplputParams SubTP;
2254 memset(&TS, 0, sizeof(tab_struct));
2255 memcpy (&SubTP, &TP, sizeof(WCTemplputParams));
2257 nTabs = ntabs = TP->Tokens->nParameters / 2;
2258 TabNames = (StrBuf **) malloc(ntabs * sizeof(StrBuf*));
2259 memset(TabNames, 0, ntabs * sizeof(StrBuf*));
2261 for (i = 0; i < ntabs; i++) {
2262 if ((TP->Tokens->Params[i * 2]->Type == TYPE_STR) &&
2263 (TP->Tokens->Params[i * 2]->len > 0)) {
2264 TabNames[i] = NewStrBuf();
2265 DoTemplate(TKEY(i * 2), TabNames[i], TP);
2267 else if (TP->Tokens->Params[i * 2]->Type == TYPE_GETTEXT) {
2270 GetTemplateTokenString(Target,
2275 TabNames[i] = NewStrBufPlain(Ch, -1);
2278 /** A Tab without subject? we can't count that, add it as silent */
2282 memcpy (&SubTP, TP, sizeof(WCTemplputParams));
2283 SubTP.Filter.ControlContextType = CTX_TAB;
2284 SubTP.ControlContext = &TS;
2286 StrTabbedDialog(Target, nTabs, TabNames);
2287 for (i = 0; i < ntabs; i++) {
2288 memset(&TS, 0, sizeof(tab_struct));
2290 TS.TabTitle = TabNames[i];
2291 StrBeginTab(Target, i, nTabs, TabNames);
2292 DoTemplate(TKEY(i * 2 + 1), Target, &SubTP);
2293 StrEndTab(Target, i, nTabs);
2295 for (i = 0; i < ntabs; i++)
2296 FreeStrBuf(&TabNames[i]);
2299 void tmplput_TAB_N(StrBuf *Target, WCTemplputParams *TP)
2301 tab_struct *Ctx = CCTX;
2303 StrBufAppendPrintf(Target, "%d", Ctx->CurrentTab);
2306 void tmplput_TAB_TITLE(StrBuf *Target, WCTemplputParams *TP)
2308 tab_struct *Ctx = CCTX;
2309 StrBufAppendTemplate(Target, TP, Ctx->TabTitle, 0);
2312 /*-----------------------------------------------------------------------------
2317 void RegisterSortFunc(const char *name, long len,
2318 const char *prepend, long preplen,
2319 CompareFunc Forward,
2320 CompareFunc Reverse,
2321 CompareFunc GroupChange,
2324 SortStruct *NewSort;
2326 NewSort = (SortStruct*) malloc(sizeof(SortStruct));
2327 memset(NewSort, 0, sizeof(SortStruct));
2328 NewSort->Name = NewStrBufPlain(name, len);
2329 if (prepend != NULL)
2330 NewSort->PrefPrepend = NewStrBufPlain(prepend, preplen);
2332 NewSort->PrefPrepend = NULL;
2333 NewSort->Forward = Forward;
2334 NewSort->Reverse = Reverse;
2335 NewSort->GroupChange = GroupChange;
2336 NewSort->ContextType = ContextType;
2337 if (ContextType == CTX_NONE) {
2338 syslog(1, "sorting requires a context. CTX_NONE won't make it.\n");
2342 Put(SortHash, name, len, NewSort, DestroySortStruct);
2345 CompareFunc RetrieveSort(WCTemplputParams *TP,
2346 const char *OtherPrefix, long OtherPrefixLen,
2347 const char *Default, long ldefault, long DefaultDirection)
2350 const StrBuf *BSort = NULL;
2353 long SortOrder = -1;
2355 if (havebstr("SortBy")) {
2356 BSort = sbstr("SortBy");
2357 if (OtherPrefix == NULL) {
2358 set_room_pref("sort", NewStrBufDup(BSort), 0);
2361 set_X_PREFS(HKEY("sort"), OtherPrefix, OtherPrefixLen, NewStrBufDup(BSort), 0);
2364 else { /** Try to fallback to our remembered values... */
2365 if (OtherPrefix == NULL) {
2366 BSort = get_room_pref("sort");
2369 BSort = get_X_PREFS(HKEY("sort"), OtherPrefix, OtherPrefixLen);
2372 putbstr("SortBy", NewStrBufDup(BSort));
2376 BSort = Buf = NewStrBufPlain(Default, ldefault);
2377 putbstr("SortBy", Buf);
2381 if (!GetHash(SortHash, SKEY(BSort), &vSortBy) ||
2382 (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