plugins/QnA/classes/QnA_Question.php

   1 <?php
   2 /**
   3  * Data class to mark a notice as a question
   4  *
   5  * PHP version 5
   6  *
   7  * @category QnA
   8  * @package  StatusNet
   9  * @author   Zach Copley <zach@status.net>
  10  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
  11  * @link     http://status.net/
  12  *
  13  * StatusNet - the distributed open-source microblogging tool
  14  * Copyright (C) 2011, StatusNet, Inc.
  15  *
  16  * This program is free software: you can redistribute it and/or modify
  17  * it under the terms of the GNU Affero General Public License as published by
  18  * the Free Software Foundation, either version 3 of the License, or
  19  * (at your option) any later version.
  20  *
  21  * This program is distributed in the hope that it will be useful,
  22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.     See the
  24  * GNU Affero General Public License for more details.
  25  *
  26  * You should have received a copy of the GNU Affero General Public License
  27  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  28  */
  29
  30 if (!defined('STATUSNET')) {
  31     exit(1);
  32 }
  33
  34 /**
  35  * For storing a question
  36  *
  37  * @category QnA
  38  * @package  StatusNet
  39  * @author   Zach Copley <zach@status.net>
  40  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
  41  * @link     http://status.net/
  42  *
  43  * @see      DB_DataObject
  44  */
  45
  46 class QnA_Question extends Managed_DataObject
  47 {
  48     const OBJECT_TYPE = 'http://activityschema.org/object/question';
  49
  50     public $__table = 'qna_question'; // table name
  51     public $id;          // char(36) primary key not null -> UUID
  52     public $uri;
  53     public $profile_id;  // int -> profile.id
  54     public $title;       // text
  55     public $description; // text
  56     public $closed;      // int (boolean) whether a question is closed
  57     public $created;     // datetime
  58
  59     /**
  60      * Get an instance by key
  61      *
  62      * This is a utility method to get a single instance with a given key value.
  63      *
  64      * @param string $k Key to use to lookup
  65      * @param mixed  $v Value to lookup
  66      *
  67      * @return QnA_Question object found, or null for no hits
  68      *
  69      */
  70     function staticGet($k, $v=null)
  71     {
  72         return Memcached_DataObject::staticGet('QnA_Question', $k, $v);
  73     }
  74
  75     /**
  76      * Get an instance by compound key
  77      *
  78      * This is a utility method to get a single instance with a given set of
  79      * key-value pairs. Usually used for the primary key for a compound key; thus
  80      * the name.
  81      *
  82      * @param array $kv array of key-value mappings
  83      *
  84      * @return Bookmark object found, or null for no hits
  85      *
  86      */
  87     function pkeyGet($kv)
  88     {
  89         return Memcached_DataObject::pkeyGet('QnA_Question', $kv);
  90     }
  91
  92     /**
  93      * The One True Thingy that must be defined and declared.
  94      */
  95     public static function schemaDef()
  96     {
  97         return array(
  98             'description' => 'Per-notice question data for QNA plugin',
  99             'fields' => array(
 100                 'id' => array(
 101                     'type'        => 'char',
 102                     'length'      => 36,
 103                     'not null'    => true,
 104                     'description' => 'UUID'
 105                 ),
 106                 'uri' => array(
 107                     'type'     => 'varchar',
 108                     'length'   => 255,
 109                     'not null' => true
 110                 ),
 111                 'profile_id'  => array('type' => 'int'),
 112                 'title'       => array('type' => 'text'),
 113                 'closed'      => array('type' => 'int', 'size' => 'tiny'),
 114                 'description' => array('type' => 'text'),
 115                 'created'     => array(
 116                     'type'     => 'datetime',
 117                     'not null' => true
 118                 ),
 119             ),
 120             'primary key' => array('id'),
 121             'unique keys' => array(
 122                 'question_uri_key' => array('uri'),
 123             ),
 124         );
 125     }
 126
 127     /**
 128      * Get a question based on a notice
 129      *
 130      * @param Notice $notice Notice to check for
 131      *
 132      * @return Question found question or null
 133      */
 134     function getByNotice($notice)
 135     {
 136         return self::staticGet('uri', $notice->uri);
 137     }
 138
 139     function getNotice()
 140     {
 141         return Notice::staticGet('uri', $this->uri);
 142     }
 143
 144     function bestUrl()
 145     {
 146         return $this->getNotice()->bestUrl();
 147     }
 148
 149     function getProfile()
 150     {
 151         $profile = Profile::staticGet('id', $this->profile_id);
 152         if (empty($profile)) {
 153             throw new Exception("No profile with ID {$this->profile_id}");
 154         }
 155         return $profile;
 156     }
 157
 158     /**
 159      * Get the answer from a particular user to this question, if any.
 160      *
 161      * @param Profile $profile
 162      *
 163      * @return Answer object or null
 164      */
 165     function getAnswer(Profile $profile)
 166     {
 167         $a = new QnA_Answer();
 168         $a->question_id = $this->id;
 169         $a->profile_id = $profile->id;
 170         $a->find();
 171         if ($a->fetch()) {
 172             return $a;
 173         } else {
 174             return null;
 175         }
 176     }
 177
 178     function getAnswers()
 179     {
 180         $a = new QnA_Answer();
 181         $a->question_id = $this->id;
 182         $cnt = $a->find();
 183         if (!empty($cnt)) {
 184             return $a;
 185         } else {
 186             return null;
 187         }
 188     }
 189
 190     function countAnswers()
 191     {
 192         $a = new QnA_Answer();
 193
 194         $a->question_id = $this->id;
 195
 196         return $a->count();
 197     }
 198
 199     static function fromNotice($notice)
 200     {
 201         return QnA_Question::staticGet('uri', $notice->uri);
 202     }
 203
 204     function asHTML()
 205     {
 206         return self::toHTML($this->getProfile(), $this);
 207     }
 208
 209     function asString()
 210     {
 211         return self::toString($this->getProfile(), $this);
 212     }
 213
 214     static function toHTML($profile, $question)
 215     {
 216         $notice = $question->getNotice();
 217
 218         $out = new XMLStringer();
 219
 220         if (!empty($question->description)) {
 221             $out->elementStart('span', 'question-description');
 222             $out->raw(QnAPlugin::shorten($question->description, $notice));
 223             $out->elementEnd('span');
 224         }
 225
 226         $cnt = $question->countAnswers();
 227
 228         if (!empty($cnt)) {
 229             $out->elementStart('span', 'answer-count');
 230             $out->text(sprintf(_m('%s answers'), $cnt));
 231             $out->elementEnd('span');
 232         }
 233
 234         if (!empty($question->closed)) {
 235             $out->elementStart('span', 'question-closed');
 236             $out->text(_m('This question is closed.'));
 237             $out->elementEnd('span');
 238         }
 239
 240         return $out->getString();
 241     }
 242
 243     static function toString($profile, $question, $answers)
 244     {
 245         return sprintf(htmlspecialchars($question->description));
 246     }
 247
 248     /**
 249      * Save a new question notice
 250      *
 251      * @param Profile $profile
 252      * @param string  $question
 253      * @param string  $title
 254      * @param string  $description
 255      * @param array   $option // and whatnot
 256      *
 257      * @return Notice saved notice
 258      */
 259     static function saveNew($profile, $title, $description, $options = array())
 260     {
 261         $q = new QnA_Question();
 262
 263         $q->id          = UUID::gen();
 264         $q->profile_id  = $profile->id;
 265         $q->title       = $title;
 266         $q->description = $description;
 267
 268         if (array_key_exists('created', $options)) {
 269             $q->created = $options['created'];
 270         } else {
 271             $q->created = common_sql_now();
 272         }
 273
 274         if (array_key_exists('uri', $options)) {
 275             $q->uri = $options['uri'];
 276         } else {
 277             $q->uri = common_local_url(
 278                 'qnashowquestion',
 279                 array('id' => $q->id)
 280             );
 281         }
 282
 283         common_log(LOG_DEBUG, "Saving question: $q->id $q->uri");
 284         $q->insert();
 285
 286         if (Notice::contentTooLong($q->title . ' ' . $q->uri)) {
 287             $max       = Notice::maxContent();
 288             $uriLen    = mb_strlen($q->uri);
 289             $targetLen = $max - ($uriLen + 15);
 290             $title = mb_substr($q->title, 0, $targetLen) . '…';
 291
 292         }
 293
 294         $content = $title . ' ' . $q->uri;
 295
 296         $link = '<a href="' . htmlspecialchars($q->uri) . '">' . htmlspecialchars($q->title) . '</a>';
 297         // TRANS: Rendered version of the notice content creating a question.
 298         // TRANS: %s a link to the question as link description.
 299         $rendered = sprintf(_m('Question: %s'), $link);
 300
 301         $tags    = array('question');
 302         $replies = array();
 303
 304         $options = array_merge(
 305             array(
 306                 'urls'        => array(),
 307                 'rendered'    => $rendered,
 308                 'tags'        => $tags,
 309                 'replies'     => $replies,
 310                 'object_type' => self::OBJECT_TYPE
 311             ),
 312             $options
 313         );
 314
 315         if (!array_key_exists('uri', $options)) {
 316             $options['uri'] = $q->uri;
 317         }
 318
 319         $saved = Notice::saveNew(
 320             $profile->id,
 321             $content,
 322             array_key_exists('source', $options) ?
 323             $options['source'] : 'web',
 324             $options
 325         );
 326
 327         return $saved;
 328     }
 329 }