gnu-social/plugins/YammerImport/yammerimporter.php
2010-09-28 07:44:21 -07:00

318 lines
9.6 KiB
PHP

<?php
/*
* 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/>.
*/
/**
* Basic client class for Yammer's OAuth/JSON API.
*
* @package YammerImportPlugin
* @author Brion Vibber <brion@status.net>
*/
class YammerImporter
{
protected $users=array();
protected $groups=array();
protected $notices=array();
/**
* Load or create an imported profile from Yammer data.
*
* @param object $item loaded JSON data for Yammer importer
* @return Profile
*/
function importUser($item)
{
$data = $this->prepUser($item);
$profileId = $this->findImportedUser($data['orig_id']);
if ($profileId) {
return Profile::staticGet('id', $profileId);
} else {
$user = User::register($data['options']);
$profile = $user->getProfile();
try {
$this->saveAvatar($data['avatar'], $profile);
} catch (Exception $e) {
common_log(LOG_ERROR, "Error importing Yammer avatar: " . $e->getMessage());
}
$this->recordImportedUser($data['orig_id'], $profile->id);
return $profile;
}
}
/**
* Load or create an imported group from Yammer data.
*
* @param object $item loaded JSON data for Yammer importer
* @return User_group
*/
function importGroup($item)
{
$data = $this->prepGroup($item);
$groupId = $this->findImportedGroup($data['orig_id']);
if ($groupId) {
return User_group::staticGet('id', $groupId);
} else {
$group = User_group::register($data['options']);
try {
$this->saveAvatar($data['avatar'], $group);
} catch (Exception $e) {
common_log(LOG_ERROR, "Error importing Yammer avatar: " . $e->getMessage());
}
$this->recordImportedGroup($data['orig_id'], $group->id);
return $group;
}
}
/**
* Load or create an imported notice from Yammer data.
*
* @param object $item loaded JSON data for Yammer importer
* @return Notice
*/
function importNotice($item)
{
$data = $this->prepNotice($item);
$noticeId = $this->findImportedNotice($data['orig_id']);
if ($noticeId) {
return Notice::staticGet('id', $noticeId);
} else {
$notice = Notice::saveNew($data['profile'],
$data['content'],
$data['source'],
$data['options']);
// @fixme attachments?
$this->recordImportedNotice($data['orig_id'], $notice->id);
return $notice;
}
}
/**
* Pull relevant info out of a Yammer data record for a user import.
*
* @param array $item
* @return array
*/
function prepUser($item)
{
if ($item['type'] != 'user') {
throw new Exception('Wrong item type sent to Yammer user import processing.');
}
$origId = $item['id'];
$origUrl = $item['url'];
// @fixme check username rules?
$options['nickname'] = $item['name'];
$options['fullname'] = trim($item['full_name']);
// We don't appear to have full bio avail here!
$options['bio'] = $item['job_title'];
// What about other data like emails?
// Avatar... this will be the "_small" variant.
// Remove that (pre-extension) suffix to get the orig-size image.
$avatar = $item['mugshot_url'];
// Warning: we don't have following state for other users?
return array('orig_id' => $origId,
'orig_url' => $origUrl,
'avatar' => $avatar,
'options' => $options);
}
/**
* Pull relevant info out of a Yammer data record for a group import.
*
* @param array $item
* @return array
*/
function prepGroup($item)
{
if ($item['type'] != 'group') {
throw new Exception('Wrong item type sent to Yammer group import processing.');
}
$origId = $item['id'];
$origUrl = $item['url'];
$privacy = $item['privacy']; // Warning! only public groups in SN so far
$options['nickname'] = $item['name'];
$options['fullname'] = $item['full_name'];
$options['created'] = $this->timestamp($item['created_at']);
$avatar = $item['mugshot_url']; // as with user profiles...
$options['mainpage'] = common_local_url('showgroup',
array('nickname' => $options['nickname']));
// @fixme what about admin user for the group?
// bio? homepage etc? aliases?
$options['local'] = true;
return array('orig_id' => $origId,
'orig_url' => $origUrl,
'options' => $options);
}
/**
* Pull relevant info out of a Yammer data record for a notice import.
*
* @param array $item
* @return array
*/
function prepNotice($item)
{
if (isset($item['type']) && $item['type'] != 'message') {
throw new Exception('Wrong item type sent to Yammer message import processing.');
}
$origId = $item['id'];
$origUrl = $item['url'];
$profile = $this->findImportedUser($item['sender_id']);
$content = $item['body']['plain'];
$source = 'yammer';
$options = array();
if ($item['replied_to_id']) {
$replyto = $this->findImportedNotice($item['replied_to_id']);
if ($replyto) {
$options['replyto'] = $replyto;
}
}
$options['created'] = $this->timestamp($item['created_at']);
// Parse/save rendered text?
// Save liked info?
// @todo attachments?
return array('orig_id' => $origId,
'orig_url' => $origUrl,
'profile' => $profile,
'content' => $content,
'source' => $source,
'options' => $options);
}
private function findImportedUser($origId)
{
if (isset($this->users[$origId])) {
return $this->users[$origId];
} else {
return false;
}
}
private function findImportedGroup($origId)
{
if (isset($this->groups[$origId])) {
return $this->groups[$origId];
} else {
return false;
}
}
private function findImportedNotice($origId)
{
if (isset($this->notices[$origId])) {
return $this->notices[$origId];
} else {
return false;
}
}
private function recordImportedUser($origId, $userId)
{
$this->users[$origId] = $userId;
}
private function recordImportedGroup($origId, $groupId)
{
$this->groups[$origId] = $groupId;
}
private function recordImportedNotice($origId, $noticeId)
{
$this->notices[$origId] = $noticeId;
}
/**
* Normalize timestamp format.
* @param string $ts
* @return string
*/
private function timestamp($ts)
{
return common_sql_date(strtotime($ts));
}
/**
* Download and update given avatar image
*
* @param string $url
* @param mixed $dest either a Profile or User_group object
* @throws Exception in various failure cases
*/
private function saveAvatar($url, $dest)
{
// Yammer API data mostly gives us the small variant.
// Try hitting the source image if we can!
// @fixme no guarantee of this URL scheme I think.
$url = preg_replace('/_small(\..*?)$/', '$1', $url);
if (!common_valid_http_url($url)) {
throw new ServerException(sprintf(_m("Invalid avatar URL %s."), $url));
}
// @fixme this should be better encapsulated
// ripped from oauthstore.php (for old OMB client)
$temp_filename = tempnam(sys_get_temp_dir(), 'listener_avatar');
if (!copy($url, $temp_filename)) {
throw new ServerException(sprintf(_m("Unable to fetch avatar from %s."), $url));
}
$id = $dest->id;
// @fixme should we be using different ids?
$imagefile = new ImageFile($id, $temp_filename);
$filename = Avatar::filename($id,
image_type_to_extension($imagefile->type),
null,
common_timestamp());
rename($temp_filename, Avatar::path($filename));
// @fixme hardcoded chmod is lame, but seems to be necessary to
// keep from accidentally saving images from command-line (queues)
// that can't be read from web server, which causes hard-to-notice
// problems later on:
//
// http://status.net/open-source/issues/2663
chmod(Avatar::path($filename), 0644);
$dest->setOriginal($filename);
}
}