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

7 8
use Drupal\Core\Asset\CssOptimizer;

9
/**
10
 * Implements hook_help().
11 12 13 14
 */
function color_help($path, $arg) {
  switch ($path) {
    case 'admin/help#color':
15
      $output = '<h3>' . t('About') . '</h3>';
16
      $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>';
17 18
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
19
      $output .= '<dt>' . t('Changing colors') . '</dt>';
20
      $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>';
21 22
      $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>';
23 24 25 26
      return $output;
  }
}

27
/**
28
 * Implements hook_theme().
29 30 31 32
 */
function color_theme() {
  return array(
    'color_scheme_form' => array(
33
      'render element' => 'form',
34
      'template' => 'color-scheme-form',
35 36 37
    ),
  );
}
38

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

57
/**
58
 * Implements hook_css_alter().
59
 *
60
 * Replaces style sheets with color-altered style sheets.
61
 */
62
function color_css_alter(&$css) {
63
  global $theme_key;
64
  $themes = list_themes();
65 66

  // Override stylesheets.
67
  $color_paths = \Drupal::config('color.' . $theme_key)->get('stylesheets');
68 69

  if (!empty($color_paths) && !empty($themes[$theme_key]->stylesheets['all'])) {
70

71
    foreach ($themes[$theme_key]->stylesheets['all'] as $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
          $css[drupal_basename($old_path)]['data'] = $color_path;
81 82 83
        }
      }
    }
84
  }
85 86 87
}

/**
88
 * Implements hook_preprocess_page().
89
 *
90
 * Replace the logo with the colored version if available.
91
 */
92
function color_preprocess_page(&$variables) {
93
  global $theme_key;
94

95
  // Override logo.
96
  $logo = \Drupal::config('color.' . $theme_key)->get('logo');
97 98
  if ($logo && $variables['logo'] && preg_match('!' . $theme_key . '/logo.png$!', $variables['logo'])) {
    $variables['logo'] = file_create_url($logo);
99 100 101 102
  }
}

/**
103
 * Retrieves the Color module information for a particular theme.
104 105
 */
function color_get_info($theme) {
106 107 108 109 110 111
  static $theme_info = array();

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

112
  $path = drupal_get_path('theme', $theme);
113
  $file = DRUPAL_ROOT . '/' . $path . '/color/color.inc';
114 115
  if ($path && file_exists($file)) {
    include $file;
116
    $theme_info[$theme] = $info;
117 118 119 120 121
    return $info;
  }
}

/**
122
 * Retrieves the color palette for a particular theme.
123
 */
124
function color_get_palette($theme, $default = FALSE) {
125
  // Fetch and expand default palette.
126
  $info = color_get_info($theme);
127
  $palette = $info['schemes']['default']['colors'];
128

129 130 131 132
  if ($default) {
    return $palette;
  }

133
  // Load variable.
134
  // @todo Default color config should be moved to yaml in the theme.
135
  return \Drupal::config('color.' . $theme)->get('palette') ?: $palette;
136 137 138
}

/**
139 140 141 142 143 144 145 146
 * 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
147
 */
148
function color_scheme_form($complete_form, &$form_state, $theme) {
149 150 151
  $base = drupal_get_path('module', 'color');
  $info = color_get_info($theme);

152 153 154 155 156 157 158 159 160
  $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'];
  }

161
  // See if we're using a predefined scheme.
162
  // Note: we use the original theme when the default scheme is chosen.
163
  $current_scheme = \Drupal::config('color.' . $theme)->get('palette');
164 165 166 167 168 169 170 171 172 173 174 175 176 177
  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 = '';
    }
  }
178

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

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

  return $form;
}

/**
232
 * Prepares variables for color scheme form templates.
233
 *
234 235 236
 * Default template: color-scheme-form.html.twig.
 *
 * @param array $variables
237 238
 *   An associative array containing:
 *   - form: A render element representing the form.
239
 */
240
function template_preprocess_color_scheme_form(&$variables) {
241
  $form = &$variables['form'];
242

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

247
  $preview_css_path = $path . $info['preview_css'];
248
  $preview_js_path = isset($info['preview_js']) ? $path . $info['preview_js'] : drupal_get_path('module', 'color') . '/' . 'preview.js';
249
  $form['scheme']['#attached']['css'][$preview_css_path] = array();
250
  // Add the JS at a weight below color.js.
251
  $form['scheme']['#attached']['js'][$preview_js_path] = array('weight' => -1);
252

253 254
  // 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');
255
  $variables['html_preview'] = file_get_contents($preview_html_path);
256 257
}

258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303
/**
 * Determines the value for a palette color field.
 *
 * @param array $element
 *   The form element whose value is being populated.
 * @param string|bool $input
 *   The incoming input to populate the form element. If this is FALSE,
 *   the element's default value should be returned.
 * @param array $form_state
 *   A keyed array containing the current state of the form.
 *
 * @return string
 *   The data that will appear in the $form_state['values'] collection for this
 *   element. Return nothing to use the default.
 */
function color_palette_color_value($element, $input = FALSE, $form_state = array()) {
  // If we suspect a possible cross-site request forgery attack, only accept
  // hexadecimal CSS color strings from user input, to avoid problems when this
  // value is used in the JavaScript preview.
  if ($input !== FALSE) {
    // Start with the provided value for this textfield, and validate that if
    // necessary, falling back on the default value.
    $value = form_type_textfield_value($element, $input, $form_state);
    if (!$value || !isset($form_state['complete form']['#token']) || color_valid_hexadecimal_string($value) || drupal_valid_token($form_state['values']['form_token'], $form_state['complete form']['#token'])) {
      return $value;
    }
    else {
      return $element['#default_value'];
    }
  }
}

/**
 * Determines if a hexadecimal CSS color string is valid.
 *
 * @param string $color
 *   The string to check.
 *
 * @return bool
 *   TRUE if the string is a valid hexadecimal CSS color string, or FALSE if it
 *   isn't.
 */
function color_valid_hexadecimal_string($color) {
  return preg_match('/^#([a-f0-9]{3}){1,2}$/iD', $color);
}

304
/**
305 306 307
 * Form validation handler for color_scheme_form().
 *
 * @see color_scheme_form_submit()
308 309 310 311
 */
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) {
312
    if (!color_valid_hexadecimal_string($color)) {
313
      form_set_error('palette][' . $key, $form_state, t('You must enter a valid hexadecimal color value for %name.', array('%name' => $form['color']['palette'][$key]['#title'])));
314 315 316 317
    }
  }
}

318
/**
319 320 321
 * Form submission handler for color_scheme_form().
 *
 * @see color_scheme_form_validate()
322
 */
323
function color_scheme_form_submit($form, &$form_state) {
324

325
  // Get theme coloring info.
326
  if (!isset($form_state['values']['info'])) {
327 328
    return;
  }
329 330
  $theme = $form_state['values']['theme'];
  $info = $form_state['values']['info'];
331

332
  $config = \Drupal::config('color.' . $theme);
333

334
  // Resolve palette.
335 336
  $palette = $form_state['values']['palette'];
  if ($form_state['values']['scheme'] != '') {
337 338 339 340
    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];
      }
341
    }
342
    $palette += $info['schemes']['default']['colors'];
343 344
  }

345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362
  // Make sure enough memory is available.
  // Fetch source image dimensions.
  $source = drupal_get_path('theme', $theme) . '/' . $info['base_image'];
  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;
  // We intend to prevent color scheme changes if there isn't enough memory
  // 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);
  $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');
    return;
363 364
  }

365
  // Delete old files.
366 367 368 369 370
  $files = $config->get('files');
  if (isset($files)) {
    foreach ($files as $file) {
      @drupal_unlink($file);
    }
371
  }
372
  if (isset($file) && $file = dirname($file)) {
373
    @drupal_rmdir($file);
374 375
  }

376
  // No change in color config, use the standard theme from color.inc.
377
  if (implode(',', color_get_palette($theme, TRUE)) == implode(',', $palette)) {
378
    $config->delete();
379 380 381
    return;
  }

382
  // Prepare target locations for generated files.
383
  $id = $theme . '-' . substr(hash('sha256', serialize($palette) . microtime()), 0, 8);
384
  $paths['color'] = file_default_scheme() . '://color';
385
  $paths['target'] = $paths['color'] . '/' . $id;
386
  foreach ($paths as $path) {
387
    file_prepare_directory($path, FILE_CREATE_DIRECTORY);
388
  }
389
  $paths['target'] = $paths['target'] . '/';
390
  $paths['id'] = $id;
391
  $paths['source'] = drupal_get_path('theme', $theme) . '/';
392 393
  $paths['files'] = $paths['map'] = array();

394
  // Save palette and logo location.
395 396 397 398
  $config
    ->set('palette', $palette)
    ->set('logo', $paths['target'] . 'logo.png')
    ->save();
399

400
  // Copy over neutral images.
401
  foreach ($info['copy'] as $file) {
402
    $base = drupal_basename($file);
403
    $source = $paths['source'] . $file;
404
    $filepath = file_unmanaged_copy($source, $paths['target'] . $base);
405
    $paths['map'][$file] = $base;
406
    $paths['files'][] = $filepath;
407 408
  }

409
  // Render new images, if image has been provided.
410 411 412
  if ($info['base_image']) {
    _color_render_images($theme, $info, $paths, $palette);
  }
413

414 415 416
  // Rewrite theme stylesheets.
  $css = array();
  foreach ($info['css'] as $stylesheet) {
417
    // Build a temporary array with CSS files.
418 419 420 421 422 423
    $files = array();
    if (file_exists($paths['source'] . $stylesheet)) {
      $files[] = $stylesheet;
    }

    foreach ($files as $file) {
424
      $css_optimizer = new CssOptimizer();
425 426
      // Aggregate @imports recursively for each configured top level CSS file
      // without optimization. Aggregation and optimization will be
427
      // handled by drupal_build_css_cache() only.
428
      $style = $css_optimizer->loadFile($paths['source'] . $file, FALSE);
429 430 431

      // Return the path to where this CSS file originated from, stripping
      // off the name of the file at the end of the path.
432
      $css_optimizer->rewriteFileURIBasePath = base_path() . dirname($paths['source'] . $file) . '/';
433 434

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

      // Rewrite stylesheet with new colors.
      $style = _color_rewrite_stylesheet($theme, $info, $paths, $palette, $style);
439
      $base_file = drupal_basename($file);
440 441
      $css[] = $paths['target'] . $base_file;
      _color_save_stylesheet($paths['target'] . $base_file, $style, $paths);
442
    }
443
  }
444

445
  // Maintain list of files.
446 447 448 449
  $config
    ->set('stylesheets', $css)
    ->set('files', $paths['files'])
    ->save();
450 451 452
}

/**
453
 * Rewrites the stylesheet to match the colors in the palette.
454
 */
455
function _color_rewrite_stylesheet($theme, &$info, &$paths, $palette, $style) {
456
  // Prepare color conversion table.
457 458 459 460
  $conversion = $palette;
  foreach ($conversion as $k => $v) {
    $conversion[$k] = drupal_strtolower($v);
  }
461
  $default = color_get_palette($theme, TRUE);
462 463

  // Split off the "Don't touch" section of the stylesheet.
464
  $split = "Color Module: Don't touch";
465
  if (strpos($style, $split) !== FALSE) {
466 467
    list($style, $fixed) = explode($split, $style);
  }
468 469 470

  // 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);
471
  $is_color = FALSE;
472 473 474
  $output = '';
  $base = 'base';

475
  // Iterate over all the parts.
476 477 478
  foreach ($style as $chunk) {
    if ($is_color) {
      $chunk = drupal_strtolower($chunk);
479
      // Check if this is one of the colors in the default palette.
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495
      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.
496
      elseif (preg_match('/(?<!-)color[^{:]*:[^{#]*$/i', $chunk)) {
497 498 499 500 501 502 503 504 505 506
        $base = 'text';
      }
      // Reset back to base.
      else {
        $base = 'base';
      }
    }
    $output .= $chunk;
    $is_color = !$is_color;
  }
507 508 509 510
  // Append fixed colors segment.
  if (isset($fixed)) {
    $output .= $fixed;
  }
511

512
  // Replace paths to images.
513
  foreach ($paths['map'] as $before => $after) {
514 515
    $before = base_path() . $paths['source'] . $before;
    $before = preg_replace('`(^|/)(?!../)([^/]+)/../`', '$1', $before);
516 517 518
    $output = str_replace($before, $after, $output);
  }

519
  return $output;
520 521 522
}

/**
523
 * Saves the rewritten stylesheet to disk.
524
 */
525
function _color_save_stylesheet($file, $style, &$paths) {
526
  $filepath = file_unmanaged_save_data($style, $file, FILE_EXISTS_REPLACE);
527
  $paths['files'][] = $filepath;
528 529

  // Set standard file permissions for webserver-generated files.
530
  drupal_chmod($file);
531 532 533
}

/**
534
 * Renders images that match a given palette.
535 536
 */
function _color_render_images($theme, &$info, &$paths, $palette) {
Steven Wittens's avatar
Steven Wittens committed
537
  // Prepare template image.
538
  $source = $paths['source'] . '/' . $info['base_image'];
539 540 541
  $source = imagecreatefrompng($source);
  $width = imagesx($source);
  $height = imagesy($source);
Steven Wittens's avatar
Steven Wittens committed
542 543

  // Prepare target buffer.
544
  $target = imagecreatetruecolor($width, $height);
545
  imagealphablending($target, TRUE);
546 547 548 549 550 551

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

552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568
  // 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);
      }
    }
569 570
  }

Steven Wittens's avatar
Steven Wittens committed
571
  // Blend over template.
572 573
  imagecopy($target, $source, 0, 0, 0, 0, $width, $height);

Steven Wittens's avatar
Steven Wittens committed
574
  // Clean up template image.
575 576
  imagedestroy($source);

Steven Wittens's avatar
Steven Wittens committed
577
  // Cut out slices.
578 579
  foreach ($info['slices'] as $file => $coord) {
    list($x, $y, $width, $height) = $coord;
580
    $base = drupal_basename($file);
581
    $image = drupal_realpath($paths['target'] . $base);
582

Steven Wittens's avatar
Steven Wittens committed
583
    // Cut out slice.
584 585 586
    if ($file == 'screenshot.png') {
      $slice = imagecreatetruecolor(150, 90);
      imagecopyresampled($slice, $target, 0, 0, $x, $y, 150, 90, $width, $height);
587
      \Drupal::config('color.' . $theme)
588 589
        ->set('screenshot', $image)
        ->save();
590 591 592 593 594 595
    }
    else {
      $slice = imagecreatetruecolor($width, $height);
      imagecopy($slice, $target, 0, 0, $x, $y, $width, $height);
    }

Steven Wittens's avatar
Steven Wittens committed
596
    // Save image.
597 598 599 600
    imagepng($slice, $image);
    imagedestroy($slice);
    $paths['files'][] = $image;

601
    // Set standard file permissions for webserver-generated files
602
    drupal_chmod($image);
603

604 605 606 607
    // Build before/after map of image paths.
    $paths['map'][$file] = $base;
  }

Steven Wittens's avatar
Steven Wittens committed
608
  // Clean up target buffer.
609 610 611 612
  imagedestroy($target);
}

/**
613
 * Shifts a given color, using a reference pair and a target blend color.
614 615 616 617
 *
 * Note: this function is significantly different from the JS version, as it
 * is written to match the blended images perfectly.
 *
618 619
 * Constraint: if (ref2 == target + (ref1 - target) * delta) for some fraction
 * delta then (return == target + (given - target) * delta).
620 621
 *
 * Loose constraint: Preserve relative positions in saturation and luminance
622
 * space.
623 624 625
 */
function _color_shift($given, $ref1, $ref2, $target) {
  // We assume that ref2 is a blend of ref1 and target and find
626
  // delta based on the length of the difference vectors.
627 628

  // delta = 1 - |ref2 - ref1| / |white - ref1|
629 630 631
  $target = _color_unpack($target, TRUE);
  $ref1 = _color_unpack($ref1, TRUE);
  $ref2 = _color_unpack($ref2, TRUE);
632 633
  $numerator = 0;
  $denominator = 0;
634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653
  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.
654
  $given = _color_unpack($given, TRUE);
655 656 657 658 659 660 661 662 663 664 665 666 667
  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.
668
  return _color_pack($result, TRUE);
669 670 671
}

/**
672
 * Converts a hex triplet into a GD color.
673 674 675 676 677 678 679
 */
function _color_gd($img, $hex) {
  $c = array_merge(array($img), _color_unpack($hex));
  return call_user_func_array('imagecolorallocate', $c);
}

/**
680
 * Blends two hex colors and returns the GD color.
681 682 683 684 685 686 687 688
 */
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;
  }
689

690 691 692 693
  return call_user_func_array('imagecolorallocate', $out);
}

/**
694
 * Converts a hex color into an RGB triplet.
695
 */
696
function _color_unpack($hex, $normalize = FALSE) {
697 698 699 700 701 702 703
  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);
  }
704

705 706 707 708
  return $out;
}

/**
709
 * Converts an RGB triplet to a hex color.
710
 */
711
function _color_pack($rgb, $normalize = FALSE) {
712
  $out = 0;
713 714 715
  foreach ($rgb as $k => $v) {
    $out |= (($v * ($normalize ? 255 : 1)) << (16 - $k * 8));
  }
716

717
  return '#' . str_pad(dechex($out), 6, 0, STR_PAD_LEFT);
718 719 720
}

/**
721
 * Converts an HSL triplet into RGB.
722 723 724 725 726 727 728
 */
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;
729

730 731 732 733 734
  return array(
    _color_hue2rgb($m1, $m2, $h + 0.33333),
    _color_hue2rgb($m1, $m2, $h),
    _color_hue2rgb($m1, $m2, $h - 0.33333),
  );
735 736 737 738 739 740 741 742 743 744
}

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

746 747 748 749
  return $m1;
}

/**
750
 * Converts an RGB triplet to HSL.
751 752 753 754 755 756 757 758 759 760
 */
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;
761

762
  if ($l > 0 && $l < 1) {
Steven Wittens's avatar
Steven Wittens committed
763
    $s = $delta / ($l < 0.5 ? (2 * $l) : (2 - 2 * $l));
764
  }
765

766 767
  $h = 0;
  if ($delta > 0) {
Steven Wittens's avatar
Steven Wittens committed
768 769 770 771
    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;
772
  }
773

774
  return array($h, $s, $l);
775
}
776 777 778 779 780 781 782

/**
 * Implements hook_library_info().
 */
function color_library_info() {
  $libraries['drupal.color'] = array(
    'title' => 'Color',
783
    'version' => \Drupal::VERSION,
784 785 786 787 788 789 790 791 792 793 794 795 796
    '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',
797
    'version' => \Drupal::VERSION,
798 799 800 801 802 803
    'js' => array(
      drupal_get_path('module', 'color') . '/preview.js' => array(),
    ),
    'dependencies' => array(
      array('system', 'jquery'),
      array('system', 'drupal'),
804
      array('system', 'drupalSettings'),
805 806 807 808 809 810
      array('system', 'jquery.once'),
    ),
  );

  return $libraries;
}