#! /usr/local/bin/python -O
"""
-ObexFTP VFS for Midnight Commander. Manipulate a cell phone's filesystem using obexftp.
+ObexFTP Virtual FileSystem for Midnight Commander.
Author: Oleg BroytMann <phd@phd.pp.ru>.
Copyright (C) 2004 PhiloSoft Design.
License: GPL.
-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).
-
-Edit the full path to the obexftp binary (see below). Put the file to the
-/usr/[local/]lib/mc/extfs, and add a line "obexftp" to the
-/usr/[local/]lib/mc/extfs/extfs.ini. Then create somewhere a file called
-"irda", "bluetooth" or "tty" to connect to the device using IrDA, Bluetooth or
-TTY transport.
-
-For the "bluetooth" put there a line "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".
-Other lines in the file are ignored.
-
-Put a device name like /dev/rfcomm0 into the "tty" file.
+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 content for the "irda" file is ignored.
-
-Now run this "cd" command in the Midnight Commander (in the "bindings" files
-the command is "%cd"): cd bluetooth#obexftp. The VFS script use obexftp to try
-to connect to the device and list files and directories. Plese 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. Often obexftp fails to list a
-directory, and the script retries after a second or two timeouts, which don't
-make the scanning process faster. Midnight Commander caches the result.
+The script requires Midnight Commander 3.1+ (http://www.ibiblio.org/mc/),
+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 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".
+
+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" 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
+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__ = "0.1.0"
-__revision__ = "$Id: obexftp,v 1.2 2004/06/13 18:49:25 phd Exp $"
-__date__ = "$Date: 2004/06/13 18:49:25 $"[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"
# Change this to suite your needs
obexftp_prog = "/usr/local/obex/bin/obexftp"
+import logging
+log_level = logging.DEBUG
+
-import sys, os, time
+import sys, time
+import os, shutil
import xml.dom.minidom
+from tempfile import mkdtemp
-def log_error(msg):
- sys.stderr.write(msg + '\n')
-def error(msg):
- log_error(msg + '\n')
- 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("""\
-It is not a program - it is a VFS for Midnight Commander.
-Put it in /usr/lib/mc/extfs.""")
-
-
-def setup_transport():
- """Setup transport parameters for the obexftp program"""
- transport_filename = sys.argv[2]
- base_filename = os.path.basename(transport_filename)
-
- if base_filename == "bluetooth":
- transport_file = open(transport_filename, 'r')
- line = transport_file.readline().strip()
- transport_file.close()
- bdaddr, channel = line.split()
- return ' '.join(["-b", bdaddr, "-B", channel])
- elif base_filename == "tty":
- transport_file = open(transport_filename, 'r')
- device = transport_file.readline().strip()
- transport_file.close()
- return ' '.join(["-t", device])
- elif base_filename == "irda":
- return "-i"
- else:
- error("Unknown transport '%s'; expected 'bluetooth', 'tty' or 'irda'" % base_filename)
+ 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!""",
+ __version__, __author__, __copyright__
+)
+ sys.exit(1)
# Parse ObexFTP XML directory listings
class DirectoryEntry(object):
+ """Represent a remote file or a directory"""
+
def __init__(self, type):
self.type = type
self.size = 0
if type == "file":
self.perm = "-rw-rw-rw-"
elif type == "folder":
- self.perm = "drw-rw-rw-"
+ self.perm = "drwxrwxrwx"
else:
raise ValueError, "unknown type '%s'; expected 'file' or 'folder'" % self.type
)
raise ValueError, "unknown type '%s'; expected 'file' or 'folder'" % self.type
-def get_entries(dom, tag):
+def get_entries(dom, type):
entries = []
- for subtag in dom.getElementsByTagName(tag):
- entry = DirectoryEntry(tag)
- attrs = subtag.attributes
+ for obj in dom.getElementsByTagName(type):
+ entry = DirectoryEntry(type)
+ attrs = obj.attributes
for i in range(attrs.length):
attr = attrs.item(i)
setattr(entry, attr.name, attr.value)
return entries
-def _recursive_list(obexftp_args, directory):
+def recursive_list(directory='/'):
"""List the directory recursively"""
- debug = open("debug", 'a')
- for i in range(3):
- time.sleep(2*i)
- pipe = os.popen("%s %s -l '%s' 2>/dev/null" % (obexftp_prog, obexftp_args, directory), 'r')
- listing = pipe.read()
- pipe.close()
-
- if listing:
- break
-
- debug.write("Cannot list '%s', retrying...\n" % directory)
+ pipe = os.popen("%s %s -l '%s' 2>/dev/null" % (obexftp_prog, obexftp_args, directory), 'r')
+ listing = pipe.read()
+ pipe.close()
if not listing:
- debug.write("Cannot list '%s'\n" % directory)
- debug.close()
return
- debug.write("Got listing of '%s'\n" % directory)
-
- try:
- dom = xml.dom.minidom.parseString(listing)
- except:
- obex_xml = open("obex.xml", 'a')
- obex_xml.write(listing)
- obex_xml.close()
- raise
-
+ dom = xml.dom.minidom.parseString(listing)
directories = get_entries(dom, "folder")
files = get_entries(dom, "file")
fullpath = "%s/%s" % (directory, entry.name)
if fullpath.startswith('//'): fullpath = fullpath[1:]
print entry.perm, "1 user group", entry.size, entry.mtime, fullpath
- debug.close()
for entry in directories:
fullpath = "%s/%s" % (directory, entry.name)
if fullpath.startswith('//'): fullpath = fullpath[1:]
- _recursive_list(obexftp_args, fullpath)
+ time.sleep(1)
+ 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():
+ global tmpdir_name
+ tmpdir_name = mkdtemp(".tmp", "mcobex-")
+ os.chdir(tmpdir_name)
+
+def cleanup_tmpdir():
+ os.chdir(os.pardir)
+ shutil.rmtree(tmpdir_name)
def mcobex_copyout():
"""Get a file from the VFS"""
- obexftp_args = setup_transport()
- dummy_filename = sys.argv[3]
+ obex_filename = sys.argv[3]
real_filename = sys.argv[4]
- real_file = open(real_filename, 'w')
- real_file.write("Copied from %s\n" % dummy_filename)
- real_file.write("Copied to %s\n" % real_filename)
- real_file.close()
+ setup_tmpdir()
+ try:
+ 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()
- dummy_filename = sys.argv[3]
+ obex_filename = sys.argv[3]
real_filename = sys.argv[4]
+ dirname, filename = os.path.split(obex_filename)
- real_file = open(real_filename + "-dummy.tmp", 'w')
- real_file.write("Copied from %s\n" % real_filename)
- real_file.write("Copied to %s\n" % dummy_filename)
- real_file.close()
+ setup_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()
- dummy_filename = sys.argv[3]
-
- real_file = open(".dummy.tmp", 'a')
- real_file.write("Remove %s\n" % dummy_filename)
- real_file.close()
+ 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()
- dummy_dirname = sys.argv[3]
-
- real_file = open(".dummy.tmp", 'a')
- real_file.write("Create %s\n" % dummy_dirname)
- real_file.close()
+ obex_dirname = sys.argv[3]
+ os.system("%s %s -C '%s' 2>/dev/null" % (obexftp_prog, obexftp_args, obex_dirname))
-def mcobex_rmdir():
- """Remove a directory from the VFS"""
- obexftp_args = setup_transport()
- dummy_dirname = sys.argv[3]
-
- real_file = open(".dummy.tmp", 'a')
- real_file.write("Remove %s\n" % dummy_dirname)
- real_file.close()
+mcobex_rmdir = mcobex_rm
g = globals()
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:
- g[procname]()
+ obexftp_args = setup_transport()
except:
- import traceback
- error = open("error", 'a')
- traceback.print_exc(file=error)
- error.close()
+ logger.exception("Exception while parsing the transport file")
sys.exit(1)
+
+try:
+ g[procname]()
+except:
+ logger.exception("Exception during run")
projects / extfs.d.git / blobdiff