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));
175 StrBufPrintf(Info, "%s [%s] %s; [%s]",
179 ChrPtr(TP->Tokens->FlatToken));
182 SerializeJson(Header, WildFireException(SKEY(TP->Tokens->FileName),
187 SerializeJson(Header, WildFireMessage(SKEY(TP->Tokens->FileName),
192 WildFireSerializePayload(Header, WCC->HBuf, &WCC->nWildfireHeaders, NULL);
199 "<pre>\n%s: %s\n</pre>\n",
203 StrBufPrintf(Info, "%s [%s] %s; [%s]",
207 ChrPtr(TP->Tokens->FlatToken));
208 SerializeJson(Header, WildFireException(HKEY(__FILE__), __LINE__, Info, 1), 1);
209 WildFireSerializePayload(Header, WCC->HBuf, &WCC->nWildfireHeaders, NULL);
215 if (dbg_bactrace_template_errors)
221 void RegisterNS(const char *NSName,
225 WCHandlerFunc HandlerFunc,
228 HashHandler *NewHandler;
230 NewHandler = (HashHandler*) malloc(sizeof(HashHandler));
231 NewHandler->Filter.nMinArgs = nMinArgs;
232 NewHandler->Filter.nMaxArgs = nMaxArgs;
233 NewHandler->Filter.ContextType = ContextRequired;
234 NewHandler->Filter.ControlContextType = CTX_NONE;
236 NewHandler->HandlerFunc = HandlerFunc;
237 Put(GlobalNS, NSName, len, NewHandler, NULL);
240 void RegisterControlNS(const char *NSName,
244 WCHandlerFunc HandlerFunc,
245 int ControlContextRequired)
247 HashHandler *NewHandler;
249 NewHandler = (HashHandler*) malloc(sizeof(HashHandler));
250 NewHandler->Filter.nMinArgs = nMinArgs;
251 NewHandler->Filter.nMaxArgs = nMaxArgs;
252 NewHandler->Filter.ContextType = CTX_NONE;
253 NewHandler->Filter.ControlContextType = ControlContextRequired;
254 NewHandler->HandlerFunc = HandlerFunc;
255 Put(GlobalNS, NSName, len, NewHandler, NULL);
260 int CheckContext(StrBuf *Target, ContextFilter *Need, WCTemplputParams *TP, const char *ErrType)
262 if ((Need->ContextType != CTX_NONE) &&
263 (Need->ContextType != TP->Filter.ContextType)) {
265 Target, ErrType, ERR_PARM1, TP,
266 " WARNING: requires Context: [%s], have [%s]!",
267 ContextName(Need->ContextType),
268 ContextName(TP->Filter.ContextType));
272 if ((Need->ControlContextType != CTX_NONE) &&
273 (Need->ControlContextType != TP->Filter.ControlContextType)) {
275 Target, ErrType, ERR_PARM1, TP,
276 " WARNING: requires Control Context: [%s], have [%s]!",
277 ContextName(Need->ControlContextType),
278 ContextName(TP->Filter.ControlContextType));
282 if (TP->Tokens->nParameters < Need->nMinArgs) {
283 LogTemplateError(Target, ErrType, ERR_NAME, TP,
284 "needs at least %ld params, have %ld",
286 TP->Tokens->nParameters);
290 else if (TP->Tokens->nParameters > Need->nMaxArgs) {
291 LogTemplateError(Target, ErrType, ERR_NAME, TP,
292 "just needs %ld params, you gave %ld",
294 TP->Tokens->nParameters);
302 void FreeToken(WCTemplateToken **Token)
305 FreeStrBuf(&(*Token)->FlatToken);
306 if ((*Token)->HaveParameters)
307 for (i = 0; i < (*Token)->nParameters; i++)
308 free((*Token)->Params[i]);
315 void FreeWCTemplate(void *vFreeMe)
318 WCTemplate *FreeMe = (WCTemplate*)vFreeMe;
320 if (FreeMe->TokenSpace > 0) {
321 for (i = 0; i < FreeMe->nTokensUsed; i ++) {
322 FreeToken(&FreeMe->Tokens[i]);
324 free(FreeMe->Tokens);
326 FreeStrBuf(&FreeMe->FileName);
327 FreeStrBuf(&FreeMe->Data);
333 * \brief debugging function to print array to log
335 void VarPrintTransition(void *vVar1, void *vVar2, int odd){}
337 * \brief debugging function to print array to log
339 void VarPrintEntry(const char *Key, void *vSubst, int odd)
342 lprintf(1,"Subst[%s] : ", Key);
343 ptr = (wcsubst*) vSubst;
345 switch(ptr->wcs_type) {
347 lprintf(1, " -> %s\n", ChrPtr(ptr->wcs_value));
350 lprintf(1, " -> Server [%s]\n", ChrPtr(ptr->wcs_value));
353 lprintf(1, " -> function at [%0xd]\n", ptr->wcs_function);
356 lprintf(1," WARNING: invalid type: [%ld]!\n", ptr->wcs_type);
363 * \brief Clear out the list of substitution variables local to this session
365 void clear_substs(wcsession *wc) {
367 if (wc->vars != NULL) {
368 DeleteHash(&wc->vars);
373 * \brief Clear out the list of substitution variables local to this session
375 void clear_local_substs(void) {
394 void FlushPayload(wcsubst *ptr, int reusestrbuf, int type)
396 int NeedNew = NeedNewBuf(type);
397 switch(ptr->wcs_type) {
401 if (reusestrbuf && NeedNew) {
402 FlushStrBuf(ptr->wcs_value);
406 FreeStrBuf(&ptr->wcs_value);
407 ptr->wcs_value = NULL;
411 ptr->wcs_function = NULL;
412 if (reusestrbuf && NeedNew)
413 ptr->wcs_value = NewStrBuf();
416 ptr->wcs_value = NULL;
417 if (reusestrbuf && NeedNew)
418 ptr->wcs_value = NewStrBuf();
422 if (reusestrbuf && NeedNew)
423 ptr->wcs_value = NewStrBuf();
426 if (reusestrbuf && NeedNew)
427 ptr->wcs_value = NewStrBuf();
434 * \brief destructor; kill one entry.
436 void deletevar(void *data)
438 wcsubst *ptr = (wcsubst*)data;
439 FlushPayload(ptr, 0, ptr->wcs_type);
444 wcsubst *NewSubstVar(const char *keyname, int keylen, int type)
449 ptr = (wcsubst *) malloc(sizeof(wcsubst));
450 memset(ptr, 0, sizeof(wcsubst));
452 ptr->wcs_type = type;
453 safestrncpy(ptr->wcs_key, keyname, sizeof ptr->wcs_key);
454 Put(WCC->vars, keyname, keylen, ptr, deletevar);
456 switch(ptr->wcs_type) {
459 ptr->wcs_value = NewStrBuf();
473 * \brief Add a substitution variable (local to this session) (strlen version...)
474 * \param keyname the replacementstring to substitute
475 * \param keytype the kind of the key
476 * \param format the format string ala printf
477 * \param ... the arguments to substitute in the formatstring
479 void SVPRINTF(char *keyname, int keytype, const char *format,...)
487 keylen = strlen(keyname);
489 * First look if we're doing a replacement of
492 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
493 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
494 ptr = (wcsubst*)vPtr;
495 FlushPayload(ptr, keytype, keytype);
496 ptr->wcs_type = keytype;
498 else /** Otherwise allocate a new one */
500 ptr = NewSubstVar(keyname, keylen, keytype);
503 /** Format the string */
504 va_start(arg_ptr, format);
505 StrBufVAppendPrintf(ptr->wcs_value, format, arg_ptr);
510 * \brief Add a substitution variable (local to this session)
511 * \param keyname the replacementstring to substitute
512 * \param keytype the kind of the key
513 * \param format the format string ala printf
514 * \param ... the arguments to substitute in the formatstring
516 void svprintf(char *keyname, size_t keylen, int keytype, const char *format,...)
524 * First look if we're doing a replacement of
527 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
528 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
529 ptr = (wcsubst*)vPtr;
530 FlushPayload(ptr, 1, keytype);
531 ptr->wcs_type = keytype;
533 else /** Otherwise allocate a new one */
535 ptr = NewSubstVar(keyname, keylen, keytype);
538 /** Format the string and save it */
539 va_start(arg_ptr, format);
540 StrBufVAppendPrintf(ptr->wcs_value, format, arg_ptr);
545 * \brief Add a substitution variable (local to this session)
546 * \param keyname the replacementstring to substitute
547 * \param keytype the kind of the key
548 * \param format the format string ala printf
549 * \param ... the arguments to substitute in the formatstring
551 void SVPut(char *keyname, size_t keylen, int keytype, char *Data)
559 * First look if we're doing a replacement of
562 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
563 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
564 ptr = (wcsubst*)vPtr;
565 FlushPayload(ptr, 1, keytype);
566 ptr->wcs_type = keytype;
568 else /** Otherwise allocate a new one */
570 ptr = NewSubstVar(keyname, keylen, keytype);
572 StrBufAppendBufPlain(ptr->wcs_value, Data, -1, 0);
576 * \brief Add a substitution variable (local to this session)
577 * \param keyname the replacementstring to substitute
578 * \param keytype the kind of the key
579 * \param format the format string ala printf
580 * \param ... the arguments to substitute in the formatstring
582 void SVPutLong(char *keyname, size_t keylen, long Data)
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, WCS_LONG);
597 ptr->wcs_type = WCS_LONG;
599 else /** Otherwise allocate a new one */
601 ptr = NewSubstVar(keyname, keylen, WCS_LONG);
607 * \brief Add a substitution variable (local to this session) that does a callback
608 * \param keyname the keystring to substitute
609 * \param fcn_ptr the function callback to give the substitution string
611 void SVCallback(char *keyname, size_t keylen, WCHandlerFunc fcn_ptr)
618 * First look if we're doing a replacement of
621 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
622 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
623 ptr = (wcsubst*)vPtr;
624 FlushPayload(ptr, 1, WCS_FUNCTION);
625 ptr->wcs_type = WCS_FUNCTION;
627 else /** Otherwise allocate a new one */
629 ptr = NewSubstVar(keyname, keylen, WCS_FUNCTION);
632 ptr->wcs_function = fcn_ptr;
634 inline void SVCALLBACK(char *keyname, WCHandlerFunc fcn_ptr)
636 SVCallback(keyname, strlen(keyname), fcn_ptr);
641 void SVPUTBuf(const char *keyname, int keylen, const StrBuf *Buf, int ref)
648 * First look if we're doing a replacement of
651 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
652 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
653 ptr = (wcsubst*)vPtr;
654 FlushPayload(ptr, 0, (ref)?WCS_STRBUF_REF:WCS_STRBUF);
655 ptr->wcs_type = (ref)?WCS_STRBUF_REF:WCS_STRBUF;
657 else /** Otherwise allocate a new one */
659 ptr = NewSubstVar(keyname, keylen, (ref)?WCS_STRBUF_REF:WCS_STRBUF);
661 ptr->wcs_value = (StrBuf*)Buf;
665 * \brief back end for print_value_of() ... does a server command
666 * \param servcmd server command to execute on the citadel server
668 void pvo_do_cmd(StrBuf *Target, StrBuf *servcmd) {
672 serv_puts(ChrPtr(servcmd));
673 len = serv_getln(buf, sizeof buf);
679 StrBufAppendPrintf(Target, "%s\n", &buf[4]);
682 _fmout(Target, "CENTER");
685 StrBufAppendPrintf(Target, "%s\n", &buf[4]);
691 void GetTemplateTokenString(WCTemplputParams *TP,
697 WCTemplputParams SubTP;
699 if (TP->Tokens->nParameters < N) {
700 lprintf(1, "invalid token. this shouldn't have come till here.\n");
707 switch (TP->Tokens->Params[N]->Type) {
710 *Value = TP->Tokens->Params[N]->Start;
711 *len = TP->Tokens->Params[N]->len;
714 Buf = (StrBuf*) SBstr(TKEY(N));
715 *Value = ChrPtr(Buf);
716 *len = StrLength(Buf);
719 get_PREFERENCE(TKEY(N), &Buf);
720 *Value = ChrPtr(Buf);
721 *len = StrLength(Buf);
725 break; /* todo: string to text? */
727 *Value = _(TP->Tokens->Params[N]->Start);
728 *len = strlen(*Value);
730 case TYPE_SUBTEMPLATE:
731 memset(&SubTP, 0, sizeof(WCTemplputParams *));
732 SubTP.Context = TP->Context;
733 SubTP.Filter.ContextType = TP->Filter.ContextType;
735 DoTemplate(TKEY(N), Buf, &SubTP);
736 *Value = ChrPtr(Buf);
737 *len = StrLength(Buf);
738 /* we can't free it here, so we put it into the subst so its discarded later on. */
739 SVPUTBuf(TKEY(N), Buf, 0);
751 * \brief Print the value of a variable
752 * \param keyname get a key to print
754 void print_value_of(StrBuf *Target, WCTemplputParams *TP)
761 /*if (WCC->vars != NULL) PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
762 /* TODO: depricated! */
763 if (TP->Tokens->pName[0] == '=') {
764 DoTemplate(TP->Tokens->pName+1, TP->Tokens->NameEnd - 1, NULL, &NoCtx);
766 /*/////TODO: if param[1] == "U" -> urlescape
768 /** Page-local variables */
769 if ((WCC->vars!= NULL) && GetHash(WCC->vars, TP->Tokens->pName, TP->Tokens->NameEnd, &vVar)) {
770 ptr = (wcsubst*) vVar;
771 switch(ptr->wcs_type) {
773 StrBufAppendBuf(Target, ptr->wcs_value, 0);
776 pvo_do_cmd(Target, ptr->wcs_value);
779 (*ptr->wcs_function) (Target, TP);
783 StrBufAppendBuf(Target, ptr->wcs_value, 0);
786 StrBufAppendPrintf(Target, "%ld", ptr->lvalue);
790 Target, "Subst", ERR_NAME, TP,
791 "WARNING: invalid value in SV-Hash at %s!", TP->Tokens->pName);
796 Target, "Token", ERR_NAME, TP,
797 "didn't find Handler \"%s\"", TP->Tokens->pName);
802 int CompareSubstToToken(TemplateParam *ParamToCompare, TemplateParam *ParamToLookup)
808 if ((WCC->vars!= NULL) && GetHash(WCC->vars, ParamToLookup->Start,
809 ParamToLookup->len, &vVar)) {
810 ptr = (wcsubst*) vVar;
811 switch(ptr->wcs_type) {
815 if (ParamToCompare->Type == TYPE_STR)
816 return ((ParamToCompare->len == StrLength(ptr->wcs_value)) &&
817 (strcmp(ParamToCompare->Start, ChrPtr(ptr->wcs_value)) == 0));
819 return ParamToCompare->lvalue == StrTol(ptr->wcs_value);
827 if (ParamToCompare->Type == TYPE_STR)
830 return ParamToCompare->lvalue == ptr->lvalue;
833 lprintf(1,"WARNING: invalid value in SV-Hash at %s!\n",
834 ParamToLookup->Start);
840 int CompareSubstToStrBuf(StrBuf *Compare, TemplateParam *ParamToLookup)
846 if ((WCC->vars!= NULL) && GetHash(WCC->vars, ParamToLookup->Start,
847 ParamToLookup->len, &vVar)) {
848 ptr = (wcsubst*) vVar;
849 switch(ptr->wcs_type) {
853 return ((StrLength(Compare) == StrLength(ptr->wcs_value)) &&
854 (strcmp(ChrPtr(Compare), ChrPtr(ptr->wcs_value)) == 0));
861 return StrTol(Compare) == ptr->lvalue;
863 lprintf(1,"WARNING: invalid value in SV-Hash at %s!\n",
864 ParamToLookup->Start);
873 * \brief puts string into the template and computes which escape methon we should use
874 * \param Source the string we should put into the template
875 * \param FormatTypeIndex where should we look for escape types if?
877 void StrBufAppendTemplate(StrBuf *Target,
878 WCTemplputParams *TP,
879 const StrBuf *Source, int FormatTypeIndex)
884 if ((FormatTypeIndex < TP->Tokens->nParameters) &&
885 (TP->Tokens->Params[FormatTypeIndex]->Type == TYPE_STR) &&
886 (TP->Tokens->Params[FormatTypeIndex]->len == 1)) {
887 EscapeAs = *TP->Tokens->Params[FormatTypeIndex]->Start;
894 StrEscAppend(Target, Source, NULL, 0, 2);
897 StrEscAppend(Target, Source, NULL, 0, 0);
900 StrECMAEscAppend(Target, Source, NULL);
903 StrBufAppendBuf(Target, Source, 0);
908 void PutNewToken(WCTemplate *Template, WCTemplateToken *NewToken)
910 if (Template->nTokensUsed + 1 >= Template->TokenSpace) {
911 if (Template->TokenSpace <= 0) {
912 Template->Tokens = (WCTemplateToken**)malloc(
913 sizeof(WCTemplateToken*) * 10);
914 Template->TokenSpace = 10;
917 WCTemplateToken **NewTokens;
918 NewTokens= (WCTemplateToken**)malloc(
919 sizeof(WCTemplateToken*) *
920 Template->TokenSpace * 2);
921 memcpy(NewTokens, Template->Tokens,
922 sizeof(WCTemplateToken*) * Template->nTokensUsed);
923 free(Template->Tokens);
924 Template->TokenSpace *= 2;
925 Template->Tokens = NewTokens;
928 Template->Tokens[(Template->nTokensUsed)++] = NewToken;
931 TemplateParam *GetNextParameter(StrBuf *Buf, const char **pCh, const char *pe, WCTemplateToken *Tokens, WCTemplate *pTmpl)
933 const char *pch = *pCh;
934 const char *pchs, *pche;
935 TemplateParam *Parm = (TemplateParam *) malloc(sizeof(TemplateParam));
939 Parm->Type = TYPE_STR;
941 /* Skip leading whitespaces */
942 while ((*pch == ' ' )||
945 (*pch == '\n')) pch ++;
948 Parm->Type = TYPE_PREFSTR;
955 else if (*pch == ';') {
956 Parm->Type = TYPE_PREFINT;
963 else if (*pch == '_') {
964 Parm->Type = TYPE_GETTEXT;
971 else if (*pch == 'B') {
972 Parm->Type = TYPE_BSTR;
979 else if (*pch == '=') {
980 Parm->Type = TYPE_SUBTEMPLATE;
991 else if (*pch == '\'')
998 ( (pch > pchs) && (*(pch - 1) == '\\'))
1003 if (*pch != quote) {
1004 lprintf(1, "Error (in '%s' line %ld); "
1005 "evaluating template param [%s] in Token [%s]\n",
1006 ChrPtr(pTmpl->FileName),
1008 ChrPtr(Tokens->FlatToken),
1015 StrBufPeek(Buf, pch, -1, '\0');
1016 if (LoadTemplates > 1) {
1017 lprintf(1, "DBG: got param [%s] %ld %ld\n",
1018 pchs, pche - pchs, strlen(pchs));
1021 Parm->len = pche - pchs;
1022 pch ++; /* move after trailing quote */
1023 if (ParamBrace && (*pch == ')')) {
1030 Parm->Type = TYPE_LONG;
1032 while ((pch <= pe) &&
1038 if (pch - pchs > 1){
1039 StrBufPeek(Buf, pch, -1, '\0');
1040 Parm->lvalue = atol(pchs);
1047 lprintf(1, "Error (in '%s' line %ld); "
1048 "evaluating long template param [%s] in Token [%s]\n",
1049 ChrPtr(pTmpl->FileName),
1051 ChrPtr(Tokens->FlatToken),
1058 while ((*pch == ' ' )||
1062 (*pch == '\n')) pch ++;
1068 WCTemplateToken *NewTemplateSubstitute(StrBuf *Buf,
1070 const char *pTmplStart,
1071 const char *pTmplEnd,
1077 TemplateParam *Param;
1078 WCTemplateToken *NewToken = (WCTemplateToken*)malloc(sizeof(WCTemplateToken));
1079 WCTemplputParams TP;
1081 TP.Tokens = NewToken;
1082 NewToken->FileName = pTmpl->FileName; /* to print meaningfull log messages... */
1083 NewToken->Flags = 0;
1084 NewToken->Line = Line + 1;
1085 NewToken->pTokenStart = pTmplStart;
1086 NewToken->TokenStart = pTmplStart - pStart;
1087 NewToken->TokenEnd = (pTmplEnd - pStart) - NewToken->TokenStart;
1088 NewToken->pTokenEnd = pTmplEnd;
1089 NewToken->NameEnd = NewToken->TokenEnd - 2;
1090 NewToken->PreEval = NULL;
1091 NewToken->FlatToken = NewStrBufPlain(pTmplStart + 2, pTmplEnd - pTmplStart - 2);
1093 StrBufPeek(Buf, pTmplStart, + 1, '\0');
1094 StrBufPeek(Buf, pTmplEnd, -1, '\0');
1095 pch = NewToken->pName = pTmplStart + 2;
1097 NewToken->HaveParameters = 0;;
1098 NewToken->nParameters = 0;
1100 while (pch < pTmplEnd - 1) {
1102 StrBufPeek(Buf, pch, -1, '\0');
1103 NewToken->NameEnd = pch - NewToken->pName;
1105 if (*(pTmplEnd - 1) != ')') {
1107 NULL, "Parseerror", ERR_NAME, &TP,
1108 "Warning, Non welformed Token; missing right parenthesis");
1110 while (pch < pTmplEnd - 1) {
1111 Param = GetNextParameter(Buf, &pch, pTmplEnd - 1, NewToken, pTmpl);
1112 if (Param != NULL) {
1113 NewToken->HaveParameters = 1;
1114 if (NewToken->nParameters > MAXPARAM) {
1116 NULL, "Parseerror", ERR_NAME, &TP,
1117 "only [%d] Params allowed in Tokens",
1121 FreeToken(&NewToken);
1124 NewToken->Params[NewToken->nParameters++] = Param;
1128 if((NewToken->NameEnd == 1) &&
1129 (NewToken->HaveParameters == 1))
1132 if (*(NewToken->pName) == '_')
1133 NewToken->Flags = SV_GETTEXT;
1134 else if (*(NewToken->pName) == '=')
1135 NewToken->Flags = SV_SUBTEMPL;
1136 else if (*(NewToken->pName) == '%')
1137 NewToken->Flags = SV_CUST_STR_CONDITIONAL;
1138 else if (*(NewToken->pName) == '?')
1139 NewToken->Flags = SV_CONDITIONAL;
1140 else if (*(NewToken->pName) == '!')
1141 NewToken->Flags = SV_NEG_CONDITIONAL;
1147 switch (NewToken->Flags) {
1149 /* If we're able to find out more about the token, do it now while its fresh. */
1150 if (GetHash(GlobalNS, NewToken->pName, NewToken->NameEnd, &vVar)) {
1151 HashHandler *Handler;
1152 Handler = (HashHandler*) vVar;
1153 if ((NewToken->nParameters < Handler->Filter.nMinArgs) ||
1154 (NewToken->nParameters > Handler->Filter.nMaxArgs)) {
1156 NULL, "Token", ERR_NAME, &TP,
1157 "doesn't work with %d params",
1158 NewToken->nParameters);
1162 NewToken->PreEval = Handler;
1163 NewToken->Flags = SV_PREEVALUATED;
1168 if (NewToken->nParameters !=1) {
1170 NULL, "Gettext", ERR_NAME, &TP,
1171 "requires exactly 1 parameter, you gave %d params",
1172 NewToken->nParameters);
1173 NewToken->Flags = 0;
1178 if (NewToken->nParameters != 1) {
1180 NULL, "Subtemplates", ERR_NAME, &TP,
1181 "require exactly 1 parameter, you gave %d params",
1182 NewToken->nParameters);
1186 case SV_CUST_STR_CONDITIONAL:
1187 case SV_CONDITIONAL:
1188 case SV_NEG_CONDITIONAL:
1189 if (NewToken->nParameters <2) {
1191 NULL, "Conditional", ERR_NAME, &TP,
1192 "require at least 2 parameters, you gave %d params",
1193 NewToken->nParameters);
1194 NewToken->Flags = 0;
1197 if (NewToken->Params[1]->lvalue == 0) {
1199 NULL, "Conditional", ERR_NAME, &TP,
1200 "Conditional ID (Parameter 1) mustn't be 0!");
1201 NewToken->Flags = 0;
1204 if (!GetHash(Conditionals,
1205 NewToken->Params[0]->Start,
1206 NewToken->Params[0]->len,
1209 if ((NewToken->Params[0]->len == 1) &&
1210 (NewToken->Params[0]->Start[0] == 'X'))
1213 NULL, "Conditional", ERR_NAME, &TP,
1216 NewToken->Error = NewStrBuf();
1219 "<pre>\nConditional [%s] (in '%s' line %ld); Not found!\n[%s]\n</pre>\n",
1220 NewToken->Params[0]->Start,
1221 ChrPtr(pTmpl->FileName),
1223 ChrPtr(NewToken->FlatToken));
1227 NewToken->PreEval = vVar;
1239 * \brief Display a variable-substituted template
1240 * \param templatename template file to load
1242 void *prepare_template(StrBuf *filename, StrBuf *Key, HashList *PutThere)
1244 WCTemplate *NewTemplate;
1245 NewTemplate = (WCTemplate *) malloc(sizeof(WCTemplate));
1246 NewTemplate->Data = NULL;
1247 NewTemplate->FileName = NewStrBufDup(filename);
1248 NewTemplate->nTokensUsed = 0;
1249 NewTemplate->TokenSpace = 0;
1250 NewTemplate->Tokens = NULL;
1252 Put(PutThere, ChrPtr(Key), StrLength(Key), NewTemplate, FreeWCTemplate);
1257 * \brief Display a variable-substituted template
1258 * \param templatename template file to load
1260 void *load_template(StrBuf *filename, StrBuf *Key, HashList *PutThere)
1263 struct stat statbuf;
1264 const char *pS, *pE, *pch, *Err;
1267 WCTemplate *NewTemplate;
1269 fd = open(ChrPtr(filename), O_RDONLY);
1271 lprintf(1, "ERROR: could not open template '%s' - %s\n",
1272 ChrPtr(filename), strerror(errno));
1276 if (fstat(fd, &statbuf) == -1) {
1277 lprintf(1, "ERROR: could not stat template '%s' - %s\n",
1278 ChrPtr(filename), strerror(errno));
1282 NewTemplate = (WCTemplate *) malloc(sizeof(WCTemplate));
1283 NewTemplate->Data = NewStrBufPlain(NULL, statbuf.st_size);
1284 NewTemplate->FileName = NewStrBufDup(filename);
1285 NewTemplate->nTokensUsed = 0;
1286 NewTemplate->TokenSpace = 0;
1287 NewTemplate->Tokens = NULL;
1288 if (StrBufReadBLOB(NewTemplate->Data, &fd, 1, statbuf.st_size, &Err) < 0) {
1290 FreeWCTemplate(NewTemplate);
1291 lprintf(1, "ERROR: reading template '%s' - %s<br />\n",
1292 ChrPtr(filename), strerror(errno));
1298 pS = pch = ChrPtr(NewTemplate->Data);
1299 pE = pS + StrLength(NewTemplate->Data);
1301 const char *pts, *pte;
1303 int InDoubleQuotes = 0;
1305 /** Find one <? > */
1307 for (; pch < pE; pch ++) {
1308 if ((*pch=='<')&&(*(pch + 1)=='?'))
1310 if (*pch=='\n') Line ++;
1316 /** Found one? parse it. */
1317 for (; pch <= pE - 1; pch ++) {
1319 InDoubleQuotes = ! InDoubleQuotes;
1320 else if (*pch == '\'')
1321 InQuotes = ! InQuotes;
1322 else if ((!InQuotes && !InDoubleQuotes) &&
1323 ((*pch!='\\')&&(*(pch + 1)=='>'))) {
1331 PutNewToken(NewTemplate,
1332 NewTemplateSubstitute(NewTemplate->Data, pS, pts, pte, Line, NewTemplate));
1335 if (LoadTemplates == 0)
1336 Put(PutThere, ChrPtr(Key), StrLength(Key), NewTemplate, FreeWCTemplate);
1341 const char* PrintTemplate(void *vSubst)
1343 WCTemplate *Tmpl = vSubst;
1345 return ChrPtr(Tmpl->FileName);
1349 int LoadTemplateDir(const char *DirName, HashList *wireless, HashList *big)
1354 DIR *filedir = NULL;
1355 struct dirent *filedir_entry;
1361 StrBufPrintf(Dir, "%s/t", DirName);
1362 filedir = opendir (ChrPtr(Dir));
1363 if (filedir == NULL) {
1368 FileName = NewStrBuf();
1370 while ((filedir_entry = readdir(filedir)))
1374 #ifdef _DIRENT_HAVE_D_NAMELEN
1375 d_namelen = filedir_entry->d_namelen;
1377 d_namelen = strlen(filedir_entry->d_name);
1379 d_without_ext = d_namelen;
1380 while ((d_without_ext > 0) && (filedir_entry->d_name[d_without_ext] != '.'))
1382 if ((d_without_ext == 0) || (d_namelen < 3))
1384 if ((d_namelen > 1) && filedir_entry->d_name[d_namelen - 1] == '~')
1385 continue; /* Ignore backup files... */
1387 IsMobile = (strstr(filedir_entry->d_name, ".m.html")!= NULL);
1388 PStart = filedir_entry->d_name;
1389 StrBufPrintf(FileName, "%s/%s", ChrPtr(Dir), filedir_entry->d_name);
1390 MinorPtr = strchr(filedir_entry->d_name, '.');
1391 if (MinorPtr != NULL)
1393 StrBufPlain(Tag, filedir_entry->d_name, MinorPtr - filedir_entry->d_name);
1395 if (LoadTemplates > 1)
1396 lprintf(1, "%s %d %s\n",ChrPtr(FileName), IsMobile, ChrPtr(Tag));
1397 if (LoadTemplates == 0)
1398 load_template(FileName, Tag, (IsMobile)?wireless:big);
1400 prepare_template(FileName, Tag, (IsMobile)?wireless:big);
1403 FreeStrBuf(&FileName);
1409 void InitTemplateCache(void)
1411 LoadTemplateDir(static_dirs[0],
1412 WirelessTemplateCache,
1414 LoadTemplateDir(static_dirs[1],
1415 WirelessLocalTemplateCache,
1416 LocalTemplateCache);
1421 /*-----------------------------------------------------------------------------
1422 * Filling & processing Templates
1425 * \brief executes one token
1426 * \param Target buffer to append to
1427 * \param Token da to process.
1428 * \param Template we're iterating
1429 * \param Context Contextpoointer to pass in
1430 * \param state are we in conditional state?
1431 * \param ContextType what type of information does context giv us?
1433 int EvaluateToken(StrBuf *Target, int state, WCTemplputParams *TP)
1435 const char *AppendMe;
1437 HashHandler *Handler;
1440 /* much output, since pName is not terminated...
1441 lprintf(1,"Doing token: %s\n",Token->pName);
1444 switch (TP->Tokens->Flags) {
1446 TmplGettext(Target, TP);
1448 case SV_CONDITIONAL: /** Forward conditional evaluation */
1449 return EvaluateConditional(Target, 1, state, TP);
1451 case SV_NEG_CONDITIONAL: /** Reverse conditional evaluation */
1452 return EvaluateConditional(Target, 0, state, TP);
1454 case SV_CUST_STR_CONDITIONAL: /** Conditional put custom strings from params */
1455 if (TP->Tokens->nParameters >= 6) {
1456 if (EvaluateConditional(Target, 0, state, TP)) {
1457 GetTemplateTokenString(TP, 5, &AppendMe, &AppendMeLen);
1458 StrBufAppendBufPlain(Target,
1464 GetTemplateTokenString(TP, 4, &AppendMe, &AppendMeLen);
1465 StrBufAppendBufPlain(Target,
1473 Target, "Conditional", ERR_NAME, TP,
1474 "needs at least 6 Params!");
1478 if (TP->Tokens->nParameters == 1)
1479 DoTemplate(TKEY(0), Target, TP);
1481 case SV_PREEVALUATED:
1482 Handler = (HashHandler*) TP->Tokens->PreEval;
1483 if (!CheckContext(Target, &Handler->Filter, TP, "Token")) {
1486 Handler->HandlerFunc(Target, TP);
1489 if (GetHash(GlobalNS, TP->Tokens->pName, TP->Tokens->NameEnd, &vVar)) {
1490 Handler = (HashHandler*) vVar;
1491 if (!CheckContext(Target, &Handler->Filter, TP, "Token")) {
1495 Handler->HandlerFunc(Target, TP);
1499 print_value_of(Target, TP);
1507 void ProcessTemplate(WCTemplate *Tmpl, StrBuf *Target, WCTemplputParams *CallingTP)
1509 WCTemplate *pTmpl = Tmpl;
1512 const char *pData, *pS;
1514 WCTemplputParams TP;
1516 memcpy(&TP.Filter, &CallingTP->Filter, sizeof(ContextFilter));
1518 TP.Context = CallingTP->Context;
1519 TP.ControlContext = CallingTP->ControlContext;
1521 if (LoadTemplates != 0) {
1522 if (LoadTemplates > 1)
1523 lprintf(1, "DBG: ----- loading: [%s] ------ \n",
1524 ChrPtr(Tmpl->FileName));
1526 pTmpl = load_template(Tmpl->FileName, NULL, NULL);
1530 "<pre>\nError loading Template [%s]\n See Logfile for details\n</pre>\n",
1531 ChrPtr(Tmpl->FileName));
1537 pS = pData = ChrPtr(pTmpl->Data);
1538 len = StrLength(pTmpl->Data);
1542 if (i >= pTmpl->nTokensUsed) {
1543 StrBufAppendBufPlain(Target,
1545 len - (pData - pS), 0);
1549 StrBufAppendBufPlain(
1551 pTmpl->Tokens[i]->pTokenStart - pData, 0);
1552 TP.Tokens = pTmpl->Tokens[i];
1553 TP.nArgs = pTmpl->Tokens[i]->nParameters;
1554 state = EvaluateToken(Target, state, &TP);
1556 while ((state != 0) && (i+1 < pTmpl->nTokensUsed)) {
1557 /* condition told us to skip till its end condition */
1559 TP.Tokens = pTmpl->Tokens[i];
1560 TP.nArgs = pTmpl->Tokens[i]->nParameters;
1561 if ((pTmpl->Tokens[i]->Flags == SV_CONDITIONAL) ||
1562 (pTmpl->Tokens[i]->Flags == SV_NEG_CONDITIONAL)) {
1563 if (state == EvaluateConditional(
1565 pTmpl->Tokens[i]->Flags,
1571 pData = pTmpl->Tokens[i++]->pTokenEnd + 1;
1572 if (i > pTmpl->nTokensUsed)
1576 if (LoadTemplates != 0) {
1577 FreeWCTemplate(pTmpl);
1582 * \brief Display a variable-substituted template
1583 * \param templatename template file to load
1585 void DoTemplate(const char *templatename, long len, StrBuf *Target, WCTemplputParams *TP)
1587 WCTemplputParams LocalTP;
1589 HashList *StaticLocal;
1595 memset(&LocalTP, 0, sizeof(WCTemplputParams));
1599 if (WC->is_mobile) {
1600 Static = WirelessTemplateCache;
1601 StaticLocal = WirelessLocalTemplateCache;
1604 Static = TemplateCache;
1605 StaticLocal = LocalTemplateCache;
1610 lprintf (1, "Can't to load a template with empty name!\n");
1611 StrBufAppendPrintf(Target, "<pre>\nCan't to load a template with empty name!\n</pre>");
1615 if (!GetHash(StaticLocal, templatename, len, &vTmpl) &&
1616 !GetHash(Static, templatename, len, &vTmpl)) {
1617 lprintf (1, "didn't find Template [%s] %ld %ld\n", templatename, len , (long)strlen(templatename));
1618 StrBufAppendPrintf(Target, "<pre>\ndidn't find Template [%s] %ld %ld\n</pre>",
1620 (long)strlen(templatename));
1622 dbg_PrintHash(Static, PrintTemplate, NULL);
1623 PrintHash(Static, VarPrintTransition, PrintTemplate);
1629 ProcessTemplate(vTmpl, Target, TP);
1632 /*-----------------------------------------------------------------------------
1635 typedef struct _HashIterator {
1636 HashList *StaticList;
1637 int AdditionalParams;
1639 int XPectContextType;
1641 RetrieveHashlistFunc GetHash;
1642 HashDestructorFunc Destructor;
1643 SubTemplFunc DoSubTemplate;
1646 void RegisterITERATOR(const char *Name, long len,
1647 int AdditionalParams,
1648 HashList *StaticList,
1649 RetrieveHashlistFunc GetHash,
1650 SubTemplFunc DoSubTempl,
1651 HashDestructorFunc Destructor,
1653 int XPectContextType,
1656 HashIterator *It = (HashIterator*)malloc(sizeof(HashIterator));
1657 It->StaticList = StaticList;
1658 It->AdditionalParams = AdditionalParams;
1659 It->GetHash = GetHash;
1660 It->DoSubTemplate = DoSubTempl;
1661 It->Destructor = Destructor;
1662 It->ContextType = ContextType;
1663 It->XPectContextType = XPectContextType;
1665 Put(Iterators, Name, len, It, NULL);
1668 /* typedef struct _iteratestruct {
1677 void tmpl_iterate_subtmpl(StrBuf *Target, WCTemplputParams *TP)
1683 SortStruct *SortBy = NULL;
1685 int DetectGroupChange = 0;
1688 void *vLastContext = NULL;
1690 WCTemplputParams SubTP;
1691 IterateStruct Status;
1693 memset(&Status, 0, sizeof(IterateStruct));
1694 memcpy (&SubTP, &TP, sizeof(WCTemplputParams));
1696 if (!GetHash(Iterators, TKEY(0), &vIt)) {
1698 Target, "Iterator", ERR_PARM1, TP, "Unknown!");
1702 It = (HashIterator*) vIt;
1704 if (TP->Tokens->nParameters < It->AdditionalParams + 2) {
1706 Target, "Iterator", ERR_PARM1, TP,
1707 "doesn't work with %d params",
1708 TP->Tokens->nParameters);
1712 if ((It->XPectContextType != CTX_NONE) &&
1713 (It->XPectContextType != TP->Filter.ContextType)) {
1715 Target, "Iterator", ERR_PARM1, TP,
1716 "requires context of type %d, have %d",
1717 It->XPectContextType,
1718 TP->Filter.ContextType);
1723 if (It->StaticList == NULL)
1724 List = It->GetHash(Target, TP);
1726 List = It->StaticList;
1728 DetectGroupChange = (It->Flags & IT_FLAG_DETECT_GROUPCHANGE) != 0;
1729 if (DetectGroupChange) {
1730 const StrBuf *BSort;
1731 DetectGroupChange = 0;
1732 if (havebstr("SortBy")) {
1733 BSort = sbstr("SortBy");
1734 if (GetHash(SortHash, SKEY(BSort), &vSortBy) &&
1735 (vSortBy != NULL)) {
1736 SortBy = (SortStruct*)vSortBy;
1737 /** Ok, its us, lets see in which direction we should sort... */
1738 if (havebstr("SortOrder")) {
1740 SortOrder = LBSTR("SortOrder");
1742 DetectGroupChange = 1;
1747 nMembersUsed = GetCount(List);
1748 SubBuf = NewStrBuf();
1749 SubTP.Filter.ContextType = It->ContextType;
1750 SubTP.Filter.ControlContextType = CTX_ITERATE;
1751 SubTP.ControlContext = &Status;
1752 it = GetNewHashPos(List, 0);
1753 while (GetNextHashPos(List, it, &Status.KeyLen, &Status.Key, &vContext)) {
1754 if (DetectGroupChange && Status.n > 0) {
1755 Status.GroupChange = (SortBy->GroupChange(vContext, vLastContext))? 1:0;
1757 Status.LastN = ++Status.LastN == nMembersUsed;
1758 SubTP.Context = vContext;
1759 if (It->DoSubTemplate != NULL)
1760 It->DoSubTemplate(SubBuf, &SubTP);
1761 DoTemplate(TKEY(1), SubBuf, &SubTP);
1763 StrBufAppendBuf(Target, SubBuf, 0);
1764 FlushStrBuf(SubBuf);
1765 Status.oddeven = ! Status.oddeven;
1766 vLastContext = vContext;
1768 FreeStrBuf(&SubBuf);
1770 if (It->Destructor != NULL)
1771 It->Destructor(&List);
1775 int conditional_ITERATE_ISGROUPCHANGE(StrBuf *Target, WCTemplputParams *TP)
1777 IterateStruct *Ctx = CCTX;
1778 return Ctx->GroupChange;
1781 void tmplput_ITERATE_ODDEVEN(StrBuf *Target, WCTemplputParams *TP)
1783 IterateStruct *Ctx = CCTX;
1785 StrBufAppendBufPlain(Target, HKEY("odd"), 0);
1787 StrBufAppendBufPlain(Target, HKEY("even"), 0);
1791 void tmplput_ITERATE_KEY(StrBuf *Target, WCTemplputParams *TP)
1793 IterateStruct *Ctx = CCTX;
1795 StrBufAppendBufPlain(Target, Ctx->Key, Ctx->KeyLen, 0);
1799 void tmplput_ITERATE_LASTN(StrBuf *Target, WCTemplputParams *TP)
1801 IterateStruct *Ctx = CCTX;
1802 StrBufAppendPrintf(Target, "%d", Ctx->n);
1805 int conditional_ITERATE_LASTN(StrBuf *Target, WCTemplputParams *TP)
1807 IterateStruct *Ctx = CCTX;
1813 /*-----------------------------------------------------------------------------
1816 int EvaluateConditional(StrBuf *Target, int Neg, int state, WCTemplputParams *TP)
1818 ConditionalStruct *Cond;
1820 if ((TP->Tokens->Params[0]->len == 1) &&
1821 (TP->Tokens->Params[0]->Start[0] == 'X'))
1822 return (state != 0)?TP->Tokens->Params[1]->lvalue:0;
1824 Cond = (ConditionalStruct *) TP->Tokens->PreEval;
1827 Target, "Conditional", ERR_PARM1, TP,
1832 if (!CheckContext(Target, &Cond->Filter, TP, "Conditional")) {
1836 if (Cond->CondF(Target, TP) == Neg)
1837 return TP->Tokens->Params[1]->lvalue;
1841 int ConditionalVar(StrBuf *Target, WCTemplputParams *TP)
1846 if (!GetHash(WC->vars, TKEY(2), &vsubst))
1848 subst = (wcsubst*) vsubst;
1850 switch(subst->wcs_type) {
1852 return (subst->wcs_function!=NULL);
1854 lprintf(1, " -> Server [%s]\n", subst->wcs_value);/* TODO */
1858 case WCS_STRBUF_REF:
1859 if (TP->Tokens->nParameters < 4)
1861 return (strcmp(TP->Tokens->Params[3]->Start, ChrPtr(subst->wcs_value)) == 0);
1863 if (TP->Tokens->nParameters < 4)
1864 return (subst->lvalue != 0);
1865 return (subst->lvalue == TP->Tokens->Params[3]->lvalue);
1867 lprintf(1," WARNING: invalid type: [%ld]!\n", subst->wcs_type);
1873 void RegisterConditional(const char *Name, long len,
1875 WCConditionalFunc CondF,
1876 int ContextRequired)
1878 ConditionalStruct *Cond = (ConditionalStruct*)malloc(sizeof(ConditionalStruct));
1879 Cond->PlainName = Name;
1880 Cond->Filter.nMaxArgs = nParams;
1881 Cond->Filter.nMinArgs = nParams;
1882 Cond->CondF = CondF;
1883 Cond->Filter.ContextType = ContextRequired;
1884 Cond->Filter.ControlContextType = CTX_NONE;
1885 Put(Conditionals, Name, len, Cond, NULL);
1888 void RegisterControlConditional(const char *Name, long len,
1890 WCConditionalFunc CondF,
1891 int ControlContextRequired)
1893 ConditionalStruct *Cond = (ConditionalStruct*)malloc(sizeof(ConditionalStruct));
1894 Cond->PlainName = Name;
1895 Cond->Filter.nMaxArgs = nParams;
1896 Cond->Filter.nMinArgs = nParams;
1897 Cond->CondF = CondF;
1898 Cond->Filter.ContextType = CTX_NONE;
1899 Cond->Filter.ControlContextType = ControlContextRequired;
1900 Put(Conditionals, Name, len, Cond, NULL);
1903 /*-----------------------------------------------------------------------------
1906 void tmplput_ContextString(StrBuf *Target, WCTemplputParams *TP)
1908 StrBufAppendTemplate(Target, TP, (StrBuf*)CTX, 0);
1910 int ConditionalContextStr(StrBuf *Target, WCTemplputParams *TP)
1912 StrBuf *TokenText = (StrBuf*) CTX;
1913 const char *CompareToken;
1916 GetTemplateTokenString(TP, 2, &CompareToken, &len);
1917 return strcmp(ChrPtr(TokenText), CompareToken) == 0;
1920 /*-----------------------------------------------------------------------------
1924 void tmpl_do_boxed(StrBuf *Target, WCTemplputParams *TP)
1926 WCTemplputParams SubTP;
1929 if (TP->Tokens->nParameters == 2) {
1930 if (TP->Tokens->Params[1]->Type == TYPE_STR) {
1931 Headline = NewStrBuf();
1932 DoTemplate(TKEY(1), Headline, TP);
1937 GetTemplateTokenString(TP,
1941 Headline = NewStrBufPlain(Ch, len);
1944 memcpy (&SubTP, TP, sizeof(WCTemplputParams));
1945 SubTP.Context = Headline;
1946 SubTP.Filter.ContextType = CTX_STRBUF;
1947 DoTemplate(HKEY("beginbox"), Target, &SubTP);
1948 DoTemplate(TKEY(0), Target, TP);
1949 DoTemplate(HKEY("endbox"), Target, TP);
1950 FreeStrBuf(&Headline);
1953 /*-----------------------------------------------------------------------------
1957 void tmpl_do_tabbed(StrBuf *Target, WCTemplputParams *TP)
1960 int i, ntabs, nTabs;
1962 nTabs = ntabs = TP->Tokens->nParameters / 2;
1963 TabNames = (StrBuf **) malloc(ntabs * sizeof(StrBuf*));
1965 for (i = 0; i < ntabs; i++) {
1966 if ((TP->Tokens->Params[i * 2]->Type == TYPE_STR) &&
1967 (TP->Tokens->Params[i * 2]->len > 0)) {
1968 TabNames[i] = NewStrBuf();
1969 DoTemplate(TKEY(i * 2), TabNames[i], TP);
1971 else if (TP->Tokens->Params[i * 2]->Type == TYPE_GETTEXT) {
1974 GetTemplateTokenString(TP,
1978 TabNames[i] = NewStrBufPlain(Ch, -1);
1981 /** A Tab without subject? we can't count that, add it as silent */
1986 StrTabbedDialog(Target, nTabs, TabNames);
1987 for (i = 0; i < ntabs; i++) {
1988 StrBeginTab(Target, i, nTabs);
1989 DoTemplate(TKEY(i * 2 + 1), Target, TP);
1990 StrEndTab(Target, i, nTabs);
1995 /*-----------------------------------------------------------------------------
2000 void RegisterSortFunc(const char *name, long len,
2001 const char *prepend, long preplen,
2002 CompareFunc Forward,
2003 CompareFunc Reverse,
2004 CompareFunc GroupChange,
2007 SortStruct *NewSort = (SortStruct*) malloc(sizeof(SortStruct));
2008 NewSort->Name = NewStrBufPlain(name, len);
2009 if (prepend != NULL)
2010 NewSort->PrefPrepend = NewStrBufPlain(prepend, preplen);
2012 NewSort->PrefPrepend = NULL;
2013 NewSort->Forward = Forward;
2014 NewSort->Reverse = Reverse;
2015 NewSort->GroupChange = GroupChange;
2016 NewSort->ContextType = ContextType;
2017 Put(SortHash, name, len, NewSort, DestroySortStruct);
2020 CompareFunc RetrieveSort(WCTemplputParams *TP,
2021 const char *OtherPrefix, long OtherPrefixLen,
2022 const char *Default, long ldefault, long DefaultDirection)
2025 const StrBuf *BSort = NULL;
2028 long SortOrder = -1;
2030 if (havebstr("SortBy")) {
2031 BSort = sbstr("SortBy");
2032 if (OtherPrefix == NULL) {
2033 set_room_pref("sort", NewStrBufDup(BSort), 0);
2036 set_X_PREFS(HKEY("sort"), OtherPrefix, OtherPrefixLen, NewStrBufDup(BSort), 0);
2039 else { /** Try to fallback to our remembered values... */
2040 if (OtherPrefix == NULL) {
2041 BSort = get_room_pref("sort");
2044 BSort = get_X_PREFS(HKEY("sort"), OtherPrefix, OtherPrefixLen);
2047 putbstr("SortBy", NewStrBufDup(BSort));
2051 BSort = Buf = NewStrBufPlain(Default, ldefault);
2052 putbstr("SortBy", Buf);
2056 if (!GetHash(SortHash, SKEY(BSort), &vSortBy) ||
2057 (vSortBy == NULL)) {
2059 if (!GetHash(SortHash, Default, ldefault, &vSortBy) ||
2060 (vSortBy == NULL)) {
2062 NULL, "Sorting", ERR_PARM1, TP,
2063 "Illegal default sort: [%s]", Default);
2067 SortBy = (SortStruct*)vSortBy;
2069 /** Ok, its us, lets see in which direction we should sort... */
2070 if (havebstr("SortOrder")) {
2071 SortOrder = LBSTR("SortOrder");
2073 else { /** Try to fallback to our remembered values... */
2075 if (SortBy->PrefPrepend == NULL) {
2076 Buf = get_room_pref("SortOrder");
2077 SortOrder = StrTol(Buf);
2080 BSort = get_X_PREFS(HKEY("SortOrder"), OtherPrefix, OtherPrefixLen);
2084 SortOrder = DefaultDirection;
2086 Buf = NewStrBufPlain(NULL, 64);
2087 StrBufPrintf(Buf, "%ld", SortOrder);
2088 putbstr("SortOrder", Buf);
2090 switch (SortOrder) {
2095 return SortBy->Forward;
2097 return SortBy->Reverse;
2109 ConstStr SortIcons[] = {
2110 {HKEY("static/sort_none.gif")},
2111 {HKEY("static/up_pointer.gif")},
2112 {HKEY("static/down_pointer.gif")},
2115 ConstStr SortNextOrder[] = {
2122 int GetSortMetric(WCTemplputParams *TP, SortStruct **Next, SortStruct **Param, long *SortOrder, int N)
2124 int bSortError = eNOT_SPECIFIED;
2125 const StrBuf *BSort;
2130 if (!GetHash(SortHash, TKEY(0), &vSort) ||
2132 return eNO_SUCH_SORT;
2133 *Param = (SortStruct*) vSort;
2136 if (havebstr("SortBy")) {
2137 BSort = sbstr("SortBy");
2138 bSortError = eINVALID_PARAM;
2139 if ((*Param)->PrefPrepend == NULL) {
2140 set_room_pref("sort", NewStrBufDup(BSort), 0);
2143 set_X_PREFS(HKEY("sort"), TKEY(N), NewStrBufDup(BSort), 0);
2146 else { /** Try to fallback to our remembered values... */
2147 if ((*Param)->PrefPrepend == NULL) {
2148 BSort = get_room_pref("sort");
2151 BSort = get_X_PREFS(HKEY("sort"), TKEY(N));
2155 if (!GetHash(SortHash, SKEY(BSort), &vSort) ||
2159 *Next = (SortStruct*) vSort;
2161 /** Ok, its us, lets see in which direction we should sort... */
2162 if (havebstr("SortOrder")) {
2163 *SortOrder = LBSTR("SortOrder");
2165 else { /** Try to fallback to our remembered values... */
2166 if ((*Param)->PrefPrepend == NULL) {
2167 *SortOrder = StrTol(get_room_pref("SortOrder"));
2170 *SortOrder = StrTol(get_X_PREFS(HKEY("SortOrder"), TKEY(N)));
2180 void tmplput_SORT_ICON(StrBuf *Target, WCTemplputParams *TP)
2185 const ConstStr *SortIcon;
2187 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2190 Target, "Sorter", ERR_PARM1, TP,
2191 " Sorter [%s] unknown!",
2192 TP->Tokens->Params[0]->Start);
2194 case eINVALID_PARAM:
2195 LogTemplateError(NULL, "Sorter", ERR_PARM1, TP,
2196 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2198 case eNOT_SPECIFIED:
2200 if (Next == Param) {
2201 SortIcon = &SortIcons[SortOrder];
2203 else { /** Not Us... */
2204 SortIcon = &SortIcons[0];
2206 StrBufAppendBufPlain(Target, SortIcon->Key, SortIcon->len, 0);
2210 void tmplput_SORT_NEXT(StrBuf *Target, WCTemplputParams *TP)
2216 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2219 Target, "Sorter", ERR_PARM1, TP,
2220 " Sorter [%s] unknown!",
2221 TP->Tokens->Params[0]->Start);
2223 case eINVALID_PARAM:
2225 NULL, "Sorter", ERR_PARM1, TP,
2226 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2228 case eNOT_SPECIFIED:
2230 StrBufAppendBuf(Target, Param->Name, 0);
2235 void tmplput_SORT_ORDER(StrBuf *Target, WCTemplputParams *TP)
2238 const ConstStr *SortOrderStr;
2242 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2245 Target, "Sorter", ERR_PARM1, TP,
2246 " Sorter [%s] unknown!",
2247 TP->Tokens->Params[0]->Start);
2249 case eINVALID_PARAM:
2251 NULL, "Sorter", ERR_PARM1, TP,
2252 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2254 case eNOT_SPECIFIED:
2256 if (Next == Param) {
2257 SortOrderStr = &SortNextOrder[SortOrder];
2259 else { /** Not Us... */
2260 SortOrderStr = &SortNextOrder[0];
2262 StrBufAppendBufPlain(Target, SortOrderStr->Key, SortOrderStr->len, 0);
2267 void tmplput_long_vector(StrBuf *Target, WCTemplputParams *TP)
2269 long *LongVector = (long*) CTX;
2271 if ((TP->Tokens->Params[0]->Type == TYPE_LONG) &&
2272 (TP->Tokens->Params[0]->lvalue <= LongVector[0]))
2274 StrBufAppendPrintf(Target, "%ld", LongVector[TP->Tokens->Params[0]->lvalue]);
2278 if (TP->Tokens->Params[0]->Type != TYPE_LONG) {
2280 Target, "Longvector", ERR_NAME, TP,
2281 "needs a numerical Parameter!");
2285 Target, "LongVector", ERR_PARM1, TP,
2286 "doesn't have %ld Parameters, its just the size of %ld!",
2287 TP->Tokens->Params[0]->lvalue,
2293 void dbg_print_longvector(long *LongVector)
2295 StrBuf *Buf = NewStrBufPlain(HKEY("Longvector: ["));
2296 int nItems = LongVector[0];
2299 for (i = 0; i < nItems; i++) {
2301 StrBufAppendPrintf(Buf, "%d: %ld | ", i, LongVector[i]);
2303 StrBufAppendPrintf(Buf, "%d: %ld]\n", i, LongVector[i]);
2306 lprintf(1, ChrPtr(Buf));
2310 int ConditionalLongVector(StrBuf *Target, WCTemplputParams *TP)
2312 long *LongVector = (long*) CTX;
2314 if ((TP->Tokens->Params[2]->Type == TYPE_LONG) &&
2315 (TP->Tokens->Params[2]->lvalue <= LongVector[0])&&
2316 (TP->Tokens->Params[3]->Type == TYPE_LONG) &&
2317 (TP->Tokens->Params[3]->lvalue <= LongVector[0]))
2319 return LongVector[TP->Tokens->Params[2]->lvalue] ==
2320 LongVector[TP->Tokens->Params[3]->lvalue];
2324 if ((TP->Tokens->Params[2]->Type == TYPE_LONG) ||
2325 (TP->Tokens->Params[2]->Type == TYPE_LONG)) {
2327 Target, "ConditionalLongvector", ERR_PARM1, TP,
2328 "needs two long Parameter!");
2332 Target, "Longvector", ERR_PARM1, TP,
2333 "doesn't have %ld / %ld Parameters, its just the size of %ld!",
2334 TP->Tokens->Params[2]->lvalue,
2335 TP->Tokens->Params[3]->lvalue,
2346 memset(&NoCtx, 0, sizeof(WCTemplputParams));
2347 RegisterNamespace("SORT:ICON", 1, 2, tmplput_SORT_ICON, CTX_NONE);
2348 RegisterNamespace("SORT:ORDER", 1, 2, tmplput_SORT_ORDER, CTX_NONE);
2349 RegisterNamespace("SORT:NEXT", 1, 2, tmplput_SORT_NEXT, CTX_NONE);
2350 RegisterNamespace("CONTEXTSTR", 0, 1, tmplput_ContextString, CTX_STRBUF);
2351 RegisterNamespace("ITERATE", 2, 100, tmpl_iterate_subtmpl, CTX_NONE);
2352 RegisterNamespace("DOBOXED", 1, 2, tmpl_do_boxed, CTX_NONE);
2353 RegisterNamespace("DOTABBED", 2, 100, tmpl_do_tabbed, CTX_NONE);
2354 RegisterNamespace("LONGVECTOR", 1, 1, tmplput_long_vector, CTX_LONGVECTOR);
2355 RegisterConditional(HKEY("COND:SUBST"), 3, ConditionalVar, CTX_NONE);
2356 RegisterConditional(HKEY("COND:CONTEXTSTR"), 3, ConditionalContextStr, CTX_STRBUF);
2357 RegisterConditional(HKEY("COND:LONGVECTOR"), 4, ConditionalLongVector, CTX_LONGVECTOR);
2359 RegisterControlConditional(HKEY("COND:ITERATE:ISGROUPCHANGE"), 2,
2360 conditional_ITERATE_ISGROUPCHANGE,
2362 RegisterControlConditional(HKEY("COND:ITERATE:LASTN"), 2,
2363 conditional_ITERATE_LASTN,
2365 RegisterControlNS(HKEY("ITERATE:ODDEVEN"), 0, 0, tmplput_ITERATE_ODDEVEN, CTX_ITERATE);
2366 RegisterControlNS(HKEY("ITERATE:KEY"), 0, 0, tmplput_ITERATE_KEY, CTX_ITERATE);
2367 RegisterControlNS(HKEY("ITERATE:N"), 0, 0, tmplput_ITERATE_LASTN, CTX_ITERATE);