src/Pure/Admin/other_isabelle.scala
author wenzelm
Tue, 24 Jan 2023 21:27:10 +0100
changeset 77085 351eee493580
parent 77082 4e724a439035
child 77087 7770537f5ceb
permissions -rw-r--r--
more robust locations (amending 7e11e96a922d) --- notably for cleanup() in build_release, after Admin/ been deleted;
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
64188
f88bae1922c4 clarified modules;
wenzelm
parents:
diff changeset
     1
/*  Title:      Pure/Admin/other_isabelle.scala
f88bae1922c4 clarified modules;
wenzelm
parents:
diff changeset
     2
    Author:     Makarius
f88bae1922c4 clarified modules;
wenzelm
parents:
diff changeset
     3
77082
4e724a439035 tuned comments;
wenzelm
parents: 77081
diff changeset
     4
Manage other Isabelle distributions: support historic versions starting from
4e724a439035 tuned comments;
wenzelm
parents: 77081
diff changeset
     5
tag "build_history_base".
64188
f88bae1922c4 clarified modules;
wenzelm
parents:
diff changeset
     6
*/
f88bae1922c4 clarified modules;
wenzelm
parents:
diff changeset
     7
f88bae1922c4 clarified modules;
wenzelm
parents:
diff changeset
     8
package isabelle
f88bae1922c4 clarified modules;
wenzelm
parents:
diff changeset
     9
f88bae1922c4 clarified modules;
wenzelm
parents:
diff changeset
    10
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 73988
diff changeset
    11
object Other_Isabelle {
77050
wenzelm
parents: 77044
diff changeset
    12
  def apply(
wenzelm
parents: 77044
diff changeset
    13
    isabelle_home: Path,
wenzelm
parents: 77044
diff changeset
    14
    isabelle_identifier: String = "",
wenzelm
parents: 77044
diff changeset
    15
    progress: Progress = new Progress
wenzelm
parents: 77044
diff changeset
    16
  ): Other_Isabelle = {
77075
973de7855948 removed unused user_home argument (see also 897f1ac84aab and 19b6091c2137);
wenzelm
parents: 77073
diff changeset
    17
    new Other_Isabelle(isabelle_home.canonical, isabelle_identifier, progress)
77050
wenzelm
parents: 77044
diff changeset
    18
  }
67045
6c94f749410a tuned signature;
wenzelm
parents: 65930
diff changeset
    19
}
6c94f749410a tuned signature;
wenzelm
parents: 65930
diff changeset
    20
77041
4adee07a5e48 tuned signature;
wenzelm
parents: 77040
diff changeset
    21
final class Other_Isabelle private(
67045
6c94f749410a tuned signature;
wenzelm
parents: 65930
diff changeset
    22
  val isabelle_home: Path,
6c94f749410a tuned signature;
wenzelm
parents: 65930
diff changeset
    23
  val isabelle_identifier: String,
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 73988
diff changeset
    24
  progress: Progress
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 73988
diff changeset
    25
) {
69404
de88761edbe2 clarified absolute isabelle_home and (implicitly) isabelle_home_user;
wenzelm
parents: 69401
diff changeset
    26
  override def toString: String = isabelle_home.toString
67046
897f1ac84aab clarified settings environment;
wenzelm
parents: 67045
diff changeset
    27
77042
wenzelm
parents: 77041
diff changeset
    28
  if (proper_string(System.getenv("ISABELLE_SETTINGS_PRESENT")).isDefined) {
67046
897f1ac84aab clarified settings environment;
wenzelm
parents: 67045
diff changeset
    29
    error("Cannot initialize with enclosing ISABELLE_SETTINGS_PRESENT")
77042
wenzelm
parents: 77041
diff changeset
    30
  }
67046
897f1ac84aab clarified settings environment;
wenzelm
parents: 67045
diff changeset
    31
64188
f88bae1922c4 clarified modules;
wenzelm
parents:
diff changeset
    32
f88bae1922c4 clarified modules;
wenzelm
parents:
diff changeset
    33
  /* static system */
f88bae1922c4 clarified modules;
wenzelm
parents:
diff changeset
    34
65930
9a28fc03c3fe tuned signature;
wenzelm
parents: 65916
diff changeset
    35
  def bash(
77042
wenzelm
parents: 77041
diff changeset
    36
    script: String,
wenzelm
parents: 77041
diff changeset
    37
    redirect: Boolean = false,
wenzelm
parents: 77041
diff changeset
    38
    echo: Boolean = false,
wenzelm
parents: 77041
diff changeset
    39
    strict: Boolean = true
wenzelm
parents: 77041
diff changeset
    40
  ): Process_Result = {
67046
897f1ac84aab clarified settings environment;
wenzelm
parents: 67045
diff changeset
    41
    progress.bash(
897f1ac84aab clarified settings environment;
wenzelm
parents: 67045
diff changeset
    42
      Isabelle_System.export_isabelle_identifier(isabelle_identifier) + script,
65930
9a28fc03c3fe tuned signature;
wenzelm
parents: 65916
diff changeset
    43
      env = null, cwd = isabelle_home.file, redirect = redirect, echo = echo, strict = strict)
77042
wenzelm
parents: 77041
diff changeset
    44
  }
64188
f88bae1922c4 clarified modules;
wenzelm
parents:
diff changeset
    45
69166
5c553c48c0e5 tuned signature;
wenzelm
parents: 68754
diff changeset
    46
  def getenv(name: String): String =
77071
wenzelm
parents: 77069
diff changeset
    47
    bash("bin/isabelle getenv -b " + Bash.string(name)).check.out
69166
5c553c48c0e5 tuned signature;
wenzelm
parents: 68754
diff changeset
    48
77080
7e11e96a922d more formal Other_Isabelle.settings, with derived expand_path / bash_path;
wenzelm
parents: 77078
diff changeset
    49
  val settings: Isabelle_System.Settings = (name: String) => getenv(name)
7e11e96a922d more formal Other_Isabelle.settings, with derived expand_path / bash_path;
wenzelm
parents: 77078
diff changeset
    50
7e11e96a922d more formal Other_Isabelle.settings, with derived expand_path / bash_path;
wenzelm
parents: 77078
diff changeset
    51
  def expand_path(path: Path): Path = path.expand_env(settings)
7e11e96a922d more formal Other_Isabelle.settings, with derived expand_path / bash_path;
wenzelm
parents: 77078
diff changeset
    52
  def bash_path(path: Path): String = Bash.string(expand_path(path).implode)
64188
f88bae1922c4 clarified modules;
wenzelm
parents:
diff changeset
    53
77085
351eee493580 more robust locations (amending 7e11e96a922d) --- notably for cleanup() in build_release, after Admin/ been deleted;
wenzelm
parents: 77082
diff changeset
    54
  val isabelle_home_user: Path = expand_path(Path.explode("$ISABELLE_HOME_USER"))
77080
7e11e96a922d more formal Other_Isabelle.settings, with derived expand_path / bash_path;
wenzelm
parents: 77078
diff changeset
    55
77085
351eee493580 more robust locations (amending 7e11e96a922d) --- notably for cleanup() in build_release, after Admin/ been deleted;
wenzelm
parents: 77082
diff changeset
    56
  def etc: Path = isabelle_home_user + Path.explode("etc")
77080
7e11e96a922d more formal Other_Isabelle.settings, with derived expand_path / bash_path;
wenzelm
parents: 77078
diff changeset
    57
  def etc_settings: Path = etc + Path.explode("settings")
7e11e96a922d more formal Other_Isabelle.settings, with derived expand_path / bash_path;
wenzelm
parents: 77078
diff changeset
    58
  def etc_preferences: Path = etc + Path.explode("preferences")
64188
f88bae1922c4 clarified modules;
wenzelm
parents:
diff changeset
    59
77071
wenzelm
parents: 77069
diff changeset
    60
  def resolve_components(echo: Boolean = false): Unit = {
77069
348f4d95d110 more robust (see also 7f55a3e28c88): resolve components from current Isabelle context, using Isabelle/Scala instead of shell scripts;
wenzelm
parents: 77055
diff changeset
    61
    val missing = Path.split(getenv("ISABELLE_COMPONENTS_MISSING"))
348f4d95d110 more robust (see also 7f55a3e28c88): resolve components from current Isabelle context, using Isabelle/Scala instead of shell scripts;
wenzelm
parents: 77055
diff changeset
    62
    for (path <- missing) {
77071
wenzelm
parents: 77069
diff changeset
    63
      Components.resolve(path.dir, path.file_name,
wenzelm
parents: 77069
diff changeset
    64
        progress = if (echo) progress else new Progress)
77069
348f4d95d110 more robust (see also 7f55a3e28c88): resolve components from current Isabelle context, using Isabelle/Scala instead of shell scripts;
wenzelm
parents: 77055
diff changeset
    65
    }
348f4d95d110 more robust (see also 7f55a3e28c88): resolve components from current Isabelle context, using Isabelle/Scala instead of shell scripts;
wenzelm
parents: 77055
diff changeset
    66
  }
348f4d95d110 more robust (see also 7f55a3e28c88): resolve components from current Isabelle context, using Isabelle/Scala instead of shell scripts;
wenzelm
parents: 77055
diff changeset
    67
77072
e8010cb36820 more robust and uniform Other_Isabelle.scala_build;
wenzelm
parents: 77071
diff changeset
    68
  def scala_build(fresh: Boolean = false, echo: Boolean = false): Unit = {
e8010cb36820 more robust and uniform Other_Isabelle.scala_build;
wenzelm
parents: 77071
diff changeset
    69
    if (fresh) {
e8010cb36820 more robust and uniform Other_Isabelle.scala_build;
wenzelm
parents: 77071
diff changeset
    70
      Isabelle_System.rm_tree(isabelle_home + Path.explode("lib/classes"))
e8010cb36820 more robust and uniform Other_Isabelle.scala_build;
wenzelm
parents: 77071
diff changeset
    71
    }
77073
7b65209fdfe8 more robust: self-contained Other_Isabelle.isabelle_home;
wenzelm
parents: 77072
diff changeset
    72
77080
7e11e96a922d more formal Other_Isabelle.settings, with derived expand_path / bash_path;
wenzelm
parents: 77078
diff changeset
    73
    val dummy_stty = Path.explode("~~/lib/dummy_stty/stty")
7e11e96a922d more formal Other_Isabelle.settings, with derived expand_path / bash_path;
wenzelm
parents: 77078
diff changeset
    74
    if (!expand_path(dummy_stty).is_file) {
7e11e96a922d more formal Other_Isabelle.settings, with derived expand_path / bash_path;
wenzelm
parents: 77078
diff changeset
    75
      Isabelle_System.copy_file(dummy_stty,
7e11e96a922d more formal Other_Isabelle.settings, with derived expand_path / bash_path;
wenzelm
parents: 77078
diff changeset
    76
        Isabelle_System.make_directory(expand_path(dummy_stty.dir)))
77073
7b65209fdfe8 more robust: self-contained Other_Isabelle.isabelle_home;
wenzelm
parents: 77072
diff changeset
    77
    }
77072
e8010cb36820 more robust and uniform Other_Isabelle.scala_build;
wenzelm
parents: 77071
diff changeset
    78
    try {
e8010cb36820 more robust and uniform Other_Isabelle.scala_build;
wenzelm
parents: 77071
diff changeset
    79
      bash(
77080
7e11e96a922d more formal Other_Isabelle.settings, with derived expand_path / bash_path;
wenzelm
parents: 77078
diff changeset
    80
        "export PATH=\"" + bash_path(dummy_stty.dir) + ":$PATH\"\n" +
77072
e8010cb36820 more robust and uniform Other_Isabelle.scala_build;
wenzelm
parents: 77071
diff changeset
    81
        "export CLASSPATH=" + Bash.string(getenv("ISABELLE_CLASSPATH")) + "\n" +
e8010cb36820 more robust and uniform Other_Isabelle.scala_build;
wenzelm
parents: 77071
diff changeset
    82
        "bin/isabelle jedit -b", echo = echo).check
e8010cb36820 more robust and uniform Other_Isabelle.scala_build;
wenzelm
parents: 77071
diff changeset
    83
    }
e8010cb36820 more robust and uniform Other_Isabelle.scala_build;
wenzelm
parents: 77071
diff changeset
    84
    catch { case ERROR(msg) => cat_error("Failed to build Isabelle/Scala/Java modules:", msg) }
e8010cb36820 more robust and uniform Other_Isabelle.scala_build;
wenzelm
parents: 77071
diff changeset
    85
  }
e8010cb36820 more robust and uniform Other_Isabelle.scala_build;
wenzelm
parents: 77071
diff changeset
    86
73625
f8f065e20837 misc tuning and clarification: more explicit types Release_Context, Release_Archive;
wenzelm
parents: 73522
diff changeset
    87
69388
fc58534bc475 clarified component settings;
wenzelm
parents: 69387
diff changeset
    88
  /* components */
fc58534bc475 clarified component settings;
wenzelm
parents: 69387
diff changeset
    89
fc58534bc475 clarified component settings;
wenzelm
parents: 69387
diff changeset
    90
  def init_components(
73240
3e963d68d394 more robust ISABELLE_COMPONENT_REPOSITORY: use current value of managing process to avoid its fluctuation in ancient history;
wenzelm
parents: 72375
diff changeset
    91
    component_repository: String = Components.default_component_repository,
69434
b93404a4c3dd clarified settings and defaults;
wenzelm
parents: 69408
diff changeset
    92
    components_base: Path = Components.default_components_base,
77055
f56800b8b085 clarified defaults;
wenzelm
parents: 77050
diff changeset
    93
    catalogs: List[String] = Components.default_catalogs,
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 73988
diff changeset
    94
    components: List[String] = Nil
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 73988
diff changeset
    95
  ): List[String] = {
69404
de88761edbe2 clarified absolute isabelle_home and (implicitly) isabelle_home_user;
wenzelm
parents: 69401
diff changeset
    96
    val dir = Components.admin(isabelle_home)
73240
3e963d68d394 more robust ISABELLE_COMPONENT_REPOSITORY: use current value of managing process to avoid its fluctuation in ancient history;
wenzelm
parents: 72375
diff changeset
    97
3e963d68d394 more robust ISABELLE_COMPONENT_REPOSITORY: use current value of managing process to avoid its fluctuation in ancient history;
wenzelm
parents: 72375
diff changeset
    98
    ("ISABELLE_COMPONENT_REPOSITORY=" + Bash.string(component_repository)) ::
69396
56bea34e0f8e clarified signature;
wenzelm
parents: 69395
diff changeset
    99
    catalogs.map(name =>
69434
b93404a4c3dd clarified settings and defaults;
wenzelm
parents: 69408
diff changeset
   100
      "init_components " + File.bash_path(components_base) + " " +
b93404a4c3dd clarified settings and defaults;
wenzelm
parents: 69408
diff changeset
   101
        File.bash_path(dir + Path.basic(name))) :::
69396
56bea34e0f8e clarified signature;
wenzelm
parents: 69395
diff changeset
   102
    components.map(name =>
69434
b93404a4c3dd clarified settings and defaults;
wenzelm
parents: 69408
diff changeset
   103
      "init_component " + File.bash_path(components_base + Path.basic(name)))
69388
fc58534bc475 clarified component settings;
wenzelm
parents: 69387
diff changeset
   104
  }
fc58534bc475 clarified component settings;
wenzelm
parents: 69387
diff changeset
   105
fc58534bc475 clarified component settings;
wenzelm
parents: 69387
diff changeset
   106
69168
68816d1c73a7 eliminated "isabelle makedist" -- prefer Scala over bash/perl scripting;
wenzelm
parents: 69166
diff changeset
   107
  /* settings */
68816d1c73a7 eliminated "isabelle makedist" -- prefer Scala over bash/perl scripting;
wenzelm
parents: 69166
diff changeset
   108
68816d1c73a7 eliminated "isabelle makedist" -- prefer Scala over bash/perl scripting;
wenzelm
parents: 69166
diff changeset
   109
  def clean_settings(): Boolean =
68816d1c73a7 eliminated "isabelle makedist" -- prefer Scala over bash/perl scripting;
wenzelm
parents: 69166
diff changeset
   110
    if (!etc_settings.is_file) true
68816d1c73a7 eliminated "isabelle makedist" -- prefer Scala over bash/perl scripting;
wenzelm
parents: 69166
diff changeset
   111
    else if (File.read(etc_settings).startsWith("# generated by Isabelle")) {
77042
wenzelm
parents: 77041
diff changeset
   112
      etc_settings.file.delete
wenzelm
parents: 77041
diff changeset
   113
      true
69168
68816d1c73a7 eliminated "isabelle makedist" -- prefer Scala over bash/perl scripting;
wenzelm
parents: 69166
diff changeset
   114
    }
68816d1c73a7 eliminated "isabelle makedist" -- prefer Scala over bash/perl scripting;
wenzelm
parents: 69166
diff changeset
   115
    else false
64188
f88bae1922c4 clarified modules;
wenzelm
parents:
diff changeset
   116
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 73988
diff changeset
   117
  def init_settings(settings: List[String]): Unit = {
77078
wenzelm
parents: 77075
diff changeset
   118
    if (clean_settings()) {
wenzelm
parents: 77075
diff changeset
   119
      Isabelle_System.make_directory(etc_settings.dir)
wenzelm
parents: 77075
diff changeset
   120
      File.write(etc_settings,
wenzelm
parents: 77075
diff changeset
   121
        "# generated by Isabelle " + Date.now() + "\n" +
wenzelm
parents: 77075
diff changeset
   122
        "#-*- shell-script -*- :mode=shellscript:\n" +
wenzelm
parents: 77075
diff changeset
   123
        settings.mkString("\n", "\n", "\n"))
77042
wenzelm
parents: 77041
diff changeset
   124
    }
77078
wenzelm
parents: 77075
diff changeset
   125
    else error("Cannot proceed with existing user settings file: " + etc_settings)
64188
f88bae1922c4 clarified modules;
wenzelm
parents:
diff changeset
   126
  }
69168
68816d1c73a7 eliminated "isabelle makedist" -- prefer Scala over bash/perl scripting;
wenzelm
parents: 69166
diff changeset
   127
68816d1c73a7 eliminated "isabelle makedist" -- prefer Scala over bash/perl scripting;
wenzelm
parents: 69166
diff changeset
   128
68816d1c73a7 eliminated "isabelle makedist" -- prefer Scala over bash/perl scripting;
wenzelm
parents: 69166
diff changeset
   129
  /* cleanup */
68816d1c73a7 eliminated "isabelle makedist" -- prefer Scala over bash/perl scripting;
wenzelm
parents: 69166
diff changeset
   130
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 73988
diff changeset
   131
  def cleanup(): Unit = {
69168
68816d1c73a7 eliminated "isabelle makedist" -- prefer Scala over bash/perl scripting;
wenzelm
parents: 69166
diff changeset
   132
    clean_settings()
68816d1c73a7 eliminated "isabelle makedist" -- prefer Scala over bash/perl scripting;
wenzelm
parents: 69166
diff changeset
   133
    etc.file.delete
68816d1c73a7 eliminated "isabelle makedist" -- prefer Scala over bash/perl scripting;
wenzelm
parents: 69166
diff changeset
   134
    isabelle_home_user.file.delete
68816d1c73a7 eliminated "isabelle makedist" -- prefer Scala over bash/perl scripting;
wenzelm
parents: 69166
diff changeset
   135
  }
64188
f88bae1922c4 clarified modules;
wenzelm
parents:
diff changeset
   136
}