├── __init__.py ├── tests ├── __init__.py ├── resources │ └── default.json ├── test_003.py ├── test_002.py └── test_001.py ├── requirements.txt ├── .gitignore ├── exceptions.py ├── setup.py ├── README.md ├── json_conf_autoref.py └── LICENSE /__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /tests/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | setuptools 2 | pytest 3 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.pyc 2 | __pycache__/ 3 | dist/ 4 | json_conf_autoref.egg-info/ 5 | build/ 6 | eggs/ 7 | .eggs/ 8 | *.swp 9 | test.* 10 | config.json 11 | venv/ 12 | docs/ 13 | .coverage 14 | *.tmp 15 | -------------------------------------------------------------------------------- /tests/resources/default.json: -------------------------------------------------------------------------------- 1 | { 2 | "project-name":"fantastic-project" 3 | ,"hdfs-user":"john" 4 | ,"hdfs-base":"/usr/$hdfs-user/$project-name" 5 | ,"hdfs-paths":{ 6 | "incoming":"$hdfs-base/incoming" 7 | ,"processing":"$hdfs-base/processing" 8 | ,"processed":"$hdfs-base/processed" 9 | ,"rejected":"$hdfs-base/rejected" 10 | } 11 | ,"multivar-ref":"$hdfs-paths.rejected$hdfs-user" 12 | ,"no-ref-list":[1,2,3,"just a test"] 13 | ,"ref-list":[1,2,3,"something","$hdfs-user","$hdfs-paths.incoming"] 14 | } -------------------------------------------------------------------------------- /exceptions.py: -------------------------------------------------------------------------------- 1 | # Exceptions 2 | class LimitException(Exception): 3 | def ___init__(self, expression, message): 4 | self.expression = expression 5 | self.message = message 6 | super(ValidationError, self).__init__(message) 7 | 8 | class NoInputData(Exception): 9 | def ___init__(self, expression, message): 10 | self.expression = expression 11 | self.message = message 12 | super(ValidationError, self).__init__(message) 13 | 14 | class InvalidParam(Exception): 15 | def ___init__(self, expression, message): 16 | 17 | self.expression = expression 18 | self.message = message 19 | super(ValidationError, self).__init__(message) 20 | 21 | class InvalidComplexListValues(Exception): 22 | def ___init__(self, expression, message): 23 | 24 | self.expression = expression 25 | self.message = message 26 | super(ValidationError, self).__init__(message) 27 | 28 | class PathNotDefined(Exception): 29 | def ___init__(self, expression, message): 30 | 31 | self.expression = expression 32 | self.message = message 33 | super(ValidationError, self).__init__(message) 34 | 35 | 36 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | from setuptools import setup, find_packages 2 | 3 | # read the contents of your README file 4 | from os import path 5 | this_directory = path.abspath(path.dirname(__file__)) 6 | with open(path.join(this_directory, 'README.md'), encoding='utf-8') as f: 7 | long_description = f.read() 8 | 9 | 10 | setup( 11 | name="json_conf_autoref", 12 | version="0.1.5", 13 | packages=find_packages(), 14 | setup_requires=['pytest-runner'], 15 | tests_require=['pytest'], 16 | py_modules=['json_conf_autoref','exceptions'], 17 | 18 | # metadata to display on PyPI 19 | author="Andre Carneiro", 20 | author_email="andregarciacarneiro@gmail.com", 21 | description="JSON config parser with variable reference's handler", 22 | long_description=long_description, 23 | long_description_content_type='text/markdown', 24 | keywords="config json variable reference", 25 | url="https://github.com/bang/json-conf-autoref", # project home page, if any 26 | project_urls={ 27 | "Bug Tracker": "https://github.com/bang/json-conf-autoref/issues", 28 | "Documentation": "https://github.com/bang/json-conf-autoref/blob/master/README.md", 29 | "Source Code": "https://github.com/bang/json-conf-autoref", 30 | }, 31 | classifiers=[ 32 | "License :: OSI Approved :: Python Software Foundation License" 33 | ], 34 | 35 | 36 | # could also include long_description, download_url, etc. 37 | ) 38 | -------------------------------------------------------------------------------- /tests/test_003.py: -------------------------------------------------------------------------------- 1 | import os 2 | import sys 3 | import pytest 4 | import json_conf_autoref as jc 5 | 6 | # Comments tests 7 | def test_comments_on_string(): 8 | js_string = """ 9 | { #comment1 10 | "project-name":"fantastic-project", 11 | #comment2 "test-ref":"#should-not-be-interpret-as-comment${project-name}", 12 | #comment3 13 | "another-var":"hey", #comment4 14 | "test-array":[1,2,3,4,"${project-name}",5,6,"${another-var}"], 15 | "inside-string":"#this is not considered a comment!" 16 | #comment5 17 | } #comment6""" 18 | conf = jc.process(json_string=js_string) 19 | assert conf['another-var'] == 'hey' 20 | assert conf['inside-string'] == "#this is not considered a comment!" 21 | assert conf['project-name'] == "fantastic-project" 22 | array_comparing = [ 23 | 1, 24 | 2, 25 | 3, 26 | 4, 27 | "fantastic-project", 28 | 5, 29 | 6, 30 | "hey" 31 | ] 32 | assert conf['test-array'] == array_comparing 33 | 34 | def test_comments_on_file(): 35 | # Simple test. No vars, one value 36 | os.environ['MY_VAR1']='test1' 37 | conf = jc.process(file='config.json') 38 | assert conf['another-var'] == 'hey' 39 | assert conf['inside-string'] == "#this is not considered a comment!" 40 | assert conf['project-name'] == "fantastic-project" 41 | array_comparing = [ 42 | 1, 43 | 2, 44 | 3, 45 | 4, 46 | "fantastic-project", 47 | 5, 48 | 6, 49 | "hey" 50 | ] 51 | assert conf['test-array'] == array_comparing 52 | 53 | -------------------------------------------------------------------------------- /tests/test_002.py: -------------------------------------------------------------------------------- 1 | import os 2 | import sys 3 | import pytest 4 | import json_conf_autoref as jc 5 | 6 | # Environment variable tests 7 | 8 | def test_common_use(): 9 | # Simple test. No vars, one value 10 | os.environ['MY_VAR1']='test1' 11 | js_string = """ 12 | { 13 | "no-var-test":"works", 14 | "test-env-var":"$ENV{MY_VAR1}" 15 | }""" 16 | conf = jc.process(json_string=js_string) 17 | assert conf['no-var-test'] == 'works' 18 | assert conf['test-env-var'] == 'test1' 19 | 20 | 21 | def test_concatenation(): 22 | # Simple test. No vars, one value 23 | os.environ['MY_VAR1']='test1' 24 | os.environ['MY_VAR2']='test2' 25 | js_string = """ 26 | { 27 | "no-var-test":"works", 28 | "test-env-var":"$ENV{MY_VAR1}$ENV{MY_VAR2}" 29 | }""" 30 | conf = jc.process(json_string=js_string) 31 | assert conf['no-var-test'] == 'works' 32 | assert conf['test-env-var'] == 'test1test2' 33 | 34 | 35 | def test_deep(): 36 | # Simple test. No vars, one value 37 | os.environ['MY_VAR1']='test1' 38 | os.environ['MY_VAR2']='test2' 39 | js_string = """ 40 | { 41 | "no-var-test":"works", 42 | "level1":{ 43 | "level2":{ 44 | "level3":"$ENV{MY_VAR1}" 45 | } 46 | } 47 | }""" 48 | conf = jc.process(json_string=js_string) 49 | assert conf['no-var-test'] == 'works' 50 | assert conf['level1']['level2']['level3'] == 'test1' 51 | 52 | 53 | def test_deep_with_concatenation(): 54 | # Simple test. No vars, one value 55 | os.environ['MY_VAR1']='test1' 56 | os.environ['MY_VAR2']='test2' 57 | js_string = """ 58 | { 59 | "no-var-test":"works", 60 | "level1":{ 61 | "level2":{ 62 | "level3":"$ENV{MY_VAR1}$ENV{MY_VAR2}" 63 | } 64 | } 65 | }""" 66 | conf = jc.process(json_string=js_string) 67 | assert conf['no-var-test'] == 'works' 68 | assert conf['level1']['level2']['level3'] == 'test1test2' 69 | 70 | 71 | def test_deep_with_concatenation2(): 72 | # Simple test. No vars, one value 73 | os.environ['MY_VAR1']='test1' 74 | os.environ['MY_VAR2']='test2' 75 | js_string = """ 76 | { 77 | "no-var-test":"works", 78 | "level1":{ 79 | "level2":{ 80 | "level3":"$ENV{MY_VAR1}--- # foobar$ENV{MY_VAR2}" 81 | } 82 | } 83 | }""" 84 | conf = jc.process(json_string=js_string) 85 | assert conf['no-var-test'] == 'works' 86 | assert conf['level1']['level2']['level3'] == 'test1--- # foobartest2' 87 | -------------------------------------------------------------------------------- /tests/test_001.py: -------------------------------------------------------------------------------- 1 | import sys 2 | import pytest 3 | import json_conf_autoref as jc 4 | 5 | 6 | 7 | def test_simple_no_vars(): 8 | # Simple test. No vars, one value 9 | js_string = """ 10 | { 11 | "no-var-test":"works" 12 | }""" 13 | 14 | conf = jc.process(json_string=js_string) 15 | assert conf['no-var-test'] == 'works' 16 | 17 | # More than one value 18 | js_string = """ 19 | { 20 | "key1":"works" 21 | ,"key2":"works too" 22 | ,"key3":"all good!" 23 | }""" 24 | 25 | conf = jc.process(json_string=js_string) 26 | assert conf['key1'] == 'works' 27 | assert conf['key2'] == 'works too' 28 | assert conf['key3'] == 'all good!' 29 | 30 | 31 | def test_simple_var_concatenation(): 32 | js_string = """ 33 | { 34 | "key1":"works" 35 | ,"key2":"works too" 36 | ,"key3":"${key1}${key2}" 37 | }""" 38 | conf = jc.process(json_string=js_string) 39 | assert conf['key3'] == "worksworks too" 40 | 41 | 42 | def test_hirerarchy_no_vars_on_values(): 43 | # Hierarchy with no var references 44 | js_string = """ 45 | { 46 | "key1":"works" 47 | ,"key2":"works too" 48 | ,"key3":"all good!" 49 | ,"levels":{ 50 | "level1":{ 51 | "level2-var":"you're on level 2" 52 | } 53 | } 54 | ,"level2-var-reference":"${levels.level1.level2-var}" 55 | }""" 56 | 57 | conf = jc.process(json_string=js_string) 58 | assert conf['level2-var-reference'] == "you're on level 2" 59 | 60 | 61 | def test_hierarchycal_var_concatenation(): 62 | js_string = """ 63 | { 64 | "key1":"works" 65 | ,"key2":"works too" 66 | ,"levels":{ 67 | "level1":{ 68 | "concat":"${key1}${key2}" 69 | } 70 | } 71 | }""" 72 | conf = jc.process(json_string=js_string) 73 | assert conf['levels']['level1']['concat'] == "worksworks too" 74 | 75 | 76 | def test_hierarchycal_var_and_chars_concatenation(): 77 | js_string = """ 78 | { 79 | "key1":"works" 80 | ,"key2":"works too" 81 | ,"key3":"works fine" 82 | ,"levels":{ 83 | "level1":{ 84 | "concat":"${key1}/${key2}#${key3}:33" 85 | } 86 | } 87 | }""" 88 | conf = jc.process(json_string=js_string) 89 | assert conf['levels']['level1']['concat'] == "works/works too#works fine:33" 90 | 91 | 92 | def test_list_no_vars(): 93 | js_string = """ 94 | { 95 | "key1":[1,2,3,"works"] 96 | ,"key2":"works too" 97 | ,"key3":"works fine" 98 | }""" 99 | conf = jc.process(json_string=js_string) 100 | if str(conf['key1'][0]) == "1" and \ 101 | str(conf['key1'][1]) == "2" and \ 102 | str(conf['key1'][2]) == "3" and \ 103 | str(conf['key1'][3]) == "works": 104 | assert True 105 | 106 | 107 | def test_list_sub_no_vars(): 108 | js_string = """ 109 | { 110 | "key1":{ 111 | "key2":[1,2,3,"works"] 112 | ,"key3":{ 113 | "key4":[4,5,6,"This is level 4"] 114 | ,"level2":"This is level 2" 115 | } 116 | } 117 | }""" 118 | conf = jc.process(json_string=js_string) 119 | print(str(conf['key1'])) 120 | assert str(conf['key1']['key2'][3]) == "works" 121 | 122 | 123 | def test_list_vars(): 124 | js_string = """ 125 | { 126 | "key1":"something" 127 | ,"key2":[1,2,3,"${key1}"] 128 | }""" 129 | conf = jc.process(json_string=js_string) 130 | print(str(conf['key2'])) 131 | assert str(conf['key2'][3]) == "something" 132 | 133 | def test_complex_list_structure(): 134 | js_string = """ 135 | { 136 | "local-base":"test-local-base", 137 | "inputs":[{ 138 | "driver":"http", 139 | "options":{ 140 | "urls":["https://whatever/part-00000.json.gz"], 141 | "download-dir":"${local-base}/downloads", 142 | "test-bool":true 143 | } 144 | }] 145 | }""" 146 | conf = jc.process(json_string=js_string) 147 | assert str(conf['inputs'][0]['options']['download-dir'] ) == "test-local-base/downloads" 148 | 149 | 150 | def test_list_sub_with_vars(): 151 | js_string = """ 152 | { 153 | "key1":{ 154 | "key2":[1,2,3,"works"] 155 | ,"key3":{ 156 | "key4":[4,5,6,"${var_to_list}"] 157 | } 158 | ,"level2":"This is level 2" 159 | 160 | } 161 | ,"var_to_list":"test" 162 | }""" 163 | conf = jc.process(json_string=js_string) 164 | assert str(conf['key1']['key3']['key4'][3]) == "test" 165 | 166 | 167 | def test_simple_concat_vars(): 168 | js_string = """ 169 | { 170 | "key1":"test1" 171 | ,"key2":"test2" 172 | ,"key3":"${key1}${key2}" 173 | }""" 174 | conf = jc.process(json_string=js_string) 175 | assert conf['key3'] == "test1test2" 176 | 177 | 178 | def test_deep_concat_vars(): 179 | js_string = """ 180 | { 181 | "key1":"test1" 182 | ,"key2":{ 183 | "level2-1":"this is ${key1}" 184 | ,"level2-2":"hey" 185 | ,"level2-3":"${key1}${key3}" 186 | ,"level2-4":"${key1}${key2.level2-2}" 187 | } 188 | ,"key3":"test2" 189 | }""" 190 | conf = jc.process(json_string=js_string) 191 | assert conf['key2']["level2-1"] == "this is test1" 192 | assert conf['key2']["level2-3"] == "test1test2" 193 | assert conf['key2']["level2-4"] == "test1hey" 194 | 195 | 196 | def test_list_concat_vars(): 197 | js_string = """ 198 | { 199 | "key1":"test1" 200 | ,"key2":"test2" 201 | ,"key3":["${key1}${key2}"] 202 | }""" 203 | conf = jc.process(json_string=js_string) 204 | assert conf['key3'][0] == "test1test2" 205 | 206 | 207 | def test_list_concat_deep_vars(): 208 | js_string = """ 209 | { 210 | "key1":"test1" 211 | ,"key2":"test2" 212 | ,"key3":{ 213 | "level1":{ 214 | "level2":{ 215 | "level2-list":["${key1}${key2}"] 216 | } 217 | ,"level1-value":"This is level1" 218 | } 219 | } 220 | }""" 221 | conf = jc.process(json_string=js_string) 222 | assert conf['key3']['level1']['level2']['level2-list'][0] == "test1test2" 223 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # json_conf_autoref 2 | JSON extension for configuration files. 3 | 4 | 5 | 6 | 7 | 8 | ## Version 9 | 10 | 0.1.5 11 | 12 | 13 | 14 | 15 | 16 | ## Description 17 | 18 | This module takes advantage from JSON that have a data strucutre similar to Python as a usual JSON file except that is allowed to create **variables** and refer to this variables in any part of the JSON file, following the rules at below: 19 | 20 | * Variables reference example: `"${name_of_some_variable}"`; 21 | 22 | * Variables **must** be referenced inside a string; 23 | 24 | * Variable is **always** a reference to a **simple value**! **Never** an complex/neasted structures or lists!; 25 | 26 | * You can concatenate variables 27 | 28 | Ex.: `"some_external_value${variable1}${variable2}"`; 29 | 30 | * Variables inside arrays is **experimental** 31 | 32 | ```json 33 | "my_array":[1,2,"${some_variable}","abc",3.2] 34 | ``` 35 | 36 | * You can use dots '.' to refer to a sublevels inside JSON data: 37 | 38 | ``` 39 | { 40 | "level1":{ 41 | "level2":{ 42 | "level3":"some-value" 43 | } 44 | }, 45 | "another-var":"${level1.level2.level3}" 46 | } 47 | ``` 48 | 49 | * You **can't** use variables on keys 50 | 51 | ```json 52 | { 53 | "var": "Hey!", 54 | "${var}": "something else" 55 | } 56 | ``` 57 | 58 | This will crash! 59 | 60 | 61 | 62 | See more examples in the session [How to use](#How-to-use) 63 | 64 | 65 | 66 | 67 | 68 | ## Requirements 69 | 70 | Python, version 3.6 or later 71 | 72 | pip 73 | 74 | pytest 75 | 76 | 77 | 78 | 79 | 80 | ## Installing 81 | 82 | 83 | 84 | ### Git way 85 | 86 | `git clone https://github.com/bang/json-conf-autoref.git` 87 | 88 | 89 | then 90 | 91 | `$ cd json-conf-autoref && python -m pip install -r requirements.txt` 92 | 93 | then 94 | 95 | `$ python setup.py pytest` 96 | 97 | **If all it's ok**, then 98 | 99 | `$ python setup.py install` 100 | 101 | done! 102 | 103 | 104 | 105 | ### pip way 106 | 107 | `python -mpip install json_config_autoref` 108 | 109 | or 110 | 111 | `python -mpip install json_config_autoref --user` 112 | 113 | 114 | 115 | 116 | 117 | ## Features 118 | 119 | * JSON key reference in any place of the structured; 120 | * Supports environment variables with **restrictions**(See 'Limitations' topic); 121 | 122 | 123 | 124 | 125 | 126 | ## How to use 127 | 128 | 129 | 130 | #### Create a JSON file. I called this one at below 'default.json': 131 | 132 | ```json 133 | { 134 | "project-name":"fantastic-project", 135 | "hdfs-user":"john", 136 | "hdfs-base":"/usr/${hdfs-user}/${project-name}" 137 | 138 | } 139 | ``` 140 | 141 | 142 | 143 | ### Loading configuration data with `json_conf_autoref` module 144 | 145 | ```python 146 | import json_conf_autoref as jca 147 | 148 | # Loading from file 149 | conf = jca.process(file='default.json') 150 | 151 | # Alternatively, you can load from a string 152 | jstr = """{ 153 | "project-name":"fantastic-project", 154 | "hdfs-user":"john", 155 | "hdfs-base":"/usr/${hdfs-user}/${project-name}" 156 | }""" 157 | conf = jca.process(json_string=) 158 | 159 | # Showing config with all references replaced 160 | jca.show(conf) 161 | 162 | ``` 163 | 164 | 165 | 166 | Result: 167 | 168 | ```json 169 | { 170 | "hdfs-base": "/usr/john/fantastic-project", 171 | "hdfs-user": "john", 172 | "project-name": "fantastic-project" 173 | } 174 | ``` 175 | 176 | What happened? 177 | 178 | For the 'hdfs-base' value, the reference `${hdfs-user}`(is a reference for the key 'hdfs-user') was replaced by 'john'(value of the key 'hdfs-user'. Simple like that! If you have a key and a simple value, you can refere in another place only using the char '$' + *{name of the key between brakets}* that have the value you want. Of course, if you refere to a variable that not exists a exception will be trhown. 179 | 180 | Now, let's complicate the *default.json* file a little bit, using reference to another reference using `$hdfs-base` referencing another reference. 181 | 182 | ```json 183 | { 184 | "project-name":"fantastic-project" 185 | ,"hdfs-user":"john" 186 | ,"hdfs-base":"/usr/${hdfs-user}/${project-name}" 187 | ,"hdfs-paths":{ 188 | "incoming":"${hdfs-base}/incoming" 189 | ,"processing":"${hdfs-base}/processing" 190 | ,"processed":"${hdfs-base}/processed" 191 | ,"rejected":"${hdfs-base}/rejected" 192 | } 193 | 194 | } 195 | ``` 196 | 197 | 198 | 199 | You can use another references mixing in simple values. In this case, the key "incoming", for example, has on config file the reference `${hdfs-base}` whose the original value has two another reference(`${hdfs-user}` and `${project-name}`). 200 | 201 | Now, loading the data from file with the same code as the example before 202 | 203 | ```python 204 | import json_conf_autoref as jca 205 | 206 | # Loading from file 207 | conf = jca.process(file='default.json') 208 | 209 | # Showing all vars from conf 210 | jca.show(conf) 211 | ``` 212 | 213 | 214 | 215 | Result 216 | 217 | ```json 218 | { 219 | "hdfs-base": "/usr/john/fantastic-project", 220 | "hdfs-paths": { 221 | "incoming": "/usr/john/fantastic-project/incoming", 222 | "processed": "/usr/john/fantastic-project/processed", 223 | "processing": "/usr/john/fantastic-project/processing", 224 | "rejected": "/usr/john/fantastic-project/rejected" 225 | }, 226 | "hdfs-user": "john", 227 | "project-name": "fantastic-project" 228 | } 229 | 230 | ``` 231 | 232 | 233 | 234 | **This will crash**! 235 | 236 | ```json 237 | { 238 | "paths":{ 239 | "path1":"/first/path" 240 | ,"path2":"/second/path" 241 | } 242 | ,"refer-test":${paths} 243 | } 244 | ``` 245 | 246 | This crashes because '${paths}' is not between quotes and even was the case(between quotes), ${paths} is refering to a complex data and this is not allowed. 247 | 248 | 249 | 250 | ### Multiple-level references (dot-paths) 251 | 252 | References by *dot-paths* is a reference to **existent paths** where any hirerchycal level division is represented by a dot char '.'. Ex: 253 | 254 | Considering the same config file 255 | 256 | ```json 257 | { 258 | "project-name":"fantastic-project" 259 | ,"hdfs-user":"john" 260 | ,"hdfs-base":"/usr/${hdfs-user}/${project-name}" 261 | ,"hdfs-paths":{ 262 | "incoming":"${hdfs-base}/incoming" 263 | ,"processing":"${hdfs-base}/processing" 264 | ,"processed":"${hdfs-base}/processed" 265 | ,"rejected":"${hdfs-base}/rejected" 266 | } 267 | 268 | } 269 | ``` 270 | 271 | How to refer to 'incoming' key ? You can acess multiple levels of the structure using dots for each deep level you want to reach. 272 | 273 | Example: Consider a JSON structure at below. Now, suppose to use a variable called "dot-path-example" that is on first level of this structure and value to reach is 'incoming', at below of 'hdfs-paths'. This is possible to access using dots like this: `"${hdfs-paths.incoming}"` 274 | 275 | ```json 276 | { 277 | "project-name":"fantastic-project" 278 | ,"hdfs-user":"john" 279 | ,"hdfs-base":"/usr/${hdfs-user}/${project-name}" 280 | ,"hdfs-paths":{ 281 | "incoming":"${hdfs-base}/incoming" 282 | ,"processing":"${hdfs-base}/processing" 283 | ,"processed":"${hdfs-base}/processed" 284 | ,"rejected":"${hdfs-base}/rejected" 285 | }, 286 | "dot-path-example":"${hdfs-paths.incoming}" 287 | } 288 | ``` 289 | 290 | 291 | 292 | The loading code is the same as before. Showing the result: 293 | 294 | ```json 295 | { 296 | "dot-path-example": "/usr/john/fantastic-project/incoming", 297 | "hdfs-base": "/usr/john/fantastic-project", 298 | "hdfs-paths": { 299 | "incoming": "/usr/john/fantastic-project/incoming", 300 | "processed": "/usr/john/fantastic-project/processed", 301 | "processing": "/usr/john/fantastic-project/processing", 302 | "rejected": "/usr/john/fantastic-project/rejected" 303 | }, 304 | "hdfs-user": "john", 305 | "project-name": "fantastic-project" 306 | } 307 | ``` 308 | 309 | As you can see, "dot-path-example" has exactly value as "hdfs-paths.incoming" key has. 310 | 311 | 312 | 313 | ### Variables inside JSON arrays 314 | 315 | Simple array example: 316 | 317 | ```json 318 | { 319 | "some-key-reference":"some-value" 320 | ,"the-list":[1,2,3,"yeah","${some-key-reference}"] 321 | } 322 | ``` 323 | 324 | 325 | 326 | The loading code is the same as before. Showing the result: 327 | 328 | ```json 329 | { 330 | "the-list": [ 331 | 1, 332 | 2, 333 | 3, 334 | "yeah", 335 | "some-value" 336 | ], 337 | "some-key": "some-value" 338 | } 339 | ``` 340 | 341 | 342 | 343 | 344 | 345 | List on deep level: 346 | 347 | ```json 348 | { 349 | "some-key-reference":"some-value" 350 | ,"levels":{ 351 | "level1":{ 352 | "level2":{ 353 | "level3":["something","${some-key-reference}"] 354 | } 355 | } 356 | } 357 | } 358 | ``` 359 | 360 | 361 | 362 | Result: 363 | 364 | ```json 365 | { 366 | "levels": { 367 | "level1": { 368 | "level2": { 369 | "level3": [ 370 | "something", 371 | "some-value" 372 | ] 373 | } 374 | } 375 | }, 376 | "some-key-reference": "some-value" 377 | } 378 | ``` 379 | 380 | 381 | 382 | **This will crash**! 383 | 384 | ``` 385 | { 386 | "my-list":[1,2,3,"bla"] 387 | "ref-test":"${my-list}" 388 | } 389 | ``` 390 | 391 | Again, you can't use reference to point to a substructure(a list), only to simple values. 392 | 393 | 394 | 395 | ### Environment variables(Please, see the restrictions below) 396 | 397 | Ex: 398 | 399 | ```JSON 400 | { 401 | "project-name":"fantastic-project" 402 | ,"hdfs-user":"john" 403 | ,"hdfs-base":"/usr/${hdfs-user}/${project-name}" 404 | ,"hdfs-paths":{ 405 | "incoming":"${hdfs-base}/incoming" 406 | ,"processing":"${hdfs-base}/processing" 407 | ,"processed":"${hdfs-base}/processed" 408 | ,"rejected":"${hdfs-base}/rejected" 409 | }, 410 | "test_env":"$ENV{SHELL} ---- $ENV{PATH}" 411 | 412 | } 413 | ``` 414 | 415 | Results: 416 | 417 | ```JSON 418 | { 419 | "hdfs-base": "/usr/john/fantastic-project", 420 | "hdfs-paths": { 421 | "incoming": "/usr/john/fantastic-project/incoming", 422 | "processed": "/usr/john/fantastic-project/processed", 423 | "processing": "/usr/john/fantastic-project/processing", 424 | "rejected": "/usr/john/fantastic-project/rejected" 425 | }, 426 | "hdfs-user": "john", 427 | "project-name": "fantastic-project", 428 | "test_env": "/usr/bin/zsh ---- /usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games:/usr/local/games:/snap/bin" 429 | } 430 | ``` 431 | 432 | #### Restrictions 433 | 434 | * Doesn't work on lists; 435 | * Doesn't work on 'dot-paths' 436 | 437 | 438 | 439 | ### Comments 440 | 441 | * is allowed using the chacacter '#'; 442 | 443 | * comment must not interfere on the references nor compromise the JSON document structure. 444 | 445 | Examples when comments are allowed: 446 | 447 | ```bash 448 | { #comment1 449 | "project-name":"fantastic-project", 450 | #comment2 "test-ref":"#should-not-be-interpret-as-comment${project-name}", 451 | #comment3 452 | "another-var":"hey", #comment4 453 | "test-array":[1,2,3,4,"${project-name}",5,6,"${another-var}"], 454 | "inside-a-string":"#this is not considered as a comment!" 455 | #comment5 456 | } #comment6 457 | 458 | ``` 459 | 460 | 461 | 462 | ### Accessing data 463 | 464 | Consider the our old and good 'default.json' file 465 | 466 | ```json 467 | { 468 | "project-name":"fantastic-project" 469 | ,"hdfs-user":"john" 470 | ,"hdfs-base":"/usr/${hdfs-user}/${project-name}" 471 | ,"hdfs-paths":{ 472 | "incoming":"${hdfs-base}/incoming" 473 | ,"processing":"${hdfs-base}/processing" 474 | ,"processed":"${hdfs-base}/processed" 475 | ,"rejected":"${hdfs-base}/rejected" 476 | } 477 | 478 | } 479 | ``` 480 | 481 | 482 | 483 | The `process` function returns always a `dict` object. So, only use the keys on dictionary! 484 | 485 | ```Python 486 | # Using common dictionary acess 487 | hdfs_user = conf['hdfs-paths']['incoming'] # takes '/usr/john/fantastic-project/incoming' 488 | ``` 489 | 490 | 491 | 492 | 493 | 494 | ## Limitations 495 | 496 | 497 | 498 | * **Reference to list/array index is not supported**: Something like `${some-list.3}` - intending to access position 3, considering that it's a single value is not possible; 499 | * **Reference to complex data structured is not supported**: Reference to a hash or list is not supported(and never will); 500 | * **Environment variables restrictions**: Not supported inside lists or 'dot-paths' yet; 501 | 502 | 503 | 504 | ## Change log 505 | 506 | ### 0.1.5 507 | 508 | * Support for comments; 509 | * Documentation fix; 510 | * Starting a change log; 511 | * Starting producing releases branches 512 | * 90% test covered 513 | 514 | 515 | 516 | ### 0.1.3 517 | 518 | * New support for environment variables; 519 | * New unit tests. 520 | 521 | 522 | 523 | ## Bugs 524 | 525 | https://github.com/bang/json-conf-autoref/issues 526 | 527 | 528 | 529 | ## Author 530 | 531 | André Garcia Carneiro - andregarciacarneiro@gmail.com -------------------------------------------------------------------------------- /json_conf_autoref.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | """json_conf_autoref 3 | 4 | Version 5 | ------- 6 | 0.1.5 7 | 8 | Description 9 | ----------- 10 | 11 | This module is a config parser that works with JSON format. Content can come 12 | from a JSON file or string. The module accepts variable definition inside the 13 | JSON data just adding '$' character to refere to any key that exists inside 14 | the JSON content. 15 | 16 | Examples 17 | -------- 18 | 19 | # conf/default.json 20 | { 21 | "hdfs-user":"some_cool_guy" 22 | ,"hdfs-base":"hdfs://yourcompany.com/user/$hdfs-user/fantastic-project" 23 | 24 | } 25 | 26 | # code snipet - from JSON file 27 | import json_conf_autoref as jca 28 | 29 | conf = jca.process(file="conf/default.json") 30 | jca.show(conf) 31 | 32 | Shows 33 | 34 | { 35 | "hdfs-base": "hdfs://yourcompany.com/user/some_cool_guy/fantastic-project", 36 | "hdfs-user": "some_cool_guy" 37 | } 38 | 39 | # From a JSON string 40 | 41 | my_json = '{"hdfs-user":"some_cool_guy","hdfs-base":"hdfs://yourcompany.com/user/${hdfs-user}/fantastic-project"} 42 | 43 | conf = jca.process(json_string = my_json) 44 | 45 | jca.show(conf) 46 | 47 | Shows 48 | 49 | { 50 | "hdfs-base": "hdfs://yourcompany.com/user/some_cool_guy/fantastic-project", 51 | "hdfs-user": "some_cool_guy" 52 | } 53 | 54 | # Vars 55 | { 56 | "project-name":"fantastic-project" 57 | "hdfs-base": "hdfs://yourcompany.com/user/some_cool_guy/${project-name}", 58 | "hdfs-user": "some_cool_guy" 59 | } 60 | 61 | # Vars inside lists(EXPERIMENTAL) 62 | 63 | my_json = '{"hdfs-user":"joe", "system-users":["${hdfs-user}","mary","lucca"] }' 64 | 65 | conf = jca.process(json_string = my_json) 66 | 67 | jca.show(conf) 68 | 69 | 70 | Shows 71 | 72 | '{"hdfs-user":"joe", "system-users":["joe","mary","lucca"] }' 73 | 74 | 75 | Limitations 76 | ----------- 77 | 78 | Vars on list is experimental and could crash in "not-mapped" situations. 79 | 80 | 81 | """ 82 | import json 83 | import sys 84 | import os 85 | import re 86 | from exceptions import * 87 | 88 | __version__ = '0.1.5' 89 | 90 | 91 | __author__ = "André Carneiro" 92 | 93 | 94 | def __traverse_json(json_input,path): 95 | """A internal recursive function that goes through JSON hierarchical structure 96 | looking for variables inside values using regular expression and yields 97 | a list of variables that it's found. 98 | 99 | Parameters 100 | ---------- 101 | 102 | json_input: list or dict, requited 103 | Python data structure(list or dict) with JSON data 104 | 105 | path: str,required 106 | The start point in the JSON structure 107 | 108 | Yields 109 | ------- 110 | 111 | First scenario - Not-list structure 112 | ----------------------------------- 113 | A new recursive call to function passing the current path if value in some 114 | point of structure not satisfies the requirements to replace variables to 115 | values 116 | 117 | or 118 | 119 | A key-value pair dictionary with 120 | 121 | Second scenario - list structure 122 | -------------------------------- 123 | Iterates the list and do the same thing in first scenario for each 124 | element of the list 125 | 126 | """ 127 | if isinstance(json_input, dict): 128 | for k, v in json_input.items(): 129 | # Divides the structure keys with '/'. Familiar, huh? 130 | if isinstance(v,str) and re.search(r'^.*?(\$(ENV|){.+?}).*?$',v): 131 | yield { '/'.join([path , k]) : v } 132 | else: 133 | # yields a new recursive call for __traverse passing 134 | # the current value and current path level 135 | yield from __traverse_json(v, '/'.join([path , k])) 136 | elif isinstance(json_input, list): 137 | yield { path:json_input } 138 | 139 | 140 | def __check_result(data): 141 | """Returns False if exists some variable under processing results structure. 142 | Otherwise returns True 143 | 144 | Parameters 145 | ---------- 146 | data : dict 147 | Processing result dictionary 148 | 149 | Returns 150 | ------- 151 | False 152 | If there is variables not replaced by their respective values. 153 | 154 | True 155 | Otherwise 156 | 157 | 158 | """ 159 | lookups = [] 160 | for _ in __traverse_json(data,''): 161 | lookups.append(_); 162 | 163 | if len(lookups) == 0: 164 | return True 165 | ok = True 166 | for l in lookups: 167 | for k,v in l.items(): 168 | if isinstance(v,list): 169 | for i in v: 170 | if re.search(r'\${.+?}*',str(i)): 171 | return False 172 | elif re.search(r'\${.+?}*',str(v)): 173 | return False 174 | else: 175 | return True 176 | return ok 177 | 178 | 179 | def __get_from_path(data,path): 180 | """Recovers a value that is referenced by a var under 'dot-path'("Ex: "$hdfs-paths.incoming"). 181 | 182 | Parameters 183 | ---------- 184 | data : dict 185 | Full JSON data under dictionary 186 | 187 | path : str 188 | A 'dot-path' var string 189 | 190 | 191 | Returns 192 | ------- 193 | A single value of a var. 194 | 195 | 196 | """ 197 | levels = re.split(r'\.',path) 198 | if len(levels) == 0: 199 | levels = [path] 200 | 201 | value = None 202 | key = re.sub(r'^\${','',levels[0]) 203 | key = re.sub(r'}','',key) 204 | value = data[key] 205 | if isinstance(value,list) or isinstance(value,dict): 206 | levels.pop(0) 207 | new_path = '.'.join(levels) 208 | new_data = value 209 | return __get_from_path(new_data,new_path) 210 | else: 211 | return value 212 | 213 | 214 | def __replace_vars_list(data,path,element_path,position): 215 | """Replace vars under single values(strings and numbers for example). 216 | 217 | Parameters 218 | ---------- 219 | data : dict 220 | JSON structure(full of it) transcripted to a dictionary 221 | 222 | path : list 223 | All path to an target element 224 | 225 | element_path : str 226 | The full path element string of JSON structure 227 | 228 | position : int 229 | The position in the list that is beeing analyzed 230 | 231 | 232 | Returns 233 | ------- 234 | A dictionary with the processing result 235 | """ 236 | 237 | # Separating variables from the rest of the path 238 | vars_to_replace = re.findall(r'(\${.+?})',str(element_path)) 239 | new_list = [] 240 | 241 | # Transforming paths into a valid dictionary path 242 | transformed_path = "" 243 | for part in path: 244 | transformed_path += "['{}']".format(part) 245 | # temp_flag = False 246 | 247 | # Just place the same value on the array(list) position 248 | if len(vars_to_replace) == 0: 249 | exec("data{}[{}] = element_path".format(str(transformed_path),str(position))) 250 | 251 | else: 252 | 253 | # Getting values for replacing 254 | for v in vars_to_replace: 255 | # Removing stupid chars(and content after it) that could mess 256 | # the reference names. 257 | # Don't know if this regex is enough yet. For now, this is it! 258 | v = re.sub(r'[\:\,\ \@\#\*\&\%\/].*?$','',str(v)) 259 | #v = re.sub(r'.*?(\$.+?)$','',v) 260 | 261 | value = __get_from_path(data,v) 262 | what = re.sub(r'\$',"\\$",v) 263 | to = value 264 | where = element_path 265 | regex_result = re.sub(r"" + what + r"", str(to), str(where)) 266 | cmd = '' 267 | if not re.search(r'[\(\{\:]+', regex_result) or re.search(r'\$', regex_result): 268 | cmd = f"data{transformed_path}[{position}] = '{regex_result}'" 269 | else: 270 | cmd = f"data{transformed_path}[{position}] = {regex_result}" 271 | 272 | exec(cmd) 273 | return data 274 | 275 | 276 | def __replace_vars_single(data,path,element_path): 277 | """Replace vars under single values(strings and numbers for example). 278 | 279 | Parameters 280 | ---------- 281 | data : dict 282 | JSON structure(full of it) transcripted to a dictionary 283 | 284 | path : list 285 | All path to an target element 286 | 287 | element_path : str 288 | The full path element string of JSON structure 289 | 290 | 291 | Returns 292 | ------- 293 | A dictionary with the processing result 294 | 295 | """ 296 | # Separating variables from the rest of the path 297 | vars_to_replace = re.findall(r'(\$\{.+?\})',str(element_path)) 298 | 299 | # Transforming paths into a valid dictionary path 300 | transformed_path = "" 301 | for part in path: 302 | transformed_path += f"['{part}']" 303 | 304 | # Getting values for replacing 305 | for v in vars_to_replace: 306 | if v == '': 307 | continue 308 | # Removing stupid chars(and content after it) that could mess 309 | # the reference names. 310 | # Don't know if this regex is enough yet. For now, this is it! 311 | v = re.sub(r'[\:\,\ \@\#\*\&\%\/].*?$','',str(v)) 312 | # For variables that represents paths. Like "$pathLv1.pathLv2.pathLvN" 313 | key = value = '' 314 | if re.search(r'\.',v): 315 | value_path = re.split(r'\.',v) 316 | var_path = "" 317 | 318 | for part in value_path: 319 | # Preparing var 320 | prepared_part = re.sub(r'^\${','',part) 321 | prepared_part = re.sub(r'}$','',prepared_part) 322 | var_path += f"['{prepared_part}']" 323 | 324 | # Getting value for 'doted' variables 325 | value = eval(f"data{var_path}") 326 | 327 | # For variables that is defined on root of config content 328 | else: 329 | # So, var is in the root path 330 | key = re.sub(r'\${','',v) 331 | key = re.sub(r'}','',key) 332 | value = data[key] 333 | 334 | # Preparing 'v' for regex 335 | v = re.sub(r'\$', '\\$',v) 336 | # Storing regex replacement result 337 | #replacement = eval("re.sub(r''+ v, value, element_path)") 338 | replacement = re.sub(r''+ v, value, element_path) 339 | # updating element_path with regex replacement result 340 | element_path = replacement 341 | # Finally replacing values in data 342 | exec(f"data{transformed_path} = replacement") 343 | 344 | # EXPERIMENTAL 345 | # Replacing environment var. if it exists. If not, raise error? 346 | envs = re.findall(r'(\$ENV\{(.+?)})', element_path) 347 | for env in envs: 348 | # The target string that will be submited to regex 349 | target = env[0] 350 | # Name of the environment variable 351 | env_name = env[1] 352 | # Value(If exists) of the environment variable 353 | replacement = os.environ[env_name] 354 | # Preparing target to regex 355 | target = re.sub(r'\$','\\$', target) 356 | # Applying regex 357 | regex_result = re.sub( r'' + target + r'', replacement, element_path ) 358 | # Updating element_path 359 | element_path = regex_result 360 | # Placing the result back to the data 361 | exec(f"data{transformed_path} = regex_result") 362 | 363 | return data 364 | 365 | 366 | def __replace_vars_factory(data,path,element_path,type): 367 | """A factory function when the goes is decide what kind 368 | of processing data must be submited. The possibilities 369 | of 'type' are determinated by a string that must contain only one 370 | of two values: 371 | 372 | * single: a single value(string or numbers) 373 | 374 | * list: single values inside lists(arrays) 375 | 376 | Parameters 377 | ---------- 378 | data : dict 379 | JSON structure(full of it) transcripted to a dictionary 380 | 381 | path : list 382 | All path to an target element 383 | 384 | element_path : str 385 | The full path element string of JSON structure 386 | 387 | type : str 388 | The type of vars replacing. Must be 'single' or 'list' 389 | 390 | 391 | Returns 392 | ------- 393 | A dictionary with the processing result 394 | 395 | 396 | Exceptions 397 | ---------- 398 | InvalidParam 399 | When type was passed as something different than 'single' nor 'list' 400 | 401 | 402 | """ 403 | if type == 'list': 404 | position = 0 405 | for e in element_path: 406 | data = __replace_vars_list(data,path,e,position) 407 | position += 1 408 | elif type == 'single': 409 | data = __replace_vars_single(data,path,element_path) 410 | else: 411 | raise InvalidParam("type must be 'list' or 'single'!") 412 | 413 | return data 414 | 415 | 416 | def __analyze(data): 417 | """Applies the 'traverse' on JSON structure(here is a dictionary) and submit 418 | data to __replace_vars_factory to replace values under this structure 419 | depending the kind of it(single or list) and return the results as a 420 | dictionary. 421 | 422 | Parameters 423 | ---------- 424 | data : dictionary 425 | JSON structure transcripted to a dictionary 426 | 427 | 428 | Returns 429 | ------- 430 | A dictionary with the processing results 431 | 432 | """ 433 | lookups = [] 434 | for _ in __traverse_json(data,''): 435 | lookups.append(_); 436 | for l in lookups: 437 | for rawPath,lookup in l.items(): 438 | Items = re.split(r'/',rawPath) 439 | if Items[0] == '': 440 | Items.pop(0) 441 | 442 | # What's it values? 443 | element_path = None 444 | path = [] 445 | for i in Items: 446 | if(element_path == None): 447 | element_path = data[i] 448 | else: 449 | element_path = element_path[i] 450 | path.append(i) 451 | 452 | if isinstance(element_path,list): 453 | data = __replace_vars_factory(data,path,element_path,'list') 454 | else: 455 | data = __replace_vars_factory(data,path,element_path,'single') 456 | 457 | return data 458 | 459 | 460 | def show(data): 461 | """Shows the results of JSON processing from a config data 462 | passing the 'process' resultant dictionary on the screen 463 | 464 | Parameters 465 | ---------- 466 | data : dictionary 467 | The dictionary generated after 'process' 468 | function call 469 | 470 | Returns 471 | ------- 472 | Nothing 473 | 474 | 475 | """ 476 | print(str(json.dumps(data,indent=4,sort_keys=True))) 477 | 478 | 479 | def __remove_comments_single(line): 480 | """Removes the comments from a single line string. 481 | 482 | """ 483 | # If a '#' character is between a valid JSON string, it will be ignored. Otherwise, 484 | # all characters after '#' character will be removed from the string 485 | if (re.search(r'^.*?#.+?$', line) and \ 486 | not re.search(r'("|\').*?#.*?("|\')', line)) or \ 487 | re.search(r'^[^\'"]*#', line): 488 | line = re.sub(r'^(.*?)#.+?$', r'\1', line) 489 | 490 | return line 491 | 492 | def __remove_comments_multilines(lines): 493 | """Break the multiline string into a single line string and applies their 494 | __remove_comments function. 495 | 496 | """ 497 | more_lines = re.split(r'(\r\n|\n\r|\n|\r)', lines) 498 | removed = [] 499 | for line in more_lines: 500 | line = __remove_comments_single(line) 501 | removed.append(line) 502 | result = lines 503 | 504 | if len(removed) > 0: 505 | result = "".join(removed) 506 | return result 507 | 508 | 509 | def __remove_comments(lines): 510 | """Removes the comment using '#' character as reference, considering the possibility 511 | to have the '#' inside an valid string on JSON structure. Returns a string 512 | without comments. 513 | 514 | Parameters 515 | ---------- 516 | 517 | lines (str): line string to remove comments. 518 | 519 | 520 | Returns 521 | ------- 522 | 523 | A string without comments 524 | 525 | """ 526 | if re.search(r'(\n|\r|\r\n|\n\r)', lines): 527 | line = __remove_comments_multilines(lines) 528 | 529 | else: 530 | line = __remove_comments_single(lines) 531 | 532 | return line 533 | 534 | def process(json_string=None,file=None): 535 | """Reads the JSON from file or string. Then, iterates the processing 536 | using __analyze and __check_results internal functions to evaluate if 537 | there is some variable in deep structure needs to be replaced and/or 538 | if the times to try is over or not. 539 | 540 | Returns a dictionary with all data processed. 541 | 542 | 543 | Parameters 544 | ---------- 545 | json_string : str or None 546 | 547 | file : str or None 548 | 549 | 550 | Returns 551 | ------- 552 | A dictionary with processed config data 553 | 554 | 555 | Exceptions 556 | ---------- 557 | 558 | ValueError 559 | When JSON reading fails. 560 | 561 | LimitException 562 | When iterations exceeds the iterations times limits(max 5x) 563 | 564 | InvalidParam 565 | When 'json_string' and 'file' params are not set 566 | 567 | """ 568 | data = None 569 | 570 | # Checking parameters 571 | if not json_string and not file: 572 | raise InvalidParam("No input data! You must define 'json_string' or 'file' parameter") 573 | 574 | # The file parameter has precedence over json_string parameter 575 | if file is not None: 576 | data = {} 577 | tmp_file = f"{file}.tmp" 578 | # Removing comments from file 579 | with open(file) as f, open(tmp_file, 'w') as f2: 580 | for line in f: 581 | line = __remove_comments(line) 582 | f2.write(line) 583 | f2.close() 584 | 585 | #Loading JSON from new file 586 | with open(tmp_file) as f: 587 | data = json.load(f) 588 | 589 | else: 590 | try: 591 | # Removing comments 592 | json_string = __remove_comments(json_string) 593 | 594 | # Loading JSON 595 | data = json.loads(json_string) 596 | except ValueError as e: 597 | print("JSON error! {}".format(str(e))) 598 | raise 599 | 600 | # Because of random key acess, some variables could not be processed. So, 601 | # must run again until this happens. But a limit of 5 iterations was defined 602 | # to avoid infinit recursion. 603 | data = __analyze(data) 604 | if not __check_result(data): 605 | limit = 5 606 | curr_time = 0 607 | while not __check_result(data): 608 | data = __analyze(data) 609 | if curr_time >= limit: 610 | raise LimitException("Fatal! Can't process this data! Please, report this issue sending the config data!") 611 | curr_time += 1 612 | 613 | return data 614 | 615 | 616 | if __name__ == '__main__': 617 | pass 618 | 619 | 620 | class LimitException(Exception): 621 | def __init__(self,*args,**kwargs): 622 | Exception.__init__(self,*args,**kwargs) 623 | -------------------------------------------------------------------------------- /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 | . 675 | --------------------------------------------------------------------------------