colorbox.module in Colorbox 6

A light-weight, customizable lightbox plugin for jQuery 1.3

File

colorbox.module

<?php

/**
 * @file
 * A light-weight, customizable lightbox plugin for jQuery 1.3
 */

/**
 * The default path to the Colorbox directory.
 */
define('COLORBOX_PATH', 'sites/all/libraries/colorbox');
define('COLORBOX_MIN_PLUGIN_VERSION', '1.3.18');
define('COLORBOX_MIN_JQUERY_VERSION', '1.3.1');
define('COLORBOX_MAX_JQUERY_VERSION', '1.4+');

/**
 * Implementation of hook_theme().
 */
function colorbox_theme() {
  $theme = array(
    'colorbox_imagefield' => array(
      'arguments' => array(
        'namespace' => NULL,
        'path' => NULL,
        'alt' => NULL,
        'title' => NULL,
        'gid' => NULL,
        'field_name' => NULL,
        'attributes' => NULL,
      ),
      'file' => 'colorbox.theme.inc',
    ),
    'colorbox_insert_image' => array(
      'arguments' => array(
        'item' => NULL,
        'widget' => NULL,
      ),
      'template' => 'colorbox-insert-image',
      'file' => 'colorbox.theme.inc',
    ),
  );
  if (module_exists('imagecache')) {
    foreach (imagecache_presets() as $preset) {
      $theme['colorbox_formatter_' . $preset['presetname'] . '__colorbox'] = array(
        'function' => 'theme_colorbox_formatter_imagefield',
        'arguments' => array(
          'element' => NULL,
        ),
        'file' => 'colorbox.theme.inc',
      );
    }
  }
  return $theme;
}

/**
 * Implementation of hook_init().
 */
function colorbox_init() {

  // Install and update pages are treated differently to prevent theming overrides.
  if (defined('MAINTENANCE_MODE') && (MAINTENANCE_MODE == 'install' || MAINTENANCE_MODE == 'update')) {
    return;
  }
  _colorbox_doheader();
}

/**
 * Implementation of hook_views_api().
 */
function colorbox_views_api() {
  return array(
    'api' => 2,
    'path' => drupal_get_path('module', 'colorbox') . '/views',
  );
}

/**
 * Implementation of hook_menu().
 */
function colorbox_menu() {
  $items = array();
  $items['admin/settings/colorbox'] = array(
    'title' => 'Colorbox',
    'description' => 'Adjust Colorbox settings.',
    'file' => 'colorbox.admin.inc',
    'page callback' => 'drupal_get_form',
    'page arguments' => array(
      'colorbox_admin_settings',
    ),
    'access arguments' => array(
      'administer site configuration',
    ),
  );
  $items['user/login/colorbox'] = array(
    'title' => 'Login',
    'page callback' => 'colorbox_login',
    'access callback' => 'user_is_anonymous',
    'type' => MENU_CALLBACK,
    'file' => 'colorbox.pages.inc',
  );
  $items['colorbox/form'] = array(
    'title' => 'Form',
    'page callback' => 'colorbox_form_page',
    'page arguments' => array(
      2,
    ),
    'access callback' => '_colorbox_form_page_access',
    'access arguments' => array(
      2,
    ),
    'type' => MENU_CALLBACK,
    'file' => 'colorbox.pages.inc',
  );
  return $items;
}

/**
 * Colorbox menu access check.
 */
function _colorbox_form_page_access($form_id) {
  $access = FALSE;

  // First check if this is one of the forms Colorbox support out of the box.
  switch ($form_id) {
    case 'contact_mail_page':
      $access = user_access('access site-wide contact form');
      break;
    case 'user_register':
      $access = user_register_access();
      break;
    case 'user_pass':
    case 'user_login':
    case 'user_login_block':
      $access = user_is_anonymous();
      break;
  }

  // Invoke hook_colorbox_form_access for all modules.
  if (!$access) {
    foreach (module_implements('colorbox_form_access') as $module) {
      if ($access = module_invoke($module, 'colorbox_form_access', $form_id)) {
        return $access;
      }
    }
  }
  return $access;
}

/**
 * Check if Colorbox should be active for the current URL.
 *
 * @return
 *   TRUE if Colorbox should be active for the current page.
 */
function _colorbox_active() {

  // Make it possible deactivate Colorbox with
  // parameter ?colorbox=no in the url.
  if (isset($_GET['colorbox']) && $_GET['colorbox'] == 'no') {
    return FALSE;
  }

  // Code from the block_list funtion in block.module.
  $path = drupal_get_path_alias($_GET['q']);
  $colorbox_pages = variable_get('colorbox_pages', "admin*\nimg_assist*\nimce*\nnode/add/*\nnode/*/edit");

  // Compare with the internal and path alias (if any).
  $page_match = drupal_match_path($path, $colorbox_pages);
  if ($path != $_GET['q']) {
    $page_match = $page_match || drupal_match_path($_GET['q'], $colorbox_pages);
  }
  return !$page_match;
}

/**
 * Loads the various js and css files.
 */
function _colorbox_doheader() {
  static $already_added = FALSE;
  if ($already_added) {
    return;

    // Don't add the JavaScript and CSS multiple times.
  }
  if (!_colorbox_active()) {
    return;

    // Don't add the JavaScript and CSS on specified paths.
  }

  // Insert options and translated strings as javascript settings.
  if (variable_get('colorbox_custom_settings_activate', 0)) {
    $js_settings = array(
      'transition' => variable_get('colorbox_transition_type', 'elastic'),
      'speed' => variable_get('colorbox_transition_speed', 350),
      'opacity' => variable_get('colorbox_opacity', '0.9'),
      'slideshow' => variable_get('colorbox_slideshow', 0) ? TRUE : FALSE,
      'slideshowAuto' => variable_get('colorbox_slideshowauto', 1) ? TRUE : FALSE,
      'slideshowSpeed' => variable_get('colorbox_slideshowspeed', 2500),
      'slideshowStart' => variable_get('colorbox_text_start', 'start slideshow'),
      'slideshowStop' => variable_get('colorbox_text_stop', 'stop slideshow'),
      'current' => variable_get('colorbox_text_current', '{current} of {total}'),
      'previous' => variable_get('colorbox_text_previous', '« Prev'),
      'next' => variable_get('colorbox_text_next', 'Next »'),
      'close' => variable_get('colorbox_text_close', 'Close'),
      'overlayClose' => variable_get('colorbox_overlayclose', 1) ? TRUE : FALSE,
      'maxWidth' => variable_get('colorbox_maxwidth', '100%'),
      'maxHeight' => variable_get('colorbox_maxheight', '100%'),
    );
  }
  else {
    $js_settings = array(
      'transition' => 'elastic',
      'speed' => 350,
      'opacity' => '0.85',
      'slideshow' => FALSE,
      'slideshowAuto' => FALSE,
      'slideshowSpeed' => 2500,
      'slideshowStart' => '',
      'slideshowStop' => '',
      'current' => t('{current} of {total}'),
      'previous' => t('« Prev'),
      'next' => t('Next »'),
      'close' => t('Close'),
      'overlayClose' => TRUE,
      'maxWidth' => '100%',
      'maxHeight' => '100%',
    );
  }
  $path = drupal_get_path('module', 'colorbox');
  $style = variable_get('colorbox_style', 'default');

  // Give other modules the possibility to override Colorbox settings and style.
  $data =& $js_settings;
  $data['__drupal_alter_by_ref'] = array(
    &$style,
  );
  drupal_alter('colorbox_settings', $data);
  drupal_add_js(array(
    'colorbox' => $js_settings,
  ), 'setting');
  if (module_exists('image') && variable_get('colorbox_auto_image_nodes', 0)) {
    $image_derivative = variable_get('colorbox_image_derivative', 'preview');

    // If the image derivative is set to IMAGE_ORIGINAL check if the
    // user has access before activating Colorbox.
    if (!($image_derivative == IMAGE_ORIGINAL && !user_access('view original images'))) {
      drupal_add_js(array(
        'colorbox' => array(
          'image_derivative' => $image_derivative,
        ),
      ), 'setting');
      drupal_add_js($path . '/js/colorbox_image_module.js');
    }
  }
  if (module_exists('img_assist') && variable_get('colorbox_auto_img_assist_custom', 0)) {
    $img_assist_derivative = variable_get('colorbox_img_assist_derivative', 'preview');

    // If the image derivative is set to IMAGE_ORIGINAL check if the
    // user has access before activating Colorbox.
    if (!($img_assist_derivative == IMAGE_ORIGINAL && !user_access('view original images'))) {
      drupal_add_js(array(
        'colorbox' => array(
          'img_assist_derivative' => $img_assist_derivative,
        ),
      ), 'setting');
      drupal_add_js($path . '/js/colorbox_img_assist_module.js');
    }
  }

  // Add and initialise the Colorbox plugin.
  drupal_add_js(colorbox_get_js());
  drupal_add_js($path . '/js/colorbox.js');

  // Add JS and CSS based on selected style.
  switch ($style) {
    case 'none':
      break;
    case 'default':
      drupal_add_css($path . '/styles/default/colorbox_default_style.css');
      drupal_add_js($path . '/styles/default/colorbox_default_style.js');
      break;
    case 'stockholmsyndrome':
      drupal_add_css($path . '/styles/stockholmsyndrome/colorbox_stockholmsyndrome.css');
      drupal_add_js($path . '/styles/stockholmsyndrome/colorbox_stockholmsyndrome.js');
      break;
    default:
      drupal_add_css($style . '/colorbox.css');
  }
  if (variable_get('colorbox_load', 0)) {
    drupal_add_js($path . '/js/colorbox_load.js');
  }
  if (variable_get('colorbox_inline', 0)) {
    drupal_add_js($path . '/js/colorbox_inline.js');
  }
  if ($GLOBALS['user']->uid == 0 && variable_get('colorbox_login', 0)) {
    drupal_add_js($path . '/js/colorbox_login.js');
  }
  $already_added = TRUE;
}

/**
 * Return the version of Colorbox plugin that is installed.
 *
 * This can be used by other modules' hook_requirements() to ensure that the
 * proper version of Colorbox plugin is installed.
 *
 * @see version_compare()
 */
function colorbox_get_version($colorbox_js = NULL) {
  $version = 0;
  $pattern = '#ColorBox v([0-9\\.a-z]+)#';

  // No file is passed in so use the default location.
  if (is_null($colorbox_js)) {
    $colorbox_js = colorbox_get_js();
  }

  // Return the version of Colorbox plugin, it it exists.
  if (file_exists($colorbox_js)) {
    $colorbox_plugin = file_get_contents($colorbox_js, NULL, NULL, 0, 32);
    if (preg_match($pattern, $colorbox_plugin, $matches)) {
      $version = $matches[1];
    }
  }
  return $version;
}

/**
 * Return the JS filename for Colorbox plugin.
 *
 * @return
 *   Boolean indicating if the JS is located.
 */
function colorbox_get_js() {
  $library_path = colorbox_get_path();
  if (file_exists($library_path . '/colorbox/jquery.colorbox.js') && file_exists($library_path . '/colorbox/jquery.colorbox-min.js')) {
    $colorbox_js_map = array(
      'none' => 'jquery.colorbox.js',
      'min' => 'jquery.colorbox-min.js',
    );
    $colorbox_js = $colorbox_js_map[variable_get('colorbox_compression_type', 'min')];
    return $library_path . '/colorbox/' . $colorbox_js;
  }

  //   else {
  //     drupal_set_message(t('You need to download the !colorbox and extract the entire contents of the archive into the %path folder of your server.', array('!colorbox' => l(t('Colorbox plugin'), 'http://colorpowered.com/colorbox/'), '%path' => $library_path)), 'error', FALSE);
  //     return FALSE;
  //   }
}

/**
 * Return the path to the Colorbox plugin.
 */
function colorbox_get_path() {
  static $library_path = NULL;

  // Try to locate the library path in any possible setup.
  if ($library_path == NULL) {

    // First check the default location.
    $path = variable_get('colorbox_path', COLORBOX_PATH);
    if (is_dir($path . '/colorbox')) {
      $library_path = $path;
    }
    elseif ($library_path == NULL && module_exists('libraries')) {
      if ($path = libraries_get_path('colorbox')) {
        $library_path = $path;
        variable_set('colorbox_path', $library_path);
      }
    }
    elseif ($library_path == NULL) {
      $library_path = COLORBOX_PATH;
    }
  }
  return $library_path;
}

/**
 * Implementation of hook_form_alter().
 * Reformat the login form.
 */
function colorbox_form_alter(&$form, $form_state, $form_id) {
  switch ($form_id) {
    case 'user_login':
      if (arg(0) == 'user' && arg(1) == 'login' && arg(2) == 'colorbox') {
        $form['name']['#size'] = 25;
        $form['pass']['#size'] = 25;

        // Add links as needed.
        if (variable_get('colorbox_login_links', 0)) {
          $items = array();

          // Add standard links.
          if (variable_get('colorbox_login_links', 0) == 1) {
            if (variable_get('user_register', 1)) {
              $items[] = l(t('Create new account'), 'user/register', array(
                'attributes' => array(
                  'title' => t('Create a new user account.'),
                ),
              ));
            }
            $items[] = l(t('Request new password'), 'user/password', array(
              'attributes' => array(
                'title' => t('Request new password via e-mail.'),
              ),
            ));
          }

          // Add links that opens in a Colorbox.
          if (variable_get('colorbox_login_links', 0) == 2) {
            if (variable_get('user_register', 1)) {
              $items[] = l(t('Create new account'), 'colorbox/form/user_register', array(
                'query' => 'width=300&height=auto',
                'attributes' => array(
                  'title' => t('Create a new user account.'),
                  'class' => 'colorbox-load',
                ),
              ));
            }
            $items[] = l(t('Request new password'), 'colorbox/form/user_pass', array(
              'query' => 'width=300&height=150',
              'attributes' => array(
                'title' => t('Request new password via e-mail.'),
                'class' => 'colorbox-load',
              ),
            ));
          }
          $form['links'] = array(
            '#value' => theme('item_list', $items),
          );
        }
      }
      break;
    case 'user_register':
      if (arg(0) == 'colorbox' && arg(1) == 'form') {
        $form['name']['#size'] = 30;
        $form['mail']['#size'] = 30;
      }
      break;
    case 'user_pass':
      if (arg(0) == 'colorbox' && arg(1) == 'form') {
        $form['name']['#size'] = 30;
      }
      break;
  }
}

/**
 * Implementation of hook_link_alter().
 */
function colorbox_link_alter(&$links, $node) {
  if ($node->type == 'image' && is_array($node->images) && variable_get('colorbox_auto_image_nodes', 0)) {

    // Add a colorbox class to the image link sizes on the image node.
    foreach ($node->images as $size => $path) {
      $links['image_size_' . $size]['attributes']['class'] = "image image-{$size} colorbox";
      $links['image_size_' . $size]['href'] = $path;
      unset($links['image_size_' . $size]['query']);
    }
  }
}

/**
 * Implementation of hook_field_formatter_info().
 *
 * Adds certain colorbox+imagecache formatters to CCK image fields if imagefield.module and imagecache.module exist.
 */
function colorbox_field_formatter_info() {
  $formatters = array();
  if (module_exists('imagefield') && module_exists('imagecache')) {
    foreach (imagecache_presets() as $preset) {
      $formatters[$preset['presetname'] . '__colorbox'] = array(
        'label' => t('Colorbox: @preset image', array(
          '@preset' => $preset['presetname'],
        )),
        'field types' => array(
          'image',
          'filefield',
        ),
      );
    }
  }
  return $formatters;
}

/**
 * Implementation of hook_insert_styles().
 */
function colorbox_insert_styles() {
  $insert_styles = array();
  $insert_styles = colorbox_field_formatter_info();
  return $insert_styles;
}

/**
 * Implementation of hook_insert_content().
 */
function colorbox_insert_content($item, $style, $widget) {
  list($item['presetname'], $item['modulename']) = explode('__', $style['name'], 2);
  return theme('colorbox_insert_image', $item, $widget);
}

Functions

Name	Description
colorbox_field_formatter_info	Implementation of hook_field_formatter_info().
colorbox_form_alter	Implementation of hook_form_alter(). Reformat the login form.
colorbox_get_js	Return the JS filename for Colorbox plugin.
colorbox_get_path	Return the path to the Colorbox plugin.
colorbox_get_version	Return the version of Colorbox plugin that is installed.
colorbox_init	Implementation of hook_init().
colorbox_insert_content	Implementation of hook_insert_content().
colorbox_insert_styles	Implementation of hook_insert_styles().
colorbox_link_alter	Implementation of hook_link_alter().
colorbox_menu	Implementation of hook_menu().
colorbox_theme	Implementation of hook_theme().
colorbox_views_api	Implementation of hook_views_api().
_colorbox_active	Check if Colorbox should be active for the current URL.
_colorbox_doheader	Loads the various js and css files.
_colorbox_form_page_access	Colorbox menu access check.

Constants

Name	Description
COLORBOX_MAX_JQUERY_VERSION
COLORBOX_MIN_JQUERY_VERSION
COLORBOX_MIN_PLUGIN_VERSION
COLORBOX_PATH	The default path to the Colorbox directory.