ultimatepp/bazaar/Updater/Updater.cpp
micio cc6cfb49fc Bazaar/Updater : removed obsoleted Web package dependencies
git-svn-id: svn://ultimatepp.org/upp/trunk@6176 f0d560ea-af0d-0410-9eb7-867de7ffcac7
2013-07-08 11:14:48 +00:00

831 lines
20 KiB
C++

#include "Updater.h"
#include <Draw/Draw.h>
#include <SysExecGui/SysExecGui.h>
#define IMAGECLASS UpdaterImg
#define IMAGEFILE <Updater/Updater.iml>
#include <Draw/iml.h>
#define TFILE <Updater/Updater.t>
#include <Core/t.h>
NAMESPACE_UPP
// gets platform root folder
String Updater::GetPlatformRoot(void)
{
#if defined(WIN64)
return serverRoot + "/WINDOWS64/";
#elif defined(WIN32)
return serverRoot + "/WINDOWS32/";
#elif defined(PLATFORM_POSIX)
#ifdef __x86_64
return serverRoot + "/LINUX64/";
#else
return serverRoot + "/LINUX32/";
#endif
#else
#error "PLATFORM NOT SUPPORTED"
#endif
}
///////////////////////////////////////////////////////////////////////////////////////
// constructor
Updater::Updater()
{
// defaults to web server mode
isWebServer = true;
// fetches and stores environment, we need to change it later
environment <<= Environment();
// accepts development versions by default
acceptDevelVersions = true;
// gets state variable, if not present assume starting in normal mode
String stateStr;
if(environment.Find("UPDATER_STATE") < 0)
state = NormalRun;
else
{
stateStr = environment.Get("UPDATER_STATE");
if(stateStr == "INSIDEUPDATER")
state = InsideUpdater;
else if(stateStr == "UNINSTALLFAILED")
state = UninstallFailed;
else if(stateStr == "INSTALLFAILED")
state = InstallFailed;
else if(stateStr == "UPDATEFAILED")
state = UpdateFailed;
else if(stateStr == "UNINSTALLSUCCEEDED")
state = UninstallSucceeded;
else if(stateStr == "INSTALLSUCCEEDED")
state = InstallSucceeded;
else if(stateStr == "UPDATESUCCEEDED")
state = UpdateSucceeded;
else
NEVER();
}
// gets user name
if(state != InsideUpdater)
user = GetUserName();
else if(environment.Find("UPDATER_USER") < 0)
user = "unknown";
else
user = environment.Get("UPDATER_USER");
// get application name -- either from GetExeTitle() if in normal mode
// or from environment if in superuser mode
if(state != InsideUpdater && state != UninstallSucceeded)
appName = GetExeTitle();
else if(environment.Find("UPDATER_APPNAME") >= 0)
appName = environment.Get("UPDATER_APPNAME");
else
appName = GetExeTitle(); // fallout -- should NEVER get here
// setup appName depending fields
SetAppName(appName);
// sets default confirm for install and uninstall
confirmInstall = true;
confirmUninstall = true;
// no desktop icon installation by default
desktopIcon = false;
// setup default user choices on errors
installBehaviour = AbortExecution;
noInstallBehaviour = AbortExecution;
updateBehaviour = AskUser;
}
// progress callback
void Updater::doProgress(void)
{
if(http.InProgress())
{
if(!progress.IsOpen())
{
progress.SetText(t_("Downloading application.... please wait"));
progress.Set(0, 0);
progress.Create();
}
if(progress.GetTotal() == 0 && http.GetContentLength() != 0)
progress.Set(0, http.GetContentLength() / 4096);
else
progress.SetPos(progress.GetPos() + 1);
}
else
{
if(progress.IsOpen())
progress.Close();
}
}
// sets applicaton name (defaults with current executable title if not used)
// allows easy separation of installer from main application code
// if you want to deploy a small installer
Updater &Updater::SetAppName(String const &_appName)
{
appName = _appName;
// gets app's user config path
#ifdef PLATFORM_POSIX
userConfigPath = AppendFileName("/home", user + "/." + appName);
#else
userConfigPath = AppendFileName(GetAppDataFolder(), appName);
#endif
// gets app's system config path
#ifdef PLATFORM_POSIX
systemConfigPath = AppendFileName("/usr/share", appName);
#else
systemConfigPath = AppendFileName(GetProgramsFolder(), appName);
#endif
// checks wether app is already installed and gather its version
installedVersion.Clear();
#ifdef PLATFORM_POSIX
appInstalled = FileExists(AppendFileName(GetProgramsFolder(), appName));
#else
appInstalled = FileExists(AppendFileName(GetProgramsFolder(), appName + "/" + appName + ".exe"));
#endif
appInstalled &= FileExists(AppendFileName(systemConfigPath, "version"));
String verStr;
if(appInstalled)
{
verStr = LoadFile(AppendFileName(systemConfigPath, "version"));
if(verStr != "")
installedVersion = verStr;
}
return *this;
}
///////////////////////////////////////////////////////////////////////////////////////
// installer/updater subfunctions
// setup environment for failing update/install
void Updater::FailUpdate()
{
switch(updaterOp)
{
case Install:
environment.Add("UPDATER_STATE", "INSTALLFAILED");
break;
case Uninstall:
environment.Add("UPDATER_APPNAME", appName);
environment.Add("UPDATER_STATE", "UNINSTALLFAILED");
break;
case Update:
environment.Add("UPDATER_STATE", "UPDATEFAILED");
break;
default:
NEVER();
}
}
// setup environment for succeeding update/install
void Updater::SucceedUpdate()
{
switch(updaterOp)
{
case Install:
environment.Add("UPDATER_STATE", "INSTALLSUCCEEDED");
break;
case Uninstall:
environment.Add("UPDATER_APPNAME", appName);
environment.Add("UPDATER_STATE", "UNINSTALLSUCCEEDED");
break;
case Update:
environment.Add("UPDATER_STATE", "UPDATESUCCEEDED");
break;
default:
NEVER();
}
}
// main updater proc inside normal mode
// prepares environment, copy app in temporary folder
// and restarts it in superuser mode
// returns true if app must continue execution, false otherwise
bool Updater::START_Updater(String const &operation)
{
// prepare environment for updating
environment.Add("UPDATER_USER", user);
environment.Add("UPDATER_OP", operation);
environment.Add("UPDATER_STATE", "INSIDEUPDATER");
environment.Add("UPDATER_APPNAME", appName);
environment.Add("UPDATER_EXEPATH", GetExeFilePath());
if(CommandLine().GetCount() && CommandLine()[0] != "--UNINSTALL")
{
String s;
for(int i = 0; i < CommandLine().GetCount(); i++)
s += CommandLine()[i] + " ";
s = s.Left(s.GetCount() - 1);
environment.Add("UPDATER_CMDLINE", s);
}
// gets current executable path
String exePath = GetExeFilePath();
// creates a temporary filename and copies itself
// in temporary folder
String tempName = GetTempFileName();
#ifdef PLATFORM_WIN32
tempName += ".exe";
#endif
if(!FileCopy(exePath, tempName))
return true;
#ifdef PLATFORM_POSIX
// for posix, change temp file permission
// allowing its execution and executes it as a superuser
if(chmod(~tempName, 0755) != 0)
return true;
#endif
// executes the file asking for password
bool res = !SysStartAdmin(tempName, "", environment);
return res;
}
// uninstall app
// returns true if app must continue execution, false otherwise
bool Updater::START_Uninstall(void)
{
if(confirmUninstall && !PromptYesNo(Format(t_("This will remove '%s' application&Continue ?"), appName)))
{
state = UninstallAborted;
return true;
}
if(START_Updater("UNINSTALL"))
{
state = UninstallFailed;
return true;
}
return false;
}
// install app
// returns true if app must continue execution, false otherwise
bool Updater::START_Install(void)
{
if(confirmInstall && !PromptYesNo(Format(t_("Install '%s' application?"), appName)))
{
state = InstallAborted;
return true;
}
if(START_Updater("INSTALL"))
{
state = InstallFailed;
return true;
}
return false;
}
// update app
// returns true if app must continue execution, false otherwise
bool Updater::START_Update(void)
{
if(START_Updater("UPDATE"))
{
state = UpdateFailed;
return true;
}
return false;
}
// app started, must check for update/install requests
// returns true if app must continue execution, false otherwise
bool Updater::DO_NormalRun(void)
{
// we now check if we just want to uninstall app
// it can be done by command line --UNINSTALL option
if(CommandLine().GetCount() && CommandLine()[0] == "--UNINSTALL")
return START_Uninstall();
// if app not installed, we shall install it
// (if any available version is present on server....)
if(!appInstalled)
{
// fetch available application versions
ProductVersions versions = FetchVersions();
// if versions present on server, install latest
if(versions.GetCount())
return START_Install();
// otherwise resume execution -- it's an uninstalled run
else
return true;
}
// not installing nor uninstalling
// we shall check which kind of update is enabled
String updateMode;
if(!FileExists(AppendFileName(userConfigPath, "UPDATER_MODE")))
{
updateMode = "ASK";
SaveFile(AppendFileName(userConfigPath, "UPDATER_MODE"), updateMode);
}
else
updateMode = LoadFile(AppendFileName(userConfigPath, "UPDATER_MODE"));
// if updates are disabled, just do nothing
if(updateMode == "DISABLED")
return true;
// if we don't have a new version available, just do nothing
ProductVersion maxVer;
if( (maxVer = FetchMaxValidVersion(acceptDevelVersions)) <= installedVersion)
return true;
// if we want manual updates, just ask
if(updateMode == "ASK")
if(!PromptYesNo(Format(t_("New version '%s' is available&Install it ?"), maxVer.ToString())))
return true;
// updater enabled, start it
// if update failed, resume normal run, otherwise exit
// as the app will be launched again by updater itself
return START_Update();
}
bool Updater::DO_InsideUpdater(void)
{
String operation;
// gets variables from environment
// fails update if no operation found (shoudn't happen...)
bool failed = false;
if(environment.Find("UPDATER_USER") < 0)
failed = true;
else
environment.RemoveKey("UPDATER_USER");
if(environment.Find("UPDATER_OP") < 0)
failed = true;
else
{
operation = environment.Get("UPDATER_OP");
environment.RemoveKey("UPDATER_OP");
// setup update operation code
if(operation == "INSTALL")
updaterOp = Install;
else if(operation == "UNINSTALL")
updaterOp = Uninstall;
else if(operation == "UPDATE")
updaterOp = Update;
else
NEVER();
}
if(environment.Find("UPDATER_APPNAME") < 0)
failed = true;
else
{
appName = environment.Get("UPDATER_APPNAME");
environment.RemoveKey("UPDATER_APPNAME");
}
environment.RemoveKey("UPDATER_STATE");
if(environment.Find("UPDATER_CMDLINE") >= 0)
{
commandLine = environment.Get("UPDATER_CMDLINE");
environment.RemoveKey("UPDATER_CMDLINE");
}
if(environment.Find("UPDATER_EXEPATH") < 0)
failed = true;
else
{
exePath = environment.Get("UPDATER_EXEPATH");
environment.RemoveKey("UPDATER_EXEPATH");
}
// if failed getting environment data, signals and restarts in normal mode
if(failed)
{
FailUpdate();
RestartApp(RestartOrig);
return false;
}
// execute the requested operation
switch(updaterOp)
{
case Install:
DO_Install();
break;
case Uninstall:
DO_Uninstall();
break;
case Update:
DO_Update();
break;
default:
NEVER();
}
// returns false anyways, it shouldn't continue in superuser mode !
return false;
}
void Updater::DO_Uninstall(void)
{
// removes executable
String path;
#ifdef PLATFORM_POSIX
path = AppendFileName(GetProgramsFolder(), appName);
#else
path = AppendFileName(GetProgramsFolder(), appName + "/" + appName + ".exe");
#endif
FileDelete(path);
// removes system config folder
// leaves user one alone, it can contain user data
// (on win32, that's also the program folder)
DeleteFolderDeep(systemConfigPath);
// unlink application from shess
ShellUnlink();
// signal op success and leave
// as it was uninstalling, it will restart
// launching app (uninstaller, possibily)
SucceedUpdate();
RestartApp(RestartTemp);
}
void Updater::DO_Install(void)
{
// fetch the new app version and install it
if(!FetchApp(ProductVersion(), acceptDevelVersions))
{
FailUpdate();
RestartApp(RestartOrig);
}
else
{
// link app to shell
ShellLink();
SucceedUpdate();
RestartApp(RestartNew);
}
}
void Updater::DO_Update(void)
{
// fetch the new app version and replace old one
if(!FetchApp(ProductVersion(), acceptDevelVersions))
{
FailUpdate();
RestartApp(RestartOrig);
}
else
{
// link app to shell -- we do it also for updates
// in case of icon changes or others
ShellLink();
SucceedUpdate();
RestartApp(RestartNew);
}
}
bool Updater::DO_UninstallFailed(void)
{
state = UninstallFailed;
return true;
}
bool Updater::DO_InstallFailed(void)
{
state = InstallFailed;
return true;
}
bool Updater::DO_UpdateFailed(void)
{
state = UpdateFailed;
return true;
}
bool Updater::DO_UninstallSucceeded(void)
{
state = UninstallSucceeded;
return true;
}
bool Updater::DO_InstallSucceeded(void)
{
state = InstallSucceeded;
return true;
}
bool Updater::DO_UpdateSucceeded(void)
{
state = UpdateSucceeded;
return true;
}
// restarts app in normal mode after updater mode
// either it re-launches the original one if update didn't succeed
// or the new one if it did OR the temporary app if uninstalling
void Updater::RestartApp(RestartModes restartMode)
{
String path;
switch(restartMode)
{
case RestartTemp:
path = GetExeFilePath();
break;
case RestartOrig:
default:
path = exePath;
break;
case RestartNew:
#ifdef PLATFORM_POSIX
path = AppendFileName(GetProgramsFolder(), appName);
#else
path = AppendFileName(GetProgramsFolder(), appName + "/" + appName + ".exe");
#endif
break;
}
// restart app in user mode, no gui, no password should be needed
SysStartUser(user, "", path, commandLine, environment);
}
// fetch list of available app versions
ProductVersions Updater::FetchVersions(void)
{
String verStr;
if(isWebServer)
{
http.Timeout(1000);
http.Url(GetPlatformRoot() + "versions");
http.WhenDo.Clear();
// fetch version file from server
verStr = http.Execute();
int err = http.GetStatusCode();
if(err != 200)
return ProductVersions();
}
else
verStr = LoadFile(GetPlatformRoot() + "versions");
verStr = TrimBoth(verStr);
if(verStr.IsEmpty())
return ProductVersions();
return ProductVersions(verStr);
}
// fetch MAX valid version, i.e. the greatest among all available
// but smaller or equal than maxVersion
ProductVersion Updater::FetchMaxValidVersion(bool devel)
{
ProductVersions versions = FetchVersions();
if(!versions.GetCount())
return ProductVersion();
return versions.FindMax(ProductVersion(), maxVersion, devel);
}
// fetch the new app version from server
// and replaces older one
// if ver is not specified, fetches the maximum available
// one but which is less than or equal maxVersion
bool Updater::FetchApp(ProductVersion ver, bool devel)
{
int err = 0;
if(!ver)
ver = FetchMaxValidVersion(acceptDevelVersions);
if(!ver)
return false;
String appServerPath, destPath;
#ifdef PLATFORM_POSIX
appServerPath = GetPlatformRoot() + ver.ToString() + "/" + appName;
destPath = AppendFileName(GetProgramsFolder(), appName);
#else
appServerPath = GetPlatformRoot() + ver.ToString() + "/" + appName + ".exe";
destPath = AppendFileName(GetProgramsFolder(), appName + "\\" + appName + ".exe");
RealizePath(destPath);
#endif
if(isWebServer)
{
http.Url(appServerPath);
http.Timeout(1000*60*30);
http.MaxContentSize(100000000);
http.WhenDo = THISBACK(doProgress);
// fetch version file from server
appBuffer = http.Execute();
err = http.GetStatusCode();
if(err != 200 || http.IsAbort() || http.IsError())
{
appBuffer = "";
return false;
}
// replaces/installs app
if(!SaveFile(destPath, appBuffer))
return false;
}
else
FileCopy(appServerPath, destPath);
#ifdef PLATFORM_POSIX
if(chmod(~destPath, 0755) != 0)
return false;
#endif
// stores current version inside system config path
if(!SaveFile(AppendFileName(systemConfigPath, "version"), ver.ToString()))
return false;
installedVersion = ver;
return true;
}
///////////////////////////////////////////////////////////////////////////////////////
// main updater call
// returns TRUE if app should continue, FALSE if should terminate
// BEWARE, app MUST check for return value AND behave as needed
// te SELF_UPDATE() macro does all what is needed
bool Updater::Run()
{
// create user config path only on normal run
if(state == NormalRun)
RealizeDirectory(userConfigPath);
// creates system config path on superuser mode
if(state == InsideUpdater)
RealizeDirectory(systemConfigPath);
switch(state)
{
case NormalRun :
return DO_NormalRun();
case InsideUpdater :
return DO_InsideUpdater();
case UninstallFailed :
return DO_UninstallFailed();
case InstallFailed :
return DO_InstallFailed();
case UpdateFailed :
return DO_UpdateFailed();
case UninstallSucceeded :
return DO_UninstallSucceeded();
case InstallSucceeded :
return DO_InstallSucceeded();
case UpdateSucceeded :
return DO_UpdateSucceeded();
default:
NEVER();
break;
}
// dummy
return false;
}
// sets updater to manual mode -- if update is available, asks user
Updater &Updater::UpdateManual(void)
{
SaveFile(AppendFileName(userConfigPath, "UPDATER_MODE"), "ASK");
return *this;
}
// sets updater to auto -- updates app on launch without asking user
Updater &Updater::UpdateAuto(void)
{
SaveFile(AppendFileName(userConfigPath, "UPDATER_MODE"), "AUTO");
return *this;
}
// disable updater -- app will not update on launch
// re-enable it to restart updating system on next run
Updater &Updater::UpdateDisable(void)
{
SaveFile(AppendFileName(userConfigPath, "UPDATER_MODE"), "DISABLE");
return *this;
}
// default set of prompts for installer result
// just an handy shortcut good for most cases
bool Updater::DefaultPrompts(void)
{
// fine grained behaviour depending on update state
switch(GetState())
{
case UninstallFailed:
Exclamation(Format(t_("Uninstall of '%s' failed&Press OK to quit"), appName));
return false;
case UninstallSucceeded:
PromptOK(Format(t_("Uninstall of '%s' complete&Press OK to quit"), appName));
return false;
case UninstallAborted:
return false ;
case InstallFailed:
switch(installBehaviour)
{
case AskUser :
if(!PromptYesNo(Format(t_("Install of '%s' failed&Run without installing?"), appName)))
return false;
break;
case AbortExecution:
Exclamation(Format(t_("Install of '%s' failed"), appName));
return false;
case ContinueExecution:
Exclamation(Format(t_("Install of '%s' failed&press OK to run uninstalled"), appName));
return true;
default:
return false;
}
return true;
case InstallSucceeded:
return true;
case InstallAborted:
switch(installBehaviour)
{
case AskUser :
if(!PromptYesNo(Format(t_("Install of '%s' aborted&Run without installing?"), appName)))
return false;
break;
case AbortExecution:
Exclamation(Format(t_("Install of '%s' aborted"), appName));
return false;
case ContinueExecution:
Exclamation(Format(t_("Install of '%s' aborted&press OK to run uninstalled"), appName));
return true;
default:
return false;
}
return true;
case UpdateFailed:
switch(updateBehaviour)
{
case AskUser:
if(!PromptYesNo(Format(t_("Update of '%s' failed&Run current version?"), appName)))
return false;
break;
case AbortExecution:
Exclamation(Format(t_("Update of '%s' failed"), appName));
return false;
case ContinueExecution:
Exclamation(Format(t_("Update of '%s' failed&press OK to run current version"), appName));
return true;
default:
return true;
}
return true;
case UpdateSucceeded:
return true;
// here we're on normal run, no install/uninstall/update process happened
// we should continue normal execution
default:
return true;
}
}
// default icon
Image Updater::DefaultIcon(void)
{
return UpdaterImg::DefaultIcon();
}
END_UPP_NAMESPACE