<?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.
*
* 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'));
$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'));
if ($user->email) {
$this->element('h2', null, _('Incoming email'));
-
+
if ($user->incomingemail) {
$this->elementStart('p');
$this->element('span', 'address', $user->incomingemail);
$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.'),
$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 {
}
}
- 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);
$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();
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;
}
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.'));
}
$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 {
projects / quix0rs-gnu-social.git / commitdiff