4288c6c2c7
punctuations outside of the form, as it does with quote punctuations.
So things like this
#, @foo{...}
that required the space to make the @foo read as a scribble form are
now better written as
@#,foo{...}
This changes all such occurrences. (In case you see this change in
your files and are worried that there might be changes: I mechanically
verified that the result of `read'ing the modified files is identical
to the previous version.)
svn: r15111
181 lines
4.7 KiB
Racket
181 lines
4.7 KiB
Racket
#lang scribble/doc
|
|
@(require "common.ss"
|
|
scribble/eval
|
|
(for-label net/cookie
|
|
net/cookie-unit
|
|
net/cookie-sig))
|
|
|
|
@(define cookie-eval (make-base-eval))
|
|
@interaction-eval[#:eval cookie-eval (require net/cookie)]
|
|
|
|
|
|
@title[#:tag "cookie"]{Cookie: HTTP Client Storage}
|
|
|
|
@defmodule[net/cookie]{The @schememodname[net/cookie] library provides
|
|
utilities for using cookies as specified in RFC 2109 @cite["RFC2109"].}
|
|
|
|
@section[#:tag "cookie-procs"]{Functions}
|
|
|
|
@defproc[(cookie? [v any/c]) boolean?]{
|
|
|
|
Returns @scheme[#t] if @scheme[v] represents a cookie, @scheme[#f]
|
|
otherwise.}
|
|
|
|
@defproc[(valid-domain? [v any/c]) boolean?]{
|
|
Returns @scheme[#t] if @scheme[v] represents a valid domain, @scheme[#f] otherwise.
|
|
}
|
|
|
|
@defproc[(set-cookie [name string?] [value string?]) cookie?]{
|
|
|
|
Creates a new cookie, with default values for required fields.}
|
|
|
|
@defproc[(cookie:add-comment [cookie cookie?] [comment string?])
|
|
cookie?]{
|
|
|
|
Modifies @scheme[cookie] with a comment, and also returns
|
|
@scheme[cookie].}
|
|
|
|
@defproc[(cookie:add-domain [cookie cookie?] [domain valid-domain?])
|
|
cookie?]{
|
|
|
|
Modifies @scheme[cookie] with a domain, and also returns
|
|
@scheme[cookie]. The @scheme[domain] must match a prefix of the
|
|
request URI.}
|
|
|
|
@defproc[(cookie:add-max-age [cookie cookie?] [seconds exact-nonnegative-integer?])
|
|
cookie?]{
|
|
|
|
Modifies @scheme[cookie] with a maximum age, and also returns
|
|
@scheme[cookie]. The @scheme[seconds] argument is number of seconds
|
|
that a client should retain the cookie.}
|
|
|
|
@defproc[(cookie:add-path [cookie cookie?] [path valid-path?])
|
|
cookie?]{
|
|
|
|
Modifies @scheme[cookie] with a path, and also returns
|
|
@scheme[cookie].}
|
|
|
|
@defproc[(cookie:secure [cookie cookie?] [secure boolean?])
|
|
cookie?]{
|
|
|
|
Modifies @scheme[cookie] with a security flag, and also returns
|
|
@scheme[cookie].}
|
|
|
|
@defproc[(cookie:version [cookie cookie?] [version exact-nonnegative-integer?])
|
|
cookie?]{
|
|
|
|
Modifies @scheme[cookie] with a version, and also returns
|
|
@scheme[cookie]. The default is the only known incarnation of HTTP
|
|
cookies: @scheme[1].}
|
|
|
|
@defproc[(print-cookie [cookie cookie?]) string?]{
|
|
|
|
Prints @scheme[cookie] to a string. Empty fields do not appear in the
|
|
output except when there is a required default.}
|
|
|
|
|
|
@defproc[(get-cookie [name string?] [cookies string?]) (listof string?)]{
|
|
|
|
Returns a list with all the values (strings) associated with @scheme[name].
|
|
|
|
The method used to obtain the @scheme["Cookie"] header depends on the
|
|
web server. It may be an environment variable (CGI), or you may have
|
|
to read it from the input port (FastCGI), or maybe it comes in an
|
|
initial-request structure, etc. The @scheme[get-cookie] and
|
|
@scheme[get-cookie/single] procedure can be used to extract fields
|
|
from a @scheme["Cookie"] field value.}
|
|
|
|
|
|
@defproc[(get-cookie/single [name string?] [cookies string?]) (or/c string? false/c)]{
|
|
|
|
Like @scheme[get-cookie], but returns the just first value string
|
|
associated to @scheme[name], or #f if no association is found.}
|
|
|
|
|
|
@defstruct[(cookie-error exn:fail) ()]{
|
|
|
|
Raised for errors when handling cookies.}
|
|
|
|
@section[#:tag "cookie-examples"]{Examples}
|
|
|
|
@subsection{Creating a cookie}
|
|
|
|
@schemeblock[
|
|
(let ((c (cookie:add-max-age
|
|
(cookie:add-path
|
|
(set-cookie "foo" "bar")
|
|
"/servlets")
|
|
3600)))
|
|
(print-cookie c))
|
|
]
|
|
|
|
Produces
|
|
|
|
@schemeblock[
|
|
@#,schemeresultfont{"foo=bar; Max-Age=3600; Path=/servlets; Version=1"}
|
|
]
|
|
|
|
To use this output in a ``regular'' CGI, instead of the last line use:
|
|
|
|
@schemeblock[
|
|
(display (format "Set-Cookie: ~a" (print-cookie c)))
|
|
]
|
|
|
|
and to use with the PLT Web Server, use:
|
|
|
|
@schemeblock[
|
|
(make-response/full code message (current-seconds) mime
|
|
(list (make-header #"Set-Cookie" (string->bytes/utf-8 (print-cookie c))))
|
|
body)
|
|
]
|
|
|
|
@subsection{Parsing a cookie}
|
|
|
|
Imagine your Cookie header looks like this:
|
|
|
|
@interaction[
|
|
#:eval cookie-eval
|
|
(define cookies
|
|
"test2=2; test3=3; xfcTheme=theme6; xfcTheme=theme2")
|
|
]
|
|
|
|
Then, to get the values of the xfcTheme cookie, use
|
|
|
|
@interaction[
|
|
#:eval cookie-eval
|
|
(get-cookie "xfcTheme" cookies)
|
|
(get-cookie/single "xfcTheme" cookies)
|
|
]
|
|
|
|
If you try to get a cookie that simply is not there:
|
|
|
|
@interaction[
|
|
#:eval cookie-eval
|
|
(get-cookie/single "foo" cookies)
|
|
(get-cookie "foo" cookies)
|
|
]
|
|
|
|
Note that not having a cookie is normally not an error. Most clients
|
|
won't have a cookie set then first arrive at your site.
|
|
|
|
|
|
@; ----------------------------------------
|
|
|
|
@section{Cookie Unit}
|
|
|
|
@defmodule[net/cookie-unit]
|
|
|
|
@defthing[cookie@ unit?]{
|
|
|
|
Imports nothing, exports @scheme[cookie^].}
|
|
|
|
@; ----------------------------------------
|
|
|
|
@section{Cookie Signature}
|
|
|
|
@defmodule[net/cookie-sig]
|
|
|
|
@defsignature[cookie^ ()]{}
|
|
|
|
Includes everything exported by the @schememodname[net/cookie] module.
|