src/addon/addon_manager.cpp

   1 //  SuperTux - Add-on Manager
   2 //  Copyright (C) 2007 Christoph Sommer <christoph.sommer@2007.expires.deltadevelopment.de>
   3 //                2014 Ingo Ruhnke <grumbel@gmail.com>
   4 //
   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.
   9 //
  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.
  14 //
  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/>.
  17
  18 #include "addon/addon_manager.hpp"
  19
  20 #include <config.h>
  21 #include <version.h>
  22
  23 #include <algorithm>
  24 #include <iostream>
  25 #include <memory>
  26 #include <physfs.h>
  27 #include <sstream>
  28 #include <stdexcept>
  29 #include <stdio.h>
  30 #include <sys/stat.h>
  31
  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"
  40
  41 namespace {
  42
  43 MD5 md5_from_file(const std::string& filename)
  44 {
  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();
  48
  49   MD5 md5;
  50
  51   unsigned char buffer[1024];
  52   PHYSFS_file* file = PHYSFS_openRead(filename.c_str());
  53   while (true)
  54   {
  55     PHYSFS_sint64 len = PHYSFS_read(file, buffer, 1, sizeof(buffer));
  56     if (len <= 0) break;
  57     md5.update(buffer, len);
  58   }
  59   PHYSFS_close(file);
  60
  61   return md5;
  62 }
  63
  64 bool has_suffix(const std::string& str, const std::string& suffix)
  65 {
  66   if (str.length() >= suffix.length())
  67     return str.compare(str.length() - suffix.length(), suffix.length(), suffix) == 0;
  68   else
  69     return false;
  70 }
  71
  72 } // namespace
  73
  74 AddonManager::AddonManager(const std::string& addon_directory,
  75                            std::vector<std::string>& ignored_addon_ids) :
  76   m_downloader(),
  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),
  81   m_installed_addons(),
  82   m_repository_addons()
  83 {
  84   PHYSFS_mkdir(m_addon_directory.c_str());
  85
  86   add_installed_addons();
  87   for(auto& addon : m_installed_addons)
  88   {
  89     if (std::find(m_ignored_addon_ids.begin(), m_ignored_addon_ids.end(),
  90                   addon->get_id()) != m_ignored_addon_ids.end())
  91     {
  92       enable_addon(addon->get_id());
  93     }
  94   }
  95 }
  96
  97 AddonManager::~AddonManager()
  98 {
  99 }
 100
 101 Addon&
 102 AddonManager::get_repository_addon(const AddonId& id)
 103 {
 104   auto it = std::find_if(m_repository_addons.begin(), m_repository_addons.end(),
 105                          [&id](const std::unique_ptr<Addon>& addon)
 106                          {
 107                            return addon->get_id() == id;
 108                          });
 109
 110   if (it != m_repository_addons.end())
 111   {
 112     return **it;
 113   }
 114   else
 115   {
 116     throw std::runtime_error("Couldn't find repository Addon with id: " + id);
 117   }
 118 }
 119
 120 Addon&
 121 AddonManager::get_installed_addon(const AddonId& id)
 122 {
 123   auto it = std::find_if(m_installed_addons.begin(), m_installed_addons.end(),
 124                          [&id](const std::unique_ptr<Addon>& addon)
 125                          {
 126                            return addon->get_id() == id;
 127                          });
 128
 129   if (it != m_installed_addons.end())
 130   {
 131     return **it;
 132   }
 133   else
 134   {
 135     throw std::runtime_error("Couldn't find installed Addon with id: " + id);
 136   }
 137 }
 138
 139 std::vector<AddonId>
 140 AddonManager::get_repository_addons() const
 141 {
 142   std::vector<AddonId> results;
 143   results.reserve(m_repository_addons.size());
 144   std::transform(m_repository_addons.begin(), m_repository_addons.end(),
 145                  std::back_inserter(results),
 146                  [](const std::unique_ptr<Addon>& addon)
 147                  {
 148                    return addon->get_id();
 149                  });
 150   return results;
 151 }
 152
 153
 154 std::vector<AddonId>
 155 AddonManager::get_installed_addons() const
 156 {
 157   std::vector<AddonId> results;
 158   results.reserve(m_installed_addons.size());
 159   std::transform(m_installed_addons.begin(), m_installed_addons.end(),
 160                  std::back_inserter(results),
 161                  [](const std::unique_ptr<Addon>& addon)
 162                  {
 163                    return addon->get_id();
 164                  });
 165   return results;
 166 }
 167
 168 bool
 169 AddonManager::has_online_support() const
 170 {
 171   return true;
 172 }
 173
 174 void
 175 AddonManager::check_online()
 176 {
 177   std::string addoninfos = m_downloader.download(m_repository_url);
 178   m_repository_addons = parse_addon_infos(addoninfos);
 179 }
 180
 181 void
 182 AddonManager::install_addon(const AddonId& addon_id)
 183 {
 184   log_debug << "installing addon " << addon_id << std::endl;
 185   Addon& repository_addon = get_repository_addon(addon_id);
 186
 187   std::string install_filename = FileSystem::join(m_addon_directory, repository_addon.get_filename());
 188
 189   m_downloader.download(repository_addon.get_http_url(), install_filename);
 190
 191   MD5 md5 = md5_from_file(install_filename);
 192   if (repository_addon.get_md5() != md5.hex_digest())
 193   {
 194     if (PHYSFS_delete(install_filename.c_str()) == 0)
 195     {
 196       log_warning << "PHYSFS_delete failed: " << PHYSFS_getLastError() << std::endl;
 197     }
 198
 199     throw std::runtime_error("Downloading Add-on failed: MD5 checksums differ");
 200   }
 201   else
 202   {
 203     const char* realdir = PHYSFS_getRealDir(install_filename.c_str());
 204     if (!realdir)
 205     {
 206       throw std::runtime_error("PHYSFS_getRealDir failed: " + install_filename);
 207     }
 208     else
 209     {
 210       add_installed_archive(install_filename);
 211     }
 212   }
 213 }
 214
 215 void
 216 AddonManager::uninstall_addon(const AddonId& addon_id)
 217 {
 218   log_debug << "uninstalling addon " << addon_id << std::endl;
 219   Addon& addon = get_installed_addon(addon_id);
 220   if (addon.is_enabled())
 221   {
 222     disable_addon(addon_id);
 223   }
 224   log_debug << "deleting file \"" << addon.get_install_filename() << "\"" << std::endl;
 225   PHYSFS_delete(addon.get_install_filename().c_str());
 226   m_installed_addons.erase(std::remove_if(m_installed_addons.begin(), m_installed_addons.end(),
 227                                           [&addon](const std::unique_ptr<Addon>& rhs)
 228                                           {
 229                                             return addon.get_id() == rhs->get_id();
 230                                           }),
 231                            m_installed_addons.end());
 232 }
 233
 234 void
 235 AddonManager::enable_addon(const AddonId& addon_id)
 236 {
 237   log_debug << "enabling addon " << addon_id << std::endl;
 238   Addon& addon = get_installed_addon(addon_id);
 239   if (addon.is_enabled())
 240   {
 241     log_warning << "Tried enabling already enabled Add-on" << std::endl;
 242   }
 243   else
 244   {
 245     log_debug << "Adding archive \"" << addon.get_install_filename() << "\" to search path" << std::endl;
 246     //int PHYSFS_mount(addon.installed_install_filename.c_str(), "addons/", 0)
 247     if (PHYSFS_addToSearchPath(addon.get_install_filename().c_str(), 0) == 0)
 248     {
 249       log_warning << "Could not add " << addon.get_install_filename() << " to search path: "
 250                   << PHYSFS_getLastError() << std::endl;
 251     }
 252     else
 253     {
 254       addon.set_enabled(true);
 255     }
 256   }
 257 }
 258
 259 void
 260 AddonManager::disable_addon(const AddonId& addon_id)
 261 {
 262   log_debug << "disabling addon " << addon_id << std::endl;
 263   Addon& addon = get_installed_addon(addon_id);
 264   if (!addon.is_enabled())
 265   {
 266     log_warning << "Tried disabling already disabled Add-On" << std::endl;
 267   }
 268   else
 269   {
 270     log_debug << "Removing archive \"" << addon.get_install_filename() << "\" from search path" << std::endl;
 271     if (PHYSFS_removeFromSearchPath(addon.get_install_filename().c_str()) == 0)
 272     {
 273       log_warning << "Could not remove " << addon.get_install_filename() << " from search path: "
 274                   << PHYSFS_getLastError() << std::endl;
 275     }
 276     else
 277     {
 278       addon.set_enabled(false);
 279     }
 280   }
 281 }
 282
 283 std::vector<std::string>
 284 AddonManager::scan_for_archives() const
 285 {
 286   std::vector<std::string> archives;
 287
 288   // Search for archives and add them to the search path
 289   std::unique_ptr<char*, decltype(&PHYSFS_freeList)>
 290     rc(PHYSFS_enumerateFiles(m_addon_directory.c_str()),
 291        PHYSFS_freeList);
 292   for(char** i = rc.get(); *i != 0; ++i)
 293   {
 294     if (has_suffix(*i, ".zip"))
 295     {
 296       std::string archive = FileSystem::join(m_addon_directory, *i);
 297       if (PHYSFS_exists(archive.c_str()))
 298       {
 299         archives.push_back(archive);
 300       }
 301     }
 302   }
 303
 304   return archives;
 305 }
 306
 307 std::string
 308 AddonManager::scan_for_info(const std::string& archive_os_path) const
 309 {
 310   std::unique_ptr<char*, decltype(&PHYSFS_freeList)>
 311     rc2(PHYSFS_enumerateFiles("/"),
 312         PHYSFS_freeList);
 313   for(char** j = rc2.get(); *j != 0; ++j)
 314   {
 315     log_debug << "enumerating: " << std::string(*j) << std::endl;
 316     if (has_suffix(*j, ".nfo"))
 317     {
 318       std::string nfo_filename = FileSystem::join("/", *j);
 319
 320       // make sure it's in the current archive_os_path
 321       const char* realdir = PHYSFS_getRealDir(nfo_filename.c_str());
 322       if (!realdir)
 323       {
 324         log_warning << "PHYSFS_getRealDir() failed for " << nfo_filename << ": " << PHYSFS_getLastError() << std::endl;
 325       }
 326       else
 327       {
 328         log_debug << "compare: " << realdir << " " << archive_os_path << std::endl;
 329         if (realdir == archive_os_path)
 330         {
 331           return nfo_filename;
 332         }
 333       }
 334     }
 335   }
 336
 337   return std::string();
 338 }
 339
 340 void
 341 AddonManager::add_installed_archive(const std::string& archive)
 342 {
 343   const char* realdir = PHYSFS_getRealDir(archive.c_str());
 344   if (!realdir)
 345   {
 346     log_warning << "PHYSFS_getRealDir() failed for " << archive << ": "
 347                 << PHYSFS_getLastError() << std::endl;
 348   }
 349   else
 350   {
 351     std::string os_path = FileSystem::join(realdir, archive);
 352
 353     PHYSFS_addToSearchPath(os_path.c_str(), 0);
 354
 355     std::string nfo_filename = scan_for_info(os_path);
 356
 357     if (nfo_filename.empty())
 358     {
 359       log_warning << "Couldn't find .nfo file for " << os_path << std::endl;
 360     }
 361     else
 362     {
 363       try
 364       {
 365         std::unique_ptr<Addon> addon = Addon::parse(nfo_filename);
 366         addon->set_install_filename(os_path);
 367         m_installed_addons.push_back(std::move(addon));
 368       }
 369       catch (const std::runtime_error& e)
 370       {
 371         log_warning << "Could not load add-on info for " << archive << ": " << e.what() << std::endl;
 372       }
 373     }
 374
 375     PHYSFS_removeFromSearchPath(os_path.c_str());
 376   }
 377 }
 378
 379 void
 380 AddonManager::add_installed_addons()
 381 {
 382   auto archives = scan_for_archives();
 383
 384   for(auto archive : archives)
 385   {
 386     add_installed_archive(archive);
 387   }
 388 }
 389
 390 AddonManager::AddonList
 391 AddonManager::parse_addon_infos(const std::string& addoninfos) const
 392 {
 393   AddonList m_addons;
 394
 395   try
 396   {
 397     lisp::Parser parser;
 398     std::stringstream addoninfos_stream(addoninfos);
 399     const lisp::Lisp* root = parser.parse(addoninfos_stream, "supertux-addons");
 400     const lisp::Lisp* addons_lisp = root->get_lisp("supertux-addons");
 401     if(!addons_lisp)
 402     {
 403       throw std::runtime_error("Downloaded file is not an Add-on list");
 404     }
 405     else
 406     {
 407       lisp::ListIterator iter(addons_lisp);
 408       while(iter.next())
 409       {
 410         const std::string& token = iter.item();
 411         if(token != "supertux-addoninfo")
 412         {
 413           log_warning << "Unknown token '" << token << "' in Add-on list" << std::endl;
 414         }
 415         else
 416         {
 417           std::unique_ptr<Addon> addon = Addon::parse(*iter.lisp());
 418           m_addons.push_back(std::move(addon));
 419         }
 420       }
 421
 422       return m_addons;
 423     }
 424   }
 425   catch(const std::exception& e)
 426   {
 427     std::stringstream msg;
 428     msg << "Problem when reading Add-on list: " << e.what();
 429     throw std::runtime_error(msg.str());
 430   }
 431
 432   return m_addons;
 433 }
 434
 435 /* EOF */