author | wenzelm |
Fri, 31 May 2024 20:46:51 +0200 | |
changeset 80218 | 875968a3b2f9 |
parent 80192 | 36e6ba1527f0 |
child 80224 | db92e0b6a11a |
permissions | -rw-r--r-- |
30175 | 1 |
/* Title: Pure/System/isabelle_system.scala |
27919 | 2 |
Author: Makarius |
3 |
||
73890 | 4 |
Miscellaneous Isabelle system operations. |
27919 | 5 |
*/ |
6 |
||
7 |
package isabelle |
|
8 |
||
55618 | 9 |
|
74146 | 10 |
import java.util.{Map => JMap, HashMap} |
76546 | 11 |
import java.util.zip.ZipFile |
67835 | 12 |
import java.io.{File => JFile, IOException} |
76145 | 13 |
import java.net.ServerSocket |
73317 | 14 |
import java.nio.file.{Path => JPath, Files, SimpleFileVisitor, FileVisitResult, |
15 |
StandardCopyOption, FileSystemException} |
|
56477 | 16 |
import java.nio.file.attribute.BasicFileAttributes |
73987
fc363a3b690a
build.props for isabelle.jar, including isabelle.jedit;
wenzelm
parents:
73945
diff
changeset
|
17 |
|
76546 | 18 |
import scala.jdk.CollectionConverters._ |
19 |
||
27919 | 20 |
|
75393 | 21 |
object Isabelle_System { |
75218 | 22 |
/* settings environment */ |
56477 | 23 |
|
77079
395a0701a125
clarified signature: minimal interface for getenv/expand_env, instead of bulky java.util.Map;
wenzelm
parents:
77027
diff
changeset
|
24 |
trait Settings { def get(name: String): String } |
395a0701a125
clarified signature: minimal interface for getenv/expand_env, instead of bulky java.util.Map;
wenzelm
parents:
77027
diff
changeset
|
25 |
trait Settings_Env extends Settings { def env: JMap[String, String] } |
395a0701a125
clarified signature: minimal interface for getenv/expand_env, instead of bulky java.util.Map;
wenzelm
parents:
77027
diff
changeset
|
26 |
|
395a0701a125
clarified signature: minimal interface for getenv/expand_env, instead of bulky java.util.Map;
wenzelm
parents:
77027
diff
changeset
|
27 |
class Env(val env: JMap[String, String]) extends Settings_Env { |
395a0701a125
clarified signature: minimal interface for getenv/expand_env, instead of bulky java.util.Map;
wenzelm
parents:
77027
diff
changeset
|
28 |
override def get(name: String): String = Option(env.get(name)).getOrElse("") |
395a0701a125
clarified signature: minimal interface for getenv/expand_env, instead of bulky java.util.Map;
wenzelm
parents:
77027
diff
changeset
|
29 |
} |
395a0701a125
clarified signature: minimal interface for getenv/expand_env, instead of bulky java.util.Map;
wenzelm
parents:
77027
diff
changeset
|
30 |
|
79633 | 31 |
object No_Env extends Env(JMap.of()) |
32 |
||
75393 | 33 |
def settings(putenv: List[(String, String)] = Nil): JMap[String, String] = { |
74146 | 34 |
val env0 = isabelle.setup.Environment.settings() |
35 |
if (putenv.isEmpty) env0 |
|
36 |
else { |
|
37 |
val env = new HashMap(env0) |
|
38 |
for ((a, b) <- putenv) env.put(a, b) |
|
39 |
env |
|
40 |
} |
|
41 |
} |
|
71739 | 42 |
|
77079
395a0701a125
clarified signature: minimal interface for getenv/expand_env, instead of bulky java.util.Map;
wenzelm
parents:
77027
diff
changeset
|
43 |
def settings_env(putenv: List[(String, String)] = Nil): Settings_Env = |
395a0701a125
clarified signature: minimal interface for getenv/expand_env, instead of bulky java.util.Map;
wenzelm
parents:
77027
diff
changeset
|
44 |
new Env(settings(putenv = putenv)) |
31498 | 45 |
|
77079
395a0701a125
clarified signature: minimal interface for getenv/expand_env, instead of bulky java.util.Map;
wenzelm
parents:
77027
diff
changeset
|
46 |
def getenv(name: String, env: Settings = settings_env()): String = env.get(name) |
395a0701a125
clarified signature: minimal interface for getenv/expand_env, instead of bulky java.util.Map;
wenzelm
parents:
77027
diff
changeset
|
47 |
|
395a0701a125
clarified signature: minimal interface for getenv/expand_env, instead of bulky java.util.Map;
wenzelm
parents:
77027
diff
changeset
|
48 |
def getenv_strict(name: String, env: Settings = settings_env()): String = |
65717 | 49 |
proper_string(getenv(name, env)) getOrElse |
50 |
error("Undefined Isabelle environment variable: " + quote(name)) |
|
27919 | 51 |
|
77719 | 52 |
def ml_identifier(): String = getenv("ML_IDENTIFIER") |
53 |
||
77384
ef6673859c38
option build_hostname allows to change hostname easily;
wenzelm
parents:
77373
diff
changeset
|
54 |
def hostname(default: String = ""): String = |
ef6673859c38
option build_hostname allows to change hostname easily;
wenzelm
parents:
77373
diff
changeset
|
55 |
proper_string(default) getOrElse getenv_strict("ISABELLE_HOSTNAME") |
77373
eaf234b0c849
proper settings for hostname: allow to adjust it in user space;
wenzelm
parents:
77218
diff
changeset
|
56 |
|
73520
4cba4e250c28
clarified ISABELLE_ID: distribution vs. hg archive vs. hg repos;
wenzelm
parents:
73445
diff
changeset
|
57 |
|
73891
6c9044f04756
clarified modules (again): services require full Isabelle/Scala environment;
wenzelm
parents:
73890
diff
changeset
|
58 |
/* services */ |
6c9044f04756
clarified modules (again): services require full Isabelle/Scala environment;
wenzelm
parents:
73890
diff
changeset
|
59 |
|
75702 | 60 |
type Service = Classpath.Service |
73891
6c9044f04756
clarified modules (again): services require full Isabelle/Scala environment;
wenzelm
parents:
73890
diff
changeset
|
61 |
|
75702 | 62 |
@volatile private var _classpath: Option[Classpath] = None |
73891
6c9044f04756
clarified modules (again): services require full Isabelle/Scala environment;
wenzelm
parents:
73890
diff
changeset
|
63 |
|
75702 | 64 |
def classpath(): Classpath = { |
65 |
if (_classpath.isEmpty) init() // unsynchronized check |
|
66 |
_classpath.get |
|
73891
6c9044f04756
clarified modules (again): services require full Isabelle/Scala environment;
wenzelm
parents:
73890
diff
changeset
|
67 |
} |
6c9044f04756
clarified modules (again): services require full Isabelle/Scala environment;
wenzelm
parents:
73890
diff
changeset
|
68 |
|
75702 | 69 |
def make_services[C](c: Class[C]): List[C] = classpath().make_services(c) |
75697 | 70 |
|
73891
6c9044f04756
clarified modules (again): services require full Isabelle/Scala environment;
wenzelm
parents:
73890
diff
changeset
|
71 |
|
75702 | 72 |
/* init settings + classpath */ |
75692 | 73 |
|
75393 | 74 |
def init(isabelle_root: String = "", cygwin_root: String = ""): Unit = { |
73906 | 75 |
isabelle.setup.Environment.init(isabelle_root, cygwin_root) |
75692 | 76 |
synchronized { |
75702 | 77 |
if (_classpath.isEmpty) _classpath = Some(Classpath()) |
75692 | 78 |
} |
78944 | 79 |
Registry.global |
73891
6c9044f04756
clarified modules (again): services require full Isabelle/Scala environment;
wenzelm
parents:
73890
diff
changeset
|
80 |
} |
6c9044f04756
clarified modules (again): services require full Isabelle/Scala environment;
wenzelm
parents:
73890
diff
changeset
|
81 |
|
6c9044f04756
clarified modules (again): services require full Isabelle/Scala environment;
wenzelm
parents:
73890
diff
changeset
|
82 |
|
73520
4cba4e250c28
clarified ISABELLE_ID: distribution vs. hg archive vs. hg repos;
wenzelm
parents:
73445
diff
changeset
|
83 |
/* getetc -- static distribution parameters */ |
4cba4e250c28
clarified ISABELLE_ID: distribution vs. hg archive vs. hg repos;
wenzelm
parents:
73445
diff
changeset
|
84 |
|
75393 | 85 |
def getetc(name: String, root: Path = Path.ISABELLE_HOME): Option[String] = { |
73520
4cba4e250c28
clarified ISABELLE_ID: distribution vs. hg archive vs. hg repos;
wenzelm
parents:
73445
diff
changeset
|
86 |
val path = root + Path.basic("etc") + Path.basic(name) |
4cba4e250c28
clarified ISABELLE_ID: distribution vs. hg archive vs. hg repos;
wenzelm
parents:
73445
diff
changeset
|
87 |
if (path.is_file) { |
4cba4e250c28
clarified ISABELLE_ID: distribution vs. hg archive vs. hg repos;
wenzelm
parents:
73445
diff
changeset
|
88 |
Library.trim_split_lines(File.read(path)) match { |
4cba4e250c28
clarified ISABELLE_ID: distribution vs. hg archive vs. hg repos;
wenzelm
parents:
73445
diff
changeset
|
89 |
case Nil => None |
4cba4e250c28
clarified ISABELLE_ID: distribution vs. hg archive vs. hg repos;
wenzelm
parents:
73445
diff
changeset
|
90 |
case List(s) => Some(s) |
4cba4e250c28
clarified ISABELLE_ID: distribution vs. hg archive vs. hg repos;
wenzelm
parents:
73445
diff
changeset
|
91 |
case _ => error("Single line expected in " + path.absolute) |
4cba4e250c28
clarified ISABELLE_ID: distribution vs. hg archive vs. hg repos;
wenzelm
parents:
73445
diff
changeset
|
92 |
} |
4cba4e250c28
clarified ISABELLE_ID: distribution vs. hg archive vs. hg repos;
wenzelm
parents:
73445
diff
changeset
|
93 |
} |
4cba4e250c28
clarified ISABELLE_ID: distribution vs. hg archive vs. hg repos;
wenzelm
parents:
73445
diff
changeset
|
94 |
else None |
4cba4e250c28
clarified ISABELLE_ID: distribution vs. hg archive vs. hg repos;
wenzelm
parents:
73445
diff
changeset
|
95 |
} |
4cba4e250c28
clarified ISABELLE_ID: distribution vs. hg archive vs. hg repos;
wenzelm
parents:
73445
diff
changeset
|
96 |
|
4cba4e250c28
clarified ISABELLE_ID: distribution vs. hg archive vs. hg repos;
wenzelm
parents:
73445
diff
changeset
|
97 |
|
73521 | 98 |
/* Isabelle distribution identification */ |
73520
4cba4e250c28
clarified ISABELLE_ID: distribution vs. hg archive vs. hg repos;
wenzelm
parents:
73445
diff
changeset
|
99 |
|
73525 | 100 |
def isabelle_id(root: Path = Path.ISABELLE_HOME): String = |
75510 | 101 |
getetc("ISABELLE_ID", root = root) orElse |
102 |
Mercurial.archive_id(root) orElse |
|
103 |
Mercurial.id_repository(root, rev = "") getOrElse |
|
104 |
error("Failed to identify Isabelle distribution " + root.expand) |
|
67865 | 105 |
|
75393 | 106 |
object Isabelle_Id extends Scala.Fun_String("isabelle_id") { |
73523
2cd23d587db9
further clarification of Isabelle distribution identification -- avoid odd patching of sources;
wenzelm
parents:
73522
diff
changeset
|
107 |
val here = Scala_Project.here |
73525 | 108 |
def apply(arg: String): String = isabelle_id() |
73523
2cd23d587db9
further clarification of Isabelle distribution identification -- avoid odd patching of sources;
wenzelm
parents:
73522
diff
changeset
|
109 |
} |
2cd23d587db9
further clarification of Isabelle distribution identification -- avoid odd patching of sources;
wenzelm
parents:
73522
diff
changeset
|
110 |
|
73522 | 111 |
def isabelle_tags(root: Path = Path.ISABELLE_HOME): String = |
73521 | 112 |
getetc("ISABELLE_TAGS", root = root) orElse Mercurial.archive_tags(root) getOrElse { |
113 |
if (Mercurial.is_repository(root)) { |
|
114 |
val hg = Mercurial.repository(root) |
|
115 |
hg.tags(rev = hg.parent()) |
|
116 |
} |
|
117 |
else "" |
|
118 |
} |
|
31796 | 119 |
|
79633 | 120 |
def export_env(user_home: String = "", isabelle_identifier: String = ""): String = |
121 |
"export USER_HOME=" + Bash.string(user_home) + "\n" + |
|
75563
5bba3516ddb5
more robust: always override ISABELLE_IDENTIFIER from environment;
wenzelm
parents:
75523
diff
changeset
|
122 |
"export ISABELLE_IDENTIFIER=" + Bash.string(isabelle_identifier) + "\n" |
75218 | 123 |
|
73523
2cd23d587db9
further clarification of Isabelle distribution identification -- avoid odd patching of sources;
wenzelm
parents:
73522
diff
changeset
|
124 |
def isabelle_identifier(): Option[String] = proper_string(getenv("ISABELLE_IDENTIFIER")) |
2cd23d587db9
further clarification of Isabelle distribution identification -- avoid odd patching of sources;
wenzelm
parents:
73522
diff
changeset
|
125 |
|
2cd23d587db9
further clarification of Isabelle distribution identification -- avoid odd patching of sources;
wenzelm
parents:
73522
diff
changeset
|
126 |
def isabelle_heading(): String = |
2cd23d587db9
further clarification of Isabelle distribution identification -- avoid odd patching of sources;
wenzelm
parents:
73522
diff
changeset
|
127 |
isabelle_identifier() match { |
2cd23d587db9
further clarification of Isabelle distribution identification -- avoid odd patching of sources;
wenzelm
parents:
73522
diff
changeset
|
128 |
case None => "" |
2cd23d587db9
further clarification of Isabelle distribution identification -- avoid odd patching of sources;
wenzelm
parents:
73522
diff
changeset
|
129 |
case Some(version) => " (" + version + ")" |
2cd23d587db9
further clarification of Isabelle distribution identification -- avoid odd patching of sources;
wenzelm
parents:
73522
diff
changeset
|
130 |
} |
2cd23d587db9
further clarification of Isabelle distribution identification -- avoid odd patching of sources;
wenzelm
parents:
73522
diff
changeset
|
131 |
|
2cd23d587db9
further clarification of Isabelle distribution identification -- avoid odd patching of sources;
wenzelm
parents:
73522
diff
changeset
|
132 |
def isabelle_name(): String = getenv_strict("ISABELLE_NAME") |
2cd23d587db9
further clarification of Isabelle distribution identification -- avoid odd patching of sources;
wenzelm
parents:
73522
diff
changeset
|
133 |
|
74336
7bb0ac635397
permissive identification, e.g. relevant for HOL-SPARK examples running on rsync-clone;
wenzelm
parents:
74268
diff
changeset
|
134 |
def identification(): String = |
7bb0ac635397
permissive identification, e.g. relevant for HOL-SPARK examples running on rsync-clone;
wenzelm
parents:
74268
diff
changeset
|
135 |
"Isabelle" + (try { "/" + isabelle_id () } catch { case ERROR(_) => "" }) + isabelle_heading() |
73547 | 136 |
|
54039 | 137 |
|
43606 | 138 |
/** file-system operations **/ |
31796 | 139 |
|
73322 | 140 |
/* scala functions */ |
141 |
||
75437 | 142 |
private def apply_paths( |
143 |
args: List[String], |
|
144 |
fun: PartialFunction[List[Path], Unit] |
|
145 |
): List[String] = { |
|
75393 | 146 |
fun(args.map(Path.explode)) |
147 |
Nil |
|
148 |
} |
|
73322 | 149 |
|
73567 | 150 |
private def apply_paths1(args: List[String], fun: Path => Unit): List[String] = |
75437 | 151 |
apply_paths(args, { case List(path) => fun(path) }) |
73322 | 152 |
|
73567 | 153 |
private def apply_paths2(args: List[String], fun: (Path, Path) => Unit): List[String] = |
75437 | 154 |
apply_paths(args, { case List(path1, path2) => fun(path1, path2) }) |
73322 | 155 |
|
73567 | 156 |
private def apply_paths3(args: List[String], fun: (Path, Path, Path) => Unit): List[String] = |
75437 | 157 |
apply_paths(args, { case List(path1, path2, path3) => fun(path1, path2, path3) }) |
73322 | 158 |
|
159 |
||
71114 | 160 |
/* permissions */ |
161 |
||
162 |
def chmod(arg: String, path: Path): Unit = |
|
71123 | 163 |
bash("chmod " + arg + " " + File.bash_path(path)).check |
71114 | 164 |
|
165 |
def chown(arg: String, path: Path): Unit = |
|
71123 | 166 |
bash("chown " + arg + " " + File.bash_path(path)).check |
71114 | 167 |
|
168 |
||
64189 | 169 |
/* directories */ |
50893
d55eb82ae77b
Isabelle_System.mkdirs with explicit error checking (in accordance to ML version), e.g. relevant with read-only DMG file-system on Mac OS X;
wenzelm
parents:
50854
diff
changeset
|
170 |
|
75393 | 171 |
def make_directory(path: Path): Path = { |
73325
a89f56ab2686
more robust (amending 87403fde8cc3): notably allow symlink to existing directory, which Files.createDirectories does not accept;
wenzelm
parents:
73324
diff
changeset
|
172 |
if (!path.is_dir) { |
73945 | 173 |
try { Files.createDirectories(path.java_path) } |
73325
a89f56ab2686
more robust (amending 87403fde8cc3): notably allow symlink to existing directory, which Files.createDirectories does not accept;
wenzelm
parents:
73324
diff
changeset
|
174 |
catch { case ERROR(_) => error("Failed to create directory: " + path.absolute) } |
a89f56ab2686
more robust (amending 87403fde8cc3): notably allow symlink to existing directory, which Files.createDirectories does not accept;
wenzelm
parents:
73324
diff
changeset
|
175 |
} |
72376 | 176 |
path |
177 |
} |
|
50893
d55eb82ae77b
Isabelle_System.mkdirs with explicit error checking (in accordance to ML version), e.g. relevant with read-only DMG file-system on Mac OS X;
wenzelm
parents:
50854
diff
changeset
|
178 |
|
72377 | 179 |
def new_directory(path: Path): Path = |
72426
f5d60c12deeb
more standard path output (despite platform_path from d55eb82ae77b);
wenzelm
parents:
72414
diff
changeset
|
180 |
if (path.is_dir) error("Directory already exists: " + path.absolute) |
72377 | 181 |
else make_directory(path) |
182 |
||
76621
7af197063e2f
clarified signature: copy directory content more directly;
wenzelm
parents:
76620
diff
changeset
|
183 |
def copy_dir(dir1: Path, dir2: Path, direct: Boolean = false): Unit = { |
80192 | 184 |
def make_path(dir: Path): String = |
185 |
Url.dir_path(File.standard_path(dir.absolute), direct = direct) |
|
76620 | 186 |
val p1 = make_path(dir1) |
187 |
val p2 = make_path(dir2) |
|
76624 | 188 |
make_directory(if (direct) dir2.absolute else dir2.absolute.dir) |
76620 | 189 |
val res = bash("cp -a " + Bash.string(p1) + " " + Bash.string(p2)) |
190 |
if (!res.ok) cat_error("Failed to copy " + quote(p1) + " to " + quote(p2), res.err) |
|
73322 | 191 |
} |
73317 | 192 |
|
75393 | 193 |
def with_copy_dir[A](dir1: Path, dir2: Path)(body: => A): A = { |
76625 | 194 |
new_directory(dir2) |
195 |
try { copy_dir(dir1, dir2, direct = true); body } |
|
196 |
finally { rm_tree(dir2) } |
|
75230
bbbee54b1198
prepare patched version more thoroughly, with explicit patches;
wenzelm
parents:
75229
diff
changeset
|
197 |
} |
bbbee54b1198
prepare patched version more thoroughly, with explicit patches;
wenzelm
parents:
75229
diff
changeset
|
198 |
|
73317 | 199 |
|
75393 | 200 |
object Make_Directory extends Scala.Fun_Strings("make_directory") { |
73322 | 201 |
val here = Scala_Project.here |
73567 | 202 |
def apply(args: List[String]): List[String] = apply_paths1(args, make_directory) |
73322 | 203 |
} |
73317 | 204 |
|
75393 | 205 |
object Copy_Dir extends Scala.Fun_Strings("copy_dir") { |
73322 | 206 |
val here = Scala_Project.here |
76621
7af197063e2f
clarified signature: copy directory content more directly;
wenzelm
parents:
76620
diff
changeset
|
207 |
def apply(args: List[String]): List[String] = apply_paths2(args, copy_dir(_, _)) |
73322 | 208 |
} |
209 |
||
210 |
||
211 |
/* copy files */ |
|
64189 | 212 |
|
75393 | 213 |
def copy_file(src: JFile, dst: JFile): Unit = { |
73317 | 214 |
val target = if (dst.isDirectory) new JFile(dst, src.getName) else dst |
73319 | 215 |
if (!File.eq(src, target)) { |
73322 | 216 |
try { |
217 |
Files.copy(src.toPath, target.toPath, |
|
218 |
StandardCopyOption.COPY_ATTRIBUTES, |
|
219 |
StandardCopyOption.REPLACE_EXISTING) |
|
220 |
} |
|
221 |
catch { |
|
222 |
case ERROR(msg) => |
|
73651 | 223 |
cat_error("Failed to copy file " + |
80187 | 224 |
File.path(src).absolute + " to " + File.path(target).absolute, msg) |
73322 | 225 |
} |
73317 | 226 |
} |
227 |
} |
|
228 |
||
73320 | 229 |
def copy_file(src: Path, dst: Path): Unit = copy_file(src.file, dst.file) |
73317 | 230 |
|
75393 | 231 |
def copy_file_base(base_dir: Path, src: Path, target_dir: Path): Unit = { |
73320 | 232 |
val src1 = src.expand |
233 |
val src1_dir = src1.dir |
|
76623 | 234 |
if (!src1.starts_basic) { |
235 |
error("Illegal path specification " + src1 + " beyond base directory " + base_dir.absolute) |
|
236 |
} |
|
73320 | 237 |
copy_file(base_dir + src1, Isabelle_System.make_directory(target_dir + src1_dir)) |
73317 | 238 |
} |
239 |
||
240 |
||
75393 | 241 |
object Copy_File extends Scala.Fun_Strings("copy_file") { |
73322 | 242 |
val here = Scala_Project.here |
73567 | 243 |
def apply(args: List[String]): List[String] = apply_paths2(args, copy_file) |
73322 | 244 |
} |
245 |
||
75393 | 246 |
object Copy_File_Base extends Scala.Fun_Strings("copy_file_base") { |
73322 | 247 |
val here = Scala_Project.here |
73567 | 248 |
def apply(args: List[String]): List[String] = apply_paths3(args, copy_file_base) |
73322 | 249 |
} |
250 |
||
251 |
||
252 |
/* move files */ |
|
73317 | 253 |
|
75393 | 254 |
def move_file(src: JFile, dst: JFile): Unit = { |
73317 | 255 |
val target = if (dst.isDirectory) new JFile(dst, src.getName) else dst |
73319 | 256 |
if (!File.eq(src, target)) |
73317 | 257 |
Files.move(src.toPath, target.toPath, StandardCopyOption.REPLACE_EXISTING) |
258 |
} |
|
259 |
||
73320 | 260 |
def move_file(src: Path, dst: Path): Unit = move_file(src.file, dst.file) |
73317 | 261 |
|
262 |
||
263 |
/* symbolic link */ |
|
264 |
||
75393 | 265 |
def symlink(src: Path, dst: Path, force: Boolean = false, native: Boolean = false): Unit = { |
73317 | 266 |
val src_file = src.file |
267 |
val dst_file = dst.file |
|
268 |
val target = if (dst_file.isDirectory) new JFile(dst_file, src_file.getName) else dst_file |
|
269 |
||
270 |
if (force) target.delete |
|
271 |
||
75393 | 272 |
def cygwin_link(): Unit = { |
74070 | 273 |
if (native) { |
274 |
error("Failed to create native symlink on Windows: " + quote(src_file.toString) + |
|
275 |
"\n(but it could work as Administrator)") |
|
276 |
} |
|
277 |
else isabelle.setup.Environment.cygwin_link(File.standard_path(src), target) |
|
278 |
} |
|
279 |
||
73893 | 280 |
|
73317 | 281 |
try { Files.createSymbolicLink(target.toPath, src_file.toPath) } |
282 |
catch { |
|
73893 | 283 |
case _: UnsupportedOperationException if Platform.is_windows => cygwin_link() |
284 |
case _: FileSystemException if Platform.is_windows => cygwin_link() |
|
73317 | 285 |
} |
286 |
} |
|
287 |
||
50893
d55eb82ae77b
Isabelle_System.mkdirs with explicit error checking (in accordance to ML version), e.g. relevant with read-only DMG file-system on Mac OS X;
wenzelm
parents:
50854
diff
changeset
|
288 |
|
56428
1acf2d76ac23
more standard Isabelle_System.tmp_file and tmp_dir operations, in accordance to ML version;
wenzelm
parents:
55876
diff
changeset
|
289 |
/* tmp files */ |
1acf2d76ac23
more standard Isabelle_System.tmp_file and tmp_dir operations, in accordance to ML version;
wenzelm
parents:
55876
diff
changeset
|
290 |
|
75393 | 291 |
def isabelle_tmp_prefix(): JFile = { |
56428
1acf2d76ac23
more standard Isabelle_System.tmp_file and tmp_dir operations, in accordance to ML version;
wenzelm
parents:
55876
diff
changeset
|
292 |
val path = Path.explode("$ISABELLE_TMP_PREFIX") |
72375 | 293 |
path.file.mkdirs // low-level mkdirs to avoid recursion via Isabelle environment |
60988 | 294 |
File.platform_file(path) |
56428
1acf2d76ac23
more standard Isabelle_System.tmp_file and tmp_dir operations, in accordance to ML version;
wenzelm
parents:
55876
diff
changeset
|
295 |
} |
1acf2d76ac23
more standard Isabelle_System.tmp_file and tmp_dir operations, in accordance to ML version;
wenzelm
parents:
55876
diff
changeset
|
296 |
|
76144 | 297 |
def tmp_file( |
298 |
name: String, |
|
299 |
ext: String = "", |
|
300 |
base_dir: JFile = isabelle_tmp_prefix(), |
|
301 |
initialized: Boolean = true |
|
302 |
): JFile = { |
|
77504 | 303 |
val suffix = if_proper(ext, "." + ext) |
67924 | 304 |
val file = Files.createTempFile(base_dir.toPath, name, suffix).toFile |
76144 | 305 |
if (initialized) file.deleteOnExit() else file.delete() |
56428
1acf2d76ac23
more standard Isabelle_System.tmp_file and tmp_dir operations, in accordance to ML version;
wenzelm
parents:
55876
diff
changeset
|
306 |
file |
1acf2d76ac23
more standard Isabelle_System.tmp_file and tmp_dir operations, in accordance to ML version;
wenzelm
parents:
55876
diff
changeset
|
307 |
} |
1acf2d76ac23
more standard Isabelle_System.tmp_file and tmp_dir operations, in accordance to ML version;
wenzelm
parents:
55876
diff
changeset
|
308 |
|
76177 | 309 |
def with_tmp_file[A]( |
310 |
name: String, |
|
311 |
ext: String = "", |
|
312 |
base_dir: JFile = isabelle_tmp_prefix() |
|
313 |
)(body: Path => A): A = { |
|
314 |
val file = tmp_file(name, ext, base_dir = base_dir) |
|
64220 | 315 |
try { body(File.path(file)) } finally { file.delete } |
56428
1acf2d76ac23
more standard Isabelle_System.tmp_file and tmp_dir operations, in accordance to ML version;
wenzelm
parents:
55876
diff
changeset
|
316 |
} |
1acf2d76ac23
more standard Isabelle_System.tmp_file and tmp_dir operations, in accordance to ML version;
wenzelm
parents:
55876
diff
changeset
|
317 |
|
1acf2d76ac23
more standard Isabelle_System.tmp_file and tmp_dir operations, in accordance to ML version;
wenzelm
parents:
55876
diff
changeset
|
318 |
|
56477 | 319 |
/* tmp dirs */ |
320 |
||
75393 | 321 |
def rm_tree(root: JFile): Unit = { |
56477 | 322 |
root.delete |
323 |
if (root.isDirectory) { |
|
324 |
Files.walkFileTree(root.toPath, |
|
325 |
new SimpleFileVisitor[JPath] { |
|
75393 | 326 |
override def visitFile(file: JPath, attrs: BasicFileAttributes): FileVisitResult = { |
68991
6c1beb52d766
more robust: avoid race condition wrt. cleanup of ML process, e.g. relevant for "$ISABELLE_TMP/rat.ML" in theory Codegen.Further;
wenzelm
parents:
68409
diff
changeset
|
327 |
try { Files.deleteIfExists(file) } |
6c1beb52d766
more robust: avoid race condition wrt. cleanup of ML process, e.g. relevant for "$ISABELLE_TMP/rat.ML" in theory Codegen.Further;
wenzelm
parents:
68409
diff
changeset
|
328 |
catch { case _: IOException => } |
56477 | 329 |
FileVisitResult.CONTINUE |
330 |
} |
|
331 |
||
75393 | 332 |
override def postVisitDirectory(dir: JPath, e: IOException): FileVisitResult = { |
56477 | 333 |
if (e == null) { |
68991
6c1beb52d766
more robust: avoid race condition wrt. cleanup of ML process, e.g. relevant for "$ISABELLE_TMP/rat.ML" in theory Codegen.Further;
wenzelm
parents:
68409
diff
changeset
|
334 |
try { Files.deleteIfExists(dir) } |
6c1beb52d766
more robust: avoid race condition wrt. cleanup of ML process, e.g. relevant for "$ISABELLE_TMP/rat.ML" in theory Codegen.Further;
wenzelm
parents:
68409
diff
changeset
|
335 |
catch { case _: IOException => } |
56477 | 336 |
FileVisitResult.CONTINUE |
337 |
} |
|
338 |
else throw e |
|
339 |
} |
|
340 |
} |
|
341 |
) |
|
342 |
} |
|
343 |
} |
|
344 |
||
73324 | 345 |
def rm_tree(root: Path): Unit = rm_tree(root.file) |
346 |
||
75393 | 347 |
object Rm_Tree extends Scala.Fun_Strings("rm_tree") { |
73324 | 348 |
val here = Scala_Project.here |
73567 | 349 |
def apply(args: List[String]): List[String] = apply_paths1(args, rm_tree) |
73324 | 350 |
} |
351 |
||
75393 | 352 |
def tmp_dir(name: String, base_dir: JFile = isabelle_tmp_prefix()): JFile = { |
67924 | 353 |
val dir = Files.createTempDirectory(base_dir.toPath, name).toFile |
75219 | 354 |
dir.deleteOnExit() |
56477 | 355 |
dir |
356 |
} |
|
357 |
||
76177 | 358 |
def with_tmp_dir[A]( |
359 |
name: String, |
|
360 |
base_dir: JFile = isabelle_tmp_prefix() |
|
361 |
)(body: Path => A): A = { |
|
362 |
val dir = tmp_dir(name, base_dir = base_dir) |
|
64220 | 363 |
try { body(File.path(dir)) } finally { rm_tree(dir) } |
56477 | 364 |
} |
365 |
||
366 |
||
65793 | 367 |
/* quasi-atomic update of directory */ |
368 |
||
75393 | 369 |
def update_directory(dir: Path, f: Path => Unit): Unit = { |
65793 | 370 |
val new_dir = dir.ext("new") |
371 |
val old_dir = dir.ext("old") |
|
372 |
||
373 |
rm_tree(new_dir) |
|
374 |
rm_tree(old_dir) |
|
375 |
||
376 |
f(new_dir) |
|
377 |
||
73317 | 378 |
if (dir.is_dir) move_file(dir, old_dir) |
379 |
move_file(new_dir, dir) |
|
65793 | 380 |
rm_tree(old_dir) |
381 |
} |
|
382 |
||
383 |
||
76145 | 384 |
/* TCP/IP ports */ |
385 |
||
386 |
def local_port(): Int = { |
|
387 |
val socket = new ServerSocket(0) |
|
388 |
val port = socket.getLocalPort |
|
389 |
socket.close() |
|
390 |
port |
|
391 |
} |
|
392 |
||
62613 | 393 |
|
76146 | 394 |
/* JVM shutdown hook */ |
395 |
||
396 |
def create_shutdown_hook(body: => Unit): Thread = { |
|
397 |
val shutdown_hook = Isabelle_Thread.create(new Runnable { def run: Unit = body }) |
|
398 |
||
399 |
try { Runtime.getRuntime.addShutdownHook(shutdown_hook) } |
|
400 |
catch { case _: IllegalStateException => } |
|
401 |
||
402 |
shutdown_hook |
|
403 |
} |
|
404 |
||
405 |
def remove_shutdown_hook(shutdown_hook: Thread): Unit = |
|
406 |
try { Runtime.getRuntime.removeShutdownHook(shutdown_hook) } |
|
407 |
catch { case _: IllegalStateException => } |
|
408 |
||
409 |
||
410 |
||
62613 | 411 |
/** external processes **/ |
412 |
||
413 |
/* GNU bash */ |
|
31796 | 414 |
|
62610
4c89504c76fb
more uniform signature for various process invocations;
wenzelm
parents:
62602
diff
changeset
|
415 |
def bash(script: String, |
74212 | 416 |
description: String = "", |
80218 | 417 |
ssh: SSH.System = SSH.Local, |
62610
4c89504c76fb
more uniform signature for various process invocations;
wenzelm
parents:
62602
diff
changeset
|
418 |
cwd: JFile = null, |
73897 | 419 |
env: JMap[String, String] = settings(), |
62610
4c89504c76fb
more uniform signature for various process invocations;
wenzelm
parents:
62602
diff
changeset
|
420 |
redirect: Boolean = false, |
74142
0f051404f487
clarified signature: more options for bash_process;
wenzelm
parents:
74070
diff
changeset
|
421 |
input: String = "", |
51962
016cb7d8f297
limit build process output, to avoid bombing Isabelle/Scala process by ill-behaved jobs (e.g. Containers in AFP/9025435b29cf);
wenzelm
parents:
51820
diff
changeset
|
422 |
progress_stdout: String => Unit = (_: String) => (), |
016cb7d8f297
limit build process output, to avoid bombing Isabelle/Scala process by ill-behaved jobs (e.g. Containers in AFP/9025435b29cf);
wenzelm
parents:
51820
diff
changeset
|
423 |
progress_stderr: String => Unit = (_: String) => (), |
72598 | 424 |
watchdog: Option[Bash.Watchdog] = None, |
62602 | 425 |
strict: Boolean = true, |
75393 | 426 |
cleanup: () => Unit = () => () |
427 |
): Process_Result = { |
|
80218 | 428 |
Bash.process(script, description = description, ssh = ssh, cwd = cwd, env = env, |
429 |
redirect = redirect, cleanup = cleanup). |
|
74142
0f051404f487
clarified signature: more options for bash_process;
wenzelm
parents:
74070
diff
changeset
|
430 |
result(input = input, progress_stdout = progress_stdout, progress_stderr = progress_stderr, |
72598 | 431 |
watchdog = watchdog, strict = strict) |
34198
ff5486262cd6
moved Library.decode_permissive_utf8 to Isabelle_System;
wenzelm
parents:
34196
diff
changeset
|
432 |
} |
ff5486262cd6
moved Library.decode_permissive_utf8 to Isabelle_System;
wenzelm
parents:
34196
diff
changeset
|
433 |
|
75218 | 434 |
|
435 |
/* command-line tools */ |
|
436 |
||
75393 | 437 |
def require_command(cmd: String, test: String = "--version"): Unit = { |
75218 | 438 |
if (!bash(Bash.string(cmd) + " " + test).ok) error("Missing system command: " + quote(cmd)) |
439 |
} |
|
440 |
||
64935
9437a117408b
insist in proper GNU tar, to avoid subtle semantic differences;
wenzelm
parents:
64657
diff
changeset
|
441 |
private lazy val gnutar_check: Boolean = |
9437a117408b
insist in proper GNU tar, to avoid subtle semantic differences;
wenzelm
parents:
64657
diff
changeset
|
442 |
try { bash("tar --version").check.out.containsSlice("GNU tar") || error("") } |
9437a117408b
insist in proper GNU tar, to avoid subtle semantic differences;
wenzelm
parents:
64657
diff
changeset
|
443 |
catch { case ERROR(_) => false } |
9437a117408b
insist in proper GNU tar, to avoid subtle semantic differences;
wenzelm
parents:
64657
diff
changeset
|
444 |
|
69425 | 445 |
def gnutar( |
446 |
args: String, |
|
447 |
dir: Path = Path.current, |
|
448 |
original_owner: Boolean = false, |
|
76540
83de6e9ae983
clarified signature: prefer Scala functions instead of shell scripts;
wenzelm
parents:
76533
diff
changeset
|
449 |
strip: Boolean = false, |
75393 | 450 |
redirect: Boolean = false |
451 |
): Process_Result = { |
|
69425 | 452 |
val options = |
453 |
(if (dir.is_current) "" else "-C " + File.bash_path(dir) + " ") + |
|
73624 | 454 |
(if (original_owner) "" else "--owner=root --group=staff ") + |
76540
83de6e9ae983
clarified signature: prefer Scala functions instead of shell scripts;
wenzelm
parents:
76533
diff
changeset
|
455 |
(if (!strip) "" else "--strip-components=1 ") |
69425 | 456 |
|
457 |
if (gnutar_check) bash("tar " + options + args, redirect = redirect) |
|
64935
9437a117408b
insist in proper GNU tar, to avoid subtle semantic differences;
wenzelm
parents:
64657
diff
changeset
|
458 |
else error("Expected to find GNU tar executable") |
9437a117408b
insist in proper GNU tar, to avoid subtle semantic differences;
wenzelm
parents:
64657
diff
changeset
|
459 |
} |
9437a117408b
insist in proper GNU tar, to avoid subtle semantic differences;
wenzelm
parents:
64657
diff
changeset
|
460 |
|
76540
83de6e9ae983
clarified signature: prefer Scala functions instead of shell scripts;
wenzelm
parents:
76533
diff
changeset
|
461 |
def extract(archive: Path, dir: Path, strip: Boolean = false): Unit = { |
76533 | 462 |
val name = archive.file_name |
76541 | 463 |
make_directory(dir) |
76546 | 464 |
if (File.is_zip(name) || File.is_jar(name)) { |
465 |
using(new ZipFile(archive.file)) { zip_file => |
|
466 |
val items = |
|
467 |
for (entry <- zip_file.entries().asScala.toList) |
|
468 |
yield { |
|
469 |
val input = JPath.of(entry.getName) |
|
470 |
val count = input.getNameCount |
|
471 |
val output = |
|
472 |
if (strip && count <= 1) None |
|
473 |
else if (strip) Some(input.subpath(1, count)) |
|
474 |
else Some(input) |
|
475 |
val result = output.map(dir.java_path.resolve(_)) |
|
476 |
for (res <- result) { |
|
477 |
if (entry.isDirectory) Files.createDirectories(res) |
|
478 |
else { |
|
479 |
val bytes = using(zip_file.getInputStream(entry))(Bytes.read_stream(_)) |
|
480 |
Files.createDirectories(res.getParent) |
|
481 |
Files.write(res, bytes.array) |
|
482 |
} |
|
483 |
} |
|
484 |
(entry, result) |
|
485 |
} |
|
486 |
for { |
|
78592 | 487 |
case (entry, Some(res)) <- items |
76546 | 488 |
if !entry.isDirectory |
489 |
t <- Option(entry.getLastModifiedTime) |
|
490 |
} Files.setLastModifiedTime(res, t) |
|
491 |
} |
|
76543
fef0195f8d8e
clarified signature: prefer Scala functions instead of shell scripts;
wenzelm
parents:
76541
diff
changeset
|
492 |
} |
76540
83de6e9ae983
clarified signature: prefer Scala functions instead of shell scripts;
wenzelm
parents:
76533
diff
changeset
|
493 |
else if (File.is_tar_bz2(name) || File.is_tgz(name) || File.is_tar_gz(name)) { |
83de6e9ae983
clarified signature: prefer Scala functions instead of shell scripts;
wenzelm
parents:
76533
diff
changeset
|
494 |
val flags = if (File.is_tar_bz2(name)) "-xjf " else "-xzf " |
83de6e9ae983
clarified signature: prefer Scala functions instead of shell scripts;
wenzelm
parents:
76533
diff
changeset
|
495 |
Isabelle_System.gnutar(flags + File.bash_path(archive), dir = dir, strip = strip).check |
76533 | 496 |
} |
497 |
else error("Cannot extract " + archive) |
|
498 |
} |
|
76530 | 499 |
|
75393 | 500 |
def make_patch(base_dir: Path, src: Path, dst: Path, diff_options: String = ""): String = { |
75394 | 501 |
with_tmp_file("patch") { patch => |
75229 | 502 |
Isabelle_System.bash( |
75230
bbbee54b1198
prepare patched version more thoroughly, with explicit patches;
wenzelm
parents:
75229
diff
changeset
|
503 |
"diff -ru " + diff_options + " -- " + File.bash_path(src) + " " + File.bash_path(dst) + |
bbbee54b1198
prepare patched version more thoroughly, with explicit patches;
wenzelm
parents:
75229
diff
changeset
|
504 |
" > " + File.bash_path(patch), |
75229 | 505 |
cwd = base_dir.file).check_rc(_ <= 1) |
506 |
File.read(patch) |
|
75394 | 507 |
} |
75220 | 508 |
} |
509 |
||
54690 | 510 |
def open(arg: String): Unit = |
64304 | 511 |
bash("exec \"$ISABELLE_OPEN\" " + Bash.string(arg) + " >/dev/null 2>/dev/null &") |
54690 | 512 |
|
513 |
def pdf_viewer(arg: Path): Unit = |
|
62616 | 514 |
bash("exec \"$PDF_VIEWER\" " + File.bash_path(arg) + " >/dev/null 2>/dev/null &") |
54690 | 515 |
|
75393 | 516 |
def open_external_file(name: String): Boolean = { |
73224
49686e3b1909
clarified links to external files, e.g. .pdf within .thy source document;
wenzelm
parents:
72976
diff
changeset
|
517 |
val ext = Library.take_suffix((c: Char) => c != '.', name.toList)._2.mkString |
49686e3b1909
clarified links to external files, e.g. .pdf within .thy source document;
wenzelm
parents:
72976
diff
changeset
|
518 |
val external = |
77218 | 519 |
ext.nonEmpty && space_explode(':', getenv("ISABELLE_EXTERNAL_FILES")).contains(ext) |
73224
49686e3b1909
clarified links to external files, e.g. .pdf within .thy source document;
wenzelm
parents:
72976
diff
changeset
|
520 |
if (external) { |
49686e3b1909
clarified links to external files, e.g. .pdf within .thy source document;
wenzelm
parents:
72976
diff
changeset
|
521 |
if (ext == "pdf" && Path.is_wellformed(name)) pdf_viewer(Path.explode(name)) |
49686e3b1909
clarified links to external files, e.g. .pdf within .thy source document;
wenzelm
parents:
72976
diff
changeset
|
522 |
else open(name) |
49686e3b1909
clarified links to external files, e.g. .pdf within .thy source document;
wenzelm
parents:
72976
diff
changeset
|
523 |
} |
49686e3b1909
clarified links to external files, e.g. .pdf within .thy source document;
wenzelm
parents:
72976
diff
changeset
|
524 |
external |
49686e3b1909
clarified links to external files, e.g. .pdf within .thy source document;
wenzelm
parents:
72976
diff
changeset
|
525 |
} |
49686e3b1909
clarified links to external files, e.g. .pdf within .thy source document;
wenzelm
parents:
72976
diff
changeset
|
526 |
|
65916 | 527 |
|
32450 | 528 |
|
31796 | 529 |
/** Isabelle resources **/ |
530 |
||
64161 | 531 |
/* repository clone with Admin */ |
532 |
||
533 |
def admin(): Boolean = Path.explode("~~/Admin").is_dir |
|
534 |
||
535 |
||
62633 | 536 |
/* default logic */ |
48503 | 537 |
|
75393 | 538 |
def default_logic(args: String*): String = { |
50403
87868964733c
more uniform default logic, using settings, options, args etc.;
wenzelm
parents:
50298
diff
changeset
|
539 |
args.find(_ != "") match { |
87868964733c
more uniform default logic, using settings, options, args etc.;
wenzelm
parents:
50298
diff
changeset
|
540 |
case Some(logic) => logic |
73317 | 541 |
case None => getenv_strict("ISABELLE_LOGIC") |
50403
87868964733c
more uniform default logic, using settings, options, args etc.;
wenzelm
parents:
50298
diff
changeset
|
542 |
} |
87868964733c
more uniform default logic, using settings, options, args etc.;
wenzelm
parents:
50298
diff
changeset
|
543 |
} |
73323 | 544 |
|
545 |
||
546 |
/* download file */ |
|
547 |
||
75393 | 548 |
def download(url_name: String, progress: Progress = new Progress): HTTP.Content = { |
73335 | 549 |
val url = Url(url_name) |
550 |
progress.echo("Getting " + quote(url_name)) |
|
73566 | 551 |
try { HTTP.Client.get(url) } |
552 |
catch { case ERROR(msg) => cat_error("Failed to download " + quote(url_name), msg) } |
|
73323 | 553 |
} |
554 |
||
73566 | 555 |
def download_file(url_name: String, file: Path, progress: Progress = new Progress): Unit = |
556 |
Bytes.write(file, download(url_name, progress = progress).bytes) |
|
557 |
||
75393 | 558 |
object Download extends Scala.Fun("download", thread = true) { |
73323 | 559 |
val here = Scala_Project.here |
77027 | 560 |
override def invoke(session: Session, args: List[Bytes]): List[Bytes] = |
75439 | 561 |
args.map(url => download(url.text).bytes) |
73323 | 562 |
} |
73608 | 563 |
|
564 |
||
565 |
/* repositories */ |
|
566 |
||
73611 | 567 |
val isabelle_repository: Mercurial.Server = |
568 |
Mercurial.Server("https://isabelle.sketis.net/repos/isabelle") |
|
73608 | 569 |
|
73611 | 570 |
val afp_repository: Mercurial.Server = |
571 |
Mercurial.Server("https://isabelle.sketis.net/repos/afp-devel") |
|
73610 | 572 |
|
573 |
def official_releases(): List[String] = |
|
574 |
Library.trim_split_lines( |
|
575 |
isabelle_repository.read_file(Path.explode("Admin/Release/official"))) |
|
27919 | 576 |
} |