From be515f5150f20c773371f680efad58f2d0fcaaf0 Mon Sep 17 00:00:00 2001
From: Benjamin Peter
Date: Sat, 9 Dec 2017 23:44:47 +0100
Subject: Added multple translation tracks with configurable endpoints and
labels
---
index.php | 12 ++++---
model/Conferences.php | 38 ++++++++++++++++------
model/Room.php | 53 ++++++++++++++++++++++++++-----
model/RoomSelection.php | 16 ++++++----
model/Stream.php | 12 +++++--
template/assemblies/switcher/audio.phtml | 20 +++++++-----
template/assemblies/switcher/slides.phtml | 12 ++++---
template/assemblies/switcher/video.phtml | 28 +++++++++-------
view/room.php | 10 ++++--
9 files changed, 142 insertions(+), 59 deletions(-)
diff --git a/index.php b/index.php
index 3c814f9..43a704e 100644
--- a/index.php
+++ b/index.php
@@ -285,12 +285,12 @@ try {
require('view/room.php');
}
- else if(preg_match('@^([^/]+)/translated$@', $route, $m))
+ else if(preg_match('@^([^/]+)/i18n/([^/]+)$@', $route, $m))
{
$_GET = array(
'room' => $m[1],
'selection' => '',
- 'language' => 'translated',
+ 'language' => $m[2],
);
require('view/room.php');
}
@@ -305,17 +305,19 @@ try {
require('view/room.php');
}
- else if(preg_match('@^([^/]+)/(sd|audio|slides|dash)/translated$@', $route, $m))
+ else if(preg_match('@^([^/]+)/(sd|audio|slides|dash)/i18n/([^/]+)$@', $route, $m))
{
$_GET = array(
'room' => $m[1],
'selection' => $m[2],
- 'language' => 'translated',
+ 'language' => $m[3],
);
require('view/room.php');
}
- else if(preg_match('@^embed/([^/]+)/(hd|sd|audio|slides)/(native|translated|stereo)(/no-autoplay)?$@', $route, $m))
+ // TODO use dynamic i18n parameter
+ // TODO change to no-autoplay query parameter?
+ else if(preg_match('@^embed/([^/]+)/(hd|sd|audio|slides)/(native|translated|translated2|stereo)(/no-autoplay)?$@', $route, $m))
{
$_GET = array(
'room' => $m[1],
diff --git a/model/Conferences.php b/model/Conferences.php
index f7276ac..eb07327 100644
--- a/model/Conferences.php
+++ b/model/Conferences.php
@@ -72,16 +72,34 @@ class Conferences
return in_array($mandator, Conferences::listConferences());
}
- public static function loadConferenceConfig($mandator) {
- $configfile = forceslash(Conferences::MANDATOR_DIR).forceslash($mandator).'config.php';
- $config = include($configfile);
-
- if(!is_array($config)) {
- throw new ConfigException("Loading $configfile did not return an array. Maybe it's missing a return-statement?");
- }
-
- return $config;
- }
+ public static function loadConferenceConfig($mandator) {
+ $configfile = forceslash(Conferences::MANDATOR_DIR).forceslash($mandator).'config.php';
+ $config = include($configfile);
+
+ if(!is_array($config)) {
+ throw new ConfigException("Loading $configfile did not return an array. Maybe it's missing a return-statement?");
+ }
+
+ // Allow setting TRANSLATION simply to true and fill in default values for uniformity
+ $rooms = $config['ROOMS'];
+ foreach ($rooms as $slug => $room) {
+ if (!isset($room['TRANSLATION'])) {
+ $config['ROOMS'][$slug]['TRANSLATION'] = [];
+ }
+ elseif (! is_array($room['TRANSLATION'])) {
+ if ($room['TRANSLATION'] === true) {
+ $config['ROOMS'][$slug]['TRANSLATION'] = [[
+ 'endpoint' => 'translated',
+ 'label' => 'Translated'
+ ]];
+ }
+ else {
+ $config['ROOMS'][$slug]['TRANSLATION'] = [];
+ }
+ }
+ }
+ return $config;
+ }
public static function getConference($mandator) {
return new Conference(Conferences::loadConferenceConfig($mandator), $mandator);
diff --git a/model/Room.php b/model/Room.php
index 4b251cd..56dab4c 100644
--- a/model/Room.php
+++ b/model/Room.php
@@ -175,10 +175,40 @@ class Room
return 'Adaptive multi-format-multi-bitrate-Stream to rule the World!!1elf';
}
- public function hasTranslation() {
+ public function getTranslations() {
return $this->getConference()->get('ROOMS.'.$this->getSlug().'.TRANSLATION');
}
+ private function getTranslationEndpoints() {
+ return array_map(
+ function ($translation) {
+ return $translation['endpoint'];
+ },
+ $this->getTranslations()
+ );
+ }
+
+ private function isTranslationEndpoint($endpoint) {
+ return in_array($endpoint, $this->getTranslationEndpoints());
+ }
+
+ private function findTranslationLabel($language) {
+ foreach($this->getTranslations() as $translation) {
+ if ($translation['endpoint'] === $language) {
+ return $translation['label'];
+ }
+ }
+ return null;
+ }
+
+ public function hasTranslation() {
+ return count($this->getTranslations()) > 0;
+ }
+
+ public function isValidLanguage($language) {
+ return ($language === 'native' || $this->isTranslationEndpoint($language));
+ }
+
public function getSelectionNames()
{
$selections = array();
@@ -284,8 +314,9 @@ class Room
foreach ($selections as $selection) {
$streams[] = $this->createStreamObject($selection, 'native');
- if($this->hasTranslation())
- $streams[] = $this->createStreamObject($selection, 'translated');
+ foreach ($this->getTranslations() as $translation) {
+ $streams[] = $this->createStreamObject($selection, $translation['endpoint'], $translation['label']);
+ }
}
return $streams;
@@ -305,17 +336,23 @@ class Room
if(!in_array($selection, $selections))
throw new NotFoundException('Selection '.$selection.' in Room '.$this->getSlug());
- if($language == 'translated' && !$this->hasTranslation())
- throw new NotFoundException('Translated Streams of Room '.$this->getSlug());
+ $translation_label = null;
+ if (substr($language, 0, strlen('native')) !== 'native') {
+ if (!$this->hasTranslation()) {
+ throw new NotFoundException('Translated Streams of Room '.$this->getSlug());
+ }
+
+ $translation_label = $this->findTranslationLabel($language);
+ }
- return $this->createStreamObject($selection, $language);
+ return $this->createStreamObject($selection, $language, $translation_label);
}
- public function createStreamObject($selection, $language = 'native')
+ public function createStreamObject($selection, $language = 'native', $languageLabel = null)
{
if($language == 'native' && $this->hasStereo())
$language = 'stereo';
- return new Stream($this, $selection, $language);
+ return new Stream($this, $selection, $language, $languageLabel);
}
}
diff --git a/model/RoomSelection.php b/model/RoomSelection.php
index 9211c31..a83b5c6 100644
--- a/model/RoomSelection.php
+++ b/model/RoomSelection.php
@@ -18,20 +18,24 @@ class RoomSelection
return $this->selection;
}
- public function getLink()
- {
+ private function getSelectionPath() {
$path = [$this->getRoom()->getConference()->getSlug(), $this->getRoom()->getSlug()];
$selection = $this->getRoom()->getSelectionNames();
- if($selection[0] != $this->getSelection())
+ if ($selection[0] != $this->getSelection())
$path[] = $this->getSelection();
- return joinpath($path).url_params();
+ return joinpath($path);
+ }
+
+ public function getLink()
+ {
+ return $this->getSelectionPath() . url_params();
}
- public function getTranslatedLink()
+ public function getTranslatedLink($translation_endpoint)
{
- return joinpath([$this->getLink(), 'translated']);
+ return joinpath([$this->getSelectionPath(), 'i18n', $translation_endpoint]) . url_params();
}
public function getDisplay()
diff --git a/model/Stream.php b/model/Stream.php
index daed17f..a4dcf72 100644
--- a/model/Stream.php
+++ b/model/Stream.php
@@ -2,11 +2,12 @@
class Stream
{
- public function __construct(Room $room, $selection, $language)
+ public function __construct(Room $room, $selection, $language, $translation_label = null)
{
$this->room = $room;
$this->selection = $selection;
$this->language = $language;
+ $this->translation_label = (empty($translation_label)) ? $language : $translation_label;
}
public function getRoom()
@@ -24,9 +25,14 @@ class Stream
return $this->language;
}
+ public function getTranslationLabel()
+ {
+ return $this->translation_label;
+ }
+
public function isTranslated()
{
- return $this->getLanguage() == 'translated';
+ return !empty($this->getLanguage()) && $this->getLanguage() !== 'native';
}
public function getVideoSize()
@@ -98,7 +104,7 @@ class Stream
}
if($this->isTranslated())
- $display .= ' (Translation)';
+ $display .= ' ('. $this->getTranslationLabel() .')';
return $display;
}
diff --git a/template/assemblies/switcher/audio.phtml b/template/assemblies/switcher/audio.phtml
index 182572e..eab77fb 100644
--- a/template/assemblies/switcher/audio.phtml
+++ b/template/assemblies/switcher/audio.phtml
@@ -10,12 +10,14 @@
- native
+ Native
-
+ getTranslations() as $translation): ?>
+
- translated
+
+
@@ -39,12 +41,14 @@
- native
-
-
-
- translated
+ Native
+ getTranslations() as $translation): ?>
+
+
+
+
+
diff --git a/template/assemblies/switcher/slides.phtml b/template/assemblies/switcher/slides.phtml
index dfbc26d..ba70c5f 100644
--- a/template/assemblies/switcher/slides.phtml
+++ b/template/assemblies/switcher/slides.phtml
@@ -10,12 +10,14 @@
- native
-
-
-
- translated
+ Native
+ getTranslations() as $translation): ?>
+
+
+
+
+
diff --git a/template/assemblies/switcher/video.phtml b/template/assemblies/switcher/video.phtml
index 3877128..ae2815f 100644
--- a/template/assemblies/switcher/video.phtml
+++ b/template/assemblies/switcher/video.phtml
@@ -12,18 +12,20 @@
- native
-
-
-
- translated
+ Native
+ getTranslations() as $translation): ?>
+
+
+
+
+
- video
+ Video
@@ -51,18 +53,20 @@
- native
-
-
-
- translated
+ Native
+ getTranslations() as $translation): ?>
+
+
+
+
+
- video
+ Video
diff --git a/view/room.php b/view/room.php
index d586248..c63f9ec 100644
--- a/view/room.php
+++ b/view/room.php
@@ -1,8 +1,14 @@
getRoom($_GET['room']);
-$stream = $room->selectStream(
- $_GET['selection'], $_GET['language']);
+$selection = $_GET['selection'];
+$language = $_GET['language'];
+
+if (! $room->isValidLanguage($language)) {
+ throw new NotFoundException('Language not found');
+}
+
+$stream = $room->selectStream($selection, $language);
echo $tpl->render(array(
'page' => 'room',
--
cgit v1.2.3