]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - classes/User_group.php
staticGet for sub-Managed_DataObject classes now calls parent
[quix0rs-gnu-social.git] / classes / User_group.php
index 68f61cb7f48a104b43aae7b84fcf5ba4503d7ca3..447dbded452811211e02d9860e9670b41d3ca2a5 100644 (file)
@@ -3,8 +3,12 @@
  * Table Definition for user_group
  */
 
-class User_group extends Memcached_DataObject
+class User_group extends Managed_DataObject
 {
+    const JOIN_POLICY_OPEN = 0;
+    const JOIN_POLICY_MODERATE = 1;
+    const CACHE_WINDOW = 201;
+
     ###START_AUTOCODE
     /* the code below is auto generated do not remove the above tag */
 
@@ -19,18 +23,56 @@ class User_group extends Memcached_DataObject
     public $homepage_logo;                   // varchar(255)
     public $stream_logo;                     // varchar(255)
     public $mini_logo;                       // varchar(255)
-    public $design_id;                       // int(4)
     public $created;                         // datetime   not_null default_0000-00-00%2000%3A00%3A00
     public $modified;                        // timestamp   not_null default_CURRENT_TIMESTAMP
     public $uri;                             // varchar(255)  unique_key
     public $mainpage;                        // varchar(255)
+    public $join_policy;                     // tinyint
+    public $force_scope;                     // tinyint
 
-    /* Static get */
-    function staticGet($k,$v=NULL) { return DB_DataObject::staticGet('User_group',$k,$v); }
+    function multiGet($keyCol, $keyVals, $skipNulls=true)
+    {
+        return parent::multiGet('User_group', $keyCol, $keyVals, $skipNulls);
+    }
 
     /* the code above is auto generated do not remove the tag below */
     ###END_AUTOCODE
 
+    public static function schemaDef()
+    {
+        return array(
+            'fields' => array(
+                'id' => array('type' => 'serial', 'not null' => true, 'description' => 'unique identifier'),
+
+                'nickname' => array('type' => 'varchar', 'length' => 64, 'description' => 'nickname for addressing'),
+                'fullname' => array('type' => 'varchar', 'length' => 255, 'description' => 'display name'),
+                'homepage' => array('type' => 'varchar', 'length' => 255, 'description' => 'URL, cached so we dont regenerate'),
+                'description' => array('type' => 'text', 'description' => 'group description'),
+                'location' => array('type' => 'varchar', 'length' => 255, 'description' => 'related physical location, if any'),
+
+                'original_logo' => array('type' => 'varchar', 'length' => 255, 'description' => 'original size logo'),
+                'homepage_logo' => array('type' => 'varchar', 'length' => 255, 'description' => 'homepage (profile) size logo'),
+                'stream_logo' => array('type' => 'varchar', 'length' => 255, 'description' => 'stream-sized logo'),
+                'mini_logo' => array('type' => 'varchar', 'length' => 255, 'description' => 'mini logo'),
+
+                'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'),
+                'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
+
+                'uri' => array('type' => 'varchar', 'length' => 255, 'description' => 'universal identifier'),
+                'mainpage' => array('type' => 'varchar', 'length' => 255, 'description' => 'page for group info to link to'),
+                'join_policy' => array('type' => 'int', 'size' => 'tiny', 'description' => '0=open; 1=requires admin approval'),      
+                'force_scope' => array('type' => 'int', 'size' => 'tiny', 'description' => '0=never,1=sometimes,-1=always'),
+            ),
+            'primary key' => array('id'),
+            'unique keys' => array(
+                'user_group_uri_key' => array('uri'),
+            ),
+            'indexes' => array(
+                'user_group_nickname_idx' => array('nickname'),
+            ),
+        );
+    }
+
     function defaultLogo($size)
     {
         static $sizenames = array(AVATAR_PROFILE_SIZE => 'profile',
@@ -83,57 +125,81 @@ class User_group extends Memcached_DataObject
 
     function getNotices($offset, $limit, $since_id=null, $max_id=null)
     {
-        $ids = Notice::stream(array($this, '_streamDirect'),
-                              array(),
-                              'user_group:notice_ids:' . $this->id,
-                              $offset, $limit, $since_id, $max_id);
+        $stream = new GroupNoticeStream($this);
 
-        return Notice::getStreamByIds($ids);
+        return $stream->getNotices($offset, $limit, $since_id, $max_id);
     }
 
-    function _streamDirect($offset, $limit, $since_id, $max_id)
+
+    function allowedNickname($nickname)
     {
-        $inbox = new Group_inbox();
+        static $blacklist = array('new');
+        return !in_array($nickname, $blacklist);
+    }
+
+    function getMembers($offset=0, $limit=null) {
+        $ids = null;
+        if (is_null($limit) || $offset + $limit > User_group::CACHE_WINDOW) {
+            $ids = $this->getMemberIDs($offset,
+                                       $limit);
+        } else {
+            $key = sprintf('group:member_ids:%d', $this->id);
+            $window = self::cacheGet($key);
+            if ($window === false) {
+                $window = $this->getMemberIDs(0,
+                                              User_group::CACHE_WINDOW);
+                self::cacheSet($key, $window);
+            }
 
-        $inbox->group_id = $this->id;
+            $ids = array_slice($window,
+                               $offset,
+                               $limit);
+        }
+
+        return Profile::multiGet('id', $ids);
+    }
+
+    function getMemberIDs($offset=0, $limit=null)
+    {
+        $gm = new Group_member();
 
-        $inbox->selectAdd();
-        $inbox->selectAdd('notice_id');
+        $gm->selectAdd();
+        $gm->selectAdd('profile_id');
 
-        Notice::addWhereSinceId($inbox, $since_id, 'notice_id');
-        Notice::addWhereMaxId($inbox, $max_id, 'notice_id');
+        $gm->group_id = $this->id;
 
-        $inbox->orderBy('created DESC, notice_id DESC');
+        $gm->orderBy('created DESC');
 
-        if (!is_null($offset)) {
-            $inbox->limit($offset, $limit);
+        if (!is_null($limit)) {
+            $gm->limit($offset, $limit);
         }
 
         $ids = array();
 
-        if ($inbox->find()) {
-            while ($inbox->fetch()) {
-                $ids[] = $inbox->notice_id;
+        if ($gm->find()) {
+            while ($gm->fetch()) {
+                $ids[] = $gm->profile_id;
             }
         }
 
         return $ids;
     }
 
-    function allowedNickname($nickname)
-    {
-        static $blacklist = array('new');
-        return !in_array($nickname, $blacklist);
-    }
-
-    function getMembers($offset=0, $limit=null)
+    /**
+     * Get pending members, who have not yet been approved.
+     *
+     * @param int $offset
+     * @param int $limit
+     * @return Profile
+     */
+    function getRequests($offset=0, $limit=null)
     {
         $qry =
           'SELECT profile.* ' .
-          'FROM profile JOIN group_member '.
-          'ON profile.id = group_member.profile_id ' .
-          'WHERE group_member.group_id = %d ' .
-          'ORDER BY group_member.created DESC ';
+          'FROM profile JOIN group_join_queue '.
+          'ON profile.id = group_join_queue.profile_id ' .
+          'WHERE group_join_queue.group_id = %d ' .
+          'ORDER BY group_join_queue.created DESC ';
 
         if ($limit != null) {
             if (common_config('db','type') == 'pgsql') {
@@ -151,17 +217,44 @@ class User_group extends Memcached_DataObject
 
     function getMemberCount()
     {
-        // XXX: WORM cache this
+        $key = sprintf("group:member_count:%d", $this->id);
 
-        $members = $this->getMembers();
-        $member_count = 0;
+        $cnt = self::cacheGet($key);
 
-        /** $member->count() doesn't work. */
-        while ($members->fetch()) {
-            $member_count++;
+        if (is_integer($cnt)) {
+            return (int) $cnt;
         }
 
-        return $member_count;
+        $mem = new Group_member();
+        $mem->group_id = $this->id;
+
+        // XXX: why 'distinct'?
+
+        $cnt = (int) $mem->count('distinct profile_id');
+
+        self::cacheSet($key, $cnt);
+
+        return $cnt;
+    }
+
+    function getBlockedCount()
+    {
+        // XXX: WORM cache this
+
+        $block = new Group_block();
+        $block->group_id = $this->id;
+
+        return $block->count();
+    }
+
+    function getQueueCount()
+    {
+        // XXX: WORM cache this
+
+        $queue = new Group_join_queue();
+        $queue->group_id = $this->id;
+
+        return $queue->count();
     }
 
     function getAdmins($offset=0, $limit=null)
@@ -272,11 +365,11 @@ class User_group extends Memcached_DataObject
 
         $oldaliases = $this->getAliases();
 
-        # Delete stuff that's old that not in new
+        // Delete stuff that's old that not in new
 
         $to_delete = array_diff($oldaliases, $newaliases);
 
-        # Insert stuff that's in new and not in old
+        // Insert stuff that's in new and not in old
 
         $to_insert = array_diff($newaliases, $oldaliases);
 
@@ -311,7 +404,7 @@ class User_group extends Memcached_DataObject
 
         // Are there any matching remote groups this profile's in?
         if ($profile) {
-            $group = $profile->getGroups();
+            $group = $profile->getGroups(0, null);
             while ($group->fetch()) {
                 if ($group->nickname == $nickname) {
                     // @fixme is this the best way?
@@ -333,11 +426,6 @@ class User_group extends Memcached_DataObject
         return null;
     }
 
-    function getDesign()
-    {
-        return Design::staticGet('id', $this->design_id);
-    }
-
     function getUserMembers()
     {
         // XXX: cache this
@@ -487,7 +575,20 @@ class User_group extends Memcached_DataObject
         }
 
         // MAGICALLY put fields into current scope
-
+        // @fixme kill extract(); it makes debugging absurdly hard
+
+               $defaults = array('nickname' => null,
+                                                 'fullname' => null,
+                                                 'homepage' => null,
+                                                 'description' => null,
+                                                 'location' => null,
+                                                 'uri' => null,
+                                                 'mainpage' => null,
+                                                 'aliases' => array(),
+                                                 'userid' => null);
+               
+               $fields = array_merge($defaults, $fields);
+               
         extract($fields);
 
         $group = new User_group();
@@ -498,6 +599,9 @@ class User_group extends Memcached_DataObject
             // fill in later...
             $uri = null;
         }
+        if (empty($mainpage)) {
+            $mainpage = common_local_url('showgroup', array('nickname' => $nickname));
+        }
 
         $group->nickname    = $nickname;
         $group->fullname    = $fullname;
@@ -508,64 +612,84 @@ class User_group extends Memcached_DataObject
         $group->mainpage    = $mainpage;
         $group->created     = common_sql_now();
 
-        $result = $group->insert();
+        if (isset($fields['join_policy'])) {
+            $group->join_policy = intval($fields['join_policy']);
+        } else {
+            $group->join_policy = 0;
+        }
 
-        if (!$result) {
-            common_log_db_error($group, 'INSERT', __FILE__);
-            // TRANS: Server exception thrown when creating a group failed.
-            throw new ServerException(_('Could not create group.'));
+        if (isset($fields['force_scope'])) {
+            $group->force_scope = intval($fields['force_scope']);
+        } else {
+            $group->force_scope = 0;
         }
 
-        if (!isset($uri) || empty($uri)) {
-            $orig = clone($group);
-            $group->uri = common_local_url('groupbyid', array('id' => $group->id));
-            $result = $group->update($orig);
+        if (Event::handle('StartGroupSave', array(&$group))) {
+
+            $result = $group->insert();
+
             if (!$result) {
-                common_log_db_error($group, 'UPDATE', __FILE__);
-                // TRANS: Server exception thrown when updating a group URI failed.
-                throw new ServerException(_('Could not set group URI.'));
+                common_log_db_error($group, 'INSERT', __FILE__);
+                // TRANS: Server exception thrown when creating a group failed.
+                throw new ServerException(_('Could not create group.'));
             }
-        }
 
-        $result = $group->setAliases($aliases);
+            if (!isset($uri) || empty($uri)) {
+                $orig = clone($group);
+                $group->uri = common_local_url('groupbyid', array('id' => $group->id));
+                $result = $group->update($orig);
+                if (!$result) {
+                    common_log_db_error($group, 'UPDATE', __FILE__);
+                    // TRANS: Server exception thrown when updating a group URI failed.
+                    throw new ServerException(_('Could not set group URI.'));
+                }
+            }
 
-        if (!$result) {
-            // TRANS: Server exception thrown when creating group aliases failed.
-            throw new ServerException(_('Could not create aliases.'));
-        }
+            $result = $group->setAliases($aliases);
 
-        $member = new Group_member();
+            if (!$result) {
+                // TRANS: Server exception thrown when creating group aliases failed.
+                throw new ServerException(_('Could not create aliases.'));
+            }
 
-        $member->group_id   = $group->id;
-        $member->profile_id = $userid;
-        $member->is_admin   = 1;
-        $member->created    = $group->created;
+            $member = new Group_member();
 
-        $result = $member->insert();
+            $member->group_id   = $group->id;
+            $member->profile_id = $userid;
+            $member->is_admin   = 1;
+            $member->created    = $group->created;
 
-        if (!$result) {
-            common_log_db_error($member, 'INSERT', __FILE__);
-            // TRANS: Server exception thrown when setting group membership failed.
-            throw new ServerException(_('Could not set group membership.'));
-        }
+            $result = $member->insert();
 
-        if ($local) {
-            $local_group = new Local_group();
+            if (!$result) {
+                common_log_db_error($member, 'INSERT', __FILE__);
+                // TRANS: Server exception thrown when setting group membership failed.
+                throw new ServerException(_('Could not set group membership.'));
+            }
 
-            $local_group->group_id = $group->id;
-            $local_group->nickname = $nickname;
-            $local_group->created  = common_sql_now();
+            self::blow('profile:groups:%d', $userid);
+            
+            if ($local) {
+                $local_group = new Local_group();
 
-            $result = $local_group->insert();
+                $local_group->group_id = $group->id;
+                $local_group->nickname = $nickname;
+                $local_group->created  = common_sql_now();
 
-            if (!$result) {
-                common_log_db_error($local_group, 'INSERT', __FILE__);
-                // TRANS: Server exception thrown when saving local group information failed.
-                throw new ServerException(_('Could not save local group info.'));
+                $result = $local_group->insert();
+
+                if (!$result) {
+                    common_log_db_error($local_group, 'INSERT', __FILE__);
+                    // TRANS: Server exception thrown when saving local group information failed.
+                    throw new ServerException(_('Could not save local group info.'));
+                }
             }
+
+            $group->query('COMMIT');
+
+            Event::handle('EndGroupSave', array($group));
         }
 
-        $group->query('COMMIT');
         return $group;
     }
 
@@ -625,4 +749,10 @@ class User_group extends Memcached_DataObject
         }
         parent::delete();
     }
+
+    function isPrivate()
+    {
+        return ($this->join_policy == self::JOIN_POLICY_MODERATE &&
+                $this->force_scope == 1);
+    }
 }