WORK IN PROGRESS: Starting infrastructure to initiate Yammer import from web UI and process it in the background queues. Totally not complete yet.

6 files changed, 613 insertions, 0 deletions

diff --git a/plugins/YammerImport/classes/Yammer_common.php b/plugins/YammerImport/classes/Yammer_common.php
new file mode 100644
index 000000000..81e302ab2
--- /dev/null
+++ b/plugins/YammerImport/classes/Yammer_common.php
@@ -0,0 +1,165 @@
+<?php
+/**
+ * Data class for remembering Yammer import mappings
+ *
+ * PHP version 5
+ *
+ * @category Data
+ * @package  StatusNet
+ * @author   Brion Vibber <brion@status.net>
+ * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
+ * @link     http://status.net/
+ *
+ * StatusNet - the distributed open-source microblogging tool
+ * Copyright (C) 2010, StatusNet, Inc.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.     See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+if (!defined('STATUSNET')) {
+    exit(1);
+}
+
+/**
+ * Common base class for the Yammer import mappings for users, groups, and notices.
+ *
+ * Child classes must override these static methods, since we need to run
+ * on PHP 5.2.x which has no late static binding:
+ * - staticGet (as our other classes)
+ * - schemaDef (call self::doSchemaDef)
+ * - record (call self::doRecord)
+ */
+
+class Yammer_common extends Memcached_DataObject
+{
+    public $__table = 'yammer_XXXX'; // table name
+    public $__field = 'XXXX_id';     // field name to save into
+    public $id;                      // int  primary_key not_null
+    public $user_id;                 // int(4)
+    public $created;                 // datetime
+
+    /**
+     * @fixme add a 'references' thing for the foreign key when we support that
+     */
+    protected static function doSchemaDef($field)
+    {
+        return array(new ColumnDef('id', 'bigint', null,
+                                   false, 'PRI'),
+                     new ColumnDef($field, 'integer', null,
+                                   false, 'UNI'),
+                     new ColumnDef('created', 'datetime', null,
+                                   false));
+    }
+
+    /**
+     * return table definition for DB_DataObject
+     *
+     * DB_DataObject needs to know something about the table to manipulate
+     * instances. This method provides all the DB_DataObject needs to know.
+     *
+     * @return array array of column definitions
+     */
+
+    function table()
+    {
+        return array('id'           => DB_DATAOBJECT_INT + DB_DATAOBJECT_NOTNULL,
+                     $this->__field => DB_DATAOBJECT_INT + DB_DATAOBJECT_NOTNULL,
+                     'created'      => DB_DATAOBJECT_STR + DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL);
+    }
+
+    /**
+     * return key definitions for DB_DataObject
+     *
+     * DB_DataObject needs to know about keys that the table has, since it
+     * won't appear in StatusNet's own keys list. In most cases, this will
+     * simply reference your keyTypes() function.
+     *
+     * @return array list of key field names
+     */
+
+    function keys()
+    {
+        return array_keys($this->keyTypes());
+    }
+
+    /**
+     * return key definitions for Memcached_DataObject
+     *
+     * Our caching system uses the same key definitions, but uses a different
+     * method to get them. This key information is used to store and clear
+     * cached data, so be sure to list any key that will be used for static
+     * lookups.
+     *
+     * @return array associative array of key definitions, field name to type:
+     *         'K' for primary key: for compound keys, add an entry for each component;
+     *         'U' for unique keys: compound keys are not well supported here.
+     */
+
+    function keyTypes()
+    {
+        return array('id' => 'K', $this->__field => 'U');
+    }
+
+    /**
+     * Magic formula for non-autoincrementing integer primary keys
+     *
+     * If a table has a single integer column as its primary key, DB_DataObject
+     * assumes that the column is auto-incrementing and makes a sequence table
+     * to do this incrementation. Since we don't need this for our class, we
+     * overload this method and return the magic formula that DB_DataObject needs.
+     *
+     * @return array magic three-false array that stops auto-incrementing.
+     */
+
+    function sequenceKey()
+    {
+        return array(false, false, false);
+    }
+
+    /**
+     * Save a mapping between a remote Yammer and local imported user.
+     *
+     * @param integer $user_id ID of the status in StatusNet
+     * @param integer $orig_id ID of the notice in Yammer
+     *
+     * @return Yammer_common new object for this value
+     */
+
+    protected static function doRecord($class, $field, $orig_id, $local_id)
+    {
+        $map = self::staticGet('id', $orig_id);
+
+        if (!empty($map)) {
+            return $map;
+        }
+
+        $map = self::staticGet($field, $local_id);
+
+        if (!empty($map)) {
+            return $map;
+        }
+
+        common_debug("Mapping Yammer $field {$orig_id} to local $field {$local_id}");
+
+        $map = new $class();
+
+        $map->id = $orig_id;
+        $map->$field = $local_id;
+        $map->created = common_sql_now();
+
+        $map->insert();
+
+        return $map;
+    }
+}
diff --git a/plugins/YammerImport/classes/Yammer_group.php b/plugins/YammerImport/classes/Yammer_group.php
new file mode 100644
index 000000000..4e7a6ebd0
--- /dev/null
+++ b/plugins/YammerImport/classes/Yammer_group.php
@@ -0,0 +1,79 @@
+<?php
+/**
+ * Data class for remembering Yammer import mappings
+ *
+ * PHP version 5
+ *
+ * @category Data
+ * @package  StatusNet
+ * @author   Brion Vibber <brion@status.net>
+ * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
+ * @link     http://status.net/
+ *
+ * StatusNet - the distributed open-source microblogging tool
+ * Copyright (C) 2010, StatusNet, Inc.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.     See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+if (!defined('STATUSNET')) {
+    exit(1);
+}
+
+class Yammer_group extends Yammer_common
+{
+    public $__table = 'yammer_group'; // table name
+    public $__field = 'group_id';     // field to map to
+    public $group_id;                 // int
+
+    /**
+     * Get an instance by key
+     *
+     * This is a utility method to get a single instance with a given key value.
+     *
+     * @param string $k Key to use to lookup
+     * @param mixed  $v Value to lookup
+     *
+     * @return Yammer_group object found, or null for no hits
+     *
+     */
+
+    function staticGet($k, $v=null)
+    {
+        return Memcached_DataObject::staticGet('Yammer_group', $k, $v);
+    }
+
+    /**
+     * Return schema definition to set this table up in onCheckSchema
+     */
+
+    static function schemaDef()
+    {
+        return self::doSchemaDef('group_id');
+    }
+
+    /**
+     * Save a mapping between a remote Yammer and local imported group.
+     *
+     * @param integer $orig_id ID of the notice in Yammer
+     * @param integer $group_id ID of the status in StatusNet
+     *
+     * @return Yammer_group new object for this value
+     */
+
+    static function record($orig_id, $group_id)
+    {
+        return self::doRecord('Yammer_group', 'group_id', $orig_id, $group_id);
+    }
+}
diff --git a/plugins/YammerImport/classes/Yammer_notice.php b/plugins/YammerImport/classes/Yammer_notice.php
new file mode 100644
index 000000000..0f63db630
--- /dev/null
+++ b/plugins/YammerImport/classes/Yammer_notice.php
@@ -0,0 +1,79 @@
+<?php
+/**
+ * Data class for remembering Yammer import mappings
+ *
+ * PHP version 5
+ *
+ * @category Data
+ * @package  StatusNet
+ * @author   Brion Vibber <brion@status.net>
+ * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
+ * @link     http://status.net/
+ *
+ * StatusNet - the distributed open-source microblogging tool
+ * Copyright (C) 2010, StatusNet, Inc.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.     See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+if (!defined('STATUSNET')) {
+    exit(1);
+}
+
+class Yammer_notice extends Yammer_common
+{
+    public $__table = 'yammer_notice'; // table name
+    public $__field = 'notice_id';     // field to map to
+    public $notice_id;                 // int
+
+    /**
+     * Get an instance by key
+     *
+     * This is a utility method to get a single instance with a given key value.
+     *
+     * @param string $k Key to use to lookup
+     * @param mixed  $v Value to lookup
+     *
+     * @return Yammer_notice object found, or null for no hits
+     *
+     */
+
+    function staticGet($k, $v=null)
+    {
+        return Memcached_DataObject::staticGet('Yammer_notice', $k, $v);
+    }
+
+    /**
+     * Return schema definition to set this table up in onCheckSchema
+     */
+
+    static function schemaDef()
+    {
+        return self::doSchemaDef('notice_id');
+    }
+
+    /**
+     * Save a mapping between a remote Yammer and local imported notice.
+     *
+     * @param integer $orig_id ID of the notice in Yammer
+     * @param integer $notice_id ID of the status in StatusNet
+     *
+     * @return Yammer_notice new object for this value
+     */
+
+    static function record($orig_id, $notice_id)
+    {
+        return self::doRecord('Yammer_notice', 'notice_id', $orig_id, $notice_id);
+    }
+}
diff --git a/plugins/YammerImport/classes/Yammer_notice_stub.php b/plugins/YammerImport/classes/Yammer_notice_stub.php
new file mode 100644
index 000000000..98a5e2cf7
--- /dev/null
+++ b/plugins/YammerImport/classes/Yammer_notice_stub.php
@@ -0,0 +1,174 @@
+<?php
+/**
+ * Data class for remembering Yammer import mappings
+ *
+ * PHP version 5
+ *
+ * @category Data
+ * @package  StatusNet
+ * @author   Brion Vibber <brion@status.net>
+ * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
+ * @link     http://status.net/
+ *
+ * StatusNet - the distributed open-source microblogging tool
+ * Copyright (C) 2010, StatusNet, Inc.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.     See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+if (!defined('STATUSNET')) {
+    exit(1);
+}
+
+/**
+ * Temporary storage for imported Yammer messages between fetching and saving
+ * as local notices.
+ *
+ * The Yammer API only allows us to page down from the most recent items; in
+ * order to start saving the oldest notices first, we have to pull them all
+ * down in reverse chronological order, then go back over them from oldest to
+ * newest and actually save them into our notice table.
+ */
+
+class Yammer_notice_stub extends Memcached_DataObject
+{
+    public $__table = 'yammer_notice_stub'; // table name
+    public $id;                             // int  primary_key not_null
+    public $json_data;                      // text
+    public $created;                        // datetime
+
+    /**
+     * Return schema definition to set this table up in onCheckSchema
+     */
+    static function schemaDef($field)
+    {
+        return array(new ColumnDef('id', 'bigint', null,
+                                   false, 'PRI'),
+                     new ColumnDef('json_data', 'text', null,
+                                   false),
+                     new ColumnDef('created', 'datetime', null,
+                                   false));
+    }
+
+    /**
+     * return table definition for DB_DataObject
+     *
+     * DB_DataObject needs to know something about the table to manipulate
+     * instances. This method provides all the DB_DataObject needs to know.
+     *
+     * @return array array of column definitions
+     */
+
+    function table()
+    {
+        return array('id'           => DB_DATAOBJECT_INT + DB_DATAOBJECT_NOTNULL,
+                     'json_data'    => DB_DATAOBJECT_INT + DB_DATAOBJECT_NOTNULL,
+                     'created'      => DB_DATAOBJECT_STR + DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL);
+    }
+
+    /**
+     * return key definitions for DB_DataObject
+     *
+     * DB_DataObject needs to know about keys that the table has, since it
+     * won't appear in StatusNet's own keys list. In most cases, this will
+     * simply reference your keyTypes() function.
+     *
+     * @return array list of key field names
+     */
+
+    function keys()
+    {
+        return array_keys($this->keyTypes());
+    }
+
+    /**
+     * return key definitions for Memcached_DataObject
+     *
+     * Our caching system uses the same key definitions, but uses a different
+     * method to get them. This key information is used to store and clear
+     * cached data, so be sure to list any key that will be used for static
+     * lookups.
+     *
+     * @return array associative array of key definitions, field name to type:
+     *         'K' for primary key: for compound keys, add an entry for each component;
+     *         'U' for unique keys: compound keys are not well supported here.
+     */
+
+    function keyTypes()
+    {
+        return array('id' => 'K');
+    }
+
+    /**
+     * Magic formula for non-autoincrementing integer primary keys
+     *
+     * If a table has a single integer column as its primary key, DB_DataObject
+     * assumes that the column is auto-incrementing and makes a sequence table
+     * to do this incrementation. Since we don't need this for our class, we
+     * overload this method and return the magic formula that DB_DataObject needs.
+     *
+     * @return array magic three-false array that stops auto-incrementing.
+     */
+
+    function sequenceKey()
+    {
+        return array(false, false, false);
+    }
+
+    /**
+     * Save the native Yammer API representation of a message for the pending
+     * import. Since they come in in reverse chronological order, we need to
+     * record them all as stubs and then go through from the beginning and
+     * save them as native notices, or we'll lose ordering and threading
+     * data.
+     *
+     * @param integer $orig_id ID of the notice on Yammer
+     * @param array $data the message record fetched out of Yammer API returnd data
+     *
+     * @return Yammer_notice_stub new object for this value
+     */
+
+    static function record($orig_id, $data)
+    {
+        common_debug("Recording Yammer message stub {$orig_id} for pending import...");
+
+        $stub = new Yammer_notice_stub();
+
+        $stub->id = $orig_id;
+        $stub->json_data = json_encode($data);
+        $stub->created = common_sql_now();
+
+        $stub->insert();
+
+        return $stub;
+    }
+
+    /**
+     * Save a mapping between a remote Yammer and local imported user.
+     *
+     * @param integer $user_id ID of the status in StatusNet
+     *
+     * @return Yammer_notice_stub new object for this value
+     */
+
+    static function retrieve($orig_id)
+    {
+        $stub = self::staticGet('id', $orig_id);
+        if ($stub) {
+            return json_decode($stub->json_data, true);
+        } else {
+            return false;
+        }
+    }
+}
diff --git a/plugins/YammerImport/classes/Yammer_state.php b/plugins/YammerImport/classes/Yammer_state.php
new file mode 100644
index 000000000..a476fd3be
--- /dev/null
+++ b/plugins/YammerImport/classes/Yammer_state.php
@@ -0,0 +1,37 @@
+<?php
+
+/*
+
+yammer_state
+    id
+    state
+    request_token
+    oauth_token
+    users_page
+    groups_page
+    messages_oldest
+    created
+    modified
+
+yammer_user
+    id
+    user_id
+    created
+
+yammer_group
+    id
+    group_id
+    created
+
+yammer_notice
+    id
+    notice_id
+    created
+
+yammer_notice_stub
+    id
+    json_data
+    created
+
+*/
+
diff --git a/plugins/YammerImport/classes/Yammer_user.php b/plugins/YammerImport/classes/Yammer_user.php
new file mode 100644
index 000000000..f6fcd6c3c
--- /dev/null
+++ b/plugins/YammerImport/classes/Yammer_user.php
@@ -0,0 +1,79 @@
+<?php
+/**
+ * Data class for remembering Yammer import mappings
+ *
+ * PHP version 5
+ *
+ * @category Data
+ * @package  StatusNet
+ * @author   Brion Vibber <brion@status.net>
+ * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
+ * @link     http://status.net/
+ *
+ * StatusNet - the distributed open-source microblogging tool
+ * Copyright (C) 2010, StatusNet, Inc.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.     See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+if (!defined('STATUSNET')) {
+    exit(1);
+}
+
+class Yammer_user extends Yammer_common
+{
+    public $__table = 'yammer_user'; // table name
+    public $__field = 'user_id';     // field to map to
+    public $user_id;                 // int
+
+    /**
+     * Get an instance by key
+     *
+     * This is a utility method to get a single instance with a given key value.
+     *
+     * @param string $k Key to use to lookup
+     * @param mixed  $v Value to lookup
+     *
+     * @return Yammer_user object found, or null for no hits
+     *
+     */
+
+    function staticGet($k, $v=null)
+    {
+        return Memcached_DataObject::staticGet('Yammer_user', $k, $v);
+    }
+
+    /**
+     * Return schema definition to set this table up in onCheckSchema
+     */
+
+    static function schemaDef()
+    {
+        return self::doSchemaDef('user_id');
+    }
+
+    /**
+     * Save a mapping between a remote Yammer and local imported user.
+     *
+     * @param integer $orig_id ID of the notice in Yammer
+     * @param integer $user_id ID of the status in StatusNet
+     *
+     * @return Yammer_user new object for this value
+     */
+
+    static function record($orig_id, $user_id)
+    {
+        return self::doRecord('Yammer_user', 'user_id', $orig_id, $user_id);
+    }
+}