X-Git-Url: http://git.pippins.net/embedvideo/.git/static/git-logo.png?a=blobdiff_plain;f=ItemAddEmbedVideo.inc;h=03a54e94d31d5b2b68e911c9d0ce04c9c6f97c49;hb=c4a807484f66dda119f14d37ef4b57a8ad4a5997;hp=e5eecd1552acde47caac0a76b47401ee4c5086a8;hpb=f61667e91c20c89758911f384ec30ff9f92c49e1;p=embedvideo%2F.git diff --git a/ItemAddEmbedVideo.inc b/ItemAddEmbedVideo.inc index e5eecd1..03a54e9 100644 --- a/ItemAddEmbedVideo.inc +++ b/ItemAddEmbedVideo.inc @@ -18,6 +18,9 @@ * 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 @@ -66,27 +69,63 @@ class ItemAddEmbedVideo extends ItemAddPlugin { /* 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 "
"; + print "

Variable Parameters

"; + print "debugOutput=$debugOutput
"; + print "useInternalFlvPlayer=$useInternalFlvPlayer
"; + print "youtubeDevId=$youtubeDevId
"; + print "youtubeShowRelated=$youtubeShowRelated
"; + print "width=$width
"; + print "height=$height
"; + print "externalFlvPlayer=$externalFlvPlayer
"; + print "externalFlvPlayerVars=$externalFlvPlayerVars
"; + print "flvThumbnail=$flvThumbnail
"; + print "useRemoteSize=$useRemoteSize
"; + print "autoStart=$autoStart
"; + print "watermarkVideos=$watermarkVideos
"; + print "watermarkImage=$watermarkImage
"; + print "
"; + } /* 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/"; @@ -98,7 +137,8 @@ class ItemAddEmbedVideo extends ItemAddPlugin { /* 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 */ @@ -138,9 +178,16 @@ class ItemAddEmbedVideo extends ItemAddPlugin { "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 "

Youtube XML Dump

"; print "$xml"; + print "
"; } /* Extract certain information from the xml feed */ @@ -163,13 +210,32 @@ class ItemAddEmbedVideo extends ItemAddPlugin { $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 = ''; $description.= ''; $description.= ''; - $description.= ''; $description.= "
$summary"; @@ -197,7 +263,8 @@ class ItemAddEmbedVideo extends ItemAddPlugin { } /* Extract the summary from the webpage contents */ - preg_match('//i', + //print "contents: $contents
"; + preg_match('//i', $contents, $matches); $summary=$matches[1]; @@ -215,11 +282,23 @@ class ItemAddEmbedVideo extends ItemAddPlugin { $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 = ' '; + $description.= 'src="'.$googlePlayer.'?docId='.$doc_id.$autoStartStr.'" flashvars=""> '; $description.= ''; $description.= "
$summary"; @@ -227,6 +306,7 @@ class ItemAddEmbedVideo extends ItemAddPlugin { ********************************** * Embed a Yahoo Video ********************************** + * TODO: The autoStart parameter doesn't work with the yahoo video player */ } else if(preg_match("/$yahooUrlPattern/",$url)) { @@ -264,8 +344,10 @@ class ItemAddEmbedVideo extends ItemAddPlugin { /* Format the description to hold a reference to the embedded video */ preg_match('/()/', $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.= "
$summary"; /* @@ -306,11 +388,57 @@ class ItemAddEmbedVideo extends ItemAddPlugin { 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.= ""; $description.= "
$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 a remote .flv file @@ -372,7 +500,7 @@ class ItemAddEmbedVideo extends ItemAddPlugin { 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 { @@ -401,7 +529,7 @@ class ItemAddEmbedVideo extends ItemAddPlugin { $description.= ''; $description.= ''; $description.= ''; $description.= ''; @@ -411,7 +539,7 @@ class ItemAddEmbedVideo extends ItemAddPlugin { $description.= 'getConfig('data.gallery.tmp'); $tmpFile = $platform->tempnam($tmpDir, 'add'); $tmpFile.= ".jpg"; - - if(!strcmp($debugOutput,"true")) { - print "thumbnail: $thumbnail
"; - } - + /* 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 */ @@ -466,18 +590,183 @@ class ItemAddEmbedVideo extends ItemAddPlugin { /* General debug output */ if(!strcmp($debugOutput,"true")) { + print "

Item Parameters

"; + print "url: $url
"; print "title: $title
"; - print "

"; - print "\n".$summary."

"; - print "

$description

"; + print "thumbnailUrl: \n".$summary."

"; + print "description:

$description

"; print "thumbnail: $tmpFile
"; print "mimeType: $mimeType
"; print "fileName: $fileName
"; - print "

Video Successfully Added to your Gallery Album

"; + print "width: $width
"; + print "height: $height
"; + print "
"; + } + + /* 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.
"; + 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
"; + 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
"; + $toolkit->performOperation($mimeType, 'resize', $tmpFile, $newTmpFile, + array($thumbnailWidth,$thumbnailHeight)); + } } + if(!strcmp($debugOutput,"true")) { + print "

Thumbnail Resize

"; + print "$debugString"; + print "
"; + } + + /* 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 "

Watermark Operation

"; + print "watermarkImage: $watermarkImage
"; + print "watermarkTmpImage: $watermark
"; + print "watermarkMimeType: $watermarkMimeType
"; + print "watermarkWidth: $watermarkWidth
"; + print "watermarkHeight: $watermarkHeight
"; + print "watermarkedWidth: $thumbnailWidth
"; + print "watermarkedHeight: $thumbnailHeight
"; + } + + /* 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
"; + print "
"; + } + + /* 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, @@ -492,8 +781,18 @@ class ItemAddEmbedVideo extends ItemAddPlugin { $status['addedFiles'][] = array('fileName' => $url, 'id' => $newItem->getId(), 'warnings' => array()); + + if(!strcmp($debugOutput,"true")) { + print "

Video Successfully Added to your Gallery Album



"; + } + } + + /* 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); @@ -501,19 +800,25 @@ class ItemAddEmbedVideo extends ItemAddPlugin { /** * 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]."
"; */ return($params['override'][$name]); - } else { + } else if(isset($params['default'][$name])) { + /* print "default $name = ".$params['default'][$name] ."
"; */ return($params['default'][$name]); + } else { + /* print "$name = $default
"; */ + 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;