barrier/src/lib/synergy/ClientApp.cpp

580 lines
12 KiB
C++
Raw Normal View History

2012-06-10 16:50:54 +00:00
/*
* synergy -- mouse and keyboard sharing utility
* Copyright (C) 2012 Synergy Si Ltd.
* Copyright (C) 2002 Chris Schoeneman
2012-06-10 16:50:54 +00:00
*
* This package is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* found in the file LICENSE that should have accompanied this file.
2012-06-10 16:50:54 +00:00
*
* This package 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include "synergy/ClientApp.h"
#include "client/Client.h"
#include "synergy/ArgParser.h"
#include "synergy/protocol_types.h"
#include "synergy/Screen.h"
#include "synergy/XScreen.h"
#include "synergy/ClientArgs.h"
#include "net/NetworkAddress.h"
#include "net/TCPSocketFactory.h"
#include "net/SocketMultiplexer.h"
#include "net/XSocket.h"
#include "mt/Thread.h"
#include "arch/IArchTaskBarReceiver.h"
#include "arch/Arch.h"
#include "base/String.h"
#include "base/Event.h"
#include "base/IEventQueue.h"
#include "base/TMethodEventJob.h"
#include "base/log_outputters.h"
#include "base/EventQueue.h"
#include "base/TMethodJob.h"
#include "base/Log.h"
#include "common/Version.h"
2012-06-10 16:50:54 +00:00
#if SYSAPI_WIN32
#include "arch/win32/ArchMiscWindows.h"
2012-06-10 16:50:54 +00:00
#endif
#if WINAPI_MSWINDOWS
#include "platform/MSWindowsScreen.h"
2012-06-10 16:50:54 +00:00
#elif WINAPI_XWINDOWS
#include "platform/XWindowsScreen.h"
2012-06-10 16:50:54 +00:00
#elif WINAPI_CARBON
#include "platform/OSXScreen.h"
2012-06-10 16:50:54 +00:00
#endif
#if defined(__APPLE__)
#include "platform/OSXDragSimulator.h"
#endif
2012-06-10 16:50:54 +00:00
#include <iostream>
#include <stdio.h>
#define RETRY_TIME 1.0
2014-11-11 13:51:47 +00:00
ClientApp::ClientApp(IEventQueue* events, CreateTaskBarReceiverFunc createTaskBarReceiver) :
App(events, createTaskBarReceiver, new ClientArgs()),
m_client(NULL),
m_clientScreen(NULL),
m_serverAddress(NULL)
2012-06-10 16:50:54 +00:00
{
}
2014-11-11 13:51:47 +00:00
ClientApp::~ClientApp()
2012-06-10 16:50:54 +00:00
{
}
void
2014-11-11 13:51:47 +00:00
ClientApp::parseArgs(int argc, const char* const* argv)
2012-06-10 16:50:54 +00:00
{
2014-11-11 13:51:47 +00:00
ArgParser argParser(this);
bool result = argParser.parseClientArgs(args(), argc, argv);
2012-06-10 16:50:54 +00:00
if (!result || args().m_shouldExit) {
2012-06-10 16:50:54 +00:00
m_bye(kExitArgs);
}
else {
// save server address
if (!args().m_synergyAddress.empty()) {
try {
2014-11-11 13:51:47 +00:00
*m_serverAddress = NetworkAddress(args().m_synergyAddress, kDefaultPort);
m_serverAddress->resolve();
}
catch (XSocketAddress& e) {
// allow an address that we can't look up if we're restartable.
// we'll try to resolve the address each time we connect to the
// server. a bad port will never get better. patch by Brent
// Priddy.
if (!args().m_restartable || e.getError() == XSocketAddress::kBadPort) {
LOG((CLOG_PRINT "%s: %s" BYE,
args().m_pname, e.what(), args().m_pname));
m_bye(kExitFailed);
}
}
}
}
2012-06-10 16:50:54 +00:00
}
void
2014-11-11 13:51:47 +00:00
ClientApp::help()
2012-06-10 16:50:54 +00:00
{
#if WINAPI_XWINDOWS
# define WINAPI_ARG \
" [--display <display>] [--no-xinitthreads]"
# define WINAPI_INFO \
" --display <display> connect to the X server at <display>\n" \
" --no-xinitthreads do not call XInitThreads()\n"
#else
# define WINAPI_ARG
# define WINAPI_INFO
#endif
char buffer[2000];
sprintf(
buffer,
"Usage: %s"
" [--yscroll <delta>]"
WINAPI_ARG
HELP_SYS_ARGS
HELP_COMMON_ARGS
" <server-address>"
"\n\n"
"Connect to a synergy mouse/keyboard sharing server.\n"
"\n"
HELP_COMMON_INFO_1
WINAPI_INFO
HELP_SYS_INFO
" --yscroll <delta> defines the vertical scrolling delta, which is\n"
" 120 by default.\n"
HELP_COMMON_INFO_2
"\n"
"* marks defaults.\n"
"\n"
"The server address is of the form: [<hostname>][:<port>]. The hostname\n"
"must be the address or hostname of the server. The port overrides the\n"
"default port, %d.\n",
args().m_pname, kDefaultPort
);
2012-06-10 16:50:54 +00:00
LOG((CLOG_PRINT "%s", buffer));
2012-06-10 16:50:54 +00:00
}
const char*
2014-11-11 13:51:47 +00:00
ClientApp::daemonName() const
2012-06-10 16:50:54 +00:00
{
#if SYSAPI_WIN32
return "Synergy Client";
#elif SYSAPI_UNIX
return "synergyc";
#endif
}
const char*
2014-11-11 13:51:47 +00:00
ClientApp::daemonInfo() const
2012-06-10 16:50:54 +00:00
{
#if SYSAPI_WIN32
return "Allows another computer to share it's keyboard and mouse with this computer.";
#elif SYSAPI_UNIX
return "";
#endif
}
synergy::Screen*
2014-11-11 13:51:47 +00:00
ClientApp::createScreen()
2012-06-10 16:50:54 +00:00
{
#if WINAPI_MSWINDOWS
2014-11-12 11:44:29 +00:00
return new synergy::Screen(new MSWindowsScreen(
false, args().m_noHooks, args().m_stopOnDeskSwitch, m_events), m_events);
2012-06-10 16:50:54 +00:00
#elif WINAPI_XWINDOWS
2014-11-12 11:28:41 +00:00
return new synergy::Screen(new XWindowsScreen(
2012-06-10 16:50:54 +00:00
args().m_display, false, args().m_disableXInitThreads,
args().m_yscroll, m_events), m_events);
2012-06-10 16:50:54 +00:00
#elif WINAPI_CARBON
return new synergy::Screen(new OSXScreen(m_events, false), m_events);
2012-06-10 16:50:54 +00:00
#endif
}
void
2014-11-11 13:51:47 +00:00
ClientApp::updateStatus()
2012-06-10 16:50:54 +00:00
{
updateStatus("");
}
void
2014-11-11 13:51:47 +00:00
ClientApp::updateStatus(const String& msg)
2012-06-10 16:50:54 +00:00
{
if (m_taskBarReceiver)
{
m_taskBarReceiver->updateStatus(m_client, msg);
2012-06-10 16:50:54 +00:00
}
}
void
2014-11-11 13:51:47 +00:00
ClientApp::resetRestartTimeout()
2012-06-10 16:50:54 +00:00
{
// retry time can nolonger be changed
//s_retryTime = 0.0;
}
double
2014-11-11 13:51:47 +00:00
ClientApp::nextRestartTimeout()
2012-06-10 16:50:54 +00:00
{
// retry at a constant rate (Issue 52)
return RETRY_TIME;
/*
// choose next restart timeout. we start with rapid retries
// then slow down.
if (s_retryTime < 1.0) {
s_retryTime = 1.0;
}
else if (s_retryTime < 3.0) {
s_retryTime = 3.0;
}
else {
s_retryTime = 5.0;
}
return s_retryTime;
*/
}
void
2014-11-11 13:51:47 +00:00
ClientApp::handleScreenError(const Event&, void*)
2012-06-10 16:50:54 +00:00
{
LOG((CLOG_CRIT "error on screen"));
2014-11-11 13:51:47 +00:00
m_events->addEvent(Event(Event::kQuit));
2012-06-10 16:50:54 +00:00
}
synergy::Screen*
2014-11-11 13:51:47 +00:00
ClientApp::openClientScreen()
2012-06-10 16:50:54 +00:00
{
synergy::Screen* screen = createScreen();
screen->setEnableDragDrop(argsBase().m_enableDragDrop);
m_events->adoptHandler(m_events->forIScreen().error(),
2012-06-10 16:50:54 +00:00
screen->getEventTarget(),
2014-11-11 13:51:47 +00:00
new TMethodEventJob<ClientApp>(
this, &ClientApp::handleScreenError));
2012-06-10 16:50:54 +00:00
return screen;
}
void
ClientApp::closeClientScreen(synergy::Screen* screen)
2012-06-10 16:50:54 +00:00
{
if (screen != NULL) {
m_events->removeHandler(m_events->forIScreen().error(),
2012-06-10 16:50:54 +00:00
screen->getEventTarget());
delete screen;
}
}
void
2014-11-11 13:51:47 +00:00
ClientApp::handleClientRestart(const Event&, void* vtimer)
2012-06-10 16:50:54 +00:00
{
// discard old timer
2014-11-11 13:51:47 +00:00
EventQueueTimer* timer = reinterpret_cast<EventQueueTimer*>(vtimer);
m_events->deleteTimer(timer);
2014-11-11 13:51:47 +00:00
m_events->removeHandler(Event::kTimer, timer);
2012-06-10 16:50:54 +00:00
// reconnect
startClient();
}
void
2014-11-11 13:51:47 +00:00
ClientApp::scheduleClientRestart(double retryTime)
2012-06-10 16:50:54 +00:00
{
// install a timer and handler to retry later
LOG((CLOG_DEBUG "retry in %.0f seconds", retryTime));
2014-11-11 13:51:47 +00:00
EventQueueTimer* timer = m_events->newOneShotTimer(retryTime, NULL);
m_events->adoptHandler(Event::kTimer, timer,
new TMethodEventJob<ClientApp>(this, &ClientApp::handleClientRestart, timer));
2012-06-10 16:50:54 +00:00
}
void
2014-11-11 13:51:47 +00:00
ClientApp::handleClientConnected(const Event&, void*)
2012-06-10 16:50:54 +00:00
{
LOG((CLOG_NOTE "connected to server"));
2012-06-10 16:50:54 +00:00
resetRestartTimeout();
updateStatus();
}
void
2014-11-11 13:51:47 +00:00
ClientApp::handleClientFailed(const Event& e, void*)
2012-06-10 16:50:54 +00:00
{
2014-11-11 13:51:47 +00:00
Client::FailInfo* info =
reinterpret_cast<Client::FailInfo*>(e.getData());
2012-06-10 16:50:54 +00:00
2014-11-11 13:51:47 +00:00
updateStatus(String("Failed to connect to server: ") + info->m_what);
2012-06-10 16:50:54 +00:00
if (!args().m_restartable || !info->m_retry) {
LOG((CLOG_ERR "failed to connect to server: %s", info->m_what.c_str()));
2014-11-11 13:51:47 +00:00
m_events->addEvent(Event(Event::kQuit));
2012-06-10 16:50:54 +00:00
}
else {
LOG((CLOG_WARN "failed to connect to server: %s", info->m_what.c_str()));
if (!m_suspended) {
scheduleClientRestart(nextRestartTimeout());
}
}
delete info;
}
void
2014-11-11 13:51:47 +00:00
ClientApp::handleClientDisconnected(const Event&, void*)
2012-06-10 16:50:54 +00:00
{
LOG((CLOG_NOTE "disconnected from server"));
2012-06-10 16:50:54 +00:00
if (!args().m_restartable) {
2014-11-11 13:51:47 +00:00
m_events->addEvent(Event(Event::kQuit));
2012-06-10 16:50:54 +00:00
}
else if (!m_suspended) {
scheduleClientRestart(nextRestartTimeout());
2012-06-10 16:50:54 +00:00
}
updateStatus();
}
2014-11-11 13:51:47 +00:00
Client*
ClientApp::openClient(const String& name, const NetworkAddress& address,
2015-02-11 11:12:54 +00:00
synergy::Screen* screen)
2012-06-10 16:50:54 +00:00
{
2014-11-11 13:51:47 +00:00
Client* client = new Client(
m_events,
name,
address,
2015-01-12 10:33:29 +00:00
new TCPSocketFactory(m_events, getSocketMultiplexer()),
screen,
args());
2012-06-10 16:50:54 +00:00
try {
m_events->adoptHandler(
2014-11-11 13:51:47 +00:00
m_events->forClient().connected(),
2012-06-10 16:50:54 +00:00
client->getEventTarget(),
2014-11-11 13:51:47 +00:00
new TMethodEventJob<ClientApp>(this, &ClientApp::handleClientConnected));
2012-06-10 16:50:54 +00:00
m_events->adoptHandler(
2014-11-11 13:51:47 +00:00
m_events->forClient().connectionFailed(),
2012-06-10 16:50:54 +00:00
client->getEventTarget(),
2014-11-11 13:51:47 +00:00
new TMethodEventJob<ClientApp>(this, &ClientApp::handleClientFailed));
2012-06-10 16:50:54 +00:00
m_events->adoptHandler(
2014-11-11 13:51:47 +00:00
m_events->forClient().disconnected(),
2012-06-10 16:50:54 +00:00
client->getEventTarget(),
2014-11-11 13:51:47 +00:00
new TMethodEventJob<ClientApp>(this, &ClientApp::handleClientDisconnected));
2012-06-10 16:50:54 +00:00
} catch (std::bad_alloc &ba) {
delete client;
throw ba;
}
return client;
}
void
2014-11-11 13:51:47 +00:00
ClientApp::closeClient(Client* client)
2012-06-10 16:50:54 +00:00
{
if (client == NULL) {
return;
}
2014-11-11 13:51:47 +00:00
m_events->removeHandler(m_events->forClient().connected(), client);
m_events->removeHandler(m_events->forClient().connectionFailed(), client);
m_events->removeHandler(m_events->forClient().disconnected(), client);
2012-06-10 16:50:54 +00:00
delete client;
}
int
2014-11-11 13:51:47 +00:00
ClientApp::foregroundStartup(int argc, char** argv)
2012-06-10 16:50:54 +00:00
{
initApp(argc, argv);
// never daemonize
return mainLoop();
}
bool
2014-11-11 13:51:47 +00:00
ClientApp::startClient()
2012-06-10 16:50:54 +00:00
{
double retryTime;
synergy::Screen* clientScreen = NULL;
2012-06-10 16:50:54 +00:00
try {
if (m_clientScreen == NULL) {
2012-06-10 16:50:54 +00:00
clientScreen = openClientScreen();
m_client = openClient(args().m_name,
2015-02-11 11:12:54 +00:00
*m_serverAddress, clientScreen);
m_clientScreen = clientScreen;
LOG((CLOG_NOTE "started client"));
2012-06-10 16:50:54 +00:00
}
m_client->connect();
2012-06-10 16:50:54 +00:00
updateStatus();
return true;
}
catch (XScreenUnavailable& e) {
LOG((CLOG_WARN "secondary screen unavailable: %s", e.what()));
closeClientScreen(clientScreen);
2014-11-11 13:51:47 +00:00
updateStatus(String("secondary screen unavailable: ") + e.what());
2012-06-10 16:50:54 +00:00
retryTime = e.getRetryTime();
}
catch (XScreenOpenFailure& e) {
LOG((CLOG_CRIT "failed to start client: %s", e.what()));
closeClientScreen(clientScreen);
return false;
}
catch (XBase& e) {
LOG((CLOG_CRIT "failed to start client: %s", e.what()));
closeClientScreen(clientScreen);
return false;
}
if (args().m_restartable) {
scheduleClientRestart(retryTime);
return true;
}
else {
// don't try again
return false;
}
}
void
2014-11-11 13:51:47 +00:00
ClientApp::stopClient()
2012-06-10 16:50:54 +00:00
{
closeClient(m_client);
closeClientScreen(m_clientScreen);
m_client = NULL;
m_clientScreen = NULL;
2012-06-10 16:50:54 +00:00
}
int
2014-11-11 13:51:47 +00:00
ClientApp::mainLoop()
2012-06-10 16:50:54 +00:00
{
// create socket multiplexer. this must happen after daemonization
// on unix because threads evaporate across a fork().
2014-11-11 13:51:47 +00:00
SocketMultiplexer multiplexer;
setSocketMultiplexer(&multiplexer);
2012-06-10 16:50:54 +00:00
// load all available plugins.
ARCH->plugin().load();
// pass log and arch into plugins.
ARCH->plugin().init(Log::getInstance(), Arch::getInstance());
// start client, etc
appUtil().startNode();
// init ipc client after node start, since create a new screen wipes out
// the event queue (the screen ctors call adoptBuffer).
if (argsBase().m_enableIpc) {
initIpcClient();
}
2012-06-10 16:50:54 +00:00
// init event for all available plugins.
ARCH->plugin().initEvent(m_clientScreen->getEventTarget(), m_events);
2012-06-10 16:50:54 +00:00
// run event loop. if startClient() failed we're supposed to retry
// later. the timer installed by startClient() will take care of
// that.
DAEMON_RUNNING(true);
#if defined(MAC_OS_X_VERSION_10_7)
2014-11-11 13:51:47 +00:00
Thread thread(
new TMethodJob<ClientApp>(
this, &ClientApp::runEventsLoop,
NULL));
// wait until carbon loop is ready
2014-11-11 13:51:47 +00:00
OSXScreen* screen = dynamic_cast<OSXScreen*>(
m_clientScreen->getPlatformScreen());
screen->waitForCarbonLoop();
runCocoaApp();
#else
m_events->loop();
#endif
2012-06-10 16:50:54 +00:00
DAEMON_RUNNING(false);
// close down
LOG((CLOG_DEBUG1 "stopping client"));
stopClient();
updateStatus();
LOG((CLOG_NOTE "stopped client"));
2012-06-10 16:50:54 +00:00
if (argsBase().m_enableIpc) {
cleanupIpcClient();
}
2015-01-27 10:42:10 +00:00
// unload all plugins.
ARCH->plugin().unload();
2012-06-10 16:50:54 +00:00
return kExitSuccess;
}
static
int
daemonMainLoopStatic(int argc, const char** argv)
{
2014-11-11 13:51:47 +00:00
return ClientApp::instance().daemonMainLoop(argc, argv);
2012-06-10 16:50:54 +00:00
}
int
2014-11-11 13:51:47 +00:00
ClientApp::standardStartup(int argc, char** argv)
2012-06-10 16:50:54 +00:00
{
initApp(argc, argv);
// daemonize if requested
if (args().m_daemon) {
return ARCH->daemonize(daemonName(), &daemonMainLoopStatic);
}
else {
return mainLoop();
}
}
int
2014-11-11 13:51:47 +00:00
ClientApp::runInner(int argc, char** argv, ILogOutputter* outputter, StartupFunc startup)
2012-06-10 16:50:54 +00:00
{
// general initialization
2014-11-11 13:51:47 +00:00
m_serverAddress = new NetworkAddress;
2012-06-10 16:50:54 +00:00
args().m_pname = ARCH->getBasename(argv[0]);
// install caller's output filter
if (outputter != NULL) {
CLOG->insert(outputter);
}
int result;
try
{
// run
result = startup(argc, argv);
}
catch (...)
{
if (m_taskBarReceiver)
{
// done with task bar receiver
delete m_taskBarReceiver;
}
delete m_serverAddress;
2012-06-10 16:50:54 +00:00
throw;
}
return result;
}
void
2014-11-11 13:51:47 +00:00
ClientApp::startNode()
2012-06-10 16:50:54 +00:00
{
// start the client. if this return false then we've failed and
// we shouldn't retry.
LOG((CLOG_DEBUG1 "starting client"));
if (!startClient()) {
m_bye(kExitFailed);
}
}