Merge video progress bar to master

* Reduce API calls

* Fix video id

* Updated `createVideoTag()` description.

* Fixed URL used for cast integration

* Check video duration

* Updates progress bar on watched and close.

* Set progress bar width to 0% by default

* Cleanup, function descriptions

* Cleanup console logging

* Update progress bar on cast progress every 10s

* Catch short <30s videos and mark as watched

.dockerignore

@@ -17,5 +17,8 @@ venv/
 # Unneeded graphics
 assets/*
 
+# Unneeded docs
+docs/*
+
 # for local testing only
 testing.sh

.github/workflows/lint_python.yml

@@ -0,0 +1,22 @@
+name: lint_python
+on: [pull_request, push]
+jobs:
+  lint_python:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+      - run: pip install --upgrade pip wheel
+      - run: pip install bandit black codespell flake8 flake8-bugbear
+                         flake8-comprehensions isort
+      - run: black --check --diff --line-length 79 .
+      - run: codespell
+      - run: flake8 . --count --max-complexity=12 --max-line-length=79
+                      --show-source --statistics
+      - run: isort --check-only --line-length 79 --profile black .
+      # - run: pip install -r tubearchivist/requirements.txt
+      # - run: mkdir --parents --verbose .mypy_cache
+      # - run: mypy --ignore-missing-imports --install-types --non-interactive .
+      # - run: python3 tubearchivist/manage.py test || true
+      # - run: shopt -s globstar && pyupgrade --py36-plus **/*.py || true
+      # - run: safety check

.gitignore

@@ -4,5 +4,5 @@ __pycache__
 # django testing db
 db.sqlite3
 
-# frontend fonts
-*ttf.woff
+# vscode custom conf
+.vscode

.vscode/settings.json

@@ -1,5 +0,0 @@
-{
-    "python.linting.pylintEnabled": true,
-    "python.linting.pycodestyleEnabled": false,
-    "python.linting.enabled": true
-}

CONTRIBUTING.md

@@ -0,0 +1,62 @@
+## Contributing to Tube Archivist
+
+Welcome, and thanks for showing interest in improving Tube Archivist!  
+If you haven't already, the best place to start is the README. This will give you an overview on what the project is all about.
+
+## Report a bug
+
+If you notice something is not working as expected, check to see if it has been previously reported in the [open issues](https://github.com/bbilly1/tubearchivist/issues).
+If it has not yet been disclosed, go ahead and create an issue.  
+If the issue doesn't move forward due to a lack of response, I assume it's solved and will close it after some time to keep the list fresh. 
+
+## Wiki
+
+The wiki is where all user functions are explained in detail. These pages are mirrored into the **docs** folder of the repo. This allows for pull requests and all other features like regular code. Make any changes there, and I'll sync them with the wiki tab.
+
+## Development Environment
+
+I have learned the hard way, that working on a dockerized application outside of docker is very error prone and in general not a good idea. So if you want to test your changes, it's best to run them in a docker testing environment.  
+
+This is my setup I have landed on, YMMV:
+- Clone the repo, work on it with your favorite code editor in your local filesystem. *testing* branch is the where all the changes are happening, might be unstable and is WIP.
+- Then I have a VM on KVM hypervisor running standard Ubuntu Server LTS with docker installed. The VM keeps my projects separate and offers convenient snapshot functionality. The VM also offers ways to simulate lowend environments by limiting CPU cores and memory. But you could also just run docker on your host system.
+- The `Dockerfile` is structured in a way that the actual application code is in the last layer so rebuilding the image with only code changes utilizes the build cache for everything else and will just take a few seconds.
+- Take a look at the `deploy.sh` file. I have my local DNS resolve `tubearchivist.local` to the IP of the VM for convenience. To deploy the latest changes and rebuild the application to the testing VM run:
+```bash
+./deploy.sh test
+```
+- The command above will also copy the file `tubarchivist/testing.sh` into the working folder of the container. Running this script will install additional debugging tools I regularly use in testing. 
+- The `test` argument takes another optional argument to build for a specific architecture valid options are: `amd64`, `arm64` and `multi`, default is `amd64`.
+- This `deploy.sh` file is not meant to be universally usable for every possible environment but could serve as an idea on how to automatically rebuild containers to test changes - customize to your liking. 
+
+## Working with Elasticsearch
+Additionally to the required services as listed in the example docker-compose file, the **Dev Tools** of [Kibana](https://www.elastic.co/guide/en/kibana/current/docker.html) are invaluable for running and testing Elasticsearch queries.  
+
+If you want to run queries in on the Elasticsearch container directly from your host with for example `curl` or something like *postman*, you might want to **publish** the port 9200 instead of just **exposing** it.
+
+## Implementing a new feature
+
+Do you see anything on the roadmap that you would like to take a closer look at but you are not sure, what's the best way to tackle that? Or anything not on there yet you'd like to implement but are not sure how? Open up an issue and we try to find a solution together.
+
+## Making changes
+
+To fix a bug or implement a feature, fork the repository and make all changes to the testing branch. When ready, create a pull request.
+
+## Releases
+
+There are three different docker tags:
+- **latest**: As the name implies is the latest multiarch release for regular usage.
+- **unstable**: Intermediate amd64 builds for quick testing and improved collaboration. Don't mix with a *latest* installation, for your testing environment only. This is untested and WIP and will have breaking changes between commits that might require a reset to resolve. 
+- **semantic versioning**: There will be a handful named version tags that will also have a matching release and tag on github.
+
+If you want to see what's in your container, checkout the matching release tag. A merge to **master** usually means a *latest* or *unstable* release. If you want to preview changes in your testing environment, pull the *unstable* tag or clone the repository and build the docker container with the Dockerfile from the **testing** branch.
+
+## Code formatting and linting
+
+To keep things clean and consistent for everybody, there is a github action setup to lint and check the changes. You can test your code locally first if you want. For example if you made changes in the **download** module, run
+
+```shell
+./deploy.sh validate tubearchivist/home/src/download.py
+```
+
+to validate your changes. If you omit the path, all the project files will get checked. This is subject to change as the codebase improves. 

Dockerfile

@@ -1,18 +1,30 @@
 # build the tube archivist image from default python slim image
 
-FROM python:3.9.7-slim-bullseye
+FROM python:3.10.2-slim-bullseye
+ARG TARGETPLATFORM
 
 ENV PYTHONUNBUFFERED 1
 
 # install distro packages needed
 RUN apt-get clean && apt-get -y update && apt-get -y install --no-install-recommends \
     build-essential \
-    ffmpeg \
     nginx \
+    atomicparsley \
     curl && rm -rf /var/lib/apt/lists/*
 
-# copy config files
-COPY nginx.conf /etc/nginx/conf.d/
+# get newest patched ffmpeg and ffprobe builds for amd64 fall back to repo ffmpeg for arm64
+RUN if [ "$TARGETPLATFORM" = "linux/amd64" ] ; then \
+    curl -s https://api.github.com/repos/yt-dlp/FFmpeg-Builds/releases/latest \
+        | grep browser_download_url \
+        | grep ".*master.*linux64.*tar.xz" \
+        | cut -d '"' -f 4 \
+        | xargs curl -L --output ffmpeg.tar.xz && \
+        tar -xf ffmpeg.tar.xz --strip-components=2 --no-anchored -C /usr/bin/ "ffmpeg" && \
+        tar -xf ffmpeg.tar.xz --strip-components=2 --no-anchored -C /usr/bin/ "ffprobe" && \
+        rm ffmpeg.tar.xz \
+    ; elif [ "$TARGETPLATFORM" = "linux/arm64" ] ; then \
+        apt-get -y update && apt-get -y install --no-install-recommends ffmpeg && rm -rf /var/lib/apt/lists/* \
+    ; fi
 
 # make folders
 RUN mkdir /cache
@@ -23,10 +35,13 @@ RUN mkdir /app
 COPY ./tubearchivist/requirements.txt /requirements.txt
 RUN pip install --no-cache-dir -r requirements.txt --src /usr/local/src
 
+# copy config files
+COPY docker_assets/nginx.conf /etc/nginx/conf.d/
+
 # copy application into container
 COPY ./tubearchivist /app
-COPY ./run.sh /app
-COPY ./uwsgi.ini /app
+COPY ./docker_assets/run.sh /app
+COPY ./docker_assets/uwsgi.ini /app
 
 # volumes
 VOLUME /cache

README.md

@@ -1,10 +1,24 @@
 ![Tube Archivist](assets/tube-archivist-banner.jpg?raw=true "Tube Archivist Banner")  
 
-<center><h1>Your self hosted Youtube media server</h1></center>
+<center><h1>Your self hosted YouTube media server</h1></center>
 
+## Table of contents:
+* [Wiki](https://github.com/bbilly1/tubearchivist/wiki) for a detailed documentation, with [FAQ](https://github.com/bbilly1/tubearchivist/wiki/FAQ)
+* [Core functionality](#core-functionality)
+* [Screenshots](#screenshots)
+* [Problem Tube Archivist tries to solve](#problem-tube-archivist-tries-to-solve)
+* [Connect](#connect)
+* [Installing and updating](#installing-and-updating)
+* [Getting Started](#getting-started)
+* [Potential pitfalls](#potential-pitfalls)
+* [Roadmap](#roadmap)
+* [Known limitations](#known-limitations)
+* [Donate](#donate)
+
+------------------------
 
 ## Core functionality
-* Subscribe to your favourite Youtube channels
+* Subscribe to your favorite YouTube channels
 * Download Videos using **yt-dlp**
 * Index and make videos searchable
 * Play videos
@@ -27,58 +41,65 @@
 *Downloads Page*
   
 ## Problem Tube Archivist tries to solve
-Once your Youtube video collection grows, it becomes hard to search and find a specific video. That's where Tube Archivist comes in: By indexing your video collection with metadata from Youtube, you can organize, search and enjoy your archived Youtube videos without hassle offline through a convenient web interface.
+Once your YouTube video collection grows, it becomes hard to search and find a specific video. That's where Tube Archivist comes in: By indexing your video collection with metadata from YouTube, you can organize, search and enjoy your archived YouTube videos without hassle offline through a convenient web interface.
 
-## Installation
-Take a look at the example `docker-compose.yml` file provided. Tube Archivist depends on three main components split up into separate docker containers:  
+## Connect
+- [Discord](https://discord.gg/AFwz8nE7BK): Connect with us on our brand new Discord server.
+- [r/TubeArchivist](https://www.reddit.com/r/TubeArchivist/): Join our brand new Subreddit.
+
+## Installing and updating
+Take a look at the example `docker-compose.yml` file provided. Use the *latest* or the named semantic version tag. The *unstable* tag is for intermediate testing and as the name implies, is **unstable** and not be used on your main installation but in a [testing environment](CONTRIBUTING.md).  
+
+Tube Archivist depends on three main components split up into separate docker containers:  
 
 ### Tube Archivist
 The main Python application that displays and serves your video collection, built with Django.
   - Serves the interface on port `8000`
-  - Needs a mandatory volume for the video archive at **/youtube**
-  - And another recommended volume to save the cache for thumbnails and artwork at **/cache**.
+  - Needs a volume for the video archive at **/youtube**
+  - And another volume to save application data at **/cache**.
   - The environment variables `ES_URL` and `REDIS_HOST` are needed to tell Tube Archivist where Elasticsearch and Redis respectively are located.
-  - The environment variables `HOST_UID` and `HOST_GID` allows Tube Archivist to `chown` the video files to the main host system user instead of the container user.
+  - The environment variables `HOST_UID` and `HOST_GID` allows Tube Archivist to `chown` the video files to the main host system user instead of the container user. Those two variables are optional, not setting them will disable that functionality. That might be needed if the underlying filesystem doesn't support `chown` like *NFS*. 
+  - Change the environment variables `TA_USERNAME` and `TA_PASSWORD` to create the initial credentials. 
+  - `ELASTIC_PASSWORD` is for the password for Elasticsearch. The environment variable `ELASTIC_USER` is optional, should you want to change the username from the default *elastic*.
+  - For the scheduler to know what time it is, set your timezone with the `TZ` environment variable, defaults to *UTC*.
+
+### Port collisions
+If you have a collision on port `8000`, best solution is to use dockers *HOST_PORT* and *CONTAINER_PORT* distinction: To for example change the interface to port 9000 use `9000:8000` in your docker-compose file.  
+
+Should that not be an option, the Tube Archivist container takes these two additional environment variables:
+- **TA_PORT**: To actually change the port where nginx listens, make sure to also change the ports value in your docker-compose file.
+- **TA_UWSGI_PORT**: To change the default uwsgi port 8080 used for container internal networking between uwsgi serving the django application and nginx.  
+
+Changing any of these two environment variables will change the files *nginx.conf* and *uwsgi.ini* at startup using `sed` in your container.
 
 ### Elasticsearch
-Stores video metadata and makes everything searchable. Also keeps track of the download queue.
+Stores video meta data and makes everything searchable. Also keeps track of the download queue.
   - Needs to be accessible over the default port `9200`
   - Needs a volume at **/usr/share/elasticsearch/data** to store data
 
 Follow the [documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/docker.html) for additional installation details.
 
 ### Redis JSON
-Functions as a cache and temporary link between the application and the filesystem. Used to store and display messages and configuration variables.
+Functions as a cache and temporary link between the application and the file system. Used to store and display messages and configuration variables.
   - Needs to be accessible over the default port `6379`
-  - Takes an optional volume at **/data** to make your configuration changes permanent.
+  - Needs a volume at **/data** to make your configuration changes permanent.
 
-## Getting Started
-1. Go through the **settings** page and look at the available options. Particularly set *Download Format* to your desired video quality before downloading. **Tube Archivist** downloads the best available quality by default.
-2. Subscribe to some of your favourite Youtube channels on the **channels** page. 
-3. On the **downloads** page, click on *Rescan subscriptions* to add videos from the subscribed channels to your Download queue or click on *Add to download queue* to manually add Video IDs, links, channels or playlists.
-4. Click on *Download queue* and let Tube Archivist to it's thing. 
-5. Enjoy your archived collection!
-  
-## Import your existing library
-So far this depends on the video you are trying to import to be still available on youtube to get the metadata. Add the files you like to import to the */cache/import* folder. Then start the process from the settings page *Manual media files import*. Make sure to follow one of the two methods below.
+### Redis on a custom port
+For some architectures it might be required to run Redis JSON on a nonstandard port. To for example change the Redis port to **6380**, set the following values:
+- Set the environment variable `REDIS_PORT=6380` to the *tubearchivist* service.
+- For the *archivist-redis* service, change the ports to `6380:6380`
+- Additionally set the following value to the *archivist-redis* service: `command: --port 6380 --loadmodule /usr/lib/redis/modules/rejson.so`
 
-### Method 1:
-Add a matching *.json* file with the media file. Both files need to have the same base name, for example:
-- For the media file: \<base-name>.mp4
-- For the JSON file: \<base-name>.info.json
-- Alternate JSON file: \<base-name>.json
+### Updating Tube Archivist
+You will see the current version number of **Tube Archivist** in the footer of the interface so you can compare it with the latest release to make sure you are running the *latest and greatest*.  
+* There can be breaking changes between updates, particularly as the application grows, new environment variables or settings might be required for you to set in the your docker-compose file. *Always* check the **release notes**: Any breaking changes will be marked there.  
+* All testing and development is done with the Elasticsearch version number as mentioned in the provided *docker-compose.yml* file. This will be updated when a new release of Elasticsearch is available. Running an older version of Elasticsearch is most likely not going to result in any issues, but it's still recommended to run the same version as mentioned.
 
-**Tube Archivist** then looks for the 'id' key within the JSON file to identify the video.
-
-### Method 2:
-Detect the Youtube ID from filename, this accepts the default yt-dlp naming convention for file names like:
-- \<base-name>[\<youtube-id>].mp4
-- The Youtube ID in square brackets at the end of the filename is the crucial part.
-
-### Some notes:
-- This will **consume** the files you put into the import folder: Files will get converted to mp4 if needed (this might take a long time...) and moved to the archive, *.json* files will get deleted upon completion to avoid having doublicates on the next run.
-- Maybe start with a subset of your files to import to make sure everything goes well...
-- Follow the logs to monitor progress and errors: `docker-compose logs -f tubearchivist`.
+### Alternative installation instructions:
+- **arm64**: The Tube Archivist container is multi arch, so is Elasticsearch. RedisJSON doesn't offer arm builds, you can use `bbilly1/rejson`, an unofficial rebuild for arm64.
+- **Synology**: There is a [discussion thread](https://github.com/bbilly1/tubearchivist/discussions/48) with Synology installation instructions.
+- **Unraid**: The three containers needed are all in the Community Applications. First install `TubeArchivist RedisJSON` followed by `TubeArchivist ES`, and finally you can install `TubeArchivist`. If you have unraid specific issues, report those to the [support thread](https://forums.unraid.net/topic/114073-support-crocs-tube-archivist/ "support thread").
+- **Helm Chart**: There is a Helm Chart available at https://github.com/insuusvenerati/helm-charts. Mostly self-explanatory but feel free to ask questions in the discord / subreddit.
 
 
 ## Potential pitfalls
@@ -103,27 +124,63 @@ chown 1000:0 /path/to/mount/point
 ```
 This will match the permissions with the **UID** and **GID** of elasticsearch within the container and should fix the issue.
 
-## Roadmap
-This should be considered as a **minimal viable product**, there is an extensive list of future functions and improvements planned.
+### Disk usage
+The Elasticsearch index will turn to *read only* if the disk usage of the container goes above 95% until the usage drops below 90% again. Similar to that, TubeArchivist will become all sorts of messed up when running out of disk space. There are some error messages in the logs when that happens, but it's best to make sure to have enough disk space before starting to download.
+
+## Getting Started
+1. Go through the **settings** page and look at the available options. Particularly set *Download Format* to your desired video quality before downloading. **Tube Archivist** downloads the best available quality by default. To support iOS or MacOS and some other browsers a compatible format must be specified. For example:
+```
+bestvideo[VCODEC=avc1]+bestaudio[ACODEC=mp4a]/mp4
+```
+2. Subscribe to some of your favorite YouTube channels on the **channels** page. 
+3. On the **downloads** page, click on *Rescan subscriptions* to add videos from the subscribed channels to your Download queue or click on *Add to download queue* to manually add Video IDs, links, channels or playlists.
+4. Click on *Start download* and let **Tube Archivist** to it's thing. 
+5. Enjoy your archived collection!
+  
+## Roadmap
+We have come far, nonetheless we are not short of ideas on how to improve and extend this project:
 
-### Functionality
-- [ ] Access control
 - [ ] User roles
-- [ ] Delete videos and channel
-- [ ] Create playlists
-- [ ] Backup and restore
 - [ ] Podcast mode to serve channel as mp3
 - [ ] Implement [PyFilesystem](https://github.com/PyFilesystem/pyfilesystem2) for flexible video storage
-- [X] Scan your filesystem to index already downloaded videos [2021-09-14]
-
-### UI
+- [ ] Implement [Apprise](https://github.com/caronc/apprise) for notifications
+- [ ] Add [SponsorBlock](https://sponsor.ajay.app/) integration
+- [ ] Implement per channel settings
+- [ ] User created playlists
+- [ ] Auto play or play next link
+- [ ] SSO / LDAP support
 - [ ] Show similar videos on video page
 - [ ] Multi language support
-- [ ] Grid and list view for both channel and video list pages
 - [ ] Show total video downloaded vs total videos available in channel
+- [ ] Make items in grid row configurable
+- [ ] Add statistics of index
 
+Implemented:
+- [X] Subtitle download & indexing [2022-02-13]
+- [X] Fancy advanced unified search interface [2022-01-08]
+- [X] Auto rescan and auto download on a schedule [2021-12-17]
+- [X] Optional automatic deletion of watched items after a specified time [2021-12-17]
+- [X] Create playlists [2021-11-27]
+- [X] Access control [2021-11-01]
+- [X] Delete videos and channel [2021-10-16]
+- [X] Add thumbnail embed option [2021-10-16]
+- [X] Create a github wiki for user documentation [2021-10-03]
+- [X] Grid and list view for both channel and video list pages [2021-10-03]
+- [X] Un-ignore videos [2021-10-03]
+- [X] Dynamic download queue [2021-09-26]
+- [X] Backup and restore [2021-09-22]
+- [X] Scan your file system to index already downloaded videos [2021-09-14]
 
 ## Known limitations
-- Video files created by Tube Archivist need to be **mp4** video files for best browser compatibility.
+- Video files created by Tube Archivist need to be playable in your browser of choice. Not every codec is compatible with every browser and might require some testing with format selection. 
 - Every limitation of **yt-dlp** will also be present in Tube Archivist. If **yt-dlp** can't download or extract a video for any reason, Tube Archivist won't be able to either.
-- For now this is meant to be run in a trusted network environment.
+- For now this is meant to be run in a trusted network environment. Not everything is properly authenticated.
+- There is currently no flexibility in naming of the media files.
+
+
+## Donate
+The best donation to **Tube Archivist** is your time, take a look at the [contribution page](CONTRIBUTING.md) to get started.  
+Second best way to support the development is to provide for caffeinated beverages:
+* [Paypal.me](https://paypal.me/bbilly1) for a one time coffee
+* [Paypal Subscription](https://www.paypal.com/webapps/billing/plans/subscribe?plan_id=P-03770005GR991451KMFGVPMQ) for a monthly coffee
+* [ko-fi.com](https://ko-fi.com/bbilly1) for an alternative platform

browser_extension/README.md

@@ -0,0 +1,26 @@
+# Tube Archivist Companion
+A browser extension to directly add videos from YouTube to Tube Archivist.
+
+## MVP or better *bearly viable product*
+This is a proof of concept with the following functionality:
+- Add your Tube Archivist connection details in the addon popup
+- Inject a download button into youtube search results page
+- Clicking the button will automatically add the video to the your download queue
+
+## Test this extension
+- Firefox
+  - Open `about:debugging#/runtime/this-firefox`
+  - Click on *Load Temporary Add-on*
+  - Select the *manifest.json* file to load the addon. 
+- Chrome / Chromium
+  - Open `chrome://extensions/`
+  - Toggle *Developer mode* on top right
+  - Click on *Load unpacked*
+  - Open the folder containing the *manifest.json* file.
+
+## Help needed
+This is only minimally useful in this state. Join us on our Discord and please help us improve that.
+
+## Note:
+- For mysterious reasons sometimes the download buttons will only load when refreshing the YouTube search page and not on first load... Hence: Help needed!
+- For your testing environment only for now: Point the extension to the newest *unstable* build.

browser_extension/extension/background.js

@@ -0,0 +1,94 @@
+/*
+extension background script listening for events
+*/
+
+console.log("running background.js");
+
+let browserType = getBrowser();
+
+
+// boilerplate to dedect browser type api
+function getBrowser() {
+    if (typeof chrome !== "undefined") {
+        if (typeof browser !== "undefined") {
+            console.log("detected firefox");
+            return browser;
+        } else {
+            console.log("detected chrome");
+            return chrome;
+        }
+    } else {
+        console.log("failed to dedect browser");
+        throw "browser detection error"
+    };
+}
+
+
+// send post request to API backend
+async function sendPayload(url, token, payload) {
+
+    const rawResponse = await fetch(url, {
+        method: "POST",
+        headers: {
+            "Accept": "application/json",
+            "Content-Type": "application/json",
+            "Authorization": token,
+            "mode": "no-cors"
+        },
+        body: JSON.stringify(payload)
+    });
+
+    const content = await rawResponse.json();
+    return content;
+}
+
+
+// read access storage and send
+function forwardRequest(payload) {
+
+    console.log("running forwardRequest");
+
+    function onGot(item) {
+        console.log(item.access);
+
+        const url = `${item.access.url}:${item.access.port}/api/download/`;
+        console.log(`sending to ${url}`);
+        const token = `Token ${item.access.apiKey}`;
+
+        sendPayload(url, token, payload).then(content => {
+            console.log(content);
+        })
+
+    };
+
+    function onError(error) {
+        console.local("failed to get access details");
+        console.log(`Error: ${error}`);
+    };
+
+    browserType.storage.local.get("access", function(result) {
+        onGot(result)
+    });
+
+}
+
+
+// listen for messages
+browserType.runtime.onMessage.addListener(
+    function(request, sender, sendResponse) {
+        console.log("responding from background.js listener");
+        console.log(JSON.stringify(request));
+        if (request.download) {
+            console.log("found new download task");
+            let payload = {
+                "data": [
+                    {
+                        "youtube_id": request.download["videoId"],
+                        "status": "pending",
+                    }
+                ]
+            }
+            forwardRequest(payload);
+        };
+    }
+);

browser_extension/extension/images/logo.svg

@@ -0,0 +1,102 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Generator: Adobe Illustrator 26.0.2, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
+<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
+	 viewBox="0 0 350 75" style="enable-background:new 0 0 350 75;" xml:space="preserve">
+<style type="text/css">
+	.st0{fill:#FFFFFF;}
+	.st1{fill:#2C9D8A;}
+</style>
+<g id="Layer_1_00000061458428874772671790000018384579824765206440_">
+	<g id="archivist">
+		<path class="st0" d="M218.5,15.2v4.6c-0.7-0.5-1.5-0.8-2.5-0.8c-1.8,0-3,1.4-3.9,3.1v8.9h-4v-16h4v3c1.1-1.9,2.6-3.3,4.5-3.3
+			C217.3,14.7,217.9,14.9,218.5,15.2z"/>
+		<path class="st0" d="M233.6,16.3V20c-1.1-0.8-2.4-1.4-4.4-1.4c-2.4,0-4.5,1.9-4.5,4.5c0,2.6,1.9,4.5,4.5,4.5c2,0,3.3-0.6,4.4-1.4
+			v3.7c-0.9,0.8-2.3,1.6-4.7,1.6c-4.8,0-8.4-3.9-8.4-8.4c0-4.5,3.6-8.5,8.4-8.5C231.3,14.6,232.7,15.6,233.6,16.3z"/>
+		<path class="st0" d="M251.8,21.2v9.8h-4l0-9.3c0-2.2-1.1-3.2-2.9-3.2c-1.4,0-2.7,1.1-3.6,2.3v10.1h-4V8.2h4v9.1
+			c1-1.3,2.7-2.7,4.8-2.7C249.3,14.6,251.8,16.9,251.8,21.2z"/>
+		<path class="st0" d="M262.1,31.1h-4V18.5h-2.5v-3.4h6.5V31.1z M256.9,10.1c0-1.5,1.2-2.6,2.6-2.6s2.7,1.2,2.7,2.6
+			c0,1.5-1.2,2.7-2.7,2.7S256.9,11.6,256.9,10.1z"/>
+		<path class="st0" d="M272.2,31.1l-7.5-16h4.7l4,9.9l4.2-9.9h4.7l-7.6,16H272.2z"/>
+		<path class="st0" d="M290.8,31.1h-4V18.5h-2.5v-3.4h6.5V31.1z M285.6,10.1c0-1.5,1.2-2.6,2.6-2.6c1.5,0,2.7,1.2,2.7,2.6
+			c0,1.5-1.2,2.7-2.7,2.7C286.8,12.8,285.6,11.6,285.6,10.1z"/>
+		<path class="st0" d="M305.5,16.1v3.5c-1-0.7-2.5-1.5-4.1-1.5c-1.5,0-2.5,0.8-2.5,1.7c0,0.7,0.4,1.2,1.8,1.7l1.8,0.6
+			c2.5,0.7,3.6,2.2,3.6,4.2c0,2.9-2.8,5.1-6.2,5.1c-2.2,0-4.4-0.8-5.5-1.6v-3.5c1.2,0.8,3.4,1.6,4.9,1.6c1.6,0,2.5-0.6,2.5-1.6
+			c0-0.8-0.7-1.2-2.1-1.6l-2-0.7c-2.4-0.8-3.2-2.3-3.2-4.3c0-3,2.5-5.1,6.1-5.1C302.7,14.6,304.5,15.3,305.5,16.1z"/>
+		<path class="st0" d="M319.8,15.1v3.4h-4.4v6.9c0,1.4,0.7,2.3,2,2.3c1.1,0,1.9-0.3,2.6-0.7v3.2c-0.8,0.8-1.9,1.4-3.8,1.4
+			c-2.9,0-4.8-2-4.8-5.2v-8h-2.9v-2.1c2.1-0.7,4.2-2.7,5.2-6h1.7v4.7H319.8z"/>
+		<polygon id="A" class="st0" points="183.9,31.1 192.7,8 196.6,8 205.4,31.1 201,31.1 194.7,13.5 188.3,31.1 		"/>
+		<path class="st1" d="M197.7,26.2l-1.8,1.6v-5.2v-0.7v-1.8c0-0.8-0.6-1.4-1.3-1.4s-1.3,0.6-1.3,1.4v1.8v0.7v5.2l-1.8-1.6l-1.2,1.2
+			l4.3,3.9l4.3-3.9L197.7,26.2z"/>
+	</g>
+	<g id="tube">
+		<g id="T_00000039852614045324270430000005353782644941079486_">
+			<polygon class="st0" points="94.7,8.3 94.7,12.3 101.3,12.3 101.3,18.4 105.5,18.4 105.5,12.3 111.9,12.3 111.9,8.3 			"/>
+			<rect x="101.3" y="22.6" class="st0" width="4.1" height="9"/>
+			<path class="st1" d="M105.8,21.7H101c-0.7,0-1.3-0.6-1.3-1.3l0,0c0-0.7,0.6-1.3,1.3-1.3h4.8c0.7,0,1.3,0.6,1.3,1.3l0,0
+				C107.1,21.1,106.5,21.7,105.8,21.7z"/>
+		</g>
+		<path class="st0" d="M127.4,24.5c0,4.2-3,6.8-7.1,6.8c-4.1,0-7.1-2.6-7.1-6.8v-9.4h4l0,8.7c0,2.4,1.3,3.7,3.1,3.7
+			c1.8,0,3.1-1.2,3.1-3.7v-8.7h4V24.5z"/>
+		<path class="st0" d="M136,17.3c1-1.8,2.8-3.1,5.2-3.1c3.9,0,7.3,3,7.3,8.4c0,5.4-3.4,8.7-7.5,8.7c-1.8,0-3.7-1-4.9-2.3v1.8h-4.1
+			V7.7h4.1V17.3z M136,22.9v2.3c1.2,1.2,2.5,2.1,4.1,2.1c2.5,0,4.1-2.3,4.1-4.7c0-2.4-1.6-4.3-4-4.3C138,18.3,135.9,20,136,22.9z"/>
+		<path class="st0" d="M167,24.1h-11.7c0.4,2.2,2.3,3.7,4.8,3.7c2.4,0,3.9-1,4.9-1.6v3.7c-0.9,0.7-2.6,1.6-5.1,1.6
+			c-4.8,0-8.7-3.5-8.7-8.4c0-4.7,3.6-8.7,8.2-8.7c4.8,0,7.6,3.3,7.6,8.1V24.1z M163.1,21.5c-0.2-2.3-2-3.5-3.8-3.5
+			c-2.1,0-3.5,1.4-3.9,3.5H163.1z"/>
+	</g>
+	<g id="icon">
+		<path class="st1" d="M27.6,33.7l1,0.4l0.5-2l-6.7-2l-0.7,2l0.9,0.4C20.9,44.4,25,54.5,34,61.9l2.9-4
+			C29.6,51.4,25.8,43.2,27.6,33.7z"/>
+		<path class="st1" d="M41.2,60.5l0.6-0.8L40,58.4L35.7,64l1.8,1.3l0.6-0.7c10.7,5.7,21.9,4.7,31.8-1.5L66.8,59
+			C58.3,63.9,49.9,65.3,41.2,60.5z"/>
+		<path class="st1" d="M70.8,55.6l-0.7-0.7l-1.8,1.3l4.3,5.9l1.8-1.3L73.9,60c8.7-8.5,11.2-18.7,8.4-30l-4.9,1.4
+			C79.3,40.9,78,48.7,70.8,55.6z"/>
+		<path class="st1" d="M75.5,26.5l-0.9,0.4l0.6,2.4l7.2-2.1l-0.7-2.4l-0.9,0.3c-5.7-10.7-15-17.4-26.6-17.9v5.4
+			C63.8,13.4,70.9,17.6,75.5,26.5z"/>
+		<path class="st1" d="M49,12.8l0.1,0.9l2.3-0.1v-7h-2.3v0.9C40,8.8,28.6,14.8,24,27.6l4.9,1.4C32.4,19,40.2,14.7,49,12.8z"/>
+		<polygon id="A_00000111884739883312047940000001222474654974762168_" class="st0" points="48,54 60.6,20.9 66.1,20.9 78.8,54 
+			72.5,54 63.4,28.8 54.3,54 		"/>
+		<g id="T">
+			<polygon class="st0" points="27.6,20.4 27.6,26.1 37.1,26.1 37.1,35 43.1,35 43.1,26.1 52.4,26.1 52.4,20.4 			"/>
+			<rect x="37.1" y="41" class="st0" width="6" height="13"/>
+		</g>
+		<path class="st1" d="M43.5,39.7h-6.9c-1,0-1.9-0.8-1.9-1.9l0,0c0-1,0.8-1.9,1.9-1.9h6.9c1,0,1.9,0.8,1.9,1.9l0,0
+			C45.4,38.9,44.5,39.7,43.5,39.7z"/>
+		<path class="st1" d="M67.8,47l-2.5,2.3v-7.5v-1v-2.5c0-1.1-0.8-2-1.9-2s-1.9,0.9-1.9,2v2.5v1v7.5L58.9,47l-1.7,1.7l6.2,5.6
+			l6.1-5.6L67.8,47z"/>
+	</g>
+</g>
+<g id="Layer_2">
+	<g>
+		<path class="st0" d="M142.1,58c0,6-4.3,9.6-10.1,9.6c-5.8,0-10.1-3.6-10.1-9.6V44.7h5.7l0,12.3c0,3.4,1.8,5.2,4.4,5.2
+			c2.6,0,4.4-1.7,4.4-5.2V44.7h5.7V58z"/>
+		<path class="st0" d="M154.1,48.5c1.3-2.4,3.8-4.3,7.2-4.3c5.4,0,10,4.1,10,11.6c0,7.4-4.6,12-10.4,12c-2.4,0-5.1-1.3-6.8-3.2V67
+			h-5.6V35.2h5.6V48.5z M154.1,56.1v3.2c1.6,1.7,3.4,2.9,5.6,2.9c3.5,0,5.7-3.2,5.7-6.5c0-3.4-2.2-6-5.6-6
+			C156.9,49.7,154.1,52.1,154.1,56.1z"/>
+		<path class="st0" d="M190.4,46.2v5c-1.4-0.9-3.5-2-5.7-2c-2.1,0-3.4,1.1-3.4,2.4c0,1,0.6,1.7,2.6,2.3l2.5,0.8c3.4,1,5.1,3,5.1,5.9
+			c0,4.1-3.9,7.2-8.7,7.2c-3,0-6.1-1.1-7.6-2.3v-4.9c1.7,1.1,4.7,2.3,6.9,2.3c2.3,0,3.5-0.8,3.5-2.3c0-1.2-1-1.6-3-2.3l-2.7-1
+			c-3.4-1.1-4.5-3.2-4.5-6.1c0-4.2,3.5-7.1,8.6-7.1C186.6,44.1,189.2,45.1,190.4,46.2z"/>
+		<path class="st0" d="M212.9,46.5v5.2c-1.5-1.1-3.4-2-6.1-2c-3.4,0-6.2,2.7-6.2,6.3s2.6,6.3,6.2,6.3c2.7,0,4.6-0.8,6.1-1.9v5.1
+			c-1.2,1.1-3.3,2.3-6.6,2.3c-6.7,0-11.7-5.4-11.7-11.7s5-11.9,11.7-11.9C209.7,44.1,211.7,45.5,212.9,46.5z"/>
+		<path class="st0" d="M232.5,44.9v6.4c-1-0.7-2.1-1.1-3.4-1.1c-2.6,0-4.2,1.9-5.5,4.4V67h-5.6V44.7h5.6v4.2
+			c1.5-2.7,3.6-4.6,6.3-4.6C230.9,44.3,231.7,44.5,232.5,44.9z"/>
+		<path class="st0" d="M244.7,67h-5.6V49.5h-3.5v-4.8h9.1V67z M237.5,37.8c0-2,1.6-3.7,3.7-3.7s3.7,1.6,3.7,3.7s-1.7,3.7-3.7,3.7
+			S237.5,39.8,237.5,37.8z"/>
+		<path class="st0" d="M257,48.5c1.3-2.4,3.8-4.3,7.2-4.3c5.4,0,10,4.1,10,11.6c0,7.4-4.6,12-10.4,12c-2.4,0-5.1-1.3-6.8-3.2V67
+			h-5.6V35.2h5.6V48.5z M257,56.1v3.2c1.6,1.7,3.4,2.9,5.6,2.9c3.5,0,5.7-3.2,5.7-6.5c0-3.4-2.2-6-5.6-6
+			C259.8,49.7,257,52.1,257,56.1z"/>
+		<path class="st0" d="M299.8,57.6h-16.2c0.6,3.1,3.1,5,6.5,5c3.3,0,5.4-1.4,6.8-2.3v5.1c-1.2,0.9-3.6,2.3-7,2.3
+			c-6.6,0-12-4.9-12-11.6c0-6.5,5-12,11.3-12c6.6,0,10.5,4.6,10.5,11.1V57.6z M294.4,54c-0.2-3.2-2.7-4.8-5.3-4.8
+			c-2.9,0-4.8,1.9-5.4,4.8H294.4z"/>
+		<path class="st0" d="M319.5,44.9v6.4c-1-0.7-2.1-1.1-3.4-1.1c-2.6,0-4.2,1.9-5.5,4.4V67H305V44.7h5.6v4.2c1.5-2.7,3.6-4.6,6.3-4.6
+			C317.9,44.3,318.7,44.5,319.5,44.9z"/>
+	</g>
+	<g>
+		<path class="st0" d="M102.6,54l2.4,0.9v-6.1c0-0.2,0-0.3,0.1-0.5c-1.2-0.6-1.9-1.4-1.9-2.6c0-2.3,2.6-3.2,4.9-3.2
+			c3.1,0,5.4,1.3,7.5,2.7v-6.1c-1.9-1.2-4.8-2.3-8.3-2.3c-5.5,0-10.5,3.5-10.5,9C96.7,49.3,98,52.3,102.6,54z"/>
+		<path class="st0" d="M111.1,51l-1.9-0.8v6.6c0.8,0.5,1.3,1.2,1.3,2.1c0,1.9-2,2.9-4.5,2.9c-3.5,0-6.7-1.5-9.3-3.4v6.1
+			c2.4,1.7,5.7,3.1,9.2,3.1c6.1,0,11.2-3.8,11.2-9C117.2,55.3,115.3,52.8,111.1,51z"/>
+	</g>
+</g>
+<path class="st1" d="M105.5,56.1v-6.9c0-1,0.8-1.9,1.6-1.9l0,0c0.9,0,1.6,0.9,1.6,1.9v6.9c0,1-0.8,1.9-1.6,1.9l0,0
+	C106.2,58,105.5,57.1,105.5,56.1z"/>
+</svg>

browser_extension/extension/images/question.svg

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Generator: Adobe Illustrator 26.0.2, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
+<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
+	 viewBox="0 0 374.4 375.1" style="enable-background:new 0 0 374.4 375.1;" xml:space="preserve">
+<style type="text/css">
+	.st0{fill:#FFFFFF;}
+</style>
+<path class="st0" d="M187.5,0C84.2-0.1,0.1,83.8,0,187.2C-0.2,290.8,83.7,375,187.1,375.1c103.3,0,187.2-83.9,187.3-187.4
+	C374.5,84.3,290.7,0.2,187.5,0z M187.9,304.5c-16,0-29.2-13.3-29.2-29.3c0.1-16,13.2-29,29.1-29.1c16,0,29.2,13.3,29.2,29.3
+	C216.9,291.4,203.8,304.5,187.9,304.5z M238.2,195.7c-4.8,2.9-9.7,5.8-14.5,8.7c-9.1,5.5-13.6,13.6-13.9,24.2c0,0.8,0,1.7,0,2.7
+	c-14.6,0-29,0-43.8,0c0.1-2.8,0.2-5.6,0.4-8.5c0.8-10.6,3.2-20.9,8.4-30.3c5.9-11,14.9-18.9,25.5-25.1c4.1-2.4,8.4-4.7,12.5-7.1
+	c12.7-7.7,13.1-19.1,6.2-29.9c-6.5-10.3-16.3-14.9-28.1-15.7c-8-0.5-15.7,0.7-22.6,4.9c-10.1,6.2-15,15.6-16.9,26.9
+	c-0.1,0.4-0.1,0.9-0.2,1.6c-14.5-1.9-28.9-3.8-43.9-5.8c1.4-5.4,2.5-10.8,4.2-15.9c5.2-14.9,13.6-27.8,25.8-38
+	c11.1-9.3,23.9-14.7,38.2-16.6c2.3-0.3,4.6-0.6,6.9-1c3.2,0,6.4,0,9.6,0c4.4,0.6,8.9,1.1,13.3,1.9c29.8,5.9,55.4,28.1,61.4,59.3
+	C271.5,157.5,260.7,182.2,238.2,195.7z"/>
+</svg>

browser_extension/extension/images/social/discord.svg

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Generator: Adobe Illustrator 26.0.2, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
+<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
+	 viewBox="0 0 384 384" style="enable-background:new 0 0 384 384;" xml:space="preserve">
+<style type="text/css">
+	.st0{fill:#FFFFFF;}
+</style>
+<g>
+	<path class="st0" d="M191.57,379.5C88.15,379.44,4.32,295.25,4.46,191.57C4.6,88.18,88.66,4.28,191.95,4.42
+		c103.29,0.14,187.02,84.23,186.93,187.72C378.8,295.6,294.86,379.55,191.57,379.5z M244.55,271.24
+		c4.89,5.91,9.44,11.19,13.73,16.69c1.8,2.32,3.72,3.11,6.64,2.93c28.39-1.75,53.17-11.56,72.96-32.55c1.12-1.19,2.08-3.2,1.97-4.76
+		c-0.79-11.71-1.27-23.48-2.97-35.07c-5.07-34.65-16.23-67.36-32.74-98.23c-0.73-1.36-1.88-2.67-3.15-3.55
+		c-19.34-13.43-40.61-21.62-64.16-23.63c-3.19-0.27-5.5,0.48-6.89,3.09c10.27,3.97,20.59,7.65,30.65,11.94
+		c10.1,4.32,19.64,9.74,28.21,16.92c-64.82-29.49-129.53-29.49-194.34,0.02c17.77-13.75,38.02-22.07,59.27-28.39
+		c-1.74-3.15-4.12-3.86-7.32-3.58c-23.15,2.02-44.13,9.94-63.2,23.08c-1.76,1.21-3.51,2.96-4.4,4.86
+		c-5.36,11.39-11.02,22.69-15.57,34.41c-12.22,31.43-19.35,64-19.75,97.86c-0.02,1.71,0.88,3.85,2.07,5.1
+		c18.74,19.74,41.98,29.72,68.88,32.19c5.73,0.53,9.64-0.46,12.96-5.26c3.36-4.86,7.35-9.28,11.2-14.05
+		c-22.46-8.05-39.37-18.53-42.93-26.17c63.97,36.11,128.17,36.13,192.51-0.02C276.69,258.45,261.71,265.95,244.55,271.24z"/>
+	<path class="st0" d="M237.28,232.74c-14.34-0.02-26.07-12-25.9-26.45c0.17-14.67,11.86-26.25,26.56-26.33
+		c13.63-0.07,25.18,12,25.21,26.35C263.18,220.98,251.66,232.76,237.28,232.74z"/>
+	<path class="st0" d="M146.11,232.74c-14.35,0.05-25.9-11.7-25.92-26.38c-0.02-14.3,11.56-26.46,25.16-26.41
+		c14.85,0.06,26.74,11.96,26.62,26.66C171.84,221.04,160.32,232.69,146.11,232.74z"/>
+</g>
+</svg>

browser_extension/extension/images/social/github.svg

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Generator: Adobe Illustrator 26.0.2, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
+<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
+	 viewBox="0 0 384 384" style="enable-background:new 0 0 384 384;" xml:space="preserve">
+<style type="text/css">
+	.st0{fill:#FFFFFF;}
+</style>
+<g>
+	<path class="st0" d="M244.51,375.15c0-10.59-0.31-21.12,0.08-31.61c0.5-13.65,0.02-26.89-10.41-37.88
+		c8.18-2.06,15.59-3.84,22.95-5.83c3.51-0.95,6.95-2.22,10.37-3.47c27.26-9.99,40.88-31.15,45.79-58.73
+		c2.71-15.21,4.11-30.82-0.74-45.88c-2.65-8.23-6.01-16.69-11.08-23.5c-3.83-5.14-3.43-9.05-2.23-14.27
+		c2.86-12.48,0.71-24.71-2.64-36.79c-0.99-3.58-3.09-4.99-6.88-4.6c-11.45,1.18-21.48,6.12-31.34,11.6
+		c-1.42,0.79-2.97,1.46-4.16,2.52c-5.55,4.99-11.4,5.13-18.58,3.42c-25.28-6.04-50.67-5.14-75.85,1.12
+		c-3.59,0.89-6.27,0.27-9.31-1.86c-11.08-7.73-22.87-14.02-36.37-16.31c-0.13-0.02-0.26-0.07-0.4-0.09
+		c-7.12-1.23-8.12-0.76-10.11,6.16c-3.51,12.23-5.18,24.6-1.55,37.14c1.14,3.94,0.44,7.16-2.01,10.61
+		c-23.14,32.46-16.36,80.65,0.11,103.41c12.16,16.81,29.02,26.2,48.63,31.06c5.49,1.36,11.11,2.15,17.1,3.28
+		c-0.24,0.79-0.43,1.81-0.85,2.71c-3.15,6.91-6.27,13.83-9.6,20.65c-0.67,1.38-2.06,3.14-3.34,3.35c-7.3,1.18-14.65,2.46-22.02,2.7
+		c-6.5,0.21-12.09-3.32-16.37-8c-5.11-5.59-9.65-11.73-14.19-17.83c-6.07-8.15-14.2-12.42-24.05-13.3c-2.22-0.2-4.58,1.12-7.99,2.05
+		c2.69,3.23,4.46,6.17,6.96,8.2c10.32,8.35,17.42,19.1,22.26,31.24c4.72,11.85,14.1,16.55,25.31,19.27
+		c9.24,2.24,18.51,1.5,27.83,0.78c6.07-0.47,6.09-0.22,6.09,5.98c0.01,5.58,0,11.17,0,16.81C86.7,368.22,7.24,301.96,4.67,198.28
+		C2.19,97.88,77.65,13.69,175.94,5.34c103.69-8.81,192.95,68.52,202.14,171.23C387.22,278.72,317.17,355.78,244.51,375.15z"/>
+</g>
+</svg>

browser_extension/extension/images/social/reddit.svg

@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Generator: Adobe Illustrator 26.0.2, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
+<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
+	 viewBox="0 0 384 384" style="enable-background:new 0 0 384 384;" xml:space="preserve">
+<style type="text/css">
+	.st0{fill:#FFFFFF;}
+</style>
+<g>
+	<path class="st0" d="M240.82,274c-3.86,3.78-8.45,6.33-13.43,8.26c-9.77,3.79-19.98,5.34-30.38,5.85
+		c-5.42,0.26-10.85,0.12-16.26-0.44c-5.89-0.61-11.72-1.56-17.42-3.18c-7.65-2.17-14.86-5.18-20.68-10.86
+		c-0.98-0.96-2.26-1.44-3.64-1.48c-2.72-0.08-4.71,1.17-5.94,3.55c-1.14,2.2-0.8,4.87,0.94,6.7c1.28,1.35,2.7,2.59,4.17,3.73
+		c5.88,4.57,12.58,7.49,19.65,9.63c11.11,3.37,22.52,4.66,36.04,4.85c2.63-0.18,7.2-0.42,11.76-0.82c6.75-0.6,13.38-1.86,19.88-3.8
+		c6.56-1.95,12.83-4.56,18.42-8.57c1.94-1.4,3.82-2.93,5.52-4.61c2.44-2.4,2.35-6.62,0.01-8.95
+		C247.1,271.52,243.37,271.51,240.82,274z"/>
+	<path class="st0" d="M192.39,4.72C89.03,4.5,5.07,88.18,4.86,191.61c-0.21,103.43,83.4,187.46,186.75,187.67
+		c103.35,0.21,187.31-83.46,187.53-186.89C379.36,88.96,295.74,4.93,192.39,4.72z M327.66,225.47c0.14,1.32,0.27,2.64,0.41,3.96
+		c0.53,4.98,0.43,9.96-0.23,14.91c-2.24,16.85-10.03,30.98-21.45,43.28c-8.94,9.62-19.42,17.22-30.95,23.42
+		c-13.96,7.52-28.79,12.64-44.3,15.87c-8.46,1.76-17,2.91-25.62,3.51c-6.58,0.46-13.16,0.6-19.75,0.39
+		c-6.8-0.22-13.58-0.8-20.34-1.72c-11.93-1.64-23.6-4.38-34.96-8.39c-14.15-4.99-27.38-11.73-39.34-20.86
+		c-9.74-7.44-18.15-16.12-24.63-26.59c-5.11-8.26-8.64-17.14-10.2-26.75c-1.1-6.76-1.23-13.55-0.14-20.33c0.03-0.21,0-0.44,0-0.7
+		c-10.51-5.25-17.19-13.54-19.32-25.14c-1.71-9.32,0.32-17.97,5.8-25.72c11.73-16.6,35.97-19.53,51.41-4.96
+		c27.77-19.23,59-27.5,92.46-28.92c0.46-2.12,0.92-4.2,1.36-6.28c3.46-16.26,6.92-32.53,10.37-48.79
+		c1.82-8.57,3.63-17.14,5.43-25.71c0.26-1.23,0.59-2.42,1.44-3.4c1.68-1.92,3.83-2.34,6.2-1.85c6.31,1.3,12.62,2.66,18.92,3.99
+		c10.35,2.19,20.7,4.39,31.05,6.59c2,0.42,4,0.84,6.09,1.28c3.7-6.86,9.29-11.3,16.92-12.93c5.54-1.19,10.89-0.41,15.96,2.14
+		c10.03,5.06,15.32,16.56,12.65,27.42c-2.74,11.12-12.68,18.73-24.01,18.65c-11.69-0.08-23.34-9.38-24.16-23.21
+		c-1.43-0.6-49.41-10.81-50.5-10.7c-5.15,24.12-10.32,48.27-15.51,72.57c0.64,0.04,1.07,0.07,1.51,0.09
+		c19.74,0.93,38.91,4.68,57.37,11.79c11.05,4.25,21.5,9.64,31.21,16.44c0.29,0.2,0.6,0.38,0.94,0.59
+		c8.62-7.75,18.62-11.01,30.07-8.89c9.47,1.76,16.97,6.78,22.22,14.87c5.67,8.73,7.06,18.26,4.21,28.25
+		C343.42,213.65,337.03,220.82,327.66,225.47z"/>
+	<path class="st0" d="M162.26,218.68c0.08-13.49-10.62-24.33-24.09-24.41c-13.86,0-24.09,11.31-24.22,23.89
+		c-0.13,12.52,9.75,24.24,23.96,24.42C151.22,242.73,162.19,231.9,162.26,218.68z"/>
+	<path class="st0" d="M245.16,194.56c-13.42,0.03-24.09,10.83-24.11,24.24c-0.02,12.58,10.14,24.01,24.17,24.05
+		c13.33,0.04,24.16-10.89,24.12-24.26C269.32,205.3,258.48,194.52,245.16,194.56z"/>
+</g>
+</svg>

browser_extension/extension/index.html

@@ -0,0 +1,93 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>TubeArchivist Companion</title>
+    <link rel="stylesheet" href="https://fonts.googleapi.com/css?family=Sen" type="text/css">
+    <style>
+        body {
+            font-family: Sen-Regular, sans-serif;
+            background-color: #00202f;
+            color: #97d4c8;
+        }
+        .container {
+            padding: 10px;
+            min-width: 300px;
+        }
+        hr {
+            height: 1px;
+            color: white;
+            background-color: white;
+        }
+        .login-form {
+            display: grid;
+            grid-template-columns: 1fr 1fr;
+        }
+        .login-form label,
+        .login-form input {
+            margin: 3px 0;
+        }
+        .submit button {
+            margin: 10px auto 15px auto;
+            display: block;
+            border-radius: 0;
+            padding: 5px 13px;
+            border: none;
+            cursor: pointer;
+            background-color: #259485;
+            color: #ffffff;
+        }
+        .submit button:hover {
+            background-color: #97d4c8;
+            transform: scale(1.05);
+            color: #00202f;
+        }
+        .icons {
+            display: flex;
+            grid-template-columns: 1fr 1fr;
+            justify-content: space-between;
+        }
+        .icons img {
+            width: 25px;
+        }
+    </style>
+</head>
+<body>
+    <div class="container">
+        <img src="/images/logo.svg" alt="ta-logo">
+        <hr>
+        <form class="login-form">
+            <label for="url">Tube Archivist Url:</label>
+            <input type="text" id="url" name="url">
+            <label for="port">Tube Archivist Port:</label>
+            <input type="text" id="port" name="port">
+            <label for="api-key">API key:</label>
+            <input type="text" id="api-key" name="api-key">
+        </form>
+        <div class="submit">
+            <button onclick="storeLogin()" id="save-login">Save</button>
+        </div>
+        <div class="icons">
+            <div>
+                <a href="https://www.reddit.com/r/TubeArchivist/" target="_blank">
+                    <img src="/images/social/reddit.svg" alt="reddit-icon">
+                </a>
+                <a href="https://discord.gg/AFwz8nE7BK" target="_blank">
+                    <img src="/images/social/discord.svg" alt="discord-icon">
+                </a>
+                <a href="https://github.com/bbilly1/tubearchivist" target="_blank">
+                    <img src="/images/social/github.svg" alt="github-icon">
+                </a>
+            </div>
+            <div>
+                <a href="#">
+                    <img src="/images/question.svg" alt="question-icon">
+                </a>
+            </div>
+        </div>
+    </div>
+    <script type="text/javascript" src="popup.js"></script>
+</body>
+</html>

browser_extension/extension/manifest.json

@@ -0,0 +1,25 @@
+{
+    "manifest_version": 2,
+    "name": "TubeArchivist Companion",
+    "description": "Interact with your selhosted TA server.",
+    "version": "0.0.1",
+    "icons": {
+        "128": "/images/icon128.png"
+    },
+    "browser_action": {
+        "default_icon": "/images/icon.png",
+        "default_popup": "index.html"
+    },
+    "permissions": [
+        "storage"
+    ],
+    "content_scripts": [
+        {
+            "matches": ["https://www.youtube.com/results*"],
+            "js": ["script.js"]
+        }
+    ],
+    "background": {
+        "scripts": ["background.js"]
+    }
+}

browser_extension/extension/popup.js

@@ -0,0 +1,63 @@
+/*
+Loaded into popup index.html
+*/
+
+let browserType = getBrowser();
+
+// boilerplate to dedect browser type api
+function getBrowser() {
+    if (typeof chrome !== "undefined") {
+        if (typeof browser !== "undefined") {
+            console.log("detected firefox");
+            return browser;
+        } else {
+            console.log("detected chrome");
+            return chrome;
+        }
+    } else {
+        console.log("failed to dedect browser");
+        throw "browser detection error"
+    };
+}
+
+// store access details
+document.getElementById("save-login").addEventListener("click", function () {
+    console.log("save form");
+    let toStore = {
+        "access": {
+            "url": document.getElementById("url").value,
+            "port": document.getElementById("port").value,
+            "apiKey": document.getElementById("api-key").value
+        }
+    };
+    console.log(toStore);
+    browserType.storage.local.set(toStore, function() {
+        console.log("Stored connection details: " + JSON.stringify(toStore));
+    });
+})
+
+// fill in form
+document.addEventListener("DOMContentLoaded", async () => {
+
+    console.log("executing dom loader");
+
+    function onGot(item) {
+        if (!item.access) {
+            console.log("no access details found");
+            return
+        }
+        console.log(item.access);
+        document.getElementById("url").value = item.access.url;
+        document.getElementById("port").value = item.access.port;
+        document.getElementById("api-key").value = item.access.apiKey;
+    };
+    
+    function onError(error) {
+        console.log(`Error: ${error}`);
+    };
+
+    browserType.storage.local.get("access", function(result) {
+        onGot(result)
+    });
+
+})

browser_extension/extension/script.js

@@ -0,0 +1,72 @@
+/*
+content script running on youtube.com
+*/
+
+console.log("running script.js");
+
+let browserType = getBrowser();
+
+setTimeout(function(){
+    console.log("running setimeout")
+    linkFinder();
+    return false;
+}, 2000);
+
+
+// boilerplate to dedect browser type api
+function getBrowser() {
+    if (typeof chrome !== "undefined") {
+        if (typeof browser !== "undefined") {
+            console.log("detected firefox");
+            return browser;
+        } else {
+            console.log("detected chrome");
+            return chrome;
+        }
+    } else {
+        console.log("failed to dedect browser");
+        throw "browser detection error"
+    };
+}
+
+
+// event handler for download task
+function addToDownload(videoId) {
+
+    console.log(`downloading ${videoId}`);
+    let payload = {
+        "download": {
+            "videoId": videoId
+        }
+    };
+
+    browserType.runtime.sendMessage(payload);
+
+}
+
+
+// find relevant links to add a button to
+function linkFinder() {
+
+    console.log("running link finder");
+
+    var allLinks = document.links;
+    for (let i = 0; i < allLinks.length; i++) {
+        
+        const linkItem = allLinks[i];
+        const linkDest = linkItem.getAttribute("href");
+
+        if (linkDest.startsWith("/watch?v=") && linkItem.id == "video-title") {
+            var dlButton = document.createElement("button");
+            dlButton.innerText = "download";
+            var videoId = linkDest.split("=")[1];
+            dlButton.setAttribute("data-id", videoId);
+            dlButton.setAttribute("id", "ta-dl-" + videoId);
+            dlButton.onclick = function(event) {
+                var videoId = this.getAttribute("data-id");
+                addToDownload(videoId);
+            };
+            linkItem.parentElement.appendChild(dlButton);
+        }
+    }
+}

deploy.sh

@@ -3,13 +3,22 @@
 # deploy all needed project files to different servers:
 # test for local vm for testing
 # blackhole for local production
-# docker to publish
+# unstable to publish intermediate releases
+# docker to publish regular release
+
+# create builder:
+# docker buildx create --name tubearchivist
+# docker buildx use tubearchivist
+# docker buildx inspect --bootstrap
+
+# more details:
+# https://github.com/bbilly1/tubearchivist/issues/6
 
 set -e
 
 function sync_blackhole {
 
-    # docker commands need sudo
+    # docker commands need sudo, only build amd64
     host="blackhole.local"
 
     read -sp 'Password: ' remote_pw
@@ -23,7 +32,7 @@ function sync_blackhole {
         --exclude "db.sqlite3" \
         . -e ssh "$host":tubearchivist
 
-    echo "$PASS" | ssh "$host" 'sudo -S docker build -t bbilly1/tubearchivist:latest tubearchivist 2>/dev/null'
+    echo "$PASS" | ssh "$host" 'sudo -S docker buildx build --platform linux/amd64 -t bbilly1/tubearchivist:latest tubearchivist --load 2>/dev/null'
     echo "$PASS" | ssh "$host" 'sudo -S docker-compose up -d 2>/dev/null'
 
 }
@@ -31,6 +40,8 @@ function sync_blackhole {
 function sync_test {
 
     # docker commands don't need sudo in testing vm
+    # pass argument to build for specific platform
+
     host="tubearchivist.local"
 
     rsync -a --progress --delete-after \
@@ -41,9 +52,20 @@ function sync_test {
         --exclude "db.sqlite3" \
         . -e ssh "$host":tubearchivist
 
-    rsync -r --progress --delete docker-compose.yml -e ssh "$host":docker
+    # uncomment or copy your own docker-compose file
+    # rsync -r --progress --delete docker-compose.yml -e ssh "$host":docker
 
-    ssh "$host" 'docker build -t bbilly1/tubearchivist:latest tubearchivist'
+    if [[ $1 = "amd64" ]]; then
+        platform="linux/amd64"
+    elif [[ $1 = "arm64" ]]; then
+        platform="linux/arm64"
+    elif [[ $1 = "multi" ]]; then
+        platform="linux/amd64,linux/arm64"
+    else
+        platform="linux/amd64"
+    fi
+
+    ssh "$host" "docker buildx build --platform $platform -t bbilly1/tubearchivist:latest tubearchivist --load"
     ssh "$host" 'docker-compose -f docker/docker-compose.yml up -d'
 
     ssh "$host" 'docker cp tubearchivist/tubearchivist/testing.sh tubearchivist:/app/testing.sh'
@@ -52,18 +74,88 @@ function sync_test {
 }
 
 
-function sync_docker {
+# run same tests and checks as with github action but locally
+# takes filename to validate as optional argument
+function validate {
+
+    if [[ $1 ]]; then
+        check_path="$1"
+    else
+        check_path="."
+    fi
+
+    echo "run validate on $check_path"
+
+    echo "running black"
+    black --diff --color --check -l 79 "$check_path"
+    echo "running codespell"
+    codespell --skip="./.git" "$check_path"
+    echo "running flake8"
+    flake8 "$check_path" --count --max-complexity=12 --max-line-length=79 \
+        --show-source --statistics
+    echo "running isort"
+    isort --check-only --diff --profile black -l 79 "$check_path"
+    printf "    \n> all validations passed\n"
+
+}
+
+
+# publish unstable tag to docker
+function sync_unstable {
 
     if [[ $(systemctl is-active docker) != 'active' ]]; then
         echo "starting docker"
         sudo systemctl start docker
     fi
 
-    sudo docker build -t bbilly1/tubearchivist:latest .
-    sudo docker push bbilly1/tubearchivist:latest
+    # start amd64 build
+    sudo docker buildx build \
+        --platform linux/amd64 \
+        -t bbilly1/tubearchivist:unstable --push .
 
 }
 
+
+function sync_docker {
+
+    # check things
+    if [[ $(git branch --show-current) != 'master' ]]; then
+        echo 'you are not on master, dummy!'
+        return
+    fi
+
+    if [[ $(systemctl is-active docker) != 'active' ]]; then
+        echo "starting docker"
+        sudo systemctl start docker
+    fi
+
+    echo "latest tags:"
+    git tag
+
+    echo "latest docker images:"
+    sudo docker image ls bbilly1/tubearchivist
+
+    printf "\ncreate new version:\n"
+    read -r VERSION
+
+    echo "build and push $VERSION?"
+    read -rn 1
+
+    # start build
+    sudo docker buildx build \
+        --platform linux/amd64,linux/arm64 \
+        -t bbilly1/tubearchivist:latest \
+        -t bbilly1/tubearchivist:"$VERSION" --push .
+
+    # create release tag
+    echo "commits since last version:"
+    git log "$(git describe --tags --abbrev=0)"..HEAD --oneline
+    git tag -a "$VERSION" -m "new release version $VERSION"
+    git push all "$VERSION"
+
+}
+
+
 # check package versions in requirements.txt for updates
 python version_check.py
 
@@ -71,11 +163,16 @@ python version_check.py
 if [[ $1 == "blackhole" ]]; then
     sync_blackhole
 elif [[ $1 == "test" ]]; then
-    sync_test
+    sync_test "$2"
+elif [[ $1 == "validate" ]]; then
+    validate "$2"
 elif [[ $1 == "docker" ]]; then
     sync_docker
+    sync_unstable
+elif [[ $1 == "unstable" ]]; then
+    sync_unstable
 else
-    echo "valid options are: blackhole | test | docker"
+    echo "valid options are: blackhole | test | validate | docker | unstable"
 fi
 
 

docker-compose.yml

@@ -8,31 +8,37 @@ services:
     ports:
       - 8000:8000
     volumes:
-      - ./volumes/tubearchivist/media:/youtube
-      - ./volumes/tubearchivist/cache:/cache
+      - media:/youtube
+      - cache:/cache
     environment:
       - ES_URL=http://archivist-es:9200
       - REDIS_HOST=archivist-redis
       - HOST_UID=1000
       - HOST_GID=1000
+      - TA_USERNAME=tubearchivist
+      - TA_PASSWORD=verysecret
+      - ELASTIC_PASSWORD=verysecret
+      - TZ=America/New_York
     depends_on:
       - archivist-es
       - archivist-redis
   archivist-redis:
-    image: redislabs/rejson:latest
+    image: redislabs/rejson:latest      # For arm64 just update this line with bbilly1/rejson:latest
     container_name: archivist-redis
     restart: always
-    ports:
-      - 6379:6379
+    expose:
+      - "6379"
     volumes:
-      - ./volumes/tubearchivist/redis:/data
+      - redis:/data
     depends_on:
       - archivist-es
   archivist-es:
-    image: docker.elastic.co/elasticsearch/elasticsearch:7.14.1
+    image: docker.elastic.co/elasticsearch/elasticsearch:7.17.0
     container_name: archivist-es
     restart: always
     environment:
+      - "xpack.security.enabled=true"
+      - "ELASTIC_PASSWORD=verysecret"
       - "discovery.type=single-node"
       - "ES_JAVA_OPTS=-Xms512m -Xmx512m"
     ulimits:
@@ -40,6 +46,12 @@ services:
         soft: -1
         hard: -1
     volumes:
-      - ./volumes/tubearchivist/es:/usr/share/elasticsearch/data
-    ports:
-      - 9200:9200
+      - es:/usr/share/elasticsearch/data
+    expose:
+      - "9200"
+
+volumes:
+  media:
+  cache:
+  redis:
+  es:

docker_assets/nginx.conf

@@ -0,0 +1,30 @@
+server {
+
+    listen 8000;
+
+    location /cache/videos/ {
+        alias /cache/videos/;
+    }
+
+    location /cache/channels/ {
+        alias /cache/channels/;
+    }
+
+    location /cache/playlists/ {
+        alias /cache/playlists/;
+    }
+
+    location /media/ {
+        alias /youtube/;
+
+        types {
+            text/vtt vtt;
+        }
+    }
+
+    location / {
+        include uwsgi_params;
+        uwsgi_pass localhost:8080;
+    }
+
+}

docker_assets/run.sh

@@ -0,0 +1,50 @@
+#!/bin/bash
+# startup script inside the container for tubearchivist
+
+if [[ -z "$ELASTIC_USER" ]]; then
+    export ELASTIC_USER=elastic
+fi
+
+ENV_VARS=("TA_USERNAME" "TA_PASSWORD" "ELASTIC_PASSWORD" "ELASTIC_USER")
+for each in "${ENV_VARS[@]}"; do
+    if ! [[ -v $each ]]; then
+        echo "missing environment variable $each"
+        exit 1
+    fi
+done
+
+# ugly nginx and uwsgi port overwrite with env vars
+if [[ -n "$TA_PORT" ]]; then
+    sed -i "s/8000/$TA_PORT/g" /etc/nginx/conf.d/nginx.conf
+fi
+
+if [[ -n "$TA_UWSGI_PORT" ]]; then
+    sed -i "s/8080/$TA_UWSGI_PORT/g" /etc/nginx/conf.d/nginx.conf
+    sed -i "s/8080/$TA_UWSGI_PORT/g" /app/uwsgi.ini
+fi
+
+# wait for elasticsearch
+counter=0
+until curl -u "$ELASTIC_USER":"$ELASTIC_PASSWORD" "$ES_URL" -fs; do
+    echo "waiting for elastic search to start"
+    counter=$((counter+1))
+    if [[ $counter -eq 12 ]]; then
+        # fail after 2 min
+        echo "failed to connect to elastic search, exiting..."
+        exit 1
+    fi
+    sleep 10
+done
+
+# start python application
+python manage.py makemigrations
+python manage.py migrate
+export DJANGO_SUPERUSER_PASSWORD=$TA_PASSWORD && \
+    python manage.py createsuperuser --noinput --name "$TA_USERNAME"
+
+python manage.py collectstatic --noinput -c
+nginx &
+celery -A home.tasks worker --loglevel=INFO &
+celery -A home beat --loglevel=INFO \
+    -s "${BEAT_SCHEDULE_PATH:-/cache/celerybeat-schedule}" &
+uwsgi --ini uwsgi.ini

docker_assets/uwsgi.ini

@@ -0,0 +1,8 @@
+[uwsgi]
+module = config.wsgi:application
+master = True
+pidfile = /tmp/project-master.pid
+vacuum = True
+max-requests = 5000
+socket = :8080
+buffer-size = 8192

docs/Channels.md

@@ -0,0 +1,26 @@
+# Channels Overview and Channel Detail Page
+
+The channels are organized on two different levels, similar as the [playlists](Playlists):
+
+## Channels Overview
+Accessible at `/channel/` of your Tube Archivist, the **Overview Page** shows a list of all channels you have indexed. 
+- You can filter that list to show or hide subscribed channels with the toggle. Clicking on the channel banner or the channel name will direct you to the *Channel Detail Page*.
+- If you are subscribed to a channel a *Unsubscribe* button will show, if you aren't subscribed, a *Subscribe* button will show instead. 
+
+The **Subscribe to Channels** button <img src="assets/icon-add.png?raw=true" alt="add icon" width="20px" style="margin:0 5px;"> opens a text field to subscribe to a channel. You have a few options:
+- Enter the YouTube channel ID, a 25 character alphanumeric string. For example *UCBa659QWEk1AI4Tg--mrJ2A*
+- Enter the URL to the channel page on YouTube. For example *https://www.youtube.com/channel/UCBa659QWEk1AI4Tg--mrJ2A*
+- Enter the channel name for example: *https://www.youtube.com/c/TomScottGo*.
+- Enter the video URL for any video and let Tube Archivist extract the channel ID for you. For example *https://www.youtube.com/watch?v=2tdiKTSdE9Y*
+- Add one per line.
+
+You can search your indexed channels by clicking on the search icon <img src="assets/icon-search.png?raw=true" alt="search icon" width="20px" style="margin:0 5px;">. This will open a dedicated page.
+
+## Channel Detail
+Each channel will get a dedicated channel detail page accessible at `/channel/<channel-id>/` of your Tube Archivist. This page shows all the videos you have downloaded from this channel plus additional metadata. 
+- If you are subscribed to the channel, an *Unsubscribe* button will show, else the *Subscribe* button will show.
+- You can *Show* the channel description, that matches with the *About* tab on YouTube.
+- The **Mark as Watched** button will mark all videos of this channel as watched.
+- The button **Delete Channel** will delete the channel plus all videos of this channel, both media files and metadata additionally this will also delete playlists metadata belonging to that channel.
+- The button **Find Playlists** will go out to youtube and look for playlists belonging to this channel and index all with at least one video downloaded. Only do this for channels where you care about playlists as this will slow down indexing new videos for having to check which playlist this belongs to.
+- The button **Show Playlists** will go to the [playlists](Playlists) page and filter the list to only show playlists from this channel.

docs/Downloads.md

@@ -0,0 +1,43 @@
+# Downloads Page
+Accessible at `/downloads/` of your Tube Archivist, this page handles all the download functionality.
+
+
+## Rescan Subscriptions
+The **Rescan Subscriptions** icon <img src="assets/icon-rescan.png?raw=true" alt="rescan icon" width="20px" style="margin:0 5px;"> will start a background task to look for new videos from the channels and playlists you are subscribed to. You can define the channel and playlist page size on the [settings page](Settings#subscriptions). With the default page size, expect this process to take around 2-3 seconds for each channel or playlist you are subscribed to. A status message will show the progress.
+
+Then for every video found, **Tube Archivist** will skip the video if it has already been downloaded or if you added it to the *ignored* list before. All the other videos will get added to the download queue. Expect this to take around 2 seconds for each video as **Tube Archivist** needs to grab some additional metadata. New videos will get added at the bottom of the download queue.
+
+## Download Queue
+The **Start Download** icon <img src="assets/icon-download.png?raw=true" alt="download icon" width="20px" style="margin:0 5px;"> will start the download process starting from the top of the queue. Take a look at the relevant settings on the [Settings Page](Settings#downloads). Once the process started, a progress message will show with additional details and controls: 
+- The stop icon <img src="assets/icon-stop.png?raw=true" alt="stop icon" width="20px" style="margin:0 5px;"> will gracefully stop the download process, once the current video has been finished successfully.
+- The cancel icon <img src="assets/icon-close-red.png?raw=true" alt="close icon" width="20px" style="margin:0 5px;"> is equivalent to killing the process and will stop the download immediately. Any leftover files will get deleted, the canceled video will still be available in the download queue.
+
+After downloading, Tube Archivist tries to add new videos to already indexed playlists.
+
+## Add to Download Queue
+The **Add to Download Queue** icon <img src="assets/icon-add.png?raw=true" alt="add icon" width="20px" style="margin:0 5px;"> opens a text field to manually add videos to the download queue. You have a few options:
+- Add a link to a YouTube video. For example *https://www.youtube.com/watch?v=2tdiKTSdE9Y*.
+- Add a YouTube video ID. For example *2tdiKTSdE9Y*.
+- Add a link to a YouTube video by providing the shortened URL, for example *https://youtu.be/2tdiKTSdE9Y*.
+- Add a Channel ID or Channel URL to add every available video to the download queue. This will ignore the channel page size as described before and is meant for an initial download of the whole channel. You can still ignore selected videos before starting the download.
+- Add a channel name like for example *https://www.youtube.com/c/TomScottGo*.
+- Add a playlist ID or URL to add every available video in the list to the download queue, for example *https://www.youtube.com/playlist?list=PL96C35uN7xGLLeET0dOWaKHkAlPsrkcha* or *PL96C35uN7xGLLeET0dOWaKHkAlPsrkcha*. 
+  - Note: When adding a playlist to the queue, this playlist will automatically get [indexed](Playlists#playlist-detail).
+  - Note: When you add a link to a video in a playlist, Tube Archivist assumes you want to download only the specific video and not the whole playlist, for example *https://www.youtube.com/watch?v=CINVwWHlzTY&list=PL96C35uN7xGLLeET0dOWaKHkAlPsrkcha* will only add one video *CINVwWHlzTY* to the queue.
+- Add one link per line.
+
+## The Download Queue
+Below the three buttons you find the download queue. New items will get added at the bottom of the queue, the next video to download once you click on **Start Download** will be the first in the list.
+
+Every video in the download queue has two buttons:
+- **Ignore**: This will remove that video from the download queue and this video will not get added again, even when you **Rescan Subscriptions**.
+- **Download now**: This will give priority to this video. If the download process is already running, the prioritized video will get downloaded as soon as the current video is finished. If there is no download process running, this will start downloading this single video and stop after that.  
+
+The button **Delete all queued** will delete all pending videos from the download queue.
+
+You can flip the view by activating **Show Only Ignored Videos**. This will show all videos you have previously *ignored*.  
+Every video in the ignored list has two buttons:
+- **Forget**: This will delete the item form the ignored list.
+- **Add to Queue**: This will add the ignored video back to the download queue.  
+
+The button **Delete all ignored** will delete all videos you have previously ignored.

docs/FAQ.md

@@ -0,0 +1,31 @@
+# Frequently Asked Questions
+
+## 1. Scope of this project
+Tube Archivist is *Your self hosted YouTube media server*, which also defines the primary scope of what this project tries to do:
+- **Self hosted**: This assumes you have full control over the underlying operating system and hardware and can configure things to work properly with Docker, it's volumes and networks as well as whatever disk storage and filesystem you choose to use.
+- **YouTube**: Downloading, indexing and playing videos from YouTube, there are currently no plans to expand this to any additional platforms.
+- **Media server**: This project tries to be a stand alone media server in it's own web interface.
+
+Additionally to that, progress is also happening on:
+- **API**: Endpoints for additional integrations.
+- **Browser Extension**: To integrate between youtube.com and Tube Archivist.
+
+Defining the scope is important for the success of any project:
+- A scope too broad will result in development effort spreading too thin and will run into danger that his project tries to do too many things and none of them well.
+- A too narrow scope will make this project uninteresting and will exclude audiences that could also benefit from this project.
+- Not defining a scope will easily lead to misunderstandings and false hopes of where this project tries to go.
+
+Of course this is subject to change, as this project continues to grow and more people contribute.
+
+## 2. Emby/Plex/Jellyfin/Kodi integrations
+Although there are similarities between these excellent projects and Tube Archivist, they have a very different use case. Trying to fit the metadata relations and database structure of a YouTube archival project into these media servers that specialize in Movies and TV shows is always going to be limiting.
+
+Part of the scope is to be its own media server, so that's where the focus and effort of this project is. That being said, the nature of self hosted and open source software gives you all the possible freedom to use your media as you wish.
+
+## 3. To Docker or not to Docker
+This project is a classical docker application: There are multiple moving parts that need to be able to interact with each other and need to be compatible with multiple architectures and operating systems. Additionally Docker also drastically reduces development complexity which is highly appreciated.  
+
+So Docker is the only supported installation method. If you don't have any experience with Docker, consider investing the time to learn this very useful technology.
+
+## 4. Finetuning Elasticsearch
+A minimal configuration of Elasticsearch (ES) is provided in the example docker-compose.yml file. ES is highly configurable and very interesting to learn more about. Refer to the [documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html) if you want to get into it.

docs/Home.md

@@ -0,0 +1,30 @@
+# Tube Archivist Wiki
+Welcome to the official Tube Archivist Wiki. This is an up-to-date documentation of user functionality.
+
+Table of contents:
+* [FAQ](FAQ): Frequently asked questions what this project is and tries to do
+* [Channels](Channels): Browse your channels, handle channel subscriptions
+* [Playlists](Playlists): Browse your indexed playlists, handle playlist subscriptions
+* [Downloads](Downloads): Scanning subscriptions, handle download queue
+* [Settings](Settings): All the configuration options
+* [Video](Video): All details of a single video and playlist navigation.
+* [Users](Users): User management admin interface
+
+## Getting Started
+1. [Subscribe](Channels#channels-overview) to some of your favourite YouTube channels.
+2. [Scan](Downloads#rescan-subscriptions) subscriptions to add the latest videos to the download queue.
+3. [Add](Downloads#add-to-download-queue) additional videos, channels or playlist - ignore the ones you don't want to download.
+4. [Download](Downloads#download-queue) and let **Tube Archivist** do it's thing.
+5. Sit back and enjoy your archived and indexed collection!
+
+## General Navigation
+* Clicking on the channel name or the channel icon brings you to the dedicated channel page to show videos from that channel.
+* Clicking on a video title brings you to the dedicated video page and shows additional details.
+* Clicking on a video thumbnail opens the video player and starts streaming the selected video.
+* Clicking on the search icon <img src="assets/icon-search.png?raw=true" alt="gridview icon" width="20px" style="margin:0 5px;"> will open a dedicated search page to search over your complete index.
+* The pagination - if available - builds links for up to 10'000 results, use the search, sort or filter functionality to find what you are looking for.
+
+
+An empty checkbox icon <img src="assets/icon-unseen.png?raw=true" alt="unseen icon" width="20px" style="margin:0 5px;"> will show for videos you haven't marked as watched. Click on it and the icon will change to a filled checkbox <img src="assets/icon-seen.png?raw=true" alt="seen icon" width="20px" style="margin:0 5px;"> indicating it as watched - click again to revert.
+
+When available the <img src="assets/icon-gridview.png?raw=true" alt="gridview icon" width="20px" style="margin:0 5px;"> gridview icon will display the list in a grid, the <img src="assets/icon-listview.png?raw=true" alt="listview icon" width="20px" style="margin:0 5px;"> listview icon will arrange the items in a list. The sort icon <img src="assets/icon-sort.png?raw=true" alt="listview icon" width="20px" style="margin:0 5px;"> will open additional sort options.

docs/Playlists.md

@@ -0,0 +1,23 @@
+# Playlist Overview and Playlist Detail Page
+The playlists are organized in two different levels, similar as the [channels](Channels):
+
+## Playlist Overview
+Accessible at `/playlist/` of your Tube Archivist, this **Overview Page** shows a list of all playlists you have indexed over all your channels.
+- You can filter that list to show only subscribed to playlists with the toggle.
+
+You can index playlists of a channel from the channel detail page as described [here](Channels#channel-detail).
+
+The **Subscribe to Playlist** button <img src="assets/icon-add.png?raw=true" alt="add icon" width="20px" style="margin:0 5px;"> opens a text field to subscribe to playlists. You have a few options:
+- Enter the YouTube playlist id, for example: *PL96C35uN7xGLLeET0dOWaKHkAlPsrkcha*
+- Enter the Youtube dedicated playlist url, for example: *https://www.youtube.com/playlist?list=PL96C35uN7xGLLeET0dOWaKHkAlPsrkcha*
+- Add one per line.
+- NOTE: It doesn't make sense to subscribe to a playlist if you are already subscribed the corresponding channel as this will slow down the **Rescan Subscriptions** [task](Downloads#rescan-subscriptions).
+
+You can search your indexed playlists by clicking on the search icon <img src="assets/icon-search.png?raw=true" alt="search icon" width="20px" style="margin:0 5px;">. This will open a dedicated page.
+
+## Playlist Detail
+Each playlist will get a dedicated playlist detail page accessible at `/playlist/<playlist-id>/` of your Tube Archivist. This page shows all the videos you have downloaded from this playlist.
+
+- If you are subscribed to the playlist, an Unsubscribe button will show, else the Subscribe button will show.
+- The Mark as Watched button will mark all videos of this playlist as watched.
+- The **Delete Playlist** button will give you the option to delete just the *metadata* which won't delete any media files or *delete all* which will delete metadata plus all videos belonging to this playlist.

docs/Settings.md

@@ -0,0 +1,133 @@
+# Settings Page
+Accessible at `/settings/` of your **Tube Archivist**, this page holds all the configurations and additional functionality related to the database.
+
+Click on **Update Settings** at the bottom of the form to apply your configurations.
+
+## Color scheme
+Switch between the easy on the eyes dark theme and the burning bright theme.
+
+## Archive View
+- **Page Size**: Defines how many results get displayed on a given page. Same value goes for all archive views.
+
+## Subscriptions
+Settings related to the channel management.
+- **Channel Page Size**: Defines how many pages will get analyzed by **Tube Archivist** each time you click on *Rescan Subscriptions*. The default page size used by yt-dlp is **50**, that's also the recommended value to set here. Any value higher will slow down the rescan process, for example if you set the value to 51, that means yt-dlp will have to go through 2 pages of results instead of 1 and by that doubling the time that process takes.
+
+## Downloads
+Settings related to the download process.
+- **Download Limit**: Stop the download process after downloading the set quantity of videos.
+- **Download Speed Limit**: Set your download speed limit in KB/s. This will pass the option `--limit-rate` to yt-dlp.
+- **Throttled Rate Limit**: Restart download if the download speed drops below this value in KB/s. This will pass the option `--throttled-rate` to yt-dlp. Using this option might have a negative effect if you have an unstable or slow internet connection.
+- **Sleep Interval**: Time in seconds to sleep between requests to YouTube. It's a good idea to set this to **3** seconds. Might be necessary to avoid throttling.
+- **Auto Delete Watched Videos**: Automatically delete videos marked as watched after selected days. If activated, checks your videos after download task is finished.
+
+## Download Format
+Additional settings passed to yt-dlp.
+- **Format**: This controls which streams get downloaded and is equivalent to passing `--format` to yt-dlp. Use one of the recommended one or look at the documentation of [yt-dlp](https://github.com/yt-dlp/yt-dlp#format-selection). Please note: The option `--merge-output-format mp4` is automatically passed to yt-dlp to guarantee browser compatibility. Similar to that, `--check-formats` is passed as well to check that the selected formats are actually downloadable.
+- **Embed Metadata**: This saves the available tags directly into the media file by passing `--embed-metadata` to yt-dlp.
+- **Embed Thumbnail**: This will save the thumbnail into the media file by passing `--embed-thumbnail` to yt-dlp.
+
+## Subtitles
+- **Download Setting**: Select the subtitle language you like to download. Add a comma separated list for multiple languages.
+- **Source Settings**: User created subtitles are provided from the uploader and are usually the video script. Auto generated is from YouTube, quality varies, particularly for auto translated tracks.
+- **Index Settings**: Enabling subtitle indexing will add the lines to Elasticsearch and will make subtitles searchable. This will increase the index size and is not recommended on low-end hardware.
+
+## Integrations
+All third party integrations of TubeArchivist will **always** be *opt in*.
+- **API**: Your access token for the Tube Archivist API. 
+- **returnyoutubedislike.com**: This will get return dislikes and average ratings for each video by integrating with the API from [returnyoutubedislike.com](https://www.returnyoutubedislike.com/).
+- **Cast**: Enabling the cast integration in the settings page will load an additional JS library from **Google**.
+    * Requirements
+        - HTTPS
+            * To use the cast integration HTTPS needs to be enabled, which can be done using a reverse proxy. This is a requirement by Google as communication to the cast device is required to be encrypted, but the content itself is not.
+        - Supported Browser
+            * A supported browser is required for this integration such as Google Chrome. Other browsers, especially Chromium-based browsers, may support casting by enabling it in the settings.
+        - Subtitles
+            * Subtitles are supported however they do not work out of the box and require additional configuration. Due to requirements by Google, to use subtitles you need additional headers which will need to be configured in your reverse proxy. See this [page](https://developers.google.com/cast/docs/web_sender/advanced#cors_requirements) for the specific requirements.
+               > You need the following headers: Content-Type, Accept-Encoding, and Range. Note that the last two headers, Accept-Encoding and Range, are additional headers that you may not have needed previously.
+               > Wildcards "*" cannot be used for the Access-Control-Allow-Origin header. If the page has protected media content, it must use a domain instead of a wildcard.
+
+
+# Scheduler Setup
+Schedule settings expect a cron like format, where the first value is minute, second is hour and third is day of the week. Day 0 is Sunday, day 1 is Monday etc.
+
+Examples:
+- **0 15 \***: Run task every day at 15:00 in the afternoon.
+- **30 8 \*/2**: Run task every second day of the week (Sun, Tue, Thu, Sat) at 08:30 in the morning.
+- **0 \*/3,8-17 \***: Execute every hour divisible by 3, and every hour during office hours (8 in the morning - 5 in the afternoon).
+- **0 8,16 \***: Execute every day at 8 in the morning and at 4 in the afternoon. 
+- **auto**: Sensible default.
+- **0**: (zero), deactivate that task.
+
+NOTE:
+- Changes in the scheduler settings require a container restart to take effect.
+- Cron format as *number*/*number* are none standard cron and are not supported by the scheduler, for example **0 0/12 \*** is invalid, use **0 \*/12 \*** instead.
+- Avoid an unnecessary frequent schedule to not get blocked by YouTube. For that reason * or wildcards for minutes are not supported.
+
+## Rescan Subscriptions
+That's the equivalent task as run from the downloads page looking through your channel and playlist and add missing videos to the download queue.
+
+## Start download
+Start downloading all videos currently in the download queue.
+
+## Refresh Metadata
+Rescan videos, channels and playlists on youtube and update metadata periodically. This will also deactivate an item and exclude it from future refreshes if the link on YouTube is no longer available. This task is meant to be run once per day, set your schedule accordingly. 
+
+The field **Refresh older than x days** takes a number where TubeArchivist will consider an item as *outdated*. This value is used to calculate how many items need to be refreshed today based on the total indexed. This will spread out the requests to YouTube. Sensible value here is **90** days. 
+
+## Thumbnail check
+This will check if all expected thumbnails are there and will delete any artwork without matching video.
+
+## Index backup
+Create a zip file of the metadata and select **Max auto backups to keep** to automatically delete old backups created from this task.
+
+
+# Actions
+Additional database functionality.
+
+## Manual Media Files Import
+So far this depends on the video you are trying to import to be still available on YouTube to get the metadata. Add the files you'd like to import to the */cache/import* folder. Then start the process from the settings page *Manual Media Files Import*. Make sure to follow one of the two methods below.
+
+### Method 1:
+Add a matching *.json* file with the media file. Both files need to have the same base name, for example:
+- For the media file: \<base-name>.mp4
+- For the JSON file: \<base-name>.info.json
+- Alternate JSON file: \<base-name>.json
+
+**Tube Archivist** then looks for the 'id' key within the JSON file to identify the video.
+
+### Method 2:
+Detect the YouTube ID from filename, this accepts the default yt-dlp naming convention for file names like:
+- \<base-name>[\<youtube-id>].mp4
+- The YouTube ID in square brackets at the end of the filename is the crucial part.
+
+### Some notes:
+- This will **consume** the files you put into the import folder: Files will get converted to mp4 if needed (this might take a long time...) and moved to the archive, *.json* files will get deleted upon completion to avoid having duplicates on the next run.
+- There should be no subdirectories added to */cache/import*, only video files. If your existing video library has video files inside subdirectories, you can get all the files into one directory by running `find ./ -mindepth 2 -type f -exec mv '{}' . \;` from the top-level directory of your existing video library. You can also delete any remaining empty subdirectories with `find ./ -mindepth 1 -type d -delete`.
+- Maybe start with a subset of your files to import to make sure everything goes well...
+- Follow the logs to monitor progress and errors: `docker-compose logs -f tubearchivist`.
+
+## Embed thumbnails into media file
+This will write or overwrite all thumbnails in the media file using the downloaded thumbnail. This is only necessary if you didn't download the files with the option *Embed Thumbnail* enabled or want to make sure all media files get the newest thumbnail. Follow the docker-compose logs to monitor progress.
+
+## Backup Database
+This will backup your metadata into a zip file. The file will get stored at *cache/backup* and will contain the necessary files to restore the Elasticsearch index formatted **nd-json** files plus a complete export of the index in a set of conventional **json** files.  
+
+BE AWARE: This will **not** backup any media files, just the metadata from the Elasticsearch.
+
+## Restore From Backup
+The restore functionality will expect the same zip file in *cache/backup* as created from the **Backup database** function. This will recreate the index from the snapshot. There will be a list of all available backup to choose from. The *source* tag can have these different values:
+- **manual**: For backups manually created from here on the settings page.
+- **auto**: For backups automatically created via a sceduled task.
+- **update**: For backups created after a Tube Archivist update due to changes in the index.
+- **False**: Undefined.
+
+BE AWARE: This will **replace** your current index with the one from the backup file. This won't restore any media files.
+
+## Rescan Filesystem
+This function will go through all your media files and looks at the whole index to try to find any issues:
+- Should the filename not match with the indexed media url, this will rename the video files correctly and update the index with the new link.
+- When you delete media files from the filesystem outside of the Tube Archivist interface, this will delete leftover metadata from the index.
+- When you have media files that are not indexed yet, this will grab the metadata from YouTube like it was a newly downloaded video. This can be useful when restoring from an older backup file with missing metadata but already downloaded mediafiles. NOTE: This only works if the media files are named in the same convention as Tube Archivist does, particularly the YouTube ID needs to be at the same index in the filename, alternatively see above for *Manual Media Files Import*.
+
+BE AWARE: There is no undo.

docs/Users.md

@@ -0,0 +1,20 @@
+# User Management
+
+For now, **Tube Archivist** is a single user application. You can create multiple users with different names and passwords, they will share the same videos and permissions but some interface configurations are on a per user basis. *More is on the roadmap*.
+
+## Superuser
+The first user gets created with the environment variables **TA_USERNAME** and **TA_PASSWORD** from your docker-compose file. That first user will automatically have *superuser* privileges. 
+
+## Admin Interface
+When logged in from your *superuser* account, you are able to access the admin interface from the settings page or at `/admin/`. This interface holds all functionality for user management.
+
+## Create additional users
+From the admin interface when you click on *Accounts* you will get a list of all users. From there you can create additional users by clicking on *Add Account*, provide a name and confirm password and click on *Save* to create the user.
+
+## Changing users
+You can delete or change permissions and password of a user by clicking on the username from the *Accounts* list page and follow the interface from there. Changing the password of the *superuser* here will overwrite the password originally set with the environment variables.
+
+## Reset
+Delete all user configurations by deleting the file `cache/db.sqlite3` and restart the container. This will create the superuser again from the environment variables.
+
+NOTE: Future improvements here will most likely require such a reset.

docs/Video.md

@@ -0,0 +1,11 @@
+# Video Page
+
+Every video downloaded gets a dedicated page accessible at `/video/<video-id>` of your Tube Archivist.
+
+Clicking on the channel name or the channel icon will bring you to the dedicated channel detail [page](Channels#channel-detail).
+
+The button **Delete Video** will delete that video including the media file.
+
+When available, a playlist navigation will show at the bottom. Clicking on the playlist name will bring you to the dedicated [Playlist Detail](Playlists#playlist-detail) page showing all videos downloaded from that playlist. The number in square brackets indicates the position of the current video in that playlist.
+
+Clicking on the next or previous video name or thumbnail will bring you to that dedicated video page.

nginx.conf

@@ -1,18 +0,0 @@
-server {
-
-    listen 8000;
-
-    location /cache/ {
-        alias /cache/;
-    }
-
-    location /media/ {
-        alias /youtube/;
-    }
-
-    location / {
-        include uwsgi_params;
-        uwsgi_pass localhost:8080;
-    }
-
-}

run.sh

@@ -1,20 +0,0 @@
-#!/bin/bash
-# startup script inside the container for tubearchivist
-
-counter=0
-until curl "$ES_URL" -fs; do
-    echo "waiting for elastic search to start"
-    counter=$((counter+1))
-    if [[ $counter -eq 12 ]]; then
-        # fail after 1 min
-        echo "failed to connect to elastic search, exiting..."
-        exit 1
-    fi
-    sleep 5
-done
-
-python manage.py migrate
-python manage.py collectstatic --noinput -c
-nginx &
-celery -A home.tasks worker --loglevel=INFO &
-uwsgi --ini uwsgi.ini

tubearchivist/api/README.md

@@ -0,0 +1,85 @@
+# TubeArchivist API
+Documentation of available API endpoints.  
+**Note: This is very early alpha and will change!**
+
+## Authentication
+API token will get automatically created, accessible on the settings page. Token needs to be passed as an authorization header with every request. Additionally session based authentication is enabled too: When you are logged into your TubeArchivist instance, you'll have access to the api in the browser for testing.
+
+Curl example:
+```shell
+curl -v /api/video/<video-id>/ \
+    -H "Authorization: Token xxxxxxxxxx"
+```
+
+Python requests example:
+```python
+import requests
+
+url = "/api/video/<video-id>/"
+headers = {"Authorization": "Token xxxxxxxxxx"}
+response = requests.get(url, headers=headers)
+```
+
+## Video Item View
+/api/video/\<video_id>/
+
+## Video Progress View
+/api/video/\<video_id>/progress  
+
+Progress is stored for each user.
+
+### Get last player position of a video
+GET /api/video/\<video_id>/progress
+```json
+{
+    "youtube_id": "<video_id>",
+    "user_id": 1,
+    "position": 100
+}
+```
+
+### Post player position of video
+POST /api/video/\<video_id>/progress
+```json
+{
+    "position": 100
+}
+```
+
+### Delete player position of video
+DELETE /api/video/\<video_id>/progress  
+
+## Channel List View
+/api/channel/
+
+### Subscribe to a list of channels
+POST /api/channel/
+```json
+{
+    "data": [
+        {"channel_id": "UC9-y-6csu5WGm29I7JiwpnA", "channel_subscribed": true}
+    ]
+}
+```
+
+## Channel Item View
+/api/channel/\<channel_id>/
+
+## Playlists Item View
+/api/playlist/\<playlist_id>/
+
+## Download Queue List View
+/api/download/
+
+### Add list of videos to download queue
+POST /api/download/
+```json
+{
+    "data": [
+        {"youtube_id": "NYj3DnI81AQ", "status": "pending"}
+    ]
+}
+```
+
+## Download Queue Item View
+/api/download/\<video_id>/

tubearchivist/api/admin.py

@@ -0,0 +1,3 @@
+from django.contrib import admin  # noqa: F401
+
+# Register your models here.

tubearchivist/api/apps.py

@@ -0,0 +1,10 @@
+"""apps file for api package"""
+
+from django.apps import AppConfig
+
+
+class ApiConfig(AppConfig):
+    """app config"""
+
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "api"

tubearchivist/api/models.py

@@ -0,0 +1,3 @@
+"""api models"""
+
+# from django.db import models

tubearchivist/api/tests.py

@@ -0,0 +1,3 @@
+from django.test import TestCase  # noqa: F401
+
+# Create your tests here.

tubearchivist/api/urls.py

@@ -0,0 +1,50 @@
+"""all api urls"""
+
+from api.views import (
+    ChannelApiListView,
+    ChannelApiView,
+    DownloadApiListView,
+    DownloadApiView,
+    PlaylistApiView,
+    VideoApiView,
+    VideoProgressView,
+)
+from django.urls import path
+
+urlpatterns = [
+    path(
+        "video/<slug:video_id>/",
+        VideoApiView.as_view(),
+        name="api-video",
+    ),
+    path(
+        "video/<slug:video_id>/progress/",
+        VideoProgressView.as_view(),
+        name="api-video-progress",
+    ),
+    path(
+        "channel/",
+        ChannelApiListView.as_view(),
+        name="api-channel-list",
+    ),
+    path(
+        "channel/<slug:channel_id>/",
+        ChannelApiView.as_view(),
+        name="api-channel",
+    ),
+    path(
+        "playlist/<slug:playlist_id>/",
+        PlaylistApiView.as_view(),
+        name="api-playlist",
+    ),
+    path(
+        "download/",
+        DownloadApiListView.as_view(),
+        name="api-download-list",
+    ),
+    path(
+        "download/<slug:video_id>/",
+        DownloadApiView.as_view(),
+        name="api-download",
+    ),
+]

tubearchivist/api/views.py

@@ -0,0 +1,262 @@
+"""all API views"""
+
+import requests
+from home.src.download.thumbnails import ThumbManager
+from home.src.ta.config import AppConfig
+from home.src.ta.helper import UrlListParser
+from home.src.ta.ta_redis import RedisArchivist
+from home.tasks import extrac_dl, subscribe_to
+from rest_framework.authentication import (
+    SessionAuthentication,
+    TokenAuthentication,
+)
+from rest_framework.permissions import IsAuthenticated
+from rest_framework.response import Response
+from rest_framework.views import APIView
+
+
+class ApiBaseView(APIView):
+    """base view to inherit from"""
+
+    authentication_classes = [SessionAuthentication, TokenAuthentication]
+    permission_classes = [IsAuthenticated]
+    search_base = False
+
+    def __init__(self):
+        super().__init__()
+        self.response = {"data": False}
+        self.status_code = False
+        self.context = False
+        self.default_conf = AppConfig().config
+
+    def config_builder(self):
+        """build confic context"""
+        self.context = {
+            "es_url": self.default_conf["application"]["es_url"],
+            "es_auth": self.default_conf["application"]["es_auth"],
+        }
+        self.response["config"] = self.default_conf
+
+    def get_document(self, document_id):
+        """get single document from es"""
+        es_url = self.context["es_url"]
+        url = f"{es_url}{self.search_base}{document_id}"
+        print(url)
+        response = requests.get(url, auth=self.context["es_auth"])
+        try:
+            self.response["data"] = response.json()["_source"]
+        except KeyError:
+            print(f"item not found: {document_id}")
+            self.response["data"] = False
+        self.status_code = response.status_code
+
+    def process_keys(self):
+        """process keys for frontend"""
+        all_keys = self.response["data"].keys()
+        if "media_url" in all_keys:
+            media_url = self.response["data"]["media_url"]
+            self.response["data"]["media_url"] = f"/media/{media_url}"
+        if "vid_thumb_url" in all_keys:
+            youtube_id = self.response["data"]["youtube_id"]
+            vid_thumb_url = ThumbManager().vid_thumb_path(youtube_id)
+            cache_dir = self.default_conf["application"]["cache_dir"]
+            new_thumb = f"{cache_dir}/{vid_thumb_url}"
+            self.response["data"]["vid_thumb_url"] = new_thumb
+        if "subtitles" in all_keys:
+            all_subtitles = self.response["data"]["subtitles"]
+            for idx, _ in enumerate(all_subtitles):
+                url = self.response["data"]["subtitles"][idx]["media_url"]
+                new_url = f"/media/{url}"
+                self.response["data"]["subtitles"][idx]["media_url"] = new_url
+
+    def get_paginate(self):
+        """add pagination detail to response"""
+        self.response["paginate"] = False
+
+    def get_document_list(self, data):
+        """get a list of results"""
+        es_url = self.context["es_url"]
+        url = f"{es_url}{self.search_base}"
+        print(url)
+        response = requests.get(url, json=data, auth=self.context["es_auth"])
+        all_hits = response.json()["hits"]["hits"]
+        self.response["data"] = [i["_source"] for i in all_hits]
+        self.status_code = response.status_code
+
+
+class VideoApiView(ApiBaseView):
+    """resolves to /api/video/<video_id>/
+    GET: returns metadata dict of video
+    """
+
+    search_base = "/ta_video/_doc/"
+
+    def get(self, request, video_id):
+        # pylint: disable=unused-argument
+        """get request"""
+        self.config_builder()
+        self.get_document(video_id)
+        self.process_keys()
+        return Response(self.response, status=self.status_code)
+
+
+class VideoProgressView(ApiBaseView):
+    """resolves to /api/video/<video_id>/
+    handle progress status for video
+    """
+
+    def get(self, request, video_id):
+        """get progress for a single video"""
+        user_id = request.user.id
+        key = f"{user_id}:progress:{video_id}"
+        video_progress = RedisArchivist().get_message(key)
+        position = video_progress.get("position", 0)
+
+        self.response = {
+            "youtube_id": video_id,
+            "user_id": user_id,
+            "position": position,
+        }
+        return Response(self.response)
+
+    def post(self, request, video_id):
+        """set progress position in redis"""
+        position = request.data.get("position", 0)
+        key = f"{request.user.id}:progress:{video_id}"
+        message = {"position": position, "youtube_id": video_id}
+        RedisArchivist().set_message(key, message, expire=False)
+        self.response = request.data
+
+        return Response(self.response)
+
+    def delete(self, request, video_id):
+        """delete progress position"""
+        key = f"{request.user.id}:progress:{video_id}"
+        RedisArchivist().del_message(key)
+        self.response = {"progress-reset": video_id}
+
+        return Response(self.response)
+
+
+class ChannelApiView(ApiBaseView):
+    """resolves to /api/channel/<channel_id>/
+    GET: returns metadata dict of channel
+    """
+
+    search_base = "/ta_channel/_doc/"
+
+    def get(self, request, channel_id):
+        # pylint: disable=unused-argument
+        """get request"""
+        self.config_builder()
+        self.get_document(channel_id)
+        return Response(self.response, status=self.status_code)
+
+
+class ChannelApiListView(ApiBaseView):
+    """resolves to /api/channel/
+    GET: returns list of channels
+    POST: edit a list of channels
+    """
+
+    search_base = "/ta_channel/_search/"
+
+    def get(self, request):
+        # pylint: disable=unused-argument
+        """get request"""
+        data = {"query": {"match_all": {}}}
+        self.config_builder()
+        self.get_document_list(data)
+        self.get_paginate()
+
+        return Response(self.response)
+
+    @staticmethod
+    def post(request):
+        """subscribe to list of channels"""
+        data = request.data
+        try:
+            to_add = data["data"]
+        except KeyError:
+            message = "missing expected data key"
+            print(message)
+            return Response({"message": message}, status=400)
+
+        pending = [i["channel_id"] for i in to_add if i["channel_subscribed"]]
+        url_str = " ".join(pending)
+        subscribe_to.delay(url_str)
+
+        return Response(data)
+
+
+class PlaylistApiView(ApiBaseView):
+    """resolves to /api/playlist/<playlist_id>/
+    GET: returns metadata dict of playlist
+    """
+
+    search_base = "/ta_playlist/_doc/"
+
+    def get(self, request, playlist_id):
+        # pylint: disable=unused-argument
+        """get request"""
+        self.config_builder()
+        self.get_document(playlist_id)
+        return Response(self.response, status=self.status_code)
+
+
+class DownloadApiView(ApiBaseView):
+    """resolves to /api/download/<video_id>/
+    GET: returns metadata dict of an item in the download queue
+    """
+
+    search_base = "/ta_download/_doc/"
+
+    def get(self, request, video_id):
+        # pylint: disable=unused-argument
+        """get request"""
+        self.config_builder()
+        self.get_document(video_id)
+        return Response(self.response, status=self.status_code)
+
+
+class DownloadApiListView(ApiBaseView):
+    """resolves to /api/download/
+    GET: returns latest videos in the download queue
+    POST: add a list of videos to download queue
+    """
+
+    search_base = "/ta_download/_search/"
+
+    def get(self, request):
+        # pylint: disable=unused-argument
+        """get request"""
+        data = {"query": {"match_all": {}}}
+        self.config_builder()
+        self.get_document_list(data)
+        self.get_paginate()
+        return Response(self.response)
+
+    @staticmethod
+    def post(request):
+        """add list of videos to download queue"""
+        print(f"request meta data: {request.META}")
+        data = request.data
+        try:
+            to_add = data["data"]
+        except KeyError:
+            message = "missing expected data key"
+            print(message)
+            return Response({"message": message}, status=400)
+
+        pending = [i["youtube_id"] for i in to_add if i["status"] == "pending"]
+        url_str = " ".join(pending)
+        try:
+            youtube_ids = UrlListParser(url_str).process_list()
+        except ValueError:
+            message = f"failed to parse: {url_str}"
+            print(message)
+            return Response({"message": message}, status=400)
+
+        extrac_dl.delay(youtube_ids)
+
+        return Response(data)

tubearchivist/config/asgi.py

@@ -11,6 +11,6 @@ import os
 
 from django.core.asgi import get_asgi_application
 
-os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'config.settings')
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "config.settings")
 
 application = get_asgi_application()

tubearchivist/config/settings.py

@@ -10,8 +10,12 @@ For the full list of settings and their values, see
 https://docs.djangoproject.com/en/3.2/ref/settings/
 """
 
+import hashlib
+from os import environ, path
 from pathlib import Path
-from os import environ
+
+from corsheaders.defaults import default_headers
+from home.src.ta.config import AppConfig
 
 # Build paths inside the project like this: BASE_DIR / 'subdir'.
 BASE_DIR = Path(__file__).resolve().parent.parent
@@ -20,68 +24,75 @@ BASE_DIR = Path(__file__).resolve().parent.parent
 # Quick-start development settings - unsuitable for production
 # See https://docs.djangoproject.com/en/3.2/howto/deployment/checklist/
 
-# SECURITY WARNING: keep the secret key used in production secret!
-SECRET_KEY = 'Fvid^aUL6LohRZz*kZFvq85B&JW&kB9o*#jdzWsdWE8*XkCLR8'
+PW_HASH = hashlib.sha256(environ.get("TA_PASSWORD").encode())
+SECRET_KEY = PW_HASH.hexdigest()
 
 # SECURITY WARNING: don't run with debug turned on in production!
-DEBUG = bool(environ.get('DJANGO_DEBUG'))
+DEBUG = bool(environ.get("DJANGO_DEBUG"))
 
-ALLOWED_HOSTS = ['*']
+ALLOWED_HOSTS = ["*"]
 
 
 # Application definition
 
 INSTALLED_APPS = [
-    'home.apps.HomeConfig',
-    'django.contrib.admin',
-    'django.contrib.auth',
-    'django.contrib.contenttypes',
-    'django.contrib.sessions',
-    'django.contrib.messages',
-    'whitenoise.runserver_nostatic',
-    'django.contrib.staticfiles',
-    'django.contrib.humanize'
+    "home.apps.HomeConfig",
+    "django.contrib.admin",
+    "django.contrib.auth",
+    "django.contrib.contenttypes",
+    "django.contrib.sessions",
+    "django.contrib.messages",
+    "corsheaders",
+    "whitenoise.runserver_nostatic",
+    "django.contrib.staticfiles",
+    "django.contrib.humanize",
+    "rest_framework",
+    "rest_framework.authtoken",
+    "api",
 ]
 
 MIDDLEWARE = [
-    'django.middleware.security.SecurityMiddleware',
-    'django.contrib.sessions.middleware.SessionMiddleware',
-    'whitenoise.middleware.WhiteNoiseMiddleware',
-    'django.middleware.common.CommonMiddleware',
-    'django.middleware.csrf.CsrfViewMiddleware',
-    'django.contrib.auth.middleware.AuthenticationMiddleware',
-    'django.contrib.messages.middleware.MessageMiddleware',
-    'django.middleware.clickjacking.XFrameOptionsMiddleware',
+    "django.middleware.security.SecurityMiddleware",
+    "django.contrib.sessions.middleware.SessionMiddleware",
+    "corsheaders.middleware.CorsMiddleware",
+    "whitenoise.middleware.WhiteNoiseMiddleware",
+    "django.middleware.common.CommonMiddleware",
+    "django.middleware.csrf.CsrfViewMiddleware",
+    "django.contrib.auth.middleware.AuthenticationMiddleware",
+    "django.contrib.messages.middleware.MessageMiddleware",
+    "django.middleware.clickjacking.XFrameOptionsMiddleware",
 ]
 
-ROOT_URLCONF = 'config.urls'
+ROOT_URLCONF = "config.urls"
 
 TEMPLATES = [
     {
-        'BACKEND': 'django.template.backends.django.DjangoTemplates',
-        'DIRS': [],
-        'APP_DIRS': True,
-        'OPTIONS': {
-            'context_processors': [
-                'django.template.context_processors.debug',
-                'django.template.context_processors.request',
-                'django.contrib.auth.context_processors.auth',
-                'django.contrib.messages.context_processors.messages',
+        "BACKEND": "django.template.backends.django.DjangoTemplates",
+        "DIRS": [],
+        "APP_DIRS": True,
+        "OPTIONS": {
+            "context_processors": [
+                "django.template.context_processors.debug",
+                "django.template.context_processors.request",
+                "django.contrib.auth.context_processors.auth",
+                "django.contrib.messages.context_processors.messages",
             ],
         },
     },
 ]
 
-WSGI_APPLICATION = 'config.wsgi.application'
+WSGI_APPLICATION = "config.wsgi.application"
 
 
 # Database
 # https://docs.djangoproject.com/en/3.2/ref/settings/#databases
 
+CACHE_DIR = AppConfig().config["application"]["cache_dir"]
+DB_PATH = path.join(CACHE_DIR, "db.sqlite3")
 DATABASES = {
-    'default': {
-        'ENGINE': 'django.db.backends.sqlite3',
-        'NAME': BASE_DIR / 'db.sqlite3',
+    "default": {
+        "ENGINE": "django.db.backends.sqlite3",
+        "NAME": DB_PATH,
     }
 }
 
@@ -91,54 +102,52 @@ DATABASES = {
 
 AUTH_PASSWORD_VALIDATORS = [
     {
-        'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
+        "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator",  # noqa: E501
     },
     {
-        'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
+        "NAME": "django.contrib.auth.password_validation.MinimumLengthValidator",  # noqa: E501
     },
     {
-        'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
+        "NAME": "django.contrib.auth.password_validation.CommonPasswordValidator",  # noqa: E501
     },
     {
-        'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
+        "NAME": "django.contrib.auth.password_validation.NumericPasswordValidator",  # noqa: E501
     },
 ]
 
+AUTH_USER_MODEL = "home.Account"
+
 
 # Internationalization
 # https://docs.djangoproject.com/en/3.2/topics/i18n/
 
-LANGUAGE_CODE = 'en-us'
-
-TIME_ZONE = 'UTC'
-
+LANGUAGE_CODE = "en-us"
+TIME_ZONE = environ.get("TZ") or "UTC"
 USE_I18N = True
-
 USE_L10N = True
-
 USE_TZ = True
 
 
 # Static files (CSS, JavaScript, Images)
 # https://docs.djangoproject.com/en/3.2/howto/static-files/
 
-STATIC_URL = '/static/'
-
-# STATICFILES_DIRS = [
-#     str(BASE_DIR.joinpath('static')),
-#     '/cache/'
-# ]
-
-# STATIC_URL = '/static/'
-STATICFILES_DIRS = (str(BASE_DIR.joinpath('static')),)
-# MEDIA_ROOT = str(BASE_DIR.joinpath('media'))
-# MEDIA_URL = '/media/'
-
-STATIC_ROOT = str(BASE_DIR.joinpath('staticfiles'))
-
-STATICFILES_STORAGE = 'whitenoise.storage.CompressedManifestStaticFilesStorage'
+STATIC_URL = "/static/"
+STATICFILES_DIRS = (str(BASE_DIR.joinpath("static")),)
+STATIC_ROOT = str(BASE_DIR.joinpath("staticfiles"))
+STATICFILES_STORAGE = "whitenoise.storage.CompressedManifestStaticFilesStorage"
 
 # Default primary key field type
 # https://docs.djangoproject.com/en/3.2/ref/settings/#default-auto-field
 
-DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'
+DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"
+
+LOGIN_URL = "/login/"
+LOGOUT_REDIRECT_URL = "/login/"
+
+# Cors needed for browser extension
+# background.js makes the request so HTTP_ORIGIN will be from extension
+CORS_ALLOWED_ORIGIN_REGEXES = [r"moz-extension://*", r"chrome-extension://*"]
+
+CORS_ALLOW_HEADERS = list(default_headers) + [
+    "mode",
+]

tubearchivist/config/urls.py

@@ -14,9 +14,10 @@ Including another URLconf
     2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
 """
 from django.contrib import admin
-from django.urls import path, include
+from django.urls import include, path
 
 urlpatterns = [
-    path('', include('home.urls')),
-    path('admin/', admin.site.urls),
+    path("", include("home.urls")),
+    path("api/", include("api.urls")),
+    path("admin/", admin.site.urls),
 ]

tubearchivist/config/wsgi.py

@@ -11,6 +11,6 @@ import os
 
 from django.core.wsgi import get_wsgi_application
 
-os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'config.settings')
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "config.settings")
 
 application = get_wsgi_application()

tubearchivist/home/__init__.py

@@ -1,40 +1,5 @@
-""" handle startup """
-
-import os
-
-from home.src.config import AppConfig
-from home.src.helper import set_message
-from home.src.index_management import index_check
+""" handle celery startup """
 
 from .tasks import app as celery_app
 
-
-def sync_redis_state():
-    """ make sure redis gets the config.json values """
-    print('sync redis')
-    config = AppConfig().config
-    sort_order = config['archive']['sort']
-    set_message('sort_order', sort_order, expire=False)
-    hide_watched = bool(int(config['archive']['hide_watched']))
-    set_message('hide_watched', hide_watched, expire=False)
-    show_subed_only = bool(int(config['archive']['show_subed_only']))
-    set_message('show_subed_only', show_subed_only, expire=False)
-
-
-def make_folders():
-    """ make needed cache folders here so docker doesn't mess it up """
-    folders = ['download', 'channels', 'videos', 'import', 'backup']
-    config = AppConfig().config
-    cache_dir = config['application']['cache_dir']
-    for folder in folders:
-        folder_path = os.path.join(cache_dir, folder)
-        try:
-            os.makedirs(folder_path)
-        except FileExistsError:
-            continue
-
-
-__all__ = ('celery_app',)
-make_folders()
-sync_redis_state()
-index_check()
+__all__ = ("celery_app",)

tubearchivist/home/admin.py

@@ -1,3 +1,36 @@
-from django.contrib import admin
+"""custom admin classes"""
 
-# Register your models here.
+from django.contrib import admin
+from django.contrib.auth.admin import UserAdmin as BaseUserAdmin
+
+from .models import Account
+
+
+class HomeAdmin(BaseUserAdmin):
+    """register in admin page"""
+
+    list_display = ("name", "is_staff", "is_superuser")
+    list_filter = ("is_superuser",)
+
+    fieldsets = (
+        (None, {"fields": ("is_staff", "is_superuser", "password")}),
+        ("Personal info", {"fields": ("name",)}),
+        ("Groups", {"fields": ("groups",)}),
+        ("Permissions", {"fields": ("user_permissions",)}),
+    )
+    add_fieldsets = (
+        (
+            None,
+            {"fields": ("is_staff", "is_superuser", "password1", "password2")},
+        ),
+        ("Personal info", {"fields": ("name",)}),
+        ("Groups", {"fields": ("groups",)}),
+        ("Permissions", {"fields": ("user_permissions",)}),
+    )
+
+    search_fields = ("name",)
+    ordering = ("name",)
+    filter_horizontal = ()
+
+
+admin.site.register(Account, HomeAdmin)

tubearchivist/home/apps.py

@@ -1,6 +1,63 @@
+"""handle custom startup functions"""
+
+import os
+
 from django.apps import AppConfig
+from home.src.es.index_setup import index_check
+from home.src.ta.config import AppConfig as ArchivistConfig
+from home.src.ta.ta_redis import RedisArchivist
+
+
+def sync_redis_state():
+    """make sure redis gets new config.json values"""
+    print("sync redis")
+    config_handler = ArchivistConfig()
+    config_handler.load_new_defaults()
+
+
+def make_folders():
+    """make needed cache folders here so docker doesn't mess it up"""
+    folders = [
+        "download",
+        "channels",
+        "videos",
+        "playlists",
+        "import",
+        "backup",
+    ]
+    config = ArchivistConfig().config
+    cache_dir = config["application"]["cache_dir"]
+    for folder in folders:
+        folder_path = os.path.join(cache_dir, folder)
+        try:
+            os.makedirs(folder_path)
+        except FileExistsError:
+            continue
+
+
+def release_lock():
+    """make sure there are no leftover locks set in redis on container start"""
+    all_locks = [
+        "manual_import",
+        "downloading",
+        "dl_queue",
+        "dl_queue_id",
+        "rescan",
+    ]
+    for lock in all_locks:
+        response = RedisArchivist().del_message(lock)
+        if response:
+            print("deleted leftover key from redis: " + lock)
 
 
 class HomeConfig(AppConfig):
-    default_auto_field = 'django.db.models.BigAutoField'
-    name = 'home'
+    """call startup funcs"""
+
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "home"
+
+    def ready(self):
+        release_lock()
+        index_check()
+        sync_redis_state()
+        make_folders()

tubearchivist/home/config.json

@@ -1,25 +1,49 @@
 {
     "archive": {
-        "sort": "published",
-        "hide_watched": false,
-        "show_subed_only": false,
+        "sort_by": "published",
+        "sort_order": "desc",
         "page_size": 12
     },
+    "default_view": {
+        "home": "grid",
+        "channel": "list",
+        "downloads": "list",
+        "playlist": "grid"
+    },
     "subscriptions": {
         "auto_search": false,
         "auto_download": false,
         "channel_size": 50
     },
     "downloads": {
-        "limit_count": 5,
+        "limit_count": false,
         "limit_speed": false,
         "sleep_interval": 3,
-        "format": false
+        "autodelete_days": false,
+        "format": false,
+        "add_metadata": false,
+        "add_thumbnail": false,
+        "subtitle": false,
+        "subtitle_source": false,
+        "subtitle_index": false,
+        "throttledratelimit": false,
+        "integrate_ryd": false
     },
     "application": {
+        "app_root": "/app",
         "cache_dir": "/cache",
         "videos": "/youtube",
         "file_template": "%(id)s_%(title)s.mp4",
-        "colors": "dark"
+        "colors": "dark",
+        "enable_cast": false
+    },
+    "scheduler": {
+        "update_subscribed": false,
+        "download_pending": false,
+        "check_reindex":  {"minute": "0", "hour": "12", "day_of_week": "*"},
+        "check_reindex_days": 90,
+        "thumbnail_check": {"minute": "0", "hour": "17", "day_of_week": "*"},
+        "run_backup": {"minute": "0", "hour": "8", "day_of_week": "0"},
+        "run_backup_rotate": 5
     }
-}
+}

tubearchivist/home/models.py

@@ -1,3 +1,53 @@
+"""custom models"""
+from django.contrib.auth.models import (
+    AbstractBaseUser,
+    BaseUserManager,
+    PermissionsMixin,
+)
 from django.db import models
 
-# Create your models here.
+
+class AccountManager(BaseUserManager):
+    """manage user creation methods"""
+
+    use_in_migrations = True
+
+    def _create_user(self, name, password, **extra_fields):
+        """create regular user private"""
+        values = [name, password]
+        field_value_map = dict(zip(self.model.REQUIRED_FIELDS, values))
+        for field_name, value in field_value_map.items():
+            if not value:
+                raise ValueError(f"The {field_name} value must be set")
+
+        user = self.model(name=name, **extra_fields)
+        user.set_password(password)
+        user.save(using=self._db)
+        return user
+
+    def create_user(self, name, password):
+        """create regular user public"""
+        return self._create_user(name, password)
+
+    def create_superuser(self, name, password, **extra_fields):
+        """create super user"""
+        extra_fields.setdefault("is_staff", True)
+        extra_fields.setdefault("is_superuser", True)
+
+        if extra_fields.get("is_staff") is not True:
+            raise ValueError("Superuser must have is_staff=True.")
+        if extra_fields.get("is_superuser") is not True:
+            raise ValueError("Superuser must have is_superuser=True.")
+
+        return self._create_user(name, password, **extra_fields)
+
+
+class Account(AbstractBaseUser, PermissionsMixin):
+    """handle account creation"""
+
+    name = models.CharField(max_length=150, unique=True)
+    is_staff = models.BooleanField(default=False)
+    objects = AccountManager()
+
+    USERNAME_FIELD = "name"
+    REQUIRED_FIELDS = ["password"]

tubearchivist/home/src/config.py

@@ -1,60 +0,0 @@
-"""
-Functionality:
-- read and write config
-- load config variables into redis
-- needs to be a separate module to avoid circular import
-"""
-
-import json
-import os
-
-from home.src.helper import get_message, set_message
-
-
-class AppConfig:
-    """ handle user settings and application variables """
-
-    def __init__(self):
-        self.config = self.get_config()
-
-    def get_config(self):
-        """ get config from default file or redis if changed """
-        config = self.get_config_redis()
-        if not config:
-            with open('home/config.json', 'r', encoding="utf-8") as f:
-                config_str = f.read()
-                config = json.loads(config_str)
-
-        config['application']['REDIS_HOST'] = os.environ.get('REDIS_HOST')
-        config['application']['es_url'] = os.environ.get('ES_URL')
-        config['application']['HOST_UID'] = int(os.environ.get('HOST_UID'))
-        config['application']['HOST_GID'] = int(os.environ.get('HOST_GID'))
-        return config
-
-    @staticmethod
-    def get_config_redis():
-        """ read config json set from redis to overwrite defaults """
-        config = get_message('config')
-        if not list(config.values())[0]:
-            return False
-
-        return config
-
-    def update_config(self, form_post):
-        """ update config values from settings form """
-        config = self.config
-        for key, value in form_post.items():
-            to_write = value[0]
-            if len(to_write):
-                if to_write == '0':
-                    to_write = False
-                elif to_write.isdigit():
-                    to_write = int(to_write)
-
-                config_dict, config_value = key.split('.')
-                config[config_dict][config_value] = to_write
-
-        with open('home/config.json', 'w', encoding="utf-8") as f:
-            f.write(json.dumps(config))
-
-        set_message('config', config, expire=False)

tubearchivist/home/src/download.py

@@ -1,505 +0,0 @@
-"""
-Functionality:
-- handele the download queue
-- manage subscriptions to channels
-- downloading videos
-"""
-
-import json
-import shutil
-import os
-
-from datetime import datetime
-from time import sleep
-
-import requests
-import yt_dlp as youtube_dl
-
-from home.src.index import YoutubeChannel, index_new_video
-from home.src.config import AppConfig
-from home.src.helper import clean_string, DurationConverter, set_message
-
-
-class PendingList:
-    """ manage the pending videos list """
-
-    CONFIG = AppConfig().config
-    ES_URL = CONFIG['application']['es_url']
-    VIDEOS = CONFIG['application']['videos']
-
-    @staticmethod
-    def parse_url_list(youtube_ids):
-        """ extract youtube ids from list """
-        missing_videos = []
-        for entry in youtube_ids:
-            # notify
-            mess_dict = {
-                "status": "pending",
-                "level": "info",
-                "title": "Adding to download queue.",
-                "message": 'Extracting lists'
-            }
-            set_message('progress:download', mess_dict)
-            # extract
-            url = entry['url']
-            url_type = entry['type']
-            if url_type == 'video':
-                missing_videos.append(url)
-            elif url_type == 'channel':
-                youtube_ids = ChannelSubscription().get_last_youtube_videos(
-                    url, limit=False
-                )
-                missing_videos = missing_videos + youtube_ids
-            elif url_type == 'playlist':
-                youtube_ids = playlist_extractor(url)
-                missing_videos = missing_videos + youtube_ids
-
-        return missing_videos
-
-    def add_to_pending(self, missing_videos):
-        """ build the bulk json data from pending """
-        # check if channel is indexed
-        channel_handler = ChannelSubscription()
-        all_indexed = channel_handler.get_channels(subscribed_only=False)
-        all_channel_ids = [i['channel_id'] for i in all_indexed]
-        # check if already there
-        all_downloaded = self.get_all_downloaded()
-        # loop
-        bulk_list = []
-        for video in missing_videos:
-            if isinstance(video, str):
-                youtube_id = video
-            elif isinstance(video, tuple):
-                youtube_id = video[0]
-            if youtube_id in all_downloaded:
-                # skip already downlaoded
-                continue
-            video = self.get_youtube_details(youtube_id)
-            # skip on download error
-            if not video:
-                continue
-
-            if video['channel_id'] in all_channel_ids:
-                video['channel_indexed'] = True
-            else:
-                video['channel_indexed'] = False
-            video['status'] = "pending"
-            action = {"create": {"_id": youtube_id, "_index": "ta_download"}}
-            bulk_list.append(json.dumps(action))
-            bulk_list.append(json.dumps(video))
-            # notify
-            mess_dict = {
-                "status": "pending",
-                "level": "info",
-                "title": "Adding to download queue.",
-                "message": 'Processing IDs...'
-            }
-            set_message('progress:download', mess_dict)
-        # add last newline
-        bulk_list.append('\n')
-        query_str = '\n'.join(bulk_list)
-        headers = {'Content-type': 'application/x-ndjson'}
-        url = self.ES_URL + '/_bulk'
-        request = requests.post(url, data=query_str, headers=headers)
-        if not request.ok:
-            print(request)
-
-    @staticmethod
-    def get_youtube_details(youtube_id):
-        """ get details from youtubedl for single pending video """
-        obs = {
-            'default_search': 'ytsearch',
-            'quiet': True,
-            'skip_download': True,
-        }
-        try:
-            vid = youtube_dl.YoutubeDL(obs).extract_info(youtube_id)
-        except youtube_dl.utils.DownloadError:
-            print('failed to extract info for: ' + youtube_id)
-            return False
-        # parse response
-        seconds = vid['duration']
-        duration_str = DurationConverter.get_str(seconds)
-        upload_date = vid['upload_date']
-        upload_dt = datetime.strptime(upload_date, "%Y%m%d")
-        published = upload_dt.strftime("%Y-%m-%d")
-        # build dict
-        youtube_details = {
-            "youtube_id": youtube_id,
-            "channel_name": vid['channel'],
-            "vid_thumb_url": vid['thumbnail'],
-            "title": vid['title'],
-            "channel_id": vid['channel_id'],
-            "duration": duration_str,
-            "published": published,
-            "timestamp": int(datetime.now().strftime("%s"))
-        }
-        return youtube_details
-
-    def get_all_pending(self):
-        """ get a list of all pending videos in ta_download """
-        headers = {'Content-type': 'application/json'}
-        # get PIT ID
-        url = self.ES_URL + '/ta_download/_pit?keep_alive=1m'
-        response = requests.post(url)
-        json_data = json.loads(response.text)
-        pit_id = json_data['id']
-        # query
-        data = {
-            "size": 50, "query": {"match_all": {}},
-            "pit": {"id": pit_id, "keep_alive": "1m"},
-            "sort": [{"timestamp": {"order": "desc"}}]
-        }
-        query_str = json.dumps(data)
-        url = self.ES_URL + '/_search'
-        all_pending = []
-        all_ignore = []
-        while True:
-            response = requests.get(url, data=query_str, headers=headers)
-            json_data = json.loads(response.text)
-            all_hits = json_data['hits']['hits']
-            if all_hits:
-                for hit in all_hits:
-                    youtube_id = hit['_source']['youtube_id']
-                    status = hit['_source']['status']
-                    if status == 'pending':
-                        all_pending.append(hit['_source'])
-                    elif status == 'ignore':
-                        all_ignore.append(youtube_id)
-                    search_after = hit['sort']
-                # update search_after with last hit data
-                data['search_after'] = search_after
-                query_str = json.dumps(data)
-            else:
-                break
-        # clean up PIT
-        query_str = json.dumps({"id": pit_id})
-        requests.delete(self.ES_URL + '/_pit', data=query_str, headers=headers)
-        return all_pending, all_ignore
-
-    def get_all_indexed(self):
-        """ get a list of all videos indexed """
-        headers = {'Content-type': 'application/json'}
-        # get PIT ID
-        url = self.ES_URL + '/ta_video/_pit?keep_alive=1m'
-        response = requests.post(url)
-        json_data = json.loads(response.text)
-        pit_id = json_data['id']
-        # query
-        data = {
-            "size": 500, "query": {"match_all": {}},
-            "pit": {"id": pit_id, "keep_alive": "1m"},
-            "sort": [{"published": {"order": "desc"}}]
-        }
-        query_str = json.dumps(data)
-        url = self.ES_URL + '/_search'
-        all_indexed = []
-        while True:
-            response = requests.get(url, data=query_str, headers=headers)
-            json_data = json.loads(response.text)
-            all_hits = json_data['hits']['hits']
-            if all_hits:
-                for hit in all_hits:
-                    all_indexed.append(hit)
-                    search_after = hit['sort']
-                # update search_after with last hit data
-                data['search_after'] = search_after
-                query_str = json.dumps(data)
-            else:
-                break
-        # clean up PIT
-        query_str = json.dumps({"id": pit_id})
-        requests.delete(self.ES_URL + '/_pit', data=query_str, headers=headers)
-        return all_indexed
-
-    def get_all_downloaded(self):
-        """ get a list of all videos in archive """
-        all_channel_folders = os.listdir(self.VIDEOS)
-        all_downloaded = []
-        for channel_folder in all_channel_folders:
-            channel_path = os.path.join(self.VIDEOS, channel_folder)
-            all_videos = os.listdir(channel_path)
-            youtube_vids = [i[9:20] for i in all_videos]
-            for youtube_id in youtube_vids:
-                all_downloaded.append(youtube_id)
-        return all_downloaded
-
-    def delete_from_pending(self, youtube_id):
-        """ delete the youtube_id from ta_download """
-        url = f'{self.ES_URL}/ta_download/_doc/{youtube_id}'
-        response = requests.delete(url)
-        if not response.ok:
-            print(response.text)
-
-    def ignore_from_pending(self, ignore_list):
-        """ build the bulk query string """
-
-        stamp = int(datetime.now().strftime("%s"))
-        bulk_list = []
-
-        for youtube_id in ignore_list:
-            action = {"update": {"_id": youtube_id, "_index": "ta_download"}}
-            source = {"doc": {"status": 'ignore', "timestamp": stamp}}
-            bulk_list.append(json.dumps(action))
-            bulk_list.append(json.dumps(source))
-
-        # add last newline
-        bulk_list.append('\n')
-        query_str = '\n'.join(bulk_list)
-
-        headers = {'Content-type': 'application/x-ndjson'}
-        url = self.ES_URL + '/_bulk'
-        request = requests.post(url, data=query_str, headers=headers)
-        mess_dict = {
-            "status": "ignore",
-            "level": "info",
-            "title": "Added to ignore list",
-            "message": ''
-        }
-        set_message('progress:download', mess_dict)
-        if not request.ok:
-            print(request)
-
-
-class ChannelSubscription:
-    """ manage the list of channels subscribed """
-
-    def __init__(self):
-        config = AppConfig().config
-        self.es_url = config['application']['es_url']
-        self.channel_size = config['subscriptions']['channel_size']
-
-    def get_channels(self, subscribed_only=True):
-        """ get a list of all channels subscribed to """
-        headers = {'Content-type': 'application/json'}
-        # get PIT ID
-        url = self.es_url + '/ta_channel/_pit?keep_alive=1m'
-        response = requests.post(url)
-        json_data = json.loads(response.text)
-        pit_id = json_data['id']
-        # query
-        if subscribed_only:
-            data = {
-                "query": {"term": {"channel_subscribed": {"value": True}}},
-                "size": 50, "pit": {"id": pit_id, "keep_alive": "1m"},
-                "sort": [{"channel_name.keyword": {"order": "asc"}}]
-            }
-        else:
-            data = {
-                "query": {"match_all": {}},
-                "size": 50, "pit": {"id": pit_id, "keep_alive": "1m"},
-                "sort": [{"channel_name.keyword": {"order": "asc"}}]
-            }
-        query_str = json.dumps(data)
-        url = self.es_url + '/_search'
-        all_channels = []
-        while True:
-            response = requests.get(url, data=query_str, headers=headers)
-            json_data = json.loads(response.text)
-            all_hits = json_data['hits']['hits']
-            if all_hits:
-                for hit in all_hits:
-                    source = hit['_source']
-                    search_after = hit['sort']
-                    all_channels.append(source)
-                # update search_after with last hit data
-                data['search_after'] = search_after
-                query_str = json.dumps(data)
-            else:
-                break
-        # clean up PIT
-        query_str = json.dumps({"id": pit_id})
-        requests.delete(self.es_url + '/_pit', data=query_str, headers=headers)
-        return all_channels
-
-    def get_last_youtube_videos(self, channel_id, limit=True):
-        """ get a list of last videos from channel """
-        url = f'https://www.youtube.com/channel/{channel_id}/videos'
-        obs = {
-            'default_search': 'ytsearch', 'quiet': True,
-            'skip_download': True, 'extract_flat': True
-        }
-        if limit:
-            obs['playlistend'] = self.channel_size
-        chan = youtube_dl.YoutubeDL(obs).extract_info(url, download=False)
-        last_videos = [(i['id'], i['title']) for i in chan['entries']]
-        return last_videos
-
-    def find_missing(self):
-        """ add missing videos from subscribed channels to pending """
-        all_channels = self.get_channels()
-        pending_handler = PendingList()
-        all_pending, all_ignore = pending_handler.get_all_pending()
-        all_pending_ids = [i['youtube_id'] for i in all_pending]
-        all_downloaded = pending_handler.get_all_downloaded()
-        to_ignore = all_pending_ids + all_ignore + all_downloaded
-        missing_videos = []
-        counter = 1
-        for channel in all_channels:
-            channel_id = channel['channel_id']
-            last_videos = self.get_last_youtube_videos(channel_id)
-            set_message('progress:download', {
-                "status": "rescan",
-                "level": "info",
-                "title": "Rescanning: Looking for new videos.",
-                "message": f'Progress: {counter}/{len(all_channels)}'
-                }
-            )
-            for video in last_videos:
-                youtube_id = video[0]
-                if youtube_id not in to_ignore:
-                    missing_videos.append(youtube_id)
-            counter = counter + 1
-
-        return missing_videos
-
-    def change_subscribe(self, channel_id, channel_subscribed):
-        """ subscribe or unsubscribe from channel and update """
-        if not isinstance(channel_subscribed, bool):
-            print('invalid status, should be bool')
-            return
-        headers = {'Content-type': 'application/json'}
-        channel_handler = YoutubeChannel(channel_id)
-        channel_dict = channel_handler.channel_dict
-        channel_dict['channel_subscribed'] = channel_subscribed
-        if channel_subscribed:
-            # handle subscribe
-            url = self.es_url + '/ta_channel/_doc/' + channel_id
-            payload = json.dumps(channel_dict)
-            print(channel_dict)
-        else:
-            url = self.es_url + '/ta_channel/_update/' + channel_id
-            payload = json.dumps({'doc': channel_dict})
-        # update channel
-        request = requests.post(url, data=payload, headers=headers)
-        if not request.ok:
-            print(request.text)
-        # sync to videos
-        channel_handler.sync_to_videos()
-
-
-def playlist_extractor(playlist_id):
-    """ return youtube_ids from a playlist_id """
-    url = 'https://www.youtube.com/playlist?list=' + playlist_id
-    obs = {
-        'default_search': 'ytsearch', 'quiet': True, 'ignoreerrors': True,
-        'skip_download': True, 'extract_flat': True
-    }
-    playlist = youtube_dl.YoutubeDL(obs).extract_info(url, download=False)
-    playlist_vids = [(i['id'], i['title']) for i in playlist['entries']]
-    return playlist_vids
-
-
-class VideoDownloader:
-    """ handle the video download functionality """
-
-    def __init__(self, youtube_id_list):
-        self.youtube_id_list = youtube_id_list
-        self.config = AppConfig().config
-
-    def download_list(self):
-        """ download the list of youtube_ids """
-        limit_count = self.config['downloads']['limit_count']
-        if limit_count:
-            self.youtube_id_list = self.youtube_id_list[:limit_count]
-
-        for youtube_id in self.youtube_id_list:
-            try:
-                self.dl_single_vid(youtube_id)
-            except youtube_dl.utils.DownloadError:
-                print('failed to download ' + youtube_id)
-                continue
-            vid_dict = index_new_video(youtube_id)
-            self.move_to_archive(vid_dict)
-            self.delete_from_pending(youtube_id)
-            if self.config['downloads']['sleep_interval']:
-                sleep(self.config['downloads']['sleep_interval'])
-
-    @staticmethod
-    def progress_hook(response):
-        """ process the progress_hooks from youtube_dl """
-        # title
-        filename = response['filename'][12:].replace('_', ' ')
-        title = "Downloading: " + os.path.split(filename)[-1]
-        # message
-        try:
-            percent = response['_percent_str']
-            size = response['_total_bytes_str']
-            speed = response['_speed_str']
-            eta = response['_eta_str']
-            message = f'{percent} of {size} at {speed} - time left: {eta}'
-        except KeyError:
-            message = ''
-        mess_dict = {
-            "status": "downloading",
-            "level": "info",
-            "title": title,
-            "message": message
-        }
-        set_message('progress:download', mess_dict)
-
-    def dl_single_vid(self, youtube_id):
-        """ download single video """
-        obs = {
-            'default_search': 'ytsearch',
-            'merge_output_format': 'mp4', 'restrictfilenames': True,
-            'outtmpl': (self.config['application']['cache_dir'] +
-                        '/download/' +
-                        self.config['application']['file_template']),
-            'progress_hooks': [self.progress_hook],
-            'quiet': True, 'continuedl': True, 'retries': 3
-        }
-        if self.config['downloads']['format']:
-            obs['format'] = self.config['downloads']['format']
-        if self.config['downloads']['limit_speed']:
-            obs['ratelimit'] = self.config['downloads']['limit_speed'] * 1024
-        external = False
-        if external:
-            obs['external_downloader'] = 'aria2c'
-        # check if already in cache to continue from there
-        cache_dir = self.config['application']['cache_dir']
-        all_cached = os.listdir(cache_dir + '/download/')
-        for file_name in all_cached:
-            if youtube_id in file_name:
-                obs['outtmpl'] = cache_dir + '/download/' + file_name
-        with youtube_dl.YoutubeDL(obs) as ydl:
-            try:
-                ydl.download([youtube_id])
-            except youtube_dl.utils.DownloadError:
-                print('retry failed download: ' + youtube_id)
-                sleep(10)
-                ydl.download([youtube_id])
-
-    def move_to_archive(self, vid_dict):
-        """ move downloaded video from cache to archive """
-        videos = self.config['application']['videos']
-        channel_name = vid_dict['channel']['channel_name']
-        channel_name_clean = clean_string(channel_name)
-        media_url = vid_dict['media_url']
-        youtube_id = vid_dict['youtube_id']
-        # make archive folder
-        videos = self.config['application']['videos']
-        new_folder = os.path.join(videos, channel_name_clean)
-        os.makedirs(new_folder, exist_ok=True)
-        # find real filename
-        cache_dir = self.config['application']['cache_dir']
-        for file_str in os.listdir(cache_dir + '/download'):
-            if youtube_id in file_str:
-                old_file = file_str
-        old_file_path = os.path.join(cache_dir, 'download', old_file)
-        new_file_path = os.path.join(videos, media_url)
-        # move and fix permission
-        shutil.move(old_file_path, new_file_path)
-        os.chown(
-            new_file_path,
-            self.config['application']['HOST_UID'],
-            self.config['application']['HOST_GID']
-        )
-
-    def delete_from_pending(self, youtube_id):
-        """ delete downloaded video from pending index if its there """
-        es_url = self.config['application']['es_url']
-        url = f'{es_url}/ta_download/_doc/{youtube_id}'
-        response = requests.delete(url)
-        if not response.ok and not response.status_code == 404:
-            print(response.text)

tubearchivist/home/src/download/queue.py

@@ -0,0 +1,263 @@
+"""
+Functionality:
+- handle download queue
+- linked with ta_dowload index
+"""
+
+import json
+import os
+from datetime import datetime
+
+import requests
+import yt_dlp
+from home.src.download.subscriptions import ChannelSubscription
+from home.src.es.connect import IndexPaginate
+from home.src.index.playlist import YoutubePlaylist
+from home.src.ta.config import AppConfig
+from home.src.ta.helper import DurationConverter, ignore_filelist
+from home.src.ta.ta_redis import RedisArchivist
+
+
+class PendingList:
+    """manage the pending videos list"""
+
+    CONFIG = AppConfig().config
+    ES_URL = CONFIG["application"]["es_url"]
+    ES_AUTH = CONFIG["application"]["es_auth"]
+    VIDEOS = CONFIG["application"]["videos"]
+
+    def __init__(self):
+        self.all_channel_ids = False
+        self.all_downloaded = False
+        self.missing_from_playlists = []
+
+    def parse_url_list(self, youtube_ids):
+        """extract youtube ids from list"""
+        missing_videos = []
+        for entry in youtube_ids:
+            # notify
+            mess_dict = {
+                "status": "message:add",
+                "level": "info",
+                "title": "Adding to download queue.",
+                "message": "Extracting lists",
+            }
+            RedisArchivist().set_message("message:add", mess_dict)
+            # extract
+            url = entry["url"]
+            url_type = entry["type"]
+            if url_type == "video":
+                missing_videos.append(url)
+            elif url_type == "channel":
+                video_results = ChannelSubscription().get_last_youtube_videos(
+                    url, limit=False
+                )
+                youtube_ids = [i[0] for i in video_results]
+                missing_videos = missing_videos + youtube_ids
+            elif url_type == "playlist":
+                self.missing_from_playlists.append(entry)
+                playlist = YoutubePlaylist(url)
+                playlist.build_json()
+                video_results = playlist.json_data.get("playlist_entries")
+                youtube_ids = [i["youtube_id"] for i in video_results]
+                missing_videos = missing_videos + youtube_ids
+
+        return missing_videos
+
+    def add_to_pending(self, missing_videos, ignore=False):
+        """build the bulk json data from pending"""
+        # check if channel is indexed
+        channel_handler = ChannelSubscription()
+        all_indexed = channel_handler.get_channels(subscribed_only=False)
+        self.all_channel_ids = [i["channel_id"] for i in all_indexed]
+        # check if already there
+        self.all_downloaded = self.get_all_downloaded()
+
+        bulk_list, all_videos_added = self.build_bulk(missing_videos, ignore)
+        # add last newline
+        bulk_list.append("\n")
+        query_str = "\n".join(bulk_list)
+        headers = {"Content-type": "application/x-ndjson"}
+        url = self.ES_URL + "/_bulk"
+        request = requests.post(
+            url, data=query_str, headers=headers, auth=self.ES_AUTH
+        )
+        if not request.ok:
+            print(request)
+            raise ValueError("failed to add video to download queue")
+
+        return all_videos_added
+
+    def build_bulk(self, missing_videos, ignore=False):
+        """build the bulk lists"""
+        bulk_list = []
+        all_videos_added = []
+
+        for idx, youtube_id in enumerate(missing_videos):
+            # check if already downloaded
+            if youtube_id in self.all_downloaded:
+                continue
+
+            video = self.get_youtube_details(youtube_id)
+            # skip on download error
+            if not video:
+                continue
+
+            channel_indexed = video["channel_id"] in self.all_channel_ids
+            video["channel_indexed"] = channel_indexed
+            if ignore:
+                video["status"] = "ignore"
+            else:
+                video["status"] = "pending"
+            action = {"create": {"_id": youtube_id, "_index": "ta_download"}}
+            bulk_list.append(json.dumps(action))
+            bulk_list.append(json.dumps(video))
+            all_videos_added.append((youtube_id, video["vid_thumb_url"]))
+            # notify
+            progress = f"{idx + 1}/{len(missing_videos)}"
+            mess_dict = {
+                "status": "message:add",
+                "level": "info",
+                "title": "Adding new videos to download queue.",
+                "message": "Progress: " + progress,
+            }
+            if idx + 1 == len(missing_videos):
+                RedisArchivist().set_message(
+                    "message:add", mess_dict, expire=4
+                )
+            else:
+                RedisArchivist().set_message("message:add", mess_dict)
+            if idx + 1 % 25 == 0:
+                print("adding to queue progress: " + progress)
+
+        return bulk_list, all_videos_added
+
+    @staticmethod
+    def get_youtube_details(youtube_id):
+        """get details from youtubedl for single pending video"""
+        obs = {
+            "default_search": "ytsearch",
+            "quiet": True,
+            "check_formats": "selected",
+            "noplaylist": True,
+            "writethumbnail": True,
+            "simulate": True,
+        }
+        try:
+            vid = yt_dlp.YoutubeDL(obs).extract_info(youtube_id)
+        except yt_dlp.utils.DownloadError:
+            print("failed to extract info for: " + youtube_id)
+            return False
+        # stop if video is streaming live now
+        if vid["is_live"]:
+            return False
+        # parse response
+        seconds = vid["duration"]
+        duration_str = DurationConverter.get_str(seconds)
+        if duration_str == "NA":
+            print(f"skip extracting duration for: {youtube_id}")
+        upload_date = vid["upload_date"]
+        upload_dt = datetime.strptime(upload_date, "%Y%m%d")
+        published = upload_dt.strftime("%Y-%m-%d")
+        # build dict
+        youtube_details = {
+            "youtube_id": youtube_id,
+            "channel_name": vid["channel"],
+            "vid_thumb_url": vid["thumbnail"],
+            "title": vid["title"],
+            "channel_id": vid["channel_id"],
+            "duration": duration_str,
+            "published": published,
+            "timestamp": int(datetime.now().strftime("%s")),
+        }
+        return youtube_details
+
+    @staticmethod
+    def get_all_pending():
+        """get a list of all pending videos in ta_download"""
+        data = {
+            "query": {"match_all": {}},
+            "sort": [{"timestamp": {"order": "asc"}}],
+        }
+        all_results = IndexPaginate("ta_download", data).get_results()
+
+        all_pending = []
+        all_ignore = []
+
+        for result in all_results:
+            if result["status"] == "pending":
+                all_pending.append(result)
+            elif result["status"] == "ignore":
+                all_ignore.append(result)
+
+        return all_pending, all_ignore
+
+    @staticmethod
+    def get_all_indexed():
+        """get a list of all videos indexed"""
+
+        data = {
+            "query": {"match_all": {}},
+            "sort": [{"published": {"order": "desc"}}],
+        }
+        all_indexed = IndexPaginate("ta_video", data).get_results()
+
+        return all_indexed
+
+    def get_all_downloaded(self):
+        """get a list of all videos in archive"""
+        channel_folders = os.listdir(self.VIDEOS)
+        all_channel_folders = ignore_filelist(channel_folders)
+        all_downloaded = []
+        for channel_folder in all_channel_folders:
+            channel_path = os.path.join(self.VIDEOS, channel_folder)
+            videos = os.listdir(channel_path)
+            all_videos = ignore_filelist(videos)
+            youtube_vids = [i[9:20] for i in all_videos]
+            for youtube_id in youtube_vids:
+                all_downloaded.append(youtube_id)
+        return all_downloaded
+
+    def delete_from_pending(self, youtube_id):
+        """delete the youtube_id from ta_download"""
+        url = f"{self.ES_URL}/ta_download/_doc/{youtube_id}"
+        response = requests.delete(url, auth=self.ES_AUTH)
+        if not response.ok:
+            print(response.text)
+
+    def delete_pending(self, status):
+        """delete download queue based on status value"""
+        data = {"query": {"term": {"status": {"value": status}}}}
+        payload = json.dumps(data)
+        url = self.ES_URL + "/ta_download/_delete_by_query"
+        headers = {"Content-type": "application/json"}
+        response = requests.post(
+            url, data=payload, headers=headers, auth=self.ES_AUTH
+        )
+        if not response.ok:
+            print(response.text)
+
+    def ignore_from_pending(self, ignore_list):
+        """build the bulk query string"""
+
+        stamp = int(datetime.now().strftime("%s"))
+        bulk_list = []
+
+        for youtube_id in ignore_list:
+            action = {"update": {"_id": youtube_id, "_index": "ta_download"}}
+            source = {"doc": {"status": "ignore", "timestamp": stamp}}
+            bulk_list.append(json.dumps(action))
+            bulk_list.append(json.dumps(source))
+
+        # add last newline
+        bulk_list.append("\n")
+        query_str = "\n".join(bulk_list)
+
+        headers = {"Content-type": "application/x-ndjson"}
+        url = self.ES_URL + "/_bulk"
+        request = requests.post(
+            url, data=query_str, headers=headers, auth=self.ES_AUTH
+        )
+        if not request.ok:
+            print(request)
+            raise ValueError("failed to set video to ignore")

tubearchivist/home/src/download/subscriptions.py

@@ -0,0 +1,222 @@
+"""
+Functionality:
+- handle channel subscriptions
+- handle playlist subscriptions
+"""
+
+import yt_dlp
+from home.src.download import queue  # partial import
+from home.src.es.connect import IndexPaginate
+from home.src.index.channel import YoutubeChannel
+from home.src.index.playlist import YoutubePlaylist
+from home.src.ta.config import AppConfig
+from home.src.ta.ta_redis import RedisArchivist
+
+
+class ChannelSubscription:
+    """manage the list of channels subscribed"""
+
+    def __init__(self):
+        config = AppConfig().config
+        self.es_url = config["application"]["es_url"]
+        self.es_auth = config["application"]["es_auth"]
+        self.channel_size = config["subscriptions"]["channel_size"]
+
+    @staticmethod
+    def get_channels(subscribed_only=True):
+        """get a list of all channels subscribed to"""
+        data = {
+            "sort": [{"channel_name.keyword": {"order": "asc"}}],
+        }
+        if subscribed_only:
+            data["query"] = {"term": {"channel_subscribed": {"value": True}}}
+        else:
+            data["query"] = {"match_all": {}}
+
+        all_channels = IndexPaginate("ta_channel", data).get_results()
+
+        return all_channels
+
+    def get_last_youtube_videos(self, channel_id, limit=True):
+        """get a list of last videos from channel"""
+        url = f"https://www.youtube.com/channel/{channel_id}/videos"
+        obs = {
+            "default_search": "ytsearch",
+            "quiet": True,
+            "skip_download": True,
+            "extract_flat": True,
+        }
+        if limit:
+            obs["playlistend"] = self.channel_size
+
+        try:
+            chan = yt_dlp.YoutubeDL(obs).extract_info(url, download=False)
+        except yt_dlp.utils.DownloadError:
+            print(f"{channel_id}: failed to extract videos, skipping.")
+            return False
+
+        last_videos = [(i["id"], i["title"]) for i in chan["entries"]]
+        return last_videos
+
+    def find_missing(self):
+        """add missing videos from subscribed channels to pending"""
+        all_channels = self.get_channels()
+        pending_handler = queue.PendingList()
+        all_pending, all_ignore = pending_handler.get_all_pending()
+        all_ids = [i["youtube_id"] for i in all_ignore + all_pending]
+        all_downloaded = pending_handler.get_all_downloaded()
+        to_ignore = all_ids + all_downloaded
+
+        missing_videos = []
+
+        for idx, channel in enumerate(all_channels):
+            channel_id = channel["channel_id"]
+            last_videos = self.get_last_youtube_videos(channel_id)
+
+            if last_videos:
+                for video in last_videos:
+                    if video[0] not in to_ignore:
+                        missing_videos.append(video[0])
+            # notify
+            message = {
+                "status": "message:rescan",
+                "level": "info",
+                "title": "Scanning channels: Looking for new videos.",
+                "message": f"Progress: {idx + 1}/{len(all_channels)}",
+            }
+            if idx + 1 == len(all_channels):
+                RedisArchivist().set_message(
+                    "message:rescan", message=message, expire=4
+                )
+            else:
+                RedisArchivist().set_message("message:rescan", message=message)
+
+        return missing_videos
+
+    @staticmethod
+    def change_subscribe(channel_id, channel_subscribed):
+        """subscribe or unsubscribe from channel and update"""
+        channel = YoutubeChannel(channel_id)
+        channel.build_json()
+        channel.json_data["channel_subscribed"] = channel_subscribed
+        channel.upload_to_es()
+        channel.sync_to_videos()
+
+
+class PlaylistSubscription:
+    """manage the playlist download functionality"""
+
+    def __init__(self):
+        self.config = AppConfig().config
+
+    @staticmethod
+    def get_playlists(subscribed_only=True):
+        """get a list of all active playlists"""
+        data = {
+            "sort": [{"playlist_channel.keyword": {"order": "desc"}}],
+        }
+        data["query"] = {
+            "bool": {"must": [{"term": {"playlist_active": {"value": True}}}]}
+        }
+        if subscribed_only:
+            data["query"]["bool"]["must"].append(
+                {"term": {"playlist_subscribed": {"value": True}}}
+            )
+
+        all_playlists = IndexPaginate("ta_playlist", data).get_results()
+
+        return all_playlists
+
+    def process_url_str(self, new_playlists, subscribed=True):
+        """process playlist subscribe form url_str"""
+        all_indexed = queue.PendingList().get_all_indexed()
+        all_youtube_ids = [i["youtube_id"] for i in all_indexed]
+
+        new_thumbs = []
+        for idx, playlist in enumerate(new_playlists):
+            url_type = playlist["type"]
+            playlist_id = playlist["url"]
+            if not url_type == "playlist":
+                print(f"{playlist_id} not a playlist, skipping...")
+                continue
+
+            playlist_h = YoutubePlaylist(playlist_id)
+            playlist_h.all_youtube_ids = all_youtube_ids
+            playlist_h.build_json()
+            playlist_h.json_data["playlist_subscribed"] = subscribed
+            playlist_h.upload_to_es()
+            playlist_h.add_vids_to_playlist()
+            self.channel_validate(playlist_h.json_data["playlist_channel_id"])
+            thumb = playlist_h.json_data["playlist_thumbnail"]
+            new_thumbs.append((playlist_id, thumb))
+            # notify
+            message = {
+                "status": "message:subplaylist",
+                "level": "info",
+                "title": "Subscribing to Playlists",
+                "message": f"Processing {idx + 1} of {len(new_playlists)}",
+            }
+            RedisArchivist().set_message(
+                "message:subplaylist", message=message
+            )
+
+        return new_thumbs
+
+    @staticmethod
+    def channel_validate(channel_id):
+        """make sure channel of playlist is there"""
+        channel = YoutubeChannel(channel_id)
+        channel.build_json()
+
+    @staticmethod
+    def change_subscribe(playlist_id, subscribe_status):
+        """change the subscribe status of a playlist"""
+        playlist = YoutubePlaylist(playlist_id)
+        playlist.build_json()
+        playlist.json_data["playlist_subscribed"] = subscribe_status
+        playlist.upload_to_es()
+
+    @staticmethod
+    def get_to_ignore():
+        """get all youtube_ids already downloaded or ignored"""
+        pending_handler = queue.PendingList()
+        all_pending, all_ignore = pending_handler.get_all_pending()
+        all_ids = [i["youtube_id"] for i in all_ignore + all_pending]
+        all_downloaded = pending_handler.get_all_downloaded()
+        to_ignore = all_ids + all_downloaded
+        return to_ignore
+
+    def find_missing(self):
+        """find videos in subscribed playlists not downloaded yet"""
+        all_playlists = [i["playlist_id"] for i in self.get_playlists()]
+        to_ignore = self.get_to_ignore()
+
+        missing_videos = []
+        for idx, playlist_id in enumerate(all_playlists):
+            size_limit = self.config["subscriptions"]["channel_size"]
+            playlist = YoutubePlaylist(playlist_id)
+            playlist.update_playlist()
+            if not playlist:
+                playlist.deactivate()
+                continue
+
+            playlist_entries = playlist.json_data["playlist_entries"]
+            if size_limit:
+                del playlist_entries[size_limit:]
+
+            all_missing = [i for i in playlist_entries if not i["downloaded"]]
+
+            message = {
+                "status": "message:rescan",
+                "level": "info",
+                "title": "Scanning playlists: Looking for new videos.",
+                "message": f"Progress: {idx + 1}/{len(all_playlists)}",
+            }
+            RedisArchivist().set_message("message:rescan", message=message)
+
+            for video in all_missing:
+                youtube_id = video["youtube_id"]
+                if youtube_id not in to_ignore:
+                    missing_videos.append(youtube_id)
+
+        return missing_videos

tubearchivist/home/src/download/thumbnails.py

@@ -0,0 +1,326 @@
+"""
+functionality:
+- handle download and caching for thumbnails
+- check for missing thumbnails
+"""
+
+import os
+from collections import Counter
+from time import sleep
+
+import requests
+from home.src.download import queue  # partial import
+from home.src.download import subscriptions  # partial import
+from home.src.ta.config import AppConfig
+from home.src.ta.helper import ignore_filelist
+from home.src.ta.ta_redis import RedisArchivist
+from mutagen.mp4 import MP4, MP4Cover
+from PIL import Image
+
+
+class ThumbManager:
+    """handle thumbnails related functions"""
+
+    CONFIG = AppConfig().config
+    MEDIA_DIR = CONFIG["application"]["videos"]
+    CACHE_DIR = CONFIG["application"]["cache_dir"]
+    VIDEO_DIR = os.path.join(CACHE_DIR, "videos")
+    CHANNEL_DIR = os.path.join(CACHE_DIR, "channels")
+    PLAYLIST_DIR = os.path.join(CACHE_DIR, "playlists")
+
+    def get_all_thumbs(self):
+        """get all video artwork already downloaded"""
+        all_thumb_folders = ignore_filelist(os.listdir(self.VIDEO_DIR))
+        all_thumbs = []
+        for folder in all_thumb_folders:
+            folder_path = os.path.join(self.VIDEO_DIR, folder)
+            if os.path.isfile(folder_path):
+                self.update_path(folder)
+                all_thumbs.append(folder_path)
+                continue
+                # raise exemption here in a future version
+                # raise FileExistsError("video cache dir has files inside")
+
+            all_folder_thumbs = ignore_filelist(os.listdir(folder_path))
+            all_thumbs.extend(all_folder_thumbs)
+
+        return all_thumbs
+
+    def update_path(self, file_name):
+        """reorganize thumbnails into folders as update path from v0.0.5"""
+        folder_name = file_name[0].lower()
+        folder_path = os.path.join(self.VIDEO_DIR, folder_name)
+        old_file = os.path.join(self.VIDEO_DIR, file_name)
+        new_file = os.path.join(folder_path, file_name)
+        os.makedirs(folder_path, exist_ok=True)
+        os.rename(old_file, new_file)
+
+    def get_needed_thumbs(self, missing_only=False):
+        """get a list of all missing thumbnails"""
+        all_thumbs = self.get_all_thumbs()
+        all_indexed = queue.PendingList().get_all_indexed()
+        all_in_queue, all_ignored = queue.PendingList().get_all_pending()
+
+        needed_thumbs = []
+        for video in all_indexed:
+            youtube_id = video["youtube_id"]
+            thumb_url = video["vid_thumb_url"]
+            if missing_only:
+                if youtube_id + ".jpg" not in all_thumbs:
+                    needed_thumbs.append((youtube_id, thumb_url))
+            else:
+                needed_thumbs.append((youtube_id, thumb_url))
+
+        for video in all_in_queue + all_ignored:
+            youtube_id = video["youtube_id"]
+            thumb_url = video["vid_thumb_url"]
+            if missing_only:
+                if youtube_id + ".jpg" not in all_thumbs:
+                    needed_thumbs.append((youtube_id, thumb_url))
+            else:
+                needed_thumbs.append((youtube_id, thumb_url))
+
+        return needed_thumbs
+
+    def get_missing_channels(self):
+        """get all channel artwork"""
+        all_channel_art = os.listdir(self.CHANNEL_DIR)
+        files = [i[0:24] for i in all_channel_art]
+        cached_channel_ids = [k for (k, v) in Counter(files).items() if v > 1]
+        channel_sub = subscriptions.ChannelSubscription()
+        channels = channel_sub.get_channels(subscribed_only=False)
+
+        missing_channels = []
+        for channel in channels:
+            channel_id = channel["channel_id"]
+            if channel_id not in cached_channel_ids:
+                channel_banner = channel["channel_banner_url"]
+                channel_thumb = channel["channel_thumb_url"]
+                missing_channels.append(
+                    (channel_id, channel_thumb, channel_banner)
+                )
+
+        return missing_channels
+
+    def get_missing_playlists(self):
+        """get all missing playlist artwork"""
+        all_downloaded = ignore_filelist(os.listdir(self.PLAYLIST_DIR))
+        all_ids_downloaded = [i.replace(".jpg", "") for i in all_downloaded]
+        playlist_sub = subscriptions.PlaylistSubscription()
+        playlists = playlist_sub.get_playlists(subscribed_only=False)
+
+        missing_playlists = []
+        for playlist in playlists:
+            playlist_id = playlist["playlist_id"]
+            if playlist_id not in all_ids_downloaded:
+                playlist_thumb = playlist["playlist_thumbnail"]
+                missing_playlists.append((playlist_id, playlist_thumb))
+
+        return missing_playlists
+
+    def get_raw_img(self, img_url, thumb_type):
+        """get raw image from youtube and handle 404"""
+        try:
+            app_root = self.CONFIG["application"]["app_root"]
+        except KeyError:
+            # lazy keyerror fix to not have to deal with a strange startup
+            # racing contition between the threads in HomeConfig.ready()
+            app_root = "/app"
+        default_map = {
+            "video": os.path.join(
+                app_root, "static/img/default-video-thumb.jpg"
+            ),
+            "icon": os.path.join(
+                app_root, "static/img/default-channel-icon.jpg"
+            ),
+            "banner": os.path.join(
+                app_root, "static/img/default-channel-banner.jpg"
+            ),
+        }
+        if img_url:
+            try:
+                response = requests.get(img_url, stream=True)
+            except ConnectionError:
+                sleep(5)
+                response = requests.get(img_url, stream=True)
+            if not response.ok and not response.status_code == 404:
+                print("retry thumbnail download for " + img_url)
+                sleep(5)
+                response = requests.get(img_url, stream=True)
+        else:
+            response = False
+        if not response or response.status_code == 404:
+            # use default
+            img_raw = Image.open(default_map[thumb_type])
+        else:
+            # use response
+            img_obj = response.raw
+            img_raw = Image.open(img_obj)
+
+        return img_raw
+
+    def download_vid(self, missing_thumbs, notify=True):
+        """download all missing thumbnails from list"""
+        print(f"downloading {len(missing_thumbs)} thumbnails")
+        for idx, (youtube_id, thumb_url) in enumerate(missing_thumbs):
+            folder_path = os.path.join(self.VIDEO_DIR, youtube_id[0].lower())
+            thumb_path = os.path.join(
+                self.CACHE_DIR, self.vid_thumb_path(youtube_id)
+            )
+
+            os.makedirs(folder_path, exist_ok=True)
+            img_raw = self.get_raw_img(thumb_url, "video")
+
+            width, height = img_raw.size
+            if not width / height == 16 / 9:
+                new_height = width / 16 * 9
+                offset = (height - new_height) / 2
+                img_raw = img_raw.crop((0, offset, width, height - offset))
+            img_raw.convert("RGB").save(thumb_path)
+
+            progress = f"{idx + 1}/{len(missing_thumbs)}"
+            if notify:
+                mess_dict = {
+                    "status": "message:add",
+                    "level": "info",
+                    "title": "Processing Videos",
+                    "message": "Downloading Thumbnails, Progress: " + progress,
+                }
+                if idx + 1 == len(missing_thumbs):
+                    RedisArchivist().set_message(
+                        "message:add", mess_dict, expire=4
+                    )
+                else:
+                    RedisArchivist().set_message("message:add", mess_dict)
+
+            if idx + 1 % 25 == 0:
+                print("thumbnail progress: " + progress)
+
+    def download_chan(self, missing_channels):
+        """download needed artwork for channels"""
+        print(f"downloading {len(missing_channels)} channel artwork")
+        for channel in missing_channels:
+            channel_id, channel_thumb, channel_banner = channel
+
+            thumb_path = os.path.join(
+                self.CHANNEL_DIR, channel_id + "_thumb.jpg"
+            )
+            img_raw = self.get_raw_img(channel_thumb, "icon")
+            img_raw.convert("RGB").save(thumb_path)
+
+            banner_path = os.path.join(
+                self.CHANNEL_DIR, channel_id + "_banner.jpg"
+            )
+            img_raw = self.get_raw_img(channel_banner, "banner")
+            img_raw.convert("RGB").save(banner_path)
+
+            mess_dict = {
+                "status": "message:download",
+                "level": "info",
+                "title": "Processing Channels",
+                "message": "Downloading Channel Art.",
+            }
+            RedisArchivist().set_message("message:download", mess_dict)
+
+    def download_playlist(self, missing_playlists):
+        """download needed artwork for playlists"""
+        print(f"downloading {len(missing_playlists)} playlist artwork")
+        for playlist in missing_playlists:
+            playlist_id, playlist_thumb_url = playlist
+            thumb_path = os.path.join(self.PLAYLIST_DIR, playlist_id + ".jpg")
+            img_raw = self.get_raw_img(playlist_thumb_url, "video")
+            img_raw.convert("RGB").save(thumb_path)
+
+            mess_dict = {
+                "status": "message:download",
+                "level": "info",
+                "title": "Processing Playlists",
+                "message": "Downloading Playlist Art.",
+            }
+            RedisArchivist().set_message("message:download", mess_dict)
+
+    @staticmethod
+    def vid_thumb_path(youtube_id):
+        """build expected path for video thumbnail from youtube_id"""
+        folder_name = youtube_id[0].lower()
+        folder_path = os.path.join("videos", folder_name)
+        thumb_path = os.path.join(folder_path, youtube_id + ".jpg")
+        return thumb_path
+
+    def delete_vid_thumb(self, youtube_id):
+        """delete video thumbnail if exists"""
+        thumb_path = self.vid_thumb_path(youtube_id)
+        to_delete = os.path.join(self.CACHE_DIR, thumb_path)
+        if os.path.exists(to_delete):
+            os.remove(to_delete)
+
+    def delete_chan_thumb(self, channel_id):
+        """delete all artwork of channel"""
+        thumb = os.path.join(self.CHANNEL_DIR, channel_id + "_thumb.jpg")
+        banner = os.path.join(self.CHANNEL_DIR, channel_id + "_banner.jpg")
+        if os.path.exists(thumb):
+            os.remove(thumb)
+        if os.path.exists(banner):
+            os.remove(banner)
+
+    def cleanup_downloaded(self):
+        """find downloaded thumbnails without video indexed"""
+        all_thumbs = self.get_all_thumbs()
+        all_indexed = self.get_needed_thumbs()
+        all_needed_thumbs = [i[0] + ".jpg" for i in all_indexed]
+        for thumb in all_thumbs:
+            if thumb not in all_needed_thumbs:
+                # cleanup
+                youtube_id = thumb.rstrip(".jpg")
+                self.delete_vid_thumb(youtube_id)
+
+    def get_thumb_list(self):
+        """get list of mediafiles and matching thumbnails"""
+        all_indexed = queue.PendingList().get_all_indexed()
+        video_list = []
+        for video in all_indexed:
+            youtube_id = video["youtube_id"]
+            media_url = os.path.join(self.MEDIA_DIR, video["media_url"])
+            thumb_path = os.path.join(
+                self.CACHE_DIR, self.vid_thumb_path(youtube_id)
+            )
+            video_list.append(
+                {
+                    "media_url": media_url,
+                    "thumb_path": thumb_path,
+                }
+            )
+
+        return video_list
+
+    @staticmethod
+    def write_all_thumbs(video_list):
+        """rewrite the thumbnail into media file"""
+
+        counter = 1
+        for video in video_list:
+            # loop through all videos
+            media_url = video["media_url"]
+            thumb_path = video["thumb_path"]
+
+            mutagen_vid = MP4(media_url)
+            with open(thumb_path, "rb") as f:
+                mutagen_vid["covr"] = [
+                    MP4Cover(f.read(), imageformat=MP4Cover.FORMAT_JPEG)
+                ]
+            mutagen_vid.save()
+            if counter % 50 == 0:
+                print(f"thumbnail write progress {counter}/{len(video_list)}")
+            counter = counter + 1
+
+
+def validate_thumbnails():
+    """check if all thumbnails are there and organized correctly"""
+    handler = ThumbManager()
+    thumbs_to_download = handler.get_needed_thumbs(missing_only=True)
+    handler.download_vid(thumbs_to_download)
+    missing_channels = handler.get_missing_channels()
+    handler.download_chan(missing_channels)
+    missing_playlists = handler.get_missing_playlists()
+    handler.download_playlist(missing_playlists)
+    handler.cleanup_downloaded()

tubearchivist/home/src/download/yt_dlp_handler.py

@@ -0,0 +1,316 @@
+"""
+functionality:
+- handle yt_dlp
+- build options and post processor
+- download video files
+- move to archive
+"""
+
+import os
+import shutil
+from datetime import datetime
+from time import sleep
+
+import requests
+import yt_dlp
+from home.src.download.queue import PendingList
+from home.src.download.subscriptions import PlaylistSubscription
+from home.src.es.connect import IndexPaginate
+from home.src.index.channel import YoutubeChannel
+from home.src.index.playlist import YoutubePlaylist
+from home.src.index.video import YoutubeVideo, index_new_video
+from home.src.ta.config import AppConfig
+from home.src.ta.helper import clean_string, ignore_filelist
+from home.src.ta.ta_redis import RedisArchivist, RedisQueue
+
+
+class VideoDownloader:
+    """
+    handle the video download functionality
+    if not initiated with list, take from queue
+    """
+
+    def __init__(self, youtube_id_list=False):
+        self.obs = False
+        self.youtube_id_list = youtube_id_list
+        self.config = AppConfig().config
+        self._build_obs()
+        self.channels = set()
+
+    def run_queue(self):
+        """setup download queue in redis loop until no more items"""
+        queue = RedisQueue("dl_queue")
+
+        limit_queue = self.config["downloads"]["limit_count"]
+        if limit_queue:
+            queue.trim(limit_queue - 1)
+
+        while True:
+            youtube_id = queue.get_next()
+            if not youtube_id:
+                break
+
+            try:
+                self._dl_single_vid(youtube_id)
+            except yt_dlp.utils.DownloadError:
+                print("failed to download " + youtube_id)
+                continue
+            vid_dict = index_new_video(youtube_id)
+            self.channels.add(vid_dict["channel"]["channel_id"])
+            self.move_to_archive(vid_dict)
+            self._delete_from_pending(youtube_id)
+
+        autodelete_days = self.config["downloads"]["autodelete_days"]
+        if autodelete_days:
+            print(f"auto delete older than {autodelete_days} days")
+            self.auto_delete_watched(autodelete_days)
+
+    @staticmethod
+    def add_pending():
+        """add pending videos to download queue"""
+        mess_dict = {
+            "status": "message:download",
+            "level": "info",
+            "title": "Looking for videos to download",
+            "message": "Scanning your download queue.",
+        }
+        RedisArchivist().set_message("message:download", mess_dict)
+        all_pending, _ = PendingList().get_all_pending()
+        to_add = [i["youtube_id"] for i in all_pending]
+        if not to_add:
+            # there is nothing pending
+            print("download queue is empty")
+            mess_dict = {
+                "status": "message:download",
+                "level": "error",
+                "title": "Download queue is empty",
+                "message": "Add some videos to the queue first.",
+            }
+            RedisArchivist().set_message("message:download", mess_dict)
+            return
+
+        queue = RedisQueue("dl_queue")
+        queue.add_list(to_add)
+
+    @staticmethod
+    def _progress_hook(response):
+        """process the progress_hooks from yt_dlp"""
+        # title
+        path = os.path.split(response["filename"])[-1][12:]
+        filename = os.path.splitext(os.path.splitext(path)[0])[0]
+        filename_clean = filename.replace("_", " ")
+        title = "Downloading: " + filename_clean
+        # message
+        try:
+            percent = response["_percent_str"]
+            size = response["_total_bytes_str"]
+            speed = response["_speed_str"]
+            eta = response["_eta_str"]
+            message = f"{percent} of {size} at {speed} - time left: {eta}"
+        except KeyError:
+            message = "processing"
+        mess_dict = {
+            "status": "message:download",
+            "level": "info",
+            "title": title,
+            "message": message,
+        }
+        RedisArchivist().set_message("message:download", mess_dict)
+
+    def _build_obs(self):
+        """collection to build all obs passed to yt-dlp"""
+        self._build_obs_basic()
+        self._build_obs_user()
+        self._build_obs_postprocessors()
+
+    def _build_obs_basic(self):
+        """initial obs"""
+        self.obs = {
+            "default_search": "ytsearch",
+            "merge_output_format": "mp4",
+            "restrictfilenames": True,
+            "outtmpl": (
+                self.config["application"]["cache_dir"]
+                + "/download/"
+                + self.config["application"]["file_template"]
+            ),
+            "progress_hooks": [self._progress_hook],
+            "noprogress": True,
+            "quiet": True,
+            "continuedl": True,
+            "retries": 3,
+            "writethumbnail": False,
+            "noplaylist": True,
+            "check_formats": "selected",
+        }
+
+    def _build_obs_user(self):
+        """build user customized options"""
+        if self.config["downloads"]["format"]:
+            self.obs["format"] = self.config["downloads"]["format"]
+        if self.config["downloads"]["limit_speed"]:
+            self.obs["ratelimit"] = (
+                self.config["downloads"]["limit_speed"] * 1024
+            )
+
+        throttle = self.config["downloads"]["throttledratelimit"]
+        if throttle:
+            self.obs["throttledratelimit"] = throttle * 1024
+
+    def _build_obs_postprocessors(self):
+        """add postprocessor to obs"""
+        postprocessors = []
+
+        if self.config["downloads"]["add_metadata"]:
+            postprocessors.append(
+                {
+                    "key": "FFmpegMetadata",
+                    "add_chapters": True,
+                    "add_metadata": True,
+                }
+            )
+
+        if self.config["downloads"]["add_thumbnail"]:
+            postprocessors.append(
+                {
+                    "key": "EmbedThumbnail",
+                    "already_have_thumbnail": True,
+                }
+            )
+            self.obs["writethumbnail"] = True
+
+        self.obs["postprocessors"] = postprocessors
+
+    def _dl_single_vid(self, youtube_id):
+        """download single video"""
+        dl_cache = self.config["application"]["cache_dir"] + "/download/"
+
+        # check if already in cache to continue from there
+        all_cached = ignore_filelist(os.listdir(dl_cache))
+        for file_name in all_cached:
+            if youtube_id in file_name:
+                self.obs["outtmpl"] = os.path.join(dl_cache, file_name)
+        with yt_dlp.YoutubeDL(self.obs) as ydl:
+            try:
+                ydl.download([youtube_id])
+            except yt_dlp.utils.DownloadError:
+                print("retry failed download: " + youtube_id)
+                sleep(10)
+                ydl.download([youtube_id])
+
+        if self.obs["writethumbnail"]:
+            # webp files don't get cleaned up automatically
+            all_cached = ignore_filelist(os.listdir(dl_cache))
+            to_clean = [i for i in all_cached if not i.endswith(".mp4")]
+            for file_name in to_clean:
+                file_path = os.path.join(dl_cache, file_name)
+                os.remove(file_path)
+
+    def move_to_archive(self, vid_dict):
+        """move downloaded video from cache to archive"""
+        videos = self.config["application"]["videos"]
+        host_uid = self.config["application"]["HOST_UID"]
+        host_gid = self.config["application"]["HOST_GID"]
+        channel_name = clean_string(vid_dict["channel"]["channel_name"])
+        if len(channel_name) <= 3:
+            # fall back to channel id
+            channel_name = vid_dict["channel"]["channel_id"]
+        # make archive folder with correct permissions
+        new_folder = os.path.join(videos, channel_name)
+        if not os.path.exists(new_folder):
+            os.makedirs(new_folder)
+            if host_uid and host_gid:
+                os.chown(new_folder, host_uid, host_gid)
+        # find real filename
+        cache_dir = self.config["application"]["cache_dir"]
+        all_cached = ignore_filelist(os.listdir(cache_dir + "/download/"))
+        for file_str in all_cached:
+            if vid_dict["youtube_id"] in file_str:
+                old_file = file_str
+        old_file_path = os.path.join(cache_dir, "download", old_file)
+        new_file_path = os.path.join(videos, vid_dict["media_url"])
+        # move media file and fix permission
+        shutil.move(old_file_path, new_file_path)
+        if host_uid and host_gid:
+            os.chown(new_file_path, host_uid, host_gid)
+
+    def _delete_from_pending(self, youtube_id):
+        """delete downloaded video from pending index if its there"""
+        es_url = self.config["application"]["es_url"]
+        es_auth = self.config["application"]["es_auth"]
+        url = f"{es_url}/ta_download/_doc/{youtube_id}"
+        response = requests.delete(url, auth=es_auth)
+        if not response.ok and not response.status_code == 404:
+            print(response.text)
+
+    def _add_subscribed_channels(self):
+        """add all channels subscribed to refresh"""
+        all_subscribed = PlaylistSubscription().get_playlists()
+        if not all_subscribed:
+            return
+
+        channel_ids = [i["playlist_channel_id"] for i in all_subscribed]
+        for channel_id in channel_ids:
+            self.channels.add(channel_id)
+
+        return
+
+    def validate_playlists(self):
+        """look for playlist needing to update"""
+        print("sync playlists")
+        self._add_subscribed_channels()
+        all_indexed = PendingList().get_all_indexed()
+        all_youtube_ids = [i["youtube_id"] for i in all_indexed]
+        for id_c, channel_id in enumerate(self.channels):
+            playlists = YoutubeChannel(channel_id).get_indexed_playlists()
+            all_playlist_ids = [i["playlist_id"] for i in playlists]
+            for id_p, playlist_id in enumerate(all_playlist_ids):
+                playlist = YoutubePlaylist(playlist_id)
+                playlist.all_youtube_ids = all_youtube_ids
+                playlist.build_json(scrape=True)
+                if not playlist.json_data:
+                    playlist.deactivate()
+
+                playlist.add_vids_to_playlist()
+                playlist.upload_to_es()
+
+                # notify
+                title = (
+                    "Processing playlists for channels: "
+                    + f"{id_c + 1}/{len(self.channels)}"
+                )
+                message = f"Progress: {id_p + 1}/{len(all_playlist_ids)}"
+                mess_dict = {
+                    "status": "message:download",
+                    "level": "info",
+                    "title": title,
+                    "message": message,
+                }
+                if id_p + 1 == len(all_playlist_ids):
+                    RedisArchivist().set_message(
+                        "message:download", mess_dict, expire=4
+                    )
+                else:
+                    RedisArchivist().set_message("message:download", mess_dict)
+
+    @staticmethod
+    def auto_delete_watched(autodelete_days):
+        """delete watched videos after x days"""
+        now = int(datetime.now().strftime("%s"))
+        now_lte = now - autodelete_days * 24 * 60 * 60
+        data = {
+            "query": {"range": {"player.watched_date": {"lte": now_lte}}},
+            "sort": [{"player.watched_date": {"order": "asc"}}],
+        }
+        all_to_delete = IndexPaginate("ta_video", data).get_results()
+        all_youtube_ids = [i["youtube_id"] for i in all_to_delete]
+        if not all_youtube_ids:
+            return
+
+        for youtube_id in all_youtube_ids:
+            print(f"autodelete {youtube_id}")
+            YoutubeVideo(youtube_id).delete_media_file()
+
+        print("add deleted to ignore list")
+        pending_handler = PendingList()
+        pending_handler.add_to_pending(all_youtube_ids, ignore=True)

tubearchivist/home/src/es/connect.py

@@ -0,0 +1,148 @@
+"""
+functionality:
+- wrapper around requests to call elastic search
+- reusable search_after to extract total index
+"""
+
+import json
+
+import requests
+from home.src.ta.config import AppConfig
+
+
+class ElasticWrap:
+    """makes all calls to elastic search
+    returns response json and status code tuple
+    """
+
+    def __init__(self, path, config=False):
+        self.url = False
+        self.auth = False
+        self.path = path
+        self.config = config
+        self._get_config()
+
+    def _get_config(self):
+        """add config if not passed"""
+        if not self.config:
+            self.config = AppConfig().config
+
+        es_url = self.config["application"]["es_url"]
+        self.auth = self.config["application"]["es_auth"]
+        self.url = f"{es_url}/{self.path}"
+
+    def get(self, data=False):
+        """get data from es"""
+        if data:
+            response = requests.get(self.url, json=data, auth=self.auth)
+        else:
+            response = requests.get(self.url, auth=self.auth)
+        if not response.ok:
+            print(response.text)
+
+        return response.json(), response.status_code
+
+    def post(self, data=False, ndjson=False):
+        """post data to es"""
+        if ndjson:
+            headers = {"Content-type": "application/x-ndjson"}
+            payload = data
+        else:
+            headers = {"Content-type": "application/json"}
+            payload = json.dumps(data)
+
+        if data:
+            response = requests.post(
+                self.url, data=payload, headers=headers, auth=self.auth
+            )
+        else:
+            response = requests.post(self.url, headers=headers, auth=self.auth)
+
+        if not response.ok:
+            print(response.text)
+
+        return response.json(), response.status_code
+
+    def put(self, data, refresh=False):
+        """put data to es"""
+        if refresh:
+            self.url = f"{self.url}/?refresh=true"
+        response = requests.put(f"{self.url}", json=data, auth=self.auth)
+        if not response.ok:
+            print(response.text)
+            print(data)
+            raise ValueError("failed to add item to index")
+
+        return response.json(), response.status_code
+
+    def delete(self, data=False):
+        """delete document from es"""
+        if data:
+            response = requests.delete(self.url, json=data, auth=self.auth)
+        else:
+            response = requests.delete(self.url, auth=self.auth)
+
+        if not response.ok:
+            print(response.text)
+
+        return response.json(), response.status_code
+
+
+class IndexPaginate:
+    """use search_after to go through whole index"""
+
+    DEFAULT_SIZE = 500
+
+    def __init__(self, index_name, data, size=False):
+        self.index_name = index_name
+        self.data = data
+        self.pit_id = False
+        self.size = size
+
+    def get_results(self):
+        """get all results"""
+        self.get_pit()
+        self.validate_data()
+        all_results = self.run_loop()
+        self.clean_pit()
+        return all_results
+
+    def get_pit(self):
+        """get pit for index"""
+        path = f"{self.index_name}/_pit?keep_alive=10m"
+        response, _ = ElasticWrap(path).post()
+        self.pit_id = response["id"]
+
+    def validate_data(self):
+        """add pit and size to data"""
+        if "sort" not in self.data.keys():
+            print(self.data)
+            raise ValueError("missing sort key in data")
+
+        size = self.size or self.DEFAULT_SIZE
+
+        self.data["size"] = size
+        self.data["pit"] = {"id": self.pit_id, "keep_alive": "10m"}
+
+    def run_loop(self):
+        """loop through results until last hit"""
+        all_results = []
+        while True:
+            response, _ = ElasticWrap("_search").get(data=self.data)
+            all_hits = response["hits"]["hits"]
+            if all_hits:
+                for hit in all_hits:
+                    source = hit["_source"]
+                    search_after = hit["sort"]
+                    all_results.append(source)
+                # update search_after with last hit data
+                self.data["search_after"] = search_after
+            else:
+                break
+
+        return all_results
+
+    def clean_pit(self):
+        """delete pit from elastic search"""
+        data = {"id": self.pit_id}
+        ElasticWrap("_pit").delete(data=data)

tubearchivist/home/src/es/index_mapping.json

@@ -0,0 +1,375 @@
+{
+    "index_config": [{
+            "index_name": "channel",
+            "expected_map": {
+                "channel_id": {
+                    "type": "keyword"
+                },
+                "channel_name": {
+                    "type": "text",
+                    "analyzer": "english",
+                    "fields": {
+                        "keyword": {
+                            "type": "keyword",
+                            "ignore_above": 256,
+                            "normalizer": "to_lower"
+                        },
+                        "search_as_you_type": {
+                            "type": "search_as_you_type",
+                            "doc_values": false,
+                            "max_shingle_size": 3
+                        }
+                    }
+                },
+                "channel_banner_url": {
+                    "type": "keyword",
+                    "index": false
+                },
+                "channel_tvart_url": {
+                    "type": "keyword",
+                    "index": false
+                },
+                "channel_thumb_url": {
+                    "type": "keyword",
+                    "index": false
+                },
+                "channel_description": {
+                    "type": "text"
+                },
+                "channel_last_refresh": {
+                    "type": "date",
+                    "format": "epoch_second"
+                }
+            },
+            "expected_set": {
+                "analysis": {
+                    "normalizer": {
+                        "to_lower": {
+                            "type": "custom",
+                            "filter": ["lowercase"]
+                        }
+                    }
+                },
+                "number_of_replicas": "0"
+            }
+        },
+        {
+            "index_name": "video",
+            "expected_map": {
+                "vid_thumb_url": {
+                    "type": "text",
+                    "index": false
+                },
+                "date_downloaded": {
+                    "type": "date"
+                },
+                "channel": {
+                    "properties": {
+                        "channel_id": {
+                            "type": "keyword"
+                        },
+                        "channel_name": {
+                            "type": "text",
+                            "analyzer": "english",
+                            "fields": {
+                                "keyword": {
+                                    "type": "keyword",
+                                    "ignore_above": 256,
+                                    "normalizer": "to_lower"
+                                },
+                                "search_as_you_type": {
+                                    "type": "search_as_you_type",
+                                    "doc_values": false,
+                                    "max_shingle_size": 3
+                                }
+                            }
+                        },
+                        "channel_banner_url": {
+                            "type": "keyword",
+                            "index": false
+                        },
+                        "channel_tvart_url": {
+                            "type": "keyword",
+                            "index": false
+                        },
+                        "channel_thumb_url": {
+                            "type": "keyword",
+                            "index": false
+                        },
+                        "channel_description": {
+                            "type": "text"
+                        },
+                        "channel_last_refresh": {
+                            "type": "date",
+                            "format": "epoch_second"
+                        }
+                    }
+                },
+                "description": {
+                    "type": "text"
+                },
+                "media_url": {
+                    "type": "keyword",
+                    "index": false
+                },
+                "tags": {
+                    "type": "text",
+                    "analyzer": "english",
+                    "fields": {
+                        "keyword": {
+                            "type": "keyword",
+                            "ignore_above": 256
+                        }
+                    }
+                },
+                "title": {
+                    "type": "text",
+                    "analyzer": "english",
+                    "fields": {
+                        "keyword": {
+                            "type": "keyword",
+                            "ignore_above": 256,
+                            "normalizer": "to_lower"
+                        },
+                        "search_as_you_type": {
+                            "type": "search_as_you_type",
+                            "doc_values": false,
+                            "max_shingle_size": 3
+                        }
+                    }
+                },
+                "vid_last_refresh": {
+                    "type": "date"
+                },
+                "youtube_id": {
+                    "type": "keyword"
+                },
+                "published": {
+                    "type": "date"
+                },
+                "playlist": {
+                    "type": "text",
+                    "fields": {
+                        "keyword": {
+                            "type": "keyword",
+                            "ignore_above": 256,
+                            "normalizer": "to_lower"
+                        }
+                    }
+                },
+                "subtitles": {
+                    "properties": {
+                        "ext": {
+                            "type": "keyword",
+                            "index": false
+                        },
+                        "lang": {
+                            "type": "keyword",
+                            "index": false
+                        },
+                        "media_url": {
+                            "type": "keyword",
+                            "index": false
+                        },
+                        "name": {
+                            "type": "keyword"
+                        },
+                        "source": {
+                            "type": "keyword"
+                        },
+                        "url": {
+                            "type": "keyword",
+                            "index": false
+                        }
+                    }
+                }
+            },
+            "expected_set": {
+                "analysis": {
+                    "normalizer": {
+                        "to_lower": {
+                            "type": "custom",
+                            "filter": ["lowercase"]
+                        }
+                    }
+                },
+                "number_of_replicas": "0"
+            }
+        },
+        {
+            "index_name": "download",
+            "expected_map": {
+                "timestamp": {
+                    "type": "date"
+                },
+                "channel_id": {
+                    "type": "keyword"
+                },
+                "channel_name": {
+                    "type": "text",
+                    "fields": {
+                        "keyword": {
+                            "type": "keyword",
+                            "ignore_above": 256,
+                            "normalizer": "to_lower"
+                        }
+                    }
+                },
+                "status": {
+                    "type": "keyword"
+                },
+                "title": {
+                    "type": "text",
+                    "fields": {
+                        "keyword": {
+                            "type": "keyword",
+                            "ignore_above": 256,
+                            "normalizer": "to_lower"
+                        }
+                    }
+                },
+                "vid_thumb_url": {
+                    "type": "keyword"
+                },
+                "youtube_id": {
+                    "type": "keyword"
+                }
+            },
+            "expected_set": {
+                "analysis": {
+                    "normalizer": {
+                        "to_lower": {
+                            "type": "custom",
+                            "filter": ["lowercase"]
+                        }
+                    }
+                },
+                "number_of_replicas": "0"
+            }
+        },
+        {
+            "index_name": "playlist",
+            "expected_map": {
+                "playlist_id": {
+                    "type": "keyword"
+                },
+                "playlist_description": {
+                    "type": "text"
+                },
+                "playlist_name": {
+                    "type": "text",
+                    "analyzer": "english",
+                    "fields": {
+                        "keyword": {
+                            "type": "keyword",
+                            "ignore_above": 256,
+                            "normalizer": "to_lower"
+                        },
+                        "search_as_you_type": {
+                            "type": "search_as_you_type",
+                            "doc_values": false,
+                            "max_shingle_size": 3
+                        }
+                    }
+                },
+                "playlist_channel": {
+                    "type": "text",
+                    "fields": {
+                        "keyword": {
+                            "type": "keyword",
+                            "ignore_above": 256,
+                            "normalizer": "to_lower"
+                        }
+                    }
+                },
+                "playlist_channel_id": {
+                    "type": "keyword"
+                },
+                "playlist_thumbnail": {
+                    "type": "keyword"
+                },
+                "playlist_last_refresh": {
+                    "type": "date"
+                }
+            },
+            "expected_set": {
+                "analysis": {
+                    "normalizer": {
+                        "to_lower": {
+                            "type": "custom",
+                            "filter": ["lowercase"]
+                        }
+                    }
+                },
+                "number_of_replicas": "0"
+            }
+        },
+        {
+            "index_name": "subtitle",
+            "expected_map": {
+                "youtube_id": {
+                    "type": "keyword"
+                },
+                "title": {
+                    "type": "text",
+                    "fields": {
+                        "keyword": {
+                            "type": "keyword",
+                            "ignore_above": 256,
+                            "normalizer": "to_lower"
+                        }
+                    }
+                },
+                "subtitle_fragment_id": {
+                    "type": "keyword"
+                },
+                "subtitle_channel": {
+                    "type": "text",
+                    "fields": {
+                        "keyword": {
+                            "type": "keyword",
+                            "ignore_above": 256,
+                            "normalizer": "to_lower"
+                        }
+                    }
+                },
+                "subtitle_channel_id": {
+                    "type": "keyword"
+                },
+                "subtitle_start": {
+                    "type": "text"
+                },
+                "subtitle_end": {
+                    "type": "text"
+                },
+                "subtitle_last_refresh": {
+                    "type": "date"
+                },
+                "subtitle_index": {
+                    "type" : "long"
+                },
+                "subtitle_lang": {
+                    "type": "keyword"
+                },
+                "subtitle_source": {
+                    "type": "keyword"
+                },
+                "subtitle_line": {
+                    "type" : "text",
+                    "analyzer": "english"
+                }
+            },
+            "expected_set": {
+                "analysis": {
+                    "normalizer": {
+                        "to_lower": {
+                            "type": "custom",
+                            "filter": ["lowercase"]
+                        }
+                    }
+                },
+                "number_of_replicas": "0"
+            }
+        }
+    ]
+}

tubearchivist/home/src/es/index_setup.py

@@ -0,0 +1,483 @@
+"""
+functionality:
+- setup elastic index at first start
+- verify and update index mapping and settings if needed
+- backup and restore metadata
+"""
+
+import json
+import os
+import zipfile
+from datetime import datetime
+
+import requests
+from home.src.ta.config import AppConfig
+from home.src.ta.helper import ignore_filelist
+
+
+class ElasticIndex:
+    """
+    handle mapping and settings on elastic search for a given index
+    """
+
+    CONFIG = AppConfig().config
+    ES_URL = CONFIG["application"]["es_url"]
+    ES_AUTH = CONFIG["application"]["es_auth"]
+    HEADERS = {"Content-type": "application/json"}
+
+    def __init__(self, index_name, expected_map, expected_set):
+        self.index_name = index_name
+        self.expected_map = expected_map
+        self.expected_set = expected_set
+        self.exists, self.details = self.index_exists()
+
+    def index_exists(self):
+        """check if index already exists and return mapping if it does"""
+        index_name = self.index_name
+        url = f"{self.ES_URL}/ta_{index_name}"
+        response = requests.get(url, auth=self.ES_AUTH)
+        exists = response.ok
+
+        if exists:
+            details = response.json()[f"ta_{index_name}"]
+        else:
+            details = False
+
+        return exists, details
+
+    def validate(self):
+        """
+        check if all expected mappings and settings match
+        returns True when rebuild is needed
+        """
+
+        if self.expected_map:
+            rebuild = self.validate_mappings()
+            if rebuild:
+                return rebuild
+
+        if self.expected_set:
+            rebuild = self.validate_settings()
+            if rebuild:
+                return rebuild
+
+        return False
+
+    def validate_mappings(self):
+        """check if all mappings are as expected"""
+
+        expected_map = self.expected_map
+        now_map = self.details["mappings"]["properties"]
+
+        for key, value in expected_map.items():
+            # nested
+            if list(value.keys()) == ["properties"]:
+                for key_n, value_n in value["properties"].items():
+                    if key_n not in now_map[key]["properties"].keys():
+                        print(key_n, value_n)
+                        return True
+                    if not value_n == now_map[key]["properties"][key_n]:
+                        print(key_n, value_n)
+                        return True
+
+                continue
+
+            # not nested
+            if key not in now_map.keys():
+                print(key, value)
+                return True
+            if not value == now_map[key]:
+                print(key, value)
+                return True
+
+        return False
+
+    def validate_settings(self):
+        """check if all settings are as expected"""
+
+        now_set = self.details["settings"]["index"]
+
+        for key, value in self.expected_set.items():
+            if key not in now_set.keys():
+                print(key, value)
+                return True
+
+            if not value == now_set[key]:
+                print(key, value)
+                return True
+
+        return False
+
+    def rebuild_index(self):
+        """rebuild with new mapping"""
+        # backup
+        self.reindex("backup")
+        # delete original
+        self.delete_index(backup=False)
+        # create new
+        self.create_blank()
+        self.reindex("restore")
+        # delete backup
+        self.delete_index()
+
+    def reindex(self, method):
+        """create on elastic search"""
+        index_name = self.index_name
+        if method == "backup":
+            source = f"ta_{index_name}"
+            destination = f"ta_{index_name}_backup"
+        elif method == "restore":
+            source = f"ta_{index_name}_backup"
+            destination = f"ta_{index_name}"
+
+        query = {"source": {"index": source}, "dest": {"index": destination}}
+        data = json.dumps(query)
+        url = self.ES_URL + "/_reindex?refresh=true"
+        response = requests.post(
+            url=url, data=data, headers=self.HEADERS, auth=self.ES_AUTH
+        )
+        if not response.ok:
+            print(response.text)
+
+    def delete_index(self, backup=True):
+        """delete index passed as argument"""
+        if backup:
+            url = f"{self.ES_URL}/ta_{self.index_name}_backup"
+        else:
+            url = f"{self.ES_URL}/ta_{self.index_name}"
+        response = requests.delete(url, auth=self.ES_AUTH)
+        if not response.ok:
+            print(response.text)
+
+    def create_blank(self):
+        """apply new mapping and settings for blank new index"""
+        expected_map = self.expected_map
+        expected_set = self.expected_set
+        # stich payload
+        payload = {}
+        if expected_set:
+            payload.update({"settings": expected_set})
+        if expected_map:
+            payload.update({"mappings": {"properties": expected_map}})
+        # create
+        url = f"{self.ES_URL}/ta_{self.index_name}"
+        data = json.dumps(payload)
+        response = requests.put(
+            url=url, data=data, headers=self.HEADERS, auth=self.ES_AUTH
+        )
+        if not response.ok:
+            print(response.text)
+
+
+class ElasticBackup:
+    """dump index to nd-json files for later bulk import"""
+
+    def __init__(self, index_config, reason):
+        self.config = AppConfig().config
+        self.index_config = index_config
+        self.reason = reason
+        self.timestamp = datetime.now().strftime("%Y%m%d")
+        self.backup_files = []
+
+    def get_all_documents(self, index_name):
+        """export all documents of a single index"""
+        headers = {"Content-type": "application/json"}
+        es_url = self.config["application"]["es_url"]
+        es_auth = self.config["application"]["es_auth"]
+        # get PIT ID
+        url = f"{es_url}/ta_{index_name}/_pit?keep_alive=1m"
+        response = requests.post(url, auth=es_auth)
+        json_data = json.loads(response.text)
+        pit_id = json_data["id"]
+        # build query
+        data = {
+            "query": {"match_all": {}},
+            "size": 100,
+            "pit": {"id": pit_id, "keep_alive": "1m"},
+            "sort": [{"_id": {"order": "asc"}}],
+        }
+        query_str = json.dumps(data)
+        url = es_url + "/_search"
+        # loop until nothing left
+        all_results = []
+        while True:
+            response = requests.get(
+                url, data=query_str, headers=headers, auth=es_auth
+            )
+            json_data = json.loads(response.text)
+            all_hits = json_data["hits"]["hits"]
+            if all_hits:
+                for hit in all_hits:
+                    search_after = hit["sort"]
+                    all_results.append(hit)
+                # update search_after with last hit data
+                data["search_after"] = search_after
+                query_str = json.dumps(data)
+            else:
+                break
+        # clean up PIT
+        query_str = json.dumps({"id": pit_id})
+        requests.delete(
+            es_url + "/_pit", data=query_str, headers=headers, auth=es_auth
+        )
+
+        return all_results
+
+    @staticmethod
+    def build_bulk(all_results):
+        """build bulk query data from all_results"""
+        bulk_list = []
+
+        for document in all_results:
+            document_id = document["_id"]
+            es_index = document["_index"]
+            action = {"index": {"_index": es_index, "_id": document_id}}
+            source = document["_source"]
+            bulk_list.append(json.dumps(action))
+            bulk_list.append(json.dumps(source))
+
+        # add last newline
+        bulk_list.append("\n")
+        file_content = "\n".join(bulk_list)
+
+        return file_content
+
+    def write_es_json(self, file_content, index_name):
+        """write nd-json file for es _bulk API to disk"""
+        cache_dir = self.config["application"]["cache_dir"]
+        file_name = f"es_{index_name}-{self.timestamp}.json"
+        file_path = os.path.join(cache_dir, "backup", file_name)
+        with open(file_path, "w", encoding="utf-8") as f:
+            f.write(file_content)
+
+        self.backup_files.append(file_path)
+
+    def write_ta_json(self, all_results, index_name):
+        """write generic json file to disk"""
+        cache_dir = self.config["application"]["cache_dir"]
+        file_name = f"ta_{index_name}-{self.timestamp}.json"
+        file_path = os.path.join(cache_dir, "backup", file_name)
+        to_write = [i["_source"] for i in all_results]
+        file_content = json.dumps(to_write)
+        with open(file_path, "w", encoding="utf-8") as f:
+            f.write(file_content)
+
+        self.backup_files.append(file_path)
+
+    def zip_it(self):
+        """pack it up into single zip file"""
+        cache_dir = self.config["application"]["cache_dir"]
+        file_name = f"ta_backup-{self.timestamp}-{self.reason}.zip"
+        backup_folder = os.path.join(cache_dir, "backup")
+        backup_file = os.path.join(backup_folder, file_name)
+
+        with zipfile.ZipFile(
+            backup_file, "w", compression=zipfile.ZIP_DEFLATED
+        ) as zip_f:
+            for backup_file in self.backup_files:
+                zip_f.write(backup_file, os.path.basename(backup_file))
+
+        # cleanup
+        for backup_file in self.backup_files:
+            os.remove(backup_file)
+
+    def post_bulk_restore(self, file_name):
+        """send bulk to es"""
+        cache_dir = self.config["application"]["cache_dir"]
+        es_url = self.config["application"]["es_url"]
+        es_auth = self.config["application"]["es_auth"]
+        headers = {"Content-type": "application/x-ndjson"}
+        file_path = os.path.join(cache_dir, file_name)
+
+        with open(file_path, "r", encoding="utf-8") as f:
+            query_str = f.read()
+
+        if not query_str.strip():
+            return
+
+        url = es_url + "/_bulk"
+        request = requests.post(
+            url, data=query_str, headers=headers, auth=es_auth
+        )
+        if not request.ok:
+            print(request.text)
+
+    def get_all_backup_files(self):
+        """build all available backup files for view"""
+        cache_dir = self.config["application"]["cache_dir"]
+        backup_dir = os.path.join(cache_dir, "backup")
+        backup_files = os.listdir(backup_dir)
+        all_backup_files = ignore_filelist(backup_files)
+        all_available_backups = [
+            i
+            for i in all_backup_files
+            if i.startswith("ta_") and i.endswith(".zip")
+        ]
+        all_available_backups.sort(reverse=True)
+
+        backup_dicts = []
+        for backup_file in all_available_backups:
+            file_split = backup_file.split("-")
+            if len(file_split) == 2:
+                timestamp = file_split[1].strip(".zip")
+                reason = False
+            elif len(file_split) == 3:
+                timestamp = file_split[1]
+                reason = file_split[2].strip(".zip")
+
+            to_add = {
+                "filename": backup_file,
+                "timestamp": timestamp,
+                "reason": reason,
+            }
+            backup_dicts.append(to_add)
+
+        return backup_dicts
+
+    def unpack_zip_backup(self, filename):
+        """extract backup zip and return filelist"""
+        cache_dir = self.config["application"]["cache_dir"]
+        backup_dir = os.path.join(cache_dir, "backup")
+        file_path = os.path.join(backup_dir, filename)
+
+        with zipfile.ZipFile(file_path, "r") as z:
+            zip_content = z.namelist()
+            z.extractall(backup_dir)
+
+        return zip_content
+
+    def restore_json_files(self, zip_content):
+        """go through the unpacked files and restore"""
+
+        cache_dir = self.config["application"]["cache_dir"]
+        backup_dir = os.path.join(cache_dir, "backup")
+
+        for json_f in zip_content:
+
+            file_name = os.path.join(backup_dir, json_f)
+
+            if not json_f.startswith("es_") or not json_f.endswith(".json"):
+                os.remove(file_name)
+                continue
+
+            print("restoring: " + json_f)
+            self.post_bulk_restore(file_name)
+            os.remove(file_name)
+
+    def index_exists(self, index_name):
+        """check if index already exists to skip"""
+        es_url = self.config["application"]["es_url"]
+        es_auth = self.config["application"]["es_auth"]
+        url = f"{es_url}/ta_{index_name}"
+        response = requests.get(url, auth=es_auth)
+
+        return response.ok
+
+    def rotate_backup(self):
+        """delete old backups if needed"""
+        rotate = self.config["scheduler"]["run_backup_rotate"]
+        if not rotate:
+            return
+
+        all_backup_files = self.get_all_backup_files()
+        auto = [i for i in all_backup_files if i["reason"] == "auto"]
+
+        if len(auto) <= rotate:
+            print("no backup files to rotate")
+            return
+
+        cache_dir = self.config["application"]["cache_dir"]
+        backup_dir = os.path.join(cache_dir, "backup")
+
+        all_to_delete = auto[rotate:]
+        for to_delete in all_to_delete:
+            file_path = os.path.join(backup_dir, to_delete["filename"])
+            print(f"remove old backup file: {file_path}")
+            os.remove(file_path)
+
+
+def get_mapping():
+    """read index_mapping.json and get expected mapping and settings"""
+    with open("home/src/es/index_mapping.json", "r", encoding="utf-8") as f:
+        index_config = json.load(f).get("index_config")
+
+    return index_config
+
+
+def index_check(force_restore=False):
+    """check if all indexes are created and have correct mapping"""
+
+    backed_up = False
+    index_config = get_mapping()
+
+    for index in index_config:
+        index_name = index["index_name"]
+        expected_map = index["expected_map"]
+        expected_set = index["expected_set"]
+        handler = ElasticIndex(index_name, expected_map, expected_set)
+        # force restore
+        if force_restore:
+            handler.delete_index(backup=False)
+            handler.create_blank()
+            continue
+
+        # create new
+        if not handler.exists:
+            print(f"create new blank index with name ta_{index_name}...")
+            handler.create_blank()
+            continue
+
+        # validate index
+        rebuild = handler.validate()
+        if rebuild:
+            # make backup before rebuild
+            if not backed_up:
+                print("running backup first")
+                backup_all_indexes(reason="update")
+                backed_up = True
+
+            print(f"applying new mappings to index ta_{index_name}...")
+            handler.rebuild_index()
+            continue
+
+        # else all good
+        print(f"ta_{index_name} index is created and up to date...")
+
+
+def get_available_backups():
+    """return dict of available backups for settings view"""
+    index_config = get_mapping()
+    backup_handler = ElasticBackup(index_config, reason=False)
+    all_backup_files = backup_handler.get_all_backup_files()
+    return all_backup_files
+
+
+def backup_all_indexes(reason):
+    """backup all es indexes to disk"""
+    index_config = get_mapping()
+    backup_handler = ElasticBackup(index_config, reason)
+
+    for index in backup_handler.index_config:
+        index_name = index["index_name"]
+        if not backup_handler.index_exists(index_name):
+            continue
+        all_results = backup_handler.get_all_documents(index_name)
+        file_content = backup_handler.build_bulk(all_results)
+        backup_handler.write_es_json(file_content, index_name)
+        backup_handler.write_ta_json(all_results, index_name)
+
+    backup_handler.zip_it()
+
+    if reason == "auto":
+        backup_handler.rotate_backup()
+
+
+def restore_from_backup(filename):
+    """restore indexes from backup file"""
+    # delete
+    index_check(force_restore=True)
+    # recreate
+    index_config = get_mapping()
+    backup_handler = ElasticBackup(index_config, reason=False)
+    zip_content = backup_handler.unpack_zip_backup(filename)
+    backup_handler.restore_json_files(zip_content)

tubearchivist/home/src/frontend/api_calls.py

@@ -0,0 +1,320 @@
+"""
+Functionality:
+- collection of functions and tasks from frontend
+- called via user input
+"""
+
+from home.src.download.queue import PendingList
+from home.src.download.subscriptions import (
+    ChannelSubscription,
+    PlaylistSubscription,
+)
+from home.src.frontend.searching import SearchForm
+from home.src.frontend.watched import WatchState
+from home.src.index.channel import YoutubeChannel
+from home.src.index.playlist import YoutubePlaylist
+from home.src.index.video import YoutubeVideo
+from home.src.ta.helper import UrlListParser
+from home.src.ta.ta_redis import RedisArchivist, RedisQueue
+from home.tasks import (
+    download_pending,
+    download_single,
+    extrac_dl,
+    index_channel_playlists,
+    kill_dl,
+    re_sync_thumbs,
+    rescan_filesystem,
+    run_backup,
+    run_manual_import,
+    run_restore_backup,
+    subscribe_to,
+    update_subscribed,
+)
+
+
+class PostData:
+    """
+    map frontend http post values to backend funcs
+    handover long running tasks to celery
+    """
+
+    def __init__(self, post_dict, current_user):
+        self.post_dict = post_dict
+        self.to_exec, self.exec_val = list(post_dict.items())[0]
+        self.current_user = current_user
+
+    def run_task(self):
+        """execute and return task result"""
+        to_exec = self.exec_map()
+        task_result = to_exec()
+        return task_result
+
+    def exec_map(self):
+        """map dict key and return function to execute"""
+        exec_map = {
+            "watched": self._watched,
+            "un_watched": self._un_watched,
+            "change_view": self._change_view,
+            "rescan_pending": self._rescan_pending,
+            "ignore": self._ignore,
+            "dl_pending": self._dl_pending,
+            "queue": self._queue_handler,
+            "unsubscribe": self._unsubscribe,
+            "subscribe": self._subscribe,
+            "sort_order": self._sort_order,
+            "hide_watched": self._hide_watched,
+            "show_subed_only": self._show_subed_only,
+            "dlnow": self._dlnow,
+            "show_ignored_only": self._show_ignored_only,
+            "forgetIgnore": self._forget_ignore,
+            "addSingle": self._add_single,
+            "deleteQueue": self._delete_queue,
+            "manual-import": self._manual_import,
+            "re-embed": self._re_embed,
+            "db-backup": self._db_backup,
+            "db-restore": self._db_restore,
+            "fs-rescan": self._fs_rescan,
+            "multi_search": self._multi_search,
+            "delete-video": self._delete_video,
+            "delete-channel": self._delete_channel,
+            "delete-playlist": self._delete_playlist,
+            "find-playlists": self._find_playlists,
+        }
+
+        return exec_map[self.to_exec]
+
+    def _watched(self):
+        """mark as watched"""
+        WatchState(self.exec_val).mark_as_watched()
+        return {"success": True}
+
+    def _un_watched(self):
+        """mark as unwatched"""
+        WatchState(self.exec_val).mark_as_unwatched()
+        return {"success": True}
+
+    def _change_view(self):
+        """process view changes in home, channel, and downloads"""
+        origin, new_view = self.exec_val.split(":")
+        key = f"{self.current_user}:view:{origin}"
+        print(f"change view: {key} to {new_view}")
+        RedisArchivist().set_message(key, {"status": new_view}, expire=False)
+        return {"success": True}
+
+    @staticmethod
+    def _rescan_pending():
+        """look for new items in subscribed channels"""
+        print("rescan subscribed channels")
+        update_subscribed.delay()
+        return {"success": True}
+
+    def _ignore(self):
+        """ignore from download queue"""
+        id_to_ignore = self.exec_val
+        print("ignore video " + id_to_ignore)
+        handler = PendingList()
+        handler.ignore_from_pending([id_to_ignore])
+        # also clear from redis queue
+        RedisQueue("dl_queue").clear_item(id_to_ignore)
+        return {"success": True}
+
+    @staticmethod
+    def _dl_pending():
+        """start the download queue"""
+        print("download pending")
+        running = download_pending.delay()
+        task_id = running.id
+        print("set task id: " + task_id)
+        RedisArchivist().set_message("dl_queue_id", task_id, expire=False)
+        return {"success": True}
+
+    def _queue_handler(self):
+        """queue controls from frontend"""
+        to_execute = self.exec_val
+        if to_execute == "stop":
+            print("stopping download queue")
+            RedisQueue("dl_queue").clear()
+        elif to_execute == "kill":
+            task_id = RedisArchivist().get_message("dl_queue_id")
+            if not isinstance(task_id, str):
+                task_id = False
+            else:
+                print("brutally killing " + task_id)
+            kill_dl(task_id)
+
+        return {"success": True}
+
+    def _unsubscribe(self):
+        """unsubscribe from channels or playlists"""
+        id_unsub = self.exec_val
+        print("unsubscribe from " + id_unsub)
+        to_unsub_list = UrlListParser(id_unsub).process_list()
+        for to_unsub in to_unsub_list:
+            unsub_type = to_unsub["type"]
+            unsub_id = to_unsub["url"]
+            if unsub_type == "playlist":
+                PlaylistSubscription().change_subscribe(
+                    unsub_id, subscribe_status=False
+                )
+            elif unsub_type == "channel":
+                ChannelSubscription().change_subscribe(
+                    unsub_id, channel_subscribed=False
+                )
+            else:
+                raise ValueError("failed to process " + id_unsub)
+
+        return {"success": True}
+
+    def _subscribe(self):
+        """subscribe to channel or playlist, called from js buttons"""
+        id_sub = self.exec_val
+        print("subscribe to " + id_sub)
+        subscribe_to.delay(id_sub)
+        return {"success": True}
+
+    def _sort_order(self):
+        """change the sort between published to downloaded"""
+        sort_order = {"status": self.exec_val}
+        if self.exec_val in ["asc", "desc"]:
+            RedisArchivist().set_message(
+                f"{self.current_user}:sort_order", sort_order, expire=False
+            )
+        else:
+            RedisArchivist().set_message(
+                f"{self.current_user}:sort_by", sort_order, expire=False
+            )
+        return {"success": True}
+
+    def _hide_watched(self):
+        """toggle if to show watched vids or not"""
+        key = f"{self.current_user}:hide_watched"
+        message = {"status": bool(int(self.exec_val))}
+        print(f"toggle {key}: {message}")
+        RedisArchivist().set_message(key, message, expire=False)
+        return {"success": True}
+
+    def _show_subed_only(self):
+        """show or hide subscribed channels only on channels page"""
+        key = f"{self.current_user}:show_subed_only"
+        message = {"status": bool(int(self.exec_val))}
+        print(f"toggle {key}: {message}")
+        RedisArchivist().set_message(key, message, expire=False)
+        return {"success": True}
+
+    def _dlnow(self):
+        """start downloading single vid now"""
+        youtube_id = self.exec_val
+        print("downloading: " + youtube_id)
+        running = download_single.delay(youtube_id=youtube_id)
+        task_id = running.id
+        print("set task id: " + task_id)
+        RedisArchivist().set_message("dl_queue_id", task_id, expire=False)
+        return {"success": True}
+
+    def _show_ignored_only(self):
+        """switch view on /downloads/ to show ignored only"""
+        show_value = self.exec_val
+        key = f"{self.current_user}:show_ignored_only"
+        value = {"status": show_value}
+        print(f"Filter download view ignored only: {show_value}")
+        RedisArchivist().set_message(key, value, expire=False)
+        return {"success": True}
+
+    def _forget_ignore(self):
+        """delete from ta_download index"""
+        youtube_id = self.exec_val
+        print("forgetting from download index: " + youtube_id)
+        PendingList().delete_from_pending(youtube_id)
+        return {"success": True}
+
+    def _add_single(self):
+        """add single youtube_id to download queue"""
+        youtube_id = self.exec_val
+        print("add vid to dl queue: " + youtube_id)
+        PendingList().delete_from_pending(youtube_id)
+        youtube_ids = UrlListParser(youtube_id).process_list()
+        extrac_dl.delay(youtube_ids)
+        return {"success": True}
+
+    def _delete_queue(self):
+        """delete download queue"""
+        status = self.exec_val
+        print("deleting from download queue: " + status)
+        if status == "pending":
+            PendingList().delete_pending("pending")
+        elif status == "ignore":
+            PendingList().delete_pending("ignore")
+        return {"success": True}
+
+    @staticmethod
+    def _manual_import():
+        """run manual import from settings page"""
+        print("starting manual import")
+        run_manual_import.delay()
+        return {"success": True}
+
+    @staticmethod
+    def _re_embed():
+        """rewrite thumbnails into media files"""
+        print("start video thumbnail embed process")
+        re_sync_thumbs.delay()
+        return {"success": True}
+
+    @staticmethod
+    def _db_backup():
+        """backup es to zip from settings page"""
+        print("backing up database")
+        run_backup.delay("manual")
+        return {"success": True}
+
+    def _db_restore(self):
+        """restore es zip from settings page"""
+        print("restoring index from backup zip")
+        filename = self.exec_val
+        run_restore_backup.delay(filename)
+        return {"success": True}
+
+    @staticmethod
+    def _fs_rescan():
+        """start file system rescan task"""
+        print("start filesystem scan")
+        rescan_filesystem.delay()
+        return {"success": True}
+
+    def _multi_search(self):
+        """search through all indexes"""
+        search_query = self.exec_val
+        print("searching for: " + search_query)
+        search_results = SearchForm().multi_search(search_query)
+        return search_results
+
+    def _delete_video(self):
+        """delete media file, metadata and thumb"""
+        youtube_id = self.exec_val
+        YoutubeVideo(youtube_id).delete_media_file()
+        return {"success": True}
+
+    def _delete_channel(self):
+        """delete channel and all matching videos"""
+        channel_id = self.exec_val
+        YoutubeChannel(channel_id).delete_channel()
+        return {"success": True}
+
+    def _delete_playlist(self):
+        """delete playlist, only metadata or incl all videos"""
+        playlist_dict = self.exec_val
+        playlist_id = playlist_dict["playlist-id"]
+        playlist_action = playlist_dict["playlist-action"]
+        print(f"{playlist_id}: delete playlist {playlist_action}")
+        if playlist_action == "metadata":
+            YoutubePlaylist(playlist_id).delete_metadata()
+        elif playlist_action == "all":
+            YoutubePlaylist(playlist_id).delete_videos_playlist()
+
+        return {"success": True}
+
+    def _find_playlists(self):
+        """add all playlists of a channel"""
+        channel_id = self.exec_val
+        index_channel_playlists.delay(channel_id)
+        return {"success": True}

tubearchivist/home/src/frontend/forms.py

@@ -0,0 +1,180 @@
+"""functionality:
+- hold all form classes used in the views
+"""
+
+from django import forms
+from django.contrib.auth.forms import AuthenticationForm
+from django.forms.widgets import PasswordInput, TextInput
+
+
+class CustomAuthForm(AuthenticationForm):
+    """better styled login form"""
+
+    username = forms.CharField(
+        widget=TextInput(
+            attrs={
+                "placeholder": "Username",
+                "autofocus": True,
+                "autocomplete": True,
+            }
+        ),
+        label=False,
+    )
+    password = forms.CharField(
+        widget=PasswordInput(attrs={"placeholder": "Password"}), label=False
+    )
+    remember_me = forms.BooleanField(required=False)
+
+
+class UserSettingsForm(forms.Form):
+    """user configurations values"""
+
+    CHOICES = [
+        ("", "-- change color scheme --"),
+        ("dark", "Dark"),
+        ("light", "Light"),
+    ]
+
+    colors = forms.ChoiceField(
+        widget=forms.Select, choices=CHOICES, required=False
+    )
+    page_size = forms.IntegerField(required=False)
+
+
+class ApplicationSettingsForm(forms.Form):
+    """handle all application settings"""
+
+    METADATA_CHOICES = [
+        ("", "-- change metadata embed --"),
+        ("0", "don't embed metadata"),
+        ("1", "embed metadata"),
+    ]
+
+    THUMBNAIL_CHOICES = [
+        ("", "-- change thumbnail embed --"),
+        ("0", "don't embed thumbnail"),
+        ("1", "embed thumbnail"),
+    ]
+
+    RYD_CHOICES = [
+        ("", "-- change ryd integrations"),
+        ("0", "disable ryd integration"),
+        ("1", "enable ryd integration"),
+    ]
+
+    CAST_CHOICES = [
+        ("", "-- change Cast integration --"),
+        ("0", "disable Cast"),
+        ("1", "enable Cast"),
+    ]
+
+    SUBTITLE_SOURCE_CHOICES = [
+        ("", "-- change subtitle source settings"),
+        ("user", "only download user created"),
+        ("auto", "also download auto generated"),
+    ]
+
+    SUBTITLE_INDEX_CHOICES = [
+        ("", "-- change subtitle index settings --"),
+        ("0", "disable subtitle index"),
+        ("1", "enable subtitle index"),
+    ]
+
+    subscriptions_channel_size = forms.IntegerField(required=False)
+    downloads_limit_count = forms.IntegerField(required=False)
+    downloads_limit_speed = forms.IntegerField(required=False)
+    downloads_throttledratelimit = forms.IntegerField(required=False)
+    downloads_sleep_interval = forms.IntegerField(required=False)
+    downloads_autodelete_days = forms.IntegerField(required=False)
+    downloads_format = forms.CharField(required=False)
+    downloads_add_metadata = forms.ChoiceField(
+        widget=forms.Select, choices=METADATA_CHOICES, required=False
+    )
+    downloads_add_thumbnail = forms.ChoiceField(
+        widget=forms.Select, choices=THUMBNAIL_CHOICES, required=False
+    )
+    downloads_subtitle = forms.CharField(required=False)
+    downloads_subtitle_source = forms.ChoiceField(
+        widget=forms.Select, choices=SUBTITLE_SOURCE_CHOICES, required=False
+    )
+    downloads_subtitle_index = forms.ChoiceField(
+        widget=forms.Select, choices=SUBTITLE_INDEX_CHOICES, required=False
+    )
+    downloads_integrate_ryd = forms.ChoiceField(
+        widget=forms.Select, choices=RYD_CHOICES, required=False
+    )
+    application_enable_cast = forms.ChoiceField(
+        widget=forms.Select, choices=CAST_CHOICES, required=False
+    )
+
+
+class SchedulerSettingsForm(forms.Form):
+    """handle scheduler settings"""
+
+    update_subscribed = forms.CharField(required=False)
+    download_pending = forms.CharField(required=False)
+    check_reindex = forms.CharField(required=False)
+    check_reindex_days = forms.IntegerField(required=False)
+    thumbnail_check = forms.CharField(required=False)
+    run_backup = forms.CharField(required=False)
+    run_backup_rotate = forms.IntegerField(required=False)
+
+
+class MultiSearchForm(forms.Form):
+    """multi search form for /search/"""
+
+    searchInput = forms.CharField(
+        label="",
+        widget=forms.TextInput(
+            attrs={
+                "autocomplete": "off",
+                "oninput": "searchMulti(this.value)",
+                "autofocus": True,
+            }
+        ),
+    )
+    home = forms.CharField(widget=forms.HiddenInput())
+    channel = forms.CharField(widget=forms.HiddenInput())
+    playlist = forms.CharField(widget=forms.HiddenInput())
+
+
+class AddToQueueForm(forms.Form):
+    """text area form to add to downloads"""
+
+    vid_url = forms.CharField(
+        label=False,
+        widget=forms.Textarea(
+            attrs={
+                "rows": 4,
+                "placeholder": "Enter Video Urls or IDs here...",
+            }
+        ),
+    )
+
+
+class SubscribeToChannelForm(forms.Form):
+    """text area form to subscribe to multiple channels"""
+
+    subscribe = forms.CharField(
+        label="Subscribe to channels",
+        widget=forms.Textarea(
+            attrs={
+                "rows": 3,
+                "placeholder": "Input channel ID, URL or Video of a channel",
+            }
+        ),
+    )
+
+
+class SubscribeToPlaylistForm(forms.Form):
+    """text area form to subscribe to multiple playlists"""
+
+    subscribe = forms.CharField(
+        label="Subscribe to playlists",
+        widget=forms.Textarea(
+            attrs={
+                "rows": 3,
+                "placeholder": "Input playlist IDs or URLs",
+            }
+        ),
+    )

tubearchivist/home/src/frontend/searching.py

@@ -0,0 +1,203 @@
+"""
+Functionality:
+- handle search to populate results to view
+- cache youtube video thumbnails and channel artwork
+- parse values in hit_cleanup for frontend
+- calculate pagination values
+"""
+
+import urllib.parse
+from datetime import datetime
+
+from home.src.download.thumbnails import ThumbManager
+from home.src.es.connect import ElasticWrap
+from home.src.ta.config import AppConfig
+
+
+class SearchHandler:
+    """search elastic search"""
+
+    def __init__(self, path, config, data=False):
+        self.max_hits = None
+        self.path = path
+        self.config = config
+        self.data = data
+
+    def get_data(self):
+        """get the data"""
+        response, _ = ElasticWrap(self.path, config=self.config).get(self.data)
+
+        if "hits" in response.keys():
+            self.max_hits = response["hits"]["total"]["value"]
+            return_value = response["hits"]["hits"]
+        else:
+            # simulate list for single result to reuse rest of class
+            return_value = [response]
+
+        # stop if empty
+        if not return_value:
+            return False
+
+        all_videos = []
+        all_channels = []
+        for idx, hit in enumerate(return_value):
+            return_value[idx] = self.hit_cleanup(hit)
+            if hit["_index"] == "ta_video":
+                video_dict, channel_dict = self.vid_cache_link(hit)
+                if video_dict not in all_videos:
+                    all_videos.append(video_dict)
+                if channel_dict not in all_channels:
+                    all_channels.append(channel_dict)
+            elif hit["_index"] == "ta_channel":
+                channel_dict = self.channel_cache_link(hit)
+                if channel_dict not in all_channels:
+                    all_channels.append(channel_dict)
+
+        return return_value
+
+    @staticmethod
+    def vid_cache_link(hit):
+        """download thumbnails into cache"""
+        vid_thumb = hit["source"]["vid_thumb_url"]
+        youtube_id = hit["source"]["youtube_id"]
+        channel_id_hit = hit["source"]["channel"]["channel_id"]
+        chan_thumb = hit["source"]["channel"]["channel_thumb_url"]
+        try:
+            chan_banner = hit["source"]["channel"]["channel_banner_url"]
+        except KeyError:
+            chan_banner = False
+        video_dict = {"youtube_id": youtube_id, "vid_thumb": vid_thumb}
+        channel_dict = {
+            "channel_id": channel_id_hit,
+            "chan_thumb": chan_thumb,
+            "chan_banner": chan_banner,
+        }
+        return video_dict, channel_dict
+
+    @staticmethod
+    def channel_cache_link(hit):
+        """build channel thumb links"""
+        channel_id_hit = hit["source"]["channel_id"]
+        chan_thumb = hit["source"]["channel_thumb_url"]
+        try:
+            chan_banner = hit["source"]["channel_banner_url"]
+        except KeyError:
+            chan_banner = False
+        channel_dict = {
+            "channel_id": channel_id_hit,
+            "chan_thumb": chan_thumb,
+            "chan_banner": chan_banner,
+        }
+        return channel_dict
+
+    @staticmethod
+    def hit_cleanup(hit):
+        """clean up and parse data from a single hit"""
+        hit["source"] = hit.pop("_source")
+        hit_keys = hit["source"].keys()
+        if "media_url" in hit_keys:
+            parsed_url = urllib.parse.quote(hit["source"]["media_url"])
+            hit["source"]["media_url"] = parsed_url
+
+        if "published" in hit_keys:
+            published = hit["source"]["published"]
+            date_pub = datetime.strptime(published, "%Y-%m-%d")
+            date_str = datetime.strftime(date_pub, "%d %b, %Y")
+            hit["source"]["published"] = date_str
+
+        if "vid_last_refresh" in hit_keys:
+            vid_last_refresh = hit["source"]["vid_last_refresh"]
+            date_refresh = datetime.fromtimestamp(vid_last_refresh)
+            date_str = datetime.strftime(date_refresh, "%d %b, %Y")
+            hit["source"]["vid_last_refresh"] = date_str
+
+        if "playlist_last_refresh" in hit_keys:
+            playlist_last_refresh = hit["source"]["playlist_last_refresh"]
+            date_refresh = datetime.fromtimestamp(playlist_last_refresh)
+            date_str = datetime.strftime(date_refresh, "%d %b, %Y")
+            hit["source"]["playlist_last_refresh"] = date_str
+
+        if "vid_thumb_url" in hit_keys:
+            youtube_id = hit["source"]["youtube_id"]
+            thumb_path = ThumbManager().vid_thumb_path(youtube_id)
+            hit["source"]["vid_thumb_url"] = thumb_path
+
+        if "channel_last_refresh" in hit_keys:
+            refreshed = hit["source"]["channel_last_refresh"]
+            date_refresh = datetime.fromtimestamp(refreshed)
+            date_str = datetime.strftime(date_refresh, "%d %b, %Y")
+            hit["source"]["channel_last_refresh"] = date_str
+
+        if "channel" in hit_keys:
+            channel_keys = hit["source"]["channel"].keys()
+            if "channel_last_refresh" in channel_keys:
+                refreshed = hit["source"]["channel"]["channel_last_refresh"]
+                date_refresh = datetime.fromtimestamp(refreshed)
+                date_str = datetime.strftime(date_refresh, "%d %b, %Y")
+                hit["source"]["channel"]["channel_last_refresh"] = date_str
+
+        return hit
+
+
+class SearchForm:
+    """build query from search form data"""
+
+    CONFIG = AppConfig().config
+
+    def multi_search(self, search_query):
+        """searching through index"""
+        path = "ta_video,ta_channel,ta_playlist/_search"
+        data = {
+            "size": 30,
+            "query": {
+                "multi_match": {
+                    "query": search_query,
+                    "type": "bool_prefix",
+                    "operator": "and",
+                    "fuzziness": "auto",
+                    "fields": [
+                        "category",
+                        "channel_description",
+                        "channel_name._2gram",
+                        "channel_name._3gram",
+                        "channel_name.search_as_you_type",
+                        "playlist_description",
+                        "playlist_name._2gram",
+                        "playlist_name._3gram",
+                        "playlist_name.search_as_you_type",
+                        "tags",
+                        "title._2gram",
+                        "title._3gram",
+                        "title.search_as_you_type",
+                    ],
+                }
+            },
+        }
+        look_up = SearchHandler(path, config=self.CONFIG, data=data)
+        search_results = look_up.get_data()
+        all_results = self.build_results(search_results)
+
+        return {"results": all_results}
+
+    @staticmethod
+    def build_results(search_results):
+        """build the all_results dict"""
+        video_results = []
+        channel_results = []
+        playlist_results = []
+        if search_results:
+            for result in search_results:
+                if result["_index"] == "ta_video":
+                    video_results.append(result)
+                elif result["_index"] == "ta_channel":
+                    channel_results.append(result)
+                elif result["_index"] == "ta_playlist":
+                    playlist_results.append(result)
+
+        all_results = {
+            "video_results": video_results,
+            "channel_results": channel_results,
+            "playlist_results": playlist_results,
+        }
+
+        return all_results

tubearchivist/home/src/frontend/watched.py

@@ -0,0 +1,128 @@
+"""
+functionality:
+- handle watched state for videos, channels and playlists
+"""
+
+import json
+from datetime import datetime
+
+import requests
+from home.src.ta.config import AppConfig
+from home.src.ta.helper import UrlListParser
+
+
+class WatchState:
+    """handle watched checkbox for videos and channels"""
+
+    CONFIG = AppConfig().config
+    ES_URL = CONFIG["application"]["es_url"]
+    ES_AUTH = CONFIG["application"]["es_auth"]
+    HEADERS = {"Content-type": "application/json"}
+
+    def __init__(self, youtube_id):
+        self.youtube_id = youtube_id
+        self.stamp = int(datetime.now().strftime("%s"))
+
+    def mark_as_watched(self):
+        """update es with new watched value"""
+        url_type = self.dedect_type()
+        if url_type == "video":
+            self.mark_vid_watched()
+        elif url_type == "channel":
+            self.mark_channel_watched()
+        elif url_type == "playlist":
+            self.mark_playlist_watched()
+
+        print(f"marked {self.youtube_id} as watched")
+
+    def mark_as_unwatched(self):
+        """revert watched state to false"""
+        url_type = self.dedect_type()
+        if url_type == "video":
+            self.mark_vid_watched(revert=True)
+
+        print(f"revert {self.youtube_id} as unwatched")
+
+    def dedect_type(self):
+        """find youtube id type"""
+        print(self.youtube_id)
+        url_process = UrlListParser(self.youtube_id).process_list()
+        url_type = url_process[0]["type"]
+        return url_type
+
+    def mark_vid_watched(self, revert=False):
+        """change watched status of single video"""
+        url = self.ES_URL + "/ta_video/_update/" + self.youtube_id
+        data = {
+            "doc": {"player": {"watched": True, "watched_date": self.stamp}}
+        }
+        if revert:
+            data["doc"]["player"]["watched"] = False
+
+        payload = json.dumps(data)
+        request = requests.post(
+            url, data=payload, headers=self.HEADERS, auth=self.ES_AUTH
+        )
+        if not request.ok:
+            print(request.text)
+            raise ValueError("failed to mark video as watched")
+
+    def mark_channel_watched(self):
+        """change watched status of every video in channel"""
+        data = {
+            "query": {
+                "bool": {
+                    "must": [
+                        {
+                            "term": {
+                                "channel.channel_id": {
+                                    "value": self.youtube_id
+                                }
+                            }
+                        },
+                        {"term": {"player.watched": {"value": False}}},
+                    ]
+                }
+            },
+            "script": {
+                "source": "ctx._source.player['watched'] = true",
+                "lang": "painless",
+            },
+        }
+        payload = json.dumps(data)
+        url = f"{self.ES_URL}/ta_video/_update_by_query"
+        request = requests.post(
+            url, data=payload, headers=self.HEADERS, auth=self.ES_AUTH
+        )
+        if not request.ok:
+            print(request.text)
+            raise ValueError("failed mark channel as watched")
+
+    def mark_playlist_watched(self):
+        """change watched state of all videos in playlist"""
+        data = {
+            "query": {
+                "bool": {
+                    "must": [
+                        {
+                            "term": {
+                                "playlist.keyword": {"value": self.youtube_id}
+                            }
+                        },
+                        {"term": {"player.watched": {"value": False}}},
+                    ]
+                }
+            },
+            "script": {
+                "source": "ctx._source.player['watched'] = true",
+                "lang": "painless",
+            },
+        }
+        payload = json.dumps(data)
+        url = f"{self.ES_URL}/ta_video/_update_by_query"
+        request = requests.post(
+            url, data=payload, headers=self.HEADERS, auth=self.ES_AUTH
+        )
+        if not request.ok:
+            print(request.text)
+            raise ValueError("failed mark playlist as watched")

tubearchivist/home/src/helper.py

@@ -1,159 +0,0 @@
-"""
-Loose collection of helper functions
-- don't import AppConfig class here to avoid circular imports
-"""
-
-import json
-import os
-import re
-import string
-import subprocess
-import unicodedata
-
-import requests
-import redis
-
-REDIS_HOST = os.environ.get('REDIS_HOST')
-
-
-def get_total_hits(index, es_url, match_field):
-    """ get total hits from index """
-    headers = {'Content-type': 'application/json'}
-    data = {"query": {"match": {match_field: True}}}
-    payload = json.dumps(data)
-    url = f'{es_url}/{index}/_search?filter_path=hits.total'
-    request = requests.post(url, data=payload, headers=headers)
-    if not request.ok:
-        print(request.text)
-    total_json = json.loads(request.text)
-    total_hits = total_json['hits']['total']['value']
-    return total_hits
-
-
-def clean_string(file_name):
-    """ clean string to only asci characters """
-    whitelist = "-_.() " + string.ascii_letters + string.digits
-    normalized = unicodedata.normalize('NFKD', file_name)
-    ascii_only = normalized.encode('ASCII', 'ignore').decode().strip()
-    white_listed = ''.join(c for c in ascii_only if c in whitelist)
-    cleaned = re.sub(r'[ ]{2,}', ' ', white_listed)
-    return cleaned
-
-
-def process_url_list(url_str):
-    """ parse url_list to find valid youtube video or channel ids """
-    to_replace = ['watch?v=', 'playlist?list=']
-    url_list = re.split('\n+', url_str[0])
-    youtube_ids = []
-    for url in url_list:
-        url_clean = url.strip().strip('/').split('/')[-1]
-        for i in to_replace:
-            url_clean = url_clean.replace(i, '')
-        url_no_param = url_clean.split('&')[0]
-        str_len = len(url_no_param)
-        if str_len == 11:
-            link_type = 'video'
-        elif str_len == 24:
-            link_type = 'channel'
-        elif str_len == 34:
-            link_type = 'playlist'
-        else:
-            # unable to parse
-            raise ValueError('not a valid url: ' + url)
-
-        youtube_ids.append({"url": url_no_param, "type": link_type})
-
-    return youtube_ids
-
-
-def set_message(key, message, expire=True):
-    """ write new message to redis """
-    redis_connection = redis.Redis(host=REDIS_HOST)
-    redis_connection.execute_command(
-        'JSON.SET', key, '.', json.dumps(message)
-    )
-    if expire:
-        redis_connection.execute_command('EXPIRE', key, 20)
-
-
-def get_message(key):
-    """ get any message from JSON key """
-    redis_connection = redis.Redis(host=REDIS_HOST)
-    reply = redis_connection.execute_command('JSON.GET', key)
-    if reply:
-        json_str = json.loads(reply)
-    else:
-        json_str = {"status": False}
-    return json_str
-
-
-def get_dl_message(cache_dir):
-    """ get latest message if available """
-    redis_connection = redis.Redis(host=REDIS_HOST)
-    reply = redis_connection.execute_command('JSON.GET', 'progress:download')
-    if reply:
-        json_str = json.loads(reply)
-    elif json_str := monitor_cache_dir(cache_dir):
-        json_str = monitor_cache_dir(cache_dir)
-    else:
-        json_str = {"status": False}
-    return json_str
-
-
-def get_lock(lock_key):
-    """ handle lock for task management """
-    redis_lock = redis.Redis(host=REDIS_HOST).lock(lock_key)
-    return redis_lock
-
-
-def monitor_cache_dir(cache_dir):
-    """
-    look at download cache dir directly as alterative progress info
-    """
-    dl_cache = os.path.join(cache_dir, 'download')
-    cache_file = os.listdir(dl_cache)
-    if cache_file:
-        filename = cache_file[0][12:].replace('_', ' ').split('.')[0]
-        mess_dict = {
-            "status": "downloading",
-            "level": "info",
-            "title": "Downloading: " + filename,
-            "message": ""
-        }
-    else:
-        return False
-
-    return mess_dict
-
-
-class DurationConverter:
-    """
-    using ffmpeg to get and parse duration from filepath
-    """
-
-    @staticmethod
-    def get_sec(file_path):
-        """ read duration from file """
-        duration = subprocess.run([
-            "ffprobe", "-v", "error", "-show_entries", "format=duration",
-            "-of", "default=noprint_wrappers=1:nokey=1", file_path
-        ], capture_output=True, check=True)
-        duration_sec = int(float(duration.stdout.decode().strip()))
-        return duration_sec
-
-    @staticmethod
-    def get_str(duration_sec):
-        """ takes duration in sec and returns clean string """
-        hours = duration_sec // 3600
-        minutes = (duration_sec - (hours * 3600)) // 60
-        secs = duration_sec - (hours * 3600) - (minutes * 60)
-
-        duration_str = str()
-        if hours:
-            duration_str = str(hours).zfill(2) + ':'
-        if minutes:
-            duration_str = duration_str + str(minutes).zfill(2) + ':'
-        else:
-            duration_str = duration_str + '00:'
-        duration_str = duration_str + str(secs).zfill(2)
-        return duration_str

tubearchivist/home/src/index.py

@@ -1,395 +0,0 @@
-"""
-Functionality:
-- index new videos into elastisearch
-- extract video info with yt_dlp
-- scrape youtube channel page if needed
-"""
-
-import json
-import re
-
-from datetime import datetime
-from time import sleep
-import os
-
-import requests
-import yt_dlp as youtube_dl
-
-from bs4 import BeautifulSoup
-
-from home.src.config import AppConfig
-from home.src.helper import clean_string, DurationConverter
-
-
-class YoutubeChannel:
-    """ represents a single youtube channel """
-
-    CONFIG = AppConfig().config
-    ES_URL = CONFIG['application']['es_url']
-    CACHE_DIR = CONFIG['application']['cache_dir']
-
-    def __init__(self, channel_id):
-        self.channel_id = channel_id
-        self.json_data = None
-        self.source = None
-        self.channel_dict = self.build_channel_dict()
-
-    def build_channel_dict(self, scrape=False):
-        """ combine the dicts build from extracted json payload """
-        if scrape:
-            channel_dict = False
-        else:
-            channel_dict = self.get_es_channel()
-        if not channel_dict:
-            print('scrape data from youtube')
-            self.scrape_channel()
-            channel_dict = self.parse_channel_main()
-            channel_dict.update(self.parse_channel_meta())
-            self.source = 'scraped'
-        return channel_dict
-
-    def get_es_channel(self):
-        """ get from elastic search first if possible """
-        channel_id = self.channel_id
-        url = f'{self.ES_URL}/ta_channel/_doc/{channel_id}'
-        response = requests.get(url)
-        if response.ok:
-            channel_source = response.json()['_source']
-            self.source = 'elastic'
-            return channel_source
-        return False
-
-    def scrape_channel(self):
-        """ scrape channel page for additional infos """
-        channel_id = self.channel_id
-        url = f'https://www.youtube.com/channel/{channel_id}/about?hl=en'
-        cookies = {
-            'CONSENT': 'YES+xxxxxxxxxxxxxxxxxxxxxxxxxxx'
-        }
-        response = requests.get(url, cookies=cookies)
-        if response.ok:
-            channel_page = response.text
-        else:
-            print(f'failed to extract channel info for: {channel_id}')
-            raise ConnectionError
-        soup = BeautifulSoup(channel_page, 'html.parser')
-        # load script into json
-        all_scripts = soup.find('body').find_all('script')
-        for script in all_scripts:
-            if 'var ytInitialData = ' in str(script):
-                script_content = str(script)
-                break
-        # extract payload
-        script_content = script_content.split('var ytInitialData = ')[1]
-        json_raw = script_content.rstrip(';</script>')
-        json_data = json.loads(json_raw)
-        # add to self
-        self.json_data = json_data
-
-    def parse_channel_main(self):
-        """ extract maintab values from scraped channel json data """
-        main_tab = self.json_data['header']['c4TabbedHeaderRenderer']
-        channel_name = main_tab['title']
-        last_refresh = int(datetime.now().strftime("%s"))
-        # channel_subs
-        try:
-            sub_text_simple = main_tab['subscriberCountText']['simpleText']
-            sub_text = sub_text_simple.split(' ')[0]
-            if sub_text[-1] == 'K':
-                channel_subs = int(float(sub_text.replace('K', ''))*1000)
-            elif sub_text[-1] == 'M':
-                channel_subs = int(float(sub_text.replace('M', ''))*1000000)
-            elif int(sub_text) >= 0:
-                channel_subs = int(sub_text)
-            else:
-                message = f'{sub_text} not dealt with'
-                print(message)
-        except KeyError:
-            channel_subs = 0
-        # banner
-        try:
-            all_banners = main_tab['banner']['thumbnails']
-            banner = sorted(all_banners, key=lambda k: k['width'])[-1]['url']
-        except KeyError:
-            banner = False
-        # build and return dict
-        main_channel_dict = {
-            'channel_active': True,
-            'channel_last_refresh': last_refresh,
-            'channel_subs': channel_subs,
-            'channel_banner_url': banner,
-            'channel_name': channel_name,
-            'channel_id': self.channel_id
-        }
-        return main_channel_dict
-
-    def parse_channel_meta(self):
-        """ extract meta tab values from channel payload """
-        # meta tab
-        json_data = self.json_data
-        meta_tab = json_data['metadata']['channelMetadataRenderer']
-        description = meta_tab['description']
-        all_thumbs = meta_tab['avatar']['thumbnails']
-        thumb_url = sorted(all_thumbs, key=lambda k: k['width'])[-1]['url']
-        # stats tab
-        renderer = 'twoColumnBrowseResultsRenderer'
-        all_tabs = json_data['contents'][renderer]['tabs']
-        for tab in all_tabs:
-            if 'tabRenderer' in tab.keys():
-                if tab['tabRenderer']['title'] == 'About':
-                    about_tab = (tab['tabRenderer']['content']
-                                 ['sectionListRenderer']['contents'][0]
-                                 ['itemSectionRenderer']['contents'][0]
-                                 ['channelAboutFullMetadataRenderer'])
-                    break
-        try:
-            channel_views_text = about_tab['viewCountText']['simpleText']
-            channel_views = int(re.sub(r"\D", "", channel_views_text))
-        except KeyError:
-            channel_views = 0
-
-        meta_channel_dict = {
-            'channel_description': description,
-            'channel_thumb_url': thumb_url,
-            'channel_views': channel_views
-        }
-
-        return meta_channel_dict
-
-    def upload_to_es(self):
-        """ upload channel data to elastic search """
-        url = f'{self.ES_URL}/ta_channel/_doc/{self.channel_id}'
-        response = requests.put(url, json=self.channel_dict)
-        print(f'added {self.channel_id} to es')
-        if not response.ok:
-            print(response.text)
-
-    def clear_cache(self):
-        """ delete banner and thumb from cache if available """
-        channel_cache = os.path.join(self.CACHE_DIR, 'channels')
-        thumb = os.path.join(channel_cache, self.channel_id + '_thumb.jpg')
-        banner = os.path.join(channel_cache, self.channel_id + '_banner.jpg')
-        if os.path.exists(thumb):
-            os.remove(thumb)
-        if os.path.exists(banner):
-            os.remove(banner)
-
-    def sync_to_videos(self):
-        """ sync new channel_dict to all videos of channel """
-        headers = {'Content-type': 'application/json'}
-        channel_id = self.channel_id
-        # add ingest pipeline
-        processors = []
-        for field, value in self.channel_dict.items():
-            line = {"set": {"field": "channel." + field, "value": value}}
-            processors.append(line)
-        data = {
-            "description": channel_id,
-            "processors": processors
-        }
-        payload = json.dumps(data)
-        url = self.ES_URL + '/_ingest/pipeline/' + channel_id
-        request = requests.put(url, data=payload, headers=headers)
-        if not request.ok:
-            print(request.text)
-        # apply pipeline
-        data = {
-            "query": {"match": {"channel.channel_id": channel_id}}
-        }
-        payload = json.dumps(data)
-        url = self.ES_URL + '/ta_video/_update_by_query?pipeline=' + channel_id
-        request = requests.post(url, data=payload, headers=headers)
-        if not request.ok:
-            print(request.text)
-
-    def get_total_hits(self):
-        """ get total channels indexed """
-        headers = {'Content-type': 'application/json'}
-        data = {"query": {"match_all": {}}}
-        payload = json.dumps(data)
-        url = f'{self.ES_URL}/ta_channel/_search?filter_path=hits.total'
-        request = requests.post(url, data=payload, headers=headers)
-        if not request.ok:
-            print(request.text)
-        total_hits = json.loads(request.text)['hits']['total']['value']
-        return total_hits
-
-
-class YoutubeVideo:
-    """ represents a signle youtube video """
-
-    CONFIG = AppConfig().config
-    ES_URL = CONFIG['application']['es_url']
-    CACHE_DIR = CONFIG['application']['cache_dir']
-    VIDEOS = CONFIG['application']['videos']
-
-    def __init__(self, youtube_id):
-        self.youtube_id = youtube_id
-        self.channel_id = None
-        self.vid_dict = self.get_wrapper()
-
-    def get_wrapper(self):
-        """ wrapper to loop around youtube_dl to retry on failure """
-        print(f'get video data for {self.youtube_id}')
-        for i in range(3):
-            try:
-                vid_dict = self.get_youtubedl_vid_data()
-            except KeyError as e:
-                print(e)
-                sleep((i + 1) ** 2)
-                continue
-            else:
-                break
-
-        return vid_dict
-
-    def get_youtubedl_vid_data(self):
-        """ parse youtubedl extract info """
-        youtube_id = self.youtube_id
-        obs = {
-            'quiet': True,
-            'default_search': 'ytsearch',
-            'skip_download': True
-        }
-        try:
-            vid = youtube_dl.YoutubeDL(obs).extract_info(youtube_id)
-        except (
-                youtube_dl.utils.ExtractorError,
-                youtube_dl.utils.DownloadError
-                ):
-            print('failed to get info for ' + youtube_id)
-            return False
-        # extract
-        self.channel_id = vid['channel_id']
-        upload_date = vid['upload_date']
-        upload_date_time = datetime.strptime(upload_date, "%Y%m%d")
-        published = upload_date_time.strftime("%Y-%m-%d")
-        last_refresh = int(datetime.now().strftime("%s"))
-        # likes
-        try:
-            like_count = vid['like_count']
-        except KeyError:
-            like_count = 0
-        try:
-            dislike_count = vid['dislike_count']
-        except KeyError:
-            dislike_count = 0
-        # build dicts
-        stats = {
-            "view_count": vid['view_count'],
-            "like_count": like_count,
-            "dislike_count": dislike_count,
-            "average_rating": vid['average_rating']
-        }
-        vid_basic = {
-            "title": vid['title'],
-            "description": vid['description'],
-            "category": vid['categories'],
-            "vid_thumb_url": vid['thumbnail'],
-            "tags": vid['tags'],
-            "published": published,
-            "stats": stats,
-            "vid_last_refresh": last_refresh,
-            "date_downloaded": last_refresh,
-            "youtube_id": youtube_id,
-            "active": True,
-            "channel": False
-        }
-
-        return vid_basic
-
-    def add_player(self, missing_vid):
-        """ add player information for new videos """
-        cache_path = self.CACHE_DIR + '/download/'
-        videos = self.VIDEOS
-
-        if missing_vid:
-            # coming from scan_filesystem
-            channel_name, file_name, _ = missing_vid
-            vid_path = os.path.join(videos, channel_name, file_name)
-        else:
-            # coming from VideoDownload
-            all_cached = os.listdir(cache_path)
-            for file_cached in all_cached:
-                if self.youtube_id in file_cached:
-                    vid_path = os.path.join(cache_path, file_cached)
-                    break
-
-        duration_handler = DurationConverter()
-        duration = duration_handler.get_sec(vid_path)
-        duration_str = duration_handler.get_str(duration)
-        player = {
-            "watched": False,
-            "duration": duration,
-            "duration_str": duration_str
-        }
-        self.vid_dict['player'] = player
-
-    def build_file_path(self, channel_name):
-        """ build media_url from where file will be located """
-        clean_channel_name = clean_string(channel_name)
-        timestamp = self.vid_dict['published'].replace('-', '')
-        youtube_id = self.vid_dict['youtube_id']
-        title = self.vid_dict['title']
-        clean_title = clean_string(title)
-        filename = f'{timestamp}_{youtube_id}_{clean_title}.mp4'
-        media_url = os.path.join(clean_channel_name, filename)
-        self.vid_dict['media_url'] = media_url
-
-    def get_es_data(self):
-        """ get current data from elastic search """
-        url = self.ES_URL + '/ta_video/_doc/' + self.youtube_id
-        response = requests.get(url)
-        if not response.ok:
-            print(response.text)
-        es_vid_dict = json.loads(response.text)
-        return es_vid_dict
-
-    def upload_to_es(self):
-        """ upload channel data to elastic search """
-        url = f'{self.ES_URL}/ta_video/_doc/{self.youtube_id}'
-        response = requests.put(url, json=self.vid_dict)
-        if not response.ok:
-            print(response.text)
-
-    def delete_cache(self):
-        """ delete thumbnail from cache if exist """
-        video_cache = os.path.join(self.CACHE_DIR, 'videos')
-        thumb = os.path.join(video_cache, self.youtube_id + '.jpg')
-        if os.path.exists(thumb):
-            os.remove(thumb)
-
-    def deactivate(self):
-        """ deactivate document on extractor error """
-        youtube_id = self.youtube_id
-        headers = {'Content-type': 'application/json'}
-        url = f'{self.ES_URL}/ta_video/_update/{youtube_id}'
-        data = {"script": "ctx._source.active = false"}
-        json_str = json.dumps(data)
-        response = requests.post(url, data=json_str, headers=headers)
-        print(f'deactivated {youtube_id}')
-        if not response.ok:
-            print(response.text)
-
-
-def index_new_video(youtube_id, missing_vid=False):
-    """ combine video and channel classes for new video index """
-    vid_handler = YoutubeVideo(youtube_id)
-    if not vid_handler.vid_dict:
-        raise ValueError('failed to get metadata for ' + youtube_id)
-
-    channel_handler = YoutubeChannel(vid_handler.channel_id)
-    # add filepath to vid_dict
-    channel_name = channel_handler.channel_dict['channel_name']
-    vid_handler.build_file_path(channel_name)
-    # add channel and player to video
-    vid_handler.add_player(missing_vid)
-    vid_handler.vid_dict['channel'] = channel_handler.channel_dict
-    # add new channel to es
-    if channel_handler.source == 'scraped':
-        channel_handler.channel_dict['channel_subscribed'] = False
-        channel_handler.upload_to_es()
-    # upload video to es
-    vid_handler.upload_to_es()
-    # return vid_dict for further processing
-    return vid_handler.vid_dict

tubearchivist/home/src/index/channel.py

@@ -0,0 +1,269 @@
+"""
+functionality:
+- get metadata from youtube for a channel
+- index and update in es
+"""
+
+import json
+import os
+import re
+from datetime import datetime
+
+import requests
+import yt_dlp
+from bs4 import BeautifulSoup
+from home.src.download.thumbnails import ThumbManager
+from home.src.es.connect import ElasticWrap, IndexPaginate
+from home.src.index.generic import YouTubeItem
+from home.src.index.playlist import YoutubePlaylist
+from home.src.ta.helper import clean_string
+
+
+class ChannelScraper:
+    """custom scraper using bs4 to scrape channel about page
+    will be able to be integrated into yt-dlp
+    once #2237 and #2350 are merged upstream
+    """
+
+    def __init__(self, channel_id):
+        self.channel_id = channel_id
+        self.soup = False
+        self.yt_json = False
+        self.json_data = False
+
+    def get_json(self):
+        """main method to return channel dict"""
+        self.get_soup()
+        self._extract_yt_json()
+        self._parse_channel_main()
+        self._parse_channel_meta()
+        return self.json_data
+
+    def get_soup(self):
+        """return soup from youtube"""
+        print(f"{self.channel_id}: scrape channel data from youtube")
+        url = f"https://www.youtube.com/channel/{self.channel_id}/about?hl=en"
+        cookies = {"CONSENT": "YES+xxxxxxxxxxxxxxxxxxxxxxxxxxx"}
+        response = requests.get(url, cookies=cookies)
+        if response.ok:
+            channel_page = response.text
+        else:
+            print(f"{self.channel_id}: failed to extract channel info")
+            raise ConnectionError
+        self.soup = BeautifulSoup(channel_page, "html.parser")
+
+    def _extract_yt_json(self):
+        """parse soup and get ytInitialData json"""
+        all_scripts = self.soup.find("body").find_all("script")
+        for script in all_scripts:
+            if "var ytInitialData = " in str(script):
+                script_content = str(script)
+                break
+        # extract payload
+        script_content = script_content.split("var ytInitialData = ")[1]
+        json_raw = script_content.rstrip(";</script>")
+        self.yt_json = json.loads(json_raw)
+
+    def _parse_channel_main(self):
+        """extract maintab values from scraped channel json data"""
+        main_tab = self.yt_json["header"]["c4TabbedHeaderRenderer"]
+        # build and return dict
+        self.json_data = {
+            "channel_active": True,
+            "channel_last_refresh": int(datetime.now().strftime("%s")),
+            "channel_subs": self._get_channel_subs(main_tab),
+            "channel_name": main_tab["title"],
+            "channel_banner_url": self._get_thumbnails(main_tab, "banner"),
+            "channel_tvart_url": self._get_thumbnails(main_tab, "tvBanner"),
+            "channel_id": self.channel_id,
+            "channel_subscribed": False,
+        }
+
+    @staticmethod
+    def _get_thumbnails(main_tab, thumb_name):
+        """extract banner url from main_tab"""
+        try:
+            all_banners = main_tab[thumb_name]["thumbnails"]
+            banner = sorted(all_banners, key=lambda k: k["width"])[-1]["url"]
+        except KeyError:
+            banner = False
+
+        return banner
+
+    @staticmethod
+    def _get_channel_subs(main_tab):
+        """process main_tab to get channel subs as int"""
+        try:
+            sub_text_simple = main_tab["subscriberCountText"]["simpleText"]
+            sub_text = sub_text_simple.split(" ")[0]
+            if sub_text[-1] == "K":
+                channel_subs = int(float(sub_text.replace("K", "")) * 1000)
+            elif sub_text[-1] == "M":
+                channel_subs = int(float(sub_text.replace("M", "")) * 1000000)
+            elif int(sub_text) >= 0:
+                channel_subs = int(sub_text)
+            else:
+                message = f"{sub_text} not dealt with"
+                print(message)
+        except KeyError:
+            channel_subs = 0
+
+        return channel_subs
+
+    def _parse_channel_meta(self):
+        """extract meta tab values from channel payload"""
+        # meta tab
+        meta_tab = self.yt_json["metadata"]["channelMetadataRenderer"]
+        all_thumbs = meta_tab["avatar"]["thumbnails"]
+        thumb_url = sorted(all_thumbs, key=lambda k: k["width"])[-1]["url"]
+        # stats tab
+        renderer = "twoColumnBrowseResultsRenderer"
+        all_tabs = self.yt_json["contents"][renderer]["tabs"]
+        for tab in all_tabs:
+            if "tabRenderer" in tab.keys():
+                if tab["tabRenderer"]["title"] == "About":
+                    about_tab = tab["tabRenderer"]["content"][
+                        "sectionListRenderer"
+                    ]["contents"][0]["itemSectionRenderer"]["contents"][0][
+                        "channelAboutFullMetadataRenderer"
+                    ]
+                    break
+        try:
+            channel_views_text = about_tab["viewCountText"]["simpleText"]
+            channel_views = int(re.sub(r"\D", "", channel_views_text))
+        except KeyError:
+            channel_views = 0
+
+        self.json_data.update(
+            {
+                "channel_description": meta_tab["description"],
+                "channel_thumb_url": thumb_url,
+                "channel_views": channel_views,
+            }
+        )
+
+
+class YoutubeChannel(YouTubeItem):
+    """represents a single youtube channel"""
+
+    es_path = False
+    index_name = "ta_channel"
+    yt_base = "https://www.youtube.com/channel/"
+
+    def __init__(self, youtube_id):
+        super().__init__(youtube_id)
+        self.es_path = f"{self.index_name}/_doc/{youtube_id}"
+
+    def build_json(self, upload=False):
+        """get from es or from youtube"""
+        self.get_from_es()
+        if self.json_data:
+            return
+
+        self.get_from_youtube()
+        if upload:
+            self.upload_to_es()
+        return
+
+    def get_from_youtube(self):
+        """use bs4 to scrape channel about page"""
+        self.json_data = ChannelScraper(self.youtube_id).get_json()
+        self.get_channel_art()
+
+    def get_channel_art(self):
+        """download channel art for new channels"""
+        channel_id = self.youtube_id
+        channel_thumb = self.json_data["channel_thumb_url"]
+        channel_banner = self.json_data["channel_banner_url"]
+        ThumbManager().download_chan(
+            [(channel_id, channel_thumb, channel_banner)]
+        )
+
+    def sync_to_videos(self):
+        """sync new channel_dict to all videos of channel"""
+        # add ingest pipeline
+        processors = []
+        for field, value in self.json_data.items():
+            line = {"set": {"field": "channel." + field, "value": value}}
+            processors.append(line)
+        data = {"description": self.youtube_id, "processors": processors}
+        ingest_path = f"_ingest/pipeline/{self.youtube_id}"
+        _, _ = ElasticWrap(ingest_path).put(data)
+        # apply pipeline
+        data = {"query": {"match": {"channel.channel_id": self.youtube_id}}}
+        update_path = f"ta_video/_update_by_query?pipeline={self.youtube_id}"
+        _, _ = ElasticWrap(update_path).post(data)
+
+    def get_folder_path(self):
+        """get folder where media files get stored"""
+        channel_name = self.json_data["channel_name"]
+        folder_name = clean_string(channel_name)
+        if len(folder_name) <= 3:
+            # fall back to channel id
+            folder_name = self.json_data["channel_id"]
+        folder_path = os.path.join(self.app_conf["videos"], folder_name)
+        return folder_path
+
+    def delete_es_videos(self):
+        """delete all channel documents from elasticsearch"""
+        data = {
+            "query": {
+                "term": {"channel.channel_id": {"value": self.youtube_id}}
+            }
+        }
+        _, _ = ElasticWrap("ta_video/_delete_by_query").post(data)
+
+    def delete_playlists(self):
+        """delete all indexed playlist from es"""
+        all_playlists = self.get_indexed_playlists()
+        for playlist in all_playlists:
+            playlist_id = playlist["playlist_id"]
+            YoutubePlaylist(playlist_id).delete_metadata()
+
+    def delete_channel(self):
+        """delete channel and all videos"""
+        print(f"{self.youtube_id}: delete channel")
+        self.get_from_es()
+        folder_path = self.get_folder_path()
+        print(f"{self.youtube_id}: delete all media files")
+        try:
+            all_videos = os.listdir(folder_path)
+            for video in all_videos:
+                video_path = os.path.join(folder_path, video)
+                os.remove(video_path)
+            os.rmdir(folder_path)
+        except FileNotFoundError:
+            print(f"no videos found for {folder_path}")
+
+        print(f"{self.youtube_id}: delete indexed playlists")
+        self.delete_playlists()
+        print(f"{self.youtube_id}: delete indexed videos")
+        self.delete_es_videos()
+        self.del_in_es()
+
+    def get_all_playlists(self):
+        """get all playlists owned by this channel"""
+        url = (
+            f"https://www.youtube.com/channel/{self.youtube_id}"
+            + "/playlists?view=1&sort=dd&shelf_id=0"
+        )
+        obs = {
+            "quiet": True,
+            "skip_download": True,
+            "extract_flat": True,
+        }
+        playlists = yt_dlp.YoutubeDL(obs).extract_info(url)
+        all_entries = [(i["id"], i["title"]) for i in playlists["entries"]]
+
+        return all_entries
+
+    def get_indexed_playlists(self):
+        """get all indexed playlists from channel"""
+        data = {
+            "query": {
+                "term": {"playlist_channel_id": {"value": self.youtube_id}}
+            },
+            "sort": [{"playlist_channel.keyword": {"order": "desc"}}],
+        }
+        all_playlists = IndexPaginate("ta_playlist", data).get_results()
+        return all_playlists

tubearchivist/home/src/index/filesystem.py

@@ -0,0 +1,326 @@
+"""
+Functionality:
+- reindexing old documents
+- syncing updated values between indexes
+- scan the filesystem to delete or index
+"""
+
+import json
+import os
+import re
+import shutil
+import subprocess
+from datetime import datetime
+
+import requests
+from home.src.download.queue import PendingList
+from home.src.download.yt_dlp_handler import VideoDownloader
+from home.src.index.reindex import Reindex
+from home.src.index.video import index_new_video
+from home.src.ta.config import AppConfig
+from home.src.ta.helper import clean_string, ignore_filelist
+from home.src.ta.ta_redis import RedisArchivist
+
+
+class FilesystemScanner:
+    """handle scanning and fixing from filesystem"""
+
+    CONFIG = AppConfig().config
+    ES_URL = CONFIG["application"]["es_url"]
+    ES_AUTH = CONFIG["application"]["es_auth"]
+    VIDEOS = CONFIG["application"]["videos"]
+
+    def __init__(self):
+        self.all_downloaded = self.get_all_downloaded()
+        self.all_indexed = self.get_all_indexed()
+        self.mismatch = None
+        self.to_rename = None
+        self.to_index = None
+        self.to_delete = None
+
+    def get_all_downloaded(self):
+        """get a list of all video files downloaded"""
+        channels = os.listdir(self.VIDEOS)
+        all_channels = ignore_filelist(channels)
+        all_channels.sort()
+        all_downloaded = []
+        for channel_name in all_channels:
+            channel_path = os.path.join(self.VIDEOS, channel_name)
+            channel_files = os.listdir(channel_path)
+            channel_files_clean = ignore_filelist(channel_files)
+            all_videos = [i for i in channel_files_clean if i.endswith(".mp4")]
+            for video in all_videos:
+                youtube_id = video[9:20]
+                all_downloaded.append((channel_name, video, youtube_id))
+
+        return all_downloaded
+
+    @staticmethod
+    def get_all_indexed():
+        """get a list of all indexed videos"""
+        index_handler = PendingList()
+        all_indexed_raw = index_handler.get_all_indexed()
+        all_indexed = []
+        for video in all_indexed_raw:
+            youtube_id = video["youtube_id"]
+            media_url = video["media_url"]
+            published = video["published"]
+            title = video["title"]
+            all_indexed.append((youtube_id, media_url, published, title))
+        return all_indexed
+
+    def list_comarison(self):
+        """compare the lists to figure out what to do"""
+        self.find_unindexed()
+        self.find_missing()
+        self.find_bad_media_url()
+
+    def find_unindexed(self):
+        """find video files without a matching document indexed"""
+        all_indexed_ids = [i[0] for i in self.all_indexed]
+        to_index = []
+        for downloaded in self.all_downloaded:
+            if downloaded[2] not in all_indexed_ids:
+                to_index.append(downloaded)
+
+        self.to_index = to_index
+
+    def find_missing(self):
+        """find indexed videos without matching media file"""
+        all_downloaded_ids = [i[2] for i in self.all_downloaded]
+        to_delete = []
+        for video in self.all_indexed:
+            youtube_id = video[0]
+            if youtube_id not in all_downloaded_ids:
+                to_delete.append(video)
+
+        self.to_delete = to_delete
+
+    def find_bad_media_url(self):
+        """rename media files not matching the indexed title"""
+        to_fix = []
+        to_rename = []
+        for downloaded in self.all_downloaded:
+            channel, filename, downloaded_id = downloaded
+            # find in indexed
+            for indexed in self.all_indexed:
+                indexed_id, media_url, published, title = indexed
+                if indexed_id == downloaded_id:
+                    # found it
+                    title_c = clean_string(title)
+                    pub = published.replace("-", "")
+                    expected_filename = f"{pub}_{indexed_id}_{title_c}.mp4"
+                    new_url = os.path.join(channel, expected_filename)
+                    if expected_filename != filename:
+                        # file to rename
+                        to_rename.append(
+                            (channel, filename, expected_filename)
+                        )
+                    if media_url != new_url:
+                        # media_url to update in es
+                        to_fix.append((indexed_id, new_url))
+
+                    break
+
+        self.mismatch = to_fix
+        self.to_rename = to_rename
+
+    def rename_files(self):
+        """rename media files as identified by find_bad_media_url"""
+        for bad_filename in self.to_rename:
+            channel, filename, expected_filename = bad_filename
+            print(f"renaming [{filename}] to [{expected_filename}]")
+            old_path = os.path.join(self.VIDEOS, channel, filename)
+            new_path = os.path.join(self.VIDEOS, channel, expected_filename)
+            os.rename(old_path, new_path)
+
+    def send_mismatch_bulk(self):
+        """build bulk update"""
+        bulk_list = []
+        for video_mismatch in self.mismatch:
+            youtube_id, media_url = video_mismatch
+            print(f"{youtube_id}: fixing media url {media_url}")
+            action = {"update": {"_id": youtube_id, "_index": "ta_video"}}
+            source = {"doc": {"media_url": media_url}}
+            bulk_list.append(json.dumps(action))
+            bulk_list.append(json.dumps(source))
+        # add last newline
+        bulk_list.append("\n")
+        query_str = "\n".join(bulk_list)
+        # make the call
+        headers = {"Content-type": "application/x-ndjson"}
+        url = self.ES_URL + "/_bulk"
+        request = requests.post(
+            url, data=query_str, headers=headers, auth=self.ES_AUTH
+        )
+        if not request.ok:
+            print(request.text)
+
+    def delete_from_index(self):
+        """find indexed but deleted mediafile"""
+        for indexed in self.to_delete:
+            youtube_id = indexed[0]
+            print(f"deleting {youtube_id} from index")
+            url = self.ES_URL + "/ta_video/_doc/" + youtube_id
+            request = requests.delete(url, auth=self.ES_AUTH)
+            if not request.ok:
+                print(request.text)
+
+
+class ManualImport:
+    """import and indexing existing video files"""
+
+    CONFIG = AppConfig().config
+    CACHE_DIR = CONFIG["application"]["cache_dir"]
+    IMPORT_DIR = os.path.join(CACHE_DIR, "import")
+
+    def __init__(self):
+        self.identified = self.import_folder_parser()
+
+    def import_folder_parser(self):
+        """detect files in import folder"""
+        import_files = os.listdir(self.IMPORT_DIR)
+        to_import = ignore_filelist(import_files)
+        to_import.sort()
+        video_files = [i for i in to_import if not i.endswith(".json")]
+
+        identified = []
+
+        for file_path in video_files:
+
+            file_dict = {"video_file": file_path}
+            file_name, _ = os.path.splitext(file_path)
+
+            matching_json = [
+                i
+                for i in to_import
+                if i.startswith(file_name) and i.endswith(".json")
+            ]
+            if matching_json:
+                json_file = matching_json[0]
+                youtube_id = self.extract_id_from_json(json_file)
+                file_dict.update({"json_file": json_file})
+            else:
+                youtube_id = self.extract_id_from_filename(file_name)
+                file_dict.update({"json_file": False})
+
+            file_dict.update({"youtube_id": youtube_id})
+            identified.append(file_dict)
+
+        return identified
+
+    @staticmethod
+    def extract_id_from_filename(file_name):
+        """
+        look at the file name for the youtube id
+        expects filename ending in [<youtube_id>].<ext>
+        """
+        id_search = re.search(r"\[([a-zA-Z0-9_-]{11})\]$", file_name)
+        if id_search:
+            youtube_id = id_search.group(1)
+            return youtube_id
+
+        print("failed to extract youtube id for: " + file_name)
+        raise Exception
+
+    def extract_id_from_json(self, json_file):
+        """open json file and extract id"""
+        json_path = os.path.join(self.CACHE_DIR, "import", json_file)
+        with open(json_path, "r", encoding="utf-8") as f:
+            json_content = f.read()
+
+        youtube_id = json.loads(json_content)["id"]
+
+        return youtube_id
+
+    def process_import(self):
+        """go through identified media files"""
+
+        all_videos_added = []
+
+        for media_file in self.identified:
+            json_file = media_file["json_file"]
+            video_file = media_file["video_file"]
+            youtube_id = media_file["youtube_id"]
+
+            video_path = os.path.join(self.CACHE_DIR, "import", video_file)
+
+            self.move_to_cache(video_path, youtube_id)
+
+            # identify and archive
+            vid_dict = index_new_video(youtube_id)
+            VideoDownloader([youtube_id]).move_to_archive(vid_dict)
+            youtube_id = vid_dict["youtube_id"]
+            thumb_url = vid_dict["vid_thumb_url"]
+            all_videos_added.append((youtube_id, thumb_url))
+
+            # cleanup
+            if os.path.exists(video_path):
+                os.remove(video_path)
+            if json_file:
+                json_path = os.path.join(self.CACHE_DIR, "import", json_file)
+                os.remove(json_path)
+
+        return all_videos_added
+
+    def move_to_cache(self, video_path, youtube_id):
+        """move identified video file to cache, convert to mp4"""
+        file_name = os.path.split(video_path)[-1]
+        video_file, ext = os.path.splitext(file_name)
+
+        # make sure youtube_id is in filename
+        if youtube_id not in video_file:
+            video_file = f"{video_file}_{youtube_id}"
+
+        # move, convert if needed
+        if ext == ".mp4":
+            new_file = video_file + ext
+            dest_path = os.path.join(self.CACHE_DIR, "download", new_file)
+            shutil.move(video_path, dest_path)
+        else:
+            print(f"processing with ffmpeg: {video_file}")
+            new_file = video_file + ".mp4"
+            dest_path = os.path.join(self.CACHE_DIR, "download", new_file)
+            subprocess.run(
+                [
+                    "ffmpeg",
+                    "-i",
+                    video_path,
+                    dest_path,
+                    "-loglevel",
+                    "warning",
+                    "-stats",
+                ],
+                check=True,
+            )
+
+
+def scan_filesystem():
+    """grouped function to delete and update index"""
+    filesystem_handler = FilesystemScanner()
+    filesystem_handler.list_comarison()
+    if filesystem_handler.to_rename:
+        print("renaming files")
+        filesystem_handler.rename_files()
+    if filesystem_handler.mismatch:
+        print("fixing media urls in index")
+        filesystem_handler.send_mismatch_bulk()
+    if filesystem_handler.to_delete:
+        print("delete metadata from index")
+        filesystem_handler.delete_from_index()
+    if filesystem_handler.to_index:
+        print("index new videos")
+        for missing_vid in filesystem_handler.to_index:
+            youtube_id = missing_vid[2]
+            index_new_video(youtube_id)
+
+
+def reindex_old_documents():
+    """daily refresh of old documents"""
+    # continue if needed
+    reindex_handler = Reindex()
+    reindex_handler.check_outdated()
+    reindex_handler.reindex()
+    # set timestamp
+    now = int(datetime.now().strftime("%s"))
+    RedisArchivist().set_message("last_reindex", now, expire=False)

tubearchivist/home/src/index/generic.py

@@ -0,0 +1,149 @@
+"""
+functionality:
+- generic base class to inherit from for video, channel and playlist
+"""
+
+import math
+
+import yt_dlp
+from home.src.es.connect import ElasticWrap
+from home.src.ta.config import AppConfig
+from home.src.ta.ta_redis import RedisArchivist
+
+
+class YouTubeItem:
+    """base class for youtube"""
+
+    es_path = False
+    index_name = False
+    yt_base = False
+    yt_obs = {
+        "quiet": True,
+        "default_search": "ytsearch",
+        "skip_download": True,
+        "check_formats": "selected",
+        "noplaylist": True,
+    }
+
+    def __init__(self, youtube_id):
+        self.youtube_id = youtube_id
+        self.config = False
+        self.app_conf = False
+        self.youtube_meta = False
+        self.json_data = False
+        self._get_conf()
+
+    def _get_conf(self):
+        """read user conf"""
+        self.config = AppConfig().config
+        self.app_conf = self.config["application"]
+
+    def get_from_youtube(self):
+        """use yt-dlp to get meta data from youtube"""
+        print(f"{self.youtube_id}: get metadata from youtube")
+        try:
+            yt_item = yt_dlp.YoutubeDL(self.yt_obs)
+            response = yt_item.extract_info(self.yt_base + self.youtube_id)
+        except (
+            yt_dlp.utils.ExtractorError,
+            yt_dlp.utils.DownloadError,
+        ):
+            print(f"{self.youtube_id}: failed to get info from youtube")
+            response = False
+
+        self.youtube_meta = response
+
+    def get_from_es(self):
+        """get indexed data from elastic search"""
+        print(f"{self.youtube_id}: get metadata from es")
+        response, _ = ElasticWrap(f"{self.es_path}").get()
+        source = response.get("_source")
+        self.json_data = source
+
+    def upload_to_es(self):
+        """add json_data to elastic"""
+        _, _ = ElasticWrap(self.es_path).put(self.json_data, refresh=True)
+
+    def deactivate(self):
+        """deactivate document in es"""
+        print(f"{self.youtube_id}: deactivate document")
+        key_match = {
+            "ta_video": "active",
+            "ta_channel": "channel_active",
+            "ta_playlist": "playlist_active",
+        }
+        update_path = f"{self.index_name}/_update/{self.youtube_id}"
+        data = {
+            "script": f"ctx._source.{key_match.get(self.index_name)} = false"
+        }
+        _, _ = ElasticWrap(update_path).post(data)
+
+    def del_in_es(self):
+        """delete item from elastic search"""
+        print(f"{self.youtube_id}: delete from es")
+        _, _ = ElasticWrap(self.es_path).delete()
+
+
+class Pagination:
+    """
+    figure out the pagination based on page size and total_hits
+    """
+
+    def __init__(self, page_get, user_id, search_get=False):
+        self.user_id = user_id
+        self.page_size = self.get_page_size()
+        self.page_get = page_get
+        self.search_get = search_get
+        self.pagination = self.first_guess()
+
+    def get_page_size(self):
+        """get default or user modified page_size"""
+        key = f"{self.user_id}:page_size"
+        page_size = RedisArchivist().get_message(key)["status"]
+        if not page_size:
+            config = AppConfig().config
+            page_size = config["archive"]["page_size"]
+
+        return page_size
+
+    def first_guess(self):
+        """build first guess before api call"""
+        page_get = self.page_get
+        if page_get in [0, 1]:
+            page_from = 0
+            prev_pages = False
+        elif page_get > 1:
+            page_from = (page_get - 1) * self.page_size
+            prev_pages = [
+                i for i in range(page_get - 1, page_get - 6, -1) if i > 1
+            ]
+            prev_pages.reverse()
+        pagination = {
+            "page_size": self.page_size,
+            "page_from": page_from,
+            "prev_pages": prev_pages,
+            "current_page": page_get,
+            "max_hits": False,
+        }
+        if self.search_get:
+            pagination.update({"search_get": self.search_get})
+        return pagination
+
+    def validate(self, total_hits):
+        """validate pagination with total_hits after making api call"""
+        page_get = self.page_get
+        max_pages = math.ceil(total_hits / self.page_size)
+        if total_hits > 10000:
+            # es returns maximal 10000 results
+            self.pagination["max_hits"] = True
+            max_pages = max_pages - 1
+
+        if page_get < max_pages and max_pages > 1:
+            self.pagination["last_page"] = max_pages
+        else:
+            self.pagination["last_page"] = False
+        next_pages = [
+            i for i in range(page_get + 1, page_get + 6) if 1 < i < max_pages
+        ]
+
+        self.pagination["next_pages"] = next_pages

tubearchivist/home/src/index/playlist.py

@@ -0,0 +1,208 @@
+"""
+functionality:
+- get metadata from youtube for a playlist
+- index and update in es
+"""
+
+import json
+from datetime import datetime
+
+from home.src.download.thumbnails import ThumbManager
+from home.src.es.connect import ElasticWrap
+from home.src.index.generic import YouTubeItem
+from home.src.index.video import YoutubeVideo
+
+
+class YoutubePlaylist(YouTubeItem):
+    """represents a single youtube playlist"""
+
+    es_path = False
+    index_name = "ta_playlist"
+    yt_obs = {
+        "default_search": "ytsearch",
+        "quiet": True,
+        "skip_download": True,
+        "extract_flat": True,
+    }
+    yt_base = "https://www.youtube.com/playlist?list="
+
+    def __init__(self, youtube_id):
+        super().__init__(youtube_id)
+        self.es_path = f"{self.index_name}/_doc/{youtube_id}"
+        self.all_members = False
+        self.nav = False
+        self.all_youtube_ids = []
+
+    def build_json(self, scrape=False):
+        """collection to create json_data"""
+        self.get_from_es()
+        if self.json_data:
+            subscribed = self.json_data.get("playlist_subscribed")
+        else:
+            subscribed = False
+
+        if scrape or not self.json_data:
+            self.get_from_youtube()
+            self.process_youtube_meta()
+            self.get_entries()
+            self.json_data["playlist_entries"] = self.all_members
+            self.get_playlist_art()
+            self.json_data["playlist_subscribed"] = subscribed
+
+    def process_youtube_meta(self):
+        """extract relevant fields from youtube"""
+        self.json_data = {
+            "playlist_id": self.youtube_id,
+            "playlist_active": True,
+            "playlist_name": self.youtube_meta["title"],
+            "playlist_channel": self.youtube_meta["channel"],
+            "playlist_channel_id": self.youtube_meta["channel_id"],
+            "playlist_thumbnail": self.youtube_meta["thumbnails"][-1]["url"],
+            "playlist_description": self.youtube_meta["description"] or False,
+            "playlist_last_refresh": int(datetime.now().strftime("%s")),
+        }
+
+    def get_entries(self, playlistend=False):
+        """get all videos in playlist"""
+        if playlistend:
+            # implement playlist end
+            print(playlistend)
+        all_members = []
+        for idx, entry in enumerate(self.youtube_meta["entries"]):
+            if self.all_youtube_ids:
+                downloaded = entry["id"] in self.all_youtube_ids
+            else:
+                downloaded = False
+            if not entry["uploader"]:
+                continue
+            to_append = {
+                "youtube_id": entry["id"],
+                "title": entry["title"],
+                "uploader": entry["uploader"],
+                "idx": idx,
+                "downloaded": downloaded,
+            }
+            all_members.append(to_append)
+
+        self.all_members = all_members
+
+    @staticmethod
+    def get_playlist_art():
+        """download artwork of playlist"""
+        thumbnails = ThumbManager()
+        missing_playlists = thumbnails.get_missing_playlists()
+        thumbnails.download_playlist(missing_playlists)
+
+    def add_vids_to_playlist(self):
+        """sync the playlist id to videos"""
+        script = (
+            'if (!ctx._source.containsKey("playlist")) '
+            + "{ctx._source.playlist = [params.playlist]} "
+            + "else if (!ctx._source.playlist.contains(params.playlist)) "
+            + "{ctx._source.playlist.add(params.playlist)} "
+            + "else {ctx.op = 'none'}"
+        )
+
+        bulk_list = []
+        for entry in self.json_data["playlist_entries"]:
+            video_id = entry["youtube_id"]
+            action = {"update": {"_id": video_id, "_index": "ta_video"}}
+            source = {
+                "script": {
+                    "source": script,
+                    "lang": "painless",
+                    "params": {"playlist": self.youtube_id},
+                }
+            }
+            bulk_list.append(json.dumps(action))
+            bulk_list.append(json.dumps(source))
+
+        # add last newline
+        bulk_list.append("\n")
+        query_str = "\n".join(bulk_list)
+
+        ElasticWrap("_bulk").post(query_str, ndjson=True)
+
+    def update_playlist(self):
+        """update metadata for playlist with data from YouTube"""
+        self.get_from_es()
+        subscribed = self.json_data["playlist_subscribed"]
+        self.get_from_youtube()
+        if not self.json_data:
+            # return false to deactivate
+            return False
+
+        self.json_data["playlist_subscribed"] = subscribed
+        self.upload_to_es()
+        return True
+
+    def build_nav(self, youtube_id):
+        """find next and previous in playlist of a given youtube_id"""
+        all_entries_available = self.json_data["playlist_entries"]
+        all_entries = [i for i in all_entries_available if i["downloaded"]]
+        current = [i for i in all_entries if i["youtube_id"] == youtube_id]
+        # stop if not found or playlist of 1
+        if not current or not len(all_entries) > 1:
+            return
+
+        current_idx = all_entries.index(current[0])
+        if current_idx == 0:
+            previous_item = False
+        else:
+            previous_item = all_entries[current_idx - 1]
+            prev_thumb = ThumbManager().vid_thumb_path(
+                previous_item["youtube_id"]
+            )
+            previous_item["vid_thumb"] = prev_thumb
+
+        if current_idx == len(all_entries) - 1:
+            next_item = False
+        else:
+            next_item = all_entries[current_idx + 1]
+            next_thumb = ThumbManager().vid_thumb_path(next_item["youtube_id"])
+            next_item["vid_thumb"] = next_thumb
+
+        self.nav = {
+            "playlist_meta": {
+                "current_idx": current[0]["idx"],
+                "playlist_id": self.youtube_id,
+                "playlist_name": self.json_data["playlist_name"],
+                "playlist_channel": self.json_data["playlist_channel"],
+            },
+            "playlist_previous": previous_item,
+            "playlist_next": next_item,
+        }
+        return
+
+    def delete_metadata(self):
+        """delete metadata for playlist"""
+        script = (
+            "ctx._source.playlist.removeAll("
+            + "Collections.singleton(params.playlist)) "
+        )
+        data = {
+            "query": {
+                "term": {"playlist.keyword": {"value": self.youtube_id}}
+            },
+            "script": {
+                "source": script,
+                "lang": "painless",
+                "params": {"playlist": self.youtube_id},
+            },
+        }
+        _, _ = ElasticWrap("ta_video/_update_by_query").post(data)
+        self.del_in_es()
+
+    def delete_videos_playlist(self):
+        """delete playlist with all videos"""
+        print(f"{self.youtube_id}: delete playlist")
+        self.get_from_es()
+        all_youtube_id = [
+            i["youtube_id"]
+            for i in self.json_data["playlist_entries"]
+            if i["downloaded"]
+        ]
+        for youtube_id in all_youtube_id:
+            YoutubeVideo(youtube_id).delete_media_file()
+
+        self.delete_metadata()

tubearchivist/home/src/index/reindex.py

@@ -0,0 +1,274 @@
+"""
+functionality:
+- periodically refresh documents
+- index and update in es
+"""
+
+import json
+from datetime import datetime
+from math import ceil
+from time import sleep
+
+import requests
+from home.src.download.queue import PendingList
+from home.src.download.subscriptions import ChannelSubscription
+from home.src.download.thumbnails import ThumbManager
+from home.src.index.channel import YoutubeChannel
+from home.src.index.playlist import YoutubePlaylist
+from home.src.index.video import YoutubeVideo
+from home.src.ta.config import AppConfig
+from home.src.ta.helper import get_total_hits
+
+
+class Reindex:
+    """check for outdated documents and refresh data from youtube"""
+
+    def __init__(self):
+        # config
+        config = AppConfig().config
+        self.sleep_interval = config["downloads"]["sleep_interval"]
+        self.es_url = config["application"]["es_url"]
+        self.es_auth = config["application"]["es_auth"]
+        self.refresh_interval = config["scheduler"]["check_reindex_days"]
+        self.integrate_ryd = config["downloads"]["integrate_ryd"]
+        # scan
+        self.all_youtube_ids = False
+        self.all_channel_ids = False
+        self.all_playlist_ids = False
+
+    def get_daily(self):
+        """get daily refresh values"""
+        total_videos = get_total_hits(
+            "ta_video", self.es_url, self.es_auth, "active"
+        )
+        video_daily = ceil(total_videos / self.refresh_interval * 1.2)
+        total_channels = get_total_hits(
+            "ta_channel", self.es_url, self.es_auth, "channel_active"
+        )
+        channel_daily = ceil(total_channels / self.refresh_interval * 1.2)
+        total_playlists = get_total_hits(
+            "ta_playlist", self.es_url, self.es_auth, "playlist_active"
+        )
+        playlist_daily = ceil(total_playlists / self.refresh_interval * 1.2)
+        return (video_daily, channel_daily, playlist_daily)
+
+    def get_outdated_vids(self, size):
+        """get daily videos to refresh"""
+        headers = {"Content-type": "application/json"}
+        now = int(datetime.now().strftime("%s"))
+        now_lte = now - self.refresh_interval * 24 * 60 * 60
+        data = {
+            "size": size,
+            "query": {
+                "bool": {
+                    "must": [
+                        {"match": {"active": True}},
+                        {"range": {"vid_last_refresh": {"lte": now_lte}}},
+                    ]
+                }
+            },
+            "sort": [{"vid_last_refresh": {"order": "asc"}}],
+            "_source": False,
+        }
+        query_str = json.dumps(data)
+        url = self.es_url + "/ta_video/_search"
+        response = requests.get(
+            url, data=query_str, headers=headers, auth=self.es_auth
+        )
+        if not response.ok:
+            print(response.text)
+        response_dict = json.loads(response.text)
+        all_youtube_ids = [i["_id"] for i in response_dict["hits"]["hits"]]
+        return all_youtube_ids
+
+    def get_unrated_vids(self):
+        """get all videos without rating if ryd integration is enabled"""
+        headers = {"Content-type": "application/json"}
+        data = {
+            "size": 200,
+            "query": {
+                "bool": {
+                    "must_not": [{"exists": {"field": "stats.average_rating"}}]
+                }
+            },
+        }
+        query_str = json.dumps(data)
+        url = self.es_url + "/ta_video/_search"
+        response = requests.get(
+            url, data=query_str, headers=headers, auth=self.es_auth
+        )
+        if not response.ok:
+            print(response.text)
+        response_dict = json.loads(response.text)
+        missing_rating = [i["_id"] for i in response_dict["hits"]["hits"]]
+        self.all_youtube_ids = self.all_youtube_ids + missing_rating
+
+    def get_outdated_channels(self, size):
+        """get daily channels to refresh"""
+        headers = {"Content-type": "application/json"}
+        now = int(datetime.now().strftime("%s"))
+        now_lte = now - self.refresh_interval * 24 * 60 * 60
+        data = {
+            "size": size,
+            "query": {
+                "bool": {
+                    "must": [
+                        {"match": {"channel_active": True}},
+                        {"range": {"channel_last_refresh": {"lte": now_lte}}},
+                    ]
+                }
+            },
+            "sort": [{"channel_last_refresh": {"order": "asc"}}],
+            "_source": False,
+        }
+        query_str = json.dumps(data)
+        url = self.es_url + "/ta_channel/_search"
+        response = requests.get(
+            url, data=query_str, headers=headers, auth=self.es_auth
+        )
+        if not response.ok:
+            print(response.text)
+        response_dict = json.loads(response.text)
+        all_channel_ids = [i["_id"] for i in response_dict["hits"]["hits"]]
+        return all_channel_ids
+
+    def get_outdated_playlists(self, size):
+        """get daily outdated playlists to refresh"""
+        headers = {"Content-type": "application/json"}
+        now = int(datetime.now().strftime("%s"))
+        now_lte = now - self.refresh_interval * 24 * 60 * 60
+        data = {
+            "size": size,
+            "query": {
+                "bool": {
+                    "must": [
+                        {"match": {"playlist_active": True}},
+                        {"range": {"playlist_last_refresh": {"lte": now_lte}}},
+                    ]
+                }
+            },
+            "sort": [{"playlist_last_refresh": {"order": "asc"}}],
+            "_source": False,
+        }
+        query_str = json.dumps(data)
+        url = self.es_url + "/ta_playlist/_search"
+        response = requests.get(
+            url, data=query_str, headers=headers, auth=self.es_auth
+        )
+        if not response.ok:
+            print(response.text)
+        response_dict = json.loads(response.text)
+        all_playlist_ids = [i["_id"] for i in response_dict["hits"]["hits"]]
+        return all_playlist_ids
+
+    def check_outdated(self):
+        """add missing vids and channels"""
+        video_daily, channel_daily, playlist_daily = self.get_daily()
+        self.all_youtube_ids = self.get_outdated_vids(video_daily)
+        self.all_channel_ids = self.get_outdated_channels(channel_daily)
+        self.all_playlist_ids = self.get_outdated_playlists(playlist_daily)
+        if self.integrate_ryd:
+            self.get_unrated_vids()
+
+    def rescrape_all_channels(self):
+        """sync new data from channel to all matching videos"""
+        sleep_interval = self.sleep_interval
+        channel_sub_handler = ChannelSubscription()
+        all_channels = channel_sub_handler.get_channels(subscribed_only=False)
+        all_channel_ids = [i["channel_id"] for i in all_channels]
+
+        for channel_id in all_channel_ids:
+            channel = YoutubeChannel(channel_id)
+            subscribed = channel.json_data["channel_subscribed"]
+            channel.get_from_youtube()
+            channel.json_data["channel_subscribed"] = subscribed
+            channel.upload_to_es()
+            channel.sync_to_videos()
+
+            if sleep_interval:
+                sleep(sleep_interval)
+
+    @staticmethod
+    def reindex_single_video(youtube_id):
+        """refresh data for single video"""
+        video = YoutubeVideo(youtube_id)
+
+        # read current state
+        video.get_from_es()
+        player = video.json_data["player"]
+        date_downloaded = video.json_data["date_downloaded"]
+        channel_dict = video.json_data["channel"]
+        playlist = video.json_data.get("playlist")
+
+        # get new
+        video.build_json()
+        if not video.youtube_meta:
+            video.deactivate()
+            return
+
+        video.delete_subtitles()
+        # add back
+        video.json_data["player"] = player
+        video.json_data["date_downloaded"] = date_downloaded
+        video.json_data["channel"] = channel_dict
+        if playlist:
+            video.json_data["playlist"] = playlist
+
+        video.upload_to_es()
+
+        thumb_handler = ThumbManager()
+        thumb_handler.delete_vid_thumb(youtube_id)
+        to_download = (youtube_id, video.json_data["vid_thumb_url"])
+        thumb_handler.download_vid([to_download], notify=False)
+        return
+
+    @staticmethod
+    def reindex_single_channel(channel_id):
+        """refresh channel data and sync to videos"""
+        channel = YoutubeChannel(channel_id)
+        channel.get_from_es()
+        subscribed = channel.json_data["channel_subscribed"]
+        channel.get_from_youtube()
+        channel.json_data["channel_subscribed"] = subscribed
+        channel.upload_to_es()
+        channel.sync_to_videos()
+
+    @staticmethod
+    def reindex_single_playlist(playlist_id, all_indexed_ids):
+        """refresh playlist data"""
+        playlist = YoutubePlaylist(playlist_id)
+        playlist.get_from_es()
+        subscribed = playlist.json_data["playlist_subscribed"]
+        playlist.all_youtube_ids = all_indexed_ids
+        playlist.build_json(scrape=True)
+        if not playlist.json_data:
+            playlist.deactivate()
+            return
+
+        playlist.json_data["playlist_subscribed"] = subscribed
+        playlist.upload_to_es()
+        return
+
+    def reindex(self):
+        """reindex what's needed"""
+        # videos
+        print(f"reindexing {len(self.all_youtube_ids)} videos")
+        for youtube_id in self.all_youtube_ids:
+            self.reindex_single_video(youtube_id)
+            if self.sleep_interval:
+                sleep(self.sleep_interval)
+        # channels
+        print(f"reindexing {len(self.all_channel_ids)} channels")
+        for channel_id in self.all_channel_ids:
+            self.reindex_single_channel(channel_id)
+            if self.sleep_interval:
+                sleep(self.sleep_interval)
+        # playlist
+        print(f"reindexing {len(self.all_playlist_ids)} playlists")
+        if self.all_playlist_ids:
+            all_indexed = PendingList().get_all_indexed()
+            all_indexed_ids = [i["youtube_id"] for i in all_indexed]
+            for playlist_id in self.all_playlist_ids:
+                self.reindex_single_playlist(playlist_id, all_indexed_ids)
+                if self.sleep_interval:
+                    sleep(self.sleep_interval)

tubearchivist/home/src/index/video.py

@@ -0,0 +1,472 @@
+"""
+functionality:
+- get metadata from youtube for a video
+- index and update in es
+"""
+
+import json
+import os
+import re
+from datetime import datetime
+
+import requests
+from home.src.es.connect import ElasticWrap
+from home.src.index import channel as ta_channel
+from home.src.index.generic import YouTubeItem
+from home.src.ta.helper import DurationConverter, clean_string
+from ryd_client import ryd_client
+
+
+class YoutubeSubtitle:
+    """handle video subtitle functionality"""
+
+    def __init__(self, video):
+        self.video = video
+        self.languages = False
+
+    def sub_conf_parse(self):
+        """add additional conf values to self"""
+        languages_raw = self.video.config["downloads"]["subtitle"]
+        if languages_raw:
+            self.languages = [i.strip() for i in languages_raw.split(",")]
+
+    def get_subtitles(self):
+        """check what to do"""
+        self.sub_conf_parse()
+        if not self.languages:
+            # no subtitles
+            return False
+
+        relevant_subtitles = []
+        for lang in self.languages:
+            user_sub = self.get_user_subtitles(lang)
+            if user_sub:
+                relevant_subtitles.append(user_sub)
+                continue
+
+            if self.video.config["downloads"]["subtitle_source"] == "auto":
+                auto_cap = self.get_auto_caption(lang)
+                if auto_cap:
+                    relevant_subtitles.append(auto_cap)
+
+        return relevant_subtitles
+
+    def get_auto_caption(self, lang):
+        """get auto_caption subtitles"""
+        print(f"{self.video.youtube_id}-{lang}: get auto generated subtitles")
+        all_subtitles = self.video.youtube_meta.get("automatic_captions")
+
+        if not all_subtitles:
+            return False
+
+        video_media_url = self.video.json_data["media_url"]
+        media_url = video_media_url.replace(".mp4", f"-{lang}.vtt")
+        all_formats = all_subtitles.get(lang)
+        if not all_formats:
+            return False
+
+        subtitle = [i for i in all_formats if i["ext"] == "vtt"][0]
+        subtitle.update(
+            {"lang": lang, "source": "auto", "media_url": media_url}
+        )
+
+        return subtitle
+
+    def _normalize_lang(self):
+        """normalize country specific language keys"""
+        all_subtitles = self.video.youtube_meta.get("subtitles")
+        if not all_subtitles:
+            return False
+
+        all_keys = list(all_subtitles.keys())
+        for key in all_keys:
+            lang = key.split("-")[0]
+            old = all_subtitles.pop(key)
+            if lang == "live_chat":
+                continue
+            all_subtitles[lang] = old
+
+        return all_subtitles
+
+    def get_user_subtitles(self, lang):
+        """get subtitles uploaded from channel owner"""
+        print(f"{self.video.youtube_id}-{lang}: get user uploaded subtitles")
+        all_subtitles = self._normalize_lang()
+        if not all_subtitles:
+            return False
+
+        video_media_url = self.video.json_data["media_url"]
+        media_url = video_media_url.replace(".mp4", f"-{lang}.vtt")
+        all_formats = all_subtitles.get(lang)
+        if not all_formats:
+            # no user subtitles found
+            return False
+
+        subtitle = [i for i in all_formats if i["ext"] == "vtt"][0]
+        subtitle.update(
+            {"lang": lang, "source": "user", "media_url": media_url}
+        )
+
+        return subtitle
+
+    def download_subtitles(self, relevant_subtitles):
+        """download subtitle files to archive"""
+        videos_base = self.video.config["application"]["videos"]
+        for subtitle in relevant_subtitles:
+            dest_path = os.path.join(videos_base, subtitle["media_url"])
+            source = subtitle["source"]
+            response = requests.get(subtitle["url"])
+            if not response.ok:
+                print(f"{self.video.youtube_id}: failed to download subtitle")
+                continue
+
+            parser = SubtitleParser(response.text, subtitle.get("lang"))
+            parser.process()
+            subtitle_str = parser.get_subtitle_str()
+            self._write_subtitle_file(dest_path, subtitle_str)
+            if self.video.config["downloads"]["subtitle_index"]:
+                query_str = parser.create_bulk_import(self.video, source)
+                self._index_subtitle(query_str)
+
+    @staticmethod
+    def _write_subtitle_file(dest_path, subtitle_str):
+        """write subtitle file to disk"""
+        # create folder here for first video of channel
+        os.makedirs(os.path.split(dest_path)[0], exist_ok=True)
+        with open(dest_path, "w", encoding="utf-8") as subfile:
+            subfile.write(subtitle_str)
+
+    @staticmethod
+    def _index_subtitle(query_str):
+        """send subtitle to es for indexing"""
+        _, _ = ElasticWrap("_bulk").post(data=query_str, ndjson=True)
+
+
+class SubtitleParser:
+    """parse subtitle str from youtube"""
+
+    time_reg = r"^([0-9]{2}:?){3}\.[0-9]{3} --> ([0-9]{2}:?){3}\.[0-9]{3}"
+    stamp_reg = r"<([0-9]{2}:?){3}\.[0-9]{3}>"
+    tag_reg = r"</?c>"
+
+    def __init__(self, subtitle_str, lang):
+        self.subtitle_str = subtitle_str
+        self.lang = lang
+        self.header = False
+        self.parsed_cue_list = False
+        self.all_text_lines = False
+        self.matched = False
+
+    def process(self):
+        """collection to process subtitle string"""
+        self._parse_cues()
+        self._match_text_lines()
+        self._add_id()
+        self._timestamp_check()
+
+    def _parse_cues(self):
+        """split into cues"""
+        all_cues = self.subtitle_str.replace("\n \n", "\n").split("\n\n")
+        self.header = all_cues[0]
+        self.all_text_lines = []
+        self.parsed_cue_list = [self._cue_cleaner(i) for i in all_cues[1:]]
+
+    def _cue_cleaner(self, cue):
+        """parse single cue"""
+        all_lines = cue.split("\n")
+        cue_dict = {"lines": []}
+
+        for line in all_lines:
+            if re.match(self.time_reg, line):
+                clean = re.search(self.time_reg, line).group()
+                start, end = clean.split(" --> ")
+                cue_dict.update({"start": start, "end": end})
+            else:
+                clean = re.sub(self.stamp_reg, "", line)
+                clean = re.sub(self.tag_reg, "", clean)
+                cue_dict["lines"].append(clean)
+                if clean.strip() and clean not in self.all_text_lines[-4:]:
+                    # remove immediate duplicates
+                    self.all_text_lines.append(clean)
+
+        return cue_dict
+
+    def _match_text_lines(self):
+        """match unique text lines with timestamps"""
+
+        self.matched = []
+
+        while self.all_text_lines:
+            check = self.all_text_lines[0]
+            matches = [i for i in self.parsed_cue_list if check in i["lines"]]
+            new_cue = matches[-1]
+            new_cue["start"] = matches[0]["start"]
+
+            for line in new_cue["lines"]:
+                try:
+                    self.all_text_lines.remove(line)
+                except ValueError:
+                    continue
+
+            self.matched.append(new_cue)
+
+    def _timestamp_check(self):
+        """check if end timestamp is bigger than start timestamp"""
+        for idx, cue in enumerate(self.matched):
+            # this
+            end = int(re.sub("[^0-9]", "", cue.get("end")))
+            # next
+            try:
+                next_cue = self.matched[idx + 1]
+            except IndexError:
+                continue
+
+            start_next = int(re.sub("[^0-9]", "", next_cue.get("start")))
+            if end > start_next:
+                self.matched[idx]["end"] = next_cue.get("start")
+
+    def _add_id(self):
+        """add id to matched cues"""
+        for idx, _ in enumerate(self.matched):
+            self.matched[idx]["id"] = idx + 1
+
+    def get_subtitle_str(self):
+        """stitch cues and return processed new string"""
+        new_subtitle_str = self.header + "\n\n"
+
+        for cue in self.matched:
+            timestamp = f"{cue.get('start')} --> {cue.get('end')}"
+            lines = "\n".join(cue.get("lines"))
+            cue_text = f"{cue.get('id')}\n{timestamp}\n{lines}\n\n"
+            new_subtitle_str = new_subtitle_str + cue_text
+
+        return new_subtitle_str
+
+    def create_bulk_import(self, video, source):
+        """process matched for es import"""
+        bulk_list = []
+        channel = video.json_data.get("channel")
+
+        document = {
+            "youtube_id": video.youtube_id,
+            "title": video.json_data.get("title"),
+            "subtitle_channel": channel.get("channel_name"),
+            "subtitle_channel_id": channel.get("channel_id"),
+            "subtitle_last_refresh": int(datetime.now().strftime("%s")),
+            "subtitle_lang": self.lang,
+            "subtitle_source": source,
+        }
+
+        for match in self.matched:
+            match_id = match.get("id")
+            document_id = f"{video.youtube_id}-{self.lang}-{match_id}"
+            action = {"index": {"_index": "ta_subtitle", "_id": document_id}}
+            document.update(
+                {
+                    "subtitle_fragment_id": document_id,
+                    "subtitle_start": match.get("start"),
+                    "subtitle_end": match.get("end"),
+                    "subtitle_index": match_id,
+                    "subtitle_line": " ".join(match.get("lines")),
+                }
+            )
+            bulk_list.append(json.dumps(action))
+            bulk_list.append(json.dumps(document))
+
+        bulk_list.append("\n")
+        query_str = "\n".join(bulk_list)
+
+        return query_str
+
+
+class YoutubeVideo(YouTubeItem, YoutubeSubtitle):
+    """represents a single youtube video"""
+
+    es_path = False
+    index_name = "ta_video"
+    yt_base = "https://www.youtube.com/watch?v="
+
+    def __init__(self, youtube_id):
+        super().__init__(youtube_id)
+        self.channel_id = False
+        self.es_path = f"{self.index_name}/_doc/{youtube_id}"
+
+    def build_json(self):
+        """build json dict of video"""
+        self.get_from_youtube()
+        if not self.youtube_meta:
+            return
+
+        self._process_youtube_meta()
+        self._add_channel()
+        self._add_stats()
+        self.add_file_path()
+        self.add_player()
+        self._check_subtitles()
+        if self.config["downloads"]["integrate_ryd"]:
+            self._get_ryd_stats()
+
+        return
+
+    def _process_youtube_meta(self):
+        """extract relevant fields from youtube"""
+        # extract
+        self.channel_id = self.youtube_meta["channel_id"]
+        upload_date = self.youtube_meta["upload_date"]
+        upload_date_time = datetime.strptime(upload_date, "%Y%m%d")
+        published = upload_date_time.strftime("%Y-%m-%d")
+        last_refresh = int(datetime.now().strftime("%s"))
+        # build json_data basics
+        self.json_data = {
+            "title": self.youtube_meta["title"],
+            "description": self.youtube_meta["description"],
+            "category": self.youtube_meta["categories"],
+            "vid_thumb_url": self.youtube_meta["thumbnail"],
+            "tags": self.youtube_meta["tags"],
+            "published": published,
+            "vid_last_refresh": last_refresh,
+            "date_downloaded": last_refresh,
+            "youtube_id": self.youtube_id,
+            "active": True,
+        }
+
+    def _add_channel(self):
+        """add channel dict to video json_data"""
+        channel = ta_channel.YoutubeChannel(self.channel_id)
+        channel.build_json(upload=True)
+        self.json_data.update({"channel": channel.json_data})
+
+    def _add_stats(self):
+        """add stats dicst to json_data"""
+        # likes
+        like_count = self.youtube_meta.get("like_count", 0)
+        dislike_count = self.youtube_meta.get("dislike_count", 0)
+        self.json_data.update(
+            {
+                "stats": {
+                    "view_count": self.youtube_meta["view_count"],
+                    "like_count": like_count,
+                    "dislike_count": dislike_count,
+                    "average_rating": self.youtube_meta["average_rating"],
+                }
+            }
+        )
+
+    def build_dl_cache_path(self):
+        """find video path in dl cache"""
+        cache_dir = self.app_conf["cache_dir"]
+        cache_path = f"{cache_dir}/download/"
+        all_cached = os.listdir(cache_path)
+        for file_cached in all_cached:
+            if self.youtube_id in file_cached:
+                vid_path = os.path.join(cache_path, file_cached)
+                return vid_path
+
+        raise FileNotFoundError
+
+    def add_player(self):
+        """add player information for new videos"""
+        try:
+            # when indexing from download task
+            vid_path = self.build_dl_cache_path()
+        except FileNotFoundError as err:
+            # when reindexing needs to handle title rename
+            channel = os.path.split(self.json_data["media_url"])[0]
+            channel_dir = os.path.join(self.app_conf["videos"], channel)
+            all_files = os.listdir(channel_dir)
+            for file in all_files:
+                if self.youtube_id in file:
+                    vid_path = os.path.join(channel_dir, file)
+                    break
+            else:
+                raise FileNotFoundError("could not find video file") from err
+
+        duration_handler = DurationConverter()
+        duration = duration_handler.get_sec(vid_path)
+        duration_str = duration_handler.get_str(duration)
+        self.json_data.update(
+            {
+                "player": {
+                    "watched": False,
+                    "duration": duration,
+                    "duration_str": duration_str,
+                }
+            }
+        )
+
+    def add_file_path(self):
+        """build media_url for where file will be located"""
+        channel_name = self.json_data["channel"]["channel_name"]
+        clean_channel_name = clean_string(channel_name)
+        if len(clean_channel_name) <= 3:
+            # fall back to channel id
+            clean_channel_name = self.json_data["channel"]["channel_id"]
+
+        timestamp = self.json_data["published"].replace("-", "")
+        youtube_id = self.json_data["youtube_id"]
+        title = self.json_data["title"]
+        clean_title = clean_string(title)
+        filename = f"{timestamp}_{youtube_id}_{clean_title}.mp4"
+        media_url = os.path.join(clean_channel_name, filename)
+        self.json_data["media_url"] = media_url
+
+    def delete_media_file(self):
+        """delete video file, meta data"""
+        self.get_from_es()
+        video_base = self.app_conf["videos"]
+        to_del = [self.json_data.get("media_url")]
+
+        all_subtitles = self.json_data.get("subtitles")
+        if all_subtitles:
+            to_del = to_del + [i.get("media_url") for i in all_subtitles]
+
+        for media_url in to_del:
+            file_path = os.path.join(video_base, media_url)
+            os.remove(file_path)
+
+        self.del_in_es()
+        self.delete_subtitles()
+
+    def _get_ryd_stats(self):
+        """get optional stats from returnyoutubedislikeapi.com"""
+        try:
+            print(f"{self.youtube_id}: get ryd stats")
+            result = ryd_client.get(self.youtube_id)
+        except requests.exceptions.ConnectionError:
+            print(f"{self.youtube_id}: failed to query ryd api, skipping")
+            return False
+
+        if result["status"] == 404:
+            return False
+
+        dislikes = {
+            "dislike_count": result["dislikes"],
+            "average_rating": result["rating"],
+        }
+        self.json_data["stats"].update(dislikes)
+
+        return True
+
+    def _check_subtitles(self):
+        """optionally add subtitles"""
+        handler = YoutubeSubtitle(self)
+        subtitles = handler.get_subtitles()
+        if subtitles:
+            self.json_data["subtitles"] = subtitles
+            handler.download_subtitles(relevant_subtitles=subtitles)
+
+    def delete_subtitles(self):
+        """delete indexed subtitles"""
+        data = {"query": {"term": {"youtube_id": {"value": self.youtube_id}}}}
+        _, _ = ElasticWrap("ta_subtitle/_delete_by_query").post(data=data)
+
+
+def index_new_video(youtube_id):
+    """combined classes to create new video in index"""
+    video = YoutubeVideo(youtube_id)
+    video.build_json()
+    if not video.json_data:
+        raise ValueError("failed to get metadata for " + youtube_id)
+
+    video.upload_to_es()
+    return video.json_data

tubearchivist/home/src/index_management.py

@@ -1,561 +0,0 @@
-"""
-Functionality:
-- initial elastic search setup
-- index configuration is represented in INDEX_CONFIG
-- index mapping and settings validation
-- backup and restore
-"""
-
-import json
-import os
-import zipfile
-
-from datetime import datetime
-
-import requests
-
-from home.src.config import AppConfig
-
-
-# expected mapping and settings
-INDEX_CONFIG = [
-    {
-        'index_name': 'channel',
-        'expected_map': {
-            "channel_id": {
-                "type": "keyword",
-            },
-            "channel_name": {
-                "type": "text",
-                "fields": {
-                    "keyword": {
-                        "type": "keyword",
-                        "ignore_above": 256,
-                        "normalizer": "to_lower"
-                    },
-                    "search_as_you_type": {
-                        "type": "search_as_you_type",
-                        "doc_values": False,
-                        "max_shingle_size": 3
-                    }
-                }
-            },
-            "channel_banner_url": {
-                "type": "keyword",
-                "index": False
-            },
-            "channel_thumb_url": {
-                "type": "keyword",
-                "index": False
-            },
-            "channel_description": {
-                "type": "text"
-            },
-            "channel_last_refresh": {
-                "type": "date",
-                "format": "epoch_second"
-            }
-        },
-        'expected_set': {
-            "analysis": {
-                "normalizer": {
-                    "to_lower": {
-                        "type": "custom",
-                        "filter": ["lowercase"]
-                    }
-                }
-            },
-            "number_of_replicas": "0"
-        }
-    },
-    {
-        'index_name': 'video',
-        'expected_map': {
-            "vid_thumb_url": {
-                "type": "text",
-                "index": False
-            },
-            "date_downloaded": {
-                "type": "date"
-            },
-            "channel": {
-                "properties": {
-                    "channel_id": {
-                        "type": "keyword",
-                    },
-                    "channel_name": {
-                        "type": "text",
-                        "fields": {
-                            "keyword": {
-                                "type": "keyword",
-                                "ignore_above": 256,
-                                "normalizer": "to_lower"
-                            },
-                            "search_as_you_type": {
-                                "type": "search_as_you_type",
-                                "doc_values": False,
-                                "max_shingle_size": 3
-                            }
-                        }
-                    },
-                    "channel_banner_url": {
-                        "type": "keyword",
-                        "index": False
-                    },
-                    "channel_thumb_url": {
-                        "type": "keyword",
-                        "index": False
-                    },
-                    "channel_description": {
-                        "type": "text"
-                    },
-                    "channel_last_refresh": {
-                        "type": "date",
-                        "format": "epoch_second"
-                    }
-                }
-            },
-            "description": {
-                "type": "text"
-            },
-            "media_url": {
-                "type": "keyword",
-                "index": False
-            },
-            "title": {
-                "type": "text",
-                "fields": {
-                    "keyword": {
-                        "type": "keyword",
-                        "ignore_above": 256,
-                        "normalizer": "to_lower"
-                    },
-                    "search_as_you_type": {
-                        "type": "search_as_you_type",
-                        "doc_values": False,
-                        "max_shingle_size": 3
-                    }
-                }
-            },
-            "vid_last_refresh": {
-                "type": "date"
-            },
-            "youtube_id": {
-                "type": "keyword"
-            },
-            "published": {
-                "type": "date"
-            },
-        },
-        'expected_set': {
-            "analysis": {
-                "normalizer": {
-                    "to_lower": {
-                        "type": "custom",
-                        "filter": ["lowercase"]
-                    }
-                }
-            },
-            "number_of_replicas": "0"
-        }
-    },
-    {
-        'index_name': 'download',
-        'expected_map': {
-            "timestamp": {
-                "type": "date"
-            },
-            "channel_id": {
-                "type": "keyword"
-            },
-            "channel_name": {
-                "type": "text",
-                "fields": {
-                    "keyword": {
-                        "type": "keyword",
-                        "ignore_above": 256,
-                        "normalizer": "to_lower"
-                    }
-                }
-            },
-            "status": {
-                "type": "keyword"
-            },
-            "title": {
-                "type": "text",
-                "fields": {
-                    "keyword": {
-                        "type": "keyword",
-                        "ignore_above": 256,
-                        "normalizer": "to_lower"
-                    }
-                }
-            },
-            "vid_thumb_url": {
-                "type": "keyword"
-            },
-            "youtube_id": {
-                "type": "keyword"
-            }
-        },
-        'expected_set': {
-            "analysis": {
-                "normalizer": {
-                    "to_lower": {
-                        "type": "custom",
-                        "filter": ["lowercase"]
-                    }
-                }
-            },
-            "number_of_replicas": "0"
-        }
-    }
-]
-
-
-class ElasticIndex:
-    """
-    handle mapping and settings on elastic search for a given index
-    """
-
-    CONFIG = AppConfig().config
-    ES_URL = CONFIG['application']['es_url']
-    HEADERS = {'Content-type': 'application/json'}
-
-    def __init__(self, index_name, expected_map, expected_set):
-        self.index_name = index_name
-        self.expected_map = expected_map
-        self.expected_set = expected_set
-        self.exists, self.details = self.index_exists()
-
-    def index_exists(self):
-        """ check if index already exists and return mapping if it does """
-        index_name = self.index_name
-        url = f'{self.ES_URL}/ta_{index_name}'
-        response = requests.get(url)
-        exists = response.ok
-
-        if exists:
-            details = response.json()[f'ta_{index_name}']
-        else:
-            details = False
-
-        return exists, details
-
-    def validate(self):
-        """
-        check if all expected mappings and settings match
-        returns True when rebuild is needed
-        """
-
-        if self.expected_map:
-            rebuild = self.validate_mappings()
-            if rebuild:
-                return rebuild
-
-        if self.expected_set:
-            rebuild = self.validate_settings()
-            if rebuild:
-                return rebuild
-
-        return False
-
-    def validate_mappings(self):
-        """ check if all mappings are as expected """
-
-        expected_map = self.expected_map
-        now_map = self.details['mappings']['properties']
-
-        for key, value in expected_map.items():
-            # nested
-            if list(value.keys()) == ['properties']:
-                for key_n, value_n in value['properties'].items():
-                    if key_n not in now_map[key]['properties'].keys():
-                        print(key_n, value_n)
-                        return True
-                    if not value_n == now_map[key]['properties'][key_n]:
-                        print(key_n, value_n)
-                        return True
-
-                continue
-
-            # not nested
-            if key not in now_map.keys():
-                print(key, value)
-                return True
-            if not value == now_map[key]:
-                print(key, value)
-                return True
-
-        return False
-
-    def validate_settings(self):
-        """ check if all settings are as expected """
-
-        now_set = self.details['settings']['index']
-
-        for key, value in self.expected_set.items():
-            if key not in now_set.keys():
-                print(key, value)
-                return True
-
-            if not value == now_set[key]:
-                print(key, value)
-                return True
-
-        return False
-
-    def rebuild_index(self):
-        """ rebuild with new mapping """
-        # backup
-        self.reindex('backup')
-        # delete original
-        self.delete_index(backup=False)
-        # create new
-        self.create_blank()
-        self.reindex('restore')
-        # delete backup
-        self.delete_index()
-
-    def reindex(self, method):
-        """ create on elastic search """
-        index_name = self.index_name
-        if method == 'backup':
-            source = f'ta_{index_name}'
-            destination = f'ta_{index_name}_backup'
-        elif method == 'restore':
-            source = f'ta_{index_name}_backup'
-            destination = f'ta_{index_name}'
-
-        query = {
-            "source": {
-                "index": source
-            },
-            "dest": {
-                "index": destination
-            }
-        }
-        data = json.dumps(query)
-        url = self.ES_URL + '/_reindex?refresh=true'
-        response = requests.post(url=url, data=data, headers=self.HEADERS)
-        if not response.ok:
-            print(response.text)
-
-    def delete_index(self, backup=True):
-        """ delete index passed as argument """
-        if backup:
-            url = f'{self.ES_URL}/ta_{self.index_name}_backup'
-        else:
-            url = f'{self.ES_URL}/ta_{self.index_name}'
-        response = requests.delete(url)
-        if not response.ok:
-            print(response.text)
-
-    def create_blank(self):
-        """ apply new mapping and settings for blank new index """
-        expected_map = self.expected_map
-        expected_set = self.expected_set
-        # stich payload
-        payload = {}
-        if expected_set:
-            payload.update({"settings": expected_set})
-        if expected_map:
-            payload.update({"mappings": {"properties": expected_map}})
-        # create
-        url = f'{self.ES_URL}/ta_{self.index_name}'
-        data = json.dumps(payload)
-        response = requests.put(url=url, data=data, headers=self.HEADERS)
-        if not response.ok:
-            print(response.text)
-
-
-class ElasticBackup:
-    """ dump index to nd-json files for later bulk import """
-
-    def __init__(self, index_config):
-        self.config = AppConfig().config
-        self.index_config = index_config
-        self.timestamp = datetime.now().strftime('%Y%m%d')
-        self.backup_files = []
-
-    def get_all_documents(self, index_name):
-        """ export all documents of a single index """
-        headers = {'Content-type': 'application/json'}
-        es_url = self.config['application']['es_url']
-        # get PIT ID
-        url = f'{es_url}/ta_{index_name}/_pit?keep_alive=1m'
-        response = requests.post(url)
-        json_data = json.loads(response.text)
-        pit_id = json_data['id']
-        # build query
-        data = {
-            "query": {"match_all": {}},
-            "size": 100, "pit": {"id": pit_id, "keep_alive": "1m"},
-            "sort": [{"_id": {"order": "asc"}}]
-        }
-        query_str = json.dumps(data)
-        url = es_url + '/_search'
-        # loop until nothing left
-        all_results = []
-        while True:
-            response = requests.get(url, data=query_str, headers=headers)
-            json_data = json.loads(response.text)
-            all_hits = json_data['hits']['hits']
-            if all_hits:
-                for hit in all_hits:
-                    search_after = hit['sort']
-                    all_results.append(hit)
-                # update search_after with last hit data
-                data['search_after'] = search_after
-                query_str = json.dumps(data)
-            else:
-                break
-        # clean up PIT
-        query_str = json.dumps({"id": pit_id})
-        requests.delete(es_url + '/_pit', data=query_str, headers=headers)
-
-        return all_results
-
-    @staticmethod
-    def build_bulk(all_results):
-        """ build bulk query data from all_results """
-        bulk_list = []
-
-        for document in all_results:
-            document_id = document['_id']
-            es_index = document['_index']
-            action = {"index": {"_index": es_index, "_id": document_id}}
-            source = document['_source']
-            bulk_list.append(json.dumps(action))
-            bulk_list.append(json.dumps(source))
-
-        # add last newline
-        bulk_list.append('\n')
-        file_content = '\n'.join(bulk_list)
-
-        return file_content
-
-    def write_es_json(self, file_content, index_name):
-        """ write nd json file for es _bulk API to disk """
-        cache_dir = self.config['application']['cache_dir']
-        file_name = f'es_{index_name}-{self.timestamp}.json'
-        file_path = os.path.join(cache_dir, 'backup', file_name)
-        with open(file_path, 'w', encoding='utf-8') as f:
-            f.write(file_content)
-
-        self.backup_files.append(file_path)
-
-    def write_ta_json(self, all_results, index_name):
-        """ write generic json file to disk """
-        cache_dir = self.config['application']['cache_dir']
-        file_name = f'ta_{index_name}-{self.timestamp}.json'
-        file_path = os.path.join(cache_dir, 'backup', file_name)
-        to_write = [i['_source'] for i in all_results]
-        file_content = json.dumps(to_write)
-        with open(file_path, 'w', encoding='utf-8') as f:
-            f.write(file_content)
-
-        self.backup_files.append(file_path)
-
-    def zip_it(self):
-        """ pack it up into single zip file """
-        cache_dir = self.config['application']['cache_dir']
-        file_name = f'ta_backup-{self.timestamp}.zip'
-        backup_file = os.path.join(cache_dir, 'backup', file_name)
-
-        with zipfile.ZipFile(
-                    backup_file, 'w', compression=zipfile.ZIP_DEFLATED
-                ) as zip_f:
-            for backup_file in self.backup_files:
-                zip_f.write(backup_file)
-
-        # cleanup
-        for backup_file in self.backup_files:
-            os.remove(backup_file)
-
-    def post_bulk_restore(self, file_name):
-        """ send bulk to es """
-        cache_dir = self.config['application']['cache_dir']
-        es_url = self.config['application']['es_url']
-        headers = {'Content-type': 'application/x-ndjson'}
-        file_path = os.path.join(cache_dir, file_name)
-
-        with open(file_path, 'r', encoding='utf-8') as f:
-            query_str = f.read()
-
-        url = es_url + '/_bulk'
-        request = requests.post(url, data=query_str, headers=headers)
-        if not request.ok:
-            print(request.text)
-
-    def restore_from_file(self):
-        """ restore all available backup files """
-        cache_dir = self.config['application']['cache_dir']
-        all_available_backups = [
-            i for i in os.listdir(cache_dir) if
-            i.startswith('ta_') and i.endswith('.json')
-        ]
-        for file_name in all_available_backups:
-            self.post_bulk_restore(file_name)
-
-
-def backup_all_indexes():
-    """ backup all es indexes to disk """
-    backup_handler = ElasticBackup(INDEX_CONFIG)
-
-    for index in backup_handler.index_config:
-        index_name = index['index_name']
-        all_results = backup_handler.get_all_documents(index_name)
-        file_content = backup_handler.build_bulk(all_results)
-        backup_handler.write_es_json(file_content, index_name)
-        backup_handler.write_ta_json(all_results, index_name)
-
-    backup_handler.zip_it()
-
-
-def restore_from_backup():
-    """ restore indexes from backup file """
-    # delete
-    index_check(force_restore=True)
-    # recreate
-    backup_handler = ElasticBackup(INDEX_CONFIG)
-    backup_handler.restore_from_file()
-
-
-def index_check(force_restore=False):
-    """ check if all indexes are created and have correct mapping """
-
-    backed_up = False
-
-    for index in INDEX_CONFIG:
-        index_name = index['index_name']
-        expected_map = index['expected_map']
-        expected_set = index['expected_set']
-        handler = ElasticIndex(index_name, expected_map, expected_set)
-        # force restore
-        if force_restore:
-            handler.delete_index(backup=False)
-            handler.create_blank()
-            continue
-
-        # create new
-        if not handler.exists:
-            print(f'create new blank index with name ta_{index_name}...')
-            handler.create_blank()
-            continue
-
-        # validate index
-        rebuild = handler.validate()
-        if rebuild:
-            # make backup before rebuild
-            if not backed_up:
-                print('running backup first')
-                backup_all_indexes()
-                backed_up = True
-
-            print(f'applying new mappings to index ta_{index_name}...')
-            handler.rebuild_index()
-            continue
-
-        # else all good
-        print(f'ta_{index_name} index is created and up to date...')

tubearchivist/home/src/reindex.py

@@ -1,479 +0,0 @@
-"""
-Functionality:
-- reindexing old documents
-- syncing updated values between indexes
-- scan the filesystem to delete or index
-"""
-
-import json
-import os
-import re
-import subprocess
-import shutil
-
-from datetime import datetime
-from time import sleep
-from math import ceil
-
-import requests
-
-from home.src.download import ChannelSubscription, PendingList, VideoDownloader
-from home.src.config import AppConfig
-from home.src.index import (
-    YoutubeChannel,
-    YoutubeVideo,
-    index_new_video
-)
-from home.src.helper import (
-    get_total_hits,
-    clean_string,
-    set_message,
-    get_message
-)
-
-
-class Reindex:
-    """ check for outdated documents and refresh data from youtube """
-
-    def __init__(self):
-        # config
-        config = AppConfig().config
-        self.sleep_interval = config['downloads']['sleep_interval']
-        self.es_url = config['application']['es_url']
-        self.refresh_interval = 90
-        # scan
-        self.video_daily, self.channel_daily = self.get_daily()
-        self.all_youtube_ids = False
-        self.all_channel_ids = False
-
-    def get_daily(self):
-        """ get daily refresh values """
-        total_videos = get_total_hits(
-            'ta_video', self.es_url, 'active'
-        )
-        video_daily = ceil(total_videos / self.refresh_interval * 1.2)
-        total_channels = get_total_hits(
-            'ta_channel', self.es_url, 'channel_active'
-        )
-        channel_daily = ceil(total_channels / self.refresh_interval * 1.2)
-        return (video_daily, channel_daily)
-
-    def get_outdated_vids(self):
-        """ get daily videos to refresh """
-        headers = {'Content-type': 'application/json'}
-        now = int(datetime.now().strftime("%s"))
-        now_3m = now - 3 * 30 * 24 * 60 * 60
-        size = self.video_daily
-        data = {
-            "size": size,
-            "query": {
-                "bool": {
-                    "must": [
-                        {"match": {"active": True}},
-                        {"range": {"vid_last_refresh": {"lte": now_3m}}}
-                    ]
-                }
-            },
-            "sort": [{"vid_last_refresh": {"order": "asc"}}], "_source": False
-        }
-        query_str = json.dumps(data)
-        url = self.es_url + '/ta_video/_search'
-        response = requests.get(url, data=query_str, headers=headers)
-        if not response.ok:
-            print(response.text)
-        response_dict = json.loads(response.text)
-        all_youtube_ids = [i['_id'] for i in response_dict['hits']['hits']]
-        return all_youtube_ids
-
-    def get_outdated_channels(self):
-        """ get daily channels to refresh """
-        headers = {'Content-type': 'application/json'}
-        now = int(datetime.now().strftime("%s"))
-        now_3m = now - 3 * 30 * 24 * 60 * 60
-        size = self.channel_daily
-        data = {
-            "size": size,
-            "query": {
-                "bool": {
-                    "must": [
-                        {"match": {"channel_active": True}},
-                        {"range": {"channel_last_refresh": {"lte": now_3m}}}
-                    ]
-                }
-            },
-            "sort": [{"channel_last_refresh": {"order": "asc"}}],
-            "_source": False
-        }
-        query_str = json.dumps(data)
-        url = self.es_url + '/ta_channel/_search'
-        response = requests.get(url, data=query_str, headers=headers)
-        if not response.ok:
-            print(response.text)
-        response_dict = json.loads(response.text)
-        all_channel_ids = [i['_id'] for i in response_dict['hits']['hits']]
-        return all_channel_ids
-
-    def check_outdated(self):
-        """ add missing vids and channels """
-        self.all_youtube_ids = self.get_outdated_vids()
-        self.all_channel_ids = self.get_outdated_channels()
-
-    def rescrape_all_channels(self):
-        """ sync new data from channel to all matching videos """
-        sleep_interval = self.sleep_interval
-        channel_sub_handler = ChannelSubscription()
-        all_channels = channel_sub_handler.get_channels(
-            subscribed_only=False
-        )
-        all_channel_ids = [i['channel_id'] for i in all_channels]
-
-        counter = 1
-        for channel_id in all_channel_ids:
-            message = f'Progress: {counter}/{len(all_channels)}'
-            mess_dict = {
-                "status": "scraping",
-                "level": "info",
-                "title": "Scraping all youtube channels",
-                "message": message
-            }
-            set_message('progress:download', mess_dict)
-            channel_index = YoutubeChannel(channel_id)
-            subscribed = channel_index.channel_dict['channel_subscribed']
-            channel_index.channel_dict = channel_index.build_channel_dict(
-                scrape=True
-            )
-            channel_index.channel_dict['channel_subscribed'] = subscribed
-            channel_index.upload_to_es()
-            channel_index.sync_to_videos()
-            counter = counter + 1
-            if sleep_interval:
-                sleep(sleep_interval)
-
-    @staticmethod
-    def reindex_single_video(youtube_id):
-        """ refresh data for single video """
-        vid_handler = YoutubeVideo(youtube_id)
-        if not vid_handler.vid_dict:
-            # stop if deactivated
-            vid_handler.deactivate()
-            return
-
-        es_vid_dict = vid_handler.get_es_data()
-        player = es_vid_dict['_source']['player']
-        date_downloaded = es_vid_dict['_source']['date_downloaded']
-        channel_dict = es_vid_dict['_source']['channel']
-        channel_name = channel_dict['channel_name']
-        vid_handler.build_file_path(channel_name)
-        # add to vid_dict
-        vid_handler.vid_dict['player'] = player
-        vid_handler.vid_dict['date_downloaded'] = date_downloaded
-        vid_handler.vid_dict['channel'] = channel_dict
-        # update
-        vid_handler.upload_to_es()
-        vid_handler.delete_cache()
-
-    @staticmethod
-    def reindex_single_channel(channel_id):
-        """ refresh channel data and sync to videos """
-        channel_handler = YoutubeChannel(channel_id)
-        subscribed = channel_handler.channel_dict['channel_subscribed']
-        channel_handler.channel_dict = channel_handler.build_channel_dict(
-            scrape=True
-        )
-        channel_handler.channel_dict['channel_subscribed'] = subscribed
-        channel_handler.upload_to_es()
-        channel_handler.sync_to_videos()
-        channel_handler.clear_cache()
-
-    def reindex(self):
-        """ reindex what's needed """
-        # videos
-        print(f'reindexing {len(self.all_youtube_ids)} videos')
-        for youtube_id in self.all_youtube_ids:
-            self.reindex_single_video(youtube_id)
-            if self.sleep_interval:
-                sleep(self.sleep_interval)
-        # channels
-        print(f'reindexing {len(self.all_channel_ids)} channels')
-        for channel_id in self.all_channel_ids:
-            self.reindex_single_channel(channel_id)
-            if self.sleep_interval:
-                sleep(self.sleep_interval)
-
-
-class FilesystemScanner:
-    """ handle scanning and fixing from filesystem """
-
-    CONFIG = AppConfig().config
-    ES_URL = CONFIG['application']['es_url']
-    VIDEOS = CONFIG['application']['videos']
-
-    def __init__(self):
-        self.all_downloaded = self.get_all_downloaded()
-        self.all_indexed = self.get_all_indexed()
-        self.missmatch = None
-        self.to_rename = None
-        self.to_index = None
-        self.to_delete = None
-
-    def get_all_downloaded(self):
-        """ get a list of all video files downloaded """
-        all_channels = os.listdir(self.VIDEOS)
-        all_channels.sort()
-        all_downloaded = []
-        for channel_name in all_channels:
-            channel_path = os.path.join(self.VIDEOS, channel_name)
-            for video in os.listdir(channel_path):
-                youtube_id = video[9:20]
-                all_downloaded.append((channel_name, video, youtube_id))
-
-        return all_downloaded
-
-    @staticmethod
-    def get_all_indexed():
-        """ get a list of all indexed videos """
-        index_handler = PendingList()
-        all_indexed_raw = index_handler.get_all_indexed()
-        all_indexed = []
-        for video in all_indexed_raw:
-            youtube_id = video['_id']
-            media_url = video['_source']['media_url']
-            published = video['_source']['published']
-            title = video['_source']['title']
-            all_indexed.append((youtube_id, media_url, published, title))
-        return all_indexed
-
-    def list_comarison(self):
-        """ compare the lists to figure out what to do """
-        self.find_unindexed()
-        self.find_missing()
-        self.find_bad_media_url()
-
-    def find_unindexed(self):
-        """ find video files without a matching document indexed """
-        all_indexed_ids = [i[0] for i in self.all_indexed]
-        to_index = []
-        for downloaded in self.all_downloaded:
-            if downloaded[2] not in all_indexed_ids:
-                to_index.append(downloaded)
-
-        self.to_index = to_index
-
-    def find_missing(self):
-        """ find indexed videos without matching media file """
-        all_downloaded_ids = [i[2] for i in self.all_downloaded]
-        to_delete = []
-        for video in self.all_indexed:
-            youtube_id = video[0]
-            if youtube_id not in all_downloaded_ids:
-                to_delete.append(video)
-
-        self.to_delete = to_delete
-
-    def find_bad_media_url(self):
-        """ rename media files not matching the indexed title """
-        to_fix = []
-        to_rename = []
-        for downloaded in self.all_downloaded:
-            channel, filename, downloaded_id = downloaded
-            # find in indexed
-            for indexed in self.all_indexed:
-                indexed_id, media_url, published, title = indexed
-                if indexed_id == downloaded_id:
-                    # found it
-                    title_c = clean_string(title)
-                    pub = published.replace('-', '')
-                    expected_filename = f'{pub}_{indexed_id}_{title_c}.mp4'
-                    new_url = os.path.join(channel, expected_filename)
-                    if expected_filename != filename:
-                        # file to rename
-                        to_rename.append(
-                            (channel, filename, expected_filename)
-                        )
-                    if media_url != new_url:
-                        # media_url to update in es
-                        to_fix.append((indexed_id, new_url))
-
-                    break
-
-        self.missmatch = to_fix
-        self.to_rename = to_rename
-
-    def rename_files(self):
-        """ rename media files as identified by find_bad_media_url """
-        for bad_filename in self.to_rename:
-            channel, filename, expected_filename = bad_filename
-            old_path = os.path.join(self.VIDEOS, channel, filename)
-            new_path = os.path.join(self.VIDEOS, channel, expected_filename)
-            os.rename(old_path, new_path)
-
-    def send_missmatch_bulk(self):
-        """ build bulk update """
-        bulk_list = []
-        for video_missmatch in self.missmatch:
-            youtube_id, media_url = video_missmatch
-            action = {"update": {"_id": youtube_id, "_index": 'ta_video'}}
-            source = {"doc": {"media_url": media_url}}
-            bulk_list.append(json.dumps(action))
-            bulk_list.append(json.dumps(source))
-        # add last newline
-        bulk_list.append('\n')
-        query_str = '\n'.join(bulk_list)
-        # make the call
-        headers = {'Content-type': 'application/x-ndjson'}
-        url = self.ES_URL + '/_bulk'
-        request = requests.post(url, data=query_str, headers=headers)
-        if not request.ok:
-            print(request.text)
-
-    def delete_from_index(self):
-        """ find indexed but deleted mediafile """
-        for indexed in self.to_delete:
-            youtube_id, _ = indexed
-            url = self.ES_URL + '/ta_video/_doc/' + youtube_id
-            request = requests.delete(url)
-            if not request.ok:
-                print(request.text)
-
-
-class ManualImport:
-    """ import and indexing existing video files """
-
-    CONFIG = AppConfig().config
-    CACHE_DIR = CONFIG['application']['cache_dir']
-    IMPORT_DIR = os.path.join(CACHE_DIR, 'import')
-
-    def __init__(self):
-        self.identified = self.import_folder_parser()
-
-    def import_folder_parser(self):
-        """ detect files in import folder """
-
-        to_import = os.listdir(self.IMPORT_DIR)
-        to_import.sort()
-        video_files = [i for i in to_import if not i.endswith('.json')]
-
-        identified = []
-
-        for file_path in video_files:
-
-            file_dict = {'video_file': file_path}
-            file_name, _ = os.path.splitext(file_path)
-
-            matching_json = [
-                i for i in to_import if i.startswith(file_name)
-                and i.endswith('.json')
-            ]
-            if matching_json:
-                json_file = matching_json[0]
-                youtube_id = self.extract_id_from_json(json_file)
-                file_dict.update({'json_file': json_file})
-            else:
-                youtube_id = self.extract_id_from_filename(file_name)
-                file_dict.update({'json_file': False})
-
-            file_dict.update({'youtube_id': youtube_id})
-            identified.append(file_dict)
-
-        return identified
-
-    @staticmethod
-    def extract_id_from_filename(file_name):
-        """
-        look at the file name for the youtube id
-        expects filename ending in [<youtube_id>].<ext>
-        """
-        id_search = re.search(r'\[([a-zA-Z0-9_-]{11})\]$', file_name)
-        if id_search:
-            youtube_id = id_search.group(1)
-            return youtube_id
-
-        print('failed to extract youtube id for: ' + file_name)
-        raise Exception
-
-    def extract_id_from_json(self, json_file):
-        """ open json file and extract id """
-        json_path = os.path.join(self.CACHE_DIR, 'import', json_file)
-        with open(json_path, 'r', encoding='utf-8') as f:
-            json_content = f.read()
-
-        youtube_id = json.loads(json_content)['id']
-
-        return youtube_id
-
-    def process_import(self):
-        """ go through identified media files """
-
-        for media_file in self.identified:
-            json_file = media_file['json_file']
-            video_file = media_file['video_file']
-            youtube_id = media_file['youtube_id']
-
-            video_path = os.path.join(self.CACHE_DIR, 'import', video_file)
-
-            self.move_to_cache(video_path, youtube_id)
-
-            # identify and archive
-            vid_dict = index_new_video(youtube_id)
-            VideoDownloader([youtube_id]).move_to_archive(vid_dict)
-
-            # cleanup
-            if os.path.exists(video_path):
-                os.remove(video_path)
-            if json_file:
-                json_path = os.path.join(self.CACHE_DIR, 'import', json_file)
-                os.remove(json_path)
-
-    def move_to_cache(self, video_path, youtube_id):
-        """ move identified video file to cache, convert to mp4 """
-        file_name = os.path.split(video_path)[-1]
-        video_file, ext = os.path.splitext(file_name)
-
-        # make sure youtube_id is in filename
-        if not youtube_id in video_file:
-            video_file = f'{video_file}_{youtube_id}'
-
-        # move, convert if needed
-        if ext == '.mp4':
-            new_file = video_file + ext
-            dest_path = os.path.join(self.CACHE_DIR, 'download', new_file)
-            shutil.move(video_path, dest_path)
-        else:
-            print(f'processing with ffmpeg: {video_file}')
-            new_file = video_file + '.mp4'
-            dest_path = os.path.join(self.CACHE_DIR, 'download', new_file)
-            subprocess.run(
-                ["ffmpeg", "-i", video_path, dest_path,
-                "-loglevel", "warning", "-stats"], check=True
-            )
-
-
-def scan_filesystem():
-    """ grouped function to delete and update index """
-    filesystem_handler = FilesystemScanner()
-    filesystem_handler.list_comarison()
-    if filesystem_handler.to_rename:
-        filesystem_handler.rename_files()
-    if filesystem_handler.missmatch:
-        filesystem_handler.send_missmatch_bulk()
-    if filesystem_handler.to_delete:
-        filesystem_handler.delete_from_index()
-    if filesystem_handler.to_index:
-        for missing_vid in filesystem_handler.to_index:
-            youtube_id = missing_vid[2]
-            index_new_video(youtube_id, missing_vid=missing_vid)
-
-
-def reindex_old_documents():
-    """ daily refresh of old documents """
-    # check needed last run
-    now = int(datetime.now().strftime("%s"))
-    last_reindex = get_message('last_reindex')
-    if isinstance(last_reindex, int) and now - last_reindex < 60 * 60 * 24:
-        return
-    # continue if needed
-    reindex_handler = Reindex()
-    reindex_handler.check_outdated()
-    reindex_handler.reindex()
-    # set timestamp
-    set_message('last_reindex', now, expire=False)

tubearchivist/home/src/searching.py

@@ -1,237 +0,0 @@
-"""
-Functionality:
-- handle search to populate results to view
-- cache youtube video thumbnails and channel artwork
-- parse values in hit_cleanup for frontend
-- calculate pagination values
-"""
-
-import math
-import os
-import urllib.parse
-
-from datetime import datetime
-
-import requests
-
-from PIL import Image
-
-from home.src.config import AppConfig
-
-
-class SearchHandler:
-    """ search elastic search """
-
-    CONFIG = AppConfig().config
-    CACHE_DIR = CONFIG['application']['cache_dir']
-
-    def __init__(self, url, data, cache=True):
-        self.max_hits = None
-        self.url = url
-        self.data = data
-        self.cache = cache
-
-    def get_data(self):
-        """ get the data """
-        if self.data:
-            response = requests.get(self.url, json=self.data).json()
-        else:
-            response = requests.get(self.url).json()
-
-        if 'hits' in response.keys():
-            self.max_hits = response['hits']['total']['value']
-            return_value = response['hits']['hits']
-        else:
-            # simulate list for single result to reuse rest of class
-            return_value = [response]
-
-        # stop if empty
-        if not return_value:
-            return False
-
-        all_videos = []
-        all_channels = []
-        for idx, hit in enumerate(return_value):
-            return_value[idx] = self.hit_cleanup(hit)
-            if hit['_index'] == 'ta_video':
-                video_dict, channel_dict = self.vid_cache_link(hit)
-                if video_dict not in all_videos:
-                    all_videos.append(video_dict)
-                if channel_dict not in all_channels:
-                    all_channels.append(channel_dict)
-            elif hit['_index'] == 'ta_channel':
-                channel_dict = self.channel_cache_link(hit)
-                if channel_dict not in all_channels:
-                    all_channels.append(channel_dict)
-        if self.cache:
-            # validate cache
-            self.cache_dl_vids(all_videos)
-            self.cache_dl_chan(all_channels)
-
-        return return_value
-
-    @staticmethod
-    def vid_cache_link(hit):
-        """ download thumbnails into chache """
-        vid_thumb = hit['source']['vid_thumb_url']
-        youtube_id = hit['source']['youtube_id']
-        channel_id_hit = hit['source']['channel']['channel_id']
-        chan_thumb = hit['source']['channel']['channel_thumb_url']
-        try:
-            chan_banner = hit['source']['channel']['channel_banner_url']
-        except KeyError:
-            chan_banner = False
-        video_dict = {
-            'youtube_id': youtube_id,
-            'vid_thumb': vid_thumb
-        }
-        channel_dict = {
-            'channel_id': channel_id_hit,
-            'chan_thumb': chan_thumb,
-            'chan_banner': chan_banner
-        }
-        return video_dict, channel_dict
-
-    @staticmethod
-    def channel_cache_link(hit):
-        """ build channel thumb links """
-        channel_id_hit = hit['source']['channel_id']
-        chan_thumb = hit['source']['channel_thumb_url']
-        try:
-            chan_banner = hit['source']['channel_banner_url']
-        except KeyError:
-            chan_banner = False
-        channel_dict = {
-            'channel_id': channel_id_hit,
-            'chan_thumb': chan_thumb,
-            'chan_banner': chan_banner
-        }
-        return channel_dict
-
-    def cache_dl_vids(self, all_videos):
-        """ video thumbs links for cache """
-        vid_cache = os.path.join(self.CACHE_DIR, 'videos')
-        all_vid_cached = os.listdir(vid_cache)
-        # videos
-        for video_dict in all_videos:
-            youtube_id = video_dict['youtube_id']
-            if not youtube_id + '.jpg' in all_vid_cached:
-                cache_path = os.path.join(vid_cache, youtube_id + '.jpg')
-                thumb_url = video_dict['vid_thumb']
-                img_raw = requests.get(thumb_url, stream=True).raw
-                img = Image.open(img_raw)
-                width, height = img.size
-                if not width / height == 16 / 9:
-                    new_height = width / 16 * 9
-                    offset = (height - new_height) / 2
-                    img = img.crop((0, offset, width, height - offset))
-                img.convert("RGB").save(cache_path)
-
-    def cache_dl_chan(self, all_channels):
-        """ download channel thumbs """
-        chan_cache = os.path.join(self.CACHE_DIR, 'channels')
-        all_chan_cached = os.listdir(chan_cache)
-        for channel_dict in all_channels:
-            channel_id_cache = channel_dict['channel_id']
-            channel_banner_url = channel_dict['chan_banner']
-            channel_banner = channel_id_cache + '_banner.jpg'
-            channel_thumb_url = channel_dict['chan_thumb']
-            channel_thumb = channel_id_cache + '_thumb.jpg'
-            # thumb
-            if channel_thumb_url and channel_thumb not in all_chan_cached:
-                cache_path = os.path.join(chan_cache, channel_thumb)
-                img_raw = requests.get(channel_thumb_url, stream=True).content
-                with open(cache_path, 'wb') as f:
-                    f.write(img_raw)
-            # banner
-            if channel_banner_url and channel_banner not in all_chan_cached:
-                cache_path = os.path.join(chan_cache, channel_banner)
-                img_raw = requests.get(channel_banner_url, stream=True).content
-                with open(cache_path, 'wb') as f:
-                    f.write(img_raw)
-
-    @staticmethod
-    def hit_cleanup(hit):
-        """ clean up and parse data from a single hit """
-        hit['source'] = hit.pop('_source')
-        hit_keys = hit['source'].keys()
-        if 'media_url' in hit_keys:
-            parsed_url = urllib.parse.quote(hit['source']['media_url'])
-            hit['source']['media_url'] = parsed_url
-
-        if 'published' in hit_keys:
-            published = hit['source']['published']
-            date_pub = datetime.strptime(published, "%Y-%m-%d")
-            date_str = datetime.strftime(date_pub, "%d %b, %Y")
-            hit['source']['published'] = date_str
-
-        if 'vid_last_refresh' in hit_keys:
-            vid_last_refresh = hit['source']['vid_last_refresh']
-            date_refresh = datetime.fromtimestamp(vid_last_refresh)
-            date_str = datetime.strftime(date_refresh, "%d %b, %Y")
-            hit['source']['vid_last_refresh'] = date_str
-
-        if 'channel_last_refresh' in hit_keys:
-            refreshed = hit['source']['channel_last_refresh']
-            date_refresh = datetime.fromtimestamp(refreshed)
-            date_str = datetime.strftime(date_refresh, "%d %b, %Y")
-            hit['source']['channel_last_refresh'] = date_str
-
-        if 'channel' in hit_keys:
-            channel_keys = hit['source']['channel'].keys()
-            if 'channel_last_refresh' in channel_keys:
-                refreshed = hit['source']['channel']['channel_last_refresh']
-                date_refresh = datetime.fromtimestamp(refreshed)
-                date_str = datetime.strftime(date_refresh, "%d %b, %Y")
-                hit['source']['channel']['channel_last_refresh'] = date_str
-
-        return hit
-
-
-class Pagination:
-    """
-    figure out the pagination based on page size and total_hits
-    """
-
-    def __init__(self, page_get, search_get=False):
-        config = AppConfig().config
-        self.page_size = config['archive']['page_size']
-        self.page_get = page_get
-        self.search_get = search_get
-        self.pagination = self.first_guess()
-
-    def first_guess(self):
-        """ build first guess before api call """
-        page_get = self.page_get
-        if page_get in [0, 1]:
-            page_from = 0
-            prev_pages = False
-        elif page_get > 1:
-            page_from = (page_get - 1) * self.page_size
-            prev_pages = [
-                i for i in range(page_get - 1, page_get - 6, -1) if i > 1
-            ]
-            prev_pages.reverse()
-        pagination = {
-            "page_size": self.page_size,
-            "page_from": page_from,
-            "prev_pages": prev_pages,
-            "current_page": page_get
-        }
-        if self.search_get:
-            pagination.update({"search_get": self.search_get})
-        return pagination
-
-    def validate(self, total_hits):
-        """ validate pagination with total_hits after making api call """
-        page_get = self.page_get
-        max_pages = math.ceil(total_hits / self.page_size)
-        if page_get < max_pages and max_pages > 1:
-            self.pagination['last_page'] = max_pages
-        else:
-            self.pagination['last_page'] = False
-        next_pages = [
-            i for i in range(page_get + 1, page_get + 6) if 1 < i < max_pages
-        ]
-
-        self.pagination['next_pages'] = next_pages