def loginButtonClicked(self):
from gobject import MainLoop
from dbus.mainloop.glib import DBusGMainLoop
from ubuntuone.platform.credentials import CredentialsManagementTool
DBusGMainLoop(set_as_default=True)
loop = MainLoop()
def loginQuit(result):
loop.quit()
self.service['ubuntuOneInst'] = result
self.service['auth'] = result != None
if self.service['auth']:
self.serviceModel.notifyAuthChanged()
cd = CredentialsManagementTool()
d = cd.login()
d.addCallbacks(loginQuit)
loop.run()
isAuth = self.service['auth']
self.ui.loginButton.setVisible(not isAuth)
self.ui.successLabel.setVisible(isAuth)
self.ui.volumeSettings.setVisible(isAuth)
if isAuth:
self.ui.volumeEdit.setFocus()
def log_in_or_out(login):
MainLoop,DBusGMainLoop,CredentialsManagementTool = import_globals()
global _login_success
_login_success = False
DBusGMainLoop(set_as_default=True)
loop = MainLoop()
def quit(result):
global _login_success
loop.quit()
if result:
_login_success = True
cd = CredentialsManagementTool()
if login:
d = cd.login()
else:
d = cd.clear_credentials()
d.addCallbacks(quit)
loop.run()
if not _login_success and login:
sys.exit(1)
def _request_token(self, autoconnecting):
"""Request to SSO auth service to fetch the token."""
# call ubuntu sso
management = CredentialsManagementTool()
# return the deferred, since we are no longer using signals
if autoconnecting:
return management.find_credentials()
else:
return management.register(window_id=0) # no window ID
def main(email='*****@*****.**', password='******'):
"""Perform a client request to be logged in."""
credtool = CredentialsManagementTool()
print 'Trying to get credentials for email:', email
try:
creds = yield credtool.login_email_password(email=email,
password=password)
print "creds found!", creds
except Exception, e:
print "creds error!", e
def logout():
from gobject import MainLoop
from dbus.mainloop.glib import DBusGMainLoop
from ubuntuone.platform.credentials import CredentialsManagementTool
DBusGMainLoop(set_as_default=True)
loop = MainLoop()
def quit(result):
loop.quit()
cd = CredentialsManagementTool()
d = cd.clear_credentials()
d.addCallbacks(quit)
loop.run()
def setUp(self):
yield super(CredentialsTestCase, self).setUp()
FakedSSOService.error_dict = None
self.creds_server = self.register_server(DBUS_BUS_NAME,
DBUS_CREDENTIALS_PATH,
CredentialsManagement) # real service
self.client = CredentialsManagementTool()
def setUp(self):
yield super(CredentialsManagementToolTestCase, self).setUp()
self.cred_tool = CredentialsManagementTool()
self.patch(self.cred_tool, 'get_platform_source', FakedPlatformSource)
self.proxy = yield self.cred_tool.get_creds_proxy()
self.proxy.error_dict = self.error_dict
self.proxy.error_handler = self.error_handler
self.window_id_arg = {'window_id': '803'}
self.email_password_arg = {'email': '*****@*****.**', 'password': '******'}
def login(self): from gobject import MainLoop from dbus.mainloop.glib import DBusGMainLoop from ubuntuone.platform.credentials import CredentialsManagementTool self.login_success = False DBusGMainLoop(set_as_default=True) loop = MainLoop() def quit(result): loop.quit() if result: self.login_success = True cd = CredentialsManagementTool() d = cd.login() d.addCallbacks(quit) loop.run() return self.login_success
def __init__(self, shutdown_func=None):
"""Initialize the web_client."""
self._status_changed_handler = None
self._credentials = None
self._volumes = {} # cache last known volume info
self.shutdown_func = shutdown_func
self.file_sync_disabled = False
self.login_client = CredentialsManagementTool()
self.sd_client = sd_client.SyncDaemonClient()
self.wc = WebClient(self.get_credentials)
logger.info("ControlBackend: instance started.")
def login():
from gobject import MainLoop
from dbus.mainloop.glib import DBusGMainLoop
from ubuntuone.platform.credentials import CredentialsManagementTool
global _login_success
_login_success = False
DBusGMainLoop(set_as_default=True)
loop = MainLoop()
def quit(result):
global _login_success
loop.quit()
if result:
_login_success = True
cd = CredentialsManagementTool()
d = cd.login()
d.addCallbacks(quit)
loop.run()
if not _login_success:
sys.exit(1)
def login():
from gobject import MainLoop
from dbus.mainloop.glib import DBusGMainLoop
from ubuntuone.platform.credentials import CredentialsManagementTool
global _login_success
_login_success = False
DBusGMainLoop(set_as_default=True)
loop = MainLoop()
def quit(result):
global _login_success
loop.quit()
if result:
_login_success = True
cd = CredentialsManagementTool()
d = cd.login()
d.addCallbacks(quit)
loop.run()
if not _login_success:
sys.exit(1)
class CredentialsManagementToolTestCase(TestCase):
"""Test case for the object that manages Magicicada credentials."""
timeout = 3
error_dict = None
error_handler = None
@defer.inlineCallbacks
def setUp(self):
yield super(CredentialsManagementToolTestCase, self).setUp()
self.cred_tool = CredentialsManagementTool()
self.patch(self.cred_tool, 'get_platform_source', FakedPlatformSource)
self.proxy = yield self.cred_tool.get_creds_proxy()
self.proxy.error_dict = self.error_dict
self.proxy.error_handler = self.error_handler
self.window_id_arg = {'window_id': '803'}
self.email_password_arg = {'email': '*****@*****.**', 'password': '******'}
@defer.inlineCallbacks
def test_proxy_is_reused(self):
"""The inner proxy is re-used."""
proxy1 = yield self.cred_tool.get_creds_proxy()
proxy2 = yield self.cred_tool.get_creds_proxy()
self.assertTrue(proxy1 is proxy2)
def test_ui_params(self):
"""The UI_PARAMS dict is correct."""
expected = {
HELP_TEXT_KEY: DESCRIPTION,
PING_URL_KEY: PING_URL,
POLICY_URL_KEY: POLICY_URL,
TC_URL_KEY: TC_URL,
UI_EXECUTABLE_KEY: UI_EXECUTABLE_QT,
}
self.assertEqual(expected, UI_PARAMS)
class CredentialsTestCase(BaseTestCase):
"""Test suite for the Credentials class."""
@inlineCallbacks
def setUp(self):
yield super(CredentialsTestCase, self).setUp()
FakedSSOService.error_dict = None
self.creds_server = self.register_server(DBUS_BUS_NAME,
DBUS_CREDENTIALS_PATH,
CredentialsManagement) # real service
self.client = CredentialsManagementTool()
@inlineCallbacks
def test_find_credentials_no_credentials(self):
"""Find credentials when credentials does not exist."""
result = yield self.client.find_credentials()
self.assertEqual(result, {})
@inlineCallbacks
def test_find_credentials_with_credentials(self):
"""Find credentials when credentials exists."""
yield self.client.store_credentials(FAKED_CREDENTIALS)
result = yield self.client.find_credentials()
self.assertEqual(result, FAKED_CREDENTIALS)
@inlineCallbacks
def test_find_credentials_error(self):
"""Find credentials and error."""
FakedSSOService.error_dict = {'failure': 'really'}
e = yield self.assertFailure(self.client.find_credentials(),
CredentialsError)
self.assertEqual(e[0], FakedSSOService.error_dict)
@inlineCallbacks
def test_clear_credentials(self):
"""Clear credentials."""
yield self.client.store_credentials({'test': 'me'})
yield self.client.clear_credentials()
result = yield self.client.find_credentials()
self.assertEqual(result, {})
@inlineCallbacks
def test_clear_credentials_error(self):
"""Clear credentials and error."""
FakedSSOService.error_dict = {'failure': 'really'}
e = yield self.assertFailure(self.client.clear_credentials(),
CredentialsError)
self.assertEqual(e[0], FakedSSOService.error_dict)
@inlineCallbacks
def test_store_credentials(self):
"""Store credentials."""
token = {'test': 'me'}
yield self.client.store_credentials(token)
result = yield self.client.find_credentials()
self.assertEqual(result, token)
@inlineCallbacks
def test_store_credentials_error(self):
"""Store credentials and error."""
FakedSSOService.error_dict = {'failure': 'really'}
e = yield self.assertFailure(self.client.store_credentials({'0': '1'}),
CredentialsError)
self.assertEqual(e[0], FakedSSOService.error_dict)
@inlineCallbacks
def test_register(self):
"""Register."""
result = yield self.client.register()
self.assertEqual(result, FAKED_CREDENTIALS)
@inlineCallbacks
def test_register_auth_denied(self):
"""Register and auth_denied."""
yield self.client.store_credentials({}) # trigger AuthorizationDenied
result = yield self.client.register()
self.assertEqual(result, None)
@inlineCallbacks
def test_register_error(self):
"""Register and error."""
FakedSSOService.error_dict = {'failure': 'really'}
e = yield self.assertFailure(self.client.register(),
CredentialsError)
self.assertEqual(e[0], FakedSSOService.error_dict)
@inlineCallbacks
def test_login(self):
"""Login."""
result = yield self.client.login()
self.assertEqual(result, FAKED_CREDENTIALS)
@inlineCallbacks
def test_login_auth_denied(self):
"""Login and auth denied."""
yield self.client.store_credentials({}) # trigger AuthorizationDenied
result = yield self.client.login()
self.assertEqual(result, None)
@inlineCallbacks
def test_login_error(self):
"""Login and error."""
FakedSSOService.error_dict = {'failure': 'really'}
e = yield self.assertFailure(self.client.login(),
CredentialsError)
self.assertEqual(e[0], FakedSSOService.error_dict)
class ControlBackend(object):
"""The control panel backend."""
ROOT_TYPE = u"ROOT"
FOLDER_TYPE = u"UDF"
SHARE_TYPE = u"SHARE"
NAME_NOT_SET = u"ENAMENOTSET"
FREE_BYTES_NOT_AVAILABLE = u"EFREEBYTESNOTAVAILABLE"
STATUS_DISABLED = {MSG_KEY: "", STATUS_KEY: FILE_SYNC_DISABLED}
DEFAULT_FILE_SYNC_SETTINGS = {
AUTOCONNECT_KEY: True,
SHOW_ALL_NOTIFICATIONS_KEY: True,
SHARE_AUTOSUBSCRIBE_KEY: False,
UDF_AUTOSUBSCRIBE_KEY: False,
DOWNLOAD_KEY: -1, # no limit
UPLOAD_KEY: -1, # no limit
}
def __init__(self, shutdown_func=None):
"""Initialize the web_client."""
self._status_changed_handler = None
self._credentials = None
self._volumes = {} # cache last known volume info
self.shutdown_func = shutdown_func
self.file_sync_disabled = False
self.login_client = CredentialsManagementTool()
self.sd_client = sd_client.SyncDaemonClient()
self.wc = WebClient(self.get_credentials)
logger.info("ControlBackend: instance started.")
def get_home_dir(self):
"""Return a defer with the home_dir from ubuntu one client."""
return self.sd_client.get_home_dir()
def _process_file_sync_status(self, status):
"""Process raw file sync status into custom format.
Return a dictionary with two members:
* STATUS_KEY: the current status of syncdaemon, can be one of:
FILE_SYNC_DISABLED, FILE_SYNC_STARTING, FILE_SYNC_DISCONNECTED,
FILE_SYNC_SYNCING, FILE_SYNC_IDLE, FILE_SYNC_ERROR,
FILE_SYNC_UNKNOWN
* MSG_KEY: a non translatable but human readable string of the status.
"""
logger.debug("sync status: %r", status)
if not status:
self.file_sync_disabled = True
return self.STATUS_DISABLED
msg = "%s (%s)" % (status["description"], status["name"])
result = {MSG_KEY: msg}
# file synch is enabled
is_error = bool(status["is_error"])
is_synching = bool(status["is_connected"])
is_idle = bool(status["is_online"]) and status["queues"] == "IDLE"
is_disconnected = status["name"] == "WAITING" or (
status["name"] == "READY" and "Not User" in status["connection"]
)
is_starting = status["name"] in ("INIT", "LOCAL_RESCAN", "READY")
is_stopped = status["name"] == "SHUTDOWN"
if is_error:
result[STATUS_KEY] = FILE_SYNC_ERROR
elif is_idle:
result[STATUS_KEY] = FILE_SYNC_IDLE
elif is_synching:
result[STATUS_KEY] = FILE_SYNC_SYNCING
elif is_disconnected:
result[STATUS_KEY] = FILE_SYNC_DISCONNECTED
elif is_starting:
self.file_sync_disabled = False
result[STATUS_KEY] = FILE_SYNC_STARTING
elif is_stopped:
result[STATUS_KEY] = FILE_SYNC_STOPPED
else:
logger.warning("file_sync_status: unknown (got %r)", status)
result[STATUS_KEY] = FILE_SYNC_UNKNOWN
if self.file_sync_disabled:
return self.STATUS_DISABLED
else:
return result
def _set_status_changed_handler(self, handler):
"""Set 'handler' to be called when file sync status changes."""
logger.debug("setting status_changed_handler to %r", handler)
def process_and_callback(status):
"""Process syncdaemon's status and callback 'handler'."""
result = self._process_file_sync_status(status)
handler(result)
self._status_changed_handler = handler
self.sd_client.set_status_changed_handler(process_and_callback)
def _get_status_changed_handler(self):
"""Return the handler to be called when file sync status changes."""
return self._status_changed_handler
status_changed_handler = property(_get_status_changed_handler, _set_status_changed_handler)
@inlineCallbacks
def _process_device_web_info(
self,
devices,
enabled=None,
limit_bw=None,
limits=None,
autoconnect=None,
show_notifs=None,
share_autosubscribe=None,
udf_autosubscribe=None,
):
"""Return a lis of processed devices.
If all the file sync settings are None, do not attach that info.
"""
result = []
for d in devices:
di = {}
di["type"] = d["kind"]
di["name"] = d["description"] if d["description"] else self.NAME_NOT_SET
if di["type"] == DEVICE_TYPE_COMPUTER:
di["device_id"] = di["type"] + d["token"]
if di["type"] == DEVICE_TYPE_PHONE:
di["device_id"] = di["type"] + str(d["id"])
is_local = yield self.device_is_local(di["device_id"])
di["is_local"] = is_local
if is_local: # prepend the local device!
result.insert(0, di)
else:
result.append(di)
if enabled is None:
# without knowing if file sync is enabled or not,
# we can't add any extra info about the device.
continue
# currently, only local devices are configurable.
di["configurable"] = is_local and enabled
if di["configurable"]:
di[LIMIT_BW_KEY] = limit_bw
di[AUTOCONNECT_KEY] = autoconnect
di[SHOW_ALL_NOTIFICATIONS_KEY] = show_notifs
di[SHARE_AUTOSUBSCRIBE_KEY] = share_autosubscribe
di[UDF_AUTOSUBSCRIBE_KEY] = udf_autosubscribe
di[UPLOAD_KEY] = limits["upload"]
di[DOWNLOAD_KEY] = limits["download"]
returnValue(result)
@inlineCallbacks
def _process_device_local_info(
self,
enabled=None,
limit_bw=None,
limits=None,
autoconnect=None,
show_notifs=None,
share_autosubscribe=None,
udf_autosubscribe=None,
):
"""Return the information for the local device.
If all the file sync settings are None, do not attach that info.
"""
credentials = yield self.get_credentials()
local_device = {}
local_device["type"] = DEVICE_TYPE_COMPUTER
local_device["name"] = credentials["name"]
device_id = local_device["type"] + credentials["token"]
local_device["device_id"] = device_id
local_device["is_local"] = True
if enabled is not None:
local_device["configurable"] = enabled
if local_device["configurable"]:
local_device[LIMIT_BW_KEY] = limit_bw
local_device[AUTOCONNECT_KEY] = autoconnect
local_device[SHOW_ALL_NOTIFICATIONS_KEY] = show_notifs
local_device[SHARE_AUTOSUBSCRIBE_KEY] = share_autosubscribe
local_device[UDF_AUTOSUBSCRIBE_KEY] = udf_autosubscribe
upload = limits["upload"]
download = limits["download"]
local_device[UPLOAD_KEY] = upload
local_device[DOWNLOAD_KEY] = download
returnValue(local_device)
@inlineCallbacks
def _process_path(self, path):
"""Trim 'path' so the '~' is removed."""
home_dir = yield self.get_home_dir()
if not home_dir.endswith(os.path.sep):
home_dir += os.path.sep
if path.startswith(home_dir):
path = path[len(home_dir) :]
returnValue(path)
@inlineCallbacks
def build_signed_iri(self, iri):
"""Returned an OAuth signed iri."""
credentials = None
if iri.startswith(UBUNTUONE_LINK):
credentials = yield self.get_credentials()
if credentials:
parameters = {"next": iri}
iri = yield self.wc.build_signed_iri(UBUNTUONE_FROM_OAUTH, parameters)
returnValue(iri)
@inlineCallbacks
def get_credentials(self):
"""Find credentials."""
if not self._credentials:
self._credentials = yield self.login_client.find_credentials()
returnValue(self._credentials)
@inlineCallbacks
def clear_credentials(self):
"""Clear the credentials."""
self._credentials = None
yield self.login_client.clear_credentials()
@inlineCallbacks
def get_token(self):
"""Return the token from the credentials."""
credentials = yield self.get_credentials()
returnValue(credentials["token"])
@log_call(logger.debug, with_args=False)
@inlineCallbacks
def login(self, email=None, password=None):
"""Login using 'email' and 'password' if not None, else prompt user."""
result = None
if email is not None and password is not None:
result = yield self.login_client.login_email_password(email=email, password=password)
else:
result = yield self.login_client.login()
# cache credentils
self._credentials = result
returnValue(result)
@log_call(logger.debug)
@inlineCallbacks
def register(self):
"""Register a new user."""
result = yield self.login_client.register()
# cache credentils
self._credentials = result
returnValue(result)
@inlineCallbacks
def device_is_local(self, device_id):
"""Return whether 'device_id' is the local devicew or not."""
dtype, did = self.type_n_id(device_id)
local_token = yield self.get_token()
is_local = dtype == DEVICE_TYPE_COMPUTER and did == local_token
returnValue(is_local)
@log_call(logger.debug)
@process_unauthorized
@inlineCallbacks
def account_info(self):
"""Get the user account info."""
result = {}
account_info = yield self.wc.call_api(ACCOUNT_API)
logger.debug("account_info from api call: %r", account_info)
if "current_plan" in account_info:
desc = account_info["current_plan"]
elif "subscription" in account_info and "description" in account_info["subscription"]:
desc = account_info["subscription"]["description"]
else:
desc = ""
result["type"] = desc
result["name"] = account_info["nickname"]
result["email"] = account_info["email"]
quota_info = yield self.wc.call_api(QUOTA_API)
result["quota_total"] = quota_info["total"]
result["quota_used"] = quota_info["used"]
returnValue(result)
@log_call(logger.debug)
@process_unauthorized
@inlineCallbacks
def devices_info(self):
"""Get the user devices info."""
result = limit_bw = limits = None
autoconnect = show_notifs = None
share_autosubscribe = udf_autosubscribe = None
enabled = yield self.sd_client.files_sync_enabled()
enabled = bool(enabled)
if enabled:
sd_res = yield self.sd_client.autoconnect_enabled()
autoconnect = bool(sd_res)
sd_res = yield self.sd_client.show_all_notifications_enabled()
show_notifs = bool(sd_res)
sd_res = yield self.sd_client.share_autosubscribe_enabled()
share_autosubscribe = bool(sd_res)
sd_res = yield self.sd_client.udf_autosubscribe_enabled()
udf_autosubscribe = bool(sd_res)
sd_res = yield self.sd_client.bandwidth_throttling_enabled()
limit_bw = bool(sd_res)
limits = yield self.sd_client.get_throttling_limits()
logger.debug(
"devices_info: file sync enabled? %s limit_bw %s, limits "
"%s, autoconnect %s, show_notifs %s, "
"share_autosubscribe %s, udf_autosubscribe %s",
enabled,
limit_bw,
limits,
autoconnect,
show_notifs,
share_autosubscribe,
udf_autosubscribe,
)
try:
devices = yield self.wc.call_api(DEVICES_API)
except UnauthorizedError:
raise
except WebClientError:
logger.exception("devices_info: web client failure:")
else:
result = yield self._process_device_web_info(
devices, enabled, limit_bw, limits, autoconnect, show_notifs, share_autosubscribe, udf_autosubscribe
)
if result is None:
local_device = yield self._process_device_local_info(
enabled, limit_bw, limits, autoconnect, show_notifs, share_autosubscribe, udf_autosubscribe
)
result = [local_device]
logger.info("devices_info: result is %r", filter_field(result, field="device_id"))
returnValue(result)
@log_call(logger.debug)
@process_unauthorized
@inlineCallbacks
def device_names_info(self):
"""Get the user devices info, only list names and kind."""
result = None
try:
devices = yield self.wc.call_api(DEVICES_API)
except UnauthorizedError:
raise
except WebClientError:
logger.exception("device_names_info: web client failure:")
else:
result = yield self._process_device_web_info(devices)
if result is None:
local_device = yield self._process_device_local_info()
result = [local_device]
logger.info("device_names_info: result is %r", filter_field(result, field="device_id"))
returnValue(result)
def type_n_id(self, device_id):
"""Return the device type and id, as used by the /devices api."""
if device_id.startswith(DEVICE_TYPE_COMPUTER):
return DEVICE_TYPE_COMPUTER, device_id[8:]
if device_id.startswith(DEVICE_TYPE_PHONE):
return DEVICE_TYPE_PHONE, device_id[5:]
return "No device", device_id
@log_call(logger.info, with_args=False)
@inlineCallbacks
def change_device_settings(self, device_id, settings):
"""Change the settings for the given device."""
is_local = yield self.device_is_local(device_id)
if is_local and SHOW_ALL_NOTIFICATIONS_KEY in settings:
if not settings[SHOW_ALL_NOTIFICATIONS_KEY]:
yield self.sd_client.disable_show_all_notifications()
else:
yield self.sd_client.enable_show_all_notifications()
if is_local and LIMIT_BW_KEY in settings:
if not settings[LIMIT_BW_KEY]:
yield self.sd_client.disable_bandwidth_throttling()
else:
yield self.sd_client.enable_bandwidth_throttling()
if is_local and (UPLOAD_KEY in settings or DOWNLOAD_KEY in settings):
current_limits = yield self.sd_client.get_throttling_limits()
limits = {"download": current_limits["download"], "upload": current_limits["upload"]}
if UPLOAD_KEY in settings:
limits["upload"] = settings[UPLOAD_KEY]
if DOWNLOAD_KEY in settings:
limits["download"] = settings[DOWNLOAD_KEY]
self.sd_client.set_throttling_limits(limits)
# still pending: more work on the settings dict (LP: #673674)
returnValue(device_id)
@log_call(logger.warning, with_args=False)
@process_unauthorized
@inlineCallbacks
def remove_device(self, device_id):
"""Remove a device's tokens from the sso server."""
dtype, did = self.type_n_id(device_id)
is_local = yield self.device_is_local(device_id)
api = DEVICE_REMOVE_API % (dtype.lower(), did)
yield self.wc.call_api(api)
if is_local:
logger.warning("remove_device: device is local! removing and " "clearing credentials.")
yield self.clear_credentials()
returnValue(device_id)
@log_call(logger.debug)
@inlineCallbacks
def file_sync_status(self):
"""Return the status of the file sync service."""
enabled = yield self.sd_client.files_sync_enabled()
if enabled:
status = yield self.sd_client.get_current_status()
else:
status = {}
returnValue(self._process_file_sync_status(status))
@log_call(logger.debug)
@inlineCallbacks
def enable_files(self):
"""Enable the files service."""
yield self.sd_client.set_files_sync_enabled(True)
self.file_sync_disabled = False
@log_call(logger.debug)
@inlineCallbacks
def disable_files(self):
"""Enable the files service."""
yield self.sd_client.set_files_sync_enabled(False)
self.file_sync_disabled = True
@log_call(logger.debug)
@inlineCallbacks
def connect_files(self):
"""Connect the files service."""
yield self.sd_client.connect_file_sync()
@log_call(logger.debug)
@inlineCallbacks
def disconnect_files(self):
"""Disconnect the files service."""
yield self.sd_client.disconnect_file_sync()
@log_call(logger.debug)
@inlineCallbacks
def restart_files(self):
"""restart the files service."""
yield self.sd_client.stop_file_sync()
yield self.sd_client.start_file_sync()
@log_call(logger.debug)
@inlineCallbacks
def start_files(self):
"""start the files service."""
yield self.sd_client.start_file_sync()
@log_call(logger.debug)
@inlineCallbacks
def stop_files(self):
"""stop the files service."""
yield self.sd_client.stop_file_sync()
@log_call(logger.debug)
@inlineCallbacks
def volumes_info(self, with_storage_info=True, refresh=False):
"""Get the volumes info."""
self._volumes = {}
free_bytes = self.FREE_BYTES_NOT_AVAILABLE
if with_storage_info:
try:
account = yield self.account_info()
except Exception: # pylint: disable=W0703
logger.exception("volumes_info: quota could not be retrieved:")
else:
free_bytes = account["quota_total"] - account["quota_used"]
if refresh:
yield self.sd_client.refresh_volumes()
root_dir = yield self.sd_client.get_root_dir()
shares_dir = yield self.sd_client.get_shares_dir()
shares_dir_link = yield self.sd_client.get_shares_dir_link()
folders = yield self.sd_client.get_folders()
shares = yield self.sd_client.get_shares()
display_name = yield self._process_path(root_dir)
root_volume = {
u"volume_id": u"",
u"path": root_dir,
u"subscribed": True,
u"type": self.ROOT_TYPE,
u"display_name": display_name,
}
self._volumes[u""] = root_volume
# group shares by the offering user
shares_result = defaultdict(list)
for share in shares:
if not bool(share["accepted"]):
continue
share[u"type"] = self.SHARE_TYPE
vid = share["volume_id"]
if vid in self._volumes:
logger.warning("volumes_info: share %r already in the volumes " "list (%r).", vid, self._volumes[vid])
self._volumes[vid] = share
share[u"realpath"] = share[u"path"]
nicer_path = share[u"path"].replace(shares_dir, shares_dir_link)
share[u"path"] = nicer_path
share[u"subscribed"] = bool(share[u"subscribed"])
share[u"display_name"] = share[u"name"]
username = share["other_visible_name"]
if not username:
username = u"%s (%s)" % (share["other_username"], self.NAME_NOT_SET)
shares_result[username].append(share)
for folder in folders:
folder[u"type"] = self.FOLDER_TYPE
vid = folder["volume_id"]
if vid in self._volumes:
logger.warning("volumes_info: udf %r already in the volumes " "list (%r).", vid, self._volumes[vid])
folder[u"subscribed"] = bool(folder[u"subscribed"])
display_name = yield self._process_path(folder[u"path"])
folder[u"display_name"] = display_name
self._volumes[vid] = folder
folders.sort(key=operator.itemgetter("path"))
result = [(u"", free_bytes, [root_volume] + folders)]
for other_username, shares in shares_result.iteritems():
send_freebytes = any(s["access_level"] == "Modify" for s in shares)
if send_freebytes:
free_bytes = int(shares[0][u"free_bytes"])
else:
free_bytes = self.FREE_BYTES_NOT_AVAILABLE
shares.sort(key=operator.itemgetter("path"))
result.append((other_username, free_bytes, shares))
returnValue(result)
@log_call(logger.debug)
@inlineCallbacks
def change_volume_settings(self, volume_id, settings):
"""Change settings for 'volume_id'.
Currently, only supported setting is boolean 'subscribed'.
"""
if "subscribed" in settings:
subscribed = settings["subscribed"]
if subscribed:
yield self.subscribe_volume(volume_id)
else:
yield self.unsubscribe_volume(volume_id)
returnValue(volume_id)
@inlineCallbacks
def subscribe_volume(self, volume_id):
"""Subscribe to 'volume_id'."""
if self._volumes[volume_id][u"type"] == self.FOLDER_TYPE:
yield self.sd_client.subscribe_folder(volume_id)
elif self._volumes[volume_id][u"type"] == self.SHARE_TYPE:
yield self.sd_client.subscribe_share(volume_id)
@inlineCallbacks
def unsubscribe_volume(self, volume_id):
"""Unsubscribe from 'volume_id'."""
if self._volumes[volume_id][u"type"] == self.FOLDER_TYPE:
yield self.sd_client.unsubscribe_folder(volume_id)
elif self._volumes[volume_id][u"type"] == self.SHARE_TYPE:
yield self.sd_client.unsubscribe_share(volume_id)
@log_call(logger.debug)
@inlineCallbacks
def create_folder(self, folder_path):
"""Create a new User Defined Folder pointing to 'folder_path'."""
yield self.sd_client.create_folder(path=folder_path)
@log_call(logger.debug)
def validate_path_for_folder(self, folder_path):
"""Validate 'folder_path' for folder creation."""
return self.sd_client.validate_path(folder_path)
@log_call(logger.debug)
@inlineCallbacks
def replications_info(self):
"""Get the user replications info."""
replications = yield replication_client.get_replications()
exclusions = yield replication_client.get_exclusions()
result = []
for rep in replications:
dependency = ""
if rep == replication_client.CONTACTS:
dependency = CONTACTS_PKG
repd = {
"replication_id": rep,
"name": rep, # this may change to be more user friendly
"enabled": rep not in exclusions,
"dependency": dependency,
}
result.append(repd)
returnValue(result)
@log_call(logger.info)
@inlineCallbacks
def change_replication_settings(self, replication_id, settings):
"""Change the settings for the given replication."""
if "enabled" in settings:
if settings["enabled"]:
yield replication_client.replicate(replication_id)
else:
yield replication_client.exclude(replication_id)
returnValue(replication_id)
@log_call(logger.debug)
@inlineCallbacks
def file_sync_settings_info(self):
"""Get the file sync settings info."""
result = {}
for name in (AUTOCONNECT_KEY, SHOW_ALL_NOTIFICATIONS_KEY, SHARE_AUTOSUBSCRIBE_KEY, UDF_AUTOSUBSCRIBE_KEY):
sd_method = getattr(self.sd_client, "%s_enabled" % name)
value = yield sd_method()
result[name] = bool(value)
limits = yield self.sd_client.get_throttling_limits()
limits_enabled = yield self.sd_client.bandwidth_throttling_enabled()
if limits_enabled:
result[DOWNLOAD_KEY] = limits["download"]
result[UPLOAD_KEY] = limits["upload"]
else:
result[DOWNLOAD_KEY] = -1
result[UPLOAD_KEY] = -1
returnValue(result)
@inlineCallbacks
def _change_boolean_file_sync_setting(self, setting_name, settings):
"""Change the value for 'setting_name' to be 'new_value'."""
if setting_name in settings:
new_value = settings[setting_name]
sd_method_name = "enable_%s" if new_value else "disable_%s"
sd_method = getattr(self.sd_client, sd_method_name % setting_name)
yield sd_method()
@log_call(logger.info)
@inlineCallbacks
def change_file_sync_settings(self, settings):
"""Change the file sync settings."""
for name in (AUTOCONNECT_KEY, SHOW_ALL_NOTIFICATIONS_KEY, SHARE_AUTOSUBSCRIBE_KEY, UDF_AUTOSUBSCRIBE_KEY):
yield self._change_boolean_file_sync_setting(name, settings)
if DOWNLOAD_KEY in settings or UPLOAD_KEY in settings:
current_limits = yield self.sd_client.get_throttling_limits()
limits = {"download": current_limits["download"], "upload": current_limits["upload"]}
if UPLOAD_KEY in settings:
limits["upload"] = settings[UPLOAD_KEY]
if DOWNLOAD_KEY in settings:
limits["download"] = settings[DOWNLOAD_KEY]
yield self.sd_client.set_throttling_limits(limits)
throttling_disabled = sum(limits.itervalues()) == -2
if throttling_disabled:
yield self.sd_client.disable_bandwidth_throttling()
else:
yield self.sd_client.enable_bandwidth_throttling()
@log_call(logger.info)
@inlineCallbacks
def restore_file_sync_settings(self):
"""Restore the file sync settings."""
yield self.change_file_sync_settings(self.DEFAULT_FILE_SYNC_SETTINGS)
@log_call(logger.info)
def shutdown(self):
"""Stop this service."""
# do any other needed cleanup
if self.shutdown_func is not None:
self.shutdown_func()
def get_ubuntuone_credentials(self):
cmt = CredentialsManagementTool()
return cmt.find_credentials()
def get_ubuntuone_credentials(self):
cmt = CredentialsManagementTool()
return cmt.find_credentials()