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   PHYSFS_file* file = PHYSFS_openRead(filename.c_str());
  52   if (!file)
  53   {
  54     std::ostringstream out;
  55     out << "PHYSFS_openRead() failed: " << PHYSFS_getLastError();
  56     throw std::runtime_error(out.str());
  57   }
  58   else
  59   {
  60     while (true)
  61     {
  62       unsigned char buffer[1024];
  63       PHYSFS_sint64 len = PHYSFS_read(file, buffer, 1, sizeof(buffer));
  64       if (len <= 0) break;
  65       md5.update(buffer, len);
  66     }
  67     PHYSFS_close(file);
  68
  69     return md5;
  70   }
  71 }
  72
  73 bool has_suffix(const std::string& str, const std::string& suffix)
  74 {
  75   if (str.length() >= suffix.length())
  76     return str.compare(str.length() - suffix.length(), suffix.length(), suffix) == 0;
  77   else
  78     return false;
  79 }
  80
  81 } // namespace
  82
  83 AddonManager::AddonManager(const std::string& addon_directory,
  84                            std::vector<Config::Addon>& addon_config) :
  85   m_downloader(),
  86   m_addon_directory(addon_directory),
  87   m_repository_url("https://raw.githubusercontent.com/SuperTuxTeam/addons/master/index-0_4_0.nfo"),
  88   m_addon_config(addon_config),
  89   m_installed_addons(),
  90   m_repository_addons(),
  91   m_has_been_updated(false),
  92   m_transfer_status()
  93 {
  94   PHYSFS_mkdir(m_addon_directory.c_str());
  95
  96   add_installed_addons();
  97
  98   // FIXME: We should also restore the order here
  99   for(auto& addon : m_addon_config)
 100   {
 101     if (addon.enabled)
 102     {
 103       try
 104       {
 105         enable_addon(addon.id);
 106       }
 107       catch(const std::exception& err)
 108       {
 109         log_warning << "failed to enable addon from config: " << err.what() << std::endl;
 110       }
 111     }
 112   }
 113
 114   try
 115   {
 116     m_repository_addons = parse_addon_infos("/addons/repository.nfo");
 117   }
 118   catch(const std::exception& err)
 119   {
 120     log_warning << "parsing repository.nfo failed: " << err.what() << std::endl;
 121   }
 122 }
 123
 124 AddonManager::~AddonManager()
 125 {
 126   // sync enabled/disabled addons into the config for saving
 127   m_addon_config.clear();
 128   for(auto& addon : m_installed_addons)
 129   {
 130     m_addon_config.push_back({addon->get_id(), addon->is_enabled()});
 131   }
 132 }
 133
 134 Addon&
 135 AddonManager::get_repository_addon(const AddonId& id)
 136 {
 137   auto it = std::find_if(m_repository_addons.begin(), m_repository_addons.end(),
 138                          [&id](const std::unique_ptr<Addon>& addon)
 139                          {
 140                            return addon->get_id() == id;
 141                          });
 142
 143   if (it != m_repository_addons.end())
 144   {
 145     return **it;
 146   }
 147   else
 148   {
 149     throw std::runtime_error("Couldn't find repository Addon with id: " + id);
 150   }
 151 }
 152
 153 Addon&
 154 AddonManager::get_installed_addon(const AddonId& id)
 155 {
 156   auto it = std::find_if(m_installed_addons.begin(), m_installed_addons.end(),
 157                          [&id](const std::unique_ptr<Addon>& addon)
 158                          {
 159                            return addon->get_id() == id;
 160                          });
 161
 162   if (it != m_installed_addons.end())
 163   {
 164     return **it;
 165   }
 166   else
 167   {
 168     throw std::runtime_error("Couldn't find installed Addon with id: " + id);
 169   }
 170 }
 171
 172 std::vector<AddonId>
 173 AddonManager::get_repository_addons() const
 174 {
 175   std::vector<AddonId> results;
 176   results.reserve(m_repository_addons.size());
 177   std::transform(m_repository_addons.begin(), m_repository_addons.end(),
 178                  std::back_inserter(results),
 179                  [](const std::unique_ptr<Addon>& addon)
 180                  {
 181                    return addon->get_id();
 182                  });
 183   return results;
 184 }
 185
 186
 187 std::vector<AddonId>
 188 AddonManager::get_installed_addons() const
 189 {
 190   std::vector<AddonId> results;
 191   results.reserve(m_installed_addons.size());
 192   std::transform(m_installed_addons.begin(), m_installed_addons.end(),
 193                  std::back_inserter(results),
 194                  [](const std::unique_ptr<Addon>& addon)
 195                  {
 196                    return addon->get_id();
 197                  });
 198   return results;
 199 }
 200
 201 bool
 202 AddonManager::has_online_support() const
 203 {
 204   return true;
 205 }
 206
 207 bool
 208 AddonManager::has_been_updated() const
 209 {
 210   return m_has_been_updated;
 211 }
 212
 213 TransferStatusPtr
 214 AddonManager::request_check_online()
 215 {
 216   if (m_transfer_status)
 217   {
 218     throw std::runtime_error("only async request can be made to AddonManager at a time");
 219   }
 220   else
 221   {
 222     m_transfer_status = m_downloader.request_download(m_repository_url, "/addons/repository.nfo");
 223
 224     m_transfer_status->then(
 225       [this](bool success)
 226       {
 227         m_transfer_status = {};
 228
 229         if (success)
 230         {
 231           m_repository_addons = parse_addon_infos("/addons/repository.nfo");
 232           m_has_been_updated = true;
 233         }
 234       });
 235
 236     return m_transfer_status;
 237   }
 238 }
 239
 240 void
 241 AddonManager::check_online()
 242 {
 243   m_downloader.download(m_repository_url, "/addons/repository.nfo");
 244   m_repository_addons = parse_addon_infos("/addons/repository.nfo");
 245   m_has_been_updated = true;
 246 }
 247
 248 TransferStatusPtr
 249 AddonManager::request_install_addon(const AddonId& addon_id)
 250 {
 251   if (m_transfer_status)
 252   {
 253     throw std::runtime_error("only one addon install request allowed at a time");
 254   }
 255   else
 256   {
 257     { // remove addon if it already exists
 258       auto it = std::find_if(m_installed_addons.begin(), m_installed_addons.end(),
 259                              [&addon_id](const std::unique_ptr<Addon>& addon)
 260                              {
 261                                return addon->get_id() == addon_id;
 262                              });
 263       if (it != m_installed_addons.end())
 264       {
 265         log_debug << "reinstalling addon " << addon_id << std::endl;
 266         if ((*it)->is_enabled())
 267         {
 268           disable_addon((*it)->get_id());
 269         }
 270         m_installed_addons.erase(it);
 271       }
 272       else
 273       {
 274         log_debug << "installing addon " << addon_id << std::endl;
 275       }
 276     }
 277
 278     Addon& addon = get_repository_addon(addon_id);
 279
 280     std::string install_filename = FileSystem::join(m_addon_directory, addon.get_filename());
 281
 282     m_transfer_status = m_downloader.request_download(addon.get_url(), install_filename);
 283
 284     m_transfer_status->then(
 285       [this, install_filename, addon_id](bool success)
 286       {
 287         m_transfer_status = {};
 288
 289         if (success)
 290         {
 291           // complete the addon install
 292           Addon& repository_addon = get_repository_addon(addon_id);
 293
 294           MD5 md5 = md5_from_file(install_filename);
 295           if (repository_addon.get_md5() != md5.hex_digest())
 296           {
 297             if (PHYSFS_delete(install_filename.c_str()) == 0)
 298             {
 299               log_warning << "PHYSFS_delete failed: " << PHYSFS_getLastError() << std::endl;
 300             }
 301
 302             throw std::runtime_error("Downloading Add-on failed: MD5 checksums differ");
 303           }
 304           else
 305           {
 306             const char* realdir = PHYSFS_getRealDir(install_filename.c_str());
 307             if (!realdir)
 308             {
 309               throw std::runtime_error("PHYSFS_getRealDir failed: " + install_filename);
 310             }
 311             else
 312             {
 313               add_installed_archive(install_filename, md5.hex_digest());
 314             }
 315           }
 316         }
 317       });
 318
 319     return m_transfer_status;
 320   }
 321 }
 322
 323 void
 324 AddonManager::install_addon(const AddonId& addon_id)
 325 {
 326   { // remove addon if it already exists
 327     auto it = std::find_if(m_installed_addons.begin(), m_installed_addons.end(),
 328                            [&addon_id](const std::unique_ptr<Addon>& addon)
 329                            {
 330                              return addon->get_id() == addon_id;
 331                            });
 332     if (it != m_installed_addons.end())
 333     {
 334       log_debug << "reinstalling addon " << addon_id << std::endl;
 335       if ((*it)->is_enabled())
 336       {
 337         disable_addon((*it)->get_id());
 338       }
 339       m_installed_addons.erase(it);
 340     }
 341     else
 342     {
 343       log_debug << "installing addon " << addon_id << std::endl;
 344     }
 345   }
 346
 347   Addon& repository_addon = get_repository_addon(addon_id);
 348
 349   std::string install_filename = FileSystem::join(m_addon_directory, repository_addon.get_filename());
 350
 351   m_downloader.download(repository_addon.get_url(), install_filename);
 352
 353   MD5 md5 = md5_from_file(install_filename);
 354   if (repository_addon.get_md5() != md5.hex_digest())
 355   {
 356     if (PHYSFS_delete(install_filename.c_str()) == 0)
 357     {
 358       log_warning << "PHYSFS_delete failed: " << PHYSFS_getLastError() << std::endl;
 359     }
 360
 361     throw std::runtime_error("Downloading Add-on failed: MD5 checksums differ");
 362   }
 363   else
 364   {
 365     const char* realdir = PHYSFS_getRealDir(install_filename.c_str());
 366     if (!realdir)
 367     {
 368       throw std::runtime_error("PHYSFS_getRealDir failed: " + install_filename);
 369     }
 370     else
 371     {
 372       add_installed_archive(install_filename, md5.hex_digest());
 373     }
 374   }
 375 }
 376
 377 void
 378 AddonManager::uninstall_addon(const AddonId& addon_id)
 379 {
 380   log_debug << "uninstalling addon " << addon_id << std::endl;
 381   Addon& addon = get_installed_addon(addon_id);
 382   if (addon.is_enabled())
 383   {
 384     disable_addon(addon_id);
 385   }
 386   log_debug << "deleting file \"" << addon.get_install_filename() << "\"" << std::endl;
 387   PHYSFS_delete(addon.get_install_filename().c_str());
 388   m_installed_addons.erase(std::remove_if(m_installed_addons.begin(), m_installed_addons.end(),
 389                                           [&addon](const std::unique_ptr<Addon>& rhs)
 390                                           {
 391                                             return addon.get_id() == rhs->get_id();
 392                                           }),
 393                            m_installed_addons.end());
 394 }
 395
 396 void
 397 AddonManager::enable_addon(const AddonId& addon_id)
 398 {
 399   log_debug << "enabling addon " << addon_id << std::endl;
 400   Addon& addon = get_installed_addon(addon_id);
 401   if (addon.is_enabled())
 402   {
 403     log_warning << "Tried enabling already enabled Add-on" << std::endl;
 404   }
 405   else
 406   {
 407     log_debug << "Adding archive \"" << addon.get_install_filename() << "\" to search path" << std::endl;
 408     //int PHYSFS_mount(addon.installed_install_filename.c_str(), "addons/", 0)
 409     if (PHYSFS_addToSearchPath(addon.get_install_filename().c_str(), 0) == 0)
 410     {
 411       log_warning << "Could not add " << addon.get_install_filename() << " to search path: "
 412                   << PHYSFS_getLastError() << std::endl;
 413     }
 414     else
 415     {
 416       addon.set_enabled(true);
 417     }
 418   }
 419 }
 420
 421 void
 422 AddonManager::disable_addon(const AddonId& addon_id)
 423 {
 424   log_debug << "disabling addon " << addon_id << std::endl;
 425   Addon& addon = get_installed_addon(addon_id);
 426   if (!addon.is_enabled())
 427   {
 428     log_warning << "Tried disabling already disabled Add-On" << std::endl;
 429   }
 430   else
 431   {
 432     log_debug << "Removing archive \"" << addon.get_install_filename() << "\" from search path" << std::endl;
 433     if (PHYSFS_removeFromSearchPath(addon.get_install_filename().c_str()) == 0)
 434     {
 435       log_warning << "Could not remove " << addon.get_install_filename() << " from search path: "
 436                   << PHYSFS_getLastError() << std::endl;
 437     }
 438     else
 439     {
 440       addon.set_enabled(false);
 441     }
 442   }
 443 }
 444
 445 std::vector<std::string>
 446 AddonManager::scan_for_archives() const
 447 {
 448   std::vector<std::string> archives;
 449
 450   // Search for archives and add them to the search path
 451   std::unique_ptr<char*, decltype(&PHYSFS_freeList)>
 452     rc(PHYSFS_enumerateFiles(m_addon_directory.c_str()),
 453        PHYSFS_freeList);
 454   for(char** i = rc.get(); *i != 0; ++i)
 455   {
 456     if (has_suffix(*i, ".zip"))
 457     {
 458       std::string archive = FileSystem::join(m_addon_directory, *i);
 459       if (PHYSFS_exists(archive.c_str()))
 460       {
 461         archives.push_back(archive);
 462       }
 463     }
 464   }
 465
 466   return archives;
 467 }
 468
 469 std::string
 470 AddonManager::scan_for_info(const std::string& archive_os_path) const
 471 {
 472   std::unique_ptr<char*, decltype(&PHYSFS_freeList)>
 473     rc2(PHYSFS_enumerateFiles("/"),
 474         PHYSFS_freeList);
 475   for(char** j = rc2.get(); *j != 0; ++j)
 476   {
 477     if (has_suffix(*j, ".nfo"))
 478     {
 479       std::string nfo_filename = FileSystem::join("/", *j);
 480
 481       // make sure it's in the current archive_os_path
 482       const char* realdir = PHYSFS_getRealDir(nfo_filename.c_str());
 483       if (!realdir)
 484       {
 485         log_warning << "PHYSFS_getRealDir() failed for " << nfo_filename << ": " << PHYSFS_getLastError() << std::endl;
 486       }
 487       else
 488       {
 489         if (realdir == archive_os_path)
 490         {
 491           return nfo_filename;
 492         }
 493       }
 494     }
 495   }
 496
 497   return std::string();
 498 }
 499
 500 void
 501 AddonManager::add_installed_archive(const std::string& archive, const std::string& md5)
 502 {
 503   const char* realdir = PHYSFS_getRealDir(archive.c_str());
 504   if (!realdir)
 505   {
 506     log_warning << "PHYSFS_getRealDir() failed for " << archive << ": "
 507                 << PHYSFS_getLastError() << std::endl;
 508   }
 509   else
 510   {
 511     std::string os_path = FileSystem::join(realdir, archive);
 512
 513     PHYSFS_addToSearchPath(os_path.c_str(), 0);
 514
 515     std::string nfo_filename = scan_for_info(os_path);
 516
 517     if (nfo_filename.empty())
 518     {
 519       log_warning << "Couldn't find .nfo file for " << os_path << std::endl;
 520     }
 521     else
 522     {
 523       try
 524       {
 525         std::unique_ptr<Addon> addon = Addon::parse(nfo_filename);
 526         addon->set_install_filename(os_path, md5);
 527         m_installed_addons.push_back(std::move(addon));
 528       }
 529       catch (const std::runtime_error& e)
 530       {
 531         log_warning << "Could not load add-on info for " << archive << ": " << e.what() << std::endl;
 532       }
 533     }
 534
 535     PHYSFS_removeFromSearchPath(os_path.c_str());
 536   }
 537 }
 538
 539 void
 540 AddonManager::add_installed_addons()
 541 {
 542   auto archives = scan_for_archives();
 543
 544   for(auto archive : archives)
 545   {
 546     MD5 md5 = md5_from_file(archive);
 547     add_installed_archive(archive, md5.hex_digest());
 548   }
 549 }
 550
 551 AddonManager::AddonList
 552 AddonManager::parse_addon_infos(const std::string& filename) const
 553 {
 554   AddonList m_addons;
 555
 556   try
 557   {
 558     lisp::Parser parser;
 559     const lisp::Lisp* root = parser.parse(filename);
 560     const lisp::Lisp* addons_lisp = root->get_lisp("supertux-addons");
 561     if(!addons_lisp)
 562     {
 563       throw std::runtime_error("Downloaded file is not an Add-on list");
 564     }
 565     else
 566     {
 567       lisp::ListIterator iter(addons_lisp);
 568       while(iter.next())
 569       {
 570         const std::string& token = iter.item();
 571         if(token != "supertux-addoninfo")
 572         {
 573           log_warning << "Unknown token '" << token << "' in Add-on list" << std::endl;
 574         }
 575         else
 576         {
 577           std::unique_ptr<Addon> addon = Addon::parse(*iter.lisp());
 578           m_addons.push_back(std::move(addon));
 579         }
 580       }
 581
 582       return m_addons;
 583     }
 584   }
 585   catch(const std::exception& e)
 586   {
 587     std::stringstream msg;
 588     msg << "Problem when reading Add-on list: " << e.what();
 589     throw std::runtime_error(msg.str());
 590   }
 591
 592   return m_addons;
 593 }
 594
 595 void
 596 AddonManager::update()
 597 {
 598   m_downloader.update();
 599 }
 600
 601 /* EOF */