From caece0123e9b0c13228a88513d9843557fb593b8 Mon Sep 17 00:00:00 2001
From: ansuz <ansuz@transitiontech.ca>
Date: Fri, 25 Jun 2021 20:22:16 +0530
Subject: [PATCH] archive pin logs instead of removing them outright

---
 lib/commands/pin-rpc.js      | 4 ++--
 lib/historyKeeper.js         | 2 ++
 lib/storage/file.js          | 9 ++++++---
 lib/workers/db-worker.js     | 3 +++
 scripts/evict-archived.js    | 2 ++
 scripts/evict-inactive.js    | 2 ++
 scripts/lint-translations.js | 8 ++++++++
 7 files changed, 25 insertions(+), 5 deletions(-)
 create mode 100644 scripts/lint-translations.js

diff --git a/lib/commands/pin-rpc.js b/lib/commands/pin-rpc.js
index 93d922620..ff6bfdbac 100644
--- a/lib/commands/pin-rpc.js
+++ b/lib/commands/pin-rpc.js
@@ -115,8 +115,8 @@ Pinning.getTotalSize = function (Env, safeKey, cb) {
 */
 Pinning.removePins = function (Env, safeKey, cb) {
     // FIXME respect the queue
-    Env.pinStore.removeChannel(safeKey, function (err) {
-        Env.Log.info('DELETION_PIN_BY_OWNER_RPC', {
+    Env.pinStore.archiveChannel(safeKey, function (err) {
+        Env.Log.info('ARCHIVAL_PIN_BY_OWNER_RPC', {
             safeKey: safeKey,
             status: err? String(err): 'SUCCESS',
         });
diff --git a/lib/historyKeeper.js b/lib/historyKeeper.js
index daa041b5f..44afe0ae0 100644
--- a/lib/historyKeeper.js
+++ b/lib/historyKeeper.js
@@ -123,6 +123,8 @@ module.exports.create = function (Env, cb) {
         Store.create({
             filePath: pinPath,
             archivePath: Env.paths.archive,
+            // indicate that archives should be put in a 'pins' archvie folder
+            volumeId: 'pins',
         }, w(function (err, s) {
             if (err) { throw err; }
             Env.pinStore = s;
diff --git a/lib/storage/file.js b/lib/storage/file.js
index 825f14066..30e6c7644 100644
--- a/lib/storage/file.js
+++ b/lib/storage/file.js
@@ -51,7 +51,7 @@ var mkPath = function (env, channelId) {
 };
 
 var mkArchivePath = function (env, channelId) {
-    return Path.join(env.archiveRoot, 'datastore', channelId.slice(0, 2), channelId) + '.ndjson';
+    return Path.join(env.archiveRoot, env.volumeId, channelId.slice(0, 2), channelId) + '.ndjson';
 };
 
 var mkMetadataPath = function (env, channelId) {
@@ -59,7 +59,7 @@ var mkMetadataPath = function (env, channelId) {
 };
 
 var mkArchiveMetadataPath = function (env, channelId) {
-    return Path.join(env.archiveRoot, 'datastore', channelId.slice(0, 2), channelId) + '.metadata.ndjson';
+    return Path.join(env.archiveRoot, env.volumeId, channelId.slice(0, 2), channelId) + '.metadata.ndjson';
 };
 
 var mkTempPath = function (env, channelId) {
@@ -1044,6 +1044,9 @@ module.exports.create = function (conf, _cb) {
     var env = {
         root: conf.filePath || './datastore',
         archiveRoot: conf.archivePath || './data/archive',
+        // supply a volumeId if you want a store to archive channels to and from
+        // to its own subpath within the archive directory
+        volumeId: conf.volumeId || 'datastore',
         channels: { },
         batchGetChannel: BatchRead('store_batch_channel'),
     };
@@ -1076,7 +1079,7 @@ module.exports.create = function (conf, _cb) {
             }
         }));
         // make sure the cold storage directory exists
-        Fse.mkdirp(env.archiveRoot, PERMISSIVE, w(function (err) {
+        Fse.mkdirp(Path.join(env.archiveRoot, env.volumeId), PERMISSIVE, w(function (err) {
             if (err && err.code !== 'EEXIST') {
                 w.abort();
                 return void cb(err);
diff --git a/lib/workers/db-worker.js b/lib/workers/db-worker.js
index 8585cc3f6..137b756b4 100644
--- a/lib/workers/db-worker.js
+++ b/lib/workers/db-worker.js
@@ -66,6 +66,9 @@ const init = function (config, _cb) {
         Store.create({
             filePath: config.pinPath,
             archivePath: config.archivePath,
+            // important to initialize the pinstore with its own volume id
+            // otherwise archived pin logs will get mixed in with channels
+            volumeId: 'pins',
         }, w(function (err, _pinStore) {
             if (err) {
                 w.abort();
diff --git a/scripts/evict-archived.js b/scripts/evict-archived.js
index 7f90f9ff5..255246e99 100644
--- a/scripts/evict-archived.js
+++ b/scripts/evict-archived.js
@@ -56,6 +56,8 @@ var prepareEnv = function (Env, cb) {
 
         Store.create({
             filePath: config.pinPath,
+            // archive pin logs to their own subpath
+            volumeId: 'pins',
         }, w(function (err, _) {
             if (err) {
                 w.abort();
diff --git a/scripts/evict-inactive.js b/scripts/evict-inactive.js
index bf7e1ca5b..2521e014f 100644
--- a/scripts/evict-inactive.js
+++ b/scripts/evict-inactive.js
@@ -56,6 +56,8 @@ var prepareEnv = function (Env, cb) {
 
         Store.create({
             filePath: config.pinPath,
+            // archive pin logs to their own subpath
+            volumeId: 'pins',
         }, w(function (err, _) {
             if (err) {
                 w.abort();
diff --git a/scripts/lint-translations.js b/scripts/lint-translations.js
new file mode 100644
index 000000000..a38cd615a
--- /dev/null
+++ b/scripts/lint-translations.js
@@ -0,0 +1,8 @@
+// TODO unify the following scripts
+    // unused-translations.js
+    // find-html-translations
+
+// more linting
+    // Search for 'Cryptpad' string (should be 'CryptPad')
+    // Search English for -ise\s
+