/stdhome

To get this branch, use:
bzr branch http://bzr.ed.am/stdhome

« back to all changes in this revision

Viewing changes to lib/stdhome/command/command.py

  • Committer: Tim Marston
  • Date: 2021-09-01 13:06:23 UTC
  • Revision ID: tim@ed.am-20210901130623-2yv2y02e3zwgd07y
fix newlines in resolve command

Show diffs side-by-side

added added

removed removed

lib/stdhome/command/command.py
20
20
 
21
21
 
22
22
import os
 
23
 
23
24
import stdhome.the as the
24
25
from stdhome.walker.walker import Walker
25
26
 
29
30
        """
30
31
 
31
32
        @staticmethod
32
 
        def expand_files( files ):
 
33
        def resolve_homedir_file( file ):
 
34
                """Given a filename, which could be absolute or relative to the CWD, this
 
35
                returns a pair of 'resolved' filenames: the name of the file relative to
 
36
                the homedir and the full, absolute filename.  Neither of the returned
 
37
                filenames are guaranteed nor required to exist.  But the supplied
 
38
                filename will cause an error if it is not iteself or when resolved (if
 
39
                it is a symlink) under the homedirectory.
 
40
 
 
41
                """
 
42
                home_dir_prefix = os.path.realpath( the.full_home_dir ) + os.sep
 
43
 
 
44
                # obtain absolute filename
 
45
                abs_file = os.path.abspath( file )
 
46
 
 
47
                # if absolute filename is not under home directory, attempt to
 
48
                # resolve symlinks
 
49
                if abs_file[ : len( home_dir_prefix ) ] != home_dir_prefix:
 
50
                        parts = os.path.split( file )
 
51
                        if os.path.exists( parts[ 0 ] ):
 
52
                                abs_file = os.path.join(
 
53
                                        os.path.realpath( parts[ 0 ] ), parts[ 1 ] )
 
54
 
 
55
                # absolute file must now be under home directory and exist
 
56
                if abs_file[ : len( home_dir_prefix ) ] != home_dir_prefix:
 
57
                        raise the.program.FatalError(
 
58
                                        'not under home directory: %s' % file )
 
59
 
 
60
                # relative file
 
61
                rel_file = abs_file[ len( home_dir_prefix ) : ]
 
62
 
 
63
                return ( rel_file, abs_file )
 
64
 
 
65
 
 
66
        @classmethod
 
67
        def expand_files( cls, files, recurse = True ):
33
68
                """Returns a unique, sorted list of relative files, calculated from the list
34
69
                provided, which is made up from individual files and directories
35
70
                relative to the CWD (and which must be contained within the home
36
71
                directory, although the files need not actually exist in the home
37
 
                directory).  All files must exist in the repository.  Any directories
38
 
                are recursed in to so that their content is also returned.
 
72
                directory).  All files must exist in the repository.  Directories are
 
73
                recursed in to as required.
 
74
 
39
75
                """
40
76
 
41
 
                ret = list()
42
 
                home_dir_prefix = os.path.realpath( the.full_home_dir ) + os.sep
 
77
                ret = set()
43
78
 
44
79
                # iterate through file list
45
80
                for file in files:
46
 
                        parts = os.path.split( file )
47
 
                        abs_file = os.path.join(
48
 
                                os.path.realpath( parts[ 0 ] ), parts[ 1 ] )
49
 
 
50
 
                        # check the file is in the home directory
51
 
                        if abs_file[ : len( home_dir_prefix ) ] != home_dir_prefix:
52
 
                                raise the.program.FatalError(
53
 
                                        'not under home directory: %s' % abs_file )
54
 
 
55
 
                        # relative file
56
 
                        rel_file = abs_file[ len( home_dir_prefix ) : ]
57
 
 
58
 
                        # check if file exists in repository
 
81
                        ( rel_file, abs_file ) = cls.resolve_homedir_file( file )
 
82
 
 
83
                        # check that file exists in repository
59
84
                        repo_file = os.path.join( the.repo.full_dir, rel_file )
60
85
                        if not os.path.lexists( repo_file ):
61
86
                                raise the.program.FatalError(
62
87
                                        'not managed by stdhome: %s' % rel_file )
63
88
 
64
89
                        # append the file or directory tree
65
 
                        ret.extend( Walker.generate_walk_list( rel_file ) )
 
90
                        ret.update( Walker.generate_walk_list(
 
91
                                the.repo.full_dir, rel_file, recurse ) )
66
92
 
67
93
                return sorted( set ( ret ) )
 
94
 
 
95
 
 
96
        @staticmethod
 
97
        def print_stage_commands_notice():
 
98
                #      01234567890123456789012345678901234567890123456789012345678901234567890123456789
 
99
                print("In addition to using the primary commands (such as add and remove) to modify a")
 
100
                print("remote repository, you can also set up changes in the local repository and")
 
101
                print("manually commit them in one go to a remote repository when you're ready.  This")
 
102
                print("is done with the staging commands.  Note, some primary commands will not work")
 
103
                print("when there are staged changes.  You can revert all staged changes with the")
 
104
                print("stage-revert command.")