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_4_0.nfo"),
79 m_addon_config(addon_config),
81 m_repository_addons(),
82 m_has_been_updated(false)
84 PHYSFS_mkdir(m_addon_directory.c_str());
86 add_installed_addons();
88 // FIXME: We should also restore the order here
89 for(auto& addon : m_addon_config)
95 enable_addon(addon.id);
97 catch(const std::exception& err)
99 log_warning << "failed to enable addon from config: " << err.what() << std::endl;
105 AddonManager::~AddonManager()
107 // sync enabled/disabled addons into the config for saving
108 m_addon_config.clear();
109 for(auto& addon : m_installed_addons)
111 m_addon_config.push_back({addon->get_id(), addon->is_enabled()});
116 AddonManager::get_repository_addon(const AddonId& id)
118 auto it = std::find_if(m_repository_addons.begin(), m_repository_addons.end(),
119 [&id](const std::unique_ptr<Addon>& addon)
121 return addon->get_id() == id;
124 if (it != m_repository_addons.end())
130 throw std::runtime_error("Couldn't find repository Addon with id: " + id);
135 AddonManager::get_installed_addon(const AddonId& id)
137 auto it = std::find_if(m_installed_addons.begin(), m_installed_addons.end(),
138 [&id](const std::unique_ptr<Addon>& addon)
140 return addon->get_id() == id;
143 if (it != m_installed_addons.end())
149 throw std::runtime_error("Couldn't find installed Addon with id: " + id);
154 AddonManager::get_repository_addons() const
156 std::vector<AddonId> results;
157 results.reserve(m_repository_addons.size());
158 std::transform(m_repository_addons.begin(), m_repository_addons.end(),
159 std::back_inserter(results),
160 [](const std::unique_ptr<Addon>& addon)
162 return addon->get_id();
169 AddonManager::get_installed_addons() const
171 std::vector<AddonId> results;
172 results.reserve(m_installed_addons.size());
173 std::transform(m_installed_addons.begin(), m_installed_addons.end(),
174 std::back_inserter(results),
175 [](const std::unique_ptr<Addon>& addon)
177 return addon->get_id();
183 AddonManager::has_online_support() const
189 AddonManager::has_been_updated() const
191 return m_has_been_updated;
195 AddonManager::check_online()
197 std::string addoninfos = m_downloader.download(m_repository_url);
198 m_repository_addons = parse_addon_infos(addoninfos);
199 m_has_been_updated = true;
203 AddonManager::install_addon(const AddonId& addon_id)
205 { // remove addon if it already exists
206 auto it = std::find_if(m_installed_addons.begin(), m_installed_addons.end(),
207 [&addon_id](const std::unique_ptr<Addon>& addon)
209 return addon->get_id() == addon_id;
211 if (it != m_installed_addons.end())
213 log_debug << "reinstalling addon " << addon_id << std::endl;
214 if ((*it)->is_enabled())
216 disable_addon((*it)->get_id());
218 m_installed_addons.erase(it);
222 log_debug << "installing addon " << addon_id << std::endl;
226 Addon& repository_addon = get_repository_addon(addon_id);
228 std::string install_filename = FileSystem::join(m_addon_directory, repository_addon.get_filename());
230 m_downloader.download(repository_addon.get_url(), install_filename);
232 MD5 md5 = md5_from_file(install_filename);
233 if (repository_addon.get_md5() != md5.hex_digest())
235 if (PHYSFS_delete(install_filename.c_str()) == 0)
237 log_warning << "PHYSFS_delete failed: " << PHYSFS_getLastError() << std::endl;
240 throw std::runtime_error("Downloading Add-on failed: MD5 checksums differ");
244 const char* realdir = PHYSFS_getRealDir(install_filename.c_str());
247 throw std::runtime_error("PHYSFS_getRealDir failed: " + install_filename);
251 add_installed_archive(install_filename, md5.hex_digest());
257 AddonManager::uninstall_addon(const AddonId& addon_id)
259 log_debug << "uninstalling addon " << addon_id << std::endl;
260 Addon& addon = get_installed_addon(addon_id);
261 if (addon.is_enabled())
263 disable_addon(addon_id);
265 log_debug << "deleting file \"" << addon.get_install_filename() << "\"" << std::endl;
266 PHYSFS_delete(addon.get_install_filename().c_str());
267 m_installed_addons.erase(std::remove_if(m_installed_addons.begin(), m_installed_addons.end(),
268 [&addon](const std::unique_ptr<Addon>& rhs)
270 return addon.get_id() == rhs->get_id();
272 m_installed_addons.end());
276 AddonManager::enable_addon(const AddonId& addon_id)
278 log_debug << "enabling addon " << addon_id << std::endl;
279 Addon& addon = get_installed_addon(addon_id);
280 if (addon.is_enabled())
282 log_warning << "Tried enabling already enabled Add-on" << std::endl;
286 log_debug << "Adding archive \"" << addon.get_install_filename() << "\" to search path" << std::endl;
287 //int PHYSFS_mount(addon.installed_install_filename.c_str(), "addons/", 0)
288 if (PHYSFS_addToSearchPath(addon.get_install_filename().c_str(), 0) == 0)
290 log_warning << "Could not add " << addon.get_install_filename() << " to search path: "
291 << PHYSFS_getLastError() << std::endl;
295 addon.set_enabled(true);
301 AddonManager::disable_addon(const AddonId& addon_id)
303 log_debug << "disabling addon " << addon_id << std::endl;
304 Addon& addon = get_installed_addon(addon_id);
305 if (!addon.is_enabled())
307 log_warning << "Tried disabling already disabled Add-On" << std::endl;
311 log_debug << "Removing archive \"" << addon.get_install_filename() << "\" from search path" << std::endl;
312 if (PHYSFS_removeFromSearchPath(addon.get_install_filename().c_str()) == 0)
314 log_warning << "Could not remove " << addon.get_install_filename() << " from search path: "
315 << PHYSFS_getLastError() << std::endl;
319 addon.set_enabled(false);
324 std::vector<std::string>
325 AddonManager::scan_for_archives() const
327 std::vector<std::string> archives;
329 // Search for archives and add them to the search path
330 std::unique_ptr<char*, decltype(&PHYSFS_freeList)>
331 rc(PHYSFS_enumerateFiles(m_addon_directory.c_str()),
333 for(char** i = rc.get(); *i != 0; ++i)
335 if (has_suffix(*i, ".zip"))
337 std::string archive = FileSystem::join(m_addon_directory, *i);
338 if (PHYSFS_exists(archive.c_str()))
340 archives.push_back(archive);
349 AddonManager::scan_for_info(const std::string& archive_os_path) const
351 std::unique_ptr<char*, decltype(&PHYSFS_freeList)>
352 rc2(PHYSFS_enumerateFiles("/"),
354 for(char** j = rc2.get(); *j != 0; ++j)
356 if (has_suffix(*j, ".nfo"))
358 std::string nfo_filename = FileSystem::join("/", *j);
360 // make sure it's in the current archive_os_path
361 const char* realdir = PHYSFS_getRealDir(nfo_filename.c_str());
364 log_warning << "PHYSFS_getRealDir() failed for " << nfo_filename << ": " << PHYSFS_getLastError() << std::endl;
368 if (realdir == archive_os_path)
376 return std::string();
380 AddonManager::add_installed_archive(const std::string& archive, const std::string& md5)
382 const char* realdir = PHYSFS_getRealDir(archive.c_str());
385 log_warning << "PHYSFS_getRealDir() failed for " << archive << ": "
386 << PHYSFS_getLastError() << std::endl;
390 std::string os_path = FileSystem::join(realdir, archive);
392 PHYSFS_addToSearchPath(os_path.c_str(), 0);
394 std::string nfo_filename = scan_for_info(os_path);
396 if (nfo_filename.empty())
398 log_warning << "Couldn't find .nfo file for " << os_path << std::endl;
404 std::unique_ptr<Addon> addon = Addon::parse(nfo_filename);
405 addon->set_install_filename(os_path, md5);
406 m_installed_addons.push_back(std::move(addon));
408 catch (const std::runtime_error& e)
410 log_warning << "Could not load add-on info for " << archive << ": " << e.what() << std::endl;
414 PHYSFS_removeFromSearchPath(os_path.c_str());
419 AddonManager::add_installed_addons()
421 auto archives = scan_for_archives();
423 for(auto archive : archives)
425 MD5 md5 = md5_from_file(archive);
426 add_installed_archive(archive, md5.hex_digest());
430 AddonManager::AddonList
431 AddonManager::parse_addon_infos(const std::string& addoninfos) const
438 std::stringstream addoninfos_stream(addoninfos);
439 const lisp::Lisp* root = parser.parse(addoninfos_stream, "supertux-addons");
440 const lisp::Lisp* addons_lisp = root->get_lisp("supertux-addons");
443 throw std::runtime_error("Downloaded file is not an Add-on list");
447 lisp::ListIterator iter(addons_lisp);
450 const std::string& token = iter.item();
451 if(token != "supertux-addoninfo")
453 log_warning << "Unknown token '" << token << "' in Add-on list" << std::endl;
457 std::unique_ptr<Addon> addon = Addon::parse(*iter.lisp());
458 m_addons.push_back(std::move(addon));
465 catch(const std::exception& e)
467 std::stringstream msg;
468 msg << "Problem when reading Add-on list: " << e.what();
469 throw std::runtime_error(msg.str());