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