From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

VVU / wubot-0.3.0-TRIAL / lib / App / Wubot / Reactor / Icon.pm 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
—
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158

              
package App::Wubot::Reactor::Icon;
use Moose;
our $VERSION = '0.3.0'; # VERSION
use YAML;
use App::Wubot::Logger;
has 'logger'  => ( is => 'ro',
                   isa => 'Log::Log4perl::Logger',
                   lazy => 1,
                   default => sub {
                       return Log::Log4perl::get_logger( __PACKAGE__ );
                   },
               );
has 'icon_dir' => ( is => 'ro',
                    isa => 'Str',
                    lazy => 1,
                    default => sub {
                        return "$ENV{HOME}/.icons";
                    },
                );
sub react {
    my ( $self, $message, $config ) = @_;
    my $image_dir = $config->{image_dir} || $self->icon_dir;
    if ( $message->{image} ) {
        if ( my $icon = $self->_check_for_image( $image_dir, $message->{image}, $config, 'image' ) ) {
            $message->{icon} = $icon;
            return $message;
        }
    }
    if ( $message->{username} && $message->{username} ne "wubot" ) {
        if ( my $icon = $self->_check_for_image( $image_dir, $message->{username}, $config, 'username' ) ) {
            $message->{icon} = $icon;
            return $message;
        }
    }
    if ( $message->{key} ) {
        if ( my $icon = $self->_check_for_image( $image_dir, $message->{key}, $config, 'key' ) ) {
            $message->{icon} = $icon;
            return $message;
        }
        $message->{key} =~ m|^(.*?)\-(.*)$|;
        my ( $plugin, $instance ) = ( $1, $2 );
        if ( my $icon = $self->_check_for_image( $image_dir, $instance, $config, 'instance' ) ) {
            $message->{icon} = $icon;
            return $message;
        }
        if ( my $icon = $self->_check_for_image( $image_dir, $plugin, $config, 'plugin', ) ) {
            $message->{icon} = $icon;
            return $message;
        }
    }
    # last chance
    $message->{icon} = $self->_check_for_image( $image_dir, "wubot", $config, 'wubot' );
    return $message;
}
sub _check_for_image {
    my ( $self, $image_dir, $image, $config, $key ) = @_;
    if ( $config ) {
        if ( $config->{custom}->{$key} ) {
            if ( $config->{custom}->{$key}->{$image} ) {
                $image = $config->{custom}->{$key}->{$image};
                $self->logger->debug( "Image custom for $key: $image" );
            }
        }
    }
    unless ( $image =~ m/\.(png|jpg|gif)$/ ) {
        $image .= ".png";
    }
    $image = lc( $image );
    $image =~ s|^.*\/||;
    $self->logger->trace( "Looking for icon: $image" );
    $image = join( "/", $image_dir, $image );
    return unless -r $image;
    $self->logger->debug( "Found image: $image" );
    return $image;
}
1;
__END__
=head1 NAME
App::Wubot::Reactor::Icon - search for an appropriate icon for a message
=head1 VERSION
version 0.3.0
=head1 SYNOPSIS
      - name: icon
        plugin: Icon
        config:
          image_dir: /Users/your_id/.icons
=head1 DESCRIPTION
Attempts to find a suitable image for a message by looking for a file
in the icon directory that matches a field on the message:
  - 'image' field
  - 'username' field
  - monitor key
  - monitor plugin name
  - monitor instance name
If no suitable icon can be found, then the image field will be set to
'wubot.png'.
Note that the Icon plugin no longer tries to parse any information in
the username field.  It is highly recommended that you use the User
reactor plugin prior to using the Icon plugin so that the username
field is parsed appropriately.
For more information, please see the 'notifications' document.
=head1 SUBROUTINES/METHODS
=over 8
=item react( $message, $config )
The standard reactor plugin react() method.
=back