Changeset 1078

Timestamp:

04/27/10 15:49:28 (22 months ago)

Author:

tboutell

Message:

New aImageConverter::supportsInput($extension) method allows you to check whether aImageConverter can import a particular image format on this system. Mainly used to check for pdf support:

if (aImageConverter::supportsInput('pdf')) { ... }

You can pass:

gif, jpg, jpeg, png, bmp, ico, pdf (pdf always reports false if ghostscript is not available) and, if you have the netpbm utilities, other well known file extensions supported by netpbm.

This method can of course be fooled by broken installations in which the netpbm utilities or ghostscript are present but not working.

Lack of support for bmp and ico is neither a bug nor uncommon.

For performance reasons the result is cached for 5 minutes. Keep that in mind if you make system changes such as installing netpbm and ghostscript and see no immediate difference.

Location:

plugins/apostrophePlugin/trunk

Files:

• . (modified) (1 prop)
• lib/toolkit/aFeed.class.php (modified) (1 diff)
• lib/toolkit/aImageConverter.class.php (modified) (1 diff)
• web/css/a.css (modified) (1 prop)
• web/images (modified) (1 prop)

plugins/apostrophePlugin/trunk/lib/toolkit/aFeed.class.php

@@ -9 +9 @@
          * http://spindrop.us/2006/07/04/dynamic-linking-to-syndication-feeds-with-symfony/
          *
-         * @author Dave Dash
+         * @author Dave Dash (just this method)
          *
          * Unrelated to aFeed slots.

plugins/apostrophePlugin/trunk/lib/toolkit/aImageConverter.class.php

@@ -461 +461 @@
     return false;
   }
+  
+  // Can this box handle pdf, png, jpeg (also acdepts jpg), gif, bmp, ico...
+
+  // Mainly used to check for PDF support.
+  
+  // NOTE: this call is a performance hit, especially with netpbm and ghostscript available.
+  // So we cache the result for 5 minutes. Keep that in mind if you make configuration changes, install
+  // ghostscript, etc. and don't see an immediate difference.
+
+  static public function supportsInput($extension)
+  {
+    $hint = aImageConverter::getHint("input:$extension");
+    if (!is_null($hint))
+    {
+      return $hint;
+    }
+    
+    $result = false;
+    if (sfConfig::get('app_aimageconverter_netpbm', true))
+    {
+      if (aImageConverter::supportsInputNetpbm($extension))
+      {
+        $result = true;
+      }
+    }
+    if (!$result)
+    {
+      $result = aImageConverter::supportsInputGd($extension);
+    }
+    aImageConverter::setHint("input:$extension", $result);
+    return $result;
+  }
+
+  static public function supportsInputNetpbm($extension)
+  {
+    $types = array('gif' => 'gif', 'png' => 'png', 'jpg' => 'jpeg', 'jpeg' => 'jpeg', 'bmp' => 'bmp', 'ico' => 'ico');
+    $path = sfConfig::get("app_aimageconverter_path", "");
+    if (strlen($path)) {
+      if (!preg_match("/\/$/", $path)) {
+        $path .= "/";
+      }
+    }
+    if ($extension === 'pdf')
+    {
+      $cmd = 'gs';
+    }
+    elseif (!isset($types[$extension]))
+    {
+      if (!preg_match('/^\w+$/', $extension))
+      {
+        return false;
+      }
+      $cmd = $extension . 'topnm';
+    }
+    else
+    {
+      $cmd = $types[$extension] . 'topnm';
+    }
+    $in = popen("(PATH=$path:\$PATH; export PATH; which $cmd)", "r");
+    $result = stream_get_contents($in);
+    pclose($in);
+    if (strlen($result))
+    {
+      return true;
+    }
+    return false;
+  }
+  
+  static public function supportsInputGd($extension)
+  {
+    $types = array('gif' => 'gif', 'png' => 'png', 'jpg' => 'jpeg', 'jpeg' => 'jpeg', 'bmp' => 'bmp', 'ico' => 'ico');
+    if (!isset($types[$extension]))
+    {
+      return false;
+    }
+    $f = 'imagecreatefrom' . $types[$extension];
+    return is_callable($f);
+  }
+  
+  static public function getHint($hint)
+  {
+    $cache = aImageConverter::getHintCache();
+    $key = 'apostrophe:imageconverter:' . $hint;
+    return $cache->get($key, null);
+  }
+  
+  static public function setHint($hint, $value)
+  {
+    $cache = aImageConverter::getHintCache();
+    // The lifetime should be short to avoid annoying developers who are
+    // trying to fix their configuration and test with new possibilities
+    $key = 'apostrophe:imageconverter:' . $hint;
+    $cache->set($key, $value, 300);
+  }
+  static public function getHintCache()
+  {
+    $cacheClass = sfConfig::get('app_a_hint_cache_class', 'sfFileCache');
+    $cache = new $cacheClass(sfConfig::get('app_a_hint_cache_options', array('cache_dir' => aFiles::getWritableDataFolder(array('a_hint_cache')))));
+    return $cache;
+  }
 }