Deprecate ActiveDOMObject::canSuspendForDocumentSuspension()
[WebKit-https.git] / Source / WebCore / Modules / geolocation / Geolocation.h
1 /*
2  * Copyright (C) 2008, 2009, 2010, 2011 Apple Inc. All Rights Reserved.
3  * Copyright 2010, The Android Open Source Project
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
25  */
26
27 #pragma once
28
29 #if ENABLE(GEOLOCATION)
30
31 #include "ActiveDOMObject.h"
32 #include "Document.h"
33 #include "GeolocationPosition.h"
34 #include "GeolocationPositionError.h"
35 #include "PositionCallback.h"
36 #include "PositionErrorCallback.h"
37 #include "PositionOptions.h"
38 #include "ScriptWrappable.h"
39 #include "Timer.h"
40 #include <wtf/HashMap.h>
41 #include <wtf/HashSet.h>
42
43 namespace WebCore {
44
45 class Frame;
46 class GeoNotifier;
47 class GeolocationError;
48 class Navigator;
49 class Page;
50 class ScriptExecutionContext;
51 class SecurityOrigin;
52 struct PositionOptions;
53
54 class Geolocation final : public ScriptWrappable, public RefCounted<Geolocation>, public ActiveDOMObject {
55     WTF_MAKE_ISO_ALLOCATED_EXPORT(Geolocation, WEBCORE_EXPORT);
56     friend class GeoNotifier;
57 public:
58     static Ref<Geolocation> create(Navigator&);
59     WEBCORE_EXPORT ~Geolocation();
60
61     WEBCORE_EXPORT void resetAllGeolocationPermission();
62     Document* document() const { return downcast<Document>(scriptExecutionContext()); }
63
64     void getCurrentPosition(Ref<PositionCallback>&&, RefPtr<PositionErrorCallback>&&, PositionOptions&&);
65     int watchPosition(Ref<PositionCallback>&&, RefPtr<PositionErrorCallback>&&, PositionOptions&&);
66     void clearWatch(int watchID);
67
68     WEBCORE_EXPORT void setIsAllowed(bool);
69     void resetIsAllowed() { m_allowGeolocation = Unknown; }
70     bool isAllowed() const { return m_allowGeolocation == Yes; }
71
72     void positionChanged();
73     void setError(GeolocationError&);
74     bool shouldBlockGeolocationRequests();
75
76     Navigator* navigator();
77     WEBCORE_EXPORT Frame* frame() const;
78
79 private:
80     explicit Geolocation(Navigator&);
81
82     GeolocationPosition* lastPosition();
83
84     // ActiveDOMObject
85     void stop() override;
86     void suspend(ReasonForSuspension) override;
87     void resume() override;
88     const char* activeDOMObjectName() const override;
89
90     bool isDenied() const { return m_allowGeolocation == No; }
91
92     Page* page() const;
93     SecurityOrigin* securityOrigin() const;
94
95     typedef Vector<RefPtr<GeoNotifier>> GeoNotifierVector;
96     typedef HashSet<RefPtr<GeoNotifier>> GeoNotifierSet;
97
98     class Watchers {
99     public:
100         bool add(int id, RefPtr<GeoNotifier>&&);
101         GeoNotifier* find(int id);
102         void remove(int id);
103         void remove(GeoNotifier*);
104         bool contains(GeoNotifier*) const;
105         void clear();
106         bool isEmpty() const;
107         void getNotifiersVector(GeoNotifierVector&) const;
108     private:
109         typedef HashMap<int, RefPtr<GeoNotifier>> IdToNotifierMap;
110         typedef HashMap<RefPtr<GeoNotifier>, int> NotifierToIdMap;
111         IdToNotifierMap m_idToNotifierMap;
112         NotifierToIdMap m_notifierToIdMap;
113     };
114
115     bool hasListeners() const { return !m_oneShots.isEmpty() || !m_watchers.isEmpty(); }
116
117     void sendError(GeoNotifierVector&, GeolocationPositionError&);
118     void sendPosition(GeoNotifierVector&, GeolocationPosition&);
119
120     static void extractNotifiersWithCachedPosition(GeoNotifierVector& notifiers, GeoNotifierVector* cached);
121     static void copyToSet(const GeoNotifierVector&, GeoNotifierSet&);
122
123     static void stopTimer(GeoNotifierVector&);
124     void stopTimersForOneShots();
125     void stopTimersForWatchers();
126     void stopTimers();
127
128     void cancelRequests(GeoNotifierVector&);
129     void cancelAllRequests();
130
131     void makeSuccessCallbacks(GeolocationPosition&);
132     void handleError(GeolocationPositionError&);
133
134     void requestPermission();
135
136     bool startUpdating(GeoNotifier*);
137     void stopUpdating();
138
139     void handlePendingPermissionNotifiers();
140
141     void startRequest(GeoNotifier*);
142
143     void fatalErrorOccurred(GeoNotifier*);
144     void requestTimedOut(GeoNotifier*);
145     void requestUsesCachedPosition(GeoNotifier*);
146     bool haveSuitableCachedPosition(const PositionOptions&);
147     void makeCachedPositionCallbacks();
148
149     void resumeTimerFired();
150
151     WeakPtr<Navigator> m_navigator;
152     GeoNotifierSet m_oneShots;
153     Watchers m_watchers;
154     GeoNotifierSet m_pendingForPermissionNotifiers;
155     RefPtr<GeolocationPosition> m_lastPosition;
156
157     enum { Unknown, InProgress, Yes, No } m_allowGeolocation { Unknown };
158     bool m_isSuspended { false };
159     bool m_resetOnResume { false };
160     bool m_hasChangedPosition { false };
161     RefPtr<GeolocationPositionError> m_errorWaitingForResume;
162     Timer m_resumeTimer;
163     GeoNotifierSet m_requestsAwaitingCachedPosition;
164 };
165     
166 } // namespace WebCore
167
168 #endif // ENABLE(GEOLOCATION)