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 NewHandler->Filter.nMinArgs = nMinArgs;
296 NewHandler->Filter.nMaxArgs = nMaxArgs;
297 NewHandler->Filter.ContextType = ContextRequired;
298 NewHandler->Filter.ControlContextType = CTX_NONE;
300 NewHandler->HandlerFunc = HandlerFunc;
301 Put(GlobalNS, NSName, len, NewHandler, NULL);
304 void RegisterControlNS(const char *NSName,
308 WCHandlerFunc HandlerFunc,
309 int ControlContextRequired)
311 HashHandler *NewHandler;
313 NewHandler = (HashHandler*) malloc(sizeof(HashHandler));
314 NewHandler->Filter.nMinArgs = nMinArgs;
315 NewHandler->Filter.nMaxArgs = nMaxArgs;
316 NewHandler->Filter.ContextType = CTX_NONE;
317 NewHandler->Filter.ControlContextType = ControlContextRequired;
318 NewHandler->HandlerFunc = HandlerFunc;
319 Put(GlobalNS, NSName, len, NewHandler, NULL);
324 int CheckContext(StrBuf *Target, ContextFilter *Need, WCTemplputParams *TP, const char *ErrType)
326 if ((Need->ContextType != CTX_NONE) &&
327 (Need->ContextType != TP->Filter.ContextType)) {
329 Target, ErrType, ERR_PARM1, TP,
330 " WARNING: requires Context: [%s], have [%s]!",
331 ContextName(Need->ContextType),
332 ContextName(TP->Filter.ContextType));
336 if ((Need->ControlContextType != CTX_NONE) &&
337 (Need->ControlContextType != TP->Filter.ControlContextType)) {
339 Target, ErrType, ERR_PARM1, TP,
340 " WARNING: requires Control Context: [%s], have [%s]!",
341 ContextName(Need->ControlContextType),
342 ContextName(TP->Filter.ControlContextType));
346 if (TP->Tokens->nParameters < Need->nMinArgs) {
347 LogTemplateError(Target, ErrType, ERR_NAME, TP,
348 "needs at least %ld params, have %ld",
350 TP->Tokens->nParameters);
354 else if (TP->Tokens->nParameters > Need->nMaxArgs) {
355 LogTemplateError(Target, ErrType, ERR_NAME, TP,
356 "just needs %ld params, you gave %ld",
358 TP->Tokens->nParameters);
366 void FreeToken(WCTemplateToken **Token)
369 FreeStrBuf(&(*Token)->FlatToken);
370 if ((*Token)->HaveParameters)
371 for (i = 0; i < (*Token)->nParameters; i++)
372 free((*Token)->Params[i]);
379 void FreeWCTemplate(void *vFreeMe)
382 WCTemplate *FreeMe = (WCTemplate*)vFreeMe;
384 if (FreeMe->TokenSpace > 0) {
385 for (i = 0; i < FreeMe->nTokensUsed; i ++) {
386 FreeToken(&FreeMe->Tokens[i]);
388 free(FreeMe->Tokens);
390 FreeStrBuf(&FreeMe->FileName);
391 FreeStrBuf(&FreeMe->Data);
392 FreeStrBuf(&FreeMe->MimeType);
398 * \brief debugging function to print array to log
400 void VarPrintTransition(void *vVar1, void *vVar2, int odd){}
402 * \brief debugging function to print array to log
404 void VarPrintEntry(const char *Key, void *vSubst, int odd)
407 lprintf(1,"Subst[%s] : ", Key);
408 ptr = (wcsubst*) vSubst;
410 switch(ptr->wcs_type) {
412 lprintf(1, " -> %s\n", ChrPtr(ptr->wcs_value));
415 lprintf(1, " -> Server [%s]\n", ChrPtr(ptr->wcs_value));
418 lprintf(1, " -> function at [%0xd]\n", ptr->wcs_function);
421 lprintf(1," WARNING: invalid type: [%ld]!\n", ptr->wcs_type);
428 * \brief Clear out the list of substitution variables local to this session
430 void clear_substs(wcsession *wc) {
432 if (wc->vars != NULL) {
433 DeleteHash(&wc->vars);
438 * \brief Clear out the list of substitution variables local to this session
440 void clear_local_substs(void) {
459 void FlushPayload(wcsubst *ptr, int reusestrbuf, int type)
461 int NeedNew = NeedNewBuf(type);
462 switch(ptr->wcs_type) {
466 if (reusestrbuf && NeedNew) {
467 FlushStrBuf(ptr->wcs_value);
471 FreeStrBuf(&ptr->wcs_value);
472 ptr->wcs_value = NULL;
476 ptr->wcs_function = NULL;
477 if (reusestrbuf && NeedNew)
478 ptr->wcs_value = NewStrBuf();
481 ptr->wcs_value = NULL;
482 if (reusestrbuf && NeedNew)
483 ptr->wcs_value = NewStrBuf();
487 if (reusestrbuf && NeedNew)
488 ptr->wcs_value = NewStrBuf();
491 if (reusestrbuf && NeedNew)
492 ptr->wcs_value = NewStrBuf();
499 * \brief destructor; kill one entry.
501 void deletevar(void *data)
503 wcsubst *ptr = (wcsubst*)data;
504 FlushPayload(ptr, 0, ptr->wcs_type);
509 wcsubst *NewSubstVar(const char *keyname, int keylen, int type)
514 ptr = (wcsubst *) malloc(sizeof(wcsubst));
515 memset(ptr, 0, sizeof(wcsubst));
517 ptr->wcs_type = type;
518 safestrncpy(ptr->wcs_key, keyname, sizeof ptr->wcs_key);
519 Put(WCC->vars, keyname, keylen, ptr, deletevar);
521 switch(ptr->wcs_type) {
524 ptr->wcs_value = NewStrBuf();
538 * \brief Add a substitution variable (local to this session) (strlen version...)
539 * \param keyname the replacementstring to substitute
540 * \param keytype the kind of the key
541 * \param format the format string ala printf
542 * \param ... the arguments to substitute in the formatstring
544 void SVPRINTF(char *keyname, int keytype, const char *format,...)
552 keylen = strlen(keyname);
554 * First look if we're doing a replacement of
557 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
558 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
559 ptr = (wcsubst*)vPtr;
560 FlushPayload(ptr, keytype, keytype);
561 ptr->wcs_type = keytype;
563 else /** Otherwise allocate a new one */
565 ptr = NewSubstVar(keyname, keylen, keytype);
568 /** Format the string */
569 va_start(arg_ptr, format);
570 StrBufVAppendPrintf(ptr->wcs_value, format, arg_ptr);
575 * \brief Add a substitution variable (local to this session)
576 * \param keyname the replacementstring to substitute
577 * \param keytype the kind of the key
578 * \param format the format string ala printf
579 * \param ... the arguments to substitute in the formatstring
581 void svprintf(char *keyname, size_t keylen, int keytype, const char *format,...)
589 * First look if we're doing a replacement of
592 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
593 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
594 ptr = (wcsubst*)vPtr;
595 FlushPayload(ptr, 1, keytype);
596 ptr->wcs_type = keytype;
598 else /** Otherwise allocate a new one */
600 ptr = NewSubstVar(keyname, keylen, keytype);
603 /** Format the string and save it */
604 va_start(arg_ptr, format);
605 StrBufVAppendPrintf(ptr->wcs_value, format, arg_ptr);
610 * \brief Add a substitution variable (local to this session)
611 * \param keyname the replacementstring to substitute
612 * \param keytype the kind of the key
613 * \param format the format string ala printf
614 * \param ... the arguments to substitute in the formatstring
616 void SVPut(char *keyname, size_t keylen, int keytype, char *Data)
624 * First look if we're doing a replacement of
627 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
628 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
629 ptr = (wcsubst*)vPtr;
630 FlushPayload(ptr, 1, keytype);
631 ptr->wcs_type = keytype;
633 else /** Otherwise allocate a new one */
635 ptr = NewSubstVar(keyname, keylen, keytype);
637 StrBufAppendBufPlain(ptr->wcs_value, Data, -1, 0);
641 * \brief Add a substitution variable (local to this session)
642 * \param keyname the replacementstring to substitute
643 * \param keytype the kind of the key
644 * \param format the format string ala printf
645 * \param ... the arguments to substitute in the formatstring
647 void SVPutLong(char *keyname, size_t keylen, long Data)
655 * First look if we're doing a replacement of
658 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
659 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
660 ptr = (wcsubst*)vPtr;
661 FlushPayload(ptr, 1, WCS_LONG);
662 ptr->wcs_type = WCS_LONG;
664 else /** Otherwise allocate a new one */
666 ptr = NewSubstVar(keyname, keylen, WCS_LONG);
672 * \brief Add a substitution variable (local to this session) that does a callback
673 * \param keyname the keystring to substitute
674 * \param fcn_ptr the function callback to give the substitution string
676 void SVCallback(char *keyname, size_t keylen, WCHandlerFunc fcn_ptr)
683 * First look if we're doing a replacement of
686 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
687 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
688 ptr = (wcsubst*)vPtr;
689 FlushPayload(ptr, 1, WCS_FUNCTION);
690 ptr->wcs_type = WCS_FUNCTION;
692 else /** Otherwise allocate a new one */
694 ptr = NewSubstVar(keyname, keylen, WCS_FUNCTION);
697 ptr->wcs_function = fcn_ptr;
699 inline void SVCALLBACK(char *keyname, WCHandlerFunc fcn_ptr)
701 SVCallback(keyname, strlen(keyname), fcn_ptr);
706 void SVPUTBuf(const char *keyname, int keylen, const StrBuf *Buf, int ref)
713 * First look if we're doing a replacement of
716 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
717 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
718 ptr = (wcsubst*)vPtr;
719 FlushPayload(ptr, 0, (ref)?WCS_STRBUF_REF:WCS_STRBUF);
720 ptr->wcs_type = (ref)?WCS_STRBUF_REF:WCS_STRBUF;
722 else /** Otherwise allocate a new one */
724 ptr = NewSubstVar(keyname, keylen, (ref)?WCS_STRBUF_REF:WCS_STRBUF);
726 ptr->wcs_value = (StrBuf*)Buf;
730 * \brief back end for print_value_of() ... does a server command
731 * \param servcmd server command to execute on the citadel server
733 void pvo_do_cmd(StrBuf *Target, StrBuf *servcmd) {
737 serv_puts(ChrPtr(servcmd));
738 len = serv_getln(buf, sizeof buf);
744 StrBufAppendPrintf(Target, "%s\n", &buf[4]);
747 _fmout(Target, "CENTER");
750 StrBufAppendPrintf(Target, "%s\n", &buf[4]);
756 void GetTemplateTokenString(StrBuf *Target,
757 WCTemplputParams *TP,
763 WCTemplputParams SubTP;
765 if (TP->Tokens->nParameters < N) {
766 LogTemplateError(Target,
767 "TokenParameter", N, TP,
768 "invalid token %d. this shouldn't have come till here.\n", N);
774 switch (TP->Tokens->Params[N]->Type) {
777 *Value = TP->Tokens->Params[N]->Start;
778 *len = TP->Tokens->Params[N]->len;
781 if (TP->Tokens->Params[N]->len == 0) {
782 LogTemplateError(Target,
783 "TokenParameter", N, TP,
784 "Requesting parameter %d; of type BSTR, empty lookup string not admitted.", N);
789 Buf = (StrBuf*) SBstr(TKEY(N));
790 *Value = ChrPtr(Buf);
791 *len = StrLength(Buf);
794 if (TP->Tokens->Params[N]->len == 0) {
795 LogTemplateError(Target,
796 "TokenParameter", N, TP,
797 "Requesting parameter %d; of type PREFSTR, empty lookup string not admitted.", N);
802 get_PREFERENCE(TKEY(N), &Buf);
803 *Value = ChrPtr(Buf);
804 *len = StrLength(Buf);
807 LogTemplateError(Target,
808 "TokenParameter", N, TP,
809 "Requesting parameter %d; of type LONG, want string.", N);
812 LogTemplateError(Target,
813 "TokenParameter", N, TP,
814 "Requesting parameter %d; of type PREFINT, want string.", N);
817 *Value = _(TP->Tokens->Params[N]->Start);
818 *len = strlen(*Value);
820 case TYPE_SUBTEMPLATE:
821 if (TP->Tokens->Params[N]->len == 0) {
822 LogTemplateError(Target,
823 "TokenParameter", N, TP,
824 "Requesting parameter %d; of type SUBTEMPLATE, empty lookup string not admitted.", N);
830 memset(&SubTP, 0, sizeof(WCTemplputParams *));
831 SubTP.Context = TP->Context;
832 SubTP.Filter.ContextType = TP->Filter.ContextType;
834 DoTemplate(TKEY(N), Buf, &SubTP);
835 *Value = ChrPtr(Buf);
836 *len = StrLength(Buf);
837 /* we can't free it here, so we put it into the subst so its discarded later on. */
838 SVPUTBuf(TKEY(N), Buf, 0);
842 LogTemplateError(Target,
843 "TokenParameter", N, TP,
844 "unknown param type %d; [%d]", N, TP->Tokens->Params[N]->Type);
849 long GetTemplateTokenNumber(StrBuf *Target, WCTemplputParams *TP, int N, long dflt)
852 if (TP->Tokens->nParameters < N) {
853 LogTemplateError(Target,
854 "TokenParameter", N, TP,
855 "invalid token %d. this shouldn't have come till here.\n", N);
860 switch (TP->Tokens->Params[N]->Type) {
863 return atol(TP->Tokens->Params[N]->Start);
866 if (TP->Tokens->Params[N]->len == 0) {
867 LogTemplateError(Target,
868 "TokenParameter", N, TP,
869 "Requesting parameter %d; of type BSTR, empty lookup string not admitted.", N);
872 return LBstr(TKEY(N));
875 LogTemplateError(Target,
876 "TokenParameter", N, TP,
877 "requesting a prefstring in param %d want a number", N);
878 if (TP->Tokens->Params[N]->len == 0) {
879 LogTemplateError(Target,
880 "TokenParameter", N, TP,
881 "Requesting parameter %d; of type PREFSTR, empty lookup string not admitted.", N);
884 if (get_PREF_LONG(TKEY(N), &Ret, dflt))
888 return TP->Tokens->Params[N]->lvalue;
890 if (TP->Tokens->Params[N]->len == 0) {
891 LogTemplateError(Target,
892 "TokenParameter", N, TP,
893 "Requesting parameter %d; of type PREFINT, empty lookup string not admitted.", N);
896 if (get_PREF_LONG(TKEY(N), &Ret, dflt))
900 LogTemplateError(Target,
901 "TokenParameter", N, TP,
902 "requesting a I18N string in param %d; want a number", N);
904 case TYPE_SUBTEMPLATE:
905 LogTemplateError(Target,
906 "TokenParameter", N, TP,
907 "requesting a subtemplate in param %d; not supported for numbers", N);
910 LogTemplateError(Target,
911 "TokenParameter", N, TP,
912 "unknown param type %d; [%d]", N, TP->Tokens->Params[N]->Type);
920 * \brief Print the value of a variable
921 * \param keyname get a key to print
923 void print_value_of(StrBuf *Target, WCTemplputParams *TP)
930 /*if (WCC->vars != NULL) PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
931 /* TODO: depricated! */
932 if (TP->Tokens->pName[0] == '=') {
933 DoTemplate(TP->Tokens->pName+1, TP->Tokens->NameEnd - 1, NULL, &NoCtx);
935 /*/////TODO: if param[1] == "U" -> urlescape
937 /** Page-local variables */
938 if ((WCC->vars!= NULL) && GetHash(WCC->vars, TP->Tokens->pName, TP->Tokens->NameEnd, &vVar)) {
939 ptr = (wcsubst*) vVar;
940 switch(ptr->wcs_type) {
942 StrBufAppendBuf(Target, ptr->wcs_value, 0);
945 pvo_do_cmd(Target, ptr->wcs_value);
948 (*ptr->wcs_function) (Target, TP);
952 StrBufAppendBuf(Target, ptr->wcs_value, 0);
955 StrBufAppendPrintf(Target, "%ld", ptr->lvalue);
959 Target, "Subst", ERR_NAME, TP,
960 "WARNING: invalid value in SV-Hash at %s!", TP->Tokens->pName);
965 Target, "Token", ERR_NAME, TP,
966 "didn't find Handler \"%s\"", TP->Tokens->pName);
971 int CompareSubstToToken(TemplateParam *ParamToCompare, TemplateParam *ParamToLookup)
977 if ((WCC->vars!= NULL) && GetHash(WCC->vars, ParamToLookup->Start,
978 ParamToLookup->len, &vVar)) {
979 ptr = (wcsubst*) vVar;
980 switch(ptr->wcs_type) {
984 if (ParamToCompare->Type == TYPE_STR)
985 return ((ParamToCompare->len == StrLength(ptr->wcs_value)) &&
986 (strcmp(ParamToCompare->Start, ChrPtr(ptr->wcs_value)) == 0));
988 return ParamToCompare->lvalue == StrTol(ptr->wcs_value);
996 if (ParamToCompare->Type == TYPE_STR)
999 return ParamToCompare->lvalue == ptr->lvalue;
1002 lprintf(1,"WARNING: invalid value in SV-Hash at %s!\n",
1003 ParamToLookup->Start);
1009 int CompareSubstToStrBuf(StrBuf *Compare, TemplateParam *ParamToLookup)
1011 wcsession *WCC = WC;
1015 if ((WCC->vars!= NULL) && GetHash(WCC->vars, ParamToLookup->Start,
1016 ParamToLookup->len, &vVar)) {
1017 ptr = (wcsubst*) vVar;
1018 switch(ptr->wcs_type) {
1021 case WCS_STRBUF_REF:
1022 return ((StrLength(Compare) == StrLength(ptr->wcs_value)) &&
1023 (strcmp(ChrPtr(Compare), ChrPtr(ptr->wcs_value)) == 0));
1030 return StrTol(Compare) == ptr->lvalue;
1032 lprintf(1,"WARNING: invalid value in SV-Hash at %s!\n",
1033 ParamToLookup->Start);
1042 * \brief puts string into the template and computes which escape methon we should use
1043 * \param Source the string we should put into the template
1044 * \param FormatTypeIndex where should we look for escape types if?
1046 void StrBufAppendTemplate(StrBuf *Target,
1047 WCTemplputParams *TP,
1048 const StrBuf *Source, int FormatTypeIndex)
1051 char EscapeAs = ' ';
1053 if ((FormatTypeIndex < TP->Tokens->nParameters) &&
1054 (TP->Tokens->Params[FormatTypeIndex]->Type == TYPE_STR) &&
1055 (TP->Tokens->Params[FormatTypeIndex]->len == 1)) {
1056 EscapeAs = *TP->Tokens->Params[FormatTypeIndex]->Start;
1063 StrEscAppend(Target, Source, NULL, 0, 2);
1066 StrEscAppend(Target, Source, NULL, 0, 0);
1069 StrECMAEscAppend(Target, Source, NULL);
1072 StrBufUrlescAppend(Target, Source, NULL);
1075 StrBufAppendBuf(Target, Source, 0);
1080 void PutNewToken(WCTemplate *Template, WCTemplateToken *NewToken)
1082 if (Template->nTokensUsed + 1 >= Template->TokenSpace) {
1083 if (Template->TokenSpace <= 0) {
1084 Template->Tokens = (WCTemplateToken**)malloc(
1085 sizeof(WCTemplateToken*) * 10);
1086 Template->TokenSpace = 10;
1089 WCTemplateToken **NewTokens;
1090 NewTokens= (WCTemplateToken**)malloc(
1091 sizeof(WCTemplateToken*) *
1092 Template->TokenSpace * 2);
1093 memcpy(NewTokens, Template->Tokens,
1094 sizeof(WCTemplateToken*) * Template->nTokensUsed);
1095 free(Template->Tokens);
1096 Template->TokenSpace *= 2;
1097 Template->Tokens = NewTokens;
1100 Template->Tokens[(Template->nTokensUsed)++] = NewToken;
1103 TemplateParam *GetNextParameter(StrBuf *Buf, const char **pCh, const char *pe, WCTemplateToken *Tokens, WCTemplate *pTmpl)
1105 const char *pch = *pCh;
1106 const char *pchs, *pche;
1107 TemplateParam *Parm = (TemplateParam *) malloc(sizeof(TemplateParam));
1111 Parm->Type = TYPE_STR;
1113 /* Skip leading whitespaces */
1114 while ((*pch == ' ' )||
1117 (*pch == '\n')) pch ++;
1120 Parm->Type = TYPE_PREFSTR;
1127 else if (*pch == ';') {
1128 Parm->Type = TYPE_PREFINT;
1135 else if (*pch == '_') {
1136 Parm->Type = TYPE_GETTEXT;
1143 else if (*pch == 'B') {
1144 Parm->Type = TYPE_BSTR;
1151 else if (*pch == '=') {
1152 Parm->Type = TYPE_SUBTEMPLATE;
1163 else if (*pch == '\'')
1165 if (quote != '\0') {
1170 ( (pch > pchs) && (*(pch - 1) == '\\'))
1175 if (*pch != quote) {
1176 lprintf(1, "Error (in '%s' line %ld); "
1177 "evaluating template param [%s] in Token [%s]\n",
1178 ChrPtr(pTmpl->FileName),
1180 ChrPtr(Tokens->FlatToken),
1187 StrBufPeek(Buf, pch, -1, '\0');
1188 if (LoadTemplates > 1) {
1189 lprintf(1, "DBG: got param [%s] %ld %ld\n",
1190 pchs, pche - pchs, strlen(pchs));
1193 Parm->len = pche - pchs;
1194 pch ++; /* move after trailing quote */
1195 if (ParamBrace && (*pch == ')')) {
1202 Parm->Type = TYPE_LONG;
1204 while ((pch <= pe) &&
1210 if (pch - pchs > 1){
1211 StrBufPeek(Buf, pch, -1, '\0');
1212 Parm->lvalue = atol(pchs);
1219 lprintf(1, "Error (in '%s' line %ld); "
1220 "evaluating long template param [%s] in Token [%s]\n",
1221 ChrPtr(pTmpl->FileName),
1223 ChrPtr(Tokens->FlatToken),
1230 while ((*pch == ' ' )||
1234 (*pch == '\n')) pch ++;
1236 if (DumpTemplateI18NStrings && (Parm->Type == TYPE_GETTEXT)) {
1237 StrBufAppendPrintf(I18nDump, "_(\"%s\");\n", Parm->Start);
1243 WCTemplateToken *NewTemplateSubstitute(StrBuf *Buf,
1245 const char *pTmplStart,
1246 const char *pTmplEnd,
1252 TemplateParam *Param;
1253 WCTemplateToken *NewToken = (WCTemplateToken*)malloc(sizeof(WCTemplateToken));
1254 WCTemplputParams TP;
1256 TP.Tokens = NewToken;
1257 NewToken->FileName = pTmpl->FileName; /* to print meaningfull log messages... */
1258 NewToken->Flags = 0;
1259 NewToken->Line = Line + 1;
1260 NewToken->pTokenStart = pTmplStart;
1261 NewToken->TokenStart = pTmplStart - pStart;
1262 NewToken->TokenEnd = (pTmplEnd - pStart) - NewToken->TokenStart;
1263 NewToken->pTokenEnd = pTmplEnd;
1264 NewToken->NameEnd = NewToken->TokenEnd - 2;
1265 NewToken->PreEval = NULL;
1266 NewToken->FlatToken = NewStrBufPlain(pTmplStart + 2, pTmplEnd - pTmplStart - 2);
1268 StrBufPeek(Buf, pTmplStart, + 1, '\0');
1269 StrBufPeek(Buf, pTmplEnd, -1, '\0');
1270 pch = NewToken->pName = pTmplStart + 2;
1272 NewToken->HaveParameters = 0;;
1273 NewToken->nParameters = 0;
1275 while (pch < pTmplEnd - 1) {
1277 StrBufPeek(Buf, pch, -1, '\0');
1278 NewToken->NameEnd = pch - NewToken->pName;
1280 if (*(pTmplEnd - 1) != ')') {
1282 NULL, "Parseerror", ERR_NAME, &TP,
1283 "Warning, Non welformed Token; missing right parenthesis");
1285 while (pch < pTmplEnd - 1) {
1286 Param = GetNextParameter(Buf, &pch, pTmplEnd - 1, NewToken, pTmpl);
1287 if (Param != NULL) {
1288 NewToken->HaveParameters = 1;
1289 if (NewToken->nParameters > MAXPARAM) {
1291 NULL, "Parseerror", ERR_NAME, &TP,
1292 "only [%d] Params allowed in Tokens",
1296 FreeToken(&NewToken);
1299 NewToken->Params[NewToken->nParameters++] = Param;
1303 if((NewToken->NameEnd == 1) &&
1304 (NewToken->HaveParameters == 1))
1307 if (*(NewToken->pName) == '_')
1308 NewToken->Flags = SV_GETTEXT;
1309 else if (*(NewToken->pName) == '=')
1310 NewToken->Flags = SV_SUBTEMPL;
1311 else if (*(NewToken->pName) == '%')
1312 NewToken->Flags = SV_CUST_STR_CONDITIONAL;
1313 else if (*(NewToken->pName) == '?')
1314 NewToken->Flags = SV_CONDITIONAL;
1315 else if (*(NewToken->pName) == '!')
1316 NewToken->Flags = SV_NEG_CONDITIONAL;
1322 switch (NewToken->Flags) {
1324 /* If we're able to find out more about the token, do it now while its fresh. */
1325 if (GetHash(GlobalNS, NewToken->pName, NewToken->NameEnd, &vVar)) {
1326 HashHandler *Handler;
1327 Handler = (HashHandler*) vVar;
1328 if ((NewToken->nParameters < Handler->Filter.nMinArgs) ||
1329 (NewToken->nParameters > Handler->Filter.nMaxArgs)) {
1331 NULL, "Token", ERR_NAME, &TP,
1332 "doesn't work with %d params",
1333 NewToken->nParameters);
1337 NewToken->PreEval = Handler;
1338 NewToken->Flags = SV_PREEVALUATED;
1343 if (NewToken->nParameters !=1) {
1345 NULL, "Gettext", ERR_NAME, &TP,
1346 "requires exactly 1 parameter, you gave %d params",
1347 NewToken->nParameters);
1348 NewToken->Flags = 0;
1351 if (DumpTemplateI18NStrings) {
1352 StrBufAppendPrintf(I18nDump, "_(\"%s\");\n", NewToken->Params[0]->Start);
1356 if (NewToken->nParameters != 1) {
1358 NULL, "Subtemplates", ERR_NAME, &TP,
1359 "require exactly 1 parameter, you gave %d params",
1360 NewToken->nParameters);
1364 case SV_CUST_STR_CONDITIONAL:
1365 case SV_CONDITIONAL:
1366 case SV_NEG_CONDITIONAL:
1367 if (NewToken->nParameters <2) {
1369 NULL, "Conditional", ERR_NAME, &TP,
1370 "require at least 2 parameters, you gave %d params",
1371 NewToken->nParameters);
1372 NewToken->Flags = 0;
1375 if (NewToken->Params[1]->lvalue == 0) {
1377 NULL, "Conditional", ERR_NAME, &TP,
1378 "Conditional ID (Parameter 1) mustn't be 0!");
1379 NewToken->Flags = 0;
1382 if (!GetHash(Conditionals,
1383 NewToken->Params[0]->Start,
1384 NewToken->Params[0]->len,
1387 if ((NewToken->Params[0]->len == 1) &&
1388 (NewToken->Params[0]->Start[0] == 'X'))
1391 NULL, "Conditional", ERR_NAME, &TP,
1394 NewToken->Error = NewStrBuf();
1397 "<pre>\nConditional [%s] (in '%s' line %ld); Not found!\n[%s]\n</pre>\n",
1398 NewToken->Params[0]->Start,
1399 ChrPtr(pTmpl->FileName),
1401 ChrPtr(NewToken->FlatToken));
1405 NewToken->PreEval = vVar;
1417 * \brief Display a variable-substituted template
1418 * \param templatename template file to load
1420 void *prepare_template(StrBuf *filename, StrBuf *Key, HashList *PutThere)
1422 WCTemplate *NewTemplate;
1423 NewTemplate = (WCTemplate *) malloc(sizeof(WCTemplate));
1424 NewTemplate->Data = NULL;
1425 NewTemplate->FileName = NewStrBufDup(filename);
1426 NewTemplate->nTokensUsed = 0;
1427 NewTemplate->TokenSpace = 0;
1428 NewTemplate->Tokens = NULL;
1429 NewTemplate->MimeType = NewStrBufPlain(GuessMimeByFilename (SKEY(NewTemplate->FileName)), -1);
1430 if (strstr(ChrPtr(NewTemplate->MimeType), "text") != NULL) {
1431 StrBufAppendBufPlain(NewTemplate->MimeType, HKEY("; charset=utf-8"), 0);
1434 Put(PutThere, ChrPtr(Key), StrLength(Key), NewTemplate, FreeWCTemplate);
1439 * \brief Display a variable-substituted template
1440 * \param templatename template file to load
1442 void *load_template(StrBuf *filename, StrBuf *Key, HashList *PutThere)
1445 struct stat statbuf;
1446 const char *pS, *pE, *pch, *Err;
1449 WCTemplate *NewTemplate;
1451 fd = open(ChrPtr(filename), O_RDONLY);
1453 lprintf(1, "ERROR: could not open template '%s' - %s\n",
1454 ChrPtr(filename), strerror(errno));
1458 if (fstat(fd, &statbuf) == -1) {
1459 lprintf(1, "ERROR: could not stat template '%s' - %s\n",
1460 ChrPtr(filename), strerror(errno));
1464 NewTemplate = (WCTemplate *) malloc(sizeof(WCTemplate));
1465 NewTemplate->Data = NewStrBufPlain(NULL, statbuf.st_size);
1466 NewTemplate->FileName = NewStrBufDup(filename);
1467 NewTemplate->nTokensUsed = 0;
1468 NewTemplate->TokenSpace = 0;
1469 NewTemplate->Tokens = NULL;
1470 NewTemplate->MimeType = NewStrBufPlain(GuessMimeByFilename (SKEY(NewTemplate->FileName)), -1);
1471 if (strstr(ChrPtr(NewTemplate->MimeType), "text") != NULL) {
1472 StrBufAppendBufPlain(NewTemplate->MimeType, HKEY("; charset=utf-8"), 0);
1475 if (StrBufReadBLOB(NewTemplate->Data, &fd, 1, statbuf.st_size, &Err) < 0) {
1477 FreeWCTemplate(NewTemplate);
1478 lprintf(1, "ERROR: reading template '%s' - %s<br />\n",
1479 ChrPtr(filename), strerror(errno));
1485 StrBufShrinkToFit(NewTemplate->Data, 1);
1486 pS = pch = ChrPtr(NewTemplate->Data);
1487 pE = pS + StrLength(NewTemplate->Data);
1489 const char *pts, *pte;
1491 int InDoubleQuotes = 0;
1493 /** Find one <? > */
1495 for (; pch < pE; pch ++) {
1496 if ((*pch=='<')&&(*(pch + 1)=='?'))
1498 if (*pch=='\n') Line ++;
1504 /** Found one? parse it. */
1505 for (; pch <= pE - 1; pch ++) {
1507 InDoubleQuotes = ! InDoubleQuotes;
1508 else if (*pch == '\'')
1509 InQuotes = ! InQuotes;
1510 else if ((!InQuotes && !InDoubleQuotes) &&
1511 ((*pch!='\\')&&(*(pch + 1)=='>'))) {
1519 PutNewToken(NewTemplate,
1520 NewTemplateSubstitute(NewTemplate->Data, pS, pts, pte, Line, NewTemplate));
1523 if (LoadTemplates == 0)
1524 Put(PutThere, ChrPtr(Key), StrLength(Key), NewTemplate, FreeWCTemplate);
1529 const char* PrintTemplate(void *vSubst)
1531 WCTemplate *Tmpl = vSubst;
1533 return ChrPtr(Tmpl->FileName);
1537 int LoadTemplateDir(const char *DirName, HashList *wireless, HashList *big)
1542 DIR *filedir = NULL;
1543 struct dirent *filedir_entry;
1549 StrBufPrintf(Dir, "%s/t", DirName);
1550 filedir = opendir (ChrPtr(Dir));
1551 if (filedir == NULL) {
1556 FileName = NewStrBuf();
1558 while ((filedir_entry = readdir(filedir)))
1562 #ifdef _DIRENT_HAVE_D_NAMELEN
1563 d_namelen = filedir_entry->d_namelen;
1565 d_namelen = strlen(filedir_entry->d_name);
1567 d_without_ext = d_namelen;
1568 while ((d_without_ext > 0) && (filedir_entry->d_name[d_without_ext] != '.'))
1570 if ((d_without_ext == 0) || (d_namelen < 3))
1572 if ((d_namelen > 1) && filedir_entry->d_name[d_namelen - 1] == '~')
1573 continue; /* Ignore backup files... */
1575 IsMobile = (strstr(filedir_entry->d_name, ".m.html")!= NULL);
1576 PStart = filedir_entry->d_name;
1577 StrBufPrintf(FileName, "%s/%s", ChrPtr(Dir), filedir_entry->d_name);
1578 MinorPtr = strchr(filedir_entry->d_name, '.');
1579 if (MinorPtr != NULL)
1581 StrBufPlain(Tag, filedir_entry->d_name, MinorPtr - filedir_entry->d_name);
1583 if (LoadTemplates > 1)
1584 lprintf(1, "%s %d %s\n",ChrPtr(FileName), IsMobile, ChrPtr(Tag));
1585 if (LoadTemplates == 0)
1586 load_template(FileName, Tag, (IsMobile)?wireless:big);
1588 prepare_template(FileName, Tag, (IsMobile)?wireless:big);
1591 FreeStrBuf(&FileName);
1597 void InitTemplateCache(void)
1599 LoadTemplateDir(static_dirs[0],
1600 WirelessTemplateCache,
1602 LoadTemplateDir(static_dirs[1],
1603 WirelessLocalTemplateCache,
1604 LocalTemplateCache);
1609 /*-----------------------------------------------------------------------------
1610 * Filling & processing Templates
1613 * \brief executes one token
1614 * \param Target buffer to append to
1615 * \param Token da to process.
1616 * \param Template we're iterating
1617 * \param Context Contextpoointer to pass in
1618 * \param state are we in conditional state?
1619 * \param ContextType what type of information does context giv us?
1621 int EvaluateToken(StrBuf *Target, int state, WCTemplputParams *TP)
1623 const char *AppendMe;
1625 HashHandler *Handler;
1628 /* much output, since pName is not terminated...
1629 lprintf(1,"Doing token: %s\n",Token->pName);
1632 switch (TP->Tokens->Flags) {
1634 TmplGettext(Target, TP);
1636 case SV_CONDITIONAL: /** Forward conditional evaluation */
1637 return EvaluateConditional(Target, 1, state, TP);
1639 case SV_NEG_CONDITIONAL: /** Reverse conditional evaluation */
1640 return EvaluateConditional(Target, 0, state, TP);
1642 case SV_CUST_STR_CONDITIONAL: /** Conditional put custom strings from params */
1643 if (TP->Tokens->nParameters >= 6) {
1644 if (EvaluateConditional(Target, 0, state, TP)) {
1645 GetTemplateTokenString(Target, TP, 5, &AppendMe, &AppendMeLen);
1646 StrBufAppendBufPlain(Target,
1652 GetTemplateTokenString(Target, TP, 4, &AppendMe, &AppendMeLen);
1653 StrBufAppendBufPlain(Target,
1661 Target, "Conditional", ERR_NAME, TP,
1662 "needs at least 6 Params!");
1666 if (TP->Tokens->nParameters == 1)
1667 DoTemplate(TKEY(0), Target, TP);
1669 case SV_PREEVALUATED:
1670 Handler = (HashHandler*) TP->Tokens->PreEval;
1671 if (!CheckContext(Target, &Handler->Filter, TP, "Token")) {
1674 Handler->HandlerFunc(Target, TP);
1677 if (GetHash(GlobalNS, TP->Tokens->pName, TP->Tokens->NameEnd, &vVar)) {
1678 Handler = (HashHandler*) vVar;
1679 if (!CheckContext(Target, &Handler->Filter, TP, "Token")) {
1683 Handler->HandlerFunc(Target, TP);
1687 print_value_of(Target, TP);
1695 const StrBuf *ProcessTemplate(WCTemplate *Tmpl, StrBuf *Target, WCTemplputParams *CallingTP)
1697 WCTemplate *pTmpl = Tmpl;
1700 const char *pData, *pS;
1702 WCTemplputParams TP;
1704 memcpy(&TP.Filter, &CallingTP->Filter, sizeof(ContextFilter));
1706 TP.Context = CallingTP->Context;
1707 TP.ControlContext = CallingTP->ControlContext;
1709 if (LoadTemplates != 0) {
1710 if (LoadTemplates > 1)
1711 lprintf(1, "DBG: ----- loading: [%s] ------ \n",
1712 ChrPtr(Tmpl->FileName));
1714 pTmpl = load_template(Tmpl->FileName, NULL, NULL);
1718 "<pre>\nError loading Template [%s]\n See Logfile for details\n</pre>\n",
1719 ChrPtr(Tmpl->FileName));
1725 pS = pData = ChrPtr(pTmpl->Data);
1726 len = StrLength(pTmpl->Data);
1730 if (i >= pTmpl->nTokensUsed) {
1731 StrBufAppendBufPlain(Target,
1733 len - (pData - pS), 0);
1737 StrBufAppendBufPlain(
1739 pTmpl->Tokens[i]->pTokenStart - pData, 0);
1740 TP.Tokens = pTmpl->Tokens[i];
1741 TP.nArgs = pTmpl->Tokens[i]->nParameters;
1742 state = EvaluateToken(Target, state, &TP);
1744 while ((state != 0) && (i+1 < pTmpl->nTokensUsed)) {
1745 /* condition told us to skip till its end condition */
1747 TP.Tokens = pTmpl->Tokens[i];
1748 TP.nArgs = pTmpl->Tokens[i]->nParameters;
1749 if ((pTmpl->Tokens[i]->Flags == SV_CONDITIONAL) ||
1750 (pTmpl->Tokens[i]->Flags == SV_NEG_CONDITIONAL)) {
1751 if (state == EvaluateConditional(
1753 pTmpl->Tokens[i]->Flags,
1759 pData = pTmpl->Tokens[i++]->pTokenEnd + 1;
1760 if (i > pTmpl->nTokensUsed)
1764 if (LoadTemplates != 0) {
1765 FreeWCTemplate(pTmpl);
1767 return Tmpl->MimeType;
1772 * \brief Display a variable-substituted template
1773 * \param templatename template file to load
1774 * \returns the mimetype of the template its doing
1776 const StrBuf *DoTemplate(const char *templatename, long len, StrBuf *Target, WCTemplputParams *TP)
1778 WCTemplputParams LocalTP;
1780 HashList *StaticLocal;
1786 memset(&LocalTP, 0, sizeof(WCTemplputParams));
1790 if (WC->is_mobile) {
1791 Static = WirelessTemplateCache;
1792 StaticLocal = WirelessLocalTemplateCache;
1795 Static = TemplateCache;
1796 StaticLocal = LocalTemplateCache;
1801 lprintf (1, "Can't to load a template with empty name!\n");
1802 StrBufAppendPrintf(Target, "<pre>\nCan't to load a template with empty name!\n</pre>");
1806 if (!GetHash(StaticLocal, templatename, len, &vTmpl) &&
1807 !GetHash(Static, templatename, len, &vTmpl)) {
1808 lprintf (1, "didn't find Template [%s] %ld %ld\n", templatename, len , (long)strlen(templatename));
1809 StrBufAppendPrintf(Target, "<pre>\ndidn't find Template [%s] %ld %ld\n</pre>",
1811 (long)strlen(templatename));
1813 dbg_PrintHash(Static, PrintTemplate, NULL);
1814 PrintHash(Static, VarPrintTransition, PrintTemplate);
1820 return ProcessTemplate(vTmpl, Target, TP);
1824 /*-----------------------------------------------------------------------------
1827 typedef struct _HashIterator {
1828 HashList *StaticList;
1829 int AdditionalParams;
1831 int XPectContextType;
1833 RetrieveHashlistFunc GetHash;
1834 HashDestructorFunc Destructor;
1835 SubTemplFunc DoSubTemplate;
1838 void RegisterITERATOR(const char *Name, long len,
1839 int AdditionalParams,
1840 HashList *StaticList,
1841 RetrieveHashlistFunc GetHash,
1842 SubTemplFunc DoSubTempl,
1843 HashDestructorFunc Destructor,
1845 int XPectContextType,
1848 HashIterator *It = (HashIterator*)malloc(sizeof(HashIterator));
1849 It->StaticList = StaticList;
1850 It->AdditionalParams = AdditionalParams;
1851 It->GetHash = GetHash;
1852 It->DoSubTemplate = DoSubTempl;
1853 It->Destructor = Destructor;
1854 It->ContextType = ContextType;
1855 It->XPectContextType = XPectContextType;
1857 Put(Iterators, Name, len, It, NULL);
1860 typedef struct _iteratestruct {
1869 void tmpl_iterate_subtmpl(StrBuf *Target, WCTemplputParams *TP)
1875 SortStruct *SortBy = NULL;
1877 int DetectGroupChange = 0;
1880 void *vLastContext = NULL;
1882 WCTemplputParams SubTP;
1883 IterateStruct Status;
1889 memset(&Status, 0, sizeof(IterateStruct));
1890 memcpy (&SubTP, &TP, sizeof(WCTemplputParams));
1892 if (!GetHash(Iterators, TKEY(0), &vIt)) {
1894 Target, "Iterator", ERR_PARM1, TP, "Unknown!");
1898 It = (HashIterator*) vIt;
1900 if (TP->Tokens->nParameters < It->AdditionalParams + 2) {
1902 Target, "Iterator", ERR_PARM1, TP,
1903 "doesn't work with %d params",
1904 TP->Tokens->nParameters);
1908 if ((It->XPectContextType != CTX_NONE) &&
1909 (It->XPectContextType != TP->Filter.ContextType)) {
1911 Target, "Iterator", ERR_PARM1, TP,
1912 "requires context of type %d, have %d",
1913 It->XPectContextType,
1914 TP->Filter.ContextType);
1919 if (It->StaticList == NULL)
1920 List = It->GetHash(Target, TP);
1922 List = It->StaticList;
1924 DetectGroupChange = (It->Flags & IT_FLAG_DETECT_GROUPCHANGE) != 0;
1925 if (DetectGroupChange) {
1926 const StrBuf *BSort;
1927 DetectGroupChange = 0;
1928 if (havebstr("SortBy")) {
1929 BSort = sbstr("SortBy");
1930 if (GetHash(SortHash, SKEY(BSort), &vSortBy) &&
1931 (vSortBy != NULL)) {
1932 SortBy = (SortStruct*)vSortBy;
1933 /** Ok, its us, lets see in which direction we should sort... */
1934 if (havebstr("SortOrder")) {
1936 SortOrder = LBSTR("SortOrder");
1938 DetectGroupChange = 1;
1943 nMembersUsed = GetCount(List);
1944 SubBuf = NewStrBuf();
1945 SubTP.Filter.ContextType = It->ContextType;
1946 SubTP.Filter.ControlContextType = CTX_ITERATE;
1947 SubTP.ControlContext = &Status;
1949 if (HAVE_PARAM(2)) {
1950 StartAt = GetTemplateTokenNumber(Target, TP, 2, 0);
1952 if (HAVE_PARAM(3)) {
1953 StepWidth = GetTemplateTokenNumber(Target, TP, 3, 0);
1955 if (HAVE_PARAM(4)) {
1956 StopAt = GetTemplateTokenNumber(Target, TP, 4, -1);
1958 it = GetNewHashPos(List, StepWidth);
1960 StopAt = GetCount(List);
1962 while (GetNextHashPos(List, it, &Status.KeyLen, &Status.Key, &vContext)) {
1963 if ((Status.n >= StartAt) && (Status.n <= StopAt)) {
1964 if (DetectGroupChange && Status.n > 0) {
1965 Status.GroupChange = (SortBy->GroupChange(vContext, vLastContext))? 1:0;
1967 Status.LastN = (Status.n + 1) == nMembersUsed;
1968 SubTP.Context = vContext;
1969 if (It->DoSubTemplate != NULL)
1970 It->DoSubTemplate(SubBuf, &SubTP);
1971 DoTemplate(TKEY(1), SubBuf, &SubTP);
1973 StrBufAppendBuf(Target, SubBuf, 0);
1974 FlushStrBuf(SubBuf);
1975 Status.oddeven = ! Status.oddeven;
1976 vLastContext = vContext;
1980 FreeStrBuf(&SubBuf);
1982 if (It->Destructor != NULL)
1983 It->Destructor(&List);
1987 int conditional_ITERATE_ISGROUPCHANGE(StrBuf *Target, WCTemplputParams *TP)
1989 IterateStruct *Ctx = CCTX;
1990 return Ctx->GroupChange;
1993 void tmplput_ITERATE_ODDEVEN(StrBuf *Target, WCTemplputParams *TP)
1995 IterateStruct *Ctx = CCTX;
1997 StrBufAppendBufPlain(Target, HKEY("odd"), 0);
1999 StrBufAppendBufPlain(Target, HKEY("even"), 0);
2003 void tmplput_ITERATE_KEY(StrBuf *Target, WCTemplputParams *TP)
2005 IterateStruct *Ctx = CCTX;
2007 StrBufAppendBufPlain(Target, Ctx->Key, Ctx->KeyLen, 0);
2011 void tmplput_ITERATE_LASTN(StrBuf *Target, WCTemplputParams *TP)
2013 IterateStruct *Ctx = CCTX;
2014 StrBufAppendPrintf(Target, "%d", Ctx->n);
2017 int conditional_ITERATE_LASTN(StrBuf *Target, WCTemplputParams *TP)
2019 IterateStruct *Ctx = CCTX;
2025 /*-----------------------------------------------------------------------------
2028 int EvaluateConditional(StrBuf *Target, int Neg, int state, WCTemplputParams *TP)
2030 ConditionalStruct *Cond;
2032 if ((TP->Tokens->Params[0]->len == 1) &&
2033 (TP->Tokens->Params[0]->Start[0] == 'X'))
2034 return (state != 0)?TP->Tokens->Params[1]->lvalue:0;
2036 Cond = (ConditionalStruct *) TP->Tokens->PreEval;
2039 Target, "Conditional", ERR_PARM1, TP,
2044 if (!CheckContext(Target, &Cond->Filter, TP, "Conditional")) {
2048 if (Cond->CondF(Target, TP) == Neg)
2049 return TP->Tokens->Params[1]->lvalue;
2053 int ConditionalVar(StrBuf *Target, WCTemplputParams *TP)
2058 if (!GetHash(WC->vars, TKEY(2), &vsubst))
2060 subst = (wcsubst*) vsubst;
2062 switch(subst->wcs_type) {
2064 return (subst->wcs_function!=NULL);
2066 lprintf(1, " -> Server [%s]\n", subst->wcs_value);/* TODO */
2070 case WCS_STRBUF_REF:
2071 if (TP->Tokens->nParameters < 4)
2073 return (strcmp(TP->Tokens->Params[3]->Start, ChrPtr(subst->wcs_value)) == 0);
2075 if (TP->Tokens->nParameters < 4)
2076 return (subst->lvalue != 0);
2077 return (subst->lvalue == TP->Tokens->Params[3]->lvalue);
2079 lprintf(1," WARNING: invalid type: [%ld]!\n", subst->wcs_type);
2085 void RegisterConditional(const char *Name, long len,
2087 WCConditionalFunc CondF,
2088 int ContextRequired)
2090 ConditionalStruct *Cond = (ConditionalStruct*)malloc(sizeof(ConditionalStruct));
2091 Cond->PlainName = Name;
2092 Cond->Filter.nMaxArgs = nParams;
2093 Cond->Filter.nMinArgs = nParams;
2094 Cond->CondF = CondF;
2095 Cond->Filter.ContextType = ContextRequired;
2096 Cond->Filter.ControlContextType = CTX_NONE;
2097 Put(Conditionals, Name, len, Cond, NULL);
2100 void RegisterControlConditional(const char *Name, long len,
2102 WCConditionalFunc CondF,
2103 int ControlContextRequired)
2105 ConditionalStruct *Cond = (ConditionalStruct*)malloc(sizeof(ConditionalStruct));
2106 Cond->PlainName = Name;
2107 Cond->Filter.nMaxArgs = nParams;
2108 Cond->Filter.nMinArgs = nParams;
2109 Cond->CondF = CondF;
2110 Cond->Filter.ContextType = CTX_NONE;
2111 Cond->Filter.ControlContextType = ControlContextRequired;
2112 Put(Conditionals, Name, len, Cond, NULL);
2115 /*-----------------------------------------------------------------------------
2118 void tmplput_ContextString(StrBuf *Target, WCTemplputParams *TP)
2120 StrBufAppendTemplate(Target, TP, (StrBuf*)CTX, 0);
2122 int ConditionalContextStr(StrBuf *Target, WCTemplputParams *TP)
2124 StrBuf *TokenText = (StrBuf*) CTX;
2125 const char *CompareToken;
2128 GetTemplateTokenString(Target, TP, 2, &CompareToken, &len);
2129 return strcmp(ChrPtr(TokenText), CompareToken) == 0;
2132 /*-----------------------------------------------------------------------------
2136 void tmpl_do_boxed(StrBuf *Target, WCTemplputParams *TP)
2138 WCTemplputParams SubTP;
2141 if (TP->Tokens->nParameters == 2) {
2142 if (TP->Tokens->Params[1]->Type == TYPE_STR) {
2143 Headline = NewStrBuf();
2144 DoTemplate(TKEY(1), Headline, TP);
2149 GetTemplateTokenString(Target,
2154 Headline = NewStrBufPlain(Ch, len);
2157 memcpy (&SubTP, TP, sizeof(WCTemplputParams));
2158 SubTP.Context = Headline;
2159 SubTP.Filter.ContextType = CTX_STRBUF;
2160 DoTemplate(HKEY("beginbox"), Target, &SubTP);
2161 DoTemplate(TKEY(0), Target, TP);
2162 DoTemplate(HKEY("endbox"), Target, TP);
2163 FreeStrBuf(&Headline);
2166 /*-----------------------------------------------------------------------------
2170 void tmpl_do_tabbed(StrBuf *Target, WCTemplputParams *TP)
2173 int i, ntabs, nTabs;
2175 nTabs = ntabs = TP->Tokens->nParameters / 2;
2176 TabNames = (StrBuf **) malloc(ntabs * sizeof(StrBuf*));
2178 for (i = 0; i < ntabs; i++) {
2179 if ((TP->Tokens->Params[i * 2]->Type == TYPE_STR) &&
2180 (TP->Tokens->Params[i * 2]->len > 0)) {
2181 TabNames[i] = NewStrBuf();
2182 DoTemplate(TKEY(i * 2), TabNames[i], TP);
2184 else if (TP->Tokens->Params[i * 2]->Type == TYPE_GETTEXT) {
2187 GetTemplateTokenString(Target,
2192 TabNames[i] = NewStrBufPlain(Ch, -1);
2195 /** A Tab without subject? we can't count that, add it as silent */
2200 StrTabbedDialog(Target, nTabs, TabNames);
2201 for (i = 0; i < ntabs; i++) {
2202 StrBeginTab(Target, i, nTabs);
2203 DoTemplate(TKEY(i * 2 + 1), Target, TP);
2204 StrEndTab(Target, i, nTabs);
2209 /*-----------------------------------------------------------------------------
2214 void RegisterSortFunc(const char *name, long len,
2215 const char *prepend, long preplen,
2216 CompareFunc Forward,
2217 CompareFunc Reverse,
2218 CompareFunc GroupChange,
2221 SortStruct *NewSort = (SortStruct*) malloc(sizeof(SortStruct));
2222 NewSort->Name = NewStrBufPlain(name, len);
2223 if (prepend != NULL)
2224 NewSort->PrefPrepend = NewStrBufPlain(prepend, preplen);
2226 NewSort->PrefPrepend = NULL;
2227 NewSort->Forward = Forward;
2228 NewSort->Reverse = Reverse;
2229 NewSort->GroupChange = GroupChange;
2230 NewSort->ContextType = ContextType;
2231 Put(SortHash, name, len, NewSort, DestroySortStruct);
2234 CompareFunc RetrieveSort(WCTemplputParams *TP,
2235 const char *OtherPrefix, long OtherPrefixLen,
2236 const char *Default, long ldefault, long DefaultDirection)
2239 const StrBuf *BSort = NULL;
2242 long SortOrder = -1;
2244 if (havebstr("SortBy")) {
2245 BSort = sbstr("SortBy");
2246 if (OtherPrefix == NULL) {
2247 set_room_pref("sort", NewStrBufDup(BSort), 0);
2250 set_X_PREFS(HKEY("sort"), OtherPrefix, OtherPrefixLen, NewStrBufDup(BSort), 0);
2253 else { /** Try to fallback to our remembered values... */
2254 if (OtherPrefix == NULL) {
2255 BSort = get_room_pref("sort");
2258 BSort = get_X_PREFS(HKEY("sort"), OtherPrefix, OtherPrefixLen);
2261 putbstr("SortBy", NewStrBufDup(BSort));
2265 BSort = Buf = NewStrBufPlain(Default, ldefault);
2266 putbstr("SortBy", Buf);
2270 if (!GetHash(SortHash, SKEY(BSort), &vSortBy) ||
2271 (vSortBy == NULL)) {
2273 if (!GetHash(SortHash, Default, ldefault, &vSortBy) ||
2274 (vSortBy == NULL)) {
2276 NULL, "Sorting", ERR_PARM1, TP,
2277 "Illegal default sort: [%s]", Default);
2281 SortBy = (SortStruct*)vSortBy;
2283 /** Ok, its us, lets see in which direction we should sort... */
2284 if (havebstr("SortOrder")) {
2285 SortOrder = LBSTR("SortOrder");
2287 else { /** Try to fallback to our remembered values... */
2289 if (SortBy->PrefPrepend == NULL) {
2290 Buf = get_room_pref("SortOrder");
2291 SortOrder = StrTol(Buf);
2294 BSort = get_X_PREFS(HKEY("SortOrder"), OtherPrefix, OtherPrefixLen);
2298 SortOrder = DefaultDirection;
2300 Buf = NewStrBufPlain(NULL, 64);
2301 StrBufPrintf(Buf, "%ld", SortOrder);
2302 putbstr("SortOrder", Buf);
2304 switch (SortOrder) {
2309 return SortBy->Forward;
2311 return SortBy->Reverse;
2323 ConstStr SortIcons[] = {
2324 {HKEY("static/sort_none.gif")},
2325 {HKEY("static/up_pointer.gif")},
2326 {HKEY("static/down_pointer.gif")},
2329 ConstStr SortNextOrder[] = {
2336 int GetSortMetric(WCTemplputParams *TP, SortStruct **Next, SortStruct **Param, long *SortOrder, int N)
2338 int bSortError = eNOT_SPECIFIED;
2339 const StrBuf *BSort;
2344 if (!GetHash(SortHash, TKEY(0), &vSort) ||
2346 return eNO_SUCH_SORT;
2347 *Param = (SortStruct*) vSort;
2350 if (havebstr("SortBy")) {
2351 BSort = sbstr("SortBy");
2352 bSortError = eINVALID_PARAM;
2353 if ((*Param)->PrefPrepend == NULL) {
2354 set_room_pref("sort", NewStrBufDup(BSort), 0);
2357 set_X_PREFS(HKEY("sort"), TKEY(N), NewStrBufDup(BSort), 0);
2360 else { /** Try to fallback to our remembered values... */
2361 if ((*Param)->PrefPrepend == NULL) {
2362 BSort = get_room_pref("sort");
2365 BSort = get_X_PREFS(HKEY("sort"), TKEY(N));
2369 if (!GetHash(SortHash, SKEY(BSort), &vSort) ||
2373 *Next = (SortStruct*) vSort;
2375 /** Ok, its us, lets see in which direction we should sort... */
2376 if (havebstr("SortOrder")) {
2377 *SortOrder = LBSTR("SortOrder");
2379 else { /** Try to fallback to our remembered values... */
2380 if ((*Param)->PrefPrepend == NULL) {
2381 *SortOrder = StrTol(get_room_pref("SortOrder"));
2384 *SortOrder = StrTol(get_X_PREFS(HKEY("SortOrder"), TKEY(N)));
2394 void tmplput_SORT_ICON(StrBuf *Target, WCTemplputParams *TP)
2399 const ConstStr *SortIcon;
2401 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2404 Target, "Sorter", ERR_PARM1, TP,
2405 " Sorter [%s] unknown!",
2406 TP->Tokens->Params[0]->Start);
2408 case eINVALID_PARAM:
2409 LogTemplateError(NULL, "Sorter", ERR_PARM1, TP,
2410 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2412 case eNOT_SPECIFIED:
2414 if (Next == Param) {
2415 SortIcon = &SortIcons[SortOrder];
2417 else { /** Not Us... */
2418 SortIcon = &SortIcons[0];
2420 StrBufAppendBufPlain(Target, SortIcon->Key, SortIcon->len, 0);
2424 void tmplput_SORT_NEXT(StrBuf *Target, WCTemplputParams *TP)
2430 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2433 Target, "Sorter", ERR_PARM1, TP,
2434 " Sorter [%s] unknown!",
2435 TP->Tokens->Params[0]->Start);
2437 case eINVALID_PARAM:
2439 NULL, "Sorter", ERR_PARM1, TP,
2440 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2442 case eNOT_SPECIFIED:
2444 StrBufAppendBuf(Target, Param->Name, 0);
2449 void tmplput_SORT_ORDER(StrBuf *Target, WCTemplputParams *TP)
2452 const ConstStr *SortOrderStr;
2456 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2459 Target, "Sorter", ERR_PARM1, TP,
2460 " Sorter [%s] unknown!",
2461 TP->Tokens->Params[0]->Start);
2463 case eINVALID_PARAM:
2465 NULL, "Sorter", ERR_PARM1, TP,
2466 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2468 case eNOT_SPECIFIED:
2470 if (Next == Param) {
2471 SortOrderStr = &SortNextOrder[SortOrder];
2473 else { /** Not Us... */
2474 SortOrderStr = &SortNextOrder[0];
2476 StrBufAppendBufPlain(Target, SortOrderStr->Key, SortOrderStr->len, 0);
2481 void tmplput_long_vector(StrBuf *Target, WCTemplputParams *TP)
2483 long *LongVector = (long*) CTX;
2485 if ((TP->Tokens->Params[0]->Type == TYPE_LONG) &&
2486 (TP->Tokens->Params[0]->lvalue <= LongVector[0]))
2488 StrBufAppendPrintf(Target, "%ld", LongVector[TP->Tokens->Params[0]->lvalue]);
2492 if (TP->Tokens->Params[0]->Type != TYPE_LONG) {
2494 Target, "Longvector", ERR_NAME, TP,
2495 "needs a numerical Parameter!");
2499 Target, "LongVector", ERR_PARM1, TP,
2500 "doesn't have %ld Parameters, its just the size of %ld!",
2501 TP->Tokens->Params[0]->lvalue,
2507 void dbg_print_longvector(long *LongVector)
2509 StrBuf *Buf = NewStrBufPlain(HKEY("Longvector: ["));
2510 int nItems = LongVector[0];
2513 for (i = 0; i < nItems; i++) {
2515 StrBufAppendPrintf(Buf, "%d: %ld | ", i, LongVector[i]);
2517 StrBufAppendPrintf(Buf, "%d: %ld]\n", i, LongVector[i]);
2520 lprintf(1, ChrPtr(Buf));
2524 int ConditionalLongVector(StrBuf *Target, WCTemplputParams *TP)
2526 long *LongVector = (long*) CTX;
2528 if ((TP->Tokens->Params[2]->Type == TYPE_LONG) &&
2529 (TP->Tokens->Params[2]->lvalue <= LongVector[0])&&
2530 (TP->Tokens->Params[3]->Type == TYPE_LONG) &&
2531 (TP->Tokens->Params[3]->lvalue <= LongVector[0]))
2533 return LongVector[TP->Tokens->Params[2]->lvalue] ==
2534 LongVector[TP->Tokens->Params[3]->lvalue];
2538 if ((TP->Tokens->Params[2]->Type == TYPE_LONG) ||
2539 (TP->Tokens->Params[2]->Type == TYPE_LONG)) {
2541 Target, "ConditionalLongvector", ERR_PARM1, TP,
2542 "needs two long Parameter!");
2546 Target, "Longvector", ERR_PARM1, TP,
2547 "doesn't have %ld / %ld Parameters, its just the size of %ld!",
2548 TP->Tokens->Params[2]->lvalue,
2549 TP->Tokens->Params[3]->lvalue,
2560 memset(&NoCtx, 0, sizeof(WCTemplputParams));
2561 RegisterNamespace("SORT:ICON", 1, 2, tmplput_SORT_ICON, CTX_NONE);
2562 RegisterNamespace("SORT:ORDER", 1, 2, tmplput_SORT_ORDER, CTX_NONE);
2563 RegisterNamespace("SORT:NEXT", 1, 2, tmplput_SORT_NEXT, CTX_NONE);
2564 RegisterNamespace("CONTEXTSTR", 0, 1, tmplput_ContextString, CTX_STRBUF);
2565 RegisterNamespace("ITERATE", 2, 100, tmpl_iterate_subtmpl, CTX_NONE);
2566 RegisterNamespace("DOBOXED", 1, 2, tmpl_do_boxed, CTX_NONE);
2567 RegisterNamespace("DOTABBED", 2, 100, tmpl_do_tabbed, CTX_NONE);
2568 RegisterNamespace("LONGVECTOR", 1, 1, tmplput_long_vector, CTX_LONGVECTOR);
2569 RegisterConditional(HKEY("COND:SUBST"), 3, ConditionalVar, CTX_NONE);
2570 RegisterConditional(HKEY("COND:CONTEXTSTR"), 3, ConditionalContextStr, CTX_STRBUF);
2571 RegisterConditional(HKEY("COND:LONGVECTOR"), 4, ConditionalLongVector, CTX_LONGVECTOR);
2573 RegisterControlConditional(HKEY("COND:ITERATE:ISGROUPCHANGE"), 2,
2574 conditional_ITERATE_ISGROUPCHANGE,
2576 RegisterControlConditional(HKEY("COND:ITERATE:LASTN"), 2,
2577 conditional_ITERATE_LASTN,
2579 RegisterControlNS(HKEY("ITERATE:ODDEVEN"), 0, 0, tmplput_ITERATE_ODDEVEN, CTX_ITERATE);
2580 RegisterControlNS(HKEY("ITERATE:KEY"), 0, 0, tmplput_ITERATE_KEY, CTX_ITERATE);
2581 RegisterControlNS(HKEY("ITERATE:N"), 0, 0, tmplput_ITERATE_LASTN, CTX_ITERATE);
2585 ServerStartModule_SUBST
2588 WirelessTemplateCache = NewHash(1, NULL);
2589 WirelessLocalTemplateCache = NewHash(1, NULL);
2590 LocalTemplateCache = NewHash(1, NULL);
2591 TemplateCache = NewHash(1, NULL);
2593 GlobalNS = NewHash(1, NULL);
2594 Iterators = NewHash(1, NULL);
2595 Conditionals = NewHash(1, NULL);
2596 SortHash = NewHash(1, NULL);
2600 FinalizeModule_SUBST
2607 ServerShutdownModule_SUBST
2610 DeleteHash(&WirelessTemplateCache);
2611 DeleteHash(&WirelessLocalTemplateCache);
2612 DeleteHash(&TemplateCache);
2613 DeleteHash(&LocalTemplateCache);
2615 DeleteHash(&GlobalNS);
2616 DeleteHash(&Iterators);
2617 DeleteHash(&Conditionals);
2618 DeleteHash(&SortHash);
2624 SessionNewModule_SUBST
2631 SessionAttachModule_SUBST
2634 sess->vars = NewHash(1,NULL);
2638 SessionDetachModule_SUBST
2641 DeleteHash(&sess->vars);
2645 SessionDestroyModule_SUBST