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);
30 * Extract variables from the URL.
32 void ParseURLParams(StrBuf *url)
34 const char *aptr, *bptr, *eptr, *up = NULL;
39 if (WCC->Hdr->urlstrings == NULL) {
40 WCC->Hdr->urlstrings = NewHash(1, NULL);
42 eptr = ChrPtr(url) + StrLength(url);
44 while ((up < eptr) && (!IsEmptyStr(up))) {
46 while ((aptr < eptr) && (*aptr != '\0') && (*aptr != '=')) {
54 while ((bptr < eptr) && (*bptr != '\0')
55 && (*bptr != '&') && (*bptr != '?') && (*bptr != ' ')) {
58 keylen = aptr - up - 1; /* -1 -> '=' */
59 if (keylen > sizeof(u->url_key)) {
60 syslog(LOG_WARNING, "%s:%d: invalid url_key of size %d in string size %d",
61 __FILE__, __LINE__, keylen, sizeof(u->url_key)
65 u = (urlcontent *) malloc(sizeof(urlcontent));
66 memcpy(u->url_key, up, keylen);
67 u->url_key[keylen] = '\0';
69 syslog(LOG_WARNING, "%s:%d: invalid url_key of size %d", __FILE__, __LINE__, keylen);
74 if (strncmp(u->url_key, "__", 2) != 0)
76 Put(WCC->Hdr->urlstrings, u->url_key, keylen, u, free_url);
78 u->url_data = NewStrBufPlain(aptr, len);
79 StrBufUnescape(u->url_data, 1);
80 #ifdef DEBUG_URLSTRINGS
81 syslog(LOG_DEBUG, "%s = [%d] %s\n",
83 StrLength(u->url_data),
89 u->url_data = NewStrBufPlain(aptr, len);
90 StrBufUnescape(u->url_data, 1);
91 syslog(LOG_WARNING, "REJECTED because of __ is internal only: %s = [%d] %s\n",
93 StrLength(u->url_data),
104 * free urlstring memory
108 DeleteHash(&WC->Hdr->urlstrings);
112 * Diagnostic function to display the contents of all variables
124 Cursor = GetNewHashPos (WCC->Hdr->urlstrings, 0);
125 while (GetNextHashPos(WCC->Hdr->urlstrings, Cursor, &HKLen, &HKey, &U)) {
127 wc_printf("%38s = %s\n", u->url_key, ChrPtr(u->url_data));
132 * Return the value of a variable supplied to the current web page (from the url or a form)
135 const char *XBstr(const char *key, size_t keylen, size_t *len)
139 if ((WC->Hdr->urlstrings != NULL) &&
140 GetHash(WC->Hdr->urlstrings, key, keylen, &U)) {
141 *len = StrLength(((urlcontent *)U)->url_data);
142 return ChrPtr(((urlcontent *)U)->url_data);
150 const char *XBSTR(const char *key, size_t *len)
154 if ((WC->Hdr->urlstrings != NULL) &&
155 GetHash(WC->Hdr->urlstrings, key, strlen (key), &U)){
156 *len = StrLength(((urlcontent *)U)->url_data);
157 return ChrPtr(((urlcontent *)U)->url_data);
166 const char *BSTR(const char *key)
170 if ((WC->Hdr->urlstrings != NULL) &&
171 GetHash(WC->Hdr->urlstrings, key, strlen (key), &U))
172 return ChrPtr(((urlcontent *)U)->url_data);
177 const char *Bstr(const char *key, size_t keylen)
181 if ((WC->Hdr->urlstrings != NULL) &&
182 GetHash(WC->Hdr->urlstrings, key, keylen, &U))
183 return ChrPtr(((urlcontent *)U)->url_data);
188 const StrBuf *SBSTR(const char *key)
192 if ((WC->Hdr->urlstrings != NULL) &&
193 GetHash(WC->Hdr->urlstrings, key, strlen (key), &U))
194 return ((urlcontent *)U)->url_data;
199 const StrBuf *SBstr(const char *key, size_t keylen)
203 if ((WC->Hdr->urlstrings != NULL) &&
204 GetHash(WC->Hdr->urlstrings, key, keylen, &U))
205 return ((urlcontent *)U)->url_data;
210 long LBstr(const char *key, size_t keylen)
214 if ((WC->Hdr->urlstrings != NULL) &&
215 GetHash(WC->Hdr->urlstrings, key, keylen, &U))
216 return StrTol(((urlcontent *)U)->url_data);
221 long LBSTR(const char *key)
225 if ((WC->Hdr->urlstrings != NULL) &&
226 GetHash(WC->Hdr->urlstrings, key, strlen(key), &U))
227 return StrTol(((urlcontent *)U)->url_data);
232 int IBstr(const char *key, size_t keylen)
236 if ((WC->Hdr->urlstrings != NULL) &&
237 GetHash(WC->Hdr->urlstrings, key, keylen, &U))
238 return StrTol(((urlcontent *)U)->url_data);
243 int IBSTR(const char *key)
247 if ((WC->Hdr->urlstrings != NULL) &&
248 GetHash(WC->Hdr->urlstrings, key, strlen(key), &U))
249 return StrToi(((urlcontent *)U)->url_data);
254 int HaveBstr(const char *key, size_t keylen)
258 if ((WC->Hdr->urlstrings != NULL) &&
259 GetHash(WC->Hdr->urlstrings, key, keylen, &U))
260 return (StrLength(((urlcontent *)U)->url_data) != 0);
265 int HAVEBSTR(const char *key)
269 if ((WC->Hdr->urlstrings != NULL) &&
270 GetHash(WC->Hdr->urlstrings, key, strlen(key), &U))
271 return (StrLength(((urlcontent *)U)->url_data) != 0);
277 int YesBstr(const char *key, size_t keylen)
281 if ((WC->Hdr->urlstrings != NULL) &&
282 GetHash(WC->Hdr->urlstrings, key, keylen, &U))
283 return strcmp( ChrPtr(((urlcontent *)U)->url_data), "yes") == 0;
288 int YESBSTR(const char *key)
292 if ((WC->Hdr->urlstrings != NULL) &&
293 GetHash(WC->Hdr->urlstrings, key, strlen(key), &U))
294 return strcmp( ChrPtr(((urlcontent *)U)->url_data), "yes") == 0;
303 * This function is called by the MIME parser to handle data uploaded by
304 * the browser. Form data, uploaded files, and the data from HTTP PUT
305 * operations (such as those found in GroupDAV) all arrive this way.
307 * name Name of the item being uploaded
308 * filename Filename of the item being uploaded
309 * partnum MIME part identifier (not needed)
310 * disp MIME content disposition (not needed)
311 * content The actual data
312 * cbtype MIME content-type
313 * cbcharset Character set
314 * length Content length
315 * encoding MIME encoding type (not needed)
316 * cbid Content ID (not needed)
317 * userdata Not used here
319 void upload_handler(char *name, char *filename, char *partnum, char *disp,
320 void *content, char *cbtype, char *cbcharset,
321 size_t length, char *encoding, char *cbid, void *userdata)
327 #ifdef DEBUG_URLSTRINGS
328 syslog(LOG_DEBUG, "upload_handler() name=%s, type=%s, len="SIZE_T_FMT, name, cbtype, length);
330 if (WCC->Hdr->urlstrings == NULL)
331 WCC->Hdr->urlstrings = NewHash(1, NULL);
334 if ( (length > 0) && (IsEmptyStr(cbtype)) ) {
335 u = (urlcontent *) malloc(sizeof(urlcontent));
337 keylen = safestrncpy(u->url_key, name, sizeof(u->url_key));
338 u->url_data = NewStrBufPlain(content, length);
340 if (strncmp(u->url_key, "__", 2) != 0)
342 Put(WCC->Hdr->urlstrings, u->url_key, keylen, u, free_url);
345 syslog(LOG_INFO, "REJECTED because of __ is internal only: %s = [%d] %s\n",
347 StrLength(u->url_data),
348 ChrPtr(u->url_data));
352 #ifdef DEBUG_URLSTRINGS
353 syslog(LOG_DEBUG, "Key: <%s> len: [%d] Data: <%s>",
355 StrLength(u->url_data),
356 ChrPtr(u->url_data));
361 if ( (length > 0) && (!IsEmptyStr(cbtype)) ) {
362 WCC->upload = NewStrBufPlain(content, length);
363 WCC->upload_length = length;
364 WCC->upload_filename = NewStrBufPlain(filename, -1);
365 safestrncpy(WCC->upload_content_type, cbtype, sizeof(WC->upload_content_type));
366 #ifdef DEBUG_URLSTRINGS
367 syslog(LOG_DEBUG, "File: <%s> len: [%ld]", filename, (long int)length);
374 void PutBstr(const char *key, long keylen, StrBuf *Value)
378 if(keylen >= sizeof(u->url_key)) {
379 syslog(LOG_WARNING, "%s:%d: invalid url_key of size %ld", __FILE__, __LINE__, keylen);
383 u = (urlcontent*)malloc(sizeof(urlcontent));
384 memcpy(u->url_key, key, keylen + 1);
386 Put(WC->Hdr->urlstrings, u->url_key, keylen, u, free_url);
388 void PutlBstr(const char *key, long keylen, long Value)
392 Buf = NewStrBufPlain(NULL, sizeof(long) * 16);
393 StrBufPrintf(Buf, "%ld", Value);
394 PutBstr(key, keylen, Buf);
399 int ConditionalBstr(StrBuf *Target, WCTemplputParams *TP)
401 if(TP->Tokens->nParameters == 3)
402 return HaveBstr(TKEY(2));
404 if (IS_NUMBER(TP->Tokens->Params[3]->Type))
406 return LBstr(TKEY(2)) ==
407 GetTemplateTokenNumber(Target,
416 GetTemplateTokenString (Target, TP, 3, &pch, &len);
417 return strcmp(Bstr(TKEY(2)), pch) == 0;
422 void tmplput_bstr(StrBuf *Target, WCTemplputParams *TP)
424 const StrBuf *Buf = SBstr(TKEY(0));
426 StrBufAppendTemplate(Target, TP, Buf, 1);
430 void tmplput_bstrforward(StrBuf *Target, WCTemplputParams *TP)
432 const StrBuf *Buf = SBstr(TKEY(0));
434 StrBufAppendBufPlain(Target, HKEY("?"), 0);
435 StrBufAppendBufPlain(Target, TKEY(0), 0);
436 StrBufAppendBufPlain(Target, HKEY("="), 0);
437 StrBufAppendTemplate(Target, TP, Buf, 1);
441 void diagnostics(void)
443 output_headers(1, 1, 1, 0, 0, 0);
444 wc_printf("Session: %d<hr />\n", WC->wc_session);
445 wc_printf("Command: <br><PRE>\n");
447 StrEscAppend(WC->WBuf, NULL, WC->UrlFragment1, 0, 0);
449 StrEscAppend(WC->WBuf, NULL, WC->UrlFragment12 0, 0);
451 StrEscAppend(WC->WBuf, NULL, WC->UrlFragment3, 0, 0);
453 wc_printf("</PRE><hr />\n");
454 wc_printf("Variables: <br><PRE>\n");
456 wc_printf("</PRE><hr />\n");
461 void tmplput_url_part(StrBuf *Target, WCTemplputParams *TP)
464 StrBuf *UrlBuf = NULL;
470 n = GetTemplateTokenNumber(Target, TP, 0, 0);
472 if (WCC->Hdr->HR.Handler != NULL)
473 UrlBuf = Name = WCC->Hdr->HR.Handler->Name;
476 UrlBuf = NewStrBuf();
477 StrBufExtract_token(UrlBuf, WCC->Hdr->HR.ReqLine, 0, '/');
480 UrlBuf = NewStrBuf();
481 StrBufExtract_token(UrlBuf, WCC->Hdr->HR.ReqLine, 1, '/');
484 if (UrlBuf == NULL) {
485 LogTemplateError(Target, "urlbuf", ERR_PARM1, TP, "not set.");
487 StrBufAppendTemplate(Target, TP, UrlBuf, 2);
488 if (Name == NULL) FreeStrBuf(&UrlBuf);
492 typedef struct __BstrPair {
496 CtxType CTX_BSTRPAIRS = CTX_NONE;
497 void HFreeBstrPair(void *pv)
499 BstrPair *p = (BstrPair*) pv;
505 HashList *iterate_GetBstrPairs(StrBuf *Target, WCTemplputParams *TP)
508 const char *ch = NULL;
510 const StrBuf *TheBStr;
513 const char *Pos = NULL;
516 if (HaveTemplateTokenString(NULL, TP, 2, &ch, &len))
518 GetTemplateTokenString(Target, TP, 2, &ch, &len);
525 TheBStr = SBstr(ch, len);
526 if ((TheBStr == NULL) || (StrLength(TheBStr) == 0))
528 List = NewHash(1, NULL);
529 while (Pos != StrBufNOTNULL)
531 X = NewStrBufPlain(NULL, StrLength(TheBStr));
532 StrBufExtract_NextToken(X, TheBStr, &Pos, '|');
533 if (Pos == StrBufNOTNULL) {
538 Y = NewStrBufPlain(NULL, StrLength(TheBStr));
539 StrBufExtract_NextToken(Y, TheBStr, &Pos, '|');
540 OnePair = (BstrPair*)malloc(sizeof(BstrPair));
543 Put(List, IKEY(i), OnePair, HFreeBstrPair);
550 void tmplput_bstr_pair(StrBuf *Target, WCTemplputParams *TP, int XY)
552 BstrPair *Pair = (BstrPair*) CTX(CTX_BSTRPAIRS);
554 StrBufAppendTemplate(Target, TP, (XY)?Pair->y:Pair->x, 0);
557 void tmplput_bstr_pair_x(StrBuf *Target, WCTemplputParams *TP)
558 { tmplput_bstr_pair(Target, TP, 0); }
559 void tmplput_bstr_pair_y(StrBuf *Target, WCTemplputParams *TP)
560 { tmplput_bstr_pair(Target, TP, 1); }
563 InitModule_PARAMHANDLING
566 RegisterCTX(CTX_BSTRPAIRS);
567 WebcitAddUrlHandler(HKEY("diagnostics"), "", 0, diagnostics, NEED_URL);
569 RegisterIterator("ITERATE:BSTR:PAIR", 1, NULL, iterate_GetBstrPairs, NULL, DeleteHash, CTX_BSTRPAIRS, CTX_NONE, IT_NOFLAG);
570 RegisterNamespace("BSTR:PAIR:X", 1, 2, tmplput_bstr_pair_x, NULL, CTX_BSTRPAIRS);
571 RegisterNamespace("BSTR:PAIR:Y", 1, 2, tmplput_bstr_pair_y, NULL, CTX_BSTRPAIRS);
573 RegisterConditional("COND:BSTR", 1, ConditionalBstr, CTX_NONE);
574 RegisterNamespace("BSTR", 1, 2, tmplput_bstr, NULL, CTX_NONE);
575 RegisterNamespace("BSTR:FORWARD", 1, 2, tmplput_bstrforward, NULL, CTX_NONE);
576 RegisterNamespace("URLPART", 1, 2, tmplput_url_part, NULL, CTX_NONE);
581 SessionAttachModule_PARAMHANDLING
584 sess->Hdr->urlstrings = NewHash(1,NULL);
588 SessionDetachModule_PARAMHANDLING
591 DeleteHash(&sess->Hdr->urlstrings);
592 FreeStrBuf(&sess->upload_filename);