PackageProvider.cc

Go to the documentation of this file.

/*---------------------------------------------------------------------\
|                          ____ _   __ __ ___                          |
|                         |__  / \ / / . \ . \                         |
|                           / / \ V /|  _/  _/                         |
|                          / /__ | | | | | |                           |
|                         /_____||_| |_| |_|                           |
|                                                                      |
\---------------------------------------------------------------------*/
#include <iostream>
#include <fstream>
#include <sstream>
#include <zypp/repo/PackageDelta.h>
#include <zypp-core/base/Logger.h>
#include <zypp-core/base/Gettext.h>
#include <utility>
#include <zypp-core/base/UserRequestException>
#include <zypp-core/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>
#include <zypp/RepoManager.h>
#include <zypp/SrcPackage.h>

#include <zypp/ZYppFactory.h>
#include <zypp/Target.h>
#include <zypp/target/rpm/RpmDb.h>
#include <zypp/FileChecker.h>
#include <zypp/target/rpm/RpmHeader.h>

#include <zypp/ng/context.h>
#include <zypp/ng/workflows/keyringwf.h>

using std::endl;

namespace zypp
{
  namespace repo
  {
    class RpmSigCheckException : public FileCheckException
    {
    public:
      RpmSigCheckException( repo::DownloadResolvableReport::Action action_r, std::string msg_r = "RpmSigCheckException" )
      : FileCheckException( std::move(msg_r) )
      , _action( action_r )
      {}

      const repo::DownloadResolvableReport::Action & action() const
      { return _action; }

    private:
      repo::DownloadResolvableReport::Action _action;
    };


    //  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;
    }

    struct PackageProvider::Impl : private base::NonCopyable
    {
      Impl() {}
      Impl(const Impl &) = delete;
      Impl(Impl &&) = delete;
      Impl &operator=(const Impl &) = delete;
      Impl &operator=(Impl &&) = delete;
      virtual ~Impl() {}

      virtual ManagedFile providePackage() const = 0;

      virtual ManagedFile providePackageFromCache() const = 0;

      virtual bool isCached() const = 0;
    };

    template <class TPackage>
    class PackageProviderImpl : public PackageProvider::Impl
    {
      using TPackagePtr = typename TPackage::constPtr;  // Package or SrcPackage
      using UserData = callback::UserData;
    public:
      PackageProviderImpl( RepoMediaAccess &access_r, TPackagePtr &&package_r,
                           PackageProviderPolicy &&policy_r )
      : _policy(std::move( policy_r ))
      , _package(std::move( package_r ))
      , _access( access_r )
      , _retry(false)
      {}

      PackageProviderImpl(const PackageProviderImpl &) = delete;
      PackageProviderImpl(PackageProviderImpl &&) = delete;
      PackageProviderImpl &operator=(const PackageProviderImpl &) = delete;
      PackageProviderImpl &operator=(PackageProviderImpl &&) = delete;

      ~PackageProviderImpl() override {}

    public:
      ManagedFile providePackage() const override;

      ManagedFile providePackageFromCache() const override
      {
        ManagedFile ret( doProvidePackageFromCache() );
        if ( ! ( ret->empty() || _package->repoInfo().effectiveKeepPackages() ) )
          ret.setDispose( filesystem::unlink );
        return ret;
      }

      bool isCached() const override
      { return ! doProvidePackageFromCache()->empty(); }

    protected:
      using Base = PackageProviderImpl<TPackage>;
      using Report = callback::SendReport<repo::DownloadResolvableReport>;

      ManagedFile doProvidePackageFromCache() const
      { return ManagedFile( _package->cachedLocation() ); }

      virtual ManagedFile doProvidePackage() const
      {
        ManagedFile ret;
        OnMediaLocation loc = _package->location();

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

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

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


      void rpmSigFileChecker( const Pathname & file_r ) const
      {
        RepoInfo info = _package->repoInfo();
        if ( info.pkgGpgCheck() )
        {
          UserData userData( "pkgGpgCheck" );
          ResObject::constPtr roptr( _package );        // gcc6 needs it more explcit. Has problem deducing
          userData.set( "ResObject", roptr );           // a type for '_package->asKind<ResObject>()'...
          /*legacy:*/userData.set( "Package", roptr->asKind<Package>() );
          userData.set( "Localpath", file_r );

          RpmDb::CheckPackageResult res = RpmDb::CHK_NOKEY;
          while ( res == RpmDb::CHK_NOKEY ) {
            res = packageSigCheck( file_r, info.pkgGpgCheckIsMandatory(), userData );

            // publish the checkresult, even if it is OK. Apps may want to report something...
            report()->pkgGpgCheck( userData );

            if ( res == RpmDb::CHK_NOKEY ) {
              // if the check fails because we don't know the key
              // we try to resolv it with gpgkey urls from the
              // repository, if available

              target::rpm::RpmHeader::constPtr hr = target::rpm::RpmHeader::readPackage( file_r );
              if ( !hr ) {
                // we did not find any information about the key in the header
                // this should never happen
                WAR << "Unable to read package header from " << hr << endl;
                break;
              }

              std::string keyID = hr->signatureKeyID();
              if ( keyID.length() > 0 ) {
                if ( !zyppng::KeyRingWorkflow::provideAndImportKeyFromRepository ( zyppng::Context::defaultContext(), keyID, info ) )
                  break;

              } else {
                // we did not find any information about the key in the header
                // this should never happen
                WAR << "packageSigCheck returned without setting providing missing key information" << endl;
                break;
              }
            }
          }

          if ( res != RpmDb::CHK_OK )
          {
            if ( userData.hasvalue( "Action" ) )        // pkgGpgCheck report provided an user error action
            {
              resolveSignatureErrorAction( userData.get( "Action", repo::DownloadResolvableReport::ABORT ) );
            }
            else if ( userData.haskey( "Action" ) )     // pkgGpgCheck requests the default problem report (wo. details)
            {
              defaultReportSignatureError( res );
            }
            else                                        // no advice from user => usedefaults
            {
              switch ( res )
              {
                case RpmDb::CHK_OK:             // Signature is OK
                  break;

                case RpmDb::CHK_NOKEY:          // Public key is unavailable
                case RpmDb::CHK_NOTFOUND:       // Signature is unknown type
                case RpmDb::CHK_FAIL:           // Signature does not verify
                case RpmDb::CHK_NOTTRUSTED:     // Signature is OK, but key is not trusted
                case RpmDb::CHK_ERROR:          // File does not exist or can't be opened
                case RpmDb::CHK_NOSIG:          // File is unsigned
                default:
                  // report problem (w. details), throw if to abort, else retry/ignore
                  defaultReportSignatureError( res, str::Str() << userData.get<RpmDb::CheckPackageDetail>( "CheckPackageDetail" ) );
                  break;
              }
            }
          }
        }
      }

      using RpmDb = target::rpm::RpmDb;

      RpmDb::CheckPackageResult packageSigCheck( const Pathname & path_r, bool isMandatory_r, UserData & userData ) const
      {
        if ( !_target )
          _target = getZYpp()->getTarget();

        RpmDb::CheckPackageResult ret = RpmDb::CHK_ERROR;
        RpmDb::CheckPackageDetail detail;
        if ( _target )
        {
          ret = _target->rpmDb().checkPackageSignature( path_r, detail );
          if ( ret == RpmDb::CHK_NOSIG && !isMandatory_r )
          {
            WAR << "Relax CHK_NOSIG: Config says unsigned packages are OK" << endl;
            ret = RpmDb::CHK_OK;
          }
        }
        else
          detail.push_back( RpmDb::CheckPackageDetail::value_type( ret, "OOps. Target is not initialized!" ) );

        userData.set( "CheckPackageResult", ret );
        userData.set( "CheckPackageDetail", std::move(detail) );
        return ret;
      }

      void resolveSignatureErrorAction( repo::DownloadResolvableReport::Action action_r ) const
      {
        switch ( action_r )
        {
          case repo::DownloadResolvableReport::IGNORE:
            WAR << _package->asUserString() << ": " << "User requested to accept insecure file" << endl;
            break;
          default:
          case repo::DownloadResolvableReport::RETRY:
          case repo::DownloadResolvableReport::ABORT:
            ZYPP_THROW(RpmSigCheckException(action_r,"Signature verification failed"));
            break;
        }
      }

      void defaultReportSignatureError( RpmDb::CheckPackageResult ret, const std::string & detail_r = std::string() ) const
      {
        str::Str msg;
        msg << _package->asUserString() << ": " << _("Signature verification failed") << " " << ret;
        if ( ! detail_r.empty() )
          msg << "\n" << detail_r;
        resolveSignatureErrorAction( report()->problem( _package, repo::DownloadResolvableReport::INVALID, msg.str() ) );
      }

    protected:
      PackageProviderPolicy     _policy;
      TPackagePtr               _package;
      RepoMediaAccess &         _access;

    private:
      using ScopedGuard = shared_ptr<void>;

      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),
                                 std::bind( std::mem_fn(static_cast<void (shared_ptr<Report>::*)()>(&shared_ptr<Report>::reset)),
                                            std::ref(_report) ) );
      }

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

    template <class TPackage>
    ManagedFile PackageProviderImpl<TPackage>::providePackage() const
    {
      ScopedGuard guardReport( newReport() );

      // check for cache hit:
      ManagedFile ret( providePackageFromCache() );
      if ( ! ret->empty() )
      {
        MIL << "provided Package from cache " << _package << " at " << ret << endl;
        report()->infoInCache( _package, ret );
        return ret; // <-- cache hit
      }

      // HERE: cache misss, check toplevel cache or do download:
      RepoInfo info = _package->repoInfo();

      // Check toplevel cache
      {
        RepoManagerOptions topCache;
        if ( info.packagesPath().dirname() != topCache.repoPackagesCachePath )  // not using toplevel cache
        {
          const OnMediaLocation & loc( _package->location() );
          if ( ! loc.checksum().empty() )       // no cache hit without checksum
          {
            PathInfo pi( topCache.repoPackagesCachePath / info.packagesPath().basename() / info.path() / loc.filename() );
            if ( pi.isExist() && loc.checksum() == CheckSum( loc.checksum().type(), std::ifstream( pi.c_str() ) ) )
            {
              report()->start( _package, pi.path().asFileUrl() );
              const Pathname & dest( info.packagesPath() / info.path() / loc.filename() );
              if ( filesystem::assert_dir( dest.dirname() ) == 0 && filesystem::hardlinkCopy( pi.path(), dest ) == 0 )
              {
                ret = ManagedFile( dest );
                if ( ! info.effectiveKeepPackages() )
                  ret.setDispose( filesystem::unlink );

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

      if ( info.repoOriginsEmpty() )
        ZYPP_THROW(Exception("No url in repository."));

      MIL << "provide Package " << _package << endl;
      Url url = info.location();
      try {
      do {
        _retry = false;
        if ( ! ret->empty() )
        {
          ret.setDispose( filesystem::unlink );
          ret.reset();
        }
        report()->start( _package, url );
        try
          {
            ret = doProvidePackage();
          }
        catch ( const UserRequestException & excpt )
          {
            ERR << "Failed to provide Package " << _package << endl;
            if ( ! _retry )
              ZYPP_RETHROW( excpt );
          }
        catch ( const RpmSigCheckException & excpt )
          {
            ERR << "Failed to provide Package " << _package << endl;
            if ( ! _retry )
            {
              // Signature verification error was already reported by the
              // rpmSigFileChecker. Just handle the users action decision:
              switch ( excpt.action() )
              {
                case repo::DownloadResolvableReport::RETRY:
                  _retry = true;
                  break;
                case repo::DownloadResolvableReport::IGNORE:
                  ZYPP_THROW(SkipRequestException("User requested skip of corrupted file"));
                  break;
                default:
                case repo::DownloadResolvableReport::ABORT:
                  ZYPP_THROW(AbortRequestException("User requested to abort"));
                  break;
              }
            }
          }
        catch ( const FileCheckException & excpt )
          {
            ERR << "Failed to provide Package " << _package << endl;
            if ( ! _retry )
            {
              const std::string & package_str = _package->asUserString();
              // 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;
                default:
                case repo::DownloadResolvableReport::ABORT:
                  ZYPP_THROW(AbortRequestException("User requested to abort"));
                  break;
              }
            }
          }
        catch ( const Exception & excpt )
          {
            ERR << "Failed to provide Package " << _package << endl;
            if ( ! _retry )
            {
                // Aything else gets reported
                const std::string & package_str = _package->asUserString();

                // 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 file", excpt));
                        break;
                      default:
                      case repo::DownloadResolvableReport::ABORT:
                        ZYPP_THROW(AbortRequestException("User requested to abort", excpt));
                        break;
                }
              }
          }
      } while ( _retry );
      } catch(...){
        // bsc#1045735: Be sure no invalid files stay in the cache!
        if ( ! ret->empty() )
          ret.setDispose( filesystem::unlink );
        throw;
      }

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


    class RpmPackageProvider : public PackageProviderImpl<Package>
    {
    public:
      RpmPackageProvider( RepoMediaAccess & access_r,
                          Package::constPtr &&package_r,
                          DeltaCandidates &&deltas_r,
                          PackageProviderPolicy &&policy_r )
      : PackageProviderImpl<Package>( access_r, std::move(package_r), std::move(policy_r) )
      , _deltas( std::move(deltas_r) )
      {}

    protected:
      ManagedFile doProvidePackage() const override;

    private:
      using DeltaRpm = packagedelta::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() ); }

    private:
      DeltaCandidates           _deltas;
    };

    ManagedFile RpmPackageProvider::doProvidePackage() const
    {
      // check whether to process patch/delta rpms
      // FIXME we only check the first url for now.
      if ( ZConfig::instance().download_use_deltarpm()
        && ( _package->repoInfo().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 );
          // bsc#1245672: delta rpms are optional resources.
          // ProvideFile however always returns a managed file if no Exception occurred.
          // So the caller has to check whether the optional file actually exists.
          if ( not PathInfo(delta).isExist() ) {
            delta.resetDispose();
            report()->problemDeltaApply( _("download deltarpm: not found") );
            return ManagedFile();
          }
        }
      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
      Pathname cachedest( _package->repoInfo().packagesPath() / _package->repoInfo().path() / _package->location().filename() );
      Pathname builddest( cachedest.extend( ".drpm" ) );

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

      // Check and move it into the cache
      // Here the rpm itself is ready. If the packages sigcheck fails, it
      // makes no sense to return a ManagedFile() and fallback to download the
      // full rpm. It won't be different. So let the exceptions escape...
      rpmSigFileChecker( builddest );
      if ( filesystem::hardlinkCopy( builddest, cachedest ) != 0 )
        ZYPP_THROW( Exception( str::Str() << "Can't hardlink/copy " << builddest << " to " << cachedest ) );

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

    //  class PackageProvider
    namespace factory
    {
      inline PackageProvider::Impl * make( RepoMediaAccess & access_r, const PoolItem & pi_r,
                                           DeltaCandidates &&deltas_r,
                                           PackageProviderPolicy &&policy_r )
      {
        if ( pi_r.isKind<Package>() )
          return new RpmPackageProvider( access_r, pi_r->asKind<Package>(), std::move(deltas_r), std::move(policy_r) );
        else if ( pi_r.isKind<SrcPackage>() )
          return new PackageProviderImpl<SrcPackage>( access_r, pi_r->asKind<SrcPackage>(), std::move(policy_r) );
        else
          ZYPP_THROW( Exception( str::Str() << "Don't know how to cache non-package " << pi_r.asUserString() ) );
      }

      inline PackageProvider::Impl * make( RepoMediaAccess & access_r, const PoolItem & pi_r,
                                                  PackageProviderPolicy &&policy_r )
      {
        if ( pi_r.isKind<Package>() )
          return new PackageProviderImpl<Package>( access_r, pi_r->asKind<Package>(), std::move(policy_r) );
        else if ( pi_r.isKind<SrcPackage>() )
          return new PackageProviderImpl<SrcPackage>( access_r, pi_r->asKind<SrcPackage>(), std::move(policy_r) );
        else
          ZYPP_THROW( Exception( str::Str() << "Don't know how to cache non-package " << pi_r.asUserString() ) );
      }

      inline PackageProvider::Impl * make( RepoMediaAccess & access_r,
                                           Package::constPtr &&package_r,
                                           DeltaCandidates &&deltas_r,
                                           PackageProviderPolicy &&policy_r )
      { return new RpmPackageProvider( access_r, std::move(package_r), std::move(deltas_r), std::move(policy_r) ); }

    } // namespace factory

    PackageProvider::PackageProvider( RepoMediaAccess & access_r, const PoolItem & pi_r,
                                      DeltaCandidates deltas_r, PackageProviderPolicy policy_r )

    : _pimpl( factory::make( access_r, pi_r, std::move(deltas_r), std::move(policy_r) ) )
    {}

    PackageProvider::PackageProvider( RepoMediaAccess & access_r, const PoolItem & pi_r,
                                      PackageProviderPolicy policy_r )
    : _pimpl( factory::make( access_r, pi_r, std::move(policy_r) ) )
    {}

    /* legacy */
    PackageProvider::PackageProvider( RepoMediaAccess & access_r,
                                      Package::constPtr package_r,
                                      DeltaCandidates deltas_r,
                                      PackageProviderPolicy policy_r )
    : _pimpl( factory::make( access_r, std::move(package_r), std::move(deltas_r), std::move(policy_r) ) )
    {}

    PackageProvider::~PackageProvider()
    {}

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

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

    bool PackageProvider::isCached() const
    { return _pimpl->isCached(); }

  } // namespace repo
} // namespace zypp