methods/mirror.cc

   1 // -*- mode: cpp; mode: fold -*-
   2 // Description                                                          /*{{{*/
   3 // $Id: mirror.cc,v 1.59 2004/05/08 19:42:35 mdz Exp $
   4 /* ######################################################################
   5
   6    Mirror Aquire Method - This is the Mirror aquire method for APT.
   7
   8    ##################################################################### */
   9                                                                         /*}}}*/
  10 // Include Files                                                        /*{{{*/
  11 #include <apt-pkg/fileutl.h>
  12 #include <apt-pkg/acquire-method.h>
  13 #include <apt-pkg/acquire-item.h>
  14 #include <apt-pkg/acquire.h>
  15 #include <apt-pkg/error.h>
  16 #include <apt-pkg/hashes.h>
  17 #include <apt-pkg/sourcelist.h>
  18
  19
  20 #include <algorithm>
  21 #include <fstream>
  22 #include <iostream>
  23
  24 #include <stdarg.h>
  25 #include <sys/stat.h>
  26 #include <sys/types.h>
  27 #include <sys/utsname.h>
  28 #include <dirent.h>
  29
  30 using namespace std;
  31
  32 #include<sstream>
  33
  34 #include "mirror.h"
  35 #include "http.h"
  36 #include "apti18n.h"
  37                                                                         /*}}}*/
  38
  39 /* Done:
  40  * - works with http (only!)
  41  * - always picks the first mirror from the list
  42  * - call out to problem reporting script
  43  * - supports "deb mirror://host/path/to/mirror-list/// dist component"
  44  * - uses pkgAcqMethod::FailReason() to have a string representation
  45  *   of the failure that is also send to LP
  46  *
  47  * TODO:
  48  * - deal with runing as non-root because we can't write to the lists
  49      dir then -> use the cached mirror file
  50  * - better method to download than having a pkgAcquire interface here
  51  *   and better error handling there!
  52  * - support more than http
  53  * - testing :)
  54  */
  55
  56 MirrorMethod::MirrorMethod()
  57    : HttpMethod(), DownloadedMirrorFile(false)
  58 {
  59 };
  60
  61 // HttpMethod::Configuration - Handle a configuration message           /*{{{*/
  62 // ---------------------------------------------------------------------
  63 /* We stash the desired pipeline depth */
  64 bool MirrorMethod::Configuration(string Message)
  65 {
  66    if (pkgAcqMethod::Configuration(Message) == false)
  67       return false;
  68    Debug = _config->FindB("Debug::Acquire::mirror",false);
  69
  70    return true;
  71 }
  72                                                                         /*}}}*/
  73
  74 // clean the mirrors dir based on ttl information
  75 bool MirrorMethod::Clean(string Dir)
  76 {
  77    vector<metaIndex *>::const_iterator I;
  78
  79    if(Debug)
  80       clog << "MirrorMethod::Clean(): " << Dir << endl;
  81
  82    if(Dir == "/")
  83       return _error->Error("will not clean: '/'");
  84
  85    // read sources.list
  86    pkgSourceList list;
  87    list.ReadMainList();
  88
  89    DIR *D = opendir(Dir.c_str());
  90    if (D == 0)
  91       return _error->Errno("opendir",_("Unable to read %s"),Dir.c_str());
  92
  93    string StartDir = SafeGetCWD();
  94    if (chdir(Dir.c_str()) != 0)
  95    {
  96       closedir(D);
  97       return _error->Errno("chdir",_("Unable to change to %s"),Dir.c_str());
  98    }
  99
 100    for (struct dirent *Dir = readdir(D); Dir != 0; Dir = readdir(D))
 101    {
 102       // Skip some files..
 103       if (strcmp(Dir->d_name,"lock") == 0 ||
 104           strcmp(Dir->d_name,"partial") == 0 ||
 105           strcmp(Dir->d_name,".") == 0 ||
 106           strcmp(Dir->d_name,"..") == 0)
 107          continue;
 108
 109       // see if we have that uri
 110       for(I=list.begin(); I != list.end(); I++)
 111       {
 112          string uri = (*I)->GetURI();
 113          if(uri.find("mirror://") != 0)
 114             continue;
 115          string BaseUri = uri.substr(0,uri.size()-1);
 116          if (URItoFileName(BaseUri) == Dir->d_name)
 117             break;
 118       }
 119       // nothing found, nuke it
 120       if (I == list.end())
 121          unlink(Dir->d_name);
 122    };
 123
 124    chdir(StartDir.c_str());
 125    closedir(D);
 126    return true;
 127 }
 128
 129
 130 bool MirrorMethod::DownloadMirrorFile(string mirror_uri_str)
 131 {
 132    // not that great to use pkgAcquire here, but we do not have
 133    // any other way right now
 134    string fetch = BaseUri;
 135    fetch.replace(0,strlen("mirror://"),"http://");
 136
 137    if(Debug)
 138       clog << "MirrorMethod::DownloadMirrorFile(): '" << fetch << "'"
 139            << " to " << MirrorFile << endl;
 140
 141    pkgAcquire Fetcher;
 142    new pkgAcqFile(&Fetcher, fetch, "", 0, "", "", "", MirrorFile);
 143    bool res = (Fetcher.Run() == pkgAcquire::Continue);
 144    if(res)
 145       DownloadedMirrorFile = true;
 146    Fetcher.Shutdown();
 147
 148    if(Debug)
 149       clog << "MirrorMethod::DownloadMirrorFile() success: " << res << endl;
 150
 151    return res;
 152 }
 153
 154 // Randomizes the lines in the mirror file, this is used so that
 155 // we spread the load on the mirrors evenly
 156 bool MirrorMethod::RandomizeMirrorFile(string mirror_file)
 157 {
 158    vector<string> content;
 159    string line;
 160
 161    // read
 162    ifstream in(mirror_file.c_str());
 163    while ( !in.eof() ) {
 164       getline(in, line);
 165       content.push_back(line);
 166    }
 167
 168    // we want the file to be random for each different machine, but also
 169    // "stable" on the same machine. this is to avoid running into out-of-sync
 170    // issues (i.e. Release/Release.gpg different on each mirror)
 171    struct utsname buf;
 172    int seed=1, i;
 173    if(uname(&buf) == 0) {
 174       for(i=0,seed=1; buf.nodename[i] != 0; i++) {
 175          seed = seed * 31 + buf.nodename[i];
 176       }
 177    }
 178    srand( seed );
 179    random_shuffle(content.begin(), content.end());
 180
 181    // write
 182    ofstream out(mirror_file.c_str());
 183    while ( !content.empty()) {
 184       line = content.back();
 185       content.pop_back();
 186       out << line << "\n";
 187    }
 188
 189    return true;
 190 }
 191
 192 /* convert a the Queue->Uri back to the mirror base uri and look
 193  * at all mirrors we have for this, this is needed as queue->uri
 194  * may point to different mirrors (if TryNextMirror() was run)
 195  */
 196 void MirrorMethod::CurrentQueueUriToMirror()
 197 {
 198    // already in mirror:// style so nothing to do
 199    if(Queue->Uri.find("mirror://") == 0)
 200       return;
 201
 202    // find current mirror and select next one
 203    for (vector<string>::const_iterator mirror = AllMirrors.begin();
 204         mirror != AllMirrors.end(); ++mirror)
 205    {
 206       if (Queue->Uri.find(*mirror) == 0)
 207       {
 208          Queue->Uri.replace(0, mirror->length(), BaseUri);
 209          return;
 210       }
 211    }
 212    _error->Error("Internal error: Failed to convert %s back to %s",
 213                  Queue->Uri.c_str(), BaseUri.c_str());
 214 }
 215
 216 bool MirrorMethod::TryNextMirror()
 217 {
 218    // find current mirror and select next one
 219    for (vector<string>::const_iterator mirror = AllMirrors.begin();
 220         mirror != AllMirrors.end(); ++mirror)
 221    {
 222       if (Queue->Uri.find(*mirror) != 0)
 223          continue;
 224
 225       vector<string>::const_iterator nextmirror = mirror + 1;
 226       if (nextmirror == AllMirrors.end())
 227          break;
 228       Queue->Uri.replace(0, mirror->length(), *nextmirror);
 229       if (Debug)
 230          clog << "TryNextMirror: " << Queue->Uri << endl;
 231
 232       // inform parent
 233       UsedMirror = *nextmirror;
 234       Log("Switching mirror");
 235       return true;
 236    }
 237
 238    if (Debug)
 239       clog << "TryNextMirror could not find another mirror to try" << endl;
 240
 241    return false;
 242 }
 243
 244 bool MirrorMethod::InitMirrors()
 245 {
 246    // if we do not have a MirrorFile, fallback
 247    if(!FileExists(MirrorFile))
 248    {
 249       // FIXME: fallback to a default mirror here instead
 250       //        and provide a config option to define that default
 251       return _error->Error(_("No mirror file '%s' found "), MirrorFile.c_str());
 252    }
 253
 254    // FIXME: make the mirror selection more clever, do not
 255    //        just use the first one!
 256    // BUT: we can not make this random, the mirror has to be
 257    //      stable accross session, because otherwise we can
 258    //      get into sync issues (got indexfiles from mirror A,
 259    //      but packages from mirror B - one might be out of date etc)
 260    ifstream in(MirrorFile.c_str());
 261    string s;
 262    while (!in.eof())
 263    {
 264       getline(in, s);
 265       if (s.size() > 0)
 266          AllMirrors.push_back(s);
 267    }
 268    Mirror = AllMirrors[0];
 269    UsedMirror = Mirror;
 270    return true;
 271 }
 272
 273 string MirrorMethod::GetMirrorFileName(string mirror_uri_str)
 274 {
 275    /*
 276     - a mirror_uri_str looks like this:
 277     mirror://people.ubuntu.com/~mvo/apt/mirror/mirrors/dists/feisty/Release.gpg
 278
 279     - the matching source.list entry
 280     deb mirror://people.ubuntu.com/~mvo/apt/mirror/mirrors feisty main
 281
 282     - we actually want to go after:
 283     http://people.ubuntu.com/~mvo/apt/mirror/mirrors
 284
 285     And we need to save the BaseUri for later:
 286     - mirror://people.ubuntu.com/~mvo/apt/mirror/mirrors
 287
 288    FIXME: what if we have two similar prefixes?
 289      mirror://people.ubuntu.com/~mvo/mirror
 290      mirror://people.ubuntu.com/~mvo/mirror2
 291    then mirror_uri_str looks like:
 292      mirror://people.ubuntu.com/~mvo/apt/mirror/dists/feisty/Release.gpg
 293      mirror://people.ubuntu.com/~mvo/apt/mirror2/dists/feisty/Release.gpg
 294    we search sources.list and find:
 295      mirror://people.ubuntu.com/~mvo/apt/mirror
 296    in both cases! So we need to apply some domain knowledge here :( and
 297    check for /dists/ or /Release.gpg as suffixes
 298    */
 299    string name;
 300    if(Debug)
 301       std::cerr << "GetMirrorFileName: " << mirror_uri_str << std::endl;
 302
 303    // read sources.list and find match
 304    vector<metaIndex *>::const_iterator I;
 305    pkgSourceList list;
 306    list.ReadMainList();
 307    for(I=list.begin(); I != list.end(); I++)
 308    {
 309       string uristr = (*I)->GetURI();
 310       if(Debug)
 311          std::cerr << "Checking: " << uristr << std::endl;
 312       if(uristr.substr(0,strlen("mirror://")) != string("mirror://"))
 313          continue;
 314       // find matching uri in sources.list
 315       if(mirror_uri_str.substr(0,uristr.size()) == uristr)
 316       {
 317          if(Debug)
 318             std::cerr << "found BaseURI: " << uristr << std::endl;
 319          BaseUri = uristr.substr(0,uristr.size()-1);
 320       }
 321    }
 322    // get new file
 323    name = _config->FindDir("Dir::State::mirrors") + URItoFileName(BaseUri);
 324
 325    if(Debug)
 326    {
 327       cerr << "base-uri: " << BaseUri << endl;
 328       cerr << "mirror-file: " << name << endl;
 329    }
 330    return name;
 331 }
 332
 333 // MirrorMethod::Fetch - Fetch an item                                  /*{{{*/
 334 // ---------------------------------------------------------------------
 335 /* This adds an item to the pipeline. We keep the pipeline at a fixed
 336    depth. */
 337 bool MirrorMethod::Fetch(FetchItem *Itm)
 338 {
 339    if(Debug)
 340       clog << "MirrorMethod::Fetch()" << endl;
 341
 342    // the http method uses Fetch(0) as a way to update the pipeline,
 343    // just let it do its work in this case - Fetch() with a valid
 344    // Itm will always run before the first Fetch(0)
 345    if(Itm == NULL)
 346       return HttpMethod::Fetch(Itm);
 347
 348    // if we don't have the name of the mirror file on disk yet,
 349    // calculate it now (can be derived from the uri)
 350    if(MirrorFile.empty())
 351       MirrorFile = GetMirrorFileName(Itm->Uri);
 352
 353   // download mirror file once (if we are after index files)
 354    if(Itm->IndexFile && !DownloadedMirrorFile)
 355    {
 356       Clean(_config->FindDir("Dir::State::mirrors"));
 357       DownloadMirrorFile(Itm->Uri);
 358       RandomizeMirrorFile(MirrorFile);
 359    }
 360
 361    if(AllMirrors.empty()) {
 362       if(!InitMirrors()) {
 363          // no valid mirror selected, something went wrong downloading
 364          // from the master mirror site most likely and there is
 365          // no old mirror file availalbe
 366          return false;
 367       }
 368    }
 369
 370    if(Itm->Uri.find("mirror://") != string::npos)
 371       Itm->Uri.replace(0,BaseUri.size(), Mirror);
 372
 373    if(Debug)
 374       clog << "Fetch: " << Itm->Uri << endl << endl;
 375
 376    // now run the real fetcher
 377    return HttpMethod::Fetch(Itm);
 378 };
 379
 380 void MirrorMethod::Fail(string Err,bool Transient)
 381 {
 382    // FIXME: TryNextMirror is not ideal for indexfile as we may
 383    //        run into auth issues
 384
 385    if (Debug)
 386       clog << "Failure to get " << Queue->Uri << endl;
 387
 388    // try the next mirror on fail (if its not a expected failure,
 389    // e.g. translations are ok to ignore)
 390    if (!Queue->FailIgnore && TryNextMirror())
 391       return;
 392
 393    // all mirrors failed, so bail out
 394    string s;
 395    strprintf(s, _("[Mirror: %s]"), Mirror.c_str());
 396    SetIP(s);
 397
 398    CurrentQueueUriToMirror();
 399    pkgAcqMethod::Fail(Err, Transient);
 400 }
 401
 402 void MirrorMethod::URIStart(FetchResult &Res)
 403 {
 404    CurrentQueueUriToMirror();
 405    pkgAcqMethod::URIStart(Res);
 406 }
 407
 408 void MirrorMethod::URIDone(FetchResult &Res,FetchResult *Alt)
 409 {
 410    CurrentQueueUriToMirror();
 411    pkgAcqMethod::URIDone(Res, Alt);
 412 }
 413
 414
 415 int main()
 416 {
 417    setlocale(LC_ALL, "");
 418
 419    MirrorMethod Mth;
 420
 421    return Mth.Loop();
 422 }
 423
 424