uiredesign + phpdocs

This commit is contained in:
Robin Millette 2009-01-22 09:39:53 +00:00 committed by Robin Millette
parent f871f52624
commit a1cb64679b
2 changed files with 92 additions and 45 deletions

View File

@ -1,5 +1,17 @@
<?php <?php
/*
/**
* Disfavor action.
*
* PHP version 5
*
* @category Action
* @package Laconica
* @author Evan Prodromou <evan@controlyourself.ca>
* @author Robin Millette <millette@controlyourself.ca>
* @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
* @link http://laconi.ca/
*
* Laconica - a distributed open-source microblogging tool * Laconica - a distributed open-source microblogging tool
* Copyright (C) 2008, Controlez-Vous, Inc. * Copyright (C) 2008, Controlez-Vous, Inc.
* *
@ -17,41 +29,51 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
if (!defined('LACONICA')) { exit(1); } if (!defined('LACONICA')) {
exit(1);
}
require_once INSTALLDIR.'/lib/favorform.php'; require_once INSTALLDIR.'/lib/favorform.php';
/**
* Disfavor class.
*
* @category Action
* @package Laconica
* @author Evan Prodromou <evan@controlyourself.ca>
* @author Robin Millette <millette@controlyourself.ca>
* @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
* @link http://laconi.ca/
*/
class DisfavorAction extends Action class DisfavorAction extends Action
{ {
/**
* Class handler.
*
* @param array $args query arguments
*
* @return void
*/
function handle($args) function handle($args)
{ {
parent::handle($args); parent::handle($args);
if (!common_logged_in()) { if (!common_logged_in()) {
$this->clientError(_('Not logged in.')); $this->clientError(_('Not logged in.'));
return; return;
} }
$user = common_current_user(); $user = common_current_user();
if ($_SERVER['REQUEST_METHOD'] != 'POST') { if ($_SERVER['REQUEST_METHOD'] != 'POST') {
common_redirect(common_local_url('showfavorites', array('nickname' => $user->nickname))); common_redirect(common_local_url('showfavorites',
array('nickname' => $user->nickname)));
return; return;
} }
$id = $this->trimmed('notice'); $id = $this->trimmed('notice');
$notice = Notice::staticGet($id); $notice = Notice::staticGet($id);
$token = $this->trimmed('token-'.$notice->id); $token = $this->trimmed('token-'.$notice->id);
if (!$token || $token != common_session_token()) { if (!$token || $token != common_session_token()) {
$this->clientError(_("There was a problem with your session token. Try again, please.")); $this->clientError(_("There was a problem with your session token. Try again, please."));
return; return;
} }
$fave = new Fave(); $fave = new Fave();
$fave->user_id = $this->id; $fave->user_id = $this->id;
$fave->notice_id = $notice->id; $fave->notice_id = $notice->id;
@ -59,17 +81,13 @@ class DisfavorAction extends Action
$this->clientError(_('This notice is not a favorite!')); $this->clientError(_('This notice is not a favorite!'));
return; return;
} }
$result = $fave->delete(); $result = $fave->delete();
if (!$result) { if (!$result) {
common_log_db_error($fave, 'DELETE', __FILE__); common_log_db_error($fave, 'DELETE', __FILE__);
$this->serverError(_('Could not delete favorite.')); $this->serverError(_('Could not delete favorite.'));
return; return;
} }
$user->blowFavesCache(); $user->blowFavesCache();
if ($this->boolean('ajax')) { if ($this->boolean('ajax')) {
$this->startHTML('text/xml;charset=utf-8', true); $this->startHTML('text/xml;charset=utf-8', true);
$this->elementStart('head'); $this->elementStart('head');
@ -86,3 +104,4 @@ class DisfavorAction extends Action
} }
} }
} }

View File

@ -1,4 +1,18 @@
<?php <?php
/**
* Favor action.
*
* PHP version 5
*
* @category Action
* @package Laconica
* @author Evan Prodromou <evan@controlyourself.ca>
* @author Robin Millette <millette@controlyourself.ca>
* @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
* @link http://laconi.ca/
*
/* /*
* Laconica - a distributed open-source microblogging tool * Laconica - a distributed open-source microblogging tool
* Copyright (C) 2008, Controlez-Vous, Inc. * Copyright (C) 2008, Controlez-Vous, Inc.
@ -17,57 +31,63 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
if (!defined('LACONICA')) { exit(1); } if (!defined('LACONICA')) {
exit(1);
}
require_once(INSTALLDIR.'/lib/mail.php'); require_once INSTALLDIR.'/lib/mail.php';
require_once INSTALLDIR.'/lib/disfavorform.php'; require_once INSTALLDIR.'/lib/disfavorform.php';
/**
* Favor class.
*
* @category Action
* @package Laconica
* @author Evan Prodromou <evan@controlyourself.ca>
* @author Robin Millette <millette@controlyourself.ca>
* @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
* @link http://laconi.ca/
*/
class FavorAction extends Action class FavorAction extends Action
{ {
/**
* Class handler.
*
* @param array $args query arguments
*
* @return void
*/
function handle($args) function handle($args)
{ {
parent::handle($args); parent::handle($args);
if (!common_logged_in()) { if (!common_logged_in()) {
$this->clientError(_('Not logged in.')); $this->clientError(_('Not logged in.'));
return; return;
} }
$user = common_current_user(); $user = common_current_user();
if ($_SERVER['REQUEST_METHOD'] != 'POST') { if ($_SERVER['REQUEST_METHOD'] != 'POST') {
common_redirect(common_local_url('showfavorites', array('nickname' => $user->nickname))); common_redirect(common_local_url('showfavorites',
array('nickname' => $user->nickname)));
return; return;
} }
$id = $this->trimmed('notice'); $id = $this->trimmed('notice');
$notice = Notice::staticGet($id); $notice = Notice::staticGet($id);
# CSRF protection
$token = $this->trimmed('token-'.$notice->id); $token = $this->trimmed('token-'.$notice->id);
if (!$token || $token != common_session_token()) { if (!$token || $token != common_session_token()) {
$this->clientError(_("There was a problem with your session token. Try again, please.")); $this->clientError(_("There was a problem with your session token. Try again, please."));
return; return;
} }
if ($user->hasFave($notice)) { if ($user->hasFave($notice)) {
$this->clientError(_('This notice is already a favorite!')); $this->clientError(_('This notice is already a favorite!'));
return; return;
} }
$fave = Fave::addNew($user, $notice); $fave = Fave::addNew($user, $notice);
if (!$fave) { if (!$fave) {
$this->serverError(_('Could not create favorite.')); $this->serverError(_('Could not create favorite.'));
return; return;
} }
$this->notify($notice, $user);
$this->notify($fave, $notice, $user);
$user->blowFavesCache(); $user->blowFavesCache();
if ($this->boolean('ajax')) { if ($this->boolean('ajax')) {
$this->startHTML('text/xml;charset=utf-8', true); $this->startHTML('text/xml;charset=utf-8', true);
$this->elementStart('head'); $this->elementStart('head');
@ -84,16 +104,24 @@ class FavorAction extends Action
} }
} }
function notify($fave, $notice, $user) /**
* Notifies a user when his notice is favorited.
*
* @param class $notice favorited notice
* @param class $user user declaring a favorite
*
* @return void
*/
function notify($notice, $user)
{ {
$other = User::staticGet('id', $notice->profile_id); $other = User::staticGet('id', $notice->profile_id);
if ($other && $other->id != $user->id) { if ($other && $other->id != $user->id) {
if ($other->email && $other->emailnotifyfav) { if ($other->email && $other->emailnotifyfav) {
mail_notify_fave($other, $user, $notice); mail_notify_fave($other, $user, $notice);
} }
# XXX: notify by IM // XXX: notify by IM
# XXX: notify by SMS // XXX: notify by SMS
}
} }
} }
}