Added new autoStart parameter. Added new useRemoteSize parameter.
[embedvideo/.git] / ItemAddEmbedVideo.inc
index b8941f60e09fcc5409f20bec9ea527629f35eea1..28d4a809bee049b1e6a63813bc8aa235a9aed917 100644 (file)
@@ -66,22 +66,44 @@ class ItemAddEmbedVideo extends ItemAddPlugin {
           /* Store any Parameters into some simpler, shorter, local variables */
           global $debugOutput, $useInternalFlvPlayer, $youtubeDevId;
           global $width, $height, $externalFlvPlayer, $externalFlvPlayerVars;
-          global $flvThumbnail;
-
-          $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');
+          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 */
+         
+          /* 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();
@@ -126,7 +148,6 @@ class ItemAddEmbedVideo extends ItemAddPlugin {
                                "Unable to get video information at url: $url - $response"),null,null);
               }
 
-
               if(!strcmp($debugOutput,"true")) {
                 print "$xml";
               }
@@ -151,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";
@@ -203,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";
         
           /*
            **********************************
@@ -272,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 {
@@ -301,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"/>';
@@ -311,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" ';
@@ -366,6 +507,7 @@ 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>";
@@ -400,19 +542,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]."<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;