Added new autoStart parameter. Added new useRemoteSize parameter.
[embedvideo/.git] / ItemAddEmbedVideo.inc
index a6cb38c5aad7092791554c75e110d47ba4e69492..28d4a809bee049b1e6a63813bc8aa235a9aed917 100644 (file)
@@ -58,25 +58,52 @@ class ItemAddEmbedVideo extends ItemAddPlugin {
                   foreach ($variablesArray as $variable) {
                       list ($name, $value) = explode('=', $variable);
                       $ItemAddEmbedVideo[$type][$name] = $value;
+                      /* print "type: $type name: $name value: $value <br>"; */
                   }
               }
           }
           
           /* Store any Parameters into some simpler, shorter, local variables */
-          $debugOutput = $ItemAddEmbedVideo['default']['debugOutput'];
-          $useInternalFlvPlayer = $ItemAddEmbedVideo['default']['useInternalFlvPlayer'];
-          $youtubeDevId = $ItemAddEmbedVideo['default']['youtubeDevId'];
-          $width=$ItemAddEmbedVideo['default']['width'];
-          $height=$ItemAddEmbedVideo['default']['height'];
-          $externalFlvPlayer = $ItemAddEmbedVideo['default']['externalFlvPlayer'];
-          $externalFlvPlayerVars = $ItemAddEmbedVideo['default']['externalFlvPlayerVars'];
-          $flvThumbnail = $ItemAddEmbedVideo['default']['flvThumbnail'];
+          global $debugOutput, $useInternalFlvPlayer, $youtubeDevId;
+          global $width, $height, $externalFlvPlayer, $externalFlvPlayerVars;
+          global $flvThumbnail, $useRemoteSize, $autoStart;
 
+          /* 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', "");
+          $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");
+          
           /* Store other string constants we'll use later */
-          $youtubeUrlPattern="www.youtube.com";
+         
+          /* youtube */
+          $youtubeUrlPattern="youtube.com";
           $youtubeApiUrl="http://www.youtube.com/api2_rest";
+          $youtubeWidth="425";
+          $youtubeHeight="350";
+
+          /* google */
           $googleUrlPattern="video.google.com";
           $googlePlayer="http://video.google.com/googleplayer.swf";
+          $googleWidth="400";
+          $googleHeight="326";
+          
+          /* yahoo */
+          $yahooUrlPattern="video.yahoo.com";
+          $yahooThumbnailUrl="http://thmg01.video.search.yahoo.com/image/";
+          
+          /* metacafe */
+          $metacafeUrlPattern="metacafe.com";
+          $metacafeThumbnailUrl="http://www.metacafe.com/thumb/";
           
           /* Gallery2 specific paths and variables */
           $urlGenerator =& $gallery->getUrlGenerator();
@@ -118,10 +145,9 @@ class ItemAddEmbedVideo extends ItemAddPlugin {
                 GalleryCoreApi::fetchWebPage($feed, $extraHeaders);
               if (!$successfullyCopied) {
                   return array(GalleryCoreApi::error(ERROR_BAD_PATH,__FILE__,__LINE__,
-                               "Unable to get video information at url: $url"),null,null);
+                               "Unable to get video information at url: $url - $response"),null,null);
               }
 
-
               if(!strcmp($debugOutput,"true")) {
                 print "$xml";
               }
@@ -146,12 +172,24 @@ 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";
+              }
+              
               /* 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.= '<embed src="http://www.youtube.com/v/'.$video_id.$autoStartStr.'" ';
               $description.= 'type="application/x-shockwave-flash" wmode="transparent" ';
               $description.= 'width="'.$width.'" height="'.$height.'"></embed></object>';
               $description.= "<br>$summary";
@@ -176,7 +214,7 @@ class ItemAddEmbedVideo extends ItemAddPlugin {
                 GalleryCoreApi::fetchWebPage($url, $extraHeaders);
               if (!$successfullyCopied) {
                   return array(GalleryCoreApi::error(ERROR_BAD_PATH,__FILE__,__LINE__,
-                               "Unable to get video information at url: $url"),null,null);
+                               "Unable to get video information at url: $url - $response"),NULL,NULL);
               }
 
               /* Extract the summary from the webpage contents */
@@ -185,9 +223,12 @@ class ItemAddEmbedVideo extends ItemAddPlugin {
               $summary=$matches[1];
 
               /* Extract the title from the webpage contents */
-              preg_match('/<title>(.+?)\s+- Google Video<\/title>/i',
-                         $contents, $matches);
-              $title=$matches[1];
+              $title="Unknown";
+              if(preg_match('/<title>(.+?)\s+- Google Video<\/title>/i', $contents, $matches)) {
+                $title=$matches[1];
+              } else if(preg_match('/<title>(.+?)<\/title>/i', $contents, $matches)) {
+                $title=$matches[1];
+              }
 
               /* Extract the thumbnail URL from the webpage contents */
               preg_match('/<img src="(http:\/\/video\.google\.com\/ThumbnailServer2.+?)" /i',
@@ -195,13 +236,121 @@ 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 = '<embed FlashVars="autoPlay=true" ';
+              $description = '<embed FlashVars=';
               $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.'"> ';
               $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)) {
+
+              /* Make sure we can extract a vidID */
+              if(preg_match("/vid=(.*)/",$url,$matches)) {
+                  $vid_id = $matches[1];
+              } else {
+                  return array(GalleryCoreApi::error(ERROR_BAD_PARAMETER,__FILE__,__LINE__,
+                               "Unable to extract vid id from url: $url"),null,null);
+              }
+
+              /* Grab the contents of the webpage used to display the video on video.google.com */
+              list ($successfullyCopied, $contents, $response, $headers) =
+                GalleryCoreApi::fetchWebPage($url, $extraHeaders);
+              if (!$successfullyCopied) {
+                  return array(GalleryCoreApi::error(ERROR_BAD_PATH,__FILE__,__LINE__,
+                               "Unable to get video information at url: $url - $response"),NULL,NULL);
+              }
+
+              /* Extract the summary from the webpage contents */
+              preg_match('/Description:<\/em><p>(.+?)<\/p>/', $contents, $matches);
+              $summary=$matches[1];
+
+              /* Extract the title from the webpage contents */
+              $title="Unknown";
+              if(preg_match('/<title>(.+?)\s+- Yahoo! Video<\/title>/i', $contents, $matches)) {
+                $title=$matches[1];
+              } else if(preg_match('/<title>(.+?)<\/title>/i', $contents, $matches)) {
+                $title=$matches[1];
+              }
+
+              /* Build the thumbnail URL from the vid_id */
+              $thumbnail=$yahooThumbnailUrl.$vid_id."_01";
+
+              /* Format the description to hold a reference to the embedded video */
+              preg_match('/(<embed src.+?<\/embed>)/', $contents, $matches);
+              $description=$matches[1];
+              if(!strcmp($useRemoteSize,"false")) {
+                $description=preg_replace("/width='\d+'/","width='".$width."'",$description);
+                $description=preg_replace("/height='\d+'/","height='".$height."'",$description);
+              }
+              $description.= "<br>$summary";
+
+          /*
+           **********************************
+           * Embed a MetaCafe Video
+           **********************************
+            */
+          } else if(preg_match("/$metacafeUrlPattern/",$url)) {
+
+              /* Make sure we can extract a itemID */
+              if(preg_match("/\/watch\/(.+?)\/(.+?)/",$url,$matches)) {
+                  $item_id = $matches[1];
+              } else {
+                  return array(GalleryCoreApi::error(ERROR_BAD_PARAMETER,__FILE__,__LINE__,
+                               "Unable to extract item id from url: $url"),null,null);
+              }
+
+              /* Grab the contents of the webpage used to display the video on video.google.com */
+              list ($successfullyCopied, $contents, $response, $headers) =
+                GalleryCoreApi::fetchWebPage($url, $extraHeaders);
+              if (!$successfullyCopied) {
+                  return array(GalleryCoreApi::error(ERROR_BAD_PATH,__FILE__,__LINE__,
+                               "Unable to get video information at url: $url - $response"),NULL,NULL);
+              }
+
+              /* Extract the summary from the webpage contents */
+              preg_match('/<meta name="description" content="(.+?)" \/>/i', $contents, $matches);
+              $summary=$matches[1];
+
+              /* Extract the title from the webpage contents */
+              preg_match('/<title>(.+?)<\/title>/i', $contents, $matches);
+              $title=$matches[1];
+              
+              /* Build the thumbnail URL from the item_id */
+              $thumbnail=$metacafeThumbnailUrl.$item_id.".jpg";
+
+              /* Format the description to hold a reference to the embedded video */
+              preg_match('/(embed src.+?\/embed)/', $contents, $matches);
+              $description="<".$matches[1];
+              $description=preg_replace("/&quot;/","'",$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";
         
           /*
            **********************************
@@ -229,11 +378,12 @@ class ItemAddEmbedVideo extends ItemAddPlugin {
                 * Check to make sure the URL to the remote flv file is valid
                * (That the file exists at the URL given)
                 */
-              /*
-                * TODO: How can we check if the remote file exists without actually
-                * downloading the entire file? For now, if the file doesn't exist,
-                * a gallery item is still added, and the embedded player won't play it.
-                */ 
+              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
@@ -263,7 +413,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 {
@@ -292,7 +442,7 @@ class ItemAddEmbedVideo extends ItemAddPlugin {
                   $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"/>';
@@ -302,7 +452,7 @@ class ItemAddEmbedVideo extends ItemAddPlugin {
                   $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" ';
@@ -342,7 +492,7 @@ class ItemAddEmbedVideo extends ItemAddPlugin {
             GalleryCoreApi::fetchWebFile($thumbnail, $tmpFile, $extraHeaders);
           if (!$successfullyCopied) {
               return array(GalleryCoreApi::error(ERROR_STORAGE_FAILURE,__FILE__,__LINE__,
-                           "Unable to copy thumbnail from url: $url"),null,null);
+                           "Unable to copy thumbnail from url: $url - $response"),null,null);
           }
           
           /* Obtain the mimeType of the thumbnail */
@@ -357,12 +507,14 @@ class ItemAddEmbedVideo extends ItemAddPlugin {
           
           /* General debug output */
           if(!strcmp($debugOutput,"true")) {
+              print "title: $title <br>";
               print "<p><a href=\"".$title."\" target=\"_blank\">";
               print "<img src=\"".$thumbnail."\">\n</a>".$summary."</p>";
               print "<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>";
           }
 
           /* Make the gallery2 call to add this item to the album */
@@ -388,6 +540,121 @@ class ItemAddEmbedVideo extends ItemAddPlugin {
    return array(null, $error, $status);
  }
 
+ /**
+  * A simple function to resolve the value of a parameter from
+  * the default or override value if it exists, or set it
+  * to the default passed as an argument.
+  */
+ function getParameter($params, $name, $default="") {
+   if(isset($params['override'][$name])) {
+     /* print "override $name = ".$params['override'][$name]."<br>"; */
+     return($params['override'][$name]);
+   } 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;
+     
+     $requestMethod='GET';
+
+     /* Convert illegal characters */
+     $url = str_replace(' ', '%20', $url);
+     
+     /* Unescape ampersands, since if the URL comes from form input it will be escaped */
+     $url = str_replace('&amp;', '&', $url);
+
+     $platform =& $gallery->getPlatform();
+     
+     $urlComponents = parse_url($url);
+     if (empty($urlComponents['port'])) {
+         $urlComponents['port'] = 80;
+     }
+     if (empty($urlComponents['path'])) {
+         $urlComponents['path'] = '/';
+     }
+
+     $handle = @$platform->fsockopen(
+                                    $urlComponents['host'], $urlComponents['port'], $errno, $errstr, 5);
+     if (empty($handle)) {
+         $gallery->debug("Error $errno: '$errstr' requesting $url");
+         return array(null, null, null);
+     }
+     
+     $requestUri = $urlComponents['path'];
+     if (!empty($urlComponents['query'])) {
+         $requestUri .= '?' . $urlComponents['query'];
+     }
+     $headerLines = array('Host: ' . $urlComponents['host']);
+     foreach ($requestHeaders as $key => $value) {
+         $headerLines[] = $key . ': ' . $value;
+     }
+     
+     $success = $platform->fwrite($handle, sprintf("%s %s HTTP/1.0\r\n%s\r\n\r\n%s",
+                                                  $requestMethod,
+                                                  $requestUri,
+                                                  implode("\r\n", $headerLines),
+                                                  $requestBody));
+     if (!$success) {
+         /* Zero bytes written or false was returned */
+         $gallery->debug(
+                        "fwrite failed in requestWebPage($url)" . ($success === false ? ' - false' : ''));
+        return array(null, null, null);
+     }
+     $platform->fflush($handle);
+     
+     
+     /*
+      * Read the status line.  fgets stops after newlines.  The first line is the protocol
+      * version followed by a numeric status code and its associated textual phrase.
+      */
+     $responseStatus = trim($platform->fgets($handle, 4096));
+     if (empty($responseStatus)) {
+         $gallery->debug('Empty http response code, maybe timeout');
+         return array(null, null, null);
+     }
+     
+     /* Read the headers */
+     $responseHeaders = array();
+     while (!$platform->feof($handle)) {
+         $line = trim($platform->fgets($handle, 4096));
+         if (empty($line)) {
+            break;
+        }
+       
+        /* Normalize the line endings */
+        $line = str_replace("\r", '', $line);
+        
+        list ($key, $value) = explode(':', $line, 2);
+        if (isset($responseHeaders[$key])) {
+            if (!is_array($responseHeaders[$key])) {
+              $responseHeaders[$key] = array($responseHeaders[$key]);
+            }
+            $responseHeaders[$key][] = trim($value);
+        } else {
+            $responseHeaders[$key] = trim($value);
+        }
+     }
+     $platform->fclose($handle);
+
+     if(preg_match("/Not found/i", $responseStatus)) {
+         $success = 0;
+     }
+
+     //print "success: $success <br>responseStatus: $responseStatus <br>responseHeaders: $responseHeaders <br>";
+     
+     return array($success, $responseStatus, $responseHeaders);
+ }
  /**
   * @see ItemAdd:loadTemplate
   */