├── comic.gif ├── _tags ├── .gitignore ├── Changes.md ├── readline.ml ├── repl.ml ├── lein.ml ├── grench.ml ├── README.md ├── client.ml ├── nrepl.ml ├── bencode.ml └── COPYING /comic.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Leonidas-from-XIV/grenchman/master/comic.gif -------------------------------------------------------------------------------- /_tags: -------------------------------------------------------------------------------- 1 | true:package(core),package(async),package(ctypes.foreign),thread,annot,debugging -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | _build 2 | *.byte 3 | /.lein-repl-history 4 | /grench.native 5 | /grench 6 | /web 7 | /downloads -------------------------------------------------------------------------------- /Changes.md: -------------------------------------------------------------------------------- 1 | # History of user-visible changes in Grenchman 2 | 3 | ## 0.2.0 / 06-10-2013 4 | 5 | * Read forms from stdin when no args are given. 6 | * Exit with 111 to indicate connection failure. 7 | * Use `libreadline` for all console input. 8 | * Implement `repl` as independent client instead of deferring to Leiningen's. 9 | * Add `eval` and `main` subcommands which don't involve Leiningen. 10 | * Move Leiningen task invocation to `lein` subcommand. 11 | 12 | ## 0.1.0 / 29-08-2013 13 | 14 | * Initial release! 15 | -------------------------------------------------------------------------------- /readline.ml: -------------------------------------------------------------------------------- 1 | open Ctypes 2 | open Foreign 3 | 4 | let readline = foreign "readline" (string @-> returning (ptr_opt char)) 5 | 6 | let add_history = foreign "add_history" (string @-> returning void) 7 | 8 | let read prompt = 9 | let rec strlen p n = 10 | match !@(p +@ n) with 11 | | '\000' -> n 12 | | _ -> strlen p (n + 1) in 13 | 14 | (* Ctypes needs help for some reason to convert char ptr to string *) 15 | let string_of_char_ptr charp = 16 | let length = strlen charp 0 in 17 | let s = String.create length in 18 | for i = 0 to length - 1 do 19 | s.[i] <- !@ (charp +@ i) 20 | done; 21 | s in 22 | 23 | match readline prompt with 24 | | Some s -> let input = string_of_char_ptr s in 25 | add_history input; Some input 26 | | None -> None 27 | 28 | let _ = (foreign_value "rl_readline_name" string) <-@ "grench" 29 | -------------------------------------------------------------------------------- /repl.ml: -------------------------------------------------------------------------------- 1 | open Core.Std 2 | open Async.Std 3 | 4 | let repl_message input session = 5 | ([("session", session); 6 | ("op", "eval"); 7 | ("id", "repl-" ^ (Uuid.to_string (Uuid.create ()))); 8 | ("ns", ! Client.ns); 9 | ("code", sprintf "(try %s (catch Exception e 10 | (clojure.stacktrace/print-cause-trace e)))" input)], 11 | Nrepl.print_all) 12 | 13 | let dummy_message session = 14 | ([("session", session); 15 | ("op", "eval"); 16 | ("id", "repl-dummy"); 17 | ("ns", "user"); 18 | ("code", "nil")], 19 | Nrepl.default_actions) 20 | 21 | let repl_done = function 22 | | Some Bencode.String(id) -> (String.sub id 0 5) = "repl-" 23 | | Some _ | None -> false 24 | 25 | let rec loop (r,w,p) resp = 26 | let prompt = (!Client.ns ^ "=> ") in 27 | if repl_done (List.Assoc.find resp "id") then 28 | match Readline.read prompt, List.Assoc.find resp "session" with 29 | | Some input, Some Bencode.String(session) -> 30 | Nrepl.send w p (repl_message input session) 31 | | Some _, _ -> Printf.eprintf "Missing session.\n"; Pervasives.exit 1 32 | | None, _ -> Pervasives.exit 0 33 | 34 | let main port = 35 | let handler = Client.handler loop in 36 | let _ = Nrepl.new_session "127.0.0.1" port [dummy_message] handler in 37 | never_returns (Scheduler.go ()) 38 | -------------------------------------------------------------------------------- /lein.ml: -------------------------------------------------------------------------------- 1 | open Core.Std 2 | open Printf 3 | 4 | (* Invoking Leiningen tasks. *) 5 | 6 | let port_err = 7 | "Couldn't read port from ~/.lein/repl-port or $LEIN_REPL_PORT.\n 8 | If Leiningen is not running, launch `lein repl :headless' from outside a 9 | project directory and try again.\n" 10 | 11 | let repl_port () = 12 | let filename = String.concat 13 | ~sep:Filename.dir_sep [(Sys.getenv_exn "HOME"); 14 | ".lein"; "repl-port"] in 15 | match Sys.getenv "LEIN_REPL_PORT" with 16 | | Some port -> int_of_string port 17 | | None -> match Sys.file_exists filename with 18 | | `Yes -> int_of_string (In_channel.read_all filename) 19 | | `No | `Unknown -> eprintf "%s%!" port_err; exit 111 20 | 21 | let form = sprintf "(binding [*cwd* \"%s\", *exit-process?* false] 22 | (System/setProperty \"leiningen.original.pwd\" \"%s\") 23 | 24 | (defmethod leiningen.core.eval/eval-in :default 25 | [project form] 26 | (leiningen.core.eval/eval-in 27 | (assoc project :eval-in :nrepl) form)) 28 | 29 | (defmethod leiningen.core.eval/eval-in :trampoline 30 | [& _] (throw (Exception. \"trampoline disabled\"))) 31 | 32 | (try (-main \"%s\") 33 | (catch clojure.lang.ExceptionInfo e 34 | (let [c (:exit-code (ex-data e))] 35 | (when-not (and (number? c) (zero? c)) 36 | (throw e))))))" 37 | 38 | let main_message args session = 39 | let cwd = Sys.getcwd () in 40 | let root = Client.find_root cwd cwd in 41 | let form = form root cwd (Client.splice_args args) in 42 | ([("session", session); 43 | ("op", "eval"); 44 | ("id", "main"); 45 | ("ns", "leiningen.core.main"); 46 | ("code", form)], 47 | Nrepl.exit_actions) 48 | 49 | let main args = 50 | let port = repl_port () in 51 | Client.eval port [main_message args] Client.handle_done 52 | -------------------------------------------------------------------------------- /grench.ml: -------------------------------------------------------------------------------- 1 | open Core.Std 2 | open Printf 3 | 4 | (* Entry point module; handles command-line args and dispatching. *) 5 | 6 | let help = "Grenchman runs Clojure code quickly. 7 | 8 | Commands: 9 | 10 | eval FORM Evals given form. 11 | main NAMESPACE[/FUNCTION] [ARGS...] Runs existing defn. 12 | repl [:connect PORT] Connects a repl. 13 | lein [TASK ARGS...] Runs a Leiningen task. 14 | 15 | Running with no arguments will read code from stdin. 16 | 17 | When running from a Leiningen project directory, the port can usually be 18 | inferred. Otherwise set the GRENCH_PORT environment variable. 19 | " 20 | 21 | let port_err = "Couldn't read port from .nrepl-port or $GRENCH_PORT.\n" 22 | 23 | let repl_port port_file err_string = 24 | let cwd = Sys.getcwd () in 25 | let root = Client.find_root cwd cwd in 26 | let filename = String.concat ~sep:Filename.dir_sep [root; port_file] in 27 | match Sys.getenv "GRENCH_PORT" with 28 | | Some port -> int_of_string port 29 | | None -> match Sys.file_exists filename with 30 | | `Yes -> int_of_string (In_channel.read_all filename) 31 | | `No | `Unknown -> eprintf "%s%!" err_string; exit 111 32 | 33 | let () = 34 | if ! Sys.interactive then () else 35 | match Sys.argv |> Array.to_list |> List.tl with 36 | | Some ["--help"] | Some ["-h"] | Some ["-?"] | Some ["help"] -> 37 | printf "%s\n%!" help 38 | | Some ["--version"] | Some ["-v"] | Some ["version"] -> 39 | printf "Grenchman 0.2.0\n%!" 40 | 41 | | Some ("eval" :: args) -> 42 | Client.main (repl_port ".nrepl-port" port_err) 43 | ("clojure.main/main" :: "-e" :: args) 44 | 45 | | Some ("main" :: args) -> 46 | Client.main (repl_port ".nrepl-port" port_err) args 47 | 48 | | Some ["repl"] -> 49 | Repl.main (repl_port ".nrepl-port" port_err) 50 | | Some ["repl"; ":connect"; port] -> 51 | Repl.main (int_of_string port) 52 | 53 | | Some ("lein" :: args) -> 54 | Lein.main args 55 | 56 | | None | Some [] -> 57 | Client.stdin_eval (repl_port ".nrepl-port" (port_err ^ "\n" ^ help)) 58 | 59 | | Some _ -> eprintf "Unknown command.\n\n%s" help; exit 1 60 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Grenchman 2 | 3 | Fast invocation of Clojure code over nREPL. 4 | 5 | 6 | 7 | 8 | To install, download the appropriate binary from 9 | http://leiningen.org/grench.html and place it on your path. If 10 | downloads for your platform are not provided you can compile your own; 11 | see "Building" below. 12 | 13 | ## Usage 14 | 15 | Grenchman has four main commands: 16 | 17 | * `grench eval "(+ 12 49)"` - evals given form 18 | * `grench main my.main.ns/entry-point arg1 arg2` - runs existing defn 19 | * `grench repl` or `grench repl :connect $PORT` - connects a repl 20 | * `grench lein test` - runs a Leiningen task 21 | 22 | Running with no arguments will read code from stdin to accomodate shebangs. 23 | 24 | The first three commands connects to a running nREPL project server in 25 | order to avoid JVM startup time. The simplest way to start a project 26 | nREPL server is to run `lein trampoline repl :headless` from the 27 | project directory in another shell. All non-lein `grench` invocations 28 | from inside the project directory will use that nREPL, but by setting 29 | the `GRENCH_PORT` environment variable you can connect to it from 30 | outside. 31 | 32 | ### Leiningen 33 | 34 | The `grench lein` subcommand is the exception to this; it connects to 35 | a Leiningen nREPL server rather than a project nREPL. It looks for the 36 | port in `~/.lein/repl-port` or `$LEIN_REPL_PORT`; you can launch this 37 | server using `lein repl :headless` from outside a project directory. 38 | 39 | Using Grenchman avoids waiting for Leiningen's JVM to start, but 40 | project JVMs are still launched like normal when necessary if 41 | Leiningen can't find a running project nREPL server. Note that this 42 | goes through Leiningen by looking for `.nrepl-port` and doesn't check 43 | `$GRENCH_PORT`. 44 | 45 | Currently the Leiningen integration requires Leiningen 2.3.3 or newer. 46 | If you get no output from `grench lein ...` but your Leiningen process 47 | emits an `java.io.FileNotFoundException: project.clj` error message, 48 | upgrading Leiningen should fix it. 49 | 50 | ## Building 51 | 52 | Building grenchman typically requires compiling the whole OCaml 53 | toolchain (two compilers, two standard libraries, a package manager, 54 | and a handful of other third-party libraries) from scratch and can 55 | take up to an hour. Please use the 56 | [precompiled binaries](http://leiningen.org/grench.html#download) if 57 | possible. 58 | 59 | You will need to 60 | [install opam](http://opam.ocaml.org/doc/Install.html) and 61 | OCaml 4.x to be able to build Grenchman. You'll also need `libffi` as 62 | well as `libreadline-dev` (sometimes called `readline-devel` on RPM 63 | systems). 64 | 65 | If you're not sure whether you have 4.x installed or not, you can check with: 66 | 67 | $ opam switch list 68 | # If your system compiler is 4.x or above, you're ready to go. 69 | # Otherwise, issue the following command: 70 | $ opam switch 4.01.0 71 | # Don't forget to add ~/.opam/4.01.0/bin/ to your $PATH 72 | 73 | To build, run the following commands: 74 | 75 | $ git clone git@github.com:technomancy/grenchman.git grenchman 76 | $ cd grenchman 77 | $ opam install ocamlfind core async ctypes ctypes-foreign 78 | $ ocamlbuild -use-ocamlfind -lflags -cclib,-lreadline grench.native 79 | $ ln -s $PWD/grench.native ~/bin/grench # or somewhere on your $PATH 80 | 81 | ## Gotchas 82 | 83 | By default Leiningen uses compilation settings which trade long-term 84 | performance for boot speed. With Grenchman you have long-running nREPL 85 | processes which start rarely, so you should disable this by putting 86 | `:jvm-opts []` in your `:user` profile. 87 | 88 | Tasks for all projects will share the same Leiningen instance, so 89 | projects with have conflicting plugins or hooks may behave unpredictably. 90 | 91 | If Grenchman cannot connect on the port specified, it will terminate 92 | with an exit code of 111, which may be useful for scripting it. 93 | 94 | ## License 95 | 96 | Copyright © 2013 Phil Hagelberg and 97 | [contributors](https://github.com/technomancy/grenchman/contributors). Bencode 98 | implementation by Prashanth Mundkur. Licensed under the GNU General 99 | Public License, version 3 or later. See COPYING for details. 100 | -------------------------------------------------------------------------------- /client.ml: -------------------------------------------------------------------------------- 1 | open Async.Std 2 | open Core.Std 3 | open Printf 4 | 5 | let exit = Pervasives.exit 6 | 7 | let ns = ref "user" 8 | 9 | let eval_message code ns session = 10 | ([("session", session); 11 | ("op", "eval"); 12 | ("id", "eval-" ^ (Uuid.to_string (Uuid.create ()))); 13 | ("ns", ns); 14 | ("code", code ^ "\n")], 15 | Nrepl.default_actions) 16 | 17 | let stdin_message input session = 18 | let uuid = Uuid.to_string (Uuid.create ()) in 19 | ([("op", "stdin"); 20 | ("id", uuid); 21 | ("stdin", input ^ "\n"); 22 | ("session", session)], 23 | Nrepl.default_actions) 24 | 25 | let stacktrace_message = 26 | eval_message "(clojure.stacktrace/print-cause-trace *e)" "user" 27 | 28 | let print_stacktrace w p resp = 29 | match List.Assoc.find resp "session" with 30 | | Some Bencode.String(session) -> 31 | Nrepl.send w p (stacktrace_message session) 32 | | Some _ | None -> eprintf " eval-error with no session." 33 | 34 | let send_input resp (r,w,p) result = 35 | match List.Assoc.find resp "session" with 36 | | Some Bencode.String(session) -> (match result with 37 | | Some input -> Nrepl.send w p (stdin_message input session) 38 | (* TODO: only exit on EOF in a top-level input request *) 39 | | None -> Nrepl.debug "Eof seen"; exit 0) 40 | | None | Some _ -> eprintf " No session in need-input." 41 | 42 | let remove_pending pending id = 43 | Nrepl.debug ("-p " ^ String.concat ~sep:" " (Hashtbl.keys pending)); 44 | match id with 45 | | Some Bencode.String(id) -> if Hashtbl.mem pending id then 46 | Hashtbl.remove pending id 47 | | None | Some _ -> eprintf " Unknown message id.\n%!" 48 | 49 | let handle_done (r,w,p) _ = 50 | if Hashtbl.keys p = ["init"] then exit 0 51 | 52 | let rec handler handle_done (r,w,p) raw resp = 53 | let handle actions k v = match (k, v) with 54 | | ("out", out) -> actions.Nrepl.out out 55 | | ("err", out) -> actions.Nrepl.err out 56 | | ("ex", out) | ("root-ex", out) -> actions.Nrepl.ex out 57 | | ("value", value) -> actions.Nrepl.value value 58 | | ("ns", new_ns) -> ns := new_ns 59 | | ("session", _) | ("id", _) -> () 60 | | (k, v) -> printf " Unknown response: %s %s\n%!" k v in 61 | 62 | let resp_actions resp = 63 | let lookup_actions id = match Hashtbl.find p id with 64 | | Some actions -> actions 65 | | None -> Nrepl.default_actions in 66 | match List.Assoc.find resp "id" with 67 | | Some Bencode.String id -> lookup_actions id 68 | | Some _ -> eprintf " Unknown id type\n%!"; 69 | Nrepl.default_actions 70 | | None -> Nrepl.default_actions in 71 | 72 | let handle_status resp status = 73 | match status with 74 | | Bencode.String "done" -> 75 | remove_pending p (List.Assoc.find resp "id"); 76 | handle_done (r,w,p) resp 77 | | Bencode.String "eval-error" -> 78 | print_stacktrace w p resp 79 | | Bencode.String "unknown-session" -> 80 | eprintf "Unknown session.\n" 81 | | Bencode.String "need-input" -> 82 | ignore (send_input resp (r,w,p) (Readline.read "")); () 83 | | Bencode.String "interrupted" -> print_newline () 84 | | x -> printf " Unknown status: %s\n%!" (Bencode.marshal x) in 85 | 86 | let handle_clause resp clause = 87 | match clause with 88 | | k, Bencode.String v -> handle (resp_actions resp) k v 89 | | "status", Bencode.List(status) -> List.iter status (handle_status resp) 90 | | k, v -> 91 | eprintf " Unknown %s response: %s %s\n%!" (Bencode.string_of_type v) k raw in 92 | 93 | List.iter resp (handle_clause resp) 94 | 95 | let eval port messages handle_done = 96 | let handler = handler handle_done in 97 | let _ = Nrepl.new_session "127.0.0.1" port messages handler in 98 | never_returns (Scheduler.go ()) 99 | 100 | (* invoking main functions *) 101 | 102 | let rec find_root cwd original = 103 | match Sys.file_exists (String.concat ~sep:Filename.dir_sep 104 | [cwd; "project.clj"]) with 105 | | `Yes -> cwd 106 | | `No | `Unknown -> if (Filename.dirname cwd) = cwd then 107 | original 108 | else 109 | find_root (Filename.dirname cwd) original 110 | 111 | let splice_args args = 112 | String.concat ~sep:"\" \"" (List.map args String.escaped) 113 | 114 | let main_form = 115 | sprintf "(do 116 | (require '[clojure.stacktrace :refer [print-cause-trace]]) 117 | (let [raw (symbol \"%s\") 118 | ns (symbol (or (namespace raw) raw)) 119 | m-sym (if (namespace raw) (symbol (name raw)) '-main)] 120 | (require ns) 121 | (try ((ns-resolve ns m-sym) \"%s\") 122 | (catch Exception e 123 | (let [c (:exit-code (ex-data e))] 124 | (when-not (and (number? c) (zero? c)) 125 | (print-cause-trace e)))))))" 126 | 127 | let main port args = 128 | match args with 129 | | [] -> eprintf "Missing ns argument."; exit 1 130 | | ns :: args -> let form = main_form ns (splice_args args) in 131 | let messages = [eval_message form "user"] in 132 | eval port messages handle_done 133 | 134 | let stdin_eval port = 135 | let input = In_channel.input_lines stdin |> String.concat ~sep:"\n" in 136 | main port ["clojure.main/main"; "-e"; input] 137 | -------------------------------------------------------------------------------- /nrepl.ml: -------------------------------------------------------------------------------- 1 | open Async.Std 2 | open Core.Std 3 | 4 | type msg_actions = 5 | { out : string -> unit; 6 | err : string -> unit; 7 | ex : string -> unit; 8 | value : string -> unit; 9 | } 10 | 11 | let do_nothing _ = () 12 | 13 | let default_actions = 14 | { out = Printf.printf "%s%!"; 15 | err = Printf.eprintf "%s%!"; 16 | value = do_nothing; 17 | ex = do_nothing; 18 | } 19 | 20 | let quiet_actions = 21 | { default_actions with out = do_nothing; } 22 | 23 | let exit_actions = 24 | { default_actions with ex = fun e -> Pervasives.exit 1 } 25 | 26 | let print_all = 27 | { default_actions with value = Printf.printf "%s\n%!"; } 28 | 29 | let buffer_size = (1024 * 16) 30 | 31 | let debug out = 32 | match Sys.getenv "DEBUG" with 33 | | Some _ -> Printf.printf "%s\n%!" out 34 | | None -> () 35 | 36 | let rec convert_message message converted = 37 | match message with 38 | | (k, v) :: tl -> convert_message tl ((k, Bencode.String(v)) :: converted) 39 | | [] -> converted 40 | 41 | let current_msg_id = ref "" 42 | 43 | let send w pending (message,actions) = 44 | let converted = Bencode.Dict(convert_message message []) in 45 | let out = Bencode.marshal converted in 46 | debug ("-> " ^ out); 47 | Writer.write w out; 48 | match List.Assoc.find message "id" with 49 | | Some id -> 50 | Hashtbl.replace pending ~key:id ~data:actions; 51 | current_msg_id := id 52 | | None -> Printf.eprintf " Sending message without id!\n%!" 53 | 54 | let rec loop (r,w,p) handler buffer partial = 55 | let parse_single contents = 56 | try let parsed = Bencode.parse contents in 57 | let bytes_parsed = String.length (Bencode.marshal parsed) in 58 | let total_bytes = String.length contents in 59 | let leftover_length = total_bytes - bytes_parsed in 60 | let leftover = String.sub contents bytes_parsed leftover_length in 61 | (Some parsed, leftover) 62 | with 63 | | _ -> (None, contents) in 64 | 65 | let rec handle_responses handler contents = 66 | match parse_single contents with 67 | | Some Bencode.Dict parsed, leftover -> handler (r,w,p) contents parsed; 68 | debug ("<- " ^ (Bencode.marshal (Bencode.Dict parsed))); 69 | handle_responses handler leftover 70 | | Some parsed, leftover -> Printf.printf "Unexpected %s: %s | %s \n%!" 71 | (Bencode.string_of_type parsed) (Bencode.marshal parsed) leftover; 72 | handle_responses handler leftover 73 | | None, leftover -> leftover in 74 | 75 | let parse_response handler buffer partial resp = 76 | match resp with 77 | | `Eof -> Pervasives.exit 0 78 | | `Ok bytes_read -> let just_read = String.sub buffer 0 bytes_read in 79 | let partial = 80 | handle_responses handler (partial ^ just_read) in 81 | loop (r,w,p) handler buffer partial in 82 | 83 | Reader.read r buffer >>= parse_response handler buffer partial 84 | 85 | let get_session buffer resp = 86 | let no_session () = Printf.eprintf "No session!"; Pervasives.exit 0 in 87 | match resp with 88 | | `Eof -> no_session () 89 | | `Ok bytes_read -> match Bencode.parse (String.sub buffer 0 bytes_read) with 90 | | Bencode.Int _ | Bencode.String _ | Bencode.List _ -> no_session () 91 | | Bencode.Dict(d) -> match List.Assoc.find d "new-session" with 92 | | Some Bencode.String(session) -> session 93 | | Some _ | None -> no_session () 94 | 95 | let interrupt_message session id = 96 | ([("session", session); 97 | ("op", "interrupt"); 98 | ("id", "interrupt-" ^ (Uuid.to_string (Uuid.create ()))); 99 | ("interrupt-id", id)], 100 | quiet_actions) 101 | 102 | let interrupt session w p _ = 103 | match Hashtbl.keys p with 104 | | ["init"] | [] -> Pervasives.exit 0 105 | | _ -> send w p (interrupt_message session !current_msg_id) 106 | 107 | let register_interrupt session w p = 108 | Caml.Sys.signal Caml.Sys.sigint (Caml.Sys.Signal_handle (interrupt session w p)) 109 | 110 | let rec send_messages (w,p) messages session = 111 | match messages with 112 | | message :: tail -> 113 | message session |> send w p; 114 | send_messages (w,p) tail session 115 | | [] -> () 116 | 117 | let defer_send_messages (w,p) messages session = 118 | let f ivar = Ivar.fill ivar (send_messages (w,p) messages session) in 119 | Deferred.create f 120 | 121 | let initiate_session (s,r,w,p) buffer = 122 | Reader.read r buffer 123 | >>| fun resp -> (s,r,w,p,get_session buffer resp) 124 | 125 | let connect host port messages handler = 126 | let buffer = (String.create buffer_size) in 127 | let pending = String.Table.create () in 128 | Tcp.connect (Tcp.to_host_and_port host port) 129 | >>= (fun (s, r, w) -> 130 | send w pending ([("op", "clone"); ("id", "init")], quiet_actions); 131 | initiate_session (s,r,w,pending) buffer 132 | >>= (fun (_, r, w, p, session) -> 133 | ignore (register_interrupt session w p); 134 | ignore (defer_send_messages (w,p) messages session); 135 | loop (r,w,p) handler buffer "")) 136 | 137 | (* Create a new session *) 138 | let new_session host port messages handler = 139 | try_with (fun () -> connect host port messages handler) 140 | >>| function 141 | | Ok () -> () 142 | | Error _ -> 143 | eprintf "Could not connect on port %i.\n%!" port; 144 | Pervasives.exit 111 145 | -------------------------------------------------------------------------------- /bencode.ml: -------------------------------------------------------------------------------- 1 | (* 2 | * Copyright (C) 2011 Prashanth Mundkur. 3 | * Author Prashanth Mundkur 4 | * 5 | * This program is free software; you can redistribute it and/or 6 | * modify it under the terms of the GNU Lesser General Public License 7 | * as published by the Free Software Foundation, either version 2.1 of 8 | * the License, or (at your option) any later version. 9 | * 10 | * This program is distributed in the hope that it will be useful, 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | * GNU Lesser General Public License for more details. 14 | *) 15 | 16 | type t = 17 | | Int of int64 18 | | String of string 19 | | List of t list 20 | | Dict of (string * t) list 21 | 22 | let string_of_type = function 23 | | Int _ -> "int" 24 | | String _ -> "string" 25 | | List _ -> "list" 26 | | Dict _ -> "dict" 27 | 28 | let is_int = function Int _ -> true | _ -> false 29 | let is_string = function String _ -> true | _ -> false 30 | let is_list = function List _ -> true | _ -> false 31 | let is_dict = function Dict _ -> true | _ -> false 32 | 33 | let is_scalar v = is_int v || is_string v 34 | 35 | let to_int = 36 | function Int v -> v | _ -> raise (Invalid_argument "bad argument type") 37 | let to_string = 38 | function String v -> v | _ -> raise (Invalid_argument "bad argument type") 39 | let to_list = 40 | function List v -> v | _ -> raise (Invalid_argument "bad argument type") 41 | let to_dict = 42 | function Dict v -> v | _ -> raise (Invalid_argument "bad argument type") 43 | 44 | let marshal_string s = 45 | (string_of_int (String.length s)) ^ ":" ^ s 46 | 47 | let rec marshal_helper f = function 48 | | Int i -> 49 | f ("i" ^ Int64.to_string i ^ "e") 50 | | String s -> 51 | f (marshal_string s) 52 | | List l -> 53 | f "l"; 54 | List.iter (marshal_helper f) l; 55 | f "e" 56 | | Dict d -> 57 | f "d"; 58 | List.iter (fun (k,v) -> 59 | f (marshal_string k); 60 | marshal_helper f v 61 | ) d; 62 | f "e" 63 | 64 | let marshal t = 65 | let buf = Buffer.create 2048 in 66 | marshal_helper (fun s -> Buffer.add_string buf s) t; 67 | Buffer.contents buf 68 | 69 | type error = 70 | | Unexpected_char of int * char * (* bencode type *) string option 71 | | Expected_char of int * char * (* bencode type *) string 72 | | Unterminated_value of int * string 73 | | Invalid_value of int * string 74 | | Empty_string of int 75 | | Invalid_key_type of int * (* bencode type *) string 76 | | Invalid_string_length of int * string 77 | 78 | exception Parse_error of error 79 | 80 | let string_of_error = function 81 | | Unexpected_char (i, c, None) -> 82 | Printf.sprintf "Unexpected char %c at offset %d" c i 83 | | Unexpected_char (i, c, Some s) -> 84 | Printf.sprintf "Unexpected char %c at offset %d in %s" c i s 85 | | Expected_char (i, c, s) -> 86 | Printf.sprintf "Expected char %c not present at offset %d in %s" c i s 87 | | Unterminated_value (i, s) -> 88 | Printf.sprintf "Unterminated %s value at offset %d" s i 89 | | Invalid_value (i, s) -> 90 | Printf.sprintf "Invalid %s value at offset %d" s i 91 | | Empty_string i -> 92 | Printf.sprintf "Unexpected end of input at offset %d" i 93 | | Invalid_key_type (i, s) -> 94 | Printf.sprintf "Invalid non-string (%s) key at offset %d" s i 95 | | Invalid_string_length (i, s) -> 96 | Printf.sprintf "Invalid length '%s' at offset %d" s i 97 | 98 | let int_substring s start skip = 99 | let start_ofs = start + skip in 100 | match (try Some (String.index_from s start_ofs 'e') with _ -> None) with 101 | | None -> 102 | raise (Parse_error (Unterminated_value (start, "int"))) 103 | | Some ofs -> 104 | if ofs <= start_ofs then 105 | raise (Parse_error (Unexpected_char (start_ofs, 'e', Some "int"))) 106 | else 107 | String.sub s start_ofs (ofs - start_ofs) 108 | 109 | let string_substring s start len = 110 | let slen, ofs = 111 | match (try Some (String.index_from s start ':') with _ -> None) with 112 | | None -> 113 | raise (Parse_error (Expected_char (start, ':', "string"))) 114 | | Some ofs -> 115 | if ofs = start then 116 | raise (Parse_error (Unexpected_char (start, 'e', Some "int"))) 117 | else 118 | let slen = String.sub s start (ofs - start) in 119 | (try 120 | int_of_string slen 121 | with _ -> 122 | raise (Parse_error ((Invalid_string_length (start, slen))))), 123 | ofs + 1 in 124 | let end_ofs = ofs + slen in 125 | if end_ofs > start + len 126 | then raise (Parse_error (Unterminated_value (start, "string"))) 127 | else String.sub s ofs slen, end_ofs - start 128 | 129 | let rec lfolder s start len acc = 130 | match s.[start] with 131 | | 'e' -> 132 | List.rev acc, start + 1 133 | | _ -> 134 | let e, consumed = parse_substring s start len in 135 | lfolder s (start + consumed) (len - consumed) (e :: acc) 136 | and list_fold s start len = 137 | let list, next_start = lfolder s start len [] in 138 | list, next_start - start 139 | 140 | and dfolder s start len acc = 141 | match s.[start] with 142 | | 'e' -> 143 | List.rev acc, start + 1 144 | | _ -> 145 | let k, kc = parse_substring s start len in 146 | let v, vc = parse_substring s (start + kc) (len - kc) in 147 | let c = kc + vc in 148 | if is_string k 149 | then dfolder s (start + c) (len - c) ((to_string k, v) :: acc) 150 | else raise (Parse_error (Invalid_key_type (start, string_of_type k))) 151 | and dict_fold s start len = 152 | let dict, next_start = dfolder s start len [] in 153 | dict, next_start - start 154 | 155 | and parse_substring s start len = 156 | if len == 0 then raise (Parse_error (Empty_string start)) 157 | else match s.[start] with 158 | | 'i' -> 159 | let v = int_substring s start 1 in 160 | (try Int (Int64.of_string v), 2 + (String.length v) 161 | with _ -> raise (Parse_error (Invalid_value (start, "int")))) 162 | | '0' .. '9' -> 163 | let v, consumed = string_substring s start len in 164 | String v, consumed 165 | | 'l' -> 166 | let l, consumed = list_fold s (start + 1) (len - 1) in 167 | List l, consumed + 1 168 | | 'd' -> 169 | let d, consumed = dict_fold s (start + 1) (len - 1) in 170 | Dict d, consumed + 1 171 | | c -> 172 | raise (Parse_error (Unexpected_char (start, c, None))) 173 | 174 | let parse s = fst (parse_substring s 0 (String.length s)) 175 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------