utility.inc in ImageCache Actions 6
Same filename and directory in other branches
Utility form, conversion and rendering functions for image processes
File
utility.incView source
<?php
/**
* @file Utility form, conversion and rendering functions for image processes
*/
/**
* Prepare a subform for displaying RGB fields
*
* Helper function to render a common element.
*
* Note that any module that re-uses this form also has to declare the theme
* function in order to ensure it's in the registry.
*/
function imagecache_rgb_form($action) {
if ($action['HEX'] && ($deduced = hex_to_rgb($action['HEX']))) {
$action = array_merge($action, $deduced);
$action['HEX'] = ltrim($action['HEX'], '#');
// With or without # is valid, but trim for consistancy
}
$form = array(
'#theme' => 'imagecacheactions_rgb_form',
);
$form['farb'] = array(
'#weight' => -1,
);
// Placeholder to get its weight right
$form['HEX'] = array(
'#type' => 'textfield',
'#title' => t('HEX'),
'#default_value' => $action['HEX'],
'#size' => 7,
);
return $form;
}
/**
* Prepare a subform for displaying positioning fields
*
* Helper function to render a common element.
*/
function imagecacheactions_pos_form($action) {
$defaults = array(
'xpos' => 'center',
'ypos' => 'center',
);
$action = array_merge($defaults, (array) $action);
$form = array(
#'#theme' => 'canvasactions_pos_form',
'xpos' => array(
'#type' => 'textfield',
'#title' => t('X offset'),
'#default_value' => $action['xpos'],
'#size' => 6,
'#description' => t('Enter an offset in pixels or use a keyword: <em>left</em>, <em>center</em>, or <em>right</em>.'),
'#element_validate' => array(
'imagecache_actions_validate_number',
),
),
'ypos' => array(
'#type' => 'textfield',
'#title' => t('Y offset'),
'#default_value' => $action['ypos'],
'#size' => 6,
'#description' => t('Enter an offset in pixels or use a keyword: <em>top</em>, <em>center</em>, or <em>bottom</em>.'),
'#element_validate' => array(
'imagecache_actions_validate_number',
),
),
);
return $form;
}
/**
* Ensure the numbers are valid.
*
* Set blanks to zero, just so the status summary doesn't get odd blanks
*/
function imagecache_actions_validate_number(&$element, &$form_state) {
if (empty($element['#value'])) {
form_set_value($element, 0, $form_state);
}
}
function imagecache_actions_validate_alpha(&$element, &$form_status) {
if (!is_numeric($element['#value']) || $element['#value'] < 1 || $element['#value'] > 100) {
form_set_error(join('][', $element['#parents']), t('Opacity must be a number between 1 and 100.'));
}
}
/**
* Render the subform in a table
*/
function theme_imagecacheactions_rgb_form(&$form) {
// Add a farb element
drupal_add_css('misc/farbtastic/farbtastic.css', 'module', 'all', FALSE);
drupal_add_js('misc/farbtastic/farbtastic.js');
// drupal_add_js(drupal_get_path('module', 'imagecache_coloractions') . '/color.js');
$hex_id = $form['HEX']['#id'];
$form['farb'] = array(
'#value' => "<div id=\"{$hex_id}-farb\" style=\"float:right\"></div>",
'#weight' => -1,
);
// Adds the JS that binds the textarea with the farb element
$js = "\n \$(document).ready(function() {\n farbify(\$('#{$hex_id}'), '#{$hex_id}-farb');\n });\n\n function farbify(elt, wrapper) {\n var farb = \$.farbtastic(wrapper);\n farb.linkTo(function(color) {\n elt\n .css('background-color', color)\n .css('color', this.hsl[2] > 0.5 ? '#000' : '#fff')\n .val(color.substring(1));\n });\n farb.setColor('#' + elt.val());\n elt.bind('keyup', function(){ updateColor(elt, farb); });\n }\n function updateColor(elt, farb) {\n var text = elt.val();\n if (text.length == 6)\n farb.setColor('#' + text);\n }\n\n ";
drupal_add_js($js, 'inline');
$output = drupal_render($form);
return $output;
}
function theme_imagecacheactions_rgb($rgb) {
if ($rgb['HEX']) {
return " <span style=\"width:2em; border:1px solid white; background-color:#{$rgb['HEX']}\" > #{$rgb['HEX']} </span>";
}
else {
return ' ' . t('Transparent');
}
}
/**
* Decode an HTML hex-code into an array of R, G, and B values.
* accepts these formats: (case insensitive) #ffffff, ffffff, #fff, fff
*/
function hex_to_rgb($hex) {
$hex = trim($hex);
// remove '#'
if (substr($hex, 0, 1) == '#') {
$hex = substr($hex, 1);
}
// expand short form ('fff') color
if (strlen($hex) == 3) {
$hex = substr($hex, 0, 1) . substr($hex, 0, 1) . substr($hex, 1, 1) . substr($hex, 1, 1) . substr($hex, 2, 1) . substr($hex, 2, 1);
}
if (strlen($hex) != 6) {
trigger_error('Error: Invalid color "' . $hex . '"');
}
// convert
$rgb['red'] = hexdec(substr($hex, 0, 2));
$rgb['green'] = hexdec(substr($hex, 2, 2));
$rgb['blue'] = hexdec(substr($hex, 4, 2));
return $rgb;
}
/**
* Accept a keyword (center, top, left, etc) and return it as an offset in pixels.
* Called on either the x or y values.
*
* May be something like "20", "center", "left+20", "bottom+10". + values are
* in from the sides, so bottom+10 is 10 UP from the bottom.
*
* "center+50" is also OK.
*
* "30%" will place the CENTER of the object at 30% across. to get a 30% margin,
* use "left+30%"
*
* @param $value
* string or int value.
* @param $current_size
* int size in pixels of the range this item is to be placed in
* @param $object_size
* int size in pixels of the object to be placed
*
*
*/
function imagecache_actions_keyword_filter($value, $current_size, $object_size) {
$keyword = '';
$offset = 0;
// Check if we have plus or minus values
// Assume that no + means a raw value
$keyword_split = explode('+', $value);
$keyword = $keyword_split[0];
if (!empty($keyword_split[1])) {
$offset = intval($keyword_split[1]);
}
if (strstr($value, '-')) {
$keyword_split = explode('-', $value);
$keyword = $keyword_split[0];
if (!empty($keyword_split[1])) {
$offset = -1 * intval($keyword_split[1]);
}
}
// handle % values
if (substr($value, strlen($value) - 1, 1) == '%') {
$percent = TRUE;
$offset = intval($offset);
$value = intval($value / 100 * $current_size);
if (!$keyword) {
// just said eg '25%' - so center the object there
$offset = $object_size / -2;
}
else {
// Otherwise the keyword will give us the new value, and the % will be its offset
$offset = intval($offset / 100 * $current_size);
}
}
#dpm(get_defined_vars());
// Whether the value is 'top or left doesn't matter, treat both axes the same.
switch ($keyword) {
case 'top':
case 'left':
$value = 0;
break;
case 'bottom':
case 'right':
$value = $current_size - $object_size;
$offset = -1 * $offset;
break;
case 'center':
case 'middle':
$value = $current_size / 2 - $object_size / 2;
break;
default:
// if no keyword, it was a raw number - assume top left then
$value = intval($value);
}
#dpm(get_defined_vars());
#dpm("Placing an object $object_size big on a range of $current_size at a position of $value , $offset");
// Add any extra negative or positive
if (!empty($offset)) {
$value = $value + $offset;
}
return $value;
}
/**
* Given two imageapi objects with dimensions, and some positioning values,
* calculate a new x,y for the layer to be placed at.
*/
function imagecache_actions_calculate_relative_position($base, $layer, $style) {
// $textimage should now have its size info available.
// Calc the position
if (isset($style['top'])) {
$ypos = $style['top'];
}
if (isset($style['bottom'])) {
$ypos = $base->info['height'] - ($layer->info['height'] + $style['bottom']);
}
if (!isset($ypos)) {
// assume center
$ypos = $base->info['height'] / 2 - $layer->info['height'] / 2;
}
if (isset($style['left'])) {
$xpos = $style['left'];
}
if (isset($style['right'])) {
$xpos = $base->info['width'] - ($layer->info['width'] + $style['right']);
}
if (!isset($xpos)) {
// assume center
$xpos = $base->info['width'] / 2 - $layer->info['width'] / 2;
}
return array(
'x' => $xpos,
'y' => $ypos,
);
}
/**
* imagecache is conservative with its inclusion of inc files, but sometimes I
* need to use them - eg crop. This function finds and includes it if needed.
*/
function imagecache_include_standard_actions() {
$cropaction = imagecache_action_definition('imagecache_crop');
include_once $cropaction['file'];
}
/**
* Given only a file filename, track back to see if we can detect the parent
* node and provide some context info.
*
* This will be different in different cases.
* Supported :
* image.module image nodes
* imagefield cck fields (may be multiple)
* upload.module attachments
*
* TODO: image_attach attachments
*
* @param $filepath
* @param $file_data MAY get some details filled in on it by reference if data
* was found.
*
* @return a loaded $node object
*/
function imagecache_actions_node_from_filepath($filepath, &$file_data = NULL) {
// lookup upload.module attachments
if (module_exists('upload')) {
$sql = "SELECT nid, f.fid FROM {upload} AS u INNER JOIN {files} AS f ON u.fid = f.fid WHERE f.filepath = '%s'";
$results = db_query_range($sql, $filepath, 0, 1);
if ($row = db_fetch_array($results)) {
// Return immediately
$node = node_load($row['nid']);
// also include the file description
$file_data = $node->files[$row['fid']];
return $node;
}
}
// Lookup image.module nodes
if (module_exists('image')) {
$sql = "SELECT nid FROM {image} AS i INNER JOIN {files} AS f ON i.fid = f.fid WHERE f.filepath = '%s'";
if ($nid = db_result(db_query_range($sql, $filepath, 0, 1))) {
// Return immediately
return node_load($nid);
}
}
// Lookup filefield imagefield CCK attachments.
//
// Drupal 6 version here based largely on work done by mikeytown2
// http://drupal.org/node/363434
// This is a terrible way to retrieve information, but CCK doesn't provide a way to reverse-lookup like this
// BAD CODE follows
// If someone could roll these DBlookups into a smaller ball, that would be fun.
// Due to CCKs use of dynamically created table names .. I don't know how.
// Multiple file ID's might have the same name, get all
// (but return just the first successful match)
$result = db_query("SELECT fid FROM {files} WHERE filepath = '%s'", $filepath);
$fids = array();
while ($row = db_fetch_array($result)) {
$fids[] = $row['fid'];
}
if (!empty($fids)) {
// Find out if any filefield contains this file, and if so, which field
// and node it belongs to. Required for later access checking.
// CCK field analysis is in the outer loop,
// fids are scanned in the inner loop for a little speed.
// Get A List Of ALL CCK Fields and look for them individually,
// it's the only way we can reverse the lookups
foreach (content_fields() as $field) {
// If Field is an Image (imagefield.module) or filefield then
if ($field['type'] == 'image' || $field['type'] == 'filefield') {
// Need to do lots of lookups to find out what the storage tables look like.
// Grab All DB Column Names for that CCK Field
$db_info = content_database_info($field);
// Get Content Type DB name - FROM statement
$tablename = $db_info['table'];
//Get File ID DB Column Name - WHERE statement
$fid_column = $db_info['columns']['fid']['column'];
// Construct a Query that looks for all known fids in one go.
// eg:
// SELECT nid FROM content_type_story
// WHERE field_illustration_fid = 77
// OR field_illustration_fid = 99;
$wheres = array();
$query_args = array();
foreach ($fids as $fid) {
$wheres[] = " %s = %d ";
$query_args[] = $fid_column;
$query_args[] = $fid;
}
$result = db_query('SELECT nid FROM {' . $tablename . '} WHERE ' . join(' OR ', $wheres), $query_args);
while ($row = db_fetch_array($result)) {
// This while is a dummy loop - Just break out and return the first matching node.
// If more than one node owns this image then ???
$node = node_load($row['nid']);
// Add even more info - the description "data" that MAY have been added
// to this file on this node using filefield_meta and stuff.
// Return the data associated specifically with this file also;
// Do this via the handle on the file_data object we were passed in.
// Slightly mushed together - I want it to mostly resemble the traditional file attachment object.
// We have the node but lost track of the file in the process.
// Need to scan again to make sure we got the right one :-{
if ($file_fields = $node->{$field['field_name']}) {
foreach ($file_fields as $file_field) {
if ($file_field['fid'] == $fid) {
$actual_file = $file_field;
}
}
$file_data = (object) array_merge((array) $file_data, $actual_file['data'], $actual_file);
}
return $node;
}
}
}
}
}Functions
Name |
Description |
|---|---|
| hex_to_rgb | Decode an HTML hex-code into an array of R, G, and B values. accepts these formats: (case insensitive) #ffffff, ffffff, #fff, fff |
| imagecacheactions_pos_form | Prepare a subform for displaying positioning fields |
| imagecache_actions_calculate_relative_position | Given two imageapi objects with dimensions, and some positioning values, calculate a new x,y for the layer to be placed at. |
| imagecache_actions_keyword_filter | Accept a keyword (center, top, left, etc) and return it as an offset in pixels. Called on either the x or y values. |
| imagecache_actions_node_from_filepath | Given only a file filename, track back to see if we can detect the parent node and provide some context info. |
| imagecache_actions_validate_alpha | |
| imagecache_actions_validate_number | Ensure the numbers are valid. |
| imagecache_include_standard_actions | imagecache is conservative with its inclusion of inc files, but sometimes I need to use them - eg crop. This function finds and includes it if needed. |
| imagecache_rgb_form | Prepare a subform for displaying RGB fields |
| theme_imagecacheactions_rgb | |
| theme_imagecacheactions_rgb_form | Render the subform in a table |