aboutsummaryrefslogtreecommitdiff
path: root/services/bookmark2tagservice.php
blob: 26a05c132bc8f5fe95e4d029e54120ea591334e7 (plain)
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
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
<?php
class Bookmark2TagService {
	var $db;
	var $tablename;

	function &getInstance(&$db) {
		static $instance;
		if (!isset($instance))
		$instance =& new Bookmark2TagService($db);
		return $instance;
	}

	function Bookmark2TagService(&$db) {
		$this->db =& $db;
		$this->tablename = $GLOBALS['tableprefix'] .'bookmarks2tags';
	}

	function isNotSystemTag($var) {
		if (utf8_substr($var, 0, 7) == 'system:')
		return false;
		else
		return true;
	}

	function attachTags($bookmarkid, $tags, $fromApi = false, $extension = NULL, $replace = true, $fromImport = false) {
		// Make sure that categories is an array of trimmed strings, and that if the categories are
		// coming in from an API call to add a bookmark, that underscores are converted into strings.
		if (!is_array($tags)) {
			$tags = trim($tags);
			if ($tags != '') {
				if (substr($tags, -1) == ',') {
					$tags = substr($tags, 0, -1);
				}
				if ($fromApi) {
					$tags = explode(' ', $tags);
				} else {
					$tags = explode(',', $tags);
				}
			} else {
				$tags = null;
			}
		}

		//clean tags from strange characters
		$tags = str_replace(array('"', '\''), "_", $tags);


		$tags_count = is_array($tags)?count($tags):0;
		
		for ($i = 0; $i < $tags_count; $i++) {
			$tags[$i] = trim(strtolower($tags[$i]));
			if ($fromApi) {
				include_once(dirname(__FILE__) .'/../functions.inc.php');
				$tags[$i] = convertTag($tags[$i], 'in');
			}
		}

		if ($tags_count > 0) {
			// Remove system tags
			$tags = array_filter($tags, array($this, "isNotSystemTag"));

			// Eliminate any duplicate categories
			$temp = array_unique($tags);
			$tags = array_values($temp);
		} else {
			// Unfiled
			$tags[] = 'system:unfiled';
		}

		// Media and file types
		if (!is_null($extension)) {
			include_once(dirname(__FILE__) .'/../functions.inc.php');
			if ($keys = multi_array_search($extension, $GLOBALS['filetypes'])) {
				$tags[] = 'system:filetype:'. $extension;
				$tags[] = 'system:media:'. array_shift($keys);
			}
		}

		// Imported
		if ($fromImport) {
			$tags[] = 'system:imported';
		}

		$this->db->sql_transaction('begin');

		if ($replace) {
			if (!$this->deleteTagsForBookmark($bookmarkid)){
				$this->db->sql_transaction('rollback');
				message_die(GENERAL_ERROR, 'Could not attach tags (deleting old ones failed)', '', __LINE__, __FILE__, $sql, $this->db);
				return false;
			}
		}

		$bs =& ServiceFactory::getServiceInstance('BookmarkService');
		$tts =& ServiceFactory::getServiceInstance('Tag2TagService');

		// Create links between tags
		foreach($tags as $key => $tag) {
			if(strpos($tag, '=')) {
				// case "="
				$pieces = explode('=', $tag);
				$nbPieces = count($pieces);
				if($nbPieces > 1) {
					for($i = 0; $i < $nbPieces-1; $i++) {
						$bookmark = $bs->getBookmark($bookmarkid);
						$uId = $bookmark['uId'];
						$tts->addLinkedTags($pieces[$i], $pieces[$i+1], '=', $uId);
					}
					$tags[$key] = $pieces[0]; // Attach just the last tag to the bookmark
				}
			} else {
				// case ">"
				$pieces = explode('>', $tag);
				$nbPieces = count($pieces);
				if($nbPieces > 1) {
					for($i = 0; $i < $nbPieces-1; $i++) {
						$bookmark = $bs->getBookmark($bookmarkid);
						$uId = $bookmark['uId'];
						$tts->addLinkedTags($pieces[$i], $pieces[$i+1], '>', $uId);
					}
					$tags[$key] = $pieces[$nbPieces-1]; // Attach just the last tag to the bookmark
				}
			}


		}

		// Add the categories to the DB.
		for ($i = 0; $i < count($tags); $i++) {
			if ($tags[$i] != '') {
				$values = array(
                    'bId' => intval($bookmarkid),
                    'tag' => $tags[$i]
				);

				if (!$this->hasTag($bookmarkid, $tags[$i])) {
					$sql = 'INSERT INTO '. $this->getTableName() .' '. $this->db->sql_build_array('INSERT', $values);
					if (!($dbresult =& $this->db->sql_query($sql))) {
						$this->db->sql_transaction('rollback');
						message_die(GENERAL_ERROR, 'Could not attach tags', '', __LINE__, __FILE__, $sql, $this->db);
						return false;
					}
				}
			}
		}
		$this->db->sql_transaction('commit');
		return true;
	}

	function deleteTag($uId, $tag) {
		$bs =& ServiceFactory::getServiceInstance('BookmarkService');

		$query = 'DELETE FROM '. $this->getTableName();
		$query.= ' USING '. $this->getTableName() .', '. $bs->getTableName();
		$query.= ' WHERE '. $this->getTableName() .'.bId = '. $bs->getTableName() .'.bId';
		$query.= ' AND '. $bs->getTableName() .'.uId = '. $uId;
		$query.= ' AND '. $this->getTableName() .'.tag = "'. $this->db->sql_escape($tag) .'"';

		if (!($dbresult =& $this->db->sql_query($query))) {
			message_die(GENERAL_ERROR, 'Could not delete tags', '', __LINE__, __FILE__, $query, $this->db);
			return false;
		}

		return true;
	}

	function deleteTagsForBookmark($bookmarkid) {
		if (!is_int($bookmarkid)) {
			message_die(GENERAL_ERROR, 'Could not delete tags (invalid bookmarkid)', '', __LINE__, __FILE__, $query);
			return false;
		}

		$query = 'DELETE FROM '. $this->getTableName() .' WHERE bId = '. intval($bookmarkid);

		if (!($dbresult =& $this->db->sql_query($query))) {
			message_die(GENERAL_ERROR, 'Could not delete tags', '', __LINE__, __FILE__, $query, $this->db);
			return false;
		}

		return true;
	}

	/* Allow deletion in admin page */
	function deleteTagsForUser($uId) {
		$qmask = 'DELETE FROM %s USING %s, %s WHERE %s.bId = %s.bId AND %s.uId = %d';
		$query = sprintf($qmask,
		$this->getTableName(),
		$this->getTableName(),
		$GLOBALS['tableprefix'].'bookmarks',
		$this->getTableName(),
		$GLOBALS['tableprefix'].'bookmarks',
		$GLOBALS['tableprefix'].'bookmarks',
		$uId);

		if (!($dbresult =& $this->db->sql_query($query))) {
			message_die(GENERAL_ERROR, 'Could not delete tags', '', __LINE__, __FILE__, $query, $this->db);
			return false;
		}

		return true;
	}

	function &getTagsForBookmark($bookmarkid) {
		if (!is_int($bookmarkid)) {
			message_die(GENERAL_ERROR, 'Could not get tags (invalid bookmarkid)', '', __LINE__, __FILE__, $query);
			return false;
		}

		$query = 'SELECT tag FROM '. $this->getTableName() .' WHERE bId = '. intval($bookmarkid) .' AND LEFT(tag, 7) <> "system:" ORDER BY tag';

		if (!($dbresult =& $this->db->sql_query($query))) {
			message_die(GENERAL_ERROR, 'Could not get tags', '', __LINE__, __FILE__, $query, $this->db);
			return false;
		}

		$tags = array();
		while ($row =& $this->db->sql_fetchrow($dbresult)) {
			$tags[] = $row['tag'];
		}

		return $tags;
	}

	function &getTags($userid = NULL) {
		$userservice =& ServiceFactory::getServiceInstance('UserService');
		$logged_on_user = $userservice->getCurrentUserId();

		$query = 'SELECT T.tag, COUNT(B.bId) AS bCount FROM '. $GLOBALS['tableprefix'] .'bookmarks AS B INNER JOIN '. $userservice->getTableName() .' AS U ON B.uId = U.'. $userservice->getFieldName('primary') .' INNER JOIN '. $GLOBALS['tableprefix'] .'bookmarks2tags AS T ON B.bId = T.bId';

		$conditions = array();
		if (!is_null($userid)) {
			$conditions['U.'. $userservice->getFieldName('primary')] = intval($userid);
			if ($logged_on_user != $userid)
			$conditions['B.bStatus'] = 0;
		} else {
			$conditions['B.bStatus'] = 0;
		}

		$query .= ' WHERE '. $this->db->sql_build_array('SELECT', $conditions) .' AND LEFT(T.tag, 7) <> "system:" GROUP BY T.tag ORDER BY bCount DESC, tag';

		if (!($dbresult =& $this->db->sql_query($query))) {
			message_die(GENERAL_ERROR, 'Could not get tags', '', __LINE__, __FILE__, $query, $this->db);
			return false;
		}

		$output = $this->db->sql_fetchrowset($dbresult);
		return $output;
	}


	// Returns the tags related to the specified tags; i.e. attached to the same bookmarks
	function &getRelatedTags($tags, $for_user = NULL, $logged_on_user = NULL, $limit = 10) {
		$conditions = array();
		// Only count the tags that are visible to the current user.
		if ($for_user != $logged_on_user || is_null($for_user))
		$conditions['B.bStatus'] = 0;

		if (!is_null($for_user))
		$conditions['B.uId'] = $for_user;

		// Set up the tags, if need be.
		if (is_numeric($tags))
		$tags = NULL;
		if (!is_array($tags) and !is_null($tags))
		$tags = explode('+', trim($tags));

		$tagcount = count($tags);
		for ($i = 0; $i < $tagcount; $i++) {
			$tags[$i] = trim($tags[$i]);
		}

		// Set up the SQL query.
		$query_1 = 'SELECT DISTINCTROW T0.tag, COUNT(B.bId) AS bCount FROM '. $GLOBALS['tableprefix'] .'bookmarks AS B, '. $this->getTableName() .' AS T0';
		$query_2 = '';
		$query_3 = ' WHERE B.bId = T0.bId ';
		if (count($conditions) > 0)
		$query_4 = ' AND '. $this->db->sql_build_array('SELECT', $conditions);
		else
		$query_4 = '';
		// Handle the parts of the query that depend on any tags that are present.
		for ($i = 1; $i <= $tagcount; $i++) {
			$query_2 .= ', '. $this->getTableName() .' AS T'. $i;
			$query_4 .= ' AND T'. $i .'.bId = B.bId AND T'. $i .'.tag = "'. $this->db->sql_escape($tags[$i - 1]) .'" AND T0.tag <> "'. $this->db->sql_escape($tags[$i - 1]) .'"';
		}
		$query_5 = ' AND LEFT(T0.tag, 7) <> "system:" GROUP BY T0.tag ORDER BY bCount DESC, T0.tag';
		$query = $query_1 . $query_2 . $query_3 . $query_4 . $query_5;

		if (! ($dbresult =& $this->db->sql_query_limit($query, $limit)) ){
			message_die(GENERAL_ERROR, 'Could not get related tags', '', __LINE__, __FILE__, $query, $this->db);
			return false;
		}
		$output = $this->db->sql_fetchrowset($dbresult);
		return $output;
	}

	// Returns the most popular tags used for a particular bookmark hash
	function &getRelatedTagsByHash($hash, $limit = 20) {
		$userservice = & ServiceFactory :: getServiceInstance('UserService');
		$sId = $userservice->getCurrentUserId();
		// Logged in
		if ($userservice->isLoggedOn()) {
			$arrWatch = $userservice->getWatchList($sId);
			// From public bookmarks or user's own
			$privacy = ' AND ((B.bStatus = 0) OR (B.uId = '. $sId .')';
			// From shared bookmarks in watchlist
			foreach ($arrWatch as $w) {
				$privacy .= ' OR (B.uId = '. $w .' AND B.bStatus = 1)';
			}
			$privacy .= ') ';
			// Not logged in
		} else {
			$privacy = ' AND B.bStatus = 0 ';
		}

		$query = 'SELECT T.tag, COUNT(T.tag) AS bCount FROM '.$GLOBALS['tableprefix'].'bookmarks AS B LEFT JOIN '.$GLOBALS['tableprefix'].'bookmarks2tags AS T ON B.bId = T.bId WHERE B.bHash = "'. $hash .'" '. $privacy .'AND LEFT(T.tag, 7) <> "system:" GROUP BY T.tag ORDER BY bCount DESC';

		if (!($dbresult =& $this->db->sql_query_limit($query, $limit))) {
			message_die(GENERAL_ERROR, 'Could not get related tags for this hash', '', __LINE__, __FILE__, $query, $this->db);
			return false;
		}
		$output = $this->db->sql_fetchrowset($dbresult);
		return $output;
	}

	function &getPopularTags($user = NULL, $limit = 30, $logged_on_user = NULL, $days = NULL) {
		// Only count the tags that are visible to the current user.
		if (($user != $logged_on_user) || is_null($user) || ($user === false))
		$privacy = ' AND B.bStatus = 0';
		else
		$privacy = '';

		if (is_null($days) || !is_int($days))
		$span = '';
		else
		$span = ' AND B.bDatetime > "'. date('Y-m-d H:i:s', time() - (86400 * $days)) .'"';

		$query = 'SELECT T.tag, COUNT(T.bId) AS bCount FROM '. $this->getTableName() .' AS T, '. $GLOBALS['tableprefix'] .'bookmarks AS B WHERE ';
		if (is_null($user) || ($user === false)) {
			$query .= 'B.bId = T.bId AND B.bStatus = 0';
		} else {
			$query .= 'B.uId = '. $this->db->sql_escape($user) .' AND B.bId = T.bId'. $privacy;
		}
		$query .= $span .' AND LEFT(T.tag, 7) <> "system:" GROUP BY T.tag ORDER BY bCount DESC, tag';

		if (!($dbresult =& $this->db->sql_query_limit($query, $limit))) {
			message_die(GENERAL_ERROR, 'Could not get popular tags', '', __LINE__, __FILE__, $query, $this->db);
			return false;
		}

		$output = $this->db->sql_fetchrowset($dbresult);
		return $output;
	}

	function hasTag($bookmarkid, $tag) {
		$query = 'SELECT COUNT(*) AS tCount FROM '. $this->getTableName() .' WHERE bId = '. intval($bookmarkid) .' AND tag ="'. $this->db->sql_escape($tag) .'"';

		if (! ($dbresult =& $this->db->sql_query($query)) ) {
			message_die(GENERAL_ERROR, 'Could not find tag', '', __LINE__, __FILE__, $query, $this->db);
			return false;
		}

		if ($row =& $this->db->sql_fetchrow($dbresult)) {
			if ($row['tCount'] > 0) {
				return true;
			}
		}
		return false;
	}

	function renameTag($userid, $old, $new, $fromApi = false) {
		$bookmarkservice =& ServiceFactory::getServiceInstance('BookmarkService');

		if (is_null($userid) || is_null($old) || is_null($new))
		return false;

		// Find bookmarks with old tag
		$bookmarksInfo =& $bookmarkservice->getBookmarks(0, NULL, $userid, $old);
		$bookmarks =& $bookmarksInfo['bookmarks'];

		// Delete old tag
		$this->deleteTag($userid, $old);

		// Attach new tags
		foreach(array_keys($bookmarks) as $key) {
			$row =& $bookmarks[$key];
			$this->attachTags($row['bId'], $new, $fromApi, NULL, false);
		}

		return true;
	}

	function &tagCloud($tags = NULL, $steps = 5, $sizemin = 90, $sizemax = 225, $sortOrder = NULL) {

		if (is_null($tags) || count($tags) < 1) {
			$output = false;
			return $output;
		}

		$min = $tags[count($tags) - 1]['bCount'];
		$max = $tags[0]['bCount'];

		for ($i = 1; $i <= $steps; $i++) {
			$delta = ($max - $min) / (2 * $steps - $i);
			$limit[$i] = $i * $delta + $min;
		}
		$sizestep = ($sizemax - $sizemin) / $steps;
		foreach ($tags as $row) {
			$next = false;
			for ($i = 1; $i <= $steps; $i++) {
				if (!$next && $row['bCount'] <= $limit[$i]) {
					$size = $sizestep * ($i - 1) + $sizemin;
					$next = true;
				}
			}
			$tempArray = array('size' => $size .'%');
			$row = array_merge($row, $tempArray);
			$output[] = $row;
		}

		if ($sortOrder == 'alphabet_asc') {
			usort($output, create_function('$a,$b','return strcasecmp(utf8_deaccent($a["tag"]), utf8_deaccent($b["tag"]));'));
		}

		return $output;
	}

	function deleteAll() {
		$query = 'TRUNCATE TABLE `'. $this->getTableName() .'`';
		$this->db->sql_query($query);
	}


	// Properties
	function getTableName()       { return $this->tablename; }
	function setTableName($value) { $this->tablename = $value; }
}
?>