The rfc2388 Reference Manual

Table of Contents

The rfc2388 Reference Manual

This is the rfc2388 Reference Manual, version 1.5, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 14:54:54 2020 GMT+0.

1 Introduction

This package contains an implementation of RFC 2388, which is used to process form data posted with HTTP POST method using enctype "multipart/form-data".

The main functions of interest are PARSE-MIME and PARSE-HEADER.

Use PARSE-MIME to parse MIME content. It can be given either a string or a stream. It returns a list of MIME parts. The second argument must be a boundary, which is a string that seperates MIME parts. See below how to obtain it.

PARSE-HEADER is used by PARSE-MIME internally, but you can use it to parse headers yourself. For instance, when data is posted to server using POST method, a header describing the content type is sent as well. Usually its content is application/x-www-form-urlencoded or something similar. But users may set it to multipart/form-data, with additional parameter named "boundary". This is how one would usually parse the posted data:

(let* ((header (parse-header <request-content-type> :value))
       (boundary (or (assoc "boundary" (header-parameters header)
                            :test #'string-equal)
                     (error "Form data is missing a boundary: ~S"
                            <request-content-type>))))
  (parse-mime <request-posted-content> boundary))

The :VALUE keyword parameter to PARSE-HEADER means that parsing should begin with header value, not name (because header name is "content-type" and the web server has already seperated them, at least in this scenario).

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 rfc2388

Author

Janis Dzerins <jonis@latnet.lv>

License

Simplified BSD

Description

Implementation of RFC 2388

Long Description

Contains an implementation of RFC 2388, which is used to process form data posted with HTTP POST method using enctype "multipart/form-data".

Version

1.5

Source

rfc2388.asd (file)

Components

• rfc2388.asd (file)
• rfc2388.lisp (file)
• packages.lisp (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 rfc2388.asd

Location

rfc2388.asd

Systems

rfc2388 (system)

3.1.2 rfc2388/rfc2388.lisp

Dependency

packages.lisp (file)

Parent

rfc2388 (system)

Location

rfc2388.lisp

Exported Definitions

• content-type (function)
• find-content-disposition-header (function)
• find-header (function)
• find-parameter (function)
• get-file-name (function)
• header-name (function)
• (setf header-name) (function)
• header-parameters (function)
• (setf header-parameters) (function)
• header-value (function)
• (setf header-value) (function)
• make-mime-part (function)
• mime-part-contents (function)
• (setf mime-part-contents) (function)
• mime-part-headers (function)
• (setf mime-part-headers) (function)
• parse-header (generic function)
• parse-header (method)
• parse-header (method)
• parse-mime (generic function)
• parse-mime (method)
• parse-mime (method)

Internal Definitions

• content-type-sub (function)
• (setf content-type-sub) (function)
• content-type-super (function)
• (setf content-type-super) (function)
• lwsp-char-p (function)
• make-content-type (function)
• make-header (function)
• make-tmp-file-name (function)
• parse-content-type (function)
• read-until-next-boundary (function)
• skip-linear-whitespace (function)
• unparse-content-type (function)

3.1.3 rfc2388/packages.lisp

Parent

rfc2388 (system)

Location

packages.lisp

Packages

rfc2388

3.2 Static

3.2.1 rfc2388/rfc2388.asd

Parent

rfc2388 (system)

Location

rfc2388.asd

4 Packages

Packages are listed by definition order.

4.1 rfc2388

Source

packages.lisp (file)

Use List

common-lisp

Exported Definitions

• content-type (function)
• find-content-disposition-header (function)
• find-header (function)
• find-parameter (function)
• get-file-name (function)
• header-name (function)
• (setf header-name) (function)
• header-parameters (function)
• (setf header-parameters) (function)
• header-value (function)
• (setf header-value) (function)
• make-mime-part (function)
• mime-part-contents (function)
• (setf mime-part-contents) (function)
• mime-part-headers (function)
• (setf mime-part-headers) (function)
• parse-header (generic function)
• parse-header (method)
• parse-header (method)
• parse-mime (generic function)
• parse-mime (method)
• parse-mime (method)

Internal Definitions

• content-type-sub (function)
• (setf content-type-sub) (function)
• content-type-super (function)
• (setf content-type-super) (function)
• copy-content-type (function)
• copy-header (function)
• copy-mime-part (function)
• lwsp-char-p (function)
• make-content-type (function)
• make-header (function)
• make-tmp-file-name (function)
• parse-content-type (function)
• read-until-next-boundary (function)
• skip-linear-whitespace (function)
• unparse-content-type (function)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Functions

Function: content-type PART &key AS-STRING

Returns the Content-Type header of mime-part PART.

Package

rfc2388

Source

rfc2388.lisp (file)

Function: find-content-disposition-header HEADERS

Package

rfc2388

Source

rfc2388.lisp (file)

Function: find-header LABEL HEADERS

Find header by label from set of headers.

Package

rfc2388

Source

rfc2388.lisp (file)

Function: find-parameter NAME PARAMS

Find header parameter by name from set of parameters.

Package

rfc2388

Source

rfc2388.lisp (file)

Function: get-file-name HEADERS

Package

rfc2388

Source

rfc2388.lisp (file)

Function: header-name STRUCTURE

Function: (setf header-name) VALUE STRUCTURE

Package

rfc2388

Source

rfc2388.lisp (file)

Function: header-parameters STRUCTURE

Function: (setf header-parameters) VALUE STRUCTURE

Package

rfc2388

Source

rfc2388.lisp (file)

Function: header-value STRUCTURE

Function: (setf header-value) VALUE STRUCTURE

Package

rfc2388

Source

rfc2388.lisp (file)

Function: make-mime-part CONTENTS HEADERS

Package

rfc2388

Source

rfc2388.lisp (file)

Function: mime-part-contents STRUCTURE

Function: (setf mime-part-contents) VALUE STRUCTURE

Package

rfc2388

Source

rfc2388.lisp (file)

Function: mime-part-headers STRUCTURE

Function: (setf mime-part-headers) VALUE STRUCTURE

Package

rfc2388

Source

rfc2388.lisp (file)

5.1.2 Generic functions

Generic Function: parse-header SOURCE &optional START-STATE

Parses SOURCE and returs a single MIME header.

Header is a list of the form (NAME VALUE PARAMETERS), PARAMETERS is a list of (NAME . VALUE)

Package

rfc2388

Source

rfc2388.lisp (file)

Methods

Method: parse-header (STREAM stream) &optional START-STATE

Returns a MIME part header, or NIL, if there is no header. Header is terminated by CRLF.

Method: parse-header (SOURCE string) &optional START-STATE

Generic Function: parse-mime SOURCE BOUNDARY &key WRITE-CONTENT-TO-FILE

Parses MIME entities, returning them as a list. Each element in the list is of form: (body headers), where BODY is the contents of MIME part, and HEADERS are all headers for that part. BOUNDARY is a string used to separate MIME entities.

Package

rfc2388

Source

rfc2388.lisp (file)

Methods

Method: parse-mime (INPUT stream) BOUNDARY &key WRITE-CONTENT-TO-FILE

Method: parse-mime (INPUT string) SEPARATOR &key WRITE-CONTENT-TO-FILE

5.2 Internal definitions

5.2.1 Functions

Function: content-type-sub STRUCTURE

Function: (setf content-type-sub) VALUE STRUCTURE

Package

rfc2388

Source

rfc2388.lisp (file)

Function: content-type-super STRUCTURE

Function: (setf content-type-super) VALUE STRUCTURE

Package

rfc2388

Source

rfc2388.lisp (file)

Function: copy-content-type SEQUENCE

Return a copy of SEQUENCE which is EQUAL to SEQUENCE but not EQ.

Package

rfc2388

Source

SYS:SRC;CODE;SEQ.LISP (not found)

Function: copy-header SEQUENCE

Return a copy of SEQUENCE which is EQUAL to SEQUENCE but not EQ.

Package

rfc2388

Source

SYS:SRC;CODE;SEQ.LISP (not found)

Function: copy-mime-part SEQUENCE

Return a copy of SEQUENCE which is EQUAL to SEQUENCE but not EQ.

Package

rfc2388

Source

SYS:SRC;CODE;SEQ.LISP (not found)

Function: lwsp-char-p CHAR

Returns true if CHAR is a linear-whitespace-char (LWSP-char). Either space or tab, in short.

Package

rfc2388

Source

rfc2388.lisp (file)

Function: make-content-type SUPER SUB

Package

rfc2388

Source

rfc2388.lisp (file)

Function: make-header NAME VALUE PARAMETERS

Package

rfc2388

Source

rfc2388.lisp (file)

Function: make-tmp-file-name ()

Package

rfc2388

Source

rfc2388.lisp (file)

Function: parse-content-type STRING

Returns content-type which is parsed from STRING.

Package

rfc2388

Source

rfc2388.lisp (file)

Function: read-until-next-boundary STREAM BOUNDARY &optional DISCARD OUT-STREAM

Reads from STREAM up to the next boundary. Returns two values: read data (nil if DISCARD is true), and true if the boundary is not last (i.e., there’s more data).

Package

rfc2388

Source

rfc2388.lisp (file)

Function: skip-linear-whitespace STRING &key START END

Returns the position of first non-linear-whitespace character in STRING bound by START and END.

Package

rfc2388

Source

rfc2388.lisp (file)

Function: unparse-content-type CT

Returns content-type CT in string representation.

Package

rfc2388

Source

rfc2388.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types