plugins/YammerImport/classes/Yammer_notice_stub.php

   1 <?php
   2 /**
   3  * Data class for remembering Yammer import mappings
   4  *
   5  * PHP version 5
   6  *
   7  * @category Data
   8  * @package  StatusNet
   9  * @author   Brion Vibber <brion@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 /**
  35  * Temporary storage for imported Yammer messages between fetching and saving
  36  * as local notices.
  37  *
  38  * The Yammer API only allows us to page down from the most recent items; in
  39  * order to start saving the oldest notices first, we have to pull them all
  40  * down in reverse chronological order, then go back over them from oldest to
  41  * newest and actually save them into our notice table.
  42  */
  43
  44 class Yammer_notice_stub extends Memcached_DataObject
  45 {
  46     public $__table = 'yammer_notice_stub'; // table name
  47     public $id;                             // int  primary_key not_null
  48     public $json_data;                      // text
  49     public $created;                        // datetime
  50
  51     /**
  52      * Return schema definition to set this table up in onCheckSchema
  53      */
  54     static function schemaDef($field)
  55     {
  56         return array(new ColumnDef('id', 'bigint', null,
  57                                    false, 'PRI'),
  58                      new ColumnDef('json_data', 'text', null,
  59                                    false),
  60                      new ColumnDef('created', 'datetime', null,
  61                                    false));
  62     }
  63
  64     /**
  65      * return table definition for DB_DataObject
  66      *
  67      * DB_DataObject needs to know something about the table to manipulate
  68      * instances. This method provides all the DB_DataObject needs to know.
  69      *
  70      * @return array array of column definitions
  71      */
  72
  73     function table()
  74     {
  75         return array('id'           => DB_DATAOBJECT_INT + DB_DATAOBJECT_NOTNULL,
  76                      'json_data'    => DB_DATAOBJECT_INT + DB_DATAOBJECT_NOTNULL,
  77                      'created'      => DB_DATAOBJECT_STR + DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL);
  78     }
  79
  80     /**
  81      * return key definitions for DB_DataObject
  82      *
  83      * DB_DataObject needs to know about keys that the table has, since it
  84      * won't appear in StatusNet's own keys list. In most cases, this will
  85      * simply reference your keyTypes() function.
  86      *
  87      * @return array list of key field names
  88      */
  89
  90     function keys()
  91     {
  92         return array_keys($this->keyTypes());
  93     }
  94
  95     /**
  96      * return key definitions for Memcached_DataObject
  97      *
  98      * Our caching system uses the same key definitions, but uses a different
  99      * method to get them. This key information is used to store and clear
 100      * cached data, so be sure to list any key that will be used for static
 101      * lookups.
 102      *
 103      * @return array associative array of key definitions, field name to type:
 104      *         'K' for primary key: for compound keys, add an entry for each component;
 105      *         'U' for unique keys: compound keys are not well supported here.
 106      */
 107
 108     function keyTypes()
 109     {
 110         return array('id' => 'K');
 111     }
 112
 113     /**
 114      * Magic formula for non-autoincrementing integer primary keys
 115      *
 116      * If a table has a single integer column as its primary key, DB_DataObject
 117      * assumes that the column is auto-incrementing and makes a sequence table
 118      * to do this incrementation. Since we don't need this for our class, we
 119      * overload this method and return the magic formula that DB_DataObject needs.
 120      *
 121      * @return array magic three-false array that stops auto-incrementing.
 122      */
 123
 124     function sequenceKey()
 125     {
 126         return array(false, false, false);
 127     }
 128
 129     /**
 130      * Save the native Yammer API representation of a message for the pending
 131      * import. Since they come in in reverse chronological order, we need to
 132      * record them all as stubs and then go through from the beginning and
 133      * save them as native notices, or we'll lose ordering and threading
 134      * data.
 135      *
 136      * @param integer $orig_id ID of the notice on Yammer
 137      * @param array $data the message record fetched out of Yammer API returnd data
 138      *
 139      * @return Yammer_notice_stub new object for this value
 140      */
 141
 142     static function record($orig_id, $data)
 143     {
 144         common_debug("Recording Yammer message stub {$orig_id} for pending import...");
 145
 146         $stub = new Yammer_notice_stub();
 147
 148         $stub->id = $orig_id;
 149         $stub->json_data = json_encode($data);
 150         $stub->created = common_sql_now();
 151
 152         $stub->insert();
 153
 154         return $stub;
 155     }
 156
 157     /**
 158      * Save a mapping between a remote Yammer and local imported user.
 159      *
 160      * @param integer $user_id ID of the status in StatusNet
 161      *
 162      * @return Yammer_notice_stub new object for this value
 163      */
 164
 165     static function retrieve($orig_id)
 166     {
 167         $stub = self::staticGet('id', $orig_id);
 168         if ($stub) {
 169             return json_decode($stub->json_data, true);
 170         } else {
 171             return false;
 172         }
 173     }
 174 }