Changeset 1809

Timestamp:

02/24/07 07:01:29 (22 months ago)

Author:

abaumann

Message:

cleanup:

• remove DEBUG/WARNING options from motosync source, and replace them with calls to opensync's tracing and warning functions
• remove WRITE_ENABLED option, since you can screw the data on the PC side without it anyway, and mototool lets you make and restore a backup of the phone

Location:

plugins/moto-sync

Files:

• README (modified) (2 diffs)
• motosync.py (modified) (12 diffs)
• mototool (modified) (4 diffs)

plugins/moto-sync/README

@@ -6 +6 @@
 mess up the data on your phone and any other members of the sync group,
 due to the limited data that can be stored on the phone. Use with caution
-and make backups!
-
-To prevent it writing any changes to the phone, set WRITE_ENABLED to False
-(near the top of the file). Note that this will still allow it to send data
-back to the other members of the sync group, so you probably want to have
-backups of everything anyway. See TESTING/BACKUP below.
+and make backups! See TESTING/BACKUP below.
 
 
@@ -85 +80 @@
 TESTING/BACKUP
 
-Before doing anything with write enabled, it is probably a good idea to
-backup the data from your phone. You can use the mototool script to
-do this, and to delete entries on the phone. Run 'mototool --help' for 
-details, or, for the impatient, try:
-    mototool -v -d (device string) -f myphone.backup --backup
+Before doing anything, it is probably a good idea to backup the data 
+from your phone. You can use the mototool script to do this, and to 
+delete entries on the phone. Run 'mototool --help' for details, or, for 
+the impatient, try:
+    mototool -d (device string) -f myphone.backup --backup
 
 

plugins/moto-sync/motosync.py

@@ -12 +12 @@
 __revision__ = "$Id$"
 
-import sys, os, types, md5, time, calendar, re
+import os, types, md5, time, calendar, re
 import xml.dom.minidom
 from datetime import date, datetime, timedelta, time as datetime_time
@@ -32 +32 @@
     USE_BLUETOOTH_MODULE = False
 
-# debug/test options:
-DEBUG_OUTPUT = False # if enabled, logs all interaction with the phone to stdout
-WARNING_OUTPUT = True # if enabled, prints warnings to stderr (reccommended)
-WRITE_ENABLED = True # if disabled, prevents changes from being made to phone
 
 # Regular expression for a Bluetooth MAC address
@@ -174 +170 @@
 RRULE_FUTURE = timedelta(365) # 1 year
 
-
-def debug(msg):
-    """Print a debug message, if enabled."""
-    if DEBUG_OUTPUT:
-        sys.stdout.write("moto-sync: " + msg + "\n")
-
-def warning(msg):
-    """Print a warning message, if enabled."""
-    if WARNING_OUTPUT:
-        sys.stderr.write("moto-sync: Warning: " + msg + "\n")
 
 def getElementsByTagNames(parent, tagnames, ret):
@@ -452 +438 @@
                 tty.setraw(self.__fd)
             else:
-                warning('tty module not present, unable to set raw mode')
+                opensync.trace(opensync.TRACE_INTERNAL, 'tty module not present, unable to set raw mode')
 
         # reset the phone and send it a bunch of init strings
@@ -580 +566 @@
         data = evdata[:-1]
         placeholders = self.__make_placeholders(data)
-        self.__do_cmd(('AT+MDBW=' + placeholders) % tuple(data), WRITE_ENABLED)
+        self.__do_cmd(('AT+MDBW=' + placeholders) % tuple(data))
         for expos in exceptions:
-            self.__do_cmd('AT+MDBWE=%d,%d,1' % (pos, expos), WRITE_ENABLED)
+            self.__do_cmd('AT+MDBWE=%d,%d,1' % (pos, expos))
 
     def delete_event(self, pos):
         """delete the event at a specific position"""
         self.open_calendar()
-        self.__do_cmd('AT+MDBWE=%d,0,0' % pos, WRITE_ENABLED)
+        self.__do_cmd('AT+MDBWE=%d,0,0' % pos)
 
     def read_categories(self):
@@ -662 +648 @@
         self.close_calendar()
         placeholders = self.__make_placeholders(data)
-        self.__do_cmd(('AT+MPBW=' + placeholders) % tuple(data), WRITE_ENABLED)
+        self.__do_cmd(('AT+MPBW=' + placeholders) % tuple(data))
 
     def delete_contact(self, pos):
         """delete the contact at a given position"""
         self.close_calendar()
-        self.__do_cmd('AT+MPBW=%d' % pos, WRITE_ENABLED)
+        self.__do_cmd('AT+MPBW=%d' % pos)
 
     def __readchar(self):
@@ -685 +671 @@
             ret += c
             c = self.__readchar()
-        debug('<-- ' + ret)
+        opensync.trace(opensync.TRACE_SENSITIVE, '<-- ' + ret)
         if c == '': # EOF, shouldn't happen
             raise opensync.Error('Unexpected EOF talking to phone', opensync.ERROR_IO_ERROR)
         return ret
 
-    def __do_cmd(self, cmd, reallydoit=True):
+    def __do_cmd(self, cmd):
         """Send a command to the phone and wait for its response.
 
@@ -696 +682 @@
         """
         cmd = cmd.encode('iso_8859_1')
-        debug('--> ' + cmd)
+        opensync.trace(opensync.TRACE_SENSITIVE, '--> ' + cmd)
         ret = []
-        if reallydoit:
-            cmd = cmd + '\r'
-            if self.__fd:
-                os.write(self.__fd, cmd)
-            elif self.__btsock:
-                self.__btsock.send(cmd)
-            line = self.__readline()
-        else:
-            line = 'OK'
+        cmd = cmd + '\r'
+        if self.__fd:
+            os.write(self.__fd, cmd)
+        elif self.__btsock:
+            self.__btsock.send(cmd)
+        line = self.__readline()
         while line != 'OK' and line != 'ERROR':
             ret.append(line)
@@ -1644 +1627 @@
         return True
 
-    def update_entry(self, change):
+    def update_entry(self, change, context):
         """Update an entry or add a new one, from the OSyncChange object.
         
@@ -1658 +1641 @@
                 entry = PhoneContactXML(change.data.data, self.revcategories)
         except UnsupportedDataError, e:
-            warning("%s is unsupported (%s), ignored" % (change.uid, str(e)))
+            err = opensync.Error("%s is unsupported (%s), ignored" % (change.uid, str(e)), opensync.ERROR_NOT_SUPPORTED)
+            context.report_osyncwarning(err)
             # we have an entry that can't be stored on the phone
             # if its modified and we've seen it before, delete it
@@ -1782 +1766 @@
         elif change.changetype == opensync.CHANGE_TYPE_MODIFIED:
             old_uid = change.uid
-            success = self.access.update_entry(change)
+            success = self.access.update_entry(change, ctx)
             # if the UID has changed, we need to tell our hashtable that
             # the old one was deleted, to keep it consistent
@@ -1788 +1772 @@
                 self.hashtable.update_hash(opensync.CHANGE_TYPE_DELETED, old_uid, None)
         else:
-            success = self.access.update_entry(change)
+            success = self.access.update_entry(change, ctx)
         if success:
             self.hashtable.update_hash(change.changetype, change.uid, change.hash)

plugins/moto-sync/mototool

@@ -31 +31 @@
     p.add_option('-d', '--device', dest='device',
                  help='device to access phone, defaults to %s' % DEFAULT_DEVICE)
-    p.add_option('-v', '--verbose', action='store_true', dest='verbose',
-                 help='log phone commands to stdout')
     p.add_option('-t', '--type', action='append', dest='objtype',
                  choices=motosync.SUPPORTED_OBJTYPES,
@@ -44 +42 @@
     p.add_option('--delete', action='store_const', dest='mode', const='delete',
                  help='delete all entries on the phone')
-    p.set_defaults(device=DEFAULT_DEVICE, verbose=False, filename=None,
-                   mode=None, objtype=None)
+    p.set_defaults(device=DEFAULT_DEVICE, filename=None, mode=None, objtype=None)
     options, args = p.parse_args()
     if not options.mode:
@@ -56 +53 @@
     """Prompt the user if they are trying to write to the phone."""
     if options.mode == 'delete' or options.mode == 'restore':
-        if not motosync.WRITE_ENABLED:
-            print 'WARNING: writes disabled, this will not save/delete anything'
-        else:
-            print ('WARNING: About to %s all %s entries from the phone!'
-                % (options.mode, ' & '.join(options.objtype)))
+        print ('WARNING: About to %s all %s entries from the phone!'
+               % (options.mode, ' & '.join(options.objtype)))
         print 'Are you sure? [yn] ',
         if sys.stdin.read(1).lower() != 'y':
@@ -107 +101 @@
     if not options.objtype:
         options.objtype = motosync.SUPPORTED_OBJTYPES
-    motosync.DEBUG_OUTPUT = options.verbose
 
     prompt_user(options)