1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640
|
/* Part of SWI-Prolog
Author: Jan Wielemaker and Richard O'Keefe
E-mail: J.Wielemaker@cs.vu.nl
WWW: http://www.swi-prolog.org
Copyright (c) 2014-2018, VU University Amsterdam
CWI, 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(check_installation,
[ check_installation/0,
check_installation/1, % -Issues
test_installation/0,
test_installation/1 % +Options
]).
:- use_module(option).
/** <module> Check installation issues and features
This library performs checks on the installed system to verify which
optional components are available and whether all libaries that load
shared objects/DLLs can be loaded.
*/
%! component(?Component, -Features) is nondet.
%
% This predicate describes the test components. Features is a dict
% with the following components:
%
% - test:Goal
% (Additional) test that must succeed for the component to be
% functional.
% - url:URL
% URL with additional information, relative to
% =|http://www.swi-prolog.org/build/issues/|=. If not provided,
% the library file with extension =|.html|= is used.
% - optional:true
% If the library does not exist, do not complain.
% - os:OS
% One of =windows=, =unix= or =linux=. If present, the component
% is only checked for if we are running on a version of the
% specified operating system.
% - features:Goal
% After successful evaluation that loading and basic operation
% of the component succeeds, run this to check additional
% features.
% Feature tests
component(gmp,
_{ test:current_prolog_flag(bounded, false),
url:'gmp.html'
}).
% Packages that depend on foreign libraries
component(library(archive), _{features:archive_features}).
component(library(cgi), _{}).
component(library(crypt), _{}).
component(library(bdb), _{}).
component(library(double_metaphone), _{}).
component(library(filesex), _{}).
component(library(http/http_stream), _{}).
component(library(http/json), _{}).
component(library(http/jquery), _{features:jquery_file}).
component(library(isub), _{}).
component(library(jpl), _{}).
component(library(memfile), _{}).
component(library(odbc), _{}).
component(library(pce),
_{pre:load_foreign_library(pce_principal:foreign(pl2xpce)),
url:'xpce.html'}).
component(library(pcre), _{features:pcre_features}).
component(library(pdt_console), _{}).
component(library(porter_stem), _{}).
component(library(process), _{}).
component(library(protobufs), _{}).
component(library(editline), _{os:unix}).
component(library(readline), _{os:unix}).
component(library(readutil), _{}).
component(library(rlimit), _{os:unix}).
component(library(semweb/rdf_db), _{}).
component(library(semweb/rdf_ntriples), _{}).
component(library(semweb/turtle), _{}).
component(library(sgml), _{}).
component(library(sha), _{}).
component(library(snowball), _{}).
component(library(socket), _{}).
component(library(ssl), _{}).
component(library(crypto), _{}).
component(library(syslog), _{os:unix}).
component(library(table), _{}).
component(library(time), _{}).
component(library(tipc/tipc), _{os:linux}).
component(library(unicode), _{}).
component(library(uri), _{}).
component(library(uuid), _{}).
component(library(zlib), _{}).
component(library(yaml), _{}).
issue_base('http://www.swi-prolog.org/build/issues/').
:- thread_local
issue/1.
:- meta_predicate
run_silent(0, +).
%! check_installation
%
% Check features of the installed system. Performs the following
% tests:
%
% 1. Test whether features that depend on optional libraries
% are present (e.g., unbounded arithmetic support)
% 2. Test that all standard libraries that depend on foreign
% code are present.
% 3. provides a test_installation predicate to run the tests
% at runtime if the system was built with -DINSTALL_TESTS
%
% If issues are found it prints a diagnostic message with a link
% to a wiki page with additional information about the issue.
check_installation :-
print_message(informational, installation(checking)),
check_installation_(Issues),
check_on_path,
( Issues == []
-> print_message(informational, installation(perfect))
; length(Issues, Count),
print_message(warning, installation(imperfect(Count)))
).
%! check_installation(-Issues:list(pair)) is det.
%
% As check_installation/0, but additionally returns a list of
% Component-Problem pairs. Problem is one of `optional_not_found`
% (optional component is not present), `not_found` (component is
% not present) or `failed` (component is present but cannot be
% loaded).
check_installation(Issues) :-
check_installation_(Issues0),
maplist(public_issue, Issues0, Issues).
public_issue(installation(Term), Source-Issue) :-
functor(Term, Issue, _),
arg(1, Term, Properties),
Source = Properties.source.
check_installation_(Issues) :-
retractall(issue(_)),
forall(component(Source, _Properties),
check_component(Source)),
findall(I, retract(issue(I)), Issues).
/*******************************
* RUN TESTS *
*******************************/
%! test_installation is semidet.
%! test_installation(+Options) is semidet.
%
% Run regression tests in the installed system. Requires the system
% to be build using
%
% cmake -DINSTALL_TESTS=ON
%
% Options processed:
%
% - packages(+Boolean)
% When `false`, do not test the packages
% - package(+Package)
% Only test package package.
test_installation :-
test_installation([]).
test_installation(Options) :-
absolute_file_name(swi(test/test),
TestFile,
[ access(read),
file_errors(fail),
file_type(prolog)
]),
!,
test_installation_run(TestFile, Options).
test_installation(_Options) :-
print_message(warning, installation(testing(no_installed_tests))).
test_installation_run(TestFile, Options) :-
( option(package(_), Options)
-> merge_options(Options,
[ core(false),
subdirs(false)
], TestOptions)
; merge_options(Options,
[ packages(true)
], TestOptions)
),
load_files(user:TestFile),
current_prolog_flag(verbose, Old),
setup_call_cleanup(
set_prolog_flag(verbose, silent),
user:test([], TestOptions),
set_prolog_flag(verbose, Old)).
check_component(Source) :-
component(Source, Properties),
!,
check_component(Source, Properties.put(source,Source)).
check_component(Source, Properties) :-
compound(Source),
!,
check_source(Source, Properties).
check_component(Feature, Properties) :-
print_message(informational, installation(checking(Feature))),
( call(Properties.test)
-> print_message(informational, installation(ok))
; print_issue(installation(missing(Properties)))
).
check_source(_Source, Properties) :-
OS = Properties.get(os),
\+ current_os(OS),
!.
check_source(Source, Properties) :-
exists_source(Source),
!,
print_message(informational, installation(loading(Source))),
( run_silent(( ( Pre = Properties.get(pre)
-> call(Pre)
; true
),
load_files(Source, [silent(true), if(not_loaded)])
),
Properties.put(action, load))
-> test_component(Properties),
print_message(informational, installation(ok)),
check_features(Properties)
; true
).
check_source(_Source, Properties) :-
Properties.get(optional) == true,
!,
print_message(silent,
installation(optional_not_found(Properties))).
check_source(_Source, Properties) :-
print_issue(installation(not_found(Properties))).
current_os(unix) :- current_prolog_flag(unix, true).
current_os(windows) :- current_prolog_flag(windows, true).
current_os(linux) :- current_prolog_flag(arch, Arch), sub_atom(Arch, _, _, _, linux).
%! test_component(+Properties) is semidet.
%
% Run additional tests to see whether the componnent really works.
test_component(Dict) :-
Test = Dict.get(test),
!,
call(Test).
test_component(_).
%! check_features(+Properties) is semidet.
%
% Check for additional features of the components.
%
% @see check_component/1 should be used for checking that the
% component works.
check_features(Dict) :-
Test = Dict.get(features),
!,
call(Test).
check_features(_).
%! run_silent(:Goal, +Properties) is semidet.
%
% Succeed if Goal succeeds and does not print any errors or
% warnings.
run_silent(Goal, Properties) :-
run_collect_messages(Goal, Result, Messages),
( Result == true,
Messages == []
-> true
; print_issue(installation(failed(Properties, Result, Messages))),
fail
).
%! run_collect_messages(Goal, Result, Messages) is det.
%
% Run Goal, unify Result with =true=, =false= or exception(Error)
% and messages with a list of generated error and warning
% messages. Each message is a term:
%
% message(Term,Kind,Lines)
%
% @see message_hook/3.
:- thread_local
got_message/1.
run_collect_messages(Goal, Result, Messages) :-
setup_call_cleanup(
asserta((user:thread_message_hook(Term,Kind,Lines) :-
error_kind(Kind),
assertz(got_message(message(Term,Kind,Lines)))), Ref),
( catch(Goal, E, true)
-> ( var(E)
-> Result0 = true
; Result0 = exception(E)
)
; Result0 = false
),
erase(Ref)),
findall(Msg, retract(got_message(Msg)), Messages),
Result = Result0.
error_kind(warning).
error_kind(error).
/*******************************
* SPECIAL TESTS *
*******************************/
%! archive_features
%
% Report features supported by library(archive).
archive_features :-
tmp_file_stream(utf8, Name, Out),
close(Out),
findall(F, archive_filter(F, Name), Filters),
print_message(informational, installation(archive(filters, Filters))),
findall(F, archive_format(F, Name), Formats),
print_message(informational, installation(archive(formats, Formats))),
delete_file(Name).
archive_filter(F, Name) :-
a_filter(F),
catch(archive_open(Name, A, [filter(F)]), E, true),
( var(E)
-> archive_close(A)
; true
),
\+ subsumes_term(error(domain_error(filter, _),_), E).
archive_format(F, Name) :-
a_format(F),
catch(archive_open(Name, A, [format(F)]), E, true),
( var(E)
-> archive_close(A)
; true
),
\+ subsumes_term(error(domain_error(filter, _),_), E).
a_filter(bzip2).
a_filter(compress).
a_filter(gzip).
a_filter(grzip).
a_filter(lrzip).
a_filter(lzip).
a_filter(lzma).
a_filter(lzop).
a_filter(none).
a_filter(rpm).
a_filter(uu).
a_filter(xz).
a_format('7zip').
a_format(ar).
a_format(cab).
a_format(cpio).
a_format(empty).
a_format(gnutar).
a_format(iso9660).
a_format(lha).
a_format(mtree).
a_format(rar).
a_format(raw).
a_format(tar).
a_format(xar).
a_format(zip).
%! pcre_features
pcre_features :-
findall(X, pcre_missing(X), Missing),
( Missing == []
-> true
; print_message(warning, installation(pcre_missing(Missing)))
).
pcre_missing(X) :-
pcre_must_have(X),
Term =.. [X,true],
\+ catch(re_config(Term), _, fail).
pcre_must_have(utf8).
pcre_must_have(unicode_properties).
%! jquery_file
%
% Test whether jquery.js can be found
jquery_file :-
setting(jquery:version, File),
( absolute_file_name(js(File), Path, [access(read), file_errors(fail)])
-> print_message(informational, installation(jquery(found(Path))))
; print_message(warning, installation(jquery(not_found(File))))
).
%! check_on_path
%
% Validate that Prolog is installed in $PATH
check_on_path :-
current_prolog_flag(executable, EXEFlag),
prolog_to_os_filename(EXE, EXEFlag),
file_base_name(EXE, Prog),
absolute_file_name(EXE, AbsExe,
[ access(execute)
]),
prolog_to_os_filename(AbsExe, OsExe),
( absolute_file_name(path(Prog), OnPath,
[ access(execute),
file_errors(fail)
])
-> ( same_file(EXE, OnPath)
-> true
; absolute_file_name(path(Prog), OnPathAny,
[ access(execute),
file_errors(fail),
solutions(all)
]),
same_file(EXE, OnPathAny)
-> print_message(warning, installation(not_first_on_path(OsExe, OnPath)))
; print_message(warning, installation(not_same_on_path(OsExe, OnPath)))
)
; print_message(warning, installation(not_on_path(OsExe, Prog)))
).
/*******************************
* MESSAGES *
*******************************/
:- multifile
prolog:message//1.
print_issue(Term) :-
assertz(issue(Term)),
print_message(warning, Term).
issue_url(Properties, URL) :-
Local = Properties.get(url),
!,
issue_base(Base),
atom_concat(Base, Local, URL).
issue_url(Properties, URL) :-
Properties.get(source) = library(Segments),
!,
path_segments_atom(Segments, Base),
file_name_extension(Base, html, URLFile),
issue_base(Issues),
atom_concat(Issues, URLFile, URL).
prolog:message(installation(Message)) -->
message(Message).
message(checking) -->
{ current_prolog_flag(address_bits, Bits) },
{ current_prolog_flag(arch, Arch) },
{ current_prolog_flag(home, Home) },
{ current_prolog_flag(cpu_count, Cores) },
[ 'Checking your SWI-Prolog kit for common issues ...'-[], nl, nl ],
[ 'Version: ~`.t~24| '-[] ], '$messages':prolog_message(version), [nl],
[ 'Address bits: ~`.t~24| ~d'-[Bits] ], [nl],
[ 'Architecture: ~`.t~24| ~w'-[Arch] ], [nl],
[ 'Installed at: ~`.t~24| ~w'-[Home] ], [nl],
[ 'Cores: ~`.t~24| ~w'-[Cores] ], [nl],
[ nl ].
message(perfect) -->
[ nl, 'Congratulations, your kit seems sound and complete!'-[] ].
message(imperfect(N)) -->
[ 'Found ~w issues.'-[N] ].
message(checking(Feature)) -->
[ 'Checking ~w ...'-[Feature], flush ].
message(missing(Properties)) -->
[ at_same_line, '~`.t~48| not present'-[] ],
details(Properties).
message(loading(Source)) -->
[ 'Loading ~q ...'-[Source], flush ].
message(ok) -->
[ at_same_line, '~`.t~48| ok'-[] ].
message(optional_not_found(Properties)) -->
[ 'Optional ~q ~`.t~48| not present'-[Properties.source] ].
message(not_found(Properties)) -->
[ '~q ~`.t~48| NOT FOUND'-[Properties.source] ],
details(Properties).
message(failed(Properties, false, [])) -->
!,
[ at_same_line, '~`.t~48| FAILED'-[] ],
details(Properties).
message(failed(Properties, exception(Ex0), [])) -->
!,
{ strip_stack(Ex0, Ex),
message_to_string(Ex, Msg) },
[ '~w'-[Msg] ],
details(Properties).
message(failed(Properties, true, Messages)) -->
[ at_same_line, '~`.t~48| FAILED'-[] ],
explain(Messages),
details(Properties).
message(archive(What, Names)) -->
[ ' Supported ~w: '-[What] ],
list_names(Names).
message(pcre_missing(Features)) -->
[ 'Missing libpcre features: '-[] ],
list_names(Features).
message(not_first_on_path(EXE, OnPath)) -->
{ public_executable(EXE, PublicEXE),
file_base_name(EXE, Prog)
},
[ 'The first ~w on '-[Prog] ], 'PATH', [ ' is ~p, while '-[OnPath], nl ],
[ 'this version is ~p.'-[PublicEXE] ].
message(not_same_on_path(EXE, OnPath)) -->
{ public_executable(EXE, PublicEXE),
file_base_name(EXE, Prog)
},
[ 'The ~w on '-[Prog] ], 'PATH', [ ' is ~p, while '-[OnPath], nl ],
[ 'this version is ~p.'-[PublicEXE] ].
message(not_on_path(EXE, Prog)) -->
{ public_bin_dir(EXE, Dir),
prolog_to_os_filename(Dir, OSDir)
},
[ 'Could not find ~w on '-[Prog] ], 'PATH', [ '. '-[], nl ],
[ 'You may wish to add ~p to '-[OSDir] ], 'PATH', [ '. '-[], nl ].
message(jquery(found(Path))) -->
[ ' jQuery from ~w'-[Path] ].
message(jquery(not_found(File))) -->
[ ' Cannot find jQuery (~w)'-[File] ].
message(testing(no_installed_tests)) -->
[ ' Runtime testing is not enabled.', nl],
[ ' Please recompile the system with INSTALL_TESTS enabled.' ].
public_executable(EXE, PublicProg) :-
file_base_name(EXE, Prog),
file_directory_name(EXE, ArchDir),
file_directory_name(ArchDir, BinDir),
file_directory_name(BinDir, Home),
file_directory_name(Home, Lib),
file_directory_name(Lib, Prefix),
atomic_list_concat([Prefix, bin, Prog], /, PublicProg),
exists_file(PublicProg),
same_file(EXE, PublicProg),
!.
public_executable(EXE, EXE).
public_bin_dir(EXE, Dir) :-
public_executable(EXE, PublicEXE),
file_directory_name(PublicEXE, Dir).
'PATH' -->
{ current_prolog_flag(windows, true) },
!,
[ '%PATH%'-[] ].
'PATH' -->
[ '$PATH'-[] ].
strip_stack(error(Error, context(prolog_stack(S), Msg)),
error(Error, context(_, Msg))) :-
nonvar(S).
strip_stack(Error, Error).
details(Properties) -->
{ issue_url(Properties, URL), !
},
[ nl, 'See ~w'-[URL] ].
details(_) --> [].
explain(Messages) -->
{ Messages = [message(error(shared_object(open, _Message), _), _, _)|_]
},
!,
[nl],
( { current_prolog_flag(windows, true) }
-> [ 'Cannot load required DLL'-[] ]
; [ 'Cannot load required shared library'-[] ]
).
explain(Messages) -->
print_messages(Messages).
print_messages([]) --> [].
print_messages([message(_Term, _Kind, Lines)|T]) -->
Lines, [nl],
print_messages(T).
list_names([]) --> [].
list_names([H|T]) -->
[ '~w'-[H] ],
( {T==[]}
-> []
; [ ', '-[] ],
list_names(T)
).
|