- task: sync with latest Drupal-5 branch changes

[project/gallery.git] / gallery_base.inc

<?php
// $Id$

/**
 * gallery.module : gallery_base.inc
 * Base functions
 */

define(GALLERY_NO_EMBED_THEME,  -1);

define(GALLERY_ERROR_WATCHDOG,  1);
define(GALLERY_ERROR_BROWSER,   2);
define(GALLERY_ERROR_VERBOSE,   3);

/**
 * Login user into embedded gallery
 */
function gallery_login() {
  _gallery_init();
}

/**
 * End user session
 */
function gallery_logout() {
  if (variable_get('gallery_valid', FALSE)) {
    require_once(variable_get('gallery_dir', './gallery2/') . 'embed.php');
    GalleryEmbed::logout();
  }
}

/**
 * Initialize embedded gallery
 */
function _gallery_init($full = FALSE, $vars = NULL) {
  global $user;
  static $ready = FALSE;
  
  // initialize only once
  if ($ready) {
    return $ready;
  }
  
  if (!$vars) {
    $embedPath = variable_get('gallery_dir', './gallery2/') . 'embed.php';
    $g2Uri =  variable_get('gallery_uri', '/gallery2/');
    $embedUri = variable_get('gallery_embed_uri', '?q=gallery');
    $gallery_valid = variable_get('gallery_valid', 0);
    $uid = ($user->uid > 0) ? $user->uid : '';
  } else {
    $embedPath = $vars['gallery_dir'] . 'embed.php';
    $g2Uri = $vars['gallery_uri'];
    $embedUri = $vars['gallery_embed_uri'];
    $gallery_valid = $vars['gallery_valid'];
    $uid = '';
  }
  
  $init_err_msg = t('Unable to initialize embedded Gallery. You need to <a href="@link"> configure your embedded Gallery</a>.', array('@link' => url('admin/settings/gallery/install')));

  if ((!$gallery_valid) || (!is_readable($embedPath))) {
    gallery_error($init_err_msg, NULL, TRUE);
    return $ready;
  }

  include_once($embedPath);
  
  $params = array('embedUri' => $embedUri,
                  'g2Uri' => $g2Uri,
                  'loginRedirect' => url('user/login', NULL, NULL, TRUE),
                  'activeUserId' => $uid,
                  'activeLanguage' => gallery_get_language($user),
                  'fullInit' => $full,
                  'apiVersion' => array(1,2));

  $ret = GalleryEmbed::init($params);
  if ($ret) {
    if ($ret->getErrorCode() & ERROR_PLUGIN_VERSION_MISMATCH) {
      gallery_error($vars ? t('Embedding API version is incompatible') : $init_err_msg, $ret, TRUE);
      return $ready;
    }
    else {
      gallery_error($init_err_msg, $ret, TRUE);
      return $ready;
    }
  }
  
  $ready = TRUE;
  
  return $ready;
}

/**
 * handleRequest extension with error handling
 */
function gallery_handle_request() {
  ob_start();
  $result = GalleryEmbed::handleRequest();
  $output = ob_get_contents();
  ob_end_clean();

  if ($output) {
    preg_match('%<div id="giStackTrace" [^>]*>(.*?)</div>%is', $output, $matches);
    gallery_error(t('Error handling request (invalid request)<br />or the requested Gallery URL does not exist.'), $matches[1]);
    return NULL;
  }

  /*
  // switch theme
  $themeid = variable_get('gallery_theme', GALLERY_NO_EMBED_THEME);
  if ($themeid != GALLERY_NO_EMBED_THEME) {
  	list ($ret, $theme) = GalleryCoreApi::loadPlugin('theme', $themeid, false, true);
  	if ($ret) {
      gallery_error(t('Error switching theme'), $ret);
      return NULL;
    }
  }
  //////
  $ret = GalleryCoreApi::setPluginParameter('module', 'core', 'theme', $themeid);
  if ($ret) {
    gallery_error(t('Error switching theme'), $ret);
    return NULL;
  }
  */

  return $result;
}

/**
 * Get the language for $user
 */
function gallery_get_language($user) {
  if (($user->uid == 0 || !($user->language))) {
    if (module_exists('i18n')) {
      return i18n_get_lang();
    }
    else if (module_exists('locale')) {
      $result = db_query('SELECT locale FROM {locales_meta} WHERE isdefault = 1');
      $row = db_fetch_object($result);
      return $row->locale;
    }
  }

  return $user->language;
}

/**
 * Include head information with check made for uniqueness (see drupal_add_js)
 */
function gallery_set_html_head($info, $unique = TRUE) {
  static $sent = array();
  if ($unique) {
    // only set html head if this info has not been sent before.
    $hash_info = md5($info);
    if (!isset($sent[$hash_info])) {
      drupal_set_html_head($info);
      $sent[$hash_info] = TRUE;
    }
  } else {
    drupal_set_html_head($info);
  }
}

/**
 * Retrieve all (active) themes from Gallery2
 */
function gallery_get_themes($all = FALSE) {
  // list of themes
  list ($ret, $g2_themes) = GalleryCoreApi::fetchPluginStatus('theme', TRUE);
  if ($ret) {
    gallery_error(t('Error retrieving theme list'), $ret);
    return array();
  }

  $themes = array();
  foreach (array_keys($g2_themes) as $themeid) {
    // only active themes
    if (!empty($g2_themes[$themeid]['active']) || $all) {
      // get theme details
      list ($ret, $theme) = GalleryCoreApi::loadPlugin('theme', $themeid, TRUE);
      if ($ret) {
        gallery_error(t('Error getting theme (:themeid) details',
          array(':themeid' => $themeid)), $ret);
        return array();
	    }
	    $themes[$themeid] = $theme->getName();
    }
  }
	
	return $themes;
}

/**
 * Implementation of gallery_generate_url
 */
function gallery_generate_url($params, $html = TRUE, $full = TRUE) {
  $options = array();
  $options['forceFullUrl'] = $full;
  $options['htmlEntities'] = $html;
  
  $urlGenerator =& $GLOBALS['gallery']->getUrlGenerator();
  if (!$urlGenerator) {
    gallery_error(t('Error: UrlGenerator not available'));
    return '';
  }
  
  return $urlGenerator->generateUrl($params, $options);
}

/**
 * Implementation of gallery_item_details
 */
function gallery_item_details($id, $verbose = FALSE) {
  $details = array();
  // load entity
  list ($ret, $entity) = GalleryCoreApi::loadEntitiesById($id);
  if ($ret) {
    gallery_error(t('Error fetching album details (entityId: :id)',
      array(':id' => $id)), $ret);
    return $details;
  }
  // extract details
  $details['type'] = $entity->entityType;
  $details['title'] = $entity->title;
  $details['owner'] = $entity->ownerId;
  $details['parent'] = $entity->parentId;

  if ($verbose) {
    $details['description'] = $entity->description;
    $details['summary'] = $entity->summary;
    $details['keywords'] = $entity->keywords;
  }

  return $details;
}

/**
 * Split an image block result into individual images
 */
function _gallery_split_imageblock($html) {
  /**
   * From http://uk.php.net/manual/en/function.preg-split.php
   * Split the html from image block into <...> parts
   */
  $pattern = '/(<(?:[^<>]+(?:"[^"]*"|\'[^\']*\')?)+>)/';
  $html_array = preg_split ($pattern, trim ($html), -1, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY);
  
  $ndx = 0;
  $images = array();
  $image_html = '';
  // iterate through this array and combine again, but on a per-image basis
  foreach ($html_array as $value) {
    $value = trim($value);
    $image_html .= $value; 
    if (!strcmp($value, '<div class="one-image">')) {
      // found the opening <div> for the image
      $open_divs = 0;
    } else if (!strncmp($value, '<div', 4)) {
      // found a <div> but not the main image one (eg a frame)
      $open_divs++;
    } else if (!strcmp($value, '</div>')) {
      // found a </div> but check if it's for the main image or a subcomponent (eg frame)
      if ($open_divs>0) {
        $open_divs--;
      } else {
        // this must be the closing div for "one-image" so move to next image
        $images[] = $image_html;
        $image_html = '';
      }
    }
  }
  
  return $images;  
}

/* 
 * --------------------------------------------------------------------------
 * Error, Debug and Status Functions
 * --------------------------------------------------------------------------
 */

function gallery_error($msg, $ret = NULL, $force = FALSE) {
  $error_mode = variable_get('gallery_error_mode', array(GALLERY_ERROR_WATCHDOG));
  // verbose error messages
  if (in_array(GALLERY_ERROR_VERBOSE, $error_mode) || variable_get('gallery_debug', 0)) {
    $msg = $ret ? (is_object($ret) ? ($msg . '<br />' . $ret->getAsHtml()) : $ret) : $msg;
    if (function_exists('debug_backtrace')) {
      $trace = debug_backtrace();
      $source = t('Error in function \':func()\' (:file::line):<br />',
        array(':func' => $trace[1]['function'], ':file' => basename($trace[0]['file']), ':line' => $trace[0]['line']));
      $message  = $source . '<ul><li>' . $msg . '</li></ul>';
    }
  }
  $message = !empty($message) ? $message : $msg;
  // debug output (skip watchdog)
  if (variable_get('gallery_debug', 0)) {
    drupal_set_message($message, 'error');
    return;
  }
  // error output to browser
  if (in_array(GALLERY_ERROR_BROWSER, $error_mode)) {
    drupal_set_message($message, 'error');
  }
  else if ($force) {
    drupal_set_message(user_access('administer site configuration') ? $message : t('Embedded Gallery2 is not available.'), 'error');
  }
  // error output to watchdog
  if (in_array(GALLERY_ERROR_WATCHDOG, $error_mode)) {
    watchdog('gallery', $message, WATCHDOG_ERROR);
  }
}

function gallery_debug($array, $label = 'Gallery Debug') {
  if (variable_get('gallery_debug', 0) && user_access('administer site configuration')) {
    drupal_set_message('<strong>' . $label . ':</strong><br />' . nl2br(htmlspecialchars(print_r($array, TRUE))), 'error');
  }
}

function gallery_set_status($status = array(), $reset = FALSE) {
  $status_array = $status;
  if (!$reset) {
    $status_array = unserialize(variable_get('gallery_status', serialize(array())));
    foreach ($status as $key => $value) {
      $status_array[$key] = $value;
    }
  }
  
  variable_set('gallery_status', serialize($status_array));
}

function gallery_get_status() {
  return unserialize(variable_get('gallery_status', serialize(array())));
}

function gallery_format_status($status = array(), $title = 'Gallery message(s):') {
  $message = $title . '<ul>';
  if (count($status)) {
    foreach ($status as $item) {
      $message .= '<li>' . t($item['title']);
      if (isset($item['success']) && $item['success']) {
        $message .= ' <span class=\'g2_embed_success\'>' . t('Success') . '</span>';
      } else if (isset($item['warning']) && $item['warning']) {
        $message .= ' <span class=\'g2_embed_warning\'>' . t('Warning') . '</span>';
        $message .= '<ul><li>' . t($item['notice']) . '</li></ul>';
      } else if (isset($item['error']) && $item['error']) {
        $message .= ' <span class=\'g2_embed_error\'>' . t('Error') . '</span>';
        $message .= '<ul><li>' . t($item['notice']) . '</li></ul>';
      } else if (isset($item['advise']) && $item['advise']) {
        $message .= ' <span class=\'g2_embed_warning\'>' . t('Advisory') . '</span>';
        $message .= '<ul><li>' . t($item['notice']) . '</li></ul>';
      } else if (isset($item['message']) && $item['message']) {
        $message .= ': ' . t($item['message']);
      }
    }
  }
  else {
    $message = t('Status not available');
  }
  $message .= '</ul>';
  
  return $message;
}

function gallery_version($setstatus = TRUE) {
  if (!_gallery_init(FALSE)) {
    return '';
  }
  
  list ($core_major, $core_minor) = GalleryCoreApi::getApiVersion();
  list ($embed_major, $embed_minor) = GalleryEmbed::getApiVersion();
  $version = "$core_major.$core_minor / $embed_major.$embed_minor";
  
  if ($setstatus) {
    $status = array('version' => array('title' => t('Gallery2 API version'), 'message' => $version));
    gallery_set_status($status);
  }
  
  GalleryEmbed::done();
  return $version;
}

?>