├── .gitattributes ├── .eslintignore ├── generators └── app │ ├── templates │ ├── conf │ │ ├── app │ │ │ └── .gitkeep │ │ └── nginx.conf │ ├── scripts │ │ ├── docker │ │ │ ├── docker-compose.yml │ │ │ ├── load.sh │ │ │ ├── save.sh │ │ │ ├── _specificvariablesapp.sh │ │ │ ├── rm.sh │ │ │ └── run.sh │ │ ├── _dockertest.sh │ │ ├── remove │ │ ├── backup │ │ ├── restore │ │ ├── upgrade │ │ ├── install │ │ └── _common.sh │ ├── README.md │ ├── check_process │ ├── manifest.json │ └── LICENSE │ └── index.js ├── .gitignore ├── .travis.yml ├── .yo-rc.json ├── .editorconfig ├── __tests__ └── app.js ├── package.json ├── README.md └── LICENSE /.gitattributes: -------------------------------------------------------------------------------- 1 | * text=auto 2 | -------------------------------------------------------------------------------- /.eslintignore: -------------------------------------------------------------------------------- 1 | coverage 2 | **/templates 3 | -------------------------------------------------------------------------------- /generators/app/templates/conf/app/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | coverage 3 | cache 4 | -------------------------------------------------------------------------------- /generators/app/templates/scripts/docker/docker-compose.yml: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /generators/app/templates/scripts/docker/load.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | -------------------------------------------------------------------------------- /generators/app/templates/scripts/docker/save.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: node_js 2 | node_js: 3 | - 7 4 | - 6 5 | - 4 6 | after_script: 'cat ./coverage/lcov.info | coveralls' 7 | -------------------------------------------------------------------------------- /generators/app/templates/scripts/docker/_specificvariablesapp.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | #example : 4 | # 5 | #. _common.sh 6 | # 7 | -------------------------------------------------------------------------------- /generators/app/templates/scripts/docker/rm.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # example : 4 | # 5 | #docker rm -f $app 1>&2 6 | #echo $? 7 | -------------------------------------------------------------------------------- /generators/app/templates/scripts/_dockertest.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # test docker install 4 | docker ps >/dev/null 2>&1 5 | echo $? 6 | -------------------------------------------------------------------------------- /.yo-rc.json: -------------------------------------------------------------------------------- 1 | { 2 | "generator-node": { 3 | "promptValues": { 4 | "authorName": "aymhce", 5 | "authorEmail": "aymhce@gmail.com", 6 | "authorUrl": "" 7 | } 8 | } 9 | } -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | indent_style = space 5 | indent_size = 2 6 | charset = utf-8 7 | trim_trailing_whitespace = true 8 | insert_final_newline = true 9 | 10 | [*.md] 11 | trim_trailing_whitespace = false 12 | -------------------------------------------------------------------------------- /generators/app/templates/conf/nginx.conf: -------------------------------------------------------------------------------- 1 | #sub_path_only rewrite ^__PATH__$ __PATH__/ permanent; 2 | location __PATH__ { 3 | 4 | proxy_pass <%= reverseProxyProtocol %>://localhost:__PORT__; 5 | proxy_read_timeout 30s; 6 | 7 | # Include SSOWAT user panel. 8 | include conf.d/yunohost_panel.conf.inc; 9 | } 10 | -------------------------------------------------------------------------------- /generators/app/templates/README.md: -------------------------------------------------------------------------------- 1 | <%= beautifulName %> for Yunohost 2 | ========== 3 | 4 | [![Install <%= beautifulName %> with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=<%= idName %>) 5 | 6 | <%= enDescription %> 7 | 8 | **[See more](<%= urlApp %>)** 9 | 10 | This app is inside a [Docker image](<%= urlDockerHub %>). 11 | 12 | ----------------- 13 | 14 | *It was generated with [DockerApp Yunohost](https://github.com/aymhce/dockerappmodel_ynh/)* 15 | -------------------------------------------------------------------------------- /generators/app/templates/scripts/docker/run.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # example : 4 | # 5 | #[ "$architecture" == "amd64" ] && image=portainer/portainer:1.14.0 6 | #[ "$architecture" == "i386" ] && image=portainer/portainer:linux-386-1.14.0 7 | #[ "$architecture" == "armhf" ] && image=portainer/portainer:linux-arm-1.14.0 8 | #[ -z $image ] && ynh_die "Sorry, your $architecture architecture is not supported ..." 9 | # 10 | #options="-p $port:9000 -v $data_path/data:/data" 11 | # 12 | #docker run -d --name=$app --restart always $options $image 1>&2 13 | #echo $? 14 | -------------------------------------------------------------------------------- /generators/app/templates/check_process: -------------------------------------------------------------------------------- 1 | # See here for more informations 2 | # https://github.com/YunoHost/package_check#syntax-check_process-file 3 | 4 | ;; Test complet 5 | ; Manifest 6 | domain="domain.tld" (DOMAIN)<% if (defaultPathOption != "") { %> 7 | path="/<%= defaultPath %>" (PATH)<% } %><% if (secureAccessOption) { %> 8 | is_public=1 (PUBLIC|public=1|private=0)<% } %><% if (adminUserOption) { %> 9 | admin="john" (USER)<% } %> 10 | ; Checks 11 | pkg_linter=1 12 | setup_sub_dir=1 13 | setup_root=1 14 | setup_nourl=0 15 | setup_private=0 16 | setup_public=0 17 | upgrade=1 18 | backup_restore=1 19 | multi_instance=1 20 | incorrect_path=1 21 | change_url=0 22 | ;;; Levels 23 | Level 1=auto 24 | Level 2=auto 25 | Level 3=auto 26 | Level 4=0 27 | Level 5=auto 28 | Level 6=auto 29 | Level 7=auto 30 | Level 8=0 31 | Level 9=0 32 | Level 10=0 33 | ;;; Options 34 | Email=<%= authorEmail %> 35 | Notification=none 36 | -------------------------------------------------------------------------------- /generators/app/templates/scripts/remove: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | #================================================= 4 | # IMPORT GENERIC HELPERS 5 | #================================================= 6 | 7 | # Source YunoHost helpers 8 | source _common.sh 9 | source /usr/share/yunohost/helpers 10 | 11 | #================================================= 12 | # LOAD SETTINGS 13 | #================================================= 14 | 15 | # Retrieve app settings 16 | app=$YNH_APP_INSTANCE_NAME 17 | domain=$(ynh_app_setting_get "$app" domain) 18 | 19 | dockerapp_ynh_loadvariables 20 | 21 | #================================================= 22 | # STOP AND REMOVE SERVICE 23 | #================================================= 24 | 25 | # docker rm 26 | dockerapp_ynh_rm 27 | 28 | #================================================= 29 | # REMOVE APP MAIN DIR 30 | #================================================= 31 | 32 | # Remove conf and app 33 | ynh_secure_remove $data_path 34 | 35 | #================================================= 36 | # REMOVE NGINX CONFIGURATION 37 | #================================================= 38 | 39 | ynh_remove_nginx_config 40 | 41 | #================================================= 42 | # RELOAD SSOWAT 43 | #================================================= 44 | 45 | # Regenerate SSOwat conf 46 | dockerapp_ynh_reloadservices 47 | -------------------------------------------------------------------------------- /__tests__/app.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | var path = require('path'); 3 | var assert = require('yeoman-assert'); 4 | var helpers = require('yeoman-test'); 5 | 6 | describe('generator-dockerapp-yunohost:app', () => { 7 | beforeAll(() => { 8 | return helpers.run(path.join(__dirname, '../generators/app')) 9 | .withPrompts({beautifulName: 'myApp', urlApp: 'http://myapp.org/'}); 10 | }); 11 | 12 | it('creates files', () => { 13 | assert.file(['manifest.json']); 14 | assert.file(['check_process']); 15 | assert.file(['scripts/docker/run.sh']); 16 | assert.file(['conf/nginx.conf']); 17 | assert.file(['scripts/docker/rm.sh']); 18 | assert.file(['scripts/docker/docker-compose.yml']); 19 | assert.file(['scripts/docker/_specificvariablesapp.sh']); 20 | assert.file(['manifest.json']); 21 | assert.file(['scripts/upgrade']); 22 | assert.file(['scripts/_common.sh']); 23 | assert.file(['scripts/_dockertest.sh']); 24 | assert.file(['scripts/install']); 25 | assert.file(['scripts/remove']); 26 | assert.file(['scripts/restore']); 27 | assert.file(['scripts/backup']); 28 | assert.file(['README.md']); 29 | assert.file(['LICENSE']); 30 | }); 31 | 32 | it('content files', () => { 33 | assert.fileContent('manifest.json', /myApp/); 34 | assert.fileContent('manifest.json', /myapp/); 35 | assert.fileContent('manifest.json', /http:\/\/myapp.org/); 36 | }); 37 | }); 38 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "generator-dockerapp-yunohost", 3 | "version": "0.0.12", 4 | "description": "Generate Yunohost App for easely Docker App integration", 5 | "homepage": "https://github.com/aymhce/dockerappmodel_ynh", 6 | "author": { 7 | "name": "aymhce", 8 | "email": "aymhce@gmail.com", 9 | "url": "" 10 | }, 11 | "files": [ 12 | "generators" 13 | ], 14 | "main": "generators/index.js", 15 | "keywords": [ 16 | "docker", 17 | "app", 18 | "application", 19 | "yunohost", 20 | "hosting", 21 | "yeoman-generator" 22 | ], 23 | "devDependencies": { 24 | "yeoman-test": "^1.6.0", 25 | "yeoman-assert": "^3.0.0", 26 | "coveralls": "^2.13.1", 27 | "nsp": "^2.6.3", 28 | "eslint": "^4.1.0", 29 | "eslint-config-xo-space": "^0.16.0", 30 | "jest": "^21.0.0", 31 | "jest-cli": "^21.0.0" 32 | }, 33 | "dependencies": { 34 | "yeoman-generator": "^1.0.0", 35 | "chalk": "^1.1.3", 36 | "yosay": "^2.0.0" 37 | }, 38 | "jest": { 39 | "testEnvironment": "node" 40 | }, 41 | "scripts": { 42 | "prepublish": "nsp check", 43 | "pretest": "eslint . --fix", 44 | "test": "jest" 45 | }, 46 | "eslintConfig": { 47 | "extends": "xo-space", 48 | "env": { 49 | "jest": true, 50 | "node": true 51 | } 52 | }, 53 | "repository": "domainelibre/generator-dockerapp-yunohost", 54 | "license": "GPL-3.0" 55 | } 56 | -------------------------------------------------------------------------------- /generators/app/templates/scripts/backup: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | set -eu 4 | 5 | #================================================= 6 | # IMPORT GENERIC HELPERS 7 | #================================================= 8 | 9 | [ ! -e _common.sh ] && cp ../settings/scripts/_common.sh ./. 10 | [ ! -e docker/ ] && cp -rf ../settings/scripts/docker/ ./. 11 | source _common.sh 12 | source /usr/share/yunohost/helpers 13 | 14 | #================================================= 15 | # MANAGE SCRIPT FAILURE 16 | #================================================= 17 | 18 | ynh_abort_if_errors 19 | 20 | #================================================= 21 | # LOAD SETTINGS 22 | #================================================= 23 | 24 | app=$YNH_APP_INSTANCE_NAME 25 | domain=$(ynh_app_setting_get "$app" domain) 26 | <% if (defaultPathOption != "") { %>path_url=$(ynh_app_setting_get "$app" path) 27 | <% } %> 28 | 29 | dockerapp_ynh_loadvariables 30 | <% if (scriptsLoadSave) { %> 31 | #================================================= 32 | # BACKUP DATA IN CONTAINER 33 | #================================================= 34 | 35 | dockerapp_ynh_save 36 | <% } %> 37 | #================================================= 38 | # BACKUP THE APP MAIN DIR 39 | #================================================= 40 | 41 | ynh_backup "$data_path" 42 | 43 | #================================================= 44 | # BACKUP THE NGINX CONFIGURATION 45 | #================================================= 46 | 47 | ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf" 48 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # generator-dockerapp-yunohost [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url] [![Coverage percentage][coveralls-image]][coveralls-url] 2 | 3 | > Generate [Yunohost App](https://yunohost.org/) for easely [Docker App](https://hub.docker.com/) integration 4 | 5 | Features : 6 | * automatic docker install 7 | * automatic port management 8 | * is_public option 9 | * context_path option 10 | * admin user option 11 | * work on [Yunohost docker container](https://hub.docker.com/r/domainelibre/) 12 | * level 7 quality app 13 | * optional load/save scripts 14 | * optional custom reverse proxy protocol 15 | 16 | After first generation you can do regeneration with persist data in .yo-rc.json 17 | 18 | ## Installation 19 | 20 | First, install [Yeoman](http://yeoman.io) and generator-dockerapp-yunohost using [npm](https://www.npmjs.com/) (we assume you have pre-installed [node.js](https://nodejs.org/)). 21 | 22 | ```bash 23 | npm install -g yo 24 | npm install -g generator-dockerapp-yunohost 25 | ``` 26 | 27 | Then generate your new project: 28 | 29 | ```bash 30 | yo dockerapp-yunohost 31 | ``` 32 | 33 | ## Getting To Know Yeoman 34 | 35 | * Yeoman has a heart of gold. 36 | * Yeoman is a person with feelings and opinions, but is very easy to work with. 37 | * Yeoman can be too opinionated at times but is easily convinced not to be. 38 | * Feel free to [learn more about Yeoman](http://yeoman.io/). 39 | 40 | ## License 41 | 42 | GPL-3.0 © [aymhce]() 43 | 44 | 45 | [npm-image]: https://badge.fury.io/js/generator-dockerapp-yunohost.svg 46 | [npm-url]: https://npmjs.org/package/generator-dockerapp-yunohost 47 | [travis-image]: https://travis-ci.org/domainelibre/generator-dockerapp-yunohost.svg?branch=master 48 | [travis-url]: https://travis-ci.org/domainelibre/generator-dockerapp-yunohost 49 | [daviddm-image]: https://david-dm.org/domainelibre/generator-dockerapp-yunohost.svg?theme=shields.io 50 | [daviddm-url]: https://david-dm.org/domainelibre/generator-dockerapp-yunohost 51 | [coveralls-image]: https://coveralls.io/repos/domainelibre/generator-dockerapp-yunohost/badge.svg 52 | [coveralls-url]: https://coveralls.io/r/domainelibre/generator-dockerapp-yunohost 53 | -------------------------------------------------------------------------------- /generators/app/templates/manifest.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "<%= beautifulName %>", 3 | "id": "<%= idName %>", 4 | "url": "<%= urlApp %>", 5 | "packaging_format": 1, 6 | "description": { 7 | "en": "<%= enDescription %>", 8 | "fr": "<%= frDescription %>" 9 | }, 10 | "version": "1.0", 11 | "license": "AGPL-3.0", 12 | "maintainer": { 13 | "name": "<%= authorName %>", 14 | "email": "<%= authorEmail %>" 15 | }, 16 | "requirements": { 17 | "yunohost": ">= 2.7.2" 18 | }, 19 | "services": [ 20 | "nginx" 21 | ], 22 | "multi_instance": true, 23 | "arguments": { 24 | "install" : [ 25 | { 26 | "name": "domain", 27 | "type": "domain", 28 | "ask": { 29 | "en": "Choose a domain for <%= beautifulName %>", 30 | "fr": "Choisissez un domaine pour <%= beautifulName %>" 31 | }, 32 | "example": "app.domain.org" 33 | }<% if (defaultPathOption != "") { %>, 34 | { 35 | "name": "path", 36 | "type": "path", 37 | "ask": { 38 | "en": "Choose a path for <%= beautifulName %>", 39 | "fr": "Choisissez un chemin pour <%= beautifulName %>" 40 | }, 41 | "example": "/mypath", 42 | "default": "/<%= defaultPathOption %>" 43 | }<% } %><% if (secureAccessOption) { %>,{ 44 | "name": "is_public", 45 | "type": "boolean", 46 | "ask": { 47 | "en": "Can a non-member access the app ?", 48 | "fr": "Un non-membre peut-il accéder à l'application ?" 49 | }, 50 | "default": <% if (forceSecureAccess) { %>false<% } else { %>true<% } %> 51 | }<% } %><% if (adminUserOption) { %>,{ 52 | "name": "admin", 53 | "type": "user", 54 | "ask": { 55 | "en": "Choose the <%= beautifulName %> administrator (must be an existing YunoHost user)", 56 | "fr": "Choisissez l'administrateur <%= beautifulName %> (doit etre un utilisateur Yunohost existant)" 57 | }, 58 | "default": "homer" 59 | }<% } %> 60 | ] 61 | } 62 | } 63 | -------------------------------------------------------------------------------- /generators/app/templates/scripts/restore: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | set -eu 4 | 5 | #================================================= 6 | # IMPORT GENERIC HELPERS 7 | #================================================= 8 | 9 | source /usr/share/yunohost/helpers 10 | 11 | #================================================= 12 | # MANAGE SCRIPT FAILURE 13 | #================================================= 14 | 15 | ynh_abort_if_errors 16 | 17 | #================================================= 18 | # LOAD SETTINGS 19 | #================================================= 20 | 21 | app=$YNH_APP_INSTANCE_NAME 22 | domain=$(ynh_app_setting_get "$app" domain) 23 | <% if (defaultPathOption != "") { %>path_url=$(ynh_app_setting_get "$app" path) 24 | <% } %> 25 | 26 | #================================================= 27 | # CHECK IF THE APP CAN BE RESTORED 28 | #================================================= 29 | 30 | test ! -d /home/yunohost.docker/$app \ 31 | || ynh_die "There is already a directory: /home/yunohost.docker/$app " 32 | 33 | #================================================= 34 | # IMPORT GENERIC HELPERS AFTER YNH_DIE FOR LINTER 35 | #================================================= 36 | 37 | [ ! -e _common.sh ] && cp ../settings/scripts/_common.sh ./. 38 | [ ! -e _dockertest.sh ] && cp ../settings/scripts/_dockertest.sh ./. 39 | [ ! -e docker/ ] && cp -rf ../settings/scripts/docker/ ./. 40 | source _common.sh 41 | 42 | #================================================= 43 | # CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS 44 | #================================================= 45 | 46 | # check or install docker 47 | dockerapp_ynh_checkinstalldocker 48 | 49 | #================================================= 50 | # MODIFY A CONFIG FILE 51 | #================================================= 52 | 53 | dockerapp_ynh_loadvariables 54 | dockerapp_ynh_findreplaceallvaribles 55 | 56 | #================================================= 57 | # RESTORE THE APP MAIN DIR 58 | #================================================= 59 | 60 | ynh_restore_file "$data_path" 61 | 62 | #================================================= 63 | # START AND CREATE SERVICE 64 | #================================================= 65 | 66 | # docker run 67 | dockerapp_ynh_run 68 | <% if (scriptsLoadSave) { %> 69 | #================================================= 70 | # RESTORE DATA IN CONTAINER 71 | #================================================= 72 | 73 | dockerapp_ynh_load 74 | <% } %> 75 | #================================================= 76 | # RESTORE THE NGINX CONFIGURATION 77 | #================================================= 78 | 79 | ynh_restore_file "/etc/nginx/conf.d/$domain.d/$app.conf" 80 | systemctl reload nginx 81 | 82 | #================================================= 83 | # RELOAD SSOWAT 84 | #================================================= 85 | 86 | # Regenerate SSOwat conf 87 | dockerapp_ynh_reloadservices 88 | 89 | -------------------------------------------------------------------------------- /generators/app/templates/scripts/upgrade: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | #================================================= 4 | # IMPORT GENERIC HELPERS 5 | #================================================= 6 | 7 | # Source YunoHost helpers 8 | source _common.sh 9 | source /usr/share/yunohost/helpers 10 | 11 | #================================================= 12 | # MANAGE SCRIPT FAILURE 13 | #================================================= 14 | 15 | ynh_abort_if_errors 16 | 17 | #================================================= 18 | # LOAD SETTINGS 19 | #================================================= 20 | 21 | # Retrieve app settings 22 | app=$YNH_APP_INSTANCE_NAME 23 | domain=$(ynh_app_setting_get "$app" domain) 24 | <% if (defaultPathOption != "") { %>path_url=$(ynh_app_setting_get "$app" path) 25 | <% } %><% if (secureAccessOption) { %>is_public=$(ynh_app_setting_get "$app" is_public) 26 | <% } %><% if (adminUserOption) { %>admin=$(ynh_app_setting_get "$app" admin) 27 | <% } %> 28 | 29 | dockerapp_ynh_loadvariables 30 | 31 | #================================================= 32 | # MODIFY A CONFIG FILE 33 | #================================================= 34 | 35 | dockerapp_ynh_findreplaceallvaribles 36 | 37 | #================================================= 38 | # COPY CONF 39 | #================================================= 40 | 41 | # Copy files to the right place 42 | dockerapp_ynh_copyconf 43 | <% if (scriptsLoadSave) { %> 44 | #================================================= 45 | # BACKUP DATA IN CONTAINER 46 | #================================================= 47 | 48 | dockerapp_ynh_save 49 | <% } %> 50 | #================================================= 51 | # STOP AND REMOVE SERVICE 52 | #================================================= 53 | 54 | # docker rm 55 | dockerapp_ynh_rm 56 | 57 | #================================================= 58 | # START AND CREATE SERVICE 59 | #================================================= 60 | 61 | # docker run 62 | dockerapp_ynh_run 63 | <% if (scriptsLoadSave) { %> 64 | #================================================= 65 | # RESTORE DATA IN CONTAINER 66 | #================================================= 67 | 68 | dockerapp_ynh_load 69 | <% } %> 70 | 71 | #================================================= 72 | # NGINX CONFIGURATION 73 | #================================================= 74 | 75 | # Modify Nginx configuration file and copy it to Nginx conf directory 76 | dockerapp_ynh_preparenginx 77 | 78 | #================================================= 79 | # SETUP SSOWAT 80 | #================================================= 81 | 82 | <% if (secureAccessOption) { %> 83 | # Make app public if necessary or protect it 84 | if [ $is_public -eq 1 ] 85 | then 86 | ynh_app_setting_set $app skipped_uris "/" 87 | else 88 | ynh_app_setting_set $app protected_uris "/" 89 | fi 90 | <% } %> 91 | 92 | #================================================= 93 | # RELOAD SSOWAT 94 | #================================================= 95 | 96 | # Regenerate SSOwat conf 97 | dockerapp_ynh_reloadservices 98 | -------------------------------------------------------------------------------- /generators/app/templates/scripts/install: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | #================================================= 4 | # RETRIEVE ARGUMENTS FROM THE MANIFEST 5 | #================================================= 6 | 7 | # Retrieve arguments 8 | app=$YNH_APP_INSTANCE_NAME 9 | domain=$YNH_APP_ARG_DOMAIN 10 | <% if (defaultPathOption != "") { %>path_url=$YNH_APP_ARG_PATH 11 | <% } %><% if (secureAccessOption) { %>is_public=$YNH_APP_ARG_IS_PUBLIC 12 | <% } %><% if (adminUserOption) { %>admin=$YNH_APP_ARG_ADMIN 13 | <% } %> 14 | 15 | #================================================= 16 | # IMPORT GENERIC HELPERS 17 | #================================================= 18 | 19 | # Source YunoHost helpers 20 | source _common.sh 21 | source /usr/share/yunohost/helpers 22 | 23 | #================================================= 24 | # MANAGE SCRIPT FAILURE 25 | #================================================= 26 | 27 | ynh_abort_if_errors 28 | 29 | #================================================= 30 | # STORE SETTINGS FROM MANIFEST 31 | #================================================= 32 | 33 | # store settings 34 | <% if (secureAccessOption) { %>ynh_app_setting_set $app is_public $is_public 35 | <% } %><% if (adminUserOption) { %>ynh_app_setting_set $app admin $admin 36 | <% } %> 37 | 38 | #================================================= 39 | # CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS 40 | #================================================= 41 | 42 | # Check or install docker 43 | dockerapp_ynh_checkinstalldocker 44 | 45 | # Check domain/path availability 46 | dockerapp_ynh_loadvariables 47 | ynh_webpath_available $domain $path_url 48 | ynh_webpath_register $app $domain $path_url 49 | 50 | #================================================= 51 | # MODIFY A CONFIG FILE 52 | #================================================= 53 | 54 | dockerapp_ynh_findreplaceallvaribles 55 | 56 | #================================================= 57 | # COPY CONF 58 | #================================================= 59 | 60 | # Copy files to the right place 61 | dockerapp_ynh_copyconf 62 | 63 | #================================================= 64 | # START AND CREATE SERVICE 65 | #================================================= 66 | 67 | # docker run 68 | dockerapp_ynh_run 69 | 70 | #================================================= 71 | # NGINX CONFIGURATION 72 | #================================================= 73 | 74 | # Modify Nginx configuration file and copy it to Nginx conf directory 75 | dockerapp_ynh_preparenginx 76 | 77 | #================================================= 78 | # SETUP SSOWAT 79 | #================================================= 80 | 81 | <% if (secureAccessOption) { %> 82 | # Make app public if necessary or protect it 83 | if [ $is_public -eq 1 ] 84 | then 85 | ynh_app_setting_set $app skipped_uris "/" 86 | fi 87 | <% } else { %> 88 | <% if (forceSecureAccess) { %><% } else { %>ynh_app_setting_set $app skipped_uris "/"<% } %> 89 | <% } %> 90 | 91 | #================================================= 92 | # RELOAD SSOWAT 93 | #================================================= 94 | 95 | # Regenerate SSOwat conf 96 | dockerapp_ynh_reloadservices 97 | -------------------------------------------------------------------------------- /generators/app/templates/scripts/_common.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # test in container 4 | dockerapp_ynh_incontainer () { 5 | if [ -f /.dockerenv ]; then 6 | echo "0" 7 | else 8 | echo "1" 9 | fi 10 | } 11 | 12 | # docker driver setter 13 | dockerapp_ynh_driversetter () { 14 | echo -e "{\n\t\"debug\": false,\n\t\"storage-driver\": \"$1\"\n}\n" > /etc/docker/daemon.json 15 | systemctl stop docker >/dev/null 2>&1 16 | rm -rf /var/lib/docker 17 | mkdir -p /var/lib/docker 18 | systemctl start docker >/dev/null 2>&1 19 | sleep 30 20 | echo $(sh _dockertest.sh) 21 | } 22 | 23 | # check or do docker install 24 | dockerapp_ynh_checkinstalldocker () { 25 | ret=$(sh _dockertest.sh) 26 | incontainer=$(dockerapp_ynh_incontainer) 27 | if [ $ret == 127 ] 28 | then 29 | # install 30 | curl -sSL https://get.docker.com | sh 31 | systemctl enable docker 32 | curl -L https://github.com/docker/compose/releases/download/1.18.0/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose 33 | 34 | #for d in overlay2 overlay devicemapper aufs vfs 35 | #do 36 | # echo "apply $d driver and test it" 37 | # [ "$(dockerapp_ynh_driversetter $d)" == "0" ] && echo "$d driver will be used" 1>&2 && break 38 | #done 39 | 40 | # retest 41 | ret=$(sh _dockertest.sh) 42 | fi 43 | 44 | if [ $ret != 0 ] 45 | then 46 | ynh_die "Sorry ! Your Docker deamon don't work ... Please check your system logs." 47 | fi 48 | 49 | } 50 | 51 | # find replace 52 | dockerapp_ynh_findreplace () { 53 | for file in $(grep -rl "$2" "$1" 2>/dev/null) 54 | do 55 | ynh_replace_string "$2" "$3" "$file" 56 | done 57 | } 58 | 59 | dockerapp_ynh_findreplacepath () { 60 | dockerapp_ynh_findreplace ../conf/. "$1" "$2" 61 | } 62 | 63 | # find replace all variables 64 | dockerapp_ynh_findreplaceallvaribles () { 65 | dockerapp_ynh_findreplacepath "YNH_APP" "$app" 66 | dockerapp_ynh_findreplacepath "YNH_DATA" "$data_path" 67 | dockerapp_ynh_findreplacepath "YNH_PORT" "$port" 68 | dockerapp_ynh_findreplacepath "YNH_PATH" "$path_url" 69 | bash docker/_specificvariablesapp.sh 70 | } 71 | 72 | # load variables 73 | dockerapp_ynh_loadvariables () { 74 | export app=$app 75 | export domain=$domain 76 | export data_path=/home/yunohost.docker/$app 77 | export port=$(ynh_app_setting_get $app port) 78 | [ "$port" == "" ] && port=$(ynh_find_port 31000) && ynh_app_setting_set $app port $port 79 | <% if (defaultPathOption != "") { %> path_url=$(ynh_normalize_url_path $path)<% } else { %> path_url=/<%}%> 80 | export architecture=$(dpkg --print-architecture) 81 | export incontainer=$(dockerapp_ynh_incontainer) 82 | } 83 | 84 | # copy conf app 85 | dockerapp_ynh_copyconf () { 86 | mkdir -p $data_path 87 | cp -rf ../conf/app $data_path 88 | } 89 | 90 | # docker run 91 | dockerapp_ynh_run () { 92 | ret=$(bash docker/run.sh) 93 | if [ "$ret" != "0" ] 94 | then 95 | # fix after yunohost restore iptables issue 96 | [ "$ret" == "125" ] && docker inspect $app | grep "Error" | grep -q "iptables failed" && systemctl restart docker && return 0 97 | ynh_die "Sorry ! App cannot start with docker. Please check docker logs." 98 | fi 99 | } 100 | 101 | # docker rm 102 | dockerapp_ynh_rm () { 103 | bash docker/rm.sh 104 | } 105 | <% if (scriptsLoadSave) { %> 106 | # docker load 107 | dockerapp_ynh_load () { 108 | bash docker/load.sh 109 | } 110 | 111 | # docker save 112 | dockerapp_ynh_save () { 113 | bash docker/save.sh 114 | } 115 | <% } %> 116 | 117 | # Modify Nginx configuration file and copy it to Nginx conf directory 118 | dockerapp_ynh_preparenginx () { 119 | <% if (defaultPathOption != "") { %> if [ "$path_url" != "/" ] 120 | then 121 | ynh_replace_string "^#sub_path_only" "" "../conf/nginx.conf" 122 | fi 123 | <% } %> 124 | ynh_add_nginx_config 125 | } 126 | 127 | # Regenerate SSOwat conf 128 | dockerapp_ynh_reloadservices () { 129 | yunohost app ssowatconf 130 | } 131 | -------------------------------------------------------------------------------- /generators/app/index.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | const Generator = require('yeoman-generator'); 3 | const chalk = require('chalk'); 4 | const yosay = require('yosay'); 5 | 6 | module.exports = class extends Generator { 7 | prompting() { 8 | this.log(yosay( 9 | 'Welcome to the wondrous ' + chalk.red('generator-dockerapp-yunohost') + ' generator!' 10 | )); 11 | 12 | const prompts = [{ 13 | type: 'input', 14 | name: 'beautifulName', 15 | message: 'Your Yunohost App name ?', 16 | default: this.appname 17 | }, { 18 | type: 'input', 19 | name: 'defaultPathOption', 20 | message: 'Active context path option (like "/mypath") - can be empty ?', 21 | default: '' 22 | }, { 23 | type: 'confirm', 24 | name: 'forceSecureAccess', 25 | message: 'Active secure access by default ?', 26 | default: true 27 | }, { 28 | type: 'confirm', 29 | name: 'secureAccessOption', 30 | message: 'Active secure access option (yunohost auth or public access) ?', 31 | default: false 32 | }, { 33 | type: 'confirm', 34 | name: 'adminUserOption', 35 | message: 'Active admin user option (admin app access for user) ?', 36 | default: false 37 | }, { 38 | type: 'input', 39 | name: 'enDescription', 40 | message: 'English description ?', 41 | default: '' 42 | }, { 43 | type: 'input', 44 | name: 'frDescription', 45 | message: 'Description en francais', 46 | default: '' 47 | }, { 48 | type: 'input', 49 | name: 'urlApp', 50 | message: 'App original url creators ?', 51 | default: '' 52 | }, { 53 | type: 'input', 54 | name: 'urlDockerHub', 55 | message: 'DockerHub image url ?', 56 | default: '' 57 | }, { 58 | type: 'input', 59 | name: 'authorName', 60 | message: 'Your name ?', 61 | default: this.user.git.name() 62 | }, { 63 | type: 'input', 64 | name: 'authorEmail', 65 | message: 'Your email ?', 66 | default: this.user.git.email() 67 | }]; 68 | 69 | if (this.config.getAll() && Object.keys(this.config.getAll()).length) { 70 | this.props = this.config.getAll(); 71 | return this.props; 72 | } 73 | return this.prompt(prompts).then(props => { 74 | this.props = props; 75 | this.props.idName = this.props.beautifulName.toLowerCase(); 76 | this.props.reverseProxyProtocol = 'http'; 77 | this.props.scriptsLoadSave = false; 78 | if (!this.props.enDescription) { 79 | this.props.enDescription = String(this.props.beautifulName) + ' App for Yunohost'; 80 | } 81 | if (!this.props.frDescription) { 82 | this.props.frDescription = this.props.enDescription; 83 | } 84 | }); 85 | } 86 | 87 | writing() { 88 | this.fs.copyTpl(this.templatePath('check_process'), this.destinationPath('check_process'), this.props); 89 | if (this.props.scriptsLoadSave && !this.fs.exists(this.destinationPath('scripts/docker/load.sh'))) { 90 | this.fs.copyTpl(this.templatePath('scripts/docker/load.sh'), this.destinationPath('scripts/docker/load.sh'), this.props); 91 | } 92 | if (this.props.scriptsLoadSave && !this.fs.exists(this.destinationPath('scripts/docker/save.sh'))) { 93 | this.fs.copyTpl(this.templatePath('scripts/docker/save.sh'), this.destinationPath('scripts/docker/save.sh'), this.props); 94 | } 95 | if (!this.fs.exists(this.destinationPath('scripts/docker/run.sh'))) { 96 | this.fs.copyTpl(this.templatePath('scripts/docker/run.sh'), this.destinationPath('scripts/docker/run.sh'), this.props); 97 | } 98 | this.fs.copyTpl(this.templatePath('conf/nginx.conf'), this.destinationPath('conf/nginx.conf'), this.props); 99 | if (!this.fs.exists(this.destinationPath('scripts/docker/rm.sh'))) { 100 | this.fs.copyTpl(this.templatePath('scripts/docker/rm.sh'), this.destinationPath('scripts/docker/rm.sh'), this.props); 101 | } 102 | if (!this.fs.exists(this.destinationPath('scripts/docker/docker-compose.yml'))) { 103 | this.fs.copyTpl(this.templatePath('scripts/docker/docker-compose.yml'), this.destinationPath('scripts/docker/docker-compose.yml'), this.props); 104 | } 105 | if (!this.fs.exists(this.destinationPath('scripts/docker/_specificvariablesapp.sh'))) { 106 | this.fs.copyTpl(this.templatePath('scripts/docker/_specificvariablesapp.sh'), this.destinationPath('scripts/docker/_specificvariablesapp.sh'), this.props); 107 | } 108 | this.fs.copyTpl(this.templatePath('conf/app/.gitkeep'), this.destinationPath('conf/app/.gitkeep'), this.props); 109 | this.fs.copyTpl(this.templatePath('manifest.json'), this.destinationPath('manifest.json'), this.props); 110 | this.fs.copyTpl(this.templatePath('scripts/upgrade'), this.destinationPath('scripts/upgrade'), this.props); 111 | this.fs.copyTpl(this.templatePath('scripts/_common.sh'), this.destinationPath('scripts/_common.sh'), this.props); 112 | this.fs.copyTpl(this.templatePath('scripts/_dockertest.sh'), this.destinationPath('scripts/_dockertest.sh'), this.props); 113 | this.fs.copyTpl(this.templatePath('scripts/install'), this.destinationPath('scripts/install'), this.props); 114 | this.fs.copyTpl(this.templatePath('scripts/remove'), this.destinationPath('scripts/remove'), this.props); 115 | this.fs.copyTpl(this.templatePath('scripts/restore'), this.destinationPath('scripts/restore'), this.props); 116 | this.fs.copyTpl(this.templatePath('scripts/backup'), this.destinationPath('scripts/backup'), this.props); 117 | if (!this.fs.exists(this.destinationPath('README.md'))) { 118 | this.fs.copyTpl(this.templatePath('README.md'), this.destinationPath('README.md'), this.props); 119 | } 120 | this.fs.copyTpl(this.templatePath('LICENSE'), this.destinationPath('LICENSE'), this.props); 121 | this.config.set(this.props); 122 | } 123 | 124 | install() { 125 | var scriptsLoadSave = ''; 126 | if (this.props.scriptsLoadSave) { 127 | scriptsLoadSave = '\n - "scripts/docker/save.sh" (for backup)\n - "scripts/docker/load.sh (for restore)"'; 128 | } 129 | this.log('\nGreat ! Now please fill up :\n - "scripts/docker/run.sh"\n - "scripts/docker/rm.sh"\n\nAs you want there is :\n - "scripts/docker/docker-compose.yml"' + scriptsLoadSave + '\n - "scripts/docker/_specificvariablesapp.sh"\n\nAlso, place your app config in conf/app, will be copied in /home/yunohost.docker/{appname}'); 130 | } 131 | }; 132 | -------------------------------------------------------------------------------- /generators/app/templates/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 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 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 | {project} Copyright (C) {year} {fullname} 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 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Copyright (c) 2017 aymhce 2 | 3 | This program is free software: you can redistribute it and/or modify 4 | it under the terms of the GNU General Public License as published by 5 | the Free Software Foundation, either version 3 of the License, or 6 | (at your option) any later version. 7 | 8 | This program is distributed in the hope that it will be useful, 9 | but WITHOUT ANY WARRANTY; without even the implied warranty of 10 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 11 | GNU General Public License for more details. 12 | 13 | You should have received a copy of the GNU General Public License 14 | along with this program. If not, see 15 | 16 | 17 | 18 | GNU GENERAL PUBLIC LICENSE 19 | Version 3, 29 June 2007 20 | 21 | Copyright (C) 2007 Free Software Foundation, Inc. 22 | Everyone is permitted to copy and distribute verbatim copies 23 | of this license document, but changing it is not allowed. 24 | 25 | Preamble 26 | 27 | The GNU General Public License is a free, copyleft license for 28 | software and other kinds of works. 29 | 30 | The licenses for most software and other practical works are designed 31 | to take away your freedom to share and change the works. By contrast, 32 | the GNU General Public License is intended to guarantee your freedom to 33 | share and change all versions of a program--to make sure it remains free 34 | software for all its users. We, the Free Software Foundation, use the 35 | GNU General Public License for most of our software; it applies also to 36 | any other work released this way by its authors. You can apply it to 37 | your programs, too. 38 | 39 | When we speak of free software, we are referring to freedom, not 40 | price. Our General Public Licenses are designed to make sure that you 41 | have the freedom to distribute copies of free software (and charge for 42 | them if you wish), that you receive source code or can get it if you 43 | want it, that you can change the software or use pieces of it in new 44 | free programs, and that you know you can do these things. 45 | 46 | To protect your rights, we need to prevent others from denying you 47 | these rights or asking you to surrender the rights. Therefore, you have 48 | certain responsibilities if you distribute copies of the software, or if 49 | you modify it: responsibilities to respect the freedom of others. 50 | 51 | For example, if you distribute copies of such a program, whether 52 | gratis or for a fee, you must pass on to the recipients the same 53 | freedoms that you received. You must make sure that they, too, receive 54 | or can get the source code. And you must show them these terms so they 55 | know their rights. 56 | 57 | Developers that use the GNU GPL protect your rights with two steps: 58 | (1) assert copyright on the software, and (2) offer you this License 59 | giving you legal permission to copy, distribute and/or modify it. 60 | 61 | For the developers' and authors' protection, the GPL clearly explains 62 | that there is no warranty for this free software. For both users' and 63 | authors' sake, the GPL requires that modified versions be marked as 64 | changed, so that their problems will not be attributed erroneously to 65 | authors of previous versions. 66 | 67 | Some devices are designed to deny users access to install or run 68 | modified versions of the software inside them, although the manufacturer 69 | can do so. This is fundamentally incompatible with the aim of 70 | protecting users' freedom to change the software. The systematic 71 | pattern of such abuse occurs in the area of products for individuals to 72 | use, which is precisely where it is most unacceptable. Therefore, we 73 | have designed this version of the GPL to prohibit the practice for those 74 | products. If such problems arise substantially in other domains, we 75 | stand ready to extend this provision to those domains in future versions 76 | of the GPL, as needed to protect the freedom of users. 77 | 78 | Finally, every program is threatened constantly by software patents. 79 | States should not allow patents to restrict development and use of 80 | software on general-purpose computers, but in those that do, we wish to 81 | avoid the special danger that patents applied to a free program could 82 | make it effectively proprietary. To prevent this, the GPL assures that 83 | patents cannot be used to render the program non-free. 84 | 85 | The precise terms and conditions for copying, distribution and 86 | modification follow. 87 | 88 | TERMS AND CONDITIONS 89 | 90 | 0. Definitions. 91 | 92 | "This License" refers to version 3 of the GNU General Public License. 93 | 94 | "Copyright" also means copyright-like laws that apply to other kinds of 95 | works, such as semiconductor masks. 96 | 97 | "The Program" refers to any copyrightable work licensed under this 98 | License. Each licensee is addressed as "you". "Licensees" and 99 | "recipients" may be individuals or organizations. 100 | 101 | To "modify" a work means to copy from or adapt all or part of the work 102 | in a fashion requiring copyright permission, other than the making of an 103 | exact copy. The resulting work is called a "modified version" of the 104 | earlier work or a work "based on" the earlier work. 105 | 106 | A "covered work" means either the unmodified Program or a work based 107 | on the Program. 108 | 109 | To "propagate" a work means to do anything with it that, without 110 | permission, would make you directly or secondarily liable for 111 | infringement under applicable copyright law, except executing it on a 112 | computer or modifying a private copy. Propagation includes copying, 113 | distribution (with or without modification), making available to the 114 | public, and in some countries other activities as well. 115 | 116 | To "convey" a work means any kind of propagation that enables other 117 | parties to make or receive copies. Mere interaction with a user through 118 | a computer network, with no transfer of a copy, is not conveying. 119 | 120 | An interactive user interface displays "Appropriate Legal Notices" 121 | to the extent that it includes a convenient and prominently visible 122 | feature that (1) displays an appropriate copyright notice, and (2) 123 | tells the user that there is no warranty for the work (except to the 124 | extent that warranties are provided), that licensees may convey the 125 | work under this License, and how to view a copy of this License. If 126 | the interface presents a list of user commands or options, such as a 127 | menu, a prominent item in the list meets this criterion. 128 | 129 | 1. Source Code. 130 | 131 | The "source code" for a work means the preferred form of the work 132 | for making modifications to it. "Object code" means any non-source 133 | form of a work. 134 | 135 | A "Standard Interface" means an interface that either is an official 136 | standard defined by a recognized standards body, or, in the case of 137 | interfaces specified for a particular programming language, one that 138 | is widely used among developers working in that language. 139 | 140 | The "System Libraries" of an executable work include anything, other 141 | than the work as a whole, that (a) is included in the normal form of 142 | packaging a Major Component, but which is not part of that Major 143 | Component, and (b) serves only to enable use of the work with that 144 | Major Component, or to implement a Standard Interface for which an 145 | implementation is available to the public in source code form. A 146 | "Major Component", in this context, means a major essential component 147 | (kernel, window system, and so on) of the specific operating system 148 | (if any) on which the executable work runs, or a compiler used to 149 | produce the work, or an object code interpreter used to run it. 150 | 151 | The "Corresponding Source" for a work in object code form means all 152 | the source code needed to generate, install, and (for an executable 153 | work) run the object code and to modify the work, including scripts to 154 | control those activities. However, it does not include the work's 155 | System Libraries, or general-purpose tools or generally available free 156 | programs which are used unmodified in performing those activities but 157 | which are not part of the work. For example, Corresponding Source 158 | includes interface definition files associated with source files for 159 | the work, and the source code for shared libraries and dynamically 160 | linked subprograms that the work is specifically designed to require, 161 | such as by intimate data communication or control flow between those 162 | subprograms and other parts of the work. 163 | 164 | The Corresponding Source need not include anything that users 165 | can regenerate automatically from other parts of the Corresponding 166 | Source. 167 | 168 | The Corresponding Source for a work in source code form is that 169 | same work. 170 | 171 | 2. Basic Permissions. 172 | 173 | All rights granted under this License are granted for the term of 174 | copyright on the Program, and are irrevocable provided the stated 175 | conditions are met. This License explicitly affirms your unlimited 176 | permission to run the unmodified Program. The output from running a 177 | covered work is covered by this License only if the output, given its 178 | content, constitutes a covered work. This License acknowledges your 179 | rights of fair use or other equivalent, as provided by copyright law. 180 | 181 | You may make, run and propagate covered works that you do not 182 | convey, without conditions so long as your license otherwise remains 183 | in force. You may convey covered works to others for the sole purpose 184 | of having them make modifications exclusively for you, or provide you 185 | with facilities for running those works, provided that you comply with 186 | the terms of this License in conveying all material for which you do 187 | not control copyright. Those thus making or running the covered works 188 | for you must do so exclusively on your behalf, under your direction 189 | and control, on terms that prohibit them from making any copies of 190 | your copyrighted material outside their relationship with you. 191 | 192 | Conveying under any other circumstances is permitted solely under 193 | the conditions stated below. Sublicensing is not allowed; section 10 194 | makes it unnecessary. 195 | 196 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 197 | 198 | No covered work shall be deemed part of an effective technological 199 | measure under any applicable law fulfilling obligations under article 200 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 201 | similar laws prohibiting or restricting circumvention of such 202 | measures. 203 | 204 | When you convey a covered work, you waive any legal power to forbid 205 | circumvention of technological measures to the extent such circumvention 206 | is effected by exercising rights under this License with respect to 207 | the covered work, and you disclaim any intention to limit operation or 208 | modification of the work as a means of enforcing, against the work's 209 | users, your or third parties' legal rights to forbid circumvention of 210 | technological measures. 211 | 212 | 4. Conveying Verbatim Copies. 213 | 214 | You may convey verbatim copies of the Program's source code as you 215 | receive it, in any medium, provided that you conspicuously and 216 | appropriately publish on each copy an appropriate copyright notice; 217 | keep intact all notices stating that this License and any 218 | non-permissive terms added in accord with section 7 apply to the code; 219 | keep intact all notices of the absence of any warranty; and give all 220 | recipients a copy of this License along with the Program. 221 | 222 | You may charge any price or no price for each copy that you convey, 223 | and you may offer support or warranty protection for a fee. 224 | 225 | 5. Conveying Modified Source Versions. 226 | 227 | You may convey a work based on the Program, or the modifications to 228 | produce it from the Program, in the form of source code under the 229 | terms of section 4, provided that you also meet all of these conditions: 230 | 231 | a) The work must carry prominent notices stating that you modified 232 | it, and giving a relevant date. 233 | 234 | b) The work must carry prominent notices stating that it is 235 | released under this License and any conditions added under section 236 | 7. This requirement modifies the requirement in section 4 to 237 | "keep intact all notices". 238 | 239 | c) You must license the entire work, as a whole, under this 240 | License to anyone who comes into possession of a copy. This 241 | License will therefore apply, along with any applicable section 7 242 | additional terms, to the whole of the work, and all its parts, 243 | regardless of how they are packaged. This License gives no 244 | permission to license the work in any other way, but it does not 245 | invalidate such permission if you have separately received it. 246 | 247 | d) If the work has interactive user interfaces, each must display 248 | Appropriate Legal Notices; however, if the Program has interactive 249 | interfaces that do not display Appropriate Legal Notices, your 250 | work need not make them do so. 251 | 252 | A compilation of a covered work with other separate and independent 253 | works, which are not by their nature extensions of the covered work, 254 | and which are not combined with it such as to form a larger program, 255 | in or on a volume of a storage or distribution medium, is called an 256 | "aggregate" if the compilation and its resulting copyright are not 257 | used to limit the access or legal rights of the compilation's users 258 | beyond what the individual works permit. Inclusion of a covered work 259 | in an aggregate does not cause this License to apply to the other 260 | parts of the aggregate. 261 | 262 | 6. Conveying Non-Source Forms. 263 | 264 | You may convey a covered work in object code form under the terms 265 | of sections 4 and 5, provided that you also convey the 266 | machine-readable Corresponding Source under the terms of this License, 267 | in one of these ways: 268 | 269 | a) Convey the object code in, or embodied in, a physical product 270 | (including a physical distribution medium), accompanied by the 271 | Corresponding Source fixed on a durable physical medium 272 | customarily used for software interchange. 273 | 274 | b) Convey the object code in, or embodied in, a physical product 275 | (including a physical distribution medium), accompanied by a 276 | written offer, valid for at least three years and valid for as 277 | long as you offer spare parts or customer support for that product 278 | model, to give anyone who possesses the object code either (1) a 279 | copy of the Corresponding Source for all the software in the 280 | product that is covered by this License, on a durable physical 281 | medium customarily used for software interchange, for a price no 282 | more than your reasonable cost of physically performing this 283 | conveying of source, or (2) access to copy the 284 | Corresponding Source from a network server at no charge. 285 | 286 | c) Convey individual copies of the object code with a copy of the 287 | written offer to provide the Corresponding Source. This 288 | alternative is allowed only occasionally and noncommercially, and 289 | only if you received the object code with such an offer, in accord 290 | with subsection 6b. 291 | 292 | d) Convey the object code by offering access from a designated 293 | place (gratis or for a charge), and offer equivalent access to the 294 | Corresponding Source in the same way through the same place at no 295 | further charge. You need not require recipients to copy the 296 | Corresponding Source along with the object code. If the place to 297 | copy the object code is a network server, the Corresponding Source 298 | may be on a different server (operated by you or a third party) 299 | that supports equivalent copying facilities, provided you maintain 300 | clear directions next to the object code saying where to find the 301 | Corresponding Source. Regardless of what server hosts the 302 | Corresponding Source, you remain obligated to ensure that it is 303 | available for as long as needed to satisfy these requirements. 304 | 305 | e) Convey the object code using peer-to-peer transmission, provided 306 | you inform other peers where the object code and Corresponding 307 | Source of the work are being offered to the general public at no 308 | charge under subsection 6d. 309 | 310 | A separable portion of the object code, whose source code is excluded 311 | from the Corresponding Source as a System Library, need not be 312 | included in conveying the object code work. 313 | 314 | A "User Product" is either (1) a "consumer product", which means any 315 | tangible personal property which is normally used for personal, family, 316 | or household purposes, or (2) anything designed or sold for incorporation 317 | into a dwelling. In determining whether a product is a consumer product, 318 | doubtful cases shall be resolved in favor of coverage. For a particular 319 | product received by a particular user, "normally used" refers to a 320 | typical or common use of that class of product, regardless of the status 321 | of the particular user or of the way in which the particular user 322 | actually uses, or expects or is expected to use, the product. A product 323 | is a consumer product regardless of whether the product has substantial 324 | commercial, industrial or non-consumer uses, unless such uses represent 325 | the only significant mode of use of the product. 326 | 327 | "Installation Information" for a User Product means any methods, 328 | procedures, authorization keys, or other information required to install 329 | and execute modified versions of a covered work in that User Product from 330 | a modified version of its Corresponding Source. The information must 331 | suffice to ensure that the continued functioning of the modified object 332 | code is in no case prevented or interfered with solely because 333 | modification has been made. 334 | 335 | If you convey an object code work under this section in, or with, or 336 | specifically for use in, a User Product, and the conveying occurs as 337 | part of a transaction in which the right of possession and use of the 338 | User Product is transferred to the recipient in perpetuity or for a 339 | fixed term (regardless of how the transaction is characterized), the 340 | Corresponding Source conveyed under this section must be accompanied 341 | by the Installation Information. But this requirement does not apply 342 | if neither you nor any third party retains the ability to install 343 | modified object code on the User Product (for example, the work has 344 | been installed in ROM). 345 | 346 | The requirement to provide Installation Information does not include a 347 | requirement to continue to provide support service, warranty, or updates 348 | for a work that has been modified or installed by the recipient, or for 349 | the User Product in which it has been modified or installed. Access to a 350 | network may be denied when the modification itself materially and 351 | adversely affects the operation of the network or violates the rules and 352 | protocols for communication across the network. 353 | 354 | Corresponding Source conveyed, and Installation Information provided, 355 | in accord with this section must be in a format that is publicly 356 | documented (and with an implementation available to the public in 357 | source code form), and must require no special password or key for 358 | unpacking, reading or copying. 359 | 360 | 7. Additional Terms. 361 | 362 | "Additional permissions" are terms that supplement the terms of this 363 | License by making exceptions from one or more of its conditions. 364 | Additional permissions that are applicable to the entire Program shall 365 | be treated as though they were included in this License, to the extent 366 | that they are valid under applicable law. If additional permissions 367 | apply only to part of the Program, that part may be used separately 368 | under those permissions, but the entire Program remains governed by 369 | this License without regard to the additional permissions. 370 | 371 | When you convey a copy of a covered work, you may at your option 372 | remove any additional permissions from that copy, or from any part of 373 | it. (Additional permissions may be written to require their own 374 | removal in certain cases when you modify the work.) You may place 375 | additional permissions on material, added by you to a covered work, 376 | for which you have or can give appropriate copyright permission. 377 | 378 | Notwithstanding any other provision of this License, for material you 379 | add to a covered work, you may (if authorized by the copyright holders of 380 | that material) supplement the terms of this License with terms: 381 | 382 | a) Disclaiming warranty or limiting liability differently from the 383 | terms of sections 15 and 16 of this License; or 384 | 385 | b) Requiring preservation of specified reasonable legal notices or 386 | author attributions in that material or in the Appropriate Legal 387 | Notices displayed by works containing it; or 388 | 389 | c) Prohibiting misrepresentation of the origin of that material, or 390 | requiring that modified versions of such material be marked in 391 | reasonable ways as different from the original version; or 392 | 393 | d) Limiting the use for publicity purposes of names of licensors or 394 | authors of the material; or 395 | 396 | e) Declining to grant rights under trademark law for use of some 397 | trade names, trademarks, or service marks; or 398 | 399 | f) Requiring indemnification of licensors and authors of that 400 | material by anyone who conveys the material (or modified versions of 401 | it) with contractual assumptions of liability to the recipient, for 402 | any liability that these contractual assumptions directly impose on 403 | those licensors and authors. 404 | 405 | All other non-permissive additional terms are considered "further 406 | restrictions" within the meaning of section 10. If the Program as you 407 | received it, or any part of it, contains a notice stating that it is 408 | governed by this License along with a term that is a further 409 | restriction, you may remove that term. If a license document contains 410 | a further restriction but permits relicensing or conveying under this 411 | License, you may add to a covered work material governed by the terms 412 | of that license document, provided that the further restriction does 413 | not survive such relicensing or conveying. 414 | 415 | If you add terms to a covered work in accord with this section, you 416 | must place, in the relevant source files, a statement of the 417 | additional terms that apply to those files, or a notice indicating 418 | where to find the applicable terms. 419 | 420 | Additional terms, permissive or non-permissive, may be stated in the 421 | form of a separately written license, or stated as exceptions; 422 | the above requirements apply either way. 423 | 424 | 8. Termination. 425 | 426 | You may not propagate or modify a covered work except as expressly 427 | provided under this License. Any attempt otherwise to propagate or 428 | modify it is void, and will automatically terminate your rights under 429 | this License (including any patent licenses granted under the third 430 | paragraph of section 11). 431 | 432 | However, if you cease all violation of this License, then your 433 | license from a particular copyright holder is reinstated (a) 434 | provisionally, unless and until the copyright holder explicitly and 435 | finally terminates your license, and (b) permanently, if the copyright 436 | holder fails to notify you of the violation by some reasonable means 437 | prior to 60 days after the cessation. 438 | 439 | Moreover, your license from a particular copyright holder is 440 | reinstated permanently if the copyright holder notifies you of the 441 | violation by some reasonable means, this is the first time you have 442 | received notice of violation of this License (for any work) from that 443 | copyright holder, and you cure the violation prior to 30 days after 444 | your receipt of the notice. 445 | 446 | Termination of your rights under this section does not terminate the 447 | licenses of parties who have received copies or rights from you under 448 | this License. If your rights have been terminated and not permanently 449 | reinstated, you do not qualify to receive new licenses for the same 450 | material under section 10. 451 | 452 | 9. Acceptance Not Required for Having Copies. 453 | 454 | You are not required to accept this License in order to receive or 455 | run a copy of the Program. Ancillary propagation of a covered work 456 | occurring solely as a consequence of using peer-to-peer transmission 457 | to receive a copy likewise does not require acceptance. However, 458 | nothing other than this License grants you permission to propagate or 459 | modify any covered work. These actions infringe copyright if you do 460 | not accept this License. Therefore, by modifying or propagating a 461 | covered work, you indicate your acceptance of this License to do so. 462 | 463 | 10. Automatic Licensing of Downstream Recipients. 464 | 465 | Each time you convey a covered work, the recipient automatically 466 | receives a license from the original licensors, to run, modify and 467 | propagate that work, subject to this License. You are not responsible 468 | for enforcing compliance by third parties with this License. 469 | 470 | An "entity transaction" is a transaction transferring control of an 471 | organization, or substantially all assets of one, or subdividing an 472 | organization, or merging organizations. If propagation of a covered 473 | work results from an entity transaction, each party to that 474 | transaction who receives a copy of the work also receives whatever 475 | licenses to the work the party's predecessor in interest had or could 476 | give under the previous paragraph, plus a right to possession of the 477 | Corresponding Source of the work from the predecessor in interest, if 478 | the predecessor has it or can get it with reasonable efforts. 479 | 480 | You may not impose any further restrictions on the exercise of the 481 | rights granted or affirmed under this License. For example, you may 482 | not impose a license fee, royalty, or other charge for exercise of 483 | rights granted under this License, and you may not initiate litigation 484 | (including a cross-claim or counterclaim in a lawsuit) alleging that 485 | any patent claim is infringed by making, using, selling, offering for 486 | sale, or importing the Program or any portion of it. 487 | 488 | 11. Patents. 489 | 490 | A "contributor" is a copyright holder who authorizes use under this 491 | License of the Program or a work on which the Program is based. The 492 | work thus licensed is called the contributor's "contributor version". 493 | 494 | A contributor's "essential patent claims" are all patent claims 495 | owned or controlled by the contributor, whether already acquired or 496 | hereafter acquired, that would be infringed by some manner, permitted 497 | by this License, of making, using, or selling its contributor version, 498 | but do not include claims that would be infringed only as a 499 | consequence of further modification of the contributor version. For 500 | purposes of this definition, "control" includes the right to grant 501 | patent sublicenses in a manner consistent with the requirements of 502 | this License. 503 | 504 | Each contributor grants you a non-exclusive, worldwide, royalty-free 505 | patent license under the contributor's essential patent claims, to 506 | make, use, sell, offer for sale, import and otherwise run, modify and 507 | propagate the contents of its contributor version. 508 | 509 | In the following three paragraphs, a "patent license" is any express 510 | agreement or commitment, however denominated, not to enforce a patent 511 | (such as an express permission to practice a patent or covenant not to 512 | sue for patent infringement). To "grant" such a patent license to a 513 | party means to make such an agreement or commitment not to enforce a 514 | patent against the party. 515 | 516 | If you convey a covered work, knowingly relying on a patent license, 517 | and the Corresponding Source of the work is not available for anyone 518 | to copy, free of charge and under the terms of this License, through a 519 | publicly available network server or other readily accessible means, 520 | then you must either (1) cause the Corresponding Source to be so 521 | available, or (2) arrange to deprive yourself of the benefit of the 522 | patent license for this particular work, or (3) arrange, in a manner 523 | consistent with the requirements of this License, to extend the patent 524 | license to downstream recipients. "Knowingly relying" means you have 525 | actual knowledge that, but for the patent license, your conveying the 526 | covered work in a country, or your recipient's use of the covered work 527 | in a country, would infringe one or more identifiable patents in that 528 | country that you have reason to believe are valid. 529 | 530 | If, pursuant to or in connection with a single transaction or 531 | arrangement, you convey, or propagate by procuring conveyance of, a 532 | covered work, and grant a patent license to some of the parties 533 | receiving the covered work authorizing them to use, propagate, modify 534 | or convey a specific copy of the covered work, then the patent license 535 | you grant is automatically extended to all recipients of the covered 536 | work and works based on it. 537 | 538 | A patent license is "discriminatory" if it does not include within 539 | the scope of its coverage, prohibits the exercise of, or is 540 | conditioned on the non-exercise of one or more of the rights that are 541 | specifically granted under this License. You may not convey a covered 542 | work if you are a party to an arrangement with a third party that is 543 | in the business of distributing software, under which you make payment 544 | to the third party based on the extent of your activity of conveying 545 | the work, and under which the third party grants, to any of the 546 | parties who would receive the covered work from you, a discriminatory 547 | patent license (a) in connection with copies of the covered work 548 | conveyed by you (or copies made from those copies), or (b) primarily 549 | for and in connection with specific products or compilations that 550 | contain the covered work, unless you entered into that arrangement, 551 | or that patent license was granted, prior to 28 March 2007. 552 | 553 | Nothing in this License shall be construed as excluding or limiting 554 | any implied license or other defenses to infringement that may 555 | otherwise be available to you under applicable patent law. 556 | 557 | 12. No Surrender of Others' Freedom. 558 | 559 | If conditions are imposed on you (whether by court order, agreement or 560 | otherwise) that contradict the conditions of this License, they do not 561 | excuse you from the conditions of this License. If you cannot convey a 562 | covered work so as to satisfy simultaneously your obligations under this 563 | License and any other pertinent obligations, then as a consequence you may 564 | not convey it at all. For example, if you agree to terms that obligate you 565 | to collect a royalty for further conveying from those to whom you convey 566 | the Program, the only way you could satisfy both those terms and this 567 | License would be to refrain entirely from conveying the Program. 568 | 569 | 13. Use with the GNU Affero General Public License. 570 | 571 | Notwithstanding any other provision of this License, you have 572 | permission to link or combine any covered work with a work licensed 573 | under version 3 of the GNU Affero General Public License into a single 574 | combined work, and to convey the resulting work. The terms of this 575 | License will continue to apply to the part which is the covered work, 576 | but the special requirements of the GNU Affero General Public License, 577 | section 13, concerning interaction through a network will apply to the 578 | combination as such. 579 | 580 | 14. Revised Versions of this License. 581 | 582 | The Free Software Foundation may publish revised and/or new versions of 583 | the GNU General Public License from time to time. Such new versions will 584 | be similar in spirit to the present version, but may differ in detail to 585 | address new problems or concerns. 586 | 587 | Each version is given a distinguishing version number. If the 588 | Program specifies that a certain numbered version of the GNU General 589 | Public License "or any later version" applies to it, you have the 590 | option of following the terms and conditions either of that numbered 591 | version or of any later version published by the Free Software 592 | Foundation. If the Program does not specify a version number of the 593 | GNU General Public License, you may choose any version ever published 594 | by the Free Software Foundation. 595 | 596 | If the Program specifies that a proxy can decide which future 597 | versions of the GNU General Public License can be used, that proxy's 598 | public statement of acceptance of a version permanently authorizes you 599 | to choose that version for the Program. 600 | 601 | Later license versions may give you additional or different 602 | permissions. However, no additional obligations are imposed on any 603 | author or copyright holder as a result of your choosing to follow a 604 | later version. 605 | 606 | 15. Disclaimer of Warranty. 607 | 608 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 609 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 610 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 611 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 612 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 613 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 614 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 615 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 616 | 617 | 16. Limitation of Liability. 618 | 619 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 620 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 621 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 622 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 623 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 624 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 625 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 626 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 627 | SUCH DAMAGES. 628 | 629 | 17. Interpretation of Sections 15 and 16. 630 | 631 | If the disclaimer of warranty and limitation of liability provided 632 | above cannot be given local legal effect according to their terms, 633 | reviewing courts shall apply local law that most closely approximates 634 | an absolute waiver of all civil liability in connection with the 635 | Program, unless a warranty or assumption of liability accompanies a 636 | copy of the Program in return for a fee. 637 | 638 | END OF TERMS AND CONDITIONS 639 | 640 | How to Apply These Terms to Your New Programs 641 | 642 | If you develop a new program, and you want it to be of the greatest 643 | possible use to the public, the best way to achieve this is to make it 644 | free software which everyone can redistribute and change under these terms. 645 | 646 | To do so, attach the following notices to the program. It is safest 647 | to attach them to the start of each source file to most effectively 648 | state the exclusion of warranty; and each file should have at least 649 | the "copyright" line and a pointer to where the full notice is found. 650 | 651 | {one line to give the program's name and a brief idea of what it does.} 652 | Copyright (C) {year} {name of author} 653 | 654 | This program is free software: you can redistribute it and/or modify 655 | it under the terms of the GNU General Public License as published by 656 | the Free Software Foundation, either version 3 of the License, or 657 | (at your option) any later version. 658 | 659 | This program is distributed in the hope that it will be useful, 660 | but WITHOUT ANY WARRANTY; without even the implied warranty of 661 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 662 | GNU General Public License for more details. 663 | 664 | You should have received a copy of the GNU General Public License 665 | along with this program. If not, see . 666 | 667 | Also add information on how to contact you by electronic and paper mail. 668 | 669 | If the program does terminal interaction, make it output a short 670 | notice like this when it starts in an interactive mode: 671 | 672 | {project} Copyright (C) {year} {fullname} 673 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 674 | This is free software, and you are welcome to redistribute it 675 | under certain conditions; type `show c' for details. 676 | 677 | The hypothetical commands `show w' and `show c' should show the appropriate 678 | parts of the General Public License. Of course, your program's commands 679 | might be different; for a GUI interface, you would use an "about box". 680 | 681 | You should also get your employer (if you work as a programmer) or school, 682 | if any, to sign a "copyright disclaimer" for the program, if necessary. 683 | For more information on this, and how to apply and follow the GNU GPL, see 684 | . 685 | 686 | The GNU General Public License does not permit incorporating your program 687 | into proprietary programs. If your program is a subroutine library, you 688 | may consider it more useful to permit linking proprietary applications with 689 | the library. If this is what you want to do, use the GNU Lesser General 690 | Public License instead of this License. But first, please read 691 | . 692 | 693 | --------------------------------------------------------------------------------