From 3d7ab52e5b7183a5ff0724fb833a72808e1e38a1 Mon Sep 17 00:00:00 2001 From: Ken Fallon Date: Sat, 28 Dec 2024 12:18:39 +0100 Subject: [PATCH] Describing the reservation table, and renameing file --- ...tory-structure.md => processing_a_show.md} | 34 +++++++------- workflow/uploading_a_show.md | 46 +++++++++++++++++++ 2 files changed, 62 insertions(+), 18 deletions(-) rename workflow/{directory-structure.md => processing_a_show.md} (92%) diff --git a/workflow/directory-structure.md b/workflow/processing_a_show.md similarity index 92% rename from workflow/directory-structure.md rename to workflow/processing_a_show.md index 068a924..c205223 100644 --- a/workflow/directory-structure.md +++ b/workflow/processing_a_show.md @@ -1,4 +1,4 @@ -# File Structure +# Show Processing We receive random files from random people on the Internet, so they are treated with extreme care. @@ -25,6 +25,11 @@ 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 ``` + +The upload will produce at a minimum a `shownote.json` file. It may also include a host photo, and usually a media file for the episode. If the media file is not provided, then the Janitors will attempt to download it from the provided `url`. If that is not possible, then the host will be contacted to provide the show, and if they do not or if it will cause a delay, the show slot is freed up for another contributor. + +Addition files and images may be provided by the host, eg: images, scripts, pdf documents etc. + 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 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 an entry created in the `hosts` table, but also because it gives the community an opportunity to welcome the new host. @@ -42,9 +47,7 @@ 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 +## 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. @@ -124,7 +127,14 @@ The duration will be extracted from the media, and the other metadata from the ` 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 script will `rsync` the formatted json, the shownotes html file, and any images back to the upload directory. +Once all the checks are done the script will `rsync` the following files back to the upload directory. + +- `shownotes_origional.json` the original json file for reference. +- `shownotes.json` the human readable formatted json file. +- `shownotes.html` the extracted and edited show notes. +- `post_show.json` the json file used to create the `eps` table entry. +- Any additional images in the format `hpr${ep_num}_${image_count}.${ext}` and if greater than 400 pixels, then the thumbnail in the format `hpr${ep_num}_${image_count}_tn.${ext}`. +- Any supporting files. Then it will use the `curl` command to POST the show to [add_show_json.php](https://repo.anhonesthost.net/HPR/hpr_hub/src/branch/main/cms/add_show_json.php). @@ -187,18 +197,7 @@ CREATE TABLE `eps` ( - - - - - - - - - - - - +