]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - classes/Notice.php
Merge branch 'inblob' of git@gitorious.org:~evan/statusnet/evans-mainline into inblob
[quix0rs-gnu-social.git] / classes / Notice.php
index a7b0f8cdbc65459a68c225e2b2c909c05f8361c2..6284b8ca518947c16c37560a9b61c982ac928614 100644 (file)
@@ -63,7 +63,7 @@ class Notice extends Memcached_DataObject
     public $created;                         // datetime  multiple_key not_null default_0000-00-00%2000%3A00%3A00
     public $modified;                        // timestamp   not_null default_CURRENT_TIMESTAMP
     public $reply_to;                        // int(4)
-    public $is_local;                        // tinyint(1)
+    public $is_local;                        // int(4)
     public $source;                          // varchar(32)
     public $conversation;                    // int(4)
     public $lat;                             // decimal(10,7)
@@ -125,8 +125,7 @@ class Notice extends Memcached_DataObject
                          'Fave',
                          'Notice_tag',
                          'Group_inbox',
-                         'Queue_item',
-                         'Notice_inbox');
+                         'Queue_item');
 
         foreach ($related as $cls) {
             $inst = new $cls();
@@ -175,16 +174,46 @@ class Notice extends Memcached_DataObject
         }
     }
 
+    /**
+     * Save a new notice and push it out to subscribers' inboxes.
+     * Poster's permissions are checked before sending.
+     *
+     * @param int $profile_id Profile ID of the poster
+     * @param string $content source message text; links may be shortened
+     *                        per current user's preference
+     * @param string $source source key ('web', 'api', etc)
+     * @param array $options Associative array of optional properties:
+     *              string 'created' timestamp of notice; defaults to now
+     *              int 'is_local' source/gateway ID, one of:
+     *                  Notice::LOCAL_PUBLIC    - Local, ok to appear in public timeline
+     *                  Notice::REMOTE_OMB      - Sent from a remote OMB service;
+     *                                            hide from public timeline but show in
+     *                                            local "and friends" timelines
+     *                  Notice::LOCAL_NONPUBLIC - Local, but hide from public timeline
+     *                  Notice::GATEWAY         - From another non-OMB service;
+     *                                            will not appear in public views
+     *              float 'lat' decimal latitude for geolocation
+     *              float 'lon' decimal longitude for geolocation
+     *              int 'location_id' geoname identifier
+     *              int 'location_ns' geoname namespace to interpret location_id
+     *              int 'reply_to'; notice ID this is a reply to
+     *              int 'repeat_of'; notice ID this is a repeat of
+     *              string 'uri' permalink to notice; defaults to local notice URL
+     *
+     * @return Notice
+     * @throws ClientException
+     */
     static function saveNew($profile_id, $content, $source, $options=null) {
+        $defaults = array('uri' => null,
+                          'reply_to' => null,
+                          'repeat_of' => null);
 
         if (!empty($options)) {
+            $options = $options + $defaults;
             extract($options);
-            if (!isset($reply_to)) {
-                $reply_to = NULL;
-            }
         }
 
-        if (empty($is_local)) {
+        if (!isset($is_local)) {
             $is_local = Notice::LOCAL_PUBLIC;
         }
 
@@ -259,21 +288,11 @@ class Notice extends Memcached_DataObject
         if (!empty($lat) && !empty($lon)) {
             $notice->lat = $lat;
             $notice->lon = $lon;
+        }
+
+        if (!empty($location_ns) && !empty($location_id)) {
             $notice->location_id = $location_id;
             $notice->location_ns = $location_ns;
-        } else if (!empty($location_ns) && !empty($location_id)) {
-            $location = Location::fromId($location_id, $location_ns);
-            if (!empty($location)) {
-                $notice->lat = $location->lat;
-                $notice->lon = $location->lon;
-                $notice->location_id = $location_id;
-                $notice->location_ns = $location_ns;
-            }
-        } else {
-            $notice->lat         = $profile->lat;
-            $notice->lon         = $profile->lon;
-            $notice->location_id = $profile->location_id;
-            $notice->location_ns = $profile->location_ns;
         }
 
         if (Event::handle('StartNoticeSave', array(&$notice))) {
@@ -483,6 +502,9 @@ class Notice extends Memcached_DataObject
                     $original->free();
                     unset($original);
                 }
+
+                $ni->free();
+                unset($ni);
             }
         }
     }
@@ -516,8 +538,18 @@ class Notice extends Memcached_DataObject
                     if ($member->find()) {
                         while ($member->fetch()) {
                             $cache->delete(common_cache_key('notice_inbox:by_user:' . $member->profile_id));
+                            $cache->delete(common_cache_key('notice_inbox:by_user_own:' . $member->profile_id));
+                            if (empty($this->repeat_of)) {
+                                $cache->delete(common_cache_key('user:friends_timeline:' . $member->profile_id));
+                                $cache->delete(common_cache_key('user:friends_timeline_own:' . $member->profile_id));
+                            }
                             if ($blowLast) {
                                 $cache->delete(common_cache_key('notice_inbox:by_user:' . $member->profile_id . ';last'));
+                                $cache->delete(common_cache_key('notice_inbox:by_user_own:' . $member->profile_id . ';last'));
+                                if (empty($this->repeat_of)) {
+                                    $cache->delete(common_cache_key('user:friends_timeline:' . $member->profile_id . ';last'));
+                                    $cache->delete(common_cache_key('user:friends_timeline_own:' . $member->profile_id . ';last'));
+                                }
                             }
                         }
                     }
@@ -565,9 +597,17 @@ class Notice extends Memcached_DataObject
             while ($user->fetch()) {
                 $cache->delete(common_cache_key('notice_inbox:by_user:'.$user->id));
                 $cache->delete(common_cache_key('notice_inbox:by_user_own:'.$user->id));
+                if (empty($this->repeat_of)) {
+                    $cache->delete(common_cache_key('user:friends_timeline:'.$user->id));
+                    $cache->delete(common_cache_key('user:friends_timeline_own:'.$user->id));
+                }
                 if ($blowLast) {
                     $cache->delete(common_cache_key('notice_inbox:by_user:'.$user->id.';last'));
                     $cache->delete(common_cache_key('notice_inbox:by_user_own:'.$user->id.';last'));
+                    if (empty($this->repeat_of)) {
+                        $cache->delete(common_cache_key('user:friends_timeline:'.$user->id.';last'));
+                        $cache->delete(common_cache_key('user:friends_timeline_own:'.$user->id.';last'));
+                    }
                 }
             }
             $user->free();
@@ -641,193 +681,6 @@ class Notice extends Memcached_DataObject
         }
     }
 
-    # XXX: too many args; we need to move to named params or even a separate
-    # class for notice streams
-
-    static function getStream($qry, $cachekey, $offset=0, $limit=20, $since_id=0, $max_id=0, $order=null, $since=null) {
-
-        if (common_config('memcached', 'enabled')) {
-
-            # Skip the cache if this is a since, since_id or max_id qry
-            if ($since_id > 0 || $max_id > 0 || $since) {
-                return Notice::getStreamDirect($qry, $offset, $limit, $since_id, $max_id, $order, $since);
-            } else {
-                return Notice::getCachedStream($qry, $cachekey, $offset, $limit, $order);
-            }
-        }
-
-        return Notice::getStreamDirect($qry, $offset, $limit, $since_id, $max_id, $order, $since);
-    }
-
-    static function getStreamDirect($qry, $offset, $limit, $since_id, $max_id, $order, $since) {
-
-        $needAnd = false;
-        $needWhere = true;
-
-        if (preg_match('/\bWHERE\b/i', $qry)) {
-            $needWhere = false;
-            $needAnd = true;
-        }
-
-        if ($since_id > 0) {
-
-            if ($needWhere) {
-                $qry .= ' WHERE ';
-                $needWhere = false;
-            } else {
-                $qry .= ' AND ';
-            }
-
-            $qry .= ' notice.id > ' . $since_id;
-        }
-
-        if ($max_id > 0) {
-
-            if ($needWhere) {
-                $qry .= ' WHERE ';
-                $needWhere = false;
-            } else {
-                $qry .= ' AND ';
-            }
-
-            $qry .= ' notice.id <= ' . $max_id;
-        }
-
-        if ($since) {
-
-            if ($needWhere) {
-                $qry .= ' WHERE ';
-                $needWhere = false;
-            } else {
-                $qry .= ' AND ';
-            }
-
-            $qry .= ' notice.created > \'' . date('Y-m-d H:i:s', $since) . '\'';
-        }
-
-        # Allow ORDER override
-
-        if ($order) {
-            $qry .= $order;
-        } else {
-            $qry .= ' ORDER BY notice.created DESC, notice.id DESC ';
-        }
-
-        if (common_config('db','type') == 'pgsql') {
-            $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
-        } else {
-            $qry .= ' LIMIT ' . $offset . ', ' . $limit;
-        }
-
-        $notice = new Notice();
-
-        $notice->query($qry);
-
-        return $notice;
-    }
-
-    # XXX: this is pretty long and should probably be broken up into
-    # some helper functions
-
-    static function getCachedStream($qry, $cachekey, $offset, $limit, $order) {
-
-        # If outside our cache window, just go to the DB
-
-        if ($offset + $limit > NOTICE_CACHE_WINDOW) {
-            return Notice::getStreamDirect($qry, $offset, $limit, null, null, $order, null);
-        }
-
-        # Get the cache; if we can't, just go to the DB
-
-        $cache = common_memcache();
-
-        if (empty($cache)) {
-            return Notice::getStreamDirect($qry, $offset, $limit, null, null, $order, null);
-        }
-
-        # Get the notices out of the cache
-
-        $notices = $cache->get(common_cache_key($cachekey));
-
-        # On a cache hit, return a DB-object-like wrapper
-
-        if ($notices !== false) {
-            $wrapper = new ArrayWrapper(array_slice($notices, $offset, $limit));
-            return $wrapper;
-        }
-
-        # If the cache was invalidated because of new data being
-        # added, we can try and just get the new stuff. We keep an additional
-        # copy of the data at the key + ';last'
-
-        # No cache hit. Try to get the *last* cached version
-
-        $last_notices = $cache->get(common_cache_key($cachekey) . ';last');
-
-        if ($last_notices) {
-
-            # Reverse-chron order, so last ID is last.
-
-            $last_id = $last_notices[0]->id;
-
-            # XXX: this assumes monotonically increasing IDs; a fair
-            # bet with our DB.
-
-            $new_notice = Notice::getStreamDirect($qry, 0, NOTICE_CACHE_WINDOW,
-                                                  $last_id, null, $order, null);
-
-            if ($new_notice) {
-                $new_notices = array();
-                while ($new_notice->fetch()) {
-                    $new_notices[] = clone($new_notice);
-                }
-                $new_notice->free();
-                $notices = array_slice(array_merge($new_notices, $last_notices),
-                                       0, NOTICE_CACHE_WINDOW);
-
-                # Store the array in the cache for next time
-
-                $result = $cache->set(common_cache_key($cachekey), $notices);
-                $result = $cache->set(common_cache_key($cachekey) . ';last', $notices);
-
-                # return a wrapper of the array for use now
-
-                return new ArrayWrapper(array_slice($notices, $offset, $limit));
-            }
-        }
-
-        # Otherwise, get the full cache window out of the DB
-
-        $notice = Notice::getStreamDirect($qry, 0, NOTICE_CACHE_WINDOW, null, null, $order, null);
-
-        # If there are no hits, just return the value
-
-        if (empty($notice)) {
-            return $notice;
-        }
-
-        # Pack results into an array
-
-        $notices = array();
-
-        while ($notice->fetch()) {
-            $notices[] = clone($notice);
-        }
-
-        $notice->free();
-
-        # Store the array in the cache for next time
-
-        $result = $cache->set(common_cache_key($cachekey), $notices);
-        $result = $cache->set(common_cache_key($cachekey) . ';last', $notices);
-
-        # return a wrapper of the array for use now
-
-        $wrapper = new ArrayWrapper(array_slice($notices, $offset, $limit));
-
-        return $wrapper;
-    }
-
     function getStreamByIds($ids)
     {
         $cache = common_memcache();
@@ -977,12 +830,8 @@ class Notice extends Memcached_DataObject
         return $ids;
     }
 
-    function addToInboxes()
+    function whoGets()
     {
-        // XXX: loads constants
-
-        $inbox = new Notice_inbox();
-
         $users = $this->getSubscribedUsers();
 
         // FIXME: kind of ignoring 'transitional'...
@@ -1022,7 +871,14 @@ class Notice extends Memcached_DataObject
             }
         }
 
-        Notice_inbox::bulkInsert($this->id, $this->created, $ni);
+        return $ni;
+    }
+
+    function addToInboxes()
+    {
+        $ni = $this->whoGets();
+
+        Inbox::bulkInsert($this->id, array_keys($ni));
 
         return;
     }
@@ -1121,6 +977,9 @@ class Notice extends Memcached_DataObject
         return true;
     }
 
+    /**
+     * @return array of integer profile IDs
+     */
     function saveReplies()
     {
         // Alternative reply format
@@ -1199,8 +1058,8 @@ class Notice extends Memcached_DataObject
 
         $recipientIds = array_keys($replied);
 
-        foreach ($recipientIds as $recipient) {
-            $user = User::staticGet('id', $recipient);
+        foreach ($recipientIds as $recipientId) {
+            $user = User::staticGet('id', $recipientId);
             if ($user) {
                 mail_notify_attn($user, $this);
             }
@@ -1261,7 +1120,7 @@ class Notice extends Memcached_DataObject
         $xs->element('id', null, $this->uri);
 
         $xs->element('published', null, common_date_w3dtf($this->created));
-        $xs->element('updated', null, common_date_w3dtf($this->modified));
+        $xs->element('updated', null, common_date_w3dtf($this->created));
 
         if ($this->reply_to) {
             $reply_notice = Notice::staticGet('id', $this->reply_to);
@@ -1339,7 +1198,7 @@ class Notice extends Memcached_DataObject
 
         $idstr = $cache->get($idkey);
 
-        if (!empty($idstr)) {
+        if ($idstr !== false) {
             // Cache hit! Woohoo!
             $window = explode(',', $idstr);
             $ids = array_slice($window, $offset, $limit);
@@ -1348,7 +1207,7 @@ class Notice extends Memcached_DataObject
 
         $laststr = $cache->get($idkey.';last');
 
-        if (!empty($laststr)) {
+        if ($laststr !== false) {
             $window = explode(',', $laststr);
             $last_id = $window[0];
             $new_ids = call_user_func_array($fn, array_merge($args, array(0, NOTICE_CACHE_WINDOW,
@@ -1488,12 +1347,21 @@ class Notice extends Memcached_DataObject
     {
         $author = Profile::staticGet('id', $this->profile_id);
 
-        // FIXME: truncate on long repeats...?
-
         $content = sprintf(_('RT @%1$s %2$s'),
                            $author->nickname,
                            $this->content);
 
+        $maxlen = common_config('site', 'textlimit');
+        if ($maxlen > 0 && mb_strlen($content) > $maxlen) {
+            // Web interface and current Twitter API clients will
+            // pull the original notice's text, but some older
+            // clients and RSS/Atom feeds will see this trimmed text.
+            //
+            // Unfortunately this is likely to lose tags or URLs
+            // at the end of long notices.
+            $content = mb_substr($content, 0, $maxlen - 4) . ' ...';
+        }
+
         return self::saveNew($repeater_id, $content, $source,
                              array('repeat_of' => $this->id));
     }
@@ -1508,7 +1376,7 @@ class Notice extends Memcached_DataObject
             $ids = $this->_repeatStreamDirect($limit);
         } else {
             $idstr = $cache->get(common_cache_key('notice:repeats:'.$this->id));
-            if (!empty($idstr)) {
+            if ($idstr !== false) {
                 $ids = explode(',', $idstr);
             } else {
                 $ids = $this->_repeatStreamDirect(100);
@@ -1551,4 +1419,47 @@ class Notice extends Memcached_DataObject
 
         return $ids;
     }
+
+    function locationOptions($lat, $lon, $location_id, $location_ns, $profile = null)
+    {
+        $options = array();
+
+        if (!empty($location_id) && !empty($location_ns)) {
+
+            $options['location_id'] = $location_id;
+            $options['location_ns'] = $location_ns;
+
+            $location = Location::fromId($location_id, $location_ns);
+
+            if (!empty($location)) {
+                $options['lat'] = $location->lat;
+                $options['lon'] = $location->lon;
+            }
+
+        } else if (!empty($lat) && !empty($lon)) {
+
+            $options['lat'] = $lat;
+            $options['lon'] = $lon;
+
+            $location = Location::fromLatLon($lat, $lon);
+
+            if (!empty($location)) {
+                $options['location_id'] = $location->location_id;
+                $options['location_ns'] = $location->location_ns;
+            }
+        } else if (!empty($profile)) {
+
+            if (isset($profile->lat) && isset($profile->lon)) {
+                $options['lat'] = $profile->lat;
+                $options['lon'] = $profile->lon;
+            }
+
+            if (isset($profile->location_id) && isset($profile->location_ns)) {
+                $options['location_id'] = $profile->location_id;
+                $options['location_ns'] = $profile->location_ns;
+            }
+        }
+
+        return $options;
+    }
 }