From af6493bf45fcd9174b485f8ae0532e2eb4e6914e Mon Sep 17 00:00:00 2001 From: Roger Planas <roger.planas@isode.com> Date: Fri, 5 Feb 2016 12:45:39 +0000 Subject: Sluift: Add timeout to roster receiving operations This avoids Sluift indefinitely waiting if the server does not respond Test-Information: Before the patch, a sluift client would wait indefinitely if a buggy XMPP server does not respond. With this patch, sluift clients now timeout and through an exception after SLUIFT_TIMEOUT when the server does not respond. Change-Id: I9d36f53a8f4d5b3d594cef68c42de38fd5a1c296 diff --git a/Sluift/SluiftClient.cpp b/Sluift/SluiftClient.cpp index 9db8969..d2b1beb 100644 --- a/Sluift/SluiftClient.cpp +++ b/Sluift/SluiftClient.cpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2013-2014 Isode Limited. + * Copyright (c) 2013-2016 Isode Limited. * All rights reserved. * See the COPYING file for more information. */ @@ -125,13 +125,21 @@ boost::optional<SluiftClient::Event> SluiftClient::getNextEvent( } } -std::vector<XMPPRosterItem> SluiftClient::getRoster() { +std::vector<XMPPRosterItem> SluiftClient::getRoster(int timeout) { + Watchdog watchdog(timeout, networkFactories->getTimerFactory()); if (!rosterReceived) { // If we haven't requested it yet, request it for the first time client->requestRoster(); - } - while (!rosterReceived) { - eventLoop->runUntilEvents(); + + // Wait for new events + while (!watchdog.getTimedOut() && !rosterReceived) { + eventLoop->runUntilEvents(); + } + + // Throw an error if we're timed out + if (watchdog.getTimedOut()) { + throw Lua::Exception("Timeout while requesting roster"); + } } return client->getRoster()->getItems(); } diff --git a/Sluift/SluiftClient.h b/Sluift/SluiftClient.h index b7a6578..68c4b61 100644 --- a/Sluift/SluiftClient.h +++ b/Sluift/SluiftClient.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2013 Isode Limited. + * Copyright (c) 2013-2016 Isode Limited. * All rights reserved. * See the COPYING file for more information. */ @@ -103,7 +103,7 @@ namespace Swift { void setSoftwareVersion(const std::string& name, const std::string& version, const std::string& os); boost::optional<SluiftClient::Event> getNextEvent(int timeout, boost::function<bool (const Event&)> condition = 0); - std::vector<XMPPRosterItem> getRoster(); + std::vector<XMPPRosterItem> getRoster(int timeout); private: Sluift::Response doSendRequest(boost::shared_ptr<Request> request, int timeout); diff --git a/Sluift/client.cpp b/Sluift/client.cpp index 8f6ff3a..6373a20 100644 --- a/Sluift/client.cpp +++ b/Sluift/client.cpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2013-2015 Isode Limited. + * Copyright (c) 2013-2016 Isode Limited. * All rights reserved. * See the COPYING file for more information. */ @@ -186,7 +186,7 @@ SLUIFT_LUA_FUNCTION_WITH_HELP( SluiftClient* client = getClient(L); Lua::Table contactsTable; - foreach(const XMPPRosterItem& item, client->getRoster()) { + foreach(const XMPPRosterItem& item, client->getRoster(getGlobalTimeout(L))) { std::string subscription; switch(item.getSubscription()) { case RosterItemPayload::None: subscription = "none"; break; @@ -636,7 +636,7 @@ SLUIFT_LUA_FUNCTION_WITH_HELP( item.setJID(Lua::checkString(L, 2)); } - client->getRoster(); + client->getRoster(timeout); if (!client->getClient()->getRoster()->containsJID(item.getJID())) { RosterPayload::ref roster = boost::make_shared<RosterPayload>(); roster->addItem(item); -- cgit v0.10.2-6-g49f6