]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - plugins/OStatus/actions/ostatussub.php
Merge branch 'master' into testing
[quix0rs-gnu-social.git] / plugins / OStatus / actions / ostatussub.php
1 <?php
2 /*
3  * StatusNet - the distributed open-source microblogging tool
4  * Copyright (C) 2009-2010, StatusNet, Inc.
5  *
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.
10  *
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.
15  *
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/>.
18  */
19
20 /**
21  * @package OStatusPlugin
22  * @maintainer Brion Vibber <brion@status.net>
23  */
24
25 if (!defined('STATUSNET')) {
26     exit(1);
27 }
28
29 /**
30  * Key UI methods:
31  *
32  *  showInputForm() - form asking for a remote profile account or URL
33  *                    We end up back here on errors
34  *
35  *  showPreviewForm() - surrounding form for preview-and-confirm
36  *    preview() - display profile for a remote user
37  *
38  *  success() - redirects to subscriptions page on subscribe
39  */
40 class OStatusSubAction extends Action
41 {
42     protected $profile_uri; // provided acct: or URI of remote entity
43     protected $oprofile; // Ostatus_profile of remote entity, if valid
44
45     /**
46      * Show the initial form, when we haven't yet been given a valid
47      * remote profile.
48      */
49     function showInputForm()
50     {
51         $user = common_current_user();
52
53         $profile = $user->getProfile();
54
55         $this->elementStart('form', array('method' => 'post',
56                                           'id' => 'form_ostatus_sub',
57                                           'class' => 'form_settings',
58                                           'action' => $this->selfLink()));
59
60         $this->hidden('token', common_session_token());
61
62         $this->elementStart('fieldset', array('id' => 'settings_feeds'));
63
64         $this->elementStart('ul', 'form_data');
65         $this->elementStart('li');
66         $this->input('profile',
67                      // TRANS: Field label for a field that takes an OStatus user address.
68                      _m('Subscribe to'),
69                      $this->profile_uri,
70                      // TRANS: Tooltip for field label "Subscribe to".
71                      _m('OStatus user\'s address, like nickname@example.com or http://example.net/nickname.'));
72         $this->elementEnd('li');
73         $this->elementEnd('ul');
74         // TRANS: Button text.
75         $this->submit('validate', _m('BUTTON','Continue'));
76
77         $this->elementEnd('fieldset');
78
79         $this->elementEnd('form');
80     }
81
82     /**
83      * Show the preview-and-confirm form. We've got a valid remote
84      * profile and are ready to poke it!
85      *
86      * This controls the wrapper form; actual profile display will
87      * be in previewUser() or previewGroup() depending on the type.
88      */
89     function showPreviewForm()
90     {
91         $ok = $this->preview();
92         if (!$ok) {
93             // @fixme maybe provide a cancel button or link back?
94             return;
95         }
96
97         $this->elementStart('div', 'entity_actions');
98         $this->elementStart('ul');
99         $this->elementStart('li', 'entity_subscribe');
100         $this->elementStart('form', array('method' => 'post',
101                                           'id' => 'form_ostatus_sub',
102                                           'class' => 'form_remote_authorize',
103                                           'action' =>
104                                           $this->selfLink()));
105         $this->elementStart('fieldset');
106         $this->hidden('token', common_session_token());
107         $this->hidden('profile', $this->profile_uri);
108         if ($this->oprofile->isGroup()) {
109             // TRANS: Button text.
110             $this->submit('submit', _m('Join'), 'submit', null,
111                          // TRANS: Tooltip for button "Join".
112                          _m('BUTTON','Join this group'));
113         } else {
114             // TRANS: Button text.
115             $this->submit('submit', _m('BUTTON','Confirm'), 'submit', null,
116                          // TRANS: Tooltip for button "Confirm".
117                          _m('Subscribe to this user'));
118         }
119         $this->elementEnd('fieldset');
120         $this->elementEnd('form');
121         $this->elementEnd('li');
122         $this->elementEnd('ul');
123         $this->elementEnd('div');
124     }
125
126     /**
127      * Show a preview for a remote user's profile
128      * @return boolean true if we're ok to try subscribing
129      */
130     function preview()
131     {
132         $oprofile = $this->oprofile;
133         $profile = $oprofile->localProfile();
134
135         $cur = common_current_user();
136         if ($cur->isSubscribed($profile)) {
137             $this->element('div', array('class' => 'error'),
138                            _m('You are already subscribed to this user.'));
139             $ok = false;
140         } else {
141             $ok = true;
142         }
143
144         $avatar = $profile->getAvatar(AVATAR_PROFILE_SIZE);
145         $avatarUrl = $avatar ? $avatar->displayUrl() : false;
146
147         $this->showEntity($profile,
148                           $profile->profileurl,
149                           $avatarUrl,
150                           $profile->bio);
151         return $ok;
152     }
153
154     function showEntity($entity, $profile, $avatar, $note)
155     {
156         $nickname = $entity->nickname;
157         $fullname = $entity->fullname;
158         $homepage = $entity->homepage;
159         $location = $entity->location;
160
161         if (!$avatar) {
162             $avatar = Avatar::defaultImage(AVATAR_PROFILE_SIZE);
163         }
164
165         $this->elementStart('div', 'entity_profile vcard');
166         $this->element('img', array('src' => $avatar,
167                                     'class' => 'photo avatar entity_depiction',
168                                     'width' => AVATAR_PROFILE_SIZE,
169                                     'height' => AVATAR_PROFILE_SIZE,
170                                     'alt' => $nickname));
171
172         $hasFN = ($fullname !== '') ? 'nickname' : 'fn nickname entity_nickname';
173         $this->elementStart('a', array('href' => $profile,
174                                        'class' => 'url '.$hasFN));
175         $this->raw($nickname);
176         $this->elementEnd('a');
177
178         if (!is_null($fullname)) {
179             $this->elementStart('div', 'fn entity_fn');
180             $this->raw($fullname);
181             $this->elementEnd('div');
182         }
183
184         if (!is_null($location)) {
185             $this->elementStart('div', 'label entity_location');
186             $this->raw($location);
187             $this->elementEnd('div');
188         }
189
190         if (!is_null($homepage)) {
191             $this->elementStart('a', array('href' => $homepage,
192                                            'class' => 'url entity_url'));
193             $this->raw($homepage);
194             $this->elementEnd('a');
195         }
196
197         if (!is_null($note)) {
198             $this->elementStart('div', 'note entity_note');
199             $this->raw($note);
200             $this->elementEnd('div');
201         }
202         $this->elementEnd('div');
203     }
204
205     /**
206      * Redirect on successful remote user subscription
207      */
208     function success()
209     {
210         $cur = common_current_user();
211         $url = common_local_url('subscriptions', array('nickname' => $cur->nickname));
212         common_redirect($url, 303);
213     }
214
215     /**
216      * Pull data for a remote profile and check if it's valid.
217      * Fills out error UI string in $this->error
218      * Fills out $this->oprofile on success.
219      *
220      * @return boolean
221      */
222     function pullRemoteProfile()
223     {
224         $this->profile_uri = $this->trimmed('profile');
225         try {
226             if (Validate::email($this->profile_uri)) {
227                 $this->oprofile = Ostatus_profile::ensureWebfinger($this->profile_uri);
228             } else if (Validate::uri($this->profile_uri)) {
229                 $this->oprofile = Ostatus_profile::ensureProfileURL($this->profile_uri);
230             } else {
231                 // TRANS: Error message in OStatus plugin. Do not translate the domain names example.com
232                 // TRANS: and example.net, as these are official standard domain names for use in examples.
233                 $this->error = _m("Sorry, we could not reach that address. Please make sure that the OStatus address is like nickname@example.com or http://example.net/nickname.");
234                 common_debug('Invalid address format.', __FILE__);
235                 return false;
236             }
237             return true;
238         } catch (FeedSubBadURLException $e) {
239                 // TRANS: Error message in OStatus plugin. Do not translate the domain names example.com
240                 // TRANS: and example.net, as these are official standard domain names for use in examples.
241             $this->error = _m("Sorry, we could not reach that address. Please make sure that the OStatus address is like nickname@example.com or http://example.net/nickname.");
242             common_debug('Invalid URL or could not reach server.', __FILE__);
243         } catch (FeedSubBadResponseException $e) {
244             // TRANS: Error text.
245             $this->error = _m("Sorry, we could not reach that feed. Please try that OStatus address again later.");
246             common_debug('Cannot read feed; server returned error.', __FILE__);
247         } catch (FeedSubEmptyException $e) {
248             // TRANS: Error text.
249             $this->error = _m("Sorry, we could not reach that feed. Please try that OStatus address again later.");
250             common_debug('Cannot read feed; server returned an empty page.', __FILE__);
251         } catch (FeedSubBadHTMLException $e) {
252             // TRANS: Error text.
253             $this->error = _m("Sorry, we could not reach that feed. Please try that OStatus address again later.");
254             common_debug('Bad HTML, could not find feed link.', __FILE__);
255         } catch (FeedSubNoFeedException $e) {
256             // TRANS: Error text.
257             $this->error = _m("Sorry, we could not reach that feed. Please try that OStatus address again later.");
258             common_debug('Could not find a feed linked from this URL.', __FILE__);
259         } catch (FeedSubUnrecognizedTypeException $e) {
260             // TRANS: Error text.
261             $this->error = _m("Sorry, we could not reach that feed. Please try that OStatus address again later.");
262             common_debug('Not a recognized feed type.', __FILE__);
263         } catch (Exception $e) {
264             // Any new ones we forgot about
265                 // TRANS: Error message in OStatus plugin. Do not translate the domain names example.com
266                 // TRANS: and example.net, as these are official standard domain names for use in examples.
267             $this->error = _m("Sorry, we could not reach that address. Please make sure that the OStatus address is like nickname@example.com or http://example.net/nickname.");
268             common_debug(sprintf('Bad feed URL: %s %s', get_class($e), $e->getMessage()), __FILE__);
269         }
270
271         return false;
272     }
273
274     function validateRemoteProfile()
275     {
276         // Send us to the respective subscription form for conf
277         if ($this->oprofile->isGroup()) {
278             $target = common_local_url('ostatusgroup', array(), array('profile' => $this->profile_uri));
279             common_redirect($target, 303);
280         } else if ($this->oprofile->isPeopletag()) {
281             $target = common_local_url('ostatuspeopletag', array(), array('profile' => $this->profile_uri));
282             common_redirect($target, 303);
283         }
284     }
285
286     /**
287      * Attempt to finalize subscription.
288      * validateFeed must have been run first.
289      *
290      * Calls showForm on failure or success on success.
291      */
292     function saveFeed()
293     {
294         // And subscribe the current user to the local profile
295         $user = common_current_user();
296         $local = $this->oprofile->localProfile();
297         if ($user->isSubscribed($local)) {
298             // TRANS: OStatus remote subscription dialog error.
299             $this->showForm(_m('Already subscribed!'));
300         } elseif (Subscription::start($user, $local)) {
301             $this->success();
302         } else {
303             // TRANS: OStatus remote subscription dialog error.
304             $this->showForm(_m('Remote subscription failed!'));
305         }
306     }
307
308     function prepare($args)
309     {
310         parent::prepare($args);
311
312         if (!common_logged_in()) {
313             // XXX: selfURL() didn't work. :<
314             common_set_returnto($_SERVER['REQUEST_URI']);
315             if (Event::handle('RedirectToLogin', array($this, null))) {
316                 common_redirect(common_local_url('login'), 303);
317             }
318             return false;
319         }
320
321         if ($this->pullRemoteProfile()) {
322             $this->validateRemoteProfile();
323         }
324         return true;
325     }
326
327     /**
328      * Handle the submission.
329      */
330     function handle($args)
331     {
332         parent::handle($args);
333         if ($_SERVER['REQUEST_METHOD'] == 'POST') {
334             $this->handlePost();
335         } else {
336             $this->showForm();
337         }
338     }
339
340     /**
341      * Handle posts to this form
342      *
343      * @return void
344      */
345
346     function handlePost()
347     {
348         // CSRF protection
349         $token = $this->trimmed('token');
350         if (!$token || $token != common_session_token()) {
351             // TRANS: Client error displayed when the session token does not match or is not given.
352             $this->showForm(_m('There was a problem with your session token. '.
353                               'Try again, please.'));
354             return;
355         }
356
357         if ($this->oprofile) {
358             if ($this->arg('submit')) {
359                 $this->saveFeed();
360                 return;
361             }
362         }
363         $this->showForm();
364     }
365
366     /**
367      * Show the appropriate form based on our input state.
368      */
369     function showForm($err=null)
370     {
371         if ($err) {
372             $this->error = $err;
373         }
374         if ($this->boolean('ajax')) {
375             header('Content-Type: text/xml;charset=utf-8');
376             $this->xw->startDocument('1.0', 'UTF-8');
377             $this->elementStart('html');
378             $this->elementStart('head');
379             // TRANS: Form title.
380             $this->element('title', null, _m('Subscribe to user'));
381             $this->elementEnd('head');
382             $this->elementStart('body');
383             $this->showContent();
384             $this->elementEnd('body');
385             $this->elementEnd('html');
386         } else {
387             $this->showPage();
388         }
389     }
390
391     /**
392      * Title of the page
393      *
394      * @return string Title of the page
395      */
396
397     function title()
398     {
399         // TRANS: Page title for OStatus remote subscription form.
400         return _m('Confirm');
401     }
402
403     /**
404      * Instructions for use
405      *
406      * @return instructions for use
407      */
408
409     function getInstructions()
410     {
411         // TRANS: Instructions.
412         return _m('You can subscribe to users from other supported sites. Paste their address or profile URI below:');
413     }
414
415     function showPageNotice()
416     {
417         if (!empty($this->error)) {
418             $this->element('p', 'error', $this->error);
419         }
420     }
421
422     /**
423      * Content area of the page
424      *
425      * Shows a form for associating a remote OStatus account with this
426      * StatusNet account.
427      *
428      * @return void
429      */
430     function showContent()
431     {
432         if ($this->oprofile) {
433             $this->showPreviewForm();
434         } else {
435             $this->showInputForm();
436         }
437     }
438
439     function showScripts()
440     {
441         parent::showScripts();
442         $this->autofocus('feedurl');
443     }
444
445     function selfLink()
446     {
447         return common_local_url('ostatussub');
448     }
449
450     /**
451      * Disable the send-notice form at the top of the page.
452      * This is really just a hack for the broken CSS in the Cloudy theme,
453      * I think; copying from other non-notice-navigation pages that do this
454      * as well. There will be plenty of others also broken.
455      *
456      * @fixme fix the cloudy theme
457      * @fixme do this in a more general way
458      */
459     function showNoticeForm() {
460         // nop
461     }
462 }