Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Paging for Episodes and Performance Optimizations #560

Merged
merged 13 commits into from
Mar 16, 2022
Merged

Paging for Episodes and Performance Optimizations #560

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
fe201d8
add paging for episodes
tgloeggl Mar 4, 2022
2a7d9be
remove problematic debug
tgloeggl Mar 4, 2022
d4b7a11
further optimization and more aggresive caching
tgloeggl Mar 4, 2022
c445f04
fix some minor issues
tgloeggl Mar 4, 2022
87a5e7a
use same endpoint for counting as for retrieving
tgloeggl Mar 7, 2022
d04fef4
keep episodes in local db
tgloeggl Mar 7, 2022
bc3c14e
ommit unnecessary calls to oc
tgloeggl Mar 15, 2022
73ce379
show wip episodes again
tgloeggl Mar 15, 2022
94cb3ab
update caniuse
tgloeggl Mar 16, 2022
788e5ce
course specific debugging, remove unnecessary call to oc
tgloeggl Mar 16, 2022
37f8331
use caching
tgloeggl Mar 16, 2022
fec6518
search service takes other filter arguments than external api
tgloeggl Mar 16, 2022
a3872ce
show debug option without connected series as well
tgloeggl Mar 16, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
use caching
  • Loading branch information
@tgloeggl
tgloeggl committed Mar 16, 2022
commit 37f83314119a95495793735c0a2461a575c4d55b
173 changes: 152 additions & 21 deletions classes/OCRestClient/ApiEventsClient.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,39 +57,50 @@ public function getBySeries($series_id)
{
static $static_events;

$cache = \StudipCacheFactory::getCache();

if (empty($static_events[$series_id])) {
$events = [];

$offset = Pager::getOffset();
$limit = Pager::getLimit();
$sort = Pager::getSortOrder();
$search = Pager::getSearch();

$events = $this->getJSON('/?filter=is_part_of:' .
$series_id . ',status:EVENTS.EVENTS.STATUS.PROCESSED,textFilter:engage-player'
. ($search ? ',title:*'. $search : '*')
. "&withpublications=true&sort=$sort&limit=$limit&offset=$offset");
$search_service = new SearchClient($this->config_id);

$static_events[$series_id] = array_reduce($events, function ($events, $event) {
$events[$event->identifier] = $event;
return $events;
}, []);
}
// first, get list of events ids from search service
$search_events = $search_service->getJSON('/episode.json?sid=' . $series_id
. ($search ? '&q='. $search : '')
. "&sort=$sort&limit=$limit&offset=$offset");

return $static_events[$series_id];
}
Pager::setLength($search_events->{'search-results'}->total);

public function getEpisodeCount($series_id)
{
static $static_events;
$results = is_array($search_events->{'search-results'}->result)
? $search_events->{'search-results'}->result
: [$search_events->{'search-results'}->result];

if (empty($static_events[$series_id])) {
$search = Pager::getSearch();
// then, iterate over list and get each event from the external-api
foreach ($results as $s_event) {
$cache_key = 'sop/episodes/'. $s_event->id;
$event = $cache->read($cache_key);

if (empty($s_event->id)) {
continue;
}

if (!$event) {
$event = self::prepareEpisode(
$this->getJSON('/' . $s_event->id . '/?withpublications=true')
);

$events = $this->getJSON('/?filter=is_part_of:' .
$series_id . ',status:EVENTS.EVENTS.STATUS.PROCESSED,textFilter:engage-player'
. ($search ? ',title:*'. $search : '*')
. "&sort=&limit=9999&offset=0");
$cache->write($cache_key, $event, 86000);
}

$static_events[$series_id] = sizeof($events);
$events[$s_event->id] = $event;
}

$static_events[$series_id] = $events;
}

return $static_events[$series_id];
Expand Down Expand Up @@ -168,4 +179,124 @@ public function getVisibilityForEpisode($episode, $course_id = null)
OCModel::setVisibilityForEpisode($course_id, $episode_id, $default);
return $default;
}

private function prepareEpisode($episode)
{
$new_episode = [];

if (!empty($episode->publications[0]->attachments)) {
$presentation_preview = false;
$preview = false;
$presenter_download = [];
$presentation_download = [];
$audio_download = [];
$annotation_tool = false;

foreach ((array) $episode->publications[0]->attachments as $attachment) {
if ($attachment->flavor === "presenter/search+preview") {
$preview = $attachment->url;
}
if ($attachment->flavor === "presentation/player+preview") {
$presentation_preview = $attachment->url;
}
}

foreach ($episode->publications[0]->media as $track) {
$parsed_url = parse_url($track->url);

if ($track->flavor === 'presenter/delivery') {
if (($track->mediatype === 'video/mp4' || $track->mediatype === 'video/avi')
&& ((in_array('atom', $track->tags) || in_array('engage-download', $track->tags))
&& $parsed_url['scheme'] != 'rtmp' && $parsed_url['scheme'] != 'rtmps')
&& !empty($track->has_video)
) {
$quality = $this->calculate_size(
$track->bitrate,
$track->duration
);
$presenter_download[$quality] = [
'url' => $track->url,
'info' => $this->getResolutionString($track->width, $track->height)
];
}

if (in_array($track->mediatype, ['audio/aac', 'audio/mp3', 'audio/mpeg', 'audio/m4a', 'audio/ogg', 'audio/opus'])
&& !empty($track->has_audio)
) {
$quality = $this->calculate_size(
$track->bitrate,
$track->duration
);
$audio_download[$quality] = [
'url' => $track->url,
'info' => round($track->audio->bitrate / 1000, 1) . 'kb/s, ' . explode('/', $track->mediatype)[1]
];
}
}

if ($track->flavor === 'presentation/delivery' && (
(
$track->mediatype === 'video/mp4'
|| $track->mediatype === 'video/avi'
) && (
(
in_array('atom', $track->tags)
|| in_array('engage-download', $track->tags)
)
&& $parsed_url['scheme'] != 'rtmp'
&& $parsed_url['scheme'] != 'rtmps'
)
&& !empty($track->has_video)
)) {
$quality = $this->calculate_size(
$track->bitrate,
$track->duration
);

$presentation_download[$quality] = [
'url' => $track->url,
'info' => $this->getResolutionString($track->width, $track->height)
];
}
}

foreach ($episode->publications as $publication) {
if ($publication->channel == 'annotation-tool') {
$annotation_tool = $publication->url;
}
}

ksort($presenter_download);
ksort($presentation_download);
ksort($audio_download);
$new_episode = [
'id' => $episode->identifier,
'series_id' => $episode->is_part_of,
'title' => $episode->title,
'start' => $episode->start,
'duration' => $episode->duration,
'description' => $episode->description,
'author' => $episode->creator,
'preview' => $preview,
'presentation_preview' => $presentation_preview,
'presenter_download' => $presenter_download,
'presentation_download' => $presentation_download,
'audio_download' => $audio_download,
'annotation_tool' => $annotation_tool,
'has_previews' => $episode->has_previews ?: false
];
}

return $new_episode;
}

private function calculate_size($bitrate, $duration)
{
return ($bitrate / 8) * ($duration / 1000);
}

private function getResolutionString($width, $height)
{
return $width .' * '. $height . ' px';
}
}
2 changes: 2 additions & 0 deletions classes/OCRestClient/OCRestClient.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@ public static function getInstance($config_id = null)
static::$me[$config_id] = new static($config_id);
}

static::$me[$config_id]->config_id = $config_id;

return static::$me[$config_id];
}

Expand Down
3 changes: 1 addition & 2 deletions controllers/course.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ public function index_action($active_id = 'false', $upload_message = false)
$cache->write($cache_key, time(), 3600);
}

$api_client = ApiEventsClient::getInstance(OCConfig::getConfigIdForSeries($series['series_id']));
$api_client = ApiEventsClient::getInstance(OCConfig::getConfigIdForSeries($this->series_id));
$this->events = $api_client->getBySeries($this->series_id);

$occourse = new OCCourseModel($this->course_id);
Expand Down Expand Up @@ -197,7 +197,6 @@ public function index_action($active_id = 'false', $upload_message = false)
$this->coursevis = $occourse->getSeriesVisibility();

$api_events = ApiEventsClient::getInstance();
Pager::setLength($api_events->getEpisodeCount($this->series_id));

$this->ordered_episode_ids = $this->get_ordered_episode_ids();

Expand Down
129 changes: 1 addition & 128 deletions models/OCCourseModel.class.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,10 +167,9 @@ private function order_episodes_by($keys, $sort_flags, $reversed, $episodes)
return $episodes;
}

private function episodeComparison($stored_episodes, $remote_episodes)
private function episodeComparison($stored_episodes, $oc_episodes)
{
$episodes = [];
$oc_episodes = $this->prepareEpisodes($remote_episodes);

$local_episodes = [];
foreach ($stored_episodes as $episode) {
Expand Down Expand Up @@ -224,121 +223,6 @@ private function episodeComparison($stored_episodes, $remote_episodes)
return $episodes;
}

private function prepareEpisodes($oc_episodes)
{
$episodes = [];
if (is_object($oc_episodes)) {
$oc_episodes = [$oc_episodes];
}

if (is_array($oc_episodes)) foreach ($oc_episodes as $episode) {
if (!empty($episode->publications[0]->attachments)) {
$presentation_preview = false;
$preview = false;
$presenter_download = [];
$presentation_download = [];
$audio_download = [];
$annotation_tool = false;

foreach ((array) $episode->publications[0]->attachments as $attachment) {
if ($attachment->flavor === "presenter/search+preview") {
$preview = $attachment->url;
}
if ($attachment->flavor === "presentation/player+preview") {
$presentation_preview = $attachment->url;
}
}

foreach ($episode->publications[0]->media as $track) {
$parsed_url = parse_url($track->url);

if ($track->flavor === 'presenter/delivery') {
if (($track->mediatype === 'video/mp4' || $track->mediatype === 'video/avi')
&& ((in_array('atom', $track->tags) || in_array('engage-download', $track->tags))
&& $parsed_url['scheme'] != 'rtmp' && $parsed_url['scheme'] != 'rtmps')
&& !empty($track->has_video)
) {
$quality = $this->calculate_size(
$track->bitrate,
$track->duration
);
$presenter_download[$quality] = [
'url' => $track->url,
'info' => $this->getResolutionString($track->width, $track->height)
];
}

if (in_array($track->mediatype, ['audio/aac', 'audio/mp3', 'audio/mpeg', 'audio/m4a', 'audio/ogg', 'audio/opus'])
&& !empty($track->has_audio)
) {
$quality = $this->calculate_size(
$track->bitrate,
$track->duration
);
$audio_download[$quality] = [
'url' => $track->url,
'info' => round($track->audio->bitrate / 1000, 1) . 'kb/s, ' . explode('/', $track->mediatype)[1]
];
}
}

if ($track->flavor === 'presentation/delivery' && (
(
$track->mediatype === 'video/mp4'
|| $track->mediatype === 'video/avi'
) && (
(
in_array('atom', $track->tags)
|| in_array('engage-download', $track->tags)
)
&& $parsed_url['scheme'] != 'rtmp'
&& $parsed_url['scheme'] != 'rtmps'
)
&& !empty($track->has_video)
)) {
$quality = $this->calculate_size(
$track->bitrate,
$track->duration
);

$presentation_download[$quality] = [
'url' => $track->url,
'info' => $this->getResolutionString($track->width, $track->height)
];
}
}

foreach ($episode->publications as $publication) {
if ($publication->channel == 'annotation-tool') {
$annotation_tool = $publication->url;
}
}

ksort($presenter_download);
ksort($presentation_download);
ksort($audio_download);
$episodes[$episode->identifier] = [
'id' => $episode->identifier,
'series_id' => $episode->is_part_of,
'title' => $episode->title,
'start' => $episode->start,
'duration' => $episode->duration,
'description' => $episode->description,
'author' => $episode->creator,
'preview' => $preview,
'presentation_preview' => $presentation_preview,
'presenter_download' => $presenter_download,
'presentation_download' => $presentation_download,
'audio_download' => $audio_download,
'annotation_tool' => $annotation_tool,
'has_previews' => $episode->has_previews ?: false
];
}
}

return $episodes;
}

/**
* return number of new episodes since last visit up to 3 month ago
*
Expand Down Expand Up @@ -492,15 +376,4 @@ public function setWorkflowForDate($termin_id, $workflow_id)

return $stmt->execute([$workflow_id, $this->getCourseID(), $termin_id]);
}

private function calculate_size($bitrate, $duration)
{
return ($bitrate / 8) * ($duration / 1000);
}

private function getResolutionString($width, $height)
{
return $width .' * '. $height . ' px';
}

}
5 changes: 2 additions & 3 deletions views/course/index.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

use Opencast\LTI\OpencastLTI;
use Opencast\LTI\LtiLink;
use Opencast\Models\Pager;

?>

Expand Down Expand Up @@ -133,11 +134,9 @@
$sidebar = Sidebar::get();

// add search widget
/*
$search_widget = new SearchWidget($controller->url_for('course/search_episodes'));
$search_widget->addNeedle($_('Videotitel'), 'search', true, null, null, $search);
$search_widget->addNeedle($_('Videotitel'), 'search', true, null, null, Pager::getSearch());
$sidebar->addWidget($search_widget);
*/

if (OCPerm::editAllowed($course_id)) {
$actions = new LinksWidget ();
Expand Down