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 WCTemplputParams NoCtx;
39 #define SV_CONDITIONAL 2
40 #define SV_NEG_CONDITIONAL 3
41 #define SV_CUST_STR_CONDITIONAL 4
43 #define SV_PREEVALUATED 6
45 typedef struct _WCTemplate {
50 WCTemplateToken **Tokens;
53 typedef struct _HashHandler {
56 WCHandlerFunc HandlerFunc;
59 void *load_template(StrBuf *filename, StrBuf *Key, HashList *PutThere);
60 int EvaluateConditional(StrBuf *Target, int Neg, int state, WCTemplputParams *TP);
64 typedef struct _SortStruct {
69 CompareFunc GroupChange;
74 const char *CtxNames[] = {
96 void DestroySortStruct(void *vSort)
98 SortStruct *Sort = (SortStruct*) vSort;
99 FreeStrBuf(&Sort->Name);
100 FreeStrBuf(&Sort->PrefPrepend);
104 void LogTemplateError (StrBuf *Target, const char *Type, int ErrorPos, WCTemplputParams *TP, const char *Format, ...)
109 const char *Err = NULL;
114 va_start(arg_ptr, Format);
115 StrBufVAppendPrintf(Error, Format, arg_ptr);
120 case ERR_NAME: /* the main token name... */
121 Err = TP->Tokens->pName;
124 Err = TP->Tokens->Params[0]->Start;
127 Err = TP->Tokens->Params[1]->Start;
130 lprintf(1, "%s [%s] (in '%s' line %ld); %s; [%s]\n",
133 ChrPtr(TP->Tokens->FileName),
136 ChrPtr(TP->Tokens->FlatToken));
137 if (Target != NULL) {
140 "<pre>\n%s [%s] (in '%s' line %ld); %s\n[%s]\n</pre>\n",
143 ChrPtr(TP->Tokens->FileName),
146 ChrPtr(TP->Tokens->FlatToken));
151 void RegisterNS(const char *NSName,
155 WCHandlerFunc HandlerFunc,
158 HashHandler *NewHandler;
160 NewHandler = (HashHandler*) malloc(sizeof(HashHandler));
161 NewHandler->Filter.nMinArgs = nMinArgs;
162 NewHandler->Filter.nMaxArgs = nMaxArgs;
163 NewHandler->Filter.ContextType = ContextRequired;
164 NewHandler->Filter.ControlContextType = CTX_NONE;
166 NewHandler->HandlerFunc = HandlerFunc;
167 Put(GlobalNS, NSName, len, NewHandler, NULL);
170 void RegisterControlNS(const char *NSName,
174 WCHandlerFunc HandlerFunc,
175 int ControlContextRequired)
177 HashHandler *NewHandler;
179 NewHandler = (HashHandler*) malloc(sizeof(HashHandler));
180 NewHandler->Filter.nMinArgs = nMinArgs;
181 NewHandler->Filter.nMaxArgs = nMaxArgs;
182 NewHandler->Filter.ContextType = CTX_NONE;
183 NewHandler->Filter.ControlContextType = ControlContextRequired;
184 NewHandler->HandlerFunc = HandlerFunc;
185 Put(GlobalNS, NSName, len, NewHandler, NULL);
190 int CheckContext(StrBuf *Target, ContextFilter *Need, WCTemplputParams *TP, const char *ErrType)
192 if ((Need->ContextType != CTX_NONE) &&
193 (Need->ContextType != TP->Filter.ContextType)) {
195 Target, ErrType, ERR_PARM1, TP,
196 " WARNING: requires Context: [%s], have [%s]!",
197 CtxNames[Need->ContextType],
198 CtxNames[TP->Filter.ContextType]);
202 if ((Need->ControlContextType != CTX_NONE) &&
203 (Need->ControlContextType != TP->Filter.ControlContextType)) {
205 Target, ErrType, ERR_PARM1, TP,
206 " WARNING: requires Control Context: [%s], have [%s]!",
207 CtxNames[Need->ControlContextType],
208 CtxNames[TP->Filter.ControlContextType]);
212 if (TP->Tokens->nParameters < Need->nMinArgs) {
213 LogTemplateError(Target, ErrType, ERR_NAME, TP,
214 "needs at least %ld params, have %ld",
216 TP->Tokens->nParameters);
220 else if (TP->Tokens->nParameters > Need->nMaxArgs) {
221 LogTemplateError(Target, ErrType, ERR_NAME, TP,
222 "just needs %ld params, you gave %ld",
224 TP->Tokens->nParameters);
232 void FreeToken(WCTemplateToken **Token)
235 FreeStrBuf(&(*Token)->FlatToken);
236 if ((*Token)->HaveParameters)
237 for (i = 0; i < (*Token)->nParameters; i++)
238 free((*Token)->Params[i]);
245 void FreeWCTemplate(void *vFreeMe)
248 WCTemplate *FreeMe = (WCTemplate*)vFreeMe;
250 if (FreeMe->TokenSpace > 0) {
251 for (i = 0; i < FreeMe->nTokensUsed; i ++) {
252 FreeToken(&FreeMe->Tokens[i]);
254 free(FreeMe->Tokens);
256 FreeStrBuf(&FreeMe->FileName);
257 FreeStrBuf(&FreeMe->Data);
263 * \brief debugging function to print array to log
265 void VarPrintTransition(void *vVar1, void *vVar2, int odd){}
267 * \brief debugging function to print array to log
269 void VarPrintEntry(const char *Key, void *vSubst, int odd)
272 lprintf(1,"Subst[%s] : ", Key);
273 ptr = (wcsubst*) vSubst;
275 switch(ptr->wcs_type) {
277 lprintf(1, " -> %s\n", ChrPtr(ptr->wcs_value));
280 lprintf(1, " -> Server [%s]\n", ChrPtr(ptr->wcs_value));
283 lprintf(1, " -> function at [%0xd]\n", ptr->wcs_function);
286 lprintf(1," WARNING: invalid type: [%ld]!\n", ptr->wcs_type);
293 * \brief Clear out the list of substitution variables local to this session
295 void clear_substs(wcsession *wc) {
297 if (wc->vars != NULL) {
298 DeleteHash(&wc->vars);
303 * \brief Clear out the list of substitution variables local to this session
305 void clear_local_substs(void) {
324 void FlushPayload(wcsubst *ptr, int reusestrbuf, int type)
326 int NeedNew = NeedNewBuf(type);
327 switch(ptr->wcs_type) {
331 if (reusestrbuf && NeedNew) {
332 FlushStrBuf(ptr->wcs_value);
336 FreeStrBuf(&ptr->wcs_value);
337 ptr->wcs_value = NULL;
341 ptr->wcs_function = NULL;
342 if (reusestrbuf && NeedNew)
343 ptr->wcs_value = NewStrBuf();
346 ptr->wcs_value = NULL;
347 if (reusestrbuf && NeedNew)
348 ptr->wcs_value = NewStrBuf();
352 if (reusestrbuf && NeedNew)
353 ptr->wcs_value = NewStrBuf();
356 if (reusestrbuf && NeedNew)
357 ptr->wcs_value = NewStrBuf();
364 * \brief destructor; kill one entry.
366 void deletevar(void *data)
368 wcsubst *ptr = (wcsubst*)data;
369 FlushPayload(ptr, 0, ptr->wcs_type);
374 wcsubst *NewSubstVar(const char *keyname, int keylen, int type)
379 ptr = (wcsubst *) malloc(sizeof(wcsubst));
380 memset(ptr, 0, sizeof(wcsubst));
382 ptr->wcs_type = type;
383 safestrncpy(ptr->wcs_key, keyname, sizeof ptr->wcs_key);
384 Put(WCC->vars, keyname, keylen, ptr, deletevar);
386 switch(ptr->wcs_type) {
389 ptr->wcs_value = NewStrBuf();
403 * \brief Add a substitution variable (local to this session) (strlen version...)
404 * \param keyname the replacementstring to substitute
405 * \param keytype the kind of the key
406 * \param format the format string ala printf
407 * \param ... the arguments to substitute in the formatstring
409 void SVPRINTF(char *keyname, int keytype, const char *format,...)
417 keylen = strlen(keyname);
419 * First look if we're doing a replacement of
422 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
423 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
424 ptr = (wcsubst*)vPtr;
425 FlushPayload(ptr, keytype, keytype);
426 ptr->wcs_type = keytype;
428 else /** Otherwise allocate a new one */
430 ptr = NewSubstVar(keyname, keylen, keytype);
433 /** Format the string */
434 va_start(arg_ptr, format);
435 StrBufVAppendPrintf(ptr->wcs_value, format, arg_ptr);
440 * \brief Add a substitution variable (local to this session)
441 * \param keyname the replacementstring to substitute
442 * \param keytype the kind of the key
443 * \param format the format string ala printf
444 * \param ... the arguments to substitute in the formatstring
446 void svprintf(char *keyname, size_t keylen, int keytype, const char *format,...)
454 * First look if we're doing a replacement of
457 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
458 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
459 ptr = (wcsubst*)vPtr;
460 FlushPayload(ptr, 1, keytype);
461 ptr->wcs_type = keytype;
463 else /** Otherwise allocate a new one */
465 ptr = NewSubstVar(keyname, keylen, keytype);
468 /** Format the string and save it */
469 va_start(arg_ptr, format);
470 StrBufVAppendPrintf(ptr->wcs_value, format, arg_ptr);
475 * \brief Add a substitution variable (local to this session)
476 * \param keyname the replacementstring to substitute
477 * \param keytype the kind of the key
478 * \param format the format string ala printf
479 * \param ... the arguments to substitute in the formatstring
481 void SVPut(char *keyname, size_t keylen, int keytype, char *Data)
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, 1, keytype);
496 ptr->wcs_type = keytype;
498 else /** Otherwise allocate a new one */
500 ptr = NewSubstVar(keyname, keylen, keytype);
502 StrBufAppendBufPlain(ptr->wcs_value, Data, -1, 0);
506 * \brief Add a substitution variable (local to this session)
507 * \param keyname the replacementstring to substitute
508 * \param keytype the kind of the key
509 * \param format the format string ala printf
510 * \param ... the arguments to substitute in the formatstring
512 void SVPutLong(char *keyname, size_t keylen, long Data)
520 * First look if we're doing a replacement of
523 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
524 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
525 ptr = (wcsubst*)vPtr;
526 FlushPayload(ptr, 1, WCS_LONG);
527 ptr->wcs_type = WCS_LONG;
529 else /** Otherwise allocate a new one */
531 ptr = NewSubstVar(keyname, keylen, WCS_LONG);
537 * \brief Add a substitution variable (local to this session) that does a callback
538 * \param keyname the keystring to substitute
539 * \param fcn_ptr the function callback to give the substitution string
541 void SVCallback(char *keyname, size_t keylen, WCHandlerFunc fcn_ptr)
548 * First look if we're doing a replacement of
551 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
552 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
553 ptr = (wcsubst*)vPtr;
554 FlushPayload(ptr, 1, WCS_FUNCTION);
555 ptr->wcs_type = WCS_FUNCTION;
557 else /** Otherwise allocate a new one */
559 ptr = NewSubstVar(keyname, keylen, WCS_FUNCTION);
562 ptr->wcs_function = fcn_ptr;
564 inline void SVCALLBACK(char *keyname, WCHandlerFunc fcn_ptr)
566 SVCallback(keyname, strlen(keyname), fcn_ptr);
571 void SVPUTBuf(const char *keyname, int keylen, const StrBuf *Buf, int ref)
578 * First look if we're doing a replacement of
581 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
582 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
583 ptr = (wcsubst*)vPtr;
584 FlushPayload(ptr, 0, (ref)?WCS_STRBUF_REF:WCS_STRBUF);
585 ptr->wcs_type = (ref)?WCS_STRBUF_REF:WCS_STRBUF;
587 else /** Otherwise allocate a new one */
589 ptr = NewSubstVar(keyname, keylen, (ref)?WCS_STRBUF_REF:WCS_STRBUF);
591 ptr->wcs_value = (StrBuf*)Buf;
595 * \brief back end for print_value_of() ... does a server command
596 * \param servcmd server command to execute on the citadel server
598 void pvo_do_cmd(StrBuf *Target, StrBuf *servcmd) {
602 serv_puts(ChrPtr(servcmd));
603 len = serv_getln(buf, sizeof buf);
609 StrBufAppendPrintf(Target, "%s\n", &buf[4]);
612 _fmout(Target, "CENTER");
615 StrBufAppendPrintf(Target, "%s\n", &buf[4]);
621 void GetTemplateTokenString(WCTemplputParams *TP,
627 WCTemplputParams SubTP;
629 if (TP->Tokens->nParameters < N) {
630 lprintf(1, "invalid token. this shouldn't have come till here.\n");
637 switch (TP->Tokens->Params[N]->Type) {
640 *Value = TP->Tokens->Params[N]->Start;
641 *len = TP->Tokens->Params[N]->len;
644 Buf = (StrBuf*) SBstr(TKEY(N));
645 *Value = ChrPtr(Buf);
646 *len = StrLength(Buf);
649 get_PREFERENCE(TKEY(N), &Buf);
650 *Value = ChrPtr(Buf);
651 *len = StrLength(Buf);
655 break; /* todo: string to text? */
657 *Value = _(TP->Tokens->Params[N]->Start);
658 *len = strlen(*Value);
660 case TYPE_SUBTEMPLATE:
661 memset(&SubTP, 0, sizeof(WCTemplputParams *));
662 SubTP.Context = TP->Context;
663 SubTP.Filter.ContextType = TP->Filter.ContextType;
665 DoTemplate(TKEY(N), Buf, &SubTP);
666 *Value = ChrPtr(Buf);
667 *len = StrLength(Buf);
668 /* we can't free it here, so we put it into the subst so its discarded later on. */
669 SVPUTBuf(TKEY(N), Buf, 0);
681 * \brief Print the value of a variable
682 * \param keyname get a key to print
684 void print_value_of(StrBuf *Target, WCTemplputParams *TP)
691 /*if (WCC->vars != NULL) PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
692 /* TODO: depricated! */
693 if (TP->Tokens->pName[0] == '=') {
694 DoTemplate(TP->Tokens->pName+1, TP->Tokens->NameEnd - 1, NULL, &NoCtx);
696 /*/////TODO: if param[1] == "U" -> urlescape
698 /** Page-local variables */
699 if ((WCC->vars!= NULL) && GetHash(WCC->vars, TP->Tokens->pName, TP->Tokens->NameEnd, &vVar)) {
700 ptr = (wcsubst*) vVar;
701 switch(ptr->wcs_type) {
703 StrBufAppendBuf(Target, ptr->wcs_value, 0);
706 pvo_do_cmd(Target, ptr->wcs_value);
709 (*ptr->wcs_function) (Target, TP);
713 StrBufAppendBuf(Target, ptr->wcs_value, 0);
716 StrBufAppendPrintf(Target, "%ld", ptr->lvalue);
720 Target, "Subst", ERR_NAME, TP,
721 "WARNING: invalid value in SV-Hash at %s!", TP->Tokens->pName);
726 Target, "Token", ERR_NAME, TP,
727 "didn't find Handler");
732 int CompareSubstToToken(TemplateParam *ParamToCompare, TemplateParam *ParamToLookup)
738 if ((WCC->vars!= NULL) && GetHash(WCC->vars, ParamToLookup->Start,
739 ParamToLookup->len, &vVar)) {
740 ptr = (wcsubst*) vVar;
741 switch(ptr->wcs_type) {
745 if (ParamToCompare->Type == TYPE_STR)
746 return ((ParamToCompare->len == StrLength(ptr->wcs_value)) &&
747 (strcmp(ParamToCompare->Start, ChrPtr(ptr->wcs_value)) == 0));
749 return ParamToCompare->lvalue == StrTol(ptr->wcs_value);
757 if (ParamToCompare->Type == TYPE_STR)
760 return ParamToCompare->lvalue == ptr->lvalue;
763 lprintf(1,"WARNING: invalid value in SV-Hash at %s!\n",
764 ParamToLookup->Start);
770 int CompareSubstToStrBuf(StrBuf *Compare, TemplateParam *ParamToLookup)
776 if ((WCC->vars!= NULL) && GetHash(WCC->vars, ParamToLookup->Start,
777 ParamToLookup->len, &vVar)) {
778 ptr = (wcsubst*) vVar;
779 switch(ptr->wcs_type) {
783 return ((StrLength(Compare) == StrLength(ptr->wcs_value)) &&
784 (strcmp(ChrPtr(Compare), ChrPtr(ptr->wcs_value)) == 0));
791 return StrTol(Compare) == ptr->lvalue;
793 lprintf(1,"WARNING: invalid value in SV-Hash at %s!\n",
794 ParamToLookup->Start);
803 * \brief puts string into the template and computes which escape methon we should use
804 * \param Source the string we should put into the template
805 * \param FormatTypeIndex where should we look for escape types if?
807 void StrBufAppendTemplate(StrBuf *Target,
808 WCTemplputParams *TP,
809 const StrBuf *Source, int FormatTypeIndex)
815 if ((FormatTypeIndex < TP->Tokens->nParameters) &&
816 (TP->Tokens->Params[FormatTypeIndex]->Type == TYPE_STR) &&
817 (TP->Tokens->Params[FormatTypeIndex]->len == 1)) {
818 EscapeAs = *TP->Tokens->Params[FormatTypeIndex]->Start;
825 Buf = NewStrBufPlain(NULL, StrLength(Source));
826 StrBuf_RFC822_to_Utf8(Buf,
828 (WCC!=NULL)? WCC->DefaultCharset : NULL,
830 StrEscAppend(Target, Buf, NULL, 0, 0);
834 StrEscAppend(Target, Source, NULL, 0, 0);
837 StrECMAEscAppend(Target, Source, NULL);
840 StrBufAppendBuf(Target, Source, 0);
845 void PutNewToken(WCTemplate *Template, WCTemplateToken *NewToken)
847 if (Template->nTokensUsed + 1 >= Template->TokenSpace) {
848 if (Template->TokenSpace <= 0) {
849 Template->Tokens = (WCTemplateToken**)malloc(
850 sizeof(WCTemplateToken*) * 10);
851 Template->TokenSpace = 10;
854 WCTemplateToken **NewTokens;
855 NewTokens= (WCTemplateToken**)malloc(
856 sizeof(WCTemplateToken*) *
857 Template->TokenSpace * 2);
858 memcpy(NewTokens, Template->Tokens,
859 sizeof(WCTemplateToken*) * Template->nTokensUsed);
860 free(Template->Tokens);
861 Template->TokenSpace *= 2;
862 Template->Tokens = NewTokens;
865 Template->Tokens[(Template->nTokensUsed)++] = NewToken;
868 TemplateParam *GetNextParameter(StrBuf *Buf, const char **pCh, const char *pe, WCTemplateToken *Tokens, WCTemplate *pTmpl)
870 const char *pch = *pCh;
871 const char *pchs, *pche;
872 TemplateParam *Parm = (TemplateParam *) malloc(sizeof(TemplateParam));
876 Parm->Type = TYPE_STR;
878 /* Skip leading whitespaces */
879 while ((*pch == ' ' )||
882 (*pch == '\n')) pch ++;
885 Parm->Type = TYPE_PREFSTR;
892 else if (*pch == ';') {
893 Parm->Type = TYPE_PREFINT;
900 else if (*pch == '_') {
901 Parm->Type = TYPE_GETTEXT;
908 else if (*pch == 'B') {
909 Parm->Type = TYPE_BSTR;
916 else if (*pch == '=') {
917 Parm->Type = TYPE_SUBTEMPLATE;
928 else if (*pch == '\'')
935 ( (pch > pchs) && (*(pch - 1) == '\\'))
941 lprintf(1, "Error (in '%s' line %ld); "
942 "evaluating template param [%s] in Token [%s]\n",
943 ChrPtr(pTmpl->FileName),
945 ChrPtr(Tokens->FlatToken),
952 StrBufPeek(Buf, pch, -1, '\0');
953 if (LoadTemplates > 1) {
954 lprintf(1, "DBG: got param [%s] %ld %ld\n",
955 pchs, pche - pchs, strlen(pchs));
958 Parm->len = pche - pchs;
959 pch ++; /* move after trailing quote */
960 if (ParamBrace && (*pch == ')')) {
967 Parm->Type = TYPE_LONG;
969 while ((pch <= pe) &&
976 StrBufPeek(Buf, pch, -1, '\0');
977 Parm->lvalue = atol(pchs);
984 lprintf(1, "Error (in '%s' line %ld); "
985 "evaluating long template param [%s] in Token [%s]\n",
986 ChrPtr(pTmpl->FileName),
988 ChrPtr(Tokens->FlatToken),
995 while ((*pch == ' ' )||
999 (*pch == '\n')) pch ++;
1005 WCTemplateToken *NewTemplateSubstitute(StrBuf *Buf,
1007 const char *pTmplStart,
1008 const char *pTmplEnd,
1014 TemplateParam *Param;
1015 WCTemplateToken *NewToken = (WCTemplateToken*)malloc(sizeof(WCTemplateToken));
1016 WCTemplputParams TP;
1018 TP.Tokens = NewToken;
1019 NewToken->FileName = pTmpl->FileName; /* to print meaningfull log messages... */
1020 NewToken->Flags = 0;
1021 NewToken->Line = Line + 1;
1022 NewToken->pTokenStart = pTmplStart;
1023 NewToken->TokenStart = pTmplStart - pStart;
1024 NewToken->TokenEnd = (pTmplEnd - pStart) - NewToken->TokenStart;
1025 NewToken->pTokenEnd = pTmplEnd;
1026 NewToken->NameEnd = NewToken->TokenEnd - 2;
1027 NewToken->PreEval = NULL;
1028 NewToken->FlatToken = NewStrBufPlain(pTmplStart + 2, pTmplEnd - pTmplStart - 2);
1030 StrBufPeek(Buf, pTmplStart, + 1, '\0');
1031 StrBufPeek(Buf, pTmplEnd, -1, '\0');
1032 pch = NewToken->pName = pTmplStart + 2;
1034 NewToken->HaveParameters = 0;;
1035 NewToken->nParameters = 0;
1037 while (pch < pTmplEnd - 1) {
1039 StrBufPeek(Buf, pch, -1, '\0');
1040 NewToken->NameEnd = pch - NewToken->pName;
1042 if (*(pTmplEnd - 1) != ')') {
1044 NULL, "Parseerror", ERR_NAME, &TP,
1045 "Warning, Non welformed Token; missing right parenthesis");
1047 while (pch < pTmplEnd - 1) {
1048 Param = GetNextParameter(Buf, &pch, pTmplEnd - 1, NewToken, pTmpl);
1049 if (Param != NULL) {
1050 NewToken->HaveParameters = 1;
1051 if (NewToken->nParameters > MAXPARAM) {
1053 NULL, "Parseerror", ERR_NAME, &TP,
1054 "only [%d] Params allowed in Tokens",
1058 FreeToken(&NewToken);
1061 NewToken->Params[NewToken->nParameters++] = Param;
1065 if((NewToken->NameEnd == 1) &&
1066 (NewToken->HaveParameters == 1))
1069 if (*(NewToken->pName) == '_')
1070 NewToken->Flags = SV_GETTEXT;
1071 else if (*(NewToken->pName) == '=')
1072 NewToken->Flags = SV_SUBTEMPL;
1073 else if (*(NewToken->pName) == '%')
1074 NewToken->Flags = SV_CUST_STR_CONDITIONAL;
1075 else if (*(NewToken->pName) == '?')
1076 NewToken->Flags = SV_CONDITIONAL;
1077 else if (*(NewToken->pName) == '!')
1078 NewToken->Flags = SV_NEG_CONDITIONAL;
1084 switch (NewToken->Flags) {
1086 /* If we're able to find out more about the token, do it now while its fresh. */
1087 if (GetHash(GlobalNS, NewToken->pName, NewToken->NameEnd, &vVar)) {
1088 HashHandler *Handler;
1089 Handler = (HashHandler*) vVar;
1090 if ((NewToken->nParameters < Handler->Filter.nMinArgs) ||
1091 (NewToken->nParameters > Handler->Filter.nMaxArgs)) {
1093 NULL, "Token", ERR_NAME, &TP,
1094 "doesn't work with %d params",
1095 NewToken->nParameters);
1099 NewToken->PreEval = Handler;
1100 NewToken->Flags = SV_PREEVALUATED;
1105 if (NewToken->nParameters !=1) {
1107 NULL, "Gettext", ERR_NAME, &TP,
1108 "requires exactly 1 parameter, you gave %d params",
1109 NewToken->nParameters);
1110 NewToken->Flags = 0;
1115 if (NewToken->nParameters != 1) {
1117 NULL, "Subtemplates", ERR_NAME, &TP,
1118 "require exactly 1 parameter, you gave %d params",
1119 NewToken->nParameters);
1123 case SV_CUST_STR_CONDITIONAL:
1124 case SV_CONDITIONAL:
1125 case SV_NEG_CONDITIONAL:
1126 if (NewToken->nParameters <2) {
1128 NULL, "Conditional", ERR_NAME, &TP,
1129 "require at least 2 parameters, you gave %d params",
1130 NewToken->nParameters);
1131 NewToken->Flags = 0;
1134 if (NewToken->Params[1]->lvalue == 0) {
1136 NULL, "Conditional", ERR_NAME, &TP,
1137 "Conditional ID (Parameter 1) mustn't be 0!");
1138 NewToken->Flags = 0;
1141 if (!GetHash(Conditionals,
1142 NewToken->Params[0]->Start,
1143 NewToken->Params[0]->len,
1146 if ((NewToken->Params[0]->len == 1) &&
1147 (NewToken->Params[0]->Start[0] == 'X'))
1150 NULL, "Conditional", ERR_NAME, &TP,
1153 NewToken->Error = NewStrBuf();
1156 "<pre>\nConditional [%s] (in '%s' line %ld); Not found!\n[%s]\n</pre>\n",
1157 NewToken->Params[0]->Start,
1158 ChrPtr(pTmpl->FileName),
1160 ChrPtr(NewToken->FlatToken));
1164 NewToken->PreEval = vVar;
1176 * \brief Display a variable-substituted template
1177 * \param templatename template file to load
1179 void *prepare_template(StrBuf *filename, StrBuf *Key, HashList *PutThere)
1181 WCTemplate *NewTemplate;
1182 NewTemplate = (WCTemplate *) malloc(sizeof(WCTemplate));
1183 NewTemplate->Data = NULL;
1184 NewTemplate->FileName = NewStrBufDup(filename);
1185 NewTemplate->nTokensUsed = 0;
1186 NewTemplate->TokenSpace = 0;
1187 NewTemplate->Tokens = NULL;
1189 Put(PutThere, ChrPtr(Key), StrLength(Key), NewTemplate, FreeWCTemplate);
1194 * \brief Display a variable-substituted template
1195 * \param templatename template file to load
1197 void *load_template(StrBuf *filename, StrBuf *Key, HashList *PutThere)
1200 struct stat statbuf;
1201 const char *pS, *pE, *pch, *Err;
1204 WCTemplate *NewTemplate;
1206 fd = open(ChrPtr(filename), O_RDONLY);
1208 lprintf(1, "ERROR: could not open template '%s' - %s\n",
1209 ChrPtr(filename), strerror(errno));
1213 if (fstat(fd, &statbuf) == -1) {
1214 lprintf(1, "ERROR: could not stat template '%s' - %s\n",
1215 ChrPtr(filename), strerror(errno));
1219 NewTemplate = (WCTemplate *) malloc(sizeof(WCTemplate));
1220 NewTemplate->Data = NewStrBufPlain(NULL, statbuf.st_size);
1221 NewTemplate->FileName = NewStrBufDup(filename);
1222 NewTemplate->nTokensUsed = 0;
1223 NewTemplate->TokenSpace = 0;
1224 NewTemplate->Tokens = NULL;
1225 if (StrBufReadBLOB(NewTemplate->Data, &fd, 1, statbuf.st_size, &Err) < 0) {
1227 FreeWCTemplate(NewTemplate);
1228 lprintf(1, "ERROR: reading template '%s' - %s<br />\n",
1229 ChrPtr(filename), strerror(errno));
1235 pS = pch = ChrPtr(NewTemplate->Data);
1236 pE = pS + StrLength(NewTemplate->Data);
1238 const char *pts, *pte;
1240 int InDoubleQuotes = 0;
1242 /** Find one <? > */
1244 for (; pch < pE; pch ++) {
1245 if ((*pch=='<')&&(*(pch + 1)=='?'))
1247 if (*pch=='\n') Line ++;
1253 /** Found one? parse it. */
1254 for (; pch <= pE - 1; pch ++) {
1256 InDoubleQuotes = ! InDoubleQuotes;
1257 else if (*pch == '\'')
1258 InQuotes = ! InQuotes;
1259 else if ((!InQuotes && !InDoubleQuotes) &&
1260 ((*pch!='\\')&&(*(pch + 1)=='>'))) {
1268 PutNewToken(NewTemplate,
1269 NewTemplateSubstitute(NewTemplate->Data, pS, pts, pte, Line, NewTemplate));
1272 if (LoadTemplates == 0)
1273 Put(PutThere, ChrPtr(Key), StrLength(Key), NewTemplate, FreeWCTemplate);
1278 const char* PrintTemplate(void *vSubst)
1280 WCTemplate *Tmpl = vSubst;
1282 return ChrPtr(Tmpl->FileName);
1286 int LoadTemplateDir(const char *DirName, HashList *wireless, HashList *big)
1291 DIR *filedir = NULL;
1292 struct dirent *filedir_entry;
1298 StrBufPrintf(Dir, "%s/t", DirName);
1299 filedir = opendir (ChrPtr(Dir));
1300 if (filedir == NULL) {
1305 FileName = NewStrBuf();
1307 while ((filedir_entry = readdir(filedir)))
1311 #ifdef _DIRENT_HAVE_D_NAMELEN
1312 d_namelen = filedir_entry->d_namelen;
1314 d_namelen = strlen(filedir_entry->d_name);
1316 d_without_ext = d_namelen;
1317 while ((d_without_ext > 0) && (filedir_entry->d_name[d_without_ext] != '.'))
1319 if ((d_without_ext == 0) || (d_namelen < 3))
1321 if ((d_namelen > 1) && filedir_entry->d_name[d_namelen - 1] == '~')
1322 continue; /* Ignore backup files... */
1324 IsMobile = (strstr(filedir_entry->d_name, ".m.html")!= NULL);
1325 PStart = filedir_entry->d_name;
1326 StrBufPrintf(FileName, "%s/%s", ChrPtr(Dir), filedir_entry->d_name);
1327 MinorPtr = strchr(filedir_entry->d_name, '.');
1328 if (MinorPtr != NULL)
1330 StrBufPlain(Tag, filedir_entry->d_name, MinorPtr - filedir_entry->d_name);
1332 if (LoadTemplates > 1)
1333 lprintf(1, "%s %d %s\n",ChrPtr(FileName), IsMobile, ChrPtr(Tag));
1334 if (LoadTemplates == 0)
1335 load_template(FileName, Tag, (IsMobile)?wireless:big);
1337 prepare_template(FileName, Tag, (IsMobile)?wireless:big);
1340 FreeStrBuf(&FileName);
1346 void InitTemplateCache(void)
1348 LoadTemplateDir(static_dirs[0],
1349 WirelessTemplateCache,
1351 LoadTemplateDir(static_dirs[1],
1352 WirelessLocalTemplateCache,
1353 LocalTemplateCache);
1358 /*-----------------------------------------------------------------------------
1359 * Filling & processing Templates
1362 * \brief executes one token
1363 * \param Target buffer to append to
1364 * \param Token da to process.
1365 * \param Template we're iterating
1366 * \param Context Contextpoointer to pass in
1367 * \param state are we in conditional state?
1368 * \param ContextType what type of information does context giv us?
1370 int EvaluateToken(StrBuf *Target, int state, WCTemplputParams *TP)
1372 const char *AppendMe;
1374 HashHandler *Handler;
1377 /* much output, since pName is not terminated...
1378 lprintf(1,"Doing token: %s\n",Token->pName);
1381 switch (TP->Tokens->Flags) {
1383 TmplGettext(Target, TP);
1385 case SV_CONDITIONAL: /** Forward conditional evaluation */
1386 return EvaluateConditional(Target, 1, state, TP);
1388 case SV_NEG_CONDITIONAL: /** Reverse conditional evaluation */
1389 return EvaluateConditional(Target, 0, state, TP);
1391 case SV_CUST_STR_CONDITIONAL: /** Conditional put custom strings from params */
1392 if (TP->Tokens->nParameters >= 6) {
1393 if (EvaluateConditional(Target, 0, state, TP)) {
1394 GetTemplateTokenString(TP, 5, &AppendMe, &AppendMeLen);
1395 StrBufAppendBufPlain(Target,
1401 GetTemplateTokenString(TP, 4, &AppendMe, &AppendMeLen);
1402 StrBufAppendBufPlain(Target,
1410 Target, "Conditional", ERR_NAME, TP,
1411 "needs at least 6 Params!");
1415 if (TP->Tokens->nParameters == 1)
1416 DoTemplate(TKEY(0), Target, TP);
1418 case SV_PREEVALUATED:
1419 Handler = (HashHandler*) TP->Tokens->PreEval;
1420 if (!CheckContext(Target, &Handler->Filter, TP, "Token")) {
1423 Handler->HandlerFunc(Target, TP);
1426 if (GetHash(GlobalNS, TP->Tokens->pName, TP->Tokens->NameEnd, &vVar)) {
1427 Handler = (HashHandler*) vVar;
1428 if (!CheckContext(Target, &Handler->Filter, TP, "Token")) {
1432 Handler->HandlerFunc(Target, TP);
1436 print_value_of(Target, TP);
1444 void ProcessTemplate(WCTemplate *Tmpl, StrBuf *Target, void *Context, int ContextType)
1446 WCTemplate *pTmpl = Tmpl;
1449 const char *pData, *pS;
1451 WCTemplputParams TP;
1453 TP.Context = Context;
1454 TP.Filter.ContextType = ContextType;
1456 if (LoadTemplates != 0) {
1457 if (LoadTemplates > 1)
1458 lprintf(1, "DBG: ----- loading: [%s] ------ \n",
1459 ChrPtr(Tmpl->FileName));
1461 pTmpl = load_template(Tmpl->FileName, NULL, NULL);
1465 "<pre>\nError loading Template [%s]\n See Logfile for details\n</pre>\n",
1466 ChrPtr(Tmpl->FileName));
1472 pS = pData = ChrPtr(pTmpl->Data);
1473 len = StrLength(pTmpl->Data);
1477 if (i >= pTmpl->nTokensUsed) {
1478 StrBufAppendBufPlain(Target,
1480 len - (pData - pS), 0);
1484 StrBufAppendBufPlain(
1486 pTmpl->Tokens[i]->pTokenStart - pData, 0);
1487 TP.Tokens = pTmpl->Tokens[i];
1488 TP.nArgs = pTmpl->Tokens[i]->nParameters;
1489 state = EvaluateToken(Target, state, &TP);
1491 while ((state != 0) && (i+1 < pTmpl->nTokensUsed)) {
1492 /* condition told us to skip till its end condition */
1494 TP.Tokens = pTmpl->Tokens[i];
1495 TP.nArgs = pTmpl->Tokens[i]->nParameters;
1496 if ((pTmpl->Tokens[i]->Flags == SV_CONDITIONAL) ||
1497 (pTmpl->Tokens[i]->Flags == SV_NEG_CONDITIONAL)) {
1498 if (state == EvaluateConditional(
1500 pTmpl->Tokens[i]->Flags,
1506 pData = pTmpl->Tokens[i++]->pTokenEnd + 1;
1507 if (i > pTmpl->nTokensUsed)
1511 if (LoadTemplates != 0) {
1512 FreeWCTemplate(pTmpl);
1517 * \brief Display a variable-substituted template
1518 * \param templatename template file to load
1520 void DoTemplate(const char *templatename, long len, StrBuf *Target, WCTemplputParams *TP)
1523 HashList *StaticLocal;
1528 if (WC->is_mobile) {
1529 Static = WirelessTemplateCache;
1530 StaticLocal = WirelessLocalTemplateCache;
1533 Static = TemplateCache;
1534 StaticLocal = LocalTemplateCache;
1539 lprintf (1, "Can't to load a template with empty name!\n");
1540 StrBufAppendPrintf(Target, "<pre>\nCan't to load a template with empty name!\n</pre>");
1544 if (!GetHash(StaticLocal, templatename, len, &vTmpl) &&
1545 !GetHash(Static, templatename, len, &vTmpl)) {
1546 lprintf (1, "didn't find Template [%s] %ld %ld\n", templatename, len , (long)strlen(templatename));
1547 StrBufAppendPrintf(Target, "<pre>\ndidn't find Template [%s] %ld %ld\n</pre>",
1549 (long)strlen(templatename));
1551 dbg_PrintHash(Static, PrintTemplate, NULL);
1552 PrintHash(Static, VarPrintTransition, PrintTemplate);
1558 ProcessTemplate(vTmpl, Target, TP->Context, TP->Filter.ContextType);
1561 /*-----------------------------------------------------------------------------
1564 typedef struct _HashIterator {
1565 HashList *StaticList;
1566 int AdditionalParams;
1568 int XPectContextType;
1570 RetrieveHashlistFunc GetHash;
1571 HashDestructorFunc Destructor;
1572 SubTemplFunc DoSubTemplate;
1575 void RegisterITERATOR(const char *Name, long len,
1576 int AdditionalParams,
1577 HashList *StaticList,
1578 RetrieveHashlistFunc GetHash,
1579 SubTemplFunc DoSubTempl,
1580 HashDestructorFunc Destructor,
1582 int XPectContextType,
1585 HashIterator *It = (HashIterator*)malloc(sizeof(HashIterator));
1586 It->StaticList = StaticList;
1587 It->AdditionalParams = AdditionalParams;
1588 It->GetHash = GetHash;
1589 It->DoSubTemplate = DoSubTempl;
1590 It->Destructor = Destructor;
1591 It->ContextType = ContextType;
1592 It->XPectContextType = XPectContextType;
1594 Put(Iterators, Name, len, It, NULL);
1597 typedef struct _iteratestruct {
1606 void tmpl_iterate_subtmpl(StrBuf *Target, WCTemplputParams *TP)
1612 SortStruct *SortBy = NULL;
1614 int DetectGroupChange = 0;
1617 void *vLastContext = NULL;
1619 WCTemplputParams SubTP;
1620 IterateStruct Status;
1622 memset(&Status, 0, sizeof(IterateStruct));
1623 memcpy (&SubTP, &TP, sizeof(WCTemplputParams));
1625 if (!GetHash(Iterators, TKEY(0), &vIt)) {
1627 Target, "Iterator", ERR_PARM1, TP, "Unknown!");
1631 It = (HashIterator*) vIt;
1633 if (TP->Tokens->nParameters < It->AdditionalParams + 2) {
1635 Target, "Iterator", ERR_PARM1, TP,
1636 "doesn't work with %d params",
1637 TP->Tokens->nParameters);
1641 if ((It->XPectContextType != CTX_NONE) &&
1642 (It->XPectContextType != TP->Filter.ContextType)) {
1644 Target, "Iterator", ERR_PARM1, TP,
1645 "requires context of type %d, have %d",
1646 It->XPectContextType,
1647 TP->Filter.ContextType);
1652 if (It->StaticList == NULL)
1653 List = It->GetHash(Target, TP);
1655 List = It->StaticList;
1657 DetectGroupChange = (It->Flags & IT_FLAG_DETECT_GROUPCHANGE) != 0;
1658 if (DetectGroupChange) {
1659 const StrBuf *BSort;
1660 DetectGroupChange = 0;
1661 if (havebstr("SortBy")) {
1662 BSort = sbstr("SortBy");
1663 if (GetHash(SortHash, SKEY(BSort), &vSortBy) &&
1664 (vSortBy != NULL)) {
1665 SortBy = (SortStruct*)vSortBy;
1666 /** Ok, its us, lets see in which direction we should sort... */
1667 if (havebstr("SortOrder")) {
1669 SortOrder = LBSTR("SortOrder");
1671 DetectGroupChange = 1;
1676 nMembersUsed = GetCount(List);
1677 SubBuf = NewStrBuf();
1678 SubTP.Filter.ContextType = It->ContextType;
1679 SubTP.Filter.ControlContextType = CTX_ITERATE;
1680 SubTP.ControlContext = &Status;
1681 it = GetNewHashPos(List, 0);
1682 while (GetNextHashPos(List, it, &Status.KeyLen, &Status.Key, &vContext)) {
1683 if (DetectGroupChange && Status.n > 0) {
1684 Status.GroupChange = (SortBy->GroupChange(vContext, vLastContext))? 1:0;
1686 Status.LastN = ++Status.LastN == nMembersUsed;
1687 SubTP.Context = vContext;
1688 if (It->DoSubTemplate != NULL)
1689 It->DoSubTemplate(SubBuf, &SubTP);
1690 DoTemplate(TKEY(1), SubBuf, &SubTP);
1692 StrBufAppendBuf(Target, SubBuf, 0);
1693 FlushStrBuf(SubBuf);
1694 Status.oddeven = ! Status.oddeven;
1695 vLastContext = vContext;
1697 FreeStrBuf(&SubBuf);
1699 if (It->Destructor != NULL)
1700 It->Destructor(&List);
1704 int conditional_ITERATE_ISGROUPCHANGE(StrBuf *Target, WCTemplputParams *TP)
1706 IterateStruct *Ctx = CCTX;
1707 return Ctx->GroupChange;
1710 void tmplput_ITERATE_ODDEVEN(StrBuf *Target, WCTemplputParams *TP)
1712 IterateStruct *Ctx = CCTX;
1714 StrBufAppendBufPlain(Target, HKEY("odd"), 0);
1716 StrBufAppendBufPlain(Target, HKEY("even"), 0);
1720 void tmplput_ITERATE_KEY(StrBuf *Target, WCTemplputParams *TP)
1722 IterateStruct *Ctx = CCTX;
1724 StrBufAppendBufPlain(Target, Ctx->Key, Ctx->KeyLen, 0);
1728 void tmplput_ITERATE_LASTN(StrBuf *Target, WCTemplputParams *TP)
1730 IterateStruct *Ctx = CCTX;
1731 StrBufAppendPrintf(Target, "%d", Ctx->n);
1734 int conditional_ITERATE_LASTN(StrBuf *Target, WCTemplputParams *TP)
1736 IterateStruct *Ctx = CCTX;
1742 /*-----------------------------------------------------------------------------
1745 int EvaluateConditional(StrBuf *Target, int Neg, int state, WCTemplputParams *TP)
1747 ConditionalStruct *Cond;
1749 if ((TP->Tokens->Params[0]->len == 1) &&
1750 (TP->Tokens->Params[0]->Start[0] == 'X'))
1751 return (state != 0)?TP->Tokens->Params[1]->lvalue:0;
1753 Cond = (ConditionalStruct *) TP->Tokens->PreEval;
1756 Target, "Conditional", ERR_PARM1, TP,
1761 if (!CheckContext(Target, &Cond->Filter, TP, "Conditional")) {
1765 if (Cond->CondF(Target, TP) == Neg)
1766 return TP->Tokens->Params[1]->lvalue;
1770 int ConditionalVar(StrBuf *Target, WCTemplputParams *TP)
1775 if (!GetHash(WC->vars, TKEY(2), &vsubst))
1777 subst = (wcsubst*) vsubst;
1779 switch(subst->wcs_type) {
1781 return (subst->wcs_function!=NULL);
1783 lprintf(1, " -> Server [%s]\n", subst->wcs_value);/* TODO */
1787 case WCS_STRBUF_REF:
1788 if (TP->Tokens->nParameters < 4)
1790 return (strcmp(TP->Tokens->Params[3]->Start, ChrPtr(subst->wcs_value)) == 0);
1792 if (TP->Tokens->nParameters < 4)
1793 return (subst->lvalue != 0);
1794 return (subst->lvalue == TP->Tokens->Params[3]->lvalue);
1796 lprintf(1," WARNING: invalid type: [%ld]!\n", subst->wcs_type);
1802 void RegisterConditional(const char *Name, long len,
1804 WCConditionalFunc CondF,
1805 int ContextRequired)
1807 ConditionalStruct *Cond = (ConditionalStruct*)malloc(sizeof(ConditionalStruct));
1808 Cond->PlainName = Name;
1809 Cond->Filter.nMaxArgs = nParams;
1810 Cond->Filter.nMinArgs = nParams;
1811 Cond->CondF = CondF;
1812 Cond->Filter.ContextType = ContextRequired;
1813 Cond->Filter.ControlContextType = CTX_NONE;
1814 Put(Conditionals, Name, len, Cond, NULL);
1817 void RegisterControlConditional(const char *Name, long len,
1819 WCConditionalFunc CondF,
1820 int ControlContextRequired)
1822 ConditionalStruct *Cond = (ConditionalStruct*)malloc(sizeof(ConditionalStruct));
1823 Cond->PlainName = Name;
1824 Cond->Filter.nMaxArgs = nParams;
1825 Cond->Filter.nMinArgs = nParams;
1826 Cond->CondF = CondF;
1827 Cond->Filter.ContextType = CTX_NONE;
1828 Cond->Filter.ControlContextType = ControlContextRequired;
1829 Put(Conditionals, Name, len, Cond, NULL);
1832 /*-----------------------------------------------------------------------------
1835 void tmplput_ContextString(StrBuf *Target, WCTemplputParams *TP)
1837 StrBufAppendTemplate(Target, TP, (StrBuf*)CTX, 0);
1839 int ConditionalContextStr(StrBuf *Target, WCTemplputParams *TP)
1841 StrBuf *TokenText = (StrBuf*) CTX;
1842 const char *CompareToken;
1845 GetTemplateTokenString(TP, 2, &CompareToken, &len);
1846 return strcmp(ChrPtr(TokenText), CompareToken) == 0;
1849 /*-----------------------------------------------------------------------------
1853 void tmpl_do_boxed(StrBuf *Target, WCTemplputParams *TP)
1855 WCTemplputParams SubTP;
1858 if (TP->Tokens->nParameters == 2) {
1859 if (TP->Tokens->Params[1]->Type == TYPE_STR) {
1860 Headline = NewStrBuf();
1861 DoTemplate(TKEY(1), Headline, TP);
1866 GetTemplateTokenString(TP,
1870 Headline = NewStrBufPlain(Ch, len);
1873 memcpy (&SubTP, TP, sizeof(WCTemplputParams));
1874 SubTP.Context = Headline;
1875 SubTP.Filter.ContextType = CTX_STRBUF;
1876 DoTemplate(HKEY("beginbox"), Target, &SubTP);
1877 DoTemplate(TKEY(0), Target, TP);
1878 DoTemplate(HKEY("endbox"), Target, TP);
1879 FreeStrBuf(&Headline);
1882 /*-----------------------------------------------------------------------------
1886 void tmpl_do_tabbed(StrBuf *Target, WCTemplputParams *TP)
1889 int i, ntabs, nTabs;
1891 nTabs = ntabs = TP->Tokens->nParameters / 2;
1892 TabNames = (StrBuf **) malloc(ntabs * sizeof(StrBuf*));
1894 for (i = 0; i < ntabs; i++) {
1895 if ((TP->Tokens->Params[i * 2]->Type == TYPE_STR) &&
1896 (TP->Tokens->Params[i * 2]->len > 0)) {
1897 TabNames[i] = NewStrBuf();
1898 DoTemplate(TKEY(i * 2), TabNames[i], TP);
1900 else if (TP->Tokens->Params[i * 2]->Type == TYPE_GETTEXT) {
1903 GetTemplateTokenString(TP,
1907 TabNames[i] = NewStrBufPlain(Ch, -1);
1910 /** A Tab without subject? we can't count that, add it as silent */
1915 StrTabbedDialog(Target, nTabs, TabNames);
1916 for (i = 0; i < ntabs; i++) {
1917 StrBeginTab(Target, i, nTabs);
1918 DoTemplate(TKEY(i * 2 + 1), Target, TP);
1919 StrEndTab(Target, i, nTabs);
1924 /*-----------------------------------------------------------------------------
1929 void RegisterSortFunc(const char *name, long len,
1930 const char *prepend, long preplen,
1931 CompareFunc Forward,
1932 CompareFunc Reverse,
1933 CompareFunc GroupChange,
1936 SortStruct *NewSort = (SortStruct*) malloc(sizeof(SortStruct));
1937 NewSort->Name = NewStrBufPlain(name, len);
1938 if (prepend != NULL)
1939 NewSort->PrefPrepend = NewStrBufPlain(prepend, preplen);
1941 NewSort->PrefPrepend = NULL;
1942 NewSort->Forward = Forward;
1943 NewSort->Reverse = Reverse;
1944 NewSort->GroupChange = GroupChange;
1945 NewSort->ContextType = ContextType;
1946 Put(SortHash, name, len, NewSort, DestroySortStruct);
1949 CompareFunc RetrieveSort(WCTemplputParams *TP,
1950 const char *OtherPrefix, long OtherPrefixLen,
1951 const char *Default, long ldefault, long DefaultDirection)
1954 const StrBuf *BSort = NULL;
1957 long SortOrder = -1;
1959 if (havebstr("SortBy")) {
1960 BSort = sbstr("SortBy");
1961 if (OtherPrefix == NULL) {
1962 set_room_pref("sort", NewStrBufDup(BSort), 0);
1965 set_X_PREFS(HKEY("sort"), OtherPrefix, OtherPrefixLen, NewStrBufDup(BSort), 0);
1968 else { /** Try to fallback to our remembered values... */
1969 if (OtherPrefix == NULL) {
1970 BSort = get_room_pref("sort");
1973 BSort = get_X_PREFS(HKEY("sort"), OtherPrefix, OtherPrefixLen);
1976 putbstr("SortBy", NewStrBufDup(BSort));
1980 BSort = Buf = NewStrBufPlain(Default, ldefault);
1981 putbstr("SortBy", Buf);
1985 if (!GetHash(SortHash, SKEY(BSort), &vSortBy) ||
1986 (vSortBy == NULL)) {
1988 if (!GetHash(SortHash, Default, ldefault, &vSortBy) ||
1989 (vSortBy == NULL)) {
1991 NULL, "Sorting", ERR_PARM1, TP,
1992 "Illegal default sort: [%s]", Default);
1996 SortBy = (SortStruct*)vSortBy;
1998 /** Ok, its us, lets see in which direction we should sort... */
1999 if (havebstr("SortOrder")) {
2000 SortOrder = LBSTR("SortOrder");
2002 else { /** Try to fallback to our remembered values... */
2004 if (SortBy->PrefPrepend == NULL) {
2005 Buf = get_room_pref("SortOrder");
2006 SortOrder = StrTol(Buf);
2009 BSort = get_X_PREFS(HKEY("SortOrder"), OtherPrefix, OtherPrefixLen);
2013 SortOrder = DefaultDirection;
2015 Buf = NewStrBufPlain(NULL, 64);
2016 StrBufPrintf(Buf, "%ld", SortOrder);
2017 putbstr("SortOrder", Buf);
2019 switch (SortOrder) {
2024 return SortBy->Forward;
2026 return SortBy->Reverse;
2038 ConstStr SortIcons[] = {
2039 {HKEY("static/sort_none.gif")},
2040 {HKEY("static/up_pointer.gif")},
2041 {HKEY("static/down_pointer.gif")},
2044 ConstStr SortNextOrder[] = {
2051 int GetSortMetric(WCTemplputParams *TP, SortStruct **Next, SortStruct **Param, long *SortOrder, int N)
2053 int bSortError = eNOT_SPECIFIED;
2054 const StrBuf *BSort;
2059 if (!GetHash(SortHash, TKEY(0), &vSort) ||
2061 return eNO_SUCH_SORT;
2062 *Param = (SortStruct*) vSort;
2065 if (havebstr("SortBy")) {
2066 BSort = sbstr("SortBy");
2067 bSortError = eINVALID_PARAM;
2068 if ((*Param)->PrefPrepend == NULL) {
2069 set_room_pref("sort", NewStrBufDup(BSort), 0);
2072 set_X_PREFS(HKEY("sort"), TKEY(N), NewStrBufDup(BSort), 0);
2075 else { /** Try to fallback to our remembered values... */
2076 if ((*Param)->PrefPrepend == NULL) {
2077 BSort = get_room_pref("sort");
2080 BSort = get_X_PREFS(HKEY("sort"), TKEY(N));
2084 if (!GetHash(SortHash, SKEY(BSort), &vSort) ||
2088 *Next = (SortStruct*) vSort;
2090 /** Ok, its us, lets see in which direction we should sort... */
2091 if (havebstr("SortOrder")) {
2092 *SortOrder = LBSTR("SortOrder");
2094 else { /** Try to fallback to our remembered values... */
2095 if ((*Param)->PrefPrepend == NULL) {
2096 *SortOrder = StrTol(get_room_pref("SortOrder"));
2099 *SortOrder = StrTol(get_X_PREFS(HKEY("SortOrder"), TKEY(N)));
2109 void tmplput_SORT_ICON(StrBuf *Target, WCTemplputParams *TP)
2114 const ConstStr *SortIcon;
2116 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2119 Target, "Sorter", ERR_PARM1, TP,
2120 " Sorter [%s] unknown!",
2121 TP->Tokens->Params[0]->Start);
2123 case eINVALID_PARAM:
2124 LogTemplateError(NULL, "Sorter", ERR_PARM1, TP,
2125 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2127 case eNOT_SPECIFIED:
2129 if (Next == Param) {
2130 SortIcon = &SortIcons[SortOrder];
2132 else { /** Not Us... */
2133 SortIcon = &SortIcons[0];
2135 StrBufAppendBufPlain(Target, SortIcon->Key, SortIcon->len, 0);
2139 void tmplput_SORT_NEXT(StrBuf *Target, WCTemplputParams *TP)
2145 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2148 Target, "Sorter", ERR_PARM1, TP,
2149 " Sorter [%s] unknown!",
2150 TP->Tokens->Params[0]->Start);
2152 case eINVALID_PARAM:
2154 NULL, "Sorter", ERR_PARM1, TP,
2155 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2157 case eNOT_SPECIFIED:
2159 StrBufAppendBuf(Target, Param->Name, 0);
2164 void tmplput_SORT_ORDER(StrBuf *Target, WCTemplputParams *TP)
2167 const ConstStr *SortOrderStr;
2171 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2174 Target, "Sorter", ERR_PARM1, TP,
2175 " Sorter [%s] unknown!",
2176 TP->Tokens->Params[0]->Start);
2178 case eINVALID_PARAM:
2180 NULL, "Sorter", ERR_PARM1, TP,
2181 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2183 case eNOT_SPECIFIED:
2185 if (Next == Param) {
2186 SortOrderStr = &SortNextOrder[SortOrder];
2188 else { /** Not Us... */
2189 SortOrderStr = &SortNextOrder[0];
2191 StrBufAppendBufPlain(Target, SortOrderStr->Key, SortOrderStr->len, 0);
2196 void tmplput_long_vector(StrBuf *Target, WCTemplputParams *TP)
2198 long *LongVector = (long*) CTX;
2200 if ((TP->Tokens->Params[0]->Type == TYPE_LONG) &&
2201 (TP->Tokens->Params[0]->lvalue <= LongVector[0]))
2203 StrBufAppendPrintf(Target, "%ld", LongVector[TP->Tokens->Params[0]->lvalue]);
2207 if (TP->Tokens->Params[0]->Type != TYPE_LONG) {
2209 Target, "Longvector", ERR_NAME, TP,
2210 "needs a numerical Parameter!");
2214 Target, "LongVector", ERR_PARM1, TP,
2215 "doesn't have %ld Parameters, its just the size of %ld!",
2216 TP->Tokens->Params[0]->lvalue,
2222 void dbg_print_longvector(long *LongVector)
2224 StrBuf *Buf = NewStrBufPlain(HKEY("Longvector: ["));
2225 int nItems = LongVector[0];
2228 for (i = 0; i < nItems; i++) {
2230 StrBufAppendPrintf(Buf, "%d: %ld | ", i, LongVector[i]);
2232 StrBufAppendPrintf(Buf, "%d: %ld]\n", i, LongVector[i]);
2235 lprintf(1, ChrPtr(Buf));
2239 int ConditionalLongVector(StrBuf *Target, WCTemplputParams *TP)
2241 long *LongVector = (long*) CTX;
2243 if ((TP->Tokens->Params[2]->Type == TYPE_LONG) &&
2244 (TP->Tokens->Params[2]->lvalue <= LongVector[0])&&
2245 (TP->Tokens->Params[3]->Type == TYPE_LONG) &&
2246 (TP->Tokens->Params[3]->lvalue <= LongVector[0]))
2248 return LongVector[TP->Tokens->Params[2]->lvalue] ==
2249 LongVector[TP->Tokens->Params[3]->lvalue];
2253 if ((TP->Tokens->Params[2]->Type == TYPE_LONG) ||
2254 (TP->Tokens->Params[2]->Type == TYPE_LONG)) {
2256 Target, "ConditionalLongvector", ERR_PARM1, TP,
2257 "needs two long Parameter!");
2261 Target, "Longvector", ERR_PARM1, TP,
2262 "doesn't have %ld / %ld Parameters, its just the size of %ld!",
2263 TP->Tokens->Params[2]->lvalue,
2264 TP->Tokens->Params[3]->lvalue,
2275 memset(&NoCtx, 0, sizeof(WCTemplputParams));
2276 RegisterNamespace("SORT:ICON", 1, 2, tmplput_SORT_ICON, CTX_NONE);
2277 RegisterNamespace("SORT:ORDER", 1, 2, tmplput_SORT_ORDER, CTX_NONE);
2278 RegisterNamespace("SORT:NEXT", 1, 2, tmplput_SORT_NEXT, CTX_NONE);
2279 RegisterNamespace("CONTEXTSTR", 0, 1, tmplput_ContextString, CTX_STRBUF);
2280 RegisterNamespace("ITERATE", 2, 100, tmpl_iterate_subtmpl, CTX_NONE);
2281 RegisterNamespace("DOBOXED", 1, 2, tmpl_do_boxed, CTX_NONE);
2282 RegisterNamespace("DOTABBED", 2, 100, tmpl_do_tabbed, CTX_NONE);
2283 RegisterNamespace("LONGVECTOR", 1, 1, tmplput_long_vector, CTX_LONGVECTOR);
2284 RegisterConditional(HKEY("COND:SUBST"), 3, ConditionalVar, CTX_NONE);
2285 RegisterConditional(HKEY("COND:CONTEXTSTR"), 3, ConditionalContextStr, CTX_STRBUF);
2286 RegisterConditional(HKEY("COND:LONGVECTOR"), 4, ConditionalLongVector, CTX_LONGVECTOR);
2288 RegisterControlConditional(HKEY("COND:ITERATE:ISGROUPCHANGE"), 2,
2289 conditional_ITERATE_ISGROUPCHANGE,
2291 RegisterControlConditional(HKEY("COND:ITERATE:LASTN"), 2,
2292 conditional_ITERATE_LASTN,
2294 RegisterControlNS(HKEY("ITERATE:ODDEVEN"), 0, 0, tmplput_ITERATE_ODDEVEN, CTX_ITERATE);
2295 RegisterControlNS(HKEY("ITERATE:KEY"), 0, 0, tmplput_ITERATE_KEY, CTX_ITERATE);
2296 RegisterControlNS(HKEY("ITERATE:N"), 0, 0, tmplput_ITERATE_LASTN, CTX_ITERATE);