merged from debian

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

diff --git a/apt-pkg/acquire-item.h b/apt-pkg/acquire-item.h
index a48f7f7e5512a86ee617ca02b548f470c0a2ed9d..de657ecc4c7b6c1b70caff57a016a4f95f91d178 100644 (file)
--- a/apt-pkg/acquire-item.h
+++ b/apt-pkg/acquire-item.h
@@ -34,7 +34,7 @@
  *  \file acquire-item.h
  */
 
  *  \file acquire-item.h
  */
 

-/** \brief Represents the process by which a pkgAcquire object should
+/** \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


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

+   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.


@@ -242,6 +243,17 @@ class pkgAcquire::Item
 
    /** \return \b true if this object is being fetched from a trusted source. */
    virtual bool IsTrusted() {return false;};
 
    /** \return \b true if this object is being fetched from a trusted source. */
    virtual bool IsTrusted() {return false;};

+   
+   // report mirror problems
+   /** \brief Report mirror problem
+    * 
+    *  This allows reporting mirror failures back to a centralized
+    *  server. The apt-report-mirror-failure script is called for this
+    * 
+    *  \param FailCode A short failure string that is send
+    */
+   void ReportMirrorFailure(string FailCode);
+

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


@@ -261,8 +273,8 @@ 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. */
    string file;
 struct DiffInfo {
    /** The filename of the diff. */
    string file;


@@ -273,8 +285,8 @@ struct DiffInfo {
    /** The size of the diff. */
    unsigned long size;
 };
    /** The size of the diff. */
    unsigned long size;
 };

-
-/** \brief An item that is responsible for fetching an index file of
+                                                                       /*}}}*/
+/** \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


@@ -348,8 +360,8 @@ class pkgAcqDiffIndex : public pkgAcquire::Item
    pkgAcqDiffIndex(pkgAcquire *Owner,string URI,string URIDesc,
                   string ShortDesc, HashString ExpectedHash);
 };
    pkgAcqDiffIndex(pkgAcquire *Owner,string URI,string URIDesc,
                   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


@@ -477,8 +489,8 @@ class pkgAcqIndexDiffs : public pkgAcquire::Item
                    string ShortDesc, HashString ExpectedHash,
                    vector<DiffInfo> diffs=vector<DiffInfo>());
 };
                    string ShortDesc, HashString ExpectedHash,
                    vector<DiffInfo> diffs=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


@@ -543,10 +555,11 @@ class pkgAcqIndex : public pkgAcquire::Item
     *  (".bz2" is used if bzip2 is installed, ".gz" otherwise).
     */
    pkgAcqIndex(pkgAcquire *Owner,string URI,string URIDesc,
     *  (".bz2" is used if bzip2 is installed, ".gz" otherwise).
     */
    pkgAcqIndex(pkgAcquire *Owner,string URI,string URIDesc,

-              string ShortDesc, HashString ExpectedHash, string compressExt="");
+              string ShortDesc, HashString ExpectedHash, 
+              string compressExt="");

 };
 };

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


@@ -579,8 +592,8 @@ class pkgAcqIndexTrans : public pkgAcqIndex
    pkgAcqIndexTrans(pkgAcquire *Owner,string URI,string URIDesc,
                    string ShortDesc);
 };
    pkgAcqIndexTrans(pkgAcquire *Owner,string URI,string URIDesc,
                    string ShortDesc);
 };

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

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


@@ -597,8 +610,8 @@ struct IndexTarget
     */
    string MetaKey;
 };
     */
    string MetaKey;
 };

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


@@ -612,7 +625,6 @@ class pkgAcqMetaSig : public pkgAcquire::Item
    /** \brief The last good signature file */
    string LastGoodSig;
 
    /** \brief The last good signature file */
    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;
 


@@ -660,8 +672,8 @@ class pkgAcqMetaSig : public pkgAcquire::Item
                 const vector<struct IndexTarget*>* IndexTargets,
                 indexRecords* MetaIndexParser);
 };
                 const vector<struct IndexTarget*>* IndexTargets,
                 indexRecords* MetaIndexParser);
 };

-
-/** \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
  *  file (i.e., Release) itself and verifying its signature.
  *
  *  Once the download and verification are complete, the downloads of


@@ -756,8 +768,8 @@ class pkgAcqMetaIndex : public pkgAcquire::Item
                   const vector<struct IndexTarget*>* IndexTargets,
                   indexRecords* MetaIndexParser);
 };
                   const vector<struct IndexTarget*>* IndexTargets,
                   indexRecords* MetaIndexParser);
 };

-
-/** \brief An item that is responsible for fetching a package file.
+                                                                       /*}}}*/
+/** \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.


@@ -840,8 +852,8 @@ class pkgAcqArchive : public pkgAcquire::Item
                 pkgRecords *Recs,pkgCache::VerIterator const &Version,
                 string &StoreFilename);
 };
                 pkgRecords *Recs,pkgCache::VerIterator const &Version,
                 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


@@ -902,7 +914,7 @@ class pkgAcqFile : public pkgAcquire::Item
              string Desc, string ShortDesc,
              const string &DestDir="", const string &DestFilename="");
 };
              string Desc, string ShortDesc,
              const string &DestDir="", const string &DestFilename="");
 };

-
+                                                                       /*}}}*/

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