From ac6486f12e3a51fc0b7b1433de881934d8029299 Mon Sep 17 00:00:00 2001 From: Evan Prodromou Date: Thu, 12 Aug 2010 21:19:12 -0700 Subject: Plugin file and data file for notice title --- plugins/NoticeTitle/NoticeTitlePlugin.php | 111 ++++++++++++++++++++++++++++ plugins/NoticeTitle/Notice_title.php | 116 ++++++++++++++++++++++++++++++ 2 files changed, 227 insertions(+) create mode 100644 plugins/NoticeTitle/NoticeTitlePlugin.php create mode 100644 plugins/NoticeTitle/Notice_title.php (limited to 'plugins') diff --git a/plugins/NoticeTitle/NoticeTitlePlugin.php b/plugins/NoticeTitle/NoticeTitlePlugin.php new file mode 100644 index 000000000..9dfb4b21c --- /dev/null +++ b/plugins/NoticeTitle/NoticeTitlePlugin.php @@ -0,0 +1,111 @@ +. + * + * @category NoticeTitle + * @package StatusNet + * @author Evan Prodromou + * @copyright 2010 StatusNet, Inc. + * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0 + * @link http://status.net/ + */ + +if (!defined('STATUSNET')) { + // This check helps protect against security problems; + // your code file can't be executed directly from the web. + exit(1); +} + +define('NOTICE_TITLE_PLUGIN_VERSION', '0.1'); + +/** + * NoticeTitle plugin to add an optional title to notices. + * + * Stores notice titles in a secondary table, notice_title. + * + * @category NoticeTitle + * @package StatusNet + * @author Evan Prodromou + * @copyright 2010 StatusNet, Inc. + * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0 + * @link http://status.net/ + */ + +class NoticeTitlePlugin extends Plugin +{ + /** + * Database schema setup + * + * Add the notice_title helper table + * + * @see Schema + * @see ColumnDef + * + * @return boolean hook value; true means continue processing, false means stop. + */ + + function onCheckSchema() + { + $schema = Schema::get(); + + // For storing titles for notices + + $schema->ensureTable('notice_title', + array(new ColumnDef('notice_id', 'integer', null, true, 'PRI'), + new ColumnDef('title', 'varchar', 255, false))); + + return true; + } + + /** + * Load related modules when needed + * + * @param string $cls Name of the class to be loaded + * + * @return boolean hook value; true means continue processing, false means stop. + */ + + function onAutoload($cls) + { + $dir = dirname(__FILE__); + + switch ($cls) + { + case 'Notice_title': + include_once $dir . '/'.$cls.'.php'; + return false; + default: + return true; + } + } + + function onPluginVersion(&$versions) + { + $versions[] = array('name' => 'NoticeTitle', + 'version' => NOTICE_TITLE_PLUGIN_VERSION, + 'author' => 'Evan Prodromou', + 'homepage' => 'http://status.net/wiki/Plugin:NoticeTitle', + 'rawdescription' => + _m('Adds optional titles to notices')); + return true; + } +} + diff --git a/plugins/NoticeTitle/Notice_title.php b/plugins/NoticeTitle/Notice_title.php new file mode 100644 index 000000000..ed71f1356 --- /dev/null +++ b/plugins/NoticeTitle/Notice_title.php @@ -0,0 +1,116 @@ + + * @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3 + * @link http://status.net/ + * + * StatusNet - the distributed open-source microblogging tool + * Copyright (C) 2010, StatusNet, Inc. + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ + +if (!defined('STATUSNET')) { + exit(1); +} + +require_once INSTALLDIR . '/classes/Memcached_DataObject.php'; + +/** + * Data class for notice titles + * + * @category Action + * @package StatusNet + * @author Evan Prodromou + * @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3 + * @link http://status.net/ + * + * @see DB_DataObject + */ + +class Notice_title extends Memcached_DataObject +{ + public $__table = 'notice_title'; // table name + public $notice_id; // int(4) primary_key not_null + public $title; // varchar(255) + + /** + * Get an instance by key + * + * This is a utility method to get a single instance with a given key value. + * + * @param string $k Key to use to lookup (usually 'user_id' for this class) + * @param mixed $v Value to lookup + * + * @return Notice_title object found, or null for no hits + * + */ + + function staticGet($k, $v=null) + { + return Memcached_DataObject::staticGet('Notice_title', $k, $v); + } + + /** + * return table definition for DB_DataObject + * + * DB_DataObject needs to know something about the table to manipulate + * instances. This method provides all the DB_DataObject needs to know. + * + * @return array array of column definitions + */ + + function table() + { + return array('notice_id' => DB_DATAOBJECT_INT + DB_DATAOBJECT_NOTNULL, + 'title' => DB_DATAOBJECT_STR); + } + + /** + * return key definitions for DB_DataObject + * + * @return array list of key field names + */ + + function keys() + { + return array_keys($this->keyTypes()); + } + + /** + * return key definitions for Memcached_DataObject + */ + + function keyTypes() + { + return array('notice_id' => 'K'); + } + + /** + * Magic formula for non-autoincrementing integer primary keys + * + * @return array magic three-false array that stops auto-incrementing. + */ + + function sequenceKey() + { + return array(false, false, false); + } +} -- cgit v1.2.3-54-g00ecf From 79b5f1cea5ffadf18d3680ddeb1f8bd4d974b059 Mon Sep 17 00:00:00 2001 From: Evan Prodromou Date: Thu, 12 Aug 2010 22:11:26 -0700 Subject: add title element to notice form --- plugins/NoticeTitle/NoticeTitlePlugin.php | 13 +++++++++++++ 1 file changed, 13 insertions(+) (limited to 'plugins') diff --git a/plugins/NoticeTitle/NoticeTitlePlugin.php b/plugins/NoticeTitle/NoticeTitlePlugin.php index 9dfb4b21c..524faef3a 100644 --- a/plugins/NoticeTitle/NoticeTitlePlugin.php +++ b/plugins/NoticeTitle/NoticeTitlePlugin.php @@ -107,5 +107,18 @@ class NoticeTitlePlugin extends Plugin _m('Adds optional titles to notices')); return true; } + + function onStartShowNoticeFormData($form) + { + $form->out->element('input', array('type' => 'text', + 'id' => 'notice_title', + 'name' => 'notice_title', + 'size' => 40, + 'value' => _m('Title'), + 'style' => 'color: 333333', + 'onFocus' => 'this.value = ""; this.style = \'color: black\';')); + return true; + } + } -- cgit v1.2.3-54-g00ecf From e2128b201952131ab78344b089b72a0b74521c86 Mon Sep 17 00:00:00 2001 From: Evan Prodromou Date: Fri, 13 Aug 2010 11:29:18 -0700 Subject: save the notice title when the notice is saved --- plugins/NoticeTitle/NoticeTitlePlugin.php | 33 ++++++++++++++++++++++++++++++- plugins/NoticeTitle/Notice_title.php | 2 ++ 2 files changed, 34 insertions(+), 1 deletion(-) (limited to 'plugins') diff --git a/plugins/NoticeTitle/NoticeTitlePlugin.php b/plugins/NoticeTitle/NoticeTitlePlugin.php index 524faef3a..86a74a4da 100644 --- a/plugins/NoticeTitle/NoticeTitlePlugin.php +++ b/plugins/NoticeTitle/NoticeTitlePlugin.php @@ -70,7 +70,7 @@ class NoticeTitlePlugin extends Plugin $schema->ensureTable('notice_title', array(new ColumnDef('notice_id', 'integer', null, true, 'PRI'), - new ColumnDef('title', 'varchar', 255, false))); + new ColumnDef('title', 'varchar', Notice_title::MAXCHARS, false))); return true; } @@ -114,11 +114,42 @@ class NoticeTitlePlugin extends Plugin 'id' => 'notice_title', 'name' => 'notice_title', 'size' => 40, + 'maxlength' => Notice_title::MAXCHARS, 'value' => _m('Title'), 'style' => 'color: 333333', 'onFocus' => 'this.value = ""; this.style = \'color: black\';')); return true; } + function onStartNoticeSaveWeb($action, &$authorId, &$text, &$options) + { + $title = $action->trimmed('notice_title'); + if (!empty($title)) { + if (mb_strlen($title) > Notice_title::MAXCHARS) { + throw new Exception(sprintf(_m("Notice title too long (max %d chars)", Notice_title::MAXCHARS))); + } + } + return true; + } + + function onEndNoticeSaveWeb($action, $notice) + { + if (!empty($notice)) { + + $title = $action->trimmed('notice_title'); + + if (!empty($title)) { + + $nt = new Notice_title(); + + $nt->notice_id = $notice->id; + $nt->title = $title; + + $nt->insert(); + } + } + + return true; + } } diff --git a/plugins/NoticeTitle/Notice_title.php b/plugins/NoticeTitle/Notice_title.php index ed71f1356..44d56b496 100644 --- a/plugins/NoticeTitle/Notice_title.php +++ b/plugins/NoticeTitle/Notice_title.php @@ -47,6 +47,8 @@ require_once INSTALLDIR . '/classes/Memcached_DataObject.php'; class Notice_title extends Memcached_DataObject { + const MAXCHARS = 255; + public $__table = 'notice_title'; // table name public $notice_id; // int(4) primary_key not_null public $title; // varchar(255) -- cgit v1.2.3-54-g00ecf From 67ff9ea49011fd8cc1c102c6fb236c47cd034342 Mon Sep 17 00:00:00 2001 From: Evan Prodromou Date: Fri, 13 Aug 2010 11:35:16 -0700 Subject: helper static method to get title text based on a notice --- plugins/NoticeTitle/Notice_title.php | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) (limited to 'plugins') diff --git a/plugins/NoticeTitle/Notice_title.php b/plugins/NoticeTitle/Notice_title.php index 44d56b496..c2d1a83ca 100644 --- a/plugins/NoticeTitle/Notice_title.php +++ b/plugins/NoticeTitle/Notice_title.php @@ -115,4 +115,22 @@ class Notice_title extends Memcached_DataObject { return array(false, false, false); } + + /** + * Get a notice title based on the notice + * + * @param Notice $notice Notice to fetch a title for + * + * @return string title of the notice, or null if none + */ + + static function fromNotice(Notice $notice) + { + $nt = Notice_title::staticGet('notice_id', $notice->id); + if (empty($nt)) { + return null; + } else { + return $nt->title; + } + } } -- cgit v1.2.3-54-g00ecf From 91c914fa3b988c2e5b38b0cdff3fd2d596a6a0ce Mon Sep 17 00:00:00 2001 From: Evan Prodromou Date: Fri, 13 Aug 2010 11:35:36 -0700 Subject: show notice title for notices in a notice list --- plugins/NoticeTitle/NoticeTitlePlugin.php | 11 +++++++++++ 1 file changed, 11 insertions(+) (limited to 'plugins') diff --git a/plugins/NoticeTitle/NoticeTitlePlugin.php b/plugins/NoticeTitle/NoticeTitlePlugin.php index 86a74a4da..e8377f5b0 100644 --- a/plugins/NoticeTitle/NoticeTitlePlugin.php +++ b/plugins/NoticeTitle/NoticeTitlePlugin.php @@ -151,5 +151,16 @@ class NoticeTitlePlugin extends Plugin return true; } + + function onStartShowNoticeItem($nli) + { + $title = Notice_title::fromNotice($nli->notice); + + if (!empty($title)) { + $nli->out->element('h4', array('class' => 'notice_title'), $title); + } + + return true; + } } -- cgit v1.2.3-54-g00ecf From 96705b4ec5d9fc658a6add47777912bc1362f406 Mon Sep 17 00:00:00 2001 From: Evan Prodromou Date: Fri, 13 Aug 2010 11:50:33 -0700 Subject: set notice titles in RSS and Atom output --- plugins/NoticeTitle/NoticeTitlePlugin.php | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) (limited to 'plugins') diff --git a/plugins/NoticeTitle/NoticeTitlePlugin.php b/plugins/NoticeTitle/NoticeTitlePlugin.php index e8377f5b0..c708a9fa0 100644 --- a/plugins/NoticeTitle/NoticeTitlePlugin.php +++ b/plugins/NoticeTitle/NoticeTitlePlugin.php @@ -162,5 +162,27 @@ class NoticeTitlePlugin extends Plugin return true; } + + function onEndRssEntryArray($notice, &$entry) + { + $title = Notice_title::fromNotice($notice); + + if (!empty($title)) { + $entry['title'] = $title; + } + + return true; + } + + function onStartActivityTitle(&$notice, &$xs, &$output) + { + $title = Notice_title::fromNotice($notice); + + if (!empty($title)) { + $output = $title; + } + + return true; + } } -- cgit v1.2.3-54-g00ecf From eff0b8e1aaf6c6c6d71b89aa068430c2077a12b0 Mon Sep 17 00:00:00 2001 From: Evan Prodromou Date: Fri, 13 Aug 2010 12:01:29 -0700 Subject: make notice title phpcs-clean --- plugins/NoticeTitle/NoticeTitlePlugin.php | 88 ++++++++++++++++++++++++++++--- 1 file changed, 80 insertions(+), 8 deletions(-) (limited to 'plugins') diff --git a/plugins/NoticeTitle/NoticeTitlePlugin.php b/plugins/NoticeTitle/NoticeTitlePlugin.php index c708a9fa0..115e1c14c 100644 --- a/plugins/NoticeTitle/NoticeTitlePlugin.php +++ b/plugins/NoticeTitle/NoticeTitlePlugin.php @@ -69,8 +69,15 @@ class NoticeTitlePlugin extends Plugin // For storing titles for notices $schema->ensureTable('notice_title', - array(new ColumnDef('notice_id', 'integer', null, true, 'PRI'), - new ColumnDef('title', 'varchar', Notice_title::MAXCHARS, false))); + array(new ColumnDef('notice_id', + 'integer', + null, + true, + 'PRI'), + new ColumnDef('title', + 'varchar', + Notice_title::MAXCHARS, + false))); return true; } @@ -97,41 +104,79 @@ class NoticeTitlePlugin extends Plugin } } + /** + * Provide plugin version information. + * + * This data is used when showing the version page. + * + * @param array &$versions array of version data arrays; see EVENTS.txt + * + * @return boolean hook value + */ + function onPluginVersion(&$versions) { + $url = 'http://status.net/wiki/Plugin:NoticeTitle'; + $versions[] = array('name' => 'NoticeTitle', 'version' => NOTICE_TITLE_PLUGIN_VERSION, 'author' => 'Evan Prodromou', - 'homepage' => 'http://status.net/wiki/Plugin:NoticeTitle', + 'homepage' => $url, 'rawdescription' => _m('Adds optional titles to notices')); return true; } + /** + * Show title entry when showing notice form + * + * @param Form $form Form being shown + * + * @return boolean hook value + */ + function onStartShowNoticeFormData($form) { $form->out->element('input', array('type' => 'text', 'id' => 'notice_title', 'name' => 'notice_title', 'size' => 40, - 'maxlength' => Notice_title::MAXCHARS, - 'value' => _m('Title'), - 'style' => 'color: 333333', - 'onFocus' => 'this.value = ""; this.style = \'color: black\';')); + 'maxlength' => Notice_title::MAXCHARS)); return true; } + /** + * Validate notice title before saving + * + * @param Action $action NewNoticeAction being executed + * @param integer &$authorId Author ID + * @param string &$text Text of the notice + * @param array &$options Options array + * + * @return boolean hook value + */ + function onStartNoticeSaveWeb($action, &$authorId, &$text, &$options) { $title = $action->trimmed('notice_title'); if (!empty($title)) { if (mb_strlen($title) > Notice_title::MAXCHARS) { - throw new Exception(sprintf(_m("Notice title too long (max %d chars)", Notice_title::MAXCHARS))); + throw new Exception(sprintf(_m("Notice title too long (max %d)", + Notice_title::MAXCHARS))); } } return true; } + /** + * Save notice title after notice is saved + * + * @param Action $action NewNoticeAction being executed + * @param Notice $notice Notice that was saved + * + * @return boolean hook value + */ + function onEndNoticeSaveWeb($action, $notice) { if (!empty($notice)) { @@ -152,6 +197,14 @@ class NoticeTitlePlugin extends Plugin return true; } + /** + * Show the notice title in lists + * + * @param NoticeListItem $nli NoticeListItem being shown + * + * @return boolean hook value + */ + function onStartShowNoticeItem($nli) { $title = Notice_title::fromNotice($nli->notice); @@ -163,6 +216,15 @@ class NoticeTitlePlugin extends Plugin return true; } + /** + * Show the notice title in RSS output + * + * @param Notice $notice Notice being shown + * @param array &$entry array of values used for RSS output + * + * @return boolean hook value + */ + function onEndRssEntryArray($notice, &$entry) { $title = Notice_title::fromNotice($notice); @@ -174,6 +236,16 @@ class NoticeTitlePlugin extends Plugin return true; } + /** + * Show the notice title in Atom output + * + * @param Notice &$notice Notice being shown + * @param XMLStringer &$xs output context + * @param string &$output string to be output as title + * + * @return boolean hook value + */ + function onStartActivityTitle(&$notice, &$xs, &$output) { $title = Notice_title::fromNotice($notice); -- cgit v1.2.3-54-g00ecf From e6da476c1650fbb9e4cca5f2d9a418b3186d5d06 Mon Sep 17 00:00:00 2001 From: Evan Prodromou Date: Fri, 13 Aug 2010 12:04:30 -0700 Subject: make notice title phpcs-clean --- plugins/NoticeTitle/Notice_title.php | 2 ++ 1 file changed, 2 insertions(+) (limited to 'plugins') diff --git a/plugins/NoticeTitle/Notice_title.php b/plugins/NoticeTitle/Notice_title.php index c2d1a83ca..b3b4fcc57 100644 --- a/plugins/NoticeTitle/Notice_title.php +++ b/plugins/NoticeTitle/Notice_title.php @@ -98,6 +98,8 @@ class Notice_title extends Memcached_DataObject /** * return key definitions for Memcached_DataObject + * + * @return array list mapping field names to key types */ function keyTypes() -- cgit v1.2.3-54-g00ecf From 9b7536351b1efa5bf222fad1fb92b6dc9e33156f Mon Sep 17 00:00:00 2001 From: Evan Prodromou Date: Fri, 13 Aug 2010 12:22:58 -0700 Subject: hide the Whats Up Nickname if notice title enabled --- lib/noticeform.php | 3 ++- plugins/NoticeTitle/NoticeTitlePlugin.php | 1 + 2 files changed, 3 insertions(+), 1 deletion(-) (limited to 'plugins') diff --git a/lib/noticeform.php b/lib/noticeform.php index 84c20a5b3..514066356 100644 --- a/lib/noticeform.php +++ b/lib/noticeform.php @@ -169,7 +169,8 @@ class NoticeForm extends Form function formData() { if (Event::handle('StartShowNoticeFormData', array($this))) { - $this->out->element('label', array('for' => 'notice_data-text'), + $this->out->element('label', array('for' => 'notice_data-text', + 'id' => 'notice_data-text-label'), sprintf(_('What\'s up, %s?'), $this->user->nickname)); // XXX: vary by defined max size $this->out->element('textarea', array('id' => 'notice_data-text', diff --git a/plugins/NoticeTitle/NoticeTitlePlugin.php b/plugins/NoticeTitle/NoticeTitlePlugin.php index 115e1c14c..18ffed4be 100644 --- a/plugins/NoticeTitle/NoticeTitlePlugin.php +++ b/plugins/NoticeTitle/NoticeTitlePlugin.php @@ -137,6 +137,7 @@ class NoticeTitlePlugin extends Plugin function onStartShowNoticeFormData($form) { + $form->out->element('style', null, 'label#notice_data-text-label { display: none }'); $form->out->element('input', array('type' => 'text', 'id' => 'notice_title', 'name' => 'notice_title', -- cgit v1.2.3-54-g00ecf From 401cf36de3bcce681f95344cc479f0594014b028 Mon Sep 17 00:00:00 2001 From: Evan Prodromou Date: Sat, 14 Aug 2010 11:58:54 -0700 Subject: handle deletion of notice --- plugins/NoticeTitle/NoticeTitlePlugin.php | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) (limited to 'plugins') diff --git a/plugins/NoticeTitle/NoticeTitlePlugin.php b/plugins/NoticeTitle/NoticeTitlePlugin.php index 18ffed4be..f7fb1e4d0 100644 --- a/plugins/NoticeTitle/NoticeTitlePlugin.php +++ b/plugins/NoticeTitle/NoticeTitlePlugin.php @@ -137,7 +137,9 @@ class NoticeTitlePlugin extends Plugin function onStartShowNoticeFormData($form) { - $form->out->element('style', null, 'label#notice_data-text-label { display: none }'); + $form->out->element('style', + null, + 'label#notice_data-text-label { display: none }'); $form->out->element('input', array('type' => 'text', 'id' => 'notice_title', 'name' => 'notice_title', @@ -257,5 +259,24 @@ class NoticeTitlePlugin extends Plugin return true; } + + /** + * Remove title when the notice is deleted + * + * @param Notice $notice Notice being deleted + * + * @return boolean hook value + */ + + function onNoticeDeleteRelated($notice) + { + $nt = Notice_title::staticGet('notice_id', $notice->id); + + if (!empty($nt)) { + $nt->delete(); + } + + return true; + } } -- cgit v1.2.3-54-g00ecf