apt  0.9.15
Public Member Functions | List of all members
pkgAcqFile Class Reference

Retrieve an arbitrary file to the current directory. {{{. More...

#include <acquire-item.h>

Inheritance diagram for pkgAcqFile:
pkgAcquire::Item WeakPointable

Public Member Functions

virtual void Failed (std::string Message, pkgAcquire::MethodConfig *Cnf)
 Invoked by the acquire worker when the object couldn't be fetched. More...
 
virtual void Done (std::string Message, unsigned long long Size, std::string CalcHash, pkgAcquire::MethodConfig *Cnf)
 Invoked by the acquire worker when the object was fetched successfully. More...
 
virtual std::string DescURI ()
 A "descriptive" URI-like string. More...
 
virtual std::string HashSum ()
 HashSum. More...
 
virtual std::string Custom600Headers ()
 Custom headers to be sent to the fetch process. More...
 
 pkgAcqFile (pkgAcquire *Owner, std::string URI, std::string Hash, unsigned long long Size, std::string Desc, std::string ShortDesc, const std::string &DestDir="", const std::string &DestFilename="", bool IsIndexFile=false)
 Create a new pkgAcqFile object. More...
 
- Public Member Functions inherited from pkgAcquire::Item
virtual void Start (std::string Message, unsigned long long Size)
 Invoked when the worker starts to fetch this object. More...
 
virtual std::string ShortDesc ()
 Short item description. More...
 
virtual void Finished ()
 Invoked by the worker when the download is completely done.
 
pkgAcquireGetOwner ()
 
virtual bool IsTrusted ()
 
void ReportMirrorFailure (std::string FailCode)
 Report mirror problem. More...
 
 Item (pkgAcquire *Owner)
 Initialize an item. More...
 
virtual ~Item ()
 Remove this item from its owner's queue by invoking pkgAcquire::Remove.
 
- Public Member Functions inherited from WeakPointable
void AddWeakPointer (WeakPointable **weakptr)
 
void RemoveWeakPointer (WeakPointable **weakptr)
 
 ~WeakPointable ()
 

Additional Inherited Members

- Public Types inherited from pkgAcquire::Item
enum  ItemState {
  StatIdle, StatFetching, StatDone, StatError,
  StatAuthError, StatTransientNetworkError
}
 The current status of this item. More...
 
- Public Attributes inherited from pkgAcquire::Item
enum pkgAcquire::Item::ItemState Status
 
std::string ErrorText
 Contains a textual description of the error encountered if #Status is StatError or StatAuthError.
 
unsigned long long FileSize
 The size of the object to fetch.
 
unsigned long long PartialSize
 How much of the object was already fetched.
 
const char * Mode
 If not NULL, contains the name of a subprocess that is operating on this object (for instance, "gzip" or "gpgv").
 
unsigned long ID
 A client-supplied unique identifier. More...
 
bool Complete
 If true, the entire object has been successfully fetched. More...
 
bool Local
 If true, the URI of this object is "local". More...
 
std::string UsedMirror
 
unsigned int QueueCounter
 The number of fetch queues into which this item has been inserted. More...
 
std::string DestFile
 The name of the file into which the retrieved object will be written.
 
- Protected Types inherited from pkgAcquire::Item
enum  RenameOnErrorState { HashSumMismatch, SizeMismatch, InvalidFormat }
 
- Protected Member Functions inherited from pkgAcquire::Item
void QueueURI (ItemDesc &Item)
 Insert this item into its owner's queue. More...
 
void Dequeue ()
 Remove this item from its owner's queue.
 
void Rename (std::string From, std::string To)
 Rename a file without modifying its timestamp. More...
 
bool RenameOnError (RenameOnErrorState const state)
 Rename failed file and set error. More...
 
- Protected Attributes inherited from pkgAcquire::Item
pkgAcquireOwner
 The acquire object with which this item is associated.
 

Detailed Description

Retrieve an arbitrary file to the current directory. {{{.

The file is retrieved even if it is accessed via a URL type that normally is a NOP, such as "file". If the download fails, the partial file is renamed to get a ".FAILED" extension.

Constructor & Destructor Documentation

pkgAcqFile ( pkgAcquire Owner,
std::string  URI,
std::string  Hash,
unsigned long long  Size,
std::string  Desc,
std::string  ShortDesc,
const std::string &  DestDir = "",
const std::string &  DestFilename = "",
bool  IsIndexFile = false 
)

Create a new pkgAcqFile object.

Parameters
OwnerThe pkgAcquire object with which this object is associated.
URIThe URI to download.
HashThe hashsum of the file to download, if it is known; otherwise "".
SizeThe size of the file to download, if it is known; otherwise 0.
DescA description of the file being downloaded.
ShortDescA brief description of the file being downloaded.
DestDirThe directory the file should be downloaded into.
DestFilenameThe filename+path the file is downloaded to.
IsIndexFileThe file is considered a IndexFile and cache-control headers like "cache-control: max-age=0" are send

If DestFilename is empty, download to DestDir/<basename> if DestDir is non-empty, $CWD/<basename> otherwise. If DestFilename is NOT empty, DestDir is ignored and DestFilename is the absolute name to which the file should be downloaded.

References pkgAcquire::ItemDesc::Description, pkgAcquire::Item::DestFile, pkgAcquire::Item::FileSize, pkgAcquire::ItemDesc::Owner, pkgAcquire::Item::PartialSize, pkgAcquire::Item::QueueURI(), pkgAcquire::Item::ShortDesc(), pkgAcquire::ItemDesc::ShortDesc, and pkgAcquire::ItemDesc::URI.

Member Function Documentation

string 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.

virtual std::string DescURI ( )
inlinevirtual

A "descriptive" URI-like string.

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

Implements pkgAcquire::Item.

References pkgAcquire::ItemDesc::URI.

void 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
MessageData from the acquire method. Use LookupTag() to parse it.
SizeThe size of the object that was fetched.
HashThe HashSum of the object that was fetched.
CnfThe method via which the object was fetched.
See Also
pkgAcqMethod

Reimplemented from pkgAcquire::Item.

References pkgAcquire::Item::Complete, pkgAcquire::Item::DestFile, pkgAcquire::Item::ErrorText, pkgAcquire::Item::Local, pkgAcquire::Item::QueueURI(), pkgAcquire::MethodConfig::Removable, pkgAcquire::Item::RenameOnError(), pkgAcquire::Item::StatError, and pkgAcquire::ItemDesc::URI.

void 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
MessageAn RFC822-formatted message from the acquire method describing what went wrong. Use LookupTag() to parse it.
CnfThe method via which the worker tried to fetch this object.
See Also
pkgAcqMethod

Reimplemented from pkgAcquire::Item.

References pkgAcquire::Item::ErrorText, pkgAcquire::MethodConfig::LocalOnly, and pkgAcquire::Item::QueueURI().

virtual std::string HashSum ( )
inlinevirtual

HashSum.

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

Reimplemented from pkgAcquire::Item.


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