3 # Python conterpart of rsync written by Vivian De Smedt
4 # Send any comment or bug report to vivian@vdesmedt.com.
5 # I would like to thanks William Tan for its support in tuning rsync.py to support unicode path.
6 # I would like to thanks Luc Saffre for its bug reports and fixes.
8 #from __future__ import nested_scopes
10 import os, os.path, shutil, glob, re, sys, getopt, stat, string
31 self.delete_excluded = 0
32 self.delete_from_source = 0
34 self.modify_window = 2
37 self.case_sensitivity = 0
39 self.case_sensitivity = re.I
41 def visit(cookie, dirname, names):
42 """Copy files names from sink_root + (dirname - sink_root) to target_root + (dirname - sink_root)"""
43 if os.path.split(cookie.sink_root)[1]: # Should be tested with (C:\Cvs -> C:\)! (C:\Archives\MyDatas\UltraEdit -> C:\Archives\MyDatas) (Cvs -> "")! (Archives\MyDatas\UltraEdit -> Archives\MyDatas) (\Cvs -> \)! (\Archives\MyDatas\UltraEdit -> Archives\MyDatas)
44 dirname = dirname[len(cookie.sink_root) + 1:]
46 dirname = dirname[len(cookie.sink_root):]
47 target_dir = os.path.join(cookie.target_root, dirname)
48 if not os.path.isdir(target_dir):
49 makeDir(cookie, target_dir)
50 sink_dir = os.path.join(cookie.sink_root, dirname)
54 ignore = os.path.join(sink_dir, ".cvsignore")
55 if os.path.isfile(ignore):
56 filters = convertPatterns(ignore, "-")
57 filters = filters + cookie.filters
61 # filter sink files (names):
63 while name_index < len(names):
64 name = names[name_index]
65 path = os.path.join(dirname, name)
66 path = convertPath(path)
67 if os.path.isdir(os.path.join(sink_dir, name)):
69 for filter in filters:
70 if re.search(filter[1], path, cookie.case_sensitivity):
72 sink = os.path.join(sink_dir, name)
73 if cookie.delete_from_source:
74 if os.path.isfile(sink):
75 removeFile(cookie, sink)
76 elif os.path.isdir(sink):
77 removeDir(cookie, sink)
79 logError("Sink %s is neither a file nor a folder (skip removal)" % sink)
80 names_excluded += [names[name_index]]
81 del(names[name_index])
82 name_index = name_index - 1
84 elif filter[0] == '+':
86 name_index = name_index + 1
88 if cookie.delete and os.path.isdir(target_dir):
89 # Delete files and folder in target not present in filtered sink.
90 for name in os.listdir(target_dir):
91 if not cookie.delete_excluded and name in names_excluded:
94 target = os.path.join(target_dir, name)
95 if os.path.isfile(target):
96 removeFile(cookie, target)
97 elif os.path.isdir(target):
98 removeDir(cookie, target)
103 # Copy files and folder from sink to target.
104 sink = os.path.join(sink_dir, name)
106 target = os.path.join(target_dir, name)
107 if os.path.exists(target):
108 # When target already exit:
109 if os.path.isfile(sink):
110 if os.path.isfile(target):
112 if shouldUpdate(cookie, sink, target):
113 updateFile(cookie, sink, target)
114 elif os.path.isdir(target):
116 removeDir(cookie, target)
117 copyFile(cookie, sink, target)
120 logError("Target %s is neither a file nor folder (skip update)" % sink)
122 elif os.path.isdir(sink):
123 if os.path.isfile(target):
125 removeFile(cookie, target)
126 makeDir(cookie, target)
129 logError("Sink %s is neither a file nor a folder (skip update)" % sink)
131 elif not cookie.existing:
132 # When target dont exist:
133 if os.path.isfile(sink):
135 copyFile(cookie, sink, target)
136 elif os.path.isdir(sink):
138 makeDir(cookie, target)
140 logError("Sink %s is neither a file nor a folder (skip update)" % sink)
143 def log(cookie, message):
147 except UnicodeEncodeError:
148 print message.encode("utf8")
151 def logError(message):
153 sys.stderr.write(message + "\n")
154 except UnicodeEncodeError:
155 sys.stderr.write(message.encode("utf8") + "\n")
158 def shouldUpdate(cookie, sink, target):
160 sink_st = os.stat(sink)
161 sink_sz = sink_st.st_size
162 sink_mt = sink_st.st_mtime
164 logError("Fail to retrieve information about sink %s (skip update)" % sink)
168 target_st = os.stat(target)
169 target_sz = target_st.st_size
170 target_mt = target_st.st_mtime
172 logError("Fail to retrieve information about target %s (skip update)" % target)
176 return target_mt < sink_mt - cookie.modify_window
178 if cookie.ignore_time:
181 if target_sz != sink_sz:
187 return abs(target_mt - sink_mt) > cookie.modify_window
190 def copyFile(cookie, sink, target):
191 log(cookie, "copy: %s to: %s" % (sink, target))
192 if not cookie.dry_run:
194 shutil.copyfile(sink, target)
196 logError("Fail to copy %s" % sink)
201 os.utime(target, (s.st_atime, s.st_mtime));
203 logError("Fail to copy timestamp of %s" % sink)
206 def updateFile(cookie, sink, target):
207 log(cookie, "update: %s to: %s" % (sink, target))
208 if not cookie.dry_run:
209 # Read only and hidden and system files can not be overridden.
213 filemode = win32file.GetFileAttributesW(target)
214 win32file.SetFileAttributesW(target, filemode & ~win32file.FILE_ATTRIBUTE_READONLY & ~win32file.FILE_ATTRIBUTE_HIDDEN & ~win32file.FILE_ATTRIBUTE_SYSTEM)
216 os.chmod(target, stat.S_IWUSR)
218 #logError("Fail to allow override of %s" % target)
221 shutil.copyfile(sink, target)
225 os.utime(target, (s.st_atime, s.st_mtime));
227 logError("Fail to copy timestamp of %s" % sink) # The utime api of the 2.3 version of python is not unicode compliant.
229 logError("Fail to override %s" % sink)
232 win32file.SetFileAttributesW(target, filemode)
235 def prepareRemoveFile(path):
237 filemode = win32file.GetFileAttributesW(path)
238 win32file.SetFileAttributesW(path, filemode & ~win32file.FILE_ATTRIBUTE_READONLY & ~win32file.FILE_ATTRIBUTE_HIDDEN & ~win32file.FILE_ATTRIBUTE_SYSTEM)
240 os.chmod(path, stat.S_IWUSR)
243 def removeFile(cookie, target):
244 # Read only files could not be deleted.
245 log(cookie, "remove: %s" % target)
246 if not cookie.dry_run:
249 prepareRemoveFile(target)
251 #logError("Fail to allow removal of %s" % target)
256 logError("Fail to remove %s" % target)
260 def makeDir(cookie, target):
261 log(cookie, "make dir: %s" % target)
262 if not cookie.dry_run:
266 logError("Fail to make dir %s" % target)
269 def visitForPrepareRemoveDir(arg, dirname, names):
271 path = os.path.join(dirname, name)
272 prepareRemoveFile(path)
275 def prepareRemoveDir(path):
276 prepareRemoveFile(path)
277 os.path.walk(path, visitForPrepareRemoveDir, None)
280 def OnRemoveDirError(func, path, excinfo):
281 logError("Fail to remove %s" % path)
284 def removeDir(cookie, target):
285 # Read only directory could not be deleted.
286 log(cookie, "remove dir: %s" % target)
287 if not cookie.dry_run:
288 prepareRemoveDir(target)
290 shutil.rmtree(target, False, OnRemoveDirError)
292 logError("Fail to remove dir %s" % target)
295 def convertPath(path):
296 # Convert windows, mac path to unix version.
297 separator = os.path.normpath("/")
299 path = re.sub(re.escape(separator), "/", path)
301 # Help file, folder pattern to express that it should match the all file or folder name.
306 def convertPattern(pattern, sign):
307 """Convert a rsync pattern that match against a path to a filter that match against a converted path."""
309 # Check for include vs exclude patterns.
310 if pattern[:2] == "+ ":
311 pattern = pattern[2:]
313 elif pattern[:2] == "- ":
314 pattern = pattern[2:]
317 # Express windows, mac patterns in unix patterns (rsync.py extension).
318 separator = os.path.normpath("/")
320 pattern = re.sub(re.escape(separator), "/", pattern)
322 # If pattern contains '/' it should match from the start.
324 if pattern[0] == "/":
325 pattern = pattern[1:]
329 # Convert pattern rules: ** * ? to regexp rules.
330 pattern = re.escape(pattern)
331 pattern = string.replace(pattern, "\\?", ".")
332 pattern = string.replace(pattern, "\\*\\*", ".*")
333 pattern = string.replace(pattern, "\\*", "[^/]*")
334 pattern = string.replace(pattern, "\\*", ".*")
337 # If pattern contains '/' it should match from the start.
338 pattern = "^\\/" + pattern
340 # Else the pattern should match the all file or folder name.
341 pattern = "\\/" + pattern
343 if pattern[-2:] != "\\/" and pattern[-2:] != ".*":
344 # File patterns should match also folders.
345 pattern = pattern + "\\/?"
347 # Pattern should match till the end.
348 pattern = pattern + "$"
349 return (sign, pattern)
352 def convertPatterns(path, sign):
353 """Read the files for pattern and return a vector of filters"""
357 pattern = f.readline()
360 if pattern[-1] == "\n":
361 pattern = pattern[:-1]
363 if re.match("[\t ]*$", pattern):
365 if pattern[0] == "#":
367 filters = filters + [convertPattern(pattern, sign)]
373 """Print the help string that should printed by rsync.py -h"""
374 print "usage: rsync.py [options] source target"
376 -q, --quiet decrease verbosity
377 -r, --recursive recurse into directories
378 -R, --relative use relative path names
379 -u, --update update only (don't overwrite newer files)
380 -t, --times preserve times
381 -n, --dry-run show what would have been transferred
382 --existing only update files that already exist
383 --delete delete files that don't exist on the sending side
384 --delete-excluded also delete excluded files on the receiving side
385 --delete-from-source delete excluded files on the receiving side
386 -I, --ignore-times don't exclude files that match length and time
387 --size-only only use file size when determining if a file should
389 --modify-window=NUM timestamp window (seconds) for file match (default=2)
390 --existing only update existing target files or folders
391 -C, --cvs-exclude auto ignore files in the same way CVS does
392 --exclude=PATTERN exclude files matching PATTERN
393 --exclude-from=FILE exclude patterns listed in FILE
394 --include=PATTERN don't exclude files matching PATTERN
395 --include-from=FILE don't exclude patterns listed in FILE
396 --version print version number
397 -h, --help show this help screen
399 See http://www.vdesmedt.com/~vds2212/rsync.html for informations and updates.
400 Send an email to vivian@vdesmedt.com for comments and bug reports."""
404 print "rsync.py version 2.0.1"
410 opts, args = getopt.getopt(args, "qrRntuCIh", ["quiet", "recursive", "relative", "dry-run", "time", "update", "cvs-ignore", "ignore-times", "help", "delete", "delete-excluded", "delete-from-source", "existing", "size-only", "modify-window=", "exclude=", "exclude-from=", "include=", "include-from=", "version"])
412 if o in ["-q", "--quiet"]:
414 if o in ["-r", "--recursive"]:
416 if o in ["-R", "--relative"]:
418 elif o in ["-n", "--dry-run"]:
420 elif o in ["-t", "--times", "--time"]: # --time is there to guaranty backward compatibility with previous buggy version.
422 elif o in ["-u", "--update"]:
424 elif o in ["-C", "--cvs-ignore"]:
425 cookie.cvs_ignore = 1
426 elif o in ["-I", "--ignore-time"]:
427 cookie.ignore_time = 1
428 elif o == "--delete":
430 elif o == "--delete-excluded":
432 cookie.delete_excluded = 1
433 elif o == "--delete-from-source":
434 cookie.delete_from_source = 1
435 elif o == "--size-only":
437 elif o == "--modify-window":
438 cookie.modify_window = int(v)
439 elif o == "--existing":
441 elif o == "--exclude":
442 cookie.filters = cookie.filters + [convertPattern(v, "-")]
443 elif o == "--exclude-from":
444 cookie.filters = cookie.filters + convertPatterns(v, "-")
445 elif o == "--include":
446 cookie.filters = cookie.filters + [convertPattern(v, "+")]
447 elif o == "--include-from":
448 cookie.filters = cookie.filters + convertPatterns(v, "+")
449 elif o == "--version":
452 elif o in ["-h", "--help"]:
460 #print cookie.filters
462 target_root = args[1]
463 try: # In order to allow compatibility below 2.3.
465 if os.path.__dict__.has_key("supports_unicode_filenames") and os.path.supports_unicode_filenames:
466 target_root = unicode(target_root, sys.getfilesystemencoding())
468 cookie.target_root = target_root
470 sinks = glob.glob(args[0])
476 try: # In order to allow compatibility below 2.3.
477 if os.path.__dict__.has_key("supports_unicode_filenames") and os.path.supports_unicode_filenames:
478 sink = unicode(sink, sys.getfilesystemencoding())
483 sink_drive, sink_root = os.path.splitdrive(sink)
485 if sink_root == os.path.sep:
488 sink_root, sink_name = os.path.split(sink_root)
489 sink_root = sink_drive + sink_root
490 if not sink_families.has_key(sink_root):
491 sink_families[sink_root] = []
492 sink_families[sink_root] = sink_families[sink_root] + [sink_name]
494 for sink_root in sink_families.keys():
496 cookie.sink_root = ""
498 cookie.sink_root = sink_root
500 global y # In order to allow compatibility below 2.1 (nested scope where used before).
502 files = filter(lambda x: os.path.isfile(os.path.join(y, x)), sink_families[sink_root])
504 visit(cookie, sink_root, files)
506 #global y # In order to allow compatibility below 2.1 (nested scope where used before).
508 folders = filter(lambda x: os.path.isdir(os.path.join(y, x)), sink_families[sink_root])
509 for folder in folders:
510 folder_path = os.path.join(sink_root, folder)
511 if not cookie.recursive:
512 visit(cookie, folder_path, os.listdir(folder_path))
514 os.path.walk(folder_path, visit, cookie)
517 if __name__ == "__main__":
518 sys.exit(main(sys.argv[1:]))