Changeset 5dee79a for perl

Timestamp:

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

Author:

Jason Gross <jasongross9@gmail.com>

Branches:

master

Children:

8cec8f7

Parents:

d2ba33c

git-author:

Jason Gross <jgross@mit.edu> (01/05/14 18:08:28)

git-committer:

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

Message:

Add log-to-subdirectories, a compatibility frob

If disabled (the default), then logging of jabber and AIM messages
behaves how it used to.  If enabled, then each protocol gets its own
subdirectory.

Location:

perl/lib/BarnOwl

Files:

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

perl/lib/BarnOwl/Logging.pm

@@ -120 +120 @@
                            . "Files will be created in the directory for each class."
         });
+
+    BarnOwl::new_variable_bool('log-to-subdirectories',
+        {
+            default     => 0,
+            summary     => "log each protocol to its own subdirectory of logbasepath",
+            description => "When this is enabled, BarnOwl will log each protocol to its own\n"
+                         . "subdirectory of logbasepath.  When this is disabled, BarnOwl will\n"
+                         . "instead log all non-zephyr non-loopback messages to the logpath,\n"
+                         . "and prefix each filename with what would otherwise be the subdirectory\n"
+                         . "name.\n\n"
+                         . "If you enable this, be sure that the relevant directories exist;\n"
+                         . "BarnOwl will not create them for you."
+        });
+
 }
 

perl/lib/BarnOwl/Message.pm

@@ -183 +183 @@
     }
     $filename = "unknown" if !defined($filename) || $filename eq '';
-    return ($filename);
+    if (BarnOwl::getvar('log-to-subdirectories') eq 'on') {
+        return ($filename);
+    } else {
+        return ($m->log_subfolder . ':' . $filename);
+    }
 }
 
@@ -205 +209 @@
 Returns the folder in which all messages of this class get logged.
 
-Defaults to C<log_base_path>/C<log_subfolder>.
+Defaults to C<log_base_path/log_subfolder> if C<log-to-subdirectories>
+is enabled, or to the C<logpath> BarnOwl variable if it is not.
+
+Most protocols should override C<log_subfolder> rather than
+C<log_path>, in order to properly take into account the value of
+C<log-to-subdirectories>.
 
 =cut
@@ -211 +220 @@
 sub log_path {
     my ($m) = @_;
-    return File::Spec->catfile($m->log_base_path, $m->log_subfolder);
+    if (BarnOwl::getvar('log-to-subdirectories') eq 'on') {
+        return File::Spec->catfile($m->log_base_path, $m->log_subfolder);
+    } else {
+        return BarnOwl::getvar('logpath');
+    }
 }