From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on dcvr.yhbt.net X-Spam-Level: X-Spam-Status: No, score=-4.0 required=3.0 tests=ALL_TRUSTED,BAYES_00 shortcircuit=no autolearn=ham autolearn_force=no version=3.4.2 Received: from localhost (dcvr.yhbt.net [127.0.0.1]) by dcvr.yhbt.net (Postfix) with ESMTP id F188C1F8DB; Sat, 27 Jun 2020 10:04:00 +0000 (UTC) From: Eric Wong To: meta@public-inbox.org Cc: "Eric W. Biederman" Subject: [PATCH 04/34] imaptracker: use ~/.local/share/public-inbox/imap.sqlite3 Date: Sat, 27 Jun 2020 10:03:30 +0000 Message-Id: <20200627100400.9871-5-e@yhbt.net> In-Reply-To: <20200627100400.9871-1-e@yhbt.net> References: <20200627100400.9871-1-e@yhbt.net> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit List-Id: 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" --- MANIFEST | 1 + lib/PublicInbox/IMAPTracker.pm | 19 +++++++++++++++++-- t/imap_tracker.t | 26 ++++++++++++++++++++++++++ 3 files changed, 44 insertions(+), 2 deletions(-) create mode 100644 t/imap_tracker.t diff --git a/MANIFEST b/MANIFEST index 42a00d74344..158d7ca2d8e 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 c7da422b725..bb4a39cc41a 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 00000000000..8dc04ed77a3 --- /dev/null +++ b/t/imap_tracker.t @@ -0,0 +1,26 @@ +# Copyright (C) 2020 all contributors +# License: AGPL-3.0+ +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;