Merge remote-tracking branch 'upstream/debian/experimental' into feature/acq-trans

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

diff --git a/apt-pkg/acquire-item.h b/apt-pkg/acquire-item.h
index 28577e9b843a2a45459dfaf6040d48d6751bf8fb..3c522f66ed6f62e026cfec10b101e10a3ef17384 100644 (file)
--- a/apt-pkg/acquire-item.h
+++ b/apt-pkg/acquire-item.h
@@ -47,7 +47,7 @@ class indexRecords;
 class pkgRecords;
 class pkgSourceList;
 class IndexTarget;
 class pkgRecords;
 class pkgSourceList;
 class IndexTarget;

-class pkgAcqMetaIndex;
+class pkgAcqMetaBase;

 
 /** \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.


@@ -63,6 +63,8 @@ class pkgAcqMetaIndex;
  */
 class pkgAcquire::Item : public WeakPointable
 {  
  */
 class pkgAcquire::Item : public WeakPointable
 {  

+   void *d;
+

    protected:
    
    /** \brief The acquire object with which this item is associated. */
    protected:
    
    /** \brief The acquire object with which this item is associated. */


@@ -169,8 +171,8 @@ class pkgAcquire::Item : public WeakPointable
     */
    unsigned int QueueCounter;
 
     */
    unsigned int QueueCounter;
 

-   /** \brief TransactionID */
-   unsigned long TransactionID;
+   /** \brief TransactionManager */
+   pkgAcqMetaBase *TransactionManager;

 
    /** \brief The number of additional fetch items that are expected
     *  once this item is done.
 
    /** \brief The number of additional fetch items that are expected
     *  once this item is done.


@@ -298,7 +300,7 @@ class pkgAcquire::Item : public WeakPointable
     */
    Item(pkgAcquire *Owner,
         HashStringList const &ExpectedHashes=HashStringList(),
     */
    Item(pkgAcquire *Owner,
         HashStringList const &ExpectedHashes=HashStringList(),

-        unsigned long TransactionID=0);
+        pkgAcqMetaBase *TransactionManager=NULL);

 
    /** \brief Remove this item from its owner's queue by invoking
     *  pkgAcquire::Remove.
 
    /** \brief Remove this item from its owner's queue by invoking
     *  pkgAcquire::Remove.


@@ -338,45 +340,33 @@ struct DiffInfo {
    unsigned long size;
 };
                                                                        /*}}}*/
    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
+                                                                       /*}}}*/
+
+class pkgAcqMetaBase  : public pkgAcquire::Item

 {
 {

+   void *d;
+

  protected:
  protected:

-   /** \brief If \b true, debugging information will be written to std::clog. */
-   bool Debug;
+   std::vector<Item*> Transaction;

 
  public:
 
  public:

-   // Specialized action members
-   virtual void Failed(std::string Message,pkgAcquire::MethodConfig *Cnf);
-   virtual void Done(std::string Message,unsigned long long Size, HashStringList const &Hashes,
-                    pkgAcquire::MethodConfig *Cnf);
-   virtual std::string DescURI() const {return Desc.URI;};
-   virtual std::string Custom600Headers() const;
-   virtual bool ParseIndex(std::string const &IndexFile);
+   // transaction code
+   void Add(Item *I);
+   void AbortTransaction();
+   bool TransactionHasError() APT_PURE;
+   void CommitTransaction();

 
 

-   /** \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 ExpectedHashes The list file's hashsums which are expected.
-    */
-   pkgAcqSubIndex(pkgAcquire *Owner, 
-                  unsigned long TransactionID,
-                  std::string const &URI,std::string const &URIDesc,
-                  std::string const &ShortDesc, HashStringList const &ExpectedHashes);
+   // helper for the signature warning
+   bool GenerateAuthWarning(const std::string &RealURI,
+                            const std::string &Message);
+
+
+   pkgAcqMetaBase(pkgAcquire *Owner,
+                  HashStringList const &ExpectedHashes=HashStringList(),
+                  pkgAcqMetaBase *TransactionManager=NULL)
+      : Item(Owner, ExpectedHashes, TransactionManager) {};

 };
 };

-                                                                       /*}}}*/
+

 
 /** \brief An item that is responsible for downloading the meta-index  {{{
  *  file (i.e., Release) itself and verifying its signature.
 
 /** \brief An item that is responsible for downloading the meta-index  {{{
  *  file (i.e., Release) itself and verifying its signature.


@@ -388,8 +378,10 @@ class pkgAcqSubIndex : public pkgAcquire::Item
  *  otherwise, the expected hashsums will be "" (causing the
  *  authentication of the index files to be bypassed).
  */
  *  otherwise, the expected hashsums will be "" (causing the
  *  authentication of the index files to be bypassed).
  */

-class pkgAcqMetaIndex : public pkgAcquire::Item
+class pkgAcqMetaIndex : public pkgAcqMetaBase

 {
 {

+   void *d;
+

    protected:
    /** \brief The URI that is actually being downloaded; never
     *  modified by pkgAcqMetaIndex.
    protected:
    /** \brief The URI that is actually being downloaded; never
     *  modified by pkgAcqMetaIndex.


@@ -478,7 +470,7 @@ class pkgAcqMetaIndex : public pkgAcquire::Item
 
    /** \brief Create a new pkgAcqMetaIndex. */
    pkgAcqMetaIndex(pkgAcquire *Owner,
 
    /** \brief Create a new pkgAcqMetaIndex. */
    pkgAcqMetaIndex(pkgAcquire *Owner,

-                   unsigned long TransactionID,
+                   pkgAcqMetaBase *TransactionManager,

                   std::string URI,std::string URIDesc, std::string ShortDesc,
                    std::string MetaIndexSigURI, std::string MetaIndexSigURIDesc, std::string MetaIndexSigShortDesc,
                   const std::vector<IndexTarget*>* IndexTargets,
                   std::string URI,std::string URIDesc, std::string ShortDesc,
                    std::string MetaIndexSigURI, std::string MetaIndexSigURIDesc, std::string MetaIndexSigShortDesc,
                   const std::vector<IndexTarget*>* IndexTargets,


@@ -488,6 +480,8 @@ class pkgAcqMetaIndex : public pkgAcquire::Item
 /** \brief An item repsonsible for downloading clearsigned metaindexes {{{*/
 class pkgAcqMetaClearSig : public pkgAcqMetaIndex
 {
 /** \brief An item repsonsible for downloading clearsigned metaindexes {{{*/
 class pkgAcqMetaClearSig : public pkgAcqMetaIndex
 {

+   void *d;
+

    /** \brief The URI of the meta-index file for the detached signature */
    std::string MetaIndexURI;
 
    /** \brief The URI of the meta-index file for the detached signature */
    std::string MetaIndexURI;
 


@@ -529,6 +523,8 @@ public:
  */
 class pkgAcqBaseIndex : public pkgAcquire::Item
 {
  */
 class pkgAcqBaseIndex : public pkgAcquire::Item
 {

+   void *d;
+

  protected:
    /** \brief Pointer to the IndexTarget data
     */
  protected:
    /** \brief Pointer to the IndexTarget data
     */


@@ -538,11 +534,11 @@ class pkgAcqBaseIndex : public pkgAcquire::Item
    std::string MetaKey;
 
    pkgAcqBaseIndex(pkgAcquire *Owner,
    std::string MetaKey;
 
    pkgAcqBaseIndex(pkgAcquire *Owner,

-                   unsigned long TransactionID,
+                   pkgAcqMetaBase *TransactionManager,

                    struct IndexTarget const * const Target,
                    HashStringList const &ExpectedHashes,
                    indexRecords *MetaIndexParser)
                    struct IndexTarget const * const Target,
                    HashStringList const &ExpectedHashes,
                    indexRecords *MetaIndexParser)

-      : Item(Owner, ExpectedHashes, TransactionID), Target(Target), 
+      : Item(Owner, ExpectedHashes, TransactionManager), Target(Target), 

         MetaIndexParser(MetaIndexParser) {};
 };
                                                                        /*}}}*/
         MetaIndexParser(MetaIndexParser) {};
 };
                                                                        /*}}}*/


@@ -557,6 +553,8 @@ class pkgAcqBaseIndex : public pkgAcquire::Item
  */
 class pkgAcqDiffIndex : public pkgAcqBaseIndex
 {
  */
 class pkgAcqDiffIndex : public pkgAcqBaseIndex
 {

+   void *d;
+

  protected:
    /** \brief If \b true, debugging information will be written to std::clog. */
    bool Debug;
  protected:
    /** \brief If \b true, debugging information will be written to std::clog. */
    bool Debug;


@@ -610,7 +608,7 @@ class pkgAcqDiffIndex : public pkgAcqBaseIndex
     *  \param ExpectedHashes The list file's hashsums which are expected.
     */
    pkgAcqDiffIndex(pkgAcquire *Owner,
     *  \param ExpectedHashes The list file's hashsums which are expected.
     */
    pkgAcqDiffIndex(pkgAcquire *Owner,

-                   unsigned long TransactionID,
+                   pkgAcqMetaBase *TransactionManager,

                    struct IndexTarget const * const Target,
                    HashStringList const &ExpectedHashes,
                    indexRecords *MetaIndexParser);
                    struct IndexTarget const * const Target,
                    HashStringList const &ExpectedHashes,
                    indexRecords *MetaIndexParser);


@@ -629,6 +627,8 @@ class pkgAcqDiffIndex : public pkgAcqBaseIndex
  */
 class pkgAcqIndexMergeDiffs : public pkgAcqBaseIndex
 {
  */
 class pkgAcqIndexMergeDiffs : public pkgAcqBaseIndex
 {

+   void *d;
+

    protected:
 
    /** \brief If \b true, debugging output will be written to
    protected:
 
    /** \brief If \b true, debugging output will be written to


@@ -699,7 +699,7 @@ class pkgAcqIndexMergeDiffs : public pkgAcqBaseIndex
     *  check if it was the last one to complete the download step
     */
    pkgAcqIndexMergeDiffs(pkgAcquire *Owner,
     *  check if it was the last one to complete the download step
     */
    pkgAcqIndexMergeDiffs(pkgAcquire *Owner,

-                         unsigned long TransactionID,
+                         pkgAcqMetaBase *TransactionManager,

                          struct IndexTarget const * const Target,
                          HashStringList const &ExpectedHash,
                          indexRecords *MetaIndexParser,
                          struct IndexTarget const * const Target,
                          HashStringList const &ExpectedHash,
                          indexRecords *MetaIndexParser,


@@ -720,6 +720,8 @@ class pkgAcqIndexMergeDiffs : public pkgAcqBaseIndex
  */
 class pkgAcqIndexDiffs : public pkgAcqBaseIndex
 {
  */
 class pkgAcqIndexDiffs : public pkgAcqBaseIndex
 {

+   void *d;
+

    private:
 
    /** \brief Queue up the next diff download.
    private:
 
    /** \brief Queue up the next diff download.


@@ -828,7 +830,7 @@ class pkgAcqIndexDiffs : public pkgAcqBaseIndex
     *  that depends on it.
     */
    pkgAcqIndexDiffs(pkgAcquire *Owner,
     *  that depends on it.
     */
    pkgAcqIndexDiffs(pkgAcquire *Owner,

-                    unsigned long TransactionID,
+                    pkgAcqMetaBase *TransactionManager,

                     struct IndexTarget const * const Target,
                     HashStringList const &ExpectedHash,
                     indexRecords *MetaIndexParser,
                     struct IndexTarget const * const Target,
                     HashStringList const &ExpectedHash,
                     indexRecords *MetaIndexParser,


@@ -845,6 +847,8 @@ class pkgAcqIndexDiffs : public pkgAcqBaseIndex
  */
 class pkgAcqIndex : public pkgAcqBaseIndex
 {
  */
 class pkgAcqIndex : public pkgAcqBaseIndex
 {

+   void *d;
+

    protected:
 
    /** \brief If \b true, the index file has been decompressed. */
    protected:
 
    /** \brief If \b true, the index file has been decompressed. */


@@ -869,6 +873,7 @@ class pkgAcqIndex : public pkgAcqBaseIndex
     */
    std::string CompressionExtension;
 
     */
    std::string CompressionExtension;
 

+

    /** \brief Do the changes needed to fetch via AptByHash (if needed) */
    void InitByHashIfNeeded(const std::string MetaKey);
 
    /** \brief Do the changes needed to fetch via AptByHash (if needed) */
    void InitByHashIfNeeded(const std::string MetaKey);
 


@@ -881,7 +886,7 @@ class pkgAcqIndex : public pkgAcqBaseIndex
                                 std::string const &compExt);
 
    /** \brief Schedule file for verification after a IMS hit */
                                 std::string const &compExt);
 
    /** \brief Schedule file for verification after a IMS hit */

-   void ReverifyAfterIMS(std::string const &FileName);
+   void ReverifyAfterIMS();

 
    public:
    
 
    public:
    


@@ -912,9 +917,8 @@ class pkgAcqIndex : public pkgAcqBaseIndex
     *  fallback is ".gz" or none.
     */
    pkgAcqIndex(pkgAcquire *Owner,std::string URI,std::string URIDesc,
     *  fallback is ".gz" or none.
     */
    pkgAcqIndex(pkgAcquire *Owner,std::string URI,std::string URIDesc,

-              std::string ShortDesc, HashStringList const &ExpectedHashes,
-              std::string compressExt="");
-   pkgAcqIndex(pkgAcquire *Owner, unsigned long TransactionID,
+              std::string ShortDesc, HashStringList const &ExpectedHashes);
+   pkgAcqIndex(pkgAcquire *Owner, pkgAcqMetaBase *TransactionManager,

                IndexTarget const * const Target,
                HashStringList const &ExpectedHash,
                indexRecords *MetaIndexParser);
                IndexTarget const * const Target,
                HashStringList const &ExpectedHash,
                indexRecords *MetaIndexParser);


@@ -932,6 +936,8 @@ class pkgAcqIndex : public pkgAcqBaseIndex
  */
 class pkgAcqIndexTrans : public pkgAcqIndex
 {
  */
 class pkgAcqIndexTrans : public pkgAcqIndex
 {

+   void *d;
+

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


@@ -952,7 +958,7 @@ class pkgAcqIndexTrans : public pkgAcqIndex
                     std::string URI,std::string URIDesc,
                    std::string ShortDesc);
    pkgAcqIndexTrans(pkgAcquire *Owner,
                     std::string URI,std::string URIDesc,
                    std::string ShortDesc);
    pkgAcqIndexTrans(pkgAcquire *Owner,

-                    unsigned long TransactionID,
+                    pkgAcqMetaBase *TransactionManager,

                     IndexTarget const * const Target,
                     HashStringList const &ExpectedHashes,
                     indexRecords *MetaIndexParser);
                     IndexTarget const * const Target,
                     HashStringList const &ExpectedHashes,
                     indexRecords *MetaIndexParser);


@@ -961,6 +967,8 @@ class pkgAcqIndexTrans : public pkgAcqIndex
 /** \brief Information about an index file. */                         /*{{{*/
 class IndexTarget
 {
 /** \brief Information about an index file. */                         /*{{{*/
 class IndexTarget
 {

+   void *d;
+

  public:
    /** \brief A URI from which the index file can be downloaded. */
    std::string URI;
  public:
    /** \brief A URI from which the index file can be downloaded. */
    std::string URI;


@@ -979,35 +987,18 @@ class IndexTarget
    virtual bool IsOptional() const {
       return false;
    }
    virtual bool IsOptional() const {
       return false;
    }

-   virtual bool IsSubIndex() const {
-      return false;
-   }

 };
                                                                        /*}}}*/
 /** \brief Information about an optional index file. */                        /*{{{*/
 class OptionalIndexTarget : public IndexTarget
 {
 };
                                                                        /*}}}*/
 /** \brief Information about an optional index file. */                        /*{{{*/
 class OptionalIndexTarget : public IndexTarget
 {

+   void *d;
+

    virtual bool IsOptional() const {
       return true;
    }
 };
                                                                        /*}}}*/
    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       {{{
  *  of a meta-index (Release) file, then queues up the release
 
 /** \brief An acquire item that downloads the detached signature       {{{
  *  of a meta-index (Release) file, then queues up the release


@@ -1017,8 +1008,10 @@ class OptionalSubIndexTarget : public OptionalIndexTarget
  *
  *  \sa pkgAcqMetaIndex
  */
  *
  *  \sa pkgAcqMetaIndex
  */

-class pkgAcqMetaSig : public pkgAcquire::Item
+class pkgAcqMetaSig : public pkgAcqMetaBase

 {
 {

+   void *d;
+

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


@@ -1059,7 +1052,7 @@ class pkgAcqMetaSig : public pkgAcquire::Item
 
    /** \brief Create a new pkgAcqMetaSig. */
    pkgAcqMetaSig(pkgAcquire *Owner,
 
    /** \brief Create a new pkgAcqMetaSig. */
    pkgAcqMetaSig(pkgAcquire *Owner,

-                 unsigned long TransactionID,
+                 pkgAcqMetaBase *TransactionManager,

                  std::string URI,std::string URIDesc, std::string ShortDesc,
                  std::string MetaIndexFile,
                 const std::vector<IndexTarget*>* IndexTargets,
                  std::string URI,std::string URIDesc, std::string ShortDesc,
                  std::string MetaIndexFile,
                 const std::vector<IndexTarget*>* IndexTargets,


@@ -1074,6 +1067,8 @@ class pkgAcqMetaSig : public pkgAcquire::Item
  */
 class pkgAcqArchive : public pkgAcquire::Item
 {
  */
 class pkgAcqArchive : public pkgAcquire::Item
 {

+   void *d;
+

    protected:
    /** \brief The package version being fetched. */
    pkgCache::VerIterator Version;
    protected:
    /** \brief The package version being fetched. */
    pkgCache::VerIterator Version;


@@ -1152,6 +1147,8 @@ class pkgAcqArchive : public pkgAcquire::Item
  */
 class pkgAcqFile : public pkgAcquire::Item
 {
  */
 class pkgAcqFile : public pkgAcquire::Item
 {

+   void *d;
+

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