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 int dbg_bactrace_template_errors = 0;
37 WCTemplputParams NoCtx;
40 #define SV_CONDITIONAL 2
41 #define SV_NEG_CONDITIONAL 3
42 #define SV_CUST_STR_CONDITIONAL 4
44 #define SV_PREEVALUATED 6
48 * \brief Dynamic content for variable substitution in templates
50 typedef struct _wcsubst {
52 int wcs_type; /* which type of Substitution are we */
53 char wcs_key[32]; /* copy of our hashkey for debugging */
54 StrBuf *wcs_value; /* if we're a string, keep it here */
55 long lvalue; /* type long? keep data here */
56 WCHandlerFunc wcs_function; /* funcion hook ???*/
60 typedef struct _WCTemplate {
66 WCTemplateToken **Tokens;
69 typedef struct _HashHandler {
72 WCHandlerFunc HandlerFunc;
75 void *load_template(StrBuf *filename, StrBuf *Key, HashList *PutThere);
76 int EvaluateConditional(StrBuf *Target, int Neg, int state, WCTemplputParams *TP);
80 typedef struct _SortStruct {
85 CompareFunc GroupChange;
90 const char *CtxNames[] = {
101 "Context MIME_ATACH",
104 "Context LONGVECTOR",
113 void DestroySortStruct(void *vSort)
115 SortStruct *Sort = (SortStruct*) vSort;
116 FreeStrBuf(&Sort->Name);
117 FreeStrBuf(&Sort->PrefPrepend);
121 const char *ContextName(int ContextType)
123 if (ContextType < CTX_UNKNOWN)
124 return CtxNames[ContextType];
126 return CtxNames[CTX_UNKNOWN];
129 void LogTemplateError (StrBuf *Target, const char *Type, int ErrorPos, WCTemplputParams *TP, const char *Format, ...)
136 const char *Err = NULL;
141 va_start(arg_ptr, Format);
142 StrBufVAppendPrintf(Error, Format, arg_ptr);
147 case ERR_NAME: /* the main token name... */
148 Err = (TP->Tokens!= NULL)? TP->Tokens->pName:"";
151 Err = (TP->Tokens!= NULL)? TP->Tokens->Params[0]->Start:"";
154 Err = (TP->Tokens!= NULL)? TP->Tokens->Params[1]->Start:"";
157 if (TP->Tokens != NULL)
159 lprintf(1, "%s [%s] (in '%s' line %ld); %s; [%s]\n",
162 ChrPtr(TP->Tokens->FileName),
165 ChrPtr(TP->Tokens->FlatToken));
169 lprintf(1, "%s: %s;\n",
176 Header = NewStrBuf();
177 if (TP->Tokens != NULL)
182 "<pre>\n%s [%s] (in '%s' line %ld); %s\n[%s]\n</pre>\n",
185 ChrPtr(TP->Tokens->FileName),
188 ChrPtr(TP->Tokens->FlatToken));
190 StrBufPrintf(Info, "%s [%s] %s; [%s]",
194 ChrPtr(TP->Tokens->FlatToken));
197 SerializeJson(Header, WildFireException(SKEY(TP->Tokens->FileName),
202 SerializeJson(Header, WildFireMessage(SKEY(TP->Tokens->FileName),
207 WildFireSerializePayload(Header, WCC->HBuf, &WCC->nWildfireHeaders, NULL);
214 "<pre>\n%s: %s\n</pre>\n",
218 StrBufPrintf(Info, "%s [%s] %s; [%s]",
222 ChrPtr(TP->Tokens->FlatToken));
223 SerializeJson(Header, WildFireException(HKEY(__FILE__), __LINE__, Info, 1), 1);
224 WildFireSerializePayload(Header, WCC->HBuf, &WCC->nWildfireHeaders, NULL);
230 if (dbg_bactrace_template_errors)
236 void RegisterNS(const char *NSName,
240 WCHandlerFunc HandlerFunc,
243 HashHandler *NewHandler;
245 NewHandler = (HashHandler*) malloc(sizeof(HashHandler));
246 NewHandler->Filter.nMinArgs = nMinArgs;
247 NewHandler->Filter.nMaxArgs = nMaxArgs;
248 NewHandler->Filter.ContextType = ContextRequired;
249 NewHandler->Filter.ControlContextType = CTX_NONE;
251 NewHandler->HandlerFunc = HandlerFunc;
252 Put(GlobalNS, NSName, len, NewHandler, NULL);
255 void RegisterControlNS(const char *NSName,
259 WCHandlerFunc HandlerFunc,
260 int ControlContextRequired)
262 HashHandler *NewHandler;
264 NewHandler = (HashHandler*) malloc(sizeof(HashHandler));
265 NewHandler->Filter.nMinArgs = nMinArgs;
266 NewHandler->Filter.nMaxArgs = nMaxArgs;
267 NewHandler->Filter.ContextType = CTX_NONE;
268 NewHandler->Filter.ControlContextType = ControlContextRequired;
269 NewHandler->HandlerFunc = HandlerFunc;
270 Put(GlobalNS, NSName, len, NewHandler, NULL);
275 int CheckContext(StrBuf *Target, ContextFilter *Need, WCTemplputParams *TP, const char *ErrType)
277 if ((Need->ContextType != CTX_NONE) &&
278 (Need->ContextType != TP->Filter.ContextType)) {
280 Target, ErrType, ERR_PARM1, TP,
281 " WARNING: requires Context: [%s], have [%s]!",
282 ContextName(Need->ContextType),
283 ContextName(TP->Filter.ContextType));
287 if ((Need->ControlContextType != CTX_NONE) &&
288 (Need->ControlContextType != TP->Filter.ControlContextType)) {
290 Target, ErrType, ERR_PARM1, TP,
291 " WARNING: requires Control Context: [%s], have [%s]!",
292 ContextName(Need->ControlContextType),
293 ContextName(TP->Filter.ControlContextType));
297 if (TP->Tokens->nParameters < Need->nMinArgs) {
298 LogTemplateError(Target, ErrType, ERR_NAME, TP,
299 "needs at least %ld params, have %ld",
301 TP->Tokens->nParameters);
305 else if (TP->Tokens->nParameters > Need->nMaxArgs) {
306 LogTemplateError(Target, ErrType, ERR_NAME, TP,
307 "just needs %ld params, you gave %ld",
309 TP->Tokens->nParameters);
317 void FreeToken(WCTemplateToken **Token)
320 FreeStrBuf(&(*Token)->FlatToken);
321 if ((*Token)->HaveParameters)
322 for (i = 0; i < (*Token)->nParameters; i++)
323 free((*Token)->Params[i]);
330 void FreeWCTemplate(void *vFreeMe)
333 WCTemplate *FreeMe = (WCTemplate*)vFreeMe;
335 if (FreeMe->TokenSpace > 0) {
336 for (i = 0; i < FreeMe->nTokensUsed; i ++) {
337 FreeToken(&FreeMe->Tokens[i]);
339 free(FreeMe->Tokens);
341 FreeStrBuf(&FreeMe->FileName);
342 FreeStrBuf(&FreeMe->Data);
343 FreeStrBuf(&FreeMe->MimeType);
349 * \brief debugging function to print array to log
351 void VarPrintTransition(void *vVar1, void *vVar2, int odd){}
353 * \brief debugging function to print array to log
355 void VarPrintEntry(const char *Key, void *vSubst, int odd)
358 lprintf(1,"Subst[%s] : ", Key);
359 ptr = (wcsubst*) vSubst;
361 switch(ptr->wcs_type) {
363 lprintf(1, " -> %s\n", ChrPtr(ptr->wcs_value));
366 lprintf(1, " -> Server [%s]\n", ChrPtr(ptr->wcs_value));
369 lprintf(1, " -> function at [%0xd]\n", ptr->wcs_function);
372 lprintf(1," WARNING: invalid type: [%ld]!\n", ptr->wcs_type);
379 * \brief Clear out the list of substitution variables local to this session
381 void clear_substs(wcsession *wc) {
383 if (wc->vars != NULL) {
384 DeleteHash(&wc->vars);
389 * \brief Clear out the list of substitution variables local to this session
391 void clear_local_substs(void) {
410 void FlushPayload(wcsubst *ptr, int reusestrbuf, int type)
412 int NeedNew = NeedNewBuf(type);
413 switch(ptr->wcs_type) {
417 if (reusestrbuf && NeedNew) {
418 FlushStrBuf(ptr->wcs_value);
422 FreeStrBuf(&ptr->wcs_value);
423 ptr->wcs_value = NULL;
427 ptr->wcs_function = NULL;
428 if (reusestrbuf && NeedNew)
429 ptr->wcs_value = NewStrBuf();
432 ptr->wcs_value = NULL;
433 if (reusestrbuf && NeedNew)
434 ptr->wcs_value = NewStrBuf();
438 if (reusestrbuf && NeedNew)
439 ptr->wcs_value = NewStrBuf();
442 if (reusestrbuf && NeedNew)
443 ptr->wcs_value = NewStrBuf();
450 * \brief destructor; kill one entry.
452 void deletevar(void *data)
454 wcsubst *ptr = (wcsubst*)data;
455 FlushPayload(ptr, 0, ptr->wcs_type);
460 wcsubst *NewSubstVar(const char *keyname, int keylen, int type)
465 ptr = (wcsubst *) malloc(sizeof(wcsubst));
466 memset(ptr, 0, sizeof(wcsubst));
468 ptr->wcs_type = type;
469 safestrncpy(ptr->wcs_key, keyname, sizeof ptr->wcs_key);
470 Put(WCC->vars, keyname, keylen, ptr, deletevar);
472 switch(ptr->wcs_type) {
475 ptr->wcs_value = NewStrBuf();
489 * \brief Add a substitution variable (local to this session) (strlen version...)
490 * \param keyname the replacementstring to substitute
491 * \param keytype the kind of the key
492 * \param format the format string ala printf
493 * \param ... the arguments to substitute in the formatstring
495 void SVPRINTF(char *keyname, int keytype, const char *format,...)
503 keylen = strlen(keyname);
505 * First look if we're doing a replacement of
508 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
509 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
510 ptr = (wcsubst*)vPtr;
511 FlushPayload(ptr, keytype, keytype);
512 ptr->wcs_type = keytype;
514 else /** Otherwise allocate a new one */
516 ptr = NewSubstVar(keyname, keylen, keytype);
519 /** Format the string */
520 va_start(arg_ptr, format);
521 StrBufVAppendPrintf(ptr->wcs_value, format, arg_ptr);
526 * \brief Add a substitution variable (local to this session)
527 * \param keyname the replacementstring to substitute
528 * \param keytype the kind of the key
529 * \param format the format string ala printf
530 * \param ... the arguments to substitute in the formatstring
532 void svprintf(char *keyname, size_t keylen, int keytype, const char *format,...)
540 * First look if we're doing a replacement of
543 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
544 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
545 ptr = (wcsubst*)vPtr;
546 FlushPayload(ptr, 1, keytype);
547 ptr->wcs_type = keytype;
549 else /** Otherwise allocate a new one */
551 ptr = NewSubstVar(keyname, keylen, keytype);
554 /** Format the string and save it */
555 va_start(arg_ptr, format);
556 StrBufVAppendPrintf(ptr->wcs_value, format, arg_ptr);
561 * \brief Add a substitution variable (local to this session)
562 * \param keyname the replacementstring to substitute
563 * \param keytype the kind of the key
564 * \param format the format string ala printf
565 * \param ... the arguments to substitute in the formatstring
567 void SVPut(char *keyname, size_t keylen, int keytype, char *Data)
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, 1, keytype);
582 ptr->wcs_type = keytype;
584 else /** Otherwise allocate a new one */
586 ptr = NewSubstVar(keyname, keylen, keytype);
588 StrBufAppendBufPlain(ptr->wcs_value, Data, -1, 0);
592 * \brief Add a substitution variable (local to this session)
593 * \param keyname the replacementstring to substitute
594 * \param keytype the kind of the key
595 * \param format the format string ala printf
596 * \param ... the arguments to substitute in the formatstring
598 void SVPutLong(char *keyname, size_t keylen, long Data)
606 * First look if we're doing a replacement of
609 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
610 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
611 ptr = (wcsubst*)vPtr;
612 FlushPayload(ptr, 1, WCS_LONG);
613 ptr->wcs_type = WCS_LONG;
615 else /** Otherwise allocate a new one */
617 ptr = NewSubstVar(keyname, keylen, WCS_LONG);
623 * \brief Add a substitution variable (local to this session) that does a callback
624 * \param keyname the keystring to substitute
625 * \param fcn_ptr the function callback to give the substitution string
627 void SVCallback(char *keyname, size_t keylen, WCHandlerFunc fcn_ptr)
634 * First look if we're doing a replacement of
637 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
638 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
639 ptr = (wcsubst*)vPtr;
640 FlushPayload(ptr, 1, WCS_FUNCTION);
641 ptr->wcs_type = WCS_FUNCTION;
643 else /** Otherwise allocate a new one */
645 ptr = NewSubstVar(keyname, keylen, WCS_FUNCTION);
648 ptr->wcs_function = fcn_ptr;
650 inline void SVCALLBACK(char *keyname, WCHandlerFunc fcn_ptr)
652 SVCallback(keyname, strlen(keyname), fcn_ptr);
657 void SVPUTBuf(const char *keyname, int keylen, const StrBuf *Buf, int ref)
664 * First look if we're doing a replacement of
667 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
668 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
669 ptr = (wcsubst*)vPtr;
670 FlushPayload(ptr, 0, (ref)?WCS_STRBUF_REF:WCS_STRBUF);
671 ptr->wcs_type = (ref)?WCS_STRBUF_REF:WCS_STRBUF;
673 else /** Otherwise allocate a new one */
675 ptr = NewSubstVar(keyname, keylen, (ref)?WCS_STRBUF_REF:WCS_STRBUF);
677 ptr->wcs_value = (StrBuf*)Buf;
681 * \brief back end for print_value_of() ... does a server command
682 * \param servcmd server command to execute on the citadel server
684 void pvo_do_cmd(StrBuf *Target, StrBuf *servcmd) {
688 serv_puts(ChrPtr(servcmd));
689 len = serv_getln(buf, sizeof buf);
695 StrBufAppendPrintf(Target, "%s\n", &buf[4]);
698 _fmout(Target, "CENTER");
701 StrBufAppendPrintf(Target, "%s\n", &buf[4]);
707 void GetTemplateTokenString(StrBuf *Target,
708 WCTemplputParams *TP,
714 WCTemplputParams SubTP;
716 if (TP->Tokens->nParameters < N) {
717 LogTemplateError(Target,
718 "TokenParameter", N, TP,
719 "invalid token %d. this shouldn't have come till here.\n", N);
725 switch (TP->Tokens->Params[N]->Type) {
728 *Value = TP->Tokens->Params[N]->Start;
729 *len = TP->Tokens->Params[N]->len;
732 Buf = (StrBuf*) SBstr(TKEY(N));
733 *Value = ChrPtr(Buf);
734 *len = StrLength(Buf);
737 get_PREFERENCE(TKEY(N), &Buf);
738 *Value = ChrPtr(Buf);
739 *len = StrLength(Buf);
742 LogTemplateError(Target,
743 "TokenParameter", N, TP,
744 "Requesting parameter %d; of type LONG, want string.", N);
747 LogTemplateError(Target,
748 "TokenParameter", N, TP,
749 "Requesting parameter %d; of type PREFINT, want string.", N);
752 *Value = _(TP->Tokens->Params[N]->Start);
753 *len = strlen(*Value);
755 case TYPE_SUBTEMPLATE:
756 memset(&SubTP, 0, sizeof(WCTemplputParams *));
757 SubTP.Context = TP->Context;
758 SubTP.Filter.ContextType = TP->Filter.ContextType;
760 DoTemplate(TKEY(N), Buf, &SubTP);
761 *Value = ChrPtr(Buf);
762 *len = StrLength(Buf);
763 /* we can't free it here, so we put it into the subst so its discarded later on. */
764 SVPUTBuf(TKEY(N), Buf, 0);
768 LogTemplateError(Target,
769 "TokenParameter", N, TP,
770 "unknown param type %d; [%d]", N, TP->Tokens->Params[N]->Type);
775 long GetTemplateTokenNumber(StrBuf *Target, WCTemplputParams *TP, int N, long dflt)
778 if (TP->Tokens->nParameters < N) {
779 LogTemplateError(Target,
780 "TokenParameter", N, TP,
781 "invalid token %d. this shouldn't have come till here.\n", N);
786 switch (TP->Tokens->Params[N]->Type) {
789 return atol(TP->Tokens->Params[N]->Start);
792 return LBstr(TKEY(N));
795 LogTemplateError(Target,
796 "TokenParameter", N, TP,
797 "requesting a prefstring in param %d want a number", N);
798 if (get_PREF_LONG(TKEY(N), &Ret, dflt))
802 return TP->Tokens->Params[N]->lvalue;
804 if (get_PREF_LONG(TKEY(N), &Ret, dflt))
808 LogTemplateError(Target,
809 "TokenParameter", N, TP,
810 "requesting a I18N string in param %d; want a number", N);
812 case TYPE_SUBTEMPLATE:
813 LogTemplateError(Target,
814 "TokenParameter", N, TP,
815 "requesting a subtemplate in param %d; not supported for numbers", N);
818 LogTemplateError(Target,
819 "TokenParameter", N, TP,
820 "unknown param type %d; [%d]", N, TP->Tokens->Params[N]->Type);
828 * \brief Print the value of a variable
829 * \param keyname get a key to print
831 void print_value_of(StrBuf *Target, WCTemplputParams *TP)
838 /*if (WCC->vars != NULL) PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
839 /* TODO: depricated! */
840 if (TP->Tokens->pName[0] == '=') {
841 DoTemplate(TP->Tokens->pName+1, TP->Tokens->NameEnd - 1, NULL, &NoCtx);
843 /*/////TODO: if param[1] == "U" -> urlescape
845 /** Page-local variables */
846 if ((WCC->vars!= NULL) && GetHash(WCC->vars, TP->Tokens->pName, TP->Tokens->NameEnd, &vVar)) {
847 ptr = (wcsubst*) vVar;
848 switch(ptr->wcs_type) {
850 StrBufAppendBuf(Target, ptr->wcs_value, 0);
853 pvo_do_cmd(Target, ptr->wcs_value);
856 (*ptr->wcs_function) (Target, TP);
860 StrBufAppendBuf(Target, ptr->wcs_value, 0);
863 StrBufAppendPrintf(Target, "%ld", ptr->lvalue);
867 Target, "Subst", ERR_NAME, TP,
868 "WARNING: invalid value in SV-Hash at %s!", TP->Tokens->pName);
873 Target, "Token", ERR_NAME, TP,
874 "didn't find Handler \"%s\"", TP->Tokens->pName);
879 int CompareSubstToToken(TemplateParam *ParamToCompare, TemplateParam *ParamToLookup)
885 if ((WCC->vars!= NULL) && GetHash(WCC->vars, ParamToLookup->Start,
886 ParamToLookup->len, &vVar)) {
887 ptr = (wcsubst*) vVar;
888 switch(ptr->wcs_type) {
892 if (ParamToCompare->Type == TYPE_STR)
893 return ((ParamToCompare->len == StrLength(ptr->wcs_value)) &&
894 (strcmp(ParamToCompare->Start, ChrPtr(ptr->wcs_value)) == 0));
896 return ParamToCompare->lvalue == StrTol(ptr->wcs_value);
904 if (ParamToCompare->Type == TYPE_STR)
907 return ParamToCompare->lvalue == ptr->lvalue;
910 lprintf(1,"WARNING: invalid value in SV-Hash at %s!\n",
911 ParamToLookup->Start);
917 int CompareSubstToStrBuf(StrBuf *Compare, TemplateParam *ParamToLookup)
923 if ((WCC->vars!= NULL) && GetHash(WCC->vars, ParamToLookup->Start,
924 ParamToLookup->len, &vVar)) {
925 ptr = (wcsubst*) vVar;
926 switch(ptr->wcs_type) {
930 return ((StrLength(Compare) == StrLength(ptr->wcs_value)) &&
931 (strcmp(ChrPtr(Compare), ChrPtr(ptr->wcs_value)) == 0));
938 return StrTol(Compare) == ptr->lvalue;
940 lprintf(1,"WARNING: invalid value in SV-Hash at %s!\n",
941 ParamToLookup->Start);
950 * \brief puts string into the template and computes which escape methon we should use
951 * \param Source the string we should put into the template
952 * \param FormatTypeIndex where should we look for escape types if?
954 void StrBufAppendTemplate(StrBuf *Target,
955 WCTemplputParams *TP,
956 const StrBuf *Source, int FormatTypeIndex)
961 if ((FormatTypeIndex < TP->Tokens->nParameters) &&
962 (TP->Tokens->Params[FormatTypeIndex]->Type == TYPE_STR) &&
963 (TP->Tokens->Params[FormatTypeIndex]->len == 1)) {
964 EscapeAs = *TP->Tokens->Params[FormatTypeIndex]->Start;
971 StrEscAppend(Target, Source, NULL, 0, 2);
974 StrEscAppend(Target, Source, NULL, 0, 0);
977 StrECMAEscAppend(Target, Source, NULL);
980 StrBufAppendBuf(Target, Source, 0);
985 void PutNewToken(WCTemplate *Template, WCTemplateToken *NewToken)
987 if (Template->nTokensUsed + 1 >= Template->TokenSpace) {
988 if (Template->TokenSpace <= 0) {
989 Template->Tokens = (WCTemplateToken**)malloc(
990 sizeof(WCTemplateToken*) * 10);
991 Template->TokenSpace = 10;
994 WCTemplateToken **NewTokens;
995 NewTokens= (WCTemplateToken**)malloc(
996 sizeof(WCTemplateToken*) *
997 Template->TokenSpace * 2);
998 memcpy(NewTokens, Template->Tokens,
999 sizeof(WCTemplateToken*) * Template->nTokensUsed);
1000 free(Template->Tokens);
1001 Template->TokenSpace *= 2;
1002 Template->Tokens = NewTokens;
1005 Template->Tokens[(Template->nTokensUsed)++] = NewToken;
1008 TemplateParam *GetNextParameter(StrBuf *Buf, const char **pCh, const char *pe, WCTemplateToken *Tokens, WCTemplate *pTmpl)
1010 const char *pch = *pCh;
1011 const char *pchs, *pche;
1012 TemplateParam *Parm = (TemplateParam *) malloc(sizeof(TemplateParam));
1016 Parm->Type = TYPE_STR;
1018 /* Skip leading whitespaces */
1019 while ((*pch == ' ' )||
1022 (*pch == '\n')) pch ++;
1025 Parm->Type = TYPE_PREFSTR;
1032 else if (*pch == ';') {
1033 Parm->Type = TYPE_PREFINT;
1040 else if (*pch == '_') {
1041 Parm->Type = TYPE_GETTEXT;
1048 else if (*pch == 'B') {
1049 Parm->Type = TYPE_BSTR;
1056 else if (*pch == '=') {
1057 Parm->Type = TYPE_SUBTEMPLATE;
1068 else if (*pch == '\'')
1070 if (quote != '\0') {
1075 ( (pch > pchs) && (*(pch - 1) == '\\'))
1080 if (*pch != quote) {
1081 lprintf(1, "Error (in '%s' line %ld); "
1082 "evaluating template param [%s] in Token [%s]\n",
1083 ChrPtr(pTmpl->FileName),
1085 ChrPtr(Tokens->FlatToken),
1092 StrBufPeek(Buf, pch, -1, '\0');
1093 if (LoadTemplates > 1) {
1094 lprintf(1, "DBG: got param [%s] %ld %ld\n",
1095 pchs, pche - pchs, strlen(pchs));
1098 Parm->len = pche - pchs;
1099 pch ++; /* move after trailing quote */
1100 if (ParamBrace && (*pch == ')')) {
1107 Parm->Type = TYPE_LONG;
1109 while ((pch <= pe) &&
1115 if (pch - pchs > 1){
1116 StrBufPeek(Buf, pch, -1, '\0');
1117 Parm->lvalue = atol(pchs);
1124 lprintf(1, "Error (in '%s' line %ld); "
1125 "evaluating long template param [%s] in Token [%s]\n",
1126 ChrPtr(pTmpl->FileName),
1128 ChrPtr(Tokens->FlatToken),
1135 while ((*pch == ' ' )||
1139 (*pch == '\n')) pch ++;
1145 WCTemplateToken *NewTemplateSubstitute(StrBuf *Buf,
1147 const char *pTmplStart,
1148 const char *pTmplEnd,
1154 TemplateParam *Param;
1155 WCTemplateToken *NewToken = (WCTemplateToken*)malloc(sizeof(WCTemplateToken));
1156 WCTemplputParams TP;
1158 TP.Tokens = NewToken;
1159 NewToken->FileName = pTmpl->FileName; /* to print meaningfull log messages... */
1160 NewToken->Flags = 0;
1161 NewToken->Line = Line + 1;
1162 NewToken->pTokenStart = pTmplStart;
1163 NewToken->TokenStart = pTmplStart - pStart;
1164 NewToken->TokenEnd = (pTmplEnd - pStart) - NewToken->TokenStart;
1165 NewToken->pTokenEnd = pTmplEnd;
1166 NewToken->NameEnd = NewToken->TokenEnd - 2;
1167 NewToken->PreEval = NULL;
1168 NewToken->FlatToken = NewStrBufPlain(pTmplStart + 2, pTmplEnd - pTmplStart - 2);
1170 StrBufPeek(Buf, pTmplStart, + 1, '\0');
1171 StrBufPeek(Buf, pTmplEnd, -1, '\0');
1172 pch = NewToken->pName = pTmplStart + 2;
1174 NewToken->HaveParameters = 0;;
1175 NewToken->nParameters = 0;
1177 while (pch < pTmplEnd - 1) {
1179 StrBufPeek(Buf, pch, -1, '\0');
1180 NewToken->NameEnd = pch - NewToken->pName;
1182 if (*(pTmplEnd - 1) != ')') {
1184 NULL, "Parseerror", ERR_NAME, &TP,
1185 "Warning, Non welformed Token; missing right parenthesis");
1187 while (pch < pTmplEnd - 1) {
1188 Param = GetNextParameter(Buf, &pch, pTmplEnd - 1, NewToken, pTmpl);
1189 if (Param != NULL) {
1190 NewToken->HaveParameters = 1;
1191 if (NewToken->nParameters > MAXPARAM) {
1193 NULL, "Parseerror", ERR_NAME, &TP,
1194 "only [%d] Params allowed in Tokens",
1198 FreeToken(&NewToken);
1201 NewToken->Params[NewToken->nParameters++] = Param;
1205 if((NewToken->NameEnd == 1) &&
1206 (NewToken->HaveParameters == 1))
1209 if (*(NewToken->pName) == '_')
1210 NewToken->Flags = SV_GETTEXT;
1211 else if (*(NewToken->pName) == '=')
1212 NewToken->Flags = SV_SUBTEMPL;
1213 else if (*(NewToken->pName) == '%')
1214 NewToken->Flags = SV_CUST_STR_CONDITIONAL;
1215 else if (*(NewToken->pName) == '?')
1216 NewToken->Flags = SV_CONDITIONAL;
1217 else if (*(NewToken->pName) == '!')
1218 NewToken->Flags = SV_NEG_CONDITIONAL;
1224 switch (NewToken->Flags) {
1226 /* If we're able to find out more about the token, do it now while its fresh. */
1227 if (GetHash(GlobalNS, NewToken->pName, NewToken->NameEnd, &vVar)) {
1228 HashHandler *Handler;
1229 Handler = (HashHandler*) vVar;
1230 if ((NewToken->nParameters < Handler->Filter.nMinArgs) ||
1231 (NewToken->nParameters > Handler->Filter.nMaxArgs)) {
1233 NULL, "Token", ERR_NAME, &TP,
1234 "doesn't work with %d params",
1235 NewToken->nParameters);
1239 NewToken->PreEval = Handler;
1240 NewToken->Flags = SV_PREEVALUATED;
1245 if (NewToken->nParameters !=1) {
1247 NULL, "Gettext", ERR_NAME, &TP,
1248 "requires exactly 1 parameter, you gave %d params",
1249 NewToken->nParameters);
1250 NewToken->Flags = 0;
1255 if (NewToken->nParameters != 1) {
1257 NULL, "Subtemplates", ERR_NAME, &TP,
1258 "require exactly 1 parameter, you gave %d params",
1259 NewToken->nParameters);
1263 case SV_CUST_STR_CONDITIONAL:
1264 case SV_CONDITIONAL:
1265 case SV_NEG_CONDITIONAL:
1266 if (NewToken->nParameters <2) {
1268 NULL, "Conditional", ERR_NAME, &TP,
1269 "require at least 2 parameters, you gave %d params",
1270 NewToken->nParameters);
1271 NewToken->Flags = 0;
1274 if (NewToken->Params[1]->lvalue == 0) {
1276 NULL, "Conditional", ERR_NAME, &TP,
1277 "Conditional ID (Parameter 1) mustn't be 0!");
1278 NewToken->Flags = 0;
1281 if (!GetHash(Conditionals,
1282 NewToken->Params[0]->Start,
1283 NewToken->Params[0]->len,
1286 if ((NewToken->Params[0]->len == 1) &&
1287 (NewToken->Params[0]->Start[0] == 'X'))
1290 NULL, "Conditional", ERR_NAME, &TP,
1293 NewToken->Error = NewStrBuf();
1296 "<pre>\nConditional [%s] (in '%s' line %ld); Not found!\n[%s]\n</pre>\n",
1297 NewToken->Params[0]->Start,
1298 ChrPtr(pTmpl->FileName),
1300 ChrPtr(NewToken->FlatToken));
1304 NewToken->PreEval = vVar;
1316 * \brief Display a variable-substituted template
1317 * \param templatename template file to load
1319 void *prepare_template(StrBuf *filename, StrBuf *Key, HashList *PutThere)
1321 WCTemplate *NewTemplate;
1322 NewTemplate = (WCTemplate *) malloc(sizeof(WCTemplate));
1323 NewTemplate->Data = NULL;
1324 NewTemplate->FileName = NewStrBufDup(filename);
1325 NewTemplate->nTokensUsed = 0;
1326 NewTemplate->TokenSpace = 0;
1327 NewTemplate->Tokens = NULL;
1328 NewTemplate->MimeType = NewStrBufPlain(GuessMimeByFilename (SKEY(NewTemplate->FileName)), -1);
1329 if (strstr(ChrPtr(NewTemplate->MimeType), "text") != NULL) {
1330 StrBufAppendBufPlain(NewTemplate->MimeType, HKEY("; charset=utf-8"), 0);
1333 Put(PutThere, ChrPtr(Key), StrLength(Key), NewTemplate, FreeWCTemplate);
1338 * \brief Display a variable-substituted template
1339 * \param templatename template file to load
1341 void *load_template(StrBuf *filename, StrBuf *Key, HashList *PutThere)
1344 struct stat statbuf;
1345 const char *pS, *pE, *pch, *Err;
1348 WCTemplate *NewTemplate;
1350 fd = open(ChrPtr(filename), O_RDONLY);
1352 lprintf(1, "ERROR: could not open template '%s' - %s\n",
1353 ChrPtr(filename), strerror(errno));
1357 if (fstat(fd, &statbuf) == -1) {
1358 lprintf(1, "ERROR: could not stat template '%s' - %s\n",
1359 ChrPtr(filename), strerror(errno));
1363 NewTemplate = (WCTemplate *) malloc(sizeof(WCTemplate));
1364 NewTemplate->Data = NewStrBufPlain(NULL, statbuf.st_size);
1365 NewTemplate->FileName = NewStrBufDup(filename);
1366 NewTemplate->nTokensUsed = 0;
1367 NewTemplate->TokenSpace = 0;
1368 NewTemplate->Tokens = NULL;
1369 NewTemplate->MimeType = NewStrBufPlain(GuessMimeByFilename (SKEY(NewTemplate->FileName)), -1);
1370 if (strstr(ChrPtr(NewTemplate->MimeType), "text") != NULL) {
1371 StrBufAppendBufPlain(NewTemplate->MimeType, HKEY("; charset=utf-8"), 0);
1374 if (StrBufReadBLOB(NewTemplate->Data, &fd, 1, statbuf.st_size, &Err) < 0) {
1376 FreeWCTemplate(NewTemplate);
1377 lprintf(1, "ERROR: reading template '%s' - %s<br />\n",
1378 ChrPtr(filename), strerror(errno));
1384 pS = pch = ChrPtr(NewTemplate->Data);
1385 pE = pS + StrLength(NewTemplate->Data);
1387 const char *pts, *pte;
1389 int InDoubleQuotes = 0;
1391 /** Find one <? > */
1393 for (; pch < pE; pch ++) {
1394 if ((*pch=='<')&&(*(pch + 1)=='?'))
1396 if (*pch=='\n') Line ++;
1402 /** Found one? parse it. */
1403 for (; pch <= pE - 1; pch ++) {
1405 InDoubleQuotes = ! InDoubleQuotes;
1406 else if (*pch == '\'')
1407 InQuotes = ! InQuotes;
1408 else if ((!InQuotes && !InDoubleQuotes) &&
1409 ((*pch!='\\')&&(*(pch + 1)=='>'))) {
1417 PutNewToken(NewTemplate,
1418 NewTemplateSubstitute(NewTemplate->Data, pS, pts, pte, Line, NewTemplate));
1421 if (LoadTemplates == 0)
1422 Put(PutThere, ChrPtr(Key), StrLength(Key), NewTemplate, FreeWCTemplate);
1427 const char* PrintTemplate(void *vSubst)
1429 WCTemplate *Tmpl = vSubst;
1431 return ChrPtr(Tmpl->FileName);
1435 int LoadTemplateDir(const char *DirName, HashList *wireless, HashList *big)
1440 DIR *filedir = NULL;
1441 struct dirent *filedir_entry;
1447 StrBufPrintf(Dir, "%s/t", DirName);
1448 filedir = opendir (ChrPtr(Dir));
1449 if (filedir == NULL) {
1454 FileName = NewStrBuf();
1456 while ((filedir_entry = readdir(filedir)))
1460 #ifdef _DIRENT_HAVE_D_NAMELEN
1461 d_namelen = filedir_entry->d_namelen;
1463 d_namelen = strlen(filedir_entry->d_name);
1465 d_without_ext = d_namelen;
1466 while ((d_without_ext > 0) && (filedir_entry->d_name[d_without_ext] != '.'))
1468 if ((d_without_ext == 0) || (d_namelen < 3))
1470 if ((d_namelen > 1) && filedir_entry->d_name[d_namelen - 1] == '~')
1471 continue; /* Ignore backup files... */
1473 IsMobile = (strstr(filedir_entry->d_name, ".m.html")!= NULL);
1474 PStart = filedir_entry->d_name;
1475 StrBufPrintf(FileName, "%s/%s", ChrPtr(Dir), filedir_entry->d_name);
1476 MinorPtr = strchr(filedir_entry->d_name, '.');
1477 if (MinorPtr != NULL)
1479 StrBufPlain(Tag, filedir_entry->d_name, MinorPtr - filedir_entry->d_name);
1481 if (LoadTemplates > 1)
1482 lprintf(1, "%s %d %s\n",ChrPtr(FileName), IsMobile, ChrPtr(Tag));
1483 if (LoadTemplates == 0)
1484 load_template(FileName, Tag, (IsMobile)?wireless:big);
1486 prepare_template(FileName, Tag, (IsMobile)?wireless:big);
1489 FreeStrBuf(&FileName);
1495 void InitTemplateCache(void)
1497 LoadTemplateDir(static_dirs[0],
1498 WirelessTemplateCache,
1500 LoadTemplateDir(static_dirs[1],
1501 WirelessLocalTemplateCache,
1502 LocalTemplateCache);
1507 /*-----------------------------------------------------------------------------
1508 * Filling & processing Templates
1511 * \brief executes one token
1512 * \param Target buffer to append to
1513 * \param Token da to process.
1514 * \param Template we're iterating
1515 * \param Context Contextpoointer to pass in
1516 * \param state are we in conditional state?
1517 * \param ContextType what type of information does context giv us?
1519 int EvaluateToken(StrBuf *Target, int state, WCTemplputParams *TP)
1521 const char *AppendMe;
1523 HashHandler *Handler;
1526 /* much output, since pName is not terminated...
1527 lprintf(1,"Doing token: %s\n",Token->pName);
1530 switch (TP->Tokens->Flags) {
1532 TmplGettext(Target, TP);
1534 case SV_CONDITIONAL: /** Forward conditional evaluation */
1535 return EvaluateConditional(Target, 1, state, TP);
1537 case SV_NEG_CONDITIONAL: /** Reverse conditional evaluation */
1538 return EvaluateConditional(Target, 0, state, TP);
1540 case SV_CUST_STR_CONDITIONAL: /** Conditional put custom strings from params */
1541 if (TP->Tokens->nParameters >= 6) {
1542 if (EvaluateConditional(Target, 0, state, TP)) {
1543 GetTemplateTokenString(Target, TP, 5, &AppendMe, &AppendMeLen);
1544 StrBufAppendBufPlain(Target,
1550 GetTemplateTokenString(Target, TP, 4, &AppendMe, &AppendMeLen);
1551 StrBufAppendBufPlain(Target,
1559 Target, "Conditional", ERR_NAME, TP,
1560 "needs at least 6 Params!");
1564 if (TP->Tokens->nParameters == 1)
1565 DoTemplate(TKEY(0), Target, TP);
1567 case SV_PREEVALUATED:
1568 Handler = (HashHandler*) TP->Tokens->PreEval;
1569 if (!CheckContext(Target, &Handler->Filter, TP, "Token")) {
1572 Handler->HandlerFunc(Target, TP);
1575 if (GetHash(GlobalNS, TP->Tokens->pName, TP->Tokens->NameEnd, &vVar)) {
1576 Handler = (HashHandler*) vVar;
1577 if (!CheckContext(Target, &Handler->Filter, TP, "Token")) {
1581 Handler->HandlerFunc(Target, TP);
1585 print_value_of(Target, TP);
1593 const StrBuf *ProcessTemplate(WCTemplate *Tmpl, StrBuf *Target, WCTemplputParams *CallingTP)
1595 WCTemplate *pTmpl = Tmpl;
1598 const char *pData, *pS;
1600 WCTemplputParams TP;
1602 memcpy(&TP.Filter, &CallingTP->Filter, sizeof(ContextFilter));
1604 TP.Context = CallingTP->Context;
1605 TP.ControlContext = CallingTP->ControlContext;
1607 if (LoadTemplates != 0) {
1608 if (LoadTemplates > 1)
1609 lprintf(1, "DBG: ----- loading: [%s] ------ \n",
1610 ChrPtr(Tmpl->FileName));
1612 pTmpl = load_template(Tmpl->FileName, NULL, NULL);
1616 "<pre>\nError loading Template [%s]\n See Logfile for details\n</pre>\n",
1617 ChrPtr(Tmpl->FileName));
1623 pS = pData = ChrPtr(pTmpl->Data);
1624 len = StrLength(pTmpl->Data);
1628 if (i >= pTmpl->nTokensUsed) {
1629 StrBufAppendBufPlain(Target,
1631 len - (pData - pS), 0);
1635 StrBufAppendBufPlain(
1637 pTmpl->Tokens[i]->pTokenStart - pData, 0);
1638 TP.Tokens = pTmpl->Tokens[i];
1639 TP.nArgs = pTmpl->Tokens[i]->nParameters;
1640 state = EvaluateToken(Target, state, &TP);
1642 while ((state != 0) && (i+1 < pTmpl->nTokensUsed)) {
1643 /* condition told us to skip till its end condition */
1645 TP.Tokens = pTmpl->Tokens[i];
1646 TP.nArgs = pTmpl->Tokens[i]->nParameters;
1647 if ((pTmpl->Tokens[i]->Flags == SV_CONDITIONAL) ||
1648 (pTmpl->Tokens[i]->Flags == SV_NEG_CONDITIONAL)) {
1649 if (state == EvaluateConditional(
1651 pTmpl->Tokens[i]->Flags,
1657 pData = pTmpl->Tokens[i++]->pTokenEnd + 1;
1658 if (i > pTmpl->nTokensUsed)
1662 if (LoadTemplates != 0) {
1663 FreeWCTemplate(pTmpl);
1665 return Tmpl->MimeType;
1670 * \brief Display a variable-substituted template
1671 * \param templatename template file to load
1672 * \returns the mimetype of the template its doing
1674 const StrBuf *DoTemplate(const char *templatename, long len, StrBuf *Target, WCTemplputParams *TP)
1676 WCTemplputParams LocalTP;
1678 HashList *StaticLocal;
1684 memset(&LocalTP, 0, sizeof(WCTemplputParams));
1688 if (WC->is_mobile) {
1689 Static = WirelessTemplateCache;
1690 StaticLocal = WirelessLocalTemplateCache;
1693 Static = TemplateCache;
1694 StaticLocal = LocalTemplateCache;
1699 lprintf (1, "Can't to load a template with empty name!\n");
1700 StrBufAppendPrintf(Target, "<pre>\nCan't to load a template with empty name!\n</pre>");
1704 if (!GetHash(StaticLocal, templatename, len, &vTmpl) &&
1705 !GetHash(Static, templatename, len, &vTmpl)) {
1706 lprintf (1, "didn't find Template [%s] %ld %ld\n", templatename, len , (long)strlen(templatename));
1707 StrBufAppendPrintf(Target, "<pre>\ndidn't find Template [%s] %ld %ld\n</pre>",
1709 (long)strlen(templatename));
1711 dbg_PrintHash(Static, PrintTemplate, NULL);
1712 PrintHash(Static, VarPrintTransition, PrintTemplate);
1718 return ProcessTemplate(vTmpl, Target, TP);
1722 /*-----------------------------------------------------------------------------
1725 typedef struct _HashIterator {
1726 HashList *StaticList;
1727 int AdditionalParams;
1729 int XPectContextType;
1731 RetrieveHashlistFunc GetHash;
1732 HashDestructorFunc Destructor;
1733 SubTemplFunc DoSubTemplate;
1736 void RegisterITERATOR(const char *Name, long len,
1737 int AdditionalParams,
1738 HashList *StaticList,
1739 RetrieveHashlistFunc GetHash,
1740 SubTemplFunc DoSubTempl,
1741 HashDestructorFunc Destructor,
1743 int XPectContextType,
1746 HashIterator *It = (HashIterator*)malloc(sizeof(HashIterator));
1747 It->StaticList = StaticList;
1748 It->AdditionalParams = AdditionalParams;
1749 It->GetHash = GetHash;
1750 It->DoSubTemplate = DoSubTempl;
1751 It->Destructor = Destructor;
1752 It->ContextType = ContextType;
1753 It->XPectContextType = XPectContextType;
1755 Put(Iterators, Name, len, It, NULL);
1758 typedef struct _iteratestruct {
1767 void tmpl_iterate_subtmpl(StrBuf *Target, WCTemplputParams *TP)
1773 SortStruct *SortBy = NULL;
1775 int DetectGroupChange = 0;
1778 void *vLastContext = NULL;
1780 WCTemplputParams SubTP;
1781 IterateStruct Status;
1787 memset(&Status, 0, sizeof(IterateStruct));
1788 memcpy (&SubTP, &TP, sizeof(WCTemplputParams));
1790 if (!GetHash(Iterators, TKEY(0), &vIt)) {
1792 Target, "Iterator", ERR_PARM1, TP, "Unknown!");
1796 It = (HashIterator*) vIt;
1798 if (TP->Tokens->nParameters < It->AdditionalParams + 2) {
1800 Target, "Iterator", ERR_PARM1, TP,
1801 "doesn't work with %d params",
1802 TP->Tokens->nParameters);
1806 if ((It->XPectContextType != CTX_NONE) &&
1807 (It->XPectContextType != TP->Filter.ContextType)) {
1809 Target, "Iterator", ERR_PARM1, TP,
1810 "requires context of type %d, have %d",
1811 It->XPectContextType,
1812 TP->Filter.ContextType);
1817 if (It->StaticList == NULL)
1818 List = It->GetHash(Target, TP);
1820 List = It->StaticList;
1822 DetectGroupChange = (It->Flags & IT_FLAG_DETECT_GROUPCHANGE) != 0;
1823 if (DetectGroupChange) {
1824 const StrBuf *BSort;
1825 DetectGroupChange = 0;
1826 if (havebstr("SortBy")) {
1827 BSort = sbstr("SortBy");
1828 if (GetHash(SortHash, SKEY(BSort), &vSortBy) &&
1829 (vSortBy != NULL)) {
1830 SortBy = (SortStruct*)vSortBy;
1831 /** Ok, its us, lets see in which direction we should sort... */
1832 if (havebstr("SortOrder")) {
1834 SortOrder = LBSTR("SortOrder");
1836 DetectGroupChange = 1;
1841 nMembersUsed = GetCount(List);
1842 SubBuf = NewStrBuf();
1843 SubTP.Filter.ContextType = It->ContextType;
1844 SubTP.Filter.ControlContextType = CTX_ITERATE;
1845 SubTP.ControlContext = &Status;
1847 if (HAVE_PARAM(2)) {
1848 StartAt = GetTemplateTokenNumber(Target, TP, 2, 0);
1850 if (HAVE_PARAM(3)) {
1851 StepWidth = GetTemplateTokenNumber(Target, TP, 3, 0);
1853 if (HAVE_PARAM(4)) {
1854 StopAt = GetTemplateTokenNumber(Target, TP, 4, -1);
1856 it = GetNewHashPos(List, StepWidth);
1858 StopAt = GetCount(List);
1860 while (GetNextHashPos(List, it, &Status.KeyLen, &Status.Key, &vContext)) {
1861 if ((Status.n >= StartAt) && (Status.n <= StopAt)) {
1862 if (DetectGroupChange && Status.n > 0) {
1863 Status.GroupChange = (SortBy->GroupChange(vContext, vLastContext))? 1:0;
1865 Status.LastN = (Status.n + 1) == nMembersUsed;
1866 SubTP.Context = vContext;
1867 if (It->DoSubTemplate != NULL)
1868 It->DoSubTemplate(SubBuf, &SubTP);
1869 DoTemplate(TKEY(1), SubBuf, &SubTP);
1871 StrBufAppendBuf(Target, SubBuf, 0);
1872 FlushStrBuf(SubBuf);
1873 Status.oddeven = ! Status.oddeven;
1874 vLastContext = vContext;
1878 FreeStrBuf(&SubBuf);
1880 if (It->Destructor != NULL)
1881 It->Destructor(&List);
1885 int conditional_ITERATE_ISGROUPCHANGE(StrBuf *Target, WCTemplputParams *TP)
1887 IterateStruct *Ctx = CCTX;
1888 return Ctx->GroupChange;
1891 void tmplput_ITERATE_ODDEVEN(StrBuf *Target, WCTemplputParams *TP)
1893 IterateStruct *Ctx = CCTX;
1895 StrBufAppendBufPlain(Target, HKEY("odd"), 0);
1897 StrBufAppendBufPlain(Target, HKEY("even"), 0);
1901 void tmplput_ITERATE_KEY(StrBuf *Target, WCTemplputParams *TP)
1903 IterateStruct *Ctx = CCTX;
1905 StrBufAppendBufPlain(Target, Ctx->Key, Ctx->KeyLen, 0);
1909 void tmplput_ITERATE_LASTN(StrBuf *Target, WCTemplputParams *TP)
1911 IterateStruct *Ctx = CCTX;
1912 StrBufAppendPrintf(Target, "%d", Ctx->n);
1915 int conditional_ITERATE_LASTN(StrBuf *Target, WCTemplputParams *TP)
1917 IterateStruct *Ctx = CCTX;
1923 /*-----------------------------------------------------------------------------
1926 int EvaluateConditional(StrBuf *Target, int Neg, int state, WCTemplputParams *TP)
1928 ConditionalStruct *Cond;
1930 if ((TP->Tokens->Params[0]->len == 1) &&
1931 (TP->Tokens->Params[0]->Start[0] == 'X'))
1932 return (state != 0)?TP->Tokens->Params[1]->lvalue:0;
1934 Cond = (ConditionalStruct *) TP->Tokens->PreEval;
1937 Target, "Conditional", ERR_PARM1, TP,
1942 if (!CheckContext(Target, &Cond->Filter, TP, "Conditional")) {
1946 if (Cond->CondF(Target, TP) == Neg)
1947 return TP->Tokens->Params[1]->lvalue;
1951 int ConditionalVar(StrBuf *Target, WCTemplputParams *TP)
1956 if (!GetHash(WC->vars, TKEY(2), &vsubst))
1958 subst = (wcsubst*) vsubst;
1960 switch(subst->wcs_type) {
1962 return (subst->wcs_function!=NULL);
1964 lprintf(1, " -> Server [%s]\n", subst->wcs_value);/* TODO */
1968 case WCS_STRBUF_REF:
1969 if (TP->Tokens->nParameters < 4)
1971 return (strcmp(TP->Tokens->Params[3]->Start, ChrPtr(subst->wcs_value)) == 0);
1973 if (TP->Tokens->nParameters < 4)
1974 return (subst->lvalue != 0);
1975 return (subst->lvalue == TP->Tokens->Params[3]->lvalue);
1977 lprintf(1," WARNING: invalid type: [%ld]!\n", subst->wcs_type);
1983 void RegisterConditional(const char *Name, long len,
1985 WCConditionalFunc CondF,
1986 int ContextRequired)
1988 ConditionalStruct *Cond = (ConditionalStruct*)malloc(sizeof(ConditionalStruct));
1989 Cond->PlainName = Name;
1990 Cond->Filter.nMaxArgs = nParams;
1991 Cond->Filter.nMinArgs = nParams;
1992 Cond->CondF = CondF;
1993 Cond->Filter.ContextType = ContextRequired;
1994 Cond->Filter.ControlContextType = CTX_NONE;
1995 Put(Conditionals, Name, len, Cond, NULL);
1998 void RegisterControlConditional(const char *Name, long len,
2000 WCConditionalFunc CondF,
2001 int ControlContextRequired)
2003 ConditionalStruct *Cond = (ConditionalStruct*)malloc(sizeof(ConditionalStruct));
2004 Cond->PlainName = Name;
2005 Cond->Filter.nMaxArgs = nParams;
2006 Cond->Filter.nMinArgs = nParams;
2007 Cond->CondF = CondF;
2008 Cond->Filter.ContextType = CTX_NONE;
2009 Cond->Filter.ControlContextType = ControlContextRequired;
2010 Put(Conditionals, Name, len, Cond, NULL);
2013 /*-----------------------------------------------------------------------------
2016 void tmplput_ContextString(StrBuf *Target, WCTemplputParams *TP)
2018 StrBufAppendTemplate(Target, TP, (StrBuf*)CTX, 0);
2020 int ConditionalContextStr(StrBuf *Target, WCTemplputParams *TP)
2022 StrBuf *TokenText = (StrBuf*) CTX;
2023 const char *CompareToken;
2026 GetTemplateTokenString(Target, TP, 2, &CompareToken, &len);
2027 return strcmp(ChrPtr(TokenText), CompareToken) == 0;
2030 /*-----------------------------------------------------------------------------
2034 void tmpl_do_boxed(StrBuf *Target, WCTemplputParams *TP)
2036 WCTemplputParams SubTP;
2039 if (TP->Tokens->nParameters == 2) {
2040 if (TP->Tokens->Params[1]->Type == TYPE_STR) {
2041 Headline = NewStrBuf();
2042 DoTemplate(TKEY(1), Headline, TP);
2047 GetTemplateTokenString(Target,
2052 Headline = NewStrBufPlain(Ch, len);
2055 memcpy (&SubTP, TP, sizeof(WCTemplputParams));
2056 SubTP.Context = Headline;
2057 SubTP.Filter.ContextType = CTX_STRBUF;
2058 DoTemplate(HKEY("beginbox"), Target, &SubTP);
2059 DoTemplate(TKEY(0), Target, TP);
2060 DoTemplate(HKEY("endbox"), Target, TP);
2061 FreeStrBuf(&Headline);
2064 /*-----------------------------------------------------------------------------
2068 void tmpl_do_tabbed(StrBuf *Target, WCTemplputParams *TP)
2071 int i, ntabs, nTabs;
2073 nTabs = ntabs = TP->Tokens->nParameters / 2;
2074 TabNames = (StrBuf **) malloc(ntabs * sizeof(StrBuf*));
2076 for (i = 0; i < ntabs; i++) {
2077 if ((TP->Tokens->Params[i * 2]->Type == TYPE_STR) &&
2078 (TP->Tokens->Params[i * 2]->len > 0)) {
2079 TabNames[i] = NewStrBuf();
2080 DoTemplate(TKEY(i * 2), TabNames[i], TP);
2082 else if (TP->Tokens->Params[i * 2]->Type == TYPE_GETTEXT) {
2085 GetTemplateTokenString(Target,
2090 TabNames[i] = NewStrBufPlain(Ch, -1);
2093 /** A Tab without subject? we can't count that, add it as silent */
2098 StrTabbedDialog(Target, nTabs, TabNames);
2099 for (i = 0; i < ntabs; i++) {
2100 StrBeginTab(Target, i, nTabs);
2101 DoTemplate(TKEY(i * 2 + 1), Target, TP);
2102 StrEndTab(Target, i, nTabs);
2107 /*-----------------------------------------------------------------------------
2112 void RegisterSortFunc(const char *name, long len,
2113 const char *prepend, long preplen,
2114 CompareFunc Forward,
2115 CompareFunc Reverse,
2116 CompareFunc GroupChange,
2119 SortStruct *NewSort = (SortStruct*) malloc(sizeof(SortStruct));
2120 NewSort->Name = NewStrBufPlain(name, len);
2121 if (prepend != NULL)
2122 NewSort->PrefPrepend = NewStrBufPlain(prepend, preplen);
2124 NewSort->PrefPrepend = NULL;
2125 NewSort->Forward = Forward;
2126 NewSort->Reverse = Reverse;
2127 NewSort->GroupChange = GroupChange;
2128 NewSort->ContextType = ContextType;
2129 Put(SortHash, name, len, NewSort, DestroySortStruct);
2132 CompareFunc RetrieveSort(WCTemplputParams *TP,
2133 const char *OtherPrefix, long OtherPrefixLen,
2134 const char *Default, long ldefault, long DefaultDirection)
2137 const StrBuf *BSort = NULL;
2140 long SortOrder = -1;
2142 if (havebstr("SortBy")) {
2143 BSort = sbstr("SortBy");
2144 if (OtherPrefix == NULL) {
2145 set_room_pref("sort", NewStrBufDup(BSort), 0);
2148 set_X_PREFS(HKEY("sort"), OtherPrefix, OtherPrefixLen, NewStrBufDup(BSort), 0);
2151 else { /** Try to fallback to our remembered values... */
2152 if (OtherPrefix == NULL) {
2153 BSort = get_room_pref("sort");
2156 BSort = get_X_PREFS(HKEY("sort"), OtherPrefix, OtherPrefixLen);
2159 putbstr("SortBy", NewStrBufDup(BSort));
2163 BSort = Buf = NewStrBufPlain(Default, ldefault);
2164 putbstr("SortBy", Buf);
2168 if (!GetHash(SortHash, SKEY(BSort), &vSortBy) ||
2169 (vSortBy == NULL)) {
2171 if (!GetHash(SortHash, Default, ldefault, &vSortBy) ||
2172 (vSortBy == NULL)) {
2174 NULL, "Sorting", ERR_PARM1, TP,
2175 "Illegal default sort: [%s]", Default);
2179 SortBy = (SortStruct*)vSortBy;
2181 /** Ok, its us, lets see in which direction we should sort... */
2182 if (havebstr("SortOrder")) {
2183 SortOrder = LBSTR("SortOrder");
2185 else { /** Try to fallback to our remembered values... */
2187 if (SortBy->PrefPrepend == NULL) {
2188 Buf = get_room_pref("SortOrder");
2189 SortOrder = StrTol(Buf);
2192 BSort = get_X_PREFS(HKEY("SortOrder"), OtherPrefix, OtherPrefixLen);
2196 SortOrder = DefaultDirection;
2198 Buf = NewStrBufPlain(NULL, 64);
2199 StrBufPrintf(Buf, "%ld", SortOrder);
2200 putbstr("SortOrder", Buf);
2202 switch (SortOrder) {
2207 return SortBy->Forward;
2209 return SortBy->Reverse;
2221 ConstStr SortIcons[] = {
2222 {HKEY("static/sort_none.gif")},
2223 {HKEY("static/up_pointer.gif")},
2224 {HKEY("static/down_pointer.gif")},
2227 ConstStr SortNextOrder[] = {
2234 int GetSortMetric(WCTemplputParams *TP, SortStruct **Next, SortStruct **Param, long *SortOrder, int N)
2236 int bSortError = eNOT_SPECIFIED;
2237 const StrBuf *BSort;
2242 if (!GetHash(SortHash, TKEY(0), &vSort) ||
2244 return eNO_SUCH_SORT;
2245 *Param = (SortStruct*) vSort;
2248 if (havebstr("SortBy")) {
2249 BSort = sbstr("SortBy");
2250 bSortError = eINVALID_PARAM;
2251 if ((*Param)->PrefPrepend == NULL) {
2252 set_room_pref("sort", NewStrBufDup(BSort), 0);
2255 set_X_PREFS(HKEY("sort"), TKEY(N), NewStrBufDup(BSort), 0);
2258 else { /** Try to fallback to our remembered values... */
2259 if ((*Param)->PrefPrepend == NULL) {
2260 BSort = get_room_pref("sort");
2263 BSort = get_X_PREFS(HKEY("sort"), TKEY(N));
2267 if (!GetHash(SortHash, SKEY(BSort), &vSort) ||
2271 *Next = (SortStruct*) vSort;
2273 /** Ok, its us, lets see in which direction we should sort... */
2274 if (havebstr("SortOrder")) {
2275 *SortOrder = LBSTR("SortOrder");
2277 else { /** Try to fallback to our remembered values... */
2278 if ((*Param)->PrefPrepend == NULL) {
2279 *SortOrder = StrTol(get_room_pref("SortOrder"));
2282 *SortOrder = StrTol(get_X_PREFS(HKEY("SortOrder"), TKEY(N)));
2292 void tmplput_SORT_ICON(StrBuf *Target, WCTemplputParams *TP)
2297 const ConstStr *SortIcon;
2299 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2302 Target, "Sorter", ERR_PARM1, TP,
2303 " Sorter [%s] unknown!",
2304 TP->Tokens->Params[0]->Start);
2306 case eINVALID_PARAM:
2307 LogTemplateError(NULL, "Sorter", ERR_PARM1, TP,
2308 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2310 case eNOT_SPECIFIED:
2312 if (Next == Param) {
2313 SortIcon = &SortIcons[SortOrder];
2315 else { /** Not Us... */
2316 SortIcon = &SortIcons[0];
2318 StrBufAppendBufPlain(Target, SortIcon->Key, SortIcon->len, 0);
2322 void tmplput_SORT_NEXT(StrBuf *Target, WCTemplputParams *TP)
2328 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2331 Target, "Sorter", ERR_PARM1, TP,
2332 " Sorter [%s] unknown!",
2333 TP->Tokens->Params[0]->Start);
2335 case eINVALID_PARAM:
2337 NULL, "Sorter", ERR_PARM1, TP,
2338 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2340 case eNOT_SPECIFIED:
2342 StrBufAppendBuf(Target, Param->Name, 0);
2347 void tmplput_SORT_ORDER(StrBuf *Target, WCTemplputParams *TP)
2350 const ConstStr *SortOrderStr;
2354 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2357 Target, "Sorter", ERR_PARM1, TP,
2358 " Sorter [%s] unknown!",
2359 TP->Tokens->Params[0]->Start);
2361 case eINVALID_PARAM:
2363 NULL, "Sorter", ERR_PARM1, TP,
2364 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2366 case eNOT_SPECIFIED:
2368 if (Next == Param) {
2369 SortOrderStr = &SortNextOrder[SortOrder];
2371 else { /** Not Us... */
2372 SortOrderStr = &SortNextOrder[0];
2374 StrBufAppendBufPlain(Target, SortOrderStr->Key, SortOrderStr->len, 0);
2379 void tmplput_long_vector(StrBuf *Target, WCTemplputParams *TP)
2381 long *LongVector = (long*) CTX;
2383 if ((TP->Tokens->Params[0]->Type == TYPE_LONG) &&
2384 (TP->Tokens->Params[0]->lvalue <= LongVector[0]))
2386 StrBufAppendPrintf(Target, "%ld", LongVector[TP->Tokens->Params[0]->lvalue]);
2390 if (TP->Tokens->Params[0]->Type != TYPE_LONG) {
2392 Target, "Longvector", ERR_NAME, TP,
2393 "needs a numerical Parameter!");
2397 Target, "LongVector", ERR_PARM1, TP,
2398 "doesn't have %ld Parameters, its just the size of %ld!",
2399 TP->Tokens->Params[0]->lvalue,
2405 void dbg_print_longvector(long *LongVector)
2407 StrBuf *Buf = NewStrBufPlain(HKEY("Longvector: ["));
2408 int nItems = LongVector[0];
2411 for (i = 0; i < nItems; i++) {
2413 StrBufAppendPrintf(Buf, "%d: %ld | ", i, LongVector[i]);
2415 StrBufAppendPrintf(Buf, "%d: %ld]\n", i, LongVector[i]);
2418 lprintf(1, ChrPtr(Buf));
2422 int ConditionalLongVector(StrBuf *Target, WCTemplputParams *TP)
2424 long *LongVector = (long*) CTX;
2426 if ((TP->Tokens->Params[2]->Type == TYPE_LONG) &&
2427 (TP->Tokens->Params[2]->lvalue <= LongVector[0])&&
2428 (TP->Tokens->Params[3]->Type == TYPE_LONG) &&
2429 (TP->Tokens->Params[3]->lvalue <= LongVector[0]))
2431 return LongVector[TP->Tokens->Params[2]->lvalue] ==
2432 LongVector[TP->Tokens->Params[3]->lvalue];
2436 if ((TP->Tokens->Params[2]->Type == TYPE_LONG) ||
2437 (TP->Tokens->Params[2]->Type == TYPE_LONG)) {
2439 Target, "ConditionalLongvector", ERR_PARM1, TP,
2440 "needs two long Parameter!");
2444 Target, "Longvector", ERR_PARM1, TP,
2445 "doesn't have %ld / %ld Parameters, its just the size of %ld!",
2446 TP->Tokens->Params[2]->lvalue,
2447 TP->Tokens->Params[3]->lvalue,
2458 memset(&NoCtx, 0, sizeof(WCTemplputParams));
2459 RegisterNamespace("SORT:ICON", 1, 2, tmplput_SORT_ICON, CTX_NONE);
2460 RegisterNamespace("SORT:ORDER", 1, 2, tmplput_SORT_ORDER, CTX_NONE);
2461 RegisterNamespace("SORT:NEXT", 1, 2, tmplput_SORT_NEXT, CTX_NONE);
2462 RegisterNamespace("CONTEXTSTR", 0, 1, tmplput_ContextString, CTX_STRBUF);
2463 RegisterNamespace("ITERATE", 2, 100, tmpl_iterate_subtmpl, CTX_NONE);
2464 RegisterNamespace("DOBOXED", 1, 2, tmpl_do_boxed, CTX_NONE);
2465 RegisterNamespace("DOTABBED", 2, 100, tmpl_do_tabbed, CTX_NONE);
2466 RegisterNamespace("LONGVECTOR", 1, 1, tmplput_long_vector, CTX_LONGVECTOR);
2467 RegisterConditional(HKEY("COND:SUBST"), 3, ConditionalVar, CTX_NONE);
2468 RegisterConditional(HKEY("COND:CONTEXTSTR"), 3, ConditionalContextStr, CTX_STRBUF);
2469 RegisterConditional(HKEY("COND:LONGVECTOR"), 4, ConditionalLongVector, CTX_LONGVECTOR);
2471 RegisterControlConditional(HKEY("COND:ITERATE:ISGROUPCHANGE"), 2,
2472 conditional_ITERATE_ISGROUPCHANGE,
2474 RegisterControlConditional(HKEY("COND:ITERATE:LASTN"), 2,
2475 conditional_ITERATE_LASTN,
2477 RegisterControlNS(HKEY("ITERATE:ODDEVEN"), 0, 0, tmplput_ITERATE_ODDEVEN, CTX_ITERATE);
2478 RegisterControlNS(HKEY("ITERATE:KEY"), 0, 0, tmplput_ITERATE_KEY, CTX_ITERATE);
2479 RegisterControlNS(HKEY("ITERATE:N"), 0, 0, tmplput_ITERATE_LASTN, CTX_ITERATE);