View source with raw comments or as raw
   1/*  Part of SWI-Prolog
   2
   3    Author:        Jan Wielemaker
   4    E-mail:        J.Wielemaker@vu.nl
   5    WWW:           http://www.swi-prolog.org
   6    Copyright (c)  2000-2011, University of Amsterdam
   7    All rights reserved.
   8
   9    Redistribution and use in source and binary forms, with or without
  10    modification, are permitted provided that the following conditions
  11    are met:
  12
  13    1. Redistributions of source code must retain the above copyright
  14       notice, this list of conditions and the following disclaimer.
  15
  16    2. Redistributions in binary form must reproduce the above copyright
  17       notice, this list of conditions and the following disclaimer in
  18       the documentation and/or other materials provided with the
  19       distribution.
  20
  21    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  24    FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  25    COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  26    INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  27    BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  28    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  29    CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30    LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  31    ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  32    POSSIBILITY OF SUCH DAMAGE.
  33*/
  34
  35:- module(cgi,
  36          [ cgi_get_form/1              % -ListOf Name(Value)
  37          ]).
  38:- use_module(library(shlib)).
  39
  40:- use_foreign_library(foreign(cgi), install_cgi).
  41
  42/** <module> Read CGI parameters
  43
  44Below is a very simple CGI script  that prints the passed parameters. To
  45test it, compile this program using the   command below, copy it to your
  46cgi-bin directory (or make it otherwise known  as a CGI-script) and try
  47the query =|http://myhost.mydomain/cgi-bin/cgidemo?hello=world|=
  48
  49    ==
  50    % swipl -o cgidemo --goal=main --toplevel=halt -c cgidemo.pl
  51    ==
  52
  53    ==
  54    :- use_module(library(cgi)).
  55
  56    main :-
  57        set_stream(current_output, encoding(utf8)),
  58        cgi_get_form(Arguments),
  59        format('Content-type: text/html; charset=UTF-8~n~n', []),
  60        format('<html>~n', []),
  61        format('<head>~n', []),
  62        format('<title>Simple SWI-Prolog CGI script</title>~n', []),
  63        format('</head>~n~n', []),
  64        format('<body>~n', []),
  65        format('<p>', []),
  66        print_args(Arguments),
  67        format('</body>~n</html>~n', []).
  68
  69    print_args([]).
  70    print_args([A0|T]) :-
  71        A0 =.. [Name, Value],
  72        format('<b>~w</b>=<em>~w</em><br>~n', [Name, Value]),
  73        print_args(T).
  74    ==
  75*/
  76
  77%!  cgi_get_form(-Form)
  78%
  79%   Decodes standard input and the environment variables to obtain a
  80%   list of arguments passed to the  CGI script. This predicate both
  81%   deals with the CGI *GET* method as well as the *POST* method. If
  82%   the data cannot be  obtained,   an  existence_error exception is
  83%   raised.
  84%
  85%   @param Form is a list of Name(Value) terms.