diff --git a/.codespellrc b/.codespellrc
new file mode 100644
index 00000000..c4a77996
--- /dev/null
+++ b/.codespellrc
@@ -0,0 +1,6 @@
+[codespell]
+# In the event of a false positive, add the problematic word, in all lowercase, to a comma-separated list here:
+ignore-words-list = ,
+check-filenames =
+check-hidden =
+skip = go.mod,go.sum,./repositories.txt,./.git,./manager/manager,./manager/manager.exe
diff --git a/.editorconfig b/.editorconfig
new file mode 100644
index 00000000..111e989c
--- /dev/null
+++ b/.editorconfig
@@ -0,0 +1,16 @@
+# http://editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.go]
+indent_style = tab
+indent_size = 4
+
+[*.{yml,yaml}]
+indent_style = space
+indent_size = 2
diff --git a/.github/workflows/check-config.yml b/.github/workflows/check-config.yml
new file mode 100644
index 00000000..8de9fb94
--- /dev/null
+++ b/.github/workflows/check-config.yml
@@ -0,0 +1,38 @@
+name: Check configuration files
+
+on:
+ push:
+ paths:
+ - ".github/workflows/check-config.yml"
+ - "Taskfile.yml"
+ - "**.yml"
+ - "**.yaml"
+ - "**.json"
+ pull_request:
+ paths:
+ - ".github/workflows/check-config.yml"
+ - "Taskfile.yml"
+ - "**.yml"
+ - "**.yaml"
+ - "**.json"
+ # See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows#workflow_dispatch
+ workflow_dispatch:
+ # See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows#repository_dispatch
+ repository_dispatch:
+
+jobs:
+ check:
+ runs-on: ubuntu-latest
+
+ steps:
+ - name: Checkout local repository
+ uses: actions/checkout@v2
+
+ - name: Install Taskfile
+ uses: arduino/actions/setup-taskfile@master
+ with:
+ repo-token: ${{ secrets.GITHUB_TOKEN }}
+ version: 3.x
+
+ - name: Check formatting
+ run: task config:check-formatting
diff --git a/.github/workflows/check-docs.yml b/.github/workflows/check-docs.yml
new file mode 100644
index 00000000..581a50a0
--- /dev/null
+++ b/.github/workflows/check-docs.yml
@@ -0,0 +1,37 @@
+name: Check documentation files
+
+on:
+ push:
+ paths:
+ - ".github/workflows/check-docs.yml"
+ - "Taskfile.yml"
+ - "**.md"
+ pull_request:
+ paths:
+ - ".github/workflows/check-docs.yml"
+ - "Taskfile.yml"
+ - "**.md"
+ # See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows#workflow_dispatch
+ workflow_dispatch:
+ # See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows#repository_dispatch
+ repository_dispatch:
+
+jobs:
+ check:
+ runs-on: ubuntu-latest
+
+ steps:
+ - name: Checkout local repository
+ uses: actions/checkout@v2
+
+ - name: Install Taskfile
+ uses: arduino/actions/setup-taskfile@master
+ with:
+ repo-token: ${{ secrets.GITHUB_TOKEN }}
+ version: 3.x
+
+ - name: Check links
+ run: task docs:check-links
+
+ - name: Check formatting
+ run: task docs:check-formatting
diff --git a/.github/workflows/check-go.yml b/.github/workflows/check-go.yml
new file mode 100644
index 00000000..da021d6d
--- /dev/null
+++ b/.github/workflows/check-go.yml
@@ -0,0 +1,45 @@
+name: Check Go code
+
+on:
+ push:
+ paths:
+ - ".github/workflows/check-go.yml"
+ - "Taskfile.yml"
+ - "manager/**"
+ pull_request:
+ paths:
+ - ".github/workflows/check-go.yml"
+ - "Taskfile.yml"
+ - "manager/**"
+ # See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows#workflow_dispatch
+ workflow_dispatch:
+ # See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows#repository_dispatch
+ repository_dispatch:
+
+jobs:
+ check:
+ runs-on: ubuntu-latest
+
+ steps:
+ - name: Checkout local repository
+ uses: actions/checkout@v2
+
+ - name: Install Go
+ uses: actions/setup-go@v2
+ with:
+ go-version: "1.14"
+
+ - name: Install Taskfile
+ uses: arduino/actions/setup-taskfile@master
+ with:
+ repo-token: ${{ secrets.GITHUB_TOKEN }}
+ version: 3.x
+
+ - name: Lint
+ run: task go:lint
+
+ - name: Run tests
+ run: task go:test
+
+ - name: Check formatting
+ run: task go:check-formatting
diff --git a/.github/workflows/check-license.yml b/.github/workflows/check-license.yml
new file mode 100644
index 00000000..60c0cb6a
--- /dev/null
+++ b/.github/workflows/check-license.yml
@@ -0,0 +1,44 @@
+name: Check license
+
+on:
+ push:
+ paths:
+ - ".github/workflows/check-license.yml"
+ - "Taskfile.yml"
+ # Recognized license files. See: https://github.com/licensee/licensee/blob/master/docs/what-we-look-at.md#detecting-the-license-file
+ - "COPYING*"
+ - "LICENCE*"
+ - "LICENSE*"
+ pull_request:
+ paths:
+ - ".github/workflows/check-license.yml"
+ - "Taskfile.yml"
+ # Recognized license files. See: https://github.com/licensee/licensee/blob/master/docs/what-we-look-at.md#detecting-the-license-file
+ - "COPYING*"
+ - "LICENCE*"
+ - "LICENSE*"
+
+jobs:
+ check:
+ runs-on: ubuntu-latest
+
+ steps:
+ - name: Checkout local repository
+ uses: actions/checkout@v2
+
+ - name: Install Taskfile
+ uses: arduino/actions/setup-taskfile@master
+ with:
+ repo-token: ${{ secrets.GITHUB_TOKEN }}
+ version: 3.x
+
+ - uses: ruby/setup-ruby@v1
+ with:
+ ruby-version: ruby # Install latest version
+
+ - name: Install licensee
+ run: gem install licensee
+
+ # See: https://docs.github.com/en/free-pro-team@latest/github/creating-cloning-and-archiving-repositories/licensing-a-repository
+ - name: Check license file
+ run: task --silent docs:check-license
diff --git a/.github/workflows/manage-prs.yml b/.github/workflows/manage-prs.yml
new file mode 100644
index 00000000..a38e9001
--- /dev/null
+++ b/.github/workflows/manage-prs.yml
@@ -0,0 +1,319 @@
+name: Manage PRs
+
+on:
+ # pull_request_target trigger is used instead of pull_request so the token will have the write permissions needed to comment and merge.
+ # Note that this means the version of the workflow from the PR base ref will be used as opposed to the head ref, as is the case with pull_request triggered workflows.
+ # See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows#pull_request_target
+ pull_request_target:
+ types:
+ - opened
+ - ready_for_review
+ - synchronize
+ issue_comment:
+ types:
+ - created
+ - edited
+ # See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows#workflow_dispatch
+ workflow_dispatch:
+ # See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows#repository_dispatch
+ repository_dispatch:
+
+jobs:
+ enabled:
+ if: >
+ github.event_name == 'pull_request_target' ||
+ (
+ github.event_name == 'issue_comment' &&
+ github.event.issue.pull_request != '' &&
+ github.event.issue.state == 'open' &&
+ contains(github.event.comment.body, 'ArduinoBot')
+ )
+ runs-on: ubuntu-latest
+
+ steps:
+ - name: Dummy step to make job valid
+ run: ""
+
+ parse:
+ needs:
+ - enabled
+ runs-on: ubuntu-latest
+
+ outputs:
+ type: ${{ steps.parse-request.outputs.type }}
+ submissions: ${{ steps.parse-request.outputs.submissions }}
+ index-entry: ${{ steps.parse-request.outputs.index-entry }}
+
+ steps:
+ - name: Set environment variables
+ run: |
+ # See: https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-commands-for-github-actions#setting-an-environment-variable
+ echo "MANAGER_PATH=${{ runner.temp }}/manager" >> "$GITHUB_ENV"
+ echo "INDEX_SOURCE_REPOSITORY_CHECKOUT_PATH=bcmi-labs/libraries-repository-engine" >> "$GITHUB_ENV"
+ echo "INDEX_SOURCE_PATH=repositories.txt" >> "$GITHUB_ENV" # Path of the LM index file under its repository.
+
+ - name: Checkout local repository
+ uses: actions/checkout@v2
+
+ - name: Install Go
+ uses: actions/setup-go@v2
+
+ - name: Install Taskfile
+ uses: arduino/actions/setup-taskfile@master
+ with:
+ repo-token: ${{ secrets.GITHUB_TOKEN }}
+ version: 3.x
+
+ # For security reasons, this must be done before checking out the PR branch.
+ - name: Build manager
+ env:
+ GO_BUILD_FLAGS: -o $MANAGER_PATH
+ run: task go:build
+
+ - name: Checkout PR branch
+ run: |
+ # https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/checking-out-pull-requests-locally
+ # It's necessary to reference both pull_request.number and issue.number because only one of the two are defined depending on whether the workflow is triggered by PR or comment event.
+ git fetch origin pull/${{ github.event.pull_request.number }}${{ github.event.issue.number }}/head:pr-branch
+ git checkout pr-branch
+
+ - name: Checkout index source list
+ uses: actions/checkout@v2
+ with:
+ repository: bcmi-labs/libraries-repository-engine
+ ref: production
+ token: ${{ secrets.REPO_SCOPE_TOKEN }}
+ path: ${{ env.INDEX_SOURCE_REPOSITORY_CHECKOUT_PATH }}
+
+ - name: Parse request
+ id: parse-request
+ run: |
+ REQUEST="$("$MANAGER_PATH" --baseref="${{ github.sha }}" --repopath="${{ github.workspace }}" --listname="repositories.txt" --indexsourcepath="${{ env.INDEX_SOURCE_REPOSITORY_CHECKOUT_PATH }}/${{ env.INDEX_SOURCE_PATH }}")"
+ # Due to limitations of the GitHub Actions workflow system, dedicated outputs must be created for use in certain workflow fields.
+ echo "::set-output name=type::$(echo "$REQUEST" | jq -r -c '.type')"
+ echo "::set-output name=submissions::$(echo "$REQUEST" | jq -c '.submissions')"
+ echo "::set-output name=index-entry::$(echo "$REQUEST" | jq -r -c '.indexEntry')"
+
+ label:
+ needs:
+ - enabled
+ - parse
+ runs-on: ubuntu-latest
+
+ steps:
+ - name: Label PR
+ uses: octokit/request-action@v2.x
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ with:
+ route: PUT /repos/{owner}/{repo}/issues/{issue_number}/labels
+ owner: ${{ github.repository_owner }}
+ repo: ${{ github.event.repository.name }}
+ issue_number: ${{ github.event.pull_request.number }}${{ github.event.issue.number }}
+ labels: |
+ - ${{ needs.parse.outputs.type }}
+
+ check-submissions:
+ needs:
+ - enabled
+ - parse
+ if: needs.parse.outputs.type == 'submission'
+ runs-on: ubuntu-latest
+
+ strategy:
+ fail-fast: false
+
+ # A matrix job will run for each of the submission URLs
+ matrix:
+ submission: ${{ fromJson(needs.parse.outputs.submissions) }}
+
+ steps:
+ - name: Set environment variables
+ run: |
+ echo "REPORT_PATH=${{ runner.temp }}/report.json" >> "$GITHUB_ENV"
+
+ - name: Comment on error detected while parsing submission
+ if: matrix.submission.error != ''
+ uses: octokit/request-action@v2.x
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ with:
+ # NOTE: "Unexpected input(s) ..." warnings for the arbitrary octokit/request-action inputs are normal and expected.
+ route: POST /repos/{owner}/{repo}/issues/{issue_number}/comments
+ owner: ${{ github.repository_owner }}
+ repo: ${{ github.event.repository.name }}
+ issue_number: ${{ github.event.pull_request.number }}${{ github.event.issue.number }}
+ body: |
+ |
+ A problem was found with your submission ${{ matrix.submission.submissionURL }}
+
+ ${{ matrix.submission.error }}
+
+ - name: Fail on error detected while parsing
+ if: matrix.submission.error != ''
+ run: |
+ echo "::error::Error found with submission"
+ exit 1
+
+ - name: Clone submission
+ run: git clone --branch ${{ matrix.submission.tag }} --depth 1 ${{ matrix.submission.normalizedURL }} "${{ matrix.submission.name }}"
+
+ - name: Lint submission
+ id: arduino-lint
+ uses: arduino/arduino-lint-action@v1
+ continue-on-error: true # Continue the job so the report can be commented to the PR
+ with:
+ library-manager: submit
+ project-type: library
+ compliance: permissive
+ official: ${{ matrix.submission.official }}
+ path: ${{ matrix.submission.name }}
+ report-file: ${{ env.REPORT_PATH }}
+
+ - name: Read Arduino Lint report
+ id: read-lint-report
+ run: |
+ echo "::set-output name=report::$(jq -c . "${{ env.REPORT_PATH }}")"
+
+ - name: Comment on Arduino Lint warning
+ if: fromJson(steps.read-lint-report.outputs.report).summary.warningCount > 0 && fromJson(steps.read-lint-report.outputs.report).summary.errorCount == 0
+ uses: octokit/request-action@v2.x
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ with:
+ route: POST /repos/{owner}/{repo}/issues/{issue_number}/comments
+ owner: ${{ github.repository_owner }}
+ repo: ${{ github.event.repository.name }}
+ issue_number: ${{ github.event.pull_request.number }}${{ github.event.issue.number }}
+ body: |
+ |
+ [Arduino Lint](https://github.com/arduino/arduino-lint) has suggestions for possible improvements to ${{ matrix.submission.submissionURL }}:
+
+ ```json
+ ${{ toJson(fromJson(steps.read-lint-report.outputs.report).projects) }}
+ ```
+
+ - name: Comment on Arduino Lint error
+ if: fromJson(steps.read-lint-report.outputs.report).summary.errorCount > 0
+ uses: octokit/request-action@v2.x
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ with:
+ route: POST /repos/{owner}/{repo}/issues/{issue_number}/comments
+ owner: ${{ github.repository_owner }}
+ repo: ${{ github.event.repository.name }}
+ issue_number: ${{ github.event.pull_request.number }}${{ github.event.issue.number }}
+ body: |
+ |
+ [Arduino Lint](https://github.com/arduino/arduino-lint) found errors with ${{ matrix.submission.submissionURL }}:
+
+ ```json
+ ${{ toJson(fromJson(steps.read-lint-report.outputs.report).projects) }}
+ ```
+
+ - name: Fail on Arduino Lint error
+ if: steps.arduino-lint.outcome == 'failure'
+ run: |
+ echo "::error::Arduino Lint detected an error"
+ exit 1
+
+ check-submissions-fail:
+ needs:
+ - enabled
+ - check-submissions
+ if: failure() # This job will only run if the submission checks failed
+ runs-on: ubuntu-latest
+
+ steps:
+ - name: Comment instructions to fix errors detected during submission checks
+ uses: octokit/request-action@v2.x
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ with:
+ route: POST /repos/{owner}/{repo}/issues/{issue_number}/comments
+ owner: ${{ github.repository_owner }}
+ repo: ${{ github.event.repository.name }}
+ issue_number: ${{ github.event.pull_request.number }}${{ github.event.issue.number }}
+ body: |
+ |
+ Thanks for your interest in contributing to the Arduino Library Manager index @${{ github.actor }}
+ Please resolve the error(s) mentioned in the previous comment.
+
+ After resolving the issue, trigger this check again by doing one of the following:
+
+ - Commit the required change to the branch you submitted this pull request from.
+ - Comment here, mentioning @ArduinoBot in the comment
+
+ More information: https://github.com/${{ github.repository }}/main/README.md#if-the-problem-is-with-the-pull-request"
+
+ merge:
+ needs:
+ - enabled
+ - parse
+ - check-submissions
+ if: success() # This job will only run if the submission checks passed
+ runs-on: ubuntu-latest
+
+ steps:
+ - name: Merge pull request
+ uses: octokit/request-action@v2.x
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ with:
+ route: PUT /repos/{owner}/{repo}/pulls/{pull_number}/merge
+ owner: ${{ github.repository_owner }}
+ repo: ${{ github.event.repository.name }}
+ pull_number: ${{ github.event.pull_request.number }}${{ github.event.issue.number }}
+
+ - name: Checkout index source file repo
+ uses: actions/checkout@v2
+ with:
+ repository: bcmi-labs/libraries-repository-engine
+ ref: production
+ token: ${{ secrets.REPO_SCOPE_TOKEN }}
+
+ - name: Add entry to index source file
+ run: |
+ INDEX_SOURCE_FILE_PATH="${{ github.workspace }}/repositories.txt"
+ echo "${{ needs.parse.outputs.index-entry }}" >> "$INDEX_SOURCE_FILE_PATH"
+ git config --global user.email "bot@arduino.cc"
+ git config --global user.name "ArduinoBot"
+ git add --update "$INDEX_SOURCE_FILE_PATH"
+ echo -e "Add submission # ${{ github.event.pull_request.number }}${{ github.event.issue.number }}\n\n${{ github.event.repository.html_url }}/pull/${{ github.event.pull_request.number }}${{ github.event.issue.number }}" | git commit --file -
+ git push
+
+ request-review:
+ needs:
+ - enabled
+ - parse
+ if: needs.parse.outputs.type != 'submission' # These request types can't be automatically approved.
+ runs-on: ubuntu-latest
+
+ steps:
+ - name: Request pull request review
+ uses: octokit/request-action@v2.x
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ with:
+ route: POST /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers
+ owner: ${{ github.repository_owner }}
+ repo: ${{ github.event.repository.name }}
+ pull_number: ${{ github.event.pull_request.number }}${{ github.event.issue.number }}
+ team_reviewers: |
+ - arduino/team_tooling
+
+ - name: Comment on required review
+ uses: octokit/request-action@v2.x
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ with:
+ route: POST /repos/{owner}/{repo}/issues/{issue_number}/comments
+ owner: ${{ github.repository_owner }}
+ repo: ${{ github.event.repository.name }}
+ issue_number: ${{ github.event.pull_request.number }}${{ github.event.issue.number }}
+ body: |
+ |
+ Hi @${{ github.actor }}. Your pull request has been detected as something other than a Library Manager submission. A maintainer will need to review it before it can be merged.
+
+ If you intended to submit a library, please check the instructions and update your pull request if necessary:
+ https://github.com/${{ github.repository }}/main/README.md#instructions
diff --git a/.github/workflows/spell-check.yml b/.github/workflows/spell-check.yml
new file mode 100644
index 00000000..176c4194
--- /dev/null
+++ b/.github/workflows/spell-check.yml
@@ -0,0 +1,37 @@
+name: Spell Check
+
+on:
+ pull_request:
+ paths-ignore:
+ - "repositories.txt"
+ push:
+ paths-ignore:
+ - "repositories.txt"
+ schedule:
+ # Run every Tuesday at 03:00 UTC to catch breakage caused by updates to the dictionary
+ - cron: "0 3 * * 2"
+
+jobs:
+ spellcheck:
+ runs-on: ubuntu-latest
+
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v2
+
+ - name: Install Python
+ uses: actions/setup-python@v2
+ with:
+ python-version: "3.8"
+
+ - name: Install Poetry
+ run: pip install poetry
+
+ - name: Install Taskfile
+ uses: arduino/actions/setup-taskfile@master
+ with:
+ repo-token: ${{ secrets.GITHUB_TOKEN }}
+ version: 3.x
+
+ - name: Spell check
+ run: task check-spelling
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 00000000..b573f51c
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,13 @@
+# Build artifacts
+/manager/manager
+/manager/manager.exe
+
+# Test artifacts
+coverage_unit.txt
+
+# IDEs
+.idea/
+.vscode/
+*.bak
+*.code-workspace
+*.sublime-workspace
diff --git a/.prettierrc b/.prettierrc
new file mode 100644
index 00000000..2703167c
--- /dev/null
+++ b/.prettierrc
@@ -0,0 +1,12 @@
+{
+ "semi": false,
+ "printWidth": 120,
+ "overrides": [
+ {
+ "files": "*.md",
+ "options": {
+ "proseWrap": "always"
+ }
+ }
+ ]
+}
diff --git a/LICENSE.txt b/LICENSE.txt
new file mode 100644
index 00000000..f288702d
--- /dev/null
+++ b/LICENSE.txt
@@ -0,0 +1,674 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc.
+ 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.
+
+
+ Copyright (C)
+
+ 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 .
+
+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:
+
+ Copyright (C)
+ 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
+.
+
+ 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
+.
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..35f319a0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,82 @@
+# Arduino Library Manager list
+
+This repository contains the list of libraries in the
+[Arduino Library Manager](https://www.arduino.cc/en/guide/libraries#toc3) index.
+
+## Adding a library to Library Manager
+
+If you would like to have your library available for installation via Library Manager, just submit a
+[pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) that
+adds the repository URL to [the list](repositories.txt). You are welcome to add multiple libraries at once.
+
+See the instructions below for detailed instructions on how to do this via the GitHub web interface.
+
+### Instructions
+
+1. You may want to first take a look at
+ [the requirements for admission into the Arduino Library Manager index](https://github.com/arduino/Arduino/wiki/Library-Manager-FAQ).
+ Each submission will be checked for compliance before being accepted.
+1. Open this link to [fork](https://guides.github.com/activities/forking/) this repository and edit the list via the
+ GitHub web interface: https://github.com/arduino/library-manager-list/edit/main/repositories.txt
+1. Add the library repository's URL to the list. This should be the URL of the repository home page. For example:
+ `https://github.com/arduino-libraries/Servo`.
+1. At the bottom of the page, select the radio button next to "Create a new branch for this commit and start a pull
+ request."
+1. Click the "Propose changes" button.
+1. In the "Open a pull request" window that opens, click the "Create pull request" button.
+
+The library will be automatically checked for compliance as soon as the pull request is submitted. If no problems were
+found, the pull request will be immediately merged and the library will be available for installation via Library
+Manager within a day's time.
+
+If any problems are found, a bot will comment on the pull request to tell you what is wrong. The problem may be either
+with your pull request or with the library.
+
+#### If the problem is with the pull request:
+
+Edit the file in the
+[branch](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-branches) you submitted the
+pull request from in your fork of the `arduino/library-manager-list` repository, then commit.
+
+Doing this will update the pull request and cause the automated checks to run again.
+
+#### If the problem is with the library:
+
+1. Make the necessary fix in the library repository.
+1. Increment the `version` value in the library's
+ [library.properties file](https://arduino.github.io/arduino-cli/latest/library-specification/#library-metadata).
+1. Create a [release](https://docs.github.com/en/github/administering-a-repository/managing-releases-in-a-repository) or
+ [tag](https://git-scm.com/docs/git-tag). The Library Manager index always uses tagged versions of the libraries, so
+ even if the development version of the library is compliant, it can't be accepted until the latest release or tag is
+ compliant. Alternatively, you can redo the existing release/tag if you prefer.
+1. Comment on your pull request here in the `arduino/library-manager-list` repository, mentioning **@ArduinoBot** in the
+ comment. Doing this will cause the automated check to run again.
+
+## Changing the URL of a library already in Library Manager
+
+Submit a pull request that changes the URL as desired in [repositories.txt](repositories.txt). This can be done by
+following [the instructions above](#instructions).
+
+Since this type of request must be reviewed by a human maintainer, please write an explanation in the pull request
+description, making it clear that the URL is intentionally being changed.
+
+## Removing the URL of a library already in Library Manager
+
+Submit a pull request that removes the URL from [repositories.txt](repositories.txt). This can be done by following
+[the instructions above](#instructions).
+
+Since this type of request must be reviewed by a human maintainer, please write an explanation in the pull request
+description, making it clear that the URL is intentionally being removed.
+
+## Report a problem with Library Manager
+
+Please first take a look at
+[the Arduino Library Manager FAQ](https://github.com/arduino/Arduino/wiki/Library-Manager-FAQ). If a library release is
+missing from Library Manager, it is usually because it was not compliant with all the requirements listed in that
+document.
+
+This repository is not an appropriate place to request support or report problems with a library. Check the library's
+own documentation for instructions or ask on the [Arduino Forum](https://forum.arduino.cc/).
+
+If the problem is about something else, please make an issue report here:
+https://github.com/arduino/library-manager-list/issues?q=is%3Aissue
diff --git a/Taskfile.yml b/Taskfile.yml
new file mode 100644
index 00000000..2d37769b
--- /dev/null
+++ b/Taskfile.yml
@@ -0,0 +1,148 @@
+version: "3"
+
+vars:
+ DEFAULT_GO_PACKAGES:
+ sh: echo `cd manager && go list ./... | tr '\n' ' '`
+ DEFAULT_GO_PATHS:
+ sh: echo '`cd manager && go list -f '{{"{{"}}.Dir{{"}}"}}' ./...`'
+
+ PRETTIER: prettier@2.1.2
+
+tasks:
+ go:build:
+ desc: Build the project
+ dir: manager
+ cmds:
+ - go build -v {{.GO_BUILD_FLAGS}}
+
+ check:
+ desc: Test, lint, and check formatting of everything
+ deps:
+ - task: go:check
+ - task: docs:check
+ - task: config:check
+
+ go:check:
+ desc: Test, lint, and check formatting of Go code
+ deps:
+ - task: go:lint
+ - task: go:test
+ - task: go:check-formatting
+
+ go:lint:
+ desc: Lint Go code
+ dir: manager
+ cmds:
+ - go vet {{default .DEFAULT_GO_PACKAGES .GO_PACKAGES}}
+ - go get golang.org/x/lint/golint
+ - |
+ GOLINT_PATH="$(go list -f '{{"{{"}}.Target{{"}}"}}' golang.org/x/lint/golint || echo "false")"
+ "$GOLINT_PATH" {{default "-min_confidence 0.8 -set_exit_status" .GO_LINT_FLAGS}} "{{default .DEFAULT_GO_PACKAGES .GO_PACKAGES}}"
+
+ go:test:
+ desc: Run unit tests
+ dir: manager
+ cmds:
+ - go test -v -short -run '{{default ".*" .GO_TEST_REGEX}}' {{default "-timeout 10m -coverpkg=./... -covermode=atomic" .GO_TEST_FLAGS}} -coverprofile=coverage_unit.txt {{default .DEFAULT_GO_PACKAGES .GO_PACKAGES}}
+
+ go:check-formatting:
+ desc: Check Go code formatting
+ dir: manager
+ cmds:
+ - |
+ RESULTS="$(gofmt -l {{default .DEFAULT_GO_PATHS .GO_PATHS}})"
+ echo "$RESULTS"
+ test -z "$RESULTS"
+
+ docs:check:
+ desc: Lint and check formatting of documentation files
+ deps:
+ - task: docs:check-license
+ - task: docs:check-links
+ - task: docs:check-formatting
+ - task: check-spelling
+
+ docs:check-license:
+ desc: Check if the license file is correctly formatted
+ cmds:
+ - |
+ EXPECTED_LICENSE_FILE="\"LICENSE.txt\""
+ EXPECTED_LICENSE_TYPE="\"GPL-3.0\"" # https://spdx.org/licenses/
+
+ # See: https://github.com/licensee/licensee
+ LICENSEE_OUTPUT="$(licensee detect --json --confidence=100)"
+
+ DETECTED_LICENSE_FILE="$(echo "$LICENSEE_OUTPUT" | jq .matched_files[0].filename | tr --delete '\r')"
+ echo "Detected license file: $DETECTED_LICENSE_FILE"
+ if [ "$DETECTED_LICENSE_FILE" != "$EXPECTED_LICENSE_FILE" ]; then
+ echo "ERROR: detected license file doesn't match expected: $EXPECTED_LICENSE_FILE"
+ exit 1
+ fi
+
+ DETECTED_LICENSE_TYPE="$(echo "$LICENSEE_OUTPUT" | jq .matched_files[0].matched_license | tr --delete '\r')"
+ echo "Detected license type: $DETECTED_LICENSE_TYPE"
+ if [ "$DETECTED_LICENSE_TYPE" != "$EXPECTED_LICENSE_TYPE" ]; then
+ echo "ERROR: detected license type doesn't match expected $EXPECTED_LICENSE_TYPE"
+ exit 1
+ fi
+
+ docs:check-links:
+ desc: Check for dead links in documentation
+ cmds:
+ - |
+ npx --package markdown-link-check --call '
+ STATUS=0
+ for file in $(find -name "*.md"); do
+ markdown-link-check --quiet "$file"
+ STATUS=$(( $STATUS + $? ))
+ done
+ exit $STATUS'
+
+ docs:check-formatting:
+ desc: Check formatting of documentation files
+ cmds:
+ - npx {{.PRETTIER}} --check "**/*.md"
+
+ check-spelling:
+ desc: Check for commonly misspelled words
+ cmds:
+ - poetry install --no-root
+ - poetry run codespell {{.CODESPELL_SKIP_OPTION}} {{.CODESPELL_IGNORE_WORDS_OPTION}}
+
+ config:check:
+ desc: Lint and check formatting of configuration files
+ deps:
+ - task: config:check-formatting
+
+ config:check-formatting:
+ desc: Check formatting of configuration files
+ cmds:
+ - npx {{.PRETTIER}} --check "**/*.{yml,yaml,json}"
+
+ format:
+ desc: Format all files
+ deps:
+ - task: go:format
+ - task: docs:format
+ - task: config:format
+
+ go:format:
+ desc: Format Go code
+ cmds:
+ - gofmt -l -w {{default .DEFAULT_GO_PATHS .GO_PATHS}}
+
+ docs:format:
+ desc: Format documentation files
+ cmds:
+ - npx {{.PRETTIER}} --write "**/*.md"
+
+ config:format:
+ desc: Format configuration files
+ cmds:
+ - npx {{.PRETTIER}} --write "**/*.{yml,yaml,json}"
+
+ correct-spelling:
+ desc: Correct commonly misspelled words where possible
+ cmds:
+ - poetry install --no-root
+ - poetry run codespell --write-changes {{.CODESPELL_SKIP_OPTION}} {{.CODESPELL_IGNORE_WORDS_OPTION}}
diff --git a/manager/go.mod b/manager/go.mod
new file mode 100644
index 00000000..970a19f0
--- /dev/null
+++ b/manager/go.mod
@@ -0,0 +1,10 @@
+module github.com/arduino/library-manager-list/manager
+
+go 1.14
+
+require (
+ github.com/arduino/go-paths-helper v1.5.0
+ github.com/arduino/go-properties-orderedmap v1.4.0
+ github.com/sourcegraph/go-diff v0.6.1
+ github.com/stretchr/testify v1.3.0
+)
diff --git a/manager/go.sum b/manager/go.sum
new file mode 100644
index 00000000..1869338c
--- /dev/null
+++ b/manager/go.sum
@@ -0,0 +1,22 @@
+github.com/arduino/go-paths-helper v1.0.1/go.mod h1:HpxtKph+g238EJHq4geEPv9p+gl3v5YYu35Yb+w31Ck=
+github.com/arduino/go-paths-helper v1.5.0 h1:RVo189hD+GhUS1rQ3gixwK1nSbvVR8MGIGa7Gxv2bdM=
+github.com/arduino/go-paths-helper v1.5.0/go.mod h1:V82BWgAAp4IbmlybxQdk9Bpkz8M4Qyx+RAFKaG9NuvU=
+github.com/arduino/go-properties-orderedmap v1.4.0 h1:YEbbzPqm1gXWDM/Jaq8tlvmh09z2qeHPJTUw9/VA4Dk=
+github.com/arduino/go-properties-orderedmap v1.4.0/go.mod h1:DKjD2VXY/NZmlingh4lSFMEYCVubfeArCsGPGDwb2yk=
+github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
+github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/google/go-cmp v0.5.2 h1:X2ev0eStA3AbceY54o37/0PQ/UWqKEiiO2dKL5OPaFM=
+github.com/google/go-cmp v0.5.2/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
+github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4=
+github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/shurcooL/go v0.0.0-20180423040247-9e1955d9fb6e/go.mod h1:TDJrrUr11Vxrven61rcy3hJMUqaf/CLWYhHNPmT14Lk=
+github.com/shurcooL/go-goon v0.0.0-20170922171312-37c2f522c041/go.mod h1:N5mDOmsrJOB+vfqUK+7DmDyjhSLIIBnXo9lvZJj3MWQ=
+github.com/sourcegraph/go-diff v0.6.1 h1:hmA1LzxW0n1c3Q4YbrFgg4P99GSnebYa3x8gr0HZqLQ=
+github.com/sourcegraph/go-diff v0.6.1/go.mod h1:iBszgVvyxdc8SFZ7gm69go2KDdt3ag071iBaWPF6cjs=
+github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/testify v1.3.0 h1:TivCn/peBQ7UY8ooIcPgZFpTNSz0Q2U6UrFlUfqbe0Q=
+github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
+golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543 h1:E7g+9GITq07hpfrRu66IVDexMakfv52eLZ2CXBWiKr4=
+golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
diff --git a/manager/main.go b/manager/main.go
new file mode 100644
index 00000000..45852c31
--- /dev/null
+++ b/manager/main.go
@@ -0,0 +1,391 @@
+// Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
+//
+// This software is released under the GNU General Public License version 3.
+// The terms of this license can be found at:
+// https://www.gnu.org/licenses/gpl-3.0.en.html
+//
+// You can be released from the requirements of the above licenses by purchasing
+// a commercial license. Buying such a license is mandatory if you want to
+// modify or otherwise use the software for commercial activities involving the
+// Arduino software without disclosing the source code of your own applications.
+// To purchase a commercial license, send an email to license@arduino.cc.
+
+package main
+
+import (
+ "bytes"
+ "encoding/json"
+ "flag"
+ "fmt"
+ "io"
+ "net/http"
+ "net/url"
+ "os"
+ "os/exec"
+ "strings"
+
+ "github.com/sourcegraph/go-diff/diff"
+
+ "github.com/arduino/go-paths-helper"
+ properties "github.com/arduino/go-properties-orderedmap"
+)
+
+// Git hosts that are supported for library repositories.
+var supportedHosts []string = []string{
+ "bitbucket.org",
+ "github.com",
+ "gitlab.com",
+}
+
+// Libraries under these organizations will have the "Arduino" type and be linted with Arduino Lint in the "official" setting.
+var officialOrganizations []string = []string{
+ "github.com/arduino",
+ "github.com/arduino-libraries",
+ "github.com/bcmi-labs",
+ "github.com/vidor-libraries",
+}
+
+// Libraries under these organizations will have the "Partner" type.
+var partnerOrganizations []string = []string{
+ "github.com/Azure",
+ "github.com/ms-iot",
+ "github.com/ameltech",
+}
+
+// Libraries under these organizations will have the "Recommended" type.
+var recommendedOrganizations []string = []string{
+ "github.com/adafruit",
+}
+
+// requestType is the type of the request data.
+type requestType struct {
+ Type string `json:"type"` // Request type.
+ Submissions []submissionType `json:"submissions"` // Data for submitted libraries.
+ IndexEntry string `json:"indexEntry"` // Entry that will be made to the Library Manager index source file when the submission is accepted.
+}
+
+// submissionType is the type of the data for each individual library submitted in the request.
+type submissionType struct {
+ SubmissionURL string `json:"submissionURL"` // Library repository URL as submitted by user. Used to identify the submission to the user.
+ NormalizedURL string `json:"normalizedURL"` // Submission URL in the standardized format that will be used in the index entry.
+ Name string `json:"name"` // Library name.
+ Official bool `json:"official"` // Whether the library is official.
+ Tag string `json:"tag"` // Name of the submission repository's latest tag, which is used as the basis for the index entry and validation.
+ Error string `json:"error"` // Error message.
+}
+
+// Command line flags.
+var baseRef = flag.String("baseref", "", "")
+var repoPath = flag.String("repopath", "", "")
+var listName = flag.String("listname", "", "")
+var indexSourcePath = flag.String("indexsourcepath", "", "")
+
+func main() {
+ // Validate flag input.
+ flag.Parse()
+
+ if *baseRef == "" {
+ errorExit("--baseref flag is required")
+ }
+
+ if *repoPath == "" {
+ errorExit("--repopath flag is required")
+ }
+
+ if *listName == "" {
+ errorExit("--listname flag is required")
+ }
+
+ listPath := paths.New(*repoPath, *listName)
+ exist, err := listPath.ExistCheck()
+ if err != nil {
+ panic(err)
+ }
+ if !exist {
+ errorExit(fmt.Sprintf("list file %s not found", listPath))
+ }
+
+ if *indexSourcePath == "" {
+ errorExit("--indexsourcepath flag is required")
+ }
+
+ indexSourcePath := paths.New(*indexSourcePath)
+ exist, err = indexSourcePath.ExistCheck()
+ if err != nil {
+ panic(err)
+ }
+ if !exist {
+ errorExit(fmt.Sprintf("index source file %s not found", indexSourcePath))
+ }
+
+ // Get the PR diff.
+ err = os.Chdir(*repoPath)
+ if err != nil {
+ panic(err)
+ }
+
+ rawDiff, err := exec.Command("git", "diff", "--unified=0", "--ignore-blank-lines", "--ignore-space-at-eol", *baseRef).Output()
+ if err != nil {
+ panic(err)
+ }
+
+ // Parse the PR diff.
+ var request requestType
+ var submissionURLs []string
+ request.Type, submissionURLs = parseDiff(rawDiff, *listName)
+
+ // Process the submissions.
+ var indexEntries []string
+ for _, submissionURL := range submissionURLs {
+ submission, indexEntry := populateSubmission(submissionURL, indexSourcePath)
+ request.Submissions = append(request.Submissions, submission)
+ indexEntries = append(indexEntries, indexEntry)
+ }
+
+ // Assemble the index entry for the submissions.
+ request.IndexEntry = strings.Join(indexEntries, "%0A")
+
+ // Marshal the request data into a JSON document.
+ var marshalledRequest bytes.Buffer
+ jsonEncoder := json.NewEncoder(io.Writer(&marshalledRequest))
+ // By default, the json package HTML-sanitizes strings during marshalling (https://golang.org/pkg/encoding/json/#Marshal)
+ // It's not possible to change this behavior when using the simple json.MarshalIndent() approach.
+ jsonEncoder.SetEscapeHTML(false)
+ jsonEncoder.SetIndent("", "") // Single line.
+ err = jsonEncoder.Encode(request)
+ if err != nil {
+ panic(err)
+ }
+
+ fmt.Println(marshalledRequest.String())
+}
+
+// errorExit prints the error message in a standardized format and exits with status 1.
+func errorExit(message string) {
+ fmt.Printf("ERROR: %s\n", message)
+ os.Exit(1)
+}
+
+// parseDiff parses the request diff and returns the request type and list of submission URLs.
+func parseDiff(rawDiff []byte, listName string) (string, []string) {
+ var submissionURLs []string
+
+ diffs, err := diff.ParseMultiFileDiff(rawDiff)
+ if err != nil {
+ panic(err)
+ }
+
+ if (len(diffs) != 1) || (diffs[0].OrigName[2:] != listName) || (diffs[0].OrigName[2:] != diffs[0].NewName[2:]) { // Git diffs have a a/ or b/ prefix on file names.
+ // This is not a Library Manager submission.
+ return "other", nil
+ }
+
+ var addedCount int
+ var deletedCount int
+ // Get the added URLs from the diff
+ for _, hunk := range diffs[0].Hunks {
+ hunkBody := string(hunk.Body)
+ for _, rawDiffLine := range strings.Split(hunkBody, "\n") {
+ diffLine := strings.TrimRight(rawDiffLine, " \t")
+ if len(diffLine) < 2 {
+ continue // Ignore blank lines.
+ }
+
+ switch diffLine[0] {
+ case '+':
+ addedCount++
+ submissionURLs = append(submissionURLs, strings.TrimSpace(diffLine[1:]))
+ case '-':
+ deletedCount++
+ default:
+ continue
+ }
+ }
+ }
+
+ var requestType string
+ if addedCount > 0 && deletedCount == 0 {
+ requestType = "submission"
+ } else if addedCount == 0 && deletedCount > 0 {
+ requestType = "removal"
+ } else {
+ requestType = "modification"
+ }
+
+ return requestType, submissionURLs
+}
+
+// populateSubmission does the checks on the submission that aren't provided by Arduino Lint and gathers the necessary data on it.
+func populateSubmission(submissionURL string, indexSourcePath *paths.Path) (submissionType, string) {
+ indexSourceSeparator := "|"
+ var submission submissionType
+
+ submission.SubmissionURL = submissionURL
+
+ // Normalize and validate submission URL.
+ submissionURLObject, err := url.Parse(submission.SubmissionURL)
+ if err != nil {
+ submission.Error = fmt.Sprintf("Invalid submission URL (%s)", err)
+ return submission, ""
+ }
+
+ // Check if URL is accessible.
+ httpResponse, err := http.Get(submissionURLObject.String())
+ if err != nil {
+ submission.Error = fmt.Sprintf("Unable to load submission URL: %s", err)
+ return submission, ""
+ }
+ if httpResponse.StatusCode != http.StatusOK {
+ submission.Error = "Unable to load submission URL. Is the repository public?"
+ return submission, ""
+ }
+
+ // Resolve redirects and normalize.
+ normalizedURLObject, err := normalizeURL(httpResponse.Request.URL)
+ if err != nil {
+ submission.Error = err.Error()
+ return submission, ""
+ }
+
+ submission.NormalizedURL = normalizedURLObject.String()
+
+ // Check if URL is from a supported Git host.
+ if !uRLIsUnder(normalizedURLObject, supportedHosts) {
+ submission.Error = normalizedURLObject.Host + " is not currently supported as a Git hosting website for Library Manager.%0ASee: https://github.com/arduino/Arduino/wiki/Library-Manager-FAQ#how-can-i-add-my-library-to-library-manager"
+ return submission, ""
+ }
+
+ // Check if the URL is already in the index.
+ indexSourceLines, err := indexSourcePath.ReadFileAsLines()
+ for _, indexSourceLine := range indexSourceLines {
+ if strings.HasPrefix(indexSourceLine, fmt.Sprintf("%s%s", normalizedURLObject.String(), indexSourceSeparator)) {
+ submission.Error = "Submission URL is already in the Library Manager index."
+ return submission, ""
+ }
+ }
+
+ // Determine the library types attributes.
+ submission.Official = uRLIsUnder(normalizedURLObject, officialOrganizations)
+ var types []string
+ if submission.Official {
+ types = append(types, "Arduino")
+ }
+ if uRLIsUnder(normalizedURLObject, partnerOrganizations) {
+ types = append(types, "Partner")
+ }
+ if uRLIsUnder(normalizedURLObject, recommendedOrganizations) {
+ types = append(types, "Recommended")
+ }
+ if types == nil {
+ types = append(types, "Contributed")
+ }
+
+ submissionClonePath, err := paths.MkTempDir("", "")
+ if err != nil {
+ panic(err)
+ }
+
+ err = exec.Command("git", "clone", "--depth", "1", normalizedURLObject.String(), submissionClonePath.String()).Run()
+ if err != nil {
+ panic(err)
+ }
+
+ // Determine latest tag name in submission repo
+ err = os.Chdir(submissionClonePath.String())
+ if err != nil {
+ panic(err)
+ }
+ err = exec.Command("git", "fetch", "--tags").Run()
+ if err != nil {
+ panic(err)
+ }
+ tagList, err := exec.Command("git", "rev-list", "--tags", "--max-count=1").Output()
+ if err != nil {
+ panic(err)
+ }
+ if string(tagList) == "" {
+ submission.Error = "The repository has no tags. You need to create a [release](https://docs.github.com/en/github/administering-a-repository/managing-releases-in-a-repository) or [tag](https://git-scm.com/docs/git-tag) that matches the `version` value in the library's library.properties file."
+ return submission, ""
+ }
+ latestTag, err := exec.Command("git", "describe", "--tags", strings.TrimSpace(string(tagList))).Output()
+ if err != nil {
+ panic(err)
+ }
+ submission.Tag = strings.TrimSpace(string(latestTag))
+
+ // Checkout latest tag.
+ err = exec.Command("git", "checkout", submission.Tag).Run()
+ if err != nil {
+ panic(err)
+ }
+
+ // Get submission library name. It is necessary to record this in the index source entry because the library is locked to this name.
+ libraryPropertiesPath := submissionClonePath.Join("library.properties")
+ if !libraryPropertiesPath.Exist() {
+ submission.Error = "Library is missing a library.properties metadata file."
+ return submission, ""
+ }
+ libraryProperties, err := properties.LoadFromPath(libraryPropertiesPath)
+ if err != nil {
+ submission.Error = fmt.Sprintf("Invalid library.properties file (%s)", err)
+ return submission, ""
+ }
+ var ok bool
+ submission.Name, ok = libraryProperties.GetOk("name")
+ if !ok {
+ submission.Error = "library.properties is missing a name field"
+ return submission, ""
+ }
+
+ // Assemble Library Manager index source entry string
+ indexEntry := strings.Join(
+ []string{
+ submission.NormalizedURL,
+ strings.Join(types, ","),
+ submission.Name,
+ },
+ indexSourceSeparator,
+ )
+
+ return submission, indexEntry
+}
+
+// normalizeURL converts the URL into the standardized format used in the index.
+func normalizeURL(rawURL *url.URL) (url.URL, error) {
+ normalizedPath := strings.TrimRight(rawURL.Path, "/")
+ if !strings.HasSuffix(normalizedPath, ".git") {
+ normalizedPath += ".git"
+ }
+ if len(strings.Split(normalizedPath, "/")) != 3 {
+ return url.URL{}, fmt.Errorf("Submission URL must point to the root of the repository")
+ }
+
+ return url.URL{
+ Scheme: "https",
+ Host: rawURL.Host,
+ Path: normalizedPath,
+ },
+ nil
+}
+
+func uRLIsUnder(childURL url.URL, parentCandidates []string) bool {
+ for _, parentCandidate := range parentCandidates {
+ if !strings.HasSuffix(parentCandidate, "/") {
+ parentCandidate += "/"
+ }
+ parentCandidateURL, err := url.Parse("https://" + parentCandidate)
+ if err != nil {
+ panic(err)
+ }
+
+ isUnderPath, err := paths.New(childURL.Path).IsInsideDir(paths.New(parentCandidateURL.Path))
+ if err != nil {
+ panic(err)
+ }
+ if (childURL.Host == parentCandidateURL.Host) && isUnderPath {
+ return true
+ }
+ }
+
+ return false
+}
diff --git a/manager/main_test.go b/manager/main_test.go
new file mode 100644
index 00000000..5e2b68a8
--- /dev/null
+++ b/manager/main_test.go
@@ -0,0 +1,204 @@
+// Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
+//
+// This software is released under the GNU General Public License version 3.
+// The terms of this license can be found at:
+// https://www.gnu.org/licenses/gpl-3.0.en.html
+//
+// You can be released from the requirements of the above licenses by purchasing
+// a commercial license. Buying such a license is mandatory if you want to
+// modify or otherwise use the software for commercial activities involving the
+// Arduino software without disclosing the source code of your own applications.
+// To purchase a commercial license, send an email to license@arduino.cc.
+
+package main
+
+import (
+ "fmt"
+ "net/url"
+ "testing"
+
+ "github.com/stretchr/testify/assert"
+ "github.com/stretchr/testify/require"
+)
+
+func Test_parseDiff(t *testing.T) {
+ testName := "Multiple files"
+ diff := []byte(`
+diff --git a/README.md b/README.md
+index d4edde0..807b76d 100644
+--- a/README.md
++++ b/README.md
+@@ -1,0 +2 @@
++hello
+diff --git a/repositories.txt b/repositories.txt
+index cff484d..e14c179 100644
+--- a/repositories.txt
++++ b/repositories.txt
+@@ -8,0 +9 @@ https://github.com/arduino-libraries/Ethernet
++https://github.com/foo/bar
+`)
+
+ requestType, submissionURLs := parseDiff(diff, "repositories.txt")
+ assert.Equal(t, "other", requestType, testName)
+ assert.Nil(t, submissionURLs, testName)
+
+ testName = "Not list"
+ diff = []byte(`
+diff --git a/README.md b/README.md
+index d4edde0..807b76d 100644
+--- a/README.md
++++ b/README.md
+@@ -1 +1,2 @@
+ # Arduino Library Manager list
++hello
+`)
+
+ requestType, submissionURLs = parseDiff(diff, "repositories.txt")
+ assert.Equal(t, "other", requestType, testName)
+ assert.Nil(t, submissionURLs, testName)
+
+ testName = "List filename change"
+ diff = []byte(`
+diff --git a/repositories.txt b/foobar.txt
+similarity index 99%
+rename from repositories.txt
+rename to foobar.txt
+index cff484d..e14c179 100644
+--- a/repositories.txt
++++ b/foobar.txt
+@@ -8,0 +9 @@ https://github.com/arduino-libraries/Ethernet
++https://github.com/foo/bar
+`)
+
+ requestType, submissionURLs = parseDiff(diff, "repositories.txt")
+ assert.Equal(t, "other", requestType, testName)
+ assert.Nil(t, submissionURLs, testName)
+
+ testName = "Submission"
+ diff = []byte(`
+diff --git a/repositories.txt b/repositories.txt
+index cff484d..9f67763 100644
+--- a/repositories.txt
++++ b/repositories.txt
+@@ -8,0 +9,2 @@ https://github.com/arduino-libraries/Ethernet
++https://github.com/foo/bar
++https://github.com/foo/baz
+`)
+
+ requestType, submissionURLs = parseDiff(diff, "repositories.txt")
+ assert.Equal(t, "submission", requestType, testName)
+ assert.ElementsMatch(t, submissionURLs, []string{"https://github.com/foo/bar", "https://github.com/foo/baz"}, testName)
+
+ testName = "Submission w/ no newline at end of file"
+ diff = []byte(`
+diff --git a/repositories.txt b/repositories.txt
+index cff484d..1b0b80b 100644
+--- a/repositories.txt
++++ b/repositories.txt
+@@ -3391,0 +3392 @@ https://github.com/lbernstone/plotutils
++https://github.com/foo/bar
+\ No newline at end of file
+`)
+
+ requestType, submissionURLs = parseDiff(diff, "repositories.txt")
+ assert.Equal(t, "submission", requestType, testName)
+ assert.ElementsMatch(t, submissionURLs, []string{"https://github.com/foo/bar"}, testName)
+
+ testName = "Submission w/ blank line"
+ diff = []byte(`
+diff --git a/repositories.txt b/repositories.txt
+index cff484d..1b0b80b 100644
+--- a/repositories.txt
++++ b/repositories.txt
+@@ -3391,0 +3392 @@ https://github.com/lbernstone/plotutils
++https://github.com/foo/bar
+\ No newline at end of file
+`)
+
+ requestType, submissionURLs = parseDiff(diff, "repositories.txt")
+ assert.Equal(t, "submission", requestType, testName)
+ assert.ElementsMatch(t, submissionURLs, []string{"https://github.com/foo/bar"}, testName)
+
+ testName = "Removal"
+ diff = []byte(`
+diff --git a/repositories.txt b/repositories.txt
+index cff484d..38e11d8 100644
+--- a/repositories.txt
++++ b/repositories.txt
+@@ -8 +7,0 @@ https://github.com/firmata/arduino
+-https://github.com/arduino-libraries/Ethernet
+`)
+
+ requestType, submissionURLs = parseDiff(diff, "repositories.txt")
+ assert.Equal(t, "removal", requestType, testName)
+ assert.Nil(t, submissionURLs, testName)
+
+ testName = "Modification"
+ diff = []byte(`
+diff --git a/repositories.txt b/repositories.txt
+index cff484d..8b401a1 100644
+--- a/repositories.txt
++++ b/repositories.txt
+@@ -8 +8 @@ https://github.com/firmata/arduino
+-https://github.com/arduino-libraries/Ethernet
++https://github.com/foo/bar
+`)
+
+ requestType, submissionURLs = parseDiff(diff, "repositories.txt")
+ assert.Equal(t, "modification", requestType, testName)
+ assert.Equal(t, submissionURLs, []string{"https://github.com/foo/bar"}, testName)
+}
+
+func Test_normalizeURL(t *testing.T) {
+ testTables := []struct {
+ testName string
+ rawURL string
+ expectedNormalizedURL string
+ expectedError string
+ }{
+ {"Trailing slash", "https://github.com/foo/bar/", "https://github.com/foo/bar.git", ""},
+ {".git suffix", "https://github.com/foo/bar.git", "https://github.com/foo/bar.git", ""},
+ {"Too few path elements", "https://github.com/foo", "", "Submission URL must point to the root of the repository"},
+ {"Too many path elements", "https://github.com/foo/bar/baz", "", "Submission URL must point to the root of the repository"},
+ {"http://", "http://github.com/foo/bar", "https://github.com/foo/bar.git", ""},
+ {"git://", "git://github.com/foo/bar", "https://github.com/foo/bar.git", ""},
+ }
+
+ for _, testTable := range testTables {
+ rawURL, err := url.Parse(testTable.rawURL)
+ require.Nil(t, err)
+ expectedNormalizedURL, err := url.Parse(testTable.expectedNormalizedURL)
+ require.Nil(t, err)
+
+ normalizedURL, err := normalizeURL(rawURL)
+ assert.Equal(t, *expectedNormalizedURL, normalizedURL, testTable.testName)
+ if testTable.expectedError == "" {
+ assert.Nil(t, err, testTable.testName)
+ } else {
+ assert.Equal(t, fmt.Errorf(testTable.expectedError), err, testTable.testName)
+ }
+ }
+}
+
+func Test_uRLIsUnder(t *testing.T) {
+ testTables := []struct {
+ testName string
+ childURL string
+ parentCandidates []string
+ assertion assert.BoolAssertionFunc
+ }{
+ {"Match, root path", "https://github.com/foo/bar", []string{"example.com", "github.com"}, assert.True},
+ {"Mismatch, root path", "https://github.com/foo/bar", []string{"example.com", "example.org"}, assert.False},
+ {"Match, subfolder", "https://github.com/foo/bar", []string{"example.com/foo", "github.com/foo"}, assert.True},
+ {"Mismatch, subfolder", "https://github.com/foo/bar", []string{"example.com/foo", "github.org/bar"}, assert.False},
+ }
+
+ for _, testTable := range testTables {
+ childURL, err := url.Parse(testTable.childURL)
+ require.Nil(t, err)
+
+ t.Run(testTable.testName, func(t *testing.T) {
+ testTable.assertion(t, uRLIsUnder(*childURL, testTable.parentCandidates))
+ })
+ }
+}
diff --git a/poetry.lock b/poetry.lock
new file mode 100644
index 00000000..bb109dbb
--- /dev/null
+++ b/poetry.lock
@@ -0,0 +1,22 @@
+[[package]]
+category = "dev"
+description = "Codespell"
+name = "codespell"
+optional = false
+python-versions = ">=3.5"
+version = "2.0.0"
+
+[package.extras]
+dev = ["check-manifest", "flake8", "pytest", "pytest-cov", "pytest-dependency"]
+hard-encoding-detection = ["chardet"]
+
+[metadata]
+content-hash = "04bfba866bc7b58afdfc851fc8ec7e13967445b6124f0a03e78e8fdedd70c6e3"
+lock-version = "1.0"
+python-versions = "^3.8"
+
+[metadata.files]
+codespell = [
+ {file = "codespell-2.0.0-py3-none-any.whl", hash = "sha256:a10b8bbb9f678e4edff7877af1f654fdc9e27c205f952c3ddee2981ad02ec5f2"},
+ {file = "codespell-2.0.0.tar.gz", hash = "sha256:dd9983e096b9f7ba89dd2d2466d1fc37231d060f19066331b9571341363c77b8"},
+]
diff --git a/pyproject.toml b/pyproject.toml
new file mode 100644
index 00000000..cdcc385a
--- /dev/null
+++ b/pyproject.toml
@@ -0,0 +1,11 @@
+[tool.poetry]
+name = "library-manager-list"
+version = "0.0.0"
+description = "Arduino Library Manager list"
+authors = ["Arduino "]
+
+[tool.poetry.dependencies]
+python = "^3.8"
+
+[tool.poetry.dev-dependencies]
+codespell = ">=2.0.0"