File: qabstractoauth.sip

package info (click to toggle)
pyqt5 5.11.3%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 15,956 kB
  • sloc: python: 93,806; cpp: 21,390; xml: 285; makefile: 266; sh: 31
file content (243 lines) | stat: -rw-r--r-- 8,051 bytes parent folder | download
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
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
// qabstractoauth.sip generated by MetaSIP
//
// This file is part of the QtNetworkAuth Python extension module.
//
// Copyright (c) 2018 Riverbank Computing Limited <info@riverbankcomputing.com>
// 
// This file is part of PyQt5.
// 
// This file may be used under the terms of the GNU General Public License
// version 3.0 as published by the Free Software Foundation and appearing in
// the file LICENSE included in the packaging of this file.  Please review the
// following information to ensure the GNU General Public License version 3.0
// requirements will be met: http://www.gnu.org/copyleft/gpl.html.
// 
// If you do not wish to use this file under the terms of the GPL version 3.0
// then you may purchase a commercial license.  For more information contact
// info@riverbankcomputing.com.
// 
// This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
// WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.


%If (Qt_5_10_0 -)

class QAbstractOAuth : QObject /NoDefaultCtors/
{
%TypeHeaderCode
#include <qabstractoauth.h>
%End

%ConvertToSubClassCode
    static struct class_graph {
        const char *name;
        sipTypeDef **type;
        int yes, no;
    } graph[] = {
        {sipName_QAbstractOAuth, &sipType_QAbstractOAuth, 2, 1},
        {sipName_QAbstractOAuthReplyHandler, &sipType_QAbstractOAuthReplyHandler, 5, -1},
        {sipName_QAbstractOAuth2, &sipType_QAbstractOAuth2, 4, 3},
        {sipName_QOAuth1, &sipType_QOAuth1, -1, -1},
        {sipName_QOAuth2AuthorizationCodeFlow, &sipType_QOAuth2AuthorizationCodeFlow, -1, -1},
        {sipName_QOAuthOobReplyHandler, &sipType_QOAuthOobReplyHandler, 6, -1},
        {sipName_QOAuthHttpServerReplyHandler, &sipType_QOAuthHttpServerReplyHandler, -1, -1},
    };
    
    int i = 0;
    
    sipType = NULL;
    
    do
    {
        struct class_graph *cg = &graph[i];
    
        if (cg->name != NULL && sipCpp->inherits(cg->name))
        {
            sipType = *cg->type;
            i = cg->yes;
        }
        else
            i = cg->no;
    }
    while (i >= 0);
%End

public:
    enum class Status
    {
        NotAuthenticated,
        TemporaryCredentialsReceived,
        Granted,
        RefreshingToken,
    };

    enum class Stage
    {
        RequestingTemporaryCredentials,
        RequestingAuthorization,
        RequestingAccessToken,
        RefreshingAccessToken,
    };

    enum class Error
    {
        NoError,
        NetworkError,
        ServerError,
        OAuthTokenNotFoundError,
        OAuthTokenSecretNotFoundError,
        OAuthCallbackNotVerified,
    };

    enum class ContentType
    {
        WwwFormUrlEncoded,
        Json,
    };

    virtual ~QAbstractOAuth();
    QString clientIdentifier() const;
    void setClientIdentifier(const QString &clientIdentifier);
    QString token() const;
    void setToken(const QString &token);
    QNetworkAccessManager *networkAccessManager() const;
    void setNetworkAccessManager(QNetworkAccessManager *networkAccessManager /KeepReference/);
    QAbstractOAuth::Status status() const;
    QUrl authorizationUrl() const;
    void setAuthorizationUrl(const QUrl &url);
    QVariantMap extraTokens() const;
    QAbstractOAuthReplyHandler *replyHandler() const;
    void setReplyHandler(QAbstractOAuthReplyHandler *handler /KeepReference/);
    virtual QNetworkReply *head(const QUrl &url, const QVariantMap &parameters = QVariantMap()) = 0;
    virtual QNetworkReply *get(const QUrl &url, const QVariantMap &parameters = QVariantMap()) = 0;
    virtual QNetworkReply *post(const QUrl &url, const QVariantMap &parameters = QVariantMap()) = 0;
    virtual QNetworkReply *put(const QUrl &url, const QVariantMap &parameters = QVariantMap()) = 0;
    virtual QNetworkReply *deleteResource(const QUrl &url, const QVariantMap &parameters = QVariantMap()) = 0;
    SIP_PYCALLABLE modifyParametersFunction() const;
%MethodCode
        // The callable, if any,  is held in the user object.
        sipRes = sipGetUserObject((sipSimpleWrapper *)sipSelf);
        Py_XINCREF(sipRes);
%End

    void setModifyParametersFunction(SIP_PYCALLABLE modifyParametersFunction /AllowNone/);
%MethodCode
        // Remove any existing callable.
        PyObject *func = sipGetUserObject((sipSimpleWrapper *)sipSelf);
        Py_XDECREF(func);
        
        // Save the new callable.
        if (a0 == Py_None)
        {
            func = 0;
        }
        else
        {
            func = a0;
            Py_INCREF(func);
        }
        
        sipSetUserObject((sipSimpleWrapper *)sipSelf, func);
        
        Py_BEGIN_ALLOW_THREADS
        
        sipCpp->setModifyParametersFunction([func](QAbstractOAuth::Stage stage, QVariantMap *parameters) {
            if (func)
            {
                SIP_BLOCK_THREADS
        
                static const sipTypeDef *variant_map = 0;
        
                if (!variant_map)
                {
                    variant_map = sipFindType("QMap<QString,QVariant>");
                    Q_ASSERT(variant_map);
                }
        
                PyObject *parameters_obj = sipConvertFromType(parameters, variant_map, NULL);
        
                if (!parameters_obj)
                {
                    pyqt5_qtnetworkauth_err_print();
                }
                else
                {
                    PyObject *res = sipCallMethod(NULL, func, "FR", stage, sipType_QAbstractOAuth_Stage, parameters_obj);
        
                    if (!res)
                    {
                        pyqt5_qtnetworkauth_err_print();
                    }
                    else
                    {
                        Py_DECREF(res);
        
                        int iserr = 0;
                        QVariantMap *updated = reinterpret_cast<QVariantMap *>(sipForceConvertToType(parameters_obj, variant_map, NULL, SIP_NO_CONVERTORS, NULL, &iserr));
        
                        if (iserr)
                        {
                            pyqt5_qtnetworkauth_err_print();
                        }
                        else
                        {
                            // Copy the updated parameters.
                            *parameters = *updated;
                            delete updated;
                        }
                    }
        
                    Py_DECREF(parameters_obj);
                }
        
                SIP_UNBLOCK_THREADS
            }
        });
        
        Py_END_ALLOW_THREADS
%End

    QAbstractOAuth::ContentType contentType() const;
    void setContentType(QAbstractOAuth::ContentType contentType);

public slots:
    virtual void grant() = 0;

signals:
    void clientIdentifierChanged(const QString &clientIdentifier);
    void tokenChanged(const QString &token);
    void statusChanged(QAbstractOAuth::Status status /ScopesStripped=1/);
    void authorizationUrlChanged(const QUrl &url);
    void extraTokensChanged(const QVariantMap &tokens);
    void contentTypeChanged(QAbstractOAuth::ContentType contentType /ScopesStripped=1/);
    void requestFailed(const QAbstractOAuth::Error error /ScopesStripped=1/);
    void authorizeWithBrowser(const QUrl &url);
    void granted();
    void finished(QNetworkReply *reply);
    void replyDataReceived(const QByteArray &data);

protected:
    void setStatus(QAbstractOAuth::Status status);
    QString callback() const;
    virtual void resourceOwnerAuthorization(const QUrl &url, const QVariantMap &parameters);
    static QByteArray generateRandomString(quint8 length);
};

%End

%ModuleHeaderCode
// Imports from QtCore.
typedef void (*pyqt5_qtnetworkauth_err_print_t)();
extern pyqt5_qtnetworkauth_err_print_t pyqt5_qtnetworkauth_err_print;
%End

%ModuleCode
// Imports from QtCore.
pyqt5_qtnetworkauth_err_print_t pyqt5_qtnetworkauth_err_print;
%End

%PostInitialisationCode
// Imports from QtCore.
pyqt5_qtnetworkauth_err_print = (pyqt5_qtnetworkauth_err_print_t)sipImportSymbol("pyqt5_err_print");
Q_ASSERT(pyqt5_qtnetworkauth_err_print);
%End