aboutsummaryrefslogtreecommitdiffstats
path: root/Zotlabs/Photo/PhotoDriver.php
blob: c47a7c3b2666ca406166ca7f2429316e9860672a (plain) (blame)
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
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
<?php

namespace Zotlabs\Photo;

/**
 * @brief Abstract photo driver class.
 *
 * Inheritance seems not to be the best design pattern for such photo drivers.
 */
abstract class PhotoDriver {

	/**
	 * @brief This variable keeps the image.
	 *
	 * For GD it is a PHP image resource.
	 * For ImageMagick it is an \Imagick object.
	 *
	 * @var resource|\Imagick
	 */
	protected $image;

	/**
	 * @var integer
	 */
	protected $width;

	/**
	 * @var integer
	 */
	protected $height;

	/**
	 * @var boolean
	 */
	protected $valid;

	/**
	 * @brief The mimetype of the image.
	 *
	 * @var string
	 */
	protected $type;

	/**
	 * @brief Supported mimetypes by the used photo driver.
	 *
	 * @var array
	 */
	protected $types;

	/**
	 * @brief Return an array with supported mimetypes.
	 *
	 * @return array
	 *  Associative array with mimetype as key and file extension as value.
	 */
	abstract public function supportedTypes();

	abstract protected function load($data, $type);

	abstract protected function destroy();

	abstract protected function setDimensions();

	/**
	 * @brief Return the current image.
	 *
	 * @fixme Shouldn't his method be protected, because outside of the current
	 * driver it makes no sense at all because of the different return values.
	 *
	 * @return boolean|resource|\Imagick
	 *  false on failure, a PHP image resource for GD driver, an \Imagick object
	 *  for ImageMagick driver.
	 */
	abstract public function getImage();

	abstract public function doScaleImage($new_width, $new_height);

	abstract public function rotate($degrees);

	abstract public function flip($horiz = true, $vert = false);

	/**
	 * @brief Crops the image.
	 *
	 * @param int $maxx width of the new image
	 * @param int $maxy height of the new image
	 * @param int $x x-offset for region
	 * @param int $y y-offset for region
	 * @param int $w width of region
	 * @param int $h height of region
	 *
	 * @return boolean|void false on failure
	 */
	abstract public function cropImageRect($maxx, $maxy, $x, $y, $w, $h);

	/**
	 * @brief Return a binary string from the image resource.
	 *
	 * @return string A Binary String.
	 */
	abstract public function imageString();

	abstract public function clearexif();


	/**
	 * @brief PhotoDriver constructor.
	 *
	 * @param string $data Image
	 * @param string $type mimetype
	 */
	public function __construct($data, $type = '') {
		$this->types = $this->supportedTypes();
		if(! array_key_exists($type, $this->types)) {
			$type = 'image/jpeg';
		}
		$this->type = $type;
		$this->valid = false;
		$this->load($data, $type);
	}

	public function __destruct() {
		if($this->is_valid())
			$this->destroy();
	}

	/**
	 * @brief Is it a valid image object.
	 *
	 * @return boolean
	 */
	public function is_valid() {
		return $this->valid;
	}

	/**
	 * @brief Get the width of the image.
	 *
	 * @return boolean|number Width of image in pixels, or false on failure
	 */
	public function getWidth() {
		if(! $this->is_valid())
			return false;

		return $this->width;
	}

	/**
	 * @brief Get the height of the image.
	 *
	 * @return boolean|number Height of image in pixels, or false on failure
	 */
	public function getHeight() {
		if(! $this->is_valid())
			return false;

		return $this->height;
	}

	/**
	 * @brief Saves the image resource to a file in filesystem.
	 *
	 * @param string $path Path and filename where to save the image
	 * @return boolean False on failure, otherwise true
	 */
	public function saveImage($path) {
		if(! $this->is_valid())
			return false;

		return (file_put_contents($path, $this->imageString()) ? true : false);
	}

	/**
	 * @brief Return mimetype of the image resource.
	 *
	 * @return boolean|string False on failure, otherwise mimetype.
	 */
	public function getType() {
		if(! $this->is_valid())
			return false;

		return $this->type;
	}

	/**
	 * @brief Return file extension of the image resource.
	 *
	 * @return boolean|string False on failure, otherwise file extension.
	 */
	public function getExt() {
		if(! $this->is_valid())
			return false;

		return $this->types[$this->getType()];
	}

	/**
	 * @brief Scale image to max pixel size in either dimension.
	 *
	 * @param int $max maximum pixel size in either dimension
	 * @param boolean $float_height (optional)
	 *   If true allow height to float to any length on tall images, constraining
	 *   only the width
	 * @return boolean|void false on failure, otherwise void
	 */
	public function scaleImage($max, $float_height = true) {
		if(! $this->is_valid())
			return false;

		$width = $this->width;
		$height = $this->height;

		$dest_width = $dest_height = 0;

		if((! $width) || (! $height))
			return false;

		if($width > $max && $height > $max) {

			// very tall image (greater than 16:9)
			// constrain the width - let the height float.

			if(((($height * 9) / 16) > $width) && ($float_height)) {
				$dest_width = $max;
				$dest_height = intval(($height * $max) / $width);
			} // else constrain both dimensions
			elseif($width > $height) {
				$dest_width = $max;
				$dest_height = intval(($height * $max) / $width);
			} else {
				$dest_width = intval(($width * $max) / $height);
				$dest_height = $max;
			}
		} else {
			if($width > $max) {
				$dest_width = $max;
				$dest_height = intval(($height * $max) / $width);
			} else {
				if($height > $max) {

					// very tall image (greater than 16:9)
					// but width is OK - don't do anything

					if(((($height * 9) / 16) > $width) && ($float_height)) {
						$dest_width = $width;
						$dest_height = $height;
					} else {
						$dest_width = intval(($width * $max) / $height);
						$dest_height = $max;
					}
				} else {
					$dest_width = $width;
					$dest_height = $height;
				}
			}
		}
		$this->doScaleImage($dest_width, $dest_height);
	}

	public function scaleImageUp($min) {
		if(! $this->is_valid()) {
			return false;
		}

		$width = $this->width;
		$height = $this->height;

		$dest_width = $dest_height = 0;

		if((! $width) || (! $height))
			return false;

		if($width < $min && $height < $min) {
			if($width > $height) {
				$dest_width = $min;
				$dest_height = intval(($height * $min) / $width);
			} else {
				$dest_width = intval(($width * $min) / $height);
				$dest_height = $min;
			}
		} else {
			if($width < $min) {
				$dest_width = $min;
				$dest_height = intval(($height * $min) / $width);
			} else {
				if($height < $min) {
					$dest_width = intval(($width * $min) / $height);
					$dest_height = $min;
				} else {
					$dest_width = $width;
					$dest_height = $height;
				}
			}
		}
		$this->doScaleImage($dest_width, $dest_height);
	}

	/**
	 * @brief Scales image to a square.
	 *
	 * @param int $dim Pixel of square image
	 * @return boolean|void false on failure, otherwise void
	 */
	public function scaleImageSquare($dim) {
		if(! $this->is_valid())
			return false;

		$this->doScaleImage($dim, $dim);
	}

	/**
	 * @brief Crops a square image.
	 *
	 * @see cropImageRect()
	 *
	 * @param int $max size of the new image
	 * @param int $x x-offset for region
	 * @param int $y y-offset for region
	 * @param int $w width of region
	 * @param int $h height of region
	 *
	 * @return boolean|void false on failure
	 */
	public function cropImage($max, $x, $y, $w, $h) {
		if(! $this->is_valid())
			return false;

		$this->cropImageRect($max, $max, $x, $y, $w, $h);
	}

	/**
	 * @brief Reads exif data from a given filename.
	 *
	 * @param string $filename
	 * @return boolean|array
	 */
	public function exif($filename) {
		if((! function_exists('exif_read_data'))
				|| (! in_array($this->getType(), ['image/jpeg', 'image/tiff'])))
		{
			return false;
		}

		/*
		 * PHP 7.2 allows you to use a stream resource, which should reduce/avoid
		 * memory exhaustion on large images.
		 */

		if(version_compare(PHP_VERSION, '7.2.0') >= 0) {
			$f = @fopen($filename, 'rb');
		} else {
			$f = $filename;
		}

		if($f) {
			return @exif_read_data($f, null, true);
		}

		return false;
	}

	/**
	 * @brief Orients current image based on exif orientation information.
	 *
	 * @param array $exif
	 * @return boolean true if oriented, otherwise false
	 */
	public function orient($exif) {
		if(! ($this->is_valid() && $exif)) {
			return false;
		}

		$ort = ((array_key_exists('IFD0', $exif)) ? $exif['IFD0']['Orientation'] : $exif['Orientation']);

		if(! $ort) {
			return false;
		}

		switch($ort) {
			case 1 : // nothing
				break;
			case 2 : // horizontal flip
				$this->flip();
				break;
			case 3 : // 180 rotate left
				$this->rotate(180);
				break;
			case 4 : // vertical flip
				$this->flip(false, true);
				break;
			case 5 : // vertical flip + 90 rotate right
				$this->flip(false, true);
				$this->rotate(-90);
				break;
			case 6 : // 90 rotate right
				$this->rotate(-90);
				break;
			case 7 : // horizontal flip + 90 rotate right
				$this->flip();
				$this->rotate(-90);
				break;
			case 8 : // 90 rotate left
				$this->rotate(90);
				break;
			default :
				break;
		}

		return true;
	}

	/**
	 * @brief Save photo to database.
	 *
	 * @param array $arr
	 * @param boolean $skipcheck (optional) default false
	 * @return boolean|array
	 */
	public function save($arr, $skipcheck = false) {
		if(! ($skipcheck || $this->is_valid())) {
			logger('Attempt to store invalid photo.');
			return false;
		}

		$p = [];

		$p['aid'] = ((intval($arr['aid'])) ? intval($arr['aid']) : 0);
		$p['uid'] = ((intval($arr['uid'])) ? intval($arr['uid']) : 0);
		$p['xchan'] = (($arr['xchan']) ? $arr['xchan'] : '');
		$p['resource_id'] = (($arr['resource_id']) ? $arr['resource_id'] : '');
		$p['filename'] = (($arr['filename']) ? $arr['filename'] : '');
		$p['mimetype'] = (($arr['mimetype']) ? $arr['mimetype'] : $this->getType());
		$p['album'] = (($arr['album']) ? $arr['album'] : '');
		$p['imgscale'] = ((intval($arr['imgscale'])) ? intval($arr['imgscale']) : 0);
		$p['allow_cid'] = (($arr['allow_cid']) ? $arr['allow_cid'] : '');
		$p['allow_gid'] = (($arr['allow_gid']) ? $arr['allow_gid'] : '');
		$p['deny_cid'] = (($arr['deny_cid']) ? $arr['deny_cid'] : '');
		$p['deny_gid'] = (($arr['deny_gid']) ? $arr['deny_gid'] : '');
		$p['edited'] = (($arr['edited']) ? $arr['edited'] : datetime_convert());
		$p['title'] = (($arr['title']) ? $arr['title'] : '');
		$p['description'] = (($arr['description']) ? $arr['description'] : '');
		$p['photo_usage'] = intval($arr['photo_usage']);
		$p['os_storage'] = intval($arr['os_storage']);
		$p['os_path'] = $arr['os_path'];
		$p['os_syspath'] = ((array_key_exists('os_syspath', $arr)) ? $arr['os_syspath'] : '');
		$p['display_path'] = (($arr['display_path']) ? $arr['display_path'] : '');
		$p['width'] = (($arr['width']) ? $arr['width'] : $this->getWidth());
		$p['height'] = (($arr['height']) ? $arr['height'] : $this->getHeight());
		$p['expires'] = (($arr['expires']) ? $arr['expires'] : gmdate('Y-m-d H:i:s', time() + get_config('system', 'photo_cache_time', 86400)));

		if(! intval($p['imgscale']))
			logger('save: ' . print_r($arr, true), LOGGER_DATA);

		$x = q("select id, created from photo where resource_id = '%s' and uid = %d and xchan = '%s' and imgscale = %d limit 1", dbesc($p['resource_id']), intval($p['uid']), dbesc($p['xchan']), intval($p['imgscale']));

		if($x) {
			$p['created'] = (($x['created']) ? $x['created'] : $p['edited']);
			$r = q("UPDATE photo set
				aid = %d,
				uid = %d,
				xchan = '%s',
				resource_id = '%s',
				created = '%s',
				edited = '%s',
				filename = '%s',
				mimetype = '%s',
				album = '%s',
				height = %d,
				width = %d,
				content = '%s',
				os_storage = %d,
				filesize = %d,
				imgscale = %d,
				photo_usage = %d,
				title = '%s',
				description = '%s',
				os_path = '%s',
				display_path = '%s',
				allow_cid = '%s',
				allow_gid = '%s',
				deny_cid = '%s',
				deny_gid = '%s',
				expires = '%s'
				where id = %d",
			intval($p['aid']), intval($p['uid']), dbesc($p['xchan']), dbesc($p['resource_id']), dbescdate($p['created']), dbescdate($p['edited']), dbesc(basename($p['filename'])), dbesc($p['mimetype']), dbesc($p['album']), intval($p['height']), intval($p['width']), (intval($p['os_storage']) ? dbescbin($p['os_syspath']) : dbescbin($this->imageString())), intval($p['os_storage']), (intval($p['os_storage']) ? @filesize($p['os_syspath']) : strlen($this->imageString())), intval($p['imgscale']), intval($p['photo_usage']), dbesc($p['title']), dbesc($p['description']), dbesc($p['os_path']), dbesc($p['display_path']), dbesc($p['allow_cid']), dbesc($p['allow_gid']), dbesc($p['deny_cid']), dbesc($p['deny_gid']), dbescdate($p['expires']), intval($x[0]['id']));
		} else {
			$p['created'] = (($arr['created']) ? $arr['created'] : $p['edited']);
			$r = q("INSERT INTO photo
				( aid, uid, xchan, resource_id, created, edited, filename, mimetype, album, height, width, content, os_storage, filesize, imgscale, photo_usage, title, description, os_path, display_path, allow_cid, allow_gid, deny_cid, deny_gid, expires )
				VALUES ( %d, %d, '%s', '%s', '%s', '%s', '%s', '%s', '%s', %d, %d, '%s', %d, %d, %d, %d, '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s' )", intval($p['aid']), intval($p['uid']), dbesc($p['xchan']), dbesc($p['resource_id']), dbescdate($p['created']), dbescdate($p['edited']), dbesc(basename($p['filename'])), dbesc($p['mimetype']), dbesc($p['album']), intval($p['height']), intval($p['width']), (intval($p['os_storage']) ? dbescbin($p['os_syspath']) : dbescbin($this->imageString())), intval($p['os_storage']), (intval($p['os_storage']) ? @filesize($p['os_syspath']) : strlen($this->imageString())), intval($p['imgscale']), intval($p['photo_usage']), dbesc($p['title']), dbesc($p['description']), dbesc($p['os_path']), dbesc($p['display_path']), dbesc($p['allow_cid']), dbesc($p['allow_gid']), dbesc($p['deny_cid']), dbesc($p['deny_gid']), dbescdate($p['expires']));
		}
		logger('Photo save imgscale ' . $p['imgscale'] . ' returned ' . intval($r));

		return $r;
	}

}