downloadwf.cc

Go to the documentation of this file.

/*---------------------------------------------------------------------\
|                          ____ _   __ __ ___                          |
|                         |__  / \ / / . \ . \                         |
|                           / / \ V /|  _/  _/                         |
|                          / /__ | | | | | |                           |
|                         /_____||_| |_| |_|                           |
|                                                                      |
\---------------------------------------------------------------------*/

#include "downloadwf.h"

#include <utility>
#include <zypp/ng/context.h>
#include <zypp/ng/workflows/checksumwf.h>


#include <zypp-core/fs/PathInfo.h>
#include <zypp-core/ng/pipelines/Algorithm>

#include <zypp/ng/media/provide.h>
#include <zypp-media/ng/ProvideSpec>

namespace zyppng {

  CacheProviderContext::CacheProviderContext( ZYPP_PRIVATE_CONSTR_ARG, ContextRef zyppContext, zypp::Pathname destDir )
    : _zyppContext( std::move(zyppContext) )
    , _destDir( std::move(destDir) )
  { }


  const ContextRef &CacheProviderContext::zyppContext() const
  {
    return _zyppContext;
  }



  const zypp::Pathname &CacheProviderContext::destDir() const
  {
    return _destDir;
  }


  void CacheProviderContext::addCacheDir(const zypp::Pathname &p)
  {
    _cacheDirs.push_back ( p );
  }


  const std::vector<zypp::Pathname> &CacheProviderContext::cacheDirs() const
  {
    return _cacheDirs;
  }

  namespace {

    using namespace zyppng::operators;

    class CacheMissException : public zypp::Exception
    {
    public:
      CacheMissException( const zypp::Pathname &filename )
        : zypp::Exception( zypp::str::Str() << filename << " not found in target cache" ) { }
    };

    struct ProvideFromCacheOrMediumLogic {
    protected:

      using ContextType    = Context;
      using ProvideType    = typename ContextType::ProvideType;
      using MediaHandle    = typename ProvideType::MediaHandle;
      using ProvideRes     = typename ProvideType::Res;

    public:
      ProvideFromCacheOrMediumLogic( CacheProviderContextRef cacheContext, MediaHandle &&medium, zypp::Pathname &&file, ProvideFileSpec &&filespec )
        : _ctx( std::move(cacheContext) )
        , _medium( std::move(medium) )
        , _file(std::move( file ))
        , _filespec( std::move(filespec) ) {}

      MaybeAwaitable<expected<zypp::ManagedFile>> execute() {

        return findFileInCache( )
          | [this]( expected<zypp::ManagedFile> cached ) -> MaybeAwaitable<expected<zypp::ManagedFile>> {
            if ( !cached ) {
               MIL << "Didn't find " << _file << " in the caches, providing from medium" << std::endl;

               // we didn't find it in the caches or the lookup failed, lets provide and check it
               std::shared_ptr<ProvideType> provider = _ctx->zyppContext()->provider();
               return provider->provide( _medium, _file, _filespec )
               | and_then( [this]( ProvideRes res ) {
                  return verifyFile( res.file() )
                  | and_then( [res = res]() {
                    return expected<ProvideRes>::success( std::move(res) );
                  });
                 })
               | and_then( ProvideType::copyResultToDest( _ctx->zyppContext()->provider(), _ctx->destDir() / _file ) )
               | and_then( []( zypp::ManagedFile &&file ){
                  file.resetDispose ();
                  return make_expected_success (std::move(file));
                }) ;

            } else {

              return verifyFile ( cached.get() )
              | and_then([ this, cachedFile = cached.get() ]() mutable {
                  if ( cachedFile == _ctx->destDir() / _file ) {
                    cachedFile.resetDispose(); // make sure dispose is reset
                    return makeReadyTask( expected<zypp::ManagedFile>::success(std::move(cachedFile) ));
                  }

                  const auto &targetPath = _ctx->destDir() / _file;
                  zypp::filesystem::assert_dir( targetPath.dirname () );

                  return _ctx->zyppContext()->provider()->copyFile( cachedFile, _ctx->destDir() / _file )
                  | and_then( [cachedFile]( zypp::ManagedFile &&f) { f.resetDispose(); return make_expected_success (std::move(f)); });
              });
            }};
      }

    protected:
      MaybeAwaitable<expected<zypp::ManagedFile>> findFileInCache( ) {

        // No checksum - no match
        if ( _filespec.checksum().empty() )
          return makeReadyTask( expected<zypp::ManagedFile>::error(std::make_exception_ptr( CacheMissException(_file) )) );

        const auto &confDirs  = _ctx->cacheDirs();
        const auto targetFile = _ctx->destDir() / _file ;
        std::vector<zypp::Pathname> caches;
        caches.push_back( _ctx->destDir() );
        caches.insert( caches.end(), confDirs.begin(), confDirs.end() );

        auto makeSearchPipeline = [this, targetFile]( zypp::Pathname cachePath ) -> expected<zypp::ManagedFile> {
          zypp::Pathname cacheFilePath( cachePath / _file );
          zypp::PathInfo cacheFileInfo( cacheFilePath );
          if ( !cacheFileInfo.isExist () ) {
            return makeReadyTask(expected<zypp::ManagedFile>::error( std::make_exception_ptr (CacheMissException(_file)) ));
          } else {
            auto provider = _ctx->zyppContext()->provider();

            // calc checksum, but do not use the workflow. Here we don't want to ask the user if a wrong checksum should
            // be accepted
            return provider->checksumForFile( cacheFilePath, _filespec.checksum().type() )
            | and_then([this, cacheFilePath, targetFile]( zypp::CheckSum sum ) {

              auto mgdFile = zypp::ManagedFile( cacheFilePath );

              // if the file is in the target dir, make sure to release it if its not used
              if ( cacheFilePath == targetFile )
                mgdFile.setDispose ( zypp::filesystem::unlink );

              if ( sum == _filespec.checksum () ) {
                // we found the file!
                return expected<zypp::ManagedFile>::success( std::move(mgdFile) );
              }

              return expected<zypp::ManagedFile>::error( std::make_exception_ptr (CacheMissException(_file)) );
            });
          }
        };

        auto defVal = expected<zypp::ManagedFile>::error( std::make_exception_ptr (CacheMissException(_file) ) );
        return std::move(caches) | firstOf( std::move(makeSearchPipeline), std::move(defVal), detail::ContinueUntilValidPredicate() );
      }

      MaybeAwaitable<expected<void>> verifyFile ( const zypp::Pathname &dlFilePath ) {

        return zypp::Pathname( dlFilePath )
        | [this]( zypp::Pathname &&dlFilePath ) {
          if ( !_filespec.checksum().empty () ) {
            return CheckSumWorkflow::verifyChecksum( _ctx->zyppContext(), _filespec.checksum (), std::move(dlFilePath) );
          }
          return makeReadyTask(expected<void>::success());
        };
        // add other verifier here via and_then(), like a signature based one
      }

      CacheProviderContextRef _ctx;
      MediaHandle     _medium;
      zypp::Pathname  _file;
      ProvideFileSpec _filespec;
    };
  }

  namespace DownloadWorkflow {

    MaybeAwaitable<expected<zypp::ManagedFile> > provideToCacheDir( CacheProviderContextRef cacheContext, ProvideMediaHandle medium, zypp::Pathname file, ProvideFileSpec filespec )
    {
      ProvideFromCacheOrMediumLogic impl(std::move(cacheContext), std::move(medium), std::move(file), std::move(filespec));
      zypp_co_return zypp_co_await( impl.execute() );
    }

  }

}