2008-07-15 16:37:48 -07:00
|
|
|
/* ***** BEGIN LICENSE BLOCK *****
|
|
|
|
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
|
|
|
|
*
|
|
|
|
* The contents of this file are subject to the Mozilla Public License Version
|
|
|
|
* 1.1 (the "License"); you may not use this file except in compliance with
|
|
|
|
* the License. You may obtain a copy of the License at
|
|
|
|
* http://www.mozilla.org/MPL/
|
|
|
|
*
|
|
|
|
* Software distributed under the License is distributed on an "AS IS" basis,
|
|
|
|
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
|
|
|
|
* for the specific language governing rights and limitations under the
|
|
|
|
* License.
|
|
|
|
*
|
|
|
|
* The Original Code is Geolocation.
|
|
|
|
*
|
|
|
|
* The Initial Developer of the Original Code is Mozilla Corporation
|
|
|
|
* Portions created by the Initial Developer are Copyright (C) 2008
|
|
|
|
* the Initial Developer. All Rights Reserved.
|
|
|
|
*
|
|
|
|
* Contributor(s):
|
|
|
|
* Doug Turner <dougt@meer.net> (Original Author)
|
|
|
|
*
|
|
|
|
* Alternatively, the contents of this file may be used under the terms of
|
|
|
|
* either the GNU General Public License Version 2 or later (the "GPL"), or
|
|
|
|
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
|
|
|
|
* in which case the provisions of the GPL or the LGPL are applicable instead
|
|
|
|
* of those above. If you wish to allow use of your version of this file only
|
|
|
|
* under the terms of either the GPL or the LGPL, and not to allow others to
|
|
|
|
* use your version of this file under the terms of the MPL, indicate your
|
|
|
|
* decision by deleting the provisions above and replace them with the notice
|
|
|
|
* and other provisions required by the GPL or the LGPL. If you do not delete
|
|
|
|
* the provisions above, a recipient may use your version of this file under
|
|
|
|
* the terms of any one of the MPL, the GPL or the LGPL.
|
|
|
|
*
|
|
|
|
* ***** END LICENSE BLOCK ***** */
|
|
|
|
|
|
|
|
|
|
|
|
#include "nsCOMPtr.h"
|
|
|
|
#include "nsAutoPtr.h"
|
|
|
|
#include "nsCOMArray.h"
|
|
|
|
#include "nsTArray.h"
|
|
|
|
#include "nsITimer.h"
|
|
|
|
#include "nsIObserver.h"
|
|
|
|
#include "nsIURI.h"
|
|
|
|
|
2008-08-14 09:35:49 -07:00
|
|
|
#include "nsIDOMGeoGeolocation.h"
|
|
|
|
#include "nsIDOMGeoPosition.h"
|
|
|
|
#include "nsIDOMGeoPositionError.h"
|
|
|
|
#include "nsIDOMGeoPositionCallback.h"
|
|
|
|
#include "nsIDOMGeoPositionErrorCallback.h"
|
|
|
|
#include "nsIDOMGeoPositionOptions.h"
|
|
|
|
#include "nsIDOMNavigatorGeolocation.h"
|
2008-07-15 16:37:48 -07:00
|
|
|
|
|
|
|
#include "nsPIDOMWindow.h"
|
|
|
|
|
|
|
|
#include "nsIGeolocationProvider.h"
|
|
|
|
|
2008-08-14 09:35:49 -07:00
|
|
|
class nsGeolocationService;
|
|
|
|
class nsGeolocation;
|
2008-07-15 16:37:48 -07:00
|
|
|
|
|
|
|
class nsGeolocationRequest : public nsIGeolocationRequest
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
NS_DECL_ISUPPORTS
|
|
|
|
NS_DECL_NSIGEOLOCATIONREQUEST
|
|
|
|
|
2008-08-14 09:35:49 -07:00
|
|
|
nsGeolocationRequest(nsGeolocation* locator,
|
|
|
|
nsIDOMGeoPositionCallback* callback,
|
|
|
|
nsIDOMGeoPositionErrorCallback* errorCallback);
|
2008-07-15 16:37:48 -07:00
|
|
|
void Shutdown();
|
|
|
|
|
2008-08-14 09:35:49 -07:00
|
|
|
void SendLocation(nsIDOMGeoPosition* location);
|
2008-07-15 16:37:48 -07:00
|
|
|
void MarkCleared();
|
|
|
|
PRBool Allowed() {return mAllowed;}
|
|
|
|
|
|
|
|
~nsGeolocationRequest();
|
|
|
|
|
|
|
|
private:
|
|
|
|
PRBool mAllowed;
|
|
|
|
PRBool mCleared;
|
|
|
|
PRBool mFuzzLocation;
|
|
|
|
|
2008-08-14 09:35:49 -07:00
|
|
|
nsCOMPtr<nsIDOMGeoPositionCallback> mCallback;
|
|
|
|
nsCOMPtr<nsIDOMGeoPositionErrorCallback> mErrorCallback;
|
2008-07-15 16:37:48 -07:00
|
|
|
|
2008-08-14 09:35:49 -07:00
|
|
|
nsGeolocation* mLocator; // The locator exists alonger than this object.
|
2008-07-15 16:37:48 -07:00
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Simple object that holds a single point in space.
|
|
|
|
*/
|
2008-08-14 09:35:49 -07:00
|
|
|
class nsGeoPosition : public nsIDOMGeoPosition
|
2008-07-15 16:37:48 -07:00
|
|
|
{
|
|
|
|
public:
|
|
|
|
NS_DECL_ISUPPORTS
|
2008-08-14 09:35:49 -07:00
|
|
|
NS_DECL_NSIDOMGEOPOSITION
|
2008-07-15 16:37:48 -07:00
|
|
|
|
2008-08-14 09:35:49 -07:00
|
|
|
nsGeoPosition(double aLat, double aLong, double aAlt, double aHError, double aVError, double aHeading, double aVelocity, long long aTimestamp)
|
|
|
|
: mLat(aLat), mLong(aLong), mAlt(aAlt), mHError(aHError), mVError(aVError), mHeading(aHeading), mVelocity(aVelocity), mTimestamp(aTimestamp){};
|
2008-07-15 16:37:48 -07:00
|
|
|
|
|
|
|
private:
|
2008-08-14 09:35:49 -07:00
|
|
|
~nsGeoPosition(){}
|
|
|
|
double mLat, mLong, mAlt, mHError, mVError, mHeading, mVelocity;
|
2008-07-15 16:37:48 -07:00
|
|
|
long long mTimestamp;
|
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Singleton that manages the geolocation provider
|
|
|
|
*/
|
2008-08-14 09:35:49 -07:00
|
|
|
class nsGeolocationService : public nsIGeolocationService, public nsIGeolocationUpdate, public nsIObserver
|
2008-07-15 16:37:48 -07:00
|
|
|
{
|
|
|
|
public:
|
|
|
|
|
2008-08-14 09:35:49 -07:00
|
|
|
static nsGeolocationService* GetGeolocationService();
|
|
|
|
static nsGeolocationService* GetInstance(); // Non-Addref'ing
|
|
|
|
static nsGeolocationService* gService;
|
2008-07-15 16:37:48 -07:00
|
|
|
|
|
|
|
NS_DECL_ISUPPORTS
|
|
|
|
NS_DECL_NSIGEOLOCATIONUPDATE
|
|
|
|
NS_DECL_NSIOBSERVER
|
|
|
|
NS_DECL_NSIGEOLOCATIONSERVICE
|
|
|
|
|
2008-08-14 09:35:49 -07:00
|
|
|
nsGeolocationService();
|
2008-07-15 16:37:48 -07:00
|
|
|
|
2008-08-14 09:35:49 -07:00
|
|
|
// Management of the nsGeolocation objects
|
|
|
|
void AddLocator(nsGeolocation* locator);
|
|
|
|
void RemoveLocator(nsGeolocation* locator);
|
2008-07-15 16:37:48 -07:00
|
|
|
|
|
|
|
// Returns the last geolocation we have seen since calling StartDevice()
|
2008-08-14 09:35:49 -07:00
|
|
|
already_AddRefed<nsIDOMGeoPosition> GetLastKnownPosition();
|
2008-07-15 16:37:48 -07:00
|
|
|
|
|
|
|
// Returns the application defined UI prompt
|
|
|
|
nsIGeolocationPrompt* GetPrompt() { return mPrompt; } // does not addref.
|
|
|
|
|
|
|
|
// Returns true if the we have successfully found and started a
|
|
|
|
// geolocation device
|
|
|
|
PRBool IsDeviceReady();
|
|
|
|
|
|
|
|
// Find and startup a geolocation device (gps, nmea, etc.)
|
|
|
|
nsresult StartDevice();
|
|
|
|
|
|
|
|
// Stop the started geolocation device (gps, nmea, etc.)
|
|
|
|
void StopDevice();
|
|
|
|
|
|
|
|
// create, or reinitalize the callback timer
|
|
|
|
void SetDisconnectTimer();
|
|
|
|
|
|
|
|
private:
|
|
|
|
|
2008-08-14 09:35:49 -07:00
|
|
|
~nsGeolocationService();
|
2008-07-15 16:37:48 -07:00
|
|
|
|
|
|
|
// Disconnect timer. When this timer expires, it clears all pending callbacks
|
|
|
|
// and closes down the provider, unless we are watching a point, and in that
|
|
|
|
// case, we disable the disconnect timer.
|
|
|
|
nsCOMPtr<nsITimer> mDisconnectTimer;
|
|
|
|
|
|
|
|
// Time, in milliseconds, to wait for the location provider to spin up.
|
|
|
|
PRInt32 mTimeout;
|
|
|
|
|
|
|
|
// The object providing geo location information to us.
|
|
|
|
nsCOMPtr<nsIGeolocationProvider> mProvider;
|
|
|
|
|
|
|
|
// mGeolocators are not owned here. Their constructor
|
|
|
|
// addes them to this list, and their destructor removes
|
|
|
|
// them from this list.
|
2008-08-14 09:35:49 -07:00
|
|
|
nsTArray<nsGeolocation*> mGeolocators;
|
2008-07-15 16:37:48 -07:00
|
|
|
|
|
|
|
// prompt callback, if any
|
|
|
|
nsCOMPtr<nsIGeolocationPrompt> mPrompt;
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Can return a geolocation info
|
|
|
|
*/
|
2008-08-14 09:35:49 -07:00
|
|
|
class nsGeolocation : public nsIDOMGeoGeolocation
|
2008-07-15 16:37:48 -07:00
|
|
|
{
|
|
|
|
public:
|
|
|
|
|
|
|
|
NS_DECL_ISUPPORTS
|
2008-08-14 09:35:49 -07:00
|
|
|
NS_DECL_NSIDOMGEOGEOLOCATION
|
2008-07-15 16:37:48 -07:00
|
|
|
|
2008-08-14 09:35:49 -07:00
|
|
|
nsGeolocation(nsIDOMWindow* contentDom);
|
2008-07-15 16:37:48 -07:00
|
|
|
|
|
|
|
// Called by the geolocation device to notify that a location has changed.
|
2008-08-14 09:35:49 -07:00
|
|
|
void Update(nsIDOMGeoPosition* aPosition);
|
2008-07-15 16:37:48 -07:00
|
|
|
|
|
|
|
// Returns true if any of the callbacks are repeating
|
|
|
|
PRBool HasActiveCallbacks();
|
|
|
|
|
|
|
|
// Remove request from all callbacks arrays
|
|
|
|
void RemoveRequest(nsGeolocationRequest* request);
|
|
|
|
|
|
|
|
// Shutting down.
|
|
|
|
void Shutdown();
|
|
|
|
|
2008-08-14 09:35:49 -07:00
|
|
|
// Setter and Getter of the URI that this nsGeolocation was loaded from
|
2008-07-15 16:37:48 -07:00
|
|
|
nsIURI* GetURI() { return mURI; }
|
|
|
|
|
2008-08-14 09:35:49 -07:00
|
|
|
// Setter and Getter of the window that this nsGeolocation is owned by
|
2008-07-15 16:37:48 -07:00
|
|
|
nsIDOMWindow* GetOwner() { return mOwner; }
|
|
|
|
|
|
|
|
// Check to see if the widnow still exists
|
|
|
|
PRBool OwnerStillExists();
|
|
|
|
|
|
|
|
private:
|
|
|
|
|
2008-08-14 09:35:49 -07:00
|
|
|
~nsGeolocation();
|
2008-07-15 16:37:48 -07:00
|
|
|
|
|
|
|
// Two callback arrays. The first |mPendingCallbacks| holds objects for only
|
|
|
|
// one callback and then they are released/removed from the array. The second
|
|
|
|
// |mWatchingCallbacks| holds objects until the object is explictly removed or
|
|
|
|
// there is a page change.
|
|
|
|
|
|
|
|
nsCOMArray<nsGeolocationRequest> mPendingCallbacks;
|
|
|
|
nsCOMArray<nsGeolocationRequest> mWatchingCallbacks;
|
|
|
|
|
|
|
|
PRBool mUpdateInProgress;
|
|
|
|
|
|
|
|
// window that this was created for. Weak reference.
|
|
|
|
nsPIDOMWindow* mOwner;
|
|
|
|
|
|
|
|
// where the content was loaded from
|
|
|
|
nsCOMPtr<nsIURI> mURI;
|
|
|
|
|
|
|
|
// owning back pointer.
|
2008-08-14 09:35:49 -07:00
|
|
|
nsRefPtr<nsGeolocationService> mService;
|
2008-07-15 16:37:48 -07:00
|
|
|
};
|