From cc6f0292521551d4059359b3c76350e8dec86665 Mon Sep 17 00:00:00 2001 From: Ken Fallon Date: Sat, 14 Dec 2024 10:29:14 +0000 Subject: [PATCH] Update request --- request.md | 43 ++++++++++++++++++++++++++++++++++--------- 1 file changed, 34 insertions(+), 9 deletions(-) diff --git a/request.md b/request.md index 5161c90..09f417d 100644 --- a/request.md +++ b/request.md @@ -4,17 +4,17 @@ This process involves requesting a slot and verifying that the request is valid. `request.php > request_confirm.php > upload.php > upload_confirm.php` -## Steps +## Summary - The host has their show recorded and wishes to select a slot. -- They go to https://hackerpublicradio.org/ and select the [⇧Upload⇧](https://hub.hackerpublicradio.org/calendar.php), which executes [calendar.php](https://repo.anhonesthost.net/HPR/hpr_hub/src/branch/main/hub/calendar.php) -- The host selects a slot from [request.php](https://repo.anhonesthost.net/HPR/hpr_hub/src/branch/main/hub/request.php), which executes [request_confirm.php](https://repo.anhonesthost.net/HPR/hpr_hub/src/branch/main/hub/request_confirm.php) +- They go to https://hackerpublicradio.org/ and select the [⇧Upload⇧](https://hub.hackerpublicradio.org/calendar.php), which executes [calendar.php](https://repo.anhonesthost.net/HPR/hpr_hub/src/branch/main/hub/calendar.php). +- The host selects a slot from [request.php](https://repo.anhonesthost.net/HPR/hpr_hub/src/branch/main/hub/request.php), which executes [request_confirm.php](https://repo.anhonesthost.net/HPR/hpr_hub/src/branch/main/hub/request_confirm.php). - An email is sent to the host. -- The host clicks on the email link and is redirected to [upload.php](https://repo.anhonesthost.net/HPR/hpr_hub/src/branch/main/hub/upload.php) -- The host fills in the form which executes [upload_confirm.php](https://repo.anhonesthost.net/HPR/hpr_hub/src/branch/main/hub/upload_confirm.php) -- The host receives a confirmation email +- The host clicks on the email link and is redirected to [upload.php](https://repo.anhonesthost.net/HPR/hpr_hub/src/branch/main/hub/upload.php). +- The host fills in the form which executes [upload_confirm.php](https://repo.anhonesthost.net/HPR/hpr_hub/src/branch/main/hub/upload_confirm.php). +- The host receives a confirmation email. -## Sequence Diagram +## Sequence Diagram Requesting a slot ```mermaid sequenceDiagram @@ -48,8 +48,8 @@ sequenceDiagram HPR->>HPR: Log Error HPR->>host: 412 ${error_code} else All checks passed - HPR-->>email: upload url - email->>host: upload url + HPR-->>email: email upload url + email-->>host: email upload url end end ``` @@ -83,6 +83,31 @@ sequenceDiagram | 434cb53552ce1e2708e74a42f438028c | Problem mapping the date to the episode number | | c7405e79b54f582e8db46c69ec4b0f24 | Problem writing to the database | +## Sequence Diagram uploading a show + +```mermaid +sequenceDiagram + host->>HPR: Host clicks on link from email + loop Preform Checks + alt If check fails + HPR->>HPR: Log Error + HPR->>host: 412 ${error_code} + else All checks passed + HPR->>host: Webform + end + end + host->>HPR: Uploads show + loop Preform Checks + alt If check fails + HPR->>HPR: Log Error + HPR->>host: 412 ${error_code} + else All checks passed + HPR-->>HPR: Save files + HPR-->>email: Upload Confirmation + email-->>host: Upload Confirmation + end +end +``` ## Checks in upload.php