src/Pure/Admin/component_solr.scala
author haftmann
Mon, 16 Jun 2025 15:25:38 +0200
changeset 82730 3b98b1b57435
parent 81784 12028de0b66a
permissions -rw-r--r--
more explicit theorem names for list quantifiers
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
81784
12028de0b66a tuned headers;
wenzelm
parents: 81779
diff changeset
     1
/*  Title:      Pure/Admin/component_solr.scala
12028de0b66a tuned headers;
wenzelm
parents: 81779
diff changeset
     2
    Author:     Fabian Huch, TU Muenchen
81764
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
     3
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
     4
Build Isabelle Solr component from official downloads. See also: https://solr.apache.org/
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
     5
*/
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
     6
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
     7
package isabelle
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
     8
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
     9
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    10
object Component_Solr {
81767
3f90880136fe clarified solr settings;
wenzelm
parents: 81765
diff changeset
    11
  val default_download_url = "https://dlcdn.apache.org/solr/solr/9.7.0/solr-9.7.0.tgz"
81764
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    12
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    13
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    14
  /* build solr */
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    15
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    16
  def build_solr(
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    17
    download_url: String = default_download_url,
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    18
    progress: Progress = new Progress,
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    19
    target_dir: Path = Path.current
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    20
  ): Unit =
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    21
    Isabelle_System.with_tmp_dir("build") { tmp_dir =>
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    22
      /* component */
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    23
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    24
      val Archive_Name = """^.*/([^/]+)$""".r
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    25
      val Version = """^solr-(.*)\.tgz$""".r
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    26
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    27
      val archive_name =
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    28
        download_url match {
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    29
          case Archive_Name(name) => name
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    30
          case _ => error("Failed to determine source archive name from " + quote(download_url))
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    31
        }
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    32
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    33
      val version =
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    34
        archive_name match {
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    35
          case Version(version) => version
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    36
          case _ => error("Failed to determine component version from " + quote(archive_name))
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    37
        }
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    38
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    39
      val component_name = "solr-" + version
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    40
      val component_dir =
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    41
        Components.Directory(target_dir + Path.basic(component_name)).create(progress = progress)
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    42
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    43
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    44
      /* download */
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    45
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    46
      val archive_path = tmp_dir + Path.basic(archive_name)
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    47
      Isabelle_System.download_file(download_url, archive_path, progress = progress)
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    48
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    49
      Isabelle_System.extract(archive_path, tmp_dir)
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    50
      val source_dir = File.get_dir(tmp_dir, title = download_url)
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    51
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    52
      Isabelle_System.copy_file(source_dir + Path.explode("LICENSE.txt"), component_dir.path)
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    53
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    54
      val webapp_lib_dir = source_dir + Path.explode("server/solr-webapp/webapp/WEB-INF/lib")
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    55
      val server_lib_dir = source_dir + Path.explode("server/lib")
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    56
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    57
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    58
      /* jars */
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    59
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    60
      Isabelle_System.make_directory(component_dir.lib)
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    61
81778
14ace6211ce8 misc tuning;
wenzelm
parents: 81768
diff changeset
    62
      for {
14ace6211ce8 misc tuning;
wenzelm
parents: 81768
diff changeset
    63
        dir <- List(webapp_lib_dir, server_lib_dir)
14ace6211ce8 misc tuning;
wenzelm
parents: 81768
diff changeset
    64
        jar <- File.find_files(dir.file, _.getName.endsWith(".jar"))
14ace6211ce8 misc tuning;
wenzelm
parents: 81768
diff changeset
    65
      } Isabelle_System.copy_file(jar, component_dir.lib.file)
81764
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    66
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    67
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    68
      /* settings */
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    69
81778
14ace6211ce8 misc tuning;
wenzelm
parents: 81768
diff changeset
    70
      def quote_jars(names: List[String]): String =
14ace6211ce8 misc tuning;
wenzelm
parents: 81768
diff changeset
    71
        quote(names.map("$SOLR_HOME/lib/" + _).mkString(":"))
81764
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    72
81767
3f90880136fe clarified solr settings;
wenzelm
parents: 81765
diff changeset
    73
      val classpath = List("solr-solrj", "solr-api", "solr-core").map(_ + "-" + version + ".jar")
81768
d47f3995e35d suppress duplicate slf4j-api --- already provided by sqlite;
wenzelm
parents: 81767
diff changeset
    74
81778
14ace6211ce8 misc tuning;
wenzelm
parents: 81768
diff changeset
    75
      val solr_jars =
14ace6211ce8 misc tuning;
wenzelm
parents: 81768
diff changeset
    76
        File.read_dir(component_dir.lib).filterNot((name: String) =>
81779
e9f3dbcf854f avoid conflict with slf4j from sqlite (see also dcddfe4f43a3), notably this message on "isabelle find_facts":
wenzelm
parents: 81778
diff changeset
    77
          classpath.contains(name) ||
e9f3dbcf854f avoid conflict with slf4j from sqlite (see also dcddfe4f43a3), notably this message on "isabelle find_facts":
wenzelm
parents: 81778
diff changeset
    78
            name.startsWith("slf4j-api") ||
e9f3dbcf854f avoid conflict with slf4j from sqlite (see also dcddfe4f43a3), notably this message on "isabelle find_facts":
wenzelm
parents: 81778
diff changeset
    79
            name.startsWith("log4j-slf4j2"))
81767
3f90880136fe clarified solr settings;
wenzelm
parents: 81765
diff changeset
    80
81764
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    81
      component_dir.write_settings("""
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    82
SOLR_HOME="$COMPONENT"
81778
14ace6211ce8 misc tuning;
wenzelm
parents: 81768
diff changeset
    83
SOLR_JARS=""" + quote_jars(solr_jars) + """
14ace6211ce8 misc tuning;
wenzelm
parents: 81768
diff changeset
    84
classpath """ + quote_jars(classpath) + """
81764
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    85
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    86
SOLR_LUCENE_VERSION="9.10"
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    87
SOLR_SCHEMA_VERSION="1.6"
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    88
""")
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    89
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    90
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    91
      /* README */
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    92
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    93
      File.write(component_dir.README,
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    94
        "This Isabelle component provides Solr " + version + " jars from\n" + download_url + """
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    95
81767
3f90880136fe clarified solr settings;
wenzelm
parents: 81765
diff changeset
    96
        Fabian Huch
81764
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    97
        """ + Date.Format.date(Date.now()) + "\n")
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    98
    }
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
    99
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
   100
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
   101
  /* Isabelle tool wrapper */
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
   102
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
   103
  val isabelle_tool =
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
   104
    Isabelle_Tool("component_solr", "build Isabelle solr jar distribution", Scala_Project.here,
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
   105
      { args =>
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
   106
        var target_dir = Path.current
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
   107
        var download_url = default_download_url
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
   108
        var verbose = false
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
   109
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
   110
        val getopts = Getopts("""
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
   111
Usage: isabelle component_solr [OPTIONS]
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
   112
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
   113
  Options are:
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
   114
    -D DIR       target directory (default ".")
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
   115
    -U URL       download URL
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
   116
                 (default: """" + default_download_url + """")
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
   117
    -v           verbose
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
   118
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
   119
  Build solr component from official download.
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
   120
""",
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
   121
          "D:" -> (arg => target_dir = Path.explode(arg)),
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
   122
          "U:" -> (arg => download_url = arg),
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
   123
          "v" -> (_ => verbose = true))
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
   124
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
   125
        val more_args = getopts(args)
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
   126
        if (more_args.nonEmpty) getopts.usage()
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
   127
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
   128
        val progress = new Console_Progress(verbose = verbose)
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
   129
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
   130
        build_solr(download_url = download_url, progress = progress, target_dir = target_dir)
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
   131
      })
fcba3250fb2a original sources of find-facts 271b5af0c4c8;
wenzelm
parents:
diff changeset
   132
}