3 * parse urlparts and post data
5 * Copyright (c) 1996-2019 by the citadel.org team
7 * This program is open source software. You can redistribute it and/or
8 * modify it under the terms of the GNU General Public License, version 3.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
17 #include "webserver.h"
19 /* uncomment to see all parameters sent to the server by the browser. */
21 /* #define DEBUG_URLSTRINGS */
24 void free_url(void *U) {
25 urlcontent *u = (urlcontent *) U;
26 FreeStrBuf(&u->url_data);
33 void PutSubstructUrlKey(HashList * list, urlcontent * u, char **keys, long *lengths, int max, int which) {
36 HashList *thisList = list;
37 if (GetHash(list, keys[which], lengths[which], &vUrl) && (vUrl != NULL)) {
38 subu = (urlcontent *) vUrl;
39 if (subu->sub == NULL) {
40 subu->sub = NewHash(1, NULL);
44 else if (which < max) {
45 subu = (urlcontent *) malloc(sizeof(urlcontent));
47 memcpy(subu->url_key, keys[which], lengths[which]);
48 subu->klen = lengths[which];
49 subu->url_data = NULL;
50 subu->sub = NewHash(1, NULL);
52 Put(list, subu->url_key, subu->klen, subu, free_url);
56 Put(thisList, keys[which], lengths[which], u, free_url);
59 PutSubstructUrlKey(subu->sub, u, keys, lengths, max, which + 1);
63 void PutUrlKey(HashList * urlstrings, urlcontent * u, int have_colons) {
64 if (have_colons == 0) {
65 Put(urlstrings, u->url_key, u->klen, u, free_url);
75 memset(&keys, 0, sizeof(keys));
76 memset(&lengths, 0, sizeof(lengths));
77 pchs = pch = u->url_key;
78 pche = u->url_key + u->klen;
79 while ((i < 10) && (pch <= pche)) {
80 if ((have_colons == 2) &&
81 (*pch == '%') && (*(pch + 1) == '3') && ((*(pch + 2) == 'A') || (*(pch + 1) == 'a')
86 /* Separate the toplevel key : */
92 lengths[i] = pch - pchs;
99 else if ((have_colons == 1) && (*pch == ':')) {
102 /* Separate the toplevel key : */
103 u->klen = pch - pchs;
107 lengths[i] = pch - pchs;
113 else if (pch == pche) {
116 lengths[i] = pch - pchs;
125 PutSubstructUrlKey(urlstrings, u, keys, lengths, i - 1, 0);
130 * Extract variables from the URL.
132 void ParseURLParams(StrBuf * url) {
133 const char *aptr, *bptr, *eptr, *up = NULL;
135 urlcontent *u = NULL;
138 if (WCC->Hdr->urlstrings == NULL) {
139 WCC->Hdr->urlstrings = NewHash(1, NULL);
141 eptr = ChrPtr(url) + StrLength(url);
143 while ((up < eptr) && (!IsEmptyStr(up))) {
146 while ((aptr < eptr) && (*aptr != '\0') && (*aptr != '=')) {
150 else if ((*aptr == '%') && (*(aptr + 1) == '3') && ((*(aptr + 2) == 'A') || (*(aptr + 1) == 'a')
161 while ((bptr < eptr) && (*bptr != '\0')
162 && (*bptr != '&') && (*bptr != '?') && (*bptr != ' ')) {
165 keylen = aptr - up - 1; /* -1 -> '=' */
166 if (keylen > sizeof(u->url_key)) {
167 syslog(LOG_WARNING, "%s:%d: invalid url_key of size %d in string size %ld",
168 __FILE__, __LINE__, keylen, (long) sizeof(u->url_key)
175 syslog(LOG_WARNING, "%s:%d: invalid url_key of size %d", __FILE__, __LINE__, keylen);
180 u = (urlcontent *) malloc(sizeof(urlcontent));
181 memcpy(u->url_key, up, keylen);
182 u->url_key[keylen] = '\0';
186 if (strncmp(u->url_key, "__", 2) != 0) {
188 u->url_data = NewStrBufPlain(aptr, len);
189 StrBufUnescape(u->url_data, 1);
190 #ifdef DEBUG_URLSTRINGS
191 syslog(LOG_DEBUG, "%s = [%d] %s\n", u->url_key, StrLength(u->url_data), ChrPtr(u->url_data));
193 PutUrlKey(WCC->Hdr->urlstrings, u, have_colon);
197 u->url_data = NewStrBufPlain(aptr, len);
198 StrBufUnescape(u->url_data, 1);
199 syslog(LOG_WARNING, "REJECTED because of __ is internal only: %s = [%d] %s\n",
200 u->url_key, StrLength(u->url_data), ChrPtr(u->url_data));
210 * free urlstring memory
212 void free_urls(void) {
213 DeleteHash(&WC->Hdr->urlstrings);
217 * Diagnostic function to display the contents of all variables
220 void dump_vars(void) {
228 Cursor = GetNewHashPos(WCC->Hdr->urlstrings, 0);
229 while (GetNextHashPos(WCC->Hdr->urlstrings, Cursor, &HKLen, &HKey, &U)) {
230 u = (urlcontent *) U;
231 wc_printf("%38s = %s\n", u->url_key, ChrPtr(u->url_data));
236 * Return the value of a variable supplied to the current web page (from the url or a form)
239 const char *XBstr(const char *key, size_t keylen, size_t *len) {
242 if ((WC->Hdr->urlstrings != NULL) && GetHash(WC->Hdr->urlstrings, key, keylen, &U)) {
243 *len = StrLength(((urlcontent *) U)->url_data);
244 return ChrPtr(((urlcontent *) U)->url_data);
252 const char *XBSTR(const char *key, size_t *len) {
255 if ((WC->Hdr->urlstrings != NULL) && GetHash(WC->Hdr->urlstrings, key, strlen(key), &U)) {
256 *len = StrLength(((urlcontent *) U)->url_data);
257 return ChrPtr(((urlcontent *) U)->url_data);
266 const char *BSTR(const char *key) {
269 if ((WC->Hdr->urlstrings != NULL) && GetHash(WC->Hdr->urlstrings, key, strlen(key), &U))
270 return ChrPtr(((urlcontent *) U)->url_data);
275 const char *Bstr(const char *key, size_t keylen) {
278 if ((WC->Hdr->urlstrings != NULL) && GetHash(WC->Hdr->urlstrings, key, keylen, &U))
279 return ChrPtr(((urlcontent *) U)->url_data);
284 const StrBuf *SBSTR(const char *key) {
287 if ((WC->Hdr->urlstrings != NULL) && GetHash(WC->Hdr->urlstrings, key, strlen(key), &U))
288 return ((urlcontent *) U)->url_data;
293 const StrBuf *SBstr(const char *key, size_t keylen) {
296 if ((WC->Hdr->urlstrings != NULL) && GetHash(WC->Hdr->urlstrings, key, keylen, &U))
297 return ((urlcontent *) U)->url_data;
302 long LBstr(const char *key, size_t keylen) {
305 if ((WC->Hdr->urlstrings != NULL) && GetHash(WC->Hdr->urlstrings, key, keylen, &U))
306 return StrTol(((urlcontent *) U)->url_data);
311 int IBstr(const char *key, size_t keylen) {
314 if ((WC->Hdr->urlstrings != NULL) && GetHash(WC->Hdr->urlstrings, key, keylen, &U))
315 return StrTol(((urlcontent *) U)->url_data);
320 int IBSTR(const char *key) {
323 if ((WC->Hdr->urlstrings != NULL) && GetHash(WC->Hdr->urlstrings, key, strlen(key), &U))
324 return StrToi(((urlcontent *) U)->url_data);
329 int HaveBstr(const char *key, size_t keylen) {
332 if ((WC->Hdr->urlstrings != NULL) && GetHash(WC->Hdr->urlstrings, key, keylen, &U))
333 return (StrLength(((urlcontent *) U)->url_data) != 0);
338 int YesBstr(const char *key, size_t keylen) {
341 if ((WC->Hdr->urlstrings != NULL) && GetHash(WC->Hdr->urlstrings, key, keylen, &U))
342 return strcmp(ChrPtr(((urlcontent *) U)->url_data), "yes") == 0;
347 int YESBSTR(const char *key) {
350 if ((WC->Hdr->urlstrings != NULL) && GetHash(WC->Hdr->urlstrings, key, strlen(key), &U))
351 return strcmp(ChrPtr(((urlcontent *) U)->url_data), "yes") == 0;
358 * Return a sub array that was separated by a colon:
360 HashList *getSubStruct(const char *key, size_t keylen) {
363 if ((WC->Hdr->urlstrings != NULL) && GetHash(WC->Hdr->urlstrings, key, strlen(key), &U))
364 return ((urlcontent *) U)->sub;
371 * Return the value of a variable of a substruct provided by getSubStruct
373 const char *XSubBstr(HashList * sub, const char *key, size_t keylen, size_t *len) {
376 if ((sub != NULL) && GetHash(sub, key, keylen, &U)) {
377 *len = StrLength(((urlcontent *) U)->url_data);
378 return ChrPtr(((urlcontent *) U)->url_data);
386 const char *SubBstr(HashList * sub, const char *key, size_t keylen) {
389 if ((sub != NULL) && GetHash(sub, key, keylen, &U)) {
390 return ChrPtr(((urlcontent *) U)->url_data);
396 const StrBuf *SSubBstr(HashList * sub, const char *key, size_t keylen) {
399 if ((sub != NULL) && GetHash(sub, key, keylen, &U)) {
400 return ((urlcontent *) U)->url_data;
406 long LSubBstr(HashList * sub, const char *key, size_t keylen) {
409 if ((sub != NULL) && GetHash(sub, key, keylen, &U)) {
410 return StrTol(((urlcontent *) U)->url_data);
416 int ISubBstr(HashList * sub, const char *key, size_t keylen) {
419 if ((sub != NULL) && GetHash(sub, key, keylen, &U)) {
420 return StrTol(((urlcontent *) U)->url_data);
426 int HaveSubBstr(HashList * sub, const char *key, size_t keylen) {
429 if ((sub != NULL) && GetHash(sub, key, keylen, &U)) {
430 return (StrLength(((urlcontent *) U)->url_data) != 0);
436 int YesSubBstr(HashList * sub, const char *key, size_t keylen) {
439 if ((sub != NULL) && GetHash(sub, key, keylen, &U)) {
440 return strcmp(ChrPtr(((urlcontent *) U)->url_data), "yes") == 0;
448 * This function is called by the MIME parser to handle data uploaded by
449 * the browser. Form data, uploaded files, and the data from HTTP PUT
450 * operations (such as those found in GroupDAV) all arrive this way.
452 * name Name of the item being uploaded
453 * filename Filename of the item being uploaded
454 * partnum MIME part identifier (not needed)
455 * disp MIME content disposition (not needed)
456 * content The actual data
457 * cbtype MIME content-type
458 * cbcharset Character set
459 * length Content length
460 * encoding MIME encoding type (not needed)
461 * cbid Content ID (not needed)
462 * userdata Not used here
464 void upload_handler(char *name, char *filename, char *partnum, char *disp,
465 void *content, char *cbtype, char *cbcharset, size_t length, char *encoding, char *cbid, void *userdata) {
470 #ifdef DEBUG_URLSTRINGS
471 syslog(LOG_DEBUG, "upload_handler() name=%s, type=%s, len=" SIZE_T_FMT, name, cbtype, length);
473 if (WCC->Hdr->urlstrings == NULL)
474 WCC->Hdr->urlstrings = NewHash(1, NULL);
477 if ((length > 0) && (IsEmptyStr(cbtype))) {
478 u = (urlcontent *) malloc(sizeof(urlcontent));
480 keylen = safestrncpy(u->url_key, name, sizeof(u->url_key));
481 u->url_data = NewStrBufPlain(content, length);
485 if (strncmp(u->url_key, "__", 2) != 0) {
486 PutUrlKey(WCC->Hdr->urlstrings, u, (strchr(u->url_key, ':') != NULL));
489 syslog(LOG_INFO, "REJECTED because of __ is internal only: %s = [%d] %s\n",
490 u->url_key, StrLength(u->url_data), ChrPtr(u->url_data));
494 #ifdef DEBUG_URLSTRINGS
495 syslog(LOG_DEBUG, "Key: <%s> len: [%d] Data: <%s>", u->url_key, StrLength(u->url_data), ChrPtr(u->url_data));
500 if ((length > 0) && (!IsEmptyStr(cbtype))) {
501 WCC->upload = NewStrBufPlain(content, length);
502 WCC->upload_length = length;
503 WCC->upload_filename = NewStrBufPlain(filename, -1);
504 safestrncpy(WCC->upload_content_type, cbtype, sizeof(WC->upload_content_type));
505 #ifdef DEBUG_URLSTRINGS
506 syslog(LOG_DEBUG, "File: <%s> len: [%ld]", filename, (long int) length);
513 void PutBstr(const char *key, long keylen, StrBuf * Value) {
516 if (keylen >= sizeof(u->url_key)) {
517 syslog(LOG_WARNING, "%s:%d: invalid url_key of size %ld", __FILE__, __LINE__, keylen);
521 u = (urlcontent *) malloc(sizeof(urlcontent));
522 memcpy(u->url_key, key, keylen + 1);
526 Put(WC->Hdr->urlstrings, u->url_key, keylen, u, free_url);
528 void PutlBstr(const char *key, long keylen, long Value) {
531 Buf = NewStrBufPlain(NULL, sizeof(long) * 16);
532 StrBufPrintf(Buf, "%ld", Value);
533 PutBstr(key, keylen, Buf);
538 int ConditionalBstr(StrBuf * Target, WCTemplputParams * TP) {
539 if (TP->Tokens->nParameters == 3)
540 return HaveBstr(TKEY(2));
542 if (IS_NUMBER(TP->Tokens->Params[3]->Type)) {
543 return LBstr(TKEY(2)) == GetTemplateTokenNumber(Target, TP, 3, 0);
549 GetTemplateTokenString(Target, TP, 3, &pch, &len);
550 return strcmp(Bstr(TKEY(2)), pch) == 0;
555 void tmplput_bstr(StrBuf * Target, WCTemplputParams * TP) {
556 const StrBuf *Buf = SBstr(TKEY(0));
558 StrBufAppendTemplate(Target, TP, Buf, 1);
562 void tmplput_bstrforward(StrBuf * Target, WCTemplputParams * TP) {
563 const StrBuf *Buf = SBstr(TKEY(0));
565 StrBufAppendBufPlain(Target, HKEY("?"), 0);
566 StrBufAppendBufPlain(Target, TKEY(0), 0);
567 StrBufAppendBufPlain(Target, HKEY("="), 0);
568 StrBufAppendTemplate(Target, TP, Buf, 1);
572 void diagnostics(void) {
573 output_headers(1, 1, 1, 0, 0, 0);
574 wc_printf("Session: %d<hr />\n", WC->wc_session);
575 wc_printf("Command: <br><PRE>\n");
578 StrEscAppend(WC->WBuf, NULL, WC->UrlFragment1, 0, 0);
580 StrEscAppend(WC->WBuf, NULL, WC->UrlFragment12 0, 0);
582 StrEscAppend(WC->WBuf, NULL, WC->UrlFragment3, 0, 0);
584 wc_printf("</PRE><hr />\n");
585 wc_printf("Variables: <br><PRE>\n");
587 wc_printf("</PRE><hr />\n");
592 void tmplput_url_part(StrBuf * Target, WCTemplputParams * TP) {
594 StrBuf *UrlBuf = NULL;
600 n = GetTemplateTokenNumber(Target, TP, 0, 0);
602 if (WCC->Hdr->HR.Handler != NULL)
603 UrlBuf = Name = WCC->Hdr->HR.Handler->Name;
606 UrlBuf = NewStrBuf();
607 StrBufExtract_token(UrlBuf, WCC->Hdr->HR.ReqLine, 0, '/');
610 UrlBuf = NewStrBuf();
611 StrBufExtract_token(UrlBuf, WCC->Hdr->HR.ReqLine, 1, '/');
614 if (UrlBuf == NULL) {
615 LogTemplateError(Target, "urlbuf", ERR_PARM1, TP, "not set.");
617 StrBufAppendTemplate(Target, TP, UrlBuf, 2);
623 typedef struct __BstrPair {
627 CtxType CTX_BSTRPAIRS = CTX_NONE;
628 void HFreeBstrPair(void *pv) {
629 BstrPair *p = (BstrPair *) pv;
635 HashList *iterate_GetBstrPairs(StrBuf * Target, WCTemplputParams * TP) {
637 const char *ch = NULL;
639 const StrBuf *TheBStr;
642 const char *Pos = NULL;
645 if (HaveTemplateTokenString(NULL, TP, 2, &ch, &len)) {
646 GetTemplateTokenString(Target, TP, 2, &ch, &len);
652 TheBStr = SBstr(ch, len);
653 if ((TheBStr == NULL) || (StrLength(TheBStr) == 0))
655 List = NewHash(1, NULL);
656 while (Pos != StrBufNOTNULL) {
657 X = NewStrBufPlain(NULL, StrLength(TheBStr));
658 StrBufExtract_NextToken(X, TheBStr, &Pos, '|');
659 if (Pos == StrBufNOTNULL) {
664 Y = NewStrBufPlain(NULL, StrLength(TheBStr));
665 StrBufExtract_NextToken(Y, TheBStr, &Pos, '|');
666 OnePair = (BstrPair *) malloc(sizeof(BstrPair));
669 Put(List, IKEY(i), OnePair, HFreeBstrPair);
676 void tmplput_bstr_pair(StrBuf * Target, WCTemplputParams * TP, int XY) {
677 BstrPair *Pair = (BstrPair *) CTX(CTX_BSTRPAIRS);
679 StrBufAppendTemplate(Target, TP, (XY) ? Pair->y : Pair->x, 0);
682 void tmplput_bstr_pair_x(StrBuf * Target, WCTemplputParams * TP) {
683 tmplput_bstr_pair(Target, TP, 0);
685 void tmplput_bstr_pair_y(StrBuf * Target, WCTemplputParams * TP) {
686 tmplput_bstr_pair(Target, TP, 1);
689 void InitModule_PARAMHANDLING(void) {
690 RegisterCTX(CTX_BSTRPAIRS);
691 WebcitAddUrlHandler(HKEY("diagnostics"), "", 0, diagnostics, NEED_URL);
693 RegisterIterator("ITERATE:BSTR:PAIR", 1, NULL, iterate_GetBstrPairs, NULL, DeleteHash, CTX_BSTRPAIRS, CTX_NONE, IT_NOFLAG);
694 RegisterNamespace("BSTR:PAIR:X", 1, 2, tmplput_bstr_pair_x, NULL, CTX_BSTRPAIRS);
695 RegisterNamespace("BSTR:PAIR:Y", 1, 2, tmplput_bstr_pair_y, NULL, CTX_BSTRPAIRS);
697 RegisterConditional("COND:BSTR", 1, ConditionalBstr, CTX_NONE);
698 RegisterNamespace("BSTR", 1, 2, tmplput_bstr, NULL, CTX_NONE);
699 RegisterNamespace("BSTR:FORWARD", 1, 2, tmplput_bstrforward, NULL, CTX_NONE);
700 RegisterNamespace("URLPART", 1, 2, tmplput_url_part, NULL, CTX_NONE);
704 void SessionAttachModule_PARAMHANDLING(wcsession * sess) {
705 sess->Hdr->urlstrings = NewHash(1, NULL);
708 void SessionDetachModule_PARAMHANDLING(wcsession * sess) {
709 DeleteHash(&sess->Hdr->urlstrings);
710 FreeStrBuf(&sess->upload_filename);