Documentation about json only posting
This commit is contained in:
parent
d8daf28eff
commit
b8e741070d
@ -48,6 +48,29 @@ Reserve shows are downloaded and submitted by the Janitors on behalf of the host
|
||||
|
||||
This is currently added manually by the Janitors, as the text to speech tools often requires manipulation to get it sounding correct.
|
||||
|
||||
```
|
||||
--
|
||||
-- Table structure for table `hosts`
|
||||
--
|
||||
|
||||
DROP TABLE IF EXISTS `hosts`;
|
||||
/*!40101 SET @saved_cs_client = @@character_set_client */;
|
||||
/*!40101 SET character_set_client = utf8 */;
|
||||
CREATE TABLE `hosts` (
|
||||
`hostid` int(10) NOT NULL AUTO_INCREMENT,
|
||||
`host` text NOT NULL,
|
||||
`email` text NOT NULL,
|
||||
`profile` text NOT NULL,
|
||||
`license` varchar(11) NOT NULL DEFAULT 'CC-BY-SA',
|
||||
`local_image` int(2) NOT NULL DEFAULT 0,
|
||||
`gpg` text NOT NULL,
|
||||
`valid` int(1) NOT NULL DEFAULT 1,
|
||||
`espeak_name` text DEFAULT NULL COMMENT 'Version of the host name for use with espeak',
|
||||
PRIMARY KEY (`hostid`)
|
||||
) ENGINE=MyISAM AUTO_INCREMENT=437 DEFAULT CHARSET=utf8mb3 COLLATE=utf8mb3_unicode_ci;
|
||||
/*!40101 SET character_set_client = @saved_cs_client */;
|
||||
```
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@ -73,7 +96,7 @@ Host Images/Avatars, can either be:
|
||||
|
||||
<strong>Local Images</strong> uploaded when the host submits or <s><a href="https://repo.anhonesthost.net/HPR/hpr_hub/issues/66">edits</a></s> their profile.
|
||||
|
||||
<strong><a href="https://gravatar.com/">Gravatar</a></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><a href="https://gravatar.com/">Gravatar</a></strong> Images downloaded periodically by the Janitors.
|
||||
|
||||
<strong>[Default Images](https://repo.anhonesthost.net/HPR/hpr_generator/src/branch/main/public_html/images/hpr_logo.png)</strong> added by [hpr_generator](https://repo.anhonesthost.net/HPR/hpr_generator/src/branch/main/templates/shared-avatar.tpl.html) when the host has no other image.
|
||||
|
||||
@ -101,11 +124,85 @@ 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
|
||||
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.
|
||||
|
||||
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).
|
||||
|
||||
---
|
||||
|
||||
The HPR CMS script [add_show_json.php](https://repo.anhonesthost.net/HPR/hpr_hub/src/branch/main/cms/add_show_json.php) will validate the input, and add an entry into the `eps` table of the database.
|
||||
|
||||
```
|
||||
--
|
||||
-- Table structure for table `eps`
|
||||
--
|
||||
|
||||
DROP TABLE IF EXISTS `eps`;
|
||||
/*!40101 SET @saved_cs_client = @@character_set_client */;
|
||||
/*!40101 SET character_set_client = utf8 */;
|
||||
CREATE TABLE `eps` (
|
||||
`id` int(5) NOT NULL,
|
||||
`date` date NOT NULL,
|
||||
`title` varchar(100) NOT NULL,
|
||||
`duration` int(5) NOT NULL,
|
||||
`summary` varchar(100) NOT NULL,
|
||||
`notes` text NOT NULL,
|
||||
`hostid` int(10) NOT NULL,
|
||||
`series` int(10) NOT NULL,
|
||||
`explicit` tinyint(1) NOT NULL DEFAULT 1,
|
||||
`license` varchar(11) NOT NULL DEFAULT 'CC-BY-SA',
|
||||
`tags` varchar(200) NOT NULL,
|
||||
`version` int(5) NOT NULL DEFAULT 0,
|
||||
`downloads` int(11) NOT NULL,
|
||||
`valid` int(1) NOT NULL DEFAULT 1,
|
||||
PRIMARY KEY (`id`),
|
||||
UNIQUE KEY `id` (`id`)
|
||||
) ENGINE=MyISAM AUTO_INCREMENT=1275 DEFAULT CHARSET=utf8mb3 COLLATE=utf8mb3_unicode_ci;
|
||||
/*!40101 SET character_set_client = @saved_cs_client */;
|
||||
|
||||
```
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Description</th>
|
||||
<th>Example</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><th>id</th><td>This is the Episode Number that will uniquely identify the show.</td><td>9278</td></tr>
|
||||
<tr><th>date</th><td>The date the show air, namely when it gets put in the main feed.</td><td>2044-02-24</td></tr>
|
||||
<tr><th>title</th><td>This will be a short descriptive title and will be used to describe the show.</td><td></td></tr>
|
||||
<tr><th>duration</th><td>The length of the submitted show without branding in seconds.</td><td>2850</td></tr>
|
||||
<tr><th>summary</th><td>This is a short 100 character summary of what the show is about. Used on the main page, on the mobile site, on printed brochures, on text to speech announcements, Mastodon etc.</td><td></td></tr>
|
||||
<tr><th>notes</th><td>Additional descriptions and images in html format.</td><td></td></tr>
|
||||
<tr><th>hostid</th><td>The hosts.hostid of the host.</td><td>789</td></tr>
|
||||
<tr><th>series</th><td>The miniseries.id that the show belongs to.</td><td></td></tr>
|
||||
<tr><th>explicit</th><td>Flags the show as [explicit](https://web.archive.org/web/20150326185817/http://www.apple.com/uk/itunes/podcasts/specs.html).</td><td>Clean or Yes</td></tr>
|
||||
<tr><th>license</th><td>Which licenses.short_name the show is released under.</td><td>CC-BY-SA</td></tr>
|
||||
<tr><th>tags</th><td>Add a list of comma separated tags that represent the essence of the show.</td><td></td></tr>
|
||||
<tr><th>version</th><td>Deprecated.</td><td></td></tr>
|
||||
<tr><th>downloads</th><td>Deprecated.</td><td></td></tr>
|
||||
<tr><th>valid</th><td>Allows temporary de-listing of host.</td><td>0</td></tr>
|
||||
<tbody>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## 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.
|
||||
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: 9278 in a single directory `hpr9278`. 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/`.
|
||||
|
||||
@ -155,7 +252,7 @@ We need to base our requirements on our own requirements and not those imposed b
|
||||
It should be possible for someone to `rsync` the entire site and store it locally for use with a file manager/or media player.
|
||||
|
||||
|
||||
To make file management clear all files must begin with the episode number `hpr9876`.
|
||||
To make file management clear all files must begin with the episode number `hpr9278`.
|
||||
|
||||
Supplemental files should be p
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user