src/addon_manager.cpp

   1 //  $Id$
   2 //
   3 //  SuperTux - Add-on Manager
   4 //  Copyright (C) 2007 Christoph Sommer <christoph.sommer@2007.expires.deltadevelopment.de>
   5 //
   6 //  This program is free software; you can redistribute it and/or
   7 //  modify it under the terms of the GNU General Public License
   8 //  as published by the Free Software Foundation; either version 2
   9 //  of the License, or (at your option) any later version.
  10 //
  11 //  This program is distributed in the hope that it will be useful,
  12 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 //  GNU General Public License for more details.
  15 //
  16 //  You should have received a copy of the GNU General Public License
  17 //  along with this program; if not, write to the Free Software
  18 //  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  19 //  02111-1307, USA.
  20 //
  21
  22 #include <sstream>
  23 #include <stdexcept>
  24 #include <list>
  25 #include <physfs.h>
  26 #include <sys/stat.h>
  27 #include <stdio.h>
  28 #include "addon_manager.hpp"
  29 #include "config.h"
  30 #include "log.hpp"
  31 #include "lisp/parser.hpp"
  32 #include "lisp/lisp.hpp"
  33 #include "lisp/list_iterator.hpp"
  34
  35 #ifdef HAVE_LIBCURL
  36 #include <curl/curl.h>
  37 #include <curl/types.h>
  38 #include <curl/easy.h>
  39 #endif
  40
  41 #ifdef HAVE_LIBCURL
  42 namespace {
  43
  44   size_t my_curl_string_append(void *ptr, size_t size, size_t nmemb, void *string_ptr)
  45   {
  46     std::string& s = *static_cast<std::string*>(string_ptr);
  47     std::string buf(static_cast<char*>(ptr), size * nmemb);
  48     s += buf;
  49     log_debug << "read " << size * nmemb << " bytes of data..." << std::endl;
  50     return size * nmemb;
  51   }
  52
  53   size_t my_curl_physfs_write(void *ptr, size_t size, size_t nmemb, void *f_p)
  54   {
  55     PHYSFS_file* f = static_cast<PHYSFS_file*>(f_p);
  56     PHYSFS_sint64 written = PHYSFS_write(f, ptr, size, nmemb);
  57     log_debug << "read " << size * nmemb << " bytes of data..." << std::endl;
  58     return size * written;
  59   }
  60
  61 }
  62 #endif
  63
  64 AddonManager&
  65 AddonManager::get_instance()
  66 {
  67   static AddonManager instance;
  68   return instance;
  69 }
  70
  71 AddonManager::AddonManager()
  72 {
  73 #ifdef HAVE_LIBCURL
  74   curl_global_init(CURL_GLOBAL_ALL);
  75 #endif
  76 }
  77
  78 AddonManager::~AddonManager()
  79 {
  80 #ifdef HAVE_LIBCURL
  81   curl_global_cleanup();
  82 #endif
  83 }
  84
  85 std::vector<Addon>
  86 AddonManager::get_installed_addons() const
  87 {
  88   std::vector<Addon> addons;
  89
  90   // iterate over complete search path (i.e. directories and archives)
  91   char **i = PHYSFS_getSearchPath();
  92   if (!i) throw std::runtime_error("Could not query physfs search path");
  93   for (; *i != NULL; i++) {
  94
  95     // get filename of potential archive
  96     std::string fileName = *i;
  97
  98     // make sure it's in the writeDir
  99     static const std::string writeDir = PHYSFS_getWriteDir();
 100     if (fileName.compare(0, writeDir.length(), writeDir) != 0) continue;
 101
 102     // make sure it looks like an archive
 103     static const std::string archiveExt = ".zip";
 104     if (fileName.compare(fileName.length()-archiveExt.length(), archiveExt.length(), archiveExt) != 0) continue;
 105
 106     // make sure it exists
 107     struct stat stats;
 108     if (stat(fileName.c_str(), &stats) != 0) continue;
 109
 110     // make sure it's an actual file
 111     if (!S_ISREG(stats.st_mode)) continue;
 112
 113     Addon addon;
 114
 115     // extract nice title as fallback for when the Add-on has no addoninfo file
 116     static const char* dirSep = PHYSFS_getDirSeparator();
 117     std::string::size_type n = fileName.rfind(dirSep) + 1;
 118     if (n == std::string::npos) n = 0;
 119     addon.title = fileName.substr(n, fileName.length() - n - archiveExt.length());
 120     std::string shortFileName = fileName.substr(n, fileName.length() - n);
 121     addon.file = shortFileName;
 122
 123     // read an accompaining .nfo file, if it exists
 124     static const std::string infoExt = ".nfo";
 125     std::string infoFileName = fileName.substr(n, fileName.length() - n - archiveExt.length()) + infoExt;
 126     if (PHYSFS_exists(infoFileName.c_str())) {
 127       addon.parse(infoFileName);
 128       if (addon.file != shortFileName) {
 129         log_warning << "Add-on \"" << addon.title << "\", contained in file \"" << shortFileName << "\" is accompained by an addoninfo file that specifies \"" << addon.file << "\" as the Add-on's file name. Skipping." << std::endl;
 130       }
 131     }
 132
 133     // make sure the Add-on's file name does not contain weird characters
 134     if (addon.file.find_first_not_of("match.quiz-proxy_gwenblvdjfks0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ") != std::string::npos) {
 135       log_warning << "Add-on \"" << addon.title << "\" contains unsafe file name. Skipping." << std::endl;
 136       continue;
 137     }
 138
 139     addon.isInstalled = true;
 140     addons.push_back(addon);
 141   }
 142
 143   return addons;
 144 }
 145
 146 std::vector<Addon>
 147 AddonManager::get_available_addons() const
 148 {
 149   std::vector<Addon> addons;
 150
 151 #ifdef HAVE_LIBCURL
 152
 153   char error_buffer[CURL_ERROR_SIZE+1];
 154
 155   const char* baseUrl = "http://supertux.lethargik.org/addons/index.nfo";
 156   std::string addoninfos = "";
 157
 158   CURL *curl_handle;
 159   curl_handle = curl_easy_init();
 160   curl_easy_setopt(curl_handle, CURLOPT_URL, baseUrl);
 161   curl_easy_setopt(curl_handle, CURLOPT_USERAGENT, "SuperTux/" PACKAGE_VERSION " libcURL");
 162   curl_easy_setopt(curl_handle, CURLOPT_WRITEFUNCTION, my_curl_string_append);
 163   curl_easy_setopt(curl_handle, CURLOPT_WRITEDATA, &addoninfos);
 164   curl_easy_setopt(curl_handle, CURLOPT_ERRORBUFFER, error_buffer);
 165   curl_easy_setopt(curl_handle, CURLOPT_NOPROGRESS, 1);
 166   curl_easy_setopt(curl_handle, CURLOPT_NOSIGNAL, 1);
 167   curl_easy_setopt(curl_handle, CURLOPT_FAILONERROR, 1);
 168   CURLcode result = curl_easy_perform(curl_handle);
 169   curl_easy_cleanup(curl_handle);
 170
 171   if (result != CURLE_OK) {
 172     std::string why = error_buffer[0] ? error_buffer : "unhandled error";
 173     throw std::runtime_error("Downloading Add-on list failed: " + why);
 174   }
 175
 176   try {
 177     lisp::Parser parser;
 178     std::stringstream addoninfos_stream(addoninfos);
 179     const lisp::Lisp* root = parser.parse(addoninfos_stream, "supertux-addons");
 180
 181     const lisp::Lisp* addons_lisp = root->get_lisp("supertux-addons");
 182     if(!addons_lisp) throw std::runtime_error("Downloaded file is not an Add-on list");
 183
 184     lisp::ListIterator iter(addons_lisp);
 185     while(iter.next()) {
 186       const std::string& token = iter.item();
 187       if(token == "supertux-addoninfo") {
 188         Addon addon;
 189         addon.parse(*(iter.lisp()));
 190
 191         // make sure the Add-on's file name does not contain weird characters
 192         if (addon.file.find_first_not_of("match.quiz-proxy_gwenblvdjfks0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ") != std::string::npos) {
 193           log_warning << "Add-on \"" << addon.title << "\" contains unsafe file name. Skipping." << std::endl;
 194           continue;
 195         }
 196
 197         addon.isInstalled = false;
 198         addons.push_back(addon);
 199       } else {
 200         log_warning << "Unknown token '" << token << "' in Add-on list" << std::endl;
 201       }
 202     }
 203   } catch(std::exception& e) {
 204     std::stringstream msg;
 205     msg << "Problem when reading Add-on list: " << e.what();
 206     throw std::runtime_error(msg.str());
 207   }
 208
 209 #endif
 210
 211   return addons;
 212 }
 213
 214
 215 void
 216 AddonManager::install(const Addon& addon)
 217 {
 218   // make sure the Add-on's file name does not contain weird characters
 219   if (addon.file.find_first_not_of("match.quiz-proxy_gwenblvdjfks0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ") != std::string::npos) {
 220     throw std::runtime_error("Add-on has unsafe file name (\""+addon.file+"\")");
 221   }
 222
 223 #ifdef HAVE_LIBCURL
 224
 225   char error_buffer[CURL_ERROR_SIZE+1];
 226
 227   char* url = (char*)malloc(addon.http_url.length() + 1);
 228   strncpy(url, addon.http_url.c_str(), addon.http_url.length() + 1);
 229
 230   PHYSFS_file* f = PHYSFS_openWrite(addon.file.c_str());
 231
 232   log_debug << "Downloading \"" << url << "\"" << std::endl;
 233
 234   CURL *curl_handle;
 235   curl_handle = curl_easy_init();
 236   curl_easy_setopt(curl_handle, CURLOPT_URL, url);
 237   curl_easy_setopt(curl_handle, CURLOPT_USERAGENT, "SuperTux/" PACKAGE_VERSION " libcURL");
 238   curl_easy_setopt(curl_handle, CURLOPT_WRITEFUNCTION, my_curl_physfs_write);
 239   curl_easy_setopt(curl_handle, CURLOPT_WRITEDATA, f);
 240   curl_easy_setopt(curl_handle, CURLOPT_ERRORBUFFER, error_buffer);
 241   curl_easy_setopt(curl_handle, CURLOPT_NOPROGRESS, 1);
 242   curl_easy_setopt(curl_handle, CURLOPT_NOSIGNAL, 1);
 243   curl_easy_setopt(curl_handle, CURLOPT_FAILONERROR, 1);
 244   CURLcode result = curl_easy_perform(curl_handle);
 245   curl_easy_cleanup(curl_handle);
 246
 247   PHYSFS_close(f);
 248
 249   free(url);
 250
 251   if (result != CURLE_OK) {
 252     PHYSFS_delete(addon.file.c_str());
 253     std::string why = error_buffer[0] ? error_buffer : "unhandled error";
 254     throw std::runtime_error("Downloading Add-on failed: " + why);
 255   }
 256
 257   // write an accompaining .nfo file
 258   static const std::string archiveExt = ".zip";
 259   static const std::string infoExt = ".nfo";
 260   std::string infoFileName = addon.file.substr(0, addon.file.length()-archiveExt.length()) + infoExt;
 261   addon.write(infoFileName);
 262
 263   static const std::string writeDir = PHYSFS_getWriteDir();
 264   static const std::string dirSep = PHYSFS_getDirSeparator();
 265   std::string fullFilename = writeDir + dirSep + addon.file;
 266   log_debug << "Finished downloading \"" << fullFilename << "\"" << std::endl;
 267   PHYSFS_addToSearchPath(fullFilename.c_str(), 1);
 268 #else
 269   (void) addon;
 270 #endif
 271
 272 }
 273
 274 void
 275 AddonManager::remove(const Addon& addon)
 276 {
 277   // make sure the Add-on's file name does not contain weird characters
 278   if (addon.file.find_first_not_of("match.quiz-proxy_gwenblvdjfks0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ") != std::string::npos) {
 279     throw std::runtime_error("Add-on has unsafe file name (\""+addon.file+"\")");
 280   }
 281
 282   log_debug << "deleting file \"" << addon.file << "\"" << std::endl;
 283   PHYSFS_removeFromSearchPath(addon.file.c_str());
 284   PHYSFS_delete(addon.file.c_str());
 285
 286   // remove an accompaining .nfo file
 287   static const std::string archiveExt = ".zip";
 288   static const std::string infoExt = ".nfo";
 289   std::string infoFileName = addon.file.substr(0, addon.file.length()-archiveExt.length()) + infoExt;
 290   if (PHYSFS_exists(infoFileName.c_str())) {
 291     log_debug << "deleting file \"" << infoFileName << "\"" << std::endl;
 292     PHYSFS_delete(infoFileName.c_str());
 293   }
 294 }
 295