Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Setting to disable redirect file browser launch #4999

Merged
merged 3 commits into from
Oct 31, 2019
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 46 additions & 5 deletions notebook/notebookapp.py
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,7 @@ def init_settings(self, jupyter_app, kernel_manager, contents_manager,
base_url=base_url,
default_url=default_url,
template_path=template_path,
use_redirect_file=jupyter_app.use_redirect_file,
takluyver marked this conversation as resolved.
Show resolved Hide resolved
static_path=jupyter_app.static_file_path,
static_custom_path=jupyter_app.static_custom_path,
static_handler_class = FileFindHandler,
Expand Down Expand Up @@ -539,6 +540,20 @@ def start(self):
_("Allow the notebook to be run from root user.")
)

flags['use_redirect_file']=(
{'NotebookApp' : {'use_redirect_file' : True}},
takluyver marked this conversation as resolved.
Show resolved Hide resolved
"""Disable launching browser by redirect file

For some environments (like Windows Subsystem for Linux (WSL) and Chromebooks),
launching a browser using a redirect file (introduced in notebook versions
> 5.7.2) can lead the browser failing to load. This is because of the
difference in file structures/paths between the runtime and the browser.

Disabling this setting will by setting to False will disable this behavior,
allowing the browser to launch by using a URL and visible token (as before).
"""
takluyver marked this conversation as resolved.
Show resolved Hide resolved
)

# Add notebook manager flags
flags.update(boolean_flag('script', 'FileContentsManager.save_script',
'DEPRECATED, IGNORED',
Expand Down Expand Up @@ -645,6 +660,19 @@ def _default_log_format(self):
help=_("Whether to allow the user to run the notebook as root.")
)

use_redirect_file = Bool(True, config=True,
help="""Disable launching browser by redirect file

For some environments (like Windows Subsystem for Linux (WSL) and Chromebooks),
launching a browser using a redirect file (introduced in notebook versions
> 5.7.2) can lead the browser failing to load. This is because of the
difference in file structures/paths between the runtime and the browser.

Disabling this setting will by setting to False will disable this behavior,
allowing the browser to launch by using a URL and visible token (as before).
"""
)

default_url = Unicode('/tree', config=True,
help=_("The default URL to redirect to from `/`")
)
Expand Down Expand Up @@ -1805,7 +1833,13 @@ def launch_browser(self):
if not browser:
return

if self.file_to_run:
if not self.use_redirect_file:
uri = self.default_url[len(self.base_url):]

if self.token:
uri = url_concat(uri, {'token': self.token})

elif self.file_to_run:
takluyver marked this conversation as resolved.
Show resolved Hide resolved
if not os.path.exists(self.file_to_run):
self.log.critical(_("%s does not exist") % self.file_to_run)
self.exit(1)
Expand All @@ -1820,10 +1854,17 @@ def launch_browser(self):
else:
open_file = self.browser_open_file

b = lambda: browser.open(
urljoin('file:', pathname2url(open_file)),
new=self.webbrowser_open_new)
threading.Thread(target=b).start()
if not self.use_redirect_file:
takluyver marked this conversation as resolved.
Show resolved Hide resolved
if browser:
takluyver marked this conversation as resolved.
Show resolved Hide resolved
b = lambda: browser.open(url_path_join(self.connection_url, uri),
new=self.webbrowser_open_new)
threading.Thread(target=b).start()

else:
b = lambda: browser.open(
urljoin('file:', pathname2url(open_file)),
new=self.webbrowser_open_new)
threading.Thread(target=b).start()
takluyver marked this conversation as resolved.
Show resolved Hide resolved

def start(self):
""" Start the Notebook server app, after initialization
Expand Down