forked from libgit2/pygit2
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcallbacks.py
More file actions
505 lines (388 loc) · 15.4 KB
/
callbacks.py
File metadata and controls
505 lines (388 loc) · 15.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
# Copyright 2010-2021 The pygit2 contributors
#
# This file is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License, version 2,
# as published by the Free Software Foundation.
#
# In addition to the permissions in the GNU General Public License,
# the authors give you unlimited permission to link the compiled
# version of this file into combinations with other programs,
# and to distribute those combinations without any restriction
# coming from the use of this file. (The General Public License
# restrictions do apply in other respects; for example, they cover
# modification of the file, and distribution when not linked into
# a combined executable.)
#
# This file 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; see the file COPYING. If not, write to
# the Free Software Foundation, 51 Franklin Street, Fifth Floor,
# Boston, MA 02110-1301, USA.
"""
In this module we keep everything concerning callback. This is how it works,
with an example:
1. The pygit2 API calls libgit2, it passes a payload object
e.g. Remote.fetch calls git_remote_fetch
2. libgit2 calls Python callbacks
e.g. git_remote_fetch calls _transfer_progress_cb
3. Optionally, the Python callback may proxy to a user defined function
e.g. _transfer_progress_cb calls RemoteCallbacks.transfer_progress
4. The user defined function may return something on success, or raise an
exception on error, or raise the special Passthrough exception.
5. The callback may return in 3 different ways to libgit2:
- Returns GIT_OK on success.
- Returns GIT_PASSTHROUGH if the user defined function raised Passthrough,
this tells libgit2 to act as if this callback didn't exist in the first
place.
- Returns GIT_EUSER if another exception was raised, and keeps the exception
in the payload to be re-raised later.
6. libgit2 returns to the pygit2 API, with an error code
e.g. git_remote_fetch returns to Remote.fetch
7. The pygit2 API will:
- Return something on success.
- Raise the original exception if libgit2 returns GIT_EUSER
- Raise another exception if libgit2 returns another error code
The payload object is passed all the way, so pygit2 API can send information to
the inner user defined function, and this can send back results to the pygit2
API.
"""
# Standard Library
from contextlib import contextmanager
from functools import wraps
# pygit2
from ._pygit2 import Oid
from .errors import check_error, Passthrough
from .ffi import ffi, C
from .utils import maybe_string, to_bytes
#
# The payload is the way to pass information from the pygit2 API, through
# libgit2, to the Python callbacks. And back.
#
class Payload:
def __init__(self, **kw):
for key, value in kw.items():
setattr(self, key, value)
self._stored_exception = None
def check_error(self, error_code):
if error_code == C.GIT_EUSER:
assert self._stored_exception is not None
raise self._stored_exception
check_error(error_code)
class RemoteCallbacks(Payload):
"""Base class for pygit2 remote callbacks.
Inherit from this class and override the callbacks which you want to use
in your class, which you can then pass to the network operations.
For the credentials, you can either subclass and override the 'credentials'
method, or if it's a constant value, pass the value to the constructor,
e.g. RemoteCallbacks(credentials=credentials).
You can as well pass the certificate the same way, for example:
RemoteCallbacks(certificate=certificate).
"""
def __init__(self, credentials=None, certificate=None):
super().__init__()
if credentials is not None:
self.credentials = credentials
if certificate is not None:
self.certificate = certificate
def sideband_progress(self, string):
"""
Progress output callback. Override this function with your own
progress reporting function
Parameters:
string : str
Progress output from the remote.
"""
def credentials(self, url, username_from_url, allowed_types):
"""
Credentials callback. If the remote server requires authentication,
this function will be called and its return value used for
authentication. Override it if you want to be able to perform
authentication.
Returns: credential
Parameters:
url : str
The url of the remote.
username_from_url : str or None
Username extracted from the url, if any.
allowed_types : int
Credential types supported by the remote.
"""
raise Passthrough
def certificate_check(self, certificate, valid, host):
"""
Certificate callback. Override with your own function to determine
whether to accept the server's certificate.
Returns: True to connect, False to abort.
Parameters:
certificate : None
The certificate. It is currently always None while we figure out
how to represent it cross-platform.
valid : bool
Whether the TLS/SSH library thinks the certificate is valid.
host : str
The hostname we want to connect to.
"""
raise Passthrough
def transfer_progress(self, stats):
"""
Transfer progress callback. Override with your own function to report
transfer progress.
Parameters:
stats : TransferProgress
The progress up to now.
"""
def update_tips(self, refname, old, new):
"""
Update tips callback. Override with your own function to report
reference updates.
Parameters:
refname : str
The name of the reference that's being updated.
old : Oid
The reference's old value.
new : Oid
The reference's new value.
"""
def push_update_reference(self, refname, message):
"""
Push update reference callback. Override with your own function to
report the remote's acceptance or rejection of reference updates.
refname : str
The name of the reference (on the remote).
message : str
Rejection message from the remote. If None, the update was accepted.
"""
#
# The context managers below wrap the calls to libgit2 functions, which them in
# turn call to callbacks defined later in this module. These context managers
# are used in the pygit2 API, see for instance remote.py
#
@contextmanager
def git_clone_options(payload, opts=None):
if opts is None:
opts = ffi.new('git_clone_options *')
C.git_clone_options_init(opts, C.GIT_CLONE_OPTIONS_VERSION)
handle = ffi.new_handle(payload)
# Plug callbacks
if payload.repository:
opts.repository_cb = C._repository_create_cb
opts.repository_cb_payload = handle
if payload.remote:
opts.remote_cb = C._remote_create_cb
opts.remote_cb_payload = handle
# Give back control
payload._stored_exception = None
payload.clone_options = opts
yield payload
@contextmanager
def git_fetch_options(payload, opts=None):
if payload is None:
payload = RemoteCallbacks()
if opts is None:
opts = ffi.new('git_fetch_options *')
C.git_fetch_init_options(opts, C.GIT_FETCH_OPTIONS_VERSION)
# Plug callbacks
opts.callbacks.sideband_progress = C._sideband_progress_cb
opts.callbacks.transfer_progress = C._transfer_progress_cb
opts.callbacks.update_tips = C._update_tips_cb
opts.callbacks.credentials = C._credentials_cb
opts.callbacks.certificate_check = C._certificate_cb
# Payload
handle = ffi.new_handle(payload)
opts.callbacks.payload = handle
# Give back control
payload.fetch_options = opts
payload._stored_exception = None
yield payload
@contextmanager
def git_push_options(payload, opts=None):
if payload is None:
payload = RemoteCallbacks()
opts = ffi.new('git_push_options *')
C.git_push_init_options(opts, C.GIT_PUSH_OPTIONS_VERSION)
# Plug callbacks
opts.callbacks.sideband_progress = C._sideband_progress_cb
opts.callbacks.transfer_progress = C._transfer_progress_cb
opts.callbacks.update_tips = C._update_tips_cb
opts.callbacks.credentials = C._credentials_cb
opts.callbacks.certificate_check = C._certificate_cb
opts.callbacks.push_update_reference = C._push_update_reference_cb
# Payload
handle = ffi.new_handle(payload)
opts.callbacks.payload = handle
# Give back control
payload.push_options = opts
payload._stored_exception = None
yield payload
@contextmanager
def git_remote_callbacks(payload):
if payload is None:
payload = RemoteCallbacks()
cdata = ffi.new('git_remote_callbacks *')
C.git_remote_init_callbacks(cdata, C.GIT_REMOTE_CALLBACKS_VERSION)
# Plug callbacks
cdata.credentials = C._credentials_cb
cdata.update_tips = C._update_tips_cb
# Payload
handle = ffi.ne
8000
w_handle(payload)
cdata.payload = handle
# Give back control
payload._stored_exception = None
payload.remote_callbacks = cdata
yield payload
#
# C callbacks
#
# These functions are called by libgit2. They cannot raise execptions, since
# they return to libgit2, they can only send back error codes.
#
# They cannot be overriden, but sometimes the only thing these functions do is
# to proxy the call to a user defined function. If user defined functions
# raises an exception, the callback must store it somewhere and return
# GIT_EUSER to libgit2, then the outer Python code will be able to reraise the
# exception.
#
def libgit2_callback(f):
@wraps(f)
def wrapper(*args):
data = ffi.from_handle(args[-1])
args = args[:-1] + (data,)
try:
return f(*args)
except Passthrough:
# A user defined callback can raise Passthrough to decline to act;
# then libgit2 will behave as if there was no callback set in the
# first place.
return C.GIT_PASSTHROUGH
except Exception as e:
# Keep the exception to be re-raised later, and inform libgit2 that
# the user defined callback has failed.
data._stored_exception = e
return C.GIT_EUSER
return ffi.def_extern()(wrapper)
@libgit2_callback
def _certificate_cb(cert_i, valid, host, data):
# We want to simulate what should happen if libgit2 supported pass-through
# for this callback. For SSH, 'valid' is always False, because it doesn't
# look at known_hosts, but we do want to let it through in order to do what
# libgit2 would if the callback were not set.
try:
is_ssh = cert_i.cert_type == C.GIT_CERT_HOSTKEY_LIBSSH2
# python's parsing is deep in the libraries and assumes an OpenSSL-owned cert
val = data.certificate_check(None, bool(valid), ffi.string(host))
if not val:
return C.GIT_ECERTIFICATE
except Passthrough:
if is_ssh:
return 0
elif valid:
return 0
else:
return C.GIT_ECERTIFICATE
return 0
@libgit2_callback
def _credentials_cb(cred_out, url, username, allowed, data):
credentials = getattr(data, 'credentials', None)
if not credentials:
return 0
ccred = get_credentials(credentials, url, username, allowed)
cred_out[0] = ccred[0]
return 0
@libgit2_callback
def _push_update_reference_cb(ref, msg, data):
push_update_reference = getattr(data, 'push_update_reference', None)
if not push_update_reference:
return 0
refname = ffi.string(ref)
message = maybe_string(msg)
push_update_reference(refname, message)
return 0
@libgit2_callback
def _remote_create_cb(remote_out, repo, name, url, data):
from .repository import Repository
remote = data.remote(Repository._from_c(repo, False), ffi.string(name), ffi.string(url))
remote_out[0] = remote._remote
# we no longer own the C object
remote._remote = ffi.NULL
return 0
@libgit2_callback
def _repository_create_cb(repo_out, path, bare, data):
repository = data.repository(ffi.string(path), bare != 0)
# we no longer own the C object
repository._disown()
repo_out[0] = repository._repo
return 0
@libgit2_callback
def _sideband_progress_cb(string, length, data):
progress = getattr(data, 'progress', None)
if not progress:
return 0
s = ffi.string(string, length).decode('utf-8')
progress(s)
return 0
@libgit2_callback
def _transfer_progress_cb(stats_ptr, data):
from .remote import TransferProgress
transfer_progress = getattr(data, 'transfer_progress', None)
if not transfer_progress:
return 0
transfer_progress(TransferProgress(stats_ptr))
return 0
@libgit2_callback
def _update_tips_cb(refname, a, b, data):
update_tips = getattr(data, 'update_tips', None)
if not update_tips:
return 0
s = maybe_string(refname)
a = Oid(raw=bytes(ffi.buffer(a)[:]))
b = Oid(raw=bytes(ffi.buffer(b)[:]))
update_tips(s, a, b)
return 0
#
# Other functions, used above.
#
def get_credentials(fn, url, username, allowed):
"""Call fn and return the credentials object.
"""
url_str = maybe_string(url)
username_str = maybe_string(username)
creds = fn(url_str, username_str, allowed)
credential_type = getattr(creds, 'credential_type', None)
credential_tuple = getattr(creds, 'credential_tuple', None)
if not credential_type or not credential_tuple:
raise TypeError("credential does not implement interface")
cred_type = credential_type
if not (allowed & cred_type):
raise TypeError("invalid credential type")
ccred = ffi.new('git_credential **')
if cred_type == C.GIT_CREDENTIAL_USERPASS_PLAINTEXT:
name, passwd = credential_tuple
err = C.git_credential_userpass_plaintext_new(ccred, to_bytes(name),
to_bytes(passwd))
elif cred_type == C.GIT_CREDENTIAL_SSH_KEY:
name, pubkey, privkey, passphrase = credential_tuple
name = to_bytes(name)
if pubkey is None and privkey is None:
err = C.git_credential_ssh_key_from_agent(ccred, name)
else:
err = C.git_credential_ssh_key_new(ccred, name, to_bytes(pubkey),
to_bytes(privkey),
to_bytes(passphrase))
elif cred_type == C.GIT_CREDENTIAL_USERNAME:
name, = credential_tuple
err = C.git_credential_username_new(ccred, to_bytes(name))
elif cred_type == C.GIT_CREDENTIAL_SSH_MEMORY:
name, pubkey, privkey, passphrase = credential_tuple
if pubkey is None and privkey is None:
raise TypeError("SSH keys from memory are empty")
err = C.git_credential_ssh_key_memory_new(ccred, to_bytes(name),
to_bytes(pubkey), to_bytes(privkey),
to_bytes(passphrase))
else:
raise TypeError("unsupported credential type")
check_error(err)
return ccred