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