X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=classes%2FUser_group.php;h=406537dd8a40f32a84d34ee4c034ae66b173c29e;hb=3ad3535cd8d12787d1af95969b9576620abce4a9;hp=310ecff1ef766726197eaa06457b6a3c5cfcc405;hpb=81aada21447b7561e759886b327aa7798a490bb2;p=quix0rs-gnu-social.git diff --git a/classes/User_group.php b/classes/User_group.php index 310ecff1ef..406537dd8a 100644 --- a/classes/User_group.php +++ b/classes/User_group.php @@ -3,114 +3,208 @@ * 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 */ public $__table = 'user_group'; // table name public $id; // int(4) primary_key not_null - public $nickname; // varchar(64) unique_key + public $nickname; // varchar(64) public $fullname; // varchar(255) public $homepage; // varchar(255) - public $description; // text() + public $description; // text public $location; // varchar(255) public $original_logo; // varchar(255) 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 - public $modified; // timestamp() not_null default_CURRENT_TIMESTAMP + 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 Memcached_DataObject::staticGet('User_group',$k,$v); } + function staticGet($k,$v=NULL) { + return Memcached_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', AVATAR_STREAM_SIZE => 'stream', AVATAR_MINI_SIZE => 'mini'); - return theme_path('default-avatar-'.$sizenames[$size].'.png'); + return Theme::path('default-avatar-'.$sizenames[$size].'.png'); } function homeUrl() { - return common_local_url('showgroup', - array('nickname' => $this->nickname)); + $url = null; + if (Event::handle('StartUserGroupHomeUrl', array($this, &$url))) { + // normally stored in mainpage, but older ones may be null + if (!empty($this->mainpage)) { + $url = $this->mainpage; + } else { + $url = common_local_url('showgroup', + array('nickname' => $this->nickname)); + } + } + Event::handle('EndUserGroupHomeUrl', array($this, &$url)); + return $url; + } + + function getUri() + { + $uri = null; + if (Event::handle('StartUserGroupGetUri', array($this, &$uri))) { + if (!empty($this->uri)) { + $uri = $this->uri; + } else { + $uri = common_local_url('groupbyid', + array('id' => $this->id)); + } + } + Event::handle('EndUserGroupGetUri', array($this, &$uri)); + return $uri; } function permalink() { - return common_local_url('groupbyid', - array('id' => $this->id)); + $url = null; + if (Event::handle('StartUserGroupPermalink', array($this, &$url))) { + $url = common_local_url('groupbyid', + array('id' => $this->id)); + } + Event::handle('EndUserGroupPermalink', array($this, &$url)); + return $url; } - function getNotices($offset, $limit) + 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); + $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, $since) - { - $inbox = new Group_inbox(); - $inbox->group_id = $this->id; + function allowedNickname($nickname) + { + static $blacklist = array('new'); + return !in_array($nickname, $blacklist); + } - $inbox->selectAdd(); - $inbox->selectAdd('notice_id'); + 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); + } - if ($since_id != 0) { - $inbox->whereAdd('notice_id > ' . $since_id); + $ids = array_slice($window, + $offset, + $limit); } - if ($max_id != 0) { - $inbox->whereAdd('notice_id <= ' . $max_id); - } + return Profile::multiGet('id', $ids); + } - if (!is_null($since)) { - $inbox->whereAdd('created > \'' . date('Y-m-d H:i:s', $since) . '\''); - } + function getMemberIDs($offset=0, $limit=null) + { + $gm = new Group_member(); - $inbox->orderBy('notice_id DESC'); + $gm->selectAdd(); + $gm->selectAdd('profile_id'); - if (!is_null($offset)) { - $inbox->limit($offset, $limit); + $gm->group_id = $this->id; + + $gm->orderBy('created DESC'); + + 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') { @@ -126,6 +220,48 @@ class User_group extends Memcached_DataObject return $members; } + function getMemberCount() + { + $key = sprintf("group:member_count:%d", $this->id); + + $cnt = self::cacheGet($key); + + if (is_integer($cnt)) { + return (int) $cnt; + } + + $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) { $qry = @@ -191,6 +327,22 @@ class User_group extends Memcached_DataObject return ($this->fullname) ? $this->fullname : $this->nickname; } + /** + * Gets the full name (if filled) with nickname as a parenthetical, or the nickname alone + * if no fullname is provided. + * + * @return string + */ + function getFancyName() + { + if ($this->fullname) { + // TRANS: Full name of a profile or group followed by nickname in parens + return sprintf(_m('FANCYNAME','%1$s (%2$s)'), $this->fullname, $this->nickname); + } else { + return $this->nickname; + } + } + function getAliases() { $aliases = array(); @@ -218,11 +370,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); @@ -251,12 +403,26 @@ class User_group extends Memcached_DataObject return true; } - static function getForNickname($nickname) + static function getForNickname($nickname, $profile=null) { $nickname = common_canonical_nickname($nickname); - $group = User_group::staticGet('nickname', $nickname); + + // Are there any matching remote groups this profile's in? + if ($profile) { + $group = $profile->getGroups(); + while ($group->fetch()) { + if ($group->nickname == $nickname) { + // @fixme is this the best way? + return clone($group); + } + } + } + + // If not, check local groups. + + $group = Local_group::staticGet('nickname', $nickname); if (!empty($group)) { - return $group; + return User_group::staticGet('id', $group->group_id); } $alias = Group_alias::staticGet('alias', $nickname); if (!empty($alias)) { @@ -265,11 +431,6 @@ class User_group extends Memcached_DataObject return null; } - function getDesign() - { - return Design::staticGet('id', $this->design_id); - } - function getUserMembers() { // XXX: cache this @@ -329,16 +490,15 @@ class User_group extends Memcached_DataObject if ($source) { $xs->elementStart('source'); + $xs->element('id', null, $this->permalink()); $xs->element('title', null, $profile->nickname . " - " . common_config('site', 'name')); $xs->element('link', array('href' => $this->permalink())); - } - - if ($source) { + $xs->element('updated', null, $this->modified); $xs->elementEnd('source'); } $xs->element('title', null, $this->nickname); - $xs->element('summary', null, $this->description); + $xs->element('summary', null, common_xml_safe_str($this->description)); $xs->element('link', array('rel' => 'alternate', 'href' => $this->permalink())); @@ -348,10 +508,256 @@ class User_group extends Memcached_DataObject $xs->element('published', null, common_date_w3dtf($this->created)); $xs->element('updated', null, common_date_w3dtf($this->modified)); - $xs->element('content', array('type' => 'html'), $this->description); + $xs->element( + 'content', + array('type' => 'html'), + common_xml_safe_str($this->description) + ); $xs->elementEnd('entry'); return $xs->getString(); } + + function asAtomAuthor() + { + $xs = new XMLStringer(true); + + $xs->elementStart('author'); + $xs->element('name', null, $this->nickname); + $xs->element('uri', null, $this->permalink()); + $xs->elementEnd('author'); + + return $xs->getString(); + } + + /** + * Returns an XML string fragment with group information as an + * Activity Streams element. + * + * Assumes that 'activity' namespace has been previously defined. + * + * @return string + */ + function asActivitySubject() + { + return $this->asActivityNoun('subject'); + } + + /** + * Returns an XML string fragment with group information as an + * Activity Streams noun object with the given element type. + * + * Assumes that 'activity', 'georss', and 'poco' namespace has been + * previously defined. + * + * @param string $element one of 'actor', 'subject', 'object', 'target' + * + * @return string + */ + function asActivityNoun($element) + { + $noun = ActivityObject::fromGroup($this); + return $noun->asString('activity:' . $element); + } + + function getAvatar() + { + return empty($this->homepage_logo) + ? User_group::defaultLogo(AVATAR_PROFILE_SIZE) + : $this->homepage_logo; + } + + static function register($fields) { + if (!empty($fields['userid'])) { + $profile = Profile::staticGet('id', $fields['userid']); + if ($profile && !$profile->hasRight(Right::CREATEGROUP)) { + common_log(LOG_WARNING, "Attempted group creation from banned user: " . $profile->nickname); + + // TRANS: Client exception thrown when a user tries to create a group while banned. + throw new ClientException(_('You are not allowed to create groups on this site.'), 403); + } + } + + // 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(); + + $group->query('BEGIN'); + + if (empty($uri)) { + // fill in later... + $uri = null; + } + if (empty($mainpage)) { + $mainpage = common_local_url('showgroup', array('nickname' => $nickname)); + } + + $group->nickname = $nickname; + $group->fullname = $fullname; + $group->homepage = $homepage; + $group->description = $description; + $group->location = $location; + $group->uri = $uri; + $group->mainpage = $mainpage; + $group->created = common_sql_now(); + + if (isset($fields['join_policy'])) { + $group->join_policy = intval($fields['join_policy']); + } else { + $group->join_policy = 0; + } + + if (isset($fields['force_scope'])) { + $group->force_scope = intval($fields['force_scope']); + } else { + $group->force_scope = 0; + } + + if (Event::handle('StartGroupSave', array(&$group))) { + + $result = $group->insert(); + + 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($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.')); + } + } + + $result = $group->setAliases($aliases); + + if (!$result) { + // TRANS: Server exception thrown when creating group aliases failed. + throw new ServerException(_('Could not create aliases.')); + } + + $member = new Group_member(); + + $member->group_id = $group->id; + $member->profile_id = $userid; + $member->is_admin = 1; + $member->created = $group->created; + + $result = $member->insert(); + + 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.')); + } + + self::blow('profile:groups:%d', $userid); + + if ($local) { + $local_group = new Local_group(); + + $local_group->group_id = $group->id; + $local_group->nickname = $nickname; + $local_group->created = common_sql_now(); + + $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)); + } + + return $group; + } + + /** + * Handle cascading deletion, on the model of notice and profile. + * + * This should handle freeing up cached entries for the group's + * id, nickname, URI, and aliases. There may be other areas that + * are not de-cached in the UI, including the sidebar lists on + * GroupsAction + */ + function delete() + { + if ($this->id) { + + // Safe to delete in bulk for now + + $related = array('Group_inbox', + 'Group_block', + 'Group_member', + 'Related_group'); + + Event::handle('UserGroupDeleteRelated', array($this, &$related)); + + foreach ($related as $cls) { + + $inst = new $cls(); + $inst->group_id = $this->id; + + if ($inst->find()) { + while ($inst->fetch()) { + $dup = clone($inst); + $dup->delete(); + } + } + } + + // And related groups in the other direction... + $inst = new Related_group(); + $inst->related_group_id = $this->id; + $inst->delete(); + + // Aliases and the local_group entry need to be cleared explicitly + // or we'll miss clearing some cache keys; that can make it hard + // to create a new group with one of those names or aliases. + $this->setAliases(array()); + $local = Local_group::staticGet('group_id', $this->id); + if ($local) { + $local->delete(); + } + + // blow the cached ids + self::blow('user_group:notice_ids:%d', $this->id); + + } else { + common_log(LOG_WARN, "Ambiguous user_group->delete(); skipping related tables."); + } + parent::delete(); + } + + function isPrivate() + { + return ($this->join_policy == self::JOIN_POLICY_MODERATE && + $this->force_scope == 1); + } }