├── charms ├── appstream-frontend │ ├── requirements.txt │ ├── .jujuignore │ ├── requirements-dev.txt │ ├── .flake8 │ ├── units │ │ ├── sync-appstream.timer │ │ └── sync-appstream.service │ ├── config.yaml │ ├── metadata.yaml │ ├── scripts │ │ └── update.sh │ ├── src │ │ └── charm.py │ └── LICENSE └── appstream-generator │ ├── requirements.txt │ ├── .jujuignore │ ├── requirements-dev.txt │ ├── .flake8 │ ├── units │ ├── appstream-generator.timer │ └── appstream-generator.service │ ├── config.yaml │ ├── metadata.yaml │ ├── actions.yaml │ ├── scripts │ └── update-appstream.sh │ ├── LICENSE │ └── src │ └── charm.py ├── mojo ├── manifest ├── manifest-upgrade ├── collect ├── scripts │ └── upgrade-charm └── bundle.yaml ├── config.json ├── .gitignore ├── README.md └── LICENSE /charms/appstream-frontend/requirements.txt: -------------------------------------------------------------------------------- 1 | ops 2 | -------------------------------------------------------------------------------- /charms/appstream-generator/requirements.txt: -------------------------------------------------------------------------------- 1 | charmhelpers 2 | ops 3 | -------------------------------------------------------------------------------- /charms/appstream-frontend/.jujuignore: -------------------------------------------------------------------------------- 1 | /venv 2 | *.py[cod] 3 | *.charm 4 | -------------------------------------------------------------------------------- /mojo/manifest: -------------------------------------------------------------------------------- 1 | collect 2 | bundle config=bundle.yaml max-wait=1800 3 | -------------------------------------------------------------------------------- /charms/appstream-generator/.jujuignore: -------------------------------------------------------------------------------- 1 | /venv 2 | *.py[cod] 3 | *.charm 4 | -------------------------------------------------------------------------------- /charms/appstream-frontend/requirements-dev.txt: -------------------------------------------------------------------------------- 1 | -r requirements.txt 2 | coverage 3 | flake8 4 | -------------------------------------------------------------------------------- /charms/appstream-generator/requirements-dev.txt: -------------------------------------------------------------------------------- 1 | -r requirements.txt 2 | coverage 3 | flake8 4 | -------------------------------------------------------------------------------- /mojo/manifest-upgrade: -------------------------------------------------------------------------------- 1 | collect 2 | script config=scripts/upgrade-charm CHARM=appstream-generator 3 | juju-check-wait 4 | -------------------------------------------------------------------------------- /charms/appstream-frontend/.flake8: -------------------------------------------------------------------------------- 1 | [flake8] 2 | max-line-length = 99 3 | select: E,W,F,C,N 4 | exclude: 5 | venv 6 | .git 7 | build 8 | dist 9 | *.egg_info 10 | -------------------------------------------------------------------------------- /charms/appstream-generator/.flake8: -------------------------------------------------------------------------------- 1 | [flake8] 2 | max-line-length = 99 3 | select: E,W,F,C,N 4 | exclude: 5 | venv 6 | .git 7 | build 8 | dist 9 | *.egg_info 10 | -------------------------------------------------------------------------------- /charms/appstream-frontend/units/sync-appstream.timer: -------------------------------------------------------------------------------- 1 | [Unit] 2 | Description=Sync appstream from backend (timer) 3 | 4 | [Timer] 5 | OnCalendar=minutely 6 | 7 | [Install] 8 | WantedBy=timers.target 9 | -------------------------------------------------------------------------------- /charms/appstream-generator/units/appstream-generator.timer: -------------------------------------------------------------------------------- 1 | [Unit] 2 | Description=Appstream Generator (timer) 3 | 4 | [Timer] 5 | OnBootSec=5m 6 | OnUnitInactiveSec=1h 7 | 8 | [Install] 9 | WantedBy=timers.target 10 | -------------------------------------------------------------------------------- /charms/appstream-frontend/config.yaml: -------------------------------------------------------------------------------- 1 | # Copyright 2021 Canonical 2 | 3 | options: 4 | external-hostname: 5 | description: The hostname the service will be presented on 6 | default: appstream.ubuntu.com 7 | type: string 8 | -------------------------------------------------------------------------------- /charms/appstream-frontend/units/sync-appstream.service: -------------------------------------------------------------------------------- 1 | [Unit] 2 | Description=Sync appstream data from backend 3 | 4 | [Service] 5 | EnvironmentFile=-/home/ubuntu/rsync-address 6 | ExecStart=/home/ubuntu/update.sh 7 | User=ubuntu 8 | Group=ubuntu 9 | -------------------------------------------------------------------------------- /charms/appstream-generator/units/appstream-generator.service: -------------------------------------------------------------------------------- 1 | [Unit] 2 | Description=Run the AppStream generator 3 | 4 | [Service] 5 | EnvironmentFile=-/etc/environment.d/proxy.conf 6 | ExecStart=/home/ubuntu/update-appstream.sh 7 | Group=ubuntu 8 | User=ubuntu 9 | Type=oneshot 10 | -------------------------------------------------------------------------------- /mojo/collect: -------------------------------------------------------------------------------- 1 | appstream-generator git+https://git.launchpad.net/~ubuntu-desktop/+git/appstream-cloud/;branch=built-appstream-generator,overwrite=True 2 | appstream-frontend git+https://git.launchpad.net/~ubuntu-desktop/+git/appstream-cloud/;branch=built-appstream-frontend,overwrite=True 3 | -------------------------------------------------------------------------------- /charms/appstream-frontend/metadata.yaml: -------------------------------------------------------------------------------- 1 | # Copyright 2021 Canonical 2 | 3 | name: appstream-frontend 4 | maintainer: Iain Lane 5 | summary: Frontend http interface for appstream.ubuntu.com 6 | subordinate: true 7 | description: Subordinate to an apache httpd, this charm install a website config and timer units to serve appstream.ubuntu.com 8 | requires: 9 | apache-website: 10 | interface: apache-website 11 | scope: container 12 | rsync: 13 | interface: appstream-rsync 14 | -------------------------------------------------------------------------------- /charms/appstream-generator/config.yaml: -------------------------------------------------------------------------------- 1 | options: 2 | hostname: 3 | description: The hostname the service will be presented on 4 | type: string 5 | config: 6 | description: The configuration of the asgen (releases, etc - see config.json) 7 | type: string 8 | mirror: 9 | default: http://archive.ubuntu.com/ubuntu/ 10 | default_snap_channel: 11 | description: When installing snaps, default to this channel 12 | type: string 13 | default: stable 14 | http_proxy: 15 | https_proxy: 16 | no_proxy: 17 | -------------------------------------------------------------------------------- /charms/appstream-generator/metadata.yaml: -------------------------------------------------------------------------------- 1 | name: appstream-generator 2 | description: | 3 | Generate Appstream metadata from a distribution's software archive 4 | summary: | 5 | Generate Appstream metadata from a distribution's software archive 6 | series: [focal] 7 | storage: 8 | appstream: 9 | type: filesystem 10 | description: appstream-generator's output & working data 11 | shared: false 12 | read-only: false 13 | minimum-size: 200G 14 | location: /home/ubuntu/appstream 15 | provides: 16 | rsync: 17 | interface: appstream-rsync 18 | optional: true 19 | -------------------------------------------------------------------------------- /charms/appstream-generator/actions.yaml: -------------------------------------------------------------------------------- 1 | clean: 2 | description: Clean up so that the next run forces a full refresh 3 | run-now: 4 | description: Run an update immediately 5 | forget: 6 | description: Forget packages from all releases, causing them to be reprocessed the next time 7 | params: 8 | packages: 9 | type: array 10 | items: { type: string } 11 | required: [packages] 12 | forget-tag: 13 | description: Forget all packages with a given tag, causing them to be reprocessed the next time 14 | params: 15 | tag: 16 | type: string 17 | description: The tag to forget 18 | required: [tag] 19 | -------------------------------------------------------------------------------- /charms/appstream-frontend/scripts/update.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | set -e 4 | set -u 5 | 6 | BASE_DIR=${HOME} 7 | 8 | LOG_BASE_DIR=${BASE_DIR}/sync-logs 9 | 10 | # Start logging 11 | logdir="${LOG_BASE_DIR}/$(date "+%Y/%m")" 12 | mkdir -p "${logdir}" 13 | NOW=$(date "+%d") 14 | LOGFILE="${logdir}/${NOW}.log" 15 | exec >> "${LOGFILE}" 2>&1 16 | 17 | find "${logdir}" -type f -not -path "${LOGFILE}" -not -name \*.gz -exec gzip -9 {} \; 18 | 19 | rsync -aqzP --delete --delete-after "${RSYNC_ADDRESS:?}::www" /home/ubuntu/appstream 20 | rsync -aqzP --delete --delete-after "${RSYNC_ADDRESS:?}::logs" /home/ubuntu/logs 21 | 22 | # finish logging 23 | exec > /dev/null 2>&1 24 | 25 | sed -i '/^$/d' "${LOGFILE}" 26 | -------------------------------------------------------------------------------- /config.json: -------------------------------------------------------------------------------- 1 | { 2 | "default" : { 3 | "architectures": ["amd64", "armhf", "arm64", "i386", "ppc64el", "s390x"], 4 | "suites": ["", "-proposed", "-updates", "-security", "-backports"] 5 | }, 6 | "xenial" : { 7 | "architectures": ["amd64", "armhf", "arm64", "i386", "ppc64el", "powerpc", "s390x"], 8 | "suites": ["-proposed", "-updates", "-security", "-backports"], 9 | "oldSuite": true 10 | }, 11 | "bionic" : { 12 | "released" : true 13 | }, 14 | "focal" : { 15 | "released" : true 16 | }, 17 | "jammy" : { 18 | "architectures": ["amd64", "armhf", "arm64", "ppc64el", "riscv64", "s390x"], 19 | "released" : true 20 | }, 21 | "kinetic" : { 22 | "architectures": ["amd64", "armhf", "arm64", "ppc64el", "riscv64", "s390x"], 23 | "released" : true 24 | }, 25 | "lunar" : { 26 | "architectures": ["amd64", "armhf", "arm64", "ppc64el", "riscv64", "s390x"] 27 | } 28 | } 29 | -------------------------------------------------------------------------------- /mojo/scripts/upgrade-charm: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # Copyright (c) 2017 Canonical Ltd. 4 | # Author: Paul Gear 5 | 6 | set -e 7 | set -u 8 | 9 | export JUJU_REPOSITORY=${MOJO_REPO_DIR} 10 | 11 | if [ -z "${CHARM:-}" ]; then 12 | echo "No charm specified for upgrade! Giving up." >&2 13 | exit 1 14 | fi 15 | 16 | if [ -z "${SERVICE:-}" ]; then 17 | echo "No service specified for upgrade! Assuming ${CHARM}." >&2 18 | SERVICE=${CHARM} 19 | fi 20 | 21 | JUJU_VERSION=$(juju version | cut -d'.' -f 1) 22 | 23 | if [ $JUJU_VERSION == "1" ]; then 24 | juju upgrade-charm ${SERVICE} 25 | else 26 | JUJU_STATUS=$(juju status --format=json) 27 | CHARM_ORIGIN=$(echo $JUJU_STATUS | jq --arg SERVICE "$SERVICE" '.applications | to_entries[] | select( .key == $SERVICE ) | .value | .["charm-origin"]') 28 | # Work around https://bugs.launchpad.net/juju/+bug/1653562 29 | if [ $CHARM_ORIGIN == "\"jujucharms\"" ]; then 30 | live_revision=$(echo $JUJU_STATUS | jq --arg SERVICE "$SERVICE" '.applications | to_entries[] | select( .key == $SERVICE ) | .value | .["charm-rev"]') 31 | store_revision=$(charm show cs:${CHARM} | awk '/^Revision/ {print $2}') 32 | if [ "$live_revision" -lt "$store_revision" ] ; then 33 | juju upgrade-charm ${SERVICE} || \ 34 | juju upgrade-charm ${SERVICE} 35 | fi 36 | else 37 | juju upgrade-charm --path ${JUJU_REPOSITORY}/${MOJO_SERIES}/${CHARM} ${SERVICE} || \ 38 | juju upgrade-charm --path ${JUJU_REPOSITORY}/${MOJO_SERIES}/${CHARM} ${SERVICE} 39 | fi 40 | fi 41 | -------------------------------------------------------------------------------- /charms/appstream-generator/scripts/update-appstream.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | set -eu 4 | 5 | BASE_DIR=/home/ubuntu/appstream 6 | 7 | ASGEN=/snap/bin/appstream-generator 8 | PUBLIC_DIR=${BASE_DIR}/appstream-public 9 | WORKSPACE_DIR=${BASE_DIR}/appstream-workdir 10 | STAMP_FILE=${BASE_DIR}/last-update 11 | LOG_BASE_DIR=${BASE_DIR}/logs 12 | CLEAN_FILE=${BASE_DIR}/clean 13 | FORGET_FILE=${BASE_DIR}/forget 14 | 15 | RELEASES=$(jq -r '.Suites | keys | reduce .[] as $item ("";. + " " + $item) | ltrimstr(" ")' "${WORKSPACE_DIR}/asgen-config.json") 16 | 17 | # Start logging 18 | logdir="${LOG_BASE_DIR}/$(date "+%Y/%m")" 19 | mkdir -p ${logdir} 20 | NOW=$(date "+%d_%H%M") 21 | LOGFILE="${logdir}/${NOW}.log" 22 | exec >> "${LOGFILE}" 2>&1 23 | 24 | echo "Reticulating splines" 25 | 26 | cd ${WORKSPACE_DIR} 27 | 28 | if [ -e "${FORGET_FILE}" ]; then 29 | . ${FORGET_FILE} 30 | for pkg in ${CLEAN_PKGS}; do 31 | echo "Forgetting ${pkg}" 32 | ${ASGEN} -w ${WORKSPACE_DIR} forget ${pkg} 33 | done 34 | rm ${FORGET_FILE} 35 | fi 36 | 37 | if [ -e "${CLEAN_FILE}" ]; then 38 | echo "Also cleaning up" 39 | fi 40 | 41 | for release in ${RELEASES}; do 42 | if [ -e "${CLEAN_FILE}" ]; then 43 | ${ASGEN} -w ${WORKSPACE_DIR} remove-found ${release} 44 | fi 45 | ${ASGEN} -w ${WORKSPACE_DIR} --force process ${release} 46 | done 47 | 48 | echo "Updating ${PUBLIC_DIR}" 49 | 50 | rsync -a --verbose --delete-after "${WORKSPACE_DIR}/export/" --filter "protect media/main" --filter "protect media/universe" --filter "protect media/multiverse" --filter "protect media/restricted" --filter "protect data/xenial" --filter "protect html/xenial" "${PUBLIC_DIR}/" 51 | touch ${STAMP_FILE} 52 | 53 | echo "Running cleanup" 54 | ${ASGEN} -w ${WORKSPACE_DIR} cleanup 55 | 56 | if [ -e "${CLEAN_FILE}" ]; then 57 | rm -rf "${WORKSPACE_DIR:?}/media" 58 | rm "${CLEAN_FILE}" 59 | fi 60 | 61 | echo "Compressing log files" 62 | 63 | find "${LOG_BASE_DIR}" -type f -name \*.log ! -newermt '2 days ago' -print0 | xargs -0r xz -9 64 | 65 | echo "Done" 66 | 67 | # finish logging 68 | exec > /dev/null 2>&1 69 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # charmcraft build dirs 2 | charms/*/build 3 | charms/*/*.charm 4 | 5 | # Byte-compiled / optimized / DLL files 6 | __pycache__/ 7 | *.py[cod] 8 | *$py.class 9 | 10 | # C extensions 11 | *.so 12 | 13 | # Distribution / packaging 14 | .Python 15 | build/ 16 | develop-eggs/ 17 | dist/ 18 | downloads/ 19 | eggs/ 20 | .eggs/ 21 | lib/ 22 | lib64/ 23 | parts/ 24 | sdist/ 25 | var/ 26 | wheels/ 27 | share/python-wheels/ 28 | *.egg-info/ 29 | .installed.cfg 30 | *.egg 31 | MANIFEST 32 | 33 | # PyInstaller 34 | # Usually these files are written by a python script from a template 35 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 36 | *.manifest 37 | *.spec 38 | 39 | # Installer logs 40 | pip-log.txt 41 | pip-delete-this-directory.txt 42 | 43 | # Unit test / coverage reports 44 | htmlcov/ 45 | .tox/ 46 | .nox/ 47 | .coverage 48 | .coverage.* 49 | .cache 50 | nosetests.xml 51 | coverage.xml 52 | *.cover 53 | *.py,cover 54 | .hypothesis/ 55 | .pytest_cache/ 56 | cover/ 57 | 58 | # Translations 59 | *.mo 60 | *.pot 61 | 62 | # Django stuff: 63 | *.log 64 | local_settings.py 65 | db.sqlite3 66 | db.sqlite3-journal 67 | 68 | # Flask stuff: 69 | instance/ 70 | .webassets-cache 71 | 72 | # Scrapy stuff: 73 | .scrapy 74 | 75 | # Sphinx documentation 76 | docs/_build/ 77 | 78 | # PyBuilder 79 | .pybuilder/ 80 | target/ 81 | 82 | # Jupyter Notebook 83 | .ipynb_checkpoints 84 | 85 | # IPython 86 | profile_default/ 87 | ipython_config.py 88 | 89 | # pyenv 90 | # For a library or package, you might want to ignore these files since the code is 91 | # intended to run in multiple environments; otherwise, check them in: 92 | # .python-version 93 | 94 | # pipenv 95 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 96 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 97 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 98 | # install all needed dependencies. 99 | #Pipfile.lock 100 | 101 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 102 | __pypackages__/ 103 | 104 | # Celery stuff 105 | celerybeat-schedule 106 | celerybeat.pid 107 | 108 | # SageMath parsed files 109 | *.sage.py 110 | 111 | # Environments 112 | .env 113 | .venv 114 | env/ 115 | venv/ 116 | ENV/ 117 | env.bak/ 118 | venv.bak/ 119 | 120 | # Spyder project settings 121 | .spyderproject 122 | .spyproject 123 | 124 | # Rope project settings 125 | .ropeproject 126 | 127 | # mkdocs documentation 128 | /site 129 | 130 | # mypy 131 | .mypy_cache/ 132 | .dmypy.json 133 | dmypy.json 134 | 135 | # Pyre type checker 136 | .pyre/ 137 | 138 | # pytype static type analyzer 139 | .pytype/ 140 | 141 | # Cython debug symbols 142 | cython_debug/ 143 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Intro 2 | 3 | This is the deployment for [appstream.ubuntu.com](https://appstream.ubuntu.com) 4 | (or [staging](https://appstream.staging.ubuntu.com)). 5 | 6 | # Structure 7 | 8 | There are two main charms. 9 | 10 | ## appstream-generator 11 | 12 | This installs the `appstream-generator` snap from the snap store, arranges for 13 | it to be run on the configured Ubuntu releases, and then presents the results 14 | over rsync for fetching by the Ubuntu archive and the frontend. 15 | 16 | ## appstream-frontend 17 | 18 | This is a subordinate (to `apache2`) charm. It fetches from the generator's 19 | rsync endpoint, and presents the data on the web for browsing. 20 | 21 | ## misc 22 | 23 | The frontends are served over SSL. Termination is provided by haproxy. Frontends 24 | can be scaled horizontally as needed. See the [mojo](https://mojo.canonical.com) 25 | spec in `mojo/` for the deployment. 26 | 27 | # Updating the config 28 | 29 | When there's a new relase, you need to update the config. This does not require 30 | rebuilding the charms. 31 | 32 | To update the configuration, edit config.json, *verify that it is valid json* 33 | and then run: 34 | 35 | ``` 36 | $ pe appstream 37 | sudo -iu stg-appstream se stg-appstream # (0) [WIP][PS5] stg-appstream 38 | sudo -iu prod-appstream se prod-appstream # (1) [WIP][PS5] prod-appstream 39 | Choose environment (q to quit): 1 40 | 41 | # Make config change on a local non-canonical system somewhere and commit 42 | # the config.json changes and pull them on the internal system. 43 | 44 | $juju config appstream-generator config="$(cat config.json)" 45 | ``` 46 | 47 | Sadly Juju doesn't have a native json type currently, so it has to be passed in 48 | as a string and deserialised on the other side. After you update the config with 49 | the `juju config` command, you're all done! After you add a new release, the 50 | next complete run of the appstream-generator will generate the initial set of 51 | appstream data for this release. Once that run is complete (logs available at 52 | https://appstream.ubuntu.com/logs/), the output should be synced to 53 | https://appstream.ubuntu.com within a couple of minutes, and to the Ubuntu archive 54 | (http://archive.ubuntu.com/ubuntu/dists///dep11/) within a 55 | couple of hours. 56 | 57 | You can still do a sanity check before appstream.ubuntu.com updates by checking 58 | the output of `juju config appstream-generator` and look for the config value 59 | (key:value pair). The value should be the contents of `config.json`. 60 | 61 | # Deploying the charms 62 | 63 | You only need to rebuild the charms in charmcraft and deploy those changes if 64 | you're making changes to the `appstream-cloud/charms` directory. The charm 65 | changes should be made and built on a local non-canonical system. Then pull 66 | `built-appstream-generator` branch changes on the internal canonical system. 67 | 68 | To deploy the updated charms, you need to have access to the live environment 69 | (the internal canonical system), which means you need to be a Canonical 70 | employee. 71 | 72 | * After any charm changes, build the charm using `charmcraft build` 73 | (`charmcraft` comes from a snap: `snap install charmcraft`). 74 | * Change to the `built-CHARMNAME` (`built-appstream-generator` or 75 | `built-appstream-frontend`) branch 76 | * use a `git worktree` for this so you can have both branches on your 77 | filesystem at once 78 | * Remove all non-hidden files: `rm -r *` 79 | * Unzip the output of the build step here; `unzip 80 | ../path/to/the/branch/charms/*/CHARMNAME/CHARMNAME.build` 81 | * Commit the changes: `git add .; git commit -m "New build"` 82 | * Check `juju config appstream-generator` and look for the config value (key 83 | value pair). The value should be the contents of `config.json`. 84 | * On the controller machine, execute `mojo run -m manifest-upgrade` 85 | 86 | # License 87 | 88 | Everything here is ⓒ Canonical and is licensed under the GPL-3. See `LICENSE`. 89 | -------------------------------------------------------------------------------- /mojo/bundle.yaml: -------------------------------------------------------------------------------- 1 | {%- if stage_name == "production" %} 2 | {%- set hostname = "appstream.ubuntu.com" %} 3 | {%- set apache_num_units = 2 %} 4 | {%- elif stage_name == "staging" %} 5 | {%- set hostname = "appstream.staging.ubuntu.com" %} 6 | {%- set apache_num_units = 2 %} 7 | {%- else %} 8 | {%- set apache_num_units = 1 %} 9 | {%- endif %} 10 | 11 | series: {{ series }} 12 | applications: 13 | apache2: 14 | charm: cs:apache2 15 | num_units: {{ apache_num_units }} 16 | options: 17 | disable_modules: status 18 | mpm_type: prefork 19 | constraints: root-disk=50G root-disk-source=volume 20 | appstream-frontend: 21 | charm: ./{{ series }}/appstream-frontend 22 | options: 23 | external-hostname: {{ hostname }} 24 | appstream-generator: 25 | charm: ./{{ series }}/appstream-generator 26 | expose: true 27 | num_units: 1 28 | {%- if stage_name == "production" or stage_name == "staging" %} 29 | options: 30 | {%- if stage_name == "staging" %} 31 | default_snap_channel: candidate 32 | {%- endif %} 33 | hostname: https://{{ hostname }} 34 | mirror: http://ftpmaster.internal/ubuntu/ 35 | storage: 36 | appstream: 200G 37 | constraints: cpu-cores=8 mem=16G root-disk-source=volume 38 | telegraf: 39 | charm: telegraf 40 | expose: true 41 | landscape-client: 42 | charm: landscape-client 43 | options: 44 | account-name: standalone 45 | ping-url: http://landscape.is.canonical.com/ping 46 | tags: juju-managed 47 | url: https://landscape.is.canonical.com/message-system 48 | registration-key: include-file://{{local_dir}}/canonical-is-landscape.key 49 | ua: 50 | charm: cs:~ubuntu-advantage-charmers/ubuntu-advantage 51 | options: 52 | token: include-file://{{local_dir}}/canonical-is-ua.key 53 | haproxy: 54 | charm: cs:haproxy 55 | num_units: 1 56 | expose: true 57 | options: 58 | services: | 59 | - service_name: https_service 60 | service_host: "::" 61 | service_port: 443 62 | crts: [DEFAULT] 63 | service_options: 64 | - balance leastconn 65 | - cookie SRVNAME insert 66 | - option httpchk HEAD / HTTP/1.0 67 | - http-request set-header X-Forwarded-Proto https 68 | - "redirect prefix https://{{ hostname }} code 301 unless { hdr(host) -i {{ hostname }} }" 69 | server_options: check inter 10000 rise 2 fall 5 maxconn 512 cookie S{i} 70 | - service_name: http_redirect_to_https 71 | service_host: "::" 72 | service_port: 80 73 | service_options: 74 | - "redirect prefix https://{{ hostname }} code 301 unless { hdr(host) -i {{ hostname }} }" 75 | - "redirect scheme https code 301 if ! { ssl_fc }" 76 | ssl_cert: DEFAULT 77 | ssl_key: 78 | autocert-haproxy: 79 | charm: cs:~autocert-charmers/autocert 80 | options: 81 | autocert_host: autocert.canonical.com 82 | cert_additional_names: {{ hostname }}=default 83 | cert_auth_pairs: include-file://{{local_dir}}/cert_auth_pairs 84 | dir_certs: /var/lib/haproxy 85 | dir_keys: /var/lib/haproxy 86 | service_action: reload 87 | service_name: haproxy 88 | suffix_cert: ".pem" 89 | suffix_chain: ".pem" 90 | suffix_key: ".pem" 91 | relations: 92 | - ["ua", "appstream-generator"] 93 | - ["ua", "apache2"] 94 | - ["ua", "haproxy"] 95 | - ["appstream-generator:juju-info", "telegraf"] 96 | - ["apache2:juju-info", "telegraf"] 97 | - ["haproxy:juju-info", "telegraf"] 98 | - ["landscape-client", "apache2"] 99 | - ["landscape-client", "appstream-generator"] 100 | - ["landscape-client", "haproxy"] 101 | - ["haproxy", "autocert-haproxy"] 102 | - ["haproxy:reverseproxy", "apache2:website"] 103 | {%- endif %} 104 | - ["apache2", "appstream-frontend"] 105 | - ["appstream-generator", "appstream-frontend"] 106 | -------------------------------------------------------------------------------- /charms/appstream-frontend/src/charm.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | # Copyright 2021 Canonical Ltd 3 | 4 | # This program is free software: you can redistribute it and/or modify it under 5 | # the terms of the GNU General Public License as published by the Free Software 6 | # Foundation, either version 3 of the License, or (at your option) any later 7 | # version. 8 | # 9 | # This program is distributed in the hope that it will be useful, but WITHOUT 10 | # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 11 | # FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. 12 | # 13 | # You should have received a copy of the GNU General Public License along with 14 | # this program. If not, see . 15 | 16 | import logging 17 | import subprocess 18 | from pathlib import Path 19 | from textwrap import dedent 20 | 21 | from ops.charm import CharmBase 22 | from ops.framework import StoredState 23 | from ops.main import main 24 | from ops.model import ActiveStatus, BlockedStatus, MaintenanceStatus 25 | 26 | logger = logging.getLogger(__name__) 27 | 28 | PACKAGES_TO_INSTALL = ["rsync"] 29 | RSYNC_ADDRESS_FILE = Path("~ubuntu/rsync-address").expanduser() 30 | SYSTEMD_ENABLE_UNITS = ("sync-appstream.timer",) 31 | SYSTEMD_UNITS = ("sync-appstream.service", "sync-appstream.timer") 32 | 33 | 34 | class AppstreamFrontendCharm(CharmBase): 35 | """Charm the service.""" 36 | 37 | _stored = StoredState() 38 | 39 | def __init__(self, *args): 40 | super().__init__(*args) 41 | self.framework.observe(self.on.install, self._on_install) 42 | self.framework.observe( 43 | self.on.rsync_relation_joined, 44 | self._on_appstream_rsync_relation_joined, 45 | ) 46 | self.framework.observe( 47 | self.on.rsync_relation_departed, 48 | self._on_appstream_rsync_relation_departed, 49 | ) 50 | self.framework.observe( 51 | self.on.apache_website_relation_joined, 52 | self._on_apache_website_relation_joined, 53 | ) 54 | self.framework.observe( 55 | self.on.apache_website_relation_departed, 56 | self._on_apache_website_relation_departed, 57 | ) 58 | self.framework.observe(self.on.upgrade_charm, self._on_upgrade_charm) 59 | self.framework.observe(self.on.start, self._on_start) 60 | self._stored.set_default( 61 | apache_related=False, installed_packages=set(), rsync_address=None 62 | ) 63 | 64 | def _install_packages(self, packages): 65 | packages = packages - self._stored.installed_packages 66 | if not packages: 67 | logger.info("No packages to install.") 68 | return 69 | pkgs = ", ".join(packages) 70 | self.unit.status = MaintenanceStatus(f"Installing {pkgs}") 71 | logger.info(f"Installing apt package(s) {pkgs}") 72 | subprocess.check_call( 73 | [ 74 | "apt-get", 75 | "--assume-yes", 76 | "--option=Dpkg::Options::=--force-confold", 77 | "install", 78 | ] 79 | + list(packages) 80 | ) 81 | self._stored.installed_packages |= packages 82 | 83 | def _maybe_set_active(self): 84 | if self._stored.apache_related: 85 | self.unit.status = ActiveStatus() 86 | else: 87 | self.unit.status = BlockedStatus("Waiting for apache relation") 88 | 89 | def _symlink_scripts(self): 90 | home = Path("~ubuntu").expanduser() 91 | scripts_dir = Path(self.charm_dir) / "scripts" 92 | 93 | for script in scripts_dir.glob("*"): 94 | if script.is_dir(): 95 | continue 96 | dest = home / script.name 97 | try: 98 | dest.symlink_to(script) 99 | logger.info(f"Symlinking {dest} → {script}") 100 | except FileExistsError: 101 | pass 102 | 103 | def _symlink_systemd_units(self): 104 | any_changed = False 105 | unit_dir = Path("/etc/systemd/system") 106 | charm_dir = Path(self.charm_dir) 107 | 108 | for unit in SYSTEMD_UNITS: 109 | dest = unit_dir / unit 110 | try: 111 | target = charm_dir / "units" / unit 112 | dest.symlink_to(target) 113 | any_changed = True 114 | logger.info(f"Symlinking {dest} → {target}") 115 | except FileExistsError: 116 | if dest.resolve() != target.resolve(): 117 | logger.info( 118 | f"Target for {dest} has changed to {target}. Re-creating." 119 | ) 120 | dest.unlink() 121 | dest.symlink_to(target) 122 | any_changed = True 123 | 124 | def _on_start(self, event): 125 | self._ensure_set_up(event) 126 | 127 | if not self._stored.rsync_address: 128 | logger.info("rsync address not set, can't start yet") 129 | self.unit.status = BlockedStatus( 130 | "Not related to appstream-generator, can't start yet." 131 | ) 132 | event.defer() 133 | return 134 | 135 | for unit in SYSTEMD_ENABLE_UNITS: 136 | subprocess.check_call( 137 | ["systemctl", "enable", "--quiet", "--now", unit] 138 | ) 139 | 140 | self._maybe_set_active() 141 | 142 | def _ensure_set_up(self, event): 143 | self._install_packages(PACKAGES_TO_INSTALL) 144 | self._symlink_scripts() 145 | self._symlink_systemd_units() 146 | 147 | def _on_install(self, event): 148 | self._ensure_set_up(event) 149 | 150 | def _on_appstream_rsync_relation_joined(self, event): 151 | data = event.relation.data[event.unit] 152 | private_address = data["private-address"] 153 | self._stored.rsync_address = private_address 154 | logger.info(f"rsync address is {private_address}") 155 | with open(RSYNC_ADDRESS_FILE, "w") as f: 156 | f.write(f"RSYNC_ADDRESS={private_address}\n") 157 | 158 | def _on_upgrade_charm(self, event): 159 | self._ensure_set_up(event) 160 | 161 | def _on_appstream_rsync_relation_departed(self, event): 162 | self._stored.rsync_address = None 163 | logger.info("rsync address removed, disabling") 164 | for unit in SYSTEMD_ENABLE_UNITS: 165 | subprocess.check_call( 166 | ["systemctl", "disable", "--quiet", "--now", unit] 167 | ) 168 | RSYNC_ADDRESS_FILE.unlink() 169 | 170 | def _on_apache_website_relation_joined(self, event): 171 | if not self._stored.rsync_address: 172 | logger.info("rsync address not set, can't start yet") 173 | self.unit.status = BlockedStatus( 174 | "Not related to appstream-generator, can't set up website yet." 175 | ) 176 | event.defer() 177 | return 178 | 179 | data = event.relation.data[self.unit] 180 | external_hostname = self.model.config.get("external-hostname") 181 | apache_config = dedent( 182 | f""" 183 | 184 | Options Indexes FollowSymLinks 185 | Require all granted 186 | 187 | 188 | 189 | Options -Indexes 190 | 191 | 192 | 193 | Options Indexes 194 | Require all granted 195 | 196 | 197 | Alias /data /home/ubuntu/appstream/data 198 | Alias /media /home/ubuntu/appstream/media 199 | Alias /logs /home/ubuntu/logs 200 | Alias /hints /home/ubuntu/appstream/hints 201 | 202 | ServerName {external_hostname} 203 | DocumentRoot /home/ubuntu/appstream/html 204 | ErrorLog ${{APACHE_LOG_DIR}}/error.log 205 | CustomLog ${{APACHE_LOG_DIR}}/custom.log combined 206 | AddType 'text/plain' .log 207 | AddCharset UTF-8 .log 208 | 209 | """ 210 | ) 211 | data["domain"] = external_hostname 212 | data["enabled"] = "true" 213 | data["ports"] = "80" 214 | data["site_config"] = apache_config 215 | data["site-modules"] = "autoindex" 216 | logger.info(f"Setting up apache site for {external_hostname}") 217 | self._stored.apache_related = True 218 | self._maybe_set_active() 219 | 220 | def _on_apache_website_relation_departed(self, event): 221 | self._stored.apache_related = False 222 | logger.info("apache relation removed, disabling") 223 | self._maybe_set_active() 224 | 225 | 226 | if __name__ == "__main__": 227 | main(AppstreamFrontendCharm) 228 | -------------------------------------------------------------------------------- /charms/appstream-frontend/LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | -------------------------------------------------------------------------------- /charms/appstream-generator/LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | -------------------------------------------------------------------------------- /charms/appstream-generator/src/charm.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | # Copyright 2021 Canonical Ltd 3 | 4 | # This program is free software: you can redistribute it and/or modify it under 5 | # the terms of the GNU General Public License as published by the Free Software 6 | # Foundation, either version 3 of the License, or (at your option) any later 7 | # version. 8 | # 9 | # This program is distributed in the hope that it will be useful, but WITHOUT 10 | # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 11 | # FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. 12 | # 13 | # You should have received a copy of the GNU General Public License along with 14 | # this program. If not, see . 15 | 16 | import json 17 | import logging 18 | import os 19 | import shutil 20 | import subprocess 21 | from pathlib import Path 22 | from textwrap import dedent 23 | 24 | from charmhelpers.core.hookenv import open_port 25 | from ops.charm import CharmBase 26 | from ops.framework import StoredState 27 | from ops.main import main 28 | from ops.model import ActiveStatus, BlockedStatus, MaintenanceStatus 29 | 30 | logger = logging.getLogger(__name__) 31 | 32 | # This is a special value that means we use the default channel, which comes 33 | # from the charm config. 34 | DEFAULT_SNAP_CHANNEL = None 35 | 36 | APPSTREAM_BASE = Path("~ubuntu/appstream").expanduser() 37 | APPSTREAM_PUBLIC = APPSTREAM_BASE / "appstream-public" 38 | APPSTREAM_WORKDIR = APPSTREAM_BASE / "appstream-workdir" 39 | ENVIRONMENT_FILE = Path("/etc/environment.d/proxy.conf") 40 | INPUT_FILENAME = "asgen-config.json.in" 41 | OUTPUT_FILENAME = APPSTREAM_WORKDIR / "asgen-config.json" 42 | PACKAGES_TO_INSTALL = ["jq"] 43 | SNAPS_TO_INSTALL = {"appstream-generator": DEFAULT_SNAP_CHANNEL} 44 | SYSTEMD_ENABLE_UNITS = ("appstream-generator.timer",) 45 | SYSTEMD_UNITS = ("appstream-generator.service", "appstream-generator.timer") 46 | 47 | CONFIG_DEFAULT_PRIORITY = 0 48 | 49 | CONFIG_PRIORITIES = { 50 | "updates": 10, 51 | "security": 20, 52 | "proposed": 30, 53 | "backports": 40, 54 | } 55 | 56 | CONFIG_HEADER = { 57 | "ProjectName": "Ubuntu", 58 | "Backend": "ubuntu", 59 | "Oldsuites": [], 60 | "Suites": {}, 61 | "Features": {"validateMetainfo": True}, 62 | } 63 | 64 | 65 | class AppstreamGeneratorCharm(CharmBase): 66 | _stored = StoredState() 67 | 68 | def __init__(self, *args): 69 | super().__init__(*args) 70 | 71 | self.framework.observe(self.on.config_changed, self._on_config_changed) 72 | self.framework.observe(self.on.install, self._on_install) 73 | self.framework.observe( 74 | self.on.appstream_storage_attached, 75 | self._on_appstream_storage_attached, 76 | ) 77 | self.framework.observe( 78 | self.on.appstream_storage_detaching, 79 | self._on_appstream_storage_detaching, 80 | ) 81 | self.framework.observe(self.on.start, self._on_start) 82 | self.framework.observe(self.on.clean_action, self._on_clean_action) 83 | self.framework.observe(self.on.forget_action, self._on_forget_action) 84 | self.framework.observe( 85 | self.on.forget_tag_action, self._on_forget_tag_action 86 | ) 87 | 88 | self._stored.set_default( 89 | installed_packages=set(), 90 | installed_snaps=dict(), 91 | storage_attached=False, 92 | ) 93 | 94 | def _on_clean_action(self, event): 95 | clean_file = APPSTREAM_BASE / "clean" 96 | with clean_file.open("w") as f: 97 | pass 98 | shutil.chown(clean_file, user="ubuntu", group="ubuntu") 99 | logger.info("Data will be cleaned with the next full run.") 100 | 101 | def _on_forget_action(self, event): 102 | forget_file = APPSTREAM_BASE / "forget" 103 | packages_raw = event.params["packages"] 104 | packages = json.loads(packages_raw) 105 | packages_s = ", ".join(packages) 106 | logger.info(f"Forgetting {packages_s}") 107 | with forget_file.open("a") as f: 108 | for package in packages: 109 | f.write(f"{package}\n") 110 | 111 | def _on_forget_tag_action(self, event): 112 | import lzma 113 | 114 | forget_file = APPSTREAM_BASE / "forget" 115 | hints_files = (APPSTREAM_PUBLIC / "hints").glob("*/*/Hints-*.xz") 116 | tag_to_forget = event.params["tag"] 117 | logger.info(f"Forgetting all packages with tag {tag_to_forget}") 118 | 119 | for filename in hints_files: 120 | p = set() 121 | hf = lzma.open(filename, "rt", encoding="utf-8") 122 | j = json.load(hf) 123 | for (v, pkg) in [ 124 | (v, pkg) 125 | for (d, pkg) in [(t["hints"], t["package"]) for t in j] 126 | for v in d.values() 127 | ]: 128 | for i in v: 129 | if i["tag"] == tag_to_forget: 130 | p.add(pkg) 131 | 132 | with forget_file.open("a") as f: 133 | for pkg in p: 134 | f.write(f"{pkg}\n") 135 | 136 | def _on_appstream_storage_attached(self, event): 137 | self._stored.storage_attached = True 138 | mp = self.meta.storages["appstream"].location 139 | shutil.chown(mp, user="ubuntu", group="ubuntu") 140 | try: 141 | APPSTREAM_WORKDIR.mkdir(parents=True, exist_ok=False) 142 | shutil.chown(APPSTREAM_WORKDIR, user="ubuntu", group="ubuntu") 143 | except FileExistsError: 144 | pass 145 | 146 | def _on_appstream_storage_detaching(self, _): 147 | self._stored.storage_attached = False 148 | 149 | def _on_start(self, event): 150 | if not self._ensure_set_up(event, more_to_do=True): 151 | return 152 | 153 | for unit in SYSTEMD_ENABLE_UNITS: 154 | subprocess.check_call( 155 | ["systemctl", "enable", "--quiet", "--now", unit] 156 | ) 157 | self.unit.status = ActiveStatus() 158 | 159 | def _install_packages(self, packages): 160 | packages = packages - self._stored.installed_packages 161 | if not packages: 162 | logger.info("No packages to install.") 163 | return 164 | pkgs = ", ".join(packages) 165 | self.unit.status = MaintenanceStatus(f"Installing {pkgs}") 166 | logger.info(f"Installing apt package(s) {pkgs}") 167 | subprocess.check_call( 168 | [ 169 | "apt-get", 170 | "--assume-yes", 171 | "--option=Dpkg::Options::=--force-confold", 172 | "install", 173 | ] 174 | + list(packages) 175 | ) 176 | self._stored.installed_packages |= packages 177 | 178 | def _install_snaps(self, wanted_snaps): 179 | default_snap_channel = self.model.config.get( 180 | "default_snap_channel", "stable" 181 | ) 182 | snaps_to_install = {} 183 | for snap in wanted_snaps: 184 | wanted_channel = wanted_snaps[snap] or default_snap_channel 185 | if snap not in self._stored.installed_snaps: 186 | verb = "install" 187 | else: 188 | if self._stored.installed_snaps[snap] == wanted_channel: 189 | continue 190 | verb = "refresh" 191 | snaps_to_install[snap] = wanted_channel, verb 192 | 193 | if not snaps_to_install: 194 | logger.info("No snaps to install.") 195 | return 196 | snps_install = ", ".join( 197 | [ 198 | s 199 | for s in snaps_to_install 200 | if snaps_to_install[s][1] == "install" 201 | ] 202 | ) 203 | status_list = [] 204 | if snps_install: 205 | status_list.append(f"Installing snap packages: {snps_install}") 206 | snps_refresh = ", ".join( 207 | [ 208 | f"{s}/{snaps_to_install[s][0]}" 209 | for s in snaps_to_install 210 | if snaps_to_install[s][1] == "refresh" 211 | ] 212 | ) 213 | if snps_refresh: 214 | status_list.append(f"Refreshing snap packages: {snps_refresh}") 215 | status_string = "; ".join(status_list) 216 | 217 | self.unit.status = MaintenanceStatus(status_string) 218 | logger.info(status_string) 219 | for snap, (channel, verb) in snaps_to_install.items(): 220 | subprocess.check_call( 221 | [ 222 | "snap", 223 | verb, 224 | "--channel", 225 | channel, 226 | snap, 227 | ], 228 | ) 229 | self._stored.installed_snaps[snap] = channel 230 | 231 | def _set_up_proxy(self): 232 | http_proxy = self.model.config.get("http-proxy") 233 | https_proxy = self.model.config.get("https-proxy") 234 | no_proxy = self.model.config.get("no-proxy") 235 | 236 | if http_proxy or https_proxy or no_proxy: 237 | logger.info(f"Writing proxy settings to {ENVIRONMENT_FILE}") 238 | ENVIRONMENT_FILE.mkdir(parents=True, exist_ok=True) 239 | with ENVIRONMENT_FILE.open("w") as env: 240 | if http_proxy: 241 | env.write(f"http_proxy={http_proxy}\n") 242 | if https_proxy: 243 | env.write(f"https_proxy={https_proxy}\n") 244 | if no_proxy: 245 | env.write(f"no_proxy={no_proxy}\n") 246 | else: 247 | try: 248 | os.unlink(ENVIRONMENT_FILE) 249 | except FileNotFoundError: 250 | pass 251 | 252 | def _config_process_suite( 253 | self, release, info, default_arches, default_suites 254 | ): 255 | out = {} 256 | for suite in ( 257 | "%s%s" % (release, s) for s in info.get("suites", default_suites) 258 | ): 259 | out[suite] = { 260 | "useIconTheme": "Humanity", 261 | "dataPriority": CONFIG_PRIORITIES.get( 262 | suite.split("-")[-1], CONFIG_DEFAULT_PRIORITY 263 | ), 264 | "sections": ["main", "universe", "multiverse", "restricted"], 265 | "architectures": info.get("architectures", default_arches), 266 | } 267 | if suite != release: 268 | out[suite]["baseSuite"] = release 269 | try: 270 | # if we have 'released' : true, make the base suite immutable 271 | info["released"] 272 | out[release]["immutable"] = True 273 | except KeyError: 274 | pass 275 | 276 | return out 277 | 278 | def _write_config(self): 279 | mirror = self.model.config.get("mirror") 280 | hostname = self.model.config.get("hostname") 281 | config = self.model.config.get("config") 282 | 283 | if not (mirror and hostname and config): 284 | logger.info("No config set. Can't continue.") 285 | return False 286 | 287 | config_j = json.loads(config) 288 | 289 | # Read the defaults 290 | default_arches = config_j["default"]["architectures"] 291 | default_suites = config_j["default"]["suites"] 292 | del config_j["default"] 293 | 294 | o = CONFIG_HEADER 295 | o["ArchiveRoot"] = mirror 296 | o["MediaBaseUrl"] = f"{hostname}/media" 297 | o["HtmlBaseUrl"] = hostname 298 | 299 | # Now do the rest 300 | for (release, ting) in config_j.items(): 301 | if ting.get("oldSuite", False): 302 | CONFIG_HEADER["Oldsuites"].append(release) 303 | o["Suites"].update( 304 | self._config_process_suite( 305 | release, ting, default_arches, default_suites 306 | ) 307 | ) 308 | 309 | OUTPUT_FILENAME.parent.mkdir(parents=True, exist_ok=True) 310 | with OUTPUT_FILENAME.open("w") as f: 311 | f.write(json.dumps(o, indent=4, sort_keys=True)) 312 | shutil.chown(OUTPUT_FILENAME, user="ubuntu", group="ubuntu") 313 | 314 | return True 315 | 316 | def _symlink_systemd_units(self): 317 | any_changed = False 318 | unit_dir = Path("/etc/systemd/system") 319 | charm_dir = Path(self.charm_dir) 320 | 321 | for unit in SYSTEMD_UNITS: 322 | dest = unit_dir / unit 323 | try: 324 | target = charm_dir / "units" / unit 325 | dest.symlink_to(target) 326 | any_changed = True 327 | logger.info(f"Symlinking {dest} → {target}") 328 | except FileExistsError: 329 | if dest.resolve() != target.resolve(): 330 | logger.info( 331 | f"Target for {dest} has changed to {target}. Re-creating." 332 | ) 333 | dest.unlink() 334 | dest.symlink_to(target) 335 | any_changed = True 336 | 337 | if any_changed: 338 | subprocess.check_call(["systemctl", "daemon-reload"]) 339 | 340 | def _symlink_scripts(self): 341 | home = Path("~ubuntu").expanduser() 342 | scripts_dir = Path(self.charm_dir) / "scripts" 343 | 344 | for script in scripts_dir.glob("*"): 345 | if script.is_dir(): 346 | continue 347 | dest = home / script.name 348 | try: 349 | dest.symlink_to(script) 350 | logger.info(f"Symlinking {dest} → {script}") 351 | except FileExistsError: 352 | pass 353 | 354 | def _set_up_rsync(self): 355 | any_written = False 356 | rsync_conf = Path("/etc/rsyncd.conf") 357 | rsync_d = Path("/etc/rsync-juju.d/") 358 | names_paths = ( 359 | ("appstream", APPSTREAM_PUBLIC / "data"), 360 | ("www", APPSTREAM_PUBLIC), 361 | ("logs", APPSTREAM_BASE / "logs"), 362 | ) 363 | rsync_template = dedent( 364 | """[{name}] 365 | path = {path} 366 | read only = yes 367 | list = yes 368 | uid = ubuntu 369 | gid = ubuntu 370 | chroot = false 371 | """ 372 | ) 373 | 374 | try: 375 | # XXX: This means if we change the template, changes will not be 376 | # written to the output file. 377 | with rsync_conf.open("x") as f: 378 | f.write( 379 | dedent( 380 | """ 381 | uid = nobody 382 | gid = nogroup 383 | pid file = /var/run/rsyncd.pid 384 | syslog facility = daemon 385 | socket options = SO_KEEPALIVE 386 | timeout = 7200 387 | 388 | &include /etc/rsync-juju.d 389 | """ 390 | ) 391 | ) 392 | except FileExistsError: 393 | pass 394 | 395 | rsync_d.mkdir(parents=True, exist_ok=True) 396 | 397 | for name, path in names_paths: 398 | path.mkdir(parents=True, exist_ok=True) 399 | try: 400 | # XXX: This means if we change the template above, changes will 401 | # not be written to the output file. 402 | conf = rsync_d / f"{name}.conf" 403 | with conf.open("x") as f: 404 | logger.info(f"Writing rsync config to {conf}") 405 | f.write(rsync_template.format(name=name, path=path)) 406 | any_written = True 407 | except FileExistsError: 408 | pass 409 | 410 | if any_written: 411 | subprocess.check_call(["systemctl", "restart", "rsync"]) 412 | open_port(873) 413 | 414 | def _ensure_set_up(self, event, more_to_do=False): 415 | if not self._stored.storage_attached: 416 | event.defer() 417 | self.unit.status = BlockedStatus( 418 | "Waiting for storage to become attached." 419 | ) 420 | return False 421 | 422 | self._install_packages(set(PACKAGES_TO_INSTALL)) 423 | self._install_snaps(SNAPS_TO_INSTALL) 424 | self._set_up_proxy() 425 | self._symlink_systemd_units() 426 | self._symlink_scripts() 427 | self._set_up_rsync() 428 | 429 | if not self._write_config(): 430 | logger.info("Failed to write config. Blocked.") 431 | event.defer() 432 | self.unit.status = BlockedStatus( 433 | "Config not set. Make sure config, hostname and mirror are set." 434 | ) 435 | return False 436 | 437 | if not more_to_do: 438 | self.unit.status = ActiveStatus() 439 | return True 440 | 441 | def _on_install(self, event): 442 | # We're not started yet, so don't set active. We'll do that after the 443 | # `start` hook. 444 | self._ensure_set_up(event, more_to_do=True) 445 | 446 | def _on_config_changed(self, event): 447 | if "appstream-generator" not in self._stored.installed_snaps: 448 | event.defer() 449 | return 450 | 451 | self._ensure_set_up(event) 452 | 453 | 454 | if __name__ == "__main__": 455 | main(AppstreamGeneratorCharm) 456 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | --------------------------------------------------------------------------------