]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - classes/Profile.php
Non-dynamic user and group fetching in Profile
[quix0rs-gnu-social.git] / classes / Profile.php
1 <?php
2 /*
3  * StatusNet - the distributed open-source microblogging tool
4  * Copyright (C) 2008-2011, 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 Managed_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     public static function schemaDef()
48     {
49         $def = array(
50             'description' => 'local and remote users have profiles',
51             'fields' => array(
52                 'id' => array('type' => 'serial', 'not null' => true, 'description' => 'unique identifier'),
53                 'nickname' => array('type' => 'varchar', 'length' => 64, 'not null' => true, 'description' => 'nickname or username', 'collate' => 'utf8_general_ci'),
54                 'fullname' => array('type' => 'varchar', 'length' => 255, 'description' => 'display name', 'collate' => 'utf8_general_ci'),
55                 'profileurl' => array('type' => 'varchar', 'length' => 255, 'description' => 'URL, cached so we dont regenerate'),
56                 'homepage' => array('type' => 'varchar', 'length' => 255, 'description' => 'identifying URL', 'collate' => 'utf8_general_ci'),
57                 'bio' => array('type' => 'text', 'description' => 'descriptive biography', 'collate' => 'utf8_general_ci'),
58                 'location' => array('type' => 'varchar', 'length' => 255, 'description' => 'physical location', 'collate' => 'utf8_general_ci'),
59                 'lat' => array('type' => 'numeric', 'precision' => 10, 'scale' => 7, 'description' => 'latitude'),
60                 'lon' => array('type' => 'numeric', 'precision' => 10, 'scale' => 7, 'description' => 'longitude'),
61                 'location_id' => array('type' => 'int', 'description' => 'location id if possible'),
62                 'location_ns' => array('type' => 'int', 'description' => 'namespace for location'),
63
64                 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'),
65                 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
66             ),
67             'primary key' => array('id'),
68             'indexes' => array(
69                 'profile_nickname_idx' => array('nickname'),
70             )
71         );
72
73         // Add a fulltext index
74
75         if (common_config('search', 'type') == 'fulltext') {
76             $def['fulltext indexes'] = array('nickname' => array('nickname', 'fullname', 'location', 'bio', 'homepage'));
77         }
78
79         return $def;
80     }
81         
82     /* the code above is auto generated do not remove the tag below */
83     ###END_AUTOCODE
84
85     public static function getByEmail($email)
86     {
87         // in the future, profiles should have emails stored...
88         $user = User::getKV('email', $email);
89         if (!($user instanceof User)) {
90             throw new NoSuchUserException(array('email'=>$email));
91         }
92         return $user->getProfile();
93     } 
94
95     protected $_user = array();
96
97     public function getUser()
98     {
99         if (!isset($this->_user[$this->id])) {
100             $this->_setUser(User::getKV('id', $this->id));
101         }
102         return $this->_user[$this->id];
103     }
104
105     public function _setUser(User $user=null)
106     {
107         if (!$user instanceof User) {
108             throw new NoSuchUserException(array('id'=>$this->id));
109         }
110         $this->_user[$this->id] = $user;
111     }
112
113     protected $_group = array();
114
115     public function getGroup()
116     {
117         if (!isset($this->_group[$this->id])) {
118             $this->_setGroup(User_group::getKV('profile_id', $this->id));
119         }
120         return $this->_group[$this->id];
121     }
122
123     public function _setGroup(User_group $group=null)
124     {
125         if (!$group instanceof User_group) {
126             throw new NoSuchGroupException(array('profile_id'=>$this->id));
127         }
128         $this->_group[$this->id] = $group;
129     }
130
131     public function isGroup()
132     {
133         try {
134             $this->getGroup();
135             return true;
136         } catch (NoSuchGroupException $e) {
137             return false;
138         }
139     }
140
141     public function isLocal()
142     {
143         try {
144             $this->getUser();
145         } catch (NoSuchUserException $e) {
146             return false;
147         }
148         return true;
149     }
150
151     public function getAvatar($width, $height=null)
152     {
153         return Avatar::byProfile($this, $width, $height);
154     }
155
156     public function setOriginal($filename)
157     {
158         $imagefile = new ImageFile($this->id, Avatar::path($filename));
159
160         $avatar = new Avatar();
161         $avatar->profile_id = $this->id;
162         $avatar->width = $imagefile->width;
163         $avatar->height = $imagefile->height;
164         $avatar->mediatype = image_type_to_mime_type($imagefile->type);
165         $avatar->filename = $filename;
166         $avatar->original = true;
167         $avatar->url = Avatar::url($filename);
168         $avatar->created = common_sql_now();
169
170         // XXX: start a transaction here
171         if (!Avatar::deleteFromProfile($this, true) || !$avatar->insert()) {
172             // If we can't delete the old avatars, let's abort right here.
173             @unlink(Avatar::path($filename));
174             return null;
175         }
176
177         return $avatar;
178     }
179
180     /**
181      * Gets either the full name (if filled) or the nickname.
182      *
183      * @return string
184      */
185     function getBestName()
186     {
187         return ($this->fullname) ? $this->fullname : $this->nickname;
188     }
189
190     /**
191      * Takes the currently scoped profile into account to give a name 
192      * to list in notice streams. Preferences may differ between profiles.
193      */
194     function getStreamName()
195     {
196         $user = common_current_user();
197         if ($user instanceof User && $user->streamNicknames()) {
198             return $this->nickname;
199         }
200
201         return $this->getBestName();
202     }
203
204     /**
205      * Gets the full name (if filled) with nickname as a parenthetical, or the nickname alone
206      * if no fullname is provided.
207      *
208      * @return string
209      */
210     function getFancyName()
211     {
212         if ($this->fullname) {
213             // TRANS: Full name of a profile or group (%1$s) followed by nickname (%2$s) in parentheses.
214             return sprintf(_m('FANCYNAME','%1$s (%2$s)'), $this->fullname, $this->nickname);
215         } else {
216             return $this->nickname;
217         }
218     }
219
220     /**
221      * Get the most recent notice posted by this user, if any.
222      *
223      * @return mixed Notice or null
224      */
225     function getCurrentNotice()
226     {
227         $notice = $this->getNotices(0, 1);
228
229         if ($notice->fetch()) {
230             if ($notice instanceof ArrayWrapper) {
231                 // hack for things trying to work with single notices
232                 return $notice->_items[0];
233             }
234             return $notice;
235         }
236         
237         return null;
238     }
239
240     function getTaggedNotices($tag, $offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $max_id=0)
241     {
242         $stream = new TaggedProfileNoticeStream($this, $tag);
243
244         return $stream->getNotices($offset, $limit, $since_id, $max_id);
245     }
246
247     function getNotices($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $max_id=0, Profile $scoped=null)
248     {
249         $stream = new ProfileNoticeStream($this, $scoped);
250
251         return $stream->getNotices($offset, $limit, $since_id, $max_id);
252     }
253
254     function isMember(User_group $group)
255     {
256         $groups = $this->getGroups(0, null);
257         while ($groups instanceof User_group && $groups->fetch()) {
258             if ($groups->id == $group->id) {
259                 return true;
260             }
261         }
262         return false;
263     }
264
265     function isAdmin(User_group $group)
266     {
267         $gm = Group_member::pkeyGet(array('profile_id' => $this->id,
268                                           'group_id' => $group->id));
269         return (!empty($gm) && $gm->is_admin);
270     }
271
272     function isPendingMember($group)
273     {
274         $request = Group_join_queue::pkeyGet(array('profile_id' => $this->id,
275                                                    'group_id' => $group->id));
276         return !empty($request);
277     }
278
279     function getGroups($offset=0, $limit=PROFILES_PER_PAGE)
280     {
281         $ids = array();
282
283         $keypart = sprintf('profile:groups:%d', $this->id);
284
285         $idstring = self::cacheGet($keypart);
286
287         if ($idstring !== false) {
288             $ids = explode(',', $idstring);
289         } else {
290             $gm = new Group_member();
291
292             $gm->profile_id = $this->id;
293
294             if ($gm->find()) {
295                 while ($gm->fetch()) {
296                     $ids[] = $gm->group_id;
297                 }
298             }
299
300             self::cacheSet($keypart, implode(',', $ids));
301         }
302
303         if (!is_null($offset) && !is_null($limit)) {
304             $ids = array_slice($ids, $offset, $limit);
305         }
306
307         try {
308             return User_group::listFind('id', $ids);
309         } catch (NoResultException $e) {
310             return null;    // throw exception when we handle it everywhere
311         }
312     }
313
314     function getGroupCount() {
315         $groups = $this->getGroups(0, null);
316         return $groups instanceof User_group
317                 ? $groups->N
318                 : 0;
319     }
320
321     function isTagged($peopletag)
322     {
323         $tag = Profile_tag::pkeyGet(array('tagger' => $peopletag->tagger,
324                                           'tagged' => $this->id,
325                                           'tag'    => $peopletag->tag));
326         return !empty($tag);
327     }
328
329     function canTag($tagged)
330     {
331         if (empty($tagged)) {
332             return false;
333         }
334
335         if ($tagged->id == $this->id) {
336             return true;
337         }
338
339         $all = common_config('peopletag', 'allow_tagging', 'all');
340         $local = common_config('peopletag', 'allow_tagging', 'local');
341         $remote = common_config('peopletag', 'allow_tagging', 'remote');
342         $subs = common_config('peopletag', 'allow_tagging', 'subs');
343
344         if ($all) {
345             return true;
346         }
347
348         $tagged_user = $tagged->getUser();
349         if (!empty($tagged_user)) {
350             if ($local) {
351                 return true;
352             }
353         } else if ($subs) {
354             return (Subscription::exists($this, $tagged) ||
355                     Subscription::exists($tagged, $this));
356         } else if ($remote) {
357             return true;
358         }
359         return false;
360     }
361
362     function getLists($auth_user, $offset=0, $limit=null, $since_id=0, $max_id=0)
363     {
364         $ids = array();
365
366         $keypart = sprintf('profile:lists:%d', $this->id);
367
368         $idstr = self::cacheGet($keypart);
369
370         if ($idstr !== false) {
371             $ids = explode(',', $idstr);
372         } else {
373             $list = new Profile_list();
374             $list->selectAdd();
375             $list->selectAdd('id');
376             $list->tagger = $this->id;
377             $list->selectAdd('id as "cursor"');
378
379             if ($since_id>0) {
380                $list->whereAdd('id > '.$since_id);
381             }
382
383             if ($max_id>0) {
384                 $list->whereAdd('id <= '.$max_id);
385             }
386
387             if($offset>=0 && !is_null($limit)) {
388                 $list->limit($offset, $limit);
389             }
390
391             $list->orderBy('id DESC');
392
393             if ($list->find()) {
394                 while ($list->fetch()) {
395                     $ids[] = $list->id;
396                 }
397             }
398
399             self::cacheSet($keypart, implode(',', $ids));
400         }
401
402         $showPrivate = (($auth_user instanceof User ||
403                             $auth_user instanceof Profile) &&
404                         $auth_user->id === $this->id);
405
406         $lists = array();
407
408         foreach ($ids as $id) {
409             $list = Profile_list::getKV('id', $id);
410             if (!empty($list) &&
411                 ($showPrivate || !$list->private)) {
412
413                 if (!isset($list->cursor)) {
414                     $list->cursor = $list->id;
415                 }
416
417                 $lists[] = $list;
418             }
419         }
420
421         return new ArrayWrapper($lists);
422     }
423
424     /**
425      * Get tags that other people put on this profile, in reverse-chron order
426      *
427      * @param (Profile|User) $auth_user  Authorized user (used for privacy)
428      * @param int            $offset     Offset from latest
429      * @param int            $limit      Max number to get
430      * @param datetime       $since_id   max date
431      * @param datetime       $max_id     min date
432      *
433      * @return Profile_list resulting lists
434      */
435
436     function getOtherTags($auth_user=null, $offset=0, $limit=null, $since_id=0, $max_id=0)
437     {
438         $list = new Profile_list();
439
440         $qry = sprintf('select profile_list.*, unix_timestamp(profile_tag.modified) as "cursor" ' .
441                        'from profile_tag join profile_list '.
442                        'on (profile_tag.tagger = profile_list.tagger ' .
443                        '    and profile_tag.tag = profile_list.tag) ' .
444                        'where profile_tag.tagged = %d ',
445                        $this->id);
446
447
448         if ($auth_user instanceof User || $auth_user instanceof Profile) {
449             $qry .= sprintf('AND ( ( profile_list.private = false ) ' .
450                             'OR ( profile_list.tagger = %d AND ' .
451                             'profile_list.private = true ) )',
452                             $auth_user->id);
453         } else {
454             $qry .= 'AND profile_list.private = 0 ';
455         }
456
457         if ($since_id > 0) {
458             $qry .= sprintf('AND (cursor > %d) ', $since_id);
459         }
460
461         if ($max_id > 0) {
462             $qry .= sprintf('AND (cursor < %d) ', $max_id);
463         }
464
465         $qry .= 'ORDER BY profile_tag.modified DESC ';
466
467         if ($offset >= 0 && !is_null($limit)) {
468             $qry .= sprintf('LIMIT %d OFFSET %d ', $limit, $offset);
469         }
470
471         $list->query($qry);
472         return $list;
473     }
474
475     function getPrivateTags($offset=0, $limit=null, $since_id=0, $max_id=0)
476     {
477         $tags = new Profile_list();
478         $tags->private = true;
479         $tags->tagger = $this->id;
480
481         if ($since_id>0) {
482            $tags->whereAdd('id > '.$since_id);
483         }
484
485         if ($max_id>0) {
486             $tags->whereAdd('id <= '.$max_id);
487         }
488
489         if($offset>=0 && !is_null($limit)) {
490             $tags->limit($offset, $limit);
491         }
492
493         $tags->orderBy('id DESC');
494         $tags->find();
495
496         return $tags;
497     }
498
499     function hasLocalTags()
500     {
501         $tags = new Profile_tag();
502
503         $tags->joinAdd(array('tagger', 'user:id'));
504         $tags->whereAdd('tagged  = '.$this->id);
505         $tags->whereAdd('tagger != '.$this->id);
506
507         $tags->limit(0, 1);
508         $tags->fetch();
509
510         return ($tags->N == 0) ? false : true;
511     }
512
513     function getTagSubscriptions($offset=0, $limit=null, $since_id=0, $max_id=0)
514     {
515         $lists = new Profile_list();
516         $subs = new Profile_tag_subscription();
517
518         $lists->joinAdd(array('id', 'profile_tag_subscription:profile_tag_id'));
519
520         #@fixme: postgres (round(date_part('epoch', my_date)))
521         $lists->selectAdd('unix_timestamp(profile_tag_subscription.created) as "cursor"');
522
523         $lists->whereAdd('profile_tag_subscription.profile_id = '.$this->id);
524
525         if ($since_id>0) {
526            $lists->whereAdd('cursor > '.$since_id);
527         }
528
529         if ($max_id>0) {
530             $lists->whereAdd('cursor <= '.$max_id);
531         }
532
533         if($offset>=0 && !is_null($limit)) {
534             $lists->limit($offset, $limit);
535         }
536
537         $lists->orderBy('"cursor" DESC');
538         $lists->find();
539
540         return $lists;
541     }
542
543     /**
544      * Request to join the given group.
545      * May throw exceptions on failure.
546      *
547      * @param User_group $group
548      * @return mixed: Group_member on success, Group_join_queue if pending approval, null on some cancels?
549      */
550     function joinGroup(User_group $group)
551     {
552         $join = null;
553         if ($group->join_policy == User_group::JOIN_POLICY_MODERATE) {
554             $join = Group_join_queue::saveNew($this, $group);
555         } else {
556             if (Event::handle('StartJoinGroup', array($group, $this))) {
557                 $join = Group_member::join($group->id, $this->id);
558                 self::blow('profile:groups:%d', $this->id);
559                 self::blow('group:member_ids:%d', $group->id);
560                 self::blow('group:member_count:%d', $group->id);
561                 Event::handle('EndJoinGroup', array($group, $this));
562             }
563         }
564         if ($join) {
565             // Send any applicable notifications...
566             $join->notify();
567         }
568         return $join;
569     }
570
571     /**
572      * Leave a group that this profile is a member of.
573      *
574      * @param User_group $group
575      */
576     function leaveGroup(User_group $group)
577     {
578         if (Event::handle('StartLeaveGroup', array($group, $this))) {
579             Group_member::leave($group->id, $this->id);
580             self::blow('profile:groups:%d', $this->id);
581             self::blow('group:member_ids:%d', $group->id);
582             self::blow('group:member_count:%d', $group->id);
583             Event::handle('EndLeaveGroup', array($group, $this));
584         }
585     }
586
587     function avatarUrl($size=AVATAR_PROFILE_SIZE)
588     {
589         return Avatar::urlByProfile($this, $size);
590     }
591
592     function getSubscribed($offset=0, $limit=null)
593     {
594         $subs = Subscription::getSubscribedIDs($this->id, $offset, $limit);
595         try {
596             $profiles = Profile::listFind('id', $subs);
597         } catch (NoResultException $e) {
598             return $e->obj;
599         }
600         return $profiles;
601     }
602
603     function getSubscribers($offset=0, $limit=null)
604     {
605         $subs = Subscription::getSubscriberIDs($this->id, $offset, $limit);
606         try {
607             $profiles = Profile::listFind('id', $subs);
608         } catch (NoResultException $e) {
609             return $e->obj;
610         }
611         return $profiles;
612     }
613
614     function getTaggedSubscribers($tag, $offset=0, $limit=null)
615     {
616         $qry =
617           'SELECT profile.* ' .
618           'FROM profile JOIN subscription ' .
619           'ON profile.id = subscription.subscriber ' .
620           'JOIN profile_tag ON (profile_tag.tagged = subscription.subscriber ' .
621           'AND profile_tag.tagger = subscription.subscribed) ' .
622           'WHERE subscription.subscribed = %d ' .
623           "AND profile_tag.tag = '%s' " .
624           'AND subscription.subscribed != subscription.subscriber ' .
625           'ORDER BY subscription.created DESC ';
626
627         if ($offset) {
628             $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
629         }
630
631         $profile = new Profile();
632
633         $cnt = $profile->query(sprintf($qry, $this->id, $profile->escape($tag)));
634
635         return $profile;
636     }
637
638     function getTaggedSubscriptions($tag, $offset=0, $limit=null)
639     {
640         $qry =
641           'SELECT profile.* ' .
642           'FROM profile JOIN subscription ' .
643           'ON profile.id = subscription.subscribed ' .
644           'JOIN profile_tag on (profile_tag.tagged = subscription.subscribed ' .
645           'AND profile_tag.tagger = subscription.subscriber) ' .
646           'WHERE subscription.subscriber = %d ' .
647           "AND profile_tag.tag = '%s' " .
648           'AND subscription.subscribed != subscription.subscriber ' .
649           'ORDER BY subscription.created DESC ';
650
651         $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
652
653         $profile = new Profile();
654
655         $profile->query(sprintf($qry, $this->id, $profile->escape($tag)));
656
657         return $profile;
658     }
659
660     /**
661      * Get pending subscribers, who have not yet been approved.
662      *
663      * @param int $offset
664      * @param int $limit
665      * @return Profile
666      */
667     function getRequests($offset=0, $limit=null)
668     {
669         $qry =
670           'SELECT profile.* ' .
671           'FROM profile JOIN subscription_queue '.
672           'ON profile.id = subscription_queue.subscriber ' .
673           'WHERE subscription_queue.subscribed = %d ' .
674           'ORDER BY subscription_queue.created DESC ';
675
676         if ($limit != null) {
677             if (common_config('db','type') == 'pgsql') {
678                 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
679             } else {
680                 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
681             }
682         }
683
684         $members = new Profile();
685
686         $members->query(sprintf($qry, $this->id));
687         return $members;
688     }
689
690     function subscriptionCount()
691     {
692         $c = Cache::instance();
693
694         if (!empty($c)) {
695             $cnt = $c->get(Cache::key('profile:subscription_count:'.$this->id));
696             if (is_integer($cnt)) {
697                 return (int) $cnt;
698             }
699         }
700
701         $sub = new Subscription();
702         $sub->subscriber = $this->id;
703
704         $cnt = (int) $sub->count('distinct subscribed');
705
706         $cnt = ($cnt > 0) ? $cnt - 1 : $cnt;
707
708         if (!empty($c)) {
709             $c->set(Cache::key('profile:subscription_count:'.$this->id), $cnt);
710         }
711
712         return $cnt;
713     }
714
715     function subscriberCount()
716     {
717         $c = Cache::instance();
718         if (!empty($c)) {
719             $cnt = $c->get(Cache::key('profile:subscriber_count:'.$this->id));
720             if (is_integer($cnt)) {
721                 return (int) $cnt;
722             }
723         }
724
725         $sub = new Subscription();
726         $sub->subscribed = $this->id;
727         $sub->whereAdd('subscriber != subscribed');
728         $cnt = (int) $sub->count('distinct subscriber');
729
730         if (!empty($c)) {
731             $c->set(Cache::key('profile:subscriber_count:'.$this->id), $cnt);
732         }
733
734         return $cnt;
735     }
736
737     /**
738      * Is this profile subscribed to another profile?
739      *
740      * @param Profile $other
741      * @return boolean
742      */
743     function isSubscribed(Profile $other)
744     {
745         return Subscription::exists($this, $other);
746     }
747
748     /**
749      * Check if a pending subscription request is outstanding for this...
750      *
751      * @param Profile $other
752      * @return boolean
753      */
754     function hasPendingSubscription(Profile $other)
755     {
756         return Subscription_queue::exists($this, $other);
757     }
758
759     /**
760      * Are these two profiles subscribed to each other?
761      *
762      * @param Profile $other
763      * @return boolean
764      */
765     function mutuallySubscribed(Profile $other)
766     {
767         return $this->isSubscribed($other) &&
768           $other->isSubscribed($this);
769     }
770
771     function hasFave($notice)
772     {
773         $fave = Fave::pkeyGet(array('user_id' => $this->id,
774                                     'notice_id' => $notice->id));
775         return ((is_null($fave)) ? false : true);
776     }
777
778     function faveCount()
779     {
780         $c = Cache::instance();
781         if (!empty($c)) {
782             $cnt = $c->get(Cache::key('profile:fave_count:'.$this->id));
783             if (is_integer($cnt)) {
784                 return (int) $cnt;
785             }
786         }
787
788         $faves = new Fave();
789         $faves->user_id = $this->id;
790         $cnt = (int) $faves->count('notice_id');
791
792         if (!empty($c)) {
793             $c->set(Cache::key('profile:fave_count:'.$this->id), $cnt);
794         }
795
796         return $cnt;
797     }
798
799     function favoriteNotices($own=false, $offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $max_id=0)
800     {
801         return Fave::stream($this->id, $offset, $limit, $own, $since_id, $max_id);
802     }
803
804     function noticeCount()
805     {
806         $c = Cache::instance();
807
808         if (!empty($c)) {
809             $cnt = $c->get(Cache::key('profile:notice_count:'.$this->id));
810             if (is_integer($cnt)) {
811                 return (int) $cnt;
812             }
813         }
814
815         $notices = new Notice();
816         $notices->profile_id = $this->id;
817         $cnt = (int) $notices->count('distinct id');
818
819         if (!empty($c)) {
820             $c->set(Cache::key('profile:notice_count:'.$this->id), $cnt);
821         }
822
823         return $cnt;
824     }
825
826     function blowFavesCache()
827     {
828         $cache = Cache::instance();
829         if ($cache) {
830             // Faves don't happen chronologically, so we need to blow
831             // ;last cache, too
832             $cache->delete(Cache::key('fave:ids_by_user:'.$this->id));
833             $cache->delete(Cache::key('fave:ids_by_user:'.$this->id.';last'));
834             $cache->delete(Cache::key('fave:ids_by_user_own:'.$this->id));
835             $cache->delete(Cache::key('fave:ids_by_user_own:'.$this->id.';last'));
836         }
837         $this->blowFaveCount();
838     }
839
840     function blowSubscriberCount()
841     {
842         $c = Cache::instance();
843         if (!empty($c)) {
844             $c->delete(Cache::key('profile:subscriber_count:'.$this->id));
845         }
846     }
847
848     function blowSubscriptionCount()
849     {
850         $c = Cache::instance();
851         if (!empty($c)) {
852             $c->delete(Cache::key('profile:subscription_count:'.$this->id));
853         }
854     }
855
856     function blowFaveCount()
857     {
858         $c = Cache::instance();
859         if (!empty($c)) {
860             $c->delete(Cache::key('profile:fave_count:'.$this->id));
861         }
862     }
863
864     function blowNoticeCount()
865     {
866         $c = Cache::instance();
867         if (!empty($c)) {
868             $c->delete(Cache::key('profile:notice_count:'.$this->id));
869         }
870     }
871
872     static function maxBio()
873     {
874         $biolimit = common_config('profile', 'biolimit');
875         // null => use global limit (distinct from 0!)
876         if (is_null($biolimit)) {
877             $biolimit = common_config('site', 'textlimit');
878         }
879         return $biolimit;
880     }
881
882     static function bioTooLong($bio)
883     {
884         $biolimit = self::maxBio();
885         return ($biolimit > 0 && !empty($bio) && (mb_strlen($bio) > $biolimit));
886     }
887
888     function update($dataObject=false)
889     {
890         if (is_object($dataObject) && $this->nickname != $dataObject->nickname) {
891             try {
892                 $local = $this->getUser();
893                 common_debug("Updating User ({$this->id}) nickname from {$dataObject->nickname} to {$this->nickname}");
894                 $origuser = clone($local);
895                 $local->nickname = $this->nickname;
896                 $result = $local->updateKeys($origuser);
897                 if ($result === false) {
898                     common_log_db_error($local, 'UPDATE', __FILE__);
899                     // TRANS: Server error thrown when user profile settings could not be updated.
900                     throw new ServerException(_('Could not update user nickname.'));
901                 }
902
903                 // Clear the site owner, in case nickname changed
904                 if ($local->hasRole(Profile_role::OWNER)) {
905                     User::blow('user:site_owner');
906                 }
907             } catch (NoSuchUserException $e) {
908                 // Nevermind...
909             }
910         }
911
912         return parent::update($dataObject);
913     }
914
915     function delete($useWhere=false)
916     {
917         $this->_deleteNotices();
918         $this->_deleteSubscriptions();
919         $this->_deleteMessages();
920         $this->_deleteTags();
921         $this->_deleteBlocks();
922         $this->_deleteAttentions();
923         Avatar::deleteFromProfile($this, true);
924
925         // Warning: delete() will run on the batch objects,
926         // not on individual objects.
927         $related = array('Reply',
928                          'Group_member',
929                          );
930         Event::handle('ProfileDeleteRelated', array($this, &$related));
931
932         foreach ($related as $cls) {
933             $inst = new $cls();
934             $inst->profile_id = $this->id;
935             $inst->delete();
936         }
937
938         return parent::delete($useWhere);
939     }
940
941     function _deleteNotices()
942     {
943         $notice = new Notice();
944         $notice->profile_id = $this->id;
945
946         if ($notice->find()) {
947             while ($notice->fetch()) {
948                 $other = clone($notice);
949                 $other->delete();
950             }
951         }
952     }
953
954     function _deleteSubscriptions()
955     {
956         $sub = new Subscription();
957         $sub->subscriber = $this->id;
958
959         $sub->find();
960
961         while ($sub->fetch()) {
962             $other = Profile::getKV('id', $sub->subscribed);
963             if (empty($other)) {
964                 continue;
965             }
966             if ($other->id == $this->id) {
967                 continue;
968             }
969             Subscription::cancel($this, $other);
970         }
971
972         $subd = new Subscription();
973         $subd->subscribed = $this->id;
974         $subd->find();
975
976         while ($subd->fetch()) {
977             $other = Profile::getKV('id', $subd->subscriber);
978             if (empty($other)) {
979                 continue;
980             }
981             if ($other->id == $this->id) {
982                 continue;
983             }
984             Subscription::cancel($other, $this);
985         }
986
987         $self = new Subscription();
988
989         $self->subscriber = $this->id;
990         $self->subscribed = $this->id;
991
992         $self->delete();
993     }
994
995     function _deleteMessages()
996     {
997         $msg = new Message();
998         $msg->from_profile = $this->id;
999         $msg->delete();
1000
1001         $msg = new Message();
1002         $msg->to_profile = $this->id;
1003         $msg->delete();
1004     }
1005
1006     function _deleteTags()
1007     {
1008         $tag = new Profile_tag();
1009         $tag->tagged = $this->id;
1010         $tag->delete();
1011     }
1012
1013     function _deleteBlocks()
1014     {
1015         $block = new Profile_block();
1016         $block->blocked = $this->id;
1017         $block->delete();
1018
1019         $block = new Group_block();
1020         $block->blocked = $this->id;
1021         $block->delete();
1022     }
1023
1024     function _deleteAttentions()
1025     {
1026         $att = new Attention();
1027         $att->profile_id = $this->getID();
1028
1029         if ($att->find()) {
1030             while ($att->fetch()) {
1031                 // Can't do delete() on the object directly since it won't remove all of it
1032                 $other = clone($att);
1033                 $other->delete();
1034             }
1035         }
1036     }
1037
1038     // XXX: identical to Notice::getLocation.
1039
1040     public function getLocation()
1041     {
1042         $location = null;
1043
1044         if (!empty($this->location_id) && !empty($this->location_ns)) {
1045             $location = Location::fromId($this->location_id, $this->location_ns);
1046         }
1047
1048         if (is_null($location)) { // no ID, or Location::fromId() failed
1049             if (!empty($this->lat) && !empty($this->lon)) {
1050                 $location = Location::fromLatLon($this->lat, $this->lon);
1051             }
1052         }
1053
1054         if (is_null($location)) { // still haven't found it!
1055             if (!empty($this->location)) {
1056                 $location = Location::fromName($this->location);
1057             }
1058         }
1059
1060         return $location;
1061     }
1062
1063     public function shareLocation()
1064     {
1065         $cfg = common_config('location', 'share');
1066
1067         if ($cfg == 'always') {
1068             return true;
1069         } else if ($cfg == 'never') {
1070             return false;
1071         } else { // user
1072             $share = common_config('location', 'sharedefault');
1073
1074             // Check if user has a personal setting for this
1075             $prefs = User_location_prefs::getKV('user_id', $this->id);
1076
1077             if (!empty($prefs)) {
1078                 $share = $prefs->share_location;
1079                 $prefs->free();
1080             }
1081
1082             return $share;
1083         }
1084     }
1085
1086     function hasRole($name)
1087     {
1088         $has_role = false;
1089         if (Event::handle('StartHasRole', array($this, $name, &$has_role))) {
1090             $role = Profile_role::pkeyGet(array('profile_id' => $this->id,
1091                                                 'role' => $name));
1092             $has_role = !empty($role);
1093             Event::handle('EndHasRole', array($this, $name, $has_role));
1094         }
1095         return $has_role;
1096     }
1097
1098     function grantRole($name)
1099     {
1100         if (Event::handle('StartGrantRole', array($this, $name))) {
1101
1102             $role = new Profile_role();
1103
1104             $role->profile_id = $this->id;
1105             $role->role       = $name;
1106             $role->created    = common_sql_now();
1107
1108             $result = $role->insert();
1109
1110             if (!$result) {
1111                 throw new Exception("Can't save role '$name' for profile '{$this->id}'");
1112             }
1113
1114             if ($name == 'owner') {
1115                 User::blow('user:site_owner');
1116             }
1117
1118             Event::handle('EndGrantRole', array($this, $name));
1119         }
1120
1121         return $result;
1122     }
1123
1124     function revokeRole($name)
1125     {
1126         if (Event::handle('StartRevokeRole', array($this, $name))) {
1127
1128             $role = Profile_role::pkeyGet(array('profile_id' => $this->id,
1129                                                 'role' => $name));
1130
1131             if (empty($role)) {
1132                 // TRANS: Exception thrown when trying to revoke an existing role for a user that does not exist.
1133                 // TRANS: %1$s is the role name, %2$s is the user ID (number).
1134                 throw new Exception(sprintf(_('Cannot revoke role "%1$s" for user #%2$d; does not exist.'),$name, $this->id));
1135             }
1136
1137             $result = $role->delete();
1138
1139             if (!$result) {
1140                 common_log_db_error($role, 'DELETE', __FILE__);
1141                 // TRANS: Exception thrown when trying to revoke a role for a user with a failing database query.
1142                 // TRANS: %1$s is the role name, %2$s is the user ID (number).
1143                 throw new Exception(sprintf(_('Cannot revoke role "%1$s" for user #%2$d; database error.'),$name, $this->id));
1144             }
1145
1146             if ($name == 'owner') {
1147                 User::blow('user:site_owner');
1148             }
1149
1150             Event::handle('EndRevokeRole', array($this, $name));
1151
1152             return true;
1153         }
1154     }
1155
1156     function isSandboxed()
1157     {
1158         return $this->hasRole(Profile_role::SANDBOXED);
1159     }
1160
1161     function isSilenced()
1162     {
1163         return $this->hasRole(Profile_role::SILENCED);
1164     }
1165
1166     function sandbox()
1167     {
1168         $this->grantRole(Profile_role::SANDBOXED);
1169     }
1170
1171     function unsandbox()
1172     {
1173         $this->revokeRole(Profile_role::SANDBOXED);
1174     }
1175
1176     function silence()
1177     {
1178         $this->grantRole(Profile_role::SILENCED);
1179         if (common_config('notice', 'hidespam')) {
1180             $this->flushVisibility();
1181         }
1182     }
1183
1184     function unsilence()
1185     {
1186         $this->revokeRole(Profile_role::SILENCED);
1187         if (common_config('notice', 'hidespam')) {
1188             $this->flushVisibility();
1189         }
1190     }
1191
1192     function flushVisibility()
1193     {
1194         // Get all notices
1195         $stream = new ProfileNoticeStream($this, $this);
1196         $ids = $stream->getNoticeIds(0, CachingNoticeStream::CACHE_WINDOW);
1197         foreach ($ids as $id) {
1198             self::blow('notice:in-scope-for:%d:null', $id);
1199         }
1200     }
1201
1202     /**
1203      * Does this user have the right to do X?
1204      *
1205      * With our role-based authorization, this is merely a lookup for whether the user
1206      * has a particular role. The implementation currently uses a switch statement
1207      * to determine if the user has the pre-defined role to exercise the right. Future
1208      * implementations may allow per-site roles, and different mappings of roles to rights.
1209      *
1210      * @param $right string Name of the right, usually a constant in class Right
1211      * @return boolean whether the user has the right in question
1212      */
1213     public function hasRight($right)
1214     {
1215         $result = false;
1216
1217         if ($this->hasRole(Profile_role::DELETED)) {
1218             return false;
1219         }
1220
1221         if (Event::handle('UserRightsCheck', array($this, $right, &$result))) {
1222             switch ($right)
1223             {
1224             case Right::DELETEOTHERSNOTICE:
1225             case Right::MAKEGROUPADMIN:
1226             case Right::SANDBOXUSER:
1227             case Right::SILENCEUSER:
1228             case Right::DELETEUSER:
1229             case Right::DELETEGROUP:
1230             case Right::TRAINSPAM:
1231             case Right::REVIEWSPAM:
1232                 $result = $this->hasRole(Profile_role::MODERATOR);
1233                 break;
1234             case Right::CONFIGURESITE:
1235                 $result = $this->hasRole(Profile_role::ADMINISTRATOR);
1236                 break;
1237             case Right::GRANTROLE:
1238             case Right::REVOKEROLE:
1239                 $result = $this->hasRole(Profile_role::OWNER);
1240                 break;
1241             case Right::NEWNOTICE:
1242             case Right::NEWMESSAGE:
1243             case Right::SUBSCRIBE:
1244             case Right::CREATEGROUP:
1245                 $result = !$this->isSilenced();
1246                 break;
1247             case Right::PUBLICNOTICE:
1248             case Right::EMAILONREPLY:
1249             case Right::EMAILONSUBSCRIBE:
1250             case Right::EMAILONFAVE:
1251                 $result = !$this->isSandboxed();
1252                 break;
1253             case Right::WEBLOGIN:
1254                 $result = !$this->isSilenced();
1255                 break;
1256             case Right::API:
1257                 $result = !$this->isSilenced();
1258                 break;
1259             case Right::BACKUPACCOUNT:
1260                 $result = common_config('profile', 'backup');
1261                 break;
1262             case Right::RESTOREACCOUNT:
1263                 $result = common_config('profile', 'restore');
1264                 break;
1265             case Right::DELETEACCOUNT:
1266                 $result = common_config('profile', 'delete');
1267                 break;
1268             case Right::MOVEACCOUNT:
1269                 $result = common_config('profile', 'move');
1270                 break;
1271             default:
1272                 $result = false;
1273                 break;
1274             }
1275         }
1276         return $result;
1277     }
1278
1279     // FIXME: Can't put Notice typing here due to ArrayWrapper
1280     public function hasRepeated($notice)
1281     {
1282         // XXX: not really a pkey, but should work
1283
1284         $notice = Notice::pkeyGet(array('profile_id' => $this->id,
1285                                         'repeat_of' => $notice->id));
1286
1287         return !empty($notice);
1288     }
1289
1290     /**
1291      * Returns an XML string fragment with limited profile information
1292      * as an Atom <author> element.
1293      *
1294      * Assumes that Atom has been previously set up as the base namespace.
1295      *
1296      * @param Profile $cur the current authenticated user
1297      *
1298      * @return string
1299      */
1300     function asAtomAuthor($cur = null)
1301     {
1302         $xs = new XMLStringer(true);
1303
1304         $xs->elementStart('author');
1305         $xs->element('name', null, $this->nickname);
1306         $xs->element('uri', null, $this->getUri());
1307         if ($cur != null) {
1308             $attrs = Array();
1309             $attrs['following'] = $cur->isSubscribed($this) ? 'true' : 'false';
1310             $attrs['blocking']  = $cur->hasBlocked($this) ? 'true' : 'false';
1311             $xs->element('statusnet:profile_info', $attrs, null);
1312         }
1313         $xs->elementEnd('author');
1314
1315         return $xs->getString();
1316     }
1317
1318     /**
1319      * Extra profile info for atom entries
1320      *
1321      * Clients use some extra profile info in the atom stream.
1322      * This gives it to them.
1323      *
1324      * @param User $cur Current user
1325      *
1326      * @return array representation of <statusnet:profile_info> element or null
1327      */
1328
1329     function profileInfo($cur)
1330     {
1331         $profileInfoAttr = array('local_id' => $this->id);
1332
1333         if ($cur != null) {
1334             // Whether the current user is a subscribed to this profile
1335             $profileInfoAttr['following'] = $cur->isSubscribed($this) ? 'true' : 'false';
1336             // Whether the current user is has blocked this profile
1337             $profileInfoAttr['blocking']  = $cur->hasBlocked($this) ? 'true' : 'false';
1338         }
1339
1340         return array('statusnet:profile_info', $profileInfoAttr, null);
1341     }
1342
1343     /**
1344      * Returns an XML string fragment with profile information as an
1345      * Activity Streams <activity:actor> element.
1346      *
1347      * Assumes that 'activity' namespace has been previously defined.
1348      *
1349      * @return string
1350      */
1351     function asActivityActor()
1352     {
1353         return $this->asActivityNoun('actor');
1354     }
1355
1356     /**
1357      * Returns an XML string fragment with profile information as an
1358      * Activity Streams noun object with the given element type.
1359      *
1360      * Assumes that 'activity', 'georss', and 'poco' namespace has been
1361      * previously defined.
1362      *
1363      * @param string $element one of 'actor', 'subject', 'object', 'target'
1364      *
1365      * @return string
1366      */
1367     function asActivityNoun($element)
1368     {
1369         $noun = ActivityObject::fromProfile($this);
1370         return $noun->asString('activity:' . $element);
1371     }
1372
1373     /**
1374      * Returns the profile's canonical url, not necessarily a uri/unique id
1375      *
1376      * @return string $profileurl
1377      */
1378     public function getUrl()
1379     {
1380         if (empty($this->profileurl) ||
1381                 !filter_var($this->profileurl, FILTER_VALIDATE_URL)) {
1382             throw new InvalidUrlException($this->profileurl);
1383         }
1384         return $this->profileurl;
1385     }
1386
1387     public function getNickname()
1388     {
1389         return $this->nickname;
1390     }
1391
1392     /**
1393      * Returns the best URI for a profile. Plugins may override.
1394      *
1395      * @return string $uri
1396      */
1397     public function getUri()
1398     {
1399         $uri = null;
1400
1401         // give plugins a chance to set the URI
1402         if (Event::handle('StartGetProfileUri', array($this, &$uri))) {
1403
1404             // check for a local user first
1405             $user = User::getKV('id', $this->id);
1406             if ($user instanceof User) {
1407                 $uri = $user->getUri();
1408             }
1409
1410             Event::handle('EndGetProfileUri', array($this, &$uri));
1411         }
1412
1413         return $uri;
1414     }
1415
1416     /**
1417      * Returns an assumed acct: URI for a profile. Plugins are required.
1418      *
1419      * @return string $uri
1420      */
1421     public function getAcctUri()
1422     {
1423         $acct = null;
1424
1425         if (Event::handle('StartGetProfileAcctUri', array($this, &$acct))) {
1426             Event::handle('EndGetProfileAcctUri', array($this, &$acct));
1427         }
1428
1429         if ($acct === null) {
1430             throw new ProfileNoAcctUriException($this);
1431         }
1432
1433         return $acct;
1434     }
1435
1436     function hasBlocked($other)
1437     {
1438         $block = Profile_block::exists($this, $other);
1439         return !empty($block);
1440     }
1441
1442     function getAtomFeed()
1443     {
1444         $feed = null;
1445
1446         if (Event::handle('StartProfileGetAtomFeed', array($this, &$feed))) {
1447             $user = User::getKV('id', $this->id);
1448             if (!empty($user)) {
1449                 $feed = common_local_url('ApiTimelineUser', array('id' => $user->id,
1450                                                                   'format' => 'atom'));
1451             }
1452             Event::handle('EndProfileGetAtomFeed', array($this, $feed));
1453         }
1454
1455         return $feed;
1456     }
1457
1458     /*
1459      * Get a Profile object by URI. Will call external plugins for help
1460      * using the event StartGetProfileFromURI.
1461      *
1462      * @param string $uri A unique identifier for a resource (profile/group/whatever)
1463      */
1464     static function fromUri($uri)
1465     {
1466         $profile = null;
1467
1468         if (Event::handle('StartGetProfileFromURI', array($uri, &$profile))) {
1469             // Get a local user when plugin lookup (like OStatus) fails
1470             $user = User::getKV('uri', $uri);
1471             if ($user instanceof User) {
1472                 $profile = $user->getProfile();
1473             }
1474             Event::handle('EndGetProfileFromURI', array($uri, $profile));
1475         }
1476
1477         if (!$profile instanceof Profile) {
1478             throw new UnknownUriException($uri);
1479         }
1480
1481         return $profile;
1482     }
1483
1484     function canRead(Notice $notice)
1485     {
1486         if ($notice->scope & Notice::SITE_SCOPE) {
1487             $user = $this->getUser();
1488             if (empty($user)) {
1489                 return false;
1490             }
1491         }
1492
1493         if ($notice->scope & Notice::ADDRESSEE_SCOPE) {
1494             $replies = $notice->getReplies();
1495
1496             if (!in_array($this->id, $replies)) {
1497                 $groups = $notice->getGroups();
1498
1499                 $foundOne = false;
1500
1501                 foreach ($groups as $group) {
1502                     if ($this->isMember($group)) {
1503                         $foundOne = true;
1504                         break;
1505                     }
1506                 }
1507
1508                 if (!$foundOne) {
1509                     return false;
1510                 }
1511             }
1512         }
1513
1514         if ($notice->scope & Notice::FOLLOWER_SCOPE) {
1515             $author = $notice->getProfile();
1516             if (!Subscription::exists($this, $author)) {
1517                 return false;
1518             }
1519         }
1520
1521         return true;
1522     }
1523
1524     static function current()
1525     {
1526         $user = common_current_user();
1527         if (empty($user)) {
1528             $profile = null;
1529         } else {
1530             $profile = $user->getProfile();
1531         }
1532         return $profile;
1533     }
1534
1535     /**
1536      * Magic function called at serialize() time.
1537      *
1538      * We use this to drop a couple process-specific references
1539      * from DB_DataObject which can cause trouble in future
1540      * processes.
1541      *
1542      * @return array of variable names to include in serialization.
1543      */
1544
1545     function __sleep()
1546     {
1547         $vars = parent::__sleep();
1548         $skip = array('_user', '_group');
1549         return array_diff($vars, $skip);
1550     }
1551
1552     public function getProfile()
1553     {
1554         return $this;
1555     }
1556
1557     /**
1558      * This will perform shortenLinks with the connected User object.
1559      *
1560      * Won't work on remote profiles or groups, so expect a
1561      * NoSuchUserException if you don't know it's a local User.
1562      *
1563      * @param string $text      String to shorten
1564      * @param boolean $always   Disrespect minimum length etc.
1565      *
1566      * @return string link-shortened $text
1567      */
1568     public function shortenLinks($text, $always=false)
1569     {
1570         return $this->getUser()->shortenLinks($text, $always);
1571     }
1572 }