plugins/TwitterBridge/classes/Notice_to_status.php

   1 <?php
   2 /**
   3  * Data class for remembering notice-to-status mappings
   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  * Data class for mapping notices to statuses
  38  *
  39  * Notices flow back and forth between Twitter and StatusNet. We use this
  40  * table to remember which StatusNet notice corresponds to which Twitter
  41  * status.
  42  *
  43  * Note that notice_id is unique only within a single database; if you
  44  * want to share this data for some reason, get the notice's URI and use
  45  * that instead, since it's universally unique.
  46  *
  47  * @category Action
  48  * @package  StatusNet
  49  * @author   Evan Prodromou <evan@status.net>
  50  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
  51  * @link     http://status.net/
  52  *
  53  * @see      DB_DataObject
  54  */
  55
  56 class Notice_to_status extends Managed_DataObject
  57 {
  58     public $__table = 'notice_to_status'; // table name
  59     public $notice_id;                    // int(4)  primary_key not_null
  60     public $status_id;                    // bigint not_null
  61     public $created;                      // datetime()   not_null
  62     public $modified;                     // datetime   not_null default_0000-00-00%2000%3A00%3A00
  63
  64     public static function schemaDef()
  65     {
  66         return array(
  67             'fields' => array(
  68                 'notice_id' => array('type' => 'int', 'not null' => true, 'description' => 'local notice id'),
  69                 'status_id' => array('type' => 'int', 'size' => 'big', 'not null' => true, 'description' => 'twitter status id'),
  70                 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'),
  71                 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
  72             ),
  73             'primary key' => array('notice_id'),
  74             'unique keys' => array(
  75                 'status_id_key' => array('status_id'),
  76             ),
  77             'foreign keys' => array(
  78                 'notice_to_status_notice_id_fkey' => array('notice', array('notice_id' => 'id')),
  79             ),
  80         );
  81     }
  82
  83     /**
  84      * Save a mapping between a notice and a status
  85      * Warning: status_id values may not fit in 32-bit integers.
  86      *
  87      * @param integer $notice_id ID of the notice in StatusNet
  88      * @param integer $status_id ID of the status in Twitter
  89      *
  90      * @return Notice_to_status new object for this value
  91      */
  92     static function saveNew($notice_id, $status_id)
  93     {
  94         if (empty($notice_id)) {
  95             throw new Exception("Invalid notice_id $notice_id");
  96         }
  97         $n2s = Notice_to_status::getKV('notice_id', $notice_id);
  98
  99         if (!empty($n2s)) {
 100             return $n2s;
 101         }
 102
 103         if (empty($status_id)) {
 104             throw new Exception("Invalid status_id $status_id");
 105         }
 106         $n2s = Notice_to_status::getKV('status_id', $status_id);
 107
 108         if (!empty($n2s)) {
 109             return $n2s;
 110         }
 111
 112         common_debug("Mapping notice {$notice_id} to Twitter status {$status_id}");
 113
 114         $n2s = new Notice_to_status();
 115
 116         $n2s->notice_id = $notice_id;
 117         $n2s->status_id = $status_id;
 118         $n2s->created   = common_sql_now();
 119
 120         $n2s->insert();
 121
 122         return $n2s;
 123     }
 124 }