src/Network/HTTPClient.cxx

   1 // HTTPClient.cxx -- Singleton HTTP client object
   2 //
   3 // Written by James Turner, started April 2012.
   4 //
   5 // Copyright (C) 2012  James Turner
   6 //
   7 // This program is free software; you can redistribute it and/or
   8 // modify it under the terms of the GNU General Public License as
   9 // published by the Free Software Foundation; either version 2 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful, but
  13 // WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 // General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU General Public License
  18 // along with this program; if not, write to the Free Software
  19 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  20
  21 #include "HTTPClient.hxx"
  22
  23 #include <cassert>
  24
  25 #include <Main/fg_props.hxx>
  26 #include <Include/version.h>
  27
  28 #include <simgear/sg_inlines.h>
  29
  30 #include <simgear/package/Root.hxx>
  31 #include <simgear/package/Catalog.hxx>
  32 #include <simgear/package/Delegate.hxx>
  33 #include <simgear/package/Install.hxx>
  34 #include <simgear/package/Package.hxx>
  35
  36 #include <simgear/nasal/cppbind/from_nasal.hxx>
  37 #include <simgear/nasal/cppbind/to_nasal.hxx>
  38 #include <simgear/nasal/cppbind/NasalHash.hxx>
  39 #include <simgear/nasal/cppbind/Ghost.hxx>
  40
  41 #include <Scripting/NasalSys.hxx>
  42
  43 using namespace simgear;
  44
  45 typedef nasal::Ghost<pkg::RootRef> NasalPackageRoot;
  46 typedef nasal::Ghost<pkg::PackageRef> NasalPackage;
  47 typedef nasal::Ghost<pkg::CatalogRef> NasalCatalog;
  48 typedef nasal::Ghost<pkg::InstallRef> NasalInstall;
  49
  50
  51 class FGHTTPClient::FGDelegate : public pkg::Delegate
  52 {
  53 public:
  54   virtual void refreshComplete()
  55   {
  56     SG_LOG(SG_IO, SG_INFO, "all Catalogs refreshed");
  57
  58     // auto-update; make this controlled by a property
  59     pkg::Root* r = globals->packageRoot();
  60
  61     pkg::PackageList toBeUpdated(r->packagesNeedingUpdate());
  62     pkg::PackageList::const_iterator it;
  63     for (it = toBeUpdated.begin(); it != toBeUpdated.end(); ++it) {
  64       assert((*it)->isInstalled());
  65       SG_LOG(SG_IO, SG_INFO, "updating:" << (*it)->id());
  66       r->scheduleToUpdate((*it)->install());
  67     }
  68   }
  69
  70   virtual void catalogRefreshed(pkg::CatalogRef aCat, StatusCode aReason)
  71   {
  72       if (aCat.ptr() == NULL) {
  73           SG_LOG(SG_IO, SG_INFO, "refresh of all catalogs done");
  74           return;
  75       }
  76
  77     switch (aReason) {
  78     case pkg::Delegate::STATUS_SUCCESS:
  79     case pkg::Delegate::STATUS_REFRESHED:
  80         SG_LOG(SG_IO, SG_INFO, "refresh of Catalog done:" << aCat->url());
  81         break;
  82
  83     case pkg::Delegate::STATUS_IN_PROGRESS:
  84         SG_LOG(SG_IO, SG_INFO, "refresh of Catalog started:" << aCat->url());
  85         break;
  86
  87     default:
  88         SG_LOG(SG_IO, SG_WARN, "refresh of Catalog " << aCat->url() << " failed:" << aReason);
  89     }
  90   }
  91
  92   virtual void startInstall(pkg::InstallRef aInstall)
  93   {
  94     SG_LOG(SG_IO, SG_INFO, "beginning install of:" << aInstall->package()->id()
  95            << " to local path:" << aInstall->path());
  96
  97   }
  98
  99   virtual void installProgress(pkg::InstallRef aInstall, unsigned int aBytes, unsigned int aTotal)
 100   {
 101   }
 102
 103   virtual void finishInstall(pkg::InstallRef aInstall, StatusCode aReason)
 104   {
 105       if (aReason == STATUS_SUCCESS) {
 106     SG_LOG(SG_IO, SG_INFO, "finished install of:" << aInstall->package()->id()
 107            << " to local path:" << aInstall->path());
 108       } else {
 109           SG_LOG(SG_IO, SG_WARN, "install failed of:" << aInstall->package()->id()
 110                  << " to local path:" << aInstall->path());
 111       }
 112
 113   }
 114 }; // of FGHTTPClient::FGDelegate
 115
 116 FGHTTPClient::FGHTTPClient() :
 117     _inited(false)
 118 {
 119 }
 120
 121 FGHTTPClient::~FGHTTPClient()
 122 {
 123 }
 124
 125 void FGHTTPClient::init()
 126 {
 127     // launcher may need to setup HTTP access abnormally early, so
 128     // guard against duplicate inits
 129     if (_inited) {
 130         return;
 131     }
 132
 133   _http.reset(new simgear::HTTP::Client);
 134
 135   std::string proxyHost(fgGetString("/sim/presets/proxy/host"));
 136   int proxyPort(fgGetInt("/sim/presets/proxy/port"));
 137   std::string proxyAuth(fgGetString("/sim/presets/proxy/auth"));
 138
 139   if (!proxyHost.empty()) {
 140     _http->setProxy(proxyHost, proxyPort, proxyAuth);
 141   }
 142
 143   pkg::Root* packageRoot = globals->packageRoot();
 144   if (packageRoot) {
 145     // package system needs access to the HTTP engine too
 146     packageRoot->setHTTPClient(_http.get());
 147
 148     _packageDelegate.reset(new FGDelegate);
 149     packageRoot->addDelegate(_packageDelegate.get());
 150
 151     const char * defaultCatalogId = fgGetString("/sim/package-system/default-catalog/id", "org.flightgear.official" );
 152     const char * defaultCatalogUrl = fgGetString("/sim/package-system/default-catalog/url",
 153             "http://fgfs.goneabitbursar.com/pkg/" FLIGHTGEAR_VERSION "/catalog.xml");
 154     // setup default catalog if not present
 155     pkg::Catalog* defaultCatalog = packageRoot->getCatalogById( defaultCatalogId );
 156     if (!defaultCatalog) {
 157       // always show this message
 158       SG_LOG(SG_GENERAL, SG_ALERT, "default catalog not found, installing '"
 159         << defaultCatalogId << "' from '" << defaultCatalogUrl << "'.");
 160       pkg::Catalog::createFromUrl(packageRoot,defaultCatalogUrl);
 161     }
 162
 163     // start a refresh now
 164     packageRoot->refresh();
 165   }
 166
 167     _inited = true;
 168 }
 169
 170 static naRef f_package_existingInstall( pkg::Package& pkg,
 171                                         const nasal::CallContext& ctx )
 172 {
 173   return ctx.to_nasal(
 174     pkg.existingInstall( ctx.getArg<pkg::Package::InstallCallback>(0) )
 175   );
 176 }
 177
 178 static naRef f_package_uninstall(pkg::Package& pkg, const nasal::CallContext& ctx)
 179 {
 180     pkg::InstallRef ins = pkg.existingInstall();
 181     if (ins) {
 182         ins->uninstall();
 183     }
 184
 185     return naNil();
 186 }
 187
 188 static SGPropertyNode_ptr queryPropsFromHash(const nasal::Hash& h)
 189 {
 190     SGPropertyNode_ptr props(new SGPropertyNode);
 191
 192     for (nasal::Hash::const_iterator it = h.begin(); it != h.end(); ++it) {
 193         std::string const key = it->getKey();
 194         if ((key == "name") || (key == "description")) {
 195             props->setStringValue(key, it->getValue<std::string>());
 196         } else if (strutils::starts_with(key, "rating-")) {
 197             props->setIntValue(key, it->getValue<int>());
 198         } else if (key == "tags") {
 199             string_list tags = it->getValue<string_list>();
 200             string_list::const_iterator tagIt;
 201             int tagCount = 0;
 202             for (tagIt = tags.begin(); tagIt != tags.end(); ++tagIt) {
 203                 SGPropertyNode_ptr tag = props->getChild("tag", tagCount++, true);
 204                 tag->setStringValue(*tagIt);
 205             }
 206         } else if (key == "installed") {
 207             props->setBoolValue(key, it->getValue<bool>());
 208         } else {
 209             SG_LOG(SG_GENERAL, SG_WARN, "unknown filter term in hash:" << key);
 210         }
 211     }
 212
 213     return props;
 214 }
 215
 216 static naRef f_root_search(pkg::Root& root, const nasal::CallContext& ctx)
 217 {
 218     SGPropertyNode_ptr query = queryPropsFromHash(ctx.requireArg<nasal::Hash>(0));
 219     pkg::PackageList result = root.packagesMatching(query);
 220     return ctx.to_nasal(result);
 221 }
 222
 223 static naRef f_catalog_search(pkg::Catalog& cat, const nasal::CallContext& ctx)
 224 {
 225     SGPropertyNode_ptr query = queryPropsFromHash(ctx.requireArg<nasal::Hash>(0));
 226     pkg::PackageList result = cat.packagesMatching(query);
 227     return ctx.to_nasal(result);
 228 }
 229
 230 static naRef f_package_variants(pkg::Package& pack, naContext c)
 231 {
 232     nasal::Hash h(c);
 233     string_list vars(pack.variants());
 234     for (string_list_iterator it  = vars.begin(); it != vars.end(); ++it) {
 235         h.set(*it, pack.nameForVariant(*it));
 236     }
 237
 238     return h.get_naRef();
 239 }
 240
 241 void FGHTTPClient::postinit()
 242 {
 243   NasalPackageRoot::init("PackageRoot")
 244   .member("path", &pkg::Root::path)
 245   .member("version", &pkg::Root::catalogVersion)
 246   .method("refresh", &pkg::Root::refresh)
 247   .method("catalogs", &pkg::Root::catalogs)
 248   .method("packageById", &pkg::Root::getPackageById)
 249   .method("catalogById", &pkg::Root::getCatalogById)
 250   .method("search", &f_root_search);
 251
 252   NasalCatalog::init("Catalog")
 253   .member("installRoot", &pkg::Catalog::installRoot)
 254   .member("id", &pkg::Catalog::id)
 255   .member("url", &pkg::Catalog::url)
 256   .member("description", &pkg::Catalog::description)
 257   .method("packages", &pkg::Catalog::packages)
 258   .method("packageById", &pkg::Catalog::getPackageById)
 259   .method("refresh", &pkg::Catalog::refresh)
 260   .method("needingUpdate", &pkg::Catalog::packagesNeedingUpdate)
 261   .member("installed", &pkg::Catalog::installedPackages)
 262   .method("search", &f_catalog_search);
 263
 264   NasalPackage::init("Package")
 265   .member("id", &pkg::Package::id)
 266   .member("name", &pkg::Package::name)
 267   .member("description", &pkg::Package::description)
 268   .member("installed", &pkg::Package::isInstalled)
 269   .member("thumbnails", &pkg::Package::thumbnailUrls)
 270   .member("variants", &f_package_variants)
 271   .member("revision", &pkg::Package::revision)
 272   .member("catalog", &pkg::Package::catalog)
 273   .method("install", &pkg::Package::install)
 274   .method("uninstall", &f_package_uninstall)
 275   .method("existingInstall", &f_package_existingInstall)
 276   .method("lprop", &pkg::Package::getLocalisedProp)
 277   .member("fileSize", &pkg::Package::fileSizeBytes);
 278
 279   typedef pkg::Install* (pkg::Install::*InstallCallback)
 280                         (const pkg::Install::Callback&);
 281   typedef pkg::Install* (pkg::Install::*ProgressCallback)
 282                         (const pkg::Install::ProgressCallback&);
 283   NasalInstall::init("Install")
 284   .member("revision", &pkg::Install::revsion)
 285   .member("pkg", &pkg::Install::package)
 286   .member("path", &pkg::Install::path)
 287   .member("hasUpdate", &pkg::Install::hasUpdate)
 288   .method("startUpdate", &pkg::Install::startUpdate)
 289   .method("uninstall", &pkg::Install::uninstall)
 290   .method("done", static_cast<InstallCallback>(&pkg::Install::done))
 291   .method("fail", static_cast<InstallCallback>(&pkg::Install::fail))
 292   .method("always", static_cast<InstallCallback>(&pkg::Install::always))
 293   .method("progress", static_cast<ProgressCallback>(&pkg::Install::progress));
 294
 295   pkg::Root* packageRoot = globals->packageRoot();
 296   if (packageRoot) {
 297     FGNasalSys* nasalSys = (FGNasalSys*) globals->get_subsystem("nasal");
 298     nasal::Hash nasalGlobals = nasalSys->getGlobals();
 299     nasal::Hash nasalPkg = nasalGlobals.createHash("pkg"); // module
 300     nasalPkg.set("root", packageRoot);
 301   }
 302 }
 303
 304 void FGHTTPClient::shutdown()
 305 {
 306     pkg::Root* packageRoot = globals->packageRoot();
 307     if (packageRoot && _packageDelegate.get()) {
 308         packageRoot->removeDelegate(_packageDelegate.get());
 309     }
 310
 311     _packageDelegate.reset();
 312     _http.reset();
 313 }
 314
 315 void FGHTTPClient::update(double)
 316 {
 317   _http->update();
 318 }
 319
 320 void FGHTTPClient::makeRequest(const simgear::HTTP::Request_ptr& req)
 321 {
 322   _http->makeRequest(req);
 323 }