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",
116 void DestroySortStruct(void *vSort)
118 SortStruct *Sort = (SortStruct*) vSort;
119 FreeStrBuf(&Sort->Name);
120 FreeStrBuf(&Sort->PrefPrepend);
124 const char *ContextName(int ContextType)
126 if (ContextType < CTX_UNKNOWN)
127 return CtxNames[ContextType];
129 return CtxNames[CTX_UNKNOWN];
132 void LogTemplateError (StrBuf *Target, const char *Type, int ErrorPos, WCTemplputParams *TP, const char *Format, ...)
139 const char *Err = NULL;
144 va_start(arg_ptr, Format);
145 StrBufVAppendPrintf(Error, Format, arg_ptr);
150 case ERR_NAME: /* the main token name... */
151 Err = (TP->Tokens!= NULL)? TP->Tokens->pName:"";
154 Err = (TP->Tokens!= NULL)? TP->Tokens->Params[0]->Start:"";
157 Err = (TP->Tokens!= NULL)? TP->Tokens->Params[1]->Start:"";
160 if (TP->Tokens != NULL)
162 lprintf(1, "%s [%s] (in '%s' line %ld); %s; [%s]\n",
165 ChrPtr(TP->Tokens->FileName),
168 ChrPtr(TP->Tokens->FlatToken));
172 lprintf(1, "%s: %s;\n",
184 Header = NewStrBuf();
185 if (TP->Tokens != NULL)
190 "<pre>\n%s [%s] (in '%s' line %ld); %s\n[%s]\n</pre>\n",
193 ChrPtr(TP->Tokens->FileName),
196 ChrPtr(TP->Tokens->FlatToken));
198 StrBufPrintf(Info, "%s [%s] %s; [%s]",
202 ChrPtr(TP->Tokens->FlatToken));
205 SerializeJson(Header, WildFireException(SKEY(TP->Tokens->FileName),
210 SerializeJson(Header, WildFireMessage(SKEY(TP->Tokens->FileName),
215 WildFireSerializePayload(Header, WCC->HBuf, &WCC->Hdr->nWildfireHeaders, NULL);
222 "<pre>\n%s: %s\n</pre>\n",
226 StrBufPrintf(Info, "%s [%s] %s; [%s]",
230 ChrPtr(TP->Tokens->FlatToken));
231 SerializeJson(Header, WildFireException(HKEY(__FILE__), __LINE__, Info, 1), 1);
232 WildFireSerializePayload(Header, WCC->HBuf, &WCC->Hdr->nWildfireHeaders, NULL);
238 if (dbg_bactrace_template_errors)
246 void LogError (StrBuf *Target, const char *Type, const char *Format, ...)
257 va_start(arg_ptr, Format);
258 StrBufVAppendPrintf(Error, Format, arg_ptr);
261 lprintf(1, ChrPtr(Error));
264 Header = NewStrBuf();
267 SerializeJson(Header, WildFireException(Type, strlen(Type),
271 WildFireSerializePayload(Header, WCC->HBuf, &WCC->Hdr->nWildfireHeaders, NULL);
277 if (dbg_bactrace_template_errors)
283 void RegisterNS(const char *NSName,
287 WCHandlerFunc HandlerFunc,
290 HashHandler *NewHandler;
292 NewHandler = (HashHandler*) malloc(sizeof(HashHandler));
293 NewHandler->Filter.nMinArgs = nMinArgs;
294 NewHandler->Filter.nMaxArgs = nMaxArgs;
295 NewHandler->Filter.ContextType = ContextRequired;
296 NewHandler->Filter.ControlContextType = CTX_NONE;
298 NewHandler->HandlerFunc = HandlerFunc;
299 Put(GlobalNS, NSName, len, NewHandler, NULL);
302 void RegisterControlNS(const char *NSName,
306 WCHandlerFunc HandlerFunc,
307 int ControlContextRequired)
309 HashHandler *NewHandler;
311 NewHandler = (HashHandler*) malloc(sizeof(HashHandler));
312 NewHandler->Filter.nMinArgs = nMinArgs;
313 NewHandler->Filter.nMaxArgs = nMaxArgs;
314 NewHandler->Filter.ContextType = CTX_NONE;
315 NewHandler->Filter.ControlContextType = ControlContextRequired;
316 NewHandler->HandlerFunc = HandlerFunc;
317 Put(GlobalNS, NSName, len, NewHandler, NULL);
322 int CheckContext(StrBuf *Target, ContextFilter *Need, WCTemplputParams *TP, const char *ErrType)
324 if ((Need->ContextType != CTX_NONE) &&
325 (Need->ContextType != TP->Filter.ContextType)) {
327 Target, ErrType, ERR_PARM1, TP,
328 " WARNING: requires Context: [%s], have [%s]!",
329 ContextName(Need->ContextType),
330 ContextName(TP->Filter.ContextType));
334 if ((Need->ControlContextType != CTX_NONE) &&
335 (Need->ControlContextType != TP->Filter.ControlContextType)) {
337 Target, ErrType, ERR_PARM1, TP,
338 " WARNING: requires Control Context: [%s], have [%s]!",
339 ContextName(Need->ControlContextType),
340 ContextName(TP->Filter.ControlContextType));
344 if (TP->Tokens->nParameters < Need->nMinArgs) {
345 LogTemplateError(Target, ErrType, ERR_NAME, TP,
346 "needs at least %ld params, have %ld",
348 TP->Tokens->nParameters);
352 else if (TP->Tokens->nParameters > Need->nMaxArgs) {
353 LogTemplateError(Target, ErrType, ERR_NAME, TP,
354 "just needs %ld params, you gave %ld",
356 TP->Tokens->nParameters);
364 void FreeToken(WCTemplateToken **Token)
367 FreeStrBuf(&(*Token)->FlatToken);
368 if ((*Token)->HaveParameters)
369 for (i = 0; i < (*Token)->nParameters; i++)
370 free((*Token)->Params[i]);
377 void FreeWCTemplate(void *vFreeMe)
380 WCTemplate *FreeMe = (WCTemplate*)vFreeMe;
382 if (FreeMe->TokenSpace > 0) {
383 for (i = 0; i < FreeMe->nTokensUsed; i ++) {
384 FreeToken(&FreeMe->Tokens[i]);
386 free(FreeMe->Tokens);
388 FreeStrBuf(&FreeMe->FileName);
389 FreeStrBuf(&FreeMe->Data);
390 FreeStrBuf(&FreeMe->MimeType);
396 * \brief debugging function to print array to log
398 void VarPrintTransition(void *vVar1, void *vVar2, int odd){}
400 * \brief debugging function to print array to log
402 void VarPrintEntry(const char *Key, void *vSubst, int odd)
405 lprintf(1,"Subst[%s] : ", Key);
406 ptr = (wcsubst*) vSubst;
408 switch(ptr->wcs_type) {
410 lprintf(1, " -> %s\n", ChrPtr(ptr->wcs_value));
413 lprintf(1, " -> Server [%s]\n", ChrPtr(ptr->wcs_value));
416 lprintf(1, " -> function at [%0xd]\n", ptr->wcs_function);
419 lprintf(1," WARNING: invalid type: [%ld]!\n", ptr->wcs_type);
426 * \brief Clear out the list of substitution variables local to this session
428 void clear_substs(wcsession *wc) {
430 if (wc->vars != NULL) {
431 DeleteHash(&wc->vars);
436 * \brief Clear out the list of substitution variables local to this session
438 void clear_local_substs(void) {
457 void FlushPayload(wcsubst *ptr, int reusestrbuf, int type)
459 int NeedNew = NeedNewBuf(type);
460 switch(ptr->wcs_type) {
464 if (reusestrbuf && NeedNew) {
465 FlushStrBuf(ptr->wcs_value);
469 FreeStrBuf(&ptr->wcs_value);
470 ptr->wcs_value = NULL;
474 ptr->wcs_function = NULL;
475 if (reusestrbuf && NeedNew)
476 ptr->wcs_value = NewStrBuf();
479 ptr->wcs_value = NULL;
480 if (reusestrbuf && NeedNew)
481 ptr->wcs_value = NewStrBuf();
485 if (reusestrbuf && NeedNew)
486 ptr->wcs_value = NewStrBuf();
489 if (reusestrbuf && NeedNew)
490 ptr->wcs_value = NewStrBuf();
497 * \brief destructor; kill one entry.
499 void deletevar(void *data)
501 wcsubst *ptr = (wcsubst*)data;
502 FlushPayload(ptr, 0, ptr->wcs_type);
507 wcsubst *NewSubstVar(const char *keyname, int keylen, int type)
512 ptr = (wcsubst *) malloc(sizeof(wcsubst));
513 memset(ptr, 0, sizeof(wcsubst));
515 ptr->wcs_type = type;
516 safestrncpy(ptr->wcs_key, keyname, sizeof ptr->wcs_key);
517 Put(WCC->vars, keyname, keylen, ptr, deletevar);
519 switch(ptr->wcs_type) {
522 ptr->wcs_value = NewStrBuf();
536 * \brief Add a substitution variable (local to this session) (strlen version...)
537 * \param keyname the replacementstring to substitute
538 * \param keytype the kind of the key
539 * \param format the format string ala printf
540 * \param ... the arguments to substitute in the formatstring
542 void SVPRINTF(char *keyname, int keytype, const char *format,...)
550 keylen = strlen(keyname);
552 * First look if we're doing a replacement of
555 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
556 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
557 ptr = (wcsubst*)vPtr;
558 FlushPayload(ptr, keytype, keytype);
559 ptr->wcs_type = keytype;
561 else /** Otherwise allocate a new one */
563 ptr = NewSubstVar(keyname, keylen, keytype);
566 /** Format the string */
567 va_start(arg_ptr, format);
568 StrBufVAppendPrintf(ptr->wcs_value, format, arg_ptr);
573 * \brief Add a substitution variable (local to this session)
574 * \param keyname the replacementstring to substitute
575 * \param keytype the kind of the key
576 * \param format the format string ala printf
577 * \param ... the arguments to substitute in the formatstring
579 void svprintf(char *keyname, size_t keylen, int keytype, const char *format,...)
587 * First look if we're doing a replacement of
590 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
591 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
592 ptr = (wcsubst*)vPtr;
593 FlushPayload(ptr, 1, keytype);
594 ptr->wcs_type = keytype;
596 else /** Otherwise allocate a new one */
598 ptr = NewSubstVar(keyname, keylen, keytype);
601 /** Format the string and save it */
602 va_start(arg_ptr, format);
603 StrBufVAppendPrintf(ptr->wcs_value, format, arg_ptr);
608 * \brief Add a substitution variable (local to this session)
609 * \param keyname the replacementstring to substitute
610 * \param keytype the kind of the key
611 * \param format the format string ala printf
612 * \param ... the arguments to substitute in the formatstring
614 void SVPut(char *keyname, size_t keylen, int keytype, char *Data)
622 * First look if we're doing a replacement of
625 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
626 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
627 ptr = (wcsubst*)vPtr;
628 FlushPayload(ptr, 1, keytype);
629 ptr->wcs_type = keytype;
631 else /** Otherwise allocate a new one */
633 ptr = NewSubstVar(keyname, keylen, keytype);
635 StrBufAppendBufPlain(ptr->wcs_value, Data, -1, 0);
639 * \brief Add a substitution variable (local to this session)
640 * \param keyname the replacementstring to substitute
641 * \param keytype the kind of the key
642 * \param format the format string ala printf
643 * \param ... the arguments to substitute in the formatstring
645 void SVPutLong(char *keyname, size_t keylen, long Data)
653 * First look if we're doing a replacement of
656 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
657 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
658 ptr = (wcsubst*)vPtr;
659 FlushPayload(ptr, 1, WCS_LONG);
660 ptr->wcs_type = WCS_LONG;
662 else /** Otherwise allocate a new one */
664 ptr = NewSubstVar(keyname, keylen, WCS_LONG);
670 * \brief Add a substitution variable (local to this session) that does a callback
671 * \param keyname the keystring to substitute
672 * \param fcn_ptr the function callback to give the substitution string
674 void SVCallback(char *keyname, size_t keylen, WCHandlerFunc fcn_ptr)
681 * First look if we're doing a replacement of
684 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
685 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
686 ptr = (wcsubst*)vPtr;
687 FlushPayload(ptr, 1, WCS_FUNCTION);
688 ptr->wcs_type = WCS_FUNCTION;
690 else /** Otherwise allocate a new one */
692 ptr = NewSubstVar(keyname, keylen, WCS_FUNCTION);
695 ptr->wcs_function = fcn_ptr;
697 inline void SVCALLBACK(char *keyname, WCHandlerFunc fcn_ptr)
699 SVCallback(keyname, strlen(keyname), fcn_ptr);
704 void SVPUTBuf(const char *keyname, int keylen, const StrBuf *Buf, int ref)
711 * First look if we're doing a replacement of
714 /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
715 if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
716 ptr = (wcsubst*)vPtr;
717 FlushPayload(ptr, 0, (ref)?WCS_STRBUF_REF:WCS_STRBUF);
718 ptr->wcs_type = (ref)?WCS_STRBUF_REF:WCS_STRBUF;
720 else /** Otherwise allocate a new one */
722 ptr = NewSubstVar(keyname, keylen, (ref)?WCS_STRBUF_REF:WCS_STRBUF);
724 ptr->wcs_value = (StrBuf*)Buf;
728 * \brief back end for print_value_of() ... does a server command
729 * \param servcmd server command to execute on the citadel server
731 void pvo_do_cmd(StrBuf *Target, StrBuf *servcmd) {
735 serv_puts(ChrPtr(servcmd));
736 len = serv_getln(buf, sizeof buf);
742 StrBufAppendPrintf(Target, "%s\n", &buf[4]);
745 _fmout(Target, "CENTER");
748 StrBufAppendPrintf(Target, "%s\n", &buf[4]);
754 void GetTemplateTokenString(StrBuf *Target,
755 WCTemplputParams *TP,
761 WCTemplputParams SubTP;
763 if (TP->Tokens->nParameters < N) {
764 LogTemplateError(Target,
765 "TokenParameter", N, TP,
766 "invalid token %d. this shouldn't have come till here.\n", N);
772 switch (TP->Tokens->Params[N]->Type) {
775 *Value = TP->Tokens->Params[N]->Start;
776 *len = TP->Tokens->Params[N]->len;
779 Buf = (StrBuf*) SBstr(TKEY(N));
780 *Value = ChrPtr(Buf);
781 *len = StrLength(Buf);
784 get_PREFERENCE(TKEY(N), &Buf);
785 *Value = ChrPtr(Buf);
786 *len = StrLength(Buf);
789 LogTemplateError(Target,
790 "TokenParameter", N, TP,
791 "Requesting parameter %d; of type LONG, want string.", N);
794 LogTemplateError(Target,
795 "TokenParameter", N, TP,
796 "Requesting parameter %d; of type PREFINT, want string.", N);
799 *Value = _(TP->Tokens->Params[N]->Start);
800 *len = strlen(*Value);
802 case TYPE_SUBTEMPLATE:
803 memset(&SubTP, 0, sizeof(WCTemplputParams *));
804 SubTP.Context = TP->Context;
805 SubTP.Filter.ContextType = TP->Filter.ContextType;
807 DoTemplate(TKEY(N), Buf, &SubTP);
808 *Value = ChrPtr(Buf);
809 *len = StrLength(Buf);
810 /* we can't free it here, so we put it into the subst so its discarded later on. */
811 SVPUTBuf(TKEY(N), Buf, 0);
815 LogTemplateError(Target,
816 "TokenParameter", N, TP,
817 "unknown param type %d; [%d]", N, TP->Tokens->Params[N]->Type);
822 long GetTemplateTokenNumber(StrBuf *Target, WCTemplputParams *TP, int N, long dflt)
825 if (TP->Tokens->nParameters < N) {
826 LogTemplateError(Target,
827 "TokenParameter", N, TP,
828 "invalid token %d. this shouldn't have come till here.\n", N);
833 switch (TP->Tokens->Params[N]->Type) {
836 return atol(TP->Tokens->Params[N]->Start);
839 return LBstr(TKEY(N));
842 LogTemplateError(Target,
843 "TokenParameter", N, TP,
844 "requesting a prefstring in param %d want a number", N);
845 if (get_PREF_LONG(TKEY(N), &Ret, dflt))
849 return TP->Tokens->Params[N]->lvalue;
851 if (get_PREF_LONG(TKEY(N), &Ret, dflt))
855 LogTemplateError(Target,
856 "TokenParameter", N, TP,
857 "requesting a I18N string in param %d; want a number", N);
859 case TYPE_SUBTEMPLATE:
860 LogTemplateError(Target,
861 "TokenParameter", N, TP,
862 "requesting a subtemplate in param %d; not supported for numbers", N);
865 LogTemplateError(Target,
866 "TokenParameter", N, TP,
867 "unknown param type %d; [%d]", N, TP->Tokens->Params[N]->Type);
875 * \brief Print the value of a variable
876 * \param keyname get a key to print
878 void print_value_of(StrBuf *Target, WCTemplputParams *TP)
885 /*if (WCC->vars != NULL) PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
886 /* TODO: depricated! */
887 if (TP->Tokens->pName[0] == '=') {
888 DoTemplate(TP->Tokens->pName+1, TP->Tokens->NameEnd - 1, NULL, &NoCtx);
890 /*/////TODO: if param[1] == "U" -> urlescape
892 /** Page-local variables */
893 if ((WCC->vars!= NULL) && GetHash(WCC->vars, TP->Tokens->pName, TP->Tokens->NameEnd, &vVar)) {
894 ptr = (wcsubst*) vVar;
895 switch(ptr->wcs_type) {
897 StrBufAppendBuf(Target, ptr->wcs_value, 0);
900 pvo_do_cmd(Target, ptr->wcs_value);
903 (*ptr->wcs_function) (Target, TP);
907 StrBufAppendBuf(Target, ptr->wcs_value, 0);
910 StrBufAppendPrintf(Target, "%ld", ptr->lvalue);
914 Target, "Subst", ERR_NAME, TP,
915 "WARNING: invalid value in SV-Hash at %s!", TP->Tokens->pName);
920 Target, "Token", ERR_NAME, TP,
921 "didn't find Handler \"%s\"", TP->Tokens->pName);
926 int CompareSubstToToken(TemplateParam *ParamToCompare, TemplateParam *ParamToLookup)
932 if ((WCC->vars!= NULL) && GetHash(WCC->vars, ParamToLookup->Start,
933 ParamToLookup->len, &vVar)) {
934 ptr = (wcsubst*) vVar;
935 switch(ptr->wcs_type) {
939 if (ParamToCompare->Type == TYPE_STR)
940 return ((ParamToCompare->len == StrLength(ptr->wcs_value)) &&
941 (strcmp(ParamToCompare->Start, ChrPtr(ptr->wcs_value)) == 0));
943 return ParamToCompare->lvalue == StrTol(ptr->wcs_value);
951 if (ParamToCompare->Type == TYPE_STR)
954 return ParamToCompare->lvalue == ptr->lvalue;
957 lprintf(1,"WARNING: invalid value in SV-Hash at %s!\n",
958 ParamToLookup->Start);
964 int CompareSubstToStrBuf(StrBuf *Compare, TemplateParam *ParamToLookup)
970 if ((WCC->vars!= NULL) && GetHash(WCC->vars, ParamToLookup->Start,
971 ParamToLookup->len, &vVar)) {
972 ptr = (wcsubst*) vVar;
973 switch(ptr->wcs_type) {
977 return ((StrLength(Compare) == StrLength(ptr->wcs_value)) &&
978 (strcmp(ChrPtr(Compare), ChrPtr(ptr->wcs_value)) == 0));
985 return StrTol(Compare) == ptr->lvalue;
987 lprintf(1,"WARNING: invalid value in SV-Hash at %s!\n",
988 ParamToLookup->Start);
997 * \brief puts string into the template and computes which escape methon we should use
998 * \param Source the string we should put into the template
999 * \param FormatTypeIndex where should we look for escape types if?
1001 void StrBufAppendTemplate(StrBuf *Target,
1002 WCTemplputParams *TP,
1003 const StrBuf *Source, int FormatTypeIndex)
1006 char EscapeAs = ' ';
1008 if ((FormatTypeIndex < TP->Tokens->nParameters) &&
1009 (TP->Tokens->Params[FormatTypeIndex]->Type == TYPE_STR) &&
1010 (TP->Tokens->Params[FormatTypeIndex]->len == 1)) {
1011 EscapeAs = *TP->Tokens->Params[FormatTypeIndex]->Start;
1018 StrEscAppend(Target, Source, NULL, 0, 2);
1021 StrEscAppend(Target, Source, NULL, 0, 0);
1024 StrECMAEscAppend(Target, Source, NULL);
1027 StrBufUrlescAppend(Target, Source, NULL);
1030 StrBufAppendBuf(Target, Source, 0);
1035 void PutNewToken(WCTemplate *Template, WCTemplateToken *NewToken)
1037 if (Template->nTokensUsed + 1 >= Template->TokenSpace) {
1038 if (Template->TokenSpace <= 0) {
1039 Template->Tokens = (WCTemplateToken**)malloc(
1040 sizeof(WCTemplateToken*) * 10);
1041 Template->TokenSpace = 10;
1044 WCTemplateToken **NewTokens;
1045 NewTokens= (WCTemplateToken**)malloc(
1046 sizeof(WCTemplateToken*) *
1047 Template->TokenSpace * 2);
1048 memcpy(NewTokens, Template->Tokens,
1049 sizeof(WCTemplateToken*) * Template->nTokensUsed);
1050 free(Template->Tokens);
1051 Template->TokenSpace *= 2;
1052 Template->Tokens = NewTokens;
1055 Template->Tokens[(Template->nTokensUsed)++] = NewToken;
1058 TemplateParam *GetNextParameter(StrBuf *Buf, const char **pCh, const char *pe, WCTemplateToken *Tokens, WCTemplate *pTmpl)
1060 const char *pch = *pCh;
1061 const char *pchs, *pche;
1062 TemplateParam *Parm = (TemplateParam *) malloc(sizeof(TemplateParam));
1066 Parm->Type = TYPE_STR;
1068 /* Skip leading whitespaces */
1069 while ((*pch == ' ' )||
1072 (*pch == '\n')) pch ++;
1075 Parm->Type = TYPE_PREFSTR;
1082 else if (*pch == ';') {
1083 Parm->Type = TYPE_PREFINT;
1090 else if (*pch == '_') {
1091 Parm->Type = TYPE_GETTEXT;
1098 else if (*pch == 'B') {
1099 Parm->Type = TYPE_BSTR;
1106 else if (*pch == '=') {
1107 Parm->Type = TYPE_SUBTEMPLATE;
1118 else if (*pch == '\'')
1120 if (quote != '\0') {
1125 ( (pch > pchs) && (*(pch - 1) == '\\'))
1130 if (*pch != quote) {
1131 lprintf(1, "Error (in '%s' line %ld); "
1132 "evaluating template param [%s] in Token [%s]\n",
1133 ChrPtr(pTmpl->FileName),
1135 ChrPtr(Tokens->FlatToken),
1142 StrBufPeek(Buf, pch, -1, '\0');
1143 if (LoadTemplates > 1) {
1144 lprintf(1, "DBG: got param [%s] %ld %ld\n",
1145 pchs, pche - pchs, strlen(pchs));
1148 Parm->len = pche - pchs;
1149 pch ++; /* move after trailing quote */
1150 if (ParamBrace && (*pch == ')')) {
1157 Parm->Type = TYPE_LONG;
1159 while ((pch <= pe) &&
1165 if (pch - pchs > 1){
1166 StrBufPeek(Buf, pch, -1, '\0');
1167 Parm->lvalue = atol(pchs);
1174 lprintf(1, "Error (in '%s' line %ld); "
1175 "evaluating long template param [%s] in Token [%s]\n",
1176 ChrPtr(pTmpl->FileName),
1178 ChrPtr(Tokens->FlatToken),
1185 while ((*pch == ' ' )||
1189 (*pch == '\n')) pch ++;
1191 if (DumpTemplateI18NStrings && (Parm->Type == TYPE_GETTEXT)) {
1192 StrBufAppendPrintf(I18nDump, "_(\"%s\");\n", Parm->Start);
1198 WCTemplateToken *NewTemplateSubstitute(StrBuf *Buf,
1200 const char *pTmplStart,
1201 const char *pTmplEnd,
1207 TemplateParam *Param;
1208 WCTemplateToken *NewToken = (WCTemplateToken*)malloc(sizeof(WCTemplateToken));
1209 WCTemplputParams TP;
1211 TP.Tokens = NewToken;
1212 NewToken->FileName = pTmpl->FileName; /* to print meaningfull log messages... */
1213 NewToken->Flags = 0;
1214 NewToken->Line = Line + 1;
1215 NewToken->pTokenStart = pTmplStart;
1216 NewToken->TokenStart = pTmplStart - pStart;
1217 NewToken->TokenEnd = (pTmplEnd - pStart) - NewToken->TokenStart;
1218 NewToken->pTokenEnd = pTmplEnd;
1219 NewToken->NameEnd = NewToken->TokenEnd - 2;
1220 NewToken->PreEval = NULL;
1221 NewToken->FlatToken = NewStrBufPlain(pTmplStart + 2, pTmplEnd - pTmplStart - 2);
1223 StrBufPeek(Buf, pTmplStart, + 1, '\0');
1224 StrBufPeek(Buf, pTmplEnd, -1, '\0');
1225 pch = NewToken->pName = pTmplStart + 2;
1227 NewToken->HaveParameters = 0;;
1228 NewToken->nParameters = 0;
1230 while (pch < pTmplEnd - 1) {
1232 StrBufPeek(Buf, pch, -1, '\0');
1233 NewToken->NameEnd = pch - NewToken->pName;
1235 if (*(pTmplEnd - 1) != ')') {
1237 NULL, "Parseerror", ERR_NAME, &TP,
1238 "Warning, Non welformed Token; missing right parenthesis");
1240 while (pch < pTmplEnd - 1) {
1241 Param = GetNextParameter(Buf, &pch, pTmplEnd - 1, NewToken, pTmpl);
1242 if (Param != NULL) {
1243 NewToken->HaveParameters = 1;
1244 if (NewToken->nParameters > MAXPARAM) {
1246 NULL, "Parseerror", ERR_NAME, &TP,
1247 "only [%d] Params allowed in Tokens",
1251 FreeToken(&NewToken);
1254 NewToken->Params[NewToken->nParameters++] = Param;
1258 if((NewToken->NameEnd == 1) &&
1259 (NewToken->HaveParameters == 1))
1262 if (*(NewToken->pName) == '_')
1263 NewToken->Flags = SV_GETTEXT;
1264 else if (*(NewToken->pName) == '=')
1265 NewToken->Flags = SV_SUBTEMPL;
1266 else if (*(NewToken->pName) == '%')
1267 NewToken->Flags = SV_CUST_STR_CONDITIONAL;
1268 else if (*(NewToken->pName) == '?')
1269 NewToken->Flags = SV_CONDITIONAL;
1270 else if (*(NewToken->pName) == '!')
1271 NewToken->Flags = SV_NEG_CONDITIONAL;
1277 switch (NewToken->Flags) {
1279 /* If we're able to find out more about the token, do it now while its fresh. */
1280 if (GetHash(GlobalNS, NewToken->pName, NewToken->NameEnd, &vVar)) {
1281 HashHandler *Handler;
1282 Handler = (HashHandler*) vVar;
1283 if ((NewToken->nParameters < Handler->Filter.nMinArgs) ||
1284 (NewToken->nParameters > Handler->Filter.nMaxArgs)) {
1286 NULL, "Token", ERR_NAME, &TP,
1287 "doesn't work with %d params",
1288 NewToken->nParameters);
1292 NewToken->PreEval = Handler;
1293 NewToken->Flags = SV_PREEVALUATED;
1298 if (NewToken->nParameters !=1) {
1300 NULL, "Gettext", ERR_NAME, &TP,
1301 "requires exactly 1 parameter, you gave %d params",
1302 NewToken->nParameters);
1303 NewToken->Flags = 0;
1306 if (DumpTemplateI18NStrings) {
1307 StrBufAppendPrintf(I18nDump, "_(\"%s\");\n", NewToken->Params[0]->Start);
1311 if (NewToken->nParameters != 1) {
1313 NULL, "Subtemplates", ERR_NAME, &TP,
1314 "require exactly 1 parameter, you gave %d params",
1315 NewToken->nParameters);
1319 case SV_CUST_STR_CONDITIONAL:
1320 case SV_CONDITIONAL:
1321 case SV_NEG_CONDITIONAL:
1322 if (NewToken->nParameters <2) {
1324 NULL, "Conditional", ERR_NAME, &TP,
1325 "require at least 2 parameters, you gave %d params",
1326 NewToken->nParameters);
1327 NewToken->Flags = 0;
1330 if (NewToken->Params[1]->lvalue == 0) {
1332 NULL, "Conditional", ERR_NAME, &TP,
1333 "Conditional ID (Parameter 1) mustn't be 0!");
1334 NewToken->Flags = 0;
1337 if (!GetHash(Conditionals,
1338 NewToken->Params[0]->Start,
1339 NewToken->Params[0]->len,
1342 if ((NewToken->Params[0]->len == 1) &&
1343 (NewToken->Params[0]->Start[0] == 'X'))
1346 NULL, "Conditional", ERR_NAME, &TP,
1349 NewToken->Error = NewStrBuf();
1352 "<pre>\nConditional [%s] (in '%s' line %ld); Not found!\n[%s]\n</pre>\n",
1353 NewToken->Params[0]->Start,
1354 ChrPtr(pTmpl->FileName),
1356 ChrPtr(NewToken->FlatToken));
1360 NewToken->PreEval = vVar;
1372 * \brief Display a variable-substituted template
1373 * \param templatename template file to load
1375 void *prepare_template(StrBuf *filename, StrBuf *Key, HashList *PutThere)
1377 WCTemplate *NewTemplate;
1378 NewTemplate = (WCTemplate *) malloc(sizeof(WCTemplate));
1379 NewTemplate->Data = NULL;
1380 NewTemplate->FileName = NewStrBufDup(filename);
1381 NewTemplate->nTokensUsed = 0;
1382 NewTemplate->TokenSpace = 0;
1383 NewTemplate->Tokens = NULL;
1384 NewTemplate->MimeType = NewStrBufPlain(GuessMimeByFilename (SKEY(NewTemplate->FileName)), -1);
1385 if (strstr(ChrPtr(NewTemplate->MimeType), "text") != NULL) {
1386 StrBufAppendBufPlain(NewTemplate->MimeType, HKEY("; charset=utf-8"), 0);
1389 Put(PutThere, ChrPtr(Key), StrLength(Key), NewTemplate, FreeWCTemplate);
1394 * \brief Display a variable-substituted template
1395 * \param templatename template file to load
1397 void *load_template(StrBuf *filename, StrBuf *Key, HashList *PutThere)
1400 struct stat statbuf;
1401 const char *pS, *pE, *pch, *Err;
1404 WCTemplate *NewTemplate;
1406 fd = open(ChrPtr(filename), O_RDONLY);
1408 lprintf(1, "ERROR: could not open template '%s' - %s\n",
1409 ChrPtr(filename), strerror(errno));
1413 if (fstat(fd, &statbuf) == -1) {
1414 lprintf(1, "ERROR: could not stat template '%s' - %s\n",
1415 ChrPtr(filename), strerror(errno));
1419 NewTemplate = (WCTemplate *) malloc(sizeof(WCTemplate));
1420 NewTemplate->Data = NewStrBufPlain(NULL, statbuf.st_size);
1421 NewTemplate->FileName = NewStrBufDup(filename);
1422 NewTemplate->nTokensUsed = 0;
1423 NewTemplate->TokenSpace = 0;
1424 NewTemplate->Tokens = NULL;
1425 NewTemplate->MimeType = NewStrBufPlain(GuessMimeByFilename (SKEY(NewTemplate->FileName)), -1);
1426 if (strstr(ChrPtr(NewTemplate->MimeType), "text") != NULL) {
1427 StrBufAppendBufPlain(NewTemplate->MimeType, HKEY("; charset=utf-8"), 0);
1430 if (StrBufReadBLOB(NewTemplate->Data, &fd, 1, statbuf.st_size, &Err) < 0) {
1432 FreeWCTemplate(NewTemplate);
1433 lprintf(1, "ERROR: reading template '%s' - %s<br />\n",
1434 ChrPtr(filename), strerror(errno));
1440 StrBufShrinkToFit(NewTemplate->Data, 1);
1441 pS = pch = ChrPtr(NewTemplate->Data);
1442 pE = pS + StrLength(NewTemplate->Data);
1444 const char *pts, *pte;
1446 int InDoubleQuotes = 0;
1448 /** Find one <? > */
1450 for (; pch < pE; pch ++) {
1451 if ((*pch=='<')&&(*(pch + 1)=='?'))
1453 if (*pch=='\n') Line ++;
1459 /** Found one? parse it. */
1460 for (; pch <= pE - 1; pch ++) {
1462 InDoubleQuotes = ! InDoubleQuotes;
1463 else if (*pch == '\'')
1464 InQuotes = ! InQuotes;
1465 else if ((!InQuotes && !InDoubleQuotes) &&
1466 ((*pch!='\\')&&(*(pch + 1)=='>'))) {
1474 PutNewToken(NewTemplate,
1475 NewTemplateSubstitute(NewTemplate->Data, pS, pts, pte, Line, NewTemplate));
1478 if (LoadTemplates == 0)
1479 Put(PutThere, ChrPtr(Key), StrLength(Key), NewTemplate, FreeWCTemplate);
1484 const char* PrintTemplate(void *vSubst)
1486 WCTemplate *Tmpl = vSubst;
1488 return ChrPtr(Tmpl->FileName);
1492 int LoadTemplateDir(const char *DirName, HashList *wireless, HashList *big)
1497 DIR *filedir = NULL;
1498 struct dirent *filedir_entry;
1504 StrBufPrintf(Dir, "%s/t", DirName);
1505 filedir = opendir (ChrPtr(Dir));
1506 if (filedir == NULL) {
1511 FileName = NewStrBuf();
1513 while ((filedir_entry = readdir(filedir)))
1517 #ifdef _DIRENT_HAVE_D_NAMELEN
1518 d_namelen = filedir_entry->d_namelen;
1520 d_namelen = strlen(filedir_entry->d_name);
1522 d_without_ext = d_namelen;
1523 while ((d_without_ext > 0) && (filedir_entry->d_name[d_without_ext] != '.'))
1525 if ((d_without_ext == 0) || (d_namelen < 3))
1527 if ((d_namelen > 1) && filedir_entry->d_name[d_namelen - 1] == '~')
1528 continue; /* Ignore backup files... */
1530 IsMobile = (strstr(filedir_entry->d_name, ".m.html")!= NULL);
1531 PStart = filedir_entry->d_name;
1532 StrBufPrintf(FileName, "%s/%s", ChrPtr(Dir), filedir_entry->d_name);
1533 MinorPtr = strchr(filedir_entry->d_name, '.');
1534 if (MinorPtr != NULL)
1536 StrBufPlain(Tag, filedir_entry->d_name, MinorPtr - filedir_entry->d_name);
1538 if (LoadTemplates > 1)
1539 lprintf(1, "%s %d %s\n",ChrPtr(FileName), IsMobile, ChrPtr(Tag));
1540 if (LoadTemplates == 0)
1541 load_template(FileName, Tag, (IsMobile)?wireless:big);
1543 prepare_template(FileName, Tag, (IsMobile)?wireless:big);
1546 FreeStrBuf(&FileName);
1552 void InitTemplateCache(void)
1554 LoadTemplateDir(static_dirs[0],
1555 WirelessTemplateCache,
1557 LoadTemplateDir(static_dirs[1],
1558 WirelessLocalTemplateCache,
1559 LocalTemplateCache);
1564 /*-----------------------------------------------------------------------------
1565 * Filling & processing Templates
1568 * \brief executes one token
1569 * \param Target buffer to append to
1570 * \param Token da to process.
1571 * \param Template we're iterating
1572 * \param Context Contextpoointer to pass in
1573 * \param state are we in conditional state?
1574 * \param ContextType what type of information does context giv us?
1576 int EvaluateToken(StrBuf *Target, int state, WCTemplputParams *TP)
1578 const char *AppendMe;
1580 HashHandler *Handler;
1583 /* much output, since pName is not terminated...
1584 lprintf(1,"Doing token: %s\n",Token->pName);
1587 switch (TP->Tokens->Flags) {
1589 TmplGettext(Target, TP);
1591 case SV_CONDITIONAL: /** Forward conditional evaluation */
1592 return EvaluateConditional(Target, 1, state, TP);
1594 case SV_NEG_CONDITIONAL: /** Reverse conditional evaluation */
1595 return EvaluateConditional(Target, 0, state, TP);
1597 case SV_CUST_STR_CONDITIONAL: /** Conditional put custom strings from params */
1598 if (TP->Tokens->nParameters >= 6) {
1599 if (EvaluateConditional(Target, 0, state, TP)) {
1600 GetTemplateTokenString(Target, TP, 5, &AppendMe, &AppendMeLen);
1601 StrBufAppendBufPlain(Target,
1607 GetTemplateTokenString(Target, TP, 4, &AppendMe, &AppendMeLen);
1608 StrBufAppendBufPlain(Target,
1616 Target, "Conditional", ERR_NAME, TP,
1617 "needs at least 6 Params!");
1621 if (TP->Tokens->nParameters == 1)
1622 DoTemplate(TKEY(0), Target, TP);
1624 case SV_PREEVALUATED:
1625 Handler = (HashHandler*) TP->Tokens->PreEval;
1626 if (!CheckContext(Target, &Handler->Filter, TP, "Token")) {
1629 Handler->HandlerFunc(Target, TP);
1632 if (GetHash(GlobalNS, TP->Tokens->pName, TP->Tokens->NameEnd, &vVar)) {
1633 Handler = (HashHandler*) vVar;
1634 if (!CheckContext(Target, &Handler->Filter, TP, "Token")) {
1638 Handler->HandlerFunc(Target, TP);
1642 print_value_of(Target, TP);
1650 const StrBuf *ProcessTemplate(WCTemplate *Tmpl, StrBuf *Target, WCTemplputParams *CallingTP)
1652 WCTemplate *pTmpl = Tmpl;
1655 const char *pData, *pS;
1657 WCTemplputParams TP;
1659 memcpy(&TP.Filter, &CallingTP->Filter, sizeof(ContextFilter));
1661 TP.Context = CallingTP->Context;
1662 TP.ControlContext = CallingTP->ControlContext;
1664 if (LoadTemplates != 0) {
1665 if (LoadTemplates > 1)
1666 lprintf(1, "DBG: ----- loading: [%s] ------ \n",
1667 ChrPtr(Tmpl->FileName));
1669 pTmpl = load_template(Tmpl->FileName, NULL, NULL);
1673 "<pre>\nError loading Template [%s]\n See Logfile for details\n</pre>\n",
1674 ChrPtr(Tmpl->FileName));
1680 pS = pData = ChrPtr(pTmpl->Data);
1681 len = StrLength(pTmpl->Data);
1685 if (i >= pTmpl->nTokensUsed) {
1686 StrBufAppendBufPlain(Target,
1688 len - (pData - pS), 0);
1692 StrBufAppendBufPlain(
1694 pTmpl->Tokens[i]->pTokenStart - pData, 0);
1695 TP.Tokens = pTmpl->Tokens[i];
1696 TP.nArgs = pTmpl->Tokens[i]->nParameters;
1697 state = EvaluateToken(Target, state, &TP);
1699 while ((state != 0) && (i+1 < pTmpl->nTokensUsed)) {
1700 /* condition told us to skip till its end condition */
1702 TP.Tokens = pTmpl->Tokens[i];
1703 TP.nArgs = pTmpl->Tokens[i]->nParameters;
1704 if ((pTmpl->Tokens[i]->Flags == SV_CONDITIONAL) ||
1705 (pTmpl->Tokens[i]->Flags == SV_NEG_CONDITIONAL)) {
1706 if (state == EvaluateConditional(
1708 pTmpl->Tokens[i]->Flags,
1714 pData = pTmpl->Tokens[i++]->pTokenEnd + 1;
1715 if (i > pTmpl->nTokensUsed)
1719 if (LoadTemplates != 0) {
1720 FreeWCTemplate(pTmpl);
1722 return Tmpl->MimeType;
1727 * \brief Display a variable-substituted template
1728 * \param templatename template file to load
1729 * \returns the mimetype of the template its doing
1731 const StrBuf *DoTemplate(const char *templatename, long len, StrBuf *Target, WCTemplputParams *TP)
1733 WCTemplputParams LocalTP;
1735 HashList *StaticLocal;
1741 memset(&LocalTP, 0, sizeof(WCTemplputParams));
1745 if (WC->is_mobile) {
1746 Static = WirelessTemplateCache;
1747 StaticLocal = WirelessLocalTemplateCache;
1750 Static = TemplateCache;
1751 StaticLocal = LocalTemplateCache;
1756 lprintf (1, "Can't to load a template with empty name!\n");
1757 StrBufAppendPrintf(Target, "<pre>\nCan't to load a template with empty name!\n</pre>");
1761 if (!GetHash(StaticLocal, templatename, len, &vTmpl) &&
1762 !GetHash(Static, templatename, len, &vTmpl)) {
1763 lprintf (1, "didn't find Template [%s] %ld %ld\n", templatename, len , (long)strlen(templatename));
1764 StrBufAppendPrintf(Target, "<pre>\ndidn't find Template [%s] %ld %ld\n</pre>",
1766 (long)strlen(templatename));
1768 dbg_PrintHash(Static, PrintTemplate, NULL);
1769 PrintHash(Static, VarPrintTransition, PrintTemplate);
1775 return ProcessTemplate(vTmpl, Target, TP);
1779 /*-----------------------------------------------------------------------------
1782 typedef struct _HashIterator {
1783 HashList *StaticList;
1784 int AdditionalParams;
1786 int XPectContextType;
1788 RetrieveHashlistFunc GetHash;
1789 HashDestructorFunc Destructor;
1790 SubTemplFunc DoSubTemplate;
1793 void RegisterITERATOR(const char *Name, long len,
1794 int AdditionalParams,
1795 HashList *StaticList,
1796 RetrieveHashlistFunc GetHash,
1797 SubTemplFunc DoSubTempl,
1798 HashDestructorFunc Destructor,
1800 int XPectContextType,
1803 HashIterator *It = (HashIterator*)malloc(sizeof(HashIterator));
1804 It->StaticList = StaticList;
1805 It->AdditionalParams = AdditionalParams;
1806 It->GetHash = GetHash;
1807 It->DoSubTemplate = DoSubTempl;
1808 It->Destructor = Destructor;
1809 It->ContextType = ContextType;
1810 It->XPectContextType = XPectContextType;
1812 Put(Iterators, Name, len, It, NULL);
1815 typedef struct _iteratestruct {
1824 void tmpl_iterate_subtmpl(StrBuf *Target, WCTemplputParams *TP)
1830 SortStruct *SortBy = NULL;
1832 int DetectGroupChange = 0;
1835 void *vLastContext = NULL;
1837 WCTemplputParams SubTP;
1838 IterateStruct Status;
1844 memset(&Status, 0, sizeof(IterateStruct));
1845 memcpy (&SubTP, &TP, sizeof(WCTemplputParams));
1847 if (!GetHash(Iterators, TKEY(0), &vIt)) {
1849 Target, "Iterator", ERR_PARM1, TP, "Unknown!");
1853 It = (HashIterator*) vIt;
1855 if (TP->Tokens->nParameters < It->AdditionalParams + 2) {
1857 Target, "Iterator", ERR_PARM1, TP,
1858 "doesn't work with %d params",
1859 TP->Tokens->nParameters);
1863 if ((It->XPectContextType != CTX_NONE) &&
1864 (It->XPectContextType != TP->Filter.ContextType)) {
1866 Target, "Iterator", ERR_PARM1, TP,
1867 "requires context of type %d, have %d",
1868 It->XPectContextType,
1869 TP->Filter.ContextType);
1874 if (It->StaticList == NULL)
1875 List = It->GetHash(Target, TP);
1877 List = It->StaticList;
1879 DetectGroupChange = (It->Flags & IT_FLAG_DETECT_GROUPCHANGE) != 0;
1880 if (DetectGroupChange) {
1881 const StrBuf *BSort;
1882 DetectGroupChange = 0;
1883 if (havebstr("SortBy")) {
1884 BSort = sbstr("SortBy");
1885 if (GetHash(SortHash, SKEY(BSort), &vSortBy) &&
1886 (vSortBy != NULL)) {
1887 SortBy = (SortStruct*)vSortBy;
1888 /** Ok, its us, lets see in which direction we should sort... */
1889 if (havebstr("SortOrder")) {
1891 SortOrder = LBSTR("SortOrder");
1893 DetectGroupChange = 1;
1898 nMembersUsed = GetCount(List);
1899 SubBuf = NewStrBuf();
1900 SubTP.Filter.ContextType = It->ContextType;
1901 SubTP.Filter.ControlContextType = CTX_ITERATE;
1902 SubTP.ControlContext = &Status;
1904 if (HAVE_PARAM(2)) {
1905 StartAt = GetTemplateTokenNumber(Target, TP, 2, 0);
1907 if (HAVE_PARAM(3)) {
1908 StepWidth = GetTemplateTokenNumber(Target, TP, 3, 0);
1910 if (HAVE_PARAM(4)) {
1911 StopAt = GetTemplateTokenNumber(Target, TP, 4, -1);
1913 it = GetNewHashPos(List, StepWidth);
1915 StopAt = GetCount(List);
1917 while (GetNextHashPos(List, it, &Status.KeyLen, &Status.Key, &vContext)) {
1918 if ((Status.n >= StartAt) && (Status.n <= StopAt)) {
1919 if (DetectGroupChange && Status.n > 0) {
1920 Status.GroupChange = (SortBy->GroupChange(vContext, vLastContext))? 1:0;
1922 Status.LastN = (Status.n + 1) == nMembersUsed;
1923 SubTP.Context = vContext;
1924 if (It->DoSubTemplate != NULL)
1925 It->DoSubTemplate(SubBuf, &SubTP);
1926 DoTemplate(TKEY(1), SubBuf, &SubTP);
1928 StrBufAppendBuf(Target, SubBuf, 0);
1929 FlushStrBuf(SubBuf);
1930 Status.oddeven = ! Status.oddeven;
1931 vLastContext = vContext;
1935 FreeStrBuf(&SubBuf);
1937 if (It->Destructor != NULL)
1938 It->Destructor(&List);
1942 int conditional_ITERATE_ISGROUPCHANGE(StrBuf *Target, WCTemplputParams *TP)
1944 IterateStruct *Ctx = CCTX;
1945 return Ctx->GroupChange;
1948 void tmplput_ITERATE_ODDEVEN(StrBuf *Target, WCTemplputParams *TP)
1950 IterateStruct *Ctx = CCTX;
1952 StrBufAppendBufPlain(Target, HKEY("odd"), 0);
1954 StrBufAppendBufPlain(Target, HKEY("even"), 0);
1958 void tmplput_ITERATE_KEY(StrBuf *Target, WCTemplputParams *TP)
1960 IterateStruct *Ctx = CCTX;
1962 StrBufAppendBufPlain(Target, Ctx->Key, Ctx->KeyLen, 0);
1966 void tmplput_ITERATE_LASTN(StrBuf *Target, WCTemplputParams *TP)
1968 IterateStruct *Ctx = CCTX;
1969 StrBufAppendPrintf(Target, "%d", Ctx->n);
1972 int conditional_ITERATE_LASTN(StrBuf *Target, WCTemplputParams *TP)
1974 IterateStruct *Ctx = CCTX;
1980 /*-----------------------------------------------------------------------------
1983 int EvaluateConditional(StrBuf *Target, int Neg, int state, WCTemplputParams *TP)
1985 ConditionalStruct *Cond;
1987 if ((TP->Tokens->Params[0]->len == 1) &&
1988 (TP->Tokens->Params[0]->Start[0] == 'X'))
1989 return (state != 0)?TP->Tokens->Params[1]->lvalue:0;
1991 Cond = (ConditionalStruct *) TP->Tokens->PreEval;
1994 Target, "Conditional", ERR_PARM1, TP,
1999 if (!CheckContext(Target, &Cond->Filter, TP, "Conditional")) {
2003 if (Cond->CondF(Target, TP) == Neg)
2004 return TP->Tokens->Params[1]->lvalue;
2008 int ConditionalVar(StrBuf *Target, WCTemplputParams *TP)
2013 if (!GetHash(WC->vars, TKEY(2), &vsubst))
2015 subst = (wcsubst*) vsubst;
2017 switch(subst->wcs_type) {
2019 return (subst->wcs_function!=NULL);
2021 lprintf(1, " -> Server [%s]\n", subst->wcs_value);/* TODO */
2025 case WCS_STRBUF_REF:
2026 if (TP->Tokens->nParameters < 4)
2028 return (strcmp(TP->Tokens->Params[3]->Start, ChrPtr(subst->wcs_value)) == 0);
2030 if (TP->Tokens->nParameters < 4)
2031 return (subst->lvalue != 0);
2032 return (subst->lvalue == TP->Tokens->Params[3]->lvalue);
2034 lprintf(1," WARNING: invalid type: [%ld]!\n", subst->wcs_type);
2040 void RegisterConditional(const char *Name, long len,
2042 WCConditionalFunc CondF,
2043 int ContextRequired)
2045 ConditionalStruct *Cond = (ConditionalStruct*)malloc(sizeof(ConditionalStruct));
2046 Cond->PlainName = Name;
2047 Cond->Filter.nMaxArgs = nParams;
2048 Cond->Filter.nMinArgs = nParams;
2049 Cond->CondF = CondF;
2050 Cond->Filter.ContextType = ContextRequired;
2051 Cond->Filter.ControlContextType = CTX_NONE;
2052 Put(Conditionals, Name, len, Cond, NULL);
2055 void RegisterControlConditional(const char *Name, long len,
2057 WCConditionalFunc CondF,
2058 int ControlContextRequired)
2060 ConditionalStruct *Cond = (ConditionalStruct*)malloc(sizeof(ConditionalStruct));
2061 Cond->PlainName = Name;
2062 Cond->Filter.nMaxArgs = nParams;
2063 Cond->Filter.nMinArgs = nParams;
2064 Cond->CondF = CondF;
2065 Cond->Filter.ContextType = CTX_NONE;
2066 Cond->Filter.ControlContextType = ControlContextRequired;
2067 Put(Conditionals, Name, len, Cond, NULL);
2070 /*-----------------------------------------------------------------------------
2073 void tmplput_ContextString(StrBuf *Target, WCTemplputParams *TP)
2075 StrBufAppendTemplate(Target, TP, (StrBuf*)CTX, 0);
2077 int ConditionalContextStr(StrBuf *Target, WCTemplputParams *TP)
2079 StrBuf *TokenText = (StrBuf*) CTX;
2080 const char *CompareToken;
2083 GetTemplateTokenString(Target, TP, 2, &CompareToken, &len);
2084 return strcmp(ChrPtr(TokenText), CompareToken) == 0;
2087 /*-----------------------------------------------------------------------------
2091 void tmpl_do_boxed(StrBuf *Target, WCTemplputParams *TP)
2093 WCTemplputParams SubTP;
2096 if (TP->Tokens->nParameters == 2) {
2097 if (TP->Tokens->Params[1]->Type == TYPE_STR) {
2098 Headline = NewStrBuf();
2099 DoTemplate(TKEY(1), Headline, TP);
2104 GetTemplateTokenString(Target,
2109 Headline = NewStrBufPlain(Ch, len);
2112 memcpy (&SubTP, TP, sizeof(WCTemplputParams));
2113 SubTP.Context = Headline;
2114 SubTP.Filter.ContextType = CTX_STRBUF;
2115 DoTemplate(HKEY("beginbox"), Target, &SubTP);
2116 DoTemplate(TKEY(0), Target, TP);
2117 DoTemplate(HKEY("endbox"), Target, TP);
2118 FreeStrBuf(&Headline);
2121 /*-----------------------------------------------------------------------------
2125 void tmpl_do_tabbed(StrBuf *Target, WCTemplputParams *TP)
2128 int i, ntabs, nTabs;
2130 nTabs = ntabs = TP->Tokens->nParameters / 2;
2131 TabNames = (StrBuf **) malloc(ntabs * sizeof(StrBuf*));
2133 for (i = 0; i < ntabs; i++) {
2134 if ((TP->Tokens->Params[i * 2]->Type == TYPE_STR) &&
2135 (TP->Tokens->Params[i * 2]->len > 0)) {
2136 TabNames[i] = NewStrBuf();
2137 DoTemplate(TKEY(i * 2), TabNames[i], TP);
2139 else if (TP->Tokens->Params[i * 2]->Type == TYPE_GETTEXT) {
2142 GetTemplateTokenString(Target,
2147 TabNames[i] = NewStrBufPlain(Ch, -1);
2150 /** A Tab without subject? we can't count that, add it as silent */
2155 StrTabbedDialog(Target, nTabs, TabNames);
2156 for (i = 0; i < ntabs; i++) {
2157 StrBeginTab(Target, i, nTabs);
2158 DoTemplate(TKEY(i * 2 + 1), Target, TP);
2159 StrEndTab(Target, i, nTabs);
2164 /*-----------------------------------------------------------------------------
2169 void RegisterSortFunc(const char *name, long len,
2170 const char *prepend, long preplen,
2171 CompareFunc Forward,
2172 CompareFunc Reverse,
2173 CompareFunc GroupChange,
2176 SortStruct *NewSort = (SortStruct*) malloc(sizeof(SortStruct));
2177 NewSort->Name = NewStrBufPlain(name, len);
2178 if (prepend != NULL)
2179 NewSort->PrefPrepend = NewStrBufPlain(prepend, preplen);
2181 NewSort->PrefPrepend = NULL;
2182 NewSort->Forward = Forward;
2183 NewSort->Reverse = Reverse;
2184 NewSort->GroupChange = GroupChange;
2185 NewSort->ContextType = ContextType;
2186 Put(SortHash, name, len, NewSort, DestroySortStruct);
2189 CompareFunc RetrieveSort(WCTemplputParams *TP,
2190 const char *OtherPrefix, long OtherPrefixLen,
2191 const char *Default, long ldefault, long DefaultDirection)
2194 const StrBuf *BSort = NULL;
2197 long SortOrder = -1;
2199 if (havebstr("SortBy")) {
2200 BSort = sbstr("SortBy");
2201 if (OtherPrefix == NULL) {
2202 set_room_pref("sort", NewStrBufDup(BSort), 0);
2205 set_X_PREFS(HKEY("sort"), OtherPrefix, OtherPrefixLen, NewStrBufDup(BSort), 0);
2208 else { /** Try to fallback to our remembered values... */
2209 if (OtherPrefix == NULL) {
2210 BSort = get_room_pref("sort");
2213 BSort = get_X_PREFS(HKEY("sort"), OtherPrefix, OtherPrefixLen);
2216 putbstr("SortBy", NewStrBufDup(BSort));
2220 BSort = Buf = NewStrBufPlain(Default, ldefault);
2221 putbstr("SortBy", Buf);
2225 if (!GetHash(SortHash, SKEY(BSort), &vSortBy) ||
2226 (vSortBy == NULL)) {
2228 if (!GetHash(SortHash, Default, ldefault, &vSortBy) ||
2229 (vSortBy == NULL)) {
2231 NULL, "Sorting", ERR_PARM1, TP,
2232 "Illegal default sort: [%s]", Default);
2236 SortBy = (SortStruct*)vSortBy;
2238 /** Ok, its us, lets see in which direction we should sort... */
2239 if (havebstr("SortOrder")) {
2240 SortOrder = LBSTR("SortOrder");
2242 else { /** Try to fallback to our remembered values... */
2244 if (SortBy->PrefPrepend == NULL) {
2245 Buf = get_room_pref("SortOrder");
2246 SortOrder = StrTol(Buf);
2249 BSort = get_X_PREFS(HKEY("SortOrder"), OtherPrefix, OtherPrefixLen);
2253 SortOrder = DefaultDirection;
2255 Buf = NewStrBufPlain(NULL, 64);
2256 StrBufPrintf(Buf, "%ld", SortOrder);
2257 putbstr("SortOrder", Buf);
2259 switch (SortOrder) {
2264 return SortBy->Forward;
2266 return SortBy->Reverse;
2278 ConstStr SortIcons[] = {
2279 {HKEY("static/sort_none.gif")},
2280 {HKEY("static/up_pointer.gif")},
2281 {HKEY("static/down_pointer.gif")},
2284 ConstStr SortNextOrder[] = {
2291 int GetSortMetric(WCTemplputParams *TP, SortStruct **Next, SortStruct **Param, long *SortOrder, int N)
2293 int bSortError = eNOT_SPECIFIED;
2294 const StrBuf *BSort;
2299 if (!GetHash(SortHash, TKEY(0), &vSort) ||
2301 return eNO_SUCH_SORT;
2302 *Param = (SortStruct*) vSort;
2305 if (havebstr("SortBy")) {
2306 BSort = sbstr("SortBy");
2307 bSortError = eINVALID_PARAM;
2308 if ((*Param)->PrefPrepend == NULL) {
2309 set_room_pref("sort", NewStrBufDup(BSort), 0);
2312 set_X_PREFS(HKEY("sort"), TKEY(N), NewStrBufDup(BSort), 0);
2315 else { /** Try to fallback to our remembered values... */
2316 if ((*Param)->PrefPrepend == NULL) {
2317 BSort = get_room_pref("sort");
2320 BSort = get_X_PREFS(HKEY("sort"), TKEY(N));
2324 if (!GetHash(SortHash, SKEY(BSort), &vSort) ||
2328 *Next = (SortStruct*) vSort;
2330 /** Ok, its us, lets see in which direction we should sort... */
2331 if (havebstr("SortOrder")) {
2332 *SortOrder = LBSTR("SortOrder");
2334 else { /** Try to fallback to our remembered values... */
2335 if ((*Param)->PrefPrepend == NULL) {
2336 *SortOrder = StrTol(get_room_pref("SortOrder"));
2339 *SortOrder = StrTol(get_X_PREFS(HKEY("SortOrder"), TKEY(N)));
2349 void tmplput_SORT_ICON(StrBuf *Target, WCTemplputParams *TP)
2354 const ConstStr *SortIcon;
2356 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2359 Target, "Sorter", ERR_PARM1, TP,
2360 " Sorter [%s] unknown!",
2361 TP->Tokens->Params[0]->Start);
2363 case eINVALID_PARAM:
2364 LogTemplateError(NULL, "Sorter", ERR_PARM1, TP,
2365 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2367 case eNOT_SPECIFIED:
2369 if (Next == Param) {
2370 SortIcon = &SortIcons[SortOrder];
2372 else { /** Not Us... */
2373 SortIcon = &SortIcons[0];
2375 StrBufAppendBufPlain(Target, SortIcon->Key, SortIcon->len, 0);
2379 void tmplput_SORT_NEXT(StrBuf *Target, WCTemplputParams *TP)
2385 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2388 Target, "Sorter", ERR_PARM1, TP,
2389 " Sorter [%s] unknown!",
2390 TP->Tokens->Params[0]->Start);
2392 case eINVALID_PARAM:
2394 NULL, "Sorter", ERR_PARM1, TP,
2395 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2397 case eNOT_SPECIFIED:
2399 StrBufAppendBuf(Target, Param->Name, 0);
2404 void tmplput_SORT_ORDER(StrBuf *Target, WCTemplputParams *TP)
2407 const ConstStr *SortOrderStr;
2411 switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2414 Target, "Sorter", ERR_PARM1, TP,
2415 " Sorter [%s] unknown!",
2416 TP->Tokens->Params[0]->Start);
2418 case eINVALID_PARAM:
2420 NULL, "Sorter", ERR_PARM1, TP,
2421 " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2423 case eNOT_SPECIFIED:
2425 if (Next == Param) {
2426 SortOrderStr = &SortNextOrder[SortOrder];
2428 else { /** Not Us... */
2429 SortOrderStr = &SortNextOrder[0];
2431 StrBufAppendBufPlain(Target, SortOrderStr->Key, SortOrderStr->len, 0);
2436 void tmplput_long_vector(StrBuf *Target, WCTemplputParams *TP)
2438 long *LongVector = (long*) CTX;
2440 if ((TP->Tokens->Params[0]->Type == TYPE_LONG) &&
2441 (TP->Tokens->Params[0]->lvalue <= LongVector[0]))
2443 StrBufAppendPrintf(Target, "%ld", LongVector[TP->Tokens->Params[0]->lvalue]);
2447 if (TP->Tokens->Params[0]->Type != TYPE_LONG) {
2449 Target, "Longvector", ERR_NAME, TP,
2450 "needs a numerical Parameter!");
2454 Target, "LongVector", ERR_PARM1, TP,
2455 "doesn't have %ld Parameters, its just the size of %ld!",
2456 TP->Tokens->Params[0]->lvalue,
2462 void dbg_print_longvector(long *LongVector)
2464 StrBuf *Buf = NewStrBufPlain(HKEY("Longvector: ["));
2465 int nItems = LongVector[0];
2468 for (i = 0; i < nItems; i++) {
2470 StrBufAppendPrintf(Buf, "%d: %ld | ", i, LongVector[i]);
2472 StrBufAppendPrintf(Buf, "%d: %ld]\n", i, LongVector[i]);
2475 lprintf(1, ChrPtr(Buf));
2479 int ConditionalLongVector(StrBuf *Target, WCTemplputParams *TP)
2481 long *LongVector = (long*) CTX;
2483 if ((TP->Tokens->Params[2]->Type == TYPE_LONG) &&
2484 (TP->Tokens->Params[2]->lvalue <= LongVector[0])&&
2485 (TP->Tokens->Params[3]->Type == TYPE_LONG) &&
2486 (TP->Tokens->Params[3]->lvalue <= LongVector[0]))
2488 return LongVector[TP->Tokens->Params[2]->lvalue] ==
2489 LongVector[TP->Tokens->Params[3]->lvalue];
2493 if ((TP->Tokens->Params[2]->Type == TYPE_LONG) ||
2494 (TP->Tokens->Params[2]->Type == TYPE_LONG)) {
2496 Target, "ConditionalLongvector", ERR_PARM1, TP,
2497 "needs two long Parameter!");
2501 Target, "Longvector", ERR_PARM1, TP,
2502 "doesn't have %ld / %ld Parameters, its just the size of %ld!",
2503 TP->Tokens->Params[2]->lvalue,
2504 TP->Tokens->Params[3]->lvalue,
2515 memset(&NoCtx, 0, sizeof(WCTemplputParams));
2516 RegisterNamespace("SORT:ICON", 1, 2, tmplput_SORT_ICON, CTX_NONE);
2517 RegisterNamespace("SORT:ORDER", 1, 2, tmplput_SORT_ORDER, CTX_NONE);
2518 RegisterNamespace("SORT:NEXT", 1, 2, tmplput_SORT_NEXT, CTX_NONE);
2519 RegisterNamespace("CONTEXTSTR", 0, 1, tmplput_ContextString, CTX_STRBUF);
2520 RegisterNamespace("ITERATE", 2, 100, tmpl_iterate_subtmpl, CTX_NONE);
2521 RegisterNamespace("DOBOXED", 1, 2, tmpl_do_boxed, CTX_NONE);
2522 RegisterNamespace("DOTABBED", 2, 100, tmpl_do_tabbed, CTX_NONE);
2523 RegisterNamespace("LONGVECTOR", 1, 1, tmplput_long_vector, CTX_LONGVECTOR);
2524 RegisterConditional(HKEY("COND:SUBST"), 3, ConditionalVar, CTX_NONE);
2525 RegisterConditional(HKEY("COND:CONTEXTSTR"), 3, ConditionalContextStr, CTX_STRBUF);
2526 RegisterConditional(HKEY("COND:LONGVECTOR"), 4, ConditionalLongVector, CTX_LONGVECTOR);
2528 RegisterControlConditional(HKEY("COND:ITERATE:ISGROUPCHANGE"), 2,
2529 conditional_ITERATE_ISGROUPCHANGE,
2531 RegisterControlConditional(HKEY("COND:ITERATE:LASTN"), 2,
2532 conditional_ITERATE_LASTN,
2534 RegisterControlNS(HKEY("ITERATE:ODDEVEN"), 0, 0, tmplput_ITERATE_ODDEVEN, CTX_ITERATE);
2535 RegisterControlNS(HKEY("ITERATE:KEY"), 0, 0, tmplput_ITERATE_KEY, CTX_ITERATE);
2536 RegisterControlNS(HKEY("ITERATE:N"), 0, 0, tmplput_ITERATE_LASTN, CTX_ITERATE);
2540 ServerStartModule_SUBST
2543 WirelessTemplateCache = NewHash(1, NULL);
2544 WirelessLocalTemplateCache = NewHash(1, NULL);
2545 LocalTemplateCache = NewHash(1, NULL);
2546 TemplateCache = NewHash(1, NULL);
2548 GlobalNS = NewHash(1, NULL);
2549 Iterators = NewHash(1, NULL);
2550 Conditionals = NewHash(1, NULL);
2551 SortHash = NewHash(1, NULL);
2555 FinalizeModule_SUBST
2562 ServerShutdownModule_SUBST
2565 DeleteHash(&WirelessTemplateCache);
2566 DeleteHash(&WirelessLocalTemplateCache);
2567 DeleteHash(&TemplateCache);
2568 DeleteHash(&LocalTemplateCache);
2570 DeleteHash(&GlobalNS);
2571 DeleteHash(&Iterators);
2572 DeleteHash(&Conditionals);
2573 DeleteHash(&SortHash);
2579 SessionNewModule_SUBST
2586 SessionAttachModule_SUBST
2589 sess->vars = NewHash(1,NULL);
2593 SessionDetachModule_SUBST
2596 DeleteHash(&sess->vars);
2600 SessionDestroyModule_SUBST