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_ROOT_HXX
19 #define SG_PACKAGE_ROOT_HXX
22 #include <memory> // for auto_ptr
24 #include <simgear/misc/sg_path.hxx>
25 #include <simgear/package/Delegate.hxx>
27 #include <simgear/structure/SGReferenced.hxx>
28 #include <simgear/structure/SGSharedPtr.hxx>
48 typedef SGSharedPtr<Package> PackageRef;
49 typedef SGSharedPtr<Catalog> CatalogRef;
50 typedef SGSharedPtr<Install> InstallRef;
52 typedef std::vector<PackageRef> PackageList;
53 typedef std::vector<CatalogRef> CatalogList;
55 class Root : public SGReferenced
58 Root(const SGPath& aPath, const std::string& aVersion);
63 void setLocale(const std::string& aLocale);
65 void addDelegate(Delegate* aDelegate);
67 void removeDelegate(Delegate* aDelegate);
69 std::string getLocale() const;
71 CatalogList catalogs() const;
73 void setMaxAgeSeconds(unsigned int seconds);
74 unsigned int maxAgeSeconds() const;
76 void setHTTPClient(HTTP::Client* aHTTP);
79 * Submit an HTTP request. The Root may delay or queue requests if it needs
80 * too, for example during startup when the HTTP engine may not have been
83 void makeHTTPRequest(HTTP::Request* req);
86 * Cancel an HTTP request.
88 void cancelHTTPRequest(HTTP::Request* req, const std::string& reason);
91 * The catalog XML/property version in use. This is used to make incomaptible
92 * changes to the package/catalog syntax
94 int catalogVersion() const;
97 * the version string of the application. Catalogs must match this version,
98 * or they will be ignored / rejected.
100 std::string applicationVersion() const;
103 * refresh catalogs which are more than the maximum age (24 hours by default)
104 * set force to true, to download all catalogs regardless of age.
106 void refresh(bool aForce = false);
111 PackageList allPackages() const;
114 * retrieve packages matching a filter.
115 * filter consists of required / minimum values, AND-ed together.
117 PackageList packagesMatching(const SGPropertyNode* aFilter) const;
120 * retrieve all the packages which are installed
121 * and have a pending update
123 PackageList packagesNeedingUpdate() const;
125 PackageRef getPackageById(const std::string& aId) const;
127 CatalogRef getCatalogById(const std::string& aId) const;
129 void scheduleToUpdate(InstallRef aInstall);
132 * remove a catalog. Will uninstall all packages originating
133 * from the catalog too.
135 bool removeCatalogById(const std::string& aId);
138 * request thumbnail data from the cache / network
140 void requestThumbnailData(const std::string& aUrl);
142 bool isInstallQueued(InstallRef aInstall) const;
144 friend class Install;
145 friend class Catalog;
146 friend class Package;
148 InstallRef existingInstallForPackage(PackageRef p) const;
150 void catalogRefreshStatus(CatalogRef aCat, Delegate::StatusCode aReason);
152 void startNext(InstallRef aCurrent);
154 void startInstall(InstallRef aInstall);
155 void installProgress(InstallRef aInstall, unsigned int aBytes, unsigned int aTotal);
156 void finishInstall(InstallRef aInstall, Delegate::StatusCode aReason);
157 void cancelDownload(InstallRef aInstall);
159 void registerInstall(InstallRef ins);
160 void unregisterInstall(InstallRef ins);
162 class ThumbnailDownloader;
164 std::auto_ptr<RootPrivate> d;
167 typedef SGSharedPtr<Root> RootRef;
169 } // of namespace pkg
171 } // of namespace simgear
173 #endif // of SG_PACKAGE_ROOT_HXX