3 * StatusNet - the distributed open-source microblogging tool
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU Affero General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU Affero General Public License for more details.
15 * You should have received a copy of the GNU Affero General Public License
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
20 * @author Shashi Gowda <connect2shashi@gmail.com>
21 * @license GNU Affero General Public License http://www.gnu.org/licenses/
24 if (!defined('STATUSNET') && !defined('LACONICA')) {
29 * Table Definition for profile_list
31 require_once INSTALLDIR.'/classes/Memcached_DataObject.php';
33 class Profile_list extends Memcached_DataObject
36 /* the code below is auto generated do not remove the above tag */
38 public $__table = 'profile_list'; // table name
39 public $id; // int(4) primary_key not_null
40 public $tagger; // int(4)
41 public $tag; // varchar(64)
42 public $description; // text
43 public $private; // tinyint(1)
44 public $created; // datetime not_null default_0000-00-00%2000%3A00%3A00
45 public $modified; // timestamp not_null default_CURRENT_TIMESTAMP
46 public $uri; // varchar(255) unique_key
47 public $mainpage; // varchar(255)
48 public $tagged_count; // smallint
49 public $subscriber_count; // smallint
52 function staticGet($k,$v=NULL) { return Memcached_DataObject::staticGet('Profile_list',$k,$v); }
54 /* the code above is auto generated do not remove the tag below */
58 * return a profile_list record, given its tag and tagger.
60 * @param array $kv ideally array('tag' => $tag, 'tagger' => $tagger)
62 * @return Profile_list a Profile_list object with the given tag and tagger.
67 return Memcached_DataObject::pkeyGet('Profile_list', $kv);
71 * get the tagger of this profile_list object
73 * @return Profile the tagger
78 return Profile::staticGet('id', $this->tagger);
82 * return a string to identify this
83 * profile_list in the user interface etc.
88 function getBestName()
94 * return a uri string for this profile_list
102 if (Event::handle('StartProfiletagGetUri', array($this, &$uri))) {
103 if (!empty($this->uri)) {
106 $uri = common_local_url('profiletagbyid',
107 array('id' => $this->id, 'tagger_id' => $this->tagger));
110 Event::handle('EndProfiletagGetUri', array($this, &$uri));
115 * return a url to the homepage of this item
117 * @return String home url
123 if (Event::handle('StartUserPeopletagHomeUrl', array($this, &$url))) {
124 // normally stored in mainpage, but older ones may be null
125 if (!empty($this->mainpage)) {
126 $url = $this->mainpage;
128 $url = common_local_url('showprofiletag',
129 array('tagger' => $this->getTagger()->nickname,
130 'tag' => $this->tag));
133 Event::handle('EndUserPeopletagHomeUrl', array($this, &$url));
138 * return an immutable url for this object
140 * @return String permalink
146 if (Event::handle('StartProfiletagPermalink', array($this, &$url))) {
147 $url = common_local_url('profiletagbyid',
148 array('id' => $this->id));
150 Event::handle('EndProfiletagPermalink', array($this, &$url));
155 * Query notices by users associated with this tag,
156 * but first check the cache before hitting the DB.
158 * @param integer $offset offset
159 * @param integer $limit maximum no of results
160 * @param integer $since_id=null since this id
161 * @param integer $max_id=null maximum id in result
163 * @return Notice the query
166 function getNotices($offset, $limit, $since_id=null, $max_id=null)
168 $stream = new PeopletagNoticeStream($this);
170 return $stream->getNotices($offset, $limit, $since_id, $max_id);
174 * Get subscribers (local and remote) to this people tag
175 * Order by reverse chronology
177 * @param integer $offset offset
178 * @param integer $limit maximum no of results
179 * @param integer $since_id=null since unix timestamp
180 * @param integer $upto=null maximum unix timestamp when subscription was made
182 * @return Profile results
185 function getSubscribers($offset=0, $limit=null, $since=0, $upto=0)
187 $subs = new Profile();
188 $sub = new Profile_tag_subscription();
189 $sub->profile_tag_id = $this->id;
191 $subs->joinAdd($sub);
192 $subs->selectAdd('unix_timestamp(profile_tag_subscription.' .
193 'created) as "cursor"');
196 $subs->whereAdd('cursor > ' . $since);
200 $subs->whereAdd('cursor <= ' . $upto);
203 if ($limit != null) {
204 $subs->limit($offset, $limit);
207 $subs->orderBy('profile_tag_subscription.created DESC');
214 * Get all and only local subscribers to this people tag
215 * used for distributing notices to user inboxes.
217 * @return array ids of users
220 function getUserSubscribers()
225 if(common_config('db','quote_identifiers'))
226 $user_table = '"user"';
227 else $user_table = 'user';
231 'FROM '. $user_table .' JOIN profile_tag_subscription '.
232 'ON '. $user_table .'.id = profile_tag_subscription.profile_id ' .
233 'WHERE profile_tag_subscription.profile_tag_id = %d ';
235 $user->query(sprintf($qry, $this->id));
239 while ($user->fetch()) {
249 * Check to see if a given profile has
250 * subscribed to this people tag's timeline
252 * @param mixed $id User or Profile object or integer id
254 * @return boolean subscription status
257 function hasSubscriber($id)
259 if (!is_numeric($id)) {
263 $sub = Profile_tag_subscription::pkeyGet(array('profile_tag_id' => $this->id,
264 'profile_id' => $id));
269 * Get profiles tagged with this people tag,
270 * include modified timestamp as a "cursor" field
271 * order by descending order of modified time
273 * @param integer $offset offset
274 * @param integer $limit maximum no of results
275 * @param integer $since_id=null since unix timestamp
276 * @param integer $upto=null maximum unix timestamp when subscription was made
278 * @return Profile results
281 function getTagged($offset=0, $limit=null, $since=0, $upto=0)
283 $tagged = new Profile();
284 $tagged->joinAdd(array('id', 'profile_tag:tagged'));
287 $tagged->selectAdd('unix_timestamp(profile_tag.modified) as "cursor"');
288 $tagged->whereAdd('profile_tag.tagger = '.$this->tagger);
289 $tagged->whereAdd("profile_tag.tag = '{$this->tag}'");
292 $tagged->whereAdd('cursor > ' . $since);
296 $tagged->whereAdd('cursor <= ' . $upto);
299 if ($limit != null) {
300 $tagged->limit($offset, $limit);
303 $tagged->orderBy('profile_tag.modified DESC');
310 * Gracefully delete one or many people tags
311 * along with their members and subscriptions data
313 * @return boolean success
318 // force delete one item at a time.
319 if (empty($this->id)) {
321 while ($this->fetch()) {
326 Profile_tag::cleanup($this);
327 Profile_tag_subscription::cleanup($this);
329 self::blow('profile:lists:%d', $this->tagger);
331 return parent::delete();
335 * Update a people tag gracefully
336 * also change "tag" fields in profile_tag table
338 * @param Profile_list $orig Object's original form
340 * @return boolean success
343 function update($orig=null)
347 if (!is_object($orig) && !$orig instanceof Profile_list) {
348 parent::update($orig);
351 // if original tag was different
352 // check to see if the new tag already exists
353 // if not, rename the tag correctly
354 if($orig->tag != $this->tag || $orig->tagger != $this->tagger) {
355 $existing = Profile_list::getByTaggerAndTag($this->tagger, $this->tag);
356 if(!empty($existing)) {
357 // TRANS: Server exception.
358 throw new ServerException(_('The tag you are trying to rename ' .
359 'to already exists.'));
362 // XXX: allow OStatus plugin to send out profile tag
363 $result = Profile_tag::moveTag($orig, $this);
365 parent::update($orig);
370 * return an xml string representing this people tag
371 * as the author of an atom feed
373 * @return string atom author element
376 function asAtomAuthor()
378 $xs = new XMLStringer(true);
380 $tagger = $this->getTagger();
381 $xs->elementStart('author');
382 $xs->element('name', null, '@' . $tagger->nickname . '/' . $this->tag);
383 $xs->element('uri', null, $this->permalink());
384 $xs->elementEnd('author');
386 return $xs->getString();
390 * return an xml string to represent this people tag
391 * as the subject of an activitystreams feed.
393 * @return string activitystreams subject
396 function asActivitySubject()
398 return $this->asActivityNoun('subject');
402 * return an xml string to represent this people tag
403 * as a noun in an activitystreams feed.
405 * @param string $element the xml tag
407 * @return string activitystreams noun
410 function asActivityNoun($element)
412 $noun = ActivityObject::fromPeopletag($this);
413 return $noun->asString('activity:' . $element);
417 * get the cached number of profiles tagged with this
418 * people tag, re-count if the argument is true.
420 * @param boolean $recount whether to ignore cache
422 * @return integer count
425 function taggedCount($recount=false)
427 $keypart = sprintf('profile_list:tagged_count:%d:%s',
431 $count = self::cacheGet($keypart);
433 if ($count === false) {
434 $tags = new Profile_tag();
436 $tags->tag = $this->tag;
437 $tags->tagger = $this->tagger;
439 $count = $tags->count('distinct tagged');
441 self::cacheSet($keypart, $count);
448 * get the cached number of profiles subscribed to this
449 * people tag, re-count if the argument is true.
451 * @param boolean $recount whether to ignore cache
453 * @return integer count
456 function subscriberCount($recount=false)
458 $keypart = sprintf('profile_list:subscriber_count:%d',
461 $count = self::cacheGet($keypart);
463 if ($count === false) {
465 $sub = new Profile_tag_subscription();
466 $sub->profile_tag_id = $this->id;
467 $count = (int) $sub->count('distinct profile_id');
469 self::cacheSet($keypart, $count);
476 * get the cached number of profiles subscribed to this
477 * people tag, re-count if the argument is true.
479 * @param boolean $recount whether to ignore cache
481 * @return integer count
484 function blowNoticeStreamCache($all=false)
486 self::blow('profile_list:notice_ids:%d', $this->id);
488 self::blow('profile_list:notice_ids:%d;last', $this->id);
493 * get the Profile_list object by the
494 * given tagger and with given tag
496 * @param integer $tagger the id of the creator profile
497 * @param integer $tag the tag
499 * @return integer count
502 static function getByTaggerAndTag($tagger, $tag)
504 $ptag = Profile_list::pkeyGet(array('tagger' => $tagger, 'tag' => $tag));
509 * create a profile_list record for a tag, tagger pair
510 * if it doesn't exist, return it.
512 * @param integer $tagger the tagger
513 * @param string $tag the tag
514 * @param string $description description
515 * @param boolean $private protected or not
517 * @return Profile_list the people tag object
520 static function ensureTag($tagger, $tag, $description=null, $private=false)
522 $ptag = Profile_list::getByTaggerAndTag($tagger, $tag);
524 if(empty($ptag->id)) {
528 'description' => $description,
529 'private' => $private
532 $new_tag = Profile_list::saveNew($args);
540 * get the maximum number of characters
541 * that can be used in the description of
544 * determined by $config['peopletag']['desclimit']
545 * if not set, falls back to $config['site']['textlimit']
547 * @return integer maximum number of characters
550 static function maxDescription()
552 $desclimit = common_config('peopletag', 'desclimit');
553 // null => use global limit (distinct from 0!)
554 if (is_null($desclimit)) {
555 $desclimit = common_config('site', 'textlimit');
561 * check if the length of given text exceeds
564 * @param string $desc the description
566 * @return boolean is the descripition too long?
569 static function descriptionTooLong($desc)
571 $desclimit = self::maxDescription();
572 return ($desclimit > 0 && !empty($desc) && (mb_strlen($desc) > $desclimit));
576 * save a new people tag, this should be always used
577 * since it makes uri, homeurl, created and modified
578 * timestamps and performs checks.
580 * @param array $fields an array with fields and their values
582 * @return mixed Profile_list on success, false on fail
584 static function saveNew($fields) {
587 $ptag = new Profile_list();
589 $ptag->query('BEGIN');
591 if (empty($tagger)) {
592 // TRANS: Server exception saving new tag without having a tagger specified.
593 throw new Exception(_('No tagger specified.'));
597 // TRANS: Server exception saving new tag without having a tag specified.
598 throw new Exception(_('No tag specified.'));
601 if (empty($mainpage)) {
610 if (empty($mainpage)) {
614 if (empty($description)) {
618 if (empty($private)) {
622 $ptag->tagger = $tagger;
624 $ptag->description = $description;
625 $ptag->private = $private;
627 $ptag->mainpage = $mainpage;
628 $ptag->created = common_sql_now();
629 $ptag->modified = common_sql_now();
631 $result = $ptag->insert();
634 common_log_db_error($ptag, 'INSERT', __FILE__);
635 // TRANS: Server exception saving new tag.
636 throw new ServerException(_('Could not create profile tag.'));
639 if (!isset($uri) || empty($uri)) {
640 $orig = clone($ptag);
641 $ptag->uri = common_local_url('profiletagbyid', array('id' => $ptag->id, 'tagger_id' => $ptag->tagger));
642 $result = $ptag->update($orig);
644 common_log_db_error($ptag, 'UPDATE', __FILE__);
645 // TRANS: Server exception saving new tag.
646 throw new ServerException(_('Could not set profile tag URI.'));
650 if (!isset($mainpage) || empty($mainpage)) {
651 $orig = clone($ptag);
652 $user = User::staticGet('id', $ptag->tagger);
654 $ptag->mainpage = common_local_url('showprofiletag', array('tag' => $ptag->tag, 'tagger' => $user->nickname));
656 $ptag->mainpage = $uri; // assume this is a remote peopletag and the uri works
659 $result = $ptag->update($orig);
661 common_log_db_error($ptag, 'UPDATE', __FILE__);
662 // TRANS: Server exception saving new tag.
663 throw new ServerException(_('Could not set profile tag mainpage.'));
670 * get all items at given cursor position for api
672 * @param callback $fn a function that takes the following arguments in order:
673 * $offset, $limit, $since_id, $max_id
674 * and returns a Profile_list object after making the DB query
675 * @param array $args arguments required for $fn
676 * @param integer $cursor the cursor
677 * @param integer $count max. number of results
680 * - if cursor is 0, return empty list
681 * - if cursor is -1, get first 21 items, next_cursor = 20th prev_cursor = 0
682 * - if cursor is +ve get 22 consecutive items before starting at cursor
683 * - return items[1..20] if items[0] == cursor else return items[0..21]
684 * - prev_cursor = items[1]
685 * - next_cursor = id of the last item being returned
687 * - if cursor is -ve get 22 consecutive items after cursor starting at cursor
688 * - return items[1..20]
690 * @returns array (array (mixed items), int next_cursor, int previous_cursor)
693 // XXX: This should be in Memcached_DataObject... eventually.
695 static function getAtCursor($fn, $args, $cursor, $count=20)
705 // if cursor is +ve fetch $count+2 items before cursor starting at cursor
707 $fn_args = array_merge($args, array(0, $count+2, 0, $max_id));
708 $list = call_user_func_array($fn, $fn_args);
709 while($list->fetch()) {
710 $items[] = clone($list);
713 if ((isset($items[0]->cursor) && $items[0]->cursor == $cursor) ||
714 $items[0]->id == $cursor) {
716 $prev_cursor = isset($items[0]->cursor) ?
717 -$items[0]->cursor : -$items[0]->id;
719 if (count($items) > $count+1) {
722 // this means the cursor item has been deleted, check to see if there are more
723 $fn_args = array_merge($args, array(0, 1, $cursor));
724 $more = call_user_func($fn, $fn_args);
725 if (!$more->fetch() || empty($more)) {
729 $prev_cursor = isset($items[0]->cursor) ?
730 -$items[0]->cursor : -$items[0]->id;
734 if (count($items)==$count+1) {
735 // this means there is a next page.
736 $next = array_pop($items);
737 $next_cursor = isset($next->cursor) ?
738 $items[$count-1]->cursor : $items[$count-1]->id;
741 } else if($cursor < -1) {
742 // if cursor is -ve fetch $count+2 items created after -$cursor-1
743 $cursor = abs($cursor);
744 $since_id = $cursor-1;
746 $fn_args = array_merge($args, array(0, $count+2, $since_id));
747 $list = call_user_func_array($fn, $fn_args);
748 while($list->fetch()) {
749 $items[] = clone($list);
752 $end = count($items)-1;
753 if ((isset($items[$end]->cursor) && $items[$end]->cursor == $cursor) ||
754 $items[$end]->id == $cursor) {
756 $next_cursor = isset($items[$end-1]->cursor) ?
757 $items[$end-1]->cursor : $items[$end-1]->id;
759 $next_cursor = isset($items[$end]->cursor) ?
760 $items[$end]->cursor : $items[$end]->id;
761 if ($end > $count) array_pop($items); // excess item.
763 // check if there are more items for next page
764 $fn_args = array_merge($args, array(0, 1, 0, $cursor));
765 $more = call_user_func_array($fn, $fn_args);
766 if (!$more->fetch() || empty($more)) {
771 if (count($items) == $count+1) {
772 // this means there is a previous page.
773 $prev = array_shift($items);
774 $prev_cursor = isset($prev->cursor) ?
775 -$items[0]->cursor : -$items[0]->id;
777 } else if($cursor == -1) {
778 $fn_args = array_merge($args, array(0, $count+1));
779 $list = call_user_func_array($fn, $fn_args);
781 while($list->fetch()) {
782 $items[] = clone($list);
785 if (count($items)==$count+1) {
786 $next = array_pop($items);
787 if(isset($next->cursor)) {
788 $next_cursor = $items[$count-1]->cursor;
790 $next_cursor = $items[$count-1]->id;
795 return array($items, $next_cursor, $prev_cursor);
799 * save a collection of people tags into the cache
801 * @param string $ckey cache key
802 * @param Profile_list &$tag the results to store
803 * @param integer $offset offset for slicing results
804 * @param integer $limit maximum number of results
806 * @return boolean success
809 static function setCache($ckey, &$tag, $offset=0, $limit=null) {
810 $cache = Cache::instance();
816 while ($tag->fetch()) {
817 $str .= $tag->tagger . ':' . $tag->tag . ';';
818 $tags[] = clone($tag);
820 $str = substr($str, 0, -1);
821 if ($offset>=0 && !is_null($limit)) {
822 $tags = array_slice($tags, $offset, $limit);
825 $tag = new ArrayWrapper($tags);
827 return self::cacheSet($ckey, $str);
831 * get people tags from the cache
833 * @param string $ckey cache key
834 * @param integer $offset offset for slicing
835 * @param integer $limit limit
837 * @return Profile_list results
840 static function getCached($ckey, $offset=0, $limit=null) {
842 $keys_str = self::cacheGet($ckey);
843 if ($keys_str === false) {
847 $pairs = explode(';', $keys_str);
849 foreach ($pairs as $pair) {
850 $keys[] = explode(':', $pair);
853 if ($offset>=0 && !is_null($limit)) {
854 $keys = array_slice($keys, $offset, $limit);
856 return self::getByKeys($keys);
860 * get Profile_list objects from the database
861 * given their (tag, tagger) key pairs.
863 * @param array $keys array of array(tagger, tag)
865 * @return Profile_list results
868 static function getByKeys($keys) {
869 $cache = Cache::instance();
871 if (!empty($cache)) {
874 foreach ($keys as $key) {
875 $t = Profile_list::getByTaggerAndTag($key[0], $key[1]);
880 return new ArrayWrapper($tags);
882 $tag = new Profile_list();
884 //if no IDs requested, just return the tag object
889 foreach ($keys as $key) {
890 $pairs[] = '(' . $key[0] . ', "' . $key[1] . '")';
893 $tag->whereAdd('(tagger, tag) in (' . implode(', ', $pairs) . ')');
899 while ($tag->fetch()) {
900 $temp[$tag->tagger.'-'.$tag->tag] = clone($tag);
905 foreach ($keys as $key) {
906 $id = $key[0].'-'.$key[1];
907 if (array_key_exists($id, $temp)) {
908 $wrapped[] = $temp[$id];
912 return new ArrayWrapper($wrapped);
918 $result = parent::insert();
920 self::blow('profile:lists:%d', $this->tagger);