mirror of
https://github.com/InvoiceShelf/InvoiceShelf.git
synced 2026-07-16 22:05:20 +00:00
The v2 self-updater only overlays new files (copyFiles) and never removes files a release deleted; the one removal path (deleted_files) is not even sent by the web UI. A major upgrade (v2 → v3) removes thousands of files, so overlay-only leaves a broken hybrid, and stale bootstrap/cache config + package-discovery survive and break the new boot. Backport v3's manifest allow-list approach into this final v2 release: - Updater::cleanStaleFiles(?string $basePath): delete every file under the install not listed in the release's manifest.json, except the configured update_protected_paths. No manifest present → safe no-op (v2→v2 updates). - Updater::clearCompiledCaches(): wipe bootstrap/cache/*.php and compiled views so the freshly copied release re-reads config and re-runs package discovery. Called at the end of copyFiles() — the last point that runs as the currently-installed code before the new release boots, and necessary because bootstrap/cache is itself a protected path. - DeleteFilesController + UpdateCommand: when manifest.json is present, run cleanStaleFiles(); otherwise fall back to the legacy deleted_files list. No route or frontend change — both already call the delete step between copy and migrate. - config/invoiceshelf.php: add update_protected_paths (.env, storage, vendor, node_modules, Modules, public/storage, .git, bootstrap/cache, manifest.json). The v3 release zip already ships manifest.json (built by its make dist), so a v2 instance running this updater cleans itself up correctly on upgrade. Tested: tests/Unit/UpdaterTest.php covers stale removal, protected-path and manifest preservation, empty-dir pruning, no-manifest no-op, and invalid manifest. Full suite green.
247 lines
5.7 KiB
PHP
247 lines
5.7 KiB
PHP
<?php
|
|
|
|
namespace App\Console\Commands;
|
|
|
|
use App\Space\Updater;
|
|
use Illuminate\Console\Command;
|
|
use Illuminate\Support\Facades\File;
|
|
|
|
// Implementation taken from Akaunting - https://github.com/akaunting/akaunting
|
|
class UpdateCommand extends Command
|
|
{
|
|
public $installed;
|
|
|
|
public $version;
|
|
|
|
public $response;
|
|
|
|
/**
|
|
* The name and signature of the console command.
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $signature = 'core:update';
|
|
|
|
/**
|
|
* The console command description.
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $description = 'Automatically update your InvoiceShelf Core App';
|
|
|
|
/**
|
|
* Create a new command instance.
|
|
*
|
|
* @return void
|
|
*/
|
|
public function __construct()
|
|
{
|
|
parent::__construct();
|
|
}
|
|
|
|
/**
|
|
* Execute the console command.
|
|
*/
|
|
public function handle(): void
|
|
{
|
|
set_time_limit(3600); // 1 hour
|
|
|
|
$this->installed = $this->getInstalledVersion();
|
|
$this->response = $this->getLatestVersionResponse();
|
|
$this->version = ($this->response) ? $this->response->version : false;
|
|
|
|
if ($this->response == 'extension_required') {
|
|
$this->info('Sorry! Your system does not meet the minimum requirements for this update.');
|
|
$this->info('Please retry after installing the required version/extensions.');
|
|
|
|
return;
|
|
}
|
|
|
|
if (! $this->version) {
|
|
$this->info('No Update Available! You are already on the latest version.');
|
|
|
|
return;
|
|
}
|
|
|
|
if (! $this->confirm("Do you wish to update to {$this->version}?")) {
|
|
return;
|
|
}
|
|
|
|
if (! $path = $this->download()) {
|
|
return;
|
|
}
|
|
|
|
if (! $path = $this->unzip($path)) {
|
|
return;
|
|
}
|
|
|
|
if (! $this->copyFiles($path)) {
|
|
return;
|
|
}
|
|
|
|
if (! $this->cleanFiles()) {
|
|
return;
|
|
}
|
|
|
|
if (! $this->migrateUpdate()) {
|
|
return;
|
|
}
|
|
|
|
if (! $this->finish()) {
|
|
return;
|
|
}
|
|
|
|
$this->info('Successfully updated to '.$this->version);
|
|
}
|
|
|
|
public function getInstalledVersion()
|
|
{
|
|
return preg_replace('~[\r\n]+~', '', File::get(base_path('version.md')));
|
|
}
|
|
|
|
public function getLatestVersionResponse()
|
|
{
|
|
$this->info('Your currently installed version is '.$this->installed);
|
|
$this->line('');
|
|
$this->info('Checking for update...');
|
|
|
|
try {
|
|
$response = Updater::checkForUpdate($this->installed);
|
|
|
|
if ($response->success) {
|
|
$extensions = $response->version->extensions;
|
|
|
|
$is_required = false;
|
|
|
|
foreach ($extensions as $key => $extension) {
|
|
if (! $extension) {
|
|
$is_required = true;
|
|
$this->info('❌ '.$key);
|
|
}
|
|
|
|
$this->info('✅ '.$key);
|
|
}
|
|
|
|
if ($is_required) {
|
|
return 'extension_required';
|
|
}
|
|
|
|
return $response->version;
|
|
}
|
|
|
|
return false;
|
|
} catch (\Exception $e) {
|
|
$this->error($e->getMessage());
|
|
|
|
return false;
|
|
}
|
|
}
|
|
|
|
public function download()
|
|
{
|
|
$this->info('Downloading update...');
|
|
|
|
try {
|
|
$path = Updater::download($this->version, 1);
|
|
if (! is_string($path)) {
|
|
$this->error('Download exception');
|
|
|
|
return false;
|
|
}
|
|
} catch (\Exception $e) {
|
|
$this->error($e->getMessage());
|
|
|
|
return false;
|
|
}
|
|
|
|
return $path;
|
|
}
|
|
|
|
public function unzip($path)
|
|
{
|
|
$this->info('Unzipping update package...');
|
|
|
|
try {
|
|
$path = Updater::unzip($path);
|
|
if (! is_string($path)) {
|
|
$this->error('Unzipping exception');
|
|
|
|
return false;
|
|
}
|
|
} catch (\Exception $e) {
|
|
$this->error($e->getMessage());
|
|
|
|
return false;
|
|
}
|
|
|
|
return $path;
|
|
}
|
|
|
|
public function copyFiles($path)
|
|
{
|
|
$this->info('Copying update files...');
|
|
|
|
try {
|
|
Updater::copyFiles($path);
|
|
} catch (\Exception $e) {
|
|
$this->error($e->getMessage());
|
|
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
public function cleanFiles()
|
|
{
|
|
try {
|
|
// When the release ships a manifest.json (e.g. v3), remove every stale file
|
|
// not listed in it. Otherwise fall back to the explicit deleted_files list
|
|
// for same-line updates.
|
|
if (File::exists(base_path('manifest.json'))) {
|
|
$this->info('Cleaning stale files...');
|
|
Updater::cleanStaleFiles();
|
|
} elseif (isset($this->response->deleted_files) && ! empty($this->response->deleted_files)) {
|
|
$this->info('Deleting unused old files...');
|
|
Updater::deleteFiles($this->response->deleted_files);
|
|
}
|
|
} catch (\Exception $e) {
|
|
$this->error($e->getMessage());
|
|
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
public function migrateUpdate()
|
|
{
|
|
$this->info('Running Migrations...');
|
|
|
|
try {
|
|
Updater::migrateUpdate();
|
|
} catch (\Exception $e) {
|
|
$this->error($e->getMessage());
|
|
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
public function finish()
|
|
{
|
|
$this->info('Finishing update...');
|
|
|
|
try {
|
|
Updater::finishUpdate($this->installed, $this->version);
|
|
} catch (\Exception $e) {
|
|
$this->error($e->getMessage());
|
|
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
}
|