def finish_initializing(self, builder):
"""Called while initializing this instance in __new__
finish_initalizing should be called after parsing the ui definition
and creating a PreferencesDialog object with it in order to
finish initializing the start of the new PerferencesUlauncherDialog
instance.
Put your initialization code in here and leave __init__ undefined.
"""
# Get a reference to the builder and set up the signals.
self.builder = builder
self.ui = builder.get_ui(self, True)
# unnecessary action area can be removed only manually, like this
self.ui['dialog_action_area'].destroy()
self.settings = Settings.get_instance()
self._init_webview()
self.init_styles(get_data_file('styles', 'preferences.css'))
self._handle_no_window_shadow_option(self.ui['window_wrapper'])
self.autostart_pref = AutostartPreference()
self.hotkey_dialog = HotkeyDialog()
self.hotkey_dialog.connect('hotkey-set', self.on_hotkey_set)
self.show_all()
def __init_autostart_switch(self):
self._autostart_pref = AutostartPreference()
self._autostart_switch = self.builder.get_object('autostart')
autostart_allowed = self._autostart_pref.is_allowed()
self._autostart_switch.set_sensitive(autostart_allowed)
if autostart_allowed:
self._autostart_switch.set_active(self._autostart_pref.is_on())
def __init__(self):
super().__init__(
title="Ulauncher Preferences",
window_position=Gtk.WindowPosition.CENTER,
)
self.connect("key-press-event", self.on_key_press)
self.connect("delete-event", self.on_delete)
self.set_default_size(1000, 600)
self.settings = Settings.get_instance()
self._init_webview()
self.autostart_pref = AutostartPreference()
self.hotkey_dialog = HotkeyDialog()
self.hotkey_dialog.connect('hotkey-set', self.on_hotkey_set)
self.show_all()
class PreferencesUlauncherDialog(Gtk.Dialog, WindowHelper):
__gtype_name__ = "PreferencesUlauncherDialog"
_hotkey_name = None
######################################
# Initialization
######################################
def __new__(cls):
"""Special static method that's automatically called by Python when
constructing a new instance of this class.
Returns a fully instantiated PreferencesDialog object.
"""
builder = Builder.new_from_file('PreferencesUlauncherDialog')
new_object = builder.get_object("preferences_ulauncher_dialog")
new_object.finish_initializing(builder)
return new_object
def finish_initializing(self, builder):
"""Called while initializing this instance in __new__
finish_initalizing should be called after parsing the ui definition
and creating a PreferencesDialog object with it in order to
finish initializing the start of the new PerferencesUlauncherDialog
instance.
Put your initialization code in here and leave __init__ undefined.
"""
# Get a reference to the builder and set up the signals.
self.builder = builder
self.ui = builder.get_ui(self, True)
# unnecessary action area can be removed only manually, like this
self.ui['dialog_action_area'].destroy()
self.settings = Settings.get_instance()
self._init_webview()
self.init_styles(get_data_file('styles', 'preferences.css'))
self._handle_no_window_shadow_option(self.ui['window_wrapper'])
self.autostart_pref = AutostartPreference()
self.hotkey_dialog = HotkeyDialog()
self.hotkey_dialog.connect('hotkey-set', self.on_hotkey_set)
self.show_all()
def _handle_no_window_shadow_option(self, window_wrapper):
# removing window shadow solves issue with DEs without a compositor (#230)
if get_options().no_window_shadow:
window_wrapper.get_style_context().add_class('no-window-shadow')
def _init_webview(self):
"""
Initialize preferences WebView
"""
self.webview = WebKit2.WebView()
self.ui['scrolled_window'].add(self.webview)
opts = get_options()
self._load_prefs_html()
web_settings = self.webview.get_settings()
web_settings.set_enable_developer_extras(bool(opts.dev))
web_settings.set_enable_xss_auditor(False)
web_settings.set_enable_write_console_messages_to_stdout(True)
self.webview.get_context().register_uri_scheme('prefs', self.on_scheme_callback)
self.webview.get_context().set_cache_model(WebKit2.CacheModel.DOCUMENT_VIEWER) # disable caching
self.webview.connect('button-press-event', self.webview_on_button_press_event)
self.webview.connect('context-menu', self.webview_on_context_menu)
inspector = self.webview.get_inspector()
inspector.connect("attach", lambda inspector, target_view: WebKit2.WebView())
######################################
# Overrides
######################################
# pylint: disable=arguments-differ
def present(self, page):
self._load_prefs_html(page)
super().present()
def show(self, page):
self._load_prefs_html(page)
super().show()
######################################
# GTK event handlers
######################################
#
def webview_on_button_press_event(self, widget, event):
"""
Makes preferences window draggable by empty an empty space between navigation and close button
also by the color stripe
"""
window_width = self.get_size()[0]
if event.button == 1 and (690 < event.x < window_width - 100 and 0 < event.y < 69) or event.y <= 11:
self.begin_move_drag(event.button, event.x_root, event.y_root, event.time)
return False
def webview_on_context_menu(self, *args):
return bool(not get_options().dev)
######################################
# WebView communication methods
######################################
@run_async
def on_scheme_callback(self, scheme_request):
"""
Handles Javascript-to-Python calls
"""
# pylint: disable=broad-except
try:
params = get_url_params(scheme_request.get_uri())
callback_name = params['query']['callback']
assert callback_name
except Exception as e:
logger.exception('API call failed. %s: %s', type(e).__name__, e)
return
try:
resp = rt.dispatch(self, scheme_request.get_uri())
callback = '%s(%s);' % (callback_name, json.dumps(resp))
except UlauncherAPIError as e:
error_type = type(e).__name__
logger.error('%s: %s', error_type, e)
callback = '%s(null, %s);' % (callback_name, json.dumps({
'message': str(e),
'type': error_type,
'errorName': e.error_name,
'stacktrace': traceback.format_exc()
}))
except Exception as e:
message = 'Unexpected API error. %s: %s' % (type(e).__name__, e)
logger.exception(message)
callback = '%s(null, %s);' % (callback_name, json.dumps({
'message': str(e),
'type': type(e).__name__,
'errorName': ErrorName.UnhandledError.value,
'stacktrace': traceback.format_exc()
}))
try:
stream = Gio.MemoryInputStream.new_from_data(callback.encode())
# send response
scheme_request.finish(stream, -1, 'text/javascript')
except Exception as e:
logger.exception('Unexpected API error. %s: %s', type(e).__name__, e)
def send_webview_notification(self, name, data):
self.webview.run_javascript('onNotification("%s", %s)' % (name, json.dumps(data)))
######################################
# Request handlers
######################################
@rt.route('/get/all')
def prefs_get_all(self, url_params):
logger.info('API call /get/all')
return {
'show_indicator_icon': self.settings.get_property('show-indicator-icon'),
'hotkey_show_app': self.get_app_hotkey(),
'autostart_allowed': self.autostart_pref.is_allowed(),
'autostart_enabled': self.autostart_pref.is_on(),
'show_recent_apps': self.settings.get_property('show-recent-apps'),
'clear_previous_query': self.settings.get_property('clear-previous-query'),
'blacklisted_desktop_dirs': self.settings.get_property('blacklisted-desktop-dirs'),
'disable_desktop_filters': self.settings.get_property('disable-desktop-filters'),
'available_themes': self._get_available_themes(),
'theme_name': Theme.get_current().get_name(),
'render_on_screen': self.settings.get_property('render-on-screen'),
'is_wayland': is_wayland(),
'terminal_command': self.settings.get_property('terminal-command'),
'grab_mouse_pointer': self.settings.get_property('grab-mouse-pointer'),
'env': {
'version': get_version(),
'api_version': api_version,
'user_home': os.path.expanduser('~')
}
}
@rt.route('/set/show-indicator-icon')
def prefs_set_show_indicator_icon(self, url_params):
show_indicator = self._get_bool(url_params['query']['value'])
logger.info('Set show-indicator-icon to %s', show_indicator)
self.settings.set_property('show-indicator-icon', show_indicator)
self.settings.save_to_file()
indicator = AppIndicator.get_instance()
GLib.idle_add(indicator.switch, show_indicator)
@rt.route('/set/autostart-enabled')
def prefs_set_autostart(self, url_params):
is_on = self._get_bool(url_params['query']['value'])
logger.info('Set autostart-enabled to %s', is_on)
if is_on and not self.autostart_pref.is_allowed():
raise PrefsApiError("Unable to turn on autostart preference")
try:
self.autostart_pref.switch(is_on)
except Exception as e:
raise PrefsApiError('Caught an error while switching "autostart": %s' % e) from e
@rt.route('/set/show-recent-apps')
def prefs_set_show_recent_apps(self, url_params):
try:
recent_apps_number = int(url_params['query']['value'])
except ValueError:
recent_apps_number = 3
logger.info('Set show-recent-apps to %s', recent_apps_number)
self.settings.set_property('show-recent-apps', recent_apps_number)
self.settings.save_to_file()
@rt.route('/set/hotkey-show-app')
@glib_idle_add
def prefs_set_hotkey_show_app(self, url_params):
hotkey = url_params['query']['value']
logger.info('Set hotkey-show-app to %s', hotkey)
# Bind a new key
from ulauncher.ui.windows.UlauncherWindow import UlauncherWindow
ulauncher_window = UlauncherWindow.get_instance()
ulauncher_window.bind_show_app_hotkey(hotkey)
self.settings.set_property('hotkey-show-app', hotkey)
self.settings.save_to_file()
@rt.route('/set/theme-name')
@glib_idle_add
def prefs_set_theme_name(self, url_params):
name = url_params['query']['value']
logger.info('Set theme-name to %s', name)
self.settings.set_property('theme-name', name)
self.settings.save_to_file()
from ulauncher.ui.windows.UlauncherWindow import UlauncherWindow
ulauncher_window = UlauncherWindow.get_instance()
ulauncher_window.init_theme()
@rt.route('/set/terminal-command')
def prefs_set_terminal_command(self, url_params):
terminal_command = url_params['query']['value']
logger.info('Set terminal launch command to %s', terminal_command)
self.settings.set_property('terminal-command', terminal_command)
self.settings.save_to_file()
@rt.route('/show/hotkey-dialog')
@glib_idle_add
def prefs_showhotkey_dialog(self, url_params):
self._hotkey_name = url_params['query']['name']
logger.info('Show hotkey-dialog for %s', self._hotkey_name)
self.hotkey_dialog.present()
@rt.route('/set/clear-previous-query')
def prefs_set_clear_previous_text(self, url_params):
is_on = self._get_bool(url_params['query']['value'])
logger.info('Set clear-previous-query to %s', is_on)
self.settings.set_property('clear-previous-query', is_on)
self.settings.save_to_file()
@rt.route('/set/grab-mouse-pointer')
def prefs_set_grab_mouse_pointer(self, url_params):
is_on = self._get_bool(url_params['query']['value'])
logger.info('Set grab-mouse-pointer to %s', is_on)
self.settings.set_property('grab-mouse-pointer', is_on)
self.settings.save_to_file()
@rt.route('/set/blacklisted-desktop-dirs')
def prefs_set_blacklisted_desktop_dirs(self, url_params):
dirs = url_params['query']['value']
logger.info('Set blacklisted-desktop-dirs to %s', dirs)
self.settings.set_property('blacklisted-desktop-dirs', dirs)
self.settings.save_to_file()
@rt.route('/set/disable-desktop-filters')
def prefs_set_disable_desktop_filters(self, url_params):
is_on = self._get_bool(url_params['query']['value'])
logger.info('Set disable-desktop-filters to %s', is_on)
self.settings.set_property('disable-desktop-filters', is_on)
self.settings.save_to_file()
@rt.route('/set/render-on-screen')
def prefs_set_render_on_screen(self, url_params):
selected_option = url_params['query']['value']
logger.info('Set render-on-screen to %s', selected_option)
self.settings.set_property('render-on-screen', selected_option)
self.settings.save_to_file()
@rt.route('/show/file-browser')
@glib_idle_add
def prefs_show_file_browser(self, url_params):
"""
Request params: type=(image|all), name=(str)
"""
file_browser_name = url_params['query']['name']
logger.info('Show file browser dialog for %s', file_browser_name)
dialog = Gtk.FileChooserDialog("Please choose a file", self, Gtk.FileChooserAction.OPEN,
(Gtk.STOCK_CANCEL, Gtk.ResponseType.CANCEL, Gtk.STOCK_OPEN, Gtk.ResponseType.OK))
filter_images = Gtk.FileFilter()
filter_images.set_name("Image files")
filter_images.add_mime_type("image/*")
dialog.add_filter(filter_images)
response = dialog.run()
data = {
'value': None
}
if response == Gtk.ResponseType.OK:
data['value'] = dialog.get_filename()
logger.debug('%s %s', file_browser_name, data)
self.send_webview_notification(file_browser_name, data)
dialog.destroy()
@rt.route('/open/web-url')
def prefs_open_url(self, url_params):
url = unquote(url_params['query']['url'])
logger.info('Open Web URL %s', url)
OpenUrlAction(url).run()
@rt.route('/close')
def prefs_close(self, url_params):
logger.info('Close preferences')
self.hide()
@rt.route('/shortcut/get-all')
def prefs_shortcut_get_all(self, url_params):
logger.info('Handling /shortcut/get-all')
shortcuts = ShortcutsDb.get_instance()
return shortcuts.get_sorted_records()
@rt.route('/shortcut/update')
@rt.route('/shortcut/add')
def prefs_shortcut_update(self, url_params):
req_data = url_params['query']
logger.info('Add/Update shortcut: %s', json.dumps(req_data))
shortcuts = ShortcutsDb.get_instance()
id = shortcuts.put_shortcut(req_data['name'],
req_data['keyword'],
req_data['cmd'],
req_data.get('icon') or None,
str_to_bool(req_data['is_default_search']),
str_to_bool(req_data['run_without_argument']),
req_data.get('id'))
shortcuts.commit()
return {'id': id}
@rt.route('/shortcut/remove')
def prefs_shortcut_remove(self, url_params):
req_data = url_params['query']
logger.info('Remove shortcut: %s', json.dumps(req_data))
shortcuts = ShortcutsDb.get_instance()
shortcuts.remove(req_data['id'])
shortcuts.commit()
@rt.route('/extension/get-all')
def prefs_extension_get_all(self, url_params):
logger.info('Handling /extension/get-all')
return self._get_all_extensions()
@rt.route('/extension/add')
def prefs_extension_add(self, url_params):
url = url_params['query']['url']
logger.info('Add extension: %s', url)
downloader = ExtensionDownloader.get_instance()
ext_id = downloader.download(url)
ExtensionRunner.get_instance().run(ext_id)
return self._get_all_extensions()
@rt.route('/extension/update-prefs')
def prefs_extension_update_prefs(self, url_params):
query = url_params['query']
ext_id = query['id']
logger.info('Update extension preferences: %s', query)
prefix = 'pref.'
controller = ExtensionServer.get_instance().get_controller(ext_id)
if not controller:
logger.error("Cannot update preferences. The extension controller is not registered. \
Try relaunching or restarting Ulauncher, and check the extension readme for external dependencies \
you may have to install manually")
return
preferences = [(key[len(prefix):], value) for key, value in query.items() if key.startswith(prefix)]
for pref_id, value in preferences:
old_value = controller.preferences.get(pref_id)['value']
controller.preferences.set(pref_id, value)
if value != old_value:
controller.trigger_event(PreferencesUpdateEvent(pref_id, old_value, value))
@rt.route('/extension/check-updates')
def prefs_extension_check_updates(self, url_params):
logger.info('Handling /extension/check-updates')
ext_id = url_params['query']['id']
try:
return ExtensionDownloader.get_instance().get_new_version(ext_id)
except ExtensionIsUpToDateError:
return None
@rt.route('/extension/update-ext')
def prefs_extension_update_ext(self, url_params):
ext_id = url_params['query']['id']
logger.info('Update extension: %s', ext_id)
downloader = ExtensionDownloader.get_instance()
try:
downloader.update(ext_id)
except ExtensionManifestError as e:
raise PrefsApiError(e)
@rt.route('/extension/remove')
def prefs_extension_remove(self, url_params):
ext_id = url_params['query']['id']
logger.info('Remove extension: %s', ext_id)
downloader = ExtensionDownloader.get_instance()
downloader.remove(ext_id)
######################################
# Helpers
######################################
def _get_all_extensions(self) -> List[ExtensionInfo]:
extensions = []
for ext_id, _ in find_extensions(EXTENSIONS_DIR):
prefs = ExtensionPreferences.create_instance(ext_id) # type: ExtensionPreferences
prefs.manifest.refresh()
error = None
try:
prefs.manifest.validate()
prefs.manifest.check_compatibility()
except UlauncherAPIError as e:
error = cast(ExtError, {
'message': str(e),
'errorName': e.error_name
})
except Exception as e:
error = cast(ExtError, {
'message': str(e),
'errorName': ErrorName.UnexpectedError.value
})
extensions.append(self._get_extension_info(ext_id, prefs, error))
return extensions
def _get_extension_info(self, ext_id: str, prefs: ExtensionPreferences, error: ExtError = None) -> ExtensionInfo:
ext_db = ExtensionDb.get_instance()
is_connected = bool(ExtensionServer.get_instance().get_controller(ext_id))
ext_runner = ExtensionRunner.get_instance()
is_running = is_connected or ext_runner.is_running(ext_id)
ext_db_record = ext_db.find(ext_id, {})
return {
'id': ext_id,
'url': ext_db_record.get('url'),
'updated_at': ext_db_record.get('updated_at'),
'last_commit': ext_db_record.get('last_commit'),
'last_commit_time': ext_db_record.get('last_commit_time'),
'name': prefs.manifest.get_name(),
'icon': prefs.manifest.get_icon_path(),
'description': prefs.manifest.get_description(),
'developer_name': prefs.manifest.get_developer_name(),
'preferences': prefs.get_items(),
'error': error,
'is_running': is_running,
'runtime_error': ext_runner.get_extension_error(ext_id) if not is_running else None
}
def _load_prefs_html(self, page=''):
uri = "file://%s#/%s" % (get_data_file('preferences', 'dist', 'index.html'), page)
self.webview.load_uri(uri)
def _get_bool(self, str_val):
return str(str_val).lower() in ('true', '1', 'on')
def _get_available_themes(self):
load_available_themes()
return [dict(value=th.get_name(), text=th.get_display_name()) for th in themes.values()]
def get_app_hotkey(self):
app_hotkey_current_accel_name = self.settings.get_property('hotkey-show-app')
try:
(key, mode) = Gtk.accelerator_parse(app_hotkey_current_accel_name)
# pylint: disable=broad-except
except Exception:
logger.warning('Unable to parse accelerator "%s". Use Ctrl+Space', app_hotkey_current_accel_name)
(key, mode) = Gtk.accelerator_parse("<Primary>space")
return Gtk.accelerator_get_label(key, mode)
def on_hotkey_set(self, widget, hotkey_val, hotkey_display_val):
self.send_webview_notification(self._hotkey_name, {
'value': hotkey_val,
'displayValue': hotkey_display_val
})
class PreferencesWindow(Gtk.ApplicationWindow):
def __init__(self):
super().__init__(
title="Ulauncher Preferences",
window_position=Gtk.WindowPosition.CENTER,
)
self.connect("key-press-event", self.on_key_press)
self.connect("delete-event", self.on_delete)
self.set_default_size(1000, 600)
self.settings = Settings.get_instance()
self._init_webview()
self.autostart_pref = AutostartPreference()
self.hotkey_dialog = HotkeyDialog()
self.hotkey_dialog.connect('hotkey-set', self.on_hotkey_set)
self.show_all()
def on_key_press(self, _, event):
keyval = event.get_keyval()
keyname = Gdk.keyval_name(keyval[1])
if keyname == 'Escape':
self.hide()
def on_delete(self, *_):
# Override default event when the user presses the close button in the menubar
self.hide()
return True
def _init_webview(self):
"""
Initialize preferences WebView
"""
self.webview = WebKit2.WebView()
self.add(self.webview)
opts = get_options()
self._load_prefs_html()
web_settings = self.webview.get_settings()
web_settings.set_enable_developer_extras(bool(opts.dev))
web_settings.set_enable_xss_auditor(False)
web_settings.set_enable_write_console_messages_to_stdout(True)
self.webview.get_context().register_uri_scheme('prefs', self.on_scheme_callback)
self.webview.get_context().set_cache_model(WebKit2.CacheModel.DOCUMENT_VIEWER) # disable caching
self.webview.connect('context-menu', self.webview_on_context_menu)
inspector = self.webview.get_inspector()
inspector.connect("attach", lambda inspector, target_view: WebKit2.WebView())
######################################
# Overrides
######################################
# pylint: disable=arguments-differ
def present(self, page):
self._load_prefs_html(page)
super().present()
def show(self, page):
self._load_prefs_html(page)
super().show()
######################################
# GTK event handlers
######################################
def webview_on_context_menu(self, *args):
return bool(not get_options().dev)
######################################
# WebView communication methods
######################################
@run_async
def on_scheme_callback(self, scheme_request):
"""
Handles Javascript-to-Python calls
"""
# pylint: disable=broad-except
try:
params = urlparse(scheme_request.get_uri())
query = json.loads(unquote(params.query))
callback_name = query['callback']
assert callback_name
except Exception as e:
logger.exception('API call failed. %s: %s', type(e).__name__, e)
return
try:
resp = rt.dispatch(self, scheme_request.get_uri())
callback = f'{callback_name}({json.dumps(resp)});'
except UlauncherAPIError as e:
error_type = type(e).__name__
logger.error('%s: %s', error_type, e)
err_meta = json.dumps({
'message': str(e),
'type': error_type,
'errorName': e.error_name,
'stacktrace': traceback.format_exc()
})
callback = f'{callback_name}(null, {err_meta});'
except Exception as e:
logger.exception('Unexpected API error. %s: %s', type(e).__name__, e)
err_meta = json.dumps({
'message': str(e),
'type': type(e).__name__,
'errorName': ErrorName.UnhandledError.value,
'stacktrace': traceback.format_exc()
})
callback = f'{callback_name}(null, {err_meta});'
try:
stream = Gio.MemoryInputStream.new_from_data(callback.encode())
# send response
scheme_request.finish(stream, -1, 'text/javascript')
except Exception as e:
logger.exception('Unexpected API error. %s: %s', type(e).__name__, e)
def send_webview_notification(self, name, data):
self.webview.run_javascript(f'onNotification("{name}", {json.dumps(data)})')
######################################
# Request handlers
######################################
@rt.route('/get/all')
def prefs_get_all(self, query):
logger.info('API call /get/all')
settings = self.settings.get_all()
settings.update({
'autostart_allowed': self.autostart_pref.is_allowed(),
'autostart_enabled': self.autostart_pref.is_enabled(),
'available_themes': self._get_available_themes(),
'hotkey_show_app': self.get_app_hotkey(),
'env': {
'version': VERSION,
'api_version': API_VERSION,
'user_home': os.path.expanduser('~'),
'is_x11': IS_X11,
}
})
return settings
@rt.route('/set')
def prefs_set(self, query):
property = query['property']
value = query['value']
# This setting is not stored to the config
if property == 'autostart-enabled':
self.prefs_set_autostart(value)
return
self.settings.set_property(property, value)
if property == 'show-indicator-icon':
# pylint: disable=import-outside-toplevel
from ulauncher.ui.windows.UlauncherWindow import UlauncherWindow
ulauncher_window = UlauncherWindow.get_instance()
GLib.idle_add(AppIndicator.get_instance(ulauncher_window).switch, value)
if property == 'theme-name':
self.prefs_apply_theme()
def prefs_set_autostart(self, is_enabled):
logger.info('Set autostart-enabled to %s', is_enabled)
if is_enabled and not self.autostart_pref.is_allowed():
raise PrefsApiError("Unable to turn on autostart preference")
try:
self.autostart_pref.switch(is_enabled)
except Exception as err:
raise PrefsApiError(f'Caught an error while switching "autostart": {err}') from err
def prefs_apply_theme(self):
# pylint: disable=import-outside-toplevel
from ulauncher.ui.windows.UlauncherWindow import UlauncherWindow
ulauncher_window = UlauncherWindow.get_instance()
ulauncher_window.init_theme()
@rt.route('/set/hotkey-show-app')
@glib_idle_add
def prefs_set_hotkey_show_app(self, query):
hotkey = query['value']
# Bind a new key
# pylint: disable=import-outside-toplevel
from ulauncher.ui.windows.UlauncherWindow import UlauncherWindow
ulauncher_window = UlauncherWindow.get_instance()
ulauncher_window.bind_hotkey(hotkey)
self.settings.set_property('hotkey-show-app', hotkey)
@rt.route('/show/hotkey-dialog')
@glib_idle_add
def prefs_showhotkey_dialog(self, query):
self._hotkey_name = query['name']
logger.info('Show hotkey-dialog for %s', self._hotkey_name)
self.hotkey_dialog.present()
@rt.route('/show/file-browser')
@glib_idle_add
def prefs_show_file_browser(self, query):
"""
Request params: type=(image|all), name=(str)
"""
file_browser_name = query['name']
logger.info('Show file browser dialog for %s', file_browser_name)
dialog = Gtk.FileChooserDialog("Please choose a file", self, Gtk.FileChooserAction.OPEN,
(Gtk.STOCK_CANCEL, Gtk.ResponseType.CANCEL, Gtk.STOCK_OPEN, Gtk.ResponseType.OK))
filter_images = Gtk.FileFilter()
filter_images.set_name("Image files")
filter_images.add_mime_type("image/*")
dialog.add_filter(filter_images)
response = dialog.run()
data = {
'value': None
}
if response == Gtk.ResponseType.OK:
data['value'] = dialog.get_filename()
logger.debug('%s %s', file_browser_name, data)
self.send_webview_notification(file_browser_name, data)
dialog.destroy()
@rt.route('/open/web-url')
def prefs_open_url(self, query):
url = query['url']
logger.info('Open Web URL %s', url)
OpenAction(url).run()
@rt.route('/shortcut/get-all')
def prefs_shortcut_get_all(self, query):
logger.info('Handling /shortcut/get-all')
shortcuts = ShortcutsDb.get_instance()
return shortcuts.get_sorted_records()
@rt.route('/shortcut/update')
@rt.route('/shortcut/add')
def prefs_shortcut_update(self, query):
logger.info('Add/Update shortcut: %s', json.dumps(query))
shortcuts = ShortcutsDb.get_instance()
id = shortcuts.put_shortcut(query['name'],
query['keyword'],
query['cmd'],
query.get('icon') or None,
str_to_bool(query['is_default_search']),
str_to_bool(query['run_without_argument']),
query.get('id'))
shortcuts.commit()
return {'id': id}
@rt.route('/shortcut/remove')
def prefs_shortcut_remove(self, query):
logger.info('Remove shortcut: %s', json.dumps(query))
shortcuts = ShortcutsDb.get_instance()
shortcuts.remove(query['id'])
shortcuts.commit()
@rt.route('/extension/get-all')
def prefs_extension_get_all(self, query):
logger.info('Handling /extension/get-all')
return self._get_all_extensions()
@rt.route('/extension/add')
def prefs_extension_add(self, query):
url = query['url']
logger.info('Add extension: %s', url)
downloader = ExtensionDownloader.get_instance()
ext_id = downloader.download(url)
ExtensionRunner.get_instance().run(ext_id)
return self._get_all_extensions()
@rt.route('/extension/update-prefs')
def prefs_extension_update_prefs(self, query):
ext_id = query['id']
logger.info('Update extension preferences: %s', query)
prefix = 'pref.'
controller = ExtensionServer.get_instance().controllers.get(ext_id)
preferences = [(key[len(prefix):], value) for key, value in query.items() if key.startswith(prefix)]
for pref_id, value in preferences:
old_value = controller.preferences.get(pref_id)['value']
controller.preferences.set(pref_id, value)
if value != old_value:
controller.trigger_event(PreferencesUpdateEvent(pref_id, old_value, value))
@rt.route('/extension/check-updates')
def prefs_extension_check_updates(self, query):
logger.info('Handling /extension/check-updates')
try:
return ExtensionDownloader.get_instance().get_new_version(query['id'])
except ExtensionIsUpToDateError:
return None
@rt.route('/extension/update-ext')
def prefs_extension_update_ext(self, query):
logger.info('Update extension: %s', query['id'])
downloader = ExtensionDownloader.get_instance()
try:
downloader.update(query['id'])
except ExtensionManifestError as e:
raise PrefsApiError(e) from e
@rt.route('/extension/remove')
def prefs_extension_remove(self, query):
logger.info('Remove extension: %s', query['id'])
downloader = ExtensionDownloader.get_instance()
downloader.remove(query['id'])
######################################
# Helpers
######################################
def _get_all_extensions(self) -> List[ExtensionInfo]:
extensions = []
for ext_id, _ in find_extensions(EXTENSIONS_DIR):
prefs = ExtensionPreferences.create_instance(ext_id) # type: ExtensionPreferences
prefs.manifest.refresh()
error = None
try:
prefs.manifest.validate()
prefs.manifest.check_compatibility()
except UlauncherAPIError as e:
error = cast(ExtError, {
'message': str(e),
'errorName': e.error_name
})
except Exception as e:
error = cast(ExtError, {
'message': str(e),
'errorName': ErrorName.UnexpectedError.value
})
extensions.append(self._get_extension_info(ext_id, prefs, error))
return extensions
def _get_extension_info(self, ext_id: str, prefs: ExtensionPreferences, error: ExtError = None) -> ExtensionInfo:
ext_db = ExtensionDb.get_instance()
is_connected = ext_id in ExtensionServer.get_instance().controllers
ext_runner = ExtensionRunner.get_instance()
is_running = is_connected or ext_runner.is_running(ext_id)
ext_db_record = ext_db.find(ext_id, {})
return {
'id': ext_id,
'url': ext_db_record.get('url'),
'updated_at': ext_db_record.get('updated_at'),
'last_commit': ext_db_record.get('last_commit'),
'last_commit_time': ext_db_record.get('last_commit_time'),
'name': prefs.manifest.get_name(),
'icon': prefs.manifest.get_icon_path(),
'description': prefs.manifest.get_description(),
'developer_name': prefs.manifest.get_developer_name(),
'preferences': prefs.get_items(),
'error': error,
'is_running': is_running,
'runtime_error': ext_runner.get_extension_error(ext_id) if not is_running else None
}
def _load_prefs_html(self, page=''):
self.webview.load_uri(f"file://{get_asset('preferences', 'index.html')}#/{page}")
def _get_available_themes(self):
load_available_themes()
return [dict(value=th.get_name(), text=th.get_display_name()) for th in themes.values()]
def get_app_hotkey(self):
app_hotkey_current_accel_name = self.settings.get_property('hotkey-show-app')
try:
(key, mode) = Gtk.accelerator_parse(app_hotkey_current_accel_name)
# pylint: disable=broad-except
except Exception:
logger.warning('Unable to parse accelerator "%s". Use Ctrl+Space', app_hotkey_current_accel_name)
(key, mode) = Gtk.accelerator_parse("<Primary>space")
return Gtk.accelerator_get_label(key, mode)
def on_hotkey_set(self, widget, hotkey_val, hotkey_display_val):
self.send_webview_notification(self._hotkey_name, {
'value': hotkey_val,
'displayValue': hotkey_display_val
})
def test_is_allowed__retuns_False(self, db):
del db.get_records.return_value['Ulauncher']
assert not AutostartPreference().is_allowed()
def autostart(self, db, xdg_config_home):
return AutostartPreference()
class PreferencesUlauncherDialog(PreferencesDialogBase):
__gtype_name__ = "PreferencesUlauncherDialog"
def finish_initializing(self, builder):
"""Set up the preferences dialog"""
super(PreferencesUlauncherDialog, self).finish_initializing(builder)
# unnecessary action area can be removed only manually, like this
self.builder.get_object('dialog_action_area').destroy()
self.settings = Settings.get_instance()
self.__init_indicator_switch()
self.__init_app_hotkey()
self.__init_autostart_switch()
def __init_indicator_switch(self):
indicator_switch = self.builder.get_object('show_indicator_icon')
indicator_switch.set_active(
self.settings.get_property('show-indicator-icon'))
def __init_app_hotkey(self):
app_hotkey = self.builder.get_object('hotkey_show_app')
self.app_hotkey_current_accel_name = self.settings.get_property(
'hotkey-show-app')
try:
(key,
mode) = Gtk.accelerator_parse(self.app_hotkey_current_accel_name)
except Exception:
logger.warning('Unable to parse accelerator "%s". Use Ctrl+Space' %
self.app_hotkey_current_accel_name)
(key, mode) = Gtk.accelerator_parse("<Primary>space")
self.app_hotkey_current_label = Gtk.accelerator_get_label(key, mode)
app_hotkey.set_text(self.app_hotkey_current_label)
def __init_autostart_switch(self):
self._autostart_pref = AutostartPreference()
self._autostart_switch = self.builder.get_object('autostart')
autostart_allowed = self._autostart_pref.is_allowed()
self._autostart_switch.set_sensitive(autostart_allowed)
if autostart_allowed:
self._autostart_switch.set_active(self._autostart_pref.is_on())
def on_show_indicator_icon_notify(self, widget, event):
if event.name == 'active':
show_indicator = widget.get_active()
self.settings.set_property('show-indicator-icon', show_indicator)
indicator = AppIndicator.get_instance()
indicator.show() if show_indicator else indicator.hide()
self.settings.save_to_file()
def on_autostart_notify(self, widget, event):
if event.name == 'active':
is_on = widget.get_active()
try:
self._autostart_pref.switch(is_on)
except Exception as e:
logger.warning(
'Caught an error while switching "autostart": %s' % e)
def is_valid_hotkey(self, label, accel_name):
"""
:param str label: String like 'Ctrl+`'
:param str accel_name: String like '<Primary>space'
accel_name should not be in FORBIDDEN_ACCEL_KEYS
and label should consist of more than one symbol
NOTE: it's very likely these verifications are not enough,
but I could not find more information about this topic
"""
return (accel_name not in FORBIDDEN_ACCEL_KEYS
) and len(label) > 1 and not accel_name.startswith('KP_')
def on_hotkey_show_app_key_press_event(self, widget, event):
# remove GDK_MOD2_MASK, because it seems unnecessary
mask = event.state
if mask & Gdk.ModifierType.MOD2_MASK:
mask ^= Gdk.ModifierType.MOD2_MASK
label = Gtk.accelerator_get_label(event.keyval, mask)
accel_name = Gtk.accelerator_name(event.keyval, mask)
# do nothing for invalid hotkeys
if not self.is_valid_hotkey(label, accel_name):
logger.debug("Invalid hotkey '%s', ('%s') is not allowed" %
(label, accel_name))
return
# Bind a new key
from ulauncher.ui.windows.UlauncherWindow import UlauncherWindow
UlauncherWindow.get_instance().bind_show_app_hotkey(accel_name)
widget.set_text(label)
self.settings.set_property('hotkey-show-app', accel_name)
self.settings.save_to_file()
def test_is_allowed__retuns_False(self, db):
db.get_by_name.return_value = None
assert not AutostartPreference().is_allowed()
def autostart(self):
return AutostartPreference()