]> git.phdru.name Git - extfs.d.git/blobdiff - obexftp
Import logging requires python 2.3+.
[extfs.d.git] / obexftp
diff --git a/obexftp b/obexftp
index 8d4906d1639152e3e4ea7426f79608521336225b..acc51fd9ff957a5caefba9dd1f3b179505f95427 100755 (executable)
--- a/obexftp
+++ b/obexftp
@@ -7,54 +7,66 @@ Author: Oleg BroytMann <phd@phd.pp.ru>.
 Copyright (C) 2004 PhiloSoft Design.
 License: GPL.
 
-Manipulate a cell phone's filesystem calling obexftp binary. This is a complete
-user-mode solution, no kernel modules required (unlike SieFS or such). The
-script implements all commands of Midnight VFS, except for undocumented "run";
-but there are no runnable files in the cell phone. The script is written in
-Python because I love Python, the best of all languages, and I need to parse
-XML directory listings from obexftp.
+Manipulate a cell phone's filesystem calling obexftp binary. This is a
+complete user-mode solution, no kernel modules required (unlike SieFS or
+such). The script implements all commands of Midnight VFS, except for
+undocumented "run"; anyway there are no runnable files in the cell phone. The
+script is written in Python because I love Python, the best of all languages ;),
+and I need to parse XML directory listings from obexftp.
 
 The script requires Midnight Commander 3.1+ (http://www.ibiblio.org/mc/),
-Python 2.2+ (http://www.python.org/),
-OpenOBEX 1.0.1+ (http://openobex.sourceforge.net/)
-and ObexFTP 0.10.4+ (http://triq.net/obexftp).
+Python 2.3+ (http://www.python.org/),
+OpenOBEX 1.0.1+ (http://openobex.sourceforge.net/) and
+ObexFTP 0.10.4+ (http://triq.net/obexftp).
 
 Edit the script, and correct the shebang path, if your python is not in the
 /usr/local. Edit the full path to the obexftp binary (see below). Put the file
 in the /usr/[local/]lib/mc/extfs, and add a line "obexftp" to the
 /usr/[local/]lib/mc/extfs/extfs.ini.
 
-Create somewhere a transport file. The transport file can have any name, and is
-expected to be a text file with at least one line defining the transport to
+Create somewhere a transport file. The transport file may have any name, and
+is expected to be a text file with at least one line defining the transport to
 your device. Other lines in the file are ignored.
 
 First word in the line is a transport name - Bluetooth, TTY or IrDA. The name
 is case-insensitive.
 
 For the Bluetooth transport put there a line "Bluetooth CP:AD:RE:SS channel",
-where CP:AD:RE:SS is the hardware address of the device you want to connect to,
-and channel is the OBEX File Transfer channel; you can discover the address and
-the channel for your device by using commands like "hcitool scan" and "sdptool
-browse".
+where CP:AD:RE:SS is the hardware address of the device you want to connect
+to, and "channel" is the OBEX File Transfer channel; you can discover the
+address and the channel for your device by using commands like "hcitool scan"
+and "sdptool browse".
 
 For the TTY put the device name: "tty /dev/ttyUSB0".
 
 For the IrDA: just put "IrDA" in the file.
 
-Now run this "cd" command in the Midnight Commander (in the "bindings" files
-the command is "%cd"): cd description#obexftp, where "description" is the name
-of your file. The VFS script uses obexftp to connect to the device and list
-files and directories. Please be warned that opening the VFS for the first time
-is VERY slow, because the script needs to scan the entire cell phone's
+Now run this "cd" command in the Midnight Commander (in the "bindings" file
+the command is "%cd"): cd transport#obexftp, where "transport" is the name of
+your transport file. The script uses obexftp to connect to the device and list
+files and directories. Please be warned that opening the VFS for the first
+time is VERY slow, because the script needs to scan the entire cell phone's
 filesystem. And there must be timeouts between connections, which don't make
-the scanning faster. Midnight Commander caches the result, so you can browse
-directories quickly.
+the scanning faster. Midnight Commander caches the result so you can browse
+and manipulate files and directories quickly.
+
+Please note that manipulating the filesystem using your phone's internal
+filemanager in parallel with the VFS leads to disagreement between the VFS
+cache and the phone. It is not very dangerous but inconvenient. There is no
+way to clear the VFS cache in Midnight Commander and reread the filesystem.
+You have to exit the VFS (cd /, for example) and return back using cd
+transport#obexftp command. Sometimes even this doesn't help - Midnight
+Commander shows the same cached VFS image. Exit Midnight Commander and
+restart it.
+
+If something goes wrong you can help by turning log_level to INFO (see below)
+or DEBUG and looking in the obexftp-mcextfs.log file.
 
 """
 
-__version__ = "1.0.1"
-__revision__ = "$Id: obexftp,v 1.12 2004/06/23 16:05:34 phd Exp $"
-__date__ = "$Date: 2004/06/23 16:05:34 $"[7:-2]
+__version__ = "1.1.0"
+__revision__ = "$Id: obexftp,v 1.15 2004/07/27 16:35:28 phd Exp $"
+__date__ = "$Date: 2004/07/27 16:35:28 $"[7:-2]
 __author__ = "Oleg Broytmann <phd@phd.pp.ru>"
 __copyright__ = "Copyright (C) 2004 PhiloSoft Design"
 
@@ -62,6 +74,9 @@ __copyright__ = "Copyright (C) 2004 PhiloSoft Design"
 # Change this to suite your needs
 obexftp_prog = "/usr/local/obex/bin/obexftp"
 
+import logging
+log_level = logging.DEBUG
+
 
 import sys, time
 import os, shutil
@@ -69,47 +84,26 @@ import xml.dom.minidom
 from tempfile import mkdtemp
 
 
-def log_error(msg):
-   sys.stderr.write(msg + '\n')
-
-def error(msg):
-   log_error(msg)
-   sys.exit(1)
+logger = logging.getLogger('obexftp-mcextfs')
+logger.addHandler(logging.FileHandler('obexftp-mcextfs.log'))
+logger.setLevel(log_level)
 
 
 if len(sys.argv) < 2:
-   error("""\
+   logger.error("""\
 ObexFTP Virtual FileSystem for Midnight Commander version %s
 Author: %s
 %s
-Put it in /usr/lib/mc/extfs. For more information read the source!""" % (
+Put it in /usr/lib/mc/extfs. For more information read the source!""",
    __version__, __author__, __copyright__
-))
-
-
-def setup_transport():
-   """Setup transport parameters for the obexftp program"""
-   transport_file = open(sys.argv[2], 'r')
-   line = transport_file.readline()
-   transport_file.close()
-
-   parts = line.strip().split()
-   transport = parts[0].lower()
-
-   if transport == "bluetooth":
-      return ' '.join(["-b", parts[1], "-B", parts[2]])
-   elif transport == "tty":
-      return ' '.join(["-t", parts[1]])
-   elif transport == "irda":
-      return "-i"
-   else:
-      error("Unknown transport '%s'; expected 'bluetooth', 'tty' or 'irda'" % transport)
+)
+   sys.exit(1)
 
 
 # Parse ObexFTP XML directory listings
 
 class DirectoryEntry(object):
-   """Represent remote files and directories"""
+   """Represent a remote file or a directory"""
 
    def __init__(self, type):
       self.type = type
@@ -158,7 +152,7 @@ def get_entries(dom, type):
    return entries
 
 
-def recursive_list(obexftp_args, directory):
+def recursive_list(directory='/'):
    """List the directory recursively"""
    pipe = os.popen("%s %s -l '%s' 2>/dev/null" % (obexftp_prog, obexftp_args, directory), 'r')
    listing = pipe.read()
@@ -180,16 +174,14 @@ def recursive_list(obexftp_args, directory):
       fullpath = "%s/%s" % (directory, entry.name)
       if fullpath.startswith('//'): fullpath = fullpath[1:]
       time.sleep(1)
-      recursive_list(obexftp_args, fullpath)
+      recursive_list(fullpath)
 
 def mcobex_list():
    """List the entire VFS"""
-   obexftp_args = setup_transport()
-   recursive_list(obexftp_args, '/')
+   recursive_list()
 
 
 # A unique directory for temporary files
-
 tmpdir_name = None
 
 def setup_tmpdir():
@@ -204,45 +196,45 @@ def cleanup_tmpdir():
 
 def mcobex_copyout():
    """Get a file from the VFS"""
-   obexftp_args = setup_transport()
    obex_filename = sys.argv[3]
    real_filename = sys.argv[4]
 
    setup_tmpdir()
-   os.system("%s %s -g '%s' 2>/dev/null" % (obexftp_prog, obexftp_args, obex_filename))
    try:
-      os.rename(os.path.basename(obex_filename), real_filename)
-   except OSError:
-      pass
-   cleanup_tmpdir()
+      os.system("%s %s -g '%s' 2>/dev/null" % (obexftp_prog, obexftp_args, obex_filename))
+      try:
+         os.rename(os.path.basename(obex_filename), real_filename)
+      except OSError:
+         pass
+   finally:
+      cleanup_tmpdir()
 
 
 def mcobex_copyin():
    """Put a file to the VFS"""
-   obexftp_args = setup_transport()
    obex_filename = sys.argv[3]
    real_filename = sys.argv[4]
    dirname, filename = os.path.split(obex_filename)
 
    setup_tmpdir()
-   os.rename(real_filename, filename)
-   os.system("%s %s -c '%s' -p '%s' 2>/dev/null" % (obexftp_prog, obexftp_args,
-      dirname, filename
-   ))
-   os.rename(filename, real_filename) # by some reason MC wants the file back
-   cleanup_tmpdir()
+   try:
+      os.rename(real_filename, filename)
+      os.system("%s %s -c '%s' -p '%s' 2>/dev/null" % (obexftp_prog, obexftp_args,
+         dirname, filename
+      ))
+      os.rename(filename, real_filename) # by some reason MC wants the file back
+   finally:
+      cleanup_tmpdir()
 
 
 def mcobex_rm():
    """Remove a file from the VFS"""
-   obexftp_args = setup_transport()
    obex_filename = sys.argv[3]
    os.system("%s %s -k '%s' 2>/dev/null" % (obexftp_prog, obexftp_args, obex_filename))
 
 
 def mcobex_mkdir():
    """Create a directory in the VFS"""
-   obexftp_args = setup_transport()
    obex_dirname = sys.argv[3]
    os.system("%s %s -C '%s' 2>/dev/null" % (obexftp_prog, obexftp_args, obex_dirname))
 
@@ -255,6 +247,36 @@ command = sys.argv[1]
 procname = "mcobex_" + command
 
 if not g.has_key(procname):
-   error("Unknown command %s" % command)
+   logger.error("Unknown command %s", command)
+   sys.exit(1)
+
+
+def setup_transport():
+   """Setup transport parameters for the obexftp program"""
+   transport_file = open(sys.argv[2], 'r')
+   line = transport_file.readline()
+   transport_file.close()
+
+   parts = line.strip().split()
+   transport = parts[0].lower()
+
+   if transport == "bluetooth":
+      return ' '.join(["-b", parts[1], "-B", parts[2]])
+   elif transport == "tty":
+      return ' '.join(["-t", parts[1]])
+   elif transport == "irda":
+      return "-i"
+   else:
+      logger.error("Unknown transport '%s'; expected 'bluetooth', 'tty' or 'irda'", transport)
+      sys.exit(1)
+
+try:
+   obexftp_args = setup_transport()
+except:
+   logger.exception("Exception while parsing the transport file")
+   sys.exit(1)
 
-g[procname]()
+try:
+   g[procname]()
+except:
+   logger.exception("Exception during run")