Merge misc-abi-changes

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

diff --git a/apt-pkg/acquire-item.h b/apt-pkg/acquire-item.h
index 8b6889c4d5bc47c1065f78d54a710341b1ec401c..2b122cffb3c98bb274e81ff05e712d4afef51dc1 100644 (file)
--- a/apt-pkg/acquire-item.h
+++ b/apt-pkg/acquire-item.h
@@ -1,19 +1,19 @@
 // -*- mode: cpp; mode: fold -*-
 // Description                                                         /*{{{*/
 // -*- mode: cpp; mode: fold -*-
 // Description                                                         /*{{{*/

-// $Id: acquire-item.h,v 1.14 1999/01/30 08:08:54 jgg Exp $
+// $Id: acquire-item.h,v 1.26.2.3 2004/01/02 18:51:00 mdz 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.
    
    A Archive class is provided for downloading .deb files. It does Md5
    
    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.
+   checking and source location as well as a retry algorithm.

    
    ##################################################################### */
                                                                        /*}}}*/
    
    ##################################################################### */
                                                                        /*}}}*/


@@ -21,8 +21,11 @@
 #define PKGLIB_ACQUIRE_ITEM_H
 
 #include <apt-pkg/acquire.h>
 #define PKGLIB_ACQUIRE_ITEM_H
 
 #include <apt-pkg/acquire.h>

+#include <apt-pkg/indexfile.h>
+#include <apt-pkg/vendor.h>

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

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

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


@@ -33,19 +36,23 @@ 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:
 
    // State of the item
    void Rename(string From,string To);
    
    public:
 
    // State of the item

-   enum {StatIdle, StatFetching, StatDone, StatError} Status;
+   enum {StatIdle, StatFetching, StatDone, StatError, StatAuthError} Status;

    string ErrorText;
    unsigned long FileSize;
    string ErrorText;
    unsigned long FileSize;

-   char *Mode;
+   unsigned long PartialSize;   
+   const char *Mode;

    unsigned long ID;
    bool Complete;
    bool Local;
    unsigned long ID;
    bool Complete;
    bool Local;


@@ -56,14 +63,21 @@ class pkgAcquire::Item
    // File to write the fetch into
    string DestFile;
 
    // File to write the fetch into
    string DestFile;
 

+   // Action members invoked by the worker

    virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
    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,
+                    pkgAcquire::MethodConfig *Cnf);

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

+   virtual string Custom600Headers() {return string();};
+   virtual string DescURI() = 0;
+   virtual string ShortDesc() {return DescURI();}
+   virtual void Finished() {};
+   
+   // Inquire functions

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

-   virtual string Describe() = 0;
+   pkgAcquire *GetOwner() {return Owner;};
+   virtual bool IsTrusted() {return false;};

    
    

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

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


@@ -73,35 +87,89 @@ class pkgAcqIndex : public pkgAcquire::Item
 {
    protected:
    
 {
    protected:
    

-   const pkgSourceList::Item *Location;

    bool Decompression;
    bool Erase;
    pkgAcquire::ItemDesc Desc;
    bool Decompression;
    bool Erase;
    pkgAcquire::ItemDesc Desc;

+   string RealURI;
+   string ExpectedMD5;

    
    public:
    
    
    public:
    

-   virtual void Done(string Message,unsigned long Size,string Md5Hash);   
+   // Specialized action members
+   virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
+   virtual void Done(string Message,unsigned long Size,string Md5Hash,
+                    pkgAcquire::MethodConfig *Cnf);

    virtual string Custom600Headers();
    virtual string Custom600Headers();

-   virtual string Describe();
+   virtual string DescURI() {return RealURI + ".gz";};

 
 

-   pkgAcqIndex(pkgAcquire *Owner,const pkgSourceList::Item *Location);
+   pkgAcqIndex(pkgAcquire *Owner,string URI,string URIDesc,
+              string ShortDesct, string ExpectedMD5);

 };
 
 };
 

-// Item class for index files
-class pkgAcqIndexRel : public pkgAcquire::Item
+struct IndexTarget
+{
+   string URI;
+   string Description;
+   string ShortDesc;
+   string MetaKey;
+};
+
+// Item class for index signatures
+class pkgAcqMetaSig : public pkgAcquire::Item

 {
    protected:
    
 {
    protected:
    

-   const pkgSourceList::Item *Location;

    pkgAcquire::ItemDesc Desc;
    pkgAcquire::ItemDesc Desc;

-   
+   string RealURI,MetaIndexURI,MetaIndexURIDesc,MetaIndexShortDesc;
+   indexRecords* MetaIndexParser;
+   const vector<struct IndexTarget*>* IndexTargets;
+

    public:
    
    public:
    

-   virtual void Done(string Message,unsigned long Size,string Md5Hash);   
+   // Specialized action members
+   virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
+   virtual void Done(string Message,unsigned long Size,string Md5Hash,
+                    pkgAcquire::MethodConfig *Cnf);

    virtual string Custom600Headers();
    virtual string Custom600Headers();

-   virtual string Describe();
+   virtual string DescURI() {return RealURI; };
+
+   pkgAcqMetaSig(pkgAcquire *Owner,string URI,string URIDesc, string ShortDesc,
+                string MetaIndexURI, string MetaIndexURIDesc, string MetaIndexShortDesc,
+                const vector<struct IndexTarget*>* IndexTargets,
+                indexRecords* MetaIndexParser);
+};
+
+// Item class for index signatures
+class pkgAcqMetaIndex : public pkgAcquire::Item
+{
+   protected:
+   
+   pkgAcquire::ItemDesc Desc;
+   string RealURI; // FIXME: is this redundant w/ Desc.URI?
+   string SigFile;
+   const vector<struct IndexTarget*>* IndexTargets;
+   indexRecords* MetaIndexParser;
+   bool AuthPass;
+
+   bool VerifyVendor();
+   void RetrievalDone(string Message);
+   void AuthDone(string Message);
+   void QueueIndexes(bool verify);
+   
+   public:

    
    

-   pkgAcqIndexRel(pkgAcquire *Owner,const pkgSourceList::Item *Location);
+   // Specialized action members
+   virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
+   virtual void Done(string Message,unsigned long Size,string Md5Hash,
+                    pkgAcquire::MethodConfig *Cnf);
+   virtual string Custom600Headers();
+   virtual string DescURI() {return RealURI; };
+
+   pkgAcqMetaIndex(pkgAcquire *Owner,
+                  string URI,string URIDesc, string ShortDesc,
+                  string SigFile,
+                  const vector<struct IndexTarget*>* IndexTargets,
+                  indexRecords* MetaIndexParser);

 };
 
 // Item class for archive files
 };
 
 // Item class for archive files


@@ -109,6 +177,7 @@ class pkgAcqArchive : public pkgAcquire::Item
 {
    protected:
    
 {
    protected:
    

+   // State information for the retry mechanism

    pkgCache::VerIterator Version;
    pkgAcquire::ItemDesc Desc;
    pkgSourceList *Sources;
    pkgCache::VerIterator Version;
    pkgAcquire::ItemDesc Desc;
    pkgSourceList *Sources;


@@ -117,19 +186,46 @@ class pkgAcqArchive : public pkgAcquire::Item
    string &StoreFilename;
    pkgCache::VerFileIterator Vf;
    unsigned int Retries;
    string &StoreFilename;
    pkgCache::VerFileIterator Vf;
    unsigned int Retries;

-   
+   bool Trusted; 
+
+   // Queue the next available file for download.

    bool QueueNext();
    
    public:
    
    bool QueueNext();
    
    public:
    

+   // Specialized action members

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

+   virtual void Done(string Message,unsigned long Size,string Md5Hash,
+                    pkgAcquire::MethodConfig *Cnf);

    virtual string MD5Sum() {return MD5;};
    virtual string MD5Sum() {return MD5;};

-   virtual void Done(string Message,unsigned long Size,string Md5Hash);
-   virtual string Describe();
+   virtual string DescURI() {return Desc.URI;};
+   virtual string ShortDesc() {return Desc.ShortDesc;};
+   virtual void Finished();
+   virtual bool IsTrusted();

    
    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 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,
+                    pkgAcquire::MethodConfig *Cnf);
+   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
 #endif