classes/Profile.php

   1 <?php
   2 /*
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2008, 2009, StatusNet, Inc.
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU Affero General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU Affero General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Affero General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); }
  21
  22 /**
  23  * Table Definition for profile
  24  */
  25 require_once INSTALLDIR.'/classes/Memcached_DataObject.php';
  26
  27 class Profile extends Memcached_DataObject
  28 {
  29     ###START_AUTOCODE
  30     /* the code below is auto generated do not remove the above tag */
  31
  32     public $__table = 'profile';                         // table name
  33     public $id;                              // int(4)  primary_key not_null
  34     public $nickname;                        // varchar(64)  multiple_key not_null
  35     public $fullname;                        // varchar(255)  multiple_key
  36     public $profileurl;                      // varchar(255)
  37     public $homepage;                        // varchar(255)  multiple_key
  38     public $bio;                             // text()  multiple_key
  39     public $location;                        // varchar(255)  multiple_key
  40     public $lat;                             // decimal(10,7)
  41     public $lon;                             // decimal(10,7)
  42     public $location_id;                     // int(4)
  43     public $location_ns;                     // int(4)
  44     public $created;                         // datetime()   not_null
  45     public $modified;                        // timestamp()   not_null default_CURRENT_TIMESTAMP
  46
  47     /* Static get */
  48     function staticGet($k,$v=NULL) {
  49         return Memcached_DataObject::staticGet('Profile',$k,$v);
  50     }
  51
  52     /* the code above is auto generated do not remove the tag below */
  53     ###END_AUTOCODE
  54
  55     function getUser()
  56     {
  57         return User::staticGet('id', $this->id);
  58     }
  59
  60     function getAvatar($width, $height=null)
  61     {
  62         if (is_null($height)) {
  63             $height = $width;
  64         }
  65         return Avatar::pkeyGet(array('profile_id' => $this->id,
  66                                      'width' => $width,
  67                                      'height' => $height));
  68     }
  69
  70     function getOriginalAvatar()
  71     {
  72         $avatar = DB_DataObject::factory('avatar');
  73         $avatar->profile_id = $this->id;
  74         $avatar->original = true;
  75         if ($avatar->find(true)) {
  76             return $avatar;
  77         } else {
  78             return null;
  79         }
  80     }
  81
  82     function setOriginal($filename)
  83     {
  84         $imagefile = new ImageFile($this->id, Avatar::path($filename));
  85
  86         $avatar = new Avatar();
  87         $avatar->profile_id = $this->id;
  88         $avatar->width = $imagefile->width;
  89         $avatar->height = $imagefile->height;
  90         $avatar->mediatype = image_type_to_mime_type($imagefile->type);
  91         $avatar->filename = $filename;
  92         $avatar->original = true;
  93         $avatar->url = Avatar::url($filename);
  94         $avatar->created = DB_DataObject_Cast::dateTime(); # current time
  95
  96         # XXX: start a transaction here
  97
  98         if (!$this->delete_avatars() || !$avatar->insert()) {
  99             @unlink(Avatar::path($filename));
 100             return null;
 101         }
 102
 103         foreach (array(AVATAR_PROFILE_SIZE, AVATAR_STREAM_SIZE, AVATAR_MINI_SIZE) as $size) {
 104             # We don't do a scaled one if original is our scaled size
 105             if (!($avatar->width == $size && $avatar->height == $size)) {
 106
 107                 $scaled_filename = $imagefile->resize($size);
 108
 109                 //$scaled = DB_DataObject::factory('avatar');
 110                 $scaled = new Avatar();
 111                 $scaled->profile_id = $this->id;
 112                 $scaled->width = $size;
 113                 $scaled->height = $size;
 114                 $scaled->original = false;
 115                 $scaled->mediatype = image_type_to_mime_type($imagefile->type);
 116                 $scaled->filename = $scaled_filename;
 117                 $scaled->url = Avatar::url($scaled_filename);
 118                 $scaled->created = DB_DataObject_Cast::dateTime(); # current time
 119
 120                 if (!$scaled->insert()) {
 121                     return null;
 122                 }
 123             }
 124         }
 125
 126         return $avatar;
 127     }
 128
 129     function delete_avatars($original=true)
 130     {
 131         $avatar = new Avatar();
 132         $avatar->profile_id = $this->id;
 133         $avatar->find();
 134         while ($avatar->fetch()) {
 135             if ($avatar->original) {
 136                 if ($original == false) {
 137                     continue;
 138                 }
 139             }
 140             $avatar->delete();
 141         }
 142         return true;
 143     }
 144
 145     function getBestName()
 146     {
 147         return ($this->fullname) ? $this->fullname : $this->nickname;
 148     }
 149
 150     # Get latest notice on or before date; default now
 151     function getCurrentNotice($dt=null)
 152     {
 153         $notice = new Notice();
 154         $notice->profile_id = $this->id;
 155         if ($dt) {
 156             $notice->whereAdd('created < "' . $dt . '"');
 157         }
 158         $notice->orderBy('created DESC, notice.id DESC');
 159         $notice->limit(1);
 160         if ($notice->find(true)) {
 161             return $notice;
 162         }
 163         return null;
 164     }
 165
 166     function getTaggedNotices($tag, $offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $max_id=0, $since=null)
 167     {
 168         $ids = Notice::stream(array($this, '_streamTaggedDirect'),
 169                               array($tag),
 170                               'profile:notice_ids_tagged:' . $this->id . ':' . $tag,
 171                               $offset, $limit, $since_id, $max_id, $since);
 172         return Notice::getStreamByIds($ids);
 173     }
 174
 175     function getNotices($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $max_id=0, $since=null)
 176     {
 177         // XXX: I'm not sure this is going to be any faster. It probably isn't.
 178         $ids = Notice::stream(array($this, '_streamDirect'),
 179                               array(),
 180                               'profile:notice_ids:' . $this->id,
 181                               $offset, $limit, $since_id, $max_id, $since);
 182
 183         return Notice::getStreamByIds($ids);
 184     }
 185
 186     function _streamTaggedDirect($tag, $offset, $limit, $since_id, $max_id, $since)
 187     {
 188         // XXX It would be nice to do this without a join
 189
 190         $notice = new Notice();
 191
 192         $query =
 193           "select id from notice join notice_tag on id=notice_id where tag='".
 194           $notice->escape($tag) .
 195           "' and profile_id=" . $notice->escape($this->id);
 196
 197         if ($since_id != 0) {
 198             $query .= " and id > $since_id";
 199         }
 200
 201         if ($max_id != 0) {
 202             $query .= " and id < $max_id";
 203         }
 204
 205         if (!is_null($since)) {
 206             $query .= " and created > '" . date('Y-m-d H:i:s', $since) . "'";
 207         }
 208
 209         $query .= ' order by id DESC';
 210
 211         if (!is_null($offset)) {
 212             $query .= " LIMIT $limit OFFSET $offset";
 213         }
 214
 215         $notice->query($query);
 216
 217         $ids = array();
 218
 219         while ($notice->fetch()) {
 220             $ids[] = $notice->id;
 221         }
 222
 223         return $ids;
 224     }
 225
 226     function _streamDirect($offset, $limit, $since_id, $max_id, $since = null)
 227     {
 228         $notice = new Notice();
 229
 230         $notice->profile_id = $this->id;
 231
 232         $notice->selectAdd();
 233         $notice->selectAdd('id');
 234
 235         if ($since_id != 0) {
 236             $notice->whereAdd('id > ' . $since_id);
 237         }
 238
 239         if ($max_id != 0) {
 240             $notice->whereAdd('id <= ' . $max_id);
 241         }
 242
 243         if (!is_null($since)) {
 244             $notice->whereAdd('created > \'' . date('Y-m-d H:i:s', $since) . '\'');
 245         }
 246
 247         $notice->orderBy('id DESC');
 248
 249         if (!is_null($offset)) {
 250             $notice->limit($offset, $limit);
 251         }
 252
 253         $ids = array();
 254
 255         if ($notice->find()) {
 256             while ($notice->fetch()) {
 257                 $ids[] = $notice->id;
 258             }
 259         }
 260
 261         return $ids;
 262     }
 263
 264     function isMember($group)
 265     {
 266         $mem = new Group_member();
 267
 268         $mem->group_id = $group->id;
 269         $mem->profile_id = $this->id;
 270
 271         if ($mem->find()) {
 272             return true;
 273         } else {
 274             return false;
 275         }
 276     }
 277
 278     function isAdmin($group)
 279     {
 280         $mem = new Group_member();
 281
 282         $mem->group_id = $group->id;
 283         $mem->profile_id = $this->id;
 284         $mem->is_admin = 1;
 285
 286         if ($mem->find()) {
 287             return true;
 288         } else {
 289             return false;
 290         }
 291     }
 292
 293     function avatarUrl($size=AVATAR_PROFILE_SIZE)
 294     {
 295         $avatar = $this->getAvatar($size);
 296         if ($avatar) {
 297             return $avatar->displayUrl();
 298         } else {
 299             return Avatar::defaultImage($size);
 300         }
 301     }
 302
 303     function getSubscriptions($offset=0, $limit=null)
 304     {
 305         $qry =
 306           'SELECT profile.* ' .
 307           'FROM profile JOIN subscription ' .
 308           'ON profile.id = subscription.subscribed ' .
 309           'WHERE subscription.subscriber = %d ' .
 310           'AND subscription.subscribed != subscription.subscriber ' .
 311           'ORDER BY subscription.created DESC ';
 312
 313         if ($offset>0 && !is_null($limit)){
 314             if (common_config('db','type') == 'pgsql') {
 315                 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
 316             } else {
 317                 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
 318             }
 319         }
 320
 321         $profile = new Profile();
 322
 323         $profile->query(sprintf($qry, $this->id));
 324
 325         return $profile;
 326     }
 327
 328     function getSubscribers($offset=0, $limit=null)
 329     {
 330         $qry =
 331           'SELECT profile.* ' .
 332           'FROM profile JOIN subscription ' .
 333           'ON profile.id = subscription.subscriber ' .
 334           'WHERE subscription.subscribed = %d ' .
 335           'AND subscription.subscribed != subscription.subscriber ' .
 336           'ORDER BY subscription.created DESC ';
 337
 338         if ($offset>0 && !is_null($limit)){
 339             if ($offset) {
 340                 if (common_config('db','type') == 'pgsql') {
 341                     $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
 342                 } else {
 343                     $qry .= ' LIMIT ' . $offset . ', ' . $limit;
 344                 }
 345             }
 346         }
 347
 348         $profile = new Profile();
 349
 350         $cnt = $profile->query(sprintf($qry, $this->id));
 351
 352         return $profile;
 353     }
 354
 355     function getApplications($offset = 0, $limit = null)
 356     {
 357         $qry =
 358           'SELECT oauth_application_user.* ' .
 359           'FROM oauth_application_user ' .
 360           'WHERE profile_id = %d ' .
 361           'ORDER BY created DESC ';
 362
 363         if ($offset > 0) {
 364             if (common_config('db','type') == 'pgsql') {
 365                 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
 366             } else {
 367                 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
 368             }
 369         }
 370
 371         $application = new Oauth_application();
 372
 373         $cnt = $application->query(sprintf($qry, $this->id));
 374
 375         return $application;
 376     }
 377
 378     function subscriptionCount()
 379     {
 380         $c = common_memcache();
 381
 382         if (!empty($c)) {
 383             $cnt = $c->get(common_cache_key('profile:subscription_count:'.$this->id));
 384             if (is_integer($cnt)) {
 385                 return (int) $cnt;
 386             }
 387         }
 388
 389         $sub = new Subscription();
 390         $sub->subscriber = $this->id;
 391
 392         $cnt = (int) $sub->count('distinct subscribed');
 393
 394         $cnt = ($cnt > 0) ? $cnt - 1 : $cnt;
 395
 396         if (!empty($c)) {
 397             $c->set(common_cache_key('profile:subscription_count:'.$this->id), $cnt);
 398         }
 399
 400         return $cnt;
 401     }
 402
 403     function subscriberCount()
 404     {
 405         $c = common_memcache();
 406         if (!empty($c)) {
 407             $cnt = $c->get(common_cache_key('profile:subscriber_count:'.$this->id));
 408             if (is_integer($cnt)) {
 409                 return (int) $cnt;
 410             }
 411         }
 412
 413         $sub = new Subscription();
 414         $sub->subscribed = $this->id;
 415
 416         $cnt = (int) $sub->count('distinct subscriber');
 417
 418         $cnt = ($cnt > 0) ? $cnt - 1 : $cnt;
 419
 420         if (!empty($c)) {
 421             $c->set(common_cache_key('profile:subscriber_count:'.$this->id), $cnt);
 422         }
 423
 424         return $cnt;
 425     }
 426
 427     function faveCount()
 428     {
 429         $c = common_memcache();
 430         if (!empty($c)) {
 431             $cnt = $c->get(common_cache_key('profile:fave_count:'.$this->id));
 432             if (is_integer($cnt)) {
 433                 return (int) $cnt;
 434             }
 435         }
 436
 437         $faves = new Fave();
 438         $faves->user_id = $this->id;
 439         $cnt = (int) $faves->count('distinct notice_id');
 440
 441         if (!empty($c)) {
 442             $c->set(common_cache_key('profile:fave_count:'.$this->id), $cnt);
 443         }
 444
 445         return $cnt;
 446     }
 447
 448     function noticeCount()
 449     {
 450         $c = common_memcache();
 451
 452         if (!empty($c)) {
 453             $cnt = $c->get(common_cache_key('profile:notice_count:'.$this->id));
 454             if (is_integer($cnt)) {
 455                 return (int) $cnt;
 456             }
 457         }
 458
 459         $notices = new Notice();
 460         $notices->profile_id = $this->id;
 461         $cnt = (int) $notices->count('distinct id');
 462
 463         if (!empty($c)) {
 464             $c->set(common_cache_key('profile:notice_count:'.$this->id), $cnt);
 465         }
 466
 467         return $cnt;
 468     }
 469
 470     function blowSubscriberCount()
 471     {
 472         $c = common_memcache();
 473         if (!empty($c)) {
 474             $c->delete(common_cache_key('profile:subscriber_count:'.$this->id));
 475         }
 476     }
 477
 478     function blowSubscriptionCount()
 479     {
 480         $c = common_memcache();
 481         if (!empty($c)) {
 482             $c->delete(common_cache_key('profile:subscription_count:'.$this->id));
 483         }
 484     }
 485
 486     function blowFaveCount()
 487     {
 488         $c = common_memcache();
 489         if (!empty($c)) {
 490             $c->delete(common_cache_key('profile:fave_count:'.$this->id));
 491         }
 492     }
 493
 494     function blowNoticeCount()
 495     {
 496         $c = common_memcache();
 497         if (!empty($c)) {
 498             $c->delete(common_cache_key('profile:notice_count:'.$this->id));
 499         }
 500     }
 501
 502     static function maxBio()
 503     {
 504         $biolimit = common_config('profile', 'biolimit');
 505         // null => use global limit (distinct from 0!)
 506         if (is_null($biolimit)) {
 507             $biolimit = common_config('site', 'textlimit');
 508         }
 509         return $biolimit;
 510     }
 511
 512     static function bioTooLong($bio)
 513     {
 514         $biolimit = self::maxBio();
 515         return ($biolimit > 0 && !empty($bio) && (mb_strlen($bio) > $biolimit));
 516     }
 517
 518     function delete()
 519     {
 520         $this->_deleteNotices();
 521         $this->_deleteSubscriptions();
 522         $this->_deleteMessages();
 523         $this->_deleteTags();
 524         $this->_deleteBlocks();
 525
 526         $related = array('Avatar',
 527                          'Reply',
 528                          'Group_member',
 529                          );
 530         Event::handle('ProfileDeleteRelated', array($this, &$related));
 531
 532         foreach ($related as $cls) {
 533             $inst = new $cls();
 534             $inst->profile_id = $this->id;
 535             $inst->delete();
 536         }
 537
 538         parent::delete();
 539     }
 540
 541     function _deleteNotices()
 542     {
 543         $notice = new Notice();
 544         $notice->profile_id = $this->id;
 545
 546         if ($notice->find()) {
 547             while ($notice->fetch()) {
 548                 $other = clone($notice);
 549                 $other->delete();
 550             }
 551         }
 552     }
 553
 554     function _deleteSubscriptions()
 555     {
 556         $sub = new Subscription();
 557         $sub->subscriber = $this->id;
 558         $sub->delete();
 559
 560         $subd = new Subscription();
 561         $subd->subscribed = $this->id;
 562         $subd->delete();
 563     }
 564
 565     function _deleteMessages()
 566     {
 567         $msg = new Message();
 568         $msg->from_profile = $this->id;
 569         $msg->delete();
 570
 571         $msg = new Message();
 572         $msg->to_profile = $this->id;
 573         $msg->delete();
 574     }
 575
 576     function _deleteTags()
 577     {
 578         $tag = new Profile_tag();
 579         $tag->tagged = $this->id;
 580         $tag->delete();
 581     }
 582
 583     function _deleteBlocks()
 584     {
 585         $block = new Profile_block();
 586         $block->blocked = $this->id;
 587         $block->delete();
 588
 589         $block = new Group_block();
 590         $block->blocked = $this->id;
 591         $block->delete();
 592     }
 593
 594     // XXX: identical to Notice::getLocation.
 595
 596     function getLocation()
 597     {
 598         $location = null;
 599
 600         if (!empty($this->location_id) && !empty($this->location_ns)) {
 601             $location = Location::fromId($this->location_id, $this->location_ns);
 602         }
 603
 604         if (is_null($location)) { // no ID, or Location::fromId() failed
 605             if (!empty($this->lat) && !empty($this->lon)) {
 606                 $location = Location::fromLatLon($this->lat, $this->lon);
 607             }
 608         }
 609
 610         if (is_null($location)) { // still haven't found it!
 611             if (!empty($this->location)) {
 612                 $location = Location::fromName($this->location);
 613             }
 614         }
 615
 616         return $location;
 617     }
 618
 619     function hasRole($name)
 620     {
 621         $has_role = false;
 622         if (Event::handle('StartHasRole', array($this, $name, &$has_role))) {
 623             $role = Profile_role::pkeyGet(array('profile_id' => $this->id,
 624                                                 'role' => $name));
 625             $has_role = !empty($role);
 626             Event::handle('EndHasRole', array($this, $name, $has_role));
 627         }
 628         return $has_role;
 629     }
 630
 631     function grantRole($name)
 632     {
 633         $role = new Profile_role();
 634
 635         $role->profile_id = $this->id;
 636         $role->role       = $name;
 637         $role->created    = common_sql_now();
 638
 639         $result = $role->insert();
 640
 641         if (!$result) {
 642             common_log_db_error($role, 'INSERT', __FILE__);
 643             return false;
 644         }
 645
 646         return true;
 647     }
 648
 649     function revokeRole($name)
 650     {
 651         $role = Profile_role::pkeyGet(array('profile_id' => $this->id,
 652                                             'role' => $name));
 653
 654         if (empty($role)) {
 655             throw new Exception('Cannot revoke role "'.$name.'" for user #'.$this->id.'; does not exist.');
 656         }
 657
 658         $result = $role->delete();
 659
 660         if (!$result) {
 661             common_log_db_error($role, 'DELETE', __FILE__);
 662             throw new Exception('Cannot revoke role "'.$name.'" for user #'.$this->id.'; database error.');
 663         }
 664
 665         return true;
 666     }
 667
 668     function isSandboxed()
 669     {
 670         return $this->hasRole(Profile_role::SANDBOXED);
 671     }
 672
 673     function isSilenced()
 674     {
 675         return $this->hasRole(Profile_role::SILENCED);
 676     }
 677
 678     function sandbox()
 679     {
 680         $this->grantRole(Profile_role::SANDBOXED);
 681     }
 682
 683     function unsandbox()
 684     {
 685         $this->revokeRole(Profile_role::SANDBOXED);
 686     }
 687
 688     function silence()
 689     {
 690         $this->grantRole(Profile_role::SILENCED);
 691     }
 692
 693     function unsilence()
 694     {
 695         $this->revokeRole(Profile_role::SILENCED);
 696     }
 697
 698     /**
 699      * Does this user have the right to do X?
 700      *
 701      * With our role-based authorization, this is merely a lookup for whether the user
 702      * has a particular role. The implementation currently uses a switch statement
 703      * to determine if the user has the pre-defined role to exercise the right. Future
 704      * implementations may allow per-site roles, and different mappings of roles to rights.
 705      *
 706      * @param $right string Name of the right, usually a constant in class Right
 707      * @return boolean whether the user has the right in question
 708      */
 709
 710     function hasRight($right)
 711     {
 712         $result = false;
 713         if (Event::handle('UserRightsCheck', array($this, $right, &$result))) {
 714             switch ($right)
 715             {
 716             case Right::DELETEOTHERSNOTICE:
 717             case Right::SANDBOXUSER:
 718             case Right::SILENCEUSER:
 719             case Right::DELETEUSER:
 720                 $result = $this->hasRole(Profile_role::MODERATOR);
 721                 break;
 722             case Right::CONFIGURESITE:
 723                 $result = $this->hasRole(Profile_role::ADMINISTRATOR);
 724                 break;
 725             case Right::NEWNOTICE:
 726             case Right::NEWMESSAGE:
 727             case Right::SUBSCRIBE:
 728                 $result = !$this->isSilenced();
 729                 break;
 730             case Right::PUBLICNOTICE:
 731             case Right::EMAILONREPLY:
 732             case Right::EMAILONSUBSCRIBE:
 733             case Right::EMAILONFAVE:
 734                 $result = !$this->isSandboxed();
 735                 break;
 736             default:
 737                 $result = false;
 738                 break;
 739             }
 740         }
 741         return $result;
 742     }
 743
 744     function hasRepeated($notice_id)
 745     {
 746         // XXX: not really a pkey, but should work
 747
 748         $notice = Memcached_DataObject::pkeyGet('Notice',
 749                                                 array('profile_id' => $this->id,
 750                                                       'repeat_of' => $notice_id));
 751
 752         return !empty($notice);
 753     }
 754 }