3
# Copyright (C) 2021 Tim Marston <tim@ed.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 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
30
class StageAddCommand( Command ):
34
self.recursive = False
37
def print_help( self ):
38
print("Usage: " + the.program.name + " stage-add [--repo=REPO] FILE...")
40
# 01234567890123456789012345678901234567890123456789012345678901234567890123456789
41
print("Add (or update) a file in the local repository.")
43
print("In addition to using the primary commands (such as add and remove) to modify a")
44
print("remote repository, you can also set up changes in the local repository and")
45
print("manually commit them to a remote repository when ready. This can be done with")
46
print("the staging commands. Note, some primary commands will not work when there are")
47
print("staged changes. You can revert all staged changes with stage-revert.")
49
print("This command adds a named file from the local filesystem to the local repo, or")
50
print("updates an existing file in the local repo with your changes. Directories can")
51
print("also be added, but note that they are not added recursively (as is common with")
52
print("version control) unless this is explicitly requested.")
55
print(" -r, --repo=REPO select the repo to check-out or create (defaults to 'home')")
56
print(" -R, --recursive recursively add directories")
57
print(" -v, --verbose display information about what is being done")
58
print(" --help display help and exit")
62
def parse_command_line( self ):
63
opts, args = getopt.gnu_getopt(
64
sys.argv[ 1: ], "r:Rv",
65
[ "repo=", "recuirsive", "verbose", "help" ] )
66
for opt, optarg in opts:
67
if opt in [ '--repo', '-r' ]:
68
if not re.search( '^[-a-zA-z0-9.]+$', optarg ):
69
raise the.program.FatalError(
70
'invalid repository name: ' + optarg )
72
elif opt in [ '--recursive', '-R' ]:
74
elif opt in [ '--verbose', '-v' ]:
79
# discard first argument (the command)
82
# check remaining arguments
84
raise the.program.UsageError( 'too few arguments' )
92
# set up repo and check it exists
93
the.repo.check_dir_exists()
96
files = self.expand_home_files( self.files, self.recursive )
98
# initialise deployment and ensure it's not ongoing
99
deployment = Deployment()
100
deployment.check_ongoing( False )
103
walker = CopyInWalker( files, True )
106
# make sure all files are added to version control
107
if the.verbose >= 1: print("adding files")
108
the.repo.vcs.add( files )
113
def expand_home_files( files, recurse ):
114
"""Returns a unique, sorted list of relative filenames, calculated from the list
115
provided, which is made up from individual files and directories
116
relative to the CWD. As directories are found, they may optionally be
117
recursed in to. Leading path components of any items are alse returned.
118
Specified filenames must exist in the home directory (although they do
119
not have to exist in the repo).
121
This is a modified version of command.expand_files().
126
home_dir_prefix = os.path.realpath( the.full_home_dir ) + os.sep
128
# iterate through file list
130
( rel_file, abs_file ) = Command.resolve_homedir_file( file )
132
# check that file exists in homedir
133
if not os.path.exists( abs_file ):
134
raise the.program.FatalError(
135
'not found in home directory: %s' % file )
137
# ensure parent path parts are included
140
path, dummy = os.path.split( path )
141
if len( path ): ret.add( path )
144
# append the file or directory
145
ret.update( Walker.generate_walk_list(
146
the.full_home_dir, rel_file, recurse ) )