The Tor Browser: extensions/cookie/nsPermissionManager.h@b8a032363ba2 (annotated)

extensions/cookie/nsPermissionManager.h@b8a032363ba2 (annotated)

extensions/cookie/nsPermissionManager.h

Thu, 22 Jan 2015 13:21:57 +0100

author: Michael Schloh von Bennewitz <michael@schloh.com>
date: Thu, 22 Jan 2015 13:21:57 +0100
branch: TOR_BUG_9701
changeset 15: b8a032363ba2
permissions: -rw-r--r--

Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6

 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
 /* This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 #ifndef nsPermissionManager_h__
 #define nsPermissionManager_h__
 #include "nsIPermissionManager.h"
 #include "nsIObserver.h"
 #include "nsIObserverService.h"
 #include "nsWeakReference.h"
 #include "nsCOMPtr.h"
 #include "nsIFile.h"
 #include "nsTHashtable.h"
 #include "nsTArray.h"
 #include "nsString.h"
 #include "nsPermission.h"
 #include "nsHashKeys.h"
 #include "nsAutoPtr.h"
 #include "nsCOMArray.h"
 #include "nsDataHashtable.h"
 class nsIPermission;
 class nsIIDNService;
 class mozIStorageConnection;
 class mozIStorageAsyncStatement;
 ////////////////////////////////////////////////////////////////////////////////
 class nsPermissionManager : public nsIPermissionManager,
                             public nsIObserver,
                             public nsSupportsWeakReference
 {
 public:
   class PermissionEntry
   {
   public:
     PermissionEntry(int64_t aID, uint32_t aType, uint32_t aPermission,
                     uint32_t aExpireType, int64_t aExpireTime)
      : mID(aID)
      , mType(aType)
      , mPermission(aPermission)
      , mExpireType(aExpireType)
      , mExpireTime(aExpireTime)
      , mNonSessionPermission(aPermission)
      , mNonSessionExpireType(aExpireType)
      , mNonSessionExpireTime(aExpireTime)
     {}
     int64_t  mID;
     uint32_t mType;
     uint32_t mPermission;
     uint32_t mExpireType;
     int64_t  mExpireTime;
     uint32_t mNonSessionPermission;
     uint32_t mNonSessionExpireType;
     uint32_t mNonSessionExpireTime;
   };
   /**
    * PermissionKey is the key used by PermissionHashKey hash table.
    *
    * NOTE: It could be implementing nsIHashable but there is no reason to worry
    * with XPCOM interfaces while we don't need to.
    */
   class PermissionKey
   {
   public:
     PermissionKey(nsIPrincipal* aPrincipal);
     PermissionKey(const nsACString& aHost,
                   uint32_t aAppId,
                   bool aIsInBrowserElement)
       : mHost(aHost)
       , mAppId(aAppId)
       , mIsInBrowserElement(aIsInBrowserElement)
     {
     }
     bool operator==(const PermissionKey& aKey) const {
       return mHost.Equals(aKey.mHost) &&
              mAppId == aKey.mAppId &&
              mIsInBrowserElement == aKey.mIsInBrowserElement;
     }
     PLDHashNumber GetHashCode() const {
       nsAutoCString str;
       str.Assign(mHost);
       str.AppendInt(mAppId);
       str.AppendInt(static_cast<int32_t>(mIsInBrowserElement));
       return mozilla::HashString(str);
     }
     NS_INLINE_DECL_THREADSAFE_REFCOUNTING(PermissionKey)
     nsCString mHost;
     uint32_t  mAppId;
     bool      mIsInBrowserElement;
   private:
     // Default ctor shouldn't be used.
     PermissionKey() MOZ_DELETE;
     // Dtor shouldn't be used outside of the class.
     ~PermissionKey() {};
   };
   class PermissionHashKey : public nsRefPtrHashKey<PermissionKey>
   {
   public:
     PermissionHashKey(const PermissionKey* aPermissionKey)
       : nsRefPtrHashKey<PermissionKey>(aPermissionKey)
     {}
     PermissionHashKey(const PermissionHashKey& toCopy)
       : nsRefPtrHashKey<PermissionKey>(toCopy)
       , mPermissions(toCopy.mPermissions)
     {}
     bool KeyEquals(const PermissionKey* aKey) const
     {
       return *aKey == *GetKey();
     }
     static PLDHashNumber HashKey(const PermissionKey* aKey)
     {
       return aKey->GetHashCode();
     }
     // Force the hashtable to use the copy constructor when shuffling entries
     // around, otherwise the Auto part of our nsAutoTArray won't be happy!
     enum { ALLOW_MEMMOVE = false };
     inline nsTArray<PermissionEntry> & GetPermissions()
     {
       return mPermissions;
     }
     inline int32_t GetPermissionIndex(uint32_t aType) const
     {
       for (uint32_t i = 0; i < mPermissions.Length(); ++i)
         if (mPermissions[i].mType == aType)
           return i;
       return -1;
     }
     inline PermissionEntry GetPermission(uint32_t aType) const
     {
       for (uint32_t i = 0; i < mPermissions.Length(); ++i)
         if (mPermissions[i].mType == aType)
           return mPermissions[i];
       // unknown permission... return relevant data
       return PermissionEntry(-1, aType, nsIPermissionManager::UNKNOWN_ACTION,
                              nsIPermissionManager::EXPIRE_NEVER, 0);
     }
   private:
     nsAutoTArray<PermissionEntry, 1> mPermissions;
   };
   // nsISupports
   NS_DECL_ISUPPORTS
   NS_DECL_NSIPERMISSIONMANAGER
   NS_DECL_NSIOBSERVER
   nsPermissionManager();
   virtual ~nsPermissionManager();
   static nsIPermissionManager* GetXPCOMSingleton();
   nsresult Init();
   // enums for AddInternal()
   enum OperationType {
     eOperationNone,
     eOperationAdding,
     eOperationRemoving,
     eOperationChanging
   };
   enum DBOperationType {
     eNoDBOperation,
     eWriteToDB
   };
   enum NotifyOperationType {
     eDontNotify,
     eNotify
   };
   nsresult AddInternal(nsIPrincipal* aPrincipal,
                        const nsAFlatCString &aType,
                        uint32_t aPermission,
                        int64_t aID,
                        uint32_t aExpireType,
                        int64_t  aExpireTime,
                        NotifyOperationType aNotifyOperation,
                        DBOperationType aDBOperation);
   /**
    * Initialize the "webapp-uninstall" observing.
    * Will create a nsPermissionManager instance if needed.
    * That way, we can prevent have nsPermissionManager created at startup just
    * to be able to clear data when an application is uninstalled.
    */
   static void AppClearDataObserverInit();
 private:
   int32_t GetTypeIndex(const char *aTypeString,
                        bool        aAdd);
   PermissionHashKey* GetPermissionHashKey(const nsACString& aHost,
                                           uint32_t aAppId,
                                           bool aIsInBrowserElement,
                                           uint32_t          aType,
                                           bool              aExactHostMatch);
   nsresult CommonTestPermission(nsIPrincipal* aPrincipal,
                                 const char *aType,
                                 uint32_t   *aPermission,
                                 bool        aExactHostMatch,
                                 bool        aIncludingSession);
   nsresult InitDB(bool aRemoveFile);
   nsresult CreateTable();
   nsresult Import();
   nsresult Read();
   void     NotifyObserversWithPermission(const nsACString &aHost,
                                          uint32_t          aAppId,
                                          bool              aIsInBrowserElement,
                                          const nsCString  &aType,
                                          uint32_t          aPermission,
                                          uint32_t          aExpireType,
                                          int64_t           aExpireTime,
                                          const char16_t  *aData);
   void     NotifyObservers(nsIPermission *aPermission, const char16_t *aData);
   // Finalize all statements, close the DB and null it.
   // if aRebuildOnSuccess, reinitialize database
   void     CloseDB(bool aRebuildOnSuccess = false);
   nsresult RemoveAllInternal(bool aNotifyObservers);
   nsresult RemoveAllFromMemory();
   nsresult NormalizeToACE(nsCString &aHost);
   static void UpdateDB(OperationType aOp,
                        mozIStorageAsyncStatement* aStmt,
                        int64_t aID,
                        const nsACString& aHost,
                        const nsACString& aType,
                        uint32_t aPermission,
                        uint32_t aExpireType,
                        int64_t aExpireTime,
                        uint32_t aAppId,
                        bool aIsInBrowserElement);
   nsresult RemoveExpiredPermissionsForApp(uint32_t aAppId);
   /**
    * This struct has to be passed as an argument to GetPermissionsForApp.
    * |appId| and |browserOnly| have to be defined.
    * |permissions| will be filed with permissions that are related to the app.
    * If |browserOnly| is true, only permissions related to a browserElement will
    * be in |permissions|.
    */
   struct GetPermissionsForAppStruct {
     uint32_t                  appId;
     bool                      browserOnly;
     nsCOMArray<nsIPermission> permissions;
     GetPermissionsForAppStruct() MOZ_DELETE;
     GetPermissionsForAppStruct(uint32_t aAppId, bool aBrowserOnly)
       : appId(aAppId)
       , browserOnly(aBrowserOnly)
     {}
   };
   /**
    * This method will return the list of all permissions that are related to a
    * specific app.
    * @param arg has to be an instance of GetPermissionsForAppStruct.
    */
   static PLDHashOperator
   GetPermissionsForApp(PermissionHashKey* entry, void* arg);
   /**
    * This method restores an app's permissions when its session ends.
    */
   static PLDHashOperator
   RemoveExpiredPermissionsForAppEnumerator(PermissionHashKey* entry,
                                            void* nonused);
   nsCOMPtr<nsIObserverService> mObserverService;
   nsCOMPtr<nsIIDNService>      mIDNService;
   nsCOMPtr<mozIStorageConnection> mDBConn;
   nsCOMPtr<mozIStorageAsyncStatement> mStmtInsert;
   nsCOMPtr<mozIStorageAsyncStatement> mStmtDelete;
   nsCOMPtr<mozIStorageAsyncStatement> mStmtUpdate;
   nsTHashtable<PermissionHashKey> mPermissionTable;
   // a unique, monotonically increasing id used to identify each database entry
   int64_t                      mLargestID;
   // An array to store the strings identifying the different types.
   nsTArray<nsCString>          mTypeArray;
   // A list of struct for counting applications
   struct ApplicationCounter {
     uint32_t mAppId;
     uint32_t mCounter;
   };
   nsTArray<ApplicationCounter> mAppIdRefcounts;
   // Initially, |false|. Set to |true| once shutdown has started, to avoid
   // reopening the database.
   bool mIsShuttingDown;
   friend class DeleteFromMozHostListener;
   friend class CloseDatabaseListener;
 };
 // {4F6B5E00-0C36-11d5-A535-0010A401EB10}
 #define NS_PERMISSIONMANAGER_CID \
 { 0x4f6b5e00, 0xc36, 0x11d5, { 0xa5, 0x35, 0x0, 0x10, 0xa4, 0x1, 0xeb, 0x10 } }
 #endif /* nsPermissionManager_h__ */

The Tor Browser / annotate

extensions/cookie/nsPermissionManager.h@b8a032363ba2 (annotated)

extensions/cookie/nsPermissionManager.h