file_system.inc

<?php
function get_file_type($filename)
{
    if (is_string($filename)) {
        return strtolower(  substr( strrchr($filename,'.') , 1)  );
    } else {
        return '';
    }

}//end get_file_type()


function is_image($filename)
{

    switch (get_file_type($filename)) {
        case 'jpg'  :
        case 'jpeg' :
        case 'gif'  :
        case 'png'  :
            return TRUE;
        default :
            return FALSE;
    } //end switch

}//end is_image()


function file_to_string($filename)
{
    if (!is_readable($filename)) return FALSE;
    return file_get_contents($filename);

}//end file_to_string()


function string_to_file($string, $filename)
{
    if (!is_string($filename) || empty($filename)) {
        return FALSE;
    }

    // this function writes into the files only in the existing directories
    // if directory doe snot exist then it returns false

    if (!is_dir(dirname($filename))) return FALSE;

    $tmp_filename = tempnam(dirname($filename), __FUNCTION__);
    if (!$f = fopen($tmp_filename, 'wb')) {
        trigger_error('Unable to open temporary file ('.$tmp_filename.') for writing, unable to write '.$filename, E_USER_WARNING);
        return FALSE;
    }
    $s = fputs($f, $string);
    fclose($f);
    if ($s === FALSE) {
        trigger_error('Unable to write '.$filename, E_USER_WARNING);
        unlink($tmp_filename);
        return FALSE;
    }

    $om = umask(0000);
    chmod($tmp_filename, 0664);
    umask($om);

    // if the file being renamed to exists, have to delete it because winnt doesn't overwrite on
    // rename
    if ((strtolower(PHP_OS) == 'winnt') || (strtolower(PHP_OS) == 'win32')) {
        // make sure we're using the latest info
        clearstatcache();

        if (file_exists($filename)) unlink($filename);
    }

    if (rename($tmp_filename, $filename)) {
        return TRUE;
    } else {
        unlink($tmp_filename);
        return FALSE;
    }

}//end string_to_file()


function array_to_file($value, $var_name, $filename)
{
    if (!is_array($value)) return FALSE;
    $string = '<?php $'.$var_name.' = '.var_export($value, TRUE).'; ?>';
    return string_to_file($string, $filename);

}//end array_to_file()


function easy_filesize($size)
{
    if ($size < 1024) {
        return $size.' Bytes';
    } else if ($size < 1048576) {
        return sprintf('%.1f KB', $size/1024.0);
    } else if ($size < 1073741824) {
        return sprintf('%.1f MB',($size/1024.0)/1024.0);
    } else {
        return sprintf('%.1f GB',(($size/1024.0)/1024.0)/1024.0);
    }

}//end easy_filesize()


function increment_filename($name,$spacer='')
{
    require_once dirname(__FILE__).'/../general/general.inc';
    if (strpos($name,'.') !== FALSE) {
        $ext = get_file_type($name);
        return increment_name(substr($name,0,-strlen($ext)-1),$spacer).'.'.$ext;
    } else {
        return increment_name($name, $spacer);
    }

}//end increment_filename()


function list_files($dir, $fullpath=FALSE)
{
    if (!$dir) return FALSE;
    if (is_dir($dir)) {
        $restrict = FALSE;
    } else {
        $restrict = basename(str_replace('*','',$dir)); // if we pass in *.inc, check for .inc
        $dir = dirname($dir);
    }

    if (!is_dir($dir)) return Array();

    $files = Array();
    if ($handle = opendir($dir)) {
        while (($file = readdir($handle)) !== FALSE) {
            if ($file == '.' || $file == '..') {
                continue;
            }
            if (is_file($dir.'/'.$file)) {
                if ($restrict && (preg_match("%$restrict%", $file))) {
                    $files[] = ($fullpath) ? $dir.'/'.$file : $file;
                }
                if (!$restrict) {
                    $files[] = ($fullpath) ? $dir.'/'.$file : $file;
                }
            }
        }
        closedir($handle);
    }
    return $files;

}//end list_files()


function list_dirs($dir, $fullpath=FALSE, $ignore_list=Array(), $recursive=FALSE)
{
    if (!is_dir($dir)) return Array();

    // if recursive we will be using fullpath
    if ($recursive) $fullpath = TRUE;

    array_push($ignore_list, '.', '..');

    $dirs = Array();
    if ($handle = opendir($dir)) {
        while (($subdir = readdir($handle)) !== FALSE) {
            if (!is_dir($dir.'/'.$subdir) || in_array($subdir, $ignore_list)) {
                continue;
            }
            $dirs[] = ($fullpath) ? $dir.'/'.$subdir : $subdir;
            if ($recursive) {
                $dirs = array_merge($dirs, list_dirs($dir.'/'.$subdir, $fullpath, $ignore_list, TRUE));
            }
        }
        closedir($handle);
    }
    return $dirs;

}//end list_dirs()


function create_directory($path)
{
    if ((!is_string($path) &&(!is_int($path))) || empty($path)) {
        return FALSE;
    }
    if (is_dir($path)) return TRUE;

    $old_umask = umask(0);
    if (!mkdir($path, 0775, TRUE)) {
        trigger_error('Unable to create directory: '.$path, E_USER_WARNING);
        clearstatcache();
        return FALSE;
    }

    umask($old_umask);
    clearstatcache();
    return TRUE;

}//end create_directory()


function delete_directory($path)
{
    $path  = rtrim($path, '/');
    if (!is_dir($path)) {
        trigger_error($path.' is not a directory (for deletion).', E_USER_WARNING);
        clearstatcache();
        return FALSE;
    }
    if (clear_directory($path)) {
        if (rmdir($path)) {
            clearstatcache();
            return TRUE;
        } else {
            trigger_error('Unable to delete dir: '.$path, E_USER_WARNING);
            clearstatcache();
            return FALSE;
        }
    }
    clearstatcache();
    return FALSE;

}//end delete_directory()


function clear_directory($path, $file_excl = Array())
{
    $path  = rtrim($path, '/');
    if (!is_dir($path)) {
        trigger_error($path.' is not a directory (for clearing).');
        clearstatcache();
        return FALSE;
    }
    $dir = opendir($path);
    while (FALSE !== ($filename = readdir($dir))) {
        if ($filename == '.' || $filename == '..' || in_array($filename, $file_excl)) {
            continue;
        }
        $filename = $path.'/'.$filename;
        if (is_dir($filename)) {
            delete_directory($filename);
        } else {
            if (!unlink($filename)) {
                trigger_error('Unable to delete: '.$filename, E_USER_WARNING);
                clearstatcache();
                return FALSE;
            }
        }
    }
    closedir($dir);
    clearstatcache();
    return TRUE;

}//end clear_directory()


function copy_directory($path, $new_path)
{
    $path     = rtrim($path, '/');
    $new_path = rtrim($new_path, '/');
    if (!is_dir($path)) {
        trigger_error($path.' is not a directory (for copying.)');
        clearstatcache();
        return FALSE;
    }
    if (file_exists($new_path)) {
        if (!is_dir($new_path)) {
            trigger_error($new_path.' exists but is not a directory (for copying into).');
            clearstatcache();
            return FALSE;
        }
    } else {
        if (!create_directory($new_path)) {
            clearstatcache();
            return FALSE;
        }
    }
    // Copy the contents
    $dir = opendir($path);
    while (FALSE !== ($filename = readdir($dir))) {
        if ($filename == '.' || $filename == '..') {
            continue;
        }
        $full_filename = $path.'/'.$filename;
        if (is_dir($full_filename)) {
            if (!copy_directory($full_filename, $new_path.'/'.$filename)) {
                clearstatcache();
                return FALSE;
            }
        } else {
            if (!copy($full_filename, $new_path.'/'.$filename)) {
                trigger_error('Unable to copy: '.$full_filename.' --> '.$new_path.'/'.$filename);
                clearstatcache();
                return FALSE;
            }
        }
    }
    closedir($dir);
    clearstatcache();
    return TRUE;

}//end copy_directory()


function copy_file($from, $to)
{
    if (!create_directory(dirname($to))) return FALSE;

    if (!copy($from, $to)) return FALSE;
    return TRUE;

}//end copy_file()


function move_file($from, $to)
{
    if (!copy_file($from, $to)) return FALSE;
    if (!unlink($from)) return FALSE;
    return TRUE;

}//end move_file()


function truncate_file($file)
{
    $fp = fopen($file, 'r+');
    if ($fp) {
        if (!ftruncate($fp, 0)) return FALSE;
        fclose($fp);
        return TRUE;
    }//end if
    return FALSE;

}//end truncate_file()


function get_last_lines_from_file($filepath, $max_lines=10, $line_ending="\n")
{
    // type verification
    if (!is_string($filepath) || !is_int($max_lines) || !is_string($line_ending)) {
        return Array();
    }

    $result = Array();
    $max_lines = is_int($max_lines) ? $max_lines : 10;

    if (!file_exists($filepath) || !is_readable($filepath)) {
        return FALSE;
    }

    if (!$handle = fopen($filepath, 'r')) return FALSE;

    // move pointer before the last character
    fseek($handle, -1, SEEK_END);
    $pos = ftell($handle);
    if ($pos === FALSE) return FALSE;

    $chars = 0;
    $current_word = NULL;
    $lines = Array();
    $line_count = 0;
    $ok = TRUE;

    do {
        $char = fgetc($handle);
        if (0 != fseek($handle, -2, SEEK_CUR)) $ok = FALSE;

        if ($char == $line_ending) {
            if (is_null($current_word)) {
                continue;
            } else {
                array_unshift($lines, $current_word);
                $line_count++;
                $current_word = NULL;
            }

        } else if ($char === FALSE) {
            $ok = FALSE;
            continue;

        } else {
            $current_word = $char.$current_word;
        }

        $chars++;
    } while ($max_lines > $line_count && $ok);

    if (!is_null($current_word) && $max_lines > $line_count) {
        array_unshift($lines, $current_word);
    }

    fclose($handle);

    return $lines;

}//end get_last_lines_from_file()


?>