[ABI-Break] remove the PACKAGE_MATCHER_ABI_COMPAT defines

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

diff --git a/apt-pkg/acquire-item.h b/apt-pkg/acquire-item.h
index 233cbdda9b61c9ae7970e1e81cb94c97226a2d81..10c855e63d98a91caab3726dbaa708ab08107122 100644 (file)
--- a/apt-pkg/acquire-item.h
+++ b/apt-pkg/acquire-item.h
@@ -12,7 +12,7 @@
    Three item classes are provided to provide functionality for
    downloading of Index, Translation and Packages files.
    
    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 Md5
+   A Archive class is provided for downloading .deb files. It does Hash

    checking and source location as well as a retry algorithm.
    
    ##################################################################### */
    checking and source location as well as a retry algorithm.
    
    ##################################################################### */


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

+#include <apt-pkg/hashes.h>
+#include <apt-pkg/weakptr.h>
+#include <apt-pkg/pkgcache.h>
+
+#ifndef APT_8_CLEANER_HEADERS

 #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/indexfile.h>
 #include <apt-pkg/vendor.h>
 #include <apt-pkg/sourcelist.h>
 #include <apt-pkg/pkgrecords.h>
 #include <apt-pkg/indexrecords.h>

-
+#endif

 
 /** \addtogroup acquire
  *  @{
 
 /** \addtogroup acquire
  *  @{


@@ -34,7 +39,11 @@
  *  \file acquire-item.h
  */
 
  *  \file acquire-item.h
  */
 

-/** \brief Represents the process by which a pkgAcquire object should
+class indexRecords;
+class pkgRecords;
+class pkgSourceList;
+
+/** \brief Represents the process by which a pkgAcquire object should  {{{

  *  retrieve a file or a collection of files.
  *
  *  By convention, Item subclasses should insert themselves into the
  *  retrieve a file or a collection of files.
  *
  *  By convention, Item subclasses should insert themselves into the


@@ -46,7 +55,7 @@
  *
  *  \see pkgAcquire
  */
  *
  *  \see pkgAcquire
  */

-class pkgAcquire::Item
+class pkgAcquire::Item : public WeakPointable

 {  
    protected:
    
 {  
    protected:
    


@@ -73,7 +82,7 @@ class pkgAcquire::Item
     *  \param To The new name of #From.  If #To exists it will be
     *  overwritten.
     */
     *  \param To The new name of #From.  If #To exists it will be
     *  overwritten.
     */

-   void Rename(string From,string To);
+   void Rename(std::string From,std::string To);

    
    public:
 
    
    public:
 


@@ -108,13 +117,13 @@ class pkgAcquire::Item
    /** \brief Contains a textual description of the error encountered
     *  if #Status is #StatError or #StatAuthError.
     */
    /** \brief Contains a textual description of the error encountered
     *  if #Status is #StatError or #StatAuthError.
     */

-   string ErrorText;
+   std::string ErrorText;

 
    /** \brief The size of the object to fetch. */
 
    /** \brief The size of the object to fetch. */

-   unsigned long FileSize;
+   unsigned long long FileSize;

 
    /** \brief How much of the object was already fetched. */
 
    /** \brief How much of the object was already fetched. */

-   unsigned long PartialSize;
+   unsigned long long PartialSize;

 
    /** \brief If not \b NULL, contains the name of a subprocess that
     *  is operating on this object (for instance, "gzip" or "gpgv").
 
    /** \brief If not \b NULL, contains the name of a subprocess that
     *  is operating on this object (for instance, "gzip" or "gpgv").


@@ -142,7 +151,7 @@ class pkgAcquire::Item
     *  download progress indicator's overall statistics.
     */
    bool Local;
     *  download progress indicator's overall statistics.
     */
    bool Local;

-   string UsedMirror;
+   std::string UsedMirror;

 
    /** \brief The number of fetch queues into which this item has been
     *  inserted.
 
    /** \brief The number of fetch queues into which this item has been
     *  inserted.


@@ -157,7 +166,7 @@ class pkgAcquire::Item
    /** \brief The name of the file into which the retrieved object
     *  will be written.
     */
    /** \brief The name of the file into which the retrieved object
     *  will be written.
     */

-   string DestFile;
+   std::string DestFile;

 
    /** \brief Invoked by the acquire worker when the object couldn't
     *  be fetched.
 
    /** \brief Invoked by the acquire worker when the object couldn't
     *  be fetched.


@@ -172,7 +181,7 @@ class pkgAcquire::Item
     *
     *  \sa pkgAcqMethod
     */
     *
     *  \sa pkgAcqMethod
     */

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

 
    /** \brief Invoked by the acquire worker when the object was
     *  fetched successfully.
 
    /** \brief Invoked by the acquire worker when the object was
     *  fetched successfully.


@@ -188,12 +197,12 @@ class pkgAcquire::Item
     *  \param Message Data from the acquire method.  Use LookupTag()
     *  to parse it.
     *  \param Size The size of the object that was fetched.
     *  \param Message Data from the acquire method.  Use LookupTag()
     *  to parse it.
     *  \param Size The size of the object that was fetched.

-    *  \param Md5Hash The MD5Sum of the object that was fetched.
+    *  \param Hash The HashSum of the object that was fetched.

     *  \param Cnf The method via which the object was fetched.
     *
     *  \sa pkgAcqMethod
     */
     *  \param Cnf The method via which the object was fetched.
     *
     *  \sa pkgAcqMethod
     */

-   virtual void Done(string Message,unsigned long Size,string Md5Hash,
+   virtual void Done(std::string Message,unsigned long long Size,std::string Hash,

                     pkgAcquire::MethodConfig *Cnf);
 
    /** \brief Invoked when the worker starts to fetch this object.
                     pkgAcquire::MethodConfig *Cnf);
 
    /** \brief Invoked when the worker starts to fetch this object.


@@ -205,7 +214,7 @@ class pkgAcquire::Item
     *
     *  \sa pkgAcqMethod
     */
     *
     *  \sa pkgAcqMethod
     */

-   virtual void Start(string Message,unsigned long Size);
+   virtual void Start(std::string Message,unsigned long long Size);

 
    /** \brief Custom headers to be sent to the fetch process.
     *
 
    /** \brief Custom headers to be sent to the fetch process.
     *


@@ -215,28 +224,28 @@ class pkgAcquire::Item
     *  line, so they should (if nonempty) have a leading newline and
     *  no trailing newline.
     */
     *  line, so they should (if nonempty) have a leading newline and
     *  no trailing newline.
     */

-   virtual string Custom600Headers() {return string();};
+   virtual std::string Custom600Headers() {return std::string();};

 
    /** \brief A "descriptive" URI-like string.
     *
     *  \return a URI that should be used to describe what is being fetched.
     */
 
    /** \brief A "descriptive" URI-like string.
     *
     *  \return a URI that should be used to describe what is being fetched.
     */

-   virtual string DescURI() = 0;
+   virtual std::string DescURI() = 0;

    /** \brief Short item description.
     *
     *  \return a brief description of the object being fetched.
     */
    /** \brief Short item description.
     *
     *  \return a brief description of the object being fetched.
     */

-   virtual string ShortDesc() {return DescURI();}
+   virtual std::string ShortDesc() {return DescURI();}

 
    /** \brief Invoked by the worker when the download is completely done. */
    virtual void Finished() {};
    
 
    /** \brief Invoked by the worker when the download is completely done. */
    virtual void Finished() {};
    

-   /** \brief MD5Sum.
+   /** \brief HashSum 

     *
     *

-    *  \return the MD5Sum of this object, if applicable; otherwise, an
+    *  \return the HashSum of this object, if applicable; otherwise, an

     *  empty string.
     */
     *  empty string.
     */

-   virtual string MD5Sum() {return string();};
+   virtual std::string HashSum() {return std::string();};

 
    /** \return the acquire process with which this item is associated. */
    pkgAcquire *GetOwner() {return Owner;};
 
    /** \return the acquire process with which this item is associated. */
    pkgAcquire *GetOwner() {return Owner;};


@@ -252,7 +261,7 @@ class pkgAcquire::Item
     * 
     *  \param FailCode A short failure string that is send
     */
     * 
     *  \param FailCode A short failure string that is send
     */

-   void ReportMirrorFailure(string FailCode);
+   void ReportMirrorFailure(std::string FailCode);

 
 
    /** \brief Initialize an item.
 
 
    /** \brief Initialize an item.


@@ -273,20 +282,64 @@ class pkgAcquire::Item
     */
    virtual ~Item();
 };
     */
    virtual ~Item();
 };

-
-/** \brief Information about an index patch (aka diff). */
+                                                                       /*}}}*/
+/** \brief Information about an index patch (aka diff). */             /*{{{*/

 struct DiffInfo {
    /** The filename of the diff. */
 struct DiffInfo {
    /** The filename of the diff. */

-   string file;
+   std::string file;

 
    /** The sha1 hash of the diff. */
 
    /** The sha1 hash of the diff. */

-   string sha1;
+   std::string sha1;

 
    /** The size of the diff. */
    unsigned long size;
 };
 
    /** The size of the diff. */
    unsigned long size;
 };

+                                                                       /*}}}*/
+/** \brief An item that is responsible for fetching a SubIndex         {{{
+ *
+ *  The MetaIndex file includes only records for important indexes
+ *  and records for these SubIndex files so these can carry records
+ *  for addition files like PDiffs and Translations
+ */
+class pkgAcqSubIndex : public pkgAcquire::Item
+{
+ protected:
+   /** \brief If \b true, debugging information will be written to std::clog. */
+   bool Debug;
+
+   /** \brief The item that is currently being downloaded. */
+   pkgAcquire::ItemDesc Desc;
+
+   /** \brief The Hash that this file should have after download
+    */
+   HashString ExpectedHash;
+
+ public:
+   // Specialized action members
+   virtual void Failed(std::string Message,pkgAcquire::MethodConfig *Cnf);
+   virtual void Done(std::string Message,unsigned long long Size,std::string Md5Hash,
+                    pkgAcquire::MethodConfig *Cnf);
+   virtual std::string DescURI() {return Desc.URI;};
+   virtual std::string Custom600Headers();
+   virtual bool ParseIndex(std::string const &IndexFile);

 
 

-/** \brief An item that is responsible for fetching an index file of
+   /** \brief Create a new pkgAcqSubIndex.
+    *
+    *  \param Owner The Acquire object that owns this item.
+    *
+    *  \param URI The URI of the list file to download.
+    *
+    *  \param URIDesc A long description of the list file to download.
+    *
+    *  \param ShortDesc A short description of the list file to download.
+    *
+    *  \param ExpectedHash The list file's MD5 signature.
+    */
+   pkgAcqSubIndex(pkgAcquire *Owner, std::string const &URI,std::string const &URIDesc,
+                  std::string const &ShortDesc, HashString const &ExpectedHash);
+};
+                                                                       /*}}}*/
+/** \brief An item that is responsible for fetching an index file of   {{{

  *  package list diffs and starting the package list's download.
  *
  *  This item downloads the Index file and parses it, then enqueues
  *  package list diffs and starting the package list's download.
  *
  *  This item downloads the Index file and parses it, then enqueues


@@ -307,30 +360,30 @@ class pkgAcqDiffIndex : public pkgAcquire::Item
    /** \brief The URI of the index file to recreate at our end (either
     *  by downloading it or by applying partial patches).
     */
    /** \brief The URI of the index file to recreate at our end (either
     *  by downloading it or by applying partial patches).
     */

-   string RealURI;
+   std::string RealURI;

 
 

-   /** \brief The MD5Sum that the real index file should have after
+   /** \brief The Hash that the real index file should have after

     *  all patches have been applied.
     */
     *  all patches have been applied.
     */

-   string ExpectedMD5;
+   HashString ExpectedHash;

 
    /** \brief The index file which will be patched to generate the new
     *  file.
     */
 
    /** \brief The index file which will be patched to generate the new
     *  file.
     */

-   string CurrentPackagesFile;
+   std::string CurrentPackagesFile;

 
    /** \brief A description of the Packages file (stored in
     *  pkgAcquire::ItemDesc::Description).
     */
 
    /** \brief A description of the Packages file (stored in
     *  pkgAcquire::ItemDesc::Description).
     */

-   string Description;
+   std::string Description;

 
  public:
    // Specialized action members
 
  public:
    // Specialized action members

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

                     pkgAcquire::MethodConfig *Cnf);
                     pkgAcquire::MethodConfig *Cnf);

-   virtual string DescURI() {return RealURI + "Index";};
-   virtual string Custom600Headers();
+   virtual std::string DescURI() {return RealURI + "Index";};
+   virtual std::string Custom600Headers();

 
    /** \brief Parse the Index file for a set of Packages diffs.
     *
 
    /** \brief Parse the Index file for a set of Packages diffs.
     *


@@ -342,7 +395,7 @@ class pkgAcqDiffIndex : public pkgAcquire::Item
     *  \return \b true if the Index file was successfully parsed, \b
     *  false otherwise.
     */
     *  \return \b true if the Index file was successfully parsed, \b
     *  false otherwise.
     */

-   bool ParseDiffIndex(string IndexDiffFile);
+   bool ParseDiffIndex(std::string IndexDiffFile);

    
 
    /** \brief Create a new pkgAcqDiffIndex.
    
 
    /** \brief Create a new pkgAcqDiffIndex.


@@ -355,13 +408,13 @@ class pkgAcqDiffIndex : public pkgAcquire::Item
     *
     *  \param ShortDesc A short description of the list file to download.
     *
     *
     *  \param ShortDesc A short description of the list file to download.
     *

-    *  \param ExpectedMD5 The list file's MD5 signature.
+    *  \param ExpectedHash The list file's MD5 signature.

     */
     */

-   pkgAcqDiffIndex(pkgAcquire *Owner,string URI,string URIDesc,
-                  string ShortDesc, string ExpectedMD5);
+   pkgAcqDiffIndex(pkgAcquire *Owner,std::string URI,std::string URIDesc,
+                  std::string ShortDesc, HashString ExpectedHash);

 };
 };

-
-/** \brief An item that is responsible for fetching all the patches
+                                                                       /*}}}*/
+/** \brief An item that is responsible for fetching all the patches    {{{

  *  that need to be applied to a given package index file.
  *
  *  After downloading and applying a single patch, this item will
  *  that need to be applied to a given package index file.
  *
  *  After downloading and applying a single patch, this item will


@@ -391,7 +444,7 @@ class pkgAcqIndexDiffs : public pkgAcquire::Item
     *  finishes downloading.
     *
     *  Dequeues the item and checks the resulting file's md5sum
     *  finishes downloading.
     *
     *  Dequeues the item and checks the resulting file's md5sum

-    *  against ExpectedMD5 after the last patch was applied.
+    *  against ExpectedHash after the last patch was applied.

     *  There is no need to check the md5/sha1 after a "normal" 
     *  patch because QueueNextDiff() will check the sha1 later.
     *
     *  There is no need to check the md5/sha1 after a "normal" 
     *  patch because QueueNextDiff() will check the sha1 later.
     *


@@ -415,15 +468,15 @@ class pkgAcqIndexDiffs : public pkgAcquire::Item
    /** \brief The URI of the package index file that is being
     *  reconstructed.
     */
    /** \brief The URI of the package index file that is being
     *  reconstructed.
     */

-   string RealURI;
+   std::string RealURI;

 
 

-   /** \brief The MD5Sum of the package index file that is being
+   /** \brief The HashSum of the package index file that is being

     *  reconstructed.
     */
     *  reconstructed.
     */

-   string ExpectedMD5;
+   HashString ExpectedHash;

 
    /** A description of the file being downloaded. */
 
    /** A description of the file being downloaded. */

-   string Description;
+   std::string Description;

 
    /** The patches that remain to be downloaded, including the patch
     *  being downloaded right now.  This list should be ordered so
 
    /** The patches that remain to be downloaded, including the patch
     *  being downloaded right now.  This list should be ordered so


@@ -433,7 +486,11 @@ class pkgAcqIndexDiffs : public pkgAcquire::Item
     *  dictionary instead of relying on ordering and stripping them
     *  off the front?
     */
     *  dictionary instead of relying on ordering and stripping them
     *  off the front?
     */

-   vector<DiffInfo> available_patches;
+   std::vector<DiffInfo> available_patches;
+
+   /** Stop applying patches when reaching that sha1 */
+   std::string ServerSha1;
+

    /** The current status of this patch. */
    enum DiffState
      {
    /** The current status of this patch. */
    enum DiffState
      {


@@ -444,7 +501,7 @@ class pkgAcqIndexDiffs : public pkgAcquire::Item
         StateFetchDiff,
         
         /** \brief The diff is currently being uncompressed. */
         StateFetchDiff,
         
         /** \brief The diff is currently being uncompressed. */

-        StateUnzipDiff,
+        StateUnzipDiff, // FIXME: No longer used

 
         /** \brief The diff is currently being applied. */
         StateApplyDiff
 
         /** \brief The diff is currently being applied. */
         StateApplyDiff


@@ -457,11 +514,11 @@ class pkgAcqIndexDiffs : public pkgAcquire::Item
     *  This method will fall back to downloading the whole index file
     *  outright; its arguments are ignored.
     */
     *  This method will fall back to downloading the whole index file
     *  outright; its arguments are ignored.
     */

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

 
 

-   virtual void Done(string Message,unsigned long Size,string Md5Hash,
+   virtual void Done(std::string Message,unsigned long long Size,std::string Md5Hash,

                     pkgAcquire::MethodConfig *Cnf);
                     pkgAcquire::MethodConfig *Cnf);

-   virtual string DescURI() {return RealURI + "Index";};
+   virtual std::string DescURI() {return RealURI + "Index";};

 
    /** \brief Create an index diff item.
     *
 
    /** \brief Create an index diff item.
     *


@@ -477,7 +534,7 @@ class pkgAcqIndexDiffs : public pkgAcquire::Item
     *
     *  \param ShortDesc A brief description of this item.
     *
     *
     *  \param ShortDesc A brief description of this item.
     *

-    *  \param ExpectedMD5 The expected md5sum of the completely
+    *  \param ExpectedHash The expected md5sum of the completely

     *  reconstructed package index file; the index file will be tested
     *  against this value when it is entirely reconstructed.
     *
     *  reconstructed package index file; the index file will be tested
     *  against this value when it is entirely reconstructed.
     *


@@ -485,12 +542,13 @@ class pkgAcqIndexDiffs : public pkgAcquire::Item
     *  should be ordered so that each diff appears before any diff
     *  that depends on it.
     */
     *  should be ordered so that each diff appears before any diff
     *  that depends on it.
     */

-   pkgAcqIndexDiffs(pkgAcquire *Owner,string URI,string URIDesc,
-                   string ShortDesc, string ExpectedMD5,
-                   vector<DiffInfo> diffs=vector<DiffInfo>());
+   pkgAcqIndexDiffs(pkgAcquire *Owner,std::string URI,std::string URIDesc,
+                   std::string ShortDesc, HashString ExpectedHash,
+                   std::string ServerSha1,
+                   std::vector<DiffInfo> diffs=std::vector<DiffInfo>());

 };
 };

-
-/** \brief An acquire item that is responsible for fetching an index
+                                                                       /*}}}*/
+/** \brief An acquire item that is responsible for fetching an index   {{{

  *  file (e.g., Packages or Sources).
  *
  *  \sa pkgAcqDiffIndex, pkgAcqIndexDiffs, pkgAcqIndexTrans
  *  file (e.g., Packages or Sources).
  *
  *  \sa pkgAcqDiffIndex, pkgAcqIndexDiffs, pkgAcqIndexTrans


@@ -509,6 +567,16 @@ class pkgAcqIndex : public pkgAcquire::Item
     */
    bool Erase;
 
     */
    bool Erase;
 

+   /** \brief Verify for correctness by checking if a "Package"
+    *         tag is found in the index. This can be set to
+    *         false for optional index targets
+    *       
+    */
+   // 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;
+

    /** \brief The download request that is currently being
     *   processed.
     */
    /** \brief The download request that is currently being
     *   processed.
     */


@@ -517,24 +585,25 @@ class pkgAcqIndex : public pkgAcquire::Item
    /** \brief The object that is actually being fetched (minus any
     *  compression-related extensions).
     */
    /** \brief The object that is actually being fetched (minus any
     *  compression-related extensions).
     */

-   string RealURI;
+   std::string RealURI;

 
 

-   /** \brief The expected md5sum of the decompressed index file. */
-   string ExpectedMD5;
+   /** \brief The expected hashsum of the decompressed index file. */
+   HashString ExpectedHash;

 
 

-   /** \brief The compression-related file extension that is being
-    *  added to the downloaded file (e.g., ".gz" or ".bz2").
+   /** \brief The compression-related file extensions that are being
+    *  added to the downloaded file one by one if first fails (e.g., "gz bz2").

     */
     */

-   string CompressionExtension;
+   std::string CompressionExtension;

 
    public:
    
    // Specialized action members
 
    public:
    
    // Specialized action members

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

                     pkgAcquire::MethodConfig *Cnf);
                     pkgAcquire::MethodConfig *Cnf);

-   virtual string Custom600Headers();
-   virtual string DescURI() {return RealURI + CompressionExtension;};
+   virtual std::string Custom600Headers();
+   virtual std::string DescURI() {return Desc.URI;};
+   virtual std::string HashSum() {return ExpectedHash.toStr(); };

 
    /** \brief Create a pkgAcqIndex.
     *
 
    /** \brief Create a pkgAcqIndex.
     *


@@ -547,17 +616,23 @@ class pkgAcqIndex : public pkgAcquire::Item
     *
     *  \param ShortDesc A brief description of this index file.
     *
     *
     *  \param ShortDesc A brief description of this index file.
     *

-    *  \param ExpectedMD5 The expected md5sum of this index file.
+    *  \param ExpectedHash The expected hashsum of this index file.

     *
     *  \param compressExt The compression-related extension with which
     *  this index file should be downloaded, or "" to autodetect
     *
     *  \param compressExt The compression-related extension with which
     *  this index file should be downloaded, or "" to autodetect

-    *  (".bz2" is used if bzip2 is installed, ".gz" otherwise).
+    *  Compression types can be set with config Acquire::CompressionTypes,
+    *  default is ".lzma" or ".bz2" (if the needed binaries are present)
+    *  fallback is ".gz" or none.

     */
     */

-   pkgAcqIndex(pkgAcquire *Owner,string URI,string URIDesc,
-              string ShortDesct, string ExpectedMD5, string compressExt="");
+   pkgAcqIndex(pkgAcquire *Owner,std::string URI,std::string URIDesc,
+              std::string ShortDesc, HashString ExpectedHash, 
+              std::string compressExt="");
+   pkgAcqIndex(pkgAcquire *Owner, struct IndexTarget const * const Target,
+                        HashString const &ExpectedHash, indexRecords const *MetaIndexParser);
+   void Init(std::string const &URI, std::string const &URIDesc, std::string const &ShortDesc);

 };
 };

-
-/** \brief An acquire item that is responsible for fetching a
+                                                                       /*}}}*/
+/** \brief An acquire item that is responsible for fetching a          {{{

  *  translated index file.
  *
  *  The only difference from pkgAcqIndex is that transient failures
  *  translated index file.
  *
  *  The only difference from pkgAcqIndex is that transient failures


@@ -568,7 +643,8 @@ class pkgAcqIndexTrans : public pkgAcqIndex
 {
    public:
   
 {
    public:
   

-   virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
+   virtual void Failed(std::string Message,pkgAcquire::MethodConfig *Cnf);
+   virtual std::string Custom600Headers();

 
    /** \brief Create a pkgAcqIndexTrans.
     *
 
    /** \brief Create a pkgAcqIndexTrans.
     *


@@ -580,36 +656,65 @@ class pkgAcqIndexTrans : public pkgAcqIndex
     *  \param URIDesc A "URI-style" description of this index file.
     *
     *  \param ShortDesc A brief description of this index file.
     *  \param URIDesc A "URI-style" description of this index file.
     *
     *  \param ShortDesc A brief description of this index file.

-    *
-    *  \param ExpectedMD5 The expected md5sum of this index file.
-    *
-    *  \param compressExt The compression-related extension with which
-    *  this index file should be downloaded, or "" to autodetect
-    *  (".bz2" is used if bzip2 is installed, ".gz" otherwise).

     */
     */

-   pkgAcqIndexTrans(pkgAcquire *Owner,string URI,string URIDesc,
-                   string ShortDesc);
+   pkgAcqIndexTrans(pkgAcquire *Owner,std::string URI,std::string URIDesc,
+                   std::string ShortDesc);
+   pkgAcqIndexTrans(pkgAcquire *Owner, struct IndexTarget const * const Target,
+                   HashString const &ExpectedHash, indexRecords const *MetaIndexParser);

 };
 };

-
-/** \brief Information about an index file. */
-struct IndexTarget
+                                                                       /*}}}*/
+/** \brief Information about an index file. */                         /*{{{*/
+class IndexTarget

 {
 {

+ public:

    /** \brief A URI from which the index file can be downloaded. */
    /** \brief A URI from which the index file can be downloaded. */

-   string URI;
+   std::string URI;

 
    /** \brief A description of the index file. */
 
    /** \brief A description of the index file. */

-   string Description;
+   std::string Description;

 
    /** \brief A shorter description of the index file. */
 
    /** \brief A shorter description of the index file. */

-   string ShortDesc;
+   std::string ShortDesc;

 
    /** \brief The key by which this index file should be
     *  looked up within the meta signature file.
     */
 
    /** \brief The key by which this index file should be
     *  looked up within the meta signature file.
     */

-   string MetaKey;
+   std::string MetaKey;
+
+   virtual bool IsOptional() const {
+      return false;
+   }
+   virtual bool IsSubIndex() const {
+      return false;
+   }
+};
+                                                                       /*}}}*/
+/** \brief Information about an optional index file. */                        /*{{{*/
+class OptionalIndexTarget : public IndexTarget
+{
+   virtual bool IsOptional() const {
+      return true;
+   }
+};
+                                                                       /*}}}*/
+/** \brief Information about an subindex index file. */                        /*{{{*/
+class SubIndexTarget : public IndexTarget
+{
+   virtual bool IsSubIndex() const {
+      return true;
+   }
+};
+                                                                       /*}}}*/
+/** \brief Information about an subindex index file. */                        /*{{{*/
+class OptionalSubIndexTarget : public OptionalIndexTarget
+{
+   virtual bool IsSubIndex() const {
+      return true;
+   }

 };
 };

+                                                                       /*}}}*/

 
 

-/** \brief An acquire item that downloads the detached signature
+/** \brief An acquire item that downloads the detached signature       {{{

  *  of a meta-index (Release) file, then queues up the release
  *  file itself.
  *
  *  of a meta-index (Release) file, then queues up the release
  *  file itself.
  *


@@ -620,6 +725,9 @@ struct IndexTarget
 class pkgAcqMetaSig : public pkgAcquire::Item
 {
    protected:
 class pkgAcqMetaSig : public pkgAcquire::Item
 {
    protected:

+   /** \brief The last good signature file */
+   std::string LastGoodSig;
+

    /** \brief The fetch request that is currently being processed. */
    pkgAcquire::ItemDesc Desc;
 
    /** \brief The fetch request that is currently being processed. */
    pkgAcquire::ItemDesc Desc;
 


@@ -627,20 +735,20 @@ class pkgAcqMetaSig : public pkgAcquire::Item
     *  never modified; it is used to determine the file that is being
     *  downloaded.
     */
     *  never modified; it is used to determine the file that is being
     *  downloaded.
     */

-   string RealURI;
+   std::string RealURI;

 
    /** \brief The URI of the meta-index file to be fetched after the signature. */
 
    /** \brief The URI of the meta-index file to be fetched after the signature. */

-   string MetaIndexURI;
+   std::string MetaIndexURI;

 
    /** \brief A "URI-style" description of the meta-index file to be
     *  fetched after the signature.
     */
 
    /** \brief A "URI-style" description of the meta-index file to be
     *  fetched after the signature.
     */

-   string MetaIndexURIDesc;
+   std::string MetaIndexURIDesc;

 
    /** \brief A brief description of the meta-index file to be fetched
     *  after the signature.
     */
 
    /** \brief A brief description of the meta-index file to be fetched
     *  after the signature.
     */

-   string MetaIndexShortDesc;
+   std::string MetaIndexShortDesc;

 
    /** \brief A package-system-specific parser for the meta-index file. */
    indexRecords* MetaIndexParser;
 
    /** \brief A package-system-specific parser for the meta-index file. */
    indexRecords* MetaIndexParser;


@@ -650,32 +758,33 @@ class pkgAcqMetaSig : public pkgAcquire::Item
     *
     *  \todo Why a list of pointers instead of a list of structs?
     */
     *
     *  \todo Why a list of pointers instead of a list of structs?
     */

-   const vector<struct IndexTarget*>* IndexTargets;
+   const std::vector<struct IndexTarget*>* IndexTargets;

 
    public:
    
    // Specialized action members
 
    public:
    
    // Specialized action members

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

                     pkgAcquire::MethodConfig *Cnf);
                     pkgAcquire::MethodConfig *Cnf);

-   virtual string Custom600Headers();
-   virtual string DescURI() {return RealURI; };
+   virtual std::string Custom600Headers();
+   virtual std::string DescURI() {return RealURI; };

 
    /** \brief Create a new pkgAcqMetaSig. */
 
    /** \brief Create a new pkgAcqMetaSig. */

-   pkgAcqMetaSig(pkgAcquire *Owner,string URI,string URIDesc, string ShortDesc,
-                string MetaIndexURI, string MetaIndexURIDesc, string MetaIndexShortDesc,
-                const vector<struct IndexTarget*>* IndexTargets,
+   pkgAcqMetaSig(pkgAcquire *Owner,std::string URI,std::string URIDesc, std::string ShortDesc,
+                std::string MetaIndexURI, std::string MetaIndexURIDesc, std::string MetaIndexShortDesc,
+                const std::vector<struct IndexTarget*>* IndexTargets,

                 indexRecords* MetaIndexParser);
                 indexRecords* MetaIndexParser);

+   virtual ~pkgAcqMetaSig();

 };
 };

-
-/** \brief An item that is responsible for downloading the meta-index
+                                                                       /*}}}*/
+/** \brief An item that is responsible for downloading the meta-index  {{{

  *  file (i.e., Release) itself and verifying its signature.
  *
  *  Once the download and verification are complete, the downloads of
  *  the individual index files are queued up using pkgAcqDiffIndex.
  *  file (i.e., Release) itself and verifying its signature.
  *
  *  Once the download and verification are complete, the downloads of
  *  the individual index files are queued up using pkgAcqDiffIndex.

- *  If the meta-index file had a valid signature, the expected md5sums
+ *  If the meta-index file had a valid signature, the expected hashsums

  *  of the index files will be the md5sums listed in the meta-index;
  *  of the index files will be the md5sums listed in the meta-index;

- *  otherwise, the expected md5sums will be "" (causing the
+ *  otherwise, the expected hashsums will be "" (causing the

  *  authentication of the index files to be bypassed).
  */
 class pkgAcqMetaIndex : public pkgAcquire::Item
  *  authentication of the index files to be bypassed).
  */
 class pkgAcqMetaIndex : public pkgAcquire::Item


@@ -687,17 +796,17 @@ class pkgAcqMetaIndex : public pkgAcquire::Item
    /** \brief The URI that is actually being downloaded; never
     *  modified by pkgAcqMetaIndex.
     */
    /** \brief The URI that is actually being downloaded; never
     *  modified by pkgAcqMetaIndex.
     */

-   string RealURI;
+   std::string RealURI;

 
    /** \brief The file in which the signature for this index was stored.
     *
     *  If empty, the signature and the md5sums of the individual
     *  indices will not be checked.
     */
 
    /** \brief The file in which the signature for this index was stored.
     *
     *  If empty, the signature and the md5sums of the individual
     *  indices will not be checked.
     */

-   string SigFile;
+   std::string SigFile;

 
    /** \brief The index files to download. */
 
    /** \brief The index files to download. */

-   const vector<struct IndexTarget*>* IndexTargets;
+   const std::vector<struct IndexTarget*>* IndexTargets;

 
    /** \brief The parser for the meta-index file. */
    indexRecords* MetaIndexParser;
 
    /** \brief The parser for the meta-index file. */
    indexRecords* MetaIndexParser;


@@ -713,7 +822,7 @@ class pkgAcqMetaIndex : public pkgAcquire::Item
     *
     *  \return \b true if no fatal errors were encountered.
     */
     *
     *  \return \b true if no fatal errors were encountered.
     */

-   bool VerifyVendor(string Message);
+   bool VerifyVendor(std::string Message);

 
    /** \brief Called when a file is finished being retrieved.
     *
 
    /** \brief Called when a file is finished being retrieved.
     *


@@ -724,7 +833,7 @@ class pkgAcqMetaIndex : public pkgAcquire::Item
     *  \param Message The message block received from the fetch
     *  subprocess.
     */
     *  \param Message The message block received from the fetch
     *  subprocess.
     */

-   void RetrievalDone(string Message);
+   void RetrievalDone(std::string Message);

 
    /** \brief Called when authentication succeeded.
     *
 
    /** \brief Called when authentication succeeded.
     *


@@ -735,36 +844,71 @@ class pkgAcqMetaIndex : public pkgAcquire::Item
     *  \param Message The message block received from the fetch
     *  subprocess.
     */
     *  \param Message The message block received from the fetch
     *  subprocess.
     */

-   void AuthDone(string Message);
+   void AuthDone(std::string Message);

 
    /** \brief Starts downloading the individual index files.
     *
 
    /** \brief Starts downloading the individual index files.
     *

-    *  \param verify If \b true, only indices whose expected md5sum
+    *  \param verify If \b true, only indices whose expected hashsum

     *  can be determined from the meta-index will be downloaded, and
     *  can be determined from the meta-index will be downloaded, and

-    *  the md5sums of indices will be checked (reporting
+    *  the hashsums of indices will be checked (reporting

     *  #StatAuthError if there is a mismatch).  If verify is \b false,
     *  #StatAuthError if there is a mismatch).  If verify is \b false,

-    *  no md5sum checking will be performed.
+    *  no hashsum checking will be performed.

     */
    void QueueIndexes(bool verify);
    
    public:
    
    // Specialized action members
     */
    void QueueIndexes(bool verify);
    
    public:
    
    // Specialized action members

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

                     pkgAcquire::MethodConfig *Cnf);
                     pkgAcquire::MethodConfig *Cnf);

-   virtual string Custom600Headers();
-   virtual string DescURI() {return RealURI; };
+   virtual std::string Custom600Headers();
+   virtual std::string DescURI() {return RealURI; };

 
    /** \brief Create a new pkgAcqMetaIndex. */
    pkgAcqMetaIndex(pkgAcquire *Owner,
 
    /** \brief Create a new pkgAcqMetaIndex. */
    pkgAcqMetaIndex(pkgAcquire *Owner,

-                  string URI,string URIDesc, string ShortDesc,
-                  string SigFile,
-                  const vector<struct IndexTarget*>* IndexTargets,
+                  std::string URI,std::string URIDesc, std::string ShortDesc,
+                  std::string SigFile,
+                  const std::vector<struct IndexTarget*>* IndexTargets,

                   indexRecords* MetaIndexParser);
 };
                   indexRecords* MetaIndexParser);
 };

+                                                                       /*}}}*/
+/** \brief An item repsonsible for downloading clearsigned metaindexes {{{*/
+class pkgAcqMetaClearSig : public pkgAcqMetaIndex
+{
+   /** \brief The URI of the meta-index file for the detached signature */
+   std::string MetaIndexURI;
+
+   /** \brief A "URI-style" description of the meta-index file */
+   std::string MetaIndexURIDesc;
+
+   /** \brief A brief description of the meta-index file */
+   std::string MetaIndexShortDesc;
+
+   /** \brief The URI of the detached meta-signature file if the clearsigned one failed. */
+   std::string MetaSigURI;
+
+   /** \brief A "URI-style" description of the meta-signature file */
+   std::string MetaSigURIDesc;

 
 

-/** \brief An item that is responsible for fetching a package file.
+   /** \brief A brief description of the meta-signature file */
+   std::string MetaSigShortDesc;
+
+public:
+   void Failed(std::string Message,pkgAcquire::MethodConfig *Cnf);
+   virtual std::string Custom600Headers();
+
+   /** \brief Create a new pkgAcqMetaClearSig. */
+   pkgAcqMetaClearSig(pkgAcquire *Owner,
+               std::string const &URI, std::string const &URIDesc, std::string const &ShortDesc,
+               std::string const &MetaIndexURI, std::string const &MetaIndexURIDesc, std::string const &MetaIndexShortDesc,
+               std::string const &MetaSigURI, std::string const &MetaSigURIDesc, std::string const &MetaSigShortDesc,
+               const std::vector<struct IndexTarget*>* IndexTargets,
+               indexRecords* MetaIndexParser);
+   virtual ~pkgAcqMetaClearSig();
+};
+                                                                       /*}}}*/
+/** \brief An item that is responsible for fetching a package file.    {{{

  *
  *  If the package file already exists in the cache, nothing will be
  *  done.
  *
  *  If the package file already exists in the cache, nothing will be
  *  done.


@@ -788,13 +932,13 @@ class pkgAcqArchive : public pkgAcquire::Item
     */
    pkgRecords *Recs;
 
     */
    pkgRecords *Recs;
 

-   /** \brief The md5sum of this package. */
-   string MD5;
+   /** \brief The hashsum of this package. */
+   HashString ExpectedHash;

 
    /** \brief A location in which the actual filename of the package
     *  should be stored.
     */
 
    /** \brief A location in which the actual filename of the package
     *  should be stored.
     */

-   string &StoreFilename;
+   std::string &StoreFilename;

 
    /** \brief The next file for this version to try to download. */
    pkgCache::VerFileIterator Vf;
 
    /** \brief The next file for this version to try to download. */
    pkgCache::VerFileIterator Vf;


@@ -816,14 +960,13 @@ class pkgAcqArchive : public pkgAcquire::Item
    
    public:
    
    
    public:
    

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

                     pkgAcquire::MethodConfig *Cnf);
                     pkgAcquire::MethodConfig *Cnf);

-   virtual string MD5Sum() {return MD5;};
-   virtual string DescURI() {return Desc.URI;};
-   virtual string ShortDesc() {return Desc.ShortDesc;};
+   virtual std::string DescURI() {return Desc.URI;};
+   virtual std::string ShortDesc() {return Desc.ShortDesc;};

    virtual void Finished();
    virtual void Finished();

-
+   virtual std::string HashSum() {return ExpectedHash.toStr(); };

    virtual bool IsTrusted();
    
    /** \brief Create a new pkgAcqArchive.
    virtual bool IsTrusted();
    
    /** \brief Create a new pkgAcqArchive.


@@ -846,10 +989,10 @@ class pkgAcqArchive : public pkgAcquire::Item
     */
    pkgAcqArchive(pkgAcquire *Owner,pkgSourceList *Sources,
                 pkgRecords *Recs,pkgCache::VerIterator const &Version,
     */
    pkgAcqArchive(pkgAcquire *Owner,pkgSourceList *Sources,
                 pkgRecords *Recs,pkgCache::VerIterator const &Version,

-                string &StoreFilename);
+                std::string &StoreFilename);

 };
 };

-
-/** \brief Retrieve an arbitrary file to the current directory.
+                                                                       /*}}}*/
+/** \brief Retrieve an arbitrary file to the current directory.                {{{

  *
  *  The file is retrieved even if it is accessed via a URL type that
  *  normally is a NOP, such as "file".  If the download fails, the
  *
  *  The file is retrieved even if it is accessed via a URL type that
  *  normally is a NOP, such as "file".  If the download fails, the


@@ -860,22 +1003,26 @@ class pkgAcqFile : public pkgAcquire::Item
    /** \brief The currently active download process. */
    pkgAcquire::ItemDesc Desc;
 
    /** \brief The currently active download process. */
    pkgAcquire::ItemDesc Desc;
 

-   /** \brief The md5sum of the file to download, if it is known. */
-   string Md5Hash;
+   /** \brief The hashsum of the file to download, if it is known. */
+   HashString ExpectedHash;

 
    /** \brief How many times to retry the download, set from
     *  Acquire::Retries.
     */
    unsigned int Retries;
    
 
    /** \brief How many times to retry the download, set from
     *  Acquire::Retries.
     */
    unsigned int Retries;
    

+   /** \brief Should this file be considered a index file */
+   bool IsIndexFile;
+

    public:
    
    // Specialized action members
    public:
    
    // Specialized action members

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

                     pkgAcquire::MethodConfig *Cnf);
                     pkgAcquire::MethodConfig *Cnf);

-   virtual string MD5Sum() {return Md5Hash;};
-   virtual string DescURI() {return Desc.URI;};
+   virtual std::string DescURI() {return Desc.URI;};
+   virtual std::string HashSum() {return ExpectedHash.toStr(); };
+   virtual std::string Custom600Headers();

 
    /** \brief Create a new pkgAcqFile object.
     *
 
    /** \brief Create a new pkgAcqFile object.
     *


@@ -884,7 +1031,7 @@ class pkgAcqFile : public pkgAcquire::Item
     *
     *  \param URI The URI to download.
     *
     *
     *  \param URI The URI to download.
     *

-    *  \param MD5 The md5sum of the file to download, if it is known;
+    *  \param Hash The hashsum of the file to download, if it is known;

     *  otherwise "".
     *
     *  \param Size The size of the file to download, if it is known;
     *  otherwise "".
     *
     *  \param Size The size of the file to download, if it is known;


@@ -899,6 +1046,8 @@ class pkgAcqFile : public pkgAcquire::Item
     *
     *  \param DestFilename The filename+path the file is downloaded to.
     *
     *
     *  \param DestFilename The filename+path the file is downloaded to.
     *

+    *  \param IsIndexFile The file is considered a IndexFile and cache-control
+    *                     headers like "cache-control: max-age=0" are send

     *
     * If DestFilename is empty, download to DestDir/<basename> if
     * DestDir is non-empty, $CWD/<basename> otherwise.  If
     *
     * If DestFilename is empty, download to DestDir/<basename> if
     * DestDir is non-empty, $CWD/<basename> otherwise.  If


@@ -906,11 +1055,12 @@ class pkgAcqFile : public pkgAcquire::Item
     * is the absolute name to which the file should be downloaded.
     */
 
     * 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="");
+   pkgAcqFile(pkgAcquire *Owner, std::string URI, std::string Hash, unsigned long long Size,
+             std::string Desc, std::string ShortDesc,
+             const std::string &DestDir="", const std::string &DestFilename="",
+             bool IsIndexFile=false);

 };
 };

-
+                                                                       /*}}}*/

 /** @} */
 
 #endif
 /** @} */
 
 #endif