mailshears 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e15c8726d061b6406ce5f7213d52fc8b1f9ae3e7
-  data.tar.gz: 7c04d8bd79a8894ce919856dc2abb0f87b7b9870
+  metadata.gz: b1f58755e2a89e2b13f0f3d972e2042357e11569
+  data.tar.gz: c09388cc7659a1e2c06f05ddb1b15bbad31dc278
 SHA512:
-  metadata.gz: b30cbd27cd0004bd2eccab8537c4cf55304713f7ba8fa588a56e6acf4884425f9fd86113b431665f1850bc64cfae0927a26c6ee09fbb24f90888b11957f2de6d
-  data.tar.gz: efcae9b45e44aa41b132dfa6971a211531f43c3774b7d0be9522c3de8c23875e2bb682457bc52f3bb1b7593b46f56cb819e63b4f1025e1b6de325c507be25442
+  metadata.gz: f189f7f051667c13eff013dae9529824f254ac70250dc8d3b0d5d4313d6c3c977ff289c8fa21f8a90565bd429c8b4fcc854047ab44d491f9c0232a347b05584a
+  data.tar.gz: 26586f35b0dbd61af8b76a5c1338aababe302064050ffeb76fd8c7a40d188922f9610a3fd5681972c12ffa0fa3038b3dea3fe8da1d564359c103a33a80751e3c

data/doc/TODO

@@ -11,6 +11,12 @@
 
 * Add OpenDKIM support.
 
-* Make a release.
+* Rename the "dovecot" plugin to "filesystem".
 
 * Implement moving of domains.
+
+* The AgenDAV "user exists" test is wonky, because there's no real
+  users in AgenDAV. Right now we check the "username" column in the
+  "prefs" table, but all of the shares (and principals?) have URLs
+  instead of usernames. We don't parse the URLs, and instead rely
+  on doing find/replace of substrings in e.g. AgendavMv.

data/doc/man1/mailshears.1

@@ -29,15 +29,15 @@ functionality is provided by plugins. The following are supported at
 the moment:
 \#
 .IP \(bu 2
-Agendav (database)
+Agendav (database, v2.1.x)
 .IP \(bu
-DAViCal (datbase)
+DAViCal (database, v1.1.x)
 .IP \(bu
-Dovecot (filesystem)
+Dovecot (filesystem, version irrelevant)
 .IP \(bu
-PostfixAdmin (database)
+PostfixAdmin (database, v2.x)
 .IP \(bu
-Roundcube (database)
+Roundcube (database, v1.2.x)
 
 You are free to pick and choose the plugins that you need. The Dovecot
 plugin is a misnomer: as long as your mail is stored on disk in

data/lib/common/agendav_plugin.rb

@@ -35,9 +35,11 @@ module AgendavPlugin
 
     connection = PG::Connection.new(@db_hash)
 
-    sql_query  = '(SELECT username FROM prefs)'
-    sql_query += 'UNION'
-    sql_query += '(SELECT user_from FROM shared);'
+    # There are also "owner" and "with" fields in the "shares" table,
+    # but they contains principal URLs and not a bare username. Thus
+    # their format depends on the CalDAV server configuration, and
+    # isn't predictable.
+    sql_query  = 'SELECT username FROM prefs;'
 
     begin
       connection.query(sql_query) do |result|
@@ -51,4 +53,27 @@ module AgendavPlugin
     return users.map{ |u| User.new(u) }
   end
 
+
+  # Count the number of rows in the "shares" table. Used only for
+  # testing.
+  #
+  # @return [Fixnum] the number of rows in the "shares" table.
+  #
+  def count_shares()
+    count = nil
+    connection = PG::Connection.new(@db_hash)
+
+    sql_query  = 'SELECT count(*) FROM shares;'
+    begin
+      connection.query(sql_query) do |result|
+        count = result.getvalue(0,0).to_i()
+      end
+    ensure
+      # Make sure the connection gets closed even if the query explodes.
+      connection.close()
+    end
+
+    return count
+  end
+
 end

data/lib/mv/plugins/agendav.rb

@@ -15,27 +15,50 @@ class AgendavMv
   # Move the user *src* to *dst* within the Agendav database. This
   # should "rename" him in _every_ table where he is referenced.
   #
-  # This can fail is *src* does not exist, or if *dst* already exists
-  # before the move. It should also be an error if the destination
-  # domain doesn't exist. But Agendav doesn't know about domains, so
-  # we let that slide.
+  # This can fail if *dst* already exists before the move. It should
+  # also be an error if the destination domain doesn't exist. But
+  # Agendav doesn't know about domains, so we let that slide.
+  #
+  # If the source user doesn't exist, we do our best. AgenDAV has a
+  # "shares" table that isn't keyed on the username, but rather the
+  # principal URL. And its "prefs" table doesn't contain entries for
+  # users who have default preferences. As a result, we may need to
+  # perform some find/replaces in the "shares" table even if no
+  # corresponding user exists in the "prefs" table (which is how we
+  # tell if a user exists in AgenDAV). Thus it's not a fatal error if
+  # the *src* user doesn't exist.
   #
   # @param src [User] the source user to be moved.
   #
   # @param dst [User] the destination user being moved to.
   #
   def mv_user(src, dst)
-    raise NonexistentUserError.new(src.to_s()) if not user_exists(src)
     raise UserAlreadyExistsError.new(dst.to_s()) if user_exists(dst)
 
-    sql_queries = ['UPDATE prefs SET username = $1 WHERE username = $2;']
-    sql_queries << 'UPDATE shared SET user_from = $1 WHERE user_from = $2;'
-    sql_queries << 'UPDATE shared SET user_which = $1 WHERE user_which = $2;'
-
     connection = PG::Connection.new(@db_hash)
     begin
+      # The "prefs" table uses the normal username as a key...
+      # This should be harmless if the source user does not exist.
+      sql_query0 = 'UPDATE prefs SET username = $1 WHERE username = $2;'
+      connection.query(sql_query0, [dst.to_s(), src.to_s()])
+
+      # But the "shares" table uses encoded principal URLs. For the
+      # "shares" table, we need to do a find/replace on the username
+      # with its "@" symbol translated to a "%40".
+      encoded_src = src.to_s()['@'] = '%40'
+      encoded_dst = dst.to_s()['@'] = '%40'
+
+      # Unlike in the "rm" plugin, we do modify the "calendar" field
+      # here. That's because in the usual legitimate use case, the
+      # calendar URL will change when a user moves. This will ALSO
+      # affect people who name their calendars something like
+      # "user%40example.com", but screw those people.
+      sql_queries = ['UPDATE shares SET owner=REPLACE(owner, $2, $1);']
+      sql_queries << 'UPDATE shares SET calendar=REPLACE(calendar, $2, $1);'
+      sql_queries << 'UPDATE shares SET "with"=REPLACE("with", $2, $1);'
+
       sql_queries.each do |sql_query|
-        connection.query(sql_query, [dst.to_s(), src.to_s()])
+        connection.query(sql_query, [encoded_dst, encoded_src])
       end
     ensure
       # Make sure the connection gets closed even if a query explodes.

data/lib/rm/plugins/agendav.rb

@@ -16,13 +16,33 @@ class AgendavRm
   # Remove *user* from the Agendav database. This should remove him
   # from _every_ table in which he is referenced.
   #
+  # We do not raise an error if the user doesn't exist. This is due to
+  # an unfortunate problem with the "user exists" check in AgenDAV.
+  # The AgenDAV "shares" table is not tied directly to a username, so
+  # we are forced to use a regexp match to decide what rows to delete
+  # from that table. We do so regardless of whether or not the username
+  # exists in the "prefs" table, because that table stores only non-
+  # default preferences -- not all users' preferences.
+  #
   # @param user [User] the user to remove.
   #
   def remove_user(user)
-    raise NonexistentUserError.new(user.to_s()) if not user_exists(user)
-
     sql_queries = ['DELETE FROM prefs WHERE username = $1;']
-    sql_queries << 'DELETE FROM shared WHERE user_from = $1;'
+
+    # The "shares" table contains principal URLs, and the "@" symbol
+    # is usually encoded to "%40". These queries do a regex match on
+    # the username after replacing the "%40" with a "@".
+    #
+    # As a precaution, I haven chosen not to delete based on the
+    # "calendar" field here. Nobody should have a calendar named
+    # "user%40example.com", but it's not impossible -- and we don't
+    # want to delete that calendar when the not-necessarily-related
+    # "user@example.com" account is removed. And the usual appearance
+    # of the user's email address in the "calendar" field happens when
+    # he is also the owner, so the calendar does get deleted in the
+    # normal situation.
+    sql_queries << "DELETE FROM shares WHERE REPLACE(owner,'%40','@')    ~ $1;"
+    sql_queries << "DELETE FROM shares WHERE REPLACE(\"with\",'%40','@') ~ $1;"
 
     connection = PG::Connection.new(@db_hash)
     begin

data/mailshears.gemspec

@@ -1,11 +1,11 @@
 Gem::Specification.new do |s|
 
   s.name              = 'mailshears'
-  s.version           = '0.0.2'
+  s.version           = '0.0.3'
   s.platform          = Gem::Platform::RUBY
   s.authors           = ['Michael Orlitzky']
   s.email             = ['michael@orlitzky.com']
-  s.homepage          = 'http://michael.orlitzky.com/code/mailshears.php'
+  s.homepage          = 'http://michael.orlitzky.com/code/mailshears.xhtml'
   s.summary           = 'Prune unused mail directories.'
   s.description       = <<-EOF
     Managing a mail system with virtual users is annoying. The
@@ -24,7 +24,7 @@ Gem::Specification.new do |s|
     as well. Since these two tasks are related, mailshears does them both.
   EOF
 
-  s.license           = 'AGPL-3'
+  s.license           = 'AGPL-3.0'
   s.required_rubygems_version = '>= 1.3.6'
 
   # If you have runtime dependencies, add them here

data/test/mailshears_test.rb

@@ -1,6 +1,14 @@
+# Without this, I get...
+#
+#   Warning: you should require 'minitest/autorun' instead.
+#   Warning: or add 'gem "minitest"' before 'require "minitest/autorun"'
+#
+# Whatever.
+gem 'minitest'
+require 'minitest/autorun'
+
 require 'common/configuration'
 require 'fileutils'
-require 'minitest/autorun'
 require 'pg'
 
 class MailshearsTest < MiniTest::Test
@@ -71,15 +79,15 @@ class MailshearsTest < MiniTest::Test
     #   +------------------  +---------+
     #
     #
-    #   +---------------------------------------------------------+
-    #   |                         shared                          |
-    #   +-----+--------------------+----------+-------------------+
-    #   | sid |     user_from      | calendar |    user_which     |
-    #   +-----+--------------------+----------+-------------------+
-    #   |   1 |  adam@example.net  | derp     | beth@example.net  |
-    #   +-----+--------------------+----------+-------------------+
-    #   |   2 | booger@example.com | derp     | carol@example.net |
-    #   +-----+--------------------+----------+-------------------+
+    #   +---------------------------------------------------------------------------------------------------------------------+
+    #   |                                                       shares                                                        |
+    #   +-----+-----------------------------------+---------------------------------------------------+-----------------------+
+    #   | sid |              owner                |                      calendar                     |          with         |
+    #   +-----+-----------------------------------+---------------------------------------------------+-----------------------+
+    #   |   1 | /caldav.php/adam%40example.net/   | /caldav.php/adam%40example.net/calendar-default   | /beth%40example.net/  |
+    #   +-----+-----------------------------------+---------------------------------------------------+-----------------------+
+    #   |   2 | /caldav.php/booger%40example.com/ | /caldav.php/booger%40example.com/calendar-default | /carol%40example.net/ |
+    #   +-----+-----------------------------------+---------------------------------------------------+-----------------------+
     #
     #
     # 2. davical_test

data/test/sql/agendav-fixtures.sql

@@ -1,9 +1,34 @@
 /* Add an AgenDAV record for one user only. */
 INSERT INTO prefs (username, options) VALUES ('adam@example.net', 'herp');
-INSERT INTO shared (user_from, user_which, calendar)
-  VALUES ('adam@example.net', 'beth@example.net', 'derp');
+INSERT INTO shares (owner, calendar, "with", options, rw)
+  VALUES ('/caldav.php/adam%40example.net/',
+          '/caldav.php/adam%40example.net/calendar-default',
+          '/beth%40example.net/',
+	  'a:0:{}',
+	  false);
 
 /* Just kidding, here's another one! */
 INSERT INTO prefs (username, options) VALUES ('booger@example.com', 'herp');
-INSERT INTO shared (user_from, user_which, calendar)
-  VALUES ('booger@example.com', 'carol@example.net', 'derp');
+INSERT INTO shares (owner, calendar, "with", options, rw)
+  VALUES ('/caldav.php/booger%40example.com/',
+	  '/caldav.php/booger%40example.com/calendar-default',
+          '/carol%40example.net/',
+	  'a:0:{}',
+	  true);
+
+/* These two are missing a prefs entry to test the removal of "shares"
+ * entries in that situation.
+*/
+INSERT INTO shares (owner, calendar, "with", options, rw)
+  VALUES ('/caldav.php/stinky%40example.com/',
+	  '/caldav.php/stinky%40example.com/calendar-default',
+          '/herp%40example.net/',
+	  'a:0:{}',
+	  true);
+
+INSERT INTO shares (owner, calendar, "with", options, rw)
+  VALUES ('/caldav.php/goober%40example.com/',
+	  '/caldav.php/goober%40example.com/calendar-default',
+          '/derp%40example.net/',
+	  'a:0:{}',
+	  true);

data/test/sql/agendav.sql

@@ -3,10 +3,12 @@
 --
 
 SET statement_timeout = 0;
+SET lock_timeout = 0;
 SET client_encoding = 'UTF8';
 SET standard_conforming_strings = on;
 SET check_function_bodies = false;
 SET client_min_messages = warning;
+SET row_security = off;
 
 --
 -- Name: plpgsql; Type: EXTENSION; Schema: -; Owner: 
@@ -29,48 +31,76 @@ SET default_tablespace = '';
 SET default_with_oids = false;
 
 --
--- Name: migrations; Type: TABLE; Schema: public; Owner: postgres; Tablespace: 
+-- Name: prefs; Type: TABLE; Schema: public; Owner: agendav
 --
 
-CREATE TABLE migrations (
-    version integer NOT NULL
+CREATE TABLE prefs (
+    username character varying(255) NOT NULL,
+    options text NOT NULL
 );
 
 
-ALTER TABLE public.migrations OWNER TO postgres;
+ALTER TABLE prefs OWNER to postgres;
 
 --
--- Name: prefs; Type: TABLE; Schema: public; Owner: postgres; Tablespace: 
+-- Name: principals; Type: TABLE; Schema: public; Owner: agendav
 --
 
-CREATE TABLE prefs (
-    username character varying(255) NOT NULL,
-    options text NOT NULL
+CREATE TABLE principals (
+    url character varying(255) NOT NULL,
+    displayname character varying(255) NOT NULL,
+    email character varying(255) NOT NULL
 );
 
 
-ALTER TABLE public.prefs OWNER TO postgres;
+ALTER TABLE principals OWNER to postgres;
 
 --
--- Name: sessions; Type: TABLE; Schema: public; Owner: postgres; Tablespace: 
+-- Name: schema_versions; Type: TABLE; Schema: public; Owner: agendav
+--
+
+CREATE TABLE schema_versions (
+    version character varying(255) NOT NULL
+);
+
+
+ALTER TABLE schema_versions OWNER to postgres;
+
+--
+-- Name: sessions; Type: TABLE; Schema: public; Owner: agendav
 --
 
 CREATE TABLE sessions (
-    session_id character varying(40) DEFAULT 0 NOT NULL,
-    ip_address character varying(16) DEFAULT 0 NOT NULL,
-    user_agent character varying(120) DEFAULT NULL::character varying,
-    last_activity bigint DEFAULT 0 NOT NULL,
-    user_data text NOT NULL
+    sess_id character varying(128) NOT NULL,
+    sess_data bytea NOT NULL,
+    sess_lifetime integer NOT NULL,
+    sess_time integer NOT NULL
+);
+
+
+ALTER TABLE sessions OWNER to postgres;
+
+--
+-- Name: shares; Type: TABLE; Schema: public; Owner: agendav
+--
+
+CREATE TABLE shares (
+    sid integer NOT NULL,
+    owner character varying(255) NOT NULL,
+    calendar character varying(255) NOT NULL,
+    "with" character varying(255) NOT NULL,
+    options text NOT NULL,
+    rw boolean NOT NULL
 );
 
 
-ALTER TABLE public.sessions OWNER TO postgres;
+ALTER TABLE shares OWNER to postgres;
 
 --
--- Name: shared_sid_seq; Type: SEQUENCE; Schema: public; Owner: postgres
+-- Name: shares_sid_seq; Type: SEQUENCE; Schema: public; Owner: agendav
 --
 
-CREATE SEQUENCE shared_sid_seq
+CREATE SEQUENCE shares_sid_seq
     START WITH 1
     INCREMENT BY 1
     NO MINVALUE
@@ -78,26 +108,24 @@ CREATE SEQUENCE shared_sid_seq
     CACHE 1;
 
 
-ALTER TABLE public.shared_sid_seq OWNER TO postgres;
+ALTER TABLE shares_sid_seq OWNER to postgres;
 
 --
--- Name: shared; Type: TABLE; Schema: public; Owner: postgres; Tablespace: 
+-- Name: shares_sid_seq; Type: SEQUENCE OWNED BY; Schema: public; Owner: agendav
 --
 
-CREATE TABLE shared (
-    sid integer DEFAULT nextval('shared_sid_seq'::regclass) NOT NULL,
-    user_from character varying(255) NOT NULL,
-    calendar character varying(255) NOT NULL,
-    user_which character varying(255) NOT NULL,
-    options text DEFAULT ''::text NOT NULL,
-    write_access boolean DEFAULT false NOT NULL
-);
+ALTER SEQUENCE shares_sid_seq OWNED BY shares.sid;
+
 
+--
+-- Name: sid; Type: DEFAULT; Schema: public; Owner: agendav
+--
+
+ALTER TABLE ONLY shares ALTER COLUMN sid SET DEFAULT nextval('shares_sid_seq'::regclass);
 
-ALTER TABLE public.shared OWNER TO postgres;
 
 --
--- Name: prefs_pkey; Type: CONSTRAINT; Schema: public; Owner: postgres; Tablespace: 
+-- Name: prefs_pkey; Type: CONSTRAINT; Schema: public; Owner: agendav
 --
 
 ALTER TABLE ONLY prefs
@@ -105,40 +133,49 @@ ALTER TABLE ONLY prefs
 
 
 --
--- Name: sessions_pkey; Type: CONSTRAINT; Schema: public; Owner: postgres; Tablespace: 
+-- Name: principals_pkey; Type: CONSTRAINT; Schema: public; Owner: agendav
 --
 
-ALTER TABLE ONLY sessions
-    ADD CONSTRAINT sessions_pkey PRIMARY KEY (session_id);
+ALTER TABLE ONLY principals
+    ADD CONSTRAINT principals_pkey PRIMARY KEY (url);
+
+
+--
+-- Name: schema_versions_pkey; Type: CONSTRAINT; Schema: public; Owner: agendav
+--
+
+ALTER TABLE ONLY schema_versions
+    ADD CONSTRAINT schema_versions_pkey PRIMARY KEY (version);
 
 
 --
--- Name: shared_pkey; Type: CONSTRAINT; Schema: public; Owner: postgres; Tablespace: 
+-- Name: sessions_pkey; Type: CONSTRAINT; Schema: public; Owner: agendav
 --
 
-ALTER TABLE ONLY shared
-    ADD CONSTRAINT shared_pkey PRIMARY KEY (sid);
+ALTER TABLE ONLY sessions
+    ADD CONSTRAINT sessions_pkey PRIMARY KEY (sess_id);
 
 
 --
--- Name: last_activity_idx; Type: INDEX; Schema: public; Owner: postgres; Tablespace: 
+-- Name: shares_pkey; Type: CONSTRAINT; Schema: public; Owner: agendav
 --
 
-CREATE INDEX last_activity_idx ON sessions USING btree (last_activity);
+ALTER TABLE ONLY shares
+    ADD CONSTRAINT shares_pkey PRIMARY KEY (sid);
 
 
 --
--- Name: sharedwithidx; Type: INDEX; Schema: public; Owner: postgres; Tablespace: 
+-- Name: idx_905f717c9890e20e; Type: INDEX; Schema: public; Owner: agendav
 --
 
-CREATE INDEX sharedwithidx ON shared USING btree (user_which);
+CREATE INDEX idx_905f717c9890e20e ON shares USING btree ("with");
 
 
 --
--- Name: shareidx; Type: INDEX; Schema: public; Owner: postgres; Tablespace: 
+-- Name: idx_905f717ccf60e67c6ea9a146; Type: INDEX; Schema: public; Owner: agendav
 --
 
-CREATE INDEX shareidx ON shared USING btree (user_from, calendar);
+CREATE INDEX idx_905f717ccf60e67c6ea9a146 ON shares USING btree (owner, calendar);
 
 
 --

data/test/test_mv.rb

@@ -27,7 +27,8 @@ class TestMv < MailshearsTest
     actual = output_buffer.string()
 
     expected =
-      "AgendavMv - Source user alice@example.com not found.\n" +
+      "AgendavMv - Moved user alice@example.com (User not found) " +
+        "to alice@example.net (User not found).\n" +
       "DavicalMv - Moved user alice@example.com (Principal ID: 1) " +
         "to alice@example.net (Principal ID: 1).\n" +
       "DovecotMv - Moved user alice@example.com " +

data/test/test_rm.rb

@@ -42,6 +42,13 @@ class TestRm < MailshearsTest
     expected = [User.new('booger@example.com')]
     assert_equal(expected, actual)
 
+    # Only try to remove this guy from the agendav database, to ensure
+    # that "nonexistent" users have their shares removed.
+    arm.remove_user('stinky@example.com')
+    expected = 2
+    actual = arm.count_shares()
+    assert_equal(expected, actual)
+
     drm = DavicalRm.new(cfg)
     actual = drm.list_users()
     expected = [User.new('alice@example.com'), User.new('booger@example.com')]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailshears
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Michael Orlitzky
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-09 00:00:00.000000000 Z
+date: 2017-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -106,9 +106,9 @@ files:
 - test/test_mv.rb
 - test/test_prune.rb
 - test/test_rm.rb
-homepage: http://michael.orlitzky.com/code/mailshears.php
+homepage: http://michael.orlitzky.com/code/mailshears.xhtml
 licenses:
-- AGPL-3
+- AGPL-3.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -126,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Prune unused mail directories.