libzypp 17.36.4
provide.h
Go to the documentation of this file.
1/*---------------------------------------------------------------------\
2| ____ _ __ __ ___ |
3| |__ / \ / / . \ . \ |
4| / / \ V /| _/ _/ |
5| / /__ | | | | | | |
6| /_____||_| |_| |_| |
7| |
8\---------------------------------------------------------------------*/
9#ifndef ZYPP_MEDIA_PROVIDE_H_INCLUDED
10#define ZYPP_MEDIA_PROVIDE_H_INCLUDED
11
15#include <zypp-core/zyppng/base/Base>
16#include <zypp-core/zyppng/async/AsyncOp>
18#include <zypp-core/ByteCount.h>
19#include <zypp-media/ng/LazyMediaHandle>
20#include <zypp-media/ng/ProvideFwd>
21#include <zypp-media/ng/ProvideRes>
22#include <zypp-media/auth/AuthData>
23#include <boost/any.hpp>
24
25namespace zypp {
26 class Url;
27 namespace media {
28 struct CredManagerOptions;
29 }
30}
31
42namespace zyppng {
43
44 class ProvidePrivate;
45 using AnyMap = std::unordered_map<std::string, boost::any>;
47
52 {
53 public:
54
56
57 ProvideMediaHandle () = default;
58 ProvideMediaHandle ( Provide &parent, AttachedMediaInfo_Ptr mediaInfoRef );
59 std::shared_ptr<Provide> parent() const;
60 bool isValid () const;
61 std::string handle() const;
62 const zypp::Url &baseUrl() const;
63 const std::optional<zypp::Pathname> &localPath() const;
64 zyppng::AttachedMediaInfo_constPtr mediaInfo() const;
65 private:
66 ProvideWeakRef _parent;
67 AttachedMediaInfo_Ptr _mediaRef;
68 };
69
75 {
76 public:
77
78 struct Stats {
79 std::chrono::steady_clock::time_point _startTime;
80 std::chrono::steady_clock::time_point _lastPulseTime;
81 uint _itemsSinceStart = 0; //< How many items have been started since Provide::start() was called
82 uint _runningItems = 0; //< How many items are currently running
83 zypp::ByteCount _finishedBytes; //< The number of bytes that were finished completely
84 zypp::ByteCount _expectedBytes; //< The number of currently expected bytes
85 zypp::ByteCount _partialBytes; //< The number of bytes of items that were already partially downloaded but the item they belong to is not finished
86 zypp::ByteCount _perSecondSinceLastPulse; //< The download speed since the last pulse
87 zypp::ByteCount _perSecond; //< The download speed we are currently operating with
88 };
89
90 ProvideStatus( ProvideRef parent );
91 virtual ~ProvideStatus(){}
92
93 virtual void provideStart ();
94 virtual void provideDone (){}
95 virtual void itemStart ( ProvideItem &item ){}
96 virtual void itemDone ( ProvideItem &item );
97 virtual void itemFailed ( ProvideItem &item );
98 virtual void requestStart ( ProvideItem &item, uint32_t reqId, const zypp::Url &url, const AnyMap &extraData = {} ){}
99 virtual void requestDone ( ProvideItem &item, uint32_t reqId, const AnyMap &extraData = {} ){}
100 virtual void requestRedirect ( ProvideItem &item, uint32_t reqId, const zypp::Url &toUrl, const AnyMap &extraData = {} ){}
101 virtual void requestFailed ( ProvideItem &item, uint32_t reqId, const std::exception_ptr &err, const AnyMap &requestData = {} ){}
102 virtual void pulse ( );
103
104 const Stats &stats() const;
105
106 private:
108 ProvideWeakRef _provider;
109 };
110
111 class Provide : public Base
112 {
114 template<class T> friend class ProvidePromise;
115 friend class ProvideItem;
116 friend class ProvideMediaHandle;
117 friend class ProvideStatus;
118 public:
119
123
124 static ProvideRef create( const zypp::Pathname &workDir = "" );
125
130 expected<LazyMediaHandle> prepareMedia ( const std::vector<zypp::Url> &urls, const ProvideMediaSpec &request );
131 expected<LazyMediaHandle> prepareMedia ( const zypp::Url &url, const ProvideMediaSpec &request );
132
134 AsyncOpRef<expected<MediaHandle>> attachMedia( const std::vector<zypp::Url> &urls, const ProvideMediaSpec &request );
136
137 AsyncOpRef<expected<ProvideRes>> provide( const std::vector<zypp::Url> &urls, const ProvideFileSpec &request );
138 AsyncOpRef<expected<ProvideRes>> provide( const zypp::Url &url, const ProvideFileSpec &request );
139 AsyncOpRef<expected<ProvideRes>> provide( const MediaHandle &attachHandle, const zypp::Pathname &fileName, const ProvideFileSpec &request );
140 AsyncOpRef<expected<ProvideRes>> provide( const LazyMediaHandle &attachHandle, const zypp::Pathname &fileName, const ProvideFileSpec &request );
141
142
146 AsyncOpRef<expected<zypp::CheckSum>> checksumForFile ( const zypp::Pathname &p, const std::string &algorithm );
147
153
154 void start();
155 void setWorkerPath( const zypp::Pathname &path );
156 bool isRunning() const;
157 bool ejectDevice ( const std::string &queueRef, const std::string &device );
158
159 void setStatusTracker( ProvideStatusRef tracker );
160
161 const zypp::Pathname &providerWorkdir () const;
162
163 const zypp::media::CredManagerOptions &credManangerOptions () const;
164 void setCredManagerOptions( const zypp::media::CredManagerOptions & opt );
165
166 SignalProxy<void()> sigIdle();
167
168 enum Action {
169 ABORT, // abort and return error
170 RETRY, // retry
171 SKIP // abort and set skip request
172 };
173 using MediaChangeAction = std::optional<Action>;
174
181 SignalProxy<MediaChangeAction( const std::string &queueRef, const std::string &label, const int32_t mediaNr, const std::vector<std::string> &devices, const std::optional<std::string> &desc )> sigMediaChangeRequested( );
182
187 SignalProxy< std::optional<zypp::media::AuthData> ( const zypp::Url &reqUrl, const std::string &triedUsername, const std::map<std::string, std::string> &extraValues ) > sigAuthRequired();
188
189
190 static auto copyResultToDest ( ProvideRef provider, const zypp::Pathname &targetPath ) {
191 return [ providerRef=std::move(provider), targetPath = targetPath ]( ProvideRes &&file ){
192 zypp::filesystem::assert_dir( targetPath.dirname () );
193 return providerRef->copyFile( std::move(file), targetPath );
194 };
195 }
196
197
198 private:
199 Provide( const zypp::Pathname &workDir );
200 };
201
202}
203#endif
Store and operate with byte count.
Definition ByteCount.h:32
Url manipulation class.
Definition Url.h:93
Pathname dirname() const
Return all but the last component od this path.
Definition Pathname.h:126
AttachedMediaInfo_Ptr _mediaRef
Definition provide.h:67
const zypp::Url & baseUrl() const
Definition provide.cc:974
zyppng::AttachedMediaInfo_constPtr mediaInfo() const
Definition provide.cc:990
ProvideWeakRef _parent
Definition provide.h:66
const std::optional< zypp::Pathname > & localPath() const
Definition provide.cc:982
std::string handle() const
Definition provide.cc:967
std::shared_ptr< Provide > parent() const
Definition provide.cc:957
A ProvideRes object is a reference counted ownership of a resource in the cache provided by a Provide...
Definition provideres.h:36
virtual void requestFailed(ProvideItem &item, uint32_t reqId, const std::exception_ptr &err, const AnyMap &requestData={})
Definition provide.h:101
virtual void provideDone()
Definition provide.h:94
virtual void requestDone(ProvideItem &item, uint32_t reqId, const AnyMap &extraData={})
Definition provide.h:99
virtual void itemStart(ProvideItem &item)
Definition provide.h:95
virtual void provideStart()
Definition provide.cc:1230
const Stats & stats() const
Definition provide.cc:1255
virtual void requestStart(ProvideItem &item, uint32_t reqId, const zypp::Url &url, const AnyMap &extraData={})
Definition provide.h:98
virtual void pulse()
Definition provide.cc:1260
ProvideWeakRef _provider
Definition provide.h:108
ProvideStatus(ProvideRef parent)
Definition provide.cc:1226
virtual void itemFailed(ProvideItem &item)
Definition provide.cc:1250
virtual void requestRedirect(ProvideItem &item, uint32_t reqId, const zypp::Url &toUrl, const AnyMap &extraData={})
Definition provide.h:100
virtual void itemDone(ProvideItem &item)
Definition provide.cc:1237
virtual ~ProvideStatus()
Definition provide.h:91
bool isRunning() const
AsyncOpRef< expected< ProvideRes > > provide(const std::vector< zypp::Url > &urls, const ProvideFileSpec &request)
Definition provide.cc:1066
const zypp::media::CredManagerOptions & credManangerOptions() const
Definition provide.cc:1198
SignalProxy< std::optional< zypp::media::AuthData >(const zypp::Url &reqUrl, const std::string &triedUsername, const std::map< std::string, std::string > &extraValues) > sigAuthRequired()
Definition provide.cc:1219
static ProvideRef create(const zypp::Pathname &workDir="")
Definition provide.cc:1002
AsyncOpRef< expected< MediaHandle > > attachMedia(const std::vector< zypp::Url > &urls, const ProvideMediaSpec &request)
Definition provide.cc:1043
friend class ProvideMediaHandle
Definition provide.h:116
void setWorkerPath(const zypp::Pathname &path)
Definition provide.cc:1175
SignalProxy< void()> sigIdle()
Definition provide.cc:1209
void setCredManagerOptions(const zypp::media::CredManagerOptions &opt)
Definition provide.cc:1204
Provide(const zypp::Pathname &workDir)
Definition provide.cc:996
ProvideRes Res
Definition provide.h:122
AsyncOpRef< expected< zypp::CheckSum > > checksumForFile(const zypp::Pathname &p, const std::string &algorithm)
Definition provide.cc:1120
void setStatusTracker(ProvideStatusRef tracker)
Definition provide.cc:1188
AsyncOpRef< expected< MediaHandle > > attachMediaIfNeeded(LazyMediaHandle lazyHandle)
Definition provide.cc:1023
zyppng::LazyMediaHandle< Provide > LazyMediaHandle
Definition provide.h:121
friend class ProvidePromise
Definition provide.h:114
bool ejectDevice(const std::string &queueRef, const std::string &device)
Definition provide.cc:1180
expected< LazyMediaHandle > prepareMedia(const std::vector< zypp::Url > &urls, const ProvideMediaSpec &request)
Definition provide.cc:1007
AsyncOpRef< expected< zypp::ManagedFile > > copyFile(const zypp::Pathname &source, const zypp::Pathname &target)
Definition provide.cc:1140
SignalProxy< MediaChangeAction(const std::string &queueRef, const std::string &label, const int32_t mediaNr, const std::vector< std::string > &devices, const std::optional< std::string > &desc)> sigMediaChangeRequested()
Definition provide.cc:1214
std::optional< Action > MediaChangeAction
Definition provide.h:173
static auto copyResultToDest(ProvideRef provider, const zypp::Pathname &targetPath)
Definition provide.h:190
friend class ProvideItem
Definition provide.h:115
const zypp::Pathname & providerWorkdir() const
Definition provide.cc:1193
friend class ProvideStatus
Definition provide.h:117
ProvideMediaHandle MediaHandle
Definition provide.h:120
Definition Arch.h:364
int assert_dir(const Pathname &path, unsigned mode)
Like 'mkdir -p'.
Definition PathInfo.cc:324
Url details namespace.
Definition UrlBase.cc:58
Easy-to use interface to the ZYPP dependency resolver.
AutoDispose< const Pathname > ManagedFile
A Pathname plus associated cleanup code to be executed when path is no longer needed.
Definition ManagedFile.h:27
std::shared_ptr< AsyncOp< T > > AsyncOpRef
Definition asyncop.h:255
std::unordered_map< std::string, boost::any > AnyMap
Definition provide.h:45
zypp::ByteCount _partialBytes
Definition provide.h:85
zypp::ByteCount _perSecondSinceLastPulse
Definition provide.h:86
zypp::ByteCount _perSecond
Definition provide.h:87
zypp::ByteCount _expectedBytes
Definition provide.h:84
std::chrono::steady_clock::time_point _startTime
Definition provide.h:79
zypp::ByteCount _finishedBytes
Definition provide.h:83
std::chrono::steady_clock::time_point _lastPulseTime
Definition provide.h:80
#define DEFINE_PTR_TYPE(NAME)
Forward declaration of Ptr types.
Definition PtrTypes.h:639
#define ZYPP_DECLARE_PRIVATE(Class)
Definition zyppglobal.h:87