Skip to content

Commit

Permalink
Provided asynchronous (unblocking) variants for requestToken() and ac…
Browse files Browse the repository at this point in the history 
…cessToken() methods, returning QNetworkReply* instead of a ParamMap.

Deprecated old requestToken() and accessToken()
New signals:
 * requestTokenFinished(ParamMap)
 * accessTokenFinished(ParamMap)
New property:
 * signatureMethod

Updated tests.
  • Loading branch information
@ayoy
ayoy committed Oct 18, 2010
1 parent 18dbc19 commit a7ce531
Show file tree
Hide file tree
Showing 9 changed files with 544 additions and 147 deletions.
160 changes: 121 additions & 39 deletions src/interface.cpp
View file
Expand Up @@ -212,13 +212,16 @@ const QByteArray QOAuth::InterfacePrivate::ParamTimestamp = "oauth_timesta
//! \brief The <em>version</em> request parameter string
const QByteArray QOAuth::InterfacePrivate::ParamVersion = "oauth_version";

const QNetworkRequest::Attribute QOAuth::InterfacePrivate::OperationTypeAttribute = QNetworkRequest::User;

QOAuth::InterfacePrivate::InterfacePrivate() :
privateKeySet( false ),
consumerKey( QByteArray() ),
consumerSecret( QByteArray() ),
signatureMethod( HMAC_SHA1 ),
manager(0),
loop(0),
requestTimeout(0),
DEPRECATED_loop(0),
DEPRECATED_requestTimeout(0),
error( NoError )
{
}
Expand All @@ -228,7 +231,7 @@ void QOAuth::InterfacePrivate::init()
Q_Q(QOAuth::Interface);

ignoreSslErrors = false;
loop = new QEventLoop(q);
DEPRECATED_loop = new QEventLoop(q);
setupNetworkAccessManager();

q->connect( &eventHandler, SIGNAL(eventReady(int,QCA::Event)), SLOT(_q_setPassphrase(int,QCA::Event)) );
Expand All @@ -243,7 +246,7 @@ void QOAuth::InterfacePrivate::setupNetworkAccessManager()
manager = new QNetworkAccessManager;

manager->setParent(q);
q->connect( manager, SIGNAL(finished(QNetworkReply*)), loop, SLOT(quit()) );
q->connect( manager, SIGNAL(finished(QNetworkReply*)), DEPRECATED_loop, SLOT(quit()) );
q->connect( manager, SIGNAL(finished(QNetworkReply*)), SLOT(_q_parseReply(QNetworkReply*)) );
q->connect( manager, SIGNAL(sslErrors(QNetworkReply*,QList<QSslError>)),
SLOT(_q_handleSslErrors(QNetworkReply*,QList<QSslError>)) );
Expand Down Expand Up @@ -311,18 +314,31 @@ QOAuth::ParamMap QOAuth::InterfacePrivate::replyToMap( const QByteArray &data )

void QOAuth::InterfacePrivate::_q_parseReply( QNetworkReply *reply )
{
Q_Q(QOAuth::Interface);

int returnCode = reply->attribute( QNetworkRequest::HttpStatusCodeAttribute ).toInt();

switch ( returnCode ) {
case NoError:
replyParams = replyToMap( reply->readAll() );
case NoError: {
ParamMap replyParams = replyToMap( reply->readAll() );
if ( !replyParams.contains( InterfacePrivate::ParamToken ) ) {
qWarning() << __FUNCTION__ << "- oauth_token not present in reply!";
}
if ( !replyParams.contains( InterfacePrivate::ParamTokenSecret ) ) {
qWarning() << __FUNCTION__ << "- oauth_token_secret not present in reply!";
}

QNetworkRequest request = reply->request();
Operation op = (Operation) request.attribute(OperationTypeAttribute, Invalid).toInt();
Q_ASSERT(op != Invalid);

if (op == RequestToken)
emit q->requestTokenFinished(replyParams);
else if (op == AccessToken)
emit q->accessTokenFinished(replyParams);

DEPRECATED_replyParams = replyParams;
}
case BadRequest:
case Unauthorized:
case Forbidden:
Expand All @@ -333,6 +349,7 @@ void QOAuth::InterfacePrivate::_q_parseReply( QNetworkReply *reply )
}

reply->close();
reply->deleteLater();
}

void QOAuth::InterfacePrivate::_q_handleSslErrors(QNetworkReply *reply, const QList<QSslError> &errors)
Expand Down Expand Up @@ -545,6 +562,21 @@ void QOAuth::Interface::setConsumerSecret( const QByteArray &consumerSecret )
d->consumerSecret = consumerSecret;
}

QOAuth::SignatureMethod QOAuth::Interface::signatureMethod() const
{
Q_D(const QOAuth::Interface);

return d->signatureMethod;
}

void QOAuth::Interface::setSignatureMethod( const SignatureMethod &signatureMethod )
{
Q_D(QOAuth::Interface);

d->signatureMethod = signatureMethod;
}


/*!
\property QOAuth::Interface::requestTimeout
\brief This property holds the timeout value in milliseconds for issued network requests.
Expand All @@ -564,14 +596,14 @@ uint QOAuth::Interface::requestTimeout() const
{
Q_D(const Interface);

return d->requestTimeout;
return d->DEPRECATED_requestTimeout;
}

void QOAuth::Interface::setRequestTimeout( uint msec )
{
Q_D(Interface);

d->requestTimeout = msec;
d->DEPRECATED_requestTimeout = msec;
}


Expand Down Expand Up @@ -747,13 +779,46 @@ void QOAuth::InterfacePrivate::_q_setPassphrase( int id, const QCA::Event &event
\sa accessToken(), error
*/

QOAuth::ParamMap QOAuth::Interface::requestToken( const QString &requestUrl, HttpMethod httpMethod,
SignatureMethod signatureMethod, const ParamMap &params )
QNetworkReply* QOAuth::Interface::requestToken( const QUrl &requestUrl, HttpMethod httpMethod,
const ParamMap &params )
{
Q_D(Interface);

return d->sendRequest( requestUrl, httpMethod, signatureMethod,
QByteArray(), QByteArray(), params );
return d->sendRequest( requestUrl.toString(), httpMethod, d->signatureMethod,
QByteArray(), QByteArray(), params, QOAuth::InterfacePrivate::RequestToken );
}

QOAuth::ParamMap QOAuth::Interface::requestToken(const QString &requestUrl, HttpMethod httpMethod,
SignatureMethod signatureMethod, const ParamMap &params)
{
Q_D(QOAuth::Interface);

// fire up a single shot timer if timeout was specified
if ( d->DEPRECATED_requestTimeout > 0 ) {
QTimer::singleShot( d->DEPRECATED_requestTimeout, d->DEPRECATED_loop, SLOT(quit()) );
// if the request finishes on time, the error value is overriden
// if not, it remains equal to QOAuth::Interface::Timeout
d->error = Timeout;
}

// clear the reply container and send the request
d->DEPRECATED_replyParams.clear();
QNetworkReply *reply = d->sendRequest( requestUrl, httpMethod, signatureMethod,
QByteArray(), QByteArray(), params, QOAuth::InterfacePrivate::RequestToken );
if (!reply)
return ParamMap();

// start the event loop and wait for the response
d->DEPRECATED_loop->exec();

// if request completed successfully, error is different than QOAuth::Interface::Timeout
// if it failed, we have to abort the request
if ( d->error == Timeout ) {
reply->abort();
reply->deleteLater();
}

return d->DEPRECATED_replyParams;
}

/*!
Expand Down Expand Up @@ -796,14 +861,48 @@ QOAuth::ParamMap QOAuth::Interface::requestToken( const QString &requestUrl, Htt
\sa requestToken(), createParametersString(), error
*/

QNetworkReply* QOAuth::Interface::accessToken( const QUrl &requestUrl, HttpMethod httpMethod, const QByteArray &token,
const QByteArray &tokenSecret, const ParamMap &params )
{
Q_D(QOAuth::Interface);

return d->sendRequest( requestUrl.toString(), httpMethod, d->signatureMethod,
token, tokenSecret, params, QOAuth::InterfacePrivate::AccessToken );

}

QOAuth::ParamMap QOAuth::Interface::accessToken( const QString &requestUrl, HttpMethod httpMethod, const QByteArray &token,
const QByteArray &tokenSecret, SignatureMethod signatureMethod,
const ParamMap &params )
{
Q_D(Interface);
Q_D(QOAuth::Interface);
// fire up a single shot timer if timeout was specified
if ( d->DEPRECATED_requestTimeout > 0 ) {
QTimer::singleShot( d->DEPRECATED_requestTimeout, d->DEPRECATED_loop, SLOT(quit()) );
// if the request finishes on time, the error value is overriden
// if not, it remains equal to QOAuth::Interface::Timeout
d->error = Timeout;
}

// clear the reply container and send the request
d->DEPRECATED_replyParams.clear();
QNetworkReply *reply = d->sendRequest( requestUrl, httpMethod, signatureMethod,
token, tokenSecret, params, QOAuth::InterfacePrivate::AccessToken );
if (!reply)
return ParamMap();

// start the event loop and wait for the response
d->DEPRECATED_loop->exec();

// if request completed successfully, error is different than QOAuth::Interface::Timeout
// if it failed, we have to abort the request
if ( d->error == Timeout ) {
reply->abort();
reply->deleteLater();
}

return d->DEPRECATED_replyParams;

return d->sendRequest( requestUrl, httpMethod, signatureMethod,
token, tokenSecret, params );

}

Expand Down Expand Up @@ -905,14 +1004,15 @@ QByteArray QOAuth::Interface::inlineParameters( const ParamMap &params, ParsingM
return query;
}

QOAuth::ParamMap QOAuth::InterfacePrivate::sendRequest( const QString &requestUrl, HttpMethod httpMethod,
QNetworkReply* QOAuth::InterfacePrivate::sendRequest( const QString &requestUrl, HttpMethod httpMethod,
SignatureMethod signatureMethod, const QByteArray &token,
const QByteArray &tokenSecret, const ParamMap &params )
const QByteArray &tokenSecret, const ParamMap &params,
Operation operation )
{
if ( httpMethod != GET && httpMethod != POST ) {
qWarning() << __FUNCTION__ << "- requestToken() and accessToken() accept only GET and POST methods";
error = UnsupportedHttpMethod;
return ParamMap();
return 0;
}

error = NoError;
Expand All @@ -925,7 +1025,7 @@ QOAuth::ParamMap QOAuth::InterfacePrivate::sendRequest( const QString &requestUr

// if signature wasn't created, return an empty map
if ( error != NoError ) {
return ParamMap();
return 0;
}

// add signature to parameters
Expand All @@ -945,34 +1045,16 @@ QOAuth::ParamMap QOAuth::InterfacePrivate::sendRequest( const QString &requestUr
}

request.setUrl( QUrl( requestUrl ) );
request.setAttribute(OperationTypeAttribute, operation);

// fire up a single shot timer if timeout was specified
if ( requestTimeout > 0 ) {
QTimer::singleShot( requestTimeout, loop, SLOT(quit()) );
// if the request finishes on time, the error value is overriden
// if not, it remains equal to QOAuth::Interface::Timeout
error = Timeout;
}

// clear the reply container and send the request
replyParams.clear();
QNetworkReply *reply;
if ( httpMethod == GET ) {
reply = manager->get( request );
} else if ( httpMethod == POST ) {
reply = manager->post( request, authorizationHeader );
}

// start the event loop and wait for the response
loop->exec();

// if request completed successfully, error is different than QOAuth::Interface::Timeout
// if it failed, we have to abort the request
if ( error == Timeout ) {
reply->abort();
}

return replyParams;
return reply;
}

QByteArray QOAuth::InterfacePrivate::createSignature( const QString &requestUrl, HttpMethod httpMethod,
Expand Down
19 changes: 17 additions & 2 deletions src/interface.h
View file
Expand Up @@ -51,6 +51,8 @@ class QOAUTH_EXPORT Interface : public QObject
Q_PROPERTY( uint requestTimeout READ requestTimeout WRITE setRequestTimeout )
Q_PROPERTY( bool ignoreSslErrors READ ignoreSslErrors WRITE setIgnoreSslErrors )
Q_PROPERTY( int error READ error )
Q_PROPERTY( SignatureMethod signatureMethod READ signatureMethod WRITE setSignatureMethod )
Q_ENUMS( QOAuth::SignatureMethod )

public:
Interface( QObject *parent = 0 );
Expand All @@ -69,6 +71,9 @@ class QOAUTH_EXPORT Interface : public QObject
QByteArray consumerSecret() const;
void setConsumerSecret( const QByteArray &consumerSecret );

SignatureMethod signatureMethod() const;
void setSignatureMethod( const SignatureMethod &signatureMethod );

uint requestTimeout() const;
void setRequestTimeout( uint msec );

Expand All @@ -80,10 +85,17 @@ class QOAUTH_EXPORT Interface : public QObject
const QCA::SecureArray &passphrase = QCA::SecureArray() );


ParamMap requestToken( const QString &requestUrl, HttpMethod httpMethod,
QNetworkReply* requestToken( const QUrl &requestUrl, HttpMethod httpMethod,
const ParamMap &params = ParamMap() );

QNetworkReply* accessToken( const QUrl &requestUrl, HttpMethod httpMethod,
const QByteArray &token, const QByteArray &tokenSecret,
const ParamMap &params = ParamMap() );

Q_DECL_DEPRECATED ParamMap requestToken( const QString &requestUrl, HttpMethod httpMethod,
SignatureMethod signatureMethod = HMAC_SHA1, const ParamMap &params = ParamMap() );

ParamMap accessToken( const QString &requestUrl, HttpMethod httpMethod, const QByteArray &token,
Q_DECL_DEPRECATED ParamMap accessToken( const QString &requestUrl, HttpMethod httpMethod, const QByteArray &token,
const QByteArray &tokenSecret, SignatureMethod signatureMethod = HMAC_SHA1,
const ParamMap &params = ParamMap() );

Expand All @@ -93,6 +105,9 @@ class QOAUTH_EXPORT Interface : public QObject

QByteArray inlineParameters( const ParamMap &params, ParsingMode mode = ParseForRequestContent );

signals:
void requestTokenFinished(const ParamMap &reply);
void accessTokenFinished(const ParamMap &reply);

protected:
InterfacePrivate * const d_ptr;
Expand Down

0 comments on commit a7ce531

Please sign in to comment.