Как архивировать и распаковывать файлы в CodeIgniter

Russian (Pусский) translation by Masha Kolesnikova (you can also view the original English article)

Первая половина этого руководства объясняет различные способы создания ZIP-файла с помощью встроенных API-интерфейсов CodeIgniter. Мы увидим, как создавать и сохранять zip-файлы на сервере, и как вы можете сделать их доступными для загрузки конечным пользователям.

Вторая половина включает обсуждение того, как вы можете разархивировать файл. Чтобы продемонстрировать это, мы создадим пользовательскую страницу, которая позволит пользователям загружать zip-файлы, которые будут извлечены на сервере после успешной загрузки файла. Для достижения желаемых функциональных возможностей нам пригодится расширение ZipArchive PHP!

Прежде чем мы продолжим и фактически погрузимся в материал разработки, я перечислил файлы, которые мы собираемся разработать в ходе этого учебника:

Application / controllers / Zip.php: Это файл контроллера, который демонстрирует различные способы создания zip-файла.
Application / controllers / Unzip.php: Это файл контроллера, который включает в себя код, используемый для распаковки загруженного пользователем файла.
Application / views / file_upload_form.php: Это файл представления, который содержит довольно простой код для загрузки файлов HTML.
Application / views / file_upload_result.php: это файл представления, который показывает результат загруженного пользователем файла; В основном это говорит вам, если файл был успешно разархивирован.
Application / libraries / Extractor.php: Этот файл демонстрирует концепцию пользовательской библиотеки в CodeIgniter.

Со всем, что у нас есть, мы готовы перейти к следующему разделу!

Как архивировать файлы?

Идем дальше и создаем файл application/controllers/Zip.php со следующим содержимым.

<?php
// application/controllers/Zip.php
defined('BASEPATH') OR exit('No direct script access allowed');

class Zip extends CI_Controller {
    private function _load_zip_lib()
  {
		$this->load->library('zip');
	}
	
	private function _archieve_and_download($filename)
	{
		// create zip file on server
		$this->zip->archive(FCPATH.'/uploads/'.$filename);
		
		// prompt user to download the zip file
		$this->zip->download($filename);
	}

	public function data()
	{
		$this->_load_zip_lib();
		
		$this->zip->add_data('name.txt', 'Sajal Soni');
		$this->zip->add_data('profile.txt', 'Web Developer');
		
		$this->_archieve_and_download('my_info.zip');
	}

	public function data_array()
	{
		$this->_load_zip_lib();
		
		$files = array(
				'name.txt' => 'Sajal Soni',
				'profile.txt' => 'Web Developer'
		);
		
		$this->zip->add_data($files);
		
		$this->_archieve_and_download('my_info.zip');
	}

	public function data_with_subdirs()
	{
		$this->_load_zip_lib();
		
		$this->zip->add_data('info/name.txt', 'Sajal Soni');
		$this->zip->add_data('info/profile.txt', 'Web Developer');
		
		$this->_archieve_and_download('my_info.zip');
	}

	public function files()
	{
		$this->_load_zip_lib();
		
		// pass second argument as TRUE if want to preserve dir structure
		$this->zip->read_file(FCPATH.'/uploads/1.jpg');
		$this->zip->read_file(FCPATH.'/uploads/2.jpg');
		
		$this->_archieve_and_download('images.zip');
	}
	
	public function dir()
	{
		$this->_load_zip_lib();
		
		// pass second argument as FALSE if want to ignore preceding directories
		$this->zip->read_dir(FCPATH.'/uploads/images/');
		
		$this->_archieve_and_download('dir_images.zip');
	}
}

Это довольно стандартный файл контроллера, с которым вы уже знакомы. Он содержит несколько методов, и каждый из них показывает вам другой способ создания zip-файла.

Кроме того, он предоставляет два частных метода: _load_zip_lib и _archieve_and_download, которые вызываются из остальных методов. Конечно, вам не нужно реализовывать эти методы, но мы просто реорганизовали наш код, чтобы вы не повторяли тот же код в других методах. Давайте сначала рассмотрим эти два метода.

Вот как выглядит метод _load_zip_lib.

1	private function _load_zip_lib()
2	{
3	$this->load->library('zip');
4	}

Он загружает встроенную zip-библиотеку среды CodeIgniter, чтобы вы могли использовать возможности этой библиотеки во всем остальном коде. Теперь вы можете получить доступ к zip-библиотеке с помощью соглашения $this-> zip.

Далее, рассмотрим метод _archieve_and_download.

private function _archieve_and_download($filename)
{
    // create zip file on server
    $this->zip->archive(FCPATH.'/uploads/'.$filename);
        
    // prompt user to download the zip file
    $this->zip->download($filename);
}

Когда мы загрузили zip-библиотеку, вы можете использовать предоставленные ею методы. Метод архивирования позволяет вам по пути создать zip-файл, указанному в качестве первого аргумента. С другой стороны, метод загрузки предлагает пользователю загрузить файл.

Не беспокойтесь, если вы задаетесь вопросом о содержимом нашего zip-файла, сейчас мы к этому перейдем.

Все на месте, поэтому мы готовы к работе!

Давайте рассмотрим код метода data. Этот метод показывает вам, как создавать файлы «на лету» и переносить их в zip-файл.

public function data()
{
    $this->_load_zip_lib();
        
    $this->zip->add_data('name.txt', 'Sajal Soni');
    $this->zip->add_data('profile.txt', 'Web Developer');
        
    $this->_archieve_and_download('my_info.zip');
}

Начнем с того, что мы вызвали метод _load_zip_lib, который загружает библиотеку zip. Затем мы использовали метод add_data класса zip, который позволяет вам создать файл и одновременно заполнить его содержимым! Конечно, он будет добавлен в архив!

Первый аргумент должен быть именем файла, а второй - содержимым файла.

Как вы можете видеть, мы добавили два файла: name.txt и profile.txt, с некоторым демо-контентом. Наконец, мы вызываем _archieve_and_download с my_info.zip в качестве аргумента этого метода. Что он делает?

Он создаст zip-файл my_info.zip в каталоге загрузки.
Он также предложит пользователю загрузить файл, а имя, в котором будет сохранен файл, будет my_info.zip.

Поэтому убедитесь, что вы создали каталог uploads в корневом каталоге своего сайта. Кроме того, сделайте его доступным для записи пользователю веб-сервера. Теперь, продолжайте и откройте «http://my-codeingiter-site/zip/data», чтобы увидеть все в действии!

Если у вас возникнут проблемы, вы можете задать их мне в комментариях!

Далее, есть метод data_array.

public function data_array()
{
    $this->_load_zip_lib();
    
    $files = array(
        'name.txt' => 'Sajal Soni',
        'profile.txt' => 'Web Developer'
    );
    
    $this->zip->add_data($files);
    
    $this->_archieve_and_download('my_info.zip');
}

Этот метод идентичен предыдущему, о котором мы только что говорили, за исключением того, что мы предоставили массив файлов методу add_data вместо отдельных файлов!

Затем давайте рассмотрим код метода data_with_subdirs.

public function data_with_subdirs()
{
    $this->_load_zip_lib();
        
    $this->zip->add_data('info/name.txt', 'Sajal Soni');
    $this->zip->add_data('info/profile.txt', 'Web Developer');
        
    $this->_archieve_and_download('my_info.zip');
}

На всякий случай, если вы хотите упорядочить свои файлы в определенных каталогах, метод add_data также позволяет создавать их. Полученный результат вышеупомянутого метода не будет отличаться, за исключением того, что файлы name.txt и profile.txt будут помещены в каталог info.

Хотя метод add_data предоставляет хорошую возможность, которая позволяет вам создавать файлы «на лету», чаще всего вам необходимо заархивировать существующие файлы на сервере. Во всяком случае, это как раз тема наших следующих методов.

Давайте быстро посмотрим, как выглядит наш следующий метод files. Он создаст zip архив файлов в каталоге uploads.

public function files()
{
    $this->_load_zip_lib();
        
    // pass second argument as TRUE if want to preserve dir structure
    $this->zip->read_file(FCPATH.'/uploads/1.jpg');
    $this->zip->read_file(FCPATH.'/uploads/2.jpg');
        
    $this->_archieve_and_download('images.zip');
}

Цель метода read_file - прочитать существующий файл на сервере и добавить его в архив. Итак, как вы видите, что мы добавили два файла 1.jpg и 2.jpg в архив. Конечно, эти два файла должны присутствовать в каталоге uploads в корневом каталоге вашего сайта.

Если вы передадите TRUE как второй аргумент метода read_file, результирующий zip-файл сохранит точную структуру директории, в которую был помещен файл.

Попробуйте запустить http: // my-codeigniter-site / zip / files и проверьте результат!

Последний метод в этом сегменте - это метод dir. Он создаст zip-архив всего каталога.

public function dir()
{
    $this->_load_zip_lib();
        
    // pass second argument as FALSE if want to ignore preceding directories
    $this->zip->read_dir(FCPATH.'/uploads/images/');
        
    $this->_archieve_and_download('dir_images.zip');
}

Вы можете использовать метод read_dir, если хотите создать zip-архив всего каталога вместо определенных файлов. В нашем примере выше он создаст файл dir_images.zip, содержащий все файлы в каталоге /uploads/images/.

Важно отметить, что вся структура каталогов будет сохранена по умолчанию в zip-файле. Но, если вы хотите проигнорировать его, просто передайте FALSE в качестве второго аргумента метода read_dir. В этом случае создается только каталог images в zip-файле.

Итак, мы заканчиваем нашу историю о том, как создавать zip-архив, используя различные методы, предоставляемые встроенным zip-классом.

Как распаковать файлы?

К сожалению, нет встроенной библиотеки CodeIgniter, которая позволяет нам разархивировать zip-архив. Но расширение ZipArchive PHP делает этот процесс весьма легким, как мы сейчас увидим.

Мы создадим довольно простой пример, демонстрирующий, как разархивировать загруженные пользователем файлы.

Идем дальше и создаем файл application/controllers/Unzip.php со следующим содержимым.

<?php
// application/controllers/Unzip.php
defined('BASEPATH') OR exit('No direct script access allowed');

class Unzip extends CI_Controller {
    public function __construct()
	{
		parent::__construct();
		$this->load->helper(array('form', 'url'));
	}

	public function index()
	{
		$this->load->view('file_upload_form');
	}

	public function upload()
	{
		$config['upload_path']          = './uploads/';
		$config['allowed_types']        = 'zip';
		
		$this->load->library('upload', $config);
		
		if ( ! $this->upload->do_upload('zip_file'))
		{
			$params = array('error' => $this->upload->display_errors());
		}
		else
		{
			$data = array('upload_data' => $this->upload->data());
			$full_path = $data['upload_data']['full_path'];
			
			/**** without library ****/
			$zip = new ZipArchive;

			if ($zip->open($full_path) === TRUE) 
			{
				$zip->extractTo(FCPATH.'/uploads/');
				$zip->close();
			}

			$params = array('success' => 'Extracted successfully!');
		}
		
		$this->load->view('file_upload_result', $params);
	}
}

Давайте также создадим наши шаблоны представлений, и тогда мы увидим, как это работает.

Создайте файл шаблон application/views/file_upload_form.php со следующим содержимым.

<?php
// application/views/file_upload_form.php
defined('BASEPATH') OR exit('No direct script access allowed');
?><!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
	<title>Welcome to CodeIgniter</title>

	<style type="text/css">

	::selection { background-color: #E13300; color: white; }
	::-moz-selection { background-color: #E13300; color: white; }

	body {
		background-color: #fff;
		margin: 40px;
		font: 13px/20px normal Helvetica, Arial, sans-serif;
		color: #4F5155;
	}

	a {
		color: #003399;
		background-color: transparent;
		font-weight: normal;
	}

	h1 {
		color: #444;
		background-color: transparent;
		border-bottom: 1px solid #D0D0D0;
		font-size: 19px;
		font-weight: normal;
		margin: 0 0 14px 0;
		padding: 14px 15px 10px 15px;
	}

	code {
		font-family: Consolas, Monaco, Courier New, Courier, monospace;
		font-size: 12px;
		background-color: #f9f9f9;
		border: 1px solid #D0D0D0;
		color: #002166;
		display: block;
		margin: 14px 0 14px 0;
		padding: 12px 10px 12px 10px;
	}

	#body {
		margin: 0 15px 0 15px;
	}

	p.footer {
		text-align: right;
		font-size: 11px;
		border-top: 1px solid #D0D0D0;
		line-height: 32px;
		padding: 0 10px 0 10px;
		margin: 20px 0 0 0;
	}

	#container {
		margin: 10px;
		border: 1px solid #D0D0D0;
		box-shadow: 0 0 8px #D0D0D0;
	}
	
	div {
	  padding: 10px;
	}
	
	.error {
	  color: #F00;
	}
	
	.success {
	  color: #00F;
	}
	</style>
</head>
<body>

<div id="container">
	<h1>Upload File</h1>

	<div id="body">
	  <div class="success"><?php if (isset($success)) {echo $success;}?></div>
	  <div class="error"><?php if (isset($error)) {echo $error;}?></div>

		<?php echo form_open_multipart('unzip/upload');?>
		  <div>
			  <input name="zip_file" type="file"/>
			</div>
			<div>
			  <input type="submit" value="Upload Zip File" />
			</div>
		</form>
	</div>
</div>

</body>
</html>

Он создает простую форму для загрузки файлов, чтобы пользователь мог загрузить zip-файл! Пожалуйста, обратите внимание, что я свел все к минимуму ради простоты.

Теперь давайте создадим файл шаблона application/views/file_upload_result.php

<?php
// application/views/file_upload_result.php
defined('BASEPATH') OR exit('No direct script access allowed');
?><!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
	<title>Welcome to CodeIgniter</title>

	<style type="text/css">

	::selection { background-color: #E13300; color: white; }
	::-moz-selection { background-color: #E13300; color: white; }

	body {
		background-color: #fff;
		margin: 40px;
		font: 13px/20px normal Helvetica, Arial, sans-serif;
		color: #4F5155;
	}

	a {
		color: #003399;
		background-color: transparent;
		font-weight: normal;
	}

	h1 {
		color: #444;
		background-color: transparent;
		border-bottom: 1px solid #D0D0D0;
		font-size: 19px;
		font-weight: normal;
		margin: 0 0 14px 0;
		padding: 14px 15px 10px 15px;
	}

	code {
		font-family: Consolas, Monaco, Courier New, Courier, monospace;
		font-size: 12px;
		background-color: #f9f9f9;
		border: 1px solid #D0D0D0;
		color: #002166;
		display: block;
		margin: 14px 0 14px 0;
		padding: 12px 10px 12px 10px;
	}

	#body {
		margin: 0 15px 0 15px;
	}

	p.footer {
		text-align: right;
		font-size: 11px;
		border-top: 1px solid #D0D0D0;
		line-height: 32px;
		padding: 0 10px 0 10px;
		margin: 20px 0 0 0;
	}

	#container {
		margin: 10px;
		border: 1px solid #D0D0D0;
		box-shadow: 0 0 8px #D0D0D0;
	}
	
	div {
	  padding: 10px;
	}
	
	.error {
	  color: #F00;
	}
	
	.success {
	  color: #00F;
	}
	</style>
</head>
<body>

<div id="container">
	<h1>Upload File Result</h1>

	<div id="body">
	  <div class="success"><?php if (isset($success)) {echo $success;}?></div>
	  <div class="error"><?php if (isset($error)) {echo $error;}?></div>
	  <a href="<?php echo site_url('unzip/index'); ?>">&lt;&lt; Back to File Uploader</a>
	</div>
</div>

</body>
</html>

После загрузки и извлечения файла пользователю будет показан указанный выше шаблон.

Теперь давайте вернемся к нашему контроллеру и пройдемся по каждому методу.

В конструкторе нашего контроллера мы загрузили встроенные хелперы CodeIgniter такие как form и url, чтобы мы могли использовать вспомогательные функции, такие как form_open_multipart, site_url и т.п.

Затем давайте посмотрим на метод index.

1	public function index()
2	{
3	$this->load->view('file_upload_form');
4	}

Нужно ли это объяснять? Он вызывает представление file_upload_form и отображает страницу. Таким образом, при доступе к http://my-codeingiter-site/unzip он должен отображать простую форму для загрузки файлов, как показано ниже.

Также обратите внимание, что действие нашей формы - unzip/upload, где данные будут отправлены. Мы использовали хелпер form_open_multipart для создания тега multipart form!

Затем нам нужно реализовать метод upload, который будет обрабатывать файлы для загрузки и извлечения файлов. Используйте для него код из контроллера Unzip.php.

public function upload()
{
    $config['upload_path']          = './uploads/';
    $config['allowed_types']        = 'zip';
        
    $this->load->library('upload', $config);
        
    if ( ! $this->upload->do_upload('zip_file'))
    {
        $params = array('error' => $this->upload->display_errors());
    }
    else
    {
        $data = array('upload_data' => $this->upload->data());
        $full_path = $data['upload_data']['full_path'];
            
        $zip = new ZipArchive;

        if ($zip->open($full_path) === TRUE)
        {
            $zip->extractTo(FCPATH.'/uploads/');
            $zip->close();
        }

        $params = array('success' => 'Extracted successfully!');
    }
        
    $this->load->view('file_upload_result', $params);
}

Если вы знакомы с загрузкой файлов в CodeIgniter, код не должен выглядеть чужим для новым. Для тех, кто не знаком, вам не о чем беспокоиться, так как встроенные API загрузки в CodeIgniter довольно просты.

Следующий код загружает библиотеку загрузки с некоторой начальной конфигурацией, предоставляемой переменной массива $config.

1	$this->load->library('upload', $config);

Мы настроили его так, чтобы загруженный файл был помещен в папку uploads в корне приложения, и пользователю будет разрешено загружать только zip-файлы.

Затем мы проверили, не удалось ли загрузить файл, и в этом случае мы выведем сообщение об ошибке, которое присвоим переменной $params, чтобы мы могли отобразить его в шаблоне.

1	$params = array('error' => $this->upload->display_errors());

В этом случае файл загружается успешно, поэтому следующий шаг - это путь к загруженному файлу.

1	$data = array('upload_data' => $this->upload->data());
2	$full_path = $data['upload_data']['full_path'];

Наконец, мы создаем объект ZipArchive, открываем наш zip-файл и извлекаем его в каталог uploads.

$zip = new ZipArchive;

if ($zip->open($full_path) === TRUE)
{
    $zip->extractTo(FCPATH.'/uploads/');
    $zip->close();
}

Не так ли?

Единственное, что нам осталось - это вызвать представление file_upload_result, и вот как оно должно выглядеть!

Итак, это другая часть истории!

Рефакторинг Unzipping кода в библиотеку

Вы заметили бы, что метод upload содержит код ZipArchive, который извлекает загруженный файл. Что делать, если вам нужно использовать этот код в нескольких местах? Возможно, у вас возникнет соблазн скопировать и вставить код по мере необходимости.

На самом деле, есть лучший способ, с помощью которого CodeIgniter позволяет централизовать код, который можно использовать во всем приложении. Вы можете создать собственную библиотеку.

Двигаемся дальше и создаем файл application/libraries/Extractor.php со следующим содержимым.

<?php
// application/libraries/Extractor.php
class Extractor {
    private $CI = NULL;
    private $zip = NULL;
	
    public function __construct($params = array())
    {
        $this->CI =& get_instance();
        $this->zip = new ZipArchive;
    }
	
    public function extract($source_file, $dest_dir)
    {
        if ($this->zip->open($source_file) === TRUE) 
		{
			$this->zip->extractTo($dest_dir);
			$this->zip->close();
        }
    }
}

Теперь давайте заменим метод upload в вашем Unzip.php-контроллере следующим.

public function upload()
{
    $config['upload_path']          = './uploads/';
    $config['allowed_types']        = 'zip';
        
    $this->load->library('upload', $config);
        
    if ( ! $this->upload->do_upload('zip_file'))
    {
        $params = array('error' => $this->upload->display_errors());
    }
    else
    {
        $data = array('upload_data' => $this->upload->data());
        $full_path = $data['upload_data']['full_path'];

        $this->load->library('extractor');
        $this->extractor->extract($full_path, FCPATH.'/uploads/');
        $params = array('success' => 'Extracted successfully!');
    }
        
    $this->load->view('file_upload_result', $params);
}

Как вы можете видеть, мы загрузили нашу пользовательскую библиотеку и использовали ее для извлечения содержимого!

1	$this->load->library('extractor');
2	$this->extractor->extract($full_path, FCPATH.'/uploads/');

Круто, да?

И да, это конец этой статьи.

Заключение

Надеюсь, вам понравилась статья, в которой мы начали изучать основную zip-библиотеку среды CodeIgniter и различными способами создавать ZIP-архив. Во второй части я объяснил, как можно распаковывать загруженные пользователем файлы с помощью расширения ZipArchive PHP.

В этом процессе мы также получили возможность переместить наш код в обычную библиотеку CodeIgniter, и я бы сказал, что это было чем-то вроде вишенки на торте.

Сообщите мне, если у вас появятся какие-либо вопросы и предложения, которые вы можете отправить, используя фид ниже.