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 StrECMAEscAppend(Target, Source, NULL);
740 StrBufAppendBuf(Target, Source, 0);
745 void PutNewToken(WCTemplate *Template, WCTemplateToken *NewToken)
747 if (Template->nTokensUsed + 1 >= Template->TokenSpace) {
748 if (Template->TokenSpace <= 0) {
749 Template->Tokens = (WCTemplateToken**)malloc(
750 sizeof(WCTemplateToken*) * 10);
751 Template->TokenSpace = 10;
754 WCTemplateToken **NewTokens;
755 NewTokens= (WCTemplateToken**)malloc(
756 sizeof(WCTemplateToken*) *
757 Template->TokenSpace * 2);
758 memcpy(NewTokens, Template->Tokens,
759 sizeof(WCTemplateToken*) * Template->nTokensUsed);
760 free(Template->Tokens);
761 Template->TokenSpace *= 2;
762 Template->Tokens = NewTokens;
765 Template->Tokens[(Template->nTokensUsed)++] = NewToken;
768 TemplateParam *GetNextParameter(StrBuf *Buf, const char **pCh, const char *pe, WCTemplateToken *Tokens, WCTemplate *pTmpl)
770 const char *pch = *pCh;
771 const char *pchs, *pche;
772 TemplateParam *Parm = (TemplateParam *) malloc(sizeof(TemplateParam));
776 Parm->Type = TYPE_STR;
778 /* Skip leading whitespaces */
779 while ((*pch == ' ' )||
782 (*pch == '\n')) pch ++;
785 Parm->Type = TYPE_PREFSTR;
792 else if (*pch == ';') {
793 Parm->Type = TYPE_PREFINT;
800 else if (*pch == '_') {
801 Parm->Type = TYPE_GETTEXT;
808 else if (*pch == 'B') {
809 Parm->Type = TYPE_BSTR;
820 else if (*pch == '\'')
827 ( (pch > pchs) && (*(pch - 1) == '\\'))
833 lprintf(1, "Error (in '%s' line %ld); "
834 "evaluating template param [%s] in Token [%s]\n",
835 ChrPtr(pTmpl->FileName),
837 ChrPtr(Tokens->FlatToken),
844 StrBufPeek(Buf, pch, -1, '\0');
845 if (LoadTemplates > 1) {
846 lprintf(1, "DBG: got param [%s] %ld %ld\n",
847 pchs, pche - pchs, strlen(pchs));
850 Parm->len = pche - pchs;
851 pch ++; /* move after trailing quote */
852 if (ParamBrace && (*pch == ')')) {
859 Parm->Type = TYPE_LONG;
861 while ((pch <= pe) &&
868 StrBufPeek(Buf, pch, -1, '\0');
869 Parm->lvalue = atol(pchs);
876 lprintf(1, "Error (in '%s' line %ld); "
877 "evaluating long template param [%s] in Token [%s]\n",
878 ChrPtr(pTmpl->FileName),
880 ChrPtr(Tokens->FlatToken),
887 while ((*pch == ' ' )||
891 (*pch == '\n')) pch ++;
897 WCTemplateToken *NewTemplateSubstitute(StrBuf *Buf,
899 const char *pTmplStart,
900 const char *pTmplEnd,
906 TemplateParam *Param;
907 WCTemplateToken *NewToken = (WCTemplateToken*)malloc(sizeof(WCTemplateToken));
910 TP.Tokens = NewToken;
911 NewToken->FileName = pTmpl->FileName; /* to print meaningfull log messages... */
913 NewToken->Line = Line + 1;
914 NewToken->pTokenStart = pTmplStart;
915 NewToken->TokenStart = pTmplStart - pStart;
916 NewToken->TokenEnd = (pTmplEnd - pStart) - NewToken->TokenStart;
917 NewToken->pTokenEnd = pTmplEnd;
918 NewToken->NameEnd = NewToken->TokenEnd - 2;
919 NewToken->PreEval = NULL;
920 NewToken->FlatToken = NewStrBufPlain(pTmplStart + 2, pTmplEnd - pTmplStart - 2);
922 StrBufPeek(Buf, pTmplStart, + 1, '\0');
923 StrBufPeek(Buf, pTmplEnd, -1, '\0');
924 pch = NewToken->pName = pTmplStart + 2;
926 NewToken->HaveParameters = 0;;
927 NewToken->nParameters = 0;
929 while (pch < pTmplEnd - 1) {
931 StrBufPeek(Buf, pch, -1, '\0');
932 NewToken->NameEnd = pch - NewToken->pName;
934 if (*(pTmplEnd - 1) != ')') {
936 NULL, "Parseerror", ERR_NAME, &TP,
937 "Warning, Non welformed Token; missing right parenthesis");
939 while (pch < pTmplEnd - 1) {
940 Param = GetNextParameter(Buf, &pch, pTmplEnd - 1, NewToken, pTmpl);
942 NewToken->HaveParameters = 1;
943 if (NewToken->nParameters > MAXPARAM) {
945 NULL, "Parseerror", ERR_NAME, &TP,
946 "only [%ld] Params allowed in Tokens",
950 FreeToken(&NewToken);
953 NewToken->Params[NewToken->nParameters++] = Param;
957 if((NewToken->NameEnd == 1) &&
958 (NewToken->HaveParameters == 1))
961 if (*(NewToken->pName) == '_')
962 NewToken->Flags = SV_GETTEXT;
963 else if (*(NewToken->pName) == '=')
964 NewToken->Flags = SV_SUBTEMPL;
965 else if (*(NewToken->pName) == '%')
966 NewToken->Flags = SV_CUST_STR_CONDITIONAL;
967 else if (*(NewToken->pName) == '?')
968 NewToken->Flags = SV_CONDITIONAL;
969 else if (*(NewToken->pName) == '!')
970 NewToken->Flags = SV_NEG_CONDITIONAL;
976 switch (NewToken->Flags) {
978 /* If we're able to find out more about the token, do it now while its fresh. */
979 if (GetHash(GlobalNS, NewToken->pName, NewToken->NameEnd, &vVar)) {
980 HashHandler *Handler;
981 Handler = (HashHandler*) vVar;
982 if ((NewToken->nParameters < Handler->nMinArgs) ||
983 (NewToken->nParameters > Handler->nMaxArgs)) {
985 NULL, "Token", ERR_NAME, &TP,
986 "doesn't work with %ld params",
987 NewToken->nParameters);
991 NewToken->PreEval = Handler;
992 NewToken->Flags = SV_PREEVALUATED;
997 if (NewToken->nParameters !=1) {
999 NULL, "Gettext", ERR_NAME, &TP,
1000 "requires exactly 1 parameter, you gave %ld params",
1001 NewToken->nParameters);
1002 NewToken->Flags = 0;
1007 if (NewToken->nParameters != 1) {
1009 NULL, "Subtemplates", ERR_NAME, &TP,
1010 "require exactly 1 parameter, you gave %ld params",
1011 NewToken->nParameters);
1015 case SV_CUST_STR_CONDITIONAL:
1016 case SV_CONDITIONAL:
1017 case SV_NEG_CONDITIONAL:
1018 if (NewToken->nParameters <2) {
1020 NULL, "Conditional", ERR_NAME, &TP,
1021 "require at least 2 parameters, you gave %ld params",
1022 NewToken->nParameters);
1023 NewToken->Flags = 0;
1026 if (NewToken->Params[1]->lvalue == 0) {
1028 NULL, "Conditional", ERR_NAME, &TP,
1029 "Conditional ID (Parameter 1) mustn't be 0!");
1030 NewToken->Flags = 0;
1033 if (!GetHash(Conditionals,
1034 NewToken->Params[0]->Start,
1035 NewToken->Params[0]->len,
1038 if ((NewToken->Params[0]->len == 1) &&
1039 (NewToken->Params[0]->Start[0] == 'X'))
1042 NULL, "Conditional", ERR_NAME, &TP,
1045 NewToken->Error = NewStrBuf();
1048 "<pre>\nConditional [%s] (in '%s' line %ld); Not found!\n[%s]\n</pre>\n",
1049 NewToken->Params[0]->Start,
1050 ChrPtr(pTmpl->FileName),
1052 ChrPtr(NewToken->FlatToken));
1056 NewToken->PreEval = vVar;
1068 * \brief Display a variable-substituted template
1069 * \param templatename template file to load
1071 void *prepare_template(StrBuf *filename, StrBuf *Key, HashList *PutThere)
1073 WCTemplate *NewTemplate;
1074 NewTemplate = (WCTemplate *) malloc(sizeof(WCTemplate));
1075 NewTemplate->Data = NULL;
1076 NewTemplate->FileName = NewStrBufDup(filename);
1077 NewTemplate->nTokensUsed = 0;
1078 NewTemplate->TokenSpace = 0;
1079 NewTemplate->Tokens = NULL;
1081 Put(PutThere, ChrPtr(Key), StrLength(Key), NewTemplate, FreeWCTemplate);
1086 * \brief Display a variable-substituted template
1087 * \param templatename template file to load
1089 void *load_template(StrBuf *filename, StrBuf *Key, HashList *PutThere)
1092 struct stat statbuf;
1093 const char *pS, *pE, *pch, *Err;
1096 WCTemplate *NewTemplate;
1098 fd = open(ChrPtr(filename), O_RDONLY);
1100 lprintf(1, "ERROR: could not open template '%s' - %s\n",
1101 ChrPtr(filename), strerror(errno));
1105 if (fstat(fd, &statbuf) == -1) {
1106 lprintf(1, "ERROR: could not stat template '%s' - %s\n",
1107 ChrPtr(filename), strerror(errno));
1111 NewTemplate = (WCTemplate *) malloc(sizeof(WCTemplate));
1112 NewTemplate->Data = NewStrBufPlain(NULL, statbuf.st_size);
1113 NewTemplate->FileName = NewStrBufDup(filename);
1114 NewTemplate->nTokensUsed = 0;
1115 NewTemplate->TokenSpace = 0;
1116 NewTemplate->Tokens = NULL;
1117 if (StrBufReadBLOB(NewTemplate->Data, &fd, 1, statbuf.st_size, &Err) < 0) {
1119 FreeWCTemplate(NewTemplate);
1120 lprintf(1, "ERROR: reading template '%s' - %s<br />\n",
1121 ChrPtr(filename), strerror(errno));
1127 pS = pch = ChrPtr(NewTemplate->Data);
1128 pE = pS + StrLength(NewTemplate->Data);
1130 const char *pts, *pte;
1132 int InDoubleQuotes = 0;
1134 /** Find one <? > */
1136 for (; pch < pE; pch ++) {
1137 if ((*pch=='<')&&(*(pch + 1)=='?'))
1139 if (*pch=='\n') Line ++;
1145 /** Found one? parse it. */
1146 for (; pch <= pE - 1; pch ++) {
1148 InDoubleQuotes = ! InDoubleQuotes;
1149 else if (*pch == '\'')
1150 InQuotes = ! InQuotes;
1151 else if ((!InQuotes && !InDoubleQuotes) &&
1152 ((*pch!='\\')&&(*(pch + 1)=='>'))) {
1160 PutNewToken(NewTemplate,
1161 NewTemplateSubstitute(NewTemplate->Data, pS, pts, pte, Line, NewTemplate));
1164 if (LoadTemplates == 0)
1165 Put(PutThere, ChrPtr(Key), StrLength(Key), NewTemplate, FreeWCTemplate);
1170 const char* PrintTemplate(void *vSubst)
1172 WCTemplate *Tmpl = vSubst;
1174 return ChrPtr(Tmpl->FileName);
1178 int LoadTemplateDir(const char *DirName, HashList *wireless, HashList *big)
1183 DIR *filedir = NULL;
1184 struct dirent *filedir_entry;
1190 StrBufPrintf(Dir, "%s/t", DirName);
1191 filedir = opendir (ChrPtr(Dir));
1192 if (filedir == NULL) {
1197 FileName = NewStrBuf();
1199 while ((filedir_entry = readdir(filedir)))
1203 #ifdef _DIRENT_HAVE_D_NAMELEN
1204 d_namelen = filedir_entry->d_namelen;
1206 d_namelen = strlen(filedir_entry->d_name);
1208 d_without_ext = d_namelen;
1209 while ((d_without_ext > 0) && (filedir_entry->d_name[d_without_ext] != '.'))
1211 if ((d_without_ext == 0) || (d_namelen < 3))
1213 if ((d_namelen > 1) && filedir_entry->d_name[d_namelen - 1] == '~')
1214 continue; /* Ignore backup files... */
1216 IsMobile = (strstr(filedir_entry->d_name, ".m.html")!= NULL);
1217 PStart = filedir_entry->d_name;
1218 StrBufPrintf(FileName, "%s/%s", ChrPtr(Dir), filedir_entry->d_name);
1219 MinorPtr = strchr(filedir_entry->d_name, '.');
1220 if (MinorPtr != NULL)
1222 StrBufPlain(Tag, filedir_entry->d_name, MinorPtr - filedir_entry->d_name);
1224 if (LoadTemplates > 1)
1225 lprintf(1, "%s %d %s\n",ChrPtr(FileName), IsMobile, ChrPtr(Tag));
1226 if (LoadTemplates == 0)
1227 load_template(FileName, Tag, (IsMobile)?wireless:big);
1229 prepare_template(FileName, Tag, (IsMobile)?wireless:big);
1232 FreeStrBuf(&FileName);
1238 void InitTemplateCache(void)
1240 LoadTemplateDir(static_dirs[0],
1241 WirelessTemplateCache,
1243 LoadTemplateDir(static_dirs[1],
1244 WirelessLocalTemplateCache,
1245 LocalTemplateCache);
1250 /*-----------------------------------------------------------------------------
1251 * Filling & processing Templates
1254 * \brief executes one token
1255 * \param Target buffer to append to
1256 * \param Token da to process.
1257 * \param Template we're iterating
1258 * \param Context Contextpoointer to pass in
1259 * \param state are we in conditional state?
1260 * \param ContextType what type of information does context giv us?
1262 int EvaluateToken(StrBuf *Target, int state, WCTemplputParams *TP)
1264 const char *AppendMe;
1266 HashHandler *Handler;
1268 /* much output, since pName is not terminated...
1269 lprintf(1,"Doing token: %s\n",Token->pName);
1272 switch (TP->Tokens->Flags) {
1274 TmplGettext(Target, TP);
1276 case SV_CONDITIONAL: /** Forward conditional evaluation */
1277 return EvaluateConditional(Target, 1, state, TP);
1279 case SV_NEG_CONDITIONAL: /** Reverse conditional evaluation */
1280 return EvaluateConditional(Target, 0, state, TP);
1282 case SV_CUST_STR_CONDITIONAL: /** Conditional put custom strings from params */
1283 if (TP->Tokens->nParameters >= 6) {
1284 if (EvaluateConditional(Target, 0, state, TP)) {
1285 GetTemplateTokenString(TP, 5, &AppendMe, &AppendMeLen);
1286 StrBufAppendBufPlain(Target,
1292 GetTemplateTokenString(TP, 4, &AppendMe, &AppendMeLen);
1293 StrBufAppendBufPlain(Target,
1301 Target, "Conditional", ERR_NAME, TP,
1302 "needs at least 6 Params!");
1306 if (TP->Tokens->nParameters == 1)
1307 DoTemplate(TKEY(0), NULL, TP);
1309 case SV_PREEVALUATED:
1310 Handler = (HashHandler*) TP->Tokens->PreEval;
1311 if ((Handler->ContextRequired != CTX_NONE) &&
1312 (Handler->ContextRequired != TP->ContextType)) {
1314 Target, "Token", ERR_NAME, TP,
1315 "requires context of type %ld, have %ld",
1316 Handler->ContextRequired,
1321 Handler->HandlerFunc(Target, TP);
1324 if (GetHash(GlobalNS, TP->Tokens->pName, TP->Tokens->NameEnd, &vVar)) {
1325 Handler = (HashHandler*) vVar;
1326 if ((Handler->ContextRequired != CTX_NONE) &&
1327 (Handler->ContextRequired != TP->ContextType)) {
1329 Target, "Token", ERR_NAME, TP,
1330 "requires context of type %ld, have %ld",
1331 Handler->ContextRequired,
1335 else if ((TP->Tokens->nParameters < Handler->nMinArgs) ||
1336 (TP->Tokens->nParameters > Handler->nMaxArgs)) {
1338 Target, "Token", ERR_NAME, TP,
1339 "doesn't work with %ld params need > %ld < %ld",
1340 TP->Tokens->nParameters,
1345 Handler->HandlerFunc(Target, TP);
1349 print_value_of(Target, TP);
1357 void ProcessTemplate(WCTemplate *Tmpl, StrBuf *Target, void *Context, int ContextType)
1359 WCTemplate *pTmpl = Tmpl;
1362 const char *pData, *pS;
1364 WCTemplputParams TP;
1366 TP.Context = Context;
1367 TP.ContextType = ContextType;
1369 if (LoadTemplates != 0) {
1370 if (LoadTemplates > 1)
1371 lprintf(1, "DBG: ----- loading: [%s] ------ \n",
1372 ChrPtr(Tmpl->FileName));
1374 pTmpl = load_template(Tmpl->FileName, NULL, NULL);
1378 "<pre>\nError loading Template [%s]\n See Logfile for details\n</pre>\n",
1379 ChrPtr(Tmpl->FileName));
1385 pS = pData = ChrPtr(pTmpl->Data);
1386 len = StrLength(pTmpl->Data);
1390 if (i >= pTmpl->nTokensUsed) {
1391 StrBufAppendBufPlain(Target,
1393 len - (pData - pS), 0);
1397 StrBufAppendBufPlain(
1399 pTmpl->Tokens[i]->pTokenStart - pData, 0);
1400 TP.Tokens = pTmpl->Tokens[i];
1401 TP.nArgs = pTmpl->Tokens[i]->nParameters;
1402 state = EvaluateToken(Target, state, &TP);
1404 while ((state != 0) && (i+1 < pTmpl->nTokensUsed)) {
1405 /* condition told us to skip till its end condition */
1407 TP.Tokens = pTmpl->Tokens[i];
1408 TP.nArgs = pTmpl->Tokens[i]->nParameters;
1409 if ((pTmpl->Tokens[i]->Flags == SV_CONDITIONAL) ||
1410 (pTmpl->Tokens[i]->Flags == SV_NEG_CONDITIONAL)) {
1411 if (state == EvaluateConditional(
1413 pTmpl->Tokens[i]->Flags,
1419 pData = pTmpl->Tokens[i++]->pTokenEnd + 1;
1420 if (i > pTmpl->nTokensUsed)
1424 if (LoadTemplates != 0) {
1425 FreeWCTemplate(pTmpl);
1430 * \brief Display a variable-substituted template
1431 * \param templatename template file to load
1433 void DoTemplate(const char *templatename, long len, StrBuf *Target, WCTemplputParams *TP)
1436 HashList *StaticLocal;
1441 if (WC->is_mobile) {
1442 Static = WirelessTemplateCache;
1443 StaticLocal = WirelessLocalTemplateCache;
1446 Static = TemplateCache;
1447 StaticLocal = LocalTemplateCache;
1452 lprintf (1, "Can't to load a template with empty name!\n");
1453 StrBufAppendPrintf(Target, "<pre>\nCan't to load a template with empty name!\n</pre>");
1457 if (!GetHash(StaticLocal, templatename, len, &vTmpl) &&
1458 !GetHash(Static, templatename, len, &vTmpl)) {
1459 lprintf (1, "didn't find Template [%s] %ld %ld\n", templatename, len , (long)strlen(templatename));
1460 StrBufAppendPrintf(Target, "<pre>\ndidn't find Template [%s] %ld %ld\n</pre>",
1462 (long)strlen(templatename));
1464 dbg_PrintHash(Static, PrintTemplate, NULL);
1465 PrintHash(Static, VarPrintTransition, PrintTemplate);
1471 ProcessTemplate(vTmpl, Target, TP->Context, TP->ContextType);
1474 /*-----------------------------------------------------------------------------
1477 typedef struct _HashIterator {
1478 HashList *StaticList;
1479 int AdditionalParams;
1481 int XPectContextType;
1483 RetrieveHashlistFunc GetHash;
1484 HashDestructorFunc Destructor;
1485 SubTemplFunc DoSubTemplate;
1488 void RegisterITERATOR(const char *Name, long len,
1489 int AdditionalParams,
1490 HashList *StaticList,
1491 RetrieveHashlistFunc GetHash,
1492 SubTemplFunc DoSubTempl,
1493 HashDestructorFunc Destructor,
1495 int XPectContextType,
1498 HashIterator *It = (HashIterator*)malloc(sizeof(HashIterator));
1499 It->StaticList = StaticList;
1500 It->AdditionalParams = AdditionalParams;
1501 It->GetHash = GetHash;
1502 It->DoSubTemplate = DoSubTempl;
1503 It->Destructor = Destructor;
1504 It->ContextType = ContextType;
1505 It->XPectContextType = XPectContextType;
1507 Put(Iterators, Name, len, It, NULL);
1510 void tmpl_iterate_subtmpl(StrBuf *Target, WCTemplputParams *TP)
1516 SortStruct *SortBy = NULL;
1518 int DetectGroupChange = 0;
1520 int nMembersCounted = 0;
1524 void *vLastContext = NULL;
1527 WCTemplputParams SubTP;
1529 memcpy (&SubTP, &TP, sizeof(WCTemplputParams));
1531 if (!GetHash(Iterators, TKEY(0), &vIt)) {
1533 Target, "Iterator", ERR_PARM1, TP, "Unknown!");
1537 It = (HashIterator*) vIt;
1539 if (TP->Tokens->nParameters < It->AdditionalParams + 2) {
1541 Target, "Iterator", ERR_PARM1, TP,
1542 "doesn't work with %ld params",
1543 TP->Tokens->nParameters);
1547 if ((It->XPectContextType != CTX_NONE) &&
1548 (It->XPectContextType != TP->ContextType)) {
1550 Target, "Iterator", ERR_PARM1, TP,
1551 "requires context of type %ld, have %ld",
1552 It->XPectContextType,
1558 if (It->StaticList == NULL)
1559 List = It->GetHash(Target, TP);
1561 List = It->StaticList;
1563 DetectGroupChange = (It->Flags & IT_FLAG_DETECT_GROUPCHANGE) != 0;
1564 if (DetectGroupChange) {
1565 const StrBuf *BSort;
1566 DetectGroupChange = 0;
1567 if (havebstr("SortBy")) {
1568 BSort = sbstr("SortBy");
1569 if (GetHash(SortHash, SKEY(BSort), &vSortBy) &&
1570 (vSortBy != NULL)) {
1571 SortBy = (SortStruct*)vSortBy;
1572 /** Ok, its us, lets see in which direction we should sort... */
1573 if (havebstr("SortOrder")) {
1575 SortOrder = LBSTR("SortOrder");
1577 DetectGroupChange = 1;
1582 nMembersUsed = GetCount(List);
1583 SubBuf = NewStrBuf();
1584 SubTP.ContextType = It->ContextType;
1585 it = GetNewHashPos(List, 0);
1586 while (GetNextHashPos(List, it, &len, &Key, &vContext)) {
1587 if (DetectGroupChange && nMembersCounted > 0) {
1588 if (SortBy->GroupChange(vContext, vLastContext))
1589 svputlong("ITERATE:ISGROUPCHANGE", 1);
1591 svputlong("ITERATE:ISGROUPCHANGE", 0);
1593 svprintf(HKEY("ITERATE:ODDEVEN"), WCS_STRING, "%s",
1594 (oddeven) ? "odd" : "even");
1595 svprintf(HKEY("ITERATE:KEY"), WCS_STRING, "%s", Key);
1596 svputlong("ITERATE:N", nMembersCounted);
1597 svputlong("ITERATE:LASTN", ++nMembersCounted == nMembersUsed);
1598 SubTP.Context = vContext;
1599 if (It->DoSubTemplate != NULL)
1600 It->DoSubTemplate(SubBuf, &SubTP);
1601 DoTemplate(TKEY(1), SubBuf, &SubTP);
1603 StrBufAppendBuf(Target, SubBuf, 0);
1604 FlushStrBuf(SubBuf);
1605 oddeven = ~ oddeven;
1606 vLastContext = vContext;
1608 FreeStrBuf(&SubBuf);
1610 if (It->Destructor != NULL)
1611 It->Destructor(&List);
1616 /*-----------------------------------------------------------------------------
1619 int EvaluateConditional(StrBuf *Target, int Neg, int state, WCTemplputParams *TP)
1621 ConditionalStruct *Cond;
1623 if ((TP->Tokens->Params[0]->len == 1) &&
1624 (TP->Tokens->Params[0]->Start[0] == 'X'))
1625 return (state != 0)?TP->Tokens->Params[1]->lvalue:0;
1627 Cond = (ConditionalStruct *) TP->Tokens->PreEval;
1630 Target, "Conditional", ERR_PARM1, TP,
1635 if (TP->Tokens->nParameters < Cond->nParams) {
1637 Target, "Conditional", ERR_PARM1, TP,
1638 "needs %ld Params, have %ld!",
1640 TP->Tokens->nParameters);
1643 if (Cond->CondF(Target, TP) == Neg)
1644 return TP->Tokens->Params[1]->lvalue;
1648 int ConditionalVar(StrBuf *Target, WCTemplputParams *TP)
1653 if (!GetHash(WC->vars, TKEY(2), &vsubst))
1655 subst = (wcsubst*) vsubst;
1656 if ((subst->ContextRequired != CTX_NONE) &&
1657 (subst->ContextRequired != TP->ContextType)) {
1659 Target, "ConditionalVar", ERR_PARM1, TP,
1660 " WARNING: Conditional requires Context: [%ld], have [%ld]!",
1661 subst->ContextRequired, CTX);
1665 switch(subst->wcs_type) {
1667 return (subst->wcs_function!=NULL);
1669 lprintf(1, " -> Server [%s]\n", subst->wcs_value);/* TODO */
1673 case WCS_STRBUF_REF:
1674 if (TP->Tokens->nParameters < 4)
1676 return (strcmp(TP->Tokens->Params[3]->Start, ChrPtr(subst->wcs_value)) == 0);
1678 if (TP->Tokens->nParameters < 4)
1679 return (subst->lvalue != 0);
1680 return (subst->lvalue == TP->Tokens->Params[3]->lvalue);
1682 lprintf(1," WARNING: invalid type: [%ld]!\n", subst->wcs_type);
1689 void RegisterConditional(const char *Name, long len,
1691 WCConditionalFunc CondF,
1692 int ContextRequired)
1694 ConditionalStruct *Cond = (ConditionalStruct*)malloc(sizeof(ConditionalStruct));
1695 Cond->PlainName = Name;
1696 Cond->nParams = nParams;
1697 Cond->CondF = CondF;
1698 Cond->ContextRequired = ContextRequired;
1699 Put(Conditionals, Name, len, Cond, NULL);
1702 /*-----------------------------------------------------------------------------
1705 void tmplput_ContextString(StrBuf *Target, WCTemplputParams *TP)
1707 StrBufAppendTemplate(Target, TP, (StrBuf*)CTX, 0);
1709 int ConditionalContextStr(StrBuf *Target, WCTemplputParams *TP)
1711 StrBuf *TokenText = (StrBuf*) CTX;
1712 const char *CompareToken;
1715 GetTemplateTokenString(TP, 2, &CompareToken, &len);
1716 return strcmp(ChrPtr(TokenText), CompareToken) == 0;
1719 /*-----------------------------------------------------------------------------
1723 void tmpl_do_boxed(StrBuf *Target, WCTemplputParams *TP)
1725 WCTemplputParams SubTP;
1728 if (TP->Tokens->nParameters == 2) {
1729 if (TP->Tokens->Params[1]->Type == TYPE_STR) {
1730 Headline = NewStrBuf();
1731 DoTemplate(TKEY(1), Headline, TP);
1736 GetTemplateTokenString(TP,
1740 Headline = NewStrBufPlain(Ch, len);
1743 memcpy (&SubTP, TP, sizeof(WCTemplputParams));
1744 SubTP.Context = Headline;
1745 SubTP.ContextType = CTX_STRBUF;
1746 DoTemplate(HKEY("beginbox"), Target, &SubTP);
1747 DoTemplate(TKEY(0), Target, TP);
1748 DoTemplate(HKEY("endbox"), Target, TP);
1749 FreeStrBuf(&Headline);
1752 /*-----------------------------------------------------------------------------
1756 void tmpl_do_tabbed(StrBuf *Target, WCTemplputParams *TP)
1759 int i, ntabs, nTabs;
1761 nTabs = ntabs = TP->Tokens->nParameters / 2;
1762 TabNames = (StrBuf **) malloc(ntabs * sizeof(StrBuf*));
1764 for (i = 0; i < ntabs; i++) {
1765 if ((TP->Tokens->Params[i * 2]->Type == TYPE_STR) &&
1766 (TP->Tokens->Params[i * 2]->len > 0)) {
1767 TabNames[i] = NewStrBuf();
1768 DoTemplate(TKEY(i * 2), TabNames[i], TP);
1770 else if (TP->Tokens->Params[i * 2]->Type == TYPE_GETTEXT) {
1773 GetTemplateTokenString(TP,
1777 TabNames[i] = NewStrBufPlain(Ch, -1);
1780 /** A Tab without subject? we can't count that, add it as silent */
1785 StrTabbedDialog(Target, nTabs, TabNames);
1786 for (i = 0; i < ntabs; i++) {
1787 StrBeginTab(Target, i, nTabs);
1788 DoTemplate(TKEY(i * 2 + 1), Target, TP);
1789 StrEndTab(Target, i, nTabs);
1794 /*-----------------------------------------------------------------------------
1799 void RegisterSortFunc(const char *name, long len,
1800 const char *prepend, long preplen,
1801 CompareFunc Forward,
1802 CompareFunc Reverse,
1803 CompareFunc GroupChange,
1806 SortStruct *NewSort = (SortStruct*) malloc(sizeof(SortStruct));
1807 NewSort->Name = NewStrBufPlain(name, len);
1808 if (prepend != NULL)
1809 NewSort->PrefPrepend = NewStrBufPlain(prepend, preplen);
1811 NewSort->PrefPrepend = NULL;
1812 NewSort->Forward = Forward;
1813 NewSort->Reverse = Reverse;
1814 NewSort->GroupChange = GroupChange;
1815 NewSort->ContextType = ContextType;
1816 Put(SortHash, name, len, NewSort, DestroySortStruct);
1819 CompareFunc RetrieveSort(WCTemplputParams *TP,
1820 const char *OtherPrefix, long OtherPrefixLen,
1821 const char *Default, long ldefault, long DefaultDirection)
1824 const StrBuf *BSort = NULL;
1827 long SortOrder = -1;
1829 if (havebstr("SortBy")) {
1830 BSort = sbstr("SortBy");
1831 if (OtherPrefix == NULL) {
1832 set_room_pref("sort", NewStrBufDup(BSort), 0);
1835 set_X_PREFS(HKEY("sort"), OtherPrefix, OtherPrefixLen, NewStrBufDup(BSort), 0);
1838 else { /** Try to fallback to our remembered values... */
1839 if (OtherPrefix == NULL) {
1840 BSort = get_room_pref("sort");
1843 BSort = get_X_PREFS(HKEY("sort"), OtherPrefix, OtherPrefixLen);
1846 putbstr("SortBy", NewStrBufDup(BSort));
1850 BSort = Buf = NewStrBufPlain(Default, ldefault);
1851 putbstr("SortBy", Buf);
1855 if (!GetHash(SortHash, SKEY(BSort), &vSortBy) ||
1856 (vSortBy == NULL)) {
1858 if (!GetHash(SortHash, Default, ldefault, &vSortBy) ||
1859 (vSortBy == NULL)) {
1861 NULL, "Sorting", ERR_PARM1, TP,
1862 "Illegal default sort: [%s]", Default);
1866 SortBy = (SortStruct*)vSortBy;
1868 /** Ok, its us, lets see in which direction we should sort... */
1869 if (havebstr("SortOrder")) {
1870 SortOrder = LBSTR("SortOrder");
1872 else { /** Try to fallback to our remembered values... */
1874 if (SortBy->PrefPrepend == NULL) {
1875 Buf = get_room_pref("SortOrder");
1876 SortOrder = StrTol(Buf);
1879 BSort = get_X_PREFS(HKEY("SortOrder"), OtherPrefix, OtherPrefixLen);
1883 SortOrder = DefaultDirection;
1885 Buf = NewStrBufPlain(NULL, 64);
1886 StrBufPrintf(Buf, "%ld", SortOrder);
1887 putbstr("SortOrder", Buf);
1889 switch (SortOrder) {
1894 return SortBy->Forward;
1896 return SortBy->Reverse;
1908 ConstStr SortIcons[] = {
1909 {HKEY("static/sort_none.gif")},
1910 {HKEY("static/up_pointer.gif")},
1911 {HKEY("static/down_pointer.gif")},
1914 ConstStr SortNextOrder[] = {
1921 int GetSortMetric(WCTemplputParams *TP, SortStruct **Next, SortStruct **Param, long *SortOrder, int N)
1923 int bSortError = eNOT_SPECIFIED;
1924 const StrBuf *BSort;
1929 if (!GetHash(SortHash, TKEY(0), &vSort) ||
1931 return eNO_SUCH_SORT;
1932 *Param = (SortStruct*) vSort;
1935 if (havebstr("SortBy")) {
1936 BSort = sbstr("SortBy");
1937 bSortError = eINVALID_PARAM;
1938 if ((*Param)->PrefPrepend == NULL) {
1939 set_room_pref("sort", NewStrBufDup(BSort), 0);
1942 set_X_PREFS(HKEY("sort"), TKEY(N), NewStrBufDup(BSort), 0);
1945 else { /** Try to fallback to our remembered values... */
1946 if ((*Param)->PrefPrepend == NULL) {
1947 BSort = get_room_pref("sort");
1950 BSort = get_X_PREFS(HKEY("sort"), TKEY(N));
1954 if (!GetHash(SortHash, SKEY(BSort), &vSort) ||
1958 *Next = (SortStruct*) vSort;
1960 /** Ok, its us, lets see in which direction we should sort... */
1961 if (havebstr("SortOrder")) {
1962 *SortOrder = LBSTR("SortOrder");
1964 else { /** Try to fallback to our remembered values... */
1965 if ((*Param)->PrefPrepend == NULL) {
1966 *SortOrder = StrTol(get_room_pref("SortOrder"));
1969 *SortOrder = StrTol(get_X_PREFS(HKEY("SortOrder"), TKEY(N)));
1979 void tmplput_SORT_ICON(StrBuf *Target, WCTemplputParams *TP)
1984 const ConstStr *SortIcon;
1986 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
1989 Target, "Sorter", ERR_PARM1, TP,
1990 " Sorter [%s] unknown!",
1991 TP->Tokens->Params[0]->Start);
1993 case eINVALID_PARAM:
1994 LogTemplateError(NULL, "Sorter", ERR_PARM1, TP,
1995 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
1997 case eNOT_SPECIFIED:
1999 if (Next == Param) {
2000 SortIcon = &SortIcons[SortOrder];
2002 else { /** Not Us... */
2003 SortIcon = &SortIcons[0];
2005 StrBufAppendBufPlain(Target, SortIcon->Key, SortIcon->len, 0);
2009 void tmplput_SORT_NEXT(StrBuf *Target, WCTemplputParams *TP)
2015 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2018 Target, "Sorter", ERR_PARM1, TP,
2019 " Sorter [%s] unknown!",
2020 TP->Tokens->Params[0]->Start);
2022 case eINVALID_PARAM:
2024 NULL, "Sorter", ERR_PARM1, TP,
2025 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2027 case eNOT_SPECIFIED:
2029 StrBufAppendBuf(Target, Param->Name, 0);
2034 void tmplput_SORT_ORDER(StrBuf *Target, WCTemplputParams *TP)
2037 const ConstStr *SortOrderStr;
2041 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2044 Target, "Sorter", ERR_PARM1, TP,
2045 " Sorter [%s] unknown!",
2046 TP->Tokens->Params[0]->Start);
2048 case eINVALID_PARAM:
2050 NULL, "Sorter", ERR_PARM1, TP,
2051 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2053 case eNOT_SPECIFIED:
2055 if (Next == Param) {
2056 SortOrderStr = &SortNextOrder[SortOrder];
2058 else { /** Not Us... */
2059 SortOrderStr = &SortNextOrder[0];
2061 StrBufAppendBufPlain(Target, SortOrderStr->Key, SortOrderStr->len, 0);
2066 void tmplput_long_vector(StrBuf *Target, WCTemplputParams *TP)
2068 long *LongVector = (long*) CTX;
2070 if ((TP->Tokens->Params[0]->Type == TYPE_LONG) &&
2071 (TP->Tokens->Params[0]->lvalue <= LongVector[0]))
2073 StrBufAppendPrintf(Target, "%ld", LongVector[TP->Tokens->Params[0]->lvalue]);
2077 if (TP->Tokens->Params[0]->Type != TYPE_LONG) {
2079 Target, "Longvector", ERR_NAME, TP,
2080 "needs a numerical Parameter!");
2084 Target, "LongVector", ERR_PARM1, TP,
2085 "doesn't have %ld Parameters, its just the size of %ld!",
2086 TP->Tokens->Params[0]->lvalue,
2092 void dbg_print_longvector(long *LongVector)
2094 StrBuf *Buf = NewStrBufPlain(HKEY("Longvector: ["));
2095 int nItems = LongVector[0];
2098 for (i = 0; i < nItems; i++) {
2100 StrBufAppendPrintf(Buf, "%d: %ld | ", i, LongVector[i]);
2102 StrBufAppendPrintf(Buf, "%d: %ld]\n", i, LongVector[i]);
2105 lprintf(1, ChrPtr(Buf));
2109 int ConditionalLongVector(StrBuf *Target, WCTemplputParams *TP)
2111 long *LongVector = (long*) CTX;
2113 if ((TP->Tokens->Params[2]->Type == TYPE_LONG) &&
2114 (TP->Tokens->Params[2]->lvalue <= LongVector[0])&&
2115 (TP->Tokens->Params[3]->Type == TYPE_LONG) &&
2116 (TP->Tokens->Params[3]->lvalue <= LongVector[0]))
2118 return LongVector[TP->Tokens->Params[2]->lvalue] ==
2119 LongVector[TP->Tokens->Params[3]->lvalue];
2123 if ((TP->Tokens->Params[2]->Type == TYPE_LONG) ||
2124 (TP->Tokens->Params[2]->Type == TYPE_LONG)) {
2126 Target, "ConditionalLongvector", ERR_PARM1, TP,
2127 "needs two long Parameter!");
2131 Target, "Longvector", ERR_PARM1, TP,
2132 "doesn't have %ld / %ld Parameters, its just the size of %ld!",
2133 TP->Tokens->Params[2]->lvalue,
2134 TP->Tokens->Params[3]->lvalue,
2145 memset(&NoCtx, 0, sizeof(WCTemplputParams));
2146 RegisterNamespace("SORT:ICON", 1, 2, tmplput_SORT_ICON, CTX_NONE);
2147 RegisterNamespace("SORT:ORDER", 1, 2, tmplput_SORT_ORDER, CTX_NONE);
2148 RegisterNamespace("SORT:NEXT", 1, 2, tmplput_SORT_NEXT, CTX_NONE);
2149 RegisterNamespace("CONTEXTSTR", 0, 1, tmplput_ContextString, CTX_STRBUF);
2150 RegisterNamespace("ITERATE", 2, 100, tmpl_iterate_subtmpl, CTX_NONE);
2151 RegisterNamespace("DOBOXED", 1, 2, tmpl_do_boxed, CTX_NONE);
2152 RegisterNamespace("DOTABBED", 2, 100, tmpl_do_tabbed, CTX_NONE);
2153 RegisterNamespace("LONGVECTOR", 1, 1, tmplput_long_vector, CTX_LONGVECTOR);
2154 RegisterConditional(HKEY("COND:SUBST"), 3, ConditionalVar, CTX_NONE);
2155 RegisterConditional(HKEY("COND:CONTEXTSTR"), 3, ConditionalContextStr, CTX_STRBUF);
2156 RegisterConditional(HKEY("COND:LONGVECTOR"), 4, ConditionalLongVector, CTX_LONGVECTOR);