File: WebKitXRPermissionRequest.cpp

package info (click to toggle)
webkit2gtk 2.51.3-1
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 477,912 kB
  • sloc: cpp: 3,898,343; javascript: 198,215; ansic: 165,229; python: 50,371; asm: 21,819; ruby: 18,095; perl: 16,953; xml: 4,623; sh: 2,398; yacc: 2,356; java: 2,019; lex: 1,358; pascal: 372; makefile: 197
file content (408 lines) | stat: -rw-r--r-- 14,868 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
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
/*
 * Copyright (C) 2025 Igalia S.L.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public License
 * along with this library; see the file COPYING.LIB.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 */

#include "config.h"
#include "WebKitXRPermissionRequest.h"

#include "WebKitPermissionRequest.h"
#include "WebKitSecurityOriginPrivate.h"
#include "WebKitXRPermissionRequestPrivate.h"
#include <wtf/glib/WTFGType.h>

#if !ENABLE(WEBXR)
#include <WebCore/NotImplemented.h>
#endif

#if !ENABLE(2022_GLIB_API)
typedef WebKitPermissionRequestIface WebKitPermissionRequestInterface;
#endif

#if ENABLE(WEBXR)
static PlatformXR::Device::FeatureList toFeatureList(WebKitXRSessionFeatures features)
{
    PlatformXR::Device::FeatureList result;
    if (features & WEBKIT_XR_SESSION_FEATURES_VIEWER)
        result.append(PlatformXR::SessionFeature::ReferenceSpaceTypeViewer);
    if (features & WEBKIT_XR_SESSION_FEATURES_LOCAL)
        result.append(PlatformXR::SessionFeature::ReferenceSpaceTypeLocal);
    if (features & WEBKIT_XR_SESSION_FEATURES_LOCAL_FLOOR)
        result.append(PlatformXR::SessionFeature::ReferenceSpaceTypeLocalFloor);
    if (features & WEBKIT_XR_SESSION_FEATURES_BOUNDED_FLOOR)
        result.append(PlatformXR::SessionFeature::ReferenceSpaceTypeBoundedFloor);
    if (features & WEBKIT_XR_SESSION_FEATURES_UNBOUNDED)
        result.append(PlatformXR::SessionFeature::ReferenceSpaceTypeUnbounded);
#if ENABLE(WEBXR_HANDS)
    if (features & WEBKIT_XR_SESSION_FEATURES_HAND_TRACKING)
        result.append(PlatformXR::SessionFeature::HandTracking);
#endif
#if ENABLE(WEBXR_HIT_TEST)
    if (features & WEBKIT_XR_SESSION_FEATURES_HIT_TEST)
        result.append(PlatformXR::SessionFeature::HitTest);
#endif
#if ENABLE(WEBXR_LAYERS)
    if (features & WEBKIT_XR_SESSION_FEATURES_LAYERS)
        result.append(PlatformXR::SessionFeature::Layers);
#endif
    return result;
}
#endif // ENABLE(WEBXR)

/**
 * WebKitXRPermissionRequest:
 * @See_also: #WebKitPermissionRequest, #WebKitWebView
 *
 * A permission request for accessing virtual reality (VR) and
 * augmented reality (AR) devices, including sensors and head-mounted
 * displays.
 *
 * WebKitXRPermissionRequest represents a request for permission to
 * decide whether WebKit can initialize an XR session through the
 * WebXR API.
 *
 * When a WebKitXRPermissionRequest is not handled by the user,
 * it is denied by default.
 *
 * Since: 2.52
 */

static void webkit_permission_request_interface_init(WebKitPermissionRequestInterface*);

struct _WebKitXRPermissionRequestPrivate {
#if ENABLE(WEBXR)
    WebKitSecurityOrigin* securityOrigin;
    WebKitXRSessionMode mode;
    WebKitXRSessionFeatures newlyGrantedFeatures;
    WebKitXRSessionFeatures previouslyGrantedFeatures;
    WebKitXRSessionFeatures consentRequiredFeatures;
    WebKitXRSessionFeatures consentOptionalFeatures;
    WebKitXRSessionFeatures requiredFeaturesRequested;
    WebKitXRSessionFeatures optionalFeaturesRequested;
    CompletionHandler<void(std::optional<PlatformXR::Device::FeatureList>&&)> completionHandler;
#endif
};

WEBKIT_DEFINE_FINAL_TYPE_WITH_CODE(
    WebKitXRPermissionRequest, webkit_xr_permission_request, G_TYPE_OBJECT, GObject,
    G_IMPLEMENT_INTERFACE(WEBKIT_TYPE_PERMISSION_REQUEST, webkit_permission_request_interface_init))

#if ENABLE(WEBXR)
static void webkitXRPermissionRequestAllow(WebKitPermissionRequest* request)
{
    ASSERT(WEBKIT_IS_XR_PERMISSION_REQUEST(request));

    WebKitXRPermissionRequestPrivate* priv = WEBKIT_XR_PERMISSION_REQUEST(request)->priv;

    if (priv->completionHandler)
        priv->completionHandler(toFeatureList(static_cast<WebKitXRSessionFeatures>(priv->newlyGrantedFeatures | priv->previouslyGrantedFeatures | priv->consentRequiredFeatures)));
}

static void webkitXRPermissionRequestDeny(WebKitPermissionRequest* request)
{
    ASSERT(WEBKIT_IS_XR_PERMISSION_REQUEST(request));

    WebKitXRPermissionRequestPrivate* priv = WEBKIT_XR_PERMISSION_REQUEST(request)->priv;

    if (priv->completionHandler)
        priv->completionHandler(std::nullopt);
}
#endif

static void webkit_permission_request_interface_init(WebKitPermissionRequestInterface* iface)
{
#if ENABLE(WEBXR)
    iface->allow = webkitXRPermissionRequestAllow;
    iface->deny = webkitXRPermissionRequestDeny;
#endif
}

static void webkitXRPermissionRequestDispose(GObject* object)
{
#if ENABLE(WEBXR)
    // Default behaviour when no decision has been made is denying the request.
    webkitXRPermissionRequestDeny(WEBKIT_PERMISSION_REQUEST(object));
    WebKitXRPermissionRequestPrivate* priv = WEBKIT_XR_PERMISSION_REQUEST(object)->priv;
    g_clear_pointer(&priv->securityOrigin, webkit_security_origin_unref);
#endif
    G_OBJECT_CLASS(webkit_xr_permission_request_parent_class)->dispose(object);
}

static void webkit_xr_permission_request_class_init(WebKitXRPermissionRequestClass* klass)
{
    GObjectClass* objectClass = G_OBJECT_CLASS(klass);
    objectClass->dispose = webkitXRPermissionRequestDispose;
}

/**
 * webkit_xr_permission_request_get_security_origin:
 * @request: a #WebKitXRPermissionRequest
 *
 * Gets the security origin that initiated the permission request.
 *
 * Returns: (transfer none): the #WebKitSecurityOrigin that initiated the request
 *
 * Since: 2.52
 */
WebKitSecurityOrigin* webkit_xr_permission_request_get_security_origin(WebKitXRPermissionRequest* request)
{
#if ENABLE(WEBXR)
    g_return_val_if_fail(WEBKIT_IS_XR_PERMISSION_REQUEST(request), nullptr);
    return request->priv->securityOrigin;
#else
    notImplemented();
    return nullptr;
#endif
}

/**
 * webkit_xr_permission_request_get_session_mode:
 * @request: a #WebKitXRPermissionRequest
 *
 * Gets the session mode for which permission is being requested.
 *
 * Returns: a #WebKitXRSessionMode
 *
 * Since: 2.52
 */
WebKitXRSessionMode webkit_xr_permission_request_get_session_mode(WebKitXRPermissionRequest* request)
{
#if ENABLE(WEBXR)
    g_return_val_if_fail(WEBKIT_IS_XR_PERMISSION_REQUEST(request), WEBKIT_XR_SESSION_MODE_INLINE);
    return request->priv->mode;
#else
    notImplemented();
    return WEBKIT_XR_SESSION_MODE_INLINE;
#endif
}

/**
 * webkit_xr_permission_request_get_granted_features:
 * @request: a #WebKitXRPermissionRequest
 *
 * Gets the features requested by the origin for the XR device, which
 * are either granted by default or have been explicitly granted by
 * the user.
 *
 * Returns: a #WebKitXRSessionFeatures flag combination
 *
 * Since: 2.52
 */
WebKitXRSessionFeatures webkit_xr_permission_request_get_granted_features(WebKitXRPermissionRequest* request)
{
#if ENABLE(WEBXR)
    g_return_val_if_fail(WEBKIT_IS_XR_PERMISSION_REQUEST(request), static_cast<WebKitXRSessionFeatures>(0));
    return request->priv->previouslyGrantedFeatures;
#else
    notImplemented();
    return static_cast<WebKitXRSessionFeatures>(0);
#endif
}

/**
 * webkit_xr_permission_request_get_consent_required_features:
 * @request: a #WebKitXRPermissionRequest
 *
 * Gets the required features that need user consent.
 *
 * These features are automatically granted if the request is allowed with
 * webkit_permission_request_allow().
 *
 * Returns: a #WebKitXRSessionFeatures flag combination
 *
 * Since: 2.52
 */
WebKitXRSessionFeatures webkit_xr_permission_request_get_consent_required_features(WebKitXRPermissionRequest* request)
{
#if ENABLE(WEBXR)
    g_return_val_if_fail(WEBKIT_IS_XR_PERMISSION_REQUEST(request), static_cast<WebKitXRSessionFeatures>(0));
    return request->priv->consentRequiredFeatures;
#else
    notImplemented();
    return static_cast<WebKitXRSessionFeatures>(0);
#endif
}

/**
 * webkit_xr_permission_request_get_consent_optional_features:
 * @request: a #WebKitXRPermissionRequest
 *
 * Gets the optional features that need user consent.
 *
 * These features can be granted by calling
 * webkit_xr_permission_request_set_granted_optional_features()
 * before allowing the request with webkit_permission_request_allow().
 *
 * Returns: a #WebKitXRSessionFeatures flag combination
 *
 * Since: 2.52
 */
WebKitXRSessionFeatures webkit_xr_permission_request_get_consent_optional_features(WebKitXRPermissionRequest* request)
{
#if ENABLE(WEBXR)
    g_return_val_if_fail(WEBKIT_IS_XR_PERMISSION_REQUEST(request), static_cast<WebKitXRSessionFeatures>(0));
    return request->priv->consentOptionalFeatures;
#else
    notImplemented();
    return static_cast<WebKitXRSessionFeatures>(0);
#endif
}

/**
 * webkit_xr_permission_request_get_required_features_requested:
 * @request: a #WebKitXRPermissionRequest
 *
 * Gets the full set of required features requested by the web application.
 *
 * This includes both already granted features and those requiring consent.
 *
 * Returns: a #WebKitXRSessionFeatures flag combination
 *
 * Since: 2.52
 */
WebKitXRSessionFeatures webkit_xr_permission_request_get_required_features_requested(WebKitXRPermissionRequest* request)
{
#if ENABLE(WEBXR)
    g_return_val_if_fail(WEBKIT_IS_XR_PERMISSION_REQUEST(request), static_cast<WebKitXRSessionFeatures>(0));
    return request->priv->requiredFeaturesRequested;
#else
    notImplemented();
    return static_cast<WebKitXRSessionFeatures>(0);
#endif
}

/**
 * webkit_xr_permission_request_get_optional_features_requested:
 * @request: a #WebKitXRPermissionRequest
 *
 * Gets the full set of optional features requested by the web application.
 *
 * This includes both already granted features and those requiring consent.
 *
 * Returns: a #WebKitXRSessionFeatures flag combination
 *
 * Since: 2.52
 *
 */
WebKitXRSessionFeatures webkit_xr_permission_request_get_optional_features_requested(WebKitXRPermissionRequest* request)
{
#if ENABLE(WEBXR)
    g_return_val_if_fail(WEBKIT_IS_XR_PERMISSION_REQUEST(request), static_cast<WebKitXRSessionFeatures>(0));
    return request->priv->optionalFeaturesRequested;
#else
    notImplemented();
    return static_cast<WebKitXRSessionFeatures>(0);
#endif
}

/**
 * webkit_xr_permission_request_set_granted_optional_features:
 * @request: a #WebKitXRPermissionRequest
 * @granted: granted features
 *
 * Sets which optional features should be granted if the permission request is allowed.
 *
 * This function should be called with a subset of the features from
 * webkit_xr_permission_request_get_consent_optional_features() before calling
 * webkit_permission_request_allow(). If the request is denied, no features are
 * granted, regardless of what is set here.
 *
 * Since: 2.52
 *
 */
void webkit_xr_permission_request_set_granted_optional_features(WebKitXRPermissionRequest* request, WebKitXRSessionFeatures granted)
{
#if ENABLE(WEBXR)
    g_return_if_fail(WEBKIT_IS_XR_PERMISSION_REQUEST(request));
    request->priv->newlyGrantedFeatures = granted;
#else
    notImplemented();
#endif
}

#if ENABLE(WEBXR)
static WebKitXRSessionMode toWebKitXRSessionMode(PlatformXR::SessionMode mode)
{
    switch (mode) {
    case PlatformXR::SessionMode::ImmersiveVr:
        return WEBKIT_XR_SESSION_MODE_IMMERSIVE_VR;
    case PlatformXR::SessionMode::ImmersiveAr:
        return WEBKIT_XR_SESSION_MODE_IMMERSIVE_AR;
    default:
        ASSERT_NOT_REACHED();
        break;
    }
    return WEBKIT_XR_SESSION_MODE_INLINE;
}

static WebKitXRSessionFeatures toWebKitXRSessionFeatures(const PlatformXR::Device::FeatureList& features)
{
    unsigned result = 0;
    for (auto& feature : features) {
        switch (feature) {
        case PlatformXR::SessionFeature::ReferenceSpaceTypeViewer:
            result |= WEBKIT_XR_SESSION_FEATURES_VIEWER;
            break;
        case PlatformXR::SessionFeature::ReferenceSpaceTypeLocal:
            result |= WEBKIT_XR_SESSION_FEATURES_LOCAL;
            break;
        case PlatformXR::SessionFeature::ReferenceSpaceTypeLocalFloor:
            result |= WEBKIT_XR_SESSION_FEATURES_LOCAL_FLOOR;
            break;
        case PlatformXR::SessionFeature::ReferenceSpaceTypeBoundedFloor:
            result |= WEBKIT_XR_SESSION_FEATURES_BOUNDED_FLOOR;
            break;
        case PlatformXR::SessionFeature::ReferenceSpaceTypeUnbounded:
            result |= WEBKIT_XR_SESSION_FEATURES_UNBOUNDED;
            break;
#if ENABLE(WEBXR_HANDS)
        case PlatformXR::SessionFeature::HandTracking:
            result |= WEBKIT_XR_SESSION_FEATURES_HAND_TRACKING;
            break;
#endif
#if ENABLE(WEBXR_HIT_TEST)
        case PlatformXR::SessionFeature::HitTest:
            result |= WEBKIT_XR_SESSION_FEATURES_HIT_TEST;
            break;
#endif
#if ENABLE(WEBXR_LAYERS)
        case PlatformXR::SessionFeature::Layers:
            result |= WEBKIT_XR_SESSION_FEATURES_LAYERS;
            break;
#endif
        default:
            ASSERT_NOT_REACHED();
            break;
        }
    }
    return static_cast<WebKitXRSessionFeatures>(result);
}

WebKitXRPermissionRequest* webkitXRPermissionRequestCreate(const WebCore::SecurityOriginData& securityOriginData, PlatformXR::SessionMode mode, const PlatformXR::Device::FeatureList& granted, const PlatformXR::Device::FeatureList& consentRequired, const PlatformXR::Device::FeatureList& consentOptional, const PlatformXR::Device::FeatureList& requiredFeaturesRequested, const PlatformXR::Device::FeatureList& optionalFeaturesRequested, CompletionHandler<void(std::optional<PlatformXR::Device::FeatureList>&&)>&& completionHandler)
{
    WebKitXRPermissionRequest* xrPermissionRequest = WEBKIT_XR_PERMISSION_REQUEST(g_object_new(WEBKIT_TYPE_XR_PERMISSION_REQUEST, nullptr));
    xrPermissionRequest->priv->securityOrigin = webkitSecurityOriginCreate(WebCore::SecurityOriginData { securityOriginData });
    xrPermissionRequest->priv->mode = toWebKitXRSessionMode(mode);
    xrPermissionRequest->priv->completionHandler = WTFMove(completionHandler);
    xrPermissionRequest->priv->previouslyGrantedFeatures = toWebKitXRSessionFeatures(granted);
    xrPermissionRequest->priv->consentRequiredFeatures = toWebKitXRSessionFeatures(consentRequired);
    xrPermissionRequest->priv->consentOptionalFeatures = toWebKitXRSessionFeatures(consentOptional);
    xrPermissionRequest->priv->requiredFeaturesRequested = toWebKitXRSessionFeatures(requiredFeaturesRequested);
    xrPermissionRequest->priv->optionalFeaturesRequested = toWebKitXRSessionFeatures(optionalFeaturesRequested);
    return xrPermissionRequest;
}
#endif