Add nsds5ReplicaStripAttrs to replica agreements

Generalize the fix_replica_memberof update plugin to allow updating more
replication attributes.

Add nsds5ReplicaStripAttrs to replication agreements on update and
replica install.

https://fedorahosted.org/freeipa/ticket/2534

4 files changed, 125 insertions, 84 deletions

diff --git a/ipaserver/install/plugins/Makefile.am b/ipaserver/install/plugins/Makefile.am
index e3b2e989b..9670273c8 100644
--- a/ipaserver/install/plugins/Makefile.am
+++ b/ipaserver/install/plugins/Makefile.am
@@ -4,7 +4,7 @@ appdir = $(pythondir)/ipaserver/install
 app_PYTHON = 			\
 	__init__.py		\
 	baseupdate.py		\
-	fix_replica_memberof.py	\
+	fix_replica_agreements.py	\
 	rename_managed.py	\
 	dns.py			\
 	updateclient.py		\
diff --git a/ipaserver/install/plugins/fix_replica_agreements.py b/ipaserver/install/plugins/fix_replica_agreements.py
new file mode 100644
index 000000000..2819acc92
--- /dev/null
+++ b/ipaserver/install/plugins/fix_replica_agreements.py
@@ -0,0 +1,115 @@
+# Authors:
+#   Rob Crittenden <rcritten@redhat.com>
+#
+# Copyright (C) 2012  Red Hat
+# see file 'COPYING' for use and warranty information
+#
+# This program 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.
+#
+# This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
+
+import os
+import pwd
+from ipaserver.install.plugins import PRE_UPDATE, MIDDLE
+from ipaserver.install.plugins.baseupdate import PreUpdate
+from ipaserver import ipaldap
+from ipaserver.install import replication
+from ipalib import api
+
+EXCLUDE_TEMPLATE = '(objectclass=*) $ EXCLUDE %s'
+
+
+class update_replica_attribute_lists(PreUpdate):
+    """
+    Run through all replication agreements and ensure that EXCLUDE list
+    has all the required attributes so that we don't cause replication
+    storms.
+    """
+    order=MIDDLE
+
+    def execute(self, **options):
+        # We need an IPAdmin connection to the backend
+        self.log.debug("Start replication agreement exclude list update task")
+        conn = ipaldap.IPAdmin(api.env.host, ldapi=True, realm=api.env.realm)
+        conn.do_external_bind(pwd.getpwuid(os.geteuid()).pw_name)
+
+        repl = replication.ReplicationManager(api.env.realm, api.env.host,
+                                              None, conn=conn)
+        entries = repl.find_replication_agreements()
+        self.log.debug("Found %d agreement(s)", len(entries))
+        for replica in entries:
+            self.log.debug(replica.getValue('description'))
+
+            self._update_attr(repl, replica,
+                'nsDS5ReplicatedAttributeList',
+                replication.EXCLUDES, template=EXCLUDE_TEMPLATE)
+            self._update_attr(repl, replica,
+                'nsDS5ReplicatedAttributeListTotal',
+                replication.TOTAL_EXCLUDES, template=EXCLUDE_TEMPLATE)
+            self._update_attr(repl, replica,
+                'nsds5ReplicaStripAttrs', replication.STRIP_ATTRS)
+
+        self.log.debug("Done updating agreements")
+
+        return (False, False, [])  # No restart, no apply now, no updates
+
+    def _update_attr(self, repl, replica, attribute, values, template='%s'):
+        """Add or update an attribute of a replication agreement
+
+        If the attribute doesn't already exist, it is added and set to
+        `template` with %s substituted by a space-separated `values`.
+        If the attribute does exist, `values` missing from it are just
+        appended to the end, also space-separated.
+
+        :param repl: Replication manager
+        :param replica: Replica agreement
+        :param attribute: Attribute to add or update
+        :param values: List of values the attribute should hold
+        :param template: Template to use when adding attribute
+        """
+        attrlist = replica.getValue(attribute)
+        if attrlist is None:
+            self.log.debug("Adding %s", attribute)
+
+            current = replica.toDict()
+            # Need to add it altogether
+            replica.setValues(attribute, template % " ".join(values))
+
+            try:
+                repl.conn.updateEntry(replica.dn, current, replica.toDict())
+                self.log.debug("Updated")
+            except Exception, e:
+                self.log.error("Error caught updating replica: %s", str(e))
+
+        else:
+            attrlist_normalized = attrlist.lower().split()
+            missing = [a for a in values
+                if a.lower() not in attrlist_normalized]
+
+            if missing:
+                self.log.debug("%s needs updating (missing: %s)", attribute,
+                    ', '.join(missing))
+                current = replica.toDict()
+
+                replica.setValue(attribute,
+                    '%s %s' % (attrlist, ' '.join(missing)))
+
+                try:
+                    repl.conn.updateEntry(replica.dn, current, replica.toDict())
+                    self.log.debug("Updated %s", attribute)
+                except Exception, e:
+                    self.log.error("Error caught updating %s: %s",
+                        attribute, str(e))
+            else:
+                self.log.debug("%s: No update necessary" % attribute)
+
+api.register(update_replica_attribute_lists)
diff --git a/ipaserver/install/plugins/fix_replica_memberof.py b/ipaserver/install/plugins/fix_replica_memberof.py
deleted file mode 100644
index d4ab75348..000000000
--- a/ipaserver/install/plugins/fix_replica_memberof.py
+++ /dev/null
@@ -1,83 +0,0 @@
-# Authors:
-#   Rob Crittenden <rcritten@redhat.com>
-#
-# Copyright (C) 2012  Red Hat
-# see file 'COPYING' for use and warranty information
-#
-# This program 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.
-#
-# This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
-
-import os
-import pwd
-from ipaserver.install.plugins import PRE_UPDATE, MIDDLE
-from ipaserver.install.plugins.baseupdate import PreUpdate
-from ipaserver import ipaldap
-from ipaserver.install import replication
-from ipalib import api
-
-class update_replica_exclude_attribute_list(PreUpdate):
-    """
-    Run through all replication agreements and ensure that EXCLUDE list
-    has all the required attributes so that we don't cause replication
-    storms.
-    """
-    order=MIDDLE
-
-    def execute(self, **options):
-        # We need an IPAdmin connection to the backend
-        self.log.debug("Start replication agreement exclude list update task")
-        conn = ipaldap.IPAdmin(api.env.host, ldapi=True, realm=api.env.realm)
-        conn.do_external_bind(pwd.getpwuid(os.geteuid()).pw_name)
-
-        repl = replication.ReplicationManager(api.env.realm, api.env.host,
-                                              None, conn=conn)
-        entries = repl.find_replication_agreements()
-        self.log.debug("Found %d agreement(s)", len(entries))
-        for replica in entries:
-            self.log.debug(replica.getValue('description'))
-            attrlist = replica.getValue('nsDS5ReplicatedAttributeList')
-            if attrlist is None:
-                self.log.debug("Adding nsDS5ReplicatedAttributeList and nsDS5ReplicatedAttributeListTotal")
-                current = replica.toDict()
-                # Need to add it altogether
-                replica.setValues('nsDS5ReplicatedAttributeList',
-                    '(objectclass=*) $ EXCLUDE %s' % " ".join(replication.EXCLUDES))
-                replica.setValues('nsDS5ReplicatedAttributeListTotal',
-                    '(objectclass=*) $ EXCLUDE %s' % " ".join(replication.TOTAL_EXCLUDES))
-                try:
-                    repl.conn.updateEntry(replica.dn, current, replica.toDict())
-                    self.log.debug("Updated")
-                except Exception, e:
-                    self.log.error("Error caught updating replica: %s", str(e))
-            else:
-                attrlist_normalized = attrlist.lower()
-                missing = [attr for attr in replication.EXCLUDES
-                                if attr not in attrlist_normalized]
-
-                if missing:
-                    self.log.debug("Attribute list needs updating")
-                    current = replica.toDict()
-                    replica.setValue('nsDS5ReplicatedAttributeList',
-                        replica.getValue('nsDS5ReplicatedAttributeList') + ' %s' % ' '.join(missing))
-                    try:
-                        repl.conn.updateEntry(replica.dn, current, replica.toDict())
-                        self.log.debug("Updated")
-                    except Exception, e:
-                        self.log.error("Error caught updating replica: %s", str(e))
-                else:
-                    self.log.debug("No update necessary")
-        self.log.debug("Done updating agreements")
-
-        return (False, False, []) # No restart, no apply now, no updates
-
-api.register(update_replica_exclude_attribute_list)
diff --git a/ipaserver/install/replication.py b/ipaserver/install/replication.py
index d6931db43..8501a8c2c 100644
--- a/ipaserver/install/replication.py
+++ b/ipaserver/install/replication.py
@@ -51,6 +51,13 @@ TOTAL_EXCLUDES = ('entryusn',
 # List of attributes that need to be excluded from normal replication.
 EXCLUDES = ('memberof', 'idnssoaserial') + TOTAL_EXCLUDES
 
+# List of attributes that are not updated on empty replication
+STRIP_ATTRS = ('modifiersName',
+               'modifyTimestamp',
+               'internalModifiersName',
+               'internalModifyTimestamp')
+
+
 def replica_conn_check(master_host, host_name, realm, check_ca,
                        admin_password=None):
     """
@@ -519,6 +526,8 @@ class ReplicationManager(object):
             # that we will have to set the memberof fixup task
             self.need_memberof_fixup = True
 
+        entry.setValues('nsds5ReplicaStripAttrs', " ".join(STRIP_ATTRS))
+
         entry = a_conn.waitForEntry(entry)
 
     def needs_memberof_fixup(self):