From 073ec99c54ad66e42dea1af62bab646aa9e48564 Mon Sep 17 00:00:00 2001 From: Evan Prodromou Date: Mon, 22 Dec 2008 14:50:41 -0500 Subject: bring mailbox.php into line with PEAR Coding Standards (mostly) darcs-hash:20081222195041-84dde-3cc82f6b0f3e4e753c9525aa9a881cfb0c25830c.gz --- lib/mailbox.php | 402 +++++++++++++++++++++++++++++++++++--------------------- 1 file changed, 250 insertions(+), 152 deletions(-) (limited to 'lib/mailbox.php') diff --git a/lib/mailbox.php b/lib/mailbox.php index 4ed8d1758..9039c5fda 100644 --- a/lib/mailbox.php +++ b/lib/mailbox.php @@ -1,9 +1,12 @@ . + * + * @category Action + * @package Laconica + * @author Evan Prodromou + * @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/ */ -if (!defined('LACONICA')) { exit(1); } +if (!defined('LACONICA')) { + exit(1); +} -require_once(INSTALLDIR.'/lib/personal.php'); +require_once INSTALLDIR.'/lib/personal.php'; define('MESSAGES_PER_PAGE', 20); -class MailboxAction extends PersonalAction { - - function handle($args) { - - parent::handle($args); - - $nickname = common_canonical_nickname($this->arg('nickname')); - $user = User::staticGet('nickname', $nickname); - - if (!$user) { - $this->client_error(_('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); - return; - } - - $profile = $user->getProfile(); - - if (!$profile) { - $this->server_error(_('User has no profile.')); - return; - } - - $page = $this->trimmed('page'); - - if (!$page) { - $page = 1; - } - - $this->show_page($user, $page); - } - - function get_title($user, $page) { - return ''; - } - - function get_instructions() { - return ''; - } - - function show_top() { - - $cur = common_current_user(); - - common_message_form(NULL, $cur, NULL); - - $this->views_menu(); - } - - function show_page($user, $page) { - - common_show_header($this->get_title($user, $page), - NULL, NULL, - array($this, 'show_top')); - - $this->show_box($user, $page); - - common_show_footer(); - } - - function show_box($user, $page) { - - $message = $this->get_messages($user, $page); - - if ($message) { - - $cnt = 0; - common_element_start('ul', array('id' => 'messages')); - - while ($message->fetch() && $cnt <= MESSAGES_PER_PAGE) { - $cnt++; - - if ($cnt > MESSAGES_PER_PAGE) { - break; - } - - $this->show_message($message); - } - - common_element_end('ul'); - - common_pagination($page > 1, $cnt > MESSAGES_PER_PAGE, - $page, $this->trimmed('action'), - array('nickname' => $user->nickname)); - - $message->free(); - unset($message); - } - } - - # returns the profile we want to show with the message - - function get_message_profile($message) { - return NULL; - } - - function show_message($message) { - - common_element_start('li', array('class' => 'message_single', - 'id' => 'message-' . $message->id)); - - $profile = $this->get_message_profile($message); - - $avatar = $profile->getAvatar(AVATAR_STREAM_SIZE); - common_element_start('a', array('href' => $profile->profileurl)); - common_element('img', array('src' => ($avatar) ? common_avatar_display_url($avatar) : common_default_avatar(AVATAR_STREAM_SIZE), - 'class' => 'avatar stream', - 'width' => AVATAR_STREAM_SIZE, - 'height' => AVATAR_STREAM_SIZE, - 'alt' => - ($profile->fullname) ? $profile->fullname : - $profile->nickname)); - common_element_end('a'); - common_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'); - - $messageurl = common_local_url('showmessage', array('message' => $message->id)); - - # XXX: we need to figure this out better. Is this right? - if (strcmp($message->uri, $messageurl) != 0 && preg_match('/^http/', $message->uri)) { - $messageurl = $message->uri; - } - common_element_start('p', 'time'); - common_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); - } - - common_element_end('p'); - - common_element_end('li'); - } +/** + * common superclass for direct messages inbox and outbox + * + * @category Action + * @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/ + * @see InboxAction + * @see OutboxAction + */ + +class MailboxAction extends PersonalAction +{ + /** + * output page based on arguments + * + * @param array $args HTTP arguments (from $_REQUEST) + * + * @return void + */ + + function handle($args) + { + parent::handle($args); + + $nickname = common_canonical_nickname($this->arg('nickname')); + + $user = User::staticGet('nickname', $nickname); + + if (!$user) { + $this->client_error(_('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); + return; + } + + $profile = $user->getProfile(); + + if (!$profile) { + $this->server_error(_('User has no profile.')); + return; + } + + $page = $this->trimmed('page'); + + if (!$page) { + $page = 1; + } + + $this->show_page($user, $page); + } + + /** + * returns the title of the page + * + * @param User $user current user + * @param int $page current page + * + * @return string localised title of the page + */ + + function get_title($user, $page) + { + return ''; + } + + /** + * instructions for using this page + * + * @return string localised instructions for using the page + */ + + function get_instructions() + { + return ''; + } + + /** + * do structured output for the "instructions" are of the page + * + * @return void + */ + + function show_top() + { + $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 show_page($user, $page) + { + common_show_header($this->get_title($user, $page), + null, null, + array($this, 'show_top')); + + $this->show_box($user, $page); + + common_show_footer(); + } + + /** + * 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 show_box($user, $page) + { + $message = $this->get_messages($user, $page); + + if ($message) { + + $cnt = 0; + common_element_start('ul', array('id' => 'messages')); + + while ($message->fetch() && $cnt <= MESSAGES_PER_PAGE) { + $cnt++; + + if ($cnt > MESSAGES_PER_PAGE) { + break; + } + + $this->show_message($message); + } + + common_element_end('ul'); + + common_pagination($page > 1, $cnt > MESSAGES_PER_PAGE, + $page, $this->trimmed('action'), + array('nickname' => $user->nickname)); + + $message->free(); + unset($message); + } + } + + /** + * returns the profile we want to show with the message + * + * For inboxes, we show the sender; for outboxes, the recipient. + * + * @param Message $message The message to get the profile for + * + * @return Profile The profile that matches the message + */ + + function get_message_profile($message) + { + return null; + } + + /** + * show a single message in the list format + * + * @param Message $message the message to show + * + * @return void + */ + + function show_message($message) + { + common_element_start('li', array('class' => 'message_single', + 'id' => 'message-' . $message->id)); + + $profile = $this->get_message_profile($message); + + $avatar = $profile->getAvatar(AVATAR_STREAM_SIZE); + common_element_start('a', array('href' => $profile->profileurl)); + common_element('img', array('src' => ($avatar) ? + common_avatar_display_url($avatar) : + common_default_avatar(AVATAR_STREAM_SIZE), + 'class' => 'avatar stream', + 'width' => AVATAR_STREAM_SIZE, + 'height' => AVATAR_STREAM_SIZE, + 'alt' => + ($profile->fullname) ? $profile->fullname : + $profile->nickname)); + common_element_end('a'); + common_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'); + + $messageurl = common_local_url('showmessage', + array('message' => $message->id)); + + // XXX: we need to figure this out better. Is this right? + if (strcmp($message->uri, $messageurl) != 0 && + preg_match('/^http/', $message->uri)) { + $messageurl = $message->uri; + } + common_element_start('p', 'time'); + common_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); + } + + common_element_end('p'); + + common_element_end('li'); + } } -- cgit v1.2.3-54-g00ecf From 2d0aec255f3cc49e246d972a3482f444c5a44980 Mon Sep 17 00:00:00 2001 From: Evan Prodromou Date: Mon, 22 Dec 2008 15:13:04 -0500 Subject: bring messaging section (inbox, outbox, mailbox) into PEAR Code Standards compliance Actually refactored the method names on these classes to come into complete compliance with the code standards. Untested; maybe there are some bad method names now. darcs-hash:20081222201304-84dde-3effcce0f9ef25fbe0bfebd505037d9ff37252fa.gz --- _darcs/inventory | 10 +- ...dde-3effcce0f9ef25fbe0bfebd505037d9ff37252fa.gz | Bin 0 -> 1931 bytes _darcs/pristine/actions/inbox.php | 149 ++++-- _darcs/pristine/actions/outbox.php | 149 ++++-- _darcs/pristine/lib/mailbox.php | 48 +- _darcs/tentative_pristine | 560 ++++++++++----------- actions/inbox.php | 149 ++++-- actions/outbox.php | 149 ++++-- lib/mailbox.php | 48 +- 9 files changed, 777 insertions(+), 485 deletions(-) create mode 100644 _darcs/patches/20081222201304-84dde-3effcce0f9ef25fbe0bfebd505037d9ff37252fa.gz (limited to 'lib/mailbox.php') diff --git a/_darcs/inventory b/_darcs/inventory index 7f21ac58a..083e53fd0 100644 --- a/_darcs/inventory +++ b/_darcs/inventory @@ -35,4 +35,12 @@ Evan Prodromou **20081222173249] [reformat lib/language.php for PEAR Coding Standards Evan Prodromou **20081222193029] [bring mailbox.php into line with PEAR Coding Standards (mostly) -Evan Prodromou **20081222195041] \ No newline at end of file +Evan Prodromou **20081222195041] +[bring messaging section (inbox, outbox, mailbox) into PEAR Code Standards compliance +Evan Prodromou **20081222201304 + + Actually refactored the method names on these classes to come into + complete compliance with the code standards. Untested; maybe there are + some bad method names now. + +] \ No newline at end of file diff --git a/_darcs/patches/20081222201304-84dde-3effcce0f9ef25fbe0bfebd505037d9ff37252fa.gz b/_darcs/patches/20081222201304-84dde-3effcce0f9ef25fbe0bfebd505037d9ff37252fa.gz new file mode 100644 index 000000000..60517eb79 Binary files /dev/null and b/_darcs/patches/20081222201304-84dde-3effcce0f9ef25fbe0bfebd505037d9ff37252fa.gz differ diff --git a/_darcs/pristine/actions/inbox.php b/_darcs/pristine/actions/inbox.php index c752e404e..da27814a6 100644 --- a/_darcs/pristine/actions/inbox.php +++ b/_darcs/pristine/actions/inbox.php @@ -1,9 +1,12 @@ . + * + * @category Message + * @package Laconica + * @author Evan Prodromou + * @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/ + */ + +if (!defined('LACONICA')) { + exit(1); +} + +require_once INSTALLDIR.'/lib/mailbox.php'; + +/** + * action handler for message inbox + * + * @category Message + * @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/ + * @see MailboxAction */ -if (!defined('LACONICA')) { exit(1); } - -require_once(INSTALLDIR.'/lib/mailbox.php'); - -class InboxAction extends MailboxAction { - - function get_title($user, $page) { - if ($page > 1) { - $title = sprintf(_("Inbox for %s - page %d"), $user->nickname, $page); - } else { - $title = sprintf(_("Inbox for %s"), $user->nickname); - } - return $title; - } - - function get_messages($user, $page) { - $message = new Message(); - $message->to_profile = $user->id; - $message->orderBy('created DESC, id DESC'); - $message->limit((($page-1)*MESSAGES_PER_PAGE), MESSAGES_PER_PAGE + 1); - - if ($message->find()) { - return $message; - } else { - return NULL; - } - } - - function get_message_profile($message) { - return $message->getFrom(); - } - - function get_instructions() { - return _('This is your inbox, which lists your incoming private messages.'); - } +class InboxAction extends MailboxAction +{ + /** + * returns the title of the page + * + * @param User $user current user + * @param int $page current page + * + * @return string localised title of the page + * + * @see MailboxAction::getTitle() + */ + + function getTitle($user, $page) + { + if ($page > 1) { + $title = sprintf(_("Inbox for %s - page %d"), $user->nickname, $page); + } else { + $title = sprintf(_("Inbox for %s"), $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) + { + $message = new Message(); + + $message->to_profile = $user->id; + + $message->orderBy('created DESC, id DESC'); + $message->limit((($page-1)*MESSAGES_PER_PAGE), MESSAGES_PER_PAGE + 1); + + if ($message->find()) { + return $message; + } else { + return null; + } + } + + /** + * returns the profile we want to show with the message + * + * For inboxes, we show the sender. + * + * @param Message $message The message to get the profile for + * + * @return Profile The profile of the message sender + * + * @see MailboxAction::getMessageProfile() + */ + + function getMessageProfile($message) + { + return $message->getFrom(); + } + + /** + * instructions for using this page + * + * @return string localised instructions for using the page + */ + + function getInstructions() + { + return _('This is your inbox, which lists your incoming private messages.'); + } } diff --git a/_darcs/pristine/actions/outbox.php b/_darcs/pristine/actions/outbox.php index c48d9c206..9fb6dbf9f 100644 --- a/_darcs/pristine/actions/outbox.php +++ b/_darcs/pristine/actions/outbox.php @@ -1,9 +1,12 @@ . + * + * @category Message + * @package Laconica + * @author Evan Prodromou + * @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/ + */ + +if (!defined('LACONICA')) { + exit(1); +} + +require_once INSTALLDIR.'/lib/mailbox.php'; + +/** + * action handler for message outbox + * + * @category Message + * @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/ + * @see MailboxAction */ -if (!defined('LACONICA')) { exit(1); } - -require_once(INSTALLDIR.'/lib/mailbox.php'); - -class OutboxAction extends MailboxAction { - - function get_title($user, $page) { - if ($page > 1) { - $title = sprintf(_("Outbox for %s - page %d"), $user->nickname, $page); - } else { - $title = sprintf(_("Outbox for %s"), $user->nickname); - } - return $title; - } - - function get_messages($user, $page) { - $message = new Message(); - $message->from_profile = $user->id; - $message->orderBy('created DESC, id DESC'); - $message->limit((($page-1)*MESSAGES_PER_PAGE), MESSAGES_PER_PAGE + 1); - - if ($message->find()) { - return $message; - } else { - return NULL; - } - } - - function get_message_profile($message) { - return $message->getTo(); - } - - function get_instructions() { - return _('This is your outbox, which lists private messages you have sent.'); - } - +class OutboxAction extends MailboxAction +{ + /** + * returns the title of the page + * + * @param User $user current user + * @param int $page current page + * + * @return string localised title of the page + * + * @see MailboxAction::getTitle() + */ + + function getTitle($user, $page) + { + if ($page > 1) { + $title = sprintf(_("Outbox for %s - page %d"), $user->nickname, $page); + } else { + $title = sprintf(_("Outbox for %s"), $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) + { + $message = new Message(); + + $message->from_profile = $user->id; + $message->orderBy('created DESC, id DESC'); + $message->limit((($page-1)*MESSAGES_PER_PAGE), MESSAGES_PER_PAGE + 1); + + if ($message->find()) { + return $message; + } else { + return null; + } + } + + /** + * returns the profile we want to show with the message + * + * For outboxes, we show the recipient. + * + * @param Message $message The message to get the profile for + * + * @return Profile The profile of the message recipient + * + * @see MailboxAction::getMessageProfile() + */ + + function getMessageProfile($message) + { + return $message->getTo(); + } + + /** + * instructions for using this page + * + * @return string localised instructions for using the page + */ + + function getInstructions() + { + return _('This is your outbox, which lists private messages you have sent.'); + } } diff --git a/_darcs/pristine/lib/mailbox.php b/_darcs/pristine/lib/mailbox.php index 9039c5fda..bdc360a35 100644 --- a/_darcs/pristine/lib/mailbox.php +++ b/_darcs/pristine/lib/mailbox.php @@ -19,7 +19,7 @@ * You should have received a copy of the GNU Affero General Public License * along with this program. If not, see . * - * @category Action + * @category Message * @package Laconica * @author Evan Prodromou * @copyright 2008 Control Yourself, Inc. @@ -38,7 +38,7 @@ define('MESSAGES_PER_PAGE', 20); /** * common superclass for direct messages inbox and outbox * - * @category Action + * @category Message * @package Laconica * @author Evan Prodromou * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0 @@ -91,7 +91,7 @@ class MailboxAction extends PersonalAction $page = 1; } - $this->show_page($user, $page); + $this->showPage($user, $page); } /** @@ -103,7 +103,7 @@ class MailboxAction extends PersonalAction * @return string localised title of the page */ - function get_title($user, $page) + function getTitle($user, $page) { return ''; } @@ -114,7 +114,7 @@ class MailboxAction extends PersonalAction * @return string localised instructions for using the page */ - function get_instructions() + function getInstructions() { return ''; } @@ -125,7 +125,7 @@ class MailboxAction extends PersonalAction * @return void */ - function show_top() + function showTop() { $cur = common_current_user(); @@ -143,17 +143,33 @@ class MailboxAction extends PersonalAction * @return void */ - function show_page($user, $page) + function showPage($user, $page) { - common_show_header($this->get_title($user, $page), + common_show_header($this->getTitle($user, $page), null, null, - array($this, 'show_top')); + array($this, 'showTop')); - $this->show_box($user, $page); + $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 * @@ -165,9 +181,9 @@ class MailboxAction extends PersonalAction * @return void */ - function show_box($user, $page) + function showBox($user, $page) { - $message = $this->get_messages($user, $page); + $message = $this->getMessages($user, $page); if ($message) { @@ -181,7 +197,7 @@ class MailboxAction extends PersonalAction break; } - $this->show_message($message); + $this->showMessage($message); } common_element_end('ul'); @@ -205,7 +221,7 @@ class MailboxAction extends PersonalAction * @return Profile The profile that matches the message */ - function get_message_profile($message) + function getMessageProfile($message) { return null; } @@ -218,12 +234,12 @@ class MailboxAction extends PersonalAction * @return void */ - function show_message($message) + function showMessage($message) { common_element_start('li', array('class' => 'message_single', 'id' => 'message-' . $message->id)); - $profile = $this->get_message_profile($message); + $profile = $this->getMessageProfile($message); $avatar = $profile->getAvatar(AVATAR_STREAM_SIZE); common_element_start('a', array('href' => $profile->profileurl)); diff --git a/_darcs/tentative_pristine b/_darcs/tentative_pristine index dd4a35214..5a45154e6 100644 --- a/_darcs/tentative_pristine +++ b/_darcs/tentative_pristine @@ -1,393 +1,365 @@ -hunk ./lib/mailbox.php 2 +hunk ./actions/inbox.php 2 -/* - * Laconica - a distributed open-source microblogging tool - * Copyright (C) 2008, Controlez-Vous, Inc. +/** + * Laconica, the distributed open-source microblogging tool -hunk ./lib/mailbox.php 5 +hunk ./actions/inbox.php 5 - * This program is free software: you can redistribute it and/or modify -+ * common superclass for direct messages inbox and outbox ++ * action handler for message inbox + * + * PHP version 5 + * + * LICENCE: This program is free software: you can redistribute it and/or modify -hunk ./lib/mailbox.php 21 +hunk ./actions/inbox.php 21 + * -+ * @category Action ++ * @category Message + * @package Laconica + * @author Evan Prodromou + * @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/ -hunk ./lib/mailbox.php 30 --if (!defined('LACONICA')) { exit(1); } ++ */ ++ +if (!defined('LACONICA')) { + exit(1); +} -hunk ./lib/mailbox.php 34 --require_once(INSTALLDIR.'/lib/personal.php'); -+require_once INSTALLDIR.'/lib/personal.php'; -hunk ./lib/mailbox.php 38 --class MailboxAction extends PersonalAction { -- -- function handle($args) { ++ ++require_once INSTALLDIR.'/lib/mailbox.php'; ++ +/** -+ * common superclass for direct messages inbox and outbox ++ * action handler for message inbox + * -+ * @category Action ++ * @category Message + * @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/ -+ * @see InboxAction -+ * @see OutboxAction -+ */ -+ -+class MailboxAction extends PersonalAction ++ * @see MailboxAction +hunk ./actions/inbox.php 47 +-if (!defined('LACONICA')) { exit(1); } ++class InboxAction extends MailboxAction +{ + /** -+ * output page based on arguments ++ * returns the title of the page + * -+ * @param array $args HTTP arguments (from $_REQUEST) ++ * @param User $user current user ++ * @param int $page current page + * -+ * @return void ++ * @return string localised title of the page ++ * ++ * @see MailboxAction::getTitle() + */ + -+ function handle($args) ++ function getTitle($user, $page) + { -+ parent::handle($args); -+ -+ $nickname = common_canonical_nickname($this->arg('nickname')); -+ -+ $user = User::staticGet('nickname', $nickname); -+ -+ if (!$user) { -+ $this->client_error(_('No such user.'), 404); -+ return; ++ if ($page > 1) { ++ $title = sprintf(_("Inbox for %s - page %d"), $user->nickname, $page); ++ } else { ++ $title = sprintf(_("Inbox for %s"), $user->nickname); + } ++ return $title; ++ } + -+ $cur = common_current_user(); -+ -+ if (!$cur || $cur->id != $user->id) { -+ $this->client_error(_('Only the user can read their own mailboxes.'), -+ 403); -+ return; -+ } ++ /** ++ * 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() ++ */ + -+ $profile = $user->getProfile(); ++ function getMessages($user, $page) ++ { ++ $message = new Message(); + -+ if (!$profile) { -+ $this->server_error(_('User has no profile.')); -+ return; -+ } ++ $message->to_profile = $user->id; + -+ $page = $this->trimmed('page'); ++ $message->orderBy('created DESC, id DESC'); ++ $message->limit((($page-1)*MESSAGES_PER_PAGE), MESSAGES_PER_PAGE + 1); + -+ if (!$page) { -+ $page = 1; ++ if ($message->find()) { ++ return $message; ++ } else { ++ return null; + } -+ -+ $this->show_page($user, $page); + } + + /** -+ * returns the title of the page ++ * returns the profile we want to show with the message + * -+ * @param User $user current user -+ * @param int $page current page ++ * For inboxes, we show the sender. + * -+ * @return string localised title of the page ++ * @param Message $message The message to get the profile for ++ * ++ * @return Profile The profile of the message sender ++ * ++ * @see MailboxAction::getMessageProfile() + */ -+ -+ function get_title($user, $page) +hunk ./actions/inbox.php 111 +-require_once(INSTALLDIR.'/lib/mailbox.php'); ++ function getMessageProfile($message) + { -+ return ''; ++ return $message->getFrom(); + } -+ +hunk ./actions/inbox.php 116 +-class InboxAction extends MailboxAction { +- +- function get_title($user, $page) { +- if ($page > 1) { +- $title = sprintf(_("Inbox for %s - page %d"), $user->nickname, $page); +- } else { +- $title = sprintf(_("Inbox for %s"), $user->nickname); +- } +- return $title; +- } +- +- function get_messages($user, $page) { +- $message = new Message(); +- $message->to_profile = $user->id; +- $message->orderBy('created DESC, id DESC'); +- $message->limit((($page-1)*MESSAGES_PER_PAGE), MESSAGES_PER_PAGE + 1); + /** + * instructions for using this page + * + * @return string localised instructions for using the page + */ -+ -+ function get_instructions() +hunk ./actions/inbox.php 122 +- if ($message->find()) { +- return $message; +- } else { +- return NULL; +- } +- } +- +- function get_message_profile($message) { +- return $message->getFrom(); +- } +- +- function get_instructions() { +- return _('This is your inbox, which lists your incoming private messages.'); +- } ++ function getInstructions() + { -+ return ''; ++ return _('This is your inbox, which lists your incoming private messages.'); + } +hunk ./actions/outbox.php 2 +-/* +- * Laconica - a distributed open-source microblogging tool +- * Copyright (C) 2008, Controlez-Vous, Inc. ++/** ++ * Laconica, the distributed open-source microblogging tool +hunk ./actions/outbox.php 5 +- * This program is free software: you can redistribute it and/or modify ++ * action handler for message inbox ++ * ++ * PHP version 5 ++ * ++ * LICENCE: This program is free software: you can redistribute it and/or modify +hunk ./actions/outbox.php 21 ++ * ++ * @category Message ++ * @package Laconica ++ * @author Evan Prodromou ++ * @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/ ++ */ + -+ /** -+ * do structured output for the "instructions" are of the page -+ * -+ * @return void -+ */ -+ -+ function show_top() -+ { -+ $cur = common_current_user(); -+ -+ common_message_form(null, $cur, null); ++if (!defined('LACONICA')) { ++ exit(1); ++} + -+ $this->views_menu(); -+ } ++require_once INSTALLDIR.'/lib/mailbox.php'; + ++/** ++ * action handler for message outbox ++ * ++ * @category Message ++ * @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/ ++ * @see MailboxAction +hunk ./actions/outbox.php 47 +-if (!defined('LACONICA')) { exit(1); } ++class OutboxAction extends MailboxAction ++{ + /** -+ * show a full page of output ++ * returns the title of the page + * -+ * @param User $user The current user -+ * @param int $page The page the user is on ++ * @param User $user current user ++ * @param int $page current page ++ * ++ * @return string localised title of the page + * -+ * @return void ++ * @see MailboxAction::getTitle() + */ + -+ function show_page($user, $page) ++ function getTitle($user, $page) + { -+ common_show_header($this->get_title($user, $page), -+ null, null, -+ array($this, 'show_top')); -+ -+ $this->show_box($user, $page); -+ -+ common_show_footer(); ++ if ($page > 1) { ++ $title = sprintf(_("Outbox for %s - page %d"), $user->nickname, $page); ++ } else { ++ $title = sprintf(_("Outbox for %s"), $user->nickname); ++ } ++ return $title; + } + + /** -+ * show the messages for a mailbox in list format ++ * retrieve the messages for this user and this page + * -+ * Includes the pagination links (before, after). ++ * Does a query for the right messages + * + * @param User $user The current user + * @param int $page The page the user is on + * -+ * @return void ++ * @return Message data object with stream for messages ++ * ++ * @see MailboxAction::getMessages() + */ + -+ function show_box($user, $page) ++ function getMessages($user, $page) + { -+ $message = $this->get_messages($user, $page); ++ $message = new Message(); + -+ if ($message) { ++ $message->from_profile = $user->id; ++ $message->orderBy('created DESC, id DESC'); ++ $message->limit((($page-1)*MESSAGES_PER_PAGE), MESSAGES_PER_PAGE + 1); + -+ $cnt = 0; -+ common_element_start('ul', array('id' => 'messages')); -+ -+ while ($message->fetch() && $cnt <= MESSAGES_PER_PAGE) { -+ $cnt++; -hunk ./lib/mailbox.php 180 -- parent::handle($args); -+ if ($cnt > MESSAGES_PER_PAGE) { -+ break; -+ } -hunk ./lib/mailbox.php 184 -- $nickname = common_canonical_nickname($this->arg('nickname')); -- $user = User::staticGet('nickname', $nickname); -+ $this->show_message($message); -+ } -hunk ./lib/mailbox.php 187 -- if (!$user) { -- $this->client_error(_('No such user.'), 404); -- return; -- } -+ common_element_end('ul'); -hunk ./lib/mailbox.php 189 -- $cur = common_current_user(); -- -- if (!$cur || $cur->id != $user->id) { -- $this->client_error(_('Only the user can read their own mailboxes.'), 403); -- return; -- } -- -- $profile = $user->getProfile(); -+ common_pagination($page > 1, $cnt > MESSAGES_PER_PAGE, -+ $page, $this->trimmed('action'), -+ array('nickname' => $user->nickname)); -hunk ./lib/mailbox.php 193 -- if (!$profile) { -- $this->server_error(_('User has no profile.')); -- return; -- } -+ $message->free(); -+ unset($message); ++ if ($message->find()) { ++ return $message; ++ } else { ++ return null; + } + } -hunk ./lib/mailbox.php 198 -- $page = $this->trimmed('page'); -- -- if (!$page) { -- $page = 1; -- } -- -- $this->show_page($user, $page); -- } ++ + /** + * returns the profile we want to show with the message + * -+ * For inboxes, we show the sender; for outboxes, the recipient. ++ * For outboxes, we show the recipient. + * + * @param Message $message The message to get the profile for + * -+ * @return Profile The profile that matches the message ++ * @return Profile The profile of the message recipient ++ * ++ * @see MailboxAction::getMessageProfile() + */ -hunk ./lib/mailbox.php 208 -- function get_title($user, $page) { -- return ''; -- } -+ function get_message_profile($message) +hunk ./actions/outbox.php 110 +-require_once(INSTALLDIR.'/lib/mailbox.php'); ++ function getMessageProfile($message) + { -+ return null; ++ return $message->getTo(); + } -hunk ./lib/mailbox.php 213 -- function get_instructions() { -- return ''; +hunk ./actions/outbox.php 115 +-class OutboxAction extends MailboxAction { +- +- function get_title($user, $page) { +- if ($page > 1) { +- $title = sprintf(_("Outbox for %s - page %d"), $user->nickname, $page); +- } else { +- $title = sprintf(_("Outbox for %s"), $user->nickname); +- } +- return $title; - } +- +- function get_messages($user, $page) { +- $message = new Message(); +- $message->from_profile = $user->id; +- $message->orderBy('created DESC, id DESC'); +- $message->limit((($page-1)*MESSAGES_PER_PAGE), MESSAGES_PER_PAGE + 1); + /** -+ * show a single message in the list format -+ * -+ * @param Message $message the message to show ++ * instructions for using this page + * -+ * @return void ++ * @return string localised instructions for using the page + */ -hunk ./lib/mailbox.php 221 -- function show_top() { -+ function show_message($message) -+ { -+ common_element_start('li', array('class' => 'message_single', -+ 'id' => 'message-' . $message->id)); -hunk ./lib/mailbox.php 226 -- $cur = common_current_user(); -- -- common_message_form(NULL, $cur, NULL); -- -- $this->views_menu(); -- } -- -- function show_page($user, $page) { -+ $profile = $this->get_message_profile($message); -hunk ./lib/mailbox.php 228 -- common_show_header($this->get_title($user, $page), -- NULL, NULL, -- array($this, 'show_top')); -- -- $this->show_box($user, $page); -- -- common_show_footer(); -- } -- -- function show_box($user, $page) { -- -- $message = $this->get_messages($user, $page); -- -- if ($message) { -- -- $cnt = 0; -- common_element_start('ul', array('id' => 'messages')); -- -- while ($message->fetch() && $cnt <= MESSAGES_PER_PAGE) { -- $cnt++; -- -- if ($cnt > MESSAGES_PER_PAGE) { -- break; -- } -- -- $this->show_message($message); -- } -+ $avatar = $profile->getAvatar(AVATAR_STREAM_SIZE); -+ common_element_start('a', array('href' => $profile->profileurl)); -+ common_element('img', array('src' => ($avatar) ? -+ common_avatar_display_url($avatar) : -+ common_default_avatar(AVATAR_STREAM_SIZE), -+ 'class' => 'avatar stream', -+ 'width' => AVATAR_STREAM_SIZE, -+ 'height' => AVATAR_STREAM_SIZE, -+ 'alt' => -+ ($profile->fullname) ? $profile->fullname : -+ $profile->nickname)); -+ common_element_end('a'); -+ common_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'); -hunk ./lib/mailbox.php 248 -- common_element_end('ul'); -- -- common_pagination($page > 1, $cnt > MESSAGES_PER_PAGE, -- $page, $this->trimmed('action'), -- array('nickname' => $user->nickname)); -- -- $message->free(); -- unset($message); +hunk ./actions/outbox.php 121 +- if ($message->find()) { +- return $message; +- } else { +- return NULL; - } - } -+ $messageurl = common_local_url('showmessage', -+ array('message' => $message->id)); -hunk ./lib/mailbox.php 251 -- # returns the profile we want to show with the message - - function get_message_profile($message) { -- return NULL; +- return $message->getTo(); - } - -- function show_message($message) { -+ // XXX: we need to figure this out better. Is this right? -+ if (strcmp($message->uri, $messageurl) != 0 && -+ preg_match('/^http/', $message->uri)) { -+ $messageurl = $message->uri; -+ } -+ common_element_start('p', 'time'); -+ common_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); -+ } -hunk ./lib/mailbox.php 266 -- common_element_start('li', array('class' => 'message_single', -- 'id' => 'message-' . $message->id)); -+ common_element_end('p'); -hunk ./lib/mailbox.php 268 -- $profile = $this->get_message_profile($message); -- -- $avatar = $profile->getAvatar(AVATAR_STREAM_SIZE); -- common_element_start('a', array('href' => $profile->profileurl)); -- common_element('img', array('src' => ($avatar) ? common_avatar_display_url($avatar) : common_default_avatar(AVATAR_STREAM_SIZE), -- 'class' => 'avatar stream', -- 'width' => AVATAR_STREAM_SIZE, -- 'height' => AVATAR_STREAM_SIZE, -- 'alt' => -- ($profile->fullname) ? $profile->fullname : -- $profile->nickname)); -- common_element_end('a'); -- common_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'); -- -- $messageurl = common_local_url('showmessage', array('message' => $message->id)); -- -- # XXX: we need to figure this out better. Is this right? -- if (strcmp($message->uri, $messageurl) != 0 && preg_match('/^http/', $message->uri)) { -- $messageurl = $message->uri; -- } -- common_element_start('p', 'time'); -- common_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); -- } -- -- common_element_end('p'); -- -- common_element_end('li'); +- function get_instructions() { +- return _('This is your outbox, which lists private messages you have sent.'); - } -+ common_element_end('li'); +- ++ function getInstructions() ++ { ++ return _('This is your outbox, which lists private messages you have sent.'); ++ } +hunk ./lib/mailbox.php 22 +- * @category Action ++ * @category Message +hunk ./lib/mailbox.php 41 +- * @category Action ++ * @category Message +hunk ./lib/mailbox.php 94 +- $this->show_page($user, $page); ++ $this->showPage($user, $page); +hunk ./lib/mailbox.php 106 +- function get_title($user, $page) ++ function getTitle($user, $page) +hunk ./lib/mailbox.php 117 +- function get_instructions() ++ function getInstructions() +hunk ./lib/mailbox.php 128 +- function show_top() ++ function showTop() +hunk ./lib/mailbox.php 146 +- function show_page($user, $page) ++ function showPage($user, $page) +hunk ./lib/mailbox.php 148 +- common_show_header($this->get_title($user, $page), ++ common_show_header($this->getTitle($user, $page), +hunk ./lib/mailbox.php 150 +- array($this, 'show_top')); ++ array($this, 'showTop')); +hunk ./lib/mailbox.php 152 +- $this->show_box($user, $page); ++ $this->showBox($user, $page); +hunk ./lib/mailbox.php 157 ++ /** ++ * 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; + } ++ +hunk ./lib/mailbox.php 184 +- function show_box($user, $page) ++ function showBox($user, $page) +hunk ./lib/mailbox.php 186 +- $message = $this->get_messages($user, $page); ++ $message = $this->getMessages($user, $page); +hunk ./lib/mailbox.php 200 +- $this->show_message($message); ++ $this->showMessage($message); +hunk ./lib/mailbox.php 224 +- function get_message_profile($message) ++ function getMessageProfile($message) +hunk ./lib/mailbox.php 237 +- function show_message($message) ++ function showMessage($message) +hunk ./lib/mailbox.php 242 +- $profile = $this->get_message_profile($message); ++ $profile = $this->getMessageProfile($message); diff --git a/actions/inbox.php b/actions/inbox.php index c752e404e..da27814a6 100644 --- a/actions/inbox.php +++ b/actions/inbox.php @@ -1,9 +1,12 @@ . + * + * @category Message + * @package Laconica + * @author Evan Prodromou + * @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/ + */ + +if (!defined('LACONICA')) { + exit(1); +} + +require_once INSTALLDIR.'/lib/mailbox.php'; + +/** + * action handler for message inbox + * + * @category Message + * @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/ + * @see MailboxAction */ -if (!defined('LACONICA')) { exit(1); } - -require_once(INSTALLDIR.'/lib/mailbox.php'); - -class InboxAction extends MailboxAction { - - function get_title($user, $page) { - if ($page > 1) { - $title = sprintf(_("Inbox for %s - page %d"), $user->nickname, $page); - } else { - $title = sprintf(_("Inbox for %s"), $user->nickname); - } - return $title; - } - - function get_messages($user, $page) { - $message = new Message(); - $message->to_profile = $user->id; - $message->orderBy('created DESC, id DESC'); - $message->limit((($page-1)*MESSAGES_PER_PAGE), MESSAGES_PER_PAGE + 1); - - if ($message->find()) { - return $message; - } else { - return NULL; - } - } - - function get_message_profile($message) { - return $message->getFrom(); - } - - function get_instructions() { - return _('This is your inbox, which lists your incoming private messages.'); - } +class InboxAction extends MailboxAction +{ + /** + * returns the title of the page + * + * @param User $user current user + * @param int $page current page + * + * @return string localised title of the page + * + * @see MailboxAction::getTitle() + */ + + function getTitle($user, $page) + { + if ($page > 1) { + $title = sprintf(_("Inbox for %s - page %d"), $user->nickname, $page); + } else { + $title = sprintf(_("Inbox for %s"), $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) + { + $message = new Message(); + + $message->to_profile = $user->id; + + $message->orderBy('created DESC, id DESC'); + $message->limit((($page-1)*MESSAGES_PER_PAGE), MESSAGES_PER_PAGE + 1); + + if ($message->find()) { + return $message; + } else { + return null; + } + } + + /** + * returns the profile we want to show with the message + * + * For inboxes, we show the sender. + * + * @param Message $message The message to get the profile for + * + * @return Profile The profile of the message sender + * + * @see MailboxAction::getMessageProfile() + */ + + function getMessageProfile($message) + { + return $message->getFrom(); + } + + /** + * instructions for using this page + * + * @return string localised instructions for using the page + */ + + function getInstructions() + { + return _('This is your inbox, which lists your incoming private messages.'); + } } diff --git a/actions/outbox.php b/actions/outbox.php index c48d9c206..9fb6dbf9f 100644 --- a/actions/outbox.php +++ b/actions/outbox.php @@ -1,9 +1,12 @@ . + * + * @category Message + * @package Laconica + * @author Evan Prodromou + * @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/ + */ + +if (!defined('LACONICA')) { + exit(1); +} + +require_once INSTALLDIR.'/lib/mailbox.php'; + +/** + * action handler for message outbox + * + * @category Message + * @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/ + * @see MailboxAction */ -if (!defined('LACONICA')) { exit(1); } - -require_once(INSTALLDIR.'/lib/mailbox.php'); - -class OutboxAction extends MailboxAction { - - function get_title($user, $page) { - if ($page > 1) { - $title = sprintf(_("Outbox for %s - page %d"), $user->nickname, $page); - } else { - $title = sprintf(_("Outbox for %s"), $user->nickname); - } - return $title; - } - - function get_messages($user, $page) { - $message = new Message(); - $message->from_profile = $user->id; - $message->orderBy('created DESC, id DESC'); - $message->limit((($page-1)*MESSAGES_PER_PAGE), MESSAGES_PER_PAGE + 1); - - if ($message->find()) { - return $message; - } else { - return NULL; - } - } - - function get_message_profile($message) { - return $message->getTo(); - } - - function get_instructions() { - return _('This is your outbox, which lists private messages you have sent.'); - } - +class OutboxAction extends MailboxAction +{ + /** + * returns the title of the page + * + * @param User $user current user + * @param int $page current page + * + * @return string localised title of the page + * + * @see MailboxAction::getTitle() + */ + + function getTitle($user, $page) + { + if ($page > 1) { + $title = sprintf(_("Outbox for %s - page %d"), $user->nickname, $page); + } else { + $title = sprintf(_("Outbox for %s"), $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) + { + $message = new Message(); + + $message->from_profile = $user->id; + $message->orderBy('created DESC, id DESC'); + $message->limit((($page-1)*MESSAGES_PER_PAGE), MESSAGES_PER_PAGE + 1); + + if ($message->find()) { + return $message; + } else { + return null; + } + } + + /** + * returns the profile we want to show with the message + * + * For outboxes, we show the recipient. + * + * @param Message $message The message to get the profile for + * + * @return Profile The profile of the message recipient + * + * @see MailboxAction::getMessageProfile() + */ + + function getMessageProfile($message) + { + return $message->getTo(); + } + + /** + * instructions for using this page + * + * @return string localised instructions for using the page + */ + + function getInstructions() + { + return _('This is your outbox, which lists private messages you have sent.'); + } } diff --git a/lib/mailbox.php b/lib/mailbox.php index 9039c5fda..bdc360a35 100644 --- a/lib/mailbox.php +++ b/lib/mailbox.php @@ -19,7 +19,7 @@ * You should have received a copy of the GNU Affero General Public License * along with this program. If not, see . * - * @category Action + * @category Message * @package Laconica * @author Evan Prodromou * @copyright 2008 Control Yourself, Inc. @@ -38,7 +38,7 @@ define('MESSAGES_PER_PAGE', 20); /** * common superclass for direct messages inbox and outbox * - * @category Action + * @category Message * @package Laconica * @author Evan Prodromou * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0 @@ -91,7 +91,7 @@ class MailboxAction extends PersonalAction $page = 1; } - $this->show_page($user, $page); + $this->showPage($user, $page); } /** @@ -103,7 +103,7 @@ class MailboxAction extends PersonalAction * @return string localised title of the page */ - function get_title($user, $page) + function getTitle($user, $page) { return ''; } @@ -114,7 +114,7 @@ class MailboxAction extends PersonalAction * @return string localised instructions for using the page */ - function get_instructions() + function getInstructions() { return ''; } @@ -125,7 +125,7 @@ class MailboxAction extends PersonalAction * @return void */ - function show_top() + function showTop() { $cur = common_current_user(); @@ -143,17 +143,33 @@ class MailboxAction extends PersonalAction * @return void */ - function show_page($user, $page) + function showPage($user, $page) { - common_show_header($this->get_title($user, $page), + common_show_header($this->getTitle($user, $page), null, null, - array($this, 'show_top')); + array($this, 'showTop')); - $this->show_box($user, $page); + $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 * @@ -165,9 +181,9 @@ class MailboxAction extends PersonalAction * @return void */ - function show_box($user, $page) + function showBox($user, $page) { - $message = $this->get_messages($user, $page); + $message = $this->getMessages($user, $page); if ($message) { @@ -181,7 +197,7 @@ class MailboxAction extends PersonalAction break; } - $this->show_message($message); + $this->showMessage($message); } common_element_end('ul'); @@ -205,7 +221,7 @@ class MailboxAction extends PersonalAction * @return Profile The profile that matches the message */ - function get_message_profile($message) + function getMessageProfile($message) { return null; } @@ -218,12 +234,12 @@ class MailboxAction extends PersonalAction * @return void */ - function show_message($message) + function showMessage($message) { common_element_start('li', array('class' => 'message_single', 'id' => 'message-' . $message->id)); - $profile = $this->get_message_profile($message); + $profile = $this->getMessageProfile($message); $avatar = $profile->getAvatar(AVATAR_STREAM_SIZE); common_element_start('a', array('href' => $profile->profileurl)); -- cgit v1.2.3-54-g00ecf From 624ca93c9d2a55d7acfca453ba22268d09154dab Mon Sep 17 00:00:00 2001 From: Zach Copley Date: Tue, 20 Jan 2009 17:49:47 -0800 Subject: 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(-) (limited to 'lib/mailbox.php') diff --git a/actions/inbox.php b/actions/inbox.php index da27814a6..b553ab26c 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 510a5f8f3..aa94f8c4f 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')); - - if ($msg) { - $this->element('p', array('id'=>'error'), $msg); - } + $this->msg = $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 9fb6dbf9f..c8d7f2812 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 bdc360a35..9af0dbd2f 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); - return; - } - - $profile = $user->getProfile(); - - if (!$profile) { - $this->server_error(_('User has no profile.')); + if (!$cur || $cur->id != $this->user->id) { + $this->clientError(_('Only the user can read their own mailboxes.'), + 403); 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 46f9ff6be..900df0257 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()); } } -- cgit v1.2.3-54-g00ecf From 9376003871652300b5960437fd37461fdd85e63b Mon Sep 17 00:00:00 2001 From: sarven Date: Wed, 21 Jan 2009 05:27:16 +0000 Subject: Mailbox markup for Inbox/Outbox direct notices Please enter the commit message for your changes. --- lib/mailbox.php | 64 ++++++++++++++++++++++++++++++++++++------------------ lib/noticelist.php | 4 ++-- 2 files changed, 45 insertions(+), 23 deletions(-) (limited to 'lib/mailbox.php') diff --git a/lib/mailbox.php b/lib/mailbox.php index 9af0dbd2f..8d5d44e49 100644 --- a/lib/mailbox.php +++ b/lib/mailbox.php @@ -111,9 +111,10 @@ class MailboxAction extends PersonalAction $message = $this->getMessages(); if ($message) { - $cnt = 0; - $this->elementStart('ul', array('id' => 'messages')); + $this->elementStart('div', array('id' =>'notices_primary')); + $this->element('h2', null, _('Notices')); + $this->elementStart('ul', 'notices'); while ($message->fetch() && $cnt <= MESSAGES_PER_PAGE) { $cnt++; @@ -130,7 +131,7 @@ class MailboxAction extends PersonalAction $this->pagination($this->page > 1, $cnt > MESSAGES_PER_PAGE, $this->page, $this->trimmed('action'), array('nickname' => $this->user->nickname)); - + $this->elementEnd('div'); $message->free(); unset($message); } @@ -169,30 +170,35 @@ class MailboxAction extends PersonalAction function showMessage($message) { - $this->elementStart('li', array('class' => 'message_single', + $this->elementStart('li', array('class' => 'hentry notice', 'id' => 'message-' . $message->id)); $profile = $this->getMessageProfile($message); + $this->elementStart('div', 'entry-title'); + $this->elementStart('span', 'vcard author'); + $this->elementStart('a', array('href' => $profile->profileurl, + 'class' => 'url')); $avatar = $profile->getAvatar(AVATAR_STREAM_SIZE); - $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', + 'class' => 'photo avatar', 'width' => AVATAR_STREAM_SIZE, 'height' => AVATAR_STREAM_SIZE, 'alt' => ($profile->fullname) ? $profile->fullname : $profile->nickname)); + $this->element('span', array('class' => 'nickname fn'), + $profile->nickname); $this->elementEnd('a'); - $this->element('a', array('href' => $profile->profileurl, - 'class' => 'nickname'), - $profile->nickname); + $this->elementEnd('span'); + // FIXME: URL, image, video, audio - $this->elementStart('p', array('class' => 'content')); + $this->elementStart('p', array('class' => 'entry-content')); $this->raw($message->rendered); $this->elementEnd('p'); + $this->elementEnd('div'); $messageurl = common_local_url('showmessage', array('message' => $message->id)); @@ -202,17 +208,30 @@ class MailboxAction extends PersonalAction preg_match('/^http/', $message->uri)) { $messageurl = $message->uri; } - $this->elementStart('p', 'time'); - $this->element('a', array('class' => 'permalink', - 'href' => $messageurl, - 'title' => common_exact_date($message->created)), - common_date_string($message->created)); + + $this->elementStart('div', 'entry-content'); + $this->elementStart('dl', 'timestamp'); + $this->element('dt', null, _('Published')); + $this->elementStart('dd', null); + $dt = common_date_iso8601($message->created); + $this->elementStart('a', array('rel' => 'bookmark', + 'href' => $messageurl)); + $this->element('abbr', array('class' => 'published', + 'title' => $dt), + common_date_string($message->created)); + $this->elementEnd('a'); + $this->elementEnd('dd'); + $this->elementEnd('dl'); + if ($message->source) { - $this->text(_(' from ')); + $this->elementStart('dl', 'device'); + $this->elementStart('dt'); + $this->text(_('From')); + $this->elementEnd('dt'); $this->showSource($message->source); + $this->elementEnd('dl'); } - - $this->elementEnd('p'); + $this->elementEnd('div'); $this->elementEnd('li'); } @@ -255,15 +274,18 @@ class MailboxAction extends PersonalAction case 'mail': case 'omb': case 'api': - $this->element('span', 'noticesource', $source_name); + $this->element('dd', null, $source_name); break; default: $ns = Notice_source::staticGet($source); if ($ns) { - $this->element('a', array('href' => $ns->url), + $this->elementStart('dd', null); + $this->element('a', array('href' => $ns->url, + 'rel' => 'external'), $ns->name); + $this->elementEnd('dd'); } else { - $this->element('span', 'noticesource', $source_name); + $this->element('dd', null, $source_name); } break; } diff --git a/lib/noticelist.php b/lib/noticelist.php index c57d6ce19..07912c552 100644 --- a/lib/noticelist.php +++ b/lib/noticelist.php @@ -379,7 +379,7 @@ class NoticeListItem extends Widget case 'mail': case 'omb': case 'api': - $this->out->element('dd', 'noticesource', $source_name); + $this->out->element('dd', null, $source_name); break; default: $ns = Notice_source::staticGet($this->notice->source); @@ -390,7 +390,7 @@ class NoticeListItem extends Widget $ns->name); $this->out->elementEnd('dd'); } else { - $this->out->element('dd', 'noticesource', $source_name); + $this->out->element('dd', null, $source_name); } break; } -- cgit v1.2.3-54-g00ecf