Improve the graphics toolkit detection code so that properly

identifies situations where its restricted by open_basedir.

We now track more informatoin about the toolkit including the version
and any errors we encountered while doing the detection so that we can
provide more info downstream.  This makes graphics::detect_toolkits()
a little heavier, but that's ok because it should not be called very
often.

In the process, refactor the controller and view hierarchy so that
it's a little more straightforward in the code.

Fixes ticket #616.

7 files changed, 127 insertions, 57 deletions

diff --git a/modules/gallery/controllers/admin_graphics.php b/modules/gallery/controllers/admin_graphics.php
index 72f8d8e1..565ee1b0 100644
--- a/modules/gallery/controllers/admin_graphics.php
+++ b/modules/gallery/controllers/admin_graphics.php
@@ -21,41 +21,24 @@ class Admin_Graphics_Controller extends Admin_Controller {
   public function index() {
     $view = new Admin_View("admin.html");
     $view->content = new View("admin_graphics.html");
-    $view->content->available = "";
-
-    $tk = new ArrayObject(graphics::detect_toolkits(), ArrayObject::ARRAY_AS_PROPS);
-    $active = module::get_var("gallery", "graphics_toolkit", "none");
-    foreach (array("gd", "imagemagick", "graphicsmagick", "none") as $id) {
-      if ($id == $active) {
-        $view->content->active = new View("admin_graphics_$id.html");
-        $view->content->active->tk = $tk;
-        $view->content->active->is_active = true;
-      } else if ($id != "none") {
-        $v = new View("admin_graphics_$id.html");
-        $v->tk = $tk;
-        $v->is_active = false;
-        $view->content->available .= $v;
-      }
-    }
-
+    $view->content->tk = graphics::detect_toolkits();
+    $view->content->active = module::get_var("gallery", "graphics_toolkit", "none");
     print $view;
   }
 
-  public function choose($toolkit) {
+  public function choose($toolkit_id) {
     access::verify_csrf();
 
-    if ($toolkit != module::get_var("gallery", "graphics_toolkit")) {
-      module::set_var("gallery", "graphics_toolkit", $toolkit);
-
-      $toolkit_info = graphics::detect_toolkits();
-      if ($toolkit == "graphicsmagick" || $toolkit == "imagemagick") {
-        module::set_var("gallery", "graphics_toolkit_path", $toolkit_info[$toolkit]);
-      }
+    if ($toolkit_id != module::get_var("gallery", "graphics_toolkit")) {
+      $tk = graphics::detect_toolkits();
+      module::set_var("gallery", "graphics_toolkit", $toolkit_id);
+      module::set_var("gallery", "graphics_toolkit_path", dirname($tk->$toolkit_id->dir));
 
       site_status::clear("missing_graphics_toolkit");
-      message::success(t("Updated Graphics Toolkit"));
-      log::success("graphics", t("Changed graphics toolkit to: %toolkit",
-                                 array("toolkit" => $toolkit)));
+
+      $msg = t("Changed graphics toolkit to: %toolkit", array("toolkit" => $tk->$toolkit_id->name));
+      message::success($msg);
+      log::success("graphics", $msg);
     }
 
     url::redirect("admin/graphics");
diff --git a/modules/gallery/helpers/graphics.php b/modules/gallery/helpers/graphics.php
index d506a982..7dc46eeb 100644
--- a/modules/gallery/helpers/graphics.php
+++ b/modules/gallery/helpers/graphics.php
@@ -339,15 +339,90 @@ class graphics_Core {
    * GraphicsMagick we return the path to the directory containing the appropriate binaries.
    */
   static function detect_toolkits() {
+    $toolkits = new stdClass();
+
+    // GD is special, it doesn't use exec()
     $gd = function_exists("gd_info") ? gd_info() : array();
-    $exec = function_exists("exec");
+    $toolkits->gd->name = "GD";
     if (!isset($gd["GD Version"])) {
-      $gd["GD Version"] = false;
+      $toolkits->gd->installed = false;
+      $toolkits->gd->error = t("GD is not installed");
+    } else {
+      $toolkits->gd->installed = true;
+      $toolkits->gd->version = $gd["GD Version"];
+      $toolkits->gd->rotate = function_exists("imagerotate");
+      $toolkits->gd->binary = "";
+      $toolkits->gd->dir = "";
+
+      if (!$toolkits->gd->rotate) {
+        $toolkits->gd->error =
+          t("You have GD version %version, but it lacks image rotation.",
+            array("version" => $gd["GD Version"]));
+      }
+    }
+
+    if (!function_exists("exec")) {
+      $toolkits->imagemagick->installed = false;
+      $toolkits->imagemagick->error = t("ImageMagick requires the <b>exec</b> function");
+
+      $toolkits->graphicsmagick->installed = false;
+      $toolkits->graphicsmagick->error = t("GraphicsMagick requires the <b>exec</b> function");
+    } else {
+      putenv("PATH=" . getenv("PATH") . ":/usr/local/bin:/opt/local/bin:/opt/bin");
+
+      // @todo: consider refactoring the two segments below into a loop since they are so
+      // similar.
+
+      // ImageMagick
+      $path = exec("which convert");
+      $toolkits->imagemagick->name = "ImageMagick";
+      if ($path) {
+        if (@is_file($path)) {
+          preg_match('/Version: \S+ (\S+)/', `convert -v`, $matches);
+          $version = $matches[1];
+
+          $toolkits->imagemagick->installed = true;
+          $toolkits->imagemagick->version = $version;
+          $toolkits->imagemagick->binary = $path;
+          $toolkits->imagemagick->dir = dirname($path);
+          $toolkits->imagemagick->rotate = true;
+        } else {
+          $toolkits->imagemagick->installed = false;
+          $toolkits->imagemagick->error =
+            t("ImageMagick is installed, but PHP's open_basedir restriction " .
+              "prevents Gallery from using it.");
+        }
+      } else {
+        $toolkits->imagemagick->installed = false;
+        $toolkits->imagemagick->error = t("We could not locate ImageMagick on your system.");
+      }
+
+      // GraphicsMagick
+      $path = exec("which gm");
+      $toolkits->graphicsmagick->name = "GraphicsMagick";
+      if ($path) {
+        if (@is_file($path)) {
+          preg_match('/\S+ (\S+)/', `gm version`, $matches);
+          $version = $matches[1];
+
+          $toolkits->graphicsmagick->installed = true;
+          $toolkits->graphicsmagick->version = $version;
+          $toolkits->graphicsmagick->binary = $path;
+          $toolkits->graphicsmagick->dir = dirname($path);
+          $toolkits->graphicsmagick->rotate = true;
+        } else {
+          $toolkits->graphicsmagick->installed = false;
+          $toolkits->graphicsmagick->error =
+            t("GraphicsMagick is installed, but PHP's open_basedir restriction " .
+              "prevents Gallery from using it.");
+        }
+      } else {
+        $toolkits->graphicsmagick->installed = false;
+        $toolkits->graphicsmagick->error = t("We could not locate GraphicsMagick on your system.");
+      }
     }
-    putenv("PATH=" . getenv("PATH") . ":/usr/local/bin:/opt/local/bin:/opt/bin");
-    return array("gd" => $gd,
-                 "imagemagick" => $exec ? dirname(exec("which convert")) : false,
-                 "graphicsmagick" => $exec ? dirname(exec("which gm")) : false);
+
+    return $toolkits;
   }
 
   /**
@@ -357,12 +432,13 @@ class graphics_Core {
     // Detect a graphics toolkit
     $toolkits = graphics::detect_toolkits();
     foreach (array("imagemagick", "graphicsmagick", "gd") as $tk) {
-      if ($toolkits[$tk]) {
+      if ($toolkits->$tk->installed) {
         module::set_var("gallery", "graphics_toolkit", $tk);
-        module::set_var("gallery", "graphics_toolkit_path", $tk == "gd" ? "" : $toolkits[$tk]);
+        module::set_var("gallery", "graphics_toolkit_path", $toolkits->$tk->dir);
         break;
       }
     }
+
     if (!module::get_var("gallery", "graphics_toolkit")) {
       site_status::warning(
         t("Graphics toolkit missing!  Please <a href=\"%url\">choose a toolkit</a>",
diff --git a/modules/gallery/views/admin_graphics.html.php b/modules/gallery/views/admin_graphics.html.php
index 08374471..c4a2f5c6 100644
--- a/modules/gallery/views/admin_graphics.html.php
+++ b/modules/gallery/views/admin_graphics.html.php
@@ -9,8 +9,8 @@
     };
     $("#gAdminGraphics div.gAvailable .gBlock").click(select_toolkit);
   });
-
 </script>
+
 <div id="gAdminGraphics">
   <h1> <?= t("Graphics Settings") ?> </h1>
   <p>
@@ -18,11 +18,19 @@
   </p>
 
   <h2> <?= t("Active Toolkit") ?> </h2>
-  <?= $active ?>
+  <? if ($active == "none"): ?>
+  <?= new View("admin_graphics_none.html") ?>
+  <? else: ?>
+  <?= new View("admin_graphics_$active.html", array("tk" => $tk->$active, "is_active" => true)) ?>
+  <? endif ?>
 
   <div class="gAvailable">
     <h2> <?= t("Available Toolkits") ?> </h2>
-    <?= $available ?>
+    <? foreach (array_keys((array)$tk) as $id): ?>
+    <? if ($id != $active): ?>
+    <?= new View("admin_graphics_$id.html", array("tk" => $tk->$id, "is_active" => false)) ?>
+    <? endif ?>
+    <? endforeach ?>
   </div>
 </div>
 
diff --git a/modules/gallery/views/admin_graphics_gd.html.php b/modules/gallery/views/admin_graphics_gd.html.php
index b77da8e3..aa9ee67c 100644
--- a/modules/gallery/views/admin_graphics_gd.html.php
+++ b/modules/gallery/views/admin_graphics_gd.html.php
@@ -1,23 +1,26 @@
 <?php defined("SYSPATH") or die("No direct script access.") ?>
-<div id="gd" class="gBlock<?= $is_active ? " gSelected" : "" ?><?= $tk->gd["GD Version"] ? " gInstalledToolkit" : " gUnavailable" ?>">
+<div id="gd" class="gBlock<?= $is_active ? " gSelected" : "" ?><?= $tk->installed ? " gInstalledToolkit" : " gUnavailable" ?>">
   <img class="logo" width="170" height="110" src="<?= url::file("modules/gallery/images/gd.png"); ?>" alt="<? t("Visit the GD lib project site") ?>" />
   <h3> <?= t("GD") ?> </h3>
   <p>
     <?= t("The GD graphics library is an extension to PHP commonly installed most webservers.  Please refer to the <a href=\"%url\">GD website</a> for more information.",
         array("url" => "http://www.boutell.com/gd")) ?>
   </p>
-  <? if ($tk->gd["GD Version"] && function_exists('imagerotate')): ?>
+  <? if ($tk->installed && $tk->rotate): ?>
   <p class="gSuccess">
-    <?= t("You have GD version %version.", array("version" => $tk->gd["GD Version"])) ?>
+    <?= t("You have GD version %version.", array("version" => $tk->version)) ?>
   </p>
   <p>
     <a class="gButtonLink ui-state-default ui-corner-all"><?= t("Activate GD") ?></a>
   </p>
-  <? elseif ($tk->gd["GD Version"]): ?>
+  <? elseif ($tk->installed): ?>
+
+  <? if ($tk->error): ?>
   <p class="gWarning">
-    <?= t("You have GD version %version, but it lacks image rotation.",
-        array("version" => $tk->gd["GD Version"])) ?>
+    <?= $tk->error ?>
   </p>
+  <? endif ?>
+
   <p>
     <a class="gButtonLink ui-state-default ui-corner-all"><?= t("Activate GD") ?></a>
   </p>
diff --git a/modules/gallery/views/admin_graphics_graphicsmagick.html.php b/modules/gallery/views/admin_graphics_graphicsmagick.html.php
index e2cd0777..bf3ad339 100644
--- a/modules/gallery/views/admin_graphics_graphicsmagick.html.php
+++ b/modules/gallery/views/admin_graphics_graphicsmagick.html.php
@@ -1,21 +1,21 @@
 <?php defined("SYSPATH") or die("No direct script access.") ?>
-<div id="graphicsmagick" class="gBlock<?= $is_active ? " gSelected" : "" ?><?= $tk->graphicsmagick ? "  gInstalledToolkit" : " gUnavailable" ?>">
+<div id="graphicsmagick" class="gBlock<?= $is_active ? " gSelected" : "" ?><?= $tk->installed ? "  gInstalledToolkit" : " gUnavailable" ?>">
   <h3> <?= t("GraphicsMagick") ?> </h3>
   <img class="logo" width="107" height="76" src="<?= url::file("modules/gallery/images/graphicsmagick.png"); ?>" alt="<? t("Visit the GraphicsMagick project site") ?>" />
   <p>
     <?= t("GraphicsMagick is a standalone graphics program available on most Linux systems.  Please refer to the <a href=\"%url\">GraphicsMagick website</a> for more information.",
         array("url" => "http://www.graphicsmagick.org")) ?>
   </p>
-  <? if ($tk->graphicsmagick): ?>
+  <? if ($tk->installed): ?>
   <p class="gSuccess">
-    <?= t("GraphicsMagick is available in %path", array("path" => $tk->graphicsmagick)) ?>
+    <?= t("GraphicsMagick version %version is available in %dir", array("version" => $tk->version, "dir" => $tk->dir)) ?>
   </p>
   <p>
     <a class="gButtonLink ui-state-default ui-corner-all"><?= t("Activate Graphics Magic") ?></a>
   </p>
   <? else: ?>
-  <p class="gInfo">
-    <?= t("GraphicsMagick is not available on your system.") ?>
+  <p class="gWarning">
+    <?= $tk->error ?>
   </p>
   <? endif ?>
 </div>
diff --git a/modules/gallery/views/admin_graphics_imagemagick.html.php b/modules/gallery/views/admin_graphics_imagemagick.html.php
index 081ddc15..b8f7ffb8 100644
--- a/modules/gallery/views/admin_graphics_imagemagick.html.php
+++ b/modules/gallery/views/admin_graphics_imagemagick.html.php
@@ -1,21 +1,21 @@
 <?php defined("SYSPATH") or die("No direct script access.") ?>
-<div id="imagemagick" class="gBlock<?= $is_active ? " gSelected" : "" ?><?= $tk->imagemagick ? "  gInstalledToolkit" : " gUnavailable" ?>">
+<div id="imagemagick" class="gBlock<?= $is_active ? " gSelected" : "" ?><?= $tk->installed ? "  gInstalledToolkit" : " gUnavailable" ?>">
   <h3> <?= t("ImageMagick") ?> </h3>
   <img class="logo" width="114" height="118" src="<?= url::file("modules/gallery/images/imagemagick.jpg"); ?>" alt="<? t("Visit the ImageMagick project site") ?>" />
   <p>
     <?= t("ImageMagick is a standalone graphics program available on most Linux systems.  Please refer to the <a href=\"%url\">ImageMagick website</a> for more information.",
         array("url" => "http://www.imagemagick.org")) ?>
   </p>
-  <? if ($tk->imagemagick): ?>
+  <? if ($tk->installed): ?>
   <p class="gSuccess">
-    <?= t("ImageMagick is available in %path", array("path" => $tk->imagemagick)) ?>
+    <?= t("ImageMagick version %version is available in %dir", array("version" => $tk->version, "dir" => $tk->dir)) ?>
   </p>
   <p>
     <a class="gButtonLink ui-state-default ui-corner-all"><?= t("Activate ImageMagick") ?></a>
   </p>
-  <? else: ?>
-  <p class="gInfo">
-    <?= t("ImageMagick is not available on your system.") ?>
+  <? elseif ($tk->error): ?>
+  <p class="gWarning">
+    <?= $tk->error ?>
   </p>
   <? endif ?>
 </div>
diff --git a/modules/gallery/views/admin_graphics_none.html.php b/modules/gallery/views/admin_graphics_none.html.php
index 5306a70d..be2a580d 100644
--- a/modules/gallery/views/admin_graphics_none.html.php
+++ b/modules/gallery/views/admin_graphics_none.html.php
@@ -2,6 +2,6 @@
 <div id="none" class="gBlock">
   <h3 class="gWarning"> <?= t("No Active Toolkit") ?> </h3>
   <p>
-    <?= t("We were unable to detect a graphics program.  You must install one of the toolkits below in order to many Gallery features.") ?>
+    <?= t("We were unable to detect a graphics program.  You must install one of the toolkits below in order to use many Gallery features.") ?>
   </p>
 </div>