1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
|
# apt/progress/base.py - Base classes for progress reporting.
#
# Copyright (C) 2009 Julian Andres Klode <jak@debian.org>
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License as
# published by the Free Software Foundation; either version 2 of the
# License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
# USA
# pylint: disable-msg = R0201
"""Base classes for progress reporting.
Custom progress classes should inherit from these classes. They can also be
used as dummy progress classes which simply do nothing.
"""
from __future__ import annotations
import errno
import fcntl
import io
import os
import re
import select
import sys
import apt_pkg
__all__ = ["AcquireProgress", "CdromProgress", "InstallProgress", "OpProgress"]
class AcquireProgress:
"""Monitor object for downloads controlled by the Acquire class.
This is an mostly abstract class. You should subclass it and implement the
methods to get something useful.
"""
current_bytes = current_cps = fetched_bytes = last_bytes = total_bytes = 0.0
current_items = elapsed_time = total_items = 0
def done(self, item: apt_pkg.AcquireItemDesc) -> None:
"""Invoked when an item is successfully and completely fetched."""
def fail(self, item: apt_pkg.AcquireItemDesc) -> None:
"""Invoked when an item could not be fetched."""
def fetch(self, item: apt_pkg.AcquireItemDesc) -> None:
"""Invoked when some of the item's data is fetched."""
def ims_hit(self, item: apt_pkg.AcquireItemDesc) -> None:
"""Invoked when an item is confirmed to be up-to-date.
Invoked when an item is confirmed to be up-to-date. For instance,
when an HTTP download is informed that the file on the server was
not modified.
"""
def media_change(self, media: str, drive: str) -> bool:
"""Prompt the user to change the inserted removable media.
The parameter 'media' decribes the name of the media type that
should be changed, whereas the parameter 'drive' should be the
identifying name of the drive whose media should be changed.
This method should not return until the user has confirmed to the user
interface that the media change is complete. It must return True if
the user confirms the media change, or False to cancel it.
"""
return False
def pulse(self, owner: apt_pkg.Acquire) -> bool:
"""Periodically invoked while the Acquire process is underway.
This method gets invoked while the Acquire progress given by the
parameter 'owner' is underway. It should display information about
the current state.
This function returns a boolean value indicating whether the
acquisition should be continued (True) or cancelled (False).
"""
return True
def start(self) -> None:
"""Invoked when the Acquire process starts running."""
# Reset all our values.
self.current_bytes = 0.0
self.current_cps = 0.0
self.current_items = 0
self.elapsed_time = 0
self.fetched_bytes = 0.0
self.last_bytes = 0.0
self.total_bytes = 0.0
self.total_items = 0
def stop(self) -> None:
"""Invoked when the Acquire process stops running."""
class CdromProgress:
"""Base class for reporting the progress of adding a cdrom.
Can be used with apt_pkg.Cdrom to produce an utility like apt-cdrom. The
attribute 'total_steps' defines the total number of steps and can be used
in update() to display the current progress.
"""
total_steps = 0
def ask_cdrom_name(self) -> str | None:
"""Ask for the name of the cdrom.
If a name has been provided, return it. Otherwise, return None to
cancel the operation.
"""
def change_cdrom(self) -> bool:
"""Ask for the CD-ROM to be changed.
Return True once the cdrom has been changed or False to cancel the
operation.
"""
return False
def update(self, text: str, current: int) -> None:
"""Periodically invoked to update the interface.
The string 'text' defines the text which should be displayed. The
integer 'current' defines the number of completed steps.
"""
class InstallProgress:
"""Class to report the progress of installing packages."""
child_pid, percent, select_timeout, status = 0, 0.0, 0.1, ""
def __init__(self) -> None:
(self.statusfd, self.writefd) = os.pipe()
# These will leak fds, but fixing this safely requires API changes.
self.write_stream: io.TextIOBase = os.fdopen(self.writefd, "w")
self.status_stream: io.TextIOBase = os.fdopen(self.statusfd, "r") # noqa
fcntl.fcntl(self.statusfd, fcntl.F_SETFL, os.O_NONBLOCK)
def start_update(self) -> None:
"""(Abstract) Start update."""
def finish_update(self) -> None:
"""(Abstract) Called when update has finished."""
def __enter__(self) -> InstallProgress:
return self
def __exit__(self, type: object, value: object, traceback: object) -> None:
self.write_stream.close()
self.status_stream.close()
def error(self, pkg: str, errormsg: str) -> None:
"""(Abstract) Called when a error is detected during the install."""
def conffile(self, current: str, new: str) -> None:
"""(Abstract) Called when a conffile question from dpkg is detected."""
def status_change(self, pkg: str, percent: float, status: str) -> None:
"""(Abstract) Called when the APT status changed."""
def dpkg_status_change(self, pkg: str, status: str) -> None:
"""(Abstract) Called when the dpkg status changed."""
def processing(self, pkg: str, stage: str) -> None:
"""(Abstract) Sent just before a processing stage starts.
The parameter 'stage' is one of "upgrade", "install"
(both sent before unpacking), "configure", "trigproc", "remove",
"purge". This method is used for dpkg only.
"""
def run(self, obj: apt_pkg.PackageManager | bytes | str) -> int:
"""Install using the object 'obj'.
This functions runs install actions. The parameter 'obj' may either
be a PackageManager object in which case its do_install() method is
called or the path to a deb file.
If the object is a PackageManager, the functions returns the result
of calling its do_install() method. Otherwise, the function returns
the exit status of dpkg. In both cases, 0 means that there were no
problems.
"""
pid = self.fork()
if pid == 0:
try:
# PEP-446 implemented in Python 3.4 made all descriptors
# CLOEXEC, but we need to be able to pass writefd to dpkg
# when we spawn it
os.set_inheritable(self.writefd, True)
except AttributeError: # if we don't have os.set_inheritable()
pass
# pm.do_install might raise a exception,
# when this happens, we need to catch
# it, otherwise os._exit() is not run
# and the execution continues in the
# parent code leading to very confusing bugs
try:
os._exit(obj.do_install(self.write_stream.fileno())) # type: ignore # noqa
except AttributeError:
os._exit(
os.spawnlp(
os.P_WAIT,
"dpkg",
"dpkg",
"--status-fd",
str(self.write_stream.fileno()),
"-i",
obj, # type: ignore # noqa
)
)
except Exception as e:
sys.stderr.write("%s\n" % e)
os._exit(apt_pkg.PackageManager.RESULT_FAILED)
self.child_pid = pid
res = self.wait_child()
return os.WEXITSTATUS(res)
def fork(self) -> int:
"""Fork."""
return os.fork()
def update_interface(self) -> None:
"""Update the interface."""
try:
line = self.status_stream.readline()
except OSError as err:
# resource temporarly unavailable is ignored
if err.errno != errno.EAGAIN and err.errno != errno.EWOULDBLOCK:
print(err.strerror)
return
pkgname = status = status_str = percent = base = ""
if line.startswith("pm"):
try:
(status, pkgname, percent, status_str) = line.split(":", 3)
except ValueError:
# silently ignore lines that can't be parsed
return
elif line.startswith("status"):
try:
(base, pkgname, status, status_str) = line.split(":", 3)
except ValueError:
(base, pkgname, status) = line.split(":", 2)
elif line.startswith("processing"):
(status, status_str, pkgname) = line.split(":", 2)
self.processing(pkgname.strip(), status_str.strip())
# Always strip the status message
pkgname = pkgname.strip()
status_str = status_str.strip()
status = status.strip()
if status == "pmerror" or status == "error":
self.error(pkgname, status_str)
elif status == "conffile-prompt" or status == "pmconffile":
match = re.match("\\s*'(.*)'\\s*'(.*)'.*", status_str)
if match:
self.conffile(match.group(1), match.group(2))
elif status == "pmstatus":
# FIXME: Float comparison
if float(percent) != self.percent or status_str != self.status:
self.status_change(pkgname, float(percent), status_str.strip())
self.percent = float(percent)
self.status = status_str.strip()
elif base == "status":
self.dpkg_status_change(pkgname, status)
def wait_child(self) -> int:
"""Wait for child progress to exit.
This method is responsible for calling update_interface() from time to
time. It exits once the child has exited. The return values is the
full status returned from os.waitpid() (not only the return code).
"""
(pid, res) = (0, 0)
while True:
try:
select.select([self.status_stream], [], [], self.select_timeout)
except OSError as error:
(errno_, _errstr) = error.args
if errno_ != errno.EINTR:
raise
self.update_interface()
try:
(pid, res) = os.waitpid(self.child_pid, os.WNOHANG)
if pid == self.child_pid:
break
except OSError as err:
if err.errno == errno.ECHILD:
break
if err.errno != errno.EINTR:
raise
return res
class OpProgress:
"""Monitor objects for operations.
Display the progress of operations such as opening the cache."""
major_change, op, percent, subop = False, "", 0.0, ""
def update(self, percent: float | None = None) -> None:
"""Called periodically to update the user interface.
You may use the optional argument 'percent' to set the attribute
'percent' in this call.
"""
if percent is not None:
self.percent = percent
def done(self) -> None:
"""Called once an operation has been completed."""
|