This is an archive of the discontinued Mercurial Phabricator instance.

Differential D3649

serve: add option print-url
ClosedPublic

Authored by nspanti-logilab on May 24 2018, 9:28 AM.
Tags
  • Restricted Project
Subscribers
admin, • KelvinTot, av6 and 2 others

Details

Reviewers
durin42
Group Reviewers
hg-reviewers
Commits
rHGaea29e81753a: serve: add option print-url
Summary

It can be used to open hgweb in a web browser. Example :
xdg-open "hg serve --print-url".

Diff Detail

Repository
rHG Mercurial
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

nspanti-logilab added a project: Restricted Project.May 24 2018, 9:40 AM
durin42 accepted this revision.May 31 2018, 3:14 PM
This revision is now accepted and ready to land.May 31 2018, 3:14 PM
Closed by commit rHGaea29e81753a: serve: add option print-url (authored by nspanti-logilab). · Explain WhyJun 1 2018, 2:00 AM
This revision was automatically updated to reflect the committed changes.
yuja added a subscriber: yuja.Jun 1 2018, 10:47 PM
('t', 'templates', '', _('web templates to use'), _('TEMPLATE')),
('', 'style', '', _('template style to use'), _('STYLE')),
('6', 'ipv6', None, _('use IPv6 in addition to IPv4')),
  • ('', 'certificate', '', _('SSL certificate file'), _('FILE'))]

+ ('', 'certificate', '', _('SSL certificate file'), _('FILE')),
+ ('', 'print-url', None, _('start and print only the URL'))]

 + subrepoopts,
_('[OPTION]...'),
optionalrepo=True)

@@ -4798,6 +4799,10 @@

opts = pycompat.byteskwargs(opts)
if opts["stdio"] and opts["cmdserver"]:
    raise error.Abort(_("cannot use --stdio with --cmdserver"))

+ if opts["print_url"] and ui.verbose:
+ raise error.Abort(_("cannot use --print-url with --verbose"))
+ if opts["print_url"]:
+ opts['daemon'] = True

It's surprising that hg serve --print-url spawns a daemon process!

av6 added a subscriber: av6.Jun 2 2018, 8:42 AM

Merits another patch with some simple tests.

• KelvinTot added a subscriber: • KelvinTot.Jun 3 2018, 2:48 PM
This comment was removed by admin.
nspanti-logilab added a comment.Jun 4 2018, 5:34 AM
In D3649#57835, @yuja wrote:

It's surprising that hg serve --print-url spawns a daemon process!

If it does not launch a daemon process, the procress caller (xdg-open, midori, firefox, etc.) waits the end of the stream to launch, so it waits that the hg serve procress ends!

In D3649#57838, @av6 wrote:

Merits another patch with some simple tests.

Could you describe tests that you would like?

@KelvinTot : Could you write in English or French, please?

yuja added a comment.Jun 4 2018, 8:19 AM

(resend because I forgot to remove the Phab shit, sorry for the noise.)

> It's surprising that `hg serve --print-url` spawns a daemon process!
If it does not launch a daemon process, the procress caller (`xdg-open`, `midori`, `firefox`, etc.) waits the end of the stream to launch, so it waits that the `hg serve` procress ends!

You can just run hg serve -d --print-url.

The option could be named as --daemon-print-url if we needed such big
red switch, but I don't think that makes sense.

av6 added a comment.Jun 4 2018, 8:43 AM
In D3649#57901, @nspanti-logilab wrote:

Could you describe tests that you would like?

For example, some that check that url is correct and is printed on stdout and not stderr, maybe also that it is printed when --port is specified (unlike "listening at" line). Doesn't have to be a lot, just some usage of this new command line switch in the tests. For inspiration, there are examples in test-hgwebdir.t, lines 1414 and 1431.

admin added a subscriber: admin.Jun 4 2018, 9:05 AM
durin42 added a comment.Jun 7 2018, 11:20 AM
In D3649#57906, @yuja wrote:

(resend because I forgot to remove the Phab shit, sorry for the noise.)

> It's surprising that `hg serve --print-url` spawns a daemon process!
If it does not launch a daemon process, the procress caller (`xdg-open`, `midori`, `firefox`, etc.) waits the end of the stream to launch, so it waits that the `hg serve` procress ends!

You can just run hg serve -d --print-url.
The option could be named as --daemon-print-url if we needed such big
red switch, but I don't think that makes sense.

On reflection I agree, it's a little too magical that --print-url daemonizes. Let's get a follow-up that doesn't do that, especially since -d is so easy to type.

(I'd probably often use --print-url without --daemon, FWIW)

Revision Contents
Changeset List

Diff 8945

mercurial/commands.py

('', 'webdir-conf', '', _('name of the hgweb config file (DEPRECATED)'), ('', 'webdir-conf', '', _('name of the hgweb config file (DEPRECATED)'),
_('FILE')), _('FILE')),
('', 'pid-file', '', _('name of file to write process ID to'), _('FILE')), ('', 'pid-file', '', _('name of file to write process ID to'), _('FILE')),
('', 'stdio', None, _('for remote clients (ADVANCED)')), ('', 'stdio', None, _('for remote clients (ADVANCED)')),
('', 'cmdserver', '', _('for remote clients (ADVANCED)'), _('MODE')), ('', 'cmdserver', '', _('for remote clients (ADVANCED)'), _('MODE')),
('t', 'templates', '', _('web templates to use'), _('TEMPLATE')), ('t', 'templates', '', _('web templates to use'), _('TEMPLATE')),
('', 'style', '', _('template style to use'), _('STYLE')), ('', 'style', '', _('template style to use'), _('STYLE')),
('6', 'ipv6', None, _('use IPv6 in addition to IPv4')), ('6', 'ipv6', None, _('use IPv6 in addition to IPv4')),
('', 'certificate', '', _('SSL certificate file'), _('FILE'))] ('', 'certificate', '', _('SSL certificate file'), _('FILE')),
('', 'print-url', None, _('start and print only the URL'))]
+ subrepoopts, + subrepoopts,
_('[OPTION]...'), _('[OPTION]...'),
optionalrepo=True) optionalrepo=True)
def serve(ui, repo, **opts): def serve(ui, repo, **opts):
"""start stand-alone webserver """start stand-alone webserver
Start a local HTTP repository browser and pull server. You can use Start a local HTTP repository browser and pull server. You can use
this for ad-hoc sharing and browsing of repositories. It is this for ad-hoc sharing and browsing of repositories. It is
number it uses. number it uses.
Returns 0 on success. Returns 0 on success.
""" """
opts = pycompat.byteskwargs(opts) opts = pycompat.byteskwargs(opts)
if opts["stdio"] and opts["cmdserver"]: if opts["stdio"] and opts["cmdserver"]:
raise error.Abort(_("cannot use --stdio with --cmdserver")) raise error.Abort(_("cannot use --stdio with --cmdserver"))
if opts["print_url"] and ui.verbose:
raise error.Abort(_("cannot use --print-url with --verbose"))
if opts["print_url"]:
opts['daemon'] = True
if opts["stdio"]: if opts["stdio"]:
if repo is None: if repo is None:
raise error.RepoError(_("there is no Mercurial repository here" raise error.RepoError(_("there is no Mercurial repository here"
" (.hg not found)")) " (.hg not found)"))
s = wireprotoserver.sshserver(ui, repo) s = wireprotoserver.sshserver(ui, repo)
s.serve_forever() s.serve_forever()

mercurial/hgweb/__init__.py

self.ui = ui self.ui = ui
self.app = app self.app = app
self.opts = opts self.opts = opts
def init(self): def init(self):
procutil.setsignalhandler() procutil.setsignalhandler()
self.httpd = server.create_server(self.ui, self.app) self.httpd = server.create_server(self.ui, self.app)
if self.opts['port'] and not self.ui.verbose: if (self.opts['port'] and
not self.ui.verbose and
not self.opts['print_url']):
return return
if self.httpd.prefix: if self.httpd.prefix:
prefix = self.httpd.prefix.strip('/') + '/' prefix = self.httpd.prefix.strip('/') + '/'
else: else:
prefix = '' prefix = ''
port = r':%d' % self.httpd.port port = r':%d' % self.httpd.port
if port == r':80': if port == r':80':
port = r'' port = r''
bindaddr = self.httpd.addr bindaddr = self.httpd.addr
if bindaddr == r'0.0.0.0': if bindaddr == r'0.0.0.0':
bindaddr = r'*' bindaddr = r'*'
elif r':' in bindaddr: # IPv6 elif r':' in bindaddr: # IPv6
bindaddr = r'[%s]' % bindaddr bindaddr = r'[%s]' % bindaddr
fqaddr = self.httpd.fqaddr fqaddr = self.httpd.fqaddr
if r':' in fqaddr: if r':' in fqaddr:
fqaddr = r'[%s]' % fqaddr fqaddr = r'[%s]' % fqaddr
url = 'http://%s%s/%s' % (
pycompat.sysbytes(fqaddr), pycompat.sysbytes(port), prefix)
if self.opts['print_url']:
self.ui.write('%s\n' % url)
else:
if self.opts['port']: if self.opts['port']:
write = self.ui.status write = self.ui.status
else: else:
write = self.ui.write write = self.ui.write
write(_('listening at http://%s%s/%s (bound to %s:%d)\n') % write(_('listening at %s (bound to %s:%d)\n') %
(pycompat.sysbytes(fqaddr), pycompat.sysbytes(port), (url, pycompat.sysbytes(bindaddr), self.httpd.port))
prefix, pycompat.sysbytes(bindaddr), self.httpd.port))
self.ui.flush() # avoid buffering of status message self.ui.flush() # avoid buffering of status message
def run(self): def run(self):
self.httpd.serve_forever() self.httpd.serve_forever()
def createapp(baseui, repo, webconf): def createapp(baseui, repo, webconf):
if webconf: if webconf:
return hgwebdir_mod.hgwebdir(webconf, baseui=baseui) return hgwebdir_mod.hgwebdir(webconf, baseui=baseui)
else: else:
if not repo: if not repo:
raise error.RepoError(_("there is no Mercurial repository" raise error.RepoError(_("there is no Mercurial repository"
" here (.hg not found)")) " here (.hg not found)"))
return hgweb_mod.hgweb(repo, baseui=baseui) return hgweb_mod.hgweb(repo, baseui=baseui)

tests/test-completion.t

--hidden --hidden
--ipv6 --ipv6
--name --name
--noninteractive --noninteractive
--pager --pager
--pid-file --pid-file
--port --port
--prefix --prefix
--print-url
--profile --profile
--quiet --quiet
--repository --repository
--stdio --stdio
--style --style
--subrepos --subrepos
--templates --templates
--time --time
export: bookmark, output, switch-parent, rev, text, git, binary, nodates, template export: bookmark, output, switch-parent, rev, text, git, binary, nodates, template
forget: interactive, include, exclude, dry-run forget: interactive, include, exclude, dry-run
init: ssh, remotecmd, insecure init: ssh, remotecmd, insecure
log: follow, follow-first, date, copies, keyword, rev, line-range, removed, only-merges, user, only-branch, branch, prune, patch, git, limit, no-merges, stat, graph, style, template, include, exclude log: follow, follow-first, date, copies, keyword, rev, line-range, removed, only-merges, user, only-branch, branch, prune, patch, git, limit, no-merges, stat, graph, style, template, include, exclude
merge: force, rev, preview, abort, tool merge: force, rev, preview, abort, tool
pull: update, force, rev, bookmark, branch, ssh, remotecmd, insecure pull: update, force, rev, bookmark, branch, ssh, remotecmd, insecure
push: force, rev, bookmark, branch, new-branch, pushvars, ssh, remotecmd, insecure push: force, rev, bookmark, branch, new-branch, pushvars, ssh, remotecmd, insecure
remove: after, force, subrepos, include, exclude, dry-run remove: after, force, subrepos, include, exclude, dry-run
serve: accesslog, daemon, daemon-postexec, errorlog, port, address, prefix, name, web-conf, webdir-conf, pid-file, stdio, cmdserver, templates, style, ipv6, certificate, subrepos serve: accesslog, daemon, daemon-postexec, errorlog, port, address, prefix, name, web-conf, webdir-conf, pid-file, stdio, cmdserver, templates, style, ipv6, certificate, print-url, subrepos
status: all, modified, added, removed, deleted, clean, unknown, ignored, no-status, terse, copies, print0, rev, change, include, exclude, subrepos, template status: all, modified, added, removed, deleted, clean, unknown, ignored, no-status, terse, copies, print0, rev, change, include, exclude, subrepos, template
summary: remote summary: remote
update: clean, check, merge, date, rev, tool update: clean, check, merge, date, rev, tool
addremove: similarity, subrepos, include, exclude, dry-run addremove: similarity, subrepos, include, exclude, dry-run
archive: no-decode, prefix, rev, type, subrepos, include, exclude archive: no-decode, prefix, rev, type, subrepos, include, exclude
backout: merge, commit, no-commit, parent, rev, edit, tool, include, exclude, message, logfile, date, user backout: merge, commit, no-commit, parent, rev, edit, tool, include, exclude, message, logfile, date, user
bisect: reset, good, bad, skip, extend, command, noupdate bisect: reset, good, bad, skip, extend, command, noupdate
bookmarks: force, rev, delete, rename, inactive, template bookmarks: force, rev, delete, rename, inactive, template