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 $foreign_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     public $modified;                        // datetime not_null
  60
  61     /**
  62      * Get an instance by key
  63      *
  64      * @param string $k Key to use to lookup (usually 'foreign_id' for this class)
  65      * @param mixed  $v Value to lookup
  66      *
  67      * @return Twitter_synch_status object found, or null for no hits
  68      *
  69      */
  70
  71     function staticGet($k, $v=null)
  72     {
  73         throw new Exception("Use pkeyGet() for this class.");
  74     }
  75
  76     /**
  77      * Get an instance by compound primary key
  78      *
  79      * @param array $kv key-value pair array
  80      *
  81      * @return Twitter_synch_status object found, or null for no hits
  82      *
  83      */
  84
  85     function pkeyGet($kv)
  86     {
  87         return Memcached_DataObject::pkeyGet('Twitter_synch_status', $kv);
  88     }
  89
  90     /**
  91      * return table definition for DB_DataObject
  92      *
  93      * DB_DataObject needs to know something about the table to manipulate
  94      * instances. This method provides all the DB_DataObject needs to know.
  95      *
  96      * @return array array of column definitions
  97      */
  98
  99     function table()
 100     {
 101         return array('foreign_id' => DB_DATAOBJECT_INT + DB_DATAOBJECT_NOTNULL,
 102                      'timeline' => DB_DATAOBJECT_STR + DB_DATAOBJECT_NOTNULL,
 103                      'last_id' => DB_DATAOBJECT_INT + DB_DATAOBJECT_NOTNULL,
 104                      'created' => DB_DATAOBJECT_STR + DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL,
 105                      'modified' => DB_DATAOBJECT_STR + DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL
 106                      );
 107     }
 108
 109     /**
 110      * return key definitions for DB_DataObject
 111      *
 112      * DB_DataObject needs to know about keys that the table has, since it
 113      * won't appear in StatusNet's own keys list. In most cases, this will
 114      * simply reference your keyTypes() function.
 115      *
 116      * @return array list of key field names
 117      */
 118
 119     function keys()
 120     {
 121         return array_keys($this->keyTypes());
 122     }
 123
 124     /**
 125      * return key definitions for Memcached_DataObject
 126      *
 127      * Our caching system uses the same key definitions, but uses a different
 128      * method to get them. This key information is used to store and clear
 129      * cached data, so be sure to list any key that will be used for static
 130      * lookups.
 131      *
 132      * @return array associative array of key definitions, field name to type:
 133      *         'K' for primary key: for compound keys, add an entry for each component;
 134      *         'U' for unique keys: compound keys are not well supported here.
 135      */
 136
 137     function keyTypes()
 138     {
 139         return array('foreign_id' => 'K',
 140                      'timeline' => 'K');
 141     }
 142
 143     /**
 144      * Magic formula for non-autoincrementing integer primary keys
 145      *
 146      * If a table has a single integer column as its primary key, DB_DataObject
 147      * assumes that the column is auto-incrementing and makes a sequence table
 148      * to do this incrementation. Since we don't need this for our class, we
 149      * overload this method and return the magic formula that DB_DataObject needs.
 150      *
 151      * @return array magic three-false array that stops auto-incrementing.
 152      */
 153
 154     function sequenceKey()
 155     {
 156         return array(false, false, false);
 157     }
 158
 159     static function getLastId($foreign_id, $timeline)
 160     {
 161         $tss = self::pkeyGet(array('foreign_id' => $foreign_id,
 162                                    'timeline' => $timeline));
 163
 164         if (empty($tss)) {
 165             return null;
 166         } else {
 167             return $tss->last_id;
 168         }
 169     }
 170
 171     static function setLastId($foreign_id, $timeline, $last_id)
 172     {
 173         $tss = self::pkeyGet(array('foreign_id' => $foreign_id,
 174                                    'timeline' => $timeline));
 175
 176         if (empty($tss)) {
 177
 178             $tss = new Twitter_synch_status();
 179
 180             $tss->foreign_id = $foreign_id;
 181             $tss->timeline   = $timeline;
 182             $tss->last_id    = $last_id;
 183             $tss->created    = common_sql_now();
 184             $tss->modified   = $tss->created;
 185
 186             $tss->insert();
 187
 188             return true;
 189
 190         } else {
 191
 192             $orig = clone($tss);
 193
 194             $tss->last_id  = $last_id;
 195             $tss->modified = common_sql_now();
 196
 197             $tss->update();
 198
 199             return true;
 200         }
 201     }
 202 }