/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
63 by Tim Marston
determine and instantiate repo vcs dynamically; for new repos, added default vcs
60
			elif opt in [ '--verbose', '-v' ]:
61
				the.verbose += 1
41 by Tim Marston
added add command
62
			elif opt == "--help":
63
				self.print_help()
55 by Tim Marston
moved handling of --verbose to main program; manuall parse config file (because
64
41 by Tim Marston
added add command
65
		# discard first argument (the command)
66
		args.pop( 0 )
67
68
		# check remaining arguments
69
		if len( args ) < 1:
70
			raise the.program.UsageError( 'too few arguments' )
71
72
		# files arguments
73
		self.files = args
74
75
76
	def run( self ):
77
78
		# set up repo and check it exists
79
		the.repo.check_dir_exists()
80
81
		# determine files
82
		files = self.expand_home_dir_files( self.files )
83
84
		# initialise deployment and ensure it's not ongoing
85
		deployment = Deployment()
86
		deployment.check_ongoing( False )
87
88
		# check for local changes
89
		if the.repo.vcs.has_changes():
90
			raise the.program.FatalError(
91
				'repo has local changes: %s\n'
55 by Tim Marston
moved handling of --verbose to main program; manuall parse config file (because
92
				'Hint: see "%s stage-revert --help"' %
41 by Tim Marston
added add command
93
				( the.repo.name, the.program.name ) )
94
95
		# check status
96
		walker = CopyInWalker( files )
97
		walker.walk()
98
99
		# make sure all files are added to version control
100
		if the.verbose >= 1: print "adding files"
101
		the.repo.vcs.add( files )
102
103
		# commit repo
104
		if the.verbose >= 1: print "committing " + the.repo.dir
105
		the.repo.vcs.commit()
106
107
108
	@staticmethod
109
	def expand_home_dir_files( files ):
110
		"""Returns a unique, sorted list of relative filenames, calculated from the list
111
		provided, which is made up from individual files and directories
48 by Tim Marston
during add, ensure parent directories are added
112
		relative to the CWD.  Directories and are not recursed in to, but
113
		leading path components are also returned.  Specified filenames must
114
		exist in the home directory (although they may not exist in the repo).
115
41 by Tim Marston
added add command
116
		"""
117
48 by Tim Marston
during add, ensure parent directories are added
118
		ret = set()
41 by Tim Marston
added add command
119
		home_dir_prefix = os.path.realpath( the.full_home_dir ) + os.sep
120
121
		# iterate through file list
122
		for file in files:
123
			parts = os.path.split( file )
124
			abs_file = os.path.join(
125
				os.path.realpath( parts[ 0 ] ), parts[ 1 ] )
126
127
			# check the file is in the home directory
128
			if abs_file[ : len( home_dir_prefix ) ] != home_dir_prefix:
129
				raise the.program.FatalError(
48 by Tim Marston
during add, ensure parent directories are added
130
					'not under home directory: %s' % abs_file )
41 by Tim Marston
added add command
131
132
			# relative file
133
			rel_file = abs_file[ len( home_dir_prefix ) : ]
134
135
			# check if file exists in home directory
136
			if not os.path.lexists( abs_file ):
137
				raise the.program.FatalError(
48 by Tim Marston
during add, ensure parent directories are added
138
					'not found in home directory: %s' % rel_file )
139
140
			# append path parts
141
			path = rel_file
142
			while True:
143
				path, dummy = os.path.split( path )
144
				if len( path ): ret.add( path )
145
				else: break
146
147
			# append the file or directory
148
			ret.add( rel_file )
149
150
		return sorted( ret )