color.module 25.3 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 = config('color.' . $theme_key)->get('stylesheets');
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 = config('color.' . $theme_key)->get('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 136 137 138
  if ($default) {
    return $palette;
  }

139
  // Load variable.
140 141
  // @todo Default color config should be moved to yaml in the theme.
  return config('color.' . $theme)->get('palette') ?: $palette;
142 143 144
}

/**
145 146 147 148 149 150 151 152
 * 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
153
 */
154
function color_scheme_form($complete_form, &$form_state, $theme) {
155 156 157
  $base = drupal_get_path('module', 'color');
  $info = color_get_info($theme);

158 159 160 161 162 163 164 165 166
  $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'];
  }

167
  // See if we're using a predefined scheme.
168
  // Note: we use the original theme when the default scheme is chosen.
169
  $current_scheme = config('color.' . $theme)->get('palette');
170 171 172 173 174 175 176 177 178 179 180 181 182 183
  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 = '';
    }
  }
184

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

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

  return $form;
}

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

247 248
  $theme = $form['theme']['#value'];
  $info = $form['info']['#value'];
249
  $path = drupal_get_path('theme', $theme) . '/';
250
  drupal_add_css($path . $info['preview_css']);
251

252
  // @todo Transform to add library.
253 254
  $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.
255
  drupal_add_js($preview_js_path, array('weight' => -1));
256

257
  $output  = '';
258
  $output .= '<div class="color-form clearfix">';
259
  // Color schemes
260 261
  $output .= drupal_render($form['scheme']);
  // Palette
262
  $output .= '<div id="palette" class="clearfix">';
263 264 265 266 267
  foreach (element_children($form['palette']) as $name) {
    $output .= drupal_render($form['palette'][$name]);
  }
  $output .= '</div>';
  // Preview
268
  $output .= drupal_render_children($form);
269
  $output .= '<h2>' . t('Preview') . '</h2>';
270 271 272
  // 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);
273
  // Close the wrapper div.
274
  $output .= '</div>';
275 276 277 278

  return $output;
}

279
/**
280 281 282
 * Form validation handler for color_scheme_form().
 *
 * @see color_scheme_form_submit()
283 284 285 286 287 288 289 290 291 292
 */
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'])));
    }
  }
}

293
/**
294 295 296
 * Form submission handler for color_scheme_form().
 *
 * @see color_scheme_form_validate()
297
 */
298
function color_scheme_form_submit($form, &$form_state) {
299

300
  // Get theme coloring info.
301
  if (!isset($form_state['values']['info'])) {
302 303
    return;
  }
304 305
  $theme = $form_state['values']['theme'];
  $info = $form_state['values']['info'];
306

307 308
  $config = config('color.' . $theme);

309
  // Resolve palette.
310 311
  $palette = $form_state['values']['palette'];
  if ($form_state['values']['scheme'] != '') {
312 313 314 315
    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];
      }
316
    }
317
    $palette += $info['schemes']['default']['colors'];
318 319
  }

320 321 322
  // Make sure enough memory is available, if PHP's memory limit is compiled in.
  if (function_exists('memory_get_usage')) {
    // Fetch source image dimensions.
323
    $source = drupal_get_path('theme', $theme) . '/' . $info['base_image'];
324 325 326 327 328
    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;
329
    // We intend to prevent color scheme changes if there isn't enough memory
330 331 332 333
    // 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);
334 335 336 337
    $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');
338 339 340 341
      return;
    }
  }

342
  // Delete old files.
343 344 345 346 347
  $files = $config->get('files');
  if (isset($files)) {
    foreach ($files as $file) {
      @drupal_unlink($file);
    }
348
  }
349
  if (isset($file) && $file = dirname($file)) {
350
    @drupal_rmdir($file);
351 352
  }

353
  // No change in color config, use the standard theme from color.inc.
354
  if (implode(',', color_get_palette($theme, TRUE)) == implode(',', $palette)) {
355
    $config->delete();
356 357 358
    return;
  }

359
  // Prepare target locations for generated files.
360
  $id = $theme . '-' . substr(hash('sha256', serialize($palette) . microtime()), 0, 8);
361
  $paths['color'] = 'public://color';
362
  $paths['target'] = $paths['color'] . '/' . $id;
363
  foreach ($paths as $path) {
364
    file_prepare_directory($path, FILE_CREATE_DIRECTORY);
365
  }
366
  $paths['target'] = $paths['target'] . '/';
367
  $paths['id'] = $id;
368
  $paths['source'] = drupal_get_path('theme', $theme) . '/';
369 370
  $paths['files'] = $paths['map'] = array();

371
  // Save palette and logo location.
372 373 374 375
  $config
    ->set('palette', $palette)
    ->set('logo', $paths['target'] . 'logo.png')
    ->save();
376

377
  // Copy over neutral images.
378
  foreach ($info['copy'] as $file) {
379
    $base = drupal_basename($file);
380
    $source = $paths['source'] . $file;
381
    $filepath = file_unmanaged_copy($source, $paths['target'] . $base);
382
    $paths['map'][$file] = $base;
383
    $paths['files'][] = $filepath;
384 385
  }

386
  // Render new images, if image has been provided.
387 388 389
  if ($info['base_image']) {
    _color_render_images($theme, $info, $paths, $palette);
  }
390

391 392 393 394 395 396 397 398 399 400 401 402 403 404 405
  // 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) {
406 407
      // Aggregate @imports recursively for each configured top level CSS file
      // without optimization. Aggregation and optimization will be
408 409 410 411 412
      // 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.
413
      $base = base_path() . dirname($paths['source'] . $file) . '/';
414 415 416 417 418 419 420
      _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);
421
      $base_file = drupal_basename($file);
422 423
      $css[] = $paths['target'] . $base_file;
      _color_save_stylesheet($paths['target'] . $base_file, $style, $paths);
424
    }
425
  }
426

427
  // Maintain list of files.
428 429 430 431
  $config
    ->set('stylesheets', $css)
    ->set('files', $paths['files'])
    ->save();
432 433 434
}

/**
435
 * Rewrites the stylesheet to match the colors in the palette.
436
 */
437
function _color_rewrite_stylesheet($theme, &$info, &$paths, $palette, $style) {
438
  $themes = list_themes();
439
  // Prepare color conversion table.
440 441 442 443
  $conversion = $palette;
  foreach ($conversion as $k => $v) {
    $conversion[$k] = drupal_strtolower($v);
  }
444
  $default = color_get_palette($theme, TRUE);
445 446

  // Split off the "Don't touch" section of the stylesheet.
447
  $split = "Color Module: Don't touch";
448
  if (strpos($style, $split) !== FALSE) {
449 450
    list($style, $fixed) = explode($split, $style);
  }
451 452 453

  // 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);
454
  $is_color = FALSE;
455 456 457
  $output = '';
  $base = 'base';

458
  // Iterate over all the parts.
459 460 461
  foreach ($style as $chunk) {
    if ($is_color) {
      $chunk = drupal_strtolower($chunk);
462
      // Check if this is one of the colors in the default palette.
463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478
      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.
479
      elseif (preg_match('/(?<!-)color[^{:]*:[^{#]*$/i', $chunk)) {
480 481 482 483 484 485 486 487 488 489
        $base = 'text';
      }
      // Reset back to base.
      else {
        $base = 'base';
      }
    }
    $output .= $chunk;
    $is_color = !$is_color;
  }
490 491 492 493
  // Append fixed colors segment.
  if (isset($fixed)) {
    $output .= $fixed;
  }
494

495
  // Replace paths to images.
496
  foreach ($paths['map'] as $before => $after) {
497 498
    $before = base_path() . $paths['source'] . $before;
    $before = preg_replace('`(^|/)(?!../)([^/]+)/../`', '$1', $before);
499 500 501
    $output = str_replace($before, $after, $output);
  }

502
  return $output;
503 504 505
}

/**
506
 * Saves the rewritten stylesheet to disk.
507
 */
508
function _color_save_stylesheet($file, $style, &$paths) {
509
  $filepath = file_unmanaged_save_data($style, $file, FILE_EXISTS_REPLACE);
510
  $paths['files'][] = $filepath;
511 512

  // Set standard file permissions for webserver-generated files.
513
  drupal_chmod($file);
514 515 516
}

/**
517
 * Renders images that match a given palette.
518 519
 */
function _color_render_images($theme, &$info, &$paths, $palette) {
Steven Wittens's avatar
Steven Wittens committed
520
  // Prepare template image.
521
  $source = $paths['source'] . '/' . $info['base_image'];
522 523 524
  $source = imagecreatefrompng($source);
  $width = imagesx($source);
  $height = imagesy($source);
Steven Wittens's avatar
Steven Wittens committed
525 526

  // Prepare target buffer.
527
  $target = imagecreatetruecolor($width, $height);
528
  imagealphablending($target, TRUE);
529 530 531 532 533 534

  // 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]));
  }

535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551
  // 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);
      }
    }
552 553
  }

Steven Wittens's avatar
Steven Wittens committed
554
  // Blend over template.
555 556
  imagecopy($target, $source, 0, 0, 0, 0, $width, $height);

Steven Wittens's avatar
Steven Wittens committed
557
  // Clean up template image.
558 559
  imagedestroy($source);

Steven Wittens's avatar
Steven Wittens committed
560
  // Cut out slices.
561 562
  foreach ($info['slices'] as $file => $coord) {
    list($x, $y, $width, $height) = $coord;
563
    $base = drupal_basename($file);
564
    $image = drupal_realpath($paths['target'] . $base);
565

Steven Wittens's avatar
Steven Wittens committed
566
    // Cut out slice.
567 568 569
    if ($file == 'screenshot.png') {
      $slice = imagecreatetruecolor(150, 90);
      imagecopyresampled($slice, $target, 0, 0, $x, $y, 150, 90, $width, $height);
570 571 572
      config('color.' . $theme)
        ->set('screenshot', $image)
        ->save();
573 574 575 576 577 578
    }
    else {
      $slice = imagecreatetruecolor($width, $height);
      imagecopy($slice, $target, 0, 0, $x, $y, $width, $height);
    }

Steven Wittens's avatar
Steven Wittens committed
579
    // Save image.
580 581 582 583
    imagepng($slice, $image);
    imagedestroy($slice);
    $paths['files'][] = $image;

584
    // Set standard file permissions for webserver-generated files
585
    drupal_chmod($image);
586

587 588 589 590
    // Build before/after map of image paths.
    $paths['map'][$file] = $base;
  }

Steven Wittens's avatar
Steven Wittens committed
591
  // Clean up target buffer.
592 593 594 595
  imagedestroy($target);
}

/**
596
 * Shifts a given color, using a reference pair and a target blend color.
597 598 599 600
 *
 * Note: this function is significantly different from the JS version, as it
 * is written to match the blended images perfectly.
 *
601 602
 * Constraint: if (ref2 == target + (ref1 - target) * delta) for some fraction
 * delta then (return == target + (given - target) * delta).
603 604
 *
 * Loose constraint: Preserve relative positions in saturation and luminance
605
 * space.
606 607 608
 */
function _color_shift($given, $ref1, $ref2, $target) {
  // We assume that ref2 is a blend of ref1 and target and find
609
  // delta based on the length of the difference vectors.
610 611

  // delta = 1 - |ref2 - ref1| / |white - ref1|
612 613 614
  $target = _color_unpack($target, TRUE);
  $ref1 = _color_unpack($ref1, TRUE);
  $ref2 = _color_unpack($ref2, TRUE);
615 616
  $numerator = 0;
  $denominator = 0;
617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636
  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.
637
  $given = _color_unpack($given, TRUE);
638 639 640 641 642 643 644 645 646 647 648 649 650
  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.
651
  return _color_pack($result, TRUE);
652 653 654
}

/**
655
 * Converts a hex triplet into a GD color.
656 657 658 659 660 661 662
 */
function _color_gd($img, $hex) {
  $c = array_merge(array($img), _color_unpack($hex));
  return call_user_func_array('imagecolorallocate', $c);
}

/**
663
 * Blends two hex colors and returns the GD color.
664 665 666 667 668 669 670 671
 */
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;
  }
672

673 674 675 676
  return call_user_func_array('imagecolorallocate', $out);
}

/**
677
 * Converts a hex color into an RGB triplet.
678
 */
679
function _color_unpack($hex, $normalize = FALSE) {
680 681 682 683 684 685 686
  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);
  }
687

688 689 690 691
  return $out;
}

/**
692
 * Converts an RGB triplet to a hex color.
693
 */
694
function _color_pack($rgb, $normalize = FALSE) {
695
  $out = 0;
696 697 698
  foreach ($rgb as $k => $v) {
    $out |= (($v * ($normalize ? 255 : 1)) << (16 - $k * 8));
  }
699

700
  return '#' . str_pad(dechex($out), 6, 0, STR_PAD_LEFT);
701 702 703
}

/**
704
 * Converts an HSL triplet into RGB.
705 706 707 708 709 710 711
 */
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;
712

713 714 715 716 717
  return array(
    _color_hue2rgb($m1, $m2, $h + 0.33333),
    _color_hue2rgb($m1, $m2, $h),
    _color_hue2rgb($m1, $m2, $h - 0.33333),
  );
718 719 720 721 722 723 724 725 726 727
}

/**
 * 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;
728

729 730 731 732
  return $m1;
}

/**
733
 * Converts an RGB triplet to HSL.
734 735 736 737 738 739 740 741 742 743
 */
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;
744

745
  if ($l > 0 && $l < 1) {
Steven Wittens's avatar
Steven Wittens committed
746
    $s = $delta / ($l < 0.5 ? (2 * $l) : (2 - 2 * $l));
747
  }
748

749 750
  $h = 0;
  if ($delta > 0) {
Steven Wittens's avatar
Steven Wittens committed
751 752 753 754
    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;
755
  }
756

757
  return array($h, $s, $l);
758
}
759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786

/**
 * 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'),
787
      array('system', 'drupalSettings'),
788 789 790 791 792 793
      array('system', 'jquery.once'),
    ),
  );

  return $libraries;
}