ImageManager::_delFile() - Code Metrics - mambax7/xoopseditors - Measure and Improve Code Quality continuously with Scrutinizer

ImageManager::_delFile() A
last analyzed 2022-06-12 05:55 UTC

↳ Parent: ImageManager
Complexity

Conditions	4
Paths	5
Size

Total Lines	17
Code Lines	9
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	4
eloc	9
c	1
b	0
f	0
nc	5
nop	1
dl	0
loc	17
rs	9.9666
<?php
/**
 * ImageManager, list images, directories, and thumbnails.
 * @author  $Author:ray $
 * @version $Id:ImageManager.php 709 2007-01-30 23:22:04Z ray $
 * @package ImageManager
 */

require_once('../ImageManager/Classes/Files.php');

// uncomment to turn on debugging

// _ddtOn();

/**
 * ImageManager Class.
 * @author  $Author:ray $
 * @version $Id:ImageManager.php 709 2007-01-30 23:22:04Z ray $
 */
class ImageManager
{
    /**
     * Configuration array.
     */
    public $config;

    /**
     * Array of directory information.
     */
    public $dirs;

    /**
     * Constructor. Create a new Image Manager instance.
     * @param array $config configuration array, see config.inc.php
     */
    public function __construct($config)
    {
        $this->config = $config;
    }

    /**
     * Get the images base directory.
     * @return string base dir, see config.inc.php
     */
    public function getImagesDir()
    {
        Return $this->config['images_dir'];
    }

    /**
     * Get the images base URL.
     * @return string base url, see config.inc.php
     */
    public function getImagesURL()
    {
        Return $this->config['images_url'];
    }

    public function isValidBase()
    {
        return is_dir($this->getImagesDir());
    }

    /**
     * Get the tmp file prefix.
     * @return string tmp file prefix.
     */
    public function getTmpPrefix()
    {
        Return $this->config['tmp_prefix'];
    }

    /**
     * Get the sub directories in the base dir.
     * Each array element contain
     * the relative path (relative to the base dir) as key and the
     * full path as value.
     * @return array of sub directries
     * <code>array('path name' => 'full directory path', ...)</code>
     */
    public function getDirs()
    {
        if (is_null($this->dirs)) {
            $dirs = $this->_dirs($this->getImagesDir(), '/');
            ksort($dirs);
            $this->dirs = $dirs;
        }
        return $this->dirs;
    }

    /**
     * Recursively travese the directories to get a list
     * of accessable directories.
     * @param string $base the full path to the current directory
     * @param string $path the relative path name
     * @return array of accessiable sub-directories
     *                     <code>array('path name' => 'full directory path', ...)</code>
     */
    public function _dirs($base, $path)
    {
        $base = Files::fixPath($base);
        $base = Files::fixPath($base);
        $dirs = [];

        if (false == $this->isValidBase()) {

            return $dirs;
        }

        $d = @dir($base);

        while (false !== ($entry = $d->read())) {
            //If it is a directory, and it doesn't start with
            // a dot, and if is it not the thumbnail directory
            if (is_dir($base . $entry)
                && '.' != substr($entry, 0, 1)
                && false == $this->isThumbDir($entry)) {

                $relative        = Files::fixPath($path . $entry);
                $fullpath        = Files::fixPath($base . $entry);
                $dirs[$relative] = $fullpath;
                $dirs            = array_merge($dirs, $this->_dirs($fullpath, $relative));
            }
        }
        $d->close();

        Return $dirs;
    }

    /**
     * Get all the files and directories of a relative path.
     * @param string $path    relative path to be base path.
     * @return array of file and path information.
     *                        <code>array(0=>array('relative'=>'fullpath',...), 1=>array('filename'=>fileinfo array(),...)</code>
     *                        fileinfo array: <code>array('url'=>'full url',
     *                        'relative'=>'relative to base',
     *                        'fullpath'=>'full file path',
     *                        'image'=>imageInfo array() false if not image,
     *                        'stat' => filestat)</code>
     */
    public function getFiles($path)
    {
        $files = [];
        $dirs  = [];

        if (false == $this->isValidBase()) {

            return [$files, $dirs];
        }

        $path     = Files::fixPath($path);
        $path     = Files::fixPath($path);
        $base     = Files::fixPath($this->getImagesDir());
        $fullpath = Files::makePath($base, $path);
        $fullpath = Files::makePath($base, $path);

        $d = @dir($fullpath);

        while (false !== ($entry = $d->read())) {
            //not a dot file or directory
            if ('.' != substr($entry, 0, 1)) {
                if (is_dir($fullpath . $entry)
                    && false == $this->isThumbDir($entry)) {

                    $relative        = Files::fixPath($path . $entry);
                    $full            = Files::fixPath($fullpath . $entry);
                    $count           = $this->countFiles($full);
                    $dirs[$relative] = ['fullpath' => $full, 'entry' => $entry, 'count' => $count];
                } elseif (is_file($fullpath . $entry) && false == $this->isThumb($entry) && false == $this->isTmpFile($entry)) {

                    $img = $this->getImageInfo($fullpath . $entry);

                    if (!(!is_array($img) && $this->config['validate_images'])) {
                        $file['url']      = Files::makePath($this->config['base_url'], $path) . $entry;
                        $file['relative'] = $path . $entry;
                        $file['fullpath'] = $fullpath . $entry;
                        $file['image']    = $img;
                        $file['stat']     = stat($fullpath . $entry);
                        $files[$entry]    = $file;
                    }
                }
            }
        }
        $d->close();
        ksort($dirs);
        ksort($files);

        Return [$dirs, $files];
    }

    /**
     * Count the number of files and directories in a given folder
     * minus the thumbnail folders and thumbnails.
     */
    public function countFiles($path)
    {
        $total = 0;

        if (is_dir($path)) {
            $d = @dir($path);

            while (false !== ($entry = $d->read())) {
                //echo $entry."<br>";
                if ('.' != substr($entry, 0, 1)
                    && false == $this->isThumbDir($entry)

                    && false == $this->isTmpFile($entry)

                    && false == $this->isThumb($entry)) {

                    $total++;
                }
            }
            $d->close();
        }
        return $total;
    }

    /**
     * Get image size information.
     * @param string $file the image file
     * @return array of getImageSize information,
     *                     false if the file is not an image.
     */
    public function getImageInfo($file)
    {
        Return @getImageSize($file);

    }

    /**
     * Check if the file contains the thumbnail prefix.
     * @param string $file filename to be checked
     * @return true if the file contains the thumbnail prefix, false otherwise.
     */
    public function isThumb($file)
    {
        $len = strlen($this->config['thumbnail_prefix']);
        if (substr($file, 0, $len) == $this->config['thumbnail_prefix']) {
            Return true;
        } else {
            Return false;

        }
    }

    /**
     * Check if the given directory is a thumbnail directory.
     * @param string $entry directory name
     * @return true if it is a thumbnail directory, false otherwise
     */
    public function isThumbDir($entry)
    {
        if (false == $this->config['thumbnail_dir']
            || 0 == strlen(trim($this->config['thumbnail_dir']))) {
            Return false;

        } else {
            Return ($entry == $this->config['thumbnail_dir']);

        }
    }

    /**
     * Check if the given file is a tmp file.
     * @param string $file file name
     * @return bool true if it is a tmp file, false otherwise
     */
    public function isTmpFile($file)
    {
        $len = strlen($this->config['tmp_prefix']);
        if (substr($file, 0, $len) == $this->config['tmp_prefix']) {
            Return true;
        } else {
            Return false;
        }
    }

    /**
     * For a given image file, get the respective thumbnail filename
     * no file existence check is done.
     * @param string $fullpathfile the full path to the image file
     * @return string of the thumbnail file
     */
    public function getThumbName($fullpathfile)
    {
        $path_parts = pathinfo($fullpathfile);

        $thumbnail = $this->config['thumbnail_prefix'] . $path_parts['basename'];

        if (0 == strlen(trim($this->config['thumbnail_dir'])) || true == $this->config['safe_mode']) {
            Return Files::makeFile($path_parts['dirname'], $thumbnail);
            Return Files::/** @scrutinizer ignore-call */ makeFile($path_parts['dirname'], $thumbnail);
        } else {
            $path = Files::makePath($path_parts['dirname'], $this->config['thumbnail_dir']);
            $path = Files::makePath($path_parts['dirname'], $this->config['thumbnail_dir']);
            if (!is_dir($path)) {
                Files::createFolder($path);
                       createFolder($path);
            }
            Return Files::makeFile($path, $thumbnail);
        }
    }

    /**
     * Similar to getThumbName, but returns the URL, base on the
     * given base_url in config.inc.php
     * @param string $relative the relative image file name,
     *                         relative to the base_dir path
     * @return string the url of the thumbnail
     */
    public function getThumbURL($relative)
    {
        _ddt(__FILE__, __LINE__, "getThumbURL(): relative is '$relative'");

        $path_parts = pathinfo($relative);
        $thumbnail  = $this->config['thumbnail_prefix'] . $path_parts['basename'];
        if ('\\' == $path_parts['dirname']) {
            $path_parts['dirname'] = '/';
        }

        if (true == $this->config['safe_mode']
            || 0 == strlen(trim($this->config['thumbnail_dir']))) {
            Return Files::makeFile($this->getImagesURL(), rawurlencode($thumbnail));
            Return Files::/** @scrutinizer ignore-call */ makeFile($this->getImagesURL(), rawurlencode($thumbnail));
        } else {
            if (strlen(trim($this->config['thumbnail_dir'])) > 0) {
                $path     = Files::makePath($path_parts['dirname'], $this->config['thumbnail_dir']);
                $path     = Files::makePath($path_parts['dirname'], $this->config['thumbnail_dir']);
                $url_path = Files::makePath($this->getImagesURL(), $path);

                _ddt(__FILE__, __LINE__, "getThumbURL(): url_path is '$url_path'");

                Return Files::makeFile($url_path, rawurlencode($thumbnail));
            } else //should this ever happen?
            {
                //error_log('ImageManager: Error in creating thumbnail url');
            }
        }
    }

    /**
     * For a given image file, get the respective resized filename
     * no file existence check is done.
     * @param string $fullpathfile the full path to the image file
     * @param int    $width        the intended width
     * @param int    $height       the intended height
     * @param bool   $mkDir        whether to attempt to make the resized_dir if it doesn't exist
     * @return string of the resized filename
     */
    public function getResizedName($fullpathfile, $width, $height, $mkDir = true)
    {
        $path_parts = pathinfo($fullpathfile);

        $thumbnail = $this->config['resized_prefix'] . "_{$width}x{$height}_{$path_parts['basename']}";

        if (0 == strlen(trim($this->config['resized_dir'])) || true == $this->config['safe_mode']) {
            Return Files::makeFile($path_parts['dirname'], $thumbnail);
            Return Files::/** @scrutinizer ignore-call */ makeFile($path_parts['dirname'], $thumbnail);
        } else {
            $path = Files::makePath($path_parts['dirname'], $this->config['resized_dir']);
            $path = Files::makePath($path_parts['dirname'], $this->config['resized_dir']);
            if ($mkDir && !is_dir($path)) {
                Files::createFolder($path);
                       createFolder($path);
            }
            Return Files::makeFile($path, $thumbnail);
        }
    }

    /**
     * Check if the given path is part of the subdirectories
     * under the base_dir.
     * @param string $path the relative path to be checked
     * @return bool true if the path exists, false otherwise
     */
    public function validRelativePath($path)
    {
        $dirs = $this->getDirs();
        if ('/' == $path) {
            Return true;
        }
        //check the path given in the url against the
        //list of paths in the system.
        for ($i = 0; $i < count($dirs); $i++) {
for ($i=0; $i<count($array); $i++) { // calls count() on each iteration
}

// Better
for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once
}
            $key = key($dirs);
            //we found the path
            if ($key == $path) {
                Return true;
            }

            next($dirs);
        }
        Return false;
    }

    /**
     * Process uploaded files, assumes the file is in
     * $_FILES['upload'] and $_POST['dir'] is set.
     * The dir must be relative to the base_dir and exists.
     * If 'validate_images' is set to true, only file with
     * image dimensions will be accepted.
     * @return null
     */
    public function processUploads()
    {
        if (false == $this->isValidBase()) {

            return;
        }

        $relative = null;


        if (isset($_POST['dir'])) {
            $relative = rawurldecode($_POST['dir']);
        } else {
            return;
        }

        //check for the file, and must have valid relative path
        if (isset($_FILES['upload']) && $this->validRelativePath($relative)) {
            $this->_processFiles($relative, $_FILES['upload']);
        }
    }

    /**
     * Process upload files. The file must be an
     * uploaded file. If 'validate_images' is set to
     * true, only images will be processed. Any duplicate
     * file will be renamed. See Files::copyFile for details
     * on renaming.
     * @param string $relative the relative path where the file
     *                         should be copied to.
     * @param array  $file     the uploaded file from $_FILES
     * @return bool true if the file was processed successfully,
     *                         false otherwise
     */
    public function _processFiles($relative, $file)
    {
        if (0 != $file['error']) {
            Return false;
        }

        if (!is_file($file['tmp_name'])) {
            Return false;
        }

        if (!is_uploaded_file($file['tmp_name'])) {
            Files::delFile($file['tmp_name']);
                   delFile($file['tmp_name']);
            Return false;
        }

        if (true == $this->config['validate_images']) {
            $imgInfo = @getImageSize($file['tmp_name']);
            if (!is_array($imgInfo)) {
                Files::delFile($file['tmp_name']);
                Return false;
            }
        }

        $valid_extensions = $this->config['allowed_image_extensions'];
        $afruext          = strtolower(substr(strrchr($file['name'], '.'), 1));
        if (!in_array($afruext, $valid_extensions)) {
            Files::delFile($file['tmp_name']);
            Return 'Cannot upload $extension=' . $afruext . '$ Files. Permission denied.';

        }

        //now copy the file
        $path   = Files::makePath($this->getImagesDir(), $relative);
        $path   = Files::makePath($this->getImagesDir(), $relative);
        $result = Files::copyFile($file['tmp_name'], $path, $file['name']);
        $result = Files::copyFile($file['tmp_name'], $path, $file['name']);

        //no copy error
        if (!is_int($result)) {

            Files::delFile($file['tmp_name']);
            Return true;
        }

        //delete tmp files.
        Files::delFile($file['tmp_name']);
        Return false;
    }

    /**
     * Get the URL of the relative file.
     * basically appends the relative file to the
     * base_url given in config.inc.php
     * @param string $relative a file the relative to the base_dir
     * @return string the URL of the relative file.
     */
    public function getFileURL($relative)
    {
        Return Files::makeFile($this->getImagesURL(), $relative);
        Return Files::/** @scrutinizer ignore-call */ makeFile($this->getImagesURL(), $relative);
    }

    /**
     * Get the fullpath to a relative file.
     * @param string $relative the relative file.
     * @return string the full path, .ie. the base_dir + relative.
     */
    public function getFullPath($relative)
    {
        Return Files::makeFile($this->getImagesDir(), $relative);;
        Return Files::/** @scrutinizer ignore-call */ makeFile($this->getImagesDir(), $relative);;
    }

    /**
     * Get the default thumbnail.
     * @return string default thumbnail, empty string if
     * the thumbnail doesn't exist.
     */
    public function getDefaultThumb()
    {
        // FIXME: hack

        Return $this->config['default_thumbnail'];

        if (is_file($this->config['default_thumbnail'])) {
function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}
            Return $this->config['default_thumbnail'];
        } else {
            Return '';
        }
    }

    /**
     * Get the thumbnail url to be displayed.
     * If the thumbnail exists, and it is up-to-date
     * the thumbnail url will be returns. If the
     * file is not an image, a default image will be returned.
     * If it is an image file, and no thumbnail exists or
     * the thumbnail is out-of-date (i.e. the thumbnail
     * modified time is less than the original file)
     * then a thumbs.php?img=filename.jpg is returned.
     * The thumbs.php url will generate a new thumbnail
     * on the fly. If the image is less than the dimensions
     * of the thumbnails, the image will be display instead.
     * @param string $relative the relative image file.
     * @return string the url of the thumbnail, be it
     *                         actually thumbnail or a script to generate the
     *                         thumbnail on the fly.
     */
    public function getThumbnail($relative)
    {
        global $IMConfig;

        _ddt(__FILE__, __LINE__, "getThumbnail(): top with '$relative'");

        $fullpath = Files::makeFile($this->getImagesDir(), $relative);
        $fullpath = Files::makeFile($this->getImagesDir(), $relative);

        //not a file???
        if (!is_file($fullpath)) {
            Return $this->getDefaultThumb();
        }

        $imgInfo = @getImageSize($fullpath);

        //not an image
        if (!is_array($imgInfo)) {
            Return $this->getDefaultThumb();
        }

        //the original image is smaller than thumbnails,
        //so just return the url to the original image.
        if ($imgInfo[0] <= $this->config['thumbnail_width']
            && $imgInfo[1] <= $this->config['thumbnail_height']) {
            Return $this->getFileURL($relative);
        }

        $thumbnail = $this->getThumbName($fullpath);

        //check for thumbnails, if exists and
        // it is up-to-date, return the thumbnail url
        if (is_file($thumbnail)) {
            if (filemtime($thumbnail) >= filemtime($fullpath)) {
                _ddt(__FILE__, __LINE__, "getThumbnail(): returning url '" . $this->getThumbURL($relative) . "'");

                Return $this->getThumbURL($relative);
            }
        }

        //well, no thumbnail was found, so ask the thumbs.php
        //to generate the thumbnail on the fly.
        Return $IMConfig['backend_url'] . '__function=thumbs&img=' . rawurlencode($relative);
    }

    /**
     * Delete and specified files.
     * @return bool true if delete, false otherwise
     */
    public function deleteFiles()
    {
        if (isset($_GET['delf'])) {
            $this->_delFile(rawurldecode($_GET['delf']));
        }
    }

    /**
     * Delete and specified directories.
     * @return bool true if delete, false otherwise
     */
    public function deleteDirs()
    {
        if (isset($_GET['deld'])) {
            return $this->_delDir(rawurldecode($_GET['deld']));
        } else {
            Return false;
        }
    }

    /**
     * Delete the relative file, and any thumbnails.
     * @param string $relative the relative file.
     * @return bool true if deleted, false otherwise.
     */
    public function _delFile($relative)
    {
        $fullpath = Files::makeFile($this->getImagesDir(), $relative);
        $fullpath = Files::makeFile($this->getImagesDir(), $relative);

        //check that the file is an image
        if (true == $this->config['validate_images']) {
            if (!is_array($this->getImageInfo($fullpath))) {

                return false;
            } //hmmm not an Image!!???
        }

        $thumbnail = $this->getThumbName($fullpath);

        if (Files::delFile($fullpath)) {
        if (Files::/** @scrutinizer ignore-call */ delFile($fullpath)) {
            Return Files::delFile($thumbnail);
        } else {
            Return false;
        }
    }

    /**
     * Delete directories recursively.
     * @param string $relative the relative path to be deleted.
     * @return bool true if deleted, false otherwise.
     */
    public function _delDir($relative)
    {
        $fullpath = Files::makePath($this->getImagesDir(), $relative);
        $fullpath = Files::makePath($this->getImagesDir(), $relative);
        if ($this->countFiles($fullpath) <= 0) {
            return Files::delFolder($fullpath, true);
            return Files::/** @scrutinizer ignore-call */ delFolder($fullpath, true);
        } //delete recursively.
        else {
            Return false;
        }
    }

    /**
     * Create new directories.
     * If in safe_mode, nothing happens.
     * @return bool true if created, false otherwise.
     */
    public function processNewDir()
    {
        if (true == $this->config['safe_mode']) {
            Return false;
        }

        if (isset($_GET['newDir']) && isset($_GET['dir'])) {
            $newDir   = rawurldecode($_GET['newDir']);
            $dir      = rawurldecode($_GET['dir']);
            $path     = Files::makePath($this->getImagesDir(), $dir);
            $path     = Files::makePath($this->getImagesDir(), $dir);
            $fullpath = Files::makePath($path, Files::escape($newDir));
            $fullpath = Files::makePath($path, Files::/** @scrutinizer ignore-call */ escape($newDir));
            if (is_dir($fullpath)) {
                Return false;
            }

            Return Files::createFolder($fullpath);
            Return Files::/** @scrutinizer ignore-call */ createFolder($fullpath);
        }
    }
}



mambax7 / xoopseditors

ImageManager::_delFile() A last analyzed 2022-06-12 05:55 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

ImageManager::_delFile() A
last analyzed 2022-06-12 05:55 UTC
