simgear/package/Catalog.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_CATALOG_HXX
  19 #define SG_PACKAGE_CATALOG_HXX
  20
  21 #include <vector>
  22 #include <ctime>
  23
  24 #include <simgear/misc/sg_path.hxx>
  25 #include <simgear/props/props.hxx>
  26
  27 #include <simgear/structure/SGReferenced.hxx>
  28 #include <simgear/structure/SGSharedPtr.hxx>
  29
  30 #include <simgear/package/Delegate.hxx>
  31
  32 namespace simgear
  33 {
  34
  35 namespace HTTP { class Client; }
  36
  37 namespace pkg
  38 {
  39
  40 // forward decls
  41 class Package;
  42 class Catalog;
  43 class Root;
  44
  45 typedef SGSharedPtr<Package> PackageRef;
  46 typedef SGSharedPtr<Catalog> CatalogRef;
  47 typedef SGSharedPtr<Install> InstallRef;
  48
  49 typedef std::vector<PackageRef> PackageList;
  50 typedef std::vector<CatalogRef> CatalogList;
  51
  52   class Catalog : public SGReferenced
  53 {
  54 public:
  55     virtual ~Catalog();
  56
  57     static CatalogRef createFromUrl(Root* aRoot, const std::string& aUrl);
  58
  59     static CatalogRef createFromPath(Root* aRoot, const SGPath& aPath);
  60
  61     static CatalogList allCatalogs();
  62
  63     Root* root() const
  64         { return m_root;};
  65
  66     /**
  67      * perform a refresh of the catalog contents
  68      */
  69     void refresh();
  70     /**
  71      * retrieve packages in this catalog matching a filter.
  72      * filter consists of required / minimum values, AND-ed together.
  73      */
  74     PackageList packagesMatching(const SGPropertyNode* aFilter) const;
  75
  76     /**
  77      * packages which are locally installed
  78      */
  79     PackageList installedPackages() const;
  80
  81     /**
  82      * retrieve all the packages in the catalog which are installed
  83      * and have a pendig update
  84      */
  85     PackageList packagesNeedingUpdate() const;
  86
  87     SGPath installRoot() const
  88          { return m_installRoot; }
  89
  90     std::string id() const;
  91
  92     std::string url() const;
  93
  94     std::string description() const;
  95
  96     PackageRef getPackageById(const std::string& aId) const;
  97
  98     /**
  99      * test if the catalog data was retrieved longer ago than the
 100      * maximum permitted age for this catalog.
 101      */
 102     bool needsRefresh() const;
 103
 104     unsigned int ageInSeconds() const;
 105
 106     /**
 107      * access the raw property data in the catalog
 108      */
 109     SGPropertyNode* properties() const;
 110 private:
 111     Catalog(Root* aRoot);
 112
 113     class Downloader;
 114     friend class Downloader;
 115
 116     void parseProps(const SGPropertyNode* aProps);
 117
 118     void refreshComplete(Delegate::FailureCode aReason);
 119
 120     void parseTimestamp();
 121     void writeTimestamp();
 122
 123     std::string getLocalisedString(const SGPropertyNode* aRoot, const char* aName) const;
 124
 125     Root* m_root;
 126     SGPropertyNode_ptr m_props;
 127     SGPath m_installRoot;
 128     std::string m_url;
 129
 130     PackageList m_packages;
 131     time_t m_retrievedTime;
 132 };
 133
 134 } // of namespace pkg
 135
 136 } // of namespace simgear
 137
 138 #endif // of SG_PACKAGE_CATALOG_HXX