gcp/gcp

314 lines
12 KiB
Plaintext
Raw Normal View History

2010-08-25 10:11:34 +02:00
#!/usr/bin/python
# -*- coding: utf-8 -*-
"""
gcp: Goffi's CoPier
Copyright (C) 2010 Jérôme Poisson (goffi@goffi.org)
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
"""
### logging ###
import logging
from logging import debug, info, error, warning
logging.basicConfig(level=logging.DEBUG,
format='%(message)s')
###
import sys
import os,os.path
from optparse import OptionParser #To be replaced by argparse ASAP
2010-08-30 14:15:26 +02:00
import cPickle as pickle
2010-08-25 10:11:34 +02:00
try:
import gobject
#DBus
import dbus, dbus.glib
import dbus.service
import dbus.mainloop.glib
except ImportError,e:
error("Error during import")
error("Please check dependecies:",e)
exit(2)
try:
from progressbar import ProgressBar, Percentage, Bar, ETA, FileTransferSpeed
pbar_available=True
except ImportError, e:
info ('ProgressBar not available, please download it at http://pypi.python.org/pypi/progressbar')
info ('Progress bar deactivated\n--\n')
pbar_available=False
NAME = "gcp (Goffi's copier)"
NAME_SHORT = "gcp"
VERSION = '0.1'
ABOUT = NAME+" v"+VERSION+""" (c) Jérôme Poisson (aka Goffi) 2010
---
"""+NAME+""" Copyright (C) 2010 Jérôme Poisson
This program comes with ABSOLUTELY NO WARRANTY;
This is free software, and you are welcome to redistribute it
under certain conditions.
---
This software is an advanced file copier
Get the latest version at http://www.goffi.org
"""
const_DBUS_INTERFACE = "org.goffi.gcp"
const_DBUS_PATH = "/org/goffi/gcp"
const_BUFF_SIZE = 4096
2010-08-25 10:11:34 +02:00
class DbusObject(dbus.service.Object):
def __init__(self, gcp, bus, path):
self._gcp = gcp
dbus.service.Object.__init__(self, bus, path)
debug("Init DbusObject...")
self.cb={}
@dbus.service.method(const_DBUS_INTERFACE,
in_signature='', out_signature='s')
def getVersion(self):
"""Get gcp version
@return: version as string"""
return VERSION
@dbus.service.method(const_DBUS_INTERFACE,
2010-08-30 14:15:26 +02:00
in_signature='ss', out_signature='bs')
2010-08-25 10:11:34 +02:00
def addArgs(self, source_path, args):
"""Add arguments to gcp as if there were entered on its own command line
2010-08-30 14:15:26 +02:00
@param source_path: current working dir to use as base for arguments, as given by os.getcwd()
@param args: serialized (wich pickle) list of strings - without command name -, as given by sys.argv[1:].
@return: success (boolean) and error message if any (string)"""
try:
args = pickle.loads(str(args))
except TypeError, pickle.UnpicklingError:
return (False, "INTERNAL ERROR: invalid arguments")
2010-08-25 10:11:34 +02:00
return self._gcp.parseArguments(args, source_path)
class GCP():
def __init__(self):
try:
sessions_bus = dbus.SessionBus()
db_object = sessions_bus.get_object(const_DBUS_INTERFACE,
const_DBUS_PATH)
self.gcp_main = dbus.Interface(db_object,
dbus_interface=const_DBUS_INTERFACE)
self._main_instance = False
except dbus.exceptions.DBusException,e:
if e._dbus_error_name=='org.freedesktop.DBus.Error.ServiceUnknown':
self.launchDbusMainInstance()
debug ("gcp launched")
self._main_instance = True
self.buffer_size = const_BUFF_SIZE
2010-08-25 10:11:34 +02:00
else:
raise e
def launchDbusMainInstance(self):
debug ("Init DBus...")
session_bus = dbus.SessionBus()
self.dbus_name = dbus.service.BusName(const_DBUS_INTERFACE, session_bus)
self.dbus_object = DbusObject(self, session_bus, const_DBUS_PATH)
self.copy_list = []
self.mounts = self.__getMountPoints()
2010-08-30 14:15:26 +02:00
self.files_left = 0
self.bytes_left = 0
2010-08-25 10:11:34 +02:00
def getFsType(self, path):
fs=''
for mount in self.mounts:
2010-09-21 07:47:44 +02:00
if path.startswith(mount) and len(self.mounts[mount])>=len(fs):
2010-08-25 10:11:34 +02:00
fs = self.mounts[mount]
return fs
def __getMountPoints(self):
"""Parse /proc/mounts to get currently mounted devices"""
#TODO: reparse when a new device is added/a device is removed
2010-08-30 14:15:26 +02:00
#(check freedesktop mounting signals)
2010-08-25 10:11:34 +02:00
ret = {}
try:
with open("/proc/mounts",'r') as mounts:
for line in mounts.readlines():
fs_spec, fs_file, fs_vfstype, fs_mntops, fs_freq, fs_passno = line.split(' ')
ret[fs_file] = fs_vfstype
except:
error ("Can't read mounts table")
return ret
def __appendToList(self, path, dest_path, options):
2010-08-25 10:11:34 +02:00
"""Add a file to the copy list
@param path: absolute path of file
@param options: options as return by optparse"""
debug ("Adding to copy list: %s ==> %s (%s)", path, dest_path, self.getFsType(dest_path))
2010-08-30 14:15:26 +02:00
try:
self.bytes_left+=os.path.getsize(path)
self.files_left+=1
self.copy_list.append((path, dest_path, options))
2010-08-30 14:15:26 +02:00
print "total size:", float(self.bytes_left/1024/1024), "Mb (%i)" % self.files_left
except OSError,e:
error("Can't copy %(path)s: %(exception)s" % {'path':path, 'exception':e.strerror})
2010-08-25 10:11:34 +02:00
2010-08-30 14:15:26 +02:00
def __appendDirToList(self, dirpath, dest_path, options):
2010-08-25 10:11:34 +02:00
"""Add recursively directory to the copy list
@param path: absolute path of dir
@param options: options as return by optparse"""
#We first check that the dest path exists, and create it if needed
if not os.path.exists(dest_path):
debug ("Creating directory %s" % dest_path)
os.makedirs(dest_path) #TODO: check permissions
#TODO: check that dest_path is an accessible dir,
# and skip file/write error in log if needed
2010-08-25 10:11:34 +02:00
try:
for filename in os.listdir(dirpath):
filepath = os.path.join(dirpath,filename)
if os.path.isdir(filepath):
full_dest_path = os.path.join(dest_path,filename)
self.__appendDirToList(filepath, full_dest_path, options)
2010-08-25 10:11:34 +02:00
else:
self.__appendToList(filepath, dest_path, options)
2010-08-25 10:11:34 +02:00
except OSError,e:
error("Can't copy %(path)s: %(exception)s" % {'path':dirpath, 'exception':e.strerror})
def __checkArgs(self, options, source_path, args):
"""Check thats args are files, and add them to copy list"""
2010-08-30 14:15:26 +02:00
assert(len (args)>=2)
try:
dest_path = os.path.normpath(os.path.join(os.path.expanduser(source_path), args.pop()))
2010-08-30 14:15:26 +02:00
except OSError,e:
error ("Invalid dest_path: %s",e)
2010-08-30 14:15:26 +02:00
2010-08-25 10:11:34 +02:00
for path in args:
2010-08-30 14:15:26 +02:00
abspath = os.path.normpath(os.path.join(os.path.expanduser(source_path), path))
2010-08-25 10:11:34 +02:00
if not os.path.exists(abspath):
warning("The path given in arg doesn't exist or is not accessible: %s",abspath)
else:
if os.path.isdir(abspath):
full_dest_path = dest_path if os.path.isabs(path) else os.path.normpath(os.path.join(dest_path, path))
2010-08-25 10:11:34 +02:00
if not options.recursive:
warning ('omitting directory "%s"' % abspath)
else:
self.__appendDirToList(abspath, full_dest_path, options)
2010-08-25 10:11:34 +02:00
else:
self.__appendToList(abspath, dest_path, options)
def __copyNextFile(self):
"""Take the last file in the list, and launch the copy using glib io_watch event
@return: True a file was added, False else"""
if self.copy_list:
source_path, dest_path, options = self.copy_list.pop()
source_fd = open(source_path, 'r')
filename = os.path.basename(source_path)
assert(filename)
dest_file = os.path.join(dest_path,filename)
if os.path.exists(dest_file):
warning ("File [%s] already exists, skipping it !" % dest_file)
return True
dest_fd = open(dest_file, 'w')
self.total=0
gobject.io_add_watch(source_fd,gobject.IO_IN,self._copyFile,(dest_fd,options), priority=gobject.PRIORITY_HIGH)
print "** COPYING",source_path,"==>",dest_file
return True
else:
#Nothing left to copy, we quit
self.loop.quit()
def _copyFile(self, source_fd, condition, data):
"""Actually copy the file, callback used with io_add_watch
@param source_fd: file descriptor of the file to copy
@param condition: condition which launched the callback (glib.IO_IN)
@param data: tuple with (destination file descriptor, copying options)"""
dest_fd,options = data
buff = source_fd.read(self.buffer_size)
dest_fd.write(buff)
self.total += len(buff)
sys.stdout.write('%i written\r' % self.total)
if len(buff) != self.buffer_size:
sys.stdout.write('\n---\n')
source_fd.close()
dest_fd.close()
return False
return True
2010-08-25 10:11:34 +02:00
2010-08-25 10:11:34 +02:00
def parseArguments(self, full_args=sys.argv[1:], source_path = os.getcwd()):
2010-08-30 14:15:26 +02:00
"""Parse arguments and add files to queue
@param full_args: list of arguments strings (without program name)
@param source_path: path from where the arguments come, ad given by os.getcwd()
@return: a tuple (boolean, message) where the boolean is the success of the arguments
validation, and message is the error message to print when necessary"""
2010-08-25 10:11:34 +02:00
_usage="""
%prog [options] FILE1 [FILE2 ...] DEST
%prog --help for options list
"""
2010-08-30 14:15:26 +02:00
for idx in range(len(full_args)):
if isinstance(full_args[idx], unicode):
#We don't want unicode as some filenames can be invalid unicode
full_args[idx] = full_args[idx].encode('utf-8')
2010-08-25 10:11:34 +02:00
parser = OptionParser(usage=_usage,version=ABOUT)
parser.add_option("-r", "--recursive", action="store_true", default=False,
help="copy directories recursively")
2010-08-30 14:15:26 +02:00
parser.add_option("--no-unicode-fix", action="store_true", default=False,
help="don't fixe name encoding errors") #TODO
parser.add_option("--no-progress", action="store_false", dest="progress", default=True,
help="deactivate progress bar")
2010-08-25 10:11:34 +02:00
(options, args) = parser.parse_args(full_args)
if options.progress and not pbar_available:
warning ("Progress bar is not available, deactivating")
options.progress = False
2010-08-25 10:11:34 +02:00
if not self._main_instance:
2010-08-30 14:15:26 +02:00
info ("There is already one instance of %s running, pluging to it" % NAME_SHORT)
#XXX: we have to serialize data as dbus only accept valid unicode, and filenames
# can have invalid unicode.
return self.gcp_main.addArgs(os.getcwd(),pickle.dumps(full_args))
2010-08-25 10:11:34 +02:00
else:
2010-08-30 14:15:26 +02:00
if len(args) < 2:
_error_msg = "Wrong number of arguments"
return (False, _error_msg)
2010-08-25 10:11:34 +02:00
debug("adding args to gcp: %s",args)
self.__checkArgs(options, source_path, args)
gobject.idle_add(self.__copyNextFile)
2010-08-30 14:15:26 +02:00
return (True,'')
2010-08-25 10:11:34 +02:00
def go(self):
2010-08-30 14:15:26 +02:00
"""Launch main loop"""
2010-08-25 10:11:34 +02:00
self.loop = gobject.MainLoop()
try:
self.loop.run()
except KeyboardInterrupt:
info("User interruption: good bye")
if __name__ == "__main__":
gcp = GCP()
2010-08-30 14:15:26 +02:00
success,message = gcp.parseArguments()
if not success:
error(message)
exit(1)
2010-08-25 10:11:34 +02:00
if gcp._main_instance:
gcp.go()