1 // SuperTux - Add-on Manager
2 // Copyright (C) 2007 Christoph Sommer <christoph.sommer@2007.expires.deltadevelopment.de>
3 // 2014 Ingo Ruhnke <grumbel@gmail.com>
5 // This program is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
10 // This program is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 // GNU General Public License for more details.
15 // You should have received a copy of the GNU General Public License
16 // along with this program. If not, see <http://www.gnu.org/licenses/>.
18 #include "addon/addon_manager.hpp"
32 #include "addon/addon.hpp"
33 #include "addon/md5.hpp"
34 #include "lisp/list_iterator.hpp"
35 #include "lisp/parser.hpp"
36 #include "util/file_system.hpp"
37 #include "util/log.hpp"
38 #include "util/reader.hpp"
39 #include "util/writer.hpp"
43 MD5 md5_from_file(const std::string& filename)
45 // TODO: this does not work as expected for some files -- IFileStream seems to not always behave like an ifstream.
46 //IFileStream ifs(installed_physfs_filename);
47 //std::string md5 = MD5(ifs).hex_digest();
51 unsigned char buffer[1024];
52 PHYSFS_file* file = PHYSFS_openRead(filename.c_str());
55 PHYSFS_sint64 len = PHYSFS_read(file, buffer, 1, sizeof(buffer));
57 md5.update(buffer, len);
64 bool has_suffix(const std::string& str, const std::string& suffix)
66 if (str.length() >= suffix.length())
67 return str.compare(str.length() - suffix.length(), suffix.length(), suffix) == 0;
74 AddonManager::AddonManager(const std::string& addon_directory,
75 std::vector<Config::Addon>& addon_config) :
77 m_addon_directory(addon_directory),
78 //m_repository_url("http://addons.supertux.googlecode.com/git/index-0_3_5.nfo"),
79 m_repository_url("http://localhost:8000/index-0_4_0.nfo"),
80 m_addon_config(addon_config),
82 m_repository_addons(),
83 m_has_been_updated(false)
85 PHYSFS_mkdir(m_addon_directory.c_str());
87 add_installed_addons();
89 // FIXME: We should also restore the order here
90 for(auto& addon : m_addon_config)
96 enable_addon(addon.id);
98 catch(const std::exception& err)
100 log_warning << "failed to enable addon from config: " << err.what() << std::endl;
106 AddonManager::~AddonManager()
108 // sync enabled/disabled addons into the config for saving
109 m_addon_config.clear();
110 for(auto& addon : m_installed_addons)
112 m_addon_config.push_back({addon->get_id(), addon->is_enabled()});
117 AddonManager::get_repository_addon(const AddonId& id)
119 auto it = std::find_if(m_repository_addons.begin(), m_repository_addons.end(),
120 [&id](const std::unique_ptr<Addon>& addon)
122 return addon->get_id() == id;
125 if (it != m_repository_addons.end())
131 throw std::runtime_error("Couldn't find repository Addon with id: " + id);
136 AddonManager::get_installed_addon(const AddonId& id)
138 auto it = std::find_if(m_installed_addons.begin(), m_installed_addons.end(),
139 [&id](const std::unique_ptr<Addon>& addon)
141 return addon->get_id() == id;
144 if (it != m_installed_addons.end())
150 throw std::runtime_error("Couldn't find installed Addon with id: " + id);
155 AddonManager::get_repository_addons() const
157 std::vector<AddonId> results;
158 results.reserve(m_repository_addons.size());
159 std::transform(m_repository_addons.begin(), m_repository_addons.end(),
160 std::back_inserter(results),
161 [](const std::unique_ptr<Addon>& addon)
163 return addon->get_id();
170 AddonManager::get_installed_addons() const
172 std::vector<AddonId> results;
173 results.reserve(m_installed_addons.size());
174 std::transform(m_installed_addons.begin(), m_installed_addons.end(),
175 std::back_inserter(results),
176 [](const std::unique_ptr<Addon>& addon)
178 return addon->get_id();
184 AddonManager::has_online_support() const
190 AddonManager::has_been_updated() const
192 return m_has_been_updated;
196 AddonManager::check_online()
198 std::string addoninfos = m_downloader.download(m_repository_url);
199 m_repository_addons = parse_addon_infos(addoninfos);
200 m_has_been_updated = true;
204 AddonManager::install_addon(const AddonId& addon_id)
206 { // remove addon if it already exists
207 auto it = std::find_if(m_installed_addons.begin(), m_installed_addons.end(),
208 [&addon_id](const std::unique_ptr<Addon>& addon)
210 return addon->get_id() == addon_id;
212 if (it != m_installed_addons.end())
214 log_debug << "reinstalling addon " << addon_id << std::endl;
215 if ((*it)->is_enabled())
217 disable_addon((*it)->get_id());
219 m_installed_addons.erase(it);
223 log_debug << "installing addon " << addon_id << std::endl;
227 Addon& repository_addon = get_repository_addon(addon_id);
229 std::string install_filename = FileSystem::join(m_addon_directory, repository_addon.get_filename());
231 m_downloader.download(repository_addon.get_url(), install_filename);
233 MD5 md5 = md5_from_file(install_filename);
234 if (repository_addon.get_md5() != md5.hex_digest())
236 if (PHYSFS_delete(install_filename.c_str()) == 0)
238 log_warning << "PHYSFS_delete failed: " << PHYSFS_getLastError() << std::endl;
241 throw std::runtime_error("Downloading Add-on failed: MD5 checksums differ");
245 const char* realdir = PHYSFS_getRealDir(install_filename.c_str());
248 throw std::runtime_error("PHYSFS_getRealDir failed: " + install_filename);
252 add_installed_archive(install_filename, md5.hex_digest());
258 AddonManager::uninstall_addon(const AddonId& addon_id)
260 log_debug << "uninstalling addon " << addon_id << std::endl;
261 Addon& addon = get_installed_addon(addon_id);
262 if (addon.is_enabled())
264 disable_addon(addon_id);
266 log_debug << "deleting file \"" << addon.get_install_filename() << "\"" << std::endl;
267 PHYSFS_delete(addon.get_install_filename().c_str());
268 m_installed_addons.erase(std::remove_if(m_installed_addons.begin(), m_installed_addons.end(),
269 [&addon](const std::unique_ptr<Addon>& rhs)
271 return addon.get_id() == rhs->get_id();
273 m_installed_addons.end());
277 AddonManager::enable_addon(const AddonId& addon_id)
279 log_debug << "enabling addon " << addon_id << std::endl;
280 Addon& addon = get_installed_addon(addon_id);
281 if (addon.is_enabled())
283 log_warning << "Tried enabling already enabled Add-on" << std::endl;
287 log_debug << "Adding archive \"" << addon.get_install_filename() << "\" to search path" << std::endl;
288 //int PHYSFS_mount(addon.installed_install_filename.c_str(), "addons/", 0)
289 if (PHYSFS_addToSearchPath(addon.get_install_filename().c_str(), 0) == 0)
291 log_warning << "Could not add " << addon.get_install_filename() << " to search path: "
292 << PHYSFS_getLastError() << std::endl;
296 addon.set_enabled(true);
302 AddonManager::disable_addon(const AddonId& addon_id)
304 log_debug << "disabling addon " << addon_id << std::endl;
305 Addon& addon = get_installed_addon(addon_id);
306 if (!addon.is_enabled())
308 log_warning << "Tried disabling already disabled Add-On" << std::endl;
312 log_debug << "Removing archive \"" << addon.get_install_filename() << "\" from search path" << std::endl;
313 if (PHYSFS_removeFromSearchPath(addon.get_install_filename().c_str()) == 0)
315 log_warning << "Could not remove " << addon.get_install_filename() << " from search path: "
316 << PHYSFS_getLastError() << std::endl;
320 addon.set_enabled(false);
325 std::vector<std::string>
326 AddonManager::scan_for_archives() const
328 std::vector<std::string> archives;
330 // Search for archives and add them to the search path
331 std::unique_ptr<char*, decltype(&PHYSFS_freeList)>
332 rc(PHYSFS_enumerateFiles(m_addon_directory.c_str()),
334 for(char** i = rc.get(); *i != 0; ++i)
336 if (has_suffix(*i, ".zip"))
338 std::string archive = FileSystem::join(m_addon_directory, *i);
339 if (PHYSFS_exists(archive.c_str()))
341 archives.push_back(archive);
350 AddonManager::scan_for_info(const std::string& archive_os_path) const
352 std::unique_ptr<char*, decltype(&PHYSFS_freeList)>
353 rc2(PHYSFS_enumerateFiles("/"),
355 for(char** j = rc2.get(); *j != 0; ++j)
357 if (has_suffix(*j, ".nfo"))
359 std::string nfo_filename = FileSystem::join("/", *j);
361 // make sure it's in the current archive_os_path
362 const char* realdir = PHYSFS_getRealDir(nfo_filename.c_str());
365 log_warning << "PHYSFS_getRealDir() failed for " << nfo_filename << ": " << PHYSFS_getLastError() << std::endl;
369 if (realdir == archive_os_path)
377 return std::string();
381 AddonManager::add_installed_archive(const std::string& archive, const std::string& md5)
383 const char* realdir = PHYSFS_getRealDir(archive.c_str());
386 log_warning << "PHYSFS_getRealDir() failed for " << archive << ": "
387 << PHYSFS_getLastError() << std::endl;
391 std::string os_path = FileSystem::join(realdir, archive);
393 PHYSFS_addToSearchPath(os_path.c_str(), 0);
395 std::string nfo_filename = scan_for_info(os_path);
397 if (nfo_filename.empty())
399 log_warning << "Couldn't find .nfo file for " << os_path << std::endl;
405 std::unique_ptr<Addon> addon = Addon::parse(nfo_filename);
406 addon->set_install_filename(os_path, md5);
407 m_installed_addons.push_back(std::move(addon));
409 catch (const std::runtime_error& e)
411 log_warning << "Could not load add-on info for " << archive << ": " << e.what() << std::endl;
415 PHYSFS_removeFromSearchPath(os_path.c_str());
420 AddonManager::add_installed_addons()
422 auto archives = scan_for_archives();
424 for(auto archive : archives)
426 MD5 md5 = md5_from_file(archive);
427 add_installed_archive(archive, md5.hex_digest());
431 AddonManager::AddonList
432 AddonManager::parse_addon_infos(const std::string& addoninfos) const
439 std::stringstream addoninfos_stream(addoninfos);
440 const lisp::Lisp* root = parser.parse(addoninfos_stream, "supertux-addons");
441 const lisp::Lisp* addons_lisp = root->get_lisp("supertux-addons");
444 throw std::runtime_error("Downloaded file is not an Add-on list");
448 lisp::ListIterator iter(addons_lisp);
451 const std::string& token = iter.item();
452 if(token != "supertux-addoninfo")
454 log_warning << "Unknown token '" << token << "' in Add-on list" << std::endl;
458 std::unique_ptr<Addon> addon = Addon::parse(*iter.lisp());
459 m_addons.push_back(std::move(addon));
466 catch(const std::exception& e)
468 std::stringstream msg;
469 msg << "Problem when reading Add-on list: " << e.what();
470 throw std::runtime_error(msg.str());