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<std::string>& ignored_addon_ids) :
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_ignored_addon_ids(ignored_addon_ids),
82 m_repository_addons(),
83 m_has_been_updated(false)
85 PHYSFS_mkdir(m_addon_directory.c_str());
87 add_installed_addons();
88 for(auto& addon : m_installed_addons)
90 if (std::find(m_ignored_addon_ids.begin(), m_ignored_addon_ids.end(),
91 addon->get_id()) != m_ignored_addon_ids.end())
93 enable_addon(addon->get_id());
98 AddonManager::~AddonManager()
103 AddonManager::get_repository_addon(const AddonId& id)
105 auto it = std::find_if(m_repository_addons.begin(), m_repository_addons.end(),
106 [&id](const std::unique_ptr<Addon>& addon)
108 return addon->get_id() == id;
111 if (it != m_repository_addons.end())
117 throw std::runtime_error("Couldn't find repository Addon with id: " + id);
122 AddonManager::get_installed_addon(const AddonId& id)
124 auto it = std::find_if(m_installed_addons.begin(), m_installed_addons.end(),
125 [&id](const std::unique_ptr<Addon>& addon)
127 return addon->get_id() == id;
130 if (it != m_installed_addons.end())
136 throw std::runtime_error("Couldn't find installed Addon with id: " + id);
141 AddonManager::get_repository_addons() const
143 std::vector<AddonId> results;
144 results.reserve(m_repository_addons.size());
145 std::transform(m_repository_addons.begin(), m_repository_addons.end(),
146 std::back_inserter(results),
147 [](const std::unique_ptr<Addon>& addon)
149 return addon->get_id();
156 AddonManager::get_installed_addons() const
158 std::vector<AddonId> results;
159 results.reserve(m_installed_addons.size());
160 std::transform(m_installed_addons.begin(), m_installed_addons.end(),
161 std::back_inserter(results),
162 [](const std::unique_ptr<Addon>& addon)
164 return addon->get_id();
170 AddonManager::has_online_support() const
176 AddonManager::has_been_updated() const
178 return m_has_been_updated;
182 AddonManager::check_online()
184 std::string addoninfos = m_downloader.download(m_repository_url);
185 m_repository_addons = parse_addon_infos(addoninfos);
186 m_has_been_updated = true;
190 AddonManager::install_addon(const AddonId& addon_id)
192 { // remove addon if it already exists
193 auto it = std::find_if(m_installed_addons.begin(), m_installed_addons.end(),
194 [&addon_id](const std::unique_ptr<Addon>& addon)
196 return addon->get_id() == addon_id;
198 if (it != m_installed_addons.end())
200 log_debug << "reinstalling addon " << addon_id << std::endl;
201 if ((*it)->is_enabled())
203 disable_addon((*it)->get_id());
205 m_installed_addons.erase(it);
209 log_debug << "installing addon " << addon_id << std::endl;
213 Addon& repository_addon = get_repository_addon(addon_id);
215 std::string install_filename = FileSystem::join(m_addon_directory, repository_addon.get_filename());
217 m_downloader.download(repository_addon.get_http_url(), install_filename);
219 MD5 md5 = md5_from_file(install_filename);
220 if (repository_addon.get_md5() != md5.hex_digest())
222 if (PHYSFS_delete(install_filename.c_str()) == 0)
224 log_warning << "PHYSFS_delete failed: " << PHYSFS_getLastError() << std::endl;
227 throw std::runtime_error("Downloading Add-on failed: MD5 checksums differ");
231 const char* realdir = PHYSFS_getRealDir(install_filename.c_str());
234 throw std::runtime_error("PHYSFS_getRealDir failed: " + install_filename);
238 add_installed_archive(install_filename, md5.hex_digest());
244 AddonManager::uninstall_addon(const AddonId& addon_id)
246 log_debug << "uninstalling addon " << addon_id << std::endl;
247 Addon& addon = get_installed_addon(addon_id);
248 if (addon.is_enabled())
250 disable_addon(addon_id);
252 log_debug << "deleting file \"" << addon.get_install_filename() << "\"" << std::endl;
253 PHYSFS_delete(addon.get_install_filename().c_str());
254 m_installed_addons.erase(std::remove_if(m_installed_addons.begin(), m_installed_addons.end(),
255 [&addon](const std::unique_ptr<Addon>& rhs)
257 return addon.get_id() == rhs->get_id();
259 m_installed_addons.end());
263 AddonManager::enable_addon(const AddonId& addon_id)
265 log_debug << "enabling addon " << addon_id << std::endl;
266 Addon& addon = get_installed_addon(addon_id);
267 if (addon.is_enabled())
269 log_warning << "Tried enabling already enabled Add-on" << std::endl;
273 log_debug << "Adding archive \"" << addon.get_install_filename() << "\" to search path" << std::endl;
274 //int PHYSFS_mount(addon.installed_install_filename.c_str(), "addons/", 0)
275 if (PHYSFS_addToSearchPath(addon.get_install_filename().c_str(), 0) == 0)
277 log_warning << "Could not add " << addon.get_install_filename() << " to search path: "
278 << PHYSFS_getLastError() << std::endl;
282 addon.set_enabled(true);
288 AddonManager::disable_addon(const AddonId& addon_id)
290 log_debug << "disabling addon " << addon_id << std::endl;
291 Addon& addon = get_installed_addon(addon_id);
292 if (!addon.is_enabled())
294 log_warning << "Tried disabling already disabled Add-On" << std::endl;
298 log_debug << "Removing archive \"" << addon.get_install_filename() << "\" from search path" << std::endl;
299 if (PHYSFS_removeFromSearchPath(addon.get_install_filename().c_str()) == 0)
301 log_warning << "Could not remove " << addon.get_install_filename() << " from search path: "
302 << PHYSFS_getLastError() << std::endl;
306 addon.set_enabled(false);
311 std::vector<std::string>
312 AddonManager::scan_for_archives() const
314 std::vector<std::string> archives;
316 // Search for archives and add them to the search path
317 std::unique_ptr<char*, decltype(&PHYSFS_freeList)>
318 rc(PHYSFS_enumerateFiles(m_addon_directory.c_str()),
320 for(char** i = rc.get(); *i != 0; ++i)
322 if (has_suffix(*i, ".zip"))
324 std::string archive = FileSystem::join(m_addon_directory, *i);
325 if (PHYSFS_exists(archive.c_str()))
327 archives.push_back(archive);
336 AddonManager::scan_for_info(const std::string& archive_os_path) const
338 std::unique_ptr<char*, decltype(&PHYSFS_freeList)>
339 rc2(PHYSFS_enumerateFiles("/"),
341 for(char** j = rc2.get(); *j != 0; ++j)
343 if (has_suffix(*j, ".nfo"))
345 std::string nfo_filename = FileSystem::join("/", *j);
347 // make sure it's in the current archive_os_path
348 const char* realdir = PHYSFS_getRealDir(nfo_filename.c_str());
351 log_warning << "PHYSFS_getRealDir() failed for " << nfo_filename << ": " << PHYSFS_getLastError() << std::endl;
355 if (realdir == archive_os_path)
363 return std::string();
367 AddonManager::add_installed_archive(const std::string& archive, const std::string& md5)
369 const char* realdir = PHYSFS_getRealDir(archive.c_str());
372 log_warning << "PHYSFS_getRealDir() failed for " << archive << ": "
373 << PHYSFS_getLastError() << std::endl;
377 std::string os_path = FileSystem::join(realdir, archive);
379 PHYSFS_addToSearchPath(os_path.c_str(), 0);
381 std::string nfo_filename = scan_for_info(os_path);
383 if (nfo_filename.empty())
385 log_warning << "Couldn't find .nfo file for " << os_path << std::endl;
391 std::unique_ptr<Addon> addon = Addon::parse(nfo_filename);
392 addon->set_install_filename(os_path, md5);
393 m_installed_addons.push_back(std::move(addon));
395 catch (const std::runtime_error& e)
397 log_warning << "Could not load add-on info for " << archive << ": " << e.what() << std::endl;
401 PHYSFS_removeFromSearchPath(os_path.c_str());
406 AddonManager::add_installed_addons()
408 auto archives = scan_for_archives();
410 for(auto archive : archives)
412 MD5 md5 = md5_from_file(archive);
413 add_installed_archive(archive, md5.hex_digest());
417 AddonManager::AddonList
418 AddonManager::parse_addon_infos(const std::string& addoninfos) const
425 std::stringstream addoninfos_stream(addoninfos);
426 const lisp::Lisp* root = parser.parse(addoninfos_stream, "supertux-addons");
427 const lisp::Lisp* addons_lisp = root->get_lisp("supertux-addons");
430 throw std::runtime_error("Downloaded file is not an Add-on list");
434 lisp::ListIterator iter(addons_lisp);
437 const std::string& token = iter.item();
438 if(token != "supertux-addoninfo")
440 log_warning << "Unknown token '" << token << "' in Add-on list" << std::endl;
444 std::unique_ptr<Addon> addon = Addon::parse(*iter.lisp());
445 m_addons.push_back(std::move(addon));
452 catch(const std::exception& e)
454 std::stringstream msg;
455 msg << "Problem when reading Add-on list: " << e.what();
456 throw std::runtime_error(msg.str());