New ah_GET_GETCONF macro, better abstraction in the rest.

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

diff --git a/apt-pkg/acquire-item.h b/apt-pkg/acquire-item.h
index da650a63fa7a7e8d4cdd49794589323d823e47ef..fd74280b8f184ba5cf8e9ab530ba70a00ca41b8d 100644 (file)
--- a/apt-pkg/acquire-item.h
+++ b/apt-pkg/acquire-item.h
@@ -1,17 +1,20 @@
 // -*- mode: cpp; mode: fold -*-
 // Description                                                         /*{{{*/
-// $Id: acquire-item.h,v 1.7 1998/11/11 06:54:14 jgg Exp $
+// $Id: acquire-item.h,v 1.22 1999/10/17 20:58:36 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 
-   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.
    
+   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
@@ -19,6 +22,7 @@
 
 #include <apt-pkg/acquire.h>
 #include <apt-pkg/sourcelist.h>
+#include <apt-pkg/pkgrecords.h>
 
 #ifdef __GNUG__
 #pragma interface "apt-pkg/acquire-item.h"
@@ -29,10 +33,13 @@ class pkgAcquire::Item
 {  
    protected:
    
+   // Some private helper methods for registering URIs
    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:
@@ -41,22 +48,29 @@ class pkgAcquire::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;
-   
-   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 string Custom600Headers() {return string();};
-      
+   virtual string DescURI() = 0;
+   virtual void Finished() {};
+   
+   // Inquire functions
+   virtual string MD5Sum() {return string();};
+         
    Item(pkgAcquire *Owner);
    virtual ~Item();
 };
@@ -73,8 +87,10 @@ class pkgAcqIndex : public pkgAcquire::Item
    
    public:
    
+   // Specialized action members
    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);
 };
@@ -89,10 +105,64 @@ class pkgAcqIndexRel : public pkgAcquire::Item
    
    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 string DescURI() {return Location->ReleaseURI();};
    
    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;};
+   virtual void Finished();
+   
+   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 Md5Hash;
+   unsigned int Retries;
+   
+   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 Md5Hash;};
+   virtual string DescURI() {return Desc.URI;};
+   
+   pkgAcqFile(pkgAcquire *Owner,string URI,string MD5,unsigned long Size,
+                 string Desc,string ShortDesc);
+};
+
 #endif