/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/program.py

  • Committer: Tim Marston
  • Date: 2014-04-18 14:32:26 UTC
  • Revision ID: tim@ed.am-20140418143226-d3ih1aafs6mg9ndw
made revert require --all to act on all files

Show diffs side-by-side

added added

removed removed

19
19
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
20
20
 
21
21
 
22
 
import os, sys, getopt
 
22
import os, sys, getopt, ConfigParser
23
23
import the
 
24
from vcs.vcs import Vcs
24
25
 
25
26
 
26
27
class Program:
38
39
 
39
40
 
40
41
        def print_usage( self, error_message ):
41
 
                suffix = ' ' + the.command if the.command else ''
 
42
                command = ' ' + the.command if the.command else ''
42
43
                self.die( error_message + \
43
44
                                  "\nTry '%s%s --help' for more information." % \
44
 
                                  ( self.name, suffix ) )
 
45
                                  ( self.name, command ) )
45
46
 
46
47
 
47
48
        def print_help( self ):
48
49
                print "Usage: " + self.name + " COMMAND [OPTION]..."
49
50
                print
50
51
                #      01234567890123456789012345678901234567890123456789012345678901234567890123456789
51
 
                print "Manage your home directories, across multiple computers, similar to how you"
52
 
                print "would software under version control."
 
52
                print "Tool to manage a set of files in your home directory and distribute them across"
 
53
                print "multiple computers, merging local changes (in the same way as you would manage"
 
54
                print "source code under version control)."
53
55
                print
54
56
                print "Global options (for all commands):"
55
57
                print "     --help     display help and exit"
59
61
                print "  init          initialise a local copy of your repositories"
60
62
                print "  update        update files in your home directory"
61
63
                print "  resolve       try to finish an update (that had conflicts)"
62
 
                print "  add           add local files/changes to the repository"
63
 
                print "  remove        remove a local file from the repository"
64
 
                print "  revert        undo changes made to a local file"
65
 
                print "  stage-add     stage local files/changes"
66
 
                print "  stage-remove  stage the removal of files"
67
 
                print "  stage-revert  revert staged changes"
68
 
                print "  stage-status  show status of staging area"
69
 
                print "  stage-commit  commit staged changes to repository"
 
64
#               print "  add           add local files/changes to the repository"
 
65
#               print "  remove        remove a local file from the repository"
 
66
                print "  status        list files that have changed locally"
 
67
                print "  diff          shows changes made to local files"
 
68
                print "  revert        undo changes made to local files"
 
69
#               print "  stage-add     add (but don't commit) files/changes to local repository"
 
70
#               print "  stage-remove  delete *but don't comit) files from the local repository"
 
71
                print "  stage-revert  revert changes in the local repository"
 
72
#               print "  stage-status  show status of local repository"
 
73
#               print "  stage-diff    shows changes in local repository"
 
74
#               print "  stage-commit  commit changes in the local repository"
70
75
                print
71
76
                print "For help about a particular command (including the additional options that the"
72
77
                print "command accepts) try typing:"
77
82
        def print_version( self ):
78
83
                print "stdhome " + self.version
79
84
                print
80
 
                print "Copyright (C) 2013 Tim Marston"
 
85
                print "Copyright (C) 2013 to 2014 Tim Marston"
81
86
                print
82
87
                #      01234567890123456789012345678901234567890123456789012345678901234567890123456789
83
88
                print "This program is free software, and you may use, modify and redistribute it"
99
104
                - `command`: the given command
100
105
                """
101
106
                # commands
102
 
                if [ 'init', 'update', 'resolve', 'add', 'remove', 'revert',
103
 
                         'stage-add', 'stage-remove', 'stage-revert', 'stage-status',
104
 
                         'stage-commit' ].count( command ) == 1:
 
107
                if [ 'init', 'update', 'resolve', 'add', 'remove', 'revert', 'status',
 
108
                         'diff', 'stage-add', 'stage-remove', 'stage-revert',
 
109
                         'stage-status', 'stage-diff', 'stage-commit'
 
110
                ].count( command ) == 1:
105
111
                        return command
106
112
 
107
113
                # resolve aliases
108
 
                elif command == 'up':
109
 
                        return 'update'
110
 
                elif command == 'rm':
111
 
                        return 'remove'
 
114
                alias = {
 
115
                        'up': 'update',
 
116
                        'rm': 'remove',
 
117
                        'st': 'status',
 
118
                        'co': 'init',
 
119
                }.get( command, False )
 
120
                if alias: return alias
112
121
 
113
122
                # invalid
114
 
                else:
115
 
                        return None
116
 
 
117
 
 
118
 
        def get_command_argument( self, args ):
119
 
                """
120
 
                Find the first program argument what isn't an option argument.
121
 
 
122
 
        Arguments:
123
 
        - `args`: the program arguments
124
 
        """
125
 
                while args:
126
 
                        if args[ 0 ] == '--':
127
 
                                return args[ 1 ] if len( args ) > 1 else None
128
 
                        if args[ 0 ][ 0 : 1 ] != '-':
129
 
                                return args[ 0 ]
130
 
                        args = args[ 1 : ]
131
123
                return None
132
124
 
133
125
 
153
145
                        # ignore errors -- we aren't parsing the command line properly yet
154
146
                        pass
155
147
 
156
 
                # find the first non-option argument (the command)
157
 
                the.command = self.get_command_argument( sys.argv[ 1: ] )
 
148
                # read program configuration
 
149
                self.read_config()
 
150
 
 
151
                # the first argument should be the command
 
152
                the.command = sys.argv[ 1 ] if len( sys.argv ) > 1 else None
158
153
                if the.command == None:
159
154
                        self.print_usage( "missing command" )
160
155
 
163
158
                if the.command == None:
164
159
                        self.print_usage( "bad command" )
165
160
 
166
 
                # calculate class name
 
161
                # calculate module and class name
 
162
                class_name = module_name = ''
167
163
                bits = the.command.split( '-' )
168
 
                class_name = 'Command'
169
164
                for bit in bits:
170
165
                        class_name += bit[ 0 ].upper() + bit[ 1 : ]
 
166
                        if module_name: module_name += '_'
 
167
                        module_name += bit
 
168
                class_name += 'Command'
171
169
 
172
 
                # instantiate the command class
173
 
                module = __import__( 'stdhome.command_' + the.command,
 
170
                # import module and instantiate the class
 
171
                module = __import__( 'stdhome.command.' + module_name,
174
172
                                                         fromlist = [ class_name ] )
175
173
                instance = getattr( module, class_name )()
176
174
 
177
 
                # run it
 
175
                # fully parse the command line, as per the command
178
176
                try:
179
177
                        instance.parse_command_line()
 
178
                except( getopt.GetoptError, self.UsageError ) as e:
 
179
                        self.print_usage( e.msg )
 
180
                except self.FatalError as e:
 
181
                        self.die( e.msg )
 
182
 
 
183
                # do late initialisation
 
184
                the.late_init()
 
185
 
 
186
                # run the command
 
187
                try:
180
188
                        instance.run()
181
 
                except ( getopt.GetoptError, self.UsageError ) as e:
182
 
                        self.print_usage( e.msg )
183
 
                except self.FatalError as e:
184
 
                        message = e.msg
185
 
                        if the.verbose and e.output:
186
 
                                message += '\n\nOUTPUT:\n' + e.output
 
189
                except Vcs.VcsError as e:
 
190
                        message = e.msg.rstrip()
 
191
                        if the.verbose:
 
192
                                message += '\n\nOUTPUT:\n' + e.output.rstrip()
187
193
                        self.die( message )
 
194
                except self.FatalError as e:
 
195
                        self.die( e.msg )
 
196
 
 
197
 
 
198
        def read_config( self ):
 
199
                config = ConfigParser.SafeConfigParser( allow_no_value = True )
 
200
                config.read( the.config_file )
 
201
                if config.has_option( 'stdhome', 'home-dir' ):
 
202
                        the.home_dir = config.get( 'stdhome', 'home-dir' )
188
203
 
189
204
 
190
205
        class UsageError( Exception ):
195
210
 
196
211
        class FatalError( Exception ):
197
212
 
198
 
                def __init__( self, message, output = None ):
 
213
                def __init__( self, message ):
199
214
                        self.msg = message
200
 
                        self.output = output