3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2010, StatusNet, Inc.
6 * A plugin to add titles to notices
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/>.
23 * @category NoticeTitle
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/
31 if (!defined('STATUSNET')) {
32 // This check helps protect against security problems;
33 // your code file can't be executed directly from the web.
37 define('NOTICE_TITLE_PLUGIN_VERSION', '0.1');
40 * NoticeTitle plugin to add an optional title to notices.
42 * Stores notice titles in a secondary table, notice_title.
44 * @category NoticeTitle
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/
51 class NoticeTitlePlugin extends Plugin
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;
60 * Database schema setup
62 * Add the notice_title helper table
67 * @return boolean hook value; true means continue processing, false means stop.
69 function onCheckSchema()
71 $schema = Schema::get();
73 // For storing titles for notices
75 $schema->ensureTable('notice_title',
76 array(new ColumnDef('notice_id',
81 new ColumnDef('title',
83 Notice_title::MAXCHARS,
90 * Load related modules when needed
92 * @param string $cls Name of the class to be loaded
94 * @return boolean hook value; true means continue processing, false means stop.
96 function onAutoload($cls)
98 $dir = dirname(__FILE__);
103 include_once $dir . '/'.$cls.'.php';
111 * Provide plugin version information.
113 * This data is used when showing the version page.
115 * @param array &$versions array of version data arrays; see EVENTS.txt
117 * @return boolean hook value
119 function onPluginVersion(&$versions)
121 $url = 'http://status.net/wiki/Plugin:NoticeTitle';
123 $versions[] = array('name' => 'NoticeTitle',
124 'version' => NOTICE_TITLE_PLUGIN_VERSION,
125 'author' => 'Evan Prodromou',
128 // TRANS: Plugin description.
129 _m('Adds optional titles to notices.'));
134 * Show title entry when showing notice form
136 * @param Form $form Form being shown
138 * @return boolean hook value
140 function onStartShowNoticeFormData($form)
142 if ($this->isAllowedRichEdit()) {
143 $form->out->element('style',
145 'label#notice_data-text-label { display: none }');
146 $form->out->element('input', array('type' => 'text',
147 'id' => 'notice_title',
148 'name' => 'notice_title',
150 'maxlength' => Notice_title::MAXCHARS));
156 * Validate notice title before saving
158 * @param Action $action NewNoticeAction being executed
159 * @param integer &$authorId Author ID
160 * @param string &$text Text of the notice
161 * @param array &$options Options array
163 * @return boolean hook value
165 function onStartNoticeSaveWeb($action, &$authorId, &$text, &$options)
167 $title = $action->trimmed('notice_title');
168 if (!empty($title) && $this->isAllowedRichEdit()) {
169 if (mb_strlen($title) > Notice_title::MAXCHARS) {
170 // TRANS: Exception thrown when a notice title is too long.
171 // TRANS: %d is the maximum number of characters allowed in a title (used for plural).
172 throw new Exception(sprintf(_m('The notice title is too long (maximum %d character).',
173 'The notice title is too long (maximum %d characters).',
174 Notice_title::MAXCHARS),
175 Notice_title::MAXCHARS));
182 * Save notice title after notice is saved
184 * @param Action $action NewNoticeAction being executed
185 * @param Notice $notice Notice that was saved
187 * @return boolean hook value
189 function onEndNoticeSaveWeb($action, $notice)
191 if (!empty($notice)) {
193 $title = $action->trimmed('notice_title');
195 if (!empty($title) && $this->isAllowedRichEdit()) {
197 $nt = new Notice_title();
199 $nt->notice_id = $notice->id;
210 * Show the notice title in lists
212 * @param NoticeListItem $nli NoticeListItem being shown
214 * @return boolean hook value
216 function onStartShowNoticeItem($nli)
218 $title = Notice_title::fromNotice($nli->notice);
220 if (!empty($title)) {
221 $nli->out->elementStart('h4', array('class' => 'notice_title'));
222 $nli->out->element('a', array('href' => $nli->notice->bestUrl()), $title);
223 $nli->out->elementEnd('h4');
230 * Show the notice title in RSS output
232 * @param Notice $notice Notice being shown
233 * @param array &$entry array of values used for RSS output
235 * @return boolean hook value
237 function onEndRssEntryArray($notice, &$entry)
239 $title = Notice_title::fromNotice($notice);
241 if (!empty($title)) {
242 $entry['title'] = $title;
249 * Show the notice title in Atom output
251 * @param Notice &$notice Notice being shown
252 * @param XMLStringer &$xs output context
253 * @param string &$output string to be output as title
255 * @return boolean hook value
257 function onEndNoticeAsActivity($notice, &$activity)
259 $title = Notice_title::fromNotice($notice);
261 if (!empty($title)) {
262 foreach ($activity->objects as $obj) {
263 if ($obj->id == $notice->uri) {
264 $obj->title = $title;
274 * Remove title when the notice is deleted
276 * @param Notice $notice Notice being deleted
278 * @return boolean hook value
280 function onNoticeDeleteRelated($notice)
282 $nt = Notice_title::staticGet('notice_id', $notice->id);
292 * If a notice has a title, show it in the <title> element
294 * @param Action $action Action being executed
296 * @return boolean hook value
298 function onStartShowHeadTitle($action)
300 $actionName = $action->trimmed('action');
302 if ($actionName == 'shownotice') {
303 $title = Notice_title::fromNotice($action->notice);
304 if (!empty($title)) {
305 $action->element('title', null,
306 // TRANS: Page title. %1$s is the title, %2$s is the site name.
307 sprintf(_m("%1\$s - %2\$s"),
309 common_config('site', 'name')));
317 * If a notice has a title, show it in the <h1> element
319 * @param Action $action Action being executed
321 * @return boolean hook value
323 function onStartShowPageTitle($action)
325 $actionName = $action->trimmed('action');
327 if ($actionName == 'shownotice') {
328 $title = Notice_title::fromNotice($action->notice);
329 if (!empty($title)) {
330 $action->element('h1', null, $title);
339 * Does the current user have permission to use the notice-title widget?
340 * Always true unless the plugin's "restricted" setting is on, in which
341 * case it's limited to users with the "richedit" role.
343 * @todo FIXME: make that more sanely configurable :)
347 private function isAllowedRichEdit()
349 if ($this->restricted) {
350 $user = common_current_user();
351 return !empty($user) && $user->hasRole('richedit');