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' => 191, 'description' => 'display name'), 'homepage' => array('type' => 'varchar', 'length' => 191, 'description' => 'URL, cached so we dont regenerate'), 'description' => array('type' => 'text', 'description' => 'group description'), 'location' => array('type' => 'varchar', 'length' => 191, 'description' => 'related physical location, if any'), 'original_logo' => array('type' => 'varchar', 'length' => 191, 'description' => 'original size logo'), 'homepage_logo' => array('type' => 'varchar', 'length' => 191, 'description' => 'homepage (profile) size logo'), 'stream_logo' => array('type' => 'varchar', 'length' => 191, 'description' => 'stream-sized logo'), 'mini_logo' => array('type' => 'varchar', 'length' => 191, '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' => 191, 'description' => 'universal identifier'), 'mainpage' => array('type' => 'varchar', 'length' => 191, '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', AVATAR_MINI_SIZE => 'mini'); return Theme::path('default-avatar-'.$sizenames[$size].'.png'); } function homeUrl() { $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; } elseif ($this->isLocal()) { $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; } elseif ($this->isLocal()) { $uri = common_local_url('groupbyid', array('id' => $this->id)); } } Event::handle('EndUserGroupGetUri', array($this, &$uri)); return $uri; } function permalink() { $url = null; if (Event::handle('StartUserGroupPermalink', array($this, &$url))) { if ($this->isLocal()) { $url = common_local_url('groupbyid', array('id' => $this->id)); } } Event::handle('EndUserGroupPermalink', array($this, &$url)); return $url; } function getNotices($offset, $limit, $since_id=null, $max_id=null) { $stream = new GroupNoticeStream($this); 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); } $ids = array_slice($window, $offset, $limit); } return Profile::multiGet('id', $ids); } function getMemberIDs($offset=0, $limit=null) { $gm = new Group_member(); $gm->selectAdd(); $gm->selectAdd('profile_id'); $gm->group_id = $this->id; $gm->orderBy('created DESC'); if (!is_null($limit)) { $gm->limit($offset, $limit); } $ids = array(); if ($gm->find()) { while ($gm->fetch()) { $ids[] = $gm->profile_id; } } return $ids; } /** * 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_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') { $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset; } else { $qry .= ' LIMIT ' . $offset . ', ' . $limit; } } $members = new Profile(); $members->query(sprintf($qry, $this->id)); return $members; } public function getAdminCount() { $block = new Group_member(); $block->group_id = $this->id; $block->is_admin = 1; return $block->count(); } public 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=null, $limit=null) // offset is null because DataObject wants it, 0 would mean no results { $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(); 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(); return $blocked; } function setOriginal($filename) { $imagefile = new ImageFile(null, Avatar::path($filename)); $orig = clone($this); $this->original_logo = Avatar::url($filename); $this->homepage_logo = Avatar::url($imagefile->resize(AVATAR_PROFILE_SIZE)); $this->stream_logo = Avatar::url($imagefile->resize(AVATAR_STREAM_SIZE)); $this->mini_logo = Avatar::url($imagefile->resize(AVATAR_MINI_SIZE)); common_debug(common_log_objstring($this)); return $this->update($orig); } function getBestName() { 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(); // XXX: cache this $alias = new Group_alias(); $alias->group_id = $this->id; if ($alias->find()) { while ($alias->fetch()) { $aliases[] = $alias->alias; } } $alias->free(); return $aliases; } function setAliases($newaliases) { $newaliases = array_unique($newaliases); $oldaliases = $this->getAliases(); // 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 $to_insert = array_diff($newaliases, $oldaliases); $alias = new Group_alias(); $alias->group_id = $this->id; foreach ($to_delete as $delalias) { $alias->alias = $delalias; $result = $alias->delete(); if (!$result) { common_log_db_error($alias, 'DELETE', __FILE__); return false; } } foreach ($to_insert as $insalias) { if ($insalias === $this->nickname) { continue; } $alias->alias = Nickname::normalize($insalias, true); $result = $alias->insert(); if (!$result) { common_log_db_error($alias, 'INSERT', __FILE__); return false; } } return true; } static function getForNickname($nickname, Profile $profile=null) { $nickname = Nickname::normalize($nickname); // Are there any matching remote groups this profile's in? 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); } } } // If not, check local groups. $group = Local_group::getKV('nickname', $nickname); if ($group instanceof Local_group) { return User_group::getKV('id', $group->group_id); } $alias = Group_alias::getKV('alias', $nickname); if ($alias instanceof Group_alias) { return User_group::getKV('id', $alias->group_id); } return null; } function getUserMembers() { // XXX: cache this $user = new User(); if(common_config('db','quote_identifiers')) $user_table = '"user"'; else $user_table = 'user'; $qry = 'SELECT id ' . 'FROM '. $user_table .' JOIN group_member '. 'ON '. $user_table .'.id = group_member.profile_id ' . 'WHERE group_member.group_id = %d '; $user->query(sprintf($qry, $this->id)); $ids = array(); while ($user->fetch()) { $ids[] = $user->id; } $user->free(); return $ids; } static function maxDescription() { $desclimit = common_config('group', 'desclimit'); // null => use global limit (distinct from 0!) if (is_null($desclimit)) { $desclimit = common_config('site', 'textlimit'); } return $desclimit; } static function descriptionTooLong($desc) { $desclimit = self::maxDescription(); return ($desclimit > 0 && !empty($desc) && (mb_strlen($desc) > $desclimit)); } function asAtomEntry($namespace=false, $source=false) { $xs = new XMLStringer(true); if ($namespace) { $attrs = array('xmlns' => 'http://www.w3.org/2005/Atom', 'xmlns:thr' => 'http://purl.org/syndication/thread/1.0'); } else { $attrs = array(); } $xs->elementStart('entry', $attrs); 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())); $xs->element('updated', null, $this->modified); $xs->elementEnd('source'); } $xs->element('title', null, $this->nickname); $xs->element('summary', null, common_xml_safe_str($this->description)); $xs->element('link', array('rel' => 'alternate', 'href' => $this->permalink())); $xs->element('id', null, $this->permalink()); $xs->element('published', null, common_date_w3dtf($this->created)); $xs->element('updated', null, common_date_w3dtf($this->modified)); $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 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::getKV('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); } } $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(); if (empty($uri)) { // fill in later... $uri = null; } if (empty($mainpage)) { $mainpage = common_local_url('showgroup', array('nickname' => $nickname)); } // 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 === false) { 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.')); } } Event::handle('EndGroupSave', array($group)); } $profile->query('COMMIT'); 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($useWhere=false) { if (empty($this->id)) { common_log(LOG_WARNING, "Ambiguous User_group->delete(); skipping related tables."); return parent::delete($useWhere); } try { $profile = $this->getProfile(); $profile->delete(); } catch (GroupNoProfileException $unp) { common_log(LOG_INFO, "Group {$this->nickname} has no profile; continuing deletion."); } // 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()); // $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); } } // 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')); } 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; } return array_keys($ids); } }