├── .travis.yml ├── .gitignore ├── CONTRIBUTING.md ├── src ├── test │ ├── resources │ │ └── www.example.conf │ └── java │ │ └── com │ │ └── stackify │ │ └── apache │ │ ├── ConfigNodeTest.java │ │ └── ApacheConfigParserTest.java └── main │ └── java │ └── com │ └── stackify │ └── apache │ ├── ApacheConfigParser.java │ └── ConfigNode.java ├── README.md ├── pom.xml └── LICENSE.txt /.travis.yml: -------------------------------------------------------------------------------- 1 | language: java -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .classpath 2 | .project 3 | .settings 4 | 5 | target 6 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | Contributing 2 | ============ 3 | 4 | If you would like to contribute code to apache-config you can do so through GitHub by 5 | forking the repository and sending a pull request. 6 | 7 | When submitting code, please make every effort to follow existing conventions 8 | and style in order to keep the code as readable as possible. Please also make 9 | sure your code compiles by running `mvn clean verify`. 10 | 11 | Before your code can be accepted into the project you must also sign the 12 | [Individual Contributor License Agreement (CLA)][1]. 13 | 14 | 15 | [1]: https://spreadsheets.google.com/spreadsheet/viewform?formkey=dFhUbGhrNndkZFF5SzN6YjBRUm1KYnc6MQ -------------------------------------------------------------------------------- /src/test/resources/www.example.conf: -------------------------------------------------------------------------------- 1 | 2 | ServerName example.com 3 | Redirect permanent / http://www.example.com/ 4 | 5 | 6 | 7 | # DocumentRoot "/usr/local/apache/htdocs/www" 8 | DocumentRoot "/usr/local/apache/htdocs/www.example.com" 9 | ServerName www.example.com 10 | #ServerAlias example.com 11 | 12 | RewriteEngine On 13 | 14 | # Front page... 15 | RewriteRule ^/$ /w/extract2.php?title=Www.example.com_portal&template=Www.example.com_template [L] 16 | 17 | php_admin_flag engine on 18 | 19 | 20 | Order Deny,Allow 21 | Allow from env=tarpitted_bots 22 | Deny from env=bad_bots 23 | 24 | 25 | AllowOverride All 26 | ExpiresByType image/gif A0 27 | ExpiresByType image/png A0 28 | ExpiresByType image/jpeg A0 29 | ExpiresByType text/css A2592000 30 | ExpiresByType text/javascript A2592000 31 | ExpiresByType application/x-javascript A2592000 32 | ExpiresByType text/html A0 33 | 34 | 35 | 36 | # vim: sts=4 sw=4 syn=apache autoindent -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | apache-config 2 | ============= 3 | 4 | A simple config parser for Apache HTTP Server config files. 5 | 6 | Usage 7 | ----- 8 | The parser builds a tree of apache configuration. So, for example, if you wanted to find all of the virtual hosts you could do the following. 9 | 10 | ```java 11 | InputStream inputStream = new FileInputStream(new File("/etc/httpd/conf/httpd.conf")); 12 | 13 | ApacheConfigParser parser = new ApacheConfigParser(); 14 | ConfigNode config = parser.parse(inputStream); 15 | 16 | for (ConfigNode child : config.getChildren()) { 17 | if (child.getName().equals("VirtualHost")) { 18 | System.out.println(child.getContent()); 19 | } 20 | } 21 | ``` 22 | 23 | License 24 | ======= 25 | 26 | Copyright 2013 Stackify, LLC. 27 | 28 | Licensed under the Apache License, Version 2.0 (the "License"); 29 | you may not use this file except in compliance with the License. 30 | You may obtain a copy of the License at 31 | 32 | http://www.apache.org/licenses/LICENSE-2.0 33 | 34 | Unless required by applicable law or agreed to in writing, software 35 | distributed under the License is distributed on an "AS IS" BASIS, 36 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 37 | See the License for the specific language governing permissions and 38 | limitations under the License. -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 17 | 18 | 4.0.0 19 | com.stackify 20 | apache-config 21 | 1.0.1-SNAPSHOT 22 | jar 23 | 24 | Apache config parser 25 | A simple parser for Apache httpd config files 26 | https://github.com/stackify/apache-config 27 | 28 | 29 | org.sonatype.oss 30 | oss-parent 31 | 7 32 | 33 | 34 | 35 | 36 | The Apache Software License, Version 2.0 37 | http://www.apache.org/licenses/LICENSE-2.0.txt 38 | 39 | 40 | 41 | 42 | scm:git:git://github.com/stackify/apache-config.git 43 | scm:git:git@github.com:stackify/apache-config.git 44 | https://github.com/stackify/apache-config 45 | 46 | 47 | 48 | Stackify, LLC 49 | http://www.stackify.com 50 | 51 | 52 | 53 | UTF-8 54 | 1.6 55 | 56 | 57 | 58 | 59 | 60 | 61 | junit 62 | junit 63 | 4.11 64 | test 65 | 66 | 67 | 68 | 69 | 70 | 71 | org.apache.maven.plugins 72 | maven-compiler-plugin 73 | 2.3.2 74 | 75 | ${java.version} 76 | ${java.version} 77 | 78 | 79 | 80 | org.apache.maven.plugins 81 | maven-gpg-plugin 82 | 83 | 84 | sign-artifacts 85 | verify 86 | 87 | sign 88 | 89 | 90 | 91 | 92 | 93 | 94 | -------------------------------------------------------------------------------- /src/main/java/com/stackify/apache/ApacheConfigParser.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2013 Stackify 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package com.stackify.apache; 17 | 18 | import java.io.BufferedReader; 19 | import java.io.IOException; 20 | import java.io.InputStream; 21 | import java.io.InputStreamReader; 22 | import java.util.regex.Matcher; 23 | import java.util.regex.Pattern; 24 | 25 | /** 26 | * A parser for Apache httpd configuration files. 27 | * 28 | *

29 | * This parser reads the configuration file line by line and builds a tree of the configuration. 30 | * 31 | * @author jleacox 32 | * 33 | */ 34 | public class ApacheConfigParser { 35 | private static final String commentRegex = "#.*"; 36 | private static final String directiveRegex = "([^\\s]+)\\s*(.+)"; 37 | private static final String sectionOpenRegex = "<([^/\\s>]+)\\s*([^>]+)?>"; 38 | private static final String sectionCloseRegex = "]+)\\s*>"; 39 | 40 | private static final Matcher commentMatcher = Pattern.compile(commentRegex).matcher(""); 41 | private static final Matcher directiveMatcher = Pattern.compile(directiveRegex).matcher(""); 42 | private static final Matcher sectionOpenMatcher = Pattern.compile(sectionOpenRegex).matcher(""); 43 | private static final Matcher sectionCloseMatcher = Pattern.compile(sectionCloseRegex).matcher(""); 44 | 45 | public ApacheConfigParser() { 46 | } 47 | 48 | /** 49 | * Parses an Apache httpd configuration file into a configuration tree. 50 | * 51 | *

52 | * Each directive will be a leaf node in the tree, while configuration sections will be nodes with additional child 53 | * configuration nodes 54 | * 55 | * @param inputStream 56 | * the configuration file 57 | * @return a {@link ConfigNode tree} representing the Apache configuration 58 | * @throws IOException 59 | * if there is an error reading the configuration 60 | */ 61 | public ConfigNode parse(InputStream inputStream) throws IOException { 62 | if (inputStream == null) { 63 | throw new NullPointerException("inputStream: null"); 64 | } 65 | 66 | BufferedReader reader = new BufferedReader(new InputStreamReader(inputStream)); 67 | String line; 68 | ConfigNode currentNode = ConfigNode.createRootNode(); 69 | while ((line = reader.readLine()) != null) { 70 | if (commentMatcher.reset(line).find()) { 71 | continue; 72 | } else if (sectionOpenMatcher.reset(line).find()) { 73 | String name = sectionOpenMatcher.group(1); 74 | String content = sectionOpenMatcher.group(2); 75 | ConfigNode sectionNode = ConfigNode.createChildNode(name, content, currentNode); 76 | currentNode = sectionNode; 77 | } else if (sectionCloseMatcher.reset(line).find()) { 78 | currentNode = currentNode.getParent(); 79 | } else if (directiveMatcher.reset(line).find()) { 80 | String name = directiveMatcher.group(1); 81 | String content = directiveMatcher.group(2); 82 | ConfigNode.createChildNode(name, content, currentNode); 83 | } // TODO: Should an exception be thrown for unknown lines? 84 | } 85 | 86 | return currentNode; 87 | } 88 | } 89 | -------------------------------------------------------------------------------- /src/main/java/com/stackify/apache/ConfigNode.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2013 Stackify 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package com.stackify.apache; 17 | 18 | import java.util.ArrayList; 19 | import java.util.List; 20 | 21 | /** 22 | * A node in an Apache httpd configuration tree. 23 | * 24 | * @author John Leacox 25 | * 26 | */ 27 | public class ConfigNode { 28 | private final String name; 29 | private final String content; 30 | private final List children = new ArrayList(); 31 | 32 | private final ConfigNode parent; 33 | 34 | /** 35 | * Private constructor. {@code ConfigNode} instances should be created via the creation factory methods. 36 | * 37 | * @param name 38 | * the node name 39 | * @param content 40 | * the node content 41 | * @param parent 42 | * the parent of the node 43 | */ 44 | private ConfigNode(String name, String content, ConfigNode parent) { 45 | this.name = name; 46 | this.content = content; 47 | this.parent = parent; 48 | } 49 | 50 | /** 51 | * Creates a root node. 52 | * 53 | *

54 | * A root node will have a null parent, name, and content. It is the top level of the configuration tree with child 55 | * nodes containing actual values. 56 | * 57 | * @return a new root configuration node 58 | */ 59 | public static ConfigNode createRootNode() { 60 | return new ConfigNode(null, null, null); 61 | } 62 | 63 | /** 64 | * Creates a child node 65 | * 66 | *

67 | * A child node contains a configuration name and configuration content as well as a parent node in the tree. If the 68 | * child node is an apache configuration section it may also have child nodes of its own. 69 | * 70 | * @param name 71 | * the configuration name (cannot be null) 72 | * @param content 73 | * the configuration content (cannot be null) 74 | * @param parent 75 | * the child nodes parent (cannot be null) 76 | * @return a new child configuration node 77 | * @throws NullPointerException 78 | * if name, content, or parent is null 79 | */ 80 | public static ConfigNode createChildNode(String name, String content, ConfigNode parent) { 81 | if (name == null) { 82 | throw new NullPointerException("name: null"); 83 | } 84 | if (content == null) { 85 | throw new NullPointerException("content: null"); 86 | } 87 | if (parent == null) { 88 | throw new NullPointerException("parent: null"); 89 | } 90 | 91 | ConfigNode child = new ConfigNode(name, content, parent); 92 | parent.addChild(child); 93 | 94 | return child; 95 | } 96 | 97 | /** 98 | * 99 | * @return the configuration name; null if this is a root node 100 | */ 101 | public String getName() { 102 | return name; 103 | } 104 | 105 | /** 106 | * 107 | * @return the configuration content; null if this is a root node 108 | */ 109 | public String getContent() { 110 | return content; 111 | } 112 | 113 | /** 114 | * 115 | * @return The nodes parent; null if this is a root node 116 | */ 117 | public ConfigNode getParent() { 118 | return parent; 119 | } 120 | 121 | /** 122 | * 123 | * @return a list of child configuration nodes 124 | */ 125 | public List getChildren() { 126 | return children; 127 | } 128 | 129 | /** 130 | * 131 | * @return true if this is a root node; false otherwise 132 | */ 133 | public boolean isRootNode() { 134 | return parent == null; 135 | } 136 | 137 | @Override 138 | public String toString() { 139 | return "ConfigNode {name=" + name + ", content=" + content + ", childNodeCount=" + children.size() + "}"; 140 | } 141 | 142 | private void addChild(ConfigNode child) { 143 | children.add(child); 144 | } 145 | } 146 | -------------------------------------------------------------------------------- /src/test/java/com/stackify/apache/ConfigNodeTest.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2013 Stackify 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package com.stackify.apache; 17 | 18 | import static org.junit.Assert.assertEquals; 19 | import static org.junit.Assert.assertFalse; 20 | import static org.junit.Assert.assertNull; 21 | import static org.junit.Assert.assertTrue; 22 | 23 | import org.junit.Test; 24 | 25 | public class ConfigNodeTest { 26 | @Test(expected = NullPointerException.class) 27 | public void testCreateChildNodeWithNullNameThrowsNullPointerException() { 28 | ConfigNode root = ConfigNode.createRootNode(); 29 | ConfigNode.createChildNode((String) null, "content", root); 30 | } 31 | 32 | @Test(expected = NullPointerException.class) 33 | public void testCreateChildNodeWithNullContentThrowsNullPointerException() { 34 | ConfigNode root = ConfigNode.createRootNode(); 35 | ConfigNode.createChildNode("name", (String) null, root); 36 | } 37 | 38 | @Test(expected = NullPointerException.class) 39 | public void testCreateChildNodeWithNullParentThrowsNullPointerException() { 40 | ConfigNode.createChildNode("name", "content", (ConfigNode) null); 41 | } 42 | 43 | @Test 44 | public void testGetNameFromRootNodeIsNull() { 45 | ConfigNode root = ConfigNode.createRootNode(); 46 | assertNull(root.getName()); 47 | } 48 | 49 | @Test 50 | public void testGetContentFromRootNodeIsNull() { 51 | ConfigNode root = ConfigNode.createRootNode(); 52 | assertNull(root.getContent()); 53 | } 54 | 55 | @Test 56 | public void testGetParentFromRootNodeIsNull() { 57 | ConfigNode root = ConfigNode.createRootNode(); 58 | assertNull(root.getParent()); 59 | } 60 | 61 | @Test 62 | public void testIsRootNodeTrue() { 63 | ConfigNode root = ConfigNode.createRootNode(); 64 | assertTrue(root.isRootNode()); 65 | } 66 | 67 | @Test 68 | public void testIsRootNodeFalse() { 69 | ConfigNode root = ConfigNode.createRootNode(); 70 | ConfigNode child = ConfigNode.createChildNode("name", "content", root); 71 | 72 | assertFalse(child.isRootNode()); 73 | } 74 | 75 | @Test 76 | public void testGetNameFromChildNode() { 77 | ConfigNode root = ConfigNode.createRootNode(); 78 | ConfigNode child = ConfigNode.createChildNode("name", "content", root); 79 | 80 | assertEquals("name", child.getName()); 81 | } 82 | 83 | @Test 84 | public void testGetContentFromChildNode() { 85 | ConfigNode root = ConfigNode.createRootNode(); 86 | ConfigNode child = ConfigNode.createChildNode("name", "content", root); 87 | 88 | assertEquals("content", child.getContent()); 89 | } 90 | 91 | @Test 92 | public void testGetParentFromChildNode() { 93 | ConfigNode root = ConfigNode.createRootNode(); 94 | ConfigNode child = ConfigNode.createChildNode("name", "content", root); 95 | 96 | assertEquals(root, child.getParent()); 97 | } 98 | 99 | @Test 100 | public void testToStringRoot() { 101 | String expectedString = "ConfigNode {name=null, content=null, childNodeCount=3}"; 102 | 103 | ConfigNode root = ConfigNode.createRootNode(); 104 | ConfigNode.createChildNode("child1", "content1", root); 105 | ConfigNode.createChildNode("child2", "content2", root); 106 | ConfigNode.createChildNode("child3", "content3", root); 107 | 108 | assertEquals(expectedString, root.toString()); 109 | } 110 | 111 | @Test 112 | public void testToStringChild() { 113 | String expectedString = "ConfigNode {name=child1, content=content1, childNodeCount=2}"; 114 | 115 | ConfigNode root = ConfigNode.createRootNode(); 116 | ConfigNode child = ConfigNode.createChildNode("child1", "content1", root); 117 | ConfigNode.createChildNode("child2", "content2", child); 118 | ConfigNode.createChildNode("child3", "content3", child); 119 | 120 | assertEquals(expectedString, child.toString()); 121 | } 122 | } 123 | -------------------------------------------------------------------------------- /src/test/java/com/stackify/apache/ApacheConfigParserTest.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2013 Stackify 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package com.stackify.apache; 17 | 18 | import static org.junit.Assert.assertEquals; 19 | 20 | import java.io.IOException; 21 | import java.io.InputStream; 22 | import java.util.List; 23 | 24 | import org.junit.Test; 25 | 26 | public class ApacheConfigParserTest { 27 | @Test(expected = NullPointerException.class) 28 | public void testParseWithNullInputStreamThrowsNullPointerException() throws IOException { 29 | ApacheConfigParser parser = new ApacheConfigParser(); 30 | parser.parse((InputStream) null); 31 | } 32 | 33 | @Test 34 | public void testParseExampleConfig() throws IOException { 35 | InputStream inputStream = getClass().getResourceAsStream("/www.example.conf"); 36 | 37 | ApacheConfigParser parser = new ApacheConfigParser(); 38 | ConfigNode root = parser.parse(inputStream); 39 | 40 | verifyNode(null, null, 2, root); 41 | 42 | List vhosts = root.getChildren(); 43 | assertEquals(2, vhosts.size()); 44 | 45 | // Virtual Host 1 46 | { 47 | ConfigNode vhost = vhosts.get(0); 48 | verifyNode("VirtualHost", "*", 2, vhost); 49 | 50 | List directives = vhost.getChildren(); 51 | 52 | ConfigNode serverName = directives.get(0); 53 | verifyNode("ServerName", "example.com", 0, serverName); 54 | 55 | ConfigNode redirect = directives.get(1); 56 | verifyNode("Redirect", "permanent / http://www.example.com/", 0, redirect); 57 | } 58 | 59 | // Virtual Host 2 60 | { 61 | ConfigNode vhost = vhosts.get(1); 62 | verifyNode("VirtualHost", "*", 7, vhost); 63 | 64 | List vhostDirectives = vhost.getChildren(); 65 | 66 | ConfigNode documentRoot = vhostDirectives.get(0); 67 | verifyNode("DocumentRoot", "\"/usr/local/apache/htdocs/www.example.com\"", 0, documentRoot); 68 | 69 | ConfigNode serverName = vhostDirectives.get(1); 70 | verifyNode("ServerName", "www.example.com", 0, serverName); 71 | 72 | ConfigNode rewriteEngine = vhostDirectives.get(2); 73 | verifyNode("RewriteEngine", "On", 0, rewriteEngine); 74 | 75 | ConfigNode rewriteRule = vhostDirectives.get(3); 76 | verifyNode("RewriteRule", 77 | "^/$ /w/extract2.php?title=Www.example.com_portal&template=Www.example.com_template [L]", 0, 78 | rewriteRule); 79 | 80 | ConfigNode vhostTwoPhpAdminFlag = vhostDirectives.get(4); 81 | verifyNode("php_admin_flag", "engine on", 0, vhostTwoPhpAdminFlag); 82 | 83 | // Directory 1 84 | { 85 | ConfigNode directory = vhostDirectives.get(5); 86 | verifyNode("Directory", "\"/usr/local/apache/htdocs/www\"", 3, directory); 87 | 88 | List directoryDirectives = directory.getChildren(); 89 | 90 | ConfigNode order = directoryDirectives.get(0); 91 | verifyNode("Order", "Deny,Allow", 0, order); 92 | 93 | ConfigNode allow = directoryDirectives.get(1); 94 | verifyNode("Allow", "from env=tarpitted_bots", 0, allow); 95 | 96 | ConfigNode deny = directoryDirectives.get(2); 97 | verifyNode("Deny", "from env=bad_bots", 0, deny); 98 | } 99 | 100 | // Directory 2 101 | { 102 | ConfigNode directory = vhostDirectives.get(6); 103 | verifyNode("Directory", "\"/usr/local/apache/htdocs/www/stats\"", 8, directory); 104 | 105 | List directoryDirectives = directory.getChildren(); 106 | 107 | ConfigNode allowOverride = directoryDirectives.get(0); 108 | verifyNode("AllowOverride", "All", 0, allowOverride); 109 | 110 | ConfigNode expiresByTypeGif = directoryDirectives.get(1); 111 | verifyNode("ExpiresByType", "image/gif A0", 0, expiresByTypeGif); 112 | 113 | ConfigNode expiresByTypePng = directoryDirectives.get(2); 114 | verifyNode("ExpiresByType", "image/png A0", 0, expiresByTypePng); 115 | 116 | ConfigNode expiresByTypeJpeg = directoryDirectives.get(3); 117 | verifyNode("ExpiresByType", "image/jpeg A0", 0, expiresByTypeJpeg); 118 | 119 | ConfigNode expiresByTypeCss = directoryDirectives.get(4); 120 | verifyNode("ExpiresByType", "text/css A2592000", 0, expiresByTypeCss); 121 | 122 | ConfigNode expiresByTypeTextJavascript = directoryDirectives.get(5); 123 | verifyNode("ExpiresByType", "text/javascript A2592000", 0, expiresByTypeTextJavascript); 124 | 125 | ConfigNode expiresByTypeAppJavascript = directoryDirectives.get(6); 126 | verifyNode("ExpiresByType", "application/x-javascript A2592000", 0, expiresByTypeAppJavascript); 127 | 128 | ConfigNode expiresByTypeHtml = directoryDirectives.get(7); 129 | verifyNode("ExpiresByType", "text/html A0", 0, expiresByTypeHtml); 130 | } 131 | } 132 | 133 | } 134 | 135 | private static void verifyNode(String expectedName, String expectedContent, int expectedChildCount, ConfigNode node) { 136 | assertEquals(expectedName, node.getName()); 137 | assertEquals(expectedContent, node.getContent()); 138 | assertEquals(expectedChildCount, node.getChildren().size()); 139 | } 140 | } 141 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. --------------------------------------------------------------------------------