Changeset dca6255 for perl/lib


Ignore:
Timestamp:
Jan 7, 2014, 6:00:46 PM (9 years ago)
Author:
Jason Gross <jgross@mit.edu>
Children:
e38cc20
Parents:
e7ab1d7
git-author:
Jason Gross <jgross@mit.edu> (07/12/11 14:42:39)
git-committer:
Jason Gross <jgross@mit.edu> (01/07/14 18:00:46)
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
Files:
1 added
4 edited

Legend:

Unmodified
Added
Removed
  • perl/lib/BarnOwl.pm

    recd4edf rdca6255  
    3838use BarnOwl::Hook;
    3939use BarnOwl::Hooks;
     40use BarnOwl::Logging;
    4041use BarnOwl::Message;
    4142use BarnOwl::Style;
  • perl/lib/BarnOwl/Message.pm

    rc877a63 rdca6255  
    160160        return $m->body;
    161161    }
     162}
     163
     164=head2 log_filenames MESSAGE
     165
     166Returns a list of filenames to which this message should be logged.
     167The filenames should be relative to the path returned by
     168C<log_base_path>.  See L<BarnOwl::Logging::get_filenames> for the
     169specification of valid filenames, and for what happens if this
     170method returns an invalid filename.
     171
     172=cut
     173
     174sub log_filenames {
     175    my ($m) = @_;
     176    my $filename = lc($m->type);
     177    $filename = "unknown" if !defined $filename || $filename eq '';
     178    if ($m->is_incoming && $m->pretty_sender) {
     179        $filename .= ":" . $m->pretty_sender;
     180    } elsif ($m->is_outgoing && $m->pretty_recipient) {
     181        $filename .= ":" . $m->pretty_recipient;
     182    }
     183    return ($filename);
     184}
     185
     186=head2 log_to_all_file MESSAGE
     187
     188There is an C<all> file.  This method determines if C<MESSAGE>
     189should get logged to it, in addition to any files returned by
     190C<log_filenames>.
     191
     192It defaults to returning true if and only if C<MESSAGE> is outgoing.
     193
     194=cut
     195
     196sub log_to_all_file {
     197    my ($m) = @_;
     198    return $m->is_outgoing;
     199}
     200
     201=head2 log_base_path MESSAGE
     202
     203Returns the base path for logging, the folder in which all messages
     204of this class get logged.
     205
     206Defaults to the BarnOwl variable C<logpath>.
     207
     208=cut
     209
     210sub log_base_path {
     211    return BarnOwl::getvar('logpath');
    162212}
    163213
  • perl/lib/BarnOwl/Message/AIM.pm

    r7011c3dc rdca6255  
    2424}
    2525
     26sub normalize_screenname {
     27    my ($screenname) = @_;
     28    $screenname =~ s/\s+//g;
     29    return lc($screenname);
     30}
     31
     32sub log_filenames {
     33    return map { normalize_screenname($_) } BarnOwl::Message::log_filenames(@_);
     34}
    2635
    27361;
  • perl/lib/BarnOwl/Message/Zephyr.pm

    rc877a63 rdca6255  
    99
    1010use base qw( BarnOwl::Message );
     11use Unicode::Normalize qw( NFKC );
    1112
    1213sub strip_realm {
     
    132133    return $1 if $self->body =~ /^\s*cc:\s+([^\n]+)/i;
    133134    return undef;
     135}
     136
     137sub zephyr_cc_without_recipient {
     138    my $self = shift;
     139    my $recipient = lc(strip_realm($self->recipient));
     140    my $cc = $self->zephyr_cc;
     141    return grep { lc(strip_realm($_)) ne $recipient } split(/\s+/, $cc) if defined $cc;
     142    return ();
    134143}
    135144
     
    240249}
    241250
     251sub log_filenames {
     252    my ($m) = @_;
     253    my @filenames = ();
     254    if ($m->is_personal) {
     255        @filenames = $m->zephyr_cc_without_recipient;
     256    }
     257    if ($m->is_incoming) {
     258        if ($m->is_personal) {
     259            push @filenames, $m->sender;
     260        } else {
     261            return (lc(NFKC($m->class)));
     262        }
     263    } else {
     264        push @filenames, $m->recipient;
     265    }
     266    return map { lc(NFKC(strip_realm($_))) } @filenames;
     267}
     268
     269sub log_to_class_file {
     270    my ($m) = @_;
     271    return !$m->is_personal;
     272}
     273
     274sub log_base_path {
     275    my ($m) = @_;
     276    if ($m->log_to_class_file) {
     277        return BarnOwl::getvar('classlogpath');
     278    } else {
     279        return BarnOwl::getvar('logpath');
     280    }
     281}
     282
    2422831;
Note: See TracChangeset for help on using the changeset viewer.