297 lines
9.4 KiB
PHP
297 lines
9.4 KiB
PHP
<?php
|
|
// This file is part of GNU social - https://www.gnu.org/software/social
|
|
//
|
|
// GNU social 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.
|
|
//
|
|
// GNU social 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 GNU social. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
/**
|
|
* Data class to save answers to questions
|
|
*
|
|
* @category QnA
|
|
* @package GNUsocial
|
|
* @author Zach Copley <zach@status.net>
|
|
* @copyright 2011 StatusNet, Inc.
|
|
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
|
|
*/
|
|
|
|
defined('STATUSNET') || die();
|
|
|
|
/**
|
|
* For storing answers
|
|
*
|
|
* @copyright 2011 StatusNet, Inc.
|
|
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
|
|
*
|
|
* @see DB_DataObject
|
|
*/
|
|
class QnA_Answer extends Managed_DataObject
|
|
{
|
|
const OBJECT_TYPE = 'http://activityschema.org/object/answer';
|
|
|
|
public $__table = 'qna_answer'; // table name
|
|
public $id; // char(36) primary key not null -> UUID
|
|
public $uri; // varchar(191) not 255 because utf8mb4 takes more space
|
|
public $question_id; // char(36) -> question.id UUID
|
|
public $profile_id; // int -> question.id
|
|
public $best; // bool -> whether the question asker has marked this as the best answer
|
|
public $revisions; // int -> count of revisions to this answer
|
|
public $content; // text -> response text
|
|
public $created; // datetime
|
|
|
|
/**
|
|
* The One True Thingy that must be defined and declared.
|
|
*/
|
|
public static function schemaDef()
|
|
{
|
|
return array(
|
|
'description' => 'Record of answers to questions',
|
|
'fields' => array(
|
|
'id' => array(
|
|
'type' => 'char',
|
|
'length' => 36,
|
|
'not null' => true, 'description' => 'UUID of the response',
|
|
),
|
|
'uri' => array(
|
|
'type' => 'varchar',
|
|
'length' => 191,
|
|
'not null' => true,
|
|
'description' => 'UUID to the answer notice',
|
|
),
|
|
'question_id' => array(
|
|
'type' => 'char',
|
|
'length' => 36,
|
|
'not null' => true,
|
|
'description' => 'UUID of question being responded to',
|
|
),
|
|
'content' => array('type' => 'text'), // got a better name?
|
|
'best' => array('type' => 'bool'),
|
|
'revisions' => array('type' => 'int'),
|
|
'profile_id' => array('type' => 'int'),
|
|
'created' => array('type' => 'datetime', 'not null' => true),
|
|
),
|
|
'primary key' => array('id'),
|
|
'unique keys' => array(
|
|
'question_uri_key' => array('uri'),
|
|
'question_id_profile_id_key' => array('question_id', 'profile_id'),
|
|
),
|
|
'indexes' => array(
|
|
'profile_id_question_id_index' => array('profile_id', 'question_id'),
|
|
)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Get an answer based on a notice
|
|
*
|
|
* @param Notice $notice Notice to check for
|
|
*
|
|
* @return QnA_Answer found response or null
|
|
*/
|
|
public static function getByNotice($notice)
|
|
{
|
|
$answer = self::getKV('uri', $notice->uri);
|
|
if (empty($answer)) {
|
|
throw new Exception("No answer with URI {$notice->uri}");
|
|
}
|
|
return $answer;
|
|
}
|
|
|
|
/**
|
|
* Get the notice that belongs to this answer
|
|
*
|
|
* @return Notice
|
|
*/
|
|
public function getNotice()
|
|
{
|
|
return Notice::getKV('uri', $this->uri);
|
|
}
|
|
|
|
public static function fromNotice($notice)
|
|
{
|
|
return QnA_Answer::getKV('uri', $notice->uri);
|
|
}
|
|
|
|
public function getUrl()
|
|
{
|
|
return $this->getNotice()->getUrl();
|
|
}
|
|
|
|
/**
|
|
* Get the Question this is an answer to
|
|
*
|
|
* @return QnA_Question
|
|
*/
|
|
public function getQuestion()
|
|
{
|
|
$question = QnA_Question::getKV('id', $this->question_id);
|
|
if (empty($question)) {
|
|
// TRANS: Exception thown when getting a question with a non-existing ID.
|
|
// TRANS: %s is the non-existing question ID.
|
|
throw new Exception(sprintf(_m('No question with ID %s'), $this->question_id));
|
|
}
|
|
return $question;
|
|
}
|
|
|
|
public function getProfile()
|
|
{
|
|
$profile = Profile::getKV('id', $this->profile_id);
|
|
if (empty($profile)) {
|
|
// TRANS: Exception thown when getting a profile with a non-existing ID.
|
|
// TRANS: %s is the non-existing profile ID.
|
|
throw new Exception(sprintf(_m('No profile with ID %s'), $this->profile_id));
|
|
}
|
|
return $profile;
|
|
}
|
|
|
|
public function asHTML()
|
|
{
|
|
return self::toHTML(
|
|
$this->getProfile(),
|
|
$this->getQuestion(),
|
|
$this
|
|
);
|
|
}
|
|
|
|
public function asString()
|
|
{
|
|
return self::toString(
|
|
$this->getProfile(),
|
|
$this->getQuestion(),
|
|
$this
|
|
);
|
|
}
|
|
|
|
public static function toHTML($profile, $question, $answer)
|
|
{
|
|
$notice = $question->getNotice();
|
|
|
|
$out = new XMLStringer();
|
|
|
|
$cls = array('qna_answer');
|
|
if (!empty($answer->best)) {
|
|
$cls[] = 'best';
|
|
}
|
|
|
|
$out->elementStart('p', array('class' => implode(' ', $cls)));
|
|
$out->elementStart('span', 'answer-content');
|
|
$out->raw(common_render_text($answer->content));
|
|
$out->elementEnd('span');
|
|
|
|
if (!empty($answer->revisions)) {
|
|
$out->elementstart('span', 'answer-revisions');
|
|
$out->text(
|
|
htmlspecialchars(
|
|
// Notification of how often an answer was revised.
|
|
// TRANS: %s is the number of answer revisions.
|
|
sprintf(_m('%s revision', '%s revisions', $answer->revisions), $answer->revisions)
|
|
)
|
|
);
|
|
$out->elementEnd('span');
|
|
}
|
|
|
|
$out->elementEnd('p');
|
|
|
|
return $out->getString();
|
|
}
|
|
|
|
public static function toString($profile, $question, $answer)
|
|
{
|
|
// @todo FIXME: unused variable?
|
|
$notice = $question->getNotice();
|
|
|
|
return sprintf(
|
|
// TRANS: Text for a question that was answered.
|
|
// TRANS: %1$s is the user that answered, %2$s is the question title,
|
|
// TRANS: %2$s is the answer content.
|
|
_m('%1$s answered the question "%2$s": %3$s'),
|
|
htmlspecialchars($profile->getBestName()),
|
|
htmlspecialchars($question->title),
|
|
htmlspecialchars($answer->content)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Save a new answer notice
|
|
*
|
|
* @param Profile $profile
|
|
* @param Question $Question the question being answered
|
|
* @param array
|
|
*
|
|
* @return Notice saved notice
|
|
*/
|
|
public static function saveNew($profile, $question, $text, $options = null)
|
|
{
|
|
if (empty($options)) {
|
|
$options = array();
|
|
}
|
|
|
|
$answer = new QnA_Answer();
|
|
$answer->id = UUID::gen();
|
|
$answer->profile_id = $profile->id;
|
|
$answer->question_id = $question->id;
|
|
$answer->revisions = 0;
|
|
$answer->best = false;
|
|
$answer->content = $text;
|
|
$answer->created = common_sql_now();
|
|
$answer->uri = common_local_url(
|
|
'qnashowanswer',
|
|
array('id' => $answer->id)
|
|
);
|
|
|
|
common_log(LOG_DEBUG, "Saving answer: $answer->id, $answer->uri");
|
|
$answer->insert();
|
|
|
|
$content = sprintf(
|
|
// TRANS: Text for a question that was answered.
|
|
// TRANS: %s is the question title.
|
|
_m('answered "%s"'),
|
|
$question->title
|
|
);
|
|
|
|
$link = '<a href="' . htmlspecialchars($answer->uri) . '">' . htmlspecialchars($question->title) . '</a>';
|
|
// TRANS: Rendered version of the notice content answering a question.
|
|
// TRANS: %s a link to the question with question title as the link content.
|
|
$rendered = sprintf(_m('answered "%s"'), $link);
|
|
|
|
$tags = array();
|
|
$replies = array();
|
|
|
|
$options = array_merge(
|
|
array(
|
|
'urls' => array(),
|
|
'content' => $content,
|
|
'rendered' => $rendered,
|
|
'tags' => $tags,
|
|
'replies' => $replies,
|
|
'reply_to' => $question->getNotice()->id,
|
|
'object_type' => self::OBJECT_TYPE
|
|
),
|
|
$options
|
|
);
|
|
|
|
if (!array_key_exists('uri', $options)) {
|
|
$options['uri'] = $answer->uri;
|
|
}
|
|
|
|
$saved = Notice::saveNew(
|
|
$profile->id,
|
|
$content,
|
|
array_key_exists('source', $options) ?
|
|
$options['source'] : 'web',
|
|
$options
|
|
);
|
|
|
|
return $saved;
|
|
}
|
|
}
|