From e01ceaa07f4c28bc01958fb136caa492e7468bc5 Mon Sep 17 00:00:00 2001
From: epriestley <git@epriestley.com>
Date: Mon, 20 May 2013 10:16:35 -0700
Subject: [PATCH] Provide 'bin/cache', for managing caches

Summary:
See <https://github.com/facebook/phabricator/issues/323>. We have a very old cache management script which doesn't purge all the modern caches (and does purge some caches which are no longer in use). Update it so it purges all the modern caches (remarkup, general, changeset), no longer purges outdated caches, and is easier to use.

Also delete a lot of "this script has moved" scripts from the last few rounds of similar cleanup, I believe all of these have been in master for at least several months, which should be enough time for users to get used to the new stuff.

Test Plan: Ran `bin/cache` with various arguments. Verified caches were purged.

Reviewers: btrahan

Reviewed By: btrahan

CC: aran

Differential Revision: https://secure.phabricator.com/D5978
---
 bin/cache                                     |   1 +
 scripts/cache/manage_cache.php                |  22 +++
 scripts/repository/discover.php               |   8 --
 scripts/repository/parse_one_commit.php       |   7 -
 scripts/repository/pull.php                   |   8 --
 .../reparse_all_commit_messages.php           |   8 --
 scripts/search/index_one_commit.php           |   5 -
 scripts/search/reindex_all_users.php          |   5 -
 scripts/search/reindex_everything.php         |   5 -
 scripts/sql/upgrade_schema.php                |  10 --
 scripts/util/purge_cache.php                  | 126 +-----------------
 src/__phutil_library_map__.php                |   4 +
 ...habricatorCacheManagementPurgeWorkflow.php |  99 ++++++++++++++
 .../PhabricatorCacheManagementWorkflow.php    |  10 ++
 14 files changed, 138 insertions(+), 180 deletions(-)
 create mode 120000 bin/cache
 create mode 100755 scripts/cache/manage_cache.php
 delete mode 100755 scripts/repository/discover.php
 delete mode 100755 scripts/repository/parse_one_commit.php
 delete mode 100755 scripts/repository/pull.php
 delete mode 100755 scripts/repository/reparse_all_commit_messages.php
 delete mode 100755 scripts/search/index_one_commit.php
 delete mode 100755 scripts/search/reindex_all_users.php
 delete mode 100755 scripts/search/reindex_everything.php
 delete mode 100755 scripts/sql/upgrade_schema.php
 create mode 100644 src/applications/cache/management/PhabricatorCacheManagementPurgeWorkflow.php
 create mode 100644 src/applications/cache/management/PhabricatorCacheManagementWorkflow.php

diff --git a/bin/cache b/bin/cache
new file mode 120000
index 0000000000..f3b182e818
--- /dev/null
+++ b/bin/cache
@@ -0,0 +1 @@
+../scripts/cache/manage_cache.php
\ No newline at end of file
diff --git a/scripts/cache/manage_cache.php b/scripts/cache/manage_cache.php
new file mode 100755
index 0000000000..20c4bc1d84
--- /dev/null
+++ b/scripts/cache/manage_cache.php
@@ -0,0 +1,22 @@
+#!/usr/bin/env php
+<?php
+
+$root = dirname(dirname(dirname(__FILE__)));
+require_once $root.'/scripts/__init_script__.php';
+
+$args = new PhutilArgumentParser($argv);
+$args->setTagline('manage mail');
+$args->setSynopsis(<<<EOSYNOPSIS
+**cache** __command__ [__options__]
+    Manage Phabricator caches.
+
+EOSYNOPSIS
+  );
+$args->parseStandardArguments();
+
+$workflows = array(
+  new PhabricatorCacheManagementPurgeWorkflow(),
+  new PhutilHelpArgumentWorkflow(),
+);
+
+$args->parseWorkflows($workflows);
diff --git a/scripts/repository/discover.php b/scripts/repository/discover.php
deleted file mode 100755
index e5f2df166b..0000000000
--- a/scripts/repository/discover.php
+++ /dev/null
@@ -1,8 +0,0 @@
-#!/usr/bin/env php
-<?php
-
-echo
-  "This script has moved. All repository management is now performed through ".
-  "'bin/repository'. Use this command instead:\n\n".
-  "    phabricator/ $ ./bin/repository discover ...\n";
-exit(1);
diff --git a/scripts/repository/parse_one_commit.php b/scripts/repository/parse_one_commit.php
deleted file mode 100755
index 6b6d5f81b4..0000000000
--- a/scripts/repository/parse_one_commit.php
+++ /dev/null
@@ -1,7 +0,0 @@
-#!/usr/bin/env php
-<?php
-
-echo "This script is obsolete. Instead, use:\n\n".
-     "  $ reparse.php <commit_name> --message --change\n\n".
-     "See that script for more options.\n";
-exit(1);
diff --git a/scripts/repository/pull.php b/scripts/repository/pull.php
deleted file mode 100755
index 5f716e77d4..0000000000
--- a/scripts/repository/pull.php
+++ /dev/null
@@ -1,8 +0,0 @@
-#!/usr/bin/env php
-<?php
-
-echo
-  "This script has moved. All repository management is now performed through ".
-  "'bin/repository'. Use this command instead:\n\n".
-  "    phabricator/ $ ./bin/repository pull ...\n";
-exit(1);
diff --git a/scripts/repository/reparse_all_commit_messages.php b/scripts/repository/reparse_all_commit_messages.php
deleted file mode 100755
index 293aa6ff37..0000000000
--- a/scripts/repository/reparse_all_commit_messages.php
+++ /dev/null
@@ -1,8 +0,0 @@
-#!/usr/bin/env php
-<?php
-
-echo "This script is obsolete. Instead, use:\n\n".
-     "  $ reparse.php --all <repository_name> --message\n\n".
-     "See that script for more options.\n";
-exit(1);
-
diff --git a/scripts/search/index_one_commit.php b/scripts/search/index_one_commit.php
deleted file mode 100755
index 7803caccef..0000000000
--- a/scripts/search/index_one_commit.php
+++ /dev/null
@@ -1,5 +0,0 @@
-#!/usr/bin/env php
-<?php
-
-echo "Use 'bin/search index rXnnnnnn' instead of this script.\n";
-exit(1);
diff --git a/scripts/search/reindex_all_users.php b/scripts/search/reindex_all_users.php
deleted file mode 100755
index 68aee018d3..0000000000
--- a/scripts/search/reindex_all_users.php
+++ /dev/null
@@ -1,5 +0,0 @@
-#!/usr/bin/env php
-<?php
-
-echo "Use 'bin/search index --type USER' instead of this script.\n";
-die(1);
diff --git a/scripts/search/reindex_everything.php b/scripts/search/reindex_everything.php
deleted file mode 100755
index bbf02b43c7..0000000000
--- a/scripts/search/reindex_everything.php
+++ /dev/null
@@ -1,5 +0,0 @@
-#!/usr/bin/env php
-<?php
-
-echo "Use 'bin/search index --all' instead of this script.\n";
-die(1);
diff --git a/scripts/sql/upgrade_schema.php b/scripts/sql/upgrade_schema.php
deleted file mode 100755
index dc2d6b562b..0000000000
--- a/scripts/sql/upgrade_schema.php
+++ /dev/null
@@ -1,10 +0,0 @@
-#!/usr/bin/env php
-<?php
-
-echo "This script has been replaced by 'phabricator/bin/storage'.\n\n".
-     "Run:\n\n".
-     "  phabricator/bin $ ./storage help\n\n".
-     "...for help, or:\n\n".
-     "  phabricator/bin $ ./storage upgrade\n\n".
-     "...to upgrade storage.\n\n";
-exit(1);
diff --git a/scripts/util/purge_cache.php b/scripts/util/purge_cache.php
index 8effd9d2ae..54a0bb29aa 100755
--- a/scripts/util/purge_cache.php
+++ b/scripts/util/purge_cache.php
@@ -1,127 +1,5 @@
 #!/usr/bin/env php
 <?php
 
-$root = dirname(dirname(dirname(__FILE__)));
-require_once $root.'/scripts/__init_script__.php';
-
-$purge_changesets   = false;
-$purge_differential = false;
-
-$args = array_slice($argv, 1);
-if (!$args) {
-  usage("Specify which caches you want to purge.");
-}
-
-$changesets = array();
-$len = count($args);
-for ($ii = 0; $ii < $len; $ii++) {
-  switch ($args[$ii]) {
-    case '--all':
-      $purge_changesets = true;
-      $purge_differential = true;
-      break;
-    case '--changesets':
-      $purge_changesets = true;
-      while (isset($args[$ii + 1]) && (substr($args[$ii + 1], 0, 2) !== '--')) {
-        $changeset = $args[++$ii];
-        if (!is_numeric($changeset)) {
-          return usage("Changeset argument '{$changeset}' ".
-                       "is not a positive integer.");
-        }
-        $changesets[] = intval($changeset);
-      }
-      break;
-    case '--differential':
-      $purge_differential = true;
-      break;
-    case '--help':
-      return help();
-    default:
-      return usage("Unrecognized argument '{$args[$ii]}'.");
-  }
-}
-
-if ($purge_changesets) {
-  $table = new DifferentialChangeset();
-  if ($changesets) {
-    echo "Purging changeset cache for changesets ".
-         implode($changesets, ",")."\n";
-    queryfx(
-      $table->establishConnection('w'),
-      'DELETE FROM %T WHERE id IN (%Ld)',
-      DifferentialChangeset::TABLE_CACHE,
-      $changesets);
-  } else {
-    echo "Purging changeset cache...\n";
-    queryfx(
-      $table->establishConnection('w'),
-      'TRUNCATE TABLE %T',
-      DifferentialChangeset::TABLE_CACHE);
-  }
-  echo "Done.\n";
-}
-
-if ($purge_differential) {
-  echo "Purging Differential comment cache...\n";
-  $table = new DifferentialComment();
-  queryfx(
-    $table->establishConnection('w'),
-    'UPDATE %T SET cache = NULL',
-    $table->getTableName());
-  echo "Purging Differential inline comment cache...\n";
-  $table = new DifferentialInlineComment();
-  queryfx(
-    $table->establishConnection('w'),
-    'UPDATE %T SET cache = NULL',
-    $table->getTableName());
-  echo "Done.\n";
-}
-
-echo "Ok, caches purged.\n";
-
-function usage($message) {
-  echo "Usage Error: {$message}";
-  echo "\n\n";
-  echo "Run 'purge_cache.php --help' for detailed help.\n";
-  exit(1);
-}
-
-function help() {
-  $help = <<<EOHELP
-**SUMMARY**
-
-    **purge_cache.php**
-        [--differential]
-        [--changesets [changeset_id ...]]
-    **purge_cache.php** --all
-    **purge_cache.php** --help
-
-    Purge various long-lived caches. Normally, Phabricator caches some data for
-    a long time or indefinitely, but certain configuration changes might
-    invalidate these caches. You can use this script to manually purge them.
-
-    For instance, if you change display widths in Differential or configure
-    syntax highlighting, you may want to purge the changeset cache (with
-    "--changesets") so your changes are reflected in older diffs.
-
-    If you change Remarkup rules, you may want to purge the Differential
-    comment caches ("--differential") so older comments pick up the new rules.
-
-    __--all__
-        Purge all long-lived caches.
-
-    __--changesets [changeset_id ...]__
-        Purge Differential changeset render cache. If changeset_ids are present,
-        the script will delete the cache for those changesets; otherwise it will
-        delete the cache for all the changesets.
-
-    __--differential__
-        Purge Differential comment formatting cache.
-
-    __--help__: show this help
-
-
-EOHELP;
-  echo phutil_console_format($help);
-  exit(1);
-}
+echo "This script is obsolete. Use 'bin/cache' instead.\n";
+exit(1);
diff --git a/src/__phutil_library_map__.php b/src/__phutil_library_map__.php
index 0a5ea21592..9f85c8f465 100644
--- a/src/__phutil_library_map__.php
+++ b/src/__phutil_library_map__.php
@@ -807,6 +807,8 @@ phutil_register_library_map(array(
     'PhabricatorBuiltinPatchList' => 'infrastructure/storage/patch/PhabricatorBuiltinPatchList.php',
     'PhabricatorButtonsExample' => 'applications/uiexample/examples/PhabricatorButtonsExample.php',
     'PhabricatorCacheDAO' => 'applications/cache/storage/PhabricatorCacheDAO.php',
+    'PhabricatorCacheManagementPurgeWorkflow' => 'applications/cache/management/PhabricatorCacheManagementPurgeWorkflow.php',
+    'PhabricatorCacheManagementWorkflow' => 'applications/cache/management/PhabricatorCacheManagementWorkflow.php',
     'PhabricatorCaches' => 'applications/cache/PhabricatorCaches.php',
     'PhabricatorCalendarBrowseController' => 'applications/calendar/controller/PhabricatorCalendarBrowseController.php',
     'PhabricatorCalendarController' => 'applications/calendar/controller/PhabricatorCalendarController.php',
@@ -2575,6 +2577,8 @@ phutil_register_library_map(array(
     'PhabricatorBuiltinPatchList' => 'PhabricatorSQLPatchList',
     'PhabricatorButtonsExample' => 'PhabricatorUIExample',
     'PhabricatorCacheDAO' => 'PhabricatorLiskDAO',
+    'PhabricatorCacheManagementPurgeWorkflow' => 'PhabricatorSearchManagementWorkflow',
+    'PhabricatorCacheManagementWorkflow' => 'PhutilArgumentWorkflow',
     'PhabricatorCalendarBrowseController' => 'PhabricatorCalendarController',
     'PhabricatorCalendarController' => 'PhabricatorController',
     'PhabricatorCalendarDAO' => 'PhabricatorLiskDAO',
diff --git a/src/applications/cache/management/PhabricatorCacheManagementPurgeWorkflow.php b/src/applications/cache/management/PhabricatorCacheManagementPurgeWorkflow.php
new file mode 100644
index 0000000000..cfa29c0b5e
--- /dev/null
+++ b/src/applications/cache/management/PhabricatorCacheManagementPurgeWorkflow.php
@@ -0,0 +1,99 @@
+<?php
+
+final class PhabricatorCacheManagementPurgeWorkflow
+  extends PhabricatorSearchManagementWorkflow {
+
+  protected function didConstruct() {
+    $this
+      ->setName('purge')
+      ->setSynopsis('Drop data from caches.')
+      ->setArguments(
+        array(
+          array(
+            'name'    => 'purge-all',
+            'help'    => 'Purge all caches.',
+          ),
+          array(
+            'name'    => 'purge-remarkup',
+            'help'    => 'Purge the remarkup cache.',
+          ),
+          array(
+            'name'    => 'purge-changeset',
+            'help'    => 'Purge the Differential changeset cache.',
+          ),
+          array(
+            'name'    => 'purge-general',
+            'help'    => 'Purge the general cache.',
+          ),
+        ));
+  }
+
+  public function execute(PhutilArgumentParser $args) {
+    $console = PhutilConsole::getConsole();
+
+    $purge_all = $args->getArg('purge-all');
+
+    $purge = array(
+      'remarkup'  => $purge_all || $args->getArg('purge-remarkup'),
+      'changeset' => $purge_all || $args->getArg('purge-changeset'),
+      'general'   => $purge_all || $args->getArg('purge-general'),
+    );
+
+    if (!array_filter($purge)) {
+      $list = array();
+      foreach ($purge as $key => $ignored) {
+        $list[] = "'--purge-".$key."'";
+      }
+
+      throw new PhutilArgumentUsageException(
+        "Specify which cache or caches to purge, or use '--purge-all'. ".
+        "Available caches are: ".implode(', ', $list).". Use '--help' ".
+        "for more information.");
+    }
+
+    if ($purge['remarkup']) {
+      $console->writeOut("Purging remarkup cache...");
+      $this->purgeRemarkupCache();
+      $console->writeOut("done.\n");
+    }
+
+    if ($purge['changeset']) {
+      $console->writeOut("Purging changeset cache...");
+      $this->purgeChangesetCache();
+      $console->writeOut("done.\n");
+    }
+
+    if ($purge['general']) {
+      $console->writeOut("Purging general cache...");
+      $this->purgeGeneralCache();
+      $console->writeOut("done.\n");
+    }
+  }
+
+  private function purgeRemarkupCache() {
+    $conn_w = id(new PhabricatorMarkupCache())->establishConnection('w');
+
+    queryfx(
+      $conn_w,
+      'TRUNCATE TABLE %T',
+      id(new PhabricatorMarkupCache())->getTableName());
+  }
+
+  private function purgeChangesetCache() {
+    $conn_w = id(new DifferentialChangeset())->establishConnection('w');
+    queryfx(
+      $conn_w,
+      'TRUNCATE TABLE %T',
+      DifferentialChangeset::TABLE_CACHE);
+  }
+
+  private function purgeGeneralCache() {
+    $conn_w = id(new PhabricatorMarkupCache())->establishConnection('w');
+
+    queryfx(
+      $conn_w,
+      'TRUNCATE TABLE %T',
+      'cache_general');
+  }
+
+}
diff --git a/src/applications/cache/management/PhabricatorCacheManagementWorkflow.php b/src/applications/cache/management/PhabricatorCacheManagementWorkflow.php
new file mode 100644
index 0000000000..661a1ee359
--- /dev/null
+++ b/src/applications/cache/management/PhabricatorCacheManagementWorkflow.php
@@ -0,0 +1,10 @@
+<?php
+
+abstract class PhabricatorCacheManagementWorkflow
+  extends PhutilArgumentWorkflow {
+
+  final public function isExecutable() {
+    return true;
+  }
+
+}