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
|
/*
* Copyright (C) 2008, 2009, 2010, 2011 Apple Inc. All Rights Reserved.
* Copyright 2010, The Android Open Source Project
*
* 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 APPLE INC. ``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 APPLE INC. OR
* CONTRIBUTORS 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 Geolocation_h
#define Geolocation_h
#include "bindings/core/v8/ScriptWrappable.h"
#include "core/dom/ActiveDOMObject.h"
#include "modules/geolocation/GeoNotifier.h"
#include "modules/geolocation/GeolocationWatchers.h"
#include "modules/geolocation/Geoposition.h"
#include "modules/geolocation/PositionCallback.h"
#include "modules/geolocation/PositionError.h"
#include "modules/geolocation/PositionErrorCallback.h"
#include "modules/geolocation/PositionOptions.h"
#include "platform/Timer.h"
#include "platform/heap/Handle.h"
namespace blink {
class Document;
class LocalFrame;
class GeolocationError;
class ExecutionContext;
class Geolocation final
: public GarbageCollectedFinalized<Geolocation>
, public ScriptWrappable
, public ActiveDOMObject {
DEFINE_WRAPPERTYPEINFO();
WILL_BE_USING_GARBAGE_COLLECTED_MIXIN(Geolocation);
public:
static Geolocation* create(ExecutionContext*);
virtual ~Geolocation();
virtual void trace(Visitor*) override;
virtual void stop() override;
Document* document() const;
LocalFrame* frame() const;
// Creates a oneshot and attempts to obtain a position that meets the
// constraints of the options.
void getCurrentPosition(PositionCallback*, PositionErrorCallback*, const PositionOptions&);
// Creates a watcher that will be notified whenever a new position is
// available that meets the constraints of the options.
int watchPosition(PositionCallback*, PositionErrorCallback*, const PositionOptions&);
// Removes all references to the watcher, it will not be updated again.
void clearWatch(int watchID);
void setIsAllowed(bool);
bool isAllowed() const { return m_geolocationPermission == PermissionAllowed; }
// Notifies this that a new position is available. Must never be called
// before permission is granted by the user.
void positionChanged();
// Notifies this that an error has occurred, it must be handled immediately.
void setError(GeolocationError*);
// Discards the notifier because a fatal error occurred for it.
void fatalErrorOccurred(GeoNotifier*);
// Adds the notifier to the set awaiting a cached position. Runs the success
// callbacks for them if permission has been granted. Requests permission if
// it is unknown.
void requestUsesCachedPosition(GeoNotifier*);
// Discards the notifier if it is a oneshot because it timed it.
void requestTimedOut(GeoNotifier*);
private:
// Returns the last known position, if any. May return null.
Geoposition* lastPosition();
bool isDenied() const { return m_geolocationPermission == PermissionDenied; }
explicit Geolocation(ExecutionContext*);
typedef HeapVector<Member<GeoNotifier> > GeoNotifierVector;
typedef HeapHashSet<Member<GeoNotifier> > GeoNotifierSet;
bool hasListeners() const { return !m_oneShots.isEmpty() || !m_watchers.isEmpty(); }
void sendError(GeoNotifierVector&, PositionError*);
void sendPosition(GeoNotifierVector&, Geoposition*);
// Removes notifiers that use a cached position from |notifiers| and
// if |cached| is not null they are added to it.
static void extractNotifiersWithCachedPosition(GeoNotifierVector& notifiers, GeoNotifierVector* cached);
// Copies notifiers from |src| vector to |dest| set.
static void copyToSet(const GeoNotifierVector& src, GeoNotifierSet& dest);
static void stopTimer(GeoNotifierVector&);
void stopTimersForOneShots();
void stopTimersForWatchers();
void stopTimers();
// Sets a fatal error on the given notifiers.
void cancelRequests(GeoNotifierVector&);
// Sets a fatal error on all notifiers.
void cancelAllRequests();
// Runs the success callbacks on all notifiers. A position must be available
// and the user must have given permission.
void makeSuccessCallbacks();
// Sends the given error to all notifiers, unless the error is not fatal and
// the notifier is due to receive a cached position. Clears the oneshots,
// and also clears the watchers if the error is fatal.
void handleError(PositionError*);
// Requests permission to share positions with the page.
void requestPermission();
// Attempts to register this with the controller for receiving updates.
// Returns false if there is no controller to register with.
bool startUpdating(GeoNotifier*);
void stopUpdating();
// Processes the notifiers that were waiting for a permission decision. If
// granted and this can be registered with the controller then the
// notifier's timers are started. Otherwise, a fatal error is set on them.
void handlePendingPermissionNotifiers();
// Attempts to obtain a position for the given notifier, either by using
// the cached position or by requesting one from the controller. Sets a
// fatal error if permission is denied or no position can be obtained.
void startRequest(GeoNotifier*);
bool haveSuitableCachedPosition(const PositionOptions&);
// Runs the success callbacks for the set of notifiers awaiting a cached
// position, the set is then cleared. The oneshots are removed everywhere.
void makeCachedPositionCallbacks();
// Record whether the origin trying to access Geolocation would be allowed
// to access a feature that can only be accessed by secure origins.
// See http://goo.gl/lq4gCo
void recordOriginTypeAccess() const;
GeoNotifierSet m_oneShots;
GeolocationWatchers m_watchers;
GeoNotifierSet m_pendingForPermissionNotifiers;
Member<Geoposition> m_lastPosition;
// States of Geolocation permission as granted by the embedder. Unknown
// means that the embedder still has to be asked for the current permission
// level; Requested means that the user has yet to make a decision.
enum Permission {
PermissionUnknown,
PermissionRequested,
PermissionAllowed,
PermissionDenied
};
Permission m_geolocationPermission;
GeoNotifierSet m_requestsAwaitingCachedPosition;
};
} // namespace blink
#endif // Geolocation_h
|
