2 * parse urlparts and post data
4 * Copyright (c) 1996-2019 by the citadel.org team
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.
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.
16 #include "webserver.h"
18 /* uncomment to see all parameters sent to the server by the browser. */
19 /* #define DEBUG_URLSTRINGS */
22 void free_url(void *U)
24 urlcontent *u = (urlcontent*) U;
25 FreeStrBuf(&u->url_data);
32 void PutSubstructUrlKey(HashList *list, urlcontent *u, char **keys, long *lengths, int max, int which){
35 HashList *thisList = list;
36 if (GetHash(list, keys[which], lengths[which], &vUrl) &&
39 subu = (urlcontent*) vUrl;
40 if (subu->sub == NULL) {
41 subu->sub = NewHash(1, NULL);
45 else if (which < max) {
46 subu = (urlcontent *) malloc(sizeof(urlcontent));
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);
53 Put(list, subu->url_key, subu->klen, subu, free_url);
57 Put(thisList, keys[which], lengths[which], u, free_url);
60 PutSubstructUrlKey(subu->sub, u, keys, lengths, max, which + 1);
64 void PutUrlKey(HashList *urlstrings, urlcontent *u, int have_colons) {
65 if (have_colons == 0) {
66 Put(urlstrings, u->url_key, u->klen, u, free_url);
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 ((have_colons == 2) &&
83 (*(pch + 1) == '3') &&
84 ((*(pch + 2) == 'A') ||
91 /* Separate the toplevel key : */
97 lengths[i] = pch - pchs;
104 else if ((have_colons == 1) &&
108 /* Separate the toplevel key : */
109 u->klen = pch - pchs;
113 lengths[i] = pch - pchs;
119 else if (pch == pche){
122 lengths[i] = pch - pchs;
131 PutSubstructUrlKey(urlstrings, u, keys, lengths, i - 1, 0);
136 * Extract variables from the URL.
138 void ParseURLParams(StrBuf *url)
140 const char *aptr, *bptr, *eptr, *up = NULL;
142 urlcontent *u = NULL;
145 if (WCC->Hdr->urlstrings == NULL) {
146 WCC->Hdr->urlstrings = NewHash(1, NULL);
148 eptr = ChrPtr(url) + StrLength(url);
150 while ((up < eptr) && (!IsEmptyStr(up))) {
153 while ((aptr < eptr) && (*aptr != '\0') && (*aptr != '=')) {
157 else if ((*aptr == '%') &&
158 (*(aptr + 1) == '3') &&
159 ((*(aptr + 2) == 'A') ||
172 while ((bptr < eptr) && (*bptr != '\0')
173 && (*bptr != '&') && (*bptr != '?') && (*bptr != ' ')) {
176 keylen = aptr - up - 1; /* -1 -> '=' */
177 if (keylen > sizeof(u->url_key)) {
178 syslog(LOG_WARNING, "%s:%d: invalid url_key of size %d in string size %ld",
179 __FILE__, __LINE__, keylen, (long)sizeof(u->url_key)
186 syslog(LOG_WARNING, "%s:%d: invalid url_key of size %d", __FILE__, __LINE__, keylen);
191 u = (urlcontent *) malloc(sizeof(urlcontent));
192 memcpy(u->url_key, up, keylen);
193 u->url_key[keylen] = '\0';
197 if (strncmp(u->url_key, "__", 2) != 0)
200 u->url_data = NewStrBufPlain(aptr, len);
201 StrBufUnescape(u->url_data, 1);
202 #ifdef DEBUG_URLSTRINGS
203 syslog(LOG_DEBUG, "%s = [%d] %s\n",
205 StrLength(u->url_data),
206 ChrPtr(u->url_data));
208 PutUrlKey(WCC->Hdr->urlstrings, u, have_colon);
212 u->url_data = NewStrBufPlain(aptr, len);
213 StrBufUnescape(u->url_data, 1);
214 syslog(LOG_WARNING, "REJECTED because of __ is internal only: %s = [%d] %s\n",
216 StrLength(u->url_data),
217 ChrPtr(u->url_data));
227 * free urlstring memory
231 DeleteHash(&WC->Hdr->urlstrings);
235 * Diagnostic function to display the contents of all variables
247 Cursor = GetNewHashPos (WCC->Hdr->urlstrings, 0);
248 while (GetNextHashPos(WCC->Hdr->urlstrings, Cursor, &HKLen, &HKey, &U)) {
250 wc_printf("%38s = %s\n", u->url_key, ChrPtr(u->url_data));
255 * Return the value of a variable supplied to the current web page (from the url or a form)
258 const char *XBstr(const char *key, size_t keylen, size_t *len)
262 if ((WC->Hdr->urlstrings != NULL) &&
263 GetHash(WC->Hdr->urlstrings, key, keylen, &U)) {
264 *len = StrLength(((urlcontent *)U)->url_data);
265 return ChrPtr(((urlcontent *)U)->url_data);
273 const char *XBSTR(const char *key, size_t *len)
277 if ((WC->Hdr->urlstrings != NULL) &&
278 GetHash(WC->Hdr->urlstrings, key, strlen (key), &U)){
279 *len = StrLength(((urlcontent *)U)->url_data);
280 return ChrPtr(((urlcontent *)U)->url_data);
289 const char *BSTR(const char *key)
293 if ((WC->Hdr->urlstrings != NULL) &&
294 GetHash(WC->Hdr->urlstrings, key, strlen (key), &U))
295 return ChrPtr(((urlcontent *)U)->url_data);
300 const char *Bstr(const char *key, size_t keylen)
304 if ((WC->Hdr->urlstrings != NULL) &&
305 GetHash(WC->Hdr->urlstrings, key, keylen, &U))
306 return ChrPtr(((urlcontent *)U)->url_data);
311 const StrBuf *SBSTR(const char *key)
315 if ((WC->Hdr->urlstrings != NULL) &&
316 GetHash(WC->Hdr->urlstrings, key, strlen (key), &U))
317 return ((urlcontent *)U)->url_data;
322 const StrBuf *SBstr(const char *key, size_t keylen)
326 if ((WC->Hdr->urlstrings != NULL) &&
327 GetHash(WC->Hdr->urlstrings, key, keylen, &U))
328 return ((urlcontent *)U)->url_data;
333 long LBstr(const char *key, size_t keylen)
337 if ((WC->Hdr->urlstrings != NULL) &&
338 GetHash(WC->Hdr->urlstrings, key, keylen, &U))
339 return StrTol(((urlcontent *)U)->url_data);
344 int IBstr(const char *key, size_t keylen)
348 if ((WC->Hdr->urlstrings != NULL) &&
349 GetHash(WC->Hdr->urlstrings, key, keylen, &U))
350 return StrTol(((urlcontent *)U)->url_data);
355 int IBSTR(const char *key)
359 if ((WC->Hdr->urlstrings != NULL) &&
360 GetHash(WC->Hdr->urlstrings, key, strlen(key), &U))
361 return StrToi(((urlcontent *)U)->url_data);
366 int HaveBstr(const char *key, size_t keylen)
370 if ((WC->Hdr->urlstrings != NULL) &&
371 GetHash(WC->Hdr->urlstrings, key, keylen, &U))
372 return (StrLength(((urlcontent *)U)->url_data) != 0);
377 int YesBstr(const char *key, size_t keylen)
381 if ((WC->Hdr->urlstrings != NULL) &&
382 GetHash(WC->Hdr->urlstrings, key, keylen, &U))
383 return strcmp( ChrPtr(((urlcontent *)U)->url_data), "yes") == 0;
388 int YESBSTR(const char *key)
392 if ((WC->Hdr->urlstrings != NULL) &&
393 GetHash(WC->Hdr->urlstrings, key, strlen(key), &U))
394 return strcmp( ChrPtr(((urlcontent *)U)->url_data), "yes") == 0;
401 * Return a sub array that was separated by a colon:
403 HashList* getSubStruct(const char *key, size_t keylen)
407 if ((WC->Hdr->urlstrings != NULL) &&
408 GetHash(WC->Hdr->urlstrings, key, strlen(key), &U))
409 return ((urlcontent *)U)->sub;
416 * Return the value of a variable of a substruct provided by getSubStruct
418 const char *XSubBstr(HashList *sub, const char *key, size_t keylen, size_t *len)
423 GetHash(sub, key, keylen, &U)) {
424 *len = StrLength(((urlcontent *)U)->url_data);
425 return ChrPtr(((urlcontent *)U)->url_data);
433 const char *SubBstr(HashList *sub, const char *key, size_t keylen)
438 GetHash(sub, key, keylen, &U)) {
439 return ChrPtr(((urlcontent *)U)->url_data);
445 const StrBuf *SSubBstr(HashList *sub, const char *key, size_t keylen)
450 GetHash(sub, key, keylen, &U)) {
451 return ((urlcontent *)U)->url_data;
457 long LSubBstr(HashList *sub, const char *key, size_t keylen)
462 GetHash(sub, key, keylen, &U)) {
463 return StrTol(((urlcontent *)U)->url_data);
469 int ISubBstr(HashList *sub, const char *key, size_t keylen)
474 GetHash(sub, key, keylen, &U)) {
475 return StrTol(((urlcontent *)U)->url_data);
481 int HaveSubBstr(HashList *sub, const char *key, size_t keylen)
486 GetHash(sub, key, keylen, &U)) {
487 return (StrLength(((urlcontent *)U)->url_data) != 0);
493 int YesSubBstr(HashList *sub, const char *key, size_t keylen)
498 GetHash(sub, key, keylen, &U)) {
499 return strcmp( ChrPtr(((urlcontent *)U)->url_data), "yes") == 0;
507 * This function is called by the MIME parser to handle data uploaded by
508 * the browser. Form data, uploaded files, and the data from HTTP PUT
509 * operations (such as those found in GroupDAV) all arrive this way.
511 * name Name of the item being uploaded
512 * filename Filename of the item being uploaded
513 * partnum MIME part identifier (not needed)
514 * disp MIME content disposition (not needed)
515 * content The actual data
516 * cbtype MIME content-type
517 * cbcharset Character set
518 * length Content length
519 * encoding MIME encoding type (not needed)
520 * cbid Content ID (not needed)
521 * userdata Not used here
523 void upload_handler(char *name, char *filename, char *partnum, char *disp,
524 void *content, char *cbtype, char *cbcharset,
525 size_t length, char *encoding, char *cbid, void *userdata)
531 #ifdef DEBUG_URLSTRINGS
532 syslog(LOG_DEBUG, "upload_handler() name=%s, type=%s, len="SIZE_T_FMT, name, cbtype, length);
534 if (WCC->Hdr->urlstrings == NULL)
535 WCC->Hdr->urlstrings = NewHash(1, NULL);
538 if ( (length > 0) && (IsEmptyStr(cbtype)) ) {
539 u = (urlcontent *) malloc(sizeof(urlcontent));
541 keylen = safestrncpy(u->url_key, name, sizeof(u->url_key));
542 u->url_data = NewStrBufPlain(content, length);
546 if (strncmp(u->url_key, "__", 2) != 0)
548 PutUrlKey(WCC->Hdr->urlstrings, u, (strchr(u->url_key, ':') != NULL));
551 syslog(LOG_INFO, "REJECTED because of __ is internal only: %s = [%d] %s\n",
553 StrLength(u->url_data),
554 ChrPtr(u->url_data));
558 #ifdef DEBUG_URLSTRINGS
559 syslog(LOG_DEBUG, "Key: <%s> len: [%d] Data: <%s>",
561 StrLength(u->url_data),
562 ChrPtr(u->url_data));
567 if ( (length > 0) && (!IsEmptyStr(cbtype)) ) {
568 WCC->upload = NewStrBufPlain(content, length);
569 WCC->upload_length = length;
570 WCC->upload_filename = NewStrBufPlain(filename, -1);
571 safestrncpy(WCC->upload_content_type, cbtype, sizeof(WC->upload_content_type));
572 #ifdef DEBUG_URLSTRINGS
573 syslog(LOG_DEBUG, "File: <%s> len: [%ld]", filename, (long int)length);
580 void PutBstr(const char *key, long keylen, StrBuf *Value)
584 if(keylen >= sizeof(u->url_key)) {
585 syslog(LOG_WARNING, "%s:%d: invalid url_key of size %ld", __FILE__, __LINE__, keylen);
589 u = (urlcontent*)malloc(sizeof(urlcontent));
590 memcpy(u->url_key, key, keylen + 1);
594 Put(WC->Hdr->urlstrings, u->url_key, keylen, u, free_url);
596 void PutlBstr(const char *key, long keylen, long Value)
600 Buf = NewStrBufPlain(NULL, sizeof(long) * 16);
601 StrBufPrintf(Buf, "%ld", Value);
602 PutBstr(key, keylen, Buf);
607 int ConditionalBstr(StrBuf *Target, WCTemplputParams *TP)
609 if(TP->Tokens->nParameters == 3)
610 return HaveBstr(TKEY(2));
612 if (IS_NUMBER(TP->Tokens->Params[3]->Type))
614 return LBstr(TKEY(2)) ==
615 GetTemplateTokenNumber(Target,
624 GetTemplateTokenString (Target, TP, 3, &pch, &len);
625 return strcmp(Bstr(TKEY(2)), pch) == 0;
630 void tmplput_bstr(StrBuf *Target, WCTemplputParams *TP)
632 const StrBuf *Buf = SBstr(TKEY(0));
634 StrBufAppendTemplate(Target, TP, Buf, 1);
638 void tmplput_bstrforward(StrBuf *Target, WCTemplputParams *TP)
640 const StrBuf *Buf = SBstr(TKEY(0));
642 StrBufAppendBufPlain(Target, HKEY("?"), 0);
643 StrBufAppendBufPlain(Target, TKEY(0), 0);
644 StrBufAppendBufPlain(Target, HKEY("="), 0);
645 StrBufAppendTemplate(Target, TP, Buf, 1);
649 void diagnostics(void)
651 output_headers(1, 1, 1, 0, 0, 0);
652 wc_printf("Session: %d<hr />\n", WC->wc_session);
653 wc_printf("Command: <br><PRE>\n");
655 StrEscAppend(WC->WBuf, NULL, WC->UrlFragment1, 0, 0);
657 StrEscAppend(WC->WBuf, NULL, WC->UrlFragment12 0, 0);
659 StrEscAppend(WC->WBuf, NULL, WC->UrlFragment3, 0, 0);
661 wc_printf("</PRE><hr />\n");
662 wc_printf("Variables: <br><PRE>\n");
664 wc_printf("</PRE><hr />\n");
669 void tmplput_url_part(StrBuf *Target, WCTemplputParams *TP)
672 StrBuf *UrlBuf = NULL;
678 n = GetTemplateTokenNumber(Target, TP, 0, 0);
680 if (WCC->Hdr->HR.Handler != NULL)
681 UrlBuf = Name = WCC->Hdr->HR.Handler->Name;
684 UrlBuf = NewStrBuf();
685 StrBufExtract_token(UrlBuf, WCC->Hdr->HR.ReqLine, 0, '/');
688 UrlBuf = NewStrBuf();
689 StrBufExtract_token(UrlBuf, WCC->Hdr->HR.ReqLine, 1, '/');
692 if (UrlBuf == NULL) {
693 LogTemplateError(Target, "urlbuf", ERR_PARM1, TP, "not set.");
695 StrBufAppendTemplate(Target, TP, UrlBuf, 2);
696 if (Name == NULL) FreeStrBuf(&UrlBuf);
700 typedef struct __BstrPair {
704 CtxType CTX_BSTRPAIRS = CTX_NONE;
705 void HFreeBstrPair(void *pv)
707 BstrPair *p = (BstrPair*) pv;
713 HashList *iterate_GetBstrPairs(StrBuf *Target, WCTemplputParams *TP)
716 const char *ch = NULL;
718 const StrBuf *TheBStr;
721 const char *Pos = NULL;
724 if (HaveTemplateTokenString(NULL, TP, 2, &ch, &len))
726 GetTemplateTokenString(Target, TP, 2, &ch, &len);
733 TheBStr = SBstr(ch, len);
734 if ((TheBStr == NULL) || (StrLength(TheBStr) == 0))
736 List = NewHash(1, NULL);
737 while (Pos != StrBufNOTNULL)
739 X = NewStrBufPlain(NULL, StrLength(TheBStr));
740 StrBufExtract_NextToken(X, TheBStr, &Pos, '|');
741 if (Pos == StrBufNOTNULL) {
746 Y = NewStrBufPlain(NULL, StrLength(TheBStr));
747 StrBufExtract_NextToken(Y, TheBStr, &Pos, '|');
748 OnePair = (BstrPair*)malloc(sizeof(BstrPair));
751 Put(List, IKEY(i), OnePair, HFreeBstrPair);
758 void tmplput_bstr_pair(StrBuf *Target, WCTemplputParams *TP, int XY)
760 BstrPair *Pair = (BstrPair*) CTX(CTX_BSTRPAIRS);
762 StrBufAppendTemplate(Target, TP, (XY)?Pair->y:Pair->x, 0);
765 void tmplput_bstr_pair_x(StrBuf *Target, WCTemplputParams *TP)
766 { tmplput_bstr_pair(Target, TP, 0); }
767 void tmplput_bstr_pair_y(StrBuf *Target, WCTemplputParams *TP)
768 { tmplput_bstr_pair(Target, TP, 1); }
771 InitModule_PARAMHANDLING
774 RegisterCTX(CTX_BSTRPAIRS);
775 WebcitAddUrlHandler(HKEY("diagnostics"), "", 0, diagnostics, NEED_URL);
777 RegisterIterator("ITERATE:BSTR:PAIR", 1, NULL, iterate_GetBstrPairs, NULL, DeleteHash, CTX_BSTRPAIRS, CTX_NONE, IT_NOFLAG);
778 RegisterNamespace("BSTR:PAIR:X", 1, 2, tmplput_bstr_pair_x, NULL, CTX_BSTRPAIRS);
779 RegisterNamespace("BSTR:PAIR:Y", 1, 2, tmplput_bstr_pair_y, NULL, CTX_BSTRPAIRS);
781 RegisterConditional("COND:BSTR", 1, ConditionalBstr, CTX_NONE);
782 RegisterNamespace("BSTR", 1, 2, tmplput_bstr, NULL, CTX_NONE);
783 RegisterNamespace("BSTR:FORWARD", 1, 2, tmplput_bstrforward, NULL, CTX_NONE);
784 RegisterNamespace("URLPART", 1, 2, tmplput_url_part, NULL, CTX_NONE);
789 SessionAttachModule_PARAMHANDLING
792 sess->Hdr->urlstrings = NewHash(1,NULL);
796 SessionDetachModule_PARAMHANDLING
799 DeleteHash(&sess->Hdr->urlstrings);
800 FreeStrBuf(&sess->upload_filename);