1
0
mirror of https://github.com/gryf/mc_adbfs.git synced 2026-03-27 13:53:35 +01:00

14 Commits
0.7 ... 0.10

Author SHA1 Message Date
1c6a6cfdf8 Added new option for selecting adb executable 2017-04-29 17:49:19 +02:00
7ce2dd2568 Fix for new version of adb command
Previously it was possible (most probably unintentionally) to perform
command which gives listing of directory contents on the output:

$ adb shell su -c toolbox ls /
acct
cache
charger
config
...

Using such syntax in newer versions of adb, return an error:

$ adb shell su -c toolbox ls /
Unknown id: ls

It is needed to quote argument passed to the 'shell' parameter on adb,
like:

$ adb shell 'su -c "toolbox ls /"'
acct
cache
charger
config
...

This patch fixes this issue for both adb versions.
2017-04-29 17:44:57 +02:00
11f980beb1 Minor code style fixes 2017-04-29 17:30:18 +02:00
bc742ccdf6 Merge remote-tracking branch 'github/master' 2017-03-06 17:12:58 +01:00
7a6a8a499b Added basic support for not rooted devices 2017-03-06 17:10:15 +01:00
b2163e0fba Update README.rst 2016-10-06 18:51:52 +02:00
57509eaac0 Added option for suppressing colors for ls command from busybox 2016-10-06 14:14:28 +02:00
210d7f2962 Added a functionality for accessing single directory 2016-09-20 20:40:14 +02:00
ae08a7329a Added ability to use config file 2016-09-18 19:22:50 +02:00
ebef125f38 Added rmmdir command 2016-09-14 18:50:49 +02:00
de5793c672 Fixed error handling, replacing manual commandline parsing with argparse 2016-06-04 18:02:33 +02:00
d1e8f42429 Removing quoting where it is unnecessary 2016-06-04 16:46:06 +02:00
89c783e9cd Added checking for root 2016-06-04 16:19:33 +02:00
7cb2a09282 Added support for toolbox 2016-06-04 16:16:51 +02:00
2 changed files with 431 additions and 133 deletions

View File

@@ -9,15 +9,19 @@ Rquirements
===========
* Python 2.7
* ``adb`` installed and in ``$PATH``
* ``adb`` installed and in ``$PATH`` or provided via the config file
* An Android device or emulator preferably rooted
* Busybox installed and available in the path on the device
Make sure, that issuing from command line::
Make sure, that issuing from command line:
.. code:: shell-session
$ adb shell busybox ls
$ # or in case of no PATH adb placement
$ /path/to/adb shell busybox ls
should display files from root directory on the device.
it should display files from root directory on the device.
Features
========
@@ -39,15 +43,49 @@ if needed.
Usage
=====
To use it, just issue::
To use it, just issue:
cd adbfs://
.. code:: shell-session
cd adbfs://
under MC - after some time you should see the files and directories on your
device. For convenience you can add a bookmark (accessible under CTRL+\) for
fast access. The time is depended on how many files and directories you have on
your device and how fast it is :)
Configuration
=============
You can configure behaviour of this plugin using ``.ini`` file located under
``$XDG_CONFIG_HOME/mc/adbfs.ini`` (which usually is located under
``~/.config/mc/adbfs.ini``), and have default values, like:
.. code:: ini
[adbfs]
debug = false
skip_dirs = true
dirs_to_skip = ["acct", "charger", "d", "dev", "proc", "sys"]
suppress_colors = false
root =
adb_command = adb
where:
* ``debug`` will provide a little bit more verbose information, useful for
debugging
* ``dirs_to_skip`` list of paths to directories which will be skipped during
reading. If leaved empty, or setted to empty list (``[]``) will read
everything (slow!)
* ``suppress_colors`` this option will make ``busybox`` not to display colors,
helpful, if ``busybox ls`` is configured to display colors by default. Does
not affect ``toolbox``.
* ``root`` root directory to read. Everything outside of that directory will be
omitted. That would be the fastest way to access certain location on the
device. Note, that ``dirs_to_skip`` still apply inside this directory.
* ``adb_command`` = path to ``adb`` command.
Limitations
===========
@@ -55,6 +93,8 @@ Limitations
files are on the device and so on
* Some filenames might be still inaccessible for operating
* All files operations which needs root privileges will fail (for now)
* The implementation is experimental and it's by now working with mine device;
while it might not work with yours
License
=======

514
adbfs
View File

@@ -2,38 +2,151 @@
"""
adbfs Virtual filesystem for Midnight Commander
* Copyright (c) 2015, Roman Dobosz,
* Copyright (c) 2016, Roman Dobosz,
* Published under 3-clause BSD-style license (see LICENSE file)
Version: 0.7
"""
import ConfigParser
import argparse
from datetime import datetime
import errno
import json
import os
import pipes
import re
import subprocess
import sys
__version__ = 0.10
DEBUG = os.getenv("ADBFS_DEBUG", False)
SKIP_SYSTEM_DIR = os.getenv("ADBFS_SKIP_SYSTEM_DIR", True)
XDG_CONFIG_HOME = os.getenv('XDG_CONFIG_HOME', os.path.expanduser('~/.config'))
class NoBoxFoundException(OSError):
"""
Exception raised in case of not found either toolbox or busybox on remote
filesystem accessed via adb
"""
pass
class Conf(object):
"""Simple config parser"""
boxes = {'busybox': {'ls': 'busybox ls -anel',
'rls': 'busybox ls -Ranel {}',
'file_re': r'^(?P<perms>[-bcdlps][-rwxsStT]{9})\s+'
r'(?P<links>\d+)\s'
r'(?P<uid>\d+)\s+'
r'(?P<gid>\d+)\s+'
r'(?P<size>\d+)\s[A-Z,a-z]{3}\s'
r'(?P<date_time>[A-Z,a-z]{3}\s+'
r'\d+\s\d{2}:\d{2}:\d{2}\s+\d{4})\s'
r'(?P<name>.*)'},
'toolbox': {'ls': 'toolbox ls -anl',
'rls': 'toolbox ls -Ranl {}',
'file_re': r'^(?P<perms>[-bcdlps][-rwxsStT]{9})\s+'
r'(?P<uid>\d+)\s+'
r'(?P<gid>\d+)\s+'
r'(?P<size>\d+)?\s'
r'(?P<date>\d{4}-\d{2}-\d{2}\s'
r'\d{2}:\d{2})\s'
r'(?P<name>.*)'}}
def __init__(self):
self.box = None
self.debug = False
self.dirs_to_skip = ['acct', 'charger', 'd', 'dev', 'proc', 'sys']
self.root = None
self.suppress_colors = False
self.adb_command = 'adb'
self.read()
self.get_the_box()
def get_the_box(self):
"""Detect if we dealing with busybox or toolbox"""
cmd = [self.adb_command] + 'shell which'.split()
try:
with open(os.devnull, 'w') as fnull:
result = subprocess.check_output(cmd + ['busybox'],
stderr=fnull)
if 'busybox' in result:
self.box = Conf.boxes['busybox']
if self.suppress_colors:
self.box.update({'ls': 'busybox ls --color=none -anel',
'rls': 'busybox ls --color=none '
'-Ranel {}'})
Adb.file_re = re.compile(self.box['file_re'])
return
except subprocess.CalledProcessError:
pass
try:
with open(os.devnull, 'w') as fnull:
result = subprocess.check_output(cmd + ['toolbox'],
stderr=fnull)
if 'toolbox' in result:
self.box = Conf.boxes['toolbox']
Adb.file_re = re.compile(self.box['file_re'])
return
except subprocess.CalledProcessError:
pass
raise NoBoxFoundException(errno.ENOENT,
'There is no toolbox or busybox available')
def read(self):
"""
Read config file and change the options according to values from that
file.
"""
if not os.path.exists(XDG_CONFIG_HOME):
return
conf_fname = os.path.join(XDG_CONFIG_HOME, 'mc', 'adbfs.ini')
if not os.path.exists(conf_fname):
return
cfg = ConfigParser.SafeConfigParser()
cfg_map = {'debug': (cfg.getboolean, 'debug'),
'dirs_to_skip': (cfg.get, 'dirs_to_skip'),
'suppress_colors': (cfg.get, 'suppress_colors'),
'root': (cfg.get, 'root'),
'adb_command': (cfg.get, 'adb')}
cfg.read(conf_fname)
for key, (function, attr) in cfg_map.items():
try:
setattr(self, attr, function('adbfs', key))
except (ConfigParser.NoSectionError, ConfigParser.NoOptionError):
pass
if self.dirs_to_skip and isinstance(self.dirs_to_skip, str):
self.dirs_to_skip = json.loads(self.dirs_to_skip, encoding='ascii')
self.dirs_to_skip = [x.encode('utf-8') for x in self.dirs_to_skip]
else:
self.dirs_to_skip = []
if self.adb_command:
self.adb_command = os.path.expandvars(self.adb_command)
self.adb_command = os.path.expanduser(self.adb_command)
class File(object):
"""Item in filesystem representation"""
def __init__(self, perms=None, links=1, uid=0, gid=0, size=0,
date_time=None, name=None):
def __init__(self, perms=None, links=1, uid=0, gid=0, size=None,
date_time=None, date=None, name=None):
"""initialize file"""
self.perms = perms
self.links = links
self.uid = uid
self.gid = gid
self.size = size
self.size = size if size else 0
self.date_time = date_time # as string
self.name = name
self.date = date # as string
self.dirname = ""
self.dirname = ''
self.type = None
self.string = None
self.link_target = None
@@ -42,12 +155,16 @@ class File(object):
def _correct_link(self):
"""Canonize filename and fill the link attr"""
try:
name, target = self.name.split(" -> ")
name, target = self.name.split(' -> ')
except ValueError:
return
self.name = name
if target.startswith("/"):
if not self.size:
self.size = 0
if target.startswith('/'):
self.link_target = target
else:
self.link_target = os.path.abspath(os.path.join(self.dirname,
@@ -55,60 +172,62 @@ class File(object):
def update(self, dirname):
"""update object fields"""
month_num = {"Jan": 1,
"Feb": 2,
"Mar": 3,
"Apr": 4,
"May": 5,
"Jun": 6,
"Jul": 7,
"Aug": 8,
"Sep": 9,
"Oct": 10,
"Nov": 11,
"Dec": 12}
month_num = {'Jan': 1,
'Feb': 2,
'Mar': 3,
'Apr': 4,
'May': 5,
'Jun': 6,
'Jul': 7,
'Aug': 8,
'Sep': 9,
'Oct': 10,
'Nov': 11,
'Dec': 12}
self.dirname = dirname
date = self.date_time.split()
date = "%s-%02d-%s %s" % (date[1],
month_num[date[0]],
date[3],
date[2])
date = datetime.strptime(date, "%d-%m-%Y %H:%M:%S")
self.date_time = date.strftime("%m/%d/%Y %H:%M:01")
if self.date_time:
date = self.date_time.split()
date = '%s-%02d-%s %s' % (date[1],
month_num[date[0]],
date[3],
date[2])
date = datetime.strptime(date, '%d-%m-%Y %H:%M:%S')
elif self.date:
date = datetime.strptime(self.date, '%Y-%m-%d %H:%M')
self.date_time = date.strftime('%m/%d/%Y %H:%M:01')
self.type = self.perms[0] if self.perms else None
if self.type == "l" and " -> " in self.name:
if self.type == 'l' and ' -> ' in self.name:
self._correct_link()
self.filepath = os.path.join(self.dirname, self.name)
def mk_link_relative(self, target_type):
def mk_link_relative(self):
"""Convert links to relative"""
rel_path = self.dirname
# if target_type == "d":
# rel_path = self.filepath
self.link_target = os.path.relpath(self.link_target, rel_path)
self.link_target = os.path.relpath(self.link_target, self.dirname)
def __repr__(self):
"""represent the file/entire node"""
fullname = os.path.join(self.dirname, self.name)
if self.link_target:
fullname += " -> " + self.link_target
return "<File {type} {name} {id}>".format(type=self.type,
fullname += ' -> ' + self.link_target
return '<File {type} {name} {id}>'.format(type=self.type,
name=fullname,
id=hex(id(self)))
def __str__(self):
"""display the file/entire node"""
template = ("{perms} {links:>4} {uid:<8} {gid:<8} {size:>8} "
"{date_time} {fullname}\n")
template = ('{perms} {links:>4} {uid:<8} {gid:<8} {size:>8} '
'{date_time} {fullname}\n')
if not self.name:
return ""
return ''
fullname = os.path.join(self.dirname, self.name)
if self.link_target:
fullname += " -> " + self.link_target
fullname += ' -> ' + self.link_target
return template.format(perms=self.perms,
links=self.links,
@@ -121,25 +240,32 @@ class File(object):
class Adb(object):
"""Class for interact with android rooted device through adb"""
dirs_to_skip = ["acct", "charger", "d", "dev", "proc", "sys"]
file_re = re.compile(r'^(?P<perms>[-bcdlps][-rwxsStT]{9})\s+'
r'(?P<links>\d+)\s'
r'(?P<uid>\d+)\s+'
r'(?P<gid>\d+)\s+'
r'(?P<size>\d+)\s[A-Z,a-z]{3}\s'
r'(?P<date_time>[A-Z,a-z]{3}\s+'
r'\d+\s\d{2}:\d{2}:\d{2}\s+\d{4})\s'
r'(?P<name>.*)')
current_re = re.compile(r"^(\./)?(?P<dir>.+):$")
as_root = os.getenv("ADBFS_AS_ROOT", False)
verbose = os.getenv("ADBFS_VERBOSE", False)
file_re = None
current_re = re.compile(r'^(\./)?(?P<dir>.+):$')
def __init__(self):
"""Prepare archive content for operations"""
super(Adb, self).__init__()
self.conf = Conf()
self.error = ''
self._entries = []
self._links = {}
self._got_root = False
self.__su_check()
def __su_check(self):
"""Check if we are able to get elevated privileges"""
cmd = [self.conf.adb_command] + 'shell su -c whoami'.split()
try:
with open(os.devnull, 'w') as fnull:
result = subprocess.check_output(cmd, stderr=fnull)
except subprocess.CalledProcessError:
return
if 'root' in result:
self._got_root = True
def _find_target(self, needle):
"""Find link target"""
@@ -153,6 +279,7 @@ class Adb(object):
for entry in self._entries:
if entry.filepath == needle:
return entry
return None
def _normalize_links(self):
@@ -170,38 +297,99 @@ class Adb(object):
target_entry = self._find_target(entry.link_target)
if target_entry:
entry.link_target = target_entry.filepath
entry.mk_link_relative(target_entry.type)
entry.mk_link_relative()
else:
elems_to_remove.append(self._entries.index(entry))
for idx in sorted(elems_to_remove, reverse=True):
del self._entries[idx]
def _retrieve_single_dir_list(self, dir_):
"""Retrieve file list using adb"""
lscmd = self.conf.box['rls'].format(dir_)
if self._got_root:
lscmd = 'su -c "{}"'.format(lscmd)
command = [self.conf.adb_command, 'shell', lscmd]
try:
if self.conf.debug:
print 'executing', ' '.join(command)
lines = subprocess.check_output(command)
except subprocess.CalledProcessError:
sys.stderr.write('Cannot read directory. Is device connected?\n')
return 1
lines = [l.strip() for l in lines.split('\n') if l.strip()]
if len(lines) == 1:
reg_match = self.file_re.match(lines[0])
entry = File(**reg_match.groupdict())
entry.update('/')
if entry.filepath in self.conf.dirs_to_skip:
return
self._entries.append(entry)
if entry.type == 'l':
self._links[entry.filepath] = entry
self._retrieve_single_dir_list(entry.link_target)
else:
for line in lines:
current_dir_re = self.current_re.match(line)
if current_dir_re:
current_dir = current_dir_re.groupdict()['dir']
if not current_dir:
current_dir = '/'
continue
reg_match = self.file_re.match(line)
if not reg_match:
continue
entry = File(**reg_match.groupdict())
if entry.name in ('.', '..'):
continue
entry.update(current_dir)
if entry.filepath in self.conf.dirs_to_skip:
continue
self._entries.append(entry)
if entry.type == 'l':
self._links[entry.filepath] = entry
def _retrieve_file_list(self, root=None):
"""Retrieve file list using adb"""
# if root:
# print "retrieve for %s" % root.filepath
command = ["adb", "shell", "su", "-c"]
if not root:
command.append("'busybox ls -anel'")
lscmd = self.conf.box['ls']
else:
command.append("'busybox ls -Ranel {}'".format(root.filepath))
lscmd = self.conf.box['rls'].format(root.filepath)
if self._got_root:
lscmd = 'su -c "{}"'.format(lscmd)
command = [self.conf.adb_command, 'shell', lscmd]
try:
if self.conf.debug:
print 'executing', ' '.join(command)
lines = subprocess.check_output(command)
except subprocess.CalledProcessError:
sys.stderr.write("Cannot read directory. Is device connected?\n")
sys.stderr.write('Cannot read directory. Is device connected?\n')
return 1
current_dir = root.dirname if root else "/"
for line in lines.split("\n"):
current_dir = root.dirname if root else '/'
for line in lines.split('\n'):
line = line.strip()
current_dir_re = self.current_re.match(line)
if current_dir_re:
current_dir = current_dir_re.groupdict()["dir"]
current_dir = current_dir_re.groupdict()['dir']
if not current_dir:
current_dir = "/"
current_dir = '/'
continue
reg_match = self.file_re.match(line)
@@ -209,85 +397,139 @@ class Adb(object):
continue
entry = File(**reg_match.groupdict())
if entry.name in (".", ".."):
continue
if SKIP_SYSTEM_DIR and entry.name in Adb.dirs_to_skip:
if entry.name in ('.', '..'):
continue
entry.update(current_dir)
if entry.filepath in self.conf.dirs_to_skip:
continue
self._entries.append(entry)
if root is None and entry.type == "d":
if root is None and entry.type == 'd':
self._retrieve_file_list(entry)
if entry.type == "l":
if entry.type == 'l':
self._links[entry.filepath] = entry
def run(self, fname):
"""Not supported"""
sys.stderr.write("Not supported - or maybe you are on compatible "
"architecture?\n")
sys.stderr.write('Not supported - or maybe you are on compatible '
'architecture?\n')
return 1
def list(self):
"""Output list contents directory"""
self._retrieve_file_list()
# self._retrieve_file_list_from_pickle()
# self._save_file_list_to_pickle()
if self.error:
sys.stderr.write(self.error)
return 1
if self.conf.root:
self._retrieve_single_dir_list(self.conf.root)
else:
self._retrieve_file_list()
self._normalize_links()
sys.stdout.write("".join([str(entry) for entry in self._entries]))
sys.stdout.write(''.join([str(entry) for entry in self._entries]))
return 0
def copyout(self, src, dst):
"""Copy file form the device using adb."""
with open(os.devnull, "w") as fnull:
return subprocess.call(["adb", "pull", pipes.quote(src),
pipes.quote(dst)],
stdout=fnull, stderr=fnull)
if self.error:
sys.stderr.write(self.error)
return 1
cmd = [self.conf.adb_command, 'pull', src, dst]
if self.conf.debug:
sys.stderr.write(' '.join(cmd) + '\n')
with open(os.devnull, 'w') as fnull:
try:
err = subprocess.call(cmd, stdout=fnull, stderr=fnull)
except subprocess.CalledProcessError:
sys.stderr.write('Error executing adb shell')
return 1
return err
def copyin(self, src, dst):
"""Copy file to the device through adb."""
if not dst.startswith("/"):
dst = "/" + dst
if self.error:
sys.stderr.write(self.error)
return 1
if not dst.startswith('/'):
dst = '/' + dst
with open(os.devnull, "w") as fnull:
err = subprocess.call(["adb", "push", pipes.quote(src),
pipes.quote(dst)],
stdout=fnull, stderr=fnull)
cmd = [self.conf.adb_command, 'push', src, dst]
if self.conf.debug:
sys.stderr.write(' '.join(cmd) + '\n')
with open(os.devnull, 'w') as fnull:
try:
err = subprocess.call(cmd, stdout=fnull, stderr=fnull)
except subprocess.CalledProcessError:
sys.stderr.write('Error executing adb shell')
return 1
if err != 0:
sys.stderr.write("Cannot push the file, "
"%s, error %d" % (dst, err))
sys.stderr.write('Cannot push the file, '
'%s, error %d' % (dst, err))
return 1
return 0
def rm(self, dst):
"""Remove file from device."""
cmd = ["adb", "shell", "rm", pipes.quote(dst)]
err = subprocess.check_output(cmd)
if self.error:
sys.stderr.write(self.error)
return 1
if err != "":
cmd = [self.conf.adb_command, 'shell', 'rm', dst]
try:
err = subprocess.check_output(cmd)
except subprocess.CalledProcessError:
sys.stderr.write('Error executing adb shell')
return 1
if err != '':
sys.stderr.write(err)
return 1
return 0
def rmdir(self, dst):
"""Remove directory from device."""
cmd = ["adb", "shell", "rm", "-r", pipes.quote(dst)]
err = subprocess.check_output(cmd)
if self.error:
sys.stderr.write(self.error)
return 1
if err != "":
cmd = [self.conf.adb_command, 'shell', 'rm', '-r', dst]
try:
err = subprocess.check_output(cmd)
except subprocess.CalledProcessError:
sys.stderr.write('Error executing adb shell')
return 1
if err != '':
sys.stderr.write(err)
return 1
return 0
def mkdir(self, dst):
"""Make directory on the device through adb."""
cmd = ["adb", "shell", "mkdir", pipes.quote(dst)]
err = subprocess.check_output(cmd)
if self.error:
sys.stderr.write(self.error)
return 1
if err != "":
if not dst.startswith('/'):
dst = '/' + dst
cmd = [self.conf.adb_command, 'shell', 'mkdir', dst]
try:
err = subprocess.check_output(cmd)
except subprocess.CalledProcessError:
sys.stderr.write('Error executing adb shell')
return 1
if err != '':
sys.stderr.write(err)
return 1
return 0
@@ -301,39 +543,55 @@ CALL_MAP = {'list': lambda a: Adb().list(),
'rm': lambda a: Adb().rm(a.dst),
'run': lambda a: Adb().run(a.dst)}
def main():
"""parse commandline"""
try:
if DEBUG:
sys.stderr.write("commandline: %s\n" % " ".join(sys.argv))
if sys.argv[1] not in ('list', 'copyin', 'copyout', 'rm', "rmdir",
'mkdir', "run"):
sys.exit(2)
except IndexError:
sys.exit(2)
parser = argparse.ArgumentParser()
subparsers = parser.add_subparsers(help='supported commands')
parser_list = subparsers.add_parser('list')
parser_copyin = subparsers.add_parser('copyin')
parser_copyout = subparsers.add_parser('copyout')
parser_rm = subparsers.add_parser('rm')
parser_mkdir = subparsers.add_parser('mkdir')
parser_rmdir = subparsers.add_parser('rmdir')
parser_run = subparsers.add_parser('run')
class Arg(object):
"""Mimic argparse/optparse object"""
dst = None
src = None
arch = None
parser_list.add_argument('arch')
parser_list.set_defaults(func=CALL_MAP['list'])
arg = Arg()
parser_copyin.add_argument('arch')
parser_copyin.add_argument('dst')
parser_copyin.add_argument('src')
parser_copyin.set_defaults(func=CALL_MAP['copyin'])
try:
arg.arch = sys.argv[2]
if sys.argv[1] == 'copyin':
arg.src = sys.argv[4]
arg.dst = sys.argv[3]
if sys.argv[1] == 'copyout':
arg.src = sys.argv[3]
arg.dst = sys.argv[4]
elif sys.argv[1] in ('rm', 'rmdir', 'run', 'mkdir'):
arg.dst = sys.argv[3]
except IndexError:
sys.exit(2)
parser_copyout.add_argument('arch')
parser_copyout.add_argument('src')
parser_copyout.add_argument('dst')
parser_copyout.set_defaults(func=CALL_MAP['copyout'])
return CALL_MAP[sys.argv[1]](arg)
parser_rm.add_argument('arch')
parser_rm.add_argument('dst')
parser_rm.set_defaults(func=CALL_MAP['rm'])
if __name__ == "__main__":
parser_mkdir.add_argument('arch')
parser_mkdir.add_argument('dst')
parser_mkdir.set_defaults(func=CALL_MAP['mkdir'])
parser_rmdir.add_argument('arch')
parser_rmdir.add_argument('dst')
parser_rmdir.set_defaults(func=CALL_MAP['rmdir'])
parser_run.add_argument('arch')
parser_run.add_argument('dst')
parser_run.set_defaults(func=CALL_MAP['run'])
parser.add_argument('--version', action='version',
version='%(prog)s ' + str(__version__))
args = parser.parse_args()
return args.func(args)
if __name__ == '__main__':
sys.exit(main())