]> git.saurik.com Git - apt.git/blame - apt-pkg/acquire.cc
deal better with acquiring the same URI multiple times
[apt.git] / apt-pkg / acquire.cc
CommitLineData
0118833a
AL
1// -*- mode: cpp; mode: fold -*-
2// Description /*{{{*/
1b480911 3// $Id: acquire.cc,v 1.50 2004/03/17 05:17:11 mdz Exp $
0118833a
AL
4/* ######################################################################
5
6 Acquire - File Acquiration
7
1e3f4083 8 The core element for the schedule system is the concept of a named
0a8a80e5 9 queue. Each queue is unique and each queue has a name derived from the
1e3f4083 10 URI. The degree of paralization can be controlled by how the queue
0a8a80e5
AL
11 name is derived from the URI.
12
0118833a
AL
13 ##################################################################### */
14 /*}}}*/
15// Include Files /*{{{*/
ea542140
DK
16#include <config.h>
17
0118833a
AL
18#include <apt-pkg/acquire.h>
19#include <apt-pkg/acquire-item.h>
20#include <apt-pkg/acquire-worker.h>
0a8a80e5
AL
21#include <apt-pkg/configuration.h>
22#include <apt-pkg/error.h>
cdcc6d34 23#include <apt-pkg/strutl.h>
1cd1c398 24#include <apt-pkg/fileutl.h>
8267fe24 25
08ea7806 26#include <algorithm>
453b82a3
DK
27#include <string>
28#include <vector>
b4fc9b6f 29#include <iostream>
75ef8f14 30#include <sstream>
04a54261
DK
31#include <iomanip>
32
526334a0 33#include <stdio.h>
453b82a3
DK
34#include <stdlib.h>
35#include <string.h>
36#include <unistd.h>
04a54261
DK
37#include <pwd.h>
38#include <grp.h>
7a7fa5f0 39#include <dirent.h>
8267fe24 40#include <sys/time.h>
453b82a3 41#include <sys/select.h>
524f8105 42#include <errno.h>
56472095 43#include <sys/stat.h>
04a54261 44#include <sys/types.h>
ea542140
DK
45
46#include <apti18n.h>
0118833a
AL
47 /*}}}*/
48
b4fc9b6f
AL
49using namespace std;
50
0118833a
AL
51// Acquire::pkgAcquire - Constructor /*{{{*/
52// ---------------------------------------------------------------------
93bf083d 53/* We grab some runtime state from the configuration space */
5efbd596 54pkgAcquire::pkgAcquire() : LockFD(-1), Queues(0), Workers(0), Configs(0), Log(NULL), ToFetch(0),
1cd1c398 55 Debug(_config->FindB("Debug::pkgAcquire",false)),
5efbd596 56 Running(false)
0118833a 57{
03aa0847 58 Initialize();
1cd1c398 59}
04a54261
DK
60pkgAcquire::pkgAcquire(pkgAcquireStatus *Progress) : LockFD(-1), Queues(0), Workers(0),
61 Configs(0), Log(NULL), ToFetch(0),
1cd1c398 62 Debug(_config->FindB("Debug::pkgAcquire",false)),
5efbd596 63 Running(false)
03aa0847
DK
64{
65 Initialize();
66 SetLog(Progress);
67}
68void pkgAcquire::Initialize()
1cd1c398
DK
69{
70 string const Mode = _config->Find("Acquire::Queue-Mode","host");
71 if (strcasecmp(Mode.c_str(),"host") == 0)
72 QueueMode = QueueHost;
73 if (strcasecmp(Mode.c_str(),"access") == 0)
74 QueueMode = QueueAccess;
03aa0847
DK
75
76 // chown the auth.conf file as it will be accessed by our methods
77 std::string const SandboxUser = _config->Find("APT::Sandbox::User");
78 if (getuid() == 0 && SandboxUser.empty() == false) // if we aren't root, we can't chown, so don't try it
79 {
80 struct passwd const * const pw = getpwnam(SandboxUser.c_str());
81 struct group const * const gr = getgrnam("root");
82 if (pw != NULL && gr != NULL)
83 {
84 std::string const AuthConf = _config->FindFile("Dir::Etc::netrc");
85 if(AuthConf.empty() == false && RealFileExists(AuthConf) &&
86 chown(AuthConf.c_str(), pw->pw_uid, gr->gr_gid) != 0)
87 _error->WarningE("SetupAPTPartialDirectory", "chown to %s:root of file %s failed", SandboxUser.c_str(), AuthConf.c_str());
88 }
89 }
1cd1c398
DK
90}
91 /*}}}*/
04a54261
DK
92// Acquire::GetLock - lock directory and prepare for action /*{{{*/
93static bool SetupAPTPartialDirectory(std::string const &grand, std::string const &parent)
1cd1c398 94{
04a54261 95 std::string const partial = parent + "partial";
8fe964f1
DK
96 mode_t const mode = umask(S_IWGRP | S_IWOTH);
97 bool const creation_fail = (CreateAPTDirectoryIfNeeded(grand, partial) == false &&
98 CreateAPTDirectoryIfNeeded(parent, partial) == false);
99 umask(mode);
100 if (creation_fail == true)
04a54261 101 return false;
0a8a80e5 102
03aa0847
DK
103 std::string const SandboxUser = _config->Find("APT::Sandbox::User");
104 if (getuid() == 0 && SandboxUser.empty() == false) // if we aren't root, we can't chown, so don't try it
04a54261 105 {
03aa0847
DK
106 struct passwd const * const pw = getpwnam(SandboxUser.c_str());
107 struct group const * const gr = getgrnam("root");
1924b1e5
MV
108 if (pw != NULL && gr != NULL)
109 {
110 // chown the partial dir
111 if(chown(partial.c_str(), pw->pw_uid, gr->gr_gid) != 0)
112 _error->WarningE("SetupAPTPartialDirectory", "chown to %s:root of directory %s failed", SandboxUser.c_str(), partial.c_str());
1924b1e5 113 }
04a54261
DK
114 }
115 if (chmod(partial.c_str(), 0700) != 0)
116 _error->WarningE("SetupAPTPartialDirectory", "chmod 0700 of directory %s failed", partial.c_str());
117
118 return true;
119}
120bool pkgAcquire::Setup(pkgAcquireStatus *Progress, string const &Lock)
121{
122 Log = Progress;
123 if (Lock.empty())
43acd019
DK
124 {
125 string const listDir = _config->FindDir("Dir::State::lists");
04a54261
DK
126 if (SetupAPTPartialDirectory(_config->FindDir("Dir::State"), listDir) == false)
127 return _error->Errno("Acquire", _("List directory %spartial is missing."), listDir.c_str());
43acd019 128 string const archivesDir = _config->FindDir("Dir::Cache::Archives");
04a54261
DK
129 if (SetupAPTPartialDirectory(_config->FindDir("Dir::Cache"), archivesDir) == false)
130 return _error->Errno("Acquire", _("Archives directory %spartial is missing."), archivesDir.c_str());
131 return true;
132 }
133 return GetLock(Lock);
134}
135bool pkgAcquire::GetLock(std::string const &Lock)
136{
137 if (Lock.empty() == true)
138 return false;
9c2c9c24 139
04a54261
DK
140 // check for existence and possibly create auxiliary directories
141 string const listDir = _config->FindDir("Dir::State::lists");
142 string const archivesDir = _config->FindDir("Dir::Cache::Archives");
9c2c9c24 143
04a54261
DK
144 if (Lock == listDir)
145 {
146 if (SetupAPTPartialDirectory(_config->FindDir("Dir::State"), listDir) == false)
147 return _error->Errno("Acquire", _("List directory %spartial is missing."), listDir.c_str());
148 }
149 if (Lock == archivesDir)
150 {
151 if (SetupAPTPartialDirectory(_config->FindDir("Dir::Cache"), archivesDir) == false)
43acd019
DK
152 return _error->Errno("Acquire", _("Archives directory %spartial is missing."), archivesDir.c_str());
153 }
1cd1c398 154
04a54261 155 if (_config->FindB("Debug::NoLocking", false) == true)
1cd1c398
DK
156 return true;
157
158 // Lock the directory this acquire object will work in
7e04a6bf
DK
159 if (LockFD != -1)
160 close(LockFD);
04a54261 161 LockFD = ::GetLock(flCombine(Lock, "lock"));
1cd1c398
DK
162 if (LockFD == -1)
163 return _error->Error(_("Unable to lock directory %s"), Lock.c_str());
164
165 return true;
166}
167 /*}}}*/
0118833a
AL
168// Acquire::~pkgAcquire - Destructor /*{{{*/
169// ---------------------------------------------------------------------
93bf083d 170/* Free our memory, clean up the queues (destroy the workers) */
0118833a
AL
171pkgAcquire::~pkgAcquire()
172{
459681d3 173 Shutdown();
1cd1c398
DK
174
175 if (LockFD != -1)
176 close(LockFD);
177
3b5421b4
AL
178 while (Configs != 0)
179 {
180 MethodConfig *Jnk = Configs;
181 Configs = Configs->Next;
182 delete Jnk;
183 }
281daf46
AL
184}
185 /*}}}*/
8e5fc8f5 186// Acquire::Shutdown - Clean out the acquire object /*{{{*/
281daf46
AL
187// ---------------------------------------------------------------------
188/* */
189void pkgAcquire::Shutdown()
190{
f7f0d6c7 191 while (Items.empty() == false)
1b480911
AL
192 {
193 if (Items[0]->Status == Item::StatFetching)
194 Items[0]->Status = Item::StatError;
281daf46 195 delete Items[0];
1b480911 196 }
0a8a80e5
AL
197
198 while (Queues != 0)
199 {
200 Queue *Jnk = Queues;
201 Queues = Queues->Next;
202 delete Jnk;
203 }
0118833a
AL
204}
205 /*}}}*/
206// Acquire::Add - Add a new item /*{{{*/
207// ---------------------------------------------------------------------
93bf083d
AL
208/* This puts an item on the acquire list. This list is mainly for tracking
209 item status */
0118833a
AL
210void pkgAcquire::Add(Item *Itm)
211{
212 Items.push_back(Itm);
213}
214 /*}}}*/
215// Acquire::Remove - Remove a item /*{{{*/
216// ---------------------------------------------------------------------
93bf083d 217/* Remove an item from the acquire list. This is usually not used.. */
0118833a
AL
218void pkgAcquire::Remove(Item *Itm)
219{
a3eaf954
AL
220 Dequeue(Itm);
221
753b3525 222 for (ItemIterator I = Items.begin(); I != Items.end();)
0118833a
AL
223 {
224 if (*I == Itm)
b4fc9b6f 225 {
0118833a 226 Items.erase(I);
b4fc9b6f
AL
227 I = Items.begin();
228 }
753b3525 229 else
f7f0d6c7 230 ++I;
8267fe24 231 }
0118833a
AL
232}
233 /*}}}*/
0a8a80e5
AL
234// Acquire::Add - Add a worker /*{{{*/
235// ---------------------------------------------------------------------
93bf083d
AL
236/* A list of workers is kept so that the select loop can direct their FD
237 usage. */
0a8a80e5
AL
238void pkgAcquire::Add(Worker *Work)
239{
240 Work->NextAcquire = Workers;
241 Workers = Work;
242}
243 /*}}}*/
244// Acquire::Remove - Remove a worker /*{{{*/
245// ---------------------------------------------------------------------
93bf083d
AL
246/* A worker has died. This can not be done while the select loop is running
247 as it would require that RunFds could handling a changing list state and
1e3f4083 248 it can't.. */
0a8a80e5
AL
249void pkgAcquire::Remove(Worker *Work)
250{
93bf083d
AL
251 if (Running == true)
252 abort();
253
0a8a80e5
AL
254 Worker **I = &Workers;
255 for (; *I != 0;)
256 {
257 if (*I == Work)
258 *I = (*I)->NextAcquire;
259 else
260 I = &(*I)->NextAcquire;
261 }
262}
263 /*}}}*/
0118833a
AL
264// Acquire::Enqueue - Queue an URI for fetching /*{{{*/
265// ---------------------------------------------------------------------
93bf083d 266/* This is the entry point for an item. An item calls this function when
281daf46 267 it is constructed which creates a queue (based on the current queue
93bf083d
AL
268 mode) and puts the item in that queue. If the system is running then
269 the queue might be started. */
8267fe24 270void pkgAcquire::Enqueue(ItemDesc &Item)
0118833a 271{
0a8a80e5 272 // Determine which queue to put the item in
e331f6ed
AL
273 const MethodConfig *Config;
274 string Name = QueueName(Item.URI,Config);
0a8a80e5
AL
275 if (Name.empty() == true)
276 return;
277
278 // Find the queue structure
279 Queue *I = Queues;
280 for (; I != 0 && I->Name != Name; I = I->Next);
281 if (I == 0)
282 {
283 I = new Queue(Name,this);
284 I->Next = Queues;
285 Queues = I;
93bf083d
AL
286
287 if (Running == true)
288 I->Startup();
0a8a80e5 289 }
bfd22fc0 290
e331f6ed
AL
291 // See if this is a local only URI
292 if (Config->LocalOnly == true && Item.Owner->Complete == false)
293 Item.Owner->Local = true;
8267fe24 294 Item.Owner->Status = Item::StatIdle;
0a8a80e5
AL
295
296 // Queue it into the named queue
c03462c6
MV
297 if(I->Enqueue(Item))
298 ToFetch++;
299
0a8a80e5
AL
300 // Some trace stuff
301 if (Debug == true)
302 {
8267fe24
AL
303 clog << "Fetching " << Item.URI << endl;
304 clog << " to " << Item.Owner->DestFile << endl;
e331f6ed 305 clog << " Queue is: " << Name << endl;
0a8a80e5 306 }
3b5421b4
AL
307}
308 /*}}}*/
0a8a80e5 309// Acquire::Dequeue - Remove an item from all queues /*{{{*/
3b5421b4 310// ---------------------------------------------------------------------
93bf083d
AL
311/* This is called when an item is finished being fetched. It removes it
312 from all the queues */
0a8a80e5
AL
313void pkgAcquire::Dequeue(Item *Itm)
314{
315 Queue *I = Queues;
bfd22fc0 316 bool Res = false;
93bf083d
AL
317 if (Debug == true)
318 clog << "Dequeuing " << Itm->DestFile << endl;
5674f6b3
RG
319
320 for (; I != 0; I = I->Next)
321 {
322 if (I->Dequeue(Itm))
323 {
324 Res = true;
325 if (Debug == true)
326 clog << "Dequeued from " << I->Name << endl;
327 }
328 }
329
bfd22fc0
AL
330 if (Res == true)
331 ToFetch--;
0a8a80e5
AL
332}
333 /*}}}*/
334// Acquire::QueueName - Return the name of the queue for this URI /*{{{*/
335// ---------------------------------------------------------------------
336/* The string returned depends on the configuration settings and the
337 method parameters. Given something like http://foo.org/bar it can
338 return http://foo.org or http */
e331f6ed 339string pkgAcquire::QueueName(string Uri,MethodConfig const *&Config)
3b5421b4 340{
93bf083d
AL
341 URI U(Uri);
342
e331f6ed 343 Config = GetConfig(U.Access);
0a8a80e5
AL
344 if (Config == 0)
345 return string();
346
347 /* Single-Instance methods get exactly one queue per URI. This is
348 also used for the Access queue method */
349 if (Config->SingleInstance == true || QueueMode == QueueAccess)
5674f6b3
RG
350 return U.Access;
351
352 string AccessSchema = U.Access + ':',
353 FullQueueName = AccessSchema + U.Host;
354 unsigned int Instances = 0, SchemaLength = AccessSchema.length();
355
356 Queue *I = Queues;
357 for (; I != 0; I = I->Next) {
358 // if the queue already exists, re-use it
359 if (I->Name == FullQueueName)
360 return FullQueueName;
361
362 if (I->Name.compare(0, SchemaLength, AccessSchema) == 0)
363 Instances++;
364 }
365
366 if (Debug) {
367 clog << "Found " << Instances << " instances of " << U.Access << endl;
368 }
369
370 if (Instances >= (unsigned int)_config->FindI("Acquire::QueueHost::Limit",10))
371 return U.Access;
93bf083d 372
5674f6b3 373 return FullQueueName;
0118833a
AL
374}
375 /*}}}*/
3b5421b4
AL
376// Acquire::GetConfig - Fetch the configuration information /*{{{*/
377// ---------------------------------------------------------------------
378/* This locates the configuration structure for an access method. If
379 a config structure cannot be found a Worker will be created to
380 retrieve it */
0a8a80e5 381pkgAcquire::MethodConfig *pkgAcquire::GetConfig(string Access)
3b5421b4
AL
382{
383 // Search for an existing config
384 MethodConfig *Conf;
385 for (Conf = Configs; Conf != 0; Conf = Conf->Next)
386 if (Conf->Access == Access)
387 return Conf;
388
389 // Create the new config class
390 Conf = new MethodConfig;
391 Conf->Access = Access;
392 Conf->Next = Configs;
393 Configs = Conf;
0118833a 394
3b5421b4
AL
395 // Create the worker to fetch the configuration
396 Worker Work(Conf);
397 if (Work.Start() == false)
398 return 0;
7c6e2dc7
MV
399
400 /* if a method uses DownloadLimit, we switch to SingleInstance mode */
4b65cc13 401 if(_config->FindI("Acquire::"+Access+"::Dl-Limit",0) > 0)
7c6e2dc7
MV
402 Conf->SingleInstance = true;
403
3b5421b4
AL
404 return Conf;
405}
406 /*}}}*/
0a8a80e5
AL
407// Acquire::SetFds - Deal with readable FDs /*{{{*/
408// ---------------------------------------------------------------------
409/* Collect FDs that have activity monitors into the fd sets */
410void pkgAcquire::SetFds(int &Fd,fd_set *RSet,fd_set *WSet)
411{
412 for (Worker *I = Workers; I != 0; I = I->NextAcquire)
413 {
414 if (I->InReady == true && I->InFd >= 0)
415 {
416 if (Fd < I->InFd)
417 Fd = I->InFd;
418 FD_SET(I->InFd,RSet);
419 }
420 if (I->OutReady == true && I->OutFd >= 0)
421 {
422 if (Fd < I->OutFd)
423 Fd = I->OutFd;
424 FD_SET(I->OutFd,WSet);
425 }
426 }
427}
428 /*}}}*/
429// Acquire::RunFds - Deal with active FDs /*{{{*/
430// ---------------------------------------------------------------------
93bf083d
AL
431/* Dispatch active FDs over to the proper workers. It is very important
432 that a worker never be erased while this is running! The queue class
433 should never erase a worker except during shutdown processing. */
0a8a80e5
AL
434void pkgAcquire::RunFds(fd_set *RSet,fd_set *WSet)
435{
436 for (Worker *I = Workers; I != 0; I = I->NextAcquire)
437 {
438 if (I->InFd >= 0 && FD_ISSET(I->InFd,RSet) != 0)
439 I->InFdReady();
440 if (I->OutFd >= 0 && FD_ISSET(I->OutFd,WSet) != 0)
441 I->OutFdReady();
442 }
443}
444 /*}}}*/
445// Acquire::Run - Run the fetch sequence /*{{{*/
446// ---------------------------------------------------------------------
447/* This runs the queues. It manages a select loop for all of the
448 Worker tasks. The workers interact with the queues and items to
449 manage the actual fetch. */
1c5f7e5f 450pkgAcquire::RunResult pkgAcquire::Run(int PulseIntervall)
0a8a80e5 451{
8b89e57f
AL
452 Running = true;
453
0a8a80e5
AL
454 for (Queue *I = Queues; I != 0; I = I->Next)
455 I->Startup();
456
b98f2859
AL
457 if (Log != 0)
458 Log->Start();
459
024d1123
AL
460 bool WasCancelled = false;
461
0a8a80e5 462 // Run till all things have been acquired
8267fe24
AL
463 struct timeval tv;
464 tv.tv_sec = 0;
1c5f7e5f 465 tv.tv_usec = PulseIntervall;
0a8a80e5
AL
466 while (ToFetch > 0)
467 {
468 fd_set RFds;
469 fd_set WFds;
470 int Highest = 0;
471 FD_ZERO(&RFds);
472 FD_ZERO(&WFds);
473 SetFds(Highest,&RFds,&WFds);
474
b0db36b1
AL
475 int Res;
476 do
477 {
478 Res = select(Highest+1,&RFds,&WFds,0,&tv);
479 }
480 while (Res < 0 && errno == EINTR);
481
8267fe24 482 if (Res < 0)
8b89e57f 483 {
8267fe24
AL
484 _error->Errno("select","Select has failed");
485 break;
8b89e57f 486 }
93bf083d 487
0a8a80e5 488 RunFds(&RFds,&WFds);
93bf083d
AL
489 if (_error->PendingError() == true)
490 break;
8267fe24
AL
491
492 // Timeout, notify the log class
493 if (Res == 0 || (Log != 0 && Log->Update == true))
494 {
1c5f7e5f 495 tv.tv_usec = PulseIntervall;
8267fe24
AL
496 for (Worker *I = Workers; I != 0; I = I->NextAcquire)
497 I->Pulse();
024d1123
AL
498 if (Log != 0 && Log->Pulse(this) == false)
499 {
500 WasCancelled = true;
501 break;
502 }
8267fe24 503 }
0a8a80e5 504 }
be4401bf 505
b98f2859
AL
506 if (Log != 0)
507 Log->Stop();
508
be4401bf
AL
509 // Shut down the acquire bits
510 Running = false;
0a8a80e5 511 for (Queue *I = Queues; I != 0; I = I->Next)
8e5fc8f5 512 I->Shutdown(false);
0a8a80e5 513
ab559b35 514 // Shut down the items
f7f0d6c7 515 for (ItemIterator I = Items.begin(); I != Items.end(); ++I)
8e5fc8f5 516 (*I)->Finished();
ab559b35 517
024d1123
AL
518 if (_error->PendingError())
519 return Failed;
520 if (WasCancelled)
521 return Cancelled;
522 return Continue;
93bf083d
AL
523}
524 /*}}}*/
be4401bf 525// Acquire::Bump - Called when an item is dequeued /*{{{*/
93bf083d
AL
526// ---------------------------------------------------------------------
527/* This routine bumps idle queues in hopes that they will be able to fetch
528 the dequeued item */
529void pkgAcquire::Bump()
530{
be4401bf
AL
531 for (Queue *I = Queues; I != 0; I = I->Next)
532 I->Bump();
0a8a80e5
AL
533}
534 /*}}}*/
8267fe24
AL
535// Acquire::WorkerStep - Step to the next worker /*{{{*/
536// ---------------------------------------------------------------------
537/* Not inlined to advoid including acquire-worker.h */
538pkgAcquire::Worker *pkgAcquire::WorkerStep(Worker *I)
539{
540 return I->NextAcquire;
d3e8fbb3 541}
8267fe24 542 /*}}}*/
a6568219 543// Acquire::Clean - Cleans a directory /*{{{*/
7a7fa5f0
AL
544// ---------------------------------------------------------------------
545/* This is a bit simplistic, it looks at every file in the dir and sees
546 if it is part of the download set. */
547bool pkgAcquire::Clean(string Dir)
548{
95b5f6c1
DK
549 // non-existing directories are by definition clean…
550 if (DirectoryExists(Dir) == false)
551 return true;
552
10ecfe4f
MV
553 if(Dir == "/")
554 return _error->Error(_("Clean of %s is not supported"), Dir.c_str());
555
7a7fa5f0
AL
556 DIR *D = opendir(Dir.c_str());
557 if (D == 0)
b2e465d6 558 return _error->Errno("opendir",_("Unable to read %s"),Dir.c_str());
7a7fa5f0
AL
559
560 string StartDir = SafeGetCWD();
561 if (chdir(Dir.c_str()) != 0)
562 {
563 closedir(D);
b2e465d6 564 return _error->Errno("chdir",_("Unable to change to %s"),Dir.c_str());
7a7fa5f0
AL
565 }
566
567 for (struct dirent *Dir = readdir(D); Dir != 0; Dir = readdir(D))
568 {
569 // Skip some files..
570 if (strcmp(Dir->d_name,"lock") == 0 ||
571 strcmp(Dir->d_name,"partial") == 0 ||
572 strcmp(Dir->d_name,".") == 0 ||
573 strcmp(Dir->d_name,"..") == 0)
574 continue;
575
576 // Look in the get list
b4fc9b6f 577 ItemCIterator I = Items.begin();
f7f0d6c7 578 for (; I != Items.end(); ++I)
7a7fa5f0
AL
579 if (flNotDir((*I)->DestFile) == Dir->d_name)
580 break;
581
582 // Nothing found, nuke it
583 if (I == Items.end())
584 unlink(Dir->d_name);
585 };
586
7a7fa5f0 587 closedir(D);
3c8cda8b
MV
588 if (chdir(StartDir.c_str()) != 0)
589 return _error->Errno("chdir",_("Unable to change to %s"),StartDir.c_str());
7a7fa5f0
AL
590 return true;
591}
592 /*}}}*/
a6568219
AL
593// Acquire::TotalNeeded - Number of bytes to fetch /*{{{*/
594// ---------------------------------------------------------------------
595/* This is the total number of bytes needed */
a02db58f 596APT_PURE unsigned long long pkgAcquire::TotalNeeded()
a6568219 597{
a3c4c81a 598 unsigned long long Total = 0;
f7f0d6c7 599 for (ItemCIterator I = ItemsBegin(); I != ItemsEnd(); ++I)
a6568219
AL
600 Total += (*I)->FileSize;
601 return Total;
602}
603 /*}}}*/
604// Acquire::FetchNeeded - Number of bytes needed to get /*{{{*/
605// ---------------------------------------------------------------------
606/* This is the number of bytes that is not local */
a02db58f 607APT_PURE unsigned long long pkgAcquire::FetchNeeded()
a6568219 608{
a3c4c81a 609 unsigned long long Total = 0;
f7f0d6c7 610 for (ItemCIterator I = ItemsBegin(); I != ItemsEnd(); ++I)
a6568219
AL
611 if ((*I)->Local == false)
612 Total += (*I)->FileSize;
613 return Total;
614}
615 /*}}}*/
6b1ff003
AL
616// Acquire::PartialPresent - Number of partial bytes we already have /*{{{*/
617// ---------------------------------------------------------------------
618/* This is the number of bytes that is not local */
a02db58f 619APT_PURE unsigned long long pkgAcquire::PartialPresent()
6b1ff003 620{
a3c4c81a 621 unsigned long long Total = 0;
f7f0d6c7 622 for (ItemCIterator I = ItemsBegin(); I != ItemsEnd(); ++I)
6b1ff003
AL
623 if ((*I)->Local == false)
624 Total += (*I)->PartialSize;
625 return Total;
626}
92fcbfc1 627 /*}}}*/
8e5fc8f5 628// Acquire::UriBegin - Start iterator for the uri list /*{{{*/
f7a08e33
AL
629// ---------------------------------------------------------------------
630/* */
631pkgAcquire::UriIterator pkgAcquire::UriBegin()
632{
633 return UriIterator(Queues);
634}
635 /*}}}*/
8e5fc8f5 636// Acquire::UriEnd - End iterator for the uri list /*{{{*/
f7a08e33
AL
637// ---------------------------------------------------------------------
638/* */
639pkgAcquire::UriIterator pkgAcquire::UriEnd()
640{
641 return UriIterator(0);
642}
643 /*}}}*/
e331f6ed
AL
644// Acquire::MethodConfig::MethodConfig - Constructor /*{{{*/
645// ---------------------------------------------------------------------
646/* */
25613a61
DK
647pkgAcquire::MethodConfig::MethodConfig() : d(NULL), Next(0), SingleInstance(false),
648 Pipeline(false), SendConfig(false), LocalOnly(false), NeedsCleanup(false),
649 Removable(false)
e331f6ed 650{
e331f6ed
AL
651}
652 /*}}}*/
0a8a80e5
AL
653// Queue::Queue - Constructor /*{{{*/
654// ---------------------------------------------------------------------
655/* */
25613a61
DK
656pkgAcquire::Queue::Queue(string Name,pkgAcquire *Owner) : d(NULL), Next(0),
657 Name(Name), Items(0), Workers(0), Owner(Owner), PipeDepth(0), MaxPipeDepth(1)
0a8a80e5 658{
0a8a80e5
AL
659}
660 /*}}}*/
661// Queue::~Queue - Destructor /*{{{*/
662// ---------------------------------------------------------------------
663/* */
664pkgAcquire::Queue::~Queue()
665{
8e5fc8f5 666 Shutdown(true);
0a8a80e5
AL
667
668 while (Items != 0)
669 {
670 QItem *Jnk = Items;
671 Items = Items->Next;
672 delete Jnk;
673 }
674}
675 /*}}}*/
676// Queue::Enqueue - Queue an item to the queue /*{{{*/
677// ---------------------------------------------------------------------
678/* */
c03462c6 679bool pkgAcquire::Queue::Enqueue(ItemDesc &Item)
0a8a80e5 680{
7a1b1f8b 681 QItem **I = &Items;
c03462c6
MV
682 // move to the end of the queue and check for duplicates here
683 for (; *I != 0; I = &(*I)->Next)
684 if (Item.URI == (*I)->URI)
685 {
08ea7806
DK
686 (*I)->Owners.push_back(Item.Owner);
687 Item.Owner->Status = (*I)->Owner->Status;
c03462c6
MV
688 return false;
689 }
690
0a8a80e5 691 // Create a new item
7a1b1f8b
AL
692 QItem *Itm = new QItem;
693 *Itm = Item;
694 Itm->Next = 0;
695 *I = Itm;
0a8a80e5 696
8267fe24 697 Item.Owner->QueueCounter++;
93bf083d
AL
698 if (Items->Next == 0)
699 Cycle();
c03462c6 700 return true;
0a8a80e5
AL
701}
702 /*}}}*/
c88edf1d 703// Queue::Dequeue - Remove an item from the queue /*{{{*/
0a8a80e5 704// ---------------------------------------------------------------------
b185acc2 705/* We return true if we hit something */
bfd22fc0 706bool pkgAcquire::Queue::Dequeue(Item *Owner)
0a8a80e5 707{
b185acc2
AL
708 if (Owner->Status == pkgAcquire::Item::StatFetching)
709 return _error->Error("Tried to dequeue a fetching object");
08ea7806 710
bfd22fc0 711 bool Res = false;
08ea7806 712
0a8a80e5
AL
713 QItem **I = &Items;
714 for (; *I != 0;)
715 {
08ea7806 716 if (Owner == (*I)->Owner)
0a8a80e5
AL
717 {
718 QItem *Jnk= *I;
719 *I = (*I)->Next;
720 Owner->QueueCounter--;
721 delete Jnk;
bfd22fc0 722 Res = true;
0a8a80e5
AL
723 }
724 else
725 I = &(*I)->Next;
726 }
08ea7806 727
bfd22fc0 728 return Res;
0a8a80e5
AL
729}
730 /*}}}*/
731// Queue::Startup - Start the worker processes /*{{{*/
732// ---------------------------------------------------------------------
8e5fc8f5
AL
733/* It is possible for this to be called with a pre-existing set of
734 workers. */
0a8a80e5
AL
735bool pkgAcquire::Queue::Startup()
736{
8e5fc8f5
AL
737 if (Workers == 0)
738 {
739 URI U(Name);
740 pkgAcquire::MethodConfig *Cnf = Owner->GetConfig(U.Access);
741 if (Cnf == 0)
742 return false;
743
744 Workers = new Worker(this,Cnf,Owner->Log);
745 Owner->Add(Workers);
746 if (Workers->Start() == false)
747 return false;
748
749 /* When pipelining we commit 10 items. This needs to change when we
750 added other source retry to have cycle maintain a pipeline depth
751 on its own. */
752 if (Cnf->Pipeline == true)
6ce72612 753 MaxPipeDepth = _config->FindI("Acquire::Max-Pipeline-Depth",10);
8e5fc8f5
AL
754 else
755 MaxPipeDepth = 1;
756 }
5cb5d8dc 757
93bf083d 758 return Cycle();
0a8a80e5
AL
759}
760 /*}}}*/
761// Queue::Shutdown - Shutdown the worker processes /*{{{*/
762// ---------------------------------------------------------------------
8e5fc8f5
AL
763/* If final is true then all workers are eliminated, otherwise only workers
764 that do not need cleanup are removed */
765bool pkgAcquire::Queue::Shutdown(bool Final)
0a8a80e5
AL
766{
767 // Delete all of the workers
8e5fc8f5
AL
768 pkgAcquire::Worker **Cur = &Workers;
769 while (*Cur != 0)
0a8a80e5 770 {
8e5fc8f5
AL
771 pkgAcquire::Worker *Jnk = *Cur;
772 if (Final == true || Jnk->GetConf()->NeedsCleanup == false)
773 {
774 *Cur = Jnk->NextQueue;
775 Owner->Remove(Jnk);
776 delete Jnk;
777 }
778 else
779 Cur = &(*Cur)->NextQueue;
0a8a80e5
AL
780 }
781
782 return true;
3b5421b4
AL
783}
784 /*}}}*/
7d8afa39 785// Queue::FindItem - Find a URI in the item list /*{{{*/
c88edf1d
AL
786// ---------------------------------------------------------------------
787/* */
788pkgAcquire::Queue::QItem *pkgAcquire::Queue::FindItem(string URI,pkgAcquire::Worker *Owner)
789{
790 for (QItem *I = Items; I != 0; I = I->Next)
791 if (I->URI == URI && I->Worker == Owner)
792 return I;
793 return 0;
794}
795 /*}}}*/
796// Queue::ItemDone - Item has been completed /*{{{*/
797// ---------------------------------------------------------------------
798/* The worker signals this which causes the item to be removed from the
93bf083d
AL
799 queue. If this is the last queue instance then it is removed from the
800 main queue too.*/
c88edf1d
AL
801bool pkgAcquire::Queue::ItemDone(QItem *Itm)
802{
b185acc2 803 PipeDepth--;
08ea7806
DK
804 for (QItem::owner_iterator O = Itm->Owners.begin(); O != Itm->Owners.end(); ++O)
805 {
806 if ((*O)->Status == pkgAcquire::Item::StatFetching)
807 (*O)->Status = pkgAcquire::Item::StatDone;
808 }
809
93bf083d
AL
810 if (Itm->Owner->QueueCounter <= 1)
811 Owner->Dequeue(Itm->Owner);
812 else
813 {
814 Dequeue(Itm->Owner);
815 Owner->Bump();
816 }
08ea7806 817
93bf083d
AL
818 return Cycle();
819}
820 /*}}}*/
821// Queue::Cycle - Queue new items into the method /*{{{*/
822// ---------------------------------------------------------------------
b185acc2
AL
823/* This locates a new idle item and sends it to the worker. If pipelining
824 is enabled then it keeps the pipe full. */
93bf083d
AL
825bool pkgAcquire::Queue::Cycle()
826{
827 if (Items == 0 || Workers == 0)
c88edf1d
AL
828 return true;
829
e7432370
AL
830 if (PipeDepth < 0)
831 return _error->Error("Pipedepth failure");
08ea7806 832
93bf083d
AL
833 // Look for a queable item
834 QItem *I = Items;
e7432370 835 while (PipeDepth < (signed)MaxPipeDepth)
b185acc2
AL
836 {
837 for (; I != 0; I = I->Next)
838 if (I->Owner->Status == pkgAcquire::Item::StatIdle)
839 break;
08ea7806 840
b185acc2
AL
841 // Nothing to do, queue is idle.
842 if (I == 0)
843 return true;
08ea7806 844
b185acc2 845 I->Worker = Workers;
08ea7806
DK
846 for (QItem::owner_iterator O = I->Owners.begin(); O != I->Owners.end(); ++O)
847 (*O)->Status = pkgAcquire::Item::StatFetching;
e7432370 848 PipeDepth++;
b185acc2
AL
849 if (Workers->QueueItem(I) == false)
850 return false;
851 }
08ea7806 852
b185acc2 853 return true;
c88edf1d
AL
854}
855 /*}}}*/
be4401bf
AL
856// Queue::Bump - Fetch any pending objects if we are idle /*{{{*/
857// ---------------------------------------------------------------------
b185acc2 858/* This is called when an item in multiple queues is dequeued */
be4401bf
AL
859void pkgAcquire::Queue::Bump()
860{
b185acc2 861 Cycle();
be4401bf
AL
862}
863 /*}}}*/
08ea7806
DK
864HashStringList pkgAcquire::Queue::QItem::GetExpectedHashes() const /*{{{*/
865{
866 /* each Item can have multiple owners and each owner might have different
867 hashes, even if that is unlikely in practice and if so at least some
868 owners will later fail. There is one situation through which is not a
869 failure and still needs this handling: Two owners who expect the same
870 file, but one owner only knows the SHA1 while the other only knows SHA256. */
871 HashStringList superhsl;
872 for (pkgAcquire::Queue::QItem::owner_iterator O = Owners.begin(); O != Owners.end(); ++O)
873 {
874 HashStringList const hsl = (*O)->GetExpectedHashes();
875 if (hsl.usable() == false)
876 continue;
877 if (superhsl.usable() == false)
878 superhsl = hsl;
879 else
880 {
881 // we merge both lists - if we find disagreement send no hashes
882 HashStringList::const_iterator hs = hsl.begin();
883 for (; hs != hsl.end(); ++hs)
884 if (superhsl.push_back(*hs) == false)
885 break;
886 if (hs != hsl.end())
887 {
888 superhsl.clear();
889 break;
890 }
891 }
892 }
893 return superhsl;
894}
895 /*}}}*/
896APT_PURE unsigned long long pkgAcquire::Queue::QItem::GetMaximumSize() const /*{{{*/
897{
898 unsigned long long Maximum = std::numeric_limits<unsigned long long>::max();
899 for (pkgAcquire::Queue::QItem::owner_iterator O = Owners.begin(); O != Owners.end(); ++O)
900 {
901 if ((*O)->FileSize == 0)
902 continue;
903 Maximum = std::min(Maximum, (*O)->FileSize);
904 }
905 if (Maximum == std::numeric_limits<unsigned long long>::max())
906 return 0;
907 return Maximum;
908}
909 /*}}}*/
910void pkgAcquire::Queue::QItem::SyncDestinationFiles() const /*{{{*/
911{
912 /* ensure that the first owner has the best partial file of all and
913 the rest have (potentially dangling) symlinks to it so that
914 everything (like progress reporting) finds it easily */
915 std::string superfile = Owner->DestFile;
916 off_t supersize = 0;
917 for (pkgAcquire::Queue::QItem::owner_iterator O = Owners.begin(); O != Owners.end(); ++O)
918 {
919 if ((*O)->DestFile == superfile)
920 continue;
921 struct stat file;
922 if (lstat((*O)->DestFile.c_str(),&file) == 0)
923 {
924 if ((file.st_mode & S_IFREG) == 0)
925 unlink((*O)->DestFile.c_str());
926 else if (supersize < file.st_size)
927 {
928 supersize = file.st_size;
929 unlink(superfile.c_str());
930 rename((*O)->DestFile.c_str(), superfile.c_str());
931 }
932 else
933 unlink((*O)->DestFile.c_str());
934 if (symlink(superfile.c_str(), (*O)->DestFile.c_str()) != 0)
935 {
936 ; // not a problem per-se and no real alternative
937 }
938 }
939 }
940}
941 /*}}}*/
942std::string pkgAcquire::Queue::QItem::Custom600Headers() const /*{{{*/
943{
944 /* The others are relatively easy to merge, but this one?
945 Lets not merge and see how far we can run with it…
946 Likely, nobody will ever notice as all the items will
947 be of the same class and hence generate the same headers. */
948 return Owner->Custom600Headers();
949}
950 /*}}}*/
951
b98f2859
AL
952// AcquireStatus::pkgAcquireStatus - Constructor /*{{{*/
953// ---------------------------------------------------------------------
954/* */
25613a61 955pkgAcquireStatus::pkgAcquireStatus() : d(NULL), Percent(0), Update(true), MorePulses(false)
b98f2859
AL
956{
957 Start();
958}
959 /*}}}*/
960// AcquireStatus::Pulse - Called periodically /*{{{*/
961// ---------------------------------------------------------------------
962/* This computes some internal state variables for the derived classes to
963 use. It generates the current downloaded bytes and total bytes to download
964 as well as the current CPS estimate. */
024d1123 965bool pkgAcquireStatus::Pulse(pkgAcquire *Owner)
b98f2859
AL
966{
967 TotalBytes = 0;
968 CurrentBytes = 0;
d568ed2d
AL
969 TotalItems = 0;
970 CurrentItems = 0;
b98f2859
AL
971
972 // Compute the total number of bytes to fetch
973 unsigned int Unknown = 0;
974 unsigned int Count = 0;
c6e9cc58
MV
975 bool UnfetchedReleaseFiles = false;
976 for (pkgAcquire::ItemCIterator I = Owner->ItemsBegin();
977 I != Owner->ItemsEnd();
f7f0d6c7 978 ++I, ++Count)
b98f2859 979 {
d568ed2d
AL
980 TotalItems++;
981 if ((*I)->Status == pkgAcquire::Item::StatDone)
f7f0d6c7 982 ++CurrentItems;
d568ed2d 983
a6568219
AL
984 // Totally ignore local items
985 if ((*I)->Local == true)
986 continue;
b2e465d6 987
d0cfa8ad
MV
988 // see if the method tells us to expect more
989 TotalItems += (*I)->ExpectedAdditionalItems;
990
c6e9cc58
MV
991 // check if there are unfetched Release files
992 if ((*I)->Complete == false && (*I)->ExpectedAdditionalItems > 0)
993 UnfetchedReleaseFiles = true;
994
b98f2859
AL
995 TotalBytes += (*I)->FileSize;
996 if ((*I)->Complete == true)
997 CurrentBytes += (*I)->FileSize;
998 if ((*I)->FileSize == 0 && (*I)->Complete == false)
f7f0d6c7 999 ++Unknown;
b98f2859
AL
1000 }
1001
1002 // Compute the current completion
dbbc5494 1003 unsigned long long ResumeSize = 0;
b98f2859
AL
1004 for (pkgAcquire::Worker *I = Owner->WorkersBegin(); I != 0;
1005 I = Owner->WorkerStep(I))
c62f7898 1006 {
b98f2859 1007 if (I->CurrentItem != 0 && I->CurrentItem->Owner->Complete == false)
aa0e1101
AL
1008 {
1009 CurrentBytes += I->CurrentSize;
1010 ResumeSize += I->ResumePoint;
08ea7806 1011
aa0e1101 1012 // Files with unknown size always have 100% completion
08ea7806 1013 if (I->CurrentItem->Owner->FileSize == 0 &&
aa0e1101
AL
1014 I->CurrentItem->Owner->Complete == false)
1015 TotalBytes += I->CurrentSize;
1016 }
c62f7898 1017 }
aa0e1101 1018
b98f2859
AL
1019 // Normalize the figures and account for unknown size downloads
1020 if (TotalBytes <= 0)
1021 TotalBytes = 1;
1022 if (Unknown == Count)
1023 TotalBytes = Unknown;
18ef0a78
AL
1024
1025 // Wha?! Is not supposed to happen.
1026 if (CurrentBytes > TotalBytes)
1027 CurrentBytes = TotalBytes;
96c6cab1
MV
1028
1029 // debug
1030 if (_config->FindB("Debug::acquire::progress", false) == true)
1031 std::clog << " Bytes: "
1032 << SizeToStr(CurrentBytes) << " / " << SizeToStr(TotalBytes)
1033 << std::endl;
b98f2859
AL
1034
1035 // Compute the CPS
1036 struct timeval NewTime;
1037 gettimeofday(&NewTime,0);
2ec1674d 1038 if ((NewTime.tv_sec - Time.tv_sec == 6 && NewTime.tv_usec > Time.tv_usec) ||
b98f2859
AL
1039 NewTime.tv_sec - Time.tv_sec > 6)
1040 {
f17ac097
AL
1041 double Delta = NewTime.tv_sec - Time.tv_sec +
1042 (NewTime.tv_usec - Time.tv_usec)/1000000.0;
b98f2859 1043
b98f2859 1044 // Compute the CPS value
f17ac097 1045 if (Delta < 0.01)
e331f6ed
AL
1046 CurrentCPS = 0;
1047 else
aa0e1101
AL
1048 CurrentCPS = ((CurrentBytes - ResumeSize) - LastBytes)/Delta;
1049 LastBytes = CurrentBytes - ResumeSize;
dbbc5494 1050 ElapsedTime = (unsigned long long)Delta;
b98f2859
AL
1051 Time = NewTime;
1052 }
024d1123 1053
c6e9cc58
MV
1054 // calculate the percentage, if we have too little data assume 1%
1055 if (TotalBytes > 0 && UnfetchedReleaseFiles)
96c6cab1
MV
1056 Percent = 0;
1057 else
1058 // use both files and bytes because bytes can be unreliable
1059 Percent = (0.8 * (CurrentBytes/float(TotalBytes)*100.0) +
1060 0.2 * (CurrentItems/float(TotalItems)*100.0));
1061
75ef8f14
MV
1062 int fd = _config->FindI("APT::Status-Fd",-1);
1063 if(fd > 0)
1064 {
1065 ostringstream status;
1066
1067 char msg[200];
1068 long i = CurrentItems < TotalItems ? CurrentItems + 1 : CurrentItems;
c033d415
MV
1069 unsigned long long ETA = 0;
1070 if(CurrentCPS > 0)
1071 ETA = (TotalBytes - CurrentBytes) / CurrentCPS;
75ef8f14 1072
1e8b4c0f
MV
1073 // only show the ETA if it makes sense
1074 if (ETA > 0 && ETA < 172800 /* two days */ )
0c508b03 1075 snprintf(msg,sizeof(msg), _("Retrieving file %li of %li (%s remaining)"), i, TotalItems, TimeToStr(ETA).c_str());
1e8b4c0f 1076 else
0c508b03 1077 snprintf(msg,sizeof(msg), _("Retrieving file %li of %li"), i, TotalItems);
1e8b4c0f 1078
75ef8f14
MV
1079 // build the status str
1080 status << "dlstatus:" << i
96c6cab1 1081 << ":" << std::setprecision(3) << Percent
d0cfa8ad
MV
1082 << ":" << msg
1083 << endl;
31bda500
DK
1084
1085 std::string const dlstatus = status.str();
d68d65ad 1086 FileFd::Write(fd, dlstatus.c_str(), dlstatus.size());
75ef8f14
MV
1087 }
1088
024d1123 1089 return true;
b98f2859
AL
1090}
1091 /*}}}*/
1092// AcquireStatus::Start - Called when the download is started /*{{{*/
1093// ---------------------------------------------------------------------
1094/* We just reset the counters */
1095void pkgAcquireStatus::Start()
1096{
1097 gettimeofday(&Time,0);
1098 gettimeofday(&StartTime,0);
1099 LastBytes = 0;
1100 CurrentCPS = 0;
1101 CurrentBytes = 0;
1102 TotalBytes = 0;
1103 FetchedBytes = 0;
1104 ElapsedTime = 0;
d568ed2d
AL
1105 TotalItems = 0;
1106 CurrentItems = 0;
b98f2859
AL
1107}
1108 /*}}}*/
a6568219 1109// AcquireStatus::Stop - Finished downloading /*{{{*/
b98f2859
AL
1110// ---------------------------------------------------------------------
1111/* This accurately computes the elapsed time and the total overall CPS. */
1112void pkgAcquireStatus::Stop()
1113{
1114 // Compute the CPS and elapsed time
1115 struct timeval NewTime;
1116 gettimeofday(&NewTime,0);
1117
31a0531d
AL
1118 double Delta = NewTime.tv_sec - StartTime.tv_sec +
1119 (NewTime.tv_usec - StartTime.tv_usec)/1000000.0;
b98f2859 1120
b98f2859 1121 // Compute the CPS value
31a0531d 1122 if (Delta < 0.01)
e331f6ed
AL
1123 CurrentCPS = 0;
1124 else
31a0531d 1125 CurrentCPS = FetchedBytes/Delta;
b98f2859 1126 LastBytes = CurrentBytes;
dbbc5494 1127 ElapsedTime = (unsigned long long)Delta;
b98f2859
AL
1128}
1129 /*}}}*/
1130// AcquireStatus::Fetched - Called when a byte set has been fetched /*{{{*/
1131// ---------------------------------------------------------------------
1132/* This is used to get accurate final transfer rate reporting. */
73da43e9 1133void pkgAcquireStatus::Fetched(unsigned long long Size,unsigned long long Resume)
93274b8d 1134{
b98f2859
AL
1135 FetchedBytes += Size - Resume;
1136}
1137 /*}}}*/
862bafea 1138
9d653a6d
DK
1139APT_CONST pkgAcquire::UriIterator::~UriIterator() {}
1140APT_CONST pkgAcquire::MethodConfig::~MethodConfig() {}
1141APT_CONST pkgAcquireStatus::~pkgAcquireStatus() {}