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
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 */
57 public static function schemaDef()
61 'id' => array('type' => 'serial', 'not null' => true, 'description' => 'unique identifier'),
62 'tagger' => array('type' => 'int', 'not null' => true, 'description' => 'user making the tag'),
63 'tag' => array('type' => 'varchar', 'length' => 64, 'not null' => true, 'description' => 'people tag'),
64 'description' => array('type' => 'text', 'description' => 'description of the people tag'),
65 'private' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'is this tag private'),
67 'created' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date the tag was added'),
68 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date the tag was modified'),
70 'uri' => array('type' => 'varchar', 'length' => 255, 'description' => 'universal identifier'),
71 'mainpage' => array('type' => 'varchar', 'length' => 255, 'description' => 'page to link to'),
72 'tagged_count' => array('type' => 'int', 'default' => 0, 'description' => 'number of people tagged with this tag by this user'),
73 'subscriber_count' => array('type' => 'int', 'default' => 0, 'description' => 'number of subscribers to this tag'),
75 'primary key' => array('tagger', 'tag'),
76 'unique keys' => array(
77 'profile_list_id_key' => array('id')
79 'foreign keys' => array(
80 'profile_list_tagger_fkey' => array('profile', array('tagger' => 'id')),
83 'profile_list_modified_idx' => array('modified'),
84 'profile_list_tag_idx' => array('tag'),
85 'profile_list_tagger_tag_idx' => array('tagger', 'tag'),
86 'profile_list_tagged_count_idx' => array('tagged_count'),
87 'profile_list_subscriber_count_idx' => array('subscriber_count'),
93 * return a profile_list record, given its tag and tagger.
95 * @param array $kv ideally array('tag' => $tag, 'tagger' => $tagger)
97 * @return Profile_list a Profile_list object with the given tag and tagger.
100 function pkeyGet($kv)
102 return Memcached_DataObject::pkeyGet('Profile_list', $kv);
106 * get the tagger of this profile_list object
108 * @return Profile the tagger
113 return Profile::staticGet('id', $this->tagger);
117 * return a string to identify this
118 * profile_list in the user interface etc.
123 function getBestName()
129 * return a uri string for this profile_list
137 if (Event::handle('StartProfiletagGetUri', array($this, &$uri))) {
138 if (!empty($this->uri)) {
141 $uri = common_local_url('profiletagbyid',
142 array('id' => $this->id, 'tagger_id' => $this->tagger));
145 Event::handle('EndProfiletagGetUri', array($this, &$uri));
150 * return a url to the homepage of this item
152 * @return String home url
158 if (Event::handle('StartUserPeopletagHomeUrl', array($this, &$url))) {
159 // normally stored in mainpage, but older ones may be null
160 if (!empty($this->mainpage)) {
161 $url = $this->mainpage;
163 $url = common_local_url('showprofiletag',
164 array('tagger' => $this->getTagger()->nickname,
165 'tag' => $this->tag));
168 Event::handle('EndUserPeopletagHomeUrl', array($this, &$url));
173 * return an immutable url for this object
175 * @return String permalink
181 if (Event::handle('StartProfiletagPermalink', array($this, &$url))) {
182 $url = common_local_url('profiletagbyid',
183 array('id' => $this->id));
185 Event::handle('EndProfiletagPermalink', array($this, &$url));
190 * Query notices by users associated with this tag,
191 * but first check the cache before hitting the DB.
193 * @param integer $offset offset
194 * @param integer $limit maximum no of results
195 * @param integer $since_id=null since this id
196 * @param integer $max_id=null maximum id in result
198 * @return Notice the query
201 function getNotices($offset, $limit, $since_id=null, $max_id=null)
203 $stream = new PeopletagNoticeStream($this);
205 return $stream->getNotices($offset, $limit, $since_id, $max_id);
209 * Get subscribers (local and remote) to this people tag
210 * Order by reverse chronology
212 * @param integer $offset offset
213 * @param integer $limit maximum no of results
214 * @param integer $since_id=null since unix timestamp
215 * @param integer $upto=null maximum unix timestamp when subscription was made
217 * @return Profile results
220 function getSubscribers($offset=0, $limit=null, $since=0, $upto=0)
222 $subs = new Profile();
224 $subs->joinAdd(array('id', 'profile_tag_subscription:profile_tag_id'));
226 $subs->selectAdd('unix_timestamp(profile_tag_subscription.' .
227 'created) as "cursor"');
230 $subs->whereAdd('cursor > ' . $since);
234 $subs->whereAdd('cursor <= ' . $upto);
237 if ($limit != null) {
238 $subs->limit($offset, $limit);
241 $subs->orderBy('profile_tag_subscription.created DESC');
248 * Get all and only local subscribers to this people tag
249 * used for distributing notices to user inboxes.
251 * @return array ids of users
254 function getUserSubscribers()
259 if(common_config('db','quote_identifiers'))
260 $user_table = '"user"';
261 else $user_table = 'user';
265 'FROM '. $user_table .' JOIN profile_tag_subscription '.
266 'ON '. $user_table .'.id = profile_tag_subscription.profile_id ' .
267 'WHERE profile_tag_subscription.profile_tag_id = %d ';
269 $user->query(sprintf($qry, $this->id));
273 while ($user->fetch()) {
283 * Check to see if a given profile has
284 * subscribed to this people tag's timeline
286 * @param mixed $id User or Profile object or integer id
288 * @return boolean subscription status
291 function hasSubscriber($id)
293 if (!is_numeric($id)) {
297 $sub = Profile_tag_subscription::pkeyGet(array('profile_tag_id' => $this->id,
298 'profile_id' => $id));
303 * Get profiles tagged with this people tag,
304 * include modified timestamp as a "cursor" field
305 * order by descending order of modified time
307 * @param integer $offset offset
308 * @param integer $limit maximum no of results
309 * @param integer $since_id=null since unix timestamp
310 * @param integer $upto=null maximum unix timestamp when subscription was made
312 * @return Profile results
315 function getTagged($offset=0, $limit=null, $since=0, $upto=0)
317 $tagged = new Profile();
318 $tagged->joinAdd(array('id', 'profile_tag:tagged'));
321 $tagged->selectAdd('unix_timestamp(profile_tag.modified) as "cursor"');
322 $tagged->whereAdd('profile_tag.tagger = '.$this->tagger);
323 $tagged->whereAdd("profile_tag.tag = '{$this->tag}'");
326 $tagged->whereAdd('cursor > ' . $since);
330 $tagged->whereAdd('cursor <= ' . $upto);
333 if ($limit != null) {
334 $tagged->limit($offset, $limit);
337 $tagged->orderBy('profile_tag.modified DESC');
344 * Gracefully delete one or many people tags
345 * along with their members and subscriptions data
347 * @return boolean success
352 // force delete one item at a time.
353 if (empty($this->id)) {
355 while ($this->fetch()) {
360 Profile_tag::cleanup($this);
361 Profile_tag_subscription::cleanup($this);
363 self::blow('profile:lists:%d', $this->tagger);
365 return parent::delete();
369 * Update a people tag gracefully
370 * also change "tag" fields in profile_tag table
372 * @param Profile_list $orig Object's original form
374 * @return boolean success
377 function update($orig=null)
381 if (!is_object($orig) && !$orig instanceof Profile_list) {
382 parent::update($orig);
385 // if original tag was different
386 // check to see if the new tag already exists
387 // if not, rename the tag correctly
388 if($orig->tag != $this->tag || $orig->tagger != $this->tagger) {
389 $existing = Profile_list::getByTaggerAndTag($this->tagger, $this->tag);
390 if(!empty($existing)) {
391 // TRANS: Server exception.
392 throw new ServerException(_('The tag you are trying to rename ' .
393 'to already exists.'));
396 // XXX: allow OStatus plugin to send out profile tag
397 $result = Profile_tag::moveTag($orig, $this);
399 parent::update($orig);
404 * return an xml string representing this people tag
405 * as the author of an atom feed
407 * @return string atom author element
410 function asAtomAuthor()
412 $xs = new XMLStringer(true);
414 $tagger = $this->getTagger();
415 $xs->elementStart('author');
416 $xs->element('name', null, '@' . $tagger->nickname . '/' . $this->tag);
417 $xs->element('uri', null, $this->permalink());
418 $xs->elementEnd('author');
420 return $xs->getString();
424 * return an xml string to represent this people tag
425 * as the subject of an activitystreams feed.
427 * @return string activitystreams subject
430 function asActivitySubject()
432 return $this->asActivityNoun('subject');
436 * return an xml string to represent this people tag
437 * as a noun in an activitystreams feed.
439 * @param string $element the xml tag
441 * @return string activitystreams noun
444 function asActivityNoun($element)
446 $noun = ActivityObject::fromPeopletag($this);
447 return $noun->asString('activity:' . $element);
451 * get the cached number of profiles tagged with this
452 * people tag, re-count if the argument is true.
454 * @param boolean $recount whether to ignore cache
456 * @return integer count
459 function taggedCount($recount=false)
461 $keypart = sprintf('profile_list:tagged_count:%d:%s',
465 $count = self::cacheGet($keypart);
467 if ($count === false) {
468 $tags = new Profile_tag();
470 $tags->tag = $this->tag;
471 $tags->tagger = $this->tagger;
473 $count = $tags->count('distinct tagged');
475 self::cacheSet($keypart, $count);
482 * get the cached number of profiles subscribed to this
483 * people tag, re-count if the argument is true.
485 * @param boolean $recount whether to ignore cache
487 * @return integer count
490 function subscriberCount($recount=false)
492 $keypart = sprintf('profile_list:subscriber_count:%d',
495 $count = self::cacheGet($keypart);
497 if ($count === false) {
499 $sub = new Profile_tag_subscription();
500 $sub->profile_tag_id = $this->id;
501 $count = (int) $sub->count('distinct profile_id');
503 self::cacheSet($keypart, $count);
510 * get the cached number of profiles subscribed to this
511 * people tag, re-count if the argument is true.
513 * @param boolean $recount whether to ignore cache
515 * @return integer count
518 function blowNoticeStreamCache($all=false)
520 self::blow('profile_list:notice_ids:%d', $this->id);
522 self::blow('profile_list:notice_ids:%d;last', $this->id);
527 * get the Profile_list object by the
528 * given tagger and with given tag
530 * @param integer $tagger the id of the creator profile
531 * @param integer $tag the tag
533 * @return integer count
536 static function getByTaggerAndTag($tagger, $tag)
538 $ptag = Profile_list::pkeyGet(array('tagger' => $tagger, 'tag' => $tag));
543 * create a profile_list record for a tag, tagger pair
544 * if it doesn't exist, return it.
546 * @param integer $tagger the tagger
547 * @param string $tag the tag
548 * @param string $description description
549 * @param boolean $private protected or not
551 * @return Profile_list the people tag object
554 static function ensureTag($tagger, $tag, $description=null, $private=false)
556 $ptag = Profile_list::getByTaggerAndTag($tagger, $tag);
558 if(empty($ptag->id)) {
562 'description' => $description,
563 'private' => $private
566 $new_tag = Profile_list::saveNew($args);
574 * get the maximum number of characters
575 * that can be used in the description of
578 * determined by $config['peopletag']['desclimit']
579 * if not set, falls back to $config['site']['textlimit']
581 * @return integer maximum number of characters
584 static function maxDescription()
586 $desclimit = common_config('peopletag', 'desclimit');
587 // null => use global limit (distinct from 0!)
588 if (is_null($desclimit)) {
589 $desclimit = common_config('site', 'textlimit');
595 * check if the length of given text exceeds
598 * @param string $desc the description
600 * @return boolean is the descripition too long?
603 static function descriptionTooLong($desc)
605 $desclimit = self::maxDescription();
606 return ($desclimit > 0 && !empty($desc) && (mb_strlen($desc) > $desclimit));
610 * save a new people tag, this should be always used
611 * since it makes uri, homeurl, created and modified
612 * timestamps and performs checks.
614 * @param array $fields an array with fields and their values
616 * @return mixed Profile_list on success, false on fail
618 static function saveNew($fields) {
621 $ptag = new Profile_list();
623 $ptag->query('BEGIN');
625 if (empty($tagger)) {
626 // TRANS: Server exception saving new tag without having a tagger specified.
627 throw new Exception(_('No tagger specified.'));
631 // TRANS: Server exception saving new tag without having a tag specified.
632 throw new Exception(_('No tag specified.'));
635 if (empty($mainpage)) {
644 if (empty($mainpage)) {
648 if (empty($description)) {
652 if (empty($private)) {
656 $ptag->tagger = $tagger;
658 $ptag->description = $description;
659 $ptag->private = $private;
661 $ptag->mainpage = $mainpage;
662 $ptag->created = common_sql_now();
663 $ptag->modified = common_sql_now();
665 $result = $ptag->insert();
668 common_log_db_error($ptag, 'INSERT', __FILE__);
669 // TRANS: Server exception saving new tag.
670 throw new ServerException(_('Could not create profile tag.'));
673 if (!isset($uri) || empty($uri)) {
674 $orig = clone($ptag);
675 $ptag->uri = common_local_url('profiletagbyid', array('id' => $ptag->id, 'tagger_id' => $ptag->tagger));
676 $result = $ptag->update($orig);
678 common_log_db_error($ptag, 'UPDATE', __FILE__);
679 // TRANS: Server exception saving new tag.
680 throw new ServerException(_('Could not set profile tag URI.'));
684 if (!isset($mainpage) || empty($mainpage)) {
685 $orig = clone($ptag);
686 $user = User::staticGet('id', $ptag->tagger);
688 $ptag->mainpage = common_local_url('showprofiletag', array('tag' => $ptag->tag, 'tagger' => $user->nickname));
690 $ptag->mainpage = $uri; // assume this is a remote peopletag and the uri works
693 $result = $ptag->update($orig);
695 common_log_db_error($ptag, 'UPDATE', __FILE__);
696 // TRANS: Server exception saving new tag.
697 throw new ServerException(_('Could not set profile tag mainpage.'));
704 * get all items at given cursor position for api
706 * @param callback $fn a function that takes the following arguments in order:
707 * $offset, $limit, $since_id, $max_id
708 * and returns a Profile_list object after making the DB query
709 * @param array $args arguments required for $fn
710 * @param integer $cursor the cursor
711 * @param integer $count max. number of results
714 * - if cursor is 0, return empty list
715 * - if cursor is -1, get first 21 items, next_cursor = 20th prev_cursor = 0
716 * - if cursor is +ve get 22 consecutive items before starting at cursor
717 * - return items[1..20] if items[0] == cursor else return items[0..21]
718 * - prev_cursor = items[1]
719 * - next_cursor = id of the last item being returned
721 * - if cursor is -ve get 22 consecutive items after cursor starting at cursor
722 * - return items[1..20]
724 * @returns array (array (mixed items), int next_cursor, int previous_cursor)
727 // XXX: This should be in Memcached_DataObject... eventually.
729 static function getAtCursor($fn, $args, $cursor, $count=20)
739 // if cursor is +ve fetch $count+2 items before cursor starting at cursor
741 $fn_args = array_merge($args, array(0, $count+2, 0, $max_id));
742 $list = call_user_func_array($fn, $fn_args);
743 while($list->fetch()) {
744 $items[] = clone($list);
747 if ((isset($items[0]->cursor) && $items[0]->cursor == $cursor) ||
748 $items[0]->id == $cursor) {
750 $prev_cursor = isset($items[0]->cursor) ?
751 -$items[0]->cursor : -$items[0]->id;
753 if (count($items) > $count+1) {
756 // this means the cursor item has been deleted, check to see if there are more
757 $fn_args = array_merge($args, array(0, 1, $cursor));
758 $more = call_user_func($fn, $fn_args);
759 if (!$more->fetch() || empty($more)) {
763 $prev_cursor = isset($items[0]->cursor) ?
764 -$items[0]->cursor : -$items[0]->id;
768 if (count($items)==$count+1) {
769 // this means there is a next page.
770 $next = array_pop($items);
771 $next_cursor = isset($next->cursor) ?
772 $items[$count-1]->cursor : $items[$count-1]->id;
775 } else if($cursor < -1) {
776 // if cursor is -ve fetch $count+2 items created after -$cursor-1
777 $cursor = abs($cursor);
778 $since_id = $cursor-1;
780 $fn_args = array_merge($args, array(0, $count+2, $since_id));
781 $list = call_user_func_array($fn, $fn_args);
782 while($list->fetch()) {
783 $items[] = clone($list);
786 $end = count($items)-1;
787 if ((isset($items[$end]->cursor) && $items[$end]->cursor == $cursor) ||
788 $items[$end]->id == $cursor) {
790 $next_cursor = isset($items[$end-1]->cursor) ?
791 $items[$end-1]->cursor : $items[$end-1]->id;
793 $next_cursor = isset($items[$end]->cursor) ?
794 $items[$end]->cursor : $items[$end]->id;
795 if ($end > $count) array_pop($items); // excess item.
797 // check if there are more items for next page
798 $fn_args = array_merge($args, array(0, 1, 0, $cursor));
799 $more = call_user_func_array($fn, $fn_args);
800 if (!$more->fetch() || empty($more)) {
805 if (count($items) == $count+1) {
806 // this means there is a previous page.
807 $prev = array_shift($items);
808 $prev_cursor = isset($prev->cursor) ?
809 -$items[0]->cursor : -$items[0]->id;
811 } else if($cursor == -1) {
812 $fn_args = array_merge($args, array(0, $count+1));
813 $list = call_user_func_array($fn, $fn_args);
815 while($list->fetch()) {
816 $items[] = clone($list);
819 if (count($items)==$count+1) {
820 $next = array_pop($items);
821 if(isset($next->cursor)) {
822 $next_cursor = $items[$count-1]->cursor;
824 $next_cursor = $items[$count-1]->id;
829 return array($items, $next_cursor, $prev_cursor);
833 * save a collection of people tags into the cache
835 * @param string $ckey cache key
836 * @param Profile_list &$tag the results to store
837 * @param integer $offset offset for slicing results
838 * @param integer $limit maximum number of results
840 * @return boolean success
843 static function setCache($ckey, &$tag, $offset=0, $limit=null) {
844 $cache = Cache::instance();
850 while ($tag->fetch()) {
851 $str .= $tag->tagger . ':' . $tag->tag . ';';
852 $tags[] = clone($tag);
854 $str = substr($str, 0, -1);
855 if ($offset>=0 && !is_null($limit)) {
856 $tags = array_slice($tags, $offset, $limit);
859 $tag = new ArrayWrapper($tags);
861 return self::cacheSet($ckey, $str);
865 * get people tags from the cache
867 * @param string $ckey cache key
868 * @param integer $offset offset for slicing
869 * @param integer $limit limit
871 * @return Profile_list results
874 static function getCached($ckey, $offset=0, $limit=null) {
876 $keys_str = self::cacheGet($ckey);
877 if ($keys_str === false) {
881 $pairs = explode(';', $keys_str);
883 foreach ($pairs as $pair) {
884 $keys[] = explode(':', $pair);
887 if ($offset>=0 && !is_null($limit)) {
888 $keys = array_slice($keys, $offset, $limit);
890 return self::getByKeys($keys);
894 * get Profile_list objects from the database
895 * given their (tag, tagger) key pairs.
897 * @param array $keys array of array(tagger, tag)
899 * @return Profile_list results
902 static function getByKeys($keys) {
903 $cache = Cache::instance();
905 if (!empty($cache)) {
908 foreach ($keys as $key) {
909 $t = Profile_list::getByTaggerAndTag($key[0], $key[1]);
914 return new ArrayWrapper($tags);
916 $tag = new Profile_list();
918 //if no IDs requested, just return the tag object
923 foreach ($keys as $key) {
924 $pairs[] = '(' . $key[0] . ', "' . $key[1] . '")';
927 $tag->whereAdd('(tagger, tag) in (' . implode(', ', $pairs) . ')');
933 while ($tag->fetch()) {
934 $temp[$tag->tagger.'-'.$tag->tag] = clone($tag);
939 foreach ($keys as $key) {
940 $id = $key[0].'-'.$key[1];
941 if (array_key_exists($id, $temp)) {
942 $wrapped[] = $temp[$id];
946 return new ArrayWrapper($wrapped);
952 $result = parent::insert();
954 self::blow('profile:lists:%d', $this->tagger);