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 class Yammer_notice_stub extends Memcached_DataObject
  44 {
  45     public $__table = 'yammer_notice_stub'; // table name
  46     public $id;                             // int  primary_key not_null
  47     public $json_data;                      // text
  48     public $created;                        // datetime
  49
  50     /**
  51      * Get an instance by key
  52      *
  53      * This is a utility method to get a single instance with a given key value.
  54      *
  55      * @param string $k Key to use to lookup
  56      * @param mixed  $v Value to lookup
  57      *
  58      * @return Yammer_notice_stub object found, or null for no hits
  59      */
  60     function staticGet($k, $v=null)
  61     {
  62         return Memcached_DataObject::staticGet('Yammer_notice_stub', $k, $v);
  63     }
  64
  65     /**
  66      * Return schema definition to set this table up in onCheckSchema
  67      */
  68     static function schemaDef()
  69     {
  70         return array(new ColumnDef('id', 'bigint', null,
  71                                    false, 'PRI'),
  72                      new ColumnDef('json_data', 'text', null,
  73                                    false),
  74                      new ColumnDef('created', 'datetime', null,
  75                                    false));
  76     }
  77
  78     /**
  79      * return table definition for DB_DataObject
  80      *
  81      * DB_DataObject needs to know something about the table to manipulate
  82      * instances. This method provides all the DB_DataObject needs to know.
  83      *
  84      * @return array array of column definitions
  85      */
  86     function table()
  87     {
  88         return array('id'           => DB_DATAOBJECT_INT + DB_DATAOBJECT_NOTNULL,
  89                      'json_data'    => DB_DATAOBJECT_STR + DB_DATAOBJECT_NOTNULL,
  90                      'created'      => DB_DATAOBJECT_STR + DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL);
  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     function keyTypes()
 121     {
 122         return array('id' => 'K');
 123     }
 124
 125     /**
 126      * Magic formula for non-autoincrementing integer primary keys
 127      *
 128      * If a table has a single integer column as its primary key, DB_DataObject
 129      * assumes that the column is auto-incrementing and makes a sequence table
 130      * to do this incrementation. Since we don't need this for our class, we
 131      * overload this method and return the magic formula that DB_DataObject needs.
 132      *
 133      * @return array magic three-false array that stops auto-incrementing.
 134      */
 135     function sequenceKey()
 136     {
 137         return array(false, false, false);
 138     }
 139
 140     /**
 141      * Decode the stored data structure.
 142      *
 143      * @return mixed
 144      */
 145     public function getData()
 146     {
 147         return json_decode($this->json_data, true);
 148     }
 149
 150     /**
 151      * Save the native Yammer API representation of a message for the pending
 152      * import. Since they come in in reverse chronological order, we need to
 153      * record them all as stubs and then go through from the beginning and
 154      * save them as native notices, or we'll lose ordering and threading
 155      * data.
 156      *
 157      * @param integer $orig_id ID of the notice on Yammer
 158      * @param array $data the message record fetched out of Yammer API returnd data
 159      *
 160      * @return Yammer_notice_stub new object for this value
 161      */
 162
 163     static function record($orig_id, $data)
 164     {
 165         common_debug("Recording Yammer message stub {$orig_id} for pending import...");
 166
 167         $stub = new Yammer_notice_stub();
 168
 169         $stub->id = $orig_id;
 170         $stub->json_data = json_encode($data);
 171         $stub->created = common_sql_now();
 172
 173         $stub->insert();
 174
 175         return $stub;
 176     }
 177 }