blob: 43bb1f48c7cef1e7b2e345300e02b0fe5a9d4605 (
plain) (
blame)
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
176
177
178
179
180
181
182
183
184
185
186
187
188
|
<?php
/*
* This file is part of SwiftMailer.
* (c) 2004-2009 Chris Corbyn
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
//@require 'Swift/Events/SendEvent.php';
//@require 'Swift/Plugins/BandwidthMonitorPlugin.php';
//@require 'Swift/Plugins/Sleeper.php';
//@require 'Swift/Plugins/Timer.php';
/**
* Throttles the rate at which emails are sent.
* @package Swift
* @subpackage Plugins
* @author Chris Corbyn
*/
class Swift_Plugins_ThrottlerPlugin
extends Swift_Plugins_BandwidthMonitorPlugin
implements Swift_Plugins_Sleeper, Swift_Plugins_Timer
{
/** Flag for throttling in bytes per minute */
const BYTES_PER_MINUTE = 0x01;
/** Flag for throttling in emails per minute */
const MESSAGES_PER_MINUTE = 0x10;
/**
* The Sleeper instance for sleeping.
* @var Swift_Plugins_Sleeper
* @access private
*/
private $_sleeper;
/**
* The Timer instance which provides the timestamp.
* @var Swift_Plugins_Timer
* @access private
*/
private $_timer;
/**
* The time at which the first email was sent.
* @var int
* @access private
*/
private $_start;
/**
* The rate at which messages should be sent.
* @var int
* @access private
*/
private $_rate;
/**
* The mode for throttling.
* This is {@link BYTES_PER_MINUTE} or {@link MESSAGES_PER_MINUTE}
* @var int
* @access private
*/
private $_mode;
/**
* An internal counter of the number of messages sent.
* @var int
* @access private
*/
private $_messages = 0;
/**
* Create a new ThrottlerPlugin.
* @param int $rate
* @param int $mode, defaults to {@link BYTES_PER_MINUTE}
* @param Swift_Plugins_Sleeper $sleeper (only needed in testing)
* @param Swift_Plugins_Timer $timer (only needed in testing)
*/
public function __construct($rate, $mode = self::BYTES_PER_MINUTE,
Swift_Plugins_Sleeper $sleeper = null, Swift_Plugins_Timer $timer = null)
{
$this->_rate = $rate;
$this->_mode = $mode;
$this->_sleeper = $sleeper;
$this->_timer = $timer;
}
/**
* Invoked immediately before the Message is sent.
* @param Swift_Events_SendEvent $evt
*/
public function beforeSendPerformed(Swift_Events_SendEvent $evt)
{
$time = $this->getTimestamp();
if (!isset($this->_start))
{
$this->_start = $time;
}
$duration = $time - $this->_start;
if (self::BYTES_PER_MINUTE == $this->_mode)
{
$sleep = $this->_throttleBytesPerMinute($duration);
}
else
{
$sleep = $this->_throttleMessagesPerMinute($duration);
}
if ($sleep > 0)
{
$this->sleep($sleep);
}
}
/**
* Invoked when a Message is sent.
* @param Swift_Events_SendEvent $evt
*/
public function sendPerformed(Swift_Events_SendEvent $evt)
{
parent::sendPerformed($evt);
++$this->_messages;
}
/**
* Sleep for $seconds.
* @param int $seconds
*/
public function sleep($seconds)
{
if (isset($this->_sleeper))
{
$this->_sleeper->sleep($seconds);
}
else
{
sleep($seconds);
}
}
/**
* Get the current UNIX timestamp
* @return int
*/
public function getTimestamp()
{
if (isset($this->_timer))
{
return $this->_timer->getTimestamp();
}
else
{
return time();
}
}
// -- Private methods
/**
* Get a number of seconds to sleep for.
* @param int $timePassed
* @return int
* @access private
*/
private function _throttleBytesPerMinute($timePassed)
{
$expectedDuration = $this->getBytesOut() / ($this->_rate / 60);
return (int) ceil($expectedDuration - $timePassed);
}
/**
* Get a number of seconds to sleep for.
* @param int $timePassed
* @return int
* @access private
*/
private function _throttleMessagesPerMinute($timePassed)
{
$expectedDuration = $this->_messages / ($this->_rate / 60);
return (int) ceil($expectedDuration - $timePassed);
}
}
|
