This file is indexed.

/usr/share/perl5/RoPkg/Rsync/LogParser.pm is in libropkg-perl 0.4-1.1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  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
############################################################################
##      Copyright (C) 2006 Subredu Manuel  <diablo@iasi.roedu.net>.        #
##                                                                         #
## 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.                                                      #
############################################################################

package RoPkg::Rsync::LogParser;

use strict;
use warnings;

use Scalar::Util qw(blessed);
use English      qw(-no_match_vars);
use Data::Dumper;
use RoPkg::Exceptions;

use vars qw($VERSION);
$VERSION='0.1';

sub new {
  my ($class, %opt) = @_;
  my $self;
  
  $self = bless { %opt }, $class;

  if (!$self->{type}) {
    Param::Missing->throw('log type not specified');
  }

  if ($self->{type} ne 'server' &&
      $self->{type} ne 'client') {
    Param::Wrong->throw('log type not know to me');
  }

  $self->_create_get_methods();

  return $self;
}

#
# Get/Set the raw rsync log
# 
sub Log {
  my ($self, $raw_log) = @_;

  if ( !blessed($self) ) {
    OutsideClass->throw('Called outside class instance');
  }

  if ( !$raw_log ) {
    return $self->{_raw_log};
  }
  else {
    return ($self->{_raw_log} = $raw_log);
  }
}

#
# Get/Set rsync probes list
#
sub Probes {
  my ($self, @probes) = @_;

  if ( !blessed($self) ) {
    OutsideClass->throw('Called outside class instance');
  }

  if ( !@probes ) {
    if ( $self->{_probes} ) {
      return @{ $self->{_probes} };
    }
    else {
      return 0;
    }
  }
  else {
    push @{ $self->{_probes} }, @probes;
    return scalar(@{ $self->{_probes} });
  }
}

sub _read_log_file {
  my ($self, $filename) = @_;
  my $fh;

  if ( ! -f $filename ) {
    Param::Wrong->throw("$filename is not a file");
  }

  if ( ! open($fh, '<', $filename) ) {
    File::Open->throw("Could not open $filename");
  }

  {
    local $RS;
    $self->{_raw_log} = <$fh>;
  }

  close($fh);

  return scalar($self->{_raw_log});
}

sub _clean {
  my ($self) = @_;

  $self->{_transfered_files} =
  $self->{_real_transfered_files} =
  $self->{_deleted} =
  $self->{_real_deleted} =
  $self->{_speed} =
  $self->{_size} =
  $self->{_transfered_bytes} =
  $self->{_symlinks} =
  $self->{_symlink_targets} =
  $self->{_real_symlinks} =
  $self->{_real_symlink_targets} =
  ();

  return ();
}

###################################
# rsync client log parser - BEGIN #
###################################

sub Parse {
  my ($self, $filename) = @_;
  my $inside = 0;

  if ( !blessed($self) ) {
    OutsideClass->throw('Called outside class instance');
  }

  $self->_clean();

  if ( $filename ) {
    $self->_read_log_file($filename);
  }

  if ( !$self->{_raw_log} ) {
    return 0;
  }

  foreach(split(/[\n\r]/xm, $self->{_raw_log})) {
    my $line = $_;

    next if ( $line =~ m{^\s*$}xm );

    if ( $line =~ m{^receiving \s file .*}xm ) {
      $inside = 1;
      next;
    }

    if ( $line =~ m{^(sent|wrote).*}xm || $line =~ m{^total \s+ size.*}xm ) {
      $self->_parse_report($line);
      next;
    }

    if ( $line =~ m{^deleting.*}xm ) {
      $self->_parse_delete($line);
      next;
    }

    if ( $line =~ m{.* (-|=)> .*}xm ) {
      $self->_parse_symlink($line);
      next;
    }

    next if ( !$inside );
    next if ( $line =~ m{^created \s .*$}xm );

    if ( !$self->_is_probe($line) ) {
      push @{ $self->{_transfered_files} }, $line;
    }

    push @{ $self->{_real_transfered_files} }, $line;
  }

  return 1;
}

sub _parse_delete {
  my ($self, $line) = @_;

  $line =~ s/deleting\s*//xm;

  if ( !$self->_is_probe($line) ) {
    push @{ $self->{_deleted} }, $line;
  }

  push @{ $self->{_real_deleted} }, $line;
  return scalar (@{ $self->{_deleted} });
}

sub _parse_symlink {
  my ($self, $line) = @_;

  my @lines = split(/[\s\-=>]+/xm, $line);
  if ( !$self->_is_probe($lines[0]) && !$self->_is_probe($lines[1]) ) {
    push @{ $self->{_symlinks} }, $lines[0];
    push @{ $self->{_symlink_targets} }, $lines[1];
  }

  push @{ $self->{_real_symlinks} }, $lines[0];
  push @{ $self->{_real_symlink_targets} }, $lines[1];

  return 1;
}

sub _parse_report {
  my ($self, $line) = @_;

  if ( $line =~ m{^(sent|wrote) \s+ (\d+) \s+ bytes \s+
                   (received|read) \s+ (\d+) \s+ bytes \s+
                   ([0-9.]+) \s+ bytes\/sec$}xm ) {
    $self->{_transfered_bytes} = $4;
    $self->{_speed} = $5;
  }
  elsif ( $line =~ m{^total \s+ size \s+ is \s+ (\d+)\s.*$}xm ) {
    $self->{_size} = $1;
  }

  return 1;
}

sub _is_probe {
  my ($self, $pname) = @_;

  foreach(@{ $self->{_probes} }) {
    return 1 if ( $_ eq $pname );
  }

  return 0;
}

###################################
# rsync client log parser -   END #
###################################

#######################
# GET methods - BEGIN #
#######################

sub _get_value {
  my ($self, $pname) = @_;

  if ( !defined($self->{$pname}) ) {
    if ( wantarray ) {
      return ();
    }
    else {
      return 0;
    }
  }

  # if we have a array
  if ( ref($self->{$pname}) eq 'ARRAY' ) {
    return (wantarray ? @{$self->{$pname}} : (scalar @{ $self->{$pname} }));
  }
  else {
    return $self->{$pname};
  }
}

# Here we have to create some wrappers around _get_value.
# Since the code is almost the same for all methods, I
# created the methods dynamically at runtime. Since this
# may not be the best  way to write the methods, is the
# shortest.
sub _create_get_methods {
  my ($self) = @_;

  my $mmaper = {
    'Files'       => '_transfered_files',
    'RealFiles'   => '_real_transfered_files',
    'Deleted'     => '_deleted',
    'RealDeleted' => '_real_deleted',
    'Speed'       => '_speed',
    'Size'        => '_size',
    'TransfData'  => '_transfered_bytes',
  };

  no strict 'refs';
  foreach(keys(%{ $mmaper })) {
    my $pname = $_;
    my $pval  = $mmaper->{$pname};

    next if ( $self->can($pname) );
    *{'RoPkg::Rsync::LogParser::' . $pname} = sub {
                                               my ($self) = @_;

                                               if (!blessed($self)) {
                                                 OutsideClass->throw('Called outside class instance');
                                               }

                                               return $self->_get_value($pval);
    };
  }
  use strict;

  return keys(%{ $mmaper });
}

# Returns a reference to a hash in which the keys are the symlinks,
# and the values are symlinks targets.
sub Symlinks {
  my ($self) = @_;
  my $result = ();
  my $i = 0;

  if ( !blessed($self) ) {
    OutsideClass->throw('Called outside class instance');
  }

  foreach(@{ $self->{_symlinks} }) {
    $result->{$_} = $self->{_symlink_targets}->[$i];
    $i++;
  }

  return $result;
}

# Returns a reference to a hash in which the keys are the symlinks,
# and the values are symlinks targets.
sub RealSymlinks {
  my ($self) = @_;
  my $result = ();
  my $i = 0;

  if ( !blessed($self) ) {
    OutsideClass->throw('Called outside class instance');
  }

  foreach(@{ $self->{_real_symlinks} }) {
    $result->{$_} = $self->{_real_symlink_targets}->[$i];
    $i++;
  }

  return $result;
}


#######################
# GET methods -   END #
#######################

1;

__END__

=head1 NAME

RoPkg::Rsync::LogParser - a rsync log parser class

=head1 SYNOPSIS

 #!/usr/bin/perl
 
 use strict;
 use warning;

 sub main {
   my $lp = new RoPkg::Rsync::LogParser( type => 'client' );

   $lp->Parse('/tmp/debian-log.txt');
 }

 main();

=head1 Short description

RoPkg::Rsync::LogParser is a class used to parse (for the moment)
client side rsync logs. Using this class you can extract the
transfered files, symlinks created, directories, total number
of files, transfered bytes, speed of transfer etc. LogParser
support list filter trough probes (used by many projects to
verify the mirrors). The primary use of this class is inside
Simba, but can be used without problems in any other project
who needs a rsync client log parser.

=head1 METHODS

=head2 new(hash)

Constructor of the class. When creating a new class instance
you must provide the type of log: B<client> or B<server> . For
the moment only the client parsing routines are defined.

=head2 Log($raw_log)

Get/Set the raw rsync log. With no parameters, the get behaviour
is selected. If a parameter is present (and valid) the method
acts as a Set method.

=head2 Probes(@probes_list)

Get/Set the raw probes list. If no parameter is present, the method
returns the number of probes defined (0 if none). If a list of probes
is given, the list is added to the existing list of probes.

=head2 Parse($filename)

Parse a rsync client log. If no filename is specified, the method
parses the log previsiously set with Log() method. Please take
extra care with the filename. If it does not exists, or is not
a file a exception will be raised (Param::Wrong and File::Open).

=head2 Files()

In scalar context returns the number of transfered files (filtered
by probes list). In list context, returns the list of transfered files.

=head2 RealFiles()

In scalar context returns the number of transfered files. In list
context, returns the list of transfered files.

=head2 Deleted()

In scalar context returns the number of deleted files (filtered
by probes list). In list context, returns the list of deleted files.

=head2 RealDeleted()

In scalar context returns the number of deleted files.
In list context, returns the list of deleted files.

=head2 Speed()

Returns the speed (as reported by rsync [in bytes/sec]) of the 
transfer.

=head2 Size()

Returns the size of the synced content.

=head2 TransfData()

Returns the total number of bytes transfered during the sync session

=head2 Symlinks()

In scalar context returns the number of symlinks (filtered
by probes list). In list context, returns the list of symlinks.

=head2 RealSymlinks()

In scalar context returns the number of symlinks.
In list context, returns the list of symlinks.

=head1 PREREQUISITES

RoPkg::Utils requires perl 5.008 or later and RoPkg::Exceptions class. From CPAN,
you need the Scalar::Util module. At build time Test::More is required for tests (if you don't
plan to use the tests ignore this dependency).

=head1 SEE ALSO

L<RoPkg::Rsync::Node> L<RoPkg::Rsync::ConfFile> L<RoPkg::Exceptions>

=head1 AUTHOR

Subredu Manuel <diablo@iasi.roedu.net>

=head1 LICENSE

Copyright (C) 2005 Subredu Manuel.  All Rights Reserved.
This module is free software; you can redistribute it 
and/or modify it under the same terms as Perl itself.
The LICENSE file contains the full text of the license.

=cut