libzypp 17.37.10

RepoProvideFile.cc
Go to the documentation of this file.
1/*---------------------------------------------------------------------\
2| ____ _ __ __ ___ |
3| |__ / \ / / . \ . \ |
4| / / \ V /| _/ _/ |
5| / /__ | | | | | | |
6| /_____||_| |_| |_| |
7| |
8\---------------------------------------------------------------------*/
12#include "zypp-core/zyppng/pipelines/transform.h"
13#include <iostream>
14#include <fstream>
15#include <sstream>
16#include <set>
17
18#include <zypp/base/Gettext.h>
19#include <zypp/base/Logger.h>
20#include <zypp/base/String.h>
21#include <utility>
22#include <zypp-core/base/UserRequestException>
23#include <zypp/repo/RepoProvideFile.h>
24#include <zypp/ZYppCallbacks.h>
25#include <zypp/MediaSetAccess.h>
26#include <zypp/ZConfig.h>
27#include <zypp/ZYppFactory.h>
28#include <zypp/repo/SUSEMediaVerifier.h>
29#include <zypp/repo/RepoException.h>
30
31#include <zypp/repo/SUSEMediaVerifier.h>
32#include <zypp/repo/RepoException.h>
33#include <zypp/FileChecker.h>
34#include <zypp/Fetcher.h>
35
36 using std::endl;
37 using std::set;
38
40 namespace zypp
41{
43 namespace repo
44 {
45
47 //
48 // provideFile
49 //
51
53 namespace
54 {
55
61 struct DownloadFileReportHack : public callback::ReceiveReport<media::DownloadProgressReport>
62 {
63 using BaseType = callback::ReceiveReport<ReportType>;
64 using RedirectType = function<bool (int)>;
65
66 DownloadFileReportHack(RedirectType &&redirect_r)
67 : _oldRec(Distributor::instance().getReceiver()),
68 _redirect(std::move(redirect_r)) {
69 connect();
70 }
71
72 DownloadFileReportHack(const DownloadFileReportHack &) = delete;
73 DownloadFileReportHack(DownloadFileReportHack &&) = delete;
74 DownloadFileReportHack &operator=(const DownloadFileReportHack &) = delete;
75 DownloadFileReportHack &operator=(DownloadFileReportHack &&) = delete;
76
77 ~DownloadFileReportHack() override
78 { if ( _oldRec ) Distributor::instance().setReceiver( *_oldRec ); else Distributor::instance().noReceiver(); }
79
80 void start( const Url & file, Pathname localfile ) override
81 {
82 if ( _oldRec )
83 _oldRec->start( file, localfile );
84 else
85 BaseType::start( file, localfile );
86 }
87
88 bool progress( int value, const Url & file, double dbps_avg = -1, double dbps_current = -1 ) override
89 {
90 bool ret = true;
91 if ( _oldRec )
92 ret &= _oldRec->progress( value, file, dbps_avg, dbps_current );
93 if ( _redirect )
94 ret &= _redirect( value );
95 return ret;
96 }
97
98 Action problem( const Url & file, Error error, const std::string & description ) override
99 {
100 if ( _oldRec )
101 return _oldRec->problem( file, error, description );
102 return BaseType::problem( file, error, description );
103 }
104 void finish( const Url & file, Error error, const std::string & reason ) override
105 {
106 if ( _oldRec )
107 _oldRec->finish( file, error, reason );
108 else
109 BaseType::finish( file, error, reason );
110 }
111
112 private:
113 Receiver * _oldRec;
114 RedirectType _redirect;
115 };
116
118 } // namespace
120
121 ManagedFile provideFile( RepoInfo repo_r,
122 const OnMediaLocation & loc_r,
123 const ProvideFilePolicy & policy_r )
124 {
125 RepoMediaAccess access;
126 return access.provideFile(std::move(repo_r), loc_r, policy_r );
127 }
128
130 class RepoMediaAccess::Impl
131 {
132 public:
133 Impl(ProvideFilePolicy &&defaultPolicy_r)
134 : _defaultPolicy(std::move(defaultPolicy_r)) {}
135
136 Impl(const Impl &) = delete;
137 Impl(Impl &&) = delete;
138 Impl &operator=(const Impl &) = delete;
139 Impl &operator=(Impl &&) = delete;
140
141 ~Impl()
142 {
143 std::map<Url, shared_ptr<MediaSetAccess> >::iterator it;
144 for ( it = _medias.begin();
145 it != _medias.end();
146 ++it )
147 {
148 it->second->release();
149 }
150 }
151
159 shared_ptr<MediaSetAccess> mediaAccessForUrl( const MirroredOrigin &origin, RepoInfo repo )
160 {
161 if ( !origin.isValid() )
162 return nullptr;
163
164 std::map<Url, shared_ptr<MediaSetAccess> >::const_iterator it;
165 it = _medias.find( origin.authority().url() ); // primary Url is the key
166 shared_ptr<MediaSetAccess> media;
167 if ( it != _medias.end() )
168 {
169 media = it->second;
170 }
171 else
172 {
173 media.reset( new MediaSetAccess( origin ) );
174 _medias[origin.authority().url()] = media;
175 }
176 setVerifierForRepo( repo, media );
177 return media;
178 }
179
180 private:
181 void setVerifierForRepo( const RepoInfo& repo, const shared_ptr<MediaSetAccess>& media )
182 {
183 // Always set the MediaSetAccess label.
184 media->setLabel( repo.name() );
185
186 // set a verifier if the repository has it
187
188 Pathname mediafile = repo.metadataPath() + "/media.1/media";
189 if ( ! repo.metadataPath().empty() )
190 {
191 if ( PathInfo(mediafile).isExist() )
192 {
193 std::map<shared_ptr<MediaSetAccess>, RepoInfo>::const_iterator it;
194 it = _verifier.find(media);
195 if ( it != _verifier.end() )
196 {
197 if ( it->second.alias() == repo.alias() )
198 {
199 // this media is already using this repo verifier
200 return;
201 }
202 }
203
204 SUSEMediaVerifier lverifier { mediafile };
205 if ( lverifier ) {
206 DBG << "Verifier for repo '" << repo.alias() << "':" << lverifier << endl;
207 for ( media::MediaNr i = 1; i <= lverifier.totalMedia(); ++i ) {
208 media::MediaVerifierRef verifier( new repo::SUSEMediaVerifier( lverifier, i ) );
209 media->setVerifier( i, verifier);
210 }
211 _verifier[media] = repo;
212 }
213 else {
214 WAR << "Invalid verifier for repo '" << repo.alias() << "' in '" << repo.metadataPath() << "': " << lverifier << endl;
215 }
216 }
217 else
218 {
219 DBG << "No media verifier for repo '" << repo.alias() << "' media.1/media does not exist in '" << repo.metadataPath() << "'" << endl;
220 }
221 }
222 else
223 {
224 WAR << "'" << repo.alias() << "' metadata path is empty. Can't set verifier. Probably this repository does not come from RepoManager." << endl;
225 }
226 }
227
228 private:
229 std::map<shared_ptr<MediaSetAccess>, RepoInfo> _verifier;
230 std::map<Url, shared_ptr<MediaSetAccess> > _medias;
231
232 public:
233 ProvideFilePolicy _defaultPolicy;
234 };
235
236
237
238 RepoMediaAccess::RepoMediaAccess( ProvideFilePolicy defaultPolicy_r )
239 : _impl( new Impl( std::move(defaultPolicy_r) ) )
240 {}
241
242 RepoMediaAccess::~RepoMediaAccess()
243 {}
244
245 void RepoMediaAccess::setDefaultPolicy( const ProvideFilePolicy & policy_r )
246 { _impl->_defaultPolicy = policy_r; }
247
248 const ProvideFilePolicy & RepoMediaAccess::defaultPolicy() const
249 { return _impl->_defaultPolicy; }
250
251 ManagedFile RepoMediaAccess::provideFile( const RepoInfo& repo_r,
252 const OnMediaLocation & loc_rx,
253 const ProvideFilePolicy & policy_r )
254 {
255 const OnMediaLocation locWithPath( OnMediaLocation(loc_rx).prependPath( repo_r.path() ) );
256
257 MIL << locWithPath << endl;
258 // Arrange DownloadFileReportHack to recieve the source::DownloadFileReport
259 // and redirect download progress triggers to call the ProvideFilePolicy
260 // callback.
261 DownloadFileReportHack dumb( std::bind( std::mem_fn(&ProvideFilePolicy::progress), std::ref(policy_r), _1 ) );
262
263 RepoException repo_excpt(repo_r,
264 str::form(_("Can't provide file '%s' from repository '%s'"),
265 locWithPath.filename().c_str(),
266 repo_r.alias().c_str() ) );
267
268 const auto &repoOrigins = repo_r.repoOrigins();
269
270 if ( repoOrigins.empty() ) {
271 repo_excpt.remember(RepoException(_("No url in repository.")));
272 ZYPP_THROW(repo_excpt);
273 }
274
275 Fetcher fetcher;
276 fetcher.addCachePath( repo_r.packagesPath() );
277 MIL << "Added cache path " << repo_r.packagesPath() << endl;
278 fetcher.addCachePath( repo_r.predownloadPath(), Fetcher::CleanFiles );
279 MIL << "Added cache path " << repo_r.predownloadPath() << endl;
280
281 // Test whether download destination is writable, if not
282 // switch into the tmpspace (e.g. bnc#755239, download and
283 // install srpms as user).
284 Pathname destinationDir( repo_r.packagesPath() );
285
286 PathInfo pi( destinationDir );
287 if ( ! pi.isExist() )
288 {
289 // try to create it...
290 assert_dir( destinationDir );
291 pi();
292 }
293 if ( geteuid() != 0 && ! pi.userMayW() )
294 {
295 WAR << "Destination dir '" << destinationDir << "' is not user writable, using tmp space." << endl;
296 destinationDir = getZYpp()->tmpPath() / destinationDir;
297 assert_dir( destinationDir );
298 fetcher.addCachePath( destinationDir );
299 MIL << "Added cache path " << destinationDir << endl;
300 }
301
302 // Suppress (interactive) media::MediaChangeReport if we have fallback URLs
303 media::ScopedDisableMediaChangeReport guard( repoOrigins.hasFallbackUrls() );
304 for ( const auto &origin : repoOrigins )
305 {
306
307 if ( !origin.isValid() ) {
308 MIL << "Skipping empty Url group" << std::endl;
309 continue;
310 }
311
312 try
313 {
314 MIL << "Providing file of repo '" << repo_r.alias() << "' from: ";
315 std::for_each( origin.begin (), origin.end(), [&]( const OriginEndpoint &u ){
316 MIL << u << ", ";
317 });
318 MIL << std::endl;
319
320 shared_ptr<MediaSetAccess> access = _impl->mediaAccessForUrl( origin, repo_r );
321 if ( !access )
322 continue;
323
324 fetcher.enqueue( locWithPath, policy_r.fileChecker() );
325 fetcher.start( destinationDir, *access );
326
327 // reached if no exception has been thrown, so this is the correct file
328 // LEGACY NOTE:
329 // DeltaRpms e.g are in fact optional resources (tagged in OnMediaLocation).
330 // They should actually return a ManagedFile(). But I don't know if there is
331 // already code which requests optional files but relies on provideFile returning
332 // a ManagedFile holding the path even if it does not exist. So I keep it this way.
333 ManagedFile ret( destinationDir + locWithPath.filename() );
334 if ( !repo_r.keepPackages() )
335 {
336 ret.setDispose( filesystem::unlink );
337 }
338
339 MIL << "provideFile at " << ret << endl;
340 return ret;
341 }
342 catch ( const UserRequestException & excpt )
343 {
344 ZYPP_RETHROW( excpt );
345 }
346 catch ( const FileCheckException & excpt )
347 {
348 ZYPP_RETHROW( excpt );
349 }
350 catch ( const Exception &e )
351 {
352 ZYPP_CAUGHT( e );
353
354 repo_excpt.remember(e);
355
356 WAR << "Trying next url" << endl;
357 continue;
358 }
359 } // iteration over urls
360
361 ZYPP_THROW(repo_excpt);
362 return ManagedFile(); // not reached
363 }
364
366 } // namespace repo
369} // namespace zypp
Fetcher.h
FileChecker.h
MediaSetAccess.h
RepoException.h
RepoProvideFile.h
SUSEMediaVerifier.h
ZConfig.h
ZYppCallbacks.h
ZYppFactory.h
shared_ptr
zypp::AutoDispose::setDispose
void setDispose(const Dispose &dispose_r)
Set a new dispose function.
Definition AutoDispose.h:167
zypp::Exception
Base class for Exception.
Definition Exception.h:153
zypp::Exception::remember
void remember(const Exception &old_r)
Store an other Exception as history.
Definition Exception.cc:154
zypp::Fetcher
This class allows to retrieve a group of files in a confortable way, providing some smartness that do...
Definition Fetcher.h:104
zypp::Fetcher::CleanFiles
@ CleanFiles
Definition Fetcher.h:307
zypp::Fetcher::start
void start(const Pathname &dest_dir, const ProgressData::ReceiverFnc &progress=ProgressData::ReceiverFnc())
start the transfer to a destination directory dest_dir The media has to be provides with setMediaSetA...
Definition Fetcher.cc:927
zypp::Fetcher::enqueue
void enqueue(const OnMediaLocation &resource, const FileChecker &checker=FileChecker())
Enqueue a object for transferal, they will not be transferred until start() is called.
Definition Fetcher.cc:901
zypp::Fetcher::addCachePath
void addCachePath(const Pathname &cache_dir)
adds a directory to the list of directories where to look for cached files
Definition Fetcher.cc:907
zypp::FileCheckException
Definition filecheckexception.h:18
zypp::MediaSetAccess
Media access layer responsible for handling files distributed on a set of media with media change and...
Definition MediaSetAccess.h:82
zypp::MirroredOrigin
Manages a data source characterized by an authoritative URL and a list of mirror URLs.
Definition MirroredOrigin.h:170
zypp::MirroredOrigin::isValid
bool isValid() const
Definition MirroredOrigin.cc:194
zypp::MirroredOrigin::authority
const OriginEndpoint & authority() const
Definition MirroredOrigin.cc:184
zypp::OnMediaLocation
Describes a resource file located on a medium.
Definition onmedialocation.h:37
zypp::OnMediaLocation::filename
const Pathname & filename() const
The path to the resource on the medium.
Definition onmedialocation.cc:90
zypp::OriginEndpoint
Represents a single, configurable network endpoint, combining a URL with specific access settings.
Definition MirroredOrigin.h:41
zypp::OriginEndpoint::url
const zypp::Url & url() const
Definition MirroredOrigin.cc:51
zypp::ProvideFilePolicy
Policy for provideFile and RepoMediaAccess.
Definition ProvideFilePolicy.h:31
zypp::ProvideFilePolicy::fileChecker
ProvideFilePolicy & fileChecker(FileChecker fileChecker_r)
Add a FileCecker passed down to the Fetcher.
Definition ProvideFilePolicy.h:45
zypp::ProvideFilePolicy::progress
bool progress(int value) const
Evaluate callback.
Definition ProvideFilePolicy.cc:28
zypp::RepoInfo
What is known about a repository.
Definition RepoInfo.h:72
zypp::RepoInfo::predownloadPath
Pathname predownloadPath() const
Path where this repo packages are predownloaded.
Definition RepoInfo.cc:715
zypp::RepoInfo::repoOrigins
MirroredOriginSet repoOrigins() const
The repodata origins.
Definition RepoInfo.cc:689
zypp::RepoInfo::keepPackages
bool keepPackages() const
Whether packages downloaded from this repository will be kept in local cache.
Definition RepoInfo.cc:727
zypp::RepoInfo::path
Pathname path() const
Repository path.
Definition RepoInfo.cc:775
zypp::RepoInfo::packagesPath
Pathname packagesPath() const
Path where this repo packages are cached.
Definition RepoInfo.cc:736
zypp::UserRequestException
Base for exceptions caused by explicit user request.
Definition userrequestexception.h:65
zypp::ZYppFactory::getZYpp
ZYpp::Ptr getZYpp()
Convenience to get the Pointer to the ZYpp instance.
Definition ZYppFactory.h:77
zypp::filesystem::PathInfo
Wrapper class for stat/lstat.
Definition PathInfo.h:226
zypp::filesystem::PathInfo::userMayW
bool userMayW() const
Definition PathInfo.h:354
zypp::filesystem::PathInfo::isExist
bool isExist() const
Return whether valid stat info exists.
Definition PathInfo.h:286
zypp::filesystem::Pathname
Pathname.
Definition Pathname.h:47
zypp::filesystem::Pathname::c_str
const char * c_str() const
String representation.
Definition Pathname.h:112
zypp::repo::RepoException
Exception for repository handling.
Definition RepoException.h:38
zypp::repo::RepoInfoBase::alias
std::string alias() const
unique identifier for this source.
Definition RepoInfoBase.cc:104
zypp::repo::RepoMediaAccess::Impl
Definition RepoProvideFile.cc:131
zypp::repo::RepoMediaAccess::Impl::_verifier
std::map< shared_ptr< MediaSetAccess >, RepoInfo > _verifier
Definition RepoProvideFile.cc:229
zypp::repo::RepoMediaAccess::Impl::_defaultPolicy
ProvideFilePolicy _defaultPolicy
Definition RepoProvideFile.cc:233
zypp::repo::RepoMediaAccess::Impl::mediaAccessForUrl
shared_ptr< MediaSetAccess > mediaAccessForUrl(const MirroredOrigin &origin, RepoInfo repo)
Provide a MediaSetAccess for url with label and verifier adjusted.
Definition RepoProvideFile.cc:159
zypp::repo::RepoMediaAccess::Impl::~Impl
~Impl()
Definition RepoProvideFile.cc:141
zypp::repo::RepoMediaAccess::Impl::Impl
Impl(const Impl &)=delete
zypp::repo::RepoMediaAccess::Impl::operator=
Impl & operator=(Impl &&)=delete
zypp::repo::RepoMediaAccess::Impl::Impl
Impl(ProvideFilePolicy &&defaultPolicy_r)
Definition RepoProvideFile.cc:133
zypp::repo::RepoMediaAccess::Impl::_medias
std::map< Url, shared_ptr< MediaSetAccess > > _medias
Definition RepoProvideFile.cc:230
zypp::repo::RepoMediaAccess::Impl::Impl
Impl(Impl &&)=delete
zypp::repo::RepoMediaAccess::Impl::setVerifierForRepo
void setVerifierForRepo(const RepoInfo &repo, const shared_ptr< MediaSetAccess > &media)
Definition RepoProvideFile.cc:181
zypp::repo::RepoMediaAccess::Impl::operator=
Impl & operator=(const Impl &)=delete
zypp::repo::RepoMediaAccess
Provides files from different repos.
Definition RepoProvideFile.h:62
zypp::repo::RepoMediaAccess::setDefaultPolicy
void setDefaultPolicy(const ProvideFilePolicy &policy_r)
Set a new default ProvideFilePolicy.
Definition RepoProvideFile.cc:245
zypp::repo::RepoMediaAccess::_impl
RW_pointer< Impl > _impl
Definition RepoProvideFile.h:94
zypp::repo::RepoMediaAccess::~RepoMediaAccess
~RepoMediaAccess()
Definition RepoProvideFile.cc:242
zypp::repo::RepoMediaAccess::RepoMediaAccess
RepoMediaAccess(ProvideFilePolicy defaultPolicy_r=ProvideFilePolicy())
Ctor taking the default ProvideFilePolicy.
Definition RepoProvideFile.cc:238
zypp::repo::RepoMediaAccess::defaultPolicy
const ProvideFilePolicy & defaultPolicy() const
Get the current default ProvideFilePolicy.
Definition RepoProvideFile.cc:248
zypp::repo::RepoMediaAccess::provideFile
ManagedFile provideFile(const RepoInfo &repo_r, const OnMediaLocation &loc_r, const ProvideFilePolicy &policy_r)
Provide a file from a Repository.
Definition RepoProvideFile.cc:251
zypp::repo::SUSEMediaVerifier
Implementation of the traditional SUSE media verifier.
Definition SUSEMediaVerifier.h:28
zypp::repo::SUSEMediaVerifier::totalMedia
media::MediaNr totalMedia() const
The total number of media in this set (or 0 if not known).
Definition SUSEMediaVerifier.cc:145
std
Definition Arch.h:364
zypp::filesystem::unlink
int unlink(const Pathname &path)
Like 'unlink'.
Definition PathInfo.cc:705
zypp::media
Definition MediaNetworkRequestExecutor.h:22
zypp::media::MediaNr
unsigned int MediaNr
Definition MediaManager.h:32
zypp::media::MediaVerifierRef
zypp::RW_pointer< MediaVerifierBase > MediaVerifierRef
A shared reference to the MediaVerifier implementation.
Definition MediaManager.h:107
zypp::repo
Definition DeltaCandidates.cc:30
zypp::repo::provideFile
ManagedFile provideFile(RepoInfo repo_r, const OnMediaLocation &loc_r, const ProvideFilePolicy &policy_r)
Provide a file from a Repository.
Definition RepoProvideFile.cc:121
zypp::sat::operator=
SolvableSpec & operator=(const SolvableSpec &)=default
zypp::str::form
std::string form(const char *format,...) __attribute__((format(printf
Printf style construction of std::string.
Definition String.cc:39
zypp
Easy-to use interface to the ZYPP dependency resolver.
Definition Application.cc:20
zypp::ManagedFile
AutoDispose< const Pathname > ManagedFile
A Pathname plus associated cleanup code to be executed when path is no longer needed.
Definition ManagedFile.h:27
zypp::media::ScopedDisableMediaChangeReport
Temporarily disable MediaChangeReport Sometimes helpful to suppress interactive messages connected to...
Definition ZYppCallbacks.h:354
transform.h
ZYPP_RETHROW
#define ZYPP_RETHROW(EXCPT)
Drops a logline and rethrows, updating the CodeLocation.
Definition Exception.h:479
ZYPP_CAUGHT
#define ZYPP_CAUGHT(EXCPT)
Drops a logline telling the Exception was caught (in order to handle it).
Definition Exception.h:475
ZYPP_THROW
#define ZYPP_THROW(EXCPT)
Drops a logline and throws the Exception.
Definition Exception.h:459
_
#define _(MSG)
Definition Gettext.h:39
DBG
#define DBG
Definition Logger.h:99
MIL
#define MIL
Definition Logger.h:100
WAR
#define WAR
Definition Logger.h:101
Gettext.h
Interface to gettext.
Logger.h
String.h