Joomla! Programmierung/Framework/JArchive/extract

Beschreibung

JArchive/extract dient zum Entpacken von Archiven.

Syntax

extract( $archivename, $extractdir )

• @return boolean true bei Erfolg
• @since

Parameter	Datentyp	Beschreibung	Standardwert
$archivename	string	Der Name der Archivdatei	---
$extractdir	string	Der Pfad in welchen das Archiv entpackt werden soll	---

Beispiele

Ein Archiv entpacken

Das tar.gz Archiv

•  mein_archiv.tar.gz

im Ordner

•  JPATH_COMPONENT
  •  archiv_ordner

soll im Unterordner

•  JPATH_COMPONENT
  •  archiv_ordner
    •  neues_verzeichnis

entpackt werden.

$dateiPfad = JPATH_COMPONENT.DS.'archiv_ordner';
$dateiName = 'mein_archiv.tar.gz';
 
if( JArchive::extract($dateiPfad.DS.$dateiName, $dateiPfad.DS.'neues_verzeichnis') )
{
    //-- Das Archiv wurde erfolgreich entpackt
}
else
{
    //-- Es trat ein Fehler auf
}

Quellcode

 libraries

•  joomla
  •  filesystem
    •  archive.php

public static function extract($archivename, $extractdir)
{
   jimport('joomla.filesystem.file');
   jimport('joomla.filesystem.folder');
 
   $untar = false;
   $result = false;
   $ext = JFile::getExt(strtolower($archivename));
 
   // Check if a tar is embedded...gzip/bzip2 can just be plain files!
   if (JFile::getExt(JFile::stripExt(strtolower($archivename))) == 'tar')
   {
      $untar = true;
   }
 
   switch ($ext)
   {
      case 'zip':
         $adapter = JArchive::getAdapter('zip');
 
         if ($adapter)
         {
            $result = $adapter->extract($archivename, $extractdir);
         }
         break;
 
      case 'tar':
         $adapter = JArchive::getAdapter('tar');
 
         if ($adapter)
         {
            $result = $adapter->extract($archivename, $extractdir);
         }
         break;
 
      case 'tgz':
         // This format is a tarball gzip'd
         $untar = true;
 
      case 'gz':
      case 'gzip':
         // This may just be an individual file (e.g. sql script)
         $adapter = JArchive::getAdapter('gzip');
 
         if ($adapter)
         {
            $config = JFactory::getConfig();
            $tmpfname = $config->get('tmp_path') . '/' . uniqid('gzip');
            $gzresult = $adapter->extract($archivename, $tmpfname);
 
            if ($gzresult instanceof Exception)
            {
               @unlink($tmpfname);
 
               return false;
            }
 
            if ($untar)
            {
               // Try to untar the file
               $tadapter = JArchive::getAdapter('tar');
 
               if ($tadapter)
               {
                  $result = $tadapter->extract($tmpfname, $extractdir);
               }
            }
            else
            {
               $path = JPath::clean($extractdir);
               JFolder::create($path);
               $result = JFile::copy($tmpfname, $path . '/' . JFile::stripExt(JFile::getName(strtolower($archivename))), null, 1);
            }
 
            @unlink($tmpfname);
         }
         break;
 
      case 'tbz2':
         // This format is a tarball bzip2'd
         $untar = true;
 
      case 'bz2':
      case 'bzip2':
         // This may just be an individual file (e.g. sql script)
         $adapter = JArchive::getAdapter('bzip2');
 
         if ($adapter)
         {
            $config = JFactory::getConfig();
            $tmpfname = $config->get('tmp_path') . '/' . uniqid('bzip2');
            $bzresult = $adapter->extract($archivename, $tmpfname);
 
            if ($bzresult instanceof Exception)
            {
               @unlink($tmpfname);
               return false;
            }
 
            if ($untar)
            {
               // Try to untar the file
               $tadapter = JArchive::getAdapter('tar');
 
               if ($tadapter)
               {
                  $result = $tadapter->extract($tmpfname, $extractdir);
               }
            }
            else
            {
               $path = JPath::clean($extractdir);
               JFolder::create($path);
               $result = JFile::copy($tmpfname, $path . '/' . JFile::stripExt(JFile::getName(strtolower($archivename))), null, 1);
            }
 
            @unlink($tmpfname);
         }
         break;
 
      default:
         JError::raiseWarning(10, JText::_('JLIB_FILESYSTEM_UNKNOWNARCHIVETYPE'));
         return false;
         break;
   }
 
   if (!$result || $result instanceof Exception)
   {
      return false;
   }
 
   return true;
}

Siehe auch

• JArchive->extract() auf api.joomla.org