Bagaimana Cara Zip dan Unzip File di Codelgeniter

() translation by (you can also view the original English article)

Separuh pertama tutorial ini menjelaskan cara-cara berbeda agar Anda bisa membuat suatu file zip dengan menggunakan Codelgeniter API built-in. Akan kita lihat bagaimana cara membuat dan menyimpan file zip di server dan bagaimana Anda membuatnya juga bisa diunduh oleh pengguna akhir.

Separuh keduanya berisi pembahasan cara Anda unzip filenya. Untuk mendemonstrasikan hal itu, kita akan membuat halaman sesuaian (custom) yang mengizinkan pengguna mengunggah file zip yang akan diekstrak ke server setelah pengunggahan file berhasil. Untuk mendapatkan fungsionalitas yang diinginkan, ekstensi ZipArchive PHP datang dan membantu kita!

Sebelum melanjutkan dan secara serius mendalami hal-hal pengembangan, saya akan menyebutkan file-file yang akan kita kembangkan sepanjang tutorial ini:

application/controllers/Zip.php: ini adalah file controller yang mendemonstrasikan berbagai cara Anda bisa membuat file zip.
application/controllers/Unzip.php: Suatu file controller yang berisi kode yang digunakan untuk unzip file yang diunggah pengguna.
application/views/file_upload_form.php : File tampilan yang menangani kode form pengunggahan file HTML yang cukup dasar.
application/views/file_upload_result.php: File tampilan yang menunjukkan hasil file yang diunggah pengguna; pada dasarnya memberitahu Anda bahwa filenya berhasil di-unzip.
application/libraries/Extractor.php: File ini mendemonstrasikan konsep pustaka sesuaian (custom library) di Codelgeniter.

Jika semuanya sudah tersedia, kita siap melangkah ke bagian berikutnya!

Bagaimana Men-Zip File?

Lanjutkan dengan membuat suatu file application/controllers/Zip.php dengan konten berikut.

<?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');
	}
}

Ini adalah file controller yang cukup standar dan Anda sudah akrab dengannya. File ini menangani beberapa metode, dan tiap metodenya menunjukkan Anda cara berbeda untuk membuat file zip.

Terlepas dari itu, file tersebut menyediakan dua metode privat, _load_zip_lib dan _archieve_and_download, yang dipanggil dari metode-metode yang lainnya. Tentu saja, Anda tidak perlu mengimplementasikan metode-metode tersebut, tetapi kita baru saja merefaktor kodenya sehingga Anda tidak harus mengulangi kode yang sama di metode lainnya. Pertama mari melihat kedua metode tersebut.

Berikut adalah penampakan metode _load_zip_lib.

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

Metode itu memuat pustaka zip internal framework Codelgeniter supaya Anda bisa menggunakan fitur-fitur pustaka tersebut di sepanjang kodenya. Sekarang Anda bisa mengakses pustaka zip dengan konvensi $this->zip.

Berikutnya, ada metode _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);
}

Sebagaimana kita telah memuat pustaka zip, Anda bisa menggunakan metode yang disediakannya. Metode archive memungkinkan Anda membuat file zip sebagai path yang dijadikan argumen pertama. Di sisi lain, metode pengunduhan mengarahkan pengguna untuk mengunduh file.

Jangan khawatir jika Anda bertanya-tanya tentang konten file zip kami, karena kita akan melihatnya sebentar lagi.

Semua sudah siap, jadi kita ambil ancang-ancang untuk bergerak!

Mari ambil kode metode data. Metode ini menunjukkan cara membuat file dengan cepat dan membungkusnya dalam file 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');
}

Untuk memulai, kita memanggil metode _load_zip_lib yang memuat pustaka zip. Berikutnya, kita telah menggunakan metode add_data kelas zip yang memungkinkan Anda menciptakan dan mengisinya dengan konten pada waktu yang sama! Tentu saja ditambahkan ke arsipnya juga!

Argumen pertama haruslah nama filenya, dan argumen kedua menangani konten yang masuk ke dalam filenya.

Sebagaimana bisa dilihat, kita telah menambahkan dua file, name.txt dan profile.txt, dengan sejumlah konten demo. Akhirnya, kita memanggil _archieve_and_download dengan my_info.zip sebagai argumen metode tersebut. Apa yang dilakukannya?

Akan membuat suatu file zip my_info.zip di bawah direktori unggahan Anda.
Akan meminta pengguna untuk mengunduh file, dan nama yang dengannya filenya akan disimpan adalah my_info.zip.

Jadi pastikan Anda sudah membuat direktori uploads di root situs Anda. Pastikan juga Anda membuatnya bisa ditulisi oleh pengguna server web. Sekarang, lanjutkan dan jalankan “http://my-codeingiter-site/zip/data” untuk melihat aksinya.

Jika Anda ada masalah, silakan bertanya pada saya di komentar!

Berikutnya adalah metode 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');
}

Metode ini identik dengan yang baru saja kita bahas, kecuali bahwa kita menyediakan sekumpulan file untuk metode add_data alih-alih file-file tersendiri.

Berikutnya, mari mengambil kode metode 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');
}

Untuk berjaga-jaga jika Anda ingin mengorganisasikan file-file Anda dalam direktori tertentu, metode add_data memungkinkan Ana membuatnya juga. Keluaran yang dihasilkan metode di atas tidak ada bedanya kecuali file name.txt dan profile.txt akan dimasukkan dalam direktori info.

Meskipun metode add_data menyediakan fitur bagus yang memungkinkan Anda membuat file dengan cepat, lebih sering dari tidak Anda akan membutuhkan untuk men-zip file-file yang ada di server. Bagaimanapun itulah tepatnya topik yang akan dibahas dalam beberapa metode ke depan.

Mari kita lihat dengan cepat bagaimana penampakan metode files kita berikutnya. Akan dibuat suatu zip file-file di bawah direktori 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');
}

Tujuan metode read_file adalah membaca file yang ada di server dan menambahkannya ke archive. Sebagaimana bisa dilihat, kita menambahkan dua file 1.jpg dan 2.jpg ke archive. Tentu saja dua file tersebut harus ada di bawah direktori uploads di root situs Anda.

Jika Anda memasukkan TRUE sebagai argumen kedua metode read_file, file zip yang dihasilkan mempertahankan struktur direktoi yang tepat yang filenya ditempatkan di situ.

Cobalah menjalankan http://my-codeingiter-site/zip/files dan lihat hasilnya!

Metode terakhir di segmen ini adalah metode dir yang akan memuat suatu arsip zip keseluruhan direktori.

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');
}

Anda bisa menggunakan metode read_dir jika ingin membuat arsip zip keseluruhan direktori alih-alih file-file tertentu. Dalam contoh kita di atas, yang akan dibuat adalah file dir_images.zip yang berisi semua file di bawah direktori /uploads/images/.

Hal yang penting diingat di sini adalah bahwa keseluruhan struktur direktori akan dipertahankan secara default dalam file zipnya. Tetapi jika Anda ingin mengabaikannya masukkan saja FALSE sebagai argumen kedua metode read_dir. Dalam hal ini, yang akan dibuat hanyalah direktori images dalam file zipnya.

Maka itulah akhir cerita tentang cara membuat arsip zip dengan menggunakan berbagai metode yang disediakan oleh kelas zip internal.

Bagaimana Cara Unzip File?

Sayangnya, tidak ada pustaka internal Codelgeniter yang memungkinkan kita meng-unzip arsip zip. Tetapi ekstensi ZipArchive PHP membuatnya jadi mudah, sebagaimana kita lihat sebentar lagi.

Kita akan membuat contoh yang lumayan sederhana untuk mendemonstrasikan cara meng-unzip fle-file yang diunggah pengguna.

Mulailah dengan membuat fle application/controllers/Unzip.php dengan konten sebagai berikut.

<?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);
	}
}

Kita juga membuat templat tampilannya, kemudian kita lihat bagaimana itu bekerja bersama.

Buat file templat tampilan application/views/file_upload_form.php dengan konten sebagai berikut.

<?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>

Dibuatnya suatu form unggahan file sederhana supaya pengguna bisa mengunggah file zip! Perhatikan bahwa saya membuatnya seminimal mungkin demi kesederhanaan.

Berikutnya, mari membuat file templat tampilan 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>

Sekalinya filenya diunggah dan diekstrak, pengguna akan ditunjukkan templat di atas.

Sekarang, mari kita kembali ke controller dan menelusuri tiap metodenya.

Di constructor controller kita, telah dimuat form dan url internal bantuan Codelgeniter, sehingga kita bisa menggunakan fungsi bantuan seperti form_open_multipart, site_url dan semacamnya.

Berikutnya, mari melihat metode index.

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

Apakah ini butuh penjelasan? Ini memanggil tampilan file_upload_form dan me-render halamannya. Jadi ketika Anda mengakses http://my-codeingiter-site/unzip akan ditampilkan form pengunggahan file sederhana sebagaimana ditampilkan di bawah ini.

Perhatikan juga bahwa action form kita adalah unzip/upload yang datanya akan dikirimkan ke situ. Kita telah menggunakan bantuan form_open_multipart untuk menghasilkan tag form multibagian!

Berikutnya, kita harus mengimplementasikan metode action upload yang akan menangani pengunggahan file dan ekstraksi. Ambil kodenya dari controller 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);
}

Jika Anda akrab dengan pengunggahan file di Codelgeniter, kodenya tidak akan tampak asing bagi Anda. Bagi yang belum akrab, tidak ada yang perlu dikhawatirkan karena API pengunggahan di Codelgeniter menjadikannya mudah.

Kode berikut memuat pustaka unggahan dengan beberapa konfigurasi awal yang disediakan oleh variabel array $config.

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

Kita telah mengonfigurasinya sehingga file yang diunggah akan ditempatkan di bawah direktori uploads di root aplikasinya, dan pengguna hanya akan diizinkan untuk mengunggah file-file zip.

Berikutnya, kita telah mengecek apakah pengunggahan filenya gagal, jika seperti itu maka kita akan mengambil pesan kesalahan yang bermanfaat dan memberikannya ke $params supaya bisa ditampilkan dalam templatnya.

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

Dalam hal ini, jika file berhasil diunggah, maka langkah berikutnya adalah mendapatkan path file yang diunggah.

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

Akhirnya, kita menginstantiasi suatu objek ZipArchive, membuka file zip kita, dan mengekstraknya ke direktori uploads.

$zip = new ZipArchive;

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

Bukankah itu langsung ke tujuan?

Satu-satunya yang tersisa adalah memanggil tampilan file_upload_result, dan berikut adalah penampakannya seharusnya!

Jadi, itulah bagian lain dari ceritanya!

Refaktor Unzipping Code ke Suatu Pustaka

Anda mungkin sudah menyadari bahwa metode upload mengandung kode ZipArchive yang mengekstrak file yang diunggah. Bagaimana jika Anda butuh menggunakan kode tersebut di berbagai tempat? Mungkin Anda tergoda untuk copy paste kodenya sesuai kebutuhan.

Bukan demikian, ada cara yang lebih baik yang Codelgeniter mengizinkan Anda melakukan sentralisasi kode yang akan digunakan di sepanjang aplikasi. Anda bisa membuat suatu pustaka sesuaian (custom library).

Mulailah dengan membuat suatu file application/libraries/Extractor.php dengan konten sebagai berikut.

<?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();
        }
    }
}

Sekarang lanjutkan dengan mengganti metode upload di controller Unzip.php Anda dengan yang berikut ini.

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);
}

Sebagaimana bisa Anda lihat, kita telah memuat custom library dan menggunakannya untuk mengekstrak kontennya!

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

Cukup keran, kan?

Dan ya, itulah akhir artikel ini.

Kesimpulan

Saya harap Anda menikmati artikel ini, yang kita mulai dengan mengeksplorasi pustaka zip inti framework Codelgeniter dan beragam cara Anda bisa membuat arsip zip. Di bagian kedua, saya menjelaskan bagaimana Anda bisa meng-unzip file-file unggahan pengguna dengan menggunakan ekstensi ZipArchive PHP.

Dalam prosesnya, kita juga mendapat kesempatan mengonversi kode kita jadi pustaka Codelgeniter custom, dan itu boleh dibilang semacam buah ceri di puncak!

Beritahu saya jika Anda memiliki pertanyaan dan saran yang bisa Anda sampaikan dengan menggunakan umpan di bawah ini.