/usr/share/php/Horde/Image/Base.php is in php-horde-image 2.1.0-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 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 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 | <?php
/**
* This class defines the Horde_Image:: API, and also provides some
* utility functions, such as generating highlights of a color.
*
* Copyright 2002-2014 Horde LLC (http://www.horde.org/)
*
* See the enclosed file COPYING for license information (LGPL). If you
* did not receive this file, see http://www.horde.org/licenses/lgpl21.
*
* @author Chuck Hagenbuch <chuck@horde.org>
* @author Michael J. Rubinsky <mrubinsk@horde.org>
* @package Image
*/
abstract class Horde_Image_Base extends EmptyIterator
{
/**
* Background color.
*
* @var string
*/
protected $_background = 'white';
/**
* Observers.
*
* @var array
*/
protected $_observers = array();
/**
* The current image data.
*
* @var string
*/
protected $_data = '';
/**
* Logger
*/
protected $_logger;
/**
* The current width of the image data.
*
* @var integer
*/
protected $_width = 0;
/**
* The current height of the image data.
*
* @var integer
*/
protected $_height = 0;
/**
* A directory for temporary files.
*
* @var string
*/
protected $_tmpdir;
/**
* Array containing available Effects
*
* @var array
*/
protected $_loadedEffects = array();
/**
* What kind of images should ImageMagick generate? Defaults to 'png'.
*
* @var string
*/
protected $_type = 'png';
/**
* Cache the context
*
* @param array
*/
protected $_context;
/**
* Constructor.
*
* @param array $params The image object parameters. Values include:
*<pre>
* (optional)width - The desired image width
* (optional)height - The desired image height
* (optional)type - The image type (png, jpeg etc...) If not provided,
* or set by the setType method, any image output will
* be converted to the default image type of png.
* (optional)data - The image binary data.
*</pre>
* @param array $context The object context - configuration, injected objects
*<pre>
* (required)tmpdir - Temporary directory
* (optional)logger - The logger
*</pre>
* @throws InvalidArgumentException
*/
protected function __construct($params, $context = array())
{
$this->_params = $params;
$this->_context = $context;
if (empty($context['tmpdir'])) {
throw new InvalidArgumentException('A path to a temporary directory is required.');
}
$this->_tmpdir = $context['tmpdir'];
if (isset($params['width'])) {
$this->_width = $params['width'];
}
if (isset($params['height'])) {
$this->_height = $params['height'];
}
if (!empty($params['type'])) {
// We only want the extension, not the full mimetype.
if (strpos($params['type'], 'image/') !== false) {
$params['type'] = substr($params['type'], 6);
}
$this->_type = $params['type'];
}
if (!empty($context['logger'])) {
$this->_logger = $context['logger'];
}
$this->_background = isset($params['background']) ? $params['background'] : 'white';
}
/**
* Getter for the capabilities array
*
* @return array
*/
public function getCapabilities()
{
return $this->_capabilities;
}
/**
* Check the existence of a particular capability.
*
* @param string $capability The capability to check for.
*
* @return boolean
*/
public function hasCapability($capability)
{
return in_array($capability, $this->_capabilities);
}
/**
* Generate image headers.
*/
public function headers()
{
header('Content-type: ' . $this->getContentType());
}
/**
* Return the content type for this image.
*
* @return string The content type for this image.
*/
public function getContentType()
{
return 'image/' . $this->_type;
}
/**
* Getter for the simplified image type.
*
* @return string The type of image (png, jpg, etc...)
*/
public function getType()
{
return $this->_type;
}
/**
* Setter for the image type.
*
* @param string $type The simple type for the imag (png, jpg, etc...)
*
* @return void
*/
public function setType($type)
{
// We only want the extension, not the full mimetype.
if (strpos($type, 'image/') !== false) {
$type = substr($type, 6);
}
$old = $this->_type;
$this->_type = $type;
return $old;
}
/**
* Draw a shaped point at the specified (x,y) point. Useful for
* scatter diagrams, debug points, etc. Draws squares, circles,
* diamonds, and triangles.
*
* @param integer $x The x coordinate of the point to brush.
* @param integer $y The y coordinate of the point to brush.
* @param string $color The color to brush the point with.
* @param string $shape What brush to use? Defaults to a square.
*/
public function brush($x, $y, $color = 'black', $shape = 'square')
{
switch ($shape) {
case 'triangle':
$verts[0] = array('x' => $x + 3, 'y' => $y + 3);
$verts[1] = array('x' => $x, 'y' => $y - 3);
$verts[2] = array('x' => $x - 3, 'y' => $y + 3);
$this->polygon($verts, $color, $color);
break;
case 'circle':
$this->circle($x, $y, 3, $color, $color);
break;
case 'diamond':
$verts[0] = array('x' => $x - 3, 'y' => $y);
$verts[1] = array('x' => $x, 'y' => $y + 3);
$verts[2] = array('x' => $x + 3, 'y' => $y);
$verts[3] = array('x' => $x, 'y' => $y - 3);
$this->polygon($verts, $color, $color);
break;
case 'square':
default:
$this->rectangle($x - 2, $y - 2, 4, 4, $color, $color);
break;
}
}
/**
* Reset the image data to defaults.
*/
public function reset()
{
$this->_data = '';
$this->_width = null;
$this->_height = null;
$this->_background = 'white';
}
/**
* Get the height and width of the current image data.
*
* @return array An hash with 'width' containing the width,
* 'height' containing the height of the image.
*/
public function getDimensions()
{
// Check if we know it already
if ($this->_width == 0 && $this->_height == 0) {
$tmp = $this->toFile();
$details = @getimagesize($tmp);
list($this->_width, $this->_height) = $details;
unlink($tmp);
}
return array('width' => $this->_width,
'height' => $this->_height);
}
/**
* Load the image data from a string.
*
* @param string $id An arbitrary id for the image.
* @param string $image_data The data to use for the image.
*/
public function loadString($image_data)
{
$this->reset();
$this->_data = $image_data;
}
/**
* Load the image data from a file.
*
* @param string $filename The full path and filename to the file to load
* the image data from. The filename will also be
* used for the image id.
*
* @return mixed True if successful or already loaded, PEAR Error if file
* does not exist or could not be loaded.
* @throws Horde_Image_Exception
*/
public function loadFile($filename)
{
$this->reset();
if (!file_exists($filename)) {
throw new Horde_Image_Exception(sprintf("The image file, %s, does not exist.", $filename));
}
if (!$this->_data = file_get_contents($filename)) {
throw new Horde_Image_Exception(sprintf("Could not load the image file %s", $filename));
}
return true;
}
/**
* Ouputs image data to file. If $data is false, outputs current
* image data after performing any pending operations on the data.
* If $data contains raw image data, outputs that data to file without
* regard for $this->_data
*
* @param mixed String of binary image data | false
*
* @return string Path to temporary file.
*/
public function toFile($data = false)
{
$tmp = Horde_Util::getTempFile('img', false, $this->_tmpdir);
$fp = @fopen($tmp, 'wb');
fwrite($fp, $data ? $data : $this->raw());
fclose($fp);
return $tmp;
}
/**
* Display the current image.
*/
public function display()
{
$this->headers();
echo $this->raw(true);
}
/**
* Returns the raw data for this image.
*
* @param boolean $convert If true, the image data will be returned in the
* target format, independently from any image
* operations.
*
* @return string The raw image data.
*/
public function raw($convert = false)
{
return $this->_data;
}
/**
* Attempts to apply requested effect to this image.
*
* @param string $type The type of effect to apply.
* @param array $params Any parameters for the effect.
*
* @return boolean
*/
public function addEffect($type, $params)
{
$class = str_replace('Horde_Image_', '', get_class($this));
$params['logger'] = $this->_logger;
$effect = Horde_Image_Effect::factory($type, $class, $params);
$effect->setImageObject($this);
return $effect->apply();
}
/**
* Load a list of available effects for this driver.
*/
public function getLoadedEffects()
{
if (!count($this->_loadedEffects)) {
$class = str_replace('Horde_Image_', '', get_class($this));
$this->_loadedEffects = array();
// First, load the driver-agnostic Effects.
$path = __DIR__ . '/Effect/';
if (is_dir($path)) {
if ($handle = opendir($path)) {
while (($file = readdir($handle)) !== false) {
if (substr($file, -4, 4) == '.php') {
$this->_loadedEffects[] = substr($file, 0, strlen($file) - 4);
}
}
}
}
// Driver specific effects.
$path = $path . $class;
if (is_dir($path)) {
if ($handle = opendir($path)) {
while (($file = readdir($handle)) !== false) {
if (substr($file, -4, 4) == '.php') {
$this->_loadedEffects[] = substr($file, 0, strlen($file) - 4);
}
}
}
}
}
return $this->_loadedEffects;
}
/**
* Apply any effects in the effect queue.
*/
public function applyEffects()
{
$this->raw();
}
public function getTmpDir()
{
return $this->_tmpdir;
}
/**
* Utility function to zero out cached geometry information. Shouldn't
* really be called from client code, but is needed since Effects may need
* to clear these.
*
*/
public function clearGeometry()
{
$this->_height = 0;
$this->_width = 0;
}
protected function _logDebug($message)
{
if (!empty($this->_logger)) {
$this->_logger->debug($message);
}
}
protected function _logErr($message)
{
if (!empty($this->_logger)) {
$this->_logger->err($message);
}
}
/**
* Request a specific image from the collection of images.
*
* @param integer $index The index to return
*
* @return Horde_Image_Base
*/
abstract function getImageAtIndex($index);
/**
* Return the number of image pages available in the image object.
*
* @return integer
*/
abstract function getImagePageCount();
}
|