| 1 | # Copyright 2008, 2009, 2010, 2011, 2012 Kevin Ryde | ||
| 2 | |||
| 3 | # This file is part of Chart. | ||
| 4 | # | ||
| 5 | # Chart is free software; you can redistribute it and/or modify it under the | ||
| 6 | # terms of the GNU General Public License as published by the Free Software | ||
| 7 | # Foundation; either version 3, or (at your option) any later version. | ||
| 8 | # | ||
| 9 | # Chart is distributed in the hope that it will be useful, but WITHOUT ANY | ||
| 10 | # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS | ||
| 11 | # FOR A PARTICULAR PURPOSE. See the GNU General Public License for more | ||
| 12 | # details. | ||
| 13 | # | ||
| 14 | # You should have received a copy of the GNU General Public License along | ||
| 15 | # with Chart. If not, see <http://www.gnu.org/licenses/>. | ||
| 16 | |||
| 17 | |||
| 18 | # FIXME: consistency checks mark as historical things merely not downloaded | ||
| 19 | # for a while | ||
| 20 | |||
| 21 | |||
| 22 | package App::Chart::Gtk2::VacuumDialog; | ||
| 23 | use 5.010; | ||
| 24 | use strict; | ||
| 25 | use warnings; | ||
| 26 | use Gtk2; | ||
| 27 | use Locale::TextDomain ('App-Chart'); | ||
| 28 | |||
| 29 | use Glib::Ex::ConnectProperties; | ||
| 30 | use Gtk2::Ex::Units; | ||
| 31 | use App::Chart::Glib::Ex::MoreUtils; | ||
| 32 | use App::Chart; | ||
| 33 | |||
| 34 | use base 'App::Chart::Gtk2::Ex::ToplevelSingleton'; | ||
| 35 | |||
| 36 | use Glib::Object::Subclass | ||
| 37 | 'Gtk2::Dialog', | ||
| 38 | signals => { destroy => \&_do_destroy }; | ||
| 39 | |||
| 40 | use constant { RESPONSE_START => 0, | ||
| 41 | RESPONSE_STOP => 1, | ||
| 42 | RESPONSE_CLEAR => 2 }; | ||
| 43 | |||
| 44 | # sub popup { | ||
| 45 | # my ($class) = @_; | ||
| 46 | # require Gtk2::Ex::WidgetCursor; | ||
| 47 | # Gtk2::Ex::WidgetCursor->busy; | ||
| 48 | # my $dialog = $class->instance; | ||
| 49 | # $dialog->present; | ||
| 50 | # return $dialog; | ||
| 51 | # } | ||
| 52 | |||
| 53 | sub INIT_INSTANCE { | ||
| 54 | my ($self) = @_; | ||
| 55 | |||
| 56 | $self->set_title (__('Chart: Vacuum')); | ||
| 57 | $self->add_buttons (__('_Start') => $self->RESPONSE_START, | ||
| 58 | __('_Stop') => $self->RESPONSE_STOP, | ||
| 59 | 'gtk-clear' => $self->RESPONSE_CLEAR, | ||
| 60 | 'gtk-close' => 'close', | ||
| 61 | 'gtk-help' => 'help'); | ||
| 62 | $self->signal_connect (response => \&_do_response); | ||
| 63 | my $vbox = $self->vbox; | ||
| 64 | |||
| 65 | my $heading = Gtk2::Label->new (__"Compact and clean out the database.\n(May take a while if the database is big.)"); | ||
| 66 | $heading->set (justify => 'center'); | ||
| 67 | $vbox->pack_start ($heading, 0,0,0); | ||
| 68 | |||
| 69 | { | ||
| 70 | my $button = $self->{'consistency'} | ||
| 71 | = Gtk2::CheckButton->new_with_label (__('Consistency Checks')); | ||
| 72 | $button->set_active (1); | ||
| 73 | $vbox->pack_start ($button, 0, 0, 0); | ||
| 74 | } | ||
| 75 | { | ||
| 76 | my $button = $self->{'compact'} | ||
| 77 | = Gtk2::CheckButton->new_with_label (__('Compact Files')); | ||
| 78 | $button->set_active (1); | ||
| 79 | $vbox->pack_start ($button, 0, 0, 0); | ||
| 80 | } | ||
| 81 | { | ||
| 82 | my $button = $self->{'verbose'} | ||
| 83 | = Gtk2::CheckButton->new_with_label (__('Verbose')); | ||
| 84 | $vbox->pack_start ($button, 0, 0, 0); | ||
| 85 | } | ||
| 86 | |||
| 87 | my $textbuf = $self->{'textbuf'} = Gtk2::TextBuffer->new; | ||
| 88 | |||
| 89 | # clear button sensitive when there is in fact something to clear | ||
| 90 | Glib::Ex::ConnectProperties->new | ||
| 91 | ([$textbuf, 'textbuffer#not-empty'], | ||
| 92 | [$self, 'response-sensitive#'.$self->RESPONSE_CLEAR]); | ||
| 93 | |||
| 94 | require Gtk2::Ex::TextView::FollowAppend; | ||
| 95 | my $textview = $self->{'textview'} | ||
| 96 | = Gtk2::Ex::TextView::FollowAppend->new_with_buffer ($textbuf); | ||
| 97 | $textview->set (wrap_mode => 'char', | ||
| 98 | editable => 0); | ||
| 99 | |||
| 100 | my $scrolled = Gtk2::ScrolledWindow->new(); | ||
| 101 | $scrolled->add($textview); | ||
| 102 | $scrolled->set_policy('never', 'always'); | ||
| 103 | $vbox->pack_start ($scrolled, 1, 1, 0); | ||
| 104 | |||
| 105 | my $status = $self->{'status'} | ||
| 106 | = Gtk2::Label->new ("Press Start to begin vacuuming ...\n"); | ||
| 107 | $vbox->pack_start ($status, 0,0,0); | ||
| 108 | |||
| 109 | _update_stop_sensitive ($self); | ||
| 110 | $vbox->show_all; | ||
| 111 | |||
| 112 | # with sensible message area size | ||
| 113 | Gtk2::Ex::Units::set_default_size_with_subsizes | ||
| 114 | ($self, | ||
| 115 | [$textview, '60 ems', -1], | ||
| 116 | [$scrolled, -1, '6 lines']); | ||
| 117 | } | ||
| 118 | |||
| 119 | # 'destroy' class closure | ||
| 120 | # this can be called more than once! | ||
| 121 | sub _do_destroy { | ||
| 122 | my ($self) = @_; | ||
| 123 | ### VacuumDialog destroy | ||
| 124 | |||
| 125 | delete $self->{'model_ids'}; | ||
| 126 | |||
| 127 | # break circular references | ||
| 128 | delete $self->{'textview'}; | ||
| 129 | delete $self->{'textbuf'}; | ||
| 130 | |||
| 131 | return shift->signal_chain_from_overridden(@_); | ||
| 132 | } | ||
| 133 | |||
| 134 | # 'response' signal handler | ||
| 135 | sub _do_response { | ||
| 136 | my ($self, $response) = @_; | ||
| 137 | ### VacuumDialog response: $response | ||
| 138 | |||
| 139 | if ($response eq RESPONSE_START) { | ||
| 140 | my $textbuf = $self->{'textbuf'}; | ||
| 141 | $textbuf->delete ($textbuf->get_start_iter, $textbuf->get_end_iter); | ||
| 142 | $self->start; | ||
| 143 | |||
| 144 | } elsif ($response eq RESPONSE_STOP) { | ||
| 145 | $self->stop; | ||
| 146 | |||
| 147 | } elsif ($response eq RESPONSE_CLEAR) { | ||
| 148 | my $textbuf = $self->{'textbuf'}; | ||
| 149 | $textbuf->delete ($textbuf->get_start_iter, $textbuf->get_end_iter); | ||
| 150 | _remove_done_job ($self); | ||
| 151 | |||
| 152 | } elsif ($response eq 'close') { | ||
| 153 | # as per a keyboard close, defaults to raising 'delete-event', which in | ||
| 154 | # turn defaults to a destroy | ||
| 155 | $self->signal_emit ('close'); | ||
| 156 | |||
| 157 | } elsif ($response eq 'help') { | ||
| 158 | # require App::Chart::Manual; | ||
| 159 | # App::Chart::Manual->open(__p('manual-node','Vacuum'), $self); | ||
| 160 | } | ||
| 161 | } | ||
| 162 | |||
| 163 | sub start { | ||
| 164 | my ($self) = @_; | ||
| 165 | $self->stop; | ||
| 166 | $self->{'status'}->set_text (__('Starting vacuum job')); | ||
| 167 | $self->message (__("Vacuuming ...\n")); | ||
| 168 | require App::Chart::Gtk2::Job; | ||
| 169 | my $job = $self->{'job'} = App::Chart::Gtk2::Job->start | ||
| 170 | (args => ['vacuum', | ||
| 171 | (map { ($_, $self->{$_}->get_active) } | ||
| 172 | 'compact', 'consistency', 'verbose') ], | ||
| 173 | name => __('Vacuum database')); | ||
| 174 | $job->signal_connect (message => \&_do_job_message, | ||
| 175 | App::Chart::Glib::Ex::MoreUtils::ref_weak($self)); | ||
| 176 | $job->signal_connect (status_changed => \&_do_job_status, | ||
| 177 | App::Chart::Glib::Ex::MoreUtils::ref_weak($self)); | ||
| 178 | _update_stop_sensitive ($self); | ||
| 179 | return $job; | ||
| 180 | } | ||
| 181 | sub stop { | ||
| 182 | my ($self) = @_; | ||
| 183 | my $job = $self->{'job'} || return; | ||
| 184 | $job->stop; | ||
| 185 | _remove_done_job ($self); | ||
| 186 | } | ||
| 187 | sub _remove_done_job { | ||
| 188 | my ($self) = @_; | ||
| 189 | my $job = $self->{'job'} || return; | ||
| 190 | if ($job->is_done) { | ||
| 191 | ### VacuumDialog: removing done job | ||
| 192 | delete $self->{'job'}; | ||
| 193 | App::Chart::Gtk2::JobQueue->remove_job ($job); | ||
| 194 | } | ||
| 195 | } | ||
| 196 | |||
| 197 | # 'message' signal handler for App::Chart::Gtk2::Job | ||
| 198 | sub _do_job_message { | ||
| 199 | my ($job, $str, $ref_weak_self) = @_; | ||
| 200 | my $self = $$ref_weak_self || return; | ||
| 201 | $self->message ($str); | ||
| 202 | } | ||
| 203 | sub message { | ||
| 204 | my ($self, $str) = @_; | ||
| 205 | my $textbuf = $self->{'textview'}->get_buffer; | ||
| 206 | $textbuf->insert ($textbuf->get_end_iter, $str); | ||
| 207 | } | ||
| 208 | |||
| 209 | # 'status-changed' signal handler for App::Chart::Gtk2::Job | ||
| 210 | sub _do_job_status { | ||
| 211 | my ($job, $str, $ref_weak_self) = @_; | ||
| 212 | ### VacuumDialog: job status: $str | ||
| 213 | my $self = $$ref_weak_self || return; | ||
| 214 | $self->{'status'}->set_text ($str); | ||
| 215 | _update_stop_sensitive ($self); | ||
| 216 | |||
| 217 | if ($job->is_done) { | ||
| 218 | $self->message (__("done\n")); | ||
| 219 | } | ||
| 220 | } | ||
| 221 | |||
| 222 | sub _update_stop_sensitive { | ||
| 223 | my ($self) = @_; | ||
| 224 | my $job = $self->{'job'}; | ||
| 225 | my $running = $job && $job->is_stoppable; | ||
| 226 | $self->set_response_sensitive (RESPONSE_START, ! $running); | ||
| 227 | $self->set_response_sensitive (RESPONSE_STOP, $running); | ||
| 228 | } | ||
| 229 | |||
| 230 | 1; | ||
| 231 | __END__ |