Merge lp:~narendraj9/gtg/bug_971651_fixed into lp:~gtg/gtg/old-trunk

[Narendra Joshi]

Fixes bug #971651: https://bugs.launchpad.net/gtg/+bug/971651

Used a module wide variable in cleanxml.py to store information about backups being used everytime a call to openxml is made. Added a function to get the state of backup usage: cleanxml.used_backup()

Modified GTG/backends/backend_localfile.py to store information about whether backup files were used while instantiating a Backend object. Added a function used_backup() to get status about backup recovery.

Added a call to BackendSignals().interaction_requested(..) in GTG/gtk/manager.py inside the open_browser function, called whenever backup files are used to recover gtg_tasks.xml. I had to modify the function GTG.gtk.browser.custominfobar._prepare_textual_iteraction to add a case for backup recovery notification. There must be a more elegant way to do this, I guess.

[lp:~narendraj9/gtg/bug_971651_fixed]

1364. By Narendra Joshi on 2014-03-10

backup files are now used even when gtg_tasks.xml is missing.
Earlier they were used only when gtg_tasks.xml was malformed.

1365. By Narendra Joshi on 2014-03-10

Modified CHANGELOG and added myself to AUTHORS

1366. By Narendra Joshi on 2014-03-11

Fixed some PEP8 erros and warnings

1367. By Narendra Joshi on 2014-03-11

Fixed a typo

1368. By Narendra Joshi on 2014-03-13

Added date of creation of the backup used in recovery to the info being displayed.

1369. By Narendra Joshi on 2014-03-13

Backup infobar fixed on first_run

1370. By Narendra Joshi on 2014-03-13

Removed a PEP8 error. Fixed a typo.

[Izidor Matušov (izidor)]

Fix merged on github as https://github.com/getting-things-gnome/gtg/commit/99dbb240aa866961174ffd88e14990a91a42001c

review: Approve

=== modified file 'AUTHORS'
--- AUTHORS	2014-03-05 19:25:18 +0000
+++ AUTHORS	2014-03-13 18:43:02 +0000
@@ -133,4 +133,5 @@
 * Sushant Raikar <[e-mail]>
 * Atit Anand <[e-mail]>
 * Parth P. Panchal <[e-mail]>
-* Sara Ribeiro <[e-mail]>
\ No newline at end of file
+* Sara Ribeiro <[e-mail]>
+* Narendra Joshi <[e-mail]>

=== modified file 'CHANGELOG'
--- CHANGELOG	2014-03-10 03:37:32 +0000
+++ CHANGELOG	2014-03-13 18:43:02 +0000
@@ -21,6 +21,7 @@
     * Fix for bug #316922 : Have a link to the parent(s) in the task editor, by Parth Panchal
     * Fix for bug #1287259 : pep8ify the codebase, by Izidor Matušov
     * Rework of test-suite, by Izidor Matušov
+	* Fix for bug #971651:  Inform about automatic recovery. Also made to use backup files on gtg_tasks.xml missing
 
 2013-11-24 Getting Things GNOME! 0.3.1
     * Fix for bug #1024473: Have 'Show Main Window' in notification area, by Antonio Roquentin

=== modified file 'GTG/backends/backend_localfile.py'
--- GTG/backends/backend_localfile.py	2013-11-23 14:40:23 +0000
+++ GTG/backends/backend_localfile.py	2014-03-13 18:43:02 +0000
@@ -29,6 +29,7 @@
 
 from GTG import _
 from GTG.backends.genericbackend import GenericBackend
+from GTG.backends.backendsignals import BackendSignals
 from GTG.core import CoreConfig
 from GTG.tools import cleanxml, taskxml
 
@@ -93,9 +94,11 @@
             parameters["path"] = parameters.pop("need_conversion")
         if not self.KEY_DEFAULT_BACKEND in parameters:
             parameters[self.KEY_DEFAULT_BACKEND] = True
-
         self.doc, self.xmlproj = cleanxml.openxmlfile(
             self.get_path(), "project")
+        # status if backup was used while trying to open xml file
+        self._used_backup = cleanxml.used_backup()
+        self._backup_file_info = cleanxml.backup_file_info()
         # Make safety daily backup after loading
         cleanxml.savexml(self.get_path(), self.doc, backup=True)
 
@@ -130,6 +133,7 @@
         cleanxml.savexml(self.get_path(), xml)
         self.doc, self.xmlproj = cleanxml.openxmlfile(
             self.get_path(), "project")
+        self._used_backup = False
 
     def start_get_tasks(self):
         """ This function starts submitting the tasks from the XML file into
@@ -197,3 +201,33 @@
         # We save the XML file only if it's necessary
         if modified:
             cleanxml.savexml(self.get_path(), self.doc, backup=True)
+
+    def used_backup(self):
+        """ This functions return a boolean value telling if backup files
+        were used when instantiating Backend class.
+        """
+        return self._used_backup
+
+    def backup_file_info(self):
+        """This functions returns status of the attempt to recover
+        gtg_tasks.xml
+        """
+        return self._backup_file_info
+
+    def notify_user_about_backup(self):
+        """ This function causes the inforbar to show up with the message
+        about file recovery.
+        """
+        BackendSignals().interaction_requested(self.get_id(),
+                                               "Oops, something unexpected "
+                                               "happened! GTG tried to recover"
+                                               " your tasks from backups. \n" +
+                                               self.backup_file_info(),
+                                               BackendSignals(
+                                               ).INTERACTION_TEXT,
+                                               "on_continue_clicked")
+
+    def on_continue_clicked(self, *args):
+        """ Callback when the user clicks continue in the infobar
+        """
+        pass

=== modified file 'GTG/gtk/browser/custominfobar.py'
--- GTG/gtk/browser/custominfobar.py	2013-11-25 02:37:46 +0000
+++ GTG/gtk/browser/custominfobar.py	2014-03-13 18:43:02 +0000
@@ -153,7 +153,6 @@
         if event == Gtk.ResponseType.ACCEPT:
             if self.interaction_type == BackendSignals().INTERACTION_TEXT:
                 self._prepare_textual_interaction()
-                print("done")
             elif self.interaction_type == BackendSignals().INTERACTION_CONFIRM:
                 self.hide()
                 threading.Thread(target=getattr(self.backend,
@@ -164,6 +163,11 @@
         Helper function. gtk calls to populate the infobar in the case of
         interaction request
         '''
+
+        # If infobar is used just to notify user of backup recovery
+        if self.callback == "on_continue_clicked":
+            self.hide()
+            return
         title, description\
             = getattr(self.backend,
                       self.callback)("get_ui_dialog_text")

=== modified file 'GTG/gtk/manager.py'
--- GTG/gtk/manager.py	2014-03-09 12:59:59 +0000
+++ GTG/gtk/manager.py	2014-03-13 18:43:02 +0000
@@ -117,6 +117,12 @@
     def open_browser(self):
         if not self.browser:
             self.browser = TaskBrowser(self.req, self)
+        # notify user if backup was used
+        backend_dic = self.req.get_all_backends()
+        for backend in backend_dic:
+            if backend.get_name() == "backend_localfile" and \
+                    backend.used_backup():
+                backend.notify_user_about_backup()
         Log.debug("Browser is open")
 
     # FIXME : the browser should not be the center of the universe.

=== modified file 'GTG/tools/cleanxml.py'
--- GTG/tools/cleanxml.py	2014-03-09 12:59:59 +0000
+++ GTG/tools/cleanxml.py	2014-03-13 18:43:02 +0000
@@ -30,6 +30,8 @@
 tab = "\t"
 enter = "\n"
 BACKUP_NBR = 7
+_USED_BACKUP = False
+_BACKUP_FILE_INFO = ""
 
 # Those two functions are there only to be able to read prettyXML
 # Source: http://yumenokaze.free.fr/?/Informatique/Snipplet/Python/cleandom
@@ -119,6 +121,11 @@
 
     If file doesn't exist, create a new file """
 
+    #reset _USED_BACKUP and _BACKUP_FILE_INFO
+    global _USED_BACKUP
+    global _BACKUP_FILE_INFO
+    _USED_BACKUP = False
+    _BACKUP_FILE_INFO = ""
     tmpfile = zefile + '__'
     try:
         if os.path.exists(zefile):
@@ -126,14 +133,10 @@
         elif os.path.exists(tmpfile):
             Log.warning("Something happened to %s. Using backup" % zefile)
             os.rename(tmpfile, zefile)
-            return _try_openxmlfile(zefile, root)
-        else:
-            # Creating empty file
-            doc, xmlproject = emptydoc(root)
-            newfile = savexml(zefile, doc)
-            if not newfile:
-                Log.error("Could not create a new file %s" % zefile)
-                sys.exit(1)
+            _USED_BACKUP = True
+            _BACKUP_FILE_INFO = "Recovered from backup made on: " + \
+                datetime.datetime.fromtimestamp(
+                    os.path.getmtime(tmpfile)).strftime('%Y-%m-%d')
             return _try_openxmlfile(zefile, root)
 
     except IOError as msg:
@@ -146,25 +149,46 @@
         if os.path.exists(tmpfile):
             Log.warning("Something happened to %s. Using backup" % zefile)
             os.rename(tmpfile, zefile)
+            _USED_BACKUP = True
+            _BACKUP_FILE_INFO = "Recovered from backup made on: " + \
+                datetime.datetime.fromtimestamp(
+                    os.path.getmtime(tmpfile)).strftime('%Y-%m-%d')
             # Ok, try one more time now
             try:
                 return _try_openxmlfile(zefile, root)
             except Exception as msg:
                 Log.warning('Failed with reason: %s' % msg)
 
-        # Try to revert to backup
-        backup_name = _get_backup_name(zefile)
-        for i in range(BACKUP_NBR):
-            backup_file = "%s.bak.%d" % (backup_name, i)
-            if os.path.exists(backup_file):
-                Log.info("Trying to restore backup file %s" % backup_file)
-                try:
-                    return _try_openxmlfile(backup_file, root)
-                except Exception as msg:
-                    Log.warning('Failed with reason: %s' % msg)
-
-        Log.info("No suitable backup was found")
+    # Try to revert to backup
+    backup_name = _get_backup_name(zefile)
+    for i in range(BACKUP_NBR):
+        backup_file = "%s.bak.%d" % (backup_name, i)
+        if os.path.exists(backup_file):
+            Log.info("Trying to restore backup file %s" % backup_file)
+            _USED_BACKUP = True
+            _BACKUP_FILE_INFO = "Recovered from backup made on: " + \
+                datetime.datetime.fromtimestamp(
+                    os.path.getmtime(backup_file)).strftime('%Y-%m-%d')
+            try:
+                return _try_openxmlfile(backup_file, root)
+            except Exception as msg:
+                Log.warning('Failed with reason: %s' % msg)
+
+    Log.info("No suitable backup was found")
+
+    # Creating empty file
+    doc, xmlproject = emptydoc(root)
+    newfile = savexml(zefile, doc)
+    if not newfile:
+        Log.error("Could not create a new file %s" % zefile)
         sys.exit(1)
+    # set _USED_BACKUP even if there's a failure to notify about the same
+    _USED_BACKUP = True
+    _BACKUP_FILE_INFO = "No backups found. Created a new file"
+    return _try_openxmlfile(zefile, root)
+
+    # exit if execution reached this statement
+    sys.exit(1)
 
 
 # Return a doc element with only one root element of the name "root"
@@ -235,3 +259,15 @@
     except IOError as msg:
         print(msg)
         return False
+
+
+def used_backup():
+    """ This function returns true if a call to openxml used saved backup file
+    """
+    return _USED_BACKUP
+
+
+def backup_file_info():
+    """ Return information about the status of automatic backup file recovery
+    """
+    return _BACKUP_FILE_INFO