bfc8ac7ff1dfdead5a1132718425a9415e68e746
[citadel.git] / webcit / paramhandling.c
1 /*
2  * parse urlparts and post data
3  *
4  * Copyright (c) 1996-2013 by the citadel.org team
5  *
6  * This program is open source software.  You can redistribute it and/or
7  * modify it under the terms of the GNU General Public License, version 3.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  */
14
15 #include "webcit.h"
16 #include "webserver.h"
17
18 /* uncomment to see all parameters sent to the server by the browser. */
19 /* #define DEBUG_URLSTRINGS */
20
21
22 void free_url(void *U)
23 {
24         urlcontent *u = (urlcontent*) U;
25         FreeStrBuf(&u->url_data);
26         if (u->sub != NULL) {
27                 DeleteHash(&u->sub);
28         }
29         free(u);
30 }
31
32 void PutSubstructUrlKey(HashList *list, urlcontent *u, char **keys, long *lengths, int max, int which){
33         void *vUrl;
34         urlcontent *subu;
35         HashList *thisList = list;
36         if (GetHash(list, keys[which], lengths[which], &vUrl) &&
37             (vUrl != NULL))
38         {
39                 subu = (urlcontent*) vUrl;
40                 if (subu->sub == NULL) {
41                         subu->sub = NewHash(1, NULL);
42                 }
43                 thisList = subu->sub;
44         } 
45         else if (which < max) {
46                 subu = (urlcontent *) malloc(sizeof(urlcontent));
47                 
48                 memcpy(subu->url_key, keys[which], lengths[which]);
49                 subu->klen = lengths[which];
50                 subu->url_data = NULL;
51                 subu->sub = NewHash(1, NULL);
52                 
53                 Put(list, subu->url_key, subu->klen, subu, free_url);
54                 thisList = subu->sub;
55         }
56         if (which >= max) {
57                 Put(thisList, keys[which], lengths[which], u, free_url);
58         }
59         else {
60                 PutSubstructUrlKey(subu->sub, u, keys, lengths, max, which + 1);
61         }
62 }
63
64 void PutUrlKey(HashList *urlstrings, urlcontent *u, int have_colons) {
65         if (!have_colons) {
66                 Put(urlstrings, u->url_key, u->klen, u, free_url);
67         }
68         else {
69                 char *keys[10];
70                 long lengths[10];
71                 int i = 0;
72                 char *pch;
73                 char *pchs;
74                 char *pche;
75
76                 memset(&keys, 0, sizeof(keys));
77                 memset(&lengths, 0, sizeof(lengths));
78                 pchs = pch = u->url_key;
79                 pche = u->url_key + u->klen;
80                 while ((i < 10) && (pch <= pche)) {
81                         if ((*pch != ':') && (pch != pche)){
82                                 pch ++;
83                                 continue;
84                         }
85                         *pch = '\0';
86                         if (i == 0) {
87                                 /* Separate the toplevel key : */
88                                 u->klen = pch - pchs;
89                         }
90                         /* sub-section: */
91                         keys[i] = pchs;
92                         lengths[i] = pch - pchs;
93                         
94                         pch++;
95                         pchs = pch;
96                         i++;
97                 }
98                 
99                 PutSubstructUrlKey(urlstrings, u, keys, lengths, i - 1, 0);
100         }
101 }
102
103 /*
104  * Extract variables from the URL.
105  */
106 void ParseURLParams(StrBuf *url)
107 {
108         const char *aptr, *bptr, *eptr, *up = NULL;
109         int len, keylen = 0;
110         urlcontent *u = NULL;
111         wcsession *WCC = WC;
112
113         if (WCC->Hdr->urlstrings == NULL) {
114                 WCC->Hdr->urlstrings = NewHash(1, NULL);
115         }
116         eptr = ChrPtr(url) + StrLength(url);
117         up = ChrPtr(url);
118         while ((up < eptr) && (!IsEmptyStr(up))) {
119                 int have_colon = 0;
120                 aptr = up;
121                 while ((aptr < eptr) && (*aptr != '\0') && (*aptr != '=')) {
122                         if (*aptr == ':') {
123                                 have_colon = 1;
124                         }
125                         aptr++;
126                 }
127                 if (*aptr != '=') {
128                         return;
129                 }
130                 aptr++;
131                 bptr = aptr;
132                 while ((bptr < eptr) && (*bptr != '\0')
133                       && (*bptr != '&') && (*bptr != '?') && (*bptr != ' ')) {
134                         bptr++;
135                 }
136                 keylen = aptr - up - 1; /* -1 -> '=' */
137                 if (keylen > sizeof(u->url_key)) {
138                         syslog(LOG_WARNING, "%s:%d: invalid url_key of size %d in string size %ld",
139                                 __FILE__, __LINE__, keylen, sizeof(u->url_key)
140                         );
141                 }
142
143                 if (keylen < 0) {
144                         syslog(LOG_WARNING, "%s:%d: invalid url_key of size %d", __FILE__, __LINE__, keylen);
145                         free(u);
146                         return;
147                 }
148                 
149                 u = (urlcontent *) malloc(sizeof(urlcontent));
150                 memcpy(u->url_key, up, keylen);
151                 u->url_key[keylen] = '\0';
152                 u->klen = keylen;
153                 u->sub = NULL;
154
155                 if (strncmp(u->url_key, "__", 2) != 0)
156                 {
157                         len = bptr - aptr;
158                         u->url_data = NewStrBufPlain(aptr, len);
159                         StrBufUnescape(u->url_data, 1);
160 #ifdef DEBUG_URLSTRINGS
161                         syslog(LOG_DEBUG, "%s = [%d]  %s\n", 
162                                 u->url_key, 
163                                 StrLength(u->url_data), 
164                                 ChrPtr(u->url_data)); 
165 #endif
166                         PutUrlKey(WCC->Hdr->urlstrings, u, have_colon);
167                 }
168                 else {
169                         len = bptr - aptr;
170                         u->url_data = NewStrBufPlain(aptr, len);
171                         StrBufUnescape(u->url_data, 1);
172                         syslog(LOG_WARNING, "REJECTED because of __ is internal only: %s = [%d]  %s\n", 
173                                 u->url_key, 
174                                 StrLength(u->url_data), 
175                                 ChrPtr(u->url_data)); 
176                         
177                         free_url(u);
178                 }
179                 up = bptr;
180                 ++up;
181         }
182 }
183
184 /*
185  * free urlstring memory
186  */
187 void free_urls(void)
188 {
189         DeleteHash(&WC->Hdr->urlstrings);
190 }
191
192 /*
193  * Diagnostic function to display the contents of all variables
194  */
195
196 void dump_vars(void)
197 {
198         wcsession *WCC = WC;
199         urlcontent *u;
200         void *U;
201         long HKLen;
202         const char *HKey;
203         HashPos *Cursor;
204         
205         Cursor = GetNewHashPos (WCC->Hdr->urlstrings, 0);
206         while (GetNextHashPos(WCC->Hdr->urlstrings, Cursor, &HKLen, &HKey, &U)) {
207                 u = (urlcontent*) U;
208                 wc_printf("%38s = %s\n", u->url_key, ChrPtr(u->url_data));
209         }
210 }
211
212 /*
213  * Return the value of a variable supplied to the current web page (from the url or a form)
214  */
215
216 const char *XBstr(const char *key, size_t keylen, size_t *len)
217 {
218         void *U;
219
220         if ((WC->Hdr->urlstrings != NULL) && 
221             GetHash(WC->Hdr->urlstrings, key, keylen, &U)) {
222                 *len = StrLength(((urlcontent *)U)->url_data);
223                 return ChrPtr(((urlcontent *)U)->url_data);
224         }
225         else {
226                 *len = 0;
227                 return ("");
228         }
229 }
230
231 const char *XBSTR(const char *key, size_t *len)
232 {
233         void *U;
234
235         if ((WC->Hdr->urlstrings != NULL) &&
236             GetHash(WC->Hdr->urlstrings, key, strlen (key), &U)){
237                 *len = StrLength(((urlcontent *)U)->url_data);
238                 return ChrPtr(((urlcontent *)U)->url_data);
239         }
240         else {
241                 *len = 0;
242                 return ("");
243         }
244 }
245
246
247 const char *BSTR(const char *key)
248 {
249         void *U;
250
251         if ((WC->Hdr->urlstrings != NULL) &&
252             GetHash(WC->Hdr->urlstrings, key, strlen (key), &U))
253                 return ChrPtr(((urlcontent *)U)->url_data);
254         else    
255                 return ("");
256 }
257
258 const char *Bstr(const char *key, size_t keylen)
259 {
260         void *U;
261
262         if ((WC->Hdr->urlstrings != NULL) && 
263             GetHash(WC->Hdr->urlstrings, key, keylen, &U))
264                 return ChrPtr(((urlcontent *)U)->url_data);
265         else    
266                 return ("");
267 }
268
269 const StrBuf *SBSTR(const char *key)
270 {
271         void *U;
272
273         if ((WC->Hdr->urlstrings != NULL) &&
274             GetHash(WC->Hdr->urlstrings, key, strlen (key), &U))
275                 return ((urlcontent *)U)->url_data;
276         else    
277                 return NULL;
278 }
279
280 const StrBuf *SBstr(const char *key, size_t keylen)
281 {
282         void *U;
283
284         if ((WC->Hdr->urlstrings != NULL) && 
285             GetHash(WC->Hdr->urlstrings, key, keylen, &U))
286                 return ((urlcontent *)U)->url_data;
287         else    
288                 return NULL;
289 }
290
291 long LBstr(const char *key, size_t keylen)
292 {
293         void *U;
294
295         if ((WC->Hdr->urlstrings != NULL) && 
296             GetHash(WC->Hdr->urlstrings, key, keylen, &U))
297                 return StrTol(((urlcontent *)U)->url_data);
298         else    
299                 return (0);
300 }
301
302 long LBSTR(const char *key)
303 {
304         void *U;
305
306         if ((WC->Hdr->urlstrings != NULL) && 
307             GetHash(WC->Hdr->urlstrings, key, strlen(key), &U))
308                 return StrTol(((urlcontent *)U)->url_data);
309         else    
310                 return (0);
311 }
312
313 int IBstr(const char *key, size_t keylen)
314 {
315         void *U;
316
317         if ((WC->Hdr->urlstrings != NULL) && 
318             GetHash(WC->Hdr->urlstrings, key, keylen, &U))
319                 return StrTol(((urlcontent *)U)->url_data);
320         else    
321                 return (0);
322 }
323
324 int IBSTR(const char *key)
325 {
326         void *U;
327
328         if ((WC->Hdr->urlstrings != NULL) && 
329             GetHash(WC->Hdr->urlstrings, key, strlen(key), &U))
330                 return StrToi(((urlcontent *)U)->url_data);
331         else    
332                 return (0);
333 }
334
335 int HaveBstr(const char *key, size_t keylen)
336 {
337         void *U;
338
339         if ((WC->Hdr->urlstrings != NULL) && 
340             GetHash(WC->Hdr->urlstrings, key, keylen, &U))
341                 return (StrLength(((urlcontent *)U)->url_data) != 0);
342         else    
343                 return (0);
344 }
345
346 int HAVEBSTR(const char *key)
347 {
348         void *U;
349
350         if ((WC->Hdr->urlstrings != NULL) && 
351             GetHash(WC->Hdr->urlstrings, key, strlen(key), &U))
352                 return (StrLength(((urlcontent *)U)->url_data) != 0);
353         else    
354                 return (0);
355 }
356
357
358 int YesBstr(const char *key, size_t keylen)
359 {
360         void *U;
361
362         if ((WC->Hdr->urlstrings != NULL) && 
363             GetHash(WC->Hdr->urlstrings, key, keylen, &U))
364                 return strcmp( ChrPtr(((urlcontent *)U)->url_data), "yes") == 0;
365         else    
366                 return (0);
367 }
368
369 int YESBSTR(const char *key)
370 {
371         void *U;
372
373         if ((WC->Hdr->urlstrings != NULL) && 
374             GetHash(WC->Hdr->urlstrings, key, strlen(key), &U))
375                 return strcmp( ChrPtr(((urlcontent *)U)->url_data), "yes") == 0;
376         else    
377                 return (0);
378 }
379
380
381
382
383 /*
384  * This function is called by the MIME parser to handle data uploaded by
385  * the browser.  Form data, uploaded files, and the data from HTTP PUT
386  * operations (such as those found in GroupDAV) all arrive this way.
387  *
388  * name         Name of the item being uploaded
389  * filename     Filename of the item being uploaded
390  * partnum      MIME part identifier (not needed)
391  * disp         MIME content disposition (not needed)
392  * content      The actual data
393  * cbtype       MIME content-type
394  * cbcharset    Character set
395  * length       Content length
396  * encoding     MIME encoding type (not needed)
397  * cbid         Content ID (not needed)
398  * userdata     Not used here
399  */
400 void upload_handler(char *name, char *filename, char *partnum, char *disp,
401                         void *content, char *cbtype, char *cbcharset,
402                         size_t length, char *encoding, char *cbid, void *userdata)
403 {
404         wcsession *WCC = WC;
405         urlcontent *u;
406         long keylen;
407
408 #ifdef DEBUG_URLSTRINGS
409         syslog(LOG_DEBUG, "upload_handler() name=%s, type=%s, len="SIZE_T_FMT, name, cbtype, length);
410 #endif
411         if (WCC->Hdr->urlstrings == NULL)
412                 WCC->Hdr->urlstrings = NewHash(1, NULL);
413
414         /* Form fields */
415         if ( (length > 0) && (IsEmptyStr(cbtype)) ) {
416                 u = (urlcontent *) malloc(sizeof(urlcontent));
417                 
418                 keylen = safestrncpy(u->url_key, name, sizeof(u->url_key));
419                 u->url_data = NewStrBufPlain(content, length);
420                 u->klen = keylen;
421                 u->sub = NULL;
422                 
423                 if (strncmp(u->url_key, "__", 2) != 0)
424                 {
425                         PutUrlKey(WCC->Hdr->urlstrings, u, (strchr(u->url_key, ':') != NULL));
426                 }
427                 else {
428                         syslog(LOG_INFO, "REJECTED because of __ is internal only: %s = [%d]  %s\n", 
429                                 u->url_key, 
430                                 StrLength(u->url_data), 
431                                 ChrPtr(u->url_data)); 
432                         
433                         free_url(u);
434                 }
435 #ifdef DEBUG_URLSTRINGS
436                 syslog(LOG_DEBUG, "Key: <%s> len: [%d] Data: <%s>", 
437                         u->url_key, 
438                         StrLength(u->url_data), 
439                         ChrPtr(u->url_data));
440 #endif
441         }
442
443         /* Uploaded files */
444         if ( (length > 0) && (!IsEmptyStr(cbtype)) ) {
445                 WCC->upload = NewStrBufPlain(content, length);
446                 WCC->upload_length = length;
447                 WCC->upload_filename = NewStrBufPlain(filename, -1);
448                 safestrncpy(WCC->upload_content_type, cbtype, sizeof(WC->upload_content_type));
449 #ifdef DEBUG_URLSTRINGS
450                 syslog(LOG_DEBUG, "File: <%s> len: [%ld]", filename, (long int)length);
451 #endif
452                 
453         }
454
455 }
456
457 void PutBstr(const char *key, long keylen, StrBuf *Value)
458 {
459         urlcontent *u;
460
461         if(keylen >= sizeof(u->url_key)) {
462                 syslog(LOG_WARNING, "%s:%d: invalid url_key of size %ld", __FILE__, __LINE__, keylen);
463                 FreeStrBuf(&Value);
464                 return;
465         }
466         u = (urlcontent*)malloc(sizeof(urlcontent));
467         memcpy(u->url_key, key, keylen + 1);
468         u->klen = keylen;
469         u->url_data = Value;
470         u->sub = NULL;
471         Put(WC->Hdr->urlstrings, u->url_key, keylen, u, free_url);
472 }
473 void PutlBstr(const char *key, long keylen, long Value)
474 {
475         StrBuf *Buf;
476
477         Buf = NewStrBufPlain(NULL, sizeof(long) * 16);
478         StrBufPrintf(Buf, "%ld", Value);
479         PutBstr(key, keylen, Buf);
480 }
481
482
483
484 int ConditionalBstr(StrBuf *Target, WCTemplputParams *TP)
485 {
486         if(TP->Tokens->nParameters == 3)
487                 return HaveBstr(TKEY(2));
488         else {
489                 if (IS_NUMBER(TP->Tokens->Params[3]->Type))
490                 {
491                         return LBstr(TKEY(2)) == 
492                                 GetTemplateTokenNumber(Target, 
493                                                        TP, 
494                                                        3, 
495                                                        0);
496                 }
497                 else {
498                         const char *pch;
499                         long len;
500
501                         GetTemplateTokenString (Target, TP, 3, &pch, &len);
502                         return strcmp(Bstr(TKEY(2)), pch) == 0;
503                 }
504         }
505 }
506
507 void tmplput_bstr(StrBuf *Target, WCTemplputParams *TP)
508 {
509         const StrBuf *Buf = SBstr(TKEY(0));
510         if (Buf != NULL)
511                 StrBufAppendTemplate(Target, TP, Buf, 1);
512 }
513
514
515 void tmplput_bstrforward(StrBuf *Target, WCTemplputParams *TP)
516 {
517         const StrBuf *Buf = SBstr(TKEY(0));
518         if (Buf != NULL) {
519                 StrBufAppendBufPlain(Target, HKEY("?"), 0);             
520                 StrBufAppendBufPlain(Target, TKEY(0), 0);
521                 StrBufAppendBufPlain(Target, HKEY("="), 0);             
522                 StrBufAppendTemplate(Target, TP, Buf, 1);
523         }
524 }
525
526 void diagnostics(void)
527 {
528         output_headers(1, 1, 1, 0, 0, 0);
529         wc_printf("Session: %d<hr />\n", WC->wc_session);
530         wc_printf("Command: <br><PRE>\n");
531 /*      
532 StrEscAppend(WC->WBuf, NULL, WC->UrlFragment1, 0, 0);
533         wc_printf("<br>\n");
534 StrEscAppend(WC->WBuf, NULL, WC->UrlFragment12 0, 0);
535         wc_printf("<br>\n");
536 StrEscAppend(WC->WBuf, NULL, WC->UrlFragment3, 0, 0);
537 */
538         wc_printf("</PRE><hr />\n");
539         wc_printf("Variables: <br><PRE>\n");
540         dump_vars();
541         wc_printf("</PRE><hr />\n");
542         wDumpContent(1);
543 }
544
545
546 void tmplput_url_part(StrBuf *Target, WCTemplputParams *TP)
547 {
548         StrBuf *Name = NULL;
549         StrBuf *UrlBuf = NULL;
550         wcsession *WCC = WC;
551         
552         if (WCC != NULL) {
553                 long n;
554
555                 n = GetTemplateTokenNumber(Target, TP, 0, 0);
556                 if (n == 0) {
557                         if (WCC->Hdr->HR.Handler != NULL)
558                                 UrlBuf = Name = WCC->Hdr->HR.Handler->Name;
559                 }
560                 else if (n == 1) {
561                         UrlBuf = NewStrBuf();
562                         StrBufExtract_token(UrlBuf, WCC->Hdr->HR.ReqLine, 0, '/');
563                 }
564                 else {
565                         UrlBuf = NewStrBuf();
566                         StrBufExtract_token(UrlBuf, WCC->Hdr->HR.ReqLine, 1, '/');
567                 }
568
569                 if (UrlBuf == NULL)  {
570                         LogTemplateError(Target, "urlbuf", ERR_PARM1, TP, "not set.");
571                 }
572                 StrBufAppendTemplate(Target, TP, UrlBuf, 2);
573                 if (Name == NULL) FreeStrBuf(&UrlBuf);
574         }
575 }
576
577 typedef struct __BstrPair {
578         StrBuf *x;
579         StrBuf *y;
580 }BstrPair;
581 CtxType CTX_BSTRPAIRS = CTX_NONE;
582 void HFreeBstrPair(void *pv)
583 {
584         BstrPair *p = (BstrPair*) pv;
585         FreeStrBuf(&p->x);
586         FreeStrBuf(&p->y);
587         free(pv);
588 }
589
590 HashList *iterate_GetBstrPairs(StrBuf *Target, WCTemplputParams *TP)
591 {
592         StrBuf *X, *Y;
593         const char *ch = NULL;
594         long len;
595         const StrBuf *TheBStr;
596         BstrPair *OnePair;
597         HashList *List;
598         const char *Pos = NULL;
599         int i = 0;
600
601         if (HaveTemplateTokenString(NULL, TP, 2, &ch, &len))
602         {
603                 GetTemplateTokenString(Target, TP, 2, &ch, &len);
604         }
605         else 
606         {
607                 return NULL;
608         }
609
610         TheBStr = SBstr(ch, len);
611         if ((TheBStr == NULL) || (StrLength(TheBStr) == 0))
612                 return NULL;
613         List = NewHash(1, NULL);
614         while (Pos != StrBufNOTNULL)
615         {
616                 X = NewStrBufPlain(NULL, StrLength(TheBStr));
617                 StrBufExtract_NextToken(X, TheBStr, &Pos, '|');
618                 if (Pos == StrBufNOTNULL) {
619                         FreeStrBuf(&X);
620                         DeleteHash(&List);
621                         return NULL;
622                 }
623                 Y = NewStrBufPlain(NULL, StrLength(TheBStr));
624                 StrBufExtract_NextToken(Y, TheBStr, &Pos, '|');
625                 OnePair = (BstrPair*)malloc(sizeof(BstrPair));
626                 OnePair->x = X;
627                 OnePair->y = Y;
628                 Put(List, IKEY(i), OnePair, HFreeBstrPair);
629                 i++;
630         }
631         return List;
632 }
633
634
635 void tmplput_bstr_pair(StrBuf *Target, WCTemplputParams *TP, int XY)
636 {
637         BstrPair *Pair = (BstrPair*) CTX(CTX_BSTRPAIRS);
638
639         StrBufAppendTemplate(Target, TP, (XY)?Pair->y:Pair->x, 0);
640 }
641
642 void tmplput_bstr_pair_x(StrBuf *Target, WCTemplputParams *TP)
643 {       tmplput_bstr_pair(Target, TP, 0); }
644 void tmplput_bstr_pair_y(StrBuf *Target, WCTemplputParams *TP)
645 {       tmplput_bstr_pair(Target, TP, 1); }
646
647 void 
648 InitModule_PARAMHANDLING
649 (void)
650 {
651         RegisterCTX(CTX_BSTRPAIRS);
652         WebcitAddUrlHandler(HKEY("diagnostics"), "", 0, diagnostics, NEED_URL);
653
654         RegisterIterator("ITERATE:BSTR:PAIR", 1, NULL, iterate_GetBstrPairs, NULL, DeleteHash, CTX_BSTRPAIRS, CTX_NONE, IT_NOFLAG);
655         RegisterNamespace("BSTR:PAIR:X", 1, 2, tmplput_bstr_pair_x, NULL, CTX_BSTRPAIRS);
656         RegisterNamespace("BSTR:PAIR:Y", 1, 2, tmplput_bstr_pair_y, NULL, CTX_BSTRPAIRS);
657
658         RegisterConditional("COND:BSTR", 1, ConditionalBstr, CTX_NONE);
659         RegisterNamespace("BSTR", 1, 2, tmplput_bstr, NULL, CTX_NONE);
660         RegisterNamespace("BSTR:FORWARD", 1, 2, tmplput_bstrforward, NULL, CTX_NONE);
661         RegisterNamespace("URLPART", 1, 2, tmplput_url_part, NULL, CTX_NONE);
662 }
663
664
665 void
666 SessionAttachModule_PARAMHANDLING
667 (wcsession *sess)
668 {
669         sess->Hdr->urlstrings = NewHash(1,NULL);
670 }
671
672 void
673 SessionDetachModule_PARAMHANDLING
674 (wcsession *sess)
675 {
676         DeleteHash(&sess->Hdr->urlstrings);
677         FreeStrBuf(&sess->upload_filename);
678 }