3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2009, 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 * @package GravatarPlugin
22 * @maintainer Eric Helgeson <erichelgeson@gmail.com>
25 if (!defined('STATUSNET') && !defined('LACONICA')) {
26 // This check helps protect against security problems;
27 // your code file can't be executed directly from the web.
31 class GravatarPlugin extends Plugin
33 function onInitializePlugin()
38 function onStartAvatarFormData($action)
40 $user = common_current_user();
41 $hasGravatar = $this->hasGravatar($user->id);
48 function onEndAvatarFormData($action)
50 $user = common_current_user();
51 $hasGravatar = $this->hasGravatar($user->id);
53 if(!empty($user->email) && !$hasGravatar) { //and not gravatar already set
54 $action->elementStart('form', array('method' => 'post',
55 'id' => 'form_settings_gravatar_add',
56 'class' => 'form_settings',
58 common_local_url('avatarsettings')));
59 $action->elementStart('fieldset', array('id' => 'settings_gravatar_add'));
60 // TRANS: Fieldset legend. Gravatar is an avatar service.
61 $action->element('legend', null, _m('Set Gravatar'));
62 $action->hidden('token', common_session_token());
63 $action->element('p', 'form_guide',
64 // TRANS: Form guide. Gravatar is an avatar service.
65 _m('If you want to use your Gravatar image, click "Add".'));
66 $action->element('input', array('type' => 'submit',
67 'id' => 'settings_gravatar_add_action-submit',
70 // TRANS: Button text to add a Gravatar. Gravatar is an avatar service.
71 'value' => _m('BUTTON','Add')));
72 $action->elementEnd('fieldset');
73 $action->elementEnd('form');
74 } elseif($hasGravatar) {
75 $action->elementStart('form', array('method' => 'post',
76 'id' => 'form_settings_gravatar_remove',
77 'class' => 'form_settings',
79 common_local_url('avatarsettings')));
80 $action->elementStart('fieldset', array('id' => 'settings_gravatar_remove'));
81 // TRANS: Fieldset legend. Gravatar is an avatar service.
82 $action->element('legend', null, _m('Remove Gravatar'));
83 $action->hidden('token', common_session_token());
84 $action->element('p', 'form_guide',
85 // TRANS: Form guide. Gravatar is an avatar service.
86 _m('If you want to remove your Gravatar image, click "Remove".'));
87 $action->element('input', array('type' => 'submit',
88 'id' => 'settings_gravatar_remove_action-submit',
91 // TRANS: Button text to remove a Gravatar. Gravatar is an avatar service.
92 'value' => _m('Remove')));
93 $action->elementEnd('fieldset');
94 $action->elementEnd('form');
96 $action->element('p', 'form_guide',
97 // TRANS: Form guide. Gravatar is an avatar service.
98 _m('To use a Gravatar first enter in an email address.'));
102 function onStartAvatarSaveForm($action)
104 if ($action->arg('add')) {
105 $result = $this->gravatar_save();
107 if($result['success']===true) {
108 common_broadcast_profile(common_current_user()->getProfile());
111 $action->showForm($result['message'], $result['success']);
114 } else if ($action->arg('remove')) {
115 $result = $this->gravatar_remove();
117 if($result['success']===true) {
118 common_broadcast_profile(common_current_user()->getProfile());
121 $action->showForm($result['message'], $result['success']);
129 function hasGravatar($id) {
130 $avatar = new Avatar();
131 $avatar->profile_id = $id;
132 if ($avatar->find()) {
133 while ($avatar->fetch()) {
134 if($avatar->filename == null) {
142 function gravatar_save()
144 $cur = common_current_user();
146 if(empty($cur->email)) {
147 // TRANS: Message displayed when no e-mail address was set when saving Gravatar setting. Gravatar is an avatar service.
148 return array('message' => _m('You do not have an email address set in your profile.'),
151 //Get rid of previous Avatar
152 $this->gravatar_remove();
154 foreach (array(AVATAR_PROFILE_SIZE, AVATAR_STREAM_SIZE, AVATAR_MINI_SIZE) as $size) {
155 $gravatar = new Avatar();
156 $gravatar->profile_id = $cur->id;
157 $gravatar->width = $size;
158 $gravatar->height = $size;
159 $gravatar->original = false; //No file, so no original
160 $gravatar->mediatype = 'img';//XXX: Unsure what to put here
161 //$gravatar->filename = null;//No filename. Remote
162 $gravatar->url = $this->gravatar_url($cur->email, $size);
163 $gravatar->created = DB_DataObject_Cast::dateTime(); # current time
165 if (!$gravatar->insert()) {
166 // TRANS: Message displayed when saving Gravatar setting fails. Gravatar is an avatar service.
167 return array('message' => _m('Failed to save Gravatar to the database.'),
171 // TRANS: Message displayed when Gravatar was added. Gravatar is an avatar service.
172 return array('message' => _m('Gravatar added.'),
176 function gravatar_remove()
178 $user = common_current_user();
179 $profile = $user->getProfile();
181 $avatar = $profile->getOriginalAvatar();
182 if($avatar) $avatar->delete();
183 $avatar = $profile->getAvatar(AVATAR_PROFILE_SIZE);
184 if($avatar) $avatar->delete();
185 $avatar = $profile->getAvatar(AVATAR_STREAM_SIZE);
186 if($avatar) $avatar->delete();
187 $avatar = $profile->getAvatar(AVATAR_MINI_SIZE);
188 if($avatar) $avatar->delete();
190 // TRANS: Message displayed when Gravatar was removed. Gravatar is an avatar service.
191 return array('message' => _m('Gravatar removed.'),
195 function gravatar_url($email, $size)
197 $url = "https://secure.gravatar.com/avatar.php?gravatar_id=".
198 md5(strtolower($email)).
199 "&default=".urlencode(Avatar::defaultImage($size)).
204 function onPluginVersion(&$versions)
206 $versions[] = array('name' => 'Gravatar',
207 'version' => STATUSNET_VERSION,
208 'author' => 'Eric Helgeson',
209 'homepage' => 'http://status.net/wiki/Plugin:Gravatar',
211 // TRANS: Plugin decsription.
212 _m('The Gravatar plugin allows users to use their <a href="http://www.gravatar.com/">Gravatar</a> with StatusNet.'));