webcit/subst.c

   1 /*
   2  * $Id$
   3  */
   4 /**
   5  * \defgroup Subst Variable substitution type stuff
   6  * \ingroup CitadelConfig
   7  */
   8
   9 /*@{*/
  10
  11 #include "sysdep.h"
  12 #include <sys/types.h>
  13 #include <sys/stat.h>
  14 #include <unistd.h>
  15 #include <dirent.h>
  16 #include <errno.h>
  17 #include <stdarg.h>
  18 #define SHOW_ME_VAPPEND_PRINTF
  19
  20 #include "webcit.h"
  21 #include "webserver.h"
  22
  23 extern char *static_dirs[PATH_MAX];  /**< Disk representation */
  24
  25 HashList *WirelessTemplateCache;
  26 HashList *WirelessLocalTemplateCache;
  27 HashList *TemplateCache;
  28 HashList *LocalTemplateCache;
  29
  30 HashList *GlobalNS;
  31 HashList *Iterators;
  32 HashList *Conditionals;
  33 HashList *SortHash;
  34
  35 int LoadTemplates = 0;
  36 WCTemplputParams NoCtx;
  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 typedef struct _WCTemplate {
  46         StrBuf *Data;
  47         StrBuf *FileName;
  48         int nTokensUsed;
  49         int TokenSpace;
  50         WCTemplateToken **Tokens;
  51 } WCTemplate;
  52
  53 typedef struct _HashHandler {
  54         int nMinArgs;
  55         int nMaxArgs;
  56         int ContextRequired;
  57         WCHandlerFunc HandlerFunc;
  58 }HashHandler;
  59
  60 void *load_template(StrBuf *filename, StrBuf *Key, HashList *PutThere);
  61 int EvaluateConditional(StrBuf *Target, int Neg, int state, WCTemplputParams *TP);
  62
  63 typedef struct _SortStruct {
  64         StrBuf *Name;
  65         StrBuf *PrefPrepend;
  66         CompareFunc Forward;
  67         CompareFunc Reverse;
  68         CompareFunc GroupChange;
  69
  70         long ContextType;
  71 }SortStruct;
  72
  73 void DestroySortStruct(void *vSort)
  74 {
  75         SortStruct *Sort = (SortStruct*) vSort;
  76         FreeStrBuf(&Sort->Name);
  77         FreeStrBuf(&Sort->PrefPrepend);
  78         free (Sort);
  79 }
  80
  81 void LogTemplateError (StrBuf *Target, const char *Type, int ErrorPos, WCTemplputParams *TP, const char *Format, ...)
  82 {
  83         StrBuf *Error;
  84         StrBuf *Info;
  85         va_list arg_ptr;
  86         const char *Err = NULL;
  87
  88         Info = NewStrBuf();
  89         Error = NewStrBuf();
  90
  91         va_start(arg_ptr, Format);
  92         StrBufVAppendPrintf(Error, Format, arg_ptr);
  93         va_end(arg_ptr);
  94
  95         switch (ErrorPos) {
  96         default:
  97         case ERR_NAME: /* the main token name... */
  98                 Err = TP->Tokens->pName;
  99                 break;
 100         case ERR_PARM1:
 101                 Err = TP->Tokens->Params[0]->Start;
 102                 break;
 103         case ERR_PARM2:
 104                 Err = TP->Tokens->Params[1]->Start;
 105                 break;
 106         }
 107         lprintf(1, "%s [%s]  (in '%s' line %ld); %s; [%s]\n",
 108                 Type,
 109                 Err,
 110                 ChrPtr(TP->Tokens->FileName),
 111                 TP->Tokens->Line,
 112                 ChrPtr(Error),
 113                 ChrPtr(TP->Tokens->FlatToken));
 114         if (Target != NULL) {
 115                 StrBufAppendPrintf(
 116                         Target,
 117                         "<pre>\n%s [%s] (in '%s' line %ld); %s\n[%s]\n</pre>\n",
 118                         Type,
 119                         Err,
 120                         ChrPtr(TP->Tokens->FileName),
 121                         TP->Tokens->Line,
 122                         ChrPtr(Error),
 123                         ChrPtr(TP->Tokens->FlatToken));
 124         }
 125 }
 126
 127
 128 void RegisterNS(const char *NSName,
 129                 long len,
 130                 int nMinArgs,
 131                 int nMaxArgs,
 132                 WCHandlerFunc HandlerFunc,
 133                 int ContextRequired)
 134 {
 135         HashHandler *NewHandler;
 136
 137         NewHandler = (HashHandler*) malloc(sizeof(HashHandler));
 138         NewHandler->nMinArgs = nMinArgs;
 139         NewHandler->nMaxArgs = nMaxArgs;
 140         NewHandler->HandlerFunc = HandlerFunc;
 141         NewHandler->ContextRequired = ContextRequired;
 142         Put(GlobalNS, NSName, len, NewHandler, NULL);
 143 }
 144
 145 void FreeToken(WCTemplateToken **Token)
 146 {
 147         int i;
 148         FreeStrBuf(&(*Token)->FlatToken);
 149         if ((*Token)->HaveParameters)
 150                 for (i = 0; i < (*Token)->nParameters; i++)
 151                         free((*Token)->Params[i]);
 152         free(*Token);
 153         *Token = NULL;
 154 }
 155
 156
 157
 158 void FreeWCTemplate(void *vFreeMe)
 159 {
 160         int i;
 161         WCTemplate *FreeMe = (WCTemplate*)vFreeMe;
 162
 163         if (FreeMe->TokenSpace > 0) {
 164                 for (i = 0; i < FreeMe->nTokensUsed; i ++) {
 165                         FreeToken(&FreeMe->Tokens[i]);
 166                 }
 167                 free(FreeMe->Tokens);
 168         }
 169         FreeStrBuf(&FreeMe->FileName);
 170         FreeStrBuf(&FreeMe->Data);
 171         free(FreeMe);
 172 }
 173
 174
 175 /**
 176  * \brief debugging function to print array to log
 177  */
 178 void VarPrintTransition(void *vVar1, void *vVar2, int odd){}
 179 /**
 180  * \brief debugging function to print array to log
 181  */
 182 void VarPrintEntry(const char *Key, void *vSubst, int odd)
 183 {
 184         wcsubst *ptr;
 185         lprintf(1,"Subst[%s] : ", Key);
 186         ptr = (wcsubst*) vSubst;
 187
 188         switch(ptr->wcs_type) {
 189         case WCS_STRING:
 190                 lprintf(1, "  -> %s\n", ChrPtr(ptr->wcs_value));
 191                 break;
 192         case WCS_SERVCMD:
 193                 lprintf(1, "  -> Server [%s]\n", ChrPtr(ptr->wcs_value));
 194                 break;
 195         case WCS_FUNCTION:
 196                 lprintf(1, "  -> function at [%0xd]\n", ptr->wcs_function);
 197                 break;
 198         default:
 199                 lprintf(1,"  WARNING: invalid type: [%ld]!\n", ptr->wcs_type);
 200         }
 201 }
 202
 203
 204
 205 /**
 206  * \brief Clear out the list of substitution variables local to this session
 207  */
 208 void clear_substs(wcsession *wc) {
 209
 210         if (wc->vars != NULL) {
 211                 DeleteHash(&wc->vars);
 212         }
 213 }
 214
 215 /**
 216  * \brief Clear out the list of substitution variables local to this session
 217  */
 218 void clear_local_substs(void) {
 219         clear_substs (WC);
 220 }
 221
 222 int NeedNewBuf(type)
 223 {
 224         switch(type) {
 225         case WCS_STRING:
 226         case WCS_SERVCMD:
 227         case WCS_STRBUF:
 228                 return 1;
 229         case WCS_FUNCTION:
 230         case WCS_STRBUF_REF:
 231         case WCS_LONG:
 232         default:
 233                 return 0;
 234         }
 235 }
 236
 237 void FlushPayload(wcsubst *ptr, int reusestrbuf, int type)
 238 {
 239         int NeedNew = NeedNewBuf(type);
 240         switch(ptr->wcs_type) {
 241         case WCS_STRING:
 242         case WCS_SERVCMD:
 243         case WCS_STRBUF:
 244                 if (reusestrbuf && NeedNew) {
 245                         FlushStrBuf(ptr->wcs_value);
 246                 }
 247                 else {
 248
 249                         FreeStrBuf(&ptr->wcs_value);
 250                         ptr->wcs_value = NULL;
 251                 }
 252                 break;
 253         case WCS_FUNCTION:
 254                 ptr->wcs_function = NULL;
 255                 if (reusestrbuf && NeedNew)
 256                         ptr->wcs_value = NewStrBuf();
 257                 break;
 258         case WCS_STRBUF_REF:
 259                 ptr->wcs_value = NULL;
 260                 if (reusestrbuf && NeedNew)
 261                         ptr->wcs_value = NewStrBuf();
 262                 break;
 263         case WCS_LONG:
 264                 ptr->lvalue = 0;
 265                 if (reusestrbuf && NeedNew)
 266                         ptr->wcs_value = NewStrBuf();
 267                 break;
 268         default:
 269                 if (reusestrbuf && NeedNew)
 270                         ptr->wcs_value = NewStrBuf();
 271                 break;
 272         }
 273 }
 274
 275
 276 /**
 277  * \brief destructor; kill one entry.
 278  */
 279 void deletevar(void *data)
 280 {
 281         wcsubst *ptr = (wcsubst*)data;
 282         FlushPayload(ptr, 0, ptr->wcs_type);
 283         free(ptr);
 284 }
 285
 286
 287 wcsubst *NewSubstVar(const char *keyname, int keylen, int type)
 288 {
 289         wcsubst* ptr;
 290         wcsession *WCC = WC;
 291
 292         ptr = (wcsubst *) malloc(sizeof(wcsubst));
 293         memset(ptr, 0, sizeof(wcsubst));
 294
 295         ptr->wcs_type = type;
 296         safestrncpy(ptr->wcs_key, keyname, sizeof ptr->wcs_key);
 297         Put(WCC->vars, keyname, keylen, ptr,  deletevar);
 298
 299         switch(ptr->wcs_type) {
 300         case WCS_STRING:
 301         case WCS_SERVCMD:
 302                 ptr->wcs_value = NewStrBuf();
 303                 break;
 304         case WCS_STRBUF:
 305         case WCS_FUNCTION:
 306         case WCS_STRBUF_REF:
 307         case WCS_LONG:
 308         default:
 309                 break;
 310         }
 311         return ptr;
 312 }
 313
 314
 315 /**
 316  * \brief Add a substitution variable (local to this session) (strlen version...)
 317  * \param keyname the replacementstring to substitute
 318  * \param keytype the kind of the key
 319  * \param format the format string ala printf
 320  * \param ... the arguments to substitute in the formatstring
 321  */
 322 void SVPRINTF(char *keyname, int keytype, const char *format,...)
 323 {
 324         va_list arg_ptr;
 325         void *vPtr;
 326         wcsubst *ptr = NULL;
 327         size_t keylen;
 328         wcsession *WCC = WC;
 329
 330         keylen = strlen(keyname);
 331         /**
 332          * First look if we're doing a replacement of
 333          * an existing key
 334          */
 335         /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
 336         if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
 337                 ptr = (wcsubst*)vPtr;
 338                 FlushPayload(ptr, keytype, keytype);
 339                 ptr->wcs_type = keytype;
 340         }
 341         else    /** Otherwise allocate a new one */
 342         {
 343                 ptr = NewSubstVar(keyname, keylen, keytype);
 344         }
 345
 346         /** Format the string */
 347         va_start(arg_ptr, format);
 348         StrBufVAppendPrintf(ptr->wcs_value, format, arg_ptr);
 349         va_end(arg_ptr);
 350 }
 351
 352 /**
 353  * \brief Add a substitution variable (local to this session)
 354  * \param keyname the replacementstring to substitute
 355  * \param keytype the kind of the key
 356  * \param format the format string ala printf
 357  * \param ... the arguments to substitute in the formatstring
 358  */
 359 void svprintf(char *keyname, size_t keylen, int keytype, const char *format,...)
 360 {
 361         va_list arg_ptr;
 362         void *vPtr;
 363         wcsubst *ptr = NULL;
 364         wcsession *WCC = WC;
 365
 366         /**
 367          * First look if we're doing a replacement of
 368          * an existing key
 369          */
 370         /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
 371         if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
 372                 ptr = (wcsubst*)vPtr;
 373                 FlushPayload(ptr, 1, keytype);
 374                 ptr->wcs_type = keytype;
 375         }
 376         else    /** Otherwise allocate a new one */
 377         {
 378                 ptr = NewSubstVar(keyname, keylen, keytype);
 379         }
 380
 381         /** Format the string and save it */
 382         va_start(arg_ptr, format);
 383         StrBufVAppendPrintf(ptr->wcs_value, format, arg_ptr);
 384         va_end(arg_ptr);
 385 }
 386
 387 /**
 388  * \brief Add a substitution variable (local to this session)
 389  * \param keyname the replacementstring to substitute
 390  * \param keytype the kind of the key
 391  * \param format the format string ala printf
 392  * \param ... the arguments to substitute in the formatstring
 393  */
 394 void SVPut(char *keyname, size_t keylen, int keytype, char *Data)
 395 {
 396         void *vPtr;
 397         wcsubst *ptr = NULL;
 398         wcsession *WCC = WC;
 399
 400
 401         /**
 402          * First look if we're doing a replacement of
 403          * an existing key
 404          */
 405         /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
 406         if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
 407                 ptr = (wcsubst*)vPtr;
 408                 FlushPayload(ptr, 1, keytype);
 409                 ptr->wcs_type = keytype;
 410         }
 411         else    /** Otherwise allocate a new one */
 412         {
 413                 ptr = NewSubstVar(keyname, keylen, keytype);
 414         }
 415         StrBufAppendBufPlain(ptr->wcs_value, Data, -1, 0);
 416 }
 417
 418 /**
 419  * \brief Add a substitution variable (local to this session)
 420  * \param keyname the replacementstring to substitute
 421  * \param keytype the kind of the key
 422  * \param format the format string ala printf
 423  * \param ... the arguments to substitute in the formatstring
 424  */
 425 void SVPutLong(char *keyname, size_t keylen, long Data)
 426 {
 427         void *vPtr;
 428         wcsubst *ptr = NULL;
 429         wcsession *WCC = WC;
 430
 431
 432         /**
 433          * First look if we're doing a replacement of
 434          * an existing key
 435          */
 436         /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
 437         if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
 438                 ptr = (wcsubst*)vPtr;
 439                 FlushPayload(ptr, 1, WCS_LONG);
 440                 ptr->wcs_type = WCS_LONG;
 441         }
 442         else    /** Otherwise allocate a new one */
 443         {
 444                 ptr = NewSubstVar(keyname, keylen, WCS_LONG);
 445         }
 446         ptr->lvalue = Data;
 447 }
 448
 449 /**
 450  * \brief Add a substitution variable (local to this session) that does a callback
 451  * \param keyname the keystring to substitute
 452  * \param fcn_ptr the function callback to give the substitution string
 453  */
 454 void SVCallback(char *keyname, size_t keylen, WCHandlerFunc fcn_ptr)
 455 {
 456         wcsubst *ptr;
 457         void *vPtr;
 458         wcsession *WCC = WC;
 459
 460         /**
 461          * First look if we're doing a replacement of
 462          * an existing key
 463          */
 464         /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
 465         if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
 466                 ptr = (wcsubst*)vPtr;
 467                 FlushPayload(ptr, 1, WCS_FUNCTION);
 468                 ptr->wcs_type = WCS_FUNCTION;
 469         }
 470         else    /** Otherwise allocate a new one */
 471         {
 472                 ptr = NewSubstVar(keyname, keylen, WCS_FUNCTION);
 473         }
 474
 475         ptr->wcs_function = fcn_ptr;
 476 }
 477 inline void SVCALLBACK(char *keyname, WCHandlerFunc fcn_ptr)
 478 {
 479         SVCallback(keyname, strlen(keyname), fcn_ptr);
 480 }
 481
 482
 483
 484 void SVPUTBuf(const char *keyname, int keylen, const StrBuf *Buf, int ref)
 485 {
 486         wcsubst *ptr;
 487         void *vPtr;
 488         wcsession *WCC = WC;
 489
 490         /**
 491          * First look if we're doing a replacement of
 492          * an existing key
 493          */
 494         /*PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
 495         if (GetHash(WCC->vars, keyname, keylen, &vPtr)) {
 496                 ptr = (wcsubst*)vPtr;
 497                 FlushPayload(ptr, 0, (ref)?WCS_STRBUF_REF:WCS_STRBUF);
 498                 ptr->wcs_type = (ref)?WCS_STRBUF_REF:WCS_STRBUF;
 499         }
 500         else    /** Otherwise allocate a new one */
 501         {
 502                 ptr = NewSubstVar(keyname, keylen, (ref)?WCS_STRBUF_REF:WCS_STRBUF);
 503         }
 504         ptr->wcs_value = (StrBuf*)Buf;
 505 }
 506
 507 /**
 508  * \brief back end for print_value_of() ... does a server command
 509  * \param servcmd server command to execute on the citadel server
 510  */
 511 void pvo_do_cmd(StrBuf *Target, StrBuf *servcmd) {
 512         char buf[SIZ];
 513         int len;
 514
 515         serv_puts(ChrPtr(servcmd));
 516         len = serv_getln(buf, sizeof buf);
 517
 518         switch(buf[0]) {
 519                 case '2':
 520                 case '3':
 521                 case '5':
 522                         StrBufAppendPrintf(Target, "%s\n", &buf[4]);
 523                         break;
 524                 case '1':
 525                         _fmout(Target, "CENTER");
 526                         break;
 527                 case '4':
 528                         StrBufAppendPrintf(Target, "%s\n", &buf[4]);
 529                         serv_puts("000");
 530                         break;
 531         }
 532 }
 533
 534 void GetTemplateTokenString(WCTemplputParams *TP,
 535                             int N,
 536                             const char **Value,
 537                             long *len)
 538 {
 539         StrBuf *Buf;
 540
 541         if (TP->Tokens->nParameters < N) {
 542                 lprintf(1, "invalid token. this shouldn't have come till here.\n");
 543                 wc_backtrace();
 544                 *Value = "";
 545                 *len = 0;
 546                 return;
 547         }
 548
 549         switch (TP->Tokens->Params[N]->Type) {
 550
 551         case TYPE_STR:
 552                 *Value = TP->Tokens->Params[N]->Start;
 553                 *len = TP->Tokens->Params[N]->len;
 554                 break;
 555         case TYPE_BSTR:
 556                 Buf = (StrBuf*) SBstr(TKEY(N));
 557                 *Value = ChrPtr(Buf);
 558                 *len = StrLength(Buf);
 559                 break;
 560         case TYPE_PREFSTR:
 561                 get_PREFERENCE(TKEY(N), &Buf);
 562                 *Value = ChrPtr(Buf);
 563                 *len = StrLength(Buf);
 564                 break;
 565         case TYPE_LONG:
 566         case TYPE_PREFINT:
 567                 break; /* todo: string to text? */
 568         case TYPE_GETTEXT:
 569                 *Value = _(TP->Tokens->Params[N]->Start);
 570                 *len = strlen(*Value);
 571                 break;
 572         default:
 573                 break;
 574 /*/todo log error */
 575         }
 576 }
 577
 578
 579
 580 /**
 581  * \brief Print the value of a variable
 582  * \param keyname get a key to print
 583  */
 584 void print_value_of(StrBuf *Target, WCTemplputParams *TP)
 585
 586 {
 587         wcsession *WCC = WC;
 588         wcsubst *ptr;
 589         void *vVar;
 590
 591         /*if (WCC->vars != NULL) PrintHash(WCC->vars, VarPrintTransition, VarPrintEntry);*/
 592         /* TODO: depricated! */
 593         if (TP->Tokens->pName[0] == '=') {
 594                 DoTemplate(TP->Tokens->pName+1, TP->Tokens->NameEnd - 1, NULL, &NoCtx);
 595         }
 596 /*/////TODO: if param[1] == "U" -> urlescape
 597 /// X -> escputs */
 598         /** Page-local variables */
 599         if ((WCC->vars!= NULL) && GetHash(WCC->vars, TP->Tokens->pName, TP->Tokens->NameEnd, &vVar)) {
 600                 ptr = (wcsubst*) vVar;
 601                 switch(ptr->wcs_type) {
 602                 case WCS_STRING:
 603                         StrBufAppendBuf(Target, ptr->wcs_value, 0);
 604                         break;
 605                 case WCS_SERVCMD:
 606                         pvo_do_cmd(Target, ptr->wcs_value);
 607                         break;
 608                 case WCS_FUNCTION:
 609                         (*ptr->wcs_function) (Target, TP);
 610                         break;
 611                 case WCS_STRBUF:
 612                 case WCS_STRBUF_REF:
 613                         StrBufAppendBuf(Target, ptr->wcs_value, 0);
 614                         break;
 615                 case WCS_LONG:
 616                         StrBufAppendPrintf(Target, "%ld", ptr->lvalue);
 617                         break;
 618                 default:
 619                         LogTemplateError(
 620                                 Target, "Subst", ERR_NAME, TP,
 621                                 "WARNING: invalid value in SV-Hash at %s!", TP->Tokens->pName);
 622                 }
 623         }
 624         else {
 625                 LogTemplateError(
 626                         Target, "Token", ERR_NAME, TP,
 627                         "didn't find Handler");
 628                 wc_backtrace();
 629         }
 630 }
 631
 632 int CompareSubstToToken(TemplateParam *ParamToCompare, TemplateParam *ParamToLookup)
 633 {
 634         wcsession *WCC = WC;
 635         wcsubst *ptr;
 636         void *vVar;
 637
 638         if ((WCC->vars!= NULL) && GetHash(WCC->vars, ParamToLookup->Start,
 639                                           ParamToLookup->len, &vVar)) {
 640                 ptr = (wcsubst*) vVar;
 641                 switch(ptr->wcs_type) {
 642                 case WCS_STRING:
 643                 case WCS_STRBUF:
 644                 case WCS_STRBUF_REF:
 645                         if (ParamToCompare->Type == TYPE_STR)
 646                                 return ((ParamToCompare->len == StrLength(ptr->wcs_value)) &&
 647                                         (strcmp(ParamToCompare->Start, ChrPtr(ptr->wcs_value)) == 0));
 648                         else
 649                                 return ParamToCompare->lvalue == StrTol(ptr->wcs_value);
 650                         break;
 651                 case WCS_SERVCMD:
 652                         return 1;
 653                         break;
 654                 case WCS_FUNCTION:
 655                         return 1;
 656                 case WCS_LONG:
 657                         if (ParamToCompare->Type == TYPE_STR)
 658                                 return 0;
 659                         else
 660                                 return ParamToCompare->lvalue == ptr->lvalue;
 661                         break;
 662                 default:
 663                         lprintf(1,"WARNING: invalid value in SV-Hash at %s!\n",
 664                                 ParamToLookup->Start);
 665                 }
 666         }
 667         return 0;
 668 }
 669
 670 int CompareSubstToStrBuf(StrBuf *Compare, TemplateParam *ParamToLookup)
 671 {
 672         wcsession *WCC = WC;
 673         wcsubst *ptr;
 674         void *vVar;
 675
 676         if ((WCC->vars!= NULL) && GetHash(WCC->vars, ParamToLookup->Start,
 677                                           ParamToLookup->len, &vVar)) {
 678                 ptr = (wcsubst*) vVar;
 679                 switch(ptr->wcs_type) {
 680                 case WCS_STRING:
 681                 case WCS_STRBUF:
 682                 case WCS_STRBUF_REF:
 683                         return ((StrLength(Compare) == StrLength(ptr->wcs_value)) &&
 684                                 (strcmp(ChrPtr(Compare), ChrPtr(ptr->wcs_value)) == 0));
 685                 case WCS_SERVCMD:
 686                         return 1;
 687                         break;
 688                 case WCS_FUNCTION:
 689                         return 1;
 690                 case WCS_LONG:
 691                         return StrTol(Compare) == ptr->lvalue;
 692                 default:
 693                         lprintf(1,"WARNING: invalid value in SV-Hash at %s!\n",
 694                                 ParamToLookup->Start);
 695                 }
 696         }
 697         return 0;
 698 }
 699
 700
 701
 702 /**
 703  * \brief puts string into the template and computes which escape methon we should use
 704  * \param Source the string we should put into the template
 705  * \param FormatTypeIndex where should we look for escape types if?
 706  */
 707 void StrBufAppendTemplate(StrBuf *Target,
 708                           WCTemplputParams *TP,
 709                           const StrBuf *Source, int FormatTypeIndex)
 710 {
 711         wcsession *WCC;
 712         StrBuf *Buf;
 713         char EscapeAs = ' ';
 714
 715         if ((FormatTypeIndex < TP->Tokens->nParameters) &&
 716             (TP->Tokens->Params[FormatTypeIndex]->Type == TYPE_STR) &&
 717             (TP->Tokens->Params[FormatTypeIndex]->len == 1)) {
 718                 EscapeAs = *TP->Tokens->Params[FormatTypeIndex]->Start;
 719         }
 720
 721         switch(EscapeAs)
 722         {
 723         case 'H':
 724                 WCC = WC;
 725                 Buf = NewStrBufPlain(NULL, StrLength(Source));
 726                 StrBuf_RFC822_to_Utf8(Buf,
 727                                       Source,
 728                                       (WCC!=NULL)? WCC->DefaultCharset : NULL,
 729                                       NULL);
 730                 StrEscAppend(Target, Buf, NULL, 0, 0);
 731                 FreeStrBuf(&Buf);
 732                 break;
 733         case 'X':
 734                 StrEscAppend(Target, Source, NULL, 0, 0);
 735                 break;
 736         case 'J':
 737           StrECMAEscAppend(Target, Source, NULL);
 738           break;
 739         default:
 740                 StrBufAppendBuf(Target, Source, 0);
 741         }
 742 }
 743
 744
 745 void PutNewToken(WCTemplate *Template, WCTemplateToken *NewToken)
 746 {
 747         if (Template->nTokensUsed + 1 >= Template->TokenSpace) {
 748                 if (Template->TokenSpace <= 0) {
 749                         Template->Tokens = (WCTemplateToken**)malloc(
 750                                 sizeof(WCTemplateToken*) * 10);
 751                         Template->TokenSpace = 10;
 752                 }
 753                 else {
 754                         WCTemplateToken **NewTokens;
 755                         NewTokens= (WCTemplateToken**)malloc(
 756                                 sizeof(WCTemplateToken*) *
 757                                 Template->TokenSpace * 2);
 758                         memcpy(NewTokens, Template->Tokens,
 759                                sizeof(WCTemplateToken*) * Template->nTokensUsed);
 760                         free(Template->Tokens);
 761                         Template->TokenSpace *= 2;
 762                         Template->Tokens = NewTokens;
 763                 }
 764         }
 765         Template->Tokens[(Template->nTokensUsed)++] = NewToken;
 766 }
 767
 768 TemplateParam *GetNextParameter(StrBuf *Buf, const char **pCh, const char *pe, WCTemplateToken *Tokens, WCTemplate *pTmpl)
 769 {
 770         const char *pch = *pCh;
 771         const char *pchs, *pche;
 772         TemplateParam *Parm = (TemplateParam *) malloc(sizeof(TemplateParam));
 773         char quote = '\0';
 774         int ParamBrace = 0;
 775
 776         Parm->Type = TYPE_STR;
 777
 778         /* Skip leading whitespaces */
 779         while ((*pch == ' ' )||
 780                (*pch == '\t')||
 781                (*pch == '\r')||
 782                (*pch == '\n')) pch ++;
 783
 784         if (*pch == ':') {
 785                 Parm->Type = TYPE_PREFSTR;
 786                 pch ++;
 787                 if (*pch == '(') {
 788                         pch ++;
 789                         ParamBrace = 1;
 790                 }
 791         }
 792         else if (*pch == ';') {
 793                 Parm->Type = TYPE_PREFINT;
 794                 pch ++;
 795                 if (*pch == '(') {
 796                         pch ++;
 797                         ParamBrace = 1;
 798                 }
 799         }
 800         else if (*pch == '_') {
 801                 Parm->Type = TYPE_GETTEXT;
 802                 pch ++;
 803                 if (*pch == '(') {
 804                         pch ++;
 805                         ParamBrace = 1;
 806                 }
 807         }
 808         else if (*pch == 'B') {
 809                 Parm->Type = TYPE_BSTR;
 810                 pch ++;
 811                 if (*pch == '(') {
 812                         pch ++;
 813                         ParamBrace = 1;
 814                 }
 815         }
 816
 817
 818         if (*pch == '"')
 819                 quote = '"';
 820         else if (*pch == '\'')
 821                 quote = '\'';
 822         if (quote != '\0') {
 823                 pch ++;
 824                 pchs = pch;
 825                 while (pch <= pe &&
 826                        ((*pch != quote) ||
 827                         ( (pch > pchs) && (*(pch - 1) == '\\'))
 828                                )) {
 829                         pch ++;
 830                 }
 831                 pche = pch;
 832                 if (*pch != quote) {
 833                         lprintf(1, "Error (in '%s' line %ld); "
 834                                 "evaluating template param [%s] in Token [%s]\n",
 835                                 ChrPtr(pTmpl->FileName),
 836                                 Tokens->Line,
 837                                 ChrPtr(Tokens->FlatToken),
 838                                 *pCh);
 839                         pch ++;
 840                         free(Parm);
 841                         return NULL;
 842                 }
 843                 else {
 844                         StrBufPeek(Buf, pch, -1, '\0');
 845                         if (LoadTemplates > 1) {
 846                                 lprintf(1, "DBG: got param [%s] %ld %ld\n",
 847                                         pchs, pche - pchs, strlen(pchs));
 848                         }
 849                         Parm->Start = pchs;
 850                         Parm->len = pche - pchs;
 851                         pch ++; /* move after trailing quote */
 852                         if (ParamBrace && (*pch == ')')) {
 853                                 pch ++;
 854                         }
 855
 856                 }
 857         }
 858         else {
 859                 Parm->Type = TYPE_LONG;
 860                 pchs = pch;
 861                 while ((pch <= pe) &&
 862                        (isdigit(*pch) ||
 863                         (*pch == '+') ||
 864                         (*pch == '-')))
 865                         pch ++;
 866                 pch ++;
 867                 if (pch - pchs > 1){
 868                         StrBufPeek(Buf, pch, -1, '\0');
 869                         Parm->lvalue = atol(pchs);
 870                         Parm->Start = pchs;
 871                         pch++;
 872                 }
 873                 else {
 874                         Parm->lvalue = 0;
 875 /* TODO whUT?
 876                         lprintf(1, "Error (in '%s' line %ld); "
 877                                 "evaluating long template param [%s] in Token [%s]\n",
 878                                 ChrPtr(pTmpl->FileName),
 879                                 Tokens->Line,
 880                                 ChrPtr(Tokens->FlatToken),
 881                                 *pCh);
 882                                 */
 883                         free(Parm);
 884                         return NULL;
 885                 }
 886         }
 887         while ((*pch == ' ' )||
 888                (*pch == '\t')||
 889                (*pch == '\r')||
 890                (*pch == ',' )||
 891                (*pch == '\n')) pch ++;
 892
 893         *pCh = pch;
 894         return Parm;
 895 }
 896
 897 WCTemplateToken *NewTemplateSubstitute(StrBuf *Buf,
 898                                        const char *pStart,
 899                                        const char *pTmplStart,
 900                                        const char *pTmplEnd,
 901                                        long Line,
 902                                        WCTemplate *pTmpl)
 903 {
 904         void *vVar;
 905         const char *pch;
 906         TemplateParam *Param;
 907         WCTemplateToken *NewToken = (WCTemplateToken*)malloc(sizeof(WCTemplateToken));
 908         WCTemplputParams TP;
 909
 910         TP.Tokens = NewToken;
 911         NewToken->FileName = pTmpl->FileName; /* to print meaningfull log messages... */
 912         NewToken->Flags = 0;
 913         NewToken->Line = Line + 1;
 914         NewToken->pTokenStart = pTmplStart;
 915         NewToken->TokenStart = pTmplStart - pStart;
 916         NewToken->TokenEnd =  (pTmplEnd - pStart) - NewToken->TokenStart;
 917         NewToken->pTokenEnd = pTmplEnd;
 918         NewToken->NameEnd = NewToken->TokenEnd - 2;
 919         NewToken->PreEval = NULL;
 920         NewToken->FlatToken = NewStrBufPlain(pTmplStart + 2, pTmplEnd - pTmplStart - 2);
 921
 922         StrBufPeek(Buf, pTmplStart, + 1, '\0');
 923         StrBufPeek(Buf, pTmplEnd, -1, '\0');
 924         pch = NewToken->pName = pTmplStart + 2;
 925
 926         NewToken->HaveParameters = 0;;
 927         NewToken->nParameters = 0;
 928
 929         while (pch < pTmplEnd - 1) {
 930                 if (*pch == '(') {
 931                         StrBufPeek(Buf, pch, -1, '\0');
 932                         NewToken->NameEnd = pch - NewToken->pName;
 933                         pch ++;
 934                         if (*(pTmplEnd - 1) != ')') {
 935                                 LogTemplateError(
 936                                         NULL, "Parseerror", ERR_NAME, &TP,
 937                                         "Warning, Non welformed Token; missing right parenthesis");
 938                         }
 939                         while (pch < pTmplEnd - 1) {
 940                                 Param = GetNextParameter(Buf, &pch, pTmplEnd - 1, NewToken, pTmpl);
 941                                 if (Param != NULL) {
 942                                         NewToken->HaveParameters = 1;
 943                                         if (NewToken->nParameters > MAXPARAM) {
 944                                                 LogTemplateError(
 945                                                         NULL, "Parseerror", ERR_NAME, &TP,
 946                                                         "only [%ld] Params allowed in Tokens",
 947                                                         MAXPARAM);
 948
 949                                                 free(Param);
 950                                                 FreeToken(&NewToken);
 951                                                 return NULL;
 952                                         }
 953                                         NewToken->Params[NewToken->nParameters++] = Param;
 954                                 }
 955                                 else break;
 956                         }
 957                         if((NewToken->NameEnd == 1) &&
 958                            (NewToken->HaveParameters == 1))
 959
 960                         {
 961                                 if (*(NewToken->pName) == '_')
 962                                         NewToken->Flags = SV_GETTEXT;
 963                                 else if (*(NewToken->pName) == '=')
 964                                         NewToken->Flags = SV_SUBTEMPL;
 965                                 else if (*(NewToken->pName) == '%')
 966                                         NewToken->Flags = SV_CUST_STR_CONDITIONAL;
 967                                 else if (*(NewToken->pName) == '?')
 968                                         NewToken->Flags = SV_CONDITIONAL;
 969                                 else if (*(NewToken->pName) == '!')
 970                                         NewToken->Flags = SV_NEG_CONDITIONAL;
 971                         }
 972                 }
 973                 else pch ++;
 974         }
 975
 976         switch (NewToken->Flags) {
 977         case 0:
 978                 /* If we're able to find out more about the token, do it now while its fresh. */
 979                 if (GetHash(GlobalNS, NewToken->pName, NewToken->NameEnd, &vVar)) {
 980                         HashHandler *Handler;
 981                         Handler = (HashHandler*) vVar;
 982                         if ((NewToken->nParameters < Handler->nMinArgs) ||
 983                             (NewToken->nParameters > Handler->nMaxArgs)) {
 984                                 LogTemplateError(
 985                                         NULL, "Token", ERR_NAME, &TP,
 986                                         "doesn't work with %ld params",
 987                                         NewToken->nParameters);
 988
 989                         }
 990                         else {
 991                                 NewToken->PreEval = Handler;
 992                                 NewToken->Flags = SV_PREEVALUATED;
 993                         }
 994                 }
 995                 break;
 996         case SV_GETTEXT:
 997                 if (NewToken->nParameters !=1) {
 998                         LogTemplateError(
 999                                 NULL, "Gettext", ERR_NAME, &TP,
1000                                 "requires exactly 1 parameter, you gave %ld params",
1001                                 NewToken->nParameters);
1002                         NewToken->Flags = 0;
1003                         break;
1004                 }
1005                 break;
1006         case SV_SUBTEMPL:
1007                 if (NewToken->nParameters != 1) {
1008                         LogTemplateError(
1009                                 NULL, "Subtemplates", ERR_NAME, &TP,
1010                                 "require exactly 1 parameter, you gave %ld params",
1011                                 NewToken->nParameters);
1012                         break;
1013                 }
1014                 break;
1015         case SV_CUST_STR_CONDITIONAL:
1016         case SV_CONDITIONAL:
1017         case SV_NEG_CONDITIONAL:
1018                 if (NewToken->nParameters <2) {
1019                         LogTemplateError(
1020                                 NULL, "Conditional", ERR_NAME, &TP,
1021                                 "require at least 2 parameters, you gave %ld params",
1022                                 NewToken->nParameters);
1023                         NewToken->Flags = 0;
1024                         break;
1025                 }
1026                 if (NewToken->Params[1]->lvalue == 0) {
1027                         LogTemplateError(
1028                                 NULL, "Conditional", ERR_NAME, &TP,
1029                                 "Conditional ID (Parameter 1) mustn't be 0!");
1030                         NewToken->Flags = 0;
1031                         break;
1032                 }
1033                 if (!GetHash(Conditionals,
1034                              NewToken->Params[0]->Start,
1035                              NewToken->Params[0]->len,
1036                              &vVar) ||
1037                     (vVar == NULL)) {
1038                         if ((NewToken->Params[0]->len == 1) &&
1039                             (NewToken->Params[0]->Start[0] == 'X'))
1040                                 break;
1041                         LogTemplateError(
1042                                 NULL, "Conditional", ERR_NAME, &TP,
1043                                 "Not found!");
1044 /*
1045                         NewToken->Error = NewStrBuf();
1046                         StrBufAppendPrintf(
1047                                 NewToken->Error,
1048                                 "<pre>\nConditional [%s] (in '%s' line %ld); Not found!\n[%s]\n</pre>\n",
1049                                 NewToken->Params[0]->Start,
1050                                 ChrPtr(pTmpl->FileName),
1051                                 NewToken->Line,
1052                                 ChrPtr(NewToken->FlatToken));
1053 */
1054                 }
1055                 else {
1056                         NewToken->PreEval = vVar;
1057                 }
1058                 break;
1059         }
1060         return NewToken;
1061 }
1062
1063
1064
1065
1066
1067 /**
1068  * \brief Display a variable-substituted template
1069  * \param templatename template file to load
1070  */
1071 void *prepare_template(StrBuf *filename, StrBuf *Key, HashList *PutThere)
1072 {
1073         WCTemplate *NewTemplate;
1074         NewTemplate = (WCTemplate *) malloc(sizeof(WCTemplate));
1075         NewTemplate->Data = NULL;
1076         NewTemplate->FileName = NewStrBufDup(filename);
1077         NewTemplate->nTokensUsed = 0;
1078         NewTemplate->TokenSpace = 0;
1079         NewTemplate->Tokens = NULL;
1080
1081         Put(PutThere, ChrPtr(Key), StrLength(Key), NewTemplate, FreeWCTemplate);
1082         return NewTemplate;
1083 }
1084
1085 /**
1086  * \brief Display a variable-substituted template
1087  * \param templatename template file to load
1088  */
1089 void *load_template(StrBuf *filename, StrBuf *Key, HashList *PutThere)
1090 {
1091         int fd;
1092         struct stat statbuf;
1093         const char *pS, *pE, *pch, *Err;
1094         long Line;
1095         int pos;
1096         WCTemplate *NewTemplate;
1097
1098         fd = open(ChrPtr(filename), O_RDONLY);
1099         if (fd <= 0) {
1100                 lprintf(1, "ERROR: could not open template '%s' - %s\n",
1101                         ChrPtr(filename), strerror(errno));
1102                 return NULL;
1103         }
1104
1105         if (fstat(fd, &statbuf) == -1) {
1106                 lprintf(1, "ERROR: could not stat template '%s' - %s\n",
1107                         ChrPtr(filename), strerror(errno));
1108                 return NULL;
1109         }
1110
1111         NewTemplate = (WCTemplate *) malloc(sizeof(WCTemplate));
1112         NewTemplate->Data = NewStrBufPlain(NULL, statbuf.st_size);
1113         NewTemplate->FileName = NewStrBufDup(filename);
1114         NewTemplate->nTokensUsed = 0;
1115         NewTemplate->TokenSpace = 0;
1116         NewTemplate->Tokens = NULL;
1117         if (StrBufReadBLOB(NewTemplate->Data, &fd, 1, statbuf.st_size, &Err) < 0) {
1118                 close(fd);
1119                 FreeWCTemplate(NewTemplate);
1120                 lprintf(1, "ERROR: reading template '%s' - %s<br />\n",
1121                         ChrPtr(filename), strerror(errno));
1122                 return NULL;
1123         }
1124         close(fd);
1125
1126         Line = 0;
1127         pS = pch = ChrPtr(NewTemplate->Data);
1128         pE = pS + StrLength(NewTemplate->Data);
1129         while (pch < pE) {
1130                 const char *pts, *pte;
1131                 int InQuotes = 0;
1132                 int InDoubleQuotes = 0;
1133
1134                 /** Find one <? > */
1135                 pos = (-1);
1136                 for (; pch < pE; pch ++) {
1137                         if ((*pch=='<')&&(*(pch + 1)=='?'))
1138                                 break;
1139                         if (*pch=='\n') Line ++;
1140                 }
1141                 if (pch >= pE)
1142                         continue;
1143                 pts = pch;
1144
1145                 /** Found one? parse it. */
1146                 for (; pch <= pE - 1; pch ++) {
1147                         if (*pch == '"')
1148                                 InDoubleQuotes = ! InDoubleQuotes;
1149                         else if (*pch == '\'')
1150                                 InQuotes = ! InQuotes;
1151                         else if ((!InQuotes  && !InDoubleQuotes) &&
1152                                  ((*pch!='\\')&&(*(pch + 1)=='>'))) {
1153                                 pch ++;
1154                                 break;
1155                         }
1156                 }
1157                 if (pch + 1 > pE)
1158                         continue;
1159                 pte = pch;
1160                 PutNewToken(NewTemplate,
1161                             NewTemplateSubstitute(NewTemplate->Data, pS, pts, pte, Line, NewTemplate));
1162                 pch ++;
1163         }
1164         if (LoadTemplates == 0)
1165                 Put(PutThere, ChrPtr(Key), StrLength(Key), NewTemplate, FreeWCTemplate);
1166         return NewTemplate;
1167 }
1168
1169
1170 const char* PrintTemplate(void *vSubst)
1171 {
1172         WCTemplate *Tmpl = vSubst;
1173
1174         return ChrPtr(Tmpl->FileName);
1175
1176 }
1177
1178 int LoadTemplateDir(const char *DirName, HashList *wireless, HashList *big)
1179 {
1180         StrBuf *FileName;
1181         StrBuf *Tag;
1182         StrBuf *Dir;
1183         DIR *filedir = NULL;
1184         struct dirent *filedir_entry;
1185         int d_namelen;
1186         int d_without_ext;
1187         int IsMobile;
1188
1189         Dir = NewStrBuf();
1190         StrBufPrintf(Dir, "%s/t", DirName);
1191         filedir = opendir (ChrPtr(Dir));
1192         if (filedir == NULL) {
1193                 FreeStrBuf(&Dir);
1194                 return 0;
1195         }
1196
1197         FileName = NewStrBuf();
1198         Tag = NewStrBuf();
1199         while ((filedir_entry = readdir(filedir)))
1200         {
1201                 char *MinorPtr;
1202                 char *PStart;
1203 #ifdef _DIRENT_HAVE_D_NAMELEN
1204                 d_namelen = filedir_entry->d_namelen;
1205 #else
1206                 d_namelen = strlen(filedir_entry->d_name);
1207 #endif
1208                 d_without_ext = d_namelen;
1209                 while ((d_without_ext > 0) && (filedir_entry->d_name[d_without_ext] != '.'))
1210                         d_without_ext --;
1211                 if ((d_without_ext == 0) || (d_namelen < 3))
1212                         continue;
1213                 if ((d_namelen > 1) && filedir_entry->d_name[d_namelen - 1] == '~')
1214                         continue; /* Ignore backup files... */
1215
1216                 IsMobile = (strstr(filedir_entry->d_name, ".m.html")!= NULL);
1217                 PStart = filedir_entry->d_name;
1218                 StrBufPrintf(FileName, "%s/%s", ChrPtr(Dir),  filedir_entry->d_name);
1219                 MinorPtr = strchr(filedir_entry->d_name, '.');
1220                 if (MinorPtr != NULL)
1221                         *MinorPtr = '\0';
1222                 StrBufPlain(Tag, filedir_entry->d_name, MinorPtr - filedir_entry->d_name);
1223
1224                 if (LoadTemplates > 1)
1225                         lprintf(1, "%s %d %s\n",ChrPtr(FileName), IsMobile, ChrPtr(Tag));
1226                 if (LoadTemplates == 0)
1227                         load_template(FileName, Tag, (IsMobile)?wireless:big);
1228                 else
1229                         prepare_template(FileName, Tag, (IsMobile)?wireless:big);
1230         }
1231         closedir(filedir);
1232         FreeStrBuf(&FileName);
1233         FreeStrBuf(&Tag);
1234         FreeStrBuf(&Dir);
1235         return 1;
1236 }
1237
1238 void InitTemplateCache(void)
1239 {
1240         LoadTemplateDir(static_dirs[0],
1241                         WirelessTemplateCache,
1242                         TemplateCache);
1243         LoadTemplateDir(static_dirs[1],
1244                         WirelessLocalTemplateCache,
1245                         LocalTemplateCache);
1246 }
1247
1248
1249
1250 /*-----------------------------------------------------------------------------
1251  *                      Filling & processing Templates
1252  */
1253 /**
1254  * \brief executes one token
1255  * \param Target buffer to append to
1256  * \param Token da to  process.
1257  * \param Template we're iterating
1258  * \param Context Contextpoointer to pass in
1259  * \param state are we in conditional state?
1260  * \param ContextType what type of information does context giv us?
1261  */
1262 int EvaluateToken(StrBuf *Target, int state, WCTemplputParams *TP)
1263 {
1264         const char *AppendMe;
1265         long AppendMeLen;
1266         HashHandler *Handler;
1267         void *vVar;
1268 /* much output, since pName is not terminated...
1269         lprintf(1,"Doing token: %s\n",Token->pName);
1270 */
1271
1272         switch (TP->Tokens->Flags) {
1273         case SV_GETTEXT:
1274                 TmplGettext(Target, TP);
1275                 break;
1276         case SV_CONDITIONAL: /** Forward conditional evaluation */
1277                 return EvaluateConditional(Target, 1, state, TP);
1278                 break;
1279         case SV_NEG_CONDITIONAL: /** Reverse conditional evaluation */
1280                 return EvaluateConditional(Target, 0, state, TP);
1281                 break;
1282         case SV_CUST_STR_CONDITIONAL: /** Conditional put custom strings from params */
1283                 if (TP->Tokens->nParameters >= 6) {
1284                         if (EvaluateConditional(Target, 0, state, TP)) {
1285                                 GetTemplateTokenString(TP, 5, &AppendMe, &AppendMeLen);
1286                                 StrBufAppendBufPlain(Target,
1287                                                      AppendMe,
1288                                                      AppendMeLen,
1289                                                      0);
1290                         }
1291                         else{
1292                                 GetTemplateTokenString(TP, 4, &AppendMe, &AppendMeLen);
1293                                 StrBufAppendBufPlain(Target,
1294                                                      AppendMe,
1295                                                      AppendMeLen,
1296                                                      0);
1297                         }
1298                 }
1299                 else  {
1300                         LogTemplateError(
1301                                 Target, "Conditional", ERR_NAME, TP,
1302                                 "needs at least 6 Params!");
1303                 }
1304                 break;
1305         case SV_SUBTEMPL:
1306                 if (TP->Tokens->nParameters == 1)
1307                         DoTemplate(TKEY(0), NULL, TP);
1308                 break;
1309         case SV_PREEVALUATED:
1310                 Handler = (HashHandler*) TP->Tokens->PreEval;
1311                 if ((Handler->ContextRequired != CTX_NONE) &&
1312                     (Handler->ContextRequired != TP->ContextType)) {
1313                         LogTemplateError(
1314                                 Target, "Token", ERR_NAME, TP,
1315                                 "requires context of type %ld, have %ld",
1316                                 Handler->ContextRequired,
1317                                 TP->ContextType);
1318                         return -1;
1319
1320                 }
1321                 Handler->HandlerFunc(Target, TP);
1322                 break;
1323         default:
1324                 if (GetHash(GlobalNS, TP->Tokens->pName, TP->Tokens->NameEnd, &vVar)) {
1325                         Handler = (HashHandler*) vVar;
1326                         if ((Handler->ContextRequired != CTX_NONE) &&
1327                             (Handler->ContextRequired != TP->ContextType)) {
1328                                 LogTemplateError(
1329                                         Target, "Token", ERR_NAME, TP,
1330                                         "requires context of type %ld, have %ld",
1331                                         Handler->ContextRequired,
1332                                         TP->ContextType);
1333                                 return -1;
1334                         }
1335                         else if ((TP->Tokens->nParameters < Handler->nMinArgs) ||
1336                                  (TP->Tokens->nParameters > Handler->nMaxArgs)) {
1337                                 LogTemplateError(
1338                                         Target, "Token", ERR_NAME, TP,
1339                                         "doesn't work with %ld params need  > %ld  < %ld",
1340                                         TP->Tokens->nParameters,
1341                                         Handler->nMaxArgs,
1342                                         Handler->nMinArgs);
1343                         }
1344                         else {
1345                                 Handler->HandlerFunc(Target, TP);
1346                         }
1347                 }
1348                 else {
1349                         print_value_of(Target, TP);
1350                 }
1351         }
1352         return 0;
1353 }
1354
1355
1356
1357 void ProcessTemplate(WCTemplate *Tmpl, StrBuf *Target, void *Context, int ContextType)
1358 {
1359         WCTemplate *pTmpl = Tmpl;
1360         int done = 0;
1361         int i, state;
1362         const char *pData, *pS;
1363         long len;
1364         WCTemplputParams TP;
1365
1366         TP.Context = Context;
1367         TP.ContextType = ContextType;
1368
1369         if (LoadTemplates != 0) {
1370                 if (LoadTemplates > 1)
1371                         lprintf(1, "DBG: ----- loading:  [%s] ------ \n",
1372                                 ChrPtr(Tmpl->FileName));
1373
1374                 pTmpl = load_template(Tmpl->FileName, NULL, NULL);
1375                 if(pTmpl == NULL) {
1376                         StrBufAppendPrintf(
1377                                 Target,
1378                                 "<pre>\nError loading Template [%s]\n See Logfile for details\n</pre>\n",
1379                                 ChrPtr(Tmpl->FileName));
1380                         return;
1381                 }
1382
1383         }
1384
1385         pS = pData = ChrPtr(pTmpl->Data);
1386         len = StrLength(pTmpl->Data);
1387         i = 0;
1388         state = 0;
1389         while (!done) {
1390                 if (i >= pTmpl->nTokensUsed) {
1391                         StrBufAppendBufPlain(Target,
1392                                              pData,
1393                                              len - (pData - pS), 0);
1394                         done = 1;
1395                 }
1396                 else {
1397                         StrBufAppendBufPlain(
1398                                 Target, pData,
1399                                 pTmpl->Tokens[i]->pTokenStart - pData, 0);
1400                         TP.Tokens = pTmpl->Tokens[i];
1401                         TP.nArgs = pTmpl->Tokens[i]->nParameters;
1402                         state = EvaluateToken(Target, state, &TP);
1403
1404                         while ((state != 0) && (i+1 < pTmpl->nTokensUsed)) {
1405                         /* condition told us to skip till its end condition */
1406                                 i++;
1407                                 TP.Tokens = pTmpl->Tokens[i];
1408                                 TP.nArgs = pTmpl->Tokens[i]->nParameters;
1409                                 if ((pTmpl->Tokens[i]->Flags == SV_CONDITIONAL) ||
1410                                     (pTmpl->Tokens[i]->Flags == SV_NEG_CONDITIONAL)) {
1411                                         if (state == EvaluateConditional(
1412                                                     Target,
1413                                                     pTmpl->Tokens[i]->Flags,
1414                                                     state,
1415                                                     &TP))
1416                                                 state = 0;
1417                                 }
1418                         }
1419                         pData = pTmpl->Tokens[i++]->pTokenEnd + 1;
1420                         if (i > pTmpl->nTokensUsed)
1421                                 done = 1;
1422                 }
1423         }
1424         if (LoadTemplates != 0) {
1425                 FreeWCTemplate(pTmpl);
1426         }
1427 }
1428
1429 /**
1430  * \brief Display a variable-substituted template
1431  * \param templatename template file to load
1432  */
1433 void DoTemplate(const char *templatename, long len, StrBuf *Target, WCTemplputParams *TP)
1434 {
1435         HashList *Static;
1436         HashList *StaticLocal;
1437         void *vTmpl;
1438
1439         if (Target == NULL)
1440                 Target = WC->WBuf;
1441         if (WC->is_mobile) {
1442                 Static = WirelessTemplateCache;
1443                 StaticLocal = WirelessLocalTemplateCache;
1444         }
1445         else {
1446                 Static = TemplateCache;
1447                 StaticLocal = LocalTemplateCache;
1448         }
1449
1450         if (len == 0)
1451         {
1452                 lprintf (1, "Can't to load a template with empty name!\n");
1453                 StrBufAppendPrintf(Target, "<pre>\nCan't to load a template with empty name!\n</pre>");
1454                 return;
1455         }
1456
1457         if (!GetHash(StaticLocal, templatename, len, &vTmpl) &&
1458             !GetHash(Static, templatename, len, &vTmpl)) {
1459                 lprintf (1, "didn't find Template [%s] %ld %ld\n", templatename, len , (long)strlen(templatename));
1460                 StrBufAppendPrintf(Target, "<pre>\ndidn't find Template [%s] %ld %ld\n</pre>",
1461                                    templatename, len,
1462                                    (long)strlen(templatename));
1463 #if 0
1464                 dbg_PrintHash(Static, PrintTemplate, NULL);
1465                 PrintHash(Static, VarPrintTransition, PrintTemplate);
1466 #endif
1467                 return;
1468         }
1469         if (vTmpl == NULL)
1470                 return;
1471         ProcessTemplate(vTmpl, Target, TP->Context, TP->ContextType);
1472 }
1473
1474 /*-----------------------------------------------------------------------------
1475  *                      Iterators
1476  */
1477 typedef struct _HashIterator {
1478         HashList *StaticList;
1479         int AdditionalParams;
1480         int ContextType;
1481         int XPectContextType;
1482         int Flags;
1483         RetrieveHashlistFunc GetHash;
1484         HashDestructorFunc Destructor;
1485         SubTemplFunc DoSubTemplate;
1486 } HashIterator;
1487
1488 void RegisterITERATOR(const char *Name, long len,
1489                       int AdditionalParams,
1490                       HashList *StaticList,
1491                       RetrieveHashlistFunc GetHash,
1492                       SubTemplFunc DoSubTempl,
1493                       HashDestructorFunc Destructor,
1494                       int ContextType,
1495                       int XPectContextType,
1496                       int Flags)
1497 {
1498         HashIterator *It = (HashIterator*)malloc(sizeof(HashIterator));
1499         It->StaticList = StaticList;
1500         It->AdditionalParams = AdditionalParams;
1501         It->GetHash = GetHash;
1502         It->DoSubTemplate = DoSubTempl;
1503         It->Destructor = Destructor;
1504         It->ContextType = ContextType;
1505         It->XPectContextType = XPectContextType;
1506         It->Flags = Flags;
1507         Put(Iterators, Name, len, It, NULL);
1508 }
1509
1510 void tmpl_iterate_subtmpl(StrBuf *Target, WCTemplputParams *TP)
1511 {
1512         void *vIt;
1513         HashIterator *It;
1514         HashList *List;
1515         HashPos  *it;
1516         SortStruct *SortBy = NULL;
1517         void *vSortBy;
1518         int DetectGroupChange = 0;
1519         int nMembersUsed;
1520         int nMembersCounted = 0;
1521         long len;
1522         const char *Key;
1523         void *vContext;
1524         void *vLastContext = NULL;
1525         StrBuf *SubBuf;
1526         int oddeven = 0;
1527         WCTemplputParams SubTP;
1528
1529         memcpy (&SubTP, &TP, sizeof(WCTemplputParams));
1530
1531         if (!GetHash(Iterators, TKEY(0), &vIt)) {
1532                 LogTemplateError(
1533                         Target, "Iterator", ERR_PARM1, TP, "Unknown!");
1534                 return;
1535         }
1536
1537         It = (HashIterator*) vIt;
1538
1539         if (TP->Tokens->nParameters < It->AdditionalParams + 2) {
1540                 LogTemplateError(
1541                         Target, "Iterator", ERR_PARM1, TP,
1542                         "doesn't work with %ld params",
1543                         TP->Tokens->nParameters);
1544                 return;
1545         }
1546
1547         if ((It->XPectContextType != CTX_NONE) &&
1548             (It->XPectContextType != TP->ContextType)) {
1549                 LogTemplateError(
1550                         Target, "Iterator", ERR_PARM1, TP,
1551                         "requires context of type %ld, have %ld",
1552                         It->XPectContextType,
1553                         TP->ContextType);
1554                 return ;
1555
1556         }
1557
1558         if (It->StaticList == NULL)
1559                 List = It->GetHash(Target, TP);
1560         else
1561                 List = It->StaticList;
1562
1563         DetectGroupChange = (It->Flags & IT_FLAG_DETECT_GROUPCHANGE) != 0;
1564         if (DetectGroupChange) {
1565                 const StrBuf *BSort;
1566                 DetectGroupChange = 0;
1567                 if (havebstr("SortBy")) {
1568                         BSort = sbstr("SortBy");
1569                         if (GetHash(SortHash, SKEY(BSort), &vSortBy) &&
1570                             (vSortBy != NULL)) {
1571                                 SortBy = (SortStruct*)vSortBy;
1572                                 /** Ok, its us, lets see in which direction we should sort... */
1573                                 if (havebstr("SortOrder")) {
1574                                         int SortOrder;
1575                                         SortOrder = LBSTR("SortOrder");
1576                                         if (SortOrder != 0)
1577                                                 DetectGroupChange = 1;
1578                                 }
1579                         }
1580                 }
1581         }
1582         nMembersUsed = GetCount(List);
1583         SubBuf = NewStrBuf();
1584         SubTP.ContextType = It->ContextType;
1585         it = GetNewHashPos(List, 0);
1586         while (GetNextHashPos(List, it, &len, &Key, &vContext)) {
1587                 if (DetectGroupChange && nMembersCounted > 0) {
1588                         if (SortBy->GroupChange(vContext, vLastContext))
1589                                 svputlong("ITERATE:ISGROUPCHANGE", 1);
1590                         else
1591                                 svputlong("ITERATE:ISGROUPCHANGE", 0);
1592                 }
1593                 svprintf(HKEY("ITERATE:ODDEVEN"), WCS_STRING, "%s",
1594                          (oddeven) ? "odd" : "even");
1595                 svprintf(HKEY("ITERATE:KEY"), WCS_STRING, "%s", Key);
1596                 svputlong("ITERATE:N", nMembersCounted);
1597                 svputlong("ITERATE:LASTN", ++nMembersCounted == nMembersUsed);
1598                 SubTP.Context = vContext;
1599                 if (It->DoSubTemplate != NULL)
1600                         It->DoSubTemplate(SubBuf, &SubTP);
1601                 DoTemplate(TKEY(1), SubBuf, &SubTP);
1602
1603                 StrBufAppendBuf(Target, SubBuf, 0);
1604                 FlushStrBuf(SubBuf);
1605                 oddeven = ~ oddeven;
1606                 vLastContext = vContext;
1607         }
1608         FreeStrBuf(&SubBuf);
1609         DeleteHashPos(&it);
1610         if (It->Destructor != NULL)
1611                 It->Destructor(&List);
1612 }
1613
1614
1615
1616 /*-----------------------------------------------------------------------------
1617  *                      Conditionals
1618  */
1619 int EvaluateConditional(StrBuf *Target, int Neg, int state, WCTemplputParams *TP)
1620 {
1621         ConditionalStruct *Cond;
1622
1623         if ((TP->Tokens->Params[0]->len == 1) &&
1624             (TP->Tokens->Params[0]->Start[0] == 'X'))
1625                 return (state != 0)?TP->Tokens->Params[1]->lvalue:0;
1626
1627         Cond = (ConditionalStruct *) TP->Tokens->PreEval;
1628         if (Cond == NULL) {
1629                 LogTemplateError(
1630                         Target, "Conditional", ERR_PARM1, TP,
1631                         "unknown!");
1632                 return 1;
1633         }
1634
1635         if (TP->Tokens->nParameters < Cond->nParams) {
1636                 LogTemplateError(
1637                         Target, "Conditional", ERR_PARM1, TP,
1638                         "needs %ld Params, have %ld!",
1639                         Cond->nParams,
1640                         TP->Tokens->nParameters);
1641                 return 0;
1642         }
1643         if (Cond->CondF(Target, TP) == Neg)
1644                 return TP->Tokens->Params[1]->lvalue;
1645         return 0;
1646 }
1647
1648 int ConditionalVar(StrBuf *Target, WCTemplputParams *TP)
1649 {
1650         void *vsubst;
1651         wcsubst *subst;
1652
1653         if (!GetHash(WC->vars, TKEY(2), &vsubst))
1654                 return 0;
1655         subst = (wcsubst*) vsubst;
1656         if ((subst->ContextRequired != CTX_NONE) &&
1657             (subst->ContextRequired != TP->ContextType)) {
1658                 LogTemplateError(
1659                         Target, "ConditionalVar", ERR_PARM1, TP,
1660                         "  WARNING: Conditional requires Context: [%ld], have [%ld]!",
1661                         subst->ContextRequired, CTX);
1662                 return -1;
1663         }
1664
1665         switch(subst->wcs_type) {
1666         case WCS_FUNCTION:
1667                 return (subst->wcs_function!=NULL);
1668         case WCS_SERVCMD:
1669                 lprintf(1, "  -> Server [%s]\n", subst->wcs_value);/* TODO */
1670                 return 1;
1671         case WCS_STRING:
1672         case WCS_STRBUF:
1673         case WCS_STRBUF_REF:
1674                 if (TP->Tokens->nParameters < 4)
1675                         return 1;
1676                 return (strcmp(TP->Tokens->Params[3]->Start, ChrPtr(subst->wcs_value)) == 0);
1677         case WCS_LONG:
1678                 if (TP->Tokens->nParameters < 4)
1679                         return (subst->lvalue != 0);
1680                 return (subst->lvalue == TP->Tokens->Params[3]->lvalue);
1681         default:
1682                 lprintf(1,"  WARNING: invalid type: [%ld]!\n", subst->wcs_type);
1683                 return -1;
1684         }
1685         return 0;
1686 }
1687
1688
1689 void RegisterConditional(const char *Name, long len,
1690                          int nParams,
1691                          WCConditionalFunc CondF,
1692                          int ContextRequired)
1693 {
1694         ConditionalStruct *Cond = (ConditionalStruct*)malloc(sizeof(ConditionalStruct));
1695         Cond->PlainName = Name;
1696         Cond->nParams = nParams;
1697         Cond->CondF = CondF;
1698         Cond->ContextRequired = ContextRequired;
1699         Put(Conditionals, Name, len, Cond, NULL);
1700 }
1701
1702 /*-----------------------------------------------------------------------------
1703  *                      Context Strings
1704  */
1705 void tmplput_ContextString(StrBuf *Target, WCTemplputParams *TP)
1706 {
1707         StrBufAppendTemplate(Target, TP, (StrBuf*)CTX, 0);
1708 }
1709 int ConditionalContextStr(StrBuf *Target, WCTemplputParams *TP)
1710 {
1711         StrBuf *TokenText = (StrBuf*) CTX;
1712         const char *CompareToken;
1713         long len;
1714
1715         GetTemplateTokenString(TP, 2, &CompareToken, &len);
1716         return strcmp(ChrPtr(TokenText), CompareToken) == 0;
1717 }
1718
1719 /*-----------------------------------------------------------------------------
1720  *                      Boxed-API
1721  */
1722
1723 void tmpl_do_boxed(StrBuf *Target, WCTemplputParams *TP)
1724 {
1725         WCTemplputParams SubTP;
1726
1727         StrBuf *Headline;
1728         if (TP->Tokens->nParameters == 2) {
1729                 if (TP->Tokens->Params[1]->Type == TYPE_STR) {
1730                         Headline = NewStrBuf();
1731                         DoTemplate(TKEY(1), Headline, TP);
1732                 }
1733                 else {
1734                         const char *Ch;
1735                         long len;
1736                         GetTemplateTokenString(TP,
1737                                                1,
1738                                                &Ch,
1739                                                &len);
1740                         Headline = NewStrBufPlain(Ch, len);
1741                 }
1742         }
1743        memcpy (&SubTP, TP, sizeof(WCTemplputParams));
1744         SubTP.Context = Headline;
1745         SubTP.ContextType = CTX_STRBUF;
1746         DoTemplate(HKEY("beginbox"), Target, &SubTP);
1747         DoTemplate(TKEY(0), Target, TP);
1748         DoTemplate(HKEY("endbox"), Target, TP);
1749         FreeStrBuf(&Headline);
1750 }
1751
1752 /*-----------------------------------------------------------------------------
1753  *                      Tabbed-API
1754  */
1755
1756 void tmpl_do_tabbed(StrBuf *Target, WCTemplputParams *TP)
1757 {
1758         StrBuf **TabNames;
1759         int i, ntabs, nTabs;
1760
1761         nTabs = ntabs = TP->Tokens->nParameters / 2;
1762         TabNames = (StrBuf **) malloc(ntabs * sizeof(StrBuf*));
1763
1764         for (i = 0; i < ntabs; i++) {
1765                 if ((TP->Tokens->Params[i * 2]->Type == TYPE_STR) &&
1766                     (TP->Tokens->Params[i * 2]->len > 0)) {
1767                         TabNames[i] = NewStrBuf();
1768                         DoTemplate(TKEY(i * 2), TabNames[i], TP);
1769                 }
1770                 else if (TP->Tokens->Params[i * 2]->Type == TYPE_GETTEXT) {
1771                         const char *Ch;
1772                         long len;
1773                         GetTemplateTokenString(TP,
1774                                                i * 2,
1775                                                &Ch,
1776                                                &len);
1777                         TabNames[i] = NewStrBufPlain(Ch, -1);
1778                 }
1779                 else {
1780                         /** A Tab without subject? we can't count that, add it as silent */
1781                         nTabs --;
1782                 }
1783         }
1784
1785         StrTabbedDialog(Target, nTabs, TabNames);
1786         for (i = 0; i < ntabs; i++) {
1787                 StrBeginTab(Target, i, nTabs);
1788                 DoTemplate(TKEY(i * 2 + 1), Target, TP);
1789                 StrEndTab(Target, i, nTabs);
1790         }
1791 }
1792
1793
1794 /*-----------------------------------------------------------------------------
1795  *                      Sorting-API
1796  */
1797
1798
1799 void RegisterSortFunc(const char *name, long len,
1800                       const char *prepend, long preplen,
1801                       CompareFunc Forward,
1802                       CompareFunc Reverse,
1803                       CompareFunc GroupChange,
1804                       long ContextType)
1805 {
1806         SortStruct *NewSort = (SortStruct*) malloc(sizeof(SortStruct));
1807         NewSort->Name = NewStrBufPlain(name, len);
1808         if (prepend != NULL)
1809                 NewSort->PrefPrepend = NewStrBufPlain(prepend, preplen);
1810         else
1811                 NewSort->PrefPrepend = NULL;
1812         NewSort->Forward = Forward;
1813         NewSort->Reverse = Reverse;
1814         NewSort->GroupChange = GroupChange;
1815         NewSort->ContextType = ContextType;
1816         Put(SortHash, name, len, NewSort, DestroySortStruct);
1817 }
1818
1819 CompareFunc RetrieveSort(WCTemplputParams *TP,
1820                          const char *OtherPrefix, long OtherPrefixLen,
1821                          const char *Default, long ldefault, long DefaultDirection)
1822 {
1823         int isdefault = 0;
1824         const StrBuf *BSort = NULL;
1825         SortStruct *SortBy;
1826         void *vSortBy;
1827         long SortOrder = -1;
1828
1829         if (havebstr("SortBy")) {
1830                 BSort = sbstr("SortBy");
1831                 if (OtherPrefix == NULL) {
1832                         set_room_pref("sort", NewStrBufDup(BSort), 0);
1833                 }
1834                 else {
1835                         set_X_PREFS(HKEY("sort"), OtherPrefix, OtherPrefixLen, NewStrBufDup(BSort), 0);
1836                 }
1837         }
1838         else { /** Try to fallback to our remembered values... */
1839                 if (OtherPrefix == NULL) {
1840                         BSort = get_room_pref("sort");
1841                 }
1842                 else {
1843                         BSort = get_X_PREFS(HKEY("sort"), OtherPrefix, OtherPrefixLen);
1844                 }
1845                 if (BSort != NULL)
1846                         putbstr("SortBy", NewStrBufDup(BSort));
1847                 else {
1848                         StrBuf *Buf;
1849
1850                         BSort = Buf = NewStrBufPlain(Default, ldefault);
1851                         putbstr("SortBy", Buf);
1852                 }
1853         }
1854
1855         if (!GetHash(SortHash, SKEY(BSort), &vSortBy) ||
1856             (vSortBy == NULL)) {
1857                 isdefault = 1;
1858                 if (!GetHash(SortHash, Default, ldefault, &vSortBy) ||
1859                     (vSortBy == NULL)) {
1860                         LogTemplateError(
1861                                 NULL, "Sorting", ERR_PARM1, TP,
1862                                 "Illegal default sort: [%s]", Default);
1863                         wc_backtrace();
1864                 }
1865         }
1866         SortBy = (SortStruct*)vSortBy;
1867
1868         /** Ok, its us, lets see in which direction we should sort... */
1869         if (havebstr("SortOrder")) {
1870                 SortOrder = LBSTR("SortOrder");
1871         }
1872         else { /** Try to fallback to our remembered values... */
1873                 StrBuf *Buf = NULL;
1874                 if (SortBy->PrefPrepend == NULL) {
1875                         Buf = get_room_pref("SortOrder");
1876                         SortOrder = StrTol(Buf);
1877                 }
1878                 else {
1879                         BSort = get_X_PREFS(HKEY("SortOrder"), OtherPrefix, OtherPrefixLen);
1880                 }
1881
1882                 if (Buf == NULL)
1883                         SortOrder = DefaultDirection;
1884
1885                 Buf = NewStrBufPlain(NULL, 64);
1886                 StrBufPrintf(Buf, "%ld", SortOrder);
1887                 putbstr("SortOrder", Buf);
1888         }
1889         switch (SortOrder) {
1890         default:
1891         case 0:
1892                 return NULL;
1893         case 1:
1894                 return SortBy->Forward;
1895         case 2:
1896                 return SortBy->Reverse;
1897         }
1898 }
1899
1900
1901 enum {
1902         eNO_SUCH_SORT,
1903         eNOT_SPECIFIED,
1904         eINVALID_PARAM,
1905         eFOUND
1906 };
1907
1908 ConstStr SortIcons[] = {
1909         {HKEY("static/sort_none.gif")},
1910         {HKEY("static/up_pointer.gif")},
1911         {HKEY("static/down_pointer.gif")},
1912 };
1913
1914 ConstStr SortNextOrder[] = {
1915         {HKEY("1")},
1916         {HKEY("2")},
1917         {HKEY("0")},
1918 };
1919
1920
1921 int GetSortMetric(WCTemplputParams *TP, SortStruct **Next, SortStruct **Param, long *SortOrder, int N)
1922 {
1923         int bSortError = eNOT_SPECIFIED;
1924         const StrBuf *BSort;
1925         void *vSort;
1926
1927         *SortOrder = 0;
1928         *Next = NULL;
1929         if (!GetHash(SortHash, TKEY(0), &vSort) ||
1930             (vSort == NULL))
1931                 return eNO_SUCH_SORT;
1932         *Param = (SortStruct*) vSort;
1933
1934
1935         if (havebstr("SortBy")) {
1936                 BSort = sbstr("SortBy");
1937                 bSortError = eINVALID_PARAM;
1938                 if ((*Param)->PrefPrepend == NULL) {
1939                         set_room_pref("sort", NewStrBufDup(BSort), 0);
1940                 }
1941                 else {
1942                         set_X_PREFS(HKEY("sort"), TKEY(N), NewStrBufDup(BSort), 0);
1943                 }
1944         }
1945         else { /** Try to fallback to our remembered values... */
1946                 if ((*Param)->PrefPrepend == NULL) {
1947                         BSort = get_room_pref("sort");
1948                 }
1949                 else {
1950                         BSort = get_X_PREFS(HKEY("sort"), TKEY(N));
1951                 }
1952         }
1953
1954         if (!GetHash(SortHash, SKEY(BSort), &vSort) ||
1955             (vSort == NULL))
1956                 return bSortError;
1957
1958         *Next = (SortStruct*) vSort;
1959
1960         /** Ok, its us, lets see in which direction we should sort... */
1961         if (havebstr("SortOrder")) {
1962                 *SortOrder = LBSTR("SortOrder");
1963         }
1964         else { /** Try to fallback to our remembered values... */
1965                 if ((*Param)->PrefPrepend == NULL) {
1966                         *SortOrder = StrTol(get_room_pref("SortOrder"));
1967                 }
1968                 else {
1969                         *SortOrder = StrTol(get_X_PREFS(HKEY("SortOrder"), TKEY(N)));
1970                 }
1971         }
1972         if (*SortOrder > 2)
1973                 *SortOrder = 0;
1974
1975         return eFOUND;
1976 }
1977
1978
1979 void tmplput_SORT_ICON(StrBuf *Target, WCTemplputParams *TP)
1980 {
1981         long SortOrder;
1982         SortStruct *Next;
1983         SortStruct *Param;
1984         const ConstStr *SortIcon;
1985
1986         switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
1987         case eNO_SUCH_SORT:
1988                 LogTemplateError(
1989                         Target, "Sorter", ERR_PARM1, TP,
1990                         " Sorter [%s] unknown!",
1991                         TP->Tokens->Params[0]->Start);
1992                 break;
1993         case eINVALID_PARAM:
1994                 LogTemplateError(NULL, "Sorter", ERR_PARM1, TP,
1995                                  " Sorter specified by BSTR 'SortBy' [%s] unknown!",
1996                                  bstr("SortBy"));
1997         case eNOT_SPECIFIED:
1998         case eFOUND:
1999                 if (Next == Param) {
2000                         SortIcon = &SortIcons[SortOrder];
2001                 }
2002                 else { /** Not Us... */
2003                         SortIcon = &SortIcons[0];
2004                 }
2005                 StrBufAppendBufPlain(Target, SortIcon->Key, SortIcon->len, 0);
2006         }
2007 }
2008
2009 void tmplput_SORT_NEXT(StrBuf *Target, WCTemplputParams *TP)
2010 {
2011         long SortOrder;
2012         SortStruct *Next;
2013         SortStruct *Param;
2014
2015         switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2016         case eNO_SUCH_SORT:
2017                 LogTemplateError(
2018                         Target, "Sorter", ERR_PARM1, TP,
2019                         " Sorter [%s] unknown!",
2020                         TP->Tokens->Params[0]->Start);
2021                 break;
2022         case eINVALID_PARAM:
2023                 LogTemplateError(
2024                         NULL, "Sorter", ERR_PARM1, TP,
2025                         " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2026                         bstr("SortBy"));
2027         case eNOT_SPECIFIED:
2028         case eFOUND:
2029                 StrBufAppendBuf(Target, Param->Name, 0);
2030
2031         }
2032 }
2033
2034 void tmplput_SORT_ORDER(StrBuf *Target, WCTemplputParams *TP)
2035 {
2036         long SortOrder;
2037         const ConstStr *SortOrderStr;
2038         SortStruct *Next;
2039         SortStruct *Param;
2040
2041         switch (GetSortMetric(TP, &Next, &Param, &SortOrder, 2)){
2042         case eNO_SUCH_SORT:
2043                 LogTemplateError(
2044                         Target, "Sorter", ERR_PARM1, TP,
2045                         " Sorter [%s] unknown!",
2046                         TP->Tokens->Params[0]->Start);
2047                 break;
2048         case eINVALID_PARAM:
2049                 LogTemplateError(
2050                         NULL, "Sorter", ERR_PARM1, TP,
2051                         " Sorter specified by BSTR 'SortBy' [%s] unknown!",
2052                         bstr("SortBy"));
2053         case eNOT_SPECIFIED:
2054         case eFOUND:
2055                 if (Next == Param) {
2056                         SortOrderStr = &SortNextOrder[SortOrder];
2057                 }
2058                 else { /** Not Us... */
2059                         SortOrderStr = &SortNextOrder[0];
2060                 }
2061                 StrBufAppendBufPlain(Target, SortOrderStr->Key, SortOrderStr->len, 0);
2062         }
2063 }
2064
2065
2066 void tmplput_long_vector(StrBuf *Target, WCTemplputParams *TP)
2067 {
2068         long *LongVector = (long*) CTX;
2069
2070         if ((TP->Tokens->Params[0]->Type == TYPE_LONG) &&
2071             (TP->Tokens->Params[0]->lvalue <= LongVector[0]))
2072         {
2073                 StrBufAppendPrintf(Target, "%ld", LongVector[TP->Tokens->Params[0]->lvalue]);
2074         }
2075         else
2076         {
2077                 if (TP->Tokens->Params[0]->Type != TYPE_LONG) {
2078                         LogTemplateError(
2079                                 Target, "Longvector", ERR_NAME, TP,
2080                                 "needs a numerical Parameter!");
2081                 }
2082                 else {
2083                         LogTemplateError(
2084                                 Target, "LongVector", ERR_PARM1, TP,
2085                                 "doesn't have %ld Parameters, its just the size of %ld!",
2086                                 TP->Tokens->Params[0]->lvalue,
2087                                 LongVector[0]);
2088                 }
2089         }
2090 }
2091
2092 void dbg_print_longvector(long *LongVector)
2093 {
2094         StrBuf *Buf = NewStrBufPlain(HKEY("Longvector: ["));
2095         int nItems = LongVector[0];
2096         int i;
2097
2098         for (i = 0; i < nItems; i++) {
2099                 if (i + 1 < nItems)
2100                         StrBufAppendPrintf(Buf, "%d: %ld | ", i, LongVector[i]);
2101                 else
2102                         StrBufAppendPrintf(Buf, "%d: %ld]\n", i, LongVector[i]);
2103
2104         }
2105         lprintf(1, ChrPtr(Buf));
2106         FreeStrBuf(&Buf);
2107 }
2108
2109 int ConditionalLongVector(StrBuf *Target, WCTemplputParams *TP)
2110 {
2111         long *LongVector = (long*) CTX;
2112
2113         if ((TP->Tokens->Params[2]->Type == TYPE_LONG) &&
2114             (TP->Tokens->Params[2]->lvalue <= LongVector[0])&&
2115             (TP->Tokens->Params[3]->Type == TYPE_LONG) &&
2116             (TP->Tokens->Params[3]->lvalue <= LongVector[0]))
2117         {
2118                 return LongVector[TP->Tokens->Params[2]->lvalue] ==
2119                         LongVector[TP->Tokens->Params[3]->lvalue];
2120         }
2121         else
2122         {
2123                 if ((TP->Tokens->Params[2]->Type == TYPE_LONG) ||
2124                     (TP->Tokens->Params[2]->Type == TYPE_LONG)) {
2125                         LogTemplateError(
2126                                 Target, "ConditionalLongvector", ERR_PARM1, TP,
2127                                 "needs two long Parameter!");
2128                 }
2129                 else {
2130                         LogTemplateError(
2131                                 Target, "Longvector", ERR_PARM1, TP,
2132                                 "doesn't have %ld / %ld Parameters, its just the size of %ld!",
2133                                 TP->Tokens->Params[2]->lvalue,
2134                                 TP->Tokens->Params[3]->lvalue,
2135                                 LongVector[0]);
2136                 }
2137         }
2138         return 0;
2139 }
2140
2141 void
2142 InitModule_SUBST
2143 (void)
2144 {
2145         memset(&NoCtx, 0, sizeof(WCTemplputParams));
2146         RegisterNamespace("SORT:ICON", 1, 2, tmplput_SORT_ICON, CTX_NONE);
2147         RegisterNamespace("SORT:ORDER", 1, 2, tmplput_SORT_ORDER, CTX_NONE);
2148         RegisterNamespace("SORT:NEXT", 1, 2, tmplput_SORT_NEXT, CTX_NONE);
2149         RegisterNamespace("CONTEXTSTR", 0, 1, tmplput_ContextString, CTX_STRBUF);
2150         RegisterNamespace("ITERATE", 2, 100, tmpl_iterate_subtmpl, CTX_NONE);
2151         RegisterNamespace("DOBOXED", 1, 2, tmpl_do_boxed, CTX_NONE);
2152         RegisterNamespace("DOTABBED", 2, 100, tmpl_do_tabbed, CTX_NONE);
2153         RegisterNamespace("LONGVECTOR", 1, 1, tmplput_long_vector, CTX_LONGVECTOR);
2154         RegisterConditional(HKEY("COND:SUBST"), 3, ConditionalVar, CTX_NONE);
2155         RegisterConditional(HKEY("COND:CONTEXTSTR"), 3, ConditionalContextStr, CTX_STRBUF);
2156         RegisterConditional(HKEY("COND:LONGVECTOR"), 4, ConditionalLongVector, CTX_LONGVECTOR);
2157 }
2158
2159 /*@}*/