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-2019, VU University Amsterdam
    7                              CWI, Amsterdam
    8    All rights reserved.
    9
   10    Redistribution and use in source and binary forms, with or without
   11    modification, are permitted provided that the following conditions
   12    are met:
   13
   14    1. Redistributions of source code must retain the above copyright
   15       notice, this list of conditions and the following disclaimer.
   16
   17    2. Redistributions in binary form must reproduce the above copyright
   18       notice, this list of conditions and the following disclaimer in
   19       the documentation and/or other materials provided with the
   20       distribution.
   21
   22    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
   23    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
   24    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
   25    FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
   26    COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
   27    INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
   28    BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
   29    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
   30    CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
   31    LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
   32    ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
   33    POSSIBILITY OF SUCH DAMAGE.
   34*/
   35
   36:- module('$pack',
   37          [ attach_packs/0,
   38            attach_packs/1,                     % +Dir
   39            attach_packs/2,                     % +Dir, +Options
   40            '$pack_detach'/2,                   % +Name, -Dir
   41            '$pack_attach'/1,                   % +Dir
   42            '$pack_attach'/2
   43          ]).   44
   45:- multifile user:file_search_path/2.   46:- dynamic user:file_search_path/2.   47
   48:- dynamic
   49    pack_dir/3,                             % Pack, Type, Dir
   50    pack/2.                                 % Pack, BaseDir
   51
   52user:file_search_path(pack, app_data(pack)).
   53
   54user:file_search_path(library, PackLib) :-
   55    pack_dir(_Name, prolog, PackLib).
   56user:file_search_path(foreign, PackLib) :-
   57    pack_dir(_Name, foreign, PackLib).
   58
   59%!  '$pack_detach'(+Name, -Dir) is det.
   60%
   61%   Detach the given package  from  the   search  paths  and list of
   62%   registered packages, but does not delete the files.
   63
   64'$pack_detach'(Name, Dir) :-
   65    (   atom(Name)
   66    ->  true
   67    ;   throw(error(type_error(atom, Name), _))
   68    ),
   69    (   retract(pack(Name, Dir))
   70    ->  retractall(pack_dir(Name, _, _)),
   71        reload_library_index
   72    ;   throw(error(existence_error(pack, Name), _))
   73    ).
   74
   75%!  '$pack_attach'(+Dir) is det.
   76%
   77%   Attach the given package
   78
   79'$pack_attach'(Dir) :-
   80    '$pack_attach'(Dir, []).
   81
   82'$pack_attach'(Dir, Options) :-
   83    attach_package(Dir, Options),
   84    !.
   85'$pack_attach'(Dir, _) :-
   86    (   exists_directory(Dir)
   87    ->  throw(error(existence_error(directory, Dir), _))
   88    ;   throw(error(domain_error(pack, Dir), _))
   89    ).
   90
   91%!  attach_packs
   92%
   93%   Attach  packages  from  all  package    directories.  If  there  are
   94%   duplicates the first package found is used.
   95
   96attach_packs :-
   97    set_prolog_flag(packs, true),
   98    findall(PackDir, absolute_file_name(pack(.), PackDir,
   99                                        [ file_type(directory),
  100                                          access(read),
  101                                          solutions(all)
  102                                        ]),
  103            PackDirs),
  104    (   PackDirs \== []
  105    ->  remove_dups(PackDirs, UniquePackDirs, []),
  106        forall('$member'(PackDir, UniquePackDirs),
  107               attach_packs(PackDir, [duplicate(keep)]))
  108    ;   true
  109    ).
  110
  111%!  remove_dups(+List, -Unique, +Seen) is det.
  112%
  113%   Remove duplicates from List, keeping the first solution.
  114
  115remove_dups([], [], _).
  116remove_dups([H|T0], T, Seen) :-
  117    memberchk(H, Seen),
  118    !,
  119    remove_dups(T0, T, Seen).
  120remove_dups([H|T0], [H|T], Seen) :-
  121    remove_dups(T0, T, [H|Seen]).
  122
  123
  124%!  attach_packs(+Dir) is det.
  125%!  attach_packs(+Dir, +Options) is det.
  126%
  127%   Attach packages from directory Dir.  Options processed:
  128%
  129%     - duplicate(+Action)
  130%     What to do if the same package is already installed in a different
  131%     directory.  Action is one of
  132%       - warning
  133%       Warn and ignore the package
  134%       - keep
  135%       Silently ignore the package
  136%       - replace
  137%       Unregister the existing and insert the new package
  138%     - search(+Where)
  139%     Determines the order of searching package library directories.
  140%     Default is `last`, alternative is `first`.
  141
  142attach_packs(Dir) :-
  143    attach_packs(Dir, []).
  144
  145attach_packs(Dir, Options) :-
  146    absolute_file_name(Dir, Path,
  147                       [ file_type(directory),
  148                         file_errors(fail)
  149                       ]),
  150    catch(directory_files(Path, Entries), _, fail),
  151    !,
  152    ensure_slash(Path, SPath),
  153    attach_packages(Entries, SPath, Options).
  154attach_packs(_, _).
  155
  156attach_packages([], _, _).
  157attach_packages([H|T], Dir, Options) :-
  158    attach_package(H, Dir, Options),
  159    attach_packages(T, Dir, Options).
  160
  161attach_package(Entry, Dir, Options) :-
  162    \+ special(Entry),
  163    atom_concat(Dir, Entry, PackDir),
  164    attach_package(PackDir, Options),
  165    !.
  166attach_package(_, _, _).
  167
  168special(.).
  169special(..).
  170
  171
  172%!  attach_package(+PackDir, +Options) is semidet.
  173%
  174%   @tbd    Deal with autoload index.  Reload?
  175
  176attach_package(PackDir, Options) :-
  177    atomic_list_concat([PackDir, '/pack.pl'], InfoFile),
  178    access_file(InfoFile, read),
  179    file_base_name(PackDir, Pack),
  180    check_existing(Pack, PackDir, Options),
  181    foreign_dir(Pack, PackDir, ForeignDir),
  182    prolog_dir(PackDir, PrologDir),
  183    !,
  184    assertz(pack(Pack, PackDir)),
  185    '$option'(search(Where), Options, last),
  186    (   Where == last
  187    ->  assertz(pack_dir(Pack, prolog, PrologDir))
  188    ;   Where == first
  189    ->  asserta(pack_dir(Pack, prolog, PrologDir))
  190    ;   '$domain_error'(option_search, Where)
  191    ),
  192    update_autoload(PrologDir),
  193    (   ForeignDir \== (-)
  194    ->  assertz(pack_dir(Pack, foreign, ForeignDir))
  195    ;   true
  196    ),
  197    print_message(silent, pack(attached(Pack, PackDir))).
  198
  199
  200%!  check_existing(+Pack, +PackDir, +Options) is semidet.
  201%
  202%   Verify that we did not load this package before.
  203
  204check_existing(Entry, Dir, _) :-
  205    retract(pack(Entry, Dir)),             % registered from same place
  206    !,
  207    retractall(pack_dir(Entry, _, _)).
  208check_existing(Entry, Dir, Options) :-
  209    pack(Entry, OldDir),
  210    !,
  211    '$option'(duplicate(Action), Options, warning),
  212    (   Action == warning
  213    ->  print_message(warning, pack(duplicate(Entry, OldDir, Dir))),
  214        fail
  215    ;   Action == keep
  216    ->  fail
  217    ;   Action == replace
  218    ->  print_message(silent, pack(replaced(Entry, OldDir, Dir))),
  219        '$pack_detach'(Entry, OldDir)
  220    ;   '$domain_error'(option_duplicate, Action)
  221    ).
  222check_existing(_, _, _).
  223
  224
  225prolog_dir(PackDir, PrologDir) :-
  226    atomic_list_concat([PackDir, '/prolog'], PrologDir),
  227    exists_directory(PrologDir).
  228
  229update_autoload(PrologDir) :-
  230    atom_concat(PrologDir, '/INDEX.pl', IndexFile),
  231    (   exists_file(IndexFile)
  232    ->  reload_library_index
  233    ;   true
  234    ).
  235
  236foreign_dir(Pack, PackDir, ForeignDir) :-
  237    atomic_list_concat([PackDir, '/lib'], ForeignBaseDir),
  238    exists_directory(ForeignBaseDir),
  239    !,
  240    (   arch(Arch),
  241	atomic_list_concat([PackDir, '/lib/', Arch], ForeignDir),
  242        exists_directory(ForeignDir)
  243    ->  assertz(pack_dir(Pack, foreign, ForeignDir))
  244    ;   findall(Arch, arch(Arch), Archs),
  245	print_message(warning, pack(no_arch(Pack, Archs))),
  246        fail
  247    ).
  248foreign_dir(_, _, (-)).
  249
  250arch(Arch) :-
  251    current_prolog_flag(apple_universal_binary, true),
  252    Arch = 'fat-darwin'.
  253arch(Arch) :-
  254    current_prolog_flag(arch, Arch).
  255
  256ensure_slash(Dir, SDir) :-
  257    (   sub_atom(Dir, _, _, 0, /)
  258    ->  SDir = Dir
  259    ;   atom_concat(Dir, /, SDir)
  260    )