2 * parse urlparts and post data
4 * Copyright (c) 1996-2013 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, sizeof(u->url_key)
184 syslog(LOG_WARNING, "%s:%d: invalid url_key of size %d", __FILE__, __LINE__, keylen);
189 u = (urlcontent *) malloc(sizeof(urlcontent));
190 memcpy(u->url_key, up, keylen);
191 u->url_key[keylen] = '\0';
195 if (strncmp(u->url_key, "__", 2) != 0)
198 u->url_data = NewStrBufPlain(aptr, len);
199 StrBufUnescape(u->url_data, 1);
200 #ifdef DEBUG_URLSTRINGS
201 syslog(LOG_DEBUG, "%s = [%d] %s\n",
203 StrLength(u->url_data),
204 ChrPtr(u->url_data));
206 PutUrlKey(WCC->Hdr->urlstrings, u, have_colon);
210 u->url_data = NewStrBufPlain(aptr, len);
211 StrBufUnescape(u->url_data, 1);
212 syslog(LOG_WARNING, "REJECTED because of __ is internal only: %s = [%d] %s\n",
214 StrLength(u->url_data),
215 ChrPtr(u->url_data));
225 * free urlstring memory
229 DeleteHash(&WC->Hdr->urlstrings);
233 * Diagnostic function to display the contents of all variables
245 Cursor = GetNewHashPos (WCC->Hdr->urlstrings, 0);
246 while (GetNextHashPos(WCC->Hdr->urlstrings, Cursor, &HKLen, &HKey, &U)) {
248 wc_printf("%38s = %s\n", u->url_key, ChrPtr(u->url_data));
253 * Return the value of a variable supplied to the current web page (from the url or a form)
256 const char *XBstr(const char *key, size_t keylen, size_t *len)
260 if ((WC->Hdr->urlstrings != NULL) &&
261 GetHash(WC->Hdr->urlstrings, key, keylen, &U)) {
262 *len = StrLength(((urlcontent *)U)->url_data);
263 return ChrPtr(((urlcontent *)U)->url_data);
271 const char *XBSTR(const char *key, size_t *len)
275 if ((WC->Hdr->urlstrings != NULL) &&
276 GetHash(WC->Hdr->urlstrings, key, strlen (key), &U)){
277 *len = StrLength(((urlcontent *)U)->url_data);
278 return ChrPtr(((urlcontent *)U)->url_data);
287 const char *BSTR(const char *key)
291 if ((WC->Hdr->urlstrings != NULL) &&
292 GetHash(WC->Hdr->urlstrings, key, strlen (key), &U))
293 return ChrPtr(((urlcontent *)U)->url_data);
298 const char *Bstr(const char *key, size_t keylen)
302 if ((WC->Hdr->urlstrings != NULL) &&
303 GetHash(WC->Hdr->urlstrings, key, keylen, &U))
304 return ChrPtr(((urlcontent *)U)->url_data);
309 const StrBuf *SBSTR(const char *key)
313 if ((WC->Hdr->urlstrings != NULL) &&
314 GetHash(WC->Hdr->urlstrings, key, strlen (key), &U))
315 return ((urlcontent *)U)->url_data;
320 const StrBuf *SBstr(const char *key, size_t keylen)
324 if ((WC->Hdr->urlstrings != NULL) &&
325 GetHash(WC->Hdr->urlstrings, key, keylen, &U))
326 return ((urlcontent *)U)->url_data;
331 long LBstr(const char *key, size_t keylen)
335 if ((WC->Hdr->urlstrings != NULL) &&
336 GetHash(WC->Hdr->urlstrings, key, keylen, &U))
337 return StrTol(((urlcontent *)U)->url_data);
342 int IBstr(const char *key, size_t keylen)
346 if ((WC->Hdr->urlstrings != NULL) &&
347 GetHash(WC->Hdr->urlstrings, key, keylen, &U))
348 return StrTol(((urlcontent *)U)->url_data);
353 int IBSTR(const char *key)
357 if ((WC->Hdr->urlstrings != NULL) &&
358 GetHash(WC->Hdr->urlstrings, key, strlen(key), &U))
359 return StrToi(((urlcontent *)U)->url_data);
364 int HaveBstr(const char *key, size_t keylen)
368 if ((WC->Hdr->urlstrings != NULL) &&
369 GetHash(WC->Hdr->urlstrings, key, keylen, &U))
370 return (StrLength(((urlcontent *)U)->url_data) != 0);
375 int YesBstr(const char *key, size_t keylen)
379 if ((WC->Hdr->urlstrings != NULL) &&
380 GetHash(WC->Hdr->urlstrings, key, keylen, &U))
381 return strcmp( ChrPtr(((urlcontent *)U)->url_data), "yes") == 0;
386 int YESBSTR(const char *key)
390 if ((WC->Hdr->urlstrings != NULL) &&
391 GetHash(WC->Hdr->urlstrings, key, strlen(key), &U))
392 return strcmp( ChrPtr(((urlcontent *)U)->url_data), "yes") == 0;
399 * Return a sub array that was separated by a colon:
401 HashList* getSubStruct(const char *key, size_t keylen)
405 if ((WC->Hdr->urlstrings != NULL) &&
406 GetHash(WC->Hdr->urlstrings, key, strlen(key), &U))
407 return ((urlcontent *)U)->sub;
414 * Return the value of a variable of a substruct provided by getSubStruct
416 const char *XSubBstr(HashList *sub, const char *key, size_t keylen, size_t *len)
421 GetHash(sub, key, keylen, &U)) {
422 *len = StrLength(((urlcontent *)U)->url_data);
423 return ChrPtr(((urlcontent *)U)->url_data);
431 const char *SubBstr(HashList *sub, const char *key, size_t keylen)
436 GetHash(sub, key, keylen, &U)) {
437 return ChrPtr(((urlcontent *)U)->url_data);
443 const StrBuf *SSubBstr(HashList *sub, const char *key, size_t keylen)
448 GetHash(sub, key, keylen, &U)) {
449 return ((urlcontent *)U)->url_data;
455 long LSubBstr(HashList *sub, const char *key, size_t keylen)
460 GetHash(sub, key, keylen, &U)) {
461 return StrTol(((urlcontent *)U)->url_data);
467 int ISubBstr(HashList *sub, const char *key, size_t keylen)
472 GetHash(sub, key, keylen, &U)) {
473 return StrTol(((urlcontent *)U)->url_data);
479 int HaveSubBstr(HashList *sub, const char *key, size_t keylen)
484 GetHash(sub, key, keylen, &U)) {
485 return (StrLength(((urlcontent *)U)->url_data) != 0);
491 int YesSubBstr(HashList *sub, const char *key, size_t keylen)
496 GetHash(sub, key, keylen, &U)) {
497 return strcmp( ChrPtr(((urlcontent *)U)->url_data), "yes") == 0;
505 * This function is called by the MIME parser to handle data uploaded by
506 * the browser. Form data, uploaded files, and the data from HTTP PUT
507 * operations (such as those found in GroupDAV) all arrive this way.
509 * name Name of the item being uploaded
510 * filename Filename of the item being uploaded
511 * partnum MIME part identifier (not needed)
512 * disp MIME content disposition (not needed)
513 * content The actual data
514 * cbtype MIME content-type
515 * cbcharset Character set
516 * length Content length
517 * encoding MIME encoding type (not needed)
518 * cbid Content ID (not needed)
519 * userdata Not used here
521 void upload_handler(char *name, char *filename, char *partnum, char *disp,
522 void *content, char *cbtype, char *cbcharset,
523 size_t length, char *encoding, char *cbid, void *userdata)
529 #ifdef DEBUG_URLSTRINGS
530 syslog(LOG_DEBUG, "upload_handler() name=%s, type=%s, len="SIZE_T_FMT, name, cbtype, length);
532 if (WCC->Hdr->urlstrings == NULL)
533 WCC->Hdr->urlstrings = NewHash(1, NULL);
536 if ( (length > 0) && (IsEmptyStr(cbtype)) ) {
537 u = (urlcontent *) malloc(sizeof(urlcontent));
539 keylen = safestrncpy(u->url_key, name, sizeof(u->url_key));
540 u->url_data = NewStrBufPlain(content, length);
544 if (strncmp(u->url_key, "__", 2) != 0)
546 PutUrlKey(WCC->Hdr->urlstrings, u, (strchr(u->url_key, ':') != NULL));
549 syslog(LOG_INFO, "REJECTED because of __ is internal only: %s = [%d] %s\n",
551 StrLength(u->url_data),
552 ChrPtr(u->url_data));
556 #ifdef DEBUG_URLSTRINGS
557 syslog(LOG_DEBUG, "Key: <%s> len: [%d] Data: <%s>",
559 StrLength(u->url_data),
560 ChrPtr(u->url_data));
565 if ( (length > 0) && (!IsEmptyStr(cbtype)) ) {
566 WCC->upload = NewStrBufPlain(content, length);
567 WCC->upload_length = length;
568 WCC->upload_filename = NewStrBufPlain(filename, -1);
569 safestrncpy(WCC->upload_content_type, cbtype, sizeof(WC->upload_content_type));
570 #ifdef DEBUG_URLSTRINGS
571 syslog(LOG_DEBUG, "File: <%s> len: [%ld]", filename, (long int)length);
578 void PutBstr(const char *key, long keylen, StrBuf *Value)
582 if(keylen >= sizeof(u->url_key)) {
583 syslog(LOG_WARNING, "%s:%d: invalid url_key of size %ld", __FILE__, __LINE__, keylen);
587 u = (urlcontent*)malloc(sizeof(urlcontent));
588 memcpy(u->url_key, key, keylen + 1);
592 Put(WC->Hdr->urlstrings, u->url_key, keylen, u, free_url);
594 void PutlBstr(const char *key, long keylen, long Value)
598 Buf = NewStrBufPlain(NULL, sizeof(long) * 16);
599 StrBufPrintf(Buf, "%ld", Value);
600 PutBstr(key, keylen, Buf);
605 int ConditionalBstr(StrBuf *Target, WCTemplputParams *TP)
607 if(TP->Tokens->nParameters == 3)
608 return HaveBstr(TKEY(2));
610 if (IS_NUMBER(TP->Tokens->Params[3]->Type))
612 return LBstr(TKEY(2)) ==
613 GetTemplateTokenNumber(Target,
622 GetTemplateTokenString (Target, TP, 3, &pch, &len);
623 return strcmp(Bstr(TKEY(2)), pch) == 0;
628 void tmplput_bstr(StrBuf *Target, WCTemplputParams *TP)
630 const StrBuf *Buf = SBstr(TKEY(0));
632 StrBufAppendTemplate(Target, TP, Buf, 1);
636 void tmplput_bstrforward(StrBuf *Target, WCTemplputParams *TP)
638 const StrBuf *Buf = SBstr(TKEY(0));
640 StrBufAppendBufPlain(Target, HKEY("?"), 0);
641 StrBufAppendBufPlain(Target, TKEY(0), 0);
642 StrBufAppendBufPlain(Target, HKEY("="), 0);
643 StrBufAppendTemplate(Target, TP, Buf, 1);
647 void diagnostics(void)
649 output_headers(1, 1, 1, 0, 0, 0);
650 wc_printf("Session: %d<hr />\n", WC->wc_session);
651 wc_printf("Command: <br><PRE>\n");
653 StrEscAppend(WC->WBuf, NULL, WC->UrlFragment1, 0, 0);
655 StrEscAppend(WC->WBuf, NULL, WC->UrlFragment12 0, 0);
657 StrEscAppend(WC->WBuf, NULL, WC->UrlFragment3, 0, 0);
659 wc_printf("</PRE><hr />\n");
660 wc_printf("Variables: <br><PRE>\n");
662 wc_printf("</PRE><hr />\n");
667 void tmplput_url_part(StrBuf *Target, WCTemplputParams *TP)
670 StrBuf *UrlBuf = NULL;
676 n = GetTemplateTokenNumber(Target, TP, 0, 0);
678 if (WCC->Hdr->HR.Handler != NULL)
679 UrlBuf = Name = WCC->Hdr->HR.Handler->Name;
682 UrlBuf = NewStrBuf();
683 StrBufExtract_token(UrlBuf, WCC->Hdr->HR.ReqLine, 0, '/');
686 UrlBuf = NewStrBuf();
687 StrBufExtract_token(UrlBuf, WCC->Hdr->HR.ReqLine, 1, '/');
690 if (UrlBuf == NULL) {
691 LogTemplateError(Target, "urlbuf", ERR_PARM1, TP, "not set.");
693 StrBufAppendTemplate(Target, TP, UrlBuf, 2);
694 if (Name == NULL) FreeStrBuf(&UrlBuf);
698 typedef struct __BstrPair {
702 CtxType CTX_BSTRPAIRS = CTX_NONE;
703 void HFreeBstrPair(void *pv)
705 BstrPair *p = (BstrPair*) pv;
711 HashList *iterate_GetBstrPairs(StrBuf *Target, WCTemplputParams *TP)
714 const char *ch = NULL;
716 const StrBuf *TheBStr;
719 const char *Pos = NULL;
722 if (HaveTemplateTokenString(NULL, TP, 2, &ch, &len))
724 GetTemplateTokenString(Target, TP, 2, &ch, &len);
731 TheBStr = SBstr(ch, len);
732 if ((TheBStr == NULL) || (StrLength(TheBStr) == 0))
734 List = NewHash(1, NULL);
735 while (Pos != StrBufNOTNULL)
737 X = NewStrBufPlain(NULL, StrLength(TheBStr));
738 StrBufExtract_NextToken(X, TheBStr, &Pos, '|');
739 if (Pos == StrBufNOTNULL) {
744 Y = NewStrBufPlain(NULL, StrLength(TheBStr));
745 StrBufExtract_NextToken(Y, TheBStr, &Pos, '|');
746 OnePair = (BstrPair*)malloc(sizeof(BstrPair));
749 Put(List, IKEY(i), OnePair, HFreeBstrPair);
756 void tmplput_bstr_pair(StrBuf *Target, WCTemplputParams *TP, int XY)
758 BstrPair *Pair = (BstrPair*) CTX(CTX_BSTRPAIRS);
760 StrBufAppendTemplate(Target, TP, (XY)?Pair->y:Pair->x, 0);
763 void tmplput_bstr_pair_x(StrBuf *Target, WCTemplputParams *TP)
764 { tmplput_bstr_pair(Target, TP, 0); }
765 void tmplput_bstr_pair_y(StrBuf *Target, WCTemplputParams *TP)
766 { tmplput_bstr_pair(Target, TP, 1); }
769 InitModule_PARAMHANDLING
772 RegisterCTX(CTX_BSTRPAIRS);
773 WebcitAddUrlHandler(HKEY("diagnostics"), "", 0, diagnostics, NEED_URL);
775 RegisterIterator("ITERATE:BSTR:PAIR", 1, NULL, iterate_GetBstrPairs, NULL, DeleteHash, CTX_BSTRPAIRS, CTX_NONE, IT_NOFLAG);
776 RegisterNamespace("BSTR:PAIR:X", 1, 2, tmplput_bstr_pair_x, NULL, CTX_BSTRPAIRS);
777 RegisterNamespace("BSTR:PAIR:Y", 1, 2, tmplput_bstr_pair_y, NULL, CTX_BSTRPAIRS);
779 RegisterConditional("COND:BSTR", 1, ConditionalBstr, CTX_NONE);
780 RegisterNamespace("BSTR", 1, 2, tmplput_bstr, NULL, CTX_NONE);
781 RegisterNamespace("BSTR:FORWARD", 1, 2, tmplput_bstrforward, NULL, CTX_NONE);
782 RegisterNamespace("URLPART", 1, 2, tmplput_url_part, NULL, CTX_NONE);
787 SessionAttachModule_PARAMHANDLING
790 sess->Hdr->urlstrings = NewHash(1,NULL);
794 SessionDetachModule_PARAMHANDLING
797 DeleteHash(&sess->Hdr->urlstrings);
798 FreeStrBuf(&sess->upload_filename);