Mercurial > hg
comparison mercurial/url.py @ 29589:486de14eb394
url: add distribution and version to user-agent request header (BC)
As a server operator, I've always wanted to know what Mercurial
version clients are running so I can track version adoption and
make informed decisions about which versions of Mercurial to
support in extensions. Unfortunately, there is no easy way to discern
this today: the best you can do is look for high-level feature usage
(e.g. bundle2) or sniff capabilities from bundle2 commands. And these
things aren't changed frequently enough to tell you anything that
interesting.
Nearly every piece of software talking HTTP sends its version in
the user agent. This includes web browsers, curl, and even Git.
This patch adds the distribution name and version to the user-agent
HTTP request header. We choose "Mercurial" for the distribution
name because that seems appropriate. The version string comes
from __version__.
The value is inside parenthesis for a few reasons:
* The version *may* contain spaces
* Alternate forms like "Mercurial/<version>" imply structure and
since the user agent should not be used by servers for protocol
or feature negotiation/detection, we don't want to even give the
illusion that the value should be parsed. A free form field is
the most hostile to parsing.
Flagging the patch as BC so it shows up in release notes. This
change should be backwards compatible. But I wouldn't be surprised if
a server somewhere is filtering on the exact old user agent string. So
I want to make noise about this change.
author | Gregory Szorc <gregory.szorc@gmail.com> |
---|---|
date | Thu, 14 Jul 2016 19:16:46 -0700 |
parents | 0c741fd6158a |
children | e3dc96834126 |
comparison
equal
deleted
inserted
replaced
29588:1bb94666b9fc | 29589:486de14eb394 |
---|---|
503 handlers.extend((httpbasicauthhandler(passmgr), | 503 handlers.extend((httpbasicauthhandler(passmgr), |
504 httpdigestauthhandler(passmgr))) | 504 httpdigestauthhandler(passmgr))) |
505 handlers.extend([h(ui, passmgr) for h in handlerfuncs]) | 505 handlers.extend([h(ui, passmgr) for h in handlerfuncs]) |
506 opener = urlreq.buildopener(*handlers) | 506 opener = urlreq.buildopener(*handlers) |
507 | 507 |
508 # 1.0 here is the _protocol_ version | 508 # The user agent should should *NOT* be used by servers for e.g. |
509 opener.addheaders = [('User-agent', 'mercurial/proto-1.0')] | 509 # protocol detection or feature negotiation: there are other |
510 # facilities for that. | |
511 # | |
512 # "mercurial/proto-1.0" was the original user agent string and | |
513 # exists for backwards compatibility reasons. | |
514 # | |
515 # The "(Mercurial %s)" string contains the distribution | |
516 # name and version. Other client implementations should choose their | |
517 # own distribution name. Since servers should not be using the user | |
518 # agent string for anything, clients should be able to define whatever | |
519 # user agent they deem appropriate. | |
520 agent = 'mercurial/proto-1.0 (Mercurial %s)' % util.version() | |
521 opener.addheaders = [('User-agent', agent)] | |
510 opener.addheaders.append(('Accept', 'application/mercurial-0.1')) | 522 opener.addheaders.append(('Accept', 'application/mercurial-0.1')) |
511 return opener | 523 return opener |
512 | 524 |
513 def open(ui, url_, data=None): | 525 def open(ui, url_, data=None): |
514 u = util.url(url_) | 526 u = util.url(url_) |