19 | {% endblock content %}
20 |
--------------------------------------------------------------------------------
/templates/thank-you.html:
--------------------------------------------------------------------------------
1 | {% extends '_layout.html' %}
2 |
3 | {% block title %} Thank you | Anbox Cloud {% endblock %}
4 |
5 | {% block description %}Anbox Cloud is the mobile cloud computing platform delivered by Canonical. Run Android in the cloud, at high scale and on any type of hardware. Canonical partners with cloud providers and computing hardware manufacturer to accelerate your time to market and provide long term commercial support.{% endblock %}
6 |
7 |
8 | {% block content %}
9 |
10 |
11 |
12 |
13 |
Thanks for getting in touch
14 |
A member of our team will be in touch within one working day.
I agree that my use of the services are subject to my adherence to, and acceptance of, the Terms of Service*, Privacy Notice and Privacy Policy.
4 | TERMS OF SERVICE
5 | 1. Introduction
6 | These Terms of Service cover your access to the Anbox Cloud Demo Service (“Anbox Cloud Demo”) made available by Canonical Group Limited ("Canonical", "us", "our" or "we") to you ("you" or "your") subject to and in accordance with these Terms of Service (the “Service”).
7 |
8 | Please read these Terms of Service carefully before you use the Services. By using Services, you agree to become bound by these Terms of Service. You may not use the Service for illegal or unauthorised purposes or otherwise in accordance with these Terms of Service.
9 |
10 | If you are entering into these Terms of Service on behalf of a company or legal entity, you represent that you have authority to bind such company or legal entity, its officers, employees and agents and all users who access the Service through the account, to these Terms of Service. “you” and “your” shall refer to the company or legal entity and such users. If you do not have such authority do not accept these Terms of Service.
11 |
12 | You must be at least 13 years old to use the Service. If you are between age 13 and 18, we require your parent's or legal guardian's consent to use of the Services, please contact us at legal@canonical.com.
13 |
14 | Any change or update to the Services or Terms of Service will be made in accordance with section 6 below.
15 |
16 | 2. Services
17 | The Service enables you to access a demo of Anbox Cloud (https://anbox-cloud.io) which includes streaming an Android system from the cloud.
18 |
19 | 3. Account
20 | You will need an account to access and use the Service. We reserve the right to reject your request for an account or to immediately cancel or suspend your account and your use of the Services at any time if you do not comply with the following requirements. You must not attempt to create an account or use the Service if doing so would violate these Terms of Service. You must:
21 |
22 | have a Service account
23 | not use the Service for illegal or unauthorised purposes (or which encourage or permit illegal or authorised purposes), in infringement of a third party's’ rights or otherwise in accordance with these Terms of Service
24 | not take any action or use the Service in any way that might bring Canonical into disrepute or affect the ability of Canonical to provide the Service
25 | not use the Service in any manner that might be libellous or defamatory, that contains threats or incites violence towards individuals or entities, or that violates the privacy rights of any third party
26 | not be located in or use the Services in an OFAC/EAR embargoed or sanctioned country or be on the U.S. Commerce Department’s Denied Persons List, Entity List, or Unverified List
27 |
28 | In order to access the Anbox Cloud Demo you will require an invitation code and a Single Sign On account with Canonical. If you do not have an account you will need to create one. You are responsible for choosing an appropriate password for your accounts and for keeping such password secure. Canonical will not ask you for your password and you should not reveal it to anyone. You are responsible for keeping your account details up to date.
29 |
30 | 4. End of Service
31 |
32 | We look forward to providing you with the Service for a limited trial period only. The trial period will be specified on the invitation code and may differ from user to user. However, there are also some circumstances under which the Service may be suspended or terminated:
33 |
34 | We cease to make the Service (or any part thereof) available
35 | By us at any time as described in Section 3 above
36 |
37 | We may also cease to offer the Services for any other reason, in which case we will provide you with notice on your account page.
38 |
39 | 6. Changes
40 |
41 | We aim to continually improve the delivery and content of the Service and accordingly may make changes to the Service throughout the trial.
42 |
43 | This Service is offered on a trial basis, and your use of this Service will be limited to the period of your trial. New features may be added, but we may also modify or discontinue (temporarily or permanently) part of the Service, in part or in whole before the end of the trial period.
44 |
45 | In the event of a material change to the Service, we will notify you on your account page. What constitutes a material change in this circumstance will be determined by Canonical, in good faith and using common sense and reasonable judgment.
46 |
47 | Similarly, we may occasionally make changes to these Terms of Service and will notify you of material changes either by email or on your account page. If Canonical does make changes to these Terms of Service, all changes will go into effect at the time we post the updated Terms of Service on your account page or as otherwise notified at that time.
48 | 7. Intellectual property
49 |
50 | You have a non-exclusive, non-transferable (to the extent permitted by law) right to view, access and use the Services for such time as it is made available by us strictly in accordance with these Terms of Service.
51 |
52 | You will not acquire any rights to the Service (or the intellectual property rights contained therein) from your use of the Service, other than as set out in these Terms of Service.
53 |
54 | 8. Personal data
55 |
56 | In order to provide the Service to you, you will be required to provide information about yourself such as your name, address, job title and company. Any such information you provide to Canonical must always be accurate, correct and up to date.
57 |
58 | Our Privacy Notice and Privacy Policy explain how we treat your personal data and protect your privacy when using the Services and our services in general. Canonical may provide limited personal data, such as your name, email address and related information, to third parties Ampere Computing LLC with a registered office at 4655 Great America Pkwy Suite 601 Santa Clara, CA 95054, United States and Packet Host Inc., with a registered office in 30 Vesey Street, New York, 10007 NY, United States. By accessing the Anbox Cloud Demo you are agreeing to the use of your personal data in this way.
59 |
60 | We may also collect certain non-personally-identifiable information, which is located on your computer. The information collected may include statistics relating to how often data is transferred, and performance metrics in relation to software and configuration. You agree this information may be retained and used by Canonical.
61 |
62 | Canonical may disclose any or all personal data and contents you have sent, posted or published if required to comply with applicable law or the order or requirement of a court, administrative agency or other governmental body. All other use of your personal data is subject to the Privacy Policy.
63 | 9. Liability
64 | Your use of the Service is at your sole risk. The Service is provided on an “as is” and “as available” basis without warranty of any kind.
65 |
66 | In the case of the Service provided by Canonical, the Service is provided “as is” and, other than as expressly set out in these Terms of Service, all warranties (whether express, implied, statutory or otherwise) in respect of the Services are expressly excluded to the maximum extent permitted by law.
67 |
68 | Canonical will provide the Services with reasonable care and skill, and Canonical will use reasonable efforts to ensure the availability of the Services, but makes no guarantee that the Services will be available without interruption or will be error-free.
69 |
70 | Canonical will not be liable in contract, tort or otherwise for any: indirect or consequential loss; loss of profits; loss of revenue; loss of anticipated savings; loss of business or business opportunity; loss of goodwill; or loss of or corruption to data. Otherwise, Canonical’s total liability in contract, tort or otherwise for any claims is limited to £10.
71 |
72 | Nothing in these Terms of Service will exclude or limit Canonical’s liability for: death or personal injury caused by the negligence of Canonical; fraud or fraudulent misrepresentation; or any other liability that cannot be excluded or limited by law.
73 |
74 | 9. General
75 | These Terms of Service are governed by the laws of England and any dispute will be heard by the courts in England.
76 |
77 | Failure by Canonical to enforce any right or provision of these Terms of Service shall not constitute a waiver of such right or provision. If any part of these Terms of Service is held invalid or unenforceable, that part will be construed to reflect the parties original intent, and the remaining portions will remain in full force and effect. The terms of these Terms of Service do not affect your statutory rights.
78 |
79 | Any notices should be sent by email to legal@canonical.com or by registered post to:
80 |
81 | Canonical Group Limited,
82 | 5 New Street Square,
83 | London,
84 | EC4A 3TW.
85 |
86 | Version: January 2020
87 |
88 |
--------------------------------------------------------------------------------
/run:
--------------------------------------------------------------------------------
1 | #! /usr/bin/env bash
2 |
3 | # CAUTION:
4 | # This file was generated by generator-canonical-webteam@3.4.3
5 | # and should usually not be edited directly.
6 | #
7 | # This file was generated by the "canonical-webteam" Yeoman generator
8 | # https://npmjs.org/package/generator-canonical-webteam
9 | #
10 | # Update it to the latest version with:
11 | #
12 | # $ sudo npm install -g yo generator-canonical-webteam
13 | # $ yo canonical-webteam:run
14 |
15 | set -euo pipefail
16 |
17 | USAGE="How to use ./run v3.4.3
18 | ===
19 |
20 | $ ./run \\
21 | [-e|--env VAR_NAME=value] # Declare an environment variable to use while running commands \\
22 | [-m|--node-module PATH] # A path to a local node module to use instead of the installed dependencies \\
23 | [COMMAND] # Optionally provide a command to run
24 |
25 | If no COMMAND is provided, \`serve\` will be run.
26 |
27 | Commands
28 | ---
29 |
30 | - serve [-p|--port PORT] [-d|--detach] [-f|--forward-port]: Run a development server
31 | - watch [-s|--watch-site]: Run \`yarn run watch\` (for jekyll sites, watch for changes with \`--watch-site\`)
32 | - build: Run \`yarn run build\`
33 | - test: Run \`yarn run test\`
34 | - test-python: Run \`yarn run test-python\`
35 | - lint-python: Run \`yarn run lint-python\`
36 | - stop: Stop any running containers
37 | - exec [-r|--root] [-p|--expose-port PORT] : Run a command in the development container (optionally exposing a port to the host)
38 | - yarn [-r|--root] [-p|--expose-port PORT] : Run a yarn script from package.json
39 | - clean: Remove all images and containers, any installed dependencies and the .docker-project file
40 | - clean-cache: Empty cache files, which are saved between projects (eg, yarn)
41 | "
42 |
43 | ##
44 | # Variable definitions
45 | ##
46 |
47 | # Define docker images versions
48 | dev_image="canonicalwebteam/dev:v1.6.7"
49 | if [ -n "${DOCKER_REGISTRY:-}" ]; then
50 | dev_image="${DOCKER_REGISTRY}/${dev_image}"
51 | fi
52 |
53 | # Interactivity options
54 | [ -t 1 ] && tty="--tty --interactive" || tty="" # Do we have a terminal?
55 | [ -f .env ] && env_file="--env-file .env" || env_file="" # Do we have an env file?
56 | [ -f .env.local ] && env_file="${env_file} --env-file .env.local" || env_file=$env_file # Do we have a local env file?
57 |
58 | # Defaults environment settings
59 | PORT=8000
60 |
61 | # Import environment settings
62 | if [ -f .env ]; then
63 | source .env
64 | fi
65 |
66 | # Other variables
67 | run_serve_docker_opts="${CANONICAL_WEBTEAM_RUN_SERVE_DOCKER_OPTS:-}"
68 | module_volumes=""
69 | env_vars=""
70 |
71 | # Decide which md5 command to use
72 | if $(command -v md5sum > /dev/null); then md5_command="md5sum";
73 | elif $(command -v md5 > /dev/null); then md5_command="md5";
74 | else echo "No md5 tool available. Exiting."; exit 1; fi
75 |
76 | ##
77 | # Check docker is installed correctly
78 | ##
79 | if ! command -v docker >/dev/null 2>&1; then
80 | echo "
81 | Error: Docker not installed
82 | ==
83 | Please install Docker before continuing:
84 | https://www.docker.com/products/docker
85 | "
86 | exit 1
87 | fi
88 | if grep -q '^docker:' /etc/group && ! groups | grep -q '\bdocker\b'; then
89 | echo "
90 | Error: `whoami` not in docker group
91 | ===
92 | Please add this user to the docker group, e.g. with:
93 | \$ newgrp docker
94 | "
95 | exit 1
96 | fi
97 |
98 | # Grab HTTP_PROXY settings from the host
99 | http_proxy=""
100 | yarn_proxy=""
101 | if [ -n "${HTTP_PROXY:-}" ]; then
102 | http_proxy="--env HTTP_PROXY=${HTTP_PROXY} --env http_proxy=${HTTP_PROXY}"
103 | yarn_proxy="--proxy ${HTTP_PROXY}"
104 | fi
105 | if [ -n "${HTTPS_PROXY:-}" ]; then
106 | http_proxy="${http_proxy} --env HTTPS_PROXY=${HTTPS_PROXY} --env https_proxy=${HTTPS_PROXY}"
107 | yarn_proxy="${yarn_proxy} --https-proxy ${HTTPS_PROXY}"
108 | fi
109 |
110 | # Generate the project name
111 | if [[ -f ".docker-project" ]]; then
112 | project=$(cat .docker-project)
113 | else
114 | directory="$(basename "$(pwd)")"
115 | hash=$(pwd | ${md5_command} | cut -c1-8)
116 | project=canonical-webteam-${directory}-${hash}
117 | echo $project > .docker-project
118 | fi
119 |
120 | # Volume names
121 | cache_volume="${CANONICAL_WEBTEAM_CACHE_VOLUME:-canonical-webteam-cache}"
122 | etc_volume="${project}-etc"
123 | usr_local_volume="${project}-usr-local"
124 | db_volume="${project}-db"
125 |
126 | # Container names
127 | db_container="${project}-db"
128 | pip_container="${project}-pip"
129 |
130 | # Network name
131 | network_name="${project}-net"
132 |
133 | invalid() {
134 | message=${1}
135 | echo "Error: ${message}"
136 | echo ""
137 | echo "$USAGE"
138 | exit 1
139 | }
140 |
141 | # Read optional arguments
142 | while [[ -n "${1:-}" ]] && [[ "${1:0:1}" == "-" ]]; do
143 | key="$1"
144 |
145 | case $key in
146 | -e|--env)
147 | if [ -z "${2:-}" ]; then invalid "Missing environment variables. Usage: --env XXXX=yyyy"; fi
148 | env_vars="${env_vars} --env ${2}"
149 | shift
150 | ;;
151 | -m|--node-module)
152 | if [ -z "${2:-}" ]; then invalid "Missing module name. Usage: --node-module ."; fi
153 | # Ensure directories exist, ready to host module volumes
154 | if [ ! -d "`pwd`/node_modules/$(basename ${2})" ]; then
155 | mkdir -p "`pwd`/node_modules/$(basename ${2})"
156 | fi
157 | module_volumes="${module_volumes} --volume=${2}:`pwd`/node_modules/$(basename ${2})"
158 | shift
159 | ;;
160 | -h|--help) echo "$USAGE"; exit ;;
161 | -v|--version) echo "Generated from generator-canonical-webteam@3.4.3"; exit ;;
162 | *) invalid "Option '${key}' not recognised." ;;
163 | esac
164 | shift
165 | done
166 |
167 | start_django_db () {
168 | # Run the database if necessary
169 | if grep -q django.db.backends.postgresql_psycopg2 */settings.py 2> /dev/null; then
170 | # Create isolated network
171 | if ! docker network inspect ${network_name} &> /dev/null; then
172 | docker network create ${network_name}
173 | fi
174 |
175 | # Start the database
176 | trap "kill_container ${db_container}" EXIT;
177 | if ! docker inspect -f {{.State.Running}} ${db_container} &>/dev/null; then
178 | docker run \
179 | --name ${db_container} `# Name the container` \
180 | --rm `# Remove the container once it's finished` \
181 | --volume "${db_volume}":/var/lib/postgresql/data `# Store dependencies in a docker volume` \
182 | ${http_proxy} `# Include HTTP proxy if needed` \
183 | --network ${network_name} `# Use an isolated network` \
184 | --network-alias db `# Call this container "db" on the network so it can be found` \
185 | --detach `# Run in the background` \
186 | postgres `# Use the image for node version 7`
187 | fi
188 |
189 | # Wait for it
190 | wait_time=0
191 | until docker exec ${db_container} pg_isready || [ $wait_time -eq 4 ]; do
192 | sleep $(( wait_time++ ))
193 | done
194 |
195 | # Provision database
196 | run_as_user "${network}" python3 manage.py migrate
197 | fi
198 | }
199 |
200 | kill_container () {
201 | container_name="${1}"
202 |
203 | # Kill any previous containers
204 | previous_id=$(docker ps --all --quiet --filter "name=^/${container_name}$")
205 | if [ -n "${previous_id}" ]; then
206 | docker rm --force ${previous_id} > /dev/null;
207 | fi
208 | }
209 |
210 | docker_run () {
211 | # Get options
212 | docker_run_options="${1}"; shift
213 |
214 | # Generate container name from command
215 | container_name="${project}-${@}"
216 | container_name="${container_name// /_}" # Replace spaces with underscores
217 | container_name=$(echo ${container_name} | tr -dc '[:alnum:]_.-') # Remove disallowed chars
218 |
219 | # Use network if it's been setup
220 | network=""
221 | if docker network inspect ${network_name} &> /dev/null; then
222 | network="--network ${network_name}"
223 | fi
224 |
225 | # Kill existing containers
226 | kill_container "${container_name}"
227 |
228 | # Environment info
229 | commit_id=$(git rev-parse HEAD || echo "unknown")
230 |
231 | # Start the new container
232 | docker run \
233 | --name ${container_name} `# Name the container` \
234 | --rm `# Remove the container once it's finished` \
235 | --volume "$(pwd):$(pwd)" `# Mirror current directory inside container` \
236 | --workdir "$(pwd)" `# Set current directory to the image's work directory` \
237 | --volume ${etc_volume}:/etc `# Use etc with corresponding user added` \
238 | --volume ${usr_local_volume}:/usr/local/ `# Bind local folder to volume` \
239 | --volume ${cache_volume}:/home/shared/.cache/ `# Bind cache to volume` \
240 | --env COMMIT_ID=${commit_id} `# Pass through the commit ID` \
241 | ${network} `# Network settings, if needed` \
242 | ${env_file} `# Pass any files of environment variables to the container` \
243 | ${env_vars} `# Pass explicit environment variables to the container` \
244 | ${http_proxy} `# Include HTTP proxy if needed` \
245 | ${tty} `# Attach a pseudo-terminal, if relevant` \
246 | ${docker_run_options} `# Extra options` \
247 | ${dev_image} $@ `# Run command in the image`
248 | }
249 |
250 | run_as_user () {
251 | run_as_user_options="${1}"; shift
252 |
253 | create_etc_volume
254 |
255 | docker_run "--user $(id -u):$(id -g) ${run_as_user_options}" $@
256 | }
257 |
258 | create_etc_volume() {
259 | # Create local user and group in the dev image
260 | uid=$(id -u)
261 | gid=$(id -g)
262 |
263 | if ! docker volume inspect -f " " ${etc_volume} 2> /dev/null; then
264 | etc_run="docker run --rm --volume ${etc_volume}:/etc ${dev_image}"
265 | if ! ${etc_run} grep -P "${gid}:$" /etc/group; then
266 | ${etc_run} groupadd -g ${gid} app-user
267 | fi
268 |
269 | if ! ${etc_run} grep -P "x:${uid}:" /etc/passwd; then
270 | ${etc_run} useradd -u ${uid} -g ${gid} app-user
271 | fi
272 | fi
273 | }
274 |
275 | update_dependencies() {
276 | # Make sure the etc volume has been created first
277 | create_etc_volume
278 |
279 | # Install yarn dependencies
280 | if [ -f package.json ]; then
281 | package_json_hash=$(${md5_command} package.json | cut -c1-8)
282 | if [ -d node_modules ]; then
283 | yarn_dependencies_hash=$(find node_modules -type f ! -wholename 'node_modules/.cache/*' -print0 | sort -z | xargs -0 ${md5_command} | ${md5_command} | cut -c1-8)-${package_json_hash}
284 | fi
285 | if [ -z "${yarn_dependencies_hash:-}" ] || [ ! -f .yarn.${project}.hash ] || [ "${yarn_dependencies_hash}" != "$(cat .yarn.${project}.hash)" ]; then
286 | echo "Installing new Yarn dependencies"
287 | run_as_user "" yarn install --force ${yarn_proxy}
288 | yarn_dependencies_hash=$(find node_modules -type f ! -wholename 'node_modules/.cache/*' -print0 | sort -z | xargs -0 ${md5_command} | ${md5_command} | cut -c1-8)-${package_json_hash}
289 | echo ${yarn_dependencies_hash} > .yarn.${project}.hash
290 | echo "Saved ${yarn_dependencies_hash} to .yarn.${project}.hash"
291 | else
292 | echo "Yarn dependencies haven't changed. To force an update, delete .yarn.${project}.hash."
293 | fi
294 | fi
295 |
296 | # Install bower dependencies
297 | if [ -f bower.json ]; then
298 | bower_json_hash=$(${md5_command} bower.json | cut -c1-8)
299 | if [ -d bower_components ]; then
300 | bower_dependencies_hash=$(find bower_components -type f -print0 | sort -z | xargs -0 ${md5_command} | ${md5_command} | cut -c1-8)-${bower_json_hash}
301 | fi
302 | if [ -z "${bower_dependencies_hash:-}" ] || [ ! -f .bower.${project}.hash ] || [ "${bower_dependencies_hash}" != "$(cat .bower.${project}.hash)" ]; then
303 | echo "Installing new bower dependencies"
304 | run_as_user "" bower install
305 | bower_dependencies_hash=$(find bower_components -type f -print0 | sort -z | xargs -0 ${md5_command} | ${md5_command} | cut -c1-8)-${bower_json_hash}
306 | echo ${bower_dependencies_hash} > .bower.${project}.hash
307 | else
308 | echo "Bower dependencies haven't changed. To force an update, delete .bower.${project}.hash."
309 | fi
310 | fi
311 |
312 | # Install ruby dependencies
313 | if [ -f Gemfile ]; then
314 | gemfile_hash=$(${md5_command} Gemfile | cut -c1-8)
315 | if [ -d vendor/bundle ]; then
316 | bundler_dependencies_hash=$(find vendor/bundle -type f -print0 | sort -z | xargs -0 ${md5_command} | ${md5_command} | cut -c1-8)-${gemfile_hash}
317 | fi
318 | if [ -z "${bundler_dependencies_hash:-}" ] || [ ! -f .bundler.${project}.hash ] || [ "${bundler_dependencies_hash}" != "$(cat .bundler.${project}.hash)" ]; then
319 | echo "Installing new bundler dependencies"
320 | run_as_user "" bundle install --path vendor/bundle
321 | bundler_dependencies_hash=$(find vendor/bundle -type f -print0 | sort -z | xargs -0 ${md5_command} | ${md5_command} | cut -c1-8)-${gemfile_hash}
322 | echo ${bundler_dependencies_hash} > .bundler.${project}.hash
323 | else
324 | echo "Bundler dependencies haven't changed. To force an update, delete .bundler.${project}.hash."
325 | fi
326 | fi
327 |
328 | # Install pip dependecies
329 | if [ -f requirements.txt ]; then
330 | requirements_hash=$(${md5_command} requirements.txt | cut -c1-8)
331 | pip_dependencies_hash=$(docker run --volume ${etc_volume}:/etc ${dev_image} bash -c 'find $(find /usr/local/lib/ -maxdepth 1 -name "python*" -type d | sort | tail -n 1)/dist-packages -type f -print0 | sort -z | xargs -0 '${md5_command}' | '${md5_command}' | cut -c1-8')-${requirements_hash}
332 | if [ ! -f .pip.${project}.hash ] || [ "${pip_dependencies_hash}" != "$(cat .pip.${project}.hash)" ]; then
333 | echo "Installing new pip dependencies"
334 | docker_run "" pip3 install --requirement requirements.txt
335 | pip_dependencies_hash=$(docker run --volume ${etc_volume}:/etc ${dev_image} bash -c 'find $(find /usr/local/lib/ -maxdepth 1 -name "python*" -type d | sort | tail -n 1)/dist-packages -type f -print0 | sort -z | xargs -0 '${md5_command}' | '${md5_command}' | cut -c1-8')-${requirements_hash}
336 | echo ${pip_dependencies_hash} > .pip.${project}.hash
337 | else
338 | echo "Pip dependencies haven't changed. To force an update, delete .pip.${project}.hash."
339 | fi
340 | fi
341 | }
342 |
343 | # Find current run command
344 | run_command=${1:-}
345 | if [[ -n "${run_command}" ]]; then shift; fi
346 |
347 | # Do the real business
348 | case $run_command in
349 | ""|"serve")
350 | update_dependencies
351 |
352 | # Read optional arguments
353 | detach=""
354 | forward_ports=("")
355 | run_watcher=false
356 | while [[ -n "${1:-}" ]] && [[ "${1:0:1}" == "-" ]]; do
357 | key="$1"
358 |
359 | case $key in
360 | -d|--detach) detach="--detach" ;;
361 | -p|--port)
362 | if [ -z "${2:-}" ]; then invalid "Missing port number. Usage: --port XXXX"; fi
363 | PORT=${2}
364 | shift
365 | ;;
366 | -f|--forward-port)
367 | if [ -z "${2:-}" ]; then invalid "Missing port number. Usage: --port XXXX"; fi
368 | forward_ports+=("${2}")
369 | shift
370 | ;;
371 | *) invalid "Option '${key}' not recognised." ;;
372 | esac
373 | shift
374 | done
375 |
376 | # Setup yarn dependencies
377 | if [ -f package.json ]; then
378 | run_as_user "${module_volumes}" yarn run build
379 | fi
380 |
381 | # Run watch command in the background
382 | if ${run_watcher}; then
383 | if [ -z "${detach}" ]; then trap "kill_container ${project}-watch" EXIT; fi
384 | run_as_user "--detach" yarn run watch # Run watch in the background
385 | fi
386 |
387 | publish_extra_ports=""
388 | if [ -n "${EXTRA_PORTS:-}" ]; then
389 | IFS=', ' read -r -a ports_array <<< "$EXTRA_PORTS"
390 | for extra_port in "${ports_array[@]}"; do
391 | publish_extra_ports="${publish_extra_ports} --publish $extra_port:$extra_port"
392 | done
393 | fi
394 |
395 | publish_forward_ports=""
396 | for forward_port in "${forward_ports[@]}"; do
397 | if [ -n "${forward_port}" ]; then
398 | publish_forward_ports="${publish_forward_ports} --publish ${forward_port}:${PORT}"
399 | fi
400 | done
401 |
402 | start_django_db
403 |
404 | # Run the serve container, publishing the port, and detaching if required
405 | run_as_user "--env PORT=${PORT} --publish ${PORT}:${PORT} ${publish_forward_ports} ${publish_extra_ports} ${detach} ${run_serve_docker_opts} ${module_volumes}" yarn run serve $*
406 | ;;
407 | "stop")
408 | echo "Stopping all running containers for ${project}"
409 | running_containers="$(docker ps --quiet --filter name=${project})"
410 | if [ -z "${running_containers}" ]; then
411 | echo "No running containers found"
412 | exit 0
413 | fi
414 | docker kill ${running_containers}
415 | ;;
416 | "watch")
417 | update_dependencies
418 |
419 | # Read optional arguments
420 | watch_site=false
421 | while [[ -n "${1:-}" ]] && [[ "${1:0:1}" == "-" ]]; do
422 | key="$1"
423 |
424 | case $key in
425 | -s|--watch-site)
426 | # Error if not a jekyll site
427 | if [ ! -f _config.yml ]; then
428 | echo "Error: Not a Jekyll site";
429 | exit 1;
430 | fi
431 | watch_site=true
432 | ;;
433 | *) invalid "Option '${key}' not recognised." ;;
434 | esac
435 | shift
436 | done
437 | if ${watch_site}; then
438 | trap "kill_container ${project}-watch-site" EXIT
439 | run_as_user "--detach" jekyll build --watch # Run site watcher in the background
440 | fi
441 | run_as_user "${module_volumes}" yarn run build
442 | run_as_user "${module_volumes}" yarn run watch
443 | ;;
444 | "build")
445 | update_dependencies
446 |
447 | run_as_user "${module_volumes}" yarn run build
448 |
449 | if [ -f _config.yml ]; then
450 | # For jekyll sites
451 | run_as_user "" bundle exec jekyll build
452 | fi
453 | ;;
454 | "test")
455 | update_dependencies
456 |
457 | test_error=false
458 |
459 | # Run node tests
460 | echo "- Running yarn tests"
461 | run_as_user "" yarn run test || test_error=true
462 |
463 | # Report success or failure
464 | if ${test_error}; then
465 | echo "==="
466 | echo "Tests failed"
467 | echo "==="
468 | exit 1
469 | else
470 | echo "==="
471 | echo "Tests succeeded"
472 | echo "==="
473 | fi
474 | ;;
475 | "test-python")
476 | update_dependencies
477 |
478 | test_error=false
479 |
480 | # Run node tests
481 | echo "- Running python tests"
482 | run_as_user "" yarn run test-python || test_error=true
483 |
484 | # Report success or failure
485 | if ${test_error}; then
486 | echo "==="
487 | echo "Tests failed"
488 | echo "==="
489 | exit 1
490 | else
491 | echo "==="
492 | echo "Tests succeeded"
493 | echo "==="
494 | fi
495 | ;;
496 | "lint-python")
497 | update_dependencies
498 |
499 | lint_error=false
500 |
501 | # Run node tests
502 | echo "- Running python lint"
503 | run_as_user "" yarn run lint-python || lint_error=true
504 |
505 | # Report success or failure
506 | if ${lint_error}; then
507 | echo "==="
508 | echo "Lint failed"
509 | echo "==="
510 | exit 1
511 | else
512 | echo "==="
513 | echo "Lint succeeded"
514 | echo "==="
515 | fi
516 | ;;
517 | "clean")
518 | echo "Remove hash files"
519 | rm -rf .*.hash
520 |
521 | echo "Running 'clean' yarn script"
522 | run_as_user "" yarn run clean || true # Run the clean script
523 |
524 | echo "Removing docker objects for project: ${project}"
525 |
526 | echo "- Removing containers using project volumes"
527 | project_volumes="$(docker volume ls --quiet --filter name=${project})"
528 | for volume in ${project_volumes}; do
529 | echo " > Removing containers using volume ${volume}"
530 | containers_using_volume="$(docker ps --all --quiet --filter volume=${volume})"
531 | if [ -n "${containers_using_volume}" ]; then docker rm --force ${containers_using_volume}; fi
532 | done
533 | echo "- Removing project volumes"
534 | if [ -n "${project_volumes}" ]; then docker volume rm ${project_volumes}; fi
535 |
536 | echo "- Removing remaining project containers"
537 | project_containers="$(docker ps --all --quiet --filter name=${project})"
538 | if [ -n "${project_containers}" ]; then docker rm --force ${project_containers}; fi
539 |
540 | echo "- Removing project networks"
541 | project_networks="$(docker network ls --quiet --filter name=${project})"
542 | if [ -n "${project_networks}" ]; then docker network rm ${project_networks}; fi
543 |
544 | echo "Removing .docker-project file"
545 | rm -rf .docker-project # Remove the project file
546 | ;;
547 | "clean-cache")
548 | # Clean node cache volume
549 | echo "Removing cache volume ${cache_volume}"
550 | containers_using_volume=$(docker ps --quiet --all --filter "volume=${cache_volume}")
551 | if [ -n "${containers_using_volume}" ]; then docker rm --force ${containers_using_volume}; fi
552 | docker volume rm ${cache_volume}
553 | ;;
554 | "exec")
555 | expose_ports=""
556 | run_as_root=false
557 |
558 | while [[ -n "${1:-}" ]] && [[ "${1:0:1}" == "-" ]]; do
559 | key="$1"
560 |
561 | case $key in
562 | -r|--root)
563 | run_as_root=true
564 | ;;
565 | -p|--expose-port)
566 | if [ -z "${2:-}" ]; then invalid "Missing port number. Usage: --expose-port XXXX"; fi
567 | expose_ports="${expose_ports} --publish ${2}:${2}"
568 | shift
569 | ;;
570 | *) invalid "Option '${key}' not recognised." ;;
571 | esac
572 | shift
573 | done
574 |
575 | update_dependencies
576 | start_django_db
577 |
578 | if ${run_as_root}; then
579 | docker_run "${expose_ports}" $@
580 | else
581 | run_as_user "${expose_ports}" $@
582 | fi
583 | ;;
584 | "yarn")
585 | expose_ports=""
586 | run_as_root=false
587 |
588 | while [[ -n "${1:-}" ]] && [[ "${1:0:1}" == "-" ]]; do
589 | key="$1"
590 |
591 | case $key in
592 | -r|--root)
593 | run_as_root=true
594 | ;;
595 | -p|--expose-port)
596 | if [ -z "${2:-}" ]; then invalid "Missing port number. Usage: --expose-port XXXX"; fi
597 | expose_ports="${expose_ports} --publish ${2}:${2}"
598 | shift
599 | ;;
600 | *) invalid "Option '${key}' not recognised." ;;
601 | esac
602 | shift
603 | done
604 |
605 | update_dependencies
606 | start_django_db
607 |
608 | if ${run_as_root}; then
609 | docker_run "${expose_ports}" yarn run $@
610 | else
611 | run_as_user "${expose_ports}" yarn run $@
612 | fi
613 | ;;
614 | *) invalid "Command '${run_command}' not recognised." ;;
615 | esac
616 |
--------------------------------------------------------------------------------
/templates/index.html:
--------------------------------------------------------------------------------
1 | {% extends '_layout.html' %}
2 |
3 | {% block title %}Anbox Cloud - Scalable Android in the cloud{% endblock %}
4 |
5 | {% block description %}Anbox Cloud is the mobile cloud computing platform delivered by Canonical. Run Android in the cloud, at high scale and on any type of hardware. Canonical partners with cloud providers and computing hardware manufacturers to accelerate your time to market and provide long term commercial support.{% endblock %}
6 |
7 | {% block copydoc %}https://docs.google.com/document/d/1m3hL6Y8VqFqeZLy-sewPAyCZz-uGr7zfqzNwtGumyho/edit{% endblock %}
8 |
9 | {% block content %}
10 |
11 |
12 |
13 |
Scalable Android in the cloud
14 |
Anbox Cloud lets you stream mobile apps securely, at any scale, to any device letting you focus on your apps. Run Android in system containers, not emulators, on AWS, OCI, Azure, GCP or your private cloud with ultra low streaming latency.
NVIDIA T4 GPUs are now featured in second-generation Arm servers at cloud service providers, delivering significantly improved app-streams-per-server and lower cost per-user. Canonical's Anbox platform provides a complete solution to containerize mobile apps and works seamlessly with NVIDIA's Linux and Android software stacks. Together, Canonical and NVIDIA provide a scalable solution to virtualize mobile apps, and stream them securely to the growing population of 5G mobile devices.
337 | Phil Eisler, VP Cloud Streaming at NVIDIA
338 |
It's no secret that TCO is a key driver of cloud provider decisions. And that's what gets Arm excited about the Android in the Cloud solution Ampere, Canonical and NETINT have developed. The Ampere Altra CPU packs 80 high-performance Neoverse N1 cores into a very power-efficient design that should deliver incredible TCO for Android in the Cloud use cases like cloud gaming, Android app development and IoT enablement to cloud providers.
352 | Robbie Williamson, Arm Senior Director of Solutions Engineering
353 |
The combination of Ampere's Arm-based servers with a provisioned virtualisation solution like Canonical's Anbox Cloud delivers the flexible, high-performance and secure infrastructure that developers need in order to deliver a better user experience for consumers.
370 | Jeff Wittich, SVP of Products at Ampere
371 |
As small, low-powered devices inundate our world, offloading applications to nearby cloud servers opens up a huge number of opportunities for efficiency, as well as new experiences. We're excited to support the Anbox Cloud team as they grow alongside the worldwide rollout of 5G.
386 | Jacob Smith, Co-founder and CMO Packet (now Equinix Metal)
387 |
Canonical's inclusion of the Intel Visual Cloud Accelerator Card - Render as part of their newly launched Anbox Cloud solution will enable the delivery of enhanced cloud and mobile gaming experiences on Android devices, supporting an emerging industry opportunity today, and for the upcoming 5G era.
404 | Lynn Comp, Vice President, Data Platforms Group and General manager of the Visual Cloud Division, Intel
405 |
636 |
637 |
642 |
643 |
644 |
647 |
648 | {% endblock %}
649 |
--------------------------------------------------------------------------------
/static/js/anbox-stream-sdk.js:
--------------------------------------------------------------------------------
1 | // Anbox Stream SDK
2 | // Copyright 2019 Canonical Ltd. All rights reserved.
3 |
4 | class AnboxStream {
5 | /**
6 | * AnboxStream creates a connection between your client and an Android instance and
7 | * displays its video & audio feed in an HTML5 player
8 | *
9 | * @param options: {object} {
10 | * targetElement: ID of the DOM element to attach the video to. (required)
11 | * url: Address of the service. (required)
12 | * authToken: Authentication token acquired through /1.0/login (required)
13 | * stunServers: List ICE servers (default: [{"urls": ['stun:stun.l.google.com:19302'], username: "", password: ""}])
14 | * session: {
15 | * app: Android application ID or name. (required)
16 | * },
17 | * screen: {
18 | * width: screen width (default: 1280)
19 | * height: screen height (default: 720)
20 | * fps: screen frame rate (default: 60)
21 | * density: screen density (default: 240)
22 | * },
23 | * controls: {
24 | * keyboard: true or false, send keypress events to the Android instance. (default: true)
25 | * mouse: true or false, send mouse and touch events to the Android instance. (default: true)
26 | * gamepad: true or false, send gamepad events to the Android instance. (default: true)
27 | * },
28 | * callbacks: {
29 | * ready: function, called when the video and audio stream are ready to be inserted. (default: none)
30 | * error: function, called on stream error with the message as parameter. (default: none)
31 | * done: function, called when the stream is closed. (default: none)
32 | * }
33 | * }
34 | */
35 | constructor(options) {
36 | if (this._nullOrUndef(options))
37 | throw new Error('invalid options');
38 |
39 | this._fillDefaults(options);
40 | this._validateOptions(options);
41 | this._options = options;
42 |
43 | this._id = Math.random().toString(36).substr(2, 9);
44 | this._containerID = options.targetElement;
45 | this._videoID = 'anbox-stream-video-' + this._id;
46 | this._audioID = 'anbox-stream-audio-' + this._id;
47 |
48 | // WebRTC
49 | this._ws = null; // WebSocket
50 | this._pc = null; // PeerConnection
51 | this._controlChan = null; // Channel to send inputs
52 | this._timedout = false;
53 | this._timer = -1;
54 | this._ready = false;
55 |
56 | // Media streams
57 | this._videoStream = null;
58 | this._audioStream = null;
59 |
60 | // Control options
61 | this._modifierState = 0;
62 | this._dimensions = null;
63 | this._gamepadManager = null;
64 | };
65 |
66 | /**
67 | * Connect a new instance for the configured application or attach to an existing one
68 | */
69 | connect() {
70 | // We first have to check if an instance for the application already
71 | // exists. If we already have one we attach to the existing instance.
72 | // Otherwise we create a new instance for the application.
73 | fetch(this._options.url + '/1.0/instances/', {
74 | method: 'GET',
75 | headers: {
76 | 'Accept': 'application/json, text/plain, */*',
77 | 'Authorization': 'Macaroon root=' + this._options.authToken,
78 | 'Content-Type': 'application/json',
79 | },
80 | })
81 | .then(response => {
82 | if (response.status !== 200)
83 | throw new Error("Failed to retrieve list of instances");
84 |
85 | return response.json();
86 | })
87 | .then(jsonResp => {
88 | if (jsonResp.status !== "success")
89 | throw new Error(jsonResp.error);
90 |
91 | var instanceID = "";
92 | for (var n = 0; n < jsonResp.metadata.length; n++) {
93 | var instance = jsonResp.metadata[n];
94 | if (instance.application === this._options.session.app) {
95 | instanceID = instance.id;
96 | break;
97 | }
98 | }
99 |
100 | if (instanceID.length === 0) {
101 | this._createNewInstance();
102 | return;
103 | }
104 |
105 | this._attachToInstance(instanceID);
106 | })
107 | .catch(error => {
108 | this._options.callbacks.error(error);
109 | });
110 | };
111 |
112 | _attachToInstance(instanceID) {
113 | const details = {
114 | screen: {
115 | width: this._options.screen.width,
116 | height: this._options.screen.height,
117 | fps: this._options.screen.fps,
118 | density: this._options.screen.density,
119 | }
120 | }
121 | fetch(this._options.url + '/1.0/instances/' + instanceID + '/join', {
122 | method: 'POST',
123 | headers: {
124 | 'Accept': 'application/json, text/plain, */*',
125 | 'Authorization': 'Macaroon root=' + this._options.authToken,
126 | 'Content-Type': 'application/json',
127 | },
128 | body: JSON.stringify(details),
129 | })
130 | .then(response => {
131 | if (response.status !== 200)
132 | throw new Error("Failed to join instance");
133 |
134 | return response.json();
135 | })
136 | .then(jsonResp => {
137 | if (jsonResp.status !== "success")
138 | throw new Error(jsonResp.error)
139 |
140 | // If we received any additional STUN/TURN servers from the gateway use them
141 | // If we received any additional STUN/TURN servers from the gateway use them
142 | if (!this._nullOrUndef(jsonResp.metadata.stun_servers) && jsonResp.metadata.stun_servers.length > 0) {
143 | for (var n = 0; n < jsonResp.metadata.stun_servers.length; n++) {
144 | this._options.stunServers.push({
145 | "urls": jsonResp.metadata.stun_servers[n].urls,
146 | "username": jsonResp.metadata.stun_servers[n].username,
147 | "credential": jsonResp.metadata.stun_servers[n].password
148 | });
149 | }
150 | }
151 |
152 | this._connectSignaler(jsonResp.metadata.websocket_url);
153 | })
154 | .catch(error => {
155 | this._options.callbacks.error(error);
156 | })
157 | }
158 |
159 | _createNewInstance() {
160 | const details = {
161 | name: this._options.session.app,
162 | application: this._options.session.app,
163 | }
164 |
165 | fetch(this._options.url + '/1.0/instances/', {
166 | method: 'POST',
167 | headers: {
168 | 'Accept': 'application/json, text/plain, */*',
169 | 'Authorization': 'Macaroon root=' + this._options.authToken,
170 | 'Content-Type': 'application/json',
171 | },
172 | body: JSON.stringify(details),
173 | })
174 | .then(response => {
175 | if (response.status !== 200)
176 | throw new Error("Failed to create new instance");
177 |
178 | return response.json();
179 | })
180 | .then(jsonResp => {
181 | if (jsonResp.status !== "success")
182 | throw new Error(jsonResp.error);
183 |
184 | this._attachToInstance(jsonResp.metadata.id);
185 | })
186 | .catch(error => {
187 | this._options.callbacks.error(error);
188 | });
189 | }
190 |
191 | _connectSignaler(url) {
192 | let ws = new WebSocket(url);
193 | ws.onopen = this._onWsOpen.bind(this);
194 | ws.onclose = this._onWsClose.bind(this);
195 | ws.onerror = this._onWsError.bind(this);
196 | ws.onmessage = this._onWsMessage.bind(this);
197 |
198 | this._ws = ws;
199 | this._timer = window.setTimeout(this._onTimeout.bind(this), 2 * 60 * 1000);
200 | }
201 |
202 | /**
203 | * Disconnect an existing stream and remove the video & audio elements.
204 | *
205 | * This will stop the underlying Android instance.
206 | */
207 | disconnect() {
208 | this._stopStreaming();
209 | };
210 |
211 | /**
212 | * Toggle fullscreen for the streamed video.
213 | *
214 | * IMPORTANT: fullscreen can only be toggled following a user input.
215 | * If you call this method when your page loads, it will not work.
216 | */
217 | requestFullscreen() {
218 | if (!document.fullscreenEnabled) {
219 | console.error("fullscreen not supported");
220 | } else {
221 | const video = document.getElementById(this._videoID);
222 | if (video.requestFullscreen) {
223 | video.requestFullscreen();
224 | } else if (video.mozRequestFullScreen) { /* Firefox */
225 | video.mozRequestFullScreen();
226 | } else if (video.webkitRequestFullscreen) { /* Chrome, Safari and Opera */
227 | video.webkitRequestFullscreen();
228 | } else if (video.msRequestFullscreen) { /* IE/Edge */
229 | video.msRequestFullscreen();
230 | }
231 | }
232 | };
233 |
234 | /**
235 | * Exit fullscreen mode.
236 | */
237 | exitFullscreen() {
238 | document.exitFullscreen();
239 | };
240 |
241 | /**
242 | * Return the stream ID you can use to access video and audio elements with getElementById
243 | */
244 | getId() {
245 | return this._id;
246 | }
247 |
248 | _fillDefaults(options) {
249 | if (this._nullOrUndef(options.screen))
250 | options.screen = {};
251 |
252 | if (this._nullOrUndef(options.screen.width))
253 | options.screen.width = 1280;
254 |
255 | if (this._nullOrUndef(options.screen.height))
256 | options.screen.height = 720;
257 |
258 | if (this._nullOrUndef(options.screen.fps))
259 | options.screen.fps = 60;
260 |
261 | if (this._nullOrUndef(options.screen.density))
262 | options.screen.density = 240;
263 |
264 | if (this._nullOrUndef(options.controls))
265 | options.controls = {};
266 |
267 | if (this._nullOrUndef(options.controls.key))
268 | options.controls.keyboard = true;
269 |
270 | if (this._nullOrUndef(options.controls.mouse))
271 | options.controls.mouse = true;
272 |
273 | if (this._nullOrUndef(options.controls.gamepad))
274 | options.controls.gamepad = true;
275 |
276 | if (this._nullOrUndef(options.stunServers))
277 | options.stunServers = [{ urls: ['stun:stun.l.google.com:19302'], username: "", password: ""}];
278 |
279 | if (this._nullOrUndef(options.callbacks))
280 | options.callbacks = {};
281 |
282 | if (this._nullOrUndef(options.callbacks.ready))
283 | options.callbacks.ready = () => {};
284 |
285 | if (this._nullOrUndef(options.callbacks.error))
286 | options.callbacks.error = () => {};
287 |
288 | if (this._nullOrUndef(options.callbacks.done))
289 | options.callbacks.done = () => {};
290 | };
291 |
292 | _validateOptions(options) {
293 | // Required
294 | if (this._nullOrUndef(options.targetElement))
295 | throw new Error('missing targetElement parameter');
296 | if (document.getElementById(options.targetElement) === null) {
297 | throw new Error(`target element "${options.targetElement}" does not exist`)
298 | }
299 |
300 | if (this._nullOrUndef(options.authToken))
301 | throw new Error('missing authToken parameter');
302 |
303 | if (this._nullOrUndef(options.session))
304 | throw new Error('missing session parameter');
305 |
306 | if (this._nullOrUndef(options.session.app))
307 | throw new Error('missing session.app parameter');
308 |
309 | if (this._nullOrUndef(options.url))
310 | throw new Error('missing url parameter');
311 |
312 | if (!options.url.includes('https') && !options.url.includes('http'))
313 | throw new Error('unsupported scheme');
314 | }
315 |
316 | _insertMedia(videoSource, audioSource) {
317 | this._ready = true;
318 | let mediaContainer = document.getElementById(this._containerID);
319 |
320 | const video = document.createElement('video');
321 | video.srcObject = videoSource;
322 | video.muted = true;
323 | video.autoplay = true;
324 | video.controls = false;
325 | video.id = this._videoID;
326 |
327 | const audio = document.createElement('audio');
328 | audio.id = this._audioID;
329 | audio.srcObject = audioSource;
330 | audio.autoplay = true;
331 | audio.controls = false;
332 |
333 | mediaContainer.appendChild(video);
334 | mediaContainer.appendChild(audio);
335 |
336 | this._registerControls()
337 | };
338 |
339 | _removeMedia() {
340 | const video = document.getElementById(this._videoID);
341 | const audio = document.getElementById(this._audioID);
342 |
343 | if (video)
344 | video.remove();
345 | if (audio)
346 | audio.remove();
347 | };
348 |
349 | _stopStreaming() {
350 | if (this._pc !== null) {
351 | this._pc.close();
352 | this._pc = null;
353 | }
354 | if (this._ws !== null) {
355 | this._ws.close();
356 | this._ws = null;
357 | }
358 | this._removeMedia();
359 | this._unregisterControls();
360 |
361 | if (this._gamepadManager) {
362 | this._gamepadManager.stopPolling()
363 | }
364 | this._options.callbacks.done()
365 | };
366 |
367 | _onTimeout() {
368 | if (this._pc == null || this._pc.iceConnectionState === 'connected')
369 | return;
370 |
371 | this._timedout = true;
372 | this._stopStreaming();
373 | };
374 |
375 | _onRtcOfferCreated(description) {
376 | this._pc.setLocalDescription(description);
377 | let msg = {type: 'offer', sdp: btoa(description.sdp)};
378 | if (this._ws.readyState === 1)
379 | this._ws.send(JSON.stringify(msg))
380 | };
381 |
382 | _onRtcTrack(event) {
383 | const kind = event.track.kind;
384 | if (kind === 'video') {
385 | this._videoStream = event.streams[0];
386 | this._videoStream.onremovetrack = this._stopStreaming;
387 | } else if (kind === 'audio') {
388 | this._audioStream = event.streams[0];
389 | this._audioStream.onremovetrack = this._stopStreaming;
390 | }
391 |
392 | // Start streaming until audio and video tracks both are available
393 | if (this._videoStream && this._audioStream) {
394 | this._insertMedia(this._videoStream, this._audioStream)
395 | this._options.callbacks.ready();
396 | }
397 | };
398 |
399 | _onRtcIceConnectionStateChange() {
400 | if (this._pc === null)
401 | return;
402 |
403 | if (this._pc.iceConnectionState === 'failed') {
404 | this._stopStreaming();
405 | this._options.callbacks.error(new Error('Failed to establish a connection via ICE'));
406 | } else if (this._pc.iceConnectionState === 'disconnected' ||
407 | this._pc.iceConnectionState === 'closed') {
408 | if (this._timedout) {
409 | this._options.callbacks.error(new Error('Connection timed out'));
410 | return;
411 | }
412 | this._options.callbacks.error(new Error('Connection lost'));
413 | this._stopStreaming();
414 | } else if (this._pc.iceConnectionState === 'connected') {
415 | window.clearTimeout(this._timer);
416 | this._ws.close();
417 | }
418 | };
419 |
420 | _onRtcIceCandidate(event) {
421 | if (event.candidate !== null && event.candidate.candidate !== "") {
422 | const msg = {
423 | type: 'candidate',
424 | candidate: btoa(event.candidate.candidate),
425 | sdpMid: event.candidate.sdpMid,
426 | sdpMLineIndex: event.candidate.sdpMLineIndex,
427 | };
428 | if (this._ws.readyState === 1)
429 | this._ws.send(JSON.stringify(msg));
430 | }
431 | };
432 |
433 | _registerControls() {
434 | const v = document.getElementById(this._videoID);
435 |
436 | if (this._options.controls.mouse) {
437 | if (window.matchMedia('(pointer:fine)')) {
438 | v.addEventListener('mousemove', this._onMouseMove.bind(this));
439 | v.addEventListener('mousedown', this._onMouseButton.bind(this));
440 | v.addEventListener('mouseup', this._onMouseButton.bind(this));
441 | v.addEventListener('touchstart', this._onTouchStart.bind(this));
442 | v.addEventListener('touchend', this._onTouchEnd.bind(this));
443 | v.addEventListener('touchcancel', this._onTouchCancel.bind(this));
444 | v.addEventListener('touchmove', this._onTouchMove.bind(this));
445 | v.addEventListener('resize', this._refreshWindowMath.bind(this));
446 | } else
447 | console.warn("Device does not have mouse support")
448 | }
449 |
450 | if (this._options.controls.keyboard) {
451 | window.addEventListener('keydown', this._onKey.bind(this));
452 | window.addEventListener('keyup', this._onKey.bind(this));
453 | window.addEventListener('gamepadconnected', this._queryGamePadEvents.bind(this));
454 | }
455 |
456 | if (this._options.controls.keyboard || this._options.controls.mouse) {
457 | // Call it once for the initial values and refresh it every time the window
458 | // or video element is resized
459 | this._refreshWindowMath();
460 | window.addEventListener('resize', this._refreshWindowMath.bind(this));
461 | }
462 | };
463 |
464 | _unregisterControls() {
465 | const v = document.getElementById(this._videoID);
466 |
467 | // Removing the video container should automatically remove all event listeners
468 | // but this is dependant on the garbage collector, so we manually do it if we can
469 | if (v) {
470 | v.removeEventListener('mousemove', this._onMouseMove);
471 | v.removeEventListener('mousedown', this._onMouseButton);
472 | v.removeEventListener('mouseup', this._onMouseButton);
473 | v.removeEventListener('touchstart', this._onTouchStart);
474 | v.removeEventListener('touchend', this._onTouchEnd);
475 | v.removeEventListener('touchcancel', this._onTouchCancel);
476 | v.removeEventListener('touchmove', this._onTouchMove);
477 | v.removeEventListener('resize', this._refreshWindowMath);
478 | }
479 |
480 | window.removeEventListener('resize', this._refreshWindowMath.bind(this));
481 | window.removeEventListener('keydown', this._onKey.bind(this));
482 | window.removeEventListener('keyup', this._onKey.bind(this));
483 | window.removeEventListener('gamepadconnected', this._queryGamePadEvents.bind(this));
484 | };
485 |
486 | _clientToServerX(clientX, d) {
487 | let serverX = Math.round((clientX - d.containerOffsetX) * d.scalingFactorX);
488 | if (serverX === d.frameW - 1) serverX = d.frameW;
489 | if (serverX > d.frameW) serverX = d.frameW;
490 | if (serverX < 0) serverX = 0;
491 | return serverX;
492 | };
493 |
494 | _clientToServerY(clientY, m) {
495 | let serverY = Math.round((clientY - m.containerOffsetY) * m.scalingFactorY);
496 | if (serverY === m.frameH - 1) serverY = m.frameH;
497 | if (serverY > m.frameH) serverY = m.frameH;
498 | if (serverY < 0) serverY = 0;
499 | return serverY;
500 | };
501 |
502 | _triggerModifierEvent(event, key) {
503 | if (event.getModifierState(key)) {
504 | if (!(this._modifierState & _modifierEnum[key])) {
505 | this._modifierState = this._modifierState | _modifierEnum[key];
506 | this._sendEvent('key', {code: _keyScancodes[key], pressed: true});
507 | }
508 | } else {
509 | if ((this._modifierState & _modifierEnum[key])) {
510 | this._modifierState = this._modifierState & ~_modifierEnum[key];
511 | this._sendEvent('key', {code: _keyScancodes[key], pressed: false});
512 | }
513 | }
514 | };
515 |
516 | _sendEvent(type, data) {
517 | if (this._pc === null || this._controlChan.readyState !== 'open')
518 | return;
519 | this._controlChan.send(JSON.stringify({type: 'input::' + type, data: data}));
520 | };
521 |
522 | _refreshWindowMath() {
523 | let video = document.getElementById(this._videoID);
524 |
525 | // timing issues can occur when removing the component
526 | if (!video) {
527 | return
528 | }
529 |
530 | const windowW = video.offsetWidth;
531 | const windowH = video.offsetHeight;
532 | const frameW = video.videoWidth;
533 | const frameH = video.videoHeight;
534 |
535 | const multi = Math.min(windowW / frameW, windowH / frameH);
536 | const vpWidth = frameW * multi;
537 | const vpHeight = frameH * multi;
538 |
539 | this._dimensions = {
540 | scalingFactorX: frameW / vpWidth,
541 | scalingFactorY: frameH / vpHeight,
542 | containerOffsetX: Math.max((windowW - vpWidth) / 2.0, 0),
543 | containerOffsetY: Math.max((windowH - vpHeight) / 2.0, 0),
544 | frameW,
545 | frameH,
546 | };
547 | };
548 |
549 | _onMouseMove(event) {
550 | const x = this._clientToServerX(event.offsetX, this._dimensions);
551 | const y = this._clientToServerY(event.offsetY, this._dimensions);
552 | this._sendEvent('mouse-move', {x: x, y: y, rx: event.movementX, ry: event.movementY})
553 | };
554 |
555 | _onMouseButton(event) {
556 | const down = event.type === 'mousedown';
557 | let button;
558 |
559 | if (down && event.button === 0 && event.ctrlKey && event.shiftKey)
560 | return;
561 |
562 | switch (event.button) {
563 | case 0: button = 1; break;
564 | case 1: button = 2; break;
565 | case 2: button = 3; break;
566 | case 3: button = 4; break;
567 | case 4: button = 5; break;
568 | default: break;
569 | }
570 |
571 | this._sendEvent('mouse-button', {button: button, pressed: down})
572 | };
573 |
574 | _onKey(event) {
575 | // Disable any problematic browser shortcuts
576 | if (event.code === 'F5' || // Reload
577 | (event.code === 'KeyR' && event.ctrlKey) || // Reload
578 | (event.code === 'F5' && event.ctrlKey) || // Hard reload
579 | (event.code === 'KeyI' && event.ctrlKey && event.shiftKey) ||
580 | (event.code === 'F11') || // Fullscreen
581 | (event.code === 'F12') // Developer tools
582 | ) return;
583 |
584 | event.preventDefault();
585 |
586 | const code = _keyScancodes[event.code];
587 | const pressed = (event.type === 'keydown');
588 | if (code) {
589 | // NOTE: no need to check the following modifier keys
590 | // 'ScrollLock', 'NumLock', 'CapsLock'
591 | // as they're mapped to event.code correctly
592 | const modifierKeys = ['Control', 'Shift', 'Alt', 'Meta', 'AltGraph'];
593 | for (let i = 0; i < modifierKeys.length; i++) {
594 | this._triggerModifierEvent(event, modifierKeys[i]);
595 | }
596 |
597 | this._sendEvent('key', {code: code, pressed: pressed});
598 | }
599 | };
600 |
601 | _touchEvent(event, eventType) {
602 | event.preventDefault();
603 | for (let n = 0; n < event.changedTouches.length; n++) {
604 | let touch = event.changedTouches[n];
605 | let x = this._clientToServerX(touch.clientX, this._dimensions);
606 | let y = this._clientToServerY(touch.clientY, this._dimensions);
607 | this._sendEvent(eventType, {id: n, x: x, y: y});
608 | }
609 | };
610 |
611 | _onTouchStart(event) {this._touchEvent(event, 'touch-start')};
612 | _onTouchEnd(event) {this._touchEvent(event, 'touch-end')};
613 | _onTouchCancel(event) {this._touchEvent(event, 'touch-cancel')};
614 | _onTouchMove(event) {this._touchEvent(event, 'touch-move')};
615 |
616 | _queryGamePadEvents() {
617 | if (!this._options.controls.gamepad)
618 | return;
619 | let gamepads = navigator.getGamepads();
620 | if (gamepads.length > 0) {
621 | this._gamepadManager = new _gamepadEventManager(this._sendEvent.bind(this));
622 | this._gamepadManager.startPolling()
623 | }
624 | };
625 |
626 | _nullOrUndef(obj) { return obj === null || obj === undefined };
627 |
628 | _onWsOpen() {
629 | const config = { iceServers: this._options.stunServers };
630 | this._pc = new RTCPeerConnection(config);
631 | this._pc.ontrack = this._onRtcTrack.bind(this);
632 | this._pc.oniceconnectionstatechange = this._onRtcIceConnectionStateChange.bind(this);
633 | this._pc.onicecandidate = this._onRtcIceCandidate.bind(this);
634 |
635 | this._controlChan = this._pc.createDataChannel('control');
636 | let options = {offerToReceiveVideo: true, offerToReceiveAudio: true};
637 | this._pc.createOffer(options).then(this._onRtcOfferCreated.bind(this)).catch(function(err) {
638 | console.error(err)
639 | });
640 | };
641 |
642 | _onWsClose() {
643 | if (!this._ready) {
644 | this._options.callbacks.error(new Error('Connection was interrupted while connecting'));
645 | }
646 | };
647 |
648 | _onWsError(event) {
649 | if (event.type === 'error') {
650 | this._stopStreaming();
651 | }
652 | this._options.callbacks.error(new Error('failed to communicate with backend service'));
653 | };
654 |
655 | _onWsMessage(event) {
656 | const msg = JSON.parse(event.data);
657 | if (msg.type === 'answer') {
658 | this._pc.setRemoteDescription(new RTCSessionDescription({type: 'answer', sdp: atob(msg.sdp)}));
659 | } else if (msg.type === 'candidate') {
660 | this._pc.addIceCandidate({'candidate': atob(msg.candidate), 'sdpMLineIndex': msg.sdpMLineIndex, 'sdpMid': msg.sdpMid})
661 | } else {
662 | console.log('Unknown message type ' + msg.type)
663 | }
664 | };
665 | }
666 |
667 |
668 | class _gamepadEventManager {
669 | constructor(sendEvent) {
670 | this._polling = false;
671 | this._state = {};
672 | this._dpad_remap_start_index = 6;
673 | this._dpad_standard_start_index = 12;
674 | this._sendEvent = sendEvent
675 | }
676 |
677 | startPolling() {
678 | if (this._polling === true)
679 | return;
680 |
681 | // Since chrome only supports event polling and we don't want
682 | // to send any gamepad events to Android isntance if the state
683 | // of any button or axis of gamepad is not changed. Hence we
684 | // cache all keys state whenever it gets connected and provide
685 | // event-driven gamepad events mechanism for gamepad events processing.
686 | let gamepads = navigator.getGamepads();
687 | for (let i = 0; i < gamepads.length; i++) {
688 | if (gamepads[i])
689 | this.cacheState(gamepads[i]);
690 | }
691 |
692 | this._polling = true;
693 | this.tick()
694 | };
695 |
696 | stopPolling() {
697 | if (this._polling === true)
698 | this._polling = false;
699 | };
700 |
701 | tick() {
702 | this.queryEvents();
703 | if (this._polling)
704 | window.requestAnimationFrame(this.tick.bind(this));
705 | };
706 |
707 | queryEvents() {
708 | let gamepads = navigator.getGamepads();
709 | for (let i = 0; i < gamepads.length; i++) {
710 | let gamepad = gamepads[i];
711 | if (gamepad) {
712 | // A new gamepad is added
713 | if (!this._state[gamepad])
714 | this.cacheState(gamepad);
715 | else {
716 | const buttons = gamepad.buttons;
717 | const cacheButtons = this._state[gamepad].buttons;
718 | for (let j = 0; j < buttons.length; j++) {
719 | if (cacheButtons[j].pressed !== buttons[j].pressed) {
720 | // Check the table at the following link that describes the buttons/axes
721 | // index and their physical locations.
722 | this._sendEvent('gamepad-button', {id: gamepad.index, index: j, pressed: buttons[j].pressed});
723 | cacheButtons[j].pressed = buttons[j].pressed;
724 | }
725 | }
726 |
727 | // NOTE: For some game controllers, E.g. PS3 or Xbox 360 controller, DPAD buttons
728 | // were translated to axes via html5 gamepad APIs and located in gamepad.axes array
729 | // indexed starting from 6 to 7.
730 | // When a DPAD button is pressed/unpressed, the corresponding value as follows
731 | //
732 | // Button | Index | Pressed | Unpressed |
733 | // DPAD_LEFT_BUTTON | 6 | -1 | 0 |
734 | // DPAD_RIGHT_BUTTON | 6 | 1 | 0 |
735 | // DPAD_UP_BUTTON | 7 | -1 | 0 |
736 | // DPAD_DOWN_BUTTON | 7 | 1 | 0 |
737 | //
738 | // When the above button was pressed/unpressed, we will send the gamepad-button
739 | // event instead.
740 | const axes = gamepad.axes;
741 | let dpad_button_index = 0;
742 | const cacheAxes = this._state[gamepad].axes;
743 | for (let k = 0; k < axes.length; k++) {
744 | if (cacheAxes[k] !== axes[k]) {
745 | switch (true) {
746 | case k < this._dpad_remap_start_index: // Standard axes
747 | this._sendEvent('gamepad-axes', {id: gamepad.index, index: k, value: axes[k]});
748 | break;
749 | case k === this._dpad_remap_start_index: // DPAD left and right buttons
750 | if (axes[k] === 0) {}
751 | else if (axes[k] === -1) {
752 | dpad_button_index = this._dpad_standard_start_index + 2;
753 | } else {
754 | dpad_button_index = this._dpad_standard_start_index + 3;
755 | }
756 |
757 | this._sendEvent('gamepad-button', {
758 | id: gamepad.index,
759 | index: dpad_button_index,
760 | pressed: axes[k] !== 0
761 | });
762 | break;
763 | case k === this._dpad_remap_start_index + 1: // DPAD up and down buttons
764 | if (axes[k] === 0) {}
765 | else if (axes[k] === -1) {
766 | dpad_button_index = this._dpad_standard_start_index;
767 | } else {
768 | dpad_button_index = this._dpad_standard_start_index + 1;
769 | }
770 |
771 | this._sendEvent('gamepad-button', {
772 | id: gamepad.index,
773 | index: dpad_button_index,
774 | pressed: axes[k] !== 0
775 | });
776 | break;
777 | default:
778 | console.log("Unsupported axes index", k);
779 | break;
780 | }
781 | cacheAxes[k] = axes[k]
782 | }
783 | }
784 | }
785 | }
786 | }
787 | };
788 |
789 | cacheState(gamepad) {
790 | if (!gamepad)
791 | return;
792 |
793 | const gamepadState = {};
794 | const buttons = gamepad.buttons;
795 | for (let index = 0; index < buttons.length; index++) {
796 | let buttonState = {
797 | pressed: buttons[index].pressed
798 | };
799 | if (gamepadState.buttons)
800 | gamepadState.buttons.push(buttonState);
801 | else
802 | gamepadState.buttons = [buttonState];
803 | }
804 |
805 | const axes = gamepad.axes;
806 | for (let index = 0; index < axes.length; index++) {
807 | if (gamepadState.axes)
808 | gamepadState.axes.push(axes[index]);
809 | else
810 | gamepadState.axes = [axes[index]];
811 | }
812 |
813 | this._state[gamepad] = gamepadState;
814 | }
815 | }
816 |
817 | const _keyScancodes = {
818 | KeyA: 4,
819 | KeyB: 5,
820 | KeyC: 6,
821 | KeyD: 7,
822 | KeyE: 8,
823 | KeyF: 9,
824 | KeyG: 10,
825 | KeyH: 11,
826 | KeyI: 12,
827 | KeyJ: 13,
828 | KeyK: 14,
829 | KeyL: 15,
830 | KeyM: 16,
831 | KeyN: 17,
832 | KeyO: 18,
833 | KeyP: 19,
834 | KeyQ: 20,
835 | KeyR: 21,
836 | KeyS: 22,
837 | KeyT: 23,
838 | KeyU: 24,
839 | KeyV: 25,
840 | KeyW: 26,
841 | KeyX: 27,
842 | KeyY: 28,
843 | KeyZ: 29,
844 | Digit1: 30,
845 | Digit2: 31,
846 | Digit3: 32,
847 | Digit4: 33,
848 | Digit5: 34,
849 | Digit6: 35,
850 | Digit7: 36,
851 | Digit8: 37,
852 | Digit9: 38,
853 | Digit0: 39,
854 | Enter: 40,
855 | Escape: 41,
856 | Backspace: 42,
857 | Tab: 43,
858 | Space: 44,
859 | Minus: 45,
860 | Equal: 46,
861 | BracketLeft: 47,
862 | BracketRight: 48,
863 | Backslash: 49,
864 | Semicolon: 51,
865 | Comma: 54,
866 | Period: 55,
867 | Slash: 56,
868 | CapsLock: 57,
869 | F1: 58,
870 | F2: 59,
871 | F3: 60,
872 | F4: 61,
873 | F5: 62,
874 | F6: 63,
875 | F7: 64,
876 | F8: 65,
877 | F9: 66,
878 | F10: 67,
879 | F11: 68,
880 | F12: 69,
881 | PrintScreen: 70,
882 | ScrollLock: 71,
883 | Pause: 72,
884 | Insert: 73,
885 | Home: 74,
886 | PageUp: 75,
887 | Delete: 76,
888 | End: 77,
889 | PageDown: 78,
890 | ArrowRight: 79,
891 | ArrowLeft: 80,
892 | ArrowDown: 81,
893 | ArrowUp: 82,
894 | Control: 83,
895 | Shift: 84,
896 | Alt: 85,
897 | Meta: 86,
898 | AltGraph: 87,
899 | NumLock: 88,
900 | };
901 |
902 | const _modifierEnum = {
903 | Control: 0x1,
904 | Shift: 0x2,
905 | Alt: 0x4,
906 | Meta: 0x8,
907 | AltGraph: 0x10,
908 | };
909 |
910 | export default AnboxStream;
911 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------