# HG changeset patch # User Goffi # Date 1422054898 -3600 # Node ID 7cf32aeeebdb9a18f95045192469a474212c37ff # Parent e3a9ea76de35bbad3d793b85fbef01c454e62ec6 quick_frontend, primitivus: moved parts of primitivus's profileManager to quick_frontend diff -r e3a9ea76de35 -r 7cf32aeeebdb frontends/src/primitivus/profile_manager.py --- a/frontends/src/primitivus/profile_manager.py Wed Dec 10 19:00:09 2014 +0100 +++ b/frontends/src/primitivus/profile_manager.py Sat Jan 24 00:14:58 2015 +0100 @@ -20,66 +20,25 @@ from sat.core.i18n import _ from sat.core import log as logging log = logging.getLogger(__name__) +from sat_frontends.quick_frontend.quick_profile_manager import QuickProfileManager from sat_frontends.primitivus.constants import Const as C from sat_frontends.primitivus.keys import action_key_map as a_key from urwid_satext import sat_widgets import urwid -class ProfileRecord(object): - def __init__(self, profile=None, login=None, password=None): - self._profile = profile - self._login = login - self._password = password - - @property - def profile(self): - return self._profile - - @profile.setter - def profile(self, value): - self._profile = value - # if we change the profile, - # we must have no login/password until backend give them - self._login = self._password = None - - @property - def login(self): - return self._login - - @login.setter - def login(self, value): - self._login = value - - @property - def password(self): - return self._password - - @password.setter - def password(self, value): - self._password = value - - -class ProfileManager(urwid.WidgetWrap): - """Class with manage profiles creation/deletion/connection""" +class ProfileManager(QuickProfileManager, urwid.WidgetWrap): def __init__(self, host, autoconnect=None): - """Create the manager - - @param host: %(doc_host)s - @param autoconnect(iterable): list of profiles to connect automatically - """ - self.host = host - self._autoconnect = bool(autoconnect) - self.current = ProfileRecord() - profiles = self.host.bridge.getProfilesList() - profiles.sort() + QuickProfileManager.__init__(self, host, autoconnect) #login & password box must be created before list because of onProfileChange self.login_wid = sat_widgets.AdvancedEdit(_('Login:'), align='center') self.pass_wid = sat_widgets.Password(_('Password:'), align='center') style = ['no_first_select'] + profiles = host.bridge.getProfilesList() + profiles.sort() self.list_profile = sat_widgets.List(profiles, style=style, align='center', on_change=self.onProfileChange) #new & delete buttons @@ -99,20 +58,8 @@ frame = urwid.Frame(frame_body,urwid.AttrMap(urwid.Text(_("Profile Manager"),align='center'),'title')) self.main_widget = urwid.LineBox(frame) urwid.WidgetWrap.__init__(self, self.main_widget) - if self._autoconnect: - self.autoconnect(autoconnect) - def autoconnect(self, profile_keys): - """Automatically connect profiles - - @param profile_keys(iterable): list of profile keys to connect - """ - if not profile_keys: - log.warning("No profile given to autoconnect") - return - self._autoconnect = True - self._autoconnect_profiles=[] - self._do_autoconnect(profile_keys) + self.go(autoconnect) def keypress(self, size, key): @@ -135,42 +82,6 @@ return return super(ProfileManager, self).keypress(size, key) - def _do_autoconnect(self, profile_keys): - """Connect automatically given profiles - - @param profile_kes(iterable): profiles to connect - """ - assert self._autoconnect - - def authenticate_cb(callback_id, data, profile): - - if C.bool(data['validated']): - self._autoconnect_profiles.append(profile) - if len(self._autoconnect_profiles) == len(profile_keys): - # all the profiles have been validated - self.host.plug_profiles(self._autoconnect_profiles) - else: - # a profile is not validated, we go to manual mode - self._autoconnect=False - - for profile_key in profile_keys: - profile = self.host.bridge.getProfileName(profile_key) - if not profile: - self._autoconnect = False # manual mode - msg = _("Trying to plug an unknown profile key ({})".format(profile_key)) - log.warning(msg) - popup = sat_widgets.Alert(_("Profile plugging in error"), msg, ok_cb=self.host.removePopUp) - self.host.showPopUp(popup) - break - self.host.launchAction(C.AUTHENTICATE_PROFILE_ID, callback=authenticate_cb, profile=profile) - - def refillProfiles(self): - """Update the list of profiles""" - profiles = self.host.bridge.getProfilesList() - profiles.sort() - self.list_profile.changeValues(profiles) - self.host.redraw() - def cancelDialog(self, button): self.host.removePopUp() @@ -189,21 +100,11 @@ def profileCreationFailure(self, reason): self.host.removePopUp() - if reason == "ConflictError": - message = _("A profile with this name already exists") - elif reason == "CancelError": - message = _("Profile creation cancelled by backend") - elif reason == "ValueError": - message = _("You profile name is not valid") # TODO: print a more informative message (empty name, name starting with '@') - else: - message = _("Can't create profile ({})").format(reason) - popup = sat_widgets.Alert(_("Can't create profile"), message, ok_cb=self.host.removePopUp) - self.host.showPopUp(popup) + message = self._getErrorMessage(reason) + self.alert(_("Can't create profile"), message) def deleteProfile(self, button): - if self.current.profile: - self.host.bridge.asyncDeleteProfile(self.current.profile, callback=self.refillProfiles) - self.resetFields() + self._deleteProfile() self.host.removePopUp() def onNewProfile(self, e): @@ -215,44 +116,45 @@ pop_up_widget = sat_widgets.ConfirmDialog(_("Are you sure you want to delete the profile {} ?").format(self.current.profile), no_cb=self.cancelDialog, yes_cb=self.deleteProfile) self.host.showPopUp(pop_up_widget) + def onConnectProfiles(self, button): + """Connect the profiles and start the main widget + + @param button: the connect button + """ + self._onConnectProfiles() + def resetFields(self): """Set profile to None, and reset fields""" - self.current.profile=None - self.login_wid.set_edit_text("") - self.pass_wid.set_edit_text("") + super(ProfileManager, self).resetFields() self.list_profile.unselectAll(invisible=True) - def getConnectionParams(self, profile): - """Get login and password and display them + def setProfiles(self, profiles): + """Update the list of profiles""" + self.list_profile.changeValues(profiles) + self.host.redraw() - @param profile: %(doc_profile)s - """ - def setJID(jabberID): - self.login_wid.set_edit_text(jabberID) - self.current.login = jabberID - self.host.redraw() # FIXME: redraw should be avoided + def getProfiles(self): + return self.list_profile.getSelectedValues() - def setPassword(password): - self.pass_wid.set_edit_text(password) - self.current.password = password - self.host.redraw() + def getJID(self): + return self.login_wid.get_edit_text() + + def getPassword(self): + return self.pass_wid.get_edit_text() - self.host.bridge.asyncGetParamA("JabberID", "Connection", profile_key=profile, callback=setJID, errback=self.getParamError) - self.host.bridge.asyncGetParamA("Password", "Connection", profile_key=profile, callback=setPassword, errback=self.getParamError) + def setJID(self, jid_): + self.login_wid.set_edit_text(jid_) + self.current.login = jid_ + self.host.redraw() # FIXME: redraw should be avoided - def updateConnectionParams(self): - """Check if connection parameters have changed, and update them if so""" - if self.current.profile: - login = self.login_wid.get_edit_text() - password = self.pass_wid.get_edit_text() - if login != self.current.login and self.current.login is not None: - self.current.login = login - self.host.bridge.setParam("JabberID", login, "Connection", profile_key=self.current.profile) - log.info("login updated for profile [{}]".format(self.current.profile)) - if password != self.current.password and self.current.password is not None: - self.current.password = password - self.host.bridge.setParam("Password", password, "Connection", profile_key=self.current.profile) - log.info("password updated for profile [{}]".format(self.current.profile)) + def setPassword(self, password): + self.pass_wid.set_edit_text(password) + self.current.password = password + self.host.redraw() + + def alert(self, title, message): + popup = sat_widgets.alert(title, message, ok_cb=self.host.removePopUp) + self.host.showPopUp(popup) def onProfileChange(self, list_wid): """This is called when a profile is selected in the profile list. @@ -273,24 +175,3 @@ self.host.redraw() self.host.launchAction(C.AUTHENTICATE_PROFILE_ID, callback=authenticate_cb, profile=focused.text) - def onConnectProfiles(self, button): - """Connect the profiles and start the main widget - - @param button: the connect button - """ - if self._autoconnect: - pop_up_widget = sat_widgets.Alert(_('Internal error'), _('You can connect manually and automatically at the same time'), ok_cb=self.cancelDialog) - self.host.showPopUp(pop_up_widget) - return - self.updateConnectionParams() - profiles = self.list_profile.getSelectedValues() - if not profiles: - pop_up_widget = sat_widgets.Alert(_('No profile selected'), _('You need to create and select at least one profile before connecting'), ok_cb=self.cancelDialog) - self.host.showPopUp(pop_up_widget) - else: - # All profiles in the list are already validated, so we can plug them directly - self.host.plug_profiles(profiles) - - def getParamError(self, dummy): - popup = sat_widgets.Alert("Error", _("Can't get profile parameter"), ok_cb=self.host.removePopUp) - self.host.showPopUp(popup) diff -r e3a9ea76de35 -r 7cf32aeeebdb frontends/src/quick_frontend/quick_profile_manager.py --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/frontends/src/quick_frontend/quick_profile_manager.py Sat Jan 24 00:14:58 2015 +0100 @@ -0,0 +1,259 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- + +# helper class for making a SAT frontend +# Copyright (C) 2009, 2010, 2011, 2012, 2013, 2014 Jérôme Poisson (goffi@goffi.org) + +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. + +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. + +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . + +from sat.core.i18n import _ +from sat.core import log as logging +log = logging.getLogger(__name__) +from sat_frontends.primitivus.constants import Const as C + + +class ProfileRecord(object): + """Class which manage data for one profile""" + + def __init__(self, profile=None, login=None, password=None): + self._profile = profile + self._login = login + self._password = password + + @property + def profile(self): + return self._profile + + @profile.setter + def profile(self, value): + self._profile = value + # if we change the profile, + # we must have no login/password until backend give them + self._login = self._password = None + + @property + def login(self): + return self._login + + @login.setter + def login(self, value): + self._login = value + + @property + def password(self): + return self._password + + @password.setter + def password(self, value): + self._password = value + + +class QuickProfileManager(object): + """Class with manage profiles creation/deletion/connection""" + + def __init__(self, host, autoconnect=None): + """Create the manager + + @param host: %(doc_host)s + @param autoconnect(iterable): list of profiles to connect automatically + """ + self.host = host + self._autoconnect = bool(autoconnect) + self.current = ProfileRecord() + + def go(self, autoconnect): + if self._autoconnect: + self.autoconnect(autoconnect) + + def autoconnect(self, profile_keys): + """Automatically connect profiles + + @param profile_keys(iterable): list of profile keys to connect + """ + if not profile_keys: + log.warning("No profile given to autoconnect") + return + self._autoconnect = True + self._autoconnect_profiles=[] + self._do_autoconnect(profile_keys) + + + def _do_autoconnect(self, profile_keys): + """Connect automatically given profiles + + @param profile_kes(iterable): profiles to connect + """ + assert self._autoconnect + + def authenticate_cb(callback_id, data, profile): + + if C.bool(data['validated']): + self._autoconnect_profiles.append(profile) + if len(self._autoconnect_profiles) == len(profile_keys): + # all the profiles have been validated + self.host.plug_profiles(self._autoconnect_profiles) + else: + # a profile is not validated, we go to manual mode + self._autoconnect=False + + for profile_key in profile_keys: + profile = self.host.bridge.getProfileName(profile_key) + if not profile: + self._autoconnect = False # manual mode + msg = _("Trying to plug an unknown profile key ({})".format(profile_key)) + log.warning(msg) + self.alert(_("Profile plugging in error"), msg, ok_cb=self.host.removePopUp) + break + self.host.launchAction(C.AUTHENTICATE_PROFILE_ID, callback=authenticate_cb, profile=profile) + + + def getParamError(self, dummy): + self.alert(_(u"Error"), _("Can't get profile parameter")) + + ## Helping methods ## + + def _getErrorMessage(self, reason): + """Return an error message corresponding to profile creation error + + @param reason (str): reason as returned by asyncCreateProfile + @return (unicode): human readable error message + """ + if reason == "ConflictError": + message = _("A profile with this name already exists") + elif reason == "CancelError": + message = _("Profile creation cancelled by backend") + elif reason == "ValueError": + message = _("You profile name is not valid") # TODO: print a more informative message (empty name, name starting with '@') + else: + message = _("Can't create profile ({})").format(reason) + return message + + def _deleteProfile(self): + """Delete the currently selected profile""" + if self.current.profile: + self.host.bridge.asyncDeleteProfile(self.current.profile, callback=self.refillProfiles) + self.resetFields() + + ## workflow methods (events occuring during the profiles selection) ## + + # These methods must be called by the frontend at some point + + def _onConnectProfiles(self): + """Connect the profiles and start the main widget""" + if self._autoconnect: + self.alert(_('Internal error'), _('You can connect manually and automatically at the same time')) + return + self.updateConnectionParams() + profiles = self.getProfiles() + if not profiles: + self.alert(_('No profile selected'), _('You need to create and select at least one profile before connecting')) + else: + # All profiles in the list are already validated, so we can plug them directly + self.host.plug_profiles(profiles) + + def getConnectionParams(self, profile): + """Get login and password and display them + + @param profile: %(doc_profile)s + """ + self.host.bridge.asyncGetParamA("JabberID", "Connection", profile_key=profile, callback=self.setJID, errback=self.getParamError) + self.host.bridge.asyncGetParamA("Password", "Connection", profile_key=profile, callback=self.setPassword, errback=self.getParamError) + + def updateConnectionParams(self): + """Check if connection parameters have changed, and update them if so""" + if self.current.profile: + login = self.getJID() + password = self.getPassword() + if login != self.current.login and self.current.login is not None: + self.current.login = login + self.host.bridge.setParam("JabberID", login, "Connection", profile_key=self.current.profile) + log.info("login updated for profile [{}]".format(self.current.profile)) + if password != self.current.password and self.current.password is not None: + self.current.password = password + self.host.bridge.setParam("Password", password, "Connection", profile_key=self.current.profile) + log.info("password updated for profile [{}]".format(self.current.profile)) + + ## graphic updates (should probably be overriden in frontends) ## + + def resetFields(self): + """Set profile to None, and reset fields""" + self.current.profile=None + self.setJID("") + self.setPassword("") + + def refillProfiles(self): + """Rebuild the list of profiles""" + profiles = self.host.bridge.getProfilesList() + profiles.sort() + self.setProfiles(profiles) + + ## Method which must be implemented by frontends ## + + # get/set data + + def getProfiles(self): + """Return list of selected profiles + + Must be implemented by frontends + @return (list): list of profiles + """ + raise NotImplementedError + + def setProfiles(self, profiles): + """Update the list of profiles""" + raise NotImplementedError + + + def getJID(self): + """Get current jid + + Must be implemented by frontends + @return (unicode): current jabber id + """ + raise NotImplementedError + + def getPassword(self): + """Get current password + + Must be implemented by frontends + @return (unicode): current password + """ + raise NotImplementedError + + def setJID(self, jid_): + """Set current jid + + Must be implemented by frontends + @param jid_(unicode): jabber id to set + """ + raise NotImplementedError + + def setPassword(self, password): + """Set current password + + Must be implemented by frontends + """ + raise NotImplementedError + + # dialogs + + def alert(self, title, message): + """Show an alert message, must be implemented by frontends + + @param title: title of the dialog/popup + @param message: error message + """ + raise NotImplementedError + + # Note: a method which check profiles change must be implemented too