Changeset eea7bed4 for perl/lib/BarnOwl

Timestamp:

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

Author:

Jason Gross <jasongross9@gmail.com>

Branches:

master

Children:

ff528e6

Parents:

da7341e

git-author:

Jason Gross <jgross@mit.edu> (07/12/11 14:42:39)

git-committer:

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

Message:

Moved log file name generation to perl

I don't think that the class/personal distinction is the best for
general protocols, but I don't know what should replace it.  I've made
class-logging default to only zephyr (a slight change from previous
behavior, where jabber MUC's would be logged to $classlogpath, as well
as all non-private non-login messages from other protocols), but made
logging path generation overridable.

TODO: Decide whether or not to filter out more 'bad' characters.
Perhaps we should remove '!' because it indicates history in some shells
and makes things obnoxious, or '~' becase it indicates homedirs in many
shells.
* '/' is for separating directories, and we don't want to accidentally
  make subdirectories

We first NFKC for zephyrs, and then apply lc.  The zephyr servers
apply case-folded NFKC (so says
http://zephyr.1ts.org/browser/zephyr/server/zstring.c).  We should
probably use Unicode::CaseFold instead of lc.  I'm also not sure what
the order case-adjustment and normalization should be.

We first NFKC, then apply lc, to jabbers, as per
http://xmpp.org/internet-drafts/attic/draft-ietf-xmpp-nodeprep-03.html
(though I can't actually find anything that specifies the case-folding
algorithm, nor the ordering).

We now use lc instead of g_utf8_strdown to normalize AIM screennames.

Location:

perl/lib/BarnOwl

Files:

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

perl/lib/BarnOwl/Message.pm

@@ -160 +160 @@
         return $m->body;
     }
+}
+
+=head2 log_filenames MESSAGE
+
+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.
+
+=cut
+
+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;
+    }
+    return ($filename);
+}
+
+=head2 log_to_all_file MESSAGE
+
+There is an C<all> file.  This method determines if C<MESSAGE>
+should get logged to it, in addition to any files returned by
+C<log_filenames>.
+
+It defaults to returning true if and only if C<MESSAGE> is outgoing.
+
+=cut
+
+sub log_to_all_file {
+    my ($m) = @_;
+    return $m->is_outgoing;
+}
+
+=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>.
+
+=cut
+
+sub log_base_path {
+    return BarnOwl::getvar('logpath');
 }
 

perl/lib/BarnOwl/Message/AIM.pm

@@ -24 +24 @@
 }
 
+sub normalize_screenname {
+    my ($screenname) = @_;
+    $screenname =~ s/\s+//g;
+    return lc($screenname);
+}
+
+sub log_filenames {
+    return map { normalize_screenname($_) } BarnOwl::Message::log_filenames(@_);
+}
 
 1;

perl/lib/BarnOwl/Message/Zephyr.pm

@@ -9 +9 @@
 
 use base qw( BarnOwl::Message );
+use Unicode::Normalize qw( NFKC );
 
 sub strip_realm {
@@ -132 +133 @@
     return $1 if $self->body =~ /^\s*cc:\s+([^\n]+)/i;
     return undef;
+}
+
+sub zephyr_cc_without_recipient {
+    my $self = shift;
+    my $recipient = lc(strip_realm($self->recipient));
+    my $cc = $self->zephyr_cc;
+    return grep { lc(strip_realm($_)) ne $recipient } split(/\s+/, $cc) if defined $cc;
+    return ();
 }
 
@@ -240 +249 @@
 }
 
+sub log_filenames {
+    my ($m) = @_;
+    my @filenames = ();
+    if ($m->is_personal) {
+        @filenames = $m->zephyr_cc_without_recipient;
+    }
+    if ($m->is_incoming) {
+        if ($m->is_personal) {
+            push @filenames, $m->sender;
+        } else {
+            return (lc(NFKC($m->class)));
+        }
+    } else {
+        push @filenames, $m->recipient;
+    }
+    return map { lc(NFKC(strip_realm($_))) } @filenames;
+}
+
+sub log_to_class_file {
+    my ($m) = @_;
+    return !$m->is_personal;
+}
+
+sub log_base_path {
+    my ($m) = @_;
+    if ($m->log_to_class_file) {
+        return BarnOwl::getvar('classlogpath');
+    } else {
+        return BarnOwl::getvar('logpath');
+    }
+}
+
 1;