aboutsummaryrefslogtreecommitdiffstats
path: root/lib/AdminPanel/Module/LogViewer.pm
blob: aeb31d6a68a1860808e3f4893d47c7719f0d483d (plain)
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
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
# vim: set et ts=4 sw=4:
package AdminPanel::Module::LogViewer;
#============================================================= -*-perl-*-

=head1 NAME

AdminPanel::Module::LogViewer - Log viewer

=head1 SYNOPSIS

   my $logViewer = AdminPanel::Module::LogViewer->new();
   $logViewer->start();

=head1 DESCRIPTION

Log viewer is a backend to journalctl, it can also load a custom
file.


=head1 SUPPORT

You can find documentation for this module with the perldoc command:

perldoc AdminPanel::Module::::LogViewer

=head1 AUTHOR

Angelo Naselli <anaselli@linux.it>

=head1 COPYRIGHT and LICENSE

Copyright (C) 2014, Angelo Naselli.

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License version 2, as
published by the Free Software Foundation.

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

=head1 FUNCTIONS

=cut

use strict;
use open OUT => ':utf8';

use AdminPanel::Shared;
use AdminPanel::Shared::Locales;
use AdminPanel::Shared::Services qw (services);
use AdminPanel::Shared::JournalCtl;


use POSIX qw/strftime floor/;
use Date::Simple ();
use File::HomeDir qw(home);

use Moose;
use yui;

extends qw( AdminPanel::Module );

### TODO icon 
has '+icon' => (
    default => "/usr/share/mcc/themes/default/logdrake-mdk.png",
);

# has '+name' => (
#     default => undef, 
# );

has 'loc' => (
        is => 'rw',
        init_arg => undef,
        builder => '_localeInitialize'
);

sub _localeInitialize {
    my $self = shift();

    # TODO fix domain binding for translation
    $self->loc(AdminPanel::Shared::Locales->new(domain_name => 'libDrakX-standalone') );
    # TODO if we want to give the opportunity to test locally add dir_name => 'path'
}

=head1 VERSION

Version 1.0.0

=cut

our $VERSION = '1.0.0';


my %prior = ('emerg'   => 0, 
             'alert'   => 1, 
             'crit'    => 2, 
             'err'     => 3, 
             'warning' => 4, 
             'notice'  => 5, 
             'info'    => 6, 
             'debug'   => 7);


#=============================================================

=head2 BUILD

=head3 INPUT

    $self: this object

=head3 DESCRIPTION

    The BUILD method is called after a Moose object is created,
    in this methods Services loads all the service information.

=cut

#=============================================================
sub BUILD {
    my $self = shift;

    if (! $self->name) {
        $self->name ($self->loc->N("Log viewer"));
    }
}


#=============================================================

=head2 start

=head3 INPUT

    $self: this object

=head3 DESCRIPTION

    This method extends Module::start and is invoked to
    start  adminService

=cut

#=============================================================
sub start {
    my $self = shift;

    $self->_logViewerPanel();
};





sub _logViewerPanel {
    my $self = shift;
    
    if(!$self->_warn_about_user_mode()) {
        return 0;
    }
    
    my $appTitle = yui::YUI::app()->applicationTitle();
    
    ## set new title to get it in dialog
    yui::YUI::app()->setApplicationTitle($self->name);
    ## set icon if not already set by external launcher
    yui::YUI::app()->setApplicationIcon($self->icon);
    
    my $factory    = yui::YUI::widgetFactory;
    my $optFactory = yui::YUI::optionalWidgetFactory;
    
    # Create Dialog
    my $dialog  = $factory->createMainDialog;
    
    # Start Dialog layout:
    my $vbox    = $factory->createVBox( $dialog );
    my $align = $factory->createAlignment($vbox, $yui::YAlignCenter, $yui::YAlignUnchanged);
    $factory->createLabel( $align, $self->loc->N("A tool to monitor your logs"), 1, 0 );
    
    #### matching
    my $hbox = $factory->createHBox($vbox);
    my $matchingInputField = $factory->createInputField($hbox, $self->loc->N("Matching"));
    $factory->createHSpacing($hbox, 1);
    
    #### not matching
    my $notMatchingInputField = $factory->createInputField($hbox, $self->loc->N("but not matching"));
    $matchingInputField->setWeight($yui::YD_HORIZ, 1);
    $notMatchingInputField->setWeight($yui::YD_HORIZ, 1);
    
    my $frame = $factory->createFrame($vbox, $self->loc->N("Options"));
    $hbox = $factory->createHBox($frame);
    
    #### lastBoot
    $align = $factory->createAlignment($hbox, $yui::YAlignBegin, $yui::YAlignBegin);
    my $vbox1 = $factory->createVBox( $align );
    $align = $factory->createAlignment($vbox1, $yui::YAlignBegin, $yui::YAlignBegin);
    my $lastBoot = $factory->createCheckBoxFrame($align, $self->loc->N("Last boot"), 1);
    $align = $factory->createLeft($lastBoot);
    my $lbl = $factory->createLabel( $align, "  " );
    $lastBoot->setNotify(1);
    
    #### since and until 
    $align    = $factory->createAlignment($vbox1, $yui::YAlignBegin, $yui::YAlignBegin);
    my $hbox1 = $factory->createHBox( $align );
    $align    = $factory->createAlignment($hbox1, $yui::YAlignBegin, $yui::YAlignBegin);
    my $sinceDate;
    my $sinceFrame = $factory->createCheckBoxFrame($align, $self->loc->N("Since"), 1);
    $sinceFrame->setNotify(1);
    my $untilDate;
    $align = $factory->createAlignment($hbox1, $yui::YAlignBegin, $yui::YAlignBegin);
    my $untilFrame = $factory->createCheckBoxFrame($align, $self->loc->N("Until"), 1);
    $untilFrame->setNotify(1);
    if ($optFactory->hasDateField()) {
        $align = $factory->createLeft($sinceFrame);
        $sinceDate = $optFactory->createDateField($align, "");
        my $day = strftime "%F", localtime;
        $sinceDate->setValue($day);
        $align = $factory->createLeft($untilFrame);
        $untilDate = $optFactory->createDateField($align, "");
        $untilDate->setValue($day);
    }
    else {
        $sinceFrame->enable(0);
        $untilFrame->enable(0);
    }

    
    #### units
    $vbox1 = $factory->createVBox( $hbox );
    $align = $factory->createAlignment($vbox1, $yui::YAlignBegin, $yui::YAlignBegin);
    my $unitsFrame = $factory->createCheckBoxFrame($align, $self->loc->N("Select a unit"), 1);
    $unitsFrame->setNotify(1);
    $align = $factory->createLeft($unitsFrame);
    my $units = $factory->createComboBox  ( $align, "" );
    my $itemCollection = new yui::YItemCollection;

    yui::YUI::app()->busyCursor();
    my ($l, $active_services) = AdminPanel::Shared::Services::services();

    foreach (@{$active_services}) {
        my $serviceName = $_;
        my $item = new yui::YItem($serviceName);
        $itemCollection->push($item);
        $item->DISOWN();
    }
    $units->addItems($itemCollection);
    yui::YUI::app()->normalCursor();
    

    #### priority
    $align = $factory->createAlignment($vbox1, $yui::YAlignBegin, $yui::YAlignBegin);
    $hbox1 = $factory->createHBox( $align );
    # From
    my $priorityFromFrame = $factory->createCheckBoxFrame($hbox1, $self->loc->N("From priority"), 1);
    $priorityFromFrame->setNotify(1);
    my $priorityFrom = $factory->createComboBox  ( $priorityFromFrame, "" );
    $itemCollection->clear();
    
    my @pr = ('emerg', 'alert', 'crit', 'err', 
             'warning', 'notice', 'info', 'debug');
    foreach (@pr) {
        my $item = new yui::YItem($_);
        if ( $_ eq 'emerg' ) {
            $item->setSelected(1);
        }
        $itemCollection->push($item);
        $item->DISOWN();
    }
    $priorityFrom->addItems($itemCollection);

    # To
    my $priorityToFrame = $factory->createCheckBoxFrame($hbox1, $self->loc->N("To priority"), 1);
    $priorityToFrame->setNotify(1);
    my $priorityTo = $factory->createComboBox  ( $priorityToFrame, "" );
    $itemCollection->clear();
       
    foreach (@pr) {
        my $item = new yui::YItem($_);
        if ( $_ eq 'debug' ) {
            $item->setSelected(1);
        }
        $itemCollection->push($item);
        $item->DISOWN();
    }
    $priorityTo->addItems($itemCollection);
  
    #### search
    $align = $factory->createRight($vbox);
    my $searchButton = $factory->createPushButton($align, $self->loc->N("search"));
  
    #### create log view object
    my $logView = $factory->createLogView($vbox, $self->loc->N("Log content"), 10, 0);

    
    ### NOTE CheckBoxFrame doesn't honoured his costructor checked value for his children
    $unitsFrame->setValue(0);
    $sinceFrame->setValue(0);
    $untilFrame->setValue(0);
    $priorityFromFrame->setValue(0);
    $priorityToFrame->setValue(0);

    # buttons on the last line 
    $align = $factory->createRight($vbox);
    $hbox = $factory->createHBox($align);
    my $aboutButton = $factory->createPushButton($hbox, $self->loc->N("About") );
    $align = $factory->createRight($hbox);
    $hbox     = $factory->createHBox($align);
    my $saveButton = $factory->createPushButton($hbox, $self->loc->N("Save"));
    my $quitButton = $factory->createPushButton($hbox, $self->loc->N("Quit"));

    # End Dialof layout 
    
    while(1) {
        my $event       = $dialog->waitForEvent();
        my $eventType   = $event->eventType();
        
        #event type checking
        if ($eventType == $yui::YEvent::CancelEvent) {
            last;
        }
        elsif ($eventType == $yui::YEvent::WidgetEvent) {
            # widget selected
            my $widget = $event->widget();
            if ($widget == $quitButton) {
                last;
            }
            elsif($widget == $aboutButton) {
                my $license = $self->loc->N($AdminPanel::Shared::License);
                
                AdminPanel::Shared::AboutDialog({ name => $self->name,
                    version => $self->VERSION, 
                    copyright => $self->loc->N("Copyright (C) %s Mageia community", '2014'),
                    license => $license, 
                    comments => $self->loc->N("Log viewer is a systemd journal viewer."),
                    website => 'http://www.mageia.org',
                    website_label => $self->loc->N("Mageia"),
                    authors => "Angelo Naselli <anaselli\@linux.it>\nMatteo Pasotti <matteo.pasotti\@gmail.com>",
                    translator_credits =>
                        #-PO: put here name(s) and email(s) of translator(s) (eg: "John Smith <jsmith@nowhere.com>")
                        $self->loc->N("_: Translator(s) name(s) & email(s)\n")}
                );
            }            
            elsif($widget == $saveButton) {
                if ($logView->lines()) {
                    $self->_save($logView);
                }
                else {
                   AdminPanel::Shared::warningMsgBox($self->loc->N("Empty log found"));
                }
            }
            elsif ($widget == $searchButton) {
                yui::YUI::app()->busyCursor();
                $dialog->startMultipleChanges();
                $logView->clearText();
                my %log_opts;
                if ($lastBoot->value()) {
                    $log_opts{this_boot} = 1;
                }
                if ($unitsFrame->value()) {
                     $log_opts{unit} = $units->value();
                }
                if ($sinceFrame->value()) {
                    $log_opts{since} = $sinceDate->value();
                }
                if ($untilFrame->value()) {                    
                    $log_opts{until} = $untilDate->value();
# TODO check date until > date since                    
                }
                if ($priorityFromFrame->value() || $priorityToFrame->value()) {
                    my $prio = $priorityFrom->value();
                    $prio .= "..".$priorityTo->value() if ($priorityToFrame->value());
                    $log_opts{priority} = $prio;
# TODO enabling right using checkBoxes                    
                }
                my $log = $self->_search(\%log_opts);
print " log lines: ". scalar (@{$log}) ."\n";                
# TODO check on log line number what to do if too big? and adding a progress bar?                
                $self->_parse_content({'matching'   => $matchingInputField->value(),
                                       'noMatching' => $notMatchingInputField->value(),
                                       'log'        => $log,
                                       'logView'    => $logView,
                                      }
                );
                $dialog->recalcLayout();
                $dialog->doneMultipleChanges();
                yui::YUI::app()->normalCursor();
            }
            elsif ($widget == $lastBoot) {
                yui::YUI::ui()->blockEvents();
                if ($lastBoot->value()) {
                    #last boot overrrides until and since
                    $sinceFrame->setValue(0);
                    $untilFrame->setValue(0);
                }
                yui::YUI::ui()->unblockEvents();
            }
            elsif ($widget == $sinceFrame) {
                yui::YUI::ui()->blockEvents();
                if ($sinceFrame->value()) {
                    #disabling last boot that overrrides until and since
                    $lastBoot->setValue(0);
                }
                yui::YUI::ui()->unblockEvents();
            }
            elsif ($widget == $untilFrame) {
                yui::YUI::ui()->blockEvents();
                if ($untilFrame->value()) {
                    #disabling last boot that overrrides until and since
                    $lastBoot->setValue(0);
                }
                yui::YUI::ui()->unblockEvents();
            }
            elsif ($widget == $priorityFromFrame) {
                if ($priorityToFrame->value() && !$priorityFromFrame->value()) {
                     yui::YUI::ui()->blockEvents();
                     $priorityToFrame->setValue(0) ;
                     yui::YUI::ui()->unblockEvents();
                }
            }
            elsif ($widget == $priorityToFrame) {
                if ($priorityToFrame->value() && !$priorityFromFrame->value()) {
                     yui::YUI::ui()->blockEvents();
                     $priorityFromFrame->setValue(1) ;
                     yui::YUI::ui()->unblockEvents();
                }
            }
        
        }
    }
    $dialog->destroy();
    
    #restore old application title
    yui::YUI::app()->setApplicationTitle($appTitle) if $appTitle;
}



sub _warn_about_user_mode {
    my $self = shift;

    my $title = $self->loc->N("Running in user mode");
    my $msg   = $self->loc->N("You are launching this program as a normal user.\n".
                              "You will not be able to read system logs which you do not have rights to,\n".
                              "but you may still browse all the others.");
    
    # $EUID:  effective user identifier
    if(($> != 0) and (!ask_YesOrNo($title, $msg))) {
        # TODO add Privileges? 
        return 0;
    }

    return 1;
}


## Save as
#
# $logView: log Widget
#
##
sub _save {
    my ($self, $logView) = @_;
    
    yui::YUI::app()->busyCursor();

    my $outFile = yui::YUI::app()->askForSaveFileName(home(), "*", $self->loc->N("Save as.."));
    if ($outFile) {
        open(OF, ">".$outFile);
        print OF $logView->logText();
        close OF;
    }
    
    yui::YUI::app()->normalCursor();
}

## Search call back
sub _search {
    my ($self, $log_opts) = @_;

$DB::single = 1;
    my $log = AdminPanel::Shared::JournalCtl->new(%{$log_opts});
    my $all = $log->getLog();
    
    return $all;
}

## _parse_content
#
#  $info : HASH cotaining 
#
#  matching:    string to match
#  notMatching: string to skip
#  log:         ARRAY REF to log content
#  logViewer:   logViewer Widget
#
##
sub _parse_content {
    my ($self, $info) = @_;

    $DB::single = 1;
    
    my $ey = "";
    my $en = "";
    
    if( exists($info->{'matching'} ) ){
         $ey = $info->{'matching'};
    }
    if( exists($info->{'noMatching'} ) ){
         $en = $info->{'noMatching'};
    }
    
    $ey =~ s/ OR /|/ if ($ey);
    $ey =~ s/^\*$//  if ($ey);
    $en =~ s/^\*$/.*/ if ($en);

    my $test;

    if ($en && !$ey) {
        $test = sub { $_[0] !~ /$en/ };
    } 
    elsif ($ey && !$en) {
        $test = sub { $_[0] =~ /$ey/ };
    } 
    elsif ($ey && $en) {
        $test = sub { $_[0] =~ /$ey/ && $_[0] !~ /$en/ };
    } 
    else {
        $test = sub { $_[0] };
    }

    foreach (@{$info->{log}}) {
        $info->{logView}->appendLines($_) if $test->($_);
    }
  
}


1