about summary refs log tree commit homepage
diff options
context:
space:
mode:
authorEric Wong <e@yhbt.net>2020-06-27 10:03:30 +0000
committerEric Wong <e@yhbt.net>2020-06-28 22:27:09 +0000
commitb6f82589757137f16ac9177676968cdde2b06400 (patch)
tree88e04f964d1f3a3c390da53bef39ac5b07e3ae3b
parent80b6cf9fb3aafe7a2d5e2fee1b420a93c6c9b0ae (diff)
downloadpublic-inbox-b6f82589757137f16ac9177676968cdde2b06400.tar.gz
Respect XDG_DATA_HOME to avoid cluttering ~/.public-inbox/.
Existing users of ~/.public-inbox/imap.sqlite3 will remain
supported, but the preference for new data is to use
~/.local/share and other paths standardized by XDG.

Cc: "Eric W. Biederman" <ebiederm@xmission.com>
-rw-r--r--MANIFEST1
-rw-r--r--lib/PublicInbox/IMAPTracker.pm19
-rw-r--r--t/imap_tracker.t26
3 files changed, 44 insertions, 2 deletions
diff --git a/MANIFEST b/MANIFEST
index 42a00d74..158d7ca2 100644
--- a/MANIFEST
+++ b/MANIFEST
@@ -274,6 +274,7 @@ t/httpd.t
 t/hval.t
 t/imap.t
 t/imap_searchqp.t
+t/imap_tracker.t
 t/imapd-tls.t
 t/imapd.t
 t/import.t
diff --git a/lib/PublicInbox/IMAPTracker.pm b/lib/PublicInbox/IMAPTracker.pm
index c7da422b..bb4a39cc 100644
--- a/lib/PublicInbox/IMAPTracker.pm
+++ b/lib/PublicInbox/IMAPTracker.pm
@@ -52,8 +52,23 @@ VALUES (?, ?, ?)
 }
 
 sub new {
-        my ($class) = @_;
-        my $dbname = PublicInbox::Config->config_dir() . "/imap.sqlite3";
+        my ($class, $dbname) = @_;
+
+        # original name for compatibility with old setups:
+        $dbname //= PublicInbox::Config->config_dir() . "/imap.sqlite3";
+
+        # use the new XDG-compliant name for new setups:
+        if (!-f $dbname) {
+                $dbname = ($ENV{XDG_DATA_HOME} //
+                        (($ENV{HOME} // '/nonexistent').'/.local/share')) .
+                        '/public-inbox/imap.sqlite3';
+        }
+        if (!-f $dbname) {
+                require File::Path;
+                require File::Basename;;
+                File::Path::mkpath(File::Basename::dirname($dbname));
+        }
+
         my $dbh = dbh_new($dbname);
         bless { dbname => $dbname, dbh => $dbh }, $class;
 }
diff --git a/t/imap_tracker.t b/t/imap_tracker.t
new file mode 100644
index 00000000..8dc04ed7
--- /dev/null
+++ b/t/imap_tracker.t
@@ -0,0 +1,26 @@
+# Copyright (C) 2020 all contributors <meta@public-inbox.org>
+# License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
+use Test::More;
+use strict;
+use PublicInbox::TestCommon;
+require_mods 'DBD::SQLite';
+use_ok 'PublicInbox::IMAPTracker';
+my ($tmpdir, $for_destroy) = tmpdir();
+mkdir "$tmpdir/old" or die "mkdir $tmpdir/old: $!";
+my $old = "$tmpdir/old/imap.sqlite3";
+my $cur = "$tmpdir/data/public-inbox/imap.sqlite3";
+{
+        local $ENV{XDG_DATA_HOME} = "$tmpdir/data";
+        local $ENV{PI_DIR} = "$tmpdir/old";
+
+        my $tracker = PublicInbox::IMAPTracker->new;
+        ok(-f $cur, '->new creates file');
+        $tracker = undef;
+        ok(-f $cur, 'file persists after DESTROY');
+        link $cur, $old or die "link $cur => $old: $!";
+        unlink $cur or die "unlink $cur: $!";
+        $tracker = PublicInbox::IMAPTracker->new;
+        ok(!-f $cur, '->new does not create new file if old is present');
+}
+
+done_testing;