libzypp: zypp/MediaSetAccess.h Source File

libzypp 17.36.6

MediaSetAccess.h
Go to the documentation of this file.
1/*---------------------------------------------------------------------\
2| ____ _ __ __ ___ |
3| |__ / \ / / . \ . \ |
4| / / \ V /| _/ _/ |
5| / /__ | | | | | | |
6| /_____||_| |_| |_| |
7| |
8\---------------------------------------------------------------------*/
9
10#ifndef ZYPP_MediaSetAccess_H
11#define ZYPP_MediaSetAccess_H
12
13#include <iosfwd>
14#include <string>
15#include <vector>
16#include <zypp/base/Function.h>
17
18#include <zypp/base/ReferenceCounted.h>
19#include <zypp/base/NonCopyable.h>
20#include <zypp/base/Flags.h>
21#include <zypp/base/PtrTypes.h>
22#include <zypp/media/MediaManager.h>
23#include <zypp/Pathname.h>
24#include <zypp/CheckSum.h>
25#include <zypp-core/OnMediaLocation>
26#include <zypp/ManagedFile.h>
27
29namespace zypp
30{
31
32 DEFINE_PTR_TYPE(MediaSetAccess);
33
35 //
36 // CLASS NAME : MediaSetAccess
37 //
80 class ZYPP_API MediaSetAccess : public base::ReferenceCounted, private base::NonCopyable
81 {
82 friend std::ostream & operator<<( std::ostream & str, const MediaSetAccess & obj );
83
84 public:
92 MediaSetAccess( Url url, Pathname prefered_attach_point = "" );
94 MediaSetAccess( std::string label_r, Url url, Pathname prefered_attach_point = "" );
95 ~MediaSetAccess() override;
96
100 void setVerifier( unsigned media_nr, const media::MediaVerifierRef& verifier );
101
105 const std::string & label() const
106 { return _label; }
107
111 void setLabel( const std::string & label_r )
112 { _label = label_r; }
113
114 enum ProvideFileOption
115 {
119 PROVIDE_DEFAULT = 0x0,
120 PROVIDE_NON_INTERACTIVE = 0x1
121 };
122 ZYPP_DECLARE_FLAGS(ProvideFileOptions,ProvideFileOption);
123
134 void precacheFiles(const std::vector<OnMediaLocation> &files);
135
163 Pathname provideFile( const OnMediaLocation & resource, ProvideFileOptions options = PROVIDE_DEFAULT );
164
168 ZYPP_DEPRECATED Pathname provideFile( const OnMediaLocation & resource, ProvideFileOptions options, const Pathname &deltafile );
169
190 Pathname provideFile(const Pathname & file, unsigned media_nr = 1, ProvideFileOptions options = PROVIDE_DEFAULT );
191
199 Pathname provideOptionalFile( const Pathname & file, unsigned media_nr = 1 );
200
218 static ManagedFile provideFileFromUrl( const Url & file_url, ProvideFileOptions options = PROVIDE_DEFAULT );
219
227 static ManagedFile provideOptionalFileFromUrl( const Url & file_url );
228
235 void releaseFile( const OnMediaLocation &resource );
236
237
245 void releaseFile(const Pathname & file, unsigned media_nr = 1 );
246
262 struct ReleaseFileGuard
263 {
264 NON_COPYABLE( ReleaseFileGuard );
265 NON_MOVABLE( ReleaseFileGuard );
266 ReleaseFileGuard( MediaSetAccess & media_r, const OnMediaLocation & loc_r )
267 : _media( media_r )
268 , _loc( loc_r )
269 {}
270 ~ReleaseFileGuard()
271 { _media.releaseFile( _loc ); }
272 private:
273 MediaSetAccess & _media;
274 const OnMediaLocation & _loc;
275 };
276
294 Pathname provideDir(const Pathname & dir, bool recursive, unsigned media_nr = 1, ProvideFileOptions options = PROVIDE_DEFAULT );
295
310 bool doesFileExist(const Pathname & file, unsigned media_nr = 1 );
311
315 void dirInfo( filesystem::DirContent &retlist, const Pathname &dirname,
316 bool dots = true, unsigned media_nr = 1 );
317
323 void release();
324
339 static Url rewriteUrl (const Url & url_r, const media::MediaNr medianr);
340
341 protected:
357 Pathname provideFileInternal( const OnMediaLocation &resource, ProvideFileOptions options );
358
359 using ProvideOperation = function<void (media::MediaAccessId, const OnMediaLocation &)>;
360
361 void provide( const ProvideOperation& op, const OnMediaLocation &resource, ProvideFileOptions options );
362
363 media::MediaAccessId getMediaAccessId (media::MediaNr medianr);
364 std::ostream & dumpOn( std::ostream & str ) const override;
365
366 private:
368 Url _url;
369
376 Pathname _prefAttachPoint;
377
378 std::string _label;
379
380 using MediaMap = std::map<media::MediaNr, media::MediaAccessId>;
381 using VerifierMap = std::map<media::MediaNr, media::MediaVerifierRef>;
382
384 MediaMap _medias;
386 VerifierMap _verifiers;
387 };
388
389 ZYPP_DECLARE_OPERATORS_FOR_FLAGS(MediaSetAccess::ProvideFileOptions);
390
392 inline std::ostream & operator<<( std::ostream & str, const MediaSetAccess & obj )
393 { return obj.dumpOn( str ); }
394
395
396} // namespace zypp
398#endif // ZYPP_SOURCE_MediaSetAccess_H
MediaManager.h
zypp::MediaSetAccess
Media access layer responsible for handling files distributed on a set of media with media change and...
Definition MediaSetAccess.h:81
zypp::MediaSetAccess::ZYPP_DECLARE_FLAGS
ZYPP_DECLARE_FLAGS(ProvideFileOptions, ProvideFileOption)
zypp::MediaSetAccess::_verifiers
VerifierMap _verifiers
Mapping between media number and corespondent verifier.
Definition MediaSetAccess.h:386
zypp::MediaSetAccess::getMediaAccessId
media::MediaAccessId getMediaAccessId(media::MediaNr medianr)
Definition MediaSetAccess.cc:407
zypp::MediaSetAccess::provideDir
Pathname provideDir(const Pathname &dir, bool recursive, unsigned media_nr=1, ProvideFileOptions options=PROVIDE_DEFAULT)
Provides direcotry dir from media number media_nr.
Definition MediaSetAccess.cc:390
zypp::MediaSetAccess::_label
std::string _label
Definition MediaSetAccess.h:378
zypp::MediaSetAccess::_medias
MediaMap _medias
Mapping between media number and Media Access ID.
Definition MediaSetAccess.h:384
zypp::MediaSetAccess::precacheFiles
void precacheFiles(const std::vector< OnMediaLocation > &files)
Tries to fetch the given files and precaches them.
Definition MediaSetAccess.cc:236
zypp::MediaSetAccess::operator<<
friend std::ostream & operator<<(std::ostream &str, const MediaSetAccess &obj)
zypp::MediaSetAccess::VerifierMap
std::map< media::MediaNr, media::MediaVerifierRef > VerifierMap
Definition MediaSetAccess.h:381
zypp::MediaSetAccess::setVerifier
void setVerifier(unsigned media_nr, const media::MediaVerifierRef &verifier)
Sets a MediaVerifier verifier for given media number.
Definition MediaSetAccess.cc:63
zypp::MediaSetAccess::MediaSetAccess
MediaSetAccess(Url url, Pathname prefered_attach_point="")
Creates a callback enabled media access for specified url.
Definition MediaSetAccess.cc:37
zypp::MediaSetAccess::provideFileFromUrl
static ManagedFile provideFileFromUrl(const Url &file_url, ProvideFileOptions options=PROVIDE_DEFAULT)
Provides file from url.
Definition MediaSetAccess.cc:195
zypp::MediaSetAccess::provide
void provide(const ProvideOperation &op, const OnMediaLocation &resource, ProvideFileOptions options)
Definition MediaSetAccess.cc:256
zypp::MediaSetAccess::ProvideFileOption
ProvideFileOption
Definition MediaSetAccess.h:115
zypp::MediaSetAccess::PROVIDE_DEFAULT
@ PROVIDE_DEFAULT
The user is not asked anything, and the error exception is just propagated.
Definition MediaSetAccess.h:119
zypp::MediaSetAccess::PROVIDE_NON_INTERACTIVE
@ PROVIDE_NON_INTERACTIVE
Definition MediaSetAccess.h:120
zypp::MediaSetAccess::provideFile
Pathname provideFile(const OnMediaLocation &resource, ProvideFileOptions options=PROVIDE_DEFAULT)
Provides a file from a media location.
Definition MediaSetAccess.cc:163
zypp::MediaSetAccess::setLabel
void setLabel(const std::string &label_r)
Set the label identifing this media set and to be sent in a media change request.
Definition MediaSetAccess.h:111
zypp::MediaSetAccess::provideOptionalFile
Pathname provideOptionalFile(const Pathname &file, unsigned media_nr=1)
Provides an optional file from media media_nr.
Definition MediaSetAccess.cc:180
zypp::MediaSetAccess::provideOptionalFileFromUrl
static ManagedFile provideOptionalFileFromUrl(const Url &file_url)
Provides an optional file from url.
Definition MediaSetAccess.cc:215
zypp::MediaSetAccess::MediaMap
std::map< media::MediaNr, media::MediaAccessId > MediaMap
Definition MediaSetAccess.h:380
zypp::MediaSetAccess::doesFileExist
bool doesFileExist(const Pathname &file, unsigned media_nr=1)
Checks if a file exists on the specified media, with user callbacks.
Definition MediaSetAccess.cc:228
zypp::MediaSetAccess::dirInfo
void dirInfo(filesystem::DirContent &retlist, const Pathname &dirname, bool dots=true, unsigned media_nr=1)
Fills retlist with directory information.
Definition MediaSetAccess.cc:100
zypp::MediaSetAccess::release
void release()
Release all attached media of this set.
Definition MediaSetAccess.cc:485
zypp::MediaSetAccess::_prefAttachPoint
Pathname _prefAttachPoint
Prefered mount point.
Definition MediaSetAccess.h:376
zypp::MediaSetAccess::provideFileInternal
Pathname provideFileInternal(const OnMediaLocation &resource, ProvideFileOptions options)
Provides the file from medium number media_nr and returns its local path.
zypp::MediaSetAccess::ProvideOperation
function< void(media::MediaAccessId, const OnMediaLocation &)> ProvideOperation
Definition MediaSetAccess.h:359
zypp::MediaSetAccess::rewriteUrl
static Url rewriteUrl(const Url &url_r, const media::MediaNr medianr)
Replaces media number in specified url with given medianr.
Definition MediaSetAccess.cc:442
zypp::MediaSetAccess::_url
Url _url
Media or media set URL.
Definition MediaSetAccess.h:368
zypp::MediaSetAccess::dumpOn
std::ostream & dumpOn(std::ostream &str) const override
Overload to realize std::ostream & operator<<.
Definition MediaSetAccess.cc:493
zypp::MediaSetAccess::releaseFile
void releaseFile(const OnMediaLocation &resource)
Release file from media.
Definition MediaSetAccess.cc:82
zypp::MediaSetAccess::label
const std::string & label() const
The label identifing this media set and to be sent in a media change request.
Definition MediaSetAccess.h:105
zypp::OnMediaLocation
Describes a resource file located on a medium.
Definition onmedialocation.h:37
zypp::Url
Url manipulation class.
Definition Url.h:93
zypp::base::ReferenceCounted
Base class for reference counted objects.
Definition ReferenceCounted.h:35
zypp::filesystem::Pathname
Pathname.
Definition Pathname.h:47
str
String related utilities and Regular expression matching.
zypp::base::NonCopyable
boost::noncopyable NonCopyable
Ensure derived classes cannot be copied.
Definition NonCopyable.h:26
zypp::filesystem::DirContent
std::list< DirEntry > DirContent
Returned by readdir.
Definition PathInfo.h:526
zypp::media::MediaNr
unsigned int MediaNr
Definition MediaManager.h:32
zypp::media::MediaAccessId
unsigned int MediaAccessId
Media manager access Id type.
Definition MediaSource.h:30
zypp::media::MediaVerifierRef
zypp::RW_pointer< MediaVerifierBase > MediaVerifierRef
A shared reference to the MediaVerifier implementation.
Definition MediaManager.h:107
zypp::url
Url details namespace.
Definition UrlBase.cc:58
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::dumpOn
std::ostream & dumpOn(std::ostream &str, const Capability &obj)
Definition Capability.cc:580
zypp::ZYPP_API
const Arch Arch_armv7hnl Arch_armv7nhl ZYPP_API
Definition Arch.h:247
zypp::MediaSetAccess::ReleaseFileGuard::~ReleaseFileGuard
~ReleaseFileGuard()
Definition MediaSetAccess.h:270
zypp::MediaSetAccess::ReleaseFileGuard::NON_COPYABLE
NON_COPYABLE(ReleaseFileGuard)
zypp::MediaSetAccess::ReleaseFileGuard::_media
MediaSetAccess & _media
Definition MediaSetAccess.h:273
zypp::MediaSetAccess::ReleaseFileGuard::ReleaseFileGuard
ReleaseFileGuard(MediaSetAccess &media_r, const OnMediaLocation &loc_r)
Definition MediaSetAccess.h:266
zypp::MediaSetAccess::ReleaseFileGuard::NON_MOVABLE
NON_MOVABLE(ReleaseFileGuard)
zypp::MediaSetAccess::ReleaseFileGuard::_loc
const OnMediaLocation & _loc
Definition MediaSetAccess.h:274
ZYPP_DEPRECATED
#define ZYPP_DEPRECATED
The ZYPP_DEPRECATED macro can be used to trigger compile-time warnings with gcc >= 3....
Definition Globals.h:112
ZYPP_DECLARE_OPERATORS_FOR_FLAGS
#define ZYPP_DECLARE_OPERATORS_FOR_FLAGS(Name)
Definition Flags.h:177
DEFINE_PTR_TYPE
#define DEFINE_PTR_TYPE(NAME)
Forward declaration of Ptr types.
Definition PtrTypes.h:639
CheckSum.h
ManagedFile.h
Pathname.h
Flags.h
Function.h
NonCopyable.h
PtrTypes.h
ReferenceCounted.h