--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/Helpviewer/Sync/DirectorySyncHandler.py Sat Mar 10 17:42:07 2012 +0100
@@ -0,0 +1,225 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2012 Detlev Offenbach <detlev@die-offenbachs.de>
+#
+
+"""
+Module implementing a synchronization handler using a shared directory.
+"""
+
+import os
+
+from PyQt4.QtCore import pyqtSignal, QByteArray, QFileInfo
+
+from .SyncHandler import SyncHandler
+
+import Helpviewer.HelpWindow
+
+import Preferences
+
+
+class DirectorySyncHandler(SyncHandler):
+ """
+ Class implementing a synchronization handler using a shared directory.
+
+ @signal syncStatus(type_, done, message) emitted to indicate the synchronization
+ status (string one of "bookmarks", "history", "passwords" or "useragents",
+ boolean, string)
+ @signal syncError(message) emitted for a general error with the error message (string)
+ @signal syncMessage(message) emitted to send a message about synchronization (string)
+ @signal syncFinished(type_, done, download) emitted after a synchronization has
+ finished (string one of "bookmarks", "history", "passwords" or "useragents",
+ boolean, boolean)
+ """
+ syncStatus = pyqtSignal(str, bool, str)
+ syncError = pyqtSignal(str)
+ syncMessage = pyqtSignal(str)
+ syncFinished = pyqtSignal(str, bool, bool)
+
+ def __init__(self, parent=None):
+ """
+ Constructor
+
+ @param parent reference to the parent object (QObject)
+ """
+ super().__init__(parent)
+ self.__forceUpload = False
+
+ self.__remoteFilesFound = []
+
+ def initialLoadAndCheck(self, forceUpload):
+ """
+ Public method to do the initial check.
+
+ @keyparam forceUpload flag indicating a forced upload of the files (boolean)
+ """
+ if not Preferences.getHelp("SyncEnabled"):
+ return
+
+ self.__forceUpload = forceUpload
+
+ self.__remoteFilesFound = []
+
+ # check the existence of the shared directory; create it, if it is not there
+ if not os.path.exists(Preferences.getHelp("SyncDirectoryPath")):
+ try:
+ os.makedirs(Preferences.getHelp("SyncDirectoryPath"))
+ except OSError as err:
+ self.syncError.emit(
+ self.trUtf8("Error creating the shared directory.\n{0}")
+ .format(str(err)))
+ return
+
+ self.__initialSync()
+
+ def __downloadFile(self, type_, fileName):
+ """
+ Private method to downlaod the given file.
+
+ @param type_ type of the synchronization event (string one
+ of "bookmarks", "history", "passwords" or "useragents")
+ @param fileName name of the file to be downloaded (string)
+ """
+ try:
+ f = open(os.path.join(Preferences.getHelp("SyncDirectoryPath"),
+ self._remoteFiles[type_]), "rb")
+ data = f.read()
+ f.close()
+ except IOError as err:
+ self.syncStatus.emit(type_, False,
+ self.trUtf8("Cannot read remote file.\n{0}").format(str(err)))
+ self.syncFinished(type_, False, True)
+ return
+
+ ok, error = self.writeFile(QByteArray(data), fileName)
+ if ok:
+ self.syncStatus.emit(type_, True, self._messages[type_]["RemoteExists"])
+ else:
+ self.syncStatus.emit(type_, False, error)
+ self.syncFinished.emit(type_, True, True)
+
+ def __uploadFile(self, type_, fileName):
+ """
+ Private method to upload the given file.
+
+ @param type_ type of the synchronization event (string one
+ of "bookmarks", "history", "passwords" or "useragents")
+ @param fileName name of the file to be uploaded (string)
+ """
+ data = self.readFile(fileName)
+ if data.isEmpty():
+ self.syncStatus.emit(type_, True,
+ self._messages[type_]["LocalMissing"])
+ else:
+ try:
+ f = open(os.path.join(Preferences.getHelp("SyncDirectoryPath"),
+ self._remoteFiles[type_]), "wb")
+ f.write(bytes(data))
+ f.close()
+ except IOError as err:
+ self.syncStatus.emit(type_, False,
+ self.trUtf8("Cannot write remote file.\n{0}").format(str(err)))
+ self.syncFinished(type_, False, False)
+ return
+
+ self.syncFinished.emit(type_, True, False)
+
+ def __initialSyncFile(self, type_, fileName):
+ """
+ Private method to do the initial synchronization of the given file.
+
+ @param type_ type of the synchronization event (string one
+ of "bookmarks", "history", "passwords" or "useragents")
+ @param fileName name of the file to be synchronized (string)
+ """
+ if not self.__forceUpload and \
+ os.path.exists(os.path.join(Preferences.getHelp("SyncDirectoryPath"),
+ self._remoteFiles[type_])) and \
+ QFileInfo(fileName).lastModified() <= \
+ QFileInfo(os.path.join(Preferences.getHelp("SyncDirectoryPath"),
+ self._remoteFiles[type_]).lastModified()):
+ self.__downloadFile(type_, fileName,
+ QFileInfo(os.path.join(Preferences.getHelp("SyncDirectoryPath"),
+ self._remoteFiles[type_]).lastModified()).toTime_t())
+ else:
+ if os.path.exists(os.path.join(Preferences.getHelp("SyncDirectoryPath"),
+ self._remoteFiles[type_])):
+ self.syncStatus.emit(type_, True,
+ self._messages[type_]["RemoteMissing"])
+ else:
+ self.syncStatus.emit(type_, True,
+ self._messages[type_]["LocalNewer"])
+ self.__uploadFile(type_, fileName)
+
+ def __initialSync(self):
+ """
+ Private slot to do the initial synchronization.
+ """
+ # Bookmarks
+ if Preferences.getHelp("SyncBookmarks"):
+ self.__initialSyncFile("bookmarks",
+ Helpviewer.HelpWindow.HelpWindow.bookmarksManager().getFileName())
+
+ # History
+ if Preferences.getHelp("SyncHistory"):
+ self.__initialSyncFile("history",
+ Helpviewer.HelpWindow.HelpWindow.historyManager().getFileName())
+
+ # Passwords
+ if Preferences.getHelp("SyncPasswords"):
+ self.__initialSyncFile("passwords",
+ Helpviewer.HelpWindow.HelpWindow.passwordManager().getFileName())
+
+ # User Agent Settings
+ if Preferences.getHelp("SyncUserAgents"):
+ self.__initialSyncFile("useragents",
+ Helpviewer.HelpWindow.HelpWindow.userAgentsManager().getFileName())
+
+ self.__forceUpload = False
+ self.syncMessage.emit(self.trUtf8("Synchronization finished"))
+
+ def __syncFile(self, type_, fileName):
+ """
+ Private method to synchronize the given file.
+
+ @param type_ type of the synchronization event (string one
+ of "bookmarks", "history", "passwords" or "useragents")
+ @param fileName name of the file to be synchronized (string)
+ """
+ self.syncStatus.emit(type_, True, self._messages[type_]["Uploading"])
+ self.__uploadFile(type_, fileName)
+
+ def syncBookmarks(self):
+ """
+ Public method to synchronize the bookmarks.
+ """
+ self.__syncFile("bookmarks",
+ Helpviewer.HelpWindow.HelpWindow.bookmarksManager().getFileName())
+
+ def syncHistory(self):
+ """
+ Public method to synchronize the history.
+ """
+ self.__syncFile("history",
+ Helpviewer.HelpWindow.HelpWindow.historyManager().getFileName())
+
+ def syncPasswords(self):
+ """
+ Public method to synchronize the passwords.
+ """
+ self.__syncFile("passwords",
+ Helpviewer.HelpWindow.HelpWindow.passwordManager().getFileName())
+
+ def syncUserAgents(self):
+ """
+ Public method to synchronize the user agents.
+ """
+ self.__syncFile("useragents",
+ Helpviewer.HelpWindow.HelpWindow.userAgentsManager().getFileName())
+
+ def shutdown(self):
+ """
+ Public method to shut down the handler.
+ """
+ # nothing to do
+ return
