src/Pure/Tools/server.scala
author wenzelm
Sun, 06 Aug 2017 13:35:03 +0200
changeset 66349 66b843e4cff5
parent 66348 a426e826e84c
child 66350 66331026a2fc
permissions -rw-r--r--
clarified database names;
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
66347
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
     1
/*  Title:      Pure/Tools/server.scala
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
     2
    Author:     Makarius
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
     3
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
     4
Resident Isabelle servers.
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
     5
*/
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
     6
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
     7
package isabelle
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
     8
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
     9
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    10
import java.util.UUID
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    11
import java.net.{ServerSocket, InetAddress}
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    12
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    13
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    14
object Server
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    15
{
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    16
  /* per-user servers */
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    17
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    18
  object Data
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    19
  {
66349
66b843e4cff5 clarified database names;
wenzelm
parents: 66348
diff changeset
    20
    val database = Path.explode("$ISABELLE_HOME_USER/servers.db")
66347
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    21
66349
66b843e4cff5 clarified database names;
wenzelm
parents: 66348
diff changeset
    22
    val name = SQL.Column.string("name", primary_key = true)
66b843e4cff5 clarified database names;
wenzelm
parents: 66348
diff changeset
    23
    val port = SQL.Column.int("port")
66347
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    24
    val password = SQL.Column.string("password")
66349
66b843e4cff5 clarified database names;
wenzelm
parents: 66348
diff changeset
    25
    val table = SQL.Table("isabelle_servers", List(name, port, password))
66347
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    26
66349
66b843e4cff5 clarified database names;
wenzelm
parents: 66348
diff changeset
    27
    sealed case class Entry(name: String, port: Int, password: String)
66347
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    28
    {
66348
a426e826e84c more options;
wenzelm
parents: 66347
diff changeset
    29
      def print: String =
66349
66b843e4cff5 clarified database names;
wenzelm
parents: 66348
diff changeset
    30
        "server " + quote(name) + " = 127.0.0.1:" + port + " (password " + quote(password) + ")"
66347
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    31
    }
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    32
  }
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    33
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    34
  def list(): List[Data.Entry] =
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    35
    using(SQLite.open_database(Data.database))(list(_))
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    36
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    37
  def list(db: SQLite.Database): List[Data.Entry] =
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    38
    if (db.tables.contains(Data.table.name)) {
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    39
      db.using_statement(Data.table.select())(stmt =>
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    40
        stmt.execute_query().iterator(res =>
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    41
          Data.Entry(
66349
66b843e4cff5 clarified database names;
wenzelm
parents: 66348
diff changeset
    42
            res.string(Data.name),
66b843e4cff5 clarified database names;
wenzelm
parents: 66348
diff changeset
    43
            res.int(Data.port),
66b843e4cff5 clarified database names;
wenzelm
parents: 66348
diff changeset
    44
            res.string(Data.password))).toList.sortBy(_.name))
66347
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    45
    }
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    46
    else Nil
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    47
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    48
  def find(db: SQLite.Database, name: String): Option[Data.Entry] =
66349
66b843e4cff5 clarified database names;
wenzelm
parents: 66348
diff changeset
    49
    list(db).find(entry => entry.name == name)
66347
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    50
66348
a426e826e84c more options;
wenzelm
parents: 66347
diff changeset
    51
  def start(name: String = "", port: Int = 0, password: String = ""): (Data.Entry, Option[Thread]) =
66347
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    52
  {
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    53
    using(SQLite.open_database(Data.database))(db =>
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    54
      db.transaction {
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    55
        find(db, name) match {
66348
a426e826e84c more options;
wenzelm
parents: 66347
diff changeset
    56
          case Some(entry) => (entry, None)
66347
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    57
          case None =>
66348
a426e826e84c more options;
wenzelm
parents: 66347
diff changeset
    58
            val server = new Server(port, password)
66347
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    59
            val entry = Data.Entry(name, server.port, server.password)
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    60
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    61
            Isabelle_System.bash("chmod 600 " + File.bash_path(Data.database)).check
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    62
            db.create_table(Data.table)
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    63
            db.using_statement(Data.table.insert())(stmt =>
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    64
            {
66349
66b843e4cff5 clarified database names;
wenzelm
parents: 66348
diff changeset
    65
              stmt.string(1) = entry.name
66b843e4cff5 clarified database names;
wenzelm
parents: 66348
diff changeset
    66
              stmt.int(2) = entry.port
66347
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    67
              stmt.string(3) = entry.password
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    68
              stmt.execute()
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    69
            })
66348
a426e826e84c more options;
wenzelm
parents: 66347
diff changeset
    70
a426e826e84c more options;
wenzelm
parents: 66347
diff changeset
    71
            (entry, Some(server.thread))
66347
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    72
        }
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    73
      })
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    74
  }
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    75
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    76
  def stop(name: String = ""): Boolean =
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    77
  {
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    78
    using(SQLite.open_database(Data.database))(db =>
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    79
      db.transaction {
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    80
        find(db, name) match {
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    81
          case Some(entry) =>
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    82
            // FIXME shutdown server
66349
66b843e4cff5 clarified database names;
wenzelm
parents: 66348
diff changeset
    83
            db.using_statement(Data.table.delete(Data.name.where_equal(name)))(_.execute)
66347
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    84
            true
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    85
          case None =>
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    86
            false
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    87
        }
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    88
      })
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    89
  }
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    90
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    91
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    92
  /* Isabelle tool wrapper */
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    93
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    94
  val isabelle_tool =
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    95
    Isabelle_Tool("server", "manage resident Isabelle servers", args =>
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
    96
    {
66348
a426e826e84c more options;
wenzelm
parents: 66347
diff changeset
    97
      var operation_list = false
a426e826e84c more options;
wenzelm
parents: 66347
diff changeset
    98
      var name = ""
a426e826e84c more options;
wenzelm
parents: 66347
diff changeset
    99
      var port = 0
66347
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
   100
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
   101
      val getopts =
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
   102
        Getopts("""
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
   103
Usage: isabelle server [OPTIONS]
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
   104
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
   105
  Options are:
66348
a426e826e84c more options;
wenzelm
parents: 66347
diff changeset
   106
    -L           list servers
a426e826e84c more options;
wenzelm
parents: 66347
diff changeset
   107
    -n NAME      explicit server name
a426e826e84c more options;
wenzelm
parents: 66347
diff changeset
   108
    -p PORT      explicit server port
66347
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
   109
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
   110
  Manage resident Isabelle servers.
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
   111
""",
66348
a426e826e84c more options;
wenzelm
parents: 66347
diff changeset
   112
          "L" -> (_ => operation_list = true),
a426e826e84c more options;
wenzelm
parents: 66347
diff changeset
   113
          "n:" -> (arg => name = arg),
a426e826e84c more options;
wenzelm
parents: 66347
diff changeset
   114
          "p:" -> (arg => port = Value.Int.parse(arg)))
66347
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
   115
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
   116
      val more_args = getopts(args)
66348
a426e826e84c more options;
wenzelm
parents: 66347
diff changeset
   117
      if (more_args.nonEmpty) getopts.usage()
66347
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
   118
66348
a426e826e84c more options;
wenzelm
parents: 66347
diff changeset
   119
      if (operation_list) list().foreach(entry => Console.println(entry.print))
a426e826e84c more options;
wenzelm
parents: 66347
diff changeset
   120
      else {
a426e826e84c more options;
wenzelm
parents: 66347
diff changeset
   121
        val (entry, thread) = start(name, port)
a426e826e84c more options;
wenzelm
parents: 66347
diff changeset
   122
        Console.println(entry.print)
a426e826e84c more options;
wenzelm
parents: 66347
diff changeset
   123
        thread.foreach(_.join)
a426e826e84c more options;
wenzelm
parents: 66347
diff changeset
   124
      }
66347
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
   125
    })
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
   126
}
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
   127
66348
a426e826e84c more options;
wenzelm
parents: 66347
diff changeset
   128
class Server private(_port: Int, _password: String)
66347
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
   129
{
66348
a426e826e84c more options;
wenzelm
parents: 66347
diff changeset
   130
  val socket = new ServerSocket(_port, 50, InetAddress.getByName("127.0.0.1"))
66347
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
   131
  def port: Int = socket.getLocalPort
66348
a426e826e84c more options;
wenzelm
parents: 66347
diff changeset
   132
  val password: String = proper_string(_password) getOrElse UUID.randomUUID().toString
a426e826e84c more options;
wenzelm
parents: 66347
diff changeset
   133
a426e826e84c more options;
wenzelm
parents: 66347
diff changeset
   134
  lazy val thread: Thread = Thread.currentThread // FIXME
66347
23eaab37e4a8 support for resident Isabelle servers;
wenzelm
parents:
diff changeset
   135
}