consistently fail if Smart* packagemanager actions fail

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

diff --git a/apt-pkg/acquire-item.h b/apt-pkg/acquire-item.h
index f39a90c0bfd7857d5ca0657b613d40441ec70740..f48d2a0d79f1350b89867accab78300fd2fa750c 100644 (file)
--- a/apt-pkg/acquire-item.h
+++ b/apt-pkg/acquire-item.h
@@ -21,13 +21,21 @@
 #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>
+#include <apt-pkg/cacheiterators.h>
+
+#include <string>
+#include <vector>
+
+#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>

-#include <apt-pkg/hashes.h>
-#include <apt-pkg/weakptr.h>
+#endif

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


@@ -35,6 +43,10 @@
  *  \file acquire-item.h
  */
 
  *  \file acquire-item.h
  */
 

+class indexRecords;
+class pkgRecords;
+class pkgSourceList;
+

 /** \brief Represents the process by which a pkgAcquire object should  {{{
  *  retrieve a file or a collection of files.
  *
 /** \brief Represents the process by which a pkgAcquire object should  {{{
  *  retrieve a file or a collection of files.
  *


@@ -56,7 +68,7 @@ class pkgAcquire::Item : public WeakPointable
 
    /** \brief Insert this item into its owner's queue.
     *
 
    /** \brief Insert this item into its owner's queue.
     *

-    *  \param ItemDesc Metadata about this item (its URI and
+    *  \param Item Metadata about this item (its URI and

     *  description).
     */
    inline void QueueURI(ItemDesc &Item)
     *  description).
     */
    inline void QueueURI(ItemDesc &Item)


@@ -71,11 +83,11 @@ class pkgAcquire::Item : public WeakPointable
     *
     *  \param From The file to be renamed.
     *
     *
     *  \param From The file to be renamed.
     *

-    *  \param To The new name of #From.  If #To exists it will be
+    *  \param To The new name of \a From.  If \a To exists it will be

     *  overwritten.
     */
     *  overwritten.
     */

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

    public:
 
    /** \brief The current status of this item. */
    public:
 
    /** \brief The current status of this item. */


@@ -107,9 +119,9 @@ class pkgAcquire::Item : public WeakPointable
      } Status;
 
    /** \brief Contains a textual description of the error encountered
      } Status;
 
    /** \brief Contains a textual description of the error encountered

-    *  if #Status is #StatError or #StatAuthError.
+    *  if #ItemState is #StatError or #StatAuthError.

     */
     */

-   string ErrorText;
+   std::string ErrorText;

 
    /** \brief The size of the object to fetch. */
    unsigned long long FileSize;
 
    /** \brief The size of the object to fetch. */
    unsigned long long FileSize;


@@ -143,7 +155,7 @@ class pkgAcquire::Item : public WeakPointable
     *  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.


@@ -158,7 +170,7 @@ class pkgAcquire::Item : public WeakPointable
    /** \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.


@@ -173,7 +185,7 @@ class pkgAcquire::Item : public WeakPointable
     *
     *  \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.


@@ -194,7 +206,7 @@ class pkgAcquire::Item : public WeakPointable
     *
     *  \sa pkgAcqMethod
     */
     *
     *  \sa pkgAcqMethod
     */

-   virtual void Done(string Message,unsigned long long Size,string Hash,
+   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.


@@ -206,7 +218,7 @@ class pkgAcquire::Item : public WeakPointable
     *
     *  \sa pkgAcqMethod
     */
     *
     *  \sa pkgAcqMethod
     */

-   virtual void Start(string Message,unsigned long 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.
     *


@@ -216,18 +228,18 @@ class pkgAcquire::Item : public WeakPointable
     *  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() {};


@@ -237,7 +249,7 @@ class pkgAcquire::Item : public WeakPointable
     *  \return the HashSum of this object, if applicable; otherwise, an
     *  empty string.
     */
     *  \return the HashSum of this object, if applicable; otherwise, an
     *  empty string.
     */

-   virtual string HashSum() {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;};


@@ -253,7 +265,7 @@ class pkgAcquire::Item : public WeakPointable
     * 
     *  \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,15 +285,29 @@ class pkgAcquire::Item : public WeakPointable
     *  pkgAcquire::Remove.
     */
    virtual ~Item();
     *  pkgAcquire::Remove.
     */
    virtual ~Item();

+
+   protected:
+
+   enum RenameOnErrorState {
+      HashSumMismatch,
+      SizeMismatch,
+      InvalidFormat
+   };
+
+   /** \brief Rename failed file and set error
+    *
+    * \param state respresenting the error we encountered
+    */
+   bool RenameOnError(RenameOnErrorState const state);

 };
                                                                        /*}}}*/
 /** \brief Information about an index patch (aka diff). */             /*{{{*/
 struct DiffInfo {
    /** The filename of the diff. */
 };
                                                                        /*}}}*/
 /** \brief Information about an index patch (aka 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;


@@ -308,12 +334,12 @@ class pkgAcqSubIndex : public pkgAcquire::Item
 
  public:
    // Specialized action members
 
  public:
    // Specialized action members

-   virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
-   virtual void Done(string Message,unsigned long 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 Desc.URI;};
-   virtual string Custom600Headers();
-   virtual bool ParseIndex(string const &IndexFile);
+   virtual std::string DescURI() {return Desc.URI;};
+   virtual std::string Custom600Headers();
+   virtual bool ParseIndex(std::string const &IndexFile);

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


@@ -327,8 +353,8 @@ class pkgAcqSubIndex : public pkgAcquire::Item
     *
     *  \param ExpectedHash The list file's MD5 signature.
     */
     *
     *  \param ExpectedHash The list file's MD5 signature.
     */

-   pkgAcqSubIndex(pkgAcquire *Owner, string const &URI,string const &URIDesc,
-                  string const &ShortDesc, HashString const &ExpectedHash);
+   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   {{{
 };
                                                                        /*}}}*/
 /** \brief An item that is responsible for fetching an index file of   {{{


@@ -352,7 +378,7 @@ 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 Hash that the real index file should have after
     *  all patches have been applied.
 
    /** \brief The Hash that the real index file should have after
     *  all patches have been applied.


@@ -362,20 +388,20 @@ class pkgAcqDiffIndex : public pkgAcquire::Item
    /** \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 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.
     *


@@ -387,7 +413,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.


@@ -402,11 +428,109 @@ class pkgAcqDiffIndex : public pkgAcquire::Item
     *
     *  \param ExpectedHash The list file's MD5 signature.
     */
     *
     *  \param ExpectedHash The list file's MD5 signature.
     */

-   pkgAcqDiffIndex(pkgAcquire *Owner,string URI,string URIDesc,
-                  string ShortDesc, HashString ExpectedHash);
+   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 client-merge patches {{{
+ *  that need to be applied to a given package index file.
+ *
+ *  Instead of downloading and applying each patch one by one like its
+ *  sister #pkgAcqIndexDiffs this class will download all patches at once
+ *  and call rred with all the patches downloaded once. Rred will then
+ *  merge and apply them in one go, which should be a lot faster – but is
+ *  incompatible with server-based merges of patches like reprepro can do.
+ *
+ *  \sa pkgAcqDiffIndex, pkgAcqIndex
+ */
+class pkgAcqIndexMergeDiffs : public pkgAcquire::Item
+{
+   protected:
+
+   /** \brief If \b true, debugging output will be written to
+    *  std::clog.
+    */
+   bool Debug;
+
+   /** \brief description of the item that is currently being
+    *  downloaded.
+    */
+   pkgAcquire::ItemDesc Desc;
+
+   /** \brief URI of the package index file that is being
+    *  reconstructed.
+    */
+   std::string RealURI;
+
+   /** \brief HashSum of the package index file that is being
+    *  reconstructed.
+    */
+   HashString ExpectedHash;
+
+   /** \brief description of the file being downloaded. */
+   std::string Description;
+
+   /** \brief information about the current patch */
+   struct DiffInfo const patch;
+
+   /** \brief list of all download items for the patches */
+   std::vector<pkgAcqIndexMergeDiffs*> const * const allPatches;
+
+   /** The current status of this patch. */
+   enum DiffState
+   {
+      /** \brief The diff is currently being fetched. */
+      StateFetchDiff,
+
+      /** \brief The diff is currently being applied. */
+      StateApplyDiff,
+
+      /** \brief the work with this diff is done */
+      StateDoneDiff,
+
+      /** \brief something bad happened and fallback was triggered */
+      StateErrorDiff
+   } State;
+
+   public:
+   /** \brief Called when the patch file failed to be downloaded.
+    *
+    *  This method will fall back to downloading the whole index file
+    *  outright; its arguments are ignored.
+    */
+   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 RealURI + "Index";};
+
+   /** \brief Create an index merge-diff item.
+    *
+    *  \param Owner The pkgAcquire object that owns this item.
+    *
+    *  \param URI The URI of the package index file being
+    *  reconstructed.
+    *
+    *  \param URIDesc A long description of this item.
+    *
+    *  \param ShortDesc A brief description of this item.
+    *
+    *  \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.
+    *
+    *  \param patch contains infos about the patch this item is supposed
+    *  to download which were read from the index
+    *
+    *  \param allPatches contains all related items so that each item can
+    *  check if it was the last one to complete the download step
+    */
+   pkgAcqIndexMergeDiffs(pkgAcquire *Owner,std::string const &URI,std::string const &URIDesc,
+                   std::string const &ShortDesc, HashString const &ExpectedHash,
+                   DiffInfo const &patch, std::vector<pkgAcqIndexMergeDiffs*> const * const allPatches);
+};
+                                                                       /*}}}*/
+/** \brief An item that is responsible for fetching server-merge 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


@@ -460,7 +584,7 @@ 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 HashSum of the package index file that is being
     *  reconstructed.
 
    /** \brief The HashSum of the package index file that is being
     *  reconstructed.


@@ -468,7 +592,7 @@ class pkgAcqIndexDiffs : public pkgAcquire::Item
    HashString ExpectedHash;
 
    /** A description of the file being downloaded. */
    HashString ExpectedHash;
 
    /** 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


@@ -478,10 +602,10 @@ 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 */
 
    /** Stop applying patches when reaching that sha1 */

-   string ServerSha1;
+   std::string ServerSha1;

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


@@ -506,16 +630,16 @@ 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 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.
     *
     *  After filling in its basic fields, this invokes Finish(true) if
 
    /** \brief Create an index diff item.
     *
     *  After filling in its basic fields, this invokes Finish(true) if

-    *  #diffs is empty, or QueueNextDiff() otherwise.
+    *  \a diffs is empty, or QueueNextDiff() otherwise.

     *
     *  \param Owner The pkgAcquire object that owns this item.
     *
     *
     *  \param Owner The pkgAcquire object that owns this item.
     *


@@ -530,14 +654,16 @@ class pkgAcqIndexDiffs : public pkgAcquire::Item
     *  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.
     *

+    *  \param ServerSha1 is the sha1sum of the current file on the server
+    *

     *  \param diffs The remaining diffs from the index of diffs.  They
     *  should be ordered so that each diff appears before any diff
     *  that depends on it.
     */
     *  \param diffs The remaining diffs from the index of diffs.  They
     *  should be ordered so that each diff appears before any diff
     *  that depends on it.
     */

-   pkgAcqIndexDiffs(pkgAcquire *Owner,string URI,string URIDesc,
-                   string ShortDesc, HashString ExpectedHash,
-                   string ServerSha1,
-                   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   {{{


@@ -559,6 +685,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.
     */


@@ -567,7 +703,7 @@ 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 hashsum of the decompressed index file. */
    HashString ExpectedHash;
 
    /** \brief The expected hashsum of the decompressed index file. */
    HashString ExpectedHash;


@@ -575,17 +711,17 @@ class pkgAcqIndex : public pkgAcquire::Item
    /** \brief The compression-related file extensions that are being
     *  added to the downloaded file one by one if first fails (e.g., "gz 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 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 Desc.URI;};
-   virtual string HashSum() {return ExpectedHash.toStr(); };
+   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.
     *


@@ -606,12 +742,12 @@ class pkgAcqIndex : public pkgAcquire::Item
     *  default is ".lzma" or ".bz2" (if the needed binaries are present)
     *  fallback is ".gz" or none.
     */
     *  default is ".lzma" or ".bz2" (if the needed binaries are present)
     *  fallback is ".gz" or none.
     */

-   pkgAcqIndex(pkgAcquire *Owner,string URI,string URIDesc,
-              string ShortDesc, HashString ExpectedHash, 
-              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);
    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);
+   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          {{{


@@ -625,8 +761,8 @@ class pkgAcqIndexTrans : public pkgAcqIndex
 {
    public:
   
 {
    public:
   

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

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


@@ -639,8 +775,8 @@ class pkgAcqIndexTrans : public pkgAcqIndex
     *
     *  \param ShortDesc A brief description of this index file.
     */
     *
     *  \param ShortDesc A brief description of this index file.
     */

-   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);
 };
    pkgAcqIndexTrans(pkgAcquire *Owner, struct IndexTarget const * const Target,
                    HashString const &ExpectedHash, indexRecords const *MetaIndexParser);
 };


@@ -650,18 +786,18 @@ class IndexTarget
 {
  public:
    /** \brief A URI from which the index file can be downloaded. */
 {
  public:
    /** \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 IsOptional() const {
       return false;


@@ -681,6 +817,14 @@ class OptionalIndexTarget : public IndexTarget
                                                                        /*}}}*/
 /** \brief Information about an subindex index file. */                        /*{{{*/
 class SubIndexTarget : public IndexTarget
                                                                        /*}}}*/
 /** \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;
 {
    virtual bool IsSubIndex() const {
       return true;


@@ -700,7 +844,7 @@ class pkgAcqMetaSig : public pkgAcquire::Item
 {
    protected:
    /** \brief The last good signature file */
 {
    protected:
    /** \brief The last good signature file */

-   string LastGoodSig;
+   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;


@@ -709,20 +853,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;


@@ -732,22 +876,23 @@ 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 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  {{{


@@ -769,17 +914,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;


@@ -795,7 +940,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.
     *


@@ -806,7 +951,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.
     *


@@ -817,7 +962,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 AuthDone(string Message);
+   void AuthDone(std::string Message);

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


@@ -832,17 +977,17 @@ class pkgAcqMetaIndex : public pkgAcquire::Item
    public:
    
    // Specialized action members
    public:
    
    // Specialized action members

-   virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
-   virtual void Done(string Message,unsigned long long Size, string Hash,
+   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);
 };
                                                                        /*}}}*/


@@ -850,34 +995,35 @@ class pkgAcqMetaIndex : public pkgAcquire::Item
 class pkgAcqMetaClearSig : public pkgAcqMetaIndex
 {
    /** \brief The URI of the meta-index file for the detached signature */
 class pkgAcqMetaClearSig : public pkgAcqMetaIndex
 {
    /** \brief The URI of the meta-index file for the detached signature */

-   string MetaIndexURI;
+   std::string MetaIndexURI;

 
    /** \brief A "URI-style" description of the meta-index file */
 
    /** \brief A "URI-style" description of the meta-index file */

-   string MetaIndexURIDesc;
+   std::string MetaIndexURIDesc;

 
    /** \brief A brief description of the meta-index file */
 
    /** \brief A brief description of the meta-index file */

-   string MetaIndexShortDesc;
+   std::string MetaIndexShortDesc;

 
    /** \brief The URI of the detached meta-signature file if the clearsigned one failed. */
 
    /** \brief The URI of the detached meta-signature file if the clearsigned one failed. */

-   string MetaSigURI;
+   std::string MetaSigURI;

 
    /** \brief A "URI-style" description of the meta-signature file */
 
    /** \brief A "URI-style" description of the meta-signature file */

-   string MetaSigURIDesc;
+   std::string MetaSigURIDesc;

 
    /** \brief A brief description of the meta-signature file */
 
    /** \brief A brief description of the meta-signature file */

-   string MetaSigShortDesc;
+   std::string MetaSigShortDesc;

 
 public:
 
 public:

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

 
    /** \brief Create a new pkgAcqMetaClearSig. */
    pkgAcqMetaClearSig(pkgAcquire *Owner,
 
    /** \brief Create a new pkgAcqMetaClearSig. */
    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,
+               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);
                indexRecords* MetaIndexParser);

+   virtual ~pkgAcqMetaClearSig();

 };
                                                                        /*}}}*/
 /** \brief An item that is responsible for fetching a package file.    {{{
 };
                                                                        /*}}}*/
 /** \brief An item that is responsible for fetching a package file.    {{{


@@ -910,7 +1056,7 @@ class pkgAcqArchive : public pkgAcquire::Item
    /** \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;


@@ -932,13 +1078,13 @@ class pkgAcqArchive : public pkgAcquire::Item
    
    public:
    
    
    public:
    

-   virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
-   virtual void Done(string Message,unsigned long long Size,string Hash,
+   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 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 string HashSum() {return ExpectedHash.toStr(); };
+   virtual std::string HashSum() {return ExpectedHash.toStr(); };

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


@@ -954,14 +1100,14 @@ class pkgAcqArchive : public pkgAcquire::Item
     *
     *  \param Version The package version to download.
     *
     *
     *  \param Version The package version to download.
     *

-    *  \param StoreFilename A location in which the actual filename of
+    *  \param[out] StoreFilename A location in which the actual filename of

     *  the package should be stored.  It will be set to a guessed
     *  basename in the constructor, and filled in with a fully
     *  qualified filename once the download finishes.
     */
    pkgAcqArchive(pkgAcquire *Owner,pkgSourceList *Sources,
                 pkgRecords *Recs,pkgCache::VerIterator const &Version,
     *  the package should be stored.  It will be set to a guessed
     *  basename in the constructor, and filled in with a fully
     *  qualified filename once the download finishes.
     */
    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.                {{{


@@ -989,12 +1135,12 @@ class pkgAcqFile : public pkgAcquire::Item
    public:
    
    // Specialized action members
    public:
    
    // Specialized action members

-   virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
-   virtual void Done(string Message,unsigned long long Size,string CalcHash,
+   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 DescURI() {return Desc.URI;};
-   virtual string HashSum() {return ExpectedHash.toStr(); };
-   virtual string Custom600Headers();
+   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.
     *


@@ -1021,15 +1167,15 @@ class pkgAcqFile : public pkgAcquire::Item
     *  \param IsIndexFile The file is considered a IndexFile and cache-control
     *                     headers like "cache-control: max-age=0" are send
     *
     *  \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

     * DestFilename is NOT empty, DestDir is ignored and DestFilename
     * is the absolute name to which the file should be downloaded.
     */
 
     * 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 Hash, unsigned long 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);
 };
                                                                        /*}}}*/
              bool IsIndexFile=false);
 };
                                                                        /*}}}*/