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 Managed_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
51 /* the code above is auto generated do not remove the tag below */
54 public static function schemaDef()
58 'id' => array('type' => 'serial', 'not null' => true, 'description' => 'unique identifier'),
59 'tagger' => array('type' => 'int', 'not null' => true, 'description' => 'user making the tag'),
60 'tag' => array('type' => 'varchar', 'length' => 64, 'not null' => true, 'description' => 'people tag'),
61 'description' => array('type' => 'text', 'description' => 'description of the people tag'),
62 'private' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'is this tag private'),
64 'created' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date the tag was added'),
65 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date the tag was modified'),
67 'uri' => array('type' => 'varchar', 'length' => 255, 'description' => 'universal identifier'),
68 'mainpage' => array('type' => 'varchar', 'length' => 255, 'description' => 'page to link to'),
69 'tagged_count' => array('type' => 'int', 'default' => 0, 'description' => 'number of people tagged with this tag by this user'),
70 'subscriber_count' => array('type' => 'int', 'default' => 0, 'description' => 'number of subscribers to this tag'),
72 'primary key' => array('tagger', 'tag'),
73 'unique keys' => array(
74 'profile_list_id_key' => array('id')
76 'foreign keys' => array(
77 'profile_list_tagger_fkey' => array('profile', array('tagger' => 'id')),
80 'profile_list_modified_idx' => array('modified'),
81 'profile_list_tag_idx' => array('tag'),
82 'profile_list_tagger_tag_idx' => array('tagger', 'tag'),
83 'profile_list_tagged_count_idx' => array('tagged_count'),
84 'profile_list_subscriber_count_idx' => array('subscriber_count'),
90 * get the tagger of this profile_list object
92 * @return Profile the tagger
97 return Profile::getKV('id', $this->tagger);
101 * return a string to identify this
102 * profile_list in the user interface etc.
107 function getBestName()
113 * return a uri string for this profile_list
121 if (Event::handle('StartProfiletagGetUri', array($this, &$uri))) {
122 if (!empty($this->uri)) {
125 $uri = common_local_url('profiletagbyid',
126 array('id' => $this->id, 'tagger_id' => $this->tagger));
129 Event::handle('EndProfiletagGetUri', array($this, &$uri));
134 * return a url to the homepage of this item
136 * @return String home url
142 if (Event::handle('StartUserPeopletagHomeUrl', array($this, &$url))) {
143 // normally stored in mainpage, but older ones may be null
144 if (!empty($this->mainpage)) {
145 $url = $this->mainpage;
147 $url = common_local_url('showprofiletag',
148 array('tagger' => $this->getTagger()->nickname,
149 'tag' => $this->tag));
152 Event::handle('EndUserPeopletagHomeUrl', array($this, &$url));
157 * return an immutable url for this object
159 * @return String permalink
165 if (Event::handle('StartProfiletagPermalink', array($this, &$url))) {
166 $url = common_local_url('profiletagbyid',
167 array('id' => $this->id));
169 Event::handle('EndProfiletagPermalink', array($this, &$url));
174 * Query notices by users associated with this tag,
175 * but first check the cache before hitting the DB.
177 * @param integer $offset offset
178 * @param integer $limit maximum no of results
179 * @param integer $since_id=null since this id
180 * @param integer $max_id=null maximum id in result
182 * @return Notice the query
185 function getNotices($offset, $limit, $since_id=null, $max_id=null)
187 $stream = new PeopletagNoticeStream($this);
189 return $stream->getNotices($offset, $limit, $since_id, $max_id);
193 * Get subscribers (local and remote) to this people tag
194 * Order by reverse chronology
196 * @param integer $offset offset
197 * @param integer $limit maximum no of results
198 * @param integer $since_id=null since unix timestamp
199 * @param integer $upto=null maximum unix timestamp when subscription was made
201 * @return Profile results
204 function getSubscribers($offset=0, $limit=null, $since=0, $upto=0)
206 $subs = new Profile();
209 array('id', 'profile_tag_subscription:profile_id')
211 $subs->whereAdd('profile_tag_subscription.profile_tag_id = ' . $this->id);
213 $subs->selectAdd('unix_timestamp(profile_tag_subscription.' .
214 'created) as "cursor"');
217 $subs->whereAdd('cursor > ' . $since);
221 $subs->whereAdd('cursor <= ' . $upto);
224 if ($limit != null) {
225 $subs->limit($offset, $limit);
228 $subs->orderBy('profile_tag_subscription.created DESC');
235 * Get all and only local subscribers to this people tag
236 * used for distributing notices to user inboxes.
238 * @return array ids of users
241 function getUserSubscribers()
246 if(common_config('db','quote_identifiers'))
247 $user_table = '"user"';
248 else $user_table = 'user';
252 'FROM '. $user_table .' JOIN profile_tag_subscription '.
253 'ON '. $user_table .'.id = profile_tag_subscription.profile_id ' .
254 'WHERE profile_tag_subscription.profile_tag_id = %d ';
256 $user->query(sprintf($qry, $this->id));
260 while ($user->fetch()) {
270 * Check to see if a given profile has
271 * subscribed to this people tag's timeline
273 * @param mixed $id User or Profile object or integer id
275 * @return boolean subscription status
278 function hasSubscriber($id)
280 if (!is_numeric($id)) {
284 $sub = Profile_tag_subscription::pkeyGet(array('profile_tag_id' => $this->id,
285 'profile_id' => $id));
290 * Get profiles tagged with this people tag,
291 * include modified timestamp as a "cursor" field
292 * order by descending order of modified time
294 * @param integer $offset offset
295 * @param integer $limit maximum no of results
296 * @param integer $since_id=null since unix timestamp
297 * @param integer $upto=null maximum unix timestamp when subscription was made
299 * @return Profile results
302 function getTagged($offset=0, $limit=null, $since=0, $upto=0)
304 $tagged = new Profile();
305 $tagged->joinAdd(array('id', 'profile_tag:tagged'));
308 $tagged->selectAdd('unix_timestamp(profile_tag.modified) as "cursor"');
309 $tagged->whereAdd('profile_tag.tagger = '.$this->tagger);
310 $tagged->whereAdd("profile_tag.tag = '{$this->tag}'");
313 $tagged->whereAdd('cursor > ' . $since);
317 $tagged->whereAdd('cursor <= ' . $upto);
320 if ($limit != null) {
321 $tagged->limit($offset, $limit);
324 $tagged->orderBy('profile_tag.modified DESC');
331 * Gracefully delete one or many people tags
332 * along with their members and subscriptions data
334 * @return boolean success
339 // force delete one item at a time.
340 if (empty($this->id)) {
342 while ($this->fetch()) {
347 Profile_tag::cleanup($this);
348 Profile_tag_subscription::cleanup($this);
350 self::blow('profile:lists:%d', $this->tagger);
352 return parent::delete();
356 * Update a people tag gracefully
357 * also change "tag" fields in profile_tag table
359 * @param Profile_list $orig Object's original form
361 * @return boolean success
364 function update($orig=null)
368 if (!is_object($orig) && !$orig instanceof Profile_list) {
369 parent::update($orig);
372 // if original tag was different
373 // check to see if the new tag already exists
374 // if not, rename the tag correctly
375 if($orig->tag != $this->tag || $orig->tagger != $this->tagger) {
376 $existing = Profile_list::getByTaggerAndTag($this->tagger, $this->tag);
377 if(!empty($existing)) {
378 // TRANS: Server exception.
379 throw new ServerException(_('The tag you are trying to rename ' .
380 'to already exists.'));
383 // XXX: allow OStatus plugin to send out profile tag
384 $result = Profile_tag::moveTag($orig, $this);
386 parent::update($orig);
391 * return an xml string representing this people tag
392 * as the author of an atom feed
394 * @return string atom author element
397 function asAtomAuthor()
399 $xs = new XMLStringer(true);
401 $tagger = $this->getTagger();
402 $xs->elementStart('author');
403 $xs->element('name', null, '@' . $tagger->nickname . '/' . $this->tag);
404 $xs->element('uri', null, $this->permalink());
405 $xs->elementEnd('author');
407 return $xs->getString();
411 * return an xml string to represent this people tag
412 * as a noun in an activitystreams feed.
414 * @param string $element the xml tag
416 * @return string activitystreams noun
419 function asActivityNoun($element)
421 $noun = ActivityObject::fromPeopletag($this);
422 return $noun->asString('activity:' . $element);
426 * get the cached number of profiles tagged with this
427 * people tag, re-count if the argument is true.
429 * @param boolean $recount whether to ignore cache
431 * @return integer count
434 function taggedCount($recount=false)
436 $keypart = sprintf('profile_list:tagged_count:%d:%s',
440 $count = self::cacheGet($keypart);
442 if ($count === false) {
443 $tags = new Profile_tag();
445 $tags->tag = $this->tag;
446 $tags->tagger = $this->tagger;
448 $count = $tags->count('distinct tagged');
450 self::cacheSet($keypart, $count);
457 * get the cached number of profiles subscribed to this
458 * people tag, re-count if the argument is true.
460 * @param boolean $recount whether to ignore cache
462 * @return integer count
465 function subscriberCount($recount=false)
467 $keypart = sprintf('profile_list:subscriber_count:%d',
470 $count = self::cacheGet($keypart);
472 if ($count === false) {
474 $sub = new Profile_tag_subscription();
475 $sub->profile_tag_id = $this->id;
476 $count = (int) $sub->count('distinct profile_id');
478 self::cacheSet($keypart, $count);
485 * get the cached number of profiles subscribed to this
486 * people tag, re-count if the argument is true.
488 * @param boolean $recount whether to ignore cache
490 * @return integer count
493 function blowNoticeStreamCache($all=false)
495 self::blow('profile_list:notice_ids:%d', $this->id);
497 self::blow('profile_list:notice_ids:%d;last', $this->id);
502 * get the Profile_list object by the
503 * given tagger and with given tag
505 * @param integer $tagger the id of the creator profile
506 * @param integer $tag the tag
508 * @return integer count
511 static function getByTaggerAndTag($tagger, $tag)
513 $ptag = Profile_list::pkeyGet(array('tagger' => $tagger, 'tag' => $tag));
518 * create a profile_list record for a tag, tagger pair
519 * if it doesn't exist, return it.
521 * @param integer $tagger the tagger
522 * @param string $tag the tag
523 * @param string $description description
524 * @param boolean $private protected or not
526 * @return Profile_list the people tag object
529 static function ensureTag($tagger, $tag, $description=null, $private=false)
531 $ptag = Profile_list::getByTaggerAndTag($tagger, $tag);
533 if(empty($ptag->id)) {
537 'description' => $description,
538 'private' => $private
541 $new_tag = Profile_list::saveNew($args);
549 * get the maximum number of characters
550 * that can be used in the description of
553 * determined by $config['peopletag']['desclimit']
554 * if not set, falls back to $config['site']['textlimit']
556 * @return integer maximum number of characters
559 static function maxDescription()
561 $desclimit = common_config('peopletag', 'desclimit');
562 // null => use global limit (distinct from 0!)
563 if (is_null($desclimit)) {
564 $desclimit = common_config('site', 'textlimit');
570 * check if the length of given text exceeds
573 * @param string $desc the description
575 * @return boolean is the descripition too long?
578 static function descriptionTooLong($desc)
580 $desclimit = self::maxDescription();
581 return ($desclimit > 0 && !empty($desc) && (mb_strlen($desc) > $desclimit));
585 * save a new people tag, this should be always used
586 * since it makes uri, homeurl, created and modified
587 * timestamps and performs checks.
589 * @param array $fields an array with fields and their values
591 * @return mixed Profile_list on success, false on fail
593 static function saveNew(array $fields) {
596 $ptag = new Profile_list();
598 $ptag->query('BEGIN');
600 if (empty($tagger)) {
601 // TRANS: Server exception saving new tag without having a tagger specified.
602 throw new Exception(_('No tagger specified.'));
606 // TRANS: Server exception saving new tag without having a tag specified.
607 throw new Exception(_('No tag specified.'));
610 if (empty($mainpage)) {
619 if (empty($mainpage)) {
623 if (empty($description)) {
627 if (empty($private)) {
631 $ptag->tagger = $tagger;
633 $ptag->description = $description;
634 $ptag->private = $private;
636 $ptag->mainpage = $mainpage;
637 $ptag->created = common_sql_now();
638 $ptag->modified = common_sql_now();
640 $result = $ptag->insert();
643 common_log_db_error($ptag, 'INSERT', __FILE__);
644 // TRANS: Server exception saving new tag.
645 throw new ServerException(_('Could not create profile tag.'));
648 if (!isset($uri) || empty($uri)) {
649 $orig = clone($ptag);
650 $ptag->uri = common_local_url('profiletagbyid', array('id' => $ptag->id, 'tagger_id' => $ptag->tagger));
651 $result = $ptag->update($orig);
653 common_log_db_error($ptag, 'UPDATE', __FILE__);
654 // TRANS: Server exception saving new tag.
655 throw new ServerException(_('Could not set profile tag URI.'));
659 if (!isset($mainpage) || empty($mainpage)) {
660 $orig = clone($ptag);
661 $user = User::getKV('id', $ptag->tagger);
663 $ptag->mainpage = common_local_url('showprofiletag', array('tag' => $ptag->tag, 'tagger' => $user->nickname));
665 $ptag->mainpage = $uri; // assume this is a remote peopletag and the uri works
668 $result = $ptag->update($orig);
670 common_log_db_error($ptag, 'UPDATE', __FILE__);
671 // TRANS: Server exception saving new tag.
672 throw new ServerException(_('Could not set profile tag mainpage.'));
679 * get all items at given cursor position for api
681 * @param callback $fn a function that takes the following arguments in order:
682 * $offset, $limit, $since_id, $max_id
683 * and returns a Profile_list object after making the DB query
684 * @param array $args arguments required for $fn
685 * @param integer $cursor the cursor
686 * @param integer $count max. number of results
689 * - if cursor is 0, return empty list
690 * - if cursor is -1, get first 21 items, next_cursor = 20th prev_cursor = 0
691 * - if cursor is +ve get 22 consecutive items before starting at cursor
692 * - return items[1..20] if items[0] == cursor else return items[0..21]
693 * - prev_cursor = items[1]
694 * - next_cursor = id of the last item being returned
696 * - if cursor is -ve get 22 consecutive items after cursor starting at cursor
697 * - return items[1..20]
699 * @returns array (array (mixed items), int next_cursor, int previous_cursor)
702 // XXX: This should be in Memcached_DataObject... eventually.
704 static function getAtCursor($fn, array $args, $cursor, $count=20)
714 // if cursor is +ve fetch $count+2 items before cursor starting at cursor
716 $fn_args = array_merge($args, array(0, $count+2, 0, $max_id));
717 $list = call_user_func_array($fn, $fn_args);
718 while($list->fetch()) {
719 $items[] = clone($list);
722 if ((isset($items[0]->cursor) && $items[0]->cursor == $cursor) ||
723 $items[0]->id == $cursor) {
725 $prev_cursor = isset($items[0]->cursor) ?
726 -$items[0]->cursor : -$items[0]->id;
728 if (count($items) > $count+1) {
731 // this means the cursor item has been deleted, check to see if there are more
732 $fn_args = array_merge($args, array(0, 1, $cursor));
733 $more = call_user_func($fn, $fn_args);
734 if (!$more->fetch() || empty($more)) {
738 $prev_cursor = isset($items[0]->cursor) ?
739 -$items[0]->cursor : -$items[0]->id;
743 if (count($items)==$count+1) {
744 // this means there is a next page.
745 $next = array_pop($items);
746 $next_cursor = isset($next->cursor) ?
747 $items[$count-1]->cursor : $items[$count-1]->id;
750 } else if($cursor < -1) {
751 // if cursor is -ve fetch $count+2 items created after -$cursor-1
752 $cursor = abs($cursor);
753 $since_id = $cursor-1;
755 $fn_args = array_merge($args, array(0, $count+2, $since_id));
756 $list = call_user_func_array($fn, $fn_args);
757 while($list->fetch()) {
758 $items[] = clone($list);
761 $end = count($items)-1;
762 if ((isset($items[$end]->cursor) && $items[$end]->cursor == $cursor) ||
763 $items[$end]->id == $cursor) {
765 $next_cursor = isset($items[$end-1]->cursor) ?
766 $items[$end-1]->cursor : $items[$end-1]->id;
768 $next_cursor = isset($items[$end]->cursor) ?
769 $items[$end]->cursor : $items[$end]->id;
770 if ($end > $count) array_pop($items); // excess item.
772 // check if there are more items for next page
773 $fn_args = array_merge($args, array(0, 1, 0, $cursor));
774 $more = call_user_func_array($fn, $fn_args);
775 if (!$more->fetch() || empty($more)) {
780 if (count($items) == $count+1) {
781 // this means there is a previous page.
782 $prev = array_shift($items);
783 $prev_cursor = isset($prev->cursor) ?
784 -$items[0]->cursor : -$items[0]->id;
786 } else if($cursor == -1) {
787 $fn_args = array_merge($args, array(0, $count+1));
788 $list = call_user_func_array($fn, $fn_args);
790 while($list->fetch()) {
791 $items[] = clone($list);
794 if (count($items)==$count+1) {
795 $next = array_pop($items);
796 if(isset($next->cursor)) {
797 $next_cursor = $items[$count-1]->cursor;
799 $next_cursor = $items[$count-1]->id;
804 return array($items, $next_cursor, $prev_cursor);
808 * save a collection of people tags into the cache
810 * @param string $ckey cache key
811 * @param Profile_list &$tag the results to store
812 * @param integer $offset offset for slicing results
813 * @param integer $limit maximum number of results
815 * @return boolean success
818 static function setCache($ckey, &$tag, $offset=0, $limit=null) {
819 $cache = Cache::instance();
825 while ($tag->fetch()) {
826 $str .= $tag->tagger . ':' . $tag->tag . ';';
827 $tags[] = clone($tag);
829 $str = substr($str, 0, -1);
830 if ($offset>=0 && !is_null($limit)) {
831 $tags = array_slice($tags, $offset, $limit);
834 $tag = new ArrayWrapper($tags);
836 return self::cacheSet($ckey, $str);
840 * get people tags from the cache
842 * @param string $ckey cache key
843 * @param integer $offset offset for slicing
844 * @param integer $limit limit
846 * @return Profile_list results
849 static function getCached($ckey, $offset=0, $limit=null) {
851 $keys_str = self::cacheGet($ckey);
852 if ($keys_str === false) {
856 $pairs = explode(';', $keys_str);
858 foreach ($pairs as $pair) {
859 $keys[] = explode(':', $pair);
862 if ($offset>=0 && !is_null($limit)) {
863 $keys = array_slice($keys, $offset, $limit);
865 return self::getByKeys($keys);
869 * get Profile_list objects from the database
870 * given their (tag, tagger) key pairs.
872 * @param array $keys array of array(tagger, tag)
874 * @return Profile_list results
877 static function getByKeys(array $keys) {
878 $cache = Cache::instance();
880 if (!empty($cache)) {
883 foreach ($keys as $key) {
884 $t = Profile_list::getByTaggerAndTag($key[0], $key[1]);
889 return new ArrayWrapper($tags);
891 $tag = new Profile_list();
893 //if no IDs requested, just return the tag object
898 foreach ($keys as $key) {
899 $pairs[] = '(' . $key[0] . ', "' . $key[1] . '")';
902 $tag->whereAdd('(tagger, tag) in (' . implode(', ', $pairs) . ')');
908 while ($tag->fetch()) {
909 $temp[$tag->tagger.'-'.$tag->tag] = clone($tag);
914 foreach ($keys as $key) {
915 $id = $key[0].'-'.$key[1];
916 if (array_key_exists($id, $temp)) {
917 $wrapped[] = $temp[$id];
921 return new ArrayWrapper($wrapped);
927 $result = parent::insert();
929 self::blow('profile:lists:%d', $this->tagger);