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",
117 void DestroySortStruct(void *vSort)
119 SortStruct *Sort = (SortStruct*) vSort;
120 FreeStrBuf(&Sort->Name);
121 FreeStrBuf(&Sort->PrefPrepend);
125 const char *ContextName(int ContextType)
127 if (ContextType < CTX_UNKNOWN)
128 return CtxNames[ContextType];
130 return CtxNames[CTX_UNKNOWN];
133 void LogTemplateError (StrBuf *Target, const char *Type, int ErrorPos, WCTemplputParams *TP, const char *Format, ...)
139 const char *Err = NULL;
144 va_start(arg_ptr, Format);
145 StrBufVAppendPrintf(Error, Format, arg_ptr);
149 case ERR_NAME: /* the main token name... */
150 Err = (TP->Tokens!= NULL)? TP->Tokens->pName:"";
153 Err = ((TP->Tokens!= NULL) &&
154 (TP->Tokens->nParameters > ErrorPos - 1))?
155 TP->Tokens->Params[ErrorPos - 1]->Start : "";
158 if (TP->Tokens != NULL)
160 syslog(1, "%s [%s] (in '%s' line %ld); %s; [%s]\n",
163 ChrPtr(TP->Tokens->FileName),
166 ChrPtr(TP->Tokens->FlatToken));
170 syslog(1, "%s: %s;\n",
185 if (WCC->WFBuf == NULL) WCC->WFBuf = NewStrBuf();
186 if (TP->Tokens != NULL)
191 "<pre>\n%s [%s] (in '%s' line %ld); %s\n[%s]\n</pre>\n",
194 ChrPtr(TP->Tokens->FileName),
197 ChrPtr(TP->Tokens->FlatToken));
199 StrBufPrintf(Info, "%s [%s] %s; [%s]",
203 ChrPtr(TP->Tokens->FlatToken));
206 SerializeJson(WCC->WFBuf, WildFireException(SKEY(TP->Tokens->FileName),
211 SerializeJson(Header, WildFireMessage(SKEY(TP->Tokens->FileName),
223 "<pre>\n%s: %s\n</pre>\n",
227 StrBufPrintf(Info, "%s [%s] %s; [%s]",
231 ChrPtr(TP->Tokens->FlatToken));
232 SerializeJson(WCC->WFBuf, WildFireException(HKEY(__FILE__), __LINE__, Info, 1), 1);
237 if (dbg_backtrace_template_errors)
245 void LogError (StrBuf *Target, const char *Type, const char *Format, ...)
255 va_start(arg_ptr, Format);
256 StrBufVAppendPrintf(Error, Format, arg_ptr);
259 syslog(1, "%s", ChrPtr(Error));
262 if (WCC->WFBuf == NULL) WCC->WFBuf = NewStrBuf();
264 SerializeJson(WCC->WFBuf, WildFireException(Type, strlen(Type),
272 if (dbg_backtrace_template_errors)
278 void RegisterNS(const char *NSName,
282 WCHandlerFunc HandlerFunc,
283 WCPreevalFunc PreevalFunc,
286 HashHandler *NewHandler;
288 NewHandler = (HashHandler*) malloc(sizeof(HashHandler));
289 memset(NewHandler, 0, sizeof(HashHandler));
290 NewHandler->Filter.nMinArgs = nMinArgs;
291 NewHandler->Filter.nMaxArgs = nMaxArgs;
292 NewHandler->Filter.ContextType = ContextRequired;
293 NewHandler->Filter.ControlContextType = CTX_NONE;
295 NewHandler->PreEvalFunc = PreevalFunc;
296 NewHandler->HandlerFunc = HandlerFunc;
297 Put(GlobalNS, NSName, len, NewHandler, NULL);
300 void RegisterControlNS(const char *NSName,
304 WCHandlerFunc HandlerFunc,
305 int ControlContextRequired)
307 HashHandler *NewHandler;
309 NewHandler = (HashHandler*) malloc(sizeof(HashHandler));
310 memset(NewHandler, 0, sizeof(HashHandler));
311 NewHandler->Filter.nMinArgs = nMinArgs;
312 NewHandler->Filter.nMaxArgs = nMaxArgs;
313 NewHandler->Filter.ContextType = CTX_NONE;
314 NewHandler->Filter.ControlContextType = ControlContextRequired;
315 NewHandler->HandlerFunc = HandlerFunc;
316 Put(GlobalNS, NSName, len, NewHandler, NULL);
321 int CheckContext(StrBuf *Target, ContextFilter *Need, WCTemplputParams *TP, const char *ErrType)
323 if ((Need->ContextType != CTX_NONE) &&
324 (Need->ContextType != TP->Filter.ContextType)) {
326 Target, ErrType, ERR_PARM1, TP,
327 " WARNING: requires Context: [%s], have [%s]!",
328 ContextName(Need->ContextType),
329 ContextName(TP->Filter.ContextType));
333 if ((Need->ControlContextType != CTX_NONE) &&
334 (Need->ControlContextType != TP->Filter.ControlContextType)) {
336 Target, ErrType, ERR_PARM1, TP,
337 " WARNING: requires Control Context: [%s], have [%s]!",
338 ContextName(Need->ControlContextType),
339 ContextName(TP->Filter.ControlContextType));
343 if (TP->Tokens->nParameters < Need->nMinArgs) {
344 LogTemplateError(Target, ErrType, ERR_NAME, TP,
345 "needs at least %ld params, have %ld",
347 TP->Tokens->nParameters);
351 else if (TP->Tokens->nParameters > Need->nMaxArgs) {
352 LogTemplateError(Target, ErrType, ERR_NAME, TP,
353 "just needs %ld params, you gave %ld",
355 TP->Tokens->nParameters);
363 void FreeToken(WCTemplateToken **Token)
366 FreeStrBuf(&(*Token)->FlatToken);
367 if ((*Token)->HaveParameters)
368 for (i = 0; i < (*Token)->nParameters; i++)
369 free((*Token)->Params[i]);
376 void FreeWCTemplate(void *vFreeMe)
379 WCTemplate *FreeMe = (WCTemplate*)vFreeMe;
381 if (FreeMe->TokenSpace > 0) {
382 for (i = 0; i < FreeMe->nTokensUsed; i ++) {
383 FreeToken(&FreeMe->Tokens[i]);
385 free(FreeMe->Tokens);
387 FreeStrBuf(&FreeMe->FileName);
388 FreeStrBuf(&FreeMe->Data);
389 FreeStrBuf(&FreeMe->MimeType);
396 * \brief back end for print_value_of() ... does a server command
397 * \param servcmd server command to execute on the citadel server
399 void pvo_do_cmd(StrBuf *Target, StrBuf *servcmd) {
403 serv_puts(ChrPtr(servcmd));
404 len = serv_getln(buf, sizeof buf);
410 StrBufAppendPrintf(Target, "%s\n", &buf[4]);
413 _fmout(Target, "CENTER");
416 StrBufAppendPrintf(Target, "%s\n", &buf[4]);
422 int HaveTemplateTokenString(StrBuf *Target,
423 WCTemplputParams *TP,
428 if (N >= TP->Tokens->nParameters) {
432 switch (TP->Tokens->Params[N]->Type) {
438 case TYPE_SUBTEMPLATE:
447 void GetTemplateTokenString(StrBuf *Target,
448 WCTemplputParams *TP,
454 WCTemplputParams SubTP;
456 if (N >= TP->Tokens->nParameters) {
457 LogTemplateError(Target,
458 "TokenParameter", N, TP,
459 "invalid token %d. this shouldn't have come till here.\n", N);
465 switch (TP->Tokens->Params[N]->Type) {
469 *Value = TP->Tokens->Params[N]->Start;
470 *len = TP->Tokens->Params[N]->len;
473 if (TP->Tokens->Params[N]->len == 0) {
474 LogTemplateError(Target,
475 "TokenParameter", N, TP,
476 "Requesting parameter %d; of type BSTR, empty lookup string not admitted.", N);
481 Buf = (StrBuf*) SBstr(TKEY(N));
482 *Value = ChrPtr(Buf);
483 *len = StrLength(Buf);
486 if (TP->Tokens->Params[N]->len == 0) {
487 LogTemplateError(Target,
488 "TokenParameter", N, TP,
489 "Requesting parameter %d; of type PREFSTR, empty lookup string not admitted.", N);
494 get_PREFERENCE(TKEY(N), &Buf);
495 *Value = ChrPtr(Buf);
496 *len = StrLength(Buf);
499 LogTemplateError(Target,
500 "TokenParameter", N, TP,
501 "Requesting parameter %d; of type LONG, want string.", N);
504 LogTemplateError(Target,
505 "TokenParameter", N, TP,
506 "Requesting parameter %d; of type PREFINT, want string.", N);
509 *Value = _(TP->Tokens->Params[N]->Start);
510 *len = strlen(*Value);
512 case TYPE_SUBTEMPLATE:
513 if (TP->Tokens->Params[N]->len == 0) {
514 LogTemplateError(Target,
515 "TokenParameter", N, TP,
516 "Requesting parameter %d; of type SUBTEMPLATE, empty lookup string not admitted.", N);
522 memset(&SubTP, 0, sizeof(WCTemplputParams *));
523 SubTP.Context = TP->Context;
524 SubTP.Filter.ContextType = TP->Filter.ContextType;
526 DoTemplate(TKEY(N), Buf, &SubTP);
527 *Value = ChrPtr(Buf);
528 *len = StrLength(Buf);
529 /* we can't free it here, so we put it into the subst so its discarded later on. */
530 PutRequestLocalMem(Buf, HFreeStrBuf);
534 LogTemplateError(Target,
535 "TokenParameter", N, TP,
536 "unknown param type %d; [%d]", N, TP->Tokens->Params[N]->Type);
541 long GetTemplateTokenNumber(StrBuf *Target, WCTemplputParams *TP, int N, long dflt)
544 if (N >= TP->Tokens->nParameters) {
545 LogTemplateError(Target,
546 "TokenParameter", N, TP,
547 "invalid token %d. this shouldn't have come till here.\n", N);
552 switch (TP->Tokens->Params[N]->Type) {
555 return atol(TP->Tokens->Params[N]->Start);
558 if (TP->Tokens->Params[N]->len == 0) {
559 LogTemplateError(Target,
560 "TokenParameter", N, TP,
561 "Requesting parameter %d; of type BSTR, empty lookup string not admitted.", N);
564 return LBstr(TKEY(N));
567 LogTemplateError(Target,
568 "TokenParameter", N, TP,
569 "requesting a prefstring in param %d want a number", N);
570 if (TP->Tokens->Params[N]->len == 0) {
571 LogTemplateError(Target,
572 "TokenParameter", N, TP,
573 "Requesting parameter %d; of type PREFSTR, empty lookup string not admitted.", N);
576 if (get_PREF_LONG(TKEY(N), &Ret, dflt))
581 return TP->Tokens->Params[N]->lvalue;
583 if (TP->Tokens->Params[N]->len == 0) {
584 LogTemplateError(Target,
585 "TokenParameter", N, TP,
586 "Requesting parameter %d; of type PREFINT, empty lookup string not admitted.", N);
589 if (get_PREF_LONG(TKEY(N), &Ret, dflt))
593 LogTemplateError(Target,
594 "TokenParameter", N, TP,
595 "requesting a I18N string in param %d; want a number", N);
597 case TYPE_SUBTEMPLATE:
598 LogTemplateError(Target,
599 "TokenParameter", N, TP,
600 "requesting a subtemplate in param %d; not supported for numbers", N);
603 LogTemplateError(Target,
604 "TokenParameter", N, TP,
605 "unknown param type %d; [%d]", N, TP->Tokens->Params[N]->Type);
612 * \brief puts string into the template and computes which escape methon we should use
613 * \param Source the string we should put into the template
614 * \param FormatTypeIndex where should we look for escape types if?
616 void StrBufAppendTemplate(StrBuf *Target,
617 WCTemplputParams *TP,
618 const StrBuf *Source, int FormatTypeIndex)
623 if ((FormatTypeIndex < TP->Tokens->nParameters) &&
624 (TP->Tokens->Params[FormatTypeIndex]->Type == TYPE_STR) &&
625 (TP->Tokens->Params[FormatTypeIndex]->len == 1)) {
626 EscapeAs = *TP->Tokens->Params[FormatTypeIndex]->Start;
633 StrEscAppend(Target, Source, NULL, 0, 2);
636 StrEscAppend(Target, Source, NULL, 0, 0);
639 StrECMAEscAppend(Target, Source, NULL);
642 StrHtmlEcmaEscAppend(Target, Source, NULL, 0, 0);
645 StrBufUrlescAppend(Target, Source, NULL);
648 StrBufAppendBuf(Target, Source, 0);
653 void PutNewToken(WCTemplate *Template, WCTemplateToken *NewToken)
655 if (Template->nTokensUsed + 1 >= Template->TokenSpace) {
656 if (Template->TokenSpace <= 0) {
657 Template->Tokens = (WCTemplateToken**)malloc(
658 sizeof(WCTemplateToken*) * 10);
659 memset(Template->Tokens, 0, sizeof(WCTemplateToken*) * 10);
660 Template->TokenSpace = 10;
663 WCTemplateToken **NewTokens;
665 NewTokens= (WCTemplateToken**) malloc(
666 sizeof(WCTemplateToken*) * Template->TokenSpace * 2);
669 0, sizeof(WCTemplateToken*) * Template->TokenSpace * 2);
673 sizeof(WCTemplateToken*) * Template->nTokensUsed);
675 free(Template->Tokens);
676 Template->TokenSpace *= 2;
677 Template->Tokens = NewTokens;
680 Template->Tokens[(Template->nTokensUsed)++] = NewToken;
683 int GetNextParameter(StrBuf *Buf,
686 WCTemplateToken *Tokens,
688 WCTemplputParams *TP,
689 TemplateParam **pParm)
691 const char *pch = *pCh;
692 const char *pchs, *pche;
697 *pParm = Parm = (TemplateParam *) malloc(sizeof(TemplateParam));
698 memset(Parm, 0, sizeof(TemplateParam));
699 Parm->Type = TYPE_STR;
701 /* Skip leading whitespaces */
702 while ((*pch == ' ' )||
705 (*pch == '\n')) pch ++;
708 Parm->Type = TYPE_PREFSTR;
715 else if (*pch == ';') {
716 Parm->Type = TYPE_PREFINT;
723 else if (*pch == '#') {
724 Parm->Type = TYPE_INTDEFINE;
727 else if (*pch == '_') {
728 Parm->Type = TYPE_GETTEXT;
735 else if (*pch == 'B') {
736 Parm->Type = TYPE_BSTR;
743 else if (*pch == '=') {
744 Parm->Type = TYPE_SUBTEMPLATE;
755 else if (*pch == '\'')
762 ( (pch > pchs) && (*(pch - 1) == '\\'))
768 syslog(1, "Error (in '%s' line %ld); "
769 "evaluating template param [%s] in Token [%s]\n",
770 ChrPtr(pTmpl->FileName),
772 ChrPtr(Tokens->FlatToken),
780 StrBufPeek(Buf, pch, -1, '\0');
781 if (LoadTemplates > 1) {
782 syslog(1, "DBG: got param [%s] %ld %ld\n",
783 pchs, pche - pchs, strlen(pchs));
786 Parm->len = pche - pchs;
787 pch ++; /* move after trailing quote */
788 if (ParamBrace && (*pch == ')')) {
795 Parm->Type = TYPE_LONG;
797 while ((pch <= pe) &&
804 StrBufPeek(Buf, pch, -1, '\0');
805 Parm->lvalue = atol(pchs);
812 syslog(1, "Error (in '%s' line %ld); "
813 "evaluating long template param [%s] in Token [%s]\n",
814 ChrPtr(pTmpl->FileName),
816 ChrPtr(Tokens->FlatToken),
824 while ((*pch == ' ' )||
828 (*pch == '\n')) pch ++;
833 if (DumpTemplateI18NStrings) {
834 StrBufAppendPrintf(I18nDump, "_(\"%s\");\n", Parm->Start);
837 case TYPE_INTDEFINE: {
840 if (GetHash(Defines, Parm->Start, Parm->len, &vPVal) &&
844 PVal = (long*) vPVal;
846 Parm->lvalue = *PVal;
848 else if (strchr(Parm->Start, '|') != NULL)
855 pToken = NewStrBufPlain (Parm->Start, Parm->len);
856 Match = NewStrBufPlain (NULL, Parm->len);
857 Pos = ChrPtr(pToken);
859 while ((Pos != NULL) && (Pos != StrBufNOTNULL))
861 StrBufExtract_NextToken(Match, pToken, &Pos, '|');
863 if (StrLength (Match) > 0)
865 if (GetHash(Defines, SKEY(Match), &vPVal) &&
869 PVal = (long*) vPVal;
871 Parm->lvalue |= *PVal;
874 LogTemplateError(NULL, "Define",
886 else if (strchr(Parm->Start, '&') != NULL)
893 pToken = NewStrBufPlain (Parm->Start, Parm->len);
894 Match = NewStrBufPlain (NULL, Parm->len);
895 Pos = ChrPtr(pToken);
897 while ((Pos != NULL) && (Pos != StrBufNOTNULL))
899 StrBufExtract_NextToken(Match, pToken, &Pos, '&');
901 if (StrLength (Match) > 0)
903 if (GetHash(Defines, SKEY(Match), &vPVal) &&
907 PVal = (long*) vPVal;
909 Parm->lvalue |= *PVal;
912 LogTemplateError(NULL, "Define",
927 LogTemplateError(NULL, "Define",
934 case TYPE_SUBTEMPLATE:{
936 /* well, we don't check the mobile stuff here... */
937 if (!GetHash(LocalTemplateCache, Parm->Start, Parm->len, &vTmpl) &&
938 !GetHash(TemplateCache, Parm->Start, Parm->len, &vTmpl)) {
939 LogTemplateError(NULL,
943 "referenced here doesn't exist");
951 WCTemplateToken *NewTemplateSubstitute(StrBuf *Buf,
953 const char *pTokenStart,
954 const char *pTokenEnd,
960 WCTemplateToken *NewToken;
963 NewToken = (WCTemplateToken*)malloc(sizeof(WCTemplateToken));
964 memset(NewToken, 0, sizeof(WCTemplateToken));
965 TP.Tokens = NewToken;
966 NewToken->FileName = pTmpl->FileName; /* to print meaningfull log messages... */
968 NewToken->Line = Line + 1;
969 NewToken->pTokenStart = pTokenStart;
970 NewToken->TokenStart = pTokenStart - pStart;
971 NewToken->TokenEnd = (pTokenEnd - pStart) - NewToken->TokenStart;
972 NewToken->pTokenEnd = pTokenEnd;
973 NewToken->NameEnd = NewToken->TokenEnd - 2;
974 NewToken->PreEval = NULL;
975 NewToken->FlatToken = NewStrBufPlain(pTokenStart + 2, pTokenEnd - pTokenStart - 2);
976 StrBufShrinkToFit(NewToken->FlatToken, 1);
978 StrBufPeek(Buf, pTokenStart, + 1, '\0');
979 StrBufPeek(Buf, pTokenEnd, -1, '\0');
980 pch = NewToken->pName = pTokenStart + 2;
982 NewToken->HaveParameters = 0;;
983 NewToken->nParameters = 0;
985 while (pch < pTokenEnd - 1) {
987 StrBufPeek(Buf, pch, -1, '\0');
988 NewToken->NameEnd = pch - NewToken->pName;
990 if (*(pTokenEnd - 1) != ')') {
992 NULL, "Parseerror", ERR_NAME, &TP,
993 "Warning, Non welformed Token; missing right parenthesis");
995 while (pch < pTokenEnd - 1) {
996 NewToken->nParameters++;
997 if (GetNextParameter(Buf,
1003 &NewToken->Params[NewToken->nParameters - 1]))
1005 NewToken->HaveParameters = 1;
1006 if (NewToken->nParameters >= MAXPARAM) {
1008 NULL, "Parseerror", ERR_NAME, &TP,
1009 "only [%d] Params allowed in Tokens",
1012 FreeToken(&NewToken);
1018 if((NewToken->NameEnd == 1) &&
1019 (NewToken->HaveParameters == 1))
1022 if (*(NewToken->pName) == '_')
1023 NewToken->Flags = SV_GETTEXT;
1024 else if (*(NewToken->pName) == '=')
1025 NewToken->Flags = SV_SUBTEMPL;
1026 else if (*(NewToken->pName) == '%')
1027 NewToken->Flags = SV_CUST_STR_CONDITIONAL;
1028 else if (*(NewToken->pName) == '?')
1029 NewToken->Flags = SV_CONDITIONAL;
1030 else if (*(NewToken->pName) == '!')
1031 NewToken->Flags = SV_NEG_CONDITIONAL;
1037 switch (NewToken->Flags) {
1039 /* If we're able to find out more about the token, do it now while its fresh. */
1040 if (GetHash(GlobalNS, NewToken->pName, NewToken->NameEnd, &vVar)) {
1041 HashHandler *Handler;
1042 Handler = (HashHandler*) vVar;
1043 if ((NewToken->nParameters < Handler->Filter.nMinArgs) ||
1044 (NewToken->nParameters > Handler->Filter.nMaxArgs)) {
1046 NULL, "Token", ERR_NAME, &TP,
1047 "doesn't work with %d params",
1048 NewToken->nParameters);
1052 NewToken->PreEval = Handler;
1053 NewToken->Flags = SV_PREEVALUATED;
1054 if (Handler->PreEvalFunc != NULL)
1055 Handler->PreEvalFunc(NewToken);
1060 if (NewToken->nParameters !=1) {
1062 NULL, "Gettext", ERR_NAME, &TP,
1063 "requires exactly 1 parameter, you gave %d params",
1064 NewToken->nParameters);
1065 NewToken->Flags = 0;
1068 if (DumpTemplateI18NStrings) {
1069 StrBufAppendPrintf(I18nDump, "_(\"%s\");\n", NewToken->Params[0]->Start);
1073 if (NewToken->nParameters != 1) {
1075 NULL, "Subtemplates", ERR_NAME, &TP,
1076 "require exactly 1 parameter, you gave %d params",
1077 NewToken->nParameters);
1082 /* well, we don't check the mobile stuff here... */
1083 if (!GetHash(LocalTemplateCache,
1084 NewToken->Params[0]->Start,
1085 NewToken->Params[0]->len,
1087 !GetHash(TemplateCache,
1088 NewToken->Params[0]->Start,
1089 NewToken->Params[0]->len,
1092 NULL, "SubTemplate", ERR_PARM1, &TP,
1097 case SV_CUST_STR_CONDITIONAL:
1098 case SV_CONDITIONAL:
1099 case SV_NEG_CONDITIONAL:
1100 if (NewToken->nParameters <2) {
1102 NULL, "Conditional", ERR_PARM1, &TP,
1103 "require at least 2 parameters, you gave %d params",
1104 NewToken->nParameters);
1105 NewToken->Flags = 0;
1108 if (NewToken->Params[1]->lvalue == 0) {
1110 NULL, "Conditional", ERR_PARM1, &TP,
1111 "Conditional ID (Parameter 1) mustn't be 0!");
1112 NewToken->Flags = 0;
1115 if (!GetHash(Conditionals,
1116 NewToken->Params[0]->Start,
1117 NewToken->Params[0]->len,
1120 if ((NewToken->Params[0]->len == 1) &&
1121 (NewToken->Params[0]->Start[0] == 'X'))
1124 NULL, "Conditional", ERR_PARM1, &TP,
1127 NewToken->Error = NewStrBuf();
1130 "<pre>\nConditional [%s] (in '%s' line %ld); Not found!\n[%s]\n</pre>\n",
1131 NewToken->Params[0]->Start,
1132 ChrPtr(pTmpl->FileName),
1134 ChrPtr(NewToken->FlatToken));
1138 NewToken->PreEval = vVar;
1150 * \brief Display a variable-substituted template
1151 * \param templatename template file to load
1153 void *prepare_template(StrBuf *filename, StrBuf *Key, HashList *PutThere)
1155 WCTemplate *NewTemplate;
1157 NewTemplate = (WCTemplate *) malloc(sizeof(WCTemplate));
1158 memset(NewTemplate, 0, sizeof(WCTemplate));
1159 NewTemplate->Data = NULL;
1160 NewTemplate->FileName = NewStrBufDup(filename);
1161 StrBufShrinkToFit(NewTemplate->FileName, 1);
1162 NewTemplate->nTokensUsed = 0;
1163 NewTemplate->TokenSpace = 0;
1164 NewTemplate->Tokens = NULL;
1165 NewTemplate->MimeType = NewStrBufPlain(GuessMimeByFilename (SKEY(NewTemplate->FileName)), -1);
1166 if (strstr(ChrPtr(NewTemplate->MimeType), "text") != NULL) {
1167 StrBufAppendBufPlain(NewTemplate->MimeType, HKEY("; charset=utf-8"), 0);
1170 if (strstr(ChrPtr(NewTemplate->MimeType), "text") != NULL) {
1171 StrBufAppendBufPlain(NewTemplate->MimeType, HKEY("; charset=utf-8"), 0);
1174 Put(PutThere, ChrPtr(Key), StrLength(Key), NewTemplate, FreeWCTemplate);
1179 * \brief Display a variable-substituted template
1180 * \param templatename template file to load
1182 void *duplicate_template(WCTemplate *OldTemplate)
1184 WCTemplate *NewTemplate;
1186 NewTemplate = (WCTemplate *) malloc(sizeof(WCTemplate));
1187 memset(NewTemplate, 0, sizeof(WCTemplate));
1188 NewTemplate->Data = NULL;
1189 NewTemplate->FileName = NewStrBufDup(OldTemplate->FileName);
1190 StrBufShrinkToFit(NewTemplate->FileName, 1);
1191 NewTemplate->nTokensUsed = 0;
1192 NewTemplate->TokenSpace = 0;
1193 NewTemplate->Tokens = NULL;
1194 NewTemplate->MimeType = NewStrBufDup(OldTemplate->MimeType);
1199 * \brief Display a variable-substituted template
1200 * \param templatename template file to load
1202 void *load_template(WCTemplate *NewTemplate)
1205 struct stat statbuf;
1206 const char *pS, *pE, *pch, *Err;
1210 fd = open(ChrPtr(NewTemplate->FileName), O_RDONLY);
1212 syslog(1, "ERROR: could not open template '%s' - %s\n",
1213 ChrPtr(NewTemplate->FileName), strerror(errno));
1217 if (fstat(fd, &statbuf) == -1) {
1218 syslog(1, "ERROR: could not stat template '%s' - %s\n",
1219 ChrPtr(NewTemplate->FileName), strerror(errno));
1223 NewTemplate->Data = NewStrBufPlain(NULL, statbuf.st_size + 1);
1224 if (StrBufReadBLOB(NewTemplate->Data, &fd, 1, statbuf.st_size, &Err) < 0) {
1226 syslog(1, "ERROR: reading template '%s' - %s<br>\n",
1227 ChrPtr(NewTemplate->FileName), strerror(errno));
1228 //FreeWCTemplate(NewTemplate);/////tODO
1234 StrBufShrinkToFit(NewTemplate->Data, 1);
1235 StrBufShrinkToFit(NewTemplate->MimeType, 1);
1236 pS = pch = ChrPtr(NewTemplate->Data);
1237 pE = pS + StrLength(NewTemplate->Data);
1239 const char *pts, *pte;
1241 int InDoubleQuotes = 0;
1244 /** Find one <? > */
1246 for (; pch < pE; pch ++) {
1247 if ((*pch=='<')&&(*(pch + 1)=='?') &&
1248 !((pch == pS) && /* we must ommit a <?xml */
1249 (*(pch + 2) == 'x') &&
1250 (*(pch + 3) == 'm') &&
1251 (*(pch + 4) == 'l')))
1253 if (*pch=='\n') Line ++;
1259 /** Found one? parse it. */
1260 for (; pch <= pE - 1; pch ++) {
1262 InDoubleQuotes = ! InDoubleQuotes;
1263 else if (*pch == '\'')
1264 InQuotes = ! InQuotes;
1265 else if ((!InQuotes && !InDoubleQuotes) &&
1266 ((*pch!='\\')&&(*(pch + 1)=='>'))) {
1274 pv = NewTemplateSubstitute(NewTemplate->Data, pS, pts, pte, Line, NewTemplate);
1276 PutNewToken(NewTemplate, pv);
1284 const char* PrintTemplate(void *vSubst)
1286 WCTemplate *Tmpl = vSubst;
1288 return ChrPtr(Tmpl->FileName);
1292 int LoadTemplateDir(const StrBuf *DirName, HashList *big, const StrBuf *BaseKey)
1298 StrBuf *SubDirectory;
1299 DIR *filedir = NULL;
1300 struct dirent *filedir_entry;
1306 d = (struct dirent *)malloc(offsetof(struct dirent, d_name) + PATH_MAX + 1);
1311 filedir = opendir (ChrPtr(DirName));
1312 if (filedir == NULL) {
1317 Toplevel = StrLength(BaseKey) == 0;
1318 SubDirectory = NewStrBuf();
1319 SubKey = NewStrBuf();
1320 FileName = NewStrBufPlain(NULL, PATH_MAX);
1322 while ((readdir_r(filedir, d, &filedir_entry) == 0) &&
1323 (filedir_entry != NULL))
1327 #ifdef _DIRENT_HAVE_D_NAMELEN
1328 d_namelen = filedir_entry->d_namelen;
1329 d_type = filedir_entry->d_type;
1333 #define DT_UNKNOWN 0
1338 #define IFTODT(mode) (((mode) & 0170000) >> 12)
1339 #define DTTOIF(dirtype) ((dirtype) << 12)
1341 d_namelen = strlen(filedir_entry->d_name);
1342 d_type = DT_UNKNOWN;
1344 d_without_ext = d_namelen;
1346 if ((d_namelen > 1) && filedir_entry->d_name[d_namelen - 1] == '~')
1347 continue; /* Ignore backup files... */
1349 if ((d_namelen == 1) &&
1350 (filedir_entry->d_name[0] == '.'))
1353 if ((d_namelen == 2) &&
1354 (filedir_entry->d_name[0] == '.') &&
1355 (filedir_entry->d_name[1] == '.'))
1358 if (d_type == DT_UNKNOWN) {
1360 char path[PATH_MAX];
1361 snprintf(path, PATH_MAX, "%s/%s",
1362 ChrPtr(DirName), filedir_entry->d_name);
1363 if (stat(path, &s) == 0) {
1364 d_type = IFTODT(s.st_mode);
1370 /* Skip directories we are not interested in... */
1371 if (strcmp(filedir_entry->d_name, ".svn") == 0)
1374 FlushStrBuf(SubKey);
1376 /* If we're not toplevel, the upper dirs count as foo_bar_<local name>*/
1377 StrBufAppendBuf(SubKey, BaseKey, 0);
1378 StrBufAppendBufPlain(SubKey, HKEY("_"), 0);
1380 StrBufAppendBufPlain(SubKey, filedir_entry->d_name, d_namelen, 0);
1382 FlushStrBuf(SubDirectory);
1383 StrBufAppendBuf(SubDirectory, DirName, 0);
1384 if (ChrPtr(SubDirectory)[StrLength(SubDirectory) - 1] != '/')
1385 StrBufAppendBufPlain(SubDirectory, HKEY("/"), 0);
1386 StrBufAppendBufPlain(SubDirectory, filedir_entry->d_name, d_namelen, 0);
1388 LoadTemplateDir(SubDirectory, big, SubKey);
1391 case DT_LNK: /* TODO: check whether its a file or a directory */
1395 while ((d_without_ext > 0) && (filedir_entry->d_name[d_without_ext] != '.'))
1397 if ((d_without_ext == 0) || (d_namelen < 3))
1399 if (((d_namelen > 1) && filedir_entry->d_name[d_namelen - 1] == '~') ||
1400 (strcmp(&filedir_entry->d_name[d_without_ext], ".orig") == 0) ||
1401 (strcmp(&filedir_entry->d_name[d_without_ext], ".swp") == 0))
1402 continue; /* Ignore backup files... */
1403 PStart = filedir_entry->d_name;
1404 StrBufPrintf(FileName, "%s/%s", ChrPtr(DirName), filedir_entry->d_name);
1405 MinorPtr = strchr(filedir_entry->d_name, '.');
1406 if (MinorPtr != NULL)
1410 /* If we're not toplevel, the upper dirs count as foo_bar_<local name>*/
1411 StrBufAppendBuf(Key, BaseKey, 0);
1412 StrBufAppendBufPlain(Key, HKEY("_"), 0);
1414 StrBufAppendBufPlain(Key, filedir_entry->d_name, MinorPtr - filedir_entry->d_name, 0);
1416 if (LoadTemplates >= 1)
1417 syslog(1, "%s %s\n", ChrPtr(FileName), ChrPtr(Key));
1418 prepare_template(FileName, Key, big);
1425 FreeStrBuf(&FileName);
1427 FreeStrBuf(&SubDirectory);
1428 FreeStrBuf(&SubKey);
1432 void InitTemplateCache(void)
1437 HashList *Templates[2];
1442 /* Primary Template set... */
1443 StrBufPrintf(Dir, "%s/t", static_dirs[0]);
1444 LoadTemplateDir(Dir,
1448 /* User local Template set */
1449 StrBufPrintf(Dir, "%s/t", static_dirs[1]);
1450 LoadTemplateDir(Dir,
1454 /* Debug Templates, just to be loaded while debugging. */
1456 StrBufPrintf(Dir, "%s/dbg", static_dirs[0]);
1457 LoadTemplateDir(Dir,
1460 Templates[0] = TemplateCache;
1461 Templates[1] = LocalTemplateCache;
1464 if (LoadTemplates == 0)
1465 for (i=0; i < 2; i++) {
1471 At = GetNewHashPos(Templates[i], 0);
1472 while (GetNextHashPos(Templates[i],
1477 (vTemplate != NULL))
1479 load_template((WCTemplate *)vTemplate);
1491 /*-----------------------------------------------------------------------------
1492 * Filling & processing Templates
1495 * \brief executes one token
1496 * \param Target buffer to append to
1497 * \param Token da to process.
1498 * \param Template we're iterating
1499 * \param Context Contextpoointer to pass in
1500 * \param state are we in conditional state?
1501 * \param ContextType what type of information does context giv us?
1503 int EvaluateToken(StrBuf *Target, int state, WCTemplputParams *TP)
1505 const char *AppendMe;
1507 HashHandler *Handler;
1510 /* much output, since pName is not terminated...
1511 syslog(1,"Doing token: %s\n",Token->pName);
1514 switch (TP->Tokens->Flags) {
1516 TmplGettext(Target, TP);
1518 case SV_CONDITIONAL: /** Forward conditional evaluation */
1519 return EvaluateConditional(Target, 1, state, TP);
1521 case SV_NEG_CONDITIONAL: /** Reverse conditional evaluation */
1522 return EvaluateConditional(Target, 0, state, TP);
1524 case SV_CUST_STR_CONDITIONAL: /** Conditional put custom strings from params */
1525 if (TP->Tokens->nParameters >= 6) {
1526 if (EvaluateConditional(Target, 0, state, TP)) {
1527 GetTemplateTokenString(Target, TP, 5, &AppendMe, &AppendMeLen);
1528 StrBufAppendBufPlain(Target,
1534 GetTemplateTokenString(Target, TP, 4, &AppendMe, &AppendMeLen);
1535 StrBufAppendBufPlain(Target,
1543 Target, "Conditional", ERR_NAME, TP,
1544 "needs at least 6 Params!");
1548 if (TP->Tokens->nParameters == 1)
1549 DoTemplate(TKEY(0), Target, TP);
1551 case SV_PREEVALUATED:
1552 Handler = (HashHandler*) TP->Tokens->PreEval;
1553 if (!CheckContext(Target, &Handler->Filter, TP, "Token")) {
1556 Handler->HandlerFunc(Target, TP);
1559 if (GetHash(GlobalNS, TP->Tokens->pName, TP->Tokens->NameEnd, &vVar)) {
1560 Handler = (HashHandler*) vVar;
1561 if (!CheckContext(Target, &Handler->Filter, TP, "Token")) {
1565 Handler->HandlerFunc(Target, TP);
1570 Target, "Token UNKNOWN", ERR_NAME, TP,
1571 "You've specified a token that isn't known to webcit.!");
1579 const StrBuf *ProcessTemplate(WCTemplate *Tmpl, StrBuf *Target, WCTemplputParams *CallingTP)
1581 WCTemplate *pTmpl = Tmpl;
1584 const char *pData, *pS;
1586 WCTemplputParams TP;
1588 memcpy(&TP.Filter, &CallingTP->Filter, sizeof(ContextFilter));
1590 TP.Context = CallingTP->Context;
1591 TP.ControlContext = CallingTP->ControlContext;
1593 if (LoadTemplates != 0) {
1594 if (LoadTemplates > 1)
1595 syslog(1, "DBG: ----- loading: [%s] ------ \n",
1596 ChrPtr(Tmpl->FileName));
1597 pTmpl = duplicate_template(Tmpl);
1598 if(load_template(pTmpl) == NULL) {
1601 "<pre>\nError loading Template [%s]\n See Logfile for details\n</pre>\n",
1602 ChrPtr(Tmpl->FileName));
1603 FreeWCTemplate(pTmpl);
1609 pS = pData = ChrPtr(pTmpl->Data);
1610 len = StrLength(pTmpl->Data);
1614 if (i >= pTmpl->nTokensUsed) {
1615 StrBufAppendBufPlain(Target,
1617 len - (pData - pS), 0);
1621 StrBufAppendBufPlain(
1623 pTmpl->Tokens[i]->pTokenStart - pData, 0);
1624 TP.Tokens = pTmpl->Tokens[i];
1625 TP.nArgs = pTmpl->Tokens[i]->nParameters;
1626 state = EvaluateToken(Target, state, &TP);
1628 while ((state != 0) && (i+1 < pTmpl->nTokensUsed)) {
1629 /* condition told us to skip till its end condition */
1631 TP.Tokens = pTmpl->Tokens[i];
1632 TP.nArgs = pTmpl->Tokens[i]->nParameters;
1633 if ((pTmpl->Tokens[i]->Flags == SV_CONDITIONAL) ||
1634 (pTmpl->Tokens[i]->Flags == SV_NEG_CONDITIONAL)) {
1635 if (state == EvaluateConditional(
1637 pTmpl->Tokens[i]->Flags,
1643 pData = pTmpl->Tokens[i++]->pTokenEnd + 1;
1644 if (i > pTmpl->nTokensUsed)
1648 if (LoadTemplates != 0) {
1649 FreeWCTemplate(pTmpl);
1651 return Tmpl->MimeType;
1656 * \brief Display a variable-substituted template
1657 * \param templatename template file to load
1658 * \returns the mimetype of the template its doing
1660 const StrBuf *DoTemplate(const char *templatename, long len, StrBuf *Target, WCTemplputParams *TP)
1662 WCTemplputParams LocalTP;
1664 HashList *StaticLocal;
1670 memset(&LocalTP, 0, sizeof(WCTemplputParams));
1674 Static = TemplateCache;
1675 StaticLocal = LocalTemplateCache;
1679 syslog(1, "Can't to load a template with empty name!\n");
1680 StrBufAppendPrintf(Target, "<pre>\nCan't to load a template with empty name!\n</pre>");
1684 if (!GetHash(StaticLocal, templatename, len, &vTmpl) &&
1685 !GetHash(Static, templatename, len, &vTmpl)) {
1686 syslog(1, "didn't find Template [%s] %ld %ld\n", templatename, len , (long)strlen(templatename));
1687 StrBufAppendPrintf(Target, "<pre>\ndidn't find Template [%s] %ld %ld\n</pre>",
1689 (long)strlen(templatename));
1691 dbg_PrintHash(Static, PrintTemplate, NULL);
1692 PrintHash(Static, VarPrintTransition, PrintTemplate);
1698 return ProcessTemplate(vTmpl, Target, TP);
1703 void tmplput_Comment(StrBuf *Target, WCTemplputParams *TP)
1705 if (LoadTemplates != 0)
1711 GetTemplateTokenString(Target, TP, 0, &pch, &len);
1712 Comment = NewStrBufPlain(pch, len);
1713 StrBufAppendBufPlain(Target, HKEY("<!--"), 0);
1714 StrBufAppendTemplate(Target, TP, Comment, 1);
1715 StrBufAppendBufPlain(Target, HKEY("-->"), 0);
1716 FreeStrBuf(&Comment);
1720 /*-----------------------------------------------------------------------------
1723 typedef struct _HashIterator {
1724 HashList *StaticList;
1725 int AdditionalParams;
1727 int XPectContextType;
1729 RetrieveHashlistFunc GetHash;
1730 HashDestructorFunc Destructor;
1731 SubTemplFunc DoSubTemplate;
1734 void RegisterITERATOR(const char *Name, long len,
1735 int AdditionalParams,
1736 HashList *StaticList,
1737 RetrieveHashlistFunc GetHash,
1738 SubTemplFunc DoSubTempl,
1739 HashDestructorFunc Destructor,
1741 int XPectContextType,
1746 It = (HashIterator*)malloc(sizeof(HashIterator));
1747 memset(It, 0, sizeof(HashIterator));
1748 It->StaticList = StaticList;
1749 It->AdditionalParams = AdditionalParams;
1750 It->GetHash = GetHash;
1751 It->DoSubTemplate = DoSubTempl;
1752 It->Destructor = Destructor;
1753 It->ContextType = ContextType;
1754 It->XPectContextType = XPectContextType;
1756 Put(Iterators, Name, len, It, NULL);
1759 typedef struct _iteratestruct {
1768 int preeval_iterate(WCTemplateToken *Token)
1770 WCTemplputParams TPP;
1771 WCTemplputParams *TP;
1776 memset(&TPP, 0, sizeof(WCTemplputParams));
1779 if (!GetHash(Iterators, TKEY(0), &vIt)) {
1781 NULL, "Iterator", ERR_PARM1, TP,
1785 if (TP->Tokens->Params[1]->Type != TYPE_SUBTEMPLATE) {
1786 LogTemplateError(NULL, "Iterator", ERR_PARM1, TP,
1787 "Need token with type Subtemplate as param 1, have %s",
1788 TP->Tokens->Params[1]->Start);
1791 /* well, we don't check the mobile stuff here... */
1792 if (!GetHash(LocalTemplateCache, TKEY(1), &vTmpl) &&
1793 !GetHash(TemplateCache, TKEY(1), &vTmpl)) {
1794 LogTemplateError(NULL, "SubTemplate", ERR_PARM1, TP,
1795 "referenced here doesn't exist");
1797 Token->Preeval2 = vIt;
1798 It = (HashIterator *) vIt;
1800 if (TP->Tokens->nParameters < It->AdditionalParams + 2) {
1802 NULL, "Iterator", ERR_PARM1, TP,
1803 "doesn't work with %d params",
1804 TP->Tokens->nParameters);
1811 void tmpl_iterate_subtmpl(StrBuf *Target, WCTemplputParams *TP)
1816 SortStruct *SortBy = NULL;
1818 int DetectGroupChange = 0;
1821 void *vLastContext = NULL;
1823 WCTemplputParams SubTP;
1824 IterateStruct Status;
1830 memset(&Status, 0, sizeof(IterateStruct));
1831 memcpy (&SubTP, &TP, sizeof(WCTemplputParams));
1833 It = (HashIterator*) TP->Tokens->Preeval2;
1836 Target, "Iterator", ERR_PARM1, TP, "Unknown!");
1840 if (TP->Tokens->nParameters < It->AdditionalParams + 2) {
1842 Target, "Iterator", ERR_PARM1, TP,
1843 "doesn't work with %d params",
1844 TP->Tokens->nParameters - 1);
1848 if ((It->XPectContextType != CTX_NONE) &&
1849 (It->XPectContextType != TP->Filter.ContextType)) {
1851 Target, "Iterator", ERR_PARM1, TP,
1852 "requires context of type %s, have %s",
1853 ContextName(It->XPectContextType),
1854 ContextName(TP->Filter.ContextType));
1859 if (It->StaticList == NULL)
1860 List = It->GetHash(Target, TP);
1862 List = It->StaticList;
1864 DetectGroupChange = (It->Flags & IT_FLAG_DETECT_GROUPCHANGE) != 0;
1865 if (DetectGroupChange) {
1866 const StrBuf *BSort;
1867 DetectGroupChange = 0;
1868 if (havebstr("SortBy")) {
1869 BSort = sbstr("SortBy");
1870 if (GetHash(SortHash, SKEY(BSort), &vSortBy) &&
1871 (vSortBy != NULL)) {
1872 SortBy = (SortStruct*)vSortBy;
1873 /* first check whether its intended for us... */
1874 if ((SortBy->ContextType == It->ContextType)&&
1875 /** Ok, its us, lets see in which direction we should sort... */
1876 (havebstr("SortOrder"))) {
1878 SortOrder = LBSTR("SortOrder");
1880 DetectGroupChange = 1;
1885 nMembersUsed = GetCount(List);
1886 SubBuf = NewStrBuf();
1887 SubTP.Filter.ContextType = It->ContextType;
1888 SubTP.Filter.ControlContextType = CTX_ITERATE;
1889 SubTP.ControlContext = &Status;
1891 if (HAVE_PARAM(2)) {
1892 StartAt = GetTemplateTokenNumber(Target, TP, 2, 0);
1894 if (HAVE_PARAM(3)) {
1895 StepWidth = GetTemplateTokenNumber(Target, TP, 3, 0);
1897 if (HAVE_PARAM(4)) {
1898 StopAt = GetTemplateTokenNumber(Target, TP, 4, -1);
1900 it = GetNewHashPos(List, StepWidth);
1902 StopAt = GetCount(List);
1904 while (GetNextHashPos(List, it, &Status.KeyLen, &Status.Key, &vContext)) {
1905 if ((Status.n >= StartAt) && (Status.n <= StopAt)) {
1906 if (DetectGroupChange && Status.n > 0) {
1907 Status.GroupChange = SortBy->GroupChange(vContext, vLastContext);
1909 Status.LastN = (Status.n + 1) == nMembersUsed;
1910 SubTP.Context = vContext;
1911 if (It->DoSubTemplate != NULL)
1912 It->DoSubTemplate(SubBuf, &SubTP);
1913 DoTemplate(TKEY(1), SubBuf, &SubTP);
1915 StrBufAppendBuf(Target, SubBuf, 0);
1916 FlushStrBuf(SubBuf);
1917 Status.oddeven = ! Status.oddeven;
1918 vLastContext = vContext;
1922 FreeStrBuf(&SubBuf);
1924 if (It->Destructor != NULL)
1925 It->Destructor(&List);
1929 int conditional_ITERATE_ISGROUPCHANGE(StrBuf *Target, WCTemplputParams *TP)
1931 IterateStruct *Ctx = CCTX;
1932 if (TP->Tokens->nParameters < 3)
1933 return Ctx->GroupChange;
1935 return TP->Tokens->Params[2]->lvalue == Ctx->GroupChange;
1938 void tmplput_ITERATE_ODDEVEN(StrBuf *Target, WCTemplputParams *TP)
1940 IterateStruct *Ctx = CCTX;
1942 StrBufAppendBufPlain(Target, HKEY("odd"), 0);
1944 StrBufAppendBufPlain(Target, HKEY("even"), 0);
1948 void tmplput_ITERATE_KEY(StrBuf *Target, WCTemplputParams *TP)
1950 IterateStruct *Ctx = CCTX;
1952 StrBufAppendBufPlain(Target, Ctx->Key, Ctx->KeyLen, 0);
1956 void tmplput_ITERATE_LASTN(StrBuf *Target, WCTemplputParams *TP)
1958 IterateStruct *Ctx = CCTX;
1959 StrBufAppendPrintf(Target, "%d", Ctx->n);
1962 int conditional_ITERATE_FIRSTN(StrBuf *Target, WCTemplputParams *TP)
1964 IterateStruct *Ctx = CCTX;
1968 int conditional_ITERATE_LASTN(StrBuf *Target, WCTemplputParams *TP)
1970 IterateStruct *Ctx = CCTX;
1976 /*-----------------------------------------------------------------------------
1979 int EvaluateConditional(StrBuf *Target, int Neg, int state, WCTemplputParams *TP)
1981 ConditionalStruct *Cond;
1985 if ((TP->Tokens->Params[0]->len == 1) &&
1986 (TP->Tokens->Params[0]->Start[0] == 'X'))
1987 return (state != 0)?TP->Tokens->Params[1]->lvalue:0;
1989 Cond = (ConditionalStruct *) TP->Tokens->PreEval;
1992 Target, "Conditional", ERR_PARM1, TP,
1997 if (!CheckContext(Target, &Cond->Filter, TP, "Conditional")) {
2000 res = Cond->CondF(Target, TP);
2002 rc = TP->Tokens->Params[1]->lvalue;
2003 if (LoadTemplates > 5)
2004 syslog(1, "<%s> : %d %d==%d\n",
2005 ChrPtr(TP->Tokens->FlatToken),
2010 void RegisterConditional(const char *Name, long len,
2012 WCConditionalFunc CondF,
2013 int ContextRequired)
2015 ConditionalStruct *Cond;
2017 Cond = (ConditionalStruct*)malloc(sizeof(ConditionalStruct));
2018 memset(Cond, 0, sizeof(ConditionalStruct));
2019 Cond->PlainName = Name;
2020 Cond->Filter.nMaxArgs = nParams;
2021 Cond->Filter.nMinArgs = nParams;
2022 Cond->CondF = CondF;
2023 Cond->Filter.ContextType = ContextRequired;
2024 Cond->Filter.ControlContextType = CTX_NONE;
2025 Put(Conditionals, Name, len, Cond, NULL);
2028 void RegisterControlConditional(const char *Name, long len,
2030 WCConditionalFunc CondF,
2031 int ControlContextRequired)
2033 ConditionalStruct *Cond;
2035 Cond = (ConditionalStruct*)malloc(sizeof(ConditionalStruct));
2036 memset(Cond, 0, sizeof(ConditionalStruct));
2037 Cond->PlainName = Name;
2038 Cond->Filter.nMaxArgs = nParams;
2039 Cond->Filter.nMinArgs = nParams;
2040 Cond->CondF = CondF;
2041 Cond->Filter.ContextType = CTX_NONE;
2042 Cond->Filter.ControlContextType = ControlContextRequired;
2043 Put(Conditionals, Name, len, Cond, NULL);
2046 void RegisterTokenParamDefine(const char *Name, long len,
2051 PVal = (long*)malloc(sizeof(long));
2053 Put(Defines, Name, len, PVal, NULL);
2056 long GetTokenDefine(const char *Name, long len,
2061 if (GetHash(Defines, Name, len, &vPVal) &&
2064 return *(long*) vPVal;
2072 void tmplput_DefStr(StrBuf *Target, WCTemplputParams *TP)
2076 GetTemplateTokenString(Target, TP, 2, &Str, &len);
2078 StrBufAppendBufPlain(Target, Str, len, 0);
2081 void tmplput_DefVal(StrBuf *Target, WCTemplputParams *TP)
2085 val = GetTemplateTokenNumber(Target, TP, 0, 0);
2086 StrBufAppendPrintf(Target, "%d", val);
2091 /*-----------------------------------------------------------------------------
2094 void tmplput_ContextString(StrBuf *Target, WCTemplputParams *TP)
2096 StrBufAppendTemplate(Target, TP, (StrBuf*)CTX, 0);
2098 int ConditionalContextStr(StrBuf *Target, WCTemplputParams *TP)
2100 StrBuf *TokenText = (StrBuf*) CTX;
2101 const char *CompareToken;
2104 GetTemplateTokenString(Target, TP, 2, &CompareToken, &len);
2105 return strcmp(ChrPtr(TokenText), CompareToken) == 0;
2108 void tmplput_ContextStringArray(StrBuf *Target, WCTemplputParams *TP)
2110 HashList *Arr = (HashList*) CTX;
2114 val = GetTemplateTokenNumber(Target, TP, 0, 0);
2115 if (GetHash(Arr, IKEY(val), &pV) &&
2117 StrBufAppendTemplate(Target, TP, (StrBuf*)pV, 1);
2120 int ConditionalContextStrinArray(StrBuf *Target, WCTemplputParams *TP)
2122 HashList *Arr = (HashList*) CTX;
2125 const char *CompareToken;
2128 GetTemplateTokenString(Target, TP, 2, &CompareToken, &len);
2129 val = GetTemplateTokenNumber(Target, TP, 0, 0);
2130 if (GetHash(Arr, IKEY(val), &pV) &&
2132 return strcmp(ChrPtr((StrBuf*)pV), CompareToken) == 0;
2138 /*-----------------------------------------------------------------------------
2142 void tmpl_do_boxed(StrBuf *Target, WCTemplputParams *TP)
2144 WCTemplputParams SubTP;
2146 StrBuf *Headline = NULL;
2147 if (TP->Tokens->nParameters == 2) {
2148 if (TP->Tokens->Params[1]->Type == TYPE_STR) {
2149 Headline = NewStrBuf();
2150 DoTemplate(TKEY(1), Headline, TP);
2155 GetTemplateTokenString(Target,
2160 Headline = NewStrBufPlain(Ch, len);
2163 /* else TODO error? logging? */
2164 memcpy (&SubTP, TP, sizeof(WCTemplputParams));
2165 SubTP.Context = Headline;
2166 SubTP.Filter.ContextType = CTX_STRBUF;
2167 DoTemplate(HKEY("beginbox"), Target, &SubTP);
2168 DoTemplate(TKEY(0), Target, TP);
2169 DoTemplate(HKEY("endbox"), Target, TP);
2170 FreeStrBuf(&Headline);
2173 /*-----------------------------------------------------------------------------
2177 typedef struct _tab_struct {
2182 int preeval_do_tabbed(WCTemplateToken *Token)
2184 WCTemplputParams TPP;
2185 WCTemplputParams *TP;
2191 memset(&TPP, 0, sizeof(WCTemplputParams));
2194 nTabs = TP->Tokens->nParameters / 2 - 1;
2195 if (TP->Tokens->nParameters % 2 != 0)
2197 LogTemplateError(NULL, "TabbedApi", ERR_PARM1, TP,
2198 "need even number of arguments");
2202 else for (i = 0; i < nTabs; i++) {
2203 if (!HaveTemplateTokenString(NULL,
2208 (TP->Tokens->Params[i * 2]->len == 0))
2210 LogTemplateError(NULL, "TabbedApi", ERR_PARM1, TP,
2211 "Tab-Subject %d needs to be able to produce a string, have %s",
2212 i, TP->Tokens->Params[i * 2]->Start);
2215 if (!HaveTemplateTokenString(NULL,
2220 (TP->Tokens->Params[i * 2 + 1]->len == 0))
2222 LogTemplateError(NULL, "TabbedApi", ERR_PARM1, TP,
2223 "Tab-Content %d needs to be able to produce a string, have %s",
2224 i, TP->Tokens->Params[i * 2 + 1]->Start);
2229 if (!HaveTemplateTokenString(NULL,
2234 (TP->Tokens->Params[i * 2 + 1]->len == 0))
2236 LogTemplateError(NULL, "TabbedApi", ERR_PARM1, TP,
2237 "Tab-Content %d needs to be able to produce a string, have %s",
2238 i, TP->Tokens->Params[i * 2 + 1]->Start);
2245 void tmpl_do_tabbed(StrBuf *Target, WCTemplputParams *TP)
2248 int i, ntabs, nTabs;
2250 WCTemplputParams SubTP;
2252 memset(&TS, 0, sizeof(tab_struct));
2253 memcpy (&SubTP, &TP, sizeof(WCTemplputParams));
2255 nTabs = ntabs = TP->Tokens->nParameters / 2;
2256 TabNames = (StrBuf **) malloc(ntabs * sizeof(StrBuf*));
2257 memset(TabNames, 0, ntabs * sizeof(StrBuf*));
2259 for (i = 0; i < ntabs; i++) {
2260 if ((TP->Tokens->Params[i * 2]->Type == TYPE_STR) &&
2261 (TP->Tokens->Params[i * 2]->len > 0)) {
2262 TabNames[i] = NewStrBuf();
2263 DoTemplate(TKEY(i * 2), TabNames[i], TP);
2265 else if (TP->Tokens->Params[i * 2]->Type == TYPE_GETTEXT) {
2268 GetTemplateTokenString(Target,
2273 TabNames[i] = NewStrBufPlain(Ch, -1);
2276 /** A Tab without subject? we can't count that, add it as silent */
2280 memcpy (&SubTP, TP, sizeof(WCTemplputParams));
2281 SubTP.Filter.ControlContextType = CTX_TAB;
2282 SubTP.ControlContext = &TS;
2284 StrTabbedDialog(Target, nTabs, TabNames);
2285 for (i = 0; i < ntabs; i++) {
2286 memset(&TS, 0, sizeof(tab_struct));
2288 TS.TabTitle = TabNames[i];
2289 StrBeginTab(Target, i, nTabs, TabNames);
2290 DoTemplate(TKEY(i * 2 + 1), Target, &SubTP);
2291 StrEndTab(Target, i, nTabs);
2293 for (i = 0; i < ntabs; i++)
2294 FreeStrBuf(&TabNames[i]);
2297 void tmplput_TAB_N(StrBuf *Target, WCTemplputParams *TP)
2299 tab_struct *Ctx = CCTX;
2301 StrBufAppendPrintf(Target, "%d", Ctx->CurrentTab);
2304 void tmplput_TAB_TITLE(StrBuf *Target, WCTemplputParams *TP)
2306 tab_struct *Ctx = CCTX;
2307 StrBufAppendTemplate(Target, TP, Ctx->TabTitle, 0);
2310 /*-----------------------------------------------------------------------------
2315 void RegisterSortFunc(const char *name, long len,
2316 const char *prepend, long preplen,
2317 CompareFunc Forward,
2318 CompareFunc Reverse,
2319 CompareFunc GroupChange,
2322 SortStruct *NewSort;
2324 NewSort = (SortStruct*) malloc(sizeof(SortStruct));
2325 memset(NewSort, 0, sizeof(SortStruct));
2326 NewSort->Name = NewStrBufPlain(name, len);
2327 if (prepend != NULL)
2328 NewSort->PrefPrepend = NewStrBufPlain(prepend, preplen);
2330 NewSort->PrefPrepend = NULL;
2331 NewSort->Forward = Forward;
2332 NewSort->Reverse = Reverse;
2333 NewSort->GroupChange = GroupChange;
2334 NewSort->ContextType = ContextType;
2335 if (ContextType == CTX_NONE) {
2336 syslog(1, "sorting requires a context. CTX_NONE won't make it.\n");
2340 Put(SortHash, name, len, NewSort, DestroySortStruct);
2343 CompareFunc RetrieveSort(WCTemplputParams *TP,
2344 const char *OtherPrefix, long OtherPrefixLen,
2345 const char *Default, long ldefault, long DefaultDirection)
2348 const StrBuf *BSort = NULL;
2351 long SortOrder = -1;
2353 if (havebstr("SortBy")) {
2354 BSort = sbstr("SortBy");
2355 if (OtherPrefix == NULL) {
2356 set_room_pref("sort", NewStrBufDup(BSort), 0);
2359 set_X_PREFS(HKEY("sort"), OtherPrefix, OtherPrefixLen, NewStrBufDup(BSort), 0);
2362 else { /** Try to fallback to our remembered values... */
2363 if (OtherPrefix == NULL) {
2364 BSort = get_room_pref("sort");
2367 BSort = get_X_PREFS(HKEY("sort"), OtherPrefix, OtherPrefixLen);
2370 putbstr("SortBy", NewStrBufDup(BSort));
2374 BSort = Buf = NewStrBufPlain(Default, ldefault);
2375 putbstr("SortBy", Buf);
2379 if (!GetHash(SortHash, SKEY(BSort), &vSortBy) ||
2380 (vSortBy == NULL)) {
2382 if (!GetHash(SortHash, Default, ldefault, &vSortBy) ||
2383 (vSortBy == NULL)) {
2385 NULL, "Sorting", ERR_PARM1, TP,
2386 "Illegal default sort: [%s]", Default);
2390 SortBy = (SortStruct*)vSortBy;
2392 if (SortBy->ContextType != TP->Filter.ContextType)
2395 /** Ok, its us, lets see in which direction we should sort... */
2396 if (havebstr("SortOrder")) {
2397 SortOrder = LBSTR("SortOrder");
2399 else { /** Try to fallback to our remembered values... */
2401 if (SortBy->PrefPrepend == NULL) {
2402 Buf = get_room_pref("SortOrder");
2403 SortOrder = StrTol(Buf);
2406 BSort = get_X_PREFS(HKEY("SortOrder"), OtherPrefix, OtherPrefixLen);
2410 SortOrder = DefaultDirection;
2412 Buf = NewStrBufPlain(NULL, 64);
2413 StrBufPrintf(Buf, "%ld", SortOrder);
2414 putbstr("SortOrder", Buf);
2416 switch (SortOrder) {
2421 return SortBy->Forward;
2423 return SortBy->Reverse;
2435 ConstStr SortIcons[] = {
2436 {HKEY("static/sort_none.gif")},
2437 {HKEY("static/up_pointer.gif")},
2438 {HKEY("static/down_pointer.gif")},
2441 ConstStr SortNextOrder[] = {
2448 int GetSortMetric(WCTemplputParams *TP, SortStruct **Next, SortStruct **Param, long *SortOrder, int N)
2450 int bSortError = eNOT_SPECIFIED;
2451 const StrBuf *BSort;
2456 if (!GetHash(SortHash, TKEY(0), &vSort) ||
2458 return eNO_SUCH_SORT;
2459 *Param = (SortStruct*) vSort;
2462 if (havebstr("SortBy")) {
2463 BSort = sbstr("SortBy");
2464 bSortError = eINVALID_PARAM;
2465 if ((*Param)->PrefPrepend == NULL) {
2466 set_room_pref("sort", NewStrBufDup(BSort), 0);
2469 set_X_PREFS(HKEY("sort"), TKEY(N), NewStrBufDup(BSort), 0);
2472 else { /** Try to fallback to our remembered values... */
2473 if ((*Param)->PrefPrepend == NULL) {
2474 BSort = get_room_pref("sort");
2477 BSort = get_X_PREFS(HKEY("sort"), TKEY(N));
2481 if (!GetHash(SortHash, SKEY(BSort), &vSort) ||
2485 *Next = (SortStruct*) vSort;
2487 /** Ok, its us, lets see in which direction we should sort... */
2488 if (havebstr("SortOrder")) {
2489 *SortOrder = LBSTR("SortOrder");
2491 else { /** Try to fallback to our remembered values... */
2492 if ((*Param)->PrefPrepend == NULL) {
2493 *SortOrder = StrTol(get_room_pref("SortOrder"));
2496 *SortOrder = StrTol(get_X_PREFS(HKEY("SortOrder"), TKEY(N)));
2506 void tmplput_SORT_ICON(StrBuf *Target, WCTemplputParams *TP)
2511 const ConstStr *SortIcon;
2513 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2516 Target, "Sorter", ERR_PARM1, TP,
2517 " Sorter [%s] unknown!",
2518 TP->Tokens->Params[0]->Start);
2520 case eINVALID_PARAM:
2521 LogTemplateError(NULL, "Sorter", ERR_PARM1, TP,
2522 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2524 case eNOT_SPECIFIED:
2526 if (Next == Param) {
2527 SortIcon = &SortIcons[SortOrder];
2529 else { /** Not Us... */
2530 SortIcon = &SortIcons[0];
2532 StrBufAppendBufPlain(Target, SortIcon->Key, SortIcon->len, 0);
2536 void tmplput_SORT_NEXT(StrBuf *Target, WCTemplputParams *TP)
2542 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2545 Target, "Sorter", ERR_PARM1, TP,
2546 " Sorter [%s] unknown!",
2547 TP->Tokens->Params[0]->Start);
2549 case eINVALID_PARAM:
2551 NULL, "Sorter", ERR_PARM1, TP,
2552 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2554 case eNOT_SPECIFIED:
2556 StrBufAppendBuf(Target, Param->Name, 0);
2561 void tmplput_SORT_ORDER(StrBuf *Target, WCTemplputParams *TP)
2564 const ConstStr *SortOrderStr;
2568 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2571 Target, "Sorter", ERR_PARM1, TP,
2572 " Sorter [%s] unknown!",
2573 TP->Tokens->Params[0]->Start);
2575 case eINVALID_PARAM:
2577 NULL, "Sorter", ERR_PARM1, TP,
2578 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2580 case eNOT_SPECIFIED:
2582 if (Next == Param) {
2583 SortOrderStr = &SortNextOrder[SortOrder];
2585 else { /** Not Us... */
2586 SortOrderStr = &SortNextOrder[0];
2588 StrBufAppendBufPlain(Target, SortOrderStr->Key, SortOrderStr->len, 0);
2593 void tmplput_long_vector(StrBuf *Target, WCTemplputParams *TP)
2595 long *LongVector = (long*) CTX;
2597 if ((TP->Tokens->Params[0]->Type == TYPE_LONG) &&
2598 (TP->Tokens->Params[0]->lvalue <= LongVector[0]))
2600 StrBufAppendPrintf(Target, "%ld", LongVector[TP->Tokens->Params[0]->lvalue]);
2604 if (TP->Tokens->Params[0]->Type != TYPE_LONG) {
2606 Target, "Longvector", ERR_NAME, TP,
2607 "needs a numerical Parameter!");
2611 Target, "LongVector", ERR_PARM1, TP,
2612 "doesn't have %ld Parameters, its just the size of %ld!",
2613 TP->Tokens->Params[0]->lvalue,
2619 void dbg_print_longvector(long *LongVector)
2621 StrBuf *Buf = NewStrBufPlain(HKEY("Longvector: ["));
2622 int nItems = LongVector[0];
2625 for (i = 0; i < nItems; i++) {
2627 StrBufAppendPrintf(Buf, "%d: %ld | ", i, LongVector[i]);
2629 StrBufAppendPrintf(Buf, "%d: %ld]\n", i, LongVector[i]);
2632 syslog(1, "%s", ChrPtr(Buf));
2636 int ConditionalLongVector(StrBuf *Target, WCTemplputParams *TP)
2638 long *LongVector = (long*) CTX;
2640 if ((TP->Tokens->Params[2]->Type == TYPE_LONG) &&
2641 (TP->Tokens->Params[2]->lvalue <= LongVector[0])&&
2642 (TP->Tokens->Params[3]->Type == TYPE_LONG) &&
2643 (TP->Tokens->Params[3]->lvalue <= LongVector[0]))
2645 return LongVector[TP->Tokens->Params[2]->lvalue] ==
2646 LongVector[TP->Tokens->Params[3]->lvalue];
2650 if ((TP->Tokens->Params[2]->Type == TYPE_LONG) ||
2651 (TP->Tokens->Params[2]->Type == TYPE_LONG)) {
2653 Target, "ConditionalLongvector", ERR_PARM1, TP,
2654 "needs two long Parameter!");
2658 Target, "Longvector", ERR_PARM1, TP,
2659 "doesn't have %ld / %ld Parameters, its just the size of %ld!",
2660 TP->Tokens->Params[2]->lvalue,
2661 TP->Tokens->Params[3]->lvalue,
2669 void tmplput_CURRENT_FILE(StrBuf *Target, WCTemplputParams *TP)
2671 StrBufAppendTemplate(Target, TP, TP->Tokens->FileName, 0);
2678 memset(&NoCtx, 0, sizeof(WCTemplputParams));
2679 RegisterNamespace("--", 0, 2, tmplput_Comment, NULL, CTX_NONE);
2680 RegisterNamespace("SORT:ICON", 1, 2, tmplput_SORT_ICON, NULL, CTX_NONE);
2681 RegisterNamespace("SORT:ORDER", 1, 2, tmplput_SORT_ORDER, NULL, CTX_NONE);
2682 RegisterNamespace("SORT:NEXT", 1, 2, tmplput_SORT_NEXT, NULL, CTX_NONE);
2683 RegisterNamespace("CONTEXTSTR", 0, 1, tmplput_ContextString, NULL, CTX_STRBUF);
2684 RegisterNamespace("CONTEXTSTRARR", 1, 2, tmplput_ContextStringArray, NULL, CTX_STRBUFARR);
2685 RegisterNamespace("ITERATE", 2, 100, tmpl_iterate_subtmpl, preeval_iterate, CTX_NONE);
2686 RegisterNamespace("DOBOXED", 1, 2, tmpl_do_boxed, NULL, CTX_NONE);
2687 RegisterNamespace("DOTABBED", 2, 100, tmpl_do_tabbed, preeval_do_tabbed, CTX_NONE);
2688 RegisterControlNS(HKEY("TAB:N"), 0, 0, tmplput_TAB_N, CTX_TAB);
2689 RegisterControlNS(HKEY("TAB:SUBJECT"), 0, 1, tmplput_TAB_TITLE, CTX_TAB);
2692 RegisterNamespace("LONGVECTOR", 1, 1, tmplput_long_vector, NULL, CTX_LONGVECTOR);
2695 RegisterConditional(HKEY("COND:CONTEXTSTR"), 3, ConditionalContextStr, CTX_STRBUF);
2696 RegisterConditional(HKEY("COND:CONTEXTSTRARR"), 4, ConditionalContextStrinArray, CTX_STRBUFARR);
2697 RegisterConditional(HKEY("COND:LONGVECTOR"), 4, ConditionalLongVector, CTX_LONGVECTOR);
2700 RegisterControlConditional(HKEY("COND:ITERATE:ISGROUPCHANGE"), 2,
2701 conditional_ITERATE_ISGROUPCHANGE,
2703 RegisterControlConditional(HKEY("COND:ITERATE:LASTN"), 2,
2704 conditional_ITERATE_LASTN,
2706 RegisterControlConditional(HKEY("COND:ITERATE:FIRSTN"), 2,
2707 conditional_ITERATE_FIRSTN,
2710 RegisterControlNS(HKEY("ITERATE:ODDEVEN"), 0, 0, tmplput_ITERATE_ODDEVEN, CTX_ITERATE);
2711 RegisterControlNS(HKEY("ITERATE:KEY"), 0, 0, tmplput_ITERATE_KEY, CTX_ITERATE);
2712 RegisterControlNS(HKEY("ITERATE:N"), 0, 0, tmplput_ITERATE_LASTN, CTX_ITERATE);
2713 RegisterNamespace("CURRENTFILE", 0, 1, tmplput_CURRENT_FILE, NULL, CTX_NONE);
2714 RegisterNamespace("DEF:STR", 1, 1, tmplput_DefStr, NULL, CTX_NONE);
2715 RegisterNamespace("DEF:VAL", 1, 1, tmplput_DefVal, NULL, CTX_NONE);
2723 ServerStartModule_SUBST
2726 LocalTemplateCache = NewHash(1, NULL);
2727 TemplateCache = NewHash(1, NULL);
2729 GlobalNS = NewHash(1, NULL);
2730 Iterators = NewHash(1, NULL);
2731 Conditionals = NewHash(1, NULL);
2732 SortHash = NewHash(1, NULL);
2733 Defines = NewHash(1, NULL);
2737 FinalizeModule_SUBST
2744 ServerShutdownModule_SUBST
2747 DeleteHash(&TemplateCache);
2748 DeleteHash(&LocalTemplateCache);
2750 DeleteHash(&GlobalNS);
2751 DeleteHash(&Iterators);
2752 DeleteHash(&Conditionals);
2753 DeleteHash(&SortHash);
2754 DeleteHash(&Defines);
2759 SessionNewModule_SUBST
2766 SessionAttachModule_SUBST
2772 SessionDetachModule_SUBST
2775 FreeStrBuf(&sess->WFBuf);
2779 SessionDestroyModule_SUBST