mirror of https://github.com/FliegendeWurst/KIT-ILIAS-downloader.git synced 2024-08-28 04:04:18 +00:00

Downloader for https://ilias.studium.kit.edu/

Go to file

Maximilian Bosch 8131acc75a pass login: Only use first line from result It's possible to create multi-line entries in `pass(1)` where additional lines have further metadata, e.g. $ pass show kit-access <secret pw> user: uXXXX which can be helpful to persist e.g. the corresponding username. However it's a convention that the password is only in the first line, e.g. `pass show -c` (which is used by `passmenu` to copy a secret into the clipboard) only the first line is used by default. I switched to such an approach recently and realized that this is now a problem because `KIT-ILIAS-Downloader` passes the entire string to the SAML login, so I decided to just strip everything after the first line in the output of `pass show`. We may want to implement support for extracting usernames from such a format in the future, but... that's an exercise left for the reader ;-)		2022-08-06 14:33:33 +02:00
.github/workflows	CI: Remove unneeded dbus installation	2022-01-06 16:01:47 +01:00
src	pass login: Only use first line from result	2022-08-06 14:33:33 +02:00
.gitignore	Initial commit	2020-04-21 22:41:28 +02:00
build.sh	build script: require up to date lock file	2021-06-04 10:13:33 +02:00
Cargo.lock	Update dependencies	2022-07-11 10:21:51 +02:00
Cargo.toml	Update dependencies	2022-07-11 10:21:51 +02:00
CHANGELOG.md	Update readme and changelog	2022-07-11 10:22:47 +02:00
LICENSE	Update dependencies and license	2021-05-28 13:21:49 +02:00
README.md	Update readme and changelog	2022-07-11 10:22:47 +02:00
rustfmt.toml	Split downloading logic into modules	2021-06-02 11:13:13 +02:00
shell.nix	Basic shell.nix	2021-05-13 13:29:18 +02:00

README.md

KIT-ILIAS-downloader

Download content from ILIAS. That includes:

files
exercise sheets and solutions
Opencast lectures
forum posts

Installation

Windows/Linux users: go to the releases and download the executable for your operating system.
macOS users: Install Rust and compile from source:

$ cargo install --all-features --git 'https://github.com/FliegendeWurst/KIT-ILIAS-downloader'

Usage

First, open a terminal. Navigate to the directory that contains the downloaded binary.

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 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 0.3.5

USAGE:
    KIT-ILIAS-downloader [FLAGS] [OPTIONS] --output <output>

FLAGS:
        --all                 Download all courses
        --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
        --pass-path <pass-path>    Path inside `pass(1)` to the password for your KIT account
    -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 output directory)

# example 1: only download a single course
/*/
!/InsertCourseHere/
# example 2: only download files related to one tutorial
/Course/Tutorien/*/
!/Course/Tutorien/Tut* 3/

Credentials

You can use the --user and --keyring options to get/store the password using the system password store:

$ KIT-ILIAS-downloader -U uabcd --keyring [...]

If you use pass, you can use the --pass-path option to specify which password store entry to use:

$ KIT-ILIAS-downloader -U uabcd --pass-path edu/kit/uskyk [...]

You can also save your username and password in a .iliaslogin file: (located in the output folder)

username
password

When running the downloader multiple times in a short period of time, you may want to use the --keep-session flag. If specified, the downloader will save and restore session cookies (.iliassession file in the output directory).

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"

README.md Unescape Escape