/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 20:27:11 UTC
  • Revision ID: tim@ed.am-20210705202711-vklvsctrh5yhgjj7
added staging commands; updated command helps

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