add statistics on v1 pastes in administration script and an option to delete them

CHANGELOG.md

@@ -1,6 +1,7 @@
 # PrivateBin version history
 
 ## 2.0.0 (not yet released)
+* ADDED: Statistics on v1 pastes in administration script and option to delete them
 * CHANGED: Removed page template (#265)
 * CHANGED: Removed support for ZeroBin & v1 pastes - since release 1.3 the v2 format is used (#551)
 * CHANGED: Removed use of base64 & rawinflate libraries (#551)

bin/administration

@@ -72,20 +72,6 @@ class Administration
         exit("paste $pasteId successfully deleted" . PHP_EOL);
     }
 
-    /**
-     * lists all stored paste IDs
-     *
-     * @access private
-     */
-    private function _list_ids()
-    {
-        $ids = $this->_store->getAllPastes();
-        foreach ($ids as $pasteid) {
-            echo $pasteid, PHP_EOL;
-        }
-        exit;
-    }
-
     /**
      * deletes all stored pastes (regardless of expiration)
      *
@@ -101,6 +87,29 @@ class Administration
         exit("All pastes successfully deleted" . PHP_EOL);
     }
 
+    /**
+     * deletes all unsupported v1 pastes (regardless of expiration)
+     *
+     * @access private
+     */
+    private function _delete_v1()
+    {
+        $ids = $this->_store->getAllPastes();
+        foreach ($ids as $pasteid) {
+            try {
+                $paste = $this->_store->read($pasteid);
+            } catch (Exception $e) {
+                echo "Error reading paste {$pasteid}: ", $e->getMessage(), PHP_EOL;
+            }
+            if (array_key_exists('adata', $paste)) {
+                continue;
+            }
+            echo "Deleting v1 paste ID: $pasteid" . PHP_EOL;
+            $this->_store->delete($pasteid);
+        }
+        exit("All unsupported legacy v1 pastes successfully deleted" . PHP_EOL);
+    }
+
     /**
      * removes empty directories, if current storage model uses Filesystem
      *
@@ -153,11 +162,13 @@ class Administration
     {
         echo <<<'EOT'
 Usage:
-  administration [--delete <paste id> | --delete-all | --empty-dirs | --help | --list-ids | --purge | --statistics]
+  administration [--delete <paste id> | --delete-all | --delete-v1 |
+                  --empty-dirs | --help | --list-ids | --purge | --statistics]
 
 Options:
   -d, --delete      deletes the requested paste ID
-  --delete-all      deletes all paste IDs
+  --delete-all      deletes all pastes
+  --delete-v1       deletes all unsupported v1 pastes
   -e, --empty-dirs  removes empty directories (only if Filesystem storage is
                     configured)
   -h, --help        displays this help message
@@ -168,6 +179,20 @@ EOT, PHP_EOL;
         exit($code);
     }
 
+    /**
+     * lists all stored paste IDs
+     *
+     * @access private
+     */
+    private function _list_ids()
+    {
+        $ids = $this->_store->getAllPastes();
+        foreach ($ids as $pasteid) {
+            echo $pasteid, PHP_EOL;
+        }
+        exit;
+    }
+
     /**
      * return option for given short or long keyname, if it got set
      *
@@ -208,7 +233,7 @@ EOT, PHP_EOL;
             self::_help(2);
         }
 
-        $this->_opts = getopt('hd:epsl', array('help', 'delete:', 'empty-dirs', 'purge', 'statistics', 'list-ids', 'delete-all'));
+        $this->_opts = getopt('hd:elps', array('help', 'delete:', 'delete-all', 'delete-v1', 'empty-dirs', 'list-ids', 'purge', 'statistics'));
 
         if (!$this->_opts) {
             self::_error_echo('unsupported arguments given');
@@ -229,6 +254,7 @@ EOT, PHP_EOL;
             'damaged'       => 0,
             'discussion'    => 0,
             'expired'       => 0,
+            'legacy'        => 0,
             'md'            => 0,
             'percent'       => 1,
             'plain'         => 0,
@@ -265,13 +291,12 @@ EOT, PHP_EOL;
             }
 
             if (array_key_exists('adata', $paste)) {
-                $format = $paste['adata'][1];
+                $format = $paste['adata'][Paste::ADATA_FORMATTER];
-                $discussion = $paste['adata'][2];
+                $discussion = $paste['adata'][Paste::ADATA_OPEN_DISCUSSION];
-                $burn = $paste['adata'][3];
+                $burn = $paste['adata'][Paste::ADATA_BURN_AFTER_READING];
             } else {
-                $format = array_key_exists('formatter', $paste['meta']) ? $paste['meta']['formatter'] : 'plaintext';
+                echo "Unsupported v1 paste ", $pasteid, PHP_EOL;
-                $discussion = array_key_exists('opendiscussion', $paste['meta']) ? $paste['meta']['opendiscussion'] : false;
+                ++$counters['legacy'];
-                $burn = array_key_exists('burnafterreading', $paste['meta']) ? $paste['meta']['burnafterreading'] : false;
             }
 
             if ($format === 'plaintext') {
@@ -308,6 +333,9 @@ Plain Text:\t\t{$counters['plain']}
 Source Code:\t\t{$counters['syntax']}
 Markdown:\t\t{$counters['md']}
 EOT, PHP_EOL;
+        if ($counters['legacy'] > 0) {
+            echo "Legacy v1:\t\t{$counters['legacy']}", PHP_EOL;
+        }
         if ($counters['damaged'] > 0) {
             echo "Damaged:\t\t{$counters['damaged']}", PHP_EOL;
         }
@@ -340,14 +368,20 @@ EOT, PHP_EOL;
         $class = 'PrivateBin\\Data\\' . $this->_conf->getKey('class', 'model');
         $this->_store = new $class($this->_conf->getSection('model_options'));
 
-        if ($this->_option('l', 'list-ids') !== null) {
+        if (($pasteId = $this->_option('d', 'delete')) !== null) {
-            $this->_list_ids();
+            $this->_delete($pasteId);
         }
+
         if ($this->_option(null, 'delete-all') !== null) {
             $this->_delete_all();
         }
-        if (($pasteId = $this->_option('d', 'delete')) !== null) {
+
-            $this->_delete($pasteId);
+        if ($this->_option(null, 'delete-v1') !== null) {
+            $this->_delete_v1();
+        }
+
+        if ($this->_option('l', 'list-ids') !== null) {
+            $this->_list_ids();
         }
 
         if ($this->_option('p', 'purge') !== null) {