aboutsummaryrefslogtreecommitdiff
path: root/bridges/ARDMediathekBridge.php
blob: 972502726aeaa509bb670a17cd1c53ecfabb337a (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
<?php
class ARDMediathekBridge extends BridgeAbstract {
	const NAME = 'ARD-Mediathek Bridge';
	const URI = 'https://www.ardmediathek.de';
	const DESCRIPTION = 'Feed of any series in the ARD-Mediathek, specified by its path';
	const MAINTAINER = 'yue-dongchen';
	/*
	 * Number of Items to be requested from ARDmediathek API
	 * 12 has been observed on the wild
	 * 29 is the highest successfully tested value
	 * More Items could be fetched via pagination
	 * The JSON-field pagination holds more information on that
	 * @const PAGESIZE number of requested items
	 */
	const PAGESIZE = 29;
	/*
	 * The URL Prefix of the (Webapp-)API
	 * @const APIENDPOINT https-URL of the used endpoint
	 */
	const APIENDPOINT = 'https://api.ardmediathek.de/page-gateway/widgets/ard/asset/';
	/*
	 * The URL prefix of the video link
	 * URLs from the webapp include a slug containing titles of show, episode, and tv station.
	 * It seems to work without that.
	 * @const VIDEOLINKPREFIX https-URL prefix of video links
	 */
	const VIDEOLINKPREFIX = 'https://www.ardmediathek.de/video/';
	/*
	 * The requested width of the preview image
	 * 432 has been observed on the wild
	 * The webapp seems to also compute and add the height value
	 * It seems to works without that.
	 * @const IMAGEWIDTH width in px of the preview image
	 */
	const IMAGEWIDTH = 432;
	/*
	 * Placeholder that will be replace by IMAGEWIDTH in the preview image URL
	 * @const IMAGEWIDTHPLACEHOLDER
	 */
	const IMAGEWIDTHPLACEHOLDER = '{width}';

	const PARAMETERS = array(
		array(
			'path' => array(
				'name' => 'Show Link or ID',
				'required' => true,
				'title' => 'Link to the show page or just its alphanumeric suffix',
				'defaultValue' => 'https://www.ardmediathek.de/sendung/45-min/Y3JpZDovL25kci5kZS8xMzkx/'
			)
		)
	);

	public function collectData() {
		$oldTz = date_default_timezone_get();

		date_default_timezone_set('Europe/Berlin');

		$pathComponents = explode('/', $this->getInput('path'));
		if (empty($pathComponents)) {
			returnClientError('Path may not be empty');
		}
		if (count($pathComponents) < 2) {
			$showID = $pathComponents[0];
		} else {
			$lastKey = count($pathComponents) - 1;
			$showID = $pathComponents[$lastKey];
			if (strlen($showID) === 0) {
				$showID = $pathComponents[$lastKey - 1];
			}
		}

		$url = SELF::APIENDPOINT . $showID . '/?pageSize=' . SELF::PAGESIZE;
		$rawJSON = getContents($url);
		$processedJSON = json_decode($rawJSON);

		foreach($processedJSON->teasers as $video) {
			$item = array();
			// there is also ->links->self->id, ->links->self->urlId, ->links->target->id, ->links->target->urlId
			$item['uri'] = SELF::VIDEOLINKPREFIX . $video->id . '/';
			// there is also ->mediumTitle and ->shortTitle
			$item['title'] = $video->longTitle;
			// in the test, aspect16x9 was the only child of images, not sure whether that is always true
			$item['enclosures'] = array(
				str_replace(SELF::IMAGEWIDTHPLACEHOLDER, SELF::IMAGEWIDTH, $video->images->aspect16x9->src)
			);
			$item['content'] = '<img src="' . $item['enclosures'][0] . '" /><p>';
			$item['timestamp'] = $video->broadcastedOn;
			$item['uid'] = $video->id;
			$item['author'] = $video->publicationService->name;
			$this->items[] = $item;
		}

		date_default_timezone_set($oldTz);
	}
}