Merge branch 'master' of https://github.com/breadlesscode/neos-backups

Author: Alex Schulte

.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: [breadlesscode]
+patreon: breadlesscode
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.github/workflows/documentation.yml

@@ -1,12 +1,12 @@
 name: 'Build & Deploy Documentation'
 
 on:
-  release:
-    types:
-      - created
-#  push:
-#    branches:
-#      - master
+#  release:
+#    types:
+#      - created
+  push:
+    branches:
+      - master
 
 jobs:
   build:

Classes/Command/BackupCommandController.php

@@ -31,6 +31,9 @@ public function createCommand(): void
 
     /**
      * restores a single backup of a specific package
+     *
+     * @param string $name The name of the backup you want to restore
+     * @param bool $noConfirm If true, you dant have to confirm the restore action
      */
     public function restoreCommand(string $name, bool $noConfirm = false): void
     {
@@ -53,7 +56,7 @@ public function restoreCommand(string $name, bool $noConfirm = false): void
         }
 
         if ($noConfirm === false) {
-            $shouldRestore = $this->output->askConfirmation('Are you sure you want to restore this Backup?', false);
+            $shouldRestore = $this->output->askConfirmation('Are you sure you want to restore this Backup? ', false);
         }
 
         if(!$shouldRestore) {
@@ -73,6 +76,9 @@ public function restoreCommand(string $name, bool $noConfirm = false): void
 
     /**
      * lists all backups
+     *
+     * @param int $offset Offset
+     * @param int $limit Number of backups shown
      */
     public function listCommand($offset = 0, $limit = 60): void
     {
@@ -89,13 +95,16 @@ public function listCommand($offset = 0, $limit = 60): void
 
     /**
      * deletes backups
+     *
+     * @param string $name The name of the backup you want to delete
+     * @param bool $noConfirm If true, you dant have to confirm the delete action
      */
     public function deleteCommand(string $name, bool $noConfirm = false): void
     {
         $confirmed = true;
 
         if (!$noConfirm) {
-            $confirmed = $this->output->askConfirmation('Are you sure you want to delete this backup?');
+            $confirmed = $this->output->askConfirmation('Are you sure you want to delete this backup? ');
         }
 
         if (!$confirmed) {
@@ -114,6 +123,43 @@ public function deleteCommand(string $name, bool $noConfirm = false): void
         }
     }
 
+    /**
+     * deletes all backups, but can keep X latest backups
+     *
+     * @param int $keep keep the latest X backups
+     * @param bool $noConfirm If true, you dant have to confirm the delete action
+     */
+    public function pruneCommand(int $keep = 0, bool $noConfirm = false): void
+    {
+        $confirmed = true;
+
+        if (!$noConfirm) {
+            $question = ($keep > 0 ? ', except the latest '.$keep.' backups': '');
+            $question = 'Are you sure you want to delete all backups'.$question.'? ';
+            $confirmed = $this->output->askConfirmation($question);
+        }
+
+        if (!$confirmed) {
+            $this->outputLine();
+            $this->outputLine('<error>Canceled by user</error>');
+            $this->quit();
+        }
+
+        $backupCount = $this->backupService->getCount();
+        $backups = $this->backupService->getBackups($keep, $backupCount);
+
+        $this->output('Deleting '.($backupCount - $keep <= 0 ? '0': $backupCount - $keep).' backups...');
+
+        try {
+            foreach ($backups as $backup) {
+                $this->backupService->deleteBackup($backup['name']);
+            }
+            $this->outputLine('<success>success</success>');
+        } catch (\Exception $e) {
+            $this->outputError($e->getMessage());
+        }
+    }
+
     protected function outputError(string $message): void
     {
         $this->outputLine('<error>failed</error>');

Classes/Service/BackupIndexService.php

@@ -128,6 +128,11 @@ public function deleteBackup(string $name)
         return $success;
     }
 
+    public function getCount(): int
+    {
+        return $this->getReader()->count();
+    }
+
     public function getBackups(int $start = 0, int $limit = 25): array
     {
         $reader = $this->getReader();

Classes/Service/BackupService.php

@@ -10,9 +10,11 @@
 use League\Flysystem\Filesystem;
 use Neos\Flow\Annotations as Flow;
 use Neos\Flow\Exception;
+use Neos\Flow\Log\PsrLoggerFactoryInterface;
 use Neos\Flow\ObjectManagement\ObjectManagerInterface;
 use Neos\Flow\Persistence\Doctrine\PersistenceManager;
 use Neos\Utility\Files;
+use Psr\Log\LoggerInterface;
 
 /**
  * @Flow\Scope(value="singleton")
@@ -45,6 +47,11 @@ class BackupService
      */
     protected $persistenceManager;
 
+    /**
+     * @var LoggerInterface#
+     */
+    protected $logger;
+
     public function __construct(ObjectManagerInterface $objectManager)
     {
         $this->objectManager = $objectManager;
@@ -54,8 +61,12 @@ public function initializeObject()
     {
         $this->indexService = $this->objectManager->get(BackupIndexService::class);
         $this->persistenceManager = $this->objectManager->get(PersistenceManager::class);
+
         $filesystemFactory = $this->objectManager->get(FilesystemFactory::class);
         $this->filesystem = $filesystemFactory->get($this->config['filesystem']['type']);
+
+        $loggerFactory = $this->objectManager->get(PsrLoggerFactoryInterface::class);
+        $this->logger = $loggerFactory->get('backupLogger');
     }
 
     public function getBackups(int $start = 0, int $limit = 0): array
@@ -71,11 +82,14 @@ public function getBackups(int $start = 0, int $limit = 0): array
     public function deleteBackup(string $name): bool
     {
         $this->indexService->deleteBackup($name);
+        $backupFilename = $this->getCompressor()->generateFilename($name);
 
-        if ($this->filesystem->has($name)) {
-            $this->filesystem->delete($name);
+        if ($this->filesystem->has($backupFilename)) {
+            $this->filesystem->delete($backupFilename);
         }
 
+        $this->logger->info('deleted backup '.$name);
+
         return true;
     }
 
@@ -102,6 +116,10 @@ public function restoreBackup(string $name)
         }
         // persist all changes from the steps
         $this->persistenceManager->persistAll();
+        $this->logger->info('restored backup '.$name);
+        // delete temp stuff
+        Files::removeDirectoryRecursively($backupPath);
+        Files::unlink($archivePath);
     }
 
 
@@ -136,6 +154,7 @@ public function createBackup()
         Files::removeDirectoryRecursively($backupPath);
         // update index
         $this->indexService->addBackup($backupName, new \DateTime(), $meta);
+        $this->logger->info('added backup '.$backupName);
     }
 
     /**
@@ -191,6 +210,10 @@ public function getStepsInstances(string $backupPath, array $whiteList = null):
         return $steps;
     }
 
+    public function getCount(): int
+    {
+        return $this->indexService->getCount();
+    }
 
     public function noStepsConfigured(): bool
     {

Classes/Step/FileExportStep.php

@@ -19,11 +19,7 @@ public function backup(): bool
         foreach ($copyPaths as $folderName => $path) {
             $tmpBackupPath = Files::concatenatePaths([$this->getBackupStepPath(), $folderName]);
 
-            if (is_dir($path)) {
-                $this->copyDirectory($path, $tmpBackupPath);
-            } else {
-                copy($path, $tmpBackupPath);
-            }
+            Files::copyDirectoryRecursively($path, $tmpBackupPath);
         }
 
         return true;
@@ -36,11 +32,9 @@ public function restore(): bool
         foreach ($copyPaths as $folderName => $path) {
             $tmpBackupPath = Files::concatenatePaths([$this->getBackupStepPath(), $folderName]);
 
-            if (is_dir($path)) {
-                $this->copyDirectory($tmpBackupPath, $path);
-            } else {
-                copy($tmpBackupPath, $path);
-            }
+            Files::removeDirectoryRecursively($path);
+            Files::createDirectoryRecursively($path);
+            Files::copyDirectoryRecursively($tmpBackupPath, $path);
         }
 
         return true;
@@ -60,27 +54,4 @@ public function getRestoreWarning(): ?string
 
         return $restoreWarning;
     }
-
-    protected function copyDirectory(string $source, string $dest)
-    {
-        $dir = opendir($source);
-        mkdir($dest);
-
-        while(false !== ($file = readdir($dir))) {
-            if ($file === '.' || $file === '..') {
-                continue;
-            }
-
-            $srcFile = $source.'/'.$file;
-            $destFile = $dest.'/'.$file;
-
-            if (is_dir($srcFile)) {
-                $this->copyDirectory($srcFile, $destFile);
-            } else {
-                copy($srcFile, $destFile);
-            }
-        }
-
-        closedir($dir);
-    }
 }

Configuration/Settings.Log.yaml

@@ -0,0 +1,14 @@
+Neos:
+  Flow:
+    log:
+      psr3:
+        'Neos\Flow\Log\PsrLoggerFactory':
+          backupLogger:
+            default:
+              class: Neos\Flow\Log\Backend\FileBackend
+              options:
+                 logFileURL: '%FLOW_PATH_DATA%Logs/Backup.log'
+                 createParentDirectories: true
+                 severityThreshold: '%LOG_INFO%'
+                 maximumLogFileSize: 10485760
+                 logFilesToKeep: 1

Documentation/.vuepress/config.js

@@ -1,6 +1,23 @@
+const socialMeta = {
+    title: 'Neos Backups',
+    description: 'Easy backup management plugin for Neos CMS',
+    image: 'https://repository-images.githubusercontent.com/235191200/234dfe80-4129-11ea-9f1d-a938b96ec553',
+    url: 'https://breadlesscode.github.io/neos-backups'
+};
+
 module.exports = {
     title: 'Neos Backups',
     base: process.env.NODE_ENV === 'production'? '/neos-backups/': '/',
+    head: [
+        ['meta', {property: 'og:title', content: socialMeta.title}],
+        ['meta', {property: 'og:description', content: socialMeta.description}],
+        ['meta', {property: 'og:image', content: socialMeta.image}],
+        ['meta', {property: 'og:url', content: socialMeta.url}],
+        ['meta', {property: 'twitter:title', content: socialMeta.title}],
+        ['meta', {property: 'twitter:description', content: socialMeta.description}],
+        ['meta', {property: 'twitter:image', content: socialMeta.image}],
+        ['meta', {property: 'twitter:card', content: 'summary_large_image'}],
+    ],
     themeConfig: {
         nav: [
             {text: 'Github', link: 'https://github.com/breadlesscode/neos-backups'}
@@ -9,6 +26,7 @@ module.exports = {
             '/installation',
             '/filesystems',
             '/steps',
+            '/commands',
             '/custom-behaviours'
         ],
         theme: '@vuepress/theme-default',

Documentation/README.md

@@ -3,15 +3,15 @@ home: true
 editLink: false
 heroImage: /neos-backups.svg
 heroText: Neos Backups
-tagline: Easy backup and restore your Neos CMS in different filesystems
+tagline: Easily backup and restore your Neos CMS in different file systems
 actionText: Get Started →
 actionLink: /installation
 features:
-- title: Easy customizable
-  details: You can easily add your own backup steps or add your own filesystem adapter.
-- title: Free
-  details: Its free, why not use it? Its always better to have backups.
+- title: Easily customizable
+  details: You can easily add your own backup steps or add your own file system adapter.
+- title: Easy to use
+  details: Everything is ready to use. For a normal backup you don't have to write a single line of code. 
 - title: Open Source
-  details: You discovered a bug? No problem, go to the Github page and report it. 
+  details: It's free, why not use it? It's always better to have backups.
 footer: GPL-3.0 Licensed | Copyright © 2020 by Marvin Kuhn
 ---