Api
Version
mediamosa-30Class
mediamosa_rest_call_oembed_getCode
File: /sites/all/modules/mediamosa/modules/oembed/mediamosa_oembed.rest.class.inc
<?php?php
// $Id$
/**
* MediaMosa is Open Source Software to build a Full Featured, Webservice
* Oriented Media Management and Distribution platform (http://mediamosa.org)
*
* Copyright (C) 2011 SURFnet BV (http://www.surfnet.nl) and Kennisnet
* (http://www.kennisnet.nl)
*
* MediaMosa is based on the open source Drupal platform and
* was originally developed by Madcap BV (http://www.madcap.nl)
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation.
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, you can find it at:
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
*/
/**
* @file
* oEmbed rest calls.
*/
/**
* URI: /services/oembed
* Method: GET
*/
class mediamosa_rest_call_oembed_get extends mediamosa_rest_call {
// ------------------------------------------------------------------ Consts.
// Rest vars;
const MEDIAFILE_ID = 'mediafile_id';
const STILL_ID = 'still_id';
const MAXWIDTH = 'maxwidth';
const MAXHEIGHT = 'maxheight';
const FORMAT = 'format';
const FORMAT_XML = 'xml';
const FORMAT_JSON = 'json';
const PROVIDER_NAME = 'provider_name';
const PROVIDER_URL = 'provider_url';
// Types.
const TYPE_VIDEO = 'video';
const TYPE_PHOTO = 'photo';
const TYPE_LINK = 'link';
const TYPE_RICH = 'rich';
// ------------------------------------------------------------------ Functions (public).
public function get_var_setup() {
$var_setup = array(
self::VARS => array(
self::MEDIAFILE_ID => array(
self::VAR_TYPE => mediamosa_sdk::TYPE_MEDIAFILE_ID,
self::VAR_DESCRIPTION => 'The ID of the mediafile to retrieve.',
self::VAR_IS_REQUIRED => self::VAR_IS_REQUIRED_NO,
),
self::STILL_ID => array(
self::VAR_TYPE => mediamosa_sdk::TYPE_STILL_ID,
self::VAR_DESCRIPTION => 'Default this specific still.',
self::VAR_IS_REQUIRED => self::VAR_IS_REQUIRED_NO,
),
self::MAXWIDTH => array(
self::VAR_TYPE => mediamosa_sdk::TYPE_INT,
self::VAR_DESCRIPTION => 'The maximum width of the embedded resource.',
self::VAR_RANGE_START => 0,
),
self::MAXHEIGHT => array(
self::VAR_TYPE => mediamosa_sdk::TYPE_INT,
self::VAR_DESCRIPTION => 'The maximum height of the embedded resource.',
self::VAR_RANGE_START => 0,
),
self::FORMAT => array(
self::VAR_TYPE => mediamosa_sdk::TYPE_RESPONSE_TYPE,
self::VAR_DESCRIPTION => 'The required response format.',
self::VAR_ALLOWED_VALUES => array(
self::FORMAT_XML,
self::FORMAT_JSON,
),
self::VAR_DEFAULT_VALUE => self::FORMAT_JSON,
),
self::PROVIDER_NAME => array(
self::VAR_TYPE => mediamosa_sdk::TYPE_STRING,
self::VAR_DESCRIPTION => 'Name of the provider.',
),
self::PROVIDER_URL => array(
self::VAR_TYPE => mediamosa_sdk::TYPE_STRING,
self::VAR_DESCRIPTION => 'URL of the provider.',
),
)
);
// Enrich with required REST vars.
return self::get_var_setup_default($var_setup, FALSE);
}
/**
* Process the supplied parameters.
*
* @param array $var_setup
*/
protected function process_rest_args(array $var_setup) {
parent::process_rest_args($var_setup);
$format = ($this->get_param_value(self::FORMAT) == self::FORMAT_JSON ? mediamosa_response::RESPONSE_TYPE_JSON_OEMBED : mediamosa_response::RESPONSE_TYPE_XML_OEMBED);
$this->rest_args[self::FORMAT][self::PARAM_ALLOWED_VALUES] = array(
mediamosa_response::RESPONSE_TYPE_JSON_OEMBED,
mediamosa_response::RESPONSE_TYPE_XML_OEMBED,
);
// Change the input value to the response value.
$this->set_param_value(self::FORMAT, $format);
return $var_setup;
}
/**
* Get the details of asset and mediafile.
* Common function for response video and photo.
*
* @param string $mediafile_id
* @param string $user_id
* @param string $group_id
* @param $acl_domain
* @param $acl_realm
* @param boolean $is_app_admin
* @param $play_call
*
* @return array($mediafile, $asset_id, $asset_metadata, $title, $author_name, $ticket)
*/
private function get_asset_mediafile_details($mediafile_id, $user_id = NULL, $group_id = NULL, $acl_domain = NULL, $acl_realm = NULL, $is_app_admin = FALSE, $play_call = TRUE) {
$app_ids = $this->get_param_value_app();
// Get the 1st app.
$app_id = reset($app_ids);
// Get the mediafile.
$mediafile = mediamosa_asset_mediafile::must_exists($mediafile_id, $app_id);
$asset_id = $mediafile[mediamosa_asset_mediafile_db::ASSET_ID];
$asset_metadata = mediamosa_asset_metadata::metadata_get($asset_id);
// Test if access on unappropriate flag.
mediamosa_asset::is_unappropriate($asset_id, $app_ids, $user_id, $is_app_admin, $play_call);
// Check access.
mediamosa_acl::access_check_on_object(
mediamosa_acl::ACL_TYPE_MEDIAFILE,
$asset_id,
$mediafile_id,
$app_id,
$user_id,
$group_id,
$acl_domain,
$acl_realm,
$is_app_admin
);
$title = (empty($asset_metadata['dublin_core']['title']['values']) ? '' : implode(', ', $asset_metadata['dublin_core']['title']['values']));
$author_name = $mediafile[mediamosa_asset_mediafile_db::OWNER_ID];
// Create ticket ID.
$ticket = mediamosa_db::uuid($app_id);
return array($mediafile, $asset_id, $asset_metadata, $title, $author_name, $ticket);
}
// ------------------------------------------------------------------ Do Call.
public function do_call() {
$mediamosa = mediamosa::get();
$app_ids = $this->get_param_value_app();
// Get the 1st app.
$app_id = reset($app_ids);
// Get params.
$mediafile_id = $this->get_param_value(self::MEDIAFILE_ID);
$still_id = $this->get_param_value(self::STILL_ID);
$maxwidth = $this->get_param_value(self::MAXWIDTH);
$maxheight = $this->get_param_value(self::MAXHEIGHT);
$provider_name = $this->get_param_value(self::PROVIDER_NAME);
$provider_url = $this->get_param_value(self::PROVIDER_URL);
// Variables.
$user_id = NULL;
$group_id = NULL;
$acl_domain = NULL;
$acl_realm = NULL;
$is_app_admin = FALSE;
$play_call = TRUE;
$type = NULL;
$title = '';
$author_name = '';
$still_url = NULL;
$still_width = NULL;
$still_height = NULL;
$html = NULL;
$url = NULL;
$width = NULL;
$height = NULL;
$output = array();
if ($mediafile_id) {
// Mediafile.
$type = self::TYPE_VIDEO;
// Variables.
$response_type = mediamosa_asset_mediafile_play_proxy::RESPONSE_OBJECT;
// Check if allowed to play.
mediamosa_asset_mediafile_metadata::is_playable($mediafile_id);
// Now get the mediafile.
list($mediafile, $asset_id, $asset_metadata, $title, $author_name, $ticket) = $this->get_asset_mediafile_details($mediafile_id, $user_id, $group_id, $acl_domain, $acl_realm, $is_app_admin, $play_call);
// Get the metadata.
$mediafile['metadata'] = mediamosa_asset_mediafile_metadata::get_with_mediafileid($mediafile_id);
$filename = mediamosa_configuration_storage::mediafile_filename_get($mediafile);
if (empty($mediafile[mediamosa_asset_mediafile_db::URI]) && file_exists($filename)) {
$ticket = mediamosa_ticket::create_play_proxy($ticket, $mediafile, $response_type, $app_id, $user_id, $still_id);
$response = mediamosa_asset_mediafile_play_proxy::create_response(
$response_type,
$app_id,
$ticket,
$asset_id,
TRUE,
($maxwidth ? $maxwidth : 0),
($maxheight ? $maxheight : 0),
NULL,
NULL,
FALSE,
$asset_metadata,
$mediafile,
array()
);
$html = $response['output'];
$video_size = mediamosa_asset_mediafile_play_proxy::calc_video_size(
isset($mediafile['metadata']['width']) ? $mediafile['metadata']['width'] : 0,
isset($mediafile['metadata']['height']) ? $mediafile['metadata']['height'] : 0,
$maxwidth,
$maxheight,
isset($mediafile['metadata']['container_type']) ? $mediafile['metadata']['container_type'] : self::CONTAINER_TYPE_WMV
);
$width = ($video_size['width'] ? $video_size['width'] : $maxwidth);
$height = ($video_size['height'] ? $video_size['height'] : $maxheight);
}
}
elseif ($still_id) {
// Still.
$type = self::TYPE_PHOTO;
// Variables.
$response_type = mediamosa_asset_mediafile_play_proxy::RESPONSE_STILL;
// Now get the still.
$still = mediamosa_asset_mediafile::must_exists($still_id, $app_id);
$mediafile_id = $still[mediamosa_asset_mediafile_db::MEDIAFILE_ID_SOURCE];
list($mediafile, $asset_id, $asset_metadata, $title, $author_name, $ticket) = $this->get_asset_mediafile_details($mediafile_id, $user_id, $group_id, $acl_domain, $acl_realm, $is_app_admin, $play_call);
// Generate ticket or perm link?
$ticket = mediamosa_asset_mediafile_still::is_still_permanent($still_id, $is_app_admin) ? $still_id : mediamosa_ticket::TICKET_PATH . mediamosa_ticket::create_play_proxy($ticket, $mediafile, $response_type, $app_id, $user_id, $still_id);
// Create the response.
$response = mediamosa_asset_mediafile_play_proxy::create_response(
$response_type,
$app_id,
$ticket,
$asset_id,
TRUE,
($maxwidth ? $maxwidth : 0),
($maxheight ? $maxheight : 0),
NULL,
NULL,
FALSE,
$asset_metadata,
$mediafile,
array()
);
$url = $response['output'];
$width = mediamosa_asset_mediafile_metadata::get_mediafile_metadata_int($still_id, 'width');
$height = mediamosa_asset_mediafile_metadata::get_mediafile_metadata_int($still_id, 'height');
}
else {
throw new mediamosa_exception_error_501();
}
// Collect the data for output.
$output += array(
'type' => $type,
'version' => '1.0',
'title' => $title,
'author_name' => $author_name,
//'author_url' => NULL,
//'cache_age' => NULL,
'provider_name' => (!empty($provider_name) && $provider_name ? $provider_name : 'MediaMosa'),
'provider_url' => (!empty($provider_url) && $provider_url ? $provider_url : 'http://mediamosa.org/'),
);
if (!empty($still_url)) {
$output['still_url'] = $still_url;
$output['still_width'] = $still_width;
$output['still_height'] = $still_height;
}
if (!empty($html)) {
$output['html'] = $html;
}
if (!empty($url)) {
$output['url'] = $url;
}
if (!empty($width)) {
$output['width'] = $width;
}
if (!empty($height)) {
$output['height'] = $height;
}
$mediamosa->add_item($output);
}
}
