3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2010, StatusNet, Inc.
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU Affero General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU Affero General Public License for more details.
16 * You should have received a copy of the GNU Affero General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
21 * Basic client class for Yammer's OAuth/JSON API.
23 * Depends on Favorite plugin
25 * @package YammerImportPlugin
26 * @author Brion Vibber <brion@status.net>
32 function __construct(SNYammerClient $client)
34 $this->client = $client;
38 * Load or create an imported profile from Yammer data.
40 * @param object $item loaded JSON data for Yammer importer
43 function importUser($item)
45 $data = $this->prepUser($item);
46 $nickname = $data['options']['nickname'];
48 $profileId = $this->findImportedUser($data['orig_id']);
50 return Profile::getKV('id', $profileId);
52 $user = User::getKV('nickname', $nickname);
54 if ($user instanceof User) {
55 common_log(LOG_WARNING, "Copying Yammer profile info onto existing user $nickname");
56 $profile = $user->getProfile();
57 $this->savePropertiesOn($profile, $data['options'],
58 array('fullname', 'homepage', 'bio', 'location'));
60 $user = User::register($data['options']);
61 $profile = $user->getProfile();
64 if ($data['avatar']) {
66 $this->saveAvatar($data['avatar'], $profile);
67 } catch (Exception $e) {
68 common_log(LOG_ERR, "Error importing Yammer avatar: " . $e->getMessage());
71 $this->recordImportedUser($data['orig_id'], $profile->id);
77 * Load or create an imported group from Yammer data.
79 * @param object $item loaded JSON data for Yammer importer
82 function importGroup($item)
84 $data = $this->prepGroup($item);
85 $nickname = $data['options']['nickname'];
87 $groupId = $this->findImportedGroup($data['orig_id']);
89 return User_group::getKV('id', $groupId);
91 $local = Local_group::getKV('nickname', $nickname);
93 common_log(LOG_WARNING, "Copying Yammer group info onto existing group $nickname");
94 $group = User_group::getKV('id', $local->group_id);
95 $this->savePropertiesOn($group, $data['options'],
96 array('fullname', 'description'));
98 $group = User_group::register($data['options']);
100 if ($data['avatar']) {
102 $this->saveAvatar($data['avatar'], $group);
103 } catch (Exception $e) {
104 common_log(LOG_ERR, "Error importing Yammer avatar: " . $e->getMessage());
107 $this->recordImportedGroup($data['orig_id'], $group->id);
112 private function savePropertiesOn($target, $options, $propList)
115 $orig = clone($target);
116 foreach ($propList as $prop) {
117 if (!empty($options[$prop]) && $target->$prop != $options[$prop]) {
118 $target->$prop = $options[$prop];
122 $target->update($orig);
126 * Load or create an imported notice from Yammer data.
128 * @param object $item loaded JSON data for Yammer importer
131 function importNotice($item)
133 $data = $this->prepNotice($item);
135 $noticeId = $this->findImportedNotice($data['orig_id']);
137 return Notice::getKV('id', $noticeId);
139 $notice = Notice::getKV('uri', $data['options']['uri']);
140 $content = $data['content'];
141 $user = User::getKV($data['profile']);
143 // Fetch file attachments and add the URLs...
145 foreach ($data['attachments'] as $url) {
147 $upload = $this->saveAttachment($url, $user);
148 $content .= ' ' . $upload->shortUrl();
149 $uploads[] = $upload;
150 } catch (Exception $e) {
151 common_log(LOG_ERR, "Error importing Yammer attachment: " . $e->getMessage());
155 // Here's the meat! Actually save the dang ol' notice.
156 $notice = Notice::saveNew($user->id,
161 // Save "likes" as favorites...
162 foreach ($data['faves'] as $nickname) {
163 $user = User::getKV('nickname', $nickname);
164 if ($user instanceof User) {
166 Fave::addNew($user->getProfile(), $notice);
167 } catch (Exception $e) {
168 // failed, let's move to the next
169 common_debug('YammerImport failed favoriting a notice: '.$e->getMessage());
174 // And finally attach the upload records...
175 foreach ($uploads as $upload) {
176 $upload->attachToNotice($notice);
178 $this->recordImportedNotice($data['orig_id'], $notice->id);
184 * Pull relevant info out of a Yammer data record for a user import.
189 function prepUser($item)
191 if ($item['type'] != 'user') {
192 // TRANS: Exception thrown when a non-user item type is used, but expected.
193 throw new Exception(_m('Wrong item type sent to Yammer user import processing.'));
196 $origId = $item['id'];
197 $origUrl = $item['url'];
199 // @fixme check username rules?
201 $options['nickname'] = $item['name'];
202 $options['fullname'] = trim($item['full_name']);
204 // Avatar... this will be the "_small" variant.
205 // Remove that (pre-extension) suffix to get the orig-size image.
206 $avatar = $item['mugshot_url'];
208 // The following info is only available in full data, not in the reference version.
210 // There can be extensive contact info, but for now we'll only pull the primary email.
211 if (isset($item['contact'])) {
212 foreach ($item['contact']['email_addresses'] as $addr) {
213 if ($addr['type'] == 'primary') {
214 $options['email'] = $addr['address'];
215 $options['email_confirmed'] = true;
221 // There can be multiple external URLs; for now pull the first one as home page.
222 if (isset($item['external_urls'])) {
223 foreach ($item['external_urls'] as $url) {
224 if (common_valid_http_url($url)) {
225 $options['homepage'] = $url;
231 // Combine a few bits into the bio...
233 if (!empty($item['job_title'])) {
234 $bio[] = $item['job_title'];
236 if (!empty($item['summary'])) {
237 $bio[] = $item['summary'];
239 if (!empty($item['expertise'])) {
240 // TRANS: Used as a prefix for the Yammer expertise field contents.
241 $bio[] = _m('Expertise:') . ' ' . $item['expertise'];
243 $options['bio'] = implode("\n\n", $bio);
245 // Pull raw location string, may be lookupable
246 if (!empty($item['location'])) {
247 $options['location'] = $item['location'];
250 // Timezone is in format like 'Pacific Time (US & Canada)'
251 // We need to convert that to a zone id. :P
252 // @fixme timezone not yet supported at registration time :)
253 if (!empty($item['timezone'])) {
254 $tz = $this->timezone($item['timezone']);
256 $options['timezone'] = $tz;
260 return array('orig_id' => $origId,
261 'orig_url' => $origUrl,
263 'options' => $options);
268 * Pull relevant info out of a Yammer data record for a group import.
273 function prepGroup($item)
275 if ($item['type'] != 'group') {
276 // TRANS: Exception thrown when a non-group item type is used, but expected.
277 throw new Exception(_m('Wrong item type sent to Yammer group import processing.'));
280 $origId = $item['id'];
281 $origUrl = $item['url'];
283 $privacy = $item['privacy']; // Warning! only public groups in SN so far
285 $options['nickname'] = $item['name'];
286 $options['fullname'] = $item['full_name'];
287 $options['description'] = $item['description'];
288 $options['created'] = $this->timestamp($item['created_at']);
290 $avatar = $item['mugshot_url']; // as with user profiles...
292 $options['mainpage'] = common_local_url('showgroup',
293 array('nickname' => $options['nickname']));
295 // Set some default vals or User_group::register will whine
296 $options['homepage'] = '';
297 $options['location'] = '';
298 $options['aliases'] = array();
299 // @todo FIXME: What about admin user for the group?
301 $options['local'] = true;
302 return array('orig_id' => $origId,
303 'orig_url' => $origUrl,
304 'options' => $options,
305 'avatar' => $avatar);
309 * Pull relevant info out of a Yammer data record for a notice import.
314 function prepNotice($item)
316 if (isset($item['type']) && $item['type'] != 'message') {
317 // TRANS: Exception thrown when a non-message item type is used, but expected.
318 throw new Exception(_m('Wrong item type sent to Yammer message import processing.'));
321 $origId = $item['id'];
322 $origUrl = $item['url'];
324 $profile = $this->findImportedUser($item['sender_id']);
325 $content = $item['body']['plain'];
329 if ($item['replied_to_id']) {
330 $replyTo = $this->findImportedNotice($item['replied_to_id']);
332 $options['reply_to'] = $replyTo;
335 $options['created'] = $this->timestamp($item['created_at']);
337 if (!empty($item['group_id'])) {
338 $groupId = $this->findImportedGroup($item['group_id']);
340 $options['groups'] = array($groupId);
342 // @fixme if we see a group link inline, don't add this?
343 $group = User_group::getKV('id', $groupId);
344 if ($group instanceof User_group) {
345 $content .= ' !' . $group->nickname;
351 foreach ($item['liked_by']['names'] as $liker) {
352 // "permalink" is the username. wtf?
353 $faves[] = $liker['permalink'];
356 $attachments = array();
357 foreach ($item['attachments'] as $attach) {
358 if ($attach['type'] == 'image' || $attach['type'] == 'file') {
359 $attachments[] = $attach[$attach['type']]['url'];
361 common_log(LOG_WARNING, "Unrecognized Yammer attachment type: " . $attach['type']);
365 return array('orig_id' => $origId,
366 'orig_url' => $origUrl,
367 'profile' => $profile,
368 'content' => $content,
370 'options' => $options,
372 'attachments' => $attachments);
375 private function findImportedUser($origId)
377 $map = Yammer_user::getKV('id', $origId);
378 return $map ? $map->user_id : null;
381 private function findImportedGroup($origId)
383 $map = Yammer_group::getKV('id', $origId);
384 return $map ? $map->group_id : null;
387 private function findImportedNotice($origId)
389 $map = Yammer_notice::getKV('id', $origId);
390 return $map ? $map->notice_id : null;
393 private function recordImportedUser($origId, $userId)
395 Yammer_user::record($origId, $userId);
398 private function recordImportedGroup($origId, $groupId)
400 Yammer_group::record($origId, $groupId);
403 private function recordImportedNotice($origId, $noticeId)
405 Yammer_notice::record($origId, $noticeId);
409 * Normalize timestamp format.
413 private function timestamp($ts)
415 return common_sql_date(strtotime($ts));
418 private function timezone($tz)
421 $known = array('Pacific Time (US & Canada)' => 'America/Los_Angeles',
422 'Eastern Time (US & Canada)' => 'America/New_York');
423 if (array_key_exists($tz, $known)) {
431 * Download and update given avatar image
434 * @param mixed $dest either a Profile or User_group object
435 * @throws Exception in various failure cases
437 private function saveAvatar($url, $dest)
439 // Yammer API data mostly gives us the small variant.
440 // Try hitting the source image if we can!
441 // @fixme no guarantee of this URL scheme I think.
442 $url = preg_replace('/_small(\..*?)$/', '$1', $url);
444 if (!common_valid_http_url($url)) {
445 // TRANS: Server exception thrown when an avatar URL is invalid.
446 // TRANS: %s is the invalid avatar URL.
447 throw new ServerException(sprintf(_m('Invalid avatar URL %s.'), $url));
450 // @fixme this should be better encapsulated
451 // ripped from oauthstore.php (for old OMB client)
452 $temp_filename = tempnam(common_get_temp_dir(), 'listener_avatar');
454 if (!copy($url, $temp_filename)) {
455 // TRANS: Server exception thrown when an avatar could not be fetched.
456 // TRANS: %s is the failed avatar URL.
457 throw new ServerException(sprintf(_m('Unable to fetch avatar from %s.'), $url));
461 // @fixme should we be using different ids?
462 $imagefile = new ImageFile($id, $temp_filename);
463 $filename = Avatar::filename($id,
464 image_type_to_extension($imagefile->type),
467 rename($temp_filename, Avatar::path($filename));
468 } catch (Exception $e) {
469 unlink($temp_filename);
472 // @fixme hardcoded chmod is lame, but seems to be necessary to
473 // keep from accidentally saving images from command-line (queues)
474 // that can't be read from web server, which causes hard-to-notice
475 // problems later on:
477 // http://status.net/open-source/issues/2663
478 chmod(Avatar::path($filename), 0644);
480 $dest->setOriginal($filename);
484 * Fetch an attachment from Yammer and save it into our system.
485 * Unlike avatars, the attachment URLs are guarded by authentication,
486 * so we need to run the HTTP hit through our OAuth API client.
492 * @throws Exception on low-level network or HTTP error
494 private function saveAttachment($url, User $user)
496 // Fetch the attachment...
497 // WARNING: file must fit in memory here :(
498 $body = $this->client->fetchUrl($url);
500 // Save to a temporary file and shove it into our file-attachment space...
502 fwrite($temp, $body);
504 $upload = MediaFile::fromFilehandle($temp, $user->getProfile());
507 } catch (Exception $e) {