/stdhome

To get this branch, use:
bzr branch http://bzr.ed.am/stdhome

« back to all changes in this revision

Viewing changes to lib/stdhome/walker/copy_base.py

  • Committer: Tim Marston
  • Date: 2014-04-18 14:52:41 UTC
  • Revision ID: tim@ed.am-20140418145241-gldwc2ey6d2gjv96
defaulted Walker.generate_walk_list() to act on the.repo.full_dir

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# copy_base.py
 
2
#
 
3
# Copyright (C) 2013 to 2014 Tim Marston <tim@edm.am>
 
4
#
 
5
# This file is part of stdhome (hereafter referred to as "this program").
 
6
# See http://ed.am/dev/stdhome for more information.
 
7
#
 
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.
 
12
#
 
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.
 
17
#
 
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/>.
 
20
 
 
21
 
 
22
import filecmp, os, shutil
 
23
from walker import Walker
 
24
import stdhome.the as the
 
25
 
 
26
 
 
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.
 
32
        """
 
33
 
 
34
 
 
35
        def __init__( self ):
 
36
                self.check_src_symlinks = False
 
37
                self.check_dst_symlinks = False
 
38
                self.check_dst_ignores = False
 
39
 
 
40
 
 
41
        def process( self, rel_file, src, dst ):
 
42
 
 
43
                # ignore?
 
44
                if self.check_dst_ignores and the.config.ignores.matches( rel_file ):
 
45
                        if the.verbose >= 2:
 
46
                                self.print_op( rel_file, '%s#%s' % ( src.type, dst.type ) )
 
47
                        return True
 
48
 
 
49
                # src entity is directory
 
50
                if src.type == 'd':
 
51
 
 
52
                        # if dst entity doesn't exist, create directory (no need to recurse,
 
53
                        # since we're copying the whole directory)
 
54
                        if dst.type == '_':
 
55
                                if the.verbose >= 2: self.print_op( rel_file, 'd>_' )
 
56
                                shutil.copytree( src.file, dst.file, True )
 
57
 
 
58
                        # if dst entity is a directory, copy permissions, as required (and
 
59
                        # recurse)
 
60
                        elif dst.type == 'd':
 
61
                                # TODO: should check permission and only do as necessary
 
62
                                if the.verbose >= 2: self.print_op( rel_file, 'd>d' )
 
63
                                shutil.copystat( src.file, dst.file )
 
64
                                return True
 
65
 
 
66
                        # if dst entity is a symlink to a directory, and this is an
 
67
                        # acceptable substitute, just recurse
 
68
                        elif self.check_dst_symlinks and dst.link_type == 'd' and \
 
69
                                        the.config.symlinks.matches( rel_file ):
 
70
                                if the.verbose >= 2: self.print_op( rel_file, 'd@d' )
 
71
                                return True
 
72
 
 
73
                        # if dst entity is a file or symlink in home dir, replace it with
 
74
                        # directory (no need to recurse, since we're copying the whole
 
75
                        # directory)
 
76
                        elif dst.type == 'f' or dst.type == 'l':
 
77
                                if the.verbose >= 2: self.print_op( rel_file, 'd>' + dst.type )
 
78
                                os.unlink( dst.file )
 
79
                                shutil.copytree( src.file, dst.file, True )
 
80
 
 
81
                        else:
 
82
                                raise NotImplementedError()
 
83
 
 
84
                # src entity is file
 
85
                elif src.type == 'f':
 
86
 
 
87
                        # if dst entity doesn't exist, copy file
 
88
                        if dst.type == '_':
 
89
                                if the.verbose >= 2: self.print_op( rel_file, 'f>_' )
 
90
                                shutil.copy( src.file, dst.file )
 
91
                                shutil.copystat( src.file, dst.file )
 
92
 
 
93
                        # if dst entity is a file, replace it only if it differs
 
94
                        elif dst.type == 'f':
 
95
                                if not filecmp.cmp( src.file, dst.file ):
 
96
                                        if the.verbose >= 2: self.print_op( rel_file, 'f>f' )
 
97
                                        os.unlink( dst.file )
 
98
                                        shutil.copy( src.file, dst.file )
 
99
                                        shutil.copystat( src.file, dst.file )
 
100
                                else:
 
101
                                        if the.verbose >= 2: self.print_op( rel_file, 'f=f' )
 
102
 
 
103
                        # if dst entity is a directory, replace it with file
 
104
                        elif dst.type == 'd':
 
105
                                if the.verbose >= 2: self.print_op( rel_file, 'f>d' )
 
106
                                shutil.rmtree( dst.file )
 
107
                                shutil.copy( src.file, dst.file )
 
108
                                shutil.copystat( src.file, dst.file )
 
109
 
 
110
                        # if dst entity is a symlink, replace it with file
 
111
                        elif dst.type == 'l':
 
112
                                if the.verbose >= 2: self.print_op( rel_file, 'f>l' )
 
113
                                os.unlink( dst.file )
 
114
                                shutil.copy( src.file, dst.file )
 
115
                                shutil.copystat( src.file, dst.file )
 
116
 
 
117
                        else:
 
118
                                raise NotImplementedError()
 
119
 
 
120
                # src entity is a symlink
 
121
                elif src.type == 'l':
 
122
 
 
123
                        # if dst entity doesn't exist, copy symlink
 
124
                        if dst.type == '_':
 
125
                                if the.verbose >= 2: self.print_op( rel_file, 'l>_' )
 
126
                                os.symlink( os.readlink( src.file ), dst.file )
 
127
 
 
128
                        # if dst entity is a symlink, replace it only if it differs
 
129
                        elif dst.type == 'l':
 
130
                                if os.readlink( src.file ) != os.readlink( dst.file ):
 
131
                                        if the.verbose >= 2: self.print_op( rel_file, 'l>l' )
 
132
                                        os.unlink( dst.file )
 
133
                                        os.symlink( os.readlink( src.file ), dst.file )
 
134
                                else:
 
135
                                        if the.verbose >= 2: self.print_op( rel_file, 'l=l' )
 
136
 
 
137
                        # if dst entity is a file, replace it with symlink
 
138
                        elif dst.type == 'f':
 
139
                                if the.verbose >= 2: self.print_op( rel_file, 'l>f' )
 
140
                                os.unlink( dst.file )
 
141
                                os.symlink( os.readlink( src.file ), dst.file )
 
142
 
 
143
                        # if dst entity is a directory...
 
144
                        elif dst.type == 'd':
 
145
 
 
146
                                # if src entity is a symlink to a directory, and this is an
 
147
                                # acceptable substitute, just recurse
 
148
                                if self.check_src_symlinks and src.link_type == 'd' and \
 
149
                                                the.config.symlinks.matches( rel_file ):
 
150
                                        if the.verbose >= 2: self.print_op( rel_file, 'd@d' )
 
151
                                        return True
 
152
 
 
153
                                # else replace it with a symlink
 
154
                                if the.verbose >= 2: self.print_op( rel_file, 'l>d' )
 
155
                                shutil.rmtree( dst.file )
 
156
                                os.symlink( os.readlink( src.file ), dst.file )
 
157
 
 
158
                        else:
 
159
                                raise NotImplementedError()
 
160
 
 
161
                # src entity is missing
 
162
                elif src.type == '_':
 
163
 
 
164
                        # if dst entity doesn't exist, we're good
 
165
                        if dst.type == '_':
 
166
                                pass;
 
167
 
 
168
                        # if dst entity is a file or symlink, delete it
 
169
                        elif dst.type == 'f' or dst.type == 'l':
 
170
                                if the.verbose >= 2: self.print_op( rel_file, '_>' + dst.type )
 
171
                                os.unlink( dst.file )
 
172
 
 
173
                        # if dst entity is a directory, delete it
 
174
                        elif dst.type == 'd':
 
175
                                if the.verbose >= 2: self.print_op( rel_file, '_>d' )
 
176
                                shutil.rmtree( dst.file )
 
177
 
 
178
                        else:
 
179
                                raise NotImplementedError()
 
180
 
 
181
                # if we got here, we don't want to recurse...
 
182
                return False