379 lines
15 KiB
Python
Executable File
379 lines
15 KiB
Python
Executable File
#!/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.INFO,
|
|
format='%(message)s')
|
|
###
|
|
import sys
|
|
import os,os.path
|
|
from optparse import OptionParser #To be replaced by argparse ASAP
|
|
import cPickle as pickle
|
|
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
|
|
const_PRESERVE = set(['mode','ownership','timestamps'])
|
|
|
|
|
|
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,
|
|
in_signature='ss', out_signature='bs')
|
|
def addArgs(self, source_path, args):
|
|
"""Add arguments to gcp as if there were entered on its own command line
|
|
@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")
|
|
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
|
|
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()
|
|
self.files_left = 0
|
|
self.bytes_total = 0
|
|
self.bytes_copied = 0
|
|
|
|
def getFsType(self, path):
|
|
fs=''
|
|
for mount in self.mounts:
|
|
if path.startswith(mount) and len(self.mounts[mount])>=len(fs):
|
|
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
|
|
#(check freedesktop mounting signals)
|
|
ret = {}
|
|
try:
|
|
with open("/proc/mounts",'rb') 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):
|
|
"""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))
|
|
try:
|
|
self.bytes_total+=os.path.getsize(path)
|
|
self.files_left+=1
|
|
self.copy_list.insert(0,(path, dest_path, options))
|
|
except OSError,e:
|
|
error("Can't copy %(path)s: %(exception)s" % {'path':path, 'exception':e.strerror})
|
|
|
|
|
|
def __appendDirToList(self, dirpath, dest_path, options):
|
|
"""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
|
|
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)
|
|
else:
|
|
self.__appendToList(filepath, dest_path, options)
|
|
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"""
|
|
assert(len (args)>=2)
|
|
try:
|
|
dest_path = os.path.normpath(os.path.join(os.path.expanduser(source_path), args.pop()))
|
|
except OSError,e:
|
|
error ("Invalid dest_path: %s",e)
|
|
|
|
for path in args:
|
|
abspath = os.path.normpath(os.path.join(os.path.expanduser(source_path), path))
|
|
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))
|
|
if not options.recursive:
|
|
warning ('omitting directory "%s"' % abspath)
|
|
else:
|
|
self.__appendDirToList(abspath, full_dest_path, options)
|
|
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_file, dest_path, options = self.copy_list.pop()
|
|
source_fd = open(source_file, 'rb')
|
|
filename = os.path.basename(source_file)
|
|
assert(filename)
|
|
dest_file = os.path.join(dest_path,filename)
|
|
if os.path.exists(dest_file) and not options.force:
|
|
warning ("File [%s] already exists, skipping it !" % dest_file)
|
|
return True
|
|
dest_fd = open(dest_file, 'wb')
|
|
|
|
gobject.io_add_watch(source_fd,gobject.IO_IN,self._copyFile,
|
|
(dest_fd, options), priority=gobject.PRIORITY_HIGH)
|
|
if not self.progress:
|
|
info("COPYING %(source)s ==> %(dest)s" % {"source":source_path,"dest":dest_file})
|
|
return True
|
|
else:
|
|
#Nothing left to copy, we quit
|
|
if self.progress:
|
|
self.__pbar_finish()
|
|
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.bytes_copied += len(buff)
|
|
if self.progress:
|
|
self.__pbar_update()
|
|
|
|
if len(buff) != self.buffer_size:
|
|
source_fd.close()
|
|
dest_fd.close()
|
|
self.__post_copy(source_fd.name, dest_fd.name, options)
|
|
self.files_left -= 1
|
|
assert (self.files_left >= 0)
|
|
return False
|
|
return True
|
|
|
|
def __post_copy(self, source_file, dest_file, options):
|
|
"""Do post copy traitement (mainly managing --preserve option)"""
|
|
st_mode, st_ino, st_dev, st_nlink, st_uid, st_gid, st_size, st_atime, st_mtime, st_ctime = os.stat(source_file)
|
|
#TODO: complete log in case of errors
|
|
for preserve in options.preserve:
|
|
try:
|
|
if preserve == 'mode':
|
|
os.chmod(dest_file, st_mode)
|
|
elif preserve == 'ownership':
|
|
os.chown(dest_file, st_uid, st_gid)
|
|
elif preserve == 'timestamps':
|
|
os.utime(dest_file, (st_atime, st_mtime))
|
|
except OSError,e:
|
|
pass #TODO: complete log here
|
|
|
|
def __pbar_update(self):
|
|
"""Update progress bar position, create the bar if it doesn't exist"""
|
|
assert(self.progress)
|
|
try:
|
|
if self.pbar.maxval != self.bytes_total:
|
|
self.pbar.maxval = self.bytes_total
|
|
except AttributeError:
|
|
self.pbar = ProgressBar(self.bytes_total,["Progress: ",Percentage()," ",Bar()," ",FileTransferSpeed()," ",ETA()])
|
|
self.pbar.start()
|
|
self.pbar.update(self.bytes_copied)
|
|
|
|
def __pbar_finish(self):
|
|
"""Mark the progression as finished"""
|
|
assert(self.progress)
|
|
try:
|
|
self.pbar.finish()
|
|
except AttributeError:
|
|
pass
|
|
|
|
def parseArguments(self, full_args=sys.argv[1:], source_path = os.getcwd()):
|
|
"""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"""
|
|
_usage="""
|
|
%prog [options] FILE1 [FILE2 ...] DEST
|
|
|
|
%prog --help for options list
|
|
"""
|
|
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')
|
|
|
|
parser = OptionParser(usage=_usage,version=ABOUT)
|
|
|
|
parser.add_option("-r", "--recursive", action="store_true", default=False,
|
|
help="copy directories recursively")
|
|
|
|
parser.add_option("-f", "--force", action="store_true", default=False,
|
|
help="force overwriting of existing files")
|
|
|
|
parser.add_option("--preserve", action="store", default='mode,ownership,timestamps',
|
|
help="preserve the specified attributes")
|
|
|
|
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")
|
|
|
|
parser.add_option("-v", "--verbose", action="store_true", default=False,
|
|
help="Show what is currently done")
|
|
|
|
(options, args) = parser.parse_args(full_args)
|
|
#options check
|
|
if options.progress and not pbar_available:
|
|
warning ("Progress bar is not available, deactivating")
|
|
options.progress = self.progress = False
|
|
else:
|
|
self.progress = options.progress
|
|
|
|
if options.verbose:
|
|
logging.getLogger().setLevel(logging.DEBUG)
|
|
|
|
preserve = set(options.preserve.split(','))
|
|
if not preserve.issubset(const_PRESERVE):
|
|
error ('Invalide --preserve value\nvalid values are:')
|
|
for value in const_PRESERVE:
|
|
error('- %s' % value)
|
|
exit(2)
|
|
else:
|
|
options.preserve = preserve
|
|
|
|
#if there is an other instance of gcp, we send options to it
|
|
if not self._main_instance:
|
|
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))
|
|
else:
|
|
if len(args) < 2:
|
|
_error_msg = "Wrong number of arguments"
|
|
return (False, _error_msg)
|
|
debug("adding args to gcp: %s",args)
|
|
self.__checkArgs(options, source_path, args)
|
|
gobject.idle_add(self.__copyNextFile)
|
|
return (True,'')
|
|
|
|
def go(self):
|
|
"""Launch main loop"""
|
|
self.loop = gobject.MainLoop()
|
|
try:
|
|
self.loop.run()
|
|
except KeyboardInterrupt:
|
|
info("User interruption: good bye")
|
|
|
|
|
|
if __name__ == "__main__":
|
|
gcp = GCP()
|
|
success,message = gcp.parseArguments()
|
|
if not success:
|
|
error(message)
|
|
exit(1)
|
|
if gcp._main_instance:
|
|
gcp.go()
|
|
|