├── .gitignore ├── src ├── lib.rs ├── message.rs ├── client.rs └── bin │ └── minecraft-cli.rs ├── Cargo.toml ├── tests └── integration_test.rs ├── .github └── workflows │ └── build.yaml ├── README.md ├── Cargo.lock └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | /target 2 | -------------------------------------------------------------------------------- /src/lib.rs: -------------------------------------------------------------------------------- 1 | pub mod client; 2 | pub use client::Client; 3 | pub mod message; 4 | pub use message::Message; -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "minecraft-client-rs" 3 | version = "0.1.3" 4 | authors = ["Will Roberts"] 5 | edition = "2018" 6 | description = "A client for the Minecraft RCON protocol." 7 | license = "GPL-3.0-or-later" 8 | 9 | [features] 10 | cli = ["dep:clap", "dep:regex"] 11 | 12 | [dependencies] 13 | clap = { version = "3.2", features = ["derive"], optional = true } 14 | regex = { version = "1.6", optional = true } 15 | -------------------------------------------------------------------------------- /tests/integration_test.rs: -------------------------------------------------------------------------------- 1 | use minecraft_client_rs::Client; 2 | 3 | #[cfg(test)] 4 | mod tests { 5 | use super::*; 6 | 7 | const DEFAULT_HOSTPORT: &str = "127.0.0.1:25575"; 8 | const DEFAULT_PASSWORD: &str = "minecraft"; 9 | 10 | #[test] 11 | fn test_authenticate() { 12 | let mut client = Client::new(DEFAULT_HOSTPORT.to_string()).unwrap(); 13 | match client.authenticate(DEFAULT_PASSWORD.to_string()) { 14 | Ok(_) => { 15 | client.close().unwrap(); 16 | }, 17 | Err(_) => { 18 | client.close().unwrap(); 19 | panic!("failed to authenticate"); 20 | }, 21 | } 22 | } 23 | } -------------------------------------------------------------------------------- /.github/workflows/build.yaml: -------------------------------------------------------------------------------- 1 | name: build 2 | 3 | on: 4 | push: 5 | branches: 6 | - main 7 | pull_request: 8 | 9 | jobs: 10 | build: 11 | runs-on: ubuntu-latest 12 | steps: 13 | - name: install rust 14 | uses: actions-rs/toolchain@v1 15 | with: 16 | toolchain: stable 17 | - name: check out code 18 | uses: actions/checkout@v3 19 | - name: build code 20 | uses: actions-rs/cargo@v1 21 | with: 22 | command: build 23 | args: --release --all-features 24 | - name: test code 25 | uses: actions-rs/cargo@v1 26 | with: 27 | command: test 28 | args: --lib -------------------------------------------------------------------------------- /src/message.rs: -------------------------------------------------------------------------------- 1 | use std::convert::TryInto; 2 | use std::error::Error; 3 | use std::str::from_utf8; 4 | 5 | pub const HEADER_SIZE: i32 = 10; 6 | 7 | #[repr(i32)] 8 | pub enum MessageType { 9 | Response, 10 | _Unused, 11 | Command, 12 | Authenticate, 13 | } 14 | 15 | #[derive(Debug)] 16 | pub struct Message { 17 | pub size: i32, 18 | pub id: i32, 19 | pub msg_type: i32, 20 | pub body: String, 21 | } 22 | 23 | pub fn encode_message(msg: Message) -> Vec { 24 | let mut bytes: Vec = vec!(); 25 | 26 | bytes.extend_from_slice(&msg.size.to_le_bytes()); 27 | bytes.extend_from_slice(&msg.id.to_le_bytes()); 28 | bytes.extend_from_slice(&msg.msg_type.to_le_bytes()); 29 | bytes.extend_from_slice(msg.body.as_bytes()); 30 | bytes.extend_from_slice(&[0, 0]); 31 | 32 | bytes 33 | } 34 | 35 | pub fn decode_message(bytes: Vec) -> Result> { 36 | let size = i32::from_le_bytes(bytes[0..4].try_into()?); 37 | let id = i32::from_le_bytes(bytes[4..8].try_into()?); 38 | let msg_type = i32::from_le_bytes(bytes[8..12].try_into()?); 39 | 40 | let mut body = "".to_string(); 41 | let body_len: usize = (size - HEADER_SIZE).try_into()?; 42 | if body_len > 0 { 43 | let body_bytes = from_utf8(&bytes[12..12+body_len])?; 44 | body = body_bytes.to_string(); 45 | } 46 | 47 | Ok(Message{ 48 | size: size, 49 | id: id, 50 | msg_type: msg_type, 51 | body: body, 52 | }) 53 | } 54 | 55 | #[cfg(test)] 56 | mod tests { 57 | use super::*; 58 | 59 | #[test] 60 | fn test_encode_message() { 61 | let bytes = encode_message(Message{ 62 | size: 5 + HEADER_SIZE, 63 | id: 1, 64 | msg_type: MessageType::Command as i32, 65 | body: "hello".to_string(), 66 | }); 67 | 68 | let expected: Vec = vec!(15, 0, 0, 0, 1, 0, 0, 0, 2, 0, 0, 0, 104, 101, 108, 108, 111, 0, 0); 69 | 70 | assert_eq!(bytes, expected); 71 | } 72 | 73 | #[test] 74 | fn test_decode_message() { 75 | let bytes: Vec = vec!(12, 0, 0, 0, 2, 0, 0, 0, 0, 0, 0, 0, 104, 105); 76 | let msg = decode_message(bytes).unwrap(); 77 | 78 | let expected = Message{ 79 | size: 2 + HEADER_SIZE, 80 | id: 2, 81 | msg_type: MessageType::Response as i32, 82 | body: "hi".to_string(), 83 | }; 84 | 85 | assert_eq!(msg.size, expected.size); 86 | assert_eq!(msg.id, expected.id); 87 | assert_eq!(msg.msg_type, expected.msg_type); 88 | assert_eq!(msg.body, expected.body); 89 | } 90 | } -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # minecraft-client-rs 2 | 3 | [![License Badge]][License] 4 | [![Build Badge]][Build] 5 | [![Crates.io Badge]][Crates.io] 6 | [![docs.rs Badge]][docs.rs] 7 | 8 | A client for the Minecraft RCON protocol. 9 | 10 | ## Library Usage 11 | 12 | ```rust 13 | // Create a new client and connect to the server. 14 | let mut client = Client::new("127.0.0.1:25575".to_string()).unwrap(); 15 | 16 | // Send some commands. 17 | match client.authenticate("password".to_string()) { 18 | Ok(_) => { }, 19 | Err(e) => { /* handle authentication error */ }, 20 | } 21 | match client.send_command("seed".to_string()) { 22 | Ok(resp) => { println!("{}", resp.body); }, // "Seed: [1871644822592853811]" 23 | Err(e) => { /* handle error */ }, 24 | } 25 | 26 | // Disconnect cleanly when finished. 27 | client.close().unwrap(); 28 | ``` 29 | 30 | ## Shell Utility 31 | 32 | If you are looking for a tool rather than a library, try the shell command: 33 | 34 | ```bash 35 | # Single command mode 36 | $ cargo run -F cli -- -h 127.0.0.1:25575 -p minecraft seed 37 | Seed: [5454567064266725003] 38 | 39 | # Interactive mode 40 | $ cargo run -F cli -- -h 127.0.0.1:25575 -p minecraft -i 41 | Starting RCON shell. Use 'exit', 'quit', or Ctrl-C to exit. 42 | > list 43 | There are 0 of a max of 20 players online: 44 | > seed 45 | Seed: [5454567064266725003] 46 | ``` 47 | 48 | ## Limitations 49 | 50 | Response bodies over 4KB will be truncated. 51 | 52 | ## Starting a server for testing 53 | 54 | ``` 55 | $ docker pull itzg/minecraft-server 56 | $ docker run --name=minecraft-server -p 25575:25575 -d -e EULA=TRUE itzg/minecraft-server 57 | ``` 58 | 59 | ## Running Tests 60 | 61 | To run unit tests: 62 | 63 | ``` 64 | $ cargo test --lib 65 | ``` 66 | 67 | To run integration tests after starting the test server in Docker: 68 | 69 | ``` 70 | $ cargo test 71 | ``` 72 | 73 | ## Reference 74 | 75 | - https://wiki.vg/Rcon 76 | 77 | [License]: https://www.gnu.org/licenses/gpl-3.0 78 | [License Badge]: https://img.shields.io/badge/License-GPLv3-blue.svg 79 | [Build]: https://github.com/willroberts/minecraft-client-rs/actions/workflows/build.yaml 80 | [Build Badge]: https://github.com/willroberts/minecraft-client-rs/actions/workflows/build.yaml/badge.svg 81 | [Crates.io]: https://crates.io/crates/minecraft-client-rs 82 | [Crates.io Badge]: https://img.shields.io/badge/crates.io-v0.1.0-orange 83 | [docs.rs]: https://docs.rs/minecraft-client-rs/0.1.0/minecraft_client_rs/ 84 | [docs.rs Badge]: https://docs.rs/minecraft-client-rs/badge.svg?version=0.1.0 -------------------------------------------------------------------------------- /src/client.rs: -------------------------------------------------------------------------------- 1 | use std::error::Error; 2 | use std::fmt; 3 | use std::io::prelude::*; 4 | use std::net::{Shutdown, TcpStream}; 5 | use std::sync::atomic::{AtomicI32, Ordering}; 6 | 7 | use crate::message; 8 | 9 | const MAX_MESSAGE_SIZE: usize = 4110; // https://wiki.vg/Rcon#Fragmentation 10 | 11 | #[derive(Debug)] 12 | struct RequestIDMismatchError; 13 | 14 | impl Error for RequestIDMismatchError {} 15 | 16 | impl fmt::Display for RequestIDMismatchError { 17 | fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { 18 | write!(f, "received error response from server") 19 | } 20 | } 21 | 22 | pub struct Client { 23 | conn: TcpStream, 24 | last_id: AtomicI32, 25 | } 26 | 27 | impl Client { 28 | pub fn new(hostport: String) -> Result> { 29 | let conn = TcpStream::connect(hostport)?; 30 | Ok(Client { 31 | conn: conn, 32 | last_id: AtomicI32::new(0), 33 | }) 34 | } 35 | 36 | pub fn close(&mut self) -> Result<(), Box> { 37 | self.conn.shutdown(Shutdown::Both)?; 38 | Ok(()) 39 | } 40 | 41 | pub fn authenticate(&mut self, password: String) -> Result> { 42 | self.send_message(message::MessageType::Authenticate as i32, password) 43 | } 44 | 45 | pub fn send_command(&mut self, command: String) -> Result> { 46 | self.send_message(message::MessageType::Command as i32, command) 47 | } 48 | 49 | fn next_id(&self) -> i32 { 50 | let prev = self.last_id.load(Ordering::Relaxed); 51 | let next = prev + 1; 52 | self.last_id.store(next, Ordering::Relaxed); 53 | next 54 | } 55 | 56 | fn send_message( 57 | &mut self, 58 | msg_type: i32, 59 | msg_body: String, 60 | ) -> Result> { 61 | let req_id = self.next_id(); 62 | let req = message::Message { 63 | size: msg_body.len() as i32 + message::HEADER_SIZE, 64 | id: req_id.clone(), 65 | msg_type: msg_type, 66 | body: msg_body, 67 | }; 68 | 69 | self.conn.write_all(&message::encode_message(req)[..])?; 70 | let mut resp_bytes = [0u8; MAX_MESSAGE_SIZE]; 71 | self.conn.read(&mut resp_bytes)?; 72 | let resp = message::decode_message(resp_bytes.to_vec())?; 73 | 74 | if req_id == resp.id { 75 | Ok(resp) 76 | } else { 77 | Err(Box::new(RequestIDMismatchError)) 78 | } 79 | } 80 | } 81 | 82 | impl Drop for Client { 83 | fn drop(&mut self) { 84 | _ = self.close(); 85 | } 86 | } 87 | -------------------------------------------------------------------------------- /src/bin/minecraft-cli.rs: -------------------------------------------------------------------------------- 1 | #[cfg(feature = "cli")] 2 | mod cli { 3 | use clap::{ArgGroup, Parser}; 4 | use minecraft_client_rs::Client; 5 | use regex::Regex; 6 | use std::io; 7 | use std::io::prelude::*; 8 | use std::process::exit; 9 | 10 | const DEFAULT_HOSTPORT: &str = "127.0.0.1:25575"; 11 | const DEFAULT_PASSWORD: &str = "minecraft"; 12 | 13 | #[derive(Parser)] 14 | #[clap(author, version, about, long_about = None)] 15 | #[clap(propagate_version = true)] 16 | #[clap(group( 17 | ArgGroup::new("mode") 18 | .required(true) 19 | .args(&["single-command", "interactive"]), 20 | ))] 21 | struct Args { 22 | /// Starts an interactive shell. 23 | #[clap(short, long, default_value_t = false, action)] 24 | interactive: bool, 25 | 26 | /// Only send an individual command. 27 | #[clap(value_parser)] 28 | single_command: Option, 29 | 30 | /// The host and port of the RCON server. 31 | #[clap(short, long, default_value_t = String::from(DEFAULT_HOSTPORT), value_parser)] 32 | hostport: String, 33 | 34 | /// The password for RCON. 35 | #[clap(short, long, default_value_t = String::from(DEFAULT_PASSWORD), value_parser)] 36 | password: String, 37 | 38 | /// Removes Minecraft color and formatting codes from the output. 39 | #[clap(short, long, default_value_t = false, action)] 40 | keep_formatting: bool, 41 | } 42 | 43 | pub fn start() { 44 | let args = Args::parse(); 45 | 46 | let hostport = &args.hostport; 47 | let password = &args.password; 48 | 49 | // Connect and authenticate. 50 | let mut client: Client; 51 | 52 | match Client::new(hostport.to_string()) { 53 | Ok(c) => client = c, 54 | Err(e) => { 55 | println!("failed to connect to server: {}", e.to_string()); 56 | exit(1); 57 | } 58 | } 59 | 60 | match client.authenticate(password.to_string()) { 61 | Ok(_) => {} 62 | Err(_) => { 63 | println!("failed to authenticate"); 64 | disconnect_and_exit(&mut client, 1); 65 | } 66 | } 67 | 68 | if args.interactive { 69 | start_interactive_shell(&mut client, args.keep_formatting); 70 | } else { 71 | let single_command = args.single_command.unwrap_or_else(|| { 72 | println!("no command to send!"); 73 | disconnect_and_exit(&mut client, 1); 74 | }); 75 | 76 | send_single_command(&mut client, single_command, args.keep_formatting); 77 | } 78 | } 79 | 80 | fn start_interactive_shell(client: &mut Client, keep_formatting: bool) { 81 | // Start RCON shell. 82 | println!("Starting RCON shell. Use 'exit', 'quit', or Ctrl-C to exit."); 83 | let quit_commands = vec!["exit", "quit"]; 84 | loop { 85 | print!("> "); 86 | match io::stdout().flush() { 87 | Ok(_) => {} 88 | Err(e) => { 89 | println!("failed to write to stdout: {}", e); 90 | disconnect_and_exit(client, 1); 91 | } 92 | } 93 | 94 | let mut command = String::new(); 95 | 96 | match io::stdin().read_line(&mut command) { 97 | Ok(_) => {} 98 | Err(e) => { 99 | println!("failed to read from stdin: {}", e); 100 | disconnect_and_exit(client, 1); 101 | } 102 | } 103 | 104 | // Remove trailing whitespace 105 | let command = command.trim().to_string(); 106 | 107 | if quit_commands.contains(&&command[..]) { 108 | disconnect_and_exit(client, 0); 109 | } 110 | 111 | match client.send_command(command) { 112 | Ok(msg) => println!( 113 | "{}", 114 | if keep_formatting { 115 | msg.body 116 | } else { 117 | remove_minecraft_format_codes(msg.body) 118 | } 119 | ), 120 | 121 | Err(e) => { 122 | println!("failed to send command: {}", e); 123 | disconnect_and_exit(client, 1); 124 | } 125 | } 126 | } 127 | } 128 | 129 | fn send_single_command(client: &mut Client, command: String, keep_formatting: bool) { 130 | match client.send_command(command) { 131 | Ok(msg) => { 132 | println!( 133 | "{}", 134 | if keep_formatting { 135 | msg.body 136 | } else { 137 | remove_minecraft_format_codes(msg.body) 138 | } 139 | ); 140 | 141 | disconnect_and_exit(client, 0); 142 | } 143 | Err(e) => { 144 | println!("failed to send command: {}", e); 145 | disconnect_and_exit(client, 1); 146 | } 147 | } 148 | } 149 | 150 | fn disconnect_and_exit(client: &mut Client, exit_code: i32) -> ! { 151 | match client.close() { 152 | Ok(_) => { 153 | exit(exit_code); 154 | } 155 | Err(e) => { 156 | println!("failed to disconnect: {}", e.to_string()); 157 | exit(1); 158 | } 159 | } 160 | } 161 | 162 | fn remove_minecraft_format_codes(output: String) -> String { 163 | let re = Regex::new(r"(§[a-z0-9])").unwrap(); 164 | re.replace_all(output.as_str(), "").into_owned() 165 | } 166 | } 167 | 168 | fn main() { 169 | #[cfg(feature = "cli")] 170 | cli::start(); 171 | } 172 | -------------------------------------------------------------------------------- /Cargo.lock: -------------------------------------------------------------------------------- 1 | # This file is automatically @generated by Cargo. 2 | # It is not intended for manual editing. 3 | version = 3 4 | 5 | [[package]] 6 | name = "aho-corasick" 7 | version = "0.7.18" 8 | source = "registry+https://github.com/rust-lang/crates.io-index" 9 | checksum = "1e37cfd5e7657ada45f742d6e99ca5788580b5c529dc78faf11ece6dc702656f" 10 | dependencies = [ 11 | "memchr", 12 | ] 13 | 14 | [[package]] 15 | name = "atty" 16 | version = "0.2.14" 17 | source = "registry+https://github.com/rust-lang/crates.io-index" 18 | checksum = "d9b39be18770d11421cdb1b9947a45dd3f37e93092cbf377614828a319d5fee8" 19 | dependencies = [ 20 | "hermit-abi", 21 | "libc", 22 | "winapi", 23 | ] 24 | 25 | [[package]] 26 | name = "autocfg" 27 | version = "1.1.0" 28 | source = "registry+https://github.com/rust-lang/crates.io-index" 29 | checksum = "d468802bab17cbc0cc575e9b053f41e72aa36bfa6b7f55e3529ffa43161b97fa" 30 | 31 | [[package]] 32 | name = "bitflags" 33 | version = "1.3.2" 34 | source = "registry+https://github.com/rust-lang/crates.io-index" 35 | checksum = "bef38d45163c2f1dde094a7dfd33ccf595c92905c8f8f4fdc18d06fb1037718a" 36 | 37 | [[package]] 38 | name = "clap" 39 | version = "3.2.16" 40 | source = "registry+https://github.com/rust-lang/crates.io-index" 41 | checksum = "a3dbbb6653e7c55cc8595ad3e1f7be8f32aba4eb7ff7f0fd1163d4f3d137c0a9" 42 | dependencies = [ 43 | "atty", 44 | "bitflags", 45 | "clap_derive", 46 | "clap_lex", 47 | "indexmap", 48 | "once_cell", 49 | "strsim", 50 | "termcolor", 51 | "textwrap", 52 | ] 53 | 54 | [[package]] 55 | name = "clap_derive" 56 | version = "3.2.15" 57 | source = "registry+https://github.com/rust-lang/crates.io-index" 58 | checksum = "9ba52acd3b0a5c33aeada5cdaa3267cdc7c594a98731d4268cdc1532f4264cb4" 59 | dependencies = [ 60 | "heck", 61 | "proc-macro-error", 62 | "proc-macro2", 63 | "quote", 64 | "syn", 65 | ] 66 | 67 | [[package]] 68 | name = "clap_lex" 69 | version = "0.2.4" 70 | source = "registry+https://github.com/rust-lang/crates.io-index" 71 | checksum = "2850f2f5a82cbf437dd5af4d49848fbdfc27c157c3d010345776f952765261c5" 72 | dependencies = [ 73 | "os_str_bytes", 74 | ] 75 | 76 | [[package]] 77 | name = "hashbrown" 78 | version = "0.12.3" 79 | source = "registry+https://github.com/rust-lang/crates.io-index" 80 | checksum = "8a9ee70c43aaf417c914396645a0fa852624801b24ebb7ae78fe8272889ac888" 81 | 82 | [[package]] 83 | name = "heck" 84 | version = "0.4.0" 85 | source = "registry+https://github.com/rust-lang/crates.io-index" 86 | checksum = "2540771e65fc8cb83cd6e8a237f70c319bd5c29f78ed1084ba5d50eeac86f7f9" 87 | 88 | [[package]] 89 | name = "hermit-abi" 90 | version = "0.1.19" 91 | source = "registry+https://github.com/rust-lang/crates.io-index" 92 | checksum = "62b467343b94ba476dcb2500d242dadbb39557df889310ac77c5d99100aaac33" 93 | dependencies = [ 94 | "libc", 95 | ] 96 | 97 | [[package]] 98 | name = "indexmap" 99 | version = "1.9.1" 100 | source = "registry+https://github.com/rust-lang/crates.io-index" 101 | checksum = "10a35a97730320ffe8e2d410b5d3b69279b98d2c14bdb8b70ea89ecf7888d41e" 102 | dependencies = [ 103 | "autocfg", 104 | "hashbrown", 105 | ] 106 | 107 | [[package]] 108 | name = "libc" 109 | version = "0.2.126" 110 | source = "registry+https://github.com/rust-lang/crates.io-index" 111 | checksum = "349d5a591cd28b49e1d1037471617a32ddcda5731b99419008085f72d5a53836" 112 | 113 | [[package]] 114 | name = "memchr" 115 | version = "2.5.0" 116 | source = "registry+https://github.com/rust-lang/crates.io-index" 117 | checksum = "2dffe52ecf27772e601905b7522cb4ef790d2cc203488bbd0e2fe85fcb74566d" 118 | 119 | [[package]] 120 | name = "minecraft-client-rs" 121 | version = "0.1.3" 122 | dependencies = [ 123 | "clap", 124 | "regex", 125 | ] 126 | 127 | [[package]] 128 | name = "once_cell" 129 | version = "1.13.0" 130 | source = "registry+https://github.com/rust-lang/crates.io-index" 131 | checksum = "18a6dbe30758c9f83eb00cbea4ac95966305f5a7772f3f42ebfc7fc7eddbd8e1" 132 | 133 | [[package]] 134 | name = "os_str_bytes" 135 | version = "6.2.0" 136 | source = "registry+https://github.com/rust-lang/crates.io-index" 137 | checksum = "648001efe5d5c0102d8cea768e348da85d90af8ba91f0bea908f157951493cd4" 138 | 139 | [[package]] 140 | name = "proc-macro-error" 141 | version = "1.0.4" 142 | source = "registry+https://github.com/rust-lang/crates.io-index" 143 | checksum = "da25490ff9892aab3fcf7c36f08cfb902dd3e71ca0f9f9517bea02a73a5ce38c" 144 | dependencies = [ 145 | "proc-macro-error-attr", 146 | "proc-macro2", 147 | "quote", 148 | "syn", 149 | "version_check", 150 | ] 151 | 152 | [[package]] 153 | name = "proc-macro-error-attr" 154 | version = "1.0.4" 155 | source = "registry+https://github.com/rust-lang/crates.io-index" 156 | checksum = "a1be40180e52ecc98ad80b184934baf3d0d29f979574e439af5a55274b35f869" 157 | dependencies = [ 158 | "proc-macro2", 159 | "quote", 160 | "version_check", 161 | ] 162 | 163 | [[package]] 164 | name = "proc-macro2" 165 | version = "1.0.42" 166 | source = "registry+https://github.com/rust-lang/crates.io-index" 167 | checksum = "c278e965f1d8cf32d6e0e96de3d3e79712178ae67986d9cf9151f51e95aac89b" 168 | dependencies = [ 169 | "unicode-ident", 170 | ] 171 | 172 | [[package]] 173 | name = "quote" 174 | version = "1.0.20" 175 | source = "registry+https://github.com/rust-lang/crates.io-index" 176 | checksum = "3bcdf212e9776fbcb2d23ab029360416bb1706b1aea2d1a5ba002727cbcab804" 177 | dependencies = [ 178 | "proc-macro2", 179 | ] 180 | 181 | [[package]] 182 | name = "regex" 183 | version = "1.6.0" 184 | source = "registry+https://github.com/rust-lang/crates.io-index" 185 | checksum = "4c4eb3267174b8c6c2f654116623910a0fef09c4753f8dd83db29c48a0df988b" 186 | dependencies = [ 187 | "aho-corasick", 188 | "memchr", 189 | "regex-syntax", 190 | ] 191 | 192 | [[package]] 193 | name = "regex-syntax" 194 | version = "0.6.27" 195 | source = "registry+https://github.com/rust-lang/crates.io-index" 196 | checksum = "a3f87b73ce11b1619a3c6332f45341e0047173771e8b8b73f87bfeefb7b56244" 197 | 198 | [[package]] 199 | name = "strsim" 200 | version = "0.10.0" 201 | source = "registry+https://github.com/rust-lang/crates.io-index" 202 | checksum = "73473c0e59e6d5812c5dfe2a064a6444949f089e20eec9a2e5506596494e4623" 203 | 204 | [[package]] 205 | name = "syn" 206 | version = "1.0.98" 207 | source = "registry+https://github.com/rust-lang/crates.io-index" 208 | checksum = "c50aef8a904de4c23c788f104b7dddc7d6f79c647c7c8ce4cc8f73eb0ca773dd" 209 | dependencies = [ 210 | "proc-macro2", 211 | "quote", 212 | "unicode-ident", 213 | ] 214 | 215 | [[package]] 216 | name = "termcolor" 217 | version = "1.1.3" 218 | source = "registry+https://github.com/rust-lang/crates.io-index" 219 | checksum = "bab24d30b911b2376f3a13cc2cd443142f0c81dda04c118693e35b3835757755" 220 | dependencies = [ 221 | "winapi-util", 222 | ] 223 | 224 | [[package]] 225 | name = "textwrap" 226 | version = "0.15.0" 227 | source = "registry+https://github.com/rust-lang/crates.io-index" 228 | checksum = "b1141d4d61095b28419e22cb0bbf02755f5e54e0526f97f1e3d1d160e60885fb" 229 | 230 | [[package]] 231 | name = "unicode-ident" 232 | version = "1.0.2" 233 | source = "registry+https://github.com/rust-lang/crates.io-index" 234 | checksum = "15c61ba63f9235225a22310255a29b806b907c9b8c964bcbd0a2c70f3f2deea7" 235 | 236 | [[package]] 237 | name = "version_check" 238 | version = "0.9.4" 239 | source = "registry+https://github.com/rust-lang/crates.io-index" 240 | checksum = "49874b5167b65d7193b8aba1567f5c7d93d001cafc34600cee003eda787e483f" 241 | 242 | [[package]] 243 | name = "winapi" 244 | version = "0.3.9" 245 | source = "registry+https://github.com/rust-lang/crates.io-index" 246 | checksum = "5c839a674fcd7a98952e593242ea400abe93992746761e38641405d28b00f419" 247 | dependencies = [ 248 | "winapi-i686-pc-windows-gnu", 249 | "winapi-x86_64-pc-windows-gnu", 250 | ] 251 | 252 | [[package]] 253 | name = "winapi-i686-pc-windows-gnu" 254 | version = "0.4.0" 255 | source = "registry+https://github.com/rust-lang/crates.io-index" 256 | checksum = "ac3b87c63620426dd9b991e5ce0329eff545bccbbb34f3be09ff6fb6ab51b7b6" 257 | 258 | [[package]] 259 | name = "winapi-util" 260 | version = "0.1.5" 261 | source = "registry+https://github.com/rust-lang/crates.io-index" 262 | checksum = "70ec6ce85bb158151cae5e5c87f95a8e97d2c0c4b001223f33a334e3ce5de178" 263 | dependencies = [ 264 | "winapi", 265 | ] 266 | 267 | [[package]] 268 | name = "winapi-x86_64-pc-windows-gnu" 269 | version = "0.4.0" 270 | source = "registry+https://github.com/rust-lang/crates.io-index" 271 | checksum = "712e227841d057c1ee1cd2fb22fa7e5a5461ae8e48fa2ca79ec42cfc1931183f" 272 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 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 | . --------------------------------------------------------------------------------