Mercurial > public > mercurial-scm > hg
comparison mercurial/httppeer.py @ 37832:6169d95dce3b stable
httppeer: detect redirect to URL without query string (issue5860)
197d10e157ce subtly changed the HTTP peer's handling of HTTP redirects.
Before that changeset, we instantiated an HTTP peer instance and
performed the capabilities lookup with that instance. The old code had
the following relevant properties:
1) The HTTP request layer would automatically follow HTTP redirects.
2) An encountered HTTP redirect would update a peer instance variable
pointing to the repo URL.
3) The peer would automagically perform a "capabilities" command
request if a caller requested capabilities but capabilities were
not yet defined.
The first HTTP request issued by a peer is for ?cmd=capabilities. If
the server responds with an HTTP redirect to a ?cmd=capabilities URL,
the HTTP request layer automatically followed it, retrieved a valid
capabilities response, and the peer's base URL was updated
automatically so subsequent requests used the proper URL. In other
words, things "just worked."
In the case where the server redirected to a URL without the
?cmd=capabilities query string, the HTTP request layer would follow
the redirect and likely encounter HTML. The peer's base URL would be
updated and the unexpected Content-Type would raise a RepoError. We
would catch RepoError and immediately call between() (testing the case
for pre 0.9.1 servers not supporting the "capabilities" command). e.g.
try:
inst._fetchcaps()
except error.RepoError:
inst.between([(nullid, nullid)])
between() would eventually call into _callstream(). And _callstream()
made a call to self.capable('httpheader'). capable() would call
self.capabilities(), which would see that no capabilities were set
(because HTML was returned for that request) and call the "capabilities"
command to fetch capabilities. Because the base URL had been updated
from the redirect, this 2nd "capabilities" command would succeed and
the client would immediately call "between," which would also succeed.
The legacy handshake succeeded. Only because "capabilities" was
successfully executed as a side effect did the peer recognize that it
was talking to a modern server. In other words, this all appeared to
work accidentally.
After 197d10e157ce, we stopped calling the "capabilities" command on
the peer instance. Instead, we made the request via a low-level opener,
detected the redirect as part of response handling code, and passed the
redirected URL into the constructed peer instance.
For cases where the redirected URL included the query string, this
"just worked." But for cases where the redirected URL stripped the query
string, we threw RepoError and because we removed the "between" handshake
fallback, we fell through to the "is a static HTTP repo" check and
performed an HTTP request for .hg/requires.
While 197d10e157ce was marked as backwards incompatible, the only
intended backwards incompatible behavior was not performing the
"between" fallback. It was not realized that the "between" command
had the side-effect of recovering from an errant redirect that
dropped the query string.
This commit restores the previous behavior and allows clients to
handle a redirect that drops the query string. In the case where
the request is redirected and the query string is dropped, we raise
a special case of RepoError. We then catch this special exception in
the handshake code and perform another "capabilities" request against
the redirected URL. If that works, all is well. Otherwise, we fall back
to the "is a static HTTP repo" check.
The new code is arguably better than before 197d10e157ce, as it is
explicit about the expected behavior and we avoid performing a
"between" request, saving a server round trip.
Differential Revision: https://phab.mercurial-scm.org/D3433
author | Gregory Szorc <gregory.szorc@gmail.com> |
---|---|
date | Mon, 30 Apr 2018 15:32:11 -0700 |
parents | 856f381ad74b |
children | f9dc1d5b676b aac4be30e250 |
comparison
equal
deleted
inserted
replaced
37831:387af9e5df70 | 37832:6169d95dce3b |
---|---|
326 # Insert error handlers for common I/O failures. | 326 # Insert error handlers for common I/O failures. |
327 _wraphttpresponse(res) | 327 _wraphttpresponse(res) |
328 | 328 |
329 return res | 329 return res |
330 | 330 |
331 class RedirectedRepoError(error.RepoError): | |
332 def __init__(self, msg, respurl): | |
333 super(RedirectedRepoError, self).__init__(msg) | |
334 self.respurl = respurl | |
335 | |
331 def parsev1commandresponse(ui, baseurl, requrl, qs, resp, compressible, | 336 def parsev1commandresponse(ui, baseurl, requrl, qs, resp, compressible, |
332 allowcbor=False): | 337 allowcbor=False): |
333 # record the url we got redirected to | 338 # record the url we got redirected to |
339 redirected = False | |
334 respurl = pycompat.bytesurl(resp.geturl()) | 340 respurl = pycompat.bytesurl(resp.geturl()) |
335 if respurl.endswith(qs): | 341 if respurl.endswith(qs): |
336 respurl = respurl[:-len(qs)] | 342 respurl = respurl[:-len(qs)] |
343 qsdropped = False | |
344 else: | |
345 qsdropped = True | |
346 | |
337 if baseurl.rstrip('/') != respurl.rstrip('/'): | 347 if baseurl.rstrip('/') != respurl.rstrip('/'): |
348 redirected = True | |
338 if not ui.quiet: | 349 if not ui.quiet: |
339 ui.warn(_('real URL is %s\n') % respurl) | 350 ui.warn(_('real URL is %s\n') % respurl) |
340 | 351 |
341 try: | 352 try: |
342 proto = pycompat.bytesurl(resp.getheader(r'content-type', r'')) | 353 proto = pycompat.bytesurl(resp.getheader(r'content-type', r'')) |
349 | 360 |
350 # Pre 1.0 versions of Mercurial used text/plain and | 361 # Pre 1.0 versions of Mercurial used text/plain and |
351 # application/hg-changegroup. We don't support such old servers. | 362 # application/hg-changegroup. We don't support such old servers. |
352 if not proto.startswith('application/mercurial-'): | 363 if not proto.startswith('application/mercurial-'): |
353 ui.debug("requested URL: '%s'\n" % util.hidepassword(requrl)) | 364 ui.debug("requested URL: '%s'\n" % util.hidepassword(requrl)) |
354 raise error.RepoError( | 365 msg = _("'%s' does not appear to be an hg repository:\n" |
355 _("'%s' does not appear to be an hg repository:\n" | 366 "---%%<--- (%s)\n%s\n---%%<---\n") % ( |
356 "---%%<--- (%s)\n%s\n---%%<---\n") | 367 safeurl, proto or 'no content-type', resp.read(1024)) |
357 % (safeurl, proto or 'no content-type', resp.read(1024))) | 368 |
369 # Some servers may strip the query string from the redirect. We | |
370 # raise a special error type so callers can react to this specially. | |
371 if redirected and qsdropped: | |
372 raise RedirectedRepoError(msg, respurl) | |
373 else: | |
374 raise error.RepoError(msg) | |
358 | 375 |
359 try: | 376 try: |
360 subtype = proto.split('-', 1)[1] | 377 subtype = proto.split('-', 1)[1] |
361 | 378 |
362 # Unless we end up supporting CBOR in the legacy wire protocol, | 379 # Unless we end up supporting CBOR in the legacy wire protocol, |
431 | 448 |
432 def capabilities(self): | 449 def capabilities(self): |
433 return self._caps | 450 return self._caps |
434 | 451 |
435 # End of ipeercommands interface. | 452 # End of ipeercommands interface. |
436 | |
437 # look up capabilities only when needed | |
438 | 453 |
439 def _callstream(self, cmd, _compressible=False, **args): | 454 def _callstream(self, cmd, _compressible=False, **args): |
440 args = pycompat.byteskwargs(args) | 455 args = pycompat.byteskwargs(args) |
441 | 456 |
442 req, cu, qs = makev1commandrequest(self.ui, self._requestbuilder, | 457 req, cu, qs = makev1commandrequest(self.ui, self._requestbuilder, |
851 1024)) | 866 1024)) |
852 | 867 |
853 req, requrl, qs = makev1commandrequest(ui, requestbuilder, caps, | 868 req, requrl, qs = makev1commandrequest(ui, requestbuilder, caps, |
854 capable, url, 'capabilities', | 869 capable, url, 'capabilities', |
855 args) | 870 args) |
856 | |
857 resp = sendrequest(ui, opener, req) | 871 resp = sendrequest(ui, opener, req) |
858 | 872 |
859 respurl, ct, resp = parsev1commandresponse(ui, url, requrl, qs, resp, | 873 # The server may redirect us to the repo root, stripping the |
860 compressible=False, | 874 # ?cmd=capabilities query string from the URL. The server would likely |
861 allowcbor=advertisev2) | 875 # return HTML in this case and ``parsev1commandresponse()`` would raise. |
876 # We catch this special case and re-issue the capabilities request against | |
877 # the new URL. | |
878 # | |
879 # We should ideally not do this, as a redirect that drops the query | |
880 # string from the URL is arguably a server bug. (Garbage in, garbage out). | |
881 # However, Mercurial clients for several years appeared to handle this | |
882 # issue without behavior degradation. And according to issue 5860, it may | |
883 # be a longstanding bug in some server implementations. So we allow a | |
884 # redirect that drops the query string to "just work." | |
885 try: | |
886 respurl, ct, resp = parsev1commandresponse(ui, url, requrl, qs, resp, | |
887 compressible=False, | |
888 allowcbor=advertisev2) | |
889 except RedirectedRepoError as e: | |
890 req, requrl, qs = makev1commandrequest(ui, requestbuilder, caps, | |
891 capable, e.respurl, | |
892 'capabilities', args) | |
893 resp = sendrequest(ui, opener, req) | |
894 respurl, ct, resp = parsev1commandresponse(ui, url, requrl, qs, resp, | |
895 compressible=False, | |
896 allowcbor=advertisev2) | |
862 | 897 |
863 try: | 898 try: |
864 rawdata = resp.read() | 899 rawdata = resp.read() |
865 finally: | 900 finally: |
866 resp.close() | 901 resp.close() |