3
# Copyright (C) 2013 to 2014 Tim Marston <tim@edm.am>
5
# This file is part of stdhome (hereafter referred to as "this program").
6
# See http://ed.am/dev/stdhome for more information.
8
# This program is free software: you can redistribute it and/or modify
9
# it under the terms of the GNU General Public License as published by
10
# the Free Software Foundation, either version 3 of the License, or
11
# (at your option) any later version.
13
# This program is distributed in the hope that it will be useful,
14
# but WITHOUT ANY WARRANTY; without even the implied warranty of
15
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16
# GNU General Public License for more details.
18
# You should have received a copy of the GNU General Public License
19
# along with this program. If not, see <http://www.gnu.org/licenses/>.
22
import filecmp, os, shutil
23
from walker import Walker
24
import stdhome.the as the
27
class CopyBaseWalker( Walker ):
28
"""The copy-base walker traverses a walklist ruthlessly mirroring src to dst.
29
It is designed to be the base class of both the copy-in and copy-out walker,
30
both of which are specialisations of this purpose. See them for more
31
information. The print_op method, derived in those classes, takes, in
32
addition to the relative filename, a source file type, an operation, and a
33
sestination file type. Valid file types are f (file), l (symlink), d
34
(directory) and _ (non-existant). Valid operations are * (modify), = (skip:
35
same), @ (skip: symlink substitute) and # (skip: ignored).
40
self.check_src_symlinks = False
41
self.check_dst_symlinks = False
42
self.check_dst_ignores = False
45
def process( self, rel_file, src, dst ):
48
if self.check_dst_ignores and the.config.ignores.matches( rel_file ):
49
self.print_op( rel_file, src.type, '#', dst.type )
52
# src entity is directory
55
# if dst entity doesn't exist, create directory (no need to recurse,
56
# since we're copying the whole directory)
58
self.print_op( rel_file, 'd', '*', '_' )
59
shutil.copytree( src.file, dst.file, True )
61
# if dst entity is a directory, copy permissions, as required (and
64
# TODO: should check permission and only do as necessary
65
self.print_op( rel_file, 'd', '*', 'd' )
66
shutil.copystat( src.file, dst.file )
69
# if dst entity is a symlink to a directory, and this is an
70
# acceptable substitute, just recurse
71
elif self.check_dst_symlinks and dst.link_type == 'd' and \
72
the.config.symlinks.matches( rel_file ):
73
self.print_op( rel_file, 'd', '@', 'd' )
76
# if dst entity is a file or symlink in home dir, replace it with
77
# directory (no need to recurse, since we're copying the whole
79
elif dst.type == 'f' or dst.type == 'l':
80
self.print_op( rel_file, 'd', '*', dst.type )
82
shutil.copytree( src.file, dst.file, True )
85
raise NotImplementedError()
90
# if dst entity doesn't exist, copy file
92
self.print_op( rel_file, 'f', '*', '_' )
93
shutil.copy( src.file, dst.file )
94
shutil.copystat( src.file, dst.file )
96
# if dst entity is a file, replace it only if it differs
98
if not filecmp.cmp( src.file, dst.file ):
99
self.print_op( rel_file, 'f', '*', 'f' )
100
os.unlink( dst.file )
101
shutil.copy( src.file, dst.file )
102
shutil.copystat( src.file, dst.file )
104
self.print_op( rel_file, 'f', '=', 'f' )
106
# if dst entity is a directory, replace it with file
107
elif dst.type == 'd':
108
self.print_op( rel_file, 'f', '*', 'd' )
109
shutil.rmtree( dst.file )
110
shutil.copy( src.file, dst.file )
111
shutil.copystat( src.file, dst.file )
113
# if dst entity is a symlink, replace it with file
114
elif dst.type == 'l':
115
self.print_op( rel_file, 'f', '*', 'l' )
116
os.unlink( dst.file )
117
shutil.copy( src.file, dst.file )
118
shutil.copystat( src.file, dst.file )
121
raise NotImplementedError()
123
# src entity is a symlink
124
elif src.type == 'l':
126
# if dst entity doesn't exist, copy symlink
128
self.print_op( rel_file, 'l', '*', '_' )
129
os.symlink( os.readlink( src.file ), dst.file )
131
# if dst entity is a symlink, replace it only if it differs
132
elif dst.type == 'l':
133
if os.readlink( src.file ) != os.readlink( dst.file ):
134
self.print_op( rel_file, 'l', '*', 'l' )
135
os.unlink( dst.file )
136
os.symlink( os.readlink( src.file ), dst.file )
138
self.print_op( rel_file, 'l', '=', 'l' )
140
# if dst entity is a file, replace it with symlink
141
elif dst.type == 'f':
142
self.print_op( rel_file, 'l', '*', 'f' )
143
os.unlink( dst.file )
144
os.symlink( os.readlink( src.file ), dst.file )
146
# if dst entity is a directory...
147
elif dst.type == 'd':
149
# if src entity is a symlink to a directory, and this is an
150
# acceptable substitute, just recurse
151
if self.check_src_symlinks and src.link_type == 'd' and \
152
the.config.symlinks.matches( rel_file ):
153
self.print_op( rel_file, 'd', '@', 'd' )
156
# else replace it with a symlink
157
self.print_op( rel_file, 'l', '*', 'd' )
158
shutil.rmtree( dst.file )
159
os.symlink( os.readlink( src.file ), dst.file )
162
raise NotImplementedError()
164
# src entity is missing
165
elif src.type == '_':
167
# if dst entity doesn't exist, we're good
171
# if dst entity is a file or symlink, delete it
172
elif dst.type == 'f' or dst.type == 'l':
173
self.print_op( rel_file, '_', '*', dst.type )
174
os.unlink( dst.file )
176
# if dst entity is a directory, delete it
177
elif dst.type == 'd':
178
self.print_op( rel_file, '_', '*', 'd' )
179
shutil.rmtree( dst.file )
182
raise NotImplementedError()
184
# if we got here, we don't want to recurse...
added
removed
lib/stdhome/walker/copy_base.py
