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
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
|
<?php
/**
* SemanticScuttle - your social bookmark manager.
*
* PHP version 5.
*
* @category Bookmarking
* @package SemanticScuttle
* @author Benjamin Huynh-Kim-Bang <mensonge@users.sourceforge.net>
* @author Christian Weiske <cweiske@cweiske.de>
* @author Eric Dane <ericdane@users.sourceforge.net>
* @license GPL http://www.gnu.org/licenses/gpl.html
* @link http://sourceforge.net/projects/semanticscuttle
*/
/**
* SemanticScuttle search history service.
*
* @category Bookmarking
* @package SemanticScuttle
* @author Benjamin Huynh-Kim-Bang <mensonge@users.sourceforge.net>
* @author Christian Weiske <cweiske@cweiske.de>
* @author Eric Dane <ericdane@users.sourceforge.net>
* @license GPL http://www.gnu.org/licenses/gpl.html
* @link http://sourceforge.net/projects/semanticscuttle
*/
class SemanticScuttle_Service_SearchHistory extends SemanticScuttle_DbService
{
/**
* Size of the search history.
* If the number of logged searches is larger than this,
* adding a new search will delete the oldest one automatically.
*
* Use -1 to deactivate automatic deletion.
*
* @var integer
*/
public $sizeSearchHistory;
/**
* Returns the single service instance
*
* @param DB $db Database object
*
* @return SemanticScuttle_Service
*/
public static function getInstance($db)
{
static $instance;
if (!isset($instance)) {
$instance = new self($db);
}
return $instance;
}
/**
* Creates a new instance.
*
* Sets $this->sizeSearchHistory to $GLOBALS['sizeSearchHistory'] or 10
* if the global variable is not defined.
*
* @param DB $db Database object
*/
public function __construct($db)
{
$this->db = $db;
$this->tablename = $GLOBALS['tableprefix'] . 'searchhistory';
if (isset($GLOBALS['sizeSearchHistory'])) {
$this->sizeSearchHistory = $GLOBALS['sizeSearchHistory'];
} else {
$this->sizeSearchHistory = 10;
}
}
/**
* Adds a new search to the search history.
* Automatically deletes the oldest search when the number of
* searches is larger than $sizeSearchHistory.
*
* @param string $terms Search terms separated by spaces
* @param string $range - 'all' - search was in all bookmarks
* - 'watchlist' - searched in watchlist
* - any username to show that the search happened
* in his own bookmarks.
* @param integer $nbResults Number of search result rows
* @param integer $uId ID of user that searched
*
* @return boolean True if it has been added, false if not
*/
public function addSearch($terms, $range, $nbResults, $uId = 0)
{
if (strlen($terms) == 0) {
return false;
}
$datetime = gmdate('Y-m-d H:i:s', time());
//Insert values
$values = array(
'shTerms' => $terms,
'shRange' => $range,
'shDatetime' => $datetime,
'shNbResults' => $nbResults,
'uId' => $uId
);
$sql = 'INSERT INTO ' . $this->getTableName()
. ' ' . $this->db->sql_build_array('INSERT', $values);
$this->db->sql_transaction('begin');
if (!($dbresult = $this->db->sql_query($sql))) {
$this->db->sql_transaction('rollback');
message_die(
GENERAL_ERROR, 'Could not insert search history',
'', __LINE__, __FILE__, $sql, $this->db
);
return false;
}
if ($this->sizeSearchHistory != -1
&& $this->countSearches() > $this->sizeSearchHistory
) {
$this->deleteOldestSearch();
}
return true;
}
/**
* Returns searches with the given features.
*
* @param string $range - 'all' - search was in all bookmarks
* - 'watchlist' - searched in watchlist
* - any username to show that the search happened
* in his own bookmarks.
* @param integer $uId Id of the user who searched. 0 for anonymous users
* @param integer $nb Number of bookmarks to retrieve (paging)
* @param integer $start Number of bookmark to begin with (paging)
* @param boolean $distinct If the search terms shall be distinct
* @param boolean $withResults Only return searches that had at least one result
*
* @return array Array of search history database rows
*/
public function getAllSearches(
$range = null, $uId = null, $nb = null,
$start = null, $distinct = false, $withResults = false
) {
$sql = 'SELECT DISTINCT(shTerms),'
. ' shId, shRange, shNbResults, shDatetime, uId';
$sql.= ' FROM '. $this->getTableName();
$sql.= ' WHERE 1=1';
if ($range != null) {
$sql.= ' AND shRange = "'.$range.'"';
} else {
$sql.= ' AND shRange = "all"';
}
if ($uId != null) {
$sql.= ' AND uId = '.$uId;
}
if ($withResults == true) {
$sql.= ' AND shNbResults > 0';
}
if ($distinct) {
$sql.= ' GROUP BY shTerms';
}
$sql.= ' ORDER BY shId DESC';
if (!($dbresult = $this->db->sql_query_limit($sql, $nb, $start))) {
message_die(
GENERAL_ERROR, 'Could not get searches',
'', __LINE__, __FILE__, $sql, $this->db
);
return false;
}
$searches = array();
while ($row = $this->db->sql_fetchrow($dbresult)) {
$searches[] = $row;
}
$this->db->sql_freeresult($dbresult);
return $searches;
}
/**
* Counts the number of searches that have been made in total.
*
* @return integer Number of searches
*/
public function countSearches()
{
$sql = 'SELECT COUNT(*) AS `total` FROM '. $this->getTableName();
if (!($dbresult = $this->db->sql_query($sql))
|| (!($row = & $this->db->sql_fetchrow($dbresult)))
) {
message_die(
GENERAL_ERROR, 'Could not get total searches',
'', __LINE__, __FILE__, $sql, $this->db
);
return false;
}
$this->db->sql_freeresult($dbresult);
return $row['total'];
}
/**
* This function allows to limit the number of saved searches
* by deleting the oldest one
*
* @return boolean True when all went well, false in case of an error
*/
public function deleteOldestSearch()
{
$sql = 'DELETE FROM '.$this->getTableName();
// warning: here the limit is important
$sql .= ' ORDER BY shId ASC LIMIT 1';
$this->db->sql_transaction('begin');
if (!($dbresult = $this->db->sql_query($sql))) {
$this->db->sql_transaction('rollback');
message_die(
GENERAL_ERROR, 'Could not delete bookmarks',
'', __LINE__, __FILE__, $query, $this->db
);
return false;
}
return true;
}
/**
* Deletes all search history entries that have been made by the user
* with the given ID.
*
* @param integer $uId ID of the user
*
* @return boolean True when all went well, false in case of an error
*/
public function deleteSearchHistoryForUser($uId)
{
$query = 'DELETE FROM '. $this->getTableName()
. ' WHERE uId = ' . intval($uId);
if (!($dbresult = $this->db->sql_query($query))) {
message_die(
GENERAL_ERROR, 'Could not delete search history', '',
__LINE__, __FILE__, $query, $this->db
);
return false;
}
return true;
}
/**
* Deletes all search history entries.
*
* @return void
*/
public function deleteAll()
{
$query = 'TRUNCATE TABLE `'. $this->getTableName() .'`';
$this->db->sql_query($query);
}
}
?>
|
