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) {
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 ((*pch != ':') && (pch != pche)){
87 /* Separate the toplevel key : */
92 lengths[i] = pch - pchs;
99 PutSubstructUrlKey(urlstrings, u, keys, lengths, i - 1, 0);
104 * Extract variables from the URL.
106 void ParseURLParams(StrBuf *url)
108 const char *aptr, *bptr, *eptr, *up = NULL;
110 urlcontent *u = NULL;
113 if (WCC->Hdr->urlstrings == NULL) {
114 WCC->Hdr->urlstrings = NewHash(1, NULL);
116 eptr = ChrPtr(url) + StrLength(url);
118 while ((up < eptr) && (!IsEmptyStr(up))) {
121 while ((aptr < eptr) && (*aptr != '\0') && (*aptr != '=')) {
132 while ((bptr < eptr) && (*bptr != '\0')
133 && (*bptr != '&') && (*bptr != '?') && (*bptr != ' ')) {
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)
144 syslog(LOG_WARNING, "%s:%d: invalid url_key of size %d", __FILE__, __LINE__, keylen);
149 u = (urlcontent *) malloc(sizeof(urlcontent));
150 memcpy(u->url_key, up, keylen);
151 u->url_key[keylen] = '\0';
155 if (strncmp(u->url_key, "__", 2) != 0)
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",
163 StrLength(u->url_data),
164 ChrPtr(u->url_data));
166 PutUrlKey(WCC->Hdr->urlstrings, u, have_colon);
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",
174 StrLength(u->url_data),
175 ChrPtr(u->url_data));
185 * free urlstring memory
189 DeleteHash(&WC->Hdr->urlstrings);
193 * Diagnostic function to display the contents of all variables
205 Cursor = GetNewHashPos (WCC->Hdr->urlstrings, 0);
206 while (GetNextHashPos(WCC->Hdr->urlstrings, Cursor, &HKLen, &HKey, &U)) {
208 wc_printf("%38s = %s\n", u->url_key, ChrPtr(u->url_data));
213 * Return the value of a variable supplied to the current web page (from the url or a form)
216 const char *XBstr(const char *key, size_t keylen, size_t *len)
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);
231 const char *XBSTR(const char *key, size_t *len)
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);
247 const char *BSTR(const char *key)
251 if ((WC->Hdr->urlstrings != NULL) &&
252 GetHash(WC->Hdr->urlstrings, key, strlen (key), &U))
253 return ChrPtr(((urlcontent *)U)->url_data);
258 const char *Bstr(const char *key, size_t keylen)
262 if ((WC->Hdr->urlstrings != NULL) &&
263 GetHash(WC->Hdr->urlstrings, key, keylen, &U))
264 return ChrPtr(((urlcontent *)U)->url_data);
269 const StrBuf *SBSTR(const char *key)
273 if ((WC->Hdr->urlstrings != NULL) &&
274 GetHash(WC->Hdr->urlstrings, key, strlen (key), &U))
275 return ((urlcontent *)U)->url_data;
280 const StrBuf *SBstr(const char *key, size_t keylen)
284 if ((WC->Hdr->urlstrings != NULL) &&
285 GetHash(WC->Hdr->urlstrings, key, keylen, &U))
286 return ((urlcontent *)U)->url_data;
291 long LBstr(const char *key, size_t keylen)
295 if ((WC->Hdr->urlstrings != NULL) &&
296 GetHash(WC->Hdr->urlstrings, key, keylen, &U))
297 return StrTol(((urlcontent *)U)->url_data);
302 long LBSTR(const char *key)
306 if ((WC->Hdr->urlstrings != NULL) &&
307 GetHash(WC->Hdr->urlstrings, key, strlen(key), &U))
308 return StrTol(((urlcontent *)U)->url_data);
313 int IBstr(const char *key, size_t keylen)
317 if ((WC->Hdr->urlstrings != NULL) &&
318 GetHash(WC->Hdr->urlstrings, key, keylen, &U))
319 return StrTol(((urlcontent *)U)->url_data);
324 int IBSTR(const char *key)
328 if ((WC->Hdr->urlstrings != NULL) &&
329 GetHash(WC->Hdr->urlstrings, key, strlen(key), &U))
330 return StrToi(((urlcontent *)U)->url_data);
335 int HaveBstr(const char *key, size_t keylen)
339 if ((WC->Hdr->urlstrings != NULL) &&
340 GetHash(WC->Hdr->urlstrings, key, keylen, &U))
341 return (StrLength(((urlcontent *)U)->url_data) != 0);
346 int HAVEBSTR(const char *key)
350 if ((WC->Hdr->urlstrings != NULL) &&
351 GetHash(WC->Hdr->urlstrings, key, strlen(key), &U))
352 return (StrLength(((urlcontent *)U)->url_data) != 0);
358 int YesBstr(const char *key, size_t keylen)
362 if ((WC->Hdr->urlstrings != NULL) &&
363 GetHash(WC->Hdr->urlstrings, key, keylen, &U))
364 return strcmp( ChrPtr(((urlcontent *)U)->url_data), "yes") == 0;
369 int YESBSTR(const char *key)
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;
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.
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
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)
408 #ifdef DEBUG_URLSTRINGS
409 syslog(LOG_DEBUG, "upload_handler() name=%s, type=%s, len="SIZE_T_FMT, name, cbtype, length);
411 if (WCC->Hdr->urlstrings == NULL)
412 WCC->Hdr->urlstrings = NewHash(1, NULL);
415 if ( (length > 0) && (IsEmptyStr(cbtype)) ) {
416 u = (urlcontent *) malloc(sizeof(urlcontent));
418 keylen = safestrncpy(u->url_key, name, sizeof(u->url_key));
419 u->url_data = NewStrBufPlain(content, length);
423 if (strncmp(u->url_key, "__", 2) != 0)
425 PutUrlKey(WCC->Hdr->urlstrings, u, (strchr(u->url_key, ':') != NULL));
428 syslog(LOG_INFO, "REJECTED because of __ is internal only: %s = [%d] %s\n",
430 StrLength(u->url_data),
431 ChrPtr(u->url_data));
435 #ifdef DEBUG_URLSTRINGS
436 syslog(LOG_DEBUG, "Key: <%s> len: [%d] Data: <%s>",
438 StrLength(u->url_data),
439 ChrPtr(u->url_data));
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);
457 void PutBstr(const char *key, long keylen, StrBuf *Value)
461 if(keylen >= sizeof(u->url_key)) {
462 syslog(LOG_WARNING, "%s:%d: invalid url_key of size %ld", __FILE__, __LINE__, keylen);
466 u = (urlcontent*)malloc(sizeof(urlcontent));
467 memcpy(u->url_key, key, keylen + 1);
471 Put(WC->Hdr->urlstrings, u->url_key, keylen, u, free_url);
473 void PutlBstr(const char *key, long keylen, long Value)
477 Buf = NewStrBufPlain(NULL, sizeof(long) * 16);
478 StrBufPrintf(Buf, "%ld", Value);
479 PutBstr(key, keylen, Buf);
484 int ConditionalBstr(StrBuf *Target, WCTemplputParams *TP)
486 if(TP->Tokens->nParameters == 3)
487 return HaveBstr(TKEY(2));
489 if (IS_NUMBER(TP->Tokens->Params[3]->Type))
491 return LBstr(TKEY(2)) ==
492 GetTemplateTokenNumber(Target,
501 GetTemplateTokenString (Target, TP, 3, &pch, &len);
502 return strcmp(Bstr(TKEY(2)), pch) == 0;
507 void tmplput_bstr(StrBuf *Target, WCTemplputParams *TP)
509 const StrBuf *Buf = SBstr(TKEY(0));
511 StrBufAppendTemplate(Target, TP, Buf, 1);
515 void tmplput_bstrforward(StrBuf *Target, WCTemplputParams *TP)
517 const StrBuf *Buf = SBstr(TKEY(0));
519 StrBufAppendBufPlain(Target, HKEY("?"), 0);
520 StrBufAppendBufPlain(Target, TKEY(0), 0);
521 StrBufAppendBufPlain(Target, HKEY("="), 0);
522 StrBufAppendTemplate(Target, TP, Buf, 1);
526 void diagnostics(void)
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");
532 StrEscAppend(WC->WBuf, NULL, WC->UrlFragment1, 0, 0);
534 StrEscAppend(WC->WBuf, NULL, WC->UrlFragment12 0, 0);
536 StrEscAppend(WC->WBuf, NULL, WC->UrlFragment3, 0, 0);
538 wc_printf("</PRE><hr />\n");
539 wc_printf("Variables: <br><PRE>\n");
541 wc_printf("</PRE><hr />\n");
546 void tmplput_url_part(StrBuf *Target, WCTemplputParams *TP)
549 StrBuf *UrlBuf = NULL;
555 n = GetTemplateTokenNumber(Target, TP, 0, 0);
557 if (WCC->Hdr->HR.Handler != NULL)
558 UrlBuf = Name = WCC->Hdr->HR.Handler->Name;
561 UrlBuf = NewStrBuf();
562 StrBufExtract_token(UrlBuf, WCC->Hdr->HR.ReqLine, 0, '/');
565 UrlBuf = NewStrBuf();
566 StrBufExtract_token(UrlBuf, WCC->Hdr->HR.ReqLine, 1, '/');
569 if (UrlBuf == NULL) {
570 LogTemplateError(Target, "urlbuf", ERR_PARM1, TP, "not set.");
572 StrBufAppendTemplate(Target, TP, UrlBuf, 2);
573 if (Name == NULL) FreeStrBuf(&UrlBuf);
577 typedef struct __BstrPair {
581 CtxType CTX_BSTRPAIRS = CTX_NONE;
582 void HFreeBstrPair(void *pv)
584 BstrPair *p = (BstrPair*) pv;
590 HashList *iterate_GetBstrPairs(StrBuf *Target, WCTemplputParams *TP)
593 const char *ch = NULL;
595 const StrBuf *TheBStr;
598 const char *Pos = NULL;
601 if (HaveTemplateTokenString(NULL, TP, 2, &ch, &len))
603 GetTemplateTokenString(Target, TP, 2, &ch, &len);
610 TheBStr = SBstr(ch, len);
611 if ((TheBStr == NULL) || (StrLength(TheBStr) == 0))
613 List = NewHash(1, NULL);
614 while (Pos != StrBufNOTNULL)
616 X = NewStrBufPlain(NULL, StrLength(TheBStr));
617 StrBufExtract_NextToken(X, TheBStr, &Pos, '|');
618 if (Pos == StrBufNOTNULL) {
623 Y = NewStrBufPlain(NULL, StrLength(TheBStr));
624 StrBufExtract_NextToken(Y, TheBStr, &Pos, '|');
625 OnePair = (BstrPair*)malloc(sizeof(BstrPair));
628 Put(List, IKEY(i), OnePair, HFreeBstrPair);
635 void tmplput_bstr_pair(StrBuf *Target, WCTemplputParams *TP, int XY)
637 BstrPair *Pair = (BstrPair*) CTX(CTX_BSTRPAIRS);
639 StrBufAppendTemplate(Target, TP, (XY)?Pair->y:Pair->x, 0);
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); }
648 InitModule_PARAMHANDLING
651 RegisterCTX(CTX_BSTRPAIRS);
652 WebcitAddUrlHandler(HKEY("diagnostics"), "", 0, diagnostics, NEED_URL);
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);
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);
666 SessionAttachModule_PARAMHANDLING
669 sess->Hdr->urlstrings = NewHash(1,NULL);
673 SessionDetachModule_PARAMHANDLING
676 DeleteHash(&sess->Hdr->urlstrings);
677 FreeStrBuf(&sess->upload_filename);