Chris@1808: (* Chris@1808: DO NOT EDIT THIS FILE. Chris@1808: This file is automatically generated from the individual Chris@1808: source files in the Repoint repository. Chris@1808: *) Chris@1808: Chris@1808: (* Chris@1808: Repoint Chris@1808: Chris@1808: A simple manager for third-party source code dependencies Chris@1808: Chris@1808: Copyright 2018 Chris Cannam, Particular Programs Ltd, Chris@1808: and Queen Mary, University of London Chris@1808: Chris@1808: Permission is hereby granted, free of charge, to any person Chris@1808: obtaining a copy of this software and associated documentation Chris@1808: files (the "Software"), to deal in the Software without Chris@1808: restriction, including without limitation the rights to use, copy, Chris@1808: modify, merge, publish, distribute, sublicense, and/or sell copies Chris@1808: of the Software, and to permit persons to whom the Software is Chris@1808: furnished to do so, subject to the following conditions: Chris@1808: Chris@1808: The above copyright notice and this permission notice shall be Chris@1808: included in all copies or substantial portions of the Software. Chris@1808: Chris@1808: THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, Chris@1808: EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF Chris@1808: MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND Chris@1808: NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR Chris@1808: ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF Chris@1808: CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION Chris@1808: WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. Chris@1808: Chris@1808: Except as contained in this notice, the names of Chris Cannam, Chris@1808: Particular Programs Ltd, and Queen Mary, University of London Chris@1808: shall not be used in advertising or otherwise to promote the sale, Chris@1808: use or other dealings in this Software without prior written Chris@1808: authorization. Chris@1808: *) Chris@1808: Chris@1865: val repoint_version = "1.1" Chris@1808: Chris@1808: Chris@1808: datatype vcs = Chris@1808: HG | Chris@1808: GIT | Chris@1808: SVN Chris@1808: Chris@1808: datatype source = Chris@1808: URL_SOURCE of string | Chris@1808: SERVICE_SOURCE of { Chris@1808: service : string, Chris@1808: owner : string option, Chris@1808: repo : string option Chris@1808: } Chris@1808: Chris@1808: type id_or_tag = string Chris@1808: Chris@1808: datatype pin = Chris@1808: UNPINNED | Chris@1808: PINNED of id_or_tag Chris@1808: Chris@1808: datatype libstate = Chris@1808: ABSENT | Chris@1808: CORRECT | Chris@1808: SUPERSEDED | Chris@1808: WRONG Chris@1808: Chris@1808: datatype localstate = Chris@1808: MODIFIED | Chris@1808: LOCK_MISMATCHED | Chris@1808: CLEAN Chris@1808: Chris@1808: datatype branch = Chris@1808: BRANCH of string | Chris@1808: DEFAULT_BRANCH Chris@1808: Chris@1808: (* If we can recover from an error, for example by reporting failure Chris@1808: for this one thing and going on to the next thing, then the error Chris@1808: should usually be returned through a result type rather than an Chris@1808: exception. *) Chris@1808: Chris@1808: datatype 'a result = Chris@1808: OK of 'a | Chris@1808: ERROR of string Chris@1808: Chris@1808: type libname = string Chris@1808: Chris@1808: type libspec = { Chris@1808: libname : libname, Chris@1808: vcs : vcs, Chris@1808: source : source, Chris@1808: branch : branch, Chris@1808: project_pin : pin, Chris@1808: lock_pin : pin Chris@1808: } Chris@1808: Chris@1808: type lock = { Chris@1808: libname : libname, Chris@1808: id_or_tag : id_or_tag Chris@1808: } Chris@1808: Chris@1808: type remote_spec = { Chris@1808: anon : string option, Chris@1808: auth : string option Chris@1808: } Chris@1808: Chris@1808: type provider = { Chris@1808: service : string, Chris@1808: supports : vcs list, Chris@1808: remote_spec : remote_spec Chris@1808: } Chris@1808: Chris@1808: type account = { Chris@1808: service : string, Chris@1808: login : string Chris@1808: } Chris@1808: Chris@1808: type context = { Chris@1808: rootpath : string, Chris@1808: extdir : string, Chris@1808: providers : provider list, Chris@1808: accounts : account list Chris@1808: } Chris@1808: Chris@1808: type userconfig = { Chris@1808: providers : provider list, Chris@1808: accounts : account list Chris@1808: } Chris@1808: Chris@1808: type project = { Chris@1808: context : context, Chris@1808: libs : libspec list Chris@1808: } Chris@1808: Chris@1808: structure RepointFilenames = struct Chris@1808: val project_file = "repoint-project.json" Chris@1808: val project_lock_file = "repoint-lock.json" Chris@1865: val project_completion_file = ".repoint.point" Chris@1808: val user_config_file = ".repoint.json" Chris@1808: val archive_dir = ".repoint-archive" Chris@1808: end Chris@1808: Chris@1808: signature VCS_CONTROL = sig Chris@1808: Chris@1808: (** Check whether the given VCS is installed and working *) Chris@1808: val is_working : context -> bool result Chris@1808: Chris@1808: (** Test whether the library is present locally at all *) Chris@1808: val exists : context -> libname -> bool result Chris@1808: Chris@1808: (** Return the id (hash) of the current revision for the library *) Chris@1808: val id_of : context -> libname -> id_or_tag result Chris@1808: Chris@1808: (** Test whether the library is at the given id *) Chris@1808: val is_at : context -> libname * id_or_tag -> bool result Chris@1808: Chris@1808: (** Test whether the library is on the given branch, i.e. is at Chris@1808: the branch tip or an ancestor of it *) Chris@1808: val is_on_branch : context -> libname * branch -> bool result Chris@1808: Chris@1808: (** Test whether the library is at the newest revision for the Chris@1808: given branch. False may indicate that the branch has advanced Chris@1808: or that the library is not on the branch at all. This function Chris@1808: may use the network to check for new revisions *) Chris@1808: val is_newest : context -> libname * source * branch -> bool result Chris@1808: Chris@1808: (** Test whether the library is at the newest revision available Chris@1808: locally for the given branch. False may indicate that the Chris@1808: branch has advanced or that the library is not on the branch Chris@1808: at all. This function must not use the network *) Chris@1808: val is_newest_locally : context -> libname * branch -> bool result Chris@1808: Chris@1808: (** Test whether the library has been modified in the local Chris@1808: working copy *) Chris@1808: val is_modified_locally : context -> libname -> bool result Chris@1808: Chris@1808: (** Check out, i.e. clone a fresh copy of, the repo for the given Chris@1808: library on the given branch *) Chris@1808: val checkout : context -> libname * source * branch -> unit result Chris@1808: Chris@1808: (** Update the library to the given branch tip. Assumes that a Chris@1808: local copy of the library already exists *) Chris@1808: val update : context -> libname * source * branch -> unit result Chris@1808: Chris@1808: (** Update the library to the given specific id or tag *) Chris@1808: val update_to : context -> libname * source * id_or_tag -> unit result Chris@1808: Chris@1808: (** Return a URL from which the library can be cloned, given that Chris@1808: the local copy already exists. For a DVCS this can be the Chris@1808: local copy, but for a centralised VCS it will have to be the Chris@1808: remote repository URL. Used for archiving *) Chris@1808: val copy_url_for : context -> libname -> string result Chris@1808: end Chris@1808: Chris@1808: signature LIB_CONTROL = sig Chris@1808: val review : context -> libspec -> (libstate * localstate) result Chris@1808: val status : context -> libspec -> (libstate * localstate) result Chris@1808: val update : context -> libspec -> unit result Chris@1808: val id_of : context -> libspec -> id_or_tag result Chris@1808: val is_working : context -> vcs -> bool result Chris@1808: end Chris@1808: Chris@1808: structure FileBits :> sig Chris@1808: val extpath : context -> string Chris@1808: val libpath : context -> libname -> string Chris@1808: val subpath : context -> libname -> string -> string Chris@1808: val command_output : context -> libname -> string list -> string result Chris@1808: val command : context -> libname -> string list -> unit result Chris@1808: val file_url : string -> string Chris@1808: val file_contents : string -> string Chris@1808: val mydir : unit -> string Chris@1808: val homedir : unit -> string Chris@1808: val mkpath : string -> unit result Chris@1808: val rmpath : string -> unit result Chris@1808: val nonempty_dir_exists : string -> bool Chris@1808: val project_spec_path : string -> string Chris@1808: val project_lock_path : string -> string Chris@1865: val project_completion_path : string -> string Chris@1808: val verbose : unit -> bool Chris@1808: end = struct Chris@1808: Chris@1808: fun verbose () = Chris@1808: case OS.Process.getEnv "REPOINT_VERBOSE" of Chris@1808: SOME "0" => false Chris@1808: | SOME _ => true Chris@1808: | NONE => false Chris@1808: Chris@1808: fun split_relative path desc = Chris@1808: case OS.Path.fromString path of Chris@1808: { isAbs = true, ... } => raise Fail (desc ^ " may not be absolute") Chris@1808: | { arcs, ... } => arcs Chris@1808: Chris@1808: fun extpath ({ rootpath, extdir, ... } : context) = Chris@1808: let val { isAbs, vol, arcs } = OS.Path.fromString rootpath Chris@1808: in OS.Path.toString { Chris@1808: isAbs = isAbs, Chris@1808: vol = vol, Chris@1808: arcs = arcs @ Chris@1808: split_relative extdir "extdir" Chris@1808: } Chris@1808: end Chris@1808: Chris@1808: fun subpath ({ rootpath, extdir, ... } : context) libname remainder = Chris@1808: (* NB libname is allowed to be a path fragment, e.g. foo/bar *) Chris@1808: let val { isAbs, vol, arcs } = OS.Path.fromString rootpath Chris@1808: in OS.Path.toString { Chris@1808: isAbs = isAbs, Chris@1808: vol = vol, Chris@1808: arcs = arcs @ Chris@1808: split_relative extdir "extdir" @ Chris@1808: split_relative libname "library path" @ Chris@1808: split_relative remainder "subpath" Chris@1808: } Chris@1808: end Chris@1808: Chris@1808: fun libpath context "" = Chris@1808: extpath context Chris@1808: | libpath context libname = Chris@1808: subpath context libname "" Chris@1808: Chris@1808: fun project_file_path rootpath filename = Chris@1808: let val { isAbs, vol, arcs } = OS.Path.fromString rootpath Chris@1808: in OS.Path.toString { Chris@1808: isAbs = isAbs, Chris@1808: vol = vol, Chris@1808: arcs = arcs @ [ filename ] Chris@1808: } Chris@1808: end Chris@1808: Chris@1808: fun project_spec_path rootpath = Chris@1808: project_file_path rootpath (RepointFilenames.project_file) Chris@1808: Chris@1808: fun project_lock_path rootpath = Chris@1808: project_file_path rootpath (RepointFilenames.project_lock_file) Chris@1808: Chris@1865: fun project_completion_path rootpath = Chris@1865: project_file_path rootpath (RepointFilenames.project_completion_file) Chris@1865: Chris@1808: fun trim str = Chris@1808: hd (String.fields (fn x => x = #"\n" orelse x = #"\r") str) Chris@1808: Chris@1808: fun file_url path = Chris@1808: let val forward_path = Chris@1808: String.translate (fn #"\\" => "/" | Chris@1808: c => Char.toString c) Chris@1808: (OS.Path.mkCanonical path) Chris@1808: in Chris@1808: (* Path is expected to be absolute already, but if it Chris@1808: starts with a drive letter, we'll need an extra slash *) Chris@1808: case explode forward_path of Chris@1808: #"/"::rest => "file:///" ^ implode rest Chris@1808: | _ => "file:///" ^ forward_path Chris@1808: end Chris@1808: Chris@1808: fun file_contents filename = Chris@1808: let val stream = TextIO.openIn filename Chris@1808: fun read_all str acc = Chris@1808: case TextIO.inputLine str of Chris@1808: SOME line => read_all str (trim line :: acc) Chris@1808: | NONE => rev acc Chris@1808: val contents = read_all stream [] Chris@1808: val _ = TextIO.closeIn stream Chris@1808: in Chris@1808: String.concatWith "\n" contents Chris@1808: end Chris@1808: Chris@1808: fun expand_commandline cmdlist = Chris@1808: (* We are quite strict about what we accept here, except Chris@1808: for the first element in cmdlist which is assumed to be a Chris@1808: known command location rather than arbitrary user input. *) Chris@1808: let open Char Chris@1808: fun quote arg = Chris@1808: if List.all Chris@1808: (fn c => isAlphaNum c orelse c = #"-" orelse c = #"_") Chris@1808: (explode arg) Chris@1808: then arg Chris@1808: else "\"" ^ arg ^ "\"" Chris@1808: fun check arg = Chris@1808: let val valid = explode " /#:;?,._-{}@=+" Chris@1808: in Chris@1808: app (fn c => Chris@1808: if isAlphaNum c orelse Chris@1808: List.exists (fn v => v = c) valid orelse Chris@1808: c > chr 127 Chris@1808: then () Chris@1808: else raise Fail ("Invalid character '" ^ Chris@1808: (Char.toString c) ^ Chris@1808: "' in command list")) Chris@1808: (explode arg); Chris@1808: arg Chris@1808: end Chris@1808: in Chris@1808: String.concatWith " " Chris@1808: (map quote Chris@1808: (hd cmdlist :: map check (tl cmdlist))) Chris@1808: end Chris@1808: Chris@1808: val tick_cycle = ref 0 Chris@1808: val tick_chars = Vector.fromList (map String.str (explode "|/-\\")) Chris@1808: Chris@1808: fun tick libname cmdlist = Chris@1808: let val n = Vector.length tick_chars Chris@1808: fun pad_to n str = Chris@1808: if n <= String.size str then str Chris@1808: else pad_to n (str ^ " ") Chris@1808: val name = if libname <> "" then libname Chris@1808: else if cmdlist = nil then "" Chris@1808: else hd (rev cmdlist) Chris@1808: in Chris@1808: print (" " ^ Chris@1808: Vector.sub(tick_chars, !tick_cycle) ^ " " ^ Chris@1808: pad_to 70 name ^ Chris@1808: "\r"); Chris@1808: tick_cycle := (if !tick_cycle = n - 1 then 0 else 1 + !tick_cycle) Chris@1808: end Chris@1808: Chris@1808: fun run_command context libname cmdlist redirect = Chris@1808: let open OS Chris@1808: val dir = libpath context libname Chris@1808: val cmd = expand_commandline cmdlist Chris@1808: val _ = if verbose () Chris@1808: then print ("\n=== " ^ dir ^ "\n<<< " ^ cmd ^ "\n") Chris@1808: else tick libname cmdlist Chris@1808: val _ = FileSys.chDir dir Chris@1808: val status = case redirect of Chris@1808: NONE => Process.system cmd Chris@1808: | SOME file => Process.system (cmd ^ ">" ^ file) Chris@1808: in Chris@1808: if Process.isSuccess status Chris@1808: then OK () Chris@1808: else ERROR ("Command failed: " ^ cmd ^ " (in dir " ^ dir ^ ")") Chris@1808: end Chris@1808: handle ex => ERROR ("Unable to run command: " ^ exnMessage ex) Chris@1808: Chris@1808: fun command context libname cmdlist = Chris@1808: run_command context libname cmdlist NONE Chris@1808: Chris@1808: fun command_output context libname cmdlist = Chris@1808: let open OS Chris@1808: val tmpFile = FileSys.tmpName () Chris@1808: val result = run_command context libname cmdlist (SOME tmpFile) Chris@1808: val contents = file_contents tmpFile Chris@1808: val _ = if verbose () Chris@1808: then print (">>> \"" ^ contents ^ "\"\n") Chris@1808: else () Chris@1808: in Chris@1808: FileSys.remove tmpFile handle _ => (); Chris@1808: case result of Chris@1808: OK () => OK contents Chris@1808: | ERROR e => ERROR e Chris@1808: end Chris@1808: Chris@1808: fun mydir () = Chris@1808: let open OS Chris@1808: val { dir, file } = Path.splitDirFile (CommandLine.name ()) Chris@1808: in Chris@1808: FileSys.realPath Chris@1808: (if Path.isAbsolute dir Chris@1808: then dir Chris@1808: else Path.concat (FileSys.getDir (), dir)) Chris@1808: end Chris@1808: Chris@1808: fun homedir () = Chris@1808: (* Failure is not routine, so we use an exception here *) Chris@1808: case (OS.Process.getEnv "HOME", Chris@1808: OS.Process.getEnv "HOMEPATH") of Chris@1808: (SOME home, _) => home Chris@1808: | (NONE, SOME home) => home Chris@1808: | (NONE, NONE) => Chris@1808: raise Fail "Failed to look up home directory from environment" Chris@1808: Chris@1808: fun mkpath' path = Chris@1808: if OS.FileSys.isDir path handle _ => false Chris@1808: then OK () Chris@1808: else case OS.Path.fromString path of Chris@1808: { arcs = nil, ... } => OK () Chris@1808: | { isAbs = false, ... } => ERROR "mkpath requires absolute path" Chris@1808: | { isAbs, vol, arcs } => Chris@1808: case mkpath' (OS.Path.toString { (* parent *) Chris@1808: isAbs = isAbs, Chris@1808: vol = vol, Chris@1808: arcs = rev (tl (rev arcs)) }) of Chris@1808: ERROR e => ERROR e Chris@1808: | OK () => ((OS.FileSys.mkDir path; OK ()) Chris@1808: handle OS.SysErr (e, _) => Chris@1808: ERROR ("Directory creation failed: " ^ e)) Chris@1808: Chris@1808: fun mkpath path = Chris@1808: mkpath' (OS.Path.mkCanonical path) Chris@1808: Chris@1808: fun dir_contents dir = Chris@1808: let open OS Chris@1808: fun files_from dirstream = Chris@1808: case FileSys.readDir dirstream of Chris@1808: NONE => [] Chris@1808: | SOME file => Chris@1808: (* readDir is supposed to filter these, Chris@1808: but let's be extra cautious: *) Chris@1808: if file = Path.parentArc orelse file = Path.currentArc Chris@1808: then files_from dirstream Chris@1808: else file :: files_from dirstream Chris@1808: val stream = FileSys.openDir dir Chris@1808: val files = map (fn f => Path.joinDirFile Chris@1808: { dir = dir, file = f }) Chris@1808: (files_from stream) Chris@1808: val _ = FileSys.closeDir stream Chris@1808: in Chris@1808: files Chris@1808: end Chris@1808: Chris@1808: fun rmpath' path = Chris@1808: let open OS Chris@1808: fun remove path = Chris@1808: if FileSys.isLink path (* dangling links bother isDir *) Chris@1808: then FileSys.remove path Chris@1808: else if FileSys.isDir path Chris@1808: then (app remove (dir_contents path); FileSys.rmDir path) Chris@1808: else FileSys.remove path Chris@1808: in Chris@1808: (remove path; OK ()) Chris@1808: handle SysErr (e, _) => ERROR ("Path removal failed: " ^ e) Chris@1808: end Chris@1808: Chris@1808: fun rmpath path = Chris@1808: rmpath' (OS.Path.mkCanonical path) Chris@1808: Chris@1808: fun nonempty_dir_exists path = Chris@1808: let open OS.FileSys Chris@1808: in Chris@1808: (not (isLink path) andalso Chris@1808: isDir path andalso Chris@1808: dir_contents path <> []) Chris@1808: handle _ => false Chris@1808: end Chris@1808: Chris@1808: end Chris@1808: Chris@1808: functor LibControlFn (V: VCS_CONTROL) :> LIB_CONTROL = struct Chris@1808: Chris@1808: (* Valid states for unpinned libraries: Chris@1808: Chris@1808: - CORRECT: We are on the right branch and are up-to-date with Chris@1808: it as far as we can tell. (If not using the network, this Chris@1808: should be reported to user as "Present" rather than "Correct" Chris@1808: as the remote repo may have advanced without us knowing.) Chris@1808: Chris@1808: - SUPERSEDED: We are on the right branch but we can see that Chris@1808: there is a newer revision either locally or on the remote (in Chris@1808: Git terms, we are at an ancestor of the desired branch tip). Chris@1808: Chris@1808: - WRONG: We are on the wrong branch (in Git terms, we are not Chris@1808: at the desired branch tip or any ancestor of it). Chris@1808: Chris@1808: - ABSENT: Repo doesn't exist here at all. Chris@1808: Chris@1808: Valid states for pinned libraries: Chris@1808: Chris@1808: - CORRECT: We are at the pinned revision. Chris@1808: Chris@1808: - WRONG: We are at any revision other than the pinned one. Chris@1808: Chris@1808: - ABSENT: Repo doesn't exist here at all. Chris@1808: *) Chris@1808: Chris@1808: fun check with_network context Chris@1808: ({ libname, source, branch, Chris@1808: project_pin, lock_pin, ... } : libspec) = Chris@1808: let fun check_unpinned () = Chris@1808: let val newest = Chris@1808: if with_network Chris@1808: then V.is_newest context (libname, source, branch) Chris@1808: else V.is_newest_locally context (libname, branch) Chris@1808: in Chris@1808: case newest of Chris@1808: ERROR e => ERROR e Chris@1808: | OK true => OK CORRECT Chris@1808: | OK false => Chris@1808: case V.is_on_branch context (libname, branch) of Chris@1808: ERROR e => ERROR e Chris@1808: | OK true => OK SUPERSEDED Chris@1808: | OK false => OK WRONG Chris@1808: end Chris@1808: fun check_pinned target = Chris@1808: case V.is_at context (libname, target) of Chris@1808: ERROR e => ERROR e Chris@1808: | OK true => OK CORRECT Chris@1808: | OK false => OK WRONG Chris@1808: fun check_remote () = Chris@1808: case project_pin of Chris@1808: UNPINNED => check_unpinned () Chris@1808: | PINNED target => check_pinned target Chris@1808: fun check_local () = Chris@1808: case V.is_modified_locally context libname of Chris@1808: ERROR e => ERROR e Chris@1808: | OK true => OK MODIFIED Chris@1808: | OK false => Chris@1808: case lock_pin of Chris@1808: UNPINNED => OK CLEAN Chris@1808: | PINNED target => Chris@1808: case V.is_at context (libname, target) of Chris@1808: ERROR e => ERROR e Chris@1808: | OK true => OK CLEAN Chris@1808: | OK false => OK LOCK_MISMATCHED Chris@1808: in Chris@1808: case V.exists context libname of Chris@1808: ERROR e => ERROR e Chris@1808: | OK false => OK (ABSENT, CLEAN) Chris@1808: | OK true => Chris@1808: case (check_remote (), check_local ()) of Chris@1808: (ERROR e, _) => ERROR e Chris@1808: | (_, ERROR e) => ERROR e Chris@1808: | (OK r, OK l) => OK (r, l) Chris@1808: end Chris@1808: Chris@1808: val review = check true Chris@1808: val status = check false Chris@1808: Chris@1808: fun update context Chris@1808: ({ libname, source, branch, Chris@1808: project_pin, lock_pin, ... } : libspec) = Chris@1808: let fun update_unpinned () = Chris@1808: case V.is_newest context (libname, source, branch) of Chris@1808: ERROR e => ERROR e Chris@1808: | OK true => OK () Chris@1808: | OK false => V.update context (libname, source, branch) Chris@1808: fun update_pinned target = Chris@1808: case V.is_at context (libname, target) of Chris@1808: ERROR e => ERROR e Chris@1808: | OK true => OK () Chris@1808: | OK false => V.update_to context (libname, source, target) Chris@1808: fun update' () = Chris@1808: case lock_pin of Chris@1808: PINNED target => update_pinned target Chris@1808: | UNPINNED => Chris@1808: case project_pin of Chris@1808: PINNED target => update_pinned target Chris@1808: | UNPINNED => update_unpinned () Chris@1808: in Chris@1808: case V.exists context libname of Chris@1808: ERROR e => ERROR e Chris@1808: | OK true => update' () Chris@1808: | OK false => Chris@1808: case V.checkout context (libname, source, branch) of Chris@1808: ERROR e => ERROR e Chris@1808: | OK () => update' () Chris@1808: end Chris@1808: Chris@1808: fun id_of context ({ libname, ... } : libspec) = Chris@1808: V.id_of context libname Chris@1808: Chris@1808: fun is_working context vcs = Chris@1808: V.is_working context Chris@1808: Chris@1808: end Chris@1808: Chris@1808: (* Simple Standard ML JSON parser Chris@1808: https://bitbucket.org/cannam/sml-simplejson Chris@1808: Copyright 2017 Chris Cannam. BSD licence. Chris@1808: Parts based on the JSON parser in the Ponyo library by Phil Eaton. Chris@1808: *) Chris@1808: Chris@1808: signature JSON = sig Chris@1808: Chris@1808: datatype json = OBJECT of (string * json) list Chris@1808: | ARRAY of json list Chris@1808: | NUMBER of real Chris@1808: | STRING of string Chris@1808: | BOOL of bool Chris@1808: | NULL Chris@1808: Chris@1808: datatype 'a result = OK of 'a Chris@1808: | ERROR of string Chris@1808: Chris@1808: val parse : string -> json result Chris@1808: val serialise : json -> string Chris@1808: val serialiseIndented : json -> string Chris@1808: Chris@1808: end Chris@1808: Chris@1808: structure Json :> JSON = struct Chris@1808: Chris@1808: datatype json = OBJECT of (string * json) list Chris@1808: | ARRAY of json list Chris@1808: | NUMBER of real Chris@1808: | STRING of string Chris@1808: | BOOL of bool Chris@1808: | NULL Chris@1808: Chris@1808: datatype 'a result = OK of 'a Chris@1808: | ERROR of string Chris@1808: Chris@1808: structure T = struct Chris@1808: datatype token = NUMBER of char list Chris@1808: | STRING of string Chris@1808: | BOOL of bool Chris@1808: | NULL Chris@1808: | CURLY_L Chris@1808: | CURLY_R Chris@1808: | SQUARE_L Chris@1808: | SQUARE_R Chris@1808: | COLON Chris@1808: | COMMA Chris@1808: Chris@1808: fun toString t = Chris@1808: case t of NUMBER digits => implode digits Chris@1808: | STRING s => s Chris@1808: | BOOL b => Bool.toString b Chris@1808: | NULL => "null" Chris@1808: | CURLY_L => "{" Chris@1808: | CURLY_R => "}" Chris@1808: | SQUARE_L => "[" Chris@1808: | SQUARE_R => "]" Chris@1808: | COLON => ":" Chris@1808: | COMMA => "," Chris@1808: end Chris@1808: Chris@1808: fun bmpToUtf8 cp = (* convert a codepoint in Unicode BMP to utf8 bytes *) Chris@1808: let open Word Chris@1808: infix 6 orb andb >> Chris@1808: in Chris@1808: map (Char.chr o toInt) Chris@1808: (if cp < 0wx80 then Chris@1808: [cp] Chris@1808: else if cp < 0wx800 then Chris@1808: [0wxc0 orb (cp >> 0w6), 0wx80 orb (cp andb 0wx3f)] Chris@1808: else if cp < 0wx10000 then Chris@1808: [0wxe0 orb (cp >> 0w12), Chris@1808: 0wx80 orb ((cp >> 0w6) andb 0wx3f), Chris@1808: 0wx80 orb (cp andb 0wx3f)] Chris@1808: else raise Fail ("Invalid BMP point " ^ (Word.toString cp))) Chris@1808: end Chris@1808: Chris@1808: fun error pos text = ERROR (text ^ " at character position " ^ Chris@1808: Int.toString (pos - 1)) Chris@1808: fun token_error pos = error pos ("Unexpected token") Chris@1808: Chris@1808: fun lexNull pos acc (#"u" :: #"l" :: #"l" :: xs) = Chris@1808: lex (pos + 3) (T.NULL :: acc) xs Chris@1808: | lexNull pos acc _ = token_error pos Chris@1808: Chris@1808: and lexTrue pos acc (#"r" :: #"u" :: #"e" :: xs) = Chris@1808: lex (pos + 3) (T.BOOL true :: acc) xs Chris@1808: | lexTrue pos acc _ = token_error pos Chris@1808: Chris@1808: and lexFalse pos acc (#"a" :: #"l" :: #"s" :: #"e" :: xs) = Chris@1808: lex (pos + 4) (T.BOOL false :: acc) xs Chris@1808: | lexFalse pos acc _ = token_error pos Chris@1808: Chris@1808: and lexChar tok pos acc xs = Chris@1808: lex pos (tok :: acc) xs Chris@1808: Chris@1808: and lexString pos acc cc = Chris@1808: let datatype escaped = ESCAPED | NORMAL Chris@1808: fun lexString' pos text ESCAPED [] = Chris@1808: error pos "End of input during escape sequence" Chris@1808: | lexString' pos text NORMAL [] = Chris@1808: error pos "End of input during string" Chris@1808: | lexString' pos text ESCAPED (x :: xs) = Chris@1808: let fun esc c = lexString' (pos + 1) (c :: text) NORMAL xs Chris@1808: in case x of Chris@1808: #"\"" => esc x Chris@1808: | #"\\" => esc x Chris@1808: | #"/" => esc x Chris@1808: | #"b" => esc #"\b" Chris@1808: | #"f" => esc #"\f" Chris@1808: | #"n" => esc #"\n" Chris@1808: | #"r" => esc #"\r" Chris@1808: | #"t" => esc #"\t" Chris@1808: | _ => error pos ("Invalid escape \\" ^ Chris@1808: Char.toString x) Chris@1808: end Chris@1808: | lexString' pos text NORMAL (#"\\" :: #"u" ::a::b::c::d:: xs) = Chris@1808: if List.all Char.isHexDigit [a,b,c,d] Chris@1808: then case Word.fromString ("0wx" ^ (implode [a,b,c,d])) of Chris@1808: SOME w => (let val utf = rev (bmpToUtf8 w) in Chris@1808: lexString' (pos + 6) (utf @ text) Chris@1808: NORMAL xs Chris@1808: end Chris@1808: handle Fail err => error pos err) Chris@1808: | NONE => error pos "Invalid Unicode BMP escape sequence" Chris@1808: else error pos "Invalid Unicode BMP escape sequence" Chris@1808: | lexString' pos text NORMAL (x :: xs) = Chris@1808: if Char.ord x < 0x20 Chris@1808: then error pos "Invalid unescaped control character" Chris@1808: else Chris@1808: case x of Chris@1808: #"\"" => OK (rev text, xs, pos + 1) Chris@1808: | #"\\" => lexString' (pos + 1) text ESCAPED xs Chris@1808: | _ => lexString' (pos + 1) (x :: text) NORMAL xs Chris@1808: in Chris@1808: case lexString' pos [] NORMAL cc of Chris@1808: OK (text, rest, newpos) => Chris@1808: lex newpos (T.STRING (implode text) :: acc) rest Chris@1808: | ERROR e => ERROR e Chris@1808: end Chris@1808: Chris@1808: and lexNumber firstChar pos acc cc = Chris@1808: let val valid = explode ".+-e" Chris@1808: fun lexNumber' pos digits [] = (rev digits, [], pos) Chris@1808: | lexNumber' pos digits (x :: xs) = Chris@1808: if x = #"E" then lexNumber' (pos + 1) (#"e" :: digits) xs Chris@1808: else if Char.isDigit x orelse List.exists (fn c => x = c) valid Chris@1808: then lexNumber' (pos + 1) (x :: digits) xs Chris@1808: else (rev digits, x :: xs, pos) Chris@1808: val (digits, rest, newpos) = Chris@1808: lexNumber' (pos - 1) [] (firstChar :: cc) Chris@1808: in Chris@1808: case digits of Chris@1808: [] => token_error pos Chris@1808: | _ => lex newpos (T.NUMBER digits :: acc) rest Chris@1808: end Chris@1808: Chris@1808: and lex pos acc [] = OK (rev acc) Chris@1808: | lex pos acc (x::xs) = Chris@1808: (case x of Chris@1808: #" " => lex Chris@1808: | #"\t" => lex Chris@1808: | #"\n" => lex Chris@1808: | #"\r" => lex Chris@1808: | #"{" => lexChar T.CURLY_L Chris@1808: | #"}" => lexChar T.CURLY_R Chris@1808: | #"[" => lexChar T.SQUARE_L Chris@1808: | #"]" => lexChar T.SQUARE_R Chris@1808: | #":" => lexChar T.COLON Chris@1808: | #"," => lexChar T.COMMA Chris@1808: | #"\"" => lexString Chris@1808: | #"t" => lexTrue Chris@1808: | #"f" => lexFalse Chris@1808: | #"n" => lexNull Chris@1808: | x => lexNumber x) (pos + 1) acc xs Chris@1808: Chris@1808: fun show [] = "end of input" Chris@1808: | show (tok :: _) = T.toString tok Chris@1808: Chris@1808: fun parseNumber digits = Chris@1808: (* Note lexNumber already case-insensitised the E for us *) Chris@1808: let open Char Chris@1808: Chris@1808: fun okExpDigits [] = false Chris@1808: | okExpDigits (c :: []) = isDigit c Chris@1808: | okExpDigits (c :: cs) = isDigit c andalso okExpDigits cs Chris@1808: Chris@1808: fun okExponent [] = false Chris@1808: | okExponent (#"+" :: cs) = okExpDigits cs Chris@1808: | okExponent (#"-" :: cs) = okExpDigits cs Chris@1808: | okExponent cc = okExpDigits cc Chris@1808: Chris@1808: fun okFracTrailing [] = true Chris@1808: | okFracTrailing (c :: cs) = Chris@1808: (isDigit c andalso okFracTrailing cs) orelse Chris@1808: (c = #"e" andalso okExponent cs) Chris@1808: Chris@1808: fun okFraction [] = false Chris@1808: | okFraction (c :: cs) = Chris@1808: isDigit c andalso okFracTrailing cs Chris@1808: Chris@1808: fun okPosTrailing [] = true Chris@1808: | okPosTrailing (#"." :: cs) = okFraction cs Chris@1808: | okPosTrailing (#"e" :: cs) = okExponent cs Chris@1808: | okPosTrailing (c :: cs) = Chris@1808: isDigit c andalso okPosTrailing cs Chris@1808: Chris@1808: fun okPositive [] = false Chris@1808: | okPositive (#"0" :: []) = true Chris@1808: | okPositive (#"0" :: #"." :: cs) = okFraction cs Chris@1808: | okPositive (#"0" :: #"e" :: cs) = okExponent cs Chris@1808: | okPositive (#"0" :: cs) = false Chris@1808: | okPositive (c :: cs) = isDigit c andalso okPosTrailing cs Chris@1808: Chris@1808: fun okNumber (#"-" :: cs) = okPositive cs Chris@1808: | okNumber cc = okPositive cc Chris@1808: in Chris@1808: if okNumber digits Chris@1808: then case Real.fromString (implode digits) of Chris@1808: NONE => ERROR "Number out of range" Chris@1808: | SOME r => OK r Chris@1808: else ERROR ("Invalid number \"" ^ (implode digits) ^ "\"") Chris@1808: end Chris@1808: Chris@1808: fun parseObject (T.CURLY_R :: xs) = OK (OBJECT [], xs) Chris@1808: | parseObject tokens = Chris@1808: let fun parsePair (T.STRING key :: T.COLON :: xs) = Chris@1808: (case parseTokens xs of Chris@1808: ERROR e => ERROR e Chris@1808: | OK (j, xs) => OK ((key, j), xs)) Chris@1808: | parsePair other = Chris@1808: ERROR ("Object key/value pair expected around \"" ^ Chris@1808: show other ^ "\"") Chris@1808: fun parseObject' acc [] = ERROR "End of input during object" Chris@1808: | parseObject' acc tokens = Chris@1808: case parsePair tokens of Chris@1808: ERROR e => ERROR e Chris@1808: | OK (pair, T.COMMA :: xs) => Chris@1808: parseObject' (pair :: acc) xs Chris@1808: | OK (pair, T.CURLY_R :: xs) => Chris@1808: OK (OBJECT (rev (pair :: acc)), xs) Chris@1808: | OK (_, _) => ERROR "Expected , or } after object element" Chris@1808: in Chris@1808: parseObject' [] tokens Chris@1808: end Chris@1808: Chris@1808: and parseArray (T.SQUARE_R :: xs) = OK (ARRAY [], xs) Chris@1808: | parseArray tokens = Chris@1808: let fun parseArray' acc [] = ERROR "End of input during array" Chris@1808: | parseArray' acc tokens = Chris@1808: case parseTokens tokens of Chris@1808: ERROR e => ERROR e Chris@1808: | OK (j, T.COMMA :: xs) => parseArray' (j :: acc) xs Chris@1808: | OK (j, T.SQUARE_R :: xs) => OK (ARRAY (rev (j :: acc)), xs) Chris@1808: | OK (_, _) => ERROR "Expected , or ] after array element" Chris@1808: in Chris@1808: parseArray' [] tokens Chris@1808: end Chris@1808: Chris@1808: and parseTokens [] = ERROR "Value expected" Chris@1808: | parseTokens (tok :: xs) = Chris@1808: (case tok of Chris@1808: T.NUMBER d => (case parseNumber d of Chris@1808: OK r => OK (NUMBER r, xs) Chris@1808: | ERROR e => ERROR e) Chris@1808: | T.STRING s => OK (STRING s, xs) Chris@1808: | T.BOOL b => OK (BOOL b, xs) Chris@1808: | T.NULL => OK (NULL, xs) Chris@1808: | T.CURLY_L => parseObject xs Chris@1808: | T.SQUARE_L => parseArray xs Chris@1808: | _ => ERROR ("Unexpected token " ^ T.toString tok ^ Chris@1808: " before " ^ show xs)) Chris@1808: Chris@1808: fun parse str = Chris@1808: case lex 1 [] (explode str) of Chris@1808: ERROR e => ERROR e Chris@1808: | OK tokens => case parseTokens tokens of Chris@1808: OK (value, []) => OK value Chris@1808: | OK (_, _) => ERROR "Extra data after input" Chris@1808: | ERROR e => ERROR e Chris@1808: Chris@1808: fun stringEscape s = Chris@1808: let fun esc x = [x, #"\\"] Chris@1808: fun escape' acc [] = rev acc Chris@1808: | escape' acc (x :: xs) = Chris@1808: escape' (case x of Chris@1808: #"\"" => esc x @ acc Chris@1808: | #"\\" => esc x @ acc Chris@1808: | #"\b" => esc #"b" @ acc Chris@1808: | #"\f" => esc #"f" @ acc Chris@1808: | #"\n" => esc #"n" @ acc Chris@1808: | #"\r" => esc #"r" @ acc Chris@1808: | #"\t" => esc #"t" @ acc Chris@1808: | _ => Chris@1808: let val c = Char.ord x Chris@1808: in Chris@1808: if c < 0x20 Chris@1808: then let val hex = Word.toString (Word.fromInt c) Chris@1808: in (rev o explode) (if c < 0x10 Chris@1808: then ("\\u000" ^ hex) Chris@1808: else ("\\u00" ^ hex)) Chris@1808: end @ acc Chris@1808: else Chris@1808: x :: acc Chris@1808: end) Chris@1808: xs Chris@1808: in Chris@1808: implode (escape' [] (explode s)) Chris@1808: end Chris@1808: Chris@1808: fun serialise json = Chris@1808: case json of Chris@1808: OBJECT pp => "{" ^ String.concatWith Chris@1808: "," (map (fn (key, value) => Chris@1808: serialise (STRING key) ^ ":" ^ Chris@1808: serialise value) pp) ^ Chris@1808: "}" Chris@1808: | ARRAY arr => "[" ^ String.concatWith "," (map serialise arr) ^ "]" Chris@1808: | NUMBER n => implode (map (fn #"~" => #"-" | c => c) Chris@1808: (explode (Real.toString n))) Chris@1808: | STRING s => "\"" ^ stringEscape s ^ "\"" Chris@1808: | BOOL b => Bool.toString b Chris@1808: | NULL => "null" Chris@1808: Chris@1808: fun serialiseIndented json = Chris@1808: let fun indent 0 = "" Chris@1808: | indent i = " " ^ indent (i - 1) Chris@1808: fun serialiseIndented' i json = Chris@1808: let val ser = serialiseIndented' (i + 1) Chris@1808: in Chris@1808: case json of Chris@1808: OBJECT [] => "{}" Chris@1808: | ARRAY [] => "[]" Chris@1808: | OBJECT pp => "{\n" ^ indent (i + 1) ^ Chris@1808: String.concatWith Chris@1808: (",\n" ^ indent (i + 1)) Chris@1808: (map (fn (key, value) => Chris@1808: ser (STRING key) ^ ": " ^ Chris@1808: ser value) pp) ^ Chris@1808: "\n" ^ indent i ^ "}" Chris@1808: | ARRAY arr => "[\n" ^ indent (i + 1) ^ Chris@1808: String.concatWith Chris@1808: (",\n" ^ indent (i + 1)) Chris@1808: (map ser arr) ^ Chris@1808: "\n" ^ indent i ^ "]" Chris@1808: | other => serialise other Chris@1808: end Chris@1808: in Chris@1808: serialiseIndented' 0 json ^ "\n" Chris@1808: end Chris@1808: Chris@1808: end Chris@1808: Chris@1808: Chris@1808: structure JsonBits :> sig Chris@1808: exception Config of string Chris@1808: val load_json_from : string -> Json.json (* filename -> json *) Chris@1808: val save_json_to : string -> Json.json -> unit Chris@1808: val lookup_optional : Json.json -> string list -> Json.json option Chris@1808: val lookup_optional_string : Json.json -> string list -> string option Chris@1808: val lookup_mandatory : Json.json -> string list -> Json.json Chris@1808: val lookup_mandatory_string : Json.json -> string list -> string Chris@1808: end = struct Chris@1808: Chris@1808: exception Config of string Chris@1808: Chris@1808: fun load_json_from filename = Chris@1808: case Json.parse (FileBits.file_contents filename) of Chris@1808: Json.OK json => json Chris@1808: | Json.ERROR e => raise Config ("Failed to parse file: " ^ e) Chris@1808: Chris@1808: fun save_json_to filename json = Chris@1808: (* using binary I/O to avoid ever writing CR/LF line endings *) Chris@1808: let val jstr = Json.serialiseIndented json Chris@1808: val stream = BinIO.openOut filename Chris@1808: in Chris@1808: BinIO.output (stream, Byte.stringToBytes jstr); Chris@1808: BinIO.closeOut stream Chris@1808: end Chris@1808: Chris@1808: fun lookup_optional json kk = Chris@1808: let fun lookup key = Chris@1808: case json of Chris@1808: Json.OBJECT kvs => Chris@1808: (case List.filter (fn (k, v) => k = key) kvs of Chris@1808: [] => NONE Chris@1808: | [(_,v)] => SOME v Chris@1808: | _ => raise Config ("Duplicate key: " ^ Chris@1808: (String.concatWith " -> " kk))) Chris@1808: | _ => raise Config "Object expected" Chris@1808: in Chris@1808: case kk of Chris@1808: [] => NONE Chris@1808: | key::[] => lookup key Chris@1808: | key::kk => case lookup key of Chris@1808: NONE => NONE Chris@1808: | SOME j => lookup_optional j kk Chris@1808: end Chris@1808: Chris@1808: fun lookup_optional_string json kk = Chris@1808: case lookup_optional json kk of Chris@1808: SOME (Json.STRING s) => SOME s Chris@1808: | SOME _ => raise Config ("Value (if present) must be string: " ^ Chris@1808: (String.concatWith " -> " kk)) Chris@1808: | NONE => NONE Chris@1808: Chris@1808: fun lookup_mandatory json kk = Chris@1808: case lookup_optional json kk of Chris@1808: SOME v => v Chris@1808: | NONE => raise Config ("Value is mandatory: " ^ Chris@1808: (String.concatWith " -> " kk)) Chris@1808: Chris@1808: fun lookup_mandatory_string json kk = Chris@1808: case lookup_optional json kk of Chris@1808: SOME (Json.STRING s) => s Chris@1808: | _ => raise Config ("Value must be string: " ^ Chris@1808: (String.concatWith " -> " kk)) Chris@1808: end Chris@1808: Chris@1808: structure Provider :> sig Chris@1808: val load_providers : Json.json -> provider list Chris@1808: val load_more_providers : provider list -> Json.json -> provider list Chris@1808: val remote_url : context -> vcs -> source -> libname -> string Chris@1808: end = struct Chris@1808: Chris@1808: val known_providers : provider list = Chris@1808: [ { Chris@1808: service = "bitbucket", Chris@1808: supports = [HG, GIT], Chris@1808: remote_spec = { Chris@1808: anon = SOME "https://bitbucket.org/{owner}/{repository}", Chris@1808: auth = SOME "ssh://{vcs}@bitbucket.org/{owner}/{repository}" Chris@1808: } Chris@1808: }, Chris@1808: { Chris@1808: service = "github", Chris@1808: supports = [GIT], Chris@1808: remote_spec = { Chris@1808: anon = SOME "https://github.com/{owner}/{repository}", Chris@1808: auth = SOME "ssh://{vcs}@github.com/{owner}/{repository}" Chris@1808: } Chris@1808: } Chris@1808: ] Chris@1808: Chris@1808: fun vcs_name vcs = Chris@1808: case vcs of HG => "hg" Chris@1808: | GIT => "git" Chris@1808: | SVN => "svn" Chris@1808: Chris@1808: fun vcs_from_name name = Chris@1808: case name of "hg" => HG Chris@1808: | "git" => GIT Chris@1808: | "svn" => SVN Chris@1808: | other => raise Fail ("Unknown vcs name \"" ^ name ^ "\"") Chris@1808: Chris@1808: fun load_more_providers previously_loaded json = Chris@1808: let open JsonBits Chris@1808: fun load pjson pname : provider = Chris@1808: { Chris@1808: service = pname, Chris@1808: supports = Chris@1808: case lookup_mandatory pjson ["vcs"] of Chris@1808: Json.ARRAY vv => Chris@1808: map (fn (Json.STRING v) => vcs_from_name v Chris@1808: | _ => raise Fail "Strings expected in vcs array") Chris@1808: vv Chris@1808: | _ => raise Fail "Array expected for vcs", Chris@1808: remote_spec = { Chris@1808: anon = lookup_optional_string pjson ["anonymous"], Chris@1808: auth = lookup_optional_string pjson ["authenticated"] Chris@1808: } Chris@1808: } Chris@1808: val loaded = Chris@1808: case lookup_optional json ["services"] of Chris@1808: NONE => [] Chris@1808: | SOME (Json.OBJECT pl) => map (fn (k, v) => load v k) pl Chris@1808: | _ => raise Fail "Object expected for services in config" Chris@1808: val newly_loaded = Chris@1808: List.filter (fn p => not (List.exists (fn pp => #service p = Chris@1808: #service pp) Chris@1808: previously_loaded)) Chris@1808: loaded Chris@1808: in Chris@1808: previously_loaded @ newly_loaded Chris@1808: end Chris@1808: Chris@1808: fun load_providers json = Chris@1808: load_more_providers known_providers json Chris@1808: Chris@1808: fun expand_spec spec { vcs, service, owner, repo } login = Chris@1808: (* ugly *) Chris@1808: let fun replace str = Chris@1808: case str of Chris@1808: "vcs" => vcs_name vcs Chris@1808: | "service" => service Chris@1808: | "owner" => Chris@1808: (case owner of Chris@1808: SOME ostr => ostr Chris@1808: | NONE => raise Fail ("Owner not specified for service " ^ Chris@1808: service)) Chris@1808: | "repository" => repo Chris@1808: | "account" => Chris@1808: (case login of Chris@1808: SOME acc => acc Chris@1808: | NONE => raise Fail ("Account not given for service " ^ Chris@1808: service)) Chris@1808: | other => raise Fail ("Unknown variable \"" ^ other ^ Chris@1808: "\" in spec for service " ^ service) Chris@1808: fun expand' acc sstr = Chris@1808: case Substring.splitl (fn c => c <> #"{") sstr of Chris@1808: (pfx, sfx) => Chris@1808: if Substring.isEmpty sfx Chris@1808: then rev (pfx :: acc) Chris@1808: else Chris@1808: case Substring.splitl (fn c => c <> #"}") sfx of Chris@1808: (tok, remainder) => Chris@1808: if Substring.isEmpty remainder Chris@1808: then rev (tok :: pfx :: acc) Chris@1808: else let val replacement = Chris@1808: replace Chris@1808: (* tok begins with "{": *) Chris@1808: (Substring.string Chris@1808: (Substring.triml 1 tok)) Chris@1808: in Chris@1808: expand' (Substring.full replacement :: Chris@1808: pfx :: acc) Chris@1808: (* remainder begins with "}": *) Chris@1808: (Substring.triml 1 remainder) Chris@1808: end Chris@1808: in Chris@1808: Substring.concat (expand' [] (Substring.full spec)) Chris@1808: end Chris@1808: Chris@1808: fun provider_url req login providers = Chris@1808: case providers of Chris@1808: [] => raise Fail ("Unknown service \"" ^ (#service req) ^ Chris@1808: "\" for vcs \"" ^ (vcs_name (#vcs req)) ^ "\"") Chris@1808: | ({ service, supports, remote_spec : remote_spec } :: rest) => Chris@1808: if service <> (#service req) orelse Chris@1808: not (List.exists (fn v => v = (#vcs req)) supports) Chris@1808: then provider_url req login rest Chris@1808: else Chris@1808: case (login, #auth remote_spec, #anon remote_spec) of Chris@1808: (SOME _, SOME auth, _) => expand_spec auth req login Chris@1808: | (SOME _, _, SOME anon) => expand_spec anon req NONE Chris@1808: | (NONE, _, SOME anon) => expand_spec anon req NONE Chris@1808: | _ => raise Fail ("No suitable anonymous or authenticated " ^ Chris@1808: "URL spec provided for service \"" ^ Chris@1808: service ^ "\"") Chris@1808: Chris@1808: fun login_for ({ accounts, ... } : context) service = Chris@1808: case List.find (fn a => service = #service a) accounts of Chris@1808: SOME { login, ... } => SOME login Chris@1808: | NONE => NONE Chris@1808: Chris@1808: fun reponame_for path = Chris@1808: case String.tokens (fn c => c = #"/") path of Chris@1808: [] => raise Fail "Non-empty library path required" Chris@1808: | toks => hd (rev toks) Chris@1808: Chris@1808: fun remote_url (context : context) vcs source libname = Chris@1808: case source of Chris@1808: URL_SOURCE u => u Chris@1808: | SERVICE_SOURCE { service, owner, repo } => Chris@1808: provider_url { vcs = vcs, Chris@1808: service = service, Chris@1808: owner = owner, Chris@1808: repo = case repo of Chris@1808: SOME r => r Chris@1808: | NONE => reponame_for libname } Chris@1808: (login_for context service) Chris@1808: (#providers context) Chris@1808: end Chris@1808: Chris@1808: structure HgControl :> VCS_CONTROL = struct Chris@1808: Chris@1808: (* Pulls always use an explicit URL, never just the default Chris@1808: remote, in order to ensure we update properly if the location Chris@1808: given in the project file changes. *) Chris@1808: Chris@1808: type vcsstate = { id: string, modified: bool, Chris@1808: branch: string, tags: string list } Chris@1808: Chris@1808: val hg_program = "hg" Chris@1808: Chris@1808: val hg_args = [ "--config", "ui.interactive=true", Chris@1808: "--config", "ui.merge=:merge" ] Chris@1808: Chris@1808: fun hg_command context libname args = Chris@1808: FileBits.command context libname (hg_program :: hg_args @ args) Chris@1808: Chris@1808: fun hg_command_output context libname args = Chris@1808: FileBits.command_output context libname (hg_program :: hg_args @ args) Chris@1808: Chris@1808: fun is_working context = Chris@1808: case hg_command_output context "" ["--version"] of Chris@1808: OK "" => OK false Chris@1808: | OK _ => OK true Chris@1808: | ERROR e => ERROR e Chris@1808: Chris@1808: fun exists context libname = Chris@1808: OK (OS.FileSys.isDir (FileBits.subpath context libname ".hg")) Chris@1808: handle _ => OK false Chris@1808: Chris@1808: fun remote_for context (libname, source) = Chris@1808: Provider.remote_url context HG source libname Chris@1808: Chris@1808: fun current_state context libname : vcsstate result = Chris@1808: let fun is_branch text = text <> "" andalso #"(" = hd (explode text) Chris@1808: and extract_branch b = Chris@1808: if is_branch b (* need to remove enclosing parens *) Chris@1808: then (implode o rev o tl o rev o tl o explode) b Chris@1808: else "default" Chris@1808: and is_modified id = id <> "" andalso #"+" = hd (rev (explode id)) Chris@1808: and extract_id id = Chris@1808: if is_modified id (* need to remove trailing "+" *) Chris@1808: then (implode o rev o tl o rev o explode) id Chris@1808: else id Chris@1808: and split_tags tags = String.tokens (fn c => c = #"/") tags Chris@1808: and state_for (id, branch, tags) = Chris@1808: OK { id = extract_id id, Chris@1808: modified = is_modified id, Chris@1808: branch = extract_branch branch, Chris@1808: tags = split_tags tags } Chris@1808: in Chris@1808: case hg_command_output context libname ["id"] of Chris@1808: ERROR e => ERROR e Chris@1808: | OK out => Chris@1808: case String.tokens (fn x => x = #" ") out of Chris@1808: [id, branch, tags] => state_for (id, branch, tags) Chris@1808: | [id, other] => if is_branch other Chris@1808: then state_for (id, other, "") Chris@1808: else state_for (id, "", other) Chris@1808: | [id] => state_for (id, "", "") Chris@1808: | _ => ERROR ("Unexpected output from hg id: " ^ out) Chris@1808: end Chris@1808: Chris@1808: fun branch_name branch = case branch of Chris@1808: DEFAULT_BRANCH => "default" Chris@1808: | BRANCH "" => "default" Chris@1808: | BRANCH b => b Chris@1808: Chris@1808: fun id_of context libname = Chris@1808: case current_state context libname of Chris@1808: ERROR e => ERROR e Chris@1808: | OK { id, ... } => OK id Chris@1808: Chris@1808: fun is_at context (libname, id_or_tag) = Chris@1808: case current_state context libname of Chris@1808: ERROR e => ERROR e Chris@1808: | OK { id, tags, ... } => Chris@1808: OK (String.isPrefix id_or_tag id orelse Chris@1808: String.isPrefix id id_or_tag orelse Chris@1808: List.exists (fn t => t = id_or_tag) tags) Chris@1808: Chris@1808: fun is_on_branch context (libname, b) = Chris@1808: case current_state context libname of Chris@1808: ERROR e => ERROR e Chris@1808: | OK { branch, ... } => OK (branch = branch_name b) Chris@1808: Chris@1808: fun is_newest_locally context (libname, branch) = Chris@1808: case hg_command_output context libname Chris@1808: ["log", "-l1", Chris@1808: "-b", branch_name branch, Chris@1808: "--template", "{node}"] of Chris@1808: ERROR e => OK false (* desired branch does not exist *) Chris@1808: | OK newest_in_repo => is_at context (libname, newest_in_repo) Chris@1808: Chris@1808: fun pull context (libname, source) = Chris@1808: let val url = remote_for context (libname, source) Chris@1808: in Chris@1808: hg_command context libname Chris@1808: (if FileBits.verbose () Chris@1808: then ["pull", url] Chris@1808: else ["pull", "-q", url]) Chris@1808: end Chris@1808: Chris@1808: fun is_newest context (libname, source, branch) = Chris@1808: case is_newest_locally context (libname, branch) of Chris@1808: ERROR e => ERROR e Chris@1808: | OK false => OK false Chris@1808: | OK true => Chris@1808: case pull context (libname, source) of Chris@1808: ERROR e => ERROR e Chris@1808: | _ => is_newest_locally context (libname, branch) Chris@1808: Chris@1808: fun is_modified_locally context libname = Chris@1808: case current_state context libname of Chris@1808: ERROR e => ERROR e Chris@1808: | OK { modified, ... } => OK modified Chris@1808: Chris@1808: fun checkout context (libname, source, branch) = Chris@1808: let val url = remote_for context (libname, source) Chris@1808: in Chris@1808: (* make the lib dir rather than just the ext dir, since Chris@1808: the lib dir might be nested and hg will happily check Chris@1808: out into an existing empty dir anyway *) Chris@1808: case FileBits.mkpath (FileBits.libpath context libname) of Chris@1808: ERROR e => ERROR e Chris@1808: | _ => hg_command context "" Chris@1808: ["clone", "-u", branch_name branch, Chris@1808: url, libname] Chris@1808: end Chris@1808: Chris@1808: fun update context (libname, source, branch) = Chris@1808: let val pull_result = pull context (libname, source) Chris@1808: in Chris@1808: case hg_command context libname ["update", branch_name branch] of Chris@1808: ERROR e => ERROR e Chris@1808: | _ => Chris@1808: case pull_result of Chris@1808: ERROR e => ERROR e Chris@1808: | _ => OK () Chris@1808: end Chris@1808: Chris@1808: fun update_to context (libname, _, "") = Chris@1808: ERROR "Non-empty id (tag or revision id) required for update_to" Chris@1808: | update_to context (libname, source, id) = Chris@1808: let val pull_result = pull context (libname, source) Chris@1808: in Chris@1808: case hg_command context libname ["update", "-r", id] of Chris@1808: OK _ => OK () Chris@1808: | ERROR e => Chris@1808: case pull_result of Chris@1808: ERROR e' => ERROR e' (* this was the ur-error *) Chris@1808: | _ => ERROR e Chris@1808: end Chris@1808: Chris@1808: fun copy_url_for context libname = Chris@1808: OK (FileBits.file_url (FileBits.libpath context libname)) Chris@1808: Chris@1808: end Chris@1808: Chris@1808: structure GitControl :> VCS_CONTROL = struct Chris@1808: Chris@1808: (* With Git repos we always operate in detached HEAD state. Even Chris@1808: the master branch is checked out using a remote reference Chris@1808: (repoint/master). The remote we use is always named repoint, and we Chris@1808: update it to the expected URL each time we fetch, in order to Chris@1808: ensure we update properly if the location given in the project Chris@1808: file changes. The origin remote is unused. *) Chris@1808: Chris@1808: val git_program = "git" Chris@1808: Chris@1808: fun git_command context libname args = Chris@1808: FileBits.command context libname (git_program :: args) Chris@1808: Chris@1808: fun git_command_output context libname args = Chris@1808: FileBits.command_output context libname (git_program :: args) Chris@1808: Chris@1808: fun is_working context = Chris@1808: case git_command_output context "" ["--version"] of Chris@1808: OK "" => OK false Chris@1808: | OK _ => OK true Chris@1808: | ERROR e => ERROR e Chris@1808: Chris@1808: fun exists context libname = Chris@1808: OK (OS.FileSys.isDir (FileBits.subpath context libname ".git")) Chris@1808: handle _ => OK false Chris@1808: Chris@1808: fun remote_for context (libname, source) = Chris@1808: Provider.remote_url context GIT source libname Chris@1808: Chris@1808: fun branch_name branch = case branch of Chris@1808: DEFAULT_BRANCH => "master" Chris@1808: | BRANCH "" => "master" Chris@1808: | BRANCH b => b Chris@1808: Chris@1808: val our_remote = "repoint" Chris@1808: Chris@1808: fun remote_branch_name branch = our_remote ^ "/" ^ branch_name branch Chris@1808: Chris@1808: fun checkout context (libname, source, branch) = Chris@1808: let val url = remote_for context (libname, source) Chris@1808: in Chris@1808: (* make the lib dir rather than just the ext dir, since Chris@1808: the lib dir might be nested and git will happily check Chris@1808: out into an existing empty dir anyway *) Chris@1808: case FileBits.mkpath (FileBits.libpath context libname) of Chris@1808: OK () => git_command context "" Chris@1808: ["clone", "--origin", our_remote, Chris@1808: "--branch", branch_name branch, Chris@1808: url, libname] Chris@1808: | ERROR e => ERROR e Chris@1808: end Chris@1808: Chris@1808: fun add_our_remote context (libname, source) = Chris@1808: (* When we do the checkout ourselves (above), we add the Chris@1808: remote at the same time. But if the repo was cloned by Chris@1808: someone else, we'll need to do it after the fact. Git Chris@1808: doesn't seem to have a means to add a remote or change its Chris@1808: url if it already exists; seems we have to do this: *) Chris@1808: let val url = remote_for context (libname, source) Chris@1808: in Chris@1808: case git_command context libname Chris@1808: ["remote", "set-url", our_remote, url] of Chris@1808: OK () => OK () Chris@1808: | ERROR e => git_command context libname Chris@1808: ["remote", "add", "-f", our_remote, url] Chris@1808: end Chris@1808: Chris@1808: (* NB git rev-parse HEAD shows revision id of current checkout; Chris@1808: git rev-list -1 shows revision id of revision with that tag *) Chris@1808: Chris@1808: fun id_of context libname = Chris@1808: git_command_output context libname ["rev-parse", "HEAD"] Chris@1808: Chris@1808: fun is_at context (libname, id_or_tag) = Chris@1808: case id_of context libname of Chris@1808: ERROR e => OK false (* HEAD nonexistent, expected in empty repo *) Chris@1808: | OK id => Chris@1808: if String.isPrefix id_or_tag id orelse Chris@1808: String.isPrefix id id_or_tag Chris@1808: then OK true Chris@1808: else is_at_tag context (libname, id, id_or_tag) Chris@1808: Chris@1808: and is_at_tag context (libname, id, tag) = Chris@1808: (* For annotated tags (with message) show-ref returns the tag Chris@1808: object ref rather than that of the revision being tagged; Chris@1808: we need the subsequent rev-list to chase that up. In fact Chris@1808: the rev-list on its own is enough to get us the id direct Chris@1808: from the tag name, but it fails with an error if the tag Chris@1808: doesn't exist, whereas we want to handle that quietly in Chris@1808: case the tag simply hasn't been pulled yet *) Chris@1808: case git_command_output context libname Chris@1808: ["show-ref", "refs/tags/" ^ tag, "--"] of Chris@1808: OK "" => OK false (* Not a tag *) Chris@1808: | ERROR _ => OK false Chris@1808: | OK s => Chris@1808: let val tag_ref = hd (String.tokens (fn c => c = #" ") s) Chris@1808: in Chris@1808: case git_command_output context libname Chris@1808: ["rev-list", "-1", tag_ref] of Chris@1808: OK tagged => OK (id = tagged) Chris@1808: | ERROR _ => OK false Chris@1808: end Chris@1808: Chris@1808: fun branch_tip context (libname, branch) = Chris@1808: (* We don't have access to the source info or the network Chris@1808: here, as this is used by status (e.g. via is_on_branch) as Chris@1808: well as review. It's possible the remote branch won't exist, Chris@1808: e.g. if the repo was checked out by something other than Chris@1808: Repoint, and if that's the case, we can't add it here; we'll Chris@1808: just have to fail, since checking against local branches Chris@1808: instead could produce the wrong result. *) Chris@1808: git_command_output context libname Chris@1808: ["rev-list", "-1", Chris@1808: remote_branch_name branch, "--"] Chris@1808: Chris@1808: fun is_newest_locally context (libname, branch) = Chris@1808: case branch_tip context (libname, branch) of Chris@1808: ERROR e => OK false Chris@1808: | OK rev => is_at context (libname, rev) Chris@1808: Chris@1808: fun is_on_branch context (libname, branch) = Chris@1808: case branch_tip context (libname, branch) of Chris@1808: ERROR e => OK false Chris@1808: | OK rev => Chris@1808: case is_at context (libname, rev) of Chris@1808: ERROR e => ERROR e Chris@1808: | OK true => OK true Chris@1808: | OK false => Chris@1808: case git_command context libname Chris@1808: ["merge-base", "--is-ancestor", Chris@1808: "HEAD", remote_branch_name branch] of Chris@1808: ERROR e => OK false (* cmd returns non-zero for no *) Chris@1808: | _ => OK true Chris@1808: Chris@1808: fun fetch context (libname, source) = Chris@1808: case add_our_remote context (libname, source) of Chris@1808: ERROR e => ERROR e Chris@1808: | _ => git_command context libname ["fetch", our_remote] Chris@1808: Chris@1808: fun is_newest context (libname, source, branch) = Chris@1808: case add_our_remote context (libname, source) of Chris@1808: ERROR e => ERROR e Chris@1808: | OK () => Chris@1808: case is_newest_locally context (libname, branch) of Chris@1808: ERROR e => ERROR e Chris@1808: | OK false => OK false Chris@1808: | OK true => Chris@1808: case fetch context (libname, source) of Chris@1808: ERROR e => ERROR e Chris@1808: | _ => is_newest_locally context (libname, branch) Chris@1808: Chris@1808: fun is_modified_locally context libname = Chris@1808: case git_command_output context libname ["status", "--porcelain"] of Chris@1808: ERROR e => ERROR e Chris@1808: | OK "" => OK false Chris@1808: | OK _ => OK true Chris@1808: Chris@1808: (* This function updates to the latest revision on a branch rather Chris@1808: than to a specific id or tag. We can't just checkout the given Chris@1808: branch, as that will succeed even if the branch isn't up to Chris@1808: date. We could checkout the branch and then fetch and merge, Chris@1808: but it's perhaps cleaner not to maintain a local branch at all, Chris@1808: but instead checkout the remote branch as a detached head. *) Chris@1808: Chris@1808: fun update context (libname, source, branch) = Chris@1808: case fetch context (libname, source) of Chris@1808: ERROR e => ERROR e Chris@1808: | _ => Chris@1808: case git_command context libname ["checkout", "--detach", Chris@1808: remote_branch_name branch] of Chris@1808: ERROR e => ERROR e Chris@1808: | _ => OK () Chris@1808: Chris@1808: (* This function is dealing with a specific id or tag, so if we Chris@1808: can successfully check it out (detached) then that's all we Chris@1808: need to do, regardless of whether fetch succeeded or not. We do Chris@1808: attempt the fetch first, though, purely in order to avoid ugly Chris@1808: error messages in the common case where we're being asked to Chris@1808: update to a new pin (from the lock file) that hasn't been Chris@1808: fetched yet. *) Chris@1808: Chris@1808: fun update_to context (libname, _, "") = Chris@1808: ERROR "Non-empty id (tag or revision id) required for update_to" Chris@1808: | update_to context (libname, source, id) = Chris@1808: let val fetch_result = fetch context (libname, source) Chris@1808: in Chris@1808: case git_command context libname ["checkout", "--detach", id] of Chris@1808: OK _ => OK () Chris@1808: | ERROR e => Chris@1808: case fetch_result of Chris@1808: ERROR e' => ERROR e' (* this was the ur-error *) Chris@1808: | _ => ERROR e Chris@1808: end Chris@1808: Chris@1808: fun copy_url_for context libname = Chris@1808: OK (FileBits.file_url (FileBits.libpath context libname)) Chris@1808: Chris@1808: end Chris@1808: Chris@1808: (* SubXml - A parser for a subset of XML Chris@1808: https://bitbucket.org/cannam/sml-subxml Chris@1808: Copyright 2018 Chris Cannam. BSD licence. Chris@1808: *) Chris@1808: Chris@1808: signature SUBXML = sig Chris@1808: Chris@1808: datatype node = ELEMENT of { name : string, children : node list } Chris@1808: | ATTRIBUTE of { name : string, value : string } Chris@1808: | TEXT of string Chris@1808: | CDATA of string Chris@1808: | COMMENT of string Chris@1808: Chris@1808: datatype document = DOCUMENT of { name : string, children : node list } Chris@1808: Chris@1808: datatype 'a result = OK of 'a Chris@1808: | ERROR of string Chris@1808: Chris@1808: val parse : string -> document result Chris@1808: val serialise : document -> string Chris@1808: Chris@1808: end Chris@1808: Chris@1808: structure SubXml :> SUBXML = struct Chris@1808: Chris@1808: datatype node = ELEMENT of { name : string, children : node list } Chris@1808: | ATTRIBUTE of { name : string, value : string } Chris@1808: | TEXT of string Chris@1808: | CDATA of string Chris@1808: | COMMENT of string Chris@1808: Chris@1808: datatype document = DOCUMENT of { name : string, children : node list } Chris@1808: Chris@1808: datatype 'a result = OK of 'a Chris@1808: | ERROR of string Chris@1808: Chris@1808: structure T = struct Chris@1808: datatype token = ANGLE_L Chris@1808: | ANGLE_R Chris@1808: | ANGLE_SLASH_L Chris@1808: | SLASH_ANGLE_R Chris@1808: | EQUAL Chris@1808: | NAME of string Chris@1808: | TEXT of string Chris@1808: | CDATA of string Chris@1808: | COMMENT of string Chris@1808: Chris@1808: fun name t = Chris@1808: case t of ANGLE_L => "<" Chris@1808: | ANGLE_R => ">" Chris@1808: | ANGLE_SLASH_L => " "/>" Chris@1808: | EQUAL => "=" Chris@1808: | NAME s => "name \"" ^ s ^ "\"" Chris@1808: | TEXT s => "text" Chris@1808: | CDATA _ => "CDATA section" Chris@1808: | COMMENT _ => "comment" Chris@1808: end Chris@1808: Chris@1808: structure Lex :> sig Chris@1808: val lex : string -> T.token list result Chris@1808: end = struct Chris@1808: Chris@1808: fun error pos text = Chris@1808: ERROR (text ^ " at character position " ^ Int.toString (pos-1)) Chris@1808: fun tokenError pos token = Chris@1808: error pos ("Unexpected token '" ^ Char.toString token ^ "'") Chris@1808: Chris@1808: val nameEnd = explode " \t\n\r\"'!=?" Chris@1808: Chris@1808: fun quoted quote pos acc cc = Chris@1808: let fun quoted' pos text [] = Chris@1808: error pos "Document ends during quoted string" Chris@1808: | quoted' pos text (x::xs) = Chris@1808: if x = quote Chris@1808: then OK (rev text, xs, pos+1) Chris@1808: else quoted' (pos+1) (x::text) xs Chris@1808: in Chris@1808: case quoted' pos [] cc of Chris@1808: ERROR e => ERROR e Chris@1808: | OK (text, rest, newpos) => Chris@1808: inside newpos (T.TEXT (implode text) :: acc) rest Chris@1808: end Chris@1808: Chris@1808: and name first pos acc cc = Chris@1808: let fun name' pos text [] = Chris@1808: error pos "Document ends during name" Chris@1808: | name' pos text (x::xs) = Chris@1808: if List.find (fn c => c = x) nameEnd <> NONE Chris@1808: then OK (rev text, (x::xs), pos) Chris@1808: else name' (pos+1) (x::text) xs Chris@1808: in Chris@1808: case name' (pos-1) [] (first::cc) of Chris@1808: ERROR e => ERROR e Chris@1808: | OK ([], [], pos) => error pos "Document ends before name" Chris@1808: | OK ([], (x::xs), pos) => tokenError pos x Chris@1808: | OK (text, rest, pos) => Chris@1808: inside pos (T.NAME (implode text) :: acc) rest Chris@1808: end Chris@1808: Chris@1808: and comment pos acc cc = Chris@1808: let fun comment' pos text cc = Chris@1808: case cc of Chris@1808: #"-" :: #"-" :: #">" :: xs => OK (rev text, xs, pos+3) Chris@1808: | x :: xs => comment' (pos+1) (x::text) xs Chris@1808: | [] => error pos "Document ends during comment" Chris@1808: in Chris@1808: case comment' pos [] cc of Chris@1808: ERROR e => ERROR e Chris@1808: | OK (text, rest, pos) => Chris@1808: outside pos (T.COMMENT (implode text) :: acc) rest Chris@1808: end Chris@1808: Chris@1808: and instruction pos acc cc = Chris@1808: case cc of Chris@1808: #"?" :: #">" :: xs => outside (pos+2) acc xs Chris@1808: | #">" :: _ => tokenError pos #">" Chris@1808: | x :: xs => instruction (pos+1) acc xs Chris@1808: | [] => error pos "Document ends during processing instruction" Chris@1808: Chris@1808: and cdata pos acc cc = Chris@1808: let fun cdata' pos text cc = Chris@1808: case cc of Chris@1808: #"]" :: #"]" :: #">" :: xs => OK (rev text, xs, pos+3) Chris@1808: | x :: xs => cdata' (pos+1) (x::text) xs Chris@1808: | [] => error pos "Document ends during CDATA section" Chris@1808: in Chris@1808: case cdata' pos [] cc of Chris@1808: ERROR e => ERROR e Chris@1808: | OK (text, rest, pos) => Chris@1808: outside pos (T.CDATA (implode text) :: acc) rest Chris@1808: end Chris@1808: Chris@1808: and doctype pos acc cc = Chris@1808: case cc of Chris@1808: #">" :: xs => outside (pos+1) acc xs Chris@1808: | x :: xs => doctype (pos+1) acc xs Chris@1808: | [] => error pos "Document ends during DOCTYPE" Chris@1808: Chris@1808: and declaration pos acc cc = Chris@1808: case cc of Chris@1808: #"-" :: #"-" :: xs => Chris@1808: comment (pos+2) acc xs Chris@1808: | #"[" :: #"C" :: #"D" :: #"A" :: #"T" :: #"A" :: #"[" :: xs => Chris@1808: cdata (pos+7) acc xs Chris@1808: | #"D" :: #"O" :: #"C" :: #"T" :: #"Y" :: #"P" :: #"E" :: xs => Chris@1808: doctype (pos+7) acc xs Chris@1808: | [] => error pos "Document ends during declaration" Chris@1808: | _ => error pos "Unsupported declaration type" Chris@1808: Chris@1808: and left pos acc cc = Chris@1808: case cc of Chris@1808: #"/" :: xs => inside (pos+1) (T.ANGLE_SLASH_L :: acc) xs Chris@1808: | #"!" :: xs => declaration (pos+1) acc xs Chris@1808: | #"?" :: xs => instruction (pos+1) acc xs Chris@1808: | xs => inside pos (T.ANGLE_L :: acc) xs Chris@1808: Chris@1808: and slash pos acc cc = Chris@1808: case cc of Chris@1808: #">" :: xs => outside (pos+1) (T.SLASH_ANGLE_R :: acc) xs Chris@1808: | x :: _ => tokenError pos x Chris@1808: | [] => error pos "Document ends before element closed" Chris@1808: Chris@1808: and close pos acc xs = outside pos (T.ANGLE_R :: acc) xs Chris@1808: Chris@1808: and equal pos acc xs = inside pos (T.EQUAL :: acc) xs Chris@1808: Chris@1808: and outside pos acc [] = OK acc Chris@1808: | outside pos acc cc = Chris@1808: let fun textOf text = T.TEXT (implode (rev text)) Chris@1808: fun outside' pos [] acc [] = OK acc Chris@1808: | outside' pos text acc [] = OK (textOf text :: acc) Chris@1808: | outside' pos text acc (x::xs) = Chris@1808: case x of Chris@1808: #"<" => if text = [] Chris@1808: then left (pos+1) acc xs Chris@1808: else left (pos+1) (textOf text :: acc) xs Chris@1808: | x => outside' (pos+1) (x::text) acc xs Chris@1808: in Chris@1808: outside' pos [] acc cc Chris@1808: end Chris@1808: Chris@1808: and inside pos acc [] = error pos "Document ends within tag" Chris@1808: | inside pos acc (#"<"::_) = tokenError pos #"<" Chris@1808: | inside pos acc (x::xs) = Chris@1808: (case x of Chris@1808: #" " => inside | #"\t" => inside Chris@1808: | #"\n" => inside | #"\r" => inside Chris@1808: | #"\"" => quoted x | #"'" => quoted x Chris@1808: | #"/" => slash | #">" => close | #"=" => equal Chris@1808: | x => name x) (pos+1) acc xs Chris@1808: Chris@1808: fun lex str = Chris@1808: case outside 1 [] (explode str) of Chris@1808: ERROR e => ERROR e Chris@1808: | OK tokens => OK (rev tokens) Chris@1808: end Chris@1808: Chris@1808: structure Parse :> sig Chris@1808: val parse : string -> document result Chris@1808: end = struct Chris@1808: Chris@1808: fun show [] = "end of input" Chris@1808: | show (tok :: _) = T.name tok Chris@1808: Chris@1808: fun error toks text = ERROR (text ^ " before " ^ show toks) Chris@1808: Chris@1808: fun attribute elt name toks = Chris@1808: case toks of Chris@1808: T.EQUAL :: T.TEXT value :: xs => Chris@1808: namedElement { Chris@1808: name = #name elt, Chris@1808: children = ATTRIBUTE { name = name, value = value } :: Chris@1808: #children elt Chris@1808: } xs Chris@1808: | T.EQUAL :: xs => error xs "Expected attribute value" Chris@1808: | toks => error toks "Expected attribute assignment" Chris@1808: Chris@1808: and content elt toks = Chris@1808: case toks of Chris@1808: T.ANGLE_SLASH_L :: T.NAME n :: T.ANGLE_R :: xs => Chris@1808: if n = #name elt Chris@1808: then OK (elt, xs) Chris@1808: else ERROR ("Closing tag " ^ Chris@1808: "does not match opening <" ^ #name elt ^ ">") Chris@1808: | T.TEXT text :: xs => Chris@1808: content { Chris@1808: name = #name elt, Chris@1808: children = TEXT text :: #children elt Chris@1808: } xs Chris@1808: | T.CDATA text :: xs => Chris@1808: content { Chris@1808: name = #name elt, Chris@1808: children = CDATA text :: #children elt Chris@1808: } xs Chris@1808: | T.COMMENT text :: xs => Chris@1808: content { Chris@1808: name = #name elt, Chris@1808: children = COMMENT text :: #children elt Chris@1808: } xs Chris@1808: | T.ANGLE_L :: xs => Chris@1808: (case element xs of Chris@1808: ERROR e => ERROR e Chris@1808: | OK (child, xs) => Chris@1808: content { Chris@1808: name = #name elt, Chris@1808: children = ELEMENT child :: #children elt Chris@1808: } xs) Chris@1808: | tok :: xs => Chris@1808: error xs ("Unexpected token " ^ T.name tok) Chris@1808: | [] => Chris@1808: ERROR ("Document ends within element \"" ^ #name elt ^ "\"") Chris@1808: Chris@1808: and namedElement elt toks = Chris@1808: case toks of Chris@1808: T.SLASH_ANGLE_R :: xs => OK (elt, xs) Chris@1808: | T.NAME name :: xs => attribute elt name xs Chris@1808: | T.ANGLE_R :: xs => content elt xs Chris@1808: | x :: xs => error xs ("Unexpected token " ^ T.name x) Chris@1808: | [] => ERROR "Document ends within opening tag" Chris@1808: Chris@1808: and element toks = Chris@1808: case toks of Chris@1808: T.NAME name :: xs => Chris@1808: (case namedElement { name = name, children = [] } xs of Chris@1808: ERROR e => ERROR e Chris@1808: | OK ({ name, children }, xs) => Chris@1808: OK ({ name = name, children = rev children }, xs)) Chris@1808: | toks => error toks "Expected element name" Chris@1808: Chris@1808: and document [] = ERROR "Empty document" Chris@1808: | document (tok :: xs) = Chris@1808: case tok of Chris@1808: T.TEXT _ => document xs Chris@1808: | T.COMMENT _ => document xs Chris@1808: | T.ANGLE_L => Chris@1808: (case element xs of Chris@1808: ERROR e => ERROR e Chris@1808: | OK (elt, []) => OK (DOCUMENT elt) Chris@1808: | OK (elt, (T.TEXT _ :: xs)) => OK (DOCUMENT elt) Chris@1808: | OK (elt, xs) => error xs "Extra data after document") Chris@1808: | _ => error xs ("Unexpected token " ^ T.name tok) Chris@1808: Chris@1808: fun parse str = Chris@1808: case Lex.lex str of Chris@1808: ERROR e => ERROR e Chris@1808: | OK tokens => document tokens Chris@1808: end Chris@1808: Chris@1808: structure Serialise :> sig Chris@1808: val serialise : document -> string Chris@1808: end = struct Chris@1808: Chris@1808: fun attributes nodes = Chris@1808: String.concatWith Chris@1808: " " Chris@1808: (map node (List.filter Chris@1808: (fn ATTRIBUTE _ => true | _ => false) Chris@1808: nodes)) Chris@1808: Chris@1808: and nonAttributes nodes = Chris@1808: String.concat Chris@1808: (map node (List.filter Chris@1808: (fn ATTRIBUTE _ => false | _ => true) Chris@1808: nodes)) Chris@1808: Chris@1808: and node n = Chris@1808: case n of Chris@1808: TEXT string => Chris@1808: string Chris@1808: | CDATA string => Chris@1808: "" Chris@1808: | COMMENT string => Chris@1808: "" Chris@1808: | ATTRIBUTE { name, value } => Chris@1808: name ^ "=" ^ "\"" ^ value ^ "\"" (*!!!*) Chris@1808: | ELEMENT { name, children } => Chris@1808: "<" ^ name ^ Chris@1808: (case (attributes children) of Chris@1808: "" => "" Chris@1808: | s => " " ^ s) ^ Chris@1808: (case (nonAttributes children) of Chris@1808: "" => "/>" Chris@1808: | s => ">" ^ s ^ "") Chris@1808: Chris@1808: fun serialise (DOCUMENT { name, children }) = Chris@1808: "\n" ^ Chris@1808: node (ELEMENT { name = name, children = children }) Chris@1808: end Chris@1808: Chris@1808: val parse = Parse.parse Chris@1808: val serialise = Serialise.serialise Chris@1808: Chris@1808: end Chris@1808: Chris@1808: Chris@1808: structure SvnControl :> VCS_CONTROL = struct Chris@1808: Chris@1808: val svn_program = "svn" Chris@1808: Chris@1808: fun svn_command context libname args = Chris@1808: FileBits.command context libname (svn_program :: args) Chris@1808: Chris@1808: fun svn_command_output context libname args = Chris@1808: FileBits.command_output context libname (svn_program :: args) Chris@1808: Chris@1808: fun svn_command_lines context libname args = Chris@1808: case svn_command_output context libname args of Chris@1808: ERROR e => ERROR e Chris@1808: | OK s => OK (String.tokens (fn c => c = #"\n" orelse c = #"\r") s) Chris@1808: Chris@1808: fun split_line_pair line = Chris@1808: let fun strip_leading_ws str = case explode str of Chris@1808: #" "::rest => implode rest Chris@1808: | _ => str Chris@1808: in Chris@1808: case String.tokens (fn c => c = #":") line of Chris@1808: [] => ("", "") Chris@1808: | first::rest => Chris@1808: (first, strip_leading_ws (String.concatWith ":" rest)) Chris@1808: end Chris@1808: Chris@1808: fun is_working context = Chris@1808: case svn_command_output context "" ["--version"] of Chris@1808: OK "" => OK false Chris@1808: | OK _ => OK true Chris@1808: | ERROR e => ERROR e Chris@1808: Chris@1808: structure X = SubXml Chris@1808: Chris@1808: fun svn_info context libname route = Chris@1808: (* SVN 1.9 has info --show-item which is just what we need, Chris@1808: but at this point we still have 1.8 on the CI boxes so we Chris@1808: might as well aim to support it. For that we really have to Chris@1808: use the XML output format, since the default info output is Chris@1808: localised. This is the only thing our mini-XML parser is Chris@1808: used for though, so it would be good to trim it at some Chris@1808: point *) Chris@1808: let fun find elt [] = OK elt Chris@1808: | find { children, ... } (first :: rest) = Chris@1808: case List.find (fn (X.ELEMENT { name, ... }) => name = first Chris@1808: | _ => false) Chris@1808: children of Chris@1808: NONE => ERROR ("No element \"" ^ first ^ "\" in SVN XML") Chris@1808: | SOME (X.ELEMENT e) => find e rest Chris@1808: | SOME _ => ERROR "Internal error" Chris@1808: in Chris@1808: case svn_command_output context libname ["info", "--xml"] of Chris@1808: ERROR e => ERROR e Chris@1808: | OK xml => Chris@1808: case X.parse xml of Chris@1808: X.ERROR e => ERROR e Chris@1808: | X.OK (X.DOCUMENT doc) => find doc route Chris@1808: end Chris@1808: Chris@1808: fun exists context libname = Chris@1808: OK (OS.FileSys.isDir (FileBits.subpath context libname ".svn")) Chris@1808: handle _ => OK false Chris@1808: Chris@1808: fun remote_for context (libname, source) = Chris@1808: Provider.remote_url context SVN source libname Chris@1808: Chris@1808: (* Remote the checkout came from, not necessarily the one we want *) Chris@1808: fun actual_remote_for context libname = Chris@1808: case svn_info context libname ["entry", "url"] of Chris@1808: ERROR e => ERROR e Chris@1808: | OK { children, ... } => Chris@1808: case List.find (fn (X.TEXT _) => true | _ => false) children of Chris@1808: NONE => ERROR "No content for URL in SVN info XML" Chris@1808: | SOME (X.TEXT url) => OK url Chris@1808: | SOME _ => ERROR "Internal error" Chris@1808: Chris@1808: fun id_of context libname = Chris@1808: case svn_info context libname ["entry"] of Chris@1808: ERROR e => ERROR e Chris@1808: | OK { children, ... } => Chris@1808: case List.find Chris@1808: (fn (X.ATTRIBUTE { name = "revision", ... }) => true Chris@1808: | _ => false) Chris@1808: children of Chris@1808: NONE => ERROR "No revision for entry in SVN info XML" Chris@1808: | SOME (X.ATTRIBUTE { value, ... }) => OK value Chris@1808: | SOME _ => ERROR "Internal error" Chris@1808: Chris@1808: fun is_at context (libname, id_or_tag) = Chris@1808: case id_of context libname of Chris@1808: ERROR e => ERROR e Chris@1808: | OK id => OK (id = id_or_tag) Chris@1808: Chris@1808: fun is_on_branch context (libname, b) = Chris@1808: OK (b = DEFAULT_BRANCH) Chris@1808: Chris@1808: fun check_remote context (libname, source) = Chris@1808: case (remote_for context (libname, source), Chris@1808: actual_remote_for context libname) of Chris@1808: (_, ERROR e) => ERROR e Chris@1808: | (url, OK actual) => Chris@1808: if actual = url Chris@1808: then OK () Chris@1808: else svn_command context libname ["relocate", url] Chris@1808: Chris@1808: fun is_newest context (libname, source, branch) = Chris@1808: case check_remote context (libname, source) of Chris@1808: ERROR e => ERROR e Chris@1808: | OK () => Chris@1808: case svn_command_lines context libname Chris@1808: ["status", "--show-updates"] of Chris@1808: ERROR e => ERROR e Chris@1808: | OK lines => Chris@1808: case rev lines of Chris@1808: [] => ERROR "No result returned for server status" Chris@1808: | last_line::_ => Chris@1808: case rev (String.tokens (fn c => c = #" ") last_line) of Chris@1808: [] => ERROR "No revision field found in server status" Chris@1808: | server_id::_ => is_at context (libname, server_id) Chris@1808: Chris@1808: fun is_newest_locally context (libname, branch) = Chris@1808: OK true (* no local history *) Chris@1808: Chris@1808: fun is_modified_locally context libname = Chris@1808: case svn_command_output context libname ["status"] of Chris@1808: ERROR e => ERROR e Chris@1808: | OK "" => OK false Chris@1808: | OK _ => OK true Chris@1808: Chris@1808: fun checkout context (libname, source, branch) = Chris@1808: let val url = remote_for context (libname, source) Chris@1808: val path = FileBits.libpath context libname Chris@1808: in Chris@1808: if FileBits.nonempty_dir_exists path Chris@1808: then (* Surprisingly, SVN itself has no problem with Chris@1808: this. But for consistency with other VCSes we Chris@1808: don't allow it *) Chris@1808: ERROR ("Refusing checkout to nonempty dir \"" ^ path ^ "\"") Chris@1808: else Chris@1808: (* make the lib dir rather than just the ext dir, since Chris@1808: the lib dir might be nested and svn will happily check Chris@1808: out into an existing empty dir anyway *) Chris@1808: case FileBits.mkpath (FileBits.libpath context libname) of Chris@1808: ERROR e => ERROR e Chris@1808: | _ => svn_command context "" ["checkout", url, libname] Chris@1808: end Chris@1808: Chris@1808: fun update context (libname, source, branch) = Chris@1808: case check_remote context (libname, source) of Chris@1808: ERROR e => ERROR e Chris@1808: | OK () => Chris@1808: case svn_command context libname Chris@1808: ["update", "--accept", "postpone"] of Chris@1808: ERROR e => ERROR e Chris@1808: | _ => OK () Chris@1808: Chris@1808: fun update_to context (libname, _, "") = Chris@1808: ERROR "Non-empty id (tag or revision id) required for update_to" Chris@1808: | update_to context (libname, source, id) = Chris@1808: case check_remote context (libname, source) of Chris@1808: ERROR e => ERROR e Chris@1808: | OK () => Chris@1808: case svn_command context libname Chris@1808: ["update", "-r", id, "--accept", "postpone"] of Chris@1808: ERROR e => ERROR e Chris@1808: | OK _ => OK () Chris@1808: Chris@1808: fun copy_url_for context libname = Chris@1808: actual_remote_for context libname Chris@1808: Chris@1808: end Chris@1808: Chris@1808: structure AnyLibControl :> LIB_CONTROL = struct Chris@1808: Chris@1808: structure H = LibControlFn(HgControl) Chris@1808: structure G = LibControlFn(GitControl) Chris@1808: structure S = LibControlFn(SvnControl) Chris@1808: Chris@1808: fun review context (spec as { vcs, ... } : libspec) = Chris@1808: (fn HG => H.review | GIT => G.review | SVN => S.review) vcs context spec Chris@1808: Chris@1808: fun status context (spec as { vcs, ... } : libspec) = Chris@1808: (fn HG => H.status | GIT => G.status | SVN => S.status) vcs context spec Chris@1808: Chris@1808: fun update context (spec as { vcs, ... } : libspec) = Chris@1808: (fn HG => H.update | GIT => G.update | SVN => S.update) vcs context spec Chris@1808: Chris@1808: fun id_of context (spec as { vcs, ... } : libspec) = Chris@1808: (fn HG => H.id_of | GIT => G.id_of | SVN => S.id_of) vcs context spec Chris@1808: Chris@1808: fun is_working context vcs = Chris@1808: (fn HG => H.is_working | GIT => G.is_working | SVN => S.is_working) Chris@1808: vcs context vcs Chris@1808: Chris@1808: end Chris@1808: Chris@1808: Chris@1808: type exclusions = string list Chris@1808: Chris@1808: structure Archive :> sig Chris@1808: Chris@1808: val archive : string * exclusions -> project -> OS.Process.status Chris@1808: Chris@1808: end = struct Chris@1808: Chris@1808: (* The idea of "archive" is to replace hg/git archive, which won't Chris@1808: include files, like the Repoint-introduced external libraries, Chris@1808: that are not under version control with the main repo. Chris@1808: Chris@1808: The process goes like this: Chris@1808: Chris@1808: - Make sure we have a target filename from the user, and take Chris@1808: its basename as our archive directory name Chris@1808: Chris@1808: - Make an "archive root" subdir of the project repo, named Chris@1808: typically .repoint-archive Chris@1808: Chris@1808: - Identify the VCS used for the project repo. Note that any Chris@1808: explicit references to VCS type in this structure are to Chris@1808: the VCS used for the project (something Repoint doesn't Chris@1808: otherwise care about), not for an individual library Chris@1808: Chris@1808: - Synthesise a Repoint project with the archive root as its Chris@1808: root path, "." as its extdir, with one library whose Chris@1808: name is the user-supplied basename and whose explicit Chris@1808: source URL is the original project root; update that Chris@1808: project -- thus cloning the original project to a subdir Chris@1808: of the archive root Chris@1808: Chris@1808: - Synthesise a Repoint project identical to the original one for Chris@1808: this project, but with the newly-cloned copy as its root Chris@1808: path; update that project -- thus checking out clean copies Chris@1808: of the external library dirs Chris@1808: Chris@1808: - Call out to an archive program to archive up the new copy, Chris@1808: running e.g. Chris@1808: tar cvzf project-release.tar.gz \ Chris@1808: --exclude=.hg --exclude=.git project-release Chris@1808: in the archive root dir Chris@1808: Chris@1808: - (We also omit the repoint-project.json file and any trace of Chris@1808: Repoint. It can't properly be run in a directory where the Chris@1808: external project folders already exist but their repo history Chris@1808: does not. End users shouldn't get to see Repoint) Chris@1808: Chris@1808: - Clean up by deleting the new copy Chris@1808: *) Chris@1808: Chris@1808: fun project_vcs_id_and_url dir = Chris@1808: let val context = { Chris@1808: rootpath = dir, Chris@1808: extdir = ".", Chris@1808: providers = [], Chris@1808: accounts = [] Chris@1808: } Chris@1808: val vcs_maybe = Chris@1808: case [HgControl.exists context ".", Chris@1808: GitControl.exists context ".", Chris@1808: SvnControl.exists context "."] of Chris@1808: [OK true, OK false, OK false] => OK HG Chris@1808: | [OK false, OK true, OK false] => OK GIT Chris@1808: | [OK false, OK false, OK true] => OK SVN Chris@1808: | _ => ERROR ("Unable to identify VCS for directory " ^ dir) Chris@1808: in Chris@1808: case vcs_maybe of Chris@1808: ERROR e => ERROR e Chris@1808: | OK vcs => Chris@1808: case (fn HG => HgControl.id_of Chris@1808: | GIT => GitControl.id_of Chris@1808: | SVN => SvnControl.id_of) Chris@1808: vcs context "." of Chris@1808: ERROR e => ERROR ("Unable to find id of project repo: " ^ e) Chris@1808: | OK id => Chris@1808: case (fn HG => HgControl.copy_url_for Chris@1808: | GIT => GitControl.copy_url_for Chris@1808: | SVN => SvnControl.copy_url_for) Chris@1808: vcs context "." of Chris@1808: ERROR e => ERROR ("Unable to find URL of project repo: " Chris@1808: ^ e) Chris@1808: | OK url => OK (vcs, id, url) Chris@1808: end Chris@1808: Chris@1808: fun make_archive_root (context : context) = Chris@1808: let val path = OS.Path.joinDirFile { Chris@1808: dir = #rootpath context, Chris@1808: file = RepointFilenames.archive_dir Chris@1808: } Chris@1808: in Chris@1808: case FileBits.mkpath path of Chris@1808: ERROR e => raise Fail ("Failed to create archive directory \"" Chris@1808: ^ path ^ "\": " ^ e) Chris@1808: | OK () => path Chris@1808: end Chris@1808: Chris@1808: fun archive_path archive_dir target_name = Chris@1808: OS.Path.joinDirFile { Chris@1808: dir = archive_dir, Chris@1808: file = target_name Chris@1808: } Chris@1808: Chris@1808: fun check_nonexistent path = Chris@1808: case SOME (OS.FileSys.fileSize path) handle OS.SysErr _ => NONE of Chris@1808: NONE => () Chris@1808: | _ => raise Fail ("Path " ^ path ^ " exists, not overwriting") Chris@1808: Chris@1808: fun make_archive_copy target_name (vcs, project_id, source_url) Chris@1808: ({ context, ... } : project) = Chris@1808: let val archive_root = make_archive_root context Chris@1808: val synthetic_context = { Chris@1808: rootpath = archive_root, Chris@1808: extdir = ".", Chris@1808: providers = [], Chris@1808: accounts = [] Chris@1808: } Chris@1808: val synthetic_library = { Chris@1808: libname = target_name, Chris@1808: vcs = vcs, Chris@1808: source = URL_SOURCE source_url, Chris@1808: branch = DEFAULT_BRANCH, (* overridden by pinned id below *) Chris@1808: project_pin = PINNED project_id, Chris@1808: lock_pin = PINNED project_id Chris@1808: } Chris@1808: val path = archive_path archive_root target_name Chris@1808: val _ = print ("Cloning original project to " ^ path Chris@1808: ^ " at revision " ^ project_id ^ "...\n"); Chris@1808: val _ = check_nonexistent path Chris@1808: in Chris@1808: case AnyLibControl.update synthetic_context synthetic_library of Chris@1808: ERROR e => ERROR ("Failed to clone original project to " Chris@1808: ^ path ^ ": " ^ e) Chris@1808: | OK _ => OK archive_root Chris@1808: end Chris@1808: Chris@1808: fun update_archive archive_root target_name Chris@1808: (project as { context, ... } : project) = Chris@1808: let val synthetic_context = { Chris@1808: rootpath = archive_path archive_root target_name, Chris@1808: extdir = #extdir context, Chris@1808: providers = #providers context, Chris@1808: accounts = #accounts context Chris@1808: } Chris@1808: in Chris@1808: foldl (fn (lib, acc) => Chris@1808: case acc of Chris@1808: ERROR e => ERROR e Chris@1808: | OK () => AnyLibControl.update synthetic_context lib) Chris@1808: (OK ()) Chris@1808: (#libs project) Chris@1808: end Chris@1808: Chris@1808: datatype packer = TAR Chris@1808: | TAR_GZ Chris@1808: | TAR_BZ2 Chris@1808: | TAR_XZ Chris@1808: (* could add other packers, e.g. zip, if we knew how to Chris@1808: handle the file omissions etc properly in pack_archive *) Chris@1808: Chris@1808: fun packer_and_basename path = Chris@1808: let val extensions = [ (".tar", TAR), Chris@1808: (".tar.gz", TAR_GZ), Chris@1808: (".tar.bz2", TAR_BZ2), Chris@1808: (".tar.xz", TAR_XZ)] Chris@1808: val filename = OS.Path.file path Chris@1808: in Chris@1808: foldl (fn ((ext, packer), acc) => Chris@1808: if String.isSuffix ext filename Chris@1808: then SOME (packer, Chris@1808: String.substring (filename, 0, Chris@1808: String.size filename - Chris@1808: String.size ext)) Chris@1808: else acc) Chris@1808: NONE Chris@1808: extensions Chris@1808: end Chris@1808: Chris@1808: fun pack_archive archive_root target_name target_path packer exclusions = Chris@1808: case FileBits.command { Chris@1808: rootpath = archive_root, Chris@1808: extdir = ".", Chris@1808: providers = [], Chris@1808: accounts = [] Chris@1808: } "" ([ Chris@1808: "tar", Chris@1808: case packer of Chris@1808: TAR => "cf" Chris@1808: | TAR_GZ => "czf" Chris@1808: | TAR_BZ2 => "cjf" Chris@1808: | TAR_XZ => "cJf", Chris@1808: target_path, Chris@1808: "--exclude=.hg", Chris@1808: "--exclude=.git", Chris@1808: "--exclude=.svn", Chris@1808: "--exclude=repoint", Chris@1808: "--exclude=repoint.sml", Chris@1808: "--exclude=repoint.ps1", Chris@1808: "--exclude=repoint.bat", Chris@1808: "--exclude=repoint-project.json", Chris@1808: "--exclude=repoint-lock.json" Chris@1808: ] @ (map (fn e => "--exclude=" ^ e) exclusions) @ Chris@1808: [ target_name ]) Chris@1808: of Chris@1808: ERROR e => ERROR e Chris@1808: | OK _ => FileBits.rmpath (archive_path archive_root target_name) Chris@1808: Chris@1808: fun archive (target_path, exclusions) (project : project) = Chris@1808: let val _ = check_nonexistent target_path Chris@1808: val (packer, name) = Chris@1808: case packer_and_basename target_path of Chris@1808: NONE => raise Fail ("Unsupported archive file extension in " Chris@1808: ^ target_path) Chris@1808: | SOME pn => pn Chris@1808: val details = Chris@1808: case project_vcs_id_and_url (#rootpath (#context project)) of Chris@1808: ERROR e => raise Fail e Chris@1808: | OK details => details Chris@1808: val archive_root = Chris@1808: case make_archive_copy name details project of Chris@1808: ERROR e => raise Fail e Chris@1808: | OK archive_root => archive_root Chris@1808: val outcome = Chris@1808: case update_archive archive_root name project of Chris@1808: ERROR e => ERROR e Chris@1808: | OK _ => Chris@1808: case pack_archive archive_root name Chris@1808: target_path packer exclusions of Chris@1808: ERROR e => ERROR e Chris@1808: | OK _ => OK () Chris@1808: in Chris@1808: case outcome of Chris@1808: ERROR e => raise Fail e Chris@1808: | OK () => OS.Process.success Chris@1808: end Chris@1808: Chris@1808: end Chris@1808: Chris@1808: val libobjname = "libraries" Chris@1808: Chris@1808: fun load_libspec spec_json lock_json libname : libspec = Chris@1808: let open JsonBits Chris@1808: val libobj = lookup_mandatory spec_json [libobjname, libname] Chris@1808: val vcs = lookup_mandatory_string libobj ["vcs"] Chris@1808: val retrieve = lookup_optional_string libobj Chris@1808: val service = retrieve ["service"] Chris@1808: val owner = retrieve ["owner"] Chris@1808: val repo = retrieve ["repository"] Chris@1808: val url = retrieve ["url"] Chris@1808: val branch = retrieve ["branch"] Chris@1808: val project_pin = case retrieve ["pin"] of Chris@1808: NONE => UNPINNED Chris@1808: | SOME p => PINNED p Chris@1808: val lock_pin = case lookup_optional lock_json [libobjname, libname] of Chris@1808: NONE => UNPINNED Chris@1808: | SOME ll => case lookup_optional_string ll ["pin"] of Chris@1808: SOME p => PINNED p Chris@1808: | NONE => UNPINNED Chris@1808: in Chris@1808: { Chris@1808: libname = libname, Chris@1808: vcs = case vcs of Chris@1808: "hg" => HG Chris@1808: | "git" => GIT Chris@1808: | "svn" => SVN Chris@1808: | other => raise Fail ("Unknown version-control system \"" ^ Chris@1808: other ^ "\""), Chris@1808: source = case (url, service, owner, repo) of Chris@1808: (SOME u, NONE, _, _) => URL_SOURCE u Chris@1808: | (NONE, SOME ss, owner, repo) => Chris@1808: SERVICE_SOURCE { service = ss, owner = owner, repo = repo } Chris@1808: | _ => raise Fail ("Must have exactly one of service " ^ Chris@1808: "or url string"), Chris@1808: project_pin = project_pin, Chris@1808: lock_pin = lock_pin, Chris@1808: branch = case branch of Chris@1808: NONE => DEFAULT_BRANCH Chris@1808: | SOME b => Chris@1808: case vcs of Chris@1808: "svn" => raise Fail ("Branches not supported for " ^ Chris@1808: "svn repositories; change " ^ Chris@1808: "URL instead") Chris@1808: | _ => BRANCH b Chris@1808: } Chris@1808: end Chris@1808: Chris@1808: fun load_userconfig () : userconfig = Chris@1808: let val home = FileBits.homedir () Chris@1808: val conf_json = Chris@1808: JsonBits.load_json_from Chris@1808: (OS.Path.joinDirFile { Chris@1808: dir = home, Chris@1808: file = RepointFilenames.user_config_file }) Chris@1808: handle IO.Io _ => Json.OBJECT [] Chris@1808: in Chris@1808: { Chris@1808: accounts = case JsonBits.lookup_optional conf_json ["accounts"] of Chris@1808: NONE => [] Chris@1808: | SOME (Json.OBJECT aa) => Chris@1808: map (fn (k, (Json.STRING v)) => Chris@1808: { service = k, login = v } Chris@1808: | _ => raise Fail Chris@1808: "String expected for account name") Chris@1808: aa Chris@1808: | _ => raise Fail "Array expected for accounts", Chris@1808: providers = Provider.load_providers conf_json Chris@1808: } Chris@1808: end Chris@1808: Chris@1808: datatype pintype = Chris@1808: NO_LOCKFILE | Chris@1808: USE_LOCKFILE Chris@1808: Chris@1808: fun load_project (userconfig : userconfig) rootpath pintype : project = Chris@1808: let val spec_file = FileBits.project_spec_path rootpath Chris@1808: val lock_file = FileBits.project_lock_path rootpath Chris@1808: val _ = if OS.FileSys.access (spec_file, [OS.FileSys.A_READ]) Chris@1808: handle OS.SysErr _ => false Chris@1808: then () Chris@1808: else raise Fail ("Failed to open project spec file " ^ Chris@1808: (RepointFilenames.project_file) ^ " in " ^ Chris@1808: rootpath ^ Chris@1808: ".\nPlease ensure the spec file is in the " ^ Chris@1808: "project root and run this from there.") Chris@1808: val spec_json = JsonBits.load_json_from spec_file Chris@1808: val lock_json = if pintype = USE_LOCKFILE Chris@1808: then JsonBits.load_json_from lock_file Chris@1808: handle IO.Io _ => Json.OBJECT [] Chris@1808: else Json.OBJECT [] Chris@1808: val extdir = JsonBits.lookup_mandatory_string spec_json Chris@1808: ["config", "extdir"] Chris@1808: val spec_libs = JsonBits.lookup_optional spec_json [libobjname] Chris@1808: val lock_libs = JsonBits.lookup_optional lock_json [libobjname] Chris@1808: val providers = Provider.load_more_providers Chris@1808: (#providers userconfig) spec_json Chris@1808: val libnames = case spec_libs of Chris@1808: NONE => [] Chris@1808: | SOME (Json.OBJECT ll) => map (fn (k, v) => k) ll Chris@1808: | _ => raise Fail "Object expected for libs" Chris@1808: in Chris@1808: { Chris@1808: context = { Chris@1808: rootpath = rootpath, Chris@1808: extdir = extdir, Chris@1808: providers = providers, Chris@1808: accounts = #accounts userconfig Chris@1808: }, Chris@1808: libs = map (load_libspec spec_json lock_json) libnames Chris@1808: } Chris@1808: end Chris@1808: Chris@1808: fun save_lock_file rootpath locks = Chris@1808: let val lock_file = FileBits.project_lock_path rootpath Chris@1808: open Json Chris@1808: val lock_json = Chris@1808: OBJECT [ Chris@1808: (libobjname, Chris@1808: OBJECT (map (fn { libname, id_or_tag } => Chris@1808: (libname, Chris@1808: OBJECT [ ("pin", STRING id_or_tag) ])) Chris@1808: locks)) Chris@1808: ] Chris@1808: in Chris@1808: JsonBits.save_json_to lock_file lock_json Chris@1808: end Chris@1865: Chris@1865: fun checkpoint_completion_file rootpath = Chris@1865: let val completion_file = FileBits.project_completion_path rootpath Chris@1865: val stream = TextIO.openOut completion_file Chris@1865: in Chris@1865: TextIO.closeOut stream Chris@1865: end Chris@1865: Chris@1808: fun pad_to n str = Chris@1808: if n <= String.size str then str Chris@1808: else pad_to n (str ^ " ") Chris@1808: Chris@1808: fun hline_to 0 = "" Chris@1808: | hline_to n = "-" ^ hline_to (n-1) Chris@1808: Chris@1808: val libname_width = 28 Chris@1808: val libstate_width = 11 Chris@1808: val localstate_width = 17 Chris@1808: val notes_width = 5 Chris@1808: val divider = " | " Chris@1808: val clear_line = "\r" ^ pad_to 80 ""; Chris@1808: Chris@1808: fun print_status_header () = Chris@1808: print (clear_line ^ "\n " ^ Chris@1808: pad_to libname_width "Library" ^ divider ^ Chris@1808: pad_to libstate_width "State" ^ divider ^ Chris@1808: pad_to localstate_width "Local" ^ divider ^ Chris@1808: "Notes" ^ "\n " ^ Chris@1808: hline_to libname_width ^ "-+-" ^ Chris@1808: hline_to libstate_width ^ "-+-" ^ Chris@1808: hline_to localstate_width ^ "-+-" ^ Chris@1808: hline_to notes_width ^ "\n") Chris@1808: Chris@1808: fun print_outcome_header () = Chris@1808: print (clear_line ^ "\n " ^ Chris@1808: pad_to libname_width "Library" ^ divider ^ Chris@1808: pad_to libstate_width "Outcome" ^ divider ^ Chris@1808: "Notes" ^ "\n " ^ Chris@1808: hline_to libname_width ^ "-+-" ^ Chris@1808: hline_to libstate_width ^ "-+-" ^ Chris@1808: hline_to notes_width ^ "\n") Chris@1808: Chris@1808: fun print_status with_network (lib : libspec, status) = Chris@1808: let val libstate_str = Chris@1808: case status of Chris@1808: OK (ABSENT, _) => "Absent" Chris@1808: | OK (CORRECT, _) => if with_network then "Correct" else "Present" Chris@1808: | OK (SUPERSEDED, _) => "Superseded" Chris@1808: | OK (WRONG, _) => "Wrong" Chris@1808: | ERROR _ => "Error" Chris@1808: val localstate_str = Chris@1808: case status of Chris@1808: OK (_, MODIFIED) => "Modified" Chris@1808: | OK (_, LOCK_MISMATCHED) => "Differs from Lock" Chris@1808: | OK (_, CLEAN) => "Clean" Chris@1808: | ERROR _ => "" Chris@1808: val error_str = Chris@1808: case status of Chris@1808: ERROR e => e Chris@1808: | _ => "" Chris@1808: in Chris@1808: print (" " ^ Chris@1808: pad_to libname_width (#libname lib) ^ divider ^ Chris@1808: pad_to libstate_width libstate_str ^ divider ^ Chris@1808: pad_to localstate_width localstate_str ^ divider ^ Chris@1808: error_str ^ "\n") Chris@1808: end Chris@1808: Chris@1808: fun print_update_outcome (lib : libspec, outcome) = Chris@1808: let val outcome_str = Chris@1808: case outcome of Chris@1808: OK id => "Ok" Chris@1808: | ERROR e => "Failed" Chris@1808: val error_str = Chris@1808: case outcome of Chris@1808: ERROR e => e Chris@1808: | _ => "" Chris@1808: in Chris@1808: print (" " ^ Chris@1808: pad_to libname_width (#libname lib) ^ divider ^ Chris@1808: pad_to libstate_width outcome_str ^ divider ^ Chris@1808: error_str ^ "\n") Chris@1808: end Chris@1808: Chris@1808: fun vcs_name HG = ("Mercurial", "hg") Chris@1808: | vcs_name GIT = ("Git", "git") Chris@1808: | vcs_name SVN = ("Subversion", "svn") Chris@1808: Chris@1808: fun print_problem_summary context lines = Chris@1808: let val failed_vcs = Chris@1808: foldl (fn (({ vcs, ... } : libspec, ERROR _), acc) => vcs::acc Chris@1808: | (_, acc) => acc) [] lines Chris@1808: fun report_nonworking vcs error = Chris@1808: print ((if error = "" then "" else error ^ "\n\n") ^ Chris@1808: "Error: The project uses the " ^ (#1 (vcs_name vcs)) ^ Chris@1808: " version control system, but its\n" ^ Chris@1808: "executable program (" ^ (#2 (vcs_name vcs)) ^ Chris@1808: ") does not appear to be installed in the program path\n\n") Chris@1808: fun check_working [] checked = () Chris@1808: | check_working (vcs::rest) checked = Chris@1808: if List.exists (fn v => vcs = v) checked Chris@1808: then check_working rest checked Chris@1808: else Chris@1808: case AnyLibControl.is_working context vcs of Chris@1808: OK true => check_working rest checked Chris@1808: | OK false => (report_nonworking vcs ""; Chris@1808: check_working rest (vcs::checked)) Chris@1808: | ERROR e => (report_nonworking vcs e; Chris@1808: check_working rest (vcs::checked)) Chris@1808: in Chris@1808: print "\nError: Some operations failed\n\n"; Chris@1808: check_working failed_vcs [] Chris@1808: end Chris@1808: Chris@1808: fun act_and_print action print_header print_line context (libs : libspec list) = Chris@1808: let val lines = map (fn lib => (lib, action lib)) libs Chris@1808: val imperfect = List.exists (fn (_, ERROR _) => true | _ => false) lines Chris@1808: val _ = print_header () Chris@1808: in Chris@1808: app print_line lines; Chris@1808: if imperfect then print_problem_summary context lines else (); Chris@1808: lines Chris@1808: end Chris@1808: Chris@1808: fun return_code_for outcomes = Chris@1808: foldl (fn ((_, result), acc) => Chris@1808: case result of Chris@1808: ERROR _ => OS.Process.failure Chris@1808: | _ => acc) Chris@1808: OS.Process.success Chris@1808: outcomes Chris@1808: Chris@1808: fun status_of_project ({ context, libs } : project) = Chris@1808: return_code_for (act_and_print (AnyLibControl.status context) Chris@1808: print_status_header (print_status false) Chris@1808: context libs) Chris@1808: Chris@1808: fun review_project ({ context, libs } : project) = Chris@1808: return_code_for (act_and_print (AnyLibControl.review context) Chris@1808: print_status_header (print_status true) Chris@1808: context libs) Chris@1808: Chris@1808: fun lock_project ({ context, libs } : project) = Chris@1808: let val _ = if FileBits.verbose () Chris@1808: then print ("Scanning IDs for lock file...\n") Chris@1808: else () Chris@1808: val outcomes = map (fn lib => (lib, AnyLibControl.id_of context lib)) Chris@1808: libs Chris@1808: val locks = Chris@1808: List.concat Chris@1808: (map (fn (lib : libspec, result) => Chris@1808: case result of Chris@1808: ERROR _ => [] Chris@1808: | OK id => [{ libname = #libname lib, Chris@1808: id_or_tag = id }]) Chris@1808: outcomes) Chris@1808: val return_code = return_code_for outcomes Chris@1808: val _ = print clear_line Chris@1808: in Chris@1808: if OS.Process.isSuccess return_code Chris@1808: then save_lock_file (#rootpath context) locks Chris@1808: else (); Chris@1808: return_code Chris@1808: end Chris@1808: Chris@1808: fun update_project (project as { context, libs }) = Chris@1808: let val outcomes = act_and_print Chris@1808: (AnyLibControl.update context) Chris@1808: print_outcome_header print_update_outcome Chris@1808: context libs Chris@1808: val _ = if List.exists (fn (_, OK _) => true | _ => false) outcomes Chris@1808: then lock_project project Chris@1808: else OS.Process.success Chris@1865: val return_code = return_code_for outcomes Chris@1808: in Chris@1865: if OS.Process.isSuccess return_code Chris@1865: then checkpoint_completion_file (#rootpath context) Chris@1865: else (); Chris@1865: return_code Chris@1808: end Chris@1808: Chris@1808: fun load_local_project pintype = Chris@1808: let val userconfig = load_userconfig () Chris@1808: val rootpath = OS.FileSys.getDir () Chris@1808: in Chris@1808: load_project userconfig rootpath pintype Chris@1808: end Chris@1808: Chris@1808: fun with_local_project pintype f = Chris@1808: let open OS.Process Chris@1808: val return_code = Chris@1808: f (load_local_project pintype) Chris@1808: handle Fail msg => Chris@1808: failure before print ("Error: " ^ msg) Chris@1808: | JsonBits.Config msg => Chris@1808: failure before print ("Error in configuration: " ^ msg) Chris@1808: | e => Chris@1808: failure before print ("Error: " ^ exnMessage e) Chris@1808: val _ = print "\n"; Chris@1808: in Chris@1808: return_code Chris@1808: end Chris@1808: Chris@1808: fun review () = with_local_project USE_LOCKFILE review_project Chris@1808: fun status () = with_local_project USE_LOCKFILE status_of_project Chris@1808: fun update () = with_local_project NO_LOCKFILE update_project Chris@1808: fun lock () = with_local_project NO_LOCKFILE lock_project Chris@1808: fun install () = with_local_project USE_LOCKFILE update_project Chris@1808: Chris@1808: fun version () = Chris@1808: (print ("v" ^ repoint_version ^ "\n"); Chris@1808: OS.Process.success) Chris@1808: Chris@1808: fun usage () = Chris@1808: (print "\nRepoint "; Chris@1808: version (); Chris@1823: print ("\n A simple manager for third-party source code dependencies.\n" Chris@1823: ^ " http://all-day-breakfast.com/repoint/\n\n" Chris@1808: ^ "Usage:\n\n" Chris@1865: ^ " repoint []\n\n" Chris@1808: ^ "where is one of:\n\n" Chris@1808: ^ " status print quick report on local status only, without using network\n" Chris@1808: ^ " review check configured libraries against their providers, and report\n" Chris@1808: ^ " install update configured libraries according to project specs and lock file\n" Chris@1808: ^ " update update configured libraries and lock file according to project specs\n" Chris@1823: ^ " lock rewrite lock file to match local library status\n" Chris@1823: ^ " archive pack up project and all libraries into an archive file:\n" Chris@1823: ^ " invoke as 'repoint archive targetfile.tar.gz --exclude unwanted.txt'\n" Chris@1865: ^ " version print the Repoint version number and exit\n\n" Chris@1865: ^ "and may include:\n\n" Chris@1865: ^ " --directory \n" Chris@1865: ^ " change to directory before doing anything; in particular,\n" Chris@1865: ^ " expect to find project spec file in that directory\n\n"); Chris@1808: OS.Process.failure) Chris@1808: Chris@1808: fun archive target args = Chris@1808: case args of Chris@1808: [] => Chris@1808: with_local_project USE_LOCKFILE (Archive.archive (target, [])) Chris@1808: | "--exclude"::xs => Chris@1808: with_local_project USE_LOCKFILE (Archive.archive (target, xs)) Chris@1808: | _ => usage () Chris@1808: Chris@1865: fun handleSystemArgs args = Chris@1865: let fun handleSystemArgs' leftover args = Chris@1865: case args of Chris@1865: "--directory"::dir::rest => Chris@1865: (OS.FileSys.chDir dir; Chris@1865: handleSystemArgs' leftover rest) Chris@1865: | arg::rest => Chris@1865: handleSystemArgs' (leftover @ [arg]) rest Chris@1865: | [] => leftover Chris@1865: in Chris@1865: OK (handleSystemArgs' [] args) Chris@1865: handle e => ERROR (exnMessage e) Chris@1865: end Chris@1865: Chris@1808: fun repoint args = Chris@1865: case handleSystemArgs args of Chris@1865: ERROR e => (print ("Error: " ^ e ^ "\n"); Chris@1865: OS.Process.exit OS.Process.failure) Chris@1865: | OK args => Chris@1865: let val return_code = Chris@1808: case args of Chris@1808: ["review"] => review () Chris@1808: | ["status"] => status () Chris@1808: | ["install"] => install () Chris@1808: | ["update"] => update () Chris@1808: | ["lock"] => lock () Chris@1808: | ["version"] => version () Chris@1808: | "archive"::target::args => archive target args Chris@1808: | arg::_ => (print ("Error: unknown argument \"" ^ arg ^ "\"\n"); Chris@1808: usage ()) Chris@1808: | _ => usage () Chris@1865: in Chris@1865: OS.Process.exit return_code Chris@1865: end Chris@1808: Chris@1808: fun main () = Chris@1808: repoint (CommandLine.arguments ())