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 LoadTemplates = 0;
36 int dbg_bactrace_template_errors = 0;
37 WCTemplputParams NoCtx;
40 #define SV_CONDITIONAL 2
41 #define SV_NEG_CONDITIONAL 3
42 #define SV_CUST_STR_CONDITIONAL 4
44 #define SV_PREEVALUATED 6
46 typedef struct _WCTemplate {
51 WCTemplateToken **Tokens;
54 typedef struct _HashHandler {
57 WCHandlerFunc HandlerFunc;
60 void *load_template(StrBuf *filename, StrBuf *Key, HashList *PutThere);
61 int EvaluateConditional(StrBuf *Target, int Neg, int state, WCTemplputParams *TP);
65 typedef struct _SortStruct {
70 CompareFunc GroupChange;
75 const char *CtxNames[] = {
98 void DestroySortStruct(void *vSort)
100 SortStruct *Sort = (SortStruct*) vSort;
101 FreeStrBuf(&Sort->Name);
102 FreeStrBuf(&Sort->PrefPrepend);
106 const char *ContextName(int ContextType)
108 if (ContextType < CTX_UNKNOWN)
109 return CtxNames[ContextType];
111 return CtxNames[CTX_UNKNOWN];
114 void LogTemplateError (StrBuf *Target, const char *Type, int ErrorPos, WCTemplputParams *TP, const char *Format, ...)
121 const char *Err = NULL;
126 va_start(arg_ptr, Format);
127 StrBufVAppendPrintf(Error, Format, arg_ptr);
132 case ERR_NAME: /* the main token name... */
133 Err = (TP->Tokens!= NULL)? TP->Tokens->pName:"";
136 Err = (TP->Tokens!= NULL)? TP->Tokens->Params[0]->Start:"";
139 Err = (TP->Tokens!= NULL)? TP->Tokens->Params[1]->Start:"";
142 if (TP->Tokens != NULL)
144 lprintf(1, "%s [%s] (in '%s' line %ld); %s; [%s]\n",
147 ChrPtr(TP->Tokens->FileName),
150 ChrPtr(TP->Tokens->FlatToken));
154 lprintf(1, "%s: %s;\n",
161 Header = NewStrBuf();
162 if (TP->Tokens != NULL)
167 "<pre>\n%s [%s] (in '%s' line %ld); %s\n[%s]\n</pre>\n",
170 ChrPtr(TP->Tokens->FileName),
173 ChrPtr(TP->Tokens->FlatToken));
176 SerializeJson(Header, WildFireException(SKEY(TP->Tokens->FileName),
181 SerializeJson(Header, WildFireMessage(SKEY(TP->Tokens->FileName),
186 WildFireSerializePayload(Header, WCC->HBuf, &WCC->nWildfireHeaders, NULL);
193 "<pre>\n%s: %s\n</pre>\n",
197 SerializeJson(Header, WildFireException(HKEY(__FILE__), __LINE__, Error, 1), 1);
198 WildFireSerializePayload(Header, WCC->HBuf, &WCC->nWildfireHeaders, NULL);
202 if (dbg_bactrace_template_errors)
208 void RegisterNS(const char *NSName,
212 WCHandlerFunc HandlerFunc,
215 HashHandler *NewHandler;
217 NewHandler = (HashHandler*) malloc(sizeof(HashHandler));
218 NewHandler->Filter.nMinArgs = nMinArgs;
219 NewHandler->Filter.nMaxArgs = nMaxArgs;
220 NewHandler->Filter.ContextType = ContextRequired;
221 NewHandler->Filter.ControlContextType = CTX_NONE;
223 NewHandler->HandlerFunc = HandlerFunc;
224 Put(GlobalNS, NSName, len, NewHandler, NULL);
227 void RegisterControlNS(const char *NSName,
231 WCHandlerFunc HandlerFunc,
232 int ControlContextRequired)
234 HashHandler *NewHandler;
236 NewHandler = (HashHandler*) malloc(sizeof(HashHandler));
237 NewHandler->Filter.nMinArgs = nMinArgs;
238 NewHandler->Filter.nMaxArgs = nMaxArgs;
239 NewHandler->Filter.ContextType = CTX_NONE;
240 NewHandler->Filter.ControlContextType = ControlContextRequired;
241 NewHandler->HandlerFunc = HandlerFunc;
242 Put(GlobalNS, NSName, len, NewHandler, NULL);
247 int CheckContext(StrBuf *Target, ContextFilter *Need, WCTemplputParams *TP, const char *ErrType)
249 if ((Need->ContextType != CTX_NONE) &&
250 (Need->ContextType != TP->Filter.ContextType)) {
252 Target, ErrType, ERR_PARM1, TP,
253 " WARNING: requires Context: [%s], have [%s]!",
254 ContextName(Need->ContextType),
255 ContextName(TP->Filter.ContextType));
259 if ((Need->ControlContextType != CTX_NONE) &&
260 (Need->ControlContextType != TP->Filter.ControlContextType)) {
262 Target, ErrType, ERR_PARM1, TP,
263 " WARNING: requires Control Context: [%s], have [%s]!",
264 ContextName(Need->ControlContextType),
265 ContextName(TP->Filter.ControlContextType));
269 if (TP->Tokens->nParameters < Need->nMinArgs) {
270 LogTemplateError(Target, ErrType, ERR_NAME, TP,
271 "needs at least %ld params, have %ld",
273 TP->Tokens->nParameters);
277 else if (TP->Tokens->nParameters > Need->nMaxArgs) {
278 LogTemplateError(Target, ErrType, ERR_NAME, TP,
279 "just needs %ld params, you gave %ld",
281 TP->Tokens->nParameters);
289 void FreeToken(WCTemplateToken **Token)
292 FreeStrBuf(&(*Token)->FlatToken);
293 if ((*Token)->HaveParameters)
294 for (i = 0; i < (*Token)->nParameters; i++)
295 free((*Token)->Params[i]);
302 void FreeWCTemplate(void *vFreeMe)
305 WCTemplate *FreeMe = (WCTemplate*)vFreeMe;
307 if (FreeMe->TokenSpace > 0) {
308 for (i = 0; i < FreeMe->nTokensUsed; i ++) {
309 FreeToken(&FreeMe->Tokens[i]);
311 free(FreeMe->Tokens);
313 FreeStrBuf(&FreeMe->FileName);
314 FreeStrBuf(&FreeMe->Data);
320 * \brief debugging function to print array to log
322 void VarPrintTransition(void *vVar1, void *vVar2, int odd){}
324 * \brief debugging function to print array to log
326 void VarPrintEntry(const char *Key, void *vSubst, int odd)
329 lprintf(1,"Subst[%s] : ", Key);
330 ptr = (wcsubst*) vSubst;
332 switch(ptr->wcs_type) {
334 lprintf(1, " -> %s\n", ChrPtr(ptr->wcs_value));
337 lprintf(1, " -> Server [%s]\n", ChrPtr(ptr->wcs_value));
340 lprintf(1, " -> function at [%0xd]\n", ptr->wcs_function);
343 lprintf(1," WARNING: invalid type: [%ld]!\n", ptr->wcs_type);
350 * \brief Clear out the list of substitution variables local to this session
352 void clear_substs(wcsession *wc) {
354 if (wc->vars != NULL) {
355 DeleteHash(&wc->vars);
360 * \brief Clear out the list of substitution variables local to this session
362 void clear_local_substs(void) {
381 void FlushPayload(wcsubst *ptr, int reusestrbuf, int type)
383 int NeedNew = NeedNewBuf(type);
384 switch(ptr->wcs_type) {
388 if (reusestrbuf && NeedNew) {
389 FlushStrBuf(ptr->wcs_value);
393 FreeStrBuf(&ptr->wcs_value);
394 ptr->wcs_value = NULL;
398 ptr->wcs_function = NULL;
399 if (reusestrbuf && NeedNew)
400 ptr->wcs_value = NewStrBuf();
403 ptr->wcs_value = NULL;
404 if (reusestrbuf && NeedNew)
405 ptr->wcs_value = NewStrBuf();
409 if (reusestrbuf && NeedNew)
410 ptr->wcs_value = NewStrBuf();
413 if (reusestrbuf && NeedNew)
414 ptr->wcs_value = NewStrBuf();
421 * \brief destructor; kill one entry.
423 void deletevar(void *data)
425 wcsubst *ptr = (wcsubst*)data;
426 FlushPayload(ptr, 0, ptr->wcs_type);
431 wcsubst *NewSubstVar(const char *keyname, int keylen, int type)
436 ptr = (wcsubst *) malloc(sizeof(wcsubst));
437 memset(ptr, 0, sizeof(wcsubst));
439 ptr->wcs_type = type;
440 safestrncpy(ptr->wcs_key, keyname, sizeof ptr->wcs_key);
441 Put(WCC->vars, keyname, keylen, ptr, deletevar);
443 switch(ptr->wcs_type) {
446 ptr->wcs_value = NewStrBuf();
460 * \brief Add a substitution variable (local to this session) (strlen version...)
461 * \param keyname the replacementstring to substitute
462 * \param keytype the kind of the key
463 * \param format the format string ala printf
464 * \param ... the arguments to substitute in the formatstring
466 void SVPRINTF(char *keyname, int keytype, const char *format,...)
474 keylen = strlen(keyname);
476 * First look if we're doing a replacement of
479 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
480 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
481 ptr = (wcsubst*)vPtr;
482 FlushPayload(ptr, keytype, keytype);
483 ptr->wcs_type = keytype;
485 else /** Otherwise allocate a new one */
487 ptr = NewSubstVar(keyname, keylen, keytype);
490 /** Format the string */
491 va_start(arg_ptr, format);
492 StrBufVAppendPrintf(ptr->wcs_value, format, arg_ptr);
497 * \brief Add a substitution variable (local to this session)
498 * \param keyname the replacementstring to substitute
499 * \param keytype the kind of the key
500 * \param format the format string ala printf
501 * \param ... the arguments to substitute in the formatstring
503 void svprintf(char *keyname, size_t keylen, int keytype, const char *format,...)
511 * First look if we're doing a replacement of
514 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
515 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
516 ptr = (wcsubst*)vPtr;
517 FlushPayload(ptr, 1, keytype);
518 ptr->wcs_type = keytype;
520 else /** Otherwise allocate a new one */
522 ptr = NewSubstVar(keyname, keylen, keytype);
525 /** Format the string and save it */
526 va_start(arg_ptr, format);
527 StrBufVAppendPrintf(ptr->wcs_value, format, arg_ptr);
532 * \brief Add a substitution variable (local to this session)
533 * \param keyname the replacementstring to substitute
534 * \param keytype the kind of the key
535 * \param format the format string ala printf
536 * \param ... the arguments to substitute in the formatstring
538 void SVPut(char *keyname, size_t keylen, int keytype, char *Data)
546 * First look if we're doing a replacement of
549 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
550 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
551 ptr = (wcsubst*)vPtr;
552 FlushPayload(ptr, 1, keytype);
553 ptr->wcs_type = keytype;
555 else /** Otherwise allocate a new one */
557 ptr = NewSubstVar(keyname, keylen, keytype);
559 StrBufAppendBufPlain(ptr->wcs_value, Data, -1, 0);
563 * \brief Add a substitution variable (local to this session)
564 * \param keyname the replacementstring to substitute
565 * \param keytype the kind of the key
566 * \param format the format string ala printf
567 * \param ... the arguments to substitute in the formatstring
569 void SVPutLong(char *keyname, size_t keylen, long Data)
577 * First look if we're doing a replacement of
580 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
581 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
582 ptr = (wcsubst*)vPtr;
583 FlushPayload(ptr, 1, WCS_LONG);
584 ptr->wcs_type = WCS_LONG;
586 else /** Otherwise allocate a new one */
588 ptr = NewSubstVar(keyname, keylen, WCS_LONG);
594 * \brief Add a substitution variable (local to this session) that does a callback
595 * \param keyname the keystring to substitute
596 * \param fcn_ptr the function callback to give the substitution string
598 void SVCallback(char *keyname, size_t keylen, WCHandlerFunc fcn_ptr)
605 * First look if we're doing a replacement of
608 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
609 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
610 ptr = (wcsubst*)vPtr;
611 FlushPayload(ptr, 1, WCS_FUNCTION);
612 ptr->wcs_type = WCS_FUNCTION;
614 else /** Otherwise allocate a new one */
616 ptr = NewSubstVar(keyname, keylen, WCS_FUNCTION);
619 ptr->wcs_function = fcn_ptr;
621 inline void SVCALLBACK(char *keyname, WCHandlerFunc fcn_ptr)
623 SVCallback(keyname, strlen(keyname), fcn_ptr);
628 void SVPUTBuf(const char *keyname, int keylen, const StrBuf *Buf, int ref)
635 * First look if we're doing a replacement of
638 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
639 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
640 ptr = (wcsubst*)vPtr;
641 FlushPayload(ptr, 0, (ref)?WCS_STRBUF_REF:WCS_STRBUF);
642 ptr->wcs_type = (ref)?WCS_STRBUF_REF:WCS_STRBUF;
644 else /** Otherwise allocate a new one */
646 ptr = NewSubstVar(keyname, keylen, (ref)?WCS_STRBUF_REF:WCS_STRBUF);
648 ptr->wcs_value = (StrBuf*)Buf;
652 * \brief back end for print_value_of() ... does a server command
653 * \param servcmd server command to execute on the citadel server
655 void pvo_do_cmd(StrBuf *Target, StrBuf *servcmd) {
659 serv_puts(ChrPtr(servcmd));
660 len = serv_getln(buf, sizeof buf);
666 StrBufAppendPrintf(Target, "%s\n", &buf[4]);
669 _fmout(Target, "CENTER");
672 StrBufAppendPrintf(Target, "%s\n", &buf[4]);
678 void GetTemplateTokenString(WCTemplputParams *TP,
684 WCTemplputParams SubTP;
686 if (TP->Tokens->nParameters < N) {
687 lprintf(1, "invalid token. this shouldn't have come till here.\n");
694 switch (TP->Tokens->Params[N]->Type) {
697 *Value = TP->Tokens->Params[N]->Start;
698 *len = TP->Tokens->Params[N]->len;
701 Buf = (StrBuf*) SBstr(TKEY(N));
702 *Value = ChrPtr(Buf);
703 *len = StrLength(Buf);
706 get_PREFERENCE(TKEY(N), &Buf);
707 *Value = ChrPtr(Buf);
708 *len = StrLength(Buf);
712 break; /* todo: string to text? */
714 *Value = _(TP->Tokens->Params[N]->Start);
715 *len = strlen(*Value);
717 case TYPE_SUBTEMPLATE:
718 memset(&SubTP, 0, sizeof(WCTemplputParams *));
719 SubTP.Context = TP->Context;
720 SubTP.Filter.ContextType = TP->Filter.ContextType;
722 DoTemplate(TKEY(N), Buf, &SubTP);
723 *Value = ChrPtr(Buf);
724 *len = StrLength(Buf);
725 /* we can't free it here, so we put it into the subst so its discarded later on. */
726 SVPUTBuf(TKEY(N), Buf, 0);
738 * \brief Print the value of a variable
739 * \param keyname get a key to print
741 void print_value_of(StrBuf *Target, WCTemplputParams *TP)
748 /*if (WCC->vars != NULL) PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
749 /* TODO: depricated! */
750 if (TP->Tokens->pName[0] == '=') {
751 DoTemplate(TP->Tokens->pName+1, TP->Tokens->NameEnd - 1, NULL, &NoCtx);
753 /*/////TODO: if param[1] == "U" -> urlescape
755 /** Page-local variables */
756 if ((WCC->vars!= NULL) && GetHash(WCC->vars, TP->Tokens->pName, TP->Tokens->NameEnd, &vVar)) {
757 ptr = (wcsubst*) vVar;
758 switch(ptr->wcs_type) {
760 StrBufAppendBuf(Target, ptr->wcs_value, 0);
763 pvo_do_cmd(Target, ptr->wcs_value);
766 (*ptr->wcs_function) (Target, TP);
770 StrBufAppendBuf(Target, ptr->wcs_value, 0);
773 StrBufAppendPrintf(Target, "%ld", ptr->lvalue);
777 Target, "Subst", ERR_NAME, TP,
778 "WARNING: invalid value in SV-Hash at %s!", TP->Tokens->pName);
783 Target, "Token", ERR_NAME, TP,
784 "didn't find Handler \"%s\"", TP->Tokens->pName);
789 int CompareSubstToToken(TemplateParam *ParamToCompare, TemplateParam *ParamToLookup)
795 if ((WCC->vars!= NULL) && GetHash(WCC->vars, ParamToLookup->Start,
796 ParamToLookup->len, &vVar)) {
797 ptr = (wcsubst*) vVar;
798 switch(ptr->wcs_type) {
802 if (ParamToCompare->Type == TYPE_STR)
803 return ((ParamToCompare->len == StrLength(ptr->wcs_value)) &&
804 (strcmp(ParamToCompare->Start, ChrPtr(ptr->wcs_value)) == 0));
806 return ParamToCompare->lvalue == StrTol(ptr->wcs_value);
814 if (ParamToCompare->Type == TYPE_STR)
817 return ParamToCompare->lvalue == ptr->lvalue;
820 lprintf(1,"WARNING: invalid value in SV-Hash at %s!\n",
821 ParamToLookup->Start);
827 int CompareSubstToStrBuf(StrBuf *Compare, TemplateParam *ParamToLookup)
833 if ((WCC->vars!= NULL) && GetHash(WCC->vars, ParamToLookup->Start,
834 ParamToLookup->len, &vVar)) {
835 ptr = (wcsubst*) vVar;
836 switch(ptr->wcs_type) {
840 return ((StrLength(Compare) == StrLength(ptr->wcs_value)) &&
841 (strcmp(ChrPtr(Compare), ChrPtr(ptr->wcs_value)) == 0));
848 return StrTol(Compare) == ptr->lvalue;
850 lprintf(1,"WARNING: invalid value in SV-Hash at %s!\n",
851 ParamToLookup->Start);
860 * \brief puts string into the template and computes which escape methon we should use
861 * \param Source the string we should put into the template
862 * \param FormatTypeIndex where should we look for escape types if?
864 void StrBufAppendTemplate(StrBuf *Target,
865 WCTemplputParams *TP,
866 const StrBuf *Source, int FormatTypeIndex)
872 if ((FormatTypeIndex < TP->Tokens->nParameters) &&
873 (TP->Tokens->Params[FormatTypeIndex]->Type == TYPE_STR) &&
874 (TP->Tokens->Params[FormatTypeIndex]->len == 1)) {
875 EscapeAs = *TP->Tokens->Params[FormatTypeIndex]->Start;
882 Buf = NewStrBufPlain(NULL, StrLength(Source));
883 StrBuf_RFC822_to_Utf8(Buf,
885 (WCC!=NULL)? WCC->DefaultCharset : NULL,
887 StrEscAppend(Target, Buf, NULL, 0, 0);
891 StrEscAppend(Target, Source, NULL, 0, 0);
894 StrECMAEscAppend(Target, Source, NULL);
897 StrBufAppendBuf(Target, Source, 0);
902 void PutNewToken(WCTemplate *Template, WCTemplateToken *NewToken)
904 if (Template->nTokensUsed + 1 >= Template->TokenSpace) {
905 if (Template->TokenSpace <= 0) {
906 Template->Tokens = (WCTemplateToken**)malloc(
907 sizeof(WCTemplateToken*) * 10);
908 Template->TokenSpace = 10;
911 WCTemplateToken **NewTokens;
912 NewTokens= (WCTemplateToken**)malloc(
913 sizeof(WCTemplateToken*) *
914 Template->TokenSpace * 2);
915 memcpy(NewTokens, Template->Tokens,
916 sizeof(WCTemplateToken*) * Template->nTokensUsed);
917 free(Template->Tokens);
918 Template->TokenSpace *= 2;
919 Template->Tokens = NewTokens;
922 Template->Tokens[(Template->nTokensUsed)++] = NewToken;
925 TemplateParam *GetNextParameter(StrBuf *Buf, const char **pCh, const char *pe, WCTemplateToken *Tokens, WCTemplate *pTmpl)
927 const char *pch = *pCh;
928 const char *pchs, *pche;
929 TemplateParam *Parm = (TemplateParam *) malloc(sizeof(TemplateParam));
933 Parm->Type = TYPE_STR;
935 /* Skip leading whitespaces */
936 while ((*pch == ' ' )||
939 (*pch == '\n')) pch ++;
942 Parm->Type = TYPE_PREFSTR;
949 else if (*pch == ';') {
950 Parm->Type = TYPE_PREFINT;
957 else if (*pch == '_') {
958 Parm->Type = TYPE_GETTEXT;
965 else if (*pch == 'B') {
966 Parm->Type = TYPE_BSTR;
973 else if (*pch == '=') {
974 Parm->Type = TYPE_SUBTEMPLATE;
985 else if (*pch == '\'')
992 ( (pch > pchs) && (*(pch - 1) == '\\'))
998 lprintf(1, "Error (in '%s' line %ld); "
999 "evaluating template param [%s] in Token [%s]\n",
1000 ChrPtr(pTmpl->FileName),
1002 ChrPtr(Tokens->FlatToken),
1009 StrBufPeek(Buf, pch, -1, '\0');
1010 if (LoadTemplates > 1) {
1011 lprintf(1, "DBG: got param [%s] %ld %ld\n",
1012 pchs, pche - pchs, strlen(pchs));
1015 Parm->len = pche - pchs;
1016 pch ++; /* move after trailing quote */
1017 if (ParamBrace && (*pch == ')')) {
1024 Parm->Type = TYPE_LONG;
1026 while ((pch <= pe) &&
1032 if (pch - pchs > 1){
1033 StrBufPeek(Buf, pch, -1, '\0');
1034 Parm->lvalue = atol(pchs);
1041 lprintf(1, "Error (in '%s' line %ld); "
1042 "evaluating long template param [%s] in Token [%s]\n",
1043 ChrPtr(pTmpl->FileName),
1045 ChrPtr(Tokens->FlatToken),
1052 while ((*pch == ' ' )||
1056 (*pch == '\n')) pch ++;
1062 WCTemplateToken *NewTemplateSubstitute(StrBuf *Buf,
1064 const char *pTmplStart,
1065 const char *pTmplEnd,
1071 TemplateParam *Param;
1072 WCTemplateToken *NewToken = (WCTemplateToken*)malloc(sizeof(WCTemplateToken));
1073 WCTemplputParams TP;
1075 TP.Tokens = NewToken;
1076 NewToken->FileName = pTmpl->FileName; /* to print meaningfull log messages... */
1077 NewToken->Flags = 0;
1078 NewToken->Line = Line + 1;
1079 NewToken->pTokenStart = pTmplStart;
1080 NewToken->TokenStart = pTmplStart - pStart;
1081 NewToken->TokenEnd = (pTmplEnd - pStart) - NewToken->TokenStart;
1082 NewToken->pTokenEnd = pTmplEnd;
1083 NewToken->NameEnd = NewToken->TokenEnd - 2;
1084 NewToken->PreEval = NULL;
1085 NewToken->FlatToken = NewStrBufPlain(pTmplStart + 2, pTmplEnd - pTmplStart - 2);
1087 StrBufPeek(Buf, pTmplStart, + 1, '\0');
1088 StrBufPeek(Buf, pTmplEnd, -1, '\0');
1089 pch = NewToken->pName = pTmplStart + 2;
1091 NewToken->HaveParameters = 0;;
1092 NewToken->nParameters = 0;
1094 while (pch < pTmplEnd - 1) {
1096 StrBufPeek(Buf, pch, -1, '\0');
1097 NewToken->NameEnd = pch - NewToken->pName;
1099 if (*(pTmplEnd - 1) != ')') {
1101 NULL, "Parseerror", ERR_NAME, &TP,
1102 "Warning, Non welformed Token; missing right parenthesis");
1104 while (pch < pTmplEnd - 1) {
1105 Param = GetNextParameter(Buf, &pch, pTmplEnd - 1, NewToken, pTmpl);
1106 if (Param != NULL) {
1107 NewToken->HaveParameters = 1;
1108 if (NewToken->nParameters > MAXPARAM) {
1110 NULL, "Parseerror", ERR_NAME, &TP,
1111 "only [%d] Params allowed in Tokens",
1115 FreeToken(&NewToken);
1118 NewToken->Params[NewToken->nParameters++] = Param;
1122 if((NewToken->NameEnd == 1) &&
1123 (NewToken->HaveParameters == 1))
1126 if (*(NewToken->pName) == '_')
1127 NewToken->Flags = SV_GETTEXT;
1128 else if (*(NewToken->pName) == '=')
1129 NewToken->Flags = SV_SUBTEMPL;
1130 else if (*(NewToken->pName) == '%')
1131 NewToken->Flags = SV_CUST_STR_CONDITIONAL;
1132 else if (*(NewToken->pName) == '?')
1133 NewToken->Flags = SV_CONDITIONAL;
1134 else if (*(NewToken->pName) == '!')
1135 NewToken->Flags = SV_NEG_CONDITIONAL;
1141 switch (NewToken->Flags) {
1143 /* If we're able to find out more about the token, do it now while its fresh. */
1144 if (GetHash(GlobalNS, NewToken->pName, NewToken->NameEnd, &vVar)) {
1145 HashHandler *Handler;
1146 Handler = (HashHandler*) vVar;
1147 if ((NewToken->nParameters < Handler->Filter.nMinArgs) ||
1148 (NewToken->nParameters > Handler->Filter.nMaxArgs)) {
1150 NULL, "Token", ERR_NAME, &TP,
1151 "doesn't work with %d params",
1152 NewToken->nParameters);
1156 NewToken->PreEval = Handler;
1157 NewToken->Flags = SV_PREEVALUATED;
1162 if (NewToken->nParameters !=1) {
1164 NULL, "Gettext", ERR_NAME, &TP,
1165 "requires exactly 1 parameter, you gave %d params",
1166 NewToken->nParameters);
1167 NewToken->Flags = 0;
1172 if (NewToken->nParameters != 1) {
1174 NULL, "Subtemplates", ERR_NAME, &TP,
1175 "require exactly 1 parameter, you gave %d params",
1176 NewToken->nParameters);
1180 case SV_CUST_STR_CONDITIONAL:
1181 case SV_CONDITIONAL:
1182 case SV_NEG_CONDITIONAL:
1183 if (NewToken->nParameters <2) {
1185 NULL, "Conditional", ERR_NAME, &TP,
1186 "require at least 2 parameters, you gave %d params",
1187 NewToken->nParameters);
1188 NewToken->Flags = 0;
1191 if (NewToken->Params[1]->lvalue == 0) {
1193 NULL, "Conditional", ERR_NAME, &TP,
1194 "Conditional ID (Parameter 1) mustn't be 0!");
1195 NewToken->Flags = 0;
1198 if (!GetHash(Conditionals,
1199 NewToken->Params[0]->Start,
1200 NewToken->Params[0]->len,
1203 if ((NewToken->Params[0]->len == 1) &&
1204 (NewToken->Params[0]->Start[0] == 'X'))
1207 NULL, "Conditional", ERR_NAME, &TP,
1210 NewToken->Error = NewStrBuf();
1213 "<pre>\nConditional [%s] (in '%s' line %ld); Not found!\n[%s]\n</pre>\n",
1214 NewToken->Params[0]->Start,
1215 ChrPtr(pTmpl->FileName),
1217 ChrPtr(NewToken->FlatToken));
1221 NewToken->PreEval = vVar;
1233 * \brief Display a variable-substituted template
1234 * \param templatename template file to load
1236 void *prepare_template(StrBuf *filename, StrBuf *Key, HashList *PutThere)
1238 WCTemplate *NewTemplate;
1239 NewTemplate = (WCTemplate *) malloc(sizeof(WCTemplate));
1240 NewTemplate->Data = NULL;
1241 NewTemplate->FileName = NewStrBufDup(filename);
1242 NewTemplate->nTokensUsed = 0;
1243 NewTemplate->TokenSpace = 0;
1244 NewTemplate->Tokens = NULL;
1246 Put(PutThere, ChrPtr(Key), StrLength(Key), NewTemplate, FreeWCTemplate);
1251 * \brief Display a variable-substituted template
1252 * \param templatename template file to load
1254 void *load_template(StrBuf *filename, StrBuf *Key, HashList *PutThere)
1257 struct stat statbuf;
1258 const char *pS, *pE, *pch, *Err;
1261 WCTemplate *NewTemplate;
1263 fd = open(ChrPtr(filename), O_RDONLY);
1265 lprintf(1, "ERROR: could not open template '%s' - %s\n",
1266 ChrPtr(filename), strerror(errno));
1270 if (fstat(fd, &statbuf) == -1) {
1271 lprintf(1, "ERROR: could not stat template '%s' - %s\n",
1272 ChrPtr(filename), strerror(errno));
1276 NewTemplate = (WCTemplate *) malloc(sizeof(WCTemplate));
1277 NewTemplate->Data = NewStrBufPlain(NULL, statbuf.st_size);
1278 NewTemplate->FileName = NewStrBufDup(filename);
1279 NewTemplate->nTokensUsed = 0;
1280 NewTemplate->TokenSpace = 0;
1281 NewTemplate->Tokens = NULL;
1282 if (StrBufReadBLOB(NewTemplate->Data, &fd, 1, statbuf.st_size, &Err) < 0) {
1284 FreeWCTemplate(NewTemplate);
1285 lprintf(1, "ERROR: reading template '%s' - %s<br />\n",
1286 ChrPtr(filename), strerror(errno));
1292 pS = pch = ChrPtr(NewTemplate->Data);
1293 pE = pS + StrLength(NewTemplate->Data);
1295 const char *pts, *pte;
1297 int InDoubleQuotes = 0;
1299 /** Find one <? > */
1301 for (; pch < pE; pch ++) {
1302 if ((*pch=='<')&&(*(pch + 1)=='?'))
1304 if (*pch=='\n') Line ++;
1310 /** Found one? parse it. */
1311 for (; pch <= pE - 1; pch ++) {
1313 InDoubleQuotes = ! InDoubleQuotes;
1314 else if (*pch == '\'')
1315 InQuotes = ! InQuotes;
1316 else if ((!InQuotes && !InDoubleQuotes) &&
1317 ((*pch!='\\')&&(*(pch + 1)=='>'))) {
1325 PutNewToken(NewTemplate,
1326 NewTemplateSubstitute(NewTemplate->Data, pS, pts, pte, Line, NewTemplate));
1329 if (LoadTemplates == 0)
1330 Put(PutThere, ChrPtr(Key), StrLength(Key), NewTemplate, FreeWCTemplate);
1335 const char* PrintTemplate(void *vSubst)
1337 WCTemplate *Tmpl = vSubst;
1339 return ChrPtr(Tmpl->FileName);
1343 int LoadTemplateDir(const char *DirName, HashList *wireless, HashList *big)
1348 DIR *filedir = NULL;
1349 struct dirent *filedir_entry;
1355 StrBufPrintf(Dir, "%s/t", DirName);
1356 filedir = opendir (ChrPtr(Dir));
1357 if (filedir == NULL) {
1362 FileName = NewStrBuf();
1364 while ((filedir_entry = readdir(filedir)))
1368 #ifdef _DIRENT_HAVE_D_NAMELEN
1369 d_namelen = filedir_entry->d_namelen;
1371 d_namelen = strlen(filedir_entry->d_name);
1373 d_without_ext = d_namelen;
1374 while ((d_without_ext > 0) && (filedir_entry->d_name[d_without_ext] != '.'))
1376 if ((d_without_ext == 0) || (d_namelen < 3))
1378 if ((d_namelen > 1) && filedir_entry->d_name[d_namelen - 1] == '~')
1379 continue; /* Ignore backup files... */
1381 IsMobile = (strstr(filedir_entry->d_name, ".m.html")!= NULL);
1382 PStart = filedir_entry->d_name;
1383 StrBufPrintf(FileName, "%s/%s", ChrPtr(Dir), filedir_entry->d_name);
1384 MinorPtr = strchr(filedir_entry->d_name, '.');
1385 if (MinorPtr != NULL)
1387 StrBufPlain(Tag, filedir_entry->d_name, MinorPtr - filedir_entry->d_name);
1389 if (LoadTemplates > 1)
1390 lprintf(1, "%s %d %s\n",ChrPtr(FileName), IsMobile, ChrPtr(Tag));
1391 if (LoadTemplates == 0)
1392 load_template(FileName, Tag, (IsMobile)?wireless:big);
1394 prepare_template(FileName, Tag, (IsMobile)?wireless:big);
1397 FreeStrBuf(&FileName);
1403 void InitTemplateCache(void)
1405 LoadTemplateDir(static_dirs[0],
1406 WirelessTemplateCache,
1408 LoadTemplateDir(static_dirs[1],
1409 WirelessLocalTemplateCache,
1410 LocalTemplateCache);
1415 /*-----------------------------------------------------------------------------
1416 * Filling & processing Templates
1419 * \brief executes one token
1420 * \param Target buffer to append to
1421 * \param Token da to process.
1422 * \param Template we're iterating
1423 * \param Context Contextpoointer to pass in
1424 * \param state are we in conditional state?
1425 * \param ContextType what type of information does context giv us?
1427 int EvaluateToken(StrBuf *Target, int state, WCTemplputParams *TP)
1429 const char *AppendMe;
1431 HashHandler *Handler;
1434 /* much output, since pName is not terminated...
1435 lprintf(1,"Doing token: %s\n",Token->pName);
1438 switch (TP->Tokens->Flags) {
1440 TmplGettext(Target, TP);
1442 case SV_CONDITIONAL: /** Forward conditional evaluation */
1443 return EvaluateConditional(Target, 1, state, TP);
1445 case SV_NEG_CONDITIONAL: /** Reverse conditional evaluation */
1446 return EvaluateConditional(Target, 0, state, TP);
1448 case SV_CUST_STR_CONDITIONAL: /** Conditional put custom strings from params */
1449 if (TP->Tokens->nParameters >= 6) {
1450 if (EvaluateConditional(Target, 0, state, TP)) {
1451 GetTemplateTokenString(TP, 5, &AppendMe, &AppendMeLen);
1452 StrBufAppendBufPlain(Target,
1458 GetTemplateTokenString(TP, 4, &AppendMe, &AppendMeLen);
1459 StrBufAppendBufPlain(Target,
1467 Target, "Conditional", ERR_NAME, TP,
1468 "needs at least 6 Params!");
1472 if (TP->Tokens->nParameters == 1)
1473 DoTemplate(TKEY(0), Target, TP);
1475 case SV_PREEVALUATED:
1476 Handler = (HashHandler*) TP->Tokens->PreEval;
1477 if (!CheckContext(Target, &Handler->Filter, TP, "Token")) {
1480 Handler->HandlerFunc(Target, TP);
1483 if (GetHash(GlobalNS, TP->Tokens->pName, TP->Tokens->NameEnd, &vVar)) {
1484 Handler = (HashHandler*) vVar;
1485 if (!CheckContext(Target, &Handler->Filter, TP, "Token")) {
1489 Handler->HandlerFunc(Target, TP);
1493 print_value_of(Target, TP);
1501 void ProcessTemplate(WCTemplate *Tmpl, StrBuf *Target, WCTemplputParams *CallingTP)
1503 WCTemplate *pTmpl = Tmpl;
1506 const char *pData, *pS;
1508 WCTemplputParams TP;
1510 memcpy(&TP.Filter, &CallingTP->Filter, sizeof(ContextFilter));
1512 TP.Context = CallingTP->Context;
1513 TP.ControlContext = CallingTP->ControlContext;
1515 if (LoadTemplates != 0) {
1516 if (LoadTemplates > 1)
1517 lprintf(1, "DBG: ----- loading: [%s] ------ \n",
1518 ChrPtr(Tmpl->FileName));
1520 pTmpl = load_template(Tmpl->FileName, NULL, NULL);
1524 "<pre>\nError loading Template [%s]\n See Logfile for details\n</pre>\n",
1525 ChrPtr(Tmpl->FileName));
1531 pS = pData = ChrPtr(pTmpl->Data);
1532 len = StrLength(pTmpl->Data);
1536 if (i >= pTmpl->nTokensUsed) {
1537 StrBufAppendBufPlain(Target,
1539 len - (pData - pS), 0);
1543 StrBufAppendBufPlain(
1545 pTmpl->Tokens[i]->pTokenStart - pData, 0);
1546 TP.Tokens = pTmpl->Tokens[i];
1547 TP.nArgs = pTmpl->Tokens[i]->nParameters;
1548 state = EvaluateToken(Target, state, &TP);
1550 while ((state != 0) && (i+1 < pTmpl->nTokensUsed)) {
1551 /* condition told us to skip till its end condition */
1553 TP.Tokens = pTmpl->Tokens[i];
1554 TP.nArgs = pTmpl->Tokens[i]->nParameters;
1555 if ((pTmpl->Tokens[i]->Flags == SV_CONDITIONAL) ||
1556 (pTmpl->Tokens[i]->Flags == SV_NEG_CONDITIONAL)) {
1557 if (state == EvaluateConditional(
1559 pTmpl->Tokens[i]->Flags,
1565 pData = pTmpl->Tokens[i++]->pTokenEnd + 1;
1566 if (i > pTmpl->nTokensUsed)
1570 if (LoadTemplates != 0) {
1571 FreeWCTemplate(pTmpl);
1576 * \brief Display a variable-substituted template
1577 * \param templatename template file to load
1579 void DoTemplate(const char *templatename, long len, StrBuf *Target, WCTemplputParams *TP)
1581 WCTemplputParams LocalTP;
1583 HashList *StaticLocal;
1589 memset(&LocalTP, 0, sizeof(WCTemplputParams));
1593 if (WC->is_mobile) {
1594 Static = WirelessTemplateCache;
1595 StaticLocal = WirelessLocalTemplateCache;
1598 Static = TemplateCache;
1599 StaticLocal = LocalTemplateCache;
1604 lprintf (1, "Can't to load a template with empty name!\n");
1605 StrBufAppendPrintf(Target, "<pre>\nCan't to load a template with empty name!\n</pre>");
1609 if (!GetHash(StaticLocal, templatename, len, &vTmpl) &&
1610 !GetHash(Static, templatename, len, &vTmpl)) {
1611 lprintf (1, "didn't find Template [%s] %ld %ld\n", templatename, len , (long)strlen(templatename));
1612 StrBufAppendPrintf(Target, "<pre>\ndidn't find Template [%s] %ld %ld\n</pre>",
1614 (long)strlen(templatename));
1616 dbg_PrintHash(Static, PrintTemplate, NULL);
1617 PrintHash(Static, VarPrintTransition, PrintTemplate);
1623 ProcessTemplate(vTmpl, Target, TP);
1626 /*-----------------------------------------------------------------------------
1629 typedef struct _HashIterator {
1630 HashList *StaticList;
1631 int AdditionalParams;
1633 int XPectContextType;
1635 RetrieveHashlistFunc GetHash;
1636 HashDestructorFunc Destructor;
1637 SubTemplFunc DoSubTemplate;
1640 void RegisterITERATOR(const char *Name, long len,
1641 int AdditionalParams,
1642 HashList *StaticList,
1643 RetrieveHashlistFunc GetHash,
1644 SubTemplFunc DoSubTempl,
1645 HashDestructorFunc Destructor,
1647 int XPectContextType,
1650 HashIterator *It = (HashIterator*)malloc(sizeof(HashIterator));
1651 It->StaticList = StaticList;
1652 It->AdditionalParams = AdditionalParams;
1653 It->GetHash = GetHash;
1654 It->DoSubTemplate = DoSubTempl;
1655 It->Destructor = Destructor;
1656 It->ContextType = ContextType;
1657 It->XPectContextType = XPectContextType;
1659 Put(Iterators, Name, len, It, NULL);
1662 /* typedef struct _iteratestruct {
1671 void tmpl_iterate_subtmpl(StrBuf *Target, WCTemplputParams *TP)
1677 SortStruct *SortBy = NULL;
1679 int DetectGroupChange = 0;
1682 void *vLastContext = NULL;
1684 WCTemplputParams SubTP;
1685 IterateStruct Status;
1687 memset(&Status, 0, sizeof(IterateStruct));
1688 memcpy (&SubTP, &TP, sizeof(WCTemplputParams));
1690 if (!GetHash(Iterators, TKEY(0), &vIt)) {
1692 Target, "Iterator", ERR_PARM1, TP, "Unknown!");
1696 It = (HashIterator*) vIt;
1698 if (TP->Tokens->nParameters < It->AdditionalParams + 2) {
1700 Target, "Iterator", ERR_PARM1, TP,
1701 "doesn't work with %d params",
1702 TP->Tokens->nParameters);
1706 if ((It->XPectContextType != CTX_NONE) &&
1707 (It->XPectContextType != TP->Filter.ContextType)) {
1709 Target, "Iterator", ERR_PARM1, TP,
1710 "requires context of type %d, have %d",
1711 It->XPectContextType,
1712 TP->Filter.ContextType);
1717 if (It->StaticList == NULL)
1718 List = It->GetHash(Target, TP);
1720 List = It->StaticList;
1722 DetectGroupChange = (It->Flags & IT_FLAG_DETECT_GROUPCHANGE) != 0;
1723 if (DetectGroupChange) {
1724 const StrBuf *BSort;
1725 DetectGroupChange = 0;
1726 if (havebstr("SortBy")) {
1727 BSort = sbstr("SortBy");
1728 if (GetHash(SortHash, SKEY(BSort), &vSortBy) &&
1729 (vSortBy != NULL)) {
1730 SortBy = (SortStruct*)vSortBy;
1731 /** Ok, its us, lets see in which direction we should sort... */
1732 if (havebstr("SortOrder")) {
1734 SortOrder = LBSTR("SortOrder");
1736 DetectGroupChange = 1;
1741 nMembersUsed = GetCount(List);
1742 SubBuf = NewStrBuf();
1743 SubTP.Filter.ContextType = It->ContextType;
1744 SubTP.Filter.ControlContextType = CTX_ITERATE;
1745 SubTP.ControlContext = &Status;
1746 it = GetNewHashPos(List, 0);
1747 while (GetNextHashPos(List, it, &Status.KeyLen, &Status.Key, &vContext)) {
1748 if (DetectGroupChange && Status.n > 0) {
1749 Status.GroupChange = (SortBy->GroupChange(vContext, vLastContext))? 1:0;
1751 Status.LastN = ++Status.LastN == nMembersUsed;
1752 SubTP.Context = vContext;
1753 if (It->DoSubTemplate != NULL)
1754 It->DoSubTemplate(SubBuf, &SubTP);
1755 DoTemplate(TKEY(1), SubBuf, &SubTP);
1757 StrBufAppendBuf(Target, SubBuf, 0);
1758 FlushStrBuf(SubBuf);
1759 Status.oddeven = ! Status.oddeven;
1760 vLastContext = vContext;
1762 FreeStrBuf(&SubBuf);
1764 if (It->Destructor != NULL)
1765 It->Destructor(&List);
1769 int conditional_ITERATE_ISGROUPCHANGE(StrBuf *Target, WCTemplputParams *TP)
1771 IterateStruct *Ctx = CCTX;
1772 return Ctx->GroupChange;
1775 void tmplput_ITERATE_ODDEVEN(StrBuf *Target, WCTemplputParams *TP)
1777 IterateStruct *Ctx = CCTX;
1779 StrBufAppendBufPlain(Target, HKEY("odd"), 0);
1781 StrBufAppendBufPlain(Target, HKEY("even"), 0);
1785 void tmplput_ITERATE_KEY(StrBuf *Target, WCTemplputParams *TP)
1787 IterateStruct *Ctx = CCTX;
1789 StrBufAppendBufPlain(Target, Ctx->Key, Ctx->KeyLen, 0);
1793 void tmplput_ITERATE_LASTN(StrBuf *Target, WCTemplputParams *TP)
1795 IterateStruct *Ctx = CCTX;
1796 StrBufAppendPrintf(Target, "%d", Ctx->n);
1799 int conditional_ITERATE_LASTN(StrBuf *Target, WCTemplputParams *TP)
1801 IterateStruct *Ctx = CCTX;
1807 /*-----------------------------------------------------------------------------
1810 int EvaluateConditional(StrBuf *Target, int Neg, int state, WCTemplputParams *TP)
1812 ConditionalStruct *Cond;
1814 if ((TP->Tokens->Params[0]->len == 1) &&
1815 (TP->Tokens->Params[0]->Start[0] == 'X'))
1816 return (state != 0)?TP->Tokens->Params[1]->lvalue:0;
1818 Cond = (ConditionalStruct *) TP->Tokens->PreEval;
1821 Target, "Conditional", ERR_PARM1, TP,
1826 if (!CheckContext(Target, &Cond->Filter, TP, "Conditional")) {
1830 if (Cond->CondF(Target, TP) == Neg)
1831 return TP->Tokens->Params[1]->lvalue;
1835 int ConditionalVar(StrBuf *Target, WCTemplputParams *TP)
1840 if (!GetHash(WC->vars, TKEY(2), &vsubst))
1842 subst = (wcsubst*) vsubst;
1844 switch(subst->wcs_type) {
1846 return (subst->wcs_function!=NULL);
1848 lprintf(1, " -> Server [%s]\n", subst->wcs_value);/* TODO */
1852 case WCS_STRBUF_REF:
1853 if (TP->Tokens->nParameters < 4)
1855 return (strcmp(TP->Tokens->Params[3]->Start, ChrPtr(subst->wcs_value)) == 0);
1857 if (TP->Tokens->nParameters < 4)
1858 return (subst->lvalue != 0);
1859 return (subst->lvalue == TP->Tokens->Params[3]->lvalue);
1861 lprintf(1," WARNING: invalid type: [%ld]!\n", subst->wcs_type);
1867 void RegisterConditional(const char *Name, long len,
1869 WCConditionalFunc CondF,
1870 int ContextRequired)
1872 ConditionalStruct *Cond = (ConditionalStruct*)malloc(sizeof(ConditionalStruct));
1873 Cond->PlainName = Name;
1874 Cond->Filter.nMaxArgs = nParams;
1875 Cond->Filter.nMinArgs = nParams;
1876 Cond->CondF = CondF;
1877 Cond->Filter.ContextType = ContextRequired;
1878 Cond->Filter.ControlContextType = CTX_NONE;
1879 Put(Conditionals, Name, len, Cond, NULL);
1882 void RegisterControlConditional(const char *Name, long len,
1884 WCConditionalFunc CondF,
1885 int ControlContextRequired)
1887 ConditionalStruct *Cond = (ConditionalStruct*)malloc(sizeof(ConditionalStruct));
1888 Cond->PlainName = Name;
1889 Cond->Filter.nMaxArgs = nParams;
1890 Cond->Filter.nMinArgs = nParams;
1891 Cond->CondF = CondF;
1892 Cond->Filter.ContextType = CTX_NONE;
1893 Cond->Filter.ControlContextType = ControlContextRequired;
1894 Put(Conditionals, Name, len, Cond, NULL);
1897 /*-----------------------------------------------------------------------------
1900 void tmplput_ContextString(StrBuf *Target, WCTemplputParams *TP)
1902 StrBufAppendTemplate(Target, TP, (StrBuf*)CTX, 0);
1904 int ConditionalContextStr(StrBuf *Target, WCTemplputParams *TP)
1906 StrBuf *TokenText = (StrBuf*) CTX;
1907 const char *CompareToken;
1910 GetTemplateTokenString(TP, 2, &CompareToken, &len);
1911 return strcmp(ChrPtr(TokenText), CompareToken) == 0;
1914 /*-----------------------------------------------------------------------------
1918 void tmpl_do_boxed(StrBuf *Target, WCTemplputParams *TP)
1920 WCTemplputParams SubTP;
1923 if (TP->Tokens->nParameters == 2) {
1924 if (TP->Tokens->Params[1]->Type == TYPE_STR) {
1925 Headline = NewStrBuf();
1926 DoTemplate(TKEY(1), Headline, TP);
1931 GetTemplateTokenString(TP,
1935 Headline = NewStrBufPlain(Ch, len);
1938 memcpy (&SubTP, TP, sizeof(WCTemplputParams));
1939 SubTP.Context = Headline;
1940 SubTP.Filter.ContextType = CTX_STRBUF;
1941 DoTemplate(HKEY("beginbox"), Target, &SubTP);
1942 DoTemplate(TKEY(0), Target, TP);
1943 DoTemplate(HKEY("endbox"), Target, TP);
1944 FreeStrBuf(&Headline);
1947 /*-----------------------------------------------------------------------------
1951 void tmpl_do_tabbed(StrBuf *Target, WCTemplputParams *TP)
1954 int i, ntabs, nTabs;
1956 nTabs = ntabs = TP->Tokens->nParameters / 2;
1957 TabNames = (StrBuf **) malloc(ntabs * sizeof(StrBuf*));
1959 for (i = 0; i < ntabs; i++) {
1960 if ((TP->Tokens->Params[i * 2]->Type == TYPE_STR) &&
1961 (TP->Tokens->Params[i * 2]->len > 0)) {
1962 TabNames[i] = NewStrBuf();
1963 DoTemplate(TKEY(i * 2), TabNames[i], TP);
1965 else if (TP->Tokens->Params[i * 2]->Type == TYPE_GETTEXT) {
1968 GetTemplateTokenString(TP,
1972 TabNames[i] = NewStrBufPlain(Ch, -1);
1975 /** A Tab without subject? we can't count that, add it as silent */
1980 StrTabbedDialog(Target, nTabs, TabNames);
1981 for (i = 0; i < ntabs; i++) {
1982 StrBeginTab(Target, i, nTabs);
1983 DoTemplate(TKEY(i * 2 + 1), Target, TP);
1984 StrEndTab(Target, i, nTabs);
1989 /*-----------------------------------------------------------------------------
1994 void RegisterSortFunc(const char *name, long len,
1995 const char *prepend, long preplen,
1996 CompareFunc Forward,
1997 CompareFunc Reverse,
1998 CompareFunc GroupChange,
2001 SortStruct *NewSort = (SortStruct*) malloc(sizeof(SortStruct));
2002 NewSort->Name = NewStrBufPlain(name, len);
2003 if (prepend != NULL)
2004 NewSort->PrefPrepend = NewStrBufPlain(prepend, preplen);
2006 NewSort->PrefPrepend = NULL;
2007 NewSort->Forward = Forward;
2008 NewSort->Reverse = Reverse;
2009 NewSort->GroupChange = GroupChange;
2010 NewSort->ContextType = ContextType;
2011 Put(SortHash, name, len, NewSort, DestroySortStruct);
2014 CompareFunc RetrieveSort(WCTemplputParams *TP,
2015 const char *OtherPrefix, long OtherPrefixLen,
2016 const char *Default, long ldefault, long DefaultDirection)
2019 const StrBuf *BSort = NULL;
2022 long SortOrder = -1;
2024 if (havebstr("SortBy")) {
2025 BSort = sbstr("SortBy");
2026 if (OtherPrefix == NULL) {
2027 set_room_pref("sort", NewStrBufDup(BSort), 0);
2030 set_X_PREFS(HKEY("sort"), OtherPrefix, OtherPrefixLen, NewStrBufDup(BSort), 0);
2033 else { /** Try to fallback to our remembered values... */
2034 if (OtherPrefix == NULL) {
2035 BSort = get_room_pref("sort");
2038 BSort = get_X_PREFS(HKEY("sort"), OtherPrefix, OtherPrefixLen);
2041 putbstr("SortBy", NewStrBufDup(BSort));
2045 BSort = Buf = NewStrBufPlain(Default, ldefault);
2046 putbstr("SortBy", Buf);
2050 if (!GetHash(SortHash, SKEY(BSort), &vSortBy) ||
2051 (vSortBy == NULL)) {
2053 if (!GetHash(SortHash, Default, ldefault, &vSortBy) ||
2054 (vSortBy == NULL)) {
2056 NULL, "Sorting", ERR_PARM1, TP,
2057 "Illegal default sort: [%s]", Default);
2061 SortBy = (SortStruct*)vSortBy;
2063 /** Ok, its us, lets see in which direction we should sort... */
2064 if (havebstr("SortOrder")) {
2065 SortOrder = LBSTR("SortOrder");
2067 else { /** Try to fallback to our remembered values... */
2069 if (SortBy->PrefPrepend == NULL) {
2070 Buf = get_room_pref("SortOrder");
2071 SortOrder = StrTol(Buf);
2074 BSort = get_X_PREFS(HKEY("SortOrder"), OtherPrefix, OtherPrefixLen);
2078 SortOrder = DefaultDirection;
2080 Buf = NewStrBufPlain(NULL, 64);
2081 StrBufPrintf(Buf, "%ld", SortOrder);
2082 putbstr("SortOrder", Buf);
2084 switch (SortOrder) {
2089 return SortBy->Forward;
2091 return SortBy->Reverse;
2103 ConstStr SortIcons[] = {
2104 {HKEY("static/sort_none.gif")},
2105 {HKEY("static/up_pointer.gif")},
2106 {HKEY("static/down_pointer.gif")},
2109 ConstStr SortNextOrder[] = {
2116 int GetSortMetric(WCTemplputParams *TP, SortStruct **Next, SortStruct **Param, long *SortOrder, int N)
2118 int bSortError = eNOT_SPECIFIED;
2119 const StrBuf *BSort;
2124 if (!GetHash(SortHash, TKEY(0), &vSort) ||
2126 return eNO_SUCH_SORT;
2127 *Param = (SortStruct*) vSort;
2130 if (havebstr("SortBy")) {
2131 BSort = sbstr("SortBy");
2132 bSortError = eINVALID_PARAM;
2133 if ((*Param)->PrefPrepend == NULL) {
2134 set_room_pref("sort", NewStrBufDup(BSort), 0);
2137 set_X_PREFS(HKEY("sort"), TKEY(N), NewStrBufDup(BSort), 0);
2140 else { /** Try to fallback to our remembered values... */
2141 if ((*Param)->PrefPrepend == NULL) {
2142 BSort = get_room_pref("sort");
2145 BSort = get_X_PREFS(HKEY("sort"), TKEY(N));
2149 if (!GetHash(SortHash, SKEY(BSort), &vSort) ||
2153 *Next = (SortStruct*) vSort;
2155 /** Ok, its us, lets see in which direction we should sort... */
2156 if (havebstr("SortOrder")) {
2157 *SortOrder = LBSTR("SortOrder");
2159 else { /** Try to fallback to our remembered values... */
2160 if ((*Param)->PrefPrepend == NULL) {
2161 *SortOrder = StrTol(get_room_pref("SortOrder"));
2164 *SortOrder = StrTol(get_X_PREFS(HKEY("SortOrder"), TKEY(N)));
2174 void tmplput_SORT_ICON(StrBuf *Target, WCTemplputParams *TP)
2179 const ConstStr *SortIcon;
2181 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2184 Target, "Sorter", ERR_PARM1, TP,
2185 " Sorter [%s] unknown!",
2186 TP->Tokens->Params[0]->Start);
2188 case eINVALID_PARAM:
2189 LogTemplateError(NULL, "Sorter", ERR_PARM1, TP,
2190 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2192 case eNOT_SPECIFIED:
2194 if (Next == Param) {
2195 SortIcon = &SortIcons[SortOrder];
2197 else { /** Not Us... */
2198 SortIcon = &SortIcons[0];
2200 StrBufAppendBufPlain(Target, SortIcon->Key, SortIcon->len, 0);
2204 void tmplput_SORT_NEXT(StrBuf *Target, WCTemplputParams *TP)
2210 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2213 Target, "Sorter", ERR_PARM1, TP,
2214 " Sorter [%s] unknown!",
2215 TP->Tokens->Params[0]->Start);
2217 case eINVALID_PARAM:
2219 NULL, "Sorter", ERR_PARM1, TP,
2220 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2222 case eNOT_SPECIFIED:
2224 StrBufAppendBuf(Target, Param->Name, 0);
2229 void tmplput_SORT_ORDER(StrBuf *Target, WCTemplputParams *TP)
2232 const ConstStr *SortOrderStr;
2236 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2239 Target, "Sorter", ERR_PARM1, TP,
2240 " Sorter [%s] unknown!",
2241 TP->Tokens->Params[0]->Start);
2243 case eINVALID_PARAM:
2245 NULL, "Sorter", ERR_PARM1, TP,
2246 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2248 case eNOT_SPECIFIED:
2250 if (Next == Param) {
2251 SortOrderStr = &SortNextOrder[SortOrder];
2253 else { /** Not Us... */
2254 SortOrderStr = &SortNextOrder[0];
2256 StrBufAppendBufPlain(Target, SortOrderStr->Key, SortOrderStr->len, 0);
2261 void tmplput_long_vector(StrBuf *Target, WCTemplputParams *TP)
2263 long *LongVector = (long*) CTX;
2265 if ((TP->Tokens->Params[0]->Type == TYPE_LONG) &&
2266 (TP->Tokens->Params[0]->lvalue <= LongVector[0]))
2268 StrBufAppendPrintf(Target, "%ld", LongVector[TP->Tokens->Params[0]->lvalue]);
2272 if (TP->Tokens->Params[0]->Type != TYPE_LONG) {
2274 Target, "Longvector", ERR_NAME, TP,
2275 "needs a numerical Parameter!");
2279 Target, "LongVector", ERR_PARM1, TP,
2280 "doesn't have %ld Parameters, its just the size of %ld!",
2281 TP->Tokens->Params[0]->lvalue,
2287 void dbg_print_longvector(long *LongVector)
2289 StrBuf *Buf = NewStrBufPlain(HKEY("Longvector: ["));
2290 int nItems = LongVector[0];
2293 for (i = 0; i < nItems; i++) {
2295 StrBufAppendPrintf(Buf, "%d: %ld | ", i, LongVector[i]);
2297 StrBufAppendPrintf(Buf, "%d: %ld]\n", i, LongVector[i]);
2300 lprintf(1, ChrPtr(Buf));
2304 int ConditionalLongVector(StrBuf *Target, WCTemplputParams *TP)
2306 long *LongVector = (long*) CTX;
2308 if ((TP->Tokens->Params[2]->Type == TYPE_LONG) &&
2309 (TP->Tokens->Params[2]->lvalue <= LongVector[0])&&
2310 (TP->Tokens->Params[3]->Type == TYPE_LONG) &&
2311 (TP->Tokens->Params[3]->lvalue <= LongVector[0]))
2313 return LongVector[TP->Tokens->Params[2]->lvalue] ==
2314 LongVector[TP->Tokens->Params[3]->lvalue];
2318 if ((TP->Tokens->Params[2]->Type == TYPE_LONG) ||
2319 (TP->Tokens->Params[2]->Type == TYPE_LONG)) {
2321 Target, "ConditionalLongvector", ERR_PARM1, TP,
2322 "needs two long Parameter!");
2326 Target, "Longvector", ERR_PARM1, TP,
2327 "doesn't have %ld / %ld Parameters, its just the size of %ld!",
2328 TP->Tokens->Params[2]->lvalue,
2329 TP->Tokens->Params[3]->lvalue,
2340 memset(&NoCtx, 0, sizeof(WCTemplputParams));
2341 RegisterNamespace("SORT:ICON", 1, 2, tmplput_SORT_ICON, CTX_NONE);
2342 RegisterNamespace("SORT:ORDER", 1, 2, tmplput_SORT_ORDER, CTX_NONE);
2343 RegisterNamespace("SORT:NEXT", 1, 2, tmplput_SORT_NEXT, CTX_NONE);
2344 RegisterNamespace("CONTEXTSTR", 0, 1, tmplput_ContextString, CTX_STRBUF);
2345 RegisterNamespace("ITERATE", 2, 100, tmpl_iterate_subtmpl, CTX_NONE);
2346 RegisterNamespace("DOBOXED", 1, 2, tmpl_do_boxed, CTX_NONE);
2347 RegisterNamespace("DOTABBED", 2, 100, tmpl_do_tabbed, CTX_NONE);
2348 RegisterNamespace("LONGVECTOR", 1, 1, tmplput_long_vector, CTX_LONGVECTOR);
2349 RegisterConditional(HKEY("COND:SUBST"), 3, ConditionalVar, CTX_NONE);
2350 RegisterConditional(HKEY("COND:CONTEXTSTR"), 3, ConditionalContextStr, CTX_STRBUF);
2351 RegisterConditional(HKEY("COND:LONGVECTOR"), 4, ConditionalLongVector, CTX_LONGVECTOR);
2353 RegisterControlConditional(HKEY("COND:ITERATE:ISGROUPCHANGE"), 2,
2354 conditional_ITERATE_ISGROUPCHANGE,
2356 RegisterControlConditional(HKEY("COND:ITERATE:LASTN"), 2,
2357 conditional_ITERATE_LASTN,
2359 RegisterControlNS(HKEY("ITERATE:ODDEVEN"), 0, 0, tmplput_ITERATE_ODDEVEN, CTX_ITERATE);
2360 RegisterControlNS(HKEY("ITERATE:KEY"), 0, 0, tmplput_ITERATE_KEY, CTX_ITERATE);
2361 RegisterControlNS(HKEY("ITERATE:N"), 0, 0, tmplput_ITERATE_LASTN, CTX_ITERATE);