New login command (that saves your login, too)
[mw] / src / mw / clicommands.py
1 ###
2 # mw - VCS-like nonsense for MediaWiki websites
3 # Copyright (C) 2010  Ian Weller <ian@ianweller.org>
4 #
5 # This program is free software; you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; either version 2 of the License, or
8 # (at your option) any later version.
9 #
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 # GNU General Public License for more details.
14 #
15 # You should have received a copy of the GNU General Public License along
16 # with this program.  If not, see <http://www.gnu.org/licenses/>.
17 ###
18
19 import getpass
20 import mw.api
21 import mw.metadir
22 from optparse import OptionParser, OptionGroup
23 import os
24 import sys
25
26
27 class CommandBase(object):
28
29     def __init__(self, name, description, usage=None):
30         self.me = os.path.basename(sys.argv[0])
31         self.description = description
32         if usage is None:
33             usage = '%prog ' + name
34         else:
35             usage = '%%prog %s %s' % (name, usage)
36         self.parser = OptionParser(usage=usage, description=description)
37         self.name = name
38         self.metadir = mw.metadir.Metadir()
39         #global_options = OptionGroup(self.parser, "Global Options")
40         #global_options.add_option('-u', '--use-auth', action='store_true',
41         #                          dest='use_auth', help='force authentication '
42         #                          'even if not required')
43         #self.parser.add_option_group(global_options)
44         self.shortcuts = []
45
46     def main(self):
47         (self.options, self.args) = self.parser.parse_args()
48         self.args = self.args[1:] # don't need the first thing
49         self._do_command()
50
51     def _do_command(self):
52         pass
53
54     def _login(self):
55         user = raw_input('Username: ')
56         passwd = getpass.getpass()
57         result = self.api.call({'action': 'login',
58                                 'lgname': user,
59                                 'lgpassword': passwd})
60         if result['login']['result'] == 'Success':
61             # cookies are saved to a file
62             print 'Login successful! (yay)'
63         else:
64             print 'Login failed: %s' % result['login']['result']
65
66     def _die_if_no_init(self):
67         if self.metadir.config is None:
68             print '%s: not a mw repo' % self.me
69             sys.exit(1)
70
71     def _api_setup(self):
72         self.api_url = self.metadir.config.get('remote', 'api_url')
73         self.api = mw.api.API(self.api_url, self.metadir)
74
75
76 class InitCommand(CommandBase):
77
78     def __init__(self):
79         usage = 'API_URL'
80         CommandBase.__init__(self, 'init', 'start a mw repo', usage)
81
82     def _do_command(self):
83         if len(self.args) < 1:
84             self.parser.error('must have URL to remote api.php')
85         elif len(self.args) > 1:
86             self.parser.error('too many arguments')
87         self.metadir.create(self.args[0])
88
89
90 class LoginCommand(CommandBase):
91
92     def __init__(self):
93         CommandBase.__init__(self, 'login', 'authenticate with wiki')
94
95     def _do_command(self):
96         self._die_if_no_init()
97         self._api_setup()
98         self._login()
99
100
101 class PullCommand(CommandBase):
102
103     def __init__(self):
104         usage = '[options] PAGENAME ...'
105         CommandBase.__init__(self, 'pull', 'add remote pages to repo', usage)
106
107     def _do_command(self):
108         self._die_if_no_init()
109         self._api_setup()
110         pages = []
111         pages += self.args
112         for these_pages in [pages[i:i + 25] for i in range(0, len(pages), 25)]:
113             data = {
114                     'action': 'query',
115                     'titles': '|'.join(these_pages),
116                     'prop': 'info|revisions',
117                     'rvprop': 'ids|flags|timestamp|user|comment|content',
118             }
119             response = self.api.call(data)['query']['pages']
120             for pageid in response.keys():
121                 pagename = response[pageid]['title']
122                 if 'missing' in response[pageid].keys():
123                     print '%s: %s: page does not exist, file not created' % \
124                             (self.me, pagename)
125                     continue
126                 revids = [x['revid'] for x in response[pageid]['revisions']]
127                 revids.sort()
128                 self.metadir.pagedict_add(pagename, pageid, revids[-1])
129                 self.metadir.pages_add_rv(int(pageid),
130                                           response[pageid]['revisions'][0])
131                 filename = mw.api.pagename_to_filename(pagename)
132                 fd = file(os.path.join(self.metadir.root, filename + '.wiki'),
133                           'w')
134                 fd.write(response[pageid]['revisions'][0]['*'].encode('utf-8'))
135
136
137 class StatusCommand(CommandBase):
138
139     def __init__(self):
140         CommandBase.__init__(self, 'status', 'check repo status')
141         self.shortcuts.append('st')
142
143     def _do_command(self):
144         self._die_if_no_init()
145         status = self.metadir.working_dir_status()
146         for file in status:
147             print '%s %s' % (status[file], file)
148
149
150 class DiffCommand(CommandBase):
151
152     def __init__(self):
153         CommandBase.__init__(self, 'diff', 'diff wiki to working directory')
154
155     def _do_command(self):
156         self._die_if_no_init()
157         status = self.metadir.working_dir_status()
158         for file in status:
159             if status[file] == 'U':
160                 print self.metadir.diff_rv_to_working(
161                     mw.api.filename_to_pagename(file[:-5])
162                 ),
163
164
165 class CommitCommand(CommandBase):
166
167     def __init__(self):
168         CommandBase.__init__(self, 'commit', 'commit changes to wiki')
169         self.shortcuts.append('ci')
170
171     def _do_command(self):
172         self._die_if_no_init()
173         self._api_setup()

Benjamin Mako Hill || Want to submit a patch?