disable timestamps in the footer of docs by doxygen

[apt.git] / methods / mirror.cc

diff --git a/methods/mirror.cc b/methods/mirror.cc
index c4d911a3cce06fa0a82486a0cd34f798a60a23ce..d3aef91bcd3d68054a96754152f418b463d09d8f 100644 (file)
--- a/methods/mirror.cc
+++ b/methods/mirror.cc
@@ -3,39 +3,64 @@
 // $Id: mirror.cc,v 1.59 2004/05/08 19:42:35 mdz Exp $
 /* ######################################################################
 
 // $Id: mirror.cc,v 1.59 2004/05/08 19:42:35 mdz Exp $
 /* ######################################################################
 

-   Mirror Aquire Method - This is the Mirror aquire method for APT.
+   Mirror Acquire Method - This is the Mirror acquire method for APT.

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

+#include <config.h>
+
+#include <apt-pkg/aptconfiguration.h>

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

-#include <apt-pkg/hashes.h>
+#include <apt-pkg/sourcelist.h>
+#include <apt-pkg/configuration.h>
+#include <apt-pkg/metaindex.h>
+#include <apt-pkg/strutl.h>

 
 

-#include <fstream>
+#include <stdlib.h>
+#include <string.h>
+#include <unistd.h>
+#include <algorithm>

 #include <iostream>
 #include <iostream>

-#include <stdarg.h>
+#include <fstream>
+#include <sys/stat.h>
+#include <sys/utsname.h>
+#include <dirent.h>

 
 using namespace std;
 
 
 using namespace std;
 

+#include<sstream>
+

 #include "mirror.h"
 #include "http.h"
 #include "mirror.h"
 #include "http.h"

-
+#include <apti18n.h>

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

+/* Done:
+ * - works with http (only!)
+ * - always picks the first mirror from the list
+ * - call out to problem reporting script
+ * - supports "deb mirror://host/path/to/mirror-list/// dist component"
+ * - uses pkgAcqMethod::FailReason() to have a string representation
+ *   of the failure that is also send to LP
+ * 
+ * TODO: 
+ * - deal with running as non-root because we can't write to the lists
+     dir then -> use the cached mirror file
+ * - better method to download than having a pkgAcquire interface here
+ *   and better error handling there!
+ * - support more than http
+ * - testing :)
+ */
+

 MirrorMethod::MirrorMethod()
 MirrorMethod::MirrorMethod()

-   : HttpMethod(), HasMirrorFile(false)
+   : HttpMethod(), DownloadedMirrorFile(false), Debug(false)

 {
 {

-#if 0
-   HasMirrorFile=true;
-   BaseUri="mirror://people.ubuntu.com/~mvo/mirror/mirrors";
-   MirrorFile="/var/lib/apt/lists/people.ubuntu.com_%7emvo_apt_mirror_mirrors";
-   Mirror="http://de.archive.ubuntu.com/ubuntu/";
-#endif
-};
+}

 
 // HttpMethod::Configuration - Handle a configuration message          /*{{{*/
 // ---------------------------------------------------------------------
 
 // HttpMethod::Configuration - Handle a configuration message          /*{{{*/
 // ---------------------------------------------------------------------


@@ -50,81 +75,389 @@ bool MirrorMethod::Configuration(string Message)
 }
                                                                        /*}}}*/
 
 }
                                                                        /*}}}*/
 

-
-bool MirrorMethod::GetMirrorFile(string uri)
+// clean the mirrors dir based on ttl information
+bool MirrorMethod::Clean(string Dir)

 {
 {

-   string Marker = _config->Find("Acquire::Mirror::MagicMarker","///");
-   BaseUri = uri.substr(0,uri.find(Marker));
+   vector<metaIndex *>::const_iterator I;

 
 

-   string fetch = BaseUri;
-   fetch.replace(0,strlen("mirror://"),"http://");
+   if(Debug)
+      clog << "MirrorMethod::Clean(): " << Dir << endl;

 
 

-   MirrorFile = _config->FindDir("Dir::State::lists") + URItoFileName(BaseUri);
+   if(Dir == "/")
+      return _error->Error("will not clean: '/'");

 
 

-   if(Debug) 
+   // read sources.list
+   pkgSourceList list;
+   list.ReadMainList();
+
+   DIR *D = opendir(Dir.c_str());
+   if (D == 0)
+      return _error->Errno("opendir",_("Unable to read %s"),Dir.c_str());
+
+   string StartDir = SafeGetCWD();
+   if (chdir(Dir.c_str()) != 0)

    {
    {

-      cerr << "base-uri: " << BaseUri << endl;
-      cerr << "mirror-file: " << MirrorFile << endl;
+      closedir(D);
+      return _error->Errno("chdir",_("Unable to change to %s"),Dir.c_str());

    }
 
    }
 

-   // FIXME: fetch it with curl
+   for (struct dirent *Dir = readdir(D); Dir != 0; Dir = readdir(D))
+   {
+      // Skip some files..
+      if (strcmp(Dir->d_name,"lock") == 0 ||
+         strcmp(Dir->d_name,"partial") == 0 ||
+         strcmp(Dir->d_name,".") == 0 ||
+         strcmp(Dir->d_name,"..") == 0)
+        continue;
+
+      // see if we have that uri
+      for(I=list.begin(); I != list.end(); ++I)
+      {
+        string uri = (*I)->GetURI();
+        if(uri.compare(0, strlen("mirror://"), "mirror://") != 0)
+           continue;
+        string BaseUri = uri.substr(0,uri.size()-1);
+        if (URItoFileName(BaseUri) == Dir->d_name)
+           break;
+      }
+      // nothing found, nuke it
+      if (I == list.end())
+        unlink(Dir->d_name);
+   }
+
+   closedir(D);
+   if (chdir(StartDir.c_str()) != 0)
+      return _error->Errno("chdir",_("Unable to change to %s"),StartDir.c_str());
+   return true;
+}
+
+
+bool MirrorMethod::DownloadMirrorFile(string /*mirror_uri_str*/)
+{
+   // not that great to use pkgAcquire here, but we do not have
+   // any other way right now
+   string fetch = BaseUri;
+   fetch.replace(0,strlen("mirror://"),"http://");
+
+#if 0 // no need for this, the getArchitectures() will also include the main
+      // arch
+   // append main architecture
+   fetch += "?arch=" + _config->Find("Apt::Architecture");
+#endif
+
+   // append all architectures
+   std::vector<std::string> vec = APT::Configuration::getArchitectures();
+   for (std::vector<std::string>::const_iterator I = vec.begin();
+        I != vec.end(); ++I)
+      if (I == vec.begin())
+         fetch += "?arch=" + (*I);
+      else
+         fetch += "&arch=" + (*I);
+
+   // append the dist as a query string
+   if (Dist != "")
+      fetch += "&dist=" + Dist;
+
+   if(Debug)
+      clog << "MirrorMethod::DownloadMirrorFile(): '" << fetch << "'"
+           << " to " << MirrorFile << endl;
+

    pkgAcquire Fetcher;
    new pkgAcqFile(&Fetcher, fetch, "", 0, "", "", "", MirrorFile);
    bool res = (Fetcher.Run() == pkgAcquire::Continue);
    pkgAcquire Fetcher;
    new pkgAcqFile(&Fetcher, fetch, "", 0, "", "", "", MirrorFile);
    bool res = (Fetcher.Run() == pkgAcquire::Continue);

-   
-   if(res) 
-      HasMirrorFile = true;
+   if(res) {
+      DownloadedMirrorFile = true;
+      chmod(MirrorFile.c_str(), 0644);
+   }

    Fetcher.Shutdown();
    Fetcher.Shutdown();

+
+   if(Debug)
+      clog << "MirrorMethod::DownloadMirrorFile() success: " << res << endl;
+
+   return res;
+}
+
+// Randomizes the lines in the mirror file, this is used so that
+// we spread the load on the mirrors evenly
+bool MirrorMethod::RandomizeMirrorFile(string mirror_file)
+{
+   vector<string> content;
+   string line;
+
+   if (!FileExists(mirror_file))
+      return false;
+
+   // read
+   ifstream in(mirror_file.c_str());
+   while ( !in.eof() ) {
+      getline(in, line);
+      content.push_back(line);
+   }
+
+   // we want the file to be random for each different machine, but also
+   // "stable" on the same machine. this is to avoid running into out-of-sync
+   // issues (i.e. Release/Release.gpg different on each mirror)
+   struct utsname buf;
+   int seed=1;
+   if(uname(&buf) == 0) {
+      for(int i=0,seed=1; buf.nodename[i] != 0; ++i) {
+         seed = seed * 31 + buf.nodename[i];
+      }
+   }
+   srand( seed );
+   random_shuffle(content.begin(), content.end());
+
+   // write
+   ofstream out(mirror_file.c_str());
+   while ( !content.empty()) {
+      line = content.back();
+      content.pop_back();
+      out << line << "\n";
+   }
+

    return true;
 }
 
    return true;
 }
 

-bool MirrorMethod::SelectMirror()
+/* convert a the Queue->Uri back to the mirror base uri and look
+ * at all mirrors we have for this, this is needed as queue->uri
+ * may point to different mirrors (if TryNextMirror() was run)
+ */
+void MirrorMethod::CurrentQueueUriToMirror()
+{
+   // already in mirror:// style so nothing to do
+   if(Queue->Uri.find("mirror://") == 0)
+      return;
+
+   // find current mirror and select next one
+   for (vector<string>::const_iterator mirror = AllMirrors.begin();
+       mirror != AllMirrors.end(); ++mirror)
+   {
+      if (Queue->Uri.find(*mirror) == 0)
+      {
+        Queue->Uri.replace(0, mirror->length(), BaseUri);
+        return;
+      }
+   }
+   _error->Error("Internal error: Failed to convert %s back to %s",
+                Queue->Uri.c_str(), BaseUri.c_str());
+}
+
+bool MirrorMethod::TryNextMirror()
+{
+   // find current mirror and select next one
+   for (vector<string>::const_iterator mirror = AllMirrors.begin();
+       mirror != AllMirrors.end(); ++mirror)
+   {
+      if (Queue->Uri.find(*mirror) != 0)
+        continue;
+
+      vector<string>::const_iterator nextmirror = mirror + 1;
+      if (nextmirror == AllMirrors.end())
+        break;
+      Queue->Uri.replace(0, mirror->length(), *nextmirror);
+      if (Debug)
+        clog << "TryNextMirror: " << Queue->Uri << endl;
+
+      // inform parent
+      UsedMirror = *nextmirror;
+      Log("Switching mirror");
+      return true;
+   }
+
+   if (Debug)
+      clog << "TryNextMirror could not find another mirror to try" << endl;
+
+   return false;
+}
+
+bool MirrorMethod::InitMirrors()

 {
 {

+   // if we do not have a MirrorFile, fallback
+   if(!FileExists(MirrorFile))
+   {
+      // FIXME: fallback to a default mirror here instead 
+      //        and provide a config option to define that default
+      return _error->Error(_("No mirror file '%s' found "), MirrorFile.c_str());
+   }
+
+   if (access(MirrorFile.c_str(), R_OK) != 0)
+   {
+      // FIXME: fallback to a default mirror here instead 
+      //        and provide a config option to define that default
+      return _error->Error(_("Can not read mirror file '%s'"), MirrorFile.c_str());
+   }  
+
+   // FIXME: make the mirror selection more clever, do not 
+   //        just use the first one!
+   // BUT: we can not make this random, the mirror has to be
+   //      stable across session, because otherwise we can
+   //      get into sync issues (got indexfiles from mirror A,
+   //      but packages from mirror B - one might be out of date etc)

    ifstream in(MirrorFile.c_str());
    ifstream in(MirrorFile.c_str());

-   getline(in, Mirror);
-   if(Debug)
-      cerr << "Using mirror: " << Mirror << endl;
+   string s;
+   while (!in.eof()) 
+   {
+      getline(in, s);
+
+      // ignore lines that start with #
+      if (s.find("#") == 0)
+         continue;
+      // ignore empty lines
+      if (s.size() == 0)
+         continue;
+      // ignore non http lines
+      if (s.compare(0, strlen("http://"), "http://") != 0)
+         continue;
+
+      AllMirrors.push_back(s);
+   }
+   if (AllMirrors.empty()) {
+       return _error->Error(_("No entry found in mirror file '%s'"), MirrorFile.c_str());
+   }
+   Mirror = AllMirrors[0];
+   UsedMirror = Mirror;

    return true;
 }
 
    return true;
 }
 

+string MirrorMethod::GetMirrorFileName(string mirror_uri_str)
+{
+   /* 
+    - a mirror_uri_str looks like this:
+    mirror://people.ubuntu.com/~mvo/apt/mirror/mirrors/dists/feisty/Release.gpg
+   
+    - the matching source.list entry
+    deb mirror://people.ubuntu.com/~mvo/apt/mirror/mirrors feisty main
+   
+    - we actually want to go after:
+    http://people.ubuntu.com/~mvo/apt/mirror/mirrors
+
+    And we need to save the BaseUri for later:
+    - mirror://people.ubuntu.com/~mvo/apt/mirror/mirrors
+
+   FIXME: what if we have two similar prefixes?
+     mirror://people.ubuntu.com/~mvo/mirror
+     mirror://people.ubuntu.com/~mvo/mirror2
+   then mirror_uri_str looks like:
+     mirror://people.ubuntu.com/~mvo/apt/mirror/dists/feisty/Release.gpg
+     mirror://people.ubuntu.com/~mvo/apt/mirror2/dists/feisty/Release.gpg
+   we search sources.list and find:
+     mirror://people.ubuntu.com/~mvo/apt/mirror
+   in both cases! So we need to apply some domain knowledge here :( and
+   check for /dists/ or /Release.gpg as suffixes
+   */
+   string name;
+   if(Debug)
+      std::cerr << "GetMirrorFileName: " << mirror_uri_str << std::endl;
+
+   // read sources.list and find match
+   vector<metaIndex *>::const_iterator I;
+   pkgSourceList list;
+   list.ReadMainList();
+   for(I=list.begin(); I != list.end(); ++I)
+   {
+      string uristr = (*I)->GetURI();
+      if(Debug)
+        std::cerr << "Checking: " << uristr << std::endl;
+      if(uristr.substr(0,strlen("mirror://")) != string("mirror://"))
+        continue;
+      // find matching uri in sources.list
+      if(mirror_uri_str.substr(0,uristr.size()) == uristr)
+      {
+        if(Debug)
+           std::cerr << "found BaseURI: " << uristr << std::endl;
+        BaseUri = uristr.substr(0,uristr.size()-1);
+         Dist = (*I)->GetDist();
+      }
+   }
+   // get new file
+   name = _config->FindDir("Dir::State::mirrors") + URItoFileName(BaseUri);
+
+   if(Debug) 
+   {
+      cerr << "base-uri: " << BaseUri << endl;
+      cerr << "mirror-file: " << name << endl;
+   }
+   return name;
+}
+

 // MirrorMethod::Fetch - Fetch an item                                 /*{{{*/
 // ---------------------------------------------------------------------
 /* This adds an item to the pipeline. We keep the pipeline at a fixed
    depth. */
 bool MirrorMethod::Fetch(FetchItem *Itm)
 {
 // MirrorMethod::Fetch - Fetch an item                                 /*{{{*/
 // ---------------------------------------------------------------------
 /* This adds an item to the pipeline. We keep the pipeline at a fixed
    depth. */
 bool MirrorMethod::Fetch(FetchItem *Itm)
 {

-   // get mirror information
-   if(!HasMirrorFile)
+   if(Debug)
+      clog << "MirrorMethod::Fetch()" << endl;
+
+   // the http method uses Fetch(0) as a way to update the pipeline,
+   // just let it do its work in this case - Fetch() with a valid
+   // Itm will always run before the first Fetch(0)
+   if(Itm == NULL) 
+      return HttpMethod::Fetch(Itm);
+
+   // if we don't have the name of the mirror file on disk yet,
+   // calculate it now (can be derived from the uri)
+   if(MirrorFile.empty())
+      MirrorFile = GetMirrorFileName(Itm->Uri);
+
+  // download mirror file once (if we are after index files)
+   if(Itm->IndexFile && !DownloadedMirrorFile)

    {
    {

-      GetMirrorFile(Itm->Uri);
-      SelectMirror();
+      Clean(_config->FindDir("Dir::State::mirrors"));
+      if (DownloadMirrorFile(Itm->Uri))
+         RandomizeMirrorFile(MirrorFile);

    }
 
    }
 

-   if(Queue->Uri.find("mirror://") != string::npos)
-      Queue->Uri.replace(0,BaseUri.size(),Mirror);
+   if(AllMirrors.empty()) {
+      if(!InitMirrors()) {
+        // no valid mirror selected, something went wrong downloading
+        // from the master mirror site most likely and there is
+        // no old mirror file availalbe
+        return false;
+      }
+   }
+
+   if(Itm->Uri.find("mirror://") != string::npos)
+      Itm->Uri.replace(0,BaseUri.size(), Mirror);
+
+   if(Debug)
+      clog << "Fetch: " << Itm->Uri << endl << endl;

 
    // now run the real fetcher
    return HttpMethod::Fetch(Itm);
 
    // now run the real fetcher
    return HttpMethod::Fetch(Itm);

-};
+}

 
 void MirrorMethod::Fail(string Err,bool Transient)
 {
 
 void MirrorMethod::Fail(string Err,bool Transient)
 {

-   if(Queue->Uri.find("http://") != string::npos)
-      Queue->Uri.replace(0,Mirror.size(), BaseUri);
+   // FIXME: TryNextMirror is not ideal for indexfile as we may
+   //        run into auth issues
+
+   if (Debug)
+      clog << "Failure to get " << Queue->Uri << endl;
+
+   // try the next mirror on fail (if its not a expected failure,
+   // e.g. translations are ok to ignore)
+   if (!Queue->FailIgnore && TryNextMirror())
+      return;
+
+   // all mirrors failed, so bail out
+   string s;
+   strprintf(s, _("[Mirror: %s]"), Mirror.c_str());
+   SetIP(s);
+
+   CurrentQueueUriToMirror();

    pkgAcqMethod::Fail(Err, Transient);
 }
 
 void MirrorMethod::URIStart(FetchResult &Res)
 {
    pkgAcqMethod::Fail(Err, Transient);
 }
 
 void MirrorMethod::URIStart(FetchResult &Res)
 {

-   if(Queue->Uri.find("http://") != string::npos)
-      Queue->Uri.replace(0,Mirror.size(), BaseUri);
+   CurrentQueueUriToMirror();

    pkgAcqMethod::URIStart(Res);
 }
 
 void MirrorMethod::URIDone(FetchResult &Res,FetchResult *Alt)
 {
    pkgAcqMethod::URIStart(Res);
 }
 
 void MirrorMethod::URIDone(FetchResult &Res,FetchResult *Alt)
 {

-   if(Queue->Uri.find("http://") != string::npos)
-      Queue->Uri.replace(0,Mirror.size(), BaseUri);
+   CurrentQueueUriToMirror();

    pkgAcqMethod::URIDone(Res, Alt);
 }
 
    pkgAcqMethod::URIDone(Res, Alt);
 }