Initial.
This commit is contained in:
Casper V. Kristensen
commit
17e625474a
GPG key ID:
289CA03790535054
18 changed files with 1774 additions and 0 deletions
358
.gitignore
vendored
Normal file
358
.gitignore
vendored
Normal file
|
|
@ -0,0 +1,358 @@
|
||||||
|
|
||||||
|
# Created by https://www.gitignore.io/api/python,pycharm,pycharm+all,pycharm+iml,emacs
|
||||||
|
# Edit at https://www.gitignore.io/?templates=python,pycharm,pycharm+all,pycharm+iml,emacs
|
||||||
|
|
||||||
|
### Emacs ###
|
||||||
|
# -*- mode: gitignore; -*-
|
||||||
|
*~
|
||||||
|
\#*\#
|
||||||
|
/.emacs.desktop
|
||||||
|
/.emacs.desktop.lock
|
||||||
|
*.elc
|
||||||
|
auto-save-list
|
||||||
|
tramp
|
||||||
|
.\#*
|
||||||
|
|
||||||
|
# Org-mode
|
||||||
|
.org-id-locations
|
||||||
|
*_archive
|
||||||
|
|
||||||
|
# flymake-mode
|
||||||
|
*_flymake.*
|
||||||
|
|
||||||
|
# eshell files
|
||||||
|
/eshell/history
|
||||||
|
/eshell/lastdir
|
||||||
|
|
||||||
|
# elpa packages
|
||||||
|
/elpa/
|
||||||
|
|
||||||
|
# reftex files
|
||||||
|
*.rel
|
||||||
|
|
||||||
|
# AUCTeX auto folder
|
||||||
|
/auto/
|
||||||
|
|
||||||
|
# cask packages
|
||||||
|
.cask/
|
||||||
|
dist/
|
||||||
|
|
||||||
|
# Flycheck
|
||||||
|
flycheck_*.el
|
||||||
|
|
||||||
|
# server auth directory
|
||||||
|
/server/
|
||||||
|
|
||||||
|
# projectiles files
|
||||||
|
.projectile
|
||||||
|
|
||||||
|
# directory configuration
|
||||||
|
.dir-locals.el
|
||||||
|
|
||||||
|
### PyCharm ###
|
||||||
|
# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm
|
||||||
|
# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
|
||||||
|
|
||||||
|
# User-specific stuff
|
||||||
|
.idea/**/workspace.xml
|
||||||
|
.idea/**/tasks.xml
|
||||||
|
.idea/**/usage.statistics.xml
|
||||||
|
.idea/**/dictionaries
|
||||||
|
.idea/**/shelf
|
||||||
|
|
||||||
|
# Generated files
|
||||||
|
.idea/**/contentModel.xml
|
||||||
|
|
||||||
|
# Sensitive or high-churn files
|
||||||
|
.idea/**/dataSources/
|
||||||
|
.idea/**/dataSources.ids
|
||||||
|
.idea/**/dataSources.local.xml
|
||||||
|
.idea/**/sqlDataSources.xml
|
||||||
|
.idea/**/dynamic.xml
|
||||||
|
.idea/**/uiDesigner.xml
|
||||||
|
.idea/**/dbnavigator.xml
|
||||||
|
|
||||||
|
# Gradle
|
||||||
|
.idea/**/gradle.xml
|
||||||
|
.idea/**/libraries
|
||||||
|
|
||||||
|
# Gradle and Maven with auto-import
|
||||||
|
# When using Gradle or Maven with auto-import, you should exclude module files,
|
||||||
|
# since they will be recreated, and may cause churn. Uncomment if using
|
||||||
|
# auto-import.
|
||||||
|
# .idea/modules.xml
|
||||||
|
# .idea/*.iml
|
||||||
|
# .idea/modules
|
||||||
|
|
||||||
|
# CMake
|
||||||
|
cmake-build-*/
|
||||||
|
|
||||||
|
# Mongo Explorer plugin
|
||||||
|
.idea/**/mongoSettings.xml
|
||||||
|
|
||||||
|
# File-based project format
|
||||||
|
*.iws
|
||||||
|
|
||||||
|
# IntelliJ
|
||||||
|
out/
|
||||||
|
|
||||||
|
# mpeltonen/sbt-idea plugin
|
||||||
|
.idea_modules/
|
||||||
|
|
||||||
|
# JIRA plugin
|
||||||
|
atlassian-ide-plugin.xml
|
||||||
|
|
||||||
|
# Cursive Clojure plugin
|
||||||
|
.idea/replstate.xml
|
||||||
|
|
||||||
|
# Crashlytics plugin (for Android Studio and IntelliJ)
|
||||||
|
com_crashlytics_export_strings.xml
|
||||||
|
crashlytics.properties
|
||||||
|
crashlytics-build.properties
|
||||||
|
fabric.properties
|
||||||
|
|
||||||
|
# Editor-based Rest Client
|
||||||
|
.idea/httpRequests
|
||||||
|
|
||||||
|
# Android studio 3.1+ serialized cache file
|
||||||
|
.idea/caches/build_file_checksums.ser
|
||||||
|
|
||||||
|
### PyCharm Patch ###
|
||||||
|
# Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721
|
||||||
|
|
||||||
|
# *.iml
|
||||||
|
# modules.xml
|
||||||
|
# .idea/misc.xml
|
||||||
|
# *.ipr
|
||||||
|
|
||||||
|
# Sonarlint plugin
|
||||||
|
.idea/sonarlint
|
||||||
|
|
||||||
|
### PyCharm+all ###
|
||||||
|
# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm
|
||||||
|
# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
|
||||||
|
|
||||||
|
# User-specific stuff
|
||||||
|
|
||||||
|
# Generated files
|
||||||
|
|
||||||
|
# Sensitive or high-churn files
|
||||||
|
|
||||||
|
# Gradle
|
||||||
|
|
||||||
|
# Gradle and Maven with auto-import
|
||||||
|
# When using Gradle or Maven with auto-import, you should exclude module files,
|
||||||
|
# since they will be recreated, and may cause churn. Uncomment if using
|
||||||
|
# auto-import.
|
||||||
|
# .idea/modules.xml
|
||||||
|
# .idea/*.iml
|
||||||
|
# .idea/modules
|
||||||
|
|
||||||
|
# CMake
|
||||||
|
|
||||||
|
# Mongo Explorer plugin
|
||||||
|
|
||||||
|
# File-based project format
|
||||||
|
|
||||||
|
# IntelliJ
|
||||||
|
|
||||||
|
# mpeltonen/sbt-idea plugin
|
||||||
|
|
||||||
|
# JIRA plugin
|
||||||
|
|
||||||
|
# Cursive Clojure plugin
|
||||||
|
|
||||||
|
# Crashlytics plugin (for Android Studio and IntelliJ)
|
||||||
|
|
||||||
|
# Editor-based Rest Client
|
||||||
|
|
||||||
|
# Android studio 3.1+ serialized cache file
|
||||||
|
|
||||||
|
### PyCharm+all Patch ###
|
||||||
|
# Ignores the whole .idea folder and all .iml files
|
||||||
|
# See https://github.com/joeblau/gitignore.io/issues/186 and https://github.com/joeblau/gitignore.io/issues/360
|
||||||
|
|
||||||
|
.idea/
|
||||||
|
|
||||||
|
# Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-249601023
|
||||||
|
|
||||||
|
*.iml
|
||||||
|
modules.xml
|
||||||
|
.idea/misc.xml
|
||||||
|
*.ipr
|
||||||
|
|
||||||
|
### PyCharm+iml ###
|
||||||
|
# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm
|
||||||
|
# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
|
||||||
|
|
||||||
|
# User-specific stuff
|
||||||
|
|
||||||
|
# Generated files
|
||||||
|
|
||||||
|
# Sensitive or high-churn files
|
||||||
|
|
||||||
|
# Gradle
|
||||||
|
|
||||||
|
# Gradle and Maven with auto-import
|
||||||
|
# When using Gradle or Maven with auto-import, you should exclude module files,
|
||||||
|
# since they will be recreated, and may cause churn. Uncomment if using
|
||||||
|
# auto-import.
|
||||||
|
# .idea/modules.xml
|
||||||
|
# .idea/*.iml
|
||||||
|
# .idea/modules
|
||||||
|
|
||||||
|
# CMake
|
||||||
|
|
||||||
|
# Mongo Explorer plugin
|
||||||
|
|
||||||
|
# File-based project format
|
||||||
|
|
||||||
|
# IntelliJ
|
||||||
|
|
||||||
|
# mpeltonen/sbt-idea plugin
|
||||||
|
|
||||||
|
# JIRA plugin
|
||||||
|
|
||||||
|
# Cursive Clojure plugin
|
||||||
|
|
||||||
|
# Crashlytics plugin (for Android Studio and IntelliJ)
|
||||||
|
|
||||||
|
# Editor-based Rest Client
|
||||||
|
|
||||||
|
# Android studio 3.1+ serialized cache file
|
||||||
|
|
||||||
|
### PyCharm+iml Patch ###
|
||||||
|
# Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-249601023
|
||||||
|
|
||||||
|
|
||||||
|
### Python ###
|
||||||
|
# Byte-compiled / optimized / DLL files
|
||||||
|
__pycache__/
|
||||||
|
*.py[cod]
|
||||||
|
*$py.class
|
||||||
|
|
||||||
|
# C extensions
|
||||||
|
*.so
|
||||||
|
|
||||||
|
# Distribution / packaging
|
||||||
|
.Python
|
||||||
|
build/
|
||||||
|
develop-eggs/
|
||||||
|
downloads/
|
||||||
|
eggs/
|
||||||
|
.eggs/
|
||||||
|
lib/
|
||||||
|
lib64/
|
||||||
|
parts/
|
||||||
|
sdist/
|
||||||
|
var/
|
||||||
|
wheels/
|
||||||
|
*.egg-info/
|
||||||
|
.installed.cfg
|
||||||
|
*.egg
|
||||||
|
MANIFEST
|
||||||
|
|
||||||
|
# PyInstaller
|
||||||
|
# Usually these files are written by a python script from a template
|
||||||
|
# before PyInstaller builds the exe, so as to inject date/other infos into it.
|
||||||
|
*.manifest
|
||||||
|
*.spec
|
||||||
|
|
||||||
|
# Installer logs
|
||||||
|
pip-log.txt
|
||||||
|
pip-delete-this-directory.txt
|
||||||
|
|
||||||
|
# Unit test / coverage reports
|
||||||
|
htmlcov/
|
||||||
|
.tox/
|
||||||
|
.nox/
|
||||||
|
.coverage
|
||||||
|
.coverage.*
|
||||||
|
.cache
|
||||||
|
nosetests.xml
|
||||||
|
coverage.xml
|
||||||
|
*.cover
|
||||||
|
.hypothesis/
|
||||||
|
.pytest_cache/
|
||||||
|
|
||||||
|
# Translations
|
||||||
|
*.mo
|
||||||
|
*.pot
|
||||||
|
|
||||||
|
# Django stuff:
|
||||||
|
*.log
|
||||||
|
local_settings.py
|
||||||
|
db.sqlite3
|
||||||
|
|
||||||
|
# Flask stuff:
|
||||||
|
instance/
|
||||||
|
.webassets-cache
|
||||||
|
|
||||||
|
# Scrapy stuff:
|
||||||
|
.scrapy
|
||||||
|
|
||||||
|
# Sphinx documentation
|
||||||
|
docs/_build/
|
||||||
|
|
||||||
|
# PyBuilder
|
||||||
|
target/
|
||||||
|
|
||||||
|
# Jupyter Notebook
|
||||||
|
.ipynb_checkpoints
|
||||||
|
|
||||||
|
# IPython
|
||||||
|
profile_default/
|
||||||
|
ipython_config.py
|
||||||
|
|
||||||
|
# pyenv
|
||||||
|
.python-version
|
||||||
|
|
||||||
|
# celery beat schedule file
|
||||||
|
celerybeat-schedule
|
||||||
|
|
||||||
|
# SageMath parsed files
|
||||||
|
*.sage.py
|
||||||
|
|
||||||
|
# Environments
|
||||||
|
.env
|
||||||
|
.venv
|
||||||
|
env/
|
||||||
|
venv/
|
||||||
|
ENV/
|
||||||
|
env.bak/
|
||||||
|
venv.bak/
|
||||||
|
|
||||||
|
# Spyder project settings
|
||||||
|
.spyderproject
|
||||||
|
.spyproject
|
||||||
|
|
||||||
|
# Rope project settings
|
||||||
|
.ropeproject
|
||||||
|
|
||||||
|
# mkdocs documentation
|
||||||
|
/site
|
||||||
|
|
||||||
|
# mypy
|
||||||
|
.mypy_cache/
|
||||||
|
.dmypy.json
|
||||||
|
dmypy.json
|
||||||
|
|
||||||
|
# Pyre type checker
|
||||||
|
.pyre/
|
||||||
|
|
||||||
|
### Python Patch ###
|
||||||
|
.venv/
|
||||||
|
|
||||||
|
### Python.VirtualEnv Stack ###
|
||||||
|
# Virtualenv
|
||||||
|
# http://iamzed.com/2009/05/07/a-primer-on-virtualenv/
|
||||||
|
[Bb]in
|
||||||
|
[Ii]nclude
|
||||||
|
[Ll]ib
|
||||||
|
[Ll]ib64
|
||||||
|
[Ll]ocal
|
||||||
|
[Ss]cripts
|
||||||
|
pyvenv.cfg
|
||||||
|
pip-selfcheck.json
|
||||||
|
|
||||||
|
# End of https://www.gitignore.io/api/python,pycharm,pycharm+all,pycharm+iml,emacs
|
||||||
674
LICENSE.txt
Normal file
674
LICENSE.txt
Normal file
|
|
@ -0,0 +1,674 @@
|
||||||
|
GNU GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The GNU General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
the GNU General Public License is intended to guarantee your freedom to
|
||||||
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users. We, the Free Software Foundation, use the
|
||||||
|
GNU General Public License for most of our software; it applies also to
|
||||||
|
any other work released this way by its authors. You can apply it to
|
||||||
|
your programs, too.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
To protect your rights, we need to prevent others from denying you
|
||||||
|
these rights or asking you to surrender the rights. Therefore, you have
|
||||||
|
certain responsibilities if you distribute copies of the software, or if
|
||||||
|
you modify it: responsibilities to respect the freedom of others.
|
||||||
|
|
||||||
|
For example, if you distribute copies of such a program, whether
|
||||||
|
gratis or for a fee, you must pass on to the recipients the same
|
||||||
|
freedoms that you received. You must make sure that they, too, receive
|
||||||
|
or can get the source code. And you must show them these terms so they
|
||||||
|
know their rights.
|
||||||
|
|
||||||
|
Developers that use the GNU GPL protect your rights with two steps:
|
||||||
|
(1) assert copyright on the software, and (2) offer you this License
|
||||||
|
giving you legal permission to copy, distribute and/or modify it.
|
||||||
|
|
||||||
|
For the developers' and authors' protection, the GPL clearly explains
|
||||||
|
that there is no warranty for this free software. For both users' and
|
||||||
|
authors' sake, the GPL requires that modified versions be marked as
|
||||||
|
changed, so that their problems will not be attributed erroneously to
|
||||||
|
authors of previous versions.
|
||||||
|
|
||||||
|
Some devices are designed to deny users access to install or run
|
||||||
|
modified versions of the software inside them, although the manufacturer
|
||||||
|
can do so. This is fundamentally incompatible with the aim of
|
||||||
|
protecting users' freedom to change the software. The systematic
|
||||||
|
pattern of such abuse occurs in the area of products for individuals to
|
||||||
|
use, which is precisely where it is most unacceptable. Therefore, we
|
||||||
|
have designed this version of the GPL to prohibit the practice for those
|
||||||
|
products. If such problems arise substantially in other domains, we
|
||||||
|
stand ready to extend this provision to those domains in future versions
|
||||||
|
of the GPL, as needed to protect the freedom of users.
|
||||||
|
|
||||||
|
Finally, every program is threatened constantly by software patents.
|
||||||
|
States should not allow patents to restrict development and use of
|
||||||
|
software on general-purpose computers, but in those that do, we wish to
|
||||||
|
avoid the special danger that patents applied to a free program could
|
||||||
|
make it effectively proprietary. To prevent this, the GPL assures that
|
||||||
|
patents cannot be used to render the program non-free.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Use with the GNU Affero General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU Affero General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the special requirements of the GNU Affero General Public License,
|
||||||
|
section 13, concerning interaction through a network will apply to the
|
||||||
|
combination as such.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU General Public License from time to time. Such new versions will
|
||||||
|
be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If the program does terminal interaction, make it output a short
|
||||||
|
notice like this when it starts in an interactive mode:
|
||||||
|
|
||||||
|
<program> Copyright (C) <year> <name of author>
|
||||||
|
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||||
|
This is free software, and you are welcome to redistribute it
|
||||||
|
under certain conditions; type `show c' for details.
|
||||||
|
|
||||||
|
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||||
|
parts of the General Public License. Of course, your program's commands
|
||||||
|
might be different; for a GUI interface, you would use an "about box".
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU GPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
The GNU General Public License does not permit incorporating your program
|
||||||
|
into proprietary programs. If your program is a subroutine library, you
|
||||||
|
may consider it more useful to permit linking proprietary applications with
|
||||||
|
the library. If this is what you want to do, use the GNU Lesser General
|
||||||
|
Public License instead of this License. But first, please read
|
||||||
|
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||||
43
README.md
Normal file
43
README.md
Normal file
|
|
@ -0,0 +1,43 @@
|
||||||
|
# wau: *World of Warcraft AddOn Updater*
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
The easiest way to install the application is to use pip:
|
||||||
|
```bash
|
||||||
|
pip3 install --upgrade https://git.caspervk.net/caspervk/wau/archive/master.tar.gz
|
||||||
|
```
|
||||||
|
**It requires Python 3.7 or later.**
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
The program can be started by running `wau` or `python3 -m wau`, depending on system configuration.
|
||||||
|
```text
|
||||||
|
usage: wau [-h] [-v] {install,remove,update,list,clean,export} ...
|
||||||
|
|
||||||
|
World of Warcraft AddOn Updater v0.0.1 by Casper V. Kristensen.
|
||||||
|
|
||||||
|
positional arguments:
|
||||||
|
{install,remove,update,list,clean,export}
|
||||||
|
install Install a new AddOn.
|
||||||
|
remove Remove a previously installed AddOn.
|
||||||
|
update Install newest version of all AddOns.
|
||||||
|
list List installed AddOn.
|
||||||
|
clean Clear out the local cache of retrieved files.
|
||||||
|
export Export the list of installed AddOns for install
|
||||||
|
elsewhere.
|
||||||
|
|
||||||
|
optional arguments:
|
||||||
|
-h, --help show this help message and exit
|
||||||
|
-v, --verbose Increase verbosity level. Can be used multiple times.
|
||||||
|
|
||||||
|
For more information, see <https://git.caspervk.net/caspervk/wau>.
|
||||||
|
```
|
||||||
|
|
||||||
|
## Supported AddOn Providers
|
||||||
|
- CurseForge.com
|
||||||
|
- WowInterface.com
|
||||||
|
- Git
|
||||||
|
- ~~GitHub Releases~~ (coming soon™)
|
||||||
|
- HTTP
|
||||||
|
|
||||||
|
|
||||||
|
## Screenshots
|
||||||
|
|
||||||
BIN
images/basic.png
Normal file
BIN
images/basic.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 147 KiB |
56
setup.py
Normal file
56
setup.py
Normal file
|
|
@ -0,0 +1,56 @@
|
||||||
|
# Always prefer setuptools over distutils
|
||||||
|
from setuptools import setup, find_packages
|
||||||
|
# To use a consistent encoding
|
||||||
|
from codecs import open
|
||||||
|
from os import path
|
||||||
|
|
||||||
|
from wau import __author__, __version__, __licence__, __url__
|
||||||
|
|
||||||
|
|
||||||
|
here = path.abspath(path.dirname(__file__))
|
||||||
|
|
||||||
|
# Get the long description from the README file
|
||||||
|
with open(path.join(here, "README.md"), encoding="utf-8") as f:
|
||||||
|
long_description = f.read()
|
||||||
|
|
||||||
|
|
||||||
|
setup(
|
||||||
|
name="wau",
|
||||||
|
version=__version__,
|
||||||
|
description="World of Warcraft AddOn Updater",
|
||||||
|
long_description=long_description,
|
||||||
|
long_description_content_type="text/markdown",
|
||||||
|
url=__url__,
|
||||||
|
project_urls={
|
||||||
|
"Source": __url__
|
||||||
|
},
|
||||||
|
author=__author__,
|
||||||
|
classifiers=[
|
||||||
|
"Development Status :: 3 - Alpha",
|
||||||
|
"License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",
|
||||||
|
"Programming Language :: Python :: 3",
|
||||||
|
],
|
||||||
|
python_requires=">=3.7",
|
||||||
|
keywords="world of warcraft wow addon updater",
|
||||||
|
license=__licence__,
|
||||||
|
packages=find_packages(exclude=["tests"]),
|
||||||
|
include_package_data=True,
|
||||||
|
package_data={
|
||||||
|
"wau": [
|
||||||
|
"*.default"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
install_requires=[
|
||||||
|
"tabulate"
|
||||||
|
],
|
||||||
|
extras_require={
|
||||||
|
"dev": [
|
||||||
|
"wheel"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
entry_points={
|
||||||
|
"console_scripts": [
|
||||||
|
"wau = wau.cli:main"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
)
|
||||||
7
wau/__init__.py
Normal file
7
wau/__init__.py
Normal file
|
|
@ -0,0 +1,7 @@
|
||||||
|
__version__ = "0.0.1"
|
||||||
|
__author__ = "Casper V. Kristensen"
|
||||||
|
__licence__ = "GPLv3"
|
||||||
|
__url__ = "https://git.caspervk.net/caspervk/wau"
|
||||||
|
|
||||||
|
import sys
|
||||||
|
assert sys.version_info >= (3, 7), "wau requires python 3.7 or later."
|
||||||
3
wau/__main__.py
Normal file
3
wau/__main__.py
Normal file
|
|
@ -0,0 +1,3 @@
|
||||||
|
if __name__ == "__main__":
|
||||||
|
from .cli import main
|
||||||
|
main()
|
||||||
138
wau/addons.py
Normal file
138
wau/addons.py
Normal file
|
|
@ -0,0 +1,138 @@
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import json
|
||||||
|
import logging
|
||||||
|
import re
|
||||||
|
import shutil
|
||||||
|
from dataclasses import dataclass, field
|
||||||
|
from pathlib import Path
|
||||||
|
from typing import Iterable, List
|
||||||
|
|
||||||
|
from . import config, providers
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass
|
||||||
|
class Addon:
|
||||||
|
name: str = None
|
||||||
|
url: str = None
|
||||||
|
dirs: List[Path] = field(default_factory=list)
|
||||||
|
provider: str = None
|
||||||
|
provider_data: dict = field(default_factory=dict)
|
||||||
|
|
||||||
|
@property
|
||||||
|
def to_json(self) -> dict:
|
||||||
|
return {
|
||||||
|
"name": self.name,
|
||||||
|
"url": self.url,
|
||||||
|
"dirs": [str(d) for d in self.dirs],
|
||||||
|
"provider": self.provider,
|
||||||
|
"provider_data": self.provider_data
|
||||||
|
}
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def from_json(cls, data) -> Addon:
|
||||||
|
return cls(
|
||||||
|
name=data["name"],
|
||||||
|
url=data["url"],
|
||||||
|
dirs=[Path(d) for d in data["dirs"]],
|
||||||
|
provider=data["provider"],
|
||||||
|
provider_data=data["provider_data"]
|
||||||
|
)
|
||||||
|
|
||||||
|
@property
|
||||||
|
def download_dir(self) -> Path:
|
||||||
|
return config.CACHE_DIR.joinpath(get_valid_dir_filename(self.url))
|
||||||
|
|
||||||
|
def create_download_dir(self, recreate=False):
|
||||||
|
if recreate:
|
||||||
|
shutil.rmtree(self.download_dir, ignore_errors=True)
|
||||||
|
self.download_dir.mkdir(parents=True, exist_ok=True)
|
||||||
|
|
||||||
|
def is_cached(self) -> bool:
|
||||||
|
return self.dirs and all(d.is_dir() for d in self.dirs)
|
||||||
|
|
||||||
|
def get_provider(self) -> providers.Provider:
|
||||||
|
if self.provider is not None:
|
||||||
|
return providers.PROVIDERS[self.provider]
|
||||||
|
|
||||||
|
for provider_name, provider in providers.PROVIDERS.items():
|
||||||
|
if provider.is_supported(self.url):
|
||||||
|
self.provider = provider_name
|
||||||
|
logger.debug("%s is supported by %s", self, provider.__name__)
|
||||||
|
return provider
|
||||||
|
raise ValueError(f"No AddOn provider for {self}")
|
||||||
|
|
||||||
|
def download(self) -> bool:
|
||||||
|
logger.info("Downloading %s", self.url)
|
||||||
|
self.create_download_dir()
|
||||||
|
provider = self.get_provider()
|
||||||
|
changed = provider.download(self)
|
||||||
|
return changed
|
||||||
|
|
||||||
|
def install(self) -> None:
|
||||||
|
logger.info("Installing %s", self)
|
||||||
|
self.dirs = find_addon_dirs(self.download_dir)
|
||||||
|
for dir in self.dirs:
|
||||||
|
shutil.copytree(str(dir), config.ADDONS_DIR.joinpath(dir.name))
|
||||||
|
|
||||||
|
if self.name is None: # didn't get AddOn name from provider
|
||||||
|
if len(self.dirs) == 1:
|
||||||
|
self.name = self.dirs[0].name
|
||||||
|
else:
|
||||||
|
print(f"Please enter AddOn name for {self.url}:")
|
||||||
|
self.name = input()
|
||||||
|
|
||||||
|
def uninstall(self) -> None:
|
||||||
|
logger.info("Uninstalling %s", self)
|
||||||
|
shutil.rmtree(self.download_dir, ignore_errors=True)
|
||||||
|
for dir in self.dirs:
|
||||||
|
shutil.rmtree(config.ADDONS_DIR.joinpath(dir.name))
|
||||||
|
|
||||||
|
|
||||||
|
def find_addon_dirs(path: Path) -> List[Path]:
|
||||||
|
"""
|
||||||
|
Find and return AddOns in the given path.
|
||||||
|
|
||||||
|
Each WoW AddOn is identified by a .toc-file whose filename matches its containing folder. The algorithm traverses
|
||||||
|
the path in a breadth-first fashion, returning all found AddOns in the first level which contains any AddOns.
|
||||||
|
This ensures we find AddOns 'Foo' and 'Foo_Config'.
|
||||||
|
"""
|
||||||
|
level = [path]
|
||||||
|
while level:
|
||||||
|
addon_dirs = []
|
||||||
|
for p in level:
|
||||||
|
if any(toc.stem == p.name for toc in p.glob("*.toc")):
|
||||||
|
addon_dirs.append(p)
|
||||||
|
if addon_dirs:
|
||||||
|
logger.debug("Found AddOn dirs: %s in '%s'", addon_dirs, path)
|
||||||
|
return addon_dirs
|
||||||
|
level = [c
|
||||||
|
for p in level
|
||||||
|
for c in p.iterdir()
|
||||||
|
if c.is_dir()]
|
||||||
|
raise FileNotFoundError(f"No AddOn dirs found in {path}")
|
||||||
|
|
||||||
|
|
||||||
|
def get_valid_dir_filename(s: str) -> str:
|
||||||
|
"""
|
||||||
|
From https://github.com/django/django/blob/master/django/utils/text.py
|
||||||
|
"""
|
||||||
|
s = str(s).strip().replace(" ", "_")
|
||||||
|
return re.sub(r"(?u)[^-\w.]", "", s)
|
||||||
|
|
||||||
|
|
||||||
|
def load_installed_addons() -> List[Addon]:
|
||||||
|
logger.debug("Loading list of installed AddOns from %s", config.CONFIG_FILE)
|
||||||
|
try:
|
||||||
|
with config.CONFIG_FILE.open() as cf:
|
||||||
|
return [Addon.from_json(a) for a in json.load(cf)["installed_addons"]]
|
||||||
|
except FileNotFoundError:
|
||||||
|
return []
|
||||||
|
|
||||||
|
|
||||||
|
def save_installed_addons(addons: Iterable[Addon]) -> None:
|
||||||
|
logger.debug("Saving list of installed AddOns to %s", config.CONFIG_FILE)
|
||||||
|
with config.CONFIG_FILE.open("w") as cf:
|
||||||
|
json.dump(dict(installed_addons=[a.to_json for a in addons]), cf)
|
||||||
161
wau/cli.py
Normal file
161
wau/cli.py
Normal file
|
|
@ -0,0 +1,161 @@
|
||||||
|
import argparse
|
||||||
|
import logging
|
||||||
|
import logging.config
|
||||||
|
import shutil
|
||||||
|
import textwrap
|
||||||
|
|
||||||
|
from . import __url__, __author__, __version__, config, providers, addons
|
||||||
|
from .addons import Addon
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
class CLI:
|
||||||
|
def __init__(self) -> None:
|
||||||
|
self.validate_addons_dir()
|
||||||
|
self.installed_addons = addons.load_installed_addons()
|
||||||
|
|
||||||
|
def validate_addons_dir(self) -> None:
|
||||||
|
if not config.ADDONS_DIR.joinpath("../../Wow.exe").is_file():
|
||||||
|
a = input("Error: The application must be run from the Interface/AddOns directory. Continue anyway [y/N]? ")
|
||||||
|
if a.lower() != "y":
|
||||||
|
exit()
|
||||||
|
|
||||||
|
def parse_args(self):
|
||||||
|
parser = argparse.ArgumentParser(
|
||||||
|
prog="wau",
|
||||||
|
description=f"World of Warcraft AddOn Updater v{__version__} by {__author__}.",
|
||||||
|
epilog=f"For more information, see <{__url__}>."
|
||||||
|
)
|
||||||
|
parser.set_defaults(func=lambda a: parser.print_help())
|
||||||
|
parser.add_argument(
|
||||||
|
"-v", "--verbose",
|
||||||
|
action="count",
|
||||||
|
default=0,
|
||||||
|
help="Increase verbosity level. Can be used multiple times."
|
||||||
|
)
|
||||||
|
|
||||||
|
subparsers = parser.add_subparsers()
|
||||||
|
|
||||||
|
install_parser = subparsers.add_parser(
|
||||||
|
name="install",
|
||||||
|
help="Install a new AddOn."
|
||||||
|
)
|
||||||
|
install_parser.set_defaults(func=self.install)
|
||||||
|
install_parser.add_argument(
|
||||||
|
dest="urls",
|
||||||
|
nargs='+',
|
||||||
|
help="URL of AddOn(s).",
|
||||||
|
)
|
||||||
|
|
||||||
|
remove_parser = subparsers.add_parser(
|
||||||
|
name="remove",
|
||||||
|
help="Remove a previously installed AddOn."
|
||||||
|
)
|
||||||
|
remove_parser.set_defaults(func=self.remove)
|
||||||
|
remove_parser.add_argument(
|
||||||
|
dest="addons",
|
||||||
|
nargs='*',
|
||||||
|
help="URL or name of AddOn(s).",
|
||||||
|
)
|
||||||
|
|
||||||
|
remove_parser.add_argument(
|
||||||
|
"--all",
|
||||||
|
action="store_true",
|
||||||
|
help="Remove all AddOns.")
|
||||||
|
|
||||||
|
update_parser = subparsers.add_parser(
|
||||||
|
name="update",
|
||||||
|
help="Install newest version of all AddOns."
|
||||||
|
)
|
||||||
|
update_parser.set_defaults(func=self.update)
|
||||||
|
|
||||||
|
list_parser = subparsers.add_parser(
|
||||||
|
name="list",
|
||||||
|
help="List installed AddOn.",
|
||||||
|
|
||||||
|
)
|
||||||
|
list_parser.set_defaults(func=self.list)
|
||||||
|
|
||||||
|
clean_parser = subparsers.add_parser(
|
||||||
|
name="clean",
|
||||||
|
help="Clear out the local cache of retrieved files."
|
||||||
|
)
|
||||||
|
clean_parser.set_defaults(func=self.clean)
|
||||||
|
|
||||||
|
export_parser = subparsers.add_parser(
|
||||||
|
name="export",
|
||||||
|
help="Export the list of installed AddOns for install elsewhere."
|
||||||
|
)
|
||||||
|
export_parser.set_defaults(func=self.export)
|
||||||
|
|
||||||
|
return parser.parse_args()
|
||||||
|
|
||||||
|
def run(self):
|
||||||
|
args = self.parse_args()
|
||||||
|
logging.config.dictConfig(config.get_logging_config(level=("WARNING", "INFO", "DEBUG")[min(args.verbose, 2)]))
|
||||||
|
logger.debug("Args: %s", args)
|
||||||
|
args.func(args)
|
||||||
|
|
||||||
|
def install(self, args) -> None:
|
||||||
|
already_installed_urls = {a.url for a in self.installed_addons}
|
||||||
|
for url in set(args.urls): # set removes duplicates
|
||||||
|
if url in already_installed_urls:
|
||||||
|
print(f"{url} is already installed")
|
||||||
|
continue
|
||||||
|
print(f"Installing AddOn from {url}")
|
||||||
|
addon = Addon(url=url)
|
||||||
|
addon.download()
|
||||||
|
addon.install()
|
||||||
|
self.installed_addons.append(addon)
|
||||||
|
addons.save_installed_addons(self.installed_addons)
|
||||||
|
|
||||||
|
def remove(self, args) -> None:
|
||||||
|
if args.all:
|
||||||
|
remove = self.installed_addons.copy()
|
||||||
|
else:
|
||||||
|
remove = [addon
|
||||||
|
for addon in self.installed_addons
|
||||||
|
if addon.name in args.addons]
|
||||||
|
for addon in remove:
|
||||||
|
print(f"Removing {addon.name}")
|
||||||
|
addon.uninstall()
|
||||||
|
self.installed_addons.remove(addon)
|
||||||
|
addons.save_installed_addons(self.installed_addons)
|
||||||
|
|
||||||
|
def update(self, args) -> None:
|
||||||
|
for addon in self.installed_addons:
|
||||||
|
print(f"Updating {addon.name}..", end=" ")
|
||||||
|
changed = addon.download()
|
||||||
|
if changed:
|
||||||
|
addon.uninstall()
|
||||||
|
addon.install()
|
||||||
|
print("Done" if changed else "Already up to date")
|
||||||
|
addons.save_installed_addons(self.installed_addons)
|
||||||
|
|
||||||
|
def list(self, args) -> None:
|
||||||
|
table = []
|
||||||
|
for addon in self.installed_addons:
|
||||||
|
table.append({
|
||||||
|
"Name": addon.name,
|
||||||
|
"Provider": addon.get_provider().__name__,
|
||||||
|
"URL": addon.url,
|
||||||
|
"Directories": textwrap.fill(", ".join(d.name for d in addon.dirs), width=40)
|
||||||
|
})
|
||||||
|
from tabulate import tabulate
|
||||||
|
print(tabulate(table, headers="keys", tablefmt="orgtbl"))
|
||||||
|
|
||||||
|
def clean(self, args) -> None:
|
||||||
|
shutil.rmtree(config.CACHE_DIR, ignore_errors=True)
|
||||||
|
|
||||||
|
def export(self, args) -> None:
|
||||||
|
print(" ".join(a.url for a in self.installed_addons))
|
||||||
|
|
||||||
|
|
||||||
|
def main():
|
||||||
|
cli = CLI()
|
||||||
|
cli.run()
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == '__main__':
|
||||||
|
main()
|
||||||
34
wau/config.py
Normal file
34
wau/config.py
Normal file
|
|
@ -0,0 +1,34 @@
|
||||||
|
import logging
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
CONFIG_FILE = Path(".wau.json")
|
||||||
|
ADDONS_DIR = Path.cwd() # for now. Maybe change to reading a config file or something in the future
|
||||||
|
CACHE_DIR = Path(".wau-cache")
|
||||||
|
|
||||||
|
|
||||||
|
def get_logging_config(level="WARNING") -> dict:
|
||||||
|
return {
|
||||||
|
"version": 1,
|
||||||
|
"disable_existing_loggers": False,
|
||||||
|
"formatters": {
|
||||||
|
"standard": {
|
||||||
|
"format": "%(asctime)s [%(levelname)-7s] %(name)s:%(funcName)s - %(message)s"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"handlers": {
|
||||||
|
"console": {
|
||||||
|
"class": "logging.StreamHandler",
|
||||||
|
"stream": "ext://sys.stdout",
|
||||||
|
"formatter": "standard",
|
||||||
|
"level": level,
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"loggers": {
|
||||||
|
"wau": {
|
||||||
|
"level": "DEBUG",
|
||||||
|
"handlers": ["console"]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
}
|
||||||
61
wau/http.py
Normal file
61
wau/http.py
Normal file
|
|
@ -0,0 +1,61 @@
|
||||||
|
import json
|
||||||
|
import logging
|
||||||
|
import shutil
|
||||||
|
import tempfile
|
||||||
|
import urllib.parse
|
||||||
|
import urllib.request
|
||||||
|
import zipfile
|
||||||
|
from functools import lru_cache
|
||||||
|
from http.client import HTTPResponse
|
||||||
|
from pathlib import Path
|
||||||
|
from typing import Mapping
|
||||||
|
from urllib.request import Request
|
||||||
|
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
HTTP_USER_AGENT = "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:68.0) Gecko/20100101 Firefox/68.0"
|
||||||
|
HTTP_TIMEOUT = 3
|
||||||
|
|
||||||
|
|
||||||
|
class Response:
|
||||||
|
def __init__(self, http_response: HTTPResponse) -> None:
|
||||||
|
self.http_response = http_response
|
||||||
|
|
||||||
|
@property
|
||||||
|
@lru_cache()
|
||||||
|
def bytes(self) -> bytes:
|
||||||
|
logger.debug("GET %s", self.http_response.geturl())
|
||||||
|
return self.http_response.read()
|
||||||
|
|
||||||
|
@property
|
||||||
|
@lru_cache()
|
||||||
|
def text(self) -> str:
|
||||||
|
return self.bytes.decode() # TODO: Detect encoding
|
||||||
|
|
||||||
|
@lru_cache()
|
||||||
|
def head(self) -> dict:
|
||||||
|
logger.debug("HEAD %s", self.http_response.geturl())
|
||||||
|
return dict(self.http_response.info())
|
||||||
|
|
||||||
|
@lru_cache()
|
||||||
|
def json(self) -> dict:
|
||||||
|
return json.loads(self.bytes)
|
||||||
|
|
||||||
|
|
||||||
|
def open(url: str, params: Mapping = None) -> Response:
|
||||||
|
if params is not None:
|
||||||
|
url += "?" + urllib.parse.urlencode(params)
|
||||||
|
request = Request(url)
|
||||||
|
request.add_header("User-Agent", HTTP_USER_AGENT)
|
||||||
|
http_response = urllib.request.urlopen(request, timeout=HTTP_TIMEOUT)
|
||||||
|
return Response(http_response)
|
||||||
|
|
||||||
|
|
||||||
|
def download_zip(url: str, dest: Path) -> None:
|
||||||
|
logger.debug("Downloading '%s' to %s", url, dest)
|
||||||
|
with tempfile.TemporaryFile() as tmp:
|
||||||
|
with urllib.request.urlopen(url) as response:
|
||||||
|
shutil.copyfileobj(response, tmp)
|
||||||
|
with zipfile.ZipFile(tmp) as zip:
|
||||||
|
zip.extractall(path=dest)
|
||||||
15
wau/providers/__init__.py
Normal file
15
wau/providers/__init__.py
Normal file
|
|
@ -0,0 +1,15 @@
|
||||||
|
from .base import Provider
|
||||||
|
from .curseforge import CurseForge
|
||||||
|
from .git import Git
|
||||||
|
#from .github import GitHub
|
||||||
|
from .web import Web
|
||||||
|
from .wowinterface import WowInterface
|
||||||
|
|
||||||
|
|
||||||
|
PROVIDERS = { # in order of preference
|
||||||
|
"curse": CurseForge,
|
||||||
|
"wowinterface": WowInterface,
|
||||||
|
#"github": GitHub,
|
||||||
|
"git": Git,
|
||||||
|
"web": Web
|
||||||
|
}
|
||||||
18
wau/providers/base.py
Normal file
18
wau/providers/base.py
Normal file
|
|
@ -0,0 +1,18 @@
|
||||||
|
from ..addons import Addon
|
||||||
|
|
||||||
|
|
||||||
|
class Provider:
|
||||||
|
@classmethod
|
||||||
|
def is_supported(cls, url: str) -> bool:
|
||||||
|
"""
|
||||||
|
Returns True if the given URL is supported by this provider.
|
||||||
|
"""
|
||||||
|
raise NotImplemented
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def download(cls, addon: Addon) -> bool:
|
||||||
|
"""
|
||||||
|
Download the provided AddOn.
|
||||||
|
Returns True if the AddOn data was changed (i.e. downloaded/updated), False otherwise.
|
||||||
|
"""
|
||||||
|
raise NotImplemented
|
||||||
75
wau/providers/curseforge.py
Normal file
75
wau/providers/curseforge.py
Normal file
|
|
@ -0,0 +1,75 @@
|
||||||
|
import logging
|
||||||
|
|
||||||
|
from .base import Provider
|
||||||
|
from .. import http
|
||||||
|
from ..addons import Addon
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
class CurseForge(Provider):
|
||||||
|
api_url = "https://addons-ecs.forgesvc.net"
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def is_supported(cls, url: str) -> bool:
|
||||||
|
return "curseforge.com/wow/addons/" in url
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def download(cls, addon: Addon) -> bool:
|
||||||
|
"""
|
||||||
|
Twitch API from: https://github.com/Gaz492/TwitchAPI. Thanks Gareth! <3
|
||||||
|
"""
|
||||||
|
latest_file_url = cls._get_latest_file_url(addon)
|
||||||
|
try:
|
||||||
|
if addon.is_cached() and latest_file_url == addon.provider_data["file_url"]:
|
||||||
|
return False
|
||||||
|
except KeyError:
|
||||||
|
pass
|
||||||
|
|
||||||
|
addon.create_download_dir(recreate=True) # clean download dir
|
||||||
|
http.download_zip(latest_file_url, addon.download_dir)
|
||||||
|
addon.provider_data["file_url"] = latest_file_url
|
||||||
|
return True
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def _get_curse_id(cls, addon: Addon) -> int:
|
||||||
|
try:
|
||||||
|
return addon.provider_data["curse_id"]
|
||||||
|
except KeyError:
|
||||||
|
pass
|
||||||
|
|
||||||
|
logger.debug("Getting CurseForge AddOn ID")
|
||||||
|
slug = addon.url.split("/addons/")[-1]
|
||||||
|
query = " ".join(( # slug "big-wigs" becomes query "big-wigs bigwigs big wigs"
|
||||||
|
slug,
|
||||||
|
slug.replace("-", ""),
|
||||||
|
slug.replace("-", " ")
|
||||||
|
))
|
||||||
|
addons = http.open(
|
||||||
|
url=f"{cls.api_url}/api/v2/addon/search",
|
||||||
|
params={
|
||||||
|
"gameId": 1, # World of Warcraft
|
||||||
|
"pageSize": 10,
|
||||||
|
"searchFilter": query
|
||||||
|
}
|
||||||
|
).json()
|
||||||
|
for a in addons:
|
||||||
|
if a["slug"] == slug:
|
||||||
|
addon.provider_data["curse_id"] = a["id"]
|
||||||
|
addon.name = a["name"]
|
||||||
|
return a["id"]
|
||||||
|
raise ValueError("AddOn slug not found in CurseForge search results.")
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def _get_curse_addon_info(cls, addon: Addon) -> dict:
|
||||||
|
curse_id = cls._get_curse_id(addon)
|
||||||
|
logger.debug("Getting latest AddOn info from CurseForge")
|
||||||
|
return http.open(f"{cls.api_url}/api/v2/addon/{curse_id}").json()
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def _get_latest_file_url(cls, addon: Addon) -> str:
|
||||||
|
info = cls._get_curse_addon_info(addon)
|
||||||
|
for file in info["latestFiles"]:
|
||||||
|
if file["gameVersionFlavor"] == "wow_classic" and file["releaseType"] == 1: # 1: release, 2: beta, 3: alpha
|
||||||
|
return file["downloadUrl"]
|
||||||
|
raise ValueError("No file found")
|
||||||
64
wau/providers/git.py
Normal file
64
wau/providers/git.py
Normal file
|
|
@ -0,0 +1,64 @@
|
||||||
|
import logging
|
||||||
|
import subprocess
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
from .base import Provider
|
||||||
|
from ..addons import Addon
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
class Git(Provider):
|
||||||
|
@classmethod
|
||||||
|
def is_supported(cls, url: str) -> bool:
|
||||||
|
logger.debug("Performing 'git ls-remote' on %s", url)
|
||||||
|
try:
|
||||||
|
subprocess.run(
|
||||||
|
["git", "ls-remote", "-h", "--exit-code", url],
|
||||||
|
stdout=subprocess.DEVNULL,
|
||||||
|
stderr=subprocess.DEVNULL,
|
||||||
|
timeout=3,
|
||||||
|
check=True
|
||||||
|
)
|
||||||
|
return True
|
||||||
|
except subprocess.CalledProcessError:
|
||||||
|
return False
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def download(cls, addon: Addon) -> bool:
|
||||||
|
if addon.is_cached():
|
||||||
|
return cls._pull(addon)
|
||||||
|
cls._clone(addon)
|
||||||
|
return True
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def _clone(cls, addon: Addon) -> None:
|
||||||
|
logger.debug("Git clone %s", addon.url)
|
||||||
|
subprocess.call(
|
||||||
|
["git", "clone",
|
||||||
|
*addon.url.replace("#", " -b ").split(), # allows for '<repo>#<branch>' syntax
|
||||||
|
"--depth", "1",
|
||||||
|
"--single-branch",
|
||||||
|
"--quiet"],
|
||||||
|
cwd=str(addon.download_dir)
|
||||||
|
)
|
||||||
|
addon.name = next(x for x in addon.download_dir.iterdir() if x.is_dir()).name
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def _pull(cls, addon: Addon) -> bool:
|
||||||
|
logger.debug("Git pull %s", addon)
|
||||||
|
head = cls._head(addon.dirs[0]) # git doesn't care which AddOn dir, as long as we're in the repo
|
||||||
|
subprocess.run(
|
||||||
|
["git", "pull", "--quiet"],
|
||||||
|
cwd=str(addon.dirs[0])
|
||||||
|
)
|
||||||
|
return head != cls._head(addon.dirs[0])
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def _head(cls, path: Path) -> bytes:
|
||||||
|
p = subprocess.run(
|
||||||
|
["git", "rev-parse", "HEAD"],
|
||||||
|
capture_output=True,
|
||||||
|
cwd=str(path)
|
||||||
|
)
|
||||||
|
return p.stdout
|
||||||
13
wau/providers/github.py
Normal file
13
wau/providers/github.py
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
import re
|
||||||
|
|
||||||
|
from ..addons import Addon
|
||||||
|
|
||||||
|
|
||||||
|
class Provider:
|
||||||
|
@classmethod
|
||||||
|
def is_supported(cls, url: str) -> bool:
|
||||||
|
return bool(re.search("github.com/.*/.*/releases", url, flags=re.IGNORECASE))
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def download(cls, addon: Addon) -> bool:
|
||||||
|
raise NotImplemented
|
||||||
37
wau/providers/web.py
Normal file
37
wau/providers/web.py
Normal file
|
|
@ -0,0 +1,37 @@
|
||||||
|
import logging
|
||||||
|
import urllib.error
|
||||||
|
import urllib.request
|
||||||
|
|
||||||
|
from .base import Provider
|
||||||
|
from .. import http
|
||||||
|
from ..addons import Addon
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
class Web(Provider):
|
||||||
|
user_agent = "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:68.0) Gecko/20100101 Firefox/68.0"
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def is_supported(cls, url: str) -> bool:
|
||||||
|
try:
|
||||||
|
http.open(url).head()
|
||||||
|
return True
|
||||||
|
except (urllib.error.HTTPError, urllib.error.URLError) as e:
|
||||||
|
logger.debug(e)
|
||||||
|
return False
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def download(cls, addon: Addon, url: str = None) -> bool:
|
||||||
|
url = url or addon.url
|
||||||
|
head = http.open(url).head()
|
||||||
|
try:
|
||||||
|
if addon.is_cached() and head["Last-Modified"] == addon.provider_data["Last-Modified"]:
|
||||||
|
return False
|
||||||
|
except KeyError:
|
||||||
|
pass
|
||||||
|
|
||||||
|
addon.create_download_dir(recreate=True) # clean download dir
|
||||||
|
http.download_zip(url, addon.download_dir)
|
||||||
|
addon.provider_data["Last-Modified"] = head.get("Last-Modified")
|
||||||
|
return True
|
||||||
17
wau/providers/wowinterface.py
Normal file
17
wau/providers/wowinterface.py
Normal file
|
|
@ -0,0 +1,17 @@
|
||||||
|
import re
|
||||||
|
|
||||||
|
from .web import Web
|
||||||
|
from ..addons import Addon
|
||||||
|
|
||||||
|
|
||||||
|
class WowInterface(Web):
|
||||||
|
@classmethod
|
||||||
|
def is_supported(cls, url: str) -> bool:
|
||||||
|
return "wowinterface.com/downloads/info" in url
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def download(cls, addon: Addon, url: str = None) -> bool:
|
||||||
|
addon_id, addon_name = re.search(r"info(\d+)-?(.*)", addon.url).groups()
|
||||||
|
if addon_name:
|
||||||
|
addon.name = addon_name.replace(".html", "")
|
||||||
|
return super().download(addon, url=f"https://cdn.wowinterface.com/downloads/file{addon_id}/")
|
||||||
Loading…
Reference in a new issue