GNUsocial/gnu-social
4
0
Fork 1
Code Issues Releases Wiki Activity

Merge branch 'qna' into 1.0.x

Browse Source 
* qna:
  QnA - Allow answer revisions and marking a question as "best"
  QnA - add best class to best answers
  QnA - Better display of questions and answers in streams
  QnA - save answer revisions and show # of revisions
This commit is contained in:
Zach Copley 2011-04-04 01:30:15 -07:00
commit c4b9dc7a0f
8 changed files with 602 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

127
plugins/QnA/QnAPlugin.php
View File

@ -88,9 +88,11 @@ class QnAPlugin extends MicroAppPlugin
. strtolower(mb_substr($cls, 0, -6)) . '.php';
return false;
case 'QnaquestionForm':
case 'QnaanswerForm':
case 'QnashowanswerForm':
case 'QnanewanswerForm':
case 'QnareviseanswerForm':
case 'QnavoteForm':
case 'AnswerNoticeListItem':
include_once $dir . '/lib/' . strtolower($cls).'.php';
break;
case 'QnA_Question':
@ -124,6 +126,10 @@ class QnAPlugin extends MicroAppPlugin
'main/qna/newanswer',
array('action' => 'qnanewanswer')
);
$m->connect(
'main/qna/reviseanswer',
array('action' => 'qnareviseanswer')
);
$m->connect(
'question/vote/:id',
array('action' => 'qnavote', 'type' => 'question'),
@ -286,12 +292,66 @@ class QnAPlugin extends MicroAppPlugin
return true;
}
/**
* Output our CSS class for QnA notice list elements
*
* @param NoticeListItem $nli The item being shown
*
* @return boolean hook value
*/
function onStartOpenNoticeListItemElement($nli)
{
$type = $nli->notice->object_type;
switch($type)
{
case QnA_Question::OBJECT_TYPE:
$id = (empty($nli->repeat)) ? $nli->notice->id : $nli->repeat->id;
$nli->out->elementStart(
'li', array(
'class' => 'hentry notice question',
'id' => 'notice-' . $id
)
);
Event::handle('EndOpenNoticeListItemElement', array($nli));
return false;
break;
case QnA_Answer::OBJECT_TYPE:
$id = (empty($nli->repeat)) ? $nli->notice->id : $nli->repeat->id;
$cls = array('hentry', 'notice', 'answer');
$answer = QnA_Answer::staticGet('uri', $notice->uri);
if (!empty($answer) && !empty($answer->best)) {
$cls[] = 'best';
}
$nli->out->elementStart(
'li',
array(
'class' => implode(' ', $cls),
'id' => 'notice-' . $id
)
);
Event::handle('EndOpenNoticeListItemElement', array($nli));
return false;
break;
default:
return true;
}
return true;
}
/**
* Custom HTML output for our notices
*
* @param Notice $notice
* @param HTMLOutputter $out
*/
function showNotice($notice, $out)
{
switch ($notice->object_type) {
@ -319,20 +379,28 @@ class QnAPlugin extends MicroAppPlugin
$nli = new NoticeListItem($notice, $out);
$nli->showNotice();
$out->elementStart('div', array('class' => 'entry-content question-content'));
$out->elementStart('div', array('class' => 'entry-content question-desciption'));
$question = QnA_Question::getByNotice($notice);
if ($question) {
if ($user) {
$profile = $user->getProfile();
$answer = $question->getAnswer($profile);
if ($answer) {
// User has already answer; show the results.
$form = new QnareviseanswerForm($answer, $out);
} else {
$form = new QnaanswerForm($question, $out);
if (!empty($question)) {
$short = $this->shorten($question->description, $notice);
$out->raw($short);
// Don't prompt user for an answer if the question is closed or
// the current user posed the question in the first place
if (empty($question->closed)) {
if (!empty($user) && ($user->id != $question->profile_id)) {
$profile = $user->getProfile();
$answer = $question->getAnswer($profile);
if (!$answer) {
$form = new QnanewanswerForm($question, $out);
$form->show();
}
}
$form->show();
} else {
$out->element('span', 'closed', _m('This question is closed.'));
}
} else {
$out->text(_m('Question data is missing.'));
@ -346,15 +414,48 @@ class QnAPlugin extends MicroAppPlugin
function showNoticeAnswer($notice, $out)
{
$user = common_current_user();
$answer = QnA_Answer::getByNotice($notice);
$question = $answer->getQuestion();
// @hack we want regular rendering, then just add stuff after that
$nli = new NoticeListItem($notice, $out);
$nli->showNotice();
$out->elementStart('div', array('class' => 'entry-content answer-content'));
if (!empty($answer)) {
$form = new QnashowanswerForm($out, $answer);
$form->show();
} else {
$out->text(_m('Answer data is missing.'));
}
$out->elementEnd('div');
// @fixme
$out->elementStart('div', array('class' => 'entry-content'));
}
static function shorten($content, $notice)
{
$short = null;
if (Notice::contentTooLong($content)) {
common_debug("content too long");
$max = Notice::maxContent();
$short = mb_substr($content, 0, $max - 1);
$short .= sprintf(
'<a href="%s" rel="more" title="%s">…</a>',
$notice->uri,
_m('more')
);
} else {
$short = $content;
}
return $short;
}
/**
* Form for our app
*

11
plugins/QnA/actions/qnanewanswer.php
View File

@ -20,7 +20,7 @@
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* @category QuestonAndAnswer
* @category QnA
* @package StatusNet
* @author Zach Copley <zach@status.net>
* @copyright 2011 StatusNet, Inc.
@ -137,9 +137,11 @@ class QnanewanswerAction extends Action
*/
function newAnswer()
{
$profile = $this->user->getProfile();
try {
$notice = QnA_Answer::saveNew(
$this->user->getProfile(),
$profile,
$this->question,
$this->answerText
);
@ -150,6 +152,7 @@ class QnanewanswerAction extends Action
}
if ($this->boolean('ajax')) {
common_debug("ajaxy part");
$answer = $this->question->getAnswer($profile);
header('Content-Type: text/xml;charset=utf-8');
$this->xw->startDocument('1.0', 'UTF-8');
$this->elementStart('html');
@ -158,7 +161,7 @@ class QnanewanswerAction extends Action
$this->element('title', null, _m('Answers'));
$this->elementEnd('head');
$this->elementStart('body');
$this->raw()
$this->raw($answer->asHTML());
$this->elementEnd('body');
$this->elementEnd('html');
} else {
@ -177,7 +180,7 @@ class QnanewanswerAction extends Action
$this->element('p', 'error', $this->error);
}
$form = new QnaanswerForm($this->question, $this);
$form = new QnanewanswerForm($this->question, $this);
$form->show();
return;

273
plugins/QnA/actions/qnareviseanswer.php Normal file
View File

@ -0,0 +1,273 @@
<?php
/**
* StatusNet - the distributed open-source microblogging tool
* Copyright (C) 2011, StatusNet, Inc.
*
* Revise an answer
*
* PHP version 5
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* @category QnA
* @package StatusNet
* @author Zach Copley <zach@status.net>
* @copyright 2011 StatusNet, Inc.
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
* @link http://status.net/
*/
if (!defined('STATUSNET')) {
// This check helps protect against security problems;
// your code file can't be executed directly from the web.
exit(1);
}
/**
* Revise an answer
*
* @category QnA
* @package StatusNet
* @author Zach Copley <zach@status.net>
* @copyright 2010 StatusNet, Inc.
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
* @link http://status.net/
*/
class QnareviseanswerAction extends Action
{
protected $user = null;
protected $error = null;
protected $question = null;
protected $answer = null;
protected $content = null;
/**
* Returns the title of the action
*
* @return string Action title
*/
function title()
{
// TRANS: Page title for revising a question
return _m('Revise answer');
}
/**
* For initializing members of the class.
*
* @param array $argarray misc. arguments
*
* @return boolean true
*/
function prepare($argarray)
{
parent::prepare($argarray);
if ($this->boolean('ajax')) {
StatusNet::setApi(true);
}
$this->user = common_current_user();
if (empty($this->user)) {
// TRANS: Client exception thrown trying to answer a question while not logged in.
throw new ClientException(
_m("You must be logged in to answer to a question."),
403
);
}
$id = substr($this->trimmed('id'), 7);
$this->answer = QnA_Answer::staticGet('id', $id);
$this->question = $this->answer->getQuestion();
if (empty($this->answer) || empty($this->question)) {
// TRANS: Client exception thrown trying to respond to a non-existing question.
throw new ClientException(
_m('Invalid or missing answer.'),
404
);
}
$this->answerText = $this->trimmed('answer');
return true;
}
/**
* Handler method
*
* @param array $argarray is ignored since it's now passed in in prepare()
*
* @return void
*/
function handle($argarray=null)
{
parent::handle($argarray);
if ($this->isPost()) {
$this->checkSessionToken();
if ($this->arg('revise')) {
$this->showContent();
return;
} else if ($this->arg('best')) {
if ($this->user->id == $this->question->profile_id) {
$this->markBest();
return;
}
} else {
$this->reviseAnswer();
return;
}
}
$this->showPage();
}
/**
* Revise the answer
*
* @return void
*/
function reviseAnswer()
{
$answer = $this->answer;
try {
$orig = clone($answer);
$answer->content = $this->answerText;
$answer->revisions++;
$result = $answer->update($orig);
} catch (ClientException $ce) {
$this->error = $ce->getMessage();
$this->showPage();
return;
}
if ($this->boolean('ajax')) {
common_debug("ajaxy part");
header('Content-Type: text/xml;charset=utf-8');
$this->xw->startDocument('1.0', 'UTF-8');
$this->elementStart('html');
$this->elementStart('head');
// TRANS: Page title after sending an answer.
$this->element('title', null, _m('Answer'));
$this->elementEnd('head');
$this->elementStart('body');
$form = new QnashowanswerForm($this, $answer);
$form->show();
$this->elementEnd('body');
$this->elementEnd('html');
} else {
common_redirect($this->answer->bestUrl(), 303);
}
}
/**
* Mark the answer as the "best" answer
*
* @return void
*/
function markBest()
{
$question = $this->question;
$answer = $this->answer;
try {
// close the question to further answers
$orig = clone($question);
$question->closed = 1;
$result = $question->update($orig);
// mark this answer an the best answer
$orig = clone($answer);
$answer->best = 1;
$result = $answer->update($orig);
} catch (ClientException $ce) {
$this->error = $ce->getMessage();
$this->showPage();
return;
}
if ($this->boolean('ajax')) {
common_debug("ajaxy part");
header('Content-Type: text/xml;charset=utf-8');
$this->xw->startDocument('1.0', 'UTF-8');
$this->elementStart('html');
$this->elementStart('head');
// TRANS: Page title after sending an answer.
$this->element('title', null, _m('Answer'));
$this->elementEnd('head');
$this->elementStart('body');
$form = new QnashowanswerForm($this, $answer);
$form->show();
$this->elementEnd('body');
$this->elementEnd('html');
} else {
common_redirect($this->answer->bestUrl(), 303);
}
}
/**
* Show the revise answer form
*
* @return void
*/
function showContent()
{
if (!empty($this->error)) {
$this->element('p', 'error', $this->error);
}
if ($this->boolean('ajax')) {
$this->showAjaxReviseForm();
} else {
$form = new QnareviseanswerForm($this->answer, $this);
$form->show();
}
return;
}
function showAjaxReviseForm()
{
header('Content-Type: text/xml;charset=utf-8');
$this->xw->startDocument('1.0', 'UTF-8');
$this->elementStart('html');
$this->elementStart('head');
$this->element('title', null, _m('Answer'));
$this->elementEnd('head');
$this->elementStart('body');
$form = new QnareviseanswerForm($this->answer, $this);
$form->show();
$this->elementEnd('body');
$this->elementEnd('html');
}
/**
* Return true if read only.
*
* MAY override
*
* @param array $args other arguments
*
* @return boolean is read only action?
*/
function isReadOnly($args)
{
if ($_SERVER['REQUEST_METHOD'] == 'GET' ||
$_SERVER['REQUEST_METHOD'] == 'HEAD') {
return true;
} else {
return false;
}
}
}

21
plugins/QnA/classes/QnA_Answer.php
View File

@ -140,7 +140,7 @@ class QnA_Answer extends Managed_DataObject
{
$answer = self::staticGet('uri', $notice->uri);
if (empty($answer)) {
throw new Exception("No answer with URI {$this->notice->uri}");
throw new Exception("No answer with URI {$notice->uri}");
}
return $answer;
}
@ -205,8 +205,23 @@ class QnA_Answer extends Managed_DataObject
{
$notice = $question->getNotice();
$fmt = '<span class="answer_author"><a href="%1$s">answer</a> by <a href="%2$s">%3$s</a></span>';
$fmt .= '<span class="answer_content">%4$s</span>';
$fmt = '';
if (!empty($answer->best)) {
$fmt = '<p class="qna_answer best">';
} else {
$fmt = '<p class="qna_answer">';
}
$fmt .= '<span class="answer_author"><a href="%1$s">answer</a> by <a href="%2$s">%3$s</a></span>';
$fmt .= '<span class="answer_content">%4$s</span>';
if (!empty($answer->revisions)) {
$fmt .= '<span class="answer_revisions">'
. $answer->revisions
. _m('revisions')
. '</span>';
}
$fmt .= '</p>';
return sprintf(
$fmt,

4
plugins/QnA/classes/QnA_Question.php
View File

@ -221,11 +221,11 @@ class QnA_Question extends Managed_DataObject
{
$notice = $question->getNotice();
$fmt = '<div class="qna_question">';
$fmt = '<p class="qna_question">';
$fmt .= '<span class="question_title"><a href="%1$s">%2$s</a></span>';
$fmt .= '<span class="question_description">%3$s</span>';
$fmt .= '<span class="question_author">asked by <a href="%4$s">%5$s</a></span>';
$fmt .= '</div>';
$fmt .= '</p>';
$q = sprintf(
$fmt,

2
plugins/QnA/lib/qnaanswerform.php → plugins/QnA/lib/qnanewanswerform.php
View File

@ -44,7 +44,7 @@ if (!defined('STATUSNET')) {
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
* @link http://status.net/
*/
class QnaanswerForm extends Form
class QnanewanswerForm extends Form
{
protected $question;

11
plugins/QnA/lib/qnareviseanswerform.php
View File

@ -91,7 +91,7 @@ class QnareviseanswerForm extends Form
*/
function action()
{
return common_local_url('qnareviseanswer', array('id' => $this->question->id));
return common_local_url('qnareviseanswer');
}
/**
@ -101,12 +101,13 @@ class QnareviseanswerForm extends Form
*/
function formData()
{
$question = $this->question;
$out = $this->out;
$id = "question-" . $question->id;
$out->element('p', 'Your answer to:', $question->title);
$out->textarea('answerText', 'You said:', $this->answer->content);
$out->element('p', 'Your answer to:', $this->question->title);
$id = "answer-" . $this->answer->id;
$out->hidden('id', $id);
$out->textarea('answer', 'You said:', $this->answer->content);
}
/**

181
plugins/QnA/lib/qnashowanswerform.php Normal file
View File

@ -0,0 +1,181 @@
<?php
/**
* StatusNet, the distributed open-source microblogging tool
*
* Form for showing / revising an answer
*
* PHP version 5
*
* LICENCE: This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* @category Form
* @package StatusNet
* @author Zach Copley <zach@status.net>
* @copyright 2011 StatusNet, Inc.
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
* @link http://status.net/
*/
if (!defined('STATUSNET')) {
exit(1);
}
require_once INSTALLDIR . '/lib/form.php';
/**
* Form for showing / revising an answer
*
* @category Form
* @package StatusNet
* @author Zach Copley <zach@status.net>
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
* @link http://status.net/
*
*/
class QnashowanswerForm extends Form
{
/**
* The answer to revise
*/
var $answer = null;
/**
* The question this is an answer to
*/
var $question = null;
/**
* Constructor
*
* @param HTMLOutputter $out output channel
* @param QnA_Answer $answer answer to revise
*/
function __construct($out = null, $answer = null)
{
parent::__construct($out);
$this->answer = $answer;
$this->question = $answer->getQuestion();
}
/**
* ID of the form
*
* @return int ID of the form
*/
function id()
{
return 'revise-' . $this->answer->id;
}
/**
* Action of the form
*
* @return string URL of the action
*/
function action()
{
return common_local_url('qnareviseanswer');
}
/**
* Include a session token for CSRF protection
*
* @return void
*/
function sessionToken()
{
$this->out->hidden(
'token',
common_session_token()
);
}
/**
* Legend of the Form
*
* @return void
*/
function formLegend()
{
// TRANS: Form legend for revising the answer.
$this->out->element('legend', null, _('Revise your answer'));
}
/**
* Data elements
*
* @return void
*/
function formData()
{
$this->out->hidden(
'id',
'revise-' . $this->answer->id
);
$this->out->raw($this->answer->asHTML());
}
/**
* Action elements
*
* @return void
*/
function formActions()
{
$user = common_current_user();
if (empty($user)) {
return;
}
if (empty($this->question->closed)) {
if ($user->id == $this->question->profile_id) {
common_debug("I am the question asker!");
if (empty($this->answer->best)) {
$this->out->submit(
'best',
// TRANS: Button text for marking an answer as "best"
_m('BUTTON', 'Best'),
'submit',
null,
// TRANS: Title for button text marking an answer as "best"
_('Mark as best answer')
);
}
}
if ($user->id == $this->answer->profile_id) {
$this->out->submit(
'revise',
// TRANS: Button text for revising an answer
_m('BUTTON', 'Revise'),
'submit',
null,
// TRANS: Title for button text for revising an answer
_('Revise your answer')
);
}
}
}
/**
* Class of the form.
*
* @return string the form's class
*/
function formClass()
{
return 'form_revise ajax';
}
}