acquire-item.h

Go to the documentation of this file.

// -*- mode: cpp; mode: fold -*-
// Description                                                          /*{{{*/
// $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 
   register all the URI's they wish to fetch at the initial moment.   
   
   Three item classes are provided to provide functionality for
   downloading of Index, Translation and Packages files.
   
   A Archive class is provided for downloading .deb files. It does Hash
   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>
#include <apt-pkg/indexfile.h>
#include <apt-pkg/vendor.h>
#include <apt-pkg/sourcelist.h>
#include <apt-pkg/pkgrecords.h>
#include <apt-pkg/indexrecords.h>
#include <apt-pkg/hashes.h>
#include <apt-pkg/weakptr.h>

class pkgAcquire::Item : public WeakPointable
{  
   protected:
   
   pkgAcquire *Owner;

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

   inline void Dequeue() {Owner->Dequeue(this);};
   
   void Rename(string From,string To);
   
   public:

   enum ItemState
     {
       StatIdle,

       StatFetching,

       StatDone,

       StatError,

       StatAuthError,

       StatTransientNetworkError
     } Status;

   string ErrorText;

   unsigned long long FileSize;

   unsigned long long PartialSize;

   const char *Mode;

   unsigned long ID;

   bool Complete;

   bool Local;
   string UsedMirror;

   unsigned int QueueCounter;
   
   string DestFile;

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

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

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

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

   virtual string DescURI() = 0;
   virtual string ShortDesc() {return DescURI();}

   virtual void Finished() {};
   
   virtual string HashSum() {return string();};

   pkgAcquire *GetOwner() {return Owner;};

   virtual bool IsTrusted() {return false;};
   
   // report mirror problems
   void ReportMirrorFailure(string FailCode);


   Item(pkgAcquire *Owner);

   virtual ~Item();
};
                                                                        /*}}}*/         /*{{{*/
struct DiffInfo {
   string file;

   string sha1;

   unsigned long size;
};
                                                                        /*}}}*/
class pkgAcqSubIndex : public pkgAcquire::Item
{
 protected:
   bool Debug;

   pkgAcquire::ItemDesc Desc;

   HashString ExpectedHash;

 public:
   // Specialized action members
   virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
   virtual void Done(string Message,unsigned long long Size,string Md5Hash,
                     pkgAcquire::MethodConfig *Cnf);
   virtual string DescURI() {return Desc.URI;};
   virtual string Custom600Headers();
   virtual bool ParseIndex(string const &IndexFile);

   pkgAcqSubIndex(pkgAcquire *Owner, string const &URI,string const &URIDesc,
                   string const &ShortDesc, HashString const &ExpectedHash);
};
                                                                        /*}}}*/
class pkgAcqDiffIndex : public pkgAcquire::Item
{
 protected:
   bool Debug;

   pkgAcquire::ItemDesc Desc;

   string RealURI;

   HashString ExpectedHash;

   string CurrentPackagesFile;

   string Description;

 public:
   // Specialized action members
   virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
   virtual void Done(string Message,unsigned long long Size,string Md5Hash,
                     pkgAcquire::MethodConfig *Cnf);
   virtual string DescURI() {return RealURI + "Index";};
   virtual string Custom600Headers();

   bool ParseDiffIndex(string IndexDiffFile);
   

   pkgAcqDiffIndex(pkgAcquire *Owner,string URI,string URIDesc,
                   string ShortDesc, HashString ExpectedHash);
};
                                                                        /*}}}*/
class pkgAcqIndexDiffs : public pkgAcquire::Item
{
   private:

   bool QueueNextDiff();

   void Finish(bool allDone=false);

   protected:

   bool Debug;

   pkgAcquire::ItemDesc Desc;

   string RealURI;

   HashString ExpectedHash;

   string Description;

   vector<DiffInfo> available_patches;

   string ServerSha1;

   enum DiffState
     {
         StateFetchUnkown,

         StateFetchDiff,
         
         StateUnzipDiff, // FIXME: No longer used

         StateApplyDiff
   } State;

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

   virtual void Done(string Message,unsigned long long Size,string Md5Hash,
                     pkgAcquire::MethodConfig *Cnf);
   virtual string DescURI() {return RealURI + "Index";};

   pkgAcqIndexDiffs(pkgAcquire *Owner,string URI,string URIDesc,
                    string ShortDesc, HashString ExpectedHash,
                    string ServerSha1,
                    vector<DiffInfo> diffs=vector<DiffInfo>());
};
                                                                        /*}}}*/
class pkgAcqIndex : public pkgAcquire::Item
{
   protected:

   bool Decompression;

   bool Erase;

   // FIXME: instead of a bool it should use a verify string that will
   //        then be used in the pkgAcqIndex::Done method to ensure that
   //        the downloaded file contains the expected tag
   bool Verify;

   pkgAcquire::ItemDesc Desc;

   string RealURI;

   HashString ExpectedHash;

   string CompressionExtension;

   public:
   
   // Specialized action members
   virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
   virtual void Done(string Message,unsigned long long Size,string Md5Hash,
                     pkgAcquire::MethodConfig *Cnf);
   virtual string Custom600Headers();
   virtual string DescURI() {return Desc.URI;};
   virtual string HashSum() {return ExpectedHash.toStr(); };

   pkgAcqIndex(pkgAcquire *Owner,string URI,string URIDesc,
               string ShortDesc, HashString ExpectedHash, 
               string compressExt="");
   pkgAcqIndex(pkgAcquire *Owner, struct IndexTarget const * const Target,
                         HashString const &ExpectedHash, indexRecords const *MetaIndexParser);
   void Init(string const &URI, string const &URIDesc, string const &ShortDesc);
};
                                                                        /*}}}*/
class pkgAcqIndexTrans : public pkgAcqIndex
{
   public:
  
   virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
   virtual string Custom600Headers();

   pkgAcqIndexTrans(pkgAcquire *Owner,string URI,string URIDesc,
                    string ShortDesc);
   pkgAcqIndexTrans(pkgAcquire *Owner, struct IndexTarget const * const Target,
                    HashString const &ExpectedHash, indexRecords const *MetaIndexParser);
};
                                                                        /*}}}*/                         /*{{{*/
class IndexTarget
{
 public:
   string URI;

   string Description;

   string ShortDesc;

   string MetaKey;

   virtual bool IsOptional() const {
      return false;
   }
   virtual bool IsSubIndex() const {
      return false;
   }
};
                                                                        /*}}}*/                 /*{{{*/
class OptionalIndexTarget : public IndexTarget
{
   virtual bool IsOptional() const {
      return true;
   }
};
                                                                        /*}}}*/                 /*{{{*/
class SubIndexTarget : public IndexTarget
{
   virtual bool IsSubIndex() const {
      return true;
   }
};
                                                                        /*}}}*/

class pkgAcqMetaSig : public pkgAcquire::Item
{
   protected:
   string LastGoodSig;

   pkgAcquire::ItemDesc Desc;

   string RealURI;

   string MetaIndexURI;

   string MetaIndexURIDesc;

   string MetaIndexShortDesc;

   indexRecords* MetaIndexParser;

   const vector<struct IndexTarget*>* IndexTargets;

   public:
   
   // Specialized action members
   virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
   virtual void Done(string Message,unsigned long long Size,string Md5Hash,
                     pkgAcquire::MethodConfig *Cnf);
   virtual string Custom600Headers();
   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);
};
                                                                        /*}}}*/
class pkgAcqMetaIndex : public pkgAcquire::Item
{
   protected:
   pkgAcquire::ItemDesc Desc;

   string RealURI;

   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:
   
   // Specialized action members
   virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
   virtual void Done(string Message,unsigned long long Size, string Hash,
                     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);
};
                                                                        /*}}}*/
class pkgAcqMetaClearSig : public pkgAcqMetaIndex
{
   string MetaIndexURI;

   string MetaIndexURIDesc;

   string MetaIndexShortDesc;

   string MetaSigURI;

   string MetaSigURIDesc;

   string MetaSigShortDesc;

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

   pkgAcqMetaClearSig(pkgAcquire *Owner,
                string const &URI, string const &URIDesc, string const &ShortDesc,
                string const &MetaIndexURI, string const &MetaIndexURIDesc, string const &MetaIndexShortDesc,
                string const &MetaSigURI, string const &MetaSigURIDesc, string const &MetaSigShortDesc,
                const vector<struct IndexTarget*>* IndexTargets,
                indexRecords* MetaIndexParser);
};
                                                                        /*}}}*/
class pkgAcqArchive : public pkgAcquire::Item
{
   protected:
   pkgCache::VerIterator Version;

   pkgAcquire::ItemDesc Desc;

   pkgSourceList *Sources;

   pkgRecords *Recs;

   HashString ExpectedHash;

   string &StoreFilename;

   pkgCache::VerFileIterator Vf;

   unsigned int Retries;

   bool Trusted; 

   bool QueueNext();
   
   public:
   
   virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
   virtual void Done(string Message,unsigned long long Size,string Hash,
                     pkgAcquire::MethodConfig *Cnf);
   virtual string DescURI() {return Desc.URI;};
   virtual string ShortDesc() {return Desc.ShortDesc;};
   virtual void Finished();
   virtual string HashSum() {return ExpectedHash.toStr(); };
   virtual bool IsTrusted();
   
   pkgAcqArchive(pkgAcquire *Owner,pkgSourceList *Sources,
                 pkgRecords *Recs,pkgCache::VerIterator const &Version,
                 string &StoreFilename);
};
                                                                        /*}}}*/
class pkgAcqFile : public pkgAcquire::Item
{
   pkgAcquire::ItemDesc Desc;

   HashString ExpectedHash;

   unsigned int Retries;
   
   bool IsIndexFile;

   public:
   
   // Specialized action members
   virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
   virtual void Done(string Message,unsigned long long Size,string CalcHash,
                     pkgAcquire::MethodConfig *Cnf);
   virtual string DescURI() {return Desc.URI;};
   virtual string HashSum() {return ExpectedHash.toStr(); };
   virtual string Custom600Headers();

   pkgAcqFile(pkgAcquire *Owner, string URI, string Hash, unsigned long long Size,
              string Desc, string ShortDesc,
              const string &DestDir="", const string &DestFilename="",
              bool IsIndexFile=false);
};
                                                                        /*}}}*/
#endif