* Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
*/
+GalleryCoreApi::requireOnce('modules/gd/classes/GdToolkitHelper.class');
+
+
/**
* This plugin will handle the addition of embedded video objects
* @package embedVideo
/* Store any Parameters into some simpler, shorter, local variables */
global $debugOutput, $useInternalFlvPlayer, $youtubeDevId;
global $width, $height, $externalFlvPlayer, $externalFlvPlayerVars;
- global $flvThumbnail;
+ global $flvThumbnail, $useRemoteSize, $autoStart;
+ global $watermarkVideos, $watermarkImage;
- $debugOutput = $this->getParameter($ItemAddEmbedVideo, 'debugOutput');
- $useInternalFlvPlayer = $this->getParameter($ItemAddEmbedVideo, 'useInternalFlvPlayer');
- $youtubeDevId = $this->getParameter($ItemAddEmbedVideo, 'youtubeDevId');
- $width = $this->getParameter($ItemAddEmbedVideo, 'width');
- $height = $this->getParameter($ItemAddEmbedVideo, 'height');
- $externalFlvPlayer = $this->getParameter($ItemAddEmbedVideo, 'externalFlvPlayer');
- $externalFlvPlayerVars = $this->getParameter($ItemAddEmbedVideo, 'externalFlvPlayerVars');
- $flvThumbnail = $this->getParameter($ItemAddEmbedVideo, 'flvThumbnail');
+ /* Find out what value our parameters should have by looking to see if they
+ * are defined in our overrides section or default section. If they are not
+ * defined in either of these 2 places, pass in a default value to set them to
+ */
+ $debugOutput = $this->getParameter($ItemAddEmbedVideo, 'debugOutput', "false");
+ $useInternalFlvPlayer = $this->getParameter($ItemAddEmbedVideo, 'useInternalFlvPlayer', "true");
+ $youtubeDevId = $this->getParameter($ItemAddEmbedVideo, 'youtubeDevId', "");
+ $youtubeShowRelated = $this->getParameter($ItemAddEmbedVideo, 'youtubeShowRelated', "false");
+ $width = $this->getParameter($ItemAddEmbedVideo, 'width', "320");
+ $height = $this->getParameter($ItemAddEmbedVideo, 'height', "240");
+ $externalFlvPlayer = $this->getParameter($ItemAddEmbedVideo, 'externalFlvPlayer', "");
+ $externalFlvPlayerVars = $this->getParameter($ItemAddEmbedVideo, 'externalFlvPlayerVars', "");
+ $flvThumbnail = $this->getParameter($ItemAddEmbedVideo, 'flvThumbnail', "");
+ $useRemoteSize = $this->getParameter($ItemAddEmbedVideo, 'useRemoteSize', "false");
+ $autoStart = $this->getParameter($ItemAddEmbedVideo, 'autoStart', "false");
+ $watermarkImage = $this->getParameter($ItemAddEmbedVideo, 'watermarkImage', "");
+ $watermarkVideos = $this->getParameter($ItemAddEmbedVideo, 'watermarkVideos', "false");
+
+ /* Print our stored/set Parameters */
+ if(!strcmp($debugOutput,"true")) {
+ print "<hr>";
+ print "<h2>Variable Parameters</h2>";
+ print "debugOutput=$debugOutput<br>";
+ print "useInternalFlvPlayer=$useInternalFlvPlayer<br>";
+ print "youtubeDevId=$youtubeDevId<br>";
+ print "youtubeShowRelated=$youtubeShowRelated<br>";
+ print "width=$width<br>";
+ print "height=$height<br>";
+ print "externalFlvPlayer=$externalFlvPlayer<br>";
+ print "externalFlvPlayerVars=$externalFlvPlayerVars<br>";
+ print "flvThumbnail=$flvThumbnail<br>";
+ print "useRemoteSize=$useRemoteSize<br>";
+ print "autoStart=$autoStart<br>";
+ print "watermarkVideos=$watermarkVideos<br>";
+ print "watermarkImage=$watermarkImage<br>";
+ print "<hr>";
+ }
/* Store other string constants we'll use later */
/* youtube */
$youtubeUrlPattern="youtube.com";
$youtubeApiUrl="http://www.youtube.com/api2_rest";
+ /* We can't extract the server size from youtube */
+ $youtubeWidth="425";
+ $youtubeHeight="350";
/* google */
$googleUrlPattern="video.google.com";
$googlePlayer="http://video.google.com/googleplayer.swf";
-
+ /* We can't extract the server size from google video */
+ $googleWidth="400";
+ $googleHeight="326";
+
/* yahoo */
$yahooUrlPattern="video.yahoo.com";
$yahooThumbnailUrl="http://thmg01.video.search.yahoo.com/image/";
/* Gallery2 specific paths and variables */
$urlGenerator =& $gallery->getUrlGenerator();
$gallery2_url = $urlGenerator->getCurrentUrlDir();
- $gallery2_flv_thumbnail = "modules/thumbnail/images/G2video.jpg";
+ $gallery2_flv_thumbnail = "modules/embedvideo/images/G2video_thumbnail.jpg";
+ $gallery2_video_watermark = "modules/embedvideo/images/G2video_watermark1.png";
$gallery2_flv_player = "modules/flashvideo/lib/G2flv.swf";
/* Store the passed URL in a shorter local variable */
"Unable to get video information at url: $url - $response"),null,null);
}
-
+ if(preg_match("/This video is private/",$xml)) {
+ return array(GalleryCoreApi::error(ERROR_BAD_PARAMETER,__FILE__,__LINE__,
+ "Unable to retrieve video information from youtube.".
+ "You cannot embed a private youtube video: $url"),null,null);
+ }
+
if(!strcmp($debugOutput,"true")) {
+ print "<h2>Youtube XML Dump</h2>";
print "$xml";
+ print "<hr>";
}
/* Extract certain information from the xml feed */
$summary = $description[0][0];
$thumbnail = $thumbnail[0][0];
+ /* Determine what our width and height should be based on our useRemoteSize parameter */
+ if(!strcmp($useRemoteSize,"true")) {
+ $width = $youtubeWidth;
+ $height = $youtubeHeight;
+ }
+
+ /* Determine if the video should autoplay or not based on the autoStart parameter */
+ $autoStartStr="";
+ if(!strcmp($autoStart,"true")) {
+ $autoStartStr="&autoplay=1";
+ }
+
+ /* Determine if the video should show related videos or not based on the youtubeShowRelated parameter */
+ $youtubeShowRelatedStr="";
+ if(!strcmp($youtubeShowRelated,"false")) {
+ $youtubeShowRelatedStr="&rel=0";
+ }
+
/* Format the description to hold a reference to the embedded video */
$description = '<object width="'.$width.'" height="'.$height.'">';
$description.= '<param name="movie" ';
$description.= 'value="http://www.youtube.com/v/'.$video_id.'"></param>';
$description.= '<param name="wmode" value="transparent"></param>';
- $description.= '<embed src="http://www.youtube.com/v/'.$video_id.'" ';
- $description.= 'type="application/x-shockwave-flash" wmode="transparent" ';
+ $description.= '<embed src="http://www.youtube.com/v/';
+ $description.= $video_id.$autoStartStr.$youtubeShowRelatedStr;
+ $description.= '" type="application/x-shockwave-flash" wmode="transparent" ';
$description.= 'width="'.$width.'" height="'.$height.'"></embed></object>';
$description.= "<br>$summary";
}
/* Extract the summary from the webpage contents */
- preg_match('/<meta content="(.+?)\. \w+ \d+, \d+.*" name="description">/i',
+ //print "contents: $contents <br>";
+ preg_match('/<meta name="description" content="(.+?)\. \w+ \d+, \d+.*">/i',
$contents, $matches);
$summary=$matches[1];
$thumbnail=$matches[1];
$thumbnail=preg_replace("/offsetms=0/","offsetms=0",$thumbnail);
+ /* Determine what our width and height should be based on our useRemoteSize parameter */
+ if(!strcmp($useRemoteSize,"true")) {
+ $width = $googleWidth;
+ $height = $googleHeight;
+ }
+
+ /* Determine if the video should autoplay or not based on the autoStart parameter */
+ $autoStartStr="";
+ if(!strcmp($autoStart,"true")) {
+ $autoStartStr="&autoplay=1";
+ }
+
/* Format the description to hold a reference to the embedded video */
- $description = '<embed FlashVars="autoPlay=true" ';
+ $description = '<embed ';
$description.= 'style="width:'.$width.'px; height:'.$height.'px;" id="VideoPlayback" ';
$description.= 'type="application/x-shockwave-flash" ';
- $description.= 'src="'.$googlePlayer.'?docId='.$doc_id.'"> ';
+ $description.= 'src="'.$googlePlayer.'?docId='.$doc_id.$autoStartStr.'" flashvars=""> ';
$description.= '</embed>';
$description.= "<br>$summary";
**********************************
* Embed a Yahoo Video
**********************************
+ * TODO: The autoStart parameter doesn't work with the yahoo video player
*/
} else if(preg_match("/$yahooUrlPattern/",$url)) {
/* Format the description to hold a reference to the embedded video */
preg_match('/(<embed src.+?<\/embed>)/', $contents, $matches);
$description=$matches[1];
- $description=preg_replace("/width='\d+'/","width='".$width."'",$description);
- $description=preg_replace("/height='\d+'/","height='".$height."'",$description);
+ if(!strcmp($useRemoteSize,"false")) {
+ $description=preg_replace("/width='\d+'/","width='".$width."'",$description);
+ $description=preg_replace("/height='\d+'/","height='".$height."'",$description);
+ }
$description.= "<br>$summary";
/*
preg_match('/(embed src.+?\/embed)/', $contents, $matches);
$description="<".$matches[1];
$description=preg_replace("/"/","'",$description);
- $description=preg_replace("/width='\d+'/","width='".$width."'",$description);
- $description=preg_replace("/height='\d+'/","height='".$height."'",$description);
+ if(!strcmp($useRemoteSize,"false")) {
+ $description=preg_replace("/width='\d+'/","width='".$width."'",$description);
+ $description=preg_replace("/height='\d+'/","height='".$height."'",$description);
+ }
+ if(!strcmp($autoStart,"true")) {
+ $description=preg_replace("/\.swf/",".swf?playerVars=autoPlay=yes",$description);
+ }
$description.= "</embed>";
$description.= "<br>$summary";
-
+
+
+ /*
+ **********************************
+ * Embed a remote .swf file
+ **********************************
+ */
+ } else if(preg_match("/.*\/(.+?)\.swf/i",$url,$matches)) {
+
+ /* Set the title and summary to the name of the file */
+ $title = $matches[1];
+ $summary = $matches[1];
+
+ /*
+ * Set the thumbnail to some generic jpg image,
+ * since we can't extract it from the remote swf file.
+ * If no parameter is set, set it to a default value.
+ */
+ if(preg_match("/\w+/", $flvThumbnail)) {
+ $thumbnail = $flvThumbnail;
+ } else {
+ $thumbnail = $gallery2_url.$gallery2_flv_thumbnail;
+ }
+
+ /*
+ * Check to make sure the URL to the remote swf file is valid
+ * (That the file exists at the URL given)
+ */
+ list ($successfullyCopied, $response, $headers) =
+ $this->fetchWebFileHeaders($url, $extraHeaders);
+ if (!$successfullyCopied) {
+ return array(GalleryCoreApi::error(ERROR_BAD_PATH,__FILE__,__LINE__,
+ "Unable to find the video at url: $url - $response"),NULL,NULL);
+ }
+
+ /*
+ * Format the description to hold a reference to the embedded video
+ */
+
+ /* Format the description to hold a reference to the embedded video */
+ $description ='<embed src="'.$url.'">';
+
/*
**********************************
* Embed a remote .flv file
if(!preg_match("/\w+/",$externalFlvPlayerVars)) {
/* Format the flashvars for the internal G2 flv player */
- $description.= '&showdigits=true&autostart=false&showfsbutton=true&';
+ $description.= '&showdigits=true&autostart='.$autoStart.'&showfsbutton=true&';
$description.= '&repeat=false&lightcolor=0x9999FF';
$description.= '&backcolor=0x888888&frontcolor=0x000000"';
} else {
$description.= '<param name="movie" value="'.$gallery2_url.$gallery2_flv_player.'"/>';
$description.= '<param name="FlashVars" value="flvUrl='.$url;
$description.= '&Width='.$width.'&Height='.$height.'&title='.$title;
- $description.= '&allowDl=true&thumbUrl='.$thumbnail;
+ $description.= '&allowDl=true&thumbUrl='.$thumbnail.'&autoStart='.$autoStart;
$description.= '&langDownload=Download&langLarge=Large&langNormal=Normal"/>';
$description.= '<param name="quality" value="high"/>';
$description.= '<param name="scale" value="noscale"/>';
$description.= '<embed src="'.$gallery2_url.$gallery2_flv_player.'" ';
$description.= 'flashvars="flvUrl='.$url;
$description.= '&Width='.$width.'&Height='.$height.'&title='.$title;
- $description.= '&allowDl=true&thumbUrl='.$thumbnail;
+ $description.= '&allowDl=true&thumbUrl='.$thumbnail.'&autoStart='.$autoStart;
$description.= '&langDownload=Download&langLarge=Large&langNormal=Normal" ';
$description.= 'type="application/x-shockwave-flash" ';
$description.= 'width="100%" height="100%" quality="high" scale="noscale" salign="lt" ';
$tmpDir = $gallery->getConfig('data.gallery.tmp');
$tmpFile = $platform->tempnam($tmpDir, 'add');
$tmpFile.= ".jpg";
-
- if(!strcmp($debugOutput,"true")) {
- print "thumbnail: $thumbnail <br>";
- }
-
+
/* Fetch the thumbnail and save it to a local file */
list ($successfullyCopied, $response, $headers) =
GalleryCoreApi::fetchWebFile($thumbnail, $tmpFile, $extraHeaders);
if (!$successfullyCopied) {
return array(GalleryCoreApi::error(ERROR_STORAGE_FAILURE,__FILE__,__LINE__,
- "Unable to copy thumbnail from url: $url - $response"),null,null);
+ "Unable to copy thumbnail from url: $thumbnail - $response"),null,null);
}
/* Obtain the mimeType of the thumbnail */
/* General debug output */
if(!strcmp($debugOutput,"true")) {
+ print "<h2>Item Parameters</h2>";
+ print "url: $url <br>";
print "title: $title <br>";
- print "<p><a href=\"".$title."\" target=\"_blank\">";
- print "<img src=\"".$thumbnail."\">\n</a>".$summary."</p>";
- print "<p>$description</p>";
+ print "thumbnailUrl: <img src=\"".$thumbnail."\">\n</a>".$summary."</p>";
+ print "description: <p>$description</p>";
print "thumbnail: $tmpFile <br>";
print "mimeType: $mimeType <br>";
print "fileName: $fileName <br>";
- print "<br><br><b>Video Successfully Added to your Gallery Album</b><br><br>";
+ print "width: $width <br>";
+ print "height: $height <br>";
+ print "<hr>";
+ }
+
+ /* Resize the thumbnail image to the size indicated by our album */
+ $debugString="";
+ list ($ret, $toolkit) = GalleryCoreApi::getToolkitByOperation($mimeType, 'resize');
+ if (!$ret) {
+ $debugString.="Checking to see if a toolkit that can resize images was found. <br>";
+ if (isset($toolkit)) {
+ $newTmpFile = $platform->tempnam($tmpDir, 'add');
+ $newTmpFile.= ".jpg";
+ $thumbnailSize = 150;
+ list ($ret, $preferences) =
+ GalleryCoreApi::fetchDerivativePreferencesForItem($item->getId());
+ if(!$ret) {
+ foreach ($preferences as $preference) {
+ if (preg_match('/thumbnail\|(\d+)/',
+ $preference['derivativeOperations'], $matches)) {
+ $thumbnailSize = $matches[1];
+ $debugString.="Found thumbnail size in album preferences: $thumbnailSize <br>";
+ break;
+ }
+ }
+ }
+
+ // Obtain the width and height of the original thumbnail, finding out it's ratio,
+ // and using that ratio when determining the width of the video below.
+ // Example: youtube: 130x97 google: 160x120 metacafe: 90x76 yahoo: 100x70
+ // Set the thumbnailHeight to the current thumbnailSize
+ // Set the thumbnailWidth to the appropriate size based on the thumbnailHeight * ratio
+ $image_data = @getimagesize($tmpFile);
+ if(!$image_data) {
+ return array(GalleryCoreApi::error(ERROR_STORAGE_FAILURE,__FILE__,__LINE__,
+ "Unable to retrieve thumbnail dimensions for: $tmpFile"),null,null);
+ }
+ $ratio = $image_data[0] / $image_data[1];
+ $debugString.="Using ratio from original thumbnail of $ratio. ";
+ $thumbnailHeight=$thumbnailSize;
+ $thumbnailWidth=round($thumbnailHeight * $ratio);
+ $debugString.="Resizing thumbnail image to $thumbnailWidth x $thumbnailHeight: $tmpFile -> $newTmpFile <br>";
+ $toolkit->performOperation($mimeType, 'resize', $tmpFile, $newTmpFile,
+ array($thumbnailWidth,$thumbnailHeight));
+ }
}
+ if(!strcmp($debugOutput,"true")) {
+ print "<h2>Thumbnail Resize</h2>";
+ print "$debugString";
+ print "<hr>";
+ }
+
+ /* Watermark the video thumbnail image if indicated by our parameter */
+ if(!strcmp($watermarkVideos,"true")) {
+
+ /*
+ * If no watermarkImage parameter is set, set it to a default value.
+ */
+ if(preg_match("/\w+/", $watermarkImage)) {
+ $watermarkImage = $watermarkImage;
+ } else {
+ $watermarkImage = $gallery2_url.$gallery2_video_watermark;
+ }
+ /* Get the watermark Image Extension */
+ preg_match('/\.(...)$/', $watermarkImage, $matches);
+ $watermarkExt=$matches[1];
+
+ /*
+ * Check to make sure the URL to the watermark image file is valid
+ * (That the file exists at the URL given)
+ */
+ list ($successfullyCopied, $response, $headers) =
+ $this->fetchWebFileHeaders($watermarkImage, $extraHeaders);
+ if (!$successfullyCopied) {
+ return array(GalleryCoreApi::error(ERROR_BAD_PATH,__FILE__,__LINE__,
+ "Unable to find the watermark image at url: $watermarkImage - $response"),NULL,NULL);
+ }
+
+ /* Download the watermark image to a local file */
+ $tmpDir = $gallery->getConfig('data.gallery.tmp');
+ $watermark = $platform->tempnam($tmpDir, 'wmk_img_');
+ $watermark.= "." . $watermarkExt;
+ list ($successfullyCopied, $response, $headers) =
+ GalleryCoreApi::fetchWebFile($watermarkImage, $watermark, $extraHeaders);
+ if (!$successfullyCopied) {
+ return array(GalleryCoreApi::error(ERROR_STORAGE_FAILURE,__FILE__,__LINE__,
+ "Unable to copy watermark image from url: $watermarkImage - $response"),null,null);
+ }
+
+ /* See if there is a toolkit installed that can perform a composite operation */
+ list ($ret, $toolkit) = GalleryCoreApi::getToolkitByOperation($mimeType, 'composite');
+ if ($ret) {
+ return array($ret->wrap(__FILE__, __LINE__,
+ "Unable to locate a toolkit module to perform the 'composite' watermark operation"), null);
+ }
+
+ /* Make sure we can access the toolkit found */
+ if (!isset($toolkit)) {
+ return array(GalleryStatus::error(ERROR_PERMISSION_DENIED, __FILE__, __LINE__,
+ "Unable to access the toolkit module to perform the 'composite' watermark operation"), null);
+ }
+
+ /* Get the image dimensions of the thumbnail */
+ $image_data = @getimagesize($newTmpFile);
+ if(!$image_data) {
+ return array(GalleryCoreApi::error(ERROR_STORAGE_FAILURE,__FILE__,__LINE__,
+ "Unable to retrieve thumbnail dimensions for: $tmpFile"),null,null);
+ }
+ $thumbnailWidth = $image_data[0];
+ $thumbnailHeight = $image_data[1];
+
+ /* Get the image dimensions of the watermark */
+ $image_data = @getimagesize($watermark);
+ if(!$image_data) {
+ return array(GalleryCoreApi::error(ERROR_STORAGE_FAILURE,__FILE__,__LINE__,
+ "Unable to retrieve watermark dimensions for: $tmpFile"),null,null);
+ }
+ $watermarkWidth = $image_data[0];
+ $watermarkHeight = $image_data[1];
+
+ /* Obtain the mimeType of the watermark */
+ list ($ret, $watermarkMimeType) = GalleryCoreApi::getMimeType($watermark);
+
+ /* Remove the gallery base path from the watermark image path */
+ /* This has to be done to satisfy the argument requirement for the toolkit operation */
+ $dataDir = $gallery->getConfig('data.gallery.base');
+ $dataDir=preg_replace("/\//","\\/",$dataDir);
+ preg_match("/$dataDir(.*)/", $watermark, $matches);
+ $watermark = $matches[1];
+
+ /* General debug output */
+ if(!strcmp($debugOutput,"true")) {
+ print "<h2>Watermark Operation</h2>";
+ print "watermarkImage: $watermarkImage <br>";
+ print "watermarkTmpImage: $watermark <br>";
+ print "watermarkMimeType: $watermarkMimeType <br>";
+ print "watermarkWidth: $watermarkWidth <br>";
+ print "watermarkHeight: $watermarkHeight <br>";
+ print "watermarkedWidth: $thumbnailWidth <br>";
+ print "watermarkedHeight: $thumbnailHeight <br>";
+ }
+
+ /* Apply the watermark image to the thumbnail */
+ $tmpFile = $platform->tempnam($tmpDir, 'wmk_');
+ list ($ret, $mimeType) = $toolkit->performOperation(
+ $mimeType, 'composite', $newTmpFile, $tmpFile,
+ array($watermark, $watermarkMimeType,
+ $watermarkWidth, $watermarkHeight,
+ 'bottom-left', 0, 0));
+
+ /* Check the return code of the composite operation */
+ if ($ret) {
+ return array($ret->wrap(__FILE__, __LINE__,
+ "Unable to apply watermark to the video thumbnail image"), null);
+ }
+
+ if(!strcmp($debugOutput,"true")) {
+ print "watermarked Image: $tmpFile <br>";
+ print "<hr>";
+ }
+
+ /* Update the path of our thumbnail to point to the new watermarked thumbnail instead */
+ $newTmpFile = $tmpFile;
+
+ }
+
/* Make the gallery2 call to add this item to the album */
- list ($ret, $newItem) = GalleryCoreApi::addItemToAlbum($tmpFile,
+ list ($ret, $newItem) = GalleryCoreApi::addItemToAlbum($newTmpFile,
$fileName,
$title,
$summary,
$status['addedFiles'][] = array('fileName' => $url,
'id' => $newItem->getId(),
'warnings' => array());
+
+ if(!strcmp($debugOutput,"true")) {
+ print "<br><br><h2>Video Successfully Added to your Gallery Album</h2><br><br><hr>";
+ }
+ }
+
+ /* Keep the tmpfiles around if we are in debug mode. Otherwise, remove them. */
+ if(!strcmp($debugOutput,"false")) {
+ @$platform->unlink($tmpFile);
+ @$platform->unlink($newTmpFile);
}
- @$platform->unlink($tmpFile);
+
}
return array(null, $error, $status);
/**
* A simple function to resolve the value of a parameter from
- * the default or override value if it exists.
+ * the default or override value if it exists, or set it
+ * to the default passed as an argument.
*/
- function getParameter($params, $name) {
+ function getParameter($params, $name, $default="") {
if(isset($params['override'][$name])) {
+ /* print "override $name = ".$params['override'][$name]."<br>"; */
return($params['override'][$name]);
- } else {
+ } else if(isset($params['default'][$name])) {
+ /* print "default $name = ".$params['default'][$name] ."<br>"; */
return($params['default'][$name]);
+ } else {
+ /* print "$name = $default <br>"; */
+ return($default);
}
}
/**
* A simple function to get the headers only (no body) for a given URL
- *
+ * This was taken from GalleryCoreApi::requestWebPage
*/
function fetchWebFileHeaders($url, $requestHeaders=array()) {
global $gallery;
projects / embedvideo / .git / blobdiff
![[embedvideo/.git]](/embedvideo/.git/static/git-logo.png?p=embedvideo/.git;a=tree;hb=c4a807484f66dda119f14d37ef4b57a8ad4a5997){kind=link}
