-
Notifications
You must be signed in to change notification settings - Fork 669
/
filestore.php
747 lines (657 loc) · 20.5 KB
/
filestore.php
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
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
<?php
/**
* Elgg filestore.
* This file contains functions for saving and retrieving data from files.
*
* @package Elgg.Core
* @subpackage DataModel.FileStorage
*/
/**
* Get the size of the specified directory.
*
* @param string $dir The full path of the directory
* @param int $total_size Add to current dir size
*
* @return int The size of the directory in bytes
*/
function get_dir_size($dir, $total_size = 0) {
$handle = @opendir($dir);
while ($file = @readdir($handle)) {
if (in_array($file, array('.', '..'))) {
continue;
}
if (is_dir($dir . $file)) {
$total_size = get_dir_size($dir . $file . "/", $total_size);
} else {
$total_size += filesize($dir . $file);
}
}
@closedir($handle);
return($total_size);
}
/**
* Get the contents of an uploaded file.
* (Returns false if there was an issue.)
*
* @param string $input_name The name of the file input field on the submission form
*
* @return mixed|false The contents of the file, or false on failure.
*/
function get_uploaded_file($input_name) {
$files = _elgg_services()->request->files;
if (!$files->has($input_name)) {
return false;
}
$file = $files->get($input_name);
if (empty($file)) {
// a file input was provided but no file uploaded
return false;
}
if ($file->getError() !== 0) {
return false;
}
return file_get_contents($file->getPathname());
}
/**
* Gets the jpeg contents of the resized version of an uploaded image
* (Returns false if the uploaded file was not an image)
*
* @param string $input_name The name of the file input field on the submission form
* @param int $maxwidth The maximum width of the resized image
* @param int $maxheight The maximum height of the resized image
* @param bool $square If set to true, will take the smallest
* of maxwidth and maxheight and use it to set the
* dimensions on all size; the image will be cropped.
* @param bool $upscale Resize images smaller than $maxwidth x $maxheight?
*
* @return false|mixed The contents of the resized image, or false on failure
*/
function get_resized_image_from_uploaded_file($input_name, $maxwidth, $maxheight,
$square = false, $upscale = false) {
$files = _elgg_services()->request->files;
if (!$files->has($input_name)) {
return false;
}
$file = $files->get($input_name);
if (empty($file)) {
// a file input was provided but no file uploaded
return false;
}
if ($file->getError() !== 0) {
return false;
}
return get_resized_image_from_existing_file($file->getPathname(), $maxwidth,
$maxheight, $square, 0, 0, 0, 0, $upscale);
}
/**
* Gets the jpeg contents of the resized version of an already uploaded image
* (Returns false if the file was not an image)
*
* @param string $input_name The name of the file on the disk
* @param int $maxwidth The desired width of the resized image
* @param int $maxheight The desired height of the resized image
* @param bool $square If set to true, takes the smallest of maxwidth and
* maxheight and use it to set the dimensions on the new image.
* If no crop parameters are set, the largest square that fits
* in the image centered will be used for the resize. If square,
* the crop must be a square region.
* @param int $x1 x coordinate for top, left corner
* @param int $y1 y coordinate for top, left corner
* @param int $x2 x coordinate for bottom, right corner
* @param int $y2 y coordinate for bottom, right corner
* @param bool $upscale Resize images smaller than $maxwidth x $maxheight?
*
* @return false|mixed The contents of the resized image, or false on failure
*/
function get_resized_image_from_existing_file($input_name, $maxwidth, $maxheight, $square = false,
$x1 = 0, $y1 = 0, $x2 = 0, $y2 = 0, $upscale = false) {
// Get the size information from the image
$imgsizearray = getimagesize($input_name);
if ($imgsizearray == false) {
return false;
}
$width = $imgsizearray[0];
$height = $imgsizearray[1];
$accepted_formats = array(
'image/jpeg' => 'jpeg',
'image/pjpeg' => 'jpeg',
'image/png' => 'png',
'image/x-png' => 'png',
'image/gif' => 'gif'
);
// make sure the function is available
$load_function = "imagecreatefrom" . $accepted_formats[$imgsizearray['mime']];
if (!is_callable($load_function)) {
return false;
}
// get the parameters for resizing the image
$options = array(
'maxwidth' => $maxwidth,
'maxheight' => $maxheight,
'square' => $square,
'upscale' => $upscale,
'x1' => $x1,
'y1' => $y1,
'x2' => $x2,
'y2' => $y2,
);
$params = get_image_resize_parameters($width, $height, $options);
if ($params == false) {
return false;
}
// load original image
$original_image = call_user_func($load_function, $input_name);
if (!$original_image) {
return false;
}
// allocate the new image
$new_image = imagecreatetruecolor($params['newwidth'], $params['newheight']);
if (!$new_image) {
return false;
}
// color transparencies white (default is black)
imagefilledrectangle(
$new_image, 0, 0, $params['newwidth'], $params['newheight'],
imagecolorallocate($new_image, 255, 255, 255)
);
$rtn_code = imagecopyresampled( $new_image,
$original_image,
0,
0,
$params['xoffset'],
$params['yoffset'],
$params['newwidth'],
$params['newheight'],
$params['selectionwidth'],
$params['selectionheight']);
if (!$rtn_code) {
return false;
}
// grab a compressed jpeg version of the image
ob_start();
imagejpeg($new_image, null, 90);
$jpeg = ob_get_clean();
imagedestroy($new_image);
imagedestroy($original_image);
return $jpeg;
}
/**
* Calculate the parameters for resizing an image
*
* @param int $width Width of the original image
* @param int $height Height of the original image
* @param array $options See $defaults for the options
*
* @return array or false
* @since 1.7.2
*/
function get_image_resize_parameters($width, $height, $options) {
$defaults = array(
'maxwidth' => 100,
'maxheight' => 100,
'square' => false,
'upscale' => false,
'x1' => 0,
'y1' => 0,
'x2' => 0,
'y2' => 0,
);
$options = array_merge($defaults, $options);
// Avoiding extract() because it hurts static analysis
$maxwidth = $options['maxwidth'];
$maxheight = $options['maxheight'];
$square = $options['square'];
$upscale = $options['upscale'];
$x1 = $options['x1'];
$y1 = $options['y1'];
$x2 = $options['x2'];
$y2 = $options['y2'];
// crop image first?
$crop = true;
if ($x1 == 0 && $y1 == 0 && $x2 == 0 && $y2 == 0) {
$crop = false;
}
// how large a section of the image has been selected
if ($crop) {
$selection_width = $x2 - $x1;
$selection_height = $y2 - $y1;
} else {
// everything selected if no crop parameters
$selection_width = $width;
$selection_height = $height;
}
// determine cropping offsets
if ($square) {
// asking for a square image back
// detect case where someone is passing crop parameters that are not for a square
if ($crop == true && $selection_width != $selection_height) {
return false;
}
// size of the new square image
$new_width = $new_height = min($maxwidth, $maxheight);
// find largest square that fits within the selected region
$selection_width = $selection_height = min($selection_width, $selection_height);
// set offsets for crop
if ($crop) {
$widthoffset = $x1;
$heightoffset = $y1;
$width = $x2 - $x1;
$height = $width;
} else {
// place square region in the center
$widthoffset = floor(($width - $selection_width) / 2);
$heightoffset = floor(($height - $selection_height) / 2);
}
} else {
// non-square new image
$new_width = $maxwidth;
$new_height = $maxheight;
// maintain aspect ratio of original image/crop
if (($selection_height / (float)$new_height) > ($selection_width / (float)$new_width)) {
$new_width = floor($new_height * $selection_width / (float)$selection_height);
} else {
$new_height = floor($new_width * $selection_height / (float)$selection_width);
}
// by default, use entire image
$widthoffset = 0;
$heightoffset = 0;
if ($crop) {
$widthoffset = $x1;
$heightoffset = $y1;
}
}
if (!$upscale && ($selection_height < $new_height || $selection_width < $new_width)) {
// we cannot upscale and selected area is too small so we decrease size of returned image
if ($square) {
$new_height = $selection_height;
$new_width = $selection_width;
} else {
if ($selection_height < $new_height && $selection_width < $new_width) {
$new_height = $selection_height;
$new_width = $selection_width;
}
}
}
$params = array(
'newwidth' => $new_width,
'newheight' => $new_height,
'selectionwidth' => $selection_width,
'selectionheight' => $selection_height,
'xoffset' => $widthoffset,
'yoffset' => $heightoffset,
);
return $params;
}
/**
* Delete an \ElggFile file
*
* @param int $guid \ElggFile GUID
*
* @return bool
*/
function file_delete($guid) {
$file = get_entity($guid);
if (!$file || !$file->canEdit()) {
return false;
}
$thumbnail = $file->thumbnail;
$smallthumb = $file->smallthumb;
$largethumb = $file->largethumb;
if ($thumbnail) {
$delfile = new \ElggFile();
$delfile->owner_guid = $file->owner_guid;
$delfile->setFilename($thumbnail);
$delfile->delete();
}
if ($smallthumb) {
$delfile = new \ElggFile();
$delfile->owner_guid = $file->owner_guid;
$delfile->setFilename($smallthumb);
$delfile->delete();
}
if ($largethumb) {
$delfile = new \ElggFile();
$delfile->owner_guid = $file->owner_guid;
$delfile->setFilename($largethumb);
$delfile->delete();
}
return $file->delete();
}
/**
* Delete a directory and all its contents
*
* @param string $directory Directory to delete
*
* @return bool
*/
function delete_directory($directory) {
// sanity check: must be a directory
if (!$handle = opendir($directory)) {
return false;
}
// loop through all files
while (($file = readdir($handle)) !== false) {
if (in_array($file, array('.', '..'))) {
continue;
}
$path = "$directory/$file";
if (is_dir($path)) {
// recurse down through directory
if (!delete_directory($path)) {
return false;
}
} else {
// delete file
unlink($path);
}
}
// remove empty directory
closedir($handle);
return rmdir($directory);
}
/**
* Removes all entity files
*
* @warning This only deletes the physical files and not their entities.
* This will result in FileExceptions being thrown. Don't use this function.
*
* @warning This must be kept in sync with \ElggDiskFilestore.
*
* @todo Remove this when all files are entities.
*
* @param \ElggEntity $entity An \ElggEntity
*
* @return void
* @access private
*/
function _elgg_clear_entity_files($entity) {
$dir = new \Elgg\EntityDirLocator($entity->guid);
$file_path = elgg_get_config('dataroot') . $dir;
if (file_exists($file_path)) {
delete_directory($file_path);
}
}
/// Variable holding the default datastore
$DEFAULT_FILE_STORE = null;
/**
* Return the default filestore.
*
* @return \ElggFilestore
* @deprecated Will be removed in 3.0
*/
function get_default_filestore() {
elgg_deprecated_notice(__FUNCTION__ . ' is deprecated.', '2.1');
return $GLOBALS['DEFAULT_FILE_STORE'];
}
/**
* Set the default filestore for the system.
*
* @param \ElggFilestore $filestore An \ElggFilestore object.
*
* @return true
* @deprecated Will be removed in 3.0
*/
function set_default_filestore(\ElggFilestore $filestore) {
elgg_deprecated_notice(__FUNCTION__ . ' is deprecated.', '2.1');
$GLOBALS['DEFAULT_FILE_STORE'] = $filestore;
return true;
}
/**
* Returns the category of a file from its MIME type
*
* @param string $mime_type The MIME type
*
* @return string 'document', 'audio', 'video', or 'general' if the MIME type was unrecognized
* @since 1.10
*/
function elgg_get_file_simple_type($mime_type) {
$params = array('mime_type' => $mime_type);
return elgg_trigger_plugin_hook('simple_type', 'file', $params, 'general');
}
/**
* Bootstraps the default filestore at "boot, system" event
*
* @return void
* @access private
*/
function _elgg_filestore_boot() {
global $CONFIG;
// Now register a default filestore
if (isset($CONFIG->dataroot)) {
$GLOBALS['DEFAULT_FILE_STORE'] = new \ElggDiskFilestore($CONFIG->dataroot);
}
}
/**
* Register file-related handlers on "init, system" event
*
* @return void
* @access private
*/
function _elgg_filestore_init() {
// Fix MIME type detection for Microsoft zipped formats
elgg_register_plugin_hook_handler('mime_type', 'file', '_elgg_filestore_detect_mimetype');
// Parse category of file from MIME type
elgg_register_plugin_hook_handler('simple_type', 'file', '_elgg_filestore_parse_simpletype');
// Unit testing
elgg_register_plugin_hook_handler('unit_test', 'system', '_elgg_filestore_test');
// Handler for serving embedded icons
elgg_register_page_handler('serve-icon', '_elgg_filestore_serve_icon_handler');
// Touch entity icons if entity access id has changed
elgg_register_event_handler('update:after', 'object', '_elgg_filestore_touch_icons');
elgg_register_event_handler('update:after', 'group', '_elgg_filestore_touch_icons');
// Move entity icons if entity owner has changed
elgg_register_event_handler('update:after', 'object', '_elgg_filestore_move_icons');
elgg_register_event_handler('update:after', 'group', '_elgg_filestore_move_icons');
}
/**
* Fix MIME type detection for Microsoft zipped formats
*
* @param string $hook "mime_type"
* @param string $type "file"
* @param string $mime_type Detected MIME type
* @param array $params Hook parameters
*
* @return string The MIME type
* @access private
*/
function _elgg_filestore_detect_mimetype($hook, $type, $mime_type, $params) {
$original_filename = elgg_extract('original_filename', $params);
$ext = pathinfo($original_filename, PATHINFO_EXTENSION);
return (new \Elgg\Filesystem\MimeTypeDetector())->fixDetectionErrors($mime_type, $ext);
}
/**
* Parse a file category of file from a MIME type
*
* @param string $hook "simple_type"
* @param string $type "file"
* @param string $simple_type The category of file
* @param array $params Hook parameters
*
* @return string 'document', 'audio', 'video', or 'general' if the MIME type is unrecognized
* @access private
*/
function _elgg_filestore_parse_simpletype($hook, $type, $simple_type, $params) {
$mime_type = elgg_extract('mime_type', $params);
switch ($mime_type) {
case "application/msword":
case "application/vnd.openxmlformats-officedocument.wordprocessingml.document":
case "application/pdf":
return "document";
case "application/ogg":
return "audio";
}
if (preg_match('~^(audio|image|video)/~', $mime_type, $m)) {
return $m[1];
}
if (0 === strpos($mime_type, 'text/') || false !== strpos($mime_type, 'opendocument')) {
return "document";
}
// unrecognized MIME
return $simple_type;
}
/**
* Unit tests for files
*
* @param string $hook unit_test
* @param string $type system
* @param mixed $value Array of tests
*
* @return array
* @access private
*/
function _elgg_filestore_test($hook, $type, $value) {
global $CONFIG;
$value[] = "{$CONFIG->path}engine/tests/ElggCoreFilestoreTest.php";
return $value;
}
/**
* Returns file's download URL
*
* @note This does not work for files with custom filestores.
*
* @param \ElggFile $file File object or entity (must have the default filestore)
* @param bool $use_cookie Limit URL validity to current session only
* @param string $expires URL expiration, as a string suitable for strtotime()
* @return string
*/
function elgg_get_download_url(\ElggFile $file, $use_cookie = true, $expires = '+2 hours') {
$file_svc = new Elgg\FileService\File();
$file_svc->setFile($file);
$file_svc->setExpires($expires);
$file_svc->setDisposition('attachment');
$file_svc->bindSession($use_cookie);
return $file_svc->getURL();
}
/**
* Returns file's URL for inline display
* Suitable for displaying cacheable resources, such as user avatars
*
* @note This does not work for files with custom filestores.
*
* @param \ElggFile $file File object or entity (must have the default filestore)
* @param bool $use_cookie Limit URL validity to current session only
* @param string $expires URL expiration, as a string suitable for strtotime()
* @return string
*/
function elgg_get_inline_url(\ElggFile $file, $use_cookie = false, $expires = '') {
$file_svc = new Elgg\FileService\File();
$file_svc->setFile($file);
if ($expires) {
$file_svc->setExpires($expires);
}
$file_svc->setDisposition('inline');
$file_svc->bindSession($use_cookie);
return $file_svc->getURL();
}
/**
* Returns a URL suitable for embedding entity's icon in a text editor.
* We can not use elgg_get_inline_url() for these purposes due to a URL structure
* bound to user session and file modification time.
* This function returns a generic (permanent) URL that will then be resolved to
* an inline URL whenever requested.
*
* @param \ElggEntity $entity Entity
* @param string $size Size
* @return string
* @since 2.2
*/
function elgg_get_embed_url(\ElggEntity $entity, $size) {
return elgg_normalize_url("serve-icon/$entity->guid/$size");
}
/**
* Handler for /serve-icon resources
* /serve-icon/<entity_guid>/<size>
*
* @return void
* @access private
* @since 2.2
*/
function _elgg_filestore_serve_icon_handler() {
$response = _elgg_services()->iconService->handleServeIconRequest();
$response->send();
exit;
}
/**
* Reset icon URLs if access_id has changed
*
* @param string $event "update:after"
* @param string $type "object"|"group"
* @param ElggObject $entity Entity
* @return void
* @access private
*/
function _elgg_filestore_touch_icons($event, $type, $entity) {
$original_attributes = $entity->getOriginalAttributes();
if (!array_key_exists('access_id', $original_attributes)) {
return;
}
if ($entity instanceof \ElggFile) {
// we touch the file to invalidate any previously generated download URLs
$entity->setModifiedTime();
}
$sizes = array_keys(elgg_get_icon_sizes($entity->getType(), $entity->getSubtype()));
foreach ($sizes as $size) {
$icon = $entity->getIcon($size);
if ($icon->exists()) {
$icon->setModifiedTime();
}
}
}
/**
* Listen to entity ownership changes and update icon ownership by moving
* icons to their new owner's directory on filestore.
*
* This will only transfer icons that have a custom location on filestore
* and are owned by the entity's owner (instead of the entity itself).
* Even though core icon service does not store icons in the entity's owner
* directory, there are plugins that do (e.g. file plugin) - this handler
* helps such plugins avoid ownership mismatch.
*
* @param string $event "update:after"
* @param string $type "object"|"group"
* @param ElggObject $entity Entity
* @return void
* @access private
*/
function _elgg_filestore_move_icons($event, $type, $entity) {
$original_attributes = $entity->getOriginalAttributes();
if (empty($original_attributes['owner_guid'])) {
return;
}
$previous_owner_guid = $original_attributes['owner_guid'];
$new_owner_guid = $entity->owner_guid;
$sizes = elgg_get_icon_sizes($entity->getType(), $entity->getSubtype());
foreach ($sizes as $size => $opts) {
$new_icon = $entity->getIcon($size);
if ($new_icon->owner_guid == $entity->guid) {
// we do not need to update icons that are owned by the entity itself
continue;
}
if ($new_icon->owner_guid != $new_owner_guid) {
// a plugin implements some custom logic
continue;
}
$old_icon = new \ElggIcon();
$old_icon->owner_guid = $previous_owner_guid;
$old_icon->setFilename($new_icon->getFilename());
if (!$old_icon->exists()) {
// there is no icon to move
continue;
}
if ($new_icon->exists()) {
// there is already a new icon
// just removing the old one
$old_icon->delete();
elgg_log("Entity $entity->guid has been transferred to a new owner but an icon was left behind under {$old_icon->getFilenameOnFilestore()}. "
. "Old icon has been deleted", 'NOTICE');
continue;
}
$old_icon->transfer($new_icon->owner_guid, $new_icon->getFilename());
elgg_log("Entity $entity->guid has been transferred to a new owner. "
. "Icon was moved from {$old_icon->getFilenameOnFilestore()} to {$new_icon->getFilenameOnFilestore()}.", 'NOTICE');
}
}
return function(\Elgg\EventsService $events, \Elgg\HooksRegistrationService $hooks) {
$events->registerHandler('boot', 'system', '_elgg_filestore_boot', 100);
$events->registerHandler('init', 'system', '_elgg_filestore_init', 100);
};