Add maximum option

Author: sylvainjule

README.md

@@ -58,6 +58,17 @@ return [
 
 The backups list isn't paginated because it is not intended to keep hundreds of backups around. If included in a client website, you should include a note specifying an expected frequency of backup creation / deletion (or set up a CRON job).
 
+You can enforce a maximum number of backups by setting the `maximum` option to any integer (default is `false`).
+If this number is reached the oldest backup will be deleted automatically whenever a new backup is created.
+
+```php
+// site/config.php
+return [
+    'sylvainjule.backups.maximum' => 5,
+];
+```
+
+
 There's also a way to disable the "Backups" menu-item for specific user roles:
 
 ```yml

index.php

@@ -33,14 +33,23 @@
     ],
     'options' => [
         'publicFolder' => 'backups-temp',
-        'prefix' => 'backup-'
+        'prefix'       => 'backup-',
+        'maximum'      => false,
     ],
     'api' => [
         'routes' => [
             [
                 'pattern' => 'backups/create-backup',
                 'action'  => function() {
-                    $output = realpath(kirby()->roots()->accounts() .'/../') . '/backups/'. option('sylvainjule.backups.prefix') .'{{ timestamp }}.zip';
+                    $maximum = option('sylvainjule.backups.maximum');
+                    $b = new SylvainJule\Backups();
+                    $bCount = $b->getBackupsCount();
+
+                    $output  = realpath(kirby()->roots()->accounts() .'/../') . '/backups/'. option('sylvainjule.backups.prefix') .'{{ timestamp }}.zip';
+
+                    if($maximum && $bCount == $maximum) {
+                        $b->deleteOldestBackup();
+                    }
 
                     return janitor()->command('janitor:backupzip --output '. $output .' --quiet');
                 }

lib/backups.php

@@ -28,6 +28,10 @@ public function getBackupsArray($toApi = false) {
         return $backups;
     }
 
+    public function getBackupsCount() {
+        return count($this->getBackupsArray());
+    }
+
     public function getToDeleteArray($stamp) {
         $backups = $this->getBackupsArray();
 
@@ -50,6 +54,13 @@ public function deleteBackup($filename) {
         return $deleted;
     }
 
+    public function deleteOldestBackup() {
+        $backups  = $this->getBackupsArray();
+        $filename = end($backups);
+
+        $this->deleteBackup($filename);
+    }
+
     public function simulateDeletion($period) {
         $stamp    = $this->toTimestamp($period);
         $backups  = $this->getBackupsArray();