HPR/hpr_documentation
8
0
Fork 2
Code Issues 4 Pull Requests Actions Packages Projects Releases Wiki Activity

Update request

Ken Fallon
2024-12-14 10:29:14 +00:00
parent 1551920308
commit cc6f029252
1 changed files with 34 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
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