MACOSX: Add Sparkle support

8 files changed, 274 insertions, 6 deletions

diff --git a/backends/modular-backend.cpp b/backends/modular-backend.cpp
index 525170d685..db9d816cba 100644
--- a/backends/modular-backend.cpp
+++ b/backends/modular-backend.cpp
@@ -26,6 +26,7 @@
 
 #include "backends/graphics/graphics.h"
 #include "backends/mutex/mutex.h"
+#include "common/updates.h"
 
 #include "audio/mixer.h"
 #include "graphics/pixelformat.h"
@@ -34,7 +35,8 @@ ModularBackend::ModularBackend()
 	:
 	_mutexManager(0),
 	_graphicsManager(0),
-	_mixer(0) {
+	_mixer(0),
+	_updateManager(0) {
 
 }
 
@@ -43,6 +45,8 @@ ModularBackend::~ModularBackend() {
 	_graphicsManager = 0;
 	delete _mixer;
 	_mixer = 0;
+	delete _updateManager;
+	_updateManager = 0;
 	delete _mutexManager;
 	_mutexManager = 0;
 }
diff --git a/backends/modular-backend.h b/backends/modular-backend.h
index b864da0df5..be1d328c1f 100644
--- a/backends/modular-backend.h
+++ b/backends/modular-backend.h
@@ -24,6 +24,7 @@
 #define BACKENDS_MODULAR_BACKEND_H
 
 #include "backends/base-backend.h"
+#include "common/updates.h"
 
 class GraphicsManager;
 class MutexManager;
@@ -141,9 +142,10 @@ protected:
 	/** @name Managers variables */
 	//@{
 
-	MutexManager *_mutexManager;
-	GraphicsManager *_graphicsManager;
-	Audio::Mixer *_mixer;
+	MutexManager            *_mutexManager;
+	GraphicsManager         *_graphicsManager;
+	Audio::Mixer            *_mixer;
+	Common::UpdateManager   *_updateManager;
 
 	//@}
 };
diff --git a/backends/module.mk b/backends/module.mk
index 63774cc4d0..d8b423a67a 100644
--- a/backends/module.mk
+++ b/backends/module.mk
@@ -15,7 +15,8 @@ MODULE_OBJS := \
 	midi/timidity.o \
 	saves/savefile.o \
 	saves/default/default-saves.o \
-	timer/default/default-timer.o
+	timer/default/default-timer.o \
+	updates/sparkle-updates.o
 
 
 ifdef USE_ELF_LOADER
@@ -87,7 +88,8 @@ endif
 ifdef MACOSX
 MODULE_OBJS += \
 	midi/coreaudio.o \
-	midi/coremidi.o
+	midi/coremidi.o \
+	updates/macosx/macosx-updates.o
 endif
 
 ifdef WIN32
diff --git a/backends/platform/sdl/macosx/macosx.cpp b/backends/platform/sdl/macosx/macosx.cpp
index ddfc99570a..39fd4237ec 100644
--- a/backends/platform/sdl/macosx/macosx.cpp
+++ b/backends/platform/sdl/macosx/macosx.cpp
@@ -30,6 +30,7 @@
 #include "backends/platform/sdl/macosx/macosx.h"
 #include "backends/mixer/doublebuffersdl/doublebuffersdl-mixer.h"
 #include "backends/platform/sdl/macosx/appmenu_osx.h"
+#include "backends/updates/macosx/macosx-updates.h"
 
 #include "common/archive.h"
 #include "common/config-manager.h"
@@ -63,6 +64,11 @@ void OSystem_MacOSX::initBackend() {
 	// Replace the SDL generated menu items with our own translated ones on Mac OS X
 	replaceApplicationMenuItems();
 
+#if defined(USE_SPARKLE)
+	// Initialize updates manager
+	_updateManager = new MacOSXUpdateManager();
+#endif
+
 	// Invoke parent implementation of this method
 	OSystem_POSIX::initBackend();
 }
diff --git a/backends/updates/macosx/macosx-updates.h b/backends/updates/macosx/macosx-updates.h
new file mode 100644
index 0000000000..1fe0e4bb75
--- /dev/null
+++ b/backends/updates/macosx/macosx-updates.h
@@ -0,0 +1,46 @@
+/* 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 2
+ * 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, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ *
+ */
+
+#ifndef BACKENDS_UPDATES_MACOSX_H
+#define BACKENDS_UPDATES_MACOSX_H
+
+#include "backends/updates/sparkle-updates.h"
+
+#if defined(MACOSX) && defined(USE_SPARKLE)
+
+class MacOSXUpdateManager : public SparkleUpdateManager {
+public:
+	MacOSXUpdateManager();
+	virtual ~MacOSXUpdateManager();
+
+	virtual void checkForUpdates();
+
+	virtual void setAutomaticallyChecksForUpdates(UpdateState state);
+	virtual UpdateState getAutomaticallyChecksForUpdates();
+
+	virtual void setUpdateCheckInterval(UpdateInterval interval);
+	virtual UpdateInterval getUpdateCheckInterval();
+};
+
+#endif
+
+#endif // BACKENDS_UPDATES_MACOSX_H
diff --git a/backends/updates/macosx/macosx-updates.mm b/backends/updates/macosx/macosx-updates.mm
new file mode 100644
index 0000000000..8210b38400
--- /dev/null
+++ b/backends/updates/macosx/macosx-updates.mm
@@ -0,0 +1,115 @@
+/* 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 2
+ * 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, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ *
+ */
+
+#include "backends/updates/sparkle-updates.h"
+
+#if defined(MACOSX) && defined(USE_SPARKLE)
+
+#include "backends/updates/macosx/macosx-updates.h"
+#include "common/translation.h"
+
+#include <Cocoa/Cocoa.h>
+#include <Sparkle/Sparkle.h>
+
+SUUpdater *sparkleUpdater;
+
+MacOSXUpdateManager::MacOSXUpdateManager() {
+	NSMenuItem *menuItem = [[NSApp mainMenu] itemAtIndex:0];
+	NSMenu *applicationMenu = [menuItem submenu];
+
+	// Init Sparkle
+	sparkleUpdater = [SUUpdater sharedUpdater];
+
+	// Set appcast URL
+	[sparkleUpdater setFeedURL:[NSURL URLWithString:[NSString stringWithCString:getAppcastUrl().c_str()]]];
+
+	// Get current encoding
+	NSStringEncoding *stringEncoding = CFStringConvertEncodingToNSStringEncoding(CFStringConvertIANACharSetNameToEncoding((CFStringRef)[NSString stringWithCString:(TransMan.getCurrentCharset()).c_str() encoding:NSASCIIStringEncoding]));
+
+	// Add "Check for Updates..." menu item
+	NSMenuItem *updateMenuItem = [applicationMenu insertItemWithTitle:[NSString stringWithCString:_("Check for Updates...") encoding:stringEncoding] action:@selector(checkForUpdates:) keyEquivalent:@"" atIndex:1];
+
+	// Set the target of the new menu item
+	[updateMenuItem setTarget:sparkleUpdater];
+
+	// Finally give up our references to the objects
+	[menuItem release];
+
+	// Enable automatic update checking once a day (alternatively use
+	// checkForUpdates() here to check for updates on every startup)
+	// TODO: Should be removed when an update settings gui is implemented
+	setAutomaticallyChecksForUpdates(kUpdateStateEnabled);
+	setUpdateCheckInterval(kUpdateIntervalOneDay);
+}
+
+MacOSXUpdateManager::~MacOSXUpdateManager() {
+	[sparkleUpdater release];
+}
+
+void MacOSXUpdateManager::checkForUpdates() {
+	[sparkleUpdater checkForUpdatesInBackground];
+}
+
+void MacOSXUpdateManager::setAutomaticallyChecksForUpdates(UpdateManager::UpdateState state) {
+	if (state == kUpdateStateNotSupported)
+		return;
+
+	[sparkleUpdater setAutomaticallyChecksForUpdates:(state == kUpdateStateEnabled ? YES : NO)];
+}
+
+Common::UpdateManager::UpdateState MacOSXUpdateManager::getAutomaticallyChecksForUpdates() {
+	if ([sparkleUpdater automaticallyChecksForUpdates])
+		return kUpdateStateEnabled;
+	else
+		return kUpdateStateDisabled;
+}
+
+void MacOSXUpdateManager::setUpdateCheckInterval(UpdateInterval interval) {
+	if (interval == kUpdateIntervalNotSupported)
+		return;
+
+	[sparkleUpdater setUpdateCheckInterval:(NSTimeInterval)interval];
+}
+
+Common::UpdateManager::UpdateInterval MacOSXUpdateManager::getUpdateCheckInterval() {
+	// This is kind of a hack but necessary, as the value stored by Sparkle
+	// might have been changed outside of ScummVM (in which case we return the
+	// default interval of one day)
+	switch ((UpdateInterval)[sparkleUpdater updateCheckInterval]) {
+		default:
+			break;
+
+		case kUpdateIntervalOneDay:
+			return kUpdateIntervalOneDay;
+
+		case kUpdateIntervalOneWeek:
+			return kUpdateIntervalOneWeek;
+
+		case kUpdateIntervalOneMonth:
+			return kUpdateIntervalOneMonth;
+	}
+
+	// Return the default value (one day)
+	return kUpdateIntervalOneDay;
+}
+
+#endif
diff --git a/backends/updates/sparkle-updates.cpp b/backends/updates/sparkle-updates.cpp
new file mode 100644
index 0000000000..f146237a98
--- /dev/null
+++ b/backends/updates/sparkle-updates.cpp
@@ -0,0 +1,45 @@
+/* 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 2
+ * 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, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ *
+ */
+
+#include "backends/updates/sparkle-updates.h"
+
+#if defined(USE_SPARKLE)
+
+// TODO replace by proper URL
+#if defined(MACOSX)
+	#define APPCAST_BASE_URL "http://www.scummvm.org/appcasts/macosx/"
+#elif defined(WIN32)
+	#define APPCAST_BASE_URL "http://www.scummvm.org/appcasts/win32/"
+#else
+	#error "Please define APPCAST_BASE_URL for your platform!"
+#endif
+
+
+Common::String SparkleUpdateManager::getAppcastUrl() {
+#ifdef RELEASE_BUILD
+	return APPCAST_BASE_URL "release.xml";
+#else
+	return APPCAST_BASE_URL "beta.xml";
+#endif
+}
+
+#endif
diff --git a/backends/updates/sparkle-updates.h b/backends/updates/sparkle-updates.h
new file mode 100644
index 0000000000..26f170db2e
--- /dev/null
+++ b/backends/updates/sparkle-updates.h
@@ -0,0 +1,48 @@
+/* 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 2
+ * 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, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ *
+ */
+
+#ifndef BACKENDS_UPDATES_SPARKLE_UPDATE_H
+#define BACKENDS_UPDATES_SPARKLE_UPDATE_H
+
+#include "common/scummsys.h"
+#include "common/str.h"
+#include "common/updates.h"
+
+#if defined(USE_SPARKLE)
+
+class SparkleUpdateManager : public Common::UpdateManager {
+public:
+	/**
+	 * Gets the appcast url.
+	 *
+	 * Beta/RC versions and releases might have a different appcast url.
+	 * This function takes care of checking which version of ScummVM is running
+	 * and return the url to the proper appcast.
+	 *
+	 * @return the appcast url.
+	 */
+	Common::String getAppcastUrl();
+};
+
+#endif
+
+#endif // BACKENDS_UPDATES_SPARKLE_UPDATE_H