chamilo-lms2/main/inc/lib/fileManage.lib.php

<?php
/* For licensing terms, see /license.txt */
/**
 *	This is the file manage library for Chamilo.
 *	Include/require it in your code to use its functionality.
 *	@package chamilo.library
 */

/**
 * Update the file or directory path in the document db document table
 *
 * @author - Hugues Peeters <peeters@ipm.ucl.ac.be>
 * @param  - action (string) - action type require : 'delete' or 'update'
 * @param  - old_path (string) - old path info stored to change
 * @param  - new_path (string) - new path info to substitute
 * @desc Update the file or directory path in the document db document table
 *
 */
function update_db_info($action, $old_path, $new_path = '')
{
    $dbTable = Database::get_course_table(TABLE_DOCUMENT);
    $course_id = api_get_course_int_id();
    switch ($action) {
        case 'delete':
            $old_path = Database::escape_string($old_path);
            $query = "DELETE FROM $dbTable
                      WHERE
                        c_id = $course_id AND
                        (
                            path LIKE BINARY '".$old_path."' OR
                            path LIKE BINARY '".$old_path."/%'
                        )";
            Database::query($query);
            break;
        case 'update':
            if ($new_path[0] == '.') $new_path = substr($new_path, 1);
            $new_path = str_replace('//', '/', $new_path);

            // Attempt to update	- tested & working for root	dir
            $new_path = Database::escape_string($new_path);
            $query = "UPDATE $dbTable SET
                        path = CONCAT('".$new_path."', SUBSTRING(path, LENGTH('".$old_path."')+1) )
                      WHERE c_id = $course_id AND (path LIKE BINARY '".$old_path."' OR path LIKE BINARY '".$old_path."/%')";
            Database::query($query);
            break;
    }
}

/**
 * Cheks a file or a directory actually exist at this location
 *
 * @author - Hugues Peeters <peeters@ipm.ucl.ac.be>
 * @param  - file_path (string) - path of the presume existing file or dir
 * @return - boolean TRUE if the file or the directory exists
 *           boolean FALSE otherwise.
 */
function check_name_exist($file_path) {
    clearstatcache();
    $save_dir = getcwd();
    if (!is_dir(dirname($file_path))) {
        return false;
    }
    chdir(dirname($file_path));
    $file_name = basename($file_path);

    if (file_exists($file_name)) {
        chdir($save_dir);
        return true;
    } else {
        chdir($save_dir);
        return false;
    }
}

/**
 * Deletes a file or a directory
 *
 * @author - Hugues Peeters
 * @param  $file (String) - the path of file or directory to delete
 * @return boolean - true if the delete succeed, false otherwise.
 * @see    - delete() uses check_name_exist() and removeDir() functions
 */
function my_delete($file)
{
    if (check_name_exist($file)) {
        if (is_file($file)) { // FILE CASE
            unlink($file);
            return true;
        } elseif (is_dir($file)) { // DIRECTORY CASE
            removeDir($file);
            return true;
        }
    } else {
        return false; // no file or directory to delete
    }
}

/**
 * Removes a directory recursively
 *
 * @returns true if OK, otherwise false
 *
 * @author Amary <MasterNES@aol.com> (from Nexen.net)
 * @author Olivier Brouckaert <oli.brouckaert@skynet.be>
 *
 * @param string	$dir		directory to remove
 */
function removeDir($dir)
{
    if (!@$opendir = opendir($dir)) {
        return false;
    }

    while ($readdir = readdir($opendir)) {
        if ($readdir != '..' && $readdir != '.') {
            if (is_file($dir.'/'.$readdir)) {
                if (!@unlink($dir.'/'.$readdir)) {
                    return false;
                }
            } elseif (is_dir($dir.'/'.$readdir)) {
                if (!removeDir($dir.'/'.$readdir)) {
                    return false;
                }
            }
        }
    }

    closedir($opendir);

    if (!@rmdir($dir)) {
        return false;
    }

    return true;
}

/**
 * Return true if folder is empty
 * @author : hubert.borderiou@grenet.fr
 * @param string $in_folder : folder path on disk
 * @return 1 if folder is empty, 0 otherwise
*/
function folder_is_empty($in_folder)
{
    $folder_is_empty = 0;
    if (is_dir($in_folder)) {
        $tab_folder_content = scandir($in_folder);
        if ((count($tab_folder_content) == 2 &&
            in_array(".", $tab_folder_content) &&
            in_array("..", $tab_folder_content)
            ) ||
            (count($tab_folder_content) < 2)
        ) {
            $folder_is_empty = 1;
        }
    }

    return $folder_is_empty;
}

/**
 * Renames a file or a directory
 *
 * @author - Hugues Peeters <peeters@ipm.ucl.ac.be>
 * @param  - $file_path (string) - complete path of the file or the directory
 * @param  - $new_file_name (string) - new name for the file or the directory
 * @return - boolean - true if succeed
 *         - boolean - false otherwise
 * @see    - rename() uses the check_name_exist() and php2phps() functions
 */
function my_rename($file_path, $new_file_name) {

	$save_dir = getcwd();
	$path = dirname($file_path);
	$old_file_name = basename($file_path);
	$new_file_name = api_replace_dangerous_char($new_file_name);

	// If no extension, take the old one
	if ((strpos($new_file_name, '.') === false) && ($dotpos = strrpos($old_file_name, '.'))) {
		$new_file_name .= substr($old_file_name, $dotpos);
	}

	// Note: still possible: 'xx.yy' -rename-> '.yy' -rename-> 'zz'
	// This is useful for folder names, where otherwise '.' would be sticky

	// Extension PHP is not allowed, change to PHPS
	$new_file_name = php2phps($new_file_name);

	if ($new_file_name == $old_file_name) {
		return $old_file_name;
	}

	if (strtolower($new_file_name) != strtolower($old_file_name) && check_name_exist($path.'/'.$new_file_name)) {
		return false;
	}
	// On a Windows server, it would be better not to do the above check
	// because it succeeds for some new names resembling the old name.
	// But on Unix/Linux the check must be done because rename overwrites.

	chdir($path);
	$res = rename($old_file_name, $new_file_name) ? $new_file_name : false;
	chdir($save_dir);
	return $res;
}

/**
 * Moves a file or a directory to an other area
 *
 * @author - Hugues Peeters <peeters@ipm.ucl.ac.be>
 * @param  - $source (String) - the path of file or directory to move
 * @param  - $target (String) - the path of the new area
 * @param  bool $forceMove Whether to force a move or to make a copy (safer but slower) and then delete the original
 * @param	bool $moveContent In some cases (including migrations), we need to move the *content* and not the folder itself
 * @return - bolean - true if the move succeed
 *           bolean - false otherwise.
 * @see    - move() uses check_name_exist() and copyDirTo() functions
 */
function move($source, $target, $forceMove = false, $moveContent = false)
{
	if (check_name_exist($source)) {
		$file_name = basename($source);
        $isWindowsOS = api_is_windows_os();
        $canExec = function_exists('exec');

		/* File case */
		if (is_file($source)) {
			if ($forceMove && !$isWindowsOS && $canExec) {
				exec('mv ' . $source . ' ' . $target . '/' . $file_name);
			} else {
				copy($source, $target . '/' . $file_name);
				unlink($source);
			}
			return true;
		} elseif (is_dir($source)) {
			/* Directory */
			if ($forceMove && !$isWindowsOS && $canExec) {
				if ($moveContent) {
					$base = basename($source);
					exec('mv '.$source.'/* '.$target.$base.'/');
					exec('rm -rf '.$source);
				} else {
					exec('mv $source $target');
				}
			} else {
				copyDirTo($source, $target);
			}
			return true;
		}
	} else {
		return false;
	}
}

/**
 * Moves a directory and its content to an other area
 *
 * @author - Hugues Peeters <peeters@ipm.ucl.ac.be>
 * @param  - $orig_dir_path (string) - the path of the directory to move
 * @param  - $destination (string) - the path of the new area
 * @return - no return
 */
function copyDirTo($orig_dir_path, $destination, $move = true)
{
    $fs = new \Symfony\Component\Filesystem\Filesystem();
    if (is_dir($orig_dir_path)) {
        $fs->mirror($orig_dir_path, $destination);

        if ($move) {
            $fs->remove($orig_dir_path);
        }
    }
}


/**
 * Extracting extention of a filename
 *
 * @returns array
 * @param 	string	$filename 		filename
 */
function getextension($filename) {
	$bouts = explode('.', $filename);
	return array(array_pop($bouts), implode('.', $bouts));
}

/*	CLASS FileManager */

/**
	This class contains functions that you can access statically.

	FileManager::list_all_directories($path)
	FileManager::list_all_files($dir_array)
	FileManager::compat_load_file($file_name)
	FileManager::set_default_settings($upload_path, $filename, $filetype="file", $glued_table, $default_visibility='v')

	@author Roan Embrechts
	@version 1.1, July 2004
 *	@package chamilo.library
*/
class FileManager
{
	/**
		Returns a list of all directories, except the base dir,
		of the current course. This function uses recursion.

		Convention: the parameter $path does not end with a slash.

		@author Roan Embrechts
		@version 1.0.1
	*/
	function list_all_directories($path)
    {
		$result_array = array();
		if (is_dir($path)) {
			$save_dir = getcwd();
			chdir($path);
			$handle = opendir($path);
			while ($element = readdir($handle)) {
				if ($element == '.' || $element == '..') continue;
                // Skip the current and parent directories
				if (is_dir($element)) {
					$dir_array[] = $path.'/'.$element;
				}
			}
			closedir($handle);
			// Recursive operation if subdirectories exist
			$dir_number = sizeof($dir_array);
			if ($dir_number > 0) {
				for ($i = 0 ; $i < $dir_number ; $i++) {
					$sub_dir_array = FileManager::list_all_directories($dir_array[$i]); // Function recursivity
					if (is_array($dir_array) && is_array($sub_dir_array)) {
						$dir_array  =  array_merge($dir_array, $sub_dir_array); // Data merge
					}
				}
			}
			$result_array  =  $dir_array;
			chdir($save_dir) ;
		}
		return $result_array ;
	}

	/**
		This function receives a list of directories.
		It returns a list of all files in these directories

		@author Roan Embrechts
		@version 1.0
	*/
	function list_all_files($dir_array)
    {
		$element_array = array();
		if (is_dir($dir_array)) {

			$save_dir = getcwd();
			foreach ($dir_array as $directory) {
				chdir($directory);
				$handle = opendir($directory);
			   	while ($element = readdir($handle)) {
					if ($element == '.' || $element == '..' || $element == '.htaccess') continue;
                    // Skip the current and parent directories
					if (!is_dir($element)) {
						$element_array[] = $directory.'/'.$element;
					}
				}
				closedir($handle);
				chdir('..');
				chdir($save_dir);
			}
		}

		return $element_array;
	}

	/**
		Loads contents of file $filename into memory and returns them as a string.
		Function kept for compatibility with older PHP versions.
		Function is binary safe (is needed on Windows)
	*/
	function compat_load_file($file_name)
    {
		$buffer = '';
		if (file_exists($file_name)) {
			$fp = fopen($file_name, 'rb');
			$buffer = fread ($fp, filesize($file_name));
			fclose ($fp);
		}
		return $buffer;
	}

	/**
	 * Adds file/folder to document table in database
	 * improvement from set_default_settings (see below):
	 * take all info from function parameters
	 * no global variables needed
	 *
	 * NOTE $glued_table should already have backticks around it
	 * (get it from the database library, and it is done automatically)
	 *
	 * @param	path, filename, filetype,
				$glued_table, default_visibility

	 * action:	Adds an entry to the document table with the default settings.
	 * @author	Olivier Cauberghe <olivier.cauberghe@ugent.be>
	 * @author	Roan Embrechts
	 * @version 1.2
	 */
	function set_default_settings($upload_path, $filename, $filetype = 'file', $glued_table, $default_visibility = 'v')
    {
		if (!$default_visibility) $default_visibility = 'v';

		// Make sure path is not wrongly formed
		$upload_path = !empty($upload_path) ? "/$upload_path" : '';

		$endchar = substr($filename, strlen($filename) - 1, 1);
		if ($endchar == "\\" || $endchar == '/') {
			$filename = substr($filename, 0, strlen($filename) - 1);
		}

		$full_file_name = $upload_path.'/'.$filename;
		$full_file_name = str_replace("//", '/', $full_file_name);

		$sql_query = "SELECT count(*) as number_existing FROM $glued_table WHERE path='$full_file_name'";
		$sql_result = Database::query($sql_query);
		$result = Database::fetch_array($sql_result);
		// Determine which query to execute
		if ($result['number_existing'] > 0) {
			// Entry exists, update
			$query = "UPDATE $glued_table SET path='$full_file_name',visibility='$default_visibility', filetype='$filetype'
			          WHERE path='$full_file_name'";
		} else {
			// No entry exists, create new one
			$query = "INSERT INTO $glued_table (path,visibility,filetype)
			          VALUES ('$full_file_name','$default_visibility','$filetype')";
		}
		Database::query($query);
	}
}

/**
 * Define the image to display for each file extension.
 * This needs an existing image repository to work.
 *
 * @author - Hugues Peeters <peeters@ipm.ucl.ac.be>
 * @param  - $file_name (string) - Name of a file
 * @return - The gif image to chose
 */
function choose_image($file_name)
{
	static $type, $image;

	/* TABLES INITIALISATION */
	if (!$type || !$image) {
		$type['word'] = array(
			'doc',
			'dot',
			'rtf',
			'mcw',
			'wps',
			'psw',
			'docm',
			'docx',
			'dotm',
			'dotx',
		);
		$type['web'] = array(
			'htm',
			'html',
			'htx',
			'xml',
			'xsl',
			'php',
			'xhtml',
		);
		$type['image'] = array(
			'gif',
			'jpg',
			'png',
			'bmp',
			'jpeg',
			'tif',
			'tiff',
		);
		$type['image_vect'] = array('svg', 'svgz');
		$type['audio'] = array(
			'wav',
			'mid',
			'mp2',
			'mp3',
			'midi',
			'sib',
			'amr',
			'kar',
			'oga',
			'au',
			'wma',
		);
		$type['video'] = array(
			'mp4',
			'mov',
			'rm',
			'pls',
			'mpg',
			'mpeg',
			'm2v',
			'm4v',
			'flv',
			'f4v',
			'avi',
			'wmv',
			'asf',
			'3gp',
			'ogv',
			'ogg',
			'ogx',
			'webm',
		);
		$type['excel'] = array(
			'xls',
			'xlt',
			'xls',
			'xlt',
			'pxl',
			'xlsx',
			'xlsm',
			'xlam',
			'xlsb',
			'xltm',
			'xltx',
		);
		$type['compressed'] = array('zip', 'tar', 'rar', 'gz');
		$type['code'] = array(
			'js',
			'cpp',
			'c',
			'java',
			'phps',
			'jsp',
			'asp',
			'aspx',
			'cfm',
		);
		$type['acrobat'] = array('pdf');
		$type['powerpoint'] = array(
			'ppt',
			'pps',
			'pptm',
			'pptx',
			'potm',
			'potx',
			'ppam',
			'ppsm',
			'ppsx',
		);
		$type['flash'] = array('fla', 'swf');
		$type['text'] = array('txt', 'log');
		$type['oo_writer'] = array('odt', 'ott', 'sxw', 'stw');
		$type['oo_calc'] = array('ods', 'ots', 'sxc', 'stc');
		$type['oo_impress'] = array('odp', 'otp', 'sxi', 'sti');
		$type['oo_draw'] = array('odg', 'otg', 'sxd', 'std');
		$type['epub'] = array('epub');
		$type['java'] = array('class', 'jar');
		$type['freemind'] = array('mm');

		$image['word'] = 'word.gif';
		$image['web'] = 'file_html.gif';
		$image['image'] = 'file_image.gif';
		$image['image_vect'] = 'file_svg.png';
		$image['audio'] = 'file_sound.gif';
		$image['video'] = 'film.gif';
		$image['excel'] = 'excel.gif';
		$image['compressed'] = 'file_zip.gif';
		$image['code'] = 'icons/22/mime_code.png';
		$image['acrobat'] = 'file_pdf.gif';
		$image['powerpoint'] = 'powerpoint.gif';
		$image['flash'] = 'file_flash.gif';
		$image['text'] = 'icons/22/mime_text.png';
		$image['oo_writer'] = 'file_oo_writer.gif';
		$image['oo_calc'] = 'file_oo_calc.gif';
		$image['oo_impress'] = 'file_oo_impress.gif';
		$image['oo_draw'] = 'file_oo_draw.gif';
		$image['epub'] = 'file_epub.gif';
		$image['java'] = 'file_java.png';
		$image['freemind'] = 'file_freemind.png';
	}

	$extension = array();
	if (!is_array($file_name)) {
		if (preg_match('/\.([[:alnum:]]+)(\?|$)/', $file_name, $extension)) {
			$extension[1] = strtolower($extension[1]);

			foreach ($type as $generic_type => $extension_list) {
				if (in_array($extension[1], $extension_list)) {
					return $image[$generic_type];
				}
			}
		}
	}

	return 'defaut.gif';
}


/**
 * Transform a UNIX time stamp in human readable format date.
 *
 * @author - Hugues Peeters <peeters@ipm.ucl.ac.be>
 * @param  - $date - UNIX time stamp
 * @return - A human readable representation of the UNIX date
 */
function format_date($date)
{
	return date('d.m.Y', $date);
}

/**
 * Transform the file path to a URL.
 *
 * @param  - $file_path (string) - Relative local path of the file on the hard disk
 * @return - Relative url
 */
function format_url($file_path)
{
	$path_component = explode('/', $file_path);
	$path_component = array_map('rawurlencode', $path_component);

	return implode('/', $path_component);
}

/**
 * Get the most recent time the content of a folder was changed.
 *
 * @param  - $dir_name (string)   - Path of the dir on the hard disk
 * @param  - $do_recursive (bool) - Traverse all folders in the folder?
 * @return - Time the content of the folder was changed
 */
function recent_modified_file_time($dir_name, $do_recursive = true)
{
	$dir = dir($dir_name);
	$last_modified = 0;
	$return = 0;
	if (is_dir($dir)) {
		while(($entry = $dir->read()) !== false)
		{
			if ($entry != '.' && $entry != '..')
				continue;

			if (!is_dir($dir_name.'/'.$entry))
				$current_modified = filemtime($dir_name.'/'.$entry);
			elseif ($do_recursive)
				$current_modified = recent_modified_file_time($dir_name.'/'.$entry, true);

			if ($current_modified > $last_modified)
				$last_modified = $current_modified;
		}

		$dir->close();
		//prevents returning 0 (for empty directories)
		$return = ($last_modified == 0) ? filemtime($dir_name) : $last_modified;
	}

	return $return;
}

/**
 * Get the total size of a directory.
 *
 * @param  - $dir_name (string) - Path of the dir on the hard disk
 * @return - Total size in bytes
 */
function folder_size($dir_name)
{
	$size = 0;
	if ($dir_handle = opendir($dir_name)) {
		while (($entry = readdir($dir_handle)) !== false) {
			if ($entry == '.' || $entry == '..') {
				continue;
			}

			if (is_dir($dir_name.'/'.$entry)) {
				$size += folder_size($dir_name.'/'.$entry);
			} else {
				$size += filesize($dir_name.'/'.$entry);
			}
		}

		closedir($dir_handle);
	}

	return $size;
}

/**
 * Calculates the total size of a directory by adding the sizes (that
 * are stored in the database) of all files & folders in this directory.
 *
 * @param 	string  $path
 * @param 	boolean $can_see_invisible
 * @return 	int Total size
 */
function get_total_folder_size($path, $can_see_invisible = false)
{
	$table_itemproperty = Database::get_course_table(TABLE_ITEM_PROPERTY);
	$table_document = Database::get_course_table(TABLE_DOCUMENT);
	$tool_document = TOOL_DOCUMENT;

	$course_id = api_get_course_int_id();
	$session_id = api_get_session_id();
	$session_condition = api_get_session_condition(
		$session_id,
		true,
		true,
		'props.session_id'
	);

	$visibility_rule = ' props.visibility ' . ($can_see_invisible ? '<> 2' : '= 1');

	$sql = "SELECT SUM(table1.size) FROM (
                SELECT size
                FROM $table_itemproperty AS props, $table_document AS docs
                WHERE
                    docs.c_id 	= $course_id AND
                    docs.id 	= props.ref AND
                    docs.path LIKE '$path/%' AND
                    props.c_id 	= $course_id AND
                    props.tool 	= '$tool_document' AND
                    $visibility_rule
                    $session_condition
                GROUP BY ref
            ) as table1";

	$result = Database::query($sql);
	if ($result && Database::num_rows($result) != 0) {
		$row = Database::fetch_row($result);

		return $row[0] == null ? 0 : $row[0];
	} else {
		return 0;
	}
}