├── .gitignore ├── babel.cfg ├── requirements.txt ├── README.md ├── octoprint_customControl ├── static │ ├── css │ │ └── customControls.css │ ├── less │ │ └── customControls.less │ └── js │ │ ├── customControlDialog.js │ │ └── customControl.js ├── __init__.py └── templates │ ├── customControl_hookedsettings.jinja2 │ └── customControl.jinja2 ├── setup.py └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | *.pyc 2 | *.swp 3 | .idea 4 | *.iml 5 | build 6 | dist 7 | *.egg* 8 | .DS_Store 9 | -------------------------------------------------------------------------------- /babel.cfg: -------------------------------------------------------------------------------- 1 | [python: */**.py] 2 | [jinja2: */**.jinja2] 3 | extensions=jinja2.ext.autoescape, jinja2.ext.with_ 4 | 5 | [javascript: */**.js] 6 | extract_messages = gettext, ngettext 7 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | ### 2 | # This file is only here to make sure that something like 3 | # 4 | # pip install -e .[develop] 5 | # 6 | # works as expected. Requirements can be found in setup.py in the 7 | # variables INSTALL_REQUIRES and EXTRA_REQUIRES. 8 | ### 9 | 10 | . 11 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # WARNING 2 | 3 | Plugin actually not in active development! 4 | 5 | 6 | ### ATTENTION 7 | Plugin still in development! 8 | 9 | # Plugin for OctoPrint - makes Custom Controls editable via settings 10 | ================================================================== 11 | 12 | This plugin helps you create, edit and delete your custom controls. 13 | You can easly access all the options in the settings under customControl. 14 | 15 | Right-Click on a Control or the Green box to open a context menu. 16 | 17 | By using the container elements you can easly position the controls where you want. 18 | 19 | ## Setup 20 | 21 | Install the plugin like you would install any regular Python package from source: 22 | 23 | pip install https://github.com/Salandora/octoprint-customControl/archive/master.zip 24 | 25 | Make sure you use the same Python environment that you installed OctoPrint under, otherwise the plugin 26 | won't be able to satisfy its dependencies. 27 | -------------------------------------------------------------------------------- /octoprint_customControl/static/css/customControls.css: -------------------------------------------------------------------------------- 1 | #customControls .innerSortable { 2 | width: 100%; 3 | min-height: 50px; 4 | } 5 | #customControls .custom_section_horizontal > .custom_control { 6 | display: inline-block; 7 | } 8 | #customControls .custom_section_vertical > .custom_control { 9 | display: block; 10 | } 11 | #customControls .custom_section_vertical_section { 12 | min-width: 15px; 13 | min-height: 15px; 14 | border: 1px dashed #000000; 15 | } 16 | #customControls .slider.slider-disabled .slider-track { 17 | cursor: default !important; 18 | } 19 | #customControls input[disabled] { 20 | background: #fff !important; 21 | cursor: text !important; 22 | } 23 | #customControls .btn-group { 24 | margin-bottom: 10px; 25 | } 26 | #customControls .btn-group.distance > .btn { 27 | width: 43px; 28 | padding: 3px 0; 29 | height: 30px; 30 | } 31 | #customControls .slider-handle { 32 | width: 14px; 33 | height: 14px; 34 | margin-left: -7px; 35 | margin-top: -3px; 36 | } 37 | #customControls .custom_section h1 { 38 | cursor: pointer; 39 | display: block; 40 | width: 100%; 41 | padding: 0; 42 | margin-bottom: 10px; 43 | font-size: 21px; 44 | line-height: 40px; 45 | color: #333; 46 | border: 0; 47 | border-bottom: 1px solid #E5E5E5; 48 | font-weight: normal; 49 | } 50 | #customControls .custom_control .slider { 51 | margin-left: 10px; 52 | margin-right: 10px; 53 | margin-bottom: 2px; 54 | } 55 | -------------------------------------------------------------------------------- /octoprint_customControl/static/less/customControls.less: -------------------------------------------------------------------------------- 1 | #customControls { 2 | .innerSortable { 3 | width: 100%; 4 | min-height: 50px; 5 | } 6 | 7 | .custom_section_horizontal > .custom_control { 8 | display:inline-block; 9 | } 10 | 11 | .custom_section_vertical > .custom_control { 12 | display:block; 13 | } 14 | .custom_section_vertical_section { 15 | min-width:15px; 16 | min-height:15px; 17 | 18 | border:1px dashed #000000; 19 | } 20 | 21 | .slider.slider-disabled .slider-track { 22 | cursor: default !important; 23 | } 24 | 25 | input[disabled] { 26 | background: #fff !important; 27 | cursor: text !important; 28 | } 29 | 30 | .btn-group { 31 | margin-bottom: 10px; 32 | } 33 | 34 | .btn-group.distance > .btn { 35 | width: 43px; 36 | padding: 3px 0; 37 | height: 30px; 38 | } 39 | 40 | .slider-handle { 41 | width: 14px; 42 | height: 14px; 43 | margin-left: -7px; 44 | margin-top: -3px; 45 | } 46 | 47 | .custom_section { 48 | h1 { 49 | cursor: pointer; 50 | display: block; 51 | width: 100%; 52 | padding: 0; 53 | margin-bottom: 10px; 54 | font-size: 21px; 55 | line-height: 40px; 56 | color: #333; 57 | border: 0; 58 | border-bottom: 1px solid #E5E5E5; 59 | font-weight: normal; 60 | } 61 | } 62 | .custom_control { 63 | .slider { 64 | margin-left: 10px; 65 | margin-right: 10px; 66 | margin-bottom: 2px; 67 | } 68 | } 69 | } -------------------------------------------------------------------------------- /octoprint_customControl/__init__.py: -------------------------------------------------------------------------------- 1 | # coding=utf-8 2 | from __future__ import absolute_import 3 | 4 | __author__ = "Marc Hannappel " 5 | __license__ = 'GNU Affero General Public License http://www.gnu.org/licenses/agpl.html' 6 | 7 | from octoprint.settings import settings 8 | 9 | import octoprint.plugin 10 | 11 | 12 | class CustomControlPlugin(octoprint.plugin.SettingsPlugin, 13 | octoprint.plugin.TemplatePlugin, 14 | octoprint.plugin.AssetPlugin): 15 | def get_template_configs(self): 16 | if "editorcollection" in self._plugin_manager.enabled_plugins: 17 | return [ 18 | dict(type="plugin_editorcollection_EditorCollection", template="customControl_hookedsettings.jinja2", 19 | custom_bindings=True) 20 | ] 21 | else: 22 | return [ 23 | dict(type="settings", template="customControl_hookedsettings.jinja2", custom_bindings=True) 24 | ] 25 | 26 | def on_settings_load(self): 27 | return dict( 28 | controls=settings().get(["controls"]) 29 | ) 30 | 31 | def on_settings_save(self, data): 32 | settings().set(["controls"], data["controls"]) 33 | 34 | def get_assets(self): 35 | return dict( 36 | js=[ 37 | "js/jquery.ui.sortable.js", 38 | "js/customControl.js", 39 | "js/customControlDialog.js", 40 | ], 41 | css=["css/customControls.css"], 42 | less=["less/customControls.less"] 43 | ) 44 | 45 | def get_update_information(self): 46 | return dict( 47 | customcontrol=dict( 48 | displayName="Custom Control Editor Plugin", 49 | displayVersion=self._plugin_version, 50 | 51 | # version check: github repository 52 | type="github_release", 53 | user="Salandora", 54 | repo="octoprint-customControl", 55 | current=self._plugin_version, 56 | 57 | # update method: pip 58 | pip="https://github.com/Salandora/octoprint-customControl/archive/{target_version}.zip" 59 | ) 60 | ) 61 | 62 | 63 | __plugin_name__ = "Custom Control Editor" 64 | __plugin_pythoncompat__ = ">=2.7,<4" 65 | 66 | 67 | def __plugin_load__(): 68 | global __plugin_implementation__ 69 | __plugin_implementation__ = CustomControlPlugin() 70 | 71 | global __plugin_hooks__ 72 | __plugin_hooks__ = { 73 | "octoprint.plugin.softwareupdate.check_config": __plugin_implementation__.get_update_information 74 | } 75 | 76 | global __plugin_license__ 77 | __plugin_license__ = "AGPLv3" 78 | -------------------------------------------------------------------------------- /octoprint_customControl/templates/customControl_hookedsettings.jinja2: -------------------------------------------------------------------------------- 1 |

{{ _('Control') }}

2 | 3 |
4 |
5 | 6 | 7 | 8 | 9 | 14 | 33 | 47 | 48 | 49 | 54 | 60 | 77 | 84 | 95 | 98 | 101 | -------------------------------------------------------------------------------- /octoprint_customControl/templates/customControl.jinja2: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /octoprint_customControl/static/js/customControlDialog.js: -------------------------------------------------------------------------------- 1 | $(function () { 2 | function customControlDialogViewModel(parameters) { 3 | var self = this; 4 | 5 | self.element = ko.observable(); 6 | 7 | self.title = ko.observable(gettext("Create Container")); 8 | self.type = ko.observable("container"); 9 | 10 | self.useInputs = ko.observable(false); 11 | self.useConfirm = ko.observable(false); 12 | self.useOutput = ko.observable(false); 13 | self.useJavaScript = ko.observable(false); 14 | self.useEnabled = ko.observable(false); 15 | 16 | self.layouts = ko.observableArray([ 17 | { name: gettext("Vertical"), key: "vertical" }, 18 | { name: gettext("Horizontal"), key: "horizontal" }, 19 | { name: gettext("Horizontal grid"), key: "horizontal_grid" } 20 | ]); 21 | self.types = ko.observableArray([ 22 | { name: gettext("Container"), key: "container" }, 23 | { name: gettext("Command"), key: "command" }, 24 | { name: gettext("Script"), key: "script" }, 25 | { name: gettext("Output"), key: "output" }, 26 | ]); 27 | 28 | self.hasSlider = ko.computed(function () { 29 | if (self.element() == undefined || self.element().input == undefined) 30 | return false; 31 | 32 | var inputs = self.element().input() 33 | for(var i = 0; i < inputs.length; i++) 34 | { 35 | if (inputs[i].hasOwnProperty("slider")) { 36 | if (typeof inputs[i].slider == "object") 37 | return true; 38 | } 39 | } 40 | return false; 41 | }); 42 | self.span = function(parameter) { 43 | return ko.computed(function () { 44 | if (self.hasSlider()) 45 | return "span2"; 46 | 47 | switch (parameter) { 48 | case "name": 49 | case "parameter": 50 | return "span4"; 51 | case "default": 52 | return "span3"; 53 | } 54 | 55 | return "span2"; 56 | }); 57 | } 58 | 59 | self.reset = function (data) { 60 | var element = { 61 | name: undefined, 62 | collapsed: false, 63 | commands: "", 64 | confirm: "", 65 | defaultValue: "", 66 | script: "", 67 | javascript: "", 68 | enabled: "", 69 | input: [], 70 | layout: "vertical", 71 | regex: "", 72 | template: "", 73 | confirm: "", 74 | width: "2", 75 | offset: "", 76 | parent: undefined 77 | }; 78 | 79 | if (typeof data == "object") { 80 | element = _.extend(element, data); 81 | 82 | self.useConfirm(data.hasOwnProperty("confirm")); 83 | self.useInputs(data.hasOwnProperty("input")); 84 | self.useOutput(data.hasOwnProperty("template")); 85 | } 86 | 87 | self.element(ko.mapping.fromJS(element)); 88 | } 89 | self.show = function (f) { 90 | var dialog = $("#customControlDialog"); 91 | var primarybtn = $('div.modal-footer .btn-primary', dialog); 92 | 93 | primarybtn.unbind('click').bind('click', function (e) { 94 | var obj = ko.mapping.toJS(self.element()); 95 | 96 | var el = {}; 97 | switch (self.type()) { 98 | case "container": { 99 | el.name = obj.name; 100 | el.layout = obj.layout; 101 | el.collapsed = obj.collapsed; 102 | 103 | el.children = []; 104 | break; 105 | } 106 | case "command": { 107 | el.name = obj.name; 108 | if (obj.commands.indexOf('\n') == -1) 109 | el.command = obj.commands; 110 | else 111 | el.commands = obj.commands.split('\n'); 112 | 113 | if (self.useConfirm()) { 114 | el.confirm = obj.confirm; 115 | } 116 | 117 | if (self.useInputs()) { 118 | var attributeToInt = function (obj, key, def) { 119 | if (obj.hasOwnProperty(key)) { 120 | var val = obj[key]; 121 | if (_.isNumber(val)) { 122 | return val; 123 | } 124 | 125 | var parsedVal = parseInt(val); 126 | if (!isNaN(parsedVal)) { 127 | return parsedVal; 128 | } 129 | } 130 | return def; 131 | }; 132 | 133 | el.input = []; 134 | _.each(obj.input, function (element, index, list) { 135 | var input = { 136 | name: element.name, 137 | parameter: element.parameter, 138 | default: element.defaultValue 139 | }; 140 | if (element.hasOwnProperty("slider") && element.slider != false) { 141 | input["slider"] = { 142 | }; 143 | 144 | input.default = attributeToInt(element, "defaultValue", undefined); 145 | 146 | if (element.slider.hasOwnProperty("min") && element.slider.min != "") 147 | input.slider.min = element.slider.min; 148 | if (element.slider.hasOwnProperty("max") && element.slider.max != "") 149 | input.slider.max = element.slider.max; 150 | if (element.slider.hasOwnProperty("step") && element.slider.step != "") 151 | input.slider.step = element.slider.step; 152 | } 153 | 154 | el.input.push(input); 155 | }); 156 | } 157 | 158 | if (self.useOutput()) { 159 | el.template = obj.template; 160 | el.regex = obj.regex; 161 | el.default = obj.defaultValue; 162 | } 163 | break; 164 | } 165 | case "script": 166 | { 167 | el.name = obj.name; 168 | el.script = obj.script; 169 | 170 | if (self.useConfirm()) { 171 | el.confirm = obj.confirm; 172 | } 173 | 174 | if (self.useInputs()) { 175 | el.input = []; 176 | _.each(obj.input, function (element, index, list) { 177 | var input = { 178 | name: element.name, 179 | parameter: element.parameter, 180 | defaultValue: !isNaN(element.defaultValue) ? element.defaultValue : undefined 181 | }; 182 | if (element.hasOwnProperty("slider") && element.slider != false) { 183 | input["slider"] = { 184 | }; 185 | 186 | input.defaultValue = !isNaN(element.defaultValue) && element.defaultValue != undefined && element.defaultValue != "" ? parseInt(element.defaultValue) : undefined; 187 | 188 | if (element.slider.min != "") 189 | input.slider.min = parseInt(element.slider.min); 190 | if (element.slider.max != "") 191 | input.slider.max = parseInt(element.slider.max); 192 | if (element.slider.step != "") 193 | input.slider.step = parseInt(element.slider.step); 194 | } 195 | 196 | el.input.push(input); 197 | }); 198 | } 199 | break; 200 | } 201 | case "output": { 202 | el.template = obj.template; 203 | el.regex = obj.regex; 204 | el.defaultValue = obj.defaultValue; 205 | break; 206 | } 207 | } 208 | 209 | el.width = obj.width; 210 | el.offset = obj.offset; 211 | 212 | f(el); 213 | }); 214 | 215 | dialog.modal({ 216 | show: 'true', 217 | backdrop: 'static', 218 | keyboard: false 219 | }); 220 | } 221 | 222 | self.removeInput = function (data) { 223 | self.element().input.remove(data); 224 | } 225 | self.addInput = function () { 226 | var obj = { 227 | name: ko.observable(""), 228 | parameter: ko.observable(""), 229 | defaultValue: ko.observable(""), 230 | slider: false 231 | } 232 | 233 | self.element().input.push(obj); 234 | } 235 | self.addSliderInput = function () { 236 | var obj = { 237 | name: ko.observable(""), 238 | parameter: ko.observable(""), 239 | defaultValue: ko.observable(), 240 | slider: { 241 | min: ko.observable(), 242 | max: ko.observable(), 243 | step: ko.observable() 244 | } 245 | } 246 | 247 | self.element().input.push(obj); 248 | } 249 | } 250 | 251 | // view model class, parameters for constructor, container to bind to 252 | OCTOPRINT_VIEWMODELS.push([ 253 | customControlDialogViewModel, 254 | [], 255 | "#customControlDialog" 256 | ]); 257 | }); -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | # coding=utf-8 2 | from setuptools import setup, Command 3 | import os 4 | 5 | ######################################################################################################################## 6 | 7 | ### Do not forget to adjust the following variables to your own plugin. 8 | 9 | # The plugin's identifier, has to be unique 10 | plugin_identifier = "customControl" 11 | 12 | # The plugin's python package, should be "octoprint_", has to be unique 13 | plugin_package = "octoprint_%s" % plugin_identifier 14 | 15 | # The plugin's human readable name. Can be overwritten within OctoPrint's internal data via __plugin_name__ in the 16 | # plugin module 17 | plugin_name = "OctoPrint-CustomControlPlugin" 18 | 19 | # The plugin's version. Can be overwritten within OctoPrint's internal data via __plugin_version__ in the plugin module 20 | plugin_version = "0.2.2" 21 | 22 | # The plugin's description. Can be overwritten within OctoPrint's internal data via __plugin_description__ in the plugin 23 | # module 24 | plugin_description = "Makes Custom Controls editable via settings" 25 | 26 | # The plugin's author. Can be overwritten within OctoPrint's internal data via __plugin_author__ in the plugin module 27 | plugin_author = "Marc Hannappel (Salandora)" 28 | 29 | # The plugin's author's mail address. 30 | plugin_author_email = "salandora@gmail.com" 31 | 32 | # The plugin's homepage URL. Can be overwritten within OctoPrint's internal data via __plugin_url__ in the plugin module 33 | plugin_url = "https://github.com/Salandora/octoprint-customControl" 34 | 35 | # The plugin's license. Can be overwritten within OctoPrint's internal data via __plugin_license__ in the plugin module 36 | plugin_license = "AGPLv3" 37 | 38 | # Additional package data to install for this plugin. The subfolders "templates", "static" and "translations" will 39 | # already be installed automatically if they exist. 40 | plugin_additional_data = [] 41 | 42 | ######################################################################################################################## 43 | 44 | # I18N setup 45 | I18N_MAPPING_FILE = "babel.cfg" 46 | I18N_DOMAIN = "messages" 47 | I18N_INPUT_DIRS = "." 48 | I18N_OUTPUT_DIR_PY = os.path.join(plugin_package, "translations") 49 | I18N_OUTPUT_DIR_JS = os.path.join(plugin_package, "static", "js", "i18n") 50 | I18N_POT_FILE = os.path.join(I18N_OUTPUT_DIR_PY, "messages.pot") 51 | 52 | # Requirements for out application 53 | INSTALL_REQUIRES = [ 54 | "OctoPrint" 55 | ] 56 | 57 | # Requirements for developing etc 58 | EXTRA_REQUIRES = dict( 59 | develop=[ 60 | # Translation dependencies 61 | "babel", 62 | "po2json" 63 | ] 64 | ) 65 | 66 | 67 | def package_data_dirs(source, sub_folders): 68 | import os 69 | dirs = [] 70 | 71 | for d in sub_folders: 72 | folder = os.path.join(source, d) 73 | if not os.path.exists(folder): 74 | continue 75 | 76 | for dirname, _, files in os.walk(folder): 77 | dirname = os.path.relpath(dirname, source) 78 | for f in files: 79 | dirs.append(os.path.join(dirname, f)) 80 | 81 | return dirs 82 | 83 | 84 | def _recursively_handle_files(directory, file_matcher, folder_handler=None, file_handler=None): 85 | applied_handler = False 86 | 87 | for filename in os.listdir(directory): 88 | path = os.path.join(directory, filename) 89 | 90 | if file_handler is not None and file_matcher(filename): 91 | file_handler(path) 92 | applied_handler = True 93 | 94 | elif os.path.isdir(path): 95 | sub_applied_handler = _recursively_handle_files(path, file_matcher, folder_handler=folder_handler, 96 | file_handler=file_handler) 97 | if sub_applied_handler: 98 | applied_handler = True 99 | 100 | if folder_handler is not None: 101 | folder_handler(path, sub_applied_handler) 102 | 103 | return applied_handler 104 | 105 | 106 | class CleanCommand(Command): 107 | description = "clean build artifacts" 108 | user_options = [] 109 | boolean_options = [] 110 | 111 | def initialize_options(self): 112 | pass 113 | 114 | def finalize_options(self): 115 | pass 116 | 117 | def run(self): 118 | import shutil 119 | import glob 120 | 121 | # build folder 122 | if os.path.exists('build'): 123 | print("Deleting build directory") 124 | shutil.rmtree('build') 125 | 126 | # eggs 127 | eggs = glob.glob("*.egg-info") 128 | for egg in eggs: 129 | print("Deleting %s directory" % egg) 130 | shutil.rmtree(egg) 131 | 132 | # pyc files 133 | def delete_folder_if_empty(path, applied_handler): 134 | if not applied_handler: 135 | return 136 | if len(os.listdir(path)) == 0: 137 | shutil.rmtree(path) 138 | print("Deleted %s since it was empty" % path) 139 | 140 | def delete_file(path): 141 | os.remove(path) 142 | print("Deleted %s" % path) 143 | 144 | import fnmatch 145 | _recursively_handle_files( 146 | os.path.abspath(plugin_package), 147 | lambda name: fnmatch.fnmatch(name.lower(), "*.pyc"), 148 | folder_handler=delete_folder_if_empty, 149 | file_handler=delete_file 150 | ) 151 | 152 | # pyc files 153 | def delete_folder_if_empty(path, applied_handler): 154 | if not applied_handler: 155 | return 156 | if len(os.listdir(path)) == 0: 157 | shutil.rmtree(path) 158 | print("Deleted %s since it was empty" % path) 159 | 160 | def delete_file(path): 161 | os.remove(path) 162 | print("Deleted %s" % path) 163 | 164 | import fnmatch 165 | _recursively_handle_files( 166 | os.path.abspath(plugin_package), 167 | lambda name: fnmatch.fnmatch(name.lower(), "*.pyc"), 168 | folder_handler=delete_folder_if_empty, 169 | file_handler=delete_file 170 | ) 171 | 172 | 173 | class NewTranslation(Command): 174 | description = "create a new translation" 175 | user_options = [ 176 | ('locale=', 'l', 'locale for the new translation'), 177 | ] 178 | boolean_options = [] 179 | 180 | def __init__(self, dist, **kw): 181 | from babel.messages import frontend as babel 182 | self.babel_init_messages = babel.init_catalog(dist) 183 | Command.__init__(self, dist, **kw) 184 | 185 | def initialize_options(self): 186 | self.locale = None 187 | self.babel_init_messages.initialize_options() 188 | 189 | def finalize_options(self): 190 | self.babel_init_messages.locale = self.locale 191 | self.babel_init_messages.input_file = I18N_POT_FILE 192 | self.babel_init_messages.output_dir = I18N_OUTPUT_DIR_PY 193 | self.babel_init_messages.finalize_options() 194 | 195 | def run(self): 196 | self.babel_init_messages.run() 197 | 198 | 199 | class ExtractTranslation(Command): 200 | description = "extract translations" 201 | user_options = [] 202 | boolean_options = [] 203 | 204 | def __init__(self, dist, **kw): 205 | from babel.messages import frontend as babel 206 | self.babel_extract_messages = babel.extract_messages(dist) 207 | Command.__init__(self, dist, **kw) 208 | 209 | def initialize_options(self): 210 | self.babel_extract_messages.initialize_options() 211 | 212 | def finalize_options(self): 213 | self.babel_extract_messages.mapping_file = I18N_MAPPING_FILE 214 | self.babel_extract_messages.output_file = I18N_POT_FILE 215 | self.babel_extract_messages.input_dirs = I18N_INPUT_DIRS 216 | self.babel_extract_messages.msgid_bugs_address = plugin_author_email 217 | self.babel_extract_messages.copyright_holder = plugin_author 218 | self.babel_extract_messages.finalize_options() 219 | 220 | def run(self): 221 | self.babel_extract_messages.run() 222 | 223 | 224 | class RefreshTranslation(Command): 225 | description = "refresh translations" 226 | user_options = [ 227 | ('locale=', 'l', 'locale for the translation to refresh'), 228 | ] 229 | boolean_options = [] 230 | 231 | def __init__(self, dist, **kw): 232 | from babel.messages import frontend as babel 233 | self.babel_extract_messages = babel.extract_messages(dist) 234 | self.babel_update_messages = babel.update_catalog(dist) 235 | Command.__init__(self, dist, **kw) 236 | 237 | def initialize_options(self): 238 | self.locale = None 239 | self.babel_extract_messages.initialize_options() 240 | self.babel_update_messages.initialize_options() 241 | 242 | def finalize_options(self): 243 | self.babel_extract_messages.mapping_file = I18N_MAPPING_FILE 244 | self.babel_extract_messages.output_file = I18N_POT_FILE 245 | self.babel_extract_messages.input_dirs = I18N_INPUT_DIRS 246 | self.babel_extract_messages.msgid_bugs_address = plugin_author_email 247 | self.babel_extract_messages.copyright_holder = plugin_author 248 | self.babel_extract_messages.finalize_options() 249 | 250 | self.babel_update_messages.input_file = I18N_POT_FILE 251 | self.babel_update_messages.output_dir = I18N_OUTPUT_DIR_PY 252 | self.babel_update_messages.locale = self.locale 253 | 254 | def run(self): 255 | self.babel_extract_messages.run() 256 | self.babel_update_messages.run() 257 | 258 | 259 | class CompileTranslation(Command): 260 | description = "compile translations" 261 | user_options = [] 262 | boolean_options = [] 263 | 264 | def __init__(self, dist, **kw): 265 | from babel.messages import frontend as babel 266 | self.babel_compile_messages = babel.compile_catalog(dist) 267 | Command.__init__(self, dist, **kw) 268 | 269 | def initialize_options(self): 270 | self.babel_compile_messages.initialize_options() 271 | 272 | def finalize_options(self): 273 | self.babel_compile_messages.directory = I18N_OUTPUT_DIR_PY 274 | 275 | def run(self): 276 | self.babel_compile_messages.run() 277 | 278 | import po2json 279 | 280 | for lang_code in os.listdir(I18N_OUTPUT_DIR_PY): 281 | full_path = os.path.join(I18N_OUTPUT_DIR_PY, lang_code) 282 | 283 | if os.path.isdir(full_path): 284 | client_po_dir = os.path.join(full_path, "LC_MESSAGES") 285 | 286 | po2json.update_js_file( 287 | "%s/%s.po" % (client_po_dir, I18N_DOMAIN), 288 | lang_code, 289 | I18N_OUTPUT_DIR_JS, 290 | I18N_DOMAIN 291 | ) 292 | 293 | 294 | def params(): 295 | # Our metadata, as defined above 296 | name = plugin_name 297 | version = plugin_version 298 | description = plugin_description 299 | author = plugin_author 300 | author_email = plugin_author_email 301 | url = plugin_url 302 | license = plugin_license 303 | 304 | cmdclass = { 305 | 'clean': CleanCommand, 306 | 'babel_new': NewTranslation, 307 | 'babel_extract': ExtractTranslation, 308 | 'babel_refresh': RefreshTranslation, 309 | 'babel_compile': CompileTranslation 310 | }; 311 | 312 | # we only have our plugin package to install 313 | packages = [plugin_package] 314 | 315 | # we might have additional data files in sub folders that need to be installed too 316 | package_data = {plugin_package: package_data_dirs(plugin_package, 317 | ['static', 'templates', 'translations'] + plugin_additional_data)} 318 | include_package_data = True 319 | 320 | # If you have any package data that needs to be accessible on the file system, such as templates or static assets 321 | # this plugin is not zip_safe. 322 | zip_safe = False 323 | 324 | install_requires = INSTALL_REQUIRES 325 | extras_require = EXTRA_REQUIRES 326 | 327 | if os.environ.get('READTHEDOCS', None) == 'True': 328 | # we can't tell read the docs to please perform a pip install -e .[develop], so we help 329 | # it a bit here by explicitly adding the development dependencies, which include our 330 | # documentation dependencies 331 | install_requires = install_requires + extras_require['develop'] 332 | 333 | # Hook the plugin into the "octoprint.plugin" entry point, mapping the plugin_identifier to the plugin_package. 334 | # That way OctoPrint will be able to find the plugin and load it. 335 | entry_points = { 336 | "octoprint.plugin": ["%s = %s" % (plugin_identifier, plugin_package)] 337 | } 338 | 339 | return locals() 340 | 341 | 342 | setup(**params()) 343 | -------------------------------------------------------------------------------- /octoprint_customControl/static/js/customControl.js: -------------------------------------------------------------------------------- 1 | $(function () { 2 | function CustomControlViewModel(parameters) { 3 | var self = this; 4 | 5 | self.loginState = parameters[0]; 6 | self.settingsViewModel = parameters[1]; 7 | self.controlViewModel = parameters[2]; 8 | 9 | self.customControlDialogViewModel = parameters[3]; 10 | 11 | self.popup = undefined; 12 | 13 | self.controls = ko.observableArray([]); 14 | 15 | self.controlsFromServer = []; 16 | self.additionalControls = []; 17 | 18 | self.staticID = 0; 19 | 20 | self._showPopup = function (options, eventListeners) { 21 | if (self.popup !== undefined) { 22 | self.popup.remove(); 23 | } 24 | self.popup = new PNotify(options); 25 | 26 | if (eventListeners) { 27 | var popupObj = self.popup.get(); 28 | _.each(eventListeners, function (value, key) { 29 | popupObj.on(key, value); 30 | }) 31 | } 32 | }; 33 | 34 | self.onSettingsShown = function () { 35 | OctoPrint.control.getCustomControls().done(function(response) { 36 | self._fromResponse(response); 37 | }); 38 | }; 39 | 40 | self.requestData = function () { 41 | $.ajax({ 42 | url: API_BASEURL + "printer/command/custom", 43 | method: "GET", 44 | dataType: "json", 45 | success: function (response) { 46 | self._fromResponse(response); 47 | } 48 | }); 49 | }; 50 | 51 | self._fromResponse = function (response) { 52 | self.controlsFromServer = response.controls; 53 | self.rerenderControls(); 54 | }; 55 | 56 | self.rerenderControls = function () { 57 | 58 | // TODO: Brainstorming about how to handle additionalControls... 59 | 60 | self.staticID = 0; 61 | self.controls(undefined); 62 | self.controls(self._processControls(undefined, self.controlsFromServer)); 63 | 64 | $(".innerSortable").sortable({ 65 | connectWith: ".innerSortable", 66 | items: "> .sortable", 67 | cancel: '', 68 | sort: function (event, ui) { 69 | var self = $(this), 70 | width = ui.helper.outerWidth(), 71 | top = ui.helper.position().top;//changed to ; 72 | 73 | self.children().each(function () { 74 | if ($(this).hasClass('ui-sortable-helper') || $(this).hasClass('ui-sortable-placeholder')) { 75 | return true; 76 | } 77 | // If overlap is more than half of the dragged item 78 | var distance = Math.abs(ui.position.left - $(this).position().left), 79 | before = ui.position.left > $(this).position().left; 80 | 81 | if ((width - distance) > (width / 2) && (distance < width) && $(this).position().top === top) { 82 | if (before) { 83 | $('.ui-sortable-placeholder', self).insertBefore($(this)); 84 | } else { 85 | $('.ui-sortable-placeholder', self).insertAfter($(this)); 86 | } 87 | return false; 88 | } 89 | }); 90 | }, 91 | update: function(event, ui) { 92 | var target = ko.dataFor(this); 93 | var item = ko.dataFor(ui.item[0]); 94 | 95 | if (target === undefined) { 96 | return; 97 | } else { 98 | if (target === self) { 99 | if (!item.hasOwnProperty("children")) { 100 | return; 101 | } 102 | } 103 | else if (!target.hasOwnProperty("children")) { 104 | return; 105 | } 106 | } 107 | 108 | var position = ko.utils.arrayIndexOf(ui.item.parent().children(), ui.item[0]); 109 | if (position >= 0) { 110 | if (item.parent !== undefined) { 111 | item.parent.children.remove(item); 112 | 113 | if (target === self) 114 | self.controlsFromServer.splice(position, 0, item); 115 | else 116 | target.children.splice(position, 0, item); 117 | } else { 118 | self.controlsFromServer = _.without(self.controlsFromServer, item); 119 | if (target === self) 120 | self.controlsFromServer.splice(position, 0, item); 121 | else 122 | target.children.splice(position, 0, item); 123 | } 124 | } 125 | }, 126 | stop: function() { 127 | self.rerenderControls(); 128 | } 129 | }).disableSelection(); 130 | }; 131 | 132 | self._processControls = function (parent, controls) { 133 | for (var i = 0; i < controls.length; i++) { 134 | controls[i] = self._processControl(parent, controls[i]); 135 | } 136 | return controls; 137 | }; 138 | 139 | self._processInput = function (list) { 140 | var inputs = []; 141 | 142 | var attributeToInt = function (obj, key, def) { 143 | if (obj.hasOwnProperty(key)) { 144 | var val = obj[key]; 145 | if (_.isNumber(val)) { 146 | return val; 147 | } 148 | 149 | var parsedVal = parseInt(val); 150 | if (!isNaN(parsedVal)) { 151 | return parsedVal; 152 | } 153 | } 154 | return def; 155 | }; 156 | 157 | _.each(list, function (element) { 158 | var input = { 159 | name: ko.observable(element.name), 160 | parameter: ko.observable(element.parameter), 161 | default: ko.observable(element.hasOwnProperty("default") ? element.default : undefined) 162 | }; 163 | 164 | if (element.hasOwnProperty("slider") && _.isObject(element.slider)) { 165 | input.slider = { 166 | min: ko.observable(element.slider.min), 167 | max: ko.observable(element.slider.max), 168 | step: ko.observable(element.slider.step) 169 | }; 170 | 171 | var defaultValue = attributeToInt(element, "default", attributeToInt(element.slider, "min", 0)); 172 | 173 | // if default value is not within range of min and max, correct that 174 | if (!_.inRange(defaultValue, element.slider.min, element.slider.max)) { 175 | // use bound closer to configured default value 176 | defaultValue = defaultValue < element.slider.min ? element.slider.min : element.slider.max; 177 | } 178 | 179 | input.value = ko.observable(defaultValue); 180 | } 181 | else { 182 | input.slider = false; 183 | input.value = input.default; 184 | } 185 | 186 | inputs.push(input); 187 | }); 188 | 189 | return inputs; 190 | }; 191 | self._processControl = function (parent, control) { 192 | if (control.processed) { 193 | control.id("settingsCustomControl_id" + self.staticID++); 194 | } 195 | else { 196 | control.id = ko.observable("settingsCustomControl_id" + self.staticID++); 197 | } 198 | control.parent = parent; 199 | 200 | if (control.processed) { 201 | if (control.hasOwnProperty("children")) { 202 | control.children(self._processControls(control, control.children())); 203 | } 204 | 205 | return control; 206 | } 207 | 208 | if (control.hasOwnProperty("template") && control.hasOwnProperty("regex")) { 209 | control.template = ko.observable(control.template); 210 | control.regex = ko.observable(control.regex); 211 | control.default = ko.observable(control.default || ""); 212 | control.value = ko.computed(function () { return control.default(); }); 213 | 214 | delete control.key; 215 | delete control.template_key; 216 | } 217 | 218 | if (control.hasOwnProperty("children")) { 219 | control.children = ko.observableArray(self._processControls(control, control.children)); 220 | if (!control.hasOwnProperty("layout") || !(control.layout === "vertical" || control.layout === "horizontal" || control.layout === "horizontal_grid")) 221 | control.layout = ko.observable("vertical"); 222 | else 223 | control.layout = ko.observable(control.layout); 224 | 225 | if (control.hasOwnProperty("collapsed")) 226 | control.collapsed = ko.observable(control.collapsed); 227 | else 228 | control.collapsed = ko.observable(false); 229 | } 230 | 231 | if (control.hasOwnProperty("input")) { 232 | control.input = ko.observableArray(self._processInput(control.input)); 233 | } 234 | 235 | control.name = ko.observable(control.name || ""); 236 | 237 | control.width = ko.observable(control.hasOwnProperty("width") ? control.width : "2"); 238 | control.offset = ko.observable(control.hasOwnProperty("offset") ? control.offset : ""); 239 | 240 | var js; 241 | if (control.hasOwnProperty("javascript")) { 242 | control.javascript = control.javascript; 243 | } 244 | 245 | if (control.hasOwnProperty("enabled")) { 246 | control.enabled = control.enabled; 247 | } 248 | 249 | control.processed = true; 250 | return control; 251 | }; 252 | 253 | self.displayMode = function (customControl) { 254 | if (customControl.hasOwnProperty("children")) { 255 | return (customControl.hasOwnProperty("name") && customControl.name() !== "") ? "settingsCustomControls_containerTemplate_collapsable" : "settingsCustomControls_containerTemplate_nameless"; 256 | } else { 257 | return "settingsCustomControls_controlTemplate"; 258 | } 259 | }; 260 | 261 | self.rowCss = function (customControl) { 262 | var span = "span2"; 263 | var offset = ""; 264 | if (customControl.hasOwnProperty("width") && customControl.width() !== "") { 265 | span = "span" + customControl.width(); 266 | } 267 | if (customControl.hasOwnProperty("offset") && customControl.offset() !== "") { 268 | offset = "offset" + customControl.offset(); 269 | } 270 | return "sortable " + span + " " + offset; 271 | }; 272 | 273 | self.searchElement = function (list, id) { 274 | for (var i = 0; i < list.length; i++) 275 | { 276 | if (list[i].id() === id) 277 | return list[i]; 278 | 279 | if (list[i].hasOwnProperty("children")) { 280 | var element = self.searchElement(list[i].children(), id); 281 | if (element !== undefined) 282 | return element; 283 | } 284 | } 285 | 286 | return undefined; 287 | }; 288 | 289 | self.createElement = function (invokedOn, contextParent) { 290 | if (contextParent.attr('id') === "base") { 291 | self.customControlDialogViewModel.reset(); 292 | 293 | self.customControlDialogViewModel.show(function (ret) { 294 | self.controlsFromServer.push(ret); 295 | self.rerenderControls(); 296 | }); 297 | } 298 | else { 299 | var parentElement = self.searchElement(self.controlsFromServer, contextParent.attr('id')); 300 | if (parentElement === undefined) { 301 | self._showPopup({ 302 | title: gettext("Something went wrong while creating the new Element"), 303 | type: "error" 304 | }); 305 | return; 306 | } 307 | 308 | self.customControlDialogViewModel.reset({ parent: parentElement }); 309 | 310 | self.customControlDialogViewModel.show(function (ret) { 311 | parentElement.children.push(self._processControl(parentElement, ret)); 312 | }); 313 | } 314 | }; 315 | self.deleteElement = function (invokedOn, contextParent) { 316 | var element = self.searchElement(self.controlsFromServer, contextParent.attr('id')); 317 | if (element === undefined) { 318 | self._showPopup({ 319 | title: gettext("Something went wrong while creating the new Element"), 320 | type: "error" 321 | }); 322 | return; 323 | } 324 | 325 | showConfirmationDialog("", function (e) { 326 | if (element.parent !== undefined) 327 | element.parent.children.remove(element); 328 | else { 329 | self.controlsFromServer = _.without(self.controlsFromServer, element); 330 | self.rerenderControls(); 331 | } 332 | }); 333 | }; 334 | self.editElement = function (invokedOn, contextParent) { 335 | var element = self.element = self.searchElement(self.controlsFromServer, contextParent.attr('id')); 336 | if (element === undefined) { 337 | self._showPopup({ 338 | title: gettext("Something went wrong while creating the new Element"), 339 | type: "error" 340 | }); 341 | return; 342 | } 343 | 344 | var title = "Edit Container"; 345 | var type = "container"; 346 | var data = { 347 | parent: element.parent 348 | }; 349 | 350 | if (element.hasOwnProperty("name")) { 351 | data.name = element.name(); 352 | } 353 | if (element.hasOwnProperty("template")) { 354 | data.template = element.template(); 355 | data.regex = element.regex(); 356 | data.defaultValue = element.default() || ""; 357 | 358 | title = "Edit Output"; 359 | type = "output"; 360 | } 361 | if (element.hasOwnProperty("layout")) { 362 | data.layout = element.layout(); 363 | data.collapsed = element.collapsed(); 364 | 365 | title = "Edit Container"; 366 | type = "container"; 367 | } 368 | if (element.hasOwnProperty("command")) { 369 | data.commands = element.command; 370 | 371 | title = "Edit Command"; 372 | type = "command"; 373 | } 374 | if (element.hasOwnProperty("commands")) { 375 | var commands = ""; 376 | _.each(element.commands, function (e, index, list) { 377 | commands += e; 378 | if (index < list.length) 379 | commands += '\n'; 380 | }); 381 | data.commands = commands; 382 | 383 | title = "Edit Command"; 384 | type = "command"; 385 | } 386 | if (element.hasOwnProperty("script")) { 387 | data.script = element.script; 388 | 389 | title = "Edit Script command"; 390 | type = "script"; 391 | } 392 | if (element.hasOwnProperty("confirm")) { 393 | data.confirm = element.confirm; 394 | } 395 | if (element.hasOwnProperty("input")) 396 | { 397 | data.input = []; 398 | _.each(element.input(), function (element, index, list) { 399 | data.input[index] = ko.mapping.toJS(element); 400 | if (element.hasOwnProperty("default")) { 401 | data.input[index].defaultValue = element.default; 402 | } 403 | }); 404 | } 405 | 406 | if (element.hasOwnProperty("width")) { 407 | data.width = element.width(); 408 | } 409 | if (element.hasOwnProperty("offset")) { 410 | data.offset = element.offset(); 411 | } 412 | 413 | self.customControlDialogViewModel.reset(data); 414 | self.customControlDialogViewModel.title(gettext(title)); 415 | self.customControlDialogViewModel.type(type); 416 | 417 | self.customControlDialogViewModel.show(function (ret) { 418 | var element = self.element; 419 | 420 | switch (self.customControlDialogViewModel.type()) { 421 | case "container": { 422 | element.name(ret.name); 423 | element.layout(ret.layout); 424 | element.collapsed(ret.collapsed); 425 | break; 426 | } 427 | case "command": { 428 | element.name(ret.name); 429 | 430 | if (ret.command !== undefined) { 431 | element.command = ret.command; 432 | delete element.commands; 433 | } 434 | if (ret.commands !== undefined) { 435 | element.commands = ret.commands; 436 | delete element.command; 437 | } 438 | 439 | if (ret.confirm !== "") { 440 | element.confirm = ret.confirm; 441 | } 442 | 443 | if (ret.input !== undefined) { 444 | _.each(ret.input, function (element, index) { 445 | data.input[index] = ko.mapping.toJS(element); 446 | }); 447 | 448 | element.input(self._processInput(ret.input)); 449 | } 450 | else 451 | delete element.input; 452 | 453 | // Command can also be a output 454 | if (ret.hasOwnProperty("template")) { 455 | if (element.hasOwnProperty("template")) 456 | element.template(ret.template); 457 | else 458 | element.template = ko.observable(ret.template); 459 | 460 | if (element.hasOwnProperty("regex")) 461 | element.regex(ret.regex); 462 | else 463 | element.regex = ko.observable(ret.regex); 464 | 465 | if (element.hasOwnProperty("default")) 466 | element.default(ret.default); 467 | else 468 | element.default = ko.observable(ret.default); 469 | } 470 | else 471 | { 472 | if (element.hasOwnProperty("default")) 473 | element.default(undefined); 474 | 475 | delete element.template; 476 | delete element.regex; 477 | delete element.default; 478 | } 479 | break; 480 | } 481 | case "script": { 482 | element.name(ret.name); 483 | element.script = ret.script; 484 | 485 | if (ret.confirm !== "") { 486 | element.confirm = ret.confirm; 487 | } 488 | 489 | if (ret.input !== undefined) { 490 | element.input(self._processInput(ret.input)); 491 | } 492 | else 493 | delete element.input; 494 | 495 | break; 496 | } 497 | case "output": { 498 | element.template(ret.template); 499 | element.regex(ret.regex); 500 | element.default(ret.defaultValue); 501 | break; 502 | } 503 | } 504 | 505 | if (element.parent && element.parent.layout() === "horizontal_grid") { 506 | if (ret.width !== undefined && ret.width !== "") 507 | element.width(ret.width); 508 | 509 | if (ret.offset !== undefined && ret.offset !== "") 510 | element.offset(ret.offset); 511 | } 512 | }); 513 | }; 514 | 515 | self.controlContextMenu = function (invokedOn, contextParent, selectedMenu) 516 | { 517 | switch (selectedMenu.attr('cmd')) { 518 | case "editElement": { 519 | self.editElement(invokedOn, contextParent, selectedMenu); 520 | break; 521 | } 522 | case "deleteElement": { 523 | self.deleteElement(invokedOn, contextParent, selectedMenu); 524 | break; 525 | } 526 | default: { 527 | if (selectedMenu.attr('cmd').startsWith("create")) { 528 | switch (selectedMenu.attr('cmd')) { 529 | case "createContainer": { 530 | self.customControlDialogViewModel.title(gettext("Create container")); 531 | self.customControlDialogViewModel.type("container"); 532 | break; 533 | } 534 | case "createCommand": { 535 | self.customControlDialogViewModel.title(gettext("Create Command")); 536 | self.customControlDialogViewModel.type("command"); 537 | break; 538 | } 539 | case "createScript": { 540 | self.customControlDialogViewModel.title(gettext("Create Script")); 541 | self.customControlDialogViewModel.type("script"); 542 | break; 543 | } 544 | case "createOutput": { 545 | self.customControlDialogViewModel.title(gettext("Create Output")); 546 | self.customControlDialogViewModel.type("output"); 547 | break; 548 | } 549 | } 550 | 551 | self.createElement(invokedOn, contextParent, selectedMenu); 552 | } 553 | break; 554 | } 555 | } 556 | }; 557 | 558 | self.editStyle = function (type) { 559 | }; 560 | 561 | self.recursiveDeleteProperties = function (list) { 562 | _.each(list, function (element) { 563 | if (!element.parent || (element.parent.hasOwnProperty("layout") && element.parent.layout() !== "horizontal_grid")) { 564 | delete element.width; 565 | delete element.offset; 566 | } 567 | 568 | if (element.default === "") 569 | delete element.default; 570 | 571 | delete element.id; 572 | delete element.parent; 573 | delete element.processed; 574 | delete element.output; 575 | delete element.key; 576 | delete element.template_key; 577 | delete element.value; 578 | 579 | if (element.hasOwnProperty("input")) { 580 | _.each(element.input(), function (e, i, l) { 581 | if (e.default === "") 582 | delete e.default; 583 | 584 | delete e.value; 585 | }); 586 | } 587 | 588 | if (element.hasOwnProperty("width") && element.width() === "") 589 | delete element.width; 590 | if (element.hasOwnProperty("offset") && element.offset() === "") 591 | delete element.offset; 592 | 593 | if (!element.hasOwnProperty("name") || element.name() === "") { 594 | delete element.name; 595 | delete element.collapsed; 596 | } 597 | 598 | 599 | if (element.hasOwnProperty("children")) { 600 | if (element.hasOwnProperty("collapsed") && !element.collapsed()) 601 | delete element.collapsed; 602 | 603 | self.recursiveDeleteProperties(element.children()); 604 | } 605 | }); 606 | }; 607 | self.onSettingsBeforeSave = function () { 608 | self.recursiveDeleteProperties(self.controlsFromServer); 609 | self.settingsViewModel.settings.plugins.customControl.controls = self.controlsFromServer; 610 | }; 611 | 612 | self.onEventSettingsUpdated = function () { 613 | self.requestData(); 614 | } 615 | } 616 | 617 | // view model class, parameters for constructor, container to bind to 618 | OCTOPRINT_VIEWMODELS.push([ 619 | CustomControlViewModel, 620 | ["loginStateViewModel", "settingsViewModel", "controlViewModel", "customControlDialogViewModel"], 621 | "#settings_plugin_customControl" 622 | ]); 623 | }); -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 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 Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published by 637 | the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | --------------------------------------------------------------------------------