Initial commit

common/updates.h

@@ -0,0 +1,144 @@
+/* ScummVM - Graphic Adventure Engine
+ *
+ * ScummVM is the legal property of its developers, whose names
+ * are too numerous to list here. Please refer to the COPYRIGHT
+ * file distributed with this source distribution.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+#ifndef COMMON_UPDATES_H
+#define COMMON_UPDATES_H
+
+#if defined(USE_UPDATES)
+
+namespace Common {
+
+/**
+ * @defgroup common_update Update Manager
+ * @ingroup common
+ *
+ * @brief The UpdateManager module allows for automatic update checking.
+ *
+ * @{
+ */
+
+/**
+ * The UpdateManager allows configuring of the automatic update checking
+ * for systems that support it:
+ *  - using Sparkle on macOS
+ *  - using WinSparkle on Windows
+ *
+ * Most of the update checking is completely automated and this class only
+ * gives access to basic settings. It is mostly used by the GUI to set
+ * widgets state on the update page and for manually checking for updates
+ *
+ */
+class UpdateManager {
+public:
+	enum UpdateState {
+		kUpdateStateDisabled     = 0,
+		kUpdateStateEnabled      = 1,
+		kUpdateStateNotSupported = 2
+	};
+
+	enum UpdateInterval {
+		kUpdateIntervalNotSupported = 0,
+		kUpdateIntervalOneDay       = 86400,
+		kUpdateIntervalOneWeek      = 604800,
+		kUpdateIntervalOneMonth     = 2628000 // average seconds per month (60*60*24*365)/12
+	};
+
+	UpdateManager() {}
+	virtual ~UpdateManager() {}
+
+	/**
+	 * Checks manually if an update is available, showing progress UI to the user.
+	 *
+	 * By default, update checks are done silently on start.
+	 * This allows to manually start an update check.
+	 */
+	virtual void checkForUpdates() {}
+
+	/**
+	 * Sets the automatic update checking state
+	 *
+	 * @param  state    The state.
+	 */
+	virtual void setAutomaticallyChecksForUpdates(UpdateState state) {}
+
+	/**
+	 * Gets the automatic update checking state
+	 *
+	 * @return  kUpdateStateDisabled     if automatic update checking is disabled,
+	 *          kUpdateStateEnabled      if automatic update checking is enabled,
+	 *          kUpdateStateNotSupported if automatic update checking is not available
+	 */
+	virtual UpdateState getAutomaticallyChecksForUpdates() { return kUpdateStateNotSupported; }
+
+	/**
+	 * Sets the update checking interval.
+	 *
+	 * @param  interval    The interval.
+	 */
+	virtual void setUpdateCheckInterval(int interval) {}
+
+	/**
+	 * Gets the update check interval.
+	 *
+	 * @return  the update check interval.
+	 */
+	virtual int getUpdateCheckInterval() { return kUpdateIntervalNotSupported; }
+
+	/**
+	 * Gets last update check time
+	 *
+	 * @param  t    TimeDate struct to fill out
+	 * @return flag indicating success
+	 */
+	virtual bool getLastUpdateCheckTimeAndDate(TimeDate &t) { return false; }
+
+	/**
+	 * Returns list of supported uptate intervals.
+	 * Ending with '-1' which is not acceptable value.
+	 *
+	 * @return  list of integer values representing update intervals in seconds.
+	 */
+	static const int *getUpdateIntervals();
+
+	/**
+	 * Returns string representation of a given interval.
+	 *
+	 * @param  interval    The interval.
+	 * @return Localized string of given interval as a U32String.
+	 */
+	static Common::U32String updateIntervalToString(int interval);
+
+	/**
+	 * Rounds up the given interval to acceptable value.
+	 *
+	 * @param  interval    The interval.
+	 * @return  rounded up interval
+	 */
+	static int normalizeInterval(int interval);
+};
+
+/** @} */
+
+} // End of namespace Common
+
+#endif
+
+#endif // COMMON_UPDATES_H