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
 
 
37
        def process( self, rel_file, src, dst ):
 
 
39
                # src entity is directory
 
 
42
                        # if dst entity doesn't exist, create directory (no need to recurse,
 
 
43
                        # since we're copying the whole directory)
 
 
45
                                if the.verbose >= 2: self.print_op( rel_file, 'd>_' )
 
 
46
                                shutil.copytree( src.file, dst.file, True )
 
 
48
                        # if dst entity is a directory, copy permissions, as required (and
 
 
51
                                # TODO: should check permission and only do as necessary
 
 
52
                                if the.verbose >= 2: self.print_op( rel_file, 'd>d' )
 
 
53
                                shutil.copystat( src.file, dst.file )
 
 
56
                        # if dst entity is a symlink to a directory, and this is an
 
 
57
                        # acceptable substitute, just recurse
 
 
58
                        elif dst.link_type == 'd' and \
 
 
59
                                        self.accept_list and self.accept_list.match( rel_file ):
 
 
60
                                if the.verbose >= 2: self.print_op( rel_file, 'd@d' )
 
 
63
                        # if dst entity is a file or symlink in home dir, replace it with
 
 
64
                        # directory (no need to recurse, since we're copying the whole
 
 
66
                        elif dst.type == 'f' or dst.type == 'l':
 
 
67
                                if the.verbose >= 2: self.print_op( rel_file, 'd>' + dst.type )
 
 
69
                                shutil.copytree( src.file, dst.file, True )
 
 
72
                                raise NotImplementedError()
 
 
77
                        # if dst entity doesn't exist, copy file
 
 
79
                                if the.verbose >= 2: self.print_op( rel_file, 'f>_' )
 
 
80
                                shutil.copy( src.file, dst.file )
 
 
81
                                shutil.copystat( src.file, dst.file )
 
 
83
                        # if dst entity is a file, replace it only if it differs
 
 
85
                                if not filecmp.cmp( src.file, dst.file ):
 
 
86
                                        if the.verbose >= 2: self.print_op( rel_file, 'f>f' )
 
 
88
                                        shutil.copy( src.file, dst.file )
 
 
89
                                        shutil.copystat( src.file, dst.file )
 
 
91
                                        if the.verbose >= 2: self.print_op( rel_file, 'f=f' )
 
 
93
                        # if dst entity is a directory, replace it with file
 
 
95
                                if the.verbose >= 2: self.print_op( rel_file, 'f>d' )
 
 
96
                                shutil.rmtree( dst.file )
 
 
97
                                shutil.copy( src.file, dst.file )
 
 
98
                                shutil.copystat( src.file, dst.file )
 
 
100
                        # if dst entity is a symlink, replace it with file
 
 
101
                        elif dst.type == 'l':
 
 
102
                                if the.verbose >= 2: self.print_op( rel_file, 'f>l' )
 
 
103
                                os.unlink( dst.file )
 
 
104
                                shutil.copy( src.file, dst.file )
 
 
105
                                shutil.copystat( src.file, dst.file )
 
 
108
                                raise NotImplementedError()
 
 
110
                # src entity is a symlink
 
 
111
                elif src.type == 'l':
 
 
113
                        # if dst entity doesn't exist, copy symlink
 
 
115
                                if the.verbose >= 2: self.print_op( rel_file, 'l>_' )
 
 
116
                                os.symlink( os.readlink( src.file ), dst.file )
 
 
118
                        # if dst entity is a symlink, replace it only if it differs
 
 
119
                        elif dst.type == 'l':
 
 
120
                                if os.readlink( src.file ) != os.readlink( dst.file ):
 
 
121
                                        if the.verbose >= 2: self.print_op( rel_file, 'l>l' )
 
 
122
                                        os.unlink( dst.file )
 
 
123
                                        os.symlink( os.readlink( src.file ), dst.file )
 
 
125
                                        if the.verbose >= 2: self.print_op( rel_file, 'l=l' )
 
 
127
                        # if dst entity is a file, replace it with symlink
 
 
128
                        elif dst.type == 'f':
 
 
129
                                if the.verbose >= 2: self.print_op( rel_file, 'l>f' )
 
 
130
                                os.unlink( dst.file )
 
 
131
                                os.symlink( os.readlink( src.file ), dst.file )
 
 
133
                        # if dst entity is a directory, and src entity is a symlink to a
 
 
134
                        # directory, and this is an acceptable substitute, just recurse
 
 
135
                        elif dst.type == 'd' and src.link_type == 'd' and \
 
 
136
                                        self.accept_list and self.accept_list.match( rel_file ):
 
 
137
                                if the.verbose >= 2: self.print_op( rel_file, 'd@d' )
 
 
140
                        # if dst entity is a directory, replace it with symlink
 
 
141
                        elif dst.type == 'd':
 
 
142
                                if the.verbose >= 2: self.print_op( rel_file, 'l>d' )
 
 
143
                                shutil.rmtree( dst.file )
 
 
144
                                os.symlink( os.readlink( src.file ), dst.file )
 
 
147
                                raise NotImplementedError()
 
 
149
                # src entity is missing
 
 
150
                elif src.type == '_':
 
 
152
                        # if dst entity doesn't exist, we're good
 
 
156
                        # if dst entity is a file or symlink, delete it
 
 
157
                        elif dst.type == 'f' or dst.type == 'l':
 
 
158
                                if the.verbose >= 2: self.print_op( rel_file, '_>' + dst.type )
 
 
159
                                os.unlink( dst.file )
 
 
161
                        # if dst entity is a directory, delete it
 
 
162
                        elif dst.type == 'd':
 
 
163
                                if the.verbose >= 2: self.print_op( rel_file, '_>d' )
 
 
164
                                shutil.rmtree( dst.file )
 
 
167
                                raise NotImplementedError()
 
 
169
                # if we got here, we don't want to recurse...