dom/serviceworkers/ServiceWorkerRegistrar.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #ifndef mozilla_dom_ServiceWorkerRegistrar_h
   8 #define mozilla_dom_ServiceWorkerRegistrar_h
   9
  10 #include "mozilla/Monitor.h"
  11 #include "mozilla/Telemetry.h"
  12 #include "nsClassHashtable.h"
  13 #include "nsIAsyncShutdown.h"
  14 #include "nsIObserver.h"
  15 #include "nsCOMPtr.h"
  16 #include "nsString.h"
  17 #include "nsTArray.h"
  18
  19 #define SERVICEWORKERREGISTRAR_FILE u"serviceworker.txt"
  20 #define SERVICEWORKERREGISTRAR_VERSION "9"
  21 #define SERVICEWORKERREGISTRAR_TERMINATOR "#"
  22 #define SERVICEWORKERREGISTRAR_TRUE "true"
  23 #define SERVICEWORKERREGISTRAR_FALSE "false"
  24
  25 class nsIFile;
  26
  27 namespace mozilla {
  28
  29 namespace ipc {
  30 class PrincipalInfo;
  31 }  // namespace ipc
  32
  33 namespace dom {
  34
  35 class ServiceWorkerRegistrationData;
  36 }
  37 }  // namespace mozilla
  38
  39 namespace mozilla::dom {
  40
  41 class ServiceWorkerRegistrar : public nsIObserver,
  42                                public nsIAsyncShutdownBlocker {
  43   friend class ServiceWorkerRegistrarSaveDataRunnable;
  44
  45  public:
  46   NS_DECL_THREADSAFE_ISUPPORTS
  47   NS_DECL_NSIOBSERVER
  48   NS_DECL_NSIASYNCSHUTDOWNBLOCKER
  49
  50   static void Initialize();
  51
  52   void Shutdown();
  53
  54   void DataSaved(uint32_t aFileGeneration);
  55
  56   static already_AddRefed<ServiceWorkerRegistrar> Get();
  57
  58   void GetRegistrations(nsTArray<ServiceWorkerRegistrationData>& aValues);
  59
  60   void RegisterServiceWorker(const ServiceWorkerRegistrationData& aData);
  61   void UnregisterServiceWorker(
  62       const mozilla::ipc::PrincipalInfo& aPrincipalInfo,
  63       const nsACString& aScope);
  64   void RemoveAll();
  65
  66   bool ReloadDataForTest();
  67
  68  protected:
  69   // These methods are protected because we test this class using gTest
  70   // subclassing it.
  71   void LoadData();
  72   nsresult SaveData(const nsTArray<ServiceWorkerRegistrationData>& aData);
  73
  74   nsresult ReadData();
  75   nsresult WriteData(const nsTArray<ServiceWorkerRegistrationData>& aData);
  76   void DeleteData();
  77
  78   void RegisterServiceWorkerInternal(const ServiceWorkerRegistrationData& aData)
  79       MOZ_REQUIRES(mMonitor);
  80
  81   ServiceWorkerRegistrar();
  82   virtual ~ServiceWorkerRegistrar();
  83
  84  private:
  85   void ProfileStarted();
  86   void ProfileStopped();
  87
  88   void MaybeScheduleSaveData();
  89   void ShutdownCompleted();
  90   void MaybeScheduleShutdownCompleted();
  91
  92   uint32_t GetNextGeneration();
  93   void MaybeResetGeneration();
  94
  95   nsCOMPtr<nsIAsyncShutdownClient> GetShutdownPhase() const;
  96
  97   bool IsSupportedVersion(const nsACString& aVersion) const;
  98
  99  protected:
 100   mozilla::Monitor mMonitor;
 101
 102   // protected by mMonitor.
 103   nsCOMPtr<nsIFile> mProfileDir MOZ_GUARDED_BY(mMonitor);
 104   // Read on mainthread, modified on background thread EXCEPT for
 105   // ReloadDataForTest() AND for gtest, which modifies this on MainThread.
 106   nsTArray<ServiceWorkerRegistrationData> mData MOZ_GUARDED_BY(mMonitor);
 107   bool mDataLoaded MOZ_GUARDED_BY(mMonitor);
 108
 109   // PBackground thread only
 110   uint32_t mDataGeneration;
 111   uint32_t mFileGeneration;
 112   uint32_t mRetryCount;
 113   bool mShuttingDown;
 114   bool mSaveDataRunnableDispatched;
 115 };
 116
 117 }  // namespace mozilla::dom
 118
 119 #endif  // mozilla_dom_ServiceWorkerRegistrar_h