color.module 25.4 KB
Newer Older
1
<?php
2 3 4 5
/**
 * @file
 * Allows users to change the color scheme of themes.
 */
6

7
/**
8
 * Implements hook_help().
9 10 11 12
 */
function color_help($path, $arg) {
  switch ($path) {
    case 'admin/help#color':
13
      $output = '<h3>' . t('About') . '</h3>';
14
      $output .= '<p>' . t('The Color module allows users with the <em>Administer site configuration</em> permission to quickly and easily change the color scheme of themes that have been built to be compatible with it. For more information, see the online handbook entry for <a href="@color">Color module</a>.', array('@color' => 'http://drupal.org/documentation/modules/color')) . '</p>';
15 16
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
17
      $output .= '<dt>' . t('Changing colors') . '</dt>';
18
      $output .= '<dd>' . t("Using the Color module allows you to easily change the color of links, backgrounds, text, and other theme elements. To change the color settings for a compatible theme, select the <em>Settings</em> link for your theme on the <a href='@configure'>Themes administration page</a>. If you don't see a color picker on that page, then your theme is not compatible with the color module. If you are sure that the theme does indeed support the color module, but the color picker does not appear, then <a href='@troubleshoot'>follow these troubleshooting procedures</a>.", array('@configure' => url('admin/appearance'), '@troubleshoot' => 'http://drupal.org/node/109457')) . '</dd>';
19 20
      $output .= '<dd>' . t("The Color module saves a modified copy of the theme's specified stylesheets in the files directory. This means that if you make any manual changes to your theme's stylesheet, <em>you must save your color settings again, even if they haven't changed</em>. This step is required because the module stylesheets (in the files directory) need to be recreated to include your changes.") . '</dd>';
      $output .= '</dl>';
21 22 23 24
      return $output;
  }
}

25
/**
26
 * Implements hook_theme().
27 28 29 30
 */
function color_theme() {
  return array(
    'color_scheme_form' => array(
31
      'render element' => 'form',
32 33 34
    ),
  );
}
35

36
/**
37
 * Implements hook_form_FORM_ID_alter().
38
 */
39
function color_form_system_theme_settings_alter(&$form, &$form_state) {
40
  if (isset($form_state['build_info']['args'][0]) && ($theme = $form_state['build_info']['args'][0]) && color_get_info($theme) && function_exists('gd_info')) {
41
    $form['color'] = array(
42
      '#type' => 'details',
43 44 45 46 47
      '#title' => t('Color scheme'),
      '#weight' => -1,
      '#attributes' => array('id' => 'color_scheme_form'),
      '#theme' => 'color_scheme_form',
    );
48
    $form['color'] += color_scheme_form($form, $form_state, $theme);
49
    $form['#validate'][] = 'color_scheme_form_validate';
50
    $form['#submit'][] = 'color_scheme_form_submit';
51
  }
52 53
}

54
/**
55 56 57 58 59 60 61
 * Replaces style sheets with color-altered style sheets.
 *
 * A theme that supports the color module should call this function from its
 * THEME_process_html() function, so that the correct style sheets are
 * included when html.tpl.php is rendered.
 *
 * @see theme()
62
 */
63
function _color_html_alter(&$vars) {
64
  global $theme_key;
65
  $themes = list_themes();
66 67

  // Override stylesheets.
68
  $color_paths = variable_get('color_' . $theme_key . '_stylesheets', array());
69 70
  if (!empty($color_paths)) {

71
    foreach ($themes[$theme_key]->stylesheets['all'] as $base_filename => $old_path) {
72 73 74 75 76
      // Loop over the path array with recolored CSS files to find matching
      // paths which could replace the non-recolored paths.
      foreach ($color_paths as $color_path) {
        // Color module currently requires unique file names to be used,
        // which allows us to compare different file paths.
77
        if (drupal_basename($old_path) == drupal_basename($color_path)) {
78 79
          // Replace the path to the new css file.
          // This keeps the order of the stylesheets intact.
80
          $vars['css'][drupal_basename($old_path)]['data'] = $color_path;
81 82 83
        }
      }
    }
84

85 86
    $vars['styles'] = drupal_get_css($vars['css']);
  }
87 88 89
}

/**
90 91 92 93 94 95 96
 * Replaces the logo with a color-altered logo.
 *
 * A theme that supports the color module should call this function from its
 * THEME_process_page() function, so that the correct logo is included when
 * page.tpl.php is rendered.
 *
 * @see theme()
97 98
 */
function _color_page_alter(&$vars) {
99
  global $theme_key;
100

101
  // Override logo.
102
  $logo = variable_get('color_' . $theme_key . '_logo');
103
  if ($logo && $vars['logo'] && preg_match('!' . $theme_key . '/logo.png$!', $vars['logo'])) {
104
    $vars['logo'] = file_create_url($logo);
105 106 107 108
  }
}

/**
109
 * Retrieves the Color module information for a particular theme.
110 111
 */
function color_get_info($theme) {
112 113 114 115 116 117
  static $theme_info = array();

  if (isset($theme_info[$theme])) {
    return $theme_info[$theme];
  }

118
  $path = drupal_get_path('theme', $theme);
119
  $file = DRUPAL_ROOT . '/' . $path . '/color/color.inc';
120 121
  if ($path && file_exists($file)) {
    include $file;
122
    $theme_info[$theme] = $info;
123 124 125 126 127
    return $info;
  }
}

/**
128
 * Retrieves the color palette for a particular theme.
129
 */
130
function color_get_palette($theme, $default = FALSE) {
131
  // Fetch and expand default palette.
132
  $info = color_get_info($theme);
133
  $palette = $info['schemes']['default']['colors'];
134

135
  // Load variable.
136
  return $default ? $palette : variable_get('color_' . $theme . '_palette', $palette);
137 138 139
}

/**
140 141 142 143 144 145 146 147
 * Form constructor for the color configuration form for a particular theme.
 *
 * @param $theme
 *   The machine name of the theme whose color settings are being configured.
 *
 * @see color_scheme_form_validate()
 * @see color_scheme_form_submit()
 * @ingroup forms
148
 */
149
function color_scheme_form($complete_form, &$form_state, $theme) {
150 151 152
  $base = drupal_get_path('module', 'color');
  $info = color_get_info($theme);

153 154 155 156 157 158 159 160 161
  $info['schemes'][''] = array('title' => t('Custom'), 'colors' => array());
  $color_sets = array();
  $schemes = array();
  foreach ($info['schemes'] as $key => $scheme) {
    $color_sets[$key] = $scheme['title'];
    $schemes[$key] = $scheme['colors'];
    $schemes[$key] += $info['schemes']['default']['colors'];
  }

162
  // See if we're using a predefined scheme.
163
  // Note: we use the original theme when the default scheme is chosen.
164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
  $current_scheme = variable_get('color_' . $theme . '_palette', array());
  foreach ($schemes as $key => $scheme) {
    if ($current_scheme == $scheme) {
      $scheme_name = $key;
      break;
    }
  }
  if (empty($scheme_name)) {
    if (empty($current_scheme)) {
      $scheme_name = 'default';
    }
    else {
      $scheme_name = '';
    }
  }
179

180
  // Add scheme selector.
181 182 183
  $form['scheme'] = array(
    '#type' => 'select',
    '#title' => t('Color set'),
184 185
    '#options' => $color_sets,
    '#default_value' => $scheme_name,
186 187
    '#attached' => array(
      'library' => array(
188
        array('color', 'drupal.color'),
189 190 191
      ),
      // Add custom CSS.
      'css' => array(
192
        $base . '/color.admin.css' => array(),
193 194 195 196 197
      ),
      // Add custom JavaScript.
      'js' => array(
        array(
          'data' => array(
198 199 200 201 202
            'color' => array(
              'reference' => color_get_palette($theme, TRUE),
              'schemes' => $schemes,
            ),
            'gradients' => $info['gradients'],
203 204 205
          ),
          'type' => 'setting',
        ),
206 207
      ),
    ),
208 209
  );

210
  // Add palette fields.
211
  $palette = color_get_palette($theme);
212
  $names = $info['fields'];
213
  $form['palette']['#tree'] = TRUE;
214
  foreach ($palette as $name => $value) {
215 216 217
    if (isset($names[$name])) {
      $form['palette'][$name] = array(
        '#type' => 'textfield',
218
        '#title' => check_plain($names[$name]),
219 220 221 222
        '#default_value' => $value,
        '#size' => 8,
      );
    }
223
  }
224
  $form['theme'] = array('#type' => 'value', '#value' => $theme);
225 226 227 228 229 230
  $form['info'] = array('#type' => 'value', '#value' => $info);

  return $form;
}

/**
231 232 233 234 235
 * Returns HTML for a theme's color form.
 *
 * @param $variables
 *   An associative array containing:
 *   - form: A render element representing the form.
236
 *
237
 * @ingroup themeable
238
 */
239 240 241
function theme_color_scheme_form($variables) {
  $form = $variables['form'];

242 243
  $theme = $form['theme']['#value'];
  $info = $form['info']['#value'];
244
  $path = drupal_get_path('theme', $theme) . '/';
245
  drupal_add_css($path . $info['preview_css']);
246

247
  // @todo Transform to add library.
248 249
  $preview_js_path = isset($info['preview_js']) ? $path . $info['preview_js'] : drupal_get_path('module', 'color') . '/' . 'preview.js';
  // Add the JS at a weight below color.js.
250
  drupal_add_js($preview_js_path, array('weight' => -1));
251

252
  $output  = '';
253
  $output .= '<div class="color-form clearfix">';
254
  // Color schemes
255 256
  $output .= drupal_render($form['scheme']);
  // Palette
257
  $output .= '<div id="palette" class="clearfix">';
258 259 260 261 262
  foreach (element_children($form['palette']) as $name) {
    $output .= drupal_render($form['palette'][$name]);
  }
  $output .= '</div>';
  // Preview
263
  $output .= drupal_render_children($form);
264
  $output .= '<h2>' . t('Preview') . '</h2>';
265 266 267
  // Attempt to load preview HTML if the theme provides it.
  $preview_html_path = DRUPAL_ROOT . '/' . (isset($info['preview_html']) ? drupal_get_path('theme', $theme) . '/' . $info['preview_html'] : drupal_get_path('module', 'color') . '/preview.html');
  $output .= file_get_contents($preview_html_path);
268
  // Close the wrapper div.
269
  $output .= '</div>';
270 271 272 273

  return $output;
}

274
/**
275 276 277
 * Form validation handler for color_scheme_form().
 *
 * @see color_scheme_form_submit()
278 279 280 281 282 283 284 285 286 287
 */
function color_scheme_form_validate($form, &$form_state) {
  // Only accept hexadecimal CSS color strings to avoid XSS upon use.
  foreach ($form_state['values']['palette'] as $key => $color) {
    if (!preg_match('/^#([a-f0-9]{3}){1,2}$/iD', $color)) {
      form_set_error('palette][' . $key, t('You must enter a valid hexadecimal color value for %name.', array('%name' => $form['color']['palette'][$key]['#title'])));
    }
  }
}

288
/**
289 290 291
 * Form submission handler for color_scheme_form().
 *
 * @see color_scheme_form_validate()
292
 */
293
function color_scheme_form_submit($form, &$form_state) {
294
  // Get theme coloring info.
295
  if (!isset($form_state['values']['info'])) {
296 297
    return;
  }
298 299
  $theme = $form_state['values']['theme'];
  $info = $form_state['values']['info'];
300

301
  // Resolve palette.
302 303
  $palette = $form_state['values']['palette'];
  if ($form_state['values']['scheme'] != '') {
304 305 306 307
    foreach ($palette as $key => $color) {
      if (isset($info['schemes'][$form_state['values']['scheme']]['colors'][$key])) {
        $palette[$key] = $info['schemes'][$form_state['values']['scheme']]['colors'][$key];
      }
308
    }
309
    $palette += $info['schemes']['default']['colors'];
310 311
  }

312 313 314
  // Make sure enough memory is available, if PHP's memory limit is compiled in.
  if (function_exists('memory_get_usage')) {
    // Fetch source image dimensions.
315
    $source = drupal_get_path('theme', $theme) . '/' . $info['base_image'];
316 317 318 319 320
    list($width, $height) = getimagesize($source);

    // We need at least a copy of the source and a target buffer of the same
    // size (both at 32bpp).
    $required = $width * $height * 8;
321
    // We intend to prevent color scheme changes if there isn't enough memory
322 323 324 325
    // available.  memory_get_usage(TRUE) returns a more accurate number than
    // memory_get_usage(), therefore we won't inadvertently reject a color
    // scheme change based on a faulty memory calculation.
    $usage = memory_get_usage(TRUE);
326 327 328 329
    $memory_limit = ini_get('memory_limit');
    $size = parse_size($memory_limit);
    if (!drupal_check_memory_limit($usage + $required, $memory_limit)) {
      drupal_set_message(t('There is not enough memory available to PHP to change this theme\'s color scheme. You need at least %size more. Check the <a href="@url">PHP documentation</a> for more information.', array('%size' => format_size($usage + $required - $size), '@url' => 'http://www.php.net/manual/ini.core.php#ini.sect.resource-limits')), 'error');
330 331 332 333
      return;
    }
  }

334
  // Delete old files.
335
  foreach (variable_get('color_' . $theme . '_files', array()) as $file) {
336
    @drupal_unlink($file);
337
  }
338
  if (isset($file) && $file = dirname($file)) {
339
    @drupal_rmdir($file);
340 341 342
  }

  // Don't render the default colorscheme, use the standard theme instead.
343
  if (implode(',', color_get_palette($theme, TRUE)) == implode(',', $palette)) {
344 345 346 347 348
    variable_del('color_' . $theme . '_palette');
    variable_del('color_' . $theme . '_stylesheets');
    variable_del('color_' . $theme . '_logo');
    variable_del('color_' . $theme . '_files');
    variable_del('color_' . $theme . '_screenshot');
349 350 351
    return;
  }

352
  // Prepare target locations for generated files.
353
  $id = $theme . '-' . substr(hash('sha256', serialize($palette) . microtime()), 0, 8);
354
  $paths['color'] = 'public://color';
355
  $paths['target'] = $paths['color'] . '/' . $id;
356
  foreach ($paths as $path) {
357
    file_prepare_directory($path, FILE_CREATE_DIRECTORY);
358
  }
359
  $paths['target'] = $paths['target'] . '/';
360
  $paths['id'] = $id;
361
  $paths['source'] = drupal_get_path('theme', $theme) . '/';
362 363
  $paths['files'] = $paths['map'] = array();

364
  // Save palette and logo location.
365 366
  variable_set('color_' . $theme . '_palette', $palette);
  variable_set('color_' . $theme . '_logo', $paths['target'] . 'logo.png');
367

368
  // Copy over neutral images.
369
  foreach ($info['copy'] as $file) {
370
    $base = drupal_basename($file);
371
    $source = $paths['source'] . $file;
372
    $filepath = file_unmanaged_copy($source, $paths['target'] . $base);
373
    $paths['map'][$file] = $base;
374
    $paths['files'][] = $filepath;
375 376
  }

377
  // Render new images, if image has been provided.
378 379 380
  if ($info['base_image']) {
    _color_render_images($theme, $info, $paths, $palette);
  }
381

382 383 384 385 386 387 388 389 390 391 392 393 394 395 396
  // Rewrite theme stylesheets.
  $css = array();
  foreach ($info['css'] as $stylesheet) {
    // Build a temporary array with LTR and RTL files.
    $files = array();
    if (file_exists($paths['source'] . $stylesheet)) {
      $files[] = $stylesheet;

      $rtl_file = str_replace('.css', '-rtl.css', $stylesheet);
      if (file_exists($paths['source'] . $rtl_file)) {
        $files[] = $rtl_file;
      }
    }

    foreach ($files as $file) {
397 398
      // Aggregate @imports recursively for each configured top level CSS file
      // without optimization. Aggregation and optimization will be
399 400 401 402 403
      // handled by drupal_build_css_cache() only.
      $style = drupal_load_stylesheet($paths['source'] . $file, FALSE);

      // Return the path to where this CSS file originated from, stripping
      // off the name of the file at the end of the path.
404
      $base = base_path() . dirname($paths['source'] . $file) . '/';
405 406 407 408 409 410 411
      _drupal_build_css_path(NULL, $base);

      // Prefix all paths within this CSS file, ignoring absolute paths.
      $style = preg_replace_callback('/url\([\'"]?(?![a-z]+:|\/+)([^\'")]+)[\'"]?\)/i', '_drupal_build_css_path', $style);

      // Rewrite stylesheet with new colors.
      $style = _color_rewrite_stylesheet($theme, $info, $paths, $palette, $style);
412
      $base_file = drupal_basename($file);
413 414
      $css[] = $paths['target'] . $base_file;
      _color_save_stylesheet($paths['target'] . $base_file, $style, $paths);
415
    }
416
  }
417

418
  // Maintain list of files.
419 420
  variable_set('color_' . $theme . '_stylesheets', $css);
  variable_set('color_' . $theme . '_files', $paths['files']);
421 422 423
}

/**
424
 * Rewrites the stylesheet to match the colors in the palette.
425
 */
426
function _color_rewrite_stylesheet($theme, &$info, &$paths, $palette, $style) {
427
  $themes = list_themes();
428
  // Prepare color conversion table.
429 430 431 432
  $conversion = $palette;
  foreach ($conversion as $k => $v) {
    $conversion[$k] = drupal_strtolower($v);
  }
433
  $default = color_get_palette($theme, TRUE);
434 435

  // Split off the "Don't touch" section of the stylesheet.
436
  $split = "Color Module: Don't touch";
437
  if (strpos($style, $split) !== FALSE) {
438 439
    list($style, $fixed) = explode($split, $style);
  }
440 441 442

  // Find all colors in the stylesheet and the chunks in between.
  $style = preg_split('/(#[0-9a-f]{6}|#[0-9a-f]{3})/i', $style, -1, PREG_SPLIT_DELIM_CAPTURE);
443
  $is_color = FALSE;
444 445 446
  $output = '';
  $base = 'base';

447
  // Iterate over all the parts.
448 449 450
  foreach ($style as $chunk) {
    if ($is_color) {
      $chunk = drupal_strtolower($chunk);
451
      // Check if this is one of the colors in the default palette.
452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467
      if ($key = array_search($chunk, $default)) {
        $chunk = $conversion[$key];
      }
      // Not a pre-set color. Extrapolate from the base.
      else {
        $chunk = _color_shift($palette[$base], $default[$base], $chunk, $info['blend_target']);
      }
    }
    else {
      // Determine the most suitable base color for the next color.

      // 'a' declarations. Use link.
      if (preg_match('@[^a-z0-9_-](a)[^a-z0-9_-][^/{]*{[^{]+$@i', $chunk)) {
        $base = 'link';
      }
      // 'color:' styles. Use text.
468
      elseif (preg_match('/(?<!-)color[^{:]*:[^{#]*$/i', $chunk)) {
469 470 471 472 473 474 475 476 477 478
        $base = 'text';
      }
      // Reset back to base.
      else {
        $base = 'base';
      }
    }
    $output .= $chunk;
    $is_color = !$is_color;
  }
479 480 481 482
  // Append fixed colors segment.
  if (isset($fixed)) {
    $output .= $fixed;
  }
483

484
  // Replace paths to images.
485
  foreach ($paths['map'] as $before => $after) {
486 487
    $before = base_path() . $paths['source'] . $before;
    $before = preg_replace('`(^|/)(?!../)([^/]+)/../`', '$1', $before);
488 489 490
    $output = str_replace($before, $after, $output);
  }

491
  return $output;
492 493 494
}

/**
495
 * Saves the rewritten stylesheet to disk.
496
 */
497
function _color_save_stylesheet($file, $style, &$paths) {
498
  $filepath = file_unmanaged_save_data($style, $file, FILE_EXISTS_REPLACE);
499
  $paths['files'][] = $filepath;
500 501

  // Set standard file permissions for webserver-generated files.
502
  drupal_chmod($file);
503 504 505
}

/**
506
 * Renders images that match a given palette.
507 508
 */
function _color_render_images($theme, &$info, &$paths, $palette) {
Steven Wittens's avatar
Steven Wittens committed
509
  // Prepare template image.
510
  $source = $paths['source'] . '/' . $info['base_image'];
511 512 513
  $source = imagecreatefrompng($source);
  $width = imagesx($source);
  $height = imagesy($source);
Steven Wittens's avatar
Steven Wittens committed
514 515

  // Prepare target buffer.
516
  $target = imagecreatetruecolor($width, $height);
517
  imagealphablending($target, TRUE);
518 519 520 521 522 523

  // Fill regions of solid color.
  foreach ($info['fill'] as $color => $fill) {
    imagefilledrectangle($target, $fill[0], $fill[1], $fill[0] + $fill[2], $fill[1] + $fill[3], _color_gd($target, $palette[$color]));
  }

524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540
  // Render gradients.
  foreach ($info['gradients'] as $gradient) {
    // Get direction of the gradient.
    if (isset($gradient['direction']) && $gradient['direction'] == 'horizontal') {
      // Horizontal gradient.
      for ($x = 0; $x < $gradient['dimension'][2]; $x++) {
        $color = _color_blend($target, $palette[$gradient['colors'][0]], $palette[$gradient['colors'][1]], $x / ($gradient['dimension'][2] - 1));
        imagefilledrectangle($target, ($gradient['dimension'][0] + $x), $gradient['dimension'][1], ($gradient['dimension'][0] + $x + 1), ($gradient['dimension'][1] + $gradient['dimension'][3]), $color);
      }
    }
    else {
      // Vertical gradient.
      for ($y = 0; $y < $gradient['dimension'][3]; $y++) {
        $color = _color_blend($target, $palette[$gradient['colors'][0]], $palette[$gradient['colors'][1]], $y / ($gradient['dimension'][3] - 1));
        imagefilledrectangle($target, $gradient['dimension'][0], $gradient['dimension'][1] + $y, $gradient['dimension'][0] + $gradient['dimension'][2], $gradient['dimension'][1] + $y + 1, $color);
      }
    }
541 542
  }

Steven Wittens's avatar
Steven Wittens committed
543
  // Blend over template.
544 545
  imagecopy($target, $source, 0, 0, 0, 0, $width, $height);

Steven Wittens's avatar
Steven Wittens committed
546
  // Clean up template image.
547 548
  imagedestroy($source);

Steven Wittens's avatar
Steven Wittens committed
549
  // Cut out slices.
550 551
  foreach ($info['slices'] as $file => $coord) {
    list($x, $y, $width, $height) = $coord;
552
    $base = drupal_basename($file);
553
    $image = drupal_realpath($paths['target'] . $base);
554

Steven Wittens's avatar
Steven Wittens committed
555
    // Cut out slice.
556 557 558
    if ($file == 'screenshot.png') {
      $slice = imagecreatetruecolor(150, 90);
      imagecopyresampled($slice, $target, 0, 0, $x, $y, 150, 90, $width, $height);
559
      variable_set('color_' . $theme . '_screenshot', $image);
560 561 562 563 564 565
    }
    else {
      $slice = imagecreatetruecolor($width, $height);
      imagecopy($slice, $target, 0, 0, $x, $y, $width, $height);
    }

Steven Wittens's avatar
Steven Wittens committed
566
    // Save image.
567 568 569 570
    imagepng($slice, $image);
    imagedestroy($slice);
    $paths['files'][] = $image;

571
    // Set standard file permissions for webserver-generated files
572
    drupal_chmod($image);
573

574 575 576 577
    // Build before/after map of image paths.
    $paths['map'][$file] = $base;
  }

Steven Wittens's avatar
Steven Wittens committed
578
  // Clean up target buffer.
579 580 581 582
  imagedestroy($target);
}

/**
583
 * Shifts a given color, using a reference pair and a target blend color.
584 585 586 587
 *
 * Note: this function is significantly different from the JS version, as it
 * is written to match the blended images perfectly.
 *
588 589
 * Constraint: if (ref2 == target + (ref1 - target) * delta) for some fraction
 * delta then (return == target + (given - target) * delta).
590 591
 *
 * Loose constraint: Preserve relative positions in saturation and luminance
592
 * space.
593 594 595
 */
function _color_shift($given, $ref1, $ref2, $target) {
  // We assume that ref2 is a blend of ref1 and target and find
596
  // delta based on the length of the difference vectors.
597 598

  // delta = 1 - |ref2 - ref1| / |white - ref1|
599 600 601
  $target = _color_unpack($target, TRUE);
  $ref1 = _color_unpack($ref1, TRUE);
  $ref2 = _color_unpack($ref2, TRUE);
602 603
  $numerator = 0;
  $denominator = 0;
604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623
  for ($i = 0; $i < 3; ++$i) {
    $numerator += ($ref2[$i] - $ref1[$i]) * ($ref2[$i] - $ref1[$i]);
    $denominator += ($target[$i] - $ref1[$i]) * ($target[$i] - $ref1[$i]);
  }
  $delta = ($denominator > 0) ? (1 - sqrt($numerator / $denominator)) : 0;

  // Calculate the color that ref2 would be if the assumption was true.
  for ($i = 0; $i < 3; ++$i) {
    $ref3[$i] = $target[$i] + ($ref1[$i] - $target[$i]) * $delta;
  }

  // If the assumption is not true, there is a difference between ref2 and ref3.
  // We measure this in HSL space. Notation: x' = hsl(x).
  $ref2 = _color_rgb2hsl($ref2);
  $ref3 = _color_rgb2hsl($ref3);
  for ($i = 0; $i < 3; ++$i) {
    $shift[$i] = $ref2[$i] - $ref3[$i];
  }

  // Take the given color, and blend it towards the target.
624
  $given = _color_unpack($given, TRUE);
625 626 627 628 629 630 631 632 633 634 635 636 637
  for ($i = 0; $i < 3; ++$i) {
    $result[$i] = $target[$i] + ($given[$i] - $target[$i]) * $delta;
  }

  // Finally, we apply the extra shift in HSL space.
  // Note: if ref2 is a pure blend of ref1 and target, then |shift| = 0.
  $result = _color_rgb2hsl($result);
  for ($i = 0; $i < 3; ++$i) {
    $result[$i] = min(1, max(0, $result[$i] + $shift[$i]));
  }
  $result = _color_hsl2rgb($result);

  // Return hex color.
638
  return _color_pack($result, TRUE);
639 640 641
}

/**
642
 * Converts a hex triplet into a GD color.
643 644 645 646 647 648 649
 */
function _color_gd($img, $hex) {
  $c = array_merge(array($img), _color_unpack($hex));
  return call_user_func_array('imagecolorallocate', $c);
}

/**
650
 * Blends two hex colors and returns the GD color.
651 652 653 654 655 656 657 658
 */
function _color_blend($img, $hex1, $hex2, $alpha) {
  $in1 = _color_unpack($hex1);
  $in2 = _color_unpack($hex2);
  $out = array($img);
  for ($i = 0; $i < 3; ++$i) {
    $out[] = $in1[$i] + ($in2[$i] - $in1[$i]) * $alpha;
  }
659

660 661 662 663
  return call_user_func_array('imagecolorallocate', $out);
}

/**
664
 * Converts a hex color into an RGB triplet.
665
 */
666
function _color_unpack($hex, $normalize = FALSE) {
667 668 669 670 671 672 673
  if (strlen($hex) == 4) {
    $hex = $hex[1] . $hex[1] . $hex[2] . $hex[2] . $hex[3] . $hex[3];
  }
  $c = hexdec($hex);
  for ($i = 16; $i >= 0; $i -= 8) {
    $out[] = (($c >> $i) & 0xFF) / ($normalize ? 255 : 1);
  }
674

675 676 677 678
  return $out;
}

/**
679
 * Converts an RGB triplet to a hex color.
680
 */
681
function _color_pack($rgb, $normalize = FALSE) {
682
  $out = 0;
683 684 685
  foreach ($rgb as $k => $v) {
    $out |= (($v * ($normalize ? 255 : 1)) << (16 - $k * 8));
  }
686

687
  return '#' . str_pad(dechex($out), 6, 0, STR_PAD_LEFT);
688 689 690
}

/**
691
 * Converts an HSL triplet into RGB.
692 693 694 695 696 697 698
 */
function _color_hsl2rgb($hsl) {
  $h = $hsl[0];
  $s = $hsl[1];
  $l = $hsl[2];
  $m2 = ($l <= 0.5) ? $l * ($s + 1) : $l + $s - $l*$s;
  $m1 = $l * 2 - $m2;
699

700 701 702 703 704
  return array(
    _color_hue2rgb($m1, $m2, $h + 0.33333),
    _color_hue2rgb($m1, $m2, $h),
    _color_hue2rgb($m1, $m2, $h - 0.33333),
  );
705 706 707 708 709 710 711 712 713 714
}

/**
 * Helper function for _color_hsl2rgb().
 */
function _color_hue2rgb($m1, $m2, $h) {
  $h = ($h < 0) ? $h + 1 : (($h > 1) ? $h - 1 : $h);
  if ($h * 6 < 1) return $m1 + ($m2 - $m1) * $h * 6;
  if ($h * 2 < 1) return $m2;
  if ($h * 3 < 2) return $m1 + ($m2 - $m1) * (0.66666 - $h) * 6;
715

716 717 718 719
  return $m1;
}

/**
720
 * Converts an RGB triplet to HSL.
721 722 723 724 725 726 727 728 729 730
 */
function _color_rgb2hsl($rgb) {
  $r = $rgb[0];
  $g = $rgb[1];
  $b = $rgb[2];
  $min = min($r, min($g, $b));
  $max = max($r, max($g, $b));
  $delta = $max - $min;
  $l = ($min + $max) / 2;
  $s = 0;
731

732
  if ($l > 0 && $l < 1) {
Steven Wittens's avatar
Steven Wittens committed
733
    $s = $delta / ($l < 0.5 ? (2 * $l) : (2 - 2 * $l));
734
  }
735

736 737
  $h = 0;
  if ($delta > 0) {
Steven Wittens's avatar
Steven Wittens committed
738 739 740 741
    if ($max == $r && $max != $g) $h += ($g - $b) / $delta;
    if ($max == $g && $max != $b) $h += (2 + ($b - $r) / $delta);
    if ($max == $b && $max != $r) $h += (4 + ($r - $g) / $delta);
    $h /= 6;
742
  }
743

744
  return array($h, $s, $l);
745
}
746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773

/**
 * Implements hook_library_info().
 */
function color_library_info() {
  $libraries['drupal.color'] = array(
    'title' => 'Color',
    'version' => VERSION,
    'js' => array(
      drupal_get_path('module', 'color') . '/color.js' => array(),
    ),
    'dependencies' => array(
      array('system', 'jquery'),
      array('system', 'drupal'),
      array('system', 'jquery.once'),
      array('system', 'jquery.farbtastic'),
      array('color', 'drupal.color.preview'),
    ),
  );
  $libraries['drupal.color.preview'] = array(
    'title' => 'Color preview',
    'version' => VERSION,
    'js' => array(
      drupal_get_path('module', 'color') . '/preview.js' => array(),
    ),
    'dependencies' => array(
      array('system', 'jquery'),
      array('system', 'drupal'),
774
      array('system', 'drupalSettings'),
775 776 777 778 779 780
      array('system', 'jquery.once'),
    ),
  );

  return $libraries;
}