Finishing touches on initial support for watermarking video thumbnails
[embedvideo/.git] / ItemAddEmbedVideo.inc
index 983ec79d041f82e00dcbb2c4968928f06d7ade98..03a54e94d31d5b2b68e911c9d0ce04c9c6f97c49 100644 (file)
@@ -70,6 +70,7 @@ class ItemAddEmbedVideo extends ItemAddPlugin {
           global $debugOutput, $useInternalFlvPlayer, $youtubeDevId;
           global $width, $height, $externalFlvPlayer, $externalFlvPlayerVars;
           global $flvThumbnail, $useRemoteSize, $autoStart;
+          global $watermarkVideos, $watermarkImage;
 
           /* 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
@@ -78,6 +79,7 @@ class ItemAddEmbedVideo extends ItemAddPlugin {
           $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', "");
@@ -85,6 +87,8 @@ class ItemAddEmbedVideo extends ItemAddPlugin {
           $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")) {
@@ -93,6 +97,7 @@ class ItemAddEmbedVideo extends ItemAddPlugin {
             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>";
@@ -100,6 +105,8 @@ class ItemAddEmbedVideo extends ItemAddPlugin {
             print "flvThumbnail=$flvThumbnail<br>";
             print "useRemoteSize=$useRemoteSize<br>";
             print "autoStart=$autoStart<br>";
+            print "watermarkVideos=$watermarkVideos<br>";
+            print "watermarkImage=$watermarkImage<br>";
             print "<hr>";
           }
 
@@ -130,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 */
@@ -170,6 +178,12 @@ 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 "<h2>Youtube XML Dump</h2>";
                 print "$xml";
@@ -207,14 +221,21 @@ class ItemAddEmbedVideo extends ItemAddPlugin {
               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.$autoStartStr.'" ';
-              $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";
 
@@ -242,7 +263,8 @@ class ItemAddEmbedVideo extends ItemAddPlugin {
               }
 
               /* 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];
 
@@ -375,7 +397,48 @@ class ItemAddEmbedVideo extends ItemAddPlugin {
               }
               $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
@@ -561,9 +624,24 @@ class ItemAddEmbedVideo extends ItemAddPlugin {
                         }
                       }
                   }
-                  $debugString.="Resizing thumbnail image to $thumbnailSize: $tmpFile -> $newTmpFile <br>";
+                  
+                  // 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($thumbnailSize,$thumbnailSize));
+                                             array($thumbnailWidth,$thumbnailHeight));
               }
           }
           if(!strcmp($debugOutput,"true")) {
@@ -571,6 +649,121 @@ class ItemAddEmbedVideo extends ItemAddPlugin {
               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($newTmpFile,