utilities/downloadmanager/src/progressivedownloadserver.cpp
author hgs
Fri, 15 Oct 2010 17:30:59 -0400
changeset 16 3c88a81ff781
permissions -rw-r--r--
201041
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
16
hgs
parents:
diff changeset
     1
/**
hgs
parents:
diff changeset
     2
   This file is part of CWRT package **
hgs
parents:
diff changeset
     3
hgs
parents:
diff changeset
     4
   Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies). **
hgs
parents:
diff changeset
     5
hgs
parents:
diff changeset
     6
   This program is free software: you can redistribute it and/or modify
hgs
parents:
diff changeset
     7
   it under the terms of the GNU (Lesser) General Public License as 
hgs
parents:
diff changeset
     8
   published by the Free Software Foundation, version 2.1 of the License. 
hgs
parents:
diff changeset
     9
   This program is distributed in the hope that it will be useful, but
hgs
parents:
diff changeset
    10
   WITHOUT ANY WARRANTY; without even the implied warranty of 
hgs
parents:
diff changeset
    11
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 
hgs
parents:
diff changeset
    12
   (Lesser) General Public License for more details. You should have 
hgs
parents:
diff changeset
    13
   received a copy of the GNU (Lesser) General Public License along 
hgs
parents:
diff changeset
    14
   with this program. If not, see <http://www.gnu.org/licenses/>.
hgs
parents:
diff changeset
    15
*/
hgs
parents:
diff changeset
    16
hgs
parents:
diff changeset
    17
#include "progressivedownloadserver.h"
hgs
parents:
diff changeset
    18
#include "download.h"
hgs
parents:
diff changeset
    19
#include "dmcommon.h"
hgs
parents:
diff changeset
    20
#include "dmcommoninternal.h"
hgs
parents:
diff changeset
    21
#include <QTcpSocket>
hgs
parents:
diff changeset
    22
#include <QHostAddress>
hgs
parents:
diff changeset
    23
hgs
parents:
diff changeset
    24
#define SERVER_WAIT_INTERVAL 1000
hgs
parents:
diff changeset
    25
hgs
parents:
diff changeset
    26
// private implementation
hgs
parents:
diff changeset
    27
class ProgressiveDownloadServerPrivate
hgs
parents:
diff changeset
    28
{
hgs
parents:
diff changeset
    29
    DM_DECLARE_PUBLIC(ProgressiveDownloadServer);
hgs
parents:
diff changeset
    30
public:
hgs
parents:
diff changeset
    31
    ProgressiveDownloadServerPrivate();
hgs
parents:
diff changeset
    32
    ~ProgressiveDownloadServerPrivate();
hgs
parents:
diff changeset
    33
    QTcpServer* m_serverSocket;
hgs
parents:
diff changeset
    34
    QTcpSocket* m_clientConnection;
hgs
parents:
diff changeset
    35
    Download* m_download;
hgs
parents:
diff changeset
    36
    DownloadState m_previousDlState;
hgs
parents:
diff changeset
    37
};
hgs
parents:
diff changeset
    38
hgs
parents:
diff changeset
    39
ProgressiveDownloadServerPrivate::ProgressiveDownloadServerPrivate()
hgs
parents:
diff changeset
    40
{
hgs
parents:
diff changeset
    41
    m_serverSocket = 0;
hgs
parents:
diff changeset
    42
    m_clientConnection = 0;
hgs
parents:
diff changeset
    43
    m_download = 0;
hgs
parents:
diff changeset
    44
    m_previousDlState = DlNone;
hgs
parents:
diff changeset
    45
}
hgs
parents:
diff changeset
    46
hgs
parents:
diff changeset
    47
ProgressiveDownloadServerPrivate::~ProgressiveDownloadServerPrivate()
hgs
parents:
diff changeset
    48
{
hgs
parents:
diff changeset
    49
    if (m_serverSocket) {
hgs
parents:
diff changeset
    50
        delete m_serverSocket;
hgs
parents:
diff changeset
    51
        m_serverSocket = 0;
hgs
parents:
diff changeset
    52
    }
hgs
parents:
diff changeset
    53
}
hgs
parents:
diff changeset
    54
hgs
parents:
diff changeset
    55
Q_DECL_EXPORT ProgressiveDownloadServer::ProgressiveDownloadServer(Download* download)
hgs
parents:
diff changeset
    56
{
hgs
parents:
diff changeset
    57
    DM_INITIALIZE(ProgressiveDownloadServer);
hgs
parents:
diff changeset
    58
    priv->m_download = download;
hgs
parents:
diff changeset
    59
hgs
parents:
diff changeset
    60
    // create server socket
hgs
parents:
diff changeset
    61
    priv->m_serverSocket = new QTcpServer(this);
hgs
parents:
diff changeset
    62
    connect(priv->m_serverSocket, SIGNAL(newConnection()), this, SLOT(handleConnection()));
hgs
parents:
diff changeset
    63
}
hgs
parents:
diff changeset
    64
hgs
parents:
diff changeset
    65
ProgressiveDownloadServer::~ProgressiveDownloadServer()
hgs
parents:
diff changeset
    66
{
hgs
parents:
diff changeset
    67
    stopServer();
hgs
parents:
diff changeset
    68
    DM_UNINITIALIZE(ProgressiveDownloadServer);
hgs
parents:
diff changeset
    69
}
hgs
parents:
diff changeset
    70
hgs
parents:
diff changeset
    71
// starts the server
hgs
parents:
diff changeset
    72
Q_DECL_EXPORT int ProgressiveDownloadServer::startServer(void)
hgs
parents:
diff changeset
    73
{
hgs
parents:
diff changeset
    74
    DM_PRIVATE(ProgressiveDownloadServer);
hgs
parents:
diff changeset
    75
    if (!priv->m_serverSocket->isListening()) {
hgs
parents:
diff changeset
    76
        QHostAddress localHost(QHostAddress::LocalHost);
hgs
parents:
diff changeset
    77
        if (!priv->m_serverSocket->listen(localHost))
hgs
parents:
diff changeset
    78
            return -1;
hgs
parents:
diff changeset
    79
    }
hgs
parents:
diff changeset
    80
    return 0;
hgs
parents:
diff changeset
    81
}
hgs
parents:
diff changeset
    82
hgs
parents:
diff changeset
    83
// stops the server
hgs
parents:
diff changeset
    84
Q_DECL_EXPORT int ProgressiveDownloadServer::stopServer(void)
hgs
parents:
diff changeset
    85
{
hgs
parents:
diff changeset
    86
    DM_PRIVATE(ProgressiveDownloadServer);
hgs
parents:
diff changeset
    87
    // unregister the event listener
hgs
parents:
diff changeset
    88
    priv->m_download->unregisterEventReceiver(this);
hgs
parents:
diff changeset
    89
hgs
parents:
diff changeset
    90
    // send the server down signal
hgs
parents:
diff changeset
    91
    if ((priv->m_clientConnection) && (priv->m_clientConnection->state() == QAbstractSocket::ConnectedState)) {
hgs
parents:
diff changeset
    92
        QByteArray block;
hgs
parents:
diff changeset
    93
        QDataStream out(&block, QIODevice::WriteOnly);
hgs
parents:
diff changeset
    94
        out.setVersion(QDataStream::Qt_4_0);
hgs
parents:
diff changeset
    95
        out << (quint16)ProgressiveDlServerDown;
hgs
parents:
diff changeset
    96
        priv->m_clientConnection->write(block);
hgs
parents:
diff changeset
    97
        priv->m_clientConnection->flush();
hgs
parents:
diff changeset
    98
hgs
parents:
diff changeset
    99
        // wait till the data is written
hgs
parents:
diff changeset
   100
        if (priv->m_clientConnection->waitForBytesWritten(SERVER_WAIT_INTERVAL))
hgs
parents:
diff changeset
   101
            return 0;
hgs
parents:
diff changeset
   102
        else
hgs
parents:
diff changeset
   103
            return -1;
hgs
parents:
diff changeset
   104
    }
hgs
parents:
diff changeset
   105
hgs
parents:
diff changeset
   106
    if (priv->m_serverSocket->isListening())
hgs
parents:
diff changeset
   107
        priv->m_serverSocket->close();
hgs
parents:
diff changeset
   108
hgs
parents:
diff changeset
   109
    return 0;
hgs
parents:
diff changeset
   110
}
hgs
parents:
diff changeset
   111
hgs
parents:
diff changeset
   112
Q_DECL_EXPORT quint16 ProgressiveDownloadServer::serverPort(void)
hgs
parents:
diff changeset
   113
{
hgs
parents:
diff changeset
   114
    DM_PRIVATE(ProgressiveDownloadServer);
hgs
parents:
diff changeset
   115
    if (priv->m_serverSocket)
hgs
parents:
diff changeset
   116
        return priv->m_serverSocket->serverPort();
hgs
parents:
diff changeset
   117
    else
hgs
parents:
diff changeset
   118
        return 0;
hgs
parents:
diff changeset
   119
}
hgs
parents:
diff changeset
   120
hgs
parents:
diff changeset
   121
// last error occurred
hgs
parents:
diff changeset
   122
Q_DECL_EXPORT ProgressiveDlServerError ProgressiveDownloadServer::lastError(void)
hgs
parents:
diff changeset
   123
{
hgs
parents:
diff changeset
   124
    DM_PRIVATE(ProgressiveDownloadServer);
hgs
parents:
diff changeset
   125
    return priv->m_serverSocket->serverError();
hgs
parents:
diff changeset
   126
}
hgs
parents:
diff changeset
   127
hgs
parents:
diff changeset
   128
// last error occurred
hgs
parents:
diff changeset
   129
Q_DECL_EXPORT QString ProgressiveDownloadServer::lastErrorString(void)
hgs
parents:
diff changeset
   130
{
hgs
parents:
diff changeset
   131
    DM_PRIVATE(ProgressiveDownloadServer);
hgs
parents:
diff changeset
   132
    return priv->m_serverSocket->errorString();
hgs
parents:
diff changeset
   133
}
hgs
parents:
diff changeset
   134
hgs
parents:
diff changeset
   135
void ProgressiveDownloadServer::handleConnection(void)
hgs
parents:
diff changeset
   136
{
hgs
parents:
diff changeset
   137
    DM_PRIVATE(ProgressiveDownloadServer);
hgs
parents:
diff changeset
   138
    priv->m_clientConnection = priv->m_serverSocket->nextPendingConnection();
hgs
parents:
diff changeset
   139
    connect(priv->m_clientConnection, SIGNAL(readyRead()),
hgs
parents:
diff changeset
   140
            this, SLOT(handleRequest()));
hgs
parents:
diff changeset
   141
    priv->m_download->registerEventReceiver(this);
hgs
parents:
diff changeset
   142
hgs
parents:
diff changeset
   143
    // right now only one client is supported
hgs
parents:
diff changeset
   144
    priv->m_serverSocket->close();
hgs
parents:
diff changeset
   145
}
hgs
parents:
diff changeset
   146
hgs
parents:
diff changeset
   147
void ProgressiveDownloadServer::handleRequest(void)
hgs
parents:
diff changeset
   148
{
hgs
parents:
diff changeset
   149
    // handles the request from client
hgs
parents:
diff changeset
   150
    DM_PRIVATE(ProgressiveDownloadServer);
hgs
parents:
diff changeset
   151
    quint16 requestCode;
hgs
parents:
diff changeset
   152
    QDataStream in(priv->m_clientConnection);
hgs
parents:
diff changeset
   153
    in.setVersion(QDataStream::Qt_4_0);
hgs
parents:
diff changeset
   154
hgs
parents:
diff changeset
   155
    if (priv->m_clientConnection->bytesAvailable() < (int)sizeof(quint16))
hgs
parents:
diff changeset
   156
        return;
hgs
parents:
diff changeset
   157
hgs
parents:
diff changeset
   158
    in >> requestCode;
hgs
parents:
diff changeset
   159
    // act according to the request
hgs
parents:
diff changeset
   160
    if ((ProgressiveOperation)requestCode == DlPause)
hgs
parents:
diff changeset
   161
        priv->m_download->pause();
hgs
parents:
diff changeset
   162
    else if ((ProgressiveOperation)requestCode == DlResume)
hgs
parents:
diff changeset
   163
        priv->m_download->resume();
hgs
parents:
diff changeset
   164
    else if ((ProgressiveOperation)requestCode == DlCancel)
hgs
parents:
diff changeset
   165
        priv->m_download->cancel();
hgs
parents:
diff changeset
   166
    else if ((ProgressiveOperation)requestCode == DlGetAttribute) {
hgs
parents:
diff changeset
   167
        // getAttribute is synchronous, so send the response here
hgs
parents:
diff changeset
   168
        quint16 attr;
hgs
parents:
diff changeset
   169
        in >> attr;
hgs
parents:
diff changeset
   170
        QVariant value;
hgs
parents:
diff changeset
   171
        value = priv->m_download->getAttribute((DownloadAttribute)attr);
hgs
parents:
diff changeset
   172
        QByteArray block;
hgs
parents:
diff changeset
   173
        QDataStream out(&block, QIODevice::WriteOnly);
hgs
parents:
diff changeset
   174
        out.setVersion(QDataStream::Qt_4_0);
hgs
parents:
diff changeset
   175
        out << (quint16)ProgressiveDlGetAttribute;
hgs
parents:
diff changeset
   176
        out << value;
hgs
parents:
diff changeset
   177
        priv->m_clientConnection->write(block);
hgs
parents:
diff changeset
   178
        priv->m_clientConnection->flush();
hgs
parents:
diff changeset
   179
    }
hgs
parents:
diff changeset
   180
}
hgs
parents:
diff changeset
   181
hgs
parents:
diff changeset
   182
bool ProgressiveDownloadServer::event(QEvent *event)
hgs
parents:
diff changeset
   183
{
hgs
parents:
diff changeset
   184
    DM_PRIVATE(ProgressiveDownloadServer);
hgs
parents:
diff changeset
   185
    DEventType type = (DEventType)event->type();
hgs
parents:
diff changeset
   186
    QByteArray block;
hgs
parents:
diff changeset
   187
    QDataStream out(&block, QIODevice::WriteOnly);
hgs
parents:
diff changeset
   188
    out.setVersion(QDataStream::Qt_4_0);
hgs
parents:
diff changeset
   189
hgs
parents:
diff changeset
   190
    // handle the events from the download and send the response to the client
hgs
parents:
diff changeset
   191
    switch(type) {
hgs
parents:
diff changeset
   192
    case Progress:
hgs
parents:
diff changeset
   193
        // send the response only once when it is resumed
hgs
parents:
diff changeset
   194
        // to avoid continueously writing to the response buffer and increasing the ipc overhead 
hgs
parents:
diff changeset
   195
        if (priv->m_previousDlState != DlInprogress) {
hgs
parents:
diff changeset
   196
            priv->m_previousDlState = DlInprogress;
hgs
parents:
diff changeset
   197
            out << (quint16)ProgressiveDlInprogress;
hgs
parents:
diff changeset
   198
            priv->m_clientConnection->write(block);
hgs
parents:
diff changeset
   199
            priv->m_clientConnection->flush();
hgs
parents:
diff changeset
   200
        }
hgs
parents:
diff changeset
   201
        break;
hgs
parents:
diff changeset
   202
    case Paused:
hgs
parents:
diff changeset
   203
        priv->m_previousDlState = DlPaused;
hgs
parents:
diff changeset
   204
        out << (quint16)ProgressiveDlPaused;
hgs
parents:
diff changeset
   205
        priv->m_clientConnection->write(block);
hgs
parents:
diff changeset
   206
        priv->m_clientConnection->flush();
hgs
parents:
diff changeset
   207
        break;
hgs
parents:
diff changeset
   208
    case Completed:
hgs
parents:
diff changeset
   209
        priv->m_previousDlState = DlCompleted;
hgs
parents:
diff changeset
   210
        out << (quint16)ProgressiveDlCompleted;
hgs
parents:
diff changeset
   211
        priv->m_clientConnection->write(block);
hgs
parents:
diff changeset
   212
        priv->m_clientConnection->flush();
hgs
parents:
diff changeset
   213
        break;
hgs
parents:
diff changeset
   214
    case Failed:
hgs
parents:
diff changeset
   215
        priv->m_previousDlState = DlFailed;
hgs
parents:
diff changeset
   216
        out << (quint16)ProgressiveDlFailed;
hgs
parents:
diff changeset
   217
        priv->m_clientConnection->write(block);
hgs
parents:
diff changeset
   218
        priv->m_clientConnection->flush();
hgs
parents:
diff changeset
   219
        break;
hgs
parents:
diff changeset
   220
    case Cancelled:
hgs
parents:
diff changeset
   221
        priv->m_previousDlState = DlCancelled;
hgs
parents:
diff changeset
   222
        out << (quint16)ProgressiveDlCancelled;
hgs
parents:
diff changeset
   223
        priv->m_clientConnection->write(block);
hgs
parents:
diff changeset
   224
        priv->m_clientConnection->flush();
hgs
parents:
diff changeset
   225
        break;
hgs
parents:
diff changeset
   226
    case NetworkLoss:
hgs
parents:
diff changeset
   227
        priv->m_previousDlState = DlPaused;
hgs
parents:
diff changeset
   228
        out << (quint16)ProgressiveDlPaused;
hgs
parents:
diff changeset
   229
        priv->m_clientConnection->write(block);
hgs
parents:
diff changeset
   230
        priv->m_clientConnection->flush();
hgs
parents:
diff changeset
   231
        break;
hgs
parents:
diff changeset
   232
    default:
hgs
parents:
diff changeset
   233
        break;
hgs
parents:
diff changeset
   234
    }
hgs
parents:
diff changeset
   235
    // event is consumed in any case.
hgs
parents:
diff changeset
   236
    return true;
hgs
parents:
diff changeset
   237
}
hgs
parents:
diff changeset
   238
       
hgs
parents:
diff changeset
   239