]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - classes/Notice.php
Added checked type-hints
[quix0rs-gnu-social.git] / classes / Notice.php
index c91169c29c358bfc0708cbd94ef180aba70532fe..65190da8906e5da3169d4f3645ccc76fa8d230fa 100644 (file)
@@ -128,7 +128,7 @@ class Notice extends Managed_DataObject
 
         return $def;
     }
-       
+
     /* Notice types */
     const LOCAL_PUBLIC    =  1;
     const REMOTE          =  0;
@@ -142,7 +142,7 @@ class Notice extends Managed_DataObject
     const FOLLOWER_SCOPE  = 8;
 
     protected $_profile = array();
-    
+
     /**
      * Will always return a profile, if anything fails it will
      * (through _setProfile) throw a NoProfileException.
@@ -157,7 +157,7 @@ class Notice extends Managed_DataObject
         }
         return $this->_profile[$this->profile_id];
     }
-    
+
     public function _setProfile(Profile $profile=null)
     {
         if (!$profile instanceof Profile) {
@@ -268,7 +268,7 @@ class Notice extends Managed_DataObject
         }
         return $title;
     }
-    
+
     public function getContent()
     {
         return $this->content;
@@ -313,6 +313,16 @@ class Notice extends Managed_DataObject
         return $notice;
     }
 
+    public static function getById($id)
+    {
+        $notice = new Notice();
+        $notice->id = $id;
+        if (!$notice->find(true)) {
+            throw new NoResultException($notice);
+        }
+        return $notice;
+    }
+
     /**
      * Extract #hashtags from this notice's content and save them to the database.
      */
@@ -677,7 +687,7 @@ class Notice extends Managed_DataObject
                 $notice->insert();  // throws exception on failure
                 // If it's not part of a conversation, it's
                 // the beginning of a new conversation.
-                if (empty($notice->conversation)) { 
+                if (empty($notice->conversation)) {
                     $orig = clone($notice);
                     // $act->context->conversation will be null if it was not provided
                     $conv = Conversation::create($notice, $options['conversation']);
@@ -780,7 +790,7 @@ class Notice extends Managed_DataObject
                           'distribute' => true);
 
         // options will have default values when nothing has been supplied
-        $options = array_merge($defaults, $options); 
+        $options = array_merge($defaults, $options);
         foreach (array_keys($defaults) as $key) {
             // Only convert the keynames we specify ourselves from 'defaults' array into variables
             $$key = $options[$key];
@@ -960,7 +970,7 @@ class Notice extends Managed_DataObject
             // Prepare inbox delivery, may be queued to background.
             $stored->distribute();
         }
-        
+
         return $stored;
     }
 
@@ -1070,13 +1080,9 @@ class Notice extends Managed_DataObject
         }
 
         $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
@@ -1118,7 +1124,7 @@ class Notice extends Managed_DataObject
      *
      * @return void
      */
-    function saveKnownUrls($urls)
+    function saveKnownUrls(array $urls)
     {
         if (common_config('attachments', 'process_links')) {
             // @fixme validation?
@@ -1190,24 +1196,20 @@ class Notice extends Managed_DataObject
     }
 
        protected $_attachments = array();
-       
+
     function attachments() {
                if (isset($this->_attachments[$this->id])) {
             return $this->_attachments[$this->id];
         }
-               
+
         $f2ps = File_to_post::listGet('post_id', array($this->id));
-               
                $ids = array();
-               
                foreach ($f2ps[$this->id] as $f2p) {
-            $ids[] = $f2p->file_id;    
+            $ids[] = $f2p->file_id;
         }
-               
-               $files = File::multiGet('id', $ids);
 
+               $files = File::multiGet('id', $ids);
                $this->_attachments[$this->id] = $files->fetchAll();
-               
         return $this->_attachments[$this->id];
     }
 
@@ -1289,7 +1291,7 @@ class Notice extends Managed_DataObject
             $root->free();
             return $root;
         }
-        
+
         if (is_null($profile)) {
             $keypart = sprintf('notice:conversation_root:%d:null', $this->id);
         } else {
@@ -1297,7 +1299,7 @@ class Notice extends Managed_DataObject
                                $this->id,
                                $profile->id);
         }
-            
+
         $root = self::cacheGet($keypart);
 
         if ($root !== false && $root->inScope($profile)) {
@@ -1692,12 +1694,12 @@ class Notice extends Managed_DataObject
             $ids[] = $reply->profile_id;
         }
 
-        $this->_replies[$this->id] = $ids;
+        $this->_setReplies($ids);
 
         return $ids;
     }
 
-    function _setReplies($replies)
+    function _setReplies(array $replies)
     {
         $this->_replies[$this->id] = $replies;
     }
@@ -1710,9 +1712,9 @@ class Notice extends Managed_DataObject
     function getReplyProfiles()
     {
         $ids = $this->getReplies();
-        
+
         $profiles = Profile::multiGet('id', $ids);
-        
+
         return $profiles->fetchAll();
     }
 
@@ -1750,9 +1752,9 @@ class Notice extends Managed_DataObject
      *
      * @return array of Group objects
      */
-    
+
     protected $_groups = array();
-    
+
     function getGroups()
     {
         // Don't save groups for repeats
@@ -1760,28 +1762,25 @@ class Notice extends Managed_DataObject
         if (!empty($this->repeat_of)) {
             return array();
         }
-        
+
         if (isset($this->_groups[$this->id])) {
             return $this->_groups[$this->id];
         }
-        
+
         $gis = Group_inbox::listGet('notice_id', array($this->id));
 
         $ids = array();
 
-               foreach ($gis[$this->id] as $gi)
-               {
+               foreach ($gis[$this->id] as $gi) {
                    $ids[] = $gi->group_id;
                }
-               
+
                $groups = User_group::multiGet('id', $ids);
-               
-               $this->_groups[$this->id] = $groups->fetchAll();
-               
+               $this->_setGroups($groups->fetchAll());
                return $this->_groups[$this->id];
     }
-    
-    function _setGroups($groups)
+
+    function _setGroups(array $groups)
     {
         $this->_groups[$this->id] = $groups;
     }
@@ -2162,7 +2161,7 @@ class Notice extends Managed_DataObject
             // Unfortunately this is likely to lose tags or URLs
             // at the end of long notices.
             $content = mb_substr($content, 0, $maxlen - 4) . ' ...';
-        }     
+        }
 
 
         // Scope is same as this one's
@@ -2659,7 +2658,7 @@ class Notice extends Managed_DataObject
      *
      * @return boolean whether the profile is in the notice's scope
      */
-    function inScope($profile)
+    function inScope(Profile $profile=null)
     {
         if (is_null($profile)) {
             $keypart = sprintf('notice:in-scope-for:%d:null', $this->id);
@@ -2682,7 +2681,7 @@ class Notice extends Managed_DataObject
         return ($result == 1) ? true : false;
     }
 
-    protected function _inScope($profile)
+    protected function _inScope(Profile $profile=null)
     {
         if (!is_null($this->scope)) {
             $scope = $this->scope;
@@ -2690,89 +2689,69 @@ class Notice extends Managed_DataObject
             $scope = self::defaultScope();
         }
 
-        // If there's no scope, anyone (even anon) is in scope.
-
-        if ($scope == 0) { // Not private
-
+        if ($scope == 0 && !$this->getProfile()->isPrivateStream()) { // Not scoping, so it is public.
             return !$this->isHiddenSpam($profile);
+        }
 
-        } else { // Private, somehow
-
-            // If there's scope, anon cannot be in scope
+        // If there's scope, anon cannot be in scope
+        if (empty($profile)) {
+            return false;
+        }
 
-            if (empty($profile)) {
-                return false;
-            }
+        // Author is always in scope
+        if ($this->profile_id == $profile->id) {
+            return true;
+        }
 
-            // Author is always in scope
+        // Only for users on this site
+        if (($scope & Notice::SITE_SCOPE) && !$profile->isLocal()) {
+            return false;
+        }
 
-            if ($this->profile_id == $profile->id) {
-                return true;
-            }
+        // Only for users mentioned in the notice
+        if ($scope & Notice::ADDRESSEE_SCOPE) {
 
-            // Only for users on this site
+            $reply = Reply::pkeyGet(array('notice_id' => $this->id,
+                                         'profile_id' => $profile->id));
 
-            if (($scope & Notice::SITE_SCOPE) && !$profile->isLocal()) {
+            if (!$reply instanceof Reply) {
                 return false;
             }
+        }
 
-            // Only for users mentioned in the notice
-
-            if ($scope & Notice::ADDRESSEE_SCOPE) {
-
-                $reply = Reply::pkeyGet(array('notice_id' => $this->id,
-                                             'profile_id' => $profile->id));
-                                                                                
-                if (!$reply instanceof Reply) {
-                    return false;
-                }
-            }
-
-            // Only for members of the given group
-
-            if ($scope & Notice::GROUP_SCOPE) {
-
-                // XXX: just query for the single membership
+        // Only for members of the given group
+        if ($scope & Notice::GROUP_SCOPE) {
 
-                $groups = $this->getGroups();
+            // XXX: just query for the single membership
 
-                $foundOne = false;
+            $groups = $this->getGroups();
 
-                foreach ($groups as $group) {
-                    if ($profile->isMember($group)) {
-                        $foundOne = true;
-                        break;
-                    }
-                }
+            $foundOne = false;
 
-                if (!$foundOne) {
-                    return false;
+            foreach ($groups as $group) {
+                if ($profile->isMember($group)) {
+                    $foundOne = true;
+                    break;
                 }
             }
 
-            // Only for followers of the author
-
-            $author = null;
+            if (!$foundOne) {
+                return false;
+            }
+        }
 
-            if ($scope & Notice::FOLLOWER_SCOPE) {
+        if ($scope & Notice::FOLLOWER_SCOPE || $this->getProfile()->isPrivateStream()) {
 
-                try {
-                    $author = $this->getProfile();
-                } catch (Exception $e) {
-                    return false;
-                }
-        
-                if (!Subscription::exists($profile, $author)) {
-                    return false;
-                }
+            if (!Subscription::exists($profile, $this->getProfile())) {
+                return false;
             }
-
-            return !$this->isHiddenSpam($profile);
         }
+
+        return !$this->isHiddenSpam($profile);
     }
 
-    function isHiddenSpam($profile) {
-        
+    function isHiddenSpam(Profile $profile=null) {
+
         // Hide posts by silenced users from everyone but moderators.
 
         if (common_config('notice', 'hidespam')) {
@@ -2822,7 +2801,7 @@ class Notice extends Managed_DataObject
         $skip = array('_profile', '_groups', '_attachments', '_faves', '_replies', '_repeats');
         return array_diff($vars, $skip);
     }
-    
+
     static function defaultScope()
     {
        $scope = common_config('notice', 'defaultscope');
@@ -2836,10 +2815,9 @@ class Notice extends Managed_DataObject
        return $scope;
     }
 
-       static function fillProfiles($notices)
+       static function fillProfiles(array $notices)
        {
                $map = self::getProfiles($notices);
-               
                foreach ($notices as $entry=>$notice) {
             try {
                        if (array_key_exists($notice->profile_id, $map)) {
@@ -2850,42 +2828,35 @@ class Notice extends Managed_DataObject
                 unset($notices[$entry]);
             }
                }
-               
+
                return array_values($map);
        }
-       
-       static function getProfiles(&$notices)
+
+       static function getProfiles(array &$notices)
        {
                $ids = array();
                foreach ($notices as $notice) {
                        $ids[] = $notice->profile_id;
                }
-               
                $ids = array_unique($ids);
-               
-               return Profile::pivotGet('id', $ids); 
+               return Profile::pivotGet('id', $ids);
        }
-       
-       static function fillGroups(&$notices)
+
+       static function fillGroups(array &$notices)
        {
         $ids = self::_idsOf($notices);
-               
         $gis = Group_inbox::listGet('notice_id', $ids);
-               
         $gids = array();
 
-               foreach ($gis as $id => $gi)
-               {
+               foreach ($gis as $id => $gi) {
                    foreach ($gi as $g)
                    {
                        $gids[] = $g->group_id;
                    }
                }
-               
+
                $gids = array_unique($gids);
-               
                $group = User_group::pivotGet('id', $gids);
-               
                foreach ($notices as $notice)
                {
                        $grps = array();
@@ -2906,24 +2877,19 @@ class Notice extends Managed_DataObject
                return array_keys($ids);
     }
 
-    static function fillAttachments(&$notices)
+    static function fillAttachments(array &$notices)
     {
         $ids = self::_idsOf($notices);
-
         $f2pMap = File_to_post::listGet('post_id', $ids);
-               
                $fileIds = array();
-               
                foreach ($f2pMap as $noticeId => $f2ps) {
             foreach ($f2ps as $f2p) {
-                $fileIds[] = $f2p->file_id;    
+                $fileIds[] = $f2p->file_id;
             }
         }
 
         $fileIds = array_unique($fileIds);
-
                $fileMap = File::pivotGet('id', $fileIds);
-
                foreach ($notices as $notice)
                {
                        $files = array();
@@ -2935,7 +2901,7 @@ class Notice extends Managed_DataObject
                }
     }
 
-    static function fillReplies(&$notices)
+    static function fillReplies(array &$notices)
     {
         $ids = self::_idsOf($notices);
         $replyMap = Reply::listGet('notice_id', $ids);
@@ -2957,21 +2923,21 @@ class Notice extends Managed_DataObject
             return $this->_repeats[$this->id];
         }
         $repeatMap = Notice::listGet('repeat_of', array($this->id));
-        $this->_repeats[$this->id] = $repeatMap[$this->id];
+        $this->_setRepeats($repeatMap[$this->id]);
         return $this->_repeats[$this->id];
     }
 
-    function _setRepeats($repeats)
+    function _setRepeats(array $repeats)
     {
         $this->_repeats[$this->id] = $repeats;
     }
 
-    static function fillRepeats(&$notices)
+    static function fillRepeats(array &$notices)
     {
         $ids = self::_idsOf($notices);
         $repeatMap = Notice::listGet('repeat_of', $ids);
         foreach ($notices as $notice) {
-               $repeats = $repeatMap[$notice->id];
+            $repeats = $repeatMap[$notice->id];
             $notice->_setRepeats($repeats);
         }
     }