forked from GNUsocial/gnu-social
2a4dc77a63
I used this hacky sed-command (run it from your GNU Social root, or change the first grep's path to where it actually lies) to do a rough fix on all ::staticGet calls and rename them to ::getKV sed -i -s -e '/DataObject::staticGet/I!s/::staticGet/::getKV/Ig' $(grep -R ::staticGet `pwd`/* | grep -v -e '^extlib' | grep -v DataObject:: |grep -v "function staticGet"|cut -d: -f1 |sort |uniq) If you're applying this, remember to change the Managed_DataObject and Memcached_DataObject function definitions of staticGet to getKV! This might of course take some getting used to, or modification fo StatusNet plugins, but the result is that all the static calls (to staticGet) are now properly made without breaking PHP Strict Standards. Standards are there to be followed (and they caused some very bad confusion when used with get_called_class) Reasonably any plugin or code that tests for the definition of 'GNUSOCIAL' or similar will take this change into consideration.
320 lines
9.9 KiB
PHP
320 lines
9.9 KiB
PHP
<?php
|
|
/**
|
|
* Data class to save answers to questions
|
|
*
|
|
* PHP version 5
|
|
*
|
|
* @category QnA
|
|
* @package StatusNet
|
|
* @author Zach Copley <zach@status.net>
|
|
* @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
|
|
* @link http://status.net/
|
|
*
|
|
* StatusNet - the distributed open-source microblogging tool
|
|
* Copyright (C) 2011, StatusNet, Inc.
|
|
*
|
|
* 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/>.
|
|
*/
|
|
|
|
if (!defined('STATUSNET')) {
|
|
exit(1);
|
|
}
|
|
|
|
/**
|
|
* For storing answers
|
|
*
|
|
* @category QnA
|
|
* @package StatusNet
|
|
* @author Zach Copley <zach@status.net>
|
|
* @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
|
|
* @link http://status.net/
|
|
*
|
|
* @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 $question_id; // char(36) -> question.id UUID
|
|
public $profile_id; // int -> question.id
|
|
public $best; // (boolean) int -> 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
|
|
|
|
/**
|
|
* Get an instance by compound key
|
|
*
|
|
* This is a utility method to get a single instance with a given set of
|
|
* key-value pairs. Usually used for the primary key for a compound key; thus
|
|
* the name.
|
|
*
|
|
* @param array $kv array of key-value mappings
|
|
*
|
|
* @return QA_Answer object found, or null for no hits
|
|
*
|
|
*/
|
|
function pkeyGet($kv)
|
|
{
|
|
return Memcached_DataObject::pkeyGet('QnA_Answer', $kv);
|
|
}
|
|
|
|
/**
|
|
* 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' => 255,
|
|
'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' => 'int', 'size' => 'tiny'),
|
|
'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
|
|
*/
|
|
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
|
|
*/
|
|
function getNotice()
|
|
{
|
|
return Notice::getKV('uri', $this->uri);
|
|
}
|
|
|
|
static function fromNotice($notice)
|
|
{
|
|
return QnA_Answer::getKV('uri', $notice->uri);
|
|
}
|
|
|
|
function bestUrl()
|
|
{
|
|
return $this->getNotice()->bestUrl();
|
|
}
|
|
|
|
/**
|
|
* Get the Question this is an answer to
|
|
*
|
|
* @return QnA_Question
|
|
*/
|
|
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;
|
|
}
|
|
|
|
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;
|
|
}
|
|
|
|
function asHTML()
|
|
{
|
|
return self::toHTML(
|
|
$this->getProfile(),
|
|
$this->getQuestion(),
|
|
$this
|
|
);
|
|
}
|
|
|
|
function asString()
|
|
{
|
|
return self::toString(
|
|
$this->getProfile(),
|
|
$this->getQuestion(),
|
|
$this
|
|
);
|
|
}
|
|
|
|
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();
|
|
}
|
|
|
|
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
|
|
*/
|
|
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 = 0;
|
|
$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;
|
|
}
|
|
}
|