From 624ca93c9d2a55d7acfca453ba22268d09154dab Mon Sep 17 00:00:00 2001 From: Zach Copley Date: Tue, 20 Jan 2009 17:49:47 -0800 Subject: [PATCH] Converted direct messaging actions to new uiredesign --- actions/inbox.php | 51 ++++----- actions/newmessage.php | 123 ++++++++++++++------- actions/outbox.php | 31 +++--- lib/mailbox.php | 237 +++++++++++++++++++---------------------- lib/personal.php | 43 ++++++-- 5 files changed, 264 insertions(+), 221 deletions(-) diff --git a/actions/inbox.php b/actions/inbox.php index da27814a6e..b553ab26ca 100644 --- a/actions/inbox.php +++ b/actions/inbox.php @@ -46,66 +46,57 @@ require_once INSTALLDIR.'/lib/mailbox.php'; class InboxAction extends MailboxAction { + /** - * returns the title of the page + * Title of the page * - * @param User $user current user - * @param int $page current page - * - * @return string localised title of the page - * - * @see MailboxAction::getTitle() + * @return string page title */ - - function getTitle($user, $page) - { - if ($page > 1) { - $title = sprintf(_("Inbox for %s - page %d"), $user->nickname, $page); + + function title() + { + if ($this->page > 1) { + return sprintf(_("Inbox for %s - page %d"), $this->user->nickname, + $this->page); } else { - $title = sprintf(_("Inbox for %s"), $user->nickname); + return sprintf(_("Inbox for %s"), $this->user->nickname); } - return $title; } /** - * retrieve the messages for this user and this page + * Retrieve the messages for this user and this page * * Does a query for the right messages - * - * @param User $user The current user - * @param int $page The page the user is on - * + * * @return Message data object with stream for messages * * @see MailboxAction::getMessages() */ - function getMessages($user, $page) + function getMessages() { $message = new Message(); - $message->to_profile = $user->id; - + $message->to_profile = $this->user->id; $message->orderBy('created DESC, id DESC'); - $message->limit((($page-1)*MESSAGES_PER_PAGE), MESSAGES_PER_PAGE + 1); + $message->limit((($this->page - 1) * MESSAGES_PER_PAGE), + MESSAGES_PER_PAGE + 1); if ($message->find()) { return $message; - } else { + } else { return null; } } /** - * returns the profile we want to show with the message + * Returns the profile we want to show with the message * - * For inboxes, we show the sender. + * For inboxes, we show the sender; for outboxes, the recipient. * * @param Message $message The message to get the profile for * - * @return Profile The profile of the message sender - * - * @see MailboxAction::getMessageProfile() + * @return Profile The profile that matches the message */ function getMessageProfile($message) @@ -114,7 +105,7 @@ class InboxAction extends MailboxAction } /** - * instructions for using this page + * Instructions for using this page * * @return string localised instructions for using the page */ diff --git a/actions/newmessage.php b/actions/newmessage.php index 510a5f8f37..aa94f8c4fb 100644 --- a/actions/newmessage.php +++ b/actions/newmessage.php @@ -1,9 +1,12 @@ . + * + * @category Personal + * @package Laconica + * @author Evan Prodromou + * @author Zach Copley + * @author Sarven Capadisli + * @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); } +/** + * Action for posting new direct messages + * + * @category Personal + * @package Laconica + * @author Evan Prodromou + * @author Zach Copley + * @author Sarven Capadisli + * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0 + * @link http://laconi.ca/ + */ class NewmessageAction extends Action { + /** + * Error message, if any + */ + + var $msg = null; + + /** + * Title of the page + * + * Note that this usually doesn't get called unless something went wrong + * + * @return string page title + */ + + function title() + { + return _('New message'); + } + + /** + * Handle input, produce output + * + * @param array $args $_REQUEST contents + * + * @return void + */ + function handle($args) { parent::handle($args); @@ -29,38 +82,42 @@ class NewmessageAction extends Action if (!common_logged_in()) { $this->clientError(_('Not logged in.'), 403); } else if ($_SERVER['REQUEST_METHOD'] == 'POST') { - $this->save_new_message(); + $this->saveNewMessage(); } else { - $this->show_form(); + $this->showForm(); } } - function save_new_message() + function saveNewMessage() { $user = common_current_user(); - assert($user); # XXX: maybe an error instead... + assert($user); // XXX: maybe an error instead... - # 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->showForm(_('There was a problem with your session token. ' . + 'Try again, please.')); return; } $content = $this->trimmed('content'); - $to = $this->trimmed('to'); + $to = $this->trimmed('to'); if (!$content) { - $this->show_form(_('No content!')); + $this->showForm(_('No content!')); return; } else { $content_shortened = common_shorten_links($content); if (mb_strlen($content_shortened) > 140) { common_debug("Content = '$content_shortened'", __FILE__); - common_debug("mb_strlen(\$content) = " . mb_strlen($content_shortened), __FILE__); - $this->show_form(_('That\'s too long. Max message size is 140 chars.')); + common_debug("mb_strlen(\$content) = " . + mb_strlen($content_shortened), + __FILE__); + $this->showForm(_('That\'s too long. ' . + 'Max message size is 140 chars.')); return; } } @@ -68,20 +125,21 @@ class NewmessageAction extends Action $other = User::staticGet('id', $to); if (!$other) { - $this->show_form(_('No recipient specified.')); + $this->showForm(_('No recipient specified.')); return; } else if (!$user->mutuallySubscribed($other)) { $this->clientError(_('You can\'t send a message to this user.'), 404); return; } else if ($user->id == $other->id) { - $this->clientError(_('Don\'t send a message to yourself; just say it to yourself quietly instead.'), 403); + $this->clientError(_('Don\'t send a message to yourself; ' . + 'just say it to yourself quietly instead.'), 403); return; } $message = Message::saveNew($user->id, $other->id, $content, 'web'); if (is_string($message)) { - $this->show_form($message); + $this->showForm($message); return; } @@ -92,21 +150,10 @@ class NewmessageAction extends Action common_redirect($url, 303); } - function show_top($params) + function showForm($msg = null) { - - list($content, $user, $to) = $params; - - assert(!is_null($user)); - - common_message_form($content, $user, $to); - } - - function show_form($msg=null) - { - $content = $this->trimmed('content'); - $user = common_current_user(); + $user = common_current_user(); $to = $this->trimmed('to'); @@ -120,22 +167,16 @@ class NewmessageAction extends Action if (!$user->mutuallySubscribed($other)) { $this->clientError(_('You can\'t send a message to this user.'), 404); return; - } + } - common_show_header(_('New message'), null, - array($content, $user, $other), - array($this, 'show_top')); + $this->msg = $msg; - if ($msg) { - $this->element('p', array('id'=>'error'), $msg); - } - - common_show_footer(); + $this->showPage(); } function notify($from, $to, $message) { mail_notify_message($message, $from, $to); - # XXX: Jabber, SMS notifications... probably queued + // XXX: Jabber, SMS notifications... probably queued } } diff --git a/actions/outbox.php b/actions/outbox.php index 9fb6dbf9f8..c8d7f28125 100644 --- a/actions/outbox.php +++ b/actions/outbox.php @@ -47,46 +47,39 @@ require_once INSTALLDIR.'/lib/mailbox.php'; class OutboxAction extends MailboxAction { /** - * returns the title of the page + * Title of the page * - * @param User $user current user - * @param int $page current page - * - * @return string localised title of the page - * - * @see MailboxAction::getTitle() + * @return string page title */ - function getTitle($user, $page) + function title() { - if ($page > 1) { - $title = sprintf(_("Outbox for %s - page %d"), $user->nickname, $page); + if ($this->page > 1) { + return sprintf(_("Outbox for %s - page %d"), + $this->user->nickname, $page); } else { - $title = sprintf(_("Outbox for %s"), $user->nickname); + return sprintf(_("Outbox for %s"), $this->user->nickname); } - return $title; } /** * retrieve the messages for this user and this page * * Does a query for the right messages - * - * @param User $user The current user - * @param int $page The page the user is on - * + * * @return Message data object with stream for messages * * @see MailboxAction::getMessages() */ - function getMessages($user, $page) + function getMessages() { $message = new Message(); - $message->from_profile = $user->id; + $message->from_profile = $this->user->id; $message->orderBy('created DESC, id DESC'); - $message->limit((($page-1)*MESSAGES_PER_PAGE), MESSAGES_PER_PAGE + 1); + $message->limit((($this->page - 1) * MESSAGES_PER_PAGE), + MESSAGES_PER_PAGE + 1); if ($message->find()) { return $message; diff --git a/lib/mailbox.php b/lib/mailbox.php index bdc360a353..9af0dbd2f2 100644 --- a/lib/mailbox.php +++ b/lib/mailbox.php @@ -49,6 +49,23 @@ define('MESSAGES_PER_PAGE', 20); class MailboxAction extends PersonalAction { + var $page = null; + + function prepare($args) + { + parent::prepare($args); + + $nickname = common_canonical_nickname($this->arg('nickname')); + $this->user = User::staticGet('nickname', $nickname); + $this->page = $this->trimmed('page'); + + if (!$this->page) { + $this->page = 1; + } + + return true; + } + /** * output page based on arguments * @@ -61,134 +78,42 @@ class MailboxAction extends PersonalAction { parent::handle($args); - $nickname = common_canonical_nickname($this->arg('nickname')); - - $user = User::staticGet('nickname', $nickname); - - if (!$user) { - $this->client_error(_('No such user.'), 404); + if (!$this->user) { + $this->clientError(_('No such user.'), 404); return; } $cur = common_current_user(); - if (!$cur || $cur->id != $user->id) { - $this->client_error(_('Only the user can read their own mailboxes.'), - 403); + if (!$cur || $cur->id != $this->user->id) { + $this->clientError(_('Only the user can read their own mailboxes.'), + 403); return; } - $profile = $user->getProfile(); - - if (!$profile) { - $this->server_error(_('User has no profile.')); - return; - } - - $page = $this->trimmed('page'); - - if (!$page) { - $page = 1; - } - - $this->showPage($user, $page); + $this->showPage(); } - /** - * returns the title of the page - * - * @param User $user current user - * @param int $page current page - * - * @return string localised title of the page - */ - - function getTitle($user, $page) + function showLocalNav() { - return ''; + $nav = new PersonalGroupNav($this); + $nav->show(); } - /** - * instructions for using this page - * - * @return string localised instructions for using the page - */ - - function getInstructions() + function showNoticeForm() { - return ''; + $message_form = new MessageForm($this); + $message_form->show(); } - /** - * do structured output for the "instructions" are of the page - * - * @return void - */ - - function showTop() + function showContent() { - $cur = common_current_user(); - - common_message_form(null, $cur, null); - - $this->views_menu(); - } - - /** - * show a full page of output - * - * @param User $user The current user - * @param int $page The page the user is on - * - * @return void - */ - - function showPage($user, $page) - { - common_show_header($this->getTitle($user, $page), - null, null, - array($this, 'showTop')); - - $this->showBox($user, $page); - - common_show_footer(); - } - - /** - * retrieve the messages appropriate for this mailbox - * - * Does a query for the right messages - * - * @param User $user The current user - * @param int $page The page the user is on - * - * @return Message data object with stream for messages - */ - - function getMessages($user, $page) - { - return null; - } - - /** - * show the messages for a mailbox in list format - * - * Includes the pagination links (before, after). - * - * @param User $user The current user - * @param int $page The page the user is on - * - * @return void - */ - - function showBox($user, $page) - { - $message = $this->getMessages($user, $page); + $message = $this->getMessages(); if ($message) { $cnt = 0; - common_element_start('ul', array('id' => 'messages')); + $this->elementStart('ul', array('id' => 'messages')); while ($message->fetch() && $cnt <= MESSAGES_PER_PAGE) { $cnt++; @@ -200,17 +125,22 @@ class MailboxAction extends PersonalAction $this->showMessage($message); } - common_element_end('ul'); + $this->elementEnd('ul'); - common_pagination($page > 1, $cnt > MESSAGES_PER_PAGE, - $page, $this->trimmed('action'), - array('nickname' => $user->nickname)); + $this->pagination($this->page > 1, $cnt > MESSAGES_PER_PAGE, + $this->page, $this->trimmed('action'), + array('nickname' => $this->user->nickname)); $message->free(); unset($message); } } + function getMessages() + { + return null; + } + /** * returns the profile we want to show with the message * @@ -229,6 +159,9 @@ class MailboxAction extends PersonalAction /** * show a single message in the list format * + * XXX: This needs to be extracted out into a MessageList similar + * to NoticeList. + * * @param Message $message the message to show * * @return void @@ -236,14 +169,14 @@ class MailboxAction extends PersonalAction function showMessage($message) { - common_element_start('li', array('class' => 'message_single', + $this->elementStart('li', array('class' => 'message_single', 'id' => 'message-' . $message->id)); $profile = $this->getMessageProfile($message); $avatar = $profile->getAvatar(AVATAR_STREAM_SIZE); - common_element_start('a', array('href' => $profile->profileurl)); - common_element('img', array('src' => ($avatar) ? + $this->elementStart('a', array('href' => $profile->profileurl)); + $this->element('img', array('src' => ($avatar) ? common_avatar_display_url($avatar) : common_default_avatar(AVATAR_STREAM_SIZE), 'class' => 'avatar stream', @@ -252,14 +185,14 @@ class MailboxAction extends PersonalAction 'alt' => ($profile->fullname) ? $profile->fullname : $profile->nickname)); - common_element_end('a'); - common_element('a', array('href' => $profile->profileurl, + $this->elementEnd('a'); + $this->element('a', array('href' => $profile->profileurl, 'class' => 'nickname'), $profile->nickname); // FIXME: URL, image, video, audio - common_element_start('p', array('class' => 'content')); - common_raw($message->rendered); - common_element_end('p'); + $this->elementStart('p', array('class' => 'content')); + $this->raw($message->rendered); + $this->elementEnd('p'); $messageurl = common_local_url('showmessage', array('message' => $message->id)); @@ -269,18 +202,72 @@ class MailboxAction extends PersonalAction preg_match('/^http/', $message->uri)) { $messageurl = $message->uri; } - common_element_start('p', 'time'); - common_element('a', array('class' => 'permalink', + $this->elementStart('p', 'time'); + $this->element('a', array('class' => 'permalink', 'href' => $messageurl, 'title' => common_exact_date($message->created)), common_date_string($message->created)); if ($message->source) { - common_text(_(' from ')); - $this->source_link($message->source); + $this->text(_(' from ')); + $this->showSource($message->source); } - common_element_end('p'); + $this->elementEnd('p'); - common_element_end('li'); + $this->elementEnd('li'); } + + /** + * Show the page notice + * + * Shows instructions for the page + * + * @return void + */ + + function showPageNotice() + { + $instr = $this->getInstructions(); + $output = common_markup_to_html($instr); + + $this->elementStart('div', 'instructions'); + $this->raw($output); + $this->elementEnd('div'); + } + + /** + * Show the source of the message + * + * Returns either the name (and link) of the API client that posted the notice, + * or one of other other channels. + * + * @param string $source the source of the message + * + * @return void + */ + + function showSource($source) + { + $source_name = _($source); + switch ($source) { + case 'web': + case 'xmpp': + case 'mail': + case 'omb': + case 'api': + $this->element('span', 'noticesource', $source_name); + break; + default: + $ns = Notice_source::staticGet($source); + if ($ns) { + $this->element('a', array('href' => $ns->url), + $ns->name); + } else { + $this->element('span', 'noticesource', $source_name); + } + break; + } + return; + } + } diff --git a/lib/personal.php b/lib/personal.php index 46f9ff6be7..900df0257f 100644 --- a/lib/personal.php +++ b/lib/personal.php @@ -1,9 +1,12 @@ . + * + * @category Personal + * @package Laconica + * @author Evan Prodromou + * @author Sarven Capadisli + * @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); +} + +/** + * Base class for user profile page + * + * @category Personal + * @package Laconica + * @author Evan Prodromou + * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0 + * @link http://laconi.ca/ + */ class PersonalAction extends Action { + + var $user = null; + + function isReadOnly() + { + return true; + } + function handle($args) { parent::handle($args); - common_set_returnto($this->self_url()); + common_set_returnto($this->selfUrl()); } }