3 * Table Definition for user_group
6 class User_group extends Memcached_DataObject
9 /* the code below is auto generated do not remove the above tag */
11 public $__table = 'user_group'; // table name
12 public $id; // int(4) primary_key not_null
13 public $nickname; // varchar(64)
14 public $fullname; // varchar(255)
15 public $homepage; // varchar(255)
16 public $description; // text
17 public $location; // varchar(255)
18 public $original_logo; // varchar(255)
19 public $homepage_logo; // varchar(255)
20 public $stream_logo; // varchar(255)
21 public $mini_logo; // varchar(255)
22 public $design_id; // int(4)
23 public $created; // datetime not_null default_0000-00-00%2000%3A00%3A00
24 public $modified; // timestamp not_null default_CURRENT_TIMESTAMP
25 public $uri; // varchar(255) unique_key
26 public $mainpage; // varchar(255)
29 function staticGet($k,$v=NULL) { return DB_DataObject::staticGet('User_group',$k,$v); }
31 /* the code above is auto generated do not remove the tag below */
34 function defaultLogo($size)
36 static $sizenames = array(AVATAR_PROFILE_SIZE => 'profile',
37 AVATAR_STREAM_SIZE => 'stream',
38 AVATAR_MINI_SIZE => 'mini');
39 return Theme::path('default-avatar-'.$sizenames[$size].'.png');
45 if (Event::handle('StartUserGroupHomeUrl', array($this, &$url))) {
46 // normally stored in mainpage, but older ones may be null
47 if (!empty($this->mainpage)) {
48 $url = $this->mainpage;
50 $url = common_local_url('showgroup',
51 array('nickname' => $this->nickname));
54 Event::handle('EndUserGroupHomeUrl', array($this, &$url));
61 if (Event::handle('StartUserGroupGetUri', array($this, &$uri))) {
62 if (!empty($this->uri)) {
65 $uri = common_local_url('groupbyid',
66 array('id' => $this->id));
69 Event::handle('EndUserGroupGetUri', array($this, &$uri));
76 if (Event::handle('StartUserGroupPermalink', array($this, &$url))) {
77 $url = common_local_url('groupbyid',
78 array('id' => $this->id));
80 Event::handle('EndUserGroupPermalink', array($this, &$url));
84 function getNotices($offset, $limit, $since_id=null, $max_id=null)
86 $ids = Notice::stream(array($this, '_streamDirect'),
88 'user_group:notice_ids:' . $this->id,
89 $offset, $limit, $since_id, $max_id);
91 return Notice::getStreamByIds($ids);
94 function _streamDirect($offset, $limit, $since_id, $max_id)
96 $inbox = new Group_inbox();
98 $inbox->group_id = $this->id;
101 $inbox->selectAdd('notice_id');
103 if ($since_id != 0) {
104 $inbox->whereAdd('notice_id > ' . $since_id);
108 $inbox->whereAdd('notice_id <= ' . $max_id);
111 $inbox->orderBy('notice_id DESC');
113 if (!is_null($offset)) {
114 $inbox->limit($offset, $limit);
119 if ($inbox->find()) {
120 while ($inbox->fetch()) {
121 $ids[] = $inbox->notice_id;
128 function allowedNickname($nickname)
130 static $blacklist = array('new');
131 return !in_array($nickname, $blacklist);
134 function getMembers($offset=0, $limit=null)
137 'SELECT profile.* ' .
138 'FROM profile JOIN group_member '.
139 'ON profile.id = group_member.profile_id ' .
140 'WHERE group_member.group_id = %d ' .
141 'ORDER BY group_member.created DESC ';
143 if ($limit != null) {
144 if (common_config('db','type') == 'pgsql') {
145 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
147 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
151 $members = new Profile();
153 $members->query(sprintf($qry, $this->id));
157 function getMemberCount()
159 // XXX: WORM cache this
161 $members = $this->getMembers();
164 /** $member->count() doesn't work. */
165 while ($members->fetch()) {
169 return $member_count;
172 function getAdmins($offset=0, $limit=null)
175 'SELECT profile.* ' .
176 'FROM profile JOIN group_member '.
177 'ON profile.id = group_member.profile_id ' .
178 'WHERE group_member.group_id = %d ' .
179 'AND group_member.is_admin = 1 ' .
180 'ORDER BY group_member.modified ASC ';
182 if ($limit != null) {
183 if (common_config('db','type') == 'pgsql') {
184 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
186 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
190 $admins = new Profile();
192 $admins->query(sprintf($qry, $this->id));
196 function getBlocked($offset=0, $limit=null)
199 'SELECT profile.* ' .
200 'FROM profile JOIN group_block '.
201 'ON profile.id = group_block.blocked ' .
202 'WHERE group_block.group_id = %d ' .
203 'ORDER BY group_block.modified DESC ';
205 if ($limit != null) {
206 if (common_config('db','type') == 'pgsql') {
207 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
209 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
213 $blocked = new Profile();
215 $blocked->query(sprintf($qry, $this->id));
219 function setOriginal($filename)
221 $imagefile = new ImageFile($this->id, Avatar::path($filename));
223 $orig = clone($this);
224 $this->original_logo = Avatar::url($filename);
225 $this->homepage_logo = Avatar::url($imagefile->resize(AVATAR_PROFILE_SIZE));
226 $this->stream_logo = Avatar::url($imagefile->resize(AVATAR_STREAM_SIZE));
227 $this->mini_logo = Avatar::url($imagefile->resize(AVATAR_MINI_SIZE));
228 common_debug(common_log_objstring($this));
229 return $this->update($orig);
232 function getBestName()
234 return ($this->fullname) ? $this->fullname : $this->nickname;
237 function getAliases()
243 $alias = new Group_alias();
245 $alias->group_id = $this->id;
247 if ($alias->find()) {
248 while ($alias->fetch()) {
249 $aliases[] = $alias->alias;
258 function setAliases($newaliases) {
260 $newaliases = array_unique($newaliases);
262 $oldaliases = $this->getAliases();
264 # Delete stuff that's old that not in new
266 $to_delete = array_diff($oldaliases, $newaliases);
268 # Insert stuff that's in new and not in old
270 $to_insert = array_diff($newaliases, $oldaliases);
272 $alias = new Group_alias();
274 $alias->group_id = $this->id;
276 foreach ($to_delete as $delalias) {
277 $alias->alias = $delalias;
278 $result = $alias->delete();
280 common_log_db_error($alias, 'DELETE', __FILE__);
285 foreach ($to_insert as $insalias) {
286 $alias->alias = $insalias;
287 $result = $alias->insert();
289 common_log_db_error($alias, 'INSERT', __FILE__);
297 static function getForNickname($nickname, $profile=null)
299 $nickname = common_canonical_nickname($nickname);
301 // Are there any matching remote groups this profile's in?
303 $group = $profile->getGroups();
304 while ($group->fetch()) {
305 if ($group->nickname == $nickname) {
306 // @fixme is this the best way?
307 return clone($group);
312 // If not, check local groups.
314 $group = Local_group::staticGet('nickname', $nickname);
315 if (!empty($group)) {
316 return User_group::staticGet('id', $group->group_id);
318 $alias = Group_alias::staticGet('alias', $nickname);
319 if (!empty($alias)) {
320 return User_group::staticGet('id', $alias->group_id);
327 return Design::staticGet('id', $this->design_id);
330 function getUserMembers()
335 if(common_config('db','quote_identifiers'))
336 $user_table = '"user"';
337 else $user_table = 'user';
341 'FROM '. $user_table .' JOIN group_member '.
342 'ON '. $user_table .'.id = group_member.profile_id ' .
343 'WHERE group_member.group_id = %d ';
345 $user->query(sprintf($qry, $this->id));
349 while ($user->fetch()) {
358 static function maxDescription()
360 $desclimit = common_config('group', 'desclimit');
361 // null => use global limit (distinct from 0!)
362 if (is_null($desclimit)) {
363 $desclimit = common_config('site', 'textlimit');
368 static function descriptionTooLong($desc)
370 $desclimit = self::maxDescription();
371 return ($desclimit > 0 && !empty($desc) && (mb_strlen($desc) > $desclimit));
374 function asAtomEntry($namespace=false, $source=false)
376 $xs = new XMLStringer(true);
379 $attrs = array('xmlns' => 'http://www.w3.org/2005/Atom',
380 'xmlns:thr' => 'http://purl.org/syndication/thread/1.0');
385 $xs->elementStart('entry', $attrs);
388 $xs->elementStart('source');
389 $xs->element('id', null, $this->permalink());
390 $xs->element('title', null, $profile->nickname . " - " . common_config('site', 'name'));
391 $xs->element('link', array('href' => $this->permalink()));
392 $xs->element('updated', null, $this->modified);
393 $xs->elementEnd('source');
396 $xs->element('title', null, $this->nickname);
397 $xs->element('summary', null, common_xml_safe_str($this->description));
399 $xs->element('link', array('rel' => 'alternate',
400 'href' => $this->permalink()));
402 $xs->element('id', null, $this->permalink());
404 $xs->element('published', null, common_date_w3dtf($this->created));
405 $xs->element('updated', null, common_date_w3dtf($this->modified));
409 array('type' => 'html'),
410 common_xml_safe_str($this->description)
413 $xs->elementEnd('entry');
415 return $xs->getString();
418 function asAtomAuthor()
420 $xs = new XMLStringer(true);
422 $xs->elementStart('author');
423 $xs->element('name', null, $this->nickname);
424 $xs->element('uri', null, $this->permalink());
425 $xs->elementEnd('author');
427 return $xs->getString();
431 * Returns an XML string fragment with group information as an
432 * Activity Streams <activity:subject> element.
434 * Assumes that 'activity' namespace has been previously defined.
438 function asActivitySubject()
440 return $this->asActivityNoun('subject');
444 * Returns an XML string fragment with group information as an
445 * Activity Streams noun object with the given element type.
447 * Assumes that 'activity', 'georss', and 'poco' namespace has been
448 * previously defined.
450 * @param string $element one of 'actor', 'subject', 'object', 'target'
454 function asActivityNoun($element)
456 $noun = ActivityObject::fromGroup($this);
457 return $noun->asString('activity:' . $element);
462 return empty($this->homepage_logo)
463 ? User_group::defaultLogo(AVATAR_PROFILE_SIZE)
464 : $this->homepage_logo;
467 static function register($fields) {
468 // MAGICALLY put fields into current scope
472 $group = new User_group();
474 $group->query('BEGIN');
481 $group->nickname = $nickname;
482 $group->fullname = $fullname;
483 $group->homepage = $homepage;
484 $group->description = $description;
485 $group->location = $location;
487 $group->mainpage = $mainpage;
488 $group->created = common_sql_now();
490 $result = $group->insert();
493 common_log_db_error($group, 'INSERT', __FILE__);
494 // TRANS: Server exception thrown when creating a group failed.
495 throw new ServerException(_('Could not create group.'));
498 if (!isset($uri) || empty($uri)) {
499 $orig = clone($group);
500 $group->uri = common_local_url('groupbyid', array('id' => $group->id));
501 $result = $group->update($orig);
503 common_log_db_error($group, 'UPDATE', __FILE__);
504 // TRANS: Server exception thrown when updating a group URI failed.
505 throw new ServerException(_('Could not set group URI.'));
509 $result = $group->setAliases($aliases);
512 // TRANS: Server exception thrown when creating group aliases failed.
513 throw new ServerException(_('Could not create aliases.'));
516 $member = new Group_member();
518 $member->group_id = $group->id;
519 $member->profile_id = $userid;
520 $member->is_admin = 1;
521 $member->created = $group->created;
523 $result = $member->insert();
526 common_log_db_error($member, 'INSERT', __FILE__);
527 // TRANS: Server exception thrown when setting group membership failed.
528 throw new ServerException(_('Could not set group membership.'));
532 $local_group = new Local_group();
534 $local_group->group_id = $group->id;
535 $local_group->nickname = $nickname;
536 $local_group->created = common_sql_now();
538 $result = $local_group->insert();
541 common_log_db_error($local_group, 'INSERT', __FILE__);
542 // TRANS: Server exception thrown when saving local group information failed.
543 throw new ServerException(_('Could not save local group info.'));
547 $group->query('COMMIT');
552 * Handle cascading deletion, on the model of notice and profile.
554 * This should handle freeing up cached entries for the group's
555 * id, nickname, URI, and aliases. There may be other areas that
556 * are not de-cached in the UI, including the sidebar lists on
563 // Safe to delete in bulk for now
565 $related = array('Group_inbox',
570 Event::handle('UserGroupDeleteRelated', array($this, &$related));
572 foreach ($related as $cls) {
575 $inst->group_id = $this->id;
578 while ($inst->fetch()) {
585 // And related groups in the other direction...
586 $inst = new Related_group();
587 $inst->related_group_id = $this->id;
590 // Aliases and the local_group entry need to be cleared explicitly
591 // or we'll miss clearing some cache keys; that can make it hard
592 // to create a new group with one of those names or aliases.
593 $this->setAliases(array());
594 $local = Local_group::staticGet('group_id', $this->id);
599 // blow the cached ids
600 self::blow('user_group:notice_ids:%d', $this->id);
603 common_log(LOG_WARN, "Ambiguous user_group->delete(); skipping related tables.");