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)  2012-2021, VU University Amsterdam
    7                              CWI, Amsterdam
    8                              SWI-Prolog Solutions b.v.
    9    All rights reserved.
   10
   11    Redistribution and use in source and binary forms, with or without
   12    modification, are permitted provided that the following conditions
   13    are met:
   14
   15    1. Redistributions of source code must retain the above copyright
   16       notice, this list of conditions and the following disclaimer.
   17
   18    2. Redistributions in binary form must reproduce the above copyright
   19       notice, this list of conditions and the following disclaimer in
   20       the documentation and/or other materials provided with the
   21       distribution.
   22
   23    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
   24    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
   25    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
   26    FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
   27    COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
   28    INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
   29    BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
   30    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
   31    CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
   32    LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
   33    ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
   34    POSSIBILITY OF SUCH DAMAGE.
   35*/
   36
   37:- module(prolog_pack,
   38          [ pack_list_installed/0,
   39            pack_info/1,                % +Name
   40            pack_list/1,                % +Keyword
   41            pack_search/1,              % +Keyword
   42            pack_install/1,             % +Name
   43            pack_install/2,             % +Name, +Options
   44            pack_upgrade/1,             % +Name
   45            pack_rebuild/1,             % +Name
   46            pack_rebuild/0,             % All packages
   47            pack_remove/1,              % +Name
   48            pack_property/2,            % ?Name, ?Property
   49            pack_attach/2,              % +Dir, +Options
   50
   51            pack_url_file/2             % +URL, -File
   52          ]).   53:- use_module(library(apply)).   54:- use_module(library(error)).   55:- use_module(library(option)).   56:- use_module(library(readutil)).   57:- use_module(library(lists)).   58:- use_module(library(filesex)).   59:- use_module(library(xpath)).   60:- use_module(library(settings)).   61:- use_module(library(uri)).   62:- use_module(library(dcg/basics)).   63:- use_module(library(http/http_open)).   64:- use_module(library(http/json)).   65:- use_module(library(http/http_client), []).   % plugin for POST support
   66:- use_module(library(prolog_config)).   67:- use_module(library(debug), [assertion/1]).   68:- use_module(library(pairs), [group_pairs_by_key/2]).   69% Stuff we may not have and may not need
   70:- autoload(library(git)).   71:- autoload(library(sgml)).   72:- autoload(library(sha)).   73:- autoload(library(build/tools)).

  107:- multifile
  108    environment/2.                          % Name, Value
  109
  110:- dynamic
  111    pack_requires/2,                        % Pack, Requirement
  112    pack_provides_db/2.                     % Pack, Provided
  113
  114
  115                 /*******************************
  116                 *          CONSTANTS           *
  117                 *******************************/
  118
  119:- setting(server, atom, 'https://www.swi-prolog.org/pack/',
  120           'Server to exchange pack information').  121
  122
  123                 /*******************************
  124                 *         PACKAGE INFO         *
  125                 *******************************/

 current_pack(?Pack) is nondet

 current_pack(?Pack, ?Dir) is nondet

True if Pack is a currently installed pack.

  132current_pack(Pack) :-
  133    current_pack(Pack, _).
  134
  135current_pack(Pack, Dir) :-
  136    '$pack':pack(Pack, Dir).

 pack_list_installed is det

List currently installed packages. Unlike pack_list/1, only locally installed packages are displayed and no connection is made to the internet.

See also

- Use pack_list/1 to find packages.

  146pack_list_installed :-
  147    findall(Pack, current_pack(Pack), Packages0),
  148    Packages0 \== [],
  149    !,
  150    sort(Packages0, Packages),
  151    length(Packages, Count),
  152    format('Installed packages (~D):~n~n', [Count]),
  153    maplist(pack_info(list), Packages),
  154    validate_dependencies.
  155pack_list_installed :-
  156    print_message(informational, pack(no_packages_installed)).

 pack_info(+Pack)

Print more detailed information about Pack.

  162pack_info(Name) :-
  163    pack_info(info, Name).
  164
  165pack_info(Level, Name) :-
  166    must_be(atom, Name),
  167    findall(Info, pack_info(Name, Level, Info), Infos0),
  168    (   Infos0 == []
  169    ->  print_message(warning, pack(no_pack_installed(Name))),
  170        fail
  171    ;   true
  172    ),
  173    update_dependency_db(Name, Infos0),
  174    findall(Def,  pack_default(Level, Infos, Def), Defs),
  175    append(Infos0, Defs, Infos1),
  176    sort(Infos1, Infos),
  177    show_info(Name, Infos, [info(Level)]).
  178
  179
  180show_info(_Name, _Properties, Options) :-
  181    option(silent(true), Options),
  182    !.
  183show_info(Name, Properties, Options) :-
  184    option(info(list), Options),
  185    !,
  186    memberchk(title(Title), Properties),
  187    memberchk(version(Version), Properties),
  188    format('i ~w@~w ~28|- ~w~n', [Name, Version, Title]).
  189show_info(Name, Properties, _) :-
  190    !,
  191    print_property_value('Package'-'~w', [Name]),
  192    findall(Term, pack_level_info(info, Term, _, _), Terms),
  193    maplist(print_property(Properties), Terms).
  194
  195print_property(_, nl) :-
  196    !,
  197    format('~n').
  198print_property(Properties, Term) :-
  199    findall(Term, member(Term, Properties), Terms),
  200    Terms \== [],
  201    !,
  202    pack_level_info(_, Term, LabelFmt, _Def),
  203    (   LabelFmt = Label-FmtElem
  204    ->  true
  205    ;   Label = LabelFmt,
  206        FmtElem = '~w'
  207    ),
  208    multi_valued(Terms, FmtElem, FmtList, Values),
  209    atomic_list_concat(FmtList, ', ', Fmt),
  210    print_property_value(Label-Fmt, Values).
  211print_property(_, _).
  212
  213multi_valued([H], LabelFmt, [LabelFmt], Values) :-
  214    !,
  215    H =.. [_|Values].
  216multi_valued([H|T], LabelFmt, [LabelFmt|LT], Values) :-
  217    H =.. [_|VH],
  218    append(VH, MoreValues, Values),
  219    multi_valued(T, LabelFmt, LT, MoreValues).
  220
  221
  222pvalue_column(24).
  223print_property_value(Prop-Fmt, Values) :-
  224    !,
  225    pvalue_column(C),
  226    atomic_list_concat(['~w:~t~*|', Fmt, '~n'], Format),
  227    format(Format, [Prop,C|Values]).
  228
  229pack_info(Name, Level, Info) :-
  230    '$pack':pack(Name, BaseDir),
  231    (   Info = directory(BaseDir)
  232    ;   pack_info_term(BaseDir, Info)
  233    ),
  234    pack_level_info(Level, Info, _Format, _Default).
  235
  236:- public pack_level_info/4.                    % used by web-server
  237
  238pack_level_info(_,    title(_),         'Title',                   '<no title>').
  239pack_level_info(_,    version(_),       'Installed version',       '<unknown>').
  240pack_level_info(info, directory(_),     'Installed in directory',  -).
  241pack_level_info(info, author(_, _),     'Author'-'~w <~w>',        -).
  242pack_level_info(info, maintainer(_, _), 'Maintainer'-'~w <~w>',    -).
  243pack_level_info(info, packager(_, _),   'Packager'-'~w <~w>',      -).
  244pack_level_info(info, home(_),          'Home page',               -).
  245pack_level_info(info, download(_),      'Download URL',            -).
  246pack_level_info(_,    provides(_),      'Provides',                -).
  247pack_level_info(_,    requires(_),      'Requires',                -).
  248pack_level_info(_,    conflicts(_),     'Conflicts with',          -).
  249pack_level_info(_,    replaces(_),      'Replaces packages',       -).
  250pack_level_info(info, library(_),	'Provided libraries',      -).
  251
  252pack_default(Level, Infos, Def) :-
  253    pack_level_info(Level, ITerm, _Format, Def),
  254    Def \== (-),
  255    \+ memberchk(ITerm, Infos).

 pack_info_term(+PackDir, ?Info) is nondet

True when Info is meta-data for the package PackName.

  261pack_info_term(BaseDir, Info) :-
  262    directory_file_path(BaseDir, 'pack.pl', InfoFile),
  263    catch(
  264        setup_call_cleanup(
  265            open(InfoFile, read, In),
  266            term_in_stream(In, Info),
  267            close(In)),
  268        error(existence_error(source_sink, InfoFile), _),
  269        ( print_message(error, pack(no_meta_data(BaseDir))),
  270          fail
  271        )).
  272pack_info_term(BaseDir, library(Lib)) :-
  273    atom_concat(BaseDir, '/prolog/', LibDir),
  274    atom_concat(LibDir, '*.pl', Pattern),
  275    expand_file_name(Pattern, Files),
  276    maplist(atom_concat(LibDir), Plain, Files),
  277    convlist(base_name, Plain, Libs),
  278    member(Lib, Libs).
  279
  280base_name(File, Base) :-
  281    file_name_extension(Base, pl, File).
  282
  283term_in_stream(In, Term) :-
  284    repeat,
  285        read_term(In, Term0, []),
  286        (   Term0 == end_of_file
  287        ->  !, fail
  288        ;   Term = Term0,
  289            valid_info_term(Term0)
  290        ).
  291
  292valid_info_term(Term) :-
  293    Term =.. [Name|Args],
  294    same_length(Args, Types),
  295    Decl =.. [Name|Types],
  296    (   pack_info_term(Decl)
  297    ->  maplist(valid_info_arg, Types, Args)
  298    ;   print_message(warning, pack(invalid_info(Term))),
  299        fail
  300    ).
  301
  302valid_info_arg(Type, Arg) :-
  303    must_be(Type, Arg).

 pack_info_term(?Term) is nondet

True when Term describes name and arguments of a valid package info term.

  310pack_info_term(name(atom)).                     % Synopsis
  311pack_info_term(title(atom)).
  312pack_info_term(keywords(list(atom))).
  313pack_info_term(description(list(atom))).
  314pack_info_term(version(version)).
  315pack_info_term(author(atom, email_or_url_or_empty)).     % Persons
  316pack_info_term(maintainer(atom, email_or_url)).
  317pack_info_term(packager(atom, email_or_url)).
  318pack_info_term(pack_version(nonneg)).           % Package convention version
  319pack_info_term(home(atom)).                     % Home page
  320pack_info_term(download(atom)).                 % Source
  321pack_info_term(provides(atom)).                 % Dependencies
  322pack_info_term(requires(dependency)).
  323pack_info_term(conflicts(dependency)).          % Conflicts with package
  324pack_info_term(replaces(atom)).                 % Replaces another package
  325pack_info_term(autoload(boolean)).              % Default installation options
  326
  327:- multifile
  328    error:has_type/2.  329
  330error:has_type(version, Version) :-
  331    atom(Version),
  332    version_data(Version, _Data).
  333error:has_type(email_or_url, Address) :-
  334    atom(Address),
  335    (   sub_atom(Address, _, _, _, @)
  336    ->  true
  337    ;   uri_is_global(Address)
  338    ).
  339error:has_type(email_or_url_or_empty, Address) :-
  340    (   Address == ''
  341    ->  true
  342    ;   error:has_type(email_or_url, Address)
  343    ).
  344error:has_type(dependency, Value) :-
  345    is_dependency(Value, _Token, _Version).
  346
  347version_data(Version, version(Data)) :-
  348    atomic_list_concat(Parts, '.', Version),
  349    maplist(atom_number, Parts, Data).
  350
  351is_dependency(Token, Token, *) :-
  352    atom(Token).
  353is_dependency(Term, Token, VersionCmp) :-
  354    Term =.. [Op,Token,Version],
  355    cmp(Op, _),
  356    version_data(Version, _),
  357    VersionCmp =.. [Op,Version].
  358
  359cmp(<,  @<).
  360cmp(=<, @=<).
  361cmp(==, ==).
  362cmp(>=, @>=).
  363cmp(>,  @>).
  364
  365
  366                 /*******************************
  367                 *            SEARCH            *
  368                 *******************************/

 pack_search(+Query) is det

 pack_list(+Query) is det

Query package server and installed packages and display results. Query is matches case-insensitively against the name and title of known and installed packages. For each matching package, a single line is displayed that provides:

• Installation status
  • p: package, not installed
  • i: installed package; up-to-date with public version
  • U: installed package; can be upgraded
  • A: installed package; newer than publically available
  • l: installed package; not on server
• Name@Version
• Name@Version(ServerVersion)
• Title

Hint: ?- pack_list(''). lists all packages.

The predicates pack_list/1 and pack_search/1 are synonyms. Both contact the package server at http://www.swi-prolog.org to find available packages.

See also

- pack_list_installed/0 to list installed packages without contacting the server.

  397pack_list(Query) :-
  398    pack_search(Query).
  399
  400pack_search(Query) :-
  401    query_pack_server(search(Query), Result, []),
  402    (   Result == false
  403    ->  (   local_search(Query, Packs),
  404            Packs \== []
  405        ->  forall(member(pack(Pack, Stat, Title, Version, _), Packs),
  406                   format('~w ~w@~w ~28|- ~w~n',
  407                          [Stat, Pack, Version, Title]))
  408        ;   print_message(warning, pack(search_no_matches(Query)))
  409        )
  410    ;   Result = true(Hits),
  411        local_search(Query, Local),
  412        append(Hits, Local, All),
  413        sort(All, Sorted),
  414        list_hits(Sorted)
  415    ).
  416
  417list_hits([]).
  418list_hits([ pack(Pack, i, Title, Version, _),
  419            pack(Pack, p, Title, Version, _)
  420          | More
  421          ]) :-
  422    !,
  423    format('i ~w@~w ~28|- ~w~n', [Pack, Version, Title]),
  424    list_hits(More).
  425list_hits([ pack(Pack, i, Title, VersionI, _),
  426            pack(Pack, p, _,     VersionS, _)
  427          | More
  428          ]) :-
  429    !,
  430    version_data(VersionI, VDI),
  431    version_data(VersionS, VDS),
  432    (   VDI @< VDS
  433    ->  Tag = ('U')
  434    ;   Tag = ('A')
  435    ),
  436    format('~w ~w@~w(~w) ~28|- ~w~n', [Tag, Pack, VersionI, VersionS, Title]),
  437    list_hits(More).
  438list_hits([ pack(Pack, i, Title, VersionI, _)
  439          | More
  440          ]) :-
  441    !,
  442    format('l ~w@~w ~28|- ~w~n', [Pack, VersionI, Title]),
  443    list_hits(More).
  444list_hits([pack(Pack, Stat, Title, Version, _)|More]) :-
  445    format('~w ~w@~w ~28|- ~w~n', [Stat, Pack, Version, Title]),
  446    list_hits(More).
  447
  448
  449local_search(Query, Packs) :-
  450    findall(Pack, matching_installed_pack(Query, Pack), Packs).
  451
  452matching_installed_pack(Query, pack(Pack, i, Title, Version, URL)) :-
  453    current_pack(Pack),
  454    findall(Term,
  455            ( pack_info(Pack, _, Term),
  456              search_info(Term)
  457            ), Info),
  458    (   sub_atom_icasechk(Pack, _, Query)
  459    ->  true
  460    ;   memberchk(title(Title), Info),
  461        sub_atom_icasechk(Title, _, Query)
  462    ),
  463    option(title(Title), Info, '<no title>'),
  464    option(version(Version), Info, '<no version>'),
  465    option(download(URL), Info, '<no download url>').
  466
  467search_info(title(_)).
  468search_info(version(_)).
  469search_info(download(_)).
  470
  471
  472                 /*******************************
  473                 *            INSTALL           *
  474                 *******************************/

 pack_install(+Spec:atom) is det

Install a package. Spec is one of

• Archive file name
• HTTP URL of an archive file name. This URL may contain a star (*) for the version. In this case pack_install asks for the directory content and selects the latest version.
• GIT URL (not well supported yet)
• A local directory name given as file:// URL or '.'
• A package name. This queries the package repository at http://www.swi-prolog.org

After resolving the type of package, pack_install/2 is used to do the actual installation.

  492pack_install(Spec) :-
  493    pack_default_options(Spec, Pack, [], Options),
  494    pack_install(Pack, [pack(Pack)|Options]).

 pack_default_options(+Spec, -Pack, +OptionsIn, -Options) is det

Establish the pack name (Pack) and install options from a specification and options (OptionsIn) provided by the user.

  501pack_default_options(_Spec, Pack, OptsIn, Options) :-
  502    option(already_installed(pack(Pack,_Version)), OptsIn),
  503    !,
  504    Options = OptsIn.
  505pack_default_options(_Spec, Pack, OptsIn, Options) :-
  506    option(url(URL), OptsIn),
  507    !,
  508    (   option(git(_), OptsIn)
  509    ->  Options = OptsIn
  510    ;   git_url(URL, Pack)
  511    ->  Options = [git(true)|OptsIn]
  512    ;   Options = OptsIn
  513    ),
  514    (   nonvar(Pack)
  515    ->  true
  516    ;   option(pack(Pack), Options)
  517    ->  true
  518    ;   pack_version_file(Pack, _Version, URL)
  519    ).
  520pack_default_options(Archive, Pack, _, Options) :-      % Install from archive
  521    must_be(atom, Archive),
  522    \+ uri_is_global(Archive),
  523    expand_file_name(Archive, [File]),
  524    exists_file(File),
  525    !,
  526    pack_version_file(Pack, Version, File),
  527    uri_file_name(FileURL, File),
  528    Options = [url(FileURL), version(Version)].
  529pack_default_options(URL, Pack, _, Options) :-
  530    git_url(URL, Pack),
  531    !,
  532    Options = [git(true), url(URL)].
  533pack_default_options(FileURL, Pack, _, Options) :-      % Install from directory
  534    uri_file_name(FileURL, Dir),
  535    exists_directory(Dir),
  536    pack_info_term(Dir, name(Pack)),
  537    !,
  538    (   pack_info_term(Dir, version(Version))
  539    ->  uri_file_name(DirURL, Dir),
  540        Options = [url(DirURL), version(Version)]
  541    ;   throw(error(existence_error(key, version, Dir),_))
  542    ).
  543pack_default_options('.', Pack, _, Options) :-          % Install from CWD
  544    pack_info_term('.', name(Pack)),
  545    !,
  546    working_directory(Dir, Dir),
  547    (   pack_info_term(Dir, version(Version))
  548    ->  uri_file_name(DirURL, Dir),
  549        Options = [url(DirURL), version(Version) | Options1],
  550        (   current_prolog_flag(windows, true)
  551        ->  Options1 = []
  552        ;   Options1 = [link(true), rebuild(make)]
  553        )
  554    ;   throw(error(existence_error(key, version, Dir),_))
  555    ).
  556pack_default_options(URL, Pack, _, Options) :-          % Install from URL
  557    pack_version_file(Pack, Version, URL),
  558    download_url(URL),
  559    !,
  560    available_download_versions(URL, [URLVersion-LatestURL|_]),
  561    Options = [url(LatestURL)|VersionOptions],
  562    version_options(Version, URLVersion, VersionOptions).
  563pack_default_options(Pack, Pack, OptsIn, Options) :-    % Install from name
  564    \+ uri_is_global(Pack),                             % ignore URLs
  565    query_pack_server(locate(Pack), Reply, OptsIn),
  566    (   Reply = true(Results)
  567    ->  pack_select_candidate(Pack, Results, OptsIn, Options)
  568    ;   print_message(warning, pack(no_match(Pack))),
  569        fail
  570    ).
  571
  572version_options(Version, Version, [version(Version)]) :- !.
  573version_options(Version, _, [version(Version)]) :-
  574    Version = version(List),
  575    maplist(integer, List),
  576    !.
  577version_options(_, _, []).

 pack_select_candidate(+Pack, +AvailableVersions, +OptionsIn, -Options)

Select from available packages.

  583pack_select_candidate(Pack, [AtomVersion-_|_], Options,
  584                      [already_installed(pack(Pack, Installed))|Options]) :-
  585    current_pack(Pack),
  586    pack_info(Pack, _, version(InstalledAtom)),
  587    atom_version(InstalledAtom, Installed),
  588    atom_version(AtomVersion, Version),
  589    Installed @>= Version,
  590    !.
  591pack_select_candidate(Pack, Available, Options, OptsOut) :-
  592    option(url(URL), Options),
  593    memberchk(_Version-URLs, Available),
  594    memberchk(URL, URLs),
  595    !,
  596    (   git_url(URL, Pack)
  597    ->  Extra = [git(true)]
  598    ;   Extra = []
  599    ),
  600    OptsOut = [url(URL), inquiry(true) | Extra].
  601pack_select_candidate(Pack, [Version-[URL]|_], Options,
  602                      [url(URL), git(true), inquiry(true)]) :-
  603    git_url(URL, Pack),
  604    !,
  605    confirm(install_from(Pack, Version, git(URL)), yes, Options).
  606pack_select_candidate(Pack, [Version-[URL]|More], Options,
  607                      [url(URL), inquiry(true) | Upgrade]) :-
  608    (   More == []
  609    ->  !
  610    ;   true
  611    ),
  612    confirm(install_from(Pack, Version, URL), yes, Options),
  613    !,
  614    add_upgrade(Pack, Upgrade).
  615pack_select_candidate(Pack, [Version-URLs|_], Options,
  616                      [url(URL), inquiry(true)|Rest]) :-
  617    maplist(url_menu_item, URLs, Tagged),
  618    append(Tagged, [cancel=cancel], Menu),
  619    Menu = [Default=_|_],
  620    menu(pack(select_install_from(Pack, Version)),
  621         Menu, Default, Choice, Options),
  622    (   Choice == cancel
  623    ->  fail
  624    ;   Choice = git(URL)
  625    ->  Rest = [git(true)|Upgrade]
  626    ;   Choice = URL,
  627        Rest = Upgrade
  628    ),
  629    add_upgrade(Pack, Upgrade).
  630
  631add_upgrade(Pack, Options) :-
  632    current_pack(Pack),
  633    !,
  634    Options = [upgrade(true)].
  635add_upgrade(_, []).
  636
  637url_menu_item(URL, git(URL)=install_from(git(URL))) :-
  638    git_url(URL, _),
  639    !.
  640url_menu_item(URL, URL=install_from(URL)).

 pack_install(+Name, +Options) is det

Install package Name. Processes the options below. Default options as would be used by pack_install/1 are used to complete the provided Options.

url(+URL)

Source for downloading the package

package_directory(+Dir)

Directory into which to install the package.

global(+Boolean)

If true, install in the XDG common application data path, making the pack accessible to everyone. If false, install in the XDG user application data path, making the pack accessible for the current user only. If the option is absent, use the first existing and writable directory. If that doesn't exist find locations where it can be created and prompt the user to do so.

interactive(+Boolean)

Use default answer without asking the user if there is a default action.

silent(+Boolean)

If true (default false), suppress informational progress messages.

upgrade(+Boolean)

If true (default false), upgrade package if it is already installed.

rebuild(Condition)

Rebuild the foreign components. Condition is one of if_absent (default, do nothing if the directory with foreign resources exists), make (run make) or true (run `make distclean` followed by the default configure and build steps).

test(Boolean)

If true (default), run the pack tests.

git(+Boolean)

If true (default false unless URL ends with =.git=), assume the URL is a GIT repository.

link(+Boolean)

Can be used if the installation source is a local directory and the file system supports symbolic links. In this case the system adds the current directory to the pack registration using a symbolic link and performs the local installation steps.

Non-interactive installation can be established using the option interactive(false). It is adviced to install from a particular trusted URL instead of the plain pack name for unattented operation.

  691pack_install(Spec, Options) :-
  692    pack_default_options(Spec, Pack, Options, DefOptions),
  693    (   option(already_installed(Installed), DefOptions)
  694    ->  print_message(informational, pack(already_installed(Installed)))
  695    ;   merge_options(Options, DefOptions, PackOptions),
  696        update_dependency_db,
  697        pack_install_dir(PackDir, PackOptions),
  698        pack_install(Pack, PackDir, PackOptions)
  699    ).
  700
  701pack_install_dir(PackDir, Options) :-
  702    option(package_directory(PackDir), Options),
  703    !.
  704pack_install_dir(PackDir, Options) :-
  705    base_alias(Alias, Options),
  706    absolute_file_name(Alias, PackDir,
  707                       [ file_type(directory),
  708                         access(write),
  709                         file_errors(fail)
  710                       ]),
  711    !.
  712pack_install_dir(PackDir, Options) :-
  713    pack_create_install_dir(PackDir, Options).
  714
  715base_alias(Alias, Options) :-
  716    option(global(true), Options),
  717    !,
  718    Alias = common_app_data(pack).
  719base_alias(Alias, Options) :-
  720    option(global(false), Options),
  721    !,
  722    Alias = user_app_data(pack).
  723base_alias(Alias, _Options) :-
  724    Alias = pack('.').
  725
  726pack_create_install_dir(PackDir, Options) :-
  727    base_alias(Alias, Options),
  728    findall(Candidate = create_dir(Candidate),
  729            ( absolute_file_name(Alias, Candidate, [solutions(all)]),
  730              \+ exists_file(Candidate),
  731              \+ exists_directory(Candidate),
  732              file_directory_name(Candidate, Super),
  733              (   exists_directory(Super)
  734              ->  access_file(Super, write)
  735              ;   true
  736              )
  737            ),
  738            Candidates0),
  739    list_to_set(Candidates0, Candidates),   % keep order
  740    pack_create_install_dir(Candidates, PackDir, Options).
  741
  742pack_create_install_dir(Candidates, PackDir, Options) :-
  743    Candidates = [Default=_|_],
  744    !,
  745    append(Candidates, [cancel=cancel], Menu),
  746    menu(pack(create_pack_dir), Menu, Default, Selected, Options),
  747    Selected \== cancel,
  748    (   catch(make_directory_path(Selected), E,
  749              (print_message(warning, E), fail))
  750    ->  PackDir = Selected
  751    ;   delete(Candidates, PackDir=create_dir(PackDir), Remaining),
  752        pack_create_install_dir(Remaining, PackDir, Options)
  753    ).
  754pack_create_install_dir(_, _, _) :-
  755    print_message(error, pack(cannot_create_dir(pack(.)))),
  756    fail.

 pack_install(+Pack, +PackDir, +Options)

Install package Pack into PackDir. Options:

url(URL)

Install from the given URL, URL is either a file://, a git URL or a download URL.

upgrade(Boolean)

If Pack is already installed and Boolean is true, update the package to the latest version. If Boolean is false print an error and fail.

  771pack_install(Name, _, Options) :-
  772    current_pack(Name, Dir),
  773    option(upgrade(false), Options, false),
  774    \+ pack_is_in_local_dir(Name, Dir, Options),
  775    print_message(error, pack(already_installed(Name))),
  776    pack_info(Name),
  777    print_message(information, pack(remove_with(Name))),
  778    !,
  779    fail.
  780pack_install(Name, PackDir, Options) :-
  781    option(url(URL), Options),
  782    uri_file_name(URL, Source),
  783    !,
  784    pack_install_from_local(Source, PackDir, Name, Options).
  785pack_install(Name, PackDir, Options) :-
  786    option(url(URL), Options),
  787    uri_components(URL, Components),
  788    uri_data(scheme, Components, Scheme),
  789    pack_install_from_url(Scheme, URL, PackDir, Name, Options).

 pack_install_from_local(+Source, +PackTopDir, +Name, +Options)

Install a package from a local media.

To be done

- Provide an option to install directories using a link (or file-links).

  798pack_install_from_local(Source, PackTopDir, Name, Options) :-
  799    exists_directory(Source),
  800    !,
  801    directory_file_path(PackTopDir, Name, PackDir),
  802    (   option(link(true), Options)
  803    ->  (   same_file(Source, PackDir)
  804        ->  true
  805        ;   atom_concat(PackTopDir, '/', PackTopDirS),
  806            relative_file_name(Source, PackTopDirS, RelPath),
  807            link_file(RelPath, PackDir, symbolic),
  808            assertion(same_file(Source, PackDir))
  809        )
  810    ;   prepare_pack_dir(PackDir, Options),
  811        copy_directory(Source, PackDir)
  812    ),
  813    pack_post_install(Name, PackDir, Options).
  814pack_install_from_local(Source, PackTopDir, Name, Options) :-
  815    exists_file(Source),
  816    directory_file_path(PackTopDir, Name, PackDir),
  817    prepare_pack_dir(PackDir, Options),
  818    pack_unpack(Source, PackDir, Name, Options),
  819    pack_post_install(Name, PackDir, Options).
  820
  821pack_is_in_local_dir(_Pack, PackDir, Options) :-
  822    option(url(DirURL), Options),
  823    uri_file_name(DirURL, Dir),
  824    same_file(PackDir, Dir).

 pack_unpack(+SourceFile, +PackDir, +Pack, +Options)

Unpack an archive to the given package dir.

  831:- if(exists_source(library(archive))).  832pack_unpack(Source, PackDir, Pack, Options) :-
  833    ensure_loaded_archive,
  834    pack_archive_info(Source, Pack, _Info, StripOptions),
  835    prepare_pack_dir(PackDir, Options),
  836    archive_extract(Source, PackDir,
  837                    [ exclude(['._*'])          % MacOS resource forks
  838                    | StripOptions
  839                    ]).
  840:- else.  841pack_unpack(_,_,_,_) :-
  842    existence_error(library, archive).
  843:- endif.  844
  845                 /*******************************
  846                 *             INFO             *
  847                 *******************************/

 pack_archive_info(+Archive, +Pack, -Info, -Strip)

True when Archive archives Pack. Info is unified with the terms from pack.pl in the pack and Strip is the strip-option for archive_extract/3.

Requires library(archive), which is lazily loaded when needed.

Errors

- existence_error(pack_file, 'pack.pl') if the archive doesn't contain pack.pl

- Syntax errors if pack.pl cannot be parsed.

  861:- if(exists_source(library(archive))).  862ensure_loaded_archive :-
  863    current_predicate(archive_open/3),
  864    !.
  865ensure_loaded_archive :-
  866    use_module(library(archive)).
  867
  868pack_archive_info(Archive, Pack, [archive_size(Bytes)|Info], Strip) :-
  869    ensure_loaded_archive,
  870    size_file(Archive, Bytes),
  871    setup_call_cleanup(
  872        archive_open(Archive, Handle, []),
  873        (   repeat,
  874            (   archive_next_header(Handle, InfoFile)
  875            ->  true
  876            ;   !, fail
  877            )
  878        ),
  879        archive_close(Handle)),
  880    file_base_name(InfoFile, 'pack.pl'),
  881    atom_concat(Prefix, 'pack.pl', InfoFile),
  882    strip_option(Prefix, Pack, Strip),
  883    setup_call_cleanup(
  884        archive_open_entry(Handle, Stream),
  885        read_stream_to_terms(Stream, Info),
  886        close(Stream)),
  887    !,
  888    must_be(ground, Info),
  889    maplist(valid_info_term, Info).
  890:- else.  891pack_archive_info(_, _, _, _) :-
  892    existence_error(library, archive).
  893:- endif.  894pack_archive_info(_, _, _, _) :-
  895    existence_error(pack_file, 'pack.pl').
  896
  897strip_option('', _, []) :- !.
  898strip_option('./', _, []) :- !.
  899strip_option(Prefix, Pack, [remove_prefix(Prefix)]) :-
  900    atom_concat(PrefixDir, /, Prefix),
  901    file_base_name(PrefixDir, Base),
  902    (   Base == Pack
  903    ->  true
  904    ;   pack_version_file(Pack, _, Base)
  905    ->  true
  906    ;   \+ sub_atom(PrefixDir, _, _, _, /)
  907    ).
  908
  909read_stream_to_terms(Stream, Terms) :-
  910    read(Stream, Term0),
  911    read_stream_to_terms(Term0, Stream, Terms).
  912
  913read_stream_to_terms(end_of_file, _, []) :- !.
  914read_stream_to_terms(Term0, Stream, [Term0|Terms]) :-
  915    read(Stream, Term1),
  916    read_stream_to_terms(Term1, Stream, Terms).

 pack_git_info(+GitDir, -Hash, -Info) is det

Retrieve info from a cloned git repository that is compatible with pack_archive_info/4.

  924pack_git_info(GitDir, Hash, [git(true), installed_size(Bytes)|Info]) :-
  925    exists_directory(GitDir),
  926    !,
  927    git_ls_tree(Entries, [directory(GitDir)]),
  928    git_hash(Hash, [directory(GitDir)]),
  929    maplist(arg(4), Entries, Sizes),
  930    sum_list(Sizes, Bytes),
  931    directory_file_path(GitDir, 'pack.pl', InfoFile),
  932    read_file_to_terms(InfoFile, Info, [encoding(utf8)]),
  933    must_be(ground, Info),
  934    maplist(valid_info_term, Info).

 download_file_sanity_check(+Archive, +Pack, +Info) is semidet

Perform basic sanity checks on DownloadFile

  940download_file_sanity_check(Archive, Pack, Info) :-
  941    info_field(name(Name), Info),
  942    info_field(version(VersionAtom), Info),
  943    atom_version(VersionAtom, Version),
  944    pack_version_file(PackA, VersionA, Archive),
  945    must_match([Pack, PackA, Name], name),
  946    must_match([Version, VersionA], version).
  947
  948info_field(Field, Info) :-
  949    memberchk(Field, Info),
  950    ground(Field),
  951    !.
  952info_field(Field, _Info) :-
  953    functor(Field, FieldName, _),
  954    print_message(error, pack(missing(FieldName))),
  955    fail.
  956
  957must_match(Values, _Field) :-
  958    sort(Values, [_]),
  959    !.
  960must_match(Values, Field) :-
  961    print_message(error, pack(conflict(Field, Values))),
  962    fail.
  963
  964
  965                 /*******************************
  966                 *         INSTALLATION         *
  967                 *******************************/

 prepare_pack_dir(+Dir, +Options)

Prepare for installing the package into Dir. This

• If the directory exist and is empty, done.
• Else if the directory exists, remove the directory and recreate it. Note that if the directory is a symlink this just deletes the link.
• Else create the directory.

  979prepare_pack_dir(Dir, Options) :-
  980    exists_directory(Dir),
  981    !,
  982    (   empty_directory(Dir)
  983    ->  true
  984    ;   (   option(upgrade(true), Options)
  985        ;   confirm(remove_existing_pack(Dir), yes, Options)
  986        )
  987    ->  delete_directory_and_contents(Dir),
  988        make_directory(Dir)
  989    ).
  990prepare_pack_dir(Dir, _) :-
  991    make_directory(Dir).

 empty_directory(+Directory) is semidet

True if Directory is empty (holds no files or sub-directories).

  997empty_directory(Dir) :-
  998    \+ ( directory_files(Dir, Entries),
  999         member(Entry, Entries),
 1000         \+ special(Entry)
 1001       ).
 1002
 1003special(.).
 1004special(..).

 pack_install_from_url(+Scheme, +URL, +PackDir, +Pack, +Options)

Install a package from a remote source. For git repositories, we simply clone. Archives are downloaded. We currently use the built-in HTTP client. For complete coverage, we should consider using an external (e.g., curl) if available.

 1014pack_install_from_url(_, URL, PackTopDir, Pack, Options) :-
 1015    option(git(true), Options),
 1016    !,
 1017    directory_file_path(PackTopDir, Pack, PackDir),
 1018    prepare_pack_dir(PackDir, Options),
 1019    run_process(path(git), [clone, URL, PackDir], []),
 1020    pack_git_info(PackDir, Hash, Info),
 1021    pack_inquiry(URL, git(Hash), Info, Options),
 1022    show_info(Pack, Info, Options),
 1023    confirm(git_post_install(PackDir, Pack), yes, Options),
 1024    pack_post_install(Pack, PackDir, Options).
 1025pack_install_from_url(Scheme, URL, PackTopDir, Pack, Options) :-
 1026    download_scheme(Scheme),
 1027    directory_file_path(PackTopDir, Pack, PackDir),
 1028    prepare_pack_dir(PackDir, Options),
 1029    pack_download_dir(PackTopDir, DownLoadDir),
 1030    download_file(URL, Pack, DownloadBase, Options),
 1031    directory_file_path(DownLoadDir, DownloadBase, DownloadFile),
 1032    setup_call_cleanup(
 1033        http_open(URL, In,
 1034                  [ cert_verify_hook(ssl_verify)
 1035                  ]),
 1036        setup_call_cleanup(
 1037            open(DownloadFile, write, Out, [type(binary)]),
 1038            copy_stream_data(In, Out),
 1039            close(Out)),
 1040        close(In)),
 1041    pack_archive_info(DownloadFile, Pack, Info, _),
 1042    download_file_sanity_check(DownloadFile, Pack, Info),
 1043    pack_inquiry(URL, DownloadFile, Info, Options),
 1044    show_info(Pack, Info, Options),
 1045    confirm(install_downloaded(DownloadFile), yes, Options),
 1046    pack_install_from_local(DownloadFile, PackTopDir, Pack, Options).

 download_file(+URL, +Pack, -File, +Options) is det

 1050download_file(URL, Pack, File, Options) :-
 1051    option(version(Version), Options),
 1052    !,
 1053    atom_version(VersionA, Version),
 1054    file_name_extension(_, Ext, URL),
 1055    format(atom(File), '~w-~w.~w', [Pack, VersionA, Ext]).
 1056download_file(URL, Pack, File, _) :-
 1057    file_base_name(URL,Basename),
 1058    no_int_file_name_extension(Tag,Ext,Basename),
 1059    tag_version(Tag,Version),
 1060    !,
 1061    atom_version(VersionA,Version),
 1062    format(atom(File0), '~w-~w', [Pack, VersionA]),
 1063    file_name_extension(File0, Ext, File).
 1064download_file(URL, _, File, _) :-
 1065    file_base_name(URL, File).

 pack_url_file(+URL, -File) is det

True if File is a unique id for the referenced pack and version. Normally, that is simply the base name, but GitHub archives destroy this picture. Needed by the pack manager.

 1073pack_url_file(URL, FileID) :-
 1074    github_release_url(URL, Pack, Version),
 1075    !,
 1076    download_file(URL, Pack, FileID, [version(Version)]).
 1077pack_url_file(URL, FileID) :-
 1078    file_base_name(URL, FileID).
 1079
 1080
 1081:- public ssl_verify/5.

 ssl_verify(+SSL, +ProblemCert, +AllCerts, +FirstCert, +Error)

Currently we accept all certificates. We organise our own security using SHA1 signatures, so we do not care about the source of the data.

 1089ssl_verify(_SSL,
 1090           _ProblemCertificate, _AllCertificates, _FirstCertificate,
 1091           _Error).
 1092
 1093pack_download_dir(PackTopDir, DownLoadDir) :-
 1094    directory_file_path(PackTopDir, 'Downloads', DownLoadDir),
 1095    (   exists_directory(DownLoadDir)
 1096    ->  true
 1097    ;   make_directory(DownLoadDir)
 1098    ),
 1099    (   access_file(DownLoadDir, write)
 1100    ->  true
 1101    ;   permission_error(write, directory, DownLoadDir)
 1102    ).

 download_url(+URL) is det

True if URL looks like a URL we can download from.

 1108download_url(URL) :-
 1109    atom(URL),
 1110    uri_components(URL, Components),
 1111    uri_data(scheme, Components, Scheme),
 1112    download_scheme(Scheme).
 1113
 1114download_scheme(http).
 1115download_scheme(https) :-
 1116    catch(use_module(library(http/http_ssl_plugin)),
 1117          E, (print_message(warning, E), fail)).

 pack_post_install(+Pack, +PackDir, +Options) is det

Process post installation work. Steps:

• Create foreign resources
• Register directory as autoload library
• Attach the package

 1127pack_post_install(Pack, PackDir, Options) :-
 1128    post_install_foreign(Pack, PackDir, Options),
 1129    post_install_autoload(PackDir, Options),
 1130    '$pack_attach'(PackDir).

 pack_rebuild(+Pack) is det

Rebuild possible foreign components of Pack.

 1136pack_rebuild(Pack) :-
 1137    current_pack(Pack, PackDir),
 1138    !,
 1139    post_install_foreign(Pack, PackDir, [rebuild(true)]).
 1140pack_rebuild(Pack) :-
 1141    unattached_pacth(Pack, PackDir),
 1142    !,
 1143    post_install_foreign(Pack, PackDir, [rebuild(true)]).
 1144pack_rebuild(Pack) :-
 1145    existence_error(pack, Pack).
 1146
 1147unattached_pacth(Pack, BaseDir) :-
 1148    directory_file_path(Pack, 'pack.pl', PackFile),
 1149    absolute_file_name(pack(PackFile), PackPath,
 1150                       [ access(read),
 1151                         file_errors(fail)
 1152                       ]),
 1153    file_directory_name(PackPath, BaseDir).

 pack_rebuild is det

Rebuild foreign components of all packages.

 1159pack_rebuild :-
 1160    forall(current_pack(Pack),
 1161           ( print_message(informational, pack(rebuild(Pack))),
 1162             pack_rebuild(Pack)
 1163           )).

 post_install_foreign(+Pack, +PackDir, +Options) is det

Install foreign parts of the package.

 1170post_install_foreign(Pack, PackDir, Options) :-
 1171    is_foreign_pack(PackDir, _),
 1172    !,
 1173    (   pack_info_term(PackDir, pack_version(Version))
 1174    ->  true
 1175    ;   Version = 1
 1176    ),
 1177    option(rebuild(Rebuild), Options, if_absent),
 1178    (   Rebuild == if_absent,
 1179        foreign_present(PackDir)
 1180    ->  print_message(informational, pack(kept_foreign(Pack)))
 1181    ;   BuildSteps0 = [[dependencies], [configure], build, [test], install],
 1182        (   Rebuild == true
 1183        ->  BuildSteps1 = [distclean|BuildSteps0]
 1184        ;   BuildSteps1 = BuildSteps0
 1185        ),
 1186        (   option(test(false), Options)
 1187        ->  delete(BuildSteps1, [test], BuildSteps)
 1188        ;   BuildSteps = BuildSteps1
 1189        ),
 1190        build_steps(BuildSteps, PackDir, [pack_version(Version)|Options])
 1191    ).
 1192post_install_foreign(_, _, _).

 foreign_present(+PackDir) is semidet

True if we find one or more modules in the pack lib directory for the current architecture. Does not check that these can be loaded, nor whether all required modules are present.

 1201foreign_present(PackDir) :-
 1202    current_prolog_flag(arch, Arch),
 1203    atomic_list_concat([PackDir, '/lib'], ForeignBaseDir),
 1204    exists_directory(ForeignBaseDir),
 1205    !,
 1206    atomic_list_concat([PackDir, '/lib/', Arch], ForeignDir),
 1207    exists_directory(ForeignDir),
 1208    current_prolog_flag(shared_object_extension, Ext),
 1209    atomic_list_concat([ForeignDir, '/*.', Ext], Pattern),
 1210    expand_file_name(Pattern, Files),
 1211    Files \== [].

 is_foreign_pack(+PackDir, -Type) is nondet

True when PackDir contains files that indicate the need for a specific class of build tools indicated by Type.

 1218is_foreign_pack(PackDir, Type) :-
 1219    foreign_file(File, Type),
 1220    directory_file_path(PackDir, File, Path),
 1221    exists_file(Path).
 1222
 1223foreign_file('CMakeLists.txt', cmake).
 1224foreign_file('configure',      configure).
 1225foreign_file('configure.in',   autoconf).
 1226foreign_file('configure.ac',   autoconf).
 1227foreign_file('Makefile.am',    automake).
 1228foreign_file('Makefile',       make).
 1229foreign_file('makefile',       make).
 1230foreign_file('conanfile.txt',  conan).
 1231foreign_file('conanfile.py',   conan).
 1232
 1233
 1234                 /*******************************
 1235                 *           AUTOLOAD           *
 1236                 *******************************/

 post_install_autoload(+PackDir, +Options)

Create an autoload index if the package demands such.

 1242post_install_autoload(PackDir, Options) :-
 1243    option(autoload(true), Options, true),
 1244    pack_info_term(PackDir, autoload(true)),
 1245    !,
 1246    directory_file_path(PackDir, prolog, PrologLibDir),
 1247    make_library_index(PrologLibDir).
 1248post_install_autoload(_, _).
 1249
 1250
 1251                 /*******************************
 1252                 *            UPGRADE           *
 1253                 *******************************/

 pack_upgrade(+Pack) is semidet

Try to upgrade the package Pack.

To be done

- Update dependencies when updating a pack from git?

 1261pack_upgrade(Pack) :-
 1262    pack_info(Pack, _, directory(Dir)),
 1263    directory_file_path(Dir, '.git', GitDir),
 1264    exists_directory(GitDir),
 1265    !,
 1266    print_message(informational, pack(git_fetch(Dir))),
 1267    git([fetch], [ directory(Dir) ]),
 1268    git_describe(V0, [ directory(Dir) ]),
 1269    git_describe(V1, [ directory(Dir), commit('origin/master') ]),
 1270    (   V0 == V1
 1271    ->  print_message(informational, pack(up_to_date(Pack)))
 1272    ;   confirm(upgrade(Pack, V0, V1), yes, []),
 1273        git([merge, 'origin/master'], [ directory(Dir) ]),
 1274        pack_rebuild(Pack)
 1275    ).
 1276pack_upgrade(Pack) :-
 1277    once(pack_info(Pack, _, version(VersionAtom))),
 1278    atom_version(VersionAtom, Version),
 1279    pack_info(Pack, _, download(URL)),
 1280    (   wildcard_pattern(URL)
 1281    ->  true
 1282    ;   github_url(URL, _User, _Repo)
 1283    ),
 1284    !,
 1285    available_download_versions(URL, [Latest-LatestURL|_Versions]),
 1286    (   Latest @> Version
 1287    ->  confirm(upgrade(Pack, Version, Latest), yes, []),
 1288        pack_install(Pack,
 1289                     [ url(LatestURL),
 1290                       upgrade(true),
 1291                       pack(Pack)
 1292                     ])
 1293    ;   print_message(informational, pack(up_to_date(Pack)))
 1294    ).
 1295pack_upgrade(Pack) :-
 1296    print_message(warning, pack(no_upgrade_info(Pack))).
 1297
 1298
 1299                 /*******************************
 1300                 *            REMOVE            *
 1301                 *******************************/

 pack_remove(+Name) is det

Remove the indicated package.

 1307pack_remove(Pack) :-
 1308    update_dependency_db,
 1309    (   setof(Dep, pack_depends_on(Dep, Pack), Deps)
 1310    ->  confirm_remove(Pack, Deps, Delete),
 1311        forall(member(P, Delete), pack_remove_forced(P))
 1312    ;   pack_remove_forced(Pack)
 1313    ).
 1314
 1315pack_remove_forced(Pack) :-
 1316    catch('$pack_detach'(Pack, BaseDir),
 1317          error(existence_error(pack, Pack), _),
 1318          fail),
 1319    !,
 1320    print_message(informational, pack(remove(BaseDir))),
 1321    delete_directory_and_contents(BaseDir).
 1322pack_remove_forced(Pack) :-
 1323    unattached_pacth(Pack, BaseDir),
 1324    !,
 1325    delete_directory_and_contents(BaseDir).
 1326pack_remove_forced(Pack) :-
 1327    print_message(informational, error(existence_error(pack, Pack),_)).
 1328
 1329confirm_remove(Pack, Deps, Delete) :-
 1330    print_message(warning, pack(depends(Pack, Deps))),
 1331    menu(pack(resolve_remove),
 1332         [ [Pack]      = remove_only(Pack),
 1333           [Pack|Deps] = remove_deps(Pack, Deps),
 1334           []          = cancel
 1335         ], [], Delete, []),
 1336    Delete \== [].
 1337
 1338
 1339                 /*******************************
 1340                 *           PROPERTIES         *
 1341                 *******************************/

 pack_property(?Pack, ?Property) is nondet

True when Property is a property of an installed Pack. This interface is intended for programs that wish to interact with the package manager. Defined properties are:

directory(Directory)

Directory into which the package is installed

version(Version)

Installed version

title(Title)

Full title of the package

author(Author)

Registered author

download(URL)

Official download URL

readme(File)

Package README file (if present)

todo(File)

Package TODO file (if present)

 1364pack_property(Pack, Property) :-
 1365    findall(Pack-Property, pack_property_(Pack, Property), List),
 1366    member(Pack-Property, List).            % make det if applicable
 1367
 1368pack_property_(Pack, Property) :-
 1369    pack_info(Pack, _, Property).
 1370pack_property_(Pack, Property) :-
 1371    \+ \+ info_file(Property, _),
 1372    '$pack':pack(Pack, BaseDir),
 1373    access_file(BaseDir, read),
 1374    directory_files(BaseDir, Files),
 1375    member(File, Files),
 1376    info_file(Property, Pattern),
 1377    downcase_atom(File, Pattern),
 1378    directory_file_path(BaseDir, File, InfoFile),
 1379    arg(1, Property, InfoFile).
 1380
 1381info_file(readme(_), 'readme.txt').
 1382info_file(readme(_), 'readme').
 1383info_file(todo(_),   'todo.txt').
 1384info_file(todo(_),   'todo').
 1385
 1386
 1387                 /*******************************
 1388                 *             GIT              *
 1389                 *******************************/

 git_url(+URL, -Pack) is semidet

True if URL describes a git url for Pack

 1395git_url(URL, Pack) :-
 1396    uri_components(URL, Components),
 1397    uri_data(scheme, Components, Scheme),
 1398    nonvar(Scheme),                         % must be full URL
 1399    uri_data(path, Components, Path),
 1400    (   Scheme == git
 1401    ->  true
 1402    ;   git_download_scheme(Scheme),
 1403        file_name_extension(_, git, Path)
 1404    ;   git_download_scheme(Scheme),
 1405        catch(git_ls_remote(URL, _, [refs(['HEAD']), error(_)]), _, fail)
 1406    ->  true
 1407    ),
 1408    file_base_name(Path, PackExt),
 1409    (   file_name_extension(Pack, git, PackExt)
 1410    ->  true
 1411    ;   Pack = PackExt
 1412    ),
 1413    (   safe_pack_name(Pack)
 1414    ->  true
 1415    ;   domain_error(pack_name, Pack)
 1416    ).
 1417
 1418git_download_scheme(http).
 1419git_download_scheme(https).

 safe_pack_name(+Name:atom) is semidet

Verifies that Name is a valid pack name. This avoids trickery with pack file names to make shell commands behave unexpectly.

 1426safe_pack_name(Name) :-
 1427    atom_length(Name, Len),
 1428    Len >= 3,                               % demand at least three length
 1429    atom_codes(Name, Codes),
 1430    maplist(safe_pack_char, Codes),
 1431    !.
 1432
 1433safe_pack_char(C) :- between(0'a, 0'z, C), !.
 1434safe_pack_char(C) :- between(0'A, 0'Z, C), !.
 1435safe_pack_char(C) :- between(0'0, 0'9, C), !.
 1436safe_pack_char(0'_).
 1437
 1438
 1439                 /*******************************
 1440                 *         VERSION LOGIC        *
 1441                 *******************************/

 pack_version_file(-Pack, -Version, +File) is semidet

True if File is the name of a file or URL of a file that contains Pack at Version. File must have an extension and the basename must be of the form <pack>-<n>{.<m>}*. E.g., mypack-1.5.

 1450pack_version_file(Pack, Version, GitHubRelease) :-
 1451    atomic(GitHubRelease),
 1452    github_release_url(GitHubRelease, Pack, Version),
 1453    !.
 1454pack_version_file(Pack, Version, Path) :-
 1455    atomic(Path),
 1456    file_base_name(Path, File),
 1457    no_int_file_name_extension(Base, _Ext, File),
 1458    atom_codes(Base, Codes),
 1459    (   phrase(pack_version(Pack, Version), Codes),
 1460        safe_pack_name(Pack)
 1461    ->  true
 1462    ).
 1463
 1464no_int_file_name_extension(Base, Ext, File) :-
 1465    file_name_extension(Base0, Ext0, File),
 1466    \+ atom_number(Ext0, _),
 1467    !,
 1468    Base = Base0,
 1469    Ext = Ext0.
 1470no_int_file_name_extension(File, '', File).

 github_release_url(+URL, -Pack, -Version) is semidet

True when URL is the URL of a GitHub release. Such releases are accessible as

https:/github.com/<owner>/<pack>/archive/[vV]?<version>.zip'

 1483github_release_url(URL, Pack, Version) :-
 1484    uri_components(URL, Components),
 1485    uri_data(authority, Components, 'github.com'),
 1486    uri_data(scheme, Components, Scheme),
 1487    download_scheme(Scheme),
 1488    uri_data(path, Components, Path),
 1489    github_archive_path(Archive,Pack,File),
 1490    atomic_list_concat(Archive, /, Path),
 1491    file_name_extension(Tag, Ext, File),
 1492    github_archive_extension(Ext),
 1493    tag_version(Tag, Version),
 1494    !.
 1495
 1496github_archive_path(['',_User,Pack,archive,File],Pack,File).
 1497github_archive_path(['',_User,Pack,archive,refs,tags,File],Pack,File).
 1498
 1499github_archive_extension(tgz).
 1500github_archive_extension(zip).
 1501
 1502tag_version(Tag, Version) :-
 1503    version_tag_prefix(Prefix),
 1504    atom_concat(Prefix, AtomVersion, Tag),
 1505    atom_version(AtomVersion, Version).
 1506
 1507version_tag_prefix(v).
 1508version_tag_prefix('V').
 1509version_tag_prefix('').
 1510
 1511
 1512:- public
 1513    atom_version/2.

 atom_version(?Atom, ?Version)

Translate between atomic version representation and term representation. The term representation is a list of version components as integers and can be compared using @>

 1521atom_version(Atom, version(Parts)) :-
 1522    (   atom(Atom)
 1523    ->  atom_codes(Atom, Codes),
 1524        phrase(version(Parts), Codes)
 1525    ;   atomic_list_concat(Parts, '.', Atom)
 1526    ).
 1527
 1528pack_version(Pack, version(Parts)) -->
 1529    string(Codes), "-",
 1530    version(Parts),
 1531    !,
 1532    { atom_codes(Pack, Codes)
 1533    }.
 1534
 1535version([_|T]) -->
 1536    "*",
 1537    !,
 1538    (   "."
 1539    ->  version(T)
 1540    ;   []
 1541    ).
 1542version([H|T]) -->
 1543    integer(H),
 1544    (   "."
 1545    ->  version(T)
 1546    ;   { T = [] }
 1547    ).
 1548
 1549                 /*******************************
 1550                 *       QUERY CENTRAL DB       *
 1551                 *******************************/

 pack_inquiry(+URL, +DownloadFile, +Info, +Options) is semidet

Query the status of a package with the central repository. To do this, we POST a Prolog document containing the URL, info and the SHA1 hash to http://www.swi-prolog.org/pack/eval. The server replies using a list of Prolog terms, described below. The only member that is always included is downloads (with default value 0).

alt_hash(Count, URLs, Hash)

A file with the same base-name, but a different hash was found at URLs and downloaded Count times.

downloads(Count)

Number of times a file with this hash was downloaded.

rating(VoteCount, Rating)

User rating (1..5), provided based on VoteCount votes.

dependency(Token, Pack, Version, URLs, SubDeps)

Required tokens can be provided by the given provides.

 1571pack_inquiry(_, _, _, Options) :-
 1572    option(inquiry(false), Options),
 1573    !.
 1574pack_inquiry(URL, DownloadFile, Info, Options) :-
 1575    setting(server, ServerBase),
 1576    ServerBase \== '',
 1577    atom_concat(ServerBase, query, Server),
 1578    (   option(inquiry(true), Options)
 1579    ->  true
 1580    ;   confirm(inquiry(Server), yes, Options)
 1581    ),
 1582    !,
 1583    (   DownloadFile = git(SHA1)
 1584    ->  true
 1585    ;   file_sha1(DownloadFile, SHA1)
 1586    ),
 1587    query_pack_server(install(URL, SHA1, Info), Reply, Options),
 1588    inquiry_result(Reply, URL, Options).
 1589pack_inquiry(_, _, _, _).

 query_pack_server(+Query, -Result, +Options)

Send a Prolog query to the package server and process its results.

 1597query_pack_server(Query, Result, Options) :-
 1598    setting(server, ServerBase),
 1599    ServerBase \== '',
 1600    atom_concat(ServerBase, query, Server),
 1601    format(codes(Data), '~q.~n', Query),
 1602    info_level(Informational, Options),
 1603    print_message(Informational, pack(contacting_server(Server))),
 1604    setup_call_cleanup(
 1605        http_open(Server, In,
 1606                  [ post(codes(application/'x-prolog', Data)),
 1607                    header(content_type, ContentType)
 1608                  ]),
 1609        read_reply(ContentType, In, Result),
 1610        close(In)),
 1611    message_severity(Result, Level, Informational),
 1612    print_message(Level, pack(server_reply(Result))).
 1613
 1614read_reply(ContentType, In, Result) :-
 1615    sub_atom(ContentType, 0, _, _, 'application/x-prolog'),
 1616    !,
 1617    set_stream(In, encoding(utf8)),
 1618    read(In, Result).
 1619read_reply(ContentType, In, _Result) :-
 1620    read_string(In, 500, String),
 1621    print_message(error, pack(no_prolog_response(ContentType, String))),
 1622    fail.
 1623
 1624info_level(Level, Options) :-
 1625    option(silent(true), Options),
 1626    !,
 1627    Level = silent.
 1628info_level(informational, _).
 1629
 1630message_severity(true(_), Informational, Informational).
 1631message_severity(false, warning, _).
 1632message_severity(exception(_), error, _).

 inquiry_result(+Reply, +File, +Options) is semidet

Analyse the results of the inquiry and decide whether to continue or not.

 1640inquiry_result(Reply, File, Options) :-
 1641    findall(Eval, eval_inquiry(Reply, File, Eval, Options), Evaluation),
 1642    \+ member(cancel, Evaluation),
 1643    select_option(git(_), Options, Options1, _),
 1644    forall(member(install_dependencies(Resolution), Evaluation),
 1645           maplist(install_dependency(Options1), Resolution)).
 1646
 1647eval_inquiry(true(Reply), URL, Eval, _) :-
 1648    include(alt_hash, Reply, Alts),
 1649    Alts \== [],
 1650    print_message(warning, pack(alt_hashes(URL, Alts))),
 1651    (   memberchk(downloads(Count), Reply),
 1652        (   git_url(URL, _)
 1653        ->  Default = yes,
 1654            Eval = with_git_commits_in_same_version
 1655        ;   Default = no,
 1656            Eval = with_alt_hashes
 1657        ),
 1658        confirm(continue_with_alt_hashes(Count, URL), Default, [])
 1659    ->  true
 1660    ;   !,                          % Stop other rules
 1661        Eval = cancel
 1662    ).
 1663eval_inquiry(true(Reply), _, Eval, Options) :-
 1664    include(dependency, Reply, Deps),
 1665    Deps \== [],
 1666    select_dependency_resolution(Deps, Eval, Options),
 1667    (   Eval == cancel
 1668    ->  !
 1669    ;   true
 1670    ).
 1671eval_inquiry(true(Reply), URL, true, Options) :-
 1672    file_base_name(URL, File),
 1673    info_level(Informational, Options),
 1674    print_message(Informational, pack(inquiry_ok(Reply, File))).
 1675eval_inquiry(exception(pack(modified_hash(_SHA1-URL, _SHA2-[URL]))),
 1676             URL, Eval, Options) :-
 1677    (   confirm(continue_with_modified_hash(URL), no, Options)
 1678    ->  Eval = true
 1679    ;   Eval = cancel
 1680    ).
 1681
 1682alt_hash(alt_hash(_,_,_)).
 1683dependency(dependency(_,_,_,_,_)).

 select_dependency_resolution(+Deps, -Eval, +Options)

Select a resolution.

To be done

- Exploit backtracking over resolve_dependencies/2.

 1692select_dependency_resolution(Deps, Eval, Options) :-
 1693    resolve_dependencies(Deps, Resolution),
 1694    exclude(local_dep, Resolution, ToBeDone),
 1695    (   ToBeDone == []
 1696    ->  !, Eval = true
 1697    ;   print_message(warning, pack(install_dependencies(Resolution))),
 1698        (   memberchk(_-unresolved, Resolution)
 1699        ->  Default = cancel
 1700        ;   Default = install_deps
 1701        ),
 1702        menu(pack(resolve_deps),
 1703             [ install_deps    = install_deps,
 1704               install_no_deps = install_no_deps,
 1705               cancel          = cancel
 1706             ], Default, Choice, Options),
 1707        (   Choice == cancel
 1708        ->  !, Eval = cancel
 1709        ;   Choice == install_no_deps
 1710        ->  !, Eval = install_no_deps
 1711        ;   !, Eval = install_dependencies(Resolution)
 1712        )
 1713    ).
 1714
 1715local_dep(_-resolved(_)).