5 * \defgroup Subst Variable substitution type stuff
6 * \ingroup CitadelConfig
12 #include <sys/types.h>
18 #define SHOW_ME_VAPPEND_PRINTF
21 #include "webserver.h"
23 extern char *static_dirs[PATH_MAX]; /**< Disk representation */
25 HashList *WirelessTemplateCache;
26 HashList *WirelessLocalTemplateCache;
27 HashList *TemplateCache;
28 HashList *LocalTemplateCache;
32 HashList *Conditionals;
35 int LoadTemplates = 0;
36 WCTemplputParams NoCtx;
39 #define SV_CONDITIONAL 2
40 #define SV_NEG_CONDITIONAL 3
41 #define SV_CUST_STR_CONDITIONAL 4
43 #define SV_PREEVALUATED 6
45 typedef struct _WCTemplate {
50 WCTemplateToken **Tokens;
53 typedef struct _HashHandler {
56 WCHandlerFunc HandlerFunc;
59 void *load_template(StrBuf *filename, StrBuf *Key, HashList *PutThere);
60 int EvaluateConditional(StrBuf *Target, int Neg, int state, WCTemplputParams *TP);
62 typedef struct _SortStruct {
67 CompareFunc GroupChange;
72 const char *CtxNames[] = {
94 void DestroySortStruct(void *vSort)
96 SortStruct *Sort = (SortStruct*) vSort;
97 FreeStrBuf(&Sort->Name);
98 FreeStrBuf(&Sort->PrefPrepend);
102 void LogTemplateError (StrBuf *Target, const char *Type, int ErrorPos, WCTemplputParams *TP, const char *Format, ...)
107 const char *Err = NULL;
112 va_start(arg_ptr, Format);
113 StrBufVAppendPrintf(Error, Format, arg_ptr);
118 case ERR_NAME: /* the main token name... */
119 Err = TP->Tokens->pName;
122 Err = TP->Tokens->Params[0]->Start;
125 Err = TP->Tokens->Params[1]->Start;
128 lprintf(1, "%s [%s] (in '%s' line %ld); %s; [%s]\n",
131 ChrPtr(TP->Tokens->FileName),
134 ChrPtr(TP->Tokens->FlatToken));
135 if (Target != NULL) {
138 "<pre>\n%s [%s] (in '%s' line %ld); %s\n[%s]\n</pre>\n",
141 ChrPtr(TP->Tokens->FileName),
144 ChrPtr(TP->Tokens->FlatToken));
149 void RegisterNS(const char *NSName,
153 WCHandlerFunc HandlerFunc,
156 HashHandler *NewHandler;
158 NewHandler = (HashHandler*) malloc(sizeof(HashHandler));
159 NewHandler->Filter.nMinArgs = nMinArgs;
160 NewHandler->Filter.nMaxArgs = nMaxArgs;
161 NewHandler->Filter.ContextType = ContextRequired;
162 NewHandler->Filter.ControlContextType = CTX_NONE;
164 NewHandler->HandlerFunc = HandlerFunc;
165 Put(GlobalNS, NSName, len, NewHandler, NULL);
168 void RegisterControlNS(const char *NSName,
172 WCHandlerFunc HandlerFunc,
173 int ControlContextRequired)
175 HashHandler *NewHandler;
177 NewHandler = (HashHandler*) malloc(sizeof(HashHandler));
178 NewHandler->Filter.nMinArgs = nMinArgs;
179 NewHandler->Filter.nMaxArgs = nMaxArgs;
180 NewHandler->Filter.ContextType = CTX_NONE;
181 NewHandler->Filter.ControlContextType = ControlContextRequired;
182 NewHandler->HandlerFunc = HandlerFunc;
183 Put(GlobalNS, NSName, len, NewHandler, NULL);
188 int CheckContext(StrBuf *Target, ContextFilter *Need, WCTemplputParams *TP, const char *ErrType)
190 if ((Need->ContextType != CTX_NONE) &&
191 (Need->ContextType != TP->Filter.ContextType)) {
193 Target, ErrType, ERR_PARM1, TP,
194 " WARNING: requires Context: [%s], have [%s]!",
195 CtxNames[Need->ContextType],
196 CtxNames[TP->Filter.ContextType]);
200 if ((Need->ControlContextType != CTX_NONE) &&
201 (Need->ControlContextType != TP->Filter.ControlContextType)) {
203 Target, ErrType, ERR_PARM1, TP,
204 " WARNING: requires Control Context: [%s], have [%s]!",
205 CtxNames[Need->ControlContextType],
206 CtxNames[TP->Filter.ControlContextType]);
210 if (TP->Tokens->nParameters < Need->nMinArgs) {
211 LogTemplateError(Target, ErrType, ERR_NAME, TP,
212 "needs at least %ld params, have %ld",
214 TP->Tokens->nParameters);
218 else if (TP->Tokens->nParameters > Need->nMaxArgs) {
219 LogTemplateError(Target, ErrType, ERR_NAME, TP,
220 "just needs %ld params, you gave %ld",
221 TP->Tokens->nParameters,
229 void FreeToken(WCTemplateToken **Token)
232 FreeStrBuf(&(*Token)->FlatToken);
233 if ((*Token)->HaveParameters)
234 for (i = 0; i < (*Token)->nParameters; i++)
235 free((*Token)->Params[i]);
242 void FreeWCTemplate(void *vFreeMe)
245 WCTemplate *FreeMe = (WCTemplate*)vFreeMe;
247 if (FreeMe->TokenSpace > 0) {
248 for (i = 0; i < FreeMe->nTokensUsed; i ++) {
249 FreeToken(&FreeMe->Tokens[i]);
251 free(FreeMe->Tokens);
253 FreeStrBuf(&FreeMe->FileName);
254 FreeStrBuf(&FreeMe->Data);
260 * \brief debugging function to print array to log
262 void VarPrintTransition(void *vVar1, void *vVar2, int odd){}
264 * \brief debugging function to print array to log
266 void VarPrintEntry(const char *Key, void *vSubst, int odd)
269 lprintf(1,"Subst[%s] : ", Key);
270 ptr = (wcsubst*) vSubst;
272 switch(ptr->wcs_type) {
274 lprintf(1, " -> %s\n", ChrPtr(ptr->wcs_value));
277 lprintf(1, " -> Server [%s]\n", ChrPtr(ptr->wcs_value));
280 lprintf(1, " -> function at [%0xd]\n", ptr->wcs_function);
283 lprintf(1," WARNING: invalid type: [%ld]!\n", ptr->wcs_type);
290 * \brief Clear out the list of substitution variables local to this session
292 void clear_substs(wcsession *wc) {
294 if (wc->vars != NULL) {
295 DeleteHash(&wc->vars);
300 * \brief Clear out the list of substitution variables local to this session
302 void clear_local_substs(void) {
321 void FlushPayload(wcsubst *ptr, int reusestrbuf, int type)
323 int NeedNew = NeedNewBuf(type);
324 switch(ptr->wcs_type) {
328 if (reusestrbuf && NeedNew) {
329 FlushStrBuf(ptr->wcs_value);
333 FreeStrBuf(&ptr->wcs_value);
334 ptr->wcs_value = NULL;
338 ptr->wcs_function = NULL;
339 if (reusestrbuf && NeedNew)
340 ptr->wcs_value = NewStrBuf();
343 ptr->wcs_value = NULL;
344 if (reusestrbuf && NeedNew)
345 ptr->wcs_value = NewStrBuf();
349 if (reusestrbuf && NeedNew)
350 ptr->wcs_value = NewStrBuf();
353 if (reusestrbuf && NeedNew)
354 ptr->wcs_value = NewStrBuf();
361 * \brief destructor; kill one entry.
363 void deletevar(void *data)
365 wcsubst *ptr = (wcsubst*)data;
366 FlushPayload(ptr, 0, ptr->wcs_type);
371 wcsubst *NewSubstVar(const char *keyname, int keylen, int type)
376 ptr = (wcsubst *) malloc(sizeof(wcsubst));
377 memset(ptr, 0, sizeof(wcsubst));
379 ptr->wcs_type = type;
380 safestrncpy(ptr->wcs_key, keyname, sizeof ptr->wcs_key);
381 Put(WCC->vars, keyname, keylen, ptr, deletevar);
383 switch(ptr->wcs_type) {
386 ptr->wcs_value = NewStrBuf();
400 * \brief Add a substitution variable (local to this session) (strlen version...)
401 * \param keyname the replacementstring to substitute
402 * \param keytype the kind of the key
403 * \param format the format string ala printf
404 * \param ... the arguments to substitute in the formatstring
406 void SVPRINTF(char *keyname, int keytype, const char *format,...)
414 keylen = strlen(keyname);
416 * First look if we're doing a replacement of
419 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
420 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
421 ptr = (wcsubst*)vPtr;
422 FlushPayload(ptr, keytype, keytype);
423 ptr->wcs_type = keytype;
425 else /** Otherwise allocate a new one */
427 ptr = NewSubstVar(keyname, keylen, keytype);
430 /** Format the string */
431 va_start(arg_ptr, format);
432 StrBufVAppendPrintf(ptr->wcs_value, format, arg_ptr);
437 * \brief Add a substitution variable (local to this session)
438 * \param keyname the replacementstring to substitute
439 * \param keytype the kind of the key
440 * \param format the format string ala printf
441 * \param ... the arguments to substitute in the formatstring
443 void svprintf(char *keyname, size_t keylen, int keytype, const char *format,...)
451 * First look if we're doing a replacement of
454 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
455 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
456 ptr = (wcsubst*)vPtr;
457 FlushPayload(ptr, 1, keytype);
458 ptr->wcs_type = keytype;
460 else /** Otherwise allocate a new one */
462 ptr = NewSubstVar(keyname, keylen, keytype);
465 /** Format the string and save it */
466 va_start(arg_ptr, format);
467 StrBufVAppendPrintf(ptr->wcs_value, format, arg_ptr);
472 * \brief Add a substitution variable (local to this session)
473 * \param keyname the replacementstring to substitute
474 * \param keytype the kind of the key
475 * \param format the format string ala printf
476 * \param ... the arguments to substitute in the formatstring
478 void SVPut(char *keyname, size_t keylen, int keytype, char *Data)
486 * First look if we're doing a replacement of
489 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
490 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
491 ptr = (wcsubst*)vPtr;
492 FlushPayload(ptr, 1, keytype);
493 ptr->wcs_type = keytype;
495 else /** Otherwise allocate a new one */
497 ptr = NewSubstVar(keyname, keylen, keytype);
499 StrBufAppendBufPlain(ptr->wcs_value, Data, -1, 0);
503 * \brief Add a substitution variable (local to this session)
504 * \param keyname the replacementstring to substitute
505 * \param keytype the kind of the key
506 * \param format the format string ala printf
507 * \param ... the arguments to substitute in the formatstring
509 void SVPutLong(char *keyname, size_t keylen, long Data)
517 * First look if we're doing a replacement of
520 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
521 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
522 ptr = (wcsubst*)vPtr;
523 FlushPayload(ptr, 1, WCS_LONG);
524 ptr->wcs_type = WCS_LONG;
526 else /** Otherwise allocate a new one */
528 ptr = NewSubstVar(keyname, keylen, WCS_LONG);
534 * \brief Add a substitution variable (local to this session) that does a callback
535 * \param keyname the keystring to substitute
536 * \param fcn_ptr the function callback to give the substitution string
538 void SVCallback(char *keyname, size_t keylen, WCHandlerFunc fcn_ptr)
545 * First look if we're doing a replacement of
548 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
549 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
550 ptr = (wcsubst*)vPtr;
551 FlushPayload(ptr, 1, WCS_FUNCTION);
552 ptr->wcs_type = WCS_FUNCTION;
554 else /** Otherwise allocate a new one */
556 ptr = NewSubstVar(keyname, keylen, WCS_FUNCTION);
559 ptr->wcs_function = fcn_ptr;
561 inline void SVCALLBACK(char *keyname, WCHandlerFunc fcn_ptr)
563 SVCallback(keyname, strlen(keyname), fcn_ptr);
568 void SVPUTBuf(const char *keyname, int keylen, const StrBuf *Buf, int ref)
575 * First look if we're doing a replacement of
578 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
579 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
580 ptr = (wcsubst*)vPtr;
581 FlushPayload(ptr, 0, (ref)?WCS_STRBUF_REF:WCS_STRBUF);
582 ptr->wcs_type = (ref)?WCS_STRBUF_REF:WCS_STRBUF;
584 else /** Otherwise allocate a new one */
586 ptr = NewSubstVar(keyname, keylen, (ref)?WCS_STRBUF_REF:WCS_STRBUF);
588 ptr->wcs_value = (StrBuf*)Buf;
592 * \brief back end for print_value_of() ... does a server command
593 * \param servcmd server command to execute on the citadel server
595 void pvo_do_cmd(StrBuf *Target, StrBuf *servcmd) {
599 serv_puts(ChrPtr(servcmd));
600 len = serv_getln(buf, sizeof buf);
606 StrBufAppendPrintf(Target, "%s\n", &buf[4]);
609 _fmout(Target, "CENTER");
612 StrBufAppendPrintf(Target, "%s\n", &buf[4]);
618 void GetTemplateTokenString(WCTemplputParams *TP,
624 WCTemplputParams SubTP;
626 if (TP->Tokens->nParameters < N) {
627 lprintf(1, "invalid token. this shouldn't have come till here.\n");
634 switch (TP->Tokens->Params[N]->Type) {
637 *Value = TP->Tokens->Params[N]->Start;
638 *len = TP->Tokens->Params[N]->len;
641 Buf = (StrBuf*) SBstr(TKEY(N));
642 *Value = ChrPtr(Buf);
643 *len = StrLength(Buf);
646 get_PREFERENCE(TKEY(N), &Buf);
647 *Value = ChrPtr(Buf);
648 *len = StrLength(Buf);
652 break; /* todo: string to text? */
654 *Value = _(TP->Tokens->Params[N]->Start);
655 *len = strlen(*Value);
657 case TYPE_SUBTEMPLATE:
658 memset(&SubTP, 0, sizeof(WCTemplputParams *));
659 SubTP.Context = TP->Context;
660 SubTP.Filter.ContextType = TP->Filter.ContextType;
662 DoTemplate(TKEY(N), Buf, &SubTP);
663 *Value = ChrPtr(Buf);
664 *len = StrLength(Buf);
665 /* we can't free it here, so we put it into the subst so its discarded later on. */
666 SVPUTBuf(TKEY(N), Buf, 0);
678 * \brief Print the value of a variable
679 * \param keyname get a key to print
681 void print_value_of(StrBuf *Target, WCTemplputParams *TP)
688 /*if (WCC->vars != NULL) PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
689 /* TODO: depricated! */
690 if (TP->Tokens->pName[0] == '=') {
691 DoTemplate(TP->Tokens->pName+1, TP->Tokens->NameEnd - 1, NULL, &NoCtx);
693 /*/////TODO: if param[1] == "U" -> urlescape
695 /** Page-local variables */
696 if ((WCC->vars!= NULL) && GetHash(WCC->vars, TP->Tokens->pName, TP->Tokens->NameEnd, &vVar)) {
697 ptr = (wcsubst*) vVar;
698 switch(ptr->wcs_type) {
700 StrBufAppendBuf(Target, ptr->wcs_value, 0);
703 pvo_do_cmd(Target, ptr->wcs_value);
706 (*ptr->wcs_function) (Target, TP);
710 StrBufAppendBuf(Target, ptr->wcs_value, 0);
713 StrBufAppendPrintf(Target, "%ld", ptr->lvalue);
717 Target, "Subst", ERR_NAME, TP,
718 "WARNING: invalid value in SV-Hash at %s!", TP->Tokens->pName);
723 Target, "Token", ERR_NAME, TP,
724 "didn't find Handler");
729 int CompareSubstToToken(TemplateParam *ParamToCompare, TemplateParam *ParamToLookup)
735 if ((WCC->vars!= NULL) && GetHash(WCC->vars, ParamToLookup->Start,
736 ParamToLookup->len, &vVar)) {
737 ptr = (wcsubst*) vVar;
738 switch(ptr->wcs_type) {
742 if (ParamToCompare->Type == TYPE_STR)
743 return ((ParamToCompare->len == StrLength(ptr->wcs_value)) &&
744 (strcmp(ParamToCompare->Start, ChrPtr(ptr->wcs_value)) == 0));
746 return ParamToCompare->lvalue == StrTol(ptr->wcs_value);
754 if (ParamToCompare->Type == TYPE_STR)
757 return ParamToCompare->lvalue == ptr->lvalue;
760 lprintf(1,"WARNING: invalid value in SV-Hash at %s!\n",
761 ParamToLookup->Start);
767 int CompareSubstToStrBuf(StrBuf *Compare, TemplateParam *ParamToLookup)
773 if ((WCC->vars!= NULL) && GetHash(WCC->vars, ParamToLookup->Start,
774 ParamToLookup->len, &vVar)) {
775 ptr = (wcsubst*) vVar;
776 switch(ptr->wcs_type) {
780 return ((StrLength(Compare) == StrLength(ptr->wcs_value)) &&
781 (strcmp(ChrPtr(Compare), ChrPtr(ptr->wcs_value)) == 0));
788 return StrTol(Compare) == ptr->lvalue;
790 lprintf(1,"WARNING: invalid value in SV-Hash at %s!\n",
791 ParamToLookup->Start);
800 * \brief puts string into the template and computes which escape methon we should use
801 * \param Source the string we should put into the template
802 * \param FormatTypeIndex where should we look for escape types if?
804 void StrBufAppendTemplate(StrBuf *Target,
805 WCTemplputParams *TP,
806 const StrBuf *Source, int FormatTypeIndex)
812 if ((FormatTypeIndex < TP->Tokens->nParameters) &&
813 (TP->Tokens->Params[FormatTypeIndex]->Type == TYPE_STR) &&
814 (TP->Tokens->Params[FormatTypeIndex]->len == 1)) {
815 EscapeAs = *TP->Tokens->Params[FormatTypeIndex]->Start;
822 Buf = NewStrBufPlain(NULL, StrLength(Source));
823 StrBuf_RFC822_to_Utf8(Buf,
825 (WCC!=NULL)? WCC->DefaultCharset : NULL,
827 StrEscAppend(Target, Buf, NULL, 0, 0);
831 StrEscAppend(Target, Source, NULL, 0, 0);
834 StrECMAEscAppend(Target, Source, NULL);
837 StrBufAppendBuf(Target, Source, 0);
842 void PutNewToken(WCTemplate *Template, WCTemplateToken *NewToken)
844 if (Template->nTokensUsed + 1 >= Template->TokenSpace) {
845 if (Template->TokenSpace <= 0) {
846 Template->Tokens = (WCTemplateToken**)malloc(
847 sizeof(WCTemplateToken*) * 10);
848 Template->TokenSpace = 10;
851 WCTemplateToken **NewTokens;
852 NewTokens= (WCTemplateToken**)malloc(
853 sizeof(WCTemplateToken*) *
854 Template->TokenSpace * 2);
855 memcpy(NewTokens, Template->Tokens,
856 sizeof(WCTemplateToken*) * Template->nTokensUsed);
857 free(Template->Tokens);
858 Template->TokenSpace *= 2;
859 Template->Tokens = NewTokens;
862 Template->Tokens[(Template->nTokensUsed)++] = NewToken;
865 TemplateParam *GetNextParameter(StrBuf *Buf, const char **pCh, const char *pe, WCTemplateToken *Tokens, WCTemplate *pTmpl)
867 const char *pch = *pCh;
868 const char *pchs, *pche;
869 TemplateParam *Parm = (TemplateParam *) malloc(sizeof(TemplateParam));
873 Parm->Type = TYPE_STR;
875 /* Skip leading whitespaces */
876 while ((*pch == ' ' )||
879 (*pch == '\n')) pch ++;
882 Parm->Type = TYPE_PREFSTR;
889 else if (*pch == ';') {
890 Parm->Type = TYPE_PREFINT;
897 else if (*pch == '_') {
898 Parm->Type = TYPE_GETTEXT;
905 else if (*pch == 'B') {
906 Parm->Type = TYPE_BSTR;
913 else if (*pch == '=') {
914 Parm->Type = TYPE_SUBTEMPLATE;
925 else if (*pch == '\'')
932 ( (pch > pchs) && (*(pch - 1) == '\\'))
938 lprintf(1, "Error (in '%s' line %ld); "
939 "evaluating template param [%s] in Token [%s]\n",
940 ChrPtr(pTmpl->FileName),
942 ChrPtr(Tokens->FlatToken),
949 StrBufPeek(Buf, pch, -1, '\0');
950 if (LoadTemplates > 1) {
951 lprintf(1, "DBG: got param [%s] %ld %ld\n",
952 pchs, pche - pchs, strlen(pchs));
955 Parm->len = pche - pchs;
956 pch ++; /* move after trailing quote */
957 if (ParamBrace && (*pch == ')')) {
964 Parm->Type = TYPE_LONG;
966 while ((pch <= pe) &&
973 StrBufPeek(Buf, pch, -1, '\0');
974 Parm->lvalue = atol(pchs);
981 lprintf(1, "Error (in '%s' line %ld); "
982 "evaluating long template param [%s] in Token [%s]\n",
983 ChrPtr(pTmpl->FileName),
985 ChrPtr(Tokens->FlatToken),
992 while ((*pch == ' ' )||
996 (*pch == '\n')) pch ++;
1002 WCTemplateToken *NewTemplateSubstitute(StrBuf *Buf,
1004 const char *pTmplStart,
1005 const char *pTmplEnd,
1011 TemplateParam *Param;
1012 WCTemplateToken *NewToken = (WCTemplateToken*)malloc(sizeof(WCTemplateToken));
1013 WCTemplputParams TP;
1015 TP.Tokens = NewToken;
1016 NewToken->FileName = pTmpl->FileName; /* to print meaningfull log messages... */
1017 NewToken->Flags = 0;
1018 NewToken->Line = Line + 1;
1019 NewToken->pTokenStart = pTmplStart;
1020 NewToken->TokenStart = pTmplStart - pStart;
1021 NewToken->TokenEnd = (pTmplEnd - pStart) - NewToken->TokenStart;
1022 NewToken->pTokenEnd = pTmplEnd;
1023 NewToken->NameEnd = NewToken->TokenEnd - 2;
1024 NewToken->PreEval = NULL;
1025 NewToken->FlatToken = NewStrBufPlain(pTmplStart + 2, pTmplEnd - pTmplStart - 2);
1027 StrBufPeek(Buf, pTmplStart, + 1, '\0');
1028 StrBufPeek(Buf, pTmplEnd, -1, '\0');
1029 pch = NewToken->pName = pTmplStart + 2;
1031 NewToken->HaveParameters = 0;;
1032 NewToken->nParameters = 0;
1034 while (pch < pTmplEnd - 1) {
1036 StrBufPeek(Buf, pch, -1, '\0');
1037 NewToken->NameEnd = pch - NewToken->pName;
1039 if (*(pTmplEnd - 1) != ')') {
1041 NULL, "Parseerror", ERR_NAME, &TP,
1042 "Warning, Non welformed Token; missing right parenthesis");
1044 while (pch < pTmplEnd - 1) {
1045 Param = GetNextParameter(Buf, &pch, pTmplEnd - 1, NewToken, pTmpl);
1046 if (Param != NULL) {
1047 NewToken->HaveParameters = 1;
1048 if (NewToken->nParameters > MAXPARAM) {
1050 NULL, "Parseerror", ERR_NAME, &TP,
1051 "only [%ld] Params allowed in Tokens",
1055 FreeToken(&NewToken);
1058 NewToken->Params[NewToken->nParameters++] = Param;
1062 if((NewToken->NameEnd == 1) &&
1063 (NewToken->HaveParameters == 1))
1066 if (*(NewToken->pName) == '_')
1067 NewToken->Flags = SV_GETTEXT;
1068 else if (*(NewToken->pName) == '=')
1069 NewToken->Flags = SV_SUBTEMPL;
1070 else if (*(NewToken->pName) == '%')
1071 NewToken->Flags = SV_CUST_STR_CONDITIONAL;
1072 else if (*(NewToken->pName) == '?')
1073 NewToken->Flags = SV_CONDITIONAL;
1074 else if (*(NewToken->pName) == '!')
1075 NewToken->Flags = SV_NEG_CONDITIONAL;
1081 switch (NewToken->Flags) {
1083 /* If we're able to find out more about the token, do it now while its fresh. */
1084 if (GetHash(GlobalNS, NewToken->pName, NewToken->NameEnd, &vVar)) {
1085 HashHandler *Handler;
1086 Handler = (HashHandler*) vVar;
1087 if ((NewToken->nParameters < Handler->Filter.nMinArgs) ||
1088 (NewToken->nParameters > Handler->Filter.nMaxArgs)) {
1090 NULL, "Token", ERR_NAME, &TP,
1091 "doesn't work with %ld params",
1092 NewToken->nParameters);
1096 NewToken->PreEval = Handler;
1097 NewToken->Flags = SV_PREEVALUATED;
1102 if (NewToken->nParameters !=1) {
1104 NULL, "Gettext", ERR_NAME, &TP,
1105 "requires exactly 1 parameter, you gave %ld params",
1106 NewToken->nParameters);
1107 NewToken->Flags = 0;
1112 if (NewToken->nParameters != 1) {
1114 NULL, "Subtemplates", ERR_NAME, &TP,
1115 "require exactly 1 parameter, you gave %ld params",
1116 NewToken->nParameters);
1120 case SV_CUST_STR_CONDITIONAL:
1121 case SV_CONDITIONAL:
1122 case SV_NEG_CONDITIONAL:
1123 if (NewToken->nParameters <2) {
1125 NULL, "Conditional", ERR_NAME, &TP,
1126 "require at least 2 parameters, you gave %ld params",
1127 NewToken->nParameters);
1128 NewToken->Flags = 0;
1131 if (NewToken->Params[1]->lvalue == 0) {
1133 NULL, "Conditional", ERR_NAME, &TP,
1134 "Conditional ID (Parameter 1) mustn't be 0!");
1135 NewToken->Flags = 0;
1138 if (!GetHash(Conditionals,
1139 NewToken->Params[0]->Start,
1140 NewToken->Params[0]->len,
1143 if ((NewToken->Params[0]->len == 1) &&
1144 (NewToken->Params[0]->Start[0] == 'X'))
1147 NULL, "Conditional", ERR_NAME, &TP,
1150 NewToken->Error = NewStrBuf();
1153 "<pre>\nConditional [%s] (in '%s' line %ld); Not found!\n[%s]\n</pre>\n",
1154 NewToken->Params[0]->Start,
1155 ChrPtr(pTmpl->FileName),
1157 ChrPtr(NewToken->FlatToken));
1161 NewToken->PreEval = vVar;
1173 * \brief Display a variable-substituted template
1174 * \param templatename template file to load
1176 void *prepare_template(StrBuf *filename, StrBuf *Key, HashList *PutThere)
1178 WCTemplate *NewTemplate;
1179 NewTemplate = (WCTemplate *) malloc(sizeof(WCTemplate));
1180 NewTemplate->Data = NULL;
1181 NewTemplate->FileName = NewStrBufDup(filename);
1182 NewTemplate->nTokensUsed = 0;
1183 NewTemplate->TokenSpace = 0;
1184 NewTemplate->Tokens = NULL;
1186 Put(PutThere, ChrPtr(Key), StrLength(Key), NewTemplate, FreeWCTemplate);
1191 * \brief Display a variable-substituted template
1192 * \param templatename template file to load
1194 void *load_template(StrBuf *filename, StrBuf *Key, HashList *PutThere)
1197 struct stat statbuf;
1198 const char *pS, *pE, *pch, *Err;
1201 WCTemplate *NewTemplate;
1203 fd = open(ChrPtr(filename), O_RDONLY);
1205 lprintf(1, "ERROR: could not open template '%s' - %s\n",
1206 ChrPtr(filename), strerror(errno));
1210 if (fstat(fd, &statbuf) == -1) {
1211 lprintf(1, "ERROR: could not stat template '%s' - %s\n",
1212 ChrPtr(filename), strerror(errno));
1216 NewTemplate = (WCTemplate *) malloc(sizeof(WCTemplate));
1217 NewTemplate->Data = NewStrBufPlain(NULL, statbuf.st_size);
1218 NewTemplate->FileName = NewStrBufDup(filename);
1219 NewTemplate->nTokensUsed = 0;
1220 NewTemplate->TokenSpace = 0;
1221 NewTemplate->Tokens = NULL;
1222 if (StrBufReadBLOB(NewTemplate->Data, &fd, 1, statbuf.st_size, &Err) < 0) {
1224 FreeWCTemplate(NewTemplate);
1225 lprintf(1, "ERROR: reading template '%s' - %s<br />\n",
1226 ChrPtr(filename), strerror(errno));
1232 pS = pch = ChrPtr(NewTemplate->Data);
1233 pE = pS + StrLength(NewTemplate->Data);
1235 const char *pts, *pte;
1237 int InDoubleQuotes = 0;
1239 /** Find one <? > */
1241 for (; pch < pE; pch ++) {
1242 if ((*pch=='<')&&(*(pch + 1)=='?'))
1244 if (*pch=='\n') Line ++;
1250 /** Found one? parse it. */
1251 for (; pch <= pE - 1; pch ++) {
1253 InDoubleQuotes = ! InDoubleQuotes;
1254 else if (*pch == '\'')
1255 InQuotes = ! InQuotes;
1256 else if ((!InQuotes && !InDoubleQuotes) &&
1257 ((*pch!='\\')&&(*(pch + 1)=='>'))) {
1265 PutNewToken(NewTemplate,
1266 NewTemplateSubstitute(NewTemplate->Data, pS, pts, pte, Line, NewTemplate));
1269 if (LoadTemplates == 0)
1270 Put(PutThere, ChrPtr(Key), StrLength(Key), NewTemplate, FreeWCTemplate);
1275 const char* PrintTemplate(void *vSubst)
1277 WCTemplate *Tmpl = vSubst;
1279 return ChrPtr(Tmpl->FileName);
1283 int LoadTemplateDir(const char *DirName, HashList *wireless, HashList *big)
1288 DIR *filedir = NULL;
1289 struct dirent *filedir_entry;
1295 StrBufPrintf(Dir, "%s/t", DirName);
1296 filedir = opendir (ChrPtr(Dir));
1297 if (filedir == NULL) {
1302 FileName = NewStrBuf();
1304 while ((filedir_entry = readdir(filedir)))
1308 #ifdef _DIRENT_HAVE_D_NAMELEN
1309 d_namelen = filedir_entry->d_namelen;
1311 d_namelen = strlen(filedir_entry->d_name);
1313 d_without_ext = d_namelen;
1314 while ((d_without_ext > 0) && (filedir_entry->d_name[d_without_ext] != '.'))
1316 if ((d_without_ext == 0) || (d_namelen < 3))
1318 if ((d_namelen > 1) && filedir_entry->d_name[d_namelen - 1] == '~')
1319 continue; /* Ignore backup files... */
1321 IsMobile = (strstr(filedir_entry->d_name, ".m.html")!= NULL);
1322 PStart = filedir_entry->d_name;
1323 StrBufPrintf(FileName, "%s/%s", ChrPtr(Dir), filedir_entry->d_name);
1324 MinorPtr = strchr(filedir_entry->d_name, '.');
1325 if (MinorPtr != NULL)
1327 StrBufPlain(Tag, filedir_entry->d_name, MinorPtr - filedir_entry->d_name);
1329 if (LoadTemplates > 1)
1330 lprintf(1, "%s %d %s\n",ChrPtr(FileName), IsMobile, ChrPtr(Tag));
1331 if (LoadTemplates == 0)
1332 load_template(FileName, Tag, (IsMobile)?wireless:big);
1334 prepare_template(FileName, Tag, (IsMobile)?wireless:big);
1337 FreeStrBuf(&FileName);
1343 void InitTemplateCache(void)
1345 LoadTemplateDir(static_dirs[0],
1346 WirelessTemplateCache,
1348 LoadTemplateDir(static_dirs[1],
1349 WirelessLocalTemplateCache,
1350 LocalTemplateCache);
1355 /*-----------------------------------------------------------------------------
1356 * Filling & processing Templates
1359 * \brief executes one token
1360 * \param Target buffer to append to
1361 * \param Token da to process.
1362 * \param Template we're iterating
1363 * \param Context Contextpoointer to pass in
1364 * \param state are we in conditional state?
1365 * \param ContextType what type of information does context giv us?
1367 int EvaluateToken(StrBuf *Target, int state, WCTemplputParams *TP)
1369 const char *AppendMe;
1371 HashHandler *Handler;
1374 /* much output, since pName is not terminated...
1375 lprintf(1,"Doing token: %s\n",Token->pName);
1378 switch (TP->Tokens->Flags) {
1380 TmplGettext(Target, TP);
1382 case SV_CONDITIONAL: /** Forward conditional evaluation */
1383 return EvaluateConditional(Target, 1, state, TP);
1385 case SV_NEG_CONDITIONAL: /** Reverse conditional evaluation */
1386 return EvaluateConditional(Target, 0, state, TP);
1388 case SV_CUST_STR_CONDITIONAL: /** Conditional put custom strings from params */
1389 if (TP->Tokens->nParameters >= 6) {
1390 if (EvaluateConditional(Target, 0, state, TP)) {
1391 GetTemplateTokenString(TP, 5, &AppendMe, &AppendMeLen);
1392 StrBufAppendBufPlain(Target,
1398 GetTemplateTokenString(TP, 4, &AppendMe, &AppendMeLen);
1399 StrBufAppendBufPlain(Target,
1407 Target, "Conditional", ERR_NAME, TP,
1408 "needs at least 6 Params!");
1412 if (TP->Tokens->nParameters == 1)
1413 DoTemplate(TKEY(0), Target, TP);
1415 case SV_PREEVALUATED:
1416 Handler = (HashHandler*) TP->Tokens->PreEval;
1417 if (!CheckContext(Target, &Handler->Filter, TP, "Token")) {
1420 Handler->HandlerFunc(Target, TP);
1423 if (GetHash(GlobalNS, TP->Tokens->pName, TP->Tokens->NameEnd, &vVar)) {
1424 Handler = (HashHandler*) vVar;
1425 if (!CheckContext(Target, &Handler->Filter, TP, "Token")) {
1429 Handler->HandlerFunc(Target, TP);
1433 print_value_of(Target, TP);
1441 void ProcessTemplate(WCTemplate *Tmpl, StrBuf *Target, void *Context, int ContextType)
1443 WCTemplate *pTmpl = Tmpl;
1446 const char *pData, *pS;
1448 WCTemplputParams TP;
1450 TP.Context = Context;
1451 TP.Filter.ContextType = ContextType;
1453 if (LoadTemplates != 0) {
1454 if (LoadTemplates > 1)
1455 lprintf(1, "DBG: ----- loading: [%s] ------ \n",
1456 ChrPtr(Tmpl->FileName));
1458 pTmpl = load_template(Tmpl->FileName, NULL, NULL);
1462 "<pre>\nError loading Template [%s]\n See Logfile for details\n</pre>\n",
1463 ChrPtr(Tmpl->FileName));
1469 pS = pData = ChrPtr(pTmpl->Data);
1470 len = StrLength(pTmpl->Data);
1474 if (i >= pTmpl->nTokensUsed) {
1475 StrBufAppendBufPlain(Target,
1477 len - (pData - pS), 0);
1481 StrBufAppendBufPlain(
1483 pTmpl->Tokens[i]->pTokenStart - pData, 0);
1484 TP.Tokens = pTmpl->Tokens[i];
1485 TP.nArgs = pTmpl->Tokens[i]->nParameters;
1486 state = EvaluateToken(Target, state, &TP);
1488 while ((state != 0) && (i+1 < pTmpl->nTokensUsed)) {
1489 /* condition told us to skip till its end condition */
1491 TP.Tokens = pTmpl->Tokens[i];
1492 TP.nArgs = pTmpl->Tokens[i]->nParameters;
1493 if ((pTmpl->Tokens[i]->Flags == SV_CONDITIONAL) ||
1494 (pTmpl->Tokens[i]->Flags == SV_NEG_CONDITIONAL)) {
1495 if (state == EvaluateConditional(
1497 pTmpl->Tokens[i]->Flags,
1503 pData = pTmpl->Tokens[i++]->pTokenEnd + 1;
1504 if (i > pTmpl->nTokensUsed)
1508 if (LoadTemplates != 0) {
1509 FreeWCTemplate(pTmpl);
1514 * \brief Display a variable-substituted template
1515 * \param templatename template file to load
1517 void DoTemplate(const char *templatename, long len, StrBuf *Target, WCTemplputParams *TP)
1520 HashList *StaticLocal;
1525 if (WC->is_mobile) {
1526 Static = WirelessTemplateCache;
1527 StaticLocal = WirelessLocalTemplateCache;
1530 Static = TemplateCache;
1531 StaticLocal = LocalTemplateCache;
1536 lprintf (1, "Can't to load a template with empty name!\n");
1537 StrBufAppendPrintf(Target, "<pre>\nCan't to load a template with empty name!\n</pre>");
1541 if (!GetHash(StaticLocal, templatename, len, &vTmpl) &&
1542 !GetHash(Static, templatename, len, &vTmpl)) {
1543 lprintf (1, "didn't find Template [%s] %ld %ld\n", templatename, len , (long)strlen(templatename));
1544 StrBufAppendPrintf(Target, "<pre>\ndidn't find Template [%s] %ld %ld\n</pre>",
1546 (long)strlen(templatename));
1548 dbg_PrintHash(Static, PrintTemplate, NULL);
1549 PrintHash(Static, VarPrintTransition, PrintTemplate);
1555 ProcessTemplate(vTmpl, Target, TP->Context, TP->Filter.ContextType);
1558 /*-----------------------------------------------------------------------------
1561 typedef struct _HashIterator {
1562 HashList *StaticList;
1563 int AdditionalParams;
1565 int XPectContextType;
1567 RetrieveHashlistFunc GetHash;
1568 HashDestructorFunc Destructor;
1569 SubTemplFunc DoSubTemplate;
1572 void RegisterITERATOR(const char *Name, long len,
1573 int AdditionalParams,
1574 HashList *StaticList,
1575 RetrieveHashlistFunc GetHash,
1576 SubTemplFunc DoSubTempl,
1577 HashDestructorFunc Destructor,
1579 int XPectContextType,
1582 HashIterator *It = (HashIterator*)malloc(sizeof(HashIterator));
1583 It->StaticList = StaticList;
1584 It->AdditionalParams = AdditionalParams;
1585 It->GetHash = GetHash;
1586 It->DoSubTemplate = DoSubTempl;
1587 It->Destructor = Destructor;
1588 It->ContextType = ContextType;
1589 It->XPectContextType = XPectContextType;
1591 Put(Iterators, Name, len, It, NULL);
1594 typedef struct _iteratestruct {
1603 void tmpl_iterate_subtmpl(StrBuf *Target, WCTemplputParams *TP)
1609 SortStruct *SortBy = NULL;
1611 int DetectGroupChange = 0;
1614 void *vLastContext = NULL;
1616 WCTemplputParams SubTP;
1617 IterateStruct Status;
1619 memset(&Status, 0, sizeof(IterateStruct));
1620 memcpy (&SubTP, &TP, sizeof(WCTemplputParams));
1622 if (!GetHash(Iterators, TKEY(0), &vIt)) {
1624 Target, "Iterator", ERR_PARM1, TP, "Unknown!");
1628 It = (HashIterator*) vIt;
1630 if (TP->Tokens->nParameters < It->AdditionalParams + 2) {
1632 Target, "Iterator", ERR_PARM1, TP,
1633 "doesn't work with %ld params",
1634 TP->Tokens->nParameters);
1638 if ((It->XPectContextType != CTX_NONE) &&
1639 (It->XPectContextType != TP->Filter.ContextType)) {
1641 Target, "Iterator", ERR_PARM1, TP,
1642 "requires context of type %ld, have %ld",
1643 It->XPectContextType,
1644 TP->Filter.ContextType);
1649 if (It->StaticList == NULL)
1650 List = It->GetHash(Target, TP);
1652 List = It->StaticList;
1654 DetectGroupChange = (It->Flags & IT_FLAG_DETECT_GROUPCHANGE) != 0;
1655 if (DetectGroupChange) {
1656 const StrBuf *BSort;
1657 DetectGroupChange = 0;
1658 if (havebstr("SortBy")) {
1659 BSort = sbstr("SortBy");
1660 if (GetHash(SortHash, SKEY(BSort), &vSortBy) &&
1661 (vSortBy != NULL)) {
1662 SortBy = (SortStruct*)vSortBy;
1663 /** Ok, its us, lets see in which direction we should sort... */
1664 if (havebstr("SortOrder")) {
1666 SortOrder = LBSTR("SortOrder");
1668 DetectGroupChange = 1;
1673 nMembersUsed = GetCount(List);
1674 SubBuf = NewStrBuf();
1675 SubTP.Filter.ContextType = It->ContextType;
1676 SubTP.Filter.ControlContextType = CTX_ITERATE;
1677 SubTP.ControlContext = &Status;
1678 it = GetNewHashPos(List, 0);
1679 while (GetNextHashPos(List, it, &Status.KeyLen, &Status.Key, &vContext)) {
1680 if (DetectGroupChange && Status.n > 0) {
1681 Status.GroupChange = (SortBy->GroupChange(vContext, vLastContext))? 1:0;
1683 Status.LastN = ++Status.LastN == nMembersUsed;
1684 SubTP.Context = vContext;
1685 if (It->DoSubTemplate != NULL)
1686 It->DoSubTemplate(SubBuf, &SubTP);
1687 DoTemplate(TKEY(1), SubBuf, &SubTP);
1689 StrBufAppendBuf(Target, SubBuf, 0);
1690 FlushStrBuf(SubBuf);
1691 Status.oddeven = ! Status.oddeven;
1692 vLastContext = vContext;
1694 FreeStrBuf(&SubBuf);
1696 if (It->Destructor != NULL)
1697 It->Destructor(&List);
1701 int conditional_ITERATE_ISGROUPCHANGE(StrBuf *Target, WCTemplputParams *TP)
1703 IterateStruct *Ctx = CCTX;
1704 return Ctx->GroupChange;
1707 void tmplput_ITERATE_ODDEVEN(StrBuf *Target, WCTemplputParams *TP)
1709 IterateStruct *Ctx = CCTX;
1711 StrBufAppendBufPlain(Target, HKEY("odd"), 0);
1713 StrBufAppendBufPlain(Target, HKEY("even"), 0);
1717 void tmplput_ITERATE_KEY(StrBuf *Target, WCTemplputParams *TP)
1719 IterateStruct *Ctx = CCTX;
1721 StrBufAppendBufPlain(Target, Ctx->Key, Ctx->KeyLen, 0);
1725 void tmplput_ITERATE_LASTN(StrBuf *Target, WCTemplputParams *TP)
1727 IterateStruct *Ctx = CCTX;
1728 StrBufAppendPrintf(Target, "%d", Ctx->n);
1731 int conditional_ITERATE_LASTN(StrBuf *Target, WCTemplputParams *TP)
1733 IterateStruct *Ctx = CCTX;
1739 /*-----------------------------------------------------------------------------
1742 int EvaluateConditional(StrBuf *Target, int Neg, int state, WCTemplputParams *TP)
1744 ConditionalStruct *Cond;
1746 if ((TP->Tokens->Params[0]->len == 1) &&
1747 (TP->Tokens->Params[0]->Start[0] == 'X'))
1748 return (state != 0)?TP->Tokens->Params[1]->lvalue:0;
1750 Cond = (ConditionalStruct *) TP->Tokens->PreEval;
1753 Target, "Conditional", ERR_PARM1, TP,
1758 if (TP->Tokens->nParameters < Cond->nParams) {
1760 Target, "Conditional", ERR_PARM1, TP,
1761 "needs %ld Params, have %ld!",
1763 TP->Tokens->nParameters);
1766 if (Cond->CondF(Target, TP) == Neg)
1767 return TP->Tokens->Params[1]->lvalue;
1771 int ConditionalVar(StrBuf *Target, WCTemplputParams *TP)
1776 if (!GetHash(WC->vars, TKEY(2), &vsubst))
1778 subst = (wcsubst*) vsubst;
1780 if (!CheckContext(Target, &subst->Filter, TP, "Conditional")) {
1784 switch(subst->wcs_type) {
1786 return (subst->wcs_function!=NULL);
1788 lprintf(1, " -> Server [%s]\n", subst->wcs_value);/* TODO */
1792 case WCS_STRBUF_REF:
1793 if (TP->Tokens->nParameters < 4)
1795 return (strcmp(TP->Tokens->Params[3]->Start, ChrPtr(subst->wcs_value)) == 0);
1797 if (TP->Tokens->nParameters < 4)
1798 return (subst->lvalue != 0);
1799 return (subst->lvalue == TP->Tokens->Params[3]->lvalue);
1801 lprintf(1," WARNING: invalid type: [%ld]!\n", subst->wcs_type);
1807 void RegisterConditional(const char *Name, long len,
1809 WCConditionalFunc CondF,
1810 int ContextRequired)
1812 ConditionalStruct *Cond = (ConditionalStruct*)malloc(sizeof(ConditionalStruct));
1813 Cond->PlainName = Name;
1814 Cond->nParams = nParams;
1815 Cond->CondF = CondF;
1816 Cond->Filter.ContextType = ContextRequired;
1817 Cond->Filter.ControlContextType = CTX_NONE;
1818 Put(Conditionals, Name, len, Cond, NULL);
1821 void RegisterControlConditional(const char *Name, long len,
1823 WCConditionalFunc CondF,
1824 int ControlContextRequired)
1826 ConditionalStruct *Cond = (ConditionalStruct*)malloc(sizeof(ConditionalStruct));
1827 Cond->PlainName = Name;
1828 Cond->nParams = nParams;
1829 Cond->CondF = CondF;
1830 Cond->Filter.ContextType = CTX_NONE;
1831 Cond->Filter.ControlContextType = ControlContextRequired;
1832 Put(Conditionals, Name, len, Cond, NULL);
1835 /*-----------------------------------------------------------------------------
1838 void tmplput_ContextString(StrBuf *Target, WCTemplputParams *TP)
1840 StrBufAppendTemplate(Target, TP, (StrBuf*)CTX, 0);
1842 int ConditionalContextStr(StrBuf *Target, WCTemplputParams *TP)
1844 StrBuf *TokenText = (StrBuf*) CTX;
1845 const char *CompareToken;
1848 GetTemplateTokenString(TP, 2, &CompareToken, &len);
1849 return strcmp(ChrPtr(TokenText), CompareToken) == 0;
1852 /*-----------------------------------------------------------------------------
1856 void tmpl_do_boxed(StrBuf *Target, WCTemplputParams *TP)
1858 WCTemplputParams SubTP;
1861 if (TP->Tokens->nParameters == 2) {
1862 if (TP->Tokens->Params[1]->Type == TYPE_STR) {
1863 Headline = NewStrBuf();
1864 DoTemplate(TKEY(1), Headline, TP);
1869 GetTemplateTokenString(TP,
1873 Headline = NewStrBufPlain(Ch, len);
1876 memcpy (&SubTP, TP, sizeof(WCTemplputParams));
1877 SubTP.Context = Headline;
1878 SubTP.Filter.ContextType = CTX_STRBUF;
1879 DoTemplate(HKEY("beginbox"), Target, &SubTP);
1880 DoTemplate(TKEY(0), Target, TP);
1881 DoTemplate(HKEY("endbox"), Target, TP);
1882 FreeStrBuf(&Headline);
1885 /*-----------------------------------------------------------------------------
1889 void tmpl_do_tabbed(StrBuf *Target, WCTemplputParams *TP)
1892 int i, ntabs, nTabs;
1894 nTabs = ntabs = TP->Tokens->nParameters / 2;
1895 TabNames = (StrBuf **) malloc(ntabs * sizeof(StrBuf*));
1897 for (i = 0; i < ntabs; i++) {
1898 if ((TP->Tokens->Params[i * 2]->Type == TYPE_STR) &&
1899 (TP->Tokens->Params[i * 2]->len > 0)) {
1900 TabNames[i] = NewStrBuf();
1901 DoTemplate(TKEY(i * 2), TabNames[i], TP);
1903 else if (TP->Tokens->Params[i * 2]->Type == TYPE_GETTEXT) {
1906 GetTemplateTokenString(TP,
1910 TabNames[i] = NewStrBufPlain(Ch, -1);
1913 /** A Tab without subject? we can't count that, add it as silent */
1918 StrTabbedDialog(Target, nTabs, TabNames);
1919 for (i = 0; i < ntabs; i++) {
1920 StrBeginTab(Target, i, nTabs);
1921 DoTemplate(TKEY(i * 2 + 1), Target, TP);
1922 StrEndTab(Target, i, nTabs);
1927 /*-----------------------------------------------------------------------------
1932 void RegisterSortFunc(const char *name, long len,
1933 const char *prepend, long preplen,
1934 CompareFunc Forward,
1935 CompareFunc Reverse,
1936 CompareFunc GroupChange,
1939 SortStruct *NewSort = (SortStruct*) malloc(sizeof(SortStruct));
1940 NewSort->Name = NewStrBufPlain(name, len);
1941 if (prepend != NULL)
1942 NewSort->PrefPrepend = NewStrBufPlain(prepend, preplen);
1944 NewSort->PrefPrepend = NULL;
1945 NewSort->Forward = Forward;
1946 NewSort->Reverse = Reverse;
1947 NewSort->GroupChange = GroupChange;
1948 NewSort->ContextType = ContextType;
1949 Put(SortHash, name, len, NewSort, DestroySortStruct);
1952 CompareFunc RetrieveSort(WCTemplputParams *TP,
1953 const char *OtherPrefix, long OtherPrefixLen,
1954 const char *Default, long ldefault, long DefaultDirection)
1957 const StrBuf *BSort = NULL;
1960 long SortOrder = -1;
1962 if (havebstr("SortBy")) {
1963 BSort = sbstr("SortBy");
1964 if (OtherPrefix == NULL) {
1965 set_room_pref("sort", NewStrBufDup(BSort), 0);
1968 set_X_PREFS(HKEY("sort"), OtherPrefix, OtherPrefixLen, NewStrBufDup(BSort), 0);
1971 else { /** Try to fallback to our remembered values... */
1972 if (OtherPrefix == NULL) {
1973 BSort = get_room_pref("sort");
1976 BSort = get_X_PREFS(HKEY("sort"), OtherPrefix, OtherPrefixLen);
1979 putbstr("SortBy", NewStrBufDup(BSort));
1983 BSort = Buf = NewStrBufPlain(Default, ldefault);
1984 putbstr("SortBy", Buf);
1988 if (!GetHash(SortHash, SKEY(BSort), &vSortBy) ||
1989 (vSortBy == NULL)) {
1991 if (!GetHash(SortHash, Default, ldefault, &vSortBy) ||
1992 (vSortBy == NULL)) {
1994 NULL, "Sorting", ERR_PARM1, TP,
1995 "Illegal default sort: [%s]", Default);
1999 SortBy = (SortStruct*)vSortBy;
2001 /** Ok, its us, lets see in which direction we should sort... */
2002 if (havebstr("SortOrder")) {
2003 SortOrder = LBSTR("SortOrder");
2005 else { /** Try to fallback to our remembered values... */
2007 if (SortBy->PrefPrepend == NULL) {
2008 Buf = get_room_pref("SortOrder");
2009 SortOrder = StrTol(Buf);
2012 BSort = get_X_PREFS(HKEY("SortOrder"), OtherPrefix, OtherPrefixLen);
2016 SortOrder = DefaultDirection;
2018 Buf = NewStrBufPlain(NULL, 64);
2019 StrBufPrintf(Buf, "%ld", SortOrder);
2020 putbstr("SortOrder", Buf);
2022 switch (SortOrder) {
2027 return SortBy->Forward;
2029 return SortBy->Reverse;
2041 ConstStr SortIcons[] = {
2042 {HKEY("static/sort_none.gif")},
2043 {HKEY("static/up_pointer.gif")},
2044 {HKEY("static/down_pointer.gif")},
2047 ConstStr SortNextOrder[] = {
2054 int GetSortMetric(WCTemplputParams *TP, SortStruct **Next, SortStruct **Param, long *SortOrder, int N)
2056 int bSortError = eNOT_SPECIFIED;
2057 const StrBuf *BSort;
2062 if (!GetHash(SortHash, TKEY(0), &vSort) ||
2064 return eNO_SUCH_SORT;
2065 *Param = (SortStruct*) vSort;
2068 if (havebstr("SortBy")) {
2069 BSort = sbstr("SortBy");
2070 bSortError = eINVALID_PARAM;
2071 if ((*Param)->PrefPrepend == NULL) {
2072 set_room_pref("sort", NewStrBufDup(BSort), 0);
2075 set_X_PREFS(HKEY("sort"), TKEY(N), NewStrBufDup(BSort), 0);
2078 else { /** Try to fallback to our remembered values... */
2079 if ((*Param)->PrefPrepend == NULL) {
2080 BSort = get_room_pref("sort");
2083 BSort = get_X_PREFS(HKEY("sort"), TKEY(N));
2087 if (!GetHash(SortHash, SKEY(BSort), &vSort) ||
2091 *Next = (SortStruct*) vSort;
2093 /** Ok, its us, lets see in which direction we should sort... */
2094 if (havebstr("SortOrder")) {
2095 *SortOrder = LBSTR("SortOrder");
2097 else { /** Try to fallback to our remembered values... */
2098 if ((*Param)->PrefPrepend == NULL) {
2099 *SortOrder = StrTol(get_room_pref("SortOrder"));
2102 *SortOrder = StrTol(get_X_PREFS(HKEY("SortOrder"), TKEY(N)));
2112 void tmplput_SORT_ICON(StrBuf *Target, WCTemplputParams *TP)
2117 const ConstStr *SortIcon;
2119 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2122 Target, "Sorter", ERR_PARM1, TP,
2123 " Sorter [%s] unknown!",
2124 TP->Tokens->Params[0]->Start);
2126 case eINVALID_PARAM:
2127 LogTemplateError(NULL, "Sorter", ERR_PARM1, TP,
2128 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2130 case eNOT_SPECIFIED:
2132 if (Next == Param) {
2133 SortIcon = &SortIcons[SortOrder];
2135 else { /** Not Us... */
2136 SortIcon = &SortIcons[0];
2138 StrBufAppendBufPlain(Target, SortIcon->Key, SortIcon->len, 0);
2142 void tmplput_SORT_NEXT(StrBuf *Target, WCTemplputParams *TP)
2148 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2151 Target, "Sorter", ERR_PARM1, TP,
2152 " Sorter [%s] unknown!",
2153 TP->Tokens->Params[0]->Start);
2155 case eINVALID_PARAM:
2157 NULL, "Sorter", ERR_PARM1, TP,
2158 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2160 case eNOT_SPECIFIED:
2162 StrBufAppendBuf(Target, Param->Name, 0);
2167 void tmplput_SORT_ORDER(StrBuf *Target, WCTemplputParams *TP)
2170 const ConstStr *SortOrderStr;
2174 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2177 Target, "Sorter", ERR_PARM1, TP,
2178 " Sorter [%s] unknown!",
2179 TP->Tokens->Params[0]->Start);
2181 case eINVALID_PARAM:
2183 NULL, "Sorter", ERR_PARM1, TP,
2184 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2186 case eNOT_SPECIFIED:
2188 if (Next == Param) {
2189 SortOrderStr = &SortNextOrder[SortOrder];
2191 else { /** Not Us... */
2192 SortOrderStr = &SortNextOrder[0];
2194 StrBufAppendBufPlain(Target, SortOrderStr->Key, SortOrderStr->len, 0);
2199 void tmplput_long_vector(StrBuf *Target, WCTemplputParams *TP)
2201 long *LongVector = (long*) CTX;
2203 if ((TP->Tokens->Params[0]->Type == TYPE_LONG) &&
2204 (TP->Tokens->Params[0]->lvalue <= LongVector[0]))
2206 StrBufAppendPrintf(Target, "%ld", LongVector[TP->Tokens->Params[0]->lvalue]);
2210 if (TP->Tokens->Params[0]->Type != TYPE_LONG) {
2212 Target, "Longvector", ERR_NAME, TP,
2213 "needs a numerical Parameter!");
2217 Target, "LongVector", ERR_PARM1, TP,
2218 "doesn't have %ld Parameters, its just the size of %ld!",
2219 TP->Tokens->Params[0]->lvalue,
2225 void dbg_print_longvector(long *LongVector)
2227 StrBuf *Buf = NewStrBufPlain(HKEY("Longvector: ["));
2228 int nItems = LongVector[0];
2231 for (i = 0; i < nItems; i++) {
2233 StrBufAppendPrintf(Buf, "%d: %ld | ", i, LongVector[i]);
2235 StrBufAppendPrintf(Buf, "%d: %ld]\n", i, LongVector[i]);
2238 lprintf(1, ChrPtr(Buf));
2242 int ConditionalLongVector(StrBuf *Target, WCTemplputParams *TP)
2244 long *LongVector = (long*) CTX;
2246 if ((TP->Tokens->Params[2]->Type == TYPE_LONG) &&
2247 (TP->Tokens->Params[2]->lvalue <= LongVector[0])&&
2248 (TP->Tokens->Params[3]->Type == TYPE_LONG) &&
2249 (TP->Tokens->Params[3]->lvalue <= LongVector[0]))
2251 return LongVector[TP->Tokens->Params[2]->lvalue] ==
2252 LongVector[TP->Tokens->Params[3]->lvalue];
2256 if ((TP->Tokens->Params[2]->Type == TYPE_LONG) ||
2257 (TP->Tokens->Params[2]->Type == TYPE_LONG)) {
2259 Target, "ConditionalLongvector", ERR_PARM1, TP,
2260 "needs two long Parameter!");
2264 Target, "Longvector", ERR_PARM1, TP,
2265 "doesn't have %ld / %ld Parameters, its just the size of %ld!",
2266 TP->Tokens->Params[2]->lvalue,
2267 TP->Tokens->Params[3]->lvalue,
2278 memset(&NoCtx, 0, sizeof(WCTemplputParams));
2279 RegisterNamespace("SORT:ICON", 1, 2, tmplput_SORT_ICON, CTX_NONE);
2280 RegisterNamespace("SORT:ORDER", 1, 2, tmplput_SORT_ORDER, CTX_NONE);
2281 RegisterNamespace("SORT:NEXT", 1, 2, tmplput_SORT_NEXT, CTX_NONE);
2282 RegisterNamespace("CONTEXTSTR", 0, 1, tmplput_ContextString, CTX_STRBUF);
2283 RegisterNamespace("ITERATE", 2, 100, tmpl_iterate_subtmpl, CTX_NONE);
2284 RegisterNamespace("DOBOXED", 1, 2, tmpl_do_boxed, CTX_NONE);
2285 RegisterNamespace("DOTABBED", 2, 100, tmpl_do_tabbed, CTX_NONE);
2286 RegisterNamespace("LONGVECTOR", 1, 1, tmplput_long_vector, CTX_LONGVECTOR);
2287 RegisterConditional(HKEY("COND:SUBST"), 3, ConditionalVar, CTX_NONE);
2288 RegisterConditional(HKEY("COND:CONTEXTSTR"), 3, ConditionalContextStr, CTX_STRBUF);
2289 RegisterConditional(HKEY("COND:LONGVECTOR"), 4, ConditionalLongVector, CTX_LONGVECTOR);
2291 RegisterControlConditional(HKEY("COND:ITERATE:ISGROUPCHANGE"), 2,
2292 conditional_ITERATE_ISGROUPCHANGE,
2294 RegisterControlConditional(HKEY("COND:ITERATE:LASTN"), 2,
2295 conditional_ITERATE_LASTN,
2297 RegisterControlNS(HKEY("ITERATE:ODDEVEN"), 0, 0, tmplput_ITERATE_ODDEVEN, CTX_ITERATE);
2298 RegisterControlNS(HKEY("ITERATE:KEY"), 0, 0, tmplput_ITERATE_KEY, CTX_ITERATE);
2299 RegisterControlNS(HKEY("ITERATE:N"), 0, 0, tmplput_ITERATE_LASTN, CTX_ITERATE);