http_multipart_plugin.pl -- Multipart form-data plugin

This plugin for library(http_client) automatically translates messages with content-type multipart/form-data into a list of Name = Value pairs, greatly simplifying the processing of forms with this type.

After loading this plugin, multipart form-data can be accessed through http_parameters/3 from library(http/http_parameters) or http_read_data/3 from library(http/http_client).

 http_client:http_convert_data(+In, +Fields, -Data, +Options) is semidet[multifile]

Convert multipart/form-data messages for http_read_data/3. This plugin adds the folling options to http_read_data/3:

form_data(+AsForm)

If the content-type is multipart/form-data, return the form-data either in one of the following formats:

AsForm=form

A list of Name=Value, where Value is an atom.

AsForm=mime

A list of mime(Properties, Value, []). This is a backward compatibility mode, emulating library(http/http_mime_plugin). Note that if the disposition contains a filename property, the data is read as binary unless there is a charset parameter in the Content-Type stating otherwise, while the old library would use UTF-8 for text files.

input_encoding(+Encoding)

Encoding to be used for parts that have no filename disposition and no Content-Type with a charset indication. This is typically the case for input widgets and browsers encode this using the encoding of the page. As the SWI-Prolog http library emits pages in UTF-8, the default is utf8.

on_filename(:CallBack)

If a part with a filename disposition is found and this option is given, call CallBack as below. Stream is the multipart input stream, which has octet (raw) encoding. Value is returned as result. Note that the callback may wish to save the result into a file and return e.g., file(Path) to indicate where the file was saved.

call(:CallBack, +Stream, -Value, +Options).

The Options list contains information from the part header. It always contains name(Name) and filename(FileName). It may contain a term media(Type/SubType, Params) if the part contains a Content-Type header.

 multipart_type(+Type, -Boundary) is semidet[private]

True if Type is of the form multipart/form-data; boundary="..." and Boundary is a string describing the boundary.

 part_header(+PartHeader, -Params, -Name, -Encoding) is det[private]

Extract the form-field Name, the content Encoding and possible other properties of the form-field. Extra properties are:

• filename(Name)
• media(Type/SubType, MediaParams)

 part_value(+Stream, +Name, +Params, +Encoding, -Part, +Options)[private]