5 * \defgroup Subst Variable substitution type stuff
6 * \ingroup CitadelConfig
12 #include <sys/types.h>
18 #define SHOW_ME_VAPPEND_PRINTF
21 #include "webserver.h"
23 extern char *static_dirs[PATH_MAX]; /**< Disk representation */
25 HashList *WirelessTemplateCache;
26 HashList *WirelessLocalTemplateCache;
27 HashList *TemplateCache;
28 HashList *LocalTemplateCache;
32 HashList *Conditionals;
35 int DumpTemplateI18NStrings = 0;
36 int LoadTemplates = 0;
37 int dbg_bactrace_template_errors = 0;
38 WCTemplputParams NoCtx;
39 StrBuf *I18nDump = NULL;
41 const char EmptyStr[]="";
44 #define SV_CONDITIONAL 2
45 #define SV_NEG_CONDITIONAL 3
46 #define SV_CUST_STR_CONDITIONAL 4
48 #define SV_PREEVALUATED 6
52 * \brief Dynamic content for variable substitution in templates
54 typedef struct _wcsubst {
56 int wcs_type; /* which type of Substitution are we */
57 char wcs_key[32]; /* copy of our hashkey for debugging */
58 StrBuf *wcs_value; /* if we're a string, keep it here */
59 long lvalue; /* type long? keep data here */
60 WCHandlerFunc wcs_function; /* funcion hook ???*/
64 typedef struct _WCTemplate {
70 WCTemplateToken **Tokens;
73 typedef struct _HashHandler {
76 WCHandlerFunc HandlerFunc;
79 void *load_template(StrBuf *filename, StrBuf *Key, HashList *PutThere);
80 int EvaluateConditional(StrBuf *Target, int Neg, int state, WCTemplputParams *TP);
84 typedef struct _SortStruct {
89 CompareFunc GroupChange;
94 const char *CtxNames[] = {
105 "Context MIME_ATACH",
108 "Context LONGVECTOR",
118 void DestroySortStruct(void *vSort)
120 SortStruct *Sort = (SortStruct*) vSort;
121 FreeStrBuf(&Sort->Name);
122 FreeStrBuf(&Sort->PrefPrepend);
126 const char *ContextName(int ContextType)
128 if (ContextType < CTX_UNKNOWN)
129 return CtxNames[ContextType];
131 return CtxNames[CTX_UNKNOWN];
134 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);
152 case ERR_NAME: /* the main token name... */
153 Err = (TP->Tokens!= NULL)? TP->Tokens->pName:"";
156 Err = (TP->Tokens!= NULL)? TP->Tokens->Params[0]->Start:"";
159 Err = (TP->Tokens!= NULL)? TP->Tokens->Params[1]->Start:"";
162 if (TP->Tokens != NULL)
164 lprintf(1, "%s [%s] (in '%s' line %ld); %s; [%s]\n",
167 ChrPtr(TP->Tokens->FileName),
170 ChrPtr(TP->Tokens->FlatToken));
174 lprintf(1, "%s: %s;\n",
186 Header = NewStrBuf();
187 if (TP->Tokens != NULL)
192 "<pre>\n%s [%s] (in '%s' line %ld); %s\n[%s]\n</pre>\n",
195 ChrPtr(TP->Tokens->FileName),
198 ChrPtr(TP->Tokens->FlatToken));
200 StrBufPrintf(Info, "%s [%s] %s; [%s]",
204 ChrPtr(TP->Tokens->FlatToken));
207 SerializeJson(Header, WildFireException(SKEY(TP->Tokens->FileName),
212 SerializeJson(Header, WildFireMessage(SKEY(TP->Tokens->FileName),
217 WildFireSerializePayload(Header, WCC->HBuf, &WCC->Hdr->nWildfireHeaders, NULL);
224 "<pre>\n%s: %s\n</pre>\n",
228 StrBufPrintf(Info, "%s [%s] %s; [%s]",
232 ChrPtr(TP->Tokens->FlatToken));
233 SerializeJson(Header, WildFireException(HKEY(__FILE__), __LINE__, Info, 1), 1);
234 WildFireSerializePayload(Header, WCC->HBuf, &WCC->Hdr->nWildfireHeaders, NULL);
240 if (dbg_bactrace_template_errors)
248 void LogError (StrBuf *Target, const char *Type, const char *Format, ...)
259 va_start(arg_ptr, Format);
260 StrBufVAppendPrintf(Error, Format, arg_ptr);
263 lprintf(1, ChrPtr(Error));
266 Header = NewStrBuf();
269 SerializeJson(Header, WildFireException(Type, strlen(Type),
273 WildFireSerializePayload(Header, WCC->HBuf, &WCC->Hdr->nWildfireHeaders, NULL);
279 if (dbg_bactrace_template_errors)
285 void RegisterNS(const char *NSName,
289 WCHandlerFunc HandlerFunc,
292 HashHandler *NewHandler;
294 NewHandler = (HashHandler*) malloc(sizeof(HashHandler));
295 memset(NewHandler, 0, sizeof(HashHandler));
296 NewHandler->Filter.nMinArgs = nMinArgs;
297 NewHandler->Filter.nMaxArgs = nMaxArgs;
298 NewHandler->Filter.ContextType = ContextRequired;
299 NewHandler->Filter.ControlContextType = CTX_NONE;
301 NewHandler->HandlerFunc = HandlerFunc;
302 Put(GlobalNS, NSName, len, NewHandler, NULL);
305 void RegisterControlNS(const char *NSName,
309 WCHandlerFunc HandlerFunc,
310 int ControlContextRequired)
312 HashHandler *NewHandler;
314 NewHandler = (HashHandler*) malloc(sizeof(HashHandler));
315 memset(NewHandler, 0, sizeof(HashHandler));
316 NewHandler->Filter.nMinArgs = nMinArgs;
317 NewHandler->Filter.nMaxArgs = nMaxArgs;
318 NewHandler->Filter.ContextType = CTX_NONE;
319 NewHandler->Filter.ControlContextType = ControlContextRequired;
320 NewHandler->HandlerFunc = HandlerFunc;
321 Put(GlobalNS, NSName, len, NewHandler, NULL);
326 int CheckContext(StrBuf *Target, ContextFilter *Need, WCTemplputParams *TP, const char *ErrType)
328 if ((Need->ContextType != CTX_NONE) &&
329 (Need->ContextType != TP->Filter.ContextType)) {
331 Target, ErrType, ERR_PARM1, TP,
332 " WARNING: requires Context: [%s], have [%s]!",
333 ContextName(Need->ContextType),
334 ContextName(TP->Filter.ContextType));
338 if ((Need->ControlContextType != CTX_NONE) &&
339 (Need->ControlContextType != TP->Filter.ControlContextType)) {
341 Target, ErrType, ERR_PARM1, TP,
342 " WARNING: requires Control Context: [%s], have [%s]!",
343 ContextName(Need->ControlContextType),
344 ContextName(TP->Filter.ControlContextType));
348 if (TP->Tokens->nParameters < Need->nMinArgs) {
349 LogTemplateError(Target, ErrType, ERR_NAME, TP,
350 "needs at least %ld params, have %ld",
352 TP->Tokens->nParameters);
356 else if (TP->Tokens->nParameters > Need->nMaxArgs) {
357 LogTemplateError(Target, ErrType, ERR_NAME, TP,
358 "just needs %ld params, you gave %ld",
360 TP->Tokens->nParameters);
368 void FreeToken(WCTemplateToken **Token)
371 FreeStrBuf(&(*Token)->FlatToken);
372 if ((*Token)->HaveParameters)
373 for (i = 0; i < (*Token)->nParameters; i++)
374 free((*Token)->Params[i]);
381 void FreeWCTemplate(void *vFreeMe)
384 WCTemplate *FreeMe = (WCTemplate*)vFreeMe;
386 if (FreeMe->TokenSpace > 0) {
387 for (i = 0; i < FreeMe->nTokensUsed; i ++) {
388 FreeToken(&FreeMe->Tokens[i]);
390 free(FreeMe->Tokens);
392 FreeStrBuf(&FreeMe->FileName);
393 FreeStrBuf(&FreeMe->Data);
394 FreeStrBuf(&FreeMe->MimeType);
400 * \brief debugging function to print array to log
402 void VarPrintTransition(void *vVar1, void *vVar2, int odd){}
404 * \brief debugging function to print array to log
406 void VarPrintEntry(const char *Key, void *vSubst, int odd)
409 lprintf(1,"Subst[%s] : ", Key);
410 ptr = (wcsubst*) vSubst;
412 switch(ptr->wcs_type) {
414 lprintf(1, " -> %s\n", ChrPtr(ptr->wcs_value));
417 lprintf(1, " -> Server [%s]\n", ChrPtr(ptr->wcs_value));
420 lprintf(1, " -> function at [%0xd]\n", ptr->wcs_function);
423 lprintf(1," WARNING: invalid type: [%ld]!\n", ptr->wcs_type);
430 * \brief Clear out the list of substitution variables local to this session
432 void clear_substs(wcsession *wc) {
434 if (wc->vars != NULL) {
435 DeleteHash(&wc->vars);
440 * \brief Clear out the list of substitution variables local to this session
442 void clear_local_substs(void) {
461 void FlushPayload(wcsubst *ptr, int reusestrbuf, int type)
463 int NeedNew = NeedNewBuf(type);
464 switch(ptr->wcs_type) {
468 if (reusestrbuf && NeedNew) {
469 FlushStrBuf(ptr->wcs_value);
473 FreeStrBuf(&ptr->wcs_value);
474 ptr->wcs_value = NULL;
478 ptr->wcs_function = NULL;
479 if (reusestrbuf && NeedNew)
480 ptr->wcs_value = NewStrBuf();
483 ptr->wcs_value = NULL;
484 if (reusestrbuf && NeedNew)
485 ptr->wcs_value = NewStrBuf();
489 if (reusestrbuf && NeedNew)
490 ptr->wcs_value = NewStrBuf();
493 if (reusestrbuf && NeedNew)
494 ptr->wcs_value = NewStrBuf();
501 * \brief destructor; kill one entry.
503 void deletevar(void *data)
505 wcsubst *ptr = (wcsubst*)data;
506 FlushPayload(ptr, 0, ptr->wcs_type);
511 wcsubst *NewSubstVar(const char *keyname, int keylen, int type)
516 ptr = (wcsubst *) malloc(sizeof(wcsubst));
517 memset(ptr, 0, sizeof(wcsubst));
519 ptr->wcs_type = type;
520 safestrncpy(ptr->wcs_key, keyname, sizeof ptr->wcs_key);
521 Put(WCC->vars, keyname, keylen, ptr, deletevar);
523 switch(ptr->wcs_type) {
526 ptr->wcs_value = NewStrBuf();
540 * \brief Add a substitution variable (local to this session) (strlen version...)
541 * \param keyname the replacementstring to substitute
542 * \param keytype the kind of the key
543 * \param format the format string ala printf
544 * \param ... the arguments to substitute in the formatstring
546 void SVPRINTF(char *keyname, int keytype, const char *format,...)
554 keylen = strlen(keyname);
556 * First look if we're doing a replacement of
559 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
560 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
561 ptr = (wcsubst*)vPtr;
562 FlushPayload(ptr, keytype, keytype);
563 ptr->wcs_type = keytype;
565 else /** Otherwise allocate a new one */
567 ptr = NewSubstVar(keyname, keylen, keytype);
570 /** Format the string */
571 va_start(arg_ptr, format);
572 StrBufVAppendPrintf(ptr->wcs_value, format, arg_ptr);
577 * \brief Add a substitution variable (local to this session)
578 * \param keyname the replacementstring to substitute
579 * \param keytype the kind of the key
580 * \param format the format string ala printf
581 * \param ... the arguments to substitute in the formatstring
583 void svprintf(char *keyname, size_t keylen, int keytype, const char *format,...)
591 * First look if we're doing a replacement of
594 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
595 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
596 ptr = (wcsubst*)vPtr;
597 FlushPayload(ptr, 1, keytype);
598 ptr->wcs_type = keytype;
600 else /** Otherwise allocate a new one */
602 ptr = NewSubstVar(keyname, keylen, keytype);
605 /** Format the string and save it */
606 va_start(arg_ptr, format);
607 StrBufVAppendPrintf(ptr->wcs_value, format, arg_ptr);
612 * \brief Add a substitution variable (local to this session)
613 * \param keyname the replacementstring to substitute
614 * \param keytype the kind of the key
615 * \param format the format string ala printf
616 * \param ... the arguments to substitute in the formatstring
618 void SVPut(char *keyname, size_t keylen, int keytype, char *Data)
626 * First look if we're doing a replacement of
629 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
630 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
631 ptr = (wcsubst*)vPtr;
632 FlushPayload(ptr, 1, keytype);
633 ptr->wcs_type = keytype;
635 else /** Otherwise allocate a new one */
637 ptr = NewSubstVar(keyname, keylen, keytype);
639 StrBufAppendBufPlain(ptr->wcs_value, Data, -1, 0);
643 * \brief Add a substitution variable (local to this session)
644 * \param keyname the replacementstring to substitute
645 * \param keytype the kind of the key
646 * \param format the format string ala printf
647 * \param ... the arguments to substitute in the formatstring
649 void SVPutLong(char *keyname, size_t keylen, long Data)
657 * First look if we're doing a replacement of
660 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
661 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
662 ptr = (wcsubst*)vPtr;
663 FlushPayload(ptr, 1, WCS_LONG);
664 ptr->wcs_type = WCS_LONG;
666 else /** Otherwise allocate a new one */
668 ptr = NewSubstVar(keyname, keylen, WCS_LONG);
674 * \brief Add a substitution variable (local to this session) that does a callback
675 * \param keyname the keystring to substitute
676 * \param fcn_ptr the function callback to give the substitution string
678 void SVCallback(char *keyname, size_t keylen, WCHandlerFunc fcn_ptr)
685 * First look if we're doing a replacement of
688 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
689 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
690 ptr = (wcsubst*)vPtr;
691 FlushPayload(ptr, 1, WCS_FUNCTION);
692 ptr->wcs_type = WCS_FUNCTION;
694 else /** Otherwise allocate a new one */
696 ptr = NewSubstVar(keyname, keylen, WCS_FUNCTION);
699 ptr->wcs_function = fcn_ptr;
701 inline void SVCALLBACK(char *keyname, WCHandlerFunc fcn_ptr)
703 SVCallback(keyname, strlen(keyname), fcn_ptr);
708 void SVPUTBuf(const char *keyname, int keylen, const StrBuf *Buf, int ref)
715 * First look if we're doing a replacement of
718 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
719 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
720 ptr = (wcsubst*)vPtr;
721 FlushPayload(ptr, 0, (ref)?WCS_STRBUF_REF:WCS_STRBUF);
722 ptr->wcs_type = (ref)?WCS_STRBUF_REF:WCS_STRBUF;
724 else /** Otherwise allocate a new one */
726 ptr = NewSubstVar(keyname, keylen, (ref)?WCS_STRBUF_REF:WCS_STRBUF);
728 ptr->wcs_value = (StrBuf*)Buf;
732 * \brief back end for print_value_of() ... does a server command
733 * \param servcmd server command to execute on the citadel server
735 void pvo_do_cmd(StrBuf *Target, StrBuf *servcmd) {
739 serv_puts(ChrPtr(servcmd));
740 len = serv_getln(buf, sizeof buf);
746 StrBufAppendPrintf(Target, "%s\n", &buf[4]);
749 _fmout(Target, "CENTER");
752 StrBufAppendPrintf(Target, "%s\n", &buf[4]);
758 void GetTemplateTokenString(StrBuf *Target,
759 WCTemplputParams *TP,
765 WCTemplputParams SubTP;
767 if (TP->Tokens->nParameters < N) {
768 LogTemplateError(Target,
769 "TokenParameter", N, TP,
770 "invalid token %d. this shouldn't have come till here.\n", N);
776 switch (TP->Tokens->Params[N]->Type) {
779 *Value = TP->Tokens->Params[N]->Start;
780 *len = TP->Tokens->Params[N]->len;
783 if (TP->Tokens->Params[N]->len == 0) {
784 LogTemplateError(Target,
785 "TokenParameter", N, TP,
786 "Requesting parameter %d; of type BSTR, empty lookup string not admitted.", N);
791 Buf = (StrBuf*) SBstr(TKEY(N));
792 *Value = ChrPtr(Buf);
793 *len = StrLength(Buf);
796 if (TP->Tokens->Params[N]->len == 0) {
797 LogTemplateError(Target,
798 "TokenParameter", N, TP,
799 "Requesting parameter %d; of type PREFSTR, empty lookup string not admitted.", N);
804 get_PREFERENCE(TKEY(N), &Buf);
805 *Value = ChrPtr(Buf);
806 *len = StrLength(Buf);
809 LogTemplateError(Target,
810 "TokenParameter", N, TP,
811 "Requesting parameter %d; of type LONG, want string.", N);
814 LogTemplateError(Target,
815 "TokenParameter", N, TP,
816 "Requesting parameter %d; of type PREFINT, want string.", N);
819 *Value = _(TP->Tokens->Params[N]->Start);
820 *len = strlen(*Value);
822 case TYPE_SUBTEMPLATE:
823 if (TP->Tokens->Params[N]->len == 0) {
824 LogTemplateError(Target,
825 "TokenParameter", N, TP,
826 "Requesting parameter %d; of type SUBTEMPLATE, empty lookup string not admitted.", N);
832 memset(&SubTP, 0, sizeof(WCTemplputParams *));
833 SubTP.Context = TP->Context;
834 SubTP.Filter.ContextType = TP->Filter.ContextType;
836 DoTemplate(TKEY(N), Buf, &SubTP);
837 *Value = ChrPtr(Buf);
838 *len = StrLength(Buf);
839 /* we can't free it here, so we put it into the subst so its discarded later on. */
840 SVPUTBuf(TKEY(N), Buf, 0);
844 LogTemplateError(Target,
845 "TokenParameter", N, TP,
846 "unknown param type %d; [%d]", N, TP->Tokens->Params[N]->Type);
851 long GetTemplateTokenNumber(StrBuf *Target, WCTemplputParams *TP, int N, long dflt)
854 if (TP->Tokens->nParameters < N) {
855 LogTemplateError(Target,
856 "TokenParameter", N, TP,
857 "invalid token %d. this shouldn't have come till here.\n", N);
862 switch (TP->Tokens->Params[N]->Type) {
865 return atol(TP->Tokens->Params[N]->Start);
868 if (TP->Tokens->Params[N]->len == 0) {
869 LogTemplateError(Target,
870 "TokenParameter", N, TP,
871 "Requesting parameter %d; of type BSTR, empty lookup string not admitted.", N);
874 return LBstr(TKEY(N));
877 LogTemplateError(Target,
878 "TokenParameter", N, TP,
879 "requesting a prefstring in param %d want a number", N);
880 if (TP->Tokens->Params[N]->len == 0) {
881 LogTemplateError(Target,
882 "TokenParameter", N, TP,
883 "Requesting parameter %d; of type PREFSTR, empty lookup string not admitted.", N);
886 if (get_PREF_LONG(TKEY(N), &Ret, dflt))
890 return TP->Tokens->Params[N]->lvalue;
892 if (TP->Tokens->Params[N]->len == 0) {
893 LogTemplateError(Target,
894 "TokenParameter", N, TP,
895 "Requesting parameter %d; of type PREFINT, empty lookup string not admitted.", N);
898 if (get_PREF_LONG(TKEY(N), &Ret, dflt))
902 LogTemplateError(Target,
903 "TokenParameter", N, TP,
904 "requesting a I18N string in param %d; want a number", N);
906 case TYPE_SUBTEMPLATE:
907 LogTemplateError(Target,
908 "TokenParameter", N, TP,
909 "requesting a subtemplate in param %d; not supported for numbers", N);
912 LogTemplateError(Target,
913 "TokenParameter", N, TP,
914 "unknown param type %d; [%d]", N, TP->Tokens->Params[N]->Type);
922 * \brief Print the value of a variable
923 * \param keyname get a key to print
925 void print_value_of(StrBuf *Target, WCTemplputParams *TP)
932 /*if (WCC->vars != NULL) PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
933 /* TODO: depricated! */
934 if (TP->Tokens->pName[0] == '=') {
935 DoTemplate(TP->Tokens->pName+1, TP->Tokens->NameEnd - 1, NULL, &NoCtx);
937 /*/////TODO: if param[1] == "U" -> urlescape
939 /** Page-local variables */
940 if ((WCC->vars!= NULL) && GetHash(WCC->vars, TP->Tokens->pName, TP->Tokens->NameEnd, &vVar)) {
941 ptr = (wcsubst*) vVar;
942 switch(ptr->wcs_type) {
944 StrBufAppendBuf(Target, ptr->wcs_value, 0);
947 pvo_do_cmd(Target, ptr->wcs_value);
950 (*ptr->wcs_function) (Target, TP);
954 StrBufAppendBuf(Target, ptr->wcs_value, 0);
957 StrBufAppendPrintf(Target, "%ld", ptr->lvalue);
961 Target, "Subst", ERR_NAME, TP,
962 "WARNING: invalid value in SV-Hash at %s!", TP->Tokens->pName);
967 Target, "Token", ERR_NAME, TP,
968 "didn't find Handler \"%s\"", TP->Tokens->pName);
973 int CompareSubstToToken(TemplateParam *ParamToCompare, TemplateParam *ParamToLookup)
979 if ((WCC->vars!= NULL) && GetHash(WCC->vars, ParamToLookup->Start,
980 ParamToLookup->len, &vVar)) {
981 ptr = (wcsubst*) vVar;
982 switch(ptr->wcs_type) {
986 if (ParamToCompare->Type == TYPE_STR)
987 return ((ParamToCompare->len == StrLength(ptr->wcs_value)) &&
988 (strcmp(ParamToCompare->Start, ChrPtr(ptr->wcs_value)) == 0));
990 return ParamToCompare->lvalue == StrTol(ptr->wcs_value);
998 if (ParamToCompare->Type == TYPE_STR)
1001 return ParamToCompare->lvalue == ptr->lvalue;
1004 lprintf(1,"WARNING: invalid value in SV-Hash at %s!\n",
1005 ParamToLookup->Start);
1011 int CompareSubstToStrBuf(StrBuf *Compare, TemplateParam *ParamToLookup)
1013 wcsession *WCC = WC;
1017 if ((WCC->vars!= NULL) && GetHash(WCC->vars, ParamToLookup->Start,
1018 ParamToLookup->len, &vVar)) {
1019 ptr = (wcsubst*) vVar;
1020 switch(ptr->wcs_type) {
1023 case WCS_STRBUF_REF:
1024 return ((StrLength(Compare) == StrLength(ptr->wcs_value)) &&
1025 (strcmp(ChrPtr(Compare), ChrPtr(ptr->wcs_value)) == 0));
1032 return StrTol(Compare) == ptr->lvalue;
1034 lprintf(1,"WARNING: invalid value in SV-Hash at %s!\n",
1035 ParamToLookup->Start);
1044 * \brief puts string into the template and computes which escape methon we should use
1045 * \param Source the string we should put into the template
1046 * \param FormatTypeIndex where should we look for escape types if?
1048 void StrBufAppendTemplate(StrBuf *Target,
1049 WCTemplputParams *TP,
1050 const StrBuf *Source, int FormatTypeIndex)
1053 char EscapeAs = ' ';
1055 if ((FormatTypeIndex < TP->Tokens->nParameters) &&
1056 (TP->Tokens->Params[FormatTypeIndex]->Type == TYPE_STR) &&
1057 (TP->Tokens->Params[FormatTypeIndex]->len == 1)) {
1058 EscapeAs = *TP->Tokens->Params[FormatTypeIndex]->Start;
1065 StrEscAppend(Target, Source, NULL, 0, 2);
1068 StrEscAppend(Target, Source, NULL, 0, 0);
1071 StrECMAEscAppend(Target, Source, NULL);
1074 StrBufUrlescAppend(Target, Source, NULL);
1077 StrBufAppendBuf(Target, Source, 0);
1082 void PutNewToken(WCTemplate *Template, WCTemplateToken *NewToken)
1084 if (Template->nTokensUsed + 1 >= Template->TokenSpace) {
1085 if (Template->TokenSpace <= 0) {
1086 Template->Tokens = (WCTemplateToken**)malloc(
1087 sizeof(WCTemplateToken*) * 10);
1088 memset(Template->Tokens, 0, sizeof(WCTemplateToken*));
1089 Template->TokenSpace = 10;
1092 WCTemplateToken **NewTokens;
1093 NewTokens= (WCTemplateToken**)malloc(
1094 sizeof(WCTemplateToken*) *
1095 Template->TokenSpace * 2);
1096 memcpy(NewTokens, Template->Tokens,
1097 sizeof(WCTemplateToken*) * Template->nTokensUsed);
1098 free(Template->Tokens);
1099 Template->TokenSpace *= 2;
1100 Template->Tokens = NewTokens;
1103 Template->Tokens[(Template->nTokensUsed)++] = NewToken;
1106 TemplateParam *GetNextParameter(StrBuf *Buf, const char **pCh, const char *pe, WCTemplateToken *Tokens, WCTemplate *pTmpl)
1108 const char *pch = *pCh;
1109 const char *pchs, *pche;
1110 TemplateParam *Parm;
1114 Parm = (TemplateParam *) malloc(sizeof(TemplateParam));
1115 memset(Parm, 0, sizeof(TemplateParam));
1116 Parm->Type = TYPE_STR;
1118 /* Skip leading whitespaces */
1119 while ((*pch == ' ' )||
1122 (*pch == '\n')) pch ++;
1125 Parm->Type = TYPE_PREFSTR;
1132 else if (*pch == ';') {
1133 Parm->Type = TYPE_PREFINT;
1140 else if (*pch == '_') {
1141 Parm->Type = TYPE_GETTEXT;
1148 else if (*pch == 'B') {
1149 Parm->Type = TYPE_BSTR;
1156 else if (*pch == '=') {
1157 Parm->Type = TYPE_SUBTEMPLATE;
1168 else if (*pch == '\'')
1170 if (quote != '\0') {
1175 ( (pch > pchs) && (*(pch - 1) == '\\'))
1180 if (*pch != quote) {
1181 lprintf(1, "Error (in '%s' line %ld); "
1182 "evaluating template param [%s] in Token [%s]\n",
1183 ChrPtr(pTmpl->FileName),
1185 ChrPtr(Tokens->FlatToken),
1192 StrBufPeek(Buf, pch, -1, '\0');
1193 if (LoadTemplates > 1) {
1194 lprintf(1, "DBG: got param [%s] %ld %ld\n",
1195 pchs, pche - pchs, strlen(pchs));
1198 Parm->len = pche - pchs;
1199 pch ++; /* move after trailing quote */
1200 if (ParamBrace && (*pch == ')')) {
1207 Parm->Type = TYPE_LONG;
1209 while ((pch <= pe) &&
1215 if (pch - pchs > 1){
1216 StrBufPeek(Buf, pch, -1, '\0');
1217 Parm->lvalue = atol(pchs);
1224 lprintf(1, "Error (in '%s' line %ld); "
1225 "evaluating long template param [%s] in Token [%s]\n",
1226 ChrPtr(pTmpl->FileName),
1228 ChrPtr(Tokens->FlatToken),
1235 while ((*pch == ' ' )||
1239 (*pch == '\n')) pch ++;
1241 if (DumpTemplateI18NStrings && (Parm->Type == TYPE_GETTEXT)) {
1242 StrBufAppendPrintf(I18nDump, "_(\"%s\");\n", Parm->Start);
1248 WCTemplateToken *NewTemplateSubstitute(StrBuf *Buf,
1250 const char *pTmplStart,
1251 const char *pTmplEnd,
1257 TemplateParam *Param;
1258 WCTemplateToken *NewToken;
1259 WCTemplputParams TP;
1261 NewToken = (WCTemplateToken*)malloc(sizeof(WCTemplateToken));
1262 memset(NewToken, 0, sizeof(WCTemplateToken));
1263 TP.Tokens = NewToken;
1264 NewToken->FileName = pTmpl->FileName; /* to print meaningfull log messages... */
1265 NewToken->Flags = 0;
1266 NewToken->Line = Line + 1;
1267 NewToken->pTokenStart = pTmplStart;
1268 NewToken->TokenStart = pTmplStart - pStart;
1269 NewToken->TokenEnd = (pTmplEnd - pStart) - NewToken->TokenStart;
1270 NewToken->pTokenEnd = pTmplEnd;
1271 NewToken->NameEnd = NewToken->TokenEnd - 2;
1272 NewToken->PreEval = NULL;
1273 NewToken->FlatToken = NewStrBufPlain(pTmplStart + 2, pTmplEnd - pTmplStart - 2);
1275 StrBufPeek(Buf, pTmplStart, + 1, '\0');
1276 StrBufPeek(Buf, pTmplEnd, -1, '\0');
1277 pch = NewToken->pName = pTmplStart + 2;
1279 NewToken->HaveParameters = 0;;
1280 NewToken->nParameters = 0;
1282 while (pch < pTmplEnd - 1) {
1284 StrBufPeek(Buf, pch, -1, '\0');
1285 NewToken->NameEnd = pch - NewToken->pName;
1287 if (*(pTmplEnd - 1) != ')') {
1289 NULL, "Parseerror", ERR_NAME, &TP,
1290 "Warning, Non welformed Token; missing right parenthesis");
1292 while (pch < pTmplEnd - 1) {
1293 Param = GetNextParameter(Buf, &pch, pTmplEnd - 1, NewToken, pTmpl);
1294 if (Param != NULL) {
1295 NewToken->HaveParameters = 1;
1296 if (NewToken->nParameters > MAXPARAM) {
1298 NULL, "Parseerror", ERR_NAME, &TP,
1299 "only [%d] Params allowed in Tokens",
1303 FreeToken(&NewToken);
1306 NewToken->Params[NewToken->nParameters++] = Param;
1310 if((NewToken->NameEnd == 1) &&
1311 (NewToken->HaveParameters == 1))
1314 if (*(NewToken->pName) == '_')
1315 NewToken->Flags = SV_GETTEXT;
1316 else if (*(NewToken->pName) == '=')
1317 NewToken->Flags = SV_SUBTEMPL;
1318 else if (*(NewToken->pName) == '%')
1319 NewToken->Flags = SV_CUST_STR_CONDITIONAL;
1320 else if (*(NewToken->pName) == '?')
1321 NewToken->Flags = SV_CONDITIONAL;
1322 else if (*(NewToken->pName) == '!')
1323 NewToken->Flags = SV_NEG_CONDITIONAL;
1329 switch (NewToken->Flags) {
1331 /* If we're able to find out more about the token, do it now while its fresh. */
1332 if (GetHash(GlobalNS, NewToken->pName, NewToken->NameEnd, &vVar)) {
1333 HashHandler *Handler;
1334 Handler = (HashHandler*) vVar;
1335 if ((NewToken->nParameters < Handler->Filter.nMinArgs) ||
1336 (NewToken->nParameters > Handler->Filter.nMaxArgs)) {
1338 NULL, "Token", ERR_NAME, &TP,
1339 "doesn't work with %d params",
1340 NewToken->nParameters);
1344 NewToken->PreEval = Handler;
1345 NewToken->Flags = SV_PREEVALUATED;
1350 if (NewToken->nParameters !=1) {
1352 NULL, "Gettext", ERR_NAME, &TP,
1353 "requires exactly 1 parameter, you gave %d params",
1354 NewToken->nParameters);
1355 NewToken->Flags = 0;
1358 if (DumpTemplateI18NStrings) {
1359 StrBufAppendPrintf(I18nDump, "_(\"%s\");\n", NewToken->Params[0]->Start);
1363 if (NewToken->nParameters != 1) {
1365 NULL, "Subtemplates", ERR_NAME, &TP,
1366 "require exactly 1 parameter, you gave %d params",
1367 NewToken->nParameters);
1371 case SV_CUST_STR_CONDITIONAL:
1372 case SV_CONDITIONAL:
1373 case SV_NEG_CONDITIONAL:
1374 if (NewToken->nParameters <2) {
1376 NULL, "Conditional", ERR_NAME, &TP,
1377 "require at least 2 parameters, you gave %d params",
1378 NewToken->nParameters);
1379 NewToken->Flags = 0;
1382 if (NewToken->Params[1]->lvalue == 0) {
1384 NULL, "Conditional", ERR_NAME, &TP,
1385 "Conditional ID (Parameter 1) mustn't be 0!");
1386 NewToken->Flags = 0;
1389 if (!GetHash(Conditionals,
1390 NewToken->Params[0]->Start,
1391 NewToken->Params[0]->len,
1394 if ((NewToken->Params[0]->len == 1) &&
1395 (NewToken->Params[0]->Start[0] == 'X'))
1398 NULL, "Conditional", ERR_NAME, &TP,
1401 NewToken->Error = NewStrBuf();
1404 "<pre>\nConditional [%s] (in '%s' line %ld); Not found!\n[%s]\n</pre>\n",
1405 NewToken->Params[0]->Start,
1406 ChrPtr(pTmpl->FileName),
1408 ChrPtr(NewToken->FlatToken));
1412 NewToken->PreEval = vVar;
1424 * \brief Display a variable-substituted template
1425 * \param templatename template file to load
1427 void *prepare_template(StrBuf *filename, StrBuf *Key, HashList *PutThere)
1429 WCTemplate *NewTemplate;
1431 NewTemplate = (WCTemplate *) malloc(sizeof(WCTemplate));
1432 memset(NewTemplate, 0, sizeof(WCTemplate));
1433 NewTemplate->Data = NULL;
1434 NewTemplate->FileName = NewStrBufDup(filename);
1435 NewTemplate->nTokensUsed = 0;
1436 NewTemplate->TokenSpace = 0;
1437 NewTemplate->Tokens = NULL;
1438 NewTemplate->MimeType = NewStrBufPlain(GuessMimeByFilename (SKEY(NewTemplate->FileName)), -1);
1439 if (strstr(ChrPtr(NewTemplate->MimeType), "text") != NULL) {
1440 StrBufAppendBufPlain(NewTemplate->MimeType, HKEY("; charset=utf-8"), 0);
1443 Put(PutThere, ChrPtr(Key), StrLength(Key), NewTemplate, FreeWCTemplate);
1448 * \brief Display a variable-substituted template
1449 * \param templatename template file to load
1451 void *load_template(StrBuf *filename, StrBuf *Key, HashList *PutThere)
1454 struct stat statbuf;
1455 const char *pS, *pE, *pch, *Err;
1458 WCTemplate *NewTemplate;
1460 fd = open(ChrPtr(filename), O_RDONLY);
1462 lprintf(1, "ERROR: could not open template '%s' - %s\n",
1463 ChrPtr(filename), strerror(errno));
1467 if (fstat(fd, &statbuf) == -1) {
1468 lprintf(1, "ERROR: could not stat template '%s' - %s\n",
1469 ChrPtr(filename), strerror(errno));
1473 NewTemplate = (WCTemplate *) malloc(sizeof(WCTemplate));
1474 memset(NewTemplate, 0, sizeof(WCTemplate));
1475 NewTemplate->Data = NewStrBufPlain(NULL, statbuf.st_size);
1476 NewTemplate->FileName = NewStrBufDup(filename);
1477 NewTemplate->nTokensUsed = 0;
1478 NewTemplate->TokenSpace = 0;
1479 NewTemplate->Tokens = NULL;
1480 NewTemplate->MimeType = NewStrBufPlain(GuessMimeByFilename (SKEY(NewTemplate->FileName)), -1);
1481 if (strstr(ChrPtr(NewTemplate->MimeType), "text") != NULL) {
1482 StrBufAppendBufPlain(NewTemplate->MimeType, HKEY("; charset=utf-8"), 0);
1485 if (StrBufReadBLOB(NewTemplate->Data, &fd, 1, statbuf.st_size, &Err) < 0) {
1487 FreeWCTemplate(NewTemplate);
1488 lprintf(1, "ERROR: reading template '%s' - %s<br />\n",
1489 ChrPtr(filename), strerror(errno));
1495 StrBufShrinkToFit(NewTemplate->Data, 1);
1496 pS = pch = ChrPtr(NewTemplate->Data);
1497 pE = pS + StrLength(NewTemplate->Data);
1499 const char *pts, *pte;
1501 int InDoubleQuotes = 0;
1503 /** Find one <? > */
1505 for (; pch < pE; pch ++) {
1506 if ((*pch=='<')&&(*(pch + 1)=='?'))
1508 if (*pch=='\n') Line ++;
1514 /** Found one? parse it. */
1515 for (; pch <= pE - 1; pch ++) {
1517 InDoubleQuotes = ! InDoubleQuotes;
1518 else if (*pch == '\'')
1519 InQuotes = ! InQuotes;
1520 else if ((!InQuotes && !InDoubleQuotes) &&
1521 ((*pch!='\\')&&(*(pch + 1)=='>'))) {
1529 PutNewToken(NewTemplate,
1530 NewTemplateSubstitute(NewTemplate->Data, pS, pts, pte, Line, NewTemplate));
1533 if (LoadTemplates == 0)
1534 Put(PutThere, ChrPtr(Key), StrLength(Key), NewTemplate, FreeWCTemplate);
1539 const char* PrintTemplate(void *vSubst)
1541 WCTemplate *Tmpl = vSubst;
1543 return ChrPtr(Tmpl->FileName);
1547 int LoadTemplateDir(const char *DirName, HashList *wireless, HashList *big)
1552 DIR *filedir = NULL;
1553 struct dirent *filedir_entry;
1559 StrBufPrintf(Dir, "%s/t", DirName);
1560 filedir = opendir (ChrPtr(Dir));
1561 if (filedir == NULL) {
1566 FileName = NewStrBuf();
1568 while ((filedir_entry = readdir(filedir)))
1572 #ifdef _DIRENT_HAVE_D_NAMELEN
1573 d_namelen = filedir_entry->d_namelen;
1575 d_namelen = strlen(filedir_entry->d_name);
1577 d_without_ext = d_namelen;
1578 while ((d_without_ext > 0) && (filedir_entry->d_name[d_without_ext] != '.'))
1580 if ((d_without_ext == 0) || (d_namelen < 3))
1582 if ((d_namelen > 1) && filedir_entry->d_name[d_namelen - 1] == '~')
1583 continue; /* Ignore backup files... */
1585 IsMobile = (strstr(filedir_entry->d_name, ".m.html")!= NULL);
1586 PStart = filedir_entry->d_name;
1587 StrBufPrintf(FileName, "%s/%s", ChrPtr(Dir), filedir_entry->d_name);
1588 MinorPtr = strchr(filedir_entry->d_name, '.');
1589 if (MinorPtr != NULL)
1591 StrBufPlain(Tag, filedir_entry->d_name, MinorPtr - filedir_entry->d_name);
1593 if (LoadTemplates > 1)
1594 lprintf(1, "%s %d %s\n",ChrPtr(FileName), IsMobile, ChrPtr(Tag));
1595 if (LoadTemplates == 0)
1596 load_template(FileName, Tag, (IsMobile)?wireless:big);
1598 prepare_template(FileName, Tag, (IsMobile)?wireless:big);
1601 FreeStrBuf(&FileName);
1607 void InitTemplateCache(void)
1609 LoadTemplateDir(static_dirs[0],
1610 WirelessTemplateCache,
1612 LoadTemplateDir(static_dirs[1],
1613 WirelessLocalTemplateCache,
1614 LocalTemplateCache);
1619 /*-----------------------------------------------------------------------------
1620 * Filling & processing Templates
1623 * \brief executes one token
1624 * \param Target buffer to append to
1625 * \param Token da to process.
1626 * \param Template we're iterating
1627 * \param Context Contextpoointer to pass in
1628 * \param state are we in conditional state?
1629 * \param ContextType what type of information does context giv us?
1631 int EvaluateToken(StrBuf *Target, int state, WCTemplputParams *TP)
1633 const char *AppendMe;
1635 HashHandler *Handler;
1638 /* much output, since pName is not terminated...
1639 lprintf(1,"Doing token: %s\n",Token->pName);
1642 switch (TP->Tokens->Flags) {
1644 TmplGettext(Target, TP);
1646 case SV_CONDITIONAL: /** Forward conditional evaluation */
1647 return EvaluateConditional(Target, 1, state, TP);
1649 case SV_NEG_CONDITIONAL: /** Reverse conditional evaluation */
1650 return EvaluateConditional(Target, 0, state, TP);
1652 case SV_CUST_STR_CONDITIONAL: /** Conditional put custom strings from params */
1653 if (TP->Tokens->nParameters >= 6) {
1654 if (EvaluateConditional(Target, 0, state, TP)) {
1655 GetTemplateTokenString(Target, TP, 5, &AppendMe, &AppendMeLen);
1656 StrBufAppendBufPlain(Target,
1662 GetTemplateTokenString(Target, TP, 4, &AppendMe, &AppendMeLen);
1663 StrBufAppendBufPlain(Target,
1671 Target, "Conditional", ERR_NAME, TP,
1672 "needs at least 6 Params!");
1676 if (TP->Tokens->nParameters == 1)
1677 DoTemplate(TKEY(0), Target, TP);
1679 case SV_PREEVALUATED:
1680 Handler = (HashHandler*) TP->Tokens->PreEval;
1681 if (!CheckContext(Target, &Handler->Filter, TP, "Token")) {
1684 Handler->HandlerFunc(Target, TP);
1687 if (GetHash(GlobalNS, TP->Tokens->pName, TP->Tokens->NameEnd, &vVar)) {
1688 Handler = (HashHandler*) vVar;
1689 if (!CheckContext(Target, &Handler->Filter, TP, "Token")) {
1693 Handler->HandlerFunc(Target, TP);
1697 print_value_of(Target, TP);
1705 const StrBuf *ProcessTemplate(WCTemplate *Tmpl, StrBuf *Target, WCTemplputParams *CallingTP)
1707 WCTemplate *pTmpl = Tmpl;
1710 const char *pData, *pS;
1712 WCTemplputParams TP;
1714 memcpy(&TP.Filter, &CallingTP->Filter, sizeof(ContextFilter));
1716 TP.Context = CallingTP->Context;
1717 TP.ControlContext = CallingTP->ControlContext;
1719 if (LoadTemplates != 0) {
1720 if (LoadTemplates > 1)
1721 lprintf(1, "DBG: ----- loading: [%s] ------ \n",
1722 ChrPtr(Tmpl->FileName));
1724 pTmpl = load_template(Tmpl->FileName, NULL, NULL);
1728 "<pre>\nError loading Template [%s]\n See Logfile for details\n</pre>\n",
1729 ChrPtr(Tmpl->FileName));
1735 pS = pData = ChrPtr(pTmpl->Data);
1736 len = StrLength(pTmpl->Data);
1740 if (i >= pTmpl->nTokensUsed) {
1741 StrBufAppendBufPlain(Target,
1743 len - (pData - pS), 0);
1747 StrBufAppendBufPlain(
1749 pTmpl->Tokens[i]->pTokenStart - pData, 0);
1750 TP.Tokens = pTmpl->Tokens[i];
1751 TP.nArgs = pTmpl->Tokens[i]->nParameters;
1752 state = EvaluateToken(Target, state, &TP);
1754 while ((state != 0) && (i+1 < pTmpl->nTokensUsed)) {
1755 /* condition told us to skip till its end condition */
1757 TP.Tokens = pTmpl->Tokens[i];
1758 TP.nArgs = pTmpl->Tokens[i]->nParameters;
1759 if ((pTmpl->Tokens[i]->Flags == SV_CONDITIONAL) ||
1760 (pTmpl->Tokens[i]->Flags == SV_NEG_CONDITIONAL)) {
1761 if (state == EvaluateConditional(
1763 pTmpl->Tokens[i]->Flags,
1769 pData = pTmpl->Tokens[i++]->pTokenEnd + 1;
1770 if (i > pTmpl->nTokensUsed)
1774 if (LoadTemplates != 0) {
1775 FreeWCTemplate(pTmpl);
1777 return Tmpl->MimeType;
1782 * \brief Display a variable-substituted template
1783 * \param templatename template file to load
1784 * \returns the mimetype of the template its doing
1786 const StrBuf *DoTemplate(const char *templatename, long len, StrBuf *Target, WCTemplputParams *TP)
1788 WCTemplputParams LocalTP;
1790 HashList *StaticLocal;
1796 memset(&LocalTP, 0, sizeof(WCTemplputParams));
1800 if (WC->is_mobile) {
1801 Static = WirelessTemplateCache;
1802 StaticLocal = WirelessLocalTemplateCache;
1805 Static = TemplateCache;
1806 StaticLocal = LocalTemplateCache;
1811 lprintf (1, "Can't to load a template with empty name!\n");
1812 StrBufAppendPrintf(Target, "<pre>\nCan't to load a template with empty name!\n</pre>");
1816 if (!GetHash(StaticLocal, templatename, len, &vTmpl) &&
1817 !GetHash(Static, templatename, len, &vTmpl)) {
1818 lprintf (1, "didn't find Template [%s] %ld %ld\n", templatename, len , (long)strlen(templatename));
1819 StrBufAppendPrintf(Target, "<pre>\ndidn't find Template [%s] %ld %ld\n</pre>",
1821 (long)strlen(templatename));
1823 dbg_PrintHash(Static, PrintTemplate, NULL);
1824 PrintHash(Static, VarPrintTransition, PrintTemplate);
1830 return ProcessTemplate(vTmpl, Target, TP);
1834 /*-----------------------------------------------------------------------------
1837 typedef struct _HashIterator {
1838 HashList *StaticList;
1839 int AdditionalParams;
1841 int XPectContextType;
1843 RetrieveHashlistFunc GetHash;
1844 HashDestructorFunc Destructor;
1845 SubTemplFunc DoSubTemplate;
1848 void RegisterITERATOR(const char *Name, long len,
1849 int AdditionalParams,
1850 HashList *StaticList,
1851 RetrieveHashlistFunc GetHash,
1852 SubTemplFunc DoSubTempl,
1853 HashDestructorFunc Destructor,
1855 int XPectContextType,
1860 It = (HashIterator*)malloc(sizeof(HashIterator));
1861 memset(It, 0, sizeof(HashIterator));
1862 It->StaticList = StaticList;
1863 It->AdditionalParams = AdditionalParams;
1864 It->GetHash = GetHash;
1865 It->DoSubTemplate = DoSubTempl;
1866 It->Destructor = Destructor;
1867 It->ContextType = ContextType;
1868 It->XPectContextType = XPectContextType;
1870 Put(Iterators, Name, len, It, NULL);
1873 typedef struct _iteratestruct {
1882 void tmpl_iterate_subtmpl(StrBuf *Target, WCTemplputParams *TP)
1888 SortStruct *SortBy = NULL;
1890 int DetectGroupChange = 0;
1893 void *vLastContext = NULL;
1895 WCTemplputParams SubTP;
1896 IterateStruct Status;
1902 memset(&Status, 0, sizeof(IterateStruct));
1903 memcpy (&SubTP, &TP, sizeof(WCTemplputParams));
1905 if (!GetHash(Iterators, TKEY(0), &vIt)) {
1907 Target, "Iterator", ERR_PARM1, TP, "Unknown!");
1911 It = (HashIterator*) vIt;
1913 if (TP->Tokens->nParameters < It->AdditionalParams + 2) {
1915 Target, "Iterator", ERR_PARM1, TP,
1916 "doesn't work with %d params",
1917 TP->Tokens->nParameters);
1921 if ((It->XPectContextType != CTX_NONE) &&
1922 (It->XPectContextType != TP->Filter.ContextType)) {
1924 Target, "Iterator", ERR_PARM1, TP,
1925 "requires context of type %d, have %d",
1926 It->XPectContextType,
1927 TP->Filter.ContextType);
1932 if (It->StaticList == NULL)
1933 List = It->GetHash(Target, TP);
1935 List = It->StaticList;
1937 DetectGroupChange = (It->Flags & IT_FLAG_DETECT_GROUPCHANGE) != 0;
1938 if (DetectGroupChange) {
1939 const StrBuf *BSort;
1940 DetectGroupChange = 0;
1941 if (havebstr("SortBy")) {
1942 BSort = sbstr("SortBy");
1943 if (GetHash(SortHash, SKEY(BSort), &vSortBy) &&
1944 (vSortBy != NULL)) {
1945 SortBy = (SortStruct*)vSortBy;
1946 /** Ok, its us, lets see in which direction we should sort... */
1947 if (havebstr("SortOrder")) {
1949 SortOrder = LBSTR("SortOrder");
1951 DetectGroupChange = 1;
1956 nMembersUsed = GetCount(List);
1957 SubBuf = NewStrBuf();
1958 SubTP.Filter.ContextType = It->ContextType;
1959 SubTP.Filter.ControlContextType = CTX_ITERATE;
1960 SubTP.ControlContext = &Status;
1962 if (HAVE_PARAM(2)) {
1963 StartAt = GetTemplateTokenNumber(Target, TP, 2, 0);
1965 if (HAVE_PARAM(3)) {
1966 StepWidth = GetTemplateTokenNumber(Target, TP, 3, 0);
1968 if (HAVE_PARAM(4)) {
1969 StopAt = GetTemplateTokenNumber(Target, TP, 4, -1);
1971 it = GetNewHashPos(List, StepWidth);
1973 StopAt = GetCount(List);
1975 while (GetNextHashPos(List, it, &Status.KeyLen, &Status.Key, &vContext)) {
1976 if ((Status.n >= StartAt) && (Status.n <= StopAt)) {
1977 if (DetectGroupChange && Status.n > 0) {
1978 Status.GroupChange = (SortBy->GroupChange(vContext, vLastContext))? 1:0;
1980 Status.LastN = (Status.n + 1) == nMembersUsed;
1981 SubTP.Context = vContext;
1982 if (It->DoSubTemplate != NULL)
1983 It->DoSubTemplate(SubBuf, &SubTP);
1984 DoTemplate(TKEY(1), SubBuf, &SubTP);
1986 StrBufAppendBuf(Target, SubBuf, 0);
1987 FlushStrBuf(SubBuf);
1988 Status.oddeven = ! Status.oddeven;
1989 vLastContext = vContext;
1993 FreeStrBuf(&SubBuf);
1995 if (It->Destructor != NULL)
1996 It->Destructor(&List);
2000 int conditional_ITERATE_ISGROUPCHANGE(StrBuf *Target, WCTemplputParams *TP)
2002 IterateStruct *Ctx = CCTX;
2003 return Ctx->GroupChange;
2006 void tmplput_ITERATE_ODDEVEN(StrBuf *Target, WCTemplputParams *TP)
2008 IterateStruct *Ctx = CCTX;
2010 StrBufAppendBufPlain(Target, HKEY("odd"), 0);
2012 StrBufAppendBufPlain(Target, HKEY("even"), 0);
2016 void tmplput_ITERATE_KEY(StrBuf *Target, WCTemplputParams *TP)
2018 IterateStruct *Ctx = CCTX;
2020 StrBufAppendBufPlain(Target, Ctx->Key, Ctx->KeyLen, 0);
2024 void tmplput_ITERATE_LASTN(StrBuf *Target, WCTemplputParams *TP)
2026 IterateStruct *Ctx = CCTX;
2027 StrBufAppendPrintf(Target, "%d", Ctx->n);
2030 int conditional_ITERATE_LASTN(StrBuf *Target, WCTemplputParams *TP)
2032 IterateStruct *Ctx = CCTX;
2038 /*-----------------------------------------------------------------------------
2041 int EvaluateConditional(StrBuf *Target, int Neg, int state, WCTemplputParams *TP)
2043 ConditionalStruct *Cond;
2045 if ((TP->Tokens->Params[0]->len == 1) &&
2046 (TP->Tokens->Params[0]->Start[0] == 'X'))
2047 return (state != 0)?TP->Tokens->Params[1]->lvalue:0;
2049 Cond = (ConditionalStruct *) TP->Tokens->PreEval;
2052 Target, "Conditional", ERR_PARM1, TP,
2057 if (!CheckContext(Target, &Cond->Filter, TP, "Conditional")) {
2061 if (Cond->CondF(Target, TP) == Neg)
2062 return TP->Tokens->Params[1]->lvalue;
2066 int ConditionalVar(StrBuf *Target, WCTemplputParams *TP)
2071 if (!GetHash(WC->vars, TKEY(2), &vsubst))
2073 subst = (wcsubst*) vsubst;
2075 switch(subst->wcs_type) {
2077 return (subst->wcs_function!=NULL);
2079 lprintf(1, " -> Server [%s]\n", subst->wcs_value);/* TODO */
2083 case WCS_STRBUF_REF:
2084 if (TP->Tokens->nParameters < 4)
2086 return (strcmp(TP->Tokens->Params[3]->Start, ChrPtr(subst->wcs_value)) == 0);
2088 if (TP->Tokens->nParameters < 4)
2089 return (subst->lvalue != 0);
2090 return (subst->lvalue == TP->Tokens->Params[3]->lvalue);
2092 lprintf(1," WARNING: invalid type: [%ld]!\n", subst->wcs_type);
2098 void RegisterConditional(const char *Name, long len,
2100 WCConditionalFunc CondF,
2101 int ContextRequired)
2103 ConditionalStruct *Cond;
2105 Cond = (ConditionalStruct*)malloc(sizeof(ConditionalStruct));
2106 memset(Cond, 0, sizeof(ConditionalStruct));
2107 Cond->PlainName = Name;
2108 Cond->Filter.nMaxArgs = nParams;
2109 Cond->Filter.nMinArgs = nParams;
2110 Cond->CondF = CondF;
2111 Cond->Filter.ContextType = ContextRequired;
2112 Cond->Filter.ControlContextType = CTX_NONE;
2113 Put(Conditionals, Name, len, Cond, NULL);
2116 void RegisterControlConditional(const char *Name, long len,
2118 WCConditionalFunc CondF,
2119 int ControlContextRequired)
2121 ConditionalStruct *Cond;
2123 Cond = (ConditionalStruct*)malloc(sizeof(ConditionalStruct));
2124 memset(Cond, 0, sizeof(ConditionalStruct));
2125 Cond->PlainName = Name;
2126 Cond->Filter.nMaxArgs = nParams;
2127 Cond->Filter.nMinArgs = nParams;
2128 Cond->CondF = CondF;
2129 Cond->Filter.ContextType = CTX_NONE;
2130 Cond->Filter.ControlContextType = ControlContextRequired;
2131 Put(Conditionals, Name, len, Cond, NULL);
2134 /*-----------------------------------------------------------------------------
2137 void tmplput_ContextString(StrBuf *Target, WCTemplputParams *TP)
2139 StrBufAppendTemplate(Target, TP, (StrBuf*)CTX, 0);
2141 int ConditionalContextStr(StrBuf *Target, WCTemplputParams *TP)
2143 StrBuf *TokenText = (StrBuf*) CTX;
2144 const char *CompareToken;
2147 GetTemplateTokenString(Target, TP, 2, &CompareToken, &len);
2148 return strcmp(ChrPtr(TokenText), CompareToken) == 0;
2151 /*-----------------------------------------------------------------------------
2155 void tmpl_do_boxed(StrBuf *Target, WCTemplputParams *TP)
2157 WCTemplputParams SubTP;
2160 if (TP->Tokens->nParameters == 2) {
2161 if (TP->Tokens->Params[1]->Type == TYPE_STR) {
2162 Headline = NewStrBuf();
2163 DoTemplate(TKEY(1), Headline, TP);
2168 GetTemplateTokenString(Target,
2173 Headline = NewStrBufPlain(Ch, len);
2176 memcpy (&SubTP, TP, sizeof(WCTemplputParams));
2177 SubTP.Context = Headline;
2178 SubTP.Filter.ContextType = CTX_STRBUF;
2179 DoTemplate(HKEY("beginbox"), Target, &SubTP);
2180 DoTemplate(TKEY(0), Target, TP);
2181 DoTemplate(HKEY("endbox"), Target, TP);
2182 FreeStrBuf(&Headline);
2185 /*-----------------------------------------------------------------------------
2189 void tmpl_do_tabbed(StrBuf *Target, WCTemplputParams *TP)
2192 int i, ntabs, nTabs;
2194 nTabs = ntabs = TP->Tokens->nParameters / 2;
2195 TabNames = (StrBuf **) malloc(ntabs * sizeof(StrBuf*));
2196 memset(TabNames, 0, ntabs * sizeof(StrBuf*));
2198 for (i = 0; i < ntabs; i++) {
2199 if ((TP->Tokens->Params[i * 2]->Type == TYPE_STR) &&
2200 (TP->Tokens->Params[i * 2]->len > 0)) {
2201 TabNames[i] = NewStrBuf();
2202 DoTemplate(TKEY(i * 2), TabNames[i], TP);
2204 else if (TP->Tokens->Params[i * 2]->Type == TYPE_GETTEXT) {
2207 GetTemplateTokenString(Target,
2212 TabNames[i] = NewStrBufPlain(Ch, -1);
2215 /** A Tab without subject? we can't count that, add it as silent */
2220 StrTabbedDialog(Target, nTabs, TabNames);
2221 for (i = 0; i < ntabs; i++) {
2222 StrBeginTab(Target, i, nTabs);
2223 DoTemplate(TKEY(i * 2 + 1), Target, TP);
2224 StrEndTab(Target, i, nTabs);
2229 /*-----------------------------------------------------------------------------
2234 void RegisterSortFunc(const char *name, long len,
2235 const char *prepend, long preplen,
2236 CompareFunc Forward,
2237 CompareFunc Reverse,
2238 CompareFunc GroupChange,
2241 SortStruct *NewSort;
2243 NewSort = (SortStruct*) malloc(sizeof(SortStruct));
2244 memset(NewSort, 0, sizeof(SortStruct));
2245 NewSort->Name = NewStrBufPlain(name, len);
2246 if (prepend != NULL)
2247 NewSort->PrefPrepend = NewStrBufPlain(prepend, preplen);
2249 NewSort->PrefPrepend = NULL;
2250 NewSort->Forward = Forward;
2251 NewSort->Reverse = Reverse;
2252 NewSort->GroupChange = GroupChange;
2253 NewSort->ContextType = ContextType;
2254 Put(SortHash, name, len, NewSort, DestroySortStruct);
2257 CompareFunc RetrieveSort(WCTemplputParams *TP,
2258 const char *OtherPrefix, long OtherPrefixLen,
2259 const char *Default, long ldefault, long DefaultDirection)
2262 const StrBuf *BSort = NULL;
2265 long SortOrder = -1;
2267 if (havebstr("SortBy")) {
2268 BSort = sbstr("SortBy");
2269 if (OtherPrefix == NULL) {
2270 set_room_pref("sort", NewStrBufDup(BSort), 0);
2273 set_X_PREFS(HKEY("sort"), OtherPrefix, OtherPrefixLen, NewStrBufDup(BSort), 0);
2276 else { /** Try to fallback to our remembered values... */
2277 if (OtherPrefix == NULL) {
2278 BSort = get_room_pref("sort");
2281 BSort = get_X_PREFS(HKEY("sort"), OtherPrefix, OtherPrefixLen);
2284 putbstr("SortBy", NewStrBufDup(BSort));
2288 BSort = Buf = NewStrBufPlain(Default, ldefault);
2289 putbstr("SortBy", Buf);
2293 if (!GetHash(SortHash, SKEY(BSort), &vSortBy) ||
2294 (vSortBy == NULL)) {
2296 if (!GetHash(SortHash, Default, ldefault, &vSortBy) ||
2297 (vSortBy == NULL)) {
2299 NULL, "Sorting", ERR_PARM1, TP,
2300 "Illegal default sort: [%s]", Default);
2304 SortBy = (SortStruct*)vSortBy;
2306 /** Ok, its us, lets see in which direction we should sort... */
2307 if (havebstr("SortOrder")) {
2308 SortOrder = LBSTR("SortOrder");
2310 else { /** Try to fallback to our remembered values... */
2312 if (SortBy->PrefPrepend == NULL) {
2313 Buf = get_room_pref("SortOrder");
2314 SortOrder = StrTol(Buf);
2317 BSort = get_X_PREFS(HKEY("SortOrder"), OtherPrefix, OtherPrefixLen);
2321 SortOrder = DefaultDirection;
2323 Buf = NewStrBufPlain(NULL, 64);
2324 StrBufPrintf(Buf, "%ld", SortOrder);
2325 putbstr("SortOrder", Buf);
2327 switch (SortOrder) {
2332 return SortBy->Forward;
2334 return SortBy->Reverse;
2346 ConstStr SortIcons[] = {
2347 {HKEY("static/sort_none.gif")},
2348 {HKEY("static/up_pointer.gif")},
2349 {HKEY("static/down_pointer.gif")},
2352 ConstStr SortNextOrder[] = {
2359 int GetSortMetric(WCTemplputParams *TP, SortStruct **Next, SortStruct **Param, long *SortOrder, int N)
2361 int bSortError = eNOT_SPECIFIED;
2362 const StrBuf *BSort;
2367 if (!GetHash(SortHash, TKEY(0), &vSort) ||
2369 return eNO_SUCH_SORT;
2370 *Param = (SortStruct*) vSort;
2373 if (havebstr("SortBy")) {
2374 BSort = sbstr("SortBy");
2375 bSortError = eINVALID_PARAM;
2376 if ((*Param)->PrefPrepend == NULL) {
2377 set_room_pref("sort", NewStrBufDup(BSort), 0);
2380 set_X_PREFS(HKEY("sort"), TKEY(N), NewStrBufDup(BSort), 0);
2383 else { /** Try to fallback to our remembered values... */
2384 if ((*Param)->PrefPrepend == NULL) {
2385 BSort = get_room_pref("sort");
2388 BSort = get_X_PREFS(HKEY("sort"), TKEY(N));
2392 if (!GetHash(SortHash, SKEY(BSort), &vSort) ||
2396 *Next = (SortStruct*) vSort;
2398 /** Ok, its us, lets see in which direction we should sort... */
2399 if (havebstr("SortOrder")) {
2400 *SortOrder = LBSTR("SortOrder");
2402 else { /** Try to fallback to our remembered values... */
2403 if ((*Param)->PrefPrepend == NULL) {
2404 *SortOrder = StrTol(get_room_pref("SortOrder"));
2407 *SortOrder = StrTol(get_X_PREFS(HKEY("SortOrder"), TKEY(N)));
2417 void tmplput_SORT_ICON(StrBuf *Target, WCTemplputParams *TP)
2422 const ConstStr *SortIcon;
2424 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2427 Target, "Sorter", ERR_PARM1, TP,
2428 " Sorter [%s] unknown!",
2429 TP->Tokens->Params[0]->Start);
2431 case eINVALID_PARAM:
2432 LogTemplateError(NULL, "Sorter", ERR_PARM1, TP,
2433 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2435 case eNOT_SPECIFIED:
2437 if (Next == Param) {
2438 SortIcon = &SortIcons[SortOrder];
2440 else { /** Not Us... */
2441 SortIcon = &SortIcons[0];
2443 StrBufAppendBufPlain(Target, SortIcon->Key, SortIcon->len, 0);
2447 void tmplput_SORT_NEXT(StrBuf *Target, WCTemplputParams *TP)
2453 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2456 Target, "Sorter", ERR_PARM1, TP,
2457 " Sorter [%s] unknown!",
2458 TP->Tokens->Params[0]->Start);
2460 case eINVALID_PARAM:
2462 NULL, "Sorter", ERR_PARM1, TP,
2463 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2465 case eNOT_SPECIFIED:
2467 StrBufAppendBuf(Target, Param->Name, 0);
2472 void tmplput_SORT_ORDER(StrBuf *Target, WCTemplputParams *TP)
2475 const ConstStr *SortOrderStr;
2479 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2482 Target, "Sorter", ERR_PARM1, TP,
2483 " Sorter [%s] unknown!",
2484 TP->Tokens->Params[0]->Start);
2486 case eINVALID_PARAM:
2488 NULL, "Sorter", ERR_PARM1, TP,
2489 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2491 case eNOT_SPECIFIED:
2493 if (Next == Param) {
2494 SortOrderStr = &SortNextOrder[SortOrder];
2496 else { /** Not Us... */
2497 SortOrderStr = &SortNextOrder[0];
2499 StrBufAppendBufPlain(Target, SortOrderStr->Key, SortOrderStr->len, 0);
2504 void tmplput_long_vector(StrBuf *Target, WCTemplputParams *TP)
2506 long *LongVector = (long*) CTX;
2508 if ((TP->Tokens->Params[0]->Type == TYPE_LONG) &&
2509 (TP->Tokens->Params[0]->lvalue <= LongVector[0]))
2511 StrBufAppendPrintf(Target, "%ld", LongVector[TP->Tokens->Params[0]->lvalue]);
2515 if (TP->Tokens->Params[0]->Type != TYPE_LONG) {
2517 Target, "Longvector", ERR_NAME, TP,
2518 "needs a numerical Parameter!");
2522 Target, "LongVector", ERR_PARM1, TP,
2523 "doesn't have %ld Parameters, its just the size of %ld!",
2524 TP->Tokens->Params[0]->lvalue,
2530 void dbg_print_longvector(long *LongVector)
2532 StrBuf *Buf = NewStrBufPlain(HKEY("Longvector: ["));
2533 int nItems = LongVector[0];
2536 for (i = 0; i < nItems; i++) {
2538 StrBufAppendPrintf(Buf, "%d: %ld | ", i, LongVector[i]);
2540 StrBufAppendPrintf(Buf, "%d: %ld]\n", i, LongVector[i]);
2543 lprintf(1, ChrPtr(Buf));
2547 int ConditionalLongVector(StrBuf *Target, WCTemplputParams *TP)
2549 long *LongVector = (long*) CTX;
2551 if ((TP->Tokens->Params[2]->Type == TYPE_LONG) &&
2552 (TP->Tokens->Params[2]->lvalue <= LongVector[0])&&
2553 (TP->Tokens->Params[3]->Type == TYPE_LONG) &&
2554 (TP->Tokens->Params[3]->lvalue <= LongVector[0]))
2556 return LongVector[TP->Tokens->Params[2]->lvalue] ==
2557 LongVector[TP->Tokens->Params[3]->lvalue];
2561 if ((TP->Tokens->Params[2]->Type == TYPE_LONG) ||
2562 (TP->Tokens->Params[2]->Type == TYPE_LONG)) {
2564 Target, "ConditionalLongvector", ERR_PARM1, TP,
2565 "needs two long Parameter!");
2569 Target, "Longvector", ERR_PARM1, TP,
2570 "doesn't have %ld / %ld Parameters, its just the size of %ld!",
2571 TP->Tokens->Params[2]->lvalue,
2572 TP->Tokens->Params[3]->lvalue,
2583 memset(&NoCtx, 0, sizeof(WCTemplputParams));
2584 RegisterNamespace("SORT:ICON", 1, 2, tmplput_SORT_ICON, CTX_NONE);
2585 RegisterNamespace("SORT:ORDER", 1, 2, tmplput_SORT_ORDER, CTX_NONE);
2586 RegisterNamespace("SORT:NEXT", 1, 2, tmplput_SORT_NEXT, CTX_NONE);
2587 RegisterNamespace("CONTEXTSTR", 0, 1, tmplput_ContextString, CTX_STRBUF);
2588 RegisterNamespace("ITERATE", 2, 100, tmpl_iterate_subtmpl, CTX_NONE);
2589 RegisterNamespace("DOBOXED", 1, 2, tmpl_do_boxed, CTX_NONE);
2590 RegisterNamespace("DOTABBED", 2, 100, tmpl_do_tabbed, CTX_NONE);
2591 RegisterNamespace("LONGVECTOR", 1, 1, tmplput_long_vector, CTX_LONGVECTOR);
2592 RegisterConditional(HKEY("COND:SUBST"), 3, ConditionalVar, CTX_NONE);
2593 RegisterConditional(HKEY("COND:CONTEXTSTR"), 3, ConditionalContextStr, CTX_STRBUF);
2594 RegisterConditional(HKEY("COND:LONGVECTOR"), 4, ConditionalLongVector, CTX_LONGVECTOR);
2596 RegisterControlConditional(HKEY("COND:ITERATE:ISGROUPCHANGE"), 2,
2597 conditional_ITERATE_ISGROUPCHANGE,
2599 RegisterControlConditional(HKEY("COND:ITERATE:LASTN"), 2,
2600 conditional_ITERATE_LASTN,
2602 RegisterControlNS(HKEY("ITERATE:ODDEVEN"), 0, 0, tmplput_ITERATE_ODDEVEN, CTX_ITERATE);
2603 RegisterControlNS(HKEY("ITERATE:KEY"), 0, 0, tmplput_ITERATE_KEY, CTX_ITERATE);
2604 RegisterControlNS(HKEY("ITERATE:N"), 0, 0, tmplput_ITERATE_LASTN, CTX_ITERATE);
2608 ServerStartModule_SUBST
2611 WirelessTemplateCache = NewHash(1, NULL);
2612 WirelessLocalTemplateCache = NewHash(1, NULL);
2613 LocalTemplateCache = NewHash(1, NULL);
2614 TemplateCache = NewHash(1, NULL);
2616 GlobalNS = NewHash(1, NULL);
2617 Iterators = NewHash(1, NULL);
2618 Conditionals = NewHash(1, NULL);
2619 SortHash = NewHash(1, NULL);
2623 FinalizeModule_SUBST
2630 ServerShutdownModule_SUBST
2633 DeleteHash(&WirelessTemplateCache);
2634 DeleteHash(&WirelessLocalTemplateCache);
2635 DeleteHash(&TemplateCache);
2636 DeleteHash(&LocalTemplateCache);
2638 DeleteHash(&GlobalNS);
2639 DeleteHash(&Iterators);
2640 DeleteHash(&Conditionals);
2641 DeleteHash(&SortHash);
2647 SessionNewModule_SUBST
2654 SessionAttachModule_SUBST
2657 sess->vars = NewHash(1,NULL);
2661 SessionDetachModule_SUBST
2664 DeleteHash(&sess->vars);
2668 SessionDestroyModule_SUBST