12 #define SHOW_ME_VAPPEND_PRINTF
15 #include "webserver.h"
17 extern char *static_dirs[PATH_MAX]; /* Disk representation */
19 HashList *WirelessTemplateCache;
20 HashList *WirelessLocalTemplateCache;
21 HashList *TemplateCache;
22 HashList *LocalTemplateCache;
26 HashList *Conditionals;
29 int DumpTemplateI18NStrings = 0;
30 int LoadTemplates = 0;
31 int dbg_bactrace_template_errors = 0;
32 WCTemplputParams NoCtx;
33 StrBuf *I18nDump = NULL;
35 const char EmptyStr[]="";
38 #define SV_CONDITIONAL 2
39 #define SV_NEG_CONDITIONAL 3
40 #define SV_CUST_STR_CONDITIONAL 4
42 #define SV_PREEVALUATED 6
46 * Dynamic content for variable substitution in templates
48 typedef struct _wcsubst {
50 int wcs_type; /* which type of Substitution are we */
51 char wcs_key[32]; /* copy of our hashkey for debugging */
52 StrBuf *wcs_value; /* if we're a string, keep it here */
53 long lvalue; /* type long? keep data here */
54 WCHandlerFunc wcs_function; /* funcion hook ???*/
58 typedef struct _WCTemplate {
64 WCTemplateToken **Tokens;
67 typedef struct _HashHandler {
70 WCHandlerFunc HandlerFunc;
73 void *load_template(StrBuf *filename, StrBuf *Key, HashList *PutThere);
74 int EvaluateConditional(StrBuf *Target, int Neg, int state, WCTemplputParams *TP);
78 typedef struct _SortStruct {
83 CompareFunc GroupChange;
88 const char *CtxNames[] = {
102 "Context LONGVECTOR",
112 void DestroySortStruct(void *vSort)
114 SortStruct *Sort = (SortStruct*) vSort;
115 FreeStrBuf(&Sort->Name);
116 FreeStrBuf(&Sort->PrefPrepend);
120 const char *ContextName(int ContextType)
122 if (ContextType < CTX_UNKNOWN)
123 return CtxNames[ContextType];
125 return CtxNames[CTX_UNKNOWN];
128 void LogTemplateError (StrBuf *Target, const char *Type, int ErrorPos, WCTemplputParams *TP, const char *Format, ...)
135 const char *Err = NULL;
140 va_start(arg_ptr, Format);
141 StrBufVAppendPrintf(Error, Format, arg_ptr);
146 case ERR_NAME: /* the main token name... */
147 Err = (TP->Tokens!= NULL)? TP->Tokens->pName:"";
150 Err = ((TP->Tokens!= NULL) &&
151 (TP->Tokens->nParameters > 0))?
152 TP->Tokens->Params[0]->Start : "";
155 Err = ((TP->Tokens!= NULL) &&
156 (TP->Tokens->nParameters > 1))?
157 TP->Tokens->Params[1]->Start : "";
160 if (TP->Tokens != NULL)
162 lprintf(1, "%s [%s] (in '%s' line %ld); %s; [%s]\n",
165 ChrPtr(TP->Tokens->FileName),
168 ChrPtr(TP->Tokens->FlatToken));
172 lprintf(1, "%s: %s;\n",
184 Header = NewStrBuf();
185 if (TP->Tokens != NULL)
190 "<pre>\n%s [%s] (in '%s' line %ld); %s\n[%s]\n</pre>\n",
193 ChrPtr(TP->Tokens->FileName),
196 ChrPtr(TP->Tokens->FlatToken));
198 StrBufPrintf(Info, "%s [%s] %s; [%s]",
202 ChrPtr(TP->Tokens->FlatToken));
205 SerializeJson(Header, WildFireException(SKEY(TP->Tokens->FileName),
210 SerializeJson(Header, WildFireMessage(SKEY(TP->Tokens->FileName),
215 WildFireSerializePayload(Header, WCC->HBuf, &WCC->Hdr->nWildfireHeaders, NULL);
222 "<pre>\n%s: %s\n</pre>\n",
226 StrBufPrintf(Info, "%s [%s] %s; [%s]",
230 ChrPtr(TP->Tokens->FlatToken));
231 SerializeJson(Header, WildFireException(HKEY(__FILE__), __LINE__, Info, 1), 1);
232 WildFireSerializePayload(Header, WCC->HBuf, &WCC->Hdr->nWildfireHeaders, NULL);
238 if (dbg_bactrace_template_errors)
246 void LogError (StrBuf *Target, const char *Type, const char *Format, ...)
257 va_start(arg_ptr, Format);
258 StrBufVAppendPrintf(Error, Format, arg_ptr);
261 lprintf(1, ChrPtr(Error));
264 Header = NewStrBuf();
267 SerializeJson(Header, WildFireException(Type, strlen(Type),
271 WildFireSerializePayload(Header, WCC->HBuf, &WCC->Hdr->nWildfireHeaders, NULL);
277 if (dbg_bactrace_template_errors)
283 void RegisterNS(const char *NSName,
287 WCHandlerFunc HandlerFunc,
290 HashHandler *NewHandler;
292 NewHandler = (HashHandler*) malloc(sizeof(HashHandler));
293 memset(NewHandler, 0, sizeof(HashHandler));
294 NewHandler->Filter.nMinArgs = nMinArgs;
295 NewHandler->Filter.nMaxArgs = nMaxArgs;
296 NewHandler->Filter.ContextType = ContextRequired;
297 NewHandler->Filter.ControlContextType = CTX_NONE;
299 NewHandler->HandlerFunc = HandlerFunc;
300 Put(GlobalNS, NSName, len, NewHandler, NULL);
303 void RegisterControlNS(const char *NSName,
307 WCHandlerFunc HandlerFunc,
308 int ControlContextRequired)
310 HashHandler *NewHandler;
312 NewHandler = (HashHandler*) malloc(sizeof(HashHandler));
313 memset(NewHandler, 0, 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 * debugging function to print array to log
400 void VarPrintTransition(void *vVar1, void *vVar2, int odd){}
403 * debugging function to print array to log
405 void VarPrintEntry(const char *Key, void *vSubst, int odd)
408 lprintf(1,"Subst[%s] : ", Key);
409 ptr = (wcsubst*) vSubst;
411 switch(ptr->wcs_type) {
413 lprintf(1, " -> %s\n", ChrPtr(ptr->wcs_value));
416 lprintf(1, " -> Server [%s]\n", ChrPtr(ptr->wcs_value));
419 lprintf(1, " -> function at [%0xd]\n", ptr->wcs_function);
422 lprintf(1," WARNING: invalid type: [%ld]!\n", ptr->wcs_type);
429 * Clear out the list of substitution variables local to this session
431 void clear_substs(wcsession *wc) {
433 if (wc->vars != NULL) {
434 DeleteHash(&wc->vars);
439 * Clear out the list of substitution variables local to this session
441 void clear_local_substs(void) {
460 void FlushPayload(wcsubst *ptr, int reusestrbuf, int type)
462 int NeedNew = NeedNewBuf(type);
463 switch(ptr->wcs_type) {
467 if (reusestrbuf && NeedNew) {
468 FlushStrBuf(ptr->wcs_value);
472 FreeStrBuf(&ptr->wcs_value);
473 ptr->wcs_value = NULL;
477 ptr->wcs_function = NULL;
478 if (reusestrbuf && NeedNew)
479 ptr->wcs_value = NewStrBuf();
482 ptr->wcs_value = NULL;
483 if (reusestrbuf && NeedNew)
484 ptr->wcs_value = NewStrBuf();
488 if (reusestrbuf && NeedNew)
489 ptr->wcs_value = NewStrBuf();
492 if (reusestrbuf && NeedNew)
493 ptr->wcs_value = NewStrBuf();
500 * destructor; kill one entry.
502 void deletevar(void *data)
504 wcsubst *ptr = (wcsubst*)data;
505 FlushPayload(ptr, 0, ptr->wcs_type);
510 wcsubst *NewSubstVar(const char *keyname, int keylen, int type)
515 ptr = (wcsubst *) malloc(sizeof(wcsubst));
516 memset(ptr, 0, sizeof(wcsubst));
518 ptr->wcs_type = type;
519 safestrncpy(ptr->wcs_key, keyname, sizeof ptr->wcs_key);
520 Put(WCC->vars, keyname, keylen, ptr, deletevar);
522 switch(ptr->wcs_type) {
525 ptr->wcs_value = NewStrBuf();
539 * Add a substitution variable (local to this session) (strlen version...)
540 * keyname the replacementstring to substitute
541 * keytype the kind of the key
542 * format the format string ala printf
543 * ... the arguments to substitute in the formatstring
545 void SVPRINTF(char *keyname, int keytype, const char *format,...)
553 keylen = strlen(keyname);
555 * First look if we're doing a replacement of
558 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
559 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
560 ptr = (wcsubst*)vPtr;
561 FlushPayload(ptr, keytype, keytype);
562 ptr->wcs_type = keytype;
564 else /** Otherwise allocate a new one */
566 ptr = NewSubstVar(keyname, keylen, keytype);
569 /* Format the string */
570 va_start(arg_ptr, format);
571 StrBufVAppendPrintf(ptr->wcs_value, format, arg_ptr);
576 * Add a substitution variable (local to this session)
577 * keyname the replacementstring to substitute
578 * keytype the kind of the key
579 * format the format string ala printf
580 * ... the arguments to substitute in the formatstring
582 void svprintf(char *keyname, size_t keylen, int keytype, const char *format,...)
590 * First look if we're doing a replacement of
593 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
594 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
595 ptr = (wcsubst*)vPtr;
596 FlushPayload(ptr, 1, keytype);
597 ptr->wcs_type = keytype;
599 else /** Otherwise allocate a new one */
601 ptr = NewSubstVar(keyname, keylen, keytype);
604 /** Format the string and save it */
605 va_start(arg_ptr, format);
606 StrBufVAppendPrintf(ptr->wcs_value, format, arg_ptr);
611 * Add a substitution variable (local to this session)
612 * keyname the replacementstring to substitute
613 * keytype the kind of the key
614 * format the format string ala printf
615 * ... the arguments to substitute in the formatstring
617 void SVPut(char *keyname, size_t keylen, int keytype, char *Data)
625 * First look if we're doing a replacement of
628 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
629 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
630 ptr = (wcsubst*)vPtr;
631 FlushPayload(ptr, 1, keytype);
632 ptr->wcs_type = keytype;
634 else /** Otherwise allocate a new one */
636 ptr = NewSubstVar(keyname, keylen, keytype);
638 StrBufAppendBufPlain(ptr->wcs_value, Data, -1, 0);
642 * \brief Add a substitution variable (local to this session)
643 * \param keyname the replacementstring to substitute
644 * \param keytype the kind of the key
645 * \param format the format string ala printf
646 * \param ... the arguments to substitute in the formatstring
648 void SVPutLong(char *keyname, size_t keylen, long Data)
656 * First look if we're doing a replacement of
659 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
660 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
661 ptr = (wcsubst*)vPtr;
662 FlushPayload(ptr, 1, WCS_LONG);
663 ptr->wcs_type = WCS_LONG;
665 else /** Otherwise allocate a new one */
667 ptr = NewSubstVar(keyname, keylen, WCS_LONG);
673 * \brief Add a substitution variable (local to this session) that does a callback
674 * \param keyname the keystring to substitute
675 * \param fcn_ptr the function callback to give the substitution string
677 void SVCallback(char *keyname, size_t keylen, WCHandlerFunc fcn_ptr)
684 * First look if we're doing a replacement of
687 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
688 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
689 ptr = (wcsubst*)vPtr;
690 FlushPayload(ptr, 1, WCS_FUNCTION);
691 ptr->wcs_type = WCS_FUNCTION;
693 else /** Otherwise allocate a new one */
695 ptr = NewSubstVar(keyname, keylen, WCS_FUNCTION);
698 ptr->wcs_function = fcn_ptr;
700 inline void SVCALLBACK(char *keyname, WCHandlerFunc fcn_ptr)
702 SVCallback(keyname, strlen(keyname), fcn_ptr);
707 void SVPUTBuf(const char *keyname, int keylen, const StrBuf *Buf, int ref)
714 * First look if we're doing a replacement of
717 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
718 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
719 ptr = (wcsubst*)vPtr;
720 FlushPayload(ptr, 0, (ref)?WCS_STRBUF_REF:WCS_STRBUF);
721 ptr->wcs_type = (ref)?WCS_STRBUF_REF:WCS_STRBUF;
723 else /** Otherwise allocate a new one */
725 ptr = NewSubstVar(keyname, keylen, (ref)?WCS_STRBUF_REF:WCS_STRBUF);
727 ptr->wcs_value = (StrBuf*)Buf;
731 * \brief back end for print_value_of() ... does a server command
732 * \param servcmd server command to execute on the citadel server
734 void pvo_do_cmd(StrBuf *Target, StrBuf *servcmd) {
738 serv_puts(ChrPtr(servcmd));
739 len = serv_getln(buf, sizeof buf);
745 StrBufAppendPrintf(Target, "%s\n", &buf[4]);
748 _fmout(Target, "CENTER");
751 StrBufAppendPrintf(Target, "%s\n", &buf[4]);
757 void GetTemplateTokenString(StrBuf *Target,
758 WCTemplputParams *TP,
764 WCTemplputParams SubTP;
766 if (TP->Tokens->nParameters < N) {
767 LogTemplateError(Target,
768 "TokenParameter", N, TP,
769 "invalid token %d. this shouldn't have come till here.\n", N);
775 switch (TP->Tokens->Params[N]->Type) {
778 *Value = TP->Tokens->Params[N]->Start;
779 *len = TP->Tokens->Params[N]->len;
782 if (TP->Tokens->Params[N]->len == 0) {
783 LogTemplateError(Target,
784 "TokenParameter", N, TP,
785 "Requesting parameter %d; of type BSTR, empty lookup string not admitted.", N);
790 Buf = (StrBuf*) SBstr(TKEY(N));
791 *Value = ChrPtr(Buf);
792 *len = StrLength(Buf);
795 if (TP->Tokens->Params[N]->len == 0) {
796 LogTemplateError(Target,
797 "TokenParameter", N, TP,
798 "Requesting parameter %d; of type PREFSTR, empty lookup string not admitted.", N);
803 get_PREFERENCE(TKEY(N), &Buf);
804 *Value = ChrPtr(Buf);
805 *len = StrLength(Buf);
808 LogTemplateError(Target,
809 "TokenParameter", N, TP,
810 "Requesting parameter %d; of type LONG, want string.", N);
813 LogTemplateError(Target,
814 "TokenParameter", N, TP,
815 "Requesting parameter %d; of type PREFINT, want string.", N);
818 *Value = _(TP->Tokens->Params[N]->Start);
819 *len = strlen(*Value);
821 case TYPE_SUBTEMPLATE:
822 if (TP->Tokens->Params[N]->len == 0) {
823 LogTemplateError(Target,
824 "TokenParameter", N, TP,
825 "Requesting parameter %d; of type SUBTEMPLATE, empty lookup string not admitted.", N);
831 memset(&SubTP, 0, sizeof(WCTemplputParams *));
832 SubTP.Context = TP->Context;
833 SubTP.Filter.ContextType = TP->Filter.ContextType;
835 DoTemplate(TKEY(N), Buf, &SubTP);
836 *Value = ChrPtr(Buf);
837 *len = StrLength(Buf);
838 /* we can't free it here, so we put it into the subst so its discarded later on. */
839 SVPUTBuf(TKEY(N), Buf, 0);
843 LogTemplateError(Target,
844 "TokenParameter", N, TP,
845 "unknown param type %d; [%d]", N, TP->Tokens->Params[N]->Type);
850 long GetTemplateTokenNumber(StrBuf *Target, WCTemplputParams *TP, int N, long dflt)
853 if (TP->Tokens->nParameters < N) {
854 LogTemplateError(Target,
855 "TokenParameter", N, TP,
856 "invalid token %d. this shouldn't have come till here.\n", N);
861 switch (TP->Tokens->Params[N]->Type) {
864 return atol(TP->Tokens->Params[N]->Start);
867 if (TP->Tokens->Params[N]->len == 0) {
868 LogTemplateError(Target,
869 "TokenParameter", N, TP,
870 "Requesting parameter %d; of type BSTR, empty lookup string not admitted.", N);
873 return LBstr(TKEY(N));
876 LogTemplateError(Target,
877 "TokenParameter", N, TP,
878 "requesting a prefstring in param %d want a number", N);
879 if (TP->Tokens->Params[N]->len == 0) {
880 LogTemplateError(Target,
881 "TokenParameter", N, TP,
882 "Requesting parameter %d; of type PREFSTR, empty lookup string not admitted.", N);
885 if (get_PREF_LONG(TKEY(N), &Ret, dflt))
889 return TP->Tokens->Params[N]->lvalue;
891 if (TP->Tokens->Params[N]->len == 0) {
892 LogTemplateError(Target,
893 "TokenParameter", N, TP,
894 "Requesting parameter %d; of type PREFINT, empty lookup string not admitted.", N);
897 if (get_PREF_LONG(TKEY(N), &Ret, dflt))
901 LogTemplateError(Target,
902 "TokenParameter", N, TP,
903 "requesting a I18N string in param %d; want a number", N);
905 case TYPE_SUBTEMPLATE:
906 LogTemplateError(Target,
907 "TokenParameter", N, TP,
908 "requesting a subtemplate in param %d; not supported for numbers", N);
911 LogTemplateError(Target,
912 "TokenParameter", N, TP,
913 "unknown param type %d; [%d]", N, TP->Tokens->Params[N]->Type);
921 * \brief Print the value of a variable
922 * \param keyname get a key to print
924 void print_value_of(StrBuf *Target, WCTemplputParams *TP)
931 /*if (WCC->vars != NULL) PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
932 /* TODO: depricated! */
933 if (TP->Tokens->pName[0] == '=') {
934 DoTemplate(TP->Tokens->pName+1, TP->Tokens->NameEnd - 1, NULL, &NoCtx);
936 /*/////TODO: if param[1] == "U" -> urlescape
938 /** Page-local variables */
939 if ((WCC->vars!= NULL) && GetHash(WCC->vars, TP->Tokens->pName, TP->Tokens->NameEnd, &vVar)) {
940 ptr = (wcsubst*) vVar;
941 switch(ptr->wcs_type) {
943 StrBufAppendBuf(Target, ptr->wcs_value, 0);
946 pvo_do_cmd(Target, ptr->wcs_value);
949 (*ptr->wcs_function) (Target, TP);
953 StrBufAppendBuf(Target, ptr->wcs_value, 0);
956 StrBufAppendPrintf(Target, "%ld", ptr->lvalue);
960 Target, "Subst", ERR_NAME, TP,
961 "WARNING: invalid value in SV-Hash at %s!", TP->Tokens->pName);
966 Target, "Token", ERR_NAME, TP,
967 "didn't find Handler \"%s\"", TP->Tokens->pName);
972 int CompareSubstToToken(TemplateParam *ParamToCompare, TemplateParam *ParamToLookup)
978 if ((WCC->vars!= NULL) && GetHash(WCC->vars, ParamToLookup->Start,
979 ParamToLookup->len, &vVar)) {
980 ptr = (wcsubst*) vVar;
981 switch(ptr->wcs_type) {
985 if (ParamToCompare->Type == TYPE_STR)
986 return ((ParamToCompare->len == StrLength(ptr->wcs_value)) &&
987 (strcmp(ParamToCompare->Start, ChrPtr(ptr->wcs_value)) == 0));
989 return ParamToCompare->lvalue == StrTol(ptr->wcs_value);
997 if (ParamToCompare->Type == TYPE_STR)
1000 return ParamToCompare->lvalue == ptr->lvalue;
1003 lprintf(1,"WARNING: invalid value in SV-Hash at %s!\n",
1004 ParamToLookup->Start);
1010 int CompareSubstToStrBuf(StrBuf *Compare, TemplateParam *ParamToLookup)
1012 wcsession *WCC = WC;
1016 if ((WCC->vars!= NULL) && GetHash(WCC->vars, ParamToLookup->Start,
1017 ParamToLookup->len, &vVar)) {
1018 ptr = (wcsubst*) vVar;
1019 switch(ptr->wcs_type) {
1022 case WCS_STRBUF_REF:
1023 return ((StrLength(Compare) == StrLength(ptr->wcs_value)) &&
1024 (strcmp(ChrPtr(Compare), ChrPtr(ptr->wcs_value)) == 0));
1031 return StrTol(Compare) == ptr->lvalue;
1033 lprintf(1,"WARNING: invalid value in SV-Hash at %s!\n",
1034 ParamToLookup->Start);
1043 * \brief puts string into the template and computes which escape methon we should use
1044 * \param Source the string we should put into the template
1045 * \param FormatTypeIndex where should we look for escape types if?
1047 void StrBufAppendTemplate(StrBuf *Target,
1048 WCTemplputParams *TP,
1049 const StrBuf *Source, int FormatTypeIndex)
1052 char EscapeAs = ' ';
1054 if ((FormatTypeIndex < TP->Tokens->nParameters) &&
1055 (TP->Tokens->Params[FormatTypeIndex]->Type == TYPE_STR) &&
1056 (TP->Tokens->Params[FormatTypeIndex]->len == 1)) {
1057 EscapeAs = *TP->Tokens->Params[FormatTypeIndex]->Start;
1064 StrEscAppend(Target, Source, NULL, 0, 2);
1067 StrEscAppend(Target, Source, NULL, 0, 0);
1070 StrECMAEscAppend(Target, Source, NULL);
1073 StrBufUrlescAppend(Target, Source, NULL);
1076 StrBufAppendBuf(Target, Source, 0);
1081 void PutNewToken(WCTemplate *Template, WCTemplateToken *NewToken)
1083 if (Template->nTokensUsed + 1 >= Template->TokenSpace) {
1084 if (Template->TokenSpace <= 0) {
1085 Template->Tokens = (WCTemplateToken**)malloc(
1086 sizeof(WCTemplateToken*) * 10);
1087 memset(Template->Tokens, 0, sizeof(WCTemplateToken*));
1088 Template->TokenSpace = 10;
1091 WCTemplateToken **NewTokens;
1092 NewTokens= (WCTemplateToken**)malloc(
1093 sizeof(WCTemplateToken*) *
1094 Template->TokenSpace * 2);
1095 memcpy(NewTokens, Template->Tokens,
1096 sizeof(WCTemplateToken*) * Template->nTokensUsed);
1097 free(Template->Tokens);
1098 Template->TokenSpace *= 2;
1099 Template->Tokens = NewTokens;
1102 Template->Tokens[(Template->nTokensUsed)++] = NewToken;
1105 TemplateParam *GetNextParameter(StrBuf *Buf, const char **pCh, const char *pe, WCTemplateToken *Tokens, WCTemplate *pTmpl)
1107 const char *pch = *pCh;
1108 const char *pchs, *pche;
1109 TemplateParam *Parm;
1113 Parm = (TemplateParam *) malloc(sizeof(TemplateParam));
1114 memset(Parm, 0, sizeof(TemplateParam));
1115 Parm->Type = TYPE_STR;
1117 /* Skip leading whitespaces */
1118 while ((*pch == ' ' )||
1121 (*pch == '\n')) pch ++;
1124 Parm->Type = TYPE_PREFSTR;
1131 else if (*pch == ';') {
1132 Parm->Type = TYPE_PREFINT;
1139 else if (*pch == '_') {
1140 Parm->Type = TYPE_GETTEXT;
1147 else if (*pch == 'B') {
1148 Parm->Type = TYPE_BSTR;
1155 else if (*pch == '=') {
1156 Parm->Type = TYPE_SUBTEMPLATE;
1167 else if (*pch == '\'')
1169 if (quote != '\0') {
1174 ( (pch > pchs) && (*(pch - 1) == '\\'))
1179 if (*pch != quote) {
1180 lprintf(1, "Error (in '%s' line %ld); "
1181 "evaluating template param [%s] in Token [%s]\n",
1182 ChrPtr(pTmpl->FileName),
1184 ChrPtr(Tokens->FlatToken),
1191 StrBufPeek(Buf, pch, -1, '\0');
1192 if (LoadTemplates > 1) {
1193 lprintf(1, "DBG: got param [%s] %ld %ld\n",
1194 pchs, pche - pchs, strlen(pchs));
1197 Parm->len = pche - pchs;
1198 pch ++; /* move after trailing quote */
1199 if (ParamBrace && (*pch == ')')) {
1206 Parm->Type = TYPE_LONG;
1208 while ((pch <= pe) &&
1214 if (pch - pchs > 1){
1215 StrBufPeek(Buf, pch, -1, '\0');
1216 Parm->lvalue = atol(pchs);
1223 lprintf(1, "Error (in '%s' line %ld); "
1224 "evaluating long template param [%s] in Token [%s]\n",
1225 ChrPtr(pTmpl->FileName),
1227 ChrPtr(Tokens->FlatToken),
1234 while ((*pch == ' ' )||
1238 (*pch == '\n')) pch ++;
1240 if (DumpTemplateI18NStrings && (Parm->Type == TYPE_GETTEXT)) {
1241 StrBufAppendPrintf(I18nDump, "_(\"%s\");\n", Parm->Start);
1247 WCTemplateToken *NewTemplateSubstitute(StrBuf *Buf,
1249 const char *pTmplStart,
1250 const char *pTmplEnd,
1256 TemplateParam *Param;
1257 WCTemplateToken *NewToken;
1258 WCTemplputParams TP;
1260 NewToken = (WCTemplateToken*)malloc(sizeof(WCTemplateToken));
1261 memset(NewToken, 0, sizeof(WCTemplateToken));
1262 TP.Tokens = NewToken;
1263 NewToken->FileName = pTmpl->FileName; /* to print meaningfull log messages... */
1264 NewToken->Flags = 0;
1265 NewToken->Line = Line + 1;
1266 NewToken->pTokenStart = pTmplStart;
1267 NewToken->TokenStart = pTmplStart - pStart;
1268 NewToken->TokenEnd = (pTmplEnd - pStart) - NewToken->TokenStart;
1269 NewToken->pTokenEnd = pTmplEnd;
1270 NewToken->NameEnd = NewToken->TokenEnd - 2;
1271 NewToken->PreEval = NULL;
1272 NewToken->FlatToken = NewStrBufPlain(pTmplStart + 2, pTmplEnd - pTmplStart - 2);
1273 StrBufShrinkToFit(NewToken->FlatToken, 1);
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 StrBufShrinkToFit(NewTemplate->FileName, 1);
1436 NewTemplate->nTokensUsed = 0;
1437 NewTemplate->TokenSpace = 0;
1438 NewTemplate->Tokens = NULL;
1439 NewTemplate->MimeType = NewStrBufPlain(GuessMimeByFilename (SKEY(NewTemplate->FileName)), -1);
1440 if (strstr(ChrPtr(NewTemplate->MimeType), "text") != NULL) {
1441 StrBufAppendBufPlain(NewTemplate->MimeType, HKEY("; charset=utf-8"), 0);
1444 Put(PutThere, ChrPtr(Key), StrLength(Key), NewTemplate, FreeWCTemplate);
1449 * \brief Display a variable-substituted template
1450 * \param templatename template file to load
1452 void *load_template(StrBuf *filename, StrBuf *Key, HashList *PutThere)
1455 struct stat statbuf;
1456 const char *pS, *pE, *pch, *Err;
1459 WCTemplate *NewTemplate;
1461 fd = open(ChrPtr(filename), O_RDONLY);
1463 lprintf(1, "ERROR: could not open template '%s' - %s\n",
1464 ChrPtr(filename), strerror(errno));
1468 if (fstat(fd, &statbuf) == -1) {
1469 lprintf(1, "ERROR: could not stat template '%s' - %s\n",
1470 ChrPtr(filename), strerror(errno));
1474 NewTemplate = (WCTemplate *) malloc(sizeof(WCTemplate));
1475 memset(NewTemplate, 0, sizeof(WCTemplate));
1476 NewTemplate->Data = NewStrBufPlain(NULL, statbuf.st_size);
1477 NewTemplate->FileName = NewStrBufDup(filename);
1478 NewTemplate->nTokensUsed = 0;
1479 NewTemplate->TokenSpace = 0;
1480 NewTemplate->Tokens = NULL;
1481 NewTemplate->MimeType = NewStrBufPlain(GuessMimeByFilename (SKEY(NewTemplate->FileName)), -1);
1482 if (strstr(ChrPtr(NewTemplate->MimeType), "text") != NULL) {
1483 StrBufAppendBufPlain(NewTemplate->MimeType, HKEY("; charset=utf-8"), 0);
1486 if (StrBufReadBLOB(NewTemplate->Data, &fd, 1, statbuf.st_size, &Err) < 0) {
1488 FreeWCTemplate(NewTemplate);
1489 lprintf(1, "ERROR: reading template '%s' - %s<br />\n",
1490 ChrPtr(filename), strerror(errno));
1496 StrBufShrinkToFit(NewTemplate->Data, 1);
1497 StrBufShrinkToFit(NewTemplate->MimeType, 1);
1498 pS = pch = ChrPtr(NewTemplate->Data);
1499 pE = pS + StrLength(NewTemplate->Data);
1501 const char *pts, *pte;
1503 int InDoubleQuotes = 0;
1505 /** Find one <? > */
1507 for (; pch < pE; pch ++) {
1508 if ((*pch=='<')&&(*(pch + 1)=='?') &&
1509 !((pch == pS) && /* we must ommit a <?xml */
1510 (*(pch + 2) == 'x') &&
1511 (*(pch + 3) == 'm') &&
1512 (*(pch + 4) == 'l')))
1514 if (*pch=='\n') Line ++;
1520 /** Found one? parse it. */
1521 for (; pch <= pE - 1; pch ++) {
1523 InDoubleQuotes = ! InDoubleQuotes;
1524 else if (*pch == '\'')
1525 InQuotes = ! InQuotes;
1526 else if ((!InQuotes && !InDoubleQuotes) &&
1527 ((*pch!='\\')&&(*(pch + 1)=='>'))) {
1535 PutNewToken(NewTemplate,
1536 NewTemplateSubstitute(NewTemplate->Data, pS, pts, pte, Line, NewTemplate));
1539 if (LoadTemplates == 0)
1540 Put(PutThere, ChrPtr(Key), StrLength(Key), NewTemplate, FreeWCTemplate);
1545 const char* PrintTemplate(void *vSubst)
1547 WCTemplate *Tmpl = vSubst;
1549 return ChrPtr(Tmpl->FileName);
1553 int LoadTemplateDir(const char *DirName, HashList *wireless, HashList *big)
1558 DIR *filedir = NULL;
1559 struct dirent *filedir_entry;
1565 StrBufPrintf(Dir, "%s/t", DirName);
1566 filedir = opendir (ChrPtr(Dir));
1567 if (filedir == NULL) {
1572 FileName = NewStrBuf();
1574 while ((filedir_entry = readdir(filedir)))
1578 #ifdef _DIRENT_HAVE_D_NAMELEN
1579 d_namelen = filedir_entry->d_namelen;
1581 d_namelen = strlen(filedir_entry->d_name);
1583 d_without_ext = d_namelen;
1584 while ((d_without_ext > 0) && (filedir_entry->d_name[d_without_ext] != '.'))
1586 if ((d_without_ext == 0) || (d_namelen < 3))
1588 if ((d_namelen > 1) && filedir_entry->d_name[d_namelen - 1] == '~')
1589 continue; /* Ignore backup files... */
1591 IsMobile = (strstr(filedir_entry->d_name, ".m.html")!= NULL);
1592 PStart = filedir_entry->d_name;
1593 StrBufPrintf(FileName, "%s/%s", ChrPtr(Dir), filedir_entry->d_name);
1594 MinorPtr = strchr(filedir_entry->d_name, '.');
1595 if (MinorPtr != NULL)
1597 StrBufPlain(Tag, filedir_entry->d_name, MinorPtr - filedir_entry->d_name);
1599 if (LoadTemplates > 1)
1600 lprintf(1, "%s %d %s\n",ChrPtr(FileName), IsMobile, ChrPtr(Tag));
1601 if (LoadTemplates == 0)
1602 load_template(FileName, Tag, (IsMobile)?wireless:big);
1604 prepare_template(FileName, Tag, (IsMobile)?wireless:big);
1607 FreeStrBuf(&FileName);
1613 void InitTemplateCache(void)
1615 LoadTemplateDir(static_dirs[0],
1616 WirelessTemplateCache,
1618 LoadTemplateDir(static_dirs[1],
1619 WirelessLocalTemplateCache,
1620 LocalTemplateCache);
1625 /*-----------------------------------------------------------------------------
1626 * Filling & processing Templates
1629 * \brief executes one token
1630 * \param Target buffer to append to
1631 * \param Token da to process.
1632 * \param Template we're iterating
1633 * \param Context Contextpoointer to pass in
1634 * \param state are we in conditional state?
1635 * \param ContextType what type of information does context giv us?
1637 int EvaluateToken(StrBuf *Target, int state, WCTemplputParams *TP)
1639 const char *AppendMe;
1641 HashHandler *Handler;
1644 /* much output, since pName is not terminated...
1645 lprintf(1,"Doing token: %s\n",Token->pName);
1648 switch (TP->Tokens->Flags) {
1650 TmplGettext(Target, TP);
1652 case SV_CONDITIONAL: /** Forward conditional evaluation */
1653 return EvaluateConditional(Target, 1, state, TP);
1655 case SV_NEG_CONDITIONAL: /** Reverse conditional evaluation */
1656 return EvaluateConditional(Target, 0, state, TP);
1658 case SV_CUST_STR_CONDITIONAL: /** Conditional put custom strings from params */
1659 if (TP->Tokens->nParameters >= 6) {
1660 if (EvaluateConditional(Target, 0, state, TP)) {
1661 GetTemplateTokenString(Target, TP, 5, &AppendMe, &AppendMeLen);
1662 StrBufAppendBufPlain(Target,
1668 GetTemplateTokenString(Target, TP, 4, &AppendMe, &AppendMeLen);
1669 StrBufAppendBufPlain(Target,
1677 Target, "Conditional", ERR_NAME, TP,
1678 "needs at least 6 Params!");
1682 if (TP->Tokens->nParameters == 1)
1683 DoTemplate(TKEY(0), Target, TP);
1685 case SV_PREEVALUATED:
1686 Handler = (HashHandler*) TP->Tokens->PreEval;
1687 if (!CheckContext(Target, &Handler->Filter, TP, "Token")) {
1690 Handler->HandlerFunc(Target, TP);
1693 if (GetHash(GlobalNS, TP->Tokens->pName, TP->Tokens->NameEnd, &vVar)) {
1694 Handler = (HashHandler*) vVar;
1695 if (!CheckContext(Target, &Handler->Filter, TP, "Token")) {
1699 Handler->HandlerFunc(Target, TP);
1703 print_value_of(Target, TP);
1711 const StrBuf *ProcessTemplate(WCTemplate *Tmpl, StrBuf *Target, WCTemplputParams *CallingTP)
1713 WCTemplate *pTmpl = Tmpl;
1716 const char *pData, *pS;
1718 WCTemplputParams TP;
1720 memcpy(&TP.Filter, &CallingTP->Filter, sizeof(ContextFilter));
1722 TP.Context = CallingTP->Context;
1723 TP.ControlContext = CallingTP->ControlContext;
1725 if (LoadTemplates != 0) {
1726 if (LoadTemplates > 1)
1727 lprintf(1, "DBG: ----- loading: [%s] ------ \n",
1728 ChrPtr(Tmpl->FileName));
1730 pTmpl = load_template(Tmpl->FileName, NULL, NULL);
1734 "<pre>\nError loading Template [%s]\n See Logfile for details\n</pre>\n",
1735 ChrPtr(Tmpl->FileName));
1741 pS = pData = ChrPtr(pTmpl->Data);
1742 len = StrLength(pTmpl->Data);
1746 if (i >= pTmpl->nTokensUsed) {
1747 StrBufAppendBufPlain(Target,
1749 len - (pData - pS), 0);
1753 StrBufAppendBufPlain(
1755 pTmpl->Tokens[i]->pTokenStart - pData, 0);
1756 TP.Tokens = pTmpl->Tokens[i];
1757 TP.nArgs = pTmpl->Tokens[i]->nParameters;
1758 state = EvaluateToken(Target, state, &TP);
1760 while ((state != 0) && (i+1 < pTmpl->nTokensUsed)) {
1761 /* condition told us to skip till its end condition */
1763 TP.Tokens = pTmpl->Tokens[i];
1764 TP.nArgs = pTmpl->Tokens[i]->nParameters;
1765 if ((pTmpl->Tokens[i]->Flags == SV_CONDITIONAL) ||
1766 (pTmpl->Tokens[i]->Flags == SV_NEG_CONDITIONAL)) {
1767 if (state == EvaluateConditional(
1769 pTmpl->Tokens[i]->Flags,
1775 pData = pTmpl->Tokens[i++]->pTokenEnd + 1;
1776 if (i > pTmpl->nTokensUsed)
1780 if (LoadTemplates != 0) {
1781 FreeWCTemplate(pTmpl);
1783 return Tmpl->MimeType;
1788 * \brief Display a variable-substituted template
1789 * \param templatename template file to load
1790 * \returns the mimetype of the template its doing
1792 const StrBuf *DoTemplate(const char *templatename, long len, StrBuf *Target, WCTemplputParams *TP)
1794 WCTemplputParams LocalTP;
1796 HashList *StaticLocal;
1802 memset(&LocalTP, 0, sizeof(WCTemplputParams));
1806 if (WC->is_mobile) {
1807 Static = WirelessTemplateCache;
1808 StaticLocal = WirelessLocalTemplateCache;
1811 Static = TemplateCache;
1812 StaticLocal = LocalTemplateCache;
1817 lprintf (1, "Can't to load a template with empty name!\n");
1818 StrBufAppendPrintf(Target, "<pre>\nCan't to load a template with empty name!\n</pre>");
1822 if (!GetHash(StaticLocal, templatename, len, &vTmpl) &&
1823 !GetHash(Static, templatename, len, &vTmpl)) {
1824 lprintf (1, "didn't find Template [%s] %ld %ld\n", templatename, len , (long)strlen(templatename));
1825 StrBufAppendPrintf(Target, "<pre>\ndidn't find Template [%s] %ld %ld\n</pre>",
1827 (long)strlen(templatename));
1829 dbg_PrintHash(Static, PrintTemplate, NULL);
1830 PrintHash(Static, VarPrintTransition, PrintTemplate);
1836 return ProcessTemplate(vTmpl, Target, TP);
1840 /*-----------------------------------------------------------------------------
1843 typedef struct _HashIterator {
1844 HashList *StaticList;
1845 int AdditionalParams;
1847 int XPectContextType;
1849 RetrieveHashlistFunc GetHash;
1850 HashDestructorFunc Destructor;
1851 SubTemplFunc DoSubTemplate;
1854 void RegisterITERATOR(const char *Name, long len,
1855 int AdditionalParams,
1856 HashList *StaticList,
1857 RetrieveHashlistFunc GetHash,
1858 SubTemplFunc DoSubTempl,
1859 HashDestructorFunc Destructor,
1861 int XPectContextType,
1866 It = (HashIterator*)malloc(sizeof(HashIterator));
1867 memset(It, 0, sizeof(HashIterator));
1868 It->StaticList = StaticList;
1869 It->AdditionalParams = AdditionalParams;
1870 It->GetHash = GetHash;
1871 It->DoSubTemplate = DoSubTempl;
1872 It->Destructor = Destructor;
1873 It->ContextType = ContextType;
1874 It->XPectContextType = XPectContextType;
1876 Put(Iterators, Name, len, It, NULL);
1879 typedef struct _iteratestruct {
1888 void tmpl_iterate_subtmpl(StrBuf *Target, WCTemplputParams *TP)
1894 SortStruct *SortBy = NULL;
1896 int DetectGroupChange = 0;
1899 void *vLastContext = NULL;
1901 WCTemplputParams SubTP;
1902 IterateStruct Status;
1908 memset(&Status, 0, sizeof(IterateStruct));
1909 memcpy (&SubTP, &TP, sizeof(WCTemplputParams));
1911 if (!GetHash(Iterators, TKEY(0), &vIt)) {
1913 Target, "Iterator", ERR_PARM1, TP, "Unknown!");
1917 It = (HashIterator*) vIt;
1919 if (TP->Tokens->nParameters < It->AdditionalParams + 2) {
1921 Target, "Iterator", ERR_PARM1, TP,
1922 "doesn't work with %d params",
1923 TP->Tokens->nParameters);
1927 if ((It->XPectContextType != CTX_NONE) &&
1928 (It->XPectContextType != TP->Filter.ContextType)) {
1930 Target, "Iterator", ERR_PARM1, TP,
1931 "requires context of type %d, have %d",
1932 It->XPectContextType,
1933 TP->Filter.ContextType);
1938 if (It->StaticList == NULL)
1939 List = It->GetHash(Target, TP);
1941 List = It->StaticList;
1943 DetectGroupChange = (It->Flags & IT_FLAG_DETECT_GROUPCHANGE) != 0;
1944 if (DetectGroupChange) {
1945 const StrBuf *BSort;
1946 DetectGroupChange = 0;
1947 if (havebstr("SortBy")) {
1948 BSort = sbstr("SortBy");
1949 if (GetHash(SortHash, SKEY(BSort), &vSortBy) &&
1950 (vSortBy != NULL)) {
1951 SortBy = (SortStruct*)vSortBy;
1952 /** Ok, its us, lets see in which direction we should sort... */
1953 if (havebstr("SortOrder")) {
1955 SortOrder = LBSTR("SortOrder");
1957 DetectGroupChange = 1;
1962 nMembersUsed = GetCount(List);
1963 SubBuf = NewStrBuf();
1964 SubTP.Filter.ContextType = It->ContextType;
1965 SubTP.Filter.ControlContextType = CTX_ITERATE;
1966 SubTP.ControlContext = &Status;
1968 if (HAVE_PARAM(2)) {
1969 StartAt = GetTemplateTokenNumber(Target, TP, 2, 0);
1971 if (HAVE_PARAM(3)) {
1972 StepWidth = GetTemplateTokenNumber(Target, TP, 3, 0);
1974 if (HAVE_PARAM(4)) {
1975 StopAt = GetTemplateTokenNumber(Target, TP, 4, -1);
1977 it = GetNewHashPos(List, StepWidth);
1979 StopAt = GetCount(List);
1981 while (GetNextHashPos(List, it, &Status.KeyLen, &Status.Key, &vContext)) {
1982 if ((Status.n >= StartAt) && (Status.n <= StopAt)) {
1983 if (DetectGroupChange && Status.n > 0) {
1984 Status.GroupChange = SortBy->GroupChange(vContext, vLastContext);
1986 Status.LastN = (Status.n + 1) == nMembersUsed;
1987 SubTP.Context = vContext;
1988 if (It->DoSubTemplate != NULL)
1989 It->DoSubTemplate(SubBuf, &SubTP);
1990 DoTemplate(TKEY(1), SubBuf, &SubTP);
1992 StrBufAppendBuf(Target, SubBuf, 0);
1993 FlushStrBuf(SubBuf);
1994 Status.oddeven = ! Status.oddeven;
1995 vLastContext = vContext;
1999 FreeStrBuf(&SubBuf);
2001 if (It->Destructor != NULL)
2002 It->Destructor(&List);
2006 int conditional_ITERATE_ISGROUPCHANGE(StrBuf *Target, WCTemplputParams *TP)
2008 IterateStruct *Ctx = CCTX;
2009 if (TP->Tokens->nParameters < 3)
2010 return Ctx->GroupChange;
2012 return TP->Tokens->Params[2]->lvalue == Ctx->GroupChange;
2015 void tmplput_ITERATE_ODDEVEN(StrBuf *Target, WCTemplputParams *TP)
2017 IterateStruct *Ctx = CCTX;
2019 StrBufAppendBufPlain(Target, HKEY("odd"), 0);
2021 StrBufAppendBufPlain(Target, HKEY("even"), 0);
2025 void tmplput_ITERATE_KEY(StrBuf *Target, WCTemplputParams *TP)
2027 IterateStruct *Ctx = CCTX;
2029 StrBufAppendBufPlain(Target, Ctx->Key, Ctx->KeyLen, 0);
2033 void tmplput_ITERATE_LASTN(StrBuf *Target, WCTemplputParams *TP)
2035 IterateStruct *Ctx = CCTX;
2036 StrBufAppendPrintf(Target, "%d", Ctx->n);
2039 int conditional_ITERATE_FIRSTN(StrBuf *Target, WCTemplputParams *TP)
2041 IterateStruct *Ctx = CCTX;
2045 int conditional_ITERATE_LASTN(StrBuf *Target, WCTemplputParams *TP)
2047 IterateStruct *Ctx = CCTX;
2053 /*-----------------------------------------------------------------------------
2056 int EvaluateConditional(StrBuf *Target, int Neg, int state, WCTemplputParams *TP)
2058 ConditionalStruct *Cond;
2060 if ((TP->Tokens->Params[0]->len == 1) &&
2061 (TP->Tokens->Params[0]->Start[0] == 'X'))
2062 return (state != 0)?TP->Tokens->Params[1]->lvalue:0;
2064 Cond = (ConditionalStruct *) TP->Tokens->PreEval;
2067 Target, "Conditional", ERR_PARM1, TP,
2072 if (!CheckContext(Target, &Cond->Filter, TP, "Conditional")) {
2076 if (Cond->CondF(Target, TP) == Neg)
2077 return TP->Tokens->Params[1]->lvalue;
2081 int ConditionalVar(StrBuf *Target, WCTemplputParams *TP)
2086 if (!GetHash(WC->vars, TKEY(2), &vsubst))
2088 subst = (wcsubst*) vsubst;
2090 switch(subst->wcs_type) {
2092 return (subst->wcs_function!=NULL);
2094 lprintf(1, " -> Server [%s]\n", subst->wcs_value);/* TODO */
2098 case WCS_STRBUF_REF:
2099 if (TP->Tokens->nParameters < 4)
2101 return (strcmp(TP->Tokens->Params[3]->Start, ChrPtr(subst->wcs_value)) == 0);
2103 if (TP->Tokens->nParameters < 4)
2104 return (subst->lvalue != 0);
2105 return (subst->lvalue == TP->Tokens->Params[3]->lvalue);
2107 lprintf(1," WARNING: invalid type: [%ld]!\n", subst->wcs_type);
2113 void RegisterConditional(const char *Name, long len,
2115 WCConditionalFunc CondF,
2116 int ContextRequired)
2118 ConditionalStruct *Cond;
2120 Cond = (ConditionalStruct*)malloc(sizeof(ConditionalStruct));
2121 memset(Cond, 0, sizeof(ConditionalStruct));
2122 Cond->PlainName = Name;
2123 Cond->Filter.nMaxArgs = nParams;
2124 Cond->Filter.nMinArgs = nParams;
2125 Cond->CondF = CondF;
2126 Cond->Filter.ContextType = ContextRequired;
2127 Cond->Filter.ControlContextType = CTX_NONE;
2128 Put(Conditionals, Name, len, Cond, NULL);
2131 void RegisterControlConditional(const char *Name, long len,
2133 WCConditionalFunc CondF,
2134 int ControlContextRequired)
2136 ConditionalStruct *Cond;
2138 Cond = (ConditionalStruct*)malloc(sizeof(ConditionalStruct));
2139 memset(Cond, 0, sizeof(ConditionalStruct));
2140 Cond->PlainName = Name;
2141 Cond->Filter.nMaxArgs = nParams;
2142 Cond->Filter.nMinArgs = nParams;
2143 Cond->CondF = CondF;
2144 Cond->Filter.ContextType = CTX_NONE;
2145 Cond->Filter.ControlContextType = ControlContextRequired;
2146 Put(Conditionals, Name, len, Cond, NULL);
2149 /*-----------------------------------------------------------------------------
2152 void tmplput_ContextString(StrBuf *Target, WCTemplputParams *TP)
2154 StrBufAppendTemplate(Target, TP, (StrBuf*)CTX, 0);
2156 int ConditionalContextStr(StrBuf *Target, WCTemplputParams *TP)
2158 StrBuf *TokenText = (StrBuf*) CTX;
2159 const char *CompareToken;
2162 GetTemplateTokenString(Target, TP, 2, &CompareToken, &len);
2163 return strcmp(ChrPtr(TokenText), CompareToken) == 0;
2166 /*-----------------------------------------------------------------------------
2170 void tmpl_do_boxed(StrBuf *Target, WCTemplputParams *TP)
2172 WCTemplputParams SubTP;
2175 if (TP->Tokens->nParameters == 2) {
2176 if (TP->Tokens->Params[1]->Type == TYPE_STR) {
2177 Headline = NewStrBuf();
2178 DoTemplate(TKEY(1), Headline, TP);
2183 GetTemplateTokenString(Target,
2188 Headline = NewStrBufPlain(Ch, len);
2191 memcpy (&SubTP, TP, sizeof(WCTemplputParams));
2192 SubTP.Context = Headline;
2193 SubTP.Filter.ContextType = CTX_STRBUF;
2194 DoTemplate(HKEY("beginbox"), Target, &SubTP);
2195 DoTemplate(TKEY(0), Target, TP);
2196 DoTemplate(HKEY("endbox"), Target, TP);
2197 FreeStrBuf(&Headline);
2200 /*-----------------------------------------------------------------------------
2204 void tmpl_do_tabbed(StrBuf *Target, WCTemplputParams *TP)
2207 int i, ntabs, nTabs;
2209 nTabs = ntabs = TP->Tokens->nParameters / 2;
2210 TabNames = (StrBuf **) malloc(ntabs * sizeof(StrBuf*));
2211 memset(TabNames, 0, ntabs * sizeof(StrBuf*));
2213 for (i = 0; i < ntabs; i++) {
2214 if ((TP->Tokens->Params[i * 2]->Type == TYPE_STR) &&
2215 (TP->Tokens->Params[i * 2]->len > 0)) {
2216 TabNames[i] = NewStrBuf();
2217 DoTemplate(TKEY(i * 2), TabNames[i], TP);
2219 else if (TP->Tokens->Params[i * 2]->Type == TYPE_GETTEXT) {
2222 GetTemplateTokenString(Target,
2227 TabNames[i] = NewStrBufPlain(Ch, -1);
2230 /** A Tab without subject? we can't count that, add it as silent */
2235 StrTabbedDialog(Target, nTabs, TabNames);
2236 for (i = 0; i < ntabs; i++) {
2237 StrBeginTab(Target, i, nTabs);
2238 DoTemplate(TKEY(i * 2 + 1), Target, TP);
2239 StrEndTab(Target, i, nTabs);
2244 /*-----------------------------------------------------------------------------
2249 void RegisterSortFunc(const char *name, long len,
2250 const char *prepend, long preplen,
2251 CompareFunc Forward,
2252 CompareFunc Reverse,
2253 CompareFunc GroupChange,
2256 SortStruct *NewSort;
2258 NewSort = (SortStruct*) malloc(sizeof(SortStruct));
2259 memset(NewSort, 0, sizeof(SortStruct));
2260 NewSort->Name = NewStrBufPlain(name, len);
2261 if (prepend != NULL)
2262 NewSort->PrefPrepend = NewStrBufPlain(prepend, preplen);
2264 NewSort->PrefPrepend = NULL;
2265 NewSort->Forward = Forward;
2266 NewSort->Reverse = Reverse;
2267 NewSort->GroupChange = GroupChange;
2268 NewSort->ContextType = ContextType;
2269 Put(SortHash, name, len, NewSort, DestroySortStruct);
2272 CompareFunc RetrieveSort(WCTemplputParams *TP,
2273 const char *OtherPrefix, long OtherPrefixLen,
2274 const char *Default, long ldefault, long DefaultDirection)
2277 const StrBuf *BSort = NULL;
2280 long SortOrder = -1;
2282 if (havebstr("SortBy")) {
2283 BSort = sbstr("SortBy");
2284 if (OtherPrefix == NULL) {
2285 set_room_pref("sort", NewStrBufDup(BSort), 0);
2288 set_X_PREFS(HKEY("sort"), OtherPrefix, OtherPrefixLen, NewStrBufDup(BSort), 0);
2291 else { /** Try to fallback to our remembered values... */
2292 if (OtherPrefix == NULL) {
2293 BSort = get_room_pref("sort");
2296 BSort = get_X_PREFS(HKEY("sort"), OtherPrefix, OtherPrefixLen);
2299 putbstr("SortBy", NewStrBufDup(BSort));
2303 BSort = Buf = NewStrBufPlain(Default, ldefault);
2304 putbstr("SortBy", Buf);
2308 if (!GetHash(SortHash, SKEY(BSort), &vSortBy) ||
2309 (vSortBy == NULL)) {
2311 if (!GetHash(SortHash, Default, ldefault, &vSortBy) ||
2312 (vSortBy == NULL)) {
2314 NULL, "Sorting", ERR_PARM1, TP,
2315 "Illegal default sort: [%s]", Default);
2319 SortBy = (SortStruct*)vSortBy;
2321 /** Ok, its us, lets see in which direction we should sort... */
2322 if (havebstr("SortOrder")) {
2323 SortOrder = LBSTR("SortOrder");
2325 else { /** Try to fallback to our remembered values... */
2327 if (SortBy->PrefPrepend == NULL) {
2328 Buf = get_room_pref("SortOrder");
2329 SortOrder = StrTol(Buf);
2332 BSort = get_X_PREFS(HKEY("SortOrder"), OtherPrefix, OtherPrefixLen);
2336 SortOrder = DefaultDirection;
2338 Buf = NewStrBufPlain(NULL, 64);
2339 StrBufPrintf(Buf, "%ld", SortOrder);
2340 putbstr("SortOrder", Buf);
2342 switch (SortOrder) {
2347 return SortBy->Forward;
2349 return SortBy->Reverse;
2361 ConstStr SortIcons[] = {
2362 {HKEY("static/sort_none.gif")},
2363 {HKEY("static/up_pointer.gif")},
2364 {HKEY("static/down_pointer.gif")},
2367 ConstStr SortNextOrder[] = {
2374 int GetSortMetric(WCTemplputParams *TP, SortStruct **Next, SortStruct **Param, long *SortOrder, int N)
2376 int bSortError = eNOT_SPECIFIED;
2377 const StrBuf *BSort;
2382 if (!GetHash(SortHash, TKEY(0), &vSort) ||
2384 return eNO_SUCH_SORT;
2385 *Param = (SortStruct*) vSort;
2388 if (havebstr("SortBy")) {
2389 BSort = sbstr("SortBy");
2390 bSortError = eINVALID_PARAM;
2391 if ((*Param)->PrefPrepend == NULL) {
2392 set_room_pref("sort", NewStrBufDup(BSort), 0);
2395 set_X_PREFS(HKEY("sort"), TKEY(N), NewStrBufDup(BSort), 0);
2398 else { /** Try to fallback to our remembered values... */
2399 if ((*Param)->PrefPrepend == NULL) {
2400 BSort = get_room_pref("sort");
2403 BSort = get_X_PREFS(HKEY("sort"), TKEY(N));
2407 if (!GetHash(SortHash, SKEY(BSort), &vSort) ||
2411 *Next = (SortStruct*) vSort;
2413 /** Ok, its us, lets see in which direction we should sort... */
2414 if (havebstr("SortOrder")) {
2415 *SortOrder = LBSTR("SortOrder");
2417 else { /** Try to fallback to our remembered values... */
2418 if ((*Param)->PrefPrepend == NULL) {
2419 *SortOrder = StrTol(get_room_pref("SortOrder"));
2422 *SortOrder = StrTol(get_X_PREFS(HKEY("SortOrder"), TKEY(N)));
2432 void tmplput_SORT_ICON(StrBuf *Target, WCTemplputParams *TP)
2437 const ConstStr *SortIcon;
2439 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2442 Target, "Sorter", ERR_PARM1, TP,
2443 " Sorter [%s] unknown!",
2444 TP->Tokens->Params[0]->Start);
2446 case eINVALID_PARAM:
2447 LogTemplateError(NULL, "Sorter", ERR_PARM1, TP,
2448 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2450 case eNOT_SPECIFIED:
2452 if (Next == Param) {
2453 SortIcon = &SortIcons[SortOrder];
2455 else { /** Not Us... */
2456 SortIcon = &SortIcons[0];
2458 StrBufAppendBufPlain(Target, SortIcon->Key, SortIcon->len, 0);
2462 void tmplput_SORT_NEXT(StrBuf *Target, WCTemplputParams *TP)
2468 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2471 Target, "Sorter", ERR_PARM1, TP,
2472 " Sorter [%s] unknown!",
2473 TP->Tokens->Params[0]->Start);
2475 case eINVALID_PARAM:
2477 NULL, "Sorter", ERR_PARM1, TP,
2478 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2480 case eNOT_SPECIFIED:
2482 StrBufAppendBuf(Target, Param->Name, 0);
2487 void tmplput_SORT_ORDER(StrBuf *Target, WCTemplputParams *TP)
2490 const ConstStr *SortOrderStr;
2494 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2497 Target, "Sorter", ERR_PARM1, TP,
2498 " Sorter [%s] unknown!",
2499 TP->Tokens->Params[0]->Start);
2501 case eINVALID_PARAM:
2503 NULL, "Sorter", ERR_PARM1, TP,
2504 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2506 case eNOT_SPECIFIED:
2508 if (Next == Param) {
2509 SortOrderStr = &SortNextOrder[SortOrder];
2511 else { /** Not Us... */
2512 SortOrderStr = &SortNextOrder[0];
2514 StrBufAppendBufPlain(Target, SortOrderStr->Key, SortOrderStr->len, 0);
2519 void tmplput_long_vector(StrBuf *Target, WCTemplputParams *TP)
2521 long *LongVector = (long*) CTX;
2523 if ((TP->Tokens->Params[0]->Type == TYPE_LONG) &&
2524 (TP->Tokens->Params[0]->lvalue <= LongVector[0]))
2526 StrBufAppendPrintf(Target, "%ld", LongVector[TP->Tokens->Params[0]->lvalue]);
2530 if (TP->Tokens->Params[0]->Type != TYPE_LONG) {
2532 Target, "Longvector", ERR_NAME, TP,
2533 "needs a numerical Parameter!");
2537 Target, "LongVector", ERR_PARM1, TP,
2538 "doesn't have %ld Parameters, its just the size of %ld!",
2539 TP->Tokens->Params[0]->lvalue,
2545 void dbg_print_longvector(long *LongVector)
2547 StrBuf *Buf = NewStrBufPlain(HKEY("Longvector: ["));
2548 int nItems = LongVector[0];
2551 for (i = 0; i < nItems; i++) {
2553 StrBufAppendPrintf(Buf, "%d: %ld | ", i, LongVector[i]);
2555 StrBufAppendPrintf(Buf, "%d: %ld]\n", i, LongVector[i]);
2558 lprintf(1, ChrPtr(Buf));
2562 int ConditionalLongVector(StrBuf *Target, WCTemplputParams *TP)
2564 long *LongVector = (long*) CTX;
2566 if ((TP->Tokens->Params[2]->Type == TYPE_LONG) &&
2567 (TP->Tokens->Params[2]->lvalue <= LongVector[0])&&
2568 (TP->Tokens->Params[3]->Type == TYPE_LONG) &&
2569 (TP->Tokens->Params[3]->lvalue <= LongVector[0]))
2571 return LongVector[TP->Tokens->Params[2]->lvalue] ==
2572 LongVector[TP->Tokens->Params[3]->lvalue];
2576 if ((TP->Tokens->Params[2]->Type == TYPE_LONG) ||
2577 (TP->Tokens->Params[2]->Type == TYPE_LONG)) {
2579 Target, "ConditionalLongvector", ERR_PARM1, TP,
2580 "needs two long Parameter!");
2584 Target, "Longvector", ERR_PARM1, TP,
2585 "doesn't have %ld / %ld Parameters, its just the size of %ld!",
2586 TP->Tokens->Params[2]->lvalue,
2587 TP->Tokens->Params[3]->lvalue,
2598 memset(&NoCtx, 0, sizeof(WCTemplputParams));
2599 RegisterNamespace("SORT:ICON", 1, 2, tmplput_SORT_ICON, CTX_NONE);
2600 RegisterNamespace("SORT:ORDER", 1, 2, tmplput_SORT_ORDER, CTX_NONE);
2601 RegisterNamespace("SORT:NEXT", 1, 2, tmplput_SORT_NEXT, CTX_NONE);
2602 RegisterNamespace("CONTEXTSTR", 0, 1, tmplput_ContextString, CTX_STRBUF);
2603 RegisterNamespace("ITERATE", 2, 100, tmpl_iterate_subtmpl, CTX_NONE);
2604 RegisterNamespace("DOBOXED", 1, 2, tmpl_do_boxed, CTX_NONE);
2605 RegisterNamespace("DOTABBED", 2, 100, tmpl_do_tabbed, CTX_NONE);
2606 RegisterNamespace("LONGVECTOR", 1, 1, tmplput_long_vector, CTX_LONGVECTOR);
2607 RegisterConditional(HKEY("COND:SUBST"), 3, ConditionalVar, CTX_NONE);
2608 RegisterConditional(HKEY("COND:CONTEXTSTR"), 3, ConditionalContextStr, CTX_STRBUF);
2609 RegisterConditional(HKEY("COND:LONGVECTOR"), 4, ConditionalLongVector, CTX_LONGVECTOR);
2611 RegisterControlConditional(HKEY("COND:ITERATE:ISGROUPCHANGE"), 2,
2612 conditional_ITERATE_ISGROUPCHANGE,
2614 RegisterControlConditional(HKEY("COND:ITERATE:LASTN"), 2,
2615 conditional_ITERATE_LASTN,
2617 RegisterControlConditional(HKEY("COND:ITERATE:FIRSTN"), 2,
2618 conditional_ITERATE_FIRSTN,
2621 RegisterControlNS(HKEY("ITERATE:ODDEVEN"), 0, 0, tmplput_ITERATE_ODDEVEN, CTX_ITERATE);
2622 RegisterControlNS(HKEY("ITERATE:KEY"), 0, 0, tmplput_ITERATE_KEY, CTX_ITERATE);
2623 RegisterControlNS(HKEY("ITERATE:N"), 0, 0, tmplput_ITERATE_LASTN, CTX_ITERATE);
2627 ServerStartModule_SUBST
2630 WirelessTemplateCache = NewHash(1, NULL);
2631 WirelessLocalTemplateCache = NewHash(1, NULL);
2632 LocalTemplateCache = NewHash(1, NULL);
2633 TemplateCache = NewHash(1, NULL);
2635 GlobalNS = NewHash(1, NULL);
2636 Iterators = NewHash(1, NULL);
2637 Conditionals = NewHash(1, NULL);
2638 SortHash = NewHash(1, NULL);
2642 FinalizeModule_SUBST
2649 ServerShutdownModule_SUBST
2652 DeleteHash(&WirelessTemplateCache);
2653 DeleteHash(&WirelessLocalTemplateCache);
2654 DeleteHash(&TemplateCache);
2655 DeleteHash(&LocalTemplateCache);
2657 DeleteHash(&GlobalNS);
2658 DeleteHash(&Iterators);
2659 DeleteHash(&Conditionals);
2660 DeleteHash(&SortHash);
2666 SessionNewModule_SUBST
2673 SessionAttachModule_SUBST
2676 sess->vars = NewHash(1,NULL);
2680 SessionDetachModule_SUBST
2683 DeleteHash(&sess->vars);
2687 SessionDestroyModule_SUBST