<?php
##################################################
#
# Copyright (c) 2004-2022 OIC Group, Inc.
#
# This file is part of Exponent
#
# Exponent is free software; you can redistribute
# it and/or modify it under the terms of the GNU
# General Public License as published by the Free
# Software Foundation; either version 2 of the
# License, or (at your option) any later version.
#
# GPL: http://www.gnu.org/licenses/gpl.txt
#
##################################################

/** @define "BASE" "../../../.." */
/**
 * Class to handle files at the File System Level and updating
 * the record for each file.
 *
 * expFile is an extension of expRecord because File information is stored
 * in the database for future access and retrieval. This class also handles
 * and and all File System handling as well: copy, move, delete, upload,
 * and importing of data in preparation of data importation. Upload and
 * import via child classes.
 *
 * @subpackage Models
 * @package    Modules
 *
 */
class expFile extends expRecord {

// ==========================================================
// Class Constants

    /*
     * The definition of this constant lets other parts of the subsystem know
     * that the Image Subsystem has been included for use.
     */
    const SYS_IMAGE = 1;
    const IMAGE_ERR_NOGD = '';
    const IMAGE_ERR_NOTSUPPORTED = '_unknown';
    const IMAGE_ERR_FILENOTFOUND = '_notfound';
    const IMAGE_ERR_PERMISSIONDENIED = '_denied';

// ===========================================================
// File Access Control Values

    /**
     * Mode to use for reading from files
     *
     * @constant string FILE_MODE_READ
     *
     * @access private
     * @PHPUnit Not Defined
     *
     */
    const FILE_MODE_READ = 'rb';

    /**
     * Mode to use for truncating files, then writing
     *
     * @constant string FILE_MODE_WRITE
     *
     * @access private
     * @PHPUnit Not Defined
     *
     */
    const FILE_MODE_WRITE = 'wb';

    /**
     * Mode to use for appending to files
     *
     * @constant string FILE_MODE_APPEND
     *
     * @access private
     * @PHPUnit Not Defined
     *
     */
    const FILE_MODE_APPEND = 'ab';

    /**
     * Use this when a shared (read) lock is required.
     * This is a "relabel" of the PHP 'LOCK_SH' constant
     *
     * @constant string FILE_LOCK_SHARED
     *
     * @access private
     * @PHPUnit Not Defined
     *
     */
    const FILE_LOCK_SHARED = LOCK_SH;

    /**
     * Use this when an exclusive (write) lock is required
     * This is a "relabel" of the PHP 'LOCK_EX' constant
     *
     * @constant string FILE_LOCK_EXCLUSIVE
     *
     * @access private
     * @PHPUnit Not Defined
     *
     */
    const FILE_LOCK_EXCLUSIVE = LOCK_EX;

    // ==========================================================
    // Class Properties and their default values

    /**
     * Database Table Name to store File info
     *
     * @public
     * @property string $table   Database Table Name
     *
     */
    public $table = 'expFiles';
    protected $attachable_table = 'content_expFiles';

    protected $attachable_item_types = array(
        'content_expCats' => 'expCat',
//        'content_expComments'=>'expComment',
//        'content_expDefinableFields' => 'expDefinableField',
//        'content_expFiles'           => 'expFile',
//        'content_expRatings'=>'expRating',
//        'content_expSimpleNote'=>'expSimpleNote',
//        'content_expTags'=>'expTag',
    );

    /**
     * Relative OS System File path to where $filename is [to be] located
     *
     * @protected
     * @property string $directory  Relative OS System File path
     *
     */
    public $directory = null;

    /**
     * File Name of File to process
     *
     * @public
     * @property string $filename  Name of File to process
     *
     */
    public $filename = null;

    /**
     * Size of File, in Bytes
     *
     * @protected
     * @property string $filesize   Size of File, in Bytes.
     *
     */
    public $filesize = null;

    /**
     * Mime Type of File.
     *
     * @public
     * @property string $mimetype   File MIME Type
     *
     */
    public $mimetype = null;

    /**
     * Image width in pixels.
     *
     * @public
     * @property string $image_width   Image width in pixels
     *
     */
    public $image_width = null;

    /**
     * Image height in pixels.
     *
     * @public
     * @property string $image_height   Image height in pixels
     *
     */
    public $image_height = null;

    /**
     * Is this file an image.
    # Defaults to FALSE
     *
     * @public
     * @property string $is_image   Is this file an image
     *
     */
    public $is_image = false;

    /**
     * Determines if this file can be overwritten.
     * Also if it can be "moved" or "renamed" over
     * Default set to FALSE, no it can't
     *
     * @protected boolean
     * @property boolean $fileOverWrite Determines if this file be overwritten
     *
     * @access protected
     * @since 1.1
     */
    protected $fileOverWrite = false;

    /**
     * Web based Path for current File
     *
     * @public
     * @property string $url   Web based Path
     *
     */
    public $url = null;

    /**
     * Full File System Path for current File. Also used to in FILE Record
     *
     * @public
     * @property string $path   Full File System Path
     *
     */
    public $path = null;

    /**
     * Relative File System Path for current File
     *
     * @public
     * @property string $path_relative   Relative File System Path
     *
     */
    public $path_relative = null;

// ==========================================================
// Class Methods

    /**
     * Class constructor to create a File Class either from a database
     * record or from the File System.
     *
     * Class will either: a) load an existing File Record
     *                    b) modify an existing File Record
     *                    c) create a new File Record
     *
     * This will also handle any File System handling that is needed: copy,
     * move, create, delete, read and write.
     *
     * @access public
     *
     * @uses expRecord::__construct
     *
     * @PHPUnit Not Defined
     *
     * @param mixed $params - If an INT is given, this assumes that it needs to
     *                         load an existing File Record.
     *                       - If an ARRAY is given, this assumes that the elements
     *                         of the array are values to the File table that need
     *                         to be modified or other processing.
     *                       - If NULL is given, an empty File Object is created
     *
     * @param bool $get_assoc
     * @param bool $get_attached
     * @throws ReflectionException
     */
    public function __construct($params = array(), $get_assoc = false, $get_attached = true) {
        // Set 'directory' as the default FILE location
        // This will be redefined if a FILE record is loaded
        // or a path is given to the Class
        //eDebug($params,true);
        if (empty($params['directory']))
            $this->directory = UPLOAD_DIRECTORY_RELATIVE;
        // This will pull properties for class properties based upon
        // expRecord table definition
        parent::__construct($params, $get_assoc, $get_attached);

        // If the 'directory' is the same as the default path then a given,
        // or derived, filename can be added to pathing settings
        //if ( $this->directory == UPLOAD_DIRECTORY_RELATIVE ) {
        if (stripos($this->directory, BASE) === false) {
            // Place url
            $this->url = URL_FULL . $this->directory . $this->filename;

            // Place system level OS root
            $this->path = BASE . $this->directory . $this->filename;

            // Place web server relative path
            $this->path_relative = PATH_RELATIVE . $this->directory . $this->filename;
        } else {
            // Otherwise, the URL is not set since we can't use it, nether is
            // RELATIVE, as 'directory' must be an absolute path in this instance
            // Place system level OS root
            $relpath = str_replace(BASE, '', $this->directory);
            $this->path = $this->directory . $this->filename;
            $this->url = URL_FULL . $relpath . $this->filename;
            $this->path_relative = $relpath . $this->filename;
        }

        // If a file location was given, not derived from the database,
        // basic file information is needed
        if (empty($this->id) && !empty($this->filename)) {
            // File info
            $_fileInfo = self::getImageInfo($this->path);
            // Assign info back to class
            $this->is_image = !empty($_fileInfo['is_image']) ? $_fileInfo['is_image'] : false;
            $this->filesize = !empty($_fileInfo['fileSize']) ? $_fileInfo['fileSize'] : 0;
            if (!empty($_fileInfo['mime'])) $this->mimetype = $_fileInfo['mime'];
            if (!empty($_fileInfo['is_image'])) {
                $this->image_width = $_fileInfo[0];
                $this->image_height = $_fileInfo[1];
            }
        }
    }

    public function exists() {
        return (!empty($this->id) && is_file(BASE . PATH_RELATIVE . $this->directory . $this->filename));
    }

    public function beforeSave() {
        // Add/update posted/accessed time.
        if (empty($this->posted))
            $this->posted = time();
        $this->last_accessed = time();

        // reassess image file info in case it was changed externally (resized?)
        $_fileInfo = self::getImageInfo($this->path);
        // Assign info back to class
        $this->is_image = !empty($_fileInfo['is_image']) ? $_fileInfo['is_image'] : false;
        $this->filesize = !empty($_fileInfo['fileSize']) ? $_fileInfo['fileSize'] : 0;
        if (!empty($_fileInfo['mime'])) $this->mimetype = $_fileInfo['mime'];
        if (!empty($_fileInfo['is_image'])) {
            $this->image_width = $_fileInfo[0];
            $this->image_height = $_fileInfo[1];
        }
    }

    public function afterDelete() {
        global $db;

	    // get and delete all attachments to this file
	    $db->delete('content_expFiles','expfiles_id='.$this->id);
    }

    function copyToDirectory($destination) {
        //eDebug($this,true);
        copy($this->path, $destination . $this->filename);
    }

// =========================================================================
// Static Methods

    /**
     * Return expFile object for given path
     *   either an existing or a new expFile
     *   prevents duplication of existing expFile objects
     *
     * @param $path
     * @return array|expFile|int
     */
    public static function make_expFile($path) {
        $efile = new expFile();
        $path = str_replace(array(BASE, '\\'), array('', '/'), $path);
        $thefile = $efile->find('first','directory=\'' . dirname($path) . '/' . '\' AND filename=\'' . basename($path) . '\'');
        if (empty($thefile->id)) {
            $newfile = new expFile(array('directory' => dirname($path) . '/', 'filename' => basename($path)));
            @$newfile->save(false);
            return $newfile;
        } else {
            return $thefile;
        }
    }

    public static function selectAllFiles() {
        global $db;

        return $db->selectObjects('expFiles',1);
    }

    /**
     * File ($_POST) UPLOAD that also optionally inserts File info into database.
     *
     * File UPLOAD is a straight forward uploader and processor. It can accept
     * filename and destination directory overrides as well. It has an additional
     * pair of flags that allow for an upload NOT to be inserted into the database
     * (default to INSERT) and if it previous file, with the same name, should be
     * overwritten (default to NO overwrite)
     *
     * @static
     * @access public
     *
     * @param string $_postName The name of the _FILE upload array
     * @param bool|string $_force Force the uploaded to overwrite existing file of same name
     * @param bool|string $_save Save file info to database, defaults to TRUE
     * @param string $_destFile Override the uploaded file name
     * @param string $_destDir Override the default FILE UPLOAD location
     * @param null $_max_width
     *
     * @return object|string $_objFile expFile Object
     *                   or  $errMsg Error message if something failed
     *
     * @TODO Have file upload overwrite make sure not to duplicate its record in the DB
     * @throws ReflectionException
     */
    public static function fileUpload($_postName = null,
                                      $_force = false,
                                      $_save = true,
                                      $_destFile = null,
                                      $_destDir = null,
                                      $_max_width = null
    ) {

        // Make sure something was sent first off...
        if ((!isset($_SERVER['CONTENT_TYPE'])) ||
            (strpos($_SERVER['CONTENT_TYPE'], 'multipart/form-data') !== 0)
        ) {
            return 'bad upload form';
        }

        //check for errors
        switch ($_FILES[$_postName]['error']) {
            case UPLOAD_ERR_OK:
                // Everything looks good.  Continue with the update.
                break;
            case UPLOAD_ERR_INI_SIZE:
//			case images:
                // This is a tricky one to catch.  If the file is too large for
                // POST, then the script won't even run.
                // But if its between post_max_size and upload_max_filesize,
                // we will get here.
                return 'file_too_large';
            case UPLOAD_ERR_FORM_SIZE:
                return 'file_exceeds_form_MAX_FILE_SIZE';
            case UPLOAD_ERR_PARTIAL:
                return 'partial_file';
            case UPLOAD_ERR_NO_FILE:
                return 'no_file_uploaded';
            case UPLOAD_ERR_NO_TMP_DIR:
                return 'missing_tmp_folder';
            case UPLOAD_ERR_CANT_WRITE:
                return 'failed_write_to_disk';
            case UPLOAD_ERR_EXTENSION:
                return 'upload_stopped_by_extension';
            default:
                return 'unknown';
                break;
        }

        // If $_destDir is not defined, use the default Files directory
//        $_destDir = ( $_destDir == null ) ? UPLOAD_DIRECTORY : $_destDir;
        $_destDir = ($_destDir == null) ? UPLOAD_DIRECTORY_RELATIVE : $_destDir;

        // If $_destFile is defined, use that name as an override for the
        // uploaded file name
        $_destFile = ($_destFile == null) ? self::fixName($_FILES[$_postName]['name']) : $_destFile;

        // Fix the filename, so that we don't have funky characters screwing
        // with our attempt to create the destination file.
        // $_destFile = self::fixFileName( $_FILES[$_postName]['name']);
        // eDebug($_destFile,1);

        // Build destination fille path for future use
        $_destFullPath = BASE . $_destDir . $_destFile;

        //if the file exists and we don't want to overwrite it, create a new one
        if (file_exists($_destFullPath) && $_force == false) {
            $_destFile = self::resolveDuplicateFilename($_destFullPath);
//            $_destFullPath = BASE . $_destDir . $_destFile;
        }

        //Check to see if the directory exists.  If not, create the directory structure.
        // if (!file_exists(BASE . $_destDir)) {
        //  self::makeDirectory(BASE . $_destDir);
        // }

        // Move the temporary uploaded file into the destination directory,
        // and change the name.
        $resized = false;
        $maxwidth = (int)($_max_width);
        require_once(BASE . 'external/class.upload/class.upload.php');
        $handle = new \Verot\Upload\Upload($_FILES[$_postName]);
        $handle->file_new_name_body = pathinfo($_destFile, PATHINFO_FILENAME);
//        $handle->file_new_name_ext = '';
        $handle->dir_chmod = octdec(DIR_DEFAULT_MODE_STR + 0);
        $handle->forbidden = array('application/x-shockwave-flash');
        $handle->mime_types += array(
            'php4' => 'text/html',
            'php5' => 'text/html',
            'php7' => 'text/html',
            'php2' => 'text/html'
        );
        $handle->image_auto_rotate = false;  // don't auto-rotate jpeg images based on EXIF data
        if (!empty($maxwidth) && $handle->uploaded) {
            $handle->image_resize = true;
            $handle->image_x = $maxwidth;
            $handle->image_y = $maxwidth;
            $handle->image_ratio_no_zoom_in = true;  //fixme class.upload >0.33 image_no_enlarging
            $handle->jpeg_quality = THUMB_QUALITY;
        }
        $handle->process(BASE . $_destDir);
        if ($handle->processed && $handle->image_src_x != $handle->image_dst_x) {
            $resized = true;
        }
        $handle->clean();
        if (DEVELOPMENT && UPLOAD_LOGGER) {
            eLog($handle->log, gt('CLASS.UPLOAD'), BASE . 'tmp/upload.htm');
        }

        if (file_exists($handle->file_dst_pathname)) {
            $__oldumask = umask(0);
            chmod($handle->file_dst_pathname, octdec(FILE_DEFAULT_MODE_STR + 0));
            umask($__oldumask);
            // Checking
            if ($__oldumask != umask()) {
                flash('error', gt('An error occurred while setting file permissions') . ': ' . $handle->file_dst_pathname);
            }
        } else {
            return 'could not move';
        }

        // At this point, we are good to go.

        // Create a new expFile Object for further processing
        $_fileParams = array('filename' => $handle->file_dst_name, 'directory' => $_destDir);
        $_objFile = new expFile ($_fileParams);

        // Insert new File Record
        if ($_save === true) {
            $_objFile->save();
        }
        if ($resized) $_objFile->resized = true;
        return $_objFile;
    }

    /**
     * XHR (HTML5) File UPLOAD that also inserts File info into database.
     *
     * File UPLOAD is a straight forward uploader and processor. It can accept
     * filename and destination directory overrides as well. It has an additional
     * pair of flags that allow for an upload NOT to be inserted into the database
     * (default to INSERT) and if it previous file, with the same name, should be
     * overwritten (default to NO overwrite)
     *
     * @static
     * @access public
     *
     * @param null $fileName
     * @param bool|string $_force Force the uploaded to overwrite existing file of same name
     * @param bool|string $_save Save file info to database, defaults to TRUE
     * @param string $_destFile Override the uploaded file name
     * @param string $_destDir Override the default FILE UPLOAD location
     *
     * @param null $_max_width
     *
     * @return object|string $_objFile expFile Object
     *                   or  $errMsg   Error message if something failed
     *
     * @throws ReflectionException
     *
     * @TODO Have file upload overwrite make sure not to duplicate its record in the DB
     * @uses     class|method|global|variable description
     * @requires class_name
     *
     * @PHPUnit Not Defined|Implement|Completed
     *
     */
    public static function fileXHRUpload($fileName = null,
                                         $_force = false,
                                         $_save = true,
                                         $_destFile = null,
                                         $_destDir = null,
                                         $_max_width = null
    ) {

        // If $_destDir is not defined, use the default Files directory
        $_destDir = ($_destDir == null) ? UPLOAD_DIRECTORY_RELATIVE : $_destDir;

        // If $_destFile is defined, use that name as an override for the
        // uploaded file name
        $_destFile = ($_destFile == null) ? self::fixName($fileName) : $_destFile;

        // Fix the filename, so that we don't have funky characters screwing
        // with our attempt to create the destination file.
        // $_destFile = self::fixFileName( $_FILES[$_postName]['name']);
        // eDebug($_destFile,1);

        // Build destination fille path for future use
        $_destFullPath = BASE . $_destDir . $_destFile;

        //if the file exists and we don't want to overwrite it, create a new one
        if (file_exists($_destFullPath) && $_force == false) {
            $_destFile = self::resolveDuplicateFilename($_destFullPath);
//            $_destFullPath = BASE . $_destDir . $_destFile;
        }

        //Check to see if the directory exists.  If not, create the directory structure.
        // if (!file_exists(BASE . $_destDir)) {
        //  self::makeDirectory(BASE . $_destDir);
        // }

        // Move the temporary uploaded file into the destination directory,
        // and change the name.
        $resized = false;
        $maxwidth = (int)($_max_width);
        require_once(BASE . 'external/class.upload/class.upload.php');
        $handle = new \Verot\Upload\Upload('php:' . $fileName);
        $handle->file_new_name_body = pathinfo($_destFile, PATHINFO_FILENAME);
//        $handle->file_new_name_ext = '';
        $handle->dir_chmod = octdec(DIR_DEFAULT_MODE_STR + 0);
        $handle->forbidden = array('application/x-shockwave-flash');
        $handle->mime_types += array(
            'php4' => 'text/html',
            'php5' => 'text/html',
            'php7' => 'text/html',
            'php2' => 'text/html'
        );
        $handle->image_auto_rotate = false;  // don't auto-rotate jpeg images based on EXIF data
        if (!empty($maxwidth) && $handle->uploaded) {
            $handle->image_resize = true;
            $handle->image_x = $maxwidth;
            $handle->image_y = $maxwidth;
            $handle->image_ratio_no_zoom_in = true;  //fixme class.upload >0.33 image_no_enlarging
            $handle->jpeg_quality = THUMB_QUALITY;
        }
        $handle->process(BASE . $_destDir);
        if ($handle->processed && $handle->image_src_x != $handle->image_dst_x) {
            $resized = true;
        }
        $handle->clean();
        if (DEVELOPMENT && UPLOAD_LOGGER) {
            eLog($handle->log, gt('CLASS.UPLOAD'), BASE . 'tmp/upload.htm');
        }

        if (file_exists($handle->file_dst_pathname)) {
            $__oldumask = umask(0);
            chmod($handle->file_dst_pathname, octdec(FILE_DEFAULT_MODE_STR + 0));
            umask($__oldumask);
            // Checking
            if ($__oldumask != umask()) {
                flash('error', gt('An error occurred while setting file permissions') . ': ' . $handle->file_dst_pathname);
            }
        } else {
            return 'could not move';
        }

        // At this point, we are good to go.

        // Create a new expFile Object for further processing
        $_fileParams = array('filename' => $handle->file_dst_name, 'directory' => $_destDir);
        $_objFile = new expFile ($_fileParams);

        // Insert new File Record
        if ($_save === true) {
            $_objFile->save();
        }
        if ($resized) $_objFile->resized = true;
        return $_objFile;
    }

    /**
     * Performs a system level check on the file and retrieves its size
     *
     * @static
     * @access public
     *
     * @uses function filesize()    Built-in PHP method
     *
     * @PHPUnit Not Defined|Implement|Completed
     *
     * @param bool|string $_path Full path to file to pull info from
     *
     * @return int $_fileSize    Size of file in bytes
     * @throws void
     *
     */
    public static function fileSize($_path = false) {
        if ($_path)
            $_fileSize = filesize($_path);
        else
            $_fileSize = 0;

        return $_fileSize;
    }

    /**
     * check for duplicate files and returns a file name that's not already in the system
     *
     * @static
     * @access public
     *
     * @uses function filesize()    Built-in PHP method
     *
     * @PHPUnit Not Defined|Implement|Completed
     *
     * @param string $filepath    direct path of the file to check against
     *
     * @return string $newFileName   Name of the file that isn't a duplicate
     * @throws void
     *
     */
    public static function resolveDuplicateFilename($filepath) {
        $extension = strrchr($filepath, "."); // grab the file extention by looking for the last dot in the string
        $filnameWoExt = str_replace(array("/", $extension), "", strrchr($filepath, "/")); // filename sans extention
        $pathToFile = str_replace($filnameWoExt . $extension, "", $filepath); // path sans filename

        $i = "";
        $inc = "";
        while (file_exists($pathToFile . $filnameWoExt . $inc . $extension)) {
            $i++;
            $inc = "-" . $i;
        }

        //we'll just return the new filename assuming we've
        //already got the path we want on the other side
        return $filnameWoExt . $inc . $extension;
    }

    /**
     * prompts the user to download a file
     *
     * @static
     * @access public
     *
     * @param \expFile|string $file Full path to file to download
     *
     * @return bool
     * @uses function download()    Built-in PHP method
     *
     * @PHPUnit Not Defined|Implement|Completed
     *
     * @throws ReflectionException
     */
    public static function download($file) {
        // we are expecting an int val as a file ID or the whole file object.
        // If all we get is the ID then we'll instantiate a new file object.
        // If that object doesn't have it's id property set or the file doesn't
        // actually exist then we can assume its not a valid file object and
        // return false.
        if (!is_object($file)) $file = new expFile($file);
        //if (empty($file->id) || !file_exists($file->path)) return false;
        if (!file_exists($file->path)) {
            flash('error', gt('The file is unavailable for Download'));
            expHistory::back();
            return false;
        }

        // NO buffering from here on out or things break unexpectedly. - RAM
        ob_end_clean();

        // This code was lifted from phpMyAdmin, but this is Open Source, right?
        // 'application/octet-stream' is the registered IANA type but
        // MSIE and Opera seems to prefer 'application/octetstream'
        // It seems that other headers I've added make IE prefer octet-stream again. - RAM

        $mimetype = (EXPONENT_USER_BROWSER === 'IE' || EXPONENT_USER_BROWSER === 'OPERA') ? 'application/octet-stream;' : $file->mimetype;

        header('Content-Type: ' . $mimetype);
        header('Expires: ' . gmdate('D, d M Y H:i:s') . ' GMT');
        header('Content-Transfer-Encoding: binary');
//		header('Content-Encoding:');
        header('Content-Disposition: attachment; filename="' . $file->filename . '";');
        $filesize = filesize($file->path);
        if ($filesize) header("Content-length: " . $filesize); // for some reason the webserver cant run stat on the files and this breaks.
        // IE need specific headers
        if (EXPONENT_USER_BROWSER === 'IE') {
            header('Cache-Control: must-revalidate, post-check=0, pre-check=0');
            header('Pragma: public');
            header('Vary: User-Agent');
        } else {
            header('Pragma: no-cache');
        }

        //Read the file out directly
        readfile($file->path);
        exit();
    }

    /**
     * Replace anything but alphanumeric characters with an UNDERSCORE
     *
     * @static
     * @access public
     *
     * @uses function preg_replace   built-in PHP Function
     *
     * @PHPUnit Not Defined|Implement|Completed
     *
     * @param string  $name   File name to 'fix'
     *
     * @return string $name   the correct filename
     * @throws void
     *
     */
    public static function fixName($name) {
        $name = preg_replace('/[^A-Za-z0-9\.]/','_',$name);
        if ($name[0] === '.')  // attempt to upload a dot file
            $name[0] = '_';
        $name = str_replace('..', '_', $name);  // attempt to upload with redirection to new folder
        return $name;
//        return preg_replace('/[^A-Za-z0-9\.]/', '-', $name);
    }

    /**
     * Return the mimetype for the passed filename
     *
     * @param string $filename
     * @return string
     */
    public static function getMimeType($filename) {
        /* Store an array of commom mimetypes */
        $types = array(
        'txt' => 'text/plain',
        'htm' => 'text/html',
        'html' => 'text/html',
        'shtml' => 'text/html',
        'php' => 'text/html',
        'phps' => 'text/html',
        'php3' => 'text/html',
        'php4' => 'text/html',
        'php5' => 'text/html',
        'php7' => 'text/html',
        'phtml' => 'text/html',
        'css' => 'text/css',
        'js' => 'application/javascript',
        'json' => 'application/json',
        'xml' => 'application/xml',

        // images
        'png' => 'image/png',
        'jpe' => 'image/jpeg',
        'jpeg' => 'image/jpeg',
        'jpg' => 'image/jpeg',
        'gif' => 'image/gif',
        'bmp' => 'image/bmp',
        'ico' => 'image/vnd.microsoft.icon',
        'tiff' => 'image/tiff',
        'tif' => 'image/tiff',
        'svg' => 'image/svg+xml',
        'svgz' => 'image/svg+xml',

        // archives
        'gz' => 'application/x-gzip',
        'zip' => 'application/zip',
        'rar' => 'application/x-rar-compressed',
        'exe' => 'application/x-msdownload',
        'msi' => 'application/x-msdownload',
        'cab' => 'application/vnd.ms-cab-compressed',

        // audio/video
        'mp3' => 'audio/mpeg',
        'ogg' => 'audio/ogg',
        'qt' => 'video/quicktime',
        'mov' => 'video/quicktime',
        'f4v' => 'video/mp4',
        'mp4' => 'video/mp4',
        'm4v' => 'video/x-m4v',
        'ogv' => 'video/ogg',
        '3gp' => 'video/3gpp',
        'webm' => 'video/webm',
        'flv' => 'video/x-flv',
        'swf' => 'application/x-shockwave-flash',

        // adobe
        'pdf' => 'application/pdf',
//        'psd' => 'image/vnd.adobe.photoshop',
//        'ai' => 'application/postscript',
//        'eps' => 'application/postscript',
//        'ps' => 'application/postscript',

        // ms office
//        'doc' => 'application/msword',
//        'rtf' => 'application/rtf',
//        'xls' => 'application/vnd.ms-excel',
//        'ppt' => 'application/vnd.ms-powerpoint',

        // open office
//        'odt' => 'application/vnd.oasis.opendocument.text',
//        'ods' => 'application/vnd.oasis.opendocument.spreadsheet'
        );

        /* Get the file extension,
         * FYI: this is *really* hax.
         */
        $fileparts = explode('.',$filename);
        $extension = strtolower(array_pop($fileparts));
        if(array_key_exists($extension, $types)) {
            /* If we can *guess* the mimetype based on the filename, do that for standardization */
            return $types[$extension];
        } elseif(function_exists('finfo_open')) {
            /* If we don't have to guess, do it the right way */
            $finfo = finfo_open(FILEINFO_MIME);
            $mimetype = finfo_file($finfo, $filename);
            finfo_close($finfo);
            return $mimetype;
        } else {
            /* Otherwise, let the browser guess */
            return 'application/octet-stream';
        }
    }

    /**
     * Return audio/visual details for the passed filename
     *
     * @param string $filename
     *
     * @return array
     */
    public static function getAVInfo($filename) {
        include_once(BASE.'external/getid3/getid3/getid3.php');
        // Initialize getID3 engine
        $getID3 = new getID3;
        $fileinfo = $getID3->analyze($filename);
        getid3_lib::CopyTagsToComments($fileinfo);

        return $fileinfo;
    }
// ==========================================================
// Class Image Processing Methods
// @TODO  This collection of methods need to be placed in their own Class

    /**
     * Return size and mimetype information about an image file,
     * given its path/filename.  This is a wrapper around the
     * built-in PHP 'getimagesize' function, to make all implementations
     * work identically.
     *
     * @static
     * @access public
     *
     * @uses function getimagesize()   Built-in PHP function
     *
     * @PHPUnit Not Defined|Implement|Completed
     *
     * @param bool|string $_path Full path to file to pull info from
     *
     * @return array|string  $_sizeinfo      An array of Image File info
     *                    or $error message  Error message
     *
     */
    public static function getImageInfo($_path = false) {
        $_path = __realpath($_path);

        if (!file_exists($_path)) return self::IMAGE_ERR_FILENOTFOUND;
        if (!is_readable($_path)) return self::IMAGE_ERR_PERMISSIONDENIED;

        if ($_sizeinfo = @getimagesize($_path)) {
            $_sizeinfo['is_image'] = true;
//            if (!isset($_sizeinfo['mime'])) {
//                // In case this implementation of getimagesize doesn't discover
//                // the mime type
//                $_types = array(
//                    'jpg'  => 'image/jpeg',
//                    'jpeg' => 'image/jpeg',
//                    'gif'  => 'image/gif',
//                    'png'  => 'image/png'
//                );
//
//                $_fileData = pathinfo($_path);
//                if (array_key_exists($_fileData['extension'], $_types)) $_sizeinfo['mime'] = $_types[$_fileData['extension']];
//            }
        } else {
            $_sizeinfo = array();
            $_sizeinfo['is_image'] = false;
//            if (!isset($_sizeinfo['mime'])) {
//                // In case this implementation of getimagesize doesn't discover
//                // the mime type
//                $_types = array(
//                    'mp3'  => 'audio/mpeg',
//                    'ogg'  => 'audio/ogg',
//                    'flv'  => 'video/x-flv',
//                    'f4v'  => 'video/mp4',
//                    'mp4'  => 'video/mp4',
//                    'ogv'  => 'video/ogg',
//                    '3gp'  => 'video/3gpp',
//                    'webm' => 'video/webm',
//                    'pdf'  => 'application/pdf',
//                );
//
//                $_fileData = pathinfo($_path);
//                if (array_key_exists($_fileData['extension'], $_types)) $_sizeinfo['mime'] = $_types[$_fileData['extension']];
//            }
        }
        $_sizeinfo['mime'] = self::getMimeType($_path);
        $_sizeinfo['fileSize'] = self::fileSize($_path);

        return $_sizeinfo;
    }

    /** exdoc
     * Create an image resource handle (from GD) for a given filename.
     * This is a wrapper around various GD functions, to provide Exponent
     * programmers a single point of entry.  It also handles situations where
     * there is no GD support compiled into the server.  (In this case, null is returned).
     *
     * At this point, the user should have called self::getImageInfo on the filename
     * and verified that the file does indeed exist, and is readable.  A safeguard check
     * is in place, however.
     *
     * @param string $filename The path/filename of the image.
     * @param null $sizeinfo
     *
     * @return null|resource|string
     * @node Model:expFile
     */
    public static function openImageFile($filename, $sizeinfo=null) {
        if (!EXPONENT_HAS_GD) return null;

        if ($sizeinfo == null)
            $sizeinfo = @getimagesize($filename);
        $info = gd_info();

        if ($sizeinfo['mime'] === 'image/jpeg' && ($info['JPG Support'] == true || $info['JPEG Support'] == true)) {
            $img = imagecreatefromjpeg($filename);
        } else if ($sizeinfo['mime'] === 'image/png' && $info['PNG Support'] == true) {
            $img = imagecreatefrompng($filename);
        } else if ($sizeinfo['mime'] === 'image/gif' && $info['GIF Read Support'] == true) {
            $img = imagecreatefromgif($filename);
        } else {
            // Either we have an unknown image type, or an unsupported image type.
            return self::IMAGE_ERR_NOTSUPPORTED;
        }

        if (function_exists('imagesavealpha')) {
            imagealphablending($img, false);
            imagesavealpha($img, true);
        }
        return $img;
    }

    /** exdoc
     * Create a new blank image resource, with the specified width and height.
     * This is a wrapper around various GD functions, to provide Exponent
     * programmers a single point of entry.  It also handles situations where
     * there is no GD support compiled into the server.  (In this case, null is returned).
     *
     * @param integer $w Width of the image resource to create (in pixels)
     * @param integer $h Height of the image resource to create (in pixels)
     *
     * @return null|resource
     * @node Model:expFile
     */
    public static function imageCreate($w, $h) {
        if (!EXPONENT_HAS_GD) {
            return null;
        }
        $info = gd_info();
        if (strpos($info['GD Version'], '2.') !== false) {
            $img = imagecreatetruecolor($w, $h);

            if (function_exists('imagesavealpha')) {
                imagealphablending($img, false);
                imagesavealpha($img, true);
            }

            return $img;
        } else {
            return imagecreate($w, $h);
        }
    }

    /**
     * Copy and resize and image
     *
     * @param $dest
     * @param $src
     * @param $dst_x
     * @param $dst_y
     * @param $src_x
     * @param $src_y
     * @param $dst_w
     * @param $dst_h
     * @param $src_w
     * @param $src_h
     * @return bool|null
     */
    public static function imageCopyresized($dest, $src, $dst_x, $dst_y, $src_x, $src_y, $dst_w, $dst_h, $src_w, $src_h) {
        if (!EXPONENT_HAS_GD) {
            return null;
        }
        $info = gd_info();
        if (strpos($info['GD Version'], '2.') !== false) {
            return imagecopyresampled($dest, $src, $dst_x, $dst_y, $src_x, $src_y, $dst_w, $dst_h, $src_w, $src_h);
        } else {
            return imagecopyresized($dest, $src, $dst_x, $dst_y, $src_x, $src_y, $dst_w, $dst_h, $src_w, $src_h);
        }
    }

    /** exdoc
     * Proportionally scale an image by a specific percentage
     * This is a wrapper around various GD functions, to provide Exponent
     * programmers a single point of entry.  It also handles situations where
     * there is no GD support compiled into the server.  (In this case, null is returned).
     *
     * @param string $filename The path/filename of the image to scale.
     * @param float  $scale    The scaling factor, as a decimal (i.e. 0.5 for 50%)
     *
     * @return array|null|resource|string
     * @node Model:expFile
     */
    public static function imageScaleByPercent($filename, $scale) {
        $sizeinfo = self::getImageInfo($filename);
        if (!is_array($sizeinfo)) {
            return $sizeinfo;
        }

        $original = self::openImageFile($filename, $sizeinfo);
        if (!is_resource($original)) {
            return $original;
        }

        if ($scale == 1) {
            return $original;
        }

        $w = $scale * $sizeinfo[0];
        $h = $scale * $sizeinfo[1];

        $thumb = self::imageCreate($w, $h);
        if (!$thumb) return null;
        self::imageCopyresized($thumb, $original, 0, 0, 0, 0, $w, $h, $sizeinfo[0], $sizeinfo[1]);

        return $thumb;
    }

    /** exdoc
     * Proportionally scale an image to a given width. Height adjusts accordingly.
     * This is a wrapper around various GD functions, to provide Exponent
     * programmers a single point of entry.  It also handles situations where
     * there is no GD support compiled into the server.  (In this case, null is returned).
     *
     * @param string  $filename The path/filename of the image to scale.
     * @param integer $width    The desired width of the scaled image, in pixels.
     *
     * @return array|null|resource|string
     * @node Model:expFile
     */
    public static function imageScaleToWidth($filename, $width) {
        $sizeinfo = self::getImageInfo($filename);
        if (!is_array($sizeinfo)) {
            return $sizeinfo;
        }
        $original = self::openImageFile($filename, $sizeinfo);
        if (!is_resource($original)) {
            return $sizeinfo;
        }

        if ($width == $sizeinfo[0]) {
            return $original;
        }

        $w = $width;
        $h = ($width / $sizeinfo[0]) * $sizeinfo[1];

        $thumb = self::imageCreate($w, $h);
        if (!$thumb) return null;
        self::imageCopyresized($thumb, $original, 0, 0, 0, 0, $w, $h, $sizeinfo[0], $sizeinfo[1]);

        return $thumb;
    }

    /** exdoc
     * Proportionally scale an image to a given height.  Width adjusts accordingly.
     * This is a wrapper around various GD functions, to provide Exponent
     * programmers a single point of entry.  It also handles situations where
     * there is no GD support compiled into the server.  (In this case, null is returned).
     *
     * @param string  $filename The path/filename of the image to scale.
     * @param integer $height   The desired height of the scaled image, in pixels.
     *
     * @return array|null|resource|string
     * @node Model:expFile
     */
    public static function imageScaleToHeight($filename, $height) {
        $sizeinfo = self::getImageInfo($filename);
        if (!is_array($sizeinfo)) {
            return $sizeinfo;
        }

        $original = self::openImageFile($filename, $sizeinfo);
        if (!is_resource($original)) {
            return $original;
        }

        if ($height == $sizeinfo[1]) {
            return $original;
        }

        $w = ($height / $sizeinfo[1]) * $sizeinfo[0];
        $h = $height;

        $thumb = self::imageCreate($w, $h);
        if (!$thumb) return null;
        self::imageCopyresized($thumb, $original, 0, 0, 0, 0, $w, $h, $sizeinfo[0], $sizeinfo[1]);

        return $thumb;
    }

    /** exdoc
     * Proportionally scale an image to fit within the given width / height.
     * This is a wrapper around various GD functions, to provide Exponent
     * programmers a single point of entry.  It also handles situations where
     * there is no GD support compiled into the server.  (In this case, null is returned).
     *
     * @param string  $filename The path/filename of the image to scale.
     * @param integer $width    The maximum width of the scaled image, in pixels.
     * @param integer $height   The maximum height of the scaled image, in pixels.
     *
     * @return array|null|resource|string
     * @node Model:expFile
     */
    public static function imageScaleToConstraint($filename, $width, $height) {
        $sizeinfo = self::getImageInfo($filename);
        if (!is_array($sizeinfo)) {
            return $sizeinfo;
        }

        $original = self::openImageFile($filename, $sizeinfo);
        if (!is_resource($original)) {
            return $original;
        }

        if ($width >= $sizeinfo[0] && $height >= $sizeinfo[1]) {
            return $original;
        }

        $w = $width;
        $h = ($width / $sizeinfo[0]) * $sizeinfo[1];

        if ($h > $height) { // height is outside
            $w = ($height / $sizeinfo[1]) * $sizeinfo[0];
            $h = $height;
        }

        $thumb = self::imageCreate($w, $h);
        if (!$thumb) return null;
        self::imageCopyresized($thumb, $original, 0, 0, 0, 0, $w, $h, $sizeinfo[0], $sizeinfo[1]);

        return $thumb;
    }

    /** exdoc
     * Scale an image to a square keeping the image aspect ratio.
     * If the image is smaller in either dimension than request square side original is returned.
     * Image is first cropped to a square of length smaller of width or height and then resized.
     * This is a wrapper around various GD functions, to provide Exponent
     * programmers a single point of entry.  It also handles situations where
     * there is no GD support compiled into the server.  (In this case, null is returned).
     *
     * @param string $filename The path/filename of the image to scale.
     * @param        $side
     *
     * @return array|null|resource|string
     * @internal param int $size The desired side length of the scaled image, in pixels.
     * @node Model:expFile
     */
    public static function imageScaleToSquare($filename, $side) {
        $sizeinfo = self::getImageInfo($filename);
        if (!is_array($sizeinfo)) {
            return $sizeinfo;
        }

        $original = self::openImageFile($filename, $sizeinfo);
        if (!is_resource($original)) {
            return $original;
        }

        if ($side >= $sizeinfo[0] || $side >= $sizeinfo[1]) {
            return $original;
        }

        /* The defaults will serve in case the image is a square */
        $src_x = 0;
        $src_y = 0;
        $width = $sizeinfo[0];
        $height = $sizeinfo[1];

        /*if width greater than height, we crop the image left and right */
        if ($sizeinfo[0] > $sizeinfo[1]) {
            $width = $sizeinfo[1];
            $height = $sizeinfo[1];
            $src_x = round(($sizeinfo[0] - $width) / 2, 0);
        } else {
            /*if height greater than width, we crop the image top and bottom */
            $height = $sizeinfo[0];
            $width = $sizeinfo[0];
            $src_y = round(($sizeinfo[1] - $height) / 2, 0);
        }

        $w = $side;
        $h = $side;

        $thumb = self::imageCreate($w, $h);
        if (!$thumb) return null;
        self::imageCopyresized($thumb, $original, 0, 0, $src_x, $src_y, $w, $h, $width, $height);

        return $thumb;
    }

    /** exdoc
     * Scale an image to a given width and height, without regard to aspect ratio.
     * This is a wrapper around various GD functions, to provide Exponent
     * programmers a single point of entry.  It also handles situations where
     * there is no GD support compiled into the server.  (In this case, null is returned).
     *
     * @param string  $filename The path/filename of the image to scale.
     * @param integer $width    The desired width of the scaled image, in pixels.
     * @param integer $height   The desired height of the scaled image, in pixels.
     *
     * @return array|null|resource|string
     * @node Model:expFile
     */
    public static function imageScaleManually($filename, $width, $height) {
        $sizeinfo = self::getImageInfo($filename);
        if (!is_array($sizeinfo)) {
            return $sizeinfo;
        }

        $original = self::openImageFile($filename, $sizeinfo);
        if (!is_resource($original)) {
            return $original;
        }

        if ($width == $sizeinfo[0] && $height == $sizeinfo[1]) {
            return $original;
        }

        $thumb = self::imageCreate($width, $height);
        if (!$thumb) return null;
        self::imageCopyresized($thumb, $original, 0, 0, 0, 0, $width, $height, $sizeinfo[0], $sizeinfo[1]);

        return $thumb;
    }

    /**
     * Rotate an image file
     *
     * @param $filename
     * @param $degrees
     * @return array|null|resource|string
     */
    public static function imageRotate($filename, $degrees) {
        $sizeinfo = self::getImageInfo($filename);
        if (!is_array($sizeinfo)) {
            return $sizeinfo;
        }

        $original = self::openImageFile($filename, $sizeinfo);
        if (!is_resource($original)) {
            return $original;
        }

        $color = imagecolorclosesthwb($original, 255, 255, 255);

        return imagerotate($original, $degrees, $color);
    }

    /**
     * Flip an image file
     *
     * @param $filename
     * @param bool $is_horizontal
     * @return array|null|resource|string
     */
    public static function imageFlip($filename, $is_horizontal=false) {
        $sizeinfo = self::getImageInfo($filename);
        if (!is_array($sizeinfo)) {
            return $sizeinfo;
        }

        $original = self::openImageFile($filename, $sizeinfo);
        if (!is_resource($original)) {
            return $original;
        }

        // Horizontal - invert y coords
        // Vertical - invert x coords

        $w = $sizeinfo[0];
        $h = $sizeinfo[1];
        $new = self::imageCreate($w, $h);

        if ($is_horizontal) {
            // Copy column by column
            //$dest,$src,$dst_x, $dst_y, $src_x, $src_y, $dst_w, $dst_h, $src_w, $src_h) {
            for ($i = 0; $i < $w; $i++) {
                imagecopy($new, $original, // DESTINATION, SOURCE
                    $i, 0, // dst_X, dst_Y
                    $w - $i - 1, 0, // src_X,src_Y
                    1, $h); //src_W, src_H
            }
        } else {
            // Copy row by row.
            //$dest,$src,$dst_x, $dst_y, $src_x, $src_y, $dst_w, $dst_h, $src_w, $src_h) {
            for ($i = 0; $i < $h; $i++) {
                imagecopy($new, $original, // DESTINATION, SOURCE
                    0, $i, // dst_X, dst_Y
                    0, $h - $i - 1, // src_X,src_Y
                    #$w,1,		// dst_W, dst_H
                    $w, 1); //src_W, src_H
            }
        }
        return $new;
    }

    /** exdoc
     * Output an image based on its mimetype
     *
     * @param      $img
     * @param      $sizeinfo
     * @param null $filename
     * @param int  $quality
     */
    public static function imageOutput($img, $sizeinfo, $filename = null, $quality = 75) {
        header('Content-type: ' . $sizeinfo['mime']);
        if ($sizeinfo['mime'] === 'image/jpeg') {
            ($filename != null) ? imagejpeg($img, $filename, $quality) : imagejpeg($img, null, $quality);
        } else if ($sizeinfo['mime'] === 'image/png') {
            ($filename != null) ? imagepng($img, $filename) : imagepng($img);
        } else if ($sizeinfo['mime'] === 'image/gif') {
            ($filename != null) ? imagegif($img, $filename) : imagegif($img);
        }
    }

    /** exdoc
     * Create a captcha type image from a string
     *
     * @param $w
     * @param $h
     * @param $string
     *
     * @return null|resource
     */
    public static function imageCaptcha($w, $h, $string) {
        $img = self::imageCreate($w, $h);
        if ($img) {
            // We were able to create an image.
            $bg = imagecolorallocate($img, 250, 255, 225);
            imagefill($img, 0, 0, $bg);
            #echo $bg;
            $colors = array();
            for ($i = 0; $i < strlen($string) && $i < 10; $i++) {
                $colors[$i] = imagecolorallocate($img, mt_rand(50, 150), mt_rand(50, 150), mt_rand(50, 150));
            }
            $px_per_char = floor($w / (strlen($string) + 1));
            for ($i = 0, $iMax = strlen($string); $i < $iMax; $i++) {
                imagestring($img, mt_rand(4, 6), $px_per_char * ($i + 1) + mt_rand(-5, 5), mt_rand(0, $h / 2), $string[$i], $colors[($i % 10)]);
            }

            // Need this to be 'configurable'
            for ($i = 0; $i < strlen($string) / 2 && $i < 10; $i++) {
                $c = imagecolorallocate($img, mt_rand(150, 250), mt_rand(150, 250), mt_rand(150, 250));
                imageline($img, mt_rand(0, $w / 4), mt_rand(5, $h - 5), mt_rand(3 * $w / 4, $w), mt_rand(0, $h), $c);
            }

            //imagestring($img,6,0,0,$string,$color);
            return $img;
        } else {
            return null;
        }
    }

    /**
     * Recursively copy file(s)
     *
     * @param $src
     * @param $dst
     * @return bool
     */
    static function recurse_copy($src, $dst) {
        $dir = opendir($src);
        @mkdir($dst, octdec(DIR_DEFAULT_MODE_STR + 0));
        while (false !== ($file = readdir($dir))) {
            if (($file !== '.') && ($file !== '..')) {
                if (is_dir($src . '/' . $file)) {
                    self::recurse_copy($src . '/' . $file, $dst . '/' . $file);
                } else {
                    if (!copy($src . '/' . $file, $dst . '/' . $file)) {
                        return false;
                    }
                    ;
                }
            }
        }
        closedir($dir);
        return true;
    }

    /**
     * Recursively removes all files in a given directory, and all
     * the files and directories underneath it.
     * Optionally can skip dotfiles
     *
     * @param string $dir       directory to work with
     * @param bool   $dot_files should dotfiles be removed?
     *
     * @return array
     */
    public static function removeFilesInDirectory($dir, $dot_files = false) {
        $results['removed'] = array();
        $results['not_removed'] = array();

        $files = scandir($dir);
        array_shift($files); // remove '.' from array
        array_shift($files); // remove '..' from array
        foreach ($files as $file) {
            if ($dot_files || substr($file, 0, 1) !== '.') { // don't remove dot files
                $file = $dir . '/' . $file;
                if (is_dir($file)) {
                    self::removeFilesInDirectory($file);
                    rmdir($file);
                } else {
                    if (is_writeable($file) && !is_dir($file)) {
                        unlink($file);
                        $results['removed'][] = $file;
                    } else {
                        $results['not_removed'][] = $file;
                    }
                }
            }
        }

        /*	old routine
            if (is_readable($dir)) {
                $dh = opendir($dir);
                while (($file = readdir($dh)) !== false) {
                    $filepath = $dir.'/'.$file;
                    if (substr($file,0,1) != '.') {
                        if (is_writeable($filepath) && !is_dir($filepath)) {
                            unlink($filepath);
                            $results['removed'][] = $filepath;
                        } else {
                            $results['not_removed'][] = $filepath;
                        }
                    }
                }
            }*/

        return $results;
    }

    /** exdoc
     * This method creates a directory and all of its parent directories, if they do not exist,
     * emulating the behavior of the -p option to mkdir on UNIX systems.  Returns
     * a SYS_FILES_* constant, indicating its status.
     *
     * @param string $dir The directory to create.  This path must be relative to BASE
     * @param null   $mode
     * @param bool   $is_full
     *
     * @return int
     * @node Model:expFile
     */
    public static function makeDirectory($dir, $mode = null, $is_full = false) {
        $__oldumask = umask(0);
        $parentdir = ($is_full ? "/" : BASE); // we will add to parentdir with each directory
        foreach (explode("/", $dir) as $part) {
            if ($part != "" && !is_dir($parentdir . $part)) {
                // No parent directory.  Create it.
                if (is_file($parentdir . $part)) return SYS_FILES_FOUNDFILE;
                if (expUtil::isReallyWritable($parentdir)) {
                    if ($mode == null) $mode = octdec(DIR_DEFAULT_MODE_STR + 0);
                    mkdir($parentdir . $part, $mode);
                    chmod($parentdir . $part, $mode);
                } else return SYS_FILES_NOTWRITABLE;
            }
            $parentdir .= $part . "/";
        }
        umask($__oldumask);
        return SYS_FILES_SUCCESS;
    }

    /**
     * Recursively removes the given directory, and all
     * of the files and directories underneath it.
     *
     * @param string $dir directory to work with
     *
     * @return int
     * @node Model:expFile
     *
     */
    public static function removeDirectory($dir) {
        if (strpos($dir, BASE) != 0) $dir = BASE . $dir;
        $dh = opendir($dir);
        if ($dh) {
            while (($file = readdir($dh)) !== false) {
                if ($file !== "." && $file !== ".." && is_dir("$dir/$file")) {
                    if (self::removeDirectory("$dir/$file") == SYS_FILES_NOTDELETABLE) return SYS_FILES_NOTDELETABLE;
                } else if (is_file("$dir/$file") || is_link(is_file("$dir/$file"))) {
                    unlink("$dir/$file");
                    if (file_exists("$dir/$file")) {
                        return SYS_FILES_NOTDELETABLE;
                    }
                } else if ($file !== "." && $file !== "..") {
                    echo "BAD STUFF HAPPENED<br />";
                    echo "--------Don't know what to do with $dir/$file<br />";
//					echo "<xmp>";
                    echo "<pre>";
                    print_r(stat("$dir/$file"));
                    echo filetype("$dir/$file");
//					echo "</xmp>";
                    echo "</pre>";
                }
            }
        }
        closedir($dh);
        rmdir($dir);
    }

    /** exdoc
     * Move an uploaded temporary file to a more permanent home inside of the Exponent files/ directory.
     * This function takes into account the default file modes specified in the site configuration.
     *
     * @param string $tmp_name The temporary path of the uploaded file.
     * @param string $dest     The full path to the destination file (including the destination filename).
     *
     * @return null|string     The destination file if it exists, otherwise null
     * @node Model:expFile
     */
    public static function moveUploadedFile($tmp_name, $dest) {
        move_uploaded_file($tmp_name, $dest);
        if (file_exists($dest)) {
            $__oldumask = umask(0);
            chmod($dest, octdec(FILE_DEFAULT_MODE_STR + 0));
            umask($__oldumask);
            return str_replace(BASE, '', $dest);
        } else return null;
    }

    /** exdoc
     * Checks to see if the upload destination file exists.  This is to prevent
     * accidentally uploading over the top of another file.
     * Returns true if the file already exists, and false if it does not.
     *
     * @param string $dir  The directory to contain the existing directory.
     * @param string $name The name of the file control used to upload the
     *                     file.  The files subsystem will look to the $_FILES array
     *                     to get the filename of the uploaded file.
     *
     * @return bool
     * @node Model:expFile
     */
    public static function uploadDestinationFileExists($dir, $name) {
        return (file_exists(BASE . $dir . "/" . self::fixName($_FILES[$name]['name'])));
    }

    /** exdoc
     * Lists files and directories under a given parent directory. Returns an
     * associative, flat array of files and directories.  The key is the full file
     * or directory name, and the value is the file or directory name.
     *
     * @param string  $dir          The path of the directory to look at.
     * @param boolean $recurse      A boolean dictating whether to descend into subdirectories
     *                              recursively, and list files and subdirectories.
     * @param string  $ext          An optional file extension.  If specified, only files ending with
     *                              that file extension will show up in the list.  Directories are not affected.
     * @param array   $exclude_dirs An array of directory names to exclude.  These names are
     *                              path-independent.  Specifying "dir" will ignore all directories and
     *                              sub-directories named "dir", regardless of their parent.
     * @param string  $relative
     *
     * @return array
     * @node Model:expFile
     */
    public static function listFlat($dir, $recurse = false, $ext = null, $exclude_dirs = array(), $relative = "") {
        $files = array();
        if (is_readable($dir)) {
            $dh = opendir($dir);
            while (($file = readdir($dh)) !== false) {
                if (is_dir("$dir/$file") && !in_array($file, $exclude_dirs) && $recurse && $file !== "." && $file !== ".." && $file !== "CVS") {
                    $files = array_merge($files, self::listFlat("$dir/$file", $recurse, $ext, $exclude_dirs, $relative));
//                    $files += self::listFlat("$dir/$file", $recurse, $ext, $exclude_dirs, $relative);
                }
                if (is_file("$dir/$file") && ($ext == null || substr($file, -1 * strlen($ext), strlen($ext)) == $ext)) {
                    $files[str_replace($relative, "", "$dir/$file")] = $file;
                }
            }
            closedir($dh);
        }
        return $files;
    }

    /** exdoc
     * Checks to see if the file exists case-insensitive.  This is to circumvent
     * the case sensitive php is_file.
     * Returns true if the file already exists, and false if it does not.
     *
     * @param string $filename  The file (with path) to check.
     *
     * @return bool
     * @node Model:expFile
     */
    public static function is_file($filename) {
        $dir = dirname($filename);
        $file = basename($filename);
        if ($handle = opendir($dir)) {
            while (false !== ($entry = readdir($handle))) {
                if (strtolower($file) == strtolower($entry)) {
                    return true;
                }
            }
            closedir($handle);
        }
        return false;
    }

    /** exdoc
     * Looks at the filesystem structure surrounding the destination
     * and determines if the web server can create a new file there.
     * Returns one of the following:
     *    <br>SYS_FILES_NOTWRITABLE - unable to create files in destination
     *    <br>SYS_FILES_SUCCESS - A file or directory can be created in destination
     *    <br>SYS_FILES_FOUNDFILE - Found destination to be a file, not a directory
     *
     * @param string $dest Path to the directory to check
     *
     * @return int
     * @node Model:expFile
     */
    public static function canCreate($dest) {
        if ($dest[0] === '/') $dest = str_replace(BASE, '', $dest);
        $parts = explode('/', $dest);
        $working = BASE;
        for ($i = 0, $iMax = count($parts); $i < $iMax; $i++) {
            if ($parts[$i] != '') {
                if (!file_exists($working . $parts[$i])) {
                    return (expUtil::isReallyWritable($working) ? SYS_FILES_SUCCESS : SYS_FILES_NOTWRITABLE);
                }
                $working .= $parts[$i] . '/';
            }
        }
        // If we got this far, then the file we are asking about already exists.
        // Check to see if we can overwrite this file.
        // First however, we need to strip off the '/' that was added a few lines up as the last part of the for loop.
        $working = substr($working, 0, -1);

        if (!expUtil::isReallyWritable($working)) {
            return SYS_FILES_NOTWRITABLE;
        } else {
            if (is_file($working)) {
                return SYS_FILES_FOUNDFILE;
            } else {
                return SYS_FILES_FOUNDDIR;
            }
        }
    }

    /**
     * Test if file can be uploaded using tmp folder
     *
     * @param string $tmp
     * @param string $dest
     *
     * @return bool
     */
    public static function canUpload($tmp = 'tmp', $dest = 'files/uploads') {
        $result = expFile::canCreate(BASE . $tmp . '/TEST') != SYS_FILES_SUCCESS;
        $result |= expFile::canCreate(BASE . $dest . '/TEST') != SYS_FILES_SUCCESS;
        return $result;
    }

    /** exdoc
     * Copies just the directory structure (including subdirectories) of a given directory.
     * Any files in the source directory are ignore, and duplicate copies are made (no symlinks).
     *
     * @param string $src          The directory to copy structure from.  This must be a full path.
     * @param string $dest         The directory to create duplicate structure in.  If this directory is not empty,
     *                             you may run into some problems, because of file/directory conflicts.
     * @param array  $exclude_dirs An array of directory names to exclude.  These names are
     *                             path-independent.  Specifying "dir" will ignore all directories and
     *                             sub-directories named "dir", regardless of their parent.
     *
     * @node Model:expFile
     */
    public static function copyDirectoryStructure($src, $dest, $exclude_dirs = array()) {
        $__oldumask = umask(0);
        if (!is_dir($dest)) {
            $file_path = pathinfo($dest);
            $dest = $file_path['dirname'];
        }
        if (!is_dir($src)) {
            $file_path = pathinfo($src);
            $src = $file_path['dirname'];
        }
        if (!file_exists($dest)) mkdir($dest, fileperms($src));
        $dh = opendir($src);
        while (($file = readdir($dh)) !== false) {
            if (is_dir("$src/$file") && !in_array($file, $exclude_dirs) && $file[0] !== "." && $file !== "CVS") {
                if (!file_exists($dest."/".$file)) mkdir($dest."/".$file, fileperms($src."/".$file));
                if (is_dir($dest."/".$file)) {
                    self::copyDirectoryStructure($src."/".$file, $dest."/".$file);
                }
            }
        }
        closedir($dh);
        umask($__oldumask);
    }

    /** exdoc
     * This function takes a database object and dumps
     * all of the records in all of the tables into a string.
     * The contents of the string are suitable for storage
     * in a file or other permanent mechanism, and is in
     * the EQL format naively handled by the current
     * implementation.
     *
     * @param null/array            $tables
     * @param null/string           $type       The type of dump
     * @param null/string/array     $opts       Record descimiator
     *
     * @return string                           The content of export file
     * @node     Model:expFile
     */
    public static function dumpDatabase($tables = null, $type = null, $opts = null) {
        global $db;

        //FIXME we need to echo and/or write to file within this method to handle large database dumps
        $dump = EQL_HEADER . "\r\n";
        if ($type == null || $type === 'export') {
            $dump .= 'VERSION:' . EXPONENT . "\r\n\r\n";
        } else {
            $dump .= 'VERSION:' . EXPONENT . ':' . $type . "\r\n\r\n";
        }

        if (is_string($tables)) $tables = array($tables);
        if (!is_array($tables)) {  // dump all the tables
            $tables = $db->getTables();
            if (!function_exists('tmp_removePrefix')) {
                function tmp_removePrefix($tbl) {
                    return substr($tbl, strlen(DB_TABLE_PREFIX) + 1);
                    // we add 1, because DB_TABLE_PREFIX  no longer has the trailing
                    // '_' character - that is automatically added by the database class.
                }
            }
            $tables = array_map('tmp_removePrefix', $tables);
        }
        uasort($tables, 'strnatcmp');
        foreach ($tables as $key=>$table) {
            $where = '1';
            if ($type === 'Form') {
                if ($table === 'forms') {
                    $where = 'id=' . $opts;
                } elseif ($table === 'forms_control') {
                    $where = 'forms_id=' . $opts;
                }
            } elseif ($type === 'export') {
                if (is_string($opts))
                    $where = $opts;
                elseif (is_array($opts) && !empty($opts[$key]))
                    $where = $opts[$key];
            }
            $tmp = $db->countObjects($table,$where);
            if ($type !== 'export' || $db->countObjects($table, $where)) {
                $tabledef = $db->getDataDefinition($table);
                $dump .= 'TABLE:' . $table . "\r\n";
                $dump .= 'TABLEDEF:' . str_replace(array("\r", "\n"), array('\r', '\n'), serialize($tabledef)) . "\r\n";
                foreach ($db->selectObjects($table, $where) as $obj) {
                    $dump .= 'RECORD:' . str_replace(array("\r", "\n"), array('\r', '\n'), serialize($obj)) . "\r\n";
                }
                $dump .= "\r\n";
            }
        }
        //FIXME $dump may become too large and exhaust memory
        return $dump;
    }

    /** exdoc
     * This function restores a database (overwriting all data in
     * any existing tables) from an EQL object dump.  Returns true if
     * the restore was a success and false if something went horribly wrong
     * (unable to read file, etc.)  Even if true is returned, there is a chance
     * that some errors were encountered.  Check $errors to be sure everything
     * was fine.
     *
     * @param string $file The filename of the EQL file to restore from
     * @param array $errors A referenced array that stores errors.  Whatever
     *                              variable is passed in this argument will contain all errors encountered
     *                              during the parse/restore.
     * @param null $type
     *
     * @return bool
     * @throws ReflectionException
     * @node     Model:expFile
     */
    public static function restoreDatabase($file, &$errors, $type = null) {
        global $db;

//        $errors = array();

        if (is_readable($file)) {
            $eql = @fopen($file, "rb");
            if ($eql) {
                //NOTE changed to fgets($file)
//                $lines = @file($file);
                $line0 = fgets($eql);
                $line1 = fgets($eql);

                // Sanity check
//                if (count($lines) < 2 || trim($lines[0]) != EQL_HEADER) {
                if ($line1 === false || trim($line0) != EQL_HEADER) {
                    $errors[] = gt('Not a valid EQL file');
                    return false;
                }

//                $version = explode(':', trim($lines[1]));
                $version = explode(':', trim($line1));
                $eql_version = $version[1] + 0;
                $current_version = EXPONENT + 0;
                if ((array_key_exists(2, $version) && $type == null) || (array_key_exists(
                            2,
                            $version
                        ) && $version[2] != $type)
                ) {
                    $eql_version = 0;  // trying to import wrong eql type
                }

//            $clear_function = '';
                $fprefix = '';
                // Check version and include necessary converters
                if ($eql_version != $current_version) {
                    $errors[] = gt('EQL file was Not a valid EQL version');
                    return false;
                    //			$fprefix = 'expFile::'.implode('',explode('.',$eql_version)).'_';
                    //			if (function_exists($fprefix.'clearedTable')) {
                    //				$clear_function = $fprefix.'clearedTable';
                    //			}
                }

                // make sure the database tables are up to date with the system definitions
                expDatabase::install_dbtables();

                $table = '';
                $oldformdata = array();
                $itsoldformdata = false;
                $newformdata = array();
                $itsnewformdata = false;
//                for ($i = 2; $i < count($lines); $i++) {
                $line_number = 2;
                while (($line = fgets($eql)) !== false) {
                    $table_function = '';
//                    $line_number = $i;
                    $line_number++;
//                    $line = trim($lines[$i]);
                    $line = trim($line);
                    if ($line != '') {
                        $pair = explode(':', $line);
                        $pair[1] = implode(':', array_slice($pair, 1));
                        $pair = array_slice($pair, 0, 2);

                        if ($pair[0] === 'TABLE') {
                            $itsoldformdata = false;  // we are on a new table set
                            $itsnewformdata = false;
                            $table = $pair[1];
                            if ($fprefix != '') {
                                $table_function = $fprefix . $table;
                            }
                            if ($db->tableExists($table)) {
                                if ($type == null) {
                                    $db->delete($table);  // drop/empty table records
                                }
//                            if ($clear_function != '') {
//                                $clear_function($db, $table);
//                            }
                            } else {
                                if (substr($table, 0, 12) === 'formbuilder_') {
                                    $formbuildertypes = array(
                                        'address',
                                        'control',
                                        'form',
                                        'report'
                                    );
                                    $ttype = substr($table, 12);
                                    if (!in_array($ttype, $formbuildertypes)) {
                                        $itsoldformdata = true;
                                    }
                                } elseif (substr($table, 0, 6) === 'forms_' && $table !== 'forms_control') {
                                    $itsnewformdata = true;
                                }
                                //						if (!file_exists(BASE.'framework/core/definitions/'.$table.'.php')) {
                                $errors[] = sprintf(
                                    gt("Table '%s' not found in the database (line %d)"),
                                    $table,
                                    $line_number
                                );
                                //						} else if (!is_readable(BASE.'framework/core/definitions/'.$table.'.php')) {
                                //							$errors[] = sprintf(gt('Data definition file for %s (%s) is not readable (line %d)'),$table,'framework/core/definitions/'.$table.'.php',$line_number);
                                //						} else {
                                //							$dd = include(BASE.'framework/core/definitions/'.$table.'.php');
                                //							$info = (is_readable(BASE.'framework/core/definitions/'.$table.'.info.php') ? include(BASE.'framework/core/definitions/'.$table.'.info.php') : array());
                                //							$db->createTable($table,$dd,$info);
                                //						}
                            }
                        } else {
                            if ($pair[0] === 'TABLEDEF') {  // new in v2.1.4, re-create a missing table
                                $pair[1] = str_replace(array('\r', '\n'), array("\r", "\n"), $pair[1]);
//						$tabledef = expUnserialize($pair[1]);
                                $tabledef = @unserialize($pair[1]);
                                if (!$db->tableExists($table)) {
                                    $db->createTable($table, $tabledef, array());
                                    $errors[] = sprintf(
                                        gt("*  However...we successfully recreated the '%s' Table from the EQL file"),
                                        $table
                                    );
                                } else {
                                    $ret = $db->alterTable($table, $tabledef, array(), true);
                                    if ($ret[$table] === TABLE_ALTER_SUCCEEDED) {
                                        $errors[] = sprintf(
                                            gt("Table structure '%s' was modified in the database (line %d)"),
                                            $table,
                                            $line_number
                                        );
                                    }
                                }
                                $itsoldformdata = false;  // we've recreated the table using the tabledef
                                $itsnewformdata = false;
                            } else {
                                if ($pair[0] === 'RECORD') {
                                    if ($db->tableExists($table)) {
                                        // Here we need to check the conversion scripts.
                                        $pair[1] = str_replace(array('\r', '\n'), array("\r", "\n"), $pair[1]);
                                        //						$object = expUnserialize($pair[1]);
                                        $object = @unserialize($pair[1]);
                                        if ($type === 'Form') {
                                            if ($table === 'forms') {
                                                $forms_id = $object->id = $db->max(
                                                        $table,
                                                        'id'
                                                    ) + 1;  // create a new record
                                                $spare = new expRecord();
                                                $spare->title = $object->title;
                                                $spare->makeSefUrl();
                                                $object->sef_url = $spare->sef_url;
                                            } elseif ($table === 'forms_control') {
                                                $object->id = null;  // create a new record
                                                $object->forms_id = $forms_id;  // assign to new form record
                                            } elseif (substr($table, 6) === 'forms_') {
                                                $object->id = null;  // create a new record
                                            }
                                        }
                                        if (!$object) {
                                            $object = unserialize(stripslashes($pair[1]));
                                        }
                                        if (function_exists($table_function)) {
                                            $table_function($db, $object);
                                        } else {
                                            if (is_object($object)) {
                                                if (!$db->insertObject($object, $table) && property_exists($object, 'id')) {
                                                    $errors[] = sprintf(
                                                        gt("Unable to insert '%s' record in Table '%s' (line %d)"),
                                                        $pair[1],
                                                        $table,
                                                        $line_number
                                                    );
                                                }
                                            } else {
                                                $errors[] = sprintf(
                                                    gt("Unable to decipher '%s' record (line %d)"),
                                                    $pair[0],
                                                    $line_number
                                                );
                                            }
                                        }
                                    } elseif ($itsoldformdata) {
                                        $oldformdata[$table][] = $pair[1];  // store for later
                                    } elseif ($itsnewformdata) {
                                        $newformdata[$table][] = $pair[1];  // store for later
                                    }
                                } else {
                                    $errors[] = sprintf(
                                        gt("Invalid specifier type '%s' (line %d)"),
                                        $pair[0],
                                        $line_number
                                    );
                                }
                            }
                        }
                    }
                }

                // check for and process to rebuild old formbuilder module data table
                if (!empty($oldformdata)) {
                    foreach ($oldformdata as $tablename => $tabledata) {
                        $oldform = $db->selectObject('formbuilder_form', 'table_name=\'' . substr($tablename, 12) . '\'');
                        if (!empty($oldform)) {
                            // create the old table
                            $table = self::updateFormbuilderTable($oldform);

                            // populate the table
                            foreach ($tabledata as $record) {
                                $record = str_replace('\r\n', "\r\n", $record);
                                $object = @unserialize($record);
                                if (!$object) {
                                    $object = unserialize(stripslashes($record));
                                }
                                if (is_object($object)) {
                                    $db->insertObject($object, 'formbuilder_' . $table);
                                }
                            }
                            $errors[] = sprintf(
                                gt(
                                    '*  However...we successfully recreated the "formbuilder_%s" Table from the EQL file'
                                ),
                                $table
                            );
                        }
                    }
                }

                // check for and process to rebuild new forms module data table
                if (!empty($newformdata)) {
                    foreach ($newformdata as $tablename => $tabledata) {
                        $newform = $db->selectObject('forms', 'table_name=\'' . substr($tablename, 6) . '\'');
                        if (!empty($newform)) {
                            // create the new table
                            $form = new forms($newform->id);
                            $table = $form->updateTable();

                            // populate the table
                            foreach ($tabledata as $record) {
                                $record = str_replace('\r\n', "\r\n", $record);
                                $object = @unserialize($record);
                                if (!$object) {
                                    $object = unserialize(stripslashes($record));
                                }
                                if (is_object($object)) {
//                                $db->insertObject($object, 'forms_' . $table);
                                    $form->insertRecord($object);
                                }
                            }
                            $errors[] = sprintf(
                                gt('*  However...we successfully recreated the "forms_%s" Table from the EQL file'),
                                $table
                            );
                        }
                    }
                }

                // ensure the form data table exists and is current
//            foreach ($db->selectObjects('forms') as $f) {
//                if ($f->is_saved) $f->updateTable();
//            }
                $formmodel = new forms();
                $forms = $formmodel->find('all');
                foreach ($forms as $f) {
                    if ($f->is_saved) {
                        $f->updateTable();
                    }
                }

                // rename mixed case tables if necessary
                expDatabase::fix_table_names();
//            if ($eql_version != $current_version) {
//                $errors[] = gt('EQL file was Not a valid EQL version');
//                return false;
//            }
                return true;
            } else {
                $errors[] = gt('Unable to read EQL file');
                return false;
            }
        } else {
            $errors[] = gt('Unable to find EQL file');
            return false;
        }
    }

    /** exdoc
     * This function reads a database EQL object dump file and returns an array of the
     * database tables and records, or false if something went horribly wrong
     * (unable to read file, etc.)  Even if an array is returned, there is a chance
     * that some errors were encountered.  Check $errors to be sure everything
     * was fine.
     *
     * @param string            $file   The filename of the EQL file to parse
     * @param array             $errors A referenced array that stores errors.  Whatever
     *                                  variable is passed in this argument will contain all errors encountered
     *                                  during the parse/restore.
     * @param null/string/array $type   The list of tables to return, empty = entire file
     * @return array|boolean
     * @node     Model:expFile
     */
    public static function parseDatabase($file, &$errors, $type = null) {
//        $errors = array();
        $data = array();

        if (is_readable($file)) {
            $lines = @file($file);  //FIXME we may have to change this for handling large files via fgets()...see dumpDatabase() above

            // Sanity check
            if (count($lines) < 2 || trim($lines[0]) != EQL_HEADER) {
                $errors[] = gt('Not a valid EQL file');
                return false;
            }

            $version = explode(':', trim($lines[1]));
            $eql_version = $version[1] + 0;
            $current_version = EXPONENT + 0;
            if ((array_key_exists(2, $version) && $type == null) || (array_key_exists(2, $version) && $version[2] != $type)) {
                $eql_version = 0;  // trying to import wrong eql type
            }

            // Check version and include necessary converters
            if ($eql_version != $current_version) {
                $errors[] = gt('EQL file was Not a valid EQL version');
                return false;
            }

            $table = '';
            for ($i = 2, $iMax = count($lines); $i < $iMax; $i++) {
                $line_number = $i;
                $line = trim($lines[$i]);
                if ($line != '') {
                    $pair = explode(':', $line);
                    $pair[1] = implode(':', array_slice($pair, 1));
                    $pair = array_slice($pair, 0, 2);

                    if ($pair[0] === 'TABLE') {
                        $table = $pair[1];
                        $data[$table] = new stdClass();
                        $data[$table]->name = $table;
                        $data[$table]->records = array();
                    } else if ($pair[0] === 'TABLEDEF') {  // new in v2.1.4, re-create a missing table
                        $pair[1] = str_replace('\r\n', "\r\n", $pair[1]);
                        $tabledef = @unserialize($pair[1]);
                        $data[$table]->tabledef = $tabledef;
                    } else if ($pair[0] === 'RECORD') {
                        // Here we need to check the conversion scripts.
                        $pair[1] = str_replace('\r\n', "\r\n", $pair[1]);
//						$object = expUnserialize($pair[1]);
                        $object = @unserialize($pair[1]);
                        if (!$object) $object = unserialize(stripslashes($pair[1]));
                        if (is_object($object)) {
                            $data[$table]->records[] = object2Array($object);  //FIXME should we convert this? object2array?
                        } else {
                            $errors[] = sprintf(gt("Unable to decipher '%s' record (line %d)"), $pair[0], $line_number);
                        }
                    } else {
                        $errors[] = sprintf(gt("Invalid specifier type '%s' (line %d)"), $pair[0], $line_number);
                    }
                }
            }

            if (!empty($type)) {
                if (!is_array($type)) $type = array($type);
                foreach ($data as $key=>$tbl) {
                    if (!in_array($key, $type)) {
                        unset($data[$key]);
                    }
                }
            }
            return $data;
        } else {
            $errors[] = gt('Unable to read EQL file');
            return false;
        }
    }

    /**
     * recreates a deprecated formbuilder data table
     * needed to import form data from eql file exported prior to v2.1.4
     * this is just the old formbuilder_form::updateTable method
     *
     * @static
     * @param $object
     * @return mixed
     */
    static function updateFormbuilderTable($object) {
		global $db;

		if (!empty($object->is_saved)) {
			$datadef =  array(
				'id'=>array(
					DB_FIELD_TYPE=>DB_DEF_ID,
					DB_PRIMARY=>true,
					DB_INCREMENT=>true),
				'ip'=>array(
					DB_FIELD_TYPE=>DB_DEF_STRING,
					DB_FIELD_LEN=>25),
				'referrer'=>array(
					DB_FIELD_TYPE=>DB_DEF_STRING,
					DB_FIELD_LEN=>1000),
				'timestamp'=>array(
					DB_FIELD_TYPE=>DB_DEF_TIMESTAMP),
				'user_id'=>array(
					DB_FIELD_TYPE=>DB_DEF_ID)
			);

			if (!isset($object->id)) {
				$object->table_name = preg_replace('/[^A-Za-z0-9]/','_',$object->name);
				$tablename = 'formbuilder_'.$object->table_name;
				$index = '';
				while ($db->tableExists($tablename . $index)) {
					$index++;
				}
				$tablename = $tablename.$index;
				$db->createTable($tablename,$datadef,array());
				$object->table_name .= $index;
			} else {
				if ($object->table_name == '') {
					$tablename = preg_replace('/[^A-Za-z0-9]/','_',$object->name);
					$index = '';
					while ($db->tableExists('formbuilder_' . $tablename . $index)) {
						$index++;
					}
					$object->table_name = $tablename . $index;
				}

				$tablename = 'formbuilder_' . $object->table_name;

				//If table is missing, create a new one.
				if (!$db->tableExists($tablename)) {
					$db->createTable($tablename,$datadef,array());
				}

				$ctl = null;
				$control_type = '';
				$tempdef = array();
				foreach ($db->selectObjects('formbuilder_control','form_id='.$object->id) as $control) {
					if ($control->is_readonly == 0) {
						$ctl = unserialize($control->data);
						$ctl->identifier = $control->name;
						$ctl->caption = $control->caption;
						$ctl->id = $control->id;
						$control_type = get_class($ctl);
						$def = call_user_func(array($control_type,'getFieldDefinition'));
						if ($def != null) {
							$tempdef[$ctl->identifier] = $def;
						}
					}
				}
				$datadef = array_merge($datadef,$tempdef);
				$db->alterTable($tablename,$datadef,array(),true);
			}
		}
		return $object->table_name;
	}

}

?>
