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
from stdhome import the
25
from stdhome import util
28
class CopyBaseWalker( Walker ):
29
"""The copy-base walker traverses a walklist ruthlessly mirroring src to dst.
30
It is designed to be the base class of both the copy-in and copy-out walker,
31
both of which are specialisations of this purpose. See them for more
32
information. The print_op method, derived in those classes, takes, in
33
addition to the relative filename, a source file type, an operation, and a
34
sestination file type. Valid file types are f (file), l (symlink), d
35
(directory) and _ (non-existant). Valid operations are * (modify), = (skip:
36
same), @ (skip: symlink substitute) and # (skip: ignored).
41
self.check_src_symlinks = False
42
self.check_dst_symlinks = False
43
self.check_dst_ignores = False
46
def process( self, rel_file, src, dst ):
49
if self.check_dst_ignores and the.config.ignores.matches( rel_file ):
50
self.print_op( rel_file, src.type, '#', dst.type )
53
# src entity is directory
56
# if dst entity doesn't exist, create directory (no need to recurse,
57
# since we're copying the whole directory)
59
self.print_op( rel_file, 'd', '*', '_' )
60
shutil.copytree( src.file, dst.file, True )
62
# if dst entity is a directory, copy permissions, as required (and
65
if os.stat( src.file ).st_mode != os.stat( dst.file ).st_mode:
66
self.print_op( rel_file, 'd', '*', 'd' )
67
shutil.copystat( src.file, dst.file )
69
self.print_op( rel_file, 'd', '=', 'd' )
72
# if dst entity is a symlink to a directory, and this is an
73
# acceptable substitute, just recurse
74
elif self.check_dst_symlinks and dst.link_type == 'd' and \
75
the.config.symlinks.matches( rel_file ):
76
self.print_op( rel_file, 'd', '@', 'd' )
79
# if dst entity is a file or symlink in home dir, replace it with
80
# directory (no need to recurse, since we're copying the whole
82
elif dst.type == 'f' or dst.type == 'l':
83
self.print_op( rel_file, 'd', '*', dst.type )
85
shutil.copytree( src.file, dst.file, True )
88
raise NotImplementedError()
93
# if dst entity doesn't exist, copy file
95
self.print_op( rel_file, 'f', '*', '_' )
96
shutil.copy( src.file, dst.file )
97
shutil.copystat( src.file, dst.file )
99
# if dst entity is a file, replace it only if it differs
100
elif dst.type == 'f':
101
if not filecmp.cmp( src.file, dst.file ):
102
self.print_op( rel_file, 'f', '*', 'f' )
103
os.unlink( dst.file )
104
shutil.copy( src.file, dst.file )
105
shutil.copystat( src.file, dst.file )
107
self.print_op( rel_file, 'f', '=', 'f' )
109
# if dst entity is a directory, replace it with file
110
elif dst.type == 'd':
111
self.print_op( rel_file, 'f', '*', 'd' )
112
shutil.rmtree( dst.file )
113
shutil.copy( src.file, dst.file )
114
shutil.copystat( src.file, dst.file )
116
# if dst entity is a symlink, replace it with file
117
elif dst.type == 'l':
118
self.print_op( rel_file, 'f', '*', 'l' )
119
os.unlink( dst.file )
120
shutil.copy( src.file, dst.file )
121
shutil.copystat( src.file, dst.file )
124
raise NotImplementedError()
126
# src entity is a symlink
127
elif src.type == 'l':
129
# if dst entity doesn't exist, copy symlink
131
self.print_op( rel_file, 'l', '*', '_' )
132
os.symlink( os.readlink( src.file ), dst.file )
134
# if dst entity is a symlink, replace it only if it differs
135
elif dst.type == 'l':
136
if os.readlink( src.file ) != os.readlink( dst.file ):
137
self.print_op( rel_file, 'l', '*', 'l' )
138
os.unlink( dst.file )
139
os.symlink( os.readlink( src.file ), dst.file )
141
self.print_op( rel_file, 'l', '=', 'l' )
143
# if dst entity is a file, replace it with symlink
144
elif dst.type == 'f':
145
self.print_op( rel_file, 'l', '*', 'f' )
146
os.unlink( dst.file )
147
os.symlink( os.readlink( src.file ), dst.file )
149
# if dst entity is a directory...
150
elif dst.type == 'd':
152
# if src entity is a symlink to a directory, and this is an
153
# acceptable substitute, just recurse
154
if self.check_src_symlinks and src.link_type == 'd' and \
155
the.config.symlinks.matches( rel_file ):
156
self.print_op( rel_file, 'd', '@', 'd' )
159
# else replace it with a symlink
160
self.print_op( rel_file, 'l', '*', 'd' )
161
shutil.rmtree( dst.file )
162
os.symlink( os.readlink( src.file ), dst.file )
165
raise NotImplementedError()
167
# src entity is missing
168
elif src.type == '_':
170
# if dst entity doesn't exist, we're good
174
# if dst entity is a file or symlink, delete it
175
elif dst.type == 'f' or dst.type == 'l':
176
self.print_op( rel_file, '_', '*', dst.type )
177
os.unlink( dst.file )
179
# if dst entity is a directory, delete it
180
elif dst.type == 'd':
181
self.print_op( rel_file, '_', '*', 'd' )
182
shutil.rmtree( dst.file )
185
raise NotImplementedError()
187
# if we got here, we don't want to recurse...