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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
|
<?php
/**
* IMP_Sentmail implementation for PHP's PEAR database abstraction layer.
*
* Required values for $params:<pre>
* 'phptype' The database type (e.g. 'pgsql', 'mysql', etc.).
* 'table' The name of the foo table in 'database'.</pre>
*
* Required by some database implementations:<pre>
* 'database' The name of the database.
* 'hostspec' The hostname of the database server.
* 'protocol' The communication protocol ('tcp', 'unix', etc.).
* 'username' The username with which to connect to the database.
* 'password' The password associated with 'username'.
* 'options' Additional options to pass to the database.
* 'tty' The TTY on which to connect to the database.
* 'port' The port on which to connect to the database.</pre>
*
* The table structure can be created by the scripts/sql/imp_sentmail.sql
* script.
*
* $Horde: imp/lib/Sentmail/sql.php,v 1.12.2.1 2007/12/20 13:59:29 jan Exp $
*
* @author Jan Schneider <jan@horde.org>
* @since IMP 4.2
* @package IMP
*/
class IMP_Sentmail_sql extends IMP_Sentmail {
/**
* Hash containing connection parameters.
*
* @var array
*/
var $_params = array();
/**
* Handle for the current database connection.
*
* @var DB
*/
var $_db;
/**
* Constructor.
*
* @param array $params A hash containing connection parameters.
*/
function IMP_Sentmail_sql($params = array())
{
$this->_params = $params;
}
/**
* Logs an attempt to send a message per recipient.
*
* @param string $action Why the message was sent, i.e. "new",
* "reply", "forward", etc.
* @param string $message_id The Message-ID.
* @param string $recipients A message recipient.
* @param boolean $success Whether the attempt was successful.
*/
function _log($action, $message_id, $recipient, $success)
{
/* Build the SQL query. */
$query = sprintf('INSERT INTO %s (sentmail_id, sentmail_who, sentmail_ts, sentmail_messageid, sentmail_action, sentmail_recipient, sentmail_success) VALUES (?, ?, ?, ?, ?, ?, ?)',
$this->_params['table']);
$values = array($this->_db->nextId($this->_params['table']),
Auth::getAuth(),
time(),
$message_id,
$action,
$recipient,
(int)$success);
/* Log the query at a DEBUG log level. */
Horde::logMessage(sprintf('IMP_Sentmail_sql::_log(): %s', $query),
__FILE__, __LINE__, PEAR_LOG_DEBUG);
/* Execute the query. */
$result = $this->_db->query($query, $values);
/* Log errors. */
if (is_a($result, 'PEAR_Error')) {
Horde::logMessage($result, __FILE__, __LINE__, PEAR_LOG_ERR);
}
}
/**
* Returns the most favourite recipients.
*
* @param integer $limit Return this number of recipients.
* @param array $filter A list of messages types that should be returned.
* A value of null returns all message types.
*
* @return array A list with the $limit most favourite recipients.
*/
function favouriteRecipients($limit, $filter = array('new', 'forward', 'reply', 'redirect'))
{
/* Build the SQL query. */
$where = '';
if (!empty($filter)) {
$filter = array_map(array($this->_db, 'quote'), $filter);
$where = sprintf(' AND sentmail_action in (%s)',
implode(', ', $filter));
}
$query = sprintf('SELECT sentmail_recipient, count(*) AS sentmail_count FROM %s WHERE sentmail_who = %s AND sentmail_success = 1%s GROUP BY sentmail_recipient ORDER BY sentmail_count DESC LIMIT %d',
$this->_params['table'],
$this->_db->quote(Auth::getAuth()),
$where,
$limit);
/* Log the query at a DEBUG log level. */
Horde::logMessage(sprintf('IMP_Sentmail_sql::favouriteRecipients(): %s', $query),
__FILE__, __LINE__, PEAR_LOG_DEBUG);
/* Execute the query. */
$recipients = $this->_db->getAll($query);
if (is_a($recipients, 'PEAR_Error')) {
Horde::logMessage($recipients, __FILE__, __LINE__, PEAR_LOG_ERR);
return $recipients;
}
/* Extract email addresses. */
$favourites = array();
foreach ($recipients as $recipient) {
$favourites[] = $recipient[0];
}
return $favourites;
}
/**
* Returns the number of recipients within a certain time period.
*
* @param integer $hours Time period in hours.
* @param boolean $user Return the number of recipients for the current
* user?
*
* @return integer The number of recipients in the given time period.
*/
function numberOfRecipients($hours, $user = false)
{
/* Build the SQL query. */
$query = sprintf('SELECT COUNT(*) FROM %s WHERE sentmail_ts > ?',
$this->_params['table']);
if ($user) {
$query .= sprintf(' AND sentmail_who = %s', $this->_db->quote(Auth::getAuth()));
}
/* Log the query at a DEBUG log level. */
Horde::logMessage(sprintf('IMP_Sentmail_sql::numberOfRecipients(): %s', $query),
__FILE__, __LINE__, PEAR_LOG_DEBUG);
/* Execute the query. */
$recipients = $this->_db->getOne($query, array(time() - $hours * 3600));
if (is_a($recipients, 'PEAR_Error')) {
Horde::logMessage($recipients, __FILE__, __LINE__, PEAR_LOG_ERR);
}
return $recipients;
}
/**
* Deletes all log entries older than a certain date.
*
* @param integer $before Unix timestamp before that all log entries
* should be deleted.
*/
function _deleteOldEntries($before)
{
/* Build the SQL query. */
$query = sprintf('DELETE FROM %s WHERE sentmail_ts < ?',
$this->_params['table']);
/* Log the query at a DEBUG log level. */
Horde::logMessage(sprintf('IMP_Sentmail_sql::_deleteOldEntries(): %s', $query),
__FILE__, __LINE__, PEAR_LOG_DEBUG);
/* Execute the query. */
$result = $this->_db->query($query, array($before));
if (is_a($result, 'PEAR_Error')) {
Horde::logMessage($result, __FILE__, __LINE__, PEAR_LOG_ERR);
return $result;
}
}
/**
* Attempts to open a connection to the SQL server.
*
* @return boolean True on success, PEAR_Error on failure.
*/
function initialize()
{
Horde::assertDriverConfig($this->_params, 'storage',
array('phptype', 'table'));
if (!isset($this->_params['database'])) {
$this->_params['database'] = '';
}
if (!isset($this->_params['username'])) {
$this->_params['username'] = '';
}
if (!isset($this->_params['hostspec'])) {
$this->_params['hostspec'] = '';
}
/* Connect to the SQL server using the supplied parameters. */
require_once 'DB.php';
$this->_db = DB::connect($this->_params,
array('persistent' => !empty($this->_params['persistent'])));
if (is_a($this->_db, 'PEAR_Error')) {
return $this->_db;
}
/* Set DB portability options. */
switch ($this->_db->phptype) {
case 'mssql':
$this->_db->setOption('portability', DB_PORTABILITY_LOWERCASE | DB_PORTABILITY_ERRORS | DB_PORTABILITY_RTRIM);
break;
default:
$this->_db->setOption('portability', DB_PORTABILITY_LOWERCASE | DB_PORTABILITY_ERRORS);
}
return true;
}
}
|
