1 // Copyright (C) 2013 James Turner - zakalawe@mac.com
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.
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.
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.
18 #ifndef SG_PACKAGE_CATALOG_HXX
19 #define SG_PACKAGE_CATALOG_HXX
24 #include <simgear/misc/sg_path.hxx>
25 #include <simgear/props/props.hxx>
27 #include <simgear/structure/SGReferenced.hxx>
28 #include <simgear/structure/SGSharedPtr.hxx>
30 #include <simgear/package/Delegate.hxx>
35 namespace HTTP { class Client; }
45 typedef SGSharedPtr<Package> PackageRef;
46 typedef SGSharedPtr<Catalog> CatalogRef;
47 typedef SGSharedPtr<Install> InstallRef;
49 typedef std::vector<PackageRef> PackageList;
50 typedef std::vector<CatalogRef> CatalogList;
52 class Catalog : public SGReferenced
57 static CatalogRef createFromUrl(Root* aRoot, const std::string& aUrl);
59 static CatalogRef createFromPath(Root* aRoot, const SGPath& aPath);
61 static CatalogList allCatalogs();
67 * perform a refresh of the catalog contents
72 * Get all packages in this catalog.
74 PackageList const& packages() const;
77 * retrieve packages in this catalog matching a filter.
78 * filter consists of required / minimum values, AND-ed together.
80 PackageList packagesMatching(const SGPropertyNode* aFilter) const;
83 * packages which are locally installed
85 PackageList installedPackages() const;
88 * retrieve all the packages in the catalog which are installed
89 * and have a pendig update
91 PackageList packagesNeedingUpdate() const;
93 SGPath installRoot() const
94 { return m_installRoot; }
96 std::string id() const;
98 std::string url() const;
100 std::string description() const;
102 PackageRef getPackageById(const std::string& aId) const;
105 * test if the catalog data was retrieved longer ago than the
106 * maximum permitted age for this catalog.
108 bool needsRefresh() const;
110 unsigned int ageInSeconds() const;
113 * access the raw property data in the catalog
115 SGPropertyNode* properties() const;
117 Catalog(Root* aRoot);
120 friend class Downloader;
122 void parseProps(const SGPropertyNode* aProps);
124 void refreshComplete(Delegate::FailureCode aReason);
126 void parseTimestamp();
127 void writeTimestamp();
129 std::string getLocalisedString(const SGPropertyNode* aRoot, const char* aName) const;
132 SGPropertyNode_ptr m_props;
133 SGPath m_installRoot;
136 PackageList m_packages;
137 time_t m_retrievedTime;
140 } // of namespace pkg
142 } // of namespace simgear
144 #endif // of SG_PACKAGE_CATALOG_HXX