islandora/fedora_repository.install

<?php

/**
 * @file fedora_repository.install
 */

/**
 * Implementation of hook_enable().
 */
function fedora_collections_enable() {
  //nothing to do as we do not currently touch the drupal database.
  //other than the variables table
}

/**
 * Implementation of hook_requirements().
 *
 * @return
 *   An array describing the status of the site regarding available updates.
 *   If there is no update data, only one record will be returned, indicating
 *   that the status of core can't be determined. If data is available, there
 *   will be two records: one for core, and another for all of contrib
 *   (assuming there are any contributed modules or themes enabled on the
 *   site). In addition to the fields expected by hook_requirements ('value',
 *   'severity', and optionally 'description'), this array will contain a
 *   'reason' attribute, which is an integer constant to indicate why the
 *   given status is being returned (UPDATE_NOT_SECURE, UPDATE_NOT_CURRENT, or
 *   UPDATE_UNKNOWN). This is used for generating the appropriate e-mail
 *   notification messages during update_cron(), and might be useful for other
 *   modules that invoke update_requirements() to find out if the site is up
 *   to date or not.
 *
 * @see _update_message_text()
 * @see _update_cron_notify()
 */
function fedora_repository_requirements($phase) {
  global $base_url;

  $requirements = array();

  if ($phase == 'install') {

    // Test for SOAP
    $requirements['fedora-soap']['title'] = t("PHP SOAP extension library");
    if (!class_exists('SoapClient')) {
      $requirements['fedora-soap']['value'] = t("Not installed");
      $requirements['fedora-soap']['severity'] = REQUIREMENT_ERROR;
      $requirements['fedora-soap']['description'] = t('Ensure that the PHP SOAP extension is installed.');
    }
    else {
      $requirements['fedora-soap']['value'] = t("Installed");
      $requirements['fedora-soap']['severity'] = REQUIREMENT_OK;
    }

    // Test for Curl
    $requirements['curl']['title'] = "PHP Curl extension library";
    if (!function_exists('curl_init')) {
      $requirements['curl']['value'] = t("Not installed");
      $requirements['curl']['severity'] = REQUIREMENT_ERROR;
      $requirements['curl']['description'] = t("Ensure that the PHP Curl extension is installed.");
    }
    else {
      $requirements['curl']['value'] = t("Installed");
      $requirements['curl']['serenity'] = REQUIREMENT_OK;
    }

    // Test for DOM
    $requirements['dom']['title'] = "PHP DOM XML extension library";
    if (!method_exists('DOMDocument', 'loadHTML')) {
      $requirements['dom']['value'] = t("Not installed");
      $requirements['dom']['severity'] = REQUIREMENT_ERROR;
      $requirements['dom']['description'] = t("Ensure that the PHP DOM XML extension is installed.");
    }
    else {
      $requirements['dom']['value'] = t("Installed");
      $requirements['dom']['serenity'] = REQUIREMENT_OK;
    }

    // Test for XSLT
    $requirements['xsl']['title'] = "PHP XSL extension library";
    if (!class_exists('XSLTProcessor')) {
      $requirements['xslt']['value'] = t("Not installed");
      $requirements['xslt']['severity'] = REQUIREMENT_ERROR;
      $requirements['xslt']['description'] = t("Ensure that the PHP XSL extension is installed.");
    }
    else {
      $requirements['xslt']['value'] = t("Installed");
      $requirements['xslt']['serenity'] = REQUIREMENT_OK;
    }

    // Test for Imagick
    system("hash convert 2>&-", $return_value);
    $requirements['imagick']['title'] = t("Image Magick library");
    if ($return_value) {
      $requirements['imagick']['value'] = t("Not installed");
      $requirements['imagick']['severity'] = REQUIREMENT_ERROR;
      $requirements['imagick']['description'] = t('Ensure that the Image Magick library is installed.');
    }
    else {
      $requirements['imagick']['value'] = t("Installed");
      $requirements['imagick']['severity'] = REQUIREMENT_OK;
    }

    // Test for Kakadu  
    system("hash kdu_compress 2>&-", $return_value);
    $requirements['kakadu']['title'] = t("Kakadu library");
    if ($return_value) {
      $requirements['kakadu']['value'] = t("Not installed");
      $requirements['kakadu']['severity'] = REQUIREMENT_ERROR;
      $requirements['kakadu']['description'] = t('Ensure that the Kakadu library is installed.');
    }
    else {
      $requirements['kakadu']['value'] = t("Installed");
      $requirements['kakadu']['severity'] = REQUIREMENT_OK;
    }
  }
  elseif ($phase == 'runtime') {
    module_load_include('inc', 'fedora_repository', 'api/fedora_utils');

    $requirements['fedora-repository']['title'] = t("Fedora server");
    if (!fedora_available()) {
      $requirements['fedora-repository']['value'] = t("Not available");
      $requirements['fedora-repository']['severity'] = REQUIREMENT_ERROR;
      $requirements['fedora-repository']['description'] = t('Ensure that Fedora is running and that the <a href="@collection-settings">collection settings</a> are correct.', array('@collection-settings' => $base_url . '/admin/settings/fedora_repository'));
    }
    else {
      $requirements['fedora-repository']['value'] = t("Available");
      $requirements['fedora-repository']['severity'] = REQUIREMENT_OK;
    }

    // Check for ImageMagick
    $requirements['fedora-imagemagick']['title'] = t("ImageMagick convert in \$PATH");
    $result = exec('convert');
    if (!$result) {
      $requirements['fedora-imagemagick']['value'] = t('Not in $PATH');
      $requirements['fedora-imagemagick']['description'] = t('Islandora will not be able to create thumbnails. Ensure that <a href="www.imagemagick.org/">ImageMagick</a> is installed and the convert command is executable by the web server user.');
      $requirements['fedora-imagemagick']['severity'] = REQUIREMENT_WARNING;
    }
    else {
      $requirements['fedora-imagemagick']['value'] = t("Available");
      $requirements['fedora-imagemagick']['severity'] = REQUIREMENT_OK;
    }

    $requirements['fedora-kakadu']['title'] = 'Kakadu kdu_compress in $PATH';
    $kdu_res = exec('kdu_compress -v');
    if (!$kdu_res) {
      $requirements['fedora-kakadu']['value'] = ('Not in $PATH');
      $requirements['fedora-kakadu']['description'] = t('Islandora cannot convert TIFF image files to JPEG2000 format. Ensure <a href="http://www.kakadusoftware.com/">Kakadu</a> is installed and the kdu_compress command is executable by the web server user.');
      $requirements['fedora-kakadu']['severity'] = REQUIREMENT_WARNING;
    }
    else {
      $requirements['fedora-kakadu']['value'] = t("Available");
      $requirements['fedora-kakadu']['severity'] = REQUIREMENT_OK;
    }
  }

  return $requirements;
}