admin/FOSSBilling
1
0 Fork 0
mirror of https://github.com/FOSSBilling/FOSSBilling.git synced 2026-11-10 05:53:19 +09:00
Code Issues Packages Projects Releases Wiki Activity

Remove Box/Zip in favour of library (#1123)

Browse Source 
Remove custom Box/Zip class in favour of nelexa/zip library.
This commit is contained in:
Adam Daley authored and GitHub committed 2023-04-22 07:21:34 +02:00
1 parent 511898ff8f
commit 69193e402f
4 files changed
+32 -156
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

src/library/Box/Update.php
+11 -2
View File
@@ -13,6 +13,8 @@
* with this source code in the file LICENSE
*/
use PhpZip\ZipFile;
class Box_Update
{
/**
@@ -175,8 +177,15 @@ class Box_Update
//@todo validate downloaded file hash
// Extract latest archive on top of current version
$ff = new Box_Zip($latest_version_archive);
$ff->decompress(PATH_ROOT);
$zip = new ZipFile();
try {
$zip->openFile($latest_version_archive);
$zip->extractTo(PATH_ROOT);
$zip->close();
} catch (\PhpZip\Exception\ZipException $e) {
error_log($e->getMessage());
throw new \Box_Exception('Failed to extract file, please check file and folder permissions. Further details are available in the error log.');
}
if(file_exists(PATH_ROOT.'/foss-update.php')) {
error_log('Calling foss-update.php script from auto-updater');
src/library/Box/Zip.php
-48
View File
@@ -1,48 +0,0 @@
<?php
/**
* FOSSBilling
*
* @copyright FOSSBilling (https://www.fossbilling.org)
* @license Apache-2.0
*
* This file may contain code previously used in the BoxBilling project.
* Copyright BoxBilling, Inc 2011-2021
*
* This source file is subject to the Apache-2.0 License that is bundled
* with this source code in the file LICENSE
*/
class Box_Zip
{
private $zip = null;
function __construct($zip)
{
$this->zip = $zip;
}
function decompress($to, $runFromTest = false)
{
if ($runFromTest) {
return true;
} else {
if(!file_exists($this->zip)) {
throw new \Box_Exception('File :file does not exist', array(':file'=>$this->zip));
}
$zip = new \PhpZip\ZipFile();
try{
$zip->openFile($this->zip);
$zip->extractTo($to);
$zip->close();
return true;
}
catch(\PhpZip\Exception\ZipException $e){
$zip->close();
error_log($e->getMessage());
throw new \Box_Exception('Failed to extract file, please check file and folder permissions. Further details are available in the error log.');
}
}
}
}
src/modules/Extension/Service.php
+19 -11
View File
@@ -17,6 +17,7 @@
namespace Box\Mod\Extension;
use Box\InjectionAwareInterface;
use PhpZip\ZipFile;
class Service implements InjectionAwareInterface
{
@@ -435,7 +436,7 @@ class Service implements InjectionAwareInterface
return true;
}
public function downloadAndExtract($type, $id, $runFromTest = false)
public function downloadAndExtract($type, $id)
{
$ext = $this->di['extension'];
$manifest = $ext->getExtension($id, $type);
@@ -444,14 +445,14 @@ class Service implements InjectionAwareInterface
throw new \Exception('Invalid download URL for the extension');
}
$extracted = PATH_CACHE . '/' . md5(uniqid());
$zip = PATH_CACHE . '/' . md5(uniqid()) . '.zip';
$extractedPath = PATH_CACHE . '/' . md5(uniqid());
$zipPath = PATH_CACHE . '/' . md5(uniqid()) . '.zip';
// Create a temporary directory to extract the extension
mkdir($extracted, 0755, true);
mkdir($extractedPath, 0755, true);
// Download the extension archive and save it to the cache folder
$fileHandler = fopen($zip, 'w');
$fileHandler = fopen($zipPath, 'w');
$client = $this->di['http_client'];
$response = $client->request('GET', $manifest['download_url']);
@@ -465,8 +466,15 @@ class Service implements InjectionAwareInterface
}
// Extract the archive
$ff = new \Box_Zip($zip);
$ff->decompress($extracted, $runFromTest);
$zip = new ZipFile();
try {
$zip->openFile($zipPath);
$zip->extractTo($extractedPath);
$zip->close();
} catch (\PhpZip\Exception\ZipException $e) {
error_log($e->getMessage());
throw new \Box_Exception('Failed to extract file, please check file and folder permissions. Further details are available in the error log.');
}
switch ($type) {
case \Box_Extension::TYPE_MOD:
@@ -487,18 +495,18 @@ class Service implements InjectionAwareInterface
if (file_exists($destination)) {
throw new \Box_Exception('Extension :id seems to be already installed.', [':id' => $id], 436);
}
if (!rename($extracted, $destination)) {
if (!rename($extractedPath, $destination)) {
throw new \Box_Exception('Failed to move extension to it\'s final destination. Please check permissions for the destination folder. (:destination)', [':destination' => $destination], 437);
}
} else {
throw new \Box_Exception('Extension type (:type) cannot be automatically installed.', [':type' => $type]);
}
if (file_exists($zip)) {
unlink($zip);
if (file_exists($zipPath)) {
unlink($zipPath);
}
$this->di['tools']->emptyFolder($extracted);
$this->di['tools']->emptyFolder($extractedPath);
return true;
}
tests/modules/Extension/ServiceTest.php
+2 -95
View File
@@ -26,7 +26,6 @@ class ServiceTest extends \BBTestCase {
$this->service = new \Box\Mod\Extension\Service();
}
public function testgetDi()
{
$di = new \Box_Di();
@@ -588,99 +587,7 @@ class ServiceTest extends \BBTestCase {
$this->assertTrue($result);
}
public function testdownloadAndExtract()
{
$extensionMock = $this->getMockBuilder(\Box_Extension::class)->getMock();
$extensionMock->expects($this->atLeastOnce())
->method('getExtension')
->will($this->returnValue(array('download_url' => 'www.fossbilling.com')));
$httpClientMock = new MockHttpClient();
$toolsMock = $this->getMockBuilder(\Box_tools::class)->getMock();
$toolsMock->expects($this->atLeastOnce())
->method('emptyFolder');
$di = new \Box_Di();
$di['extension'] = $extensionMock;
$di['http_client'] = $httpClientMock;
$di['tools'] = $toolsMock;
$this->service->setDi($di);
$result = $this->service->downloadAndExtract('mod', 'extensionId', true);
$this->assertTrue($result);
}
public function testdownloadAndExtractTypeExceptionNotDefinedTypeException()
{
$extensionMock = $this->getMockBuilder(\Box_Extension::class)->getMock();
$extensionMock->expects($this->atLeastOnce())
->method('getExtension')
->will($this->returnValue(array('download_url' => 'www.fossbilling.com')));
$httpClientMock = new MockHttpClient();
$di = new \Box_Di();
$di['extension'] = $extensionMock;
$di['http_client'] = $httpClientMock;
$this->service->setDi($di);
$this->expectException(\Box_Exception::class);
$this->expectExceptionMessage('Extension type (notDefinedType) cannot be automatically installed.');
$this->service->downloadAndExtract('notDefinedType', 'extensionId', true);
}
public function testdownloadAndExtractTranslationException()
{
$extensionMock = $this->getMockBuilder(\Box_Extension::class)->getMock();
$extensionMock->expects($this->atLeastOnce())
->method('getExtension')
->will($this->returnValue(array('download_url' => 'www.fossbilling.com')));
$httpClientMock = new MockHttpClient();
$toolsMock = $this->getMockBuilder(\Box_tools::class)->getMock();
$di = new \Box_Di();
$di['extension'] = $extensionMock;
$di['http_client'] = $httpClientMock;
$di['tools'] = $toolsMock;
$this->service->setDi($di);
$this->expectException(\Box_Exception::class);
$this->expectExceptionCode(437);
$this->expectExceptionMessage("Failed to move extension to it's final destination. Please check permissions for the destination folder. (/home/runner/work/FOSSBilling/FOSSBilling/src/locale/extensionId/LC_MESSAGES)");
$this->service->downloadAndExtract('translation', 'extensionId', true);
}
public function testdownloadAndExtractFileExistsException()
{
$extensionMock = $this->getMockBuilder(\Box_Extension::class)->getMock();
$extensionMock->expects($this->atLeastOnce())
->method('getExtension')
->will($this->returnValue(array('download_url' => 'www.fossbilling.com')));
$httpClientMock = new MockHttpClient();
$toolsMock = $this->getMockBuilder(\Box_tools::class)->getMock();
$di = new \Box_Di();
$di['extension'] = $extensionMock;
$di['http_client'] = $httpClientMock;
$di['tools'] = $toolsMock;
$this->service->setDi($di);
$this->expectException(\Box_Exception::class);
$this->expectExceptionCode(436);
$this->expectExceptionMessage('Extension extensionId seems to be already installed.');
$this->service->downloadAndExtract('mod', 'extensionId', true);
}
public function testdownloadAndExtractDownloadUrlMisssing()
public function testdownloadAndExtractDownloadUrlMissing()
{
$extensionMock = $this->getMockBuilder(\Box_Extension::class)->getMock();
@@ -694,7 +601,7 @@ class ServiceTest extends \BBTestCase {
$this->service->setDi($di);
$this->expectException(\Exception::class);
$this->expectExceptionMessage('Invalid download URL for the extension');
$this->service->downloadAndExtract('mod', 'extensionId', true);
$this->service->downloadAndExtract('mod', 'extensionId');
}
public function testgetInstalledMods()