updaterconfig.h

Go to the documentation of this file.

/*
 * updaterconfig.h - Author: Mike Gist
 *
 * Copyright (C) 2007 Atomic Blue (info@planeshift.it, http://www.atomicblue.org)
 *
 *
 * 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 (version 2 of the License)
 * 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 */

#ifndef __UPDATERCONFIG_H__
#define __UPDATERCONFIG_H__

#include <csutil/csstring.h>
#include <cstool/initapp.h>
#include <csutil/cfgmgr.h>
#include <csutil/cfgfile.h>
#include <iutil/document.h>

#include "util/singleton.h"

#define CONFIG_FILENAME "/this/pslaunch.cfg"
#define UPDATERINFO_FILENAME "/planeshift/userdata/updaterinfo.xml"
#define UPDATERINFO_CURRENT_FILENAME "/this/updaterinfo.xml"
#define INTEGRITY_ZIPNAME "/this/integrity.zip"
#define SERVERS_FILENAME "/planeshift/userdata/updateservers.xml"
#define SERVERS_CURRENT_FILENAME "/this/updateservers.xml"
#define UPDATE_CACHE_DIR "/planeshift/userdata/updatecache"
#define FALLBACK_SERVER "http://www.planeshift.it/"


class Mirror : public csRefCount
{
public:
    Mirror():
    id(0),  repair(false)
    {}
    
    ~Mirror() {}

    /* Return mirror ID */
    unsigned int GetID() const { return id; }

    /* Return mirror name */
    const char* GetName() const { return name; }

    /* Return mirror URL */
    const char* GetBaseURL() const { return baseURL; }

    bool IsRepair() const { return repair; }

    /* Set mirror URL */
    void SetBaseURL(csString url) { baseURL = url; }

    void SetID(uint id) { this->id = id; }
    void SetName(const char* name) { this->name = name; }
    void SetBaseURL(const char* baseURL) { this->baseURL = baseURL; }

    void SetIsRepair(const bool repair) { this->repair = repair; }

protected:
    /* Mirror ID */
    uint id;

    /* Mirror name */
    csString name;

    /* URL of the mirror (including update dir) */
    csString baseURL;

    bool repair;
};

class ClientVersion : public csRefCount
{
public:
    ClientVersion() {}
    ~ClientVersion() {}

    /* Get client update file name */
    const char* GetName() const { return name; }

    /* Get platform specific update file md5sum */
    const char* GetMD5Sum() const { return md5sum; }

    /* Get generic update file md5sum */
    const char* GetGenericMD5Sum() const { return genericmd5sum; }

    void SetName(const char* name) { this->name = name; }
    void SetMD5Sum(const char* md5sum) { this->md5sum = md5sum; }
    void SetGenericMD5Sum(const char* genericmd5sum) { this->genericmd5sum = genericmd5sum; }

private:
    /* Client update file name */
    csString name;

    /* md5sum of the platform specific update file */
    csString md5sum;

    /* md5sum of the generic update file */
    csString genericmd5sum;
};

struct Proxy
{
    /* Hostname of the proxy */
    csString host;
    /* Port */
    uint port;
};

class Config
{
public:
    Config();

    Mirror* GetMirror(uint mirrorNumber);
    csArray<Mirror> GetRepairMirrors();

    csRefArray<Mirror>& GetMirrors() { return mirrors; }
    
    csRefArray<ClientVersion>& GetClientVersions() { return clientVersions; }

    bool LoadMirrors(iDocumentNode* node);

    bool Initialize(iDocumentNode* node);

    const char* GetPlatform() const;

    const char* GetGeneric() const { return "generic"; }

    float GetUpdaterVersionLatest() const { return updaterVersionLatest; }

    unsigned int GetUpdaterVersionLatestMajor() const { return updaterVersionLatestMajor; }

    unsigned int GetUpdaterVersionLatestMinor() const { return updaterVersionLatestMinor; }

    const char* GetUpdaterVersionLatestMD5() const { return updaterVersionLatestMD5; }

    bool IsActive() const { return active; }

private:
    float updaterVersionLatest;

    unsigned int updaterVersionLatestMajor;

    unsigned int updaterVersionLatestMinor;

    /* Latest version md5sum */
    csString updaterVersionLatestMD5;

    /* List of mirrors */
    csRefArray<Mirror> mirrors;

    /* List of client versions */
    csRefArray<ClientVersion> clientVersions;

    /* Whether the updater mirror is active */
    bool active;
};

class UpdaterConfig : public Singleton<UpdaterConfig>
{
public:
    UpdaterConfig(csStringArray& args, iObjectRegistry* _object_reg, iVFS* _vfs);
    ~UpdaterConfig();

    int IsSelfUpdating() const { return selfUpdating; }

    bool CheckForIntegrity() const { return checkIntegrity; }

    bool SwitchMirror() const { return switchMirror; }

    Proxy GetProxy() { return proxy; }

    Config* GetCurrentConfig() const { return currentCon; }

    Config* GetNewConfig() const { return newCon; }

    bool WasCleanUpdate() const { return cleanUpdate; }

    bool UpdatePlatform() const { return updatePlatform; }

    bool RepairingInZip() const { return repairInZip; }

    bool KeepingRepaired() const { return keepRepaired; }

    bool RepairFailed() const { return repairFailed; }

    bool IsUpdateEnabled() const { return updateEnabled; }

    iConfigFile* GetConfigFile() const { return configFile; }

    void SetSelfUpdating(bool t) { selfUpdating = t ? 1 : 0; }

    const char* GetNewMirrorAddress() const { return newMirror; }

private:

    /* Holds stage of self updating. */
    int selfUpdating;

    /* Holds whether or not the last update was successful. */
    bool cleanUpdate;

    /* True if we want the updater to update platform specific files. */
    bool updatePlatform;

    /* True if we're being asked to check the integrity of the install. */
    bool checkIntegrity;

    /* True if we're being asked to switch the updater mirror. */
    bool switchMirror;

    /* True if we want to do in-zip repairs. */
    bool repairInZip;

    /* True if we want a repair to keep the old file (*.bak). */
    bool keepRepaired;

    /* True if we want to perform a repair when files fail after an update. */
    bool repairFailed;

    /* True if we want to use the updater. This could be turned of when third-party
     * updater is used
     */
    bool updateEnabled;

    /* Address of new mirror. */
    csString newMirror;

    /* VFS, Object Registry */
    csRef<iVFS> vfs;
    static iObjectRegistry* object_reg;

    /* Config Manager */
    csRef<iConfigManager> configManager;

    /* Config File */
    csRef<iConfigFile> configFile;

    /* Proxy server */
    Proxy proxy;

    /* Current Config */
    Config* currentCon;

    /* New Config */
    Config* newCon;
};

#endif // __UPDATERCONFIG_H__