Support for memory-only caching

[apt.git] / apt-pkg / acquire-item.h

diff --git a/apt-pkg/acquire-item.h b/apt-pkg/acquire-item.h
index d550b33dba26538dc6fe1a27a7495cb2692b2f93..3079c68efd8dfc91d3cb52a7e1958fac7f0599f7 100644 (file)
--- a/apt-pkg/acquire-item.h
+++ b/apt-pkg/acquire-item.h
@@ -1,17 +1,20 @@
 // -*- mode: cpp; mode: fold -*-
 // Description                                                         /*{{{*/
 // -*- mode: cpp; mode: fold -*-
 // Description                                                         /*{{{*/

-// $Id: acquire-item.h,v 1.10 1998/11/22 03:20:31 jgg Exp $
+// $Id: acquire-item.h,v 1.19 1999/04/11 21:23:09 jgg Exp $

 /* ######################################################################
 
    Acquire Item - Item to acquire
 
    When an item is instantiated it will add it self to the local list in
    the Owner Acquire class. Derived classes will then call QueueURI to 
 /* ######################################################################
 
    Acquire Item - Item to acquire
 
    When an item is instantiated it will add it self to the local list in
    the Owner Acquire class. Derived classes will then call QueueURI to 

-   register all the URI's they wish to fetch for at the initial moment.   
+   register all the URI's they wish to fetch at the initial moment.   

    
    Two item classes are provided to provide functionality for downloading
    of Index files and downloading of Packages.
    
    
    Two item classes are provided to provide functionality for downloading
    of Index files and downloading of Packages.
    

+   A Archive class is provided for downloading .deb files. It does Md5
+   checking and source location as well as a retry algorithm.
+   

    ##################################################################### */
                                                                        /*}}}*/
 #ifndef PKGLIB_ACQUIRE_ITEM_H
    ##################################################################### */
                                                                        /*}}}*/
 #ifndef PKGLIB_ACQUIRE_ITEM_H


@@ -30,10 +33,13 @@ class pkgAcquire::Item
 {  
    protected:
    
 {  
    protected:
    

+   // Some private helper methods for registering URIs

    pkgAcquire *Owner;
    inline void QueueURI(ItemDesc &Item)
                  {Owner->Enqueue(Item);};
    pkgAcquire *Owner;
    inline void QueueURI(ItemDesc &Item)
                  {Owner->Enqueue(Item);};

+   inline void Dequeue() {Owner->Dequeue(this);};

    
    

+   // Safe rename function with timestamp preservation

    void Rename(string From,string To);
    
    public:
    void Rename(string From,string To);
    
    public:


@@ -42,6 +48,7 @@ class pkgAcquire::Item
    enum {StatIdle, StatFetching, StatDone, StatError} Status;
    string ErrorText;
    unsigned long FileSize;
    enum {StatIdle, StatFetching, StatDone, StatError} Status;
    string ErrorText;
    unsigned long FileSize;

+   unsigned long PartialSize;   

    char *Mode;
    unsigned long ID;
    bool Complete;
    char *Mode;
    unsigned long ID;
    bool Complete;


@@ -52,14 +59,17 @@ class pkgAcquire::Item
    
    // File to write the fetch into
    string DestFile;
    
    // File to write the fetch into
    string DestFile;

-   
-   virtual void Failed(string Message);
+
+   // Action members invoked by the worker
+   virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);

    virtual void Done(string Message,unsigned long Size,string Md5Hash);
    virtual void Start(string Message,unsigned long Size);
    virtual void Done(string Message,unsigned long Size,string Md5Hash);
    virtual void Start(string Message,unsigned long Size);

-   virtual string Describe() = 0;
-   

    virtual string Custom600Headers() {return string();};
    virtual string Custom600Headers() {return string();};

-      
+   virtual string DescURI() = 0;
+   
+   // Inquire functions
+   virtual string MD5Sum() {return string();};
+         

    Item(pkgAcquire *Owner);
    virtual ~Item();
 };
    Item(pkgAcquire *Owner);
    virtual ~Item();
 };


@@ -76,9 +86,10 @@ class pkgAcqIndex : public pkgAcquire::Item
    
    public:
    
    
    public:
    

+   // Specialized action members

    virtual void Done(string Message,unsigned long Size,string Md5Hash);   
    virtual string Custom600Headers();
    virtual void Done(string Message,unsigned long Size,string Md5Hash);   
    virtual string Custom600Headers();

-   virtual string Describe();
+   virtual string DescURI() {return Location->PackagesURI();};

 
    pkgAcqIndex(pkgAcquire *Owner,const pkgSourceList::Item *Location);
 };
 
    pkgAcqIndex(pkgAcquire *Owner,const pkgSourceList::Item *Location);
 };


@@ -93,9 +104,11 @@ class pkgAcqIndexRel : public pkgAcquire::Item
    
    public:
    
    
    public:
    

+   // Specialized action members
+   virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);

    virtual void Done(string Message,unsigned long Size,string Md5Hash);   
    virtual string Custom600Headers();
    virtual void Done(string Message,unsigned long Size,string Md5Hash);   
    virtual string Custom600Headers();

-   virtual string Describe();
+   virtual string DescURI() {return Location->ReleaseURI();};

    
    pkgAcqIndexRel(pkgAcquire *Owner,const pkgSourceList::Item *Location);
 };
    
    pkgAcqIndexRel(pkgAcquire *Owner,const pkgSourceList::Item *Location);
 };


@@ -105,21 +118,47 @@ class pkgAcqArchive : public pkgAcquire::Item
 {
    protected:
    
 {
    protected:
    

+   // State information for the retry mechanism

    pkgCache::VerIterator Version;
    pkgAcquire::ItemDesc Desc;
    pkgSourceList *Sources;
    pkgRecords *Recs;
    string MD5;
    string &StoreFilename;
    pkgCache::VerIterator Version;
    pkgAcquire::ItemDesc Desc;
    pkgSourceList *Sources;
    pkgRecords *Recs;
    string MD5;
    string &StoreFilename;

+   pkgCache::VerFileIterator Vf;
+   unsigned int Retries;
+
+   // Queue the next available file for download.
+   bool QueueNext();

    
    public:
    
    
    public:
    

+   // Specialized action members
+   virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);

    virtual void Done(string Message,unsigned long Size,string Md5Hash);
    virtual void Done(string Message,unsigned long Size,string Md5Hash);

-   virtual string Describe();
+   virtual string MD5Sum() {return MD5;};
+   virtual string DescURI() {return Desc.URI;};

    
    pkgAcqArchive(pkgAcquire *Owner,pkgSourceList *Sources,
                 pkgRecords *Recs,pkgCache::VerIterator const &Version,
                 string &StoreFilename);
 };
 
    
    pkgAcqArchive(pkgAcquire *Owner,pkgSourceList *Sources,
                 pkgRecords *Recs,pkgCache::VerIterator const &Version,
                 string &StoreFilename);
 };
 

+// Fetch a generic file to the current directory
+class pkgAcqFile : public pkgAcquire::Item
+{
+   pkgAcquire::ItemDesc Desc;
+   string MD5;
+   
+   public:
+   
+   // Specialized action members
+   virtual void Done(string Message,unsigned long Size,string Md5Hash);
+   virtual string MD5Sum() {return MD5;};
+   virtual string DescURI() {return Desc.URI;};
+   
+   pkgAcqFile(pkgAcquire *Owner,string URI,string MD5,unsigned long Size,
+                 string Desc,string ShortDesc);
+};
+

 #endif
 #endif