1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
|
#pragma once
/*
* Copyright (C) 2011-2013 Team XBMC
* http://xbmc.org
*
* This Program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2, or (at your option)
* any later version.
*
* This Program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with XBMC; see the file COPYING. If not, see
* <http://www.gnu.org/licenses/>.
*
*/
#include "utils/FileOperationJob.h"
#include "addons/Addon.h"
#include "utils/Stopwatch.h"
#include "threads/Event.h"
class CAddonDatabase;
enum {
AUTO_UPDATES_ON = 0,
AUTO_UPDATES_NOTIFY,
AUTO_UPDATES_NEVER,
AUTO_UPDATES_MAX
};
class CAddonInstaller : public IJobCallback
{
public:
static CAddonInstaller &Get();
bool IsDownloading() const;
void GetInstallList(ADDON::VECADDONS &addons) const;
bool GetProgress(const std::string &addonID, unsigned int &percent) const;
bool Cancel(const std::string &addonID);
/*! \brief Installs the addon while showing a modal progress dialog
\param addonID the addon ID of the item to install.
\param addon [out] the installed addon for later use.
\param promptForInstall Whether or not to prompt the user before installing the addon.
\return true on successful install, false otherwise.
\sa Install
*/
bool InstallModal(const std::string &addonID, ADDON::AddonPtr &addon, bool promptForInstall = true);
/*! \brief Install an addon if it is available in a repository
\param addonID the addon ID of the item to install
\param force whether to force the install even if the addon is already installed (eg for updating). Defaults to false.
\param referer string to use for referer for http fetch. Set to previous version when updating, parent when fetching a dependency
\param background whether to install in the background or not. Defaults to true.
\param modal whether to show a modal dialog when not installing in background
\return true on successful install, false on failure.
\sa DoInstall
*/
bool Install(const std::string &addonID, bool force = false, const std::string &referer="", bool background = true, bool modal = false);
/*! \brief Install an addon from the given zip path
\param path the zip file to install from
\return true if successful, false otherwise
\sa DoInstall
*/
bool InstallFromZip(const std::string &path);
/*! \brief Install a set of addons from the official repository (if needed)
\param addonIDs a set of addon IDs to install
*/
void InstallFromXBMCRepo(const std::set<std::string> &addonIDs);
/*! \brief Check whether dependencies of an addon exist or are installable.
Iterates through the addon's dependencies, checking they're installed or installable.
Each dependency must also satisfies CheckDependencies in turn.
\param addon the addon to check
\param database the database instance to update. Defaults to NULL.
\return true if dependencies are available, false otherwise.
*/
bool CheckDependencies(const ADDON::AddonPtr &addon, CAddonDatabase *database = NULL);
/*! \brief Update all repositories (if needed)
Runs through all available repositories and queues an update of them if they
need it (according to the set timeouts) or if forced. Optionally busy wait
until the repository updates are complete.
\param force whether we should run an update regardless of the normal update cycle. Defaults to false.
\param wait whether we should busy wait for the updates to be performed. Defaults to false.
*/
/*! \brief Check if an installation job for a given add-on is already queued up
* \param ID The ID of the add-on
* \return true if a job exists, false otherwise
*/
bool HasJob(const std::string& ID) const;
/*! \brief Fetch the last repository update time.
\return the last time a repository was updated.
*/
CDateTime LastRepoUpdate() const;
void UpdateRepos(bool force = false, bool wait = false);
void OnJobComplete(unsigned int jobID, bool success, CJob* job);
void OnJobProgress(unsigned int jobID, unsigned int progress, unsigned int total, const CJob *job);
class CDownloadJob
{
public:
CDownloadJob(unsigned int id)
{
jobID = id;
progress = 0;
}
unsigned int jobID;
unsigned int progress;
};
typedef std::map<std::string, CDownloadJob> JobMap;
private:
// private construction, and no assignements; use the provided singleton methods
CAddonInstaller();
CAddonInstaller(const CAddonInstaller&);
CAddonInstaller const& operator=(CAddonInstaller const&);
virtual ~CAddonInstaller();
/*! \brief Install an addon from a repository or zip
\param addon the AddonPtr describing the addon
\param hash the hash to verify the install. Defaults to "".
\param update whether this is an update of an existing addon, or a new install. Defaults to false.
\param referer string to use for referer for http fetch. Defaults to "".
\param background whether to install in the background or not. Defaults to true.
\return true on successful install, false on failure.
*/
bool DoInstall(const ADDON::AddonPtr &addon, const std::string &hash = "", bool update = false, const std::string &referer = "", bool background = true, bool modal = false);
/*! \brief Check whether dependencies of an addon exist or are installable.
Iterates through the addon's dependencies, checking they're installed or installable.
Each dependency must also satisfies CheckDependencies in turn.
\param addon the addon to check
\param preDeps previous dependencies encountered during recursion. aids in avoiding infinite recursion
\param database database instance to update
\return true if dependencies are available, false otherwise.
*/
bool CheckDependencies(const ADDON::AddonPtr &addon, std::vector<std::string>& preDeps, CAddonDatabase &database);
void PrunePackageCache();
int64_t EnumeratePackageFolder(std::map<std::string,CFileItemList*>& result);
CCriticalSection m_critSection;
JobMap m_downloadJobs;
CStopWatch m_repoUpdateWatch; ///< repository updates are done based on this counter
unsigned int m_repoUpdateJob; ///< the job ID of the repository updates
CEvent m_repoUpdateDone; ///< event set when the repository updates are complete
};
class CAddonInstallJob : public CFileOperationJob
{
public:
CAddonInstallJob(const ADDON::AddonPtr &addon, const std::string &hash = "", bool update = false, const std::string &referer = "");
virtual bool DoWork();
/*! \brief return the id of the addon being installed
\return id of the installing addon
*/
std::string AddonID() const;
/*! \brief Find which repository hosts an add-on
* \param addon The add-on to find the repository for
* \return The hosting repository
*/
static ADDON::AddonPtr GetRepoForAddon(const ADDON::AddonPtr& addon);
/*! \brief Find the add-on and itshash for the given add-on ID
* \param addonID ID of the add-on to find
* \param addon Add-on with the given add-on ID
* \param hash Hash of the add-on
* \return True if the add-on and its hash were found, false otherwise.
*/
static bool GetAddonWithHash(const std::string& addonID, ADDON::AddonPtr& addon, std::string& hash);
private:
bool OnPreInstall();
void OnPostInstall(bool reloadAddon);
bool Install(const std::string &installFrom, const ADDON::AddonPtr& repo = ADDON::AddonPtr());
bool DownloadPackage(const std::string &path, const std::string &dest);
/*! \brief Delete an addon following install failure
\param addonFolder - the folder to delete
*/
bool DeleteAddon(const std::string &addonFolder);
bool DoFileOperation(FileAction action, CFileItemList &items, const std::string &file, bool useSameJob = true);
/*! \brief Queue a notification for addon installation/update failure
\param addonID - addon id
\param fileName - filename which is shown in case the addon id is unknown
\param message - error message to be displayed
*/
void ReportInstallError(const std::string& addonID, const std::string& fileName, const std::string& message = "");
ADDON::AddonPtr m_addon;
std::string m_hash;
bool m_update;
std::string m_referer;
};
class CAddonUnInstallJob : public CFileOperationJob
{
public:
CAddonUnInstallJob(const ADDON::AddonPtr &addon);
virtual bool DoWork();
private:
/*! \brief Delete an addon following install failure
\param addonFolder - the folder to delete
*/
bool DeleteAddon(const std::string &addonFolder);
void OnPostUnInstall();
ADDON::AddonPtr m_addon;
};
|
