webcit/subst.c

   1 #include "sysdep.h"
   2
   3
   4 #include <sys/types.h>
   5 #include <sys/stat.h>
   6 #include <dirent.h>
   7 #include <errno.h>
   8
   9 #include <unistd.h>
  10 #include <stdio.h>
  11 #include <stdarg.h>
  12 #include <stddef.h>
  13
  14 #define SHOW_ME_VAPPEND_PRINTF
  15
  16 #include "webcit.h"
  17 #include "webserver.h"
  18
  19 extern char *static_dirs[PATH_MAX];  /* Disk representation */
  20
  21 HashList *TemplateCache;
  22 HashList *LocalTemplateCache;
  23
  24 HashList *GlobalNS;
  25 HashList *Iterators;
  26 HashList *Conditionals;
  27 HashList *SortHash;
  28 HashList *Defines;
  29
  30 int DumpTemplateI18NStrings = 0;
  31 int LoadTemplates = 0;
  32 int dbg_backtrace_template_errors = 0;
  33 WCTemplputParams NoCtx;
  34 StrBuf *I18nDump = NULL;
  35
  36 const char EmptyStr[]="";
  37
  38 #define SV_GETTEXT 1
  39 #define SV_CONDITIONAL 2
  40 #define SV_NEG_CONDITIONAL 3
  41 #define SV_CUST_STR_CONDITIONAL 4
  42 #define SV_SUBTEMPL 5
  43 #define SV_PREEVALUATED 6
  44
  45
  46
  47 /*
  48  * Dynamic content for variable substitution in templates
  49  */
  50 typedef struct _wcsubst {
  51         ContextFilter Filter;
  52         int wcs_type;                           /* which type of Substitution are we */
  53         char wcs_key[32];                       /* copy of our hashkey for debugging */
  54         StrBuf *wcs_value;                      /* if we're a string, keep it here */
  55         long lvalue;                            /* type long? keep data here */
  56         WCHandlerFunc wcs_function;             /* funcion hook ???*/
  57 } wcsubst;
  58
  59
  60 typedef struct _WCTemplate {
  61         StrBuf *Data;
  62         StrBuf *FileName;
  63         int nTokensUsed;
  64         int TokenSpace;
  65         StrBuf *MimeType;
  66         WCTemplateToken **Tokens;
  67 } WCTemplate;
  68
  69 typedef struct _HashHandler {
  70         ContextFilter Filter;
  71         WCPreevalFunc PreEvalFunc;
  72         WCHandlerFunc HandlerFunc;
  73 }HashHandler;
  74
  75 typedef enum _estate {
  76         eNext,
  77         eSkipTilEnd
  78 } TemplState;
  79
  80 void *load_template(StrBuf *Target, WCTemplate *NewTemplate);
  81 int EvaluateConditional(StrBuf *Target, int Neg, int state, WCTemplputParams **TPP);
  82
  83
  84
  85 typedef struct _SortStruct {
  86         StrBuf *Name;
  87         StrBuf *PrefPrepend;
  88         CompareFunc Forward;
  89         CompareFunc Reverse;
  90         CompareFunc GroupChange;
  91
  92         CtxType ContextType;
  93 }SortStruct;
  94
  95 HashList *CtxList = NULL;
  96
  97 static CtxType CtxCounter = CTX_NONE;
  98
  99 CtxType CTX_STRBUF = CTX_NONE;
 100 CtxType CTX_STRBUFARR = CTX_NONE;
 101 CtxType CTX_LONGVECTOR = CTX_NONE;
 102
 103 CtxType CTX_ITERATE = CTX_NONE;
 104 CtxType CTX_TAB = CTX_NONE;
 105
 106 void HFreeContextType(void *pCtx)
 107 {
 108         CtxTypeStruct *FreeStruct = (CtxTypeStruct *) pCtx;
 109         FreeStrBuf(&FreeStruct->Name);
 110         free(FreeStruct);
 111 }
 112 void PutContextType(const char *name, long len, CtxType TheCtx)
 113 {
 114         CtxTypeStruct *NewStruct;
 115
 116         NewStruct = (CtxTypeStruct*) malloc(sizeof(CtxTypeStruct));
 117         NewStruct->Name = NewStrBufPlain(name, len);
 118         NewStruct->Type = TheCtx;
 119
 120         Put(CtxList, IKEY(NewStruct->Type), NewStruct, HFreeContextType);
 121 }
 122 void RegisterContextType(const char *name, long len, CtxType *TheCtx)
 123 {
 124         if (*TheCtx != CTX_NONE)
 125                 return;
 126
 127         *TheCtx = ++CtxCounter;
 128         PutContextType(name, len, *TheCtx);
 129 }
 130
 131 CtxTypeStruct *GetContextType(CtxType Type)
 132 {
 133         void *pv = NULL;
 134         GetHash(CtxList, IKEY(Type), &pv);
 135         return pv;
 136 }
 137
 138 const char *UnknownContext = "CTX_UNKNOWN";
 139
 140 const char *ContextName(CtxType ContextType)
 141 {
 142         CtxTypeStruct *pCtx;
 143
 144         pCtx = GetContextType(ContextType);
 145
 146         if (pCtx != NULL)
 147                 return ChrPtr(pCtx->Name);
 148         else
 149                 return UnknownContext;
 150 }
 151
 152 void StackDynamicContext(WCTemplputParams *Super,
 153                          WCTemplputParams *Sub,
 154                          void *Context,
 155                          CtxType ContextType,
 156                          int nArgs,
 157                          WCTemplateToken *Tokens,
 158                          WCConditionalFunc ExitCtx,
 159                          long ExitCTXID)
 160 {
 161         memset(Sub, 0, sizeof(WCTemplputParams));
 162
 163         if (Super != NULL) {
 164                 Sub->Sub = Super->Sub;
 165                 Super->Sub = Sub;
 166         }
 167         if (Sub->Sub != NULL)
 168                 Sub->Sub->Super = Sub;
 169         Sub->Super = Super;
 170
 171         Sub->Context = Context;
 172         Sub->Filter.ContextType = ContextType;
 173         Sub->nArgs = nArgs;
 174         Sub->Tokens = Tokens;
 175         Sub->ExitCtx = ExitCtx;
 176         Sub->ExitCTXID = ExitCTXID;
 177 }
 178
 179 void UnStackContext(WCTemplputParams *Sub)
 180 {
 181         if (Sub->Super != NULL)
 182         {
 183                 Sub->Super->Sub = Sub->Sub;
 184         }
 185         if (Sub->Sub != NULL)
 186         {
 187                 Sub->Sub->Super = Sub->Super;
 188         }
 189 }
 190 void UnStackDynamicContext(StrBuf *Target, WCTemplputParams **TPP)
 191 {
 192         WCTemplputParams *TP = *TPP;
 193         WCTemplputParams *Super = TP->Super;
 194         TP->ExitCtx(Target, TP);
 195         *TPP = Super;
 196 }
 197
 198 void *GetContextPayload(WCTemplputParams *TP, CtxType ContextType)
 199 {
 200         WCTemplputParams *whichTP = TP;
 201
 202         if (ContextType == CTX_NONE)
 203                 return TP->Context;
 204
 205         while ((whichTP != NULL) && (whichTP->Filter.ContextType != ContextType))
 206                 whichTP = whichTP->Super;
 207
 208         return whichTP->Context;
 209 }
 210
 211 void DestroySortStruct(void *vSort)
 212 {
 213         SortStruct *Sort = (SortStruct*) vSort;
 214         FreeStrBuf(&Sort->Name);
 215         FreeStrBuf(&Sort->PrefPrepend);
 216         free (Sort);
 217 }
 218
 219
 220 void LogTemplateError (StrBuf *Target, const char *Type, int ErrorPos, WCTemplputParams *TP, const char *Format, ...)
 221 {
 222         wcsession *WCC;
 223         StrBuf *Error;
 224         StrBuf *Info;
 225         va_list arg_ptr;
 226         const char *Err = NULL;
 227
 228         Info = NewStrBuf();
 229         Error = NewStrBuf();
 230
 231         va_start(arg_ptr, Format);
 232         StrBufVAppendPrintf(Error, Format, arg_ptr);
 233         va_end(arg_ptr);
 234
 235         switch (ErrorPos) {
 236         case ERR_NAME: /* the main token name... */
 237                 Err = (TP->Tokens!= NULL)? TP->Tokens->pName:"";
 238                 break;
 239         default:
 240                 Err = ((TP->Tokens!= NULL) &&
 241                        (TP->Tokens->nParameters > ErrorPos - 1))?
 242                         TP->Tokens->Params[ErrorPos - 1]->Start : "";
 243                 break;
 244         }
 245         if (TP->Tokens != NULL)
 246         {
 247                 syslog(LOG_WARNING, "%s [%s]  (in '%s' line %ld); %s; [%s]\n",
 248                        Type,
 249                        Err,
 250                        ChrPtr(TP->Tokens->FileName),
 251                        TP->Tokens->Line,
 252                        ChrPtr(Error),
 253                        ChrPtr(TP->Tokens->FlatToken));
 254         }
 255         else
 256         {
 257                 syslog(LOG_WARNING, "%s: %s;\n",
 258                        Type,
 259                        ChrPtr(Error));
 260         }
 261         WCC = WC;
 262         if (WCC == NULL) {
 263                 FreeStrBuf(&Info);
 264                 FreeStrBuf(&Error);
 265                 return;
 266         }
 267
 268         if (WCC->WFBuf == NULL) WCC->WFBuf = NewStrBuf();
 269         if (TP->Tokens != NULL)
 270         {
 271                 /* deprecated:
 272                 StrBufAppendPrintf(
 273                         Target,
 274                         "<pre>\n%s [%s] (in '%s' line %ld); %s\n[%s]\n</pre>\n",
 275                         Type,
 276                         Err,
 277                         ChrPtr(TP->Tokens->FileName),
 278                         TP->Tokens->Line,
 279                         ChrPtr(Error),
 280                         ChrPtr(TP->Tokens->FlatToken));
 281                 */
 282                 StrBufPrintf(Info, "%s [%s]  %s; [%s]",
 283                              Type,
 284                              Err,
 285                              ChrPtr(Error),
 286                              ChrPtr(TP->Tokens->FlatToken));
 287
 288
 289                 SerializeJson(WCC->WFBuf, WildFireException(SKEY(TP->Tokens->FileName),
 290                                                         TP->Tokens->Line,
 291                                                         Info,
 292                                                         1), 1);
 293 /*
 294                 SerializeJson(Header, WildFireMessage(SKEY(TP->Tokens->FileName),
 295                                                       TP->Tokens->Line,
 296                                                       Error,
 297                                                       eERROR), 1);
 298 */
 299
 300         }
 301         else
 302         {
 303                 /* deprecated.
 304                 StrBufAppendPrintf(
 305                         Target,
 306                         "<pre>\n%s: %s\n</pre>\n",
 307                         Type,
 308                         ChrPtr(Error));
 309                 */
 310                 StrBufPrintf(Info, "%s [%s]  %s; [%s]",
 311                              Type,
 312                              Err,
 313                              ChrPtr(Error),
 314                              ChrPtr(TP->Tokens->FlatToken));
 315                 SerializeJson(WCC->WFBuf, WildFireException(HKEY(__FILE__), __LINE__, Info, 1), 1);
 316         }
 317         FreeStrBuf(&Info);
 318         FreeStrBuf(&Error);
 319 /*
 320         if (dbg_backtrace_template_errors)
 321                 wc_backtrace(LOG_DEBUG);
 322 */
 323 }
 324
 325 void LogError (StrBuf *Target, const char *Type, const char *Format, ...)
 326 {
 327         wcsession *WCC;
 328         StrBuf *Error;
 329         StrBuf *Info;
 330         va_list arg_ptr;
 331
 332         Info = NewStrBuf();
 333         Error = NewStrBuf();
 334
 335         va_start(arg_ptr, Format);
 336         StrBufVAppendPrintf(Error, Format, arg_ptr);
 337         va_end(arg_ptr);
 338
 339         syslog(LOG_WARNING, "%s", ChrPtr(Error));
 340
 341         WCC = WC;
 342         if (WCC->WFBuf == NULL) WCC->WFBuf = NewStrBuf();
 343
 344         SerializeJson(WCC->WFBuf, WildFireException(Type, strlen(Type),
 345                                                     0,
 346                                                     Info,
 347                                                     1), 1);
 348
 349         FreeStrBuf(&Info);
 350         FreeStrBuf(&Error);
 351 /*
 352         if (dbg_backtrace_template_errors)
 353                 wc_backtrace(LOG_DEBUG);
 354 */
 355 }
 356
 357
 358 void RegisterNS(const char *NSName,
 359                 long len,
 360                 int nMinArgs,
 361                 int nMaxArgs,
 362                 WCHandlerFunc HandlerFunc,
 363                 WCPreevalFunc PreevalFunc,
 364                 CtxType ContextRequired)
 365 {
 366         HashHandler *NewHandler;
 367
 368         NewHandler = (HashHandler*) malloc(sizeof(HashHandler));
 369         memset(NewHandler, 0, sizeof(HashHandler));
 370         NewHandler->Filter.nMinArgs = nMinArgs;
 371         NewHandler->Filter.nMaxArgs = nMaxArgs;
 372         NewHandler->Filter.ContextType = ContextRequired;
 373
 374         NewHandler->PreEvalFunc = PreevalFunc;
 375         NewHandler->HandlerFunc = HandlerFunc;
 376         Put(GlobalNS, NSName, len, NewHandler, NULL);
 377 }
 378
 379
 380
 381 int CheckContext(StrBuf *Target, ContextFilter *Need, WCTemplputParams *TP, const char *ErrType)
 382 {
 383         WCTemplputParams *TPP = TP;
 384
 385         if ((Need != NULL) &&
 386             (Need->ContextType != CTX_NONE) &&
 387             (Need->ContextType != TPP->Filter.ContextType)) {
 388
 389                 while ((TPP != NULL) &&
 390                        (Need->ContextType != TPP->Filter.ContextType))
 391                 {
 392                         TPP = TPP->Super;
 393                 }
 394
 395                 if (TPP != NULL)
 396                         return 1;
 397
 398                 LogTemplateError(
 399                         Target, ErrType, ERR_NAME, TP,
 400                         "  WARNING: requires Context: [%s], have [%s]!",
 401                         ContextName(Need->ContextType),
 402                         ContextName(TP->Filter.ContextType));
 403                 return 0;
 404         }
 405 /*
 406         if (TP->Tokens->nParameters < Need->nMinArgs) {
 407                 LogTemplateError(Target, ErrType, ERR_NAME, TP,
 408                                  "needs at least %ld params, have %ld",
 409                                  Need->nMinArgs,
 410                                  TP->Tokens->nParameters);
 411                 return 0;
 412
 413         }
 414         else if (TP->Tokens->nParameters > Need->nMaxArgs) {
 415                 LogTemplateError(Target, ErrType, ERR_NAME, TP,
 416                                  "just needs %ld params, you gave %ld",
 417                                  Need->nMaxArgs,
 418                                  TP->Tokens->nParameters);
 419                 return 0;
 420
 421         }
 422 */
 423         return 1;
 424 }
 425
 426 void FreeToken(WCTemplateToken **Token)
 427 {
 428         int i;
 429         FreeStrBuf(&(*Token)->FlatToken);
 430         if ((*Token)->HaveParameters)
 431                 for (i = 0; i < (*Token)->nParameters; i++)
 432                         free((*Token)->Params[i]);
 433         free(*Token);
 434         *Token = NULL;
 435 }
 436
 437
 438
 439 void FreeWCTemplate(void *vFreeMe)
 440 {
 441         int i;
 442         WCTemplate *FreeMe = (WCTemplate*)vFreeMe;
 443
 444         if (FreeMe->TokenSpace > 0) {
 445                 for (i = 0; i < FreeMe->nTokensUsed; i ++) {
 446                         FreeToken(&FreeMe->Tokens[i]);
 447                 }
 448                 free(FreeMe->Tokens);
 449         }
 450         FreeStrBuf(&FreeMe->FileName);
 451         FreeStrBuf(&FreeMe->Data);
 452         FreeStrBuf(&FreeMe->MimeType);
 453         free(FreeMe);
 454 }
 455
 456 int HaveTemplateTokenString(StrBuf *Target,
 457                             WCTemplputParams *TP,
 458                             int N,
 459                             const char **Value,
 460                             long *len)
 461 {
 462         if (N >= TP->Tokens->nParameters) {
 463                 return 0;
 464         }
 465
 466         switch (TP->Tokens->Params[N]->Type) {
 467         case TYPE_INTDEFINE:
 468         case TYPE_STR:
 469         case TYPE_BSTR:
 470         case TYPE_PREFSTR:
 471         case TYPE_ROOMPREFSTR:
 472         case TYPE_GETTEXT:
 473         case TYPE_SUBTEMPLATE:
 474                 return 1;
 475         case TYPE_LONG:
 476         case TYPE_PREFINT:
 477         default:
 478                 return 0;
 479         }
 480 }
 481
 482 void GetTemplateTokenString(StrBuf *Target,
 483                             WCTemplputParams *TP,
 484                             int N,
 485                             const char **Value,
 486                             long *len)
 487 {
 488         StrBuf *Buf;
 489
 490         if (N >= TP->Tokens->nParameters) {
 491                 LogTemplateError(Target,
 492                                  "TokenParameter", N, TP,
 493                                  "invalid token %d. this shouldn't have come till here.\n", N);
 494                 *Value = "";
 495                 *len = 0;
 496                 return;
 497         }
 498
 499         switch (TP->Tokens->Params[N]->Type) {
 500
 501         case TYPE_INTDEFINE:
 502         case TYPE_STR:
 503                 *Value = TP->Tokens->Params[N]->Start;
 504                 *len = TP->Tokens->Params[N]->len;
 505                 break;
 506         case TYPE_BSTR:
 507                 if (TP->Tokens->Params[N]->len == 0) {
 508                         LogTemplateError(Target,
 509                                          "TokenParameter", N, TP,
 510                                          "Requesting parameter %d; of type BSTR, empty lookup string not admitted.", N);
 511                         *len = 0;
 512                         *Value = EmptyStr;
 513                         break;
 514                 }
 515                 Buf = (StrBuf*) SBstr(TKEY(N));
 516                 *Value = ChrPtr(Buf);
 517                 *len = StrLength(Buf);
 518                 break;
 519         case TYPE_PREFSTR:
 520                 if (TP->Tokens->Params[N]->len == 0) {
 521                         LogTemplateError(Target,
 522                                          "TokenParameter", N, TP,
 523                                          "Requesting parameter %d; of type PREFSTR, empty lookup string not admitted.", N);
 524                         *len = 0;
 525                         *Value = EmptyStr;
 526                         break;
 527                 }
 528                 get_PREFERENCE(TKEY(N), &Buf);
 529                 *Value = ChrPtr(Buf);
 530                 *len = StrLength(Buf);
 531                 break;
 532         case TYPE_ROOMPREFSTR:
 533                 if (TP->Tokens->Params[N]->len == 0) {
 534                         LogTemplateError(Target,
 535                                          "TokenParameter", N, TP,
 536                                          "Requesting parameter %d; of type PREFSTR, empty lookup string not admitted.", N);
 537                         *len = 0;
 538                         *Value = EmptyStr;
 539                         break;
 540                 }
 541                 Buf = get_ROOM_PREFS(TKEY(N));
 542                 *Value = ChrPtr(Buf);
 543                 *len = StrLength(Buf);
 544                 break;
 545         case TYPE_LONG:
 546                 LogTemplateError(Target,
 547                                  "TokenParameter", N, TP,
 548                                  "Requesting parameter %d; of type LONG, want string.", N);
 549                 break;
 550         case TYPE_PREFINT:
 551                 LogTemplateError(Target,
 552                                  "TokenParameter", N, TP,
 553                                  "Requesting parameter %d; of type PREFINT, want string.", N);
 554                 break;
 555         case TYPE_GETTEXT:
 556                 *Value = _(TP->Tokens->Params[N]->Start);
 557                 *len = strlen(*Value);
 558                 break;
 559         case TYPE_SUBTEMPLATE:
 560                 if (TP->Tokens->Params[N]->len == 0) {
 561                         LogTemplateError(Target,
 562                                          "TokenParameter", N, TP,
 563                                          "Requesting parameter %d; of type SUBTEMPLATE, empty lookup string not admitted.", N);
 564                         *len = 0;
 565                         *Value = EmptyStr;
 566                         break;
 567                 }
 568
 569                 Buf = NewStrBuf();
 570                 DoTemplate(TKEY(N), Buf, TP);
 571
 572                 *Value = ChrPtr(Buf);
 573                 *len = StrLength(Buf);
 574                 /* we can't free it here, so we put it into the subst so its discarded later on. */
 575                 PutRequestLocalMem(Buf, HFreeStrBuf);
 576                 break;
 577
 578         default:
 579                 LogTemplateError(Target,
 580                                  "TokenParameter", N, TP,
 581                                  "unknown param type %d; [%d]", N, TP->Tokens->Params[N]->Type);
 582                 break;
 583         }
 584 }
 585
 586 long GetTemplateTokenNumber(StrBuf *Target, WCTemplputParams *TP, int N, long dflt)
 587 {
 588         long Ret;
 589         if (N >= TP->Tokens->nParameters) {
 590                 LogTemplateError(Target,
 591                                  "TokenParameter", N, TP,
 592                                  "invalid token %d. this shouldn't have come till here.\n", N);
 593                 wc_backtrace(LOG_DEBUG);
 594                 return 0;
 595         }
 596
 597         switch (TP->Tokens->Params[N]->Type) {
 598
 599         case TYPE_STR:
 600                 return atol(TP->Tokens->Params[N]->Start);
 601                 break;
 602         case TYPE_BSTR:
 603                 if (TP->Tokens->Params[N]->len == 0) {
 604                         LogTemplateError(Target,
 605                                          "TokenParameter", N, TP,
 606                                          "Requesting parameter %d; of type BSTR, empty lookup string not admitted.", N);
 607                         return 0;
 608                 }
 609                 return  LBstr(TKEY(N));
 610                 break;
 611         case TYPE_PREFSTR:
 612                 LogTemplateError(Target,
 613                                  "TokenParameter", N, TP,
 614                                  "requesting a prefstring in param %d want a number", N);
 615                 if (TP->Tokens->Params[N]->len == 0) {
 616                         LogTemplateError(Target,
 617                                          "TokenParameter", N, TP,
 618                                          "Requesting parameter %d; of type PREFSTR, empty lookup string not admitted.", N);
 619                         return 0;
 620                 }
 621                 if (get_PREF_LONG(TKEY(N), &Ret, dflt))
 622                         return Ret;
 623                 return 0;
 624         case TYPE_ROOMPREFSTR:
 625                 LogTemplateError(Target,
 626                                  "TokenParameter", N, TP,
 627                                  "requesting a prefstring in param %d want a number", N);
 628                 if (TP->Tokens->Params[N]->len == 0) {
 629                         LogTemplateError(Target,
 630                                          "TokenParameter", N, TP,
 631                                          "Requesting parameter %d; of type PREFSTR, empty lookup string not admitted.", N);
 632                         return 0;
 633                 }
 634                 if (get_ROOM_PREFS_LONG(TKEY(N), &Ret, dflt))
 635                         return Ret;
 636                 return 0;
 637         case TYPE_INTDEFINE:
 638         case TYPE_LONG:
 639                 return TP->Tokens->Params[N]->lvalue;
 640         case TYPE_PREFINT:
 641                 if (TP->Tokens->Params[N]->len == 0) {
 642                         LogTemplateError(Target,
 643                                          "TokenParameter", N, TP,
 644                                          "Requesting parameter %d; of type PREFINT, empty lookup string not admitted.", N);
 645                         return 0;
 646                 }
 647                 if (get_PREF_LONG(TKEY(N), &Ret, dflt))
 648                         return Ret;
 649                 return 0;
 650         case TYPE_GETTEXT:
 651                 LogTemplateError(Target,
 652                                  "TokenParameter", N, TP,
 653                                  "requesting a I18N string in param %d; want a number", N);
 654                 return 0;
 655         case TYPE_SUBTEMPLATE:
 656                 LogTemplateError(Target,
 657                                  "TokenParameter", N, TP,
 658                                  "requesting a subtemplate in param %d; not supported for numbers", N);
 659                 return 0;
 660         default:
 661                 LogTemplateError(Target,
 662                                  "TokenParameter", N, TP,
 663                                  "unknown param type %d; [%d]", N, TP->Tokens->Params[N]->Type);
 664                 return 0;
 665         }
 666 }
 667
 668
 669 /*
 670  * puts string into the template and computes which escape methon we should use
 671  * Source = the string we should put into the template
 672  * FormatTypeIndex = where should we look for escape types if?
 673  */
 674 void StrBufAppendTemplate(StrBuf *Target,
 675                           WCTemplputParams *TP,
 676                           const StrBuf *Source, int FormatTypeIndex)
 677 {
 678         const char *pFmt = NULL;
 679         char EscapeAs = ' ';
 680
 681         if ((FormatTypeIndex < TP->Tokens->nParameters) &&
 682             (TP->Tokens->Params[FormatTypeIndex] != NULL) &&
 683             (TP->Tokens->Params[FormatTypeIndex]->Type == TYPE_STR) &&
 684             (TP->Tokens->Params[FormatTypeIndex]->len >= 1)) {
 685                 pFmt = TP->Tokens->Params[FormatTypeIndex]->Start;
 686                 EscapeAs = *pFmt;
 687         }
 688
 689         switch(EscapeAs)
 690         {
 691         case 'H':
 692                 StrEscAppend(Target, Source, NULL, 0, 2);
 693                 break;
 694         case 'X':
 695                 StrEscAppend(Target, Source, NULL, 0, 0);
 696                 break;
 697         case 'J':
 698                 StrECMAEscAppend(Target, Source, NULL);
 699                 break;
 700         case 'K':
 701                 StrHtmlEcmaEscAppend(Target, Source, NULL, 0, 0);
 702                 break;
 703         case 'U':
 704                 StrBufUrlescAppend(Target, Source, NULL);
 705                 break;
 706         case 'F':
 707                 if (pFmt != NULL)       pFmt++;
 708                 else                    pFmt = "JUSTIFY";
 709                 if (*pFmt == '\0')      pFmt = "JUSTIFY";
 710                 FmOut(Target, pFmt, Source);
 711                 break;
 712         default:
 713                 StrBufAppendBuf(Target, Source, 0);
 714         }
 715 }
 716
 717 /*
 718  * puts string into the template and computes which escape methon we should use
 719  * Source = the string we should put into the template
 720  * FormatTypeIndex = where should we look for escape types if?
 721  */
 722 void StrBufAppendTemplateStr(StrBuf *Target,
 723                              WCTemplputParams *TP,
 724                              const char *Source, int FormatTypeIndex)
 725 {
 726         const char *pFmt = NULL;
 727         char EscapeAs = ' ';
 728
 729         if ((FormatTypeIndex < TP->Tokens->nParameters) &&
 730             (TP->Tokens->Params[FormatTypeIndex]->Type == TYPE_STR) &&
 731             (TP->Tokens->Params[FormatTypeIndex]->len >= 1)) {
 732                 pFmt = TP->Tokens->Params[FormatTypeIndex]->Start;
 733                 EscapeAs = *pFmt;
 734         }
 735
 736         switch(EscapeAs)
 737         {
 738         case 'H':
 739                 StrEscAppend(Target, NULL, Source, 0, 2);
 740                 break;
 741         case 'X':
 742                 StrEscAppend(Target, NULL, Source, 0, 0);
 743                 break;
 744         case 'J':
 745                 StrECMAEscAppend(Target, NULL, Source);
 746           break;
 747         case 'K':
 748                 StrHtmlEcmaEscAppend(Target, NULL, Source, 0, 0);
 749           break;
 750         case 'U':
 751                 StrBufUrlescAppend(Target, NULL, Source);
 752                 break;
 753 /*
 754         case 'F':
 755                 if (pFmt != NULL)       pFmt++;
 756                 else                    pFmt = "JUSTIFY";
 757                 if (*pFmt == '\0')      pFmt = "JUSTIFY";
 758                 FmOut(Target, pFmt, Source);
 759                 break;
 760 */
 761         default:
 762                 StrBufAppendBufPlain(Target, Source, -1, 0);
 763         }
 764 }
 765
 766
 767 void PutNewToken(WCTemplate *Template, WCTemplateToken *NewToken)
 768 {
 769         if (Template->nTokensUsed + 1 >= Template->TokenSpace) {
 770                 if (Template->TokenSpace <= 0) {
 771                         Template->Tokens = (WCTemplateToken**)malloc(
 772                                 sizeof(WCTemplateToken*) * 10);
 773                         memset(Template->Tokens, 0, sizeof(WCTemplateToken*) * 10);
 774                         Template->TokenSpace = 10;
 775                 }
 776                 else {
 777                         WCTemplateToken **NewTokens;
 778
 779                         NewTokens= (WCTemplateToken**) malloc(
 780                                 sizeof(WCTemplateToken*) * Template->TokenSpace * 2);
 781
 782                         memset(NewTokens,
 783                                0, sizeof(WCTemplateToken*) * Template->TokenSpace * 2);
 784
 785                         memcpy(NewTokens,
 786                                Template->Tokens,
 787                                sizeof(WCTemplateToken*) * Template->nTokensUsed);
 788
 789                         free(Template->Tokens);
 790                         Template->TokenSpace *= 2;
 791                         Template->Tokens = NewTokens;
 792                 }
 793         }
 794         Template->Tokens[(Template->nTokensUsed)++] = NewToken;
 795 }
 796
 797 int GetNextParameter(StrBuf *Buf,
 798                      const char **pCh,
 799                      const char *pe,
 800                      WCTemplateToken *Tokens,
 801                      WCTemplate *pTmpl,
 802                      WCTemplputParams *TP,
 803                      TemplateParam **pParm)
 804 {
 805         const char *pch = *pCh;
 806         const char *pchs, *pche;
 807         TemplateParam *Parm;
 808         char quote = '\0';
 809         int ParamBrace = 0;
 810
 811         *pParm = Parm = (TemplateParam *) malloc(sizeof(TemplateParam));
 812         memset(Parm, 0, sizeof(TemplateParam));
 813         Parm->Type = TYPE_STR;
 814
 815         /* Skip leading whitespaces */
 816         while ((*pch == ' ' )||
 817                (*pch == '\t')||
 818                (*pch == '\r')||
 819                (*pch == '\n')) pch ++;
 820
 821         if (*pch == ':') {
 822                 Parm->Type = TYPE_PREFSTR;
 823                 pch ++;
 824                 if (*pch == '(') {
 825                         pch ++;
 826                         ParamBrace = 1;
 827                 }
 828         }
 829         else if (*pch == '.') {
 830                 Parm->Type = TYPE_ROOMPREFSTR;
 831                 pch ++;
 832                 if (*pch == '(') {
 833                         pch ++;
 834                         ParamBrace = 1;
 835                 }
 836         }
 837         else if (*pch == ';') {
 838                 Parm->Type = TYPE_PREFINT;
 839                 pch ++;
 840                 if (*pch == '(') {
 841                         pch ++;
 842                         ParamBrace = 1;
 843                 }
 844         }
 845         else if (*pch == '#') {
 846                 Parm->Type = TYPE_INTDEFINE;
 847                 pch ++;
 848         }
 849         else if (*pch == '_') {
 850                 Parm->Type = TYPE_GETTEXT;
 851                 pch ++;
 852                 if (*pch == '(') {
 853                         pch ++;
 854                         ParamBrace = 1;
 855                 }
 856         }
 857         else if (*pch == 'B') {
 858                 Parm->Type = TYPE_BSTR;
 859                 pch ++;
 860                 if (*pch == '(') {
 861                         pch ++;
 862                         ParamBrace = 1;
 863                 }
 864         }
 865         else if (*pch == '=') {
 866                 Parm->Type = TYPE_SUBTEMPLATE;
 867                 pch ++;
 868                 if (*pch == '(') {
 869                         pch ++;
 870                         ParamBrace = 1;
 871                 }
 872         }
 873
 874
 875         if (*pch == '"')
 876                 quote = '"';
 877         else if (*pch == '\'')
 878                 quote = '\'';
 879         if (quote != '\0') {
 880                 pch ++;
 881                 pchs = pch;
 882                 while (pch <= pe &&
 883                        ((*pch != quote) ||
 884                         ( (pch > pchs) && (*(pch - 1) == '\\'))
 885                                )) {
 886                         pch ++;
 887                 }
 888                 pche = pch;
 889                 if (*pch != quote) {
 890                         syslog(LOG_WARNING, "Error (in '%s' line %ld); "
 891                                 "evaluating template param [%s] in Token [%s]\n",
 892                                 ChrPtr(pTmpl->FileName),
 893                                 Tokens->Line,
 894                                 ChrPtr(Tokens->FlatToken),
 895                                 *pCh);
 896                         pch ++;
 897                         free(Parm);
 898                         *pParm = NULL;
 899                         return 0;
 900                 }
 901                 else {
 902                         StrBufPeek(Buf, pch, -1, '\0');
 903                         if (LoadTemplates > 1) {
 904                                 syslog(LOG_DEBUG,
 905                                         "DBG: got param [%s] "SIZE_T_FMT" "SIZE_T_FMT"\n",
 906                                         pchs, pche - pchs, strlen(pchs)
 907                                 );
 908                         }
 909                         Parm->Start = pchs;
 910                         Parm->len = pche - pchs;
 911                         pch ++; /* move after trailing quote */
 912                         if (ParamBrace && (*pch == ')')) {
 913                                 pch ++;
 914                         }
 915
 916                 }
 917         }
 918         else {
 919                 Parm->Type = TYPE_LONG;
 920                 pchs = pch;
 921                 while ((pch <= pe) &&
 922                        (isdigit(*pch) ||
 923                         (*pch == '+') ||
 924                         (*pch == '-')))
 925                         pch ++;
 926                 pch ++;
 927                 if (pch - pchs > 1){
 928                         StrBufPeek(Buf, pch, -1, '\0');
 929                         Parm->lvalue = atol(pchs);
 930                         Parm->Start = pchs;
 931                         pch++;
 932                 }
 933                 else {
 934                         Parm->lvalue = 0;
 935 /* TODO whUT?
 936                         syslog(LOG_DEBUG, "Error (in '%s' line %ld); "
 937                                 "evaluating long template param [%s] in Token [%s]\n",
 938                                 ChrPtr(pTmpl->FileName),
 939                                 Tokens->Line,
 940                                 ChrPtr(Tokens->FlatToken),
 941                                 *pCh);
 942                                 */
 943                         free(Parm);
 944                         *pParm = NULL;
 945                         return 0;
 946                 }
 947         }
 948         while ((*pch == ' ' )||
 949                (*pch == '\t')||
 950                (*pch == '\r')||
 951                (*pch == ',' )||
 952                (*pch == '\n')) pch ++;
 953
 954         switch (Parm->Type)
 955         {
 956         case TYPE_GETTEXT:
 957                 if (DumpTemplateI18NStrings) {
 958                         StrBufAppendPrintf(I18nDump, "_(\"%s\");\n", Parm->Start);
 959                 }
 960                 break;
 961         case TYPE_INTDEFINE: {
 962                 void *vPVal;
 963
 964                 if (GetHash(Defines, Parm->Start, Parm->len, &vPVal) &&
 965                     (vPVal != NULL))
 966                 {
 967                         long *PVal;
 968                         PVal = (long*) vPVal;
 969
 970                         Parm->lvalue = *PVal;
 971                 }
 972                 else if (strchr(Parm->Start, '|') != NULL)
 973                 {
 974                         const char *Pos;
 975                         StrBuf *pToken;
 976                         StrBuf *Match;
 977
 978                         Parm->MaskBy = eOR;
 979                         pToken = NewStrBufPlain (Parm->Start, Parm->len);
 980                         Match = NewStrBufPlain (NULL, Parm->len);
 981                         Pos = ChrPtr(pToken);
 982
 983                         while ((Pos != NULL) && (Pos != StrBufNOTNULL))
 984                         {
 985                                 StrBufExtract_NextToken(Match, pToken, &Pos, '|');
 986                                 StrBufTrim(Match);
 987                                 if (StrLength (Match) > 0)
 988                                 {
 989                                         if (GetHash(Defines, SKEY(Match), &vPVal) &&
 990                                             (vPVal != NULL))
 991                                         {
 992                                                 long *PVal;
 993                                                 PVal = (long*) vPVal;
 994
 995                                                 Parm->lvalue |= *PVal;
 996                                         }
 997                                         else {
 998                                                 LogTemplateError(NULL, "Define",
 999                                                                  Tokens->nParameters,
1000                                                                  TP,
1001                                                                  "%s isn't known!!",
1002                                                                  ChrPtr(Match));
1003
1004                                         }
1005                                 }
1006                         }
1007                         FreeStrBuf(&pToken);
1008                         FreeStrBuf(&Match);
1009                 }
1010                 else if (strchr(Parm->Start, '&') != NULL)
1011                 {
1012                         const char *Pos;
1013                         StrBuf *pToken;
1014                         StrBuf *Match;
1015
1016                         Parm->MaskBy = eAND;
1017                         pToken = NewStrBufPlain (Parm->Start, Parm->len);
1018                         Match = NewStrBufPlain (NULL, Parm->len);
1019                         Pos = ChrPtr(pToken);
1020
1021                         while ((Pos != NULL) && (Pos != StrBufNOTNULL))
1022                         {
1023                                 StrBufExtract_NextToken(Match, pToken, &Pos, '&');
1024                                 StrBufTrim(Match);
1025                                 if (StrLength (Match) > 0)
1026                                 {
1027                                         if (GetHash(Defines, SKEY(Match), &vPVal) &&
1028                                             (vPVal != NULL))
1029                                         {
1030                                                 long *PVal;
1031                                                 PVal = (long*) vPVal;
1032
1033                                                 Parm->lvalue |= *PVal;
1034                                         }
1035                                         else {
1036                                                 LogTemplateError(NULL, "Define",
1037                                                                  Tokens->nParameters,
1038                                                                  TP,
1039                                                                  "%s isn't known!!",
1040                                                                  ChrPtr(Match));
1041
1042                                         }
1043                                 }
1044                         }
1045                         FreeStrBuf(&Match);
1046                         FreeStrBuf(&pToken);
1047                 }
1048                 else {
1049
1050
1051                         LogTemplateError(NULL, "Define",
1052                                          Tokens->nParameters,
1053                                          TP,
1054                                          "%s isn't known!!",
1055                                          Parm->Start);
1056                 }}
1057                 break;
1058         case TYPE_SUBTEMPLATE:{
1059                 void *vTmpl;
1060                 /* well, we don't check the mobile stuff here... */
1061                 if (!GetHash(LocalTemplateCache, Parm->Start, Parm->len, &vTmpl) &&
1062                     !GetHash(TemplateCache, Parm->Start, Parm->len, &vTmpl)) {
1063                         LogTemplateError(NULL,
1064                                          "SubTemplate",
1065                                          Tokens->nParameters,
1066                                          TP,
1067                                          "referenced here doesn't exist");
1068                 }}
1069                 break;
1070         }
1071         *pCh = pch;
1072         return 1;
1073 }
1074
1075 WCTemplateToken *NewTemplateSubstitute(StrBuf *Buf,
1076                                        const char *pStart,
1077                                        const char *pTokenStart,
1078                                        const char *pTokenEnd,
1079                                        long Line,
1080                                        WCTemplate *pTmpl)
1081 {
1082         void *vVar;
1083         const char *pch;
1084         WCTemplateToken *NewToken;
1085         WCTemplputParams TP;
1086
1087         NewToken = (WCTemplateToken*)malloc(sizeof(WCTemplateToken));
1088         memset(NewToken, 0, sizeof(WCTemplateToken));
1089         TP.Tokens = NewToken;
1090         NewToken->FileName = pTmpl->FileName; /* to print meaningfull log messages... */
1091         NewToken->Flags = 0;
1092         NewToken->Line = Line + 1;
1093         NewToken->pTokenStart = pTokenStart;
1094         NewToken->TokenStart = pTokenStart - pStart;
1095         NewToken->TokenEnd =  (pTokenEnd - pStart) - NewToken->TokenStart;
1096         NewToken->pTokenEnd = pTokenEnd;
1097         NewToken->NameEnd = NewToken->TokenEnd - 2;
1098         NewToken->PreEval = NULL;
1099         NewToken->FlatToken = NewStrBufPlain(pTokenStart + 2, pTokenEnd - pTokenStart - 2);
1100         StrBufShrinkToFit(NewToken->FlatToken, 1);
1101
1102         StrBufPeek(Buf, pTokenStart, + 1, '\0');
1103         StrBufPeek(Buf, pTokenEnd, -1, '\0');
1104         pch = NewToken->pName = pTokenStart + 2;
1105
1106         NewToken->HaveParameters = 0;;
1107         NewToken->nParameters = 0;
1108
1109         while (pch < pTokenEnd - 1) {
1110                 if (*pch == '(') {
1111                         StrBufPeek(Buf, pch, -1, '\0');
1112                         NewToken->NameEnd = pch - NewToken->pName;
1113                         pch ++;
1114                         if (*(pTokenEnd - 1) != ')') {
1115                                 LogTemplateError(
1116                                         NULL, "Parseerror", ERR_NAME, &TP,
1117                                         "Warning, Non welformed Token; missing right parenthesis");
1118                         }
1119                         while (pch < pTokenEnd - 1) {
1120                                 NewToken->nParameters++;
1121                                 if (GetNextParameter(Buf,
1122                                                      &pch,
1123                                                      pTokenEnd - 1,
1124                                                      NewToken,
1125                                                      pTmpl,
1126                                                      &TP,
1127                                                      &NewToken->Params[NewToken->nParameters - 1]))
1128                                 {
1129                                         NewToken->HaveParameters = 1;
1130                                         if (NewToken->nParameters >= MAXPARAM) {
1131                                                 LogTemplateError(
1132                                                         NULL, "Parseerror", ERR_NAME, &TP,
1133                                                         "only [%d] Params allowed in Tokens",
1134                                                         MAXPARAM);
1135
1136                                                 FreeToken(&NewToken);
1137                                                 return NULL;
1138                                         }
1139                                 }
1140                                 else break;
1141                         }
1142                         if((NewToken->NameEnd == 1) &&
1143                            (NewToken->HaveParameters == 1))
1144
1145                         {
1146                                 if (*(NewToken->pName) == '_')
1147                                         NewToken->Flags = SV_GETTEXT;
1148                                 else if (*(NewToken->pName) == '=')
1149                                         NewToken->Flags = SV_SUBTEMPL;
1150                                 else if (*(NewToken->pName) == '%')
1151                                         NewToken->Flags = SV_CUST_STR_CONDITIONAL;
1152                                 else if (*(NewToken->pName) == '?')
1153                                         NewToken->Flags = SV_CONDITIONAL;
1154                                 else if (*(NewToken->pName) == '!')
1155                                         NewToken->Flags = SV_NEG_CONDITIONAL;
1156                         }
1157                 }
1158                 else pch ++;
1159         }
1160
1161         switch (NewToken->Flags) {
1162         case 0:
1163                 /* If we're able to find out more about the token, do it now while its fresh. */
1164                 pch = NewToken->pName;
1165                 while (pch <  NewToken->pName + NewToken->NameEnd)
1166                 {
1167                         if (((*pch >= 'A') && (*pch <= 'Z')) ||
1168                             ((*pch >= '0') && (*pch <= '9')) ||
1169                             (*pch == ':') ||
1170                             (*pch == '-') ||
1171                             (*pch == '_'))
1172                                 pch ++;
1173                         else
1174                         {
1175                                 LogTemplateError(
1176                                         NULL, "Token Name", ERR_NAME, &TP,
1177                                         "contains illegal char: '%c'",
1178                                         *pch);
1179                                 pch++;
1180                         }
1181
1182                 }
1183                 if (GetHash(GlobalNS, NewToken->pName, NewToken->NameEnd, &vVar)) {
1184                         HashHandler *Handler;
1185                         Handler = (HashHandler*) vVar;
1186                         if ((NewToken->nParameters < Handler->Filter.nMinArgs) ||
1187                             (NewToken->nParameters > Handler->Filter.nMaxArgs)) {
1188                                 LogTemplateError(
1189                                         NULL, "Token", ERR_NAME, &TP,
1190                                         "doesn't work with %d params",
1191                                         NewToken->nParameters);
1192
1193                         }
1194                         else {
1195                                 NewToken->PreEval = Handler;
1196                                 NewToken->Flags = SV_PREEVALUATED;
1197                                 if (Handler->PreEvalFunc != NULL)
1198                                         Handler->PreEvalFunc(NewToken);
1199                         }
1200                 } else {
1201                         LogTemplateError(
1202                                 NULL, "Token ", ERR_NAME, &TP,
1203                                 " isn't known to us.");
1204                 }
1205                 break;
1206         case SV_GETTEXT:
1207                 if ((NewToken->nParameters < 1) || (NewToken->nParameters > 2)) {
1208                         LogTemplateError(
1209                                 NULL, "Gettext", ERR_NAME, &TP,
1210                                 "requires 1 or 2 parameter, you gave %d params",
1211                                 NewToken->nParameters);
1212                         NewToken->Flags = 0;
1213                         break;
1214                 }
1215                 if (DumpTemplateI18NStrings) {
1216                         StrBufAppendPrintf(I18nDump, "_(\"%s\");\n", NewToken->Params[0]->Start);
1217                 }
1218                 break;
1219         case SV_SUBTEMPL:
1220                 if (NewToken->nParameters != 1) {
1221                         LogTemplateError(
1222                                 NULL, "Subtemplates", ERR_NAME, &TP,
1223                                 "require exactly 1 parameter, you gave %d params",
1224                                 NewToken->nParameters);
1225                         break;
1226                 }
1227                 else {
1228                         void *vTmpl;
1229                         /* well, we don't check the mobile stuff here... */
1230                         if (!GetHash(LocalTemplateCache,
1231                                      NewToken->Params[0]->Start,
1232                                      NewToken->Params[0]->len,
1233                                      &vTmpl) &&
1234                             !GetHash(TemplateCache,
1235                                      NewToken->Params[0]->Start,
1236                                      NewToken->Params[0]->len,
1237                                      &vTmpl)) {
1238                                 LogTemplateError(
1239                                         NULL, "SubTemplate", ERR_PARM1, &TP,
1240                                         "doesn't exist");
1241                         }
1242                 }
1243                 break;
1244         case SV_CUST_STR_CONDITIONAL:
1245         case SV_CONDITIONAL:
1246         case SV_NEG_CONDITIONAL:
1247                 if (NewToken->nParameters <2) {
1248                         LogTemplateError(
1249                                 NULL, "Conditional", ERR_PARM1, &TP,
1250                                 "require at least 2 parameters, you gave %d params",
1251                                 NewToken->nParameters);
1252                         NewToken->Flags = 0;
1253                         break;
1254                 }
1255                 if (NewToken->Params[1]->lvalue == 0) {
1256                         LogTemplateError(
1257                                 NULL, "Conditional", ERR_PARM1, &TP,
1258                                 "Conditional ID (Parameter 1) mustn't be 0!");
1259                         NewToken->Flags = 0;
1260                         break;
1261                 }
1262                 if (!GetHash(Conditionals,
1263                              NewToken->Params[0]->Start,
1264                              NewToken->Params[0]->len,
1265                              &vVar) ||
1266                     (vVar == NULL)) {
1267                         if ((NewToken->Params[0]->len == 1) &&
1268                             (NewToken->Params[0]->Start[0] == 'X'))
1269                                 break;
1270                         LogTemplateError(
1271                                 NULL, "Conditional", ERR_PARM1, &TP,
1272                                 "Not found!");
1273 /*
1274                         NewToken->Error = NewStrBuf();
1275                         StrBufAppendPrintf(
1276                                 NewToken->Error,
1277                                 "<pre>\nConditional [%s] (in '%s' line %ld); Not found!\n[%s]\n</pre>\n",
1278                                 NewToken->Params[0]->Start,
1279                                 ChrPtr(pTmpl->FileName),
1280                                 NewToken->Line,
1281                                 ChrPtr(NewToken->FlatToken));
1282 */
1283                 }
1284                 else {
1285                         NewToken->PreEval = vVar;
1286                 }
1287                 break;
1288         }
1289         return NewToken;
1290 }
1291
1292
1293
1294
1295
1296 /**
1297  * \brief Display a variable-substituted template
1298  * \param templatename template file to load
1299  */
1300 void *prepare_template(StrBuf *filename, StrBuf *Key, HashList *PutThere)
1301 {
1302         WCTemplate *NewTemplate;
1303
1304         NewTemplate = (WCTemplate *) malloc(sizeof(WCTemplate));
1305         memset(NewTemplate, 0, sizeof(WCTemplate));
1306         NewTemplate->Data = NULL;
1307         NewTemplate->FileName = NewStrBufDup(filename);
1308         StrBufShrinkToFit(NewTemplate->FileName, 1);
1309         NewTemplate->nTokensUsed = 0;
1310         NewTemplate->TokenSpace = 0;
1311         NewTemplate->Tokens = NULL;
1312         NewTemplate->MimeType = NewStrBufPlain(GuessMimeByFilename (SKEY(NewTemplate->FileName)), -1);
1313         if (strstr(ChrPtr(NewTemplate->MimeType), "text") != NULL) {
1314                 StrBufAppendBufPlain(NewTemplate->MimeType, HKEY("; charset=utf-8"), 0);
1315         }
1316
1317         if (strstr(ChrPtr(NewTemplate->MimeType), "text") != NULL) {
1318                 StrBufAppendBufPlain(NewTemplate->MimeType, HKEY("; charset=utf-8"), 0);
1319         }
1320
1321         Put(PutThere, ChrPtr(Key), StrLength(Key), NewTemplate, FreeWCTemplate);
1322         return NewTemplate;
1323 }
1324
1325 /**
1326  * \brief Display a variable-substituted template
1327  * \param templatename template file to load
1328  */
1329 void *duplicate_template(WCTemplate *OldTemplate)
1330 {
1331         WCTemplate *NewTemplate;
1332
1333         NewTemplate = (WCTemplate *) malloc(sizeof(WCTemplate));
1334         memset(NewTemplate, 0, sizeof(WCTemplate));
1335         NewTemplate->Data = NULL;
1336         NewTemplate->FileName = NewStrBufDup(OldTemplate->FileName);
1337         StrBufShrinkToFit(NewTemplate->FileName, 1);
1338         NewTemplate->nTokensUsed = 0;
1339         NewTemplate->TokenSpace = 0;
1340         NewTemplate->Tokens = NULL;
1341         NewTemplate->MimeType = NewStrBufDup(OldTemplate->MimeType);
1342         return NewTemplate;
1343 }
1344
1345
1346 void SanityCheckTemplate(StrBuf *Target, WCTemplate *CheckMe)
1347 {
1348         int i = 0;
1349         int j;
1350         int FoundConditionalEnd;
1351
1352         for (i = 0; i < CheckMe->nTokensUsed; i++)
1353         {
1354                 switch(CheckMe->Tokens[i]->Flags)
1355                 {
1356                 case SV_CONDITIONAL:
1357                 case SV_NEG_CONDITIONAL:
1358                         FoundConditionalEnd = 0;
1359                         if ((CheckMe->Tokens[i]->Params[0]->len == 1) &&
1360                             (CheckMe->Tokens[i]->Params[0]->Start[0] == 'X'))
1361                                 break;
1362                         for (j = i + 1; j < CheckMe->nTokensUsed; j++)
1363                         {
1364                                 if (((CheckMe->Tokens[j]->Flags == SV_CONDITIONAL) ||
1365                                      (CheckMe->Tokens[j]->Flags == SV_NEG_CONDITIONAL)) &&
1366                                     (CheckMe->Tokens[i]->Params[1]->lvalue ==
1367                                      CheckMe->Tokens[j]->Params[1]->lvalue))
1368                                 {
1369                                         FoundConditionalEnd = 1;
1370                                         break;
1371                                 }
1372
1373                         }
1374                         if (!FoundConditionalEnd)
1375                         {
1376                                 WCTemplputParams TP;
1377                                 memset(&TP, 0, sizeof(WCTemplputParams));
1378                                 TP.Tokens = CheckMe->Tokens[i];
1379                                 LogTemplateError(
1380                                         Target, "Token", ERR_PARM1, &TP,
1381                                         "Conditional without Endconditional"
1382                                         );
1383                         }
1384                         break;
1385                 default:
1386                         break;
1387                 }
1388         }
1389 }
1390
1391 /**
1392  * \brief Display a variable-substituted template
1393  * \param templatename template file to load
1394  */
1395 void *load_template(StrBuf *Target, WCTemplate *NewTemplate)
1396 {
1397         int fd;
1398         struct stat statbuf;
1399         const char *pS, *pE, *pch, *Err;
1400         long Line;
1401
1402         fd = open(ChrPtr(NewTemplate->FileName), O_RDONLY);
1403         if (fd <= 0) {
1404                 syslog(LOG_WARNING, "ERROR: could not open template '%s' - %s\n",
1405                         ChrPtr(NewTemplate->FileName), strerror(errno));
1406                 return NULL;
1407         }
1408
1409         if (fstat(fd, &statbuf) == -1) {
1410                 syslog(LOG_WARNING, "ERROR: could not stat template '%s' - %s\n",
1411                         ChrPtr(NewTemplate->FileName), strerror(errno));
1412                 return NULL;
1413         }
1414
1415         NewTemplate->Data = NewStrBufPlain(NULL, statbuf.st_size + 1);
1416         if (StrBufReadBLOB(NewTemplate->Data, &fd, 1, statbuf.st_size, &Err) < 0) {
1417                 close(fd);
1418                 syslog(LOG_WARNING, "ERROR: reading template '%s' - %s<br>\n",
1419                         ChrPtr(NewTemplate->FileName), strerror(errno));
1420                 return NULL;
1421         }
1422         close(fd);
1423
1424         Line = 0;
1425         StrBufShrinkToFit(NewTemplate->Data, 1);
1426         StrBufShrinkToFit(NewTemplate->MimeType, 1);
1427         pS = pch = ChrPtr(NewTemplate->Data);
1428         pE = pS + StrLength(NewTemplate->Data);
1429         while (pch < pE) {
1430                 const char *pts, *pte;
1431                 char InQuotes = '\0';
1432                 void *pv;
1433
1434                 /** Find one <? > */
1435                 for (; pch < pE; pch ++) {
1436                         if ((*pch=='<')&&(*(pch + 1)=='?') &&
1437                             !((pch == pS) && /* we must ommit a <?xml */
1438                               (*(pch + 2) == 'x') &&
1439                               (*(pch + 3) == 'm') &&
1440                               (*(pch + 4) == 'l')))
1441                                 break;
1442                         if (*pch=='\n') Line ++;
1443                 }
1444                 if (pch >= pE)
1445                         continue;
1446                 pts = pch;
1447
1448                 /** Found one? parse it. */
1449                 for (; pch <= pE - 1; pch ++) {
1450                         if ((!InQuotes) &&
1451                             ((*pch == '\'') || (*pch == '"')))
1452                         {
1453                                 InQuotes = *pch;
1454                         }
1455                         else if (InQuotes && (InQuotes == *pch))
1456                         {
1457                                 InQuotes = '\0';
1458                         }
1459                         else if ((InQuotes) &&
1460                                  (*pch == '\\') &&
1461                                  (*(pch + 1) == InQuotes))
1462                         {
1463                                 pch++;
1464                         }
1465                         else if ((!InQuotes) &&
1466                                  (*pch == '>'))
1467                         {
1468                                 break;
1469                         }
1470                 }
1471                 if (pch + 1 > pE)
1472                         continue;
1473                 pte = pch;
1474                 pv = NewTemplateSubstitute(NewTemplate->Data, pS, pts, pte, Line, NewTemplate);
1475                 if (pv != NULL) {
1476                         PutNewToken(NewTemplate, pv);
1477                         pch ++;
1478                 }
1479         }
1480
1481         SanityCheckTemplate(NULL, NewTemplate);
1482         return NewTemplate;
1483 }
1484
1485
1486 const char* PrintTemplate(void *vSubst)
1487 {
1488         WCTemplate *Tmpl = vSubst;
1489
1490         return ChrPtr(Tmpl->FileName);
1491
1492 }
1493
1494 int LoadTemplateDir(const StrBuf *DirName, HashList *big, const StrBuf *BaseKey)
1495 {
1496         int Toplevel;
1497         StrBuf *FileName;
1498         StrBuf *Key;
1499         StrBuf *SubKey;
1500         StrBuf *SubDirectory;
1501         DIR *filedir = NULL;
1502         struct dirent *filedir_entry;
1503         struct dirent *d;
1504         int d_type = 0;
1505         int d_namelen;
1506         int d_without_ext;
1507
1508         d = (struct dirent *)malloc(offsetof(struct dirent, d_name) + PATH_MAX + 1);
1509         if (d == NULL) {
1510                 return 0;
1511         }
1512
1513         filedir = opendir (ChrPtr(DirName));
1514         if (filedir == NULL) {
1515                 free(d);
1516                 return 0;
1517         }
1518
1519         Toplevel = StrLength(BaseKey) == 0;
1520         SubDirectory = NewStrBuf();
1521         SubKey = NewStrBuf();
1522         FileName = NewStrBufPlain(NULL, PATH_MAX);
1523         Key = NewStrBuf();
1524         while ((readdir_r(filedir, d, &filedir_entry) == 0) &&
1525                (filedir_entry != NULL))
1526         {
1527                 char *MinorPtr;
1528
1529 #ifdef _DIRENT_HAVE_D_NAMLEN
1530                 d_namelen = filedir_entry->d_namlen;
1531 #else
1532                 d_namelen = strlen(filedir_entry->d_name);
1533 #endif
1534
1535 #ifdef _DIRENT_HAVE_D_TYPE
1536                 d_type = filedir_entry->d_type;
1537 #else
1538
1539 #ifndef DT_UNKNOWN
1540 #define DT_UNKNOWN     0
1541 #define DT_DIR         4
1542 #define DT_REG         8
1543 #define DT_LNK         10
1544
1545 #define IFTODT(mode)   (((mode) & 0170000) >> 12)
1546 #define DTTOIF(dirtype)        ((dirtype) << 12)
1547 #endif
1548                 d_type = DT_UNKNOWN;
1549 #endif
1550                 d_without_ext = d_namelen;
1551
1552                 if ((d_namelen > 1) && filedir_entry->d_name[d_namelen - 1] == '~')
1553                         continue; /* Ignore backup files... */
1554
1555                 if ((d_namelen == 1) &&
1556                     (filedir_entry->d_name[0] == '.'))
1557                         continue;
1558
1559                 if ((d_namelen == 2) &&
1560                     (filedir_entry->d_name[0] == '.') &&
1561                     (filedir_entry->d_name[1] == '.'))
1562                         continue;
1563
1564                 if (d_type == DT_UNKNOWN) {
1565                         struct stat s;
1566                         char path[PATH_MAX];
1567                         snprintf(path, PATH_MAX, "%s/%s",
1568                                  ChrPtr(DirName), filedir_entry->d_name);
1569                         if (lstat(path, &s) == 0) {
1570                                 d_type = IFTODT(s.st_mode);
1571                         }
1572                 }
1573                 switch (d_type)
1574                 {
1575                 case DT_DIR:
1576                         /* Skip directories we are not interested in... */
1577                         if (strcmp(filedir_entry->d_name, ".svn") == 0)
1578                                 continue;
1579
1580                         FlushStrBuf(SubKey);
1581                         if (!Toplevel) {
1582                                 /* If we're not toplevel, the upper dirs count as foo_bar_<local name>*/
1583                                 StrBufAppendBuf(SubKey, BaseKey, 0);
1584                                 StrBufAppendBufPlain(SubKey, HKEY("_"), 0);
1585                         }
1586                         StrBufAppendBufPlain(SubKey, filedir_entry->d_name, d_namelen, 0);
1587
1588                         FlushStrBuf(SubDirectory);
1589                         StrBufAppendBuf(SubDirectory, DirName, 0);
1590                         if (ChrPtr(SubDirectory)[StrLength(SubDirectory) - 1] != '/')
1591                                 StrBufAppendBufPlain(SubDirectory, HKEY("/"), 0);
1592                         StrBufAppendBufPlain(SubDirectory, filedir_entry->d_name, d_namelen, 0);
1593
1594                         LoadTemplateDir(SubDirectory, big, SubKey);
1595
1596                         break;
1597                 case DT_LNK:
1598                 case DT_REG:
1599
1600
1601                         while ((d_without_ext > 0) && (filedir_entry->d_name[d_without_ext] != '.'))
1602                                 d_without_ext --;
1603                         if ((d_without_ext == 0) || (d_namelen < 3))
1604                                 continue;
1605                         if (((d_namelen > 1) && filedir_entry->d_name[d_namelen - 1] == '~') ||
1606                             (strcmp(&filedir_entry->d_name[d_without_ext], ".orig") == 0) ||
1607                             (strcmp(&filedir_entry->d_name[d_without_ext], ".swp") == 0))
1608                                 continue; /* Ignore backup files... */
1609                         StrBufPrintf(FileName, "%s/%s", ChrPtr(DirName),  filedir_entry->d_name);
1610                         MinorPtr = strchr(filedir_entry->d_name, '.');
1611                         if (MinorPtr != NULL)
1612                                 *MinorPtr = '\0';
1613                         FlushStrBuf(Key);
1614                         if (!Toplevel) {
1615                                 /* If we're not toplevel, the upper dirs count as foo_bar_<local name>*/
1616                                 StrBufAppendBuf(Key, BaseKey, 0);
1617                                 StrBufAppendBufPlain(Key, HKEY("_"), 0);
1618                         }
1619                         StrBufAppendBufPlain(Key, filedir_entry->d_name, MinorPtr - filedir_entry->d_name, 0);
1620
1621                         if (LoadTemplates >= 1)
1622                                 syslog(LOG_DEBUG, "%s %s\n", ChrPtr(FileName), ChrPtr(Key));
1623                         prepare_template(FileName, Key, big);
1624                 default:
1625                         break;
1626                 }
1627         }
1628         free(d);
1629         closedir(filedir);
1630         FreeStrBuf(&FileName);
1631         FreeStrBuf(&Key);
1632         FreeStrBuf(&SubDirectory);
1633         FreeStrBuf(&SubKey);
1634         return 1;
1635 }
1636
1637 void InitTemplateCache(void)
1638 {
1639         int i;
1640         StrBuf *Key;
1641         StrBuf *Dir;
1642         HashList *Templates[2];
1643
1644         Dir = NewStrBuf();
1645         Key = NewStrBuf();
1646
1647         /* Primary Template set... */
1648         StrBufPrintf(Dir, "%s/t", static_dirs[0]);
1649         LoadTemplateDir(Dir,
1650                         TemplateCache,
1651                         Key);
1652
1653         /* User local Template set */
1654         StrBufPrintf(Dir, "%s/t", static_dirs[1]);
1655         LoadTemplateDir(Dir,
1656                         LocalTemplateCache,
1657                         Key);
1658
1659         /* Debug Templates, just to be loaded while debugging. */
1660
1661         StrBufPrintf(Dir, "%s/dbg", static_dirs[0]);
1662         LoadTemplateDir(Dir,
1663                         TemplateCache,
1664                         Key);
1665         Templates[0] = TemplateCache;
1666         Templates[1] = LocalTemplateCache;
1667
1668
1669         if (LoadTemplates == 0)
1670                 for (i=0; i < 2; i++) {
1671                         const char *Key;
1672                         long KLen;
1673                         HashPos *At;
1674                         void *vTemplate;
1675
1676                         At = GetNewHashPos(Templates[i], 0);
1677                         while (GetNextHashPos(Templates[i],
1678                                               At,
1679                                               &KLen,
1680                                               &Key,
1681                                               &vTemplate) &&
1682                                (vTemplate != NULL))
1683                         {
1684                                 load_template(NULL, (WCTemplate *)vTemplate);
1685                         }
1686                         DeleteHashPos(&At);
1687                 }
1688
1689
1690         FreeStrBuf(&Dir);
1691         FreeStrBuf(&Key);
1692 }
1693
1694
1695
1696 /*-----------------------------------------------------------------------------
1697  *                      Filling & processing Templates
1698  */
1699 /**
1700  * \brief executes one token
1701  * \param Target buffer to append to
1702  * \param Token da to  process.
1703  * \param Template we're iterating
1704  * \param Context Contextpoointer to pass in
1705  * \param state are we in conditional state?
1706  * \param ContextType what type of information does context giv us?
1707  */
1708 int EvaluateToken(StrBuf *Target, int state, WCTemplputParams **TPP)
1709 {
1710         const char *AppendMe;
1711         long AppendMeLen;
1712         HashHandler *Handler;
1713         void *vVar;
1714         WCTemplputParams *TP = *TPP;
1715
1716 /* much output, since pName is not terminated...
1717         syslog(LOG_DEBUG,"Doing token: %s\n",Token->pName);
1718 */
1719
1720         switch (TP->Tokens->Flags) {
1721         case SV_GETTEXT:
1722                 TmplGettext(Target, TP);
1723                 break;
1724         case SV_CONDITIONAL: /** Forward conditional evaluation */
1725                 Handler = (HashHandler*) TP->Tokens->PreEval;
1726                 if (!CheckContext(Target, &Handler->Filter, TP, "Conditional")) {
1727                         return 0;
1728                 }
1729                 return EvaluateConditional(Target, 1, state, TPP);
1730                 break;
1731         case SV_NEG_CONDITIONAL: /** Reverse conditional evaluation */
1732                 Handler = (HashHandler*) TP->Tokens->PreEval;
1733                 if (!CheckContext(Target, &Handler->Filter, TP, "Conditional")) {
1734                         return 0;
1735                 }
1736                 return EvaluateConditional(Target, 0, state, TPP);
1737                 break;
1738         case SV_CUST_STR_CONDITIONAL: /** Conditional put custom strings from params */
1739                 Handler = (HashHandler*) TP->Tokens->PreEval;
1740                 if (!CheckContext(Target, &Handler->Filter, TP, "Conditional")) {
1741                         return 0;
1742                 }
1743                 if (TP->Tokens->nParameters >= 6) {
1744                         if (EvaluateConditional(Target, 0, state, TPP)) {
1745                                 GetTemplateTokenString(Target, TP, 5, &AppendMe, &AppendMeLen);
1746                                 StrBufAppendBufPlain(Target,
1747                                                      AppendMe,
1748                                                      AppendMeLen,
1749                                                      0);
1750                         }
1751                         else{
1752                                 GetTemplateTokenString(Target, TP, 4, &AppendMe, &AppendMeLen);
1753                                 StrBufAppendBufPlain(Target,
1754                                                      AppendMe,
1755                                                      AppendMeLen,
1756                                                      0);
1757                         }
1758                         if (*TPP != TP)
1759                         {
1760                                 UnStackDynamicContext(Target, TPP);
1761                         }
1762                 }
1763                 else  {
1764                         LogTemplateError(
1765                                 Target, "Conditional", ERR_NAME, TP,
1766                                 "needs at least 6 Params!");
1767                 }
1768                 break;
1769         case SV_SUBTEMPL:
1770                 if (TP->Tokens->nParameters == 1)
1771                         DoTemplate(TKEY(0), Target, TP);
1772                 break;
1773         case SV_PREEVALUATED:
1774                 Handler = (HashHandler*) TP->Tokens->PreEval;
1775                 if (!CheckContext(Target, &Handler->Filter, TP, "Token")) {
1776                         return 0;
1777                 }
1778                 Handler->HandlerFunc(Target, TP);
1779                 break;
1780         default:
1781                 if (GetHash(GlobalNS, TP->Tokens->pName, TP->Tokens->NameEnd, &vVar)) {
1782                         Handler = (HashHandler*) vVar;
1783                         if (!CheckContext(Target, &Handler->Filter, TP, "Token")) {
1784                                 return 0;
1785                         }
1786                         else {
1787                                 Handler->HandlerFunc(Target, TP);
1788                         }
1789                 }
1790                 else {
1791                         LogTemplateError(
1792                                 Target, "Token UNKNOWN", ERR_NAME, TP,
1793                                 "You've specified a token that isn't known to webcit.!");
1794                 }
1795         }
1796         return 0;
1797 }
1798
1799
1800
1801 const StrBuf *ProcessTemplate(WCTemplate *Tmpl, StrBuf *Target, WCTemplputParams *CallingTP)
1802 {
1803         WCTemplate *pTmpl = Tmpl;
1804         int done = 0;
1805         int i;
1806         TemplState state;
1807         const char *pData, *pS;
1808         long len;
1809         WCTemplputParams TP;
1810         WCTemplputParams *TPtr = &TP;
1811
1812         memset(TPtr, 0, sizeof(WCTemplputParams));
1813
1814         memcpy(&TP.Filter, &CallingTP->Filter, sizeof(ContextFilter));
1815
1816         TP.Context = CallingTP->Context;
1817         TP.Sub = CallingTP->Sub;
1818         TP.Super = CallingTP->Super;
1819
1820         if (LoadTemplates != 0) {
1821                 if (LoadTemplates > 1)
1822                         syslog(LOG_DEBUG, "DBG: ----- loading:  [%s] ------ \n",
1823                                 ChrPtr(Tmpl->FileName));
1824                 pTmpl = duplicate_template(Tmpl);
1825                 if(load_template(Target, pTmpl) == NULL) {
1826                         StrBufAppendPrintf(
1827                                 Target,
1828                                 "<pre>\nError loading Template [%s]\n See Logfile for details\n</pre>\n",
1829                                 ChrPtr(Tmpl->FileName));
1830                         FreeWCTemplate(pTmpl);
1831                         return NULL;
1832                 }
1833
1834         }
1835
1836         pS = pData = ChrPtr(pTmpl->Data);
1837         len = StrLength(pTmpl->Data);
1838         i = 0;
1839         state = eNext;
1840         while (!done) {
1841                 if (i >= pTmpl->nTokensUsed) {
1842                         StrBufAppendBufPlain(Target,
1843                                              pData,
1844                                              len - (pData - pS), 0);
1845                         done = 1;
1846                 }
1847                 else {
1848                         int TokenRc = 0;
1849
1850                         StrBufAppendBufPlain(
1851                                 Target, pData,
1852                                 pTmpl->Tokens[i]->pTokenStart - pData, 0);
1853                         TPtr->Tokens = pTmpl->Tokens[i];
1854                         TPtr->nArgs = pTmpl->Tokens[i]->nParameters;
1855
1856                         TokenRc = EvaluateToken(Target, TokenRc, &TPtr);
1857                         if (TokenRc > 0)
1858                         {
1859                                 state = eSkipTilEnd;
1860                         }
1861                         else if (TokenRc < 0)
1862                         {
1863                                 if ((TPtr != &TP) &&
1864                                     (TPtr->ExitCTXID == -TokenRc))
1865                                 {
1866                                         UnStackDynamicContext(Target, &TPtr);
1867                                 }
1868                                 TokenRc = 0;
1869                         }
1870
1871                         while ((state != eNext) && (i+1 < pTmpl->nTokensUsed)) {
1872                         /* condition told us to skip till its end condition */
1873                                 i++;
1874                                 TPtr->Tokens = pTmpl->Tokens[i];
1875                                 TPtr->nArgs = pTmpl->Tokens[i]->nParameters;
1876                                 if ((pTmpl->Tokens[i]->Flags == SV_CONDITIONAL) ||
1877                                     (pTmpl->Tokens[i]->Flags == SV_NEG_CONDITIONAL))
1878                                 {
1879                                         int rc;
1880                                         rc = EvaluateConditional(
1881                                                 Target,
1882                                                 pTmpl->Tokens[i]->Flags,
1883                                                 TokenRc,
1884                                                 &TPtr);
1885                                         if (-rc == TokenRc)
1886                                         {
1887                                                 TokenRc = 0;
1888                                                 state = eNext;
1889                                                 if ((TPtr != &TP) &&
1890                                                     (TPtr->ExitCTXID == - rc))
1891                                                 {
1892                                                         UnStackDynamicContext(Target, &TPtr);
1893                                                 }
1894                                         }
1895                                 }
1896                         }
1897
1898                         pData = pTmpl->Tokens[i++]->pTokenEnd + 1;
1899                         if (i > pTmpl->nTokensUsed)
1900                                 done = 1;
1901                 }
1902         }
1903         if (LoadTemplates != 0) {
1904                 FreeWCTemplate(pTmpl);
1905         }
1906         return Tmpl->MimeType;
1907
1908 }
1909
1910 /**
1911  * \brief Display a variable-substituted template
1912  * \param templatename template file to load
1913  * \returns the mimetype of the template its doing
1914  */
1915 const StrBuf *DoTemplate(const char *templatename, long len, StrBuf *Target, WCTemplputParams *TP)
1916 {
1917         WCTemplputParams LocalTP;
1918         HashList *Static;
1919         HashList *StaticLocal;
1920         void *vTmpl;
1921
1922         if (Target == NULL)
1923                 Target = WC->WBuf;
1924         if (TP == NULL) {
1925                 memset(&LocalTP, 0, sizeof(WCTemplputParams));
1926                 TP = &LocalTP;
1927         }
1928
1929         Static = TemplateCache;
1930         StaticLocal = LocalTemplateCache;
1931
1932         if (len == 0)
1933         {
1934                 syslog(LOG_WARNING, "Can't to load a template with empty name!\n");
1935                 StrBufAppendPrintf(Target, "<pre>\nCan't to load a template with empty name!\n</pre>");
1936                 return NULL;
1937         }
1938
1939         if (!GetHash(StaticLocal, templatename, len, &vTmpl) &&
1940             !GetHash(Static, templatename, len, &vTmpl)) {
1941                 syslog(LOG_WARNING, "didn't find Template [%s] %ld %ld\n", templatename, len , (long)strlen(templatename));
1942                 StrBufAppendPrintf(Target, "<pre>\ndidn't find Template [%s] %ld %ld\n</pre>",
1943                                    templatename, len,
1944                                    (long)strlen(templatename));
1945 #if 0
1946                 dbg_PrintHash(Static, PrintTemplate, NULL);
1947                 PrintHash(Static, VarPrintTransition, PrintTemplate);
1948 #endif
1949                 return NULL;
1950         }
1951         if (vTmpl == NULL)
1952                 return NULL;
1953         return ProcessTemplate(vTmpl, Target, TP);
1954
1955 }
1956
1957
1958 void tmplput_Comment(StrBuf *Target, WCTemplputParams *TP)
1959 {
1960         if (LoadTemplates != 0)
1961         {
1962                 StrBuf *Comment;
1963                 const char *pch;
1964                 long len;
1965
1966                 GetTemplateTokenString(Target, TP, 0, &pch, &len);
1967                 Comment = NewStrBufPlain(pch, len);
1968                 StrBufAppendBufPlain(Target, HKEY("<!--"), 0);
1969                 StrBufAppendTemplate(Target, TP, Comment, 1);
1970                 StrBufAppendBufPlain(Target, HKEY("-->"), 0);
1971                 FreeStrBuf(&Comment);
1972         }
1973 }
1974
1975 /*-----------------------------------------------------------------------------
1976  *                      Iterators
1977  */
1978 typedef struct _HashIterator {
1979         HashList *StaticList;
1980         int AdditionalParams;
1981         CtxType ContextType;
1982         CtxType XPectContextType;
1983         int Flags;
1984         RetrieveHashlistFunc GetHash;
1985         HashDestructorFunc Destructor;
1986         SubTemplFunc DoSubTemplate;
1987         FilterByParamFunc Filter;
1988 } HashIterator;
1989
1990 void RegisterITERATOR(const char *Name, long len,
1991                       int AdditionalParams,
1992                       HashList *StaticList,
1993                       RetrieveHashlistFunc GetHash,
1994                       SubTemplFunc DoSubTempl,
1995                       HashDestructorFunc Destructor,
1996                       FilterByParamFunc Filter,
1997                       CtxType ContextType,
1998                       CtxType XPectContextType,
1999                       int Flags)
2000 {
2001         HashIterator *It;
2002
2003         It = (HashIterator*)malloc(sizeof(HashIterator));
2004         memset(It, 0, sizeof(HashIterator));
2005         It->StaticList = StaticList;
2006         It->AdditionalParams = AdditionalParams;
2007         It->GetHash = GetHash;
2008         It->DoSubTemplate = DoSubTempl;
2009         It->Destructor = Destructor;
2010         It->Filter = Filter;
2011         It->ContextType = ContextType;
2012         It->XPectContextType = XPectContextType;
2013         It->Flags = Flags;
2014         Put(Iterators, Name, len, It, NULL);
2015 }
2016
2017 typedef struct _iteratestruct {
2018         int GroupChange;
2019         int oddeven;
2020         const char *Key;
2021         long KeyLen;
2022         int n;
2023         int LastN;
2024         }IterateStruct;
2025
2026 int preeval_iterate(WCTemplateToken *Token)
2027 {
2028         WCTemplputParams TPP;
2029         WCTemplputParams *TP;
2030         void *vTmpl;
2031         void *vIt;
2032         HashIterator *It;
2033
2034         memset(&TPP, 0, sizeof(WCTemplputParams));
2035         TP = &TPP;
2036         TP->Tokens = Token;
2037         if (!GetHash(Iterators, TKEY(0), &vIt)) {
2038                 LogTemplateError(
2039                         NULL, "Iterator", ERR_PARM1, TP,
2040                         "not found");
2041                 return 0;
2042         }
2043         if (TP->Tokens->Params[1]->Type != TYPE_SUBTEMPLATE) {
2044                 LogTemplateError(NULL, "Iterator", ERR_PARM1, TP,
2045                                  "Need token with type Subtemplate as param 1, have %s",
2046                                  TP->Tokens->Params[1]->Start);
2047         }
2048
2049         /* well, we don't check the mobile stuff here... */
2050         if (!GetHash(LocalTemplateCache, TKEY(1), &vTmpl) &&
2051             !GetHash(TemplateCache, TKEY(1), &vTmpl)) {
2052                 LogTemplateError(NULL, "SubTemplate", ERR_PARM1, TP,
2053                                  "referenced here doesn't exist");
2054         }
2055         Token->Preeval2 = vIt;
2056         It = (HashIterator *) vIt;
2057
2058         if (TP->Tokens->nParameters < It->AdditionalParams + 2) {
2059                 LogTemplateError(
2060                         NULL, "Iterator", ERR_PARM1, TP,
2061                         "doesn't work with %d params",
2062                         TP->Tokens->nParameters);
2063         }
2064
2065
2066         return 1;
2067 }
2068
2069 void tmpl_iterate_subtmpl(StrBuf *Target, WCTemplputParams *TP)
2070 {
2071         HashIterator *It;
2072         HashList *List;
2073         HashPos  *it;
2074         SortStruct *SortBy = NULL;
2075         void *vSortBy;
2076         int DetectGroupChange = 0;
2077         int nMembersUsed;
2078         void *vContext;
2079         void *vLastContext = NULL;
2080         StrBuf *SubBuf;
2081         WCTemplputParams IterateTP;
2082         WCTemplputParams SubTP;
2083         IterateStruct Status;
2084
2085         long StartAt = 0;
2086         long StepWidth = 0;
2087         long StopAt = -1;
2088
2089         memset(&Status, 0, sizeof(IterateStruct));
2090
2091         It = (HashIterator*) TP->Tokens->Preeval2;
2092         if (It == NULL) {
2093                 LogTemplateError(
2094                         Target, "Iterator", ERR_PARM1, TP, "Unknown!");
2095                 return;
2096         }
2097
2098         if (TP->Tokens->nParameters < It->AdditionalParams + 2) {
2099                 LogTemplateError(
2100                         Target, "Iterator", ERR_PARM1, TP,
2101                         "doesn't work with %d params",
2102                         TP->Tokens->nParameters - 1);
2103                 return;
2104         }
2105
2106         if ((It->XPectContextType != CTX_NONE) &&
2107             (It->XPectContextType != TP->Filter.ContextType)) {
2108                 LogTemplateError(
2109                         Target, "Iterator", ERR_PARM1, TP,
2110                         "requires context of type %s, have %s",
2111                         ContextName(It->XPectContextType),
2112                         ContextName(TP->Filter.ContextType));
2113                 return ;
2114
2115         }
2116
2117         if (It->StaticList == NULL)
2118                 List = It->GetHash(Target, TP);
2119         else
2120                 List = It->StaticList;
2121
2122         DetectGroupChange = (It->Flags & IT_FLAG_DETECT_GROUPCHANGE) != 0;
2123         if (DetectGroupChange) {
2124                 const StrBuf *BSort;
2125                 DetectGroupChange = 0;
2126                 if (havebstr("SortBy")) {
2127                         BSort = sbstr("SortBy");
2128                         if (GetHash(SortHash, SKEY(BSort), &vSortBy) &&
2129                             (vSortBy != NULL)) {
2130                                 SortBy = (SortStruct*)vSortBy;
2131                                 /* first check whether its intended for us... */
2132                                 if ((SortBy->ContextType == It->ContextType)&&
2133                                 /** Ok, its us, lets see in which direction we should sort... */
2134                                     (havebstr("SortOrder"))) {
2135                                         int SortOrder;
2136                                         SortOrder = LBSTR("SortOrder");
2137                                         if (SortOrder != 0)
2138                                                 DetectGroupChange = 1;
2139                                 }
2140                         }
2141                 }
2142         }
2143         nMembersUsed = GetCount(List);
2144
2145         StackContext (TP, &IterateTP, &Status, CTX_ITERATE, 0, TP->Tokens);
2146         {
2147                 SubBuf = NewStrBuf();
2148
2149                 if (HAVE_PARAM(2)) {
2150                         StartAt = GetTemplateTokenNumber(Target, TP, 2, 0);
2151                 }
2152                 if (HAVE_PARAM(3)) {
2153                         StepWidth = GetTemplateTokenNumber(Target, TP, 3, 0);
2154                 }
2155                 if (HAVE_PARAM(4)) {
2156                         StopAt = GetTemplateTokenNumber(Target, TP, 4, -1);
2157                 }
2158                 it = GetNewHashPos(List, StepWidth);
2159                 if (StopAt < 0) {
2160                         StopAt = GetCount(List);
2161                 }
2162                 while (GetNextHashPos(List, it, &Status.KeyLen, &Status.Key, &vContext)) {
2163                         if ((Status.n >= StartAt) && (Status.n <= StopAt)) {
2164
2165                                 if ((It->Filter != NULL) &&
2166                                     It->Filter(Status.Key, Status.KeyLen, vContext, Target, TP))
2167                                 {
2168                                         continue;
2169                                 }
2170
2171                                 if (DetectGroupChange && Status.n > 0) {
2172                                         Status.GroupChange = SortBy->GroupChange(vContext, vLastContext);
2173                                 }
2174                                 Status.LastN = (Status.n + 1) == nMembersUsed;
2175                                 StackContext(&IterateTP, &SubTP, vContext, It->ContextType, 0, NULL);
2176                                 {
2177                                         if (It->DoSubTemplate != NULL)
2178                                                 It->DoSubTemplate(SubBuf, &SubTP);
2179                                         DoTemplate(TKEY(1), SubBuf, &SubTP);
2180
2181                                         StrBufAppendBuf(Target, SubBuf, 0);
2182                                         FlushStrBuf(SubBuf);
2183                                 }
2184                                 UnStackContext(&SubTP);
2185                                 Status.oddeven = ! Status.oddeven;
2186                                 vLastContext = vContext;
2187                         }
2188                         Status.n++;
2189                 }
2190         }
2191         UnStackContext(&IterateTP);
2192         FreeStrBuf(&SubBuf);
2193         DeleteHashPos(&it);
2194         if (It->Destructor != NULL)
2195                 It->Destructor(&List);
2196 }
2197
2198
2199 int conditional_ITERATE_ISGROUPCHANGE(StrBuf *Target, WCTemplputParams *TP)
2200 {
2201         IterateStruct *Ctx = CTX(CTX_ITERATE);
2202         if (TP->Tokens->nParameters < 3)
2203                 return  Ctx->GroupChange;
2204
2205         return TP->Tokens->Params[2]->lvalue == Ctx->GroupChange;
2206 }
2207
2208 void tmplput_ITERATE_ODDEVEN(StrBuf *Target, WCTemplputParams *TP)
2209 {
2210         IterateStruct *Ctx = CTX(CTX_ITERATE);
2211         if (Ctx->oddeven)
2212                 StrBufAppendBufPlain(Target, HKEY("odd"), 0);
2213         else
2214                 StrBufAppendBufPlain(Target, HKEY("even"), 0);
2215 }
2216
2217
2218 void tmplput_ITERATE_KEY(StrBuf *Target, WCTemplputParams *TP)
2219 {
2220         IterateStruct *Ctx = CTX(CTX_ITERATE);
2221
2222         StrBufAppendBufPlain(Target, Ctx->Key, Ctx->KeyLen, 0);
2223 }
2224
2225
2226 void tmplput_ITERATE_LASTN(StrBuf *Target, WCTemplputParams *TP)
2227 {
2228         IterateStruct *Ctx = CTX(CTX_ITERATE);
2229         StrBufAppendPrintf(Target, "%d", Ctx->n);
2230 }
2231
2232 int conditional_ITERATE_FIRSTN(StrBuf *Target, WCTemplputParams *TP)
2233 {
2234         IterateStruct *Ctx = CTX(CTX_ITERATE);
2235         return Ctx->n == 0;
2236 }
2237
2238 int conditional_ITERATE_LASTN(StrBuf *Target, WCTemplputParams *TP)
2239 {
2240         IterateStruct *Ctx = CTX(CTX_ITERATE);
2241         return Ctx->LastN;
2242 }
2243
2244
2245
2246 /*-----------------------------------------------------------------------------
2247  *                      Conditionals
2248  */
2249 int EvaluateConditional(StrBuf *Target, int Neg, int state, WCTemplputParams **TPP)
2250 {
2251         ConditionalStruct *Cond;
2252         int rc = 0;
2253         int res;
2254         WCTemplputParams *TP = *TPP;
2255
2256         if ((TP->Tokens->Params[0]->len == 1) &&
2257             (TP->Tokens->Params[0]->Start[0] == 'X'))
2258         {
2259                 return - (TP->Tokens->Params[1]->lvalue);
2260         }
2261
2262         Cond = (ConditionalStruct *) TP->Tokens->PreEval;
2263         if (Cond == NULL) {
2264                 LogTemplateError(
2265                         Target, "Conditional", ERR_PARM1, TP,
2266                         "unknown!");
2267                 return 0;
2268         }
2269
2270         if (!CheckContext(Target, &Cond->Filter, TP, "Conditional")) {
2271                 return 0;
2272         }
2273
2274         res = Cond->CondF(Target, TP);
2275         if (res == Neg)
2276                 rc = TP->Tokens->Params[1]->lvalue;
2277
2278         if (LoadTemplates > 5)
2279                 syslog(LOG_DEBUG, "<%s> : %d %d==%d\n",
2280                         ChrPtr(TP->Tokens->FlatToken),
2281                         rc, res, Neg);
2282
2283         if (TP->Sub != NULL)
2284         {
2285                 *TPP = TP->Sub;
2286         }
2287         return rc;
2288 }
2289
2290 void RegisterContextConditional(const char *Name, long len,
2291                                 int nParams,
2292                                 WCConditionalFunc CondF,
2293                                 WCConditionalFunc ExitCtxCond,
2294                                 int ContextRequired)
2295 {
2296         ConditionalStruct *Cond;
2297
2298         Cond = (ConditionalStruct*)malloc(sizeof(ConditionalStruct));
2299         memset(Cond, 0, sizeof(ConditionalStruct));
2300         Cond->PlainName = Name;
2301         Cond->Filter.nMaxArgs = nParams;
2302         Cond->Filter.nMinArgs = nParams;
2303         Cond->CondF = CondF;
2304         Cond->CondExitCtx = ExitCtxCond;
2305         Cond->Filter.ContextType = ContextRequired;
2306         Put(Conditionals, Name, len, Cond, NULL);
2307 }
2308
2309 void RegisterTokenParamDefine(const char *Name, long len,
2310                               long Value)
2311 {
2312         long *PVal;
2313
2314         PVal = (long*)malloc(sizeof(long));
2315         *PVal = Value;
2316         Put(Defines, Name, len, PVal, NULL);
2317 }
2318
2319 long GetTokenDefine(const char *Name, long len,
2320                     long DefValue)
2321 {
2322         void *vPVal;
2323
2324         if (GetHash(Defines, Name, len, &vPVal) &&
2325              (vPVal != NULL))
2326          {
2327                  return *(long*) vPVal;
2328          }
2329          else
2330          {
2331                  return DefValue;
2332          }
2333 }
2334
2335 void tmplput_DefStr(StrBuf *Target, WCTemplputParams *TP)
2336 {
2337         const char *Str;
2338         long len;
2339         GetTemplateTokenString(Target, TP, 2, &Str, &len);
2340
2341         StrBufAppendBufPlain(Target, Str, len, 0);
2342 }
2343
2344 void tmplput_DefVal(StrBuf *Target, WCTemplputParams *TP)
2345 {
2346         int val;
2347
2348         val = GetTemplateTokenNumber(Target, TP, 0, 0);
2349         StrBufAppendPrintf(Target, "%d", val);
2350 }
2351
2352 HashList *Defines;
2353
2354 /*-----------------------------------------------------------------------------
2355  *                      Context Strings
2356  */
2357 void tmplput_ContextString(StrBuf *Target, WCTemplputParams *TP)
2358 {
2359         StrBufAppendTemplate(Target, TP, (StrBuf*)CTX(CTX_STRBUF), 0);
2360 }
2361 int ConditionalContextStr(StrBuf *Target, WCTemplputParams *TP)
2362 {
2363         StrBuf *TokenText = (StrBuf*) CTX((CTX_STRBUF));
2364         const char *CompareToken;
2365         long len;
2366
2367         GetTemplateTokenString(Target, TP, 2, &CompareToken, &len);
2368         return strcmp(ChrPtr(TokenText), CompareToken) == 0;
2369 }
2370
2371 void tmplput_ContextStringArray(StrBuf *Target, WCTemplputParams *TP)
2372 {
2373         HashList *Arr = (HashList*) CTX(CTX_STRBUFARR);
2374         void *pV;
2375         int val;
2376
2377         val = GetTemplateTokenNumber(Target, TP, 0, 0);
2378         if (GetHash(Arr, IKEY(val), &pV) &&
2379             (pV != NULL)) {
2380                 StrBufAppendTemplate(Target, TP, (StrBuf*)pV, 1);
2381         }
2382 }
2383 int ConditionalContextStrinArray(StrBuf *Target, WCTemplputParams *TP)
2384 {
2385         HashList *Arr = (HashList*) CTX(CTX_STRBUFARR);
2386         void *pV;
2387         int val;
2388         const char *CompareToken;
2389         long len;
2390
2391         GetTemplateTokenString(Target, TP, 2, &CompareToken, &len);
2392         val = GetTemplateTokenNumber(Target, TP, 0, 0);
2393         if (GetHash(Arr, IKEY(val), &pV) &&
2394             (pV != NULL)) {
2395                 return strcmp(ChrPtr((StrBuf*)pV), CompareToken) == 0;
2396         }
2397         else
2398                 return 0;
2399 }
2400
2401 /*-----------------------------------------------------------------------------
2402  *                      Boxed-API
2403  */
2404
2405 void tmpl_do_boxed(StrBuf *Target, WCTemplputParams *TP)
2406 {
2407         WCTemplputParams SubTP;
2408
2409         StrBuf *Headline = NULL;
2410         if (TP->Tokens->nParameters == 2) {
2411                 if (TP->Tokens->Params[1]->Type == TYPE_STR) {
2412                         Headline = NewStrBuf();
2413                         DoTemplate(TKEY(1), Headline, TP);
2414                 }
2415                 else {
2416                         const char *Ch;
2417                         long len;
2418                         GetTemplateTokenString(Target,
2419                                                TP,
2420                                                1,
2421                                                &Ch,
2422                                                &len);
2423                         Headline = NewStrBufPlain(Ch, len);
2424                 }
2425         }
2426         /* else TODO error? logging? */
2427
2428         StackContext (TP, &SubTP, Headline, CTX_STRBUF, 0, NULL);
2429         {
2430                 DoTemplate(HKEY("box_begin"), Target, &SubTP);
2431         }
2432         UnStackContext(&SubTP);
2433         DoTemplate(TKEY(0), Target, TP);
2434         DoTemplate(HKEY("box_end"), Target, TP);
2435         FreeStrBuf(&Headline);
2436 }
2437
2438 /*-----------------------------------------------------------------------------
2439  *                      Tabbed-API
2440  */
2441
2442 typedef struct _tab_struct {
2443         long CurrentTab;
2444         StrBuf *TabTitle;
2445 } tab_struct;
2446
2447 int preeval_do_tabbed(WCTemplateToken *Token)
2448 {
2449         WCTemplputParams TPP;
2450         WCTemplputParams *TP;
2451         const char *Ch;
2452         long len;
2453         int i, nTabs;
2454
2455         memset(&TPP, 0, sizeof(WCTemplputParams));
2456         TP = &TPP;
2457         TP->Tokens = Token;
2458         nTabs = TP->Tokens->nParameters / 2 - 1;
2459         if (TP->Tokens->nParameters % 2 != 0)
2460         {
2461                 LogTemplateError(NULL, "TabbedApi", ERR_PARM1, TP,
2462                                  "need even number of arguments");
2463                 return 0;
2464
2465         }
2466         else for (i = 0; i < nTabs; i++) {
2467                 if (!HaveTemplateTokenString(NULL,
2468                                              TP,
2469                                              i * 2,
2470                                              &Ch,
2471                                              &len) ||
2472                     (TP->Tokens->Params[i * 2]->len == 0))
2473                 {
2474                         LogTemplateError(NULL, "TabbedApi", ERR_PARM1, TP,
2475                                          "Tab-Subject %d needs to be able to produce a string, have %s",
2476                                          i, TP->Tokens->Params[i * 2]->Start);
2477                         return 0;
2478                 }
2479                 if (!HaveTemplateTokenString(NULL,
2480                                              TP,
2481                                              i * 2 + 1,
2482                                              &Ch,
2483                                              &len) ||
2484                     (TP->Tokens->Params[i * 2 + 1]->len == 0))
2485                 {
2486                         LogTemplateError(NULL, "TabbedApi", ERR_PARM1, TP,
2487                                          "Tab-Content %d needs to be able to produce a string, have %s",
2488                                          i, TP->Tokens->Params[i * 2 + 1]->Start);
2489                         return 0;
2490                 }
2491         }
2492
2493         if (!HaveTemplateTokenString(NULL,
2494                                      TP,
2495                                      i * 2 + 1,
2496                                      &Ch,
2497                                      &len) ||
2498             (TP->Tokens->Params[i * 2 + 1]->len == 0))
2499         {
2500                 LogTemplateError(NULL, "TabbedApi", ERR_PARM1, TP,
2501                                  "Tab-Content %d needs to be able to produce a string, have %s",
2502                                  i, TP->Tokens->Params[i * 2 + 1]->Start);
2503                 return 0;
2504         }
2505         return 1;
2506 }
2507
2508
2509 void tmpl_do_tabbed(StrBuf *Target, WCTemplputParams *TP)
2510 {
2511         StrBuf **TabNames;
2512         int i, ntabs, nTabs;
2513         tab_struct TS;
2514         WCTemplputParams SubTP;
2515
2516         memset(&TS, 0, sizeof(tab_struct));
2517
2518         nTabs = ntabs = TP->Tokens->nParameters / 2;
2519         TabNames = (StrBuf **) malloc(ntabs * sizeof(StrBuf*));
2520         memset(TabNames, 0, ntabs * sizeof(StrBuf*));
2521
2522         for (i = 0; i < ntabs; i++) {
2523                 if ((TP->Tokens->Params[i * 2]->Type == TYPE_STR) &&
2524                     (TP->Tokens->Params[i * 2]->len > 0)) {
2525                         TabNames[i] = NewStrBuf();
2526                         DoTemplate(TKEY(i * 2), TabNames[i], TP);
2527                 }
2528                 else if (TP->Tokens->Params[i * 2]->Type == TYPE_GETTEXT) {
2529                         const char *Ch;
2530                         long len;
2531                         GetTemplateTokenString(Target,
2532                                                TP,
2533                                                i * 2,
2534                                                &Ch,
2535                                                &len);
2536                         TabNames[i] = NewStrBufPlain(Ch, -1);
2537                 }
2538                 else {
2539                         /** A Tab without subject? we can't count that, add it as silent */
2540                         nTabs --;
2541                 }
2542         }
2543         StackContext (TP, &SubTP, &TS, CTX_TAB, 0, NULL);
2544         {
2545                 StrTabbedDialog(Target, nTabs, TabNames);
2546                 for (i = 0; i < ntabs; i++) {
2547                         memset(&TS, 0, sizeof(tab_struct));
2548                         TS.CurrentTab = i;
2549                         TS.TabTitle = TabNames[i];
2550                         StrBeginTab(Target, i, nTabs, TabNames);
2551                         DoTemplate(TKEY(i * 2 + 1), Target, &SubTP);
2552                         StrEndTab(Target, i, nTabs);
2553                 }
2554                 for (i = 0; i < ntabs; i++)
2555                         FreeStrBuf(&TabNames[i]);
2556                 free(TabNames);
2557         }
2558         UnStackContext(&SubTP);
2559 }
2560
2561 void tmplput_TAB_N(StrBuf *Target, WCTemplputParams *TP)
2562 {
2563         tab_struct *Ctx = CTX(CTX_TAB);
2564
2565         StrBufAppendPrintf(Target, "%d", Ctx->CurrentTab);
2566 }
2567
2568 void tmplput_TAB_TITLE(StrBuf *Target, WCTemplputParams *TP)
2569 {
2570         tab_struct *Ctx = CTX(CTX_TAB);
2571         StrBufAppendTemplate(Target, TP, Ctx->TabTitle, 0);
2572 }
2573
2574 /*-----------------------------------------------------------------------------
2575  *                      Sorting-API
2576  */
2577
2578
2579 void RegisterSortFunc(const char *name, long len,
2580                       const char *prepend, long preplen,
2581                       CompareFunc Forward,
2582                       CompareFunc Reverse,
2583                       CompareFunc GroupChange,
2584                       CtxType ContextType)
2585 {
2586         SortStruct *NewSort;
2587
2588         NewSort = (SortStruct*) malloc(sizeof(SortStruct));
2589         memset(NewSort, 0, sizeof(SortStruct));
2590         NewSort->Name = NewStrBufPlain(name, len);
2591         if (prepend != NULL)
2592                 NewSort->PrefPrepend = NewStrBufPlain(prepend, preplen);
2593         else
2594                 NewSort->PrefPrepend = NULL;
2595         NewSort->Forward = Forward;
2596         NewSort->Reverse = Reverse;
2597         NewSort->GroupChange = GroupChange;
2598         NewSort->ContextType = ContextType;
2599         if (ContextType == CTX_NONE) {
2600                 syslog(LOG_WARNING, "sorting requires a context. CTX_NONE won't make it.\n");
2601                 exit(1);
2602         }
2603
2604         Put(SortHash, name, len, NewSort, DestroySortStruct);
2605 }
2606
2607 CompareFunc RetrieveSort(WCTemplputParams *TP,
2608                          const char *OtherPrefix, long OtherPrefixLen,
2609                          const char *Default, long ldefault, long DefaultDirection)
2610 {
2611         const StrBuf *BSort = NULL;
2612         SortStruct *SortBy;
2613         void *vSortBy;
2614         long SortOrder = -1;
2615
2616         if (havebstr("SortBy")) {
2617                 BSort = sbstr("SortBy");
2618                 if (OtherPrefix == NULL) {
2619                         set_room_pref("sort", NewStrBufDup(BSort), 0);
2620                 }
2621                 else {
2622                         set_X_PREFS(HKEY("sort"), OtherPrefix, OtherPrefixLen, NewStrBufDup(BSort), 0);
2623                 }
2624         }
2625         else { /** Try to fallback to our remembered values... */
2626                 if (OtherPrefix == NULL) {
2627                         BSort = get_room_pref("sort");
2628                 }
2629                 else {
2630                         BSort = get_X_PREFS(HKEY("sort"), OtherPrefix, OtherPrefixLen);
2631                 }
2632                 if (BSort != NULL)
2633                         putbstr("SortBy", NewStrBufDup(BSort));
2634                 else {
2635                         StrBuf *Buf;
2636
2637                         BSort = Buf = NewStrBufPlain(Default, ldefault);
2638                         putbstr("SortBy", Buf);
2639                 }
2640         }
2641
2642         if (!GetHash(SortHash, SKEY(BSort), &vSortBy) ||
2643             (vSortBy == NULL)) {
2644                 if (!GetHash(SortHash, Default, ldefault, &vSortBy) ||
2645                     (vSortBy == NULL)) {
2646                         LogTemplateError(
2647                                 NULL, "Sorting", ERR_PARM1, TP,
2648                                 "Illegal default sort: [%s]", Default);
2649                         wc_backtrace(LOG_WARNING);
2650                 }
2651         }
2652         SortBy = (SortStruct*)vSortBy;
2653
2654         if (SortBy->ContextType != TP->Filter.ContextType)
2655                 return NULL;
2656
2657         /** Ok, its us, lets see in which direction we should sort... */
2658         if (havebstr("SortOrder")) {
2659                 SortOrder = LBSTR("SortOrder");
2660         }
2661         else { /** Try to fallback to our remembered values... */
2662                 StrBuf *Buf = NULL;
2663                 if (SortBy->PrefPrepend == NULL) {
2664                         Buf = get_room_pref("SortOrder");
2665                         SortOrder = StrTol(Buf);
2666                 }
2667                 else {
2668                         BSort = get_X_PREFS(HKEY("SortOrder"), OtherPrefix, OtherPrefixLen);
2669                 }
2670
2671                 if (Buf == NULL)
2672                         SortOrder = DefaultDirection;
2673
2674                 Buf = NewStrBufPlain(NULL, 64);
2675                 StrBufPrintf(Buf, "%ld", SortOrder);
2676                 putbstr("SortOrder", Buf);
2677         }
2678         switch (SortOrder) {
2679         default:
2680         case 0:
2681                 return NULL;
2682         case 1:
2683                 return SortBy->Forward;
2684         case 2:
2685                 return SortBy->Reverse;
2686         }
2687 }
2688
2689
2690 enum {
2691         eNO_SUCH_SORT,
2692         eNOT_SPECIFIED,
2693         eINVALID_PARAM,
2694         eFOUND
2695 };
2696
2697 ConstStr SortIcons[] = {
2698         {HKEY("static/webcit_icons/sort_none.gif")},
2699         {HKEY("static/webcit_icons/up_pointer.gif")},
2700         {HKEY("static/webcit_icons/down_pointer.gif")},
2701 };
2702
2703 ConstStr SortNextOrder[] = {
2704         {HKEY("1")},
2705         {HKEY("2")},
2706         {HKEY("0")},
2707 };
2708
2709
2710 int GetSortMetric(WCTemplputParams *TP, SortStruct **Next, SortStruct **Param, long *SortOrder, int N)
2711 {
2712         int bSortError = eNOT_SPECIFIED;
2713         const StrBuf *BSort;
2714         void *vSort;
2715
2716         *SortOrder = 0;
2717         *Next = NULL;
2718         if (!GetHash(SortHash, TKEY(0), &vSort) ||
2719             (vSort == NULL))
2720                 return eNO_SUCH_SORT;
2721         *Param = (SortStruct*) vSort;
2722
2723
2724         if (havebstr("SortBy")) {
2725                 BSort = sbstr("SortBy");
2726                 bSortError = eINVALID_PARAM;
2727                 if ((*Param)->PrefPrepend == NULL) {
2728                         set_room_pref("sort", NewStrBufDup(BSort), 0);
2729                 }
2730                 else {
2731                         set_X_PREFS(HKEY("sort"), TKEY(N), NewStrBufDup(BSort), 0);
2732                 }
2733         }
2734         else { /** Try to fallback to our remembered values... */
2735                 if ((*Param)->PrefPrepend == NULL) {
2736                         BSort = get_room_pref("sort");
2737                 }
2738                 else {
2739                         BSort = get_X_PREFS(HKEY("sort"), TKEY(N));
2740                 }
2741         }
2742
2743         if (!GetHash(SortHash, SKEY(BSort), &vSort) ||
2744             (vSort == NULL))
2745                 return bSortError;
2746
2747         *Next = (SortStruct*) vSort;
2748
2749         /** Ok, its us, lets see in which direction we should sort... */
2750         if (havebstr("SortOrder")) {
2751                 *SortOrder = LBSTR("SortOrder");
2752         }
2753         else { /** Try to fallback to our remembered values... */
2754                 if ((*Param)->PrefPrepend == NULL) {
2755                         *SortOrder = StrTol(get_room_pref("SortOrder"));
2756                 }
2757                 else {
2758                         *SortOrder = StrTol(get_X_PREFS(HKEY("SortOrder"), TKEY(N)));
2759                 }
2760         }
2761         if (*SortOrder > 2)
2762                 *SortOrder = 0;
2763
2764         return eFOUND;
2765 }
2766
2767
2768 void tmplput_SORT_ICON(StrBuf *Target, WCTemplputParams *TP)
2769 {
2770         long SortOrder;
2771         SortStruct *Next;
2772         SortStruct *Param;
2773         const ConstStr *SortIcon;
2774
2775         switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2776         case eNO_SUCH_SORT:
2777                 LogTemplateError(
2778                         Target, "Sorter", ERR_PARM1, TP,
2779                         " Sorter [%s] unknown!",
2780                         TP->Tokens->Params[0]->Start);
2781                 break;
2782         case eINVALID_PARAM:
2783                 LogTemplateError(NULL, "Sorter", ERR_PARM1, TP,
2784                                  " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2785                                  bstr("SortBy"));
2786         case eNOT_SPECIFIED:
2787         case eFOUND:
2788                 if (Next == Param) {
2789                         SortIcon = &SortIcons[SortOrder];
2790                 }
2791                 else { /** Not Us... */
2792                         SortIcon = &SortIcons[0];
2793                 }
2794                 StrBufAppendBufPlain(Target, SortIcon->Key, SortIcon->len, 0);
2795         }
2796 }
2797
2798 void tmplput_SORT_NEXT(StrBuf *Target, WCTemplputParams *TP)
2799 {
2800         long SortOrder;
2801         SortStruct *Next;
2802         SortStruct *Param;
2803
2804         switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2805         case eNO_SUCH_SORT:
2806                 LogTemplateError(
2807                         Target, "Sorter", ERR_PARM1, TP,
2808                         " Sorter [%s] unknown!",
2809                         TP->Tokens->Params[0]->Start);
2810                 break;
2811         case eINVALID_PARAM:
2812                 LogTemplateError(
2813                         NULL, "Sorter", ERR_PARM1, TP,
2814                         " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2815                         bstr("SortBy"));
2816         case eNOT_SPECIFIED:
2817         case eFOUND:
2818                 StrBufAppendBuf(Target, Param->Name, 0);
2819
2820         }
2821 }
2822
2823 void tmplput_SORT_ORDER(StrBuf *Target, WCTemplputParams *TP)
2824 {
2825         long SortOrder;
2826         const ConstStr *SortOrderStr;
2827         SortStruct *Next;
2828         SortStruct *Param;
2829
2830         switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2831         case eNO_SUCH_SORT:
2832                 LogTemplateError(
2833                         Target, "Sorter", ERR_PARM1, TP,
2834                         " Sorter [%s] unknown!",
2835                         TP->Tokens->Params[0]->Start);
2836                 break;
2837         case eINVALID_PARAM:
2838                 LogTemplateError(
2839                         NULL, "Sorter", ERR_PARM1, TP,
2840                         " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2841                         bstr("SortBy"));
2842         case eNOT_SPECIFIED:
2843         case eFOUND:
2844                 if (Next == Param) {
2845                         SortOrderStr = &SortNextOrder[SortOrder];
2846                 }
2847                 else { /** Not Us... */
2848                         SortOrderStr = &SortNextOrder[0];
2849                 }
2850                 StrBufAppendBufPlain(Target, SortOrderStr->Key, SortOrderStr->len, 0);
2851         }
2852 }
2853
2854
2855 void tmplput_long_vector(StrBuf *Target, WCTemplputParams *TP)
2856 {
2857         long *LongVector = (long*) CTX(CTX_LONGVECTOR);
2858
2859         if ((TP->Tokens->Params[0]->Type == TYPE_LONG) &&
2860             (TP->Tokens->Params[0]->lvalue <= LongVector[0]))
2861         {
2862                 StrBufAppendPrintf(Target, "%ld", LongVector[TP->Tokens->Params[0]->lvalue]);
2863         }
2864         else
2865         {
2866                 if (TP->Tokens->Params[0]->Type != TYPE_LONG) {
2867                         LogTemplateError(
2868                                 Target, "Longvector", ERR_NAME, TP,
2869                                 "needs a numerical Parameter!");
2870                 }
2871                 else {
2872                         LogTemplateError(
2873                                 Target, "LongVector", ERR_PARM1, TP,
2874                                 "doesn't have %ld Parameters, its just the size of %ld!",
2875                                 TP->Tokens->Params[0]->lvalue,
2876                                 LongVector[0]);
2877                 }
2878         }
2879 }
2880
2881 void dbg_print_longvector(long *LongVector)
2882 {
2883         StrBuf *Buf = NewStrBufPlain(HKEY("Longvector: ["));
2884         int nItems = LongVector[0];
2885         int i;
2886
2887         for (i = 0; i < nItems; i++) {
2888                 if (i + 1 < nItems)
2889                         StrBufAppendPrintf(Buf, "%d: %ld | ", i, LongVector[i]);
2890                 else
2891                         StrBufAppendPrintf(Buf, "%d: %ld]\n", i, LongVector[i]);
2892
2893         }
2894         syslog(LOG_DEBUG, "%s", ChrPtr(Buf));
2895         FreeStrBuf(&Buf);
2896 }
2897
2898 int ConditionalLongVector(StrBuf *Target, WCTemplputParams *TP)
2899 {
2900         long *LongVector = (long*) CTX(CTX_LONGVECTOR);
2901
2902         if ((TP->Tokens->Params[2]->Type == TYPE_LONG) &&
2903             (TP->Tokens->Params[2]->lvalue <= LongVector[0])&&
2904             (TP->Tokens->Params[3]->Type == TYPE_LONG) &&
2905             (TP->Tokens->Params[3]->lvalue <= LongVector[0]))
2906         {
2907                 return LongVector[TP->Tokens->Params[2]->lvalue] ==
2908                         LongVector[TP->Tokens->Params[3]->lvalue];
2909         }
2910         else
2911         {
2912                 if ((TP->Tokens->Params[2]->Type == TYPE_LONG) ||
2913                     (TP->Tokens->Params[2]->Type == TYPE_LONG)) {
2914                         LogTemplateError(
2915                                 Target, "ConditionalLongvector", ERR_PARM1, TP,
2916                                 "needs two long Parameter!");
2917                 }
2918                 else {
2919                         LogTemplateError(
2920                                 Target, "Longvector", ERR_PARM1, TP,
2921                                 "doesn't have %ld / %ld Parameters, its just the size of %ld!",
2922                                 TP->Tokens->Params[2]->lvalue,
2923                                 TP->Tokens->Params[3]->lvalue,
2924                                 LongVector[0]);
2925                 }
2926         }
2927         return 0;
2928 }
2929
2930
2931 void tmplput_CURRENT_FILE(StrBuf *Target, WCTemplputParams *TP)
2932 {
2933         StrBufAppendTemplate(Target, TP, TP->Tokens->FileName, 0);
2934 }
2935
2936 void
2937 InitModule_SUBST
2938 (void)
2939 {
2940         RegisterCTX(CTX_TAB);
2941         RegisterCTX(CTX_ITERATE);
2942
2943         memset(&NoCtx, 0, sizeof(WCTemplputParams));
2944         RegisterNamespace("--", 0, 2, tmplput_Comment, NULL, CTX_NONE);
2945         RegisterNamespace("SORT:ICON", 1, 2, tmplput_SORT_ICON, NULL, CTX_NONE);
2946         RegisterNamespace("SORT:ORDER", 1, 2, tmplput_SORT_ORDER, NULL, CTX_NONE);
2947         RegisterNamespace("SORT:NEXT", 1, 2, tmplput_SORT_NEXT, NULL, CTX_NONE);
2948         RegisterNamespace("CONTEXTSTR", 0, 1, tmplput_ContextString, NULL, CTX_STRBUF);
2949         RegisterNamespace("CONTEXTSTRARR", 1, 2, tmplput_ContextStringArray, NULL, CTX_STRBUFARR);
2950         RegisterNamespace("ITERATE", 2, 100, tmpl_iterate_subtmpl, preeval_iterate, CTX_NONE);
2951         RegisterNamespace("DOBOXED", 1, 2, tmpl_do_boxed, NULL, CTX_NONE);
2952         RegisterNamespace("DOTABBED", 2, 100, tmpl_do_tabbed, preeval_do_tabbed, CTX_NONE);
2953         RegisterNamespace("TAB:N", 0, 0, tmplput_TAB_N, NULL, CTX_TAB);
2954         RegisterNamespace("TAB:SUBJECT", 0, 1, tmplput_TAB_TITLE, NULL, CTX_TAB);
2955
2956
2957         RegisterNamespace("LONGVECTOR", 1, 1, tmplput_long_vector, NULL, CTX_LONGVECTOR);
2958
2959
2960         RegisterConditional("COND:CONTEXTSTR", 3, ConditionalContextStr, CTX_STRBUF);
2961         RegisterConditional("COND:CONTEXTSTRARR", 4, ConditionalContextStrinArray, CTX_STRBUFARR);
2962         RegisterConditional("COND:LONGVECTOR", 4, ConditionalLongVector, CTX_LONGVECTOR);
2963
2964
2965         RegisterConditional("COND:ITERATE:ISGROUPCHANGE", 2,
2966                             conditional_ITERATE_ISGROUPCHANGE,
2967                             CTX_ITERATE);
2968         RegisterConditional("COND:ITERATE:LASTN", 2,
2969                             conditional_ITERATE_LASTN,
2970                             CTX_ITERATE);
2971         RegisterConditional("COND:ITERATE:FIRSTN", 2,
2972                             conditional_ITERATE_FIRSTN,
2973                             CTX_ITERATE);
2974
2975         RegisterNamespace("ITERATE:ODDEVEN", 0, 0, tmplput_ITERATE_ODDEVEN, NULL, CTX_ITERATE);
2976         RegisterNamespace("ITERATE:KEY", 0, 0, tmplput_ITERATE_KEY, NULL, CTX_ITERATE);
2977         RegisterNamespace("ITERATE:N", 0, 0, tmplput_ITERATE_LASTN, NULL, CTX_ITERATE);
2978         RegisterNamespace("CURRENTFILE", 0, 1, tmplput_CURRENT_FILE, NULL, CTX_NONE);
2979         RegisterNamespace("DEF:STR", 1, 1, tmplput_DefStr, NULL, CTX_NONE);
2980         RegisterNamespace("DEF:VAL", 1, 1, tmplput_DefVal, NULL, CTX_NONE);
2981
2982
2983
2984
2985 }
2986
2987 void
2988 ServerStartModule_SUBST
2989 (void)
2990 {
2991         LocalTemplateCache = NewHash(1, NULL);
2992         TemplateCache = NewHash(1, NULL);
2993
2994         GlobalNS = NewHash(1, NULL);
2995         Iterators = NewHash(1, NULL);
2996         Conditionals = NewHash(1, NULL);
2997         SortHash = NewHash(1, NULL);
2998         Defines = NewHash(1, NULL);
2999         CtxList = NewHash(1, NULL);
3000
3001         PutContextType(HKEY("CTX_NONE"), 0);
3002
3003         RegisterCTX(CTX_STRBUF);
3004         RegisterCTX(CTX_STRBUFARR);
3005         RegisterCTX(CTX_LONGVECTOR);
3006 }
3007
3008 void
3009 FinalizeModule_SUBST
3010 (void)
3011 {
3012
3013 }
3014
3015 void
3016 ServerShutdownModule_SUBST
3017 (void)
3018 {
3019         DeleteHash(&TemplateCache);
3020         DeleteHash(&LocalTemplateCache);
3021
3022         DeleteHash(&GlobalNS);
3023         DeleteHash(&Iterators);
3024         DeleteHash(&Conditionals);
3025         DeleteHash(&SortHash);
3026         DeleteHash(&Defines);
3027         DeleteHash(&CtxList);
3028 }
3029
3030
3031 void
3032 SessionNewModule_SUBST
3033 (wcsession *sess)
3034 {
3035
3036 }
3037
3038 void
3039 SessionAttachModule_SUBST
3040 (wcsession *sess)
3041 {
3042 }
3043
3044 void
3045 SessionDetachModule_SUBST
3046 (wcsession *sess)
3047 {
3048         FreeStrBuf(&sess->WFBuf);
3049 }
3050
3051 void
3052 SessionDestroyModule_SUBST
3053 (wcsession *sess)
3054 {
3055
3056 }