'\"
'\" The contents of this file are subject to the AOLserver Public License
'\" Version 1.1 (the "License"); you may not use this file except in
'\" compliance with the License. You may obtain a copy of the License at
'\" http://aolserver.com/.
'\"
'\" Software distributed under the License is distributed on an "AS IS"
'\" basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
'\" the License for the specific language governing rights and limitations
'\" under the License.
'\"
'\" The Original Code is AOLserver Code and related documentation
'\" distributed by AOL.
'\"
'\" The Initial Developer of the Original Code is America Online,
'\" Inc. Portions created by AOL are Copyright (C) 1999 America Online,
'\" Inc. All Rights Reserved.
'\"
'\" Alternatively, the contents of this file may be used under the terms
'\" of the GNU General Public License (the "GPL"), in which case the
'\" provisions of GPL are applicable instead of those above. If you wish
'\" to allow use of your version of this file only under the terms of the
'\" GPL and not to allow others to use your version of this file under the
'\" License, indicate your decision by deleting the provisions above and
'\" replace them with the notice and other provisions required by the GPL.
'\" If you do not delete the provisions above, a recipient may use your
'\" version of this file under either the License or the GPL.
'\"
'\"
'\" $Header: /cvsroot/aolserver/aolserver/doc/Ns_ConnQuery.3,v 1.2 2006/04/19 17:37:30 jgdavidson Exp $
'\"
'\"
'\" The definitions below are for supplemental macros used in Tcl/Tk
'\" manual entries.
'\"
'\" .AP type name in/out ?indent?
'\" Start paragraph describing an argument to a library procedure.
'\" type is type of argument (int, etc.), in/out is either "in", "out",
'\" or "in/out" to describe whether procedure reads or modifies arg,
'\" and indent is equivalent to second arg of .IP (shouldn't ever be
'\" needed; use .AS below instead)
'\"
'\" .AS ?type? ?name?
'\" Give maximum sizes of arguments for setting tab stops. Type and
'\" name are examples of largest possible arguments that will be passed
'\" to .AP later. If args are omitted, default tab stops are used.
'\"
'\" .BS
'\" Start box enclosure. From here until next .BE, everything will be
'\" enclosed in one large box.
'\"
'\" .BE
'\" End of box enclosure.
'\"
'\" .CS
'\" Begin code excerpt.
'\"
'\" .CE
'\" End code excerpt.
'\"
'\" .VS ?version? ?br?
'\" Begin vertical sidebar, for use in marking newly-changed parts
'\" of man pages. The first argument is ignored and used for recording
'\" the version when the .VS was added, so that the sidebars can be
'\" found and removed when they reach a certain age. If another argument
'\" is present, then a line break is forced before starting the sidebar.
'\"
'\" .VE
'\" End of vertical sidebar.
'\"
'\" .DS
'\" Begin an indented unfilled display.
'\"
'\" .DE
'\" End of indented unfilled display.
'\"
'\" .SO
'\" Start of list of standard options for a Tk widget. The
'\" options follow on successive lines, in four columns separated
'\" by tabs.
'\"
'\" .SE
'\" End of list of standard options for a Tk widget.
'\"
'\" .OP cmdName dbName dbClass
'\" Start of description of a specific option. cmdName gives the
'\" option's name as specified in the class command, dbName gives
'\" the option's name in the option database, and dbClass gives
'\" the option's class in the option database.
'\"
'\" .UL arg1 arg2
'\" Print arg1 underlined, then print arg2 normally.
'\"
'\" RCS: @(#) $Id: man.macros,v 1.1 2006/06/26 00:29:11 jgdavidson Exp $
'\"
'\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
.if t .wh -1.3i ^B
.nr ^l \n(.l
.ad b
'\" # Start an argument description
.de AP
.ie !"\\$4"" .TP \\$4
.el \{\
. ie !"\\$2"" .TP \\n()Cu
. el .TP 15
.\}
.ta \\n()Au \\n()Bu
.ie !"\\$3"" \{\
\&\\$1 \\fI\\$2\\fP (\\$3)
.\".b
.\}
.el \{\
.br
.ie !"\\$2"" \{\
\&\\$1 \\fI\\$2\\fP
.\}
.el \{\
\&\\fI\\$1\\fP
.\}
.\}
..
'\" # define tabbing values for .AP
.de AS
.nr )A 10n
.if !"\\$1"" .nr )A \\w'\\$1'u+3n
.nr )B \\n()Au+15n
.\"
.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
.nr )C \\n()Bu+\\w'(in/out)'u+2n
..
.AS Tcl_Interp Tcl_CreateInterp in/out
'\" # BS - start boxed text
'\" # ^y = starting y location
'\" # ^b = 1
.de BS
.br
.mk ^y
.nr ^b 1u
.if n .nf
.if n .ti 0
.if n \l'\\n(.lu\(ul'
.if n .fi
..
'\" # BE - end boxed text (draw box now)
.de BE
.nf
.ti 0
.mk ^t
.ie n \l'\\n(^lu\(ul'
.el \{\
.\" Draw four-sided box normally, but don't draw top of
.\" box if the box started on an earlier page.
.ie !\\n(^b-1 \{\
\h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
.\}
.el \}\
\h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
.\}
.\}
.fi
.br
.nr ^b 0
..
'\" # VS - start vertical sidebar
'\" # ^Y = starting y location
'\" # ^v = 1 (for troff; for nroff this doesn't matter)
.de VS
.if !"\\$2"" .br
.mk ^Y
.ie n 'mc \s12\(br\s0
.el .nr ^v 1u
..
'\" # VE - end of vertical sidebar
.de VE
.ie n 'mc
.el \{\
.ev 2
.nf
.ti 0
.mk ^t
\h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
.sp -1
.fi
.ev
.\}
.nr ^v 0
..
'\" # Special macro to handle page bottom: finish off current
'\" # box/sidebar if in box/sidebar mode, then invoked standard
'\" # page bottom macro.
.de ^B
.ev 2
'ti 0
'nf
.mk ^t
.if \\n(^b \{\
.\" Draw three-sided box if this is the box's first page,
.\" draw two sides but no top otherwise.
.ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
.el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
.\}
.if \\n(^v \{\
.nr ^x \\n(^tu+1v-\\n(^Yu
\kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
.\}
.bp
'fi
.ev
.if \\n(^b \{\
.mk ^y
.nr ^b 2
.\}
.if \\n(^v \{\
.mk ^Y
.\}
..
'\" # DS - begin display
.de DS
.RS
.nf
.sp
..
'\" # DE - end display
.de DE
.fi
.RE
.sp
..
'\" # SO - start of list of standard options
.de SO
.SH "STANDARD OPTIONS"
.LP
.nf
.ta 5.5c 11c
.ft B
..
'\" # SE - end of list of standard options
.de SE
.fi
.ft R
.LP
See the \\fBoptions\\fR manual entry for details on the standard options.
..
'\" # OP - start of full description for a single option
.de OP
.LP
.nf
.ta 4c
Command-Line Name: \\fB\\$1\\fR
Database Name: \\fB\\$2\\fR
Database Class: \\fB\\$3\\fR
.fi
.IP
..
'\" # CS - begin code excerpt
.de CS
.RS
.nf
.ta .25i .5i .75i 1i
..
'\" # CE - end code excerpt
.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH Ns_ConnGetQuery 3aolserver 4.5 AOLserver "AOLserver Library Procedures"
.BS
'\" Note: do not modify the .SH NAME line immediately below!
.SH NAME
Ns_ConnGetQuery, Ns_ConnClearQuery, Ns_ConnGetFile, Ns_ConnFirstFile, Ns_ConnNextFile \- Routines to access query data included with a connection request
.SH SYNOPSIS
.nf
\fB#include "ns.h"\fR
.sp
Ns_Set *
\fBNs_ConnGetQuery\fR(\fINs_Conn *conn\fR)
.sp
void
\fBNs_ConnClearQuery\fR(\fINs_Conn *conn\fR)
.sp
Ns_ConnFile *
\fBNs_ConnGetFile\fR(\fINs_Conn *conn, char *file\fR)
.sp
Ns_ConnFile *
\fBNs_ConnFirstFile\fR(\fINs_Conn *conn, Tcl_HashSearch *searchPtr\fR)
.sp
Ns_ConnFile *
\fBNs_ConnNextFile\fR(\fINs_Conn *conn, Tcl_HashSearch *searchPtr\fR)
.sp
.SH ARGUMENTS
.AS Tcl_HashSearch *searchPtr in/out
.AP Ns_Conn *conn in
Pointer to given connection.
.AP char *file in
Name of embedded file.
.AP Tcl_HashSearch *searchPtr in/out
Pointer to buffer to maintain state of an active search.
.sp
.BE
.SH DESCRIPTION
.PP
These routines provide access to connection query data, derived
from either URL query arguments (i.e., key/value pairs after the
\fI?\fR in an URL) or via an HTTP POST. The server supports ordinary
URL encoded forms as well as \fImultipart/form-data\fR forms which
may include one or more embedded files.
.PP
As form processing is a common and important aspect of dynamic web
applications, AOLserver provides easy access to the query data
within the core. The parsing occurs on demand and the results are
cached for reuse throughout the connection; there is no need to
copy the returned \fINs_Set\fR or \fINs_ConnFile\fR structure(s).
The results of these routines should be considered read-only.
.TP
Ns_Set *\fBNs_ConnGetQuery\fR(\fIconn\fR)
Returns a pointer to an \fINs_Set\fR with the fields of the connection
query or \fINULL\fR if no valid query was present. The keys and
values are in UTF-8, decoded from the request based on the server
\fIurlencoding\fR config option. Subsequent calls to \fBNs_ConnGetQuery\fR
will return the same set unless the server detects the connection
encoding has changed in which case the previous query is cleared
and a new query result is generated.
.sp
Data for the query is based on any URL query arguments which may
be present (i.e., key/value pairs following the \fI?\fR in the URL).
If there is no URL query data, the server will parse the content
of an HTTP \fBPOST\fI.
.TP
void \fBNs_ConnClearQuery\fR(\fIconn\fR)
Frees the previous parsed query, if any. There is normally no need
to call this routine as it is called automatically at the end of a
connection if necessary. It is normally only called internally
when \fBNs_ConnGetQuery\fI detects the url encoding has been manually
updated for the connection, potentially invalidating the character
encoding on the previous form parsing.
.PP
Ns_ConnFile *\fBNs_ConnGetFile\fR(\fIfile\fR)
Returns the \fINs_ConnFile\fR structure for the given file if present
which includes the following fields:
.sp
.CS
typedef struct Ns_ConnFile {
char *name;
Ns_Set *headers;
off_t offset;
off_t length;
} Ns_ConnFile;
.CE
.sp
The \fIname\fR field is a pointer to a string which matches the
name as provided by the corresponding form \fI\fR tag. The
\fIheaders\fR field is a pointer to an \fINs_Set\fR with the key/value
pairs for the file input meta data, e.g., a \fIContent-Type\fR
header. The \fIoffset\fR and \fIlength\fR fields specfy where
within the content the actual file bytes are located. See the
\fBNs_ConnContent\fR man page for details on accessing the content
bytes either through an in-memory buffer or open temp file.
.PP
\fBNs_ConnFirstFile\fR and \fBNs_ConnNextFile\fR routines
allow you to manage a search through the underlying hash table
of uploaded files.
.SH EXAMPLE
Given the following HTML form:
.sp
.CS
.CE
the following code would dump the form strings and file info to the
server log:
.sp
.CS
void
DumpQuery(Ns_Conn *conn)
{
Ns_Set *query;
Ns_ConnFile *filePtr;
Tcl_HashSearch search;
query = Ns_ConnGetQuery(conn);
if (query != NULL) {
/* Dump key/values of all fields. */
Ns_SetPrint(query);
/* Dump info on each embedded file. */
filePtr = Ns_ConnFirstFile(conn);
while (filePtr != NULL) {
Ns_Log(Notice, "file: %s %d %d", filePtr->name,
filePtr->offset, filePtr->length);
filePtr = Ns_ConnNextFile(conn);
}
}
}
.CE
.SH "SEE ALSO"
Ns_Set(3), Ns_Conn(3), Ns_ConnContent(3), ns_conn(n), ns_parsequery(n)
.SH KEYWORDS
form, query