[ee183be] | 1 | use strict; |
---|
| 2 | use warnings; |
---|
| 3 | |
---|
| 4 | package BarnOwl::Style::Default; |
---|
[5550eb0] | 5 | use POSIX qw(strftime); |
---|
| 6 | |
---|
[ee183be] | 7 | ################################################################################ |
---|
| 8 | # Branching point for various formatting functions in this style. |
---|
| 9 | ################################################################################ |
---|
| 10 | sub format_message |
---|
| 11 | { |
---|
| 12 | my $self = shift; |
---|
| 13 | my $m = shift; |
---|
| 14 | my $fmt; |
---|
| 15 | |
---|
| 16 | if ( $m->is_loginout) { |
---|
| 17 | $fmt = $self->format_login($m); |
---|
| 18 | } elsif($m->is_ping && $m->is_personal) { |
---|
| 19 | $fmt = $self->format_ping($m); |
---|
| 20 | } elsif($m->is_admin) { |
---|
| 21 | $fmt = $self->format_admin($m); |
---|
| 22 | } else { |
---|
| 23 | $fmt = $self->format_chat($m); |
---|
| 24 | } |
---|
| 25 | $fmt = BarnOwl::Style::boldify($fmt) if $self->should_bold($m); |
---|
[ad0dedd] | 26 | $fmt = $self->humanize($fmt); |
---|
[ee183be] | 27 | return $fmt; |
---|
| 28 | } |
---|
| 29 | |
---|
| 30 | sub should_bold { |
---|
| 31 | my $self = shift; |
---|
| 32 | my $m = shift; |
---|
| 33 | return $m->is_personal && $m->direction eq "in"; |
---|
| 34 | } |
---|
| 35 | |
---|
| 36 | sub description {"Default style";} |
---|
| 37 | |
---|
| 38 | BarnOwl::create_style("default", "BarnOwl::Style::Default"); |
---|
| 39 | |
---|
| 40 | ################################################################################ |
---|
| 41 | |
---|
| 42 | sub format_time { |
---|
| 43 | my $self = shift; |
---|
| 44 | my $m = shift; |
---|
[0b2afba] | 45 | my $dateformat = BarnOwl::time_format('get_time_format'); |
---|
| 46 | return strftime($dateformat, localtime($m->unix_time)); |
---|
[ee183be] | 47 | } |
---|
| 48 | |
---|
| 49 | sub format_login { |
---|
| 50 | my $self = shift; |
---|
| 51 | my $m = shift; |
---|
| 52 | return sprintf( |
---|
| 53 | '@b<%s%s> for @b(%s) (%s) %s', |
---|
| 54 | uc( $m->login ), |
---|
| 55 | $m->login_type, |
---|
| 56 | $m->pretty_sender, |
---|
| 57 | $m->login_extra, |
---|
| 58 | $self->format_time($m) |
---|
| 59 | ); |
---|
| 60 | } |
---|
| 61 | |
---|
| 62 | sub format_ping { |
---|
| 63 | my $self = shift; |
---|
| 64 | my $m = shift; |
---|
| 65 | my $personal_context = $m->personal_context; |
---|
| 66 | $personal_context = ' [' . $personal_context . ']' if $personal_context; |
---|
| 67 | return "\@b(PING)" . $personal_context . " from \@b(" . $m->pretty_sender . ")"; |
---|
| 68 | } |
---|
| 69 | |
---|
| 70 | sub format_admin { |
---|
| 71 | my $self = shift; |
---|
| 72 | my $m = shift; |
---|
| 73 | return "\@bold(OWL ADMIN)\n" . $self->indent_body($m); |
---|
| 74 | } |
---|
| 75 | |
---|
| 76 | sub format_chat { |
---|
| 77 | my $self = shift; |
---|
| 78 | my $m = shift; |
---|
| 79 | my $header = $self->chat_header($m); |
---|
| 80 | return $header . "\n". $self->indent_body($m); |
---|
| 81 | } |
---|
| 82 | |
---|
| 83 | sub chat_header { |
---|
| 84 | my $self = shift; |
---|
| 85 | my $m = shift; |
---|
| 86 | my $header; |
---|
| 87 | if ( $m->is_personal ) { |
---|
| 88 | my $personal_context = $m->personal_context; |
---|
[ad0dedd] | 89 | $personal_context = ' [' . $self->humanize($personal_context, 1) . ']' if $personal_context; |
---|
[ee183be] | 90 | |
---|
| 91 | if ( $m->direction eq "out" ) { |
---|
| 92 | $header = ucfirst $m->type . $personal_context . " sent to " . $m->pretty_recipient; |
---|
| 93 | } else { |
---|
| 94 | $header = ucfirst $m->type . $personal_context . " from " . $m->pretty_sender; |
---|
| 95 | } |
---|
| 96 | } else { |
---|
[ad0dedd] | 97 | $header = $self->humanize($m->context, 1); |
---|
[ee183be] | 98 | if(defined $m->subcontext) { |
---|
[ad0dedd] | 99 | $header .= ' / ' . $self->humanize($m->subcontext, 1); |
---|
[ee183be] | 100 | } |
---|
| 101 | $header .= ' / @b{' . $m->pretty_sender . '}'; |
---|
| 102 | } |
---|
| 103 | |
---|
| 104 | if($m->opcode) { |
---|
[ad0dedd] | 105 | $header .= " [" . $self->humanize($m->opcode, 1) . "]"; |
---|
[ee183be] | 106 | } |
---|
| 107 | $header .= " " . $self->format_time($m); |
---|
| 108 | $header .= $self->format_sender($m); |
---|
| 109 | return $header; |
---|
| 110 | } |
---|
| 111 | |
---|
| 112 | sub format_sender { |
---|
| 113 | my $self = shift; |
---|
| 114 | my $m = shift; |
---|
| 115 | my $sender = $m->long_sender; |
---|
| 116 | $sender =~ s/\n.*$//s; |
---|
| 117 | if (BarnOwl::getvar('colorztext') eq 'on') { |
---|
| 118 | return " (" . $sender . '@color[default]' . ")"; |
---|
| 119 | } else { |
---|
| 120 | return " ($sender)"; |
---|
| 121 | } |
---|
| 122 | } |
---|
| 123 | |
---|
| 124 | sub indent_body |
---|
| 125 | { |
---|
| 126 | my $self = shift; |
---|
| 127 | my $m = shift; |
---|
| 128 | |
---|
| 129 | my $body = $m->body; |
---|
| 130 | if ($m->{should_wordwrap}) { |
---|
| 131 | $body = BarnOwl::wordwrap($body, BarnOwl::getnumcols()-9); |
---|
| 132 | } |
---|
| 133 | # replace newline followed by anything with |
---|
| 134 | # newline plus four spaces and that thing. |
---|
| 135 | $body =~ s/\n(.)/\n $1/g; |
---|
| 136 | # Trim trailing newlines. |
---|
| 137 | $body =~ s/\n*$//; |
---|
| 138 | return " ".$body; |
---|
| 139 | } |
---|
| 140 | |
---|
[ad0dedd] | 141 | =head3 humanize STRING [one_line] |
---|
| 142 | |
---|
| 143 | Method that takes a STRING with control characters and makes it human |
---|
| 144 | readable in such a way as to not do anything funky with the terminal. |
---|
| 145 | If one_line is true, be more conservative about what we treat as |
---|
| 146 | control character. |
---|
| 147 | |
---|
| 148 | =cut |
---|
| 149 | |
---|
| 150 | sub humanize |
---|
| 151 | { |
---|
| 152 | my $self = shift; |
---|
| 153 | my $s = shift; |
---|
| 154 | my $oneline = shift; |
---|
| 155 | sub _humanize_char |
---|
| 156 | { |
---|
| 157 | my $c = ord(shift); |
---|
| 158 | |
---|
| 159 | if ($c < ord(' ')) { |
---|
| 160 | return ('^' . chr($c + ord('@'))); |
---|
| 161 | } elsif ($c == 255) { |
---|
| 162 | return ('^?'); |
---|
| 163 | } else { |
---|
| 164 | return (sprintf('\\x{%x}', $c)); |
---|
| 165 | } |
---|
| 166 | } |
---|
| 167 | my $colorize = (BarnOwl::getvar('colorztext') eq 'on') |
---|
| 168 | ? '@color(cyan)' : ''; |
---|
| 169 | |
---|
[0fe69d2] | 170 | my $chars = $oneline ? qr/[[:cntrl:]]/ : qr/[^[:print:]\n]|[\r\cK\f]/; |
---|
[ad0dedd] | 171 | |
---|
| 172 | $s =~ s/($chars)/ |
---|
| 173 | "\@b($colorize" . _humanize_char($1) . ')'/eg; |
---|
| 174 | |
---|
| 175 | return $s; |
---|
| 176 | } |
---|
| 177 | |
---|
| 178 | =head3 humanize_short STRING |
---|
| 179 | |
---|
| 180 | As above, but always be conservative, and replace with a '?' instead |
---|
[25bfc10] | 181 | of something more elaborate. |
---|
[ad0dedd] | 182 | |
---|
| 183 | =cut |
---|
| 184 | |
---|
| 185 | sub humanize_short |
---|
| 186 | { |
---|
| 187 | my $self = shift; |
---|
| 188 | my $s = shift; |
---|
| 189 | |
---|
| 190 | $s =~ s/[[:cntrl:]]/?/g; |
---|
| 191 | |
---|
| 192 | return $s; |
---|
| 193 | } |
---|
[ee183be] | 194 | |
---|
| 195 | 1; |
---|