1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
|
<?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 $client;
protected $users=array();
protected $groups=array();
protected $notices=array();
function __construct(SN_YammerClient $client)
{
$this->client = $client;
}
/**
* 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 {
$content = $data['content'];
$user = User::staticGet($data['profile']);
// Fetch file attachments and add the URLs...
$uploads = array();
foreach ($data['attachments'] as $url) {
try {
$upload = $this->saveAttachment($url, $user);
$content .= ' ' . $upload->shortUrl();
$uploads[] = $upload;
} catch (Exception $e) {
common_log(LOG_ERROR, "Error importing Yammer attachment: " . $e->getMessage());
}
}
// Here's the meat! Actually save the dang ol' notice.
$notice = Notice::saveNew($user->id,
$content,
$data['source'],
$data['options']);
// Save "likes" as favorites...
foreach ($data['faves'] as $nickname) {
$user = User::staticGet('nickname', $nickname);
if ($user) {
Fave::addNew($user->getProfile(), $notice);
}
}
// And finally attach the upload records...
foreach ($uploads as $upload) {
$upload->attachToNotice($notice);
}
$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']);
// Avatar... this will be the "_small" variant.
// Remove that (pre-extension) suffix to get the orig-size image.
$avatar = $item['mugshot_url'];
// The following info is only available in full data, not in the reference version.
// There can be extensive contact info, but for now we'll only pull the primary email.
if (isset($item['contact'])) {
foreach ($item['contact']['email_addresses'] as $addr) {
if ($addr['type'] == 'primary') {
$options['email'] = $addr['address'];
$options['email_confirmed'] = true;
break;
}
}
}
// There can be multiple external URLs; for now pull the first one as home page.
if (isset($item['external_urls'])) {
foreach ($item['external_urls'] as $url) {
if (common_valid_http_url($url)) {
$options['homepage'] = $url;
break;
}
}
}
// Combine a few bits into the bio...
$bio = array();
if (!empty($item['job_title'])) {
$bio[] = $item['job_title'];
}
if (!empty($item['summary'])) {
$bio[] = $item['summary'];
}
if (!empty($item['expertise'])) {
$bio[] = _m('Expertise:') . ' ' . $item['expertise'];
}
$options['bio'] = implode("\n\n", $bio);
// Pull raw location string, may be lookupable
if (!empty($item['location'])) {
$options['location'] = $item['location'];
}
// Timezone is in format like 'Pacific Time (US & Canada)'
// We need to convert that to a zone id. :P
// @fixme timezone not yet supported at registration time :)
if (!empty($item['timezone'])) {
$tz = $this->timezone($item['timezone']);
if ($tz) {
$options['timezone'] = $tz;
}
}
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['description'] = $item['description'];
$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['reply_to'] = $replyTo;
}
}
$options['created'] = $this->timestamp($item['created_at']);
if ($item['group_id']) {
$groupId = $this->findImportedGroup($item['group_id']);
if ($groupId) {
$options['groups'] = array($groupId);
// @fixme if we see a group link inline, don't add this?
$group = User_group::staticGet('id', $groupId);
if ($group) {
$content .= ' !' . $group->nickname;
}
}
}
$faves = array();
foreach ($item['liked_by']['names'] as $liker) {
// "permalink" is the username. wtf?
$faves[] = $liker['permalink'];
}
$attachments = array();
foreach ($item['attachments'] as $attach) {
if ($attach['type'] == 'image' || $attach['type'] == 'file') {
$attachments[] = $attach[$attach['type']]['url'];
} else {
common_log(LOG_WARNING, "Unrecognized Yammer attachment type: " . $attach['type']);
}
}
return array('orig_id' => $origId,
'orig_url' => $origUrl,
'profile' => $profile,
'content' => $content,
'source' => $source,
'options' => $options,
'faves' => $faves,
'attachments' => $attachments);
}
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));
}
private function timezone($tz)
{
// Blaaaaaarf!
$known = array('Pacific Time (US & Canada)' => 'America/Los_Angeles',
'Eastern Time (US & Canada)' => 'America/New_York');
if (array_key_exists($known, $tz)) {
return $known[$tz];
} else {
return false;
}
}
/**
* 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);
}
/**
* Fetch an attachment from Yammer and save it into our system.
* Unlike avatars, the attachment URLs are guarded by authentication,
* so we need to run the HTTP hit through our OAuth API client.
*
* @param string $url
* @param User $user
* @return MediaFile
*
* @throws Exception on low-level network or HTTP error
*/
private function saveAttachment($url, User $user)
{
// Fetch the attachment...
// WARNING: file must fit in memory here :(
$body = $this->client->fetchUrl($url);
// Save to a temporary file and shove it into our file-attachment space...
$temp = tmpfile();
fwrite($temp, $body);
try {
$upload = MediaFile::fromFileHandle($temp, $user);
fclose($temp);
return $upload;
} catch (Exception $e) {
fclose($temp);
throw $e;
}
}
}
|