annotate easyhg.py @ 452:d0b7dbc3ba46 authfile_refactor

Refactor into classes
author Chris Cannam
date Wed, 29 Jun 2011 15:27:01 +0100
parents 8156537329ff
children f2ab2cdd000b
rev   line source
Chris@427 1 # -*- coding: utf-8 -*-
Chris@427 2 #
Chris@427 3 # EasyMercurial
Chris@427 4 #
Chris@427 5 # Based on hgExplorer by Jari Korhonen
Chris@427 6 # Copyright (c) 2010 Jari Korhonen
Chris@427 7 # Copyright (c) 2010 Chris Cannam
Chris@427 8 # Copyright (c) 2010 Queen Mary, University of London
Chris@427 9 #
Chris@427 10 # This program is free software; you can redistribute it and/or
Chris@427 11 # modify it under the terms of the GNU General Public License as
Chris@427 12 # published by the Free Software Foundation; either version 2 of the
Chris@427 13 # License, or (at your option) any later version. See the file
Chris@427 14 # COPYING included with this distribution for more information.
Chris@427 15
Chris@449 16 import sys, os, stat, urllib, urllib2, urlparse, platform, hashlib
Chris@427 17
Chris@438 18 from mercurial.i18n import _
Chris@433 19 from mercurial import ui, util, error
Chris@427 20 try:
Chris@427 21 from mercurial.url import passwordmgr
Chris@427 22 except:
Chris@427 23 from mercurial.httprepo import passwordmgr
Chris@427 24
Chris@427 25 # The value assigned here may be modified during installation, by
Chris@427 26 # replacing its default value with another one. We can't compare
Chris@427 27 # against its default value, because then the comparison text would
Chris@427 28 # get modified as well. So, compare using prefix only.
Chris@427 29 #
Chris@427 30 easyhg_import_path = 'NO_EASYHG_IMPORT_PATH'
Chris@427 31 if not easyhg_import_path.startswith('NO_'):
Chris@427 32 # We have an installation path: append it twice, once with
Chris@427 33 # the Python version suffixed
Chris@440 34 version_suffix = 'Py%d.%d' % (sys.version_info[0], sys.version_info[1])
Chris@427 35 sys.path.append(easyhg_import_path + "/" + version_suffix)
Chris@427 36 sys.path.append(easyhg_import_path)
Chris@427 37
Chris@427 38 # Try to load the PyQt4 module that we need. If this fails, we should
Chris@427 39 # bail out later (in uisetup), because if we bail out now, Mercurial
Chris@427 40 # will just continue without us and report success. The invoking
Chris@427 41 # application needs to be able to discover whether the module load
Chris@427 42 # succeeded or not, so we need to ensure that Mercurial itself returns
Chris@427 43 # failure if it didn't.
Chris@427 44 #
Chris@427 45 easyhg_pyqt_ok = True
Chris@427 46 try:
Chris@427 47 from PyQt4 import Qt, QtGui
Chris@427 48 except ImportError:
Chris@427 49 easyhg_pyqt_ok = False
Chris@427 50 easyhg_qtapp = None
Chris@427 51
Chris@440 52 # These imports are optional, we just can't use the authfile (i.e.
Chris@438 53 # "remember this password") feature without them
Chris@438 54 #
Chris@437 55 easyhg_authfile_imports_ok = True
Chris@437 56 try:
Chris@437 57 from Crypto.Cipher import AES
Chris@437 58 import ConfigParser # Mercurial version won't write files
Chris@437 59 import base64
Chris@437 60 except ImportError:
Chris@445 61 print "EasyHg: Failed to import required modules for authfile support"
Chris@437 62 easyhg_authfile_imports_ok = False
Chris@433 63
Chris@431 64
Chris@452 65 class EasyHgAuthStore(object):
Chris@431 66
Chris@452 67 ui = None
Chris@431 68
Chris@452 69 remote_url = ''
Chris@451 70
Chris@452 71 use_auth_file = False
Chris@427 72
Chris@452 73 auth_config = None
Chris@452 74 auth_file = ''
Chris@452 75 auth_key = ''
Chris@452 76 auth_cipher = None
Chris@434 77
Chris@452 78 user = ''
Chris@452 79 passwd = ''
Chris@452 80
Chris@452 81 remember = False
Chris@452 82
Chris@452 83 def __init__(self, ui, url, user, passwd):
Chris@452 84
Chris@452 85 self.ui = ui
Chris@452 86 self.remote_url = url
Chris@452 87
Chris@452 88 self.user = user
Chris@452 89 self.passwd = passwd
Chris@452 90
Chris@452 91 self.auth_key = self.ui.config('easyhg', 'authkey')
Chris@452 92 self.auth_file = self.ui.config('easyhg', 'authfile')
Chris@452 93
Chris@452 94 self.use_auth_file = (easyhg_authfile_imports_ok and
Chris@452 95 self.auth_key and self.auth_file)
Chris@452 96
Chris@452 97 if self.use_auth_file:
Chris@452 98 self.auth_cipher = AES.new(self.auth_key, AES.MODE_CBC)
Chris@452 99 self.auth_file = os.path.expanduser(self.auth_file)
Chris@452 100 self.load_auth_data()
Chris@452 101
Chris@452 102 def save(self):
Chris@452 103 if self.use_auth_file:
Chris@452 104 self.save_auth_data()
Chris@452 105
Chris@452 106 def encrypt(self, text):
Chris@452 107 iv = os.urandom(12)
Chris@452 108 text = '%s.%d.%s.easyhg' % (base64.b64encode(iv), len(text), text)
Chris@452 109 text += (16 - (len(text) % 16)) * ' '
Chris@452 110 ctext = base64.b64encode(self.auth_cipher.encrypt(text))
Chris@452 111 return ctext
Chris@452 112
Chris@452 113 def decrypt(self, ctext):
Chris@452 114 text = self.auth_cipher.decrypt(base64.b64decode(ctext))
Chris@452 115 (iv, d, text) = text.partition('.')
Chris@452 116 (tlen, d, text) = text.partition('.')
Chris@448 117 try:
Chris@452 118 return text[0:int(tlen)]
Chris@448 119 except:
Chris@452 120 self.ui.write("failed to decrypt/convert cached data!")
Chris@452 121 return ''
Chris@452 122
Chris@452 123 def argless_url(self):
Chris@452 124 parsed = urlparse.urlparse(self.remote_url)
Chris@452 125 return "%s://%s%s" % (parsed.scheme, parsed.netloc, parsed.path)
Chris@452 126
Chris@452 127 def pathless_url(self):
Chris@452 128 parsed = urlparse.urlparse(self.remote_url)
Chris@452 129 return "%s://%s" % (parsed.scheme, parsed.netloc)
Chris@452 130
Chris@452 131 def load_config(self):
Chris@452 132 self.auth_config = ConfigParser.RawConfigParser()
Chris@452 133 fp = None
Chris@452 134 try:
Chris@452 135 fp = open(self.auth_file)
Chris@452 136 except:
Chris@452 137 self.ui.write("unable to read authfile %s, ignoring\n" % self.auth_file)
Chris@452 138 return
Chris@452 139 self.auth_config.readfp(fp)
Chris@452 140 fp.close()
Chris@452 141
Chris@452 142 def save_config(self):
Chris@452 143 ofp = None
Chris@452 144 try:
Chris@452 145 ofp = open(self.auth_file, 'w')
Chris@452 146 except:
Chris@452 147 self.ui.write("failed to open authfile %s for writing\n" % self.auth_file)
Chris@448 148 raise
Chris@452 149 if platform.system() != 'Windows':
Chris@452 150 try:
Chris@452 151 os.fchmod(ofp.fileno(), stat.S_IRUSR | stat.S_IWUSR)
Chris@452 152 except:
Chris@452 153 ofp.close()
Chris@452 154 self.ui.write("failed to set permissions on authfile %s\n" % self.auth_file)
Chris@452 155 raise
Chris@452 156 self.auth_config.write(ofp)
Chris@452 157 ofp.close()
Chris@434 158
Chris@452 159 def get_from_config(self, sect, key):
Chris@452 160 data = None
Chris@452 161 try:
Chris@452 162 data = self.auth_config.get(sect, key)
Chris@452 163 except (ConfigParser.NoOptionError, ConfigParser.NoSectionError):
Chris@452 164 pass
Chris@452 165 return data
Chris@436 166
Chris@452 167 def get_boolean_from_config(self, sect, key, deflt):
Chris@452 168 data = deflt
Chris@452 169 try:
Chris@452 170 data = self.auth_config.getboolean(sect, key)
Chris@452 171 except (ConfigParser.NoOptionError, ConfigParser.NoSectionError):
Chris@452 172 pass
Chris@452 173 return data
Chris@436 174
Chris@452 175 def set_to_config(self, sect, key, data):
Chris@452 176 if not self.auth_config.has_section(sect):
Chris@452 177 self.auth_config.add_section(sect)
Chris@452 178 self.auth_config.set(sect, key, data)
Chris@436 179
Chris@452 180 def remote_key(self, url, user):
Chris@452 181 # generate a "safe-for-config-file" key representing uri+user
Chris@452 182 self.ui.write('generating remote_key for url %s and user %s\n' % (url, user))
Chris@452 183 s = '%s@@%s' % (url, user)
Chris@452 184 h = hashlib.sha1()
Chris@452 185 h.update(self.auth_key)
Chris@452 186 h.update(s)
Chris@452 187 hx = h.hexdigest()
Chris@452 188 return hx
Chris@452 189
Chris@452 190 def remote_user_key(self):
Chris@452 191 return self.remote_key(self.argless_url(), '')
Chris@452 192
Chris@452 193 def remote_passwd_key(self):
Chris@452 194 return self.remote_key(self.pathless_url(), self.user)
Chris@452 195
Chris@452 196 def load_auth_data(self):
Chris@452 197
Chris@452 198 self.load_config()
Chris@452 199 if not self.auth_config: return
Chris@452 200
Chris@452 201 self.remember = self.get_boolean_from_config(
Chris@452 202 'preferences', 'remember', False)
Chris@452 203
Chris@452 204 if not self.user:
Chris@452 205 d = self.get_from_config('user', self.remote_user_key())
Chris@452 206 if d:
Chris@452 207 self.user = self.decrypt(d)
Chris@452 208
Chris@452 209 if self.user:
Chris@452 210 d = self.get_from_config('auth', self.remote_passwd_key())
Chris@452 211 if d:
Chris@452 212 self.passwd = self.decrypt(d)
Chris@452 213
Chris@452 214 def save_auth_data(self):
Chris@452 215
Chris@452 216 if not self.auth_config: return
Chris@452 217
Chris@452 218 self.set_to_config('preferences', 'remember', self.remember)
Chris@452 219
Chris@452 220 self.ui.write('aiming to store details for user %s\n' % self.user)
Chris@452 221
Chris@452 222 if self.remember and self.user:
Chris@452 223 d = self.encrypt(self.user)
Chris@452 224 self.set_to_config('user', self.remote_user_key(), d)
Chris@452 225 else:
Chris@452 226 self.set_to_config('user', self.remote_user_key(), '')
Chris@452 227
Chris@452 228 if self.remember and self.user and self.passwd:
Chris@452 229 d = self.encrypt(self.passwd)
Chris@452 230 self.set_to_config('auth', self.remote_passwd_key(), d)
Chris@452 231 elif self.user:
Chris@452 232 self.set_to_config('auth', self.remote_passwd_key(), '')
Chris@452 233
Chris@452 234 self.save_config()
Chris@452 235
Chris@452 236 class EasyHgAuthDialog(object):
Chris@452 237
Chris@452 238 auth_store = None
Chris@452 239
Chris@452 240 def __init__(self, ui, url, user, passwd):
Chris@452 241 self.auth_store = EasyHgAuthStore(ui, url, user, passwd)
Chris@452 242
Chris@452 243 def ask(self):
Chris@452 244 dialog = QtGui.QDialog()
Chris@452 245 layout = QtGui.QGridLayout()
Chris@452 246 dialog.setLayout(layout)
Chris@452 247
Chris@452 248 layout.addWidget(QtGui.QLabel(_('<h3>Login required</h3><p>Please provide your login details for the repository at<br><code>%s</code>:') % self.auth_store.argless_url()), 0, 0, 1, 2)
Chris@452 249
Chris@452 250 user_field = QtGui.QLineEdit()
Chris@452 251 if self.auth_store.user: user_field.setText(self.auth_store.user)
Chris@452 252 layout.addWidget(QtGui.QLabel(_('User:')), 1, 0)
Chris@452 253 layout.addWidget(user_field, 1, 1)
Chris@452 254
Chris@452 255 passwd_field = QtGui.QLineEdit()
Chris@452 256 passwd_field.setEchoMode(QtGui.QLineEdit.Password)
Chris@452 257 if self.auth_store.passwd: passwd_field.setText(self.auth_store.passwd)
Chris@452 258 layout.addWidget(QtGui.QLabel(_('Password:')), 2, 0)
Chris@452 259 layout.addWidget(passwd_field, 2, 1)
Chris@452 260
Chris@452 261 user_field.connect(user_field, Qt.SIGNAL("textChanged(QString)"),
Chris@452 262 passwd_field, Qt.SLOT("clear()"))
Chris@452 263
Chris@452 264 remember_field = None
Chris@452 265 if self.auth_store.use_auth_file:
Chris@452 266 remember_field = QtGui.QCheckBox()
Chris@452 267 remember_field.setChecked(self.auth_store.remember)
Chris@452 268 remember_field.setText(_('Remember these details while EasyMercurial is running'))
Chris@452 269 layout.addWidget(remember_field, 3, 1)
Chris@452 270
Chris@452 271 bb = QtGui.QDialogButtonBox()
Chris@452 272 ok = bb.addButton(bb.Ok)
Chris@452 273 cancel = bb.addButton(bb.Cancel)
Chris@452 274 cancel.setDefault(False)
Chris@452 275 cancel.setAutoDefault(False)
Chris@452 276 ok.setDefault(True)
Chris@452 277 bb.connect(ok, Qt.SIGNAL("clicked()"), dialog, Qt.SLOT("accept()"))
Chris@452 278 bb.connect(cancel, Qt.SIGNAL("clicked()"), dialog, Qt.SLOT("reject()"))
Chris@452 279 layout.addWidget(bb, 4, 0, 1, 2)
Chris@452 280
Chris@452 281 dialog.setWindowTitle(_('EasyMercurial: Login'))
Chris@452 282 dialog.show()
Chris@452 283
Chris@452 284 if not self.auth_store.user:
Chris@452 285 user_field.setFocus(True)
Chris@452 286 elif not self.auth_store.passwd:
Chris@452 287 passwd_field.setFocus(True)
Chris@452 288 else:
Chris@452 289 ok.setFocus(True)
Chris@452 290
Chris@452 291 dialog.raise_()
Chris@452 292 ok = dialog.exec_()
Chris@452 293 if not ok:
Chris@452 294 raise util.Abort(_('password entry cancelled'))
Chris@452 295
Chris@452 296 self.auth_store.user = user_field.text()
Chris@452 297 self.auth_store.passwd = passwd_field.text()
Chris@452 298
Chris@452 299 if remember_field:
Chris@452 300 self.auth_store.remember = remember_field.isChecked()
Chris@452 301
Chris@452 302 self.auth_store.save()
Chris@452 303
Chris@452 304 return (self.auth_store.user, self.auth_store.passwd)
Chris@438 305
Chris@440 306
Chris@440 307 def uisetup(ui):
Chris@440 308 if not easyhg_pyqt_ok:
Chris@440 309 raise util.Abort(_('Failed to load PyQt4 module required by easyhg.py'))
Chris@440 310 global easyhg_qtapp
Chris@440 311 easyhg_qtapp = QtGui.QApplication([])
Chris@440 312
Chris@440 313 def monkeypatch_method(cls):
Chris@440 314 def decorator(func):
Chris@440 315 setattr(cls, func.__name__, func)
Chris@440 316 return func
Chris@440 317 return decorator
Chris@440 318
Chris@440 319 orig_find = passwordmgr.find_user_password
Chris@440 320
Chris@427 321 @monkeypatch_method(passwordmgr)
Chris@427 322 def find_user_password(self, realm, authuri):
Chris@427 323
Chris@427 324 if not self.ui.interactive():
Chris@427 325 return orig_find(self, realm, authuri)
Chris@427 326 if not easyhg_pyqt_ok:
Chris@427 327 return orig_find(self, realm, authuri)
Chris@427 328
Chris@427 329 authinfo = urllib2.HTTPPasswordMgrWithDefaultRealm.find_user_password(
Chris@427 330 self, realm, authuri)
Chris@427 331 user, passwd = authinfo
Chris@427 332
Chris@427 333 if user and passwd:
Chris@427 334 return orig_find(self, realm, authuri)
Chris@427 335
Chris@452 336 self.ui.write("want username and/or password for %s\n" % authuri)
Chris@427 337
Chris@452 338 dialog = EasyHgAuthDialog(self.ui, authuri, user, passwd)
Chris@427 339
Chris@452 340 (user, passwd) = dialog.ask()
Chris@433 341
Chris@436 342 self.add_password(realm, authuri, user, passwd)
Chris@427 343 return (user, passwd)
Chris@427 344
Chris@427 345