Rss-Bridge/bridges/TwitchApiBridge.php

118 lines
3.5 KiB
PHP
Raw Normal View History

2015-07-14 13:36:44 +02:00
<?php
2015-11-04 10:47:21 +01:00
define('TWITCH_LIMIT', 10); // The default limit
2015-07-14 13:36:44 +02:00
class TwitchApiBridge extends BridgeAbstract{
public $maintainer = "logmanoriginal";
public $name = "Twitch API Bridge";
public $uri = "http://www.twitch.tv";
public $description = "Returns the newest broadcasts or highlights by channel name using the Twitch API (v3)";
public $parameters = array(
'Show Channel Videos'=>array(
'channel'=>array(
'name'=>'Channel',
'required'=>true
),
'broadcasts'=>array(
'name'=>'Show Broadcasts rather than Highlights',
'type'=>'checkbox'
),
'limit'=>array(
'name'=>'Limit',
'type'=>'number'
)
)
);
public function collectData(){
$param=$this->parameters[$this->queriedContext];
2015-07-14 13:36:44 +02:00
/* In accordance with API description:
* "When specifying a version for a request to the Twitch API, set the Accept HTTP header to the API version you prefer."
2015-07-14 13:36:44 +02:00
* Now we prefer v3 right now and need to build the context options. */
$opts = array('https' =>
array(
'method' => 'GET',
'header' => 'Accept: application/vnd.twitchtv.v3+json'
)
);
2015-07-14 13:36:44 +02:00
$context = stream_context_create($opts);
if(!isset($param['limit']['value']) ||
empty($param['limit']['value'])){
2015-07-14 13:36:44 +02:00
$limit = TWITCH_LIMIT;
}else{
$limit = (int)$param['limit']['value'];
2015-07-14 13:36:44 +02:00
}
2015-07-14 13:36:44 +02:00
// The Twitch API allows a limit between 1 .. 100. Therefore any value below must be set to 1, any greater must result in multiple requests.
$requests=1;
2015-07-14 13:36:44 +02:00
if($limit < 1) { $limit = 1; }
if($limit > 100) {
$requests = (int)($limit / 100);
2015-07-14 13:36:44 +02:00
if($limit % 100 != 0) { $requests++; }
}
if($param['broadcasts']['value']){
$broadcasts='true';
}else{
$broadcasts='false';
}
2015-07-14 13:36:44 +02:00
// Build the initial request, see also: https://github.com/justintv/Twitch-API/blob/master/v3_resources/videos.md#get-channelschannelvideos
$request = '';
2015-07-14 13:36:44 +02:00
if($requests == 1) {
$request = 'https://api.twitch.tv/kraken/channels/' . $param['channel']['value'] . '/videos?limit=' . $limit . '&broadcasts=' . $broadcasts;
2015-07-14 13:36:44 +02:00
} else {
$request = 'https://api.twitch.tv/kraken/channels/' . $param['channel']['value'] . '/videos?limit=100&broadcasts=' . $broadcasts;
2015-07-14 13:36:44 +02:00
}
2015-07-14 13:36:44 +02:00
/* Finally we're ready to request data from the API. Each response provides information for the next request. */
for($i = 0; $i < $requests; $i++) {
$response = $this->getSimpleHTMLDOM($request, false, $context);
if($response == false) {
$this->returnServerError('Request failed! Check if the channel name is valid!');
2015-07-14 13:36:44 +02:00
}
2015-07-14 13:36:44 +02:00
$data = json_decode($response);
2015-07-14 13:36:44 +02:00
foreach($data->videos as $video) {
$item = array();
$item['id'] = $video->_id;
$item['uri'] = $video->url;
$item['title'] = htmlspecialchars($video->title);
$item['timestamp'] = strtotime($video->recorded_at);
$item['content'] = '<a href="' . $item['uri'] . '"><img src="' . $video->preview . '" /></a><br><a href="' . $item['uri'] . '">' . $item['title'] . '</a>';
2015-07-14 13:36:44 +02:00
$this->items[] = $item;
2015-07-14 13:36:44 +02:00
// Stop once the number of requested items is reached
if(count($this->items) >= $limit) {
break;
}
}
2015-07-14 13:36:44 +02:00
// Get next request (if available)
if(isset($data->_links->next)) {
$request = $data->_links->next;
} else {
break;
}
}
}
public function getName(){
$param=$this->parameters[$this->queriedContext];
return $param['channel']['value'] . ' - Twitch API Bridge';
2015-07-14 13:36:44 +02:00
}
public function getCacheDuration(){
return 10800; // 3 hours
}
}
2015-07-30 11:29:25 +02:00
?>