X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=lib%2Fsettingsaction.php;h=fd4885c830223072a9421435def6fb756b448613;hb=fe6498e7c875f5b386a9c7d2cc1fba5677daae09;hp=d74e226d8510cf7a6b35043bc463a8b03319dfda;hpb=3b14b7901c65144835d74b712279d0492c267c0c;p=quix0rs-gnu-social.git

diff --git a/lib/settingsaction.php b/lib/settingsaction.php
index d74e226d85..fd4885c830 100644
--- a/lib/settingsaction.php
+++ b/lib/settingsaction.php
@@ -1,63 +1,181 @@
 <?php
-/* 
- * Laconica - a distributed open-source microblogging tool
- * Copyright (C) 2008, Controlez-Vous, Inc.
- * 
- * This program is free software: you can redistribute it and/or modify
+/**
+ * StatusNet, the distributed open-source microblogging tool
+ *
+ * Base class for settings actions
+ *
+ * PHP version 5
+ *
+ * LICENCE: 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
  * the Free Software Foundation, either version 3 of the License, or
  * (at your option) any later version.
- * 
+ *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU Affero General Public License for more details.
- * 
+ *
  * You should have received a copy of the GNU Affero General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * @category  Settings
+ * @package   StatusNet
+ * @author    Evan Prodromou <evan@status.net>
+ * @copyright 2008-2009 StatusNet, Inc.
+ * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link      http://status.net/
  */
-  
-if (!defined('LACONICA')) { exit(1); }
-
-class SettingsAction extends Action {
-
-	function handle($args) {
-		parent::handle($args);
-		if (!common_logged_in()) {
-			common_user_error(_t('Not logged in.'));
-			return;
-		}
-		if ($this->arg('METHOD') == 'POST') {
-			$this->handle_post();
-		} else {
-			$this->show_form();
-		}
-	}
-
-	# override!
-	function handle_post() {
-		return false;
-	}
-	
-	function show_form($msg=NULL, $success=false) {
-		return false;
-	}
-
-	function show_message($msg, $success) {
-		if ($msg) {
-			common_element('div', ($success) ? 'success' : 'error',
-						   $msg);
-		}
-	}
-	
-	function settings_menu() {
-		common_element_start('ul', 'headmenu');
-		common_menu_item(common_local_url('editprofile'),
-						 _t('Profile'));
-		common_menu_item(common_local_url('avatar'),
-						 _t('Avatar'));
-		common_menu_item(common_local_url('password'),
-						 _t('Password'));
-		common_element_end('ul');
-	}
+
+if (!defined('STATUSNET') && !defined('LACONICA')) {
+    exit(1);
+}
+
+/**
+ * Base class for settings group of actions
+ *
+ * @category Settings
+ * @package  StatusNet
+ * @author   Evan Prodromou <evan@status.net>
+ * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link     http://status.net/
+ *
+ * @see      Widget
+ */
+
+class SettingsAction extends Action
+{
+    /**
+     * A message for the user.
+     */
+
+    var $msg = null;
+
+    /**
+     * Whether the message is a good one or a bad one.
+     */
+
+    var $success = false;
+
+    /**
+     * Handle input and output a page
+     *
+     * @param array $args $_REQUEST arguments
+     *
+     * @return void
+     */
+
+    function handle($args)
+    {
+        parent::handle($args);
+        if (!common_logged_in()) {
+            // TRANS: Error message displayed when trying to perform an action that requires a logged in user.
+            $this->clientError(_('Not logged in.'));
+        } else if (!common_is_real_login()) {
+            // Cookie theft means that automatic logins can't
+            // change important settings or see private info, and
+            // _all_ our settings are important
+            common_set_returnto($this->selfUrl());
+            $user = common_current_user();
+            if (Event::handle('RedirectToLogin', array($this, $user))) {
+                common_redirect(common_local_url('login'), 303);
+            }
+        } else if ($_SERVER['REQUEST_METHOD'] == 'POST') {
+            $this->handlePost();
+        } else {
+            $this->showForm();
+        }
+    }
+
+    /**
+     * Handle a POST request
+     *
+     * @return boolean success flag
+     */
+
+    function handlePost()
+    {
+        return false;
+    }
+
+    /**
+     * show the settings form
+     *
+     * @param string $msg     an extra message for the user
+     * @param string $success good message or bad message?
+     *
+     * @return void
+     */
+
+    function showForm($msg=null, $success=false)
+    {
+        $this->msg     = $msg;
+        $this->success = $success;
+
+        $this->showPage();
+    }
+
+    /**
+     * show human-readable instructions for the page
+     *
+     * @return void
+     */
+
+    function showPageNotice()
+    {
+        if ($this->msg) {
+            $this->element('div', ($this->success) ? 'success' : 'error',
+                           $this->msg);
+        } else {
+            $inst   = $this->getInstructions();
+            $output = common_markup_to_html($inst);
+
+            $this->elementStart('div', 'instructions');
+            $this->raw($output);
+            $this->elementEnd('div');
+        }
+    }
+
+    /**
+     * instructions recipe for sub-classes
+     *
+     * Subclasses should override this to return readable instructions. They'll
+     * be processed by common_markup_to_html().
+     *
+     * @return string instructions text
+     */
+
+    function getInstructions()
+    {
+        return '';
+    }
+
+    /**
+     * Show the local navigation menu
+     *
+     * This is the same for all settings, so we show it here.
+     *
+     * @return void
+     */
+
+    function showLocalNav()
+    {
+        $menu = new SettingsNav($this);
+        $menu->show();
+    }
+
+    /**
+     * Show notice form.
+     *
+     * @return nothing
+     */
+
+    function showNoticeForm()
+    {
+        return;
+    }
+
+    function showProfileBlock()
+    {
+    }
 }