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 {
57 WCHandlerFunc HandlerFunc;
60 void *load_template(StrBuf *filename, StrBuf *Key, HashList *PutThere);
61 int EvaluateConditional(StrBuf *Target, int Neg, int state, WCTemplputParams *TP);
63 typedef struct _SortStruct {
68 CompareFunc GroupChange;
73 void DestroySortStruct(void *vSort)
75 SortStruct *Sort = (SortStruct*) vSort;
76 FreeStrBuf(&Sort->Name);
77 FreeStrBuf(&Sort->PrefPrepend);
81 void LogTemplateError (StrBuf *Target, const char *Type, int ErrorPos, WCTemplputParams *TP, const char *Format, ...)
86 const char *Err = NULL;
91 va_start(arg_ptr, Format);
92 StrBufVAppendPrintf(Error, Format, arg_ptr);
97 case ERR_NAME: /* the main token name... */
98 Err = TP->Tokens->pName;
101 Err = TP->Tokens->Params[0]->Start;
104 Err = TP->Tokens->Params[1]->Start;
107 lprintf(1, "%s [%s] (in '%s' line %ld); %s; [%s]\n",
110 ChrPtr(TP->Tokens->FileName),
113 ChrPtr(TP->Tokens->FlatToken));
114 if (Target != NULL) {
117 "<pre>\n%s [%s] (in '%s' line %ld); %s\n[%s]\n</pre>\n",
120 ChrPtr(TP->Tokens->FileName),
123 ChrPtr(TP->Tokens->FlatToken));
128 void RegisterNS(const char *NSName,
132 WCHandlerFunc HandlerFunc,
135 HashHandler *NewHandler;
137 NewHandler = (HashHandler*) malloc(sizeof(HashHandler));
138 NewHandler->nMinArgs = nMinArgs;
139 NewHandler->nMaxArgs = nMaxArgs;
140 NewHandler->HandlerFunc = HandlerFunc;
141 NewHandler->ContextRequired = ContextRequired;
142 Put(GlobalNS, NSName, len, NewHandler, NULL);
145 void FreeToken(WCTemplateToken **Token)
148 FreeStrBuf(&(*Token)->FlatToken);
149 if ((*Token)->HaveParameters)
150 for (i = 0; i < (*Token)->nParameters; i++)
151 free((*Token)->Params[i]);
158 void FreeWCTemplate(void *vFreeMe)
161 WCTemplate *FreeMe = (WCTemplate*)vFreeMe;
163 if (FreeMe->TokenSpace > 0) {
164 for (i = 0; i < FreeMe->nTokensUsed; i ++) {
165 FreeToken(&FreeMe->Tokens[i]);
167 free(FreeMe->Tokens);
169 FreeStrBuf(&FreeMe->FileName);
170 FreeStrBuf(&FreeMe->Data);
176 * \brief debugging function to print array to log
178 void VarPrintTransition(void *vVar1, void *vVar2, int odd){}
180 * \brief debugging function to print array to log
182 void VarPrintEntry(const char *Key, void *vSubst, int odd)
185 lprintf(1,"Subst[%s] : ", Key);
186 ptr = (wcsubst*) vSubst;
188 switch(ptr->wcs_type) {
190 lprintf(1, " -> %s\n", ChrPtr(ptr->wcs_value));
193 lprintf(1, " -> Server [%s]\n", ChrPtr(ptr->wcs_value));
196 lprintf(1, " -> function at [%0xd]\n", ptr->wcs_function);
199 lprintf(1," WARNING: invalid type: [%ld]!\n", ptr->wcs_type);
206 * \brief Clear out the list of substitution variables local to this session
208 void clear_substs(wcsession *wc) {
210 if (wc->vars != NULL) {
211 DeleteHash(&wc->vars);
216 * \brief Clear out the list of substitution variables local to this session
218 void clear_local_substs(void) {
237 void FlushPayload(wcsubst *ptr, int reusestrbuf, int type)
239 int NeedNew = NeedNewBuf(type);
240 switch(ptr->wcs_type) {
244 if (reusestrbuf && NeedNew) {
245 FlushStrBuf(ptr->wcs_value);
249 FreeStrBuf(&ptr->wcs_value);
250 ptr->wcs_value = NULL;
254 ptr->wcs_function = NULL;
255 if (reusestrbuf && NeedNew)
256 ptr->wcs_value = NewStrBuf();
259 ptr->wcs_value = NULL;
260 if (reusestrbuf && NeedNew)
261 ptr->wcs_value = NewStrBuf();
265 if (reusestrbuf && NeedNew)
266 ptr->wcs_value = NewStrBuf();
269 if (reusestrbuf && NeedNew)
270 ptr->wcs_value = NewStrBuf();
277 * \brief destructor; kill one entry.
279 void deletevar(void *data)
281 wcsubst *ptr = (wcsubst*)data;
282 FlushPayload(ptr, 0, ptr->wcs_type);
287 wcsubst *NewSubstVar(const char *keyname, int keylen, int type)
292 ptr = (wcsubst *) malloc(sizeof(wcsubst));
293 memset(ptr, 0, sizeof(wcsubst));
295 ptr->wcs_type = type;
296 safestrncpy(ptr->wcs_key, keyname, sizeof ptr->wcs_key);
297 Put(WCC->vars, keyname, keylen, ptr, deletevar);
299 switch(ptr->wcs_type) {
302 ptr->wcs_value = NewStrBuf();
316 * \brief Add a substitution variable (local to this session) (strlen version...)
317 * \param keyname the replacementstring to substitute
318 * \param keytype the kind of the key
319 * \param format the format string ala printf
320 * \param ... the arguments to substitute in the formatstring
322 void SVPRINTF(char *keyname, int keytype, const char *format,...)
330 keylen = strlen(keyname);
332 * First look if we're doing a replacement of
335 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
336 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
337 ptr = (wcsubst*)vPtr;
338 FlushPayload(ptr, keytype, keytype);
339 ptr->wcs_type = keytype;
341 else /** Otherwise allocate a new one */
343 ptr = NewSubstVar(keyname, keylen, keytype);
346 /** Format the string */
347 va_start(arg_ptr, format);
348 StrBufVAppendPrintf(ptr->wcs_value, format, arg_ptr);
353 * \brief Add a substitution variable (local to this session)
354 * \param keyname the replacementstring to substitute
355 * \param keytype the kind of the key
356 * \param format the format string ala printf
357 * \param ... the arguments to substitute in the formatstring
359 void svprintf(char *keyname, size_t keylen, int keytype, const char *format,...)
367 * First look if we're doing a replacement of
370 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
371 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
372 ptr = (wcsubst*)vPtr;
373 FlushPayload(ptr, 1, keytype);
374 ptr->wcs_type = keytype;
376 else /** Otherwise allocate a new one */
378 ptr = NewSubstVar(keyname, keylen, keytype);
381 /** Format the string and save it */
382 va_start(arg_ptr, format);
383 StrBufVAppendPrintf(ptr->wcs_value, format, arg_ptr);
388 * \brief Add a substitution variable (local to this session)
389 * \param keyname the replacementstring to substitute
390 * \param keytype the kind of the key
391 * \param format the format string ala printf
392 * \param ... the arguments to substitute in the formatstring
394 void SVPut(char *keyname, size_t keylen, int keytype, char *Data)
402 * First look if we're doing a replacement of
405 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
406 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
407 ptr = (wcsubst*)vPtr;
408 FlushPayload(ptr, 1, keytype);
409 ptr->wcs_type = keytype;
411 else /** Otherwise allocate a new one */
413 ptr = NewSubstVar(keyname, keylen, keytype);
415 StrBufAppendBufPlain(ptr->wcs_value, Data, -1, 0);
419 * \brief Add a substitution variable (local to this session)
420 * \param keyname the replacementstring to substitute
421 * \param keytype the kind of the key
422 * \param format the format string ala printf
423 * \param ... the arguments to substitute in the formatstring
425 void SVPutLong(char *keyname, size_t keylen, long Data)
433 * First look if we're doing a replacement of
436 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
437 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
438 ptr = (wcsubst*)vPtr;
439 FlushPayload(ptr, 1, WCS_LONG);
440 ptr->wcs_type = WCS_LONG;
442 else /** Otherwise allocate a new one */
444 ptr = NewSubstVar(keyname, keylen, WCS_LONG);
450 * \brief Add a substitution variable (local to this session) that does a callback
451 * \param keyname the keystring to substitute
452 * \param fcn_ptr the function callback to give the substitution string
454 void SVCallback(char *keyname, size_t keylen, WCHandlerFunc fcn_ptr)
461 * First look if we're doing a replacement of
464 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
465 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
466 ptr = (wcsubst*)vPtr;
467 FlushPayload(ptr, 1, WCS_FUNCTION);
468 ptr->wcs_type = WCS_FUNCTION;
470 else /** Otherwise allocate a new one */
472 ptr = NewSubstVar(keyname, keylen, WCS_FUNCTION);
475 ptr->wcs_function = fcn_ptr;
477 inline void SVCALLBACK(char *keyname, WCHandlerFunc fcn_ptr)
479 SVCallback(keyname, strlen(keyname), fcn_ptr);
484 void SVPUTBuf(const char *keyname, int keylen, const StrBuf *Buf, int ref)
491 * First look if we're doing a replacement of
494 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
495 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
496 ptr = (wcsubst*)vPtr;
497 FlushPayload(ptr, 0, (ref)?WCS_STRBUF_REF:WCS_STRBUF);
498 ptr->wcs_type = (ref)?WCS_STRBUF_REF:WCS_STRBUF;
500 else /** Otherwise allocate a new one */
502 ptr = NewSubstVar(keyname, keylen, (ref)?WCS_STRBUF_REF:WCS_STRBUF);
504 ptr->wcs_value = (StrBuf*)Buf;
508 * \brief back end for print_value_of() ... does a server command
509 * \param servcmd server command to execute on the citadel server
511 void pvo_do_cmd(StrBuf *Target, StrBuf *servcmd) {
515 serv_puts(ChrPtr(servcmd));
516 len = serv_getln(buf, sizeof buf);
522 StrBufAppendPrintf(Target, "%s\n", &buf[4]);
525 _fmout(Target, "CENTER");
528 StrBufAppendPrintf(Target, "%s\n", &buf[4]);
534 void GetTemplateTokenString(WCTemplputParams *TP,
541 if (TP->Tokens->nParameters < N) {
542 lprintf(1, "invalid token. this shouldn't have come till here.\n");
549 switch (TP->Tokens->Params[N]->Type) {
552 *Value = TP->Tokens->Params[N]->Start;
553 *len = TP->Tokens->Params[N]->len;
556 Buf = (StrBuf*) SBstr(TKEY(N));
557 *Value = ChrPtr(Buf);
558 *len = StrLength(Buf);
561 get_PREFERENCE(TKEY(N), &Buf);
562 *Value = ChrPtr(Buf);
563 *len = StrLength(Buf);
567 break; /* todo: string to text? */
569 *Value = _(TP->Tokens->Params[N]->Start);
570 *len = strlen(*Value);
581 * \brief Print the value of a variable
582 * \param keyname get a key to print
584 void print_value_of(StrBuf *Target, WCTemplputParams *TP)
591 /*if (WCC->vars != NULL) PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
592 /* TODO: depricated! */
593 if (TP->Tokens->pName[0] == '=') {
594 DoTemplate(TP->Tokens->pName+1, TP->Tokens->NameEnd - 1, NULL, &NoCtx);
596 /*/////TODO: if param[1] == "U" -> urlescape
598 /** Page-local variables */
599 if ((WCC->vars!= NULL) && GetHash(WCC->vars, TP->Tokens->pName, TP->Tokens->NameEnd, &vVar)) {
600 ptr = (wcsubst*) vVar;
601 switch(ptr->wcs_type) {
603 StrBufAppendBuf(Target, ptr->wcs_value, 0);
606 pvo_do_cmd(Target, ptr->wcs_value);
609 (*ptr->wcs_function) (Target, TP);
613 StrBufAppendBuf(Target, ptr->wcs_value, 0);
616 StrBufAppendPrintf(Target, "%ld", ptr->lvalue);
620 Target, "Subst", ERR_NAME, TP,
621 "WARNING: invalid value in SV-Hash at %s!", TP->Tokens->pName);
626 Target, "Token", ERR_NAME, TP,
627 "didn't find Handler");
632 int CompareSubstToToken(TemplateParam *ParamToCompare, TemplateParam *ParamToLookup)
638 if ((WCC->vars!= NULL) && GetHash(WCC->vars, ParamToLookup->Start,
639 ParamToLookup->len, &vVar)) {
640 ptr = (wcsubst*) vVar;
641 switch(ptr->wcs_type) {
645 if (ParamToCompare->Type == TYPE_STR)
646 return ((ParamToCompare->len == StrLength(ptr->wcs_value)) &&
647 (strcmp(ParamToCompare->Start, ChrPtr(ptr->wcs_value)) == 0));
649 return ParamToCompare->lvalue == StrTol(ptr->wcs_value);
657 if (ParamToCompare->Type == TYPE_STR)
660 return ParamToCompare->lvalue == ptr->lvalue;
663 lprintf(1,"WARNING: invalid value in SV-Hash at %s!\n",
664 ParamToLookup->Start);
670 int CompareSubstToStrBuf(StrBuf *Compare, TemplateParam *ParamToLookup)
676 if ((WCC->vars!= NULL) && GetHash(WCC->vars, ParamToLookup->Start,
677 ParamToLookup->len, &vVar)) {
678 ptr = (wcsubst*) vVar;
679 switch(ptr->wcs_type) {
683 return ((StrLength(Compare) == StrLength(ptr->wcs_value)) &&
684 (strcmp(ChrPtr(Compare), ChrPtr(ptr->wcs_value)) == 0));
691 return StrTol(Compare) == ptr->lvalue;
693 lprintf(1,"WARNING: invalid value in SV-Hash at %s!\n",
694 ParamToLookup->Start);
703 * \brief puts string into the template and computes which escape methon we should use
704 * \param Source the string we should put into the template
705 * \param FormatTypeIndex where should we look for escape types if?
707 void StrBufAppendTemplate(StrBuf *Target,
708 WCTemplputParams *TP,
709 const StrBuf *Source, int FormatTypeIndex)
715 if ((FormatTypeIndex < TP->Tokens->nParameters) &&
716 (TP->Tokens->Params[FormatTypeIndex]->Type == TYPE_STR) &&
717 (TP->Tokens->Params[FormatTypeIndex]->len == 1)) {
718 EscapeAs = *TP->Tokens->Params[FormatTypeIndex]->Start;
725 Buf = NewStrBufPlain(NULL, StrLength(Source));
726 StrBuf_RFC822_to_Utf8(Buf,
728 (WCC!=NULL)? WCC->DefaultCharset : NULL,
730 StrEscAppend(Target, Buf, NULL, 0, 0);
734 StrEscAppend(Target, Source, NULL, 0, 0);
737 StrBufAppendBuf(Target, Source, 0);
742 void PutNewToken(WCTemplate *Template, WCTemplateToken *NewToken)
744 if (Template->nTokensUsed + 1 >= Template->TokenSpace) {
745 if (Template->TokenSpace <= 0) {
746 Template->Tokens = (WCTemplateToken**)malloc(
747 sizeof(WCTemplateToken*) * 10);
748 Template->TokenSpace = 10;
751 WCTemplateToken **NewTokens;
752 NewTokens= (WCTemplateToken**)malloc(
753 sizeof(WCTemplateToken*) *
754 Template->TokenSpace * 2);
755 memcpy(NewTokens, Template->Tokens,
756 sizeof(WCTemplateToken*) * Template->nTokensUsed);
757 free(Template->Tokens);
758 Template->TokenSpace *= 2;
759 Template->Tokens = NewTokens;
762 Template->Tokens[(Template->nTokensUsed)++] = NewToken;
765 TemplateParam *GetNextParameter(StrBuf *Buf, const char **pCh, const char *pe, WCTemplateToken *Tokens, WCTemplate *pTmpl)
767 const char *pch = *pCh;
768 const char *pchs, *pche;
769 TemplateParam *Parm = (TemplateParam *) malloc(sizeof(TemplateParam));
773 Parm->Type = TYPE_STR;
775 /* Skip leading whitespaces */
776 while ((*pch == ' ' )||
779 (*pch == '\n')) pch ++;
782 Parm->Type = TYPE_PREFSTR;
785 else if (*pch == ';') {
786 Parm->Type = TYPE_PREFINT;
789 else if (*pch == '_') {
790 Parm->Type = TYPE_GETTEXT;
795 else if (*pch == 'B') {
796 Parm->Type = TYPE_BSTR;
803 else if (*pch == '\'')
810 ( (pch > pchs) && (*(pch - 1) == '\\'))
816 lprintf(1, "Error (in '%s' line %ld); "
817 "evaluating template param [%s] in Token [%s]\n",
818 ChrPtr(pTmpl->FileName),
820 ChrPtr(Tokens->FlatToken),
827 StrBufPeek(Buf, pch, -1, '\0');
828 if (LoadTemplates > 1) {
829 lprintf(1, "DBG: got param [%s] %ld %ld\n",
830 pchs, pche - pchs, strlen(pchs));
833 Parm->len = pche - pchs;
834 pch ++; /* move after trailing quote */
835 if ((Parm->Type == TYPE_GETTEXT) && (*pch == ')')) {
842 Parm->Type = TYPE_LONG;
844 while ((pch <= pe) &&
851 StrBufPeek(Buf, pch, -1, '\0');
852 Parm->lvalue = atol(pchs);
859 lprintf(1, "Error (in '%s' line %ld); "
860 "evaluating long template param [%s] in Token [%s]\n",
861 ChrPtr(pTmpl->FileName),
863 ChrPtr(Tokens->FlatToken),
870 while ((*pch == ' ' )||
874 (*pch == '\n')) pch ++;
880 WCTemplateToken *NewTemplateSubstitute(StrBuf *Buf,
882 const char *pTmplStart,
883 const char *pTmplEnd,
889 TemplateParam *Param;
890 WCTemplateToken *NewToken = (WCTemplateToken*)malloc(sizeof(WCTemplateToken));
893 TP.Tokens = NewToken;
894 NewToken->FileName = pTmpl->FileName; /* to print meaningfull log messages... */
896 NewToken->Line = Line + 1;
897 NewToken->pTokenStart = pTmplStart;
898 NewToken->TokenStart = pTmplStart - pStart;
899 NewToken->TokenEnd = (pTmplEnd - pStart) - NewToken->TokenStart;
900 NewToken->pTokenEnd = pTmplEnd;
901 NewToken->NameEnd = NewToken->TokenEnd - 2;
902 NewToken->PreEval = NULL;
903 NewToken->FlatToken = NewStrBufPlain(pTmplStart + 2, pTmplEnd - pTmplStart - 2);
905 StrBufPeek(Buf, pTmplStart, + 1, '\0');
906 StrBufPeek(Buf, pTmplEnd, -1, '\0');
907 pch = NewToken->pName = pTmplStart + 2;
909 NewToken->HaveParameters = 0;;
910 NewToken->nParameters = 0;
912 while (pch < pTmplEnd - 1) {
914 StrBufPeek(Buf, pch, -1, '\0');
915 NewToken->NameEnd = pch - NewToken->pName;
917 if (*(pTmplEnd - 1) != ')') {
919 NULL, "Parseerror", ERR_NAME, &TP,
920 "Warning, Non welformed Token; missing right parenthesis");
922 while (pch < pTmplEnd - 1) {
923 Param = GetNextParameter(Buf, &pch, pTmplEnd - 1, NewToken, pTmpl);
925 NewToken->HaveParameters = 1;
926 if (NewToken->nParameters > MAXPARAM) {
928 NULL, "Parseerror", ERR_NAME, &TP,
929 "only [%ld] Params allowed in Tokens",
933 FreeToken(&NewToken);
936 NewToken->Params[NewToken->nParameters++] = Param;
940 if((NewToken->NameEnd == 1) &&
941 (NewToken->HaveParameters == 1))
944 if (*(NewToken->pName) == '_')
945 NewToken->Flags = SV_GETTEXT;
946 else if (*(NewToken->pName) == '=')
947 NewToken->Flags = SV_SUBTEMPL;
948 else if (*(NewToken->pName) == '%')
949 NewToken->Flags = SV_CUST_STR_CONDITIONAL;
950 else if (*(NewToken->pName) == '?')
951 NewToken->Flags = SV_CONDITIONAL;
952 else if (*(NewToken->pName) == '!')
953 NewToken->Flags = SV_NEG_CONDITIONAL;
959 switch (NewToken->Flags) {
961 /* If we're able to find out more about the token, do it now while its fresh. */
962 if (GetHash(GlobalNS, NewToken->pName, NewToken->NameEnd, &vVar)) {
963 HashHandler *Handler;
964 Handler = (HashHandler*) vVar;
965 if ((NewToken->nParameters < Handler->nMinArgs) ||
966 (NewToken->nParameters > Handler->nMaxArgs)) {
968 NULL, "Token", ERR_NAME, &TP,
969 "doesn't work with %ld params",
970 NewToken->nParameters);
974 NewToken->PreEval = Handler;
975 NewToken->Flags = SV_PREEVALUATED;
980 if (NewToken->nParameters !=1) {
982 NULL, "Gettext", ERR_NAME, &TP,
983 "requires exactly 1 parameter, you gave %ld params",
984 NewToken->nParameters);
990 if (NewToken->nParameters != 1) {
992 NULL, "Subtemplates", ERR_NAME, &TP,
993 "require exactly 1 parameter, you gave %ld params",
994 NewToken->nParameters);
998 case SV_CUST_STR_CONDITIONAL:
1000 case SV_NEG_CONDITIONAL:
1001 if (NewToken->nParameters <2) {
1003 NULL, "Conditional", ERR_NAME, &TP,
1004 "require at least 2 parameters, you gave %ld params",
1005 NewToken->nParameters);
1006 NewToken->Flags = 0;
1009 if (NewToken->Params[1]->lvalue == 0) {
1011 NULL, "Conditional", ERR_NAME, &TP,
1012 "Conditional ID (Parameter 1) mustn't be 0!");
1013 NewToken->Flags = 0;
1016 if (!GetHash(Conditionals,
1017 NewToken->Params[0]->Start,
1018 NewToken->Params[0]->len,
1021 if ((NewToken->Params[0]->len == 1) &&
1022 (NewToken->Params[0]->Start[0] == 'X'))
1025 NULL, "Conditional", ERR_NAME, &TP,
1028 NewToken->Error = NewStrBuf();
1031 "<pre>\nConditional [%s] (in '%s' line %ld); Not found!\n[%s]\n</pre>\n",
1032 NewToken->Params[0]->Start,
1033 ChrPtr(pTmpl->FileName),
1035 ChrPtr(NewToken->FlatToken));
1039 NewToken->PreEval = vVar;
1051 * \brief Display a variable-substituted template
1052 * \param templatename template file to load
1054 void *prepare_template(StrBuf *filename, StrBuf *Key, HashList *PutThere)
1056 WCTemplate *NewTemplate;
1057 NewTemplate = (WCTemplate *) malloc(sizeof(WCTemplate));
1058 NewTemplate->Data = NULL;
1059 NewTemplate->FileName = NewStrBufDup(filename);
1060 NewTemplate->nTokensUsed = 0;
1061 NewTemplate->TokenSpace = 0;
1062 NewTemplate->Tokens = NULL;
1064 Put(PutThere, ChrPtr(Key), StrLength(Key), NewTemplate, FreeWCTemplate);
1069 * \brief Display a variable-substituted template
1070 * \param templatename template file to load
1072 void *load_template(StrBuf *filename, StrBuf *Key, HashList *PutThere)
1075 struct stat statbuf;
1076 const char *pS, *pE, *pch, *Err;
1079 WCTemplate *NewTemplate;
1081 fd = open(ChrPtr(filename), O_RDONLY);
1083 lprintf(1, "ERROR: could not open template '%s' - %s\n",
1084 ChrPtr(filename), strerror(errno));
1088 if (fstat(fd, &statbuf) == -1) {
1089 lprintf(1, "ERROR: could not stat template '%s' - %s\n",
1090 ChrPtr(filename), strerror(errno));
1094 NewTemplate = (WCTemplate *) malloc(sizeof(WCTemplate));
1095 NewTemplate->Data = NewStrBufPlain(NULL, statbuf.st_size);
1096 NewTemplate->FileName = NewStrBufDup(filename);
1097 NewTemplate->nTokensUsed = 0;
1098 NewTemplate->TokenSpace = 0;
1099 NewTemplate->Tokens = NULL;
1100 if (StrBufReadBLOB(NewTemplate->Data, &fd, 1, statbuf.st_size, &Err) < 0) {
1102 FreeWCTemplate(NewTemplate);
1103 lprintf(1, "ERROR: reading template '%s' - %s<br />\n",
1104 ChrPtr(filename), strerror(errno));
1110 pS = pch = ChrPtr(NewTemplate->Data);
1111 pE = pS + StrLength(NewTemplate->Data);
1113 const char *pts, *pte;
1115 int InDoubleQuotes = 0;
1117 /** Find one <? > */
1119 for (; pch < pE; pch ++) {
1120 if ((*pch=='<')&&(*(pch + 1)=='?'))
1122 if (*pch=='\n') Line ++;
1128 /** Found one? parse it. */
1129 for (; pch <= pE - 1; pch ++) {
1131 InDoubleQuotes = ! InDoubleQuotes;
1132 else if (*pch == '\'')
1133 InQuotes = ! InQuotes;
1134 else if ((!InQuotes && !InDoubleQuotes) &&
1135 ((*pch!='\\')&&(*(pch + 1)=='>'))) {
1143 PutNewToken(NewTemplate,
1144 NewTemplateSubstitute(NewTemplate->Data, pS, pts, pte, Line, NewTemplate));
1147 if (LoadTemplates == 0)
1148 Put(PutThere, ChrPtr(Key), StrLength(Key), NewTemplate, FreeWCTemplate);
1153 const char* PrintTemplate(void *vSubst)
1155 WCTemplate *Tmpl = vSubst;
1157 return ChrPtr(Tmpl->FileName);
1161 int LoadTemplateDir(const char *DirName, HashList *wireless, HashList *big)
1166 DIR *filedir = NULL;
1167 struct dirent *filedir_entry;
1173 StrBufPrintf(Dir, "%s/t", DirName);
1174 filedir = opendir (ChrPtr(Dir));
1175 if (filedir == NULL) {
1180 FileName = NewStrBuf();
1182 while ((filedir_entry = readdir(filedir)))
1186 #ifdef _DIRENT_HAVE_D_NAMELEN
1187 d_namelen = filedir_entry->d_namelen;
1189 d_namelen = strlen(filedir_entry->d_name);
1191 d_without_ext = d_namelen;
1192 while ((d_without_ext > 0) && (filedir_entry->d_name[d_without_ext] != '.'))
1194 if ((d_without_ext == 0) || (d_namelen < 3))
1196 if ((d_namelen > 1) && filedir_entry->d_name[d_namelen - 1] == '~')
1197 continue; /* Ignore backup files... */
1199 IsMobile = (strstr(filedir_entry->d_name, ".m.html")!= NULL);
1200 PStart = filedir_entry->d_name;
1201 StrBufPrintf(FileName, "%s/%s", ChrPtr(Dir), filedir_entry->d_name);
1202 MinorPtr = strchr(filedir_entry->d_name, '.');
1203 if (MinorPtr != NULL)
1205 StrBufPlain(Tag, filedir_entry->d_name, MinorPtr - filedir_entry->d_name);
1207 if (LoadTemplates > 1)
1208 lprintf(1, "%s %d %s\n",ChrPtr(FileName), IsMobile, ChrPtr(Tag));
1209 if (LoadTemplates == 0)
1210 load_template(FileName, Tag, (IsMobile)?wireless:big);
1212 prepare_template(FileName, Tag, (IsMobile)?wireless:big);
1215 FreeStrBuf(&FileName);
1221 void InitTemplateCache(void)
1223 LoadTemplateDir(static_dirs[0],
1224 WirelessTemplateCache,
1226 LoadTemplateDir(static_dirs[1],
1227 WirelessLocalTemplateCache,
1228 LocalTemplateCache);
1233 /*-----------------------------------------------------------------------------
1234 * Filling & processing Templates
1237 * \brief executes one token
1238 * \param Target buffer to append to
1239 * \param Token da to process.
1240 * \param Template we're iterating
1241 * \param Context Contextpoointer to pass in
1242 * \param state are we in conditional state?
1243 * \param ContextType what type of information does context giv us?
1245 int EvaluateToken(StrBuf *Target, int state, WCTemplputParams *TP)
1247 const char *AppendMe;
1249 HashHandler *Handler;
1251 /* much output, since pName is not terminated...
1252 lprintf(1,"Doing token: %s\n",Token->pName);
1255 switch (TP->Tokens->Flags) {
1257 TmplGettext(Target, TP);
1259 case SV_CONDITIONAL: /** Forward conditional evaluation */
1260 return EvaluateConditional(Target, 1, state, TP);
1262 case SV_NEG_CONDITIONAL: /** Reverse conditional evaluation */
1263 return EvaluateConditional(Target, 0, state, TP);
1265 case SV_CUST_STR_CONDITIONAL: /** Conditional put custom strings from params */
1266 if (TP->Tokens->nParameters >= 6) {
1267 if (EvaluateConditional(Target, 0, state, TP)) {
1268 GetTemplateTokenString(TP, 5, &AppendMe, &AppendMeLen);
1269 StrBufAppendBufPlain(Target,
1275 GetTemplateTokenString(TP, 4, &AppendMe, &AppendMeLen);
1276 StrBufAppendBufPlain(Target,
1284 Target, "Conditional", ERR_NAME, TP,
1285 "needs at least 6 Params!");
1289 if (TP->Tokens->nParameters == 1)
1290 DoTemplate(TKEY(0), NULL, TP);
1292 case SV_PREEVALUATED:
1293 Handler = (HashHandler*) TP->Tokens->PreEval;
1294 if ((Handler->ContextRequired != CTX_NONE) &&
1295 (Handler->ContextRequired != TP->ContextType)) {
1297 Target, "Token", ERR_NAME, TP,
1298 "requires context of type %ld, have %ld",
1299 Handler->ContextRequired,
1304 Handler->HandlerFunc(Target, TP);
1307 if (GetHash(GlobalNS, TP->Tokens->pName, TP->Tokens->NameEnd, &vVar)) {
1308 Handler = (HashHandler*) vVar;
1309 if ((Handler->ContextRequired != CTX_NONE) &&
1310 (Handler->ContextRequired != TP->ContextType)) {
1312 Target, "Token", ERR_NAME, TP,
1313 "requires context of type %ld, have %ld",
1314 Handler->ContextRequired,
1318 else if ((TP->Tokens->nParameters < Handler->nMinArgs) ||
1319 (TP->Tokens->nParameters > Handler->nMaxArgs)) {
1321 Target, "Token", ERR_NAME, TP,
1322 "doesn't work with %ld params need > %ld < %ld",
1323 TP->Tokens->nParameters,
1328 Handler->HandlerFunc(Target, TP);
1332 print_value_of(Target, TP);
1340 void ProcessTemplate(WCTemplate *Tmpl, StrBuf *Target, void *Context, int ContextType)
1342 WCTemplate *pTmpl = Tmpl;
1345 const char *pData, *pS;
1347 WCTemplputParams TP;
1349 TP.Context = Context;
1350 TP.ContextType = ContextType;
1352 if (LoadTemplates != 0) {
1353 if (LoadTemplates > 1)
1354 lprintf(1, "DBG: ----- loading: [%s] ------ \n",
1355 ChrPtr(Tmpl->FileName));
1357 pTmpl = load_template(Tmpl->FileName, NULL, NULL);
1361 "<pre>\nError loading Template [%s]\n See Logfile for details\n</pre>\n",
1362 ChrPtr(Tmpl->FileName));
1368 pS = pData = ChrPtr(pTmpl->Data);
1369 len = StrLength(pTmpl->Data);
1373 if (i >= pTmpl->nTokensUsed) {
1374 StrBufAppendBufPlain(Target,
1376 len - (pData - pS), 0);
1380 StrBufAppendBufPlain(
1382 pTmpl->Tokens[i]->pTokenStart - pData, 0);
1383 TP.Tokens = pTmpl->Tokens[i];
1384 TP.nArgs = pTmpl->Tokens[i]->nParameters;
1385 state = EvaluateToken(Target, state, &TP);
1387 while ((state != 0) && (i+1 < pTmpl->nTokensUsed)) {
1388 /* condition told us to skip till its end condition */
1390 TP.Tokens = pTmpl->Tokens[i];
1391 TP.nArgs = pTmpl->Tokens[i]->nParameters;
1392 if ((pTmpl->Tokens[i]->Flags == SV_CONDITIONAL) ||
1393 (pTmpl->Tokens[i]->Flags == SV_NEG_CONDITIONAL)) {
1394 if (state == EvaluateConditional(
1396 pTmpl->Tokens[i]->Flags,
1402 pData = pTmpl->Tokens[i++]->pTokenEnd + 1;
1403 if (i > pTmpl->nTokensUsed)
1407 if (LoadTemplates != 0) {
1408 FreeWCTemplate(pTmpl);
1413 * \brief Display a variable-substituted template
1414 * \param templatename template file to load
1416 void DoTemplate(const char *templatename, long len, StrBuf *Target, WCTemplputParams *TP)
1419 HashList *StaticLocal;
1424 if (WC->is_mobile) {
1425 Static = WirelessTemplateCache;
1426 StaticLocal = WirelessLocalTemplateCache;
1429 Static = TemplateCache;
1430 StaticLocal = LocalTemplateCache;
1435 lprintf (1, "Can't to load a template with empty name!\n");
1436 StrBufAppendPrintf(Target, "<pre>\nCan't to load a template with empty name!\n</pre>");
1440 if (!GetHash(StaticLocal, templatename, len, &vTmpl) &&
1441 !GetHash(Static, templatename, len, &vTmpl)) {
1442 lprintf (1, "didn't find Template [%s] %ld %ld\n", templatename, len , (long)strlen(templatename));
1443 StrBufAppendPrintf(Target, "<pre>\ndidn't find Template [%s] %ld %ld\n</pre>",
1445 (long)strlen(templatename));
1447 dbg_PrintHash(Static, PrintTemplate, NULL);
1448 PrintHash(Static, VarPrintTransition, PrintTemplate);
1454 ProcessTemplate(vTmpl, Target, TP->Context, TP->ContextType);
1457 /*-----------------------------------------------------------------------------
1460 typedef struct _HashIterator {
1461 HashList *StaticList;
1462 int AdditionalParams;
1464 int XPectContextType;
1466 RetrieveHashlistFunc GetHash;
1467 HashDestructorFunc Destructor;
1468 SubTemplFunc DoSubTemplate;
1471 void RegisterITERATOR(const char *Name, long len,
1472 int AdditionalParams,
1473 HashList *StaticList,
1474 RetrieveHashlistFunc GetHash,
1475 SubTemplFunc DoSubTempl,
1476 HashDestructorFunc Destructor,
1478 int XPectContextType,
1481 HashIterator *It = (HashIterator*)malloc(sizeof(HashIterator));
1482 It->StaticList = StaticList;
1483 It->AdditionalParams = AdditionalParams;
1484 It->GetHash = GetHash;
1485 It->DoSubTemplate = DoSubTempl;
1486 It->Destructor = Destructor;
1487 It->ContextType = ContextType;
1488 It->XPectContextType = XPectContextType;
1490 Put(Iterators, Name, len, It, NULL);
1493 void tmpl_iterate_subtmpl(StrBuf *Target, WCTemplputParams *TP)
1499 SortStruct *SortBy = NULL;
1501 int DetectGroupChange = 0;
1503 int nMembersCounted = 0;
1507 void *vLastContext = NULL;
1510 WCTemplputParams SubTP;
1512 memcpy (&SubTP, &TP, sizeof(WCTemplputParams));
1514 if (!GetHash(Iterators, TKEY(0), &vIt)) {
1516 Target, "Iterator", ERR_PARM1, TP, "Unknown!");
1520 It = (HashIterator*) vIt;
1522 if (TP->Tokens->nParameters < It->AdditionalParams + 2) {
1524 Target, "Iterator", ERR_PARM1, TP,
1525 "doesn't work with %ld params",
1526 TP->Tokens->nParameters);
1530 if ((It->XPectContextType != CTX_NONE) &&
1531 (It->XPectContextType != TP->ContextType)) {
1533 Target, "Iterator", ERR_PARM1, TP,
1534 "requires context of type %ld, have %ld",
1535 It->XPectContextType,
1541 if (It->StaticList == NULL)
1542 List = It->GetHash(Target, TP);
1544 List = It->StaticList;
1546 DetectGroupChange = (It->Flags & IT_FLAG_DETECT_GROUPCHANGE) != 0;
1547 if (DetectGroupChange) {
1548 const StrBuf *BSort;
1549 DetectGroupChange = 0;
1550 if (havebstr("SortBy")) {
1551 BSort = sbstr("SortBy");
1552 if (GetHash(SortHash, SKEY(BSort), &vSortBy) &&
1553 (vSortBy != NULL)) {
1554 SortBy = (SortStruct*)vSortBy;
1555 /** Ok, its us, lets see in which direction we should sort... */
1556 if (havebstr("SortOrder")) {
1558 SortOrder = LBSTR("SortOrder");
1560 DetectGroupChange = 1;
1565 nMembersUsed = GetCount(List);
1566 SubBuf = NewStrBuf();
1567 SubTP.ContextType = It->ContextType;
1568 it = GetNewHashPos(List, 0);
1569 while (GetNextHashPos(List, it, &len, &Key, &vContext)) {
1570 if (DetectGroupChange && nMembersCounted > 0) {
1571 if (SortBy->GroupChange(vContext, vLastContext))
1572 svputlong("ITERATE:ISGROUPCHANGE", 1);
1574 svputlong("ITERATE:ISGROUPCHANGE", 0);
1576 svprintf(HKEY("ITERATE:ODDEVEN"), WCS_STRING, "%s",
1577 (oddeven) ? "odd" : "even");
1578 svprintf(HKEY("ITERATE:KEY"), WCS_STRING, "%s", Key);
1579 svputlong("ITERATE:N", nMembersCounted);
1580 svputlong("ITERATE:LASTN", ++nMembersCounted == nMembersUsed);
1581 SubTP.Context = vContext;
1582 if (It->DoSubTemplate != NULL)
1583 It->DoSubTemplate(SubBuf, &SubTP);
1584 DoTemplate(TKEY(1), SubBuf, &SubTP);
1586 StrBufAppendBuf(Target, SubBuf, 0);
1587 FlushStrBuf(SubBuf);
1588 oddeven = ~ oddeven;
1589 vLastContext = vContext;
1591 FreeStrBuf(&SubBuf);
1593 if (It->Destructor != NULL)
1594 It->Destructor(&List);
1599 /*-----------------------------------------------------------------------------
1602 int EvaluateConditional(StrBuf *Target, int Neg, int state, WCTemplputParams *TP)
1604 ConditionalStruct *Cond;
1606 if ((TP->Tokens->Params[0]->len == 1) &&
1607 (TP->Tokens->Params[0]->Start[0] == 'X'))
1608 return (state != 0)?TP->Tokens->Params[1]->lvalue:0;
1610 Cond = (ConditionalStruct *) TP->Tokens->PreEval;
1613 Target, "Conditional", ERR_PARM1, TP,
1618 if (TP->Tokens->nParameters < Cond->nParams) {
1620 Target, "Conditional", ERR_PARM1, TP,
1621 "needs %ld Params, have %ld!",
1623 TP->Tokens->nParameters);
1626 if (Cond->CondF(Target, TP) == Neg)
1627 return TP->Tokens->Params[1]->lvalue;
1631 int ConditionalVar(StrBuf *Target, WCTemplputParams *TP)
1636 if (!GetHash(WC->vars, TKEY(2), &vsubst))
1638 subst = (wcsubst*) vsubst;
1639 if ((subst->ContextRequired != CTX_NONE) &&
1640 (subst->ContextRequired != TP->ContextType)) {
1642 Target, "ConditionalVar", ERR_PARM1, TP,
1643 " WARNING: Conditional requires Context: [%ld], have [%ld]!",
1644 subst->ContextRequired, CTX);
1648 switch(subst->wcs_type) {
1650 return (subst->wcs_function!=NULL);
1652 lprintf(1, " -> Server [%s]\n", subst->wcs_value);/* TODO */
1656 case WCS_STRBUF_REF:
1657 if (TP->Tokens->nParameters < 4)
1659 return (strcmp(TP->Tokens->Params[3]->Start, ChrPtr(subst->wcs_value)) == 0);
1661 if (TP->Tokens->nParameters < 4)
1662 return (subst->lvalue != 0);
1663 return (subst->lvalue == TP->Tokens->Params[3]->lvalue);
1665 lprintf(1," WARNING: invalid type: [%ld]!\n", subst->wcs_type);
1672 void RegisterConditional(const char *Name, long len,
1674 WCConditionalFunc CondF,
1675 int ContextRequired)
1677 ConditionalStruct *Cond = (ConditionalStruct*)malloc(sizeof(ConditionalStruct));
1678 Cond->PlainName = Name;
1679 Cond->nParams = nParams;
1680 Cond->CondF = CondF;
1681 Cond->ContextRequired = ContextRequired;
1682 Put(Conditionals, Name, len, Cond, NULL);
1685 /*-----------------------------------------------------------------------------
1688 void tmplput_ContextString(StrBuf *Target, WCTemplputParams *TP)
1690 StrBufAppendTemplate(Target, TP, (StrBuf*)CTX, 0);
1692 int ConditionalContextStr(StrBuf *Target, WCTemplputParams *TP)
1694 StrBuf *TokenText = (StrBuf*) CTX;
1695 const char *CompareToken;
1698 GetTemplateTokenString(TP, 2, &CompareToken, &len);
1699 return strcmp(ChrPtr(TokenText), CompareToken) == 0;
1702 /*-----------------------------------------------------------------------------
1706 void tmpl_do_boxed(StrBuf *Target, WCTemplputParams *TP)
1708 WCTemplputParams SubTP;
1711 if (TP->Tokens->nParameters == 2) {
1712 if (TP->Tokens->Params[1]->Type == TYPE_STR) {
1713 Headline = NewStrBuf();
1714 DoTemplate(TKEY(1), Headline, TP);
1719 GetTemplateTokenString(TP,
1723 Headline = NewStrBufPlain(Ch, len);
1726 memcpy (&SubTP, TP, sizeof(WCTemplputParams));
1727 SubTP.Context = Headline;
1728 SubTP.ContextType = CTX_STRBUF;
1729 DoTemplate(HKEY("beginbox"), Target, &SubTP);
1730 DoTemplate(TKEY(0), Target, TP);
1731 DoTemplate(HKEY("endbox"), Target, TP);
1732 FreeStrBuf(&Headline);
1735 /*-----------------------------------------------------------------------------
1739 void tmpl_do_tabbed(StrBuf *Target, WCTemplputParams *TP)
1742 int i, ntabs, nTabs;
1744 nTabs = ntabs = TP->Tokens->nParameters / 2;
1745 TabNames = (StrBuf **) malloc(ntabs * sizeof(StrBuf*));
1747 for (i = 0; i < ntabs; i++) {
1748 if ((TP->Tokens->Params[i * 2]->Type == TYPE_STR) &&
1749 (TP->Tokens->Params[i * 2]->len > 0)) {
1750 TabNames[i] = NewStrBuf();
1751 DoTemplate(TKEY(i * 2), TabNames[i], TP);
1753 else if (TP->Tokens->Params[i * 2]->Type == TYPE_GETTEXT) {
1756 GetTemplateTokenString(TP,
1760 TabNames[i] = NewStrBufPlain(Ch, -1);
1763 /** A Tab without subject? we can't count that, add it as silent */
1768 StrTabbedDialog(Target, nTabs, TabNames);
1769 for (i = 0; i < ntabs; i++) {
1770 StrBeginTab(Target, i, nTabs);
1771 DoTemplate(TKEY(i * 2 + 1), Target, TP);
1772 StrEndTab(Target, i, nTabs);
1777 /*-----------------------------------------------------------------------------
1782 void RegisterSortFunc(const char *name, long len,
1783 const char *prepend, long preplen,
1784 CompareFunc Forward,
1785 CompareFunc Reverse,
1786 CompareFunc GroupChange,
1789 SortStruct *NewSort = (SortStruct*) malloc(sizeof(SortStruct));
1790 NewSort->Name = NewStrBufPlain(name, len);
1791 if (prepend != NULL)
1792 NewSort->PrefPrepend = NewStrBufPlain(prepend, preplen);
1794 NewSort->PrefPrepend = NULL;
1795 NewSort->Forward = Forward;
1796 NewSort->Reverse = Reverse;
1797 NewSort->GroupChange = GroupChange;
1798 NewSort->ContextType = ContextType;
1799 Put(SortHash, name, len, NewSort, DestroySortStruct);
1802 CompareFunc RetrieveSort(WCTemplputParams *TP,
1803 const char *OtherPrefix, long OtherPrefixLen,
1804 const char *Default, long ldefault, long DefaultDirection)
1807 const StrBuf *BSort = NULL;
1810 long SortOrder = -1;
1812 if (havebstr("SortBy")) {
1813 BSort = sbstr("SortBy");
1814 if (OtherPrefix == NULL) {
1815 set_room_pref("sort", NewStrBufDup(BSort), 0);
1818 set_X_PREFS(HKEY("sort"), OtherPrefix, OtherPrefixLen, NewStrBufDup(BSort), 0);
1821 else { /** Try to fallback to our remembered values... */
1822 if (OtherPrefix == NULL) {
1823 BSort = get_room_pref("sort");
1826 BSort = get_X_PREFS(HKEY("sort"), OtherPrefix, OtherPrefixLen);
1829 putbstr("SortBy", NewStrBufDup(BSort));
1833 BSort = Buf = NewStrBufPlain(Default, ldefault);
1834 putbstr("SortBy", Buf);
1838 if (!GetHash(SortHash, SKEY(BSort), &vSortBy) ||
1839 (vSortBy == NULL)) {
1841 if (!GetHash(SortHash, Default, ldefault, &vSortBy) ||
1842 (vSortBy == NULL)) {
1844 NULL, "Sorting", ERR_PARM1, TP,
1845 "Illegal default sort: [%s]", Default);
1849 SortBy = (SortStruct*)vSortBy;
1851 /** Ok, its us, lets see in which direction we should sort... */
1852 if (havebstr("SortOrder")) {
1853 SortOrder = LBSTR("SortOrder");
1855 else { /** Try to fallback to our remembered values... */
1857 if (SortBy->PrefPrepend == NULL) {
1858 Buf = get_room_pref("SortOrder");
1859 SortOrder = StrTol(Buf);
1862 BSort = get_X_PREFS(HKEY("SortOrder"), OtherPrefix, OtherPrefixLen);
1866 SortOrder = DefaultDirection;
1868 Buf = NewStrBufPlain(NULL, 64);
1869 StrBufPrintf(Buf, "%ld", SortOrder);
1870 putbstr("SortOrder", Buf);
1872 switch (SortOrder) {
1877 return SortBy->Forward;
1879 return SortBy->Reverse;
1891 ConstStr SortIcons[] = {
1892 {HKEY("static/sort_none.gif")},
1893 {HKEY("static/up_pointer.gif")},
1894 {HKEY("static/down_pointer.gif")},
1897 ConstStr SortNextOrder[] = {
1904 int GetSortMetric(WCTemplputParams *TP, SortStruct **Next, SortStruct **Param, long *SortOrder, int N)
1906 int bSortError = eNOT_SPECIFIED;
1907 const StrBuf *BSort;
1912 if (!GetHash(SortHash, TKEY(0), &vSort) ||
1914 return eNO_SUCH_SORT;
1915 *Param = (SortStruct*) vSort;
1918 if (havebstr("SortBy")) {
1919 BSort = sbstr("SortBy");
1920 bSortError = eINVALID_PARAM;
1921 if ((*Param)->PrefPrepend == NULL) {
1922 set_room_pref("sort", NewStrBufDup(BSort), 0);
1925 set_X_PREFS(HKEY("sort"), TKEY(N), NewStrBufDup(BSort), 0);
1928 else { /** Try to fallback to our remembered values... */
1929 if ((*Param)->PrefPrepend == NULL) {
1930 BSort = get_room_pref("sort");
1933 BSort = get_X_PREFS(HKEY("sort"), TKEY(N));
1937 if (!GetHash(SortHash, SKEY(BSort), &vSort) ||
1941 *Next = (SortStruct*) vSort;
1943 /** Ok, its us, lets see in which direction we should sort... */
1944 if (havebstr("SortOrder")) {
1945 *SortOrder = LBSTR("SortOrder");
1947 else { /** Try to fallback to our remembered values... */
1948 if ((*Param)->PrefPrepend == NULL) {
1949 *SortOrder = StrTol(get_room_pref("SortOrder"));
1952 *SortOrder = StrTol(get_X_PREFS(HKEY("SortOrder"), TKEY(N)));
1962 void tmplput_SORT_ICON(StrBuf *Target, WCTemplputParams *TP)
1967 const ConstStr *SortIcon;
1969 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
1972 Target, "Sorter", ERR_PARM1, TP,
1973 " Sorter [%s] unknown!",
1974 TP->Tokens->Params[0]->Start);
1976 case eINVALID_PARAM:
1977 LogTemplateError(NULL, "Sorter", ERR_PARM1, TP,
1978 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
1980 case eNOT_SPECIFIED:
1982 if (Next == Param) {
1983 SortIcon = &SortIcons[SortOrder];
1985 else { /** Not Us... */
1986 SortIcon = &SortIcons[0];
1988 StrBufAppendBufPlain(Target, SortIcon->Key, SortIcon->len, 0);
1992 void tmplput_SORT_NEXT(StrBuf *Target, WCTemplputParams *TP)
1998 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2001 Target, "Sorter", ERR_PARM1, TP,
2002 " Sorter [%s] unknown!",
2003 TP->Tokens->Params[0]->Start);
2005 case eINVALID_PARAM:
2007 NULL, "Sorter", ERR_PARM1, TP,
2008 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2010 case eNOT_SPECIFIED:
2012 StrBufAppendBuf(Target, Param->Name, 0);
2017 void tmplput_SORT_ORDER(StrBuf *Target, WCTemplputParams *TP)
2020 const ConstStr *SortOrderStr;
2024 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2027 Target, "Sorter", ERR_PARM1, TP,
2028 " Sorter [%s] unknown!",
2029 TP->Tokens->Params[0]->Start);
2031 case eINVALID_PARAM:
2033 NULL, "Sorter", ERR_PARM1, TP,
2034 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2036 case eNOT_SPECIFIED:
2038 if (Next == Param) {
2039 SortOrderStr = &SortNextOrder[SortOrder];
2041 else { /** Not Us... */
2042 SortOrderStr = &SortNextOrder[0];
2044 StrBufAppendBufPlain(Target, SortOrderStr->Key, SortOrderStr->len, 0);
2049 void tmplput_long_vector(StrBuf *Target, WCTemplputParams *TP)
2051 long *LongVector = (long*) CTX;
2053 if ((TP->Tokens->Params[0]->Type == TYPE_LONG) &&
2054 (TP->Tokens->Params[0]->lvalue <= LongVector[0]))
2056 StrBufAppendPrintf(Target, "%ld", LongVector[TP->Tokens->Params[0]->lvalue]);
2060 if (TP->Tokens->Params[0]->Type != TYPE_LONG) {
2062 Target, "Longvector", ERR_NAME, TP,
2063 "needs a numerical Parameter!");
2067 Target, "LongVector", ERR_PARM1, TP,
2068 "doesn't have %ld Parameters, its just the size of %ld!",
2069 TP->Tokens->Params[0]->lvalue,
2075 void dbg_print_longvector(long *LongVector)
2077 StrBuf *Buf = NewStrBufPlain(HKEY("Longvector: ["));
2078 int nItems = LongVector[0];
2081 for (i = 0; i < nItems; i++) {
2083 StrBufAppendPrintf(Buf, "%d: %ld | ", i, LongVector[i]);
2085 StrBufAppendPrintf(Buf, "%d: %ld]\n", i, LongVector[i]);
2088 lprintf(1, ChrPtr(Buf));
2092 int ConditionalLongVector(StrBuf *Target, WCTemplputParams *TP)
2094 long *LongVector = (long*) CTX;
2096 if ((TP->Tokens->Params[2]->Type == TYPE_LONG) &&
2097 (TP->Tokens->Params[2]->lvalue <= LongVector[0])&&
2098 (TP->Tokens->Params[3]->Type == TYPE_LONG) &&
2099 (TP->Tokens->Params[3]->lvalue <= LongVector[0]))
2101 return LongVector[TP->Tokens->Params[2]->lvalue] ==
2102 LongVector[TP->Tokens->Params[3]->lvalue];
2106 if ((TP->Tokens->Params[2]->Type == TYPE_LONG) ||
2107 (TP->Tokens->Params[2]->Type == TYPE_LONG)) {
2109 Target, "ConditionalLongvector", ERR_PARM1, TP,
2110 "needs two long Parameter!");
2114 Target, "Longvector", ERR_PARM1, TP,
2115 "doesn't have %ld / %ld Parameters, its just the size of %ld!",
2116 TP->Tokens->Params[2]->lvalue,
2117 TP->Tokens->Params[3]->lvalue,
2128 memset(&NoCtx, 0, sizeof(WCTemplputParams));
2129 RegisterNamespace("SORT:ICON", 1, 2, tmplput_SORT_ICON, CTX_NONE);
2130 RegisterNamespace("SORT:ORDER", 1, 2, tmplput_SORT_ORDER, CTX_NONE);
2131 RegisterNamespace("SORT:NEXT", 1, 2, tmplput_SORT_NEXT, CTX_NONE);
2132 RegisterNamespace("CONTEXTSTR", 0, 1, tmplput_ContextString, CTX_STRBUF);
2133 RegisterNamespace("ITERATE", 2, 100, tmpl_iterate_subtmpl, CTX_NONE);
2134 RegisterNamespace("DOBOXED", 1, 2, tmpl_do_boxed, CTX_NONE);
2135 RegisterNamespace("DOTABBED", 2, 100, tmpl_do_tabbed, CTX_NONE);
2136 RegisterNamespace("LONGVECTOR", 1, 1, tmplput_long_vector, CTX_LONGVECTOR);
2137 RegisterConditional(HKEY("COND:SUBST"), 3, ConditionalVar, CTX_NONE);
2138 RegisterConditional(HKEY("COND:CONTEXTSTR"), 3, ConditionalContextStr, CTX_STRBUF);
2139 RegisterConditional(HKEY("COND:LONGVECTOR"), 4, ConditionalLongVector, CTX_LONGVECTOR);