classes/Profile_list.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  *
   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.
   9  *
  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.
  14  *
  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/>.
  17  *
  18  * @category Notices
  19  * @package  StatusNet
  20  * @author   Shashi Gowda <connect2shashi@gmail.com>
  21  * @license  GNU Affero General Public License http://www.gnu.org/licenses/
  22  */
  23
  24 if (!defined('STATUSNET') && !defined('LACONICA')) {
  25     exit(1);
  26 }
  27
  28 /**
  29  * Table Definition for profile_list
  30  */
  31 require_once INSTALLDIR.'/classes/Memcached_DataObject.php';
  32
  33 class Profile_list extends Memcached_DataObject
  34 {
  35     ###START_AUTOCODE
  36     /* the code below is auto generated do not remove the above tag */
  37
  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
  50
  51     /* Static get */
  52     function staticGet($k,$v=NULL) { return DB_DataObject::staticGet('Profile_list',$k,$v); }
  53
  54     /* the code above is auto generated do not remove the tag below */
  55     ###END_AUTOCODE
  56
  57     /**
  58      * return a profile_list record, given its tag and tagger.
  59      *
  60      * @param array $kv ideally array('tag' => $tag, 'tagger' => $tagger)
  61      *
  62      * @return Profile_list a Profile_list object with the given tag and tagger.
  63      */
  64
  65     function pkeyGet($kv)
  66     {
  67         return Memcached_DataObject::pkeyGet('Profile_list', $kv);
  68     }
  69
  70     /**
  71      * get the tagger of this profile_list object
  72      *
  73      * @return Profile the tagger
  74      */
  75
  76     function getTagger()
  77     {
  78         return Profile::staticGet('id', $this->tagger);
  79     }
  80
  81     /**
  82      * return a string to identify this
  83      * profile_list in the user interface etc.
  84      *
  85      * @return String
  86      */
  87
  88     function getBestName()
  89     {
  90         return $this->tag;
  91     }
  92
  93     /**
  94      * return a uri string for this profile_list
  95      *
  96      * @return String uri
  97      */
  98
  99     function getUri()
 100     {
 101         $uri = null;
 102         if (Event::handle('StartProfiletagGetUri', array($this, &$uri))) {
 103             if (!empty($this->uri)) {
 104                 $uri = $this->uri;
 105             } else {
 106                 $uri = common_local_url('profiletagbyid',
 107                                         array('id' => $this->id, 'tagger_id' => $this->tagger));
 108             }
 109         }
 110         Event::handle('EndProfiletagGetUri', array($this, &$uri));
 111         return $uri;
 112     }
 113
 114     /**
 115      * return a url to the homepage of this item
 116      *
 117      * @return String home url
 118      */
 119
 120     function homeUrl()
 121     {
 122         $url = null;
 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;
 127             } else {
 128                 $url = common_local_url('showprofiletag',
 129                                         array('tagger' => $this->getTagger()->nickname,
 130                                               'tag'    => $this->tag));
 131             }
 132         }
 133         Event::handle('EndUserPeopletagHomeUrl', array($this, &$url));
 134         return $url;
 135     }
 136
 137     /**
 138      * return an immutable url for this object
 139      *
 140      * @return String permalink
 141      */
 142
 143     function permalink()
 144     {
 145         $url = null;
 146         if (Event::handle('StartProfiletagPermalink', array($this, &$url))) {
 147             $url = common_local_url('profiletagbyid',
 148                                     array('id' => $this->id));
 149         }
 150         Event::handle('EndProfiletagPermalink', array($this, &$url));
 151         return $url;
 152     }
 153
 154     /**
 155      * Query notices by users associated with this tag,
 156      * but first check the cache before hitting the DB.
 157      *
 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
 162      *
 163      * @return Notice the query
 164      */
 165
 166     function getNotices($offset, $limit, $since_id=null, $max_id=null)
 167     {
 168         $stream = new PeopletagNoticeStream($this);
 169
 170         return $stream->getNotices($offset, $limit, $since_id, $max_id);
 171     }
 172
 173     /**
 174      * Get subscribers (local and remote) to this people tag
 175      * Order by reverse chronology
 176      *
 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
 181      *
 182      * @return Profile results
 183      */
 184
 185     function getSubscribers($offset=0, $limit=null, $since=0, $upto=0)
 186     {
 187         $subs = new Profile();
 188         $sub = new Profile_tag_subscription();
 189         $sub->profile_tag_id = $this->id;
 190
 191         $subs->joinAdd($sub);
 192         $subs->selectAdd('unix_timestamp(profile_tag_subscription.' .
 193                          'created) as "cursor"');
 194
 195         if ($since != 0) {
 196             $subs->whereAdd('cursor > ' . $since);
 197         }
 198
 199         if ($upto != 0) {
 200             $subs->whereAdd('cursor <= ' . $upto);
 201         }
 202
 203         if ($limit != null) {
 204             $subs->limit($offset, $limit);
 205         }
 206
 207         $subs->orderBy('profile_tag_subscription.created DESC');
 208         $subs->find();
 209
 210         return $subs;
 211     }
 212
 213     /**
 214      * Get all and only local subscribers to this people tag
 215      * used for distributing notices to user inboxes.
 216      *
 217      * @return array ids of users
 218      */
 219
 220     function getUserSubscribers()
 221     {
 222         // XXX: cache this
 223
 224         $user = new User();
 225         if(common_config('db','quote_identifiers'))
 226             $user_table = '"user"';
 227         else $user_table = 'user';
 228
 229         $qry =
 230           'SELECT id ' .
 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 ';
 234
 235         $user->query(sprintf($qry, $this->id));
 236
 237         $ids = array();
 238
 239         while ($user->fetch()) {
 240             $ids[] = $user->id;
 241         }
 242
 243         $user->free();
 244
 245         return $ids;
 246     }
 247
 248     /**
 249      * Check to see if a given profile has
 250      * subscribed to this people tag's timeline
 251      *
 252      * @param mixed $id User or Profile object or integer id
 253      *
 254      * @return boolean subscription status
 255      */
 256
 257     function hasSubscriber($id)
 258     {
 259         if (!is_numeric($id)) {
 260             $id = $id->id;
 261         }
 262
 263         $sub = Profile_tag_subscription::pkeyGet(array('profile_tag_id' => $this->id,
 264                                                        'profile_id'     => $id));
 265         return !empty($sub);
 266     }
 267
 268     /**
 269      * Get profiles tagged with this people tag,
 270      * include modified timestamp as a "cursor" field
 271      * order by descending order of modified time
 272      *
 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
 277      *
 278      * @return Profile results
 279      */
 280
 281     function getTagged($offset=0, $limit=null, $since=0, $upto=0)
 282     {
 283         $tagged = new Profile();
 284         $tagged->joinAdd(array('id', 'profile_tag:tagged'));
 285
 286         #@fixme: postgres
 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}'");
 290
 291         if ($since != 0) {
 292             $tagged->whereAdd('cursor > ' . $since);
 293         }
 294
 295         if ($upto != 0) {
 296             $tagged->whereAdd('cursor <= ' . $upto);
 297         }
 298
 299         if ($limit != null) {
 300             $tagged->limit($offset, $limit);
 301         }
 302
 303         $tagged->orderBy('profile_tag.modified DESC');
 304         $tagged->find();
 305
 306         return $tagged;
 307     }
 308
 309     /**
 310      * Gracefully delete one or many people tags
 311      * along with their members and subscriptions data
 312      *
 313      * @return boolean success
 314      */
 315
 316     function delete()
 317     {
 318         // force delete one item at a time.
 319         if (empty($this->id)) {
 320             $this->find();
 321             while ($this->fetch()) {
 322                 $this->delete();
 323             }
 324         }
 325
 326         Profile_tag::cleanup($this);
 327         Profile_tag_subscription::cleanup($this);
 328
 329         return parent::delete();
 330     }
 331
 332     /**
 333      * Update a people tag gracefully
 334      * also change "tag" fields in profile_tag table
 335      *
 336      * @param Profile_list $orig    Object's original form
 337      *
 338      * @return boolean success
 339      */
 340
 341     function update($orig=null)
 342     {
 343         $result = true;
 344
 345         if (!is_object($orig) && !$orig instanceof Profile_list) {
 346             parent::update($orig);
 347         }
 348
 349         // if original tag was different
 350         // check to see if the new tag already exists
 351         // if not, rename the tag correctly
 352         if($orig->tag != $this->tag || $orig->tagger != $this->tagger) {
 353             $existing = Profile_list::getByTaggerAndTag($this->tagger, $this->tag);
 354             if(!empty($existing)) {
 355                 // TRANS: Server exception.
 356                 throw new ServerException(_('The tag you are trying to rename ' .
 357                                             'to already exists.'));
 358             }
 359             // move the tag
 360             // XXX: allow OStatus plugin to send out profile tag
 361             $result = Profile_tag::moveTag($orig, $this);
 362         }
 363         parent::update($orig);
 364         return $result;
 365     }
 366
 367     /**
 368      * return an xml string representing this people tag
 369      * as the author of an atom feed
 370      *
 371      * @return string atom author element
 372      */
 373
 374     function asAtomAuthor()
 375     {
 376         $xs = new XMLStringer(true);
 377
 378         $tagger = $this->getTagger();
 379         $xs->elementStart('author');
 380         $xs->element('name', null, '@' . $tagger->nickname . '/' . $this->tag);
 381         $xs->element('uri', null, $this->permalink());
 382         $xs->elementEnd('author');
 383
 384         return $xs->getString();
 385     }
 386
 387     /**
 388      * return an xml string to represent this people tag
 389      * as the subject of an activitystreams feed.
 390      *
 391      * @return string activitystreams subject
 392      */
 393
 394     function asActivitySubject()
 395     {
 396         return $this->asActivityNoun('subject');
 397     }
 398
 399     /**
 400      * return an xml string to represent this people tag
 401      * as a noun in an activitystreams feed.
 402      *
 403      * @param string $element the xml tag
 404      *
 405      * @return string activitystreams noun
 406      */
 407
 408     function asActivityNoun($element)
 409     {
 410         $noun = ActivityObject::fromPeopletag($this);
 411         return $noun->asString('activity:' . $element);
 412     }
 413
 414     /**
 415      * get the cached number of profiles tagged with this
 416      * people tag, re-count if the argument is true.
 417      *
 418      * @param boolean $recount  whether to ignore cache
 419      *
 420      * @return integer count
 421      */
 422
 423     function taggedCount($recount=false)
 424     {
 425         $keypart = sprintf('profile_list:tagged_count:%d:%s',
 426                            $this->tagger,
 427                            $this->tag);
 428
 429         $count = self::cacheGet($keypart);
 430
 431         if ($count === false) {
 432             $tags = new Profile_tag();
 433
 434             $tags->tag = $this->tag;
 435             $tags->tagger = $this->tagger;
 436
 437             $count = $tags->count('distinct tagged');
 438
 439             self::cacheSet($keypart, $count);
 440         }
 441
 442         return $count;
 443     }
 444
 445     /**
 446      * get the cached number of profiles subscribed to this
 447      * people tag, re-count if the argument is true.
 448      *
 449      * @param boolean $recount  whether to ignore cache
 450      *
 451      * @return integer count
 452      */
 453
 454     function subscriberCount($recount=false)
 455     {
 456         $keypart = sprintf('profile_list:subscriber_count:%d',
 457                            $this->id);
 458
 459         $count = self::cacheGet($keypart);
 460
 461         if ($count === false) {
 462
 463             $sub = new Profile_tag_subscription();
 464             $sub->profile_tag_id = $this->id;
 465             $count = (int) $sub->count('distinct profile_id');
 466
 467             self::cacheSet($keypart, $count);
 468         }
 469
 470         return $count;
 471     }
 472
 473     /**
 474      * get the Profile_list object by the
 475      * given tagger and with given tag
 476      *
 477      * @param integer $tagger   the id of the creator profile
 478      * @param integer $tag      the tag
 479      *
 480      * @return integer count
 481      */
 482
 483     static function getByTaggerAndTag($tagger, $tag)
 484     {
 485         $ptag = Profile_list::pkeyGet(array('tagger' => $tagger, 'tag' => $tag));
 486         return $ptag;
 487     }
 488
 489     /**
 490      * create a profile_list record for a tag, tagger pair
 491      * if it doesn't exist, return it.
 492      *
 493      * @param integer $tagger   the tagger
 494      * @param string  $tag      the tag
 495      * @param string  $description description
 496      * @param boolean $private  protected or not
 497      *
 498      * @return Profile_list the people tag object
 499      */
 500
 501     static function ensureTag($tagger, $tag, $description=null, $private=false)
 502     {
 503         $ptag = Profile_list::getByTaggerAndTag($tagger, $tag);
 504
 505         if(empty($ptag->id)) {
 506             $args = array(
 507                 'tag' => $tag,
 508                 'tagger' => $tagger,
 509                 'description' => $description,
 510                 'private' => $private
 511             );
 512
 513             $new_tag = Profile_list::saveNew($args);
 514
 515             return $new_tag;
 516         }
 517         return $ptag;
 518     }
 519
 520     /**
 521      * get the maximum number of characters
 522      * that can be used in the description of
 523      * a people tag.
 524      *
 525      * determined by $config['peopletag']['desclimit']
 526      * if not set, falls back to $config['site']['textlimit']
 527      *
 528      * @return integer maximum number of characters
 529      */
 530
 531     static function maxDescription()
 532     {
 533         $desclimit = common_config('peopletag', 'desclimit');
 534         // null => use global limit (distinct from 0!)
 535         if (is_null($desclimit)) {
 536             $desclimit = common_config('site', 'textlimit');
 537         }
 538         return $desclimit;
 539     }
 540
 541     /**
 542      * check if the length of given text exceeds
 543      * character limit.
 544      *
 545      * @param string $desc  the description
 546      *
 547      * @return boolean is the descripition too long?
 548      */
 549
 550     static function descriptionTooLong($desc)
 551     {
 552         $desclimit = self::maxDescription();
 553         return ($desclimit > 0 && !empty($desc) && (mb_strlen($desc) > $desclimit));
 554     }
 555
 556     /**
 557      * save a new people tag, this should be always used
 558      * since it makes uri, homeurl, created and modified
 559      * timestamps and performs checks.
 560      *
 561      * @param array $fields an array with fields and their values
 562      *
 563      * @return mixed Profile_list on success, false on fail
 564      */
 565     static function saveNew($fields) {
 566         extract($fields);
 567
 568         $ptag = new Profile_list();
 569
 570         $ptag->query('BEGIN');
 571
 572         if (empty($tagger)) {
 573             // TRANS: Server exception saving new tag without having a tagger specified.
 574             throw new Exception(_('No tagger specified.'));
 575         }
 576
 577         if (empty($tag)) {
 578             // TRANS: Server exception saving new tag without having a tag specified.
 579             throw new Exception(_('No tag specified.'));
 580         }
 581
 582         if (empty($mainpage)) {
 583             $mainpage = null;
 584         }
 585
 586         if (empty($uri)) {
 587             // fill in later...
 588             $uri = null;
 589         }
 590
 591         if (empty($mainpage)) {
 592             $mainpage = null;
 593         }
 594
 595         if (empty($description)) {
 596             $description = null;
 597         }
 598
 599         if (empty($private)) {
 600             $private = false;
 601         }
 602
 603         $ptag->tagger      = $tagger;
 604         $ptag->tag         = $tag;
 605         $ptag->description = $description;
 606         $ptag->private     = $private;
 607         $ptag->uri         = $uri;
 608         $ptag->mainpage    = $mainpage;
 609         $ptag->created     = common_sql_now();
 610         $ptag->modified    = common_sql_now();
 611
 612         $result = $ptag->insert();
 613
 614         if (!$result) {
 615             common_log_db_error($ptag, 'INSERT', __FILE__);
 616             // TRANS: Server exception saving new tag.
 617             throw new ServerException(_('Could not create profile tag.'));
 618         }
 619
 620         if (!isset($uri) || empty($uri)) {
 621             $orig = clone($ptag);
 622             $ptag->uri = common_local_url('profiletagbyid', array('id' => $ptag->id, 'tagger_id' => $ptag->tagger));
 623             $result = $ptag->update($orig);
 624             if (!$result) {
 625                 common_log_db_error($ptag, 'UPDATE', __FILE__);
 626             // TRANS: Server exception saving new tag.
 627                 throw new ServerException(_('Could not set profile tag URI.'));
 628             }
 629         }
 630
 631         if (!isset($mainpage) || empty($mainpage)) {
 632             $orig = clone($ptag);
 633             $user = User::staticGet('id', $ptag->tagger);
 634             if(!empty($user)) {
 635                 $ptag->mainpage = common_local_url('showprofiletag', array('tag' => $ptag->tag, 'tagger' => $user->nickname));
 636             } else {
 637                 $ptag->mainpage = $uri; // assume this is a remote peopletag and the uri works
 638             }
 639
 640             $result = $ptag->update($orig);
 641             if (!$result) {
 642                 common_log_db_error($ptag, 'UPDATE', __FILE__);
 643                 // TRANS: Server exception saving new tag.
 644                 throw new ServerException(_('Could not set profile tag mainpage.'));
 645             }
 646         }
 647         return $ptag;
 648     }
 649
 650     /**
 651      * get all items at given cursor position for api
 652      *
 653      * @param callback $fn  a function that takes the following arguments in order:
 654      *                      $offset, $limit, $since_id, $max_id
 655      *                      and returns a Profile_list object after making the DB query
 656      * @param array $args   arguments required for $fn
 657      * @param integer $cursor   the cursor
 658      * @param integer $count    max. number of results
 659      *
 660      * Algorithm:
 661      * - if cursor is 0, return empty list
 662      * - if cursor is -1, get first 21 items, next_cursor = 20th prev_cursor = 0
 663      * - if cursor is +ve get 22 consecutive items before starting at cursor
 664      *   - return items[1..20] if items[0] == cursor else return items[0..21]
 665      *   - prev_cursor = items[1]
 666      *   - next_cursor = id of the last item being returned
 667      *
 668      * - if cursor is -ve get 22 consecutive items after cursor starting at cursor
 669      *   - return items[1..20]
 670      *
 671      * @returns array (array (mixed items), int next_cursor, int previous_cursor)
 672      */
 673
 674      // XXX: This should be in Memcached_DataObject... eventually.
 675
 676     static function getAtCursor($fn, $args, $cursor, $count=20)
 677     {
 678         $items = array();
 679
 680         $since_id = 0;
 681         $max_id = 0;
 682         $next_cursor = 0;
 683         $prev_cursor = 0;
 684
 685         if($cursor > 0) {
 686             // if cursor is +ve fetch $count+2 items before cursor starting at cursor
 687             $max_id = $cursor;
 688             $fn_args = array_merge($args, array(0, $count+2, 0, $max_id));
 689             $list = call_user_func_array($fn, $fn_args);
 690             while($list->fetch()) {
 691                 $items[] = clone($list);
 692             }
 693
 694             if ((isset($items[0]->cursor) && $items[0]->cursor == $cursor) ||
 695                 $items[0]->id == $cursor) {
 696                 array_shift($items);
 697                 $prev_cursor = isset($items[0]->cursor) ?
 698                     -$items[0]->cursor : -$items[0]->id;
 699             } else {
 700                 if (count($items) > $count+1) {
 701                     array_shift($items);
 702                 }
 703                 // this means the cursor item has been deleted, check to see if there are more
 704                 $fn_args = array_merge($args, array(0, 1, $cursor));
 705                 $more = call_user_func($fn, $fn_args);
 706                 if (!$more->fetch() || empty($more)) {
 707                     // no more items.
 708                     $prev_cursor = 0;
 709                 } else {
 710                     $prev_cursor = isset($items[0]->cursor) ?
 711                         -$items[0]->cursor : -$items[0]->id;
 712                 }
 713             }
 714
 715             if (count($items)==$count+1) {
 716                 // this means there is a next page.
 717                 $next = array_pop($items);
 718                 $next_cursor = isset($next->cursor) ?
 719                     $items[$count-1]->cursor : $items[$count-1]->id;
 720             }
 721
 722         } else if($cursor < -1) {
 723             // if cursor is -ve fetch $count+2 items created after -$cursor-1
 724             $cursor = abs($cursor);
 725             $since_id = $cursor-1;
 726
 727             $fn_args = array_merge($args, array(0, $count+2, $since_id));
 728             $list = call_user_func_array($fn, $fn_args);
 729             while($list->fetch()) {
 730                 $items[] = clone($list);
 731             }
 732
 733             $end = count($items)-1;
 734             if ((isset($items[$end]->cursor) && $items[$end]->cursor == $cursor) ||
 735                 $items[$end]->id == $cursor) {
 736                 array_pop($items);
 737                 $next_cursor = isset($items[$end-1]->cursor) ?
 738                     $items[$end-1]->cursor : $items[$end-1]->id;
 739             } else {
 740                 $next_cursor = isset($items[$end]->cursor) ?
 741                     $items[$end]->cursor : $items[$end]->id;
 742                 if ($end > $count) array_pop($items); // excess item.
 743
 744                 // check if there are more items for next page
 745                 $fn_args = array_merge($args, array(0, 1, 0, $cursor));
 746                 $more = call_user_func_array($fn, $fn_args);
 747                 if (!$more->fetch() || empty($more)) {
 748                     $next_cursor = 0;
 749                 }
 750             }
 751
 752             if (count($items) == $count+1) {
 753                 // this means there is a previous page.
 754                 $prev = array_shift($items);
 755                 $prev_cursor = isset($prev->cursor) ?
 756                     -$items[0]->cursor : -$items[0]->id;
 757             }
 758         } else if($cursor == -1) {
 759             $fn_args = array_merge($args, array(0, $count+1));
 760             $list = call_user_func_array($fn, $fn_args);
 761
 762             while($list->fetch()) {
 763                 $items[] = clone($list);
 764             }
 765
 766             if (count($items)==$count+1) {
 767                 $next = array_pop($items);
 768                 if(isset($next->cursor)) {
 769                     $next_cursor = $items[$count-1]->cursor;
 770                 } else {
 771                     $next_cursor = $items[$count-1]->id;
 772                 }
 773             }
 774
 775         }
 776         return array($items, $next_cursor, $prev_cursor);
 777     }
 778
 779     /**
 780      * save a collection of people tags into the cache
 781      *
 782      * @param string $ckey  cache key
 783      * @param Profile_list &$tag the results to store
 784      * @param integer $offset   offset for slicing results
 785      * @param integer $limit    maximum number of results
 786      *
 787      * @return boolean success
 788      */
 789
 790     static function setCache($ckey, &$tag, $offset=0, $limit=null) {
 791         $cache = Cache::instance();
 792         if (empty($cache)) {
 793             return false;
 794         }
 795         $str = '';
 796         $tags = array();
 797         while ($tag->fetch()) {
 798             $str .= $tag->tagger . ':' . $tag->tag . ';';
 799             $tags[] = clone($tag);
 800         }
 801         $str = substr($str, 0, -1);
 802         if ($offset>=0 && !is_null($limit)) {
 803             $tags = array_slice($tags, $offset, $limit);
 804         }
 805
 806         $tag = new ArrayWrapper($tags);
 807
 808         return self::cacheSet($ckey, $str);
 809     }
 810
 811     /**
 812      * get people tags from the cache
 813      *
 814      * @param string $ckey  cache key
 815      * @param integer $offset   offset for slicing
 816      * @param integer $limit    limit
 817      *
 818      * @return Profile_list results
 819      */
 820
 821     static function getCached($ckey, $offset=0, $limit=null) {
 822
 823         $keys_str = self::cacheGet($ckey);
 824         if ($keys_str === false) {
 825             return false;
 826         }
 827
 828         $pairs = explode(';', $keys_str);
 829         $keys = array();
 830         foreach ($pairs as $pair) {
 831             $keys[] = explode(':', $pair);
 832         }
 833
 834         if ($offset>=0 && !is_null($limit)) {
 835             $keys = array_slice($keys, $offset, $limit);
 836         }
 837         return self::getByKeys($keys);
 838     }
 839
 840     /**
 841      * get Profile_list objects from the database
 842      * given their (tag, tagger) key pairs.
 843      *
 844      * @param array $keys   array of array(tagger, tag)
 845      *
 846      * @return Profile_list results
 847      */
 848
 849     static function getByKeys($keys) {
 850         $cache = Cache::instance();
 851
 852         if (!empty($cache)) {
 853             $tags = array();
 854
 855             foreach ($keys as $key) {
 856                 $t = Profile_list::getByTaggerAndTag($key[0], $key[1]);
 857                 if (!empty($t)) {
 858                     $tags[] = $t;
 859                 }
 860             }
 861             return new ArrayWrapper($tags);
 862         } else {
 863             $tag = new Profile_list();
 864             if (empty($keys)) {
 865                 //if no IDs requested, just return the tag object
 866                 return $tag;
 867             }
 868
 869             $pairs = array();
 870             foreach ($keys as $key) {
 871                 $pairs[] = '(' . $key[0] . ', "' . $key[1] . '")';
 872             }
 873
 874             $tag->whereAdd('(tagger, tag) in (' . implode(', ', $pairs) . ')');
 875
 876             $tag->find();
 877
 878             $temp = array();
 879
 880             while ($tag->fetch()) {
 881                 $temp[$tag->tagger.'-'.$tag->tag] = clone($tag);
 882             }
 883
 884             $wrapped = array();
 885
 886             foreach ($keys as $key) {
 887                 $id = $key[0].'-'.$key[1];
 888                 if (array_key_exists($id, $temp)) {
 889                     $wrapped[] = $temp[$id];
 890                 }
 891             }
 892
 893             return new ArrayWrapper($wrapped);
 894         }
 895     }
 896 }