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;
38 #define SV_CONDITIONAL 2
39 #define SV_NEG_CONDITIONAL 3
40 #define SV_CUST_STR_CONDITIONAL 4
42 #define SV_PREEVALUATED 6
44 typedef struct _WCTemplate {
49 WCTemplateToken **Tokens;
52 typedef struct _HashHandler {
56 WCHandlerFunc HandlerFunc;
59 void *load_template(StrBuf *filename, StrBuf *Key, HashList *PutThere);
60 int EvaluateConditional(StrBuf *Target, WCTemplateToken *Tokens, WCTemplate *pTmpl, void *Context, int Neg, int state, int ContextType);
62 typedef struct _SortStruct {
67 CompareFunc GroupChange;
72 void DestroySortStruct(void *vSort)
74 SortStruct *Sort = (SortStruct*) vSort;
75 FreeStrBuf(&Sort->Name);
76 FreeStrBuf(&Sort->PrefPrepend);
81 void RegisterNS(const char *NSName,
85 WCHandlerFunc HandlerFunc,
88 HashHandler *NewHandler;
90 NewHandler = (HashHandler*) malloc(sizeof(HashHandler));
91 NewHandler->nMinArgs = nMinArgs;
92 NewHandler->nMaxArgs = nMaxArgs;
93 NewHandler->HandlerFunc = HandlerFunc;
94 NewHandler->ContextRequired = ContextRequired;
95 Put(GlobalNS, NSName, len, NewHandler, NULL);
98 void FreeToken(WCTemplateToken **Token)
101 FreeStrBuf(&(*Token)->FlatToken);
102 if ((*Token)->HaveParameters)
103 for (i = 0; i < (*Token)->nParameters; i++)
104 free((*Token)->Params[i]);
111 void FreeWCTemplate(void *vFreeMe)
114 WCTemplate *FreeMe = (WCTemplate*)vFreeMe;
116 if (FreeMe->TokenSpace > 0) {
117 for (i = 0; i < FreeMe->nTokensUsed; i ++) {
118 FreeToken(&FreeMe->Tokens[i]);
120 free(FreeMe->Tokens);
122 FreeStrBuf(&FreeMe->FileName);
123 FreeStrBuf(&FreeMe->Data);
129 * \brief debugging function to print array to log
131 void VarPrintTransition(void *vVar1, void *vVar2, int odd){}
133 * \brief debugging function to print array to log
135 void VarPrintEntry(const char *Key, void *vSubst, int odd)
138 lprintf(1,"Subst[%s] : ", Key);
139 ptr = (wcsubst*) vSubst;
141 switch(ptr->wcs_type) {
143 lprintf(1, " -> %s\n", ChrPtr(ptr->wcs_value));
146 lprintf(1, " -> Server [%s]\n", ChrPtr(ptr->wcs_value));
149 lprintf(1, " -> function at [%0xd]\n", ptr->wcs_function);
152 lprintf(1," WARNING: invalid type: [%ld]!\n", ptr->wcs_type);
159 * \brief Clear out the list of substitution variables local to this session
161 void clear_substs(wcsession *wc) {
163 if (wc->vars != NULL) {
164 DeleteHash(&wc->vars);
169 * \brief Clear out the list of substitution variables local to this session
171 void clear_local_substs(void) {
190 void FlushPayload(wcsubst *ptr, int reusestrbuf, int type)
192 int NeedNew = NeedNewBuf(type);
193 switch(ptr->wcs_type) {
197 if (reusestrbuf && NeedNew) {
198 FlushStrBuf(ptr->wcs_value);
202 FreeStrBuf(&ptr->wcs_value);
203 ptr->wcs_value = NULL;
207 ptr->wcs_function = NULL;
208 if (reusestrbuf && NeedNew)
209 ptr->wcs_value = NewStrBuf();
212 ptr->wcs_value = NULL;
213 if (reusestrbuf && NeedNew)
214 ptr->wcs_value = NewStrBuf();
218 if (reusestrbuf && NeedNew)
219 ptr->wcs_value = NewStrBuf();
222 if (reusestrbuf && NeedNew)
223 ptr->wcs_value = NewStrBuf();
230 * \brief destructor; kill one entry.
232 void deletevar(void *data)
234 wcsubst *ptr = (wcsubst*)data;
235 FlushPayload(ptr, 0, ptr->wcs_type);
240 wcsubst *NewSubstVar(const char *keyname, int keylen, int type)
245 ptr = (wcsubst *) malloc(sizeof(wcsubst));
246 memset(ptr, 0, sizeof(wcsubst));
248 ptr->wcs_type = type;
249 safestrncpy(ptr->wcs_key, keyname, sizeof ptr->wcs_key);
250 Put(WCC->vars, keyname, keylen, ptr, deletevar);
252 switch(ptr->wcs_type) {
255 ptr->wcs_value = NewStrBuf();
269 * \brief Add a substitution variable (local to this session) (strlen version...)
270 * \param keyname the replacementstring to substitute
271 * \param keytype the kind of the key
272 * \param format the format string ala printf
273 * \param ... the arguments to substitute in the formatstring
275 void SVPRINTF(char *keyname, int keytype, const char *format,...)
283 keylen = strlen(keyname);
285 * First look if we're doing a replacement of
288 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
289 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
290 ptr = (wcsubst*)vPtr;
291 FlushPayload(ptr, keytype, keytype);
292 ptr->wcs_type = keytype;
294 else /** Otherwise allocate a new one */
296 ptr = NewSubstVar(keyname, keylen, keytype);
299 /** Format the string */
300 va_start(arg_ptr, format);
301 StrBufVAppendPrintf(ptr->wcs_value, format, arg_ptr);
306 * \brief Add a substitution variable (local to this session)
307 * \param keyname the replacementstring to substitute
308 * \param keytype the kind of the key
309 * \param format the format string ala printf
310 * \param ... the arguments to substitute in the formatstring
312 void svprintf(char *keyname, size_t keylen, int keytype, const char *format,...)
320 * First look if we're doing a replacement of
323 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
324 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
325 ptr = (wcsubst*)vPtr;
326 FlushPayload(ptr, 1, keytype);
327 ptr->wcs_type = keytype;
329 else /** Otherwise allocate a new one */
331 ptr = NewSubstVar(keyname, keylen, keytype);
334 /** Format the string and save it */
335 va_start(arg_ptr, format);
336 StrBufVAppendPrintf(ptr->wcs_value, format, arg_ptr);
341 * \brief Add a substitution variable (local to this session)
342 * \param keyname the replacementstring to substitute
343 * \param keytype the kind of the key
344 * \param format the format string ala printf
345 * \param ... the arguments to substitute in the formatstring
347 void SVPut(char *keyname, size_t keylen, int keytype, char *Data)
355 * First look if we're doing a replacement of
358 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
359 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
360 ptr = (wcsubst*)vPtr;
361 FlushPayload(ptr, 1, keytype);
362 ptr->wcs_type = keytype;
364 else /** Otherwise allocate a new one */
366 ptr = NewSubstVar(keyname, keylen, keytype);
368 StrBufAppendBufPlain(ptr->wcs_value, Data, -1, 0);
372 * \brief Add a substitution variable (local to this session)
373 * \param keyname the replacementstring to substitute
374 * \param keytype the kind of the key
375 * \param format the format string ala printf
376 * \param ... the arguments to substitute in the formatstring
378 void SVPutLong(char *keyname, size_t keylen, long Data)
386 * First look if we're doing a replacement of
389 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
390 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
391 ptr = (wcsubst*)vPtr;
392 FlushPayload(ptr, 1, WCS_LONG);
393 ptr->wcs_type = WCS_LONG;
395 else /** Otherwise allocate a new one */
397 ptr = NewSubstVar(keyname, keylen, WCS_LONG);
403 * \brief Add a substitution variable (local to this session) that does a callback
404 * \param keyname the keystring to substitute
405 * \param fcn_ptr the function callback to give the substitution string
407 void SVCallback(char *keyname, size_t keylen, WCHandlerFunc fcn_ptr)
414 * First look if we're doing a replacement of
417 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
418 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
419 ptr = (wcsubst*)vPtr;
420 FlushPayload(ptr, 1, WCS_FUNCTION);
421 ptr->wcs_type = WCS_FUNCTION;
423 else /** Otherwise allocate a new one */
425 ptr = NewSubstVar(keyname, keylen, WCS_FUNCTION);
428 ptr->wcs_function = fcn_ptr;
430 inline void SVCALLBACK(char *keyname, WCHandlerFunc fcn_ptr)
432 SVCallback(keyname, strlen(keyname), fcn_ptr);
437 void SVPUTBuf(const char *keyname, int keylen, const StrBuf *Buf, int ref)
444 * First look if we're doing a replacement of
447 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
448 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
449 ptr = (wcsubst*)vPtr;
450 FlushPayload(ptr, 0, (ref)?WCS_STRBUF_REF:WCS_STRBUF);
451 ptr->wcs_type = (ref)?WCS_STRBUF_REF:WCS_STRBUF;
453 else /** Otherwise allocate a new one */
455 ptr = NewSubstVar(keyname, keylen, (ref)?WCS_STRBUF_REF:WCS_STRBUF);
457 ptr->wcs_value = (StrBuf*)Buf;
461 * \brief back end for print_value_of() ... does a server command
462 * \param servcmd server command to execute on the citadel server
464 void pvo_do_cmd(StrBuf *Target, StrBuf *servcmd) {
468 serv_puts(ChrPtr(servcmd));
469 len = serv_getln(buf, sizeof buf);
475 StrBufAppendPrintf(Target, "%s\n", &buf[4]);
478 _fmout(Target, "CENTER");
481 StrBufAppendPrintf(Target, "%s\n", &buf[4]);
487 void GetTemplateTokenString(WCTemplateToken *Tokens,
494 if (Tokens->nParameters < N) {
500 switch (Tokens->Params[N]->Type) {
503 *Value = Tokens->Params[N]->Start;
504 *len = Tokens->Params[N]->len;
507 Buf = (StrBuf*) SBstr(TKEY(N));
508 *Value = ChrPtr(Buf);
509 *len = StrLength(Buf);
512 get_PREFERENCE(TKEY(N), &Buf);
513 *Value = ChrPtr(Buf);
514 *len = StrLength(Buf);
518 break; /* todo: string to text? */
520 *Value = _(Tokens->Params[N]->Start);
521 *len = strlen(*Value);
532 * \brief Print the value of a variable
533 * \param keyname get a key to print
535 void print_value_of(StrBuf *Target, WCTemplateToken *Tokens, void *Context, int ContextType) {
540 /*if (WCC->vars != NULL) PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
541 /* TODO: depricated! */
542 if (Tokens->pName[0] == '=') {
543 DoTemplate(Tokens->pName+1, Tokens->NameEnd - 1, NULL, NULL, 0);
546 /*/////TODO: if param[1] == "U" -> urlescape
548 /** Page-local variables */
549 if ((WCC->vars!= NULL) && GetHash(WCC->vars, Tokens->pName, Tokens->NameEnd, &vVar)) {
550 ptr = (wcsubst*) vVar;
551 switch(ptr->wcs_type) {
553 StrBufAppendBuf(Target, ptr->wcs_value, 0);
556 pvo_do_cmd(Target, ptr->wcs_value);
559 (*ptr->wcs_function) (Target, Tokens->nParameters, Tokens, Context, ContextType);
563 StrBufAppendBuf(Target, ptr->wcs_value, 0);
566 StrBufAppendPrintf(Target, "%ld", ptr->lvalue);
569 lprintf(1,"WARNING: invalid value in SV-Hash at %s!\n", Tokens->pName);
570 StrBufAppendPrintf(Target, "<pre>WARNING: \ninvalid value in SV-Hash at %s!\n</pre>", Tokens->pName);
574 lprintf(1, "didn't find Handler [%s] (in '%s' line %ld); "
577 ChrPtr(Tokens->FileName),
579 ChrPtr(Tokens->FlatToken));
584 int CompareSubstToToken(TemplateParam *ParamToCompare, TemplateParam *ParamToLookup)
590 if ((WCC->vars!= NULL) && GetHash(WCC->vars, ParamToLookup->Start,
591 ParamToLookup->len, &vVar)) {
592 ptr = (wcsubst*) vVar;
593 switch(ptr->wcs_type) {
597 if (ParamToCompare->Type == TYPE_STR)
598 return ((ParamToCompare->len == StrLength(ptr->wcs_value)) &&
599 (strcmp(ParamToCompare->Start, ChrPtr(ptr->wcs_value)) == 0));
601 return ParamToCompare->lvalue == StrTol(ptr->wcs_value);
609 if (ParamToCompare->Type == TYPE_STR)
612 return ParamToCompare->lvalue == ptr->lvalue;
615 lprintf(1,"WARNING: invalid value in SV-Hash at %s!\n",
616 ParamToLookup->Start);
622 int CompareSubstToStrBuf(StrBuf *Compare, TemplateParam *ParamToLookup)
628 if ((WCC->vars!= NULL) && GetHash(WCC->vars, ParamToLookup->Start,
629 ParamToLookup->len, &vVar)) {
630 ptr = (wcsubst*) vVar;
631 switch(ptr->wcs_type) {
635 return ((StrLength(Compare) == StrLength(ptr->wcs_value)) &&
636 (strcmp(ChrPtr(Compare), ChrPtr(ptr->wcs_value)) == 0));
643 return StrTol(Compare) == ptr->lvalue;
645 lprintf(1,"WARNING: invalid value in SV-Hash at %s!\n",
646 ParamToLookup->Start);
655 * \brief puts string into the template and computes which escape methon we should use
656 * \param Source the string we should put into the template
657 * \param FormatTypeIndex where should we look for escape types if?
659 void StrBufAppendTemplate(StrBuf *Target,
661 WCTemplateToken *Tokens,
662 void *Context, int ContextType,
663 const StrBuf *Source, int FormatTypeIndex)
669 if ((FormatTypeIndex < Tokens->nParameters) &&
670 (Tokens->Params[FormatTypeIndex]->Type == TYPE_STR) &&
671 (Tokens->Params[FormatTypeIndex]->len == 1)) {
672 EscapeAs = *Tokens->Params[FormatTypeIndex]->Start;
679 Buf = NewStrBufPlain(NULL, StrLength(Source));
680 StrBuf_RFC822_to_Utf8(Buf,
682 (WCC!=NULL)? WCC->DefaultCharset : NULL,
684 StrEscAppend(Target, Buf, NULL, 0, 0);
688 StrEscAppend(Target, Source, NULL, 0, 0);
691 StrBufAppendBuf(Target, Source, 0);
696 void PutNewToken(WCTemplate *Template, WCTemplateToken *NewToken)
698 if (Template->nTokensUsed + 1 >= Template->TokenSpace) {
699 if (Template->TokenSpace <= 0) {
700 Template->Tokens = (WCTemplateToken**)malloc(
701 sizeof(WCTemplateToken*) * 10);
702 Template->TokenSpace = 10;
705 WCTemplateToken **NewTokens;
706 NewTokens= (WCTemplateToken**)malloc(
707 sizeof(WCTemplateToken*) *
708 Template->TokenSpace * 2);
709 memcpy(NewTokens, Template->Tokens,
710 sizeof(WCTemplateToken*) * Template->nTokensUsed);
711 free(Template->Tokens);
712 Template->TokenSpace *= 2;
713 Template->Tokens = NewTokens;
716 Template->Tokens[(Template->nTokensUsed)++] = NewToken;
719 TemplateParam *GetNextParameter(StrBuf *Buf, const char **pCh, const char *pe, WCTemplateToken *Tokens, WCTemplate *pTmpl)
721 const char *pch = *pCh;
722 const char *pchs, *pche;
723 TemplateParam *Parm = (TemplateParam *) malloc(sizeof(TemplateParam));
727 Parm->Type = TYPE_STR;
729 /* Skip leading whitespaces */
730 while ((*pch == ' ' )||
733 (*pch == '\n')) pch ++;
736 Parm->Type = TYPE_PREFSTR;
739 else if (*pch == ';') {
740 Parm->Type = TYPE_PREFINT;
743 else if (*pch == '_') {
744 Parm->Type = TYPE_GETTEXT;
747 else if (*pch == 'B') {
748 Parm->Type = TYPE_BSTR;
755 else if (*pch == '\'')
762 ( (pch > pchs) && (*(pch - 1) == '\\'))
768 lprintf(1, "Error (in '%s' line %ld); "
769 "evaluating template param [%s] in Token [%s]\n",
770 ChrPtr(pTmpl->FileName),
772 ChrPtr(Tokens->FlatToken),
779 StrBufPeek(Buf, pch, -1, '\0');
780 if (LoadTemplates > 1) {
781 lprintf(1, "DBG: got param [%s] %ld %ld\n",
782 pchs, pche - pchs, strlen(pchs));
785 Parm->len = pche - pchs;
786 pch ++; /* move after trailing quote */
790 Parm->Type = TYPE_LONG;
792 while ((pch <= pe) &&
799 StrBufPeek(Buf, pch, -1, '\0');
800 Parm->lvalue = atol(pchs);
806 lprintf(1, "Error (in '%s' line %ld); "
807 "evaluating long template param [%s] in Token [%s]\n",
808 ChrPtr(pTmpl->FileName),
810 ChrPtr(Tokens->FlatToken),
816 while ((*pch == ' ' )||
820 (*pch == '\n')) pch ++;
826 WCTemplateToken *NewTemplateSubstitute(StrBuf *Buf,
828 const char *pTmplStart,
829 const char *pTmplEnd,
835 TemplateParam *Param;
836 WCTemplateToken *NewToken = (WCTemplateToken*)malloc(sizeof(WCTemplateToken));
838 NewToken->FileName = pTmpl->FileName; /* to print meaningfull log messages... */
840 NewToken->Line = Line + 1;
841 NewToken->pTokenStart = pTmplStart;
842 NewToken->TokenStart = pTmplStart - pStart;
843 NewToken->TokenEnd = (pTmplEnd - pStart) - NewToken->TokenStart;
844 NewToken->pTokenEnd = pTmplEnd;
845 NewToken->NameEnd = NewToken->TokenEnd - 2;
846 NewToken->PreEval = NULL;
847 NewToken->FlatToken = NewStrBufPlain(pTmplStart + 2, pTmplEnd - pTmplStart - 2);
849 StrBufPeek(Buf, pTmplStart, + 1, '\0');
850 StrBufPeek(Buf, pTmplEnd, -1, '\0');
851 pch = NewToken->pName = pTmplStart + 2;
853 NewToken->HaveParameters = 0;;
854 NewToken->nParameters = 0;
856 while (pch < pTmplEnd - 1) {
858 StrBufPeek(Buf, pch, -1, '\0');
859 NewToken->NameEnd = pch - NewToken->pName;
861 if (*(pTmplEnd - 1) != ')') {
862 lprintf(1, "Warning, Non welformed Token; missing right parenthesis (in '%s' line %ld); "
864 ChrPtr(pTmpl->FileName),
866 ChrPtr(NewToken->FlatToken));
868 while (pch < pTmplEnd - 1) {
869 Param = GetNextParameter(Buf, &pch, pTmplEnd - 1, NewToken, pTmpl);
871 NewToken->HaveParameters = 1;
872 if (NewToken->nParameters > MAXPARAM) {
873 lprintf(1, "Error (in '%s' line %ld); "
874 "only [%ld] Params allowed in Tokens [%s]\n",
875 ChrPtr(pTmpl->FileName),
878 ChrPtr(NewToken->FlatToken));
880 FreeToken(&NewToken);
883 NewToken->Params[NewToken->nParameters++] = Param;
887 if((NewToken->NameEnd == 1) &&
888 (NewToken->HaveParameters == 1))
891 if (*(NewToken->pName) == '_')
892 NewToken->Flags = SV_GETTEXT;
893 else if (*(NewToken->pName) == '=')
894 NewToken->Flags = SV_SUBTEMPL;
895 else if (*(NewToken->pName) == '%')
896 NewToken->Flags = SV_CUST_STR_CONDITIONAL;
897 else if (*(NewToken->pName) == '?')
898 NewToken->Flags = SV_CONDITIONAL;
899 else if (*(NewToken->pName) == '!')
900 NewToken->Flags = SV_NEG_CONDITIONAL;
906 switch (NewToken->Flags) {
908 /* If we're able to find out more about the token, do it now while its fresh. */
909 if (GetHash(GlobalNS, NewToken->pName, NewToken->NameEnd, &vVar)) {
910 HashHandler *Handler;
911 Handler = (HashHandler*) vVar;
912 if ((NewToken->nParameters < Handler->nMinArgs) ||
913 (NewToken->nParameters > Handler->nMaxArgs)) {
914 lprintf(1, "Handler [%s] (in '%s' line %ld); "
915 "doesn't work with %ld params [%s]\n",
917 ChrPtr(pTmpl->FileName),
919 NewToken->nParameters,
920 ChrPtr(NewToken->FlatToken));
923 NewToken->PreEval = Handler;
924 NewToken->Flags = SV_PREEVALUATED;
929 if (NewToken->nParameters !=1) {
930 lprintf(1, "Gettext (in '%s' line %ld); "
931 "requires exactly 1 parameter, you gave %ld params [%s]\n",
932 ChrPtr(pTmpl->FileName),
934 NewToken->nParameters,
935 ChrPtr(NewToken->FlatToken));
941 if (NewToken->nParameters != 1) {
942 lprintf(1, "Subtemplates (in '%s' line %ld); "
943 "require exactly 1 parameter, you gave %ld params [%s]\n",
944 ChrPtr(pTmpl->FileName),
946 NewToken->nParameters,
947 ChrPtr(NewToken->FlatToken));
951 case SV_CUST_STR_CONDITIONAL:
953 case SV_NEG_CONDITIONAL:
954 if (NewToken->nParameters <2) {
955 lprintf(1, "Conditional (in '%s' line %ld); "
956 "require at least 2 parameters, you gave %ld params [%s]\n",
957 ChrPtr(pTmpl->FileName),
959 NewToken->nParameters,
960 ChrPtr(NewToken->FlatToken));
964 if (NewToken->Params[1]->lvalue == 0) {
965 lprintf(1, "Conditional (in '%s' line %ld); "
966 "Conditional ID mustn't be 0! [%s]\n",
967 ChrPtr(pTmpl->FileName),
969 ChrPtr(NewToken->FlatToken));
973 if (!GetHash(Conditionals,
974 NewToken->Params[0]->Start,
975 NewToken->Params[0]->len,
978 if ((NewToken->Params[0]->len == 1) &&
979 (NewToken->Params[0]->Start[0] == 'X'))
981 lprintf(1, "Conditional [%s] (in '%s' line %ld); Not found![%s]\n",
982 NewToken->Params[0]->Start,
983 ChrPtr(pTmpl->FileName),
985 ChrPtr(NewToken->FlatToken));
987 NewToken->Error = NewStrBuf();
990 "<pre>\nConditional [%s] (in '%s' line %ld); Not found!\n[%s]\n</pre>\n",
991 NewToken->Params[0]->Start,
992 ChrPtr(pTmpl->FileName),
994 ChrPtr(NewToken->FlatToken));
998 NewToken->PreEval = vVar;
1010 * \brief Display a variable-substituted template
1011 * \param templatename template file to load
1013 void *prepare_template(StrBuf *filename, StrBuf *Key, HashList *PutThere)
1015 WCTemplate *NewTemplate;
1016 NewTemplate = (WCTemplate *) malloc(sizeof(WCTemplate));
1017 NewTemplate->Data = NULL;
1018 NewTemplate->FileName = NewStrBufDup(filename);
1019 NewTemplate->nTokensUsed = 0;
1020 NewTemplate->TokenSpace = 0;
1021 NewTemplate->Tokens = NULL;
1023 Put(PutThere, ChrPtr(Key), StrLength(Key), NewTemplate, FreeWCTemplate);
1028 * \brief Display a variable-substituted template
1029 * \param templatename template file to load
1031 void *load_template(StrBuf *filename, StrBuf *Key, HashList *PutThere)
1034 struct stat statbuf;
1035 const char *pS, *pE, *pch, *Err;
1038 WCTemplate *NewTemplate;
1040 fd = open(ChrPtr(filename), O_RDONLY);
1042 lprintf(1, "ERROR: could not open template '%s' - %s\n",
1043 ChrPtr(filename), strerror(errno));
1047 if (fstat(fd, &statbuf) == -1) {
1048 lprintf(1, "ERROR: could not stat template '%s' - %s\n",
1049 ChrPtr(filename), strerror(errno));
1053 NewTemplate = (WCTemplate *) malloc(sizeof(WCTemplate));
1054 NewTemplate->Data = NewStrBufPlain(NULL, statbuf.st_size);
1055 NewTemplate->FileName = NewStrBufDup(filename);
1056 NewTemplate->nTokensUsed = 0;
1057 NewTemplate->TokenSpace = 0;
1058 NewTemplate->Tokens = NULL;
1059 if (StrBufReadBLOB(NewTemplate->Data, &fd, 1, statbuf.st_size, &Err) < 0) {
1061 FreeWCTemplate(NewTemplate);
1062 lprintf(1, "ERROR: reading template '%s' - %s<br />\n",
1063 ChrPtr(filename), strerror(errno));
1069 pS = pch = ChrPtr(NewTemplate->Data);
1070 pE = pS + StrLength(NewTemplate->Data);
1072 const char *pts, *pte;
1074 int InDoubleQuotes = 0;
1076 /** Find one <? > */
1078 for (; pch < pE; pch ++) {
1079 if ((*pch=='<')&&(*(pch + 1)=='?'))
1081 if (*pch=='\n') Line ++;
1087 /** Found one? parse it. */
1088 for (; pch <= pE - 1; pch ++) {
1090 InDoubleQuotes = ! InDoubleQuotes;
1091 else if (*pch == '\'')
1092 InQuotes = ! InQuotes;
1093 else if ((!InQuotes && !InDoubleQuotes) &&
1094 ((*pch!='\\')&&(*(pch + 1)=='>'))) {
1102 PutNewToken(NewTemplate,
1103 NewTemplateSubstitute(NewTemplate->Data, pS, pts, pte, Line, NewTemplate));
1106 if (LoadTemplates == 0)
1107 Put(PutThere, ChrPtr(Key), StrLength(Key), NewTemplate, FreeWCTemplate);
1112 const char* PrintTemplate(void *vSubst)
1114 WCTemplate *Tmpl = vSubst;
1116 return ChrPtr(Tmpl->FileName);
1120 int LoadTemplateDir(const char *DirName, HashList *wireless, HashList *big)
1125 DIR *filedir = NULL;
1126 struct dirent *filedir_entry;
1132 StrBufPrintf(Dir, "%s/t", DirName);
1133 filedir = opendir (ChrPtr(Dir));
1134 if (filedir == NULL) {
1139 FileName = NewStrBuf();
1141 while ((filedir_entry = readdir(filedir)))
1145 #ifdef _DIRENT_HAVE_D_NAMELEN
1146 d_namelen = filedir_entry->d_namelen;
1148 d_namelen = strlen(filedir_entry->d_name);
1150 d_without_ext = d_namelen;
1151 while ((d_without_ext > 0) && (filedir_entry->d_name[d_without_ext] != '.'))
1153 if ((d_without_ext == 0) || (d_namelen < 3))
1155 if ((d_namelen > 1) && filedir_entry->d_name[d_namelen - 1] == '~')
1156 continue; /* Ignore backup files... */
1158 IsMobile = (strstr(filedir_entry->d_name, ".m.html")!= NULL);
1159 PStart = filedir_entry->d_name;
1160 StrBufPrintf(FileName, "%s/%s", ChrPtr(Dir), filedir_entry->d_name);
1161 MinorPtr = strchr(filedir_entry->d_name, '.');
1162 if (MinorPtr != NULL)
1164 StrBufPlain(Tag, filedir_entry->d_name, MinorPtr - filedir_entry->d_name);
1166 if (LoadTemplates > 1)
1167 lprintf(1, "%s %d %s\n",ChrPtr(FileName), IsMobile, ChrPtr(Tag));
1168 if (LoadTemplates == 0)
1169 load_template(FileName, Tag, (IsMobile)?wireless:big);
1171 prepare_template(FileName, Tag, (IsMobile)?wireless:big);
1174 FreeStrBuf(&FileName);
1180 void InitTemplateCache(void)
1182 LoadTemplateDir(static_dirs[0],
1183 WirelessTemplateCache,
1185 LoadTemplateDir(static_dirs[1],
1186 WirelessLocalTemplateCache,
1187 LocalTemplateCache);
1192 /*-----------------------------------------------------------------------------
1193 * Filling & processing Templates
1196 * \brief executes one token
1197 * \param Target buffer to append to
1198 * \param Token da to process.
1199 * \param Template we're iterating
1200 * \param Context Contextpoointer to pass in
1201 * \param state are we in conditional state?
1202 * \param ContextType what type of information does context giv us?
1204 int EvaluateToken(StrBuf *Target, WCTemplateToken *Tokens, WCTemplate *pTmpl, void *Context, int state, int ContextType)
1206 const char *AppendMe;
1208 HashHandler *Handler;
1210 /* much output, since pName is not terminated...
1211 lprintf(1,"Doing token: %s\n",Token->pName);
1214 switch (Tokens->Flags) {
1216 TmplGettext(Target, Tokens->nParameters, Tokens);
1218 case SV_CONDITIONAL: /** Forward conditional evaluation */
1219 return EvaluateConditional(Target, Tokens, pTmpl, Context, 1, state, ContextType);
1221 case SV_NEG_CONDITIONAL: /** Reverse conditional evaluation */
1222 return EvaluateConditional(Target, Tokens, pTmpl, Context, 0, state, ContextType);
1224 case SV_CUST_STR_CONDITIONAL: /** Conditional put custom strings from params */
1225 if (Tokens->nParameters >= 6) {
1226 if (EvaluateConditional(Target, Tokens, pTmpl, Context, 0, state, ContextType)) {
1227 GetTemplateTokenString(Tokens, 5, &AppendMe, &AppendMeLen);
1228 StrBufAppendBufPlain(Target,
1234 GetTemplateTokenString(Tokens, 4, &AppendMe, &AppendMeLen);
1235 StrBufAppendBufPlain(Target,
1242 lprintf(1, "Conditional [%s] (in '%s' line %ld); needs at least 6 Params![%s]\n",
1243 Tokens->Params[0]->Start,
1244 ChrPtr(pTmpl->FileName),
1246 ChrPtr(Tokens->FlatToken));
1249 "<pre>\nConditional [%s] (in '%s' line %ld); needs 6 Params!\n[%s]\n</pre>\n",
1250 Tokens->Params[0]->Start,
1251 ChrPtr(pTmpl->FileName),
1253 ChrPtr(Tokens->FlatToken));
1257 if (Tokens->nParameters == 1)
1258 DoTemplate(TKEY(0), NULL, NULL, ContextType);
1260 case SV_PREEVALUATED:
1261 Handler = (HashHandler*) Tokens->PreEval;
1262 if ((Handler->ContextRequired != CTX_NONE) &&
1263 (Handler->ContextRequired != ContextType)) {
1264 lprintf(1, "Handler [%s] (in '%s' line %ld); "
1265 "requires context of type %ld, have %ld [%s]\n",
1267 ChrPtr(pTmpl->FileName),
1269 Handler->ContextRequired,
1271 ChrPtr(Tokens->FlatToken));
1274 "<pre>\nHandler [%s] (in '%s' line %ld);"
1275 " requires context of type %ld, have %ld!\n[%s]\n</pre>\n",
1277 ChrPtr(pTmpl->FileName),
1279 Handler->ContextRequired,
1281 ChrPtr(Tokens->FlatToken));
1285 Handler->HandlerFunc(Target,
1286 Tokens->nParameters,
1292 if (GetHash(GlobalNS, Tokens->pName, Tokens->NameEnd, &vVar)) {
1293 Handler = (HashHandler*) vVar;
1294 if ((Handler->ContextRequired != CTX_NONE) &&
1295 (Handler->ContextRequired != ContextType)) {
1296 lprintf(1, "Handler [%s] (in '%s' line %ld); "
1297 "requires context of type %ld, have %ld [%s]\n",
1299 ChrPtr(pTmpl->FileName),
1301 Handler->ContextRequired,
1303 ChrPtr(Tokens->FlatToken));
1306 "<pre>\nHandler [%s] (in '%s' line %ld);"
1307 " requires context of type %ld, have %ld!\n[%s]\n</pre>\n",
1309 ChrPtr(pTmpl->FileName),
1311 Handler->ContextRequired,
1313 ChrPtr(Tokens->FlatToken));
1316 else if ((Tokens->nParameters < Handler->nMinArgs) ||
1317 (Tokens->nParameters > Handler->nMaxArgs)) {
1318 lprintf(1, "Handler [%s] (in '%s' line %ld); "
1319 "doesn't work with %ld params [%s]\n",
1321 ChrPtr(pTmpl->FileName),
1323 Tokens->nParameters,
1324 ChrPtr(Tokens->FlatToken));
1327 "<pre>\nHandler [%s] (in '%s' line %ld);"
1328 " doesn't work with %ld params!\n[%s]\n</pre>\n",
1330 ChrPtr(pTmpl->FileName),
1332 Tokens->nParameters,
1333 ChrPtr(Tokens->FlatToken));
1336 Handler->HandlerFunc(Target,
1337 Tokens->nParameters,
1340 ContextType); /*TODO: subset of that */
1345 print_value_of(Target, Tokens, Context, ContextType);
1353 void ProcessTemplate(WCTemplate *Tmpl, StrBuf *Target, void *Context, int ContextType)
1355 WCTemplate *pTmpl = Tmpl;
1358 const char *pData, *pS;
1361 if (LoadTemplates != 0) {
1362 if (LoadTemplates > 1)
1363 lprintf(1, "DBG: ----- loading: [%s] ------ \n",
1364 ChrPtr(Tmpl->FileName));
1366 pTmpl = load_template(Tmpl->FileName, NULL, NULL);
1370 "<pre>\nError loading Template [%s]\n See Logfile for details\n</pre>\n",
1371 ChrPtr(Tmpl->FileName));
1377 pS = pData = ChrPtr(pTmpl->Data);
1378 len = StrLength(pTmpl->Data);
1382 if (i >= pTmpl->nTokensUsed) {
1383 StrBufAppendBufPlain(Target,
1385 len - (pData - pS), 0);
1389 StrBufAppendBufPlain(
1391 pTmpl->Tokens[i]->pTokenStart - pData, 0);
1392 state = EvaluateToken(Target, pTmpl->Tokens[i], pTmpl, Context, state, ContextType);
1393 while ((state != 0) && (i+1 < pTmpl->nTokensUsed)) {
1394 /* condition told us to skip till its end condition */
1396 if ((pTmpl->Tokens[i]->Flags == SV_CONDITIONAL) ||
1397 (pTmpl->Tokens[i]->Flags == SV_NEG_CONDITIONAL)) {
1398 if (state == EvaluateConditional(
1403 pTmpl->Tokens[i]->Flags,
1409 pData = pTmpl->Tokens[i++]->pTokenEnd + 1;
1410 if (i > pTmpl->nTokensUsed)
1414 if (LoadTemplates != 0) {
1415 FreeWCTemplate(pTmpl);
1420 * \brief Display a variable-substituted template
1421 * \param templatename template file to load
1423 void DoTemplate(const char *templatename, long len, StrBuf *Target, void *Context, int ContextType)
1426 HashList *StaticLocal;
1431 if (WC->is_mobile) {
1432 Static = WirelessTemplateCache;
1433 StaticLocal = WirelessLocalTemplateCache;
1436 Static = TemplateCache;
1437 StaticLocal = LocalTemplateCache;
1442 lprintf (1, "Can't to load a template with empty name!\n");
1443 StrBufAppendPrintf(Target, "<pre>\nCan't to load a template with empty name!\n</pre>");
1447 if (!GetHash(StaticLocal, templatename, len, &vTmpl) &&
1448 !GetHash(Static, templatename, len, &vTmpl)) {
1449 lprintf (1, "didn't find Template [%s] %ld %ld\n", templatename, len , (long)strlen(templatename));
1450 StrBufAppendPrintf(Target, "<pre>\ndidn't find Template [%s] %ld %ld\n</pre>",
1452 (long)strlen(templatename));
1454 dbg_PrintHash(Static, PrintTemplate, NULL);
1455 PrintHash(Static, VarPrintTransition, PrintTemplate);
1461 ProcessTemplate(vTmpl, Target, Context, ContextType);
1464 /*-----------------------------------------------------------------------------
1467 typedef struct _HashIterator {
1468 HashList *StaticList;
1469 int AdditionalParams;
1471 int XPectContextType;
1473 RetrieveHashlistFunc GetHash;
1474 HashDestructorFunc Destructor;
1475 SubTemplFunc DoSubTemplate;
1478 void RegisterITERATOR(const char *Name, long len,
1479 int AdditionalParams,
1480 HashList *StaticList,
1481 RetrieveHashlistFunc GetHash,
1482 SubTemplFunc DoSubTempl,
1483 HashDestructorFunc Destructor,
1485 int XPectContextType,
1488 HashIterator *It = (HashIterator*)malloc(sizeof(HashIterator));
1489 It->StaticList = StaticList;
1490 It->AdditionalParams = AdditionalParams;
1491 It->GetHash = GetHash;
1492 It->DoSubTemplate = DoSubTempl;
1493 It->Destructor = Destructor;
1494 It->ContextType = ContextType;
1495 It->XPectContextType = XPectContextType;
1497 Put(Iterators, Name, len, It, NULL);
1500 void tmpl_iterate_subtmpl(StrBuf *Target, int nArgs, WCTemplateToken *Tokens, void *Context, int ContextType)
1508 int DetectGroupChange = 0;
1510 int nMembersCounted = 0;
1518 if (!GetHash(Iterators, TKEY(0), &vIt)) {
1519 lprintf(1, "unknown Iterator [%s] (in '%s' line %ld); "
1521 Tokens->Params[0]->Start,
1522 ChrPtr(Tokens->FileName),
1524 ChrPtr(Tokens->FlatToken));
1527 "<pre>\nunknown Iterator [%s] (in '%s' line %ld); \n"
1529 Tokens->Params[0]->Start,
1530 ChrPtr(Tokens->FileName),
1532 ChrPtr(Tokens->FlatToken));
1536 It = (HashIterator*) vIt;
1538 if (Tokens->nParameters < It->AdditionalParams + 2) {
1539 lprintf(1, "Iterator [%s] (in '%s' line %ld); "
1540 "doesn't work with %ld params [%s]\n",
1541 Tokens->Params[0]->Start,
1542 ChrPtr(Tokens->FileName),
1544 Tokens->nParameters,
1545 ChrPtr(Tokens->FlatToken));
1548 "<pre>Iterator [%s] \n(in '%s' line %ld);\n"
1549 "doesn't work with %ld params \n[%s]\n</pre>",
1550 Tokens->Params[0]->Start,
1551 ChrPtr(Tokens->FileName),
1553 Tokens->nParameters,
1554 ChrPtr(Tokens->FlatToken));
1558 if ((It->XPectContextType != CTX_NONE) &&
1559 (It->XPectContextType != ContextType)) {
1560 lprintf(1, "Iterator [%s] (in '%s' line %ld); "
1561 "requires context of type %ld, have %ld [%s]\n",
1563 ChrPtr(Tokens->FileName),
1565 It->XPectContextType,
1567 ChrPtr(Tokens->FlatToken));
1570 "<pre>\nIterator [%s] (in '%s' line %ld);"
1571 " requires context of type %ld, have %ld!\n[%s]\n</pre>\n",
1573 ChrPtr(Tokens->FileName),
1575 It->XPectContextType,
1577 ChrPtr(Tokens->FlatToken));
1582 if (It->StaticList == NULL)
1583 List = It->GetHash(Target, nArgs, Tokens, Context, ContextType);
1585 List = It->StaticList;
1587 DetectGroupChange = (It->Flags & IT_FLAG_DETECT_GROUPCHANGE) != 0;
1588 if (DetectGroupChange) {
1589 const StrBuf *BSort;
1590 DetectGroupChange = 0;
1591 if (havebstr("SortBy")) {
1592 BSort = sbstr("SortBy");
1593 if (GetHash(SortHash, SKEY(BSort), &vSortBy) &&
1594 (vSortBy != NULL)) {
1595 SortBy = (SortStruct*)vSortBy;
1596 /** Ok, its us, lets see in which direction we should sort... */
1597 if (havebstr("SortOrder")) {
1599 SortOrder = LBSTR("SortOrder");
1601 DetectGroupChange = 1;
1606 nMembersUsed = GetCount(List);
1607 SubBuf = NewStrBuf();
1608 it = GetNewHashPos(List, 0);
1609 while (GetNextHashPos(List, it, &len, &Key, &vContext)) {
1610 if (DetectGroupChange && nMembersCounted > 0) {
1611 if (SortBy->GroupChange(vContext, vLastContext))
1612 svputlong("ITERATE:ISGROUPCHANGE", 1);
1614 svputlong("ITERATE:ISGROUPCHANGE", 0);
1616 svprintf(HKEY("ITERATE:ODDEVEN"), WCS_STRING, "%s",
1617 (oddeven) ? "odd" : "even");
1618 svprintf(HKEY("ITERATE:KEY"), WCS_STRING, "%s", Key);
1619 svputlong("ITERATE:N", nMembersCounted);
1620 svputlong("ITERATE:LASTN", ++nMembersCounted == nMembersUsed);
1622 if (It->DoSubTemplate != NULL)
1623 It->DoSubTemplate(SubBuf, vContext, Tokens);
1624 DoTemplate(TKEY(1), SubBuf, vContext, It->ContextType);
1626 StrBufAppendBuf(Target, SubBuf, 0);
1627 FlushStrBuf(SubBuf);
1628 oddeven = ~ oddeven;
1629 vLastContext = vContext;
1631 FreeStrBuf(&SubBuf);
1633 if (It->Destructor != NULL)
1634 It->Destructor(&List);
1639 /*-----------------------------------------------------------------------------
1642 int EvaluateConditional(StrBuf *Target, WCTemplateToken *Tokens, WCTemplate *pTmpl, void *Context, int Neg, int state, int ContextType)
1644 ConditionalStruct *Cond;
1646 if ((Tokens->Params[0]->len == 1) &&
1647 (Tokens->Params[0]->Start[0] == 'X'))
1648 return (state != 0)?Tokens->Params[1]->lvalue:0;
1650 Cond = (ConditionalStruct *) Tokens->PreEval;
1652 lprintf(1, "Conditional [%s] (in '%s' line %ld); unknown![%s]\n",
1653 Tokens->Params[0]->Start,
1654 ChrPtr(pTmpl->FileName),
1656 ChrPtr(Tokens->FlatToken));
1660 if (Tokens->nParameters < Cond->nParams) {
1661 lprintf(1, "Conditional [%s] (in '%s' line %ld); needs %ld Params![%s]\n",
1662 Tokens->Params[0]->Start,
1663 ChrPtr(pTmpl->FileName),
1666 ChrPtr(Tokens->FlatToken));
1669 "<pre>\nConditional [%s] (in '%s' line %ld); needs %ld Params!\n[%s]\n</pre>\n",
1670 Tokens->Params[0]->Start,
1671 ChrPtr(pTmpl->FileName),
1674 ChrPtr(Tokens->FlatToken));
1677 if (Cond->CondF(Tokens, Context, ContextType) == Neg)
1678 return Tokens->Params[1]->lvalue;
1682 int ConditionalVar(WCTemplateToken *Tokens, void *Context, int ContextType)
1687 if (!GetHash(WC->vars, TKEY(2), &vsubst))
1689 subst = (wcsubst*) vsubst;
1690 if ((subst->ContextRequired != CTX_NONE) &&
1691 (subst->ContextRequired != ContextType)) {
1692 lprintf(1," WARNING: Conditional requires Context: [%ld]!\n", Tokens->Params[2]->Start);
1696 switch(subst->wcs_type) {
1698 return (subst->wcs_function!=NULL);
1700 lprintf(1, " -> Server [%s]\n", subst->wcs_value);/* TODO */
1704 case WCS_STRBUF_REF:
1705 if (Tokens->nParameters < 4)
1707 return (strcmp(Tokens->Params[3]->Start, ChrPtr(subst->wcs_value)) == 0);
1709 if (Tokens->nParameters < 4)
1710 return (subst->lvalue != 0);
1711 return (subst->lvalue == Tokens->Params[3]->lvalue);
1713 lprintf(1," WARNING: invalid type: [%ld]!\n", subst->wcs_type);
1720 void RegisterConditional(const char *Name, long len,
1722 WCConditionalFunc CondF,
1723 int ContextRequired)
1725 ConditionalStruct *Cond = (ConditionalStruct*)malloc(sizeof(ConditionalStruct));
1726 Cond->PlainName = Name;
1727 Cond->nParams = nParams;
1728 Cond->CondF = CondF;
1729 Cond->ContextRequired = ContextRequired;
1730 Put(Conditionals, Name, len, Cond, NULL);
1733 /*-----------------------------------------------------------------------------
1736 void tmplput_ContextString(StrBuf *Target, int nArgs, WCTemplateToken *Tokens, void *Context, int ContextType)
1738 StrBufAppendTemplate(Target, nArgs, Tokens, Context, ContextType, (StrBuf*)Context, 0);
1740 int ConditionalContextStr(WCTemplateToken *Tokens, void *Context, int ContextType)
1742 StrBuf *TokenText = (StrBuf*) Context;
1743 const char *CompareToken;
1746 GetTemplateTokenString(Tokens, 2, &CompareToken, &len);
1747 return strcmp(ChrPtr(TokenText), CompareToken) == 0;
1750 /*-----------------------------------------------------------------------------
1754 void tmpl_do_boxed(StrBuf *Target, int nArgs, WCTemplateToken *Tokens, void *Context, int ContextType)
1758 if (Tokens->Params[1]->Type == TYPE_STR) {
1759 Headline = NewStrBuf();
1760 DoTemplate(TKEY(1), Headline, Context, ContextType);
1765 GetTemplateTokenString(Tokens,
1769 Headline = NewStrBufPlain(Ch, len);
1773 DoTemplate(HKEY("beginbox"), Target, Headline, CTX_STRBUF);
1774 DoTemplate(TKEY(0), Target, Context, ContextType);
1775 DoTemplate(HKEY("endbox"), Target, Context, ContextType);
1776 FreeStrBuf(&Headline);
1779 /*-----------------------------------------------------------------------------
1783 void tmpl_do_tabbed(StrBuf *Target, int nArgs, WCTemplateToken *Tokens, void *Context, int ContextType)
1786 int i, ntabs, nTabs;
1788 nTabs = ntabs = Tokens->nParameters / 2;
1789 TabNames = (StrBuf **) malloc(ntabs * sizeof(StrBuf*));
1791 for (i = 0; i < ntabs; i++) {
1792 TabNames[i] = NewStrBuf();
1793 if (Tokens->Params[i * 2]->len > 0) {
1794 DoTemplate(TKEY(i * 2), TabNames[i], Context, ContextType);
1797 /** A Tab without subject? we can't count that, add it as silent */
1802 StrTabbedDialog(Target, nTabs, TabNames);
1803 for (i = 0; i < ntabs; i++) {
1804 StrBeginTab(Target, i, nTabs);
1806 DoTemplate(TKEY(i * 2 + 1), Target, Context, ContextType);
1807 StrEndTab(Target, i, nTabs);
1812 /*-----------------------------------------------------------------------------
1817 void RegisterSortFunc(const char *name, long len,
1818 const char *prepend, long preplen,
1819 CompareFunc Forward,
1820 CompareFunc Reverse,
1821 CompareFunc GroupChange,
1824 SortStruct *NewSort = (SortStruct*) malloc(sizeof(SortStruct));
1825 NewSort->Name = NewStrBufPlain(name, len);
1826 if (prepend != NULL)
1827 NewSort->PrefPrepend = NewStrBufPlain(prepend, preplen);
1829 NewSort->PrefPrepend = NULL;
1830 NewSort->Forward = Forward;
1831 NewSort->Reverse = Reverse;
1832 NewSort->GroupChange = GroupChange;
1833 NewSort->ContextType = ContextType;
1834 Put(SortHash, name, len, NewSort, DestroySortStruct);
1837 CompareFunc RetrieveSort(long ContextType, const char *OtherPrefix,
1838 const char *Default, long ldefault, long DefaultDirection)
1841 const StrBuf *BSort;
1844 long SortOrder = -1;
1846 if (havebstr("SortBy")) {
1847 BSort = sbstr("SortBy");
1849 else { /** Try to fallback to our remembered values... */
1850 if (OtherPrefix == NULL) {
1851 BSort = get_room_pref("sort");
1854 /*TODO: nail prefprepend to sort, and lookup this! */
1857 putbstr("SortBy", NewStrBufDup(BSort));
1861 BSort = Buf = NewStrBufPlain(Default, ldefault);
1862 putbstr("SortBy", Buf);
1866 if (!GetHash(SortHash, SKEY(BSort), &vSortBy) ||
1867 (vSortBy == NULL)) {
1869 if (!GetHash(SortHash, Default, ldefault, &vSortBy) ||
1870 (vSortBy == NULL)) {
1871 lprintf(1, "Illegal default sort: [%s]\n", Default);
1875 SortBy = (SortStruct*)vSortBy;
1877 /** Ok, its us, lets see in which direction we should sort... */
1878 if (havebstr("SortOrder")) {
1879 SortOrder = LBSTR("SortOrder");
1881 else { /** Try to fallback to our remembered values... */
1883 if (SortBy->PrefPrepend == NULL) {
1884 Buf = get_room_pref("SortOrder");
1885 SortOrder = StrTol(Buf);
1888 /* TODO: nail prefprepend to sort, and lookup this! */
1892 SortOrder = DefaultDirection;
1894 Buf = NewStrBufPlain(NULL, 64);
1895 StrBufPrintf(Buf, "%ld", SortOrder);
1896 putbstr("SortOrder", Buf);
1898 switch (SortOrder) {
1903 return SortBy->Forward;
1905 return SortBy->Reverse;
1917 ConstStr SortIcons[] = {
1918 {HKEY("static/sort_none.gif")},
1919 {HKEY("static/up_pointer.gif")},
1920 {HKEY("static/down_pointer.gif")},
1923 ConstStr SortNextOrder[] = {
1930 int GetSortMetric(WCTemplateToken *Tokens, SortStruct **Next, SortStruct **Param, long *SortOrder)
1932 int bSortError = eNOT_SPECIFIED;
1933 const StrBuf *BSort;
1938 if (!GetHash(SortHash, TKEY(0), &vSort) ||
1940 return eNO_SUCH_SORT;
1941 *Param = (SortStruct*) vSort;
1944 if (havebstr("SortBy")) {
1945 BSort = sbstr("SortBy");
1946 bSortError = eINVALID_PARAM;
1948 else { /** Try to fallback to our remembered values... */
1949 if ((*Param)->PrefPrepend == NULL) {
1950 BSort = get_room_pref("sort");
1953 /* TODO: nail prefprepend to sort, and lookup this! */
1957 if (!GetHash(SortHash, SKEY(BSort), &vSort) ||
1961 *Next = (SortStruct*) vSort;
1963 /** Ok, its us, lets see in which direction we should sort... */
1964 if (havebstr("SortOrder")) {
1965 *SortOrder = LBSTR("SortOrder");
1967 else { /** Try to fallback to our remembered values... */
1968 if ((*Param)->PrefPrepend == NULL) {
1969 *SortOrder = StrTol(get_room_pref("SortOrder"));
1972 /* TODO: nail prefprepend to sort, and lookup this! */
1982 void tmplput_SORT_ICON(StrBuf *Target, int nArgs, WCTemplateToken *Tokens, void *Context, int ContextType)
1987 const ConstStr *SortIcon;
1989 switch (GetSortMetric(Tokens, &Next, &Param, &SortOrder)){
1991 lprintf(1, "[%s] (in '%s' line %ld); "
1992 " Sorter [%s] unknown! [%s]\n",
1994 ChrPtr(Tokens->FileName),
1996 Tokens->Params[0]->Start,
1997 ChrPtr(Tokens->FlatToken));
2000 "<pre>\n [%s] (in '%s' line %ld);"
2001 " Sorter [%s] unknown!\n[%s]\n</pre>\n",
2003 ChrPtr(Tokens->FileName),
2005 Tokens->Params[0]->Start,
2006 ChrPtr(Tokens->FlatToken));
2008 case eINVALID_PARAM:
2009 lprintf(1, "[%s] (in '%s' line %ld); "
2010 " Sorter specified by BSTR 'SortBy' [%s] unknown! [%s]\n",
2012 ChrPtr(Tokens->FileName),
2015 ChrPtr(Tokens->FlatToken));
2016 case eNOT_SPECIFIED:
2018 if (Next == Param) {
2019 SortIcon = &SortIcons[SortOrder];
2021 else { /** Not Us... */
2022 SortIcon = &SortIcons[0];
2024 StrBufAppendBufPlain(Target, SortIcon->Key, SortIcon->len, 0);
2028 void tmplput_SORT_NEXT(StrBuf *Target, int nArgs, WCTemplateToken *Tokens, void *Context, int ContextType)
2034 switch (GetSortMetric(Tokens, &Next, &Param, &SortOrder)){
2036 lprintf(1, "[%s] (in '%s' line %ld); "
2037 " Sorter [%s] unknown! [%s]\n",
2039 ChrPtr(Tokens->FileName),
2041 Tokens->Params[0]->Start,
2042 ChrPtr(Tokens->FlatToken));
2045 "<pre>\n [%s] (in '%s' line %ld);"
2046 " Sorter [%s] unknown!\n[%s]\n</pre>\n",
2048 ChrPtr(Tokens->FileName),
2050 Tokens->Params[0]->Start,
2051 ChrPtr(Tokens->FlatToken));
2053 case eINVALID_PARAM:
2054 lprintf(1, "[%s] (in '%s' line %ld); "
2055 " Sorter specified by BSTR 'SortBy' [%s] unknown! [%s]\n",
2057 ChrPtr(Tokens->FileName),
2060 ChrPtr(Tokens->FlatToken));
2062 case eNOT_SPECIFIED:
2064 StrBufAppendBuf(Target, Param->Name, 0);
2069 void tmplput_SORT_ORDER(StrBuf *Target, int nArgs, WCTemplateToken *Tokens, void *Context, int ContextType)
2072 const ConstStr *SortOrderStr;
2076 switch (GetSortMetric(Tokens, &Next, &Param, &SortOrder)){
2078 lprintf(1, "[%s] (in '%s' line %ld); "
2079 " Sorter [%s] unknown! [%s]\n",
2081 ChrPtr(Tokens->FileName),
2083 Tokens->Params[0]->Start,
2084 ChrPtr(Tokens->FlatToken));
2087 "<pre>\n [%s] (in '%s' line %ld);"
2088 " Sorter [%s] unknown!\n[%s]\n</pre>\n",
2090 ChrPtr(Tokens->FileName),
2092 Tokens->Params[0]->Start,
2093 ChrPtr(Tokens->FlatToken));
2095 case eINVALID_PARAM:
2096 lprintf(1, "[%s] (in '%s' line %ld); "
2097 " Sorter specified by BSTR 'SortBy' [%s] unknown! [%s]\n",
2099 ChrPtr(Tokens->FileName),
2102 ChrPtr(Tokens->FlatToken));
2104 case eNOT_SPECIFIED:
2106 if (Next == Param) {
2107 SortOrderStr = &SortNextOrder[SortOrder];
2109 else { /** Not Us... */
2110 SortOrderStr = &SortNextOrder[0];
2112 StrBufAppendBufPlain(Target, SortOrderStr->Key, SortOrderStr->len, 0);
2117 void tmplput_long_vector(StrBuf *Target, int nArgs, WCTemplateToken *Tokens, void *Context, int ContextType)
2119 long *LongVector = (long*) Context;
2121 if ((Tokens->Params[0]->Type == TYPE_LONG) &&
2122 (Tokens->Params[0]->lvalue <= LongVector[0]))
2124 StrBufAppendPrintf(Target, "%ld", LongVector[Tokens->Params[0]->lvalue]);
2128 if (Tokens->Params[0]->Type == TYPE_LONG) {
2129 lprintf(1, "longvector [%s] (in '%s' line %ld); needs a long Parameter![%s]\n",
2130 Tokens->Params[0]->Start,
2131 ChrPtr(Tokens->FileName),
2133 ChrPtr(Tokens->FlatToken));
2136 "<pre>\nlongvector [%s] (in '%s' line %ld); needs a numerical Parameter!\n[%s]\n</pre>\n",
2137 Tokens->Params[0]->Start,
2138 ChrPtr(Tokens->FileName),
2140 ChrPtr(Tokens->FlatToken));
2143 lprintf(1, "longvector [%s] (in '%s' line %ld); doesn't have %ld Parameters,"
2144 " its just the size of %ld![%s]\n",
2145 Tokens->Params[0]->Start,
2146 ChrPtr(Tokens->FileName),
2148 Tokens->Params[0]->lvalue,
2150 ChrPtr(Tokens->FlatToken));
2153 "<pre>\nlongvector [%s] (in '%s' line %ld); doesn't have %ld Parameters,"
2154 " its just the size of %ld!\n[%s]\n</pre>\n",
2155 Tokens->Params[0]->Start,
2156 ChrPtr(Tokens->FileName),
2158 Tokens->Params[0]->lvalue,
2160 ChrPtr(Tokens->FlatToken));
2165 void dbg_print_longvector(long *LongVector)
2167 StrBuf *Buf = NewStrBufPlain(HKEY("Longvector: ["));
2168 int nItems = LongVector[0];
2171 for (i = 0; i < nItems; i++) {
2173 StrBufAppendPrintf(Buf, "%d: %ld | ", i, LongVector[i]);
2175 StrBufAppendPrintf(Buf, "%d: %ld]\n", i, LongVector[i]);
2178 lprintf(1, ChrPtr(Buf));
2182 int ConditionalLongVector(WCTemplateToken *Tokens, void *Context, int ContextType)
2184 long *LongVector = (long*) Context;
2186 if ((Tokens->Params[2]->Type == TYPE_LONG) &&
2187 (Tokens->Params[2]->lvalue <= LongVector[0])&&
2188 (Tokens->Params[3]->Type == TYPE_LONG) &&
2189 (Tokens->Params[3]->lvalue <= LongVector[0]))
2191 return LongVector[Tokens->Params[2]->lvalue] == LongVector[Tokens->Params[3]->lvalue];
2195 if ((Tokens->Params[2]->Type == TYPE_LONG) ||
2196 (Tokens->Params[2]->Type == TYPE_LONG)) {
2197 lprintf(1, "ConditionalLongVector [%s] (in '%s' line %ld); needs two long Parameter![%s]\n",
2198 Tokens->Params[0]->Start,
2199 ChrPtr(Tokens->FileName),
2201 ChrPtr(Tokens->FlatToken));
2204 lprintf(1, "longvector [%s] (in '%s' line %ld); doesn't have %ld / %ld Parameters,"
2205 " its just the size of %ld![%s]\n",
2206 Tokens->Params[0]->Start,
2207 ChrPtr(Tokens->FileName),
2209 Tokens->Params[2]->lvalue,
2210 Tokens->Params[3]->lvalue,
2212 ChrPtr(Tokens->FlatToken));
2222 RegisterNamespace("SORT:ICON", 1, 1, tmplput_SORT_ICON, CTX_NONE);
2223 RegisterNamespace("SORT:ORDER", 1, 1, tmplput_SORT_ORDER, CTX_NONE);
2224 RegisterNamespace("SORT:NEXT", 1, 1, tmplput_SORT_NEXT, CTX_NONE);
2225 RegisterNamespace("CONTEXTSTR", 0, 1, tmplput_ContextString, CTX_STRBUF);
2226 RegisterNamespace("ITERATE", 2, 100, tmpl_iterate_subtmpl, CTX_NONE);
2227 RegisterNamespace("DOBOXED", 1, 2, tmpl_do_boxed, CTX_NONE);
2228 RegisterNamespace("DOTABBED", 2, 100, tmpl_do_tabbed, CTX_NONE);
2229 RegisterNamespace("LONGVECTOR", 1, 1, tmplput_long_vector, CTX_LONGVECTOR);
2230 RegisterConditional(HKEY("COND:SUBST"), 3, ConditionalVar, CTX_NONE);
2231 RegisterConditional(HKEY("COND:CONTEXTSTR"), 3, ConditionalContextStr, CTX_STRBUF);
2232 RegisterConditional(HKEY("COND:LONGVECTOR"), 4, ConditionalLongVector, CTX_LONGVECTOR);