/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/command/add.py

  • Committer: Tim Marston
  • Date: 2021-07-05 19:14:32 UTC
  • Revision ID: tim@ed.am-20210705191432-243ayb7s2nmussvi
python3ification

Show diffs side-by-side

added added

removed removed

lib/stdhome/command/add.py
 
1
# add.py
 
2
#
 
3
# Copyright (C) 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 sys, re, getopt, os
 
23
from .command import Command
 
24
import stdhome.the as the
 
25
from stdhome.deployment import Deployment
 
26
from stdhome.walker.copy_in import CopyInWalker
 
27
from stdhome.walker.walker import Walker
 
28
 
 
29
 
 
30
class AddCommand( Command ):
 
31
 
 
32
 
 
33
        def __init__( self ):
 
34
                self.recursive = False
 
35
 
 
36
 
 
37
        def print_help( self ):
 
38
                print("Usage: " + the.program.name + " add [--repo=REPO] FILE...")
 
39
                print()
 
40
                #      01234567890123456789012345678901234567890123456789012345678901234567890123456789
 
41
                print("Add (or update) a file in the repository.")
 
42
                print()
 
43
                print("Add a named file from the local filesystem, specified relative to the home")
 
44
                print("directory, to the repo, or update an existing file in the repo with your local")
 
45
                print("changes.  Directories can also be added, but note that they are not added")
 
46
                print("recursively (as is common with version control) unless this is specifically")
 
47
                print("requested on the commandline.")
 
48
                print()
 
49
                print("Options:")
 
50
                print("  -r, --repo=REPO  select the repo to check-out or create (defaults to 'home')")
 
51
                print("  -R, --recursive  recursively add directories")
 
52
                print("  -v, --verbose    display information about what is being done")
 
53
                print("      --help       display help and exit")
 
54
                exit( 0 )
 
55
 
 
56
 
 
57
        def parse_command_line( self ):
 
58
                opts, args = getopt.gnu_getopt(
 
59
                        sys.argv[ 1: ], "r:Rv",
 
60
                        [ "repo=", "recuirsive", "verbose", "help" ] )
 
61
                for opt, optarg in opts:
 
62
                        if opt in [ '--repo', '-r' ]:
 
63
                                if not re.search( '^[-a-zA-z0-9.]+$', optarg ):
 
64
                                        raise the.program.FatalError(
 
65
                                                'invalid repository name: ' + optarg )
 
66
                                the.repo = optarg
 
67
                        elif opt in [ '--recursive', '-R' ]:
 
68
                                self.recursive = True
 
69
                        elif opt in [ '--verbose', '-v' ]:
 
70
                                the.verbose += 1
 
71
                        elif opt == "--help":
 
72
                                self.print_help()
 
73
 
 
74
                # discard first argument (the command)
 
75
                args.pop( 0 )
 
76
 
 
77
                # check remaining arguments
 
78
                if len( args ) < 1:
 
79
                        raise the.program.UsageError( 'too few arguments' )
 
80
 
 
81
                # files arguments
 
82
                self.files = args
 
83
 
 
84
 
 
85
        def run( self ):
 
86
 
 
87
                # set up repo and check it exists
 
88
                the.repo.check_dir_exists()
 
89
 
 
90
                # determine files
 
91
                files = self.expand_home_files( self.files, self.recursive )
 
92
 
 
93
                # initialise deployment and ensure it's not ongoing
 
94
                deployment = Deployment()
 
95
                deployment.check_ongoing( False )
 
96
 
 
97
                # check for local changes
 
98
                if the.repo.vcs.has_changes():
 
99
                        raise the.program.FatalError(
 
100
                                'repo has local changes: %s\n'
 
101
                                'Hint: see "%s stage-revert --help"' %
 
102
                                ( the.repo.name, the.program.name ) )
 
103
 
 
104
                # check status
 
105
                walker = CopyInWalker( files, True )
 
106
                walker.walk()
 
107
 
 
108
                # make sure all files are added to version control
 
109
                if the.verbose >= 1: print("adding files")
 
110
                the.repo.vcs.add( files )
 
111
 
 
112
                # commit repo
 
113
                if the.verbose >= 1: print("committing " + the.repo.dir)
 
114
                the.repo.vcs.commit()
 
115
 
 
116
 
 
117
 
 
118
        @staticmethod
 
119
        def expand_home_files( files, recurse ):
 
120
                """Returns a unique, sorted list of relative filenames, calculated from the list
 
121
                provided, which is made up from individual files and directories
 
122
                relative to the CWD.  As directories are found, they may optionally be
 
123
                recursed in to.  Leading path components of any items are alse returned.
 
124
                Specified filenames must exist in the home directory (although they do
 
125
                not have to exist in the repo).
 
126
 
 
127
                This is a modified version of command.expand_files().
 
128
 
 
129
                """
 
130
 
 
131
                ret = set()
 
132
                home_dir_prefix = os.path.realpath( the.full_home_dir ) + os.sep
 
133
 
 
134
                # iterate through file list
 
135
                for file in files:
 
136
                        ( rel_file, abs_file ) = Command.resolve_homedir_file( file )
 
137
 
 
138
                        # check that file exists in homedir
 
139
                        if not os.path.exists( abs_file ):
 
140
                                raise the.program.FatalError(
 
141
                                        'not found in home directory: %s' % file )
 
142
 
 
143
                        # ensure parent path parts are included
 
144
                        path = rel_file
 
145
                        while True:
 
146
                                path, dummy = os.path.split( path )
 
147
                                if len( path ): ret.add( path )
 
148
                                else: break
 
149
 
 
150
                        # append the file or directory
 
151
                        ret.update( Walker.generate_walk_list(
 
152
                                the.full_home_dir, rel_file, recurse ) )
 
153
 
 
154
                return sorted( ret )