Move client.py messages to messages.py

syncplay/client.py

@@ -6,6 +6,7 @@ from twisted.internet.protocol import ClientFactory
 from twisted.internet import reactor, task
 from syncplay.protocols import SyncClientProtocol
 from syncplay import utils, constants
+from syncplay.messages import getMessage
 
 class SyncClientFactory(ClientFactory):
     def __init__(self, client, retry = constants.RECONNECT_RETRIES):
@@ -19,23 +20,22 @@ class SyncClientFactory(ClientFactory):
 
     def startedConnecting(self, connector):
         destination = connector.getDestination()
-        self._client.ui.showMessage('Attempting to connect to {}:{}'.format(destination.host, destination.port))
+        message = getMessage("en", "connection-attempt-notification").format(destination.host, destination.port)
+        self._client.ui.showMessage(message)
 
     def clientConnectionLost(self, connector, reason):
         if self._timesTried < self.retry:
             self._timesTried += 1
-            message = 'Connection with server lost, attempting to reconnect'
+            self._client.ui.showMessage(getMessage("en", "reconnection-attempt-notification"))
-            self._client.ui.showMessage(message)
             self.reconnecting = True
             reactor.callLater(0.1*(2**self._timesTried), connector.connect)
         else:
-            message = 'Disconnected from server'
+            message = getMessage("en", "disconnection-notification")
             self._client.ui.showMessage(message)
 
     def clientConnectionFailed(self, connector, reason):
         if not self.reconnecting:
-            message = 'Connection with server failed'
+            self._client.ui.showMessage(getMessage("en", "connection-failed-notification"))
-            self._client.ui.showMessage(message)
             self._client.stop(True)
         else:
             self.clientConnectionLost(connector, reason)
@@ -108,7 +108,7 @@ class SyncplayClient(object):
     def checkIfConnected(self):
         if(self._lastGlobalUpdate and self._protocol and time.time() - self._lastGlobalUpdate > constants.PROTOCOL_TIMEOUT):
             self._lastGlobalUpdate = None
-            self.ui.showErrorMessage("Connection with server timed out")
+            self.ui.showErrorMessage(getMessage("en", "server-timeout-error"))
             self._protocol.drop()
             return False
         return True
@@ -149,16 +149,14 @@ class SyncplayClient(object):
 
     def _rewindPlayerDueToTimeDifference(self, position, setBy):
         self.setPosition(position)
-        message = "Rewinded due to time difference with <{}>".format(setBy)
+        self.ui.showMessage(getMessage("en", "rewind-notification").format(setBy))
-        self.ui.showMessage(message)
         madeChangeOnPlayer = True
         return madeChangeOnPlayer
 
     def _serverUnpaused(self, setBy):
         self._player.setPaused(False)
         madeChangeOnPlayer = True
-        message = '<{}> unpaused'.format(setBy)
+        self.ui.showMessage(getMessage("en", "unpause-notification").format(setBy))
-        self.ui.showMessage(message)
         return madeChangeOnPlayer
 
     def _serverPaused(self, setBy, diff):
@@ -166,8 +164,7 @@ class SyncplayClient(object):
             self.setPosition(self.getGlobalPosition())
         self._player.setPaused(True)
         madeChangeOnPlayer = True
-        message = '<{}> paused'.format(setBy)
+        self.ui.showMessage(getMessage("en", "pause-notification").format(setBy))
-        self.ui.showMessage(message)
         return madeChangeOnPlayer
 
     def _serverSeeked(self, position, setBy):
@@ -177,7 +174,7 @@ class SyncplayClient(object):
             madeChangeOnPlayer = True
         else:
             madeChangeOnPlayer = False
-        message = '<{}> jumped from {} to {}'.format(setBy, utils.formatTime(self.playerPositionBeforeLastSeek), utils.formatTime(position))
+        message = getMessage("en", "seek-notification").format(setBy, utils.formatTime(self.playerPositionBeforeLastSeek), utils.formatTime(position))
         self.ui.showMessage(message)
         return madeChangeOnPlayer
 
@@ -185,13 +182,11 @@ class SyncplayClient(object):
         if(constants.SLOWDOWN_KICKIN_BOUNDARY < diff and not self._speedChanged):
             self._player.setSpeed(constants.SLOWDOWN_RATE)
             self._speedChanged = True
-            message = "Slowing down due to time difference with <{}>".format(setBy)
+            self.ui.showMessage(getMessage("en", "slowdown-notification").format(setBy))
-            self.ui.showMessage(message)
         elif(self._speedChanged and diff < constants.SLOWDOWN_RESET_BOUNDARY):
             self._player.setSpeed(1.00)
             self._speedChanged = False
-            message = "Reverting speed back to normal"
+            self.ui.showMessage(getMessage("en", "revert-notification"))
-            self.ui.showMessage(message)
         madeChangeOnPlayer = True
         return madeChangeOnPlayer
 
@@ -234,7 +229,7 @@ class SyncplayClient(object):
      
     def setUserOffset(self, time):
         self._userOffset = time
-        message = "Current offset: {} seconds".format(self._userOffset)
+        message =getMessage("en", "current-offset-notification").format(self._userOffset)
         self.setPosition(self.getGlobalPosition())
         self.ui.showMessage(message)
         
@@ -341,7 +336,7 @@ class SyncplayClient(object):
             self._player.drop()
         reactor.callLater(0.1, reactor.stop)
         if(promptForAction):
-            self.ui.promptFor("Press enter to exit\n")
+            self.ui.promptFor(getMessage("en", "enter-to-exit-prompt"))
 
 class SyncplayUser(object):
     def __init__(self, username = None, room = None, file_ = None, position = 0):
@@ -378,16 +373,16 @@ class SyncplayUserlist(object):
 
     def __showUserChangeMessage(self, username, room, file_):
         if (room and not file_):
-            message = "<{}> has joined the room: '{}'".format(username, room)
+            message = getMessage("en", "room-join-notification").format(username, room)
             self.ui.showMessage(message)
         elif (room and file_ and username != self.currentUser.username):
             duration = utils.formatTime(file_['duration'])
-            message = "<{}> is playing '{}' ({})".format(username, file_['name'], duration)
+            message = getMessage("en", "playing-notification").format(username, file_['name'], duration)
             if(self.currentUser.room <> room or self.currentUser.username == username):
-                message += " in room: '{}'".format(room)
+                message += getMessage("en", "playing-notification/room-addendum").format(room)
             self.ui.showMessage(message)
             if(self.currentUser.file and not self.currentUser.isFileSame(file_) and self.currentUser.room == room):
-                message = "File you are playing appears to be different from <{}>'s".format(username)
+                message = getMessage("en", "file-different-notification").format(username)
                 self.ui.showMessage(message)
                 differences = []
                 if(self.currentUser.file['name'] <> file_['name']):
@@ -396,7 +391,7 @@ class SyncplayUserlist(object):
                     differences.append("size")
                 if(self.currentUser.file['duration'] <> file_['duration']):
                     differences.append("duration")
-                message = "Your file differs in the following way(s): " + ", ".join(differences)
+                message = getMessage("en", "file-differences-notification")+ ", ".join(differences)
                 self.ui.showMessage(message)
 
     def addUser(self, username, room, file_, position = 0, noMessage = False):
@@ -411,7 +406,7 @@ class SyncplayUserlist(object):
     def removeUser(self, username):
         if(self._users.has_key(username)):
             self._users.pop(username)
-            message = "<{}> has left".format(username)
+            message = getMessage("en", "left-notification").format(username)
             self.ui.showMessage(message)
             
     def __displayModUserMessage(self, username, room, file_, user):
@@ -463,12 +458,12 @@ class SyncplayUserlist(object):
         if(self.currentUser.file):
             fileHasSameSizeAsYour = user.file['size'] == self.currentUser.file['size']
             fileHasSameNameYour = user.file['name'] == self.currentUser.file['name']
-            differentFileMessage = " (their file size is different from yours!)"
+            differentFileMessage =  getMessage("en", "different-filesize-notification")
             message += differentFileMessage if not fileHasSameSizeAsYour and fileHasSameNameYour else ""
         return message
 
     def __displayFileWatchersInRoomList(self, key, users):
-        self.ui.showMessage("File: {} is being played by:".format(key), True, True)
+        self.ui.showMessage(getMessage("en", "file-played-by-notification").format(key), True, True)
         for user in sorted(users.itervalues()):
             message = "<"+user.username+">"
             if(self.currentUser.username == user.username):
@@ -478,7 +473,7 @@ class SyncplayUserlist(object):
 
     def __displayPeopleInRoomWithNoFile(self, noFileList):
         if (noFileList):
-            self.ui.showMessage("People who are not playing any file:",  True, True)
+            self.ui.showMessage(getMessage("en", "notplaying-notification"),  True, True)
             for user in sorted(noFileList.itervalues()):
                 self.ui.showMessage("\t<" + user.username + ">", True, True)
 

syncplay/messages.py

@@ -1,5 +1,38 @@
 en = {
-      "connecting" : "Attempting to connect to {}:{}"
+     
+      # Client notifications
+      "connection-attempt-notification" : "Attempting to connect to {}:{}", #Port, IP
+      "reconnection-attempt-notification" : "Connection with server lost, attempting to reconnect",
+      "disconnection-notification" : "Disconnected from server",
+      "connection-failed-notification" : "Connection with server failed",
+      
+      "rewind-notification" : "Rewinded due to time difference with <{}>", #User
+      "slowdown-notification" : "Slowing down due to time difference with <{}>", #User
+      "revert-notification" : "Reverting speed back to normal", 
+      
+      "pause-notification" : "<{}> paused", #User
+      "unpause-notification" : "<{}> unpaused", #User
+      "seek-notification" : "<{}> jumped from {} to {}", #User, from time, to time
+      
+      "current-offset-notification" : "Current offset: {} seconds", #Offset
+      
+      "room-join-notification" : "<{}> has joined the room: '{}'", #User
+      "left-notification" : "<{}> has left", #User
+      "playing-notification" : "<{}> is playing '{}' ({})", #User, file, duration
+      "playing-notification/room-addendum" :  " in room: '{}'", #Room
+      
+      "file-different-notification" : "File you are playing appears to be different from <{}>'s", #User
+      "file-differences-notification" : "Your file differs in the following way(s): ",
+      
+      "different-filesize-notification" : " (their file size is different from yours!)",
+      "file-played-by-notification" : "File: {} is being played by:", #User
+      "notplaying-notification" : "People who are not playing any file:",
+      
+      # Client prompts
+      "enter-to-exit-prompt" : "Press enter to exit\n",
+      
+      # Client errors
+      "server-timeout-error" : "Connection with server timed out"
       }
 
 messages = {