Adding upstream version 124.0.1.upstream/124.0.1

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 124 insertions, 0 deletions

diff --git a/toolkit/components/backgroundtasks/BackgroundTasks.h b/toolkit/components/backgroundtasks/BackgroundTasks.h
new file mode 100644
index 0000000000..030a209c79
--- /dev/null
+++ b/toolkit/components/backgroundtasks/BackgroundTasks.h
@@ -0,0 +1,124 @@
+/* -*- 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 mozilla_BackgroundTasks_h
+#define mozilla_BackgroundTasks_h
+
+#include "nsCOMPtr.h"
+#include "nsIBackgroundTasks.h"
+#include "nsISupports.h"
+#include "nsString.h"
+
+#include "mozilla/Logging.h"
+#include "mozilla/Maybe.h"
+#include "mozilla/StaticPtr.h"
+
+class nsICommandLine;
+class nsIFile;
+
+namespace mozilla {
+
+class BackgroundTasks final : public nsIBackgroundTasks {
+ public:
+  NS_DECL_ISUPPORTS
+  NS_DECL_NSIBACKGROUNDTASKS
+
+ public:
+  explicit BackgroundTasks(Maybe<nsCString> aBackgroundTask);
+
+  static void Init(Maybe<nsCString> aBackgroundTask);
+
+  static void Shutdown();
+
+  /**
+   * Return a raw pointer to the singleton instance.  Use this accessor in C++
+   * code that just wants to call a method on the instance, but does not need to
+   * hold a reference.
+   */
+  static BackgroundTasks* GetSingleton();
+
+  /**
+   * Return an addRef'd pointer to the singleton instance. This is used by the
+   * XPCOM constructor that exists to support usage from JS.
+   */
+  static already_AddRefed<BackgroundTasks> GetSingletonAddRefed();
+
+  static Maybe<nsCString> GetBackgroundTasks();
+
+  static bool IsBackgroundTaskMode();
+
+  static nsresult CreateEphemeralProfileDirectory(
+      nsIFile* aRootDir, const nsCString& aProfilePrefix, nsIFile** aFile);
+
+  static nsresult CreateNonEphemeralProfileDirectory(
+      nsIFile* aRootDir, const nsCString& aProfilePrefix, nsIFile** aFile);
+
+  static bool IsEphemeralProfile();
+
+  static nsresult RunBackgroundTask(nsICommandLine* aCmdLine);
+
+  /**
+   * Whether the given task name should process updates.  Most tasks should not
+   * process updates to avoid Firefox being updated unexpectedly.
+   *
+   * At the time of writing, we only process updates for the `backgroundupdate`
+   * task and the test-only `shouldprocessupdates` task.
+   */
+  static bool IsUpdatingTaskName(const nsCString& aName);
+
+  /**
+   * Whether the given task name should use a temporary ephemeral
+   * profile.  Most tasks should use a temporary ephemeral profile to
+   * allow concurrent task invocation and to simplify reasoning.
+   *
+   * At the time of writing, we use temporary ephemeral profiles for all tasks
+   * save the `backgroundupdate` task and the test-only `notephemeralprofile`
+   * task.
+   */
+  static bool IsEphemeralProfileTaskName(const nsCString& aName);
+
+  /**
+   * Whether the given task name should produce no output.  This is achieved by
+   * redirecting stdout and stderr to /dev/null (or, on Windows, nul:).
+   * profile.  Most tasks should produce output.
+   *
+   * At the time of writing, we produce no output for the `pingsender` task and
+   * the test-only `no_output` task.
+   */
+  static bool IsNoOutputTaskName(const nsCString& aName);
+
+  /**
+   * Get the installation-specific profile prefix for the current task name and
+   * the given install hash.
+   */
+  static nsCString GetProfilePrefix(const nsCString& aInstallHash);
+
+ protected:
+  static StaticRefPtr<BackgroundTasks> sSingleton;
+  static LazyLogModule sBackgroundTasksLog;
+
+  Maybe<nsCString> mBackgroundTask;
+  bool mIsEphemeralProfile;
+  nsCOMPtr<nsIFile> mProfD;
+
+  nsresult CreateEphemeralProfileDirectoryImpl(nsIFile* aRootDir,
+                                               const nsCString& aProfilePrefix,
+                                               nsIFile** aFile);
+
+  nsresult CreateNonEphemeralProfileDirectoryImpl(
+      nsIFile* aRootDir, const nsCString& aProfilePrefix, nsIFile** aFile);
+  /*
+   * Iterates children of `aRoot` and removes unlocked profiles matching
+   * `aPrefix`.
+   */
+  static nsresult RemoveStaleEphemeralProfileDirectories(
+      nsIFile* const aRoot, const nsCString& aPrefix);
+
+  virtual ~BackgroundTasks() = default;
+};
+
+}  // namespace mozilla
+
+#endif  // mozilla_BackgroundTasks_h