/usr/lib/swi-prolog/library/filesex.pl is in swi-prolog-nox 7.6.4+dfsg-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | /* Part of SWI-Prolog
Author: Jan Wielemaker
E-mail: J.Wielemaker@vu.nl
WWW: http://www.swi-prolog.org
Copyright (c) 2002-2017, 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(files_ex,
[ set_time_file/3, % +File, -OldTimes, +NewTimes
link_file/3, % +OldPath, +NewPath, +Type
chmod/2, % +File, +Mode
relative_file_name/3, % ?AbsPath, +RelTo, ?RelPath
directory_file_path/3, % +Dir, +File, -Path
copy_file/2, % +From, +To
make_directory_path/1, % +Directory
copy_directory/2, % +Source, +Destination
delete_directory_and_contents/1, % +Dir
delete_directory_contents/1 % +Dir
]).
:- use_module(library(apply)).
:- use_module(library(error)).
/** <module> Extended operations on files
This module provides additional operations on files. This covers both
more obscure and possible non-portable low-level operations and
high-level utilities.
Using these Prolog primitives is typically to be preferred over using
operating system primitives through shell/1 or process_create/3 because
(1) there are no potential file name quoting issues, (2) there is no
dependency on operating system commands and (3) using the
implementations from this library is usually faster.
*/
:- use_foreign_library(foreign(files), install_files).
%! set_time_file(+File, -OldTimes, +NewTimes) is det.
%
% Query and set POSIX time attributes of a file. Both OldTimes and
% NewTimes are lists of option-terms. Times are represented in
% SWI-Prolog's standard floating point numbers. New times may be
% specified as =now= to indicate the current time. Defined options
% are:
%
% * access(Time)
% Describes the time of last access of the file. This value
% can be read and written.
%
% * modified(Time)
% Describes the time the contents of the file was last
% modified. This value can be read and written.
%
% * changed(Time)
% Describes the time the file-structure itself was changed by
% adding (link()) or removing (unlink()) names.
%
% Below are some example queries. The first retrieves the
% access-time, while the second sets the last-modified time to the
% current time.
%
% ==
% ?- set_time_file(foo, [access(Access)], []).
% ?- set_time_file(foo, [], [modified(now)]).
% ==
%! link_file(+OldPath, +NewPath, +Type) is det.
%
% Create a link in the filesystem from NewPath to OldPath. Type
% defines the type of link and is one of =hard= or =symbolic=.
%
% With some limitations, these functions also work on Windows.
% First of all, the unerlying filesystem must support links. This
% requires NTFS. Second, symbolic links are only supported in
% Vista and later.
%
% @error domain_error(link_type, Type) if the requested link-type
% is unknown or not supported on the target OS.
%! relative_file_name(+Path:atom, +RelTo:atom, -RelPath:atom) is det.
%! relative_file_name(-Path:atom, +RelTo:atom, +RelPath:atom) is det.
%
% True when RelPath is Path, relative to RelTo. Path and RelTo are
% first handed to absolute_file_name/2, which makes the absolute
% *and* canonical. Below are two examples:
%
% ==
% ?- relative_file_name('/home/janw/nice',
% '/home/janw/deep/dir/file', Path).
% Path = '../../nice'.
%
% ?- relative_file_name(Path, '/home/janw/deep/dir/file', '../../nice').
% Path = '/home/janw/nice'.
% ==
%
% @param All paths must be in canonical POSIX notation, i.e.,
% using / to separate segments in the path. See
% prolog_to_os_filename/2.
% @bug This predicate is defined as a _syntactical_ operation.
relative_file_name(Path, RelTo, RelPath) :- % +,+,-
nonvar(Path),
!,
absolute_file_name(Path, AbsPath),
absolute_file_name(RelTo, AbsRelTo),
atomic_list_concat(PL, /, AbsPath),
atomic_list_concat(RL, /, AbsRelTo),
delete_common_prefix(PL, RL, PL1, PL2),
to_dot_dot(PL2, DotDot, PL1),
atomic_list_concat(DotDot, /, RelPath).
relative_file_name(Path, RelTo, RelPath) :-
( is_absolute_file_name(RelPath)
-> Path = RelPath
; file_directory_name(RelTo, RelToDir),
directory_file_path(RelToDir, RelPath, Path0),
absolute_file_name(Path0, Path)
).
delete_common_prefix([H|T01], [H|T02], T1, T2) :-
!,
delete_common_prefix(T01, T02, T1, T2).
delete_common_prefix(T1, T2, T1, T2).
to_dot_dot([], Tail, Tail).
to_dot_dot([_], Tail, Tail) :- !.
to_dot_dot([_|T0], ['..'|T], Tail) :-
to_dot_dot(T0, T, Tail).
%! directory_file_path(+Directory, +File, -Path) is det.
%! directory_file_path(?Directory, ?File, +Path) is det.
%
% True when Path is the full path-name for File in Dir. This is
% comparable to atom_concat(Directory, File, Path), but it ensures
% there is exactly one / between the two parts. Notes:
%
% * In mode (+,+,-), if File is given and absolute, Path
% is unified to File.
% * Mode (-,-,+) uses file_directory_name/2 and file_base_name/2
directory_file_path(Dir, File, Path) :-
nonvar(Dir), nonvar(File),
!,
( ( is_absolute_file_name(File)
; Dir == '.'
)
-> Path = File
; sub_atom(Dir, _, _, 0, /)
-> atom_concat(Dir, File, Path)
; atomic_list_concat([Dir, /, File], Path)
).
directory_file_path(Dir, File, Path) :-
nonvar(Path),
!,
( nonvar(Dir)
-> ( Dir == '.',
\+ is_absolute_file_name(Path)
-> File = Path
; sub_atom(Dir, _, _, 0, /)
-> atom_concat(Dir, File, Path)
; atom_concat(Dir, /, TheDir)
-> atom_concat(TheDir, File, Path)
)
; nonvar(File)
-> atom_concat(Dir0, File, Path),
strip_trailing_slash(Dir0, Dir)
; file_directory_name(Path, Dir),
file_base_name(Path, File)
).
directory_file_path(_, _, _) :-
throw(error(instantiation_error(_), _)).
strip_trailing_slash(Dir0, Dir) :-
( atom_concat(D, /, Dir0),
D \== ''
-> Dir = D
; Dir = Dir0
).
%! copy_file(From, To) is det.
%
% Copy a file into a new file or directory. The data is copied as
% binary data.
copy_file(From, To) :-
destination_file(To, From, Dest),
setup_call_cleanup(
open(Dest, write, Out, [type(binary)]),
copy_from(From, Out),
close(Out)).
copy_from(File, Stream) :-
setup_call_cleanup(
open(File, read, In, [type(binary)]),
copy_stream_data(In, Stream),
close(In)).
destination_file(Dir, File, Dest) :-
exists_directory(Dir),
!,
file_base_name(File, Base),
directory_file_path(Dir, Base, Dest).
destination_file(Dest, _, Dest).
%! make_directory_path(+Dir) is det.
%
% Create Dir and all required components (like mkdir -p). Can
% raise various file-specific exceptions.
make_directory_path(Dir) :-
make_directory_path_2(Dir),
!.
make_directory_path(Dir) :-
permission_error(create, directory, Dir).
make_directory_path_2(Dir) :-
exists_directory(Dir),
!.
make_directory_path_2(Dir) :-
atom_concat(RealDir, '/', Dir),
RealDir \== '',
!,
make_directory_path_2(RealDir).
make_directory_path_2(Dir) :-
Dir \== (/),
!,
file_directory_name(Dir, Parent),
make_directory_path_2(Parent),
E = error(existence_error(directory, _), _),
catch(make_directory(Dir), E,
( exists_directory(Dir)
-> true
; throw(E)
)).
%! copy_directory(+From, +To) is det.
%
% Copy the contents of the directory From to To (recursively). If
% To is the name of an existing directory, the _contents_ of From
% are copied into To. I.e., no subdirectory using the basename of
% From is created.
copy_directory(From, To) :-
( exists_directory(To)
-> true
; make_directory(To)
),
directory_files(From, Entries),
maplist(copy_directory_content(From, To), Entries).
copy_directory_content(_From, _To, Special) :-
special(Special),
!.
copy_directory_content(From, To, Entry) :-
directory_file_path(From, Entry, Source),
directory_file_path(To, Entry, Dest),
( exists_directory(Source)
-> copy_directory(Source, Dest)
; copy_file(Source, Dest)
).
special(.).
special(..).
%! delete_directory_and_contents(+Dir) is det.
%
% Recursively remove the directory Dir and its contents. If Dir is
% a symbolic link or symbolic links inside Dir are encountered,
% the links are removed rather than their content. Use with care!
delete_directory_and_contents(Dir) :-
read_link(Dir, _, _),
!,
delete_file(Dir).
delete_directory_and_contents(Dir) :-
directory_files(Dir, Files),
maplist(delete_directory_contents(Dir), Files),
E = error(existence_error(directory, _), _),
catch(delete_directory(Dir), E,
( \+ exists_directory(Dir)
-> true
; throw(E)
)).
delete_directory_contents(_, Entry) :-
special(Entry),
!.
delete_directory_contents(Dir, Entry) :-
directory_file_path(Dir, Entry, Delete),
( exists_directory(Delete)
-> delete_directory_and_contents(Delete)
; E = error(existence_error(file, _), _),
catch(delete_file(Delete), E,
( \+ exists_file(Delete)
-> true
; throw(E)))
).
%! delete_directory_contents(+Dir) is det.
%
% Remove all content from directory Dir, without removing Dir
% itself. Similar to delete_directory_and_contents/2, if symbolic
% links are encountered in Dir, the links are removed rather than
% their content.
delete_directory_contents(Dir) :-
directory_files(Dir, Files),
maplist(delete_directory_contents(Dir), Files).
%! chmod(+File, +Spec) is det.
%
% Set the mode of the target file. Spec is one of `+Mode`, `-Mode` or
% a plain `Mode`, which adds new permissions, revokes permissions or
% sets the exact permissions. `Mode` itself is an integer, a POSIX
% mode name or a list of POSIX mode names. Defines names are `suid`,
% `sgid`, `svtx` and the all names defined by the regular expression
% =|[ugo]*[rwx]*|=. Specifying none of "ugo" is the same as specifying
% all of them. For example, to make a file executable for the owner
% (user) and group, we can use:
%
% ```
% ?- chmod(myfile, +ugx).
% ```
chmod(File, +Spec) :-
must_be(ground, Spec),
!,
mode_bits(Spec, Bits),
file_mode_(File, Mode0),
Mode is Mode0 \/ Bits,
chmod_(File, Mode).
chmod(File, -Spec) :-
must_be(ground, Spec),
!,
mode_bits(Spec, Bits),
file_mode_(File, Mode0),
Mode is Mode0 /\ \Bits,
chmod_(File, Mode).
chmod(File, Spec) :-
must_be(ground, Spec),
!,
mode_bits(Spec, Bits),
chmod_(File, Bits).
mode_bits(Spec, Spec) :-
integer(Spec),
!.
mode_bits(Name, Bits) :-
atom(Name),
!,
( file_mode(Name, Bits)
-> true
; domain_error(posix_file_mode, Name)
).
mode_bits(Spec, Bits) :-
must_be(list(atom), Spec),
phrase(mode_bits(0, Bits), Spec).
mode_bits(Bits0, Bits) -->
[Spec], !,
( { file_mode(Spec, B), Bits1 is Bits0\/B }
-> mode_bits(Bits1, Bits)
; { domain_error(posix_file_mode, Spec) }
).
mode_bits(Bits, Bits) -->
[].
file_mode(suid, 0o4000).
file_mode(sgid, 0o2000).
file_mode(svtx, 0o1000).
file_mode(Name, Bits) :-
atom_chars(Name, Chars),
phrase(who_mask(0, WMask0), Chars, Rest),
( WMask0 =:= 0
-> WMask = 0o0777
; WMask = WMask0
),
maplist(mode_char, Rest, MBits),
foldl(or, MBits, 0, Mask),
Bits is Mask /\ WMask.
who_mask(M0, M) -->
[C],
{ who_mask(C,M1), !,
M2 is M0\/M1
},
who_mask(M2,M).
who_mask(M, M) -->
[].
who_mask(o, 0o0007).
who_mask(g, 0o0070).
who_mask(u, 0o0700).
mode_char(r, 0o0444).
mode_char(w, 0o0222).
mode_char(x, 0o0111).
or(B1, B2, B) :-
B is B1\/B2.
|