colorbox.module 16.2 KB
Newer Older
jdwfly's avatar
jdwfly committed
1
<?php
2

jdwfly's avatar
jdwfly committed
3
4
5
6
/**
 * @file
 * A light-weight, customizable lightbox plugin for jQuery 1.3
 */
7
8
9
10
11

/**
 * The default path to the Colorbox directory.
 */
define('COLORBOX_PATH', 'sites/all/libraries/colorbox');
12
define('COLORBOX_MIN_PLUGIN_VERSION', '1.3.16');
13
14
15


/**
16
 * Implements hook_theme().
17
18
 */
function colorbox_theme() {
19
  return array(
20
    'colorbox_imagefield' => array(
21
      'variables' => array(
22
        'image' => array(),
23
24
25
26
        'path' => NULL,
        'title' => NULL,
        'gid' => NULL,
      ),
27
28
29
      'file' => 'colorbox.theme.inc',
    ),

30
31
32
33
34
35
36
37
38
    'colorbox_insert_image' => array(
      'variables' => array(
        'item' => NULL,
        'widget' => NULL,
      ),
      'template' => 'colorbox-insert-image',
      'file' => 'colorbox.theme.inc',
    ),

39
40
41
42
43
    'colorbox_image_formatter' => array(
      'variables' => array(
        'item' => NULL,
        'node' => NULL,
        'field' => array(),
44
45
        'colorbox_node_style' => NULL,
        'colorbox_image_style' => NULL,
46
47
48
49
      ),
      'file' => 'colorbox.theme.inc',
    ),
  );
50
51
52
}

/**
53
 * Implements hook_init().
54
55
 */
function colorbox_init() {
56
57
58
59
60
  // Do not load colorbox during the Drupal installation process, e.g. if part
  // of installation profiles.
  if (!drupal_installation_attempted()) {
    _colorbox_doheader();
  }
61
62
}

63
/**
64
 * Implements hook_views_api().
65
66
67
68
 */
function colorbox_views_api() {
  return array(
    'api' => 2,
69
    'path' => drupal_get_path('module', 'colorbox') . '/views',
70
71
72
  );
}

73
/**
74
 * Implements hook_menu().
75
 */
76
function colorbox_menu() {
77
78
  $items = array();

79
  $items['admin/config/media/colorbox'] = array(
80
    'title' => 'Colorbox',
81
    'description' => 'Adjust Colorbox settings.',
82
    'file' => 'colorbox.admin.inc',
83
84
85
86
    'page callback' => 'drupal_get_form',
    'page arguments' => array('colorbox_admin_settings'),
    'access arguments' => array('administer site configuration'),
  );
87
88
89
90
91
  $items['user/login/colorbox'] = array(
    'title' => 'Login',
    'page callback' => 'colorbox_login',
    'access callback' => 'user_is_anonymous',
    'type' => MENU_CALLBACK,
92
    'file' => 'colorbox.pages.inc',
93
94
95
  );
  $items['colorbox/form'] = array(
    'title' => 'Form',
96
    'page callback' => 'colorbox_form_page',
97
    'page arguments' => array(2),
98
99
    'access callback' => '_colorbox_form_page_access',
    'access arguments' => array(2),
100
    'type' => MENU_CALLBACK,
101
    'file' => 'colorbox.pages.inc',
102
103
  );

104
105
106
  return $items;
}

107
/**
108
 * Colorbox menu access check.
109
 */
110
function _colorbox_form_page_access($form_id) {
111
112
113
  $access = FALSE;

  // First check if this is one of the forms Colorbox support out of the box.
114
  switch ($form_id) {
115
    case 'contact_site_form':
116
117
      $access = user_access('access site-wide contact form');
      break;
118
    case 'user_register_form':
119
120
121
122
123
124
125
      $access = user_register_access();
      break;
    case 'user_pass':
    case 'user_login':
    case 'user_login_block':
      $access = user_is_anonymous();
      break;
126
127
128
129
130
131
132
133
134
  }

  // 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;
      }
    }
135
  }
136
137

  return $access;
138
139
140
141
142
143
144
145
146
147
148
}

/**
 * Check if Colorbox should be active for the current URL.
 *
 * @return
 *   TRUE if Colorbox should be active for the current page.
 */
function _colorbox_active() {
  // Code from the block_list funtion in block.module.
  $path = drupal_get_path_alias($_GET['q']);
149
  $colorbox_pages = variable_get('colorbox_pages', "admin*\nimg_assist*\nimce*\nnode/add/*\nnode/*/edit");
150
  // Compare with the internal and path alias (if any).
151
  $page_match = drupal_match_path($path, $colorbox_pages);
152
  if ($path != $_GET['q']) {
153
    $page_match = $page_match || drupal_match_path($_GET['q'], $colorbox_pages);
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
  }

  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),
176
      'opacity' => variable_get('colorbox_opacity', '0.85'),
177
      'slideshow' => variable_get('colorbox_slideshow', 0) ? TRUE : FALSE,
178
179
180
181
      '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'),
182
183
184
185
      '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'),
186
187
188
      'overlayClose' => variable_get('colorbox_overlayclose', 1) ? TRUE : FALSE,
      'maxWidth' => variable_get('colorbox_maxwidth', '100%'),
      'maxHeight' => variable_get('colorbox_maxheight', '100%'),
189
190
191
192
    );
  }
  else {
    $js_settings = array(
193
      'opacity' => '0.85',
194
195
196
197
      'current' => t('{current} of {total}'),
      'previous' => t('« Prev'),
      'next' => t('Next »'),
      'close' => t('Close'),
198
199
      'maxWidth' => '100%',
      'maxHeight' => '100%',
200
    );
201
  }
202
203
204
205

  $path = drupal_get_path('module', 'colorbox');
  $style = variable_get('colorbox_style', 'default');

206
  // Give other modules the possibility to override Colorbox settings and style.
207
208
209
210
  $data = &$js_settings;
  $data['__drupal_alter_by_ref'] = array(&$style);
  drupal_alter('colorbox_settings', $data);

211
  drupal_add_js(array('colorbox' => $js_settings), array('type' => 'setting', 'scope' => JS_DEFAULT));
212

213
214
215
216
217
  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'))) {
218
219
      drupal_add_js(array('colorbox' => array('image_derivative' => $image_derivative)), array('type' => 'setting', 'scope' => JS_DEFAULT));
      drupal_add_js($path . '/js/colorbox_image_module.js');
220
221
222
    }
  }

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

227
228
229
230
231
232
233
234
235
236
237
238
239
240
  // 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');
241
242
  }

243
  if (variable_get('colorbox_load', 0)) {
244
    drupal_add_js($path . '/js/colorbox_load.js');
245
246
  }

247
248
249
250
  if (variable_get('colorbox_inline', 0)) {
    drupal_add_js($path . '/js/colorbox_inline.js');
  }

251
  if ($GLOBALS['user']->uid == 0 && variable_get('colorbox_login', 0)) {
252
    drupal_add_js($path . '/js/colorbox_login.js');
253
254
255
  }

  $already_added = TRUE;
256
257
}

258
259
260
261
262
263
/**
 * 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.
 *
264
 * @see version_compare()
265
 */
266
function colorbox_get_version($colorbox_js = NULL) {
267
268
269
270
  $version = 0;
  $pattern = '#ColorBox v([0-9\.a-z]+)#';

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

275
276
277
278
279
280
  // 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];
    }
281
282
283
284
285
  }

  return $version;
}

286
287
288
289
290
291
292
293
294
/**
 * Return the JS filename for Colorbox plugin.
 *
 * @return
 *   Boolean indicating if the JS is located.
 */
function colorbox_get_js() {
  $library_path = colorbox_get_path();

295
  if (file_exists($library_path . '/colorbox/jquery.colorbox.js') && file_exists($library_path . '/colorbox/jquery.colorbox-min.js')) {
296
297
    $colorbox_js_map = array('none' => 'jquery.colorbox.js', 'min' => 'jquery.colorbox-min.js');
    $colorbox_js = $colorbox_js_map[variable_get('colorbox_compression_type', 'min')];
298
    return $library_path . '/colorbox/' . $colorbox_js;
299
  }
300
301
302
303
//   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;
//   }
304
305
}

306
307
308
309
/**
 * Return the path to the Colorbox plugin.
 */
function colorbox_get_path() {
310
311
312
313
314
315
  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);
316
    if (is_dir($path . '/colorbox')) {
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
      $library_path = $path;
    }
    // Ask the libraries module as a fallback.
    elseif ($library_path == NULL && module_exists('libraries')) {
      if ($path = libraries_get_path('colorbox')) {
        $library_path = $path;
        variable_set('colorbox_path', $library_path);
      }
    }
    // HACK: If libraries api module is not installed but available, load it.
    elseif ($library_path == NULL && file_exists(dirname(__FILE__) . '/../libraries/libraries.module')) {
      require_once(dirname(__FILE__) . '/../libraries/libraries.module');
      if ($path = libraries_get_path('colorbox')) {
        $library_path = $path;
        variable_set('colorbox_path', $library_path);
      }
    }
    // If no path is found suggest the default one.
    elseif ($library_path == NULL) {
      $library_path = COLORBOX_PATH;
    }
  }

  return $library_path;
341
342
}

343
/**
344
 * Implements hook_form_alter().
345
346
 * Reformat the login form.
 */
347
function colorbox_form_alter(&$form, &$form_state, $form_id) {
348
349
350
351
352
353
354
355
356
357
358
  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) {
359
            if (variable_get('user_register', USER_REGISTER_VISITORS_ADMINISTRATIVE_APPROVAL)) {
360
361
362
363
364
365
              $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) {
366
367
            if (variable_get('user_register', USER_REGISTER_VISITORS_ADMINISTRATIVE_APPROVAL)) {
              $items[] = l(t('Create new account'), 'colorbox/form/user_register_form', array('query' => array('width' => '300', 'height' => 'auto'), 'attributes' => array('title' => t('Create a new user account.'), 'class' => 'colorbox-load')));
368
            }
369
            $items[] = l(t('Request new password'), 'colorbox/form/user_pass', array('query' => array('width' => '300', 'height' => '150'), 'attributes' => array('title' => t('Request new password via e-mail.'), 'class' => 'colorbox-load')));
370
          }
371
          $form['links'] = array('#markup' => theme('item_list', array('items' => $items)));
372
373
374
        }
      }
      break;
375
    case 'user_register_form':
376
      if (arg(0) == 'colorbox' && arg(1) == 'form') {
377
378
        $form['account']['name']['#size'] = 30;
        $form['account']['mail']['#size'] = 30;
379
380
381
382
383
384
385
      }
      break;
    case 'user_pass':
      if (arg(0) == 'colorbox' && arg(1) == 'form') {
        $form['name']['#size'] = 30;
      }
      break;
386
  }
387
388
}

389
/**
390
 * Implements hook_link_alter().
391
 */
392
function colorbox_link_alter(&$links, $node) {
393
  if ($node->type == 'image' && is_array($node->images) && variable_get('colorbox_auto_image_nodes', 0)) {
394
395
    // Add a colorbox class to the image link sizes on the image node.
    foreach ($node->images as $size => $path) {
396
397
398
      $links['image_size_' . $size]['attributes']['class'] = "image image-{$size} colorbox";
      $links['image_size_' . $size]['href'] = $path;
      unset($links['image_size_' . $size]['query']);
399
    }
400
  }
jdwfly's avatar
jdwfly committed
401
}
402

jdwfly's avatar
jdwfly committed
403
/**
404
 * Implements hook_field_formatter_info().
jdwfly's avatar
jdwfly committed
405
406
 */
function colorbox_field_formatter_info() {
407
408
409
410
411
412
413
  return array(
    'colorbox' => array(
      'label' => t('Colorbox'),
      'field types' => array('image'),
      'settings' => array('colorbox_node_style' => '', 'colorbox_image_style' => ''),
    ),
  );
414
}
415

416
/**
417
 * Implements hook_field_formatter_settings_form().
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
 */
function colorbox_field_formatter_settings_form($field, $instance, $view_mode, $form, &$form_state) {
  $display = $instance['display'][$view_mode];
  $settings = $display['settings'];

  $image_styles = image_style_options(FALSE);
  $element['colorbox_node_style'] = array(
    '#title' => t('Node image style'),
    '#type' => 'select',
    '#default_value' => $settings['colorbox_node_style'],
    '#empty_option' => t('None (original image)'),
    '#options' => $image_styles,
  );
  $element['colorbox_image_style'] = array(
    '#title' => t('Colorbox image style'),
    '#type' => 'select',
    '#default_value' => $settings['colorbox_image_style'],
    '#empty_option' => t('None (original image)'),
    '#options' => $image_styles,
  );

  return $element;
440
}
441

442
/**
443
 * Implements hook_field_formatter_settings_summary().
444
 */
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
function colorbox_field_formatter_settings_summary($field, $instance, $view_mode) {
  $display = $instance['display'][$view_mode];
  $settings = $display['settings'];

  $summary = array();

  $image_styles = image_style_options(FALSE);
  // Unset possible 'No defined styles' option.
  unset($image_styles['']);
  // Styles could be lost because of enabled/disabled modules that defines
  // their styles in code.
  if (isset($image_styles[$settings['colorbox_node_style']])) {
    $summary[] = t('Node image style: @style', array('@style' => $image_styles[$settings['colorbox_node_style']]));
  }
  else {
    $summary[] = t('Node image style: Original image');
  }
462

463
464
  if (isset($image_styles[$settings['colorbox_image_style']])) {
    $summary[] = t('Colorbox image style: @style', array('@style' => $image_styles[$settings['colorbox_image_style']]));
465
  }
466
467
468
469
470
471
472
473
  else {
    $summary[] = t('Colorbox image style: Original image');
  }

  return implode('<br />', $summary);
}

/**
474
 * Implements hook_field_formatter_view().
475
476
477
 */
function colorbox_field_formatter_view($entity_type, $entity, $field, $instance, $langcode, $items, $display) {
  $element = array();
478
479
480
481
482
483
484

  foreach ($items as $delta => $item) {
    $element[$delta] = array(
      '#theme' => 'colorbox_image_formatter',
      '#item' => $item,
      '#node' => $entity,
      '#field' => $field,
485
486
      '#colorbox_node_style' => $display['settings']['colorbox_node_style'],
      '#colorbox_image_style' => $display['settings']['colorbox_image_style'],
487
488
489
490
491
492
    );
  }

  return $element;
}

493
/**
494
 * Implements hook_insert_styles().
495
496
497
 */
function colorbox_insert_styles() {
  $insert_styles = array();
498
499
500
  foreach (image_styles() as $key => $style) {
    $insert_styles['colorbox__' . $key] = array('label' => 'Colorbox ' . $style['name']);
  }
501
502
503
504
505

  return $insert_styles;
}

/**
506
 * Implements hook_insert_content().
507
508
 */
function colorbox_insert_content($item, $style, $widget) {
509
  list($item['module_name'], $item['style_name']) = explode('__', $style['name'], 2);
510
  return theme('colorbox_insert_image', array('item' => $item, 'widget' => $widget));
511
}