plugins/NoticeTitle/NoticeTitlePlugin.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2010, StatusNet, Inc.
   5  *
   6  * A plugin to add titles to notices
   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  NoticeTitle
  24  * @package   StatusNet
  25  * @author    Evan Prodromou <evan@status.net>
  26  * @copyright 2010 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 define('NOTICE_TITLE_PLUGIN_VERSION', '0.1');
  38
  39 /**
  40  * NoticeTitle plugin to add an optional title to notices.
  41  *
  42  * Stores notice titles in a secondary table, notice_title.
  43  *
  44  * @category  NoticeTitle
  45  * @package   StatusNet
  46  * @author    Evan Prodromou <evan@status.net>
  47  * @copyright 2010 StatusNet, Inc.
  48  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  49  * @link      http://status.net/
  50  */
  51 class NoticeTitlePlugin extends Plugin
  52 {
  53
  54     // By default, notice-title widget will be available to all users.
  55     // With restricted on, only users who have been granted the
  56     // "richedit" role get it.
  57     public $restricted = false;
  58
  59     /**
  60      * Database schema setup
  61      *
  62      * Add the notice_title helper table
  63      *
  64      * @see Schema
  65      * @see ColumnDef
  66      *
  67      * @return boolean hook value; true means continue processing, false means stop.
  68      */
  69     function onCheckSchema()
  70     {
  71         $schema = Schema::get();
  72
  73         // For storing titles for notices
  74         $schema->ensureTable('notice_title', Notice_title::schemaDef());
  75         return true;
  76     }
  77
  78     /**
  79      * Provide plugin version information.
  80      *
  81      * This data is used when showing the version page.
  82      *
  83      * @param array &$versions array of version data arrays; see EVENTS.txt
  84      *
  85      * @return boolean hook value
  86      */
  87     function onPluginVersion(&$versions)
  88     {
  89         $url = 'http://status.net/wiki/Plugin:NoticeTitle';
  90
  91         $versions[] = array('name' => 'NoticeTitle',
  92                             'version' => NOTICE_TITLE_PLUGIN_VERSION,
  93                             'author' => 'Evan Prodromou',
  94                             'homepage' => $url,
  95                             'rawdescription' =>
  96                             // TRANS: Plugin description.
  97                             _m('Adds optional titles to notices.'));
  98         return true;
  99     }
 100
 101     /**
 102      * Show title entry when showing notice form
 103      *
 104      * @param Form $form Form being shown
 105      *
 106      * @return boolean hook value
 107      */
 108     function onStartShowNoticeFormData($form)
 109     {
 110         if ($this->isAllowedRichEdit()) {
 111             $form->out->element('style',
 112                                 null,
 113                                 'label#notice_data-text-label { display: none }');
 114             $form->out->element('input', array('type' => 'text',
 115                                                'id' => 'notice_title',
 116                                                'name' => 'notice_title',
 117                                                'size' => 40,
 118                                                'maxlength' => Notice_title::MAXCHARS));
 119         }
 120         return true;
 121     }
 122
 123     /**
 124      * Validate notice title before saving
 125      *
 126      * @param Action  $action    NewNoticeAction being executed
 127      * @param integer &$authorId Author ID
 128      * @param string  &$text     Text of the notice
 129      * @param array   &$options  Options array
 130      *
 131      * @return boolean hook value
 132      */
 133     function onStartNoticeSaveWeb($action, &$authorId, &$text, &$options)
 134     {
 135         $title = $action->trimmed('notice_title');
 136         if (!empty($title) && $this->isAllowedRichEdit()) {
 137             if (mb_strlen($title) > Notice_title::MAXCHARS) {
 138                 // TRANS: Exception thrown when a notice title is too long.
 139                 // TRANS: %d is the maximum number of characters allowed in a title (used for plural).
 140                 throw new Exception(sprintf(_m('The notice title is too long (maximum %d character).',
 141                                                'The notice title is too long (maximum %d characters).',
 142                                                Notice_title::MAXCHARS),
 143                                             Notice_title::MAXCHARS));
 144             }
 145         }
 146         return true;
 147     }
 148
 149     /**
 150      * Save notice title after notice is saved
 151      *
 152      * @param Action $action NewNoticeAction being executed
 153      * @param Notice $notice Notice that was saved
 154      *
 155      * @return boolean hook value
 156      */
 157     function onEndNoticeSaveWeb($action, $notice)
 158     {
 159         if (!empty($notice)) {
 160
 161             $title = $action->trimmed('notice_title');
 162
 163             if (!empty($title) && $this->isAllowedRichEdit()) {
 164
 165                 $nt = new Notice_title();
 166
 167                 $nt->notice_id = $notice->id;
 168                 $nt->title     = $title;
 169
 170                 $nt->insert();
 171             }
 172         }
 173
 174         return true;
 175     }
 176
 177     /**
 178      * Show the notice title in lists
 179      *
 180      * @param NoticeListItem $nli NoticeListItem being shown
 181      *
 182      * @return boolean hook value
 183      */
 184     function onStartShowNoticeItem($nli)
 185     {
 186         $title = Notice_title::fromNotice($nli->notice);
 187
 188         if (!empty($title)) {
 189             $nli->out->elementStart('h4', array('class' => 'notice_title'));
 190             $nli->out->element('a', array('href' => $nli->notice->getUrl()), $title);
 191             $nli->out->elementEnd('h4');
 192         }
 193
 194         return true;
 195     }
 196
 197     /**
 198      * Show the notice title in RSS output
 199      *
 200      * @param Notice $notice Notice being shown
 201      * @param array  &$entry array of values used for RSS output
 202      *
 203      * @return boolean hook value
 204      */
 205     function onEndRssEntryArray($notice, &$entry)
 206     {
 207         $title = Notice_title::fromNotice($notice);
 208
 209         if (!empty($title)) {
 210             $entry['title'] = $title;
 211         }
 212
 213         return true;
 214     }
 215
 216     /**
 217      * Show the notice title in Atom output
 218      *
 219      * @param Notice      &$notice Notice being shown
 220      * @param XMLStringer &$xs     output context
 221      * @param string      &$output string to be output as title
 222      *
 223      * @return boolean hook value
 224      */
 225     function onEndNoticeAsActivity($notice, &$activity)
 226     {
 227         $title = Notice_title::fromNotice($notice);
 228
 229         if (!empty($title)) {
 230             foreach ($activity->objects as $obj) {
 231                 if ($obj->id == $notice->uri) {
 232                     $obj->title = $title;
 233                     break;
 234                 }
 235             }
 236         }
 237
 238         return true;
 239     }
 240
 241     /**
 242      * Remove title when the notice is deleted
 243      *
 244      * @param Notice $notice Notice being deleted
 245      *
 246      * @return boolean hook value
 247      */
 248     function onNoticeDeleteRelated($notice)
 249     {
 250         $nt = Notice_title::getKV('notice_id', $notice->id);
 251
 252         if (!empty($nt)) {
 253             $nt->delete();
 254         }
 255
 256         return true;
 257     }
 258
 259     /**
 260      * If a notice has a title, show it in the <title> element
 261      *
 262      * @param Action $action Action being executed
 263      *
 264      * @return boolean hook value
 265      */
 266     function onStartShowHeadTitle($action)
 267     {
 268         $actionName = $action->trimmed('action');
 269
 270         if ($actionName == 'shownotice') {
 271             $title = Notice_title::fromNotice($action->notice);
 272             if (!empty($title)) {
 273                 $action->element('title', null,
 274                                  // TRANS: Page title. %1$s is the title, %2$s is the site name.
 275                                  sprintf(_m("%1\$s - %2\$s"),
 276                                          $title,
 277                                          common_config('site', 'name')));
 278             }
 279         }
 280
 281         return true;
 282     }
 283
 284     /**
 285      * If a notice has a title, show it in the <h1> element
 286      *
 287      * @param Action $action Action being executed
 288      *
 289      * @return boolean hook value
 290      */
 291     function onStartShowPageTitle($action)
 292     {
 293         $actionName = $action->trimmed('action');
 294
 295         if ($actionName == 'shownotice') {
 296             $title = Notice_title::fromNotice($action->notice);
 297             if (!empty($title)) {
 298                 $action->element('h1', null, $title);
 299                 return false;
 300             }
 301         }
 302
 303         return true;
 304     }
 305
 306     /**
 307      * Does the current user have permission to use the notice-title widget?
 308      * Always true unless the plugin's "restricted" setting is on, in which
 309      * case it's limited to users with the "richedit" role.
 310      *
 311      * @todo FIXME: make that more sanely configurable :)
 312      *
 313      * @return boolean
 314      */
 315     private function isAllowedRichEdit()
 316     {
 317         if ($this->restricted) {
 318             $user = common_current_user();
 319             return !empty($user) && $user->hasRole('richedit');
 320         } else {
 321             return true;
 322         }
 323     }
 324 }