Change InternalReadLine to always use buffer.read() return value

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

diff --git a/apt-pkg/acquire.h b/apt-pkg/acquire.h
index 3d5d7a4b78a9aa522af324e04537f52289995213..7044797b364877cddfe4d067fe0ac154d600e5c7 100644 (file)
--- a/apt-pkg/acquire.h
+++ b/apt-pkg/acquire.h
@@ -1,11 +1,10 @@
 // -*- mode: cpp; mode: fold -*-
 // Description                                                         /*{{{*/
 // -*- mode: cpp; mode: fold -*-
 // Description                                                         /*{{{*/

-// $Id: acquire.h,v 1.29.2.1 2003/12/24 23:09:17 mdz Exp $

 /* ######################################################################
 
    Acquire - File Acquiration
    
 /* ######################################################################
 
    Acquire - File Acquiration
    

-   This module contians the Acquire system. It is responsible for bringing
+   This module contains the Acquire system. It is responsible for bringing

    files into the local pathname space. It deals with URIs for files and
    URI handlers responsible for downloading or finding the URIs.
    
    files into the local pathname space. It deals with URIs for files and
    URI handlers responsible for downloading or finding the URIs.
    


@@ -68,12 +67,18 @@
 
 #include <apt-pkg/macros.h>
 #include <apt-pkg/weakptr.h>
 
 #include <apt-pkg/macros.h>
 #include <apt-pkg/weakptr.h>

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

 
 

-#include <vector>

 #include <string>
 #include <string>

+#include <vector>

 
 

+#include <stddef.h>

 #include <sys/time.h>
 #include <sys/time.h>

+#include <sys/select.h>
+
+#ifndef APT_10_CLEANER_HEADERS

 #include <unistd.h>
 #include <unistd.h>

+#endif

 
 #ifndef APT_8_CLEANER_HEADERS
 using std::vector;
 
 #ifndef APT_8_CLEANER_HEADERS
 using std::vector;


@@ -96,7 +101,7 @@ class pkgAcquire
    /** \brief FD of the Lock file we acquire in Setup (if any) */
    int LockFD;
    /** \brief dpointer placeholder (for later in case we need it) */
    /** \brief FD of the Lock file we acquire in Setup (if any) */
    int LockFD;
    /** \brief dpointer placeholder (for later in case we need it) */

-   void *d;
+   void * const d;

 
    public:
    
 
    public:
    


@@ -106,6 +111,7 @@ class pkgAcquire
    struct MethodConfig;
    struct ItemDesc;
    friend class Item;
    struct MethodConfig;
    struct ItemDesc;
    friend class Item;

+   friend class pkgAcqMetaBase;

    friend class Queue;
 
    typedef std::vector<Item *>::iterator ItemIterator;
    friend class Queue;
 
    typedef std::vector<Item *>::iterator ItemIterator;


@@ -230,8 +236,15 @@ class pkgAcquire
     *
     *  \param WSet The set of file descriptors that are ready for
     *  output.
     *
     *  \param WSet The set of file descriptors that are ready for
     *  output.

+    *
+    * \return false if there is an error condition on one of the fds

     */
     */

-   virtual void RunFds(fd_set *RSet,fd_set *WSet);   
+   bool RunFdsSane(fd_set *RSet,fd_set *WSet);
+
+   // just here for compatbility, needs to be removed on the next
+   // ABI/API break. RunFdsSane() is what should be used as it
+   // returns if there is an error condition on one of the fds
+   virtual void RunFds(fd_set *RSet,fd_set *WSet);

 
    /** \brief Check for idle queues with ready-to-fetch items.
     *
 
    /** \brief Check for idle queues with ready-to-fetch items.
     *


@@ -282,24 +295,26 @@ class pkgAcquire
     */
    void Shutdown();
    
     */
    void Shutdown();
    

-   /** \brief Get the first #Worker object.
+   /** \brief Get the first Worker object.

     *
     *  \return the first active worker in this download process.
     */
    inline Worker *WorkersBegin() {return Workers;};
 
     *
     *  \return the first active worker in this download process.
     */
    inline Worker *WorkersBegin() {return Workers;};
 

-   /** \brief Advance to the next #Worker object.
+   /** \brief Advance to the next Worker object.

     *
     *  \return the worker immediately following I, or \b NULL if none
     *  exists.
     */
     *
     *  \return the worker immediately following I, or \b NULL if none
     *  exists.
     */

-   Worker *WorkerStep(Worker *I);
+   Worker *WorkerStep(Worker *I) APT_PURE;

 
    /** \brief Get the head of the list of items. */
    inline ItemIterator ItemsBegin() {return Items.begin();};
 
    /** \brief Get the head of the list of items. */
    inline ItemIterator ItemsBegin() {return Items.begin();};

+   inline ItemCIterator ItemsBegin() const {return Items.begin();};

 
    /** \brief Get the end iterator of the list of items. */
    inline ItemIterator ItemsEnd() {return Items.end();};
 
    /** \brief Get the end iterator of the list of items. */
    inline ItemIterator ItemsEnd() {return Items.end();};

+   inline ItemCIterator ItemsEnd() const {return Items.end();};

    
    // Iterate over queued Item URIs
    class UriIterator;
    
    // Iterate over queued Item URIs
    class UriIterator;


@@ -346,14 +361,24 @@ class pkgAcquire
     *  long as the pkgAcquire object does.
     *  \param Lock defines a lock file that should be acquired to ensure
     *  only one Acquire class is in action at the time or an empty string
     *  long as the pkgAcquire object does.
     *  \param Lock defines a lock file that should be acquired to ensure
     *  only one Acquire class is in action at the time or an empty string

-    *  if no lock file should be used.
+    *  if no lock file should be used. If set also all needed directories
+    *  will be created.

     */
     */

-   bool Setup(pkgAcquireStatus *Progress = NULL, std::string const &Lock = "");
+   APT_DEPRECATED_MSG("Use constructors, .SetLog and .GetLock as needed") bool Setup(pkgAcquireStatus *Progress = NULL, std::string const &Lock = "");

 
    void SetLog(pkgAcquireStatus *Progress) { Log = Progress; }
 
 
    void SetLog(pkgAcquireStatus *Progress) { Log = Progress; }
 

+   /** \brief acquire lock and perform directory setup
+    *
+    *  \param Lock defines a lock file that should be acquired to ensure
+    *  only one Acquire class is in action at the time or an empty string
+    *  if no lock file should be used. If set also all needed directories
+    *  will be created and setup.
+    */
+   bool GetLock(std::string const &Lock);
+

    /** \brief Construct a new pkgAcquire. */
    /** \brief Construct a new pkgAcquire. */

-   pkgAcquire(pkgAcquireStatus *Log) __deprecated;
+   explicit pkgAcquire(pkgAcquireStatus *Log);

    pkgAcquire();
 
    /** \brief Destroy this pkgAcquire object.
    pkgAcquire();
 
    /** \brief Destroy this pkgAcquire object.


@@ -363,6 +388,8 @@ class pkgAcquire
     */
    virtual ~pkgAcquire();
 
     */
    virtual ~pkgAcquire();
 

+   private:
+   APT_HIDDEN void Initialize();

 };
 
 /** \brief Represents a single download source from which an item
 };
 
 /** \brief Represents a single download source from which an item


@@ -372,13 +399,13 @@ class pkgAcquire
  */
 struct pkgAcquire::ItemDesc : public WeakPointable
 {
  */
 struct pkgAcquire::ItemDesc : public WeakPointable
 {

-   /** \brief The URI from which to download this item. */
+   /** \brief URI from which to download this item. */

    std::string URI;
    std::string URI;

-   /** brief A description of this item. */
+   /** \brief description of this item. */

    std::string Description;
    std::string Description;

-   /** brief A shorter description of this item. */
+   /** \brief shorter description of this item. */

    std::string ShortDesc;
    std::string ShortDesc;

-   /** brief The underlying item which is to be downloaded. */
+   /** \brief underlying item which is to be downloaded. */

    Item *Owner;
 };
                                                                        /*}}}*/
    Item *Owner;
 };
                                                                        /*}}}*/


@@ -393,7 +420,7 @@ class pkgAcquire::Queue
    friend class pkgAcquire::Worker;
 
    /** \brief dpointer placeholder (for later in case we need it) */
    friend class pkgAcquire::Worker;
 
    /** \brief dpointer placeholder (for later in case we need it) */

-   void *d;
+   void * const d;

 
    /** \brief The next queue in the pkgAcquire object's list of queues. */
    Queue *Next;
 
    /** \brief The next queue in the pkgAcquire object's list of queues. */
    Queue *Next;


@@ -401,13 +428,18 @@ class pkgAcquire::Queue
    protected:
 
    /** \brief A single item placed in this queue. */
    protected:
 
    /** \brief A single item placed in this queue. */

-   struct QItem : pkgAcquire::ItemDesc
+   struct QItem : public ItemDesc

    {
       /** \brief The next item in the queue. */
       QItem *Next;
       /** \brief The worker associated with this item, if any. */
       pkgAcquire::Worker *Worker;
 
    {
       /** \brief The next item in the queue. */
       QItem *Next;
       /** \brief The worker associated with this item, if any. */
       pkgAcquire::Worker *Worker;
 

+      /** \brief The underlying items interested in the download */
+      std::vector<Item*> Owners;
+
+      typedef std::vector<Item*>::const_iterator owner_iterator;
+

       /** \brief Assign the ItemDesc portion of this QItem from
        *  another ItemDesc
        */
       /** \brief Assign the ItemDesc portion of this QItem from
        *  another ItemDesc
        */


@@ -416,10 +448,24 @@ class pkgAcquire::Queue
         URI = I.URI;
         Description = I.Description;
         ShortDesc = I.ShortDesc;
         URI = I.URI;
         Description = I.Description;
         ShortDesc = I.ShortDesc;

+        Owners.clear();
+        Owners.push_back(I.Owner);

         Owner = I.Owner;
       };
         Owner = I.Owner;
       };

+
+      /** @return the sum of all expected hashes by all owners */
+      HashStringList GetExpectedHashes() const;
+
+      /** @return smallest maximum size of all owners */
+      unsigned long long GetMaximumSize() const;
+
+      /** \brief get partial files in order */
+      void SyncDestinationFiles() const;
+
+      /** @return the custom headers to use for this item */
+      std::string Custom600Headers() const;

    };
    };

-   
+

    /** \brief The name of this queue. */
    std::string Name;
 
    /** \brief The name of this queue. */
    std::string Name;
 


@@ -476,7 +522,7 @@ class pkgAcquire::Queue
     *  \return the first item in the queue whose URI is #URI and that
     *  is being downloaded by #Owner.
     */
     *  \return the first item in the queue whose URI is #URI and that
     *  is being downloaded by #Owner.
     */

-   QItem *FindItem(std::string URI,pkgAcquire::Worker *Owner);
+   QItem *FindItem(std::string URI,pkgAcquire::Worker *Owner) APT_PURE;

 
    /** Presumably this should start downloading an item?
     *
 
    /** Presumably this should start downloading an item?
     *


@@ -539,7 +585,7 @@ class pkgAcquire::Queue
     *  \param Name The name of the new queue.
     *  \param Owner The download process that owns the new queue.
     */
     *  \param Name The name of the new queue.
     *  \param Owner The download process that owns the new queue.
     */

-   Queue(std::string Name,pkgAcquire *Owner);
+   Queue(std::string const &Name,pkgAcquire * const Owner);

 
    /** Shut down all the worker processes associated with this queue
     *  and empty the queue.
 
    /** Shut down all the worker processes associated with this queue
     *  and empty the queue.


@@ -551,7 +597,7 @@ class pkgAcquire::Queue
 class pkgAcquire::UriIterator
 {
    /** \brief dpointer placeholder (for later in case we need it) */
 class pkgAcquire::UriIterator
 {
    /** \brief dpointer placeholder (for later in case we need it) */

-   void *d;
+   void * const d;

 
    /** The next queue to iterate over. */
    pkgAcquire::Queue *CurQ;
 
    /** The next queue to iterate over. */
    pkgAcquire::Queue *CurQ;


@@ -572,7 +618,7 @@ class pkgAcquire::UriIterator
       }
    };
    
       }
    };
    

-   inline pkgAcquire::ItemDesc const *operator ->() const {return CurItem;};
+   inline pkgAcquire::Queue::QItem const *operator ->() const {return CurItem;};

    inline bool operator !=(UriIterator const &rhs) const {return rhs.CurQ != CurQ || rhs.CurItem != CurItem;};
    inline bool operator ==(UriIterator const &rhs) const {return rhs.CurQ == CurQ && rhs.CurItem == CurItem;};
    
    inline bool operator !=(UriIterator const &rhs) const {return rhs.CurQ != CurQ || rhs.CurItem != CurItem;};
    inline bool operator ==(UriIterator const &rhs) const {return rhs.CurQ == CurQ && rhs.CurItem == CurItem;};
    


@@ -580,22 +626,15 @@ class pkgAcquire::UriIterator
     *
     *  \param Q The queue over which this UriIterator should iterate.
     */
     *
     *  \param Q The queue over which this UriIterator should iterate.
     */

-   UriIterator(pkgAcquire::Queue *Q) : CurQ(Q), CurItem(0)
-   {
-      while (CurItem == 0 && CurQ != 0)
-      {
-        CurItem = CurQ->Items;
-        CurQ = CurQ->Next;
-      }
-   }   
-   virtual ~UriIterator() {};
+   explicit UriIterator(pkgAcquire::Queue *Q);
+   virtual ~UriIterator();

 };
                                                                        /*}}}*/
 /** \brief Information about the properties of a single acquire method.        {{{*/
 struct pkgAcquire::MethodConfig
 {
    /** \brief dpointer placeholder (for later in case we need it) */
 };
                                                                        /*}}}*/
 /** \brief Information about the properties of a single acquire method.        {{{*/
 struct pkgAcquire::MethodConfig
 {
    /** \brief dpointer placeholder (for later in case we need it) */

-   void *d;
+   void * const d;

    
    /** \brief The next link on the acquire method list.
     *
    
    /** \brief The next link on the acquire method list.
     *


@@ -646,8 +685,7 @@ struct pkgAcquire::MethodConfig
     */
    MethodConfig();
 
     */
    MethodConfig();
 

-   /* \brief Destructor, empty currently */
-   virtual ~MethodConfig() {};
+   virtual ~MethodConfig();

 };
                                                                        /*}}}*/
 /** \brief A monitor object for downloads controlled by the pkgAcquire class.  {{{
 };
                                                                        /*}}}*/
 /** \brief A monitor object for downloads controlled by the pkgAcquire class.  {{{


@@ -657,7 +695,7 @@ struct pkgAcquire::MethodConfig
 class pkgAcquireStatus
 {
    /** \brief dpointer placeholder (for later in case we need it) */
 class pkgAcquireStatus
 {
    /** \brief dpointer placeholder (for later in case we need it) */

-   void *d;
+   void * const d;

 
    protected:
    
 
    protected:
    


@@ -709,6 +747,10 @@ class pkgAcquireStatus
    /** \brief The number of items that have been successfully downloaded. */
    unsigned long CurrentItems;
    
    /** \brief The number of items that have been successfully downloaded. */
    unsigned long CurrentItems;
    

+   /** \brief The estimated percentage of the download (0-100)
+    */
+   double Percent;
+

    public:
 
    /** \brief If \b true, the download scheduler should call Pulse()
    public:
 
    /** \brief If \b true, the download scheduler should call Pulse()


@@ -789,7 +831,7 @@ class pkgAcquireStatus
    
    /** \brief Initialize all counters to 0 and the time to the current time. */
    pkgAcquireStatus();
    
    /** \brief Initialize all counters to 0 and the time to the current time. */
    pkgAcquireStatus();

-   virtual ~pkgAcquireStatus() {};
+   virtual ~pkgAcquireStatus();

 };
                                                                        /*}}}*/
 /** @} */
 };
                                                                        /*}}}*/
 /** @} */