Changeset dce72c1 for perl

Timestamp:

Aug 16, 2017, 12:53:41 PM (7 years ago)

Author:

Jason Gross <jasongross9@gmail.com>

Branches:

master

Children:

15b87cc

Parents:

9a34040

git-author:

Jason Gross <jgross@mit.edu> (02/16/13 23:46:21)

git-committer:

Jason Gross <jasongross9@gmail.com> (08/16/17 12:53:41)

Message:

Log to subfolders of a base path

A different subfolder for each protocol.

Location:

perl/lib/BarnOwl

Files:

• Logging.pm (modified) (3 diffs)
• Message.pm (modified) (4 diffs)
• Message/Zephyr.pm (modified) (1 diff)

perl/lib/BarnOwl/Logging.pm

@@ -89 +89 @@
                            . "is selected both incoming and outgoing messages are\n"
                            . "logged."
+        });
+
+    BarnOwl::new_variable_string('logbasepath',
+        {
+            default       => '~/zlog',
+            validsettings => '<path>',
+            summary       => 'path for logging non-zephyr messages',
+            description   => "Specifies a directory which must exist.\n"
+                           . "Each non-zephyr protocol gets its own subdirectory in\n"
+                           . "logbasepath, and messages get logged there."
         });
 
@@ -141 +151 @@
 This method calls C<log_filenames> on C<MESSAGE> to determine the list
 of filenames to which C<MESSAGE> gets logged.  All filenames are
-relative to C<MESSAGE->log_base_path>.  If C<MESSAGE->log_to_all_file>
+relative to C<MESSAGE->log_path>.  If C<MESSAGE->log_to_all_file>
 returns true, then the filename C<"all"> is appended to the list of
 filenames.
@@ -153 +163 @@
     my @filenames = $m->log_filenames;
     push @filenames, 'all' if $m->log_to_all_file;
-    return map { sanitize_filename($m->log_base_path, $_) } @filenames;
+    return map { sanitize_filename($m->log_path, $_) } @filenames;
 }
 

perl/lib/BarnOwl/Message.pm

@@ -3 +3 @@
 
 package BarnOwl::Message;
+
+use File::Spec;
 
 use BarnOwl::Message::Admin;
@@ -165 +167 @@
 
 Returns a list of filenames to which this message should be logged.
-The filenames should be relative to the path returned by
-C<log_base_path>.  See L<BarnOwl::Logging::get_filenames> for the
-specification of valid filenames, and for what happens if this
-method returns an invalid filename.
+The filenames should be relative to the path returned by C<log_path>.
+See L<BarnOwl::Logging::get_filenames> for the specification of valid
+filenames, and for what happens if this method returns an invalid
+filename.
 
 =cut
@@ -174 +176 @@
 sub log_filenames {
     my ($m) = @_;
-    my $filename = lc($m->type);
-    $filename = "unknown" if !defined $filename || $filename eq '';
-    if ($m->is_incoming && $m->pretty_sender) {
-        $filename .= ":" . $m->pretty_sender;
-    } elsif ($m->is_outgoing && $m->pretty_recipient) {
-        $filename .= ":" . $m->pretty_recipient;
-    }
+    my $filename;
+    if ($m->is_incoming) {
+        $filename = $m->pretty_sender;
+    } elsif ($m->is_outgoing) {
+        $filename = $m->pretty_recipient;
+    }
+    $filename = "unknown" if !defined($filename) || $filename eq '';
     return ($filename);
 }
@@ -199 +201 @@
 }
 
+=head2 log_path MESSAGE
+
+Returns the folder in which all messages of this class get logged.
+
+Defaults to C<log_base_path>/C<log_subfolder>.
+
+=cut
+
+sub log_path {
+    my ($m) = @_;
+    return File::Spec->catfile($m->log_base_path, $m->log_subfolder);
+}
+
 =head2 log_base_path MESSAGE
 
-Returns the base path for logging, the folder in which all messages
-of this class get logged.
-
-Defaults to the BarnOwl variable C<logpath>.
+Returns the base path for logging.  See C<log_path> for more information.
+
+Defaults to the BarnOwl variable C<logbasepath>.
 
 =cut
 
 sub log_base_path {
-    return BarnOwl::getvar('logpath');
+    return BarnOwl::getvar('logbasepath');
+}
+
+=head2 log_subfolder MESSAGE
+
+Returns the subfolder of C<log_base_path> to log messages in.
+
+Defaults to C<lc($m->type)>.
+
+=cut
+
+sub log_subfolder {
+    return lc(shift->type);
 }
 

perl/lib/BarnOwl/Message/Zephyr.pm

@@ -274 +274 @@
 }
 
-sub log_base_path {
+sub log_path {
     my ($m) = @_;
     if ($m->log_to_class_file) {