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
46 typedef struct _WCTemplate {
52 WCTemplateToken **Tokens;
55 typedef struct _HashHandler {
58 WCHandlerFunc HandlerFunc;
61 void *load_template(StrBuf *filename, StrBuf *Key, HashList *PutThere);
62 int EvaluateConditional(StrBuf *Target, int Neg, int state, WCTemplputParams *TP);
66 typedef struct _SortStruct {
71 CompareFunc GroupChange;
76 const char *CtxNames[] = {
99 void DestroySortStruct(void *vSort)
101 SortStruct *Sort = (SortStruct*) vSort;
102 FreeStrBuf(&Sort->Name);
103 FreeStrBuf(&Sort->PrefPrepend);
107 const char *ContextName(int ContextType)
109 if (ContextType < CTX_UNKNOWN)
110 return CtxNames[ContextType];
112 return CtxNames[CTX_UNKNOWN];
115 void LogTemplateError (StrBuf *Target, const char *Type, int ErrorPos, WCTemplputParams *TP, const char *Format, ...)
122 const char *Err = NULL;
127 va_start(arg_ptr, Format);
128 StrBufVAppendPrintf(Error, Format, arg_ptr);
133 case ERR_NAME: /* the main token name... */
134 Err = (TP->Tokens!= NULL)? TP->Tokens->pName:"";
137 Err = (TP->Tokens!= NULL)? TP->Tokens->Params[0]->Start:"";
140 Err = (TP->Tokens!= NULL)? TP->Tokens->Params[1]->Start:"";
143 if (TP->Tokens != NULL)
145 lprintf(1, "%s [%s] (in '%s' line %ld); %s; [%s]\n",
148 ChrPtr(TP->Tokens->FileName),
151 ChrPtr(TP->Tokens->FlatToken));
155 lprintf(1, "%s: %s;\n",
162 Header = NewStrBuf();
163 if (TP->Tokens != NULL)
168 "<pre>\n%s [%s] (in '%s' line %ld); %s\n[%s]\n</pre>\n",
171 ChrPtr(TP->Tokens->FileName),
174 ChrPtr(TP->Tokens->FlatToken));
176 StrBufPrintf(Info, "%s [%s] %s; [%s]",
180 ChrPtr(TP->Tokens->FlatToken));
183 SerializeJson(Header, WildFireException(SKEY(TP->Tokens->FileName),
188 SerializeJson(Header, WildFireMessage(SKEY(TP->Tokens->FileName),
193 WildFireSerializePayload(Header, WCC->HBuf, &WCC->nWildfireHeaders, NULL);
200 "<pre>\n%s: %s\n</pre>\n",
204 StrBufPrintf(Info, "%s [%s] %s; [%s]",
208 ChrPtr(TP->Tokens->FlatToken));
209 SerializeJson(Header, WildFireException(HKEY(__FILE__), __LINE__, Info, 1), 1);
210 WildFireSerializePayload(Header, WCC->HBuf, &WCC->nWildfireHeaders, NULL);
216 if (dbg_bactrace_template_errors)
222 void RegisterNS(const char *NSName,
226 WCHandlerFunc HandlerFunc,
229 HashHandler *NewHandler;
231 NewHandler = (HashHandler*) malloc(sizeof(HashHandler));
232 NewHandler->Filter.nMinArgs = nMinArgs;
233 NewHandler->Filter.nMaxArgs = nMaxArgs;
234 NewHandler->Filter.ContextType = ContextRequired;
235 NewHandler->Filter.ControlContextType = CTX_NONE;
237 NewHandler->HandlerFunc = HandlerFunc;
238 Put(GlobalNS, NSName, len, NewHandler, NULL);
241 void RegisterControlNS(const char *NSName,
245 WCHandlerFunc HandlerFunc,
246 int ControlContextRequired)
248 HashHandler *NewHandler;
250 NewHandler = (HashHandler*) malloc(sizeof(HashHandler));
251 NewHandler->Filter.nMinArgs = nMinArgs;
252 NewHandler->Filter.nMaxArgs = nMaxArgs;
253 NewHandler->Filter.ContextType = CTX_NONE;
254 NewHandler->Filter.ControlContextType = ControlContextRequired;
255 NewHandler->HandlerFunc = HandlerFunc;
256 Put(GlobalNS, NSName, len, NewHandler, NULL);
261 int CheckContext(StrBuf *Target, ContextFilter *Need, WCTemplputParams *TP, const char *ErrType)
263 if ((Need->ContextType != CTX_NONE) &&
264 (Need->ContextType != TP->Filter.ContextType)) {
266 Target, ErrType, ERR_PARM1, TP,
267 " WARNING: requires Context: [%s], have [%s]!",
268 ContextName(Need->ContextType),
269 ContextName(TP->Filter.ContextType));
273 if ((Need->ControlContextType != CTX_NONE) &&
274 (Need->ControlContextType != TP->Filter.ControlContextType)) {
276 Target, ErrType, ERR_PARM1, TP,
277 " WARNING: requires Control Context: [%s], have [%s]!",
278 ContextName(Need->ControlContextType),
279 ContextName(TP->Filter.ControlContextType));
283 if (TP->Tokens->nParameters < Need->nMinArgs) {
284 LogTemplateError(Target, ErrType, ERR_NAME, TP,
285 "needs at least %ld params, have %ld",
287 TP->Tokens->nParameters);
291 else if (TP->Tokens->nParameters > Need->nMaxArgs) {
292 LogTemplateError(Target, ErrType, ERR_NAME, TP,
293 "just needs %ld params, you gave %ld",
295 TP->Tokens->nParameters);
303 void FreeToken(WCTemplateToken **Token)
306 FreeStrBuf(&(*Token)->FlatToken);
307 if ((*Token)->HaveParameters)
308 for (i = 0; i < (*Token)->nParameters; i++)
309 free((*Token)->Params[i]);
316 void FreeWCTemplate(void *vFreeMe)
319 WCTemplate *FreeMe = (WCTemplate*)vFreeMe;
321 if (FreeMe->TokenSpace > 0) {
322 for (i = 0; i < FreeMe->nTokensUsed; i ++) {
323 FreeToken(&FreeMe->Tokens[i]);
325 free(FreeMe->Tokens);
327 FreeStrBuf(&FreeMe->FileName);
328 FreeStrBuf(&FreeMe->Data);
329 FreeStrBuf(&FreeMe->MimeType);
335 * \brief debugging function to print array to log
337 void VarPrintTransition(void *vVar1, void *vVar2, int odd){}
339 * \brief debugging function to print array to log
341 void VarPrintEntry(const char *Key, void *vSubst, int odd)
344 lprintf(1,"Subst[%s] : ", Key);
345 ptr = (wcsubst*) vSubst;
347 switch(ptr->wcs_type) {
349 lprintf(1, " -> %s\n", ChrPtr(ptr->wcs_value));
352 lprintf(1, " -> Server [%s]\n", ChrPtr(ptr->wcs_value));
355 lprintf(1, " -> function at [%0xd]\n", ptr->wcs_function);
358 lprintf(1," WARNING: invalid type: [%ld]!\n", ptr->wcs_type);
365 * \brief Clear out the list of substitution variables local to this session
367 void clear_substs(wcsession *wc) {
369 if (wc->vars != NULL) {
370 DeleteHash(&wc->vars);
375 * \brief Clear out the list of substitution variables local to this session
377 void clear_local_substs(void) {
396 void FlushPayload(wcsubst *ptr, int reusestrbuf, int type)
398 int NeedNew = NeedNewBuf(type);
399 switch(ptr->wcs_type) {
403 if (reusestrbuf && NeedNew) {
404 FlushStrBuf(ptr->wcs_value);
408 FreeStrBuf(&ptr->wcs_value);
409 ptr->wcs_value = NULL;
413 ptr->wcs_function = NULL;
414 if (reusestrbuf && NeedNew)
415 ptr->wcs_value = NewStrBuf();
418 ptr->wcs_value = NULL;
419 if (reusestrbuf && NeedNew)
420 ptr->wcs_value = NewStrBuf();
424 if (reusestrbuf && NeedNew)
425 ptr->wcs_value = NewStrBuf();
428 if (reusestrbuf && NeedNew)
429 ptr->wcs_value = NewStrBuf();
436 * \brief destructor; kill one entry.
438 void deletevar(void *data)
440 wcsubst *ptr = (wcsubst*)data;
441 FlushPayload(ptr, 0, ptr->wcs_type);
446 wcsubst *NewSubstVar(const char *keyname, int keylen, int type)
451 ptr = (wcsubst *) malloc(sizeof(wcsubst));
452 memset(ptr, 0, sizeof(wcsubst));
454 ptr->wcs_type = type;
455 safestrncpy(ptr->wcs_key, keyname, sizeof ptr->wcs_key);
456 Put(WCC->vars, keyname, keylen, ptr, deletevar);
458 switch(ptr->wcs_type) {
461 ptr->wcs_value = NewStrBuf();
475 * \brief Add a substitution variable (local to this session) (strlen version...)
476 * \param keyname the replacementstring to substitute
477 * \param keytype the kind of the key
478 * \param format the format string ala printf
479 * \param ... the arguments to substitute in the formatstring
481 void SVPRINTF(char *keyname, int keytype, const char *format,...)
489 keylen = strlen(keyname);
491 * First look if we're doing a replacement of
494 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
495 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
496 ptr = (wcsubst*)vPtr;
497 FlushPayload(ptr, keytype, keytype);
498 ptr->wcs_type = keytype;
500 else /** Otherwise allocate a new one */
502 ptr = NewSubstVar(keyname, keylen, keytype);
505 /** Format the string */
506 va_start(arg_ptr, format);
507 StrBufVAppendPrintf(ptr->wcs_value, format, arg_ptr);
512 * \brief Add a substitution variable (local to this session)
513 * \param keyname the replacementstring to substitute
514 * \param keytype the kind of the key
515 * \param format the format string ala printf
516 * \param ... the arguments to substitute in the formatstring
518 void svprintf(char *keyname, size_t keylen, int keytype, const char *format,...)
526 * First look if we're doing a replacement of
529 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
530 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
531 ptr = (wcsubst*)vPtr;
532 FlushPayload(ptr, 1, keytype);
533 ptr->wcs_type = keytype;
535 else /** Otherwise allocate a new one */
537 ptr = NewSubstVar(keyname, keylen, keytype);
540 /** Format the string and save it */
541 va_start(arg_ptr, format);
542 StrBufVAppendPrintf(ptr->wcs_value, format, arg_ptr);
547 * \brief Add a substitution variable (local to this session)
548 * \param keyname the replacementstring to substitute
549 * \param keytype the kind of the key
550 * \param format the format string ala printf
551 * \param ... the arguments to substitute in the formatstring
553 void SVPut(char *keyname, size_t keylen, int keytype, char *Data)
561 * First look if we're doing a replacement of
564 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
565 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
566 ptr = (wcsubst*)vPtr;
567 FlushPayload(ptr, 1, keytype);
568 ptr->wcs_type = keytype;
570 else /** Otherwise allocate a new one */
572 ptr = NewSubstVar(keyname, keylen, keytype);
574 StrBufAppendBufPlain(ptr->wcs_value, Data, -1, 0);
578 * \brief Add a substitution variable (local to this session)
579 * \param keyname the replacementstring to substitute
580 * \param keytype the kind of the key
581 * \param format the format string ala printf
582 * \param ... the arguments to substitute in the formatstring
584 void SVPutLong(char *keyname, size_t keylen, long Data)
592 * First look if we're doing a replacement of
595 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
596 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
597 ptr = (wcsubst*)vPtr;
598 FlushPayload(ptr, 1, WCS_LONG);
599 ptr->wcs_type = WCS_LONG;
601 else /** Otherwise allocate a new one */
603 ptr = NewSubstVar(keyname, keylen, WCS_LONG);
609 * \brief Add a substitution variable (local to this session) that does a callback
610 * \param keyname the keystring to substitute
611 * \param fcn_ptr the function callback to give the substitution string
613 void SVCallback(char *keyname, size_t keylen, WCHandlerFunc fcn_ptr)
620 * First look if we're doing a replacement of
623 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
624 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
625 ptr = (wcsubst*)vPtr;
626 FlushPayload(ptr, 1, WCS_FUNCTION);
627 ptr->wcs_type = WCS_FUNCTION;
629 else /** Otherwise allocate a new one */
631 ptr = NewSubstVar(keyname, keylen, WCS_FUNCTION);
634 ptr->wcs_function = fcn_ptr;
636 inline void SVCALLBACK(char *keyname, WCHandlerFunc fcn_ptr)
638 SVCallback(keyname, strlen(keyname), fcn_ptr);
643 void SVPUTBuf(const char *keyname, int keylen, const StrBuf *Buf, int ref)
650 * First look if we're doing a replacement of
653 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
654 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
655 ptr = (wcsubst*)vPtr;
656 FlushPayload(ptr, 0, (ref)?WCS_STRBUF_REF:WCS_STRBUF);
657 ptr->wcs_type = (ref)?WCS_STRBUF_REF:WCS_STRBUF;
659 else /** Otherwise allocate a new one */
661 ptr = NewSubstVar(keyname, keylen, (ref)?WCS_STRBUF_REF:WCS_STRBUF);
663 ptr->wcs_value = (StrBuf*)Buf;
667 * \brief back end for print_value_of() ... does a server command
668 * \param servcmd server command to execute on the citadel server
670 void pvo_do_cmd(StrBuf *Target, StrBuf *servcmd) {
674 serv_puts(ChrPtr(servcmd));
675 len = serv_getln(buf, sizeof buf);
681 StrBufAppendPrintf(Target, "%s\n", &buf[4]);
684 _fmout(Target, "CENTER");
687 StrBufAppendPrintf(Target, "%s\n", &buf[4]);
693 void GetTemplateTokenString(StrBuf *Target,
694 WCTemplputParams *TP,
700 WCTemplputParams SubTP;
702 if (TP->Tokens->nParameters < N) {
703 LogTemplateError(Target,
704 "TokenParameter", N, TP,
705 "invalid token %d. this shouldn't have come till here.\n", N);
711 switch (TP->Tokens->Params[N]->Type) {
714 *Value = TP->Tokens->Params[N]->Start;
715 *len = TP->Tokens->Params[N]->len;
718 Buf = (StrBuf*) SBstr(TKEY(N));
719 *Value = ChrPtr(Buf);
720 *len = StrLength(Buf);
723 get_PREFERENCE(TKEY(N), &Buf);
724 *Value = ChrPtr(Buf);
725 *len = StrLength(Buf);
728 LogTemplateError(Target,
729 "TokenParameter", N, TP,
730 "Requesting parameter %d; of type LONG, want string.", N);
733 LogTemplateError(Target,
734 "TokenParameter", N, TP,
735 "Requesting parameter %d; of type PREFINT, want string.", N);
738 *Value = _(TP->Tokens->Params[N]->Start);
739 *len = strlen(*Value);
741 case TYPE_SUBTEMPLATE:
742 memset(&SubTP, 0, sizeof(WCTemplputParams *));
743 SubTP.Context = TP->Context;
744 SubTP.Filter.ContextType = TP->Filter.ContextType;
746 DoTemplate(TKEY(N), Buf, &SubTP);
747 *Value = ChrPtr(Buf);
748 *len = StrLength(Buf);
749 /* we can't free it here, so we put it into the subst so its discarded later on. */
750 SVPUTBuf(TKEY(N), Buf, 0);
754 LogTemplateError(Target,
755 "TokenParameter", N, TP,
756 "unknown param type %d; [%d]", N, TP->Tokens->Params[N]->Type);
761 long GetTemplateTokenNumber(StrBuf *Target, WCTemplputParams *TP, int N, long dflt)
764 if (TP->Tokens->nParameters < N) {
765 LogTemplateError(Target,
766 "TokenParameter", N, TP,
767 "invalid token %d. this shouldn't have come till here.\n", N);
772 switch (TP->Tokens->Params[N]->Type) {
775 return atol(TP->Tokens->Params[N]->Start);
778 return LBstr(TKEY(N));
781 LogTemplateError(Target,
782 "TokenParameter", N, TP,
783 "requesting a prefstring in param %d want a number", N);
784 if (get_PREF_LONG(TKEY(N), &Ret, dflt))
788 return TP->Tokens->Params[N]->lvalue;
790 if (get_PREF_LONG(TKEY(N), &Ret, dflt))
794 LogTemplateError(Target,
795 "TokenParameter", N, TP,
796 "requesting a I18N string in param %d; want a number", N);
798 case TYPE_SUBTEMPLATE:
799 LogTemplateError(Target,
800 "TokenParameter", N, TP,
801 "requesting a subtemplate in param %d; not supported for numbers", N);
804 LogTemplateError(Target,
805 "TokenParameter", N, TP,
806 "unknown param type %d; [%d]", N, TP->Tokens->Params[N]->Type);
814 * \brief Print the value of a variable
815 * \param keyname get a key to print
817 void print_value_of(StrBuf *Target, WCTemplputParams *TP)
824 /*if (WCC->vars != NULL) PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
825 /* TODO: depricated! */
826 if (TP->Tokens->pName[0] == '=') {
827 DoTemplate(TP->Tokens->pName+1, TP->Tokens->NameEnd - 1, NULL, &NoCtx);
829 /*/////TODO: if param[1] == "U" -> urlescape
831 /** Page-local variables */
832 if ((WCC->vars!= NULL) && GetHash(WCC->vars, TP->Tokens->pName, TP->Tokens->NameEnd, &vVar)) {
833 ptr = (wcsubst*) vVar;
834 switch(ptr->wcs_type) {
836 StrBufAppendBuf(Target, ptr->wcs_value, 0);
839 pvo_do_cmd(Target, ptr->wcs_value);
842 (*ptr->wcs_function) (Target, TP);
846 StrBufAppendBuf(Target, ptr->wcs_value, 0);
849 StrBufAppendPrintf(Target, "%ld", ptr->lvalue);
853 Target, "Subst", ERR_NAME, TP,
854 "WARNING: invalid value in SV-Hash at %s!", TP->Tokens->pName);
859 Target, "Token", ERR_NAME, TP,
860 "didn't find Handler \"%s\"", TP->Tokens->pName);
865 int CompareSubstToToken(TemplateParam *ParamToCompare, TemplateParam *ParamToLookup)
871 if ((WCC->vars!= NULL) && GetHash(WCC->vars, ParamToLookup->Start,
872 ParamToLookup->len, &vVar)) {
873 ptr = (wcsubst*) vVar;
874 switch(ptr->wcs_type) {
878 if (ParamToCompare->Type == TYPE_STR)
879 return ((ParamToCompare->len == StrLength(ptr->wcs_value)) &&
880 (strcmp(ParamToCompare->Start, ChrPtr(ptr->wcs_value)) == 0));
882 return ParamToCompare->lvalue == StrTol(ptr->wcs_value);
890 if (ParamToCompare->Type == TYPE_STR)
893 return ParamToCompare->lvalue == ptr->lvalue;
896 lprintf(1,"WARNING: invalid value in SV-Hash at %s!\n",
897 ParamToLookup->Start);
903 int CompareSubstToStrBuf(StrBuf *Compare, TemplateParam *ParamToLookup)
909 if ((WCC->vars!= NULL) && GetHash(WCC->vars, ParamToLookup->Start,
910 ParamToLookup->len, &vVar)) {
911 ptr = (wcsubst*) vVar;
912 switch(ptr->wcs_type) {
916 return ((StrLength(Compare) == StrLength(ptr->wcs_value)) &&
917 (strcmp(ChrPtr(Compare), ChrPtr(ptr->wcs_value)) == 0));
924 return StrTol(Compare) == ptr->lvalue;
926 lprintf(1,"WARNING: invalid value in SV-Hash at %s!\n",
927 ParamToLookup->Start);
936 * \brief puts string into the template and computes which escape methon we should use
937 * \param Source the string we should put into the template
938 * \param FormatTypeIndex where should we look for escape types if?
940 void StrBufAppendTemplate(StrBuf *Target,
941 WCTemplputParams *TP,
942 const StrBuf *Source, int FormatTypeIndex)
947 if ((FormatTypeIndex < TP->Tokens->nParameters) &&
948 (TP->Tokens->Params[FormatTypeIndex]->Type == TYPE_STR) &&
949 (TP->Tokens->Params[FormatTypeIndex]->len == 1)) {
950 EscapeAs = *TP->Tokens->Params[FormatTypeIndex]->Start;
957 StrEscAppend(Target, Source, NULL, 0, 2);
960 StrEscAppend(Target, Source, NULL, 0, 0);
963 StrECMAEscAppend(Target, Source, NULL);
966 StrBufAppendBuf(Target, Source, 0);
971 void PutNewToken(WCTemplate *Template, WCTemplateToken *NewToken)
973 if (Template->nTokensUsed + 1 >= Template->TokenSpace) {
974 if (Template->TokenSpace <= 0) {
975 Template->Tokens = (WCTemplateToken**)malloc(
976 sizeof(WCTemplateToken*) * 10);
977 Template->TokenSpace = 10;
980 WCTemplateToken **NewTokens;
981 NewTokens= (WCTemplateToken**)malloc(
982 sizeof(WCTemplateToken*) *
983 Template->TokenSpace * 2);
984 memcpy(NewTokens, Template->Tokens,
985 sizeof(WCTemplateToken*) * Template->nTokensUsed);
986 free(Template->Tokens);
987 Template->TokenSpace *= 2;
988 Template->Tokens = NewTokens;
991 Template->Tokens[(Template->nTokensUsed)++] = NewToken;
994 TemplateParam *GetNextParameter(StrBuf *Buf, const char **pCh, const char *pe, WCTemplateToken *Tokens, WCTemplate *pTmpl)
996 const char *pch = *pCh;
997 const char *pchs, *pche;
998 TemplateParam *Parm = (TemplateParam *) malloc(sizeof(TemplateParam));
1002 Parm->Type = TYPE_STR;
1004 /* Skip leading whitespaces */
1005 while ((*pch == ' ' )||
1008 (*pch == '\n')) pch ++;
1011 Parm->Type = TYPE_PREFSTR;
1018 else if (*pch == ';') {
1019 Parm->Type = TYPE_PREFINT;
1026 else if (*pch == '_') {
1027 Parm->Type = TYPE_GETTEXT;
1034 else if (*pch == 'B') {
1035 Parm->Type = TYPE_BSTR;
1042 else if (*pch == '=') {
1043 Parm->Type = TYPE_SUBTEMPLATE;
1054 else if (*pch == '\'')
1056 if (quote != '\0') {
1061 ( (pch > pchs) && (*(pch - 1) == '\\'))
1066 if (*pch != quote) {
1067 lprintf(1, "Error (in '%s' line %ld); "
1068 "evaluating template param [%s] in Token [%s]\n",
1069 ChrPtr(pTmpl->FileName),
1071 ChrPtr(Tokens->FlatToken),
1078 StrBufPeek(Buf, pch, -1, '\0');
1079 if (LoadTemplates > 1) {
1080 lprintf(1, "DBG: got param [%s] %ld %ld\n",
1081 pchs, pche - pchs, strlen(pchs));
1084 Parm->len = pche - pchs;
1085 pch ++; /* move after trailing quote */
1086 if (ParamBrace && (*pch == ')')) {
1093 Parm->Type = TYPE_LONG;
1095 while ((pch <= pe) &&
1101 if (pch - pchs > 1){
1102 StrBufPeek(Buf, pch, -1, '\0');
1103 Parm->lvalue = atol(pchs);
1110 lprintf(1, "Error (in '%s' line %ld); "
1111 "evaluating long template param [%s] in Token [%s]\n",
1112 ChrPtr(pTmpl->FileName),
1114 ChrPtr(Tokens->FlatToken),
1121 while ((*pch == ' ' )||
1125 (*pch == '\n')) pch ++;
1131 WCTemplateToken *NewTemplateSubstitute(StrBuf *Buf,
1133 const char *pTmplStart,
1134 const char *pTmplEnd,
1140 TemplateParam *Param;
1141 WCTemplateToken *NewToken = (WCTemplateToken*)malloc(sizeof(WCTemplateToken));
1142 WCTemplputParams TP;
1144 TP.Tokens = NewToken;
1145 NewToken->FileName = pTmpl->FileName; /* to print meaningfull log messages... */
1146 NewToken->Flags = 0;
1147 NewToken->Line = Line + 1;
1148 NewToken->pTokenStart = pTmplStart;
1149 NewToken->TokenStart = pTmplStart - pStart;
1150 NewToken->TokenEnd = (pTmplEnd - pStart) - NewToken->TokenStart;
1151 NewToken->pTokenEnd = pTmplEnd;
1152 NewToken->NameEnd = NewToken->TokenEnd - 2;
1153 NewToken->PreEval = NULL;
1154 NewToken->FlatToken = NewStrBufPlain(pTmplStart + 2, pTmplEnd - pTmplStart - 2);
1156 StrBufPeek(Buf, pTmplStart, + 1, '\0');
1157 StrBufPeek(Buf, pTmplEnd, -1, '\0');
1158 pch = NewToken->pName = pTmplStart + 2;
1160 NewToken->HaveParameters = 0;;
1161 NewToken->nParameters = 0;
1163 while (pch < pTmplEnd - 1) {
1165 StrBufPeek(Buf, pch, -1, '\0');
1166 NewToken->NameEnd = pch - NewToken->pName;
1168 if (*(pTmplEnd - 1) != ')') {
1170 NULL, "Parseerror", ERR_NAME, &TP,
1171 "Warning, Non welformed Token; missing right parenthesis");
1173 while (pch < pTmplEnd - 1) {
1174 Param = GetNextParameter(Buf, &pch, pTmplEnd - 1, NewToken, pTmpl);
1175 if (Param != NULL) {
1176 NewToken->HaveParameters = 1;
1177 if (NewToken->nParameters > MAXPARAM) {
1179 NULL, "Parseerror", ERR_NAME, &TP,
1180 "only [%d] Params allowed in Tokens",
1184 FreeToken(&NewToken);
1187 NewToken->Params[NewToken->nParameters++] = Param;
1191 if((NewToken->NameEnd == 1) &&
1192 (NewToken->HaveParameters == 1))
1195 if (*(NewToken->pName) == '_')
1196 NewToken->Flags = SV_GETTEXT;
1197 else if (*(NewToken->pName) == '=')
1198 NewToken->Flags = SV_SUBTEMPL;
1199 else if (*(NewToken->pName) == '%')
1200 NewToken->Flags = SV_CUST_STR_CONDITIONAL;
1201 else if (*(NewToken->pName) == '?')
1202 NewToken->Flags = SV_CONDITIONAL;
1203 else if (*(NewToken->pName) == '!')
1204 NewToken->Flags = SV_NEG_CONDITIONAL;
1210 switch (NewToken->Flags) {
1212 /* If we're able to find out more about the token, do it now while its fresh. */
1213 if (GetHash(GlobalNS, NewToken->pName, NewToken->NameEnd, &vVar)) {
1214 HashHandler *Handler;
1215 Handler = (HashHandler*) vVar;
1216 if ((NewToken->nParameters < Handler->Filter.nMinArgs) ||
1217 (NewToken->nParameters > Handler->Filter.nMaxArgs)) {
1219 NULL, "Token", ERR_NAME, &TP,
1220 "doesn't work with %d params",
1221 NewToken->nParameters);
1225 NewToken->PreEval = Handler;
1226 NewToken->Flags = SV_PREEVALUATED;
1231 if (NewToken->nParameters !=1) {
1233 NULL, "Gettext", ERR_NAME, &TP,
1234 "requires exactly 1 parameter, you gave %d params",
1235 NewToken->nParameters);
1236 NewToken->Flags = 0;
1241 if (NewToken->nParameters != 1) {
1243 NULL, "Subtemplates", ERR_NAME, &TP,
1244 "require exactly 1 parameter, you gave %d params",
1245 NewToken->nParameters);
1249 case SV_CUST_STR_CONDITIONAL:
1250 case SV_CONDITIONAL:
1251 case SV_NEG_CONDITIONAL:
1252 if (NewToken->nParameters <2) {
1254 NULL, "Conditional", ERR_NAME, &TP,
1255 "require at least 2 parameters, you gave %d params",
1256 NewToken->nParameters);
1257 NewToken->Flags = 0;
1260 if (NewToken->Params[1]->lvalue == 0) {
1262 NULL, "Conditional", ERR_NAME, &TP,
1263 "Conditional ID (Parameter 1) mustn't be 0!");
1264 NewToken->Flags = 0;
1267 if (!GetHash(Conditionals,
1268 NewToken->Params[0]->Start,
1269 NewToken->Params[0]->len,
1272 if ((NewToken->Params[0]->len == 1) &&
1273 (NewToken->Params[0]->Start[0] == 'X'))
1276 NULL, "Conditional", ERR_NAME, &TP,
1279 NewToken->Error = NewStrBuf();
1282 "<pre>\nConditional [%s] (in '%s' line %ld); Not found!\n[%s]\n</pre>\n",
1283 NewToken->Params[0]->Start,
1284 ChrPtr(pTmpl->FileName),
1286 ChrPtr(NewToken->FlatToken));
1290 NewToken->PreEval = vVar;
1302 * \brief Display a variable-substituted template
1303 * \param templatename template file to load
1305 void *prepare_template(StrBuf *filename, StrBuf *Key, HashList *PutThere)
1307 WCTemplate *NewTemplate;
1308 NewTemplate = (WCTemplate *) malloc(sizeof(WCTemplate));
1309 NewTemplate->Data = NULL;
1310 NewTemplate->FileName = NewStrBufDup(filename);
1311 NewTemplate->nTokensUsed = 0;
1312 NewTemplate->TokenSpace = 0;
1313 NewTemplate->Tokens = NULL;
1314 NewTemplate->MimeType = NewStrBufPlain(GuessMimeByFilename (SKEY(NewTemplate->FileName)), -1);
1315 if (strstr(ChrPtr(NewTemplate->MimeType), "text") != NULL) {
1316 StrBufAppendBufPlain(NewTemplate->MimeType, HKEY("; charset=utf-8"), 0);
1319 Put(PutThere, ChrPtr(Key), StrLength(Key), NewTemplate, FreeWCTemplate);
1324 * \brief Display a variable-substituted template
1325 * \param templatename template file to load
1327 void *load_template(StrBuf *filename, StrBuf *Key, HashList *PutThere)
1330 struct stat statbuf;
1331 const char *pS, *pE, *pch, *Err;
1334 WCTemplate *NewTemplate;
1336 fd = open(ChrPtr(filename), O_RDONLY);
1338 lprintf(1, "ERROR: could not open template '%s' - %s\n",
1339 ChrPtr(filename), strerror(errno));
1343 if (fstat(fd, &statbuf) == -1) {
1344 lprintf(1, "ERROR: could not stat template '%s' - %s\n",
1345 ChrPtr(filename), strerror(errno));
1349 NewTemplate = (WCTemplate *) malloc(sizeof(WCTemplate));
1350 NewTemplate->Data = NewStrBufPlain(NULL, statbuf.st_size);
1351 NewTemplate->FileName = NewStrBufDup(filename);
1352 NewTemplate->nTokensUsed = 0;
1353 NewTemplate->TokenSpace = 0;
1354 NewTemplate->Tokens = NULL;
1355 NewTemplate->MimeType = NewStrBufPlain(GuessMimeByFilename (SKEY(NewTemplate->FileName)), -1);
1356 if (strstr(ChrPtr(NewTemplate->MimeType), "text") != NULL) {
1357 StrBufAppendBufPlain(NewTemplate->MimeType, HKEY("; charset=utf-8"), 0);
1360 if (StrBufReadBLOB(NewTemplate->Data, &fd, 1, statbuf.st_size, &Err) < 0) {
1362 FreeWCTemplate(NewTemplate);
1363 lprintf(1, "ERROR: reading template '%s' - %s<br />\n",
1364 ChrPtr(filename), strerror(errno));
1370 pS = pch = ChrPtr(NewTemplate->Data);
1371 pE = pS + StrLength(NewTemplate->Data);
1373 const char *pts, *pte;
1375 int InDoubleQuotes = 0;
1377 /** Find one <? > */
1379 for (; pch < pE; pch ++) {
1380 if ((*pch=='<')&&(*(pch + 1)=='?'))
1382 if (*pch=='\n') Line ++;
1388 /** Found one? parse it. */
1389 for (; pch <= pE - 1; pch ++) {
1391 InDoubleQuotes = ! InDoubleQuotes;
1392 else if (*pch == '\'')
1393 InQuotes = ! InQuotes;
1394 else if ((!InQuotes && !InDoubleQuotes) &&
1395 ((*pch!='\\')&&(*(pch + 1)=='>'))) {
1403 PutNewToken(NewTemplate,
1404 NewTemplateSubstitute(NewTemplate->Data, pS, pts, pte, Line, NewTemplate));
1407 if (LoadTemplates == 0)
1408 Put(PutThere, ChrPtr(Key), StrLength(Key), NewTemplate, FreeWCTemplate);
1413 const char* PrintTemplate(void *vSubst)
1415 WCTemplate *Tmpl = vSubst;
1417 return ChrPtr(Tmpl->FileName);
1421 int LoadTemplateDir(const char *DirName, HashList *wireless, HashList *big)
1426 DIR *filedir = NULL;
1427 struct dirent *filedir_entry;
1433 StrBufPrintf(Dir, "%s/t", DirName);
1434 filedir = opendir (ChrPtr(Dir));
1435 if (filedir == NULL) {
1440 FileName = NewStrBuf();
1442 while ((filedir_entry = readdir(filedir)))
1446 #ifdef _DIRENT_HAVE_D_NAMELEN
1447 d_namelen = filedir_entry->d_namelen;
1449 d_namelen = strlen(filedir_entry->d_name);
1451 d_without_ext = d_namelen;
1452 while ((d_without_ext > 0) && (filedir_entry->d_name[d_without_ext] != '.'))
1454 if ((d_without_ext == 0) || (d_namelen < 3))
1456 if ((d_namelen > 1) && filedir_entry->d_name[d_namelen - 1] == '~')
1457 continue; /* Ignore backup files... */
1459 IsMobile = (strstr(filedir_entry->d_name, ".m.html")!= NULL);
1460 PStart = filedir_entry->d_name;
1461 StrBufPrintf(FileName, "%s/%s", ChrPtr(Dir), filedir_entry->d_name);
1462 MinorPtr = strchr(filedir_entry->d_name, '.');
1463 if (MinorPtr != NULL)
1465 StrBufPlain(Tag, filedir_entry->d_name, MinorPtr - filedir_entry->d_name);
1467 if (LoadTemplates > 1)
1468 lprintf(1, "%s %d %s\n",ChrPtr(FileName), IsMobile, ChrPtr(Tag));
1469 if (LoadTemplates == 0)
1470 load_template(FileName, Tag, (IsMobile)?wireless:big);
1472 prepare_template(FileName, Tag, (IsMobile)?wireless:big);
1475 FreeStrBuf(&FileName);
1481 void InitTemplateCache(void)
1483 LoadTemplateDir(static_dirs[0],
1484 WirelessTemplateCache,
1486 LoadTemplateDir(static_dirs[1],
1487 WirelessLocalTemplateCache,
1488 LocalTemplateCache);
1493 /*-----------------------------------------------------------------------------
1494 * Filling & processing Templates
1497 * \brief executes one token
1498 * \param Target buffer to append to
1499 * \param Token da to process.
1500 * \param Template we're iterating
1501 * \param Context Contextpoointer to pass in
1502 * \param state are we in conditional state?
1503 * \param ContextType what type of information does context giv us?
1505 int EvaluateToken(StrBuf *Target, int state, WCTemplputParams *TP)
1507 const char *AppendMe;
1509 HashHandler *Handler;
1512 /* much output, since pName is not terminated...
1513 lprintf(1,"Doing token: %s\n",Token->pName);
1516 switch (TP->Tokens->Flags) {
1518 TmplGettext(Target, TP);
1520 case SV_CONDITIONAL: /** Forward conditional evaluation */
1521 return EvaluateConditional(Target, 1, state, TP);
1523 case SV_NEG_CONDITIONAL: /** Reverse conditional evaluation */
1524 return EvaluateConditional(Target, 0, state, TP);
1526 case SV_CUST_STR_CONDITIONAL: /** Conditional put custom strings from params */
1527 if (TP->Tokens->nParameters >= 6) {
1528 if (EvaluateConditional(Target, 0, state, TP)) {
1529 GetTemplateTokenString(Target, TP, 5, &AppendMe, &AppendMeLen);
1530 StrBufAppendBufPlain(Target,
1536 GetTemplateTokenString(Target, TP, 4, &AppendMe, &AppendMeLen);
1537 StrBufAppendBufPlain(Target,
1545 Target, "Conditional", ERR_NAME, TP,
1546 "needs at least 6 Params!");
1550 if (TP->Tokens->nParameters == 1)
1551 DoTemplate(TKEY(0), Target, TP);
1553 case SV_PREEVALUATED:
1554 Handler = (HashHandler*) TP->Tokens->PreEval;
1555 if (!CheckContext(Target, &Handler->Filter, TP, "Token")) {
1558 Handler->HandlerFunc(Target, TP);
1561 if (GetHash(GlobalNS, TP->Tokens->pName, TP->Tokens->NameEnd, &vVar)) {
1562 Handler = (HashHandler*) vVar;
1563 if (!CheckContext(Target, &Handler->Filter, TP, "Token")) {
1567 Handler->HandlerFunc(Target, TP);
1571 print_value_of(Target, TP);
1579 const StrBuf *ProcessTemplate(WCTemplate *Tmpl, StrBuf *Target, WCTemplputParams *CallingTP)
1581 WCTemplate *pTmpl = Tmpl;
1584 const char *pData, *pS;
1586 WCTemplputParams TP;
1588 memcpy(&TP.Filter, &CallingTP->Filter, sizeof(ContextFilter));
1590 TP.Context = CallingTP->Context;
1591 TP.ControlContext = CallingTP->ControlContext;
1593 if (LoadTemplates != 0) {
1594 if (LoadTemplates > 1)
1595 lprintf(1, "DBG: ----- loading: [%s] ------ \n",
1596 ChrPtr(Tmpl->FileName));
1598 pTmpl = load_template(Tmpl->FileName, NULL, NULL);
1602 "<pre>\nError loading Template [%s]\n See Logfile for details\n</pre>\n",
1603 ChrPtr(Tmpl->FileName));
1609 pS = pData = ChrPtr(pTmpl->Data);
1610 len = StrLength(pTmpl->Data);
1614 if (i >= pTmpl->nTokensUsed) {
1615 StrBufAppendBufPlain(Target,
1617 len - (pData - pS), 0);
1621 StrBufAppendBufPlain(
1623 pTmpl->Tokens[i]->pTokenStart - pData, 0);
1624 TP.Tokens = pTmpl->Tokens[i];
1625 TP.nArgs = pTmpl->Tokens[i]->nParameters;
1626 state = EvaluateToken(Target, state, &TP);
1628 while ((state != 0) && (i+1 < pTmpl->nTokensUsed)) {
1629 /* condition told us to skip till its end condition */
1631 TP.Tokens = pTmpl->Tokens[i];
1632 TP.nArgs = pTmpl->Tokens[i]->nParameters;
1633 if ((pTmpl->Tokens[i]->Flags == SV_CONDITIONAL) ||
1634 (pTmpl->Tokens[i]->Flags == SV_NEG_CONDITIONAL)) {
1635 if (state == EvaluateConditional(
1637 pTmpl->Tokens[i]->Flags,
1643 pData = pTmpl->Tokens[i++]->pTokenEnd + 1;
1644 if (i > pTmpl->nTokensUsed)
1648 if (LoadTemplates != 0) {
1649 FreeWCTemplate(pTmpl);
1651 return Tmpl->MimeType;
1656 * \brief Display a variable-substituted template
1657 * \param templatename template file to load
1658 * \returns the mimetype of the template its doing
1660 const StrBuf *DoTemplate(const char *templatename, long len, StrBuf *Target, WCTemplputParams *TP)
1662 WCTemplputParams LocalTP;
1664 HashList *StaticLocal;
1670 memset(&LocalTP, 0, sizeof(WCTemplputParams));
1674 if (WC->is_mobile) {
1675 Static = WirelessTemplateCache;
1676 StaticLocal = WirelessLocalTemplateCache;
1679 Static = TemplateCache;
1680 StaticLocal = LocalTemplateCache;
1685 lprintf (1, "Can't to load a template with empty name!\n");
1686 StrBufAppendPrintf(Target, "<pre>\nCan't to load a template with empty name!\n</pre>");
1690 if (!GetHash(StaticLocal, templatename, len, &vTmpl) &&
1691 !GetHash(Static, templatename, len, &vTmpl)) {
1692 lprintf (1, "didn't find Template [%s] %ld %ld\n", templatename, len , (long)strlen(templatename));
1693 StrBufAppendPrintf(Target, "<pre>\ndidn't find Template [%s] %ld %ld\n</pre>",
1695 (long)strlen(templatename));
1697 dbg_PrintHash(Static, PrintTemplate, NULL);
1698 PrintHash(Static, VarPrintTransition, PrintTemplate);
1704 return ProcessTemplate(vTmpl, Target, TP);
1708 /*-----------------------------------------------------------------------------
1711 typedef struct _HashIterator {
1712 HashList *StaticList;
1713 int AdditionalParams;
1715 int XPectContextType;
1717 RetrieveHashlistFunc GetHash;
1718 HashDestructorFunc Destructor;
1719 SubTemplFunc DoSubTemplate;
1722 void RegisterITERATOR(const char *Name, long len,
1723 int AdditionalParams,
1724 HashList *StaticList,
1725 RetrieveHashlistFunc GetHash,
1726 SubTemplFunc DoSubTempl,
1727 HashDestructorFunc Destructor,
1729 int XPectContextType,
1732 HashIterator *It = (HashIterator*)malloc(sizeof(HashIterator));
1733 It->StaticList = StaticList;
1734 It->AdditionalParams = AdditionalParams;
1735 It->GetHash = GetHash;
1736 It->DoSubTemplate = DoSubTempl;
1737 It->Destructor = Destructor;
1738 It->ContextType = ContextType;
1739 It->XPectContextType = XPectContextType;
1741 Put(Iterators, Name, len, It, NULL);
1744 typedef struct _iteratestruct {
1753 void tmpl_iterate_subtmpl(StrBuf *Target, WCTemplputParams *TP)
1759 SortStruct *SortBy = NULL;
1761 int DetectGroupChange = 0;
1764 void *vLastContext = NULL;
1766 WCTemplputParams SubTP;
1767 IterateStruct Status;
1773 memset(&Status, 0, sizeof(IterateStruct));
1774 memcpy (&SubTP, &TP, sizeof(WCTemplputParams));
1776 if (!GetHash(Iterators, TKEY(0), &vIt)) {
1778 Target, "Iterator", ERR_PARM1, TP, "Unknown!");
1782 It = (HashIterator*) vIt;
1784 if (TP->Tokens->nParameters < It->AdditionalParams + 2) {
1786 Target, "Iterator", ERR_PARM1, TP,
1787 "doesn't work with %d params",
1788 TP->Tokens->nParameters);
1792 if ((It->XPectContextType != CTX_NONE) &&
1793 (It->XPectContextType != TP->Filter.ContextType)) {
1795 Target, "Iterator", ERR_PARM1, TP,
1796 "requires context of type %d, have %d",
1797 It->XPectContextType,
1798 TP->Filter.ContextType);
1803 if (It->StaticList == NULL)
1804 List = It->GetHash(Target, TP);
1806 List = It->StaticList;
1808 DetectGroupChange = (It->Flags & IT_FLAG_DETECT_GROUPCHANGE) != 0;
1809 if (DetectGroupChange) {
1810 const StrBuf *BSort;
1811 DetectGroupChange = 0;
1812 if (havebstr("SortBy")) {
1813 BSort = sbstr("SortBy");
1814 if (GetHash(SortHash, SKEY(BSort), &vSortBy) &&
1815 (vSortBy != NULL)) {
1816 SortBy = (SortStruct*)vSortBy;
1817 /** Ok, its us, lets see in which direction we should sort... */
1818 if (havebstr("SortOrder")) {
1820 SortOrder = LBSTR("SortOrder");
1822 DetectGroupChange = 1;
1827 nMembersUsed = GetCount(List);
1828 SubBuf = NewStrBuf();
1829 SubTP.Filter.ContextType = It->ContextType;
1830 SubTP.Filter.ControlContextType = CTX_ITERATE;
1831 SubTP.ControlContext = &Status;
1833 if (HAVE_PARAM(2)) {
1834 StartAt = GetTemplateTokenNumber(Target, TP, 2, 0);
1836 if (HAVE_PARAM(3)) {
1837 StepWidth = GetTemplateTokenNumber(Target, TP, 3, 0);
1839 if (HAVE_PARAM(4)) {
1840 StopAt = GetTemplateTokenNumber(Target, TP, 4, -1);
1842 it = GetNewHashPos(List, StepWidth);
1844 StopAt = GetCount(List);
1846 while (GetNextHashPos(List, it, &Status.KeyLen, &Status.Key, &vContext)) {
1847 if ((Status.n >= StartAt) && (Status.n <= StopAt)) {
1848 if (DetectGroupChange && Status.n > 0) {
1849 Status.GroupChange = (SortBy->GroupChange(vContext, vLastContext))? 1:0;
1851 Status.LastN = (Status.n + 1) == nMembersUsed;
1852 SubTP.Context = vContext;
1853 if (It->DoSubTemplate != NULL)
1854 It->DoSubTemplate(SubBuf, &SubTP);
1855 DoTemplate(TKEY(1), SubBuf, &SubTP);
1857 StrBufAppendBuf(Target, SubBuf, 0);
1858 FlushStrBuf(SubBuf);
1859 Status.oddeven = ! Status.oddeven;
1860 vLastContext = vContext;
1864 FreeStrBuf(&SubBuf);
1866 if (It->Destructor != NULL)
1867 It->Destructor(&List);
1871 int conditional_ITERATE_ISGROUPCHANGE(StrBuf *Target, WCTemplputParams *TP)
1873 IterateStruct *Ctx = CCTX;
1874 return Ctx->GroupChange;
1877 void tmplput_ITERATE_ODDEVEN(StrBuf *Target, WCTemplputParams *TP)
1879 IterateStruct *Ctx = CCTX;
1881 StrBufAppendBufPlain(Target, HKEY("odd"), 0);
1883 StrBufAppendBufPlain(Target, HKEY("even"), 0);
1887 void tmplput_ITERATE_KEY(StrBuf *Target, WCTemplputParams *TP)
1889 IterateStruct *Ctx = CCTX;
1891 StrBufAppendBufPlain(Target, Ctx->Key, Ctx->KeyLen, 0);
1895 void tmplput_ITERATE_LASTN(StrBuf *Target, WCTemplputParams *TP)
1897 IterateStruct *Ctx = CCTX;
1898 StrBufAppendPrintf(Target, "%d", Ctx->n);
1901 int conditional_ITERATE_LASTN(StrBuf *Target, WCTemplputParams *TP)
1903 IterateStruct *Ctx = CCTX;
1909 /*-----------------------------------------------------------------------------
1912 int EvaluateConditional(StrBuf *Target, int Neg, int state, WCTemplputParams *TP)
1914 ConditionalStruct *Cond;
1916 if ((TP->Tokens->Params[0]->len == 1) &&
1917 (TP->Tokens->Params[0]->Start[0] == 'X'))
1918 return (state != 0)?TP->Tokens->Params[1]->lvalue:0;
1920 Cond = (ConditionalStruct *) TP->Tokens->PreEval;
1923 Target, "Conditional", ERR_PARM1, TP,
1928 if (!CheckContext(Target, &Cond->Filter, TP, "Conditional")) {
1932 if (Cond->CondF(Target, TP) == Neg)
1933 return TP->Tokens->Params[1]->lvalue;
1937 int ConditionalVar(StrBuf *Target, WCTemplputParams *TP)
1942 if (!GetHash(WC->vars, TKEY(2), &vsubst))
1944 subst = (wcsubst*) vsubst;
1946 switch(subst->wcs_type) {
1948 return (subst->wcs_function!=NULL);
1950 lprintf(1, " -> Server [%s]\n", subst->wcs_value);/* TODO */
1954 case WCS_STRBUF_REF:
1955 if (TP->Tokens->nParameters < 4)
1957 return (strcmp(TP->Tokens->Params[3]->Start, ChrPtr(subst->wcs_value)) == 0);
1959 if (TP->Tokens->nParameters < 4)
1960 return (subst->lvalue != 0);
1961 return (subst->lvalue == TP->Tokens->Params[3]->lvalue);
1963 lprintf(1," WARNING: invalid type: [%ld]!\n", subst->wcs_type);
1969 void RegisterConditional(const char *Name, long len,
1971 WCConditionalFunc CondF,
1972 int ContextRequired)
1974 ConditionalStruct *Cond = (ConditionalStruct*)malloc(sizeof(ConditionalStruct));
1975 Cond->PlainName = Name;
1976 Cond->Filter.nMaxArgs = nParams;
1977 Cond->Filter.nMinArgs = nParams;
1978 Cond->CondF = CondF;
1979 Cond->Filter.ContextType = ContextRequired;
1980 Cond->Filter.ControlContextType = CTX_NONE;
1981 Put(Conditionals, Name, len, Cond, NULL);
1984 void RegisterControlConditional(const char *Name, long len,
1986 WCConditionalFunc CondF,
1987 int ControlContextRequired)
1989 ConditionalStruct *Cond = (ConditionalStruct*)malloc(sizeof(ConditionalStruct));
1990 Cond->PlainName = Name;
1991 Cond->Filter.nMaxArgs = nParams;
1992 Cond->Filter.nMinArgs = nParams;
1993 Cond->CondF = CondF;
1994 Cond->Filter.ContextType = CTX_NONE;
1995 Cond->Filter.ControlContextType = ControlContextRequired;
1996 Put(Conditionals, Name, len, Cond, NULL);
1999 /*-----------------------------------------------------------------------------
2002 void tmplput_ContextString(StrBuf *Target, WCTemplputParams *TP)
2004 StrBufAppendTemplate(Target, TP, (StrBuf*)CTX, 0);
2006 int ConditionalContextStr(StrBuf *Target, WCTemplputParams *TP)
2008 StrBuf *TokenText = (StrBuf*) CTX;
2009 const char *CompareToken;
2012 GetTemplateTokenString(Target, TP, 2, &CompareToken, &len);
2013 return strcmp(ChrPtr(TokenText), CompareToken) == 0;
2016 /*-----------------------------------------------------------------------------
2020 void tmpl_do_boxed(StrBuf *Target, WCTemplputParams *TP)
2022 WCTemplputParams SubTP;
2025 if (TP->Tokens->nParameters == 2) {
2026 if (TP->Tokens->Params[1]->Type == TYPE_STR) {
2027 Headline = NewStrBuf();
2028 DoTemplate(TKEY(1), Headline, TP);
2033 GetTemplateTokenString(Target,
2038 Headline = NewStrBufPlain(Ch, len);
2041 memcpy (&SubTP, TP, sizeof(WCTemplputParams));
2042 SubTP.Context = Headline;
2043 SubTP.Filter.ContextType = CTX_STRBUF;
2044 DoTemplate(HKEY("beginbox"), Target, &SubTP);
2045 DoTemplate(TKEY(0), Target, TP);
2046 DoTemplate(HKEY("endbox"), Target, TP);
2047 FreeStrBuf(&Headline);
2050 /*-----------------------------------------------------------------------------
2054 void tmpl_do_tabbed(StrBuf *Target, WCTemplputParams *TP)
2057 int i, ntabs, nTabs;
2059 nTabs = ntabs = TP->Tokens->nParameters / 2;
2060 TabNames = (StrBuf **) malloc(ntabs * sizeof(StrBuf*));
2062 for (i = 0; i < ntabs; i++) {
2063 if ((TP->Tokens->Params[i * 2]->Type == TYPE_STR) &&
2064 (TP->Tokens->Params[i * 2]->len > 0)) {
2065 TabNames[i] = NewStrBuf();
2066 DoTemplate(TKEY(i * 2), TabNames[i], TP);
2068 else if (TP->Tokens->Params[i * 2]->Type == TYPE_GETTEXT) {
2071 GetTemplateTokenString(Target,
2076 TabNames[i] = NewStrBufPlain(Ch, -1);
2079 /** A Tab without subject? we can't count that, add it as silent */
2084 StrTabbedDialog(Target, nTabs, TabNames);
2085 for (i = 0; i < ntabs; i++) {
2086 StrBeginTab(Target, i, nTabs);
2087 DoTemplate(TKEY(i * 2 + 1), Target, TP);
2088 StrEndTab(Target, i, nTabs);
2093 /*-----------------------------------------------------------------------------
2098 void RegisterSortFunc(const char *name, long len,
2099 const char *prepend, long preplen,
2100 CompareFunc Forward,
2101 CompareFunc Reverse,
2102 CompareFunc GroupChange,
2105 SortStruct *NewSort = (SortStruct*) malloc(sizeof(SortStruct));
2106 NewSort->Name = NewStrBufPlain(name, len);
2107 if (prepend != NULL)
2108 NewSort->PrefPrepend = NewStrBufPlain(prepend, preplen);
2110 NewSort->PrefPrepend = NULL;
2111 NewSort->Forward = Forward;
2112 NewSort->Reverse = Reverse;
2113 NewSort->GroupChange = GroupChange;
2114 NewSort->ContextType = ContextType;
2115 Put(SortHash, name, len, NewSort, DestroySortStruct);
2118 CompareFunc RetrieveSort(WCTemplputParams *TP,
2119 const char *OtherPrefix, long OtherPrefixLen,
2120 const char *Default, long ldefault, long DefaultDirection)
2123 const StrBuf *BSort = NULL;
2126 long SortOrder = -1;
2128 if (havebstr("SortBy")) {
2129 BSort = sbstr("SortBy");
2130 if (OtherPrefix == NULL) {
2131 set_room_pref("sort", NewStrBufDup(BSort), 0);
2134 set_X_PREFS(HKEY("sort"), OtherPrefix, OtherPrefixLen, NewStrBufDup(BSort), 0);
2137 else { /** Try to fallback to our remembered values... */
2138 if (OtherPrefix == NULL) {
2139 BSort = get_room_pref("sort");
2142 BSort = get_X_PREFS(HKEY("sort"), OtherPrefix, OtherPrefixLen);
2145 putbstr("SortBy", NewStrBufDup(BSort));
2149 BSort = Buf = NewStrBufPlain(Default, ldefault);
2150 putbstr("SortBy", Buf);
2154 if (!GetHash(SortHash, SKEY(BSort), &vSortBy) ||
2155 (vSortBy == NULL)) {
2157 if (!GetHash(SortHash, Default, ldefault, &vSortBy) ||
2158 (vSortBy == NULL)) {
2160 NULL, "Sorting", ERR_PARM1, TP,
2161 "Illegal default sort: [%s]", Default);
2165 SortBy = (SortStruct*)vSortBy;
2167 /** Ok, its us, lets see in which direction we should sort... */
2168 if (havebstr("SortOrder")) {
2169 SortOrder = LBSTR("SortOrder");
2171 else { /** Try to fallback to our remembered values... */
2173 if (SortBy->PrefPrepend == NULL) {
2174 Buf = get_room_pref("SortOrder");
2175 SortOrder = StrTol(Buf);
2178 BSort = get_X_PREFS(HKEY("SortOrder"), OtherPrefix, OtherPrefixLen);
2182 SortOrder = DefaultDirection;
2184 Buf = NewStrBufPlain(NULL, 64);
2185 StrBufPrintf(Buf, "%ld", SortOrder);
2186 putbstr("SortOrder", Buf);
2188 switch (SortOrder) {
2193 return SortBy->Forward;
2195 return SortBy->Reverse;
2207 ConstStr SortIcons[] = {
2208 {HKEY("static/sort_none.gif")},
2209 {HKEY("static/up_pointer.gif")},
2210 {HKEY("static/down_pointer.gif")},
2213 ConstStr SortNextOrder[] = {
2220 int GetSortMetric(WCTemplputParams *TP, SortStruct **Next, SortStruct **Param, long *SortOrder, int N)
2222 int bSortError = eNOT_SPECIFIED;
2223 const StrBuf *BSort;
2228 if (!GetHash(SortHash, TKEY(0), &vSort) ||
2230 return eNO_SUCH_SORT;
2231 *Param = (SortStruct*) vSort;
2234 if (havebstr("SortBy")) {
2235 BSort = sbstr("SortBy");
2236 bSortError = eINVALID_PARAM;
2237 if ((*Param)->PrefPrepend == NULL) {
2238 set_room_pref("sort", NewStrBufDup(BSort), 0);
2241 set_X_PREFS(HKEY("sort"), TKEY(N), NewStrBufDup(BSort), 0);
2244 else { /** Try to fallback to our remembered values... */
2245 if ((*Param)->PrefPrepend == NULL) {
2246 BSort = get_room_pref("sort");
2249 BSort = get_X_PREFS(HKEY("sort"), TKEY(N));
2253 if (!GetHash(SortHash, SKEY(BSort), &vSort) ||
2257 *Next = (SortStruct*) vSort;
2259 /** Ok, its us, lets see in which direction we should sort... */
2260 if (havebstr("SortOrder")) {
2261 *SortOrder = LBSTR("SortOrder");
2263 else { /** Try to fallback to our remembered values... */
2264 if ((*Param)->PrefPrepend == NULL) {
2265 *SortOrder = StrTol(get_room_pref("SortOrder"));
2268 *SortOrder = StrTol(get_X_PREFS(HKEY("SortOrder"), TKEY(N)));
2278 void tmplput_SORT_ICON(StrBuf *Target, WCTemplputParams *TP)
2283 const ConstStr *SortIcon;
2285 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2288 Target, "Sorter", ERR_PARM1, TP,
2289 " Sorter [%s] unknown!",
2290 TP->Tokens->Params[0]->Start);
2292 case eINVALID_PARAM:
2293 LogTemplateError(NULL, "Sorter", ERR_PARM1, TP,
2294 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2296 case eNOT_SPECIFIED:
2298 if (Next == Param) {
2299 SortIcon = &SortIcons[SortOrder];
2301 else { /** Not Us... */
2302 SortIcon = &SortIcons[0];
2304 StrBufAppendBufPlain(Target, SortIcon->Key, SortIcon->len, 0);
2308 void tmplput_SORT_NEXT(StrBuf *Target, WCTemplputParams *TP)
2314 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2317 Target, "Sorter", ERR_PARM1, TP,
2318 " Sorter [%s] unknown!",
2319 TP->Tokens->Params[0]->Start);
2321 case eINVALID_PARAM:
2323 NULL, "Sorter", ERR_PARM1, TP,
2324 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2326 case eNOT_SPECIFIED:
2328 StrBufAppendBuf(Target, Param->Name, 0);
2333 void tmplput_SORT_ORDER(StrBuf *Target, WCTemplputParams *TP)
2336 const ConstStr *SortOrderStr;
2340 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2343 Target, "Sorter", ERR_PARM1, TP,
2344 " Sorter [%s] unknown!",
2345 TP->Tokens->Params[0]->Start);
2347 case eINVALID_PARAM:
2349 NULL, "Sorter", ERR_PARM1, TP,
2350 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2352 case eNOT_SPECIFIED:
2354 if (Next == Param) {
2355 SortOrderStr = &SortNextOrder[SortOrder];
2357 else { /** Not Us... */
2358 SortOrderStr = &SortNextOrder[0];
2360 StrBufAppendBufPlain(Target, SortOrderStr->Key, SortOrderStr->len, 0);
2365 void tmplput_long_vector(StrBuf *Target, WCTemplputParams *TP)
2367 long *LongVector = (long*) CTX;
2369 if ((TP->Tokens->Params[0]->Type == TYPE_LONG) &&
2370 (TP->Tokens->Params[0]->lvalue <= LongVector[0]))
2372 StrBufAppendPrintf(Target, "%ld", LongVector[TP->Tokens->Params[0]->lvalue]);
2376 if (TP->Tokens->Params[0]->Type != TYPE_LONG) {
2378 Target, "Longvector", ERR_NAME, TP,
2379 "needs a numerical Parameter!");
2383 Target, "LongVector", ERR_PARM1, TP,
2384 "doesn't have %ld Parameters, its just the size of %ld!",
2385 TP->Tokens->Params[0]->lvalue,
2391 void dbg_print_longvector(long *LongVector)
2393 StrBuf *Buf = NewStrBufPlain(HKEY("Longvector: ["));
2394 int nItems = LongVector[0];
2397 for (i = 0; i < nItems; i++) {
2399 StrBufAppendPrintf(Buf, "%d: %ld | ", i, LongVector[i]);
2401 StrBufAppendPrintf(Buf, "%d: %ld]\n", i, LongVector[i]);
2404 lprintf(1, ChrPtr(Buf));
2408 int ConditionalLongVector(StrBuf *Target, WCTemplputParams *TP)
2410 long *LongVector = (long*) CTX;
2412 if ((TP->Tokens->Params[2]->Type == TYPE_LONG) &&
2413 (TP->Tokens->Params[2]->lvalue <= LongVector[0])&&
2414 (TP->Tokens->Params[3]->Type == TYPE_LONG) &&
2415 (TP->Tokens->Params[3]->lvalue <= LongVector[0]))
2417 return LongVector[TP->Tokens->Params[2]->lvalue] ==
2418 LongVector[TP->Tokens->Params[3]->lvalue];
2422 if ((TP->Tokens->Params[2]->Type == TYPE_LONG) ||
2423 (TP->Tokens->Params[2]->Type == TYPE_LONG)) {
2425 Target, "ConditionalLongvector", ERR_PARM1, TP,
2426 "needs two long Parameter!");
2430 Target, "Longvector", ERR_PARM1, TP,
2431 "doesn't have %ld / %ld Parameters, its just the size of %ld!",
2432 TP->Tokens->Params[2]->lvalue,
2433 TP->Tokens->Params[3]->lvalue,
2444 memset(&NoCtx, 0, sizeof(WCTemplputParams));
2445 RegisterNamespace("SORT:ICON", 1, 2, tmplput_SORT_ICON, CTX_NONE);
2446 RegisterNamespace("SORT:ORDER", 1, 2, tmplput_SORT_ORDER, CTX_NONE);
2447 RegisterNamespace("SORT:NEXT", 1, 2, tmplput_SORT_NEXT, CTX_NONE);
2448 RegisterNamespace("CONTEXTSTR", 0, 1, tmplput_ContextString, CTX_STRBUF);
2449 RegisterNamespace("ITERATE", 2, 100, tmpl_iterate_subtmpl, CTX_NONE);
2450 RegisterNamespace("DOBOXED", 1, 2, tmpl_do_boxed, CTX_NONE);
2451 RegisterNamespace("DOTABBED", 2, 100, tmpl_do_tabbed, CTX_NONE);
2452 RegisterNamespace("LONGVECTOR", 1, 1, tmplput_long_vector, CTX_LONGVECTOR);
2453 RegisterConditional(HKEY("COND:SUBST"), 3, ConditionalVar, CTX_NONE);
2454 RegisterConditional(HKEY("COND:CONTEXTSTR"), 3, ConditionalContextStr, CTX_STRBUF);
2455 RegisterConditional(HKEY("COND:LONGVECTOR"), 4, ConditionalLongVector, CTX_LONGVECTOR);
2457 RegisterControlConditional(HKEY("COND:ITERATE:ISGROUPCHANGE"), 2,
2458 conditional_ITERATE_ISGROUPCHANGE,
2460 RegisterControlConditional(HKEY("COND:ITERATE:LASTN"), 2,
2461 conditional_ITERATE_LASTN,
2463 RegisterControlNS(HKEY("ITERATE:ODDEVEN"), 0, 0, tmplput_ITERATE_ODDEVEN, CTX_ITERATE);
2464 RegisterControlNS(HKEY("ITERATE:KEY"), 0, 0, tmplput_ITERATE_KEY, CTX_ITERATE);
2465 RegisterControlNS(HKEY("ITERATE:N"), 0, 0, tmplput_ITERATE_LASTN, CTX_ITERATE);