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 class Twitter_synch_status extends Managed_DataObject
  52 {
  53     public $__table = 'twitter_synch_status'; // table name
  54     public $foreign_id;                         // int(4)  primary_key not_null
  55     public $timeline;                        // varchar(255)  primary_key not_null
  56     public $last_id;                         // bigint not_null
  57     public $created;                         // datetime not_null
  58     public $modified;                        // datetime not_null
  59
  60     /**
  61      * return table definition for DB_DataObject
  62      *
  63      * DB_DataObject needs to know something about the table to manipulate
  64      * instances. This method provides all the DB_DataObject needs to know.
  65      *
  66      * @return array array of column definitions
  67      */
  68     function table()
  69     {
  70         return array('foreign_id' => DB_DATAOBJECT_INT + DB_DATAOBJECT_NOTNULL,
  71                      'timeline' => DB_DATAOBJECT_STR + DB_DATAOBJECT_NOTNULL,
  72                      'last_id' => DB_DATAOBJECT_INT + DB_DATAOBJECT_NOTNULL,
  73                      'created' => DB_DATAOBJECT_STR + DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL,
  74                      'modified' => DB_DATAOBJECT_STR + DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL
  75                      );
  76     }
  77
  78     /**
  79      * return key definitions for DB_DataObject
  80      *
  81      * DB_DataObject needs to know about keys that the table has, since it
  82      * won't appear in StatusNet's own keys list. In most cases, this will
  83      * simply reference your keyTypes() function.
  84      *
  85      * @return array list of key field names
  86      */
  87     function keys()
  88     {
  89         return array_keys($this->keyTypes());
  90     }
  91
  92     /**
  93      * return key definitions for Memcached_DataObject
  94      *
  95      * Our caching system uses the same key definitions, but uses a different
  96      * method to get them. This key information is used to store and clear
  97      * cached data, so be sure to list any key that will be used for static
  98      * lookups.
  99      *
 100      * @return array associative array of key definitions, field name to type:
 101      *         'K' for primary key: for compound keys, add an entry for each component;
 102      *         'U' for unique keys: compound keys are not well supported here.
 103      */
 104     function keyTypes()
 105     {
 106         return array('foreign_id' => 'K',
 107                      'timeline' => 'K');
 108     }
 109
 110     /**
 111      * Magic formula for non-autoincrementing integer primary keys
 112      *
 113      * If a table has a single integer column as its primary key, DB_DataObject
 114      * assumes that the column is auto-incrementing and makes a sequence table
 115      * to do this incrementation. Since we don't need this for our class, we
 116      * overload this method and return the magic formula that DB_DataObject needs.
 117      *
 118      * @return array magic three-false array that stops auto-incrementing.
 119      */
 120     function sequenceKey()
 121     {
 122         return array(false, false, false);
 123     }
 124
 125     static function getLastId($foreign_id, $timeline)
 126     {
 127         $tss = self::pkeyGet(array('foreign_id' => $foreign_id,
 128                                    'timeline' => $timeline));
 129
 130         if (empty($tss)) {
 131             return null;
 132         } else {
 133             return $tss->last_id;
 134         }
 135     }
 136
 137     static function setLastId($foreign_id, $timeline, $last_id)
 138     {
 139         $tss = self::pkeyGet(array('foreign_id' => $foreign_id,
 140                                    'timeline' => $timeline));
 141
 142         if (empty($tss)) {
 143             $tss = new Twitter_synch_status();
 144
 145             $tss->foreign_id = $foreign_id;
 146             $tss->timeline   = $timeline;
 147             $tss->last_id    = $last_id;
 148             $tss->created    = common_sql_now();
 149             $tss->modified   = $tss->created;
 150
 151             $tss->insert();
 152
 153             return true;
 154         } else {
 155             $orig = clone($tss);
 156
 157             $tss->last_id  = $last_id;
 158             $tss->modified = common_sql_now();
 159
 160             $tss->update();
 161
 162             return true;
 163         }
 164     }
 165 }