correct various errors, typos and oddities in the manpages

[apt.git] / apt-pkg / acquire-method.cc

diff --git a/apt-pkg/acquire-method.cc b/apt-pkg/acquire-method.cc
index 1cebf9a71d2d313700fc1f352b5b44bfbe477f23..fe066741c4456fc7dd0f35bdd59705d125919d80 100644 (file)
--- a/apt-pkg/acquire-method.cc
+++ b/apt-pkg/acquire-method.cc
@@ -1,25 +1,36 @@
 // -*- mode: cpp; mode: fold -*-
 // Description                                                         /*{{{*/
 // -*- mode: cpp; mode: fold -*-
 // Description                                                         /*{{{*/

-// $Id: acquire-method.cc,v 1.11 1998/12/04 21:16:46 jgg Exp $
+// $Id: acquire-method.cc,v 1.27.2.1 2003/12/24 23:09:17 mdz Exp $

 /* ######################################################################
 
    Acquire Method
 
 /* ######################################################################
 
    Acquire Method
 

+   This is a skeleton class that implements most of the functionality
+   of a method and some useful functions to make method implementation
+   simpler. The methods all derive this and specialize it. The most
+   complex implementation is the http method which needs to provide
+   pipelining, it runs the message engine at the same time it is 
+   downloading files..
+   

    ##################################################################### */
                                                                        /*}}}*/
 // Include Files                                                       /*{{{*/
    ##################################################################### */
                                                                        /*}}}*/
 // Include Files                                                       /*{{{*/

-#ifdef __GNUG__
-#pragma implementation "apt-pkg/acquire-method.h"
-#endif

 #include <apt-pkg/acquire-method.h>
 #include <apt-pkg/error.h>
 #include <apt-pkg/configuration.h>
 #include <apt-pkg/acquire-method.h>
 #include <apt-pkg/error.h>
 #include <apt-pkg/configuration.h>

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

 #include <apt-pkg/fileutl.h>
 #include <apt-pkg/fileutl.h>

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

 
 

+#include <iostream>
+#include <stdarg.h>

 #include <stdio.h>
 #include <stdio.h>

+#include <unistd.h>
+#include <sys/signal.h>

                                                                        /*}}}*/
 
                                                                        /*}}}*/
 

+using namespace std;
+

 // AcqMethod::pkgAcqMethod - Constructor                               /*{{{*/
 // ---------------------------------------------------------------------
 /* This constructs the initialization text */
 // AcqMethod::pkgAcqMethod - Constructor                               /*{{{*/
 // ---------------------------------------------------------------------
 /* This constructs the initialization text */


@@ -41,14 +52,21 @@ pkgAcqMethod::pkgAcqMethod(const char *Ver,unsigned long Flags)
 
    if ((Flags & LocalOnly) == LocalOnly)
       strcat(End,"Local-Only: true\n");
 
    if ((Flags & LocalOnly) == LocalOnly)
       strcat(End,"Local-Only: true\n");

+
+   if ((Flags & NeedsCleanup) == NeedsCleanup)
+      strcat(End,"Needs-Cleanup: true\n");
+
+   if ((Flags & Removable) == Removable)
+      strcat(End,"Removable: true\n");

    strcat(End,"\n");
 
    if (write(STDOUT_FILENO,S,strlen(S)) != (signed)strlen(S))
       exit(100);
 
    SetNonBlock(STDIN_FILENO,true);
    strcat(End,"\n");
 
    if (write(STDOUT_FILENO,S,strlen(S)) != (signed)strlen(S))
       exit(100);
 
    SetNonBlock(STDIN_FILENO,true);

-   
+

    Queue = 0;
    Queue = 0;

+   QueueBack = 0;

 }
                                                                        /*}}}*/
 // AcqMethod::Fail - A fetch has failed                                        /*{{{*/
 }
                                                                        /*}}}*/
 // AcqMethod::Fail - A fetch has failed                                        /*{{{*/


@@ -67,21 +85,34 @@ void pkgAcqMethod::Fail(bool Transient)
 // ---------------------------------------------------------------------
 /* */
 void pkgAcqMethod::Fail(string Err,bool Transient)
 // ---------------------------------------------------------------------
 /* */
 void pkgAcqMethod::Fail(string Err,bool Transient)

-{   
+{
+   // Strip out junk from the error messages
+   for (string::iterator I = Err.begin(); I != Err.end(); I++)
+   {
+      if (*I == '\r') 
+        *I = ' ';
+      if (*I == '\n') 
+        *I = ' ';
+   }
+   

    char S[1024];
    if (Queue != 0)
    {
    char S[1024];
    if (Queue != 0)
    {

-      snprintf(S,sizeof(S),"400 URI Failure\nURI: %s\n"
-              "Message: %s\n",Queue->Uri.c_str(),Err.c_str());
+      snprintf(S,sizeof(S)-50,"400 URI Failure\nURI: %s\n"
+              "Message: %s %s\n",Queue->Uri.c_str(),Err.c_str(),
+              FailExtra.c_str());

 
       // Dequeue
       FetchItem *Tmp = Queue;
       Queue = Queue->Next;
       delete Tmp;
 
       // Dequeue
       FetchItem *Tmp = Queue;
       Queue = Queue->Next;
       delete Tmp;

+      if (Tmp == QueueBack)
+        QueueBack = Queue;

    }
    else
    }
    else

-      snprintf(S,sizeof(S),"400 URI Failure\nURI: <UNKNOWN>\n"
-              "Message: %s\n",Err.c_str());
+      snprintf(S,sizeof(S)-50,"400 URI Failure\nURI: <UNKNOWN>\n"
+              "Message: %s %s\n",Err.c_str(),
+              FailExtra.c_str());

       
    // Set the transient flag 
    if (Transient == true)
       
    // Set the transient flag 
    if (Transient == true)


@@ -106,14 +137,14 @@ void pkgAcqMethod::URIStart(FetchResult &Res)
    
    End += snprintf(S,sizeof(S),"200 URI Start\nURI: %s\n",Queue->Uri.c_str());
    if (Res.Size != 0)
    
    End += snprintf(S,sizeof(S),"200 URI Start\nURI: %s\n",Queue->Uri.c_str());
    if (Res.Size != 0)

-      End += snprintf(End,sizeof(S) - (End - S),"Size: %u\n",Res.Size);
+      End += snprintf(End,sizeof(S)-4 - (End - S),"Size: %lu\n",Res.Size);

    
    if (Res.LastModified != 0)
    
    if (Res.LastModified != 0)

-      End += snprintf(End,sizeof(S) - (End - S),"Last-Modified: %s\n",
+      End += snprintf(End,sizeof(S)-4 - (End - S),"Last-Modified: %s\n",

                      TimeRFC1123(Res.LastModified).c_str());
    
    if (Res.ResumePoint != 0)
                      TimeRFC1123(Res.LastModified).c_str());
    
    if (Res.ResumePoint != 0)

-      End += snprintf(End,sizeof(S) - (End - S),"Resume-Point: %u\n",
+      End += snprintf(End,sizeof(S)-4 - (End - S),"Resume-Point: %lu\n",

                      Res.ResumePoint);
       
    strcat(End,"\n");
                      Res.ResumePoint);
       
    strcat(End,"\n");


@@ -135,20 +166,32 @@ void pkgAcqMethod::URIDone(FetchResult &Res, FetchResult *Alt)
    End += snprintf(S,sizeof(S),"201 URI Done\nURI: %s\n",Queue->Uri.c_str());
 
    if (Res.Filename.empty() == false)
    End += snprintf(S,sizeof(S),"201 URI Done\nURI: %s\n",Queue->Uri.c_str());
 
    if (Res.Filename.empty() == false)

-      End += snprintf(End,sizeof(S) - (End - S),"Filename: %s\n",Res.Filename.c_str());
+      End += snprintf(End,sizeof(S)-50 - (End - S),"Filename: %s\n",Res.Filename.c_str());

    
    if (Res.Size != 0)
    
    if (Res.Size != 0)

-      End += snprintf(End,sizeof(S) - (End - S),"Size: %u\n",Res.Size);
+      End += snprintf(End,sizeof(S)-50 - (End - S),"Size: %lu\n",Res.Size);

    
    if (Res.LastModified != 0)
    
    if (Res.LastModified != 0)

-      End += snprintf(End,sizeof(S) - (End - S),"Last-Modified: %s\n",
+      End += snprintf(End,sizeof(S)-50 - (End - S),"Last-Modified: %s\n",

                      TimeRFC1123(Res.LastModified).c_str());
 
    if (Res.MD5Sum.empty() == false)
                      TimeRFC1123(Res.LastModified).c_str());
 
    if (Res.MD5Sum.empty() == false)

-      End += snprintf(End,sizeof(S) - (End - S),"MD5Sum: %s\n",Res.MD5Sum.c_str());
+   {
+      End += snprintf(End,sizeof(S)-50 - (End - S),"MD5-Hash: %s\n",Res.MD5Sum.c_str());
+      End += snprintf(End,sizeof(S)-50 - (End - S),"MD5Sum-Hash: %s\n",Res.MD5Sum.c_str());
+   }
+   if (Res.SHA1Sum.empty() == false)
+      End += snprintf(End,sizeof(S)-50 - (End - S),"SHA1-Hash: %s\n",Res.SHA1Sum.c_str());
+   if (Res.SHA256Sum.empty() == false)
+      End += snprintf(End,sizeof(S)-50 - (End - S),"SHA256-Hash: %s\n",Res.SHA256Sum.c_str());
+   if (Res.GPGVOutput.size() > 0)
+      End += snprintf(End,sizeof(S)-50 - (End - S),"GPGVOutput:\n");     
+   for (vector<string>::iterator I = Res.GPGVOutput.begin();
+      I != Res.GPGVOutput.end(); I++)
+      End += snprintf(End,sizeof(S)-50 - (End - S), " %s\n", (*I).c_str());

 
    if (Res.ResumePoint != 0)
 
    if (Res.ResumePoint != 0)

-      End += snprintf(End,sizeof(S) - (End - S),"Resume-Point: %u\n",
+      End += snprintf(End,sizeof(S)-50 - (End - S),"Resume-Point: %lu\n",

                      Res.ResumePoint);
 
    if (Res.IMSHit == true)
                      Res.ResumePoint);
 
    if (Res.IMSHit == true)


@@ -158,18 +201,24 @@ void pkgAcqMethod::URIDone(FetchResult &Res, FetchResult *Alt)
    if (Alt != 0)
    {
       if (Alt->Filename.empty() == false)
    if (Alt != 0)
    {
       if (Alt->Filename.empty() == false)

-        End += snprintf(End,sizeof(S) - (End - S),"Alt-Filename: %s\n",Alt->Filename.c_str());
+        End += snprintf(End,sizeof(S)-50 - (End - S),"Alt-Filename: %s\n",Alt->Filename.c_str());

       
       if (Alt->Size != 0)
       
       if (Alt->Size != 0)

-        End += snprintf(End,sizeof(S) - (End - S),"Alt-Size: %u\n",Alt->Size);
+        End += snprintf(End,sizeof(S)-50 - (End - S),"Alt-Size: %lu\n",Alt->Size);

       
       if (Alt->LastModified != 0)
       
       if (Alt->LastModified != 0)

-        End += snprintf(End,sizeof(S) - (End - S),"Alt-Last-Modified: %s\n",
+        End += snprintf(End,sizeof(S)-50 - (End - S),"Alt-Last-Modified: %s\n",

                         TimeRFC1123(Alt->LastModified).c_str());
       
       if (Alt->MD5Sum.empty() == false)
                         TimeRFC1123(Alt->LastModified).c_str());
       
       if (Alt->MD5Sum.empty() == false)

-        End += snprintf(End,sizeof(S) - (End - S),"Alt-MD5Sum: %s\n",
+        End += snprintf(End,sizeof(S)-50 - (End - S),"Alt-MD5-Hash: %s\n",

                         Alt->MD5Sum.c_str());
                         Alt->MD5Sum.c_str());

+      if (Alt->SHA1Sum.empty() == false)
+        End += snprintf(End,sizeof(S)-50 - (End - S),"Alt-SHA1-Hash: %s\n",
+                        Alt->SHA1Sum.c_str());
+      if (Alt->SHA256Sum.empty() == false)
+        End += snprintf(End,sizeof(S)-50 - (End - S),"Alt-SHA256-Hash: %s\n",
+                        Alt->SHA256Sum.c_str());

       
       if (Alt->IMSHit == true)
         strcat(End,"Alt-IMS-Hit: true\n");
       
       if (Alt->IMSHit == true)
         strcat(End,"Alt-IMS-Hit: true\n");


@@ -183,13 +232,15 @@ void pkgAcqMethod::URIDone(FetchResult &Res, FetchResult *Alt)
    FetchItem *Tmp = Queue;
    Queue = Queue->Next;
    delete Tmp;
    FetchItem *Tmp = Queue;
    Queue = Queue->Next;
    delete Tmp;

+   if (Tmp == QueueBack)
+      QueueBack = Queue;

 }
                                                                        /*}}}*/
 // AcqMethod::MediaFail - Syncronous request for new media             /*{{{*/
 // ---------------------------------------------------------------------
 /* This sends a 403 Media Failure message to the APT and waits for it
    to be ackd */
 }
                                                                        /*}}}*/
 // AcqMethod::MediaFail - Syncronous request for new media             /*{{{*/
 // ---------------------------------------------------------------------
 /* This sends a 403 Media Failure message to the APT and waits for it
    to be ackd */

-void pkgAcqMethod::MediaFail(string Required,string Drive)
+bool pkgAcqMethod::MediaFail(string Required,string Drive)

 {
    char S[1024];
    snprintf(S,sizeof(S),"403 Media Failure\nMedia: %s\nDrive: %s\n\n",
 {
    char S[1024];
    snprintf(S,sizeof(S),"403 Media Failure\nMedia: %s\nDrive: %s\n\n",


@@ -205,11 +256,11 @@ void pkgAcqMethod::MediaFail(string Required,string Drive)
    while (1)
    {
       if (WaitFd(STDIN_FILENO) == false)
    while (1)
    {
       if (WaitFd(STDIN_FILENO) == false)

-        exit(0);
+        return false;

       
       if (ReadMessages(STDIN_FILENO,MyMessages) == false)
       
       if (ReadMessages(STDIN_FILENO,MyMessages) == false)

-        exit(0);
-      
+        return false;
+

       string Message = MyMessages.front();
       MyMessages.erase(MyMessages.begin());
       
       string Message = MyMessages.front();
       MyMessages.erase(MyMessages.begin());
       


@@ -225,13 +276,13 @@ void pkgAcqMethod::MediaFail(string Required,string Drive)
       // Change ack
       if (Number == 603)
       {
       // Change ack
       if (Number == 603)
       {

-        while (Message.empty() == false)
+        while (MyMessages.empty() == false)

         {
            Messages.push_back(MyMessages.front());
            MyMessages.erase(MyMessages.begin());
         }
 
         {
            Messages.push_back(MyMessages.front());
            MyMessages.erase(MyMessages.begin());
         }
 

-        return StringToBool(LookupTag(Message,"Fail"),false);
+        return !StringToBool(LookupTag(Message,"Failed"),false);

       }
       
       Messages.push_back(Message);
       }
       
       Messages.push_back(Message);


@@ -246,10 +297,11 @@ bool pkgAcqMethod::Configuration(string Message)
 {
    ::Configuration &Cnf = *_config;
    
 {
    ::Configuration &Cnf = *_config;
    

-   const char *I = Message.begin();
+   const char *I = Message.c_str();
+   const char *MsgEnd = I + Message.length();

    
    unsigned int Length = strlen("Config-Item");
    
    unsigned int Length = strlen("Config-Item");

-   for (; I + Length < Message.end(); I++)
+   for (; I + Length < MsgEnd; I++)

    {
       // Not a config item
       if (I[Length] != ':' || stringcasecmp(I,I+Length,"Config-Item") != 0)
    {
       // Not a config item
       if (I[Length] != ':' || stringcasecmp(I,I+Length,"Config-Item") != 0)


@@ -257,15 +309,16 @@ bool pkgAcqMethod::Configuration(string Message)
       
       I += Length + 1;
       
       
       I += Length + 1;
       

-      for (; I < Message.end() && *I == ' '; I++);
+      for (; I < MsgEnd && *I == ' '; I++);

       const char *Equals = I;
       const char *Equals = I;

-      for (; Equals < Message.end() && *Equals != '='; Equals++);
+      for (; Equals < MsgEnd && *Equals != '='; Equals++);

       const char *End = Equals;
       const char *End = Equals;

-      for (; End < Message.end() && *End != '\n'; End++);
+      for (; End < MsgEnd && *End != '\n'; End++);

       if (End == Equals)
         return false;
       
       if (End == Equals)
         return false;
       

-      Cnf.Set(string(I,Equals-I),string(Equals+1,End-Equals-1));
+      Cnf.Set(DeQuoteString(string(I,Equals-I)),
+             DeQuoteString(string(Equals+1,End-Equals-1)));

       I = End;
    }
    
       I = End;
    }
    


@@ -274,7 +327,9 @@ bool pkgAcqMethod::Configuration(string Message)
                                                                        /*}}}*/
 // AcqMethod::Run - Run the message engine                             /*{{{*/
 // ---------------------------------------------------------------------
                                                                        /*}}}*/
 // AcqMethod::Run - Run the message engine                             /*{{{*/
 // ---------------------------------------------------------------------

-/* */
+/* Fetch any messages and execute them. In single mode it returns 1 if
+   there are no more available messages - any other result is a 
+   fatal failure code! */

 int pkgAcqMethod::Run(bool Single)
 {
    while (1)
 int pkgAcqMethod::Run(bool Single)
 {
    while (1)


@@ -284,15 +339,14 @@ int pkgAcqMethod::Run(bool Single)
       {
         if (Single == false)
            if (WaitFd(STDIN_FILENO) == false)
       {
         if (Single == false)
            if (WaitFd(STDIN_FILENO) == false)

-              return 0;
-      
+              break;

         if (ReadMessages(STDIN_FILENO,Messages) == false)
         if (ReadMessages(STDIN_FILENO,Messages) == false)

-           return 0;
+           break;

       }
             
       // Single mode exits if the message queue is empty
       if (Single == true && Messages.empty() == true)
       }
             
       // Single mode exits if the message queue is empty
       if (Single == true && Messages.empty() == true)

-        return 0;
+        return -1;

       
       string Message = Messages.front();
       Messages.erase(Messages.begin());
       
       string Message = Messages.front();
       Messages.erase(Messages.begin());


@@ -307,7 +361,7 @@ int pkgAcqMethod::Run(bool Single)
       }
 
       switch (Number)
       }
 
       switch (Number)

-      {
+      {         

         case 601:
         if (Configuration(Message) == false)
            return 100;
         case 601:
         if (Configuration(Message) == false)
            return 100;


@@ -328,7 +382,9 @@ int pkgAcqMethod::Run(bool Single)
            FetchItem **I = &Queue;
            for (; *I != 0; I = &(*I)->Next);
            *I = Tmp;
            FetchItem **I = &Queue;
            for (; *I != 0; I = &(*I)->Next);
            *I = Tmp;

-
+           if (QueueBack == 0)
+              QueueBack = Tmp;
+           

            // Notify that this item is to be fetched.
            if (Fetch(Tmp) == false)
               Fail();
            // Notify that this item is to be fetched.
            if (Fetch(Tmp) == false)
               Fail();


@@ -338,6 +394,7 @@ int pkgAcqMethod::Run(bool Single)
       }      
    }
 
       }      
    }
 

+   Exit();

    return 0;
 }
                                                                        /*}}}*/
    return 0;
 }
                                                                        /*}}}*/


@@ -355,10 +412,10 @@ void pkgAcqMethod::Log(const char *Format,...)
 
    // sprintf the description
    char S[1024];
 
    // sprintf the description
    char S[1024];

-   unsigned int Len = snprintf(S,sizeof(S),"101 Log\nURI: %s\n"
+   unsigned int Len = snprintf(S,sizeof(S)-4,"101 Log\nURI: %s\n"

                               "Message: ",CurrentURI.c_str());
 
                               "Message: ",CurrentURI.c_str());
 

-   vsnprintf(S+Len,sizeof(S)-Len,Format,args);
+   vsnprintf(S+Len,sizeof(S)-4-Len,Format,args);

    strcat(S,"\n\n");
    
    if (write(STDOUT_FILENO,S,strlen(S)) != (signed)strlen(S))
    strcat(S,"\n\n");
    
    if (write(STDOUT_FILENO,S,strlen(S)) != (signed)strlen(S))


@@ -379,17 +436,47 @@ void pkgAcqMethod::Status(const char *Format,...)
 
    // sprintf the description
    char S[1024];
 
    // sprintf the description
    char S[1024];

-   unsigned int Len = snprintf(S,sizeof(S),"102 Status\nURI: %s\n"
+   unsigned int Len = snprintf(S,sizeof(S)-4,"102 Status\nURI: %s\n"

                               "Message: ",CurrentURI.c_str());
 
                               "Message: ",CurrentURI.c_str());
 

-   vsnprintf(S+Len,sizeof(S)-Len,Format,args);
+   vsnprintf(S+Len,sizeof(S)-4-Len,Format,args);

    strcat(S,"\n\n");
    
    if (write(STDOUT_FILENO,S,strlen(S)) != (signed)strlen(S))
       exit(100);
 }
                                                                        /*}}}*/
    strcat(S,"\n\n");
    
    if (write(STDOUT_FILENO,S,strlen(S)) != (signed)strlen(S))
       exit(100);
 }
                                                                        /*}}}*/

+// AcqMethod::Redirect - Send a redirect message                       /*{{{*/
+// ---------------------------------------------------------------------
+/* This method sends the redirect message and also manipulates the queue
+   to keep the pipeline synchronized. */
+void pkgAcqMethod::Redirect(const string &NewURI)
+{
+   string CurrentURI = "<UNKNOWN>";
+   if (Queue != 0)
+      CurrentURI = Queue->Uri;
+ 
+   char S[1024];
+   snprintf(S, sizeof(S)-50, "103 Redirect\nURI: %s\nNew-URI: %s\n\n",
+         CurrentURI.c_str(), NewURI.c_str());

 
 

+   if (write(STDOUT_FILENO,S,strlen(S)) != (ssize_t)strlen(S))
+      exit(100);
+
+   // Change the URI for the request.
+   Queue->Uri = NewURI;
+
+   /* To keep the pipeline synchronized, move the current request to
+      the end of the queue, past the end of the current pipeline. */
+   FetchItem *I;
+   for (I = Queue; I->Next != 0; I = I->Next) ;
+   I->Next = Queue;
+   Queue = Queue->Next;
+   I->Next->Next = 0;
+   if (QueueBack == 0)
+      QueueBack = I->Next;
+}
+                                                                        /*}}}*/

 // AcqMethod::FetchResult::FetchResult - Constructor                   /*{{{*/
 // ---------------------------------------------------------------------
 /* */
 // AcqMethod::FetchResult::FetchResult - Constructor                   /*{{{*/
 // ---------------------------------------------------------------------
 /* */


@@ -398,4 +485,14 @@ pkgAcqMethod::FetchResult::FetchResult() : LastModified(0),
 {
 }
                                                                        /*}}}*/
 {
 }
                                                                        /*}}}*/

-
+// AcqMethod::FetchResult::TakeHashes - Load hashes                    /*{{{*/
+// ---------------------------------------------------------------------
+/* This hides the number of hashes we are supporting from the caller. 
+   It just deals with the hash class. */
+void pkgAcqMethod::FetchResult::TakeHashes(Hashes &Hash)
+{
+   MD5Sum = Hash.MD5.Result();
+   SHA1Sum = Hash.SHA1.Result();
+   SHA256Sum = Hash.SHA256.Result();
+}
+                                                                       /*}}}*/