/includes/class/download.class.php

<?php

/**
 * @Project NUKEVIET 3.0
 * @Author VINADES.,JSC (contact@vinades.vn)
 * @Copyright (C) 2010 VINADES.,JSC. All rights reserved
 * @Createdate 17/8/2010, 0:16
 */

/**********************************************************************
**
** A class to download files
** Version 1.0
** Features : 
**      - hide the real path to the file
**      - allow / disallow download resuming
**      - partial download (useful for download managers)
**      - rename the file on the fly
**      - limit download speed
**
** Author: Mourad Boufarguine / EPT <mourad.boufarguine@gmail.com>
**
** License: Public Domain
** Warranty: None
**
***********************************************************************/

/**
 * include("download.class.php");       // load the class file

 * $fichier = new download("example.zip");                          // use the original file name, disallow resuming, no speed limit                  
 * $fichier = new download("example.zip","My Example.zip") ;        // rename the file, disallow resuming, no speed limit
 * $fichier = new download("example.zip","My Example.zip",true) ;   // rename the file, allow resuming, no speed limit 
 * $fichier = new download("example.zip","My Example.zip",true,80) ;   // rename the file, allow resuming, speed limit 80ko/s

 * $fichier->download_file();
 */

if ( ! defined( 'NV_MAINFILE' ) ) die( 'Stop!!!' );

if ( ! defined( 'NV_ROOTDIR' ) )
{
    define( 'NV_ROOTDIR', preg_replace( "/[\/]+$/", '', str_replace( '\\', '/', realpath( dirname( __file__ ) . '/../../' ) ) ) );
}

if ( ! defined( 'NV_UPLOADS_REAL_DIR' ) )
{
    define( 'NV_UPLOADS_REAL_DIR', NV_ROOTDIR . '/uploads/' );
}

if ( ! defined( 'NV_MIME_INI_FILE' ) )
{
    define( "NV_MIME_INI_FILE", str_replace( "\\", "/", realpath( dirname( __file__ ) . "/.." ) . '/ini/mime.ini' ) );
}

if ( ! defined( 'ALLOWED_SET_TIME_LIMIT' ) )
{
    if ( $sys_info['allowed_set_time_limit'] )
    {
        define( 'ALLOWED_SET_TIME_LIMIT', true );
    }
}

/**
 * download
 * 
 * @package   
 * @author NUKEVIET 3.0
 * @copyright VINADES.,JSC
 * @version 2010
 * @access public
 */
class download
{

    private $properties = array( //
        "path" => "", //
        "name" => "", //
        "extension" => "", //
        "type" => "", //
        "size" => "", //
        "mtime" => 0, //
        "resume" => "", //
        "max_speed" => "", //
        "directory" => "" //
        );

    private $disable_functions = array();
    private $magic_path;

    /**
     * download::__construct()
     * 
     * @param mixed $path
     * @param string $name
     * @param bool $resume
     * @param integer $max_speed
     * @return
     */
    public function __construct( $path, $directory, $name = '', $resume = false, $max_speed = 0, $magic_path = '' )
    {
        $directory = $this->real_dir( $directory );
        if ( empty( $directory ) or ! is_dir( $directory ) )
        {
            $directory = NV_UPLOADS_REAL_DIR;
        }

        $path = $this->real_path( $path, $directory );
        $extension = $this->getextension( $path );
        $this->properties = array( //
            "path" => $path, //
            "name" => ( $name == "" ) ? substr( strrchr( "/" . $path, "/" ), 1 ) : $name, //
            "extension" => $extension, //
            "type" => $this->my_mime_content_type( $path ), //
            "size" => intval( sprintf( "%u", filesize( $path ) ) ), //
            "mtime" => ( $mtime = filemtime( $path ) ) > 0 ? $mtime : time(), //
            "resume" => $resume, //
            "max_speed" => $max_speed, //
            "directory" => $directory //
            );
        $this->disable_functions = ( ini_get( "disable_functions" ) != "" and ini_get( "disable_functions" ) != false ) ? array_map( 'trim', preg_split( "/[\s,]+/", ini_get( "disable_functions" ) ) ) : array();
        $this->magic_path = $magic_path;
    }

    /**
     * download::real_dir()
     * 
     * @param mixed $dir
     * @return
     */
    function real_dir( $dir )
    {
        if ( empty( $dir ) ) return false;
        $dir = realpath( $dir );
        if ( empty( $dir ) ) return false;
        $dir = str_replace( '\\', '/', $dir );
        $dir = rtrim( $dir, "\\/" );
        if ( ! preg_match( "/^(" . nv_preg_quote( NV_ROOTDIR ) . ")(\/[\S]+)/", $dir ) ) return false;
        return $dir;

    }

    /**
     * download::real_path()
     * 
     * @param mixed $path
     * @return
     */
    function real_path( $path, $dir )
    {
        if ( empty( $path ) or ! is_readable( $path ) or ! is_file( $path ) )
        {
            return false;
        }

        $realpath = realpath( $path );

        if ( empty( $realpath ) )
        {
            return false;
        }

        $realpath = str_replace( '\\', '/', $realpath );
        $realpath = rtrim( $realpath, "\\/" );

        if ( ! preg_match( "/^(" . nv_preg_quote( $dir ) . ")(\/[\S]+)/", $realpath ) )
        {
            return false;
        }

        return $realpath;
    }

    /**
     * download::func_exists()
     * 
     * @param mixed $funcName
     * @return
     */
    private function func_exists( $funcName )
    {
        return ( function_exists( $funcName ) and ! in_array( $funcName, $this->disable_functions ) );
    }

    /**
     * download::cl_exists()
     * 
     * @param mixed $clName
     * @return
     */
    private function cl_exists( $clName )
    {
        return ( class_exists( $clName ) and ! in_array( $clName, $this->disable_classes ) );
    }

    /**
     * download::getextension()
     * 
     * @param mixed $filename
     * @return
     */
    private function getextension( $filename )
    {
        if ( strpos( $filename, '.' ) === false ) return '';
        $filename = basename( strtolower( $filename ) );
        $filename = explode( '.', $filename );
        return array_pop( $filename );
    }

    /**
     * download::my_mime_content_type()
     * 
     * @param mixed $path
     * @return
     */
    private function my_mime_content_type( $path )
    {
        $mime = '';

        if ( $this->func_exists( 'finfo_open' ) )
        {
            if ( empty( $this->magic_path ) )
            {
                $finfo = finfo_open( FILEINFO_MIME );
            } elseif ( $this->magic_path != "auto" )
            {
                $finfo = finfo_open( FILEINFO_MIME, $this->magic_path );
            }
            else
            {
                if ( ( $magic = getenv( 'MAGIC' ) ) !== false )
                {
                    $finfo = finfo_open( FILEINFO_MIME, $magic );
                }
                else
                {
                    if ( substr( PHP_OS, 0, 3 ) == 'WIN' )
                    {
                        $path = realpath( ini_get( 'extension_dir' ) . '/../' ) . 'extras/magic';
                        $finfo = finfo_open( FILEINFO_MIME, $path );
                    }
                    else
                    {
                        $finfo = finfo_open( FILEINFO_MIME, '/usr/share/file/magic' );
                    }
                }
            }

            if ( is_resource( $finfo ) )
            {
                $mime = finfo_file( $finfo, realpath( $path ) );
                finfo_close( $finfo );
                $mime = preg_replace( "/^([\.-\w]+)\/([\.-\w]+)(.*)$/i", '$1/$2', trim( $mime ) );
            }
        }

        if ( empty( $mime ) or $mime == "application/octet-stream" )
        {
            if ( $this->cl_exists( "finfo" ) )
            {
                $finfo = new finfo( FILEINFO_MIME );
                if ( $finfo )
                {
                    $mime = $finfo->file( realpath( $path ) );
                    $mime = preg_replace( "/^([\.-\w]+)\/([\.-\w]+)(.*)$/i", '$1/$2', trim( $mime ) );
                }
            }
        }

        if ( empty( $mime ) or $mime == "application/octet-stream" )
        {
            if ( substr( PHP_OS, 0, 3 ) != 'WIN' )
            {
                if ( $this->func_exists( 'system' ) )
                {
                    ob_start();
                    system( "file -i -b " . escapeshellarg( $path ) );
                    $m = ob_get_clean();
                    $m = trim( $m );
                    if ( ! empty( $m ) )
                    {
                        $mime = preg_replace( "/^([\.-\w]+)\/([\.-\w]+)(.*)$/i", '$1/$2', $m );
                    }
                } elseif ( $this->func_exists( 'exec' ) )
                {
                    $m = @exec( "file -bi " . escapeshellarg( $path ) );
                    $m = trim( $m );
                    if ( ! empty( $m ) )
                    {
                        $mime = preg_replace( "/^([\.-\w]+)\/([\.-\w]+)(.*)$/i", '$1/$2', $m );
                    }
                }
            }
        }

        if ( empty( $mime ) or $mime == "application/octet-stream" )
        {
            if ( $this->func_exists( 'mime_content_type' ) )
            {
                $mime = mime_content_type( $path );
                $mime = preg_replace( "/^([\.-\w]+)\/([\.-\w]+)(.*)$/i", '$1/$2', trim( $mime ) );
            }
        }

        if ( empty( $mime ) or $mime == "application/octet-stream" )
        {
            $img_exts = array( 'png', 'gif', 'jpg', 'bmp', 'tiff', 'swf', 'psd' );
            if ( in_array( $this->properties['extension'], $img_exts ) )
            {
                if ( ( $img_info = @getimagesize( $path ) ) !== false )
                {
                    if ( array_key_exists( 'mime', $img_info ) and ! empty( $img_info['mime'] ) )
                    {
                        $mime = trim( $img_info['mime'] );
                        $mime = preg_replace( "/^([\.-\w]+)\/([\.-\w]+)(.*)$/i", '$1/$2', $mime );
                    }

                    if ( empty( $mime ) and isset( $img_info[2] ) )
                    {
                        $mime = image_type_to_mime_type( $img_info[2] );
                    }
                }
            }
        }

        if ( empty( $mime ) or $mime == "application/octet-stream" )
        {
            $mime_types = nv_parse_ini_file( NV_MIME_INI_FILE );

            if ( array_key_exists( $this->properties['extension'], $mime_types ) )
            {
                if ( is_string( $mime_types[$this->properties['extension']] ) ) return $mime_types[$this->properties['extension']];
                $mime = $mime_types[$this->properties['extension']][0];
            }
        }

        if ( preg_match( "/^application\/(?:x-)?zip(?:-compressed)?$/is", $mime ) )
        {
            if ( $this->properties['extension'] == "docx" ) $mime = "application/vnd.openxmlformats-officedocument.wordprocessingml.document";
            elseif ( $this->properties['extension'] == "dotx" ) $mime = "application/vnd.openxmlformats-officedocument.wordprocessingml.template";
            elseif ( $this->properties['extension'] == "potx" ) $mime = "application/vnd.openxmlformats-officedocument.presentationml.template";
            elseif ( $this->properties['extension'] == "ppsx" ) $mime = "application/vnd.openxmlformats-officedocument.presentationml.slideshow";
            elseif ( $this->properties['extension'] == "pptx" ) $mime = "application/vnd.openxmlformats-officedocument.presentationml.presentation";
            elseif ( $this->properties['extension'] == "xlsx" ) $mime = "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet";
            elseif ( $this->properties['extension'] == "xltx" ) $mime = "application/vnd.openxmlformats-officedocument.spreadsheetml.template";
            elseif ( $this->properties['extension'] == "docm" ) $mime = "application/vnd.ms-word.document.macroEnabled.12";
            elseif ( $this->properties['extension'] == "dotm" ) $mime = "application/vnd.ms-word.template.macroEnabled.12";
            elseif ( $this->properties['extension'] == "potm" ) $mime = "application/vnd.ms-powerpoint.template.macroEnabled.12";
            elseif ( $this->properties['extension'] == "ppam" ) $mime = "application/vnd.ms-powerpoint.addin.macroEnabled.12";
            elseif ( $this->properties['extension'] == "ppsm" ) $mime = "application/vnd.ms-powerpoint.slideshow.macroEnabled.12";
            elseif ( $this->properties['extension'] == "pptm" ) $mime = "application/vnd.ms-powerpoint.presentation.macroEnabled.12";
            elseif ( $this->properties['extension'] == "xlam" ) $mime = "application/vnd.ms-excel.addin.macroEnabled.12";
            elseif ( $this->properties['extension'] == "xlsb" ) $mime = "application/vnd.ms-excel.sheet.binary.macroEnabled.12";
            elseif ( $this->properties['extension'] == "xlsm" ) $mime = "application/vnd.ms-excel.sheet.macroEnabled.12";
            elseif ( $this->properties['extension'] == "xltm" ) $mime = "application/vnd.ms-excel.template.macroEnabled.12";
        }

        return ! empty( $mime ) ? $mime : 'application/force-download';
    }

    /**
     * download::nv_getenv()
     * 
     * @param mixed $key
     * @return
     */
    private function nv_getenv( $key )
    {
        if ( isset( $_SERVER[$key] ) )
        {
            return $_SERVER[$key];
        } elseif ( isset( $_ENV[$key] ) )
        {
            return $_ENV[$key];
        } elseif ( @getenv( $key ) )
        {
            return @getenv( $key );
        } elseif ( function_exists( 'apache_getenv' ) && apache_getenv( $key, true ) )
        {
            return apache_getenv( $key, true );
        }
        return "";
    }

    /**
     * download::get_property()
     * 
     * @param mixed $property
     * @return
     */
    public function get_property( $property )
    {
        if ( array_key_exists( $property, $this->properties ) ) return $this->properties[$property];

        else  return null;

    }

    /**
     * download::set_property()
     * 
     * @param mixed $property
     * @param mixed $value
     * @return
     */
    public function set_property( $property, $value )
    {
        if ( array_key_exists( $property, $this->properties ) )
        {

            $this->properties[$property] = $value;

            return true;
        }
        else  return false;
    }

    /**
     * download::download_file()
     * 
     * @return
     */
    public function download_file()
    {
        if ( ! $this->properties['path'] )
        {
            die( "Nothing to download!" );
        }

        $seek_start = 0;
        $seek_end = -1;
        $data_section = false;

        if ( ( $http_range = nv_getenv( 'HTTP_RANGE' ) ) != "" )
        {
            $seek_range = substr( $http_range, strlen( 'bytes=' ) );

            $range = explode( '-', $seek_range );

            if ( ! empty( $range[0] ) )
            {
                $seek_start = intval( $range[0] );
            }

            if ( isset( $range[1] ) and ! empty( $range[1] ) )
            {
                $seek_end = intval( $range[1] );
            }

            if ( ! $this->properties['resume'] )
            {
                $seek_start = 0;
            }
            else
            {
                $data_section = true;
            }
        }

        if ( @ob_get_length() )
        {
            @ob_end_clean();
        }
        $old_status = ignore_user_abort( true );
        if ( defined( 'ALLOWED_SET_TIME_LIMIT' ) )
        {
            set_time_limit( 0 );
        }

        if ( $seek_start > ( $this->properties['size'] - 1 ) )
        {
            $seek_start = 0;
        }

        $res = fopen( $this->properties['path'], 'rb' );

        if ( ! $res )
        {
            die( 'File error' );
        }

        if ( $seek_start ) fseek( $res, $seek_start );
        if ( $seek_end < $seek_start )
        {
            $seek_end = $this->properties['size'] - 1;
        }

        header( "Pragma: public" );
        header( "Expires: 0" );
        header( "Cache-Control:" );
        header( "Cache-Control: public" );
        header( "Content-Description: File Transfer" );
        header( "Content-Type: " . $this->properties['type'] );
        if ( strstr( $this->nv_getenv( 'HTTP_USER_AGENT' ), "MSIE" ) != false )
        {
            header( 'Content-Disposition: attachment; filename="' . urlencode( $this->properties['name'] ) . '";' );
        }
        else
        {
            header( 'Content-Disposition: attachment; filename="' . $this->properties['name'] . '";' );
        }
        header( 'Last-Modified: ' . date( 'D, d M Y H:i:s \G\M\T', $this->properties['mtime'] ) );

        if ( $data_section and $this->properties['resume'] )
        {
            header( "HTTP/1.1 206 Partial Content" );
            header( "Status: 206 Partial Content" );
            header( 'Accept-Ranges: bytes' );
            header( "Content-Range: bytes " . $seek_start . "-" . $seek_end . "/" . $this->properties['size'] );
            header( "Content-Length: " . ( $seek_end - $seek_start + 1 ) );
        }
        else
        {
            header( "Content-Length: " . $this->properties['size'] );
        }

        if ( function_exists( 'usleep' ) and ! in_array( 'usleep', $this->disable_functions ) and ( $speed = $this->properties['max_speed'] ) > 0 )
        {
            $sleep_time = ( 8 / $speed ) * 1e6;
        }
        else
        {
            $sleep_time = 0;
        }

        while ( ! ( connection_aborted() or connection_status() == 1 ) and ! feof( $res ) )
        {
            print ( fread( $res, 1024 * 8 ) );
            flush();
            if ( $sleep_time > 0 )
            {
                usleep( $sleep_time );
            }
        }
        fclose( $res );

        ignore_user_abort( $old_status );
        if ( defined( 'ALLOWED_SET_TIME_LIMIT' ) )
        {
            set_time_limit( ini_get( "max_execution_time" ) );
        }
        exit();
    }
}

?>