Congegni
/
sintonia
7
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix issue with automatic ingest; shift episode ingest to PodcastEpisodesController

This commit is contained in:
Duncan Sommerville 2015-10-22 12:12:41 -04:00
parent 23ccc268d1
commit 9302027a2b
8 changed files with 75 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
airtime_mvc/application/Bootstrap.php
View File

@ -38,7 +38,9 @@ require_once "Auth.php";
require_once 'Preference.php';
require_once 'Locale.php';
/* Enums */
require_once "Enum.php";
require_once "MediaType.php";
require_once "HttpRequestType.php";
/* Interfaces */
require_once "OAuth2.php";
require_once "OAuth2Controller.php";

7
airtime_mvc/application/common/PodcastManager.php
View File

@ -5,7 +5,7 @@ class PodcastManager {
/**
* @var int how often, in seconds, to check for and ingest new podcast episodes
*/
private static $_PODCAST_POLL_INTERVAL_SECONDS = 3600; // 1 hour
private static $_PODCAST_POLL_INTERVAL_SECONDS = 30; // 1 hour
/**
* Check whether $_PODCAST_POLL_INTERVAL_SECONDS have passed since the last call to
@ -50,13 +50,12 @@ class PodcastManager {
$podcastArray = Application_Service_PodcastService::getPodcastById($podcast->getDbPodcastId());
$episodeList = $podcastArray["episodes"];
$episodes = array();
// A bit hacky... sort the episodes by publication date to get the most recent
usort($episodeList, array(static::class, "_sortByEpisodePubDate"));
for ($i = 0; $i < sizeof($episodeList); $i++) {
$episodeData = $episodeList[$i];
$ingestTimestamp = $podcast->getDbAutoIngestTimestamp();
// If the publication date of this episode is before the ingest timestamp, we don't need to ingest it
// Since we're sorting by publication date, we can break
if ($episodeData["pub_date"] < $podcast->getDbAutoIngestTimestamp()) break;
if ($episodeData["pub_date"] < $ingestTimestamp) continue;
$episode = PodcastEpisodesQuery::create()->findOneByDbEpisodeGuid($episodeData["guid"]);
// Make sure there's no existing episode placeholder or import, and that the data is non-empty
if (empty($episode) && !empty($episodeData)) {

12
airtime_mvc/application/common/enum/HttpRequestType.php Normal file
View File

@ -0,0 +1,12 @@
<?php
final class HttpRequestType extends Enum {
const GET = "GET";
const POST = "POST";
const PUT = "PUT";
const DELETE = "DELETE";
const PATCH = "PATCH";
const OPTIONS = "OPTIONS";
}

29
airtime_mvc/application/modules/rest/controllers/PodcastController.php
View File

@ -5,11 +5,6 @@ require_once('PodcastFactory.php');
class Rest_PodcastController extends Zend_Rest_Controller
{
/**
* @var Application_Service_PodcastEpisodeService
*/
protected $_service;
public function init()
{
$this->view->layout()->disableLayout();
@ -17,7 +12,6 @@ class Rest_PodcastController extends Zend_Rest_Controller
// Remove reliance on .phtml files to render requests
$this->_helper->viewRenderer->setNoRender(true);
$this->view->setScriptPath(APPLICATION_PATH . 'views/scripts/');
$this->_service = new Application_Service_PodcastEpisodeService();
}
public function indexAction()
@ -120,11 +114,6 @@ class Rest_PodcastController extends Zend_Rest_Controller
try {
$requestData = json_decode($this->getRequest()->getRawBody(), true);
// Create placeholders in PodcastEpisodes so we know these episodes are being downloaded
// to prevent the user from trying to download them again while Celery is running
$episodes = $this->_service->addPodcastEpisodePlaceholders($requestData["podcast"]["id"],
$requestData["podcast"]["episodes"]);
$this->_service->downloadEpisodes($episodes);
$podcast = Application_Service_PodcastService::updatePodcastFromArray($id, $requestData);
$this->getResponse()
@ -167,7 +156,7 @@ class Rest_PodcastController extends Zend_Rest_Controller
* Endpoint for performing bulk actions (deleting multiple podcasts, opening multiple editors)
*/
public function bulkAction() {
if ($this->_request->getMethod() != "POST") {
if ($this->_request->getMethod() != HttpRequestType::POST) {
$this->getResponse()
->setHttpResponseCode(405)
->appendBody("ERROR: Method not accepted");
@ -175,28 +164,20 @@ class Rest_PodcastController extends Zend_Rest_Controller
}
$ids = $this->_getParam('ids', []);
$method = $this->_getParam('method', 'GET');
$method = $this->_getParam('method', HttpRequestType::GET);
$responseBody = [];
switch($method) {
case "DELETE":
case HttpRequestType::DELETE:
foreach($ids as $id) {
Application_Service_PodcastService::deletePodcastById($id);
}
// XXX: do we need this to be more descriptive?
$responseBody = "Successfully deleted podcasts";
break;
case "GET":
case HttpRequestType::GET:
foreach($ids as $id) {
// Check the StationPodcast table rather than checking
// the station podcast ID key in preferences for extensibility
$podcast = StationPodcastQuery::create()->findOneByDbPodcastId($id);
$path = $podcast ? 'podcast/station_podcast.phtml' : 'podcast/podcast.phtml';
$podcast = Application_Service_PodcastService::getPodcastById($id);
$responseBody[] = array(
"podcast"=>json_encode($podcast),
"html"=>$this->view->render($path),
);
$responseBody[] = Application_Service_PodcastService::buildPodcastEditorResponse($id, $this->view);
}
break;
}

16
airtime_mvc/application/modules/rest/controllers/PodcastEpisodesController.php
View File

@ -2,12 +2,19 @@
class Rest_PodcastEpisodesController extends Zend_Rest_Controller
{
/**
* @var Application_Service_PodcastEpisodeService
*/
protected $_service;
public function init()
{
$this->view->layout()->disableLayout();
// Remove reliance on .phtml files to render requests
$this->_helper->viewRenderer->setNoRender(true);
$this->_service = new Application_Service_PodcastEpisodeService();
}
public function indexAction()
@ -62,13 +69,13 @@ class Rest_PodcastEpisodesController extends Zend_Rest_Controller
public function postAction()
{
Logging::info("episodes post");
//If we do get an episode ID on a POST, then that doesn't make any sense
//since POST is only for creating.
if ($episodeId = $this->_getParam('episode_id', false)) {
$resp = $this->getResponse();
$resp->setHttpResponseCode(400);
$resp->appendBody("ERROR: Episode ID should not be specified when using POST. POST is only used for importing podcast episodes, and an episode ID will be chosen by Airtime");
$resp->appendBody("ERROR: Episode ID should not be specified when using POST. POST is only used for "
. "importing podcast episodes, and an episode ID will be chosen by Airtime");
return;
}
@ -80,10 +87,7 @@ class Rest_PodcastEpisodesController extends Zend_Rest_Controller
try {
$requestData = json_decode($this->getRequest()->getRawBody(), true);
//$requestData = $this->getRequest()->getPost();
$episode = PodcastEpisodes::create($id, $requestData);
$episode = $this->_service->importEpisode($id, $requestData["episode"]);
$this->getResponse()
->setHttpResponseCode(201)
->appendBody(json_encode($episode));

14
airtime_mvc/application/services/PodcastEpisodeService.php
View File

@ -25,6 +25,20 @@ class Application_Service_PodcastEpisodeService extends Application_Service_Thir
self::DOWNLOAD => 'podcast-download'
];
/**
* Utility function to import and download a single episode
*
* @param int $podcastId ID of the podcast the episode should belong to
* @param array $episode array of episode data to store
*
* @return PodcastEpisodes the stored PodcastEpisodes object
*/
public function importEpisode($podcastId, $episode) {
$e = $this->addPlaceholder($podcastId, $episode);
$this->_download($e->getDbId(), $e->getDbDownloadUrl());
return $e;
}
/**
* Given an array of episodes, store them in the database as placeholder objects until
* they can be processed by Celery

22
airtime_mvc/application/services/PodcastService.php
View File

@ -291,6 +291,28 @@ class Application_Service_PodcastService
}
}
/**
* Build a response with podcast data and embedded HTML to load on the frontend
*
* @param int $podcastId ID of the podcast to build a response for
* @param Zend_View_Interface $view Zend view object to render the response HTML
*
* @return array the response array containing the podcast data and editor HTML
*
* @throws PodcastNotFoundException
*/
public static function buildPodcastEditorResponse($podcastId, $view) {
// Check the StationPodcast table rather than checking
// the station podcast ID key in preferences for extensibility
$podcast = StationPodcastQuery::create()->findOneByDbPodcastId($podcastId);
$path = $podcast ? 'podcast/station_podcast.phtml' : 'podcast/podcast.phtml';
$podcast = Application_Service_PodcastService::getPodcastById($podcastId);
return array(
"podcast" => json_encode($podcast),
"html" => $view->render($path),
);
}
/**
* Updates a Podcast object with the given metadata
*

10
airtime_mvc/public/js/airtime/library/podcast.js
View File

@ -21,9 +21,13 @@ var AIRTIME = (function (AIRTIME) {
tab.setName($scope.podcast.title);
$scope.savePodcast = function() {
var podcastData = $scope.podcast; // Copy the podcast in scope so we can modify it
podcastData.episodes = episodeTable.getSelectedRows();
$http.put(endpoint + $scope.podcast.id, { csrf_token: jQuery("#csrf").val(), podcast: podcastData })
var episodes = episodeTable.getSelectedRows(),
csrf = jQuery("#csrf").val();
// TODO: Should we implement a batch endpoint for this instead?
jQuery.each(episodes, function() {
$http.post(endpoint + $scope.podcast.id + '/episodes', { csrf_token: csrf, episode: this });
});
$http.put(endpoint + $scope.podcast.id, { csrf_token: csrf, podcast: $scope.podcast })
.success(function() {
episodeTable.reload($scope.podcast.id);
AIRTIME.library.podcastDataTable.fnDraw();