Bugzilla

    'sync'

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */

/* vim: set ts=8 sts=2 et sw=2 tw=80: */

/* 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/. */

#include "SyncManager.h"

#include "mozilla/dom/Promise.h"

#include "mozilla/dom/PromiseWorkerProxy.h"

#include "mozilla/dom/SyncManagerBinding.h"

#include "mozilla/ipc/BackgroundChild.h"

#include "mozilla/ipc/BackgroundUtils.h"

#include "mozilla/ipc/PBackgroundChild.h"

#include "mozilla/Preferences.h"

#include "nsIGlobalObject.h"

#include "WorkerPrivate.h"

namespace mozilla {

using namespace ipc;

namespace dom {

using namespace workers;

// SyncManager

// static

already_AddRefed<SyncManager>

SyncManager::CreateOnMainThread(nsIGlobalObject* aGlobal,

                                nsIPrincipal* aPrincipal,

                                ErrorResult& aRv)

{

  MOZ_ASSERT(aGlobal);

  MOZ_ASSERT(aPrincipal);

  MOZ_ASSERT(NS_IsMainThread());

  PrincipalInfo principalInfo;

  nsresult rv = PrincipalToPrincipalInfo(aPrincipal, &principalInfo);

  if (NS_WARN_IF(NS_FAILED(rv))) {

    aRv.Throw(rv);

    return nullptr;

  }

  RefPtr<SyncManager> ref = new SyncManager(aGlobal, principalInfo);

  return ref.forget();

}

// static

already_AddRefed<SyncManager>

SyncManager::CreateOnWorker(WorkerPrivate* aWorkerPrivate)

{

  MOZ_ASSERT(aWorkerPrivate);

  aWorkerPrivate->AssertIsOnWorkerThread();

  const PrincipalInfo& principalInfo = aWorkerPrivate->GetPrincipalInfo();

  RefPtr<SyncManager> ref = new SyncManager(nullptr, principalInfo);

  return ref.forget();

}

SyncManager::SyncManager(nsIGlobalObject* aGlobal,

                         const PrincipalInfo& aPrincipalInfo)

  : mGlobal(aGlobal)

  , mPrincipalInfo(new PrincipalInfo(aPrincipalInfo))

{}

SyncManager::~SyncManager()

{}

// Bindings methods.

JSObject*

SyncManager::WrapObject(JSContext* aCx, JS::Handle<JSObject*> aGivenProto)

{

  return SyncManagerBinding::Wrap(aCx, this, aGivenProto);

}

// static

bool

SyncManager::PrefEnabled(JSContext* aCx, JSObject* aObj)

{

  using mozilla::dom::workers::WorkerPrivate;

  using mozilla::dom::workers::GetWorkerPrivateFromContext;

  // If we are on the main thread, then check the pref directly.

  if (NS_IsMainThread()) {

    bool enabled = false;

    Preferences::GetBool("dom.background.sync.enabled", &enabled);

    return enabled;

  }

  // Otherwise check the pref via the worker private helper.

  WorkerPrivate* workerPrivate = GetWorkerPrivateFromContext(aCx);

  if (!workerPrivate) {

    return false;

  }

  return workerPrivate->BackgroundSyncEnabled();

}

// WebIDL interace methods.

already_AddRefed<Promise>

SyncManager::Register(const nsAString& aName, ErrorResult& aRv)

{

  RefPtr<Promise> p = Promise::Create(mGlobal, aRv);

  if (NS_WARN_IF(aRv.Failed())) {

    return nullptr;

  }

  return p.forget();

}

already_AddRefed<Promise>

SyncManager::GetTags(ErrorResult& aRv)

{

  RefPtr<Promise> p = Promise::Create(mGlobal, aRv);

  if (NS_WARN_IF(aRv.Failed())) {

    return nullptr;

  }

  return p.forget();

}

NS_IMPL_CYCLE_COLLECTION_WRAPPERCACHE(SyncManager, mGlobal)

NS_IMPL_CYCLE_COLLECTING_ADDREF(SyncManager)

NS_IMPL_CYCLE_COLLECTING_RELEASE(SyncManager)

NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION(SyncManager)

  NS_WRAPPERCACHE_INTERFACE_MAP_ENTRY

  NS_INTERFACE_MAP_ENTRY(nsISupports)

NS_INTERFACE_MAP_END

} // namespace dom

} // namespace mozilla

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */

/* vim: set ts=8 sts=2 et sw=2 tw=80: */

/* 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 mozilla_dom_SyncManager_h

#define mozilla_dom_SyncManager_h

#include "nsIPrincipal.h"

#include "nsWrapperCache.h"

#include "mozilla/AlreadyAddRefed.h"

#include "mozilla/ErrorResult.h"

#include "mozilla/dom/BindingDeclarations.h"

#include "nsCOMPtr.h"

#include "jsapi.h"

class nsIGlobalObject;

namespace mozilla {

namespace ipc {

  class PrincipalInfo;

} // namespace ipc

namespace dom {

namespace workers {

  class WorkerPrivate;

} // namespace workers

class Promise;

class SyncManager final : public nsISupports

                        , public nsWrapperCache

{

public:

  NS_DECL_CYCLE_COLLECTING_ISUPPORTS

  NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_CLASS(SyncManager)

  static already_AddRefed<SyncManager>

  CreateOnMainThread(nsIGlobalObject* aGlobal,

                     nsIPrincipal* aPrincipal,

                     ErrorResult& aRv);

  static already_AddRefed<SyncManager>

  CreateOnWorker(workers::WorkerPrivate* aWorkerPrivate);

  // Binding methods.

  nsIGlobalObject*

  GetParentObject() const

  {

    // Can be nullptr on workers.

    return mGlobal;

  }

  JSObject*

  WrapObject(JSContext* aCx, JS::Handle<JSObject*> aGivenProto) override;

  static bool PrefEnabled(JSContext* aCx, JSObject* aObj);

  // WebIDL interface methods.

  already_AddRefed<Promise>

  Register(const nsAString& aName, ErrorResult& aRv);

  already_AddRefed<Promise>

  GetTags(ErrorResult& aRv);

private:

  SyncManager(nsIGlobalObject* aGlobal,

              const mozilla::ipc::PrincipalInfo& aPrincipalInfo);

  ~SyncManager();

  nsCOMPtr<nsIGlobalObject> mGlobal;

  nsAutoPtr<mozilla::ipc::PrincipalInfo> mPrincipalInfo;

};

} // namespace dom

} // namespace mozilla

#endif // mozilla_dom_SyncManager_h

# vim: set filetype=python:

# 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/.

EXPORTS.mozilla.dom += [

    'SyncManager.h'

]

UNIFIED_SOURCES += [

    'SyncManager.cpp'

]

LOCAL_INCLUDES += [

    '/dom/workers'

]

include('/ipc/chromium/chromium-config.mozbuild')

FINAL_LIBRARY = 'xul'

    {name: "SyncManager", b2g: false},

// IMPORTANT: Do not change this list without review from a DOM peer!

/* -*- Mode: IDL; tab-width: 2; 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/.

*

* The origin of this IDL file is

* https://wicg.github.io/BackgroundSync/spec/

*/

[Exposed=(Window,Worker),

 Func="mozilla::dom::SyncManager::PrefEnabled"]

interface SyncManager {

  [Throws]

  Promise<void> register(DOMString tag);

  [Throws]

  Promise<sequence<DOMString>> getTags();

};

    'SyncManager.webidl',

WORKER_SIMPLE_PREF("dom.background.sync.enabled", BackgroundSyncEnabled, BACKGROUND_SYNC_ENABLED)