libzypp 17.36.3
RpmPostTransCollector.cc
Go to the documentation of this file.
1/*---------------------------------------------------------------------\
2| ____ _ __ __ ___ |
3| |__ / \ / / . \ . \ |
4| / / \ V /| _/ _/ |
5| / /__ | | | | | | |
6| /_____||_| |_| |_| |
7| |
8\---------------------------------------------------------------------*/
11#include <iostream>
12#include <fstream>
13#include <optional>
14#include <utility>
15#include <zypp/base/LogTools.h>
17#include <zypp/base/Gettext.h>
18#include <zypp/base/Regex.h>
19#include <zypp/base/IOStream.h>
21#include <zypp/base/PtrTypes.h>
23
24#include <zypp/TmpPath.h>
25#include <zypp/PathInfo.h>
26#include <zypp/HistoryLog.h>
27#include <zypp/ZYppCallbacks.h>
31#include <zypp/ZConfig.h>
32#include <zypp/ZYppCallbacks.h>
33
34using std::endl;
35#undef ZYPP_BASE_LOGGER_LOGGROUP
36#define ZYPP_BASE_LOGGER_LOGGROUP "zypp::posttrans"
37
39namespace zypp
40{
42 namespace target
43 {
49 {
50 friend std::ostream & operator<<( std::ostream & str, const Impl & obj );
51 friend std::ostream & dumpOn( std::ostream & str, const Impl & obj );
52
54 using ScriptList = std::list< std::pair<std::string,std::string> >;
55
57 struct Dumpfile
58 {
59 Dumpfile( Pathname dumpfile_r )
60 : _dumpfile { std::move(dumpfile_r) }
61 {}
62
64 size_t _numscripts = 0;
65 bool _runposttrans = true;
66 };
67
68 public:
69 Impl( Pathname &&root_r )
70 : _root(std::move( root_r ))
71 , _myJobReport { "cmdout", "%posttrans" }
72 {}
73
74 Impl(const Impl &) = delete;
75 Impl(Impl &&) = delete;
76 Impl &operator=(const Impl &) = delete;
77 Impl &operator=(Impl &&) = delete;
78
80 {}
81
82 bool hasPosttransScript( const Pathname & rpmPackage_r )
83 { return bool(getHeaderIfPosttrans( rpmPackage_r )); }
84
85 void collectPosttransInfo( const Pathname & rpmPackage_r, const std::vector<std::string> & runposttrans_r )
86 { if ( not collectDumpPosttransLines( runposttrans_r ) ) collectScriptForPackage( rpmPackage_r ); }
87
88 void collectPosttransInfo( const std::vector<std::string> & runposttrans_r )
89 { collectDumpPosttransLines( runposttrans_r ); }
90
92 {
93 if ( pkg ) {
94 if ( not _scripts ) {
96 }
97
98 filesystem::TmpFile script( tmpDir(), pkg->ident() );
99 filesystem::addmod( script.path(), 0500 ); // script must be executable
100 script.autoCleanup( false ); // no autodelete; within a tmpdir
101 {
102 std::ofstream out( script.path().c_str() );
103 out << "#! " << pkg->tag_posttransprog() << endl
104 << pkg->tag_posttrans() << endl;
105 }
106
107 _scripts->push_back( std::make_pair( script.path().basename(), pkg->tag_name() ) );
108 MIL << "COLLECT posttrans: '" << PathInfo( script.path() ) << "' for package: '" << pkg->tag_name() << "'" << endl;
109 }
110 }
111
112 void collectScriptForPackage( const Pathname & rpmPackage_r )
113 { collectScriptFromHeader( getHeaderIfPosttrans( rpmPackage_r ) ); }
114
120 bool collectDumpPosttransLines( const std::vector<std::string> & runposttrans_r )
121 {
122 if ( runposttrans_r.empty() ) {
123 if ( _dumpfile and _dumpfile->_runposttrans ) {
124 MIL << "LOST dump_posttrans support" << endl;
125 _dumpfile->_runposttrans = false; // rpm was downgraded to a version not supporing --runposttrans
126 }
127 return false;
128 }
129
130 if ( not _dumpfile ) {
131 filesystem::TmpFile dumpfile( tmpDir(), "dumpfile" );
132 filesystem::addmod( dumpfile.path(), 0400 ); // dumpfile must be readable
133 dumpfile.autoCleanup( false ); // no autodelete; within a tmpdir
134 _dumpfile = Dumpfile( dumpfile.path() );
135 MIL << "COLLECT dump_posttrans to '" << _dumpfile->_dumpfile << endl;
136 }
137
138 std::ofstream out( _dumpfile->_dumpfile.c_str(), std::ios_base::app );
139 for ( const auto & s : runposttrans_r ) {
140 out << s << endl;
141 }
142 _dumpfile->_numscripts += runposttrans_r.size();
143 MIL << "COLLECT " << runposttrans_r.size() << " dump_posttrans lines" << endl;
144 return true;
145 }
146
156 {
157 if ( _dumpfile && not _dumpfile->_runposttrans ) {
158 // Here a downgraded rpm lost the ability to --runposttrans. Extract at least any
159 // missing %posttrans scripts collected in _dumpfile and prepend them to the _scripts.
160 MIL << "Extract missing %posttrans scripts and prepend them to the scripts." << endl;
161
162 // collectScriptFromHeader appends to _scripts, so we save here and append again later
163 std::optional<ScriptList> savedscripts;
164 if ( _scripts ) {
165 savedscripts = std::move(*_scripts);
166 _scripts = std::nullopt;
167 }
168
170 recallFromDumpfile( _dumpfile->_dumpfile, [&]( const std::string& n_r, const std::string& v_r, const std::string& r_r, const std::string& a_r ) -> void {
171 if ( it.findPackage( n_r, Edition( v_r, r_r ) ) && headerHasPosttrans( *it ) )
172 collectScriptFromHeader( *it );
173 } );
174
175 // append any savedscripts
176 if ( savedscripts ) {
177 if ( _scripts ) {
178 _scripts->splice( _scripts->end(), *savedscripts );
179 } else {
180 _scripts = std::move(*savedscripts);
181 }
182 }
183 _dumpfile = std::nullopt;
184 }
185
186 if ( not ( _scripts || _dumpfile ) )
187 return; // Nothing todo
188
189 // ProgressReport counting the scripts ( 0:preparation, 1->n:for n scripts, n+1: indicate success)
191 ProgressData scriptProgress( [&]() -> ProgressData::value_type {
193 if ( _scripts )
194 ret += _scripts->size();
195 if ( _dumpfile )
196 ret += _dumpfile->_numscripts;
197 return ret;
198 }() );
199 scriptProgress.sendTo( ProgressReportAdaptor( ProgressData::ReceiverFnc(), report ) );
200 // Translator: progress bar label
201 std::string scriptProgressName { _("Running post-transaction scripts") };
202 // Translator: progress bar label; %1% is a script identifier like '%posttrans(mypackage-2-0.noarch)'
203 str::Format fmtScriptProgressRun { _("Running %1% script") };
204 // Translator: headline; %1% is a script identifier like '%posttrans(mypackage-2-0.noarch)'
205 str::Format fmtRipoff { _("%1% script output:") };
206 std::string sendRipoff;
207
208 HistoryLog historylog;
209
210 // lambda to prepare reports for a new script
211 auto startNewScript = [&] ( const std::string & scriptident_r ) -> void {
212 // scriptident_r : script identifier like "%transfiletriggerpostun(istrigger-2-0.noarch)"
213 sendRipoff = fmtRipoff % scriptident_r;
214 scriptProgress.name( fmtScriptProgressRun % scriptident_r );
215 scriptProgress.incr();
216 };
217
218 // lambda to send script output to reports
219 auto sendScriptOutput = [&] ( const std::string & line_r ) -> void {
220 OnScopeExit cleanup; // in case we need it
221 if ( not sendRipoff.empty() ) {
222 historylog.comment( sendRipoff, true /*timestamp*/);
223 _myJobReport.set( "ripoff", std::cref(sendRipoff) );
224 cleanup.setDispose( [&]() -> void {
225 _myJobReport.erase( "ripoff" );
226 sendRipoff.clear();
227 } );
228 }
229 historylog.comment( line_r );
230 _myJobReport.info( line_r );
231 };
232
233 // send the initial progress report
234 scriptProgress.name( scriptProgressName );
235 scriptProgress.toMin();
236
237 // Scripts first...
238 if ( _scripts ) {
239 Pathname noRootScriptDir( ZConfig::instance().update_scriptsPath() / tmpDir().basename() );
240 // like rpm would report it (intentionally not translated and NL-terminated):
241 str::Format fmtScriptFailedMsg { "warning: %%posttrans(%1%) scriptlet failed, exit status %2%\n" };
242 str::Format fmtPosttrans { "%%posttrans(%1%)" };
243
244 rpm::RpmDb::db_const_iterator it { rpm_r.dbConstIterator() }; // Open DB only once
245 while ( ! _scripts->empty() )
246 {
247 const auto &scriptPair = _scripts->front();
248 const std::string & script = scriptPair.first;
249 const std::string & pkgident( script.substr( 0, script.size()-6 ) ); // strip tmp file suffix[6]
250 startNewScript( fmtPosttrans % pkgident );
251
252 int npkgs = 0;
253 for ( it.findByName( scriptPair.second ); *it; ++it )
254 ++npkgs;
255
256 MIL << "EXECUTE posttrans: " << script << " with argument: " << npkgs << endl;
258 "/bin/sh",
259 (noRootScriptDir/script).asString(),
260 str::numstring( npkgs )
261 };
262 ExternalProgram prog( cmd, ExternalProgram::Stderr_To_Stdout, false, -1, true, _root );
263
264 for( std::string line = prog.receiveLine(); ! line.empty(); line = prog.receiveLine() ) {
265 sendScriptOutput( line );
266 }
267 //script was executed, remove it from the list
268 _scripts->pop_front();
269
270 int ret = prog.close();
271 if ( ret != 0 )
272 {
273 std::string msg { fmtScriptFailedMsg % pkgident % ret };
274 WAR << msg;
275 sendScriptOutput( msg ); // info!, as rpm would have reported it.
276 }
277 }
278 _scripts = std::nullopt;
279 }
280
281 // ...then 'rpm --runposttrans'
282 int res = 0; // Indicate a failed call to rpm itself! (a failed script is just a warning)
283 if ( _dumpfile ) {
284 res = rpm_r.runposttrans( _dumpfile->_dumpfile, [&] ( const std::string & line_r ) ->void {
285 if ( str::startsWith( line_r, "RIPOFF:" ) )
286 startNewScript( line_r.substr( 7 ) ); // new scripts ident sent by rpm
287 else
288 sendScriptOutput( line_r );
289 } );
290 if ( res != 0 )
291 _myJobReport.error( str::Format("rpm --runposttrans returned %1%.") % res );
292
293 _dumpfile = std::nullopt;
294 }
295
296 // send a final progress report
297 scriptProgress.name( scriptProgressName );
298 if ( res == 0 )
299 scriptProgress.toMax(); // Indicate 100%, in case Dumpfile::_numscripts estimation was off
300 return;
301 }
302
308 {
309 if ( not ( _scripts || _dumpfile ) )
310 return; // Nothing todo
311
312 str::Str msg;
313
314 if ( _scripts ) {
315 // Legacy format logs all collected %posttrans
316 msg << "%posttrans scripts skipped while aborting:" << endl;
317 for ( const auto & script : *_scripts )
318 {
319 WAR << "UNEXECUTED posttrans: " << script.first << endl;
320 const std::string & pkgident( script.first.substr( 0, script.first.size()-6 ) ); // strip tmp file suffix[6]
321 msg << " " << pkgident << "\n";
322 }
323 _scripts = std::nullopt;
324 }
325
326 if ( _dumpfile ) {
327 msg << "%posttrans and %transfiletrigger scripts are not executed when aborting!" << endl;
328 _dumpfile = std::nullopt;
329 }
330
331 HistoryLog historylog;
332 historylog.comment( msg, true /*timestamp*/);
333 _myJobReport.warning( msg );
334 }
335
336 private:
339 {
340 if ( !_ptrTmpdir ) _ptrTmpdir.reset( new filesystem::TmpDir( _root / ZConfig::instance().update_scriptsPath(), "posttrans" ) );
341 DBG << _ptrTmpdir->path() << endl;
342 return _ptrTmpdir->path();
343 }
344
347 {
348 bool ret = false;
349 if ( pkg_r ) {
350 std::string prog( pkg_r->tag_posttransprog() );
351 if ( not prog.empty() && prog != "<lua>" ) // by now leave lua to rpm
352 ret = true;
353 }
354 return ret;
355 }
356
361 {
362 if ( _headercache.first == rpmPackage_r )
363 return _headercache.second;
364
366 if ( ret ) {
367 if ( not headerHasPosttrans( ret ) )
368 ret = nullptr;
369 } else {
370 WAR << "Unexpectedly this is no package: " << rpmPackage_r << endl;
371 }
372 _headercache = std::make_pair( rpmPackage_r, ret );
373 return ret;
374 }
375
377 void recallFromDumpfile( const Pathname & dumpfile_r, std::function<void(std::string,std::string,std::string,std::string)> consume_r )
378 {
379 // dump_posttrans: install 10 terminfo-base-6.4.20230819-19.1.x86_64
380 static const str::regex rxInstalled { "^dump_posttrans: +install +[0-9]+ +(.+)-([^-]+)-([^-]+)\\.([^.]+)" };
381 str::smatch what;
382 iostr::forEachLine( InputStream( dumpfile_r ), [&]( int num_r, const std::string& line_r ) -> bool {
383 if( str::regex_match( line_r, what, rxInstalled ) )
384 consume_r( what[1], what[2], what[3], what[4] );
385 return true; // continue iostr::forEachLine
386 } );
387 }
388
389 private:
391 std::optional<ScriptList> _scripts;
392 std::optional<Dumpfile> _dumpfile;
394
396
397 std::pair<Pathname,rpm::RpmHeader::constPtr> _headercache;
398 };
399
401 inline std::ostream & operator<<( std::ostream & str, const RpmPostTransCollector::Impl & obj )
402 { return str << "RpmPostTransCollector::Impl"; }
403
405 inline std::ostream & dumpOn( std::ostream & str, const RpmPostTransCollector::Impl & obj )
406 { return str << obj; }
407
409 //
410 // CLASS NAME : RpmPostTransCollector
411 //
413
415 : _pimpl( new Impl( std::move(root_r) ) )
416 {}
417
420
422 { return _pimpl->hasPosttransScript( rpmPackage_r ); }
423
424 void RpmPostTransCollector::collectPosttransInfo( const Pathname & rpmPackage_r, const std::vector<std::string> & runposttrans_r )
425 { _pimpl->collectPosttransInfo( rpmPackage_r, runposttrans_r ); }
426
427 void RpmPostTransCollector::collectPosttransInfo( const std::vector<std::string> & runposttrans_r )
428 { _pimpl->collectPosttransInfo( runposttrans_r ); }
429
431 { _pimpl->executeScripts( rpm_r ); }
432
434 { return _pimpl->discardScripts(); }
435
436 std::ostream & operator<<( std::ostream & str, const RpmPostTransCollector & obj )
437 { return str << *obj._pimpl; }
438
439 std::ostream & dumpOn( std::ostream & str, const RpmPostTransCollector & obj )
440 { return dumpOn( str, *obj._pimpl ); }
441
442 } // namespace target
444} // namespace zypp
Execute a program and give access to its io An object of this class encapsulates the execution of an ...
int close() override
Wait for the progamm to complete.
std::vector< std::string > Arguments
Writing the zypp history file.
Definition HistoryLog.h:57
void comment(const std::string &comment, bool timestamp=false)
Log a comment (even multiline).
Helper to create and pass std::istream.
Definition inputstream.h:57
Maintain [min,max] and counter (value) for progress counting.
void sendTo(const ReceiverFnc &fnc_r)
Set ReceiverFnc.
function< bool(const ProgressData &)> ReceiverFnc
Most simple version of progress reporting The percentage in most cases.
static ZConfig & instance()
Singleton ctor.
Definition ZConfig.cc:935
std::string receiveLine()
Read one line from the input stream.
Wrapper class for stat/lstat.
Definition PathInfo.h:226
const char * c_str() const
String representation.
Definition Pathname.h:112
std::string basename() const
Return the last component of this path.
Definition Pathname.h:130
Provide a new empty temporary directory and recursively delete it when no longer needed.
Definition TmpPath.h:182
Provide a new empty temporary file and delete it when no longer needed.
Definition TmpPath.h:128
Pathname path() const
Definition TmpPath.cc:152
bool autoCleanup() const
Whether path is valid and deleted when the last reference drops.
Definition TmpPath.cc:169
Regular expression.
Definition Regex.h:95
Regular expression match result.
Definition Regex.h:168
RpmPostTransCollector implementation.
UserDataJobReport _myJobReport
JobReport with ContentType "cmdout/%posttrans".
void discardScripts()
Discard all remembered scrips.
Impl & operator=(const Impl &)=delete
void collectPosttransInfo(const std::vector< std::string > &runposttrans_r)
void recallFromDumpfile(const Pathname &dumpfile_r, std::function< void(std::string, std::string, std::string, std::string)> consume_r)
Retrieve "dump_posttrans: install" lines from dumpfile_r and pass n,v,r,a to the consumer_r.
rpm::RpmHeader::constPtr getHeaderIfPosttrans(const Pathname &rpmPackage_r)
Cache RpmHeader for consecutive hasPosttransScript / collectScriptForPackage calls.
Pathname tmpDir()
Lazy create tmpdir on demand.
bool collectDumpPosttransLines(const std::vector< std::string > &runposttrans_r)
Return whether runposttrans lines were collected.
void collectPosttransInfo(const Pathname &rpmPackage_r, const std::vector< std::string > &runposttrans_r)
scoped_ptr< filesystem::TmpDir > _ptrTmpdir
friend std::ostream & operator<<(std::ostream &str, const Impl &obj)
std::list< std::pair< std::string, std::string > > ScriptList
<posttrans script basename, pkgname> pairs.
bool hasPosttransScript(const Pathname &rpmPackage_r)
void executeScripts(rpm::RpmDb &rpm_r)
Execute the remembered scripts.
std::ostream & dumpOn(std::ostream &str, const RpmPostTransCollector::Impl &obj)
Verbose stream output.
void collectScriptFromHeader(const rpm::RpmHeader::constPtr &pkg)
std::pair< Pathname, rpm::RpmHeader::constPtr > _headercache
std::ostream & operator<<(std::ostream &str, const RpmPostTransCollector::Impl &obj)
Stream output.
friend std::ostream & dumpOn(std::ostream &str, const Impl &obj)
void collectScriptForPackage(const Pathname &rpmPackage_r)
bool headerHasPosttrans(const rpm::RpmHeader::constPtr &pkg_r) const
Return whether RpmHeader has a posttrans.
void collectPosttransInfo(const Pathname &rpmPackage_r, const std::vector< std::string > &runposttrans_r)
Extract and remember a packages posttrans script or dump_posttrans lines for later execution.
void executeScripts(rpm::RpmDb &rpm_r)
Execute the remembered scripts and/or or dump_posttrans lines.
RW_pointer< Impl > _pimpl
Implementation class.
RpmPostTransCollector(Pathname root_r)
Default ctor.
bool hasPosttransScript(const Pathname &rpmPackage_r)
Test whether a package defines a posttrans script.
void discardScripts()
Discard all remembered scripts and/or or dump_posttrans lines.
Interface to the rpm program.
Definition RpmDb.h:51
int runposttrans(const Pathname &filename_r, const std::function< void(const std::string &)> &output_r)
Run collected posttrans and transfiletrigger(postun|in) if rpm --runposttrans is supported.
Definition RpmDb.cc:2006
db_const_iterator dbConstIterator() const
Definition RpmDb.cc:247
intrusive_ptr< const RpmHeader > constPtr
Definition RpmHeader.h:65
static RpmHeader::constPtr readPackage(const Pathname &path, VERIFICATION verification=VERIFY)
Get an accessible packages data from disk.
Definition RpmHeader.cc:212
Definition Arch.h:364
String related utilities and Regular expression matching.
boost::noncopyable NonCopyable
Ensure derived classes cannot be copied.
Definition NonCopyable.h:26
int addmod(const Pathname &path, mode_t mode)
Add the mode bits to the file given by path.
Definition PathInfo.cc:1109
int forEachLine(std::istream &str_r, const function< bool(int, std::string)> &consume_r)
Simple lineparser: Call functor consume_r for each line.
Definition IOStream.cc:100
std::string numstring(char n, int w=0)
Definition String.h:289
bool regex_match(const std::string &s, smatch &matches, const regex &regex)
\relates regex \ingroup ZYPP_STR_REGEX \relates regex \ingroup ZYPP_STR_REGEX
Definition Regex.h:70
std::ostream & dumpOn(std::ostream &str, const RpmPostTransCollector &obj)
std::ostream & operator<<(std::ostream &str, const CommitPackageCache &obj)
Easy-to use interface to the ZYPP dependency resolver.
AutoDispose< void > OnScopeExit
std::string asString(const Patch::Category &obj)
Definition Patch.cc:122
JobReport convenience sending this instance of UserData with each message.
Convenient building of std::string with boost::format.
Definition String.h:253
Convenient building of std::string via std::ostringstream Basically a std::ostringstream autoconverti...
Definition String.h:212
Data regarding the dumpfile used if rpm --runposttrans is supported.
bool _runposttrans
Set to false if rpm lost –runposttrans support during transaction.
Pathname _dumpfile
The file holding the collected dump_posttrans: lines.
size_t _numscripts
Number of scripts we collected (roughly estimated)
Wrapper providing a librpmDb::db_const_iterator for this RpmDb.
Definition RpmDb.h:65
#define _(MSG)
Definition Gettext.h:39
#define DBG
Definition Logger.h:99
#define MIL
Definition Logger.h:100
#define WAR
Definition Logger.h:101
Interface to gettext.