classes/User_group.php

   1 <?php
   2 /**
   3  * Table Definition for user_group
   4  */
   5
   6 class User_group extends Managed_DataObject
   7 {
   8     const JOIN_POLICY_OPEN = 0;
   9     const JOIN_POLICY_MODERATE = 1;
  10     const CACHE_WINDOW = 201;
  11
  12     ###START_AUTOCODE
  13     /* the code below is auto generated do not remove the above tag */
  14
  15     public $__table = 'user_group';                      // table name
  16     public $id;                              // int(4)  primary_key not_null
  17     public $nickname;                        // varchar(64)
  18     public $fullname;                        // varchar(255)
  19     public $homepage;                        // varchar(255)
  20     public $description;                     // text
  21     public $location;                        // varchar(255)
  22     public $original_logo;                   // varchar(255)
  23     public $homepage_logo;                   // varchar(255)
  24     public $stream_logo;                     // varchar(255)
  25     public $mini_logo;                       // varchar(255)
  26     public $created;                         // datetime   not_null default_0000-00-00%2000%3A00%3A00
  27     public $modified;                        // timestamp   not_null default_CURRENT_TIMESTAMP
  28     public $uri;                             // varchar(255)  unique_key
  29     public $mainpage;                        // varchar(255)
  30     public $join_policy;                     // tinyint
  31     public $force_scope;                     // tinyint
  32
  33     function multiGet($keyCol, $keyVals, $skipNulls=true)
  34     {
  35         return parent::multiGet('User_group', $keyCol, $keyVals, $skipNulls);
  36     }
  37
  38     /* the code above is auto generated do not remove the tag below */
  39     ###END_AUTOCODE
  40
  41     public static function schemaDef()
  42     {
  43         return array(
  44             'fields' => array(
  45                 'id' => array('type' => 'serial', 'not null' => true, 'description' => 'unique identifier'),
  46
  47                 'nickname' => array('type' => 'varchar', 'length' => 64, 'description' => 'nickname for addressing'),
  48                 'fullname' => array('type' => 'varchar', 'length' => 255, 'description' => 'display name'),
  49                 'homepage' => array('type' => 'varchar', 'length' => 255, 'description' => 'URL, cached so we dont regenerate'),
  50                 'description' => array('type' => 'text', 'description' => 'group description'),
  51                 'location' => array('type' => 'varchar', 'length' => 255, 'description' => 'related physical location, if any'),
  52
  53                 'original_logo' => array('type' => 'varchar', 'length' => 255, 'description' => 'original size logo'),
  54                 'homepage_logo' => array('type' => 'varchar', 'length' => 255, 'description' => 'homepage (profile) size logo'),
  55                 'stream_logo' => array('type' => 'varchar', 'length' => 255, 'description' => 'stream-sized logo'),
  56                 'mini_logo' => array('type' => 'varchar', 'length' => 255, 'description' => 'mini logo'),
  57
  58                 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'),
  59                 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
  60
  61                 'uri' => array('type' => 'varchar', 'length' => 255, 'description' => 'universal identifier'),
  62                 'mainpage' => array('type' => 'varchar', 'length' => 255, 'description' => 'page for group info to link to'),
  63                 'join_policy' => array('type' => 'int', 'size' => 'tiny', 'description' => '0=open; 1=requires admin approval'),
  64                 'force_scope' => array('type' => 'int', 'size' => 'tiny', 'description' => '0=never,1=sometimes,-1=always'),
  65             ),
  66             'primary key' => array('id'),
  67             'unique keys' => array(
  68                 'user_group_uri_key' => array('uri'),
  69             ),
  70             'indexes' => array(
  71                 'user_group_nickname_idx' => array('nickname'),
  72             ),
  73         );
  74     }
  75
  76     function defaultLogo($size)
  77     {
  78         static $sizenames = array(AVATAR_PROFILE_SIZE => 'profile',
  79                                   AVATAR_STREAM_SIZE => 'stream',
  80                                   AVATAR_MINI_SIZE => 'mini');
  81         return Theme::path('default-avatar-'.$sizenames[$size].'.png');
  82     }
  83
  84     function homeUrl()
  85     {
  86         $url = null;
  87         if (Event::handle('StartUserGroupHomeUrl', array($this, &$url))) {
  88             // normally stored in mainpage, but older ones may be null
  89             if (!empty($this->mainpage)) {
  90                 $url = $this->mainpage;
  91             } else {
  92                 $url = common_local_url('showgroup',
  93                                         array('nickname' => $this->nickname));
  94             }
  95         }
  96         Event::handle('EndUserGroupHomeUrl', array($this, &$url));
  97         return $url;
  98     }
  99
 100     function getUri()
 101     {
 102         $uri = null;
 103         if (Event::handle('StartUserGroupGetUri', array($this, &$uri))) {
 104             if (!empty($this->uri)) {
 105                 $uri = $this->uri;
 106             } else {
 107                 $uri = common_local_url('groupbyid',
 108                                         array('id' => $this->id));
 109             }
 110         }
 111         Event::handle('EndUserGroupGetUri', array($this, &$uri));
 112         return $uri;
 113     }
 114
 115     function permalink()
 116     {
 117         $url = null;
 118         if (Event::handle('StartUserGroupPermalink', array($this, &$url))) {
 119             $url = common_local_url('groupbyid',
 120                                     array('id' => $this->id));
 121         }
 122         Event::handle('EndUserGroupPermalink', array($this, &$url));
 123         return $url;
 124     }
 125
 126     function getNotices($offset, $limit, $since_id=null, $max_id=null)
 127     {
 128         $stream = new GroupNoticeStream($this);
 129
 130         return $stream->getNotices($offset, $limit, $since_id, $max_id);
 131     }
 132
 133
 134     function allowedNickname($nickname)
 135     {
 136         static $blacklist = array('new');
 137         return !in_array($nickname, $blacklist);
 138     }
 139
 140     function getMembers($offset=0, $limit=null) {
 141         $ids = null;
 142         if (is_null($limit) || $offset + $limit > User_group::CACHE_WINDOW) {
 143             $ids = $this->getMemberIDs($offset,
 144                                        $limit);
 145         } else {
 146             $key = sprintf('group:member_ids:%d', $this->id);
 147             $window = self::cacheGet($key);
 148             if ($window === false) {
 149                 $window = $this->getMemberIDs(0,
 150                                               User_group::CACHE_WINDOW);
 151                 self::cacheSet($key, $window);
 152             }
 153
 154             $ids = array_slice($window,
 155                                $offset,
 156                                $limit);
 157         }
 158
 159         return Profile::multiGet('id', $ids);
 160     }
 161
 162     function getMemberIDs($offset=0, $limit=null)
 163     {
 164         $gm = new Group_member();
 165
 166         $gm->selectAdd();
 167         $gm->selectAdd('profile_id');
 168
 169         $gm->group_id = $this->id;
 170
 171         $gm->orderBy('created DESC');
 172
 173         if (!is_null($limit)) {
 174             $gm->limit($offset, $limit);
 175         }
 176
 177         $ids = array();
 178
 179         if ($gm->find()) {
 180             while ($gm->fetch()) {
 181                 $ids[] = $gm->profile_id;
 182             }
 183         }
 184
 185         return $ids;
 186     }
 187
 188     /**
 189      * Get pending members, who have not yet been approved.
 190      *
 191      * @param int $offset
 192      * @param int $limit
 193      * @return Profile
 194      */
 195     function getRequests($offset=0, $limit=null)
 196     {
 197         $qry =
 198           'SELECT profile.* ' .
 199           'FROM profile JOIN group_join_queue '.
 200           'ON profile.id = group_join_queue.profile_id ' .
 201           'WHERE group_join_queue.group_id = %d ' .
 202           'ORDER BY group_join_queue.created DESC ';
 203
 204         if ($limit != null) {
 205             if (common_config('db','type') == 'pgsql') {
 206                 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
 207             } else {
 208                 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
 209             }
 210         }
 211
 212         $members = new Profile();
 213
 214         $members->query(sprintf($qry, $this->id));
 215         return $members;
 216     }
 217
 218     function getMemberCount()
 219     {
 220         $key = sprintf("group:member_count:%d", $this->id);
 221
 222         $cnt = self::cacheGet($key);
 223
 224         if (is_integer($cnt)) {
 225             return (int) $cnt;
 226         }
 227
 228         $mem = new Group_member();
 229         $mem->group_id = $this->id;
 230
 231         // XXX: why 'distinct'?
 232
 233         $cnt = (int) $mem->count('distinct profile_id');
 234
 235         self::cacheSet($key, $cnt);
 236
 237         return $cnt;
 238     }
 239
 240     function getBlockedCount()
 241     {
 242         // XXX: WORM cache this
 243
 244         $block = new Group_block();
 245         $block->group_id = $this->id;
 246
 247         return $block->count();
 248     }
 249
 250     function getQueueCount()
 251     {
 252         // XXX: WORM cache this
 253
 254         $queue = new Group_join_queue();
 255         $queue->group_id = $this->id;
 256
 257         return $queue->count();
 258     }
 259
 260     function getAdmins($offset=0, $limit=null)
 261     {
 262         $qry =
 263           'SELECT profile.* ' .
 264           'FROM profile JOIN group_member '.
 265           'ON profile.id = group_member.profile_id ' .
 266           'WHERE group_member.group_id = %d ' .
 267           'AND group_member.is_admin = 1 ' .
 268           'ORDER BY group_member.modified ASC ';
 269
 270         if ($limit != null) {
 271             if (common_config('db','type') == 'pgsql') {
 272                 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
 273             } else {
 274                 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
 275             }
 276         }
 277
 278         $admins = new Profile();
 279
 280         $admins->query(sprintf($qry, $this->id));
 281         return $admins;
 282     }
 283
 284     function getBlocked($offset=0, $limit=null)
 285     {
 286         $qry =
 287           'SELECT profile.* ' .
 288           'FROM profile JOIN group_block '.
 289           'ON profile.id = group_block.blocked ' .
 290           'WHERE group_block.group_id = %d ' .
 291           'ORDER BY group_block.modified DESC ';
 292
 293         if ($limit != null) {
 294             if (common_config('db','type') == 'pgsql') {
 295                 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
 296             } else {
 297                 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
 298             }
 299         }
 300
 301         $blocked = new Profile();
 302
 303         $blocked->query(sprintf($qry, $this->id));
 304         return $blocked;
 305     }
 306
 307     function setOriginal($filename)
 308     {
 309         $imagefile = new ImageFile($this->id, Avatar::path($filename));
 310
 311         $orig = clone($this);
 312         $this->original_logo = Avatar::url($filename);
 313         $this->homepage_logo = Avatar::url($imagefile->resize(AVATAR_PROFILE_SIZE));
 314         $this->stream_logo = Avatar::url($imagefile->resize(AVATAR_STREAM_SIZE));
 315         $this->mini_logo = Avatar::url($imagefile->resize(AVATAR_MINI_SIZE));
 316         common_debug(common_log_objstring($this));
 317         return $this->update($orig);
 318     }
 319
 320     function getBestName()
 321     {
 322         return ($this->fullname) ? $this->fullname : $this->nickname;
 323     }
 324
 325     /**
 326      * Gets the full name (if filled) with nickname as a parenthetical, or the nickname alone
 327      * if no fullname is provided.
 328      *
 329      * @return string
 330      */
 331     function getFancyName()
 332     {
 333         if ($this->fullname) {
 334             // TRANS: Full name of a profile or group followed by nickname in parens
 335             return sprintf(_m('FANCYNAME','%1$s (%2$s)'), $this->fullname, $this->nickname);
 336         } else {
 337             return $this->nickname;
 338         }
 339     }
 340
 341     function getAliases()
 342     {
 343         $aliases = array();
 344
 345         // XXX: cache this
 346
 347         $alias = new Group_alias();
 348
 349         $alias->group_id = $this->id;
 350
 351         if ($alias->find()) {
 352             while ($alias->fetch()) {
 353                 $aliases[] = $alias->alias;
 354             }
 355         }
 356
 357         $alias->free();
 358
 359         return $aliases;
 360     }
 361
 362     function setAliases($newaliases) {
 363
 364         $newaliases = array_unique($newaliases);
 365
 366         $oldaliases = $this->getAliases();
 367
 368         // Delete stuff that's old that not in new
 369
 370         $to_delete = array_diff($oldaliases, $newaliases);
 371
 372         // Insert stuff that's in new and not in old
 373
 374         $to_insert = array_diff($newaliases, $oldaliases);
 375
 376         $alias = new Group_alias();
 377
 378         $alias->group_id = $this->id;
 379
 380         foreach ($to_delete as $delalias) {
 381             $alias->alias = $delalias;
 382             $result = $alias->delete();
 383             if (!$result) {
 384                 common_log_db_error($alias, 'DELETE', __FILE__);
 385                 return false;
 386             }
 387         }
 388
 389         foreach ($to_insert as $insalias) {
 390             $alias->alias = $insalias;
 391             $result = $alias->insert();
 392             if (!$result) {
 393                 common_log_db_error($alias, 'INSERT', __FILE__);
 394                 return false;
 395             }
 396         }
 397
 398         return true;
 399     }
 400
 401     static function getForNickname($nickname, $profile=null)
 402     {
 403         $nickname = common_canonical_nickname($nickname);
 404
 405         // Are there any matching remote groups this profile's in?
 406         if ($profile) {
 407             $group = $profile->getGroups(0, null);
 408             while ($group->fetch()) {
 409                 if ($group->nickname == $nickname) {
 410                     // @fixme is this the best way?
 411                     return clone($group);
 412                 }
 413             }
 414         }
 415
 416         // If not, check local groups.
 417
 418         $group = Local_group::getKV('nickname', $nickname);
 419         if (!empty($group)) {
 420             return User_group::getKV('id', $group->group_id);
 421         }
 422         $alias = Group_alias::getKV('alias', $nickname);
 423         if (!empty($alias)) {
 424             return User_group::getKV('id', $alias->group_id);
 425         }
 426         return null;
 427     }
 428
 429     function getUserMembers()
 430     {
 431         // XXX: cache this
 432
 433         $user = new User();
 434         if(common_config('db','quote_identifiers'))
 435             $user_table = '"user"';
 436         else $user_table = 'user';
 437
 438         $qry =
 439           'SELECT id ' .
 440           'FROM '. $user_table .' JOIN group_member '.
 441           'ON '. $user_table .'.id = group_member.profile_id ' .
 442           'WHERE group_member.group_id = %d ';
 443
 444         $user->query(sprintf($qry, $this->id));
 445
 446         $ids = array();
 447
 448         while ($user->fetch()) {
 449             $ids[] = $user->id;
 450         }
 451
 452         $user->free();
 453
 454         return $ids;
 455     }
 456
 457     static function maxDescription()
 458     {
 459         $desclimit = common_config('group', 'desclimit');
 460         // null => use global limit (distinct from 0!)
 461         if (is_null($desclimit)) {
 462             $desclimit = common_config('site', 'textlimit');
 463         }
 464         return $desclimit;
 465     }
 466
 467     static function descriptionTooLong($desc)
 468     {
 469         $desclimit = self::maxDescription();
 470         return ($desclimit > 0 && !empty($desc) && (mb_strlen($desc) > $desclimit));
 471     }
 472
 473     function asAtomEntry($namespace=false, $source=false)
 474     {
 475         $xs = new XMLStringer(true);
 476
 477         if ($namespace) {
 478             $attrs = array('xmlns' => 'http://www.w3.org/2005/Atom',
 479                            'xmlns:thr' => 'http://purl.org/syndication/thread/1.0');
 480         } else {
 481             $attrs = array();
 482         }
 483
 484         $xs->elementStart('entry', $attrs);
 485
 486         if ($source) {
 487             $xs->elementStart('source');
 488             $xs->element('id', null, $this->permalink());
 489             $xs->element('title', null, $profile->nickname . " - " . common_config('site', 'name'));
 490             $xs->element('link', array('href' => $this->permalink()));
 491             $xs->element('updated', null, $this->modified);
 492             $xs->elementEnd('source');
 493         }
 494
 495         $xs->element('title', null, $this->nickname);
 496         $xs->element('summary', null, common_xml_safe_str($this->description));
 497
 498         $xs->element('link', array('rel' => 'alternate',
 499                                    'href' => $this->permalink()));
 500
 501         $xs->element('id', null, $this->permalink());
 502
 503         $xs->element('published', null, common_date_w3dtf($this->created));
 504         $xs->element('updated', null, common_date_w3dtf($this->modified));
 505
 506         $xs->element(
 507             'content',
 508             array('type' => 'html'),
 509             common_xml_safe_str($this->description)
 510         );
 511
 512         $xs->elementEnd('entry');
 513
 514         return $xs->getString();
 515     }
 516
 517     function asAtomAuthor()
 518     {
 519         $xs = new XMLStringer(true);
 520
 521         $xs->elementStart('author');
 522         $xs->element('name', null, $this->nickname);
 523         $xs->element('uri', null, $this->permalink());
 524         $xs->elementEnd('author');
 525
 526         return $xs->getString();
 527     }
 528
 529     /**
 530      * Returns an XML string fragment with group information as an
 531      * Activity Streams <activity:subject> element.
 532      *
 533      * Assumes that 'activity' namespace has been previously defined.
 534      *
 535      * @return string
 536      */
 537     function asActivitySubject()
 538     {
 539         return $this->asActivityNoun('subject');
 540     }
 541
 542     /**
 543      * Returns an XML string fragment with group information as an
 544      * Activity Streams noun object with the given element type.
 545      *
 546      * Assumes that 'activity', 'georss', and 'poco' namespace has been
 547      * previously defined.
 548      *
 549      * @param string $element one of 'actor', 'subject', 'object', 'target'
 550      *
 551      * @return string
 552      */
 553     function asActivityNoun($element)
 554     {
 555         $noun = ActivityObject::fromGroup($this);
 556         return $noun->asString('activity:' . $element);
 557     }
 558
 559     function getAvatar()
 560     {
 561         return empty($this->homepage_logo)
 562             ? User_group::defaultLogo(AVATAR_PROFILE_SIZE)
 563             : $this->homepage_logo;
 564     }
 565
 566     static function register($fields) {
 567         if (!empty($fields['userid'])) {
 568             $profile = Profile::getKV('id', $fields['userid']);
 569             if ($profile && !$profile->hasRight(Right::CREATEGROUP)) {
 570                 common_log(LOG_WARNING, "Attempted group creation from banned user: " . $profile->nickname);
 571
 572                 // TRANS: Client exception thrown when a user tries to create a group while banned.
 573                 throw new ClientException(_('You are not allowed to create groups on this site.'), 403);
 574             }
 575         }
 576
 577         // MAGICALLY put fields into current scope
 578         // @fixme kill extract(); it makes debugging absurdly hard
 579
 580                 $defaults = array('nickname' => null,
 581                                                   'fullname' => null,
 582                                                   'homepage' => null,
 583                                                   'description' => null,
 584                                                   'location' => null,
 585                                                   'uri' => null,
 586                                                   'mainpage' => null,
 587                                                   'aliases' => array(),
 588                                                   'userid' => null);
 589
 590                 $fields = array_merge($defaults, $fields);
 591
 592         extract($fields);
 593
 594         $group = new User_group();
 595
 596         $group->query('BEGIN');
 597
 598         if (empty($uri)) {
 599             // fill in later...
 600             $uri = null;
 601         }
 602         if (empty($mainpage)) {
 603             $mainpage = common_local_url('showgroup', array('nickname' => $nickname));
 604         }
 605
 606         $group->nickname    = $nickname;
 607         $group->fullname    = $fullname;
 608         $group->homepage    = $homepage;
 609         $group->description = $description;
 610         $group->location    = $location;
 611         $group->uri         = $uri;
 612         $group->mainpage    = $mainpage;
 613         $group->created     = common_sql_now();
 614
 615         if (isset($fields['join_policy'])) {
 616             $group->join_policy = intval($fields['join_policy']);
 617         } else {
 618             $group->join_policy = 0;
 619         }
 620
 621         if (isset($fields['force_scope'])) {
 622             $group->force_scope = intval($fields['force_scope']);
 623         } else {
 624             $group->force_scope = 0;
 625         }
 626
 627         if (Event::handle('StartGroupSave', array(&$group))) {
 628
 629             $result = $group->insert();
 630
 631             if (!$result) {
 632                 common_log_db_error($group, 'INSERT', __FILE__);
 633                 // TRANS: Server exception thrown when creating a group failed.
 634                 throw new ServerException(_('Could not create group.'));
 635             }
 636
 637             if (!isset($uri) || empty($uri)) {
 638                 $orig = clone($group);
 639                 $group->uri = common_local_url('groupbyid', array('id' => $group->id));
 640                 $result = $group->update($orig);
 641                 if (!$result) {
 642                     common_log_db_error($group, 'UPDATE', __FILE__);
 643                     // TRANS: Server exception thrown when updating a group URI failed.
 644                     throw new ServerException(_('Could not set group URI.'));
 645                 }
 646             }
 647
 648             $result = $group->setAliases($aliases);
 649
 650             if (!$result) {
 651                 // TRANS: Server exception thrown when creating group aliases failed.
 652                 throw new ServerException(_('Could not create aliases.'));
 653             }
 654
 655             $member = new Group_member();
 656
 657             $member->group_id   = $group->id;
 658             $member->profile_id = $userid;
 659             $member->is_admin   = 1;
 660             $member->created    = $group->created;
 661
 662             $result = $member->insert();
 663
 664             if (!$result) {
 665                 common_log_db_error($member, 'INSERT', __FILE__);
 666                 // TRANS: Server exception thrown when setting group membership failed.
 667                 throw new ServerException(_('Could not set group membership.'));
 668             }
 669
 670             self::blow('profile:groups:%d', $userid);
 671
 672             if ($local) {
 673                 $local_group = new Local_group();
 674
 675                 $local_group->group_id = $group->id;
 676                 $local_group->nickname = $nickname;
 677                 $local_group->created  = common_sql_now();
 678
 679                 $result = $local_group->insert();
 680
 681                 if (!$result) {
 682                     common_log_db_error($local_group, 'INSERT', __FILE__);
 683                     // TRANS: Server exception thrown when saving local group information failed.
 684                     throw new ServerException(_('Could not save local group info.'));
 685                 }
 686             }
 687
 688             $group->query('COMMIT');
 689
 690             Event::handle('EndGroupSave', array($group));
 691         }
 692
 693         return $group;
 694     }
 695
 696     /**
 697      * Handle cascading deletion, on the model of notice and profile.
 698      *
 699      * This should handle freeing up cached entries for the group's
 700      * id, nickname, URI, and aliases. There may be other areas that
 701      * are not de-cached in the UI, including the sidebar lists on
 702      * GroupsAction
 703      */
 704     function delete()
 705     {
 706         if ($this->id) {
 707
 708             // Safe to delete in bulk for now
 709
 710             $related = array('Group_inbox',
 711                              'Group_block',
 712                              'Group_member',
 713                              'Related_group');
 714
 715             Event::handle('UserGroupDeleteRelated', array($this, &$related));
 716
 717             foreach ($related as $cls) {
 718
 719                 $inst = new $cls();
 720                 $inst->group_id = $this->id;
 721
 722                 if ($inst->find()) {
 723                     while ($inst->fetch()) {
 724                         $dup = clone($inst);
 725                         $dup->delete();
 726                     }
 727                 }
 728             }
 729
 730             // And related groups in the other direction...
 731             $inst = new Related_group();
 732             $inst->related_group_id = $this->id;
 733             $inst->delete();
 734
 735             // Aliases and the local_group entry need to be cleared explicitly
 736             // or we'll miss clearing some cache keys; that can make it hard
 737             // to create a new group with one of those names or aliases.
 738             $this->setAliases(array());
 739             $local = Local_group::getKV('group_id', $this->id);
 740             if ($local) {
 741                 $local->delete();
 742             }
 743
 744             // blow the cached ids
 745             self::blow('user_group:notice_ids:%d', $this->id);
 746
 747         } else {
 748             common_log(LOG_WARN, "Ambiguous user_group->delete(); skipping related tables.");
 749         }
 750         parent::delete();
 751     }
 752
 753     function isPrivate()
 754     {
 755         return ($this->join_policy == self::JOIN_POLICY_MODERATE &&
 756                 $this->force_scope == 1);
 757     }
 758 }