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 9ead29c9a6575b250af4b104138bcc4eaca21fc6..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.5 1998/11/05 07:21:36 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


@@ -19,6 +22,7 @@
 
 #include <apt-pkg/acquire.h>
 #include <apt-pkg/sourcelist.h>
 
 #include <apt-pkg/acquire.h>
 #include <apt-pkg/sourcelist.h>

+#include <apt-pkg/pkgrecords.h>

 
 #ifdef __GNUG__
 #pragma interface "apt-pkg/acquire-item.h"
 
 #ifdef __GNUG__
 #pragma interface "apt-pkg/acquire-item.h"


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

+   // Some private helper methods for registering URIs

    pkgAcquire *Owner;
    pkgAcquire *Owner;

-   inline void QueueURI(string URI,string Description) 
-                 {Owner->Enqueue(this,URI,Description);};
+   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:


@@ -40,18 +47,29 @@ class pkgAcquire::Item
    // State of the item
    enum {StatIdle, StatFetching, StatDone, StatError} Status;
    string ErrorText;
    // State of the item
    enum {StatIdle, StatFetching, StatDone, StatError} Status;
    string ErrorText;

-   
+   unsigned long FileSize;
+   unsigned long PartialSize;   
+   char *Mode;
+   unsigned long ID;
+   bool Complete;
+   bool Local;
+

    // Number of queues we are inserted into
    unsigned int QueueCounter;
    
    // File to write the fetch into
    string DestFile;
    // Number of queues we are inserted into
    unsigned int QueueCounter;
    
    // File to write the fetch into
    string DestFile;

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

 
 

+   // 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 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();
 };


@@ -64,11 +82,14 @@ class pkgAcqIndex : public pkgAcquire::Item
    const pkgSourceList::Item *Location;
    bool Decompression;
    bool Erase;
    const pkgSourceList::Item *Location;
    bool Decompression;
    bool Erase;

+   pkgAcquire::ItemDesc Desc;

    
    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 DescURI() {return Location->PackagesURI();};

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


@@ -79,13 +100,65 @@ class pkgAcqIndexRel : public pkgAcquire::Item
    protected:
    
    const pkgSourceList::Item *Location;
    protected:
    
    const pkgSourceList::Item *Location;

+   pkgAcquire::ItemDesc Desc;

    
    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 DescURI() {return Location->ReleaseURI();};

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

+// Item class for archive files
+class pkgAcqArchive : public pkgAcquire::Item
+{
+   protected:
+   
+   // State information for the retry mechanism
+   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:
+   
+   // Specialized action members
+   virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
+   virtual void Done(string Message,unsigned long Size,string Md5Hash);
+   virtual string MD5Sum() {return MD5;};
+   virtual string DescURI() {return Desc.URI;};
+   
+   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