Allow each action to control its own db transaction.

In future this will allow objects created by the action to be, optionally, edited by the user before committing to the db.

Author: stevenyoungs

Form/UK1841.py

@@ -18,11 +18,22 @@
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 #
 
+#------------------------------------------------------------------------
+#
+# Gramps modules
+#
+#------------------------------------------------------------------------
 from gramps.gen.datehandler import displayer as date_displayer
+from gramps.gen.db import DbTxn
 from gramps.gen.display.name import displayer as name_displayer
 from gramps.gen.lib import (Date, Event, EventType, EventRef, EventRoleType,
                             Person)
 
+#------------------------------------------------------------------------
+#
+# Gramplet modules
+#
+#------------------------------------------------------------------------
 from actionbase import ActionBase, represents_int
 
 #------------------------------------------------------------------------
@@ -54,12 +65,14 @@ def populate_model(self, db, citation, form_event, model):
                     for attr in event_ref.get_attribute_list():
                         if (attr.get_type() == "Name"): # Form specific _attribute name
                             model.append(parent, (name_displayer.display(person), attr.get_value(),
-                                        lambda db, trans, citation_handle = citation.handle, person_handle = person.handle: PrimaryNameCitation.command(db, trans, citation_handle, person_handle)))
+                                        lambda dbstate, uistate, track, citation_handle = citation.handle, person_handle = person.handle: PrimaryNameCitation.command(dbstate, uistate, track, citation_handle, person_handle)))
 
-    def command(db, trans, citation_handle, person_handle):
+    def command(dbstate, uistate, track, citation_handle, person_handle):
+        db = dbstate.db
         person = db.get_person_from_handle(person_handle)
         person.get_primary_name().add_citation(citation_handle)
-        db.commit_person(person, trans)
+        with DbTxn(_("Add Person (%s)") % name_displayer.display(person), db) as trans:
+            db.commit_person(person, trans)
 
 class BirthEvent(ActionBase):
     def __init__(self):
@@ -97,7 +110,7 @@ def populate_model(self, db, citation, form_event, model):
                                         birth_date.set_quality(Date.QUAL_CALCULATED)
 
                                         model.append(parent, (name_displayer.display(person), date_displayer.display(birth_date),
-                                                     lambda db, trans, citation_handle = citation.handle, person_handle = person.handle, birth_date_ = birth_date: ActionBase.add_event_to_person(db, trans, person_handle, EventType.BIRTH, birth_date_, None, citation_handle, EventRoleType.PRIMARY)))
+                                                     lambda dbstate, uistate, track, citation_handle = citation.handle, person_handle = person.handle, birth_date_ = birth_date: ActionBase.add_event_to_person(dbstate, uistate, track, person_handle, EventType.BIRTH, birth_date_, None, citation_handle, EventRoleType.PRIMARY)))
 
 class OccupationEvent(ActionBase):
     def __init__(self):
@@ -117,4 +130,4 @@ def populate_model(self, db, citation, form_event, model):
                             occupation = attr.get_value()
                             if (occupation) :
                                 model.append(parent, (name_displayer.display(person), occupation,
-                                             lambda db, trans, citation_handle = citation.handle, person_handle = person.handle, occupation_ = occupation: ActionBase.add_event_to_person(db, trans, person_handle, EventType.OCCUPATION, form_event.get_date_object(), occupation_, citation_handle, EventRoleType.PRIMARY)))
+                                             lambda dbstate, uistate, track, citation_handle = citation.handle, person_handle = person.handle, occupation_ = occupation: ActionBase.add_event_to_person(dbstate, uistate, track, person_handle, EventType.OCCUPATION, form_event.get_date_object(), occupation_, citation_handle, EventRoleType.PRIMARY)))

Form/actionbase.py

@@ -22,18 +22,38 @@
 ActionBase definitions.
 """
 
+#------------------------------------------------------------------------
+#
+# Gramps modules
+#
+#------------------------------------------------------------------------
+from gramps.gen.db import DbTxn
 from gramps.gen.display.name import displayer as name_displayer
 from gramps.gen.lib import (Event, EventType, EventRef, EventRoleType,
                             Person)
 
+#------------------------------------------------------------------------
+#
+# Internationalisation
+#
+#------------------------------------------------------------------------
+from gramps.gen.const import GRAMPS_LOCALE as glocale
+try:
+    _trans = glocale.get_addon_translator(__file__)
+except ValueError:
+    _trans = glocale.translation
+
+_ = _trans.gettext
+
 class ActionBase():
     """
     A class to read form definitions from an XML file.
     """
     def __init__(self):
         pass
 
-    def add_event_to_person(db, trans, person_handle, event_type, event_date_object, event_description, citation_handle, event_role_type):
+    def add_event_to_person(dbstate, uistate, track, person_handle, event_type, event_date_object, event_description, citation_handle, event_role_type):
+        db = dbstate.db
         """
         Add a new event to the specified person.
         """
@@ -44,14 +64,16 @@ def add_event_to_person(db, trans, person_handle, event_type, event_date_object,
         event.set_description(event_description)
 
         # add to the database
-        db.add_event(event, trans)
+        with DbTxn(_("Add Event (%s)") % event.get_gramps_id(), db) as trans:
+            db.add_event(event, trans)
         # Add new event reference to the Person record
         event_ref = EventRef()
         event_ref.ref = event.get_handle()
         event_ref.set_role(event_role_type)
         person = db.get_person_from_handle(person_handle)
         person.add_event_ref(event_ref)
-        db.commit_person(person, trans)
+        with DbTxn(_("Add Event (%s)") % name_displayer.display(person), db) as trans:
+            db.commit_person(person, trans)
 
 def represents_int(s):
     """

Form/formactions.py

@@ -173,14 +173,13 @@ def run(self):
         self._config.save()
 
         # run the selected actions
-        with DbTxn("FormActions", self.db) as trans:
-            (model, pathlist) = self.tree.get_selection().get_selected_rows()
-            for path in pathlist :
-                tree_iter = model.get_iter(path)
-
-                command = model.get_value(tree_iter, 2)
-                if command:
-                    (command)(self.db, trans)
+        (model, pathlist) = self.tree.get_selection().get_selected_rows()
+        for path in pathlist :
+            tree_iter = model.get_iter(path)
+
+            command = model.get_value(tree_iter, 2)
+            if command:
+                (command)(self.dbstate, self.uistate, self.track)
 
         self.top.destroy()