diff options
-rw-r--r-- | actions/emailsettings.php | 304 | ||||
-rw-r--r-- | lib/action.php | 2 | ||||
-rw-r--r-- | lib/publicgroupnav.php | 16 | ||||
-rw-r--r-- | lib/settingsaction.php | 204 | ||||
-rw-r--r-- | lib/settingsgroupnav.php | 112 |
5 files changed, 450 insertions, 188 deletions
diff --git a/actions/emailsettings.php b/actions/emailsettings.php index 6210c07b4..4cd63a9d3 100644 --- a/actions/emailsettings.php +++ b/actions/emailsettings.php @@ -1,9 +1,12 @@ <?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 + * Settings for email + * + * 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. @@ -15,28 +18,77 @@ * * 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> + * @author Zach Copley <zach@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); } +if (!defined('LACONICA')) { + exit(1); +} -require_once(INSTALLDIR.'/lib/settingsaction.php'); +require_once INSTALLDIR.'/lib/settingsaction.php'; + +/** + * Settings for email + * + * @category Settings + * @package Laconica + * @author Evan Prodromou <evan@controlyourself.ca> + * @author Zach Copley <zach@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 EmailsettingsAction extends SettingsAction { + /** + * Title of the page + * + * @return string Title of the page + */ - function get_instructions() + function title() + { + return _('Email Settings'); + } + + /** + * Instructions for use + * + * @return instructions for use + */ + + function getInstructions() { return _('Manage how you get email from %%site.name%%.'); } - function show_form($msg=null, $success=false) + /** + * Content area of the page + * + * Shows a form for adding and removing email addresses and setting + * email preferences. + * + * @return void + */ + + function showContent() { $user = common_current_user(); - $this->form_header(_('Email Settings'), $msg, $success); + $this->elementStart('form', array('method' => 'post', - 'id' => 'emailsettings', - 'action' => - common_local_url('emailsettings'))); + 'id' => 'emailsettings', + 'action' => + common_local_url('emailsettings'))); + $this->hidden('token', common_session_token()); $this->element('h2', null, _('Address')); @@ -50,12 +102,14 @@ class EmailsettingsAction extends SettingsAction $this->elementEnd('p'); $this->submit('remove', _('Remove')); } else { - $confirm = $this->get_confirmation(); + $confirm = $this->getConfirmation(); if ($confirm) { $this->elementStart('p'); $this->element('span', 'address unconfirmed', $confirm->address); $this->element('span', 'input_instructions', - _('Awaiting confirmation on this address. Check your inbox (and spam box!) for a message with further instructions.')); + _('Awaiting confirmation on this address. '. + 'Check your inbox (and spam box!) for a message '. + 'with further instructions.')); $this->hidden('email', $confirm->address); $this->elementEnd('p'); $this->submit('cancel', _('Cancel')); @@ -69,7 +123,7 @@ class EmailsettingsAction extends SettingsAction if ($user->email) { $this->element('h2', null, _('Incoming email')); - + if ($user->incomingemail) { $this->elementStart('p'); $this->element('span', 'address', $user->incomingemail); @@ -78,21 +132,23 @@ class EmailsettingsAction extends SettingsAction $this->elementEnd('p'); $this->submit('removeincoming', _('Remove')); } - + $this->elementStart('p'); $this->element('span', 'input_instructions', - _('Make a new email address for posting to; cancels the old one.')); + _('Make a new email address for posting to; '. + 'cancels the old one.')); $this->elementEnd('p'); $this->submit('newincoming', _('New')); } - + $this->element('h2', null, _('Preferences')); $this->checkbox('emailnotifysub', _('Send me notices of new subscriptions through email.'), $user->emailnotifysub); $this->checkbox('emailnotifyfav', - _('Send me email when someone adds my notice as a favorite.'), + _('Send me email when someone '. + 'adds my notice as a favorite.'), $user->emailnotifyfav); $this->checkbox('emailnotifymsg', _('Send me email when someone sends me a private message.'), @@ -108,17 +164,25 @@ class EmailsettingsAction extends SettingsAction $user->emailmicroid); $this->submit('save', _('Save')); - + $this->elementEnd('form'); - common_show_footer(); } - function get_confirmation() + /** + * Gets any existing email address confirmations we're waiting for + * + * @return Confirm_address Email address confirmation for user, or null + */ + + function getConfirmation() { $user = common_current_user(); + $confirm = new Confirm_address(); - $confirm->user_id = $user->id; + + $confirm->user_id = $user->id; $confirm->address_type = 'email'; + if ($confirm->find(true)) { return $confirm; } else { @@ -126,57 +190,72 @@ class EmailsettingsAction extends SettingsAction } } - function handle_post() + /** + * Handle posts + * + * Since there are a lot of different options on the page, we + * figure out what we're supposed to do based on which button was + * pushed + * + * @return void + */ + + function handlePost() { - - # CSRF protection + // CSRF protection $token = $this->trimmed('token'); if (!$token || $token != common_session_token()) { - $this->show_form(_('There was a problem with your session token. Try again, please.')); + $this->show_form(_('There was a problem with your session token. '. + 'Try again, please.')); return; } if ($this->arg('save')) { - $this->save_preferences(); + $this->savePreferences(); } else if ($this->arg('add')) { - $this->add_address(); + $this->addAddress(); } else if ($this->arg('cancel')) { - $this->cancel_confirmation(); + $this->cancelConfirmation(); } else if ($this->arg('remove')) { - $this->remove_address(); + $this->removeAddress(); } else if ($this->arg('removeincoming')) { - $this->remove_incoming(); + $this->removeIncoming(); } else if ($this->arg('newincoming')) { - $this->new_incoming(); + $this->newIncoming(); } else { - $this->show_form(_('Unexpected form submission.')); + $this->showForm(_('Unexpected form submission.')); } } - function save_preferences() - { + /** + * Save email preferences + * + * @return void + */ - $emailnotifysub = $this->boolean('emailnotifysub'); - $emailnotifyfav = $this->boolean('emailnotifyfav'); - $emailnotifymsg = $this->boolean('emailnotifymsg'); + function savePreferences() + { + $emailnotifysub = $this->boolean('emailnotifysub'); + $emailnotifyfav = $this->boolean('emailnotifyfav'); + $emailnotifymsg = $this->boolean('emailnotifymsg'); $emailnotifynudge = $this->boolean('emailnotifynudge'); - $emailmicroid = $this->boolean('emailmicroid'); - $emailpost = $this->boolean('emailpost'); + $emailmicroid = $this->boolean('emailmicroid'); + $emailpost = $this->boolean('emailpost'); $user = common_current_user(); - assert(!is_null($user)); # should already be checked + assert(!is_null($user)); // should already be checked $user->query('BEGIN'); $original = clone($user); - $user->emailnotifysub = $emailnotifysub; - $user->emailnotifyfav = $emailnotifyfav; - $user->emailnotifymsg = $emailnotifymsg; + $user->emailnotifysub = $emailnotifysub; + $user->emailnotifyfav = $emailnotifyfav; + $user->emailnotifymsg = $emailnotifymsg; $user->emailnotifynudge = $emailnotifynudge; - $user->emailmicroid = $emailmicroid; - $user->emailpost = $emailpost; + $user->emailmicroid = $emailmicroid; + $user->emailpost = $emailpost; $result = $user->update($original); @@ -188,45 +267,52 @@ class EmailsettingsAction extends SettingsAction $user->query('COMMIT'); - $this->show_form(_('Preferences saved.'), true); + $this->showForm(_('Preferences saved.'), true); } - function add_address() - { + /** + * Add the address passed in by the user + * + * @return void + */ + function addAddress() + { $user = common_current_user(); $email = $this->trimmed('email'); - # Some validation + // Some validation if (!$email) { - $this->show_form(_('No email address.')); + $this->showForm(_('No email address.')); return; } $email = common_canonical_email($email); if (!$email) { - $this->show_form(_('Cannot normalize that email address')); + $this->showForm(_('Cannot normalize that email address')); return; } if (!Validate::email($email, true)) { - $this->show_form(_('Not a valid email address')); + $this->showForm(_('Not a valid email address')); return; } else if ($user->email == $email) { - $this->show_form(_('That is already your email address.')); + $this->showForm(_('That is already your email address.')); return; - } else if ($this->email_exists($email)) { - $this->show_form(_('That email address already belongs to another user.')); + } else if ($this->emailExists($email)) { + $this->showForm(_('That email address already belongs '. + 'to another user.')); return; } - $confirm = new Confirm_address(); - $confirm->address = $email; - $confirm->address_type = 'email'; - $confirm->user_id = $user->id; - $confirm->code = common_confirmation_code(64); + $confirm = new Confirm_address(); + + $confirm->address = $email; + $confirm->address_type = 'email'; + $confirm->user_id = $user->id; + $confirm->code = common_confirmation_code(64); $result = $confirm->insert(); @@ -238,21 +324,31 @@ class EmailsettingsAction extends SettingsAction mail_confirm_address($user, $confirm->code, $user->nickname, $email); - $msg = _('A confirmation code was sent to the email address you added. Check your inbox (and spam box!) for the code and instructions on how to use it.'); + $msg = _('A confirmation code was sent to the email address you added. '. + 'Check your inbox (and spam box!) for the code and instructions '. + 'on how to use it.'); - $this->show_form($msg, true); + $this->showForm($msg, true); } - function cancel_confirmation() + /** + * Handle a request to cancel email confirmation + * + * @return void + */ + + function cancelConfirmation() { $email = $this->arg('email'); - $confirm = $this->get_confirmation(); + + $confirm = $this->getConfirmation(); + if (!$confirm) { - $this->show_form(_('No pending confirmation to cancel.')); + $this->showForm(_('No pending confirmation to cancel.')); return; } if ($confirm->address != $email) { - $this->show_form(_('That is the wrong IM address.')); + $this->showForm(_('That is the wrong IM address.')); return; } @@ -264,26 +360,36 @@ class EmailsettingsAction extends SettingsAction return; } - $this->show_form(_('Confirmation cancelled.'), true); + $this->showForm(_('Confirmation cancelled.'), true); } - function remove_address() - { + /** + * Handle a request to remove an address from the user's account + * + * @return void + */ + function removeAddress() + { $user = common_current_user(); + $email = $this->arg('email'); - # Maybe an old tab open...? + // Maybe an old tab open...? if ($user->email != $email) { - $this->show_form(_('That is not your email address.')); + $this->showForm(_('That is not your email address.')); return; } $user->query('BEGIN'); + $original = clone($user); + $user->email = null; + $result = $user->updateKeys($original); + if (!$result) { common_log_db_error($user, 'UPDATE', __FILE__); $this->serverError(_('Couldn\'t update user.')); @@ -291,48 +397,74 @@ class EmailsettingsAction extends SettingsAction } $user->query('COMMIT'); - $this->show_form(_('The address was removed.'), true); + $this->showForm(_('The address was removed.'), true); } - function remove_incoming() + /** + * Handle a request to remove an incoming email address + * + * @return void + */ + + function removeIncoming() { $user = common_current_user(); - + if (!$user->incomingemail) { - $this->show_form(_('No incoming email address.')); + $this->showForm(_('No incoming email address.')); return; } - + $orig = clone($user); + $user->incomingemail = null; if (!$user->updateKeys($orig)) { common_log_db_error($user, 'UPDATE', __FILE__); $this->serverError(_("Couldn't update user record.")); } - - $this->show_form(_('Incoming email address removed.'), true); + + $this->showForm(_('Incoming email address removed.'), true); } - function new_incoming() + /** + * Generate a new incoming email address + * + * @return void + */ + + function newIncoming() { $user = common_current_user(); - + $orig = clone($user); + $user->incomingemail = mail_new_incoming_address(); - + if (!$user->updateKeys($orig)) { common_log_db_error($user, 'UPDATE', __FILE__); $this->serverError(_("Couldn't update user record.")); } - $this->show_form(_('New incoming email address added.'), true); + $this->showForm(_('New incoming email address added.'), true); } - - function email_exists($email) + + /** + * Does another user already have this email address? + * + * Email addresses are unique for users. + * + * @param string $email Address to check + * + * @return boolean Whether the email already exists. + */ + + function emailExists($email) { $user = common_current_user(); + $other = User::staticGet('email', $email); + if (!$other) { return false; } else { diff --git a/lib/action.php b/lib/action.php index 129a4b24b..5ff536dab 100644 --- a/lib/action.php +++ b/lib/action.php @@ -545,7 +545,7 @@ class Action extends HTMLOutputter // lawsuit common_user_error($msg, $code); } - function self_url() + function selfUrl() { $action = $this->trimmed('action'); $args = $this->args; diff --git a/lib/publicgroupnav.php b/lib/publicgroupnav.php index 7860783fa..5ac4c0e12 100644 --- a/lib/publicgroupnav.php +++ b/lib/publicgroupnav.php @@ -2,7 +2,7 @@ /** * Laconica, the distributed open-source microblogging tool * - * Base class for all actions (~views) + * Menu for public group of actions * * PHP version 5 * @@ -19,10 +19,9 @@ * 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 Action + * @category Menu * @package Laconica * @author Evan Prodromou <evan@controlyourself.ca> - * @author Sarven Capadisli <csarven@controlyourself.ca> * @copyright 2008 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/ @@ -35,22 +34,15 @@ if (!defined('LACONICA')) { require_once INSTALLDIR.'/lib/widget.php'; /** - * Base class for all actions - * - * This is the base class for all actions in the package. An action is - * more or less a "view" in an MVC framework. - * - * Actions are responsible for extracting and validating parameters; using - * model classes to read and write to the database; and doing ouput. + * Menu for public group of actions * * @category Output * @package Laconica * @author Evan Prodromou <evan@controlyourself.ca> - * @author Sarven Capadisli <csarven@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 HTMLOutputter + * @see Widget */ class PublicGroupNav extends Widget diff --git a/lib/settingsaction.php b/lib/settingsaction.php index 03bac3a93..8624803ac 100644 --- a/lib/settingsaction.php +++ b/lib/settingsaction.php @@ -1,9 +1,12 @@ <?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. @@ -15,125 +18,148 @@ * * 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); } +if (!defined('LACONICA')) { + exit(1); +} + +require_once INSTALLDIR.'/lib/settingsgroupnav.php'; + +/** + * 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 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()) { - common_user_error(_('Not 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->self_url()); + // 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()); common_redirect(common_local_url('login')); } else if ($_SERVER['REQUEST_METHOD'] == 'POST') { - $this->handle_post(); + $this->handlePost(); } else { - $this->show_form(); + $this->showForm(); } } - # override! - function handle_post() - { - return false; - } + /** + * Handle a POST request + * + * @return boolean success flag + */ - function show_form($msg=null, $success=false) + function handlePost() { return false; } - function message($msg, $success) - { - if ($msg) { - common_element('div', ($success) ? 'success' : 'error', - $msg); - } - } + /** + * show the settings form + * + * @param string $msg an extra message for the user + * @param string $success good message or bad message? + * + * @return void + */ - function form_header($title, $msg=NULL, $success=false) + function showForm($msg=null, $success=false) { - common_show_header($title, - array($this, 'show_header'), - array($msg, $success), - array($this, 'show_top')); - } + $this->msg = $msg; + $this->success = $success; - function show_header() - { - common_element('link', array('rel' => 'stylesheet', - 'type' => 'text/css', - 'href' => common_path('js/jcrop/jquery.Jcrop.css?version='.LACONICA_VERSION), - 'media' => 'screen, projection, tv')); - common_element('script', array('type' => 'text/javascript', - 'src' => common_path('js/jcrop/jquery.Jcrop.pack.js'))); - common_element('script', array('type' => 'text/javascript', - 'src' => common_path('js/jcrop/jquery.Jcrop.go.js'))); + $this->showPage(); } - function show_top($arr) + /** + * show human-readable instructions for the page + * + * @return void + */ + + function showPageNotice() { - $msg = $arr[0]; - $success = $arr[1]; - if ($msg) { - $this->message($msg, $success); + if ($this->msg) { + $this->element('div', ($this->success) ? 'success' : 'error', + $this->msg); } else { - $inst = $this->get_instructions(); + $inst = $this->getInstructions(); $output = common_markup_to_html($inst); - common_element_start('div', 'instructions'); - common_raw($output); - common_element_end('div'); + + $this->elementStart('div', 'instructions'); + $this->raw($output); + $this->elementEnd('div'); } - $this->settings_menu(); } - function settings_menu() + /** + * 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() { - # action => array('prompt', 'title') - $menu = - array('profilesettings' => - array(_('Profile'), - _('Change your profile settings')), - 'emailsettings' => - array(_('Email'), - _('Change email handling')), - 'openidsettings' => - array(_('OpenID'), - _('Add or remove OpenIDs')), - 'smssettings' => - array(_('SMS'), - _('Updates by SMS')), - 'imsettings' => - array(_('IM'), - _('Updates by instant messenger (IM)')), - 'twittersettings' => - array(_('Twitter'), - _('Twitter integration options')), - 'othersettings' => - array(_('Other'), - _('Other options'))); - - $action = $this->trimmed('action'); - common_element_start('ul', array('id' => 'nav_views')); - foreach ($menu as $menuaction => $menudesc) { - if ($menuaction == 'imsettings' && - !common_config('xmpp', 'enabled')) { - continue; - } - common_menu_item(common_local_url($menuaction), - $menudesc[0], - $menudesc[1], - $action == $menuaction); - } - common_element_end('ul'); + return ''; + } + + /** + * Show the local navigation menu + * + * This is the same for all settings, so we show it here. + * + * @return void + */ + + function showLocalNav() + { + $menu = new SettingsGroupNav($this); + $menu->show(); } } diff --git a/lib/settingsgroupnav.php b/lib/settingsgroupnav.php new file mode 100644 index 000000000..044c74552 --- /dev/null +++ b/lib/settingsgroupnav.php @@ -0,0 +1,112 @@ +<?php +/** + * Laconica, the distributed open-source microblogging tool + * + * Navigation widget for the settings group + * + * 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 Widget + * @package Laconica + * @author Evan Prodromou <evan@controlyourself.ca> + * @copyright 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); +} + +require_once INSTALLDIR.'/lib/widget.php'; + +/** + * A widget for showing the settings group local nav menu + * + * @category Widget + * @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 HTMLOutputter + */ + +class SettingsGroupNav extends Widget +{ + var $action = null; + + /** + * Construction + * + * @param Action $action current action, used for output + */ + + function __construct($action=null) + { + parent::__construct($action); + $this->action = $action; + } + + /** + * Show the menu + * + * @return void + */ + + function show() + { + # action => array('prompt', 'title') + $menu = + array('profilesettings' => + array(_('Profile'), + _('Change your profile settings')), + 'emailsettings' => + array(_('Email'), + _('Change email handling')), + 'openidsettings' => + array(_('OpenID'), + _('Add or remove OpenIDs')), + 'smssettings' => + array(_('SMS'), + _('Updates by SMS')), + 'imsettings' => + array(_('IM'), + _('Updates by instant messenger (IM)')), + 'twittersettings' => + array(_('Twitter'), + _('Twitter integration options')), + 'othersettings' => + array(_('Other'), + _('Other options'))); + + $action_name = $this->action->trimmed('action'); + $this->action->elementStart('ul', array('id' => 'nav_views')); + + foreach ($menu as $menuaction => $menudesc) { + if ($menuaction == 'imsettings' && + !common_config('xmpp', 'enabled')) { + continue; + } + $this->action->menuItem(common_local_url($menuaction), + $menudesc[0], + $menudesc[1], + $action_name == $menuaction); + } + + $this->action->elementEnd('ul'); + } +} |