projects.mako.cc - scuttle/blob - services/bookmarkservice.php

   1 <?php
   2 class BookmarkService {
   3     var $db;
   4
   5     function & getInstance(& $db) {
   6         static $instance;
   7         if (!isset ($instance))
   8             $instance = & new BookmarkService($db);
   9         return $instance;
  10     }
  11
  12     function BookmarkService(& $db) {
  13         $this->db = & $db;
  14     }
  15
  16     function _getbookmark($fieldname, $value, $all = false) {
  17         if (!$all) {
  18             $userservice = & ServiceFactory :: getServiceInstance('UserService');
  19             $sId = $userservice->getCurrentUserId();
  20             $range = ' AND uId = '. $sId;
  21         }
  22
  23         $query = 'SELECT * FROM '. $GLOBALS['tableprefix'] .'bookmarks WHERE '. $fieldname .' = "'. $this->db->sql_escape($value) .'"'. $range;
  24
  25         if (!($dbresult = & $this->db->sql_query_limit($query, 1, 0))) {
  26             message_die(GENERAL_ERROR, 'Could not get bookmark', '', __LINE__, __FILE__, $query, $this->db);
  27             return false;
  28         }
  29
  30         if ($row =& $this->db->sql_fetchrow($dbresult)) {
  31             return $row;
  32         } else {
  33             return false;
  34         }
  35     }
  36
  37     function & getBookmark($bid, $include_tags = false) {
  38         if (!is_numeric($bid))
  39             return;
  40
  41         $sql = 'SELECT * FROM '. $GLOBALS['tableprefix'] .'bookmarks WHERE bId = '. $this->db->sql_escape($bid);
  42
  43         if (!($dbresult = & $this->db->sql_query($sql)))
  44             message_die(GENERAL_ERROR, 'Could not get vars', '', __LINE__, __FILE__, $sql, $this->db);
  45
  46         if ($row = & $this->db->sql_fetchrow($dbresult)) {
  47             if ($include_tags) {
  48                 $tagservice = & ServiceFactory :: getServiceInstance('TagService');
  49                 $row['tags'] = $tagservice->getTagsForBookmark($bid);
  50             }
  51             return $row;
  52         } else {
  53             return false;
  54         }
  55     }
  56
  57     function getBookmarkByAddress($address) {
  58         $hash = md5($address);
  59         return $this->getBookmarkByHash($hash);
  60     }
  61
  62     function getBookmarkByHash($hash) {
  63         return $this->_getbookmark('bHash', $hash, true);
  64     }
  65
  66     function editAllowed($bookmark) {
  67         if (!is_numeric($bookmark) && (!is_array($bookmark) || !is_numeric($bookmark['bId'])))
  68             return false;
  69
  70         if (!is_array($bookmark))
  71             if (!($bookmark = $this->getBookmark($bookmark)))
  72                 return false;
  73
  74         $userservice = & ServiceFactory :: getServiceInstance('UserService');
  75         $userid = $userservice->getCurrentUserId();
  76         if ($userservice->isAdmin($userid))
  77             return true;
  78         else
  79             return ($bookmark['uId'] == $userid);
  80     }
  81
  82     function bookmarkExists($address = false, $uid = NULL) {
  83         if (!$address) {
  84             return;
  85         }
  86
  87         // If address doesn't contain ":", add "http://" as the default protocol
  88         if (strpos($address, ':') === false) {
  89             $address = 'http://'. $address;
  90         }
  91
  92         $crit = array ('bHash' => md5($address));
  93         if (isset ($uid)) {
  94             $crit['uId'] = $uid;
  95         }
  96
  97         $sql = 'SELECT COUNT(*) FROM '. $GLOBALS['tableprefix'] .'bookmarks WHERE '. $this->db->sql_build_array('SELECT', $crit);
  98         if (!($dbresult = & $this->db->sql_query($sql))) {
  99             message_die(GENERAL_ERROR, 'Could not get vars', '', __LINE__, __FILE__, $sql, $this->db);
 100         }
 101         return ($this->db->sql_fetchfield(0, 0) > 0);
 102     }
 103
 104     // Adds a bookmark to the database.
 105     // Note that date is expected to be a string that's interpretable by strtotime().
 106     function addBookmark($address, $title, $description, $status, $categories, $date = NULL, $fromApi = false, $fromImport = false) {
 107         $userservice = & ServiceFactory :: getServiceInstance('UserService');
 108         $sId = $userservice->getCurrentUserId();
 109
 110         // If bookmark address doesn't contain ":", add "http://" to the start as a default protocol
 111         if (strpos($address, ':') === false) {
 112             $address = 'http://'. $address;
 113         }
 114
 115         // Get the client's IP address and the date; note that the date is in GMT.
 116         if (getenv('HTTP_CLIENT_IP'))
 117             $ip = getenv('HTTP_CLIENT_IP');
 118         else
 119             if (getenv('REMOTE_ADDR'))
 120                 $ip = getenv('REMOTE_ADDR');
 121             else
 122                 $ip = getenv('HTTP_X_FORWARDED_FOR');
 123
 124         // Note that if date is NULL, then it's added with a date and time of now, and if it's present,
 125         // it's expected to be a string that's interpretable by strtotime().
 126         if (is_null($date))
 127             $time = time();
 128         else
 129             $time = strtotime($date);
 130         $datetime = gmdate('Y-m-d H:i:s', $time);
 131
 132         // Set up the SQL insert statement and execute it.
 133         $values = array('uId' => intval($sId), 'bIp' => $ip, 'bDatetime' => $datetime, 'bModified' => $datetime, 'bTitle' => $title, 'bAddress' => $address, 'bDescription' => $description, 'bStatus' => intval($status), 'bHash' => md5($address));
 134         $sql = 'INSERT INTO '. $GLOBALS['tableprefix'] .'bookmarks '. $this->db->sql_build_array('INSERT', $values);
 135         $this->db->sql_transaction('begin');
 136         if (!($dbresult = & $this->db->sql_query($sql))) {
 137             $this->db->sql_transaction('rollback');
 138             message_die(GENERAL_ERROR, 'Could not insert bookmark', '', __LINE__, __FILE__, $sql, $this->db);
 139             return false;
 140         }
 141         // Get the resultant row ID for the bookmark.
 142         $bId = $this->db->sql_nextid($dbresult);
 143         if (!isset($bId) || !is_int($bId)) {
 144             $this->db->sql_transaction('rollback');
 145             message_die(GENERAL_ERROR, 'Could not insert bookmark', '', __LINE__, __FILE__, $sql, $this->db);
 146             return false;
 147         }
 148
 149         $uriparts = explode('.', $address);
 150         $extension = end($uriparts);
 151         unset($uriparts);
 152
 153         $tagservice = & ServiceFactory :: getServiceInstance('TagService');
 154         if (!$tagservice->attachTags($bId, $categories, $fromApi, $extension, false, $fromImport)) {
 155             $this->db->sql_transaction('rollback');
 156             message_die(GENERAL_ERROR, 'Could not insert bookmark', '', __LINE__, __FILE__, $sql, $this->db);
 157             return false;
 158         }
 159         $this->db->sql_transaction('commit');
 160         // Everything worked out, so return the new bookmark's bId.
 161         return $bId;
 162     }
 163
 164     function updateBookmark($bId, $address, $title, $description, $status, $categories, $date = NULL, $fromApi = false) {
 165         if (!is_numeric($bId))
 166             return false;
 167
 168         // Get the client's IP address and the date; note that the date is in GMT.
 169         if (getenv('HTTP_CLIENT_IP'))
 170             $ip = getenv('HTTP_CLIENT_IP');
 171         else
 172             if (getenv('REMOTE_ADDR'))
 173                 $ip = getenv('REMOTE_ADDR');
 174             else
 175                 $ip = getenv('HTTP_X_FORWARDED_FOR');
 176
 177         $moddatetime = gmdate('Y-m-d H:i:s', time());
 178
 179         // Set up the SQL update statement and execute it.
 180         $updates = array('bModified' => $moddatetime, 'bTitle' => $title, 'bAddress' => $address, 'bDescription' => $description, 'bStatus' => $status, 'bHash' => md5($address));
 181
 182         if (!is_null($date)) {
 183             $datetime = gmdate('Y-m-d H:i:s', strtotime($date));
 184             $updates[] = array('bDateTime' => $datetime);
 185         }
 186
 187         $sql = 'UPDATE '. $GLOBALS['tableprefix'] .'bookmarks SET '. $this->db->sql_build_array('UPDATE', $updates) .' WHERE bId = '. intval($bId);
 188         $this->db->sql_transaction('begin');
 189
 190         if (!($dbresult = & $this->db->sql_query($sql))) {
 191             $this->db->sql_transaction('rollback');
 192             message_die(GENERAL_ERROR, 'Could not update bookmark', '', __LINE__, __FILE__, $sql, $this->db);
 193             return false;
 194         }
 195
 196         $uriparts = explode('.', $address);
 197         $extension = end($uriparts);
 198         unset($uriparts);
 199
 200         $tagservice = & ServiceFactory :: getServiceInstance('TagService');
 201         if (!$tagservice->attachTags($bId, $categories, $fromApi, $extension)) {
 202             $this->db->sql_transaction('rollback');
 203             message_die(GENERAL_ERROR, 'Could not update bookmark', '', __LINE__, __FILE__, $sql, $this->db);
 204             return false;
 205         }
 206
 207         $this->db->sql_transaction('commit');
 208         // Everything worked out, so return true.
 209         return true;
 210     }
 211
 212     function & getBookmarks($start = 0, $perpage = NULL, $user = NULL, $tags = NULL, $terms = NULL, $sortOrder = NULL, $watched = NULL, $startdate = NULL, $enddate = NULL, $hash = NULL) {
 213         // Only get the bookmarks that are visible to the current user.  Our rules:
 214         //  - if the $user is NULL, that means get bookmarks from ALL users, so we need to make
 215         //    sure to check the logged-in user's watchlist and get the contacts-only bookmarks from
 216         //    those users. If the user isn't logged-in, just get the public bookmarks.
 217         //  - if the $user is set and isn't the logged-in user, then get that user's bookmarks, and
 218         //    if that user is on the logged-in user's watchlist, get the public AND contacts-only
 219         //    bookmarks; otherwise, just get the public bookmarks.
 220         //  - if the $user is set and IS the logged-in user, then get all bookmarks.
 221         $userservice =& ServiceFactory::getServiceInstance('UserService');
 222         $tagservice =& ServiceFactory::getServiceInstance('TagService');
 223         $sId = $userservice->getCurrentUserId();
 224
 225         if ($userservice->isLoggedOn()) {
 226             // All public bookmarks, user's own bookmarks and any shared with user
 227             $privacy = ' AND ((B.bStatus = 0) OR (B.uId = '. $sId .')';
 228             $watchnames = $userservice->getWatchNames($sId, true);
 229             foreach($watchnames as $watchuser) {
 230                 $privacy .= ' OR (U.username = "'. $watchuser .'" AND B.bStatus = 1)';
 231             }
 232             $privacy .= ')';
 233         } else {
 234             // Just public bookmarks
 235             $privacy = ' AND B.bStatus = 0';
 236         }
 237
 238         // Set up the tags, if need be.
 239         if (!is_array($tags) && !is_null($tags)) {
 240             $tags = explode('+', trim($tags));
 241         }
 242
 243         $tagcount = count($tags);
 244         for ($i = 0; $i < $tagcount; $i ++) {
 245             $tags[$i] = trim($tags[$i]);
 246         }
 247
 248         // Set up the SQL query.
 249         $query_1 = 'SELECT DISTINCT ';
 250         if (SQL_LAYER == 'mysql4') {
 251             $query_1 .= 'SQL_CALC_FOUND_ROWS ';
 252         }
 253         $query_1 .= 'B.*, U.'. $userservice->getFieldName('username');
 254
 255         $query_2 = ' FROM '. $userservice->getTableName() .' AS U, '. $GLOBALS['tableprefix'] .'bookmarks AS B';
 256
 257         $query_3 = ' WHERE B.uId = U.'. $userservice->getFieldName('primary') . $privacy;
 258         if (is_null($watched)) {
 259             if (!is_null($user)) {
 260                 $query_3 .= ' AND B.uId = '. $user;
 261             }
 262         } else {
 263             $arrWatch = $userservice->getWatchlist($user);
 264             if (count($arrWatch) > 0) {
 265                 foreach($arrWatch as $row) {
 266                     $query_3_1 .= 'B.uId = '. intval($row) .' OR ';
 267                 }
 268                 $query_3_1 = substr($query_3_1, 0, -3);
 269             } else {
 270                 $query_3_1 = 'B.uId = -1';
 271             }
 272             $query_3 .= ' AND ('. $query_3_1 .') AND B.bStatus IN (0, 1)';
 273         }
 274
 275         switch($sortOrder) {
 276             case 'date_asc':
 277                 $query_5 = ' ORDER BY B.bDatetime ASC ';
 278                 break;
 279             case 'title_desc':
 280                 $query_5 = ' ORDER BY B.bTitle DESC ';
 281                 break;
 282             case 'title_asc':
 283                 $query_5 = ' ORDER BY B.bTitle ASC ';
 284                 break;
 285             case 'url_desc':
 286                 $query_5 = ' ORDER BY B.bAddress DESC ';
 287                 break;
 288             case 'url_asc':
 289                 $query_5 = ' ORDER BY B.bAddress ASC ';
 290                 break;
 291             default:
 292                 $query_5 = ' ORDER BY B.bDatetime DESC ';
 293         }
 294
 295         // Handle the parts of the query that depend on any tags that are present.
 296         $query_4 = '';
 297         for ($i = 0; $i < $tagcount; $i ++) {
 298             $query_2 .= ', '. $GLOBALS['tableprefix'] .'tags AS T'. $i;
 299             $query_4 .= ' AND T'. $i .'.tag = "'. $this->db->sql_escape($tags[$i]) .'" AND T'. $i .'.bId = B.bId';
 300         }
 301
 302         // Search terms
 303         if ($terms) {
 304             // Multiple search terms okay
 305             $aTerms = explode(' ', $terms);
 306             $aTerms = array_map('trim', $aTerms);
 307
 308             // Search terms in tags as well when none given
 309             if (!count($tags)) {
 310                 $query_2 .= ' LEFT JOIN '. $GLOBALS['tableprefix'] .'tags AS T ON B.bId = T.bId';
 311                 $dotags = true;
 312             } else {
 313                 $dotags = false;
 314             }
 315
 316             $query_4 = '';
 317             for ($i = 0; $i < count($aTerms); $i++) {
 318                 $query_4 .= ' AND (B.bTitle LIKE "%'. $this->db->sql_escape($aTerms[$i]) .'%"';
 319                 $query_4 .= ' OR B.bDescription LIKE "%'. $this->db->sql_escape($aTerms[$i]) .'%"';
 320                 if ($dotags) {
 321                     $query_4 .= ' OR T.tag = "'. $this->db->sql_escape($aTerms[$i]) .'"';
 322                 }
 323                 $query_4 .= ')';
 324             }
 325         }
 326
 327         // Start and end dates
 328         if ($startdate) {
 329             $query_4 .= ' AND B.bDatetime > "'. $startdate .'"';
 330         }
 331         if ($enddate) {
 332             $query_4 .= ' AND B.bDatetime < "'. $enddate .'"';
 333         }
 334
 335         // Hash
 336         if ($hash) {
 337             $query_4 .= ' AND B.bHash = "'. $hash .'"';
 338         }
 339
 340         $query = $query_1 . $query_2 . $query_3 . $query_4 . $query_5;
 341         if (!($dbresult = & $this->db->sql_query_limit($query, intval($perpage), intval($start)))) {
 342             message_die(GENERAL_ERROR, 'Could not get bookmarks', '', __LINE__, __FILE__, $query, $this->db);
 343             return false;
 344         }
 345
 346         if (SQL_LAYER == 'mysql4') {
 347             $totalquery = 'SELECT FOUND_ROWS() AS total';
 348         } else {
 349             $totalquery = 'SELECT COUNT(*) AS total'. $query_2 . $query_3 . $query_4;
 350         }
 351
 352         if (!($totalresult = & $this->db->sql_query($totalquery)) || (!($row = & $this->db->sql_fetchrow($totalresult)))) {
 353             message_die(GENERAL_ERROR, 'Could not get total bookmarks', '', __LINE__, __FILE__, $totalquery, $this->db);
 354             return false;
 355         }
 356
 357         $total = $row['total'];
 358
 359         $bookmarks = array();
 360         while ($row = & $this->db->sql_fetchrow($dbresult)) {
 361             $row['tags'] = $tagservice->getTagsForBookmark(intval($row['bId']));
 362             $bookmarks[] = $row;
 363         }
 364         return array ('bookmarks' => $bookmarks, 'total' => $total);
 365     }
 366
 367     function deleteBookmark($bookmarkid) {
 368         $query = 'DELETE FROM '. $GLOBALS['tableprefix'] .'bookmarks WHERE bId = '. intval($bookmarkid);
 369         $this->db->sql_transaction('begin');
 370         if (!($dbresult = & $this->db->sql_query($query))) {
 371             $this->db->sql_transaction('rollback');
 372             message_die(GENERAL_ERROR, 'Could not delete bookmarks', '', __LINE__, __FILE__, $query, $this->db);
 373             return false;
 374         }
 375
 376         $query = 'DELETE FROM '. $GLOBALS['tableprefix'] .'tags WHERE bId = '. intval($bookmarkid);
 377         $this->db->sql_transaction('begin');
 378         if (!($dbresult = & $this->db->sql_query($query))) {
 379             $this->db->sql_transaction('rollback');
 380             message_die(GENERAL_ERROR, 'Could not delete bookmarks', '', __LINE__, __FILE__, $query, $this->db);
 381             return false;
 382         }
 383
 384         $this->db->sql_transaction('commit');
 385         return true;
 386     }
 387
 388     function countOthers($address) {
 389         if (!$address) {
 390             return false;
 391         }
 392
 393         $userservice = & ServiceFactory :: getServiceInstance('UserService');
 394         $sId = $userservice->getCurrentUserId();
 395
 396         if ($userservice->isLoggedOn()) {
 397             // All public bookmarks, user's own bookmarks and any shared with user
 398             $privacy = ' AND ((B.bStatus = 0) OR (B.uId = '. $sId .')';
 399             $watchnames = $userservice->getWatchNames($sId, true);
 400             foreach($watchnames as $watchuser) {
 401                 $privacy .= ' OR (U.username = "'. $watchuser .'" AND B.bStatus = 1)';
 402             }
 403             $privacy .= ')';
 404         } else {
 405             // Just public bookmarks
 406             $privacy = ' AND B.bStatus = 0';
 407         }
 408
 409         $sql = 'SELECT COUNT(*) FROM '. $userservice->getTableName() .' AS U, '. $GLOBALS['tableprefix'] .'bookmarks AS B WHERE U.'. $userservice->getFieldName('primary') .' = B.uId AND B.bHash = "'. md5($address) .'"'. $privacy;
 410         if (!($dbresult = & $this->db->sql_query($sql))) {
 411             message_die(GENERAL_ERROR, 'Could not get vars', '', __LINE__, __FILE__, $sql, $this->db);
 412         }
 413         return $this->db->sql_fetchfield(0, 0) - 1;
 414     }
 415 }
 416 ?>