zypp::HistoryLog Class Reference

Simple wrapper for progress log. More...

#include <HistoryLog.h>

List of all members.

Public Member Functions
	HistoryLog (const Pathname &rootdir=Pathname())
	Constructor with an optional root directory.
	~HistoryLog ()
void	comment (const std::string &comment, bool timestamp=false)
	Log a comment (even multiline).
void	install (const PoolItem &pi)
	Log installation (or update) of a package.
void	remove (const PoolItem &pi)
	Log removal of a package.
void	addRepository (const RepoInfo &repo)
	Log a newly added repository.
void	removeRepository (const RepoInfo &repo)
	Log recently removed repository.
void	modifyRepository (const RepoInfo &oldrepo, const RepoInfo &newrepo)
	Log certain modifications to a repository.
Static Public Member Functions
static void	setRoot (const Pathname &root)
	Set new root directory to the default history log file path.
static const Pathname &	fname ()
	Get the current log file path.
Private Member Functions
	HistoryLog (const HistoryLog &)
HistoryLog &	operator= (const HistoryLog &)

---

Detailed Description

Simple wrapper for progress log.

Refcnt, filename and corresponding ofstream are static members. Logfile constructor raises, destructor lowers refcounter. On refcounter changing from 0->1, file is opened. Changing from 1->0 the file is closed. Thus Logfile objects should be local to those functions, writing the log, and must not be stored permanently.

Usage: some method () { PoolItem pi; ... HistoryLog().install(pi); ... HistoryLog().comment(someMessage); }

Note:

Take care to set proper target root dir if needed. Either pass it via the constructor, or set it via setRoot(Pathname) method. The default location of the file is determined by ZConfig::historyLogPath() which defaults to /var/log/zypp/history.

See also:

http://en.opensuse.org/Libzypp/Package_History

Todo:

The implementation as pseudo signleton is questionable. Use shared_ptr instead of handcrafted ref/unref. Manage multiple logs at different locations.

Definition at line 59 of file HistoryLog.h.

---

Constructor & Destructor Documentation

zypp::HistoryLog::HistoryLog

(

const HistoryLog &

)

[private]

zypp::HistoryLog::HistoryLog

(

const Pathname &

rootdir = Pathname()

)

Constructor with an optional root directory.

Parameters:

rootdir

actual target root directory

Definition at line 120 of file HistoryLog.cc.

zypp::HistoryLog::~HistoryLog

(

)

Definition at line 126 of file HistoryLog.cc.

---

Member Function Documentation

HistoryLog& zypp::HistoryLog::operator=

(

const HistoryLog &

)

[private]

void zypp::HistoryLog::setRoot

(

const Pathname &

root

)

[static]

Set new root directory to the default history log file path.

This path will be prepended to the default log file path. This should be done where there is a potential that the target root has changed.

Parameters:

root	new root directory.

Definition at line 131 of file HistoryLog.cc.

const Pathname & zypp::HistoryLog::fname

(

)

[static]

Get the current log file path.

Definition at line 147 of file HistoryLog.cc.

void zypp::HistoryLog::comment	(	const std::string &	comment,
		bool	timestamp = false
	)

Log a comment (even multiline).

Parameters:

comment	the comment
timestamp	whether to include a timestamp at the start of the comment

Definition at line 156 of file HistoryLog.cc.

void zypp::HistoryLog::install

(

const PoolItem &

pi

)

Log installation (or update) of a package.

Definition at line 188 of file HistoryLog.cc.

void zypp::HistoryLog::remove

(

const PoolItem &

pi

)

Log removal of a package.

Definition at line 219 of file HistoryLog.cc.

void zypp::HistoryLog::addRepository

(

const RepoInfo &

repo

)

Log a newly added repository.

Parameters:

repo	info about the added repository

Definition at line 250 of file HistoryLog.cc.

void zypp::HistoryLog::removeRepository

(

const RepoInfo &

repo

)

Log recently removed repository.

Parameters:

repo	info about the removed repository

Definition at line 262 of file HistoryLog.cc.

void zypp::HistoryLog::modifyRepository	(	const RepoInfo &	oldrepo,
		const RepoInfo &	newrepo
	)

Log certain modifications to a repository.

Parameters:

oldrepo	info about the old repository
newrepo	info about the new repository

Definition at line 272 of file HistoryLog.cc.

---

The documentation for this class was generated from the following files:

• zypp/HistoryLog.h
• zypp/HistoryLog.cc