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

Documenting upload and host table

Browse Source
This commit is contained in:
Ken Fallon 2024-12-27 11:23:32 +01:00
parent 8635b07c41
commit 09fa762e43
1 changed files with 59 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

59
workflow/directory-structure.md
View File

@ -42,6 +42,65 @@ It renames the directory structure based on a combination of fields separated by
```
Reserve shows are downloaded and submitted by the Janitors on behalf of the host. This follows the normal posting process where the host and Janitors are cc'd on the notification emails. The only difference is that the audio is edited to include a notification that the show is from the reserve queue, and that it is the Janitors that upload the show via the supplied link.
## Show Processing
### Adding the host to the `hosts` table
This is currently added manually by the Janitors, as the text to speech tools often requires manipulation to get it sounding correct.
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
<th>Example</th>
</tr>
</thead>
<tbody>
<tr><th>hostid</th><td>Automatically generated incrementing number.</td><td>987</td></tr>
<tr><th>host</th><td>The name or handle of the host.</td><td>Emperor Ming</td></tr>
<tr><th>email</th>The hosts email address with the `@` replaced with `.nospam@nospam.` as an antispam measure<td></td><td>Emperor.Ming.nospam@nospam.example.com</td></tr>
<tr><th>profile</th><td>A html host profile</td><td>`<p>Follow me Mastodon: <a rel="me" href="https://mastodon.example.org/@Emperor.Ming">@Emperor.Ming@mastodon.example.org</a></p>`</td></tr>
<tr><th>license</th><td>One of the allowed licenses</td><td>`CC-BY-SA`</td></tr>
<tr><th>local_image</th><td>If a avatar is available directly from the host.</td><td>`1`</td></tr>
<tr><th>gpg</th><td>We can verify the hosts emails, with [thought to automatically verify](https://repo.anhonesthost.net/HPR/hpr-tools/issues/4).</td><td>`1C7398B00F0239E8`</td></tr>
<tr><th>valid</th><td>Allows temporary de-listing of host</td><td>`0`</td></tr>
<tr><th>espeak_name</th><td>The text to speech version of the name or handle.</td><td>Fifty One Fifty</td></tr>
<tbody>
</table>
Host Images/Avatars, can either be:
<strong>Local Images</strong> uploaded when the host submits <s>or <a href="https://repo.anhonesthost.net/HPR/hpr_hub/issues/66">edits</a></s> their profile.
<strong>Gravatar</strong> Images downloaded periodically by the Janitors and copied to the file store on the [origin server](https://en.wikipedia.org/wiki/Upstream_server).
<strong>Default Images</strong> added by [hpr_generator](https://repo.anhonesthost.net/HPR/hpr_generator/src/branch/main/public_html/images/hosts) when the host has no other image.
All the images are [currently](https://repo.anhonesthost.net/HPR/hpr_generator/issues/234) stored in the [hpr_generator](https://repo.anhonesthost.net/HPR/hpr_generator/src/branch/main/public_html/images/hosts) repository, and get transferred to the server using [hpr-publish.bash](https://repo.anhonesthost.net/HPR/hpr-tools/src/branch/main/workflow/hpr-publish.bash).
### Adding the episode to the `eps` table
The script [postshow.bash](https://repo.anhonesthost.net/HPR/hpr-tools/src/branch/main/workflow/postshow.bash) is run locally on the Janitors computer.
It calls the HPR CMS script [status.php](https://repo.anhonesthost.net/HPR/hpr_hub/src/branch/main/cms/status.php) to return a tab separated list of the shows in the queue.
```
timestamp_epoc ep_num ep_date key status email
2339594445 9278 2044-02-24 aeb0579fcac318005d7550a60fd60403676c24d94148b SHOW_SUBMITTED joe.blogg.nospam@nospam.example.com
2339680845 9999 1970-01-01 4bd713699e5bc0978d5fef85a60f09bc7f70ef3488624 RESERVE_SHOW_SUBMITTED Emperor.Ming.nospam@nospam.example.com
```
It selects the first show with a status of `SHOW_SUBMITTED` and uses `rsync` to clone the directory locally. It then parses the `shownotes.json` file and extracts the shownotes object to a new file `shownotes.html`.
All embedded images are saved as local image files, with the format `hpr${ep_num}_${image_count}` based on "episode number", a underscore as delimiter, and then a sequential number of the image in the notes. eg `hpr9876_1.jpg`.
Where they are images larger than 400 pixels wide, a thumbnail is created with the same image name but suffixed with `_tn`. eg `hpr9876_1_tn.jpg`.
The Janitors then review the shownotes for issues.
The duration will be extracted from the media, and the other metadata from the `shownotes.json` file. After some checks it will be [URL encoded](https://en.wikipedia.org/wiki/Percent-encoding).
The script allows overwriting of any value in the json file from the command line, and also prevents posting from a new host that has not yet been assigned a entry in the `hosts` table.
Once all the checks are done the
## Output Directory Structure
It should be possible to ship the entire backlog on physical media 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.