Profile of Mail/SpamAssassin/PersistentAddrList.pm

Filename	/usr/local/lib/perl5/site_perl/Mail/SpamAssassin/PersistentAddrList.pm
Statements	Executed 17 statements in 898µs

Subroutines
Calls	P	F	Exclusive Time	Inclusive Time	Subroutine
1	1	1	42µs	53µs	Mail::SpamAssassin::PersistentAddrList::BEGIN@49
1	1	1	36µs	41µs	Mail::SpamAssassin::PersistentAddrList::BEGIN@51
1	1	1	29µs	104µs	Mail::SpamAssassin::PersistentAddrList::BEGIN@54
1	1	1	27µs	87µs	Mail::SpamAssassin::PersistentAddrList::BEGIN@52
1	1	1	24µs	61µs	Mail::SpamAssassin::PersistentAddrList::BEGIN@50
1	1	1	23µs	23µs	Mail::SpamAssassin::PersistentAddrList::new
0	0	0	0s	0s	Mail::SpamAssassin::PersistentAddrList::add_score
0	0	0	0s	0s	Mail::SpamAssassin::PersistentAddrList::finish
0	0	0	0s	0s	Mail::SpamAssassin::PersistentAddrList::get_addr_entry
0	0	0	0s	0s	Mail::SpamAssassin::PersistentAddrList::new_checker
0	0	0	0s	0s	Mail::SpamAssassin::PersistentAddrList::remove_entry

Call graph for these subroutines as a Graphviz dot language file.

Line	State ments	Time on line	Calls	Time in subs	Code
1					# <@LICENSE>
2					# Licensed to the Apache Software Foundation (ASF) under one or more
3					# contributor license agreements. See the NOTICE file distributed with
4					# this work for additional information regarding copyright ownership.
5					# The ASF licenses this file to you under the Apache License, Version 2.0
6					# (the "License"); you may not use this file except in compliance with
7					# the License. You may obtain a copy of the License at:
8					#
9					# http://www.apache.org/licenses/LICENSE-2.0
10					#
11					# Unless required by applicable law or agreed to in writing, software
12					# distributed under the License is distributed on an "AS IS" BASIS,
13					# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14					# See the License for the specific language governing permissions and
15					# limitations under the License.
16					# </@LICENSE>
17
18					=head1 NAME
19
20					Mail::SpamAssassin::PersistentAddrList - persistent address list base class
21
22					=head1 SYNOPSIS
23
24					my $factory = PersistentAddrListSubclass->new();
25					$spamtest->set_persistent_addr_list_factory ($factory);
26					... call into SpamAssassin classes...
27
28					SpamAssassin will call:
29
30					my $addrlist = $factory->new_checker($spamtest);
31					$entry = $addrlist->get_addr_entry ($addr);
32					...
33
34					=head1 DESCRIPTION
35
36					All persistent address list implementations, used by the auto-whitelist
37					code to track known-good email addresses, use this as a base class.
38
39					See C<Mail::SpamAssassin::DBBasedAddrList> for an example.
40
41					=head1 METHODS
42
43					=over 4
44
45					=cut
46
47					package Mail::SpamAssassin::PersistentAddrList;
48
49	2	72µs	2	63µs	# spent 53µs (42+10) within Mail::SpamAssassin::PersistentAddrList::BEGIN@49 which was called: # once (42µs+10µs) by Mail::SpamAssassin::DBBasedAddrList::BEGIN@26 at line 49 use strict; # spent 53µs making 1 call to Mail::SpamAssassin::PersistentAddrList::BEGIN@49 # spent 10µs making 1 call to strict::import
50	2	69µs	2	98µs	# spent 61µs (24+37) within Mail::SpamAssassin::PersistentAddrList::BEGIN@50 which was called: # once (24µs+37µs) by Mail::SpamAssassin::DBBasedAddrList::BEGIN@26 at line 50 use warnings; # spent 61µs making 1 call to Mail::SpamAssassin::PersistentAddrList::BEGIN@50 # spent 37µs making 1 call to warnings::import
51	2	69µs	2	46µs	# spent 41µs (36+5) within Mail::SpamAssassin::PersistentAddrList::BEGIN@51 which was called: # once (36µs+5µs) by Mail::SpamAssassin::DBBasedAddrList::BEGIN@26 at line 51 use bytes; # spent 41µs making 1 call to Mail::SpamAssassin::PersistentAddrList::BEGIN@51 # spent 5µs making 1 call to bytes::import
52	2	91µs	2	147µs	# spent 87µs (27+60) within Mail::SpamAssassin::PersistentAddrList::BEGIN@52 which was called: # once (27µs+60µs) by Mail::SpamAssassin::DBBasedAddrList::BEGIN@26 at line 52 use re 'taint'; # spent 87µs making 1 call to Mail::SpamAssassin::PersistentAddrList::BEGIN@52 # spent 60µs making 1 call to re::import
53
54	1	2µs			# spent 104µs (29+75) within Mail::SpamAssassin::PersistentAddrList::BEGIN@54 which was called: # once (29µs+75µs) by Mail::SpamAssassin::DBBasedAddrList::BEGIN@26 at line 56 use vars qw{
55					@ISA
56	1	534µs	2	179µs	}; # spent 104µs making 1 call to Mail::SpamAssassin::PersistentAddrList::BEGIN@54 # spent 75µs making 1 call to vars::import
57
58	1	18µs			@ISA = qw();
59
60					###########################################################################
61
62					=item $factory = PersistentAddrListSubclass->new();
63
64					This creates a factory object, which SpamAssassin will call to create
65					a new checker object for the persistent address list.
66
67					=cut
68
69					# spent 23µs within Mail::SpamAssassin::PersistentAddrList::new which was called: # once (23µs+0s) by Mail::SpamAssassin::DBBasedAddrList::new at line 37 of Mail/SpamAssassin/DBBasedAddrList.pm sub new {
70	1	2µs			my $class = shift;
71	1	2µs			$class = ref($class) \|\| $class;
72	1	12µs			my $self = { };
73	1	2µs			bless ($self, $class);
74	1	16µs			$self;
75					}
76
77					###########################################################################
78
79					=item my $addrlist = $factory->new_checker();
80
81					Create a new address-list checker object from the factory. Called by the
82					SpamAssassin classes.
83
84					=cut
85
86					sub new_checker {
87					my ($factory, $main) = @_;
88					die "auto-whitelist: unimplemented base method"; # override this
89					}
90
91					###########################################################################
92
93					=item $entry = $addrlist->get_addr_entry ($addr);
94
95					Given an email address C<$addr>, return an entry object with the details of
96					that address.
97
98					The entry object is a reference to a hash, which must contain at least
99					two keys: C<count>, which is the count of times that address has been
100					encountered before; and C<totscore>, which is the total of all scores for
101					messages associated with that address. From these two fields, an average
102					score will be calculated, and the score for the current message will be
103					regressed towards that mean message score.
104
105					The hash can contain whatever other data your back-end needs to store,
106					under other keys.
107
108					The method should never return C<undef>, or a hash that does not contain
109					a C<count> key and a C<totscore> key.
110
111					=cut
112
113					sub get_addr_entry {
114					my ($self, $addr, $signedby) = @_;
115					my $entry = { };
116					die "auto-whitelist: unimplemented base method"; # override this
117					return $entry;
118					}
119
120					###########################################################################
121
122					=item $entry = $addrlist->add_score($entry, $score);
123
124					This method should add the given score to the whitelist database for the
125					given entry, and then return the new entry.
126
127					=cut
128
129					sub add_score {
130					my ($self, $entry, $score) = @_;
131					die "auto-whitelist: unimplemented base method"; # override this
132					}
133
134					###########################################################################
135
136					=item $entry = $addrlist->remove_entry ($entry);
137
138					This method should remove the given entry from the whitelist database.
139
140					=cut
141
142					sub remove_entry {
143					my ($self, $entry) = @_;
144					die "auto-whitelist: unimplemented base method"; # override this
145					}
146
147					###########################################################################
148
149					=item $entry = $addrlist->finish ();
150
151					Clean up, if necessary. Called by SpamAssassin when it has finished
152					checking, or adding to, the auto-whitelist database.
153
154					=cut
155
156					sub finish {
157					my ($self) = @_;
158					}
159
160					###########################################################################
161
162	1	9µs			1;
163
164					=back
165
166					=cut