colorbox.module 17.7 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
    'colorbox_image_formatter' => array(
      'variables' => array(
        'item' => NULL,
42
43
44
        'entity_type' => NULL,
        'entity' => NULL,
        'node' => NULL,  // Left for legacy support.
45
        'field' => array(),
46
        'display_settings' => array(),
47
48
49
50
      ),
      'file' => 'colorbox.theme.inc',
    ),
  );
51
52
53
}

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

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

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

80
  $items['admin/config/media/colorbox'] = array(
81
    'title' => 'Colorbox',
82
    'description' => 'Adjust Colorbox settings.',
83
    'file' => 'colorbox.admin.inc',
84
85
86
87
    'page callback' => 'drupal_get_form',
    'page arguments' => array('colorbox_admin_settings'),
    'access arguments' => array('administer site configuration'),
  );
88

89
90
91
  return $items;
}

92
93
94
95
96
97
98
/**
 * Check if Colorbox should be active for the current URL.
 *
 * @return
 *   TRUE if Colorbox should be active for the current page.
 */
function _colorbox_active() {
99
100
101
102
103
104
  // Make it possible deactivate Colorbox with
  // parameter ?colorbox=no in the url.
  if (isset($_GET['colorbox']) && $_GET['colorbox'] == 'no') {
    return FALSE;
  }

105
106
  // Code from the block_list funtion in block.module.
  $path = drupal_get_path_alias($_GET['q']);
107
  $colorbox_pages = variable_get('colorbox_pages', "admin*\nimagebrowser*\nimg_assist*\nimce*\nnode/add/*\nnode/*/edit\nprint/*\nprintpdf/*\nsystem/ajax\nsystem/ajax/*");
108
  // Compare with the internal and path alias (if any).
109
  $page_match = drupal_match_path($path, $colorbox_pages);
110
  if ($path != $_GET['q']) {
111
    $page_match = $page_match || drupal_match_path($_GET['q'], $colorbox_pages);
112
  }
113
  $page_match = variable_get('colorbox_visibility', 0) == 0 ? !$page_match : $page_match;
114

115
  return $page_match;
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
}

/**
 * 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),
135
      'opacity' => variable_get('colorbox_opacity', '0.85'),
136
      'slideshow' => variable_get('colorbox_slideshow', 0) ? TRUE : FALSE,
137
138
139
140
      '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'),
141
142
143
144
      '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'),
145
146
147
      'overlayClose' => variable_get('colorbox_overlayclose', 1) ? TRUE : FALSE,
      'maxWidth' => variable_get('colorbox_maxwidth', '100%'),
      'maxHeight' => variable_get('colorbox_maxheight', '100%'),
148
149
150
      'initialWidth' => variable_get('colorbox_initialwidth', '300'),
      'initialHeight' => variable_get('colorbox_initialheight', '100'),
      'fixed' => variable_get('colorbox_fixed', 1) ? TRUE : FALSE,
151
      'scrolling' => variable_get('colorbox_scrolling', 1) ? TRUE : FALSE,
152
153
154
155
    );
  }
  else {
    $js_settings = array(
156
      'opacity' => '0.85',
157
158
159
160
      'current' => t('{current} of {total}'),
      'previous' => t('« Prev'),
      'next' => t('Next »'),
      'close' => t('Close'),
161
162
      'maxWidth' => '100%',
      'maxHeight' => '100%',
163
      'fixed' => TRUE,
164
    );
165
  }
166
167
168
169

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

170
  // Give other modules the possibility to override Colorbox settings and style.
171
  $data = &$js_settings;
172
  drupal_alter('colorbox_settings', $data, $style);
173

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

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

180
181
182
183
184
185
186
187
188
189
190
191
192
193
  // 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');
194
195
  }

196
  if (variable_get('colorbox_load', 0)) {
197
    drupal_add_js($path . '/js/colorbox_load.js');
198
199
  }

200
201
202
203
  if (variable_get('colorbox_inline', 0)) {
    drupal_add_js($path . '/js/colorbox_inline.js');
  }

204
  $already_added = TRUE;
205
206
}

207
208
209
210
211
212
/**
 * 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.
 *
213
 * @see version_compare()
214
 */
215
function colorbox_get_version($colorbox_js = NULL) {
216
217
218
219
  $version = 0;
  $pattern = '#ColorBox v([0-9\.a-z]+)#';

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

224
225
226
227
228
229
  // 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];
    }
230
231
232
233
234
  }

  return $version;
}

235
236
237
238
239
240
241
242
243
/**
 * Return the JS filename for Colorbox plugin.
 *
 * @return
 *   Boolean indicating if the JS is located.
 */
function colorbox_get_js() {
  $library_path = colorbox_get_path();

244
  if (file_exists($library_path . '/colorbox/jquery.colorbox.js') && file_exists($library_path . '/colorbox/jquery.colorbox-min.js')) {
245
246
    $colorbox_js_map = array('none' => 'jquery.colorbox.js', 'min' => 'jquery.colorbox-min.js');
    $colorbox_js = $colorbox_js_map[variable_get('colorbox_compression_type', 'min')];
247
    return $library_path . '/colorbox/' . $colorbox_js;
248
  }
249
250
251
252
//   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;
//   }
253
254
}

255
256
257
258
/**
 * Return the path to the Colorbox plugin.
 */
function colorbox_get_path() {
259
260
261
262
263
264
  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);
265
    if (is_dir($path . '/colorbox')) {
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
      $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;
290
291
}

292
/**
293
 * Implements hook_link_alter().
294
 */
295
function colorbox_link_alter(&$links, $node) {
296
  if ($node->type == 'image' && is_array($node->images) && variable_get('colorbox_auto_image_nodes', 0)) {
297
298
    // Add a colorbox class to the image link sizes on the image node.
    foreach ($node->images as $size => $path) {
299
300
301
      $links['image_size_' . $size]['attributes']['class'] = "image image-{$size} colorbox";
      $links['image_size_' . $size]['href'] = $path;
      unset($links['image_size_' . $size]['query']);
302
    }
303
  }
jdwfly's avatar
jdwfly committed
304
}
305

jdwfly's avatar
jdwfly committed
306
/**
307
 * Implements hook_field_formatter_info().
jdwfly's avatar
jdwfly committed
308
309
 */
function colorbox_field_formatter_info() {
310
311
312
313
  return array(
    'colorbox' => array(
      'label' => t('Colorbox'),
      'field types' => array('image'),
314
315
316
317
318
319
      'settings' => array(
        'colorbox_node_style' => '',
        'colorbox_image_style' => '',
        'colorbox_gallery' => 'post',
        'colorbox_gallery_custom' => '',
        'colorbox_caption' => 'auto',
320
        'colorbox_caption_custom' => '',
321
      ),
322
323
    ),
  );
324
}
325

326
/**
327
 * Implements hook_field_formatter_settings_form().
328
329
330
331
332
333
 */
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);
334
335
  $image_styles_hide = $image_styles;
  $image_styles_hide['hide'] = t('Hide (do not display image)');
336
  $element['colorbox_node_style'] = array(
337
    '#title' => t('Content image style'),
338
339
340
    '#type' => 'select',
    '#default_value' => $settings['colorbox_node_style'],
    '#empty_option' => t('None (original image)'),
341
    '#options' => $image_styles_hide,
342
    '#description' => t('Image style to use in the content.'),
343
344
345
346
347
348
349
  );
  $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,
350
    '#description' => t('Image style to use in the Colorbox.'),
351
352
  );

353
354
355
356
357
358
359
360
361
362
363
364
365
  $gallery = array(
    'post' => t('Per post gallery'),
    'page' => t('Per page gallery'),
    'field_post' => t('Per field in post gallery'),
    'field_page' => t('Per field in page gallery'),
    'custom' => t('Custom'),
    'none' => t('No gallery'),
  );
  $element['colorbox_gallery'] = array(
    '#title' => t('Gallery (image grouping)'),
    '#type' => 'select',
    '#default_value' => $settings['colorbox_gallery'],
    '#options' => $gallery,
366
    '#description' => t('How Colorbox should group the image galleries.'),
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
  );
  $element['colorbox_gallery_custom'] = array(
    '#title' => t('Custom gallery'),
    '#type' => 'machine_name',
    '#maxlength' => 32,
    '#default_value' => $settings['colorbox_gallery_custom'],
    '#description' => t('All images on a page with the same gallery value (rel attribute) will be grouped together. It must only contain lowercase letters, numbers, and underscores.'),
    '#required' => FALSE,
    '#machine_name' => array(
      'exists' => 'colorbox_gallery_exists',
      'error' => t('The custom gallery field must only contain lowercase letters, numbers, and underscores.'),
    ),
    '#states' => array(
      'visible' => array(
        ':input[name$="[settings_edit_form][settings][colorbox_gallery]"]' => array('value' => 'custom'),
      ),
    ),
  );

  $caption = array(
    'auto' =>  t('Automatic'),
    'title' => t('Title text'),
    'alt' => t('Alt text'),
390
    'node_title' => t('Entity title'),
391
    'custom' => t('Custom (with tokens)'),
392
393
394
395
396
397
398
    'none' => t('None'),
  );
  $element['colorbox_caption'] = array(
    '#title' => t('Caption'),
    '#type' => 'select',
    '#default_value' => $settings['colorbox_caption'],
    '#options' => $caption,
399
    '#description' => t('Automatic will use the first none empty value of the title, the alt text and the entity title.'),
400
  );
401
402
403
404
405
406
407
408
409
410
  $element['colorbox_caption_custom'] = array(
    '#title' => t('Custom caption'),
    '#type' => 'textfield',
    '#default_value' => $settings['colorbox_caption_custom'],
    '#states' => array(
      'visible' => array(
        ':input[name$="[settings_edit_form][settings][colorbox_caption]"]' => array('value' => 'custom'),
      ),
    ),
  );
411
412
413
  // Allow users to hide or set a custom recursion limit.
  // The module token_tweaks sets a global recursion limit that can not be bypassed.
  if (module_exists('token') && $recursion_limit = min(variable_get('token_tree_recursion_limit', 3), variable_get('colorbox_token_recursion_limit', 3))) {
414
415
416
417
    $element['colorbox_token'] = array(
      '#type' => 'fieldset',
      '#title' => t('Replacement patterns'),
      '#theme' => 'token_tree',
418
      '#token_types' => array($instance['entity_type'], 'file'),
419
      '#recursion_limit' => $recursion_limit,
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
      '#states' => array(
        'visible' => array(
          ':input[name$="[settings_edit_form][settings][colorbox_caption]"]' => array('value' => 'custom'),
        ),
      ),
    );
  }
  else {
    $element['colorbox_token'] = array(
      '#type' => 'fieldset',
      '#title' => t('Replacement patterns'),
      '#description' => '<strong class="error">' . t('For token support the <a href="@token_url">token module</a> must be installed.', array('@token_url' => 'http://drupal.org/project/token')) . '</strong>',
      '#states' => array(
        'visible' => array(
          ':input[name$="[settings_edit_form][settings][colorbox_caption]"]' => array('value' => 'custom'),
        ),
      ),
    );
  }
439

440
  return $element;
441
}
442

443
/**
444
 * Implements hook_field_formatter_settings_summary().
445
 */
446
447
448
449
450
451
452
453
454
455
456
457
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']])) {
458
    $summary[] = t('Content image style: @style', array('@style' => $image_styles[$settings['colorbox_node_style']]));
459
  }
460
  else if ($settings['colorbox_node_style'] == 'hide') {
461
    $summary[] = t('Content image style: Hide');
462
  }
463
  else {
464
    $summary[] = t('Content image style: Original image');
465
  }
466

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

474
475
476
477
478
479
480
481
  $gallery = array(
    'post' => t('Per post gallery'),
    'page' => t('Per page gallery'),
    'field_post' => t('Per field in post gallery'),
    'field_page' => t('Per field in page gallery'),
    'custom' => t('Custom'),
    'none' => t('No gallery'),
  );
482
483
484
  if (isset($settings['colorbox_gallery'])) {
    $summary[] = t('Colorbox gallery type: @type', array('@type' => $gallery[$settings['colorbox_gallery']])) . ($settings['colorbox_gallery'] == 'custom' ? ' (' . $settings['colorbox_gallery_custom'] . ')' : '');
  }
485
486
487
488
489

  $caption = array(
    'auto' =>  t('Automatic'),
    'title' => t('Title text'),
    'alt' => t('Alt text'),
490
    'node_title' => t('Entity title'),
491
    'custom' => t('Custom (with tokens)'),
492
493
    'none' => t('None'),
  );
494
495
496
  if (isset($settings['colorbox_caption'])) {
    $summary[] = t('Colorbox caption: @type', array('@type' => $caption[$settings['colorbox_caption']]));
  }
497

498
499
500
501
  return implode('<br />', $summary);
}

/**
502
 * Implements hook_field_formatter_view().
503
504
505
 */
function colorbox_field_formatter_view($entity_type, $entity, $field, $instance, $langcode, $items, $display) {
  $element = array();
506
507
508
509
510

  foreach ($items as $delta => $item) {
    $element[$delta] = array(
      '#theme' => 'colorbox_image_formatter',
      '#item' => $item,
511
512
513
      '#entity_type' => $entity_type,
      '#entity' => $entity,
      '#node' => $entity, // Left for legacy support.
514
      '#field' => $field,
515
      '#display_settings' => $display['settings'],
516
517
518
519
520
521
    );
  }

  return $element;
}

522
/**
523
 * Implements hook_insert_styles().
524
525
526
 */
function colorbox_insert_styles() {
  $insert_styles = array();
527
  foreach (image_styles() as $key => $style) {
528
    $insert_styles['colorbox__' . $key] = array('label' => t('Colorbox @style', array('@style' => $style['name'])));
529
  }
530
531
532
533
534

  return $insert_styles;
}

/**
535
 * Implements hook_insert_content().
536
537
 */
function colorbox_insert_content($item, $style, $widget) {
538
  list($item['module_name'], $item['style_name']) = explode('__', $style['name'], 2);
539
  return theme('colorbox_insert_image', array('item' => $item, 'widget' => $widget));
540
}
541
542
543
544
545
546
547
548
549
550

/**
 * Machine names normally need to be unique but that does not apply to galleries.
 *
 * @return
 *   Always FALSE
 */
function colorbox_gallery_exists() {
  return FALSE;
}