mirror of
https://github.com/FliegendeWurst/KIT-ILIAS-downloader.git
synced 2024-08-28 04:04:18 +00:00
Merge branch 'master' of github.com:FliegendeWurst/KIT-ILIAS-downloader
This commit is contained in:
funnym0nk3y
commit
ee8c99114c
11
.github/workflows/ci.yml
vendored
11
.github/workflows/ci.yml
vendored
@ -2,7 +2,8 @@ name: CI
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [ master ]
|
||||
branches:
|
||||
- '**'
|
||||
pull_request:
|
||||
branches: [ master ]
|
||||
|
||||
@ -17,12 +18,14 @@ jobs:
|
||||
strategy:
|
||||
matrix:
|
||||
os: [ubuntu-latest, windows-latest]
|
||||
features: ["--all-features"]
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- name: Install Rust toolchain
|
||||
uses: actions-rs/toolchain@v1
|
||||
with:
|
||||
profile: minimal
|
||||
toolchain: stable
|
||||
|
||||
- name: Cache cargo directories
|
||||
@ -39,12 +42,10 @@ jobs:
|
||||
path: target
|
||||
key: ${{ runner.os }}-cargo-build-target-${{ hashFiles('**/Cargo.lock') }}
|
||||
- name: Build
|
||||
run: cargo build --release --verbose
|
||||
# there are currently no automated tests
|
||||
- name: Run tests
|
||||
run: cargo test --release --verbose
|
||||
run: cargo build --release ${{ matrix.features }} --verbose
|
||||
- name: Archive artifacts
|
||||
uses: actions/upload-artifact@v2
|
||||
if: matrix.features == '--all-features'
|
||||
with:
|
||||
name: Binaries
|
||||
path: |
|
||||
|
||||
196
CHANGELOG.md
Normal file
196
CHANGELOG.md
Normal file
@ -0,0 +1,196 @@
|
||||
# Changelog
|
||||
All notable changes to this project will be documented in this file.
|
||||
|
||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
|
||||
|
||||
## [Unreleased]
|
||||
|
||||
## [0.3.1] - 2022-01-07
|
||||
### Fixed
|
||||
- `--sync-url` can now be used to download the [course memberships](https://ilias.studium.kit.edu/ilias.php?cmdClass=ilmembershipoverviewgui&cmdNode=iy&baseClass=ilmembershipoverviewgui)
|
||||
|
||||
## [0.3.0] - 2022-01-06
|
||||
### Fixed
|
||||
- ILIAS 7 update ([#27])
|
||||
|
||||
## [0.2.24] - 2021-11-01
|
||||
### Added
|
||||
- `--combine-videos` option to merge multiple video streams of the same lecture
|
||||
- `--save-ilias-pages` option to also save the ILIAS overview pages of courses/folders
|
||||
- Configuration file to change course names (PR [#19] by [@thelukasprobst])
|
||||
|
||||
### Fixed
|
||||
- Downloading of lectures that consist of multiple streams
|
||||
|
||||
## [0.2.23] - 2021-06-14
|
||||
### Added
|
||||
- Logging output of saved forum post attachments
|
||||
|
||||
### Changed
|
||||
- ILIAS folder/course pages are now always saved
|
||||
|
||||
### Fixed
|
||||
- Links in saved ILIAS pages now work (see [`<base>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/base))
|
||||
- ZIP of multiple forum post attachments is no longer downloaded
|
||||
|
||||
## [0.2.22] - 2021-06-02
|
||||
### Added
|
||||
- `--sync-url` can now download more "personal desktop" pages
|
||||
- `--keep-session` flag to save and restore session cookies
|
||||
|
||||
## [0.2.21] - 2021-05-18
|
||||
### Fixed
|
||||
- Automatic output directory creation
|
||||
- HTTP/2 [`NO_ERROR`](https://docs.rs/h2/0.3.3/h2/struct.Reason.html#associatedconstant.NO_ERROR) handling (issue [#15])
|
||||
- Correct logging output when the progress bar is displayed
|
||||
|
||||
## [0.2.20] - 2021-05-13
|
||||
### Fixed
|
||||
- Status display no longer prints every path when running in a small terminal
|
||||
|
||||
## [0.2.19] - 2021-05-11
|
||||
### Fixed
|
||||
- Status display on Windows (issue [#14])
|
||||
|
||||
## [0.2.18] - 2021-05-07
|
||||
### Added
|
||||
- Request rate limiting (default 8 req. / 60 s, option `--rate`, issue [#13])
|
||||
|
||||
## [0.2.17] - 2021-05-04
|
||||
### Added
|
||||
- Progress/status display: `[15/40+] <path currently processed>`
|
||||
- Extraction of course/folder pages (in course.html / folder.html, currently not versioned)
|
||||
|
||||
### Fixed
|
||||
- Downloading of external images in forum posts
|
||||
- Miscellaneous internal improvements
|
||||
|
||||
## [0.2.16] - 2021-04-19
|
||||
### Added
|
||||
- `--sync-url` option (to download only a single course/folder)
|
||||
- `--user` and `--password` options (issue [#10])
|
||||
- `--keyring` option (to get/save the password using a system keyring service)
|
||||
- Colored errors/warnings (PR [#11] by [@thelukasprobst])
|
||||
|
||||
## [0.2.15] - 2021-04-14
|
||||
### Added
|
||||
- Downloading of attachments and embedded images in forum posts
|
||||
- SOCKS5 proxy support (PR [#9] by [@Craeckie])
|
||||
|
||||
## [0.2.14] - 2021-02-16
|
||||
### Fixed
|
||||
- Handling of long paths on Windows (issue [#6])
|
||||
- OpenCast downloading (issue [#7], PR [#8] by [@funnym0nk3y])
|
||||
|
||||
## [0.2.13] - 2021-01-05
|
||||
### Fixed
|
||||
- Shibboleth login (issue [#5], PR [#4] by [@Ma27])
|
||||
|
||||
## [0.2.12] - 2020-12-10
|
||||
### Fixed
|
||||
- Handling of invalid filenames on Windows (issue [#3])
|
||||
|
||||
## [0.2.11] - 2020-12-04
|
||||
### Fixed
|
||||
- Waiting on spawned tasks (issue [#2])
|
||||
|
||||
## [0.2.10] - 2020-11-27
|
||||
### Added
|
||||
- `.iliaslogin` file to provide login credentials
|
||||
|
||||
### Fixed
|
||||
- Handling of `/` and `\\` in lecture names
|
||||
|
||||
## [0.2.9] - 2020-11-01
|
||||
### Fixed
|
||||
- OpenCast downloading
|
||||
|
||||
## [0.2.8] - 2020-07-16
|
||||
### Fixed
|
||||
- OpenCast downloading
|
||||
|
||||
## [0.2.7] - 2020-07-15
|
||||
### Added
|
||||
- Automatic creation of output directory
|
||||
- Optional re-check of OpenCast lectures (`--check-videos`)
|
||||
|
||||
### Fixed
|
||||
- OpenCast pagination (20 -> 800)
|
||||
|
||||
## [0.2.6] - 2020-05-18
|
||||
### Added
|
||||
- Downloading of exercise solutions and feedback
|
||||
|
||||
### Fixed
|
||||
- Video filenames no longer contain raw HTML
|
||||
|
||||
## [0.2.5] - 2020-05-09
|
||||
(undocumented)
|
||||
|
||||
## [0.2.4] - 2020-04-28
|
||||
(undocumented)
|
||||
|
||||
## [0.2.3] - 2020-04-24
|
||||
(undocumented)
|
||||
|
||||
## [0.2.2] - 2020-04-22
|
||||
(undocumented)
|
||||
|
||||
## [0.2.1] - 2020-04-22
|
||||
(undocumented)
|
||||
|
||||
## [0.2.0] - 2020-04-22
|
||||
(undocumented)
|
||||
|
||||
## [0.1.0] - 2020-04-21
|
||||
(undocumented)
|
||||
|
||||
[#27]: https://github.com/FliegendeWurst/KIT-ILIAS-downloader/issues/27
|
||||
[#19]: https://github.com/FliegendeWurst/KIT-ILIAS-downloader/pull/19
|
||||
[#15]: https://github.com/FliegendeWurst/KIT-ILIAS-downloader/issues/15
|
||||
[#14]: https://github.com/FliegendeWurst/KIT-ILIAS-downloader/issues/14
|
||||
[#13]: https://github.com/FliegendeWurst/KIT-ILIAS-downloader/issues/13
|
||||
[#11]: https://github.com/FliegendeWurst/KIT-ILIAS-downloader/pull/11
|
||||
[#10]: https://github.com/FliegendeWurst/KIT-ILIAS-downloader/issues/10
|
||||
[#9]: https://github.com/FliegendeWurst/KIT-ILIAS-downloader/pull/9
|
||||
[#8]: https://github.com/FliegendeWurst/KIT-ILIAS-downloader/pull/8
|
||||
[#7]: https://github.com/FliegendeWurst/KIT-ILIAS-downloader/issues/7
|
||||
[#6]: https://github.com/FliegendeWurst/KIT-ILIAS-downloader/issues/6
|
||||
[#5]: https://github.com/FliegendeWurst/KIT-ILIAS-downloader/issues/5
|
||||
[#4]: https://github.com/FliegendeWurst/KIT-ILIAS-downloader/pull/4
|
||||
[#3]: https://github.com/FliegendeWurst/KIT-ILIAS-downloader/issues/3
|
||||
[#2]: https://github.com/FliegendeWurst/KIT-ILIAS-downloader/issues/2
|
||||
[@thelukasprobst]: https://github.com/thelukasprobst
|
||||
[@Craeckie]: https://github.com/Craeckie
|
||||
[@funnym0nk3y]: https://github.com/funnym0nk3y
|
||||
[@Ma27]: https://github.com/Ma27
|
||||
[Unreleased]: https://github.com/FliegendeWurst/KIT-ILIAS-downloader/compare/v0.3.1...HEAD
|
||||
[0.3.1]: https://github.com/FliegendeWurst/KIT-ILIAS-downloader/compare/v0.3.0...v0.3.1
|
||||
[0.3.0]: https://github.com/FliegendeWurst/KIT-ILIAS-downloader/compare/v0.2.24...v0.3.0
|
||||
[0.2.24]: https://github.com/FliegendeWurst/KIT-ILIAS-downloader/compare/v0.2.23...v0.2.24
|
||||
[0.2.23]: https://github.com/FliegendeWurst/KIT-ILIAS-downloader/compare/v0.2.23...v0.2.24
|
||||
[0.2.23]: https://github.com/FliegendeWurst/KIT-ILIAS-downloader/compare/v0.2.22...v0.2.23
|
||||
[0.2.22]: https://github.com/FliegendeWurst/KIT-ILIAS-downloader/compare/v0.2.21...v0.2.22
|
||||
[0.2.21]: https://github.com/FliegendeWurst/KIT-ILIAS-downloader/compare/v0.2.20...v0.2.21
|
||||
[0.2.20]: https://github.com/FliegendeWurst/KIT-ILIAS-downloader/compare/v0.2.19...v0.2.20
|
||||
[0.2.19]: https://github.com/FliegendeWurst/KIT-ILIAS-downloader/compare/v0.2.18...v0.2.19
|
||||
[0.2.18]: https://github.com/FliegendeWurst/KIT-ILIAS-downloader/compare/v0.2.17...v0.2.18
|
||||
[0.2.17]: https://github.com/FliegendeWurst/KIT-ILIAS-downloader/compare/v0.2.16...v0.2.17
|
||||
[0.2.16]: https://github.com/FliegendeWurst/KIT-ILIAS-downloader/compare/v0.2.15...v0.2.16
|
||||
[0.2.15]: https://github.com/FliegendeWurst/KIT-ILIAS-downloader/compare/v0.2.14...v0.2.15
|
||||
[0.2.14]: https://github.com/FliegendeWurst/KIT-ILIAS-downloader/compare/v0.2.13...v0.2.14
|
||||
[0.2.13]: https://github.com/FliegendeWurst/KIT-ILIAS-downloader/compare/v0.2.12...v0.2.13
|
||||
[0.2.12]: https://github.com/FliegendeWurst/KIT-ILIAS-downloader/compare/v0.2.11...v0.2.12
|
||||
[0.2.11]: https://github.com/FliegendeWurst/KIT-ILIAS-downloader/compare/v0.2.10...v0.2.11
|
||||
[0.2.10]: https://github.com/FliegendeWurst/KIT-ILIAS-downloader/compare/v0.2.9...v0.2.10
|
||||
[0.2.9]: https://github.com/FliegendeWurst/KIT-ILIAS-downloader/compare/v0.2.8...v0.2.9
|
||||
[0.2.8]: https://github.com/FliegendeWurst/KIT-ILIAS-downloader/compare/v0.2.7...v0.2.8
|
||||
[0.2.7]: https://github.com/FliegendeWurst/KIT-ILIAS-downloader/compare/v0.2.6...v0.2.7
|
||||
[0.2.6]: https://github.com/FliegendeWurst/KIT-ILIAS-downloader/compare/v0.2.5...v0.2.6
|
||||
[0.2.5]: https://github.com/FliegendeWurst/KIT-ILIAS-downloader/compare/v0.2.4...v0.2.5
|
||||
[0.2.4]: https://github.com/FliegendeWurst/KIT-ILIAS-downloader/compare/v0.2.3...v0.2.4
|
||||
[0.2.3]: https://github.com/FliegendeWurst/KIT-ILIAS-downloader/compare/v0.2.2...v0.2.3
|
||||
[0.2.2]: https://github.com/FliegendeWurst/KIT-ILIAS-downloader/compare/v0.2.1...v0.2.2
|
||||
[0.2.1]: https://github.com/FliegendeWurst/KIT-ILIAS-downloader/compare/v0.2.0...v0.2.1
|
||||
[0.2.0]: https://github.com/FliegendeWurst/KIT-ILIAS-downloader/compare/v0.1.0...v0.2.0
|
||||
[0.1.0]: https://github.com/FliegendeWurst/KIT-ILIAS-downloader/compare/1529a678e0f4c78a24c8cc2cd236ce12ea8a78dc..v0.1.0
|
||||
1457
Cargo.lock
generated
1457
Cargo.lock
generated
File diff suppressed because it is too large
Load Diff
25
Cargo.toml
25
Cargo.toml
@ -1,15 +1,15 @@
|
||||
[package]
|
||||
name = "KIT-ILIAS-downloader"
|
||||
version = "0.2.13"
|
||||
authors = ["FliegendeWurst <2012gdwu@web.de>"]
|
||||
license = "GPL-2.0"
|
||||
version = "0.3.1"
|
||||
authors = ["FliegendeWurst <2012gdwu@posteo.de>"]
|
||||
license = "GPL-3.0-or-later"
|
||||
edition = "2018"
|
||||
|
||||
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
||||
|
||||
[dependencies]
|
||||
reqwest = { version = "0.11.0", default-features = false, features = ["cookies", "gzip", "json", "rustls-tls", "stream"] }
|
||||
tokio = { version = "1.0.2", features = ["full"] }
|
||||
reqwest = { version = "0.11.0", default-features = false, features = ["cookies", "gzip", "json", "rustls-tls", "stream", "socks"] }
|
||||
tokio = { version = "1.0.2", features = ["fs", "macros", "net", "rt-multi-thread", "process"] }
|
||||
tokio-util = { version = "0.6.1", features = ["io"] }
|
||||
serde_json = "1.0.51"
|
||||
scraper = "0.12.0"
|
||||
@ -18,10 +18,21 @@ futures = "0.3.8"
|
||||
futures-util = "0.3.8"
|
||||
futures-channel = "0.3.8"
|
||||
regex = "1.3.7"
|
||||
lazy_static = "1.4.0"
|
||||
parking_lot = "0.11.0"
|
||||
structopt = "0.3.13"
|
||||
rpassword = "5.0.0"
|
||||
rprompt = "1.0.5"
|
||||
ignore = "0.4.14"
|
||||
anyhow = "1.0.28"
|
||||
colored = "2.0.0"
|
||||
keyring = "1.0.0"
|
||||
cfg-if = "1.0.0"
|
||||
indicatif = "0.16.0"
|
||||
once_cell = "1.7.2"
|
||||
atty = "0.2.14"
|
||||
h2 = "0.3.3"
|
||||
cookie_store = "0.15.1"
|
||||
reqwest_cookie_store = "0.2.0"
|
||||
bytes = "1.0.1"
|
||||
toml = "0.5.8"
|
||||
tempfile = "3.2.0"
|
||||
ego-tree = "0.6.2"
|
||||
|
||||
674
LICENSE
Normal file
674
LICENSE
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>.
|
||||
82
README.md
82
README.md
@ -2,52 +2,73 @@
|
||||
|
||||
Download content from ILIAS. That includes:
|
||||
|
||||
* files (latest version)
|
||||
* files
|
||||
* exercise sheets and solutions
|
||||
* Opencast lectures
|
||||
* forum posts
|
||||
|
||||
## Installation
|
||||
|
||||
Go to the [releases](../../releases) and get the executable for your operating system. Alternatively compile from source: (to get the latest updates)
|
||||
**Windows/Linux users**: go to the [releases](../../releases) and download the executable for your operating system.
|
||||
**macOS users**: [Install Rust](https://www.rust-lang.org/tools/install) and compile from source:
|
||||
```
|
||||
$ git clone https://github.com/FliegendeWurst/KIT-ILIAS-downloader
|
||||
...
|
||||
$ cd KIT-ILIAS-downloader
|
||||
$ cargo build --release
|
||||
...
|
||||
$ cp target/release/KIT-ILIAS-downloader [directory in $PATH]
|
||||
$ cargo install --all-features --git 'https://github.com/FliegendeWurst/KIT-ILIAS-downloader' --branch stable
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Use `-o <directory>` to specify the download directory. Username and password have to be provided every time the program is run.
|
||||
First, open a terminal. Navigate to the directory that contains the downloaded binary.
|
||||
|
||||
Only content on your [personal desktop](https://ilias.studium.kit.edu/ilias.php?baseClass=ilPersonalDesktopGUI&cmd=jumpToSelectedItems) will be downloaded.
|
||||
Then execute the program (use `-o <directory>` to specify the download directory):
|
||||
|
||||
```
|
||||
$ KIT-ILIAS-downloader -o ./ILIAS
|
||||
```
|
||||
|
||||
By default, only content on your [personal desktop](https://ilias.studium.kit.edu/ilias.php?baseClass=ilPersonalDesktopGUI&cmd=jumpToSelectedItems) will be downloaded.
|
||||
Use the `--sync-url` option to download a specific page and its sub-pages: (the URL should be copied from an ILIAS link, not the browser URL bar)
|
||||
|
||||
```
|
||||
$ KIT-ILIAS-downloader -o ./ILIAS/WS2021-HM1 --sync-url 'https://ilias.studium.kit.edu/ilias.php?ref_id=1276968&cmdClass=ilrepositorygui&cmdNode=uk&baseClass=ilRepositoryGUI'
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
$ KIT-ILIAS-downloader --help
|
||||
KIT-ILIAS-downloader 0.2.5
|
||||
KIT-ILIAS-downloader 0.2.24
|
||||
|
||||
USAGE:
|
||||
KIT-ILIAS-downloader [FLAGS] [OPTIONS] --output <output>
|
||||
|
||||
FLAGS:
|
||||
--content-tree Use content tree (slow but thorough)
|
||||
-f Re-download already present files
|
||||
-t, --forum Download forum content
|
||||
-h, --help Prints help information
|
||||
-n, --no-videos Do not download Opencast videos
|
||||
-s, --skip-files Do not download files
|
||||
-V, --version Prints version information
|
||||
-v Verbose logging (print objects downloaded)
|
||||
--check-videos Re-check OpenCast lectures (slow)
|
||||
--combine-videos Combine videos if there is more than one stream (requires ffmpeg)
|
||||
--content-tree Use content tree (experimental)
|
||||
-f Re-download already present files
|
||||
-t, --forum Download forum content
|
||||
-h, --help Prints help information
|
||||
--keep-session Attempt to re-use session cookies
|
||||
--keyring Use the system keyring
|
||||
-n, --no-videos Do not download Opencast videos
|
||||
--save-ilias-pages Save overview pages of ILIAS courses and folders
|
||||
-s, --skip-files Do not download files
|
||||
-V, --version Prints version information
|
||||
-v Verbose logging
|
||||
|
||||
OPTIONS:
|
||||
-j, --jobs <jobs> Parallel download jobs [default: 1]
|
||||
-o, --output <output> Output directory
|
||||
-j, --jobs <jobs> Parallel download jobs [default: 1]
|
||||
-o, --output <output> Output directory
|
||||
-P, --password <password> KIT account password
|
||||
-p, --proxy <proxy> Proxy, e.g. socks5h://127.0.0.1:1080
|
||||
--rate <rate> Requests per minute [default: 8]
|
||||
--sync-url <sync-url> ILIAS page to download
|
||||
-U, --username <username> KIT account username
|
||||
```
|
||||
|
||||
### .iliasignore
|
||||
|
||||
.gitignore syntax can be used in a `.iliasignore` file: (located in the download folder)
|
||||
.gitignore syntax can be used in a `.iliasignore` file: (located in the output folder)
|
||||
```ignore
|
||||
# example 1: only download a single course
|
||||
/*/
|
||||
@ -57,16 +78,29 @@ OPTIONS:
|
||||
!/Course/Tutorien/Tut* 3/
|
||||
```
|
||||
|
||||
### .iliaslogin
|
||||
### Credentials
|
||||
|
||||
If you don't want to enter your credentials every time you run the program, you can instead save your username and password in a file (`.iliaslogin`):
|
||||
You can use the `--user` and `--keyring` options to get/store the password using the system password store.
|
||||
If you use Linux, you'll have to compile from source to be able to use this option.
|
||||
```
|
||||
$ KIT-ILIAS-downloader -U uabcd --keyring [...]
|
||||
```
|
||||
|
||||
You can also save your username and password in a `.iliaslogin` file: (located in the output folder)
|
||||
```
|
||||
username
|
||||
password
|
||||
```
|
||||
|
||||
### Renaming course names (0.2.24+)
|
||||
If you'd like to avoid unwieldy course names (e.g. "24030 – Programmierparadigmen"), you can create a `course_names.toml` file in the output directory. It should contain the desired mapping of course names to folder names, e.g.:
|
||||
```
|
||||
"24030 – Programmierparadigmen" = "ProPa"
|
||||
"Numerische Mathematik für die Fachrichtungen Informatik und Ingenieurwesen" = "Numerik"
|
||||
```
|
||||
|
||||
## Similar programs
|
||||
|
||||
- https://github.com/brantsch/kit-ilias-fuse/
|
||||
- https://github.com/Garmelon/PFERD/
|
||||
- https://github.com/DeOldSax/iliasDownloaderTool
|
||||
|
||||
8
build.sh
Executable file
8
build.sh
Executable file
@ -0,0 +1,8 @@
|
||||
#!/bin/sh
|
||||
rustup target add x86_64-unknown-linux-musl
|
||||
cargo build --locked --release --target x86_64-unknown-linux-musl
|
||||
|
||||
rustup target add x86_64-pc-windows-gnu
|
||||
# if on Debian or similar
|
||||
sudo apt install mingw-w64
|
||||
cargo build --locked --release --all-features --target x86_64-pc-windows-gnu
|
||||
3
rustfmt.toml
Normal file
3
rustfmt.toml
Normal file
@ -0,0 +1,3 @@
|
||||
hard_tabs = true
|
||||
match_block_trailing_comma = true
|
||||
max_width = 120
|
||||
6
shell.nix
Normal file
6
shell.nix
Normal file
@ -0,0 +1,6 @@
|
||||
with (import <nixpkgs> {});
|
||||
mkShell {
|
||||
buildInputs = [
|
||||
dbus
|
||||
];
|
||||
}
|
||||
177
src/cli.rs
Normal file
177
src/cli.rs
Normal file
@ -0,0 +1,177 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
use std::path::PathBuf;
|
||||
use std::sync::atomic::{AtomicBool, AtomicUsize};
|
||||
|
||||
use anyhow::anyhow;
|
||||
use anyhow::{Context, Result};
|
||||
use indicatif::ProgressBar;
|
||||
use once_cell::sync::Lazy;
|
||||
use structopt::StructOpt;
|
||||
|
||||
#[derive(Debug, Clone, StructOpt)]
|
||||
#[structopt(name = env!("CARGO_PKG_NAME"))]
|
||||
pub struct Opt {
|
||||
/// Do not download files
|
||||
#[structopt(short, long)]
|
||||
pub skip_files: bool,
|
||||
|
||||
/// Do not download Opencast videos
|
||||
#[structopt(short, long)]
|
||||
pub no_videos: bool,
|
||||
|
||||
/// Download forum content
|
||||
#[structopt(short = "t", long)]
|
||||
pub forum: bool,
|
||||
|
||||
/// Re-download already present files
|
||||
#[structopt(short)]
|
||||
pub force: bool,
|
||||
|
||||
/// Use content tree (experimental)
|
||||
#[structopt(long)]
|
||||
pub content_tree: bool,
|
||||
|
||||
/// Re-check OpenCast lectures (slow)
|
||||
#[structopt(long)]
|
||||
pub check_videos: bool,
|
||||
|
||||
/// Combine videos if there is more than one stream (requires ffmpeg)
|
||||
#[structopt(long)]
|
||||
pub combine_videos: bool,
|
||||
|
||||
/// Save overview pages of ILIAS courses and folders
|
||||
#[structopt(long)]
|
||||
pub save_ilias_pages: bool,
|
||||
|
||||
/// Verbose logging
|
||||
#[structopt(short, multiple = true, parse(from_occurrences))]
|
||||
pub verbose: usize,
|
||||
|
||||
/// Output directory
|
||||
#[structopt(short, long, parse(from_os_str))]
|
||||
pub output: PathBuf,
|
||||
|
||||
/// Parallel download jobs
|
||||
#[structopt(short, long, default_value = "1")]
|
||||
pub jobs: usize,
|
||||
|
||||
/// Proxy, e.g. socks5h://127.0.0.1:1080
|
||||
#[structopt(short, long)]
|
||||
pub proxy: Option<String>,
|
||||
|
||||
/// Use the system keyring
|
||||
#[structopt(long)]
|
||||
pub keyring: bool,
|
||||
|
||||
/// KIT account username
|
||||
#[structopt(short = "U", long)]
|
||||
pub username: Option<String>,
|
||||
|
||||
/// KIT account password
|
||||
#[structopt(short = "P", long)]
|
||||
pub password: Option<String>,
|
||||
|
||||
/// ILIAS page to download
|
||||
#[structopt(long)]
|
||||
pub sync_url: Option<String>,
|
||||
|
||||
/// Requests per minute
|
||||
#[structopt(long, default_value = "8")]
|
||||
pub rate: usize,
|
||||
|
||||
/// Attempt to re-use session cookies
|
||||
#[structopt(long)]
|
||||
pub keep_session: bool,
|
||||
}
|
||||
|
||||
pub static LOG_LEVEL: AtomicUsize = AtomicUsize::new(0);
|
||||
pub static PROGRESS_BAR_ENABLED: AtomicBool = AtomicBool::new(false);
|
||||
pub static PROGRESS_BAR: Lazy<ProgressBar> = Lazy::new(|| ProgressBar::new(0));
|
||||
|
||||
macro_rules! log {
|
||||
($lvl:expr, $($t:expr),+) => {{
|
||||
#[allow(unused_imports)]
|
||||
use colored::Colorize as _;
|
||||
#[allow(unused_comparisons)] // 0 <= 0
|
||||
if $lvl <= crate::cli::LOG_LEVEL.load(std::sync::atomic::Ordering::SeqCst) {
|
||||
if crate::cli::PROGRESS_BAR_ENABLED.load(std::sync::atomic::Ordering::SeqCst) {
|
||||
crate::cli::PROGRESS_BAR.println(format!($($t),+));
|
||||
} else {
|
||||
println!($($t),+);
|
||||
}
|
||||
}
|
||||
}}
|
||||
}
|
||||
|
||||
macro_rules! info {
|
||||
($t:tt) => {
|
||||
log!(0, $t);
|
||||
};
|
||||
}
|
||||
|
||||
macro_rules! success {
|
||||
($t:tt) => {
|
||||
log!(0, "{}", format!($t).bright_green());
|
||||
};
|
||||
}
|
||||
|
||||
macro_rules! warning {
|
||||
($e:expr) => {{
|
||||
log!(0, "Warning: {}", format!("{:?}", $e).bright_yellow());
|
||||
}};
|
||||
($msg:expr, $e:expr) => {{
|
||||
log!(0, "Warning: {}", format!("{} {:?}", $msg, $e).bright_yellow());
|
||||
}};
|
||||
($msg1:expr, $msg2:expr, $e:expr) => {{
|
||||
log!(0, "Warning: {}", format!("{} {} {:?}", $msg1, $msg2, $e).bright_yellow());
|
||||
}};
|
||||
(format => $($e:expr),+) => {{
|
||||
log!(0, "Warning: {}", format!($($e),+).bright_yellow());
|
||||
}};
|
||||
($lvl:expr; $($e:expr),+) => {{
|
||||
log!($lvl, "Warning: {}", format!($($e),+).bright_yellow());
|
||||
}};
|
||||
}
|
||||
|
||||
macro_rules! error {
|
||||
($($prefix:expr),+; $e:expr) => {
|
||||
log!(0, "{}: {}", format!($($prefix),+), format!("{:?}", $e).bright_red());
|
||||
};
|
||||
($e:expr) => {
|
||||
log!(0, "Error: {}", format!("{:?}", $e).bright_red());
|
||||
};
|
||||
}
|
||||
|
||||
pub fn ask_user_pass(opt: &Opt) -> Result<(String, String)> {
|
||||
let user = if let Some(username) = opt.username.as_ref() {
|
||||
username.clone()
|
||||
} else {
|
||||
rprompt::prompt_reply_stdout("Username: ").context("username prompt")?
|
||||
};
|
||||
let (pass, should_store);
|
||||
let keyring = Lazy::new(|| keyring::Entry::new(env!("CARGO_PKG_NAME"), &user));
|
||||
if let Some(password) = opt.password.as_ref() {
|
||||
pass = password.clone();
|
||||
should_store = true;
|
||||
} else if opt.keyring {
|
||||
match keyring.get_password() {
|
||||
Ok(password) => {
|
||||
pass = password;
|
||||
should_store = false;
|
||||
},
|
||||
Err(e) => {
|
||||
error!(e);
|
||||
pass = rpassword::read_password_from_tty(Some("Password: ")).context("password prompt")?;
|
||||
should_store = true;
|
||||
}
|
||||
}
|
||||
} else {
|
||||
pass = rpassword::read_password_from_tty(Some("Password: ")).context("password prompt")?;
|
||||
should_store = true;
|
||||
}
|
||||
if should_store && opt.keyring {
|
||||
keyring.set_password(&pass).map_err(|x| anyhow!(x.to_string()))?;
|
||||
}
|
||||
Ok((user, pass))
|
||||
}
|
||||
552
src/ilias.rs
Normal file
552
src/ilias.rs
Normal file
@ -0,0 +1,552 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
use std::{collections::HashMap, error::Error as _, io::Write, sync::Arc};
|
||||
|
||||
use anyhow::{anyhow, Context, Result};
|
||||
use cookie_store::CookieStore;
|
||||
use ignore::gitignore::Gitignore;
|
||||
use once_cell::sync::Lazy;
|
||||
use reqwest::{Client, IntoUrl, Proxy, Url};
|
||||
use reqwest_cookie_store::CookieStoreMutex;
|
||||
use scraper::{ElementRef, Html, Selector};
|
||||
use serde_json::json;
|
||||
|
||||
use crate::{cli::Opt, queue, util::wrap_html, ILIAS_URL};
|
||||
|
||||
pub mod course;
|
||||
pub mod exercise;
|
||||
pub mod file;
|
||||
pub mod folder;
|
||||
pub mod forum;
|
||||
pub mod plugin_dispatch;
|
||||
pub mod thread;
|
||||
pub mod video;
|
||||
pub mod weblink;
|
||||
|
||||
static LINKS: Lazy<Selector> = Lazy::new(|| Selector::parse("a").unwrap());
|
||||
static ALERT_DANGER: Lazy<Selector> = Lazy::new(|| Selector::parse("div.alert-danger").unwrap());
|
||||
static IL_CONTENT_CONTAINER: Lazy<Selector> = Lazy::new(|| Selector::parse("#il_center_col").unwrap());
|
||||
static BLOCK_FAVORITES: Lazy<Selector> = Lazy::new(|| Selector::parse("#block_pditems_0").unwrap());
|
||||
static ITEM_PROP: Lazy<Selector> = Lazy::new(|| Selector::parse("span.il_ItemProperty").unwrap());
|
||||
static CONTAINER_ITEMS: Lazy<Selector> = Lazy::new(|| Selector::parse("div.il_ContainerListItem, .il-std-item").unwrap());
|
||||
static CONTAINER_ITEM_TITLE: Lazy<Selector> = Lazy::new(|| Selector::parse("a.il_ContainerItemTitle, .il-item-title > a").unwrap());
|
||||
|
||||
pub struct ILIAS {
|
||||
pub opt: Opt,
|
||||
pub ignore: Gitignore,
|
||||
client: Client,
|
||||
cookies: Arc<CookieStoreMutex>,
|
||||
pub course_names: HashMap<String, String>,
|
||||
}
|
||||
|
||||
/// Returns true if the error is caused by:
|
||||
/// "http2 error: protocol error: not a result of an error"
|
||||
fn error_is_http2(error: &reqwest::Error) -> bool {
|
||||
error
|
||||
.source() // hyper::Error
|
||||
.map(|x| x.source()) // h2::Error
|
||||
.flatten()
|
||||
.map(|x| x.downcast_ref::<h2::Error>())
|
||||
.flatten()
|
||||
.map(|x| x.reason())
|
||||
.flatten()
|
||||
.map(|x| x == h2::Reason::NO_ERROR)
|
||||
.unwrap_or(false)
|
||||
}
|
||||
|
||||
impl ILIAS {
|
||||
// TODO: de-duplicate the logic below
|
||||
pub async fn with_session(
|
||||
opt: Opt,
|
||||
session: Arc<CookieStoreMutex>,
|
||||
ignore: Gitignore,
|
||||
course_names: HashMap<String, String>,
|
||||
) -> Result<Self> {
|
||||
let mut builder = Client::builder()
|
||||
.cookie_provider(Arc::clone(&session))
|
||||
.user_agent(concat!(env!("CARGO_PKG_NAME"), "/", env!("CARGO_PKG_VERSION")));
|
||||
if let Some(proxy) = opt.proxy.as_ref() {
|
||||
let proxy = Proxy::all(proxy)?;
|
||||
builder = builder.proxy(proxy);
|
||||
}
|
||||
let client = builder
|
||||
// timeout is infinite by default
|
||||
.build()?;
|
||||
info!("Re-using previous session cookies..");
|
||||
Ok(ILIAS {
|
||||
opt,
|
||||
ignore,
|
||||
client,
|
||||
cookies: session,
|
||||
course_names,
|
||||
})
|
||||
}
|
||||
|
||||
pub async fn login(
|
||||
opt: Opt,
|
||||
user: &str,
|
||||
pass: &str,
|
||||
ignore: Gitignore,
|
||||
course_names: HashMap<String, String>,
|
||||
) -> Result<Self> {
|
||||
let cookie_store = CookieStore::default();
|
||||
let cookie_store = reqwest_cookie_store::CookieStoreMutex::new(cookie_store);
|
||||
let cookie_store = std::sync::Arc::new(cookie_store);
|
||||
let mut builder = Client::builder()
|
||||
.cookie_provider(Arc::clone(&cookie_store))
|
||||
.user_agent(concat!(env!("CARGO_PKG_NAME"), "/", env!("CARGO_PKG_VERSION")));
|
||||
if let Some(proxy) = opt.proxy.as_ref() {
|
||||
let proxy = Proxy::all(proxy)?;
|
||||
builder = builder.proxy(proxy);
|
||||
}
|
||||
let client = builder
|
||||
// timeout is infinite by default
|
||||
.build()?;
|
||||
let this = ILIAS {
|
||||
opt,
|
||||
ignore,
|
||||
client,
|
||||
cookies: cookie_store,
|
||||
course_names,
|
||||
};
|
||||
info!("Logging into ILIAS using KIT account..");
|
||||
let session_establishment = this
|
||||
.client
|
||||
.post("https://ilias.studium.kit.edu/Shibboleth.sso/Login")
|
||||
.form(&json!({
|
||||
"sendLogin": "1",
|
||||
"idp_selection": "https://idp.scc.kit.edu/idp/shibboleth",
|
||||
"target": "/shib_login.php?target=",
|
||||
"home_organization_selection": "Mit KIT-Account anmelden"
|
||||
}))
|
||||
.send()
|
||||
.await?;
|
||||
let url = session_establishment.url().clone();
|
||||
let text = session_establishment.text().await?;
|
||||
let dom_sso = Html::parse_document(text.as_str());
|
||||
let csrf_token = dom_sso
|
||||
.select(&Selector::parse(r#"input[name="csrf_token"]"#).unwrap())
|
||||
.next()
|
||||
.context("no CSRF token found")?
|
||||
.value()
|
||||
.attr("value")
|
||||
.context("no CSRF token value")?;
|
||||
info!("Logging into Shibboleth..");
|
||||
let login_response = this
|
||||
.client
|
||||
.post(url)
|
||||
.form(&json!({
|
||||
"j_username": user,
|
||||
"j_password": pass,
|
||||
"_eventId_proceed": "",
|
||||
"csrf_token": csrf_token,
|
||||
}))
|
||||
.send()
|
||||
.await?
|
||||
.text()
|
||||
.await?;
|
||||
let dom = Html::parse_document(&login_response);
|
||||
let saml = Selector::parse(r#"input[name="SAMLResponse"]"#).unwrap();
|
||||
let saml = dom
|
||||
.select(&saml)
|
||||
.next()
|
||||
.context("no SAML response, incorrect password?")?;
|
||||
let relay_state = Selector::parse(r#"input[name="RelayState"]"#).unwrap();
|
||||
let relay_state = dom.select(&relay_state).next().context("no relay state")?;
|
||||
info!("Logging into ILIAS..");
|
||||
this.client
|
||||
.post("https://ilias.studium.kit.edu/Shibboleth.sso/SAML2/POST")
|
||||
.form(&json!({
|
||||
"SAMLResponse": saml.value().attr("value").context("no SAML value")?,
|
||||
"RelayState": relay_state.value().attr("value").context("no RelayState value")?
|
||||
}))
|
||||
.send()
|
||||
.await?;
|
||||
success!("Logged in!");
|
||||
Ok(this)
|
||||
}
|
||||
|
||||
pub async fn save_session(&self) -> Result<()> {
|
||||
let session_path = self.opt.output.join(".iliassession");
|
||||
let mut writer = std::fs::File::create(session_path)
|
||||
.map(std::io::BufWriter::new)
|
||||
.unwrap();
|
||||
let store = self.cookies.lock().map_err(|x| anyhow!("{}", x))?;
|
||||
// save all cookies, including session cookies
|
||||
for cookie in store.iter_unexpired().map(serde_json::to_string) {
|
||||
writeln!(writer, "{}", cookie?)?;
|
||||
}
|
||||
writer.flush()?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub async fn download(&self, url: &str) -> Result<reqwest::Response> {
|
||||
queue::get_request_ticket().await;
|
||||
log!(2, "Downloading {}", url);
|
||||
let url = if url.starts_with("http://") || url.starts_with("https://") {
|
||||
url.to_owned()
|
||||
} else if url.starts_with("ilias.studium.kit.edu") {
|
||||
format!("https://{}", url)
|
||||
} else {
|
||||
format!("{}{}", ILIAS_URL, url)
|
||||
};
|
||||
for attempt in 1..10 {
|
||||
let result = self.client.get(url.clone()).send().await;
|
||||
match result {
|
||||
Ok(x) => return Ok(x),
|
||||
Err(e) if attempt <= 3 && error_is_http2(&e) => {
|
||||
warning!(1; "encountered HTTP/2 NO_ERROR, retrying download..");
|
||||
continue;
|
||||
},
|
||||
Err(e) => return Err(e.into()),
|
||||
}
|
||||
}
|
||||
unreachable!()
|
||||
}
|
||||
|
||||
pub async fn head<U: IntoUrl>(&self, url: U) -> Result<reqwest::Response, reqwest::Error> {
|
||||
queue::get_request_ticket().await;
|
||||
let url = url.into_url()?;
|
||||
for attempt in 1..10 {
|
||||
let result = self.client.head(url.clone()).send().await;
|
||||
match result {
|
||||
Ok(x) => return Ok(x),
|
||||
Err(e) if attempt <= 3 && error_is_http2(&e) => {
|
||||
warning!(1; "encountered HTTP/2 NO_ERROR, retrying HEAD request..");
|
||||
continue;
|
||||
},
|
||||
Err(e) => return Err(e),
|
||||
}
|
||||
}
|
||||
unreachable!()
|
||||
}
|
||||
|
||||
pub async fn get_html(&self, url: &str) -> Result<Html> {
|
||||
let resp = self.download(url).await?;
|
||||
if resp
|
||||
.url()
|
||||
.query()
|
||||
.map(|x| x.contains("reloadpublic=1") || x.contains("cmd=force_login"))
|
||||
.unwrap_or(false)
|
||||
{
|
||||
return Err(anyhow!("not logged in / session expired"));
|
||||
}
|
||||
let text = self.download(url).await?.text().await?;
|
||||
let html = Html::parse_document(&text);
|
||||
if html.select(&ALERT_DANGER).next().is_some() {
|
||||
Err(anyhow!("ILIAS error"))
|
||||
} else {
|
||||
Ok(html)
|
||||
}
|
||||
}
|
||||
|
||||
pub async fn get_html_fragment(&self, url: &str) -> Result<Html> {
|
||||
let text = self.download(url).await?.text().await?;
|
||||
let html = Html::parse_fragment(&text);
|
||||
if html.select(&ALERT_DANGER).next().is_some() {
|
||||
Err(anyhow!("ILIAS error"))
|
||||
} else {
|
||||
Ok(html)
|
||||
}
|
||||
}
|
||||
|
||||
pub fn get_items(html: &Html) -> Vec<Result<Object>> {
|
||||
let html = if let Some(favorites) = html.select(&BLOCK_FAVORITES).next() {
|
||||
favorites
|
||||
} else {
|
||||
html.root_element()
|
||||
};
|
||||
html.select(&CONTAINER_ITEMS)
|
||||
.flat_map(|item| {
|
||||
item.select(&CONTAINER_ITEM_TITLE)
|
||||
.next()
|
||||
.map(|link| Object::from_link(item, link))
|
||||
// items without links are ignored
|
||||
})
|
||||
.collect()
|
||||
}
|
||||
|
||||
/// Returns subfolders and the main text in a course/folder/personal desktop.
|
||||
pub async fn get_course_content(&self, url: &URL) -> Result<(Vec<Result<Object>>, Option<String>)> {
|
||||
let html = self.get_html(&url.url).await?;
|
||||
|
||||
let main_text = if let Some(el) = html.select(&IL_CONTENT_CONTAINER).next() {
|
||||
// if we are currently extracting the dashboard, only select the favorites
|
||||
if let Some(el) = el.select(&BLOCK_FAVORITES).next() {
|
||||
Some(wrap_html(&el.inner_html()))
|
||||
} else {
|
||||
Some(wrap_html(&el.inner_html()))
|
||||
}
|
||||
} else {
|
||||
None
|
||||
};
|
||||
Ok((ILIAS::get_items(&html), main_text))
|
||||
}
|
||||
|
||||
pub async fn get_course_content_tree(&self, ref_id: &str, cmd_node: &str) -> Result<Vec<Object>> {
|
||||
// TODO: this magically does not return sub-folders
|
||||
// opening the same url in browser does show sub-folders?!
|
||||
let url = format!(
|
||||
"{}ilias.php?ref_id={}&cmdClass=ilobjcoursegui&cmd=showRepTree&cmdNode={}&baseClass=ilRepositoryGUI&cmdMode=asynch&exp_cmd=getNodeAsync&node_id=exp_node_rep_exp_{}&exp_cont=il_expl2_jstree_cont_rep_exp&searchterm=",
|
||||
ILIAS_URL, ref_id, cmd_node, ref_id
|
||||
);
|
||||
let html = self.get_html_fragment(&url).await?;
|
||||
let mut items = Vec::new();
|
||||
for link in html.select(&LINKS) {
|
||||
if link.value().attr("href").is_some() {
|
||||
items.push(Object::from_link(link, link)?);
|
||||
} // else: disabled course
|
||||
}
|
||||
Ok(items)
|
||||
}
|
||||
}
|
||||
|
||||
trait IliasObject {
|
||||
fn download(ilias: Arc<ILIAS>) -> Result<()>;
|
||||
}
|
||||
|
||||
#[derive(Debug)]
|
||||
pub enum Object {
|
||||
Course { name: String, url: URL },
|
||||
Folder { name: String, url: URL },
|
||||
Dashboard { url: URL },
|
||||
File { name: String, url: URL },
|
||||
Forum { name: String, url: URL },
|
||||
Thread { url: URL },
|
||||
Wiki { name: String, url: URL },
|
||||
ExerciseHandler { name: String, url: URL },
|
||||
Weblink { name: String, url: URL },
|
||||
Survey { name: String, url: URL },
|
||||
Presentation { name: String, url: URL },
|
||||
PluginDispatch { name: String, url: URL },
|
||||
Video { url: URL },
|
||||
Generic { name: String, url: URL },
|
||||
}
|
||||
|
||||
use Object::*;
|
||||
|
||||
impl Object {
|
||||
pub fn name(&self) -> &str {
|
||||
match self {
|
||||
Course { name, .. }
|
||||
| Folder { name, .. }
|
||||
| File { name, .. }
|
||||
| Forum { name, .. }
|
||||
| Wiki { name, .. }
|
||||
| Weblink { name, .. }
|
||||
| Survey { name, .. }
|
||||
| Presentation { name, .. }
|
||||
| ExerciseHandler { name, .. }
|
||||
| PluginDispatch { name, .. }
|
||||
| Generic { name, .. } => &name,
|
||||
Thread { url } => &url.thr_pk.as_ref().unwrap(),
|
||||
Video { url } => &url.url,
|
||||
Dashboard { url } => &url.url
|
||||
}
|
||||
}
|
||||
|
||||
pub fn url(&self) -> &URL {
|
||||
match self {
|
||||
Course { url, .. }
|
||||
| Folder { url, .. }
|
||||
| Dashboard { url }
|
||||
| File { url, .. }
|
||||
| Forum { url, .. }
|
||||
| Thread { url }
|
||||
| Wiki { url, .. }
|
||||
| Weblink { url, .. }
|
||||
| Survey { url, .. }
|
||||
| Presentation { url, .. }
|
||||
| ExerciseHandler { url, .. }
|
||||
| PluginDispatch { url, .. }
|
||||
| Video { url }
|
||||
| Generic { url, .. } => &url,
|
||||
}
|
||||
}
|
||||
|
||||
pub fn kind(&self) -> &str {
|
||||
match self {
|
||||
Course { .. } => "course",
|
||||
Folder { .. } => "folder",
|
||||
Dashboard { .. } => "dashboard",
|
||||
File { .. } => "file",
|
||||
Forum { .. } => "forum",
|
||||
Thread { .. } => "thread",
|
||||
Wiki { .. } => "wiki",
|
||||
Weblink { .. } => "weblink",
|
||||
Survey { .. } => "survey",
|
||||
Presentation { .. } => "presentation",
|
||||
ExerciseHandler { .. } => "exercise handler",
|
||||
PluginDispatch { .. } => "plugin dispatch",
|
||||
Video { .. } => "video",
|
||||
Generic { .. } => "generic",
|
||||
}
|
||||
}
|
||||
|
||||
pub fn is_dir(&self) -> bool {
|
||||
matches!(
|
||||
self,
|
||||
Course { .. }
|
||||
| Folder { .. } | Dashboard { .. }
|
||||
| Forum { .. } | Thread { .. }
|
||||
| Wiki { .. } | ExerciseHandler { .. }
|
||||
| PluginDispatch { .. }
|
||||
)
|
||||
}
|
||||
|
||||
pub fn from_link(item: ElementRef, link: ElementRef) -> Result<Self> {
|
||||
let name = link.text().collect::<String>().replace('/', "-").trim().to_owned();
|
||||
let url = URL::from_href(link.value().attr("href").context("link missing href")?)?;
|
||||
Object::from_url(url, name, Some(item))
|
||||
}
|
||||
|
||||
pub fn from_url(mut url: URL, mut name: String, item: Option<ElementRef>) -> Result<Self> {
|
||||
if url.thr_pk.is_some() {
|
||||
return Ok(Thread { url });
|
||||
}
|
||||
|
||||
if url.url.starts_with("https://ilias.studium.kit.edu/goto.php") {
|
||||
let target = url.target.as_deref().unwrap_or("NONE");
|
||||
if target.starts_with("wiki_") {
|
||||
return Ok(Wiki {
|
||||
name,
|
||||
url, // TODO: insert ref_id here
|
||||
});
|
||||
}
|
||||
if target.starts_with("root_") {
|
||||
// magazine link
|
||||
return Ok(Generic { name, url });
|
||||
}
|
||||
if target.starts_with("crs_") {
|
||||
let ref_id = url.target.as_ref().unwrap().split('_').nth(1).unwrap();
|
||||
url.ref_id = ref_id.to_owned();
|
||||
return Ok(Course { name, url });
|
||||
}
|
||||
if target.starts_with("frm_") {
|
||||
// TODO: extract post link? (this codepath should only be hit when parsing the content tree)
|
||||
let ref_id = url.target.as_ref().unwrap().split('_').nth(1).unwrap();
|
||||
url.ref_id = ref_id.to_owned();
|
||||
return Ok(Forum { name, url });
|
||||
}
|
||||
if target.starts_with("lm_") {
|
||||
// fancy interactive task
|
||||
return Ok(Presentation { name, url });
|
||||
}
|
||||
if target.starts_with("fold_") {
|
||||
let ref_id = url.target.as_ref().unwrap().split('_').nth(1).unwrap();
|
||||
url.ref_id = ref_id.to_owned();
|
||||
return Ok(Folder { name, url });
|
||||
}
|
||||
if target.starts_with("file_") {
|
||||
if !target.ends_with("download") {
|
||||
// download page containing metadata
|
||||
return Ok(Generic { name, url });
|
||||
} else {
|
||||
let mut item_props = item
|
||||
.context("can't construct file object without HTML object")?
|
||||
.select(&ITEM_PROP);
|
||||
let ext = item_props.next().context("cannot find file extension")?;
|
||||
let version = item_props
|
||||
.nth(1)
|
||||
.context("cannot find 3rd file metadata")?
|
||||
.text()
|
||||
.collect::<String>();
|
||||
let version = version.trim();
|
||||
if let Some(v) = version.strip_prefix("Version: ") {
|
||||
name += "_v";
|
||||
name += v;
|
||||
}
|
||||
return Ok(File {
|
||||
name: format!("{}.{}", name, ext.text().collect::<String>().trim()),
|
||||
url,
|
||||
});
|
||||
}
|
||||
}
|
||||
return Ok(Generic { name, url });
|
||||
}
|
||||
|
||||
if url.cmd.as_deref() == Some("showThreads") {
|
||||
return Ok(Forum { name, url });
|
||||
}
|
||||
|
||||
// class name is *sometimes* in CamelCase
|
||||
Ok(match &*url.baseClass.to_ascii_lowercase() {
|
||||
"ilexercisehandlergui" => ExerciseHandler { name, url },
|
||||
"ililwikihandlergui" => Wiki { name, url },
|
||||
"illinkresourcehandlergui" => Weblink { name, url },
|
||||
"ilobjsurveygui" => Survey { name, url },
|
||||
"illmpresentationgui" => Presentation { name, url },
|
||||
"ilrepositorygui" => match url.cmd.as_deref() {
|
||||
Some("view") | Some("render") => Folder { name, url },
|
||||
Some(_) => Generic { name, url },
|
||||
None => Course { name, url },
|
||||
},
|
||||
"ilobjplugindispatchgui" => PluginDispatch { name, url },
|
||||
// both the dashboard and the membership overview page work the same
|
||||
"ildashboardgui" | "ilmembershipoverviewgui" => Dashboard { url },
|
||||
_ => Generic { name, url },
|
||||
})
|
||||
}
|
||||
|
||||
pub(crate) fn is_ignored_by_option(&self, opt: &Opt) -> bool {
|
||||
(matches!(self, Object::Forum { .. }) && !opt.forum)
|
||||
|| (matches!(self, Object::Video { .. }) && opt.no_videos)
|
||||
|| (matches!(self, Object::File { .. }) && opt.skip_files)
|
||||
}
|
||||
}
|
||||
|
||||
#[allow(non_snake_case)]
|
||||
#[derive(Debug)]
|
||||
pub struct URL {
|
||||
pub url: String,
|
||||
baseClass: String,
|
||||
pub cmd: Option<String>,
|
||||
pub thr_pk: Option<String>,
|
||||
pub ref_id: String,
|
||||
target: Option<String>,
|
||||
}
|
||||
|
||||
#[allow(non_snake_case)]
|
||||
impl URL {
|
||||
pub fn raw(url: String) -> Self {
|
||||
URL {
|
||||
url,
|
||||
baseClass: String::new(),
|
||||
cmd: None,
|
||||
thr_pk: None,
|
||||
ref_id: String::new(),
|
||||
target: None,
|
||||
}
|
||||
}
|
||||
|
||||
pub fn from_href(href: &str) -> Result<Self> {
|
||||
let url = if !href.starts_with(ILIAS_URL) {
|
||||
Url::parse(&format!("{}{}", ILIAS_URL, href))?
|
||||
} else {
|
||||
Url::parse(href)?
|
||||
};
|
||||
let mut baseClass = String::new();
|
||||
let mut cmd = None;
|
||||
let mut thr_pk = None;
|
||||
let mut ref_id = String::new();
|
||||
let mut target = None;
|
||||
for (k, v) in url.query_pairs() {
|
||||
match &*k {
|
||||
"baseClass" => baseClass = v.into_owned(),
|
||||
"cmd" => cmd = Some(v.into_owned()),
|
||||
"thr_pk" => thr_pk = Some(v.into_owned()),
|
||||
"ref_id" => ref_id = v.into_owned(),
|
||||
"target" => target = Some(v.into_owned()),
|
||||
_ => {},
|
||||
}
|
||||
}
|
||||
Ok(URL {
|
||||
url: url.into(),
|
||||
baseClass,
|
||||
cmd,
|
||||
thr_pk,
|
||||
ref_id,
|
||||
target,
|
||||
})
|
||||
}
|
||||
}
|
||||
52
src/ilias/course.rs
Normal file
52
src/ilias/course.rs
Normal file
@ -0,0 +1,52 @@
|
||||
use std::{path::PathBuf, sync::Arc};
|
||||
|
||||
use anyhow::{Context, Result};
|
||||
use once_cell::sync::Lazy;
|
||||
use regex::Regex;
|
||||
|
||||
use crate::{
|
||||
process_gracefully,
|
||||
queue::spawn,
|
||||
util::{file_escape, write_file_data},
|
||||
};
|
||||
|
||||
use super::{ILIAS, URL};
|
||||
|
||||
static CMD_NODE_REGEX: Lazy<Regex> = Lazy::new(|| Regex::new(r#"cmdNode=uf:\w\w"#).unwrap());
|
||||
|
||||
pub async fn download(path: PathBuf, ilias: Arc<ILIAS>, url: &URL, name: &str) -> Result<()> {
|
||||
let content = if ilias.opt.content_tree {
|
||||
let html = ilias.download(&url.url).await?.text().await?;
|
||||
let cmd_node = CMD_NODE_REGEX.find(&html).context("can't find cmdNode")?.as_str()[8..].to_owned();
|
||||
let content_tree = ilias.get_course_content_tree(&url.ref_id, &cmd_node).await;
|
||||
match content_tree {
|
||||
Ok(tree) => (tree.into_iter().map(Result::Ok).collect(), None),
|
||||
Err(e) => {
|
||||
// some folders are hidden on the course page and can only be found via the RSS feed / recent activity / content tree sidebar
|
||||
// TODO: this is probably never the case for folders?
|
||||
if html.contains(r#"input[name="cmd[join]""#) {
|
||||
return Ok(()); // ignore groups we are not in
|
||||
}
|
||||
warning!(name, "falling back to incomplete course content extractor!", e);
|
||||
ilias.get_course_content(&url).await? // TODO: perhaps don't download almost the same content 3x
|
||||
},
|
||||
}
|
||||
} else {
|
||||
ilias.get_course_content(&url).await?
|
||||
};
|
||||
if ilias.opt.save_ilias_pages {
|
||||
if let Some(s) = content.1.as_ref() {
|
||||
let path = path.join("course.html");
|
||||
write_file_data(&path, &mut s.as_bytes())
|
||||
.await
|
||||
.context("failed to write course page html")?;
|
||||
}
|
||||
}
|
||||
for item in content.0 {
|
||||
let item = item?;
|
||||
let path = path.join(file_escape(item.name()));
|
||||
let ilias = Arc::clone(&ilias);
|
||||
spawn(process_gracefully(ilias, path, item));
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
66
src/ilias/exercise.rs
Normal file
66
src/ilias/exercise.rs
Normal file
@ -0,0 +1,66 @@
|
||||
use std::{collections::HashSet, path::Path, sync::Arc};
|
||||
|
||||
use anyhow::{Context, Result};
|
||||
use once_cell::sync::Lazy;
|
||||
use scraper::Selector;
|
||||
|
||||
use crate::{process_gracefully, queue::spawn, util::file_escape};
|
||||
|
||||
use super::{Object, ILIAS, URL};
|
||||
|
||||
static LINKS: Lazy<Selector> = Lazy::new(|| Selector::parse("a").unwrap());
|
||||
static FORM_GROUP: Lazy<Selector> = Lazy::new(|| Selector::parse(".form-group").unwrap());
|
||||
static FORM_NAME: Lazy<Selector> = Lazy::new(|| Selector::parse(".il_InfoScreenProperty").unwrap());
|
||||
|
||||
pub async fn download(path: &Path, ilias: Arc<ILIAS>, url: &URL) -> Result<()> {
|
||||
let html = ilias.get_html(&url.url).await?;
|
||||
let mut filenames = HashSet::new();
|
||||
for row in html.select(&FORM_GROUP) {
|
||||
let link = row.select(&LINKS).next();
|
||||
if link.is_none() {
|
||||
continue;
|
||||
}
|
||||
let link = link.unwrap();
|
||||
let href = link.value().attr("href");
|
||||
if href.is_none() {
|
||||
continue;
|
||||
}
|
||||
let href = href.unwrap();
|
||||
let url = URL::from_href(href)?;
|
||||
let cmd = url.cmd.as_deref().unwrap_or("");
|
||||
if cmd != "downloadFile" && cmd != "downloadGlobalFeedbackFile" && cmd != "downloadFeedbackFile" {
|
||||
continue;
|
||||
}
|
||||
// link is definitely just a download link to the exercise or the solution
|
||||
let name = row
|
||||
.select(&FORM_NAME)
|
||||
.next()
|
||||
.context("link without file name")?
|
||||
.text()
|
||||
.collect::<String>()
|
||||
.trim()
|
||||
.to_owned();
|
||||
let item = Object::File { url, name };
|
||||
let mut path = path.to_owned();
|
||||
// handle files with the same name
|
||||
let filename = file_escape(item.name());
|
||||
let mut parts = filename.rsplitn(2, '.');
|
||||
let extension = parts.next().unwrap_or(&filename);
|
||||
let name = parts.next().unwrap_or("");
|
||||
let mut unique_filename = filename.clone();
|
||||
let mut i = 1;
|
||||
while filenames.contains(&unique_filename) {
|
||||
i += 1;
|
||||
if name.is_empty() {
|
||||
unique_filename = format!("{}{}", extension, i);
|
||||
} else {
|
||||
unique_filename = format!("{}{}.{}", name, i, extension);
|
||||
}
|
||||
}
|
||||
filenames.insert(unique_filename.clone());
|
||||
path.push(unique_filename);
|
||||
let ilias = Arc::clone(&ilias);
|
||||
spawn(process_gracefully(ilias, path, item));
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
22
src/ilias/file.rs
Normal file
22
src/ilias/file.rs
Normal file
@ -0,0 +1,22 @@
|
||||
use std::{path::Path, sync::Arc};
|
||||
|
||||
use anyhow::Result;
|
||||
use tokio::fs;
|
||||
|
||||
use crate::util::write_stream_to_file;
|
||||
|
||||
use super::{ILIAS, URL};
|
||||
|
||||
pub async fn download(path: &Path, relative_path: &Path, ilias: Arc<ILIAS>, url: &URL) -> Result<()> {
|
||||
if ilias.opt.skip_files {
|
||||
return Ok(());
|
||||
}
|
||||
if !ilias.opt.force && fs::metadata(&path).await.is_ok() {
|
||||
log!(2, "Skipping download, file exists already");
|
||||
return Ok(());
|
||||
}
|
||||
let data = ilias.download(&url.url).await?;
|
||||
log!(0, "Writing {}", relative_path.to_string_lossy());
|
||||
write_stream_to_file(&path, data.bytes_stream()).await?;
|
||||
Ok(())
|
||||
}
|
||||
32
src/ilias/folder.rs
Normal file
32
src/ilias/folder.rs
Normal file
@ -0,0 +1,32 @@
|
||||
use std::{path::Path, sync::Arc};
|
||||
|
||||
use anyhow::{Context, Result};
|
||||
|
||||
use crate::{
|
||||
process_gracefully,
|
||||
queue::spawn,
|
||||
util::{file_escape, write_file_data},
|
||||
};
|
||||
|
||||
use super::{ILIAS, URL};
|
||||
|
||||
pub async fn download(path: &Path, ilias: Arc<ILIAS>, url: &URL) -> Result<()> {
|
||||
let content = ilias.get_course_content(&url).await?;
|
||||
if ilias.opt.save_ilias_pages {
|
||||
if let Some(s) = content.1.as_ref() {
|
||||
let path = path.join("folder.html");
|
||||
write_file_data(&path, &mut s.as_bytes())
|
||||
.await
|
||||
.context("failed to write folder page html")?;
|
||||
}
|
||||
}
|
||||
for item in content.0 {
|
||||
let item = item?;
|
||||
let path = path.join(file_escape(
|
||||
ilias.course_names.get(item.name()).map(|x| &**x).unwrap_or(item.name()),
|
||||
));
|
||||
let ilias = Arc::clone(&ilias);
|
||||
spawn(process_gracefully(ilias, path, item));
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
100
src/ilias/forum.rs
Normal file
100
src/ilias/forum.rs
Normal file
@ -0,0 +1,100 @@
|
||||
use std::{path::Path, sync::Arc};
|
||||
|
||||
use anyhow::{Context, Result};
|
||||
use once_cell::sync::Lazy;
|
||||
use scraper::{Html, Selector};
|
||||
|
||||
use crate::{ilias::Object, process_gracefully, queue::spawn, util::file_escape};
|
||||
|
||||
use super::{ILIAS, URL};
|
||||
|
||||
static LINKS: Lazy<Selector> = Lazy::new(|| Selector::parse("a").unwrap());
|
||||
static TABLE_HEADER: Lazy<Selector> = Lazy::new(|| Selector::parse("th").unwrap());
|
||||
static TABLE_ROW: Lazy<Selector> = Lazy::new(|| Selector::parse("tr").unwrap());
|
||||
static TABLE_CELLS: Lazy<Selector> = Lazy::new(|| Selector::parse("td").unwrap());
|
||||
|
||||
static FORUM_PAGES: Lazy<Selector> =
|
||||
Lazy::new(|| Selector::parse("div.ilTableNav > table > tbody > tr > td > a").unwrap());
|
||||
|
||||
const NO_ENTRIES: &str = "Keine Einträge";
|
||||
|
||||
pub async fn download(path: &Path, ilias: Arc<ILIAS>, url: &URL) -> Result<()> {
|
||||
if !ilias.opt.forum {
|
||||
return Ok(());
|
||||
}
|
||||
let url = &url.url;
|
||||
let html = {
|
||||
let data = ilias.download(url);
|
||||
let html_text = data.await?.text().await?;
|
||||
let url = {
|
||||
let html = Html::parse_document(&html_text);
|
||||
let thread_count_selector = html
|
||||
.select(&LINKS)
|
||||
.flat_map(|x| x.value().attr("href"))
|
||||
.find(|x| x.contains("trows=800"));
|
||||
if thread_count_selector.is_none() {
|
||||
if let Some(cell) = html.select(&TABLE_CELLS).next() {
|
||||
if cell.text().any(|x| x == NO_ENTRIES) {
|
||||
return Ok(()); // empty forum
|
||||
}
|
||||
}
|
||||
}
|
||||
thread_count_selector
|
||||
.context("can't find forum thread count selector (empty forum?)")?
|
||||
.to_owned()
|
||||
};
|
||||
let data = ilias.download(&url);
|
||||
let html = data.await?.text().await?;
|
||||
Html::parse_document(&html)
|
||||
};
|
||||
for row in html.select(&TABLE_ROW) {
|
||||
if row.value().attr("class") == Some("hidden-print") {
|
||||
continue; // thread count
|
||||
}
|
||||
if row.select(&TABLE_HEADER).next().is_some() {
|
||||
continue;
|
||||
}
|
||||
let cells = row.select(&TABLE_CELLS).collect::<Vec<_>>();
|
||||
if cells.len() != 6 {
|
||||
warning!(format =>
|
||||
"Warning: {}{} {} {}",
|
||||
"unusual table row (", cells.len(), "cells) in", url.to_string()
|
||||
);
|
||||
continue;
|
||||
}
|
||||
let link = cells[1].select(&LINKS).next().context("thread link not found")?;
|
||||
let object = Object::from_link(link, link)?;
|
||||
let mut path = path.to_owned();
|
||||
let name = format!(
|
||||
"{}_{}",
|
||||
object.url().thr_pk.as_ref().context("thr_pk not found for thread")?,
|
||||
link.text().collect::<String>().trim()
|
||||
);
|
||||
path.push(file_escape(&name));
|
||||
// FIXME: this heuristic no longer works after downloading attachments
|
||||
// TODO: set modification date?
|
||||
let saved_posts = {
|
||||
match std::fs::read_dir(&path) {
|
||||
// TODO: make this async
|
||||
Ok(stream) => stream.count(),
|
||||
Err(_) => 0,
|
||||
}
|
||||
};
|
||||
let available_posts = cells[3]
|
||||
.text()
|
||||
.next()
|
||||
.unwrap_or_default()
|
||||
.trim()
|
||||
.parse::<usize>()
|
||||
.context("parsing post count failed")?;
|
||||
if available_posts <= saved_posts && !ilias.opt.force {
|
||||
continue;
|
||||
}
|
||||
let ilias = Arc::clone(&ilias);
|
||||
spawn(process_gracefully(ilias, path, object));
|
||||
}
|
||||
if html.select(&FORUM_PAGES).count() > 0 {
|
||||
log!(0, "Ignoring older threads in {:?}..", path);
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
92
src/ilias/plugin_dispatch.rs
Normal file
92
src/ilias/plugin_dispatch.rs
Normal file
@ -0,0 +1,92 @@
|
||||
use std::{path::Path, sync::Arc};
|
||||
|
||||
use anyhow::{Context, Result};
|
||||
use once_cell::sync::Lazy;
|
||||
use regex::Regex;
|
||||
use reqwest::Url;
|
||||
use scraper::{Html, Selector};
|
||||
|
||||
use crate::{ilias::Object, process_gracefully, queue::spawn, util::file_escape, ILIAS_URL};
|
||||
|
||||
use super::{ILIAS, URL};
|
||||
|
||||
static LINKS: Lazy<Selector> = Lazy::new(|| Selector::parse("a").unwrap());
|
||||
static A_TARGET_BLANK: Lazy<Selector> = Lazy::new(|| Selector::parse(r#"a[target="_blank"]"#).unwrap());
|
||||
static VIDEO_ROWS: Lazy<Selector> = Lazy::new(|| Selector::parse(".ilTableOuter > div > table > tbody > tr").unwrap());
|
||||
static TABLE_CELLS: Lazy<Selector> = Lazy::new(|| Selector::parse("td").unwrap());
|
||||
static LIST_URL: Lazy<Regex> = Lazy::new(|| Regex::new("ilias\\.php\\?ref_id=\\d+&cmdClass=xocteventgui&cmdNode=.{8}q&baseClass=ilObjPluginDispatchGUI&lang=.{2}&limit=20&cmd=asyncGetTableGUI&cmdMode=asynch").unwrap());
|
||||
|
||||
const NO_ENTRIES: &str = "Keine Einträge";
|
||||
|
||||
pub async fn download(path: &Path, ilias: Arc<ILIAS>, url: &URL) -> Result<()> {
|
||||
if ilias.opt.no_videos {
|
||||
return Ok(());
|
||||
}
|
||||
let full_url = {
|
||||
let html = ilias.download(&url.url).await?.text().await?;
|
||||
let list_url = LIST_URL.find(&html).context("failed to find xoct event link")?.as_str();
|
||||
let full_list_url = format!("{}{}", ILIAS_URL, list_url);
|
||||
|
||||
// first find the link to full video list
|
||||
log!(1, "Loading {}", full_list_url);
|
||||
let data = ilias.download(&full_list_url).await?;
|
||||
let html = data.text().await?;
|
||||
let html = Html::parse_fragment(&html);
|
||||
html.select(&LINKS)
|
||||
.filter_map(|link| link.value().attr("href"))
|
||||
.filter(|href| href.contains("trows=800"))
|
||||
.map(|x| x.to_string())
|
||||
.next()
|
||||
.context("video list link not found")?
|
||||
};
|
||||
log!(1, "Rewriting {}", full_url);
|
||||
let mut full_url = Url::parse(&format!("{}{}", ILIAS_URL, full_url))?;
|
||||
let mut query_parameters = full_url
|
||||
.query_pairs()
|
||||
.map(|(x, y)| (x.into_owned(), y.into_owned()))
|
||||
.collect::<Vec<_>>();
|
||||
for (key, value) in &mut query_parameters {
|
||||
match key.as_ref() {
|
||||
"cmd" => *value = "asyncGetTableGUI".into(),
|
||||
"cmdClass" => *value = "xocteventgui".into(),
|
||||
_ => {},
|
||||
}
|
||||
}
|
||||
query_parameters.push(("cmdMode".into(), "asynch".into()));
|
||||
full_url
|
||||
.query_pairs_mut()
|
||||
.clear()
|
||||
.extend_pairs(&query_parameters)
|
||||
.finish();
|
||||
log!(1, "Loading {}", full_url);
|
||||
let data = ilias.download(full_url.as_str()).await?;
|
||||
let html = data.text().await?;
|
||||
let html = Html::parse_fragment(&html);
|
||||
for row in html.select(&VIDEO_ROWS) {
|
||||
let link = row.select(&A_TARGET_BLANK).next();
|
||||
if link.is_none() {
|
||||
if !row.text().any(|x| x == NO_ENTRIES) {
|
||||
warning!(format => "table row without link in {}", url.url);
|
||||
}
|
||||
continue;
|
||||
}
|
||||
let link = link.unwrap();
|
||||
let mut cells = row.select(&TABLE_CELLS);
|
||||
if let Some(title) = cells.nth(2) {
|
||||
let title = title.text().collect::<String>();
|
||||
let title = title.trim();
|
||||
if title.starts_with("<div") {
|
||||
continue;
|
||||
}
|
||||
let mut path = path.to_owned();
|
||||
path.push(format!("{}.mp4", file_escape(title)));
|
||||
log!(1, "Found video: {}", title);
|
||||
let video = Object::Video {
|
||||
url: URL::raw(link.value().attr("href").context("video link without href")?.to_owned()),
|
||||
};
|
||||
let ilias = Arc::clone(&ilias);
|
||||
spawn(process_gracefully(ilias, path, video));
|
||||
}
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
154
src/ilias/thread.rs
Normal file
154
src/ilias/thread.rs
Normal file
@ -0,0 +1,154 @@
|
||||
use std::{path::Path, sync::Arc};
|
||||
|
||||
use anyhow::{anyhow, Context, Result};
|
||||
use once_cell::sync::Lazy;
|
||||
use regex::Regex;
|
||||
use scraper::Selector;
|
||||
|
||||
use crate::{
|
||||
handle_gracefully, process_gracefully,
|
||||
queue::spawn,
|
||||
util::{file_escape, wrap_html, write_file_data},
|
||||
};
|
||||
|
||||
use super::{Object, ILIAS, URL};
|
||||
|
||||
static LINKS: Lazy<Selector> = Lazy::new(|| Selector::parse("a").unwrap());
|
||||
static IMAGES: Lazy<Selector> = Lazy::new(|| Selector::parse("img").unwrap());
|
||||
static TABLES: Lazy<Selector> = Lazy::new(|| Selector::parse("table").unwrap());
|
||||
static LINK_IN_TABLE: Lazy<Selector> = Lazy::new(|| Selector::parse("tbody tr td a").unwrap());
|
||||
static POST_ROW: Lazy<Selector> = Lazy::new(|| Selector::parse(".ilFrmPostRow").unwrap());
|
||||
static POST_TITLE: Lazy<Selector> = Lazy::new(|| Selector::parse(".ilFrmPostTitle").unwrap());
|
||||
static POST_CONTAINER: Lazy<Selector> = Lazy::new(|| Selector::parse(".ilFrmPostContentContainer").unwrap());
|
||||
static POST_ATTACHMENTS: Lazy<Selector> = Lazy::new(|| Selector::parse(".ilFrmPostAttachmentsContainer").unwrap());
|
||||
static SPAN_SMALL: Lazy<Selector> = Lazy::new(|| Selector::parse("span.small").unwrap());
|
||||
static IMAGE_SRC_REGEX: Lazy<Regex> = Lazy::new(|| Regex::new(r#"\./data/produktiv/mobs/mm_(\d+)/([^?]+).+"#).unwrap());
|
||||
|
||||
pub async fn download(path: &Path, relative_path: &Path, ilias: Arc<ILIAS>, url: &URL) -> Result<()> {
|
||||
if !ilias.opt.forum {
|
||||
return Ok(());
|
||||
}
|
||||
let mut all_images = Vec::new();
|
||||
let mut attachments = Vec::new();
|
||||
{
|
||||
let html = ilias.get_html(&url.url).await?;
|
||||
for post in html.select(&POST_ROW) {
|
||||
let title = post
|
||||
.select(&POST_TITLE)
|
||||
.next()
|
||||
.context("post title not found")?
|
||||
.text()
|
||||
.collect::<String>();
|
||||
let author = post.select(&SPAN_SMALL).next().context("post author not found")?;
|
||||
let author = author.text().collect::<String>();
|
||||
let author = author.trim().split('|').collect::<Vec<_>>();
|
||||
let author = if author.len() == 2 {
|
||||
author[0] // pseudonymous forum
|
||||
} else if author.len() == 3 {
|
||||
if author[1] != "Pseudonym" {
|
||||
author[1]
|
||||
} else {
|
||||
author[0]
|
||||
}
|
||||
} else {
|
||||
return Err(anyhow!("author data in unknown format"));
|
||||
}
|
||||
.trim();
|
||||
let container = post
|
||||
.select(&POST_CONTAINER)
|
||||
.next()
|
||||
.context("post container not found")?;
|
||||
let link = container.select(&LINKS).next().context("post link not found")?;
|
||||
let id = link.value().attr("id").context("no id in thread link")?.to_owned();
|
||||
let name = format!("{}_{}_{}.html", id, author, title.trim());
|
||||
let data = wrap_html(&container.inner_html());
|
||||
let path = path.join(file_escape(&name));
|
||||
let relative_path = relative_path.join(file_escape(&name));
|
||||
spawn(handle_gracefully(async move {
|
||||
log!(0, "Writing {}", relative_path.display());
|
||||
write_file_data(&path, &mut data.as_bytes())
|
||||
.await
|
||||
.context("failed to write forum post")
|
||||
}));
|
||||
let images = container
|
||||
.select(&IMAGES)
|
||||
.map(|x| x.value().attr("src").map(|x| x.to_owned()));
|
||||
for image in images {
|
||||
let image = image.context("no src on image")?;
|
||||
all_images.push((id.clone(), image));
|
||||
}
|
||||
if let Some(container) = container.select(&POST_ATTACHMENTS).next() {
|
||||
for attachment in container.select(&LINKS) {
|
||||
let href = attachment
|
||||
.value()
|
||||
.attr("href")
|
||||
.map(|x| x.to_owned())
|
||||
.context("attachment link without href")?;
|
||||
if href.contains("cmd=deliverZipFile") {
|
||||
continue; // skip downloading all attachments as zip
|
||||
}
|
||||
attachments.push((id.clone(), attachment.text().collect::<String>(), href));
|
||||
}
|
||||
}
|
||||
}
|
||||
// pagination
|
||||
if let Some(pages) = html.select(&TABLES).next() {
|
||||
if let Some(last) = pages.select(&LINK_IN_TABLE).last() {
|
||||
let text = last.text().collect::<String>();
|
||||
if text.trim() == ">>" {
|
||||
// not last page yet
|
||||
let ilias = Arc::clone(&ilias);
|
||||
let next_page = Object::Thread {
|
||||
url: URL::from_href(last.value().attr("href").context("page link not found")?)?,
|
||||
};
|
||||
spawn(process_gracefully(ilias, path.to_owned(), next_page));
|
||||
}
|
||||
} else {
|
||||
log!(
|
||||
0,
|
||||
"Warning: {} {}",
|
||||
"unable to find pagination links in".bright_yellow(),
|
||||
url.url.to_string().bright_yellow()
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
for (id, image) in all_images {
|
||||
let src = URL::from_href(&image)?;
|
||||
let dl = ilias.download(&src.url).await?;
|
||||
let mut path = path.to_owned();
|
||||
let file_name = if let Some(m) = IMAGE_SRC_REGEX.captures(&image) {
|
||||
// image uploaded to ILIAS
|
||||
let (media_id, filename) = (m.get(1).unwrap().as_str(), m.get(2).unwrap().as_str());
|
||||
file_escape(&format!("{}_{}_{}", id, media_id, filename))
|
||||
} else {
|
||||
// external image
|
||||
file_escape(&format!("{}_{}", id, image))
|
||||
};
|
||||
path.push(&file_name);
|
||||
let relative_path = relative_path.join(file_name);
|
||||
spawn(handle_gracefully(async move {
|
||||
let bytes = dl.bytes().await?;
|
||||
log!(0, "Writing {}", relative_path.display());
|
||||
write_file_data(&path, &mut &*bytes)
|
||||
.await
|
||||
.context("failed to write forum post image attachment")
|
||||
}));
|
||||
}
|
||||
for (id, name, url) in attachments {
|
||||
let src = URL::from_href(&url)?;
|
||||
let dl = ilias.download(&src.url).await?;
|
||||
let mut path = path.to_owned();
|
||||
let file_name = file_escape(&format!("{}_{}", id, name));
|
||||
path.push(&file_name);
|
||||
let relative_path = relative_path.join(file_name);
|
||||
spawn(handle_gracefully(async move {
|
||||
let bytes = dl.bytes().await?;
|
||||
log!(0, "Writing {}", relative_path.display());
|
||||
write_file_data(&path, &mut &*bytes)
|
||||
.await
|
||||
.context("failed to write forum post file attachment")
|
||||
}));
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
134
src/ilias/video.rs
Normal file
134
src/ilias/video.rs
Normal file
@ -0,0 +1,134 @@
|
||||
use std::{
|
||||
path::{Path, PathBuf},
|
||||
process::Stdio,
|
||||
sync::Arc,
|
||||
};
|
||||
|
||||
use anyhow::{Context, Result};
|
||||
use once_cell::sync::Lazy;
|
||||
use regex::Regex;
|
||||
use tempfile::tempdir;
|
||||
use tokio::{fs, process::Command};
|
||||
|
||||
use crate::{util::write_stream_to_file, ILIAS_URL};
|
||||
|
||||
use super::{ILIAS, URL};
|
||||
|
||||
static XOCT_REGEX: Lazy<Regex> =
|
||||
Lazy::new(|| Regex::new(r#"(?m)<script>\s+xoctPaellaPlayer\.init\(([\s\S]+)\)\s+</script>"#).unwrap());
|
||||
|
||||
pub async fn download(path: &Path, relative_path: &Path, ilias: Arc<ILIAS>, url: &URL) -> Result<()> {
|
||||
if ilias.opt.no_videos {
|
||||
return Ok(());
|
||||
}
|
||||
if fs::metadata(&path).await.is_ok() && !(ilias.opt.force || ilias.opt.check_videos) {
|
||||
log!(2, "Skipping download, file exists already");
|
||||
return Ok(());
|
||||
}
|
||||
let url = format!("{}{}", ILIAS_URL, url.url);
|
||||
let data = ilias.download(&url);
|
||||
let html = data.await?.text().await?;
|
||||
log!(2, "{}", html);
|
||||
let json: serde_json::Value = {
|
||||
let mut json_capture = XOCT_REGEX.captures_iter(&html);
|
||||
let json = &json_capture.next().context("xoct player json not found")?[1];
|
||||
log!(2, "{}", json);
|
||||
let json = json.split(",\n").next().context("invalid xoct player json")?;
|
||||
serde_json::from_str(&json.trim())?
|
||||
};
|
||||
log!(2, "{}", json);
|
||||
let streams = json
|
||||
.get("streams")
|
||||
.context("video streams not found")?
|
||||
.as_array()
|
||||
.context("video streams not an array")?;
|
||||
if streams.len() == 1 {
|
||||
let url = streams[0]
|
||||
.pointer("/sources/mp4/0/src")
|
||||
.context("video src not found")?
|
||||
.as_str()
|
||||
.context("video src not string")?;
|
||||
download_to_path(&ilias, path, relative_path, url).await?;
|
||||
} else {
|
||||
if !ilias.opt.combine_videos {
|
||||
fs::create_dir(path).await.context("failed to create video directory")?;
|
||||
download_all(path, streams, ilias, relative_path).await?;
|
||||
} else {
|
||||
let dir = tempdir()?;
|
||||
// construct ffmpeg command to combine all files
|
||||
let mut arguments = vec![];
|
||||
for file in download_all(dir.path(), streams, ilias, relative_path).await? {
|
||||
arguments.push("-i".to_owned());
|
||||
arguments.push(file.to_str().context("invalid UTF8")?.into());
|
||||
}
|
||||
arguments.push("-c".into());
|
||||
arguments.push("copy".into());
|
||||
for i in 0..(arguments.len() / 2) - 1 {
|
||||
arguments.push("-map".into());
|
||||
arguments.push(format!("{}", i));
|
||||
}
|
||||
arguments.push(path.to_str().context("invalid UTF8 in path")?.into());
|
||||
let status = Command::new("ffmpeg")
|
||||
.args(&arguments)
|
||||
.stderr(Stdio::null())
|
||||
.stdout(Stdio::null())
|
||||
.spawn()
|
||||
.context("failed to start ffmpeg")?
|
||||
.wait()
|
||||
.await
|
||||
.context("failed to wait for ffmpeg")?;
|
||||
if !status.success() {
|
||||
error!(format!("ffmpeg failed to merge video files into {}", path.display()));
|
||||
error!(format!("check this directory: {}", dir.into_path().display()));
|
||||
error!(format!("ffmpeg command: {}", arguments.join(" ")));
|
||||
}
|
||||
};
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
async fn download_all(
|
||||
path: &Path,
|
||||
streams: &Vec<serde_json::Value>,
|
||||
ilias: Arc<ILIAS>,
|
||||
relative_path: &Path,
|
||||
) -> Result<Vec<PathBuf>> {
|
||||
let mut paths = Vec::new();
|
||||
for (i, stream) in streams.into_iter().enumerate() {
|
||||
let url = stream
|
||||
.pointer("/sources/mp4/0/src")
|
||||
.context("video src not found")?
|
||||
.as_str()
|
||||
.context("video src not string")?;
|
||||
let new_path = path.join(format!("Stream{}.mp4", i + 1));
|
||||
download_to_path(
|
||||
&ilias,
|
||||
&new_path,
|
||||
&relative_path.join(format!("Stream{}.mp4", i + 1)),
|
||||
url,
|
||||
)
|
||||
.await?;
|
||||
paths.push(new_path);
|
||||
}
|
||||
Ok(paths)
|
||||
}
|
||||
|
||||
async fn download_to_path(ilias: &ILIAS, path: &Path, relative_path: &Path, url: &str) -> Result<()> {
|
||||
let meta = fs::metadata(&path).await;
|
||||
if !ilias.opt.force && meta.is_ok() && ilias.opt.check_videos {
|
||||
let head = ilias.head(url).await.context("HEAD request failed")?;
|
||||
if let Some(len) = head.headers().get("content-length") {
|
||||
if meta?.len() != len.to_str()?.parse::<u64>()? {
|
||||
warning!(
|
||||
relative_path.to_string_lossy(),
|
||||
"was updated, consider moving the outdated file"
|
||||
);
|
||||
}
|
||||
}
|
||||
} else {
|
||||
let resp = ilias.download(&url).await?;
|
||||
log!(0, "Writing {}", relative_path.to_string_lossy());
|
||||
write_stream_to_file(&path, resp.bytes_stream()).await?;
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
70
src/ilias/weblink.rs
Normal file
70
src/ilias/weblink.rs
Normal file
@ -0,0 +1,70 @@
|
||||
use std::{path::Path, sync::Arc};
|
||||
|
||||
use anyhow::{Context, Result};
|
||||
use once_cell::sync::Lazy;
|
||||
use scraper::Selector;
|
||||
use tokio::fs;
|
||||
|
||||
use crate::{
|
||||
util::{create_dir, file_escape, write_file_data},
|
||||
ILIAS_URL,
|
||||
};
|
||||
|
||||
use super::{ILIAS, URL};
|
||||
|
||||
static LINKS: Lazy<Selector> = Lazy::new(|| Selector::parse("a").unwrap());
|
||||
|
||||
pub async fn download(path: &Path, relative_path: &Path, ilias: Arc<ILIAS>, url: &URL) -> Result<()> {
|
||||
if !ilias.opt.force && fs::metadata(&path).await.is_ok() {
|
||||
log!(2, "Skipping download, link exists already");
|
||||
return Ok(());
|
||||
}
|
||||
let head_req_result = ilias.head(&url.url).await;
|
||||
let url = match &head_req_result {
|
||||
Err(e) => e.url().context("HEAD request failed")?.as_str(),
|
||||
Ok(head) => head.url().as_str(),
|
||||
};
|
||||
if url.starts_with(ILIAS_URL) {
|
||||
// is a link list
|
||||
if fs::metadata(&path).await.is_err() {
|
||||
create_dir(&path).await?;
|
||||
log!(0, "Writing {}", relative_path.to_string_lossy());
|
||||
}
|
||||
|
||||
let urls = {
|
||||
let html = ilias.get_html(url).await?;
|
||||
html.select(&LINKS)
|
||||
.filter_map(|x| x.value().attr("href").map(|y| (y, x.text().collect::<String>())))
|
||||
.map(|(x, y)| {
|
||||
URL::from_href(x)
|
||||
.map(|z| (z, y.trim().to_owned()))
|
||||
.context("parsing weblink")
|
||||
})
|
||||
.collect::<Result<Vec<_>>>()
|
||||
}?;
|
||||
|
||||
for (url, name) in urls {
|
||||
if url.cmd.as_deref().unwrap_or("") != "callLink" {
|
||||
continue;
|
||||
}
|
||||
|
||||
let head = ilias
|
||||
.head(url.url.as_str())
|
||||
.await
|
||||
.context("HEAD request to web link failed");
|
||||
if let Some(err) = head.as_ref().err() {
|
||||
warning!(err);
|
||||
continue;
|
||||
}
|
||||
let head = head.unwrap();
|
||||
let url = head.url().as_str();
|
||||
write_file_data(path.join(file_escape(&name)), &mut url.as_bytes()).await?;
|
||||
}
|
||||
} else {
|
||||
log!(0, "Writing {}", relative_path.to_string_lossy());
|
||||
write_file_data(&path, &mut url.as_bytes())
|
||||
.await
|
||||
.context("failed to save weblink URL")?;
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
1218
src/main.rs
1218
src/main.rs
File diff suppressed because it is too large
Load Diff
42
src/queue.rs
Normal file
42
src/queue.rs
Normal file
@ -0,0 +1,42 @@
|
||||
use futures::Future;
|
||||
use futures_channel::mpsc::{UnboundedReceiver, UnboundedSender};
|
||||
use once_cell::sync::{Lazy, OnceCell};
|
||||
use tokio::{
|
||||
sync::{Semaphore, SemaphorePermit},
|
||||
task::{self, JoinHandle},
|
||||
time,
|
||||
};
|
||||
|
||||
/// Global job queue
|
||||
static TASKS: OnceCell<UnboundedSender<JoinHandle<()>>> = OnceCell::new();
|
||||
static TASKS_RUNNING: Lazy<Semaphore> = Lazy::new(|| Semaphore::new(0));
|
||||
static REQUEST_TICKETS: Lazy<Semaphore> = Lazy::new(|| Semaphore::new(0));
|
||||
|
||||
pub async fn get_request_ticket() {
|
||||
REQUEST_TICKETS.acquire().await.unwrap().forget();
|
||||
}
|
||||
|
||||
pub async fn get_ticket() -> SemaphorePermit<'static> {
|
||||
TASKS_RUNNING.acquire().await.unwrap()
|
||||
}
|
||||
|
||||
pub fn spawn(e: impl Future<Output = ()> + Send + 'static) {
|
||||
TASKS.get().unwrap().unbounded_send(task::spawn(e)).unwrap();
|
||||
}
|
||||
|
||||
pub fn set_download_rate(rate: usize) {
|
||||
task::spawn(async move {
|
||||
let mut interval = time::interval(time::Duration::from_secs_f64(60.0 / rate as f64));
|
||||
loop {
|
||||
interval.tick().await;
|
||||
REQUEST_TICKETS.add_permits(1);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
pub fn set_parallel_jobs(jobs: usize) -> UnboundedReceiver<JoinHandle<()>> {
|
||||
let (tx, rx) = futures_channel::mpsc::unbounded::<JoinHandle<()>>();
|
||||
TASKS.get_or_init(|| tx.clone());
|
||||
TASKS_RUNNING.add_permits(jobs);
|
||||
rx
|
||||
}
|
||||
46
src/util.rs
46
src/util.rs
@ -1,16 +1,43 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
use anyhow::Context;
|
||||
use bytes::Bytes;
|
||||
use futures::TryStreamExt;
|
||||
use tokio::fs::File as AsyncFile;
|
||||
use tokio::io::{AsyncRead, BufWriter};
|
||||
use tokio_util::io::StreamReader;
|
||||
|
||||
use std::io;
|
||||
use std::path::Path;
|
||||
|
||||
use super::Result;
|
||||
use crate::{Result, ILIAS_URL};
|
||||
|
||||
pub async fn write_file_data<R: ?Sized>(path: &Path, data: &mut R) -> Result<()>
|
||||
where R: AsyncRead + Unpin {
|
||||
let file = AsyncFile::create(&path).await.context("failed to create file")?;
|
||||
/// Prepends a doctype and a base URL to the HTML fragment.
|
||||
pub fn wrap_html(html_fragment: &str) -> String {
|
||||
format!("<!DOCTYPE html>\n<base href=\"{}\">{}", ILIAS_URL, html_fragment)
|
||||
}
|
||||
|
||||
pub async fn write_stream_to_file(
|
||||
path: &Path,
|
||||
stream: impl futures::Stream<Item = Result<Bytes, reqwest::Error>> + Unpin,
|
||||
) -> Result<()> {
|
||||
let mut reader = StreamReader::new(stream.map_err(|x| io::Error::new(io::ErrorKind::Other, x)));
|
||||
write_file_data(&path, &mut reader).await?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Write all data to the specified path. Will overwrite previous file data.
|
||||
pub async fn write_file_data<R: ?Sized>(path: impl AsRef<Path>, data: &mut R) -> Result<()>
|
||||
where
|
||||
R: AsyncRead + Unpin,
|
||||
{
|
||||
let file = AsyncFile::create(path.as_ref())
|
||||
.await
|
||||
.context("failed to create file")?;
|
||||
let mut file = BufWriter::new(file);
|
||||
tokio::io::copy(data, &mut file).await.context("failed to write to file")?;
|
||||
tokio::io::copy(data, &mut file)
|
||||
.await
|
||||
.context("failed to write to file")?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
@ -23,3 +50,12 @@ pub async fn create_dir(path: &Path) -> Result<()> {
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[cfg(not(target_os = "windows"))]
|
||||
const INVALID: &[char] = &['/', '\\'];
|
||||
#[cfg(target_os = "windows")]
|
||||
const INVALID: &[char] = &['/', '\\', ':', '<', '>', '"', '|', '?', '*'];
|
||||
|
||||
pub fn file_escape(s: &str) -> String {
|
||||
s.replace(INVALID, "-")
|
||||
}
|
||||
|
||||
Loading…
Reference in New Issue
Block a user