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