summaryrefslogtreecommitdiffstats
path: root/dcoprss/xmlrpciface.h
blob: f7897e10f6ffa7a58e468bf476dc32923759bd3a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
/*
 * kxmlrpcclient.h - (c) 2003 Frerich Raabe <raabe@kde.org>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. 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.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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.
 */
#ifndef KXMLRPCCLIENT_H
#define KXMLRPCCLIENT_H

#include <kurl.h>

#include <qbuffer.h>
#include <qdatastream.h>
#include <qobject.h>
#include <qvariant.h>
#include <qvaluelist.h>

class QDomDocument;
class QDomElement;

namespace KIO
{
	class Job;
}

namespace KXMLRPC
{
	class Query;
	class QueryResult;
	class Server;

	class Query : public QObject
	{
		Q_OBJECT
		public:
			class Result
			{
				friend class Query;
				friend QDataStream &operator>>( QDataStream &s, Query::Result &r );
				public:
					Result() { }

					bool success() const { return m_success; }
					int errorCode() const { return m_errorCode; }
					QString errorString() const { return m_errorString; }
					QValueList<QVariant> data() const { return m_data; }
					QString server() const { return m_server; }
					QString method() const { return m_method; }
					QValueList<QVariant> args() const { return m_args; }

				private:
					bool m_success;
					int m_errorCode;
					QString m_errorString;
					QValueList<QVariant> m_data;
					QString m_server;
					QString m_method;
					QValueList<QVariant> m_args;
			};

			static Query *create( QObject *parent = 0, const char *name = 0 );
			static QString marshal( const QVariant &v );
			static QVariant demarshal( const QDomElement &e );

		public slots:
			void call( const QString &server, const QString &method,
			           const QValueList<QVariant> &args = QValueList<QVariant>(),
			           const QString &userAgent = "KDE-XMLRPC" );

		signals:
			void infoMessage( const QString &msg );
			void finished( const KXMLRPC::Query::Result &result );

		private slots:
			void slotInfoMessage( KIO::Job *job, const QString &msg );
			void slotData( KIO::Job *job, const QByteArray &data );
			void slotResult( KIO::Job *job );

		private:
			bool isMessageResponse( const QDomDocument &doc ) const;
			bool isFaultResponse( const QDomDocument &doc ) const;

			Result parseMessageResponse( const QDomDocument &doc ) const;
			Result parseFaultResponse( const QDomDocument &doc ) const;

			QString markupCall( const QString &method,
			                    const QValueList<QVariant> &args ) const;

			Query( QObject *parent = 0, const char *name = 0 );

			QBuffer m_buffer;
			QString m_server;
			QString m_method;
			QValueList<QVariant> m_args;
	};

	class Server : public QObject
	{
		Q_OBJECT
		public:
			Server( const KURL &url = KURL(),
			        QObject *parent = 0, const char *name = 0 );

			const KURL &url() const { return m_url; }
			void setUrl( const KURL &url );

			QString userAgent() const { return m_userAgent; }
			void setUserAgent( const QString &userAgent) { m_userAgent = userAgent; }

			template <typename T>
			void call( const QString &method, const QValueList<T> &arg,
			           QObject *object, const char *slot );

			static QValueList<QVariant> toVariantList( const QVariant &arg );
			static QValueList<QVariant> toVariantList( int arg );
			static QValueList<QVariant> toVariantList( bool arg );
			static QValueList<QVariant> toVariantList( double arg );
			static QValueList<QVariant> toVariantList( const QString &arg );
			static QValueList<QVariant> toVariantList( const QCString &arg );
			static QValueList<QVariant> toVariantList( const QByteArray &arg );
			static QValueList<QVariant> toVariantList( const QDateTime &arg );
			static QValueList<QVariant> toVariantList( const QStringList &arg );

		signals:
			void infoMessage( const QString &msg );

		public slots:
			void call( const QString &method, const QValueList<QVariant> &args,
			           QObject *object, const char *slot );
			void call( const QString &method, const QValueList<QVariant> &args,
			           QObject *object, const char *slot,
			           QObject *infoObject, const char *infoSlot );

		private:
			KURL m_url;
			QString m_userAgent;
	};

	inline QDataStream &operator>>( QDataStream &s, Query::Result &r )
	{
		return s >> r.m_errorCode >> r.m_errorString >> r.m_data
		         >> r.m_server >> r.m_method >> r.m_args;
	}
}

template <typename T>
void KXMLRPC::Server::call( const QString &method, const QValueList<T> &arg,
                            QObject *object, const char *slot )
{
	QValueList<QVariant> args;

	typename QValueList<T>::ConstIterator it = arg.begin();
	typename QValueList<T>::ConstIterator end = arg.end();
	for ( ; it != end; ++it )
		args << QVariant( *it );

	call( method, args, object, slot );
}

inline QDataStream &operator<<( QDataStream &s, const KXMLRPC::Query::Result &r )
{
	return s << r.errorCode() << r.errorString() << r.data()
	         << r.server() << r.method() << r.args();
}

#endif // KXMLRPCCLIENT_H
// vim:ts=4:sw=4:noet