X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;ds=sidebyside;f=classes%2FUser_group.php;h=aad38b635885540a29bf2b63e3b4b330744172b1;hb=1ee79dc3791162f7ef9b92befaef597328266ce1;hp=8587f15771d161e597914c982e38b2ce733043fb;hpb=1e73ba00bdd37f46415eb45b1b904dc894fb801c;p=quix0rs-gnu-social.git diff --git a/classes/User_group.php b/classes/User_group.php index 8587f15771..aad38b6358 100644 --- a/classes/User_group.php +++ b/classes/User_group.php @@ -3,10 +3,11 @@ * 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 */ @@ -22,20 +23,82 @@ 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 - - /* Static get */ - function staticGet($k,$v=NULL) { return DB_DataObject::staticGet('User_group',$k,$v); } + public $force_scope; // tinyint /* the code above is auto generated do not remove the tag below */ ###END_AUTOCODE - function defaultLogo($size) + public static function schemaDef() + { + return array( + 'fields' => array( + 'id' => array('type' => 'serial', 'not null' => true, 'description' => 'unique identifier'), + 'profile_id' => array('type' => 'int', 'not null' => true, 'description' => 'foreign key to profile table'), + + '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'), +// when it's safe and everyone's run upgrade.php 'user_profile_id_key' => array('profile_id'), + ), + 'foreign keys' => array( + 'user_group_id_fkey' => array('profile', array('profile_id' => 'id')), + ), + 'indexes' => array( + 'user_group_nickname_idx' => array('nickname'), + 'user_group_profile_id_idx' => array('profile_id'), //make this unique in future + ), + ); + } + + protected $_profile = array(); + + /** + * @return Profile + * + * @throws GroupNoProfileException if user has no profile + */ + public function getProfile() + { + if (!isset($this->_profile[$this->profile_id])) { + $profile = Profile::getKV('id', $this->profile_id); + if (!$profile instanceof Profile) { + throw new GroupNoProfileException($this); + } + $this->_profile[$this->profile_id] = $profile; + } + return $this->_profile[$this->profile_id]; + } + + public function getNickname() + { + return $this->getProfile()->getNickname(); + } + + public static function defaultLogo($size) { static $sizenames = array(AVATAR_PROFILE_SIZE => 'profile', AVATAR_STREAM_SIZE => 'stream', @@ -92,34 +155,52 @@ class User_group extends Memcached_DataObject return $stream->getNotices($offset, $limit, $since_id, $max_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); + } - function allowedNickname($nickname) - { - static $blacklist = array('new'); - return !in_array($nickname, $blacklist); + $ids = array_slice($window, + $offset, + $limit); + } + + return Profile::multiGet('id', $ids); } - function getMembers($offset=0, $limit=null) + function getMemberIDs($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 '; + $gm = new Group_member(); - if ($limit != null) { - if (common_config('db','type') == 'pgsql') { - $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset; - } else { - $qry .= ' LIMIT ' . $offset . ', ' . $limit; - } + $gm->selectAdd(); + $gm->selectAdd('profile_id'); + + $gm->group_id = $this->id; + + $gm->orderBy('created DESC'); + + if (!is_null($limit)) { + $gm->limit($offset, $limit); } - $members = new Profile(); + $ids = array(); - $members->query(sprintf($qry, $this->id)); - return $members; + if ($gm->find()) { + while ($gm->fetch()) { + $ids[] = $gm->profile_id; + } + } + + return $ids; } /** @@ -152,65 +233,78 @@ class User_group extends Memcached_DataObject return $members; } - function getMemberCount() + public function getAdminCount() { - // XXX: WORM cache this + $block = new Group_member(); + $block->group_id = $this->id; + $block->is_admin = 1; + + return $block->count(); + } - $members = $this->getMembers(); - $member_count = 0; + public function getMemberCount() + { + $key = sprintf("group:member_count:%d", $this->id); + + $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 getAdmins($offset=0, $limit=null) + function getBlockedCount() { - $qry = - 'SELECT profile.* ' . - 'FROM profile JOIN group_member '. - 'ON profile.id = group_member.profile_id ' . - 'WHERE group_member.group_id = %d ' . - 'AND group_member.is_admin = 1 ' . - 'ORDER BY group_member.modified ASC '; + // XXX: WORM cache this - if ($limit != null) { - if (common_config('db','type') == 'pgsql') { - $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset; - } else { - $qry .= ' LIMIT ' . $offset . ', ' . $limit; - } - } + $block = new Group_block(); + $block->group_id = $this->id; - $admins = new Profile(); + return $block->count(); + } - $admins->query(sprintf($qry, $this->id)); - return $admins; + function getQueueCount() + { + // XXX: WORM cache this + + $queue = new Group_join_queue(); + $queue->group_id = $this->id; + + return $queue->count(); } - function getBlocked($offset=0, $limit=null) + function getAdmins($offset=null, $limit=null) // offset is null because DataObject wants it, 0 would mean no results { - $qry = - 'SELECT profile.* ' . - 'FROM profile JOIN group_block '. - 'ON profile.id = group_block.blocked ' . - 'WHERE group_block.group_id = %d ' . - 'ORDER BY group_block.modified DESC '; + $admins = new Profile(); + $admins->joinAdd(array('id', 'group_member:profile_id')); + $admins->whereAdd(sprintf('group_member.group_id = %u AND group_member.is_admin = 1', $this->id)); + $admins->orderBy('group_member.modified ASC'); + $admins->limit($offset, $limit); + $admins->find(); - if ($limit != null) { - if (common_config('db','type') == 'pgsql') { - $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset; - } else { - $qry .= ' LIMIT ' . $offset . ', ' . $limit; - } - } + return $admins; + } + function getBlocked($offset=null, $limit=null) // offset is null because DataObject wants it, 0 would mean no results + { $blocked = new Profile(); + $blocked->joinAdd(array('id', 'group_block:blocked')); + $blocked->whereAdd(sprintf('group_block.group_id = %u', $this->id)); + $blocked->orderBy('group_block.modified DESC'); + $blocked->limit($offset, $limit); + $blocked->find(); - $blocked->query(sprintf($qry, $this->id)); return $blocked; } @@ -297,7 +391,10 @@ class User_group extends Memcached_DataObject } foreach ($to_insert as $insalias) { - $alias->alias = $insalias; + if ($insalias === $this->nickname) { + continue; + } + $alias->alias = Nickname::normalize($insalias, true); $result = $alias->insert(); if (!$result) { common_log_db_error($alias, 'INSERT', __FILE__); @@ -308,14 +405,14 @@ class User_group extends Memcached_DataObject return true; } - static function getForNickname($nickname, $profile=null) + static function getForNickname($nickname, Profile $profile=null) { - $nickname = common_canonical_nickname($nickname); + $nickname = Nickname::normalize($nickname); // Are there any matching remote groups this profile's in? - if ($profile) { - $group = $profile->getGroups(); - while ($group->fetch()) { + if ($profile instanceof Profile) { + $group = $profile->getGroups(0, null); + while ($group instanceof User_group && $group->fetch()) { if ($group->nickname == $nickname) { // @fixme is this the best way? return clone($group); @@ -324,23 +421,17 @@ class User_group extends Memcached_DataObject } // If not, check local groups. - - $group = Local_group::staticGet('nickname', $nickname); - if (!empty($group)) { - return User_group::staticGet('id', $group->group_id); + $group = Local_group::getKV('nickname', $nickname); + if ($group instanceof Local_group) { + return User_group::getKV('id', $group->group_id); } - $alias = Group_alias::staticGet('alias', $nickname); - if (!empty($alias)) { - return User_group::staticGet('id', $alias->group_id); + $alias = Group_alias::getKV('alias', $nickname); + if ($alias instanceof Group_alias) { + return User_group::getKV('id', $alias->group_id); } return null; } - function getDesign() - { - return Design::staticGet('id', $this->design_id); - } - function getUserMembers() { // XXX: cache this @@ -441,19 +532,6 @@ class User_group extends Memcached_DataObject 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. @@ -480,7 +558,7 @@ class User_group extends Memcached_DataObject static function register($fields) { if (!empty($fields['userid'])) { - $profile = Profile::staticGet('id', $fields['userid']); + $profile = Profile::getKV('id', $fields['userid']); if ($profile && !$profile->hasRight(Right::CREATEGROUP)) { common_log(LOG_WARNING, "Attempted group creation from banned user: " . $profile->nickname); @@ -489,15 +567,27 @@ class User_group extends Memcached_DataObject } } + $fields['nickname'] = Nickname::normalize($fields['nickname']); + // 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; @@ -506,25 +596,51 @@ class User_group extends Memcached_DataObject $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(); + // We must create a new, incrementally assigned profile_id + $profile = new Profile(); + $profile->nickname = $nickname; + $profile->fullname = $fullname; + $profile->profileurl = $mainpage; + $profile->homepage = $homepage; + $profile->bio = $description; + $profile->location = $location; + $profile->created = common_sql_now(); + + $group->nickname = $profile->nickname; + $group->fullname = $profile->fullname; + $group->homepage = $profile->homepage; + $group->description = $profile->bio; + $group->location = $profile->location; + $group->mainpage = $profile->profileurl; + $group->created = $profile->created; + + $profile->query('BEGIN'); + $id = $profile->insert(); + if ($id === false) { + $profile->query('ROLLBACK'); + throw new ServerException(_('Profile insertion failed')); + } + + $group->profile_id = $id; + $group->uri = $uri; + 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) { + if ($result === false) { common_log_db_error($group, 'INSERT', __FILE__); // TRANS: Server exception thrown when creating a group failed. throw new ServerException(_('Could not create group.')); @@ -563,6 +679,8 @@ class User_group extends Memcached_DataObject throw new ServerException(_('Could not set group membership.')); } + self::blow('profile:groups:%d', $userid); + if ($local) { $local_group = new Local_group(); @@ -579,11 +697,11 @@ class User_group extends Memcached_DataObject } } - $group->query('COMMIT'); - Event::handle('EndGroupSave', array($group)); } + $profile->query('COMMIT'); + return $group; } @@ -595,52 +713,140 @@ class User_group extends Memcached_DataObject * are not de-cached in the UI, including the sidebar lists on * GroupsAction */ - function delete() + function delete($useWhere=false) { - if ($this->id) { + if (empty($this->id)) { + common_log(LOG_WARNING, "Ambiguous User_group->delete(); skipping related tables."); + return parent::delete($useWhere); + } - // Safe to delete in bulk for now + try { + $profile = $this->getProfile(); + $profile->delete(); + } catch (GroupNoProfileException $unp) { + common_log(LOG_INFO, "Group {$this->nickname} has no profile; continuing deletion."); + } - $related = array('Group_inbox', - 'Group_block', - 'Group_member', - 'Related_group'); + // Safe to delete in bulk for now - Event::handle('UserGroupDeleteRelated', array($this, &$related)); + $related = array('Group_inbox', + 'Group_block', + 'Group_member', + 'Related_group'); - foreach ($related as $cls) { + Event::handle('UserGroupDeleteRelated', array($this, &$related)); - $inst = new $cls(); - $inst->group_id = $this->id; + foreach ($related as $cls) { + $inst = new $cls(); + $inst->group_id = $this->id; - if ($inst->find()) { - while ($inst->fetch()) { - $dup = clone($inst); - $dup->delete(); - } + 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(); + // 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(); + // 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()); + + // $this->isLocal() but we're using the resulting object + $local = Local_group::getKV('group_id', $this->id); + if ($local instanceof Local_group) { + $local->delete(); + } + + // blow the cached ids + self::blow('user_group:notice_ids:%d', $this->id); + + return parent::delete($useWhere); + } + + public function update($dataObject=false) + { + // Whenever the User_group is updated, find the Local_group + // and update its nickname too. + if ($this->nickname != $dataObject->nickname) { + $local = Local_group::getKV('group_id', $this->id); + if ($local instanceof Local_group) { + common_debug("Updating Local_group ({$this->id}) nickname from {$dataObject->nickname} to {$this->nickname}"); + $local->setNickname($this->nickname); } + } - // blow the cached ids - self::blow('user_group:notice_ids:%d', $this->id); + // Also make sure the Profile table is up to date! + $fields = array(/*group field => profile field*/ + 'nickname' => 'nickname', + 'fullname' => 'fullname', + 'mainpage' => 'profileurl', + 'homepage' => 'homepage', + 'description' => 'bio', + 'location' => 'location', + 'created' => 'created', + 'modified' => 'modified', + ); + $profile = $this->getProfile(); + $origpro = clone($profile); + foreach ($fields as $gf=>$pf) { + $profile->$pf = $this->$gf; + } + if ($profile->update($origpro) === false) { + throw new ServerException(_('Unable to update profile')); + } - } else { - common_log(LOG_WARN, "Ambiguous user_group->delete(); skipping related tables."); + return parent::update($dataObject); + } + + function isPrivate() + { + return ($this->join_policy == self::JOIN_POLICY_MODERATE && + $this->force_scope == 1); + } + + public function isLocal() + { + $local = Local_group::getKV('group_id', $this->id); + return ($local instanceof Local_group); + } + + static function groupsFromText($text, Profile $profile) + { + $groups = array(); + + /* extract all !group */ + $count = preg_match_all('/(?:^|\s)!(' . Nickname::DISPLAY_FMT . ')/', + strtolower($text), + $match); + + if (!$count) { + return $groups; + } + + foreach (array_unique($match[1]) as $nickname) { + $group = self::getForNickname($nickname, $profile); + if ($group instanceof User_group && $profile->isMember($group)) { + $groups[] = clone($group); + } + } + + return $groups; + } + + static function idsFromText($text, Profile $profile) + { + $ids = array(); + $groups = self::groupsFromText($text, $profile); + foreach ($groups as $group) { + $ids[$group->id] = true; } - parent::delete(); + return array_keys($ids); } }