plugins/OStatus/actions/ostatusgroup.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 group
  37  *
  38  *  success() - redirects to groups page on join
  39  */
  40 class OStatusGroupAction extends OStatusSubAction
  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     function validateRemoteProfile()
  47     {
  48         if (!$this->oprofile->isGroup()) {
  49             // Send us to the user subscription form for conf
  50             $target = common_local_url('ostatussub', array(), array('profile' => $this->profile_uri));
  51             common_redirect($target, 303);
  52         }
  53     }
  54
  55     /**
  56      * Show the initial form, when we haven't yet been given a valid
  57      * remote profile.
  58      */
  59     function showInputForm()
  60     {
  61         $user = common_current_user();
  62
  63         $profile = $user->getProfile();
  64
  65         $this->elementStart('form', array('method' => 'post',
  66                                           'id' => 'form_ostatus_sub',
  67                                           'class' => 'form_settings',
  68                                           'action' => $this->selfLink()));
  69
  70         $this->hidden('token', common_session_token());
  71
  72         $this->elementStart('fieldset', array('id' => 'settings_feeds'));
  73
  74         $this->elementStart('ul', 'form_data');
  75         $this->elementStart('li');
  76         $this->input('profile',
  77                      // TRANS: Field label.
  78                      _m('Join group'),
  79                      $this->profile_uri,
  80                      // TRANS: Tooltip for field label "Join group". Do not translate the "example.net"
  81                      // TRANS: domain name in the URL, as it is an official standard domain name for examples.
  82                      _m("OStatus group's address, like http://example.net/group/nickname."));
  83         $this->elementEnd('li');
  84         $this->elementEnd('ul');
  85
  86         // TRANS: Button text.
  87         $this->submit('validate', _m('BUTTON','Continue'));
  88
  89         $this->elementEnd('fieldset');
  90
  91         $this->elementEnd('form');
  92     }
  93
  94     /**
  95      * Show a preview for a remote group's profile
  96      * @return boolean true if we're ok to try joining
  97      */
  98     function preview()
  99     {
 100         $oprofile = $this->oprofile;
 101         $group = $oprofile->localGroup();
 102
 103         $cur = common_current_user();
 104         if ($cur->isMember($group)) {
 105             $this->element('div', array('class' => 'error'),
 106                            // TRANS: Error text displayed when trying to join a remote group the user is already a member of.
 107                            _m('You are already a member of this group.'));
 108             $ok = false;
 109         } else {
 110             $ok = true;
 111         }
 112
 113         $this->showEntity($group,
 114                           $group->homeUrl(),
 115                           $group->homepage_logo,
 116                           $group->description);
 117         return $ok;
 118     }
 119
 120     /**
 121      * Redirect on successful remote group join
 122      */
 123     function success()
 124     {
 125         $cur = common_current_user();
 126         $url = common_local_url('usergroups', array('nickname' => $cur->nickname));
 127         common_redirect($url, 303);
 128     }
 129
 130     /**
 131      * Attempt to finalize subscription.
 132      * validateFeed must have been run first.
 133      *
 134      * Calls showForm on failure or success on success.
 135      */
 136     function saveFeed()
 137     {
 138         $user = common_current_user();
 139         $group = $this->oprofile->localGroup();
 140         if ($user->isMember($group)) {
 141             // TRANS: OStatus remote group subscription dialog error.
 142             $this->showForm(_m('Already a member!'));
 143             return;
 144         }
 145
 146         try {
 147             $user->joinGroup($group);
 148         } catch (Exception $e) {
 149             // TRANS: OStatus remote group subscription dialog error.
 150             $this->showForm(_m('Remote group join failed!'));
 151             return;
 152         }
 153
 154         $this->success();
 155     }
 156
 157     /**
 158      * Title of the page
 159      *
 160      * @return string Title of the page
 161      */
 162     function title()
 163     {
 164         // TRANS: Page title for OStatus remote group join form
 165         return _m('Confirm joining remote group');
 166     }
 167
 168     /**
 169      * Instructions for use
 170      *
 171      * @return instructions for use
 172      */
 173     function getInstructions()
 174     {
 175         // TRANS: Form instructions.
 176         return _m('You can subscribe to groups from other supported sites. Paste the group\'s profile URI below:');
 177     }
 178
 179     function selfLink()
 180     {
 181         return common_local_url('ostatusgroup');
 182     }
 183 }