<?php
-/*
- * Laconica - a distributed open-source microblogging tool
- * Copyright (C) 2008, Controlez-Vous, Inc.
+/**
+ * Laconica, the distributed open-source microblogging tool
*
- * This program is free software: you can redistribute it and/or modify
+ * 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.
*
* 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 Laconica
+ * @author Evan Prodromou <evan@controlyourself.ca>
+ * @copyright 2008-2009 Control Yourself, Inc.
+ * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link http://laconi.ca/
*/
-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;
- } else if ($_SERVER['REQUEST_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 message($msg, $success) {
- if ($msg) {
- common_element('div', ($success) ? 'success' : 'error',
- $msg);
- }
- }
-
- function settings_menu() {
- common_element_start('ul', array('id' => 'nav_views'));
- common_menu_item(common_local_url('profilesettings'),
- _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('LACONICA')) {
+ exit(1);
+}
+
+/**
+ * Base class for settings group of actions
+ *
+ * @category Settings
+ * @package Laconica
+ * @author Evan Prodromou <evan@controlyourself.ca>
+ * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link http://laconi.ca/
+ *
+ * @see Widget
+ */
+
+class SettingsAction extends CurrentUserDesignAction
+{
+ /**
+ * 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()) {
+ $this->clientError(_('Not logged in.'));
+ return;
+ } 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 ($user->hasOpenID()) {
+ common_redirect(common_local_url('openidlogin'), 303);
+ } else {
+ 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 '';
+ }
+
}