HPR/hpr_documentation
6
0
Fork 1
Code Issues 1 Pull Requests Actions Packages Projects Releases Wiki Activity

2024-12-26_22-01-10_CET

Browse Source
This commit is contained in:
Ken Fallon 2024-12-26 22:01:10 +01:00
parent 183b46ecc2
commit 8f89cdac58
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
workflow/directory-structure.md
View File

@ -1,6 +1,6 @@
# File Structure
We receive random files from random people on the Internet, so are treated with extreme care.
We receive random files from random people on the Internet, so they are treated with extreme care.
The HPR Database is used to track the `status` of each show as it is been processed, using a normally hidden table `reservations`. It is not publicly available as it contains the IP address of the host uploading the show as a security measure. Once the show is processed the IP address is removed from the table.
@ -25,9 +25,9 @@ The directory structure is based on a combination of fields separated by the und
2339594445_9278_2044-02-24_aeb0579fcac318005d7550a60fd60403676c24d94148b
2339680845_9999_1970-01-01_4bd713699e5bc0978d5fef85a60f09bc7f70ef3488624
```
Shows destined for the reserve queue are moved to from the upload directory and placed the reserve directory using the script [rename-reserve.bash](https://repo.anhonesthost.net/HPR/hpr-tools/src/branch/main/workflow/rename-reserve.bash).
Shows destined for the reserve queue are moved from the upload directory and placed in the reserve directory using the script [rename-reserve.bash](https://repo.anhonesthost.net/HPR/hpr-tools/src/branch/main/workflow/rename-reserve.bash).
This is run manually by the Janitors as it checks to see if a url to the show was provide, and attempts to download the file. When new hosts submit a show directly to the reserve queue, the Janitors will resubmit it to the first available slot in the normal queue. This because new hosts need to have a entry created in the `hosts` table, but also new hosts should introduce themselves first to the community.
This is run manually by the Janitors as it checks to see if a url to the show was provided, and attempts to download the linked file. When new hosts submit a show directly to the reserve queue, the Janitors will resubmit it to the first available slot in the normal queue. This is because new hosts need to have a entry created in the `hosts` table, but also because it gives the community an opportunity to welcome the new host.
It renames the directory structure based on a combination of fields separated by the underscore (`_`) delimiter.
@ -44,7 +44,7 @@ Reserve shows are downloaded and submitted by the Janitors on behalf of the host
## Output Directory Structure
It should be possible to post the entire backlog to someone and have them plug it in and for any media player be able to play it. Each episode has it's own "album" which corresponds to a directory. The directory structure is kept as flat as possible with everything related to show 9876 in a single directory `hpr9876`. This is the least common denominator, and in no way precludes web services, or other applications.
It should be possible to post the entire backlog to someone and have them plug it in and for any media player be able to play it. Each episode has it's own "album" which corresponds to a directory. The directory structure is kept as flat as possible with everything related to show eg: 9876 in a single directory `hpr9876`. This is the least common denominator, and in no way precludes web services, or other applications.
We do however need to support other functionality so the _Episodes_ are kept inside of the `eps` directory, the _Hosts_ are in `hosts/`, and _Series_ are in `series/`.