m_zip.php

<?php

// M-ZIP Library: unzipping files using command line tools
//
// Feel free to use, modify and distribute this but please keep this note intact
// (you may add at the bottom)
// Please if you make modifications, fix bugs, etc... let me know!
//
//
// Original author: Francesco M. Munafo'
//
// EMail: phpDev (AT) eSurfers (DOT) com
// Download latest at http://eSurfers.com/m-lib/
//
// Modified for ocPortal. This file remains copyright to Francesco.
/*EXTRA FUNCTIONS: shell_exec*/

/**
 * @copyright	Francesco M. Munafo'
 * @package core
 */

/**
 * Standard code module initialisation function.
 */
function init__m_zip()
{
	$ud=get_option('unzip_dir');
	if (substr($ud,-1)=='/') $ud=substr($ud,0,strlen($ud)-1);
	define('UNZIP_DIR',$ud);
	define('UNZIP_CMD',get_option('unzip_cmd'));

	if (!function_exists('zip_open'))
{

if (substr(phpversion(),0,2)!='4.') eval("class ZIPARCHIVE
{
	const ER_OK=0;  /* N No error */
	const ER_MULTIDISK=1;  /* N Multi-disk zip archives not supported */
	const ER_RENAME=2;  /* S Renaming temporary file failed */
	const ER_CLOSE=3;  /* S Closing zip archive failed */
	const ER_SEEK=4;  /* S Seek error */
	const ER_READ=5;  /* S Read error */
	const ER_WRITE=6;  /* S Write error */
	const ER_CRC=7;  /* N CRC error */
	const ER_ZIPCLOSED=8;  /* N Containing zip archive was closed */
	const ER_NOENT=9;  /* N No such file */
	const ER_EXISTS=10;  /* N File already exists */
	const ER_OPEN=11;  /* S Can't open file */
	const ER_TMPOPEN=12;  /* S Failure to create temporary file */
	const ER_ZLIB=13;  /* Z Zlib error */
	const ER_MEMORY=14;  /* N Malloc failure */
	const ER_CHANGED=15;  /* N Entry has been changed */
	const ER_COMPNOTSUPP=16;  /* N Compression method not supported */
	const ER_EOF=17;  /* N Premature EOF */
	const ER_INVAL=18;  /* N Invalid argument */
	const ER_NOZIP=19;  /* N Not a zip archive */
	const ER_INTERNAL=20;  /* N Internal error */
	const ER_INCONS=21;  /* N Zip archive inconsistent */
	const ER_REMOVE=22;  /* S Can't remove file */
	const ER_DELETED=23;  /* N Entry has been deleted */
}
");

/**
 * Open a zip file for reading.
 *
 * @param  PATH			The zip file path
 * @return mixed			The zip file resource (number if error)
 */
function zip_open($zip_file)
{
	global $M_ZIP_DIR_HANDLES,$M_ZIP_DIR_OPEN_PATHS;

	if (function_exists('set_time_limit')) @set_time_limit(200);

	list($usec,$sec)=explode(' ',microtime(false));
	$id=strval(intval($sec)-1007700000).str_pad(strval(intval($usec)*1000000),6,'0',STR_PAD_LEFT).str_pad(strval(mt_rand(0,999)),3,'0',STR_PAD_LEFT);

	$_m_zip_open_file=explode('/',str_replace("\\",'/',$zip_file));
	$m_zip_open_file='Z'.$id.$_m_zip_open_file[count($_m_zip_open_file)-1];

	$zip_dir=UNZIP_DIR.'/'.$m_zip_open_file.'/';

	mkdir($zip_dir,0777);

	$unzip_cmd=UNZIP_CMD;
	$unzip_cmd=str_replace('@_SRC_@','"'.$zip_file.'"',$unzip_cmd);
	$unzip_cmd=str_replace('@_DST_@','"'.$zip_dir.'"',$unzip_cmd);

	$bits=explode(' ',UNZIP_CMD);
	if (!@file_exists(array_shift($bits)))
	{
		$_config_url=build_url(array('page'=>'admin_config','type'=>'category','id'=>'SITE'),get_module_zone('admin_config'));
		$config_url=$_config_url->evaluate();
		$config_url.='#group_ARCHIVES';

		attach_message(do_lang_tempcode('NO_SHELL_ZIP_POSSIBLE2',escape_html($config_url)),'warn');

		return constant('ZIPARCHIVE::ER_INTERNAL');
	}

	$res=-1; // any nonzero value
	$unused_array_result=array();
	if (strpos(@ini_get('disable_functions'),'shell_exec')!==false)
	{
		attach_message(do_lang_tempcode('NO_SHELL_ZIP_POSSIBLE'),'warn');

		return constant('ZIPARCHIVE::ER_INTERNAL');
	}
	$res=shell_exec($unzip_cmd);

	// IT IS IMPORTANT THAT YOUR COMMANDLINE ZUNZIP TOOL CORRECTLY SETS RESULT CODE
	// result code 0 == NO ERROR as in:
	if (is_null($res))
	{
		m_deldir($zip_dir);
		return constant('ZIPARCHIVE::ER_INTERNAL');
	}

	// OTHERWISE, you still have the option of parsing $unused_array_result to find clues of errors
	// (lines starting with or "inflating" mean no error)

	$m_zip_open_dirs=array(opendir($zip_dir));
	$m_zip_dir_paths=array($zip_dir);

	$M_ZIP_DIR_HANDLES[$zip_file]=false;
	unset($M_ZIP_DIR_HANDLES[$zip_file]);
	$M_ZIP_DIR_OPEN_PATHS[$zip_file]=false;
	unset($M_ZIP_DIR_OPEN_PATHS[$zip_file]);

	return array($zip_file,$m_zip_open_file,$m_zip_open_dirs,$m_zip_dir_paths);
}

/**
 * Close a zip file.
 *
 * @param  array			The zip file resource
 * @return boolean		Whether the file closed correctly
 */
function zip_close($open_zip_file)
{
	global $M_ZIP_DIR_HANDLES,$M_ZIP_DIR_OPEN_PATHS;

	$m_zip_original_file=$open_zip_file[0];
	$m_zip_open_file=$open_zip_file[1];
	$m_zip_open_dirs=$open_zip_file[2];

	$zip_dir=UNZIP_DIR.'/'.$m_zip_open_file.'/';


	$M_ZIP_DIR_HANDLES[$m_zip_original_file]=false;
	unset($M_ZIP_DIR_HANDLES[$m_zip_original_file]);
	$M_ZIP_DIR_OPEN_PATHS[$m_zip_original_file]=false;
	unset($M_ZIP_DIR_OPEN_PATHS[$m_zip_original_file]);

	if (is_dir($zip_dir))
	{
		foreach ($m_zip_open_dirs as $opendir) closedir($opendir);
		m_deldir($zip_dir);
	}
	$m_zip_open_file='';
	return true;
}

/**
 * Reads the next entry in a zip file archive.
 *
 * @param  array			The zip file resource
 * @return ~array			A directory entry resource for later use with the m_zip_entry_...() functions (false: if there's no more entries to read).
 */
function zip_read($open_zip_file)
{
	global $M_ZIP_DIR_HANDLES,$M_ZIP_DIR_OPEN_PATHS;

	$m_zip_original_file=$open_zip_file[0];
	$m_zip_open_file=$open_zip_file[1];


	// LOAD FILEHANDLES AND PATHS ARRAYS IF AVAILABLE

	if (array_key_exists($m_zip_original_file,$M_ZIP_DIR_HANDLES)) $m_zip_open_dirs=$M_ZIP_DIR_HANDLES[$m_zip_original_file];
	else $m_zip_open_dirs=$open_zip_file[2];

	if (array_key_exists($m_zip_original_file,$M_ZIP_DIR_OPEN_PATHS)) $m_zip_dir_paths=$M_ZIP_DIR_OPEN_PATHS[$m_zip_original_file];
	else $m_zip_dir_paths=$open_zip_file[3];



	$zip_dir=UNZIP_DIR.'/'.$m_zip_open_file.'/';

	$m_zip_last_open_dir=$m_zip_open_dirs[count($m_zip_open_dirs)-1];
	$m_zip_last_dir_path=$m_zip_dir_paths[count($m_zip_dir_paths)-1];

	$exit=false;
	do
	{
		$entryname=readdir($m_zip_last_open_dir);
		$exit=true;

		if ($entryname!==false)
		{
			$entrypath=$m_zip_last_dir_path.$entryname;
			if ($entryname=='.' || $entryname=='..')
			{
				$exit=false;
			} elseif (($entryname!==false) && is_dir($entrypath) )
			{
				$exit=false;
				$new_dir_path=$entrypath.'/';
				$new_open_dir=opendir($new_dir_path);

				if ($new_open_dir)
				{
					array_push($m_zip_dir_paths,$new_dir_path);
					array_push($m_zip_open_dirs,$new_open_dir);
					$m_zip_last_open_dir=$m_zip_open_dirs[count($m_zip_open_dirs)-1];
					$m_zip_last_dir_path=$m_zip_dir_paths[count($m_zip_dir_paths)-1];
				}

			}
		}
		elseif (($entryname===false) && (count($m_zip_open_dirs)>1))
		{
			$exit=false;
			closedir($m_zip_last_open_dir);
			array_pop($m_zip_open_dirs);
			array_pop($m_zip_dir_paths);
			$m_zip_last_open_dir=$m_zip_open_dirs[count($m_zip_open_dirs)-1];
			$m_zip_last_dir_path=$m_zip_dir_paths[count($m_zip_dir_paths)-1];
		}
	}
	while (!$exit);

	if ($entryname===false)
	{

		// NO MORE FILES CLEAR FILEHANDLES AND PATHS ARRAYS

		$M_ZIP_DIR_HANDLES[$m_zip_original_file]=false;
		unset($M_ZIP_DIR_HANDLES[$m_zip_original_file]);
		$M_ZIP_DIR_OPEN_PATHS[$m_zip_original_file]=false;
		unset($M_ZIP_DIR_OPEN_PATHS[$m_zip_original_file]);


		return false;
	}

	// SAVE FILEHANDLES AND PATHS ARRAYS FOR NEXT RUN

	$M_ZIP_DIR_HANDLES[$m_zip_original_file]=$m_zip_open_dirs;
	$M_ZIP_DIR_OPEN_PATHS[$m_zip_original_file]=$m_zip_dir_paths;



	return array($entryname,_m_zip_RelPath($zip_dir,$m_zip_last_dir_path),$m_zip_last_dir_path);
}

/**
 * Make a path relative.
 *
 * @param  PATH			The base path (path to make relative to)
 * @param  PATH			The path to make relative
 * @return PATH			The relative path
 */
function _m_zip_RelPath($base_path,$path)
{
	//echo("BasePath:$base_path,Path;$path");
	if ($path==$base_path) return '';

	if (strpos($path,$base_path)===0) return substr($path,strlen($base_path));
	else return $path;
}

/**
 * Opens a directory entry in a zip file for reading.
 *
 * @param  array			The zip file resource
 * @param  array			Directory entry resource returned by m_zip_read()
 * @param  string			The file access mode
 * @set    rb
 * @return boolean		Whether the operation was succesful
 */
function zip_entry_open($zip,$zip_entry,$mode='rb')
{
	unset($mode);
	global $M_ZIP_FILE_HANDLES;

	$m_zip_file_handle=fopen($zip_entry[2].$zip_entry[0],'rb');
	if ($m_zip_file_handle!==false)
	{
		$M_ZIP_FILE_HANDLES[$zip_entry[0]]=$m_zip_file_handle;
		return true;
	}
	return false;
}

/**
 * Closes a directory entry previously opened for reading.
 *
 * @param  array			Directory entry resource returned by m_zip_read()
 * @return boolean		Whether the operation was succesful
 */
function zip_entry_close($zip_entry)
{
	global $M_ZIP_FILE_HANDLES;

	if ($M_ZIP_FILE_HANDLES[$zip_entry[0]])
	{
		fclose($M_ZIP_FILE_HANDLES[$zip_entry[0]]);
		$M_ZIP_FILE_HANDLES[$zip_entry[0]]=false;
		unset($M_ZIP_FILE_HANDLES[$zip_entry[0]]);
	}

	return true;
}

/**
 * Returns the name of the directory entry specified in the given entry.
 *
 * @param  array			Directory entry resource returned by m_zip_read()
 * @return string			The entry name
 */
function zip_entry_name($zip_entry)
{
	return $zip_entry[1].$zip_entry[0];
}

/**
 * Returns the filesize of the directory entry specified in the given entry.
 *
 * @param  array			Directory entry resource returned by m_zip_read()
 * @return integer		The file size
 */
function zip_entry_filesize($zip_entry)
{
	clearstatcache();
	return filesize($zip_entry[2].$zip_entry[0]);
}

/**
 * Returns the file data of the directory entry specified in the given entry.
 *
 * @param  array				Directory entry resource returned by m_zip_read()
 * @param  integer			The maximum returned data size
 * @return ~string			The data (false: failure)
 */
function zip_entry_read($zip_entry,$zip_entry_file_size=1024)
{
	// Chris: Changed $zip_entry_file_size to default to 1024 as the proper zip_entry_read does -- no parameter does not mean read the whole file

	global $M_ZIP_FILE_HANDLES;

	// UNCOMMENT THIS TO SPEEDUP. WILL REQUIRE MORE RAM AND FAIL FOR BIG-BIG FILES

	//if (/*$zip_entry_file_size==0 ||*/ $zip_entry_file_size==filesize($TheFile)) return implode('',file($TheFile));

	$FH=$M_ZIP_FILE_HANDLES[$zip_entry[0]];
	if ($FH)
	{
		$res='';
		while ((strlen($res)<$zip_entry_file_size) && (!feof($FH)))
		{
			$read_amount=min(4096,$zip_entry_file_size-strlen($res));
			$res.=fread($FH,$read_amount);
		}

		if ($res=='') return false;
		else return $res;
	}
	return false; // Boh? (that in italian means who-knows-if-it-is-right-or-wrong-,-anyway-I-have-serious-perplexities-about-it-all)
}

/**
 * Delete a directory of files.
 * From "User Contributed Notes" at http://it.php.net/manual/en/function.rmdir.php. Thanks flexer at cutephp dot com
 *
 * @param  PATH			The path to the directory
 */
function m_deldir($a_dir)
{
	// echo('<p>Deleting:'.$a_dir);
	// return; // uncomment to skip deletion (leave things)

	// added support for trailing slash
	if ((substr($a_dir,-1)=='/') || (substr($a_dir,-1)=='\\'))
	{
		$a_dir=substr($a_dir,0,-1);
	}

	if (is_dir($a_dir))
	{
		$current_dir=opendir($a_dir);
		while (false!==($entryname=readdir($current_dir)))
		{
			//echo("<br>removing $a_dir/$entryname");
			if (is_dir($a_dir.'/'.$entryname) && ($entryname!='.' && $entryname!='..'))
			{
			//echo("<ul>");
				m_deldir($a_dir.'/'.$entryname);
			//echo("</ul>");
			} elseif ($entryname!='.' && $entryname!='..')
			{
				unlink($a_dir.'/'.$entryname);
			}
		}
		closedir($current_dir);
		rmdir($a_dir);
	} else
	{
		// uncomment this if you want to delete files (use m_deldir on anything)
		// unlink($a_dir);
		// comment this if you want to skip warning
		error_log('m_deldir() -- <b>Warning!</b> Not a directory: '.$a_dir);
	}
}

}

}