2 * parse urlparts and post data
4 * Copyright (c) 1996-2012 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 void free_url(void *U)
20 urlcontent *u = (urlcontent*) U;
21 FreeStrBuf(&u->url_data);
26 * Extract variables from the URL.
28 void ParseURLParams(StrBuf *url)
30 const char *aptr, *bptr, *eptr, *up;
35 if (WCC->Hdr->urlstrings == NULL)
36 WCC->Hdr->urlstrings = NewHash(1, NULL);
37 eptr = ChrPtr(url) + StrLength(url);
39 while ((up < eptr) && (!IsEmptyStr(up))) {
41 while ((aptr < eptr) && (*aptr != '\0') && (*aptr != '='))
48 while ((bptr < eptr) && (*bptr != '\0')
49 && (*bptr != '&') && (*bptr != '?') && (*bptr != ' ')) {
52 keylen = aptr - up - 1; /* -1 -> '=' */
53 if(keylen > sizeof(u->url_key)) {
54 syslog(1, "invalid url_key from %s", ChrPtr(WCC->Hdr->HR.browser_host));
58 u = (urlcontent *) malloc(sizeof(urlcontent));
59 memcpy(u->url_key, up, keylen);
60 u->url_key[keylen] = '\0';
62 syslog(1, "invalid url_key from %s", ChrPtr(WCC->Hdr->HR.browser_host));
67 if (strncmp(u->url_key, "__", 2) != 0)
69 Put(WCC->Hdr->urlstrings, u->url_key, keylen, u, free_url);
71 u->url_data = NewStrBufPlain(aptr, len);
72 StrBufUnescape(u->url_data, 1);
73 #ifdef DEBUG_URLSTRINGS
74 syslog(9, "%s = [%d] %s\n",
76 StrLength(u->url_data),
82 u->url_data = NewStrBufPlain(aptr, len);
83 StrBufUnescape(u->url_data, 1);
84 syslog(1, "REJECTED because of __ is internal only: %s = [%d] %s\n",
86 StrLength(u->url_data),
97 * free urlstring memory
101 DeleteHash(&WC->Hdr->urlstrings);
105 * Diagnostic function to display the contents of all variables
117 Cursor = GetNewHashPos (WCC->Hdr->urlstrings, 0);
118 while (GetNextHashPos(WCC->Hdr->urlstrings, Cursor, &HKLen, &HKey, &U)) {
120 wc_printf("%38s = %s\n", u->url_key, ChrPtr(u->url_data));
125 * Return the value of a variable supplied to the current web page (from the url or a form)
128 const char *XBstr(const char *key, size_t keylen, size_t *len)
132 if ((WC->Hdr->urlstrings != NULL) &&
133 GetHash(WC->Hdr->urlstrings, key, keylen, &U)) {
134 *len = StrLength(((urlcontent *)U)->url_data);
135 return ChrPtr(((urlcontent *)U)->url_data);
143 const char *XBSTR(const char *key, size_t *len)
147 if ((WC->Hdr->urlstrings != NULL) &&
148 GetHash(WC->Hdr->urlstrings, key, strlen (key), &U)){
149 *len = StrLength(((urlcontent *)U)->url_data);
150 return ChrPtr(((urlcontent *)U)->url_data);
159 const char *BSTR(const char *key)
163 if ((WC->Hdr->urlstrings != NULL) &&
164 GetHash(WC->Hdr->urlstrings, key, strlen (key), &U))
165 return ChrPtr(((urlcontent *)U)->url_data);
170 const char *Bstr(const char *key, size_t keylen)
174 if ((WC->Hdr->urlstrings != NULL) &&
175 GetHash(WC->Hdr->urlstrings, key, keylen, &U))
176 return ChrPtr(((urlcontent *)U)->url_data);
181 const StrBuf *SBSTR(const char *key)
185 if ((WC->Hdr->urlstrings != NULL) &&
186 GetHash(WC->Hdr->urlstrings, key, strlen (key), &U))
187 return ((urlcontent *)U)->url_data;
192 const StrBuf *SBstr(const char *key, size_t keylen)
196 if ((WC->Hdr->urlstrings != NULL) &&
197 GetHash(WC->Hdr->urlstrings, key, keylen, &U))
198 return ((urlcontent *)U)->url_data;
203 long LBstr(const char *key, size_t keylen)
207 if ((WC->Hdr->urlstrings != NULL) &&
208 GetHash(WC->Hdr->urlstrings, key, keylen, &U))
209 return StrTol(((urlcontent *)U)->url_data);
214 long LBSTR(const char *key)
218 if ((WC->Hdr->urlstrings != NULL) &&
219 GetHash(WC->Hdr->urlstrings, key, strlen(key), &U))
220 return StrTol(((urlcontent *)U)->url_data);
225 int IBstr(const char *key, size_t keylen)
229 if ((WC->Hdr->urlstrings != NULL) &&
230 GetHash(WC->Hdr->urlstrings, key, keylen, &U))
231 return StrTol(((urlcontent *)U)->url_data);
236 int IBSTR(const char *key)
240 if ((WC->Hdr->urlstrings != NULL) &&
241 GetHash(WC->Hdr->urlstrings, key, strlen(key), &U))
242 return StrToi(((urlcontent *)U)->url_data);
247 int HaveBstr(const char *key, size_t keylen)
251 if ((WC->Hdr->urlstrings != NULL) &&
252 GetHash(WC->Hdr->urlstrings, key, keylen, &U))
253 return (StrLength(((urlcontent *)U)->url_data) != 0);
258 int HAVEBSTR(const char *key)
262 if ((WC->Hdr->urlstrings != NULL) &&
263 GetHash(WC->Hdr->urlstrings, key, strlen(key), &U))
264 return (StrLength(((urlcontent *)U)->url_data) != 0);
270 int YesBstr(const char *key, size_t keylen)
274 if ((WC->Hdr->urlstrings != NULL) &&
275 GetHash(WC->Hdr->urlstrings, key, keylen, &U))
276 return strcmp( ChrPtr(((urlcontent *)U)->url_data), "yes") == 0;
281 int YESBSTR(const char *key)
285 if ((WC->Hdr->urlstrings != NULL) &&
286 GetHash(WC->Hdr->urlstrings, key, strlen(key), &U))
287 return strcmp( ChrPtr(((urlcontent *)U)->url_data), "yes") == 0;
296 * This function is called by the MIME parser to handle data uploaded by
297 * the browser. Form data, uploaded files, and the data from HTTP PUT
298 * operations (such as those found in GroupDAV) all arrive this way.
300 * name Name of the item being uploaded
301 * filename Filename of the item being uploaded
302 * partnum MIME part identifier (not needed)
303 * disp MIME content disposition (not needed)
304 * content The actual data
305 * cbtype MIME content-type
306 * cbcharset Character set
307 * length Content length
308 * encoding MIME encoding type (not needed)
309 * cbid Content ID (not needed)
310 * userdata Not used here
312 void upload_handler(char *name, char *filename, char *partnum, char *disp,
313 void *content, char *cbtype, char *cbcharset,
314 size_t length, char *encoding, char *cbid, void *userdata)
320 #ifdef DEBUG_URLSTRINGS
321 syslog(9, "upload_handler() name=%s, type=%s, len=%d", name, cbtype, length);
323 if (WCC->Hdr->urlstrings == NULL)
324 WCC->Hdr->urlstrings = NewHash(1, NULL);
327 if ( (length > 0) && (IsEmptyStr(cbtype)) ) {
328 u = (urlcontent *) malloc(sizeof(urlcontent));
330 keylen = safestrncpy(u->url_key, name, sizeof(u->url_key));
331 u->url_data = NewStrBufPlain(content, length);
333 if (strncmp(u->url_key, "__", 2) != 0)
335 Put(WCC->Hdr->urlstrings, u->url_key, keylen, u, free_url);
338 syslog(1, "REJECTED because of __ is internal only: %s = [%d] %s\n",
340 StrLength(u->url_data),
341 ChrPtr(u->url_data));
345 #ifdef DEBUG_URLSTRINGS
346 syslog(9, "Key: <%s> len: [%d] Data: <%s>",
348 StrLength(u->url_data),
349 ChrPtr(u->url_data));
354 if ( (length > 0) && (!IsEmptyStr(cbtype)) ) {
355 WCC->upload = NewStrBufPlain(content, length);
356 WCC->upload_length = length;
357 WCC->upload_filename = NewStrBufPlain(filename, -1);
358 safestrncpy(WCC->upload_content_type, cbtype, sizeof(WC->upload_content_type));
359 #ifdef DEBUG_URLSTRINGS
360 syslog(9, "File: <%s> len: [%ld]", filename, length);
369 void PutBstr(const char *key, long keylen, StrBuf *Value)
374 if(keylen > sizeof(u->url_key)) {
375 syslog(1, "invalid url_key from %s", ChrPtr(WCC->Hdr->HR.browser_host));
379 u = (urlcontent*)malloc(sizeof(urlcontent));
380 memcpy(u->url_key, key, keylen + 1);
382 Put(WC->Hdr->urlstrings, u->url_key, keylen, u, free_url);
387 int ConditionalBstr(StrBuf *Target, WCTemplputParams *TP)
389 if(TP->Tokens->nParameters == 3)
390 return HaveBstr(TKEY(2));
392 if (IS_NUMBER(TP->Tokens->Params[3]->Type))
394 return LBstr(TKEY(2)) ==
395 GetTemplateTokenNumber(Target,
404 GetTemplateTokenString (Target, TP, 3, &pch, &len);
405 return strcmp(Bstr(TKEY(2)), pch) == 0;
410 void tmplput_bstr(StrBuf *Target, WCTemplputParams *TP)
412 const StrBuf *Buf = SBstr(TKEY(0));
414 StrBufAppendTemplate(Target, TP, Buf, 1);
418 void tmplput_bstrforward(StrBuf *Target, WCTemplputParams *TP)
420 const StrBuf *Buf = SBstr(TKEY(0));
422 StrBufAppendBufPlain(Target, HKEY("?"), 0);
423 StrBufAppendBufPlain(Target, TKEY(0), 0);
424 StrBufAppendBufPlain(Target, HKEY("="), 0);
425 StrBufAppendTemplate(Target, TP, Buf, 1);
429 void diagnostics(void)
431 output_headers(1, 1, 1, 0, 0, 0);
432 wc_printf("Session: %d<hr />\n", WC->wc_session);
433 wc_printf("Command: <br><PRE>\n");
435 StrEscAppend(WC->WBuf, NULL, WC->UrlFragment1, 0, 0);
437 StrEscAppend(WC->WBuf, NULL, WC->UrlFragment12 0, 0);
439 StrEscAppend(WC->WBuf, NULL, WC->UrlFragment3, 0, 0);
441 wc_printf("</PRE><hr />\n");
442 wc_printf("Variables: <br><PRE>\n");
444 wc_printf("</PRE><hr />\n");
449 void tmplput_url_part(StrBuf *Target, WCTemplputParams *TP)
452 StrBuf *UrlBuf = NULL;
458 n = GetTemplateTokenNumber(Target, TP, 0, 0);
460 if (WCC->Hdr->HR.Handler != NULL)
461 UrlBuf = Name = WCC->Hdr->HR.Handler->Name;
464 UrlBuf = NewStrBuf();
465 StrBufExtract_token(UrlBuf, WCC->Hdr->HR.ReqLine, 0, '/');
468 UrlBuf = NewStrBuf();
469 StrBufExtract_token(UrlBuf, WCC->Hdr->HR.ReqLine, 1, '/');
472 if (UrlBuf == NULL) {
473 LogTemplateError(Target, "urlbuf", ERR_PARM1, TP, "not set.");
475 StrBufAppendTemplate(Target, TP, UrlBuf, 2);
476 if (Name == NULL) FreeStrBuf(&UrlBuf);
480 typedef struct __BstrPair {
484 CtxType CTX_BSTRPAIRS = CTX_NONE;
485 void HFreeBstrPair(void *pv)
487 BstrPair *p = (BstrPair*) pv;
493 HashList *iterate_GetBstrPairs(StrBuf *Target, WCTemplputParams *TP)
496 const char *ch = NULL;
498 const StrBuf *TheBStr;
501 const char *Pos = NULL;
504 if (HaveTemplateTokenString(NULL, TP, 2, &ch, &len))
506 GetTemplateTokenString(Target, TP, 2, &ch, &len);
513 TheBStr = SBstr(ch, len);
514 if ((TheBStr == NULL) || (StrLength(TheBStr) == 0))
516 List = NewHash(1, NULL);
517 while (Pos != StrBufNOTNULL)
519 X = NewStrBufPlain(NULL, StrLength(TheBStr));
520 StrBufExtract_NextToken(X, TheBStr, &Pos, '|');
521 if (Pos == StrBufNOTNULL) {
526 Y = NewStrBufPlain(NULL, StrLength(TheBStr));
527 StrBufExtract_NextToken(Y, TheBStr, &Pos, '|');
528 OnePair = (BstrPair*)malloc(sizeof(BstrPair));
531 Put(List, IKEY(i), OnePair, HFreeBstrPair);
538 void tmplput_bstr_pair(StrBuf *Target, WCTemplputParams *TP, int XY)
540 BstrPair *Pair = (BstrPair*) CTX(CTX_BSTRPAIRS);
542 StrBufAppendTemplate(Target, TP, (XY)?Pair->y:Pair->x, 0);
545 void tmplput_bstr_pair_x(StrBuf *Target, WCTemplputParams *TP)
546 { tmplput_bstr_pair(Target, TP, 0); }
547 void tmplput_bstr_pair_y(StrBuf *Target, WCTemplputParams *TP)
548 { tmplput_bstr_pair(Target, TP, 1); }
551 InitModule_PARAMHANDLING
554 RegisterCTX(CTX_BSTRPAIRS);
555 WebcitAddUrlHandler(HKEY("diagnostics"), "", 0, diagnostics, NEED_URL);
557 RegisterIterator("ITERATE:BSTR:PAIR", 1, NULL, iterate_GetBstrPairs, NULL, DeleteHash, CTX_BSTRPAIRS, CTX_NONE, IT_NOFLAG);
558 RegisterNamespace("BSTR:PAIR:X", 1, 2, tmplput_bstr_pair_x, NULL, CTX_BSTRPAIRS);
559 RegisterNamespace("BSTR:PAIR:Y", 1, 2, tmplput_bstr_pair_y, NULL, CTX_BSTRPAIRS);
561 RegisterConditional("COND:BSTR", 1, ConditionalBstr, CTX_NONE);
562 RegisterNamespace("BSTR", 1, 2, tmplput_bstr, NULL, CTX_NONE);
563 RegisterNamespace("BSTR:FORWARD", 1, 2, tmplput_bstrforward, NULL, CTX_NONE);
564 RegisterNamespace("URLPART", 1, 2, tmplput_url_part, NULL, CTX_NONE);
569 SessionAttachModule_PARAMHANDLING
572 sess->Hdr->urlstrings = NewHash(1,NULL);
576 SessionDetachModule_PARAMHANDLING
579 DeleteHash(&sess->Hdr->urlstrings);
580 FreeStrBuf(&sess->upload_filename);