5 * \defgroup Subst Variable substitution type stuff
6 * \ingroup CitadelConfig
12 #include <sys/types.h>
18 #define SHOW_ME_VAPPEND_PRINTF
21 #include "webserver.h"
23 extern char *static_dirs[PATH_MAX]; /**< Disk representation */
25 HashList *WirelessTemplateCache;
26 HashList *WirelessLocalTemplateCache;
27 HashList *TemplateCache;
28 HashList *LocalTemplateCache;
32 HashList *Conditionals;
35 int LoadTemplates = 0;
36 WCTemplputParams NoCtx;
39 #define SV_CONDITIONAL 2
40 #define SV_NEG_CONDITIONAL 3
41 #define SV_CUST_STR_CONDITIONAL 4
43 #define SV_PREEVALUATED 6
45 typedef struct _WCTemplate {
50 WCTemplateToken **Tokens;
53 typedef struct _HashHandler {
56 WCHandlerFunc HandlerFunc;
59 void *load_template(StrBuf *filename, StrBuf *Key, HashList *PutThere);
60 int EvaluateConditional(StrBuf *Target, int Neg, int state, WCTemplputParams *TP);
64 typedef struct _SortStruct {
69 CompareFunc GroupChange;
74 const char *CtxNames[] = {
97 void DestroySortStruct(void *vSort)
99 SortStruct *Sort = (SortStruct*) vSort;
100 FreeStrBuf(&Sort->Name);
101 FreeStrBuf(&Sort->PrefPrepend);
105 const char *ContextName(int ContextType)
107 if (ContextType < CTX_UNKNOWN)
108 return CtxNames[ContextType];
110 return CtxNames[CTX_UNKNOWN];
113 void LogTemplateError (StrBuf *Target, const char *Type, int ErrorPos, WCTemplputParams *TP, const char *Format, ...)
118 const char *Err = NULL;
123 va_start(arg_ptr, Format);
124 StrBufVAppendPrintf(Error, Format, arg_ptr);
129 case ERR_NAME: /* the main token name... */
130 Err = (TP->Tokens!= NULL)? TP->Tokens->pName:"";
133 Err = (TP->Tokens!= NULL)? TP->Tokens->Params[0]->Start:"";
136 Err = (TP->Tokens!= NULL)? TP->Tokens->Params[1]->Start:"";
139 if (TP->Tokens != NULL)
141 lprintf(1, "%s [%s] (in '%s' line %ld); %s; [%s]\n",
144 ChrPtr(TP->Tokens->FileName),
147 ChrPtr(TP->Tokens->FlatToken));
151 lprintf(1, "%s: %s;\n",
157 if (TP->Tokens != NULL)
161 "<pre>\n%s [%s] (in '%s' line %ld); %s\n[%s]\n</pre>\n",
164 ChrPtr(TP->Tokens->FileName),
167 ChrPtr(TP->Tokens->FlatToken));
173 "<pre>\n%s: %s\n</pre>\n",
180 void RegisterNS(const char *NSName,
184 WCHandlerFunc HandlerFunc,
187 HashHandler *NewHandler;
189 NewHandler = (HashHandler*) malloc(sizeof(HashHandler));
190 NewHandler->Filter.nMinArgs = nMinArgs;
191 NewHandler->Filter.nMaxArgs = nMaxArgs;
192 NewHandler->Filter.ContextType = ContextRequired;
193 NewHandler->Filter.ControlContextType = CTX_NONE;
195 NewHandler->HandlerFunc = HandlerFunc;
196 Put(GlobalNS, NSName, len, NewHandler, NULL);
199 void RegisterControlNS(const char *NSName,
203 WCHandlerFunc HandlerFunc,
204 int ControlContextRequired)
206 HashHandler *NewHandler;
208 NewHandler = (HashHandler*) malloc(sizeof(HashHandler));
209 NewHandler->Filter.nMinArgs = nMinArgs;
210 NewHandler->Filter.nMaxArgs = nMaxArgs;
211 NewHandler->Filter.ContextType = CTX_NONE;
212 NewHandler->Filter.ControlContextType = ControlContextRequired;
213 NewHandler->HandlerFunc = HandlerFunc;
214 Put(GlobalNS, NSName, len, NewHandler, NULL);
219 int CheckContext(StrBuf *Target, ContextFilter *Need, WCTemplputParams *TP, const char *ErrType)
221 if ((Need->ContextType != CTX_NONE) &&
222 (Need->ContextType != TP->Filter.ContextType)) {
224 Target, ErrType, ERR_PARM1, TP,
225 " WARNING: requires Context: [%s], have [%s]!",
226 ContextName(Need->ContextType),
227 ContextName(TP->Filter.ContextType));
231 if ((Need->ControlContextType != CTX_NONE) &&
232 (Need->ControlContextType != TP->Filter.ControlContextType)) {
234 Target, ErrType, ERR_PARM1, TP,
235 " WARNING: requires Control Context: [%s], have [%s]!",
236 ContextName(Need->ControlContextType),
237 ContextName(TP->Filter.ControlContextType));
241 if (TP->Tokens->nParameters < Need->nMinArgs) {
242 LogTemplateError(Target, ErrType, ERR_NAME, TP,
243 "needs at least %ld params, have %ld",
245 TP->Tokens->nParameters);
249 else if (TP->Tokens->nParameters > Need->nMaxArgs) {
250 LogTemplateError(Target, ErrType, ERR_NAME, TP,
251 "just needs %ld params, you gave %ld",
253 TP->Tokens->nParameters);
261 void FreeToken(WCTemplateToken **Token)
264 FreeStrBuf(&(*Token)->FlatToken);
265 if ((*Token)->HaveParameters)
266 for (i = 0; i < (*Token)->nParameters; i++)
267 free((*Token)->Params[i]);
274 void FreeWCTemplate(void *vFreeMe)
277 WCTemplate *FreeMe = (WCTemplate*)vFreeMe;
279 if (FreeMe->TokenSpace > 0) {
280 for (i = 0; i < FreeMe->nTokensUsed; i ++) {
281 FreeToken(&FreeMe->Tokens[i]);
283 free(FreeMe->Tokens);
285 FreeStrBuf(&FreeMe->FileName);
286 FreeStrBuf(&FreeMe->Data);
292 * \brief debugging function to print array to log
294 void VarPrintTransition(void *vVar1, void *vVar2, int odd){}
296 * \brief debugging function to print array to log
298 void VarPrintEntry(const char *Key, void *vSubst, int odd)
301 lprintf(1,"Subst[%s] : ", Key);
302 ptr = (wcsubst*) vSubst;
304 switch(ptr->wcs_type) {
306 lprintf(1, " -> %s\n", ChrPtr(ptr->wcs_value));
309 lprintf(1, " -> Server [%s]\n", ChrPtr(ptr->wcs_value));
312 lprintf(1, " -> function at [%0xd]\n", ptr->wcs_function);
315 lprintf(1," WARNING: invalid type: [%ld]!\n", ptr->wcs_type);
322 * \brief Clear out the list of substitution variables local to this session
324 void clear_substs(wcsession *wc) {
326 if (wc->vars != NULL) {
327 DeleteHash(&wc->vars);
332 * \brief Clear out the list of substitution variables local to this session
334 void clear_local_substs(void) {
353 void FlushPayload(wcsubst *ptr, int reusestrbuf, int type)
355 int NeedNew = NeedNewBuf(type);
356 switch(ptr->wcs_type) {
360 if (reusestrbuf && NeedNew) {
361 FlushStrBuf(ptr->wcs_value);
365 FreeStrBuf(&ptr->wcs_value);
366 ptr->wcs_value = NULL;
370 ptr->wcs_function = NULL;
371 if (reusestrbuf && NeedNew)
372 ptr->wcs_value = NewStrBuf();
375 ptr->wcs_value = NULL;
376 if (reusestrbuf && NeedNew)
377 ptr->wcs_value = NewStrBuf();
381 if (reusestrbuf && NeedNew)
382 ptr->wcs_value = NewStrBuf();
385 if (reusestrbuf && NeedNew)
386 ptr->wcs_value = NewStrBuf();
393 * \brief destructor; kill one entry.
395 void deletevar(void *data)
397 wcsubst *ptr = (wcsubst*)data;
398 FlushPayload(ptr, 0, ptr->wcs_type);
403 wcsubst *NewSubstVar(const char *keyname, int keylen, int type)
408 ptr = (wcsubst *) malloc(sizeof(wcsubst));
409 memset(ptr, 0, sizeof(wcsubst));
411 ptr->wcs_type = type;
412 safestrncpy(ptr->wcs_key, keyname, sizeof ptr->wcs_key);
413 Put(WCC->vars, keyname, keylen, ptr, deletevar);
415 switch(ptr->wcs_type) {
418 ptr->wcs_value = NewStrBuf();
432 * \brief Add a substitution variable (local to this session) (strlen version...)
433 * \param keyname the replacementstring to substitute
434 * \param keytype the kind of the key
435 * \param format the format string ala printf
436 * \param ... the arguments to substitute in the formatstring
438 void SVPRINTF(char *keyname, int keytype, const char *format,...)
446 keylen = strlen(keyname);
448 * First look if we're doing a replacement of
451 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
452 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
453 ptr = (wcsubst*)vPtr;
454 FlushPayload(ptr, keytype, keytype);
455 ptr->wcs_type = keytype;
457 else /** Otherwise allocate a new one */
459 ptr = NewSubstVar(keyname, keylen, keytype);
462 /** Format the string */
463 va_start(arg_ptr, format);
464 StrBufVAppendPrintf(ptr->wcs_value, format, arg_ptr);
469 * \brief Add a substitution variable (local to this session)
470 * \param keyname the replacementstring to substitute
471 * \param keytype the kind of the key
472 * \param format the format string ala printf
473 * \param ... the arguments to substitute in the formatstring
475 void svprintf(char *keyname, size_t keylen, int keytype, const char *format,...)
483 * First look if we're doing a replacement of
486 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
487 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
488 ptr = (wcsubst*)vPtr;
489 FlushPayload(ptr, 1, keytype);
490 ptr->wcs_type = keytype;
492 else /** Otherwise allocate a new one */
494 ptr = NewSubstVar(keyname, keylen, keytype);
497 /** Format the string and save it */
498 va_start(arg_ptr, format);
499 StrBufVAppendPrintf(ptr->wcs_value, format, arg_ptr);
504 * \brief Add a substitution variable (local to this session)
505 * \param keyname the replacementstring to substitute
506 * \param keytype the kind of the key
507 * \param format the format string ala printf
508 * \param ... the arguments to substitute in the formatstring
510 void SVPut(char *keyname, size_t keylen, int keytype, char *Data)
518 * First look if we're doing a replacement of
521 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
522 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
523 ptr = (wcsubst*)vPtr;
524 FlushPayload(ptr, 1, keytype);
525 ptr->wcs_type = keytype;
527 else /** Otherwise allocate a new one */
529 ptr = NewSubstVar(keyname, keylen, keytype);
531 StrBufAppendBufPlain(ptr->wcs_value, Data, -1, 0);
535 * \brief Add a substitution variable (local to this session)
536 * \param keyname the replacementstring to substitute
537 * \param keytype the kind of the key
538 * \param format the format string ala printf
539 * \param ... the arguments to substitute in the formatstring
541 void SVPutLong(char *keyname, size_t keylen, long Data)
549 * First look if we're doing a replacement of
552 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
553 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
554 ptr = (wcsubst*)vPtr;
555 FlushPayload(ptr, 1, WCS_LONG);
556 ptr->wcs_type = WCS_LONG;
558 else /** Otherwise allocate a new one */
560 ptr = NewSubstVar(keyname, keylen, WCS_LONG);
566 * \brief Add a substitution variable (local to this session) that does a callback
567 * \param keyname the keystring to substitute
568 * \param fcn_ptr the function callback to give the substitution string
570 void SVCallback(char *keyname, size_t keylen, WCHandlerFunc fcn_ptr)
577 * First look if we're doing a replacement of
580 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
581 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
582 ptr = (wcsubst*)vPtr;
583 FlushPayload(ptr, 1, WCS_FUNCTION);
584 ptr->wcs_type = WCS_FUNCTION;
586 else /** Otherwise allocate a new one */
588 ptr = NewSubstVar(keyname, keylen, WCS_FUNCTION);
591 ptr->wcs_function = fcn_ptr;
593 inline void SVCALLBACK(char *keyname, WCHandlerFunc fcn_ptr)
595 SVCallback(keyname, strlen(keyname), fcn_ptr);
600 void SVPUTBuf(const char *keyname, int keylen, const StrBuf *Buf, int ref)
607 * First look if we're doing a replacement of
610 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
611 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
612 ptr = (wcsubst*)vPtr;
613 FlushPayload(ptr, 0, (ref)?WCS_STRBUF_REF:WCS_STRBUF);
614 ptr->wcs_type = (ref)?WCS_STRBUF_REF:WCS_STRBUF;
616 else /** Otherwise allocate a new one */
618 ptr = NewSubstVar(keyname, keylen, (ref)?WCS_STRBUF_REF:WCS_STRBUF);
620 ptr->wcs_value = (StrBuf*)Buf;
624 * \brief back end for print_value_of() ... does a server command
625 * \param servcmd server command to execute on the citadel server
627 void pvo_do_cmd(StrBuf *Target, StrBuf *servcmd) {
631 serv_puts(ChrPtr(servcmd));
632 len = serv_getln(buf, sizeof buf);
638 StrBufAppendPrintf(Target, "%s\n", &buf[4]);
641 _fmout(Target, "CENTER");
644 StrBufAppendPrintf(Target, "%s\n", &buf[4]);
650 void GetTemplateTokenString(WCTemplputParams *TP,
656 WCTemplputParams SubTP;
658 if (TP->Tokens->nParameters < N) {
659 lprintf(1, "invalid token. this shouldn't have come till here.\n");
666 switch (TP->Tokens->Params[N]->Type) {
669 *Value = TP->Tokens->Params[N]->Start;
670 *len = TP->Tokens->Params[N]->len;
673 Buf = (StrBuf*) SBstr(TKEY(N));
674 *Value = ChrPtr(Buf);
675 *len = StrLength(Buf);
678 get_PREFERENCE(TKEY(N), &Buf);
679 *Value = ChrPtr(Buf);
680 *len = StrLength(Buf);
684 break; /* todo: string to text? */
686 *Value = _(TP->Tokens->Params[N]->Start);
687 *len = strlen(*Value);
689 case TYPE_SUBTEMPLATE:
690 memset(&SubTP, 0, sizeof(WCTemplputParams *));
691 SubTP.Context = TP->Context;
692 SubTP.Filter.ContextType = TP->Filter.ContextType;
694 DoTemplate(TKEY(N), Buf, &SubTP);
695 *Value = ChrPtr(Buf);
696 *len = StrLength(Buf);
697 /* we can't free it here, so we put it into the subst so its discarded later on. */
698 SVPUTBuf(TKEY(N), Buf, 0);
710 * \brief Print the value of a variable
711 * \param keyname get a key to print
713 void print_value_of(StrBuf *Target, WCTemplputParams *TP)
720 /*if (WCC->vars != NULL) PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
721 /* TODO: depricated! */
722 if (TP->Tokens->pName[0] == '=') {
723 DoTemplate(TP->Tokens->pName+1, TP->Tokens->NameEnd - 1, NULL, &NoCtx);
725 /*/////TODO: if param[1] == "U" -> urlescape
727 /** Page-local variables */
728 if ((WCC->vars!= NULL) && GetHash(WCC->vars, TP->Tokens->pName, TP->Tokens->NameEnd, &vVar)) {
729 ptr = (wcsubst*) vVar;
730 switch(ptr->wcs_type) {
732 StrBufAppendBuf(Target, ptr->wcs_value, 0);
735 pvo_do_cmd(Target, ptr->wcs_value);
738 (*ptr->wcs_function) (Target, TP);
742 StrBufAppendBuf(Target, ptr->wcs_value, 0);
745 StrBufAppendPrintf(Target, "%ld", ptr->lvalue);
749 Target, "Subst", ERR_NAME, TP,
750 "WARNING: invalid value in SV-Hash at %s!", TP->Tokens->pName);
755 Target, "Token", ERR_NAME, TP,
756 "didn't find Handler");
761 int CompareSubstToToken(TemplateParam *ParamToCompare, TemplateParam *ParamToLookup)
767 if ((WCC->vars!= NULL) && GetHash(WCC->vars, ParamToLookup->Start,
768 ParamToLookup->len, &vVar)) {
769 ptr = (wcsubst*) vVar;
770 switch(ptr->wcs_type) {
774 if (ParamToCompare->Type == TYPE_STR)
775 return ((ParamToCompare->len == StrLength(ptr->wcs_value)) &&
776 (strcmp(ParamToCompare->Start, ChrPtr(ptr->wcs_value)) == 0));
778 return ParamToCompare->lvalue == StrTol(ptr->wcs_value);
786 if (ParamToCompare->Type == TYPE_STR)
789 return ParamToCompare->lvalue == ptr->lvalue;
792 lprintf(1,"WARNING: invalid value in SV-Hash at %s!\n",
793 ParamToLookup->Start);
799 int CompareSubstToStrBuf(StrBuf *Compare, TemplateParam *ParamToLookup)
805 if ((WCC->vars!= NULL) && GetHash(WCC->vars, ParamToLookup->Start,
806 ParamToLookup->len, &vVar)) {
807 ptr = (wcsubst*) vVar;
808 switch(ptr->wcs_type) {
812 return ((StrLength(Compare) == StrLength(ptr->wcs_value)) &&
813 (strcmp(ChrPtr(Compare), ChrPtr(ptr->wcs_value)) == 0));
820 return StrTol(Compare) == ptr->lvalue;
822 lprintf(1,"WARNING: invalid value in SV-Hash at %s!\n",
823 ParamToLookup->Start);
832 * \brief puts string into the template and computes which escape methon we should use
833 * \param Source the string we should put into the template
834 * \param FormatTypeIndex where should we look for escape types if?
836 void StrBufAppendTemplate(StrBuf *Target,
837 WCTemplputParams *TP,
838 const StrBuf *Source, int FormatTypeIndex)
844 if ((FormatTypeIndex < TP->Tokens->nParameters) &&
845 (TP->Tokens->Params[FormatTypeIndex]->Type == TYPE_STR) &&
846 (TP->Tokens->Params[FormatTypeIndex]->len == 1)) {
847 EscapeAs = *TP->Tokens->Params[FormatTypeIndex]->Start;
854 Buf = NewStrBufPlain(NULL, StrLength(Source));
855 StrBuf_RFC822_to_Utf8(Buf,
857 (WCC!=NULL)? WCC->DefaultCharset : NULL,
859 StrEscAppend(Target, Buf, NULL, 0, 0);
863 StrEscAppend(Target, Source, NULL, 0, 0);
866 StrECMAEscAppend(Target, Source, NULL);
869 StrBufAppendBuf(Target, Source, 0);
874 void PutNewToken(WCTemplate *Template, WCTemplateToken *NewToken)
876 if (Template->nTokensUsed + 1 >= Template->TokenSpace) {
877 if (Template->TokenSpace <= 0) {
878 Template->Tokens = (WCTemplateToken**)malloc(
879 sizeof(WCTemplateToken*) * 10);
880 Template->TokenSpace = 10;
883 WCTemplateToken **NewTokens;
884 NewTokens= (WCTemplateToken**)malloc(
885 sizeof(WCTemplateToken*) *
886 Template->TokenSpace * 2);
887 memcpy(NewTokens, Template->Tokens,
888 sizeof(WCTemplateToken*) * Template->nTokensUsed);
889 free(Template->Tokens);
890 Template->TokenSpace *= 2;
891 Template->Tokens = NewTokens;
894 Template->Tokens[(Template->nTokensUsed)++] = NewToken;
897 TemplateParam *GetNextParameter(StrBuf *Buf, const char **pCh, const char *pe, WCTemplateToken *Tokens, WCTemplate *pTmpl)
899 const char *pch = *pCh;
900 const char *pchs, *pche;
901 TemplateParam *Parm = (TemplateParam *) malloc(sizeof(TemplateParam));
905 Parm->Type = TYPE_STR;
907 /* Skip leading whitespaces */
908 while ((*pch == ' ' )||
911 (*pch == '\n')) pch ++;
914 Parm->Type = TYPE_PREFSTR;
921 else if (*pch == ';') {
922 Parm->Type = TYPE_PREFINT;
929 else if (*pch == '_') {
930 Parm->Type = TYPE_GETTEXT;
937 else if (*pch == 'B') {
938 Parm->Type = TYPE_BSTR;
945 else if (*pch == '=') {
946 Parm->Type = TYPE_SUBTEMPLATE;
957 else if (*pch == '\'')
964 ( (pch > pchs) && (*(pch - 1) == '\\'))
970 lprintf(1, "Error (in '%s' line %ld); "
971 "evaluating template param [%s] in Token [%s]\n",
972 ChrPtr(pTmpl->FileName),
974 ChrPtr(Tokens->FlatToken),
981 StrBufPeek(Buf, pch, -1, '\0');
982 if (LoadTemplates > 1) {
983 lprintf(1, "DBG: got param [%s] %ld %ld\n",
984 pchs, pche - pchs, strlen(pchs));
987 Parm->len = pche - pchs;
988 pch ++; /* move after trailing quote */
989 if (ParamBrace && (*pch == ')')) {
996 Parm->Type = TYPE_LONG;
998 while ((pch <= pe) &&
1004 if (pch - pchs > 1){
1005 StrBufPeek(Buf, pch, -1, '\0');
1006 Parm->lvalue = atol(pchs);
1013 lprintf(1, "Error (in '%s' line %ld); "
1014 "evaluating long template param [%s] in Token [%s]\n",
1015 ChrPtr(pTmpl->FileName),
1017 ChrPtr(Tokens->FlatToken),
1024 while ((*pch == ' ' )||
1028 (*pch == '\n')) pch ++;
1034 WCTemplateToken *NewTemplateSubstitute(StrBuf *Buf,
1036 const char *pTmplStart,
1037 const char *pTmplEnd,
1043 TemplateParam *Param;
1044 WCTemplateToken *NewToken = (WCTemplateToken*)malloc(sizeof(WCTemplateToken));
1045 WCTemplputParams TP;
1047 TP.Tokens = NewToken;
1048 NewToken->FileName = pTmpl->FileName; /* to print meaningfull log messages... */
1049 NewToken->Flags = 0;
1050 NewToken->Line = Line + 1;
1051 NewToken->pTokenStart = pTmplStart;
1052 NewToken->TokenStart = pTmplStart - pStart;
1053 NewToken->TokenEnd = (pTmplEnd - pStart) - NewToken->TokenStart;
1054 NewToken->pTokenEnd = pTmplEnd;
1055 NewToken->NameEnd = NewToken->TokenEnd - 2;
1056 NewToken->PreEval = NULL;
1057 NewToken->FlatToken = NewStrBufPlain(pTmplStart + 2, pTmplEnd - pTmplStart - 2);
1059 StrBufPeek(Buf, pTmplStart, + 1, '\0');
1060 StrBufPeek(Buf, pTmplEnd, -1, '\0');
1061 pch = NewToken->pName = pTmplStart + 2;
1063 NewToken->HaveParameters = 0;;
1064 NewToken->nParameters = 0;
1066 while (pch < pTmplEnd - 1) {
1068 StrBufPeek(Buf, pch, -1, '\0');
1069 NewToken->NameEnd = pch - NewToken->pName;
1071 if (*(pTmplEnd - 1) != ')') {
1073 NULL, "Parseerror", ERR_NAME, &TP,
1074 "Warning, Non welformed Token; missing right parenthesis");
1076 while (pch < pTmplEnd - 1) {
1077 Param = GetNextParameter(Buf, &pch, pTmplEnd - 1, NewToken, pTmpl);
1078 if (Param != NULL) {
1079 NewToken->HaveParameters = 1;
1080 if (NewToken->nParameters > MAXPARAM) {
1082 NULL, "Parseerror", ERR_NAME, &TP,
1083 "only [%d] Params allowed in Tokens",
1087 FreeToken(&NewToken);
1090 NewToken->Params[NewToken->nParameters++] = Param;
1094 if((NewToken->NameEnd == 1) &&
1095 (NewToken->HaveParameters == 1))
1098 if (*(NewToken->pName) == '_')
1099 NewToken->Flags = SV_GETTEXT;
1100 else if (*(NewToken->pName) == '=')
1101 NewToken->Flags = SV_SUBTEMPL;
1102 else if (*(NewToken->pName) == '%')
1103 NewToken->Flags = SV_CUST_STR_CONDITIONAL;
1104 else if (*(NewToken->pName) == '?')
1105 NewToken->Flags = SV_CONDITIONAL;
1106 else if (*(NewToken->pName) == '!')
1107 NewToken->Flags = SV_NEG_CONDITIONAL;
1113 switch (NewToken->Flags) {
1115 /* If we're able to find out more about the token, do it now while its fresh. */
1116 if (GetHash(GlobalNS, NewToken->pName, NewToken->NameEnd, &vVar)) {
1117 HashHandler *Handler;
1118 Handler = (HashHandler*) vVar;
1119 if ((NewToken->nParameters < Handler->Filter.nMinArgs) ||
1120 (NewToken->nParameters > Handler->Filter.nMaxArgs)) {
1122 NULL, "Token", ERR_NAME, &TP,
1123 "doesn't work with %d params",
1124 NewToken->nParameters);
1128 NewToken->PreEval = Handler;
1129 NewToken->Flags = SV_PREEVALUATED;
1134 if (NewToken->nParameters !=1) {
1136 NULL, "Gettext", ERR_NAME, &TP,
1137 "requires exactly 1 parameter, you gave %d params",
1138 NewToken->nParameters);
1139 NewToken->Flags = 0;
1144 if (NewToken->nParameters != 1) {
1146 NULL, "Subtemplates", ERR_NAME, &TP,
1147 "require exactly 1 parameter, you gave %d params",
1148 NewToken->nParameters);
1152 case SV_CUST_STR_CONDITIONAL:
1153 case SV_CONDITIONAL:
1154 case SV_NEG_CONDITIONAL:
1155 if (NewToken->nParameters <2) {
1157 NULL, "Conditional", ERR_NAME, &TP,
1158 "require at least 2 parameters, you gave %d params",
1159 NewToken->nParameters);
1160 NewToken->Flags = 0;
1163 if (NewToken->Params[1]->lvalue == 0) {
1165 NULL, "Conditional", ERR_NAME, &TP,
1166 "Conditional ID (Parameter 1) mustn't be 0!");
1167 NewToken->Flags = 0;
1170 if (!GetHash(Conditionals,
1171 NewToken->Params[0]->Start,
1172 NewToken->Params[0]->len,
1175 if ((NewToken->Params[0]->len == 1) &&
1176 (NewToken->Params[0]->Start[0] == 'X'))
1179 NULL, "Conditional", ERR_NAME, &TP,
1182 NewToken->Error = NewStrBuf();
1185 "<pre>\nConditional [%s] (in '%s' line %ld); Not found!\n[%s]\n</pre>\n",
1186 NewToken->Params[0]->Start,
1187 ChrPtr(pTmpl->FileName),
1189 ChrPtr(NewToken->FlatToken));
1193 NewToken->PreEval = vVar;
1205 * \brief Display a variable-substituted template
1206 * \param templatename template file to load
1208 void *prepare_template(StrBuf *filename, StrBuf *Key, HashList *PutThere)
1210 WCTemplate *NewTemplate;
1211 NewTemplate = (WCTemplate *) malloc(sizeof(WCTemplate));
1212 NewTemplate->Data = NULL;
1213 NewTemplate->FileName = NewStrBufDup(filename);
1214 NewTemplate->nTokensUsed = 0;
1215 NewTemplate->TokenSpace = 0;
1216 NewTemplate->Tokens = NULL;
1218 Put(PutThere, ChrPtr(Key), StrLength(Key), NewTemplate, FreeWCTemplate);
1223 * \brief Display a variable-substituted template
1224 * \param templatename template file to load
1226 void *load_template(StrBuf *filename, StrBuf *Key, HashList *PutThere)
1229 struct stat statbuf;
1230 const char *pS, *pE, *pch, *Err;
1233 WCTemplate *NewTemplate;
1235 fd = open(ChrPtr(filename), O_RDONLY);
1237 lprintf(1, "ERROR: could not open template '%s' - %s\n",
1238 ChrPtr(filename), strerror(errno));
1242 if (fstat(fd, &statbuf) == -1) {
1243 lprintf(1, "ERROR: could not stat template '%s' - %s\n",
1244 ChrPtr(filename), strerror(errno));
1248 NewTemplate = (WCTemplate *) malloc(sizeof(WCTemplate));
1249 NewTemplate->Data = NewStrBufPlain(NULL, statbuf.st_size);
1250 NewTemplate->FileName = NewStrBufDup(filename);
1251 NewTemplate->nTokensUsed = 0;
1252 NewTemplate->TokenSpace = 0;
1253 NewTemplate->Tokens = NULL;
1254 if (StrBufReadBLOB(NewTemplate->Data, &fd, 1, statbuf.st_size, &Err) < 0) {
1256 FreeWCTemplate(NewTemplate);
1257 lprintf(1, "ERROR: reading template '%s' - %s<br />\n",
1258 ChrPtr(filename), strerror(errno));
1264 pS = pch = ChrPtr(NewTemplate->Data);
1265 pE = pS + StrLength(NewTemplate->Data);
1267 const char *pts, *pte;
1269 int InDoubleQuotes = 0;
1271 /** Find one <? > */
1273 for (; pch < pE; pch ++) {
1274 if ((*pch=='<')&&(*(pch + 1)=='?'))
1276 if (*pch=='\n') Line ++;
1282 /** Found one? parse it. */
1283 for (; pch <= pE - 1; pch ++) {
1285 InDoubleQuotes = ! InDoubleQuotes;
1286 else if (*pch == '\'')
1287 InQuotes = ! InQuotes;
1288 else if ((!InQuotes && !InDoubleQuotes) &&
1289 ((*pch!='\\')&&(*(pch + 1)=='>'))) {
1297 PutNewToken(NewTemplate,
1298 NewTemplateSubstitute(NewTemplate->Data, pS, pts, pte, Line, NewTemplate));
1301 if (LoadTemplates == 0)
1302 Put(PutThere, ChrPtr(Key), StrLength(Key), NewTemplate, FreeWCTemplate);
1307 const char* PrintTemplate(void *vSubst)
1309 WCTemplate *Tmpl = vSubst;
1311 return ChrPtr(Tmpl->FileName);
1315 int LoadTemplateDir(const char *DirName, HashList *wireless, HashList *big)
1320 DIR *filedir = NULL;
1321 struct dirent *filedir_entry;
1327 StrBufPrintf(Dir, "%s/t", DirName);
1328 filedir = opendir (ChrPtr(Dir));
1329 if (filedir == NULL) {
1334 FileName = NewStrBuf();
1336 while ((filedir_entry = readdir(filedir)))
1340 #ifdef _DIRENT_HAVE_D_NAMELEN
1341 d_namelen = filedir_entry->d_namelen;
1343 d_namelen = strlen(filedir_entry->d_name);
1345 d_without_ext = d_namelen;
1346 while ((d_without_ext > 0) && (filedir_entry->d_name[d_without_ext] != '.'))
1348 if ((d_without_ext == 0) || (d_namelen < 3))
1350 if ((d_namelen > 1) && filedir_entry->d_name[d_namelen - 1] == '~')
1351 continue; /* Ignore backup files... */
1353 IsMobile = (strstr(filedir_entry->d_name, ".m.html")!= NULL);
1354 PStart = filedir_entry->d_name;
1355 StrBufPrintf(FileName, "%s/%s", ChrPtr(Dir), filedir_entry->d_name);
1356 MinorPtr = strchr(filedir_entry->d_name, '.');
1357 if (MinorPtr != NULL)
1359 StrBufPlain(Tag, filedir_entry->d_name, MinorPtr - filedir_entry->d_name);
1361 if (LoadTemplates > 1)
1362 lprintf(1, "%s %d %s\n",ChrPtr(FileName), IsMobile, ChrPtr(Tag));
1363 if (LoadTemplates == 0)
1364 load_template(FileName, Tag, (IsMobile)?wireless:big);
1366 prepare_template(FileName, Tag, (IsMobile)?wireless:big);
1369 FreeStrBuf(&FileName);
1375 void InitTemplateCache(void)
1377 LoadTemplateDir(static_dirs[0],
1378 WirelessTemplateCache,
1380 LoadTemplateDir(static_dirs[1],
1381 WirelessLocalTemplateCache,
1382 LocalTemplateCache);
1387 /*-----------------------------------------------------------------------------
1388 * Filling & processing Templates
1391 * \brief executes one token
1392 * \param Target buffer to append to
1393 * \param Token da to process.
1394 * \param Template we're iterating
1395 * \param Context Contextpoointer to pass in
1396 * \param state are we in conditional state?
1397 * \param ContextType what type of information does context giv us?
1399 int EvaluateToken(StrBuf *Target, int state, WCTemplputParams *TP)
1401 const char *AppendMe;
1403 HashHandler *Handler;
1406 /* much output, since pName is not terminated...
1407 lprintf(1,"Doing token: %s\n",Token->pName);
1410 switch (TP->Tokens->Flags) {
1412 TmplGettext(Target, TP);
1414 case SV_CONDITIONAL: /** Forward conditional evaluation */
1415 return EvaluateConditional(Target, 1, state, TP);
1417 case SV_NEG_CONDITIONAL: /** Reverse conditional evaluation */
1418 return EvaluateConditional(Target, 0, state, TP);
1420 case SV_CUST_STR_CONDITIONAL: /** Conditional put custom strings from params */
1421 if (TP->Tokens->nParameters >= 6) {
1422 if (EvaluateConditional(Target, 0, state, TP)) {
1423 GetTemplateTokenString(TP, 5, &AppendMe, &AppendMeLen);
1424 StrBufAppendBufPlain(Target,
1430 GetTemplateTokenString(TP, 4, &AppendMe, &AppendMeLen);
1431 StrBufAppendBufPlain(Target,
1439 Target, "Conditional", ERR_NAME, TP,
1440 "needs at least 6 Params!");
1444 if (TP->Tokens->nParameters == 1)
1445 DoTemplate(TKEY(0), Target, TP);
1447 case SV_PREEVALUATED:
1448 Handler = (HashHandler*) TP->Tokens->PreEval;
1449 if (!CheckContext(Target, &Handler->Filter, TP, "Token")) {
1452 Handler->HandlerFunc(Target, TP);
1455 if (GetHash(GlobalNS, TP->Tokens->pName, TP->Tokens->NameEnd, &vVar)) {
1456 Handler = (HashHandler*) vVar;
1457 if (!CheckContext(Target, &Handler->Filter, TP, "Token")) {
1461 Handler->HandlerFunc(Target, TP);
1465 print_value_of(Target, TP);
1473 void ProcessTemplate(WCTemplate *Tmpl, StrBuf *Target, void *Context, int ContextType)
1475 WCTemplate *pTmpl = Tmpl;
1478 const char *pData, *pS;
1480 WCTemplputParams TP;
1482 TP.Context = Context;
1483 TP.Filter.ContextType = ContextType;
1485 if (LoadTemplates != 0) {
1486 if (LoadTemplates > 1)
1487 lprintf(1, "DBG: ----- loading: [%s] ------ \n",
1488 ChrPtr(Tmpl->FileName));
1490 pTmpl = load_template(Tmpl->FileName, NULL, NULL);
1494 "<pre>\nError loading Template [%s]\n See Logfile for details\n</pre>\n",
1495 ChrPtr(Tmpl->FileName));
1501 pS = pData = ChrPtr(pTmpl->Data);
1502 len = StrLength(pTmpl->Data);
1506 if (i >= pTmpl->nTokensUsed) {
1507 StrBufAppendBufPlain(Target,
1509 len - (pData - pS), 0);
1513 StrBufAppendBufPlain(
1515 pTmpl->Tokens[i]->pTokenStart - pData, 0);
1516 TP.Tokens = pTmpl->Tokens[i];
1517 TP.nArgs = pTmpl->Tokens[i]->nParameters;
1518 state = EvaluateToken(Target, state, &TP);
1520 while ((state != 0) && (i+1 < pTmpl->nTokensUsed)) {
1521 /* condition told us to skip till its end condition */
1523 TP.Tokens = pTmpl->Tokens[i];
1524 TP.nArgs = pTmpl->Tokens[i]->nParameters;
1525 if ((pTmpl->Tokens[i]->Flags == SV_CONDITIONAL) ||
1526 (pTmpl->Tokens[i]->Flags == SV_NEG_CONDITIONAL)) {
1527 if (state == EvaluateConditional(
1529 pTmpl->Tokens[i]->Flags,
1535 pData = pTmpl->Tokens[i++]->pTokenEnd + 1;
1536 if (i > pTmpl->nTokensUsed)
1540 if (LoadTemplates != 0) {
1541 FreeWCTemplate(pTmpl);
1546 * \brief Display a variable-substituted template
1547 * \param templatename template file to load
1549 void DoTemplate(const char *templatename, long len, StrBuf *Target, WCTemplputParams *TP)
1552 HashList *StaticLocal;
1557 if (WC->is_mobile) {
1558 Static = WirelessTemplateCache;
1559 StaticLocal = WirelessLocalTemplateCache;
1562 Static = TemplateCache;
1563 StaticLocal = LocalTemplateCache;
1568 lprintf (1, "Can't to load a template with empty name!\n");
1569 StrBufAppendPrintf(Target, "<pre>\nCan't to load a template with empty name!\n</pre>");
1573 if (!GetHash(StaticLocal, templatename, len, &vTmpl) &&
1574 !GetHash(Static, templatename, len, &vTmpl)) {
1575 lprintf (1, "didn't find Template [%s] %ld %ld\n", templatename, len , (long)strlen(templatename));
1576 StrBufAppendPrintf(Target, "<pre>\ndidn't find Template [%s] %ld %ld\n</pre>",
1578 (long)strlen(templatename));
1580 dbg_PrintHash(Static, PrintTemplate, NULL);
1581 PrintHash(Static, VarPrintTransition, PrintTemplate);
1587 ProcessTemplate(vTmpl, Target, TP->Context, TP->Filter.ContextType);
1590 /*-----------------------------------------------------------------------------
1593 typedef struct _HashIterator {
1594 HashList *StaticList;
1595 int AdditionalParams;
1597 int XPectContextType;
1599 RetrieveHashlistFunc GetHash;
1600 HashDestructorFunc Destructor;
1601 SubTemplFunc DoSubTemplate;
1604 void RegisterITERATOR(const char *Name, long len,
1605 int AdditionalParams,
1606 HashList *StaticList,
1607 RetrieveHashlistFunc GetHash,
1608 SubTemplFunc DoSubTempl,
1609 HashDestructorFunc Destructor,
1611 int XPectContextType,
1614 HashIterator *It = (HashIterator*)malloc(sizeof(HashIterator));
1615 It->StaticList = StaticList;
1616 It->AdditionalParams = AdditionalParams;
1617 It->GetHash = GetHash;
1618 It->DoSubTemplate = DoSubTempl;
1619 It->Destructor = Destructor;
1620 It->ContextType = ContextType;
1621 It->XPectContextType = XPectContextType;
1623 Put(Iterators, Name, len, It, NULL);
1626 typedef struct _iteratestruct {
1635 void tmpl_iterate_subtmpl(StrBuf *Target, WCTemplputParams *TP)
1641 SortStruct *SortBy = NULL;
1643 int DetectGroupChange = 0;
1646 void *vLastContext = NULL;
1648 WCTemplputParams SubTP;
1649 IterateStruct Status;
1651 memset(&Status, 0, sizeof(IterateStruct));
1652 memcpy (&SubTP, &TP, sizeof(WCTemplputParams));
1654 if (!GetHash(Iterators, TKEY(0), &vIt)) {
1656 Target, "Iterator", ERR_PARM1, TP, "Unknown!");
1660 It = (HashIterator*) vIt;
1662 if (TP->Tokens->nParameters < It->AdditionalParams + 2) {
1664 Target, "Iterator", ERR_PARM1, TP,
1665 "doesn't work with %d params",
1666 TP->Tokens->nParameters);
1670 if ((It->XPectContextType != CTX_NONE) &&
1671 (It->XPectContextType != TP->Filter.ContextType)) {
1673 Target, "Iterator", ERR_PARM1, TP,
1674 "requires context of type %d, have %d",
1675 It->XPectContextType,
1676 TP->Filter.ContextType);
1681 if (It->StaticList == NULL)
1682 List = It->GetHash(Target, TP);
1684 List = It->StaticList;
1686 DetectGroupChange = (It->Flags & IT_FLAG_DETECT_GROUPCHANGE) != 0;
1687 if (DetectGroupChange) {
1688 const StrBuf *BSort;
1689 DetectGroupChange = 0;
1690 if (havebstr("SortBy")) {
1691 BSort = sbstr("SortBy");
1692 if (GetHash(SortHash, SKEY(BSort), &vSortBy) &&
1693 (vSortBy != NULL)) {
1694 SortBy = (SortStruct*)vSortBy;
1695 /** Ok, its us, lets see in which direction we should sort... */
1696 if (havebstr("SortOrder")) {
1698 SortOrder = LBSTR("SortOrder");
1700 DetectGroupChange = 1;
1705 nMembersUsed = GetCount(List);
1706 SubBuf = NewStrBuf();
1707 SubTP.Filter.ContextType = It->ContextType;
1708 SubTP.Filter.ControlContextType = CTX_ITERATE;
1709 SubTP.ControlContext = &Status;
1710 it = GetNewHashPos(List, 0);
1711 while (GetNextHashPos(List, it, &Status.KeyLen, &Status.Key, &vContext)) {
1712 if (DetectGroupChange && Status.n > 0) {
1713 Status.GroupChange = (SortBy->GroupChange(vContext, vLastContext))? 1:0;
1715 Status.LastN = ++Status.LastN == nMembersUsed;
1716 SubTP.Context = vContext;
1717 if (It->DoSubTemplate != NULL)
1718 It->DoSubTemplate(SubBuf, &SubTP);
1719 DoTemplate(TKEY(1), SubBuf, &SubTP);
1721 StrBufAppendBuf(Target, SubBuf, 0);
1722 FlushStrBuf(SubBuf);
1723 Status.oddeven = ! Status.oddeven;
1724 vLastContext = vContext;
1726 FreeStrBuf(&SubBuf);
1728 if (It->Destructor != NULL)
1729 It->Destructor(&List);
1733 int conditional_ITERATE_ISGROUPCHANGE(StrBuf *Target, WCTemplputParams *TP)
1735 IterateStruct *Ctx = CCTX;
1736 return Ctx->GroupChange;
1739 void tmplput_ITERATE_ODDEVEN(StrBuf *Target, WCTemplputParams *TP)
1741 IterateStruct *Ctx = CCTX;
1743 StrBufAppendBufPlain(Target, HKEY("odd"), 0);
1745 StrBufAppendBufPlain(Target, HKEY("even"), 0);
1749 void tmplput_ITERATE_KEY(StrBuf *Target, WCTemplputParams *TP)
1751 IterateStruct *Ctx = CCTX;
1753 StrBufAppendBufPlain(Target, Ctx->Key, Ctx->KeyLen, 0);
1757 void tmplput_ITERATE_LASTN(StrBuf *Target, WCTemplputParams *TP)
1759 IterateStruct *Ctx = CCTX;
1760 StrBufAppendPrintf(Target, "%d", Ctx->n);
1763 int conditional_ITERATE_LASTN(StrBuf *Target, WCTemplputParams *TP)
1765 IterateStruct *Ctx = CCTX;
1771 /*-----------------------------------------------------------------------------
1774 int EvaluateConditional(StrBuf *Target, int Neg, int state, WCTemplputParams *TP)
1776 ConditionalStruct *Cond;
1778 if ((TP->Tokens->Params[0]->len == 1) &&
1779 (TP->Tokens->Params[0]->Start[0] == 'X'))
1780 return (state != 0)?TP->Tokens->Params[1]->lvalue:0;
1782 Cond = (ConditionalStruct *) TP->Tokens->PreEval;
1785 Target, "Conditional", ERR_PARM1, TP,
1790 if (!CheckContext(Target, &Cond->Filter, TP, "Conditional")) {
1794 if (Cond->CondF(Target, TP) == Neg)
1795 return TP->Tokens->Params[1]->lvalue;
1799 int ConditionalVar(StrBuf *Target, WCTemplputParams *TP)
1804 if (!GetHash(WC->vars, TKEY(2), &vsubst))
1806 subst = (wcsubst*) vsubst;
1808 switch(subst->wcs_type) {
1810 return (subst->wcs_function!=NULL);
1812 lprintf(1, " -> Server [%s]\n", subst->wcs_value);/* TODO */
1816 case WCS_STRBUF_REF:
1817 if (TP->Tokens->nParameters < 4)
1819 return (strcmp(TP->Tokens->Params[3]->Start, ChrPtr(subst->wcs_value)) == 0);
1821 if (TP->Tokens->nParameters < 4)
1822 return (subst->lvalue != 0);
1823 return (subst->lvalue == TP->Tokens->Params[3]->lvalue);
1825 lprintf(1," WARNING: invalid type: [%ld]!\n", subst->wcs_type);
1831 void RegisterConditional(const char *Name, long len,
1833 WCConditionalFunc CondF,
1834 int ContextRequired)
1836 ConditionalStruct *Cond = (ConditionalStruct*)malloc(sizeof(ConditionalStruct));
1837 Cond->PlainName = Name;
1838 Cond->Filter.nMaxArgs = nParams;
1839 Cond->Filter.nMinArgs = nParams;
1840 Cond->CondF = CondF;
1841 Cond->Filter.ContextType = ContextRequired;
1842 Cond->Filter.ControlContextType = CTX_NONE;
1843 Put(Conditionals, Name, len, Cond, NULL);
1846 void RegisterControlConditional(const char *Name, long len,
1848 WCConditionalFunc CondF,
1849 int ControlContextRequired)
1851 ConditionalStruct *Cond = (ConditionalStruct*)malloc(sizeof(ConditionalStruct));
1852 Cond->PlainName = Name;
1853 Cond->Filter.nMaxArgs = nParams;
1854 Cond->Filter.nMinArgs = nParams;
1855 Cond->CondF = CondF;
1856 Cond->Filter.ContextType = CTX_NONE;
1857 Cond->Filter.ControlContextType = ControlContextRequired;
1858 Put(Conditionals, Name, len, Cond, NULL);
1861 /*-----------------------------------------------------------------------------
1864 void tmplput_ContextString(StrBuf *Target, WCTemplputParams *TP)
1866 StrBufAppendTemplate(Target, TP, (StrBuf*)CTX, 0);
1868 int ConditionalContextStr(StrBuf *Target, WCTemplputParams *TP)
1870 StrBuf *TokenText = (StrBuf*) CTX;
1871 const char *CompareToken;
1874 GetTemplateTokenString(TP, 2, &CompareToken, &len);
1875 return strcmp(ChrPtr(TokenText), CompareToken) == 0;
1878 /*-----------------------------------------------------------------------------
1882 void tmpl_do_boxed(StrBuf *Target, WCTemplputParams *TP)
1884 WCTemplputParams SubTP;
1887 if (TP->Tokens->nParameters == 2) {
1888 if (TP->Tokens->Params[1]->Type == TYPE_STR) {
1889 Headline = NewStrBuf();
1890 DoTemplate(TKEY(1), Headline, TP);
1895 GetTemplateTokenString(TP,
1899 Headline = NewStrBufPlain(Ch, len);
1902 memcpy (&SubTP, TP, sizeof(WCTemplputParams));
1903 SubTP.Context = Headline;
1904 SubTP.Filter.ContextType = CTX_STRBUF;
1905 DoTemplate(HKEY("beginbox"), Target, &SubTP);
1906 DoTemplate(TKEY(0), Target, TP);
1907 DoTemplate(HKEY("endbox"), Target, TP);
1908 FreeStrBuf(&Headline);
1911 /*-----------------------------------------------------------------------------
1915 void tmpl_do_tabbed(StrBuf *Target, WCTemplputParams *TP)
1918 int i, ntabs, nTabs;
1920 nTabs = ntabs = TP->Tokens->nParameters / 2;
1921 TabNames = (StrBuf **) malloc(ntabs * sizeof(StrBuf*));
1923 for (i = 0; i < ntabs; i++) {
1924 if ((TP->Tokens->Params[i * 2]->Type == TYPE_STR) &&
1925 (TP->Tokens->Params[i * 2]->len > 0)) {
1926 TabNames[i] = NewStrBuf();
1927 DoTemplate(TKEY(i * 2), TabNames[i], TP);
1929 else if (TP->Tokens->Params[i * 2]->Type == TYPE_GETTEXT) {
1932 GetTemplateTokenString(TP,
1936 TabNames[i] = NewStrBufPlain(Ch, -1);
1939 /** A Tab without subject? we can't count that, add it as silent */
1944 StrTabbedDialog(Target, nTabs, TabNames);
1945 for (i = 0; i < ntabs; i++) {
1946 StrBeginTab(Target, i, nTabs);
1947 DoTemplate(TKEY(i * 2 + 1), Target, TP);
1948 StrEndTab(Target, i, nTabs);
1953 /*-----------------------------------------------------------------------------
1958 void RegisterSortFunc(const char *name, long len,
1959 const char *prepend, long preplen,
1960 CompareFunc Forward,
1961 CompareFunc Reverse,
1962 CompareFunc GroupChange,
1965 SortStruct *NewSort = (SortStruct*) malloc(sizeof(SortStruct));
1966 NewSort->Name = NewStrBufPlain(name, len);
1967 if (prepend != NULL)
1968 NewSort->PrefPrepend = NewStrBufPlain(prepend, preplen);
1970 NewSort->PrefPrepend = NULL;
1971 NewSort->Forward = Forward;
1972 NewSort->Reverse = Reverse;
1973 NewSort->GroupChange = GroupChange;
1974 NewSort->ContextType = ContextType;
1975 Put(SortHash, name, len, NewSort, DestroySortStruct);
1978 CompareFunc RetrieveSort(WCTemplputParams *TP,
1979 const char *OtherPrefix, long OtherPrefixLen,
1980 const char *Default, long ldefault, long DefaultDirection)
1983 const StrBuf *BSort = NULL;
1986 long SortOrder = -1;
1988 if (havebstr("SortBy")) {
1989 BSort = sbstr("SortBy");
1990 if (OtherPrefix == NULL) {
1991 set_room_pref("sort", NewStrBufDup(BSort), 0);
1994 set_X_PREFS(HKEY("sort"), OtherPrefix, OtherPrefixLen, NewStrBufDup(BSort), 0);
1997 else { /** Try to fallback to our remembered values... */
1998 if (OtherPrefix == NULL) {
1999 BSort = get_room_pref("sort");
2002 BSort = get_X_PREFS(HKEY("sort"), OtherPrefix, OtherPrefixLen);
2005 putbstr("SortBy", NewStrBufDup(BSort));
2009 BSort = Buf = NewStrBufPlain(Default, ldefault);
2010 putbstr("SortBy", Buf);
2014 if (!GetHash(SortHash, SKEY(BSort), &vSortBy) ||
2015 (vSortBy == NULL)) {
2017 if (!GetHash(SortHash, Default, ldefault, &vSortBy) ||
2018 (vSortBy == NULL)) {
2020 NULL, "Sorting", ERR_PARM1, TP,
2021 "Illegal default sort: [%s]", Default);
2025 SortBy = (SortStruct*)vSortBy;
2027 /** Ok, its us, lets see in which direction we should sort... */
2028 if (havebstr("SortOrder")) {
2029 SortOrder = LBSTR("SortOrder");
2031 else { /** Try to fallback to our remembered values... */
2033 if (SortBy->PrefPrepend == NULL) {
2034 Buf = get_room_pref("SortOrder");
2035 SortOrder = StrTol(Buf);
2038 BSort = get_X_PREFS(HKEY("SortOrder"), OtherPrefix, OtherPrefixLen);
2042 SortOrder = DefaultDirection;
2044 Buf = NewStrBufPlain(NULL, 64);
2045 StrBufPrintf(Buf, "%ld", SortOrder);
2046 putbstr("SortOrder", Buf);
2048 switch (SortOrder) {
2053 return SortBy->Forward;
2055 return SortBy->Reverse;
2067 ConstStr SortIcons[] = {
2068 {HKEY("static/sort_none.gif")},
2069 {HKEY("static/up_pointer.gif")},
2070 {HKEY("static/down_pointer.gif")},
2073 ConstStr SortNextOrder[] = {
2080 int GetSortMetric(WCTemplputParams *TP, SortStruct **Next, SortStruct **Param, long *SortOrder, int N)
2082 int bSortError = eNOT_SPECIFIED;
2083 const StrBuf *BSort;
2088 if (!GetHash(SortHash, TKEY(0), &vSort) ||
2090 return eNO_SUCH_SORT;
2091 *Param = (SortStruct*) vSort;
2094 if (havebstr("SortBy")) {
2095 BSort = sbstr("SortBy");
2096 bSortError = eINVALID_PARAM;
2097 if ((*Param)->PrefPrepend == NULL) {
2098 set_room_pref("sort", NewStrBufDup(BSort), 0);
2101 set_X_PREFS(HKEY("sort"), TKEY(N), NewStrBufDup(BSort), 0);
2104 else { /** Try to fallback to our remembered values... */
2105 if ((*Param)->PrefPrepend == NULL) {
2106 BSort = get_room_pref("sort");
2109 BSort = get_X_PREFS(HKEY("sort"), TKEY(N));
2113 if (!GetHash(SortHash, SKEY(BSort), &vSort) ||
2117 *Next = (SortStruct*) vSort;
2119 /** Ok, its us, lets see in which direction we should sort... */
2120 if (havebstr("SortOrder")) {
2121 *SortOrder = LBSTR("SortOrder");
2123 else { /** Try to fallback to our remembered values... */
2124 if ((*Param)->PrefPrepend == NULL) {
2125 *SortOrder = StrTol(get_room_pref("SortOrder"));
2128 *SortOrder = StrTol(get_X_PREFS(HKEY("SortOrder"), TKEY(N)));
2138 void tmplput_SORT_ICON(StrBuf *Target, WCTemplputParams *TP)
2143 const ConstStr *SortIcon;
2145 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2148 Target, "Sorter", ERR_PARM1, TP,
2149 " Sorter [%s] unknown!",
2150 TP->Tokens->Params[0]->Start);
2152 case eINVALID_PARAM:
2153 LogTemplateError(NULL, "Sorter", ERR_PARM1, TP,
2154 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2156 case eNOT_SPECIFIED:
2158 if (Next == Param) {
2159 SortIcon = &SortIcons[SortOrder];
2161 else { /** Not Us... */
2162 SortIcon = &SortIcons[0];
2164 StrBufAppendBufPlain(Target, SortIcon->Key, SortIcon->len, 0);
2168 void tmplput_SORT_NEXT(StrBuf *Target, WCTemplputParams *TP)
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 StrBufAppendBuf(Target, Param->Name, 0);
2193 void tmplput_SORT_ORDER(StrBuf *Target, WCTemplputParams *TP)
2196 const ConstStr *SortOrderStr;
2200 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2203 Target, "Sorter", ERR_PARM1, TP,
2204 " Sorter [%s] unknown!",
2205 TP->Tokens->Params[0]->Start);
2207 case eINVALID_PARAM:
2209 NULL, "Sorter", ERR_PARM1, TP,
2210 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2212 case eNOT_SPECIFIED:
2214 if (Next == Param) {
2215 SortOrderStr = &SortNextOrder[SortOrder];
2217 else { /** Not Us... */
2218 SortOrderStr = &SortNextOrder[0];
2220 StrBufAppendBufPlain(Target, SortOrderStr->Key, SortOrderStr->len, 0);
2225 void tmplput_long_vector(StrBuf *Target, WCTemplputParams *TP)
2227 long *LongVector = (long*) CTX;
2229 if ((TP->Tokens->Params[0]->Type == TYPE_LONG) &&
2230 (TP->Tokens->Params[0]->lvalue <= LongVector[0]))
2232 StrBufAppendPrintf(Target, "%ld", LongVector[TP->Tokens->Params[0]->lvalue]);
2236 if (TP->Tokens->Params[0]->Type != TYPE_LONG) {
2238 Target, "Longvector", ERR_NAME, TP,
2239 "needs a numerical Parameter!");
2243 Target, "LongVector", ERR_PARM1, TP,
2244 "doesn't have %ld Parameters, its just the size of %ld!",
2245 TP->Tokens->Params[0]->lvalue,
2251 void dbg_print_longvector(long *LongVector)
2253 StrBuf *Buf = NewStrBufPlain(HKEY("Longvector: ["));
2254 int nItems = LongVector[0];
2257 for (i = 0; i < nItems; i++) {
2259 StrBufAppendPrintf(Buf, "%d: %ld | ", i, LongVector[i]);
2261 StrBufAppendPrintf(Buf, "%d: %ld]\n", i, LongVector[i]);
2264 lprintf(1, ChrPtr(Buf));
2268 int ConditionalLongVector(StrBuf *Target, WCTemplputParams *TP)
2270 long *LongVector = (long*) CTX;
2272 if ((TP->Tokens->Params[2]->Type == TYPE_LONG) &&
2273 (TP->Tokens->Params[2]->lvalue <= LongVector[0])&&
2274 (TP->Tokens->Params[3]->Type == TYPE_LONG) &&
2275 (TP->Tokens->Params[3]->lvalue <= LongVector[0]))
2277 return LongVector[TP->Tokens->Params[2]->lvalue] ==
2278 LongVector[TP->Tokens->Params[3]->lvalue];
2282 if ((TP->Tokens->Params[2]->Type == TYPE_LONG) ||
2283 (TP->Tokens->Params[2]->Type == TYPE_LONG)) {
2285 Target, "ConditionalLongvector", ERR_PARM1, TP,
2286 "needs two long Parameter!");
2290 Target, "Longvector", ERR_PARM1, TP,
2291 "doesn't have %ld / %ld Parameters, its just the size of %ld!",
2292 TP->Tokens->Params[2]->lvalue,
2293 TP->Tokens->Params[3]->lvalue,
2304 memset(&NoCtx, 0, sizeof(WCTemplputParams));
2305 RegisterNamespace("SORT:ICON", 1, 2, tmplput_SORT_ICON, CTX_NONE);
2306 RegisterNamespace("SORT:ORDER", 1, 2, tmplput_SORT_ORDER, CTX_NONE);
2307 RegisterNamespace("SORT:NEXT", 1, 2, tmplput_SORT_NEXT, CTX_NONE);
2308 RegisterNamespace("CONTEXTSTR", 0, 1, tmplput_ContextString, CTX_STRBUF);
2309 RegisterNamespace("ITERATE", 2, 100, tmpl_iterate_subtmpl, CTX_NONE);
2310 RegisterNamespace("DOBOXED", 1, 2, tmpl_do_boxed, CTX_NONE);
2311 RegisterNamespace("DOTABBED", 2, 100, tmpl_do_tabbed, CTX_NONE);
2312 RegisterNamespace("LONGVECTOR", 1, 1, tmplput_long_vector, CTX_LONGVECTOR);
2313 RegisterConditional(HKEY("COND:SUBST"), 3, ConditionalVar, CTX_NONE);
2314 RegisterConditional(HKEY("COND:CONTEXTSTR"), 3, ConditionalContextStr, CTX_STRBUF);
2315 RegisterConditional(HKEY("COND:LONGVECTOR"), 4, ConditionalLongVector, CTX_LONGVECTOR);
2317 RegisterControlConditional(HKEY("COND:ITERATE:ISGROUPCHANGE"), 2,
2318 conditional_ITERATE_ISGROUPCHANGE,
2320 RegisterControlConditional(HKEY("COND:ITERATE:LASTN"), 2,
2321 conditional_ITERATE_LASTN,
2323 RegisterControlNS(HKEY("ITERATE:ODDEVEN"), 0, 0, tmplput_ITERATE_ODDEVEN, CTX_ITERATE);
2324 RegisterControlNS(HKEY("ITERATE:KEY"), 0, 0, tmplput_ITERATE_KEY, CTX_ITERATE);
2325 RegisterControlNS(HKEY("ITERATE:N"), 0, 0, tmplput_ITERATE_LASTN, CTX_ITERATE);