/* -*- 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_workers_serviceworkerupdatejob_h
#define mozilla_dom_workers_serviceworkerupdatejob_h

#include "ServiceWorkerJob.h"

namespace mozilla {
namespace dom {
namespace workers {

class ServiceWorkerManager;

// A job class that performs the Update and Install algorithms from the
// service worker spec.  This class is designed to be inherited and customized
// as a different job type.  This is necessary because the register job
// performs largely the same operations as the update job, but has a few
// different starting steps.
class ServiceWorkerUpdateJob : public ServiceWorkerJob
{
public:
  // Construct an update job to be used only for updates.
  ServiceWorkerUpdateJob(nsIPrincipal* aPrincipal,
                         const nsACString& aScope,
                         const nsACString& aScriptSpec,
                         nsILoadGroup* aLoadGroup,
                         nsLoadFlags aLoadFlags);

  already_AddRefed<ServiceWorkerRegistrationInfo>
  GetRegistration() const;

protected:
  // Construct an update job that is overriden as another job type.
  ServiceWorkerUpdateJob(Type aType,
                         nsIPrincipal* aPrincipal,
                         const nsACString& aScope,
                         const nsACString& aScriptSpec,
                         nsILoadGroup* aLoadGroup,
                         nsLoadFlags aLoadFlags);

  virtual ~ServiceWorkerUpdateJob();

  // FailUpdateJob() must be called if an update job needs Finish() with
  // an error.
  void
  FailUpdateJob(ErrorResult& aRv);

  void
  FailUpdateJob(nsresult aRv);

  // The entry point when the update job is being used directly.  Job
  // types overriding this class should override this method to
  // customize behavior.
  virtual void
  AsyncExecute() override;

  // Set the registration to be operated on by Update() or to be immediately
  // returned as a result of the job.  This must be called before Update().
  void
  SetRegistration(ServiceWorkerRegistrationInfo* aRegistration);

  // Execute the bulk of the update job logic using the registration defined
  // by a previous SetRegistration() call.  This can be called by the overriden
  // AsyncExecute() to complete the job.  The Update() method will always call
  // Finish().  This method corresponds to the spec Update algorithm.
  void
  Update();

  nsLoadFlags
  GetLoadFlags() const;

  void
  SetLoadFlags(nsLoadFlags aLoadFlags);

private:
  class CompareCallback;
  class ContinueUpdateRunnable;
  class ContinueInstallRunnable;

  // Utility method called after a script is loaded and compared to
  // our current cached script.
  void
  ComparisonResult(nsresult aStatus,
                   bool aInCacheAndEqual,
                   const nsAString& aNewCacheName,
                   const nsACString& aMaxScope);

  // Utility method called after evaluating the worker script.
  void
  ContinueUpdateAfterScriptEval(bool aScriptEvaluationResult);

  // Utility method corresponding to the spec Install algorithm.
  void
  Install(ServiceWorkerManager* aSWM);

  // Utility method called after the install event is handled.
  void
  ContinueAfterInstallEvent(bool aInstallEventSuccess);

  nsCOMPtr<nsILoadGroup> mLoadGroup;
  nsLoadFlags mLoadFlags;

  RefPtr<ServiceWorkerRegistrationInfo> mRegistration;
};

} // namespace workers
} // namespace dom
} // namespace mozilla

#endif // mozilla_dom_workers_serviceworkerupdatejob_h