added callback mechanism to show progress during ops

Author: splitbrain

src/Archive.php

@@ -10,6 +10,9 @@ abstract class Archive
     const COMPRESS_GZIP = 1;
     const COMPRESS_BZIP = 2;
 
+    /** @var callable */
+    protected $callback;
+
     /**
      * Set the compression level and type
      *
@@ -117,6 +120,18 @@ abstract public function getArchive();
      */
     abstract public function save($file);
 
+    /**
+     * Set a callback function to be called whenever a file is added or extracted.
+     *
+     * The callback is called with a FileInfo object as parameter. You can use this to show progress
+     * info during an operation.
+     *
+     * @param callable $callback
+     */
+    public function setCallback($callback)
+    {
+        $this->callback = $callback;
+    }
 }
 
 class ArchiveIOException extends \Exception

src/Tar.php

@@ -187,6 +187,9 @@ public function extract($outdir, $strip = '', $exclude = '', $include = '')
                 $this->skipbytes(ceil($header['size'] / 512) * 512); // the size is usually 0 for directories
             }
 
+            if(is_callable($this->callback)) {
+                call_user_func($this->callback, $fileinfo);
+            }
             $extracted[] = $fileinfo;
         }
 
@@ -276,6 +279,10 @@ public function addFile($file, $fileinfo = '')
             $this->close();
             throw new ArchiveCorruptedException("The size of $file changed while reading, archive corrupted. read $read expected ".$fileinfo->getSize());
         }
+
+        if(is_callable($this->callback)) {
+            call_user_func($this->callback, $fileinfo);
+        }
     }
 
     /**
@@ -302,6 +309,10 @@ public function addData($fileinfo, $data)
         for ($s = 0; $s < $len; $s += 512) {
             $this->writebytes(pack("a512", substr($data, $s, 512)));
         }
+
+        if (is_callable($this->callback)) {
+            call_user_func($this->callback, $fileinfo);
+        }
     }
 
     /**

src/Zip.php

@@ -155,6 +155,9 @@ public function extract($outdir, $strip = '', $exclude = '', $include = '')
 
             // nothing more to do for directories
             if ($fileinfo->getIsdir()) {
+                if(is_callable($this->callback)) {
+                    call_user_func($this->callback, $fileinfo);
+                }
                 continue;
             }
 
@@ -231,6 +234,9 @@ public function extract($outdir, $strip = '', $exclude = '', $include = '')
 
             touch($output, $fileinfo->getMtime());
             //FIXME what about permissions?
+            if(is_callable($this->callback)) {
+                call_user_func($this->callback, $fileinfo);
+            }
         }
 
         $this->close();
@@ -353,6 +359,10 @@ public function addData($fileinfo, $data)
             $name,
             (bool) $this->complevel
         );
+
+        if(is_callable($this->callback)) {
+            call_user_func($this->callback, $fileinfo);
+        }
     }
 
     /**

tests/TarTestCase.php

@@ -1,18 +1,21 @@
-<?php
+<?php /** @noinspection PhpUnhandledExceptionInspection */
 
 namespace splitbrain\PHPArchive;
 
-use splitbrain\PHPArchive\Tar;
-use PHPUnit\Framework\TestCase;
 use org\bovigo\vfs\vfsStream;
+use PHPUnit\Framework\TestCase;
 
 class TarTestCase extends TestCase
 {
+    /** @var int callback counter */
+    protected $counter = 0;
+
     /**
      * file extensions that several tests use
      */
     protected $extensions = array('tar');
 
+    /** @inheritdoc */
     protected function setUp()
     {
         parent::setUp();
@@ -27,12 +30,22 @@ protected function setUp()
         vfsStream::setup('home_root_path');
     }
 
+    /** @inheritdoc */
     protected function tearDown()
     {
         parent::tearDown();
         $this->extensions[] = null;
     }
 
+    /**
+     * Callback check function
+     * @param FileInfo $fileinfo
+     */
+    public function increaseCounter($fileinfo) {
+        $this->assertInstanceOf('\\splitbrain\\PHPArchive\\FileInfo', $fileinfo);
+        $this->counter++;
+    }
+
     /*
      * dependency for tests needing zlib extension to pass
      */
@@ -170,23 +183,30 @@ public function testDogfood()
             $archive = sys_get_temp_dir() . '/dwtartest' . md5(time()) . '.' . $ext;
             $extract = sys_get_temp_dir() . '/dwtartest' . md5(time() + 1);
 
+            $this->counter = 0;
             $tar = new Tar();
+            $tar->setCallback(array($this, 'increaseCounter'));
             $tar->create($archive);
             foreach ($input as $path) {
                 $file = basename($path);
                 $tar->addFile($path, $file);
             }
             $tar->close();
             $this->assertFileExists($archive);
+            $this->assertEquals(count($input), $this->counter);
 
+            $this->counter = 0;
             $tar = new Tar();
+            $tar->setCallback(array($this, 'increaseCounter'));
             $tar->open($archive);
             $tar->extract($extract, '', '/FileInfo\\.php/', '/.*\\.php/');
 
             $this->assertFileExists("$extract/Tar.php");
             $this->assertFileExists("$extract/Zip.php");
             $this->assertFileNotExists("$extract/FileInfo.php");
 
+            $this->assertEquals(count($input) - 1, $this->counter);
+
             $this->nativeCheck($archive, $ext);
 
             self::RDelete($extract);

tests/ZipTestCase.php

@@ -1,18 +1,30 @@
-<?php
+<?php /** @noinspection PhpUnhandledExceptionInspection */
 
 namespace splitbrain\PHPArchive;
 
-use splitbrain\PHPArchive\Zip;
-use PHPUnit\Framework\TestCase;
 use org\bovigo\vfs\vfsStream;
+use PHPUnit\Framework\TestCase;
 
 class ZipTestCase extends TestCase
 {
+    /** @var int callback counter */
+    protected $counter = 0;
+
+    /** @inheritdoc */
     protected function setUp()
     {
         vfsStream::setup('home_root_path');
     }
 
+    /**
+     * Callback check function
+     * @param FileInfo $fileinfo
+     */
+    public function increaseCounter($fileinfo) {
+        $this->assertInstanceOf('\\splitbrain\\PHPArchive\\FileInfo', $fileinfo);
+        $this->counter++;
+    }
+
     /*
      * dependency for tests needing zip extension to pass
      */
@@ -203,23 +215,30 @@ public function testDogFood()
         $archive = sys_get_temp_dir() . '/dwziptest' . md5(time()) . '.zip';
         $extract = sys_get_temp_dir() . '/dwziptest' . md5(time() + 1);
 
+        $this->counter = 0;
         $zip = new Zip();
+        $zip->setCallback(array($this, 'increaseCounter'));
         $zip->create($archive);
-        foreach($input as $path) {
+        foreach ($input as $path) {
             $file = basename($path);
             $zip->addFile($path, $file);
         }
         $zip->close();
         $this->assertFileExists($archive);
+        $this->assertEquals(count($input), $this->counter);
 
+        $this->counter = 0;
         $zip = new Zip();
+        $zip->setCallback(array($this, 'increaseCounter'));
         $zip->open($archive);
         $zip->extract($extract, '', '/FileInfo\\.php/', '/.*\\.php/');
 
         $this->assertFileExists("$extract/Tar.php");
         $this->assertFileExists("$extract/Zip.php");
         $this->assertFileNotExists("$extract/FileInfo.php");
 
+        $this->assertEquals(count($input) - 1, $this->counter);
+
         $this->nativeCheck($archive);
         $this->native7ZipCheck($archive);