libzypp: zypp/HistoryLog.cc Source File

libzypp 17.38.6

HistoryLog.cc
Go to the documentation of this file.
1/*---------------------------------------------------------------------\
2| ____ _ __ __ ___ |
3| |__ / \ / / . \ . \ |
4| / / \ V /| _/ _/ |
5| / /__ | | | | | | |
6| /_____||_| |_| |_| |
7| |
8\---------------------------------------------------------------------*/
12#include <iostream>
13#include <fstream>
14#include <unistd.h>
15
16#include <zypp/ZConfig.h>
17#include <zypp-core/base/String.h>
18#include <zypp-core/base/Logger.h>
19#include <zypp-core/base/IOStream.h>
20
21#include <zypp/PathInfo.h>
22#include <zypp-core/Date.h>
23
24#include <zypp/PoolItem.h>
25#include <zypp/Package.h>
26#include <zypp/RepoInfo.h>
27
28#include <zypp/HistoryLog.h>
29#include <zypp/HistoryLogData.h>
30
31using std::endl;
32using std::string;
33
34namespace zypp
35{
36 namespace
37 {
38 inline string timestamp()
39 { return zypp::Date::now().form( HISTORY_LOG_DATE_FORMAT ); }
40
41 inline string userAtHostname()
42 {
43 static char buf[256];
44 string result;
45 char * tmp = ::cuserid(buf);
46 if (tmp)
47 {
48 result = string(tmp);
49 if (!::gethostname(buf, 255))
50 result += "@" + string(buf);
51 }
52 return result;
53 }
54
55 static std::string pidAndAppname()
56 {
57 static std::string _val;
58 if ( _val.empty() )
59 {
60 pid_t mypid = getpid();
61 zypp::Pathname p( "/proc/"+zypp::str::numstring(mypid)+"/exe" );
62 zypp::Pathname myname( zypp::filesystem::readlink( p ) );
63
64 _val += zypp::str::numstring(mypid);
65 _val += ":";
66 _val += myname.basename();
67 }
68 return _val;
69 }
70
71 static std::string cmdline()
72 {
73 static std::string _val;
74 if ( _val.empty() )
75 {
76 pid_t mypid = getpid();
77 {
78 std::ifstream cmdlineStr( Pathname("/proc/"+zypp::str::numstring(mypid)+"/cmdline").c_str() );
79 char ch = 0;
80 const char * sep = "'";
81 while ( cmdlineStr && cmdlineStr.get( ch ) )
82 {
83 if ( sep )
84 {
85 _val += sep;
86 sep = nullptr;
87 }
88 switch ( ch )
89 {
90 case '\0': _val += '\''; sep = " '"; break;
91 case '\n': _val += ' '; break;
92 case '\\': _val += '\\'; _val += '\\'; break;
93 case '|': _val += '\\'; _val += '|'; break;
94 default: _val += ch; break;
95 }
96 }
97 }
98 }
99 return _val;
100 }
101 } // namespace
102
103 namespace
104 {
105 const char _sep = '|';
106 std::ofstream _log;
107 unsigned _refcnt = 0;
108 Pathname _fname;
109 Pathname _fnameLastFail;
110
111 inline void openLog()
112 {
113 if ( _fname.empty() )
114 _fname = ZConfig::instance().historyLogFile();
115
116 _log.clear();
117 _log.open( _fname.asString().c_str(), std::ios::out|std::ios::app );
118 if( !_log && _fnameLastFail != _fname )
119 {
120 ERR << "Could not open logfile '" << _fname << "'" << endl;
121 _fnameLastFail = _fname;
122 }
123 }
124
125 inline void closeLog()
126 {
127 _log.clear();
128 _log.close();
129 }
130
131 inline void refUp()
132 {
133 if ( !_refcnt )
134 openLog();
135 ++_refcnt;
136 }
137
138 inline void refDown()
139 {
140 --_refcnt;
141 if ( !_refcnt )
142 closeLog();
143 }
144 } // namespace
145
147 //
148 // CLASS NAME : HistoryLog
149 //
151
152 HistoryLog::HistoryLog( const Pathname & rootdir )
153 {
154 setRoot( rootdir );
155 refUp();
156 }
157
158 HistoryLog::~HistoryLog()
159 {
160 refDown();
161 }
162
163 void HistoryLog::setRoot( const Pathname & rootdir )
164 {
165 if ( ! rootdir.absolute() )
166 return;
167
168 if ( _refcnt )
169 closeLog();
170
171 _fname = ZConfig::instance().historyLogFile();
172 if ( _fname != "/dev/null" ) // no need to redirect /dev/null into the target
173 _fname = rootdir / _fname;
174 filesystem::assert_dir( _fname.dirname() );
175 MIL << "installation log file " << _fname << endl;
176
177 if ( _refcnt )
178 openLog();
179 }
180
181 const Pathname & HistoryLog::fname()
182 {
183 if ( _fname.empty() )
184 _fname = ZConfig::instance().historyLogFile();
185 return _fname;
186 }
187
189
190 void HistoryLog::comment( const string & comment, bool timestamp_r )
191 {
192 if (comment.empty())
193 return;
194
195 _log << "# ";
196 if ( timestamp_r )
197 _log << timestamp() << " ";
198
199 const char * s = comment.c_str();
200 const char * c = s;
201 unsigned size = comment.size();
202
203 // ignore the last newline
204 if (comment[size-1] == '\n')
205 --size;
206
207 for ( unsigned i = 0; i < size; ++i, ++c )
208 if ( *c == '\n' )
209 {
210 _log << string( s, c + 1 - s ) << "# ";
211 s = c + 1;
212 }
213
214 if ( s < c )
215 _log << std::string( s, c-s );
216
217 _log << endl;
218 }
219
221
222 void HistoryLog::stampCommand()
223 {
224 _log
225 << timestamp() // 1 timestamp
226 << _sep << HistoryActionID::STAMP_COMMAND.asString(true) // 2 action
227 << _sep << userAtHostname() // 3 requested by
228 << _sep << cmdline() // 4 command
229 << _sep << str::escape(ZConfig::instance().userData(), _sep) // 6 userdata
230 << endl;
231
232 }
233
234 void HistoryLog::install( const PoolItem & pi )
235 {
236 if ( ! pi.isKind<Package>() ) return;
237 const Package::constPtr p = asKind<Package>(pi.resolvable());
238
239 _log
240 << timestamp() // 1 timestamp
241 << _sep << HistoryActionID::INSTALL.asString(true) // 2 action
242 << _sep << p->name() // 3 name
243 << _sep << p->edition() // 4 evr
244 << _sep << p->arch(); // 5 arch
245
246 // ApplLow is what the solver selected on behalf of the user.
247 if (pi.status().isByUser() || pi.status().isByApplLow() )
248 _log << _sep << userAtHostname(); // 6 requested by
249 else if (pi.status().isByApplHigh())
250 _log << _sep << pidAndAppname();
251 else
252 _log << _sep;
253
254 _log
255 << _sep << p->repoInfo().alias() // 7 repo alias
256 << _sep << p->checksum().checksum() // 8 checksum
257 << _sep << str::escape(ZConfig::instance().userData(), _sep) // 9 userdata
258 << endl;
259 }
260
261
262 void HistoryLog::remove( const PoolItem & pi )
263 {
264 if ( ! pi.isKind<Package>() ) return;
265 const Package::constPtr p = asKind<Package>(pi.resolvable());
266
267 _log
268 << timestamp() // 1 timestamp
269 << _sep << HistoryActionID::REMOVE.asString(true) // 2 action
270 << _sep << p->name() // 3 name
271 << _sep << p->edition() // 4 evr
272 << _sep << p->arch(); // 5 arch
273
274 // ApplLow is what the solver selected on behalf of the user.
275 if ( pi.status().isByUser() || pi.status().isByApplLow() )
276 _log << _sep << userAtHostname(); // 6 requested by
277 else if (pi.status().isByApplHigh())
278 _log << _sep << pidAndAppname();
279 else
280 _log << _sep;
281
282 _log
283 << _sep << str::escape(ZConfig::instance().userData(), _sep) // 7 userdata
284 << endl;
285 }
286
288
289 void HistoryLog::addRepository(const RepoInfo & repo)
290 {
291 _log
292 << timestamp() // 1 timestamp
293 << _sep << HistoryActionID::REPO_ADD.asString(true) // 2 action
294 << _sep << str::escape(repo.alias(), _sep) // 3 alias
295 << _sep << str::escape(repo.url().asString(), _sep) // 4 primary URL
296 << _sep << str::escape(ZConfig::instance().userData(), _sep) // 5 userdata
297 << endl;
298 }
299
300
301 void HistoryLog::removeRepository(const RepoInfo & repo)
302 {
303 _log
304 << timestamp() // 1 timestamp
305 << _sep << HistoryActionID::REPO_REMOVE.asString(true) // 2 action
306 << _sep << str::escape(repo.alias(), _sep) // 3 alias
307 << _sep << str::escape(ZConfig::instance().userData(), _sep) // 4 userdata
308 << endl;
309 }
310
311
312 void HistoryLog::modifyRepository(
313 const RepoInfo & oldrepo, const RepoInfo & newrepo)
314 {
315 if (oldrepo.alias() != newrepo.alias())
316 {
317 _log
318 << timestamp() // 1 timestamp
319 << _sep << HistoryActionID::REPO_CHANGE_ALIAS.asString(true) // 2 action
320 << _sep << str::escape(oldrepo.alias(), _sep) // 3 old alias
321 << _sep << str::escape(newrepo.alias(), _sep) // 4 new alias
322 << _sep << str::escape(ZConfig::instance().userData(), _sep) // 5 userdata
323 << endl;
324 }
325 if ( oldrepo.url() != newrepo.url() )
326 {
327 _log
328 << timestamp() // 1 timestamp
329 << _sep << HistoryActionID::REPO_CHANGE_URL.asString(true) // 2 action
330 << _sep << str::escape(oldrepo.url().asString(), _sep) // 3 old url
331 << _sep << str::escape(newrepo.url().asString(), _sep) // 4 new url
332 << _sep << str::escape(ZConfig::instance().userData(), _sep) // 5 userdata
333 << endl;
334 }
335 }
336
337 void HistoryLog::patchStateChange( const PoolItem & pi, ResStatus::ValidateValue oldstate )
338 {
339 if ( ! pi.isKind<Patch>() ) return;
340 const Patch::constPtr p = asKind<Patch>(pi.resolvable());
341
342 _log
343 << timestamp() // 1 timestamp
344 << _sep << HistoryActionID::PATCH_STATE_CHANGE.asString(true) // 2 action
345 << _sep << p->name() // 3 name
346 << _sep << p->edition() // 4 evr
347 << _sep << p->arch() // 5 arch
348 << _sep << p->repoInfo().alias() // 6 repo alias
349 << _sep << p->severity() // 7 severity
350 << _sep << p->category() // 8 category
351 << _sep << ResStatus::validateValueAsString( oldstate ) // 9 old state
352 << _sep << pi.status().validateValueAsString() // 10 new state
353 << _sep << str::escape(ZConfig::instance().userData(), _sep) // 11 userdata
354 << endl;
355 }
356
358
359} // namespace zypp
Date.h
HistoryLogData.h
HISTORY_LOG_DATE_FORMAT
#define HISTORY_LOG_DATE_FORMAT
Definition HistoryLogData.h:26
HistoryLog.h
IOStream.h
Logger.h
MIL
#define MIL
Definition Logger.h:103
ERR
#define ERR
Definition Logger.h:105
Package.h
PoolItem.h
RepoInfo.h
String.h
ZConfig.h
zypp::Date::form
std::string form(const std::string &format_r) const
Return string representation according to format as localtime.
Definition Date.h:112
zypp::Date::now
static Date now()
Return the current time.
Definition Date.h:78
zypp::HistoryLog::~HistoryLog
~HistoryLog()
Definition HistoryLog.cc:158
zypp::HistoryLog::HistoryLog
HistoryLog(const HistoryLog &)
zypp::HistoryLog::stampCommand
void stampCommand()
Log info about the current process.
Definition HistoryLog.cc:222
zypp::HistoryLog::setRoot
static void setRoot(const Pathname &root)
Set new root directory to the default history log file path.
Definition HistoryLog.cc:163
zypp::HistoryLog::modifyRepository
void modifyRepository(const RepoInfo &oldrepo, const RepoInfo &newrepo)
Log certain modifications to a repository.
Definition HistoryLog.cc:312
zypp::HistoryLog::remove
void remove(const PoolItem &pi)
Log removal of a package.
Definition HistoryLog.cc:262
zypp::HistoryLog::addRepository
void addRepository(const RepoInfo &repo)
Log a newly added repository.
Definition HistoryLog.cc:289
zypp::HistoryLog::removeRepository
void removeRepository(const RepoInfo &repo)
Log recently removed repository.
Definition HistoryLog.cc:301
zypp::HistoryLog::fname
static const Pathname & fname()
Get the current log file path.
Definition HistoryLog.cc:181
zypp::HistoryLog::install
void install(const PoolItem &pi)
Log installation (or update) of a package.
Definition HistoryLog.cc:234
zypp::HistoryLog::patchStateChange
void patchStateChange(const PoolItem &pi, ResStatus::ValidateValue oldstate)
Log state changes in patches.
Definition HistoryLog.cc:337
zypp::HistoryLog::comment
void comment(const std::string &comment, bool timestamp=false)
Log a comment (even multiline).
Definition HistoryLog.cc:190
zypp::Package
Package interface.
Definition Package.h:34
zypp::Package::constPtr
TraitsType::constPtrType constPtr
Definition Package.h:39
zypp::Patch
Class representing a patch.
Definition Patch.h:38
zypp::Patch::constPtr
TraitsType::constPtrType constPtr
Definition Patch.h:43
zypp::PoolItem
Combining sat::Solvable and ResStatus.
Definition PoolItem.h:51
zypp::PoolItem::resolvable
ResObject::constPtr resolvable() const
Returns the ResObject::constPtr.
Definition PoolItem.cc:227
zypp::PoolItem::status
ResStatus & status() const
Returns the current status.
Definition PoolItem.cc:212
zypp::RepoInfo
What is known about a repository.
Definition RepoInfo.h:72
zypp::RepoInfo::url
Url url() const
Pars pro toto: The first repository url, this is either baseUrls().front() or if no baseUrl is define...
Definition RepoInfo.cc:854
zypp::ResStatus::isByApplLow
bool isByApplLow() const
Definition ResStatus.h:299
zypp::ResStatus::isByApplHigh
bool isByApplHigh() const
Definition ResStatus.h:302
zypp::ResStatus::ValidateValue
ValidateValue
Definition ResStatus.h:95
zypp::ResStatus::isByUser
bool isByUser() const
Definition ResStatus.h:305
zypp::ResStatus::validateValueAsString
std::string validateValueAsString() const
Definition ResStatus.h:234
zypp::Url::asString
std::string asString() const
Returns a default string representation of the Url object.
Definition Url.cc:524
zypp::ZConfig::historyLogFile
Pathname historyLogFile() const
Path where ZYpp install history is logged.
Definition ZConfig.cc:1150
zypp::ZConfig::instance
static ZConfig & instance()
Singleton ctor.
Definition ZConfig.cc:756
zypp::filesystem::Pathname
Pathname.
Definition Pathname.h:48
zypp::filesystem::Pathname::absolute
bool absolute() const
Test for an absolute path.
Definition Pathname.h:119
zypp::repo::RepoInfoBase::alias
std::string alias() const
unique identifier for this source.
Definition RepoInfoBase.cc:110
zypp::filesystem::assert_dir
int assert_dir(const Pathname &path, unsigned mode)
Like 'mkdir -p'.
Definition PathInfo.cc:338
zypp::filesystem::readlink
int readlink(const Pathname &symlink_r, Pathname &target_r)
Like 'readlink'.
Definition PathInfo.cc:943
zypp::repo
Definition DeltaCandidates.cc:30
zypp::str::numstring
std::string numstring(char n, int w=0)
Definition String.h:290
zypp::str::escape
std::string escape(const C_Str &str_r, const char sep_r)
Escape desired character c using a backslash.
Definition String.cc:374
zypp
Easy-to use interface to the ZYPP dependency resolver.
Definition CodePitfalls.doc:2
zypp::asKind
ResTraits< TRes >::PtrType asKind(const sat::Solvable &solvable_r)
Directly create a certain kind of ResObject from sat::Solvable.
Definition ResObject.h:127
zypp::sat::SolvableType::isKind
bool isKind(const ResKind &kind_r) const
Definition SolvableType.h:64
PathInfo.h