ropkg::rsync::logparser(3pm) [debian man page]
RoPkg::Rsync::LogParser(3pm) User Contributed Perl Documentation RoPkg::Rsync::LogParser(3pm) NAME
RoPkg::Rsync::LogParser - a rsync log parser class 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(); 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. METHODS
new(hash) Constructor of the class. When creating a new class instance you must provide the type of log: client or server . For the moment only the client parsing routines are defined. 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. 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. 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). Files() In scalar context returns the number of transfered files (filtered by probes list). In list context, returns the list of transfered files. RealFiles() In scalar context returns the number of transfered files. In list context, returns the list of transfered files. Deleted() In scalar context returns the number of deleted files (filtered by probes list). In list context, returns the list of deleted files. RealDeleted() In scalar context returns the number of deleted files. In list context, returns the list of deleted files. Speed() Returns the speed (as reported by rsync [in bytes/sec]) of the transfer. Size() Returns the size of the synced content. TransfData() Returns the total number of bytes transfered during the sync session Symlinks() In scalar context returns the number of symlinks (filtered by probes list). In list context, returns the list of symlinks. RealSymlinks() In scalar context returns the number of symlinks. In list context, returns the list of symlinks. 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). SEE ALSO
RoPkg::Rsync::Node RoPkg::Rsync::ConfFile RoPkg::Exceptions AUTHOR
Subredu Manuel <diablo@iasi.roedu.net> 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. perl v5.8.8 2006-06-09 RoPkg::Rsync::LogParser(3pm)
Check Out this Related Man Page
RoPkg::Rsync::Atom(3pm) User Contributed Perl Documentation RoPkg::Rsync::Atom(3pm) NAME
RoPkg::Rsync::Atom - the smallest unit in a rsync configuration file SYPONSIS
#!/usr/bin/perl use strict; use warnings; use RoPkg::Rsync::Atom; sub main { my $a = new RoPkg::Rsync::Atom( type => 'param', name => 'uid', value => 'nobody', ); print $a->ToString(0),$/; return 0; } main(); DESCRIPTION
RoPkg::Rsync::Atom is a class used by RoPkg::Rsync modules. The Atom is considered the smallest part of any rsync configuration file. An atom can be (at this moment): param blank comment METHODS
All methods, throw the OutsideClass exception, if you use them as class methods. Example: perl -MRoPkg::Rsync::Atom -e 'RoPkg::Rsync::Atom->Type;' Called outside class instance Besides OutsideClass the methods are throwing other exceptions as well. Refer to each method documentation for more information. new() The constructor of the class. new accepts 3 parameters grouped inside a hash: *) type - type of the atom *) name - name of the atom *) value - value of the atom The type parameter must always be present. If the type parameter is not present, a Param::Missing exception is raised. At this moment, the atoms have 3 types: *) param - a parameter in the standard form (name = value) *) comment - a comment *) blank - a blank line (or only with separators) If the value of the type parameter is not one of the ones specified a Param::Wrong exception is raised. Examples: example 1 (param): my $a = new RoPkg::Rsync::Atom( type => 'param', name => 'gid', value => 'users', ); example 2 (param): my $a = new RoPkg::Rsync::Atom(type => 'param'); $a->Name('gid'); $a->Value('users'); print 'Name of the atom is:',$a->Name,$/; example 3 (comment): my $a = new RoPkg::Rsync::Atom( type => 'comment', value => '# this is the group id', ); example 4 (blank): my $a = new RoPkg::Rsync::Atom( type => 'blank', value => q{ }, ); Name($new_name) The Name method is a get/set method. If $new_name exists (and his value is defined) then the set behaviour is selected, otherwise the method acts as a get method. Returns the name of the atom. Value($new_value) The Value method is a get/set method. If $new_value exists (and his value is defined) then the set behaviour is selected, otherwise the method acts as a get method. Returns the value of the atom. ToString($indent, $spaces) Returns the string representation of the atom. Accepts 2 parameters: indent and spaces. $indent is a true/false value specifing that the string representation should be prefixed with a tab character; $spaces is used to compute the number of spaces that should be added after the atom name, so that the total length of the parameter name to match the $spaces value. Example: my $a = new RoPkg::Rsync::Atom( type => 'param', name => 'gid', value => 'users', ); print $a->ToString(0, 6),$/, $a->ToString(0, 5),$/, $a->ToString(0, 4),$/, $a->ToString(0, 3),$/, $a->ToString(1, 6),$/, $a->ToString(1, 5),$/, $a->ToString(1, 4),$/, $a->ToString(1, 3),$/; The result is: gid = users gid = users gid = users gid = users gid = users gid = users gid = users gid = users Type Returns the type (string representation) of the atom. PREREQUISITES
perl 5.008 (or later) is required. Besides perl, you must have the following: RoPkg::Exceptions English Scalar::Util SEE ALSO
RoPkg::Rsync::Node RoPkg::Rsync::ConfFile RoPkg::Exceptions AUTHOR
Subredu Manuel <diablo@iasi.roedu.net> 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. perl v5.8.8 2006-06-09 RoPkg::Rsync::Atom(3pm)