plugins/QnA/QnAPlugin.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2011, StatusNet, Inc.
   5  *
   6  * Microapp plugin for Questions and Answers
   7  *
   8  * PHP version 5
   9  *
  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.
  14  *
  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.
  19  *
  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/>.
  22  *
  23  * @category  QnA
  24  * @package   StatusNet
  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/
  29  */
  30
  31 if (!defined('STATUSNET')) {
  32     // This check helps protect against security problems;
  33     // your code file can't be executed directly from the web.
  34     exit(1);
  35 }
  36
  37 /**
  38  * Question and Answer plugin
  39  *
  40  * @category  Plugin
  41  * @package   StatusNet
  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/
  46  */
  47 class QnAPlugin extends MicroAppPlugin
  48 {
  49     /**
  50      * Set up our tables (question and answer)
  51      *
  52      * @see Schema
  53      * @see ColumnDef
  54      *
  55      * @return boolean hook value; true means continue processing, false means stop.
  56      */
  57     function onCheckSchema()
  58     {
  59         $schema = Schema::get();
  60
  61         $schema->ensureTable('qna_question', QnA_Question::schemaDef());
  62         $schema->ensureTable('qna_answer', QnA_Answer::schemaDef());
  63         $schema->ensureTable('qna_vote', QnA_Vote::schemaDef());
  64
  65         return true;
  66     }
  67
  68     /**
  69      * Load related modules when needed
  70      *
  71      * @param string $cls Name of the class to be loaded
  72      *
  73      * @return boolean hook value; true means continue processing, false means stop.
  74      */
  75     function onAutoload($cls)
  76     {
  77         $dir = dirname(__FILE__);
  78
  79         switch ($cls)
  80         {
  81         case 'QnanewquestionAction':
  82         case 'QnanewanswerAction':
  83         case 'QnashowquestionAction':
  84         case 'QnaclosequestionAction':
  85         case 'QnashowanswerAction':
  86         case 'QnareviseanswerAction':
  87         case 'QnavoteAction':
  88             include_once $dir . '/actions/'
  89                 . strtolower(mb_substr($cls, 0, -6)) . '.php';
  90             return false;
  91         case 'QnanewquestionForm':
  92         case 'QnashowquestionForm':
  93         case 'QnanewanswerForm':
  94         case 'QnashowanswerForm':
  95         case 'QnareviseanswerForm':
  96         case 'QnavoteForm':
  97             include_once $dir . '/lib/' . strtolower($cls).'.php';
  98             break;
  99         case 'QnA_Question':
 100         case 'QnA_Answer':
 101         case 'QnA_Vote':
 102             include_once $dir . '/classes/' . $cls.'.php';
 103             return false;
 104             break;
 105         default:
 106             return true;
 107         }
 108     }
 109
 110     /**
 111      * Map URLs to actions
 112      *
 113      * @param Net_URL_Mapper $m path-to-action mapper
 114      *
 115      * @return boolean hook value; true means continue processing, false means stop.
 116      */
 117
 118     function onRouterInitialized($m)
 119     {
 120         $UUIDregex = '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}';
 121
 122         $m->connect(
 123             'main/qna/newquestion',
 124             array('action' => 'qnanewquestion')
 125         );
 126         $m->connect(
 127             'answer/qna/closequestion',
 128             array('action' => 'qnaclosequestion')
 129         );
 130         $m->connect(
 131             'main/qna/newanswer',
 132             array('action' => 'qnanewanswer')
 133         );
 134         $m->connect(
 135             'main/qna/reviseanswer',
 136             array('action' => 'qnareviseanswer')
 137         );
 138         $m->connect(
 139             'question/vote/:id',
 140             array('action' => 'qnavote', 'type' => 'question'),
 141             array('id' => $UUIDregex)
 142         );
 143         $m->connect(
 144             'question/:id',
 145             array('action' => 'qnashowquestion'),
 146             array('id' => $UUIDregex)
 147         );
 148         $m->connect(
 149             'answer/vote/:id',
 150             array('action' => 'qnavote', 'type' => 'answer'),
 151             array('id' => $UUIDregex)
 152         );
 153         $m->connect(
 154             'answer/:id',
 155             array('action' => 'qnashowanswer'),
 156             array('id' => $UUIDregex)
 157         );
 158
 159         return true;
 160     }
 161
 162     function onPluginVersion(&$versions)
 163     {
 164         $versions[] = array(
 165             'name'        => 'QnA',
 166             'version'     => STATUSNET_VERSION,
 167             'author'      => 'Zach Copley',
 168             'homepage'    => 'http://status.net/wiki/Plugin:QnA',
 169             'description' =>
 170              // TRANS: Plugin description.
 171              _m('Question and Answers micro-app.')
 172         );
 173         return true;
 174     }
 175
 176     function appTitle() {
 177         // TRANS: Application title.
 178         return _m('Question');
 179     }
 180
 181     function tag() {
 182         return 'question';
 183     }
 184
 185     function types() {
 186         return array(
 187             QnA_Question::OBJECT_TYPE,
 188             QnA_Answer::OBJECT_TYPE
 189         );
 190     }
 191
 192     /**
 193      * Given a parsed ActivityStreams activity, save it into a notice
 194      * and other data structures.
 195      *
 196      * @param Activity $activity
 197      * @param Profile $actor
 198      * @param array $options=array()
 199      *
 200      * @return Notice the resulting notice
 201      */
 202     function saveNoticeFromActivity($activity, $actor, $options=array())
 203     {
 204         if (count($activity->objects) != 1) {
 205             throw new Exception(_m('Too many activity objects.'));
 206         }
 207
 208         $questionObj = $activity->objects[0];
 209
 210         if ($questionObj->type != QnA_Question::OBJECT_TYPE) {
 211             throw new Exception(_m('Wrong type for object.'));
 212         }
 213
 214         $notice = null;
 215
 216         switch ($activity->verb) {
 217         case ActivityVerb::POST:
 218             $notice = QnA_Question::saveNew(
 219                 $actor,
 220                 $questionObj->title,
 221                 $questionObj->summary,
 222                 $options
 223             );
 224             break;
 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.'));
 230             }
 231             $notice = QnA_Answer::saveNew($actor, $question, $options);
 232             break;
 233         default:
 234             throw new Exception(_m('Unknown object type received by QnA Plugin.'));
 235         }
 236
 237         return $notice;
 238     }
 239
 240     /**
 241      * Turn a Notice into an activity object
 242      *
 243      * @param Notice $notice
 244      *
 245      * @return ActivityObject
 246      */
 247
 248     function activityObjectFromNotice($notice)
 249     {
 250         $question = null;
 251
 252         switch ($notice->object_type) {
 253         case QnA_Question::OBJECT_TYPE:
 254             $question = QnA_Question::fromNotice($notice);
 255             break;
 256         case QnA_Answer::OBJECT_TYPE:
 257             $answer   = QnA_Answer::fromNotice($notice);
 258             $question = $answer->getQuestion();
 259             break;
 260         }
 261
 262         if (empty($question)) {
 263             throw new Exception(_m('Unknown object type.'));
 264         }
 265
 266         $notice = $question->getNotice();
 267
 268         if (empty($notice)) {
 269             throw new Exception(_m('Unknown question notice.'));
 270         }
 271
 272         $obj = new ActivityObject();
 273
 274         $obj->id      = $question->uri;
 275         $obj->type    = QnA_Question::OBJECT_TYPE;
 276         $obj->title   = $question->title;
 277         $obj->link    = $notice->bestUrl();
 278
 279         // XXX: probably need other stuff here
 280
 281         return $obj;
 282     }
 283
 284     /**
 285      * Output our CSS class for QnA notice list elements
 286      *
 287      * @param NoticeListItem $nli The item being shown
 288      *
 289      * @return boolean hook value
 290      */
 291
 292     function onStartOpenNoticeListItemElement($nli)
 293     {
 294         $type = $nli->notice->object_type;
 295
 296         switch($type)
 297         {
 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';
 303             }
 304
 305             $question = QnA_Question::staticGet('uri', $nli->notice->uri);
 306
 307             if (!empty($question->closed)) {
 308                 $class .= ' closed';
 309             }
 310
 311             $nli->out->elementStart(
 312                 'li', array(
 313                     'class' => $class,
 314                     'id'    => 'notice-' . $id
 315                 )
 316             );
 317             Event::handle('EndOpenNoticeListItemElement', array($nli));
 318             return false;
 319             break;
 320         case QnA_Answer::OBJECT_TYPE:
 321             $id = (empty($nli->repeat)) ? $nli->notice->id : $nli->repeat->id;
 322
 323             $cls = array('hentry', 'notice', 'answer');
 324
 325             $answer = QnA_Answer::staticGet('uri', $nli->notice->uri);
 326
 327             if (!empty($answer) && !empty($answer->best)) {
 328                 $cls[] = 'best';
 329             }
 330
 331             $nli->out->elementStart(
 332                 'li',
 333                 array(
 334                     'class' => implode(' ', $cls),
 335                     'id'    => 'notice-' . $id
 336                 )
 337             );
 338             Event::handle('EndOpenNoticeListItemElement', array($nli));
 339             return false;
 340             break;
 341         default:
 342             return true;
 343         }
 344
 345         return true;
 346     }
 347
 348     /**
 349      * Custom HTML output for our notices
 350      *
 351      * @param Notice $notice
 352      * @param HTMLOutputter $out
 353      */
 354     function showNotice($notice, $out)
 355     {
 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);
 361         default:
 362             throw new Exception(
 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.'),
 366                         $notice->object_type
 367                 )
 368             );
 369         }
 370     }
 371
 372     function showNoticeQuestion($notice, $out)
 373     {
 374         $user = common_current_user();
 375
 376         // @hack we want regular rendering, then just add stuff after that
 377         $nli = new NoticeListItem($notice, $out);
 378         $nli->showNotice();
 379
 380         $out->elementStart('div', array('class' => 'entry-content question-description'));
 381
 382         $question = QnA_Question::getByNotice($notice);
 383
 384         if (!empty($question)) {
 385
 386             $form = new QnashowquestionForm($out, $question);
 387             $form->show();
 388
 389         } else {
 390             $out->text(_m('Question data is missing.'));
 391         }
 392         $out->elementEnd('div');
 393
 394         // @fixme
 395         $out->elementStart('div', array('class' => 'entry-content'));
 396     }
 397
 398
 399     /**
 400      * Output the HTML for this kind of object in a list
 401      *
 402      * @param NoticeListItem $nli The list item being shown.
 403      *
 404      * @return boolean hook value
 405      *
 406      * @fixme WARNING WARNING WARNING this closes a 'div' that is implicitly opened in BookmarkPlugin's showNotice implementation
 407      */
 408     function onStartShowNoticeItem($nli)
 409     {
 410         if (!$this->isMyNotice($nli->notice)) {
 411             return true;
 412         }
 413
 414         $out = $nli->out;
 415         $notice = $nli->notice;
 416
 417         $this->showNotice($notice, $out);
 418
 419         $nli->showNoticeLink();
 420         $nli->showNoticeSource();
 421         $nli->showNoticeLocation();
 422         $nli->showContext();
 423         $nli->showRepeat();
 424
 425         $out->elementEnd('div');
 426
 427         $nli->showNoticeOptions();
 428
 429         if ($notice->object_type == QnA_Question::OBJECT_TYPE) {
 430
 431             $user = common_current_user();
 432             $question = QnA_Question::getByNotice($notice);
 433
 434             if (!empty($user)) {
 435
 436                 $profile = $user->getProfile();
 437                 $answer = $question->getAnswer($profile);
 438
 439                 // Output a placeholder input -- clicking on it will
 440                 // bring up a real answer form
 441
 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');
 446                     $out->element(
 447                         'input',
 448                         array(
 449                             'class' => 'placeholder',
 450                             'value' => _m('Your answer...')
 451                         )
 452                     );
 453                     $out->elementEnd('li');
 454                     $out->elementEnd('ul');
 455                 }
 456             }
 457         }
 458
 459         return false;
 460     }
 461
 462
 463     function showNoticeAnswer($notice, $out)
 464     {
 465         $user = common_current_user();
 466
 467         $answer   = QnA_Answer::getByNotice($notice);
 468         $question = $answer->getQuestion();
 469
 470         $nli = new NoticeListItem($notice, $out);
 471         $nli->showNotice();
 472
 473         $out->elementStart('div', array('class' => 'entry-content answer-content'));
 474
 475         if (!empty($answer)) {
 476             $form = new QnashowanswerForm($out, $answer);
 477             $form->show();
 478         } else {
 479             $out->text(_m('Answer data is missing.'));
 480         }
 481
 482         $out->elementEnd('div');
 483
 484         // @fixme
 485         $out->elementStart('div', array('class' => 'entry-content'));
 486     }
 487
 488     static function shorten($content, $notice)
 489     {
 490         $short = null;
 491
 492         if (Notice::contentTooLong($content)) {
 493             common_debug("content too long");
 494             $max = Notice::maxContent();
 495             $short = mb_substr($content, 0, $max - 1);
 496             $short .= sprintf(
 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>'),
 500                 $notice->uri,
 501                 _m('more...')
 502             );
 503         } else {
 504             $short = $content;
 505         }
 506
 507         return $short;
 508     }
 509
 510     /**
 511      * Form for our app
 512      *
 513      * @param HTMLOutputter $out
 514      * @return Widget
 515      */
 516
 517     function entryForm($out)
 518     {
 519         return new QnanewquestionForm($out);
 520     }
 521
 522     /**
 523      * When a notice is deleted, clean up related tables.
 524      *
 525      * @param Notice $notice
 526      */
 527
 528     function deleteRelated($notice)
 529     {
 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);
 534             $question->delete();
 535             break;
 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");
 540             $answer->delete();
 541             break;
 542         default:
 543             common_log(LOG_DEBUG, "Not deleting related, wtf...");
 544         }
 545     }
 546
 547     function onEndShowScripts($action)
 548     {
 549         $action->script($this->path('js/qna.js'));
 550         return true;
 551     }
 552
 553     function onEndShowStyles($action)
 554     {
 555         $action->cssLink($this->path('css/qna.css'));
 556         return true;
 557     }
 558 }