2009-04-17 14:19:31 -07:00
|
|
|
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
|
|
|
|
* vim: sw=2 ts=2 et lcs=trail\:.,tab\:>~ :
|
|
|
|
* ***** BEGIN LICENSE BLOCK *****
|
2007-03-22 10:30:00 -07:00
|
|
|
* 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 Oracle Corporation code.
|
|
|
|
*
|
|
|
|
* The Initial Developer of the Original Code is
|
|
|
|
* Oracle Corporation
|
|
|
|
* Portions created by the Initial Developer are Copyright (C) 2004
|
|
|
|
* the Initial Developer. All Rights Reserved.
|
|
|
|
*
|
|
|
|
* Contributor(s):
|
|
|
|
* Vladimir Vukicevic <vladimir.vukicevic@oracle.com>
|
2007-07-07 14:14:51 -07:00
|
|
|
* Lev Serebryakov <lev@serebryakov.spb.ru>
|
2007-03-22 10:30:00 -07:00
|
|
|
*
|
|
|
|
* 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 ***** */
|
|
|
|
|
|
|
|
#ifndef _MOZSTORAGECONNECTION_H_
|
|
|
|
#define _MOZSTORAGECONNECTION_H_
|
|
|
|
|
2009-07-15 10:49:05 -07:00
|
|
|
#include "nsAutoPtr.h"
|
2007-03-22 10:30:00 -07:00
|
|
|
#include "nsCOMPtr.h"
|
2009-09-02 13:30:24 -07:00
|
|
|
#include "mozilla/Mutex.h"
|
2007-03-22 10:30:00 -07:00
|
|
|
|
|
|
|
#include "nsString.h"
|
2008-07-08 15:38:25 -07:00
|
|
|
#include "nsInterfaceHashtable.h"
|
2007-07-07 14:14:51 -07:00
|
|
|
#include "mozIStorageProgressHandler.h"
|
2009-07-22 15:18:33 -07:00
|
|
|
#include "SQLiteMutex.h"
|
2007-03-22 10:30:00 -07:00
|
|
|
#include "mozIStorageConnection.h"
|
2009-07-15 10:49:05 -07:00
|
|
|
#include "mozStorageService.h"
|
2007-03-22 10:30:00 -07:00
|
|
|
|
|
|
|
#include "nsIMutableArray.h"
|
|
|
|
|
2009-06-28 22:42:56 -07:00
|
|
|
#include "sqlite3.h"
|
2007-03-22 10:30:00 -07:00
|
|
|
|
2009-06-17 12:12:43 -07:00
|
|
|
struct PRLock;
|
2007-03-22 10:30:00 -07:00
|
|
|
class nsIFile;
|
2008-10-28 20:53:19 -07:00
|
|
|
class nsIEventTarget;
|
|
|
|
class nsIThread;
|
2007-03-22 10:30:00 -07:00
|
|
|
|
2009-04-17 14:19:31 -07:00
|
|
|
namespace mozilla {
|
|
|
|
namespace storage {
|
|
|
|
|
|
|
|
class Connection : public mozIStorageConnection
|
2007-03-22 10:30:00 -07:00
|
|
|
{
|
|
|
|
public:
|
2009-04-17 14:19:31 -07:00
|
|
|
NS_DECL_ISUPPORTS
|
|
|
|
NS_DECL_MOZISTORAGECONNECTION
|
|
|
|
|
2009-07-15 10:49:05 -07:00
|
|
|
Connection(Service *aService);
|
2009-04-17 14:19:31 -07:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Creates the connection to the database.
|
|
|
|
*
|
|
|
|
* @param aDatabaseFile
|
|
|
|
* The nsIFile of the location of the database to open, or create if it
|
|
|
|
* does not exist. Passing in nsnull here creates an in-memory
|
|
|
|
* database.
|
|
|
|
*/
|
|
|
|
nsresult initialize(nsIFile *aDatabaseFile);
|
|
|
|
|
|
|
|
// fetch the native handle
|
|
|
|
sqlite3 *GetNativeConnection() { return mDBConn; }
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Lazily creates and returns a background execution thread. In the future,
|
|
|
|
* the thread may be re-claimed if left idle, so you should call this
|
|
|
|
* method just before you dispatch and not save the reference.
|
2009-06-17 12:12:43 -07:00
|
|
|
*
|
2009-04-17 14:19:31 -07:00
|
|
|
* @returns an event target suitable for asynchronous statement execution.
|
|
|
|
*/
|
2010-03-24 00:32:40 -07:00
|
|
|
nsIEventTarget *getAsyncExecutionTarget();
|
2008-10-28 20:53:19 -07:00
|
|
|
|
2009-09-02 13:30:24 -07:00
|
|
|
/**
|
|
|
|
* Mutex used by asynchronous statements to protect state. The mutex is
|
|
|
|
* declared on the connection object because there is no contention between
|
2010-03-24 00:32:40 -07:00
|
|
|
* asynchronous statements (they are serialized on mAsyncExecutionThread). It
|
|
|
|
* also protects mPendingStatements.
|
2009-09-02 13:30:24 -07:00
|
|
|
*/
|
|
|
|
Mutex sharedAsyncExecutionMutex;
|
|
|
|
|
2010-03-24 00:32:40 -07:00
|
|
|
/**
|
|
|
|
* Wraps the mutex that SQLite gives us from sqlite3_db_mutex. This is public
|
|
|
|
* because we already expose the sqlite3* native connection and proper
|
|
|
|
* operation of the deadlock detector requires everyone to use the same single
|
|
|
|
* SQLiteMutex instance for correctness.
|
|
|
|
*/
|
|
|
|
SQLiteMutex sharedDBMutex;
|
|
|
|
|
2009-12-02 10:53:46 -08:00
|
|
|
/**
|
2009-11-09 09:58:34 -08:00
|
|
|
* References the thread this database was opened on. This MUST be thread it is
|
|
|
|
* closed on.
|
2009-12-02 10:53:46 -08:00
|
|
|
*/
|
|
|
|
const nsCOMPtr<nsIThread> threadOpenedOn;
|
|
|
|
|
2009-11-09 09:58:34 -08:00
|
|
|
/**
|
|
|
|
* Closes the SQLite database, and warns about any non-finalized statements.
|
|
|
|
*/
|
|
|
|
nsresult internalClose();
|
|
|
|
|
2010-05-19 16:22:19 -07:00
|
|
|
/**
|
|
|
|
* Obtains the filename of the connection. Useful for logging.
|
|
|
|
*/
|
|
|
|
nsCString getFilename();
|
|
|
|
|
2007-03-22 10:30:00 -07:00
|
|
|
private:
|
2009-04-17 14:19:31 -07:00
|
|
|
~Connection();
|
|
|
|
|
2009-11-09 09:58:34 -08:00
|
|
|
/**
|
|
|
|
* Sets the database into a closed state so no further actions can be
|
|
|
|
* performed.
|
|
|
|
*
|
|
|
|
* @note mDBConn is set to NULL in this method.
|
|
|
|
*/
|
|
|
|
nsresult setClosedState();
|
|
|
|
|
2009-04-17 14:19:31 -07:00
|
|
|
/**
|
|
|
|
* Describes a certain primitive type in the database.
|
|
|
|
*
|
|
|
|
* Possible Values Are:
|
|
|
|
* INDEX - To check for the existence of an index
|
|
|
|
* TABLE - To check for the existence of a table
|
|
|
|
*/
|
|
|
|
enum DatabaseElementType {
|
|
|
|
INDEX,
|
|
|
|
TABLE
|
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Determines if the specified primitive exists.
|
|
|
|
*
|
|
|
|
* @param aElementType
|
|
|
|
* The type of element to check the existence of
|
|
|
|
* @param aElementName
|
|
|
|
* The name of the element to check for
|
|
|
|
* @returns true if element exists, false otherwise
|
|
|
|
*/
|
|
|
|
nsresult databaseElementExists(enum DatabaseElementType aElementType,
|
|
|
|
const nsACString& aElementName,
|
|
|
|
PRBool *_exists);
|
|
|
|
|
|
|
|
bool findFunctionByInstance(nsISupports *aInstance);
|
|
|
|
|
|
|
|
static int sProgressHelper(void *aArg);
|
|
|
|
// Generic progress handler
|
|
|
|
// Dispatch call to registered progress handler,
|
|
|
|
// if there is one. Do nothing in other cases.
|
|
|
|
int progressHandler();
|
|
|
|
|
|
|
|
sqlite3 *mDBConn;
|
|
|
|
nsCOMPtr<nsIFile> mDatabaseFile;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Lazily created thread for asynchronous statement execution. Consumers
|
|
|
|
* should use getAsyncExecutionTarget rather than directly accessing this
|
|
|
|
* field.
|
|
|
|
*/
|
|
|
|
nsCOMPtr<nsIThread> mAsyncExecutionThread;
|
|
|
|
/**
|
|
|
|
* Set to true by Close() prior to actually shutting down the thread. This
|
|
|
|
* lets getAsyncExecutionTarget() know not to hand out any more thread
|
|
|
|
* references (or to create the thread in the first place). This variable
|
|
|
|
* should be accessed while holding the mAsyncExecutionMutex.
|
|
|
|
*/
|
2009-11-09 09:58:34 -08:00
|
|
|
bool mAsyncExecutionThreadShuttingDown;
|
2009-04-17 14:19:31 -07:00
|
|
|
|
2009-07-22 15:18:33 -07:00
|
|
|
/**
|
|
|
|
* Tracks if we have a transaction in progress or not. Access protected by
|
|
|
|
* mDBMutex.
|
|
|
|
*/
|
2009-04-17 14:19:31 -07:00
|
|
|
PRBool mTransactionInProgress;
|
|
|
|
|
2009-07-22 15:18:33 -07:00
|
|
|
/**
|
|
|
|
* Stores the mapping of a given function by name to its instance. Access is
|
|
|
|
* protected by mDBMutex.
|
|
|
|
*/
|
2009-04-17 14:19:31 -07:00
|
|
|
nsInterfaceHashtable<nsCStringHashKey, nsISupports> mFunctions;
|
|
|
|
|
2009-07-22 15:18:33 -07:00
|
|
|
/**
|
|
|
|
* Stores the registered progress handler for the database connection. Access
|
|
|
|
* is protected by mDBMutex.
|
|
|
|
*/
|
2009-04-17 14:19:31 -07:00
|
|
|
nsCOMPtr<mozIStorageProgressHandler> mProgressHandler;
|
|
|
|
|
2009-07-15 10:49:05 -07:00
|
|
|
// This is here for two reasons: 1) It's used to make sure that the
|
|
|
|
// connections do not outlive the service. 2) Our custom collating functions
|
|
|
|
// call its localeCompareStrings() method.
|
|
|
|
nsRefPtr<Service> mStorageService;
|
2007-03-22 10:30:00 -07:00
|
|
|
};
|
|
|
|
|
2009-04-17 14:19:31 -07:00
|
|
|
} // namespace storage
|
|
|
|
} // namespace mozilla
|
|
|
|
|
2007-03-22 10:30:00 -07:00
|
|
|
#endif /* _MOZSTORAGECONNECTION_H_ */
|