BTConnection.cpp

/*
* This file is part of buteo-sync-plugins package
*
* Copyright (C) 2010 Nokia Corporation. All rights reserved.
*
* Contact: Sateesh Kavuri <sateesh.kavuri@nokia.com>
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
* Neither the name of Nokia Corporation nor the names of its contributors may
* be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*
*/

#include "BTConnection.h"

#include <unistd.h>
#include <QtDBus>
#include <QDBusConnection>
#include <fcntl.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <termios.h>

#include "SyncMLPluginLogging.h"

#define BLUEZ_DEST "org.bluez"
#define BLUEZ_MANAGER_INTERFACE "org.bluez.Manager"
#define BLUEZ_ADAPTER_INTERFACE "org.bluez.Adapter"
#define BLUEZ_SERIAL_INTERFACE "org.bluez.Serial"
#define REQUEST_SESSION "RequestSession"
#define RELEASE_SESSION "ReleaseSession"
#define GET_DEFAULT_ADAPTER "DefaultAdapter"
#define FIND_DEVICE "FindDevice"
#define CREATE_DEVICE "CreateDevice"
#define CREATE_PAIRED_DEVICE "CreatePairedDevice"
#define CONNECT "Connect"
#define DISCONNECT "Disconnect"

BTConnection::BTConnection()
 : iFd( -1 )
{
    FUNCTION_CALL_TRACE(lcSyncMLPluginTrace);
}

BTConnection::~BTConnection()
{
    FUNCTION_CALL_TRACE(lcSyncMLPluginTrace);
    disconnect();
}

void BTConnection::setConnectionInfo( const QString& aBTAddress,
                                      const QString& aServiceUUID )
{
    FUNCTION_CALL_TRACE(lcSyncMLPluginTrace);
    iBTAddress = aBTAddress;
    iServiceUUID = aServiceUUID;
}

int BTConnection::connect()
{
    FUNCTION_CALL_TRACE(lcSyncMLPluginTrace);

    if( iFd != -1 ) {
        qCDebug(lcSyncMLPlugin) << "Using existing connection";
        return iFd;
    }

    iDevice = connectDevice( iBTAddress, iServiceUUID );

    if( iDevice.isEmpty() ) {
        qCCritical(lcSyncMLPlugin) << "Could not connect to device" << iBTAddress << ", aborting";
        return -1;
    }

    // HACK: In Sailfish, sometimes, opening the device
    // immediately after the bluetooth connect fails and works only
    // if some delay is introduced.
    // Since a plugin runs in a separate thread/process (incase of oop)
    // it is okay to introduce some delay before the open. We will use
    // a retry count of 3 to open the connection and finally giveup
    // otherwise
    int retryCount = 3;
    do {
        iFd = open( iDevice.toLatin1().constData(), O_RDWR | O_NOCTTY | O_SYNC );
        if (iFd > 0) break;
        QThread::msleep (100); // Sleep for 100msec before trying again
    } while ((--retryCount > 0) && (iFd == -1));

    if( iFd == -1 ) {
        qCCritical(lcSyncMLPlugin) << "Could not open file descriptor of the connection, aborting";
        disconnectDevice( iBTAddress, iDevice );
        return -1;
    }

    fdRawMode( iFd );

    return iFd;
}

bool BTConnection::isConnected() const
{
    if( iFd != -1 )
    {
        return true;
    }
    else
    {
        return false;
    }

}

void BTConnection::disconnect()
{
    FUNCTION_CALL_TRACE(lcSyncMLPluginTrace);

    if( iFd != -1 ) {
        close( iFd );
        iFd = -1;
    }

    if( !iDevice.isEmpty() ) {
        disconnectDevice( iBTAddress, iDevice );
    }

}

QString BTConnection::connectDevice( const QString& aBTAddress, const QString& aServiceUUID )
{
    FUNCTION_CALL_TRACE(lcSyncMLPluginTrace);

    QDBusInterface managerInterface( BLUEZ_DEST, "/", BLUEZ_MANAGER_INTERFACE, QDBusConnection::systemBus() );

    if( !managerInterface.isValid() ) {
        qCCritical(lcSyncMLPlugin) << "Could not find BlueZ manager interface";
        return "";
    }

    QDBusReply<QDBusObjectPath> pathReply = managerInterface.call( QLatin1String( GET_DEFAULT_ADAPTER ) );
    if( !pathReply.isValid() ) {
        qCCritical(lcSyncMLPlugin) << "Could not find default adapter path:" << pathReply.error();
        return "";
    }

    QString defaultAdapterPath = pathReply.value().path();

    qCDebug(lcSyncMLPlugin) << "Using adapter path: " << defaultAdapterPath;

    QDBusInterface adapterInterface( BLUEZ_DEST, defaultAdapterPath, BLUEZ_ADAPTER_INTERFACE, QDBusConnection::systemBus() );

    if( !adapterInterface.isValid() ) {
        qCCritical(lcSyncMLPlugin) << "Could not find adapter interface: " << adapterInterface.lastError();
        return "";
    }

    QDBusReply<void> voidReply = adapterInterface.call( QLatin1String( REQUEST_SESSION ) );

    if( !voidReply.isValid() ) {
        qCCritical(lcSyncMLPlugin) << "Session request failed";
        qCCritical(lcSyncMLPlugin) << "Reason:" <<  voidReply.error();
    }

    qCDebug(lcSyncMLPlugin) << "BT session created";

    pathReply = adapterInterface.call( QLatin1String( FIND_DEVICE ), aBTAddress );

    if( !pathReply.isValid() ) {
        qCWarning(lcSyncMLPlugin) << "Couldn't find device " << aBTAddress << "Reason:" <<  pathReply.error();
        qCDebug(lcSyncMLPlugin) << "Create Device :" << aBTAddress;
        pathReply = adapterInterface.call( QLatin1String( CREATE_DEVICE ), aBTAddress );
            if (pathReply.isValid()){
        qCDebug(lcSyncMLPlugin) << "Create Paired Device :" << aBTAddress << "Path :" << pathReply.value().path();
            QDBusReply<QDBusObjectPath> reply =
                adapterInterface.call(QLatin1String( CREATE_PAIRED_DEVICE ),
                        aBTAddress, qVariantFromValue(pathReply.value()), QString());
        if( !reply.isValid() ) {
            qCCritical(lcSyncMLPlugin) << "Pairing failed Reason:" << reply.error();
        }
        }
    }

    if( !pathReply.isValid() ) {
        qCCritical(lcSyncMLPlugin) << "Couldn't find device " << aBTAddress;
        qCCritical(lcSyncMLPlugin) << "Reason:" <<  pathReply.error();
        adapterInterface.call( QLatin1String( RELEASE_SESSION ) );
        qCCritical(lcSyncMLPlugin) << "BT session closed";
        return "";
    }

    QString devicePath = pathReply.value().path();

    qCDebug(lcSyncMLPlugin) << "Using path" << devicePath << "for device " << aBTAddress;

    QDBusInterface serialInterface( BLUEZ_DEST, devicePath, BLUEZ_SERIAL_INTERFACE, QDBusConnection::systemBus() );

    if( !serialInterface.isValid() ) {
        qCCritical(lcSyncMLPlugin) << "Could not find serial interface: " << serialInterface.lastError();
        adapterInterface.call( QLatin1String( RELEASE_SESSION ) );
        qCCritical(lcSyncMLPlugin) << "BT session closed";
        return "";
    }

    QDBusReply<QString> stringReply = serialInterface.call( QLatin1String( CONNECT ), aServiceUUID );

    if( !stringReply.isValid() ) {
        qCCritical(lcSyncMLPlugin) << "Could not connect to device " << devicePath << " with service uuid " << aServiceUUID;
        qCCritical(lcSyncMLPlugin) << "Reason:" <<  stringReply.error();
        adapterInterface.call( QLatin1String( RELEASE_SESSION ) );
        qCCritical(lcSyncMLPlugin) << "BT session closed";
        return "";
    }

    qCDebug(lcSyncMLPlugin) << "Device connected:" << aBTAddress;

    return stringReply.value();
}

void BTConnection::disconnectDevice( const QString& aBTAddress, const QString& aDevice )
{
    FUNCTION_CALL_TRACE(lcSyncMLPluginTrace);

    QDBusInterface managerInterface( BLUEZ_DEST, "/", BLUEZ_MANAGER_INTERFACE, QDBusConnection::systemBus() );

    if( !managerInterface.isValid() ) {
        qCCritical(lcSyncMLPlugin) << "Could not find BlueZ manager interface";
        return;
    }

    QDBusReply<QDBusObjectPath> pathReply = managerInterface.call( QLatin1String( GET_DEFAULT_ADAPTER ) );

    if( !pathReply.isValid() ) {
        qCCritical(lcSyncMLPlugin) << "Could not find default adapter path";
        qCCritical(lcSyncMLPlugin) << "Reason:" <<  pathReply.error();
        return;
    }

    QString defaultAdapterPath = pathReply.value().path();

    qCDebug(lcSyncMLPlugin) << "Using adapter path: " << defaultAdapterPath;

    QDBusInterface adapterInterface( BLUEZ_DEST, defaultAdapterPath, BLUEZ_ADAPTER_INTERFACE, QDBusConnection::systemBus() );

    if( !adapterInterface.isValid() ) {
        qCCritical(lcSyncMLPlugin) << "Could not find adapter interface: " << adapterInterface.lastError();
        return;
    }

    pathReply = adapterInterface.call( QLatin1String( FIND_DEVICE ), aBTAddress );

    if( !pathReply.isValid() ) {
        qCCritical(lcSyncMLPlugin) << "Couldn't find device " << aBTAddress;
        qCCritical(lcSyncMLPlugin) << "Reason:" <<  pathReply.error();
        return;
    }

    QString devicePath = pathReply.value().path();

    qCDebug(lcSyncMLPlugin) << "Using path" << devicePath << "for device " << aBTAddress;

    QDBusInterface serialInterface( BLUEZ_DEST, devicePath, BLUEZ_SERIAL_INTERFACE, QDBusConnection::systemBus() );

    if( !serialInterface.isValid() ) {
        qCCritical(lcSyncMLPlugin) << "Could not find serial interface: " << serialInterface.lastError();
        return;
    }

    QDBusReply<void> voidReply = serialInterface.call( QLatin1String( DISCONNECT ), aDevice );

    if( !voidReply.isValid() ) {
        qCCritical(lcSyncMLPlugin) << "Device disconnection failed";
        qCCritical(lcSyncMLPlugin) << "Reason:" <<  voidReply.error();
        return;
    }

    qCDebug(lcSyncMLPlugin) << "Device disconnected:" << aBTAddress;

    voidReply = adapterInterface.call( RELEASE_SESSION );

    if( !voidReply.isValid() ) {
        qCCritical(lcSyncMLPlugin) << "Session release failed";
        qCCritical(lcSyncMLPlugin) << "Reason:" <<  voidReply.error();
        return;
    }

    qCDebug(lcSyncMLPlugin) << "BT session closed";

    iDevice.clear();
}

bool BTConnection::fdRawMode( int aFD )
{
    FUNCTION_CALL_TRACE(lcSyncMLPluginTrace);

    struct termios mode;

    if (tcgetattr(aFD, &mode)) {
        return false;
    }

    cfmakeraw(&mode);

    if (tcsetattr(aFD, TCSADRAIN, &mode)) {
        return false;
    }

    return true;
}