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

7
use Drupal\Core\Asset\CssOptimizer;
8 9
use Drupal\Component\Utility\Bytes;
use Drupal\Component\Utility\Environment;
10
use Drupal\Component\Utility\String;
11
use Symfony\Component\HttpFoundation\Request;
12

13
/**
14
 * Implements hook_help().
15
 */
16 17 18
function color_help($route_name, Request $request) {
  switch ($route_name) {
    case 'help.page.color':
19
      $output = '<h3>' . t('About') . '</h3>';
20
      $output .= '<p>' . t('The Color module allows users with the <em>Administer site configuration</em> permission to change the color scheme (color of links, backgrounds, text, and other theme elements) of themes that are compatible with it. For more information, see <a href="!color_do">the online documentation for the Color module</a>.', array('!color_do' => 'https://drupal.org/documentation/modules/color')) . '</p>';
21 22
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
23
      $output .= '<dt>' . t('Changing colors') . '</dt>';
24 25
      $output .= '<dd><p>' . t('To change the color settings, select the <em>Settings</em> link for your theme on the <a href="!appearance">Appearance</a> page. If the color picker does not appear than the theme is not compatible with the Color module.', array('!appearance' => \Drupal::url('system.themes_page'))) . '</p>';
      $output .= '<p>' . 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.') . '</p></dd>';
26
      $output .= '</dl>';
27 28 29 30
      return $output;
  }
}

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

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

62
/**
63
 * Implements hook_css_alter().
64
 *
65
 * Replaces style sheets with color-altered style sheets.
66
 */
67
function color_css_alter(&$css) {
68
  global $theme_key;
69
  $themes = list_themes();
70 71

  // Override stylesheets.
72
  $color_paths = \Drupal::config('color.theme.' . $theme_key)->get('stylesheets');
73 74

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

76
    foreach ($themes[$theme_key]->stylesheets['all'] as $old_path) {
77 78 79 80 81
      // 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.
82
        if (drupal_basename($old_path) == drupal_basename($color_path)) {
83 84
          // Replace the path to the new css file.
          // This keeps the order of the stylesheets intact.
85
          $css[drupal_basename($old_path)]['data'] = $color_path;
86 87 88
        }
      }
    }
89
  }
90 91 92
}

/**
93
 * Implements hook_preprocess_page().
94
 *
95
 * Replace the logo with the colored version if available.
96
 */
97
function color_preprocess_page(&$variables) {
98
  global $theme_key;
99

100
  // Override logo.
101
  $logo = \Drupal::config('color.theme.' . $theme_key)->get('logo');
102 103
  if ($logo && $variables['logo'] && preg_match('!' . $theme_key . '/logo.png$!', $variables['logo'])) {
    $variables['logo'] = file_create_url($logo);
104 105 106 107
  }
}

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

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

117
  $path = drupal_get_path('theme', $theme);
118
  $file = DRUPAL_ROOT . '/' . $path . '/color/color.inc';
119 120
  if ($path && file_exists($file)) {
    include $file;
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136
    // Add in default values.
    $info += array(
      // CSS files (excluding @import) to rewrite with new color scheme.
      'css' => array(),
      // Files to copy.
      'copy' => array(),
      // Gradient definitions.
      'gradients' => array(),
      // Color areas to fill (x, y, width, height).
      'fill' => array(),
      // Coordinates of all the theme slices (x, y, width, height) with their
      // filename as used in the stylesheet.
      'slices' => array(),
      // Reference color used for blending.
      'blend_target' => '#ffffff',
    );
137
    $theme_info[$theme] = $info;
138 139 140 141 142
    return $info;
  }
}

/**
143
 * Retrieves the color palette for a particular theme.
144
 */
145
function color_get_palette($theme, $default = FALSE) {
146
  // Fetch and expand default palette.
147
  $info = color_get_info($theme);
148
  $palette = $info['schemes']['default']['colors'];
149

150 151 152 153
  if ($default) {
    return $palette;
  }

154
  // Load variable.
155
  // @todo Default color config should be moved to yaml in the theme.
156
  return \Drupal::config('color.theme.' . $theme)->get('palette') ?: $palette;
157 158 159
}

/**
160 161 162 163 164 165 166
 * 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()
167
 */
168
function color_scheme_form($complete_form, &$form_state, $theme) {
169 170 171
  $base = drupal_get_path('module', 'color');
  $info = color_get_info($theme);

172 173 174 175 176 177 178 179 180
  $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'];
  }

181
  // See if we're using a predefined scheme.
182
  // Note: we use the original theme when the default scheme is chosen.
183
  $current_scheme = \Drupal::config('color.theme.' . $theme)->get('palette');
184 185 186 187 188 189 190 191 192 193 194 195 196 197
  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 = '';
    }
  }
198

199
  // Add scheme selector.
200 201 202
  $form['scheme'] = array(
    '#type' => 'select',
    '#title' => t('Color set'),
203 204
    '#options' => $color_sets,
    '#default_value' => $scheme_name,
205 206
    '#attached' => array(
      'library' => array(
207
        'color/drupal.color',
208 209 210
      ),
      // Add custom CSS.
      'css' => array(
211
        $base . '/css/color.admin.css' => array(),
212 213 214 215 216
      ),
      // Add custom JavaScript.
      'js' => array(
        array(
          'data' => array(
217 218 219 220 221
            'color' => array(
              'reference' => color_get_palette($theme, TRUE),
              'schemes' => $schemes,
            ),
            'gradients' => $info['gradients'],
222 223 224
          ),
          'type' => 'setting',
        ),
225 226
      ),
    ),
227 228
  );

229
  // Add palette fields.
230
  $palette = color_get_palette($theme);
231
  $names = $info['fields'];
232
  $form['palette']['#tree'] = TRUE;
233
  foreach ($palette as $name => $value) {
234 235 236
    if (isset($names[$name])) {
      $form['palette'][$name] = array(
        '#type' => 'textfield',
237
        '#title' => String::checkPlain($names[$name]),
238
        '#value_callback' => 'color_palette_color_value',
239 240
        '#default_value' => $value,
        '#size' => 8,
241
        '#attributes' => array('dir' => 'ltr'),
242 243
      );
    }
244
  }
245
  $form['theme'] = array('#type' => 'value', '#value' => $theme);
246 247 248 249 250 251
  $form['info'] = array('#type' => 'value', '#value' => $info);

  return $form;
}

/**
252
 * Prepares variables for color scheme form templates.
253
 *
254 255 256
 * Default template: color-scheme-form.html.twig.
 *
 * @param array $variables
257 258
 *   An associative array containing:
 *   - form: A render element representing the form.
259
 */
260
function template_preprocess_color_scheme_form(&$variables) {
261
  $form = &$variables['form'];
262

263 264
  $theme = $form['theme']['#value'];
  $info = $form['info']['#value'];
265
  $path = drupal_get_path('theme', $theme) . '/';
266

267 268 269 270
  if (isset($info['preview_css'])) {
    $preview_css_path = $path . $info['preview_css'];
    $form['scheme']['#attached']['css'][$preview_css_path] = array();
  }
271 272
  $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.
273
  $form['scheme']['#attached']['js'][$preview_js_path] = array('weight' => -1);
274

275 276
  // 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');
277
  $variables['html_preview'] = file_get_contents($preview_html_path);
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 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325
/**
 * 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);
}

326
/**
327 328 329
 * Form validation handler for color_scheme_form().
 *
 * @see color_scheme_form_submit()
330 331 332 333
 */
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) {
334
    if (!color_valid_hexadecimal_string($color)) {
335
      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'])));
336 337 338 339
    }
  }
}

340
/**
341 342 343
 * Form submission handler for color_scheme_form().
 *
 * @see color_scheme_form_validate()
344
 */
345
function color_scheme_form_submit($form, &$form_state) {
346

347
  // Get theme coloring info.
348
  if (!isset($form_state['values']['info'])) {
349 350
    return;
  }
351 352
  $theme = $form_state['values']['theme'];
  $info = $form_state['values']['info'];
353

354
  $config = \Drupal::config('color.theme.' . $theme);
355

356
  // Resolve palette.
357 358
  $palette = $form_state['values']['palette'];
  if ($form_state['values']['scheme'] != '') {
359 360 361 362
    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];
      }
363
    }
364
    $palette += $info['schemes']['default']['colors'];
365 366
  }

367
  // Make sure enough memory is available.
368 369 370 371 372 373 374 375 376 377 378 379 380 381
  if (isset($info['base_image'])) {
    // 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');
382 383
    $size = Bytes::toInt($memory_limit);
    if (!Environment::checkMemoryLimit($usage + $required, $memory_limit)) {
384 385 386
      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;
    }
387 388
  }

389
  // Delete old files.
390 391 392 393 394
  $files = $config->get('files');
  if (isset($files)) {
    foreach ($files as $file) {
      @drupal_unlink($file);
    }
395
  }
396
  if (isset($file) && $file = dirname($file)) {
397
    @drupal_rmdir($file);
398 399
  }

400
  // No change in color config, use the standard theme from color.inc.
401
  if (implode(',', color_get_palette($theme, TRUE)) == implode(',', $palette)) {
402
    $config->delete();
403 404 405
    return;
  }

406
  // Prepare target locations for generated files.
407
  $id = $theme . '-' . substr(hash('sha256', serialize($palette) . microtime()), 0, 8);
408
  $paths['color'] = 'public://color';
409
  $paths['target'] = $paths['color'] . '/' . $id;
410
  foreach ($paths as $path) {
411
    file_prepare_directory($path, FILE_CREATE_DIRECTORY);
412
  }
413
  $paths['target'] = $paths['target'] . '/';
414
  $paths['id'] = $id;
415
  $paths['source'] = drupal_get_path('theme', $theme) . '/';
416 417
  $paths['files'] = $paths['map'] = array();

418
  // Save palette and logo location.
419 420 421 422
  $config
    ->set('palette', $palette)
    ->set('logo', $paths['target'] . 'logo.png')
    ->save();
423

424
  // Copy over neutral images.
425
  foreach ($info['copy'] as $file) {
426
    $base = drupal_basename($file);
427
    $source = $paths['source'] . $file;
428
    $filepath = file_unmanaged_copy($source, $paths['target'] . $base);
429
    $paths['map'][$file] = $base;
430
    $paths['files'][] = $filepath;
431 432
  }

433
  // Render new images, if image has been provided.
434
  if (isset($info['base_image'])) {
435 436
    _color_render_images($theme, $info, $paths, $palette);
  }
437

438 439 440
  // Rewrite theme stylesheets.
  $css = array();
  foreach ($info['css'] as $stylesheet) {
441
    // Build a temporary array with CSS files.
442 443 444 445 446 447
    $files = array();
    if (file_exists($paths['source'] . $stylesheet)) {
      $files[] = $stylesheet;
    }

    foreach ($files as $file) {
448
      $css_optimizer = new CssOptimizer();
449 450
      // Aggregate @imports recursively for each configured top level CSS file
      // without optimization. Aggregation and optimization will be
451
      // handled by drupal_build_css_cache() only.
452
      $style = $css_optimizer->loadFile($paths['source'] . $file, FALSE);
453 454 455

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

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

      // Rewrite stylesheet with new colors.
      $style = _color_rewrite_stylesheet($theme, $info, $paths, $palette, $style);
463
      $base_file = drupal_basename($file);
464 465
      $css[] = $paths['target'] . $base_file;
      _color_save_stylesheet($paths['target'] . $base_file, $style, $paths);
466
    }
467
  }
468

469
  // Maintain list of files.
470 471 472 473
  $config
    ->set('stylesheets', $css)
    ->set('files', $paths['files'])
    ->save();
474 475 476
}

/**
477
 * Rewrites the stylesheet to match the colors in the palette.
478
 */
479
function _color_rewrite_stylesheet($theme, &$info, &$paths, $palette, $style) {
480
  // Prepare color conversion table.
481 482 483 484
  $conversion = $palette;
  foreach ($conversion as $k => $v) {
    $conversion[$k] = drupal_strtolower($v);
  }
485
  $default = color_get_palette($theme, TRUE);
486 487

  // Split off the "Don't touch" section of the stylesheet.
488
  $split = "Color Module: Don't touch";
489
  if (strpos($style, $split) !== FALSE) {
490 491
    list($style, $fixed) = explode($split, $style);
  }
492 493 494

  // 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);
495
  $is_color = FALSE;
496 497 498
  $output = '';
  $base = 'base';

499
  // Iterate over all the parts.
500 501 502
  foreach ($style as $chunk) {
    if ($is_color) {
      $chunk = drupal_strtolower($chunk);
503
      // Check if this is one of the colors in the default palette.
504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519
      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.
520
      elseif (preg_match('/(?<!-)color[^{:]*:[^{#]*$/i', $chunk)) {
521 522 523 524 525 526 527 528 529 530
        $base = 'text';
      }
      // Reset back to base.
      else {
        $base = 'base';
      }
    }
    $output .= $chunk;
    $is_color = !$is_color;
  }
531 532 533 534
  // Append fixed colors segment.
  if (isset($fixed)) {
    $output .= $fixed;
  }
535

536
  // Replace paths to images.
537
  foreach ($paths['map'] as $before => $after) {
538 539
    $before = base_path() . $paths['source'] . $before;
    $before = preg_replace('`(^|/)(?!../)([^/]+)/../`', '$1', $before);
540 541 542
    $output = str_replace($before, $after, $output);
  }

543
  return $output;
544 545 546
}

/**
547
 * Saves the rewritten stylesheet to disk.
548
 */
549
function _color_save_stylesheet($file, $style, &$paths) {
550
  $filepath = file_unmanaged_save_data($style, $file, FILE_EXISTS_REPLACE);
551
  $paths['files'][] = $filepath;
552 553

  // Set standard file permissions for webserver-generated files.
554
  drupal_chmod($file);
555 556 557
}

/**
558
 * Renders images that match a given palette.
559 560
 */
function _color_render_images($theme, &$info, &$paths, $palette) {
Steven Wittens's avatar
Steven Wittens committed
561
  // Prepare template image.
562
  $source = $paths['source'] . '/' . $info['base_image'];
563 564 565
  $source = imagecreatefrompng($source);
  $width = imagesx($source);
  $height = imagesy($source);
Steven Wittens's avatar
Steven Wittens committed
566 567

  // Prepare target buffer.
568
  $target = imagecreatetruecolor($width, $height);
569
  imagealphablending($target, TRUE);
570 571 572 573 574 575

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

576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592
  // 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);
      }
    }
593 594
  }

Steven Wittens's avatar
Steven Wittens committed
595
  // Blend over template.
596 597
  imagecopy($target, $source, 0, 0, 0, 0, $width, $height);

Steven Wittens's avatar
Steven Wittens committed
598
  // Clean up template image.
599 600
  imagedestroy($source);

Steven Wittens's avatar
Steven Wittens committed
601
  // Cut out slices.
602 603
  foreach ($info['slices'] as $file => $coord) {
    list($x, $y, $width, $height) = $coord;
604
    $base = drupal_basename($file);
605
    $image = drupal_realpath($paths['target'] . $base);
606

Steven Wittens's avatar
Steven Wittens committed
607
    // Cut out slice.
608 609 610
    if ($file == 'screenshot.png') {
      $slice = imagecreatetruecolor(150, 90);
      imagecopyresampled($slice, $target, 0, 0, $x, $y, 150, 90, $width, $height);
611
      \Drupal::config('color.theme.' . $theme)
612 613
        ->set('screenshot', $image)
        ->save();
614 615 616 617 618 619
    }
    else {
      $slice = imagecreatetruecolor($width, $height);
      imagecopy($slice, $target, 0, 0, $x, $y, $width, $height);
    }

Steven Wittens's avatar
Steven Wittens committed
620
    // Save image.
621 622 623 624
    imagepng($slice, $image);
    imagedestroy($slice);
    $paths['files'][] = $image;

625
    // Set standard file permissions for webserver-generated files
626
    drupal_chmod($image);
627

628 629 630 631
    // Build before/after map of image paths.
    $paths['map'][$file] = $base;
  }

Steven Wittens's avatar
Steven Wittens committed
632
  // Clean up target buffer.
633 634 635 636
  imagedestroy($target);
}

/**
637
 * Shifts a given color, using a reference pair and a target blend color.
638 639 640 641
 *
 * Note: this function is significantly different from the JS version, as it
 * is written to match the blended images perfectly.
 *
642 643
 * Constraint: if (ref2 == target + (ref1 - target) * delta) for some fraction
 * delta then (return == target + (given - target) * delta).
644 645
 *
 * Loose constraint: Preserve relative positions in saturation and luminance
646
 * space.
647 648 649
 */
function _color_shift($given, $ref1, $ref2, $target) {
  // We assume that ref2 is a blend of ref1 and target and find
650
  // delta based on the length of the difference vectors.
651 652

  // delta = 1 - |ref2 - ref1| / |white - ref1|
653 654 655
  $target = _color_unpack($target, TRUE);
  $ref1 = _color_unpack($ref1, TRUE);
  $ref2 = _color_unpack($ref2, TRUE);
656 657
  $numerator = 0;
  $denominator = 0;
658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677
  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.
678
  $given = _color_unpack($given, TRUE);
679 680 681 682 683 684 685 686 687 688 689 690 691
  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.
692
  return _color_pack($result, TRUE);
693 694 695
}

/**
696
 * Converts a hex triplet into a GD color.
697 698 699 700 701 702 703
 */
function _color_gd($img, $hex) {
  $c = array_merge(array($img), _color_unpack($hex));
  return call_user_func_array('imagecolorallocate', $c);
}

/**
704
 * Blends two hex colors and returns the GD color.
705 706 707 708 709 710 711 712
 */
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;
  }
713

714 715 716 717
  return call_user_func_array('imagecolorallocate', $out);
}

/**
718
 * Converts a hex color into an RGB triplet.
719
 */
720
function _color_unpack($hex, $normalize = FALSE) {
721 722 723 724 725 726 727
  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);
  }
728

729 730 731 732
  return $out;
}

/**
733
 * Converts an RGB triplet to a hex color.
734
 */
735
function _color_pack($rgb, $normalize = FALSE) {
736
  $out = 0;
737 738 739
  foreach ($rgb as $k => $v) {
    $out |= (($v * ($normalize ? 255 : 1)) << (16 - $k * 8));
  }
740

741
  return '#' . str_pad(dechex($out), 6, 0, STR_PAD_LEFT);
742 743 744
}

/**
745
 * Converts an HSL triplet into RGB.
746 747 748 749 750 751 752
 */
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;
753

754 755 756 757 758
  return array(
    _color_hue2rgb($m1, $m2, $h + 0.33333),
    _color_hue2rgb($m1, $m2, $h),
    _color_hue2rgb($m1, $m2, $h - 0.33333),
  );
759 760 761 762 763 764 765 766 767 768
}

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

770 771 772 773
  return $m1;
}

/**
774
 * Converts an RGB triplet to HSL.
775 776 777 778 779 780 781 782 783 784
 */
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;
785

786
  if ($l > 0 && $l < 1) {
Steven Wittens's avatar
Steven Wittens committed
787
    $s = $delta / ($l < 0.5 ? (2 * $l) : (2 - 2 * $l));
788
  }
789

790 791
  $h = 0;
  if ($delta > 0) {
Steven Wittens's avatar
Steven Wittens committed
792 793 794 795
    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;
796
  }
797

798
  return array($h, $s, $l);
799
}