/stdhome

To get this branch, use:
bzr branch http://bzr.ed.am/stdhome
41 by Tim Marston
added add command
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
82 by Tim Marston
added general reporting to CopyBase and configured it via copy-in and copy-out
27
from stdhome.walker.walker import Walker
41 by Tim Marston
added add command
28
29
30
class AddCommand( Command ):
31
32
82 by Tim Marston
added general reporting to CopyBase and configured it via copy-in and copy-out
33
	def __init__( self ):
34
		self.recursive = False
35
36
41 by Tim Marston
added add command
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"
82 by Tim Marston
added general reporting to CopyBase and configured it via copy-in and copy-out
46
		print "recursively (as is common with version control) unless this is specifically"
47
		print "requested on the commandline."
41 by Tim Marston
added add command
48
		print
49
		print "Options:"
50
		print "  -r, --repo=REPO  select the repo to check-out or create (defaults to 'home')"
82 by Tim Marston
added general reporting to CopyBase and configured it via copy-in and copy-out
51
		print "  -R, --recursive  recursively add directories"
41 by Tim Marston
added add command
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(
82 by Tim Marston
added general reporting to CopyBase and configured it via copy-in and copy-out
59
			sys.argv[ 1: ], "r:Rv",
60
			[ "repo=", "recuirsive", "verbose", "help" ] )
41 by Tim Marston
added add command
61
		for opt, optarg in opts:
62
			if opt in [ '--repo', '-r' ]:
61 by Tim Marston
added home directory change reporting to CopyOutWalker; added --quiet option to
63
				if not re.search( '^[-a-zA-z0-9.]+$', optarg ):
41 by Tim Marston
added add command
64
					raise the.program.FatalError(
65
						'invalid repository name: ' + optarg )
66
				the.repo = optarg
82 by Tim Marston
added general reporting to CopyBase and configured it via copy-in and copy-out
67
			elif opt in [ '--recursive', '-R' ]:
68
				self.recursive = True
63 by Tim Marston
determine and instantiate repo vcs dynamically; for new repos, added default vcs
69
			elif opt in [ '--verbose', '-v' ]:
70
				the.verbose += 1
41 by Tim Marston
added add command
71
			elif opt == "--help":
72
				self.print_help()
55 by Tim Marston
moved handling of --verbose to main program; manuall parse config file (because
73
41 by Tim Marston
added add command
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
82 by Tim Marston
added general reporting to CopyBase and configured it via copy-in and copy-out
91
		files = self.expand_home_files( self.files, self.recursive )
41 by Tim Marston
added add command
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'
55 by Tim Marston
moved handling of --verbose to main program; manuall parse config file (because
101
				'Hint: see "%s stage-revert --help"' %
41 by Tim Marston
added add command
102
				( the.repo.name, the.program.name ) )
103
104
		# check status
82 by Tim Marston
added general reporting to CopyBase and configured it via copy-in and copy-out
105
		walker = CopyInWalker( files, True )
41 by Tim Marston
added add command
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
82 by Tim Marston
added general reporting to CopyBase and configured it via copy-in and copy-out
117
118
41 by Tim Marston
added add command
119
	@staticmethod
82 by Tim Marston
added general reporting to CopyBase and configured it via copy-in and copy-out
120
	def expand_home_files( files, recurse ):
41 by Tim Marston
added add command
121
		"""Returns a unique, sorted list of relative filenames, calculated from the list
122
		provided, which is made up from individual files and directories
82 by Tim Marston
added general reporting to CopyBase and configured it via copy-in and copy-out
123
		relative to the CWD.  Directories are recursed in to as requried, and
124
		leading path components of any items are alse returned.  Specified
125
		filenames must exist in the home directory (although they may not exist
126
		in the repo).
127
128
		This is a modified version of command.expand_files().
48 by Tim Marston
during add, ensure parent directories are added
129
41 by Tim Marston
added add command
130
		"""
131
48 by Tim Marston
during add, ensure parent directories are added
132
		ret = set()
41 by Tim Marston
added add command
133
		home_dir_prefix = os.path.realpath( the.full_home_dir ) + os.sep
134
135
		# iterate through file list
136
		for file in files:
137
			parts = os.path.split( file )
138
			abs_file = os.path.join(
139
				os.path.realpath( parts[ 0 ] ), parts[ 1 ] )
140
141
			# check the file is in the home directory
142
			if abs_file[ : len( home_dir_prefix ) ] != home_dir_prefix:
143
				raise the.program.FatalError(
48 by Tim Marston
during add, ensure parent directories are added
144
					'not under home directory: %s' % abs_file )
41 by Tim Marston
added add command
145
146
			# relative file
147
			rel_file = abs_file[ len( home_dir_prefix ) : ]
148
149
			# check if file exists in home directory
150
			if not os.path.lexists( abs_file ):
151
				raise the.program.FatalError(
48 by Tim Marston
during add, ensure parent directories are added
152
					'not found in home directory: %s' % rel_file )
153
82 by Tim Marston
added general reporting to CopyBase and configured it via copy-in and copy-out
154
			# ensure parent path parts are included
155
			path = rel_file
156
			while True:
157
				path, dummy = os.path.split( path )
158
				if len( path ): ret.add( path )
159
				else: break
48 by Tim Marston
during add, ensure parent directories are added
160
161
			# append the file or directory
82 by Tim Marston
added general reporting to CopyBase and configured it via copy-in and copy-out
162
			ret.update( Walker.generate_walk_list(
163
				the.full_home_dir, rel_file, recurse ) )
48 by Tim Marston
during add, ensure parent directories are added
164
165
		return sorted( ret )