/stdhome

# stage_add.py

#

# Copyright (C) 2021 Tim Marston <tim@ed.am>

#

# This file is part of stdhome (hereafter referred to as "this program").

# See http://ed.am/dev/stdhome for more information.

#

# This program is free software: you can redistribute it and/or modify

# it under the terms of the GNU General Public License as published by

# the Free Software Foundation, either version 3 of the License, or

# (at your option) any later version.

#

# This program is distributed in the hope that it will be useful,

# but WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

# GNU General Public License for more details.

#

# You should have received a copy of the GNU General Public License

# along with this program.  If not, see <http://www.gnu.org/licenses/>.

import sys, re, getopt, os

from .command import Command

import stdhome.the as the

from stdhome.deployment import Deployment

from stdhome.walker.copy_in import CopyInWalker

from stdhome.walker.walker import Walker

class StageAddCommand( Command ):

	def __init__( self ):

		self.recursive = False

	def print_help( self ):

		print("Usage: " + the.program.name + " stage-add [--repo=REPO] FILE...")

		print()

		#      01234567890123456789012345678901234567890123456789012345678901234567890123456789

		print("Add (or update) a file in the local repository.")

		print()

		print("In addition to using the primary commands (such as add and remove) to modify a")

		print("remote repository, you can also set up changes in the local repository and")

		print("manually commit them to a remote repository when ready.  This can be done with")

		print("the staging commands.  Note, some primary commands will not work when there are")

		print("staged changes.  You can revert all staged changes with stage-revert.")

		print()

		print("This command adds a named file from the local filesystem to the local repo, or")

		print("updates an existing file in the local repo with your changes.  Directories can")

		print("also be added, but note that they are not added recursively (as is common with")

		print("version control) unless this is explicitly requested.")

		print()

		print("Options:")

		print("  -r, --repo=REPO  select the repo to check-out or create (defaults to 'home')")

		print("  -R, --recursive  recursively add directories")

		print("  -v, --verbose    display information about what is being done")

		print("      --help       display help and exit")

		exit( 0 )

	def parse_command_line( self ):

		opts, args = getopt.gnu_getopt(

			sys.argv[ 1: ], "r:Rv",

			[ "repo=", "recuirsive", "verbose", "help" ] )

		for opt, optarg in opts:

			if opt in [ '--repo', '-r' ]:

				if not re.search( '^[-a-zA-z0-9.]+$', optarg ):

					raise the.program.FatalError(

						'invalid repository name: ' + optarg )

				the.repo = optarg

			elif opt in [ '--recursive', '-R' ]:

				self.recursive = True

			elif opt in [ '--verbose', '-v' ]:

				the.verbose += 1

			elif opt == "--help":

				self.print_help()

		# discard first argument (the command)

		args.pop( 0 )

		# check remaining arguments

		if len( args ) < 1:

			raise the.program.UsageError( 'too few arguments' )

		# files arguments

		self.files = args

	def run( self ):

		# set up repo and check it exists

		the.repo.check_dir_exists()

		# determine files

		files = self.expand_home_files( self.files, self.recursive )

		# initialise deployment and ensure it's not ongoing

		deployment = Deployment()

		deployment.check_ongoing( False )

		# check status

		walker = CopyInWalker( files, True )

		walker.walk()

		# make sure all files are added to version control

		if the.verbose >= 1: print("adding files")

		the.repo.vcs.add( files )

	@staticmethod

	def expand_home_files( files, recurse ):

		"""Returns a unique, sorted list of relative filenames, calculated from the list

		provided, which is made up from individual files and directories

		relative to the CWD.  As directories are found, they may optionally be

		recursed in to.  Leading path components of any items are alse returned.

		Specified filenames must exist in the home directory (although they do

		not have to exist in the repo).

		This is a modified version of command.expand_files().

		"""

		ret = set()

		home_dir_prefix = os.path.realpath( the.full_home_dir ) + os.sep

		# iterate through file list

		for file in files:

			( rel_file, abs_file ) = Command.resolve_homedir_file( file )

			# check that file exists in homedir

			if not os.path.exists( abs_file ):

				raise the.program.FatalError(

					'not found in home directory: %s' % file )

			# ensure parent path parts are included

			path = rel_file

			while True:

				path, dummy = os.path.split( path )

				if len( path ): ret.add( path )

				else: break

			# append the file or directory

			ret.update( Walker.generate_walk_list(

				the.full_home_dir, rel_file, recurse ) )

		return sorted( ret )