An item that is responsible for downloading the meta-index {{{ file (i.e., Release) itself and verifying its signature. More...

#include <acquire-item.h>

Inheritance diagram for pkgAcqMetaIndex:

[legend]

Collaboration diagram for pkgAcqMetaIndex:

[legend]

Public Types
enum	ItemState { StatIdle, StatFetching, StatDone, StatError, StatAuthError, StatTransientNetworkError }
	The current status of this item. More...

Public Member Functions
	pkgAcqMetaIndex (pkgAcquire Owner, std::string URI, std::string URIDesc, std::string ShortDesc, std::string SigFile, const std::vector< struct IndexTarget > IndexTargets, indexRecords MetaIndexParser)
	Create a new pkgAcqMetaIndex. More...

void	AddWeakPointer (WeakPointable **weakptr)
	Add a new weak pointer. More...

virtual std::string	Custom600Headers ()
	Custom headers to be sent to the fetch process. More...

virtual std::string	DescURI ()
	A "descriptive" URI-like string. More...

virtual void	Done (std::string Message, unsigned long long Size, std::string Hash, pkgAcquire::MethodConfig *Cnf)
	Invoked by the acquire worker when the object was fetched successfully. More...

virtual void	Failed (std::string Message, pkgAcquire::MethodConfig *Cnf)
	Invoked by the acquire worker when the object couldn't be fetched. More...

virtual void	Finished ()
	Invoked by the worker when the download is completely done. More...

pkgAcquire *	GetOwner ()

virtual std::string	HashSum ()
	HashSum. More...

virtual bool	IsTrusted ()

void	RemoveWeakPointer (WeakPointable **weakptr)
	Remove the weak pointer from the list of weak pointers. More...

void	ReportMirrorFailure (std::string FailCode)
	Report mirror problem. More...

virtual std::string	ShortDesc ()
	Short item description. More...

virtual void	Start (std::string Message, unsigned long long Size)
	Invoked when the worker starts to fetch this object. More...

Public Attributes
bool	Complete
	If true, the entire object has been successfully fetched. More...

std::string	DestFile
	The name of the file into which the retrieved object will be written. More...

std::string	ErrorText
	Contains a textual description of the error encountered if Status is StatError or StatAuthError. More...

unsigned long long	FileSize
	The size of the object to fetch. More...

unsigned long	ID
	A client-supplied unique identifier. More...

bool	Local
	If true, the URI of this object is "local". More...

const char *	Mode
	If not NULL, contains the name of a subprocess that is operating on this object (for instance, "gzip" or "gpgv"). More...

unsigned long long	PartialSize
	How much of the object was already fetched. More...

unsigned int	QueueCounter
	The number of fetch queues into which this item has been inserted. More...

enum pkgAcquire::Item::ItemState	Status

std::string	UsedMirror

Protected Member Functions
void	AuthDone (std::string Message)
	Called when authentication succeeded. More...

void	Dequeue ()
	Remove this item from its owner's queue. More...

void	QueueIndexes (bool verify)
	Starts downloading the individual index files. More...

void	QueueURI (ItemDesc &Item)
	Insert this item into its owner's queue. More...

void	Rename (std::string From, std::string To)
	Rename a file without modifying its timestamp. More...

void	RetrievalDone (std::string Message)
	Called when a file is finished being retrieved. More...

bool	VerifyVendor (std::string Message)
	Check that the release file is a release file for the correct distribution. More...

Protected Attributes
bool	AuthPass
	If true, the index's signature is currently being verified. More...

pkgAcquire::ItemDesc	Desc
	The fetch command that is currently being processed. More...

bool	IMSHit

const std::vector< struct IndexTarget * > *	IndexTargets
	The index files to download. More...

indexRecords *	MetaIndexParser
	The parser for the meta-index file. More...

pkgAcquire *	Owner
	The acquire object with which this item is associated. More...

std::string	RealURI
	The URI that is actually being downloaded; never modified by pkgAcqMetaIndex. More...

std::string	SigFile
	The file in which the signature for this index was stored. More...

Detailed Description

An item that is responsible for downloading the meta-index {{{ file (i.e., Release) itself and verifying its signature.

Once the download and verification are complete, the downloads of the individual index files are queued up using pkgAcqDiffIndex. If the meta-index file had a valid signature, the expected hashsums of the index files will be the md5sums listed in the meta-index; otherwise, the expected hashsums will be "" (causing the authentication of the index files to be bypassed).

Member Enumeration Documentation

enum pkgAcquire::Item::ItemState

inherited

The current status of this item.

Enumerator
StatIdle	The item is waiting to be downloaded.
StatFetching	The item is currently being downloaded.
StatDone	The item has been successfully downloaded.
StatError	An error was encountered while downloading this item.
StatAuthError	The item was downloaded but its authenticity could not be verified.
StatTransientNetworkError	The item was could not be downloaded because of a transient network error (e.g. network down)

Constructor & Destructor Documentation

pkgAcqMetaIndex::pkgAcqMetaIndex	(	pkgAcquire *	Owner,
		std::string	URI,
		std::string	URIDesc,
		std::string	ShortDesc,
		std::string	SigFile,
		const std::vector< struct IndexTarget * > *	IndexTargets,
		indexRecords *	MetaIndexParser
	)

Create a new pkgAcqMetaIndex.

Member Function Documentation

void WeakPointable::AddWeakPointer ( WeakPointable ** weakptr )

inlineinherited

Add a new weak pointer.

References WeakPointable::pointers.

void pkgAcqMetaIndex::AuthDone ( std::string Message )

protected

Called when authentication succeeded.

Sanity-checks the authenticated file, queues up the individual index files for download, and saves the signature in the lists directory next to the authenticated list file.

Parameters

Message The message block received from the fetch subprocess.

virtual std::string pkgAcqMetaIndex::Custom600Headers ( )

virtual

Custom headers to be sent to the fetch process.

Returns: a string containing RFC822-style headers that are to be inserted into the 600 URI Acquire message sent to the fetch subprocess. The headers are inserted after a newline-less line, so they should (if nonempty) have a leading newline and no trailing newline.

Reimplemented from pkgAcquire::Item.

Reimplemented in pkgAcqMetaClearSig.

void pkgAcquire::Item::Dequeue ( )

inlineprotectedinherited

Remove this item from its owner's queue.

References pkgAcquire::Dequeue(), and pkgAcquire::Item::Owner.

Here is the call graph for this function:

virtual std::string pkgAcqMetaIndex::DescURI ( )

inlinevirtual

A "descriptive" URI-like string.

Returns: a URI that should be used to describe what is being fetched.

Implements pkgAcquire::Item.

References RealURI.

virtual void pkgAcqMetaIndex::Done	(	std::string	Message,
		unsigned long long	Size,
		std::string	Hash,
		pkgAcquire::MethodConfig *	Cnf
	)

virtual

Invoked by the acquire worker when the object was fetched successfully.

Note that the object might not have been written to DestFile; check for the presence of an Alt-Filename entry in Message to find the file to which it was really written.

Done is often used to switch from one stage of the processing to the next (e.g. fetching, unpacking, copying). It is one branch of the continuation of the fetch process.

Parameters

Message	Data from the acquire method. Use LookupTag() to parse it.
Size	The size of the object that was fetched.
Hash	The HashSum of the object that was fetched.
Cnf	The method via which the object was fetched.

See Also: pkgAcqMethod

Reimplemented from pkgAcquire::Item.

virtual void pkgAcqMetaIndex::Failed	(	std::string	Message,
		pkgAcquire::MethodConfig *	Cnf
	)

virtual

Invoked by the acquire worker when the object couldn't be fetched.

This is a branch of the continuation of the fetch process.

Parameters

Message	An RFC822-formatted message from the acquire method describing what went wrong. Use LookupTag() to parse it.
Cnf	The method via which the worker tried to fetch this object.

See Also: pkgAcqMethod

Reimplemented from pkgAcquire::Item.

Reimplemented in pkgAcqMetaClearSig.

virtual void pkgAcquire::Item::Finished ( )

inlinevirtualinherited

Invoked by the worker when the download is completely done.

Reimplemented in pkgAcqArchive.

pkgAcquire* pkgAcquire::Item::GetOwner ( )

inlineinherited

Returns: the acquire process with which this item is associated.

References pkgAcquire::Item::Owner.

virtual std::string pkgAcquire::Item::HashSum ( )

inlinevirtualinherited

HashSum.

Returns: the HashSum of this object, if applicable; otherwise, an empty string.

Reimplemented in pkgAcqFile, pkgAcqArchive, and pkgAcqIndex.

virtual bool pkgAcquire::Item::IsTrusted ( )

inlinevirtualinherited

Returns: true if this object is being fetched from a trusted source.

Reimplemented in pkgAcqArchive.

void pkgAcqMetaIndex::QueueIndexes ( bool verify )

protected

Starts downloading the individual index files.

Parameters

verify If true, only indices whose expected hashsum can be determined from the meta-index will be downloaded, and the hashsums of indices will be checked (reporting StatAuthError if there is a mismatch). If verify is false, no hashsum checking will be performed.

void pkgAcquire::Item::QueueURI ( ItemDesc & Item )

inlineprotectedinherited

Insert this item into its owner's queue.

Parameters

ItemDesc Metadata about this item (its URI and description).

References pkgAcquire::Enqueue(), and pkgAcquire::Item::Owner.

Here is the call graph for this function:

void WeakPointable::RemoveWeakPointer ( WeakPointable ** weakptr )

inlineinherited

Remove the weak pointer from the list of weak pointers.

References WeakPointable::pointers.

void pkgAcquire::Item::Rename	(	std::string	From,
		std::string	To
	)

protectedinherited

Rename a file without modifying its timestamp.

Many item methods call this as their final action.

Parameters

From	The file to be renamed.
To	The new name of #From. If #To exists it will be overwritten.

void pkgAcquire::Item::ReportMirrorFailure ( std::string FailCode )

inherited

Report mirror problem.

This allows reporting mirror failures back to a centralized server. The apt-report-mirror-failure script is called for this

Parameters

FailCode A short failure string that is send

void pkgAcqMetaIndex::RetrievalDone ( std::string Message )

protected

Called when a file is finished being retrieved.

If the file was not downloaded to DestFile, a copy process is set up to copy it to DestFile; otherwise, Complete is set to true and the file is moved to its final location.

Parameters

Message The message block received from the fetch subprocess.

virtual std::string pkgAcquire::Item::ShortDesc ( )

inlinevirtualinherited

Short item description.

Returns: a brief description of the object being fetched.

Reimplemented in pkgAcqArchive.

References pkgAcquire::Item::DescURI().

Here is the call graph for this function:

virtual void pkgAcquire::Item::Start	(	std::string	Message,
		unsigned long long	Size
	)

virtualinherited

Invoked when the worker starts to fetch this object.

Parameters

Message	RFC822-formatted data from the worker process. Use LookupTag() to parse it.
Size	The size of the object being fetched.

See Also: pkgAcqMethod

bool pkgAcqMetaIndex::VerifyVendor ( std::string Message )

protected

Check that the release file is a release file for the correct distribution.

Returns: true if no fatal errors were encountered.

Member Data Documentation

bool pkgAcqMetaIndex::AuthPass

protected

If true, the index's signature is currently being verified.

bool pkgAcquire::Item::Complete

inherited

If true, the entire object has been successfully fetched.

Subclasses should set this to true when appropriate.

pkgAcquire::ItemDesc pkgAcqMetaIndex::Desc

protected

The fetch command that is currently being processed.

std::string pkgAcquire::Item::DestFile

inherited

The name of the file into which the retrieved object will be written.

std::string pkgAcquire::Item::ErrorText

inherited

Contains a textual description of the error encountered if Status is StatError or StatAuthError.

unsigned long long pkgAcquire::Item::FileSize

inherited

The size of the object to fetch.

unsigned long pkgAcquire::Item::ID

inherited

A client-supplied unique identifier.

This field is initalized to 0; it is meant to be filled in by clients that wish to use it to uniquely identify items.

Todo:: it's unused in apt itself

bool pkgAcqMetaIndex::IMSHit

protected

const std::vector<struct IndexTarget*>* pkgAcqMetaIndex::IndexTargets

protected

The index files to download.

bool pkgAcquire::Item::Local

inherited

If true, the URI of this object is "local".

The only effect of this field is to exclude the object from the download progress indicator's overall statistics.

indexRecords* pkgAcqMetaIndex::MetaIndexParser

protected

The parser for the meta-index file.

const char* pkgAcquire::Item::Mode

inherited

If not NULL, contains the name of a subprocess that is operating on this object (for instance, "gzip" or "gpgv").

pkgAcquire* pkgAcquire::Item::Owner

protectedinherited

The acquire object with which this item is associated.

Referenced by pkgAcquire::Item::Dequeue(), pkgAcquire::Item::GetOwner(), and pkgAcquire::Item::QueueURI().

unsigned long long pkgAcquire::Item::PartialSize

inherited

How much of the object was already fetched.

unsigned int pkgAcquire::Item::QueueCounter

inherited

The number of fetch queues into which this item has been inserted.

There is one queue for each source from which an item could be downloaded.

See Also: pkgAcquire

std::string pkgAcqMetaIndex::RealURI

protected

The URI that is actually being downloaded; never modified by pkgAcqMetaIndex.

Referenced by DescURI().

std::string pkgAcqMetaIndex::SigFile

protected

The file in which the signature for this index was stored.

If empty, the signature and the md5sums of the individual indices will not be checked.

enum pkgAcquire::Item::ItemState pkgAcquire::Item::Status

inherited

std::string pkgAcquire::Item::UsedMirror

inherited

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

/usr/include/apt-pkg/acquire-item.h

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation