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
25 #include <boost/bind.hpp>
27 #include <simgear/misc/sg_path.hxx>
28 #include <simgear/props/props.hxx>
30 #include <simgear/structure/SGReferenced.hxx>
31 #include <simgear/structure/SGSharedPtr.hxx>
32 #include <simgear/structure/function_list.hxx>
34 #include <simgear/package/Delegate.hxx>
39 namespace HTTP { class Client; }
50 typedef SGSharedPtr<Package> PackageRef;
51 typedef SGSharedPtr<Catalog> CatalogRef;
52 typedef SGSharedPtr<Install> InstallRef;
54 typedef std::vector<PackageRef> PackageList;
55 typedef std::vector<CatalogRef> CatalogList;
57 class Catalog : public SGReferenced
62 static CatalogRef createFromUrl(Root* aRoot, const std::string& aUrl);
64 static CatalogRef createFromPath(Root* aRoot, const SGPath& aPath);
70 * uninstall this catalog entirely, including all installed packages
75 * perform a refresh of the catalog contents
80 * Get all packages in this catalog.
82 PackageList const& packages() const;
85 * retrieve packages in this catalog matching a filter.
86 * filter consists of required / minimum values, AND-ed together.
88 PackageList packagesMatching(const SGPropertyNode* aFilter) const;
91 * packages which are locally installed
93 PackageList installedPackages() const;
96 * retrieve all the packages in the catalog which are installed
97 * and have a pendig update
99 PackageList packagesNeedingUpdate() const;
101 SGPath installRoot() const
102 { return m_installRoot; }
104 std::string id() const;
106 std::string url() const;
108 std::string description() const;
110 PackageRef getPackageById(const std::string& aId) const;
112 InstallRef installForPackage(PackageRef pkg) const;
115 * test if the catalog data was retrieved longer ago than the
116 * maximum permitted age for this catalog.
118 bool needsRefresh() const;
120 unsigned int ageInSeconds() const;
123 * access the raw property data in the catalog
125 SGPropertyNode* properties() const;
127 Delegate::FailureCode status() const;
129 typedef boost::function<void(Catalog*)> Callback;
131 void addStatusCallback(const Callback& cb);
134 void addStatusCallback(C* instance, void (C::*mem_func)(Catalog*))
136 return addStatusCallback(boost::bind(mem_func, instance, _1));
139 Catalog(Root* aRoot);
142 friend class Downloader;
144 friend class Install;
145 void registerInstall(Install* ins);
146 void unregisterInstall(Install* ins);
148 void parseProps(const SGPropertyNode* aProps);
150 void refreshComplete(Delegate::FailureCode aReason);
152 void parseTimestamp();
153 void writeTimestamp();
155 std::string getLocalisedString(const SGPropertyNode* aRoot, const char* aName) const;
157 void changeStatus(Delegate::FailureCode newStatus);
160 SGPropertyNode_ptr m_props;
161 SGPath m_installRoot;
163 Delegate::FailureCode m_status;
165 PackageList m_packages;
166 time_t m_retrievedTime;
168 typedef std::map<std::string, Package*> PackageWeakMap;
169 PackageWeakMap m_variantDict;
171 // important that this is a weak-ref to Installs,
172 // since it is only cleaned up in the Install destructor
173 typedef std::map<PackageRef, Install*> PackageInstallDict;
174 PackageInstallDict m_installed;
176 function_list<Callback> m_statusCallbacks;
179 } // of namespace pkg
181 } // of namespace simgear
183 #endif // of SG_PACKAGE_CATALOG_HXX