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