* merged with mainline

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

diff --git a/apt-pkg/acquire-item.h b/apt-pkg/acquire-item.h
index d50efc04b0b6607b06c57fca81cae15818b40513..3649d7a039bd2e92575ca6fa83954712cab1b88a 100644 (file)
--- a/apt-pkg/acquire-item.h
+++ b/apt-pkg/acquire-item.h
@@ -1,24 +1,31 @@
 // -*- mode: cpp; mode: fold -*-
 // Description                                                         /*{{{*/
 // -*- mode: cpp; mode: fold -*-
 // Description                                                         /*{{{*/

-// $Id: acquire-item.h,v 1.6 1998/11/09 01:09:21 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.
    
    
    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
 #define PKGLIB_ACQUIRE_ITEM_H
 
 #include <apt-pkg/acquire.h>
    ##################################################################### */
                                                                        /*}}}*/
 #ifndef PKGLIB_ACQUIRE_ITEM_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/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"


@@ -29,68 +36,268 @@ 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;

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

    bool Complete;
    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);
-   virtual void Start(string Message,unsigned long Size);

 
 

+   // Action members invoked by the worker
+   virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
+   virtual void Done(string Message,unsigned long Size,string Md5Hash,
+                    pkgAcquire::MethodConfig *Cnf);
+   virtual void Start(string Message,unsigned long Size);

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

-      
+   virtual string DescURI() = 0;
+   virtual string ShortDesc() {return DescURI();}
+   virtual void Finished() {};
+   
+   // Inquire functions
+   virtual string MD5Sum() {return string();};
+   pkgAcquire *GetOwner() {return Owner;};
+   virtual bool IsTrusted() {return false;};
+   

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

+// item for index diffs
+
+struct DiffInfo {
+   string file;
+   string sha1;
+   unsigned long size;
+};
+
+class pkgAcqDiffIndex : public pkgAcquire::Item
+{
+ protected:
+   bool Debug;
+   pkgAcquire::ItemDesc Desc;
+   string RealURI;
+   string ExpectedMD5;
+   string CurrentPackagesFile;
+   string Description;
+
+ 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 DescURI() {return RealURI + "Index";};
+   virtual string Custom600Headers();
+
+   // helpers
+   bool ParseDiffIndex(string IndexDiffFile);
+   
+   pkgAcqDiffIndex(pkgAcquire *Owner,string URI,string URIDesc,
+                  string ShortDesct, string ExpectedMD5);
+};
+
+class pkgAcqIndexDiffs : public pkgAcquire::Item
+{
+   protected:
+   bool Debug;
+   pkgAcquire::ItemDesc Desc;
+   string RealURI;
+   string ExpectedMD5;
+
+   // this is the SHA-1 sum we expect after the patching
+   string Description;
+   vector<DiffInfo> available_patches;
+   enum {StateFetchIndex,StateFetchDiff,StateUnzipDiff,StateApplyDiff} State;
+
+   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 DescURI() {return RealURI + "Index";};
+
+   // various helpers
+   bool QueueNextDiff();
+   bool ApplyDiff(string PatchFile);
+   void Finish(bool allDone=false);
+
+   pkgAcqIndexDiffs(pkgAcquire *Owner,string URI,string URIDesc,
+                   string ShortDesct, string ExpectedMD5,
+                   vector<DiffInfo> diffs=vector<DiffInfo>());
+};
+

 // Item class for index files
 class pkgAcqIndex : public pkgAcquire::Item
 {
    protected:
    
 // Item class for index files
 class pkgAcqIndex : public pkgAcquire::Item
 {
    protected:
    

-   const pkgSourceList::Item *Location;

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

+   string RealURI;
+   string ExpectedMD5;
+   string CompressionExtension;
+
+   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 Custom600Headers();
+   virtual string DescURI() {return RealURI + CompressionExtension;};
+
+   pkgAcqIndex(pkgAcquire *Owner,string URI,string URIDesc,
+              string ShortDesct, string ExpectedMD5, string compressExt="");
+};
+
+struct IndexTarget
+{
+   string URI;
+   string Description;
+   string ShortDesc;
+   string MetaKey;
+};
+
+// Item class for index signatures
+class pkgAcqMetaSig : public pkgAcquire::Item
+{
+   protected:
+   
+   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 DescURI() {return RealURI; };

 
 

-   pkgAcqIndex(pkgAcquire *Owner,const pkgSourceList::Item *Location);
+   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 files
-class pkgAcqIndexRel : public pkgAcquire::Item
+// Item class for index signatures
+class pkgAcqMetaIndex : public pkgAcquire::Item

 {
    protected:
    
 {
    protected:
    

-   const pkgSourceList::Item *Location;

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

+   string RealURI; // FIXME: is this redundant w/ Desc.URI?
+   string SigFile;
+   const vector<struct IndexTarget*>* IndexTargets;
+   indexRecords* MetaIndexParser;
+   bool AuthPass;
+   // required to deal gracefully with problems caused by incorrect ims hits
+   bool IMSHit; 
+
+   bool VerifyVendor(string Message);
+   void RetrievalDone(string Message);
+   void AuthDone(string Message);
+   void QueueIndexes(bool verify);

    
    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 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
+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;
+   bool Trusted; 
+
+   // 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,
+                    pkgAcquire::MethodConfig *Cnf);
+   virtual string MD5Sum() {return MD5;};
+   virtual string DescURI() {return Desc.URI;};
+   virtual string ShortDesc() {return Desc.ShortDesc;};
+   virtual void Finished();
+   virtual bool IsTrusted();

    
    

-   pkgAcqIndexRel(pkgAcquire *Owner,const pkgSourceList::Item *Location);
+   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;};
+
+   // 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.
+   pkgAcqFile(pkgAcquire *Owner, string URI, string MD5, unsigned long Size,
+             string Desc, string ShortDesc,
+             const string &DestDir="", const string &DestFilename="");

 };
 
 #endif
 };
 
 #endif