filestore.php

Go to the documentation of this file.

<?php
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);
}

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());
}

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

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;
}

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;
}

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();
}

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

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


$DEFAULT_FILE_STORE = null;

function get_default_filestore() {
    elgg_deprecated_notice(__FUNCTION__ . ' is deprecated.', '2.1');

    return $GLOBALS['DEFAULT_FILE_STORE'];
}

function set_default_filestore(\ElggFilestore $filestore) {
    elgg_deprecated_notice(__FUNCTION__ . ' is deprecated.', '2.1');

    $GLOBALS['DEFAULT_FILE_STORE'] = $filestore;
    return true;
}

function elgg_get_file_simple_type($mime_type) {
    $params = array('mime_type' => $mime_type);
    return elgg_trigger_plugin_hook('simple_type', 'file', $params, 'general');
}

function _elgg_filestore_boot() {
    global $CONFIG;

    // Now register a default filestore
    if (isset($CONFIG->dataroot)) {
        $GLOBALS['DEFAULT_FILE_STORE'] = new \ElggDiskFilestore($CONFIG->dataroot);
    }
}

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');
}

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

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;
}

function _elgg_filestore_test($hook, $type, $value) {
    global $CONFIG;
    $value[] = "{$CONFIG->path}engine/tests/ElggCoreFilestoreTest.php";
    return $value;
}


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();
}

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();
}

function elgg_get_embed_url(\ElggEntity $entity, $size) {
    return elgg_normalize_url("serve-icon/$entity->guid/$size");
}

function _elgg_filestore_serve_icon_handler() {
    $response = _elgg_services()->iconService->handleServeIconRequest();
    $response->send();
    exit;
}

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();
        }
    }
}

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