3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2011, StatusNet, Inc.
6 * Microapp plugin for Questions and Answers
10 * This program is free software: you can redistribute it and/or modify
11 * it under the terms of the GNU Affero General Public License as published by
12 * the Free Software Foundation, either version 3 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU Affero General Public License for more details.
20 * You should have received a copy of the GNU Affero General Public License
21 * along with this program. If not, see <http://www.gnu.org/licenses/>.
25 * @author Zach Copley <zach@status.net>
26 * @copyright 2011 StatusNet, Inc.
27 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
28 * @link http://status.net/
31 if (!defined('STATUSNET')) {
32 // This check helps protect against security problems;
33 // your code file can't be executed directly from the web.
38 * Question and Answer plugin
42 * @author Zach Copley <zach@status.net>
43 * @copyright 2011 StatusNet, Inc.
44 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
45 * @link http://status.net/
47 class QnAPlugin extends MicroAppPlugin
50 * Set up our tables (question and answer)
55 * @return boolean hook value; true means continue processing, false means stop.
57 function onCheckSchema()
59 $schema = Schema::get();
61 $schema->ensureTable('qna_question', QnA_Question::schemaDef());
62 $schema->ensureTable('qna_answer', QnA_Answer::schemaDef());
63 $schema->ensureTable('qna_vote', QnA_Vote::schemaDef());
69 * Load related modules when needed
71 * @param string $cls Name of the class to be loaded
73 * @return boolean hook value; true means continue processing, false means stop.
75 function onAutoload($cls)
77 $dir = dirname(__FILE__);
81 case 'QnanewquestionAction':
82 case 'QnanewanswerAction':
83 case 'QnashowquestionAction':
84 case 'QnaclosequestionAction':
85 case 'QnashowanswerAction':
86 case 'QnareviseanswerAction':
88 include_once $dir . '/actions/'
89 . strtolower(mb_substr($cls, 0, -6)) . '.php';
91 case 'QnanewquestionForm':
92 case 'QnashowquestionForm':
93 case 'QnanewanswerForm':
94 case 'QnashowanswerForm':
95 case 'QnareviseanswerForm':
97 include_once $dir . '/lib/' . strtolower($cls).'.php';
102 include_once $dir . '/classes/' . $cls.'.php';
111 * Map URLs to actions
113 * @param Net_URL_Mapper $m path-to-action mapper
115 * @return boolean hook value; true means continue processing, false means stop.
118 function onRouterInitialized($m)
120 $UUIDregex = '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}';
123 'main/qna/newquestion',
124 array('action' => 'qnanewquestion')
127 'answer/qna/closequestion',
128 array('action' => 'qnaclosequestion')
131 'main/qna/newanswer',
132 array('action' => 'qnanewanswer')
135 'main/qna/reviseanswer',
136 array('action' => 'qnareviseanswer')
140 array('action' => 'qnavote', 'type' => 'question'),
141 array('id' => $UUIDregex)
145 array('action' => 'qnashowquestion'),
146 array('id' => $UUIDregex)
150 array('action' => 'qnavote', 'type' => 'answer'),
151 array('id' => $UUIDregex)
155 array('action' => 'qnashowanswer'),
156 array('id' => $UUIDregex)
162 function onPluginVersion(&$versions)
166 'version' => STATUSNET_VERSION,
167 'author' => 'Zach Copley',
168 'homepage' => 'http://status.net/wiki/Plugin:QnA',
170 // TRANS: Plugin description.
171 _m('Question and Answers micro-app.')
176 function appTitle() {
177 // TRANS: Application title.
178 return _m('Question');
187 QnA_Question::OBJECT_TYPE,
188 QnA_Answer::OBJECT_TYPE
193 * Given a parsed ActivityStreams activity, save it into a notice
194 * and other data structures.
196 * @param Activity $activity
197 * @param Profile $actor
198 * @param array $options=array()
200 * @return Notice the resulting notice
202 function saveNoticeFromActivity($activity, $actor, $options=array())
204 if (count($activity->objects) != 1) {
205 throw new Exception(_m('Too many activity objects.'));
208 $questionObj = $activity->objects[0];
210 if ($questionObj->type != QnA_Question::OBJECT_TYPE) {
211 throw new Exception(_m('Wrong type for object.'));
216 switch ($activity->verb) {
217 case ActivityVerb::POST:
218 $notice = QnA_Question::saveNew(
221 $questionObj->summary,
225 case Answer::ObjectType:
226 $question = QnA_Question::staticGet('uri', $questionObj->id);
227 if (empty($question)) {
228 // FIXME: save the question
229 throw new Exception(_m('Answer to unknown question.'));
231 $notice = QnA_Answer::saveNew($actor, $question, $options);
234 throw new Exception(_m('Unknown object type received by QnA Plugin.'));
241 * Turn a Notice into an activity object
243 * @param Notice $notice
245 * @return ActivityObject
248 function activityObjectFromNotice($notice)
252 switch ($notice->object_type) {
253 case QnA_Question::OBJECT_TYPE:
254 $question = QnA_Question::fromNotice($notice);
256 case QnA_Answer::OBJECT_TYPE:
257 $answer = QnA_Answer::fromNotice($notice);
258 $question = $answer->getQuestion();
262 if (empty($question)) {
263 throw new Exception(_m('Unknown object type.'));
266 $notice = $question->getNotice();
268 if (empty($notice)) {
269 throw new Exception(_m('Unknown question notice.'));
272 $obj = new ActivityObject();
274 $obj->id = $question->uri;
275 $obj->type = QnA_Question::OBJECT_TYPE;
276 $obj->title = $question->title;
277 $obj->link = $notice->bestUrl();
279 // XXX: probably need other stuff here
285 * Output our CSS class for QnA notice list elements
287 * @param NoticeListItem $nli The item being shown
289 * @return boolean hook value
292 function onStartOpenNoticeListItemElement($nli)
294 $type = $nli->notice->object_type;
298 case QnA_Question::OBJECT_TYPE:
299 $id = (empty($nli->repeat)) ? $nli->notice->id : $nli->repeat->id;
300 $class = 'hentry notice question';
301 if ($nli->notice->scope != 0 && $nli->notice->scope != 1) {
302 $class .= ' limited-scope';
305 $question = QnA_Question::staticGet('uri', $nli->notice->uri);
307 if (!empty($question->closed)) {
311 $nli->out->elementStart(
314 'id' => 'notice-' . $id
317 Event::handle('EndOpenNoticeListItemElement', array($nli));
320 case QnA_Answer::OBJECT_TYPE:
321 $id = (empty($nli->repeat)) ? $nli->notice->id : $nli->repeat->id;
323 $cls = array('hentry', 'notice', 'answer');
325 $answer = QnA_Answer::staticGet('uri', $nli->notice->uri);
327 if (!empty($answer) && !empty($answer->best)) {
331 $nli->out->elementStart(
334 'class' => implode(' ', $cls),
335 'id' => 'notice-' . $id
338 Event::handle('EndOpenNoticeListItemElement', array($nli));
349 * Custom HTML output for our notices
351 * @param Notice $notice
352 * @param HTMLOutputter $out
354 function showNotice($notice, $out)
356 switch ($notice->object_type) {
357 case QnA_Question::OBJECT_TYPE:
358 return $this->showNoticeQuestion($notice, $out);
359 case QnA_Answer::OBJECT_TYPE:
360 return $this->showNoticeAnswer($notice, $out);
363 // TRANS: Exception thrown when performing an unexpected action on a question.
364 // TRANS: %s is the unpexpected object type.
365 sprintf(_m('Unexpected type for QnA plugin: %s.'),
372 function showNoticeQuestion($notice, $out)
374 $user = common_current_user();
376 // @hack we want regular rendering, then just add stuff after that
377 $nli = new NoticeListItem($notice, $out);
380 $out->elementStart('div', array('class' => 'entry-content question-description'));
382 $question = QnA_Question::getByNotice($notice);
384 if (!empty($question)) {
386 $form = new QnashowquestionForm($out, $question);
390 $out->text(_m('Question data is missing.'));
392 $out->elementEnd('div');
395 $out->elementStart('div', array('class' => 'entry-content'));
400 * Output the HTML for this kind of object in a list
402 * @param NoticeListItem $nli The list item being shown.
404 * @return boolean hook value
406 * @fixme WARNING WARNING WARNING this closes a 'div' that is implicitly opened in BookmarkPlugin's showNotice implementation
408 function onStartShowNoticeItem($nli)
410 if (!$this->isMyNotice($nli->notice)) {
415 $notice = $nli->notice;
417 $this->showNotice($notice, $out);
419 $nli->showNoticeLink();
420 $nli->showNoticeSource();
421 $nli->showNoticeLocation();
425 $out->elementEnd('div');
427 $nli->showNoticeOptions();
429 if ($notice->object_type == QnA_Question::OBJECT_TYPE) {
431 $user = common_current_user();
432 $question = QnA_Question::getByNotice($notice);
436 $profile = $user->getProfile();
437 $answer = $question->getAnswer($profile);
439 // Output a placeholder input -- clicking on it will
440 // bring up a real answer form
442 // NOTE: this whole ul is just a placeholder
443 if (empty($question->closed) && empty($answer)) {
444 $out->elementStart('ul', 'notices qna-dummy');
445 $out->elementStart('li', 'qna-dummy-placeholder');
449 'class' => 'placeholder',
450 'value' => _m('Your answer...')
453 $out->elementEnd('li');
454 $out->elementEnd('ul');
463 function showNoticeAnswer($notice, $out)
465 $user = common_current_user();
467 $answer = QnA_Answer::getByNotice($notice);
468 $question = $answer->getQuestion();
470 $nli = new NoticeListItem($notice, $out);
473 $out->elementStart('div', array('class' => 'entry-content answer-content'));
475 if (!empty($answer)) {
476 $form = new QnashowanswerForm($out, $answer);
479 $out->text(_m('Answer data is missing.'));
482 $out->elementEnd('div');
485 $out->elementStart('div', array('class' => 'entry-content'));
488 static function shorten($content, $notice)
492 if (Notice::contentTooLong($content)) {
493 common_debug("content too long");
494 $max = Notice::maxContent();
495 $short = mb_substr($content, 0, $max - 1);
497 // TRANS: Link to full notice text if it is longer than what will be dispplayed.
498 // TRANS: %s a notice URI.
499 _m('<a href="%s" rel="more" title="%s">…</a>'),
513 * @param HTMLOutputter $out
517 function entryForm($out)
519 return new QnanewquestionForm($out);
523 * When a notice is deleted, clean up related tables.
525 * @param Notice $notice
528 function deleteRelated($notice)
530 switch ($notice->object_type) {
531 case QnA_Question::OBJECT_TYPE:
532 common_log(LOG_DEBUG, "Deleting question from notice...");
533 $question = QnA_Question::fromNotice($notice);
536 case QnA_Answer::OBJECT_TYPE:
537 common_log(LOG_DEBUG, "Deleting answer from notice...");
538 $answer = QnA_Answer::fromNotice($notice);
539 common_log(LOG_DEBUG, "to delete: $answer->id");
543 common_log(LOG_DEBUG, "Not deleting related, wtf...");
547 function onEndShowScripts($action)
549 $action->script($this->path('js/qna.js'));
553 function onEndShowStyles($action)
555 $action->cssLink($this->path('css/qna.css'));