PackageProvider.cc

Go to the documentation of this file.

/*---------------------------------------------------------------------\
|                          ____ _   __ __ ___                          |
|                         |__  / \ / / . \ . \                         |
|                           / / \ V /|  _/  _/                         |
|                          / /__ | | | | | |                           |
|                         /_____||_| |_| |_|                           |
|                                                                      |
\---------------------------------------------------------------------*/
#include <iostream>
#include <sstream>
#include "zypp/repo/PackageDelta.h"
#include "zypp/base/Logger.h"
#include "zypp/base/Gettext.h"
#include "zypp/base/UserRequestException.h"
#include "zypp/base/NonCopyable.h"
#include "zypp/repo/PackageProvider.h"
#include "zypp/repo/Applydeltarpm.h"
#include "zypp/repo/PackageDelta.h"

#include "zypp/TmpPath.h"
#include "zypp/ZConfig.h"
#include "zypp/RepoInfo.h"

using std::endl;

namespace zypp
{
  namespace repo
  {
    //  class PackageProviderPolicy

    bool PackageProviderPolicy::queryInstalled( const std::string & name_r,
                                                const Edition &     ed_r,
                                                const Arch &        arch_r ) const
    {
      if ( _queryInstalledCB )
        return _queryInstalledCB( name_r, ed_r, arch_r );
      return false;
    }


    class PackageProvider::Impl : private base::NonCopyable
    {
    public:
      Impl( RepoMediaAccess & access_r,
            const Package::constPtr & package_r,
            const DeltaCandidates & deltas_r,
            const PackageProviderPolicy & policy_r )
      : _policy( policy_r )
      , _package( package_r )
      , _deltas( deltas_r )
      , _access( access_r )
      , _retry(false)
      {}

      virtual ~Impl() {}

      static Impl * factoryMake( RepoMediaAccess & access_r,
                                 const Package::constPtr & package_r,
                                 const DeltaCandidates & deltas_r,
                                 const PackageProviderPolicy & policy_r );

    public:
      ManagedFile providePackage() const;

    protected:
      typedef PackageProvider::Impl     Base;
      typedef callback::SendReport<repo::DownloadResolvableReport>      Report;

      virtual ManagedFile providePackageFromCache() const = 0;

      virtual ManagedFile doProvidePackage() const = 0;

    protected:
      Report & report() const
      { return *_report; }

      bool progressPackageDownload( int value ) const
      { return report()->progress( value, _package ); }

      bool failOnChecksumError() const
      {
        std::string package_str = _package->name() + "-" + _package->edition().asString();

        // TranslatorExplanation %s = package being checked for integrity
        switch ( report()->problem( _package, repo::DownloadResolvableReport::INVALID, str::form(_("Package %s seems to be corrupted during transfer. Do you want to retry retrieval?"), package_str.c_str() ) ) )
        {
          case repo::DownloadResolvableReport::RETRY:
            _retry = true;
            break;
          case repo::DownloadResolvableReport::IGNORE:
            ZYPP_THROW(SkipRequestException("User requested skip of corrupted file"));
            break;
          case repo::DownloadResolvableReport::ABORT:
            ZYPP_THROW(AbortRequestException("User requested to abort"));
            break;
          default:
            break;
        }
        return true; // anyway a failure
      }

    protected:
      PackageProviderPolicy     _policy;
      Package::constPtr         _package;
      DeltaCandidates           _deltas;
      RepoMediaAccess &         _access;

    private:
      typedef shared_ptr<void>  ScopedGuard;

      ScopedGuard newReport() const
      {
        _report.reset( new Report );
        // Use a custom deleter calling _report.reset() when guard goes out of
        // scope (cast required as reset is overloaded). We want report to end
        // when leaving providePackage and not wait for *this going out of scope.
        return shared_ptr<void>( static_cast<void*>(0),
                                 bind( mem_fun_ref( static_cast<void (shared_ptr<Report>::*)()>(&shared_ptr<Report>::reset) ),
                                       ref(_report) ) );
      }

      mutable bool               _retry;
      mutable shared_ptr<Report> _report;
    };

    ManagedFile PackageProvider::Impl::providePackageFromCache() const
    { return ManagedFile(); }

    ManagedFile PackageProvider::Impl::doProvidePackage() const
    {
      ManagedFile ret;
      OnMediaLocation loc = _package->location();

      ProvideFilePolicy policy;
      policy.progressCB( bind( &Base::progressPackageDownload, this, _1 ) );
      policy.failOnChecksumErrorCB( bind( &Base::failOnChecksumError, this ) );
      return _access.provideFile( _package->repoInfo(), loc, policy );
    }


    ManagedFile PackageProvider::Impl::providePackage() const
    {
      Url url;
      RepoInfo info = _package->repoInfo();
      // FIXME we only support the first url for now.
      if ( info.baseUrlsEmpty() )
        ZYPP_THROW(Exception("No url in repository."));
      else
        url = * info.baseUrlsBegin();

      // check for cache hit:
      ManagedFile ret( providePackageFromCache() );
      if ( ! ret.value().empty() )
      {
        if ( ! info.keepPackages() )
        {
          ret.setDispose( filesystem::unlink );
        }
        MIL << "provided Package from cache " << _package << " at " << ret << endl;
        return ret; // <-- cache hit
      }

      // HERE: cache misss, do download:
      MIL << "provide Package " << _package << endl;
      ScopedGuard guardReport( newReport() );
      do {
        _retry = false;
        report()->start( _package, url );
        try  // ELIMINATE try/catch by providing a log-guard
          {
            ret = doProvidePackage();
          }
        catch ( const UserRequestException & excpt )
          {
            // UserRequestException e.g. from failOnChecksumError was already reported.
            ERR << "Failed to provide Package " << _package << endl;
            if ( ! _retry )
              {
                ZYPP_RETHROW( excpt );
              }
          }
        catch ( const Exception & excpt )
          {
            ERR << "Failed to provide Package " << _package << endl;
            if ( ! _retry )
              {
                // Aything else gets reported
                std::string package_str = _package->name() + "-" + _package->edition().asString();

                // TranslatorExplanation %s = name of the package being processed.
                std::string detail_str( str::form(_("Failed to provide Package %s. Do you want to retry retrieval?"), package_str.c_str() ) );
                detail_str += str::form( "\n\n%s", excpt.asUserHistory().c_str() );

                switch ( report()->problem( _package, repo::DownloadResolvableReport::IO, detail_str.c_str() ) )
                {
                      case repo::DownloadResolvableReport::RETRY:
                        _retry = true;
                        break;
                      case repo::DownloadResolvableReport::IGNORE:
                        ZYPP_THROW(SkipRequestException("User requested skip of corrupted file", excpt));
                        break;
                      case repo::DownloadResolvableReport::ABORT:
                        ZYPP_THROW(AbortRequestException("User requested to abort", excpt));
                        break;
                      default:
                        ZYPP_RETHROW( excpt );
                        break;
                }
              }
          }
      } while ( _retry );

      report()->finish( _package, repo::DownloadResolvableReport::NO_ERROR, std::string() );
      MIL << "provided Package " << _package << " at " << ret << endl;
      return ret;
    }


    class RpmPackageProvider : public PackageProvider::Impl
    {
    public:
      RpmPackageProvider( RepoMediaAccess & access_r,
                          const Package::constPtr & package_r,
                          const DeltaCandidates & deltas_r,
                          const PackageProviderPolicy & policy_r )
      : PackageProvider::Impl( access_r, package_r, deltas_r, policy_r )
      {}

    protected:
      virtual ManagedFile providePackageFromCache() const;

      virtual ManagedFile doProvidePackage() const;

    private:
      typedef packagedelta::DeltaRpm    DeltaRpm;

      ManagedFile tryDelta( const DeltaRpm & delta_r ) const;

      bool progressDeltaDownload( int value ) const
      { return report()->progressDeltaDownload( value ); }

      void progressDeltaApply( int value ) const
      { return report()->progressDeltaApply( value ); }

      bool queryInstalled( const Edition & ed_r = Edition() ) const
      { return _policy.queryInstalled( _package->name(), ed_r, _package->arch() ); }
    };

    ManagedFile RpmPackageProvider::providePackageFromCache() const
    {
      RepoInfo info = _package->repoInfo();
      OnMediaLocation loc( _package->location() );
      PathInfo cachepath( info.packagesPath() / loc.filename() );

      if ( cachepath.isFile() && ! loc.checksum().empty() ) // accept cache hit with matching checksum only!
             // Tempting to do a quick check for matching .rpm-filesize before computing checksum,
      // but real life shows that loc.downloadSize() and the .rpm-filesize frequently do not
      // match, even if loc.checksum() and the .rpm-files checksum do. Blame the metadata generator(s).
      {
        CheckSum cachechecksum( loc.checksum().type(), filesystem::checksum( cachepath.path(), loc.checksum().type() ) );
        if ( cachechecksum == loc.checksum() )
        {
          return ManagedFile( cachepath.path() );  // <-- cache hit
        }
      }
      return ManagedFile();     // <-- cache miss
    }

    ManagedFile RpmPackageProvider::doProvidePackage() const
    {
      Url url;
      RepoInfo info = _package->repoInfo();
      // FIXME we only support the first url for now.
      if ( info.baseUrlsEmpty() )
        ZYPP_THROW(Exception("No url in repository."));
      else
        url = * info.baseUrlsBegin();

      // check whether to process patch/delta rpms
      if ( ZConfig::instance().download_use_deltarpm()
        && ( url.schemeIsDownloading() || ZConfig::instance().download_use_deltarpm_always() ) )
      {
        std::list<DeltaRpm> deltaRpms;
        _deltas.deltaRpms( _package ).swap( deltaRpms );

        if ( ! deltaRpms.empty() && queryInstalled() && applydeltarpm::haveApplydeltarpm() )
        {
          for_( it, deltaRpms.begin(), deltaRpms.end())
          {
            DBG << "tryDelta " << *it << endl;
            ManagedFile ret( tryDelta( *it ) );
            if ( ! ret->empty() )
              return ret;
          }
        }
      }

      // no patch/delta -> provide full package
      return Base::doProvidePackage();
    }

    ManagedFile RpmPackageProvider::tryDelta( const DeltaRpm & delta_r ) const
    {
      if ( delta_r.baseversion().edition() != Edition::noedition
           && ! queryInstalled( delta_r.baseversion().edition() ) )
        return ManagedFile();

      if ( ! applydeltarpm::quickcheck( delta_r.baseversion().sequenceinfo() ) )
        return ManagedFile();

      report()->startDeltaDownload( delta_r.location().filename(),
                                    delta_r.location().downloadSize() );
      ManagedFile delta;
      try
        {
          ProvideFilePolicy policy;
          policy.progressCB( bind( &RpmPackageProvider::progressDeltaDownload, this, _1 ) );
          delta = _access.provideFile( delta_r.repository().info(), delta_r.location(), policy );
        }
      catch ( const Exception & excpt )
        {
          report()->problemDeltaDownload( excpt.asUserHistory() );
          return ManagedFile();
        }
      report()->finishDeltaDownload();

      report()->startDeltaApply( delta );
      if ( ! applydeltarpm::check( delta_r.baseversion().sequenceinfo() ) )
        {
          report()->problemDeltaApply( _("applydeltarpm check failed.") );
          return ManagedFile();
        }

      // build the package and put it into the cache
      Pathname destination( _package->repoInfo().packagesPath() / _package->location().filename() );

      if ( ! applydeltarpm::provide( delta, destination,
                                     bind( &RpmPackageProvider::progressDeltaApply, this, _1 ) ) )
        {
          report()->problemDeltaApply( _("applydeltarpm failed.") );
          return ManagedFile();
        }
      report()->finishDeltaApply();

      return ManagedFile( destination, filesystem::unlink );
    }


    class PluginPackageProvider : public PackageProvider::Impl
    {
    public:
      PluginPackageProvider( const std::string & stem_r,
                             RepoMediaAccess & access_r,
                             const Package::constPtr & package_r,
                             const DeltaCandidates & deltas_r,
                             const PackageProviderPolicy & policy_r )
      : Base( access_r, package_r, deltas_r, policy_r )
      {}

    protected:
      virtual ManagedFile providePackageFromCache() const
      {
        return Base::providePackageFromCache();
      }

      virtual ManagedFile doProvidePackage() const
      {
        return Base::doProvidePackage();
      }
    };


    //  class PackageProvider

    PackageProvider::Impl * PackageProvider::Impl::factoryMake( RepoMediaAccess & access_r,
                                                                const Package::constPtr & package_r,
                                                                const DeltaCandidates & deltas_r,
                                                                const PackageProviderPolicy & policy_r )
    {
      return new RpmPackageProvider( access_r, package_r, deltas_r, policy_r );
    }

    PackageProvider::PackageProvider( RepoMediaAccess & access_r,
                                      const Package::constPtr & package_r,
                                      const DeltaCandidates & deltas_r,
                                      const PackageProviderPolicy & policy_r )
    : _pimpl( Impl::factoryMake( access_r, package_r, deltas_r, policy_r ) )
    {}

    PackageProvider::~PackageProvider()
    {}

    ManagedFile PackageProvider::providePackage() const
    { return _pimpl->providePackage(); }


  } // namespace repo
} // namespace zypp