summaryrefslogtreecommitdiffstats
path: root/gurpm/RPMProgressDialog.pm
diff options
context:
space:
mode:
authorThierry Vignaud <tv@mageia.org>2013-03-16 09:03:22 +0000
committerThierry Vignaud <tv@mageia.org>2013-03-16 09:03:22 +0000
commit40392ce42b6eee10c34eb0d8d1cfef77c8a7962c (patch)
treef69e79c61ee7ade855e147bd5be7ca0023d10fa1 /gurpm/RPMProgressDialog.pm
parenta502e85fbd3a6900e95954ca09b04ed8fc5cbe8d (diff)
downloadurpmi-40392ce42b6eee10c34eb0d8d1cfef77c8a7962c.tar
urpmi-40392ce42b6eee10c34eb0d8d1cfef77c8a7962c.tar.gz
urpmi-40392ce42b6eee10c34eb0d8d1cfef77c8a7962c.tar.bz2
urpmi-40392ce42b6eee10c34eb0d8d1cfef77c8a7962c.tar.xz
urpmi-40392ce42b6eee10c34eb0d8d1cfef77c8a7962c.zip
new widget to share with rpmdrake for global progress bar (mga#778)
Diffstat (limited to 'gurpm/RPMProgressDialog.pm')
-rw-r--r--gurpm/RPMProgressDialog.pm280
1 files changed, 280 insertions, 0 deletions
diff --git a/gurpm/RPMProgressDialog.pm b/gurpm/RPMProgressDialog.pm
new file mode 100644
index 00000000..13d79c42
--- /dev/null
+++ b/gurpm/RPMProgressDialog.pm
@@ -0,0 +1,280 @@
+package gurpm::RPMProgressDialog;
+
+#- Copyright (C) 2005 MandrakeSoft SA
+#- Copyright (C) 2005-2010 Mandriva SA
+#- Copyright (C) 2013 Mageia
+
+# Sharing code from gurpmi2 && Rpmdrake::gurpm
+# Gtk2 only (no ugtk2/mygtk2) as it's used by gurpmi too...
+#
+
+=head1 SYNOPSYS
+
+gurpm::RPMProgressDialog is a widget for gurpmi, rpmdrake (drakx already has its own)
+that presents a global progress bar.
+
+=head1 USAGE
+
+How to use:
+
+ my $w = gurpm::RPMProgressDialog->new:
+ #$w->change_widget(Gtk2::Box->new);
+ label(N("Preparing packages installation..."));
+ ... # compute packages to install/remove...
+ $w->init_progressbar;
+ urpm::main_loop::run($urpm, $state, $nb, \@ask_unselect, {
+ trans_log => &gurpm::RPMProgressDialog::callback_download,
+ inst => \&gurpm::RPMProgressDialog::callback_inst,
+ trans => \&gurpm::RPMProgressDialog::callback_inst,
+ callback_report_uninst => ...
+ ....
+
+=head1 DESCRIPTION
+
+=cut
+
+use strict;
+use Gtk2;
+use urpm::download;
+use urpm::msg 'N';
+use urpm::util qw(max member);
+
+our @ISA = qw(Gtk2::Window);
+
+sub title {
+ $::auto_select ? N("Distribution Upgrade") : N("Packages installation");
+}
+
+# package variable needed in order to simplify callbacks
+my $mainw;
+
+my $progressbar_size = 450;
+my ($progress_nb, $download_nb);
+
+
+=head2 Creators
+
+=over 4
+
+=item gurpm::RPMProgressDialog->new($urpm, $o_quit)
+
+Creates a new Progress Dialog.
+
+Arguments are an urpm object and a quit routine reference.
+
+=cut
+
+
+sub new {
+ my ($self, $urpm, $o_quit) = @_;
+ # my $w = ugtk2->new($title, %options, default_width => 600, width => 600);
+ my $w = $mainw = bless(Gtk2::Window->new('toplevel'), $self);
+ $::main_window = $w;
+ $w->set_border_width(12);
+ $w->set_title($w->title);
+ $w->signal_connect(destroy => $o_quit) if $o_quit;
+ $w->set_position('center');
+ $w->set_default_size($progressbar_size, 60);
+ $w->set_type_hint('dialog'); # for matchbox window manager during install
+ $w->set_modal(1); # for matchbox window manager during install
+ $w->{mainbox} = Gtk2::VBox->new(0, 5);
+ $w->add($w->{mainbox});
+ $w->{urpm} = $urpm;
+ bless($w, $self);
+}
+
+=back
+
+=head2 Methods
+
+=over 4
+
+=item change_widget($w, $box_widget)
+
+Replaces the contents of the main window with the specified box
+(avoids popup multiplication)
+
+=cut
+
+sub change_widget {
+ my ($w, $mainbox) = @_;
+ $w->remove($w->{mainbox});
+ $w->add($w->{mainbox} = $mainbox);
+ $w->show_all;
+}
+
+=item label($w, $o_text)
+
+sets the window to a please-wait message
+
+=cut
+
+sub label {
+ my ($w, $o_text) = @_;
+ my $wait_vbox = Gtk2::VBox->new(0, 5);
+ my $label = Gtk2::Label->new($o_text || N("Please wait..."));
+ $label->set_alignment(0.5, 0.5);
+ $wait_vbox->pack_start($label, 1, 1, 0);
+ $w->change_widget($wait_vbox);
+ $w->sync;
+}
+
+
+# From ugtk2.pm/mygtk2.pm:
+sub gtk_new_Label_Left {
+ my ($text) = @_;
+ my $w = Gtk2::Label->new($text);
+ $w->set_alignment(0, 0);
+ $w;
+}
+
+=item init_progressbar($w)
+
+Put a progress bar in the dialog.
+
+=cut
+
+sub init_progressbar {
+ my ($w) = @_;
+ my $vbox = Gtk2::VBox->new(0, 5);
+
+ my $global_label = gtk_new_Label_Left('<b>' . $w->title . '</b>');
+ $global_label->set_use_markup(1);
+ $vbox->pack_start($global_label, 0, 0, 0);
+
+ my $global_progressbar = $w->{global_progressbar} = Gtk2::ProgressBar->new;
+ $vbox->pack_start($global_progressbar, 0, 0, 0);
+
+ $vbox->pack_start($w->{progresslabel} = gtk_new_Label_Left('-'), 1, 1, 0);
+
+ my $progressbar = Gtk2::ProgressBar->new;
+ $progressbar->set_size_request($progressbar_size, -1);
+ $vbox->pack_start($progressbar, 0, 0, 0);
+ $w->{progressbar} = $progressbar;
+
+ $w->change_widget($vbox);
+}
+
+=item set_progresslabel($w, $text)
+
+Update the progress label
+
+=cut
+
+sub set_progresslabel {
+ my ($w, $text) = @_;
+ $w->{progresslabel}->set_label($text);
+}
+
+=item set_progressbar($w, $local_ratio)
+
+Update the progress bar
+
+=cut
+
+sub set_progressbar {
+ my ($w, $local_ratio) = @_;
+ if ($progress_nb || $download_nb) { # this happens when computing transaction
+ $w->{global_progressbar}->set_fraction(($download_nb + $progress_nb - 1 + $local_ratio) / 2 / $w->{urpm}{nb_install});
+ }
+ $w->{progressbar}->set_fraction($local_ratio);
+}
+
+=item sync($w)
+
+tell Gtk+ to refresh the dialog content if needed.
+
+=cut
+
+sub sync {
+ my ($w) = @_;
+ $w->show;
+ Gtk2->main_iteration while Gtk2->events_pending;
+}
+
+=back
+
+=head2 Callbacks
+
+=over 4
+
+=item callback_inst($urpm, $type, $id, $subtype, $amount, $total)
+
+This callback is called when a new RPM DB transaction is created and
+when packages are installed.
+
+Its purpose is to display installation progress in the dialog.
+
+=cut
+
+sub callback_inst {
+ my ($urpm, $type, $id, $subtype, $amount, $total) = @_;
+ my $pkg = defined $id ? $urpm->{depslist}[$id] : undef;
+ if ($subtype eq 'start') {
+ if ($type eq 'trans') {
+ $mainw->set_progresslabel(N("Preparing..."));
+ } elsif ($pkg) {
+ $progress_nb++;
+ $download_nb = max($download_nb, $progress_nb);
+ $mainw->set_progressbar(0);
+ $mainw->set_progresslabel(
+ N("Installing package `%s' (%s/%s)...", $pkg->name, $progress_nb, $urpm->{nb_install})
+ );
+ }
+ } elsif ($subtype eq 'progress') {
+ $mainw->set_progressbar($amount / $total);
+ }
+ $mainw->sync;
+}
+
+sub callback_remove {
+ $mainw->set_progresslabel(N("removing %s", $_[0]));
+}
+
+=item callback_download($mode, $file, $percent, $total, $eta, $speed)
+
+This callback is called when packages are downloaded prior being installed
+in a RPM transaction.
+
+Its purpose is to display download progress in the dialog.
+
+=cut
+
+sub callback_download {
+ my ($mode, $file, $percent, $total, $eta, $speed) = @_;
+
+ urpm::download::sync_logger($mode, $file, $percent, $total, $eta, $speed);
+
+ if (member($mode, 'start', 'progress')) {
+ $file =~ s|/*\s*$||; $file =~ s|.*/||;
+ $mainw->set_progresslabel(N("Downloading package `%s'...", $file) . "\n" .
+ &urpm::download::progress_text($mode, $percent, $total, $eta, $speed));
+ }
+ if ($mode eq 'start') {
+ $download_nb++;
+ $mainw->set_progressbar(0);
+ select(undef, undef, undef, 0.1); #- hackish
+ } elsif ($mode eq 'progress') {
+ $mainw->set_progressbar($percent / 100);
+ } elsif ($mode eq 'end') {
+ $mainw->set_progressbar(1);
+ } elsif ($mode eq 'error') {
+ #- error is 3rd argument, saved in $percent
+ push @{$mainw->{urpm}{download_errors}}, N("...retrieving failed: %s", $percent);
+ }
+ $mainw->sync;
+}
+
+=back
+
+=head1 Copyright
+
+Copyright (C) 2005 MandrakeSoft SA
+
+Copyright (C) 2005-2010 Mandriva SA
+
+Copyright (C) 2011-2013 Mageia
+
+=cut
+
+1;