Database

--------
 * The `ban` table now uses list-ids to cross-reference the mailing list,
   since these cannot change even if the mailing list is moved or renamed.

Interfaces
----------
 * The `IBanManager` is no longer a global utility.  Instead, you adapt an
   `IMailingList` to an `IBanManager` to manage the bans for a specific
   mailing list.  To manage the global bans, adapt ``None``.

4 files changed, 112 insertions, 2 deletions

diff --git a/src/mailman/database/schema/mm_20120407000000.py b/src/mailman/database/schema/mm_20120407000000.py
index d6e647c1a..3910e9438 100644
--- a/src/mailman/database/schema/mm_20120407000000.py
+++ b/src/mailman/database/schema/mm_20120407000000.py
@@ -149,7 +149,7 @@ def upgrade_sqlite(database, store, version, module_path):
 def upgrade_postgres(database, store, version, module_path):
     # Get the old values from the mailinglist table.
     results = store.execute("""
-        SELECT id, archive, archive_private, list_name, mail_host 
+        SELECT id, archive, archive_private, list_name, mail_host
         FROM mailinglist;
         """)
     # Do the simple renames first.
diff --git a/src/mailman/database/schema/mm_20121015000000.py b/src/mailman/database/schema/mm_20121015000000.py
new file mode 100644
index 000000000..51e0602e7
--- /dev/null
+++ b/src/mailman/database/schema/mm_20121015000000.py
@@ -0,0 +1,88 @@
+# Copyright (C) 2012 by the Free Software Foundation, Inc.
+#
+# This file is part of GNU Mailman.
+#
+# GNU Mailman is free software: you can redistribute it and/or modify it under
+# the terms of the GNU General Public License as published by the Free
+# Software Foundation, either version 3 of the License, or (at your option)
+# any later version.
+#
+# GNU Mailman is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+# more details.
+#
+# You should have received a copy of the GNU General Public License along with
+# GNU Mailman.  If not, see <http://www.gnu.org/licenses/>.
+
+"""3.0b2 -> 3.0b3 schema migrations.
+
+* bans.mailing_list -> bans.list_id
+"""
+
+from __future__ import absolute_import, print_function, unicode_literals
+
+__metaclass__ = type
+__all__ = [
+    'upgrade',
+    ]
+
+
+VERSION = '20121015000000'
+
+
+
+def upgrade(database, store, version, module_path):
+    if database.TAG == 'sqlite':
+        upgrade_sqlite(database, store, version, module_path)
+    else:
+        upgrade_postgres(database, store, version, module_path)
+
+
+
+def _make_listid(fqdn_listname):
+    list_name, at, mail_host = fqdn_listname.partition('@')
+    if at == '':
+        # If there is no @ sign in the value, assume it already contains the
+        # list-id.
+        return fqdn_listname
+    return '{0}.{1}'.format(list_name, mail_host)
+
+
+
+def upgrade_sqlite(database, store, version, module_path):
+    database.load_schema(
+        store, version, 'sqlite_{0}_01.sql'.format(version), module_path)
+    results = store.execute("""
+        SELECT id, mailing_list
+        FROM ban;
+        """)
+    for id, mailing_list in results:
+        # Skip global bans since there's nothing to update.
+        if mailing_list is None:
+            continue
+        store.execute("""
+            UPDATE ban_backup SET list_id = '{0}'
+            WHERE id = {1};
+            """.format(_make_listid(mailing_list), id))
+    # Pivot the backup table to the real thing.
+    store.execute('DROP TABLE ban;')
+    store.execute('ALTER TABLE ban_backup RENAME TO ban;')
+
+
+
+def upgrade_postgres(database, store, version, module_path):
+    # Get the old values from the ban table.
+    results = store.execute('SELECT id, mailing_list FROM ban;')
+    store.execute('ALTER TABLE ban ADD COLUMN list_id TEXT;')
+    for id, mailing_list in results:
+        # Skip global bans since there's nothing to update.
+        if mailing_list is None:
+            continue
+        store.execute("""
+            UPDATE ban SET list_id = '{0}'
+            WHERE id = {1};
+            """.format(_make_listid(mailing_list), id))
+    store.execute('ALTER TABLE ban DROP COLUMN mailing_list;')
+    # Record the migration in the version table.
+    database.load_schema(store, version, None, module_path)
diff --git a/src/mailman/database/schema/sqlite_20120407000000_01.sql b/src/mailman/database/schema/sqlite_20120407000000_01.sql
index b93e214c4..53bab70dd 100644
--- a/src/mailman/database/schema/sqlite_20120407000000_01.sql
+++ b/src/mailman/database/schema/sqlite_20120407000000_01.sql
@@ -269,7 +269,7 @@ INSERT INTO mem_backup SELECT
     preferences_id,
     user_id
     FROM member;
-    
+
 
 -- Add the new columns.  They'll get inserted at the Python layer.
 ALTER TABLE ml_backup ADD COLUMN archive_policy INTEGER;
diff --git a/src/mailman/database/schema/sqlite_20121015000000_01.sql b/src/mailman/database/schema/sqlite_20121015000000_01.sql
new file mode 100644
index 000000000..c0df75111
--- /dev/null
+++ b/src/mailman/database/schema/sqlite_20121015000000_01.sql
@@ -0,0 +1,22 @@
+-- THIS FILE CONTAINS THE SQLITE3 SCHEMA MIGRATION FROM
+-- 3.0b2 TO 3.0b3
+--
+-- AFTER 3.0b3 IS RELEASED YOU MAY NOT EDIT THIS FILE.
+
+-- REMOVALS from the ban table.
+-- REM mailing_list
+
+-- ADDS to the ban table.
+-- ADD list_id
+
+CREATE TABLE ban_backup (
+    id INTEGER NOT NULL,
+    email TEXT,
+    PRIMARY KEY (id)
+    );
+
+INSERT INTO ban_backup SELECT
+    id, email
+    FROM ban;
+
+ALTER TABLE ban_backup ADD COLUMN list_id TEXT;