So komprimieren und entpacken Sie Dateien in CodeIgniter

German (Deutsch) translation by Nikol Angelowa (you can also view the original English article)

In der ersten Hälfte dieses Tutorials werden verschiedene Möglichkeiten zum Erstellen einer ZIP-Datei mit integrierten CodeIgniter-APIs erläutert. Wir werden sehen, wie Sie Zip-Dateien auf dem Server erstellen und speichern und wie Sie sie auch Endbenutzern zum Download zur Verfügung stellen können.

In der zweiten Hälfte wird erläutert, wie Sie die Datei entpacken können. Um dies zu demonstrieren, erstellen wir eine benutzerdefinierte Seite, die es Benutzern ermöglicht, ZIP-Dateien hochzuladen, die nach erfolgreichem Dateiupload auf dem Server extrahiert werden. Um die gewünschte Funktionalität zu erreichen, kommt uns die ZipArchive PHP-Erweiterung zu Hilfe!

Bevor wir weitermachen und in die Entwicklung eintauchen, werde ich die Dateien auflisten, die wir im Laufe dieses Tutorials entwickeln werden:

application/controllers/Zip.php: Dies ist eine Controller-Datei, die verschiedene Möglichkeiten zum Erstellen einer ZIP-Datei zeigt.
application/controllers/Unzip.php: Dies ist eine Controller-Datei, die den Code enthält, der zum Entpacken einer vom Benutzer hochgeladenen Datei verwendet wird.
application/views/file_upload_form.php: Es ist eine Ansichtsdatei, die einen ziemlich einfachen HTML-Datei-Upload-Formularcode enthält.
application/views/file_upload_result.php: Dies ist eine Ansichtsdatei, die das Ergebnis einer vom Benutzer hochgeladenen Datei anzeigt; im Grunde sagt es Ihnen, ob die Datei erfolgreich entpackt wurde.
application/libraries/Extractor.php: Diese Datei demonstriert das Konzept einer benutzerdefinierten Bibliothek in CodeIgniter.

Wenn alles an Ort und Stelle ist, sind wir bereit, mit unserem nächsten Abschnitt fortzufahren!

So komprimieren Sie Dateien

Fahren Sie fort und erstellen Sie eine Datei application/controllers/Zip.php mit folgendem Inhalt.

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

Es ist eine ziemlich standardmäßige Controller-Datei, mit der Sie bereits vertraut sind. Es enthält mehrere Methoden, und jede von ihnen zeigt Ihnen eine andere Möglichkeit, eine ZIP-Datei zu erstellen.

Abgesehen davon bietet es zwei private Methoden, _load_zip_lib und _archieve_and_download, die von den restlichen Methoden aufgerufen werden. Natürlich müssen Sie diese Methoden nicht implementieren, aber wir haben unseren Code gerade umgestaltet, damit Sie nicht denselben Code in anderen Methoden wiederholen. Lassen Sie uns zuerst diese beiden Methoden durchgehen.

So sieht die Methode _load_zip_lib aus.

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

Es lädt die integrierte ZIP-Bibliothek des CodeIgniter-Frameworks, sodass Sie die Funktionen dieser Bibliothek im restlichen Code verwenden können. Jetzt können Sie mit der $this->zip-Konvention auf die Zip-Bibliothek zugreifen.

Als nächstes gibt es die Methode _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);
}

Da wir die Zip-Bibliothek geladen haben, können Sie die von ihr bereitgestellten Methoden verwenden. Mit der Methode archive können Sie eine ZIP-Datei unter dem als erstes Argument angegebenen Pfad erstellen. Andererseits fordert die Download-Methode den Benutzer zum Herunterladen der Datei auf.

Machen Sie sich keine Sorgen, wenn Sie sich über den Inhalt unserer ZIP-Datei wundern, denn das werden wir gleich sehen.

Alles ist an seinem Platz, also können wir loslegen!

Nehmen wir den Code der data-Methode. Diese Methode zeigt Ihnen, wie Sie Dateien im Handumdrehen erstellen und in eine ZIP-Datei packen.

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

Zunächst haben wir die Methode _load_zip_lib aufgerufen, die die Zip-Bibliothek lädt. Als Nächstes haben wir die Methode add_data der Klasse zip verwendet, mit der Sie eine Datei erstellen und gleichzeitig mit Inhalten füllen können! Natürlich wird es auch dem Archiv hinzugefügt!

Das erste Argument sollte der Name der Datei sein, und das zweite Argument enthält den Inhalt der Datei.

Wie Sie sehen, haben wir zwei Dateien namens name.txt und profile.txt mit einigen Demo-Inhalten hinzugefügt. Schließlich rufen wir _archieve_and_download mit my_info.zip als Argument dieser Methode auf. Was tut es?

Es erstellt eine ZIP-Datei my_info.zip in Ihrem Upload-Verzeichnis.
Es fordert auch einen Benutzer zum Herunterladen einer Datei auf, und der Name, unter dem die Datei gespeichert wird, lautet my_info.zip.

Stellen Sie also sicher, dass Sie im uploads-Verzeichnis Ihrer Website ein Upload-Verzeichnis erstellt haben. Machen Sie es auch für den Webserver-Benutzer beschreibbar. Führen Sie jetzt "http://my-codeingiter-site/zip/data" aus, um die Dinge in Aktion zu sehen!

Bei Problemen könnt ihr mich gerne in den Kommentaren fragen!

Als nächstes gibt es die data_array-Methode.

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

Diese Methode ist identisch mit der letzten, die wir gerade besprochen haben, außer dass wir der add_data-Methode ein Array von Dateien anstelle einzelner Dateien bereitgestellt haben!

Als nächstes greifen wir den Code der data_with_subdirs-Methode auf.

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

Für den Fall, dass Sie Ihre Dateien in bestimmten Verzeichnissen organisieren möchten, können Sie diese auch mit der Methode add_data erstellen. Die resultierende Ausgabe der obigen Methode unterscheidet sich nicht, außer dass die Dateien name.txt und profile.txt im info-Verzeichnis abgelegt werden.

Obwohl die Methode add_data eine nette Funktion bietet, mit der Sie Dateien im Handumdrehen erstellen können, müssen Sie in den meisten Fällen vorhandene Dateien auf dem Server zippen. Wie auch immer, genau das ist das Thema unserer nächsten Methodenpaare.

Schauen wir uns kurz an, wie unsere nächste files-Methode aussieht. Es wird eine ZIP-Datei mit Dateien im uploads-Verzeichnis erstellen.

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

Der Zweck der Methode read_file besteht darin, die vorhandene Datei auf dem Server zu lesen und sie dem Archiv hinzuzufügen. Wie Sie sehen, haben wir dem Archiv die beiden Dateien 1.jpg und 2.jpg hinzugefügt. Natürlich müssen sich diese beiden Dateien im upload-Verzeichnis im Stammverzeichnis Ihrer Site befinden.

Wenn Sie TRUE als zweites Argument der Methode read_file übergeben, behält die resultierende ZIP-Datei die genaue Verzeichnisstruktur bei, in der die Datei platziert wurde.

Versuchen Sie, http://my-codeingiter-site/zip/files auszuführen und überprüfen Sie das Ergebnis!

Die letzte Methode in diesem Segment ist die dir-Methode. Es wird ein ZIP-Archiv des gesamten Verzeichnisses erstellen.

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

Sie können die Methode read_dir verwenden, wenn Sie anstelle bestimmter Dateien ein ZIP-Archiv des gesamten Verzeichnisses erstellen möchten. In unserem obigen Beispiel wird eine dir_images.zip-Datei erstellt, die alle Dateien im Verzeichnis /uploads/images/ enthält.

Wichtig hierbei ist, dass die gesamte Verzeichnisstruktur standardmäßig in der ZIP-Datei erhalten bleibt. Wenn Sie es jedoch ignorieren möchten, übergeben Sie einfach FALSE als zweites Argument der Methode read_dir. In diesem Fall wird nur ein images-Verzeichnis in der ZIP-Datei erstellt.

Damit endet unsere Geschichte, wie man ein Zip-Archiv mit verschiedenen Methoden erstellt, die von der integrierten Zip-Klasse bereitgestellt werden.

Wie entpacke ich Dateien?

Leider gibt es keine integrierte CodeIgniter-Bibliothek, die es uns ermöglicht, das Zip-Archiv zu entpacken. Aber die ZipArchive PHP-Erweiterung macht es zum Kinderspiel, wie wir gleich sehen werden.

Wir erstellen ein ziemlich einfaches Beispiel, das zeigt, wie Sie von Benutzern hochgeladene Dateien entpacken.

Fahren Sie fort und erstellen Sie eine Datei application/controllers/Unzip.php mit folgendem Inhalt.

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

Lassen Sie uns auch unsere Ansichtsvorlagen erstellen und dann sehen wir, wie es insgesamt funktioniert.

Erstellen Sie eine Ansichtsvorlagendatei application/views/file_upload_form.php mit folgendem Inhalt.

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

Es erstellt ein einfaches Datei-Upload-Formular, damit der Benutzer die Zip-Datei hochladen kann! Bitte beachten Sie, dass ich es der Einfachheit halber auf ein Minimum beschränkt habe.

Als Nächstes erstellen wir eine Ansichtsvorlagendatei 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>

Sobald die Datei hochgeladen und extrahiert wurde, wird dem Benutzer die obige Vorlage angezeigt.

Kehren wir nun zu unserem Controller zurück und gehen die einzelnen Methoden durch.

Im Konstruktor unseres Controllers haben wir die integrierten Formular- und URL-CodeIgniter-Helfer geladen, damit wir Hilfsfunktionen wie form_open_multipart, site_url und dergleichen verwenden können.

Schauen wir uns als Nächstes die index-Methode an.

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

Braucht das eine Erklärung? Es ruft die Ansicht file_upload_form auf und rendert die Seite. Wenn Sie also auf http://my-codeingiter-site/unzip zugreifen, sollte ein einfaches Formular zum Hochladen von Dateien angezeigt werden, wie unten gezeigt.

Beachten Sie auch, dass die Aktion unseres Formulars unzip/upload ist, wo die Daten veröffentlicht werden. Wir haben den form_open_multipart-Helper verwendet, um das mehrteilige Formular-Tag zu generieren!

Als Nächstes müssen wir die upload-Aktionsmethode implementieren, die das Hochladen und Extrahieren von Dateien verarbeitet. Holen Sie sich den Code davon aus dem Unzip.php-Controller.

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

Wenn Sie mit dem Hochladen von Dateien in CodeIgniter vertraut sind, sollte Ihnen der Code nicht fremd erscheinen. Für diejenigen, die nicht vertraut sind, gibt es keinen Grund zur Sorge, da die integrierten Upload-APIs in CodeIgniter es zum Kinderspiel machen.

Der folgende Code lädt die Upload-Bibliothek mit einer anfänglichen Konfiguration, die von der Array-Variablen $config bereitgestellt wird.

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

Wir haben es so konfiguriert, dass die hochgeladene Datei im Verzeichnis uploads im Stammverzeichnis der Anwendung abgelegt wird und der Benutzer nur ZIP-Dateien hochladen darf.

Als nächstes haben wir überprüft, ob der Datei-Upload fehlgeschlagen ist, und wenn dies der Fall ist, rufen wir eine hilfreiche Fehlermeldung ab und weisen sie $params zu, damit wir sie in der Vorlage anzeigen können.

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

In diesem Fall wurde die Datei erfolgreich hochgeladen, sodass der nächste Schritt darin besteht, den Dateipfad der hochgeladenen Datei abzurufen.

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

Schließlich instanziieren wir ein ZipArchive-Objekt, öffnen unsere Zip-Datei und extrahieren sie in das uploads-Verzeichnis.

$zip = new ZipArchive;

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

War das nicht einfach?

Das einzige, was uns bleibt, ist, die Ansicht file_upload_result aufzurufen, und so sollte sie aussehen!

Das ist also der andere Teil der Geschichte!

Refaktorieren Sie den Entpackcode in eine Bibliothek

Sie hätten bemerkt, dass die upload-Methode den ZipArchive-Code enthält, der die hochgeladene Datei extrahiert. Was ist, wenn Sie diesen Code an mehreren Stellen verwenden müssen? Sie könnten versucht sein, den Code nach Bedarf zu kopieren und einzufügen.

Tatsächlich gibt es eine bessere Möglichkeit, mit CodeIgniter Code zu zentralisieren, der in der gesamten Anwendung verwendet werden kann. Sie könnten eine benutzerdefinierte Bibliothek erstellen.

Fahren Sie fort und erstellen Sie eine Datei application/libraries/Extractor.php mit dem folgenden Inhalt.

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

Ersetzen Sie nun die upload-Methode in Ihrem Unzip.php-Controller durch die folgende.

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

Wie Sie sehen, haben wir unsere benutzerdefinierte Bibliothek geladen und zum Extrahieren der Inhalte verwendet!

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

Ziemlich cool, oder?

Und ja, das ist das Ende dieses Artikels.

Abschluss

Ich hoffe, Ihnen hat dieser Artikel gefallen, in dem wir damit begonnen haben, die zentrale ZIP-Bibliothek des CodeIgniter-Frameworks und verschiedene Möglichkeiten zum Erstellen eines ZIP-Archivs zu erkunden. Im zweiten Teil habe ich erklärt, wie Sie von Benutzern hochgeladene Dateien mit der ZipArchive-PHP-Erweiterung entpacken können.

Dabei hatten wir auch die Möglichkeit, unseren Code in eine benutzerdefinierte CodeIgniter-Bibliothek zu konvertieren, und das ist so etwas wie ein Sahnehäubchen, würde ich sagen!

Lassen Sie es mich wissen, wenn Sie Fragen und Vorschläge haben, die Sie mit dem unten stehenden Feed aufnehmen könnten.