plugins/TwitterBridge/Twitter_synch_status.php

   1 <?php
   2 /**
   3  * Store last-touched ID for various timelines
   4  *
   5  * PHP version 5
   6  *
   7  * @category Data
   8  * @package  StatusNet
   9  * @author   Evan Prodromou <evan@status.net>
  10  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
  11  * @link     http://status.net/
  12  *
  13  * StatusNet - the distributed open-source microblogging tool
  14  * Copyright (C) 2010, StatusNet, Inc.
  15  *
  16  * This program is free software: you can redistribute it and/or modify
  17  * it under the terms of the GNU Affero General Public License as published by
  18  * the Free Software Foundation, either version 3 of the License, or
  19  * (at your option) any later version.
  20  *
  21  * This program is distributed in the hope that it will be useful,
  22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.     See the
  24  * GNU Affero General Public License for more details.
  25  *
  26  * You should have received a copy of the GNU Affero General Public License
  27  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  28  */
  29
  30 if (!defined('STATUSNET')) {
  31     exit(1);
  32 }
  33
  34 require_once INSTALLDIR . '/classes/Memcached_DataObject.php';
  35
  36 /**
  37  * Store various timeline data
  38  *
  39  * We don't want to keep re-fetching the same statuses and direct messages from Twitter.
  40  * So, we store the last ID we see from a timeline, and store it. Next time
  41  * around, we use that ID in the since_id parameter.
  42  *
  43  * @category Action
  44  * @package  StatusNet
  45  * @author   Evan Prodromou <evan@status.net>
  46  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
  47  * @link     http://status.net/
  48  *
  49  * @see      DB_DataObject
  50  */
  51
  52 class Twitter_synch_status extends Memcached_DataObject
  53 {
  54     public $__table = 'twitter_synch_status'; // table name
  55     public $user_id;                         // int(4)  primary_key not_null
  56     public $timeline;                        // varchar(255)  primary_key not_null
  57     public $last_id;                         // bigint not_null
  58     public $created;                         // datetime not_null
  59
  60     /**
  61      * Get an instance by key
  62      *
  63      * @param string $k Key to use to lookup (usually 'user_id' for this class)
  64      * @param mixed  $v Value to lookup
  65      *
  66      * @return User_greeting_count object found, or null for no hits
  67      *
  68      */
  69
  70     function staticGet($k, $v=null)
  71     {
  72         return Memcached_DataObject::staticGet('Twitter_synch_status', $k, $v);
  73     }
  74
  75     /**
  76      * return table definition for DB_DataObject
  77      *
  78      * DB_DataObject needs to know something about the table to manipulate
  79      * instances. This method provides all the DB_DataObject needs to know.
  80      *
  81      * @return array array of column definitions
  82      */
  83
  84     function table()
  85     {
  86         return array('user_id' => DB_DATAOBJECT_INT + DB_DATAOBJECT_NOTNULL,
  87                      'timeline' => DB_DATAOBJECT_STRING + DB_DATAOBJECT_NOTNULL,
  88                      'last_id' => DB_DATAOBJECT_INT + DB_DATAOBJECT_NOTNULL,
  89                      'created' => DB_DATAOBJECT_STR + DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL
  90                      );
  91     }
  92
  93     /**
  94      * return key definitions for DB_DataObject
  95      *
  96      * DB_DataObject needs to know about keys that the table has, since it
  97      * won't appear in StatusNet's own keys list. In most cases, this will
  98      * simply reference your keyTypes() function.
  99      *
 100      * @return array list of key field names
 101      */
 102
 103     function keys()
 104     {
 105         return array_keys($this->keyTypes());
 106     }
 107
 108     /**
 109      * return key definitions for Memcached_DataObject
 110      *
 111      * Our caching system uses the same key definitions, but uses a different
 112      * method to get them. This key information is used to store and clear
 113      * cached data, so be sure to list any key that will be used for static
 114      * lookups.
 115      *
 116      * @return array associative array of key definitions, field name to type:
 117      *         'K' for primary key: for compound keys, add an entry for each component;
 118      *         'U' for unique keys: compound keys are not well supported here.
 119      */
 120
 121     function keyTypes()
 122     {
 123         return array('user_id' => 'K',
 124                      'timeline' => 'K');
 125     }
 126
 127     /**
 128      * Magic formula for non-autoincrementing integer primary keys
 129      *
 130      * If a table has a single integer column as its primary key, DB_DataObject
 131      * assumes that the column is auto-incrementing and makes a sequence table
 132      * to do this incrementation. Since we don't need this for our class, we
 133      * overload this method and return the magic formula that DB_DataObject needs.
 134      *
 135      * @return array magic three-false array that stops auto-incrementing.
 136      */
 137
 138     function sequenceKey()
 139     {
 140         return array(false, false, false);
 141     }
 142
 143     static function getLastId($user_id, $timeline)
 144     {
 145         $tss = self::staticGet(array('user_id' => $user_id,
 146                                      'timeline' => $timeline));
 147
 148         if (empty($tss)) {
 149             return null;
 150         } else {
 151             return $tss->last_id;
 152         }
 153     }
 154
 155     static function setLastId($user_id, $timeline, $last_id)
 156     {
 157         $tss = self::staticGet(array('user_id' => $user_id,
 158                                      'timeline' => $timeline));
 159
 160         if (empty($tss)) {
 161
 162             $tss = new Twitter_synch_status();
 163
 164             $tss->user_id  = $user_id;
 165             $tss->timeline = $timeline;
 166             $tss->last_id  = $last_id;
 167
 168             $tss->insert();
 169
 170             return true;
 171
 172         } else {
 173
 174             $orig = clone($tss);
 175
 176             $tss->last_id = $last_id;
 177
 178             $tss->update();
 179
 180             return true;
 181         }
 182     }
 183 }