kibi-swipl-linux-x64-gnu 1.0.0

package/lib/swipl/library/ext/http/http/http_hook.pl

@@ -0,0 +1,106 @@
+/*  Part of SWI-Prolog
+
+    Author:        Jan Wielemaker
+    E-mail:        J.Wielemaker@vu.nl
+    WWW:           http://www.swi-prolog.org
+    Copyright (c)  2008-2015, University of Amsterdam
+    All rights reserved.
+
+    Redistribution and use in source and binary forms, with or without
+    modification, are permitted provided that the following conditions
+    are met:
+
+    1. Redistributions of source code must retain the above copyright
+       notice, this list of conditions and the following disclaimer.
+
+    2. Redistributions in binary form must reproduce the above copyright
+       notice, this list of conditions and the following disclaimer in
+       the documentation and/or other materials provided with the
+       distribution.
+
+    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+    FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+    COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+    INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+    BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+    CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+    LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+    ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+    POSSIBILITY OF SUCH DAMAGE.
+*/
+
+:- module(http_hook,
+          []).
+
+/** <module> HTTP library hooks
+
+Get the declarations of the HTTP package using
+
+    ==
+    :- use_module(library(http/http_hook)).
+    ==
+
+@tbd    This should be using include, but then it cannot be a module
+        and this would cause more overhead in SWI-Prolog
+@tbd    Complete this and document the hooks.
+*/
+
+                 /*******************************
+                 *           HTTP-PATH          *
+                 *******************************/
+
+:- multifile http:location/3.
+:- dynamic   http:location/3.
+
+
+                 /*******************************
+                 *           HTML-WRITE         *
+                 *******************************/
+
+:- multifile
+    html_write:expand//1,
+    html_write:expand_attribute_value//1,
+    html_write:html_head_expansion/2,
+    html_write:layout/3.
+
+
+                 /*******************************
+                 *         HTTP-DISPATCH        *
+                 *******************************/
+
+:- multifile
+    http:authenticate/3.
+
+
+                 /*******************************
+                 *       HTTP-PARAMETERS        *
+                 *******************************/
+
+%!  http:convert_parameter(+Type, +ValueIn, -ValueOut) is semidet.
+%
+%   Hook to execute a step in the HTTP parameter conversion process.
+%
+%   @see http_parameters:check_type/4.
+
+:- multifile
+    http:convert_parameter/3.
+
+
+                 /*******************************
+                 *            PROXIES           *
+                 *******************************/
+
+%!  http:http_connection_over_proxy(+Proxy, +URLParts, +Endpoint,
+%!                                  -StreamPair, +Options, -NewOptions).
+%
+%   Try to connect to the host Endpoint   via Proxy for the purposes
+%   of retrieving the resource  identified   by  URLParts. Different
+%   options can be returned in NewOptions,  which may be required if
+%   you   have   defined   a   non-standard     proxy    method   in
+%   socket:proxy_for_url/3 (such as one requiring authentication)
+
+:- multifile
+    http:http_connection_over_proxy/6.

package/lib/swipl/library/ext/http/http/http_host.pl

@@ -0,0 +1,204 @@
+/*  Part of SWI-Prolog
+
+    Author:        Jan Wielemaker
+    E-mail:        J.Wielemaker@vu.nl
+    WWW:           http://www.swi-prolog.org
+    Copyright (c)  2010-2016, University of Amsterdam,
+                              VU University Amsterdam
+    All rights reserved.
+
+    Redistribution and use in source and binary forms, with or without
+    modification, are permitted provided that the following conditions
+    are met:
+
+    1. Redistributions of source code must retain the above copyright
+       notice, this list of conditions and the following disclaimer.
+
+    2. Redistributions in binary form must reproduce the above copyright
+       notice, this list of conditions and the following disclaimer in
+       the documentation and/or other materials provided with the
+       distribution.
+
+    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+    FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+    COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+    INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+    BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+    CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+    LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+    ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+    POSSIBILITY OF SUCH DAMAGE.
+*/
+
+:- module(http_host,
+          [ http_public_url/2,          % +Request, -PublicURL
+            http_public_host_url/2,     % +Request, -HostURL
+            http_public_host/4,         % +Request, -Host, -Port, +Options
+                                        % deprecated
+            http_current_host/4         % +Request, -Host, -Port, +Options
+          ]).
+:- if(exists_source(library(http/thread_httpd))).
+:- use_module(library(http/thread_httpd)).
+:- endif.
+:- use_module(library(http/http_wrapper)).
+:- use_module(library(socket)).
+:- use_module(library(option)).
+:- use_module(library(settings)).
+
+:- setting(http:public_host, atom, '',
+           'Name the outside world can use to contact me').
+:- setting(http:public_port, integer, 80,
+           'Port on the public server').
+:- setting(http:public_scheme, oneof([http,https]), http,
+           'Default URL scheme to use').
+
+:- predicate_options(http_public_host/4, 4, [global(boolean)]).
+:- predicate_options(http_current_host/4, 4,
+                     [pass_to(http_public_host/4, 4)]).
+
+/** <module> Obtain public server location
+
+This library finds the public address of the running server. This can be
+used to construct URLs that are visible   from anywhere on the internet.
+This module was introduced to  deal  with  OpenID,  where  a  request is
+redirected to the OpenID server, which in   turn redirects to our server
+(see http_openid.pl).
+
+The address is  established  from   the  settings `http:public_host` and
+`http:public_port` if provided. Otherwise it is deduced from the request.
+*/
+
+%!  http_public_url(+Request, -URL) is det.
+%
+%   True when URL is  an  absolute   URL  for  the  current request.
+%   Typically, the login page should redirect   to this URL to avoid
+%   losing the session.
+
+http_public_url(Request, URL) :-
+    http_public_host_url(Request, HostURL),
+    option(request_uri(RequestURI), Request),
+    atomic_list_concat([HostURL, RequestURI], URL).
+
+
+%!  http_public_host_url(+Request, -URL) is det.
+%
+%   True when URL is the public  URL   at  which  this server can be
+%   contacted.   This   value   is   not   easy   to   obtain.   See
+%   http_public_host/4 for the hardest  part:   find  the  host and
+%   port.
+
+http_public_host_url(Request, URL) :-
+    http_public_host(Request, Host, Port,
+                      [ global(true)
+                      ]),
+    setting(http:public_scheme, Scheme),
+    (   scheme_port(Scheme, Port)
+    ->  format(atom(URL), '~w://~w', [Scheme, Host])
+    ;   format(atom(URL), '~w://~w:~w', [Scheme, Host, Port])
+    ).
+
+scheme_port(http, 80).
+scheme_port(https, 443).
+
+%!  http_public_host(?Request, -Hostname, -Port, +Options) is det.
+%
+%   Current global host and port of the HTTP server.  This is the
+%   basis to form absolute address, which we need for redirection
+%   based interaction such as the OpenID protocol.  Options are:
+%
+%     * global(+Bool)
+%     If =true= (default =false=), try to replace a local hostname
+%     by a world-wide accessible name.
+%
+%   This predicate performs the following steps to find the host and
+%   port:
+%
+%     1. Use the settings =http:public_host= and =http:public_port=
+%     2. Use =X-Forwarded-Host= header, which applies if this server
+%        runs behind a proxy.
+%     3. Use the =Host= header, which applies for HTTP 1.1 if we are
+%        contacted directly.
+%     4. Use gethostname/1 to find the host and
+%        http_current_server/2 to find the port.
+%
+%   @param  Request is the current request.  If it is left unbound,
+%           and the request is needed, it is obtained with
+%           http_current_request/1.
+
+http_public_host(_Request, Host, Port, _) :-
+    setting(http:public_host, PublicHost), PublicHost \== '',
+    !,
+    Host = PublicHost,
+    setting(http:public_port, Port).
+http_public_host(Request, Host, Port, Options) :-
+    (   var(Request)
+    ->  http_current_request(Request)
+    ;   true
+    ),
+    (   memberchk(x_forwarded_host(Forwarded), Request)
+    ->  Port = 80,
+        primary_forwarded_host(Forwarded, Host)
+    ;   memberchk(host(Host0), Request),
+        (   option(global(true), Options, false)
+        ->  global_host(Host0, Host)
+        ;   Host = Host0
+        ),
+        option(port(Port), Request, 80)
+    ),
+    !.
+:- if(current_predicate(http_current_server/2)).
+http_public_host(_Request, Host, Port, _Options) :-
+    gethostname(Host),
+    http_current_server(_:_Pred, Port).
+:- endif.
+
+%!  http_current_host(?Request, -Hostname, -Port, +Options) is det.
+%
+%   @deprecated     Use http_public_host/4 (same semantics)
+
+http_current_host(Request, Hostname, Port, Options) :-
+    http_public_host(Request, Hostname, Port, Options).
+
+%!  primary_forwarded_host(+Spec, -Host) is det.
+%
+%   x_forwarded host contains multiple hosts separated   by  ', ' if
+%   there are multiple proxy servers in   between.  The first one is
+%   the one the user's browser knows about.
+
+primary_forwarded_host(Spec, Host) :-
+    sub_atom(Spec, B, _, _, ','),
+    !,
+    sub_atom(Spec, 0, B, _, Host).
+primary_forwarded_host(Host, Host).
+
+
+%!  global_host(+HostIn, -Host)
+%
+%   Globalize a hostname. Used if we need  to pass our hostname to a
+%   client and expect the client to be   able to contact us. In this
+%   case we cannot use a  name  such   as  `localhost'  or the plain
+%   hostname of the machine. We assume   (possibly  wrongly) that if
+%   the host contains a '.', it is globally accessible.
+%
+%   If the heuristics used by  this   predicate  do not suffice, the
+%   setting http:public_host can be used to override.
+
+global_host(_, Host) :-
+    setting(http:public_host, PublicHost), PublicHost \== '',
+    !,
+    Host = PublicHost.
+global_host(localhost, Host) :-
+    !,
+    gethostname(Host).
+global_host(Local, Host) :-
+    sub_atom(Local, _, _, _, '.'),
+    !,
+    Host = Local.
+global_host(Local, Host) :-
+    tcp_host_to_address(Local, IP),
+    tcp_host_to_address(Host, IP).
+
+

package/lib/swipl/library/ext/http/http/http_load.pl

@@ -0,0 +1,113 @@
+/*  Part of SWI-Prolog
+
+    Author:        Jan Wielemaker
+    E-mail:        J.Wielemaker@vu.nl
+    WWW:           http://www.swi-prolog.org
+    Copyright (c)  2013, VU University Amsterdam
+    All rights reserved.
+
+    Redistribution and use in source and binary forms, with or without
+    modification, are permitted provided that the following conditions
+    are met:
+
+    1. Redistributions of source code must retain the above copyright
+       notice, this list of conditions and the following disclaimer.
+
+    2. Redistributions in binary form must reproduce the above copyright
+       notice, this list of conditions and the following disclaimer in
+       the documentation and/or other materials provided with the
+       distribution.
+
+    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+    FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+    COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+    INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+    BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+    CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+    LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+    ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+    POSSIBILITY OF SUCH DAMAGE.
+*/
+
+:- module(prolog_http_load, []).
+:- use_module(library(http/http_open)).
+:- use_module(library(uri)).
+
+:- multifile
+    user:prolog_load_file/2.
+
+/** <module> Load Prolog code from a web server
+
+This module provides a hook into load_files/2 that allows loading Prolog
+code from HTTP and HTTPS servers.  Below is an example session:
+
+  ==
+  ?- [library(http/http_load)].
+  ...
+  true.
+  ?- ['http://www.swi-prolog.org/download/demo/likes'].
+  % http://www.swi-prolog.org/download/demo/likes.pl compiled 0.00 sec, 17 clauses
+  true.
+  ==
+
+*Warning* Loading code from untrusted HTTP resources may compromise your
+security.
+*/
+
+%!  user:prolog_load_file(+URL, +Options)
+%
+%   Hook into load_files/2  that  loads   =|http://|=  and  =|https://|=
+%   resources directly from the web. Options  are passed to load_files/2
+%   and http_open/2.
+
+user:prolog_load_file(Spec, Options) :-
+    strip_module(Spec, Module, URL),
+    atom(URL),
+    (   is_http_url(URL)
+    ->  GlobalURL = URL
+    ;   prolog_load_context(file, Parent),
+        is_http_url(Parent),
+        uri_resolve(URL, Parent, GlobalURL)
+    ),
+    ensure_extension(GlobalURL, pl, FinalURL),
+    setup_call_cleanup(
+        http_open(FinalURL, In, Options),
+        load_files(Module:FinalURL, [stream(In)|Options]),
+        close(In)).
+
+is_http_url(URL) :-
+    uri_is_global(URL),
+    uri_components(URL, Components),
+    uri_data(scheme, Components, Scheme),
+    nonvar(Scheme),
+    http_scheme(Scheme).
+
+http_scheme(http).
+http_scheme(https) :-
+    exists_source(library(http/http_ssl_plugin)).
+
+%!  ensure_extension(+URL, +Ext, -PlParts)
+%
+%   If the HTTP location is a plain path without extension, add the
+%   .pl extension. This ensures extension-less files appearing in
+%   file-loading directives are processed correctly.
+
+ensure_extension(URL0, Ext, URL) :-
+    uri_components(URL0, Components0),
+    uri_data(path, Components0, Path0),
+    ensure_path_extension(Path0, Ext, Path),
+    (   Path0 == Path
+    ->  URL = URL0
+    ;   uri_data(path, Components0, Path, Components),
+        uri_components(URL, Components)
+    ).
+
+ensure_path_extension(Path0, Ext, Path) :-
+    file_name_extension(Base, '', Path0),
+    !,
+    file_name_extension(Base, Ext, Path).
+ensure_path_extension(Path, _, Path).
+