QnA - Allow answer revisions and marking a question as "best"

plugins/QnA/QnAPlugin.php

@@ -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':
@@ -318,17 +320,18 @@ class QnAPlugin extends MicroAppPlugin
         case QnA_Answer::OBJECT_TYPE:
             $id = (empty($nli->repeat)) ? $nli->notice->id : $nli->repeat->id;
 
-            $classes = array('hentry', 'notice', 'answer');
+            $cls = array('hentry', 'notice', 'answer');
 
             $answer = QnA_Answer::staticGet('uri', $notice->uri);
 
-            if (!empty($answer) && (boolean($answer->best))) {
+            if (!empty($answer) && !empty($answer->best)) {
-                $classes[] = 'best';
+                $cls[] = 'best';
             }
 
             $nli->out->elementStart(
-                'li', array(
+                'li',
-                    'class' => implode(' ', $classes),
+                array(
+                    'class' => implode(' ', $cls),
                     'id'    => 'notice-' . $id
                 )
             );
@@ -348,6 +351,7 @@ class QnAPlugin extends MicroAppPlugin
      * @param Notice $notice
      * @param HTMLOutputter $out
      */
+    
     function showNotice($notice, $out)
     {
         switch ($notice->object_type) {
@@ -381,8 +385,8 @@ class QnAPlugin extends MicroAppPlugin
 
         if (!empty($question)) {
 
-            $short = $question->description;
+            $short = $this->shorten($question->description, $notice);
-            $out->raw($question->description);
+            $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
@@ -390,15 +394,14 @@ class QnAPlugin extends MicroAppPlugin
                 if (!empty($user) && ($user->id != $question->profile_id)) {
                     $profile = $user->getProfile();
                     $answer = $question->getAnswer($profile);
-                    if ($answer) {
+                    if (!$answer) {
-                        // User has already answered; show the results.
+                        $form = new QnanewanswerForm($question, $out);
-                        $form = new QnareviseanswerForm($answer, $out);
-                    } else {
-                        $form = new QnaanswerForm($question, $out);
-                    }
                         $form->show();
                     }
                 }
+            } else {
+                $out->element('span', 'closed', _m('This question is closed.'));
+            }
         } else {
             $out->text(_m('Question data is missing.'));
         }
@@ -412,17 +415,17 @@ class QnAPlugin extends MicroAppPlugin
     {
         $user = common_current_user();
         
-        // @hack we want regular rendering, then just add stuff after that
+        $answer   = QnA_Answer::getByNotice($notice);
+        $question = $answer->getQuestion();
+
         $nli = new NoticeListItem($notice, $out);
         $nli->showNotice();
 
         $out->elementStart('div', array('class' => 'entry-content answer-content'));
 
-        $answer = QnA_Answer::staticGet('uri', $notice->uri);
-
         if (!empty($answer)) {
-            $short = $answer->content;
+            $form = new QnashowanswerForm($out, $answer);
-            $out->raw($answer->content);
+            $form->show();
         } else {
             $out->text(_m('Answer data is missing.'));
         }
@@ -433,6 +436,26 @@ class QnAPlugin extends MicroAppPlugin
         $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
      *

plugins/QnA/actions/qnanewanswer.php

@@ -180,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;

plugins/QnA/actions/qnareviseanswer.php

@@ -86,14 +86,8 @@ class QnareviseanswerAction extends Action
             );
         }
 
-        if ($this->isPost()) {
-            $this->checkSessionToken();
-        }
-
         $id = substr($this->trimmed('id'), 7);
 
-        common_debug("XXXXXXXXXXXXXXXXXX id = " . $id);
-
         $this->answer   = QnA_Answer::staticGet('id', $id);
         $this->question = $this->answer->getQuestion(); 
 
@@ -122,12 +116,22 @@ class QnareviseanswerAction extends Action
         parent::handle($argarray);
 
         if ($this->isPost()) {
-            $this->reviseAnswer();
+            $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->showPage();
+                $this->reviseAnswer();
+                return;
+            }
         }
 
-        return;
+        $this->showPage();
     }
 
     /**
@@ -159,7 +163,52 @@ class QnareviseanswerAction extends Action
             $this->element('title', null, _m('Answer'));
             $this->elementEnd('head');
             $this->elementStart('body');
-            $this->raw($answer->asHTML());
+            $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 {
@@ -178,12 +227,31 @@ class QnareviseanswerAction extends Action
             $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.
      *

plugins/QnA/classes/QnA_Answer.php

@@ -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,7 +205,14 @@ class QnA_Answer extends Managed_DataObject
     {
         $notice = $question->getNotice();
 
+        $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)) {

plugins/QnA/lib/qnanewanswerform.php

@@ -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;
 

plugins/QnA/lib/qnashowanswerform.php

@@ -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';
+    }
+}