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 DumpTemplateI18NStrings = 0;
36 int LoadTemplates = 0;
37 int dbg_bactrace_template_errors = 0;
38 WCTemplputParams NoCtx;
39 StrBuf *I18nDump = NULL;
42 #define SV_CONDITIONAL 2
43 #define SV_NEG_CONDITIONAL 3
44 #define SV_CUST_STR_CONDITIONAL 4
46 #define SV_PREEVALUATED 6
50 * \brief Dynamic content for variable substitution in templates
52 typedef struct _wcsubst {
54 int wcs_type; /* which type of Substitution are we */
55 char wcs_key[32]; /* copy of our hashkey for debugging */
56 StrBuf *wcs_value; /* if we're a string, keep it here */
57 long lvalue; /* type long? keep data here */
58 WCHandlerFunc wcs_function; /* funcion hook ???*/
62 typedef struct _WCTemplate {
68 WCTemplateToken **Tokens;
71 typedef struct _HashHandler {
74 WCHandlerFunc HandlerFunc;
77 void *load_template(StrBuf *filename, StrBuf *Key, HashList *PutThere);
78 int EvaluateConditional(StrBuf *Target, int Neg, int state, WCTemplputParams *TP);
82 typedef struct _SortStruct {
87 CompareFunc GroupChange;
92 const char *CtxNames[] = {
103 "Context MIME_ATACH",
106 "Context LONGVECTOR",
115 void DestroySortStruct(void *vSort)
117 SortStruct *Sort = (SortStruct*) vSort;
118 FreeStrBuf(&Sort->Name);
119 FreeStrBuf(&Sort->PrefPrepend);
123 const char *ContextName(int ContextType)
125 if (ContextType < CTX_UNKNOWN)
126 return CtxNames[ContextType];
128 return CtxNames[CTX_UNKNOWN];
131 void LogTemplateError (StrBuf *Target, const char *Type, int ErrorPos, WCTemplputParams *TP, const char *Format, ...)
138 const char *Err = NULL;
143 va_start(arg_ptr, Format);
144 StrBufVAppendPrintf(Error, Format, arg_ptr);
149 case ERR_NAME: /* the main token name... */
150 Err = (TP->Tokens!= NULL)? TP->Tokens->pName:"";
153 Err = (TP->Tokens!= NULL)? TP->Tokens->Params[0]->Start:"";
156 Err = (TP->Tokens!= NULL)? TP->Tokens->Params[1]->Start:"";
159 if (TP->Tokens != NULL)
161 lprintf(1, "%s [%s] (in '%s' line %ld); %s; [%s]\n",
164 ChrPtr(TP->Tokens->FileName),
167 ChrPtr(TP->Tokens->FlatToken));
171 lprintf(1, "%s: %s;\n",
183 Header = NewStrBuf();
184 if (TP->Tokens != NULL)
189 "<pre>\n%s [%s] (in '%s' line %ld); %s\n[%s]\n</pre>\n",
192 ChrPtr(TP->Tokens->FileName),
195 ChrPtr(TP->Tokens->FlatToken));
197 StrBufPrintf(Info, "%s [%s] %s; [%s]",
201 ChrPtr(TP->Tokens->FlatToken));
204 SerializeJson(Header, WildFireException(SKEY(TP->Tokens->FileName),
209 SerializeJson(Header, WildFireMessage(SKEY(TP->Tokens->FileName),
214 WildFireSerializePayload(Header, WCC->HBuf, &WCC->Hdr->nWildfireHeaders, NULL);
221 "<pre>\n%s: %s\n</pre>\n",
225 StrBufPrintf(Info, "%s [%s] %s; [%s]",
229 ChrPtr(TP->Tokens->FlatToken));
230 SerializeJson(Header, WildFireException(HKEY(__FILE__), __LINE__, Info, 1), 1);
231 WildFireSerializePayload(Header, WCC->HBuf, &WCC->Hdr->nWildfireHeaders, NULL);
237 if (dbg_bactrace_template_errors)
245 void LogError (StrBuf *Target, const char *Type, const char *Format, ...)
256 va_start(arg_ptr, Format);
257 StrBufVAppendPrintf(Error, Format, arg_ptr);
260 lprintf(1, ChrPtr(Error));
263 Header = NewStrBuf();
266 SerializeJson(Header, WildFireException(Type, strlen(Type),
270 WildFireSerializePayload(Header, WCC->HBuf, &WCC->Hdr->nWildfireHeaders, NULL);
276 if (dbg_bactrace_template_errors)
282 void RegisterNS(const char *NSName,
286 WCHandlerFunc HandlerFunc,
289 HashHandler *NewHandler;
291 NewHandler = (HashHandler*) malloc(sizeof(HashHandler));
292 NewHandler->Filter.nMinArgs = nMinArgs;
293 NewHandler->Filter.nMaxArgs = nMaxArgs;
294 NewHandler->Filter.ContextType = ContextRequired;
295 NewHandler->Filter.ControlContextType = CTX_NONE;
297 NewHandler->HandlerFunc = HandlerFunc;
298 Put(GlobalNS, NSName, len, NewHandler, NULL);
301 void RegisterControlNS(const char *NSName,
305 WCHandlerFunc HandlerFunc,
306 int ControlContextRequired)
308 HashHandler *NewHandler;
310 NewHandler = (HashHandler*) malloc(sizeof(HashHandler));
311 NewHandler->Filter.nMinArgs = nMinArgs;
312 NewHandler->Filter.nMaxArgs = nMaxArgs;
313 NewHandler->Filter.ContextType = CTX_NONE;
314 NewHandler->Filter.ControlContextType = ControlContextRequired;
315 NewHandler->HandlerFunc = HandlerFunc;
316 Put(GlobalNS, NSName, len, NewHandler, NULL);
321 int CheckContext(StrBuf *Target, ContextFilter *Need, WCTemplputParams *TP, const char *ErrType)
323 if ((Need->ContextType != CTX_NONE) &&
324 (Need->ContextType != TP->Filter.ContextType)) {
326 Target, ErrType, ERR_PARM1, TP,
327 " WARNING: requires Context: [%s], have [%s]!",
328 ContextName(Need->ContextType),
329 ContextName(TP->Filter.ContextType));
333 if ((Need->ControlContextType != CTX_NONE) &&
334 (Need->ControlContextType != TP->Filter.ControlContextType)) {
336 Target, ErrType, ERR_PARM1, TP,
337 " WARNING: requires Control Context: [%s], have [%s]!",
338 ContextName(Need->ControlContextType),
339 ContextName(TP->Filter.ControlContextType));
343 if (TP->Tokens->nParameters < Need->nMinArgs) {
344 LogTemplateError(Target, ErrType, ERR_NAME, TP,
345 "needs at least %ld params, have %ld",
347 TP->Tokens->nParameters);
351 else if (TP->Tokens->nParameters > Need->nMaxArgs) {
352 LogTemplateError(Target, ErrType, ERR_NAME, TP,
353 "just needs %ld params, you gave %ld",
355 TP->Tokens->nParameters);
363 void FreeToken(WCTemplateToken **Token)
366 FreeStrBuf(&(*Token)->FlatToken);
367 if ((*Token)->HaveParameters)
368 for (i = 0; i < (*Token)->nParameters; i++)
369 free((*Token)->Params[i]);
376 void FreeWCTemplate(void *vFreeMe)
379 WCTemplate *FreeMe = (WCTemplate*)vFreeMe;
381 if (FreeMe->TokenSpace > 0) {
382 for (i = 0; i < FreeMe->nTokensUsed; i ++) {
383 FreeToken(&FreeMe->Tokens[i]);
385 free(FreeMe->Tokens);
387 FreeStrBuf(&FreeMe->FileName);
388 FreeStrBuf(&FreeMe->Data);
389 FreeStrBuf(&FreeMe->MimeType);
395 * \brief debugging function to print array to log
397 void VarPrintTransition(void *vVar1, void *vVar2, int odd){}
399 * \brief debugging function to print array to log
401 void VarPrintEntry(const char *Key, void *vSubst, int odd)
404 lprintf(1,"Subst[%s] : ", Key);
405 ptr = (wcsubst*) vSubst;
407 switch(ptr->wcs_type) {
409 lprintf(1, " -> %s\n", ChrPtr(ptr->wcs_value));
412 lprintf(1, " -> Server [%s]\n", ChrPtr(ptr->wcs_value));
415 lprintf(1, " -> function at [%0xd]\n", ptr->wcs_function);
418 lprintf(1," WARNING: invalid type: [%ld]!\n", ptr->wcs_type);
425 * \brief Clear out the list of substitution variables local to this session
427 void clear_substs(wcsession *wc) {
429 if (wc->vars != NULL) {
430 DeleteHash(&wc->vars);
435 * \brief Clear out the list of substitution variables local to this session
437 void clear_local_substs(void) {
456 void FlushPayload(wcsubst *ptr, int reusestrbuf, int type)
458 int NeedNew = NeedNewBuf(type);
459 switch(ptr->wcs_type) {
463 if (reusestrbuf && NeedNew) {
464 FlushStrBuf(ptr->wcs_value);
468 FreeStrBuf(&ptr->wcs_value);
469 ptr->wcs_value = NULL;
473 ptr->wcs_function = NULL;
474 if (reusestrbuf && NeedNew)
475 ptr->wcs_value = NewStrBuf();
478 ptr->wcs_value = NULL;
479 if (reusestrbuf && NeedNew)
480 ptr->wcs_value = NewStrBuf();
484 if (reusestrbuf && NeedNew)
485 ptr->wcs_value = NewStrBuf();
488 if (reusestrbuf && NeedNew)
489 ptr->wcs_value = NewStrBuf();
496 * \brief destructor; kill one entry.
498 void deletevar(void *data)
500 wcsubst *ptr = (wcsubst*)data;
501 FlushPayload(ptr, 0, ptr->wcs_type);
506 wcsubst *NewSubstVar(const char *keyname, int keylen, int type)
511 ptr = (wcsubst *) malloc(sizeof(wcsubst));
512 memset(ptr, 0, sizeof(wcsubst));
514 ptr->wcs_type = type;
515 safestrncpy(ptr->wcs_key, keyname, sizeof ptr->wcs_key);
516 Put(WCC->vars, keyname, keylen, ptr, deletevar);
518 switch(ptr->wcs_type) {
521 ptr->wcs_value = NewStrBuf();
535 * \brief Add a substitution variable (local to this session) (strlen version...)
536 * \param keyname the replacementstring to substitute
537 * \param keytype the kind of the key
538 * \param format the format string ala printf
539 * \param ... the arguments to substitute in the formatstring
541 void SVPRINTF(char *keyname, int keytype, const char *format,...)
549 keylen = strlen(keyname);
551 * First look if we're doing a replacement of
554 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
555 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
556 ptr = (wcsubst*)vPtr;
557 FlushPayload(ptr, keytype, keytype);
558 ptr->wcs_type = keytype;
560 else /** Otherwise allocate a new one */
562 ptr = NewSubstVar(keyname, keylen, keytype);
565 /** Format the string */
566 va_start(arg_ptr, format);
567 StrBufVAppendPrintf(ptr->wcs_value, format, arg_ptr);
572 * \brief Add a substitution variable (local to this session)
573 * \param keyname the replacementstring to substitute
574 * \param keytype the kind of the key
575 * \param format the format string ala printf
576 * \param ... the arguments to substitute in the formatstring
578 void svprintf(char *keyname, size_t keylen, int keytype, const char *format,...)
586 * First look if we're doing a replacement of
589 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
590 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
591 ptr = (wcsubst*)vPtr;
592 FlushPayload(ptr, 1, keytype);
593 ptr->wcs_type = keytype;
595 else /** Otherwise allocate a new one */
597 ptr = NewSubstVar(keyname, keylen, keytype);
600 /** Format the string and save it */
601 va_start(arg_ptr, format);
602 StrBufVAppendPrintf(ptr->wcs_value, format, arg_ptr);
607 * \brief Add a substitution variable (local to this session)
608 * \param keyname the replacementstring to substitute
609 * \param keytype the kind of the key
610 * \param format the format string ala printf
611 * \param ... the arguments to substitute in the formatstring
613 void SVPut(char *keyname, size_t keylen, int keytype, char *Data)
621 * First look if we're doing a replacement of
624 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
625 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
626 ptr = (wcsubst*)vPtr;
627 FlushPayload(ptr, 1, keytype);
628 ptr->wcs_type = keytype;
630 else /** Otherwise allocate a new one */
632 ptr = NewSubstVar(keyname, keylen, keytype);
634 StrBufAppendBufPlain(ptr->wcs_value, Data, -1, 0);
638 * \brief Add a substitution variable (local to this session)
639 * \param keyname the replacementstring to substitute
640 * \param keytype the kind of the key
641 * \param format the format string ala printf
642 * \param ... the arguments to substitute in the formatstring
644 void SVPutLong(char *keyname, size_t keylen, long Data)
652 * First look if we're doing a replacement of
655 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
656 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
657 ptr = (wcsubst*)vPtr;
658 FlushPayload(ptr, 1, WCS_LONG);
659 ptr->wcs_type = WCS_LONG;
661 else /** Otherwise allocate a new one */
663 ptr = NewSubstVar(keyname, keylen, WCS_LONG);
669 * \brief Add a substitution variable (local to this session) that does a callback
670 * \param keyname the keystring to substitute
671 * \param fcn_ptr the function callback to give the substitution string
673 void SVCallback(char *keyname, size_t keylen, WCHandlerFunc fcn_ptr)
680 * First look if we're doing a replacement of
683 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
684 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
685 ptr = (wcsubst*)vPtr;
686 FlushPayload(ptr, 1, WCS_FUNCTION);
687 ptr->wcs_type = WCS_FUNCTION;
689 else /** Otherwise allocate a new one */
691 ptr = NewSubstVar(keyname, keylen, WCS_FUNCTION);
694 ptr->wcs_function = fcn_ptr;
696 inline void SVCALLBACK(char *keyname, WCHandlerFunc fcn_ptr)
698 SVCallback(keyname, strlen(keyname), fcn_ptr);
703 void SVPUTBuf(const char *keyname, int keylen, const StrBuf *Buf, int ref)
710 * First look if we're doing a replacement of
713 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
714 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
715 ptr = (wcsubst*)vPtr;
716 FlushPayload(ptr, 0, (ref)?WCS_STRBUF_REF:WCS_STRBUF);
717 ptr->wcs_type = (ref)?WCS_STRBUF_REF:WCS_STRBUF;
719 else /** Otherwise allocate a new one */
721 ptr = NewSubstVar(keyname, keylen, (ref)?WCS_STRBUF_REF:WCS_STRBUF);
723 ptr->wcs_value = (StrBuf*)Buf;
727 * \brief back end for print_value_of() ... does a server command
728 * \param servcmd server command to execute on the citadel server
730 void pvo_do_cmd(StrBuf *Target, StrBuf *servcmd) {
734 serv_puts(ChrPtr(servcmd));
735 len = serv_getln(buf, sizeof buf);
741 StrBufAppendPrintf(Target, "%s\n", &buf[4]);
744 _fmout(Target, "CENTER");
747 StrBufAppendPrintf(Target, "%s\n", &buf[4]);
753 void GetTemplateTokenString(StrBuf *Target,
754 WCTemplputParams *TP,
760 WCTemplputParams SubTP;
762 if (TP->Tokens->nParameters < N) {
763 LogTemplateError(Target,
764 "TokenParameter", N, TP,
765 "invalid token %d. this shouldn't have come till here.\n", N);
771 switch (TP->Tokens->Params[N]->Type) {
774 *Value = TP->Tokens->Params[N]->Start;
775 *len = TP->Tokens->Params[N]->len;
778 Buf = (StrBuf*) SBstr(TKEY(N));
779 *Value = ChrPtr(Buf);
780 *len = StrLength(Buf);
783 get_PREFERENCE(TKEY(N), &Buf);
784 *Value = ChrPtr(Buf);
785 *len = StrLength(Buf);
788 LogTemplateError(Target,
789 "TokenParameter", N, TP,
790 "Requesting parameter %d; of type LONG, want string.", N);
793 LogTemplateError(Target,
794 "TokenParameter", N, TP,
795 "Requesting parameter %d; of type PREFINT, want string.", N);
798 *Value = _(TP->Tokens->Params[N]->Start);
799 *len = strlen(*Value);
801 case TYPE_SUBTEMPLATE:
802 memset(&SubTP, 0, sizeof(WCTemplputParams *));
803 SubTP.Context = TP->Context;
804 SubTP.Filter.ContextType = TP->Filter.ContextType;
806 DoTemplate(TKEY(N), Buf, &SubTP);
807 *Value = ChrPtr(Buf);
808 *len = StrLength(Buf);
809 /* we can't free it here, so we put it into the subst so its discarded later on. */
810 SVPUTBuf(TKEY(N), Buf, 0);
814 LogTemplateError(Target,
815 "TokenParameter", N, TP,
816 "unknown param type %d; [%d]", N, TP->Tokens->Params[N]->Type);
821 long GetTemplateTokenNumber(StrBuf *Target, WCTemplputParams *TP, int N, long dflt)
824 if (TP->Tokens->nParameters < N) {
825 LogTemplateError(Target,
826 "TokenParameter", N, TP,
827 "invalid token %d. this shouldn't have come till here.\n", N);
832 switch (TP->Tokens->Params[N]->Type) {
835 return atol(TP->Tokens->Params[N]->Start);
838 return LBstr(TKEY(N));
841 LogTemplateError(Target,
842 "TokenParameter", N, TP,
843 "requesting a prefstring in param %d want a number", N);
844 if (get_PREF_LONG(TKEY(N), &Ret, dflt))
848 return TP->Tokens->Params[N]->lvalue;
850 if (get_PREF_LONG(TKEY(N), &Ret, dflt))
854 LogTemplateError(Target,
855 "TokenParameter", N, TP,
856 "requesting a I18N string in param %d; want a number", N);
858 case TYPE_SUBTEMPLATE:
859 LogTemplateError(Target,
860 "TokenParameter", N, TP,
861 "requesting a subtemplate in param %d; not supported for numbers", N);
864 LogTemplateError(Target,
865 "TokenParameter", N, TP,
866 "unknown param type %d; [%d]", N, TP->Tokens->Params[N]->Type);
874 * \brief Print the value of a variable
875 * \param keyname get a key to print
877 void print_value_of(StrBuf *Target, WCTemplputParams *TP)
884 /*if (WCC->vars != NULL) PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
885 /* TODO: depricated! */
886 if (TP->Tokens->pName[0] == '=') {
887 DoTemplate(TP->Tokens->pName+1, TP->Tokens->NameEnd - 1, NULL, &NoCtx);
889 /*/////TODO: if param[1] == "U" -> urlescape
891 /** Page-local variables */
892 if ((WCC->vars!= NULL) && GetHash(WCC->vars, TP->Tokens->pName, TP->Tokens->NameEnd, &vVar)) {
893 ptr = (wcsubst*) vVar;
894 switch(ptr->wcs_type) {
896 StrBufAppendBuf(Target, ptr->wcs_value, 0);
899 pvo_do_cmd(Target, ptr->wcs_value);
902 (*ptr->wcs_function) (Target, TP);
906 StrBufAppendBuf(Target, ptr->wcs_value, 0);
909 StrBufAppendPrintf(Target, "%ld", ptr->lvalue);
913 Target, "Subst", ERR_NAME, TP,
914 "WARNING: invalid value in SV-Hash at %s!", TP->Tokens->pName);
919 Target, "Token", ERR_NAME, TP,
920 "didn't find Handler \"%s\"", TP->Tokens->pName);
925 int CompareSubstToToken(TemplateParam *ParamToCompare, TemplateParam *ParamToLookup)
931 if ((WCC->vars!= NULL) && GetHash(WCC->vars, ParamToLookup->Start,
932 ParamToLookup->len, &vVar)) {
933 ptr = (wcsubst*) vVar;
934 switch(ptr->wcs_type) {
938 if (ParamToCompare->Type == TYPE_STR)
939 return ((ParamToCompare->len == StrLength(ptr->wcs_value)) &&
940 (strcmp(ParamToCompare->Start, ChrPtr(ptr->wcs_value)) == 0));
942 return ParamToCompare->lvalue == StrTol(ptr->wcs_value);
950 if (ParamToCompare->Type == TYPE_STR)
953 return ParamToCompare->lvalue == ptr->lvalue;
956 lprintf(1,"WARNING: invalid value in SV-Hash at %s!\n",
957 ParamToLookup->Start);
963 int CompareSubstToStrBuf(StrBuf *Compare, TemplateParam *ParamToLookup)
969 if ((WCC->vars!= NULL) && GetHash(WCC->vars, ParamToLookup->Start,
970 ParamToLookup->len, &vVar)) {
971 ptr = (wcsubst*) vVar;
972 switch(ptr->wcs_type) {
976 return ((StrLength(Compare) == StrLength(ptr->wcs_value)) &&
977 (strcmp(ChrPtr(Compare), ChrPtr(ptr->wcs_value)) == 0));
984 return StrTol(Compare) == ptr->lvalue;
986 lprintf(1,"WARNING: invalid value in SV-Hash at %s!\n",
987 ParamToLookup->Start);
996 * \brief puts string into the template and computes which escape methon we should use
997 * \param Source the string we should put into the template
998 * \param FormatTypeIndex where should we look for escape types if?
1000 void StrBufAppendTemplate(StrBuf *Target,
1001 WCTemplputParams *TP,
1002 const StrBuf *Source, int FormatTypeIndex)
1005 char EscapeAs = ' ';
1007 if ((FormatTypeIndex < TP->Tokens->nParameters) &&
1008 (TP->Tokens->Params[FormatTypeIndex]->Type == TYPE_STR) &&
1009 (TP->Tokens->Params[FormatTypeIndex]->len == 1)) {
1010 EscapeAs = *TP->Tokens->Params[FormatTypeIndex]->Start;
1017 StrEscAppend(Target, Source, NULL, 0, 2);
1020 StrEscAppend(Target, Source, NULL, 0, 0);
1023 StrECMAEscAppend(Target, Source, NULL);
1026 StrBufUrlescAppend(Target, Source, NULL);
1029 StrBufAppendBuf(Target, Source, 0);
1034 void PutNewToken(WCTemplate *Template, WCTemplateToken *NewToken)
1036 if (Template->nTokensUsed + 1 >= Template->TokenSpace) {
1037 if (Template->TokenSpace <= 0) {
1038 Template->Tokens = (WCTemplateToken**)malloc(
1039 sizeof(WCTemplateToken*) * 10);
1040 Template->TokenSpace = 10;
1043 WCTemplateToken **NewTokens;
1044 NewTokens= (WCTemplateToken**)malloc(
1045 sizeof(WCTemplateToken*) *
1046 Template->TokenSpace * 2);
1047 memcpy(NewTokens, Template->Tokens,
1048 sizeof(WCTemplateToken*) * Template->nTokensUsed);
1049 free(Template->Tokens);
1050 Template->TokenSpace *= 2;
1051 Template->Tokens = NewTokens;
1054 Template->Tokens[(Template->nTokensUsed)++] = NewToken;
1057 TemplateParam *GetNextParameter(StrBuf *Buf, const char **pCh, const char *pe, WCTemplateToken *Tokens, WCTemplate *pTmpl)
1059 const char *pch = *pCh;
1060 const char *pchs, *pche;
1061 TemplateParam *Parm = (TemplateParam *) malloc(sizeof(TemplateParam));
1065 Parm->Type = TYPE_STR;
1067 /* Skip leading whitespaces */
1068 while ((*pch == ' ' )||
1071 (*pch == '\n')) pch ++;
1074 Parm->Type = TYPE_PREFSTR;
1081 else if (*pch == ';') {
1082 Parm->Type = TYPE_PREFINT;
1089 else if (*pch == '_') {
1090 Parm->Type = TYPE_GETTEXT;
1097 else if (*pch == 'B') {
1098 Parm->Type = TYPE_BSTR;
1105 else if (*pch == '=') {
1106 Parm->Type = TYPE_SUBTEMPLATE;
1117 else if (*pch == '\'')
1119 if (quote != '\0') {
1124 ( (pch > pchs) && (*(pch - 1) == '\\'))
1129 if (*pch != quote) {
1130 lprintf(1, "Error (in '%s' line %ld); "
1131 "evaluating template param [%s] in Token [%s]\n",
1132 ChrPtr(pTmpl->FileName),
1134 ChrPtr(Tokens->FlatToken),
1141 StrBufPeek(Buf, pch, -1, '\0');
1142 if (LoadTemplates > 1) {
1143 lprintf(1, "DBG: got param [%s] %ld %ld\n",
1144 pchs, pche - pchs, strlen(pchs));
1147 Parm->len = pche - pchs;
1148 pch ++; /* move after trailing quote */
1149 if (ParamBrace && (*pch == ')')) {
1156 Parm->Type = TYPE_LONG;
1158 while ((pch <= pe) &&
1164 if (pch - pchs > 1){
1165 StrBufPeek(Buf, pch, -1, '\0');
1166 Parm->lvalue = atol(pchs);
1173 lprintf(1, "Error (in '%s' line %ld); "
1174 "evaluating long template param [%s] in Token [%s]\n",
1175 ChrPtr(pTmpl->FileName),
1177 ChrPtr(Tokens->FlatToken),
1184 while ((*pch == ' ' )||
1188 (*pch == '\n')) pch ++;
1190 if (DumpTemplateI18NStrings && (Parm->Type == TYPE_GETTEXT)) {
1191 StrBufAppendPrintf(I18nDump, "_(\"%s\");\n", Parm->Start);
1197 WCTemplateToken *NewTemplateSubstitute(StrBuf *Buf,
1199 const char *pTmplStart,
1200 const char *pTmplEnd,
1206 TemplateParam *Param;
1207 WCTemplateToken *NewToken = (WCTemplateToken*)malloc(sizeof(WCTemplateToken));
1208 WCTemplputParams TP;
1210 TP.Tokens = NewToken;
1211 NewToken->FileName = pTmpl->FileName; /* to print meaningfull log messages... */
1212 NewToken->Flags = 0;
1213 NewToken->Line = Line + 1;
1214 NewToken->pTokenStart = pTmplStart;
1215 NewToken->TokenStart = pTmplStart - pStart;
1216 NewToken->TokenEnd = (pTmplEnd - pStart) - NewToken->TokenStart;
1217 NewToken->pTokenEnd = pTmplEnd;
1218 NewToken->NameEnd = NewToken->TokenEnd - 2;
1219 NewToken->PreEval = NULL;
1220 NewToken->FlatToken = NewStrBufPlain(pTmplStart + 2, pTmplEnd - pTmplStart - 2);
1222 StrBufPeek(Buf, pTmplStart, + 1, '\0');
1223 StrBufPeek(Buf, pTmplEnd, -1, '\0');
1224 pch = NewToken->pName = pTmplStart + 2;
1226 NewToken->HaveParameters = 0;;
1227 NewToken->nParameters = 0;
1229 while (pch < pTmplEnd - 1) {
1231 StrBufPeek(Buf, pch, -1, '\0');
1232 NewToken->NameEnd = pch - NewToken->pName;
1234 if (*(pTmplEnd - 1) != ')') {
1236 NULL, "Parseerror", ERR_NAME, &TP,
1237 "Warning, Non welformed Token; missing right parenthesis");
1239 while (pch < pTmplEnd - 1) {
1240 Param = GetNextParameter(Buf, &pch, pTmplEnd - 1, NewToken, pTmpl);
1241 if (Param != NULL) {
1242 NewToken->HaveParameters = 1;
1243 if (NewToken->nParameters > MAXPARAM) {
1245 NULL, "Parseerror", ERR_NAME, &TP,
1246 "only [%d] Params allowed in Tokens",
1250 FreeToken(&NewToken);
1253 NewToken->Params[NewToken->nParameters++] = Param;
1257 if((NewToken->NameEnd == 1) &&
1258 (NewToken->HaveParameters == 1))
1261 if (*(NewToken->pName) == '_')
1262 NewToken->Flags = SV_GETTEXT;
1263 else if (*(NewToken->pName) == '=')
1264 NewToken->Flags = SV_SUBTEMPL;
1265 else if (*(NewToken->pName) == '%')
1266 NewToken->Flags = SV_CUST_STR_CONDITIONAL;
1267 else if (*(NewToken->pName) == '?')
1268 NewToken->Flags = SV_CONDITIONAL;
1269 else if (*(NewToken->pName) == '!')
1270 NewToken->Flags = SV_NEG_CONDITIONAL;
1276 switch (NewToken->Flags) {
1278 /* If we're able to find out more about the token, do it now while its fresh. */
1279 if (GetHash(GlobalNS, NewToken->pName, NewToken->NameEnd, &vVar)) {
1280 HashHandler *Handler;
1281 Handler = (HashHandler*) vVar;
1282 if ((NewToken->nParameters < Handler->Filter.nMinArgs) ||
1283 (NewToken->nParameters > Handler->Filter.nMaxArgs)) {
1285 NULL, "Token", ERR_NAME, &TP,
1286 "doesn't work with %d params",
1287 NewToken->nParameters);
1291 NewToken->PreEval = Handler;
1292 NewToken->Flags = SV_PREEVALUATED;
1297 if (NewToken->nParameters !=1) {
1299 NULL, "Gettext", ERR_NAME, &TP,
1300 "requires exactly 1 parameter, you gave %d params",
1301 NewToken->nParameters);
1302 NewToken->Flags = 0;
1305 if (DumpTemplateI18NStrings) {
1306 StrBufAppendPrintf(I18nDump, "_(\"%s\");\n", NewToken->Params[0]->Start);
1310 if (NewToken->nParameters != 1) {
1312 NULL, "Subtemplates", ERR_NAME, &TP,
1313 "require exactly 1 parameter, you gave %d params",
1314 NewToken->nParameters);
1318 case SV_CUST_STR_CONDITIONAL:
1319 case SV_CONDITIONAL:
1320 case SV_NEG_CONDITIONAL:
1321 if (NewToken->nParameters <2) {
1323 NULL, "Conditional", ERR_NAME, &TP,
1324 "require at least 2 parameters, you gave %d params",
1325 NewToken->nParameters);
1326 NewToken->Flags = 0;
1329 if (NewToken->Params[1]->lvalue == 0) {
1331 NULL, "Conditional", ERR_NAME, &TP,
1332 "Conditional ID (Parameter 1) mustn't be 0!");
1333 NewToken->Flags = 0;
1336 if (!GetHash(Conditionals,
1337 NewToken->Params[0]->Start,
1338 NewToken->Params[0]->len,
1341 if ((NewToken->Params[0]->len == 1) &&
1342 (NewToken->Params[0]->Start[0] == 'X'))
1345 NULL, "Conditional", ERR_NAME, &TP,
1348 NewToken->Error = NewStrBuf();
1351 "<pre>\nConditional [%s] (in '%s' line %ld); Not found!\n[%s]\n</pre>\n",
1352 NewToken->Params[0]->Start,
1353 ChrPtr(pTmpl->FileName),
1355 ChrPtr(NewToken->FlatToken));
1359 NewToken->PreEval = vVar;
1371 * \brief Display a variable-substituted template
1372 * \param templatename template file to load
1374 void *prepare_template(StrBuf *filename, StrBuf *Key, HashList *PutThere)
1376 WCTemplate *NewTemplate;
1377 NewTemplate = (WCTemplate *) malloc(sizeof(WCTemplate));
1378 NewTemplate->Data = NULL;
1379 NewTemplate->FileName = NewStrBufDup(filename);
1380 NewTemplate->nTokensUsed = 0;
1381 NewTemplate->TokenSpace = 0;
1382 NewTemplate->Tokens = NULL;
1383 NewTemplate->MimeType = NewStrBufPlain(GuessMimeByFilename (SKEY(NewTemplate->FileName)), -1);
1384 if (strstr(ChrPtr(NewTemplate->MimeType), "text") != NULL) {
1385 StrBufAppendBufPlain(NewTemplate->MimeType, HKEY("; charset=utf-8"), 0);
1388 Put(PutThere, ChrPtr(Key), StrLength(Key), NewTemplate, FreeWCTemplate);
1393 * \brief Display a variable-substituted template
1394 * \param templatename template file to load
1396 void *load_template(StrBuf *filename, StrBuf *Key, HashList *PutThere)
1399 struct stat statbuf;
1400 const char *pS, *pE, *pch, *Err;
1403 WCTemplate *NewTemplate;
1405 fd = open(ChrPtr(filename), O_RDONLY);
1407 lprintf(1, "ERROR: could not open template '%s' - %s\n",
1408 ChrPtr(filename), strerror(errno));
1412 if (fstat(fd, &statbuf) == -1) {
1413 lprintf(1, "ERROR: could not stat template '%s' - %s\n",
1414 ChrPtr(filename), strerror(errno));
1418 NewTemplate = (WCTemplate *) malloc(sizeof(WCTemplate));
1419 NewTemplate->Data = NewStrBufPlain(NULL, statbuf.st_size);
1420 NewTemplate->FileName = NewStrBufDup(filename);
1421 NewTemplate->nTokensUsed = 0;
1422 NewTemplate->TokenSpace = 0;
1423 NewTemplate->Tokens = NULL;
1424 NewTemplate->MimeType = NewStrBufPlain(GuessMimeByFilename (SKEY(NewTemplate->FileName)), -1);
1425 if (strstr(ChrPtr(NewTemplate->MimeType), "text") != NULL) {
1426 StrBufAppendBufPlain(NewTemplate->MimeType, HKEY("; charset=utf-8"), 0);
1429 if (StrBufReadBLOB(NewTemplate->Data, &fd, 1, statbuf.st_size, &Err) < 0) {
1431 FreeWCTemplate(NewTemplate);
1432 lprintf(1, "ERROR: reading template '%s' - %s<br />\n",
1433 ChrPtr(filename), strerror(errno));
1439 pS = pch = ChrPtr(NewTemplate->Data);
1440 pE = pS + StrLength(NewTemplate->Data);
1442 const char *pts, *pte;
1444 int InDoubleQuotes = 0;
1446 /** Find one <? > */
1448 for (; pch < pE; pch ++) {
1449 if ((*pch=='<')&&(*(pch + 1)=='?'))
1451 if (*pch=='\n') Line ++;
1457 /** Found one? parse it. */
1458 for (; pch <= pE - 1; pch ++) {
1460 InDoubleQuotes = ! InDoubleQuotes;
1461 else if (*pch == '\'')
1462 InQuotes = ! InQuotes;
1463 else if ((!InQuotes && !InDoubleQuotes) &&
1464 ((*pch!='\\')&&(*(pch + 1)=='>'))) {
1472 PutNewToken(NewTemplate,
1473 NewTemplateSubstitute(NewTemplate->Data, pS, pts, pte, Line, NewTemplate));
1476 if (LoadTemplates == 0)
1477 Put(PutThere, ChrPtr(Key), StrLength(Key), NewTemplate, FreeWCTemplate);
1482 const char* PrintTemplate(void *vSubst)
1484 WCTemplate *Tmpl = vSubst;
1486 return ChrPtr(Tmpl->FileName);
1490 int LoadTemplateDir(const char *DirName, HashList *wireless, HashList *big)
1495 DIR *filedir = NULL;
1496 struct dirent *filedir_entry;
1502 StrBufPrintf(Dir, "%s/t", DirName);
1503 filedir = opendir (ChrPtr(Dir));
1504 if (filedir == NULL) {
1509 FileName = NewStrBuf();
1511 while ((filedir_entry = readdir(filedir)))
1515 #ifdef _DIRENT_HAVE_D_NAMELEN
1516 d_namelen = filedir_entry->d_namelen;
1518 d_namelen = strlen(filedir_entry->d_name);
1520 d_without_ext = d_namelen;
1521 while ((d_without_ext > 0) && (filedir_entry->d_name[d_without_ext] != '.'))
1523 if ((d_without_ext == 0) || (d_namelen < 3))
1525 if ((d_namelen > 1) && filedir_entry->d_name[d_namelen - 1] == '~')
1526 continue; /* Ignore backup files... */
1528 IsMobile = (strstr(filedir_entry->d_name, ".m.html")!= NULL);
1529 PStart = filedir_entry->d_name;
1530 StrBufPrintf(FileName, "%s/%s", ChrPtr(Dir), filedir_entry->d_name);
1531 MinorPtr = strchr(filedir_entry->d_name, '.');
1532 if (MinorPtr != NULL)
1534 StrBufPlain(Tag, filedir_entry->d_name, MinorPtr - filedir_entry->d_name);
1536 if (LoadTemplates > 1)
1537 lprintf(1, "%s %d %s\n",ChrPtr(FileName), IsMobile, ChrPtr(Tag));
1538 if (LoadTemplates == 0)
1539 load_template(FileName, Tag, (IsMobile)?wireless:big);
1541 prepare_template(FileName, Tag, (IsMobile)?wireless:big);
1544 FreeStrBuf(&FileName);
1550 void InitTemplateCache(void)
1552 LoadTemplateDir(static_dirs[0],
1553 WirelessTemplateCache,
1555 LoadTemplateDir(static_dirs[1],
1556 WirelessLocalTemplateCache,
1557 LocalTemplateCache);
1562 /*-----------------------------------------------------------------------------
1563 * Filling & processing Templates
1566 * \brief executes one token
1567 * \param Target buffer to append to
1568 * \param Token da to process.
1569 * \param Template we're iterating
1570 * \param Context Contextpoointer to pass in
1571 * \param state are we in conditional state?
1572 * \param ContextType what type of information does context giv us?
1574 int EvaluateToken(StrBuf *Target, int state, WCTemplputParams *TP)
1576 const char *AppendMe;
1578 HashHandler *Handler;
1581 /* much output, since pName is not terminated...
1582 lprintf(1,"Doing token: %s\n",Token->pName);
1585 switch (TP->Tokens->Flags) {
1587 TmplGettext(Target, TP);
1589 case SV_CONDITIONAL: /** Forward conditional evaluation */
1590 return EvaluateConditional(Target, 1, state, TP);
1592 case SV_NEG_CONDITIONAL: /** Reverse conditional evaluation */
1593 return EvaluateConditional(Target, 0, state, TP);
1595 case SV_CUST_STR_CONDITIONAL: /** Conditional put custom strings from params */
1596 if (TP->Tokens->nParameters >= 6) {
1597 if (EvaluateConditional(Target, 0, state, TP)) {
1598 GetTemplateTokenString(Target, TP, 5, &AppendMe, &AppendMeLen);
1599 StrBufAppendBufPlain(Target,
1605 GetTemplateTokenString(Target, TP, 4, &AppendMe, &AppendMeLen);
1606 StrBufAppendBufPlain(Target,
1614 Target, "Conditional", ERR_NAME, TP,
1615 "needs at least 6 Params!");
1619 if (TP->Tokens->nParameters == 1)
1620 DoTemplate(TKEY(0), Target, TP);
1622 case SV_PREEVALUATED:
1623 Handler = (HashHandler*) TP->Tokens->PreEval;
1624 if (!CheckContext(Target, &Handler->Filter, TP, "Token")) {
1627 Handler->HandlerFunc(Target, TP);
1630 if (GetHash(GlobalNS, TP->Tokens->pName, TP->Tokens->NameEnd, &vVar)) {
1631 Handler = (HashHandler*) vVar;
1632 if (!CheckContext(Target, &Handler->Filter, TP, "Token")) {
1636 Handler->HandlerFunc(Target, TP);
1640 print_value_of(Target, TP);
1648 const StrBuf *ProcessTemplate(WCTemplate *Tmpl, StrBuf *Target, WCTemplputParams *CallingTP)
1650 WCTemplate *pTmpl = Tmpl;
1653 const char *pData, *pS;
1655 WCTemplputParams TP;
1657 memcpy(&TP.Filter, &CallingTP->Filter, sizeof(ContextFilter));
1659 TP.Context = CallingTP->Context;
1660 TP.ControlContext = CallingTP->ControlContext;
1662 if (LoadTemplates != 0) {
1663 if (LoadTemplates > 1)
1664 lprintf(1, "DBG: ----- loading: [%s] ------ \n",
1665 ChrPtr(Tmpl->FileName));
1667 pTmpl = load_template(Tmpl->FileName, NULL, NULL);
1671 "<pre>\nError loading Template [%s]\n See Logfile for details\n</pre>\n",
1672 ChrPtr(Tmpl->FileName));
1678 pS = pData = ChrPtr(pTmpl->Data);
1679 len = StrLength(pTmpl->Data);
1683 if (i >= pTmpl->nTokensUsed) {
1684 StrBufAppendBufPlain(Target,
1686 len - (pData - pS), 0);
1690 StrBufAppendBufPlain(
1692 pTmpl->Tokens[i]->pTokenStart - pData, 0);
1693 TP.Tokens = pTmpl->Tokens[i];
1694 TP.nArgs = pTmpl->Tokens[i]->nParameters;
1695 state = EvaluateToken(Target, state, &TP);
1697 while ((state != 0) && (i+1 < pTmpl->nTokensUsed)) {
1698 /* condition told us to skip till its end condition */
1700 TP.Tokens = pTmpl->Tokens[i];
1701 TP.nArgs = pTmpl->Tokens[i]->nParameters;
1702 if ((pTmpl->Tokens[i]->Flags == SV_CONDITIONAL) ||
1703 (pTmpl->Tokens[i]->Flags == SV_NEG_CONDITIONAL)) {
1704 if (state == EvaluateConditional(
1706 pTmpl->Tokens[i]->Flags,
1712 pData = pTmpl->Tokens[i++]->pTokenEnd + 1;
1713 if (i > pTmpl->nTokensUsed)
1717 if (LoadTemplates != 0) {
1718 FreeWCTemplate(pTmpl);
1720 return Tmpl->MimeType;
1725 * \brief Display a variable-substituted template
1726 * \param templatename template file to load
1727 * \returns the mimetype of the template its doing
1729 const StrBuf *DoTemplate(const char *templatename, long len, StrBuf *Target, WCTemplputParams *TP)
1731 WCTemplputParams LocalTP;
1733 HashList *StaticLocal;
1739 memset(&LocalTP, 0, sizeof(WCTemplputParams));
1743 if (WC->is_mobile) {
1744 Static = WirelessTemplateCache;
1745 StaticLocal = WirelessLocalTemplateCache;
1748 Static = TemplateCache;
1749 StaticLocal = LocalTemplateCache;
1754 lprintf (1, "Can't to load a template with empty name!\n");
1755 StrBufAppendPrintf(Target, "<pre>\nCan't to load a template with empty name!\n</pre>");
1759 if (!GetHash(StaticLocal, templatename, len, &vTmpl) &&
1760 !GetHash(Static, templatename, len, &vTmpl)) {
1761 lprintf (1, "didn't find Template [%s] %ld %ld\n", templatename, len , (long)strlen(templatename));
1762 StrBufAppendPrintf(Target, "<pre>\ndidn't find Template [%s] %ld %ld\n</pre>",
1764 (long)strlen(templatename));
1766 dbg_PrintHash(Static, PrintTemplate, NULL);
1767 PrintHash(Static, VarPrintTransition, PrintTemplate);
1773 return ProcessTemplate(vTmpl, Target, TP);
1777 /*-----------------------------------------------------------------------------
1780 typedef struct _HashIterator {
1781 HashList *StaticList;
1782 int AdditionalParams;
1784 int XPectContextType;
1786 RetrieveHashlistFunc GetHash;
1787 HashDestructorFunc Destructor;
1788 SubTemplFunc DoSubTemplate;
1791 void RegisterITERATOR(const char *Name, long len,
1792 int AdditionalParams,
1793 HashList *StaticList,
1794 RetrieveHashlistFunc GetHash,
1795 SubTemplFunc DoSubTempl,
1796 HashDestructorFunc Destructor,
1798 int XPectContextType,
1801 HashIterator *It = (HashIterator*)malloc(sizeof(HashIterator));
1802 It->StaticList = StaticList;
1803 It->AdditionalParams = AdditionalParams;
1804 It->GetHash = GetHash;
1805 It->DoSubTemplate = DoSubTempl;
1806 It->Destructor = Destructor;
1807 It->ContextType = ContextType;
1808 It->XPectContextType = XPectContextType;
1810 Put(Iterators, Name, len, It, NULL);
1813 typedef struct _iteratestruct {
1822 void tmpl_iterate_subtmpl(StrBuf *Target, WCTemplputParams *TP)
1828 SortStruct *SortBy = NULL;
1830 int DetectGroupChange = 0;
1833 void *vLastContext = NULL;
1835 WCTemplputParams SubTP;
1836 IterateStruct Status;
1842 memset(&Status, 0, sizeof(IterateStruct));
1843 memcpy (&SubTP, &TP, sizeof(WCTemplputParams));
1845 if (!GetHash(Iterators, TKEY(0), &vIt)) {
1847 Target, "Iterator", ERR_PARM1, TP, "Unknown!");
1851 It = (HashIterator*) vIt;
1853 if (TP->Tokens->nParameters < It->AdditionalParams + 2) {
1855 Target, "Iterator", ERR_PARM1, TP,
1856 "doesn't work with %d params",
1857 TP->Tokens->nParameters);
1861 if ((It->XPectContextType != CTX_NONE) &&
1862 (It->XPectContextType != TP->Filter.ContextType)) {
1864 Target, "Iterator", ERR_PARM1, TP,
1865 "requires context of type %d, have %d",
1866 It->XPectContextType,
1867 TP->Filter.ContextType);
1872 if (It->StaticList == NULL)
1873 List = It->GetHash(Target, TP);
1875 List = It->StaticList;
1877 DetectGroupChange = (It->Flags & IT_FLAG_DETECT_GROUPCHANGE) != 0;
1878 if (DetectGroupChange) {
1879 const StrBuf *BSort;
1880 DetectGroupChange = 0;
1881 if (havebstr("SortBy")) {
1882 BSort = sbstr("SortBy");
1883 if (GetHash(SortHash, SKEY(BSort), &vSortBy) &&
1884 (vSortBy != NULL)) {
1885 SortBy = (SortStruct*)vSortBy;
1886 /** Ok, its us, lets see in which direction we should sort... */
1887 if (havebstr("SortOrder")) {
1889 SortOrder = LBSTR("SortOrder");
1891 DetectGroupChange = 1;
1896 nMembersUsed = GetCount(List);
1897 SubBuf = NewStrBuf();
1898 SubTP.Filter.ContextType = It->ContextType;
1899 SubTP.Filter.ControlContextType = CTX_ITERATE;
1900 SubTP.ControlContext = &Status;
1902 if (HAVE_PARAM(2)) {
1903 StartAt = GetTemplateTokenNumber(Target, TP, 2, 0);
1905 if (HAVE_PARAM(3)) {
1906 StepWidth = GetTemplateTokenNumber(Target, TP, 3, 0);
1908 if (HAVE_PARAM(4)) {
1909 StopAt = GetTemplateTokenNumber(Target, TP, 4, -1);
1911 it = GetNewHashPos(List, StepWidth);
1913 StopAt = GetCount(List);
1915 while (GetNextHashPos(List, it, &Status.KeyLen, &Status.Key, &vContext)) {
1916 if ((Status.n >= StartAt) && (Status.n <= StopAt)) {
1917 if (DetectGroupChange && Status.n > 0) {
1918 Status.GroupChange = (SortBy->GroupChange(vContext, vLastContext))? 1:0;
1920 Status.LastN = (Status.n + 1) == nMembersUsed;
1921 SubTP.Context = vContext;
1922 if (It->DoSubTemplate != NULL)
1923 It->DoSubTemplate(SubBuf, &SubTP);
1924 DoTemplate(TKEY(1), SubBuf, &SubTP);
1926 StrBufAppendBuf(Target, SubBuf, 0);
1927 FlushStrBuf(SubBuf);
1928 Status.oddeven = ! Status.oddeven;
1929 vLastContext = vContext;
1933 FreeStrBuf(&SubBuf);
1935 if (It->Destructor != NULL)
1936 It->Destructor(&List);
1940 int conditional_ITERATE_ISGROUPCHANGE(StrBuf *Target, WCTemplputParams *TP)
1942 IterateStruct *Ctx = CCTX;
1943 return Ctx->GroupChange;
1946 void tmplput_ITERATE_ODDEVEN(StrBuf *Target, WCTemplputParams *TP)
1948 IterateStruct *Ctx = CCTX;
1950 StrBufAppendBufPlain(Target, HKEY("odd"), 0);
1952 StrBufAppendBufPlain(Target, HKEY("even"), 0);
1956 void tmplput_ITERATE_KEY(StrBuf *Target, WCTemplputParams *TP)
1958 IterateStruct *Ctx = CCTX;
1960 StrBufAppendBufPlain(Target, Ctx->Key, Ctx->KeyLen, 0);
1964 void tmplput_ITERATE_LASTN(StrBuf *Target, WCTemplputParams *TP)
1966 IterateStruct *Ctx = CCTX;
1967 StrBufAppendPrintf(Target, "%d", Ctx->n);
1970 int conditional_ITERATE_LASTN(StrBuf *Target, WCTemplputParams *TP)
1972 IterateStruct *Ctx = CCTX;
1978 /*-----------------------------------------------------------------------------
1981 int EvaluateConditional(StrBuf *Target, int Neg, int state, WCTemplputParams *TP)
1983 ConditionalStruct *Cond;
1985 if ((TP->Tokens->Params[0]->len == 1) &&
1986 (TP->Tokens->Params[0]->Start[0] == 'X'))
1987 return (state != 0)?TP->Tokens->Params[1]->lvalue:0;
1989 Cond = (ConditionalStruct *) TP->Tokens->PreEval;
1992 Target, "Conditional", ERR_PARM1, TP,
1997 if (!CheckContext(Target, &Cond->Filter, TP, "Conditional")) {
2001 if (Cond->CondF(Target, TP) == Neg)
2002 return TP->Tokens->Params[1]->lvalue;
2006 int ConditionalVar(StrBuf *Target, WCTemplputParams *TP)
2011 if (!GetHash(WC->vars, TKEY(2), &vsubst))
2013 subst = (wcsubst*) vsubst;
2015 switch(subst->wcs_type) {
2017 return (subst->wcs_function!=NULL);
2019 lprintf(1, " -> Server [%s]\n", subst->wcs_value);/* TODO */
2023 case WCS_STRBUF_REF:
2024 if (TP->Tokens->nParameters < 4)
2026 return (strcmp(TP->Tokens->Params[3]->Start, ChrPtr(subst->wcs_value)) == 0);
2028 if (TP->Tokens->nParameters < 4)
2029 return (subst->lvalue != 0);
2030 return (subst->lvalue == TP->Tokens->Params[3]->lvalue);
2032 lprintf(1," WARNING: invalid type: [%ld]!\n", subst->wcs_type);
2038 void RegisterConditional(const char *Name, long len,
2040 WCConditionalFunc CondF,
2041 int ContextRequired)
2043 ConditionalStruct *Cond = (ConditionalStruct*)malloc(sizeof(ConditionalStruct));
2044 Cond->PlainName = Name;
2045 Cond->Filter.nMaxArgs = nParams;
2046 Cond->Filter.nMinArgs = nParams;
2047 Cond->CondF = CondF;
2048 Cond->Filter.ContextType = ContextRequired;
2049 Cond->Filter.ControlContextType = CTX_NONE;
2050 Put(Conditionals, Name, len, Cond, NULL);
2053 void RegisterControlConditional(const char *Name, long len,
2055 WCConditionalFunc CondF,
2056 int ControlContextRequired)
2058 ConditionalStruct *Cond = (ConditionalStruct*)malloc(sizeof(ConditionalStruct));
2059 Cond->PlainName = Name;
2060 Cond->Filter.nMaxArgs = nParams;
2061 Cond->Filter.nMinArgs = nParams;
2062 Cond->CondF = CondF;
2063 Cond->Filter.ContextType = CTX_NONE;
2064 Cond->Filter.ControlContextType = ControlContextRequired;
2065 Put(Conditionals, Name, len, Cond, NULL);
2068 /*-----------------------------------------------------------------------------
2071 void tmplput_ContextString(StrBuf *Target, WCTemplputParams *TP)
2073 StrBufAppendTemplate(Target, TP, (StrBuf*)CTX, 0);
2075 int ConditionalContextStr(StrBuf *Target, WCTemplputParams *TP)
2077 StrBuf *TokenText = (StrBuf*) CTX;
2078 const char *CompareToken;
2081 GetTemplateTokenString(Target, TP, 2, &CompareToken, &len);
2082 return strcmp(ChrPtr(TokenText), CompareToken) == 0;
2085 /*-----------------------------------------------------------------------------
2089 void tmpl_do_boxed(StrBuf *Target, WCTemplputParams *TP)
2091 WCTemplputParams SubTP;
2094 if (TP->Tokens->nParameters == 2) {
2095 if (TP->Tokens->Params[1]->Type == TYPE_STR) {
2096 Headline = NewStrBuf();
2097 DoTemplate(TKEY(1), Headline, TP);
2102 GetTemplateTokenString(Target,
2107 Headline = NewStrBufPlain(Ch, len);
2110 memcpy (&SubTP, TP, sizeof(WCTemplputParams));
2111 SubTP.Context = Headline;
2112 SubTP.Filter.ContextType = CTX_STRBUF;
2113 DoTemplate(HKEY("beginbox"), Target, &SubTP);
2114 DoTemplate(TKEY(0), Target, TP);
2115 DoTemplate(HKEY("endbox"), Target, TP);
2116 FreeStrBuf(&Headline);
2119 /*-----------------------------------------------------------------------------
2123 void tmpl_do_tabbed(StrBuf *Target, WCTemplputParams *TP)
2126 int i, ntabs, nTabs;
2128 nTabs = ntabs = TP->Tokens->nParameters / 2;
2129 TabNames = (StrBuf **) malloc(ntabs * sizeof(StrBuf*));
2131 for (i = 0; i < ntabs; i++) {
2132 if ((TP->Tokens->Params[i * 2]->Type == TYPE_STR) &&
2133 (TP->Tokens->Params[i * 2]->len > 0)) {
2134 TabNames[i] = NewStrBuf();
2135 DoTemplate(TKEY(i * 2), TabNames[i], TP);
2137 else if (TP->Tokens->Params[i * 2]->Type == TYPE_GETTEXT) {
2140 GetTemplateTokenString(Target,
2145 TabNames[i] = NewStrBufPlain(Ch, -1);
2148 /** A Tab without subject? we can't count that, add it as silent */
2153 StrTabbedDialog(Target, nTabs, TabNames);
2154 for (i = 0; i < ntabs; i++) {
2155 StrBeginTab(Target, i, nTabs);
2156 DoTemplate(TKEY(i * 2 + 1), Target, TP);
2157 StrEndTab(Target, i, nTabs);
2162 /*-----------------------------------------------------------------------------
2167 void RegisterSortFunc(const char *name, long len,
2168 const char *prepend, long preplen,
2169 CompareFunc Forward,
2170 CompareFunc Reverse,
2171 CompareFunc GroupChange,
2174 SortStruct *NewSort = (SortStruct*) malloc(sizeof(SortStruct));
2175 NewSort->Name = NewStrBufPlain(name, len);
2176 if (prepend != NULL)
2177 NewSort->PrefPrepend = NewStrBufPlain(prepend, preplen);
2179 NewSort->PrefPrepend = NULL;
2180 NewSort->Forward = Forward;
2181 NewSort->Reverse = Reverse;
2182 NewSort->GroupChange = GroupChange;
2183 NewSort->ContextType = ContextType;
2184 Put(SortHash, name, len, NewSort, DestroySortStruct);
2187 CompareFunc RetrieveSort(WCTemplputParams *TP,
2188 const char *OtherPrefix, long OtherPrefixLen,
2189 const char *Default, long ldefault, long DefaultDirection)
2192 const StrBuf *BSort = NULL;
2195 long SortOrder = -1;
2197 if (havebstr("SortBy")) {
2198 BSort = sbstr("SortBy");
2199 if (OtherPrefix == NULL) {
2200 set_room_pref("sort", NewStrBufDup(BSort), 0);
2203 set_X_PREFS(HKEY("sort"), OtherPrefix, OtherPrefixLen, NewStrBufDup(BSort), 0);
2206 else { /** Try to fallback to our remembered values... */
2207 if (OtherPrefix == NULL) {
2208 BSort = get_room_pref("sort");
2211 BSort = get_X_PREFS(HKEY("sort"), OtherPrefix, OtherPrefixLen);
2214 putbstr("SortBy", NewStrBufDup(BSort));
2218 BSort = Buf = NewStrBufPlain(Default, ldefault);
2219 putbstr("SortBy", Buf);
2223 if (!GetHash(SortHash, SKEY(BSort), &vSortBy) ||
2224 (vSortBy == NULL)) {
2226 if (!GetHash(SortHash, Default, ldefault, &vSortBy) ||
2227 (vSortBy == NULL)) {
2229 NULL, "Sorting", ERR_PARM1, TP,
2230 "Illegal default sort: [%s]", Default);
2234 SortBy = (SortStruct*)vSortBy;
2236 /** Ok, its us, lets see in which direction we should sort... */
2237 if (havebstr("SortOrder")) {
2238 SortOrder = LBSTR("SortOrder");
2240 else { /** Try to fallback to our remembered values... */
2242 if (SortBy->PrefPrepend == NULL) {
2243 Buf = get_room_pref("SortOrder");
2244 SortOrder = StrTol(Buf);
2247 BSort = get_X_PREFS(HKEY("SortOrder"), OtherPrefix, OtherPrefixLen);
2251 SortOrder = DefaultDirection;
2253 Buf = NewStrBufPlain(NULL, 64);
2254 StrBufPrintf(Buf, "%ld", SortOrder);
2255 putbstr("SortOrder", Buf);
2257 switch (SortOrder) {
2262 return SortBy->Forward;
2264 return SortBy->Reverse;
2276 ConstStr SortIcons[] = {
2277 {HKEY("static/sort_none.gif")},
2278 {HKEY("static/up_pointer.gif")},
2279 {HKEY("static/down_pointer.gif")},
2282 ConstStr SortNextOrder[] = {
2289 int GetSortMetric(WCTemplputParams *TP, SortStruct **Next, SortStruct **Param, long *SortOrder, int N)
2291 int bSortError = eNOT_SPECIFIED;
2292 const StrBuf *BSort;
2297 if (!GetHash(SortHash, TKEY(0), &vSort) ||
2299 return eNO_SUCH_SORT;
2300 *Param = (SortStruct*) vSort;
2303 if (havebstr("SortBy")) {
2304 BSort = sbstr("SortBy");
2305 bSortError = eINVALID_PARAM;
2306 if ((*Param)->PrefPrepend == NULL) {
2307 set_room_pref("sort", NewStrBufDup(BSort), 0);
2310 set_X_PREFS(HKEY("sort"), TKEY(N), NewStrBufDup(BSort), 0);
2313 else { /** Try to fallback to our remembered values... */
2314 if ((*Param)->PrefPrepend == NULL) {
2315 BSort = get_room_pref("sort");
2318 BSort = get_X_PREFS(HKEY("sort"), TKEY(N));
2322 if (!GetHash(SortHash, SKEY(BSort), &vSort) ||
2326 *Next = (SortStruct*) vSort;
2328 /** Ok, its us, lets see in which direction we should sort... */
2329 if (havebstr("SortOrder")) {
2330 *SortOrder = LBSTR("SortOrder");
2332 else { /** Try to fallback to our remembered values... */
2333 if ((*Param)->PrefPrepend == NULL) {
2334 *SortOrder = StrTol(get_room_pref("SortOrder"));
2337 *SortOrder = StrTol(get_X_PREFS(HKEY("SortOrder"), TKEY(N)));
2347 void tmplput_SORT_ICON(StrBuf *Target, WCTemplputParams *TP)
2352 const ConstStr *SortIcon;
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:
2362 LogTemplateError(NULL, "Sorter", ERR_PARM1, TP,
2363 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2365 case eNOT_SPECIFIED:
2367 if (Next == Param) {
2368 SortIcon = &SortIcons[SortOrder];
2370 else { /** Not Us... */
2371 SortIcon = &SortIcons[0];
2373 StrBufAppendBufPlain(Target, SortIcon->Key, SortIcon->len, 0);
2377 void tmplput_SORT_NEXT(StrBuf *Target, WCTemplputParams *TP)
2383 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2386 Target, "Sorter", ERR_PARM1, TP,
2387 " Sorter [%s] unknown!",
2388 TP->Tokens->Params[0]->Start);
2390 case eINVALID_PARAM:
2392 NULL, "Sorter", ERR_PARM1, TP,
2393 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2395 case eNOT_SPECIFIED:
2397 StrBufAppendBuf(Target, Param->Name, 0);
2402 void tmplput_SORT_ORDER(StrBuf *Target, WCTemplputParams *TP)
2405 const ConstStr *SortOrderStr;
2409 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2412 Target, "Sorter", ERR_PARM1, TP,
2413 " Sorter [%s] unknown!",
2414 TP->Tokens->Params[0]->Start);
2416 case eINVALID_PARAM:
2418 NULL, "Sorter", ERR_PARM1, TP,
2419 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2421 case eNOT_SPECIFIED:
2423 if (Next == Param) {
2424 SortOrderStr = &SortNextOrder[SortOrder];
2426 else { /** Not Us... */
2427 SortOrderStr = &SortNextOrder[0];
2429 StrBufAppendBufPlain(Target, SortOrderStr->Key, SortOrderStr->len, 0);
2434 void tmplput_long_vector(StrBuf *Target, WCTemplputParams *TP)
2436 long *LongVector = (long*) CTX;
2438 if ((TP->Tokens->Params[0]->Type == TYPE_LONG) &&
2439 (TP->Tokens->Params[0]->lvalue <= LongVector[0]))
2441 StrBufAppendPrintf(Target, "%ld", LongVector[TP->Tokens->Params[0]->lvalue]);
2445 if (TP->Tokens->Params[0]->Type != TYPE_LONG) {
2447 Target, "Longvector", ERR_NAME, TP,
2448 "needs a numerical Parameter!");
2452 Target, "LongVector", ERR_PARM1, TP,
2453 "doesn't have %ld Parameters, its just the size of %ld!",
2454 TP->Tokens->Params[0]->lvalue,
2460 void dbg_print_longvector(long *LongVector)
2462 StrBuf *Buf = NewStrBufPlain(HKEY("Longvector: ["));
2463 int nItems = LongVector[0];
2466 for (i = 0; i < nItems; i++) {
2468 StrBufAppendPrintf(Buf, "%d: %ld | ", i, LongVector[i]);
2470 StrBufAppendPrintf(Buf, "%d: %ld]\n", i, LongVector[i]);
2473 lprintf(1, ChrPtr(Buf));
2477 int ConditionalLongVector(StrBuf *Target, WCTemplputParams *TP)
2479 long *LongVector = (long*) CTX;
2481 if ((TP->Tokens->Params[2]->Type == TYPE_LONG) &&
2482 (TP->Tokens->Params[2]->lvalue <= LongVector[0])&&
2483 (TP->Tokens->Params[3]->Type == TYPE_LONG) &&
2484 (TP->Tokens->Params[3]->lvalue <= LongVector[0]))
2486 return LongVector[TP->Tokens->Params[2]->lvalue] ==
2487 LongVector[TP->Tokens->Params[3]->lvalue];
2491 if ((TP->Tokens->Params[2]->Type == TYPE_LONG) ||
2492 (TP->Tokens->Params[2]->Type == TYPE_LONG)) {
2494 Target, "ConditionalLongvector", ERR_PARM1, TP,
2495 "needs two long Parameter!");
2499 Target, "Longvector", ERR_PARM1, TP,
2500 "doesn't have %ld / %ld Parameters, its just the size of %ld!",
2501 TP->Tokens->Params[2]->lvalue,
2502 TP->Tokens->Params[3]->lvalue,
2513 memset(&NoCtx, 0, sizeof(WCTemplputParams));
2514 RegisterNamespace("SORT:ICON", 1, 2, tmplput_SORT_ICON, CTX_NONE);
2515 RegisterNamespace("SORT:ORDER", 1, 2, tmplput_SORT_ORDER, CTX_NONE);
2516 RegisterNamespace("SORT:NEXT", 1, 2, tmplput_SORT_NEXT, CTX_NONE);
2517 RegisterNamespace("CONTEXTSTR", 0, 1, tmplput_ContextString, CTX_STRBUF);
2518 RegisterNamespace("ITERATE", 2, 100, tmpl_iterate_subtmpl, CTX_NONE);
2519 RegisterNamespace("DOBOXED", 1, 2, tmpl_do_boxed, CTX_NONE);
2520 RegisterNamespace("DOTABBED", 2, 100, tmpl_do_tabbed, CTX_NONE);
2521 RegisterNamespace("LONGVECTOR", 1, 1, tmplput_long_vector, CTX_LONGVECTOR);
2522 RegisterConditional(HKEY("COND:SUBST"), 3, ConditionalVar, CTX_NONE);
2523 RegisterConditional(HKEY("COND:CONTEXTSTR"), 3, ConditionalContextStr, CTX_STRBUF);
2524 RegisterConditional(HKEY("COND:LONGVECTOR"), 4, ConditionalLongVector, CTX_LONGVECTOR);
2526 RegisterControlConditional(HKEY("COND:ITERATE:ISGROUPCHANGE"), 2,
2527 conditional_ITERATE_ISGROUPCHANGE,
2529 RegisterControlConditional(HKEY("COND:ITERATE:LASTN"), 2,
2530 conditional_ITERATE_LASTN,
2532 RegisterControlNS(HKEY("ITERATE:ODDEVEN"), 0, 0, tmplput_ITERATE_ODDEVEN, CTX_ITERATE);
2533 RegisterControlNS(HKEY("ITERATE:KEY"), 0, 0, tmplput_ITERATE_KEY, CTX_ITERATE);
2534 RegisterControlNS(HKEY("ITERATE:N"), 0, 0, tmplput_ITERATE_LASTN, CTX_ITERATE);
2538 ServerStartModule_SUBST
2541 WirelessTemplateCache = NewHash(1, NULL);
2542 WirelessLocalTemplateCache = NewHash(1, NULL);
2543 LocalTemplateCache = NewHash(1, NULL);
2544 TemplateCache = NewHash(1, NULL);
2546 GlobalNS = NewHash(1, NULL);
2547 Iterators = NewHash(1, NULL);
2548 Conditionals = NewHash(1, NULL);
2549 SortHash = NewHash(1, NULL);
2553 FinalizeModule_SUBST
2560 ServerShutdownModule_SUBST
2563 DeleteHash(&WirelessTemplateCache);
2564 DeleteHash(&WirelessLocalTemplateCache);
2565 DeleteHash(&TemplateCache);
2566 DeleteHash(&LocalTemplateCache);
2568 DeleteHash(&GlobalNS);
2569 DeleteHash(&Iterators);
2570 DeleteHash(&Conditionals);
2571 DeleteHash(&SortHash);
2577 SessionNewModule_SUBST
2584 SessionAttachModule_SUBST
2587 sess->vars = NewHash(1,NULL);
2591 SessionDetachModule_SUBST
2594 DeleteHash(&sess->vars);
2598 SessionDestroyModule_SUBST