+++ /dev/null
-<?php
-/**
- * StatusNet - the distributed open-source microblogging tool
- * Copyright (C) 2011, StatusNet, Inc.
- *
- * Microapp plugin for Questions and Answers
- *
- * 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);
-}
-
-/**
- * Question and Answer plugin
- *
- * @category Plugin
- * @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/
- */
-class QnAPlugin extends MicroAppPlugin
-{
-
- // @fixme which domain should we use for these namespaces?
- const QUESTION_OBJECT = 'http://activityschema.org/object/question';
- const ANSWER_OBJECT = 'http://activityschema.org/object/answer';
-
- /**
- * Set up our tables (question and answer)
- *
- * @see Schema
- * @see ColumnDef
- *
- * @return boolean hook value; true means continue processing, false means stop.
- */
- function onCheckSchema()
- {
- $schema = Schema::get();
-
- $schema->ensureTable('qna_question', QnA_Question::schemaDef());
- $schema->ensureTable('qna_answer', QnA_Answer::schemaDef());
- $schema->ensureTable('qna_vote', QnA_Vote::schemaDef());
-
- return true;
- }
-
- /**
- * Load related modules when needed
- *
- * @param string $cls Name of the class to be loaded
- *
- * @return boolean hook value; true means continue processing, false means stop.
- */
- function onAutoload($cls)
- {
- $dir = dirname(__FILE__);
-
- switch ($cls)
- {
- case 'NewquestionAction':
- case 'NewanswerAction':
- case 'ShowquestionAction':
- case 'ShowanswerAction':
- case 'QnavoteAction':
- include_once $dir . '/actions/'
- . strtolower(mb_substr($cls, 0, -6)) . '.php';
- return false;
- case 'QuestionForm':
- case 'AnswerForm':
- case 'VoteForm';
- include_once $dir . '/lib/' . strtolower($cls).'.php';
- break;
- case 'QnA_Question':
- case 'QnA_Answer':
- case 'QnA_Vote':
- include_once $dir . '/classes/' . $cls.'.php';
- return false;
- break;
- default:
- return true;
- }
- }
-
- /**
- * Map URLs to actions
- *
- * @param Net_URL_Mapper $m path-to-action mapper
- *
- * @return boolean hook value; true means continue processing, false means stop.
- */
-
- function onRouterInitialized($m)
- {
- $regexId = '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}';
-
- $m->connect(
- 'main/question/new',
- array('action' => 'newquestion')
- );
- $m->connect(
- 'main/question/answer',
- array('action' => 'newanswer')
- );
- $m->connect(
- 'question/vote/:id',
- array('action' => 'qnavote', 'type' => 'question'),
- array('id' => $regexId)
- );
- $m->connect(
- 'question/:id',
- array('action' => 'showquestion'),
- array('id' => $regexId)
- );
- $m->connect(
- 'answer/vote/:id',
- array('action' => 'qnavote', 'type' => 'answer'),
- array('id' => $regexId)
- );
- $m->connect(
- 'answer/:id',
- array('action' => 'showanswer'),
- array('id' => $regexId)
- );
-
- return true;
- }
-
- function onPluginVersion(&$versions)
- {
- $versions[] = array(
- 'name' => 'QnA',
- 'version' => STATUSNET_VERSION,
- 'author' => 'Zach Copley',
- 'homepage' => 'http://status.net/wiki/Plugin:QnA',
- 'description' =>
- _m('Question and Answers micro-app.')
- );
- return true;
- }
-
- function appTitle() {
- return _m('Question');
- }
-
- function tag() {
- return 'question';
- }
-
- function types() {
- return array(
- Question::OBJECT_TYPE,
- Answer::NORMAL
- );
- }
-
- /**
- * Given a parsed ActivityStreams activity, save it into a notice
- * and other data structures.
- *
- * @param Activity $activity
- * @param Profile $actor
- * @param array $options=array()
- *
- * @return Notice the resulting notice
- */
- function saveNoticeFromActivity($activity, $actor, $options=array())
- {
- if (count($activity->objects) != 1) {
- throw new Exception('Too many activity objects.');
- }
-
- $questionObj = $activity->objects[0];
-
- if ($questinoObj->type != QnA_Question::OBJECT_TYPE) {
- throw new Exception('Wrong type for object.');
- }
-
- $notice = null;
-
- switch ($activity->verb) {
- case ActivityVerb::POST:
- $notice = Question::saveNew(
- $actor,
- $questionObj->title
- // null,
- // $questionObj->summary,
- // $options
- );
- break;
- case Answer::NORMAL:
- $question = QnA_Question::staticGet('uri', $questionObj->id);
- if (empty($question)) {
- // FIXME: save the question
- throw new Exception("Answer to unknown question.");
- }
- $notice = QnA_Answer::saveNew($actor, $question, $activity->verb, $options);
- break;
- default:
- throw new Exception("Unknown verb for question");
- }
-
- return $notice;
- }
-
- /**
- * Turn a Notice into an activity object
- *
- * @param Notice $notice
- *
- * @return ActivityObject
- */
-
- function activityObjectFromNotice($notice)
- {
- $question = null;
-
- switch ($notice->object_type) {
- case Question::OBJECT_TYPE:
- $question = Qeustion::fromNotice($notice);
- break;
- case Answer::NORMAL:
- case Answer::ANONYMOUS:
- $answer = Answer::fromNotice($notice);
- $question = $answer->getQuestion();
- break;
- }
-
- if (empty($question)) {
- throw new Exception("Unknown object type.");
- }
-
- $notice = $question->getNotice();
-
- if (empty($notice)) {
- throw new Exception("Unknown question notice.");
- }
-
- $obj = new ActivityObject();
-
- $obj->id = $question->uri;
- $obj->type = Question::OBJECT_TYPE;
- $obj->title = $question->title;
- $obj->link = $notice->bestUrl();
-
- // XXX: probably need other stuff here
-
- return $obj;
- }
-
- /**
- * Change the verb on Answer notices
- *
- * @param Notice $notice
- *
- * @return ActivityObject
- */
-
- function onEndNoticeAsActivity($notice, &$act) {
- switch ($notice->object_type) {
- case Answer::NORMAL:
- case Answer::ANONYMOUS:
- $act->verb = $notice->object_type;
- break;
- }
- return true;
- }
-
- /**
- * Custom HTML output for our notices
- *
- * @param Notice $notice
- * @param HTMLOutputter $out
- */
-
- function showNotice($notice, $out)
- {
- switch ($notice->object_type) {
- case Question::OBJECT_TYPE:
- $this->showQuestionNotice($notice, $out);
- break;
- case Answer::NORMAL:
- case Answer::ANONYMOUS:
- case RSVP::POSSIBLE:
- $this->showAnswerNotice($notice, $out);
- break;
- }
-
- $out->elementStart('div', array('class' => 'question'));
-
- $profile = $notice->getProfile();
- $avatar = $profile->getAvatar(AVATAR_MINI_SIZE);
-
- $out->element('img',
- array('src' => ($avatar) ?
- $avatar->displayUrl() :
- Avatar::defaultImage(AVATAR_MINI_SIZE),
- 'class' => 'avatar photo bookmark-avatar',
- 'width' => AVATAR_MINI_SIZE,
- 'height' => AVATAR_MINI_SIZE,
- 'alt' => $profile->getBestName()));
-
- $out->raw(' '); // avoid for AJAX XML compatibility
-
- $out->elementStart('span', 'vcard author'); // hack for belongsOnTimeline; JS needs to be able to find the author
- $out->element('a',
- array('class' => 'url',
- 'href' => $profile->profileurl,
- 'title' => $profile->getBestName()),
- $profile->nickname);
- $out->elementEnd('span');
- }
-
- function showAnswerNotice($notice, $out)
- {
- $rsvp = Answer::fromNotice($notice);
-
- $out->elementStart('div', 'answer');
- $out->raw($answer->asHTML());
- $out->elementEnd('div');
- return;
- }
-
- function showQuestionNotice($notice, $out)
- {
- $profile = $notice->getProfile();
- $question = Question::fromNotice($notice);
-
- assert(!empty($question));
- assert(!empty($profile));
-
- $out->elementStart('div', 'question-notice');
-
- $out->elementStart('h3');
-
- if (!empty($question->url)) {
- $out->element('a',
- array('href' => $question->url,
- 'class' => 'question-title'),
- $question->title);
- } else {
- $out->text($question->title);
- }
-
- if (!empty($question->location)) {
- $out->elementStart('div', 'question-location');
- $out->element('strong', null, _('Location: '));
- $out->element('span', 'location', $question->location);
- $out->elementEnd('div');
- }
-
- if (!empty($question->description)) {
- $out->elementStart('div', 'question-description');
- $out->element('strong', null, _('Description: '));
- $out->element('span', 'description', $question->description);
- $out->elementEnd('div');
- }
-
- $answers = $question->getAnswers();
-
- $out->elementStart('div', 'question-answers');
- $out->element('strong', null, _('Answer: '));
- $out->element('span', 'question-answer');
-
- // XXX I dunno
-
- $out->elementEnd('div');
-
- $user = common_current_user();
-
- if (!empty($user)) {
- $question = $question->getAnswer($user->getProfile());
-
- if (empty($answer)) {
- $form = new AnswerForm($question, $out);
- }
-
- $form->show();
- }
-
- $out->elementEnd('div');
- }
-
- /**
- * Form for our app
- *
- * @param HTMLOutputter $out
- * @return Widget
- */
-
- function entryForm($out)
- {
- return new QuestionForm($out);
- }
-
- /**
- * When a notice is deleted, clean up related tables.
- *
- * @param Notice $notice
- */
-
- function deleteRelated($notice)
- {
- switch ($notice->object_type) {
- case Question::OBJECT_TYPE:
- common_log(LOG_DEBUG, "Deleting question from notice...");
- $question = Question::fromNotice($notice);
- $question->delete();
- break;
- case Answer::NORMAL:
- case Answer::ANONYMOUS:
- common_log(LOG_DEBUG, "Deleting answer from notice...");
- $answer = Answer::fromNotice($notice);
- common_log(LOG_DEBUG, "to delete: $answer->id");
- $answer->delete();
- break;
- default:
- common_log(LOG_DEBUG, "Not deleting related, wtf...");
- }
- }
-
- function onEndShowScripts($action)
- {
- // XXX maybe some cool shiz here
- }
-
- function onEndShowStyles($action)
- {
- $action->cssLink($this->path('css/questionandanswer.css'));
- return true;
- }
-}
*/
class QnA_Answer extends Managed_DataObject
{
- CONST ANSWER = 'http://activityschema.org/object/answer';
+ const OBJECT_TYPE = 'http://activityschema.org/object/answer';
public $__table = 'qna_answer'; // table name
public $id; // char(36) primary key not null -> UUID
return Question::staticGet('id', $this->question_id);
}
+ static function fromNotice($notice)
+ {
+ return QnA_Answer::staticGet('uri', $notice->uri);
+ }
+
/**
* Save a new answer notice
*
*
* @return Notice saved notice
*/
- static function saveNew($profile, $question, $options=null)
+ static function saveNew($profile, $question, $options = null)
{
if (empty($options)) {
$options = array();
}
- $a = new Answer();
- $a->id = UUID::gen();
- $a->profile_id = $profile->id;
- $a->question_id = $question->id;
- $a->created = common_sql_now();
- $a->uri = common_local_url(
+ $answer = new Answer();
+ $answer->id = UUID::gen();
+ $answer->profile_id = $profile->id;
+ $answer->question_id = $question->id;
+ $answer->created = common_sql_now();
+ $answer->uri = common_local_url(
'showanswer',
- array('id' => $pr->id)
+ array('id' => $answer->id)
);
- common_log(LOG_DEBUG, "Saving answer: $pr->id $pr->uri");
- $a->insert();
+ common_log(LOG_DEBUG, "Saving answer: $answer->id, $answer->uri");
+ $answer->insert();
// TRANS: Notice content answering a question.
// TRANS: %s is the answer
$content = sprintf(
_m('answered "%s"'),
- $answer
+ $answer->uri
);
- $link = '<a href="' . htmlspecialchars($question->uri) . '">' . htmlspecialchars($answer) . '</a>';
+ $link = '<a href="' . htmlspecialchars($answer->uri) . '">' . htmlspecialchars($answer) . '</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);
$options = array_merge(
array(
- 'urls' => array(),
- 'rendered' => $rendered,
- 'tags' => $tags,
- 'replies' => $replies,
- 'reply_to' => $question->getNotice()->id,
- 'object_type' => QnA::ANSWER_OBJECT),
+ 'urls' => array(),
+ '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'] = $pr->uri;
+ $options['uri'] = $answer->uri;
}
$saved = Notice::saveNew(