The Perl and Raku Conference 2025: Greenville, South Carolina - June 27-29 Learn more

MCAUDILL / Net-Bot-IRC-Message-1.0.0 / lib / Net / Bot / IRC / Message.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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175

              
package Net::Bot::IRC::Message;
use warnings;
use strict;
use Params::Validate;
use Carp;
=head1 NAME
Net::Bot::IRC::Message - An IRC protocol message class.
=head1 VERSION
Version 1.0.0
=cut
our $VERSION = '1.0.0';
=head1 SYNOPSIS
    use Net::Bot::IRC::Message;
    my $outgoing = Net::Bot::IRC::Message->new({
        prefix  => $prefix, #Optional
        command => $cmd,
        params  => $params,
    });
    my $raw_message = $outgoing->compile();
    my $incoming = Net::Bot::IRC::Message->new({
        unparsed => $raw_message,
    });
    my ($prefix, $command, $params)
        = $incoming->parse();
=head1 FUNCTIONS
=head2 new( prefix => $prefix, command => $cmd, params => $params )
=head2 new( unparsed => $raw_message )
=cut
sub new {
    my $class = shift;
    my $self  = validate(@_, {
        # For outgoing messages.
        prefix   => {
            optional => 1,
            depends  => [ 'command', 'params' ],
        },
        command  => {
            optional => 1,
            depends  => [ 'params' ],
        },
        params   => {
            optional => 1,
            depends  => [ 'command' ],
        },
        # For incoming messages
        unparsed => {
            optional => 1,
        },
    });
    bless $self, $class;
    return $self;
}
=head2 parse()
=cut
sub parse {
    my $self = shift;
    unless (exists $self->{unparsed}) {
        croak "No message to parse.";
    }
    my $message = $self->{unparsed};
    if ($message =~ /:(\S+) (\d\d\d) (.+)/) {
        $self->{prefix}  = $1;
        $self->{command} = $2;
        $self->{params}  = $3;
    }
    return ($self->{prefix},
            $self->{command},
            $self->{params});
}
=head2 compile()
=cut
sub compile {
    my $self = shift;
    unless (   exists $self->{prefix}
            && exists $self->{command}
            && exists $self->{params}) {
        croak "Prefix, command and params not specified.";
    }
    my $message = ":" . $self->{prefix}  . " "
                      . $self->{command} . " "
                      . $self->{params};
    $self->{unparsed} = $message;
    return $self->{unparsed};
}
=head1 AUTHOR
Mark Caudill, C<< <mcaudill at cpan.org> >>
=head1 SOURCE
The source for this module is maintained at C<< <git@github.com:markcaudill/Net-Bot-IRC-Message.git> >>.
=head1 BUGS
Please report any bugs or feature requests to C<bug-net-bot-irc-message at rt.cpan.org>, or through
the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Net-Bot-IRC-Message>.  I will be notified, and then you'll
automatically be notified of progress on your bug as I make changes.
=head1 SUPPORT
You can find documentation for this module with the perldoc command.
    perldoc Net::Bot::IRC::Message
You can also look for information at:
=over 4
=item * RT: CPAN's request tracker
L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Net-Bot-IRC-Message>
=item * AnnoCPAN: Annotated CPAN documentation
L<http://annocpan.org/dist/Net-Bot-IRC-Message>
=item * CPAN Ratings
L<http://cpanratings.perl.org/d/Net-Bot-IRC-Message>
=item * Search CPAN
L<http://search.cpan.org/dist/Net-Bot-IRC-Message/>
=back
=head1 COPYRIGHT & LICENSE
Copyright 2023 Mark Caudill.
This program is free software; you can redistribute it and/or modify it
under the terms of either: the GNU General Public License as published
by the Free Software Foundation; or the Artistic License.
See http://dev.perl.org/licenses/ for more information.
=cut
1; # End of Net::Bot::IRC::Message