]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - classes/Notice.php
Properly structure X-XSS-Protection header
[quix0rs-gnu-social.git] / classes / Notice.php
index b948e9de733af6708183ab223d49196c25482d40..650dca051b359727ec00cc64c8f44b07cd280a3e 100644 (file)
@@ -1,7 +1,7 @@
 <?php
 /**
  * StatusNet - the distributed open-source microblogging tool
- * Copyright (C) 2008, 2009, StatusNet, Inc.
+ * Copyright (C) 2008-2011 StatusNet, Inc.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as published by
@@ -84,9 +84,14 @@ class Notice extends Memcached_DataObject
     /* the code above is auto generated do not remove the tag below */
     ###END_AUTOCODE
 
+       function multiGet($kc, $kvs, $skipNulls=true)
+       {
+               return Memcached_DataObject::multiGet('Notice', $kc, $kvs, $skipNulls);
+       }
+       
     /* Notice types */
     const LOCAL_PUBLIC    =  1;
-    const REMOTE_OMB      =  0;
+    const REMOTE          =  0;
     const LOCAL_NONPUBLIC = -1;
     const GATEWAY         = -2;
 
@@ -96,17 +101,21 @@ class Notice extends Memcached_DataObject
     const GROUP_SCOPE     = 4;
     const FOLLOWER_SCOPE  = 8;
 
+    protected $_profile = -1;
+
     function getProfile()
     {
-        $profile = Profile::staticGet('id', $this->profile_id);
+        if (is_int($this->_profile) && $this->_profile == -1) {
+            $this->_profile = Profile::staticGet('id', $this->profile_id);
 
-        if (empty($profile)) {
-            // TRANS: Server exception thrown when a user profile for a notice cannot be found.
-            // TRANS: %1$d is a profile ID (number), %2$d is a notice ID (number).
-            throw new ServerException(sprintf(_('No such profile (%1$d) for notice (%2$d).'), $this->profile_id, $this->id));
+            if (empty($this->_profile)) {
+                // TRANS: Server exception thrown when a user profile for a notice cannot be found.
+                // TRANS: %1$d is a profile ID (number), %2$d is a notice ID (number).
+                throw new ServerException(sprintf(_('No such profile (%1$d) for notice (%2$d).'), $this->profile_id, $this->id));
+            }
         }
 
-        return $profile;
+        return $this->_profile;
     }
 
     function delete()
@@ -204,7 +213,7 @@ class Notice extends Memcached_DataObject
 
         if (!$id) {
             // TRANS: Server exception. %s are the error details.
-            throw new ServerException(sprintf(_('Database error inserting hashtag: %s'),
+            throw new ServerException(sprintf(_('Database error inserting hashtag: %s.'),
                                               $last_error->message));
             return;
         }
@@ -225,11 +234,11 @@ class Notice extends Memcached_DataObject
      *              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;
+     *                  Notice::REMOTE          - Sent from a remote 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;
+     *                  Notice::GATEWAY         - From another non-OStatus service;
      *                                            will not appear in public views
      *              float 'lat' decimal latitude for geolocation
      *              float 'lon' decimal longitude for geolocation
@@ -444,7 +453,7 @@ class Notice extends Memcached_DataObject
             if (!empty($reply)) {
                 $notice->scope = $reply->scope;
             } else {
-                $notice->scope = common_config('notice', 'defaultscope');
+                $notice->scope = self::defaultScope();
             }
         } else {
             $notice->scope = $scope;
@@ -557,10 +566,10 @@ class Notice extends Memcached_DataObject
 
     function blowOnInsert($conversation = false)
     {
-        self::blow('profile:notice_ids:%d', $this->profile_id);
+        $this->blowStream('profile:notice_ids:%d', $this->profile_id);
 
         if ($this->isPublic()) {
-            self::blow('public');
+            $this->blowStream('public');
         }
 
         // XXX: Before we were blowing the casche only if the notice id
@@ -570,7 +579,7 @@ class Notice extends Memcached_DataObject
         self::blow('conversation::notice_count:%d', $this->conversation);
 
         if (!empty($this->repeat_of)) {
-            self::blow('notice:repeats:%d', $this->repeat_of);
+            $this->blowStream('notice:repeats:%d', $this->repeat_of);
         }
 
         $original = Notice::staticGet('id', $this->repeat_of);
@@ -578,14 +587,20 @@ class Notice extends Memcached_DataObject
         if (!empty($original)) {
             $originalUser = User::staticGet('id', $original->profile_id);
             if (!empty($originalUser)) {
-                self::blow('user:repeats_of_me:%d', $originalUser->id);
+                $this->blowStream('user:repeats_of_me:%d', $originalUser->id);
             }
         }
 
         $profile = Profile::staticGet($this->profile_id);
+
         if (!empty($profile)) {
             $profile->blowNoticeCount();
         }
+
+        $ptags = $this->getProfileTags();
+        foreach ($ptags as $ptag) {
+            $ptag->blowNoticeStreamCache();
+        }
     }
 
     /**
@@ -608,6 +623,47 @@ class Notice extends Memcached_DataObject
             // In case we're the first, will need to calc a new root.
             self::blow('notice:conversation_root:%d', $this->conversation);
         }
+
+        $ptags = $this->getProfileTags();
+        foreach ($ptags as $ptag) {
+            $ptag->blowNoticeStreamCache(true);
+        }
+    }
+
+    function blowStream()
+    {
+        $c = self::memcache();
+
+        if (empty($c)) {
+            return false;
+        }
+
+        $args = func_get_args();
+
+        $format = array_shift($args);
+
+        $keyPart = vsprintf($format, $args);
+
+        $cacheKey = Cache::key($keyPart);
+        
+        $c->delete($cacheKey);
+
+        // delete the "last" stream, too, if this notice is
+        // older than the top of that stream
+
+        $lastKey = $cacheKey.';last';
+
+        $lastStr = $c->get($lastKey);
+
+        if ($lastStr !== false) {
+            $window     = explode(',', $lastStr);
+            $lastID     = $window[0];
+            $lastNotice = Notice::staticGet('id', $lastID);
+            if (empty($lastNotice) // just weird
+                || strtotime($lastNotice->created) >= strtotime($this->created)) {
+                $c->delete($lastKey);
+            }
+        }
     }
 
     /** save all urls in the notice to the db
@@ -727,6 +783,7 @@ class Notice extends Memcached_DataObject
         if ($idstr !== false) {
             $ids = explode(',', $idstr);
         } else {
+            $ids = array();
             $f2p = new File_to_post;
             $f2p->post_id = $this->id;
             if ($f2p->find()) {
@@ -791,30 +848,65 @@ class Notice extends Memcached_DataObject
      *
      * @return Notice or null
      */
-    function conversationRoot()
+    function conversationRoot($profile=-1)
     {
-        if (!empty($this->conversation)) {
-            $c = self::memcache();
+        // XXX: can this happen?
 
-            $key = Cache::key('notice:conversation_root:' . $this->conversation);
-            $notice = $c->get($key);
-            if ($notice) {
-                return $notice;
-            }
+        if (empty($this->conversation)) {
+            return null;
+        }
 
-            $notice = new Notice();
-            $notice->conversation = $this->conversation;
-            $notice->orderBy('CREATED');
-            $notice->limit(1);
-            $notice->find(true);
+        // Get the current profile if not specified
 
-            if ($notice->N) {
-                $c->set($key, $notice);
-                return $notice;
-            }
+        if (is_int($profile) && $profile == -1) {
+            $profile = Profile::current();
         }
-        return null;
+
+        // If this notice is out of scope, no root for you!
+
+        if (!$this->inScope($profile)) {
+            return null;
+        }
+
+        // If this isn't a reply to anything, then it's its own
+        // root.
+
+        if (empty($this->reply_to)) {
+            return $this;
+        }
+        
+        if (is_null($profile)) {
+            $keypart = sprintf('notice:conversation_root:%d:null', $this->id);
+        } else {
+            $keypart = sprintf('notice:conversation_root:%d:%d',
+                               $this->id,
+                               $profile->id);
+        }
+            
+        $root = self::cacheGet($keypart);
+
+        if ($root !== false && $root->inScope($profile)) {
+            return $root;
+        } else {
+            $last = $this;
+
+            do {
+                $parent = $last->getOriginal();
+                if (!empty($parent) && $parent->inScope($profile)) {
+                    $last = $parent;
+                    continue;
+                } else {
+                    $root = $last;
+                    break;
+                }
+            } while (!empty($parent));
+
+            self::cacheSet($keypart, $root);
+        }
+
+        return $root;
     }
+
     /**
      * Pull up a full list of local recipients who will be getting
      * this notice in their inbox. Results will be cached, so don't
@@ -846,6 +938,7 @@ class Notice extends Memcached_DataObject
         }
 
         $users = $this->getSubscribedUsers();
+        $ptags = $this->getProfileTags();
 
         // FIXME: kind of ignoring 'transitional'...
         // we'll probably stop supporting inboxless mode
@@ -869,27 +962,39 @@ class Notice extends Memcached_DataObject
                 }
             }
 
+            foreach ($ptags as $ptag) {
+                $users = $ptag->getUserSubscribers();
+                foreach ($users as $id) {
+                    if (!array_key_exists($id, $ni)) {
+                        $user = User::staticGet('id', $id);
+                        if (!$user->hasBlocked($profile)) {
+                            $ni[$id] = NOTICE_INBOX_SOURCE_PROFILE_TAG;
+                        }
+                    }
+                }
+            }
+
             foreach ($recipients as $recipient) {
                 if (!array_key_exists($recipient, $ni)) {
                     $ni[$recipient] = NOTICE_INBOX_SOURCE_REPLY;
                 }
-            }
 
-            // Exclude any deleted, non-local, or blocking recipients.
-            $profile = $this->getProfile();
-            $originalProfile = null;
-            if ($this->repeat_of) {
-                // Check blocks against the original notice's poster as well.
-                $original = Notice::staticGet('id', $this->repeat_of);
-                if ($original) {
-                    $originalProfile = $original->getProfile();
+                // Exclude any deleted, non-local, or blocking recipients.
+                $profile = $this->getProfile();
+                $originalProfile = null;
+                if ($this->repeat_of) {
+                    // Check blocks against the original notice's poster as well.
+                    $original = Notice::staticGet('id', $this->repeat_of);
+                    if ($original) {
+                        $originalProfile = $original->getProfile();
+                    }
                 }
-            }
-            foreach ($ni as $id => $source) {
-                $user = User::staticGet('id', $id);
-                if (empty($user) || $user->hasBlocked($profile) ||
-                    ($originalProfile && $user->hasBlocked($originalProfile))) {
-                    unset($ni[$id]);
+                foreach ($ni as $id => $source) {
+                    $user = User::staticGet('id', $id);
+                    if (empty($user) || $user->hasBlocked($profile) ||
+                        ($originalProfile && $user->hasBlocked($originalProfile))) {
+                        unset($ni[$id]);
+                    }
                 }
             }
 
@@ -969,6 +1074,19 @@ class Notice extends Memcached_DataObject
         return $ids;
     }
 
+    function getProfileTags()
+    {
+        $profile = $this->getProfile();
+        $list    = $profile->getOtherTags($profile);
+        $ptags   = array();
+
+        while($list->fetch()) {
+            $ptags[] = clone($list);
+        }
+
+        return $ptags;
+    }
+
     /**
      * Record this notice to the given group inboxes for delivery.
      * Overrides the regular parsing of !group markup.
@@ -995,13 +1113,15 @@ class Notice extends Memcached_DataObject
                     common_log_db_error($gi, 'INSERT', __FILE__);
                 }
 
-                // we automatically add a tag for every group name, too
+                if (common_config('group', 'addtag')) {
+                    // we automatically add a tag for every group name, too
 
-                $tag = Notice_tag::pkeyGet(array('tag' => common_canonical_tag($group->nickname),
-                                                 'notice_id' => $this->id));
+                    $tag = Notice_tag::pkeyGet(array('tag' => common_canonical_tag($group->nickname),
+                                                     'notice_id' => $this->id));
 
-                if (is_null($tag)) {
-                    $this->saveTag($group->nickname);
+                    if (is_null($tag)) {
+                        $this->saveTag($group->nickname);
+                    }
                 }
 
                 $groups[] = clone($group);
@@ -1115,15 +1235,8 @@ class Notice extends Memcached_DataObject
                 continue;
             }
 
-            $reply = new Reply();
-
-            $reply->notice_id  = $this->id;
-            $reply->profile_id = $profile->id;
-            $reply->modified   = $this->created;
-
-            common_log(LOG_INFO, __METHOD__ . ": saving reply: notice $this->id to profile $profile->id");
-
-            $id = $reply->insert();
+            $this->saveReply($profile->id);
+            self::blow('reply:stream:%d', $profile->id);
         }
 
         return;
@@ -1149,13 +1262,27 @@ class Notice extends Memcached_DataObject
 
         $sender = Profile::staticGet($this->profile_id);
 
+        $replied = array();
+
+        // If it's a reply, save for the replied-to author
+
+        if (!empty($this->reply_to)) {
+            $original = $this->getOriginal();
+            if (!empty($original)) { // that'd be weird
+                $author = $original->getProfile();
+                if (!empty($author)) {
+                    $this->saveReply($author->id);
+                    $replied[$author->id] = 1;
+                    self::blow('reply:stream:%d', $author->id);
+                }
+            }
+        }
+
         // @todo ideally this parser information would only
         // be calculated once.
 
         $mentions = common_find_mentions($this->content, $this);
 
-        $replied = array();
-
         // store replied only for first @ (what user/notice what the reply directed,
         // we assume first @ is it)
 
@@ -1176,23 +1303,9 @@ class Notice extends Memcached_DataObject
                     continue;
                 }
 
-                $reply = new Reply();
-
-                $reply->notice_id  = $this->id;
-                $reply->profile_id = $mentioned->id;
-                $reply->modified   = $this->created;
-
-                $id = $reply->insert();
-
-                if (!$id) {
-                    common_log_db_error($reply, 'INSERT', __FILE__);
-                    // TRANS: Server exception thrown when a reply cannot be saved.
-                    // TRANS: %1$d is a notice ID, %2$d is the ID of the mentioned user.
-                    throw new ServerException(sprintf(_('Could not save reply for %1$d, %2$d.'), $this->id, $mentioned->id));
-                } else {
-                    $replied[$mentioned->id] = 1;
-                    self::blow('reply:stream:%d', $mentioned->id);
-                }
+                $this->saveReply($mentioned->id);
+                $replied[$mentioned->id] = 1;
+                self::blow('reply:stream:%d', $mentioned->id);
             }
         }
 
@@ -1201,6 +1314,19 @@ class Notice extends Memcached_DataObject
         return $recipientIds;
     }
 
+    function saveReply($profileId)
+    {
+        $reply = new Reply();
+
+        $reply->notice_id  = $this->id;
+        $reply->profile_id = $profileId;
+        $reply->modified   = $this->created;
+
+        $reply->insert();
+
+        return $reply;
+    }
+
     /**
      * Pull the complete list of @-reply targets for this notice.
      *
@@ -1208,26 +1334,51 @@ class Notice extends Memcached_DataObject
      */
     function getReplies()
     {
-        // XXX: cache me
+        $keypart = sprintf('notice:reply_ids:%d', $this->id);
 
-        $ids = array();
+        $idstr = self::cacheGet($keypart);
 
-        $reply = new Reply();
-        $reply->selectAdd();
-        $reply->selectAdd('profile_id');
-        $reply->notice_id = $this->id;
+        if ($idstr !== false) {
+            $ids = explode(',', $idstr);
+        } else {
+            $ids = array();
 
-        if ($reply->find()) {
-            while($reply->fetch()) {
-                $ids[] = $reply->profile_id;
+            $reply = new Reply();
+            $reply->selectAdd();
+            $reply->selectAdd('profile_id');
+            $reply->notice_id = $this->id;
+
+            if ($reply->find()) {
+                while($reply->fetch()) {
+                    $ids[] = $reply->profile_id;
+                }
             }
+            self::cacheSet($keypart, implode(',', $ids));
         }
 
-        $reply->free();
-
         return $ids;
     }
 
+    /**
+     * Pull the complete list of @-reply targets for this notice.
+     *
+     * @return array of Profiles
+     */
+    function getReplyProfiles()
+    {
+        $ids      = $this->getReplies();
+        $profiles = array();
+
+        foreach ($ids as $id) {
+            $profile = Profile::staticGet('id', $id);
+            if (!empty($profile)) {
+                $profiles[] = $profile;
+            }
+        }
+        
+        return $profiles;
+    }
+
     /**
      * Send e-mail notifications to local @-reply targets.
      *
@@ -1385,9 +1536,9 @@ class Notice extends Memcached_DataObject
             $reply_ids = $this->getReplies();
 
             foreach ($reply_ids as $id) {
-                $profile = Profile::staticGet('id', $id);
-                if (!empty($profile)) {
-                    $ctx->attention[] = $profile->getUri();
+                $rprofile = Profile::staticGet('id', $id);
+                if (!empty($rprofile)) {
+                    $ctx->attention[] = $rprofile->getUri();
                 }
             }
 
@@ -1710,7 +1861,11 @@ class Notice extends Memcached_DataObject
         } else {
             $idstr = $cache->get(Cache::key('notice:repeats:'.$this->id));
             if ($idstr !== false) {
-                $ids = explode(',', $idstr);
+               if (empty($idstr)) {
+                       $ids = array();
+               } else {
+                       $ids = explode(',', $idstr);
+               }
             } else {
                 $ids = $this->_repeatStreamDirect(100);
                 $cache->set(Cache::key('notice:repeats:'.$this->id), implode(',', $ids));
@@ -1739,18 +1894,7 @@ class Notice extends Memcached_DataObject
             $notice->limit(0, $limit);
         }
 
-        $ids = array();
-
-        if ($notice->find()) {
-            while ($notice->fetch()) {
-                $ids[] = $notice->id;
-            }
-        }
-
-        $notice->free();
-        $notice = NULL;
-
-        return $ids;
+        return $notice->fetchAll('id');
     }
 
     function locationOptions($lat, $lon, $location_id, $location_ns, $profile = null)
@@ -2164,7 +2308,7 @@ class Notice extends Memcached_DataObject
     /**
      * Check that the given profile is allowed to read, respond to, or otherwise
      * act on this notice.
-     * 
+     *
      * The $scope member is a bitmask of scopes, representing a logical AND of the
      * scope requirement. So, 0x03 (Notice::ADDRESSEE_SCOPE | Notice::SITE_SCOPE) means
      * "only visible to people who are mentioned in the notice AND are users on this site."
@@ -2176,6 +2320,25 @@ class Notice extends Memcached_DataObject
      * @return boolean whether the profile is in the notice's scope
      */
     function inScope($profile)
+    {
+        if (is_null($profile)) {
+            $keypart = sprintf('notice:in-scope-for:%d:null', $this->id);
+        } else {
+            $keypart = sprintf('notice:in-scope-for:%d:%d', $this->id, $profile->id);
+        }
+
+        $result = self::cacheGet($keypart);
+
+        if ($result === false) {
+            $bResult = $this->_inScope($profile);
+            $result = ($bResult) ? 1 : 0;
+            self::cacheSet($keypart, $result, 0, 300);
+        }
+
+        return ($result == 1) ? true : false;
+    }
+
+    protected function _inScope($profile)
     {
         // If there's no scope, anyone (even anon) is in scope.
 
@@ -2273,4 +2436,49 @@ class Notice extends Memcached_DataObject
 
         return $groups;
     }
+
+    protected $_original = -1;
+
+    function getOriginal()
+    {
+        if (is_int($this->_original) && $this->_original == -1) {
+            if (empty($this->reply_to)) {
+                $this->_original = null;
+            } else {
+                $this->_original = Notice::staticGet('id', $this->reply_to);
+            }
+        }
+        return $this->_original;
+    }
+
+    /**
+     * Magic function called at serialize() time.
+     *
+     * We use this to drop a couple process-specific references
+     * from DB_DataObject which can cause trouble in future
+     * processes.
+     *
+     * @return array of variable names to include in serialization.
+     */
+
+    function __sleep()
+    {
+        $vars = parent::__sleep();
+        $skip = array('_original', '_profile');
+        return array_diff($vars, $skip);
+    }
+    
+    static function defaultScope()
+    {
+       $scope = common_config('notice', 'defaultscope');
+       if (is_null($scope)) {
+               if (common_config('site', 'private')) {
+                       $scope = 1;
+               } else {
+                       $scope = 0;
+               }
+       }
+       return $scope;
+    }
+
 }