simgear/package/Root.hxx

   1 // Copyright (C) 2013  James Turner - zakalawe@mac.com
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Library General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Library General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU General Public License
  14 // along with this program; if not, write to the Free Software
  15 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  16 //
  17
  18 #ifndef SG_PACKAGE_ROOT_HXX
  19 #define SG_PACKAGE_ROOT_HXX
  20
  21 #include <vector>
  22 #include <memory> // for auto_ptr
  23
  24 #include <simgear/misc/sg_path.hxx>
  25 #include <simgear/package/Delegate.hxx>
  26
  27 #include <simgear/structure/SGReferenced.hxx>
  28 #include <simgear/structure/SGSharedPtr.hxx>
  29
  30 class SGPropertyNode;
  31
  32 namespace simgear
  33 {
  34
  35 namespace HTTP {
  36     class Client;
  37     class Request;
  38 }
  39
  40 namespace pkg
  41 {
  42
  43 // forward decls
  44 class Package;
  45 class Catalog;
  46 class Install;
  47
  48 typedef SGSharedPtr<Package> PackageRef;
  49 typedef SGSharedPtr<Catalog> CatalogRef;
  50 typedef SGSharedPtr<Install> InstallRef;
  51
  52 typedef std::vector<PackageRef> PackageList;
  53 typedef std::vector<CatalogRef> CatalogList;
  54
  55 class Root : public SGReferenced
  56 {
  57 public:
  58     Root(const SGPath& aPath, const std::string& aVersion);
  59     virtual ~Root();
  60
  61     SGPath path() const;
  62
  63     void setLocale(const std::string& aLocale);
  64
  65     void setDelegate(Delegate* aDelegate);
  66
  67     std::string getLocale() const;
  68
  69     CatalogList catalogs() const;
  70
  71     void setMaxAgeSeconds(unsigned int seconds);
  72     unsigned int maxAgeSeconds() const;
  73
  74     void setHTTPClient(HTTP::Client* aHTTP);
  75
  76     /**
  77      * Submit an HTTP request. The Root may delay or queue requests if it needs
  78      * too, for example during startup when the HTTP engine may not have been
  79      * set yet.
  80      */
  81     void makeHTTPRequest(HTTP::Request* req);
  82
  83     /**
  84      * the version string of the root. Catalogs must match this version,
  85      * or they will be ignored / rejected.
  86      */
  87     std::string catalogVersion() const;
  88
  89     /**
  90      * refresh catalogs which are more than the maximum age (24 hours by default)
  91      * set force to true, to download all catalogs regardless of age.
  92      */
  93     void refresh(bool aForce = false);
  94
  95     /**
  96      * retrieve packages matching a filter.
  97      * filter consists of required / minimum values, AND-ed together.
  98      */
  99     PackageList packagesMatching(const SGPropertyNode* aFilter) const;
 100
 101     /**
 102      * retrieve all the packages which are installed
 103      * and have a pending update
 104      */
 105     PackageList packagesNeedingUpdate() const;
 106
 107     PackageRef getPackageById(const std::string& aId) const;
 108
 109     CatalogRef getCatalogById(const std::string& aId) const;
 110
 111     void scheduleToUpdate(InstallRef aInstall);
 112
 113     /**
 114      * remove a catalog. Will uninstall all packages originating
 115      * from the catalog too.
 116      */
 117     bool removeCatalogById(const std::string& aId);
 118 private:
 119     friend class Install;
 120     friend class Catalog;
 121
 122
 123     void catalogRefreshBegin(CatalogRef aCat);
 124     void catalogRefreshComplete(CatalogRef aCat, Delegate::FailureCode aReason);
 125
 126     void startNext(InstallRef aCurrent);
 127
 128     void startInstall(InstallRef aInstall);
 129     void installProgress(InstallRef aInstall, unsigned int aBytes, unsigned int aTotal);
 130     void finishInstall(InstallRef aInstall);
 131     void failedInstall(InstallRef aInstall, Delegate::FailureCode aReason);
 132
 133     class RootPrivate;
 134     std::auto_ptr<RootPrivate> d;
 135 };
 136
 137 typedef SGSharedPtr<Root> RootRef;
 138
 139 } // of namespace pkg
 140
 141 } // of namespace simgear
 142
 143 #endif // of SG_PACKAGE_ROOT_HXX