1 // -*- mode: cpp; mode: fold -*-
3 // $Id: dpkgpm.cc,v 1.28 2004/01/27 02:25:01 mdz Exp $
4 /* ######################################################################
6 DPKG Package Manager - Provide an interface to dpkg
8 ##################################################################### */
11 #include <apt-pkg/dpkgpm.h>
12 #include <apt-pkg/error.h>
13 #include <apt-pkg/configuration.h>
14 #include <apt-pkg/depcache.h>
15 #include <apt-pkg/strutl.h>
20 #include <sys/select.h>
21 #include <sys/types.h>
31 #include <sys/ioctl.h>
40 // DPkgPM::pkgDPkgPM - Constructor /*{{{*/
41 // ---------------------------------------------------------------------
43 pkgDPkgPM::pkgDPkgPM(pkgDepCache
*Cache
) : pkgPackageManager(Cache
)
47 // DPkgPM::pkgDPkgPM - Destructor /*{{{*/
48 // ---------------------------------------------------------------------
50 pkgDPkgPM::~pkgDPkgPM()
54 // DPkgPM::Install - Install a package /*{{{*/
55 // ---------------------------------------------------------------------
56 /* Add an install operation to the sequence list */
57 bool pkgDPkgPM::Install(PkgIterator Pkg
,string File
)
59 if (File
.empty() == true || Pkg
.end() == true)
60 return _error
->Error("Internal Error, No file name for %s",Pkg
.Name());
62 List
.push_back(Item(Item::Install
,Pkg
,File
));
66 // DPkgPM::Configure - Configure a package /*{{{*/
67 // ---------------------------------------------------------------------
68 /* Add a configure operation to the sequence list */
69 bool pkgDPkgPM::Configure(PkgIterator Pkg
)
71 if (Pkg
.end() == true)
74 List
.push_back(Item(Item::Configure
,Pkg
));
78 // DPkgPM::Remove - Remove a package /*{{{*/
79 // ---------------------------------------------------------------------
80 /* Add a remove operation to the sequence list */
81 bool pkgDPkgPM::Remove(PkgIterator Pkg
,bool Purge
)
83 if (Pkg
.end() == true)
87 List
.push_back(Item(Item::Purge
,Pkg
));
89 List
.push_back(Item(Item::Remove
,Pkg
));
93 // DPkgPM::RunScripts - Run a set of scripts /*{{{*/
94 // ---------------------------------------------------------------------
95 /* This looks for a list of script sto run from the configuration file,
96 each one is run with system from a forked child. */
97 bool pkgDPkgPM::RunScripts(const char *Cnf
)
99 Configuration::Item
const *Opts
= _config
->Tree(Cnf
);
100 if (Opts
== 0 || Opts
->Child
== 0)
104 // Fork for running the system calls
105 pid_t Child
= ExecFork();
110 if (chdir("/tmp/") != 0)
113 unsigned int Count
= 1;
114 for (; Opts
!= 0; Opts
= Opts
->Next
, Count
++)
116 if (Opts
->Value
.empty() == true)
119 if (system(Opts
->Value
.c_str()) != 0)
125 // Wait for the child
127 while (waitpid(Child
,&Status
,0) != Child
)
131 return _error
->Errno("waitpid","Couldn't wait for subprocess");
134 // Restore sig int/quit
135 signal(SIGQUIT
,SIG_DFL
);
136 signal(SIGINT
,SIG_DFL
);
138 // Check for an error code.
139 if (WIFEXITED(Status
) == 0 || WEXITSTATUS(Status
) != 0)
141 unsigned int Count
= WEXITSTATUS(Status
);
145 for (; Opts
!= 0 && Count
!= 1; Opts
= Opts
->Next
, Count
--);
146 _error
->Error("Problem executing scripts %s '%s'",Cnf
,Opts
->Value
.c_str());
149 return _error
->Error("Sub-process returned an error code");
155 // DPkgPM::SendV2Pkgs - Send version 2 package info /*{{{*/
156 // ---------------------------------------------------------------------
157 /* This is part of the helper script communication interface, it sends
158 very complete information down to the other end of the pipe.*/
159 bool pkgDPkgPM::SendV2Pkgs(FILE *F
)
161 fprintf(F
,"VERSION 2\n");
163 /* Write out all of the configuration directives by walking the
164 configuration tree */
165 const Configuration::Item
*Top
= _config
->Tree(0);
168 if (Top
->Value
.empty() == false)
171 QuoteString(Top
->FullTag(),"=\"\n").c_str(),
172 QuoteString(Top
->Value
,"\n").c_str());
181 while (Top
!= 0 && Top
->Next
== 0)
188 // Write out the package actions in order.
189 for (vector
<Item
>::iterator I
= List
.begin(); I
!= List
.end(); I
++)
191 pkgDepCache::StateCache
&S
= Cache
[I
->Pkg
];
193 fprintf(F
,"%s ",I
->Pkg
.Name());
195 if (I
->Pkg
->CurrentVer
== 0)
198 fprintf(F
,"%s ",I
->Pkg
.CurrentVer().VerStr());
200 // Show the compare operator
202 if (S
.InstallVer
!= 0)
205 if (I
->Pkg
->CurrentVer
!= 0)
206 Comp
= S
.InstVerIter(Cache
).CompareVer(I
->Pkg
.CurrentVer());
213 fprintf(F
,"%s ",S
.InstVerIter(Cache
).VerStr());
218 // Show the filename/operation
219 if (I
->Op
== Item::Install
)
222 if (I
->File
[0] != '/')
223 fprintf(F
,"**ERROR**\n");
225 fprintf(F
,"%s\n",I
->File
.c_str());
227 if (I
->Op
== Item::Configure
)
228 fprintf(F
,"**CONFIGURE**\n");
229 if (I
->Op
== Item::Remove
||
230 I
->Op
== Item::Purge
)
231 fprintf(F
,"**REMOVE**\n");
239 // DPkgPM::RunScriptsWithPkgs - Run scripts with package names on stdin /*{{{*/
240 // ---------------------------------------------------------------------
241 /* This looks for a list of scripts to run from the configuration file
242 each one is run and is fed on standard input a list of all .deb files
243 that are due to be installed. */
244 bool pkgDPkgPM::RunScriptsWithPkgs(const char *Cnf
)
246 Configuration::Item
const *Opts
= _config
->Tree(Cnf
);
247 if (Opts
== 0 || Opts
->Child
== 0)
251 unsigned int Count
= 1;
252 for (; Opts
!= 0; Opts
= Opts
->Next
, Count
++)
254 if (Opts
->Value
.empty() == true)
257 // Determine the protocol version
258 string OptSec
= Opts
->Value
;
259 string::size_type Pos
;
260 if ((Pos
= OptSec
.find(' ')) == string::npos
|| Pos
== 0)
261 Pos
= OptSec
.length();
262 OptSec
= "DPkg::Tools::Options::" + string(Opts
->Value
.c_str(),Pos
);
264 unsigned int Version
= _config
->FindI(OptSec
+"::Version",1);
268 if (pipe(Pipes
) != 0)
269 return _error
->Errno("pipe","Failed to create IPC pipe to subprocess");
270 SetCloseExec(Pipes
[0],true);
271 SetCloseExec(Pipes
[1],true);
273 // Purified Fork for running the script
274 pid_t Process
= ExecFork();
278 dup2(Pipes
[0],STDIN_FILENO
);
279 SetCloseExec(STDOUT_FILENO
,false);
280 SetCloseExec(STDIN_FILENO
,false);
281 SetCloseExec(STDERR_FILENO
,false);
286 Args
[2] = Opts
->Value
.c_str();
288 execv(Args
[0],(char **)Args
);
292 FILE *F
= fdopen(Pipes
[1],"w");
294 return _error
->Errno("fdopen","Faild to open new FD");
296 // Feed it the filenames.
300 for (vector
<Item
>::iterator I
= List
.begin(); I
!= List
.end(); I
++)
302 // Only deal with packages to be installed from .deb
303 if (I
->Op
!= Item::Install
)
307 if (I
->File
[0] != '/')
310 /* Feed the filename of each package that is pending install
312 fprintf(F
,"%s\n",I
->File
.c_str());
321 Die
= !SendV2Pkgs(F
);
325 // Clean up the sub process
326 if (ExecWait(Process
,Opts
->Value
.c_str()) == false)
327 return _error
->Error("Failure running script %s",Opts
->Value
.c_str());
334 // DPkgPM::DoStdin - Read stdin and pass to slave pty /*{{{*/
335 // ---------------------------------------------------------------------
338 void pkgDPkgPM::DoStdin(int master
)
340 char input_buf
[256] = {0,};
341 int len
= read(0, input_buf
, sizeof(input_buf
));
342 write(master
, input_buf
, len
);
345 // DPkgPM::DoTerminalPty - Read the terminal pty and write log /*{{{*/
346 // ---------------------------------------------------------------------
348 * read the terminal pty and write log
350 void pkgDPkgPM::DoTerminalPty(int master
, FILE *term_out
)
352 char term_buf
[1024] = {0,};
354 int len
=read(master
, term_buf
, sizeof(term_buf
));
357 fwrite(term_buf
, len
, sizeof(char), term_out
);
358 write(1, term_buf
, len
);
364 // DPkgPM::Go - Run the sequence /*{{{*/
365 // ---------------------------------------------------------------------
366 /* This globs the operations and calls dpkg
368 * If it is called with "OutStatusFd" set to a valid file descriptor
369 * apt will report the install progress over this fd. It maps the
370 * dpkg states a package goes through to human readable (and i10n-able)
371 * names and calculates a percentage for each step.
373 bool pkgDPkgPM::Go(int OutStatusFd
)
375 unsigned int MaxArgs
= _config
->FindI("Dpkg::MaxArgs",8*1024);
376 unsigned int MaxArgBytes
= _config
->FindI("Dpkg::MaxArgBytes",32*1024);
378 if (RunScripts("DPkg::Pre-Invoke") == false)
381 if (RunScriptsWithPkgs("DPkg::Pre-Install-Pkgs") == false)
384 // prepare the progress reporting
387 // map the dpkg states to the operations that are performed
388 // (this is sorted in the same way as Item::Ops)
389 static const struct DpkgState DpkgStatesOpMap
[][5] = {
392 {"half-installed", N_("Preparing %s")},
393 {"unpacked", N_("Unpacking %s") },
396 // Configure operation
398 {"unpacked",N_("Preparing to configure %s") },
399 {"half-configured", N_("Configuring %s") },
400 { "installed", N_("Installed %s")},
405 {"half-configured", N_("Preparing for removal of %s")},
406 {"half-installed", N_("Removing %s")},
407 {"config-files", N_("Removed %s")},
412 {"config-files", N_("Preparing to completely remove %s")},
413 {"not-installed", N_("Completely removed %s")},
418 // the dpkg states that the pkg will run through, the string is
419 // the package, the vector contains the dpkg states that the package
421 map
<string
,vector
<struct DpkgState
> > PackageOps
;
422 // the dpkg states that are already done; the string is the package
423 // the int is the state that is already done (e.g. a package that is
424 // going to be install is already in state "half-installed")
425 map
<string
,int> PackageOpsDone
;
427 // init the PackageOps map, go over the list of packages that
428 // that will be [installed|configured|removed|purged] and add
429 // them to the PackageOps map (the dpkg states it goes through)
430 // and the PackageOpsTranslations (human readable strings)
431 for (vector
<Item
>::iterator I
= List
.begin(); I
!= List
.end();I
++)
433 string name
= (*I
).Pkg
.Name();
434 PackageOpsDone
[name
] = 0;
435 for(int i
=0; (DpkgStatesOpMap
[(*I
).Op
][i
]).state
!= NULL
; i
++)
437 PackageOps
[name
].push_back(DpkgStatesOpMap
[(*I
).Op
][i
]);
442 // this loop is runs once per operation
443 for (vector
<Item
>::iterator I
= List
.begin(); I
!= List
.end();)
445 vector
<Item
>::iterator J
= I
;
446 for (; J
!= List
.end() && J
->Op
== I
->Op
; J
++);
448 // Generate the argument list
449 const char *Args
[MaxArgs
+ 50];
450 if (J
- I
> (signed)MaxArgs
)
454 unsigned long Size
= 0;
455 string Tmp
= _config
->Find("Dir::Bin::dpkg","dpkg");
456 Args
[n
++] = Tmp
.c_str();
457 Size
+= strlen(Args
[n
-1]);
459 // Stick in any custom dpkg options
460 Configuration::Item
const *Opts
= _config
->Tree("DPkg::Options");
464 for (; Opts
!= 0; Opts
= Opts
->Next
)
466 if (Opts
->Value
.empty() == true)
468 Args
[n
++] = Opts
->Value
.c_str();
469 Size
+= Opts
->Value
.length();
473 char status_fd_buf
[20];
477 Args
[n
++] = "--status-fd";
478 Size
+= strlen(Args
[n
-1]);
479 snprintf(status_fd_buf
,sizeof(status_fd_buf
),"%i", fd
[1]);
480 Args
[n
++] = status_fd_buf
;
481 Size
+= strlen(Args
[n
-1]);
486 Args
[n
++] = "--force-depends";
487 Size
+= strlen(Args
[n
-1]);
488 Args
[n
++] = "--force-remove-essential";
489 Size
+= strlen(Args
[n
-1]);
490 Args
[n
++] = "--remove";
491 Size
+= strlen(Args
[n
-1]);
495 Args
[n
++] = "--force-depends";
496 Size
+= strlen(Args
[n
-1]);
497 Args
[n
++] = "--force-remove-essential";
498 Size
+= strlen(Args
[n
-1]);
499 Args
[n
++] = "--purge";
500 Size
+= strlen(Args
[n
-1]);
503 case Item::Configure
:
504 Args
[n
++] = "--configure";
505 Size
+= strlen(Args
[n
-1]);
509 Args
[n
++] = "--unpack";
510 Size
+= strlen(Args
[n
-1]);
511 Args
[n
++] = "--auto-deconfigure";
512 Size
+= strlen(Args
[n
-1]);
516 // Write in the file or package names
517 if (I
->Op
== Item::Install
)
519 for (;I
!= J
&& Size
< MaxArgBytes
; I
++)
521 if (I
->File
[0] != '/')
522 return _error
->Error("Internal Error, Pathname to install is not absolute '%s'",I
->File
.c_str());
523 Args
[n
++] = I
->File
.c_str();
524 Size
+= strlen(Args
[n
-1]);
529 for (;I
!= J
&& Size
< MaxArgBytes
; I
++)
531 Args
[n
++] = I
->Pkg
.Name();
532 Size
+= strlen(Args
[n
-1]);
538 if (_config
->FindB("Debug::pkgDPkgPM",false) == true)
540 for (unsigned int k
= 0; k
!= n
; k
++)
541 clog
<< Args
[k
] << ' ';
550 /* Mask off sig int/quit. We do this because dpkg also does when
551 it forks scripts. What happens is that when you hit ctrl-c it sends
552 it to all processes in the group. Since dpkg ignores the signal
553 it doesn't die but we do! So we must also ignore it */
554 sighandler_t old_SIGQUIT
= signal(SIGQUIT
,SIG_IGN
);
555 sighandler_t old_SIGINT
= signal(SIGINT
,SIG_IGN
);
562 // FIXME: setup sensible signal handling (*ick*)
564 ioctl(0, TIOCGWINSZ
, (char *)&win
);
565 if (openpty(&master
, &slave
, NULL
, &tt
, &win
) < 0)
567 fprintf(stderr
, _("openpty failed\n"));
573 rtt
.c_lflag
&= ~ECHO
;
574 tcsetattr(0, TCSAFLUSH
, &rtt
);
578 _config
->Set("APT::Keep-Fds::",fd
[1]);
585 ioctl(slave
, TIOCSCTTY
, 0);
591 close(fd
[0]); // close the read end of the pipe
593 if (chdir(_config
->FindDir("DPkg::Run-Directory","/").c_str()) != 0)
596 if (_config
->FindB("DPkg::FlushSTDIN",true) == true && isatty(STDIN_FILENO
))
599 if ((Flags
= fcntl(STDIN_FILENO
,F_GETFL
,dummy
)) < 0)
602 // Discard everything in stdin before forking dpkg
603 if (fcntl(STDIN_FILENO
,F_SETFL
,Flags
| O_NONBLOCK
) < 0)
606 while (read(STDIN_FILENO
,&dummy
,1) == 1);
608 if (fcntl(STDIN_FILENO
,F_SETFL
,Flags
& (~(long)O_NONBLOCK
)) < 0)
613 /* No Job Control Stop Env is a magic dpkg var that prevents it
614 from using sigstop */
615 putenv("DPKG_NO_TSTP=yes");
616 execvp(Args
[0],(char **)Args
);
617 cerr
<< "Could not exec dpkg!" << endl
;
621 // clear the Keep-Fd again
622 _config
->Clear("APT::Keep-Fds",fd
[1]);
627 // we read from dpkg here
629 fcntl(_dpkgin
, F_SETFL
, O_NONBLOCK
);
630 close(fd
[1]); // close the write end of the pipe
632 // the read buffers for the communication with dpkg
633 char line
[1024] = {0,};
636 // the result of the waitpid call
640 fcntl(0, F_SETFL
, O_NONBLOCK
);
641 fcntl(master
, F_SETFL
, O_NONBLOCK
);
643 // FIXME: make this a apt config option and add a logrotate file
644 FILE *term_out
= fopen("/var/log/dpkg-out.log","a");
645 chmod("/var/log/dpkg-out.log", 0600);
646 // output current time
648 time_t t
= time(NULL
);
649 struct tm
*tmp
= localtime(&t
);
650 strftime(outstr
, sizeof(outstr
), "%F %T", tmp
);
651 fprintf(term_out
, "Log started: ");
652 fprintf(term_out
, outstr
);
653 fprintf(term_out
, "\n");
659 while ((res
=waitpid(Child
,&Status
, WNOHANG
)) != Child
) {
661 // FIXME: move this to a function or something, looks ugly here
662 // error handling, waitpid returned -1
665 RunScripts("DPkg::Post-Invoke");
667 // Restore sig int/quit
668 signal(SIGQUIT
,old_SIGQUIT
);
669 signal(SIGINT
,old_SIGINT
);
670 return _error
->Errno("waitpid","Couldn't wait for subprocess");
673 // wait for input or output here
676 FD_SET(_dpkgin
, &rfds
);
677 FD_SET(master
, &rfds
);
680 select_ret
= select(max(master
, _dpkgin
)+1, &rfds
, NULL
, NULL
, &tv
);
682 std::cerr
<< "Error in select()" << std::endl
;
683 else if (select_ret
== 0)
686 if(FD_ISSET(master
, &rfds
))
687 DoTerminalPty(master
, term_out
);
688 if(FD_ISSET(0, &rfds
))
691 // FIXME: move this into its own function too
692 // FIXME2: do not use non-blocking read here,
693 // read/process as much data as possible
696 if(FD_ISSET(_dpkgin
, &rfds
))
699 if(read(_dpkgin
, buf
, 1) <= 0)
702 // sanity check (should never happen)
703 if(strlen(line
) >= sizeof(line
)-10)
705 _error
->Error("got a overlong line from dpkg: '%s'",line
);
709 // append to line, check if we got a complete line
714 if (_config
->FindB("Debug::pkgDPkgProgressReporting",false) == true)
715 std::clog
<< "got from dpkg '" << line
<< "'" << std::endl
;
717 // the status we output
718 ostringstream status
;
720 /* dpkg sends strings like this:
721 'status: <pkg>: <pkg qstate>'
722 errors look like this:
723 'status: /var/cache/apt/archives/krecipes_0.8.1-0ubuntu1_i386.deb : error : trying to overwrite `/usr/share/doc/kde/HTML/en/krecipes/krectip.png', which is also in package krecipes-data
724 and conffile-prompt like this
725 'status: conffile-prompt: conffile : 'current-conffile' 'new-conffile' useredited distedited
729 // dpkg sends multiline error messages sometimes (see
730 // #374195 for a example. we should support this by
731 // either patching dpkg to not send multiline over the
732 // statusfd or by rewriting the code here to deal with
733 // it. for now we just ignore it and not crash
734 TokSplitString(':', line
, list
, sizeof(list
)/sizeof(list
[0]));
736 char *action
= _strstrip(list
[2]);
737 if( pkg
== NULL
|| action
== NULL
)
739 if (_config
->FindB("Debug::pkgDPkgProgressReporting",false) == true)
740 std::clog
<< "ignoring line: not enough ':'" << std::endl
;
741 // reset the line buffer
746 if(strncmp(action
,"error",strlen("error")) == 0)
748 status
<< "pmerror:" << list
[1]
749 << ":" << (Done
/float(Total
)*100.0)
753 write(OutStatusFd
, status
.str().c_str(), status
.str().size());
755 if (_config
->FindB("Debug::pkgDPkgProgressReporting",false) == true)
756 std::clog
<< "send: '" << status
.str() << "'" << endl
;
759 if(strncmp(action
,"conffile",strlen("conffile")) == 0)
761 status
<< "pmconffile:" << list
[1]
762 << ":" << (Done
/float(Total
)*100.0)
766 write(OutStatusFd
, status
.str().c_str(), status
.str().size());
768 if (_config
->FindB("Debug::pkgDPkgProgressReporting",false) == true)
769 std::clog
<< "send: '" << status
.str() << "'" << endl
;
773 vector
<struct DpkgState
> &states
= PackageOps
[pkg
];
774 const char *next_action
= NULL
;
775 if(PackageOpsDone
[pkg
] < states
.size())
776 next_action
= states
[PackageOpsDone
[pkg
]].state
;
777 // check if the package moved to the next dpkg state
778 if(next_action
&& (strcmp(action
, next_action
) == 0))
780 // only read the translation if there is actually a next
782 const char *translation
= _(states
[PackageOpsDone
[pkg
]].str
);
784 snprintf(s
, sizeof(s
), translation
, pkg
);
786 // we moved from one dpkg state to a new one, report that
787 PackageOpsDone
[pkg
]++;
789 // build the status str
790 status
<< "pmstatus:" << pkg
791 << ":" << (Done
/float(Total
)*100.0)
795 write(OutStatusFd
, status
.str().c_str(), status
.str().size());
796 if (_config
->FindB("Debug::pkgDPkgProgressReporting",false) == true)
797 std::clog
<< "send: '" << status
.str() << "'" << endl
;
800 if (_config
->FindB("Debug::pkgDPkgProgressReporting",false) == true)
801 std::clog
<< "(parsed from dpkg) pkg: " << pkg
802 << " action: " << action
<< endl
;
804 // reset the line buffer
811 // Restore sig int/quit
812 signal(SIGQUIT
,old_SIGQUIT
);
813 signal(SIGINT
,old_SIGINT
);
815 tcsetattr(0, TCSAFLUSH
, &tt
);
817 // Check for an error code.
818 if (WIFEXITED(Status
) == 0 || WEXITSTATUS(Status
) != 0)
820 // if it was set to "keep-dpkg-runing" then we won't return
821 // here but keep the loop going and just report it as a error
823 bool stopOnError
= _config
->FindB("Dpkg::StopOnError",true);
826 RunScripts("DPkg::Post-Invoke");
828 if (WIFSIGNALED(Status
) != 0 && WTERMSIG(Status
) == SIGSEGV
)
829 _error
->Error("Sub-process %s received a segmentation fault.",Args
[0]);
830 else if (WIFEXITED(Status
) != 0)
831 _error
->Error("Sub-process %s returned an error code (%u)",Args
[0],WEXITSTATUS(Status
));
833 _error
->Error("Sub-process %s exited unexpectedly",Args
[0]);
840 if (RunScripts("DPkg::Post-Invoke") == false)
845 // pkgDpkgPM::Reset - Dump the contents of the command list /*{{{*/
846 // ---------------------------------------------------------------------
848 void pkgDPkgPM::Reset()
850 List
.erase(List
.begin(),List
.end());