]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - actions/block.php
Add repeat info to statusnet:notice_info Atom element
[quix0rs-gnu-social.git] / actions / block.php
index c1ff7c04462308ef20af2332a268ed2b4b95369b..239a50868d3913614b4fbc16b497bad3624fb3b6 100644 (file)
@@ -1,7 +1,18 @@
 <?php
-/*
- * Laconica - a distributed open-source microblogging tool
- * Copyright (C) 2008, Controlez-Vous, Inc.
+/**
+ * Block a user action class.
+ *
+ * PHP version 5
+ *
+ * @category Action
+ * @package  StatusNet
+ * @author   Evan Prodromou <evan@status.net>
+ * @author   Robin Millette <millette@status.net>
+ * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
+ * @link     http://status.net/
+ *
+ * StatusNet - the distributed open-source microblogging tool
+ * Copyright (C) 2008, 2009, 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
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-if (!defined('LACONICA')) { exit(1); }
+if (!defined('STATUSNET') && !defined('LACONICA')) {
+    exit(1);
+}
+
+/**
+ * Block a user action class.
+ *
+ * @category Action
+ * @package  StatusNet
+ * @author   Evan Prodromou <evan@status.net>
+ * @author   Robin Millette <millette@status.net>
+ * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
+ * @link     http://status.net/
+ */
 
-class BlockAction extends Action
+class BlockAction extends ProfileFormAction
 {
-
     var $profile = null;
 
+    /**
+     * Take arguments for running
+     *
+     * @param array $args $_REQUEST args
+     *
+     * @return boolean success flag
+     */
+
     function prepare($args)
     {
-
-        parent::prepare($args);
-
-        if (!common_logged_in()) {
-            $this->client_error(_('Not logged in.'));
+        if (!parent::prepare($args)) {
             return false;
         }
 
-        $token = $this->trimmed('token');
-
-        if (!$token || $token != common_session_token()) {
-            $this->client_error(_('There was a problem with your session token. Try again, please.'));
-            return;
-        }
-
-        $id = $this->trimmed('blockto');
-
-        if (!$id) {
-            $this->client_error(_('No profile specified.'));
-            return false;
-        }
+        $cur = common_current_user();
 
-        $this->profile = Profile::staticGet('id', $id);
+        assert(!empty($cur)); // checked by parent
 
-        if (!$this->profile) {
-            $this->client_error(_('No profile with that ID.'));
+        if ($cur->hasBlocked($this->profile)) {
+            $this->clientError(_('You already blocked that user.'));
             return false;
         }
 
         return true;
     }
 
+    /**
+     * Handle request
+     *
+     * Shows a page with list of favorite notices
+     *
+     * @param array $args $_REQUEST args; handled in prepare()
+     *
+     * @return void
+     */
+
     function handle($args)
     {
-        parent::handle($args);
         if ($_SERVER['REQUEST_METHOD'] == 'POST') {
-            if ($this->arg('block')) {
-                $this->are_you_sure_form();
-            } else if ($this->arg('no')) {
-                $cur = common_current_user();
-                common_redirect(common_local_url('subscribers',
-                                                 array('nickname' => $cur->nickname)));
-            } else if ($this->arg('yes')) {
-                $this->block_profile();
+            if ($this->arg('no')) {
+                $this->returnToPrevious();
+            } elseif ($this->arg('yes')) {
+                $this->handlePost();
+                $this->returnToPrevious();
+            } else {
+                $this->showPage();
             }
+        } else {
+            $this->showPage();
         }
     }
 
-    function are_you_sure_form()
-    {
+    function showContent() {
+        $this->areYouSureForm();
+    }
 
-        $id = $this->profile->id;
+    function title() {
+        return _('Block user');
+    }
 
-        common_show_header(_('Block user'));
+    function showNoticeForm() {
+        // nop
+    }
+
+    /**
+     * Confirm with user.
+     *
+     * Shows a confirmation form.
+     *
+     * @return void
+     */
+    function areYouSureForm()
+    {
+        // @fixme if we ajaxify the confirmation form, skip the preview on ajax hits
+        $profile = new ArrayWrapper(array($this->profile));
+        $preview = new ProfileList($profile, $this);
+        $preview->show();
 
-        common_element('p', null,
+
+        $id = $this->profile->id;
+        $this->elementStart('form', array('id' => 'block-' . $id,
+                                           'method' => 'post',
+                                           'class' => 'form_settings form_entity_block',
+                                           'action' => common_local_url('block')));
+        $this->elementStart('fieldset');
+        $this->hidden('token', common_session_token());
+        $this->element('legend', _('Block user'));
+        $this->element('p', null,
                        _('Are you sure you want to block this user? '.
                          'Afterwards, they will be unsubscribed from you, '.
                          'unable to subscribe to you in the future, and '.
                          'you will not be notified of any @-replies from them.'));
-
-        common_element_start('form', array('id' => 'block-' . $id,
-                                           'method' => 'post',
-                                           'class' => 'block',
-                                           'action' => common_local_url('block')));
-
-        common_hidden('token', common_session_token());
-
-        common_element('input', array('id' => 'blockto-' . $id,
-                                      'name' => 'blockto',
+        $this->element('input', array('id' => 'blockto-' . $id,
+                                      'name' => 'profileid',
                                       'type' => 'hidden',
                                       'value' => $id));
-
         foreach ($this->args as $k => $v) {
             if (substr($k, 0, 9) == 'returnto-') {
-                common_hidden($k, $v);
+                $this->hidden($k, $v);
             }
         }
-
-        common_submit('no', _('No'));
-        common_submit('yes', _('Yes'));
-
-        common_element_end('form');
-
-        common_show_footer();
+        $this->submit('form_action-no', _('No'), 'submit form_action-primary', 'no', _("Do not block this user"));
+        $this->submit('form_action-yes', _('Yes'), 'submit form_action-secondary', 'yes', _('Block this user'));
+        $this->elementEnd('fieldset');
+        $this->elementEnd('form');
     }
 
-    function block_profile()
-    {
+    /**
+     * Actually block a user.
+     *
+     * @return void
+     */
 
+    function handlePost()
+    {
         $cur = common_current_user();
 
-        if ($cur->hasBlocked($this->profile)) {
-            $this->client_error(_('You have already blocked this user.'));
-            return;
+        if (Event::handle('StartBlockProfile', array($cur, $this->profile))) {
+            $result = $cur->block($this->profile);
+            if ($result) {
+                Event::handle('EndBlockProfile', array($cur, $this->profile));
+            }
         }
 
-        $result = $cur->block($this->profile);
-
         if (!$result) {
-            $this->server_error(_('Failed to save block information.'));
+            $this->serverError(_('Failed to save block information.'));
             return;
         }
+    }
+
+    function showScripts()
+    {
+        parent::showScripts();
+        $this->autofocus('form_action-yes');
+    }
 
-        # Now, gotta figure where we go back to
+    /**
+     * Override for form session token checks; on our first hit we're just
+     * requesting confirmation, which doesn't need a token. We need to be
+     * able to take regular GET requests from email!
+     * 
+     * @throws ClientException if token is bad on POST request or if we have
+     *         confirmation parameters which could trigger something.
+     */
+    function checkSessionToken()
+    {
+        if ($_SERVER['REQUEST_METHOD'] == 'POST' ||
+            $this->arg('yes') ||
+            $this->arg('no')) {
 
-        foreach ($this->args as $k => $v) {
-            if ($k == 'returnto-action') {
-                $action = $v;
-            } else if (substr($k, 0, 9) == 'returnto-') {
-                $args[substr($k, 9)] = $v;
-            }
+            return parent::checkSessionToken();
         }
+    }
 
-        if ($action) {
-            common_redirect(common_local_url($action, $args));
+    /**
+     * If we reached this form without returnto arguments, return to the
+     * current user's subscription list.
+     * 
+     * @return string URL
+     */
+    function defaultReturnTo()
+    {
+        $user = common_current_user();
+        if ($user) {
+            return common_local_url('subscribers',
+                                    array('nickname' => $user->nickname));
         } else {
-            common_redirect(common_local_url('subscriptions',
-                                             array('nickname' => $cur->nickname)));
+            return common_local_url('public');
         }
     }
 }