Merge branch 'noticetitle' into 0.9.x

2 files changed, 420 insertions, 0 deletions

diff --git a/plugins/NoticeTitle/NoticeTitlePlugin.php b/plugins/NoticeTitle/NoticeTitlePlugin.php
new file mode 100644
index 000000000..f7fb1e4d0
--- /dev/null
+++ b/plugins/NoticeTitle/NoticeTitlePlugin.php
@@ -0,0 +1,282 @@
+<?php
+/**
+ * StatusNet - the distributed open-source microblogging tool
+ * Copyright (C) 2010, StatusNet, Inc.
+ *
+ * A plugin to add titles to notices
+ *
+ * PHP version 5
+ *
+ * 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 <http://www.gnu.org/licenses/>.
+ *
+ * @category  NoticeTitle
+ * @package   StatusNet
+ * @author    Evan Prodromou <evan@status.net>
+ * @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 <evan@status.net>
+ * @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',
+                                                 Notice_title::MAXCHARS,
+                                                 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;
+        }
+    }
+
+    /**
+     * 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' => $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('style',
+                            null,
+                            'label#notice_data-text-label { display: none }');
+        $form->out->element('input', array('type' => 'text',
+                                           'id' => 'notice_title',
+                                           'name' => 'notice_title',
+                                           'size' => 40,
+                                           '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)",
+                                               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)) {
+
+            $title = $action->trimmed('notice_title');
+
+            if (!empty($title)) {
+
+                $nt = new Notice_title();
+
+                $nt->notice_id = $notice->id;
+                $nt->title     = $title;
+
+                $nt->insert();
+            }
+        }
+
+        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);
+
+        if (!empty($title)) {
+            $nli->out->element('h4', array('class' => 'notice_title'), $title);
+        }
+
+        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);
+
+        if (!empty($title)) {
+            $entry['title'] = $title;
+        }
+
+        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);
+
+        if (!empty($title)) {
+            $output = $title;
+        }
+
+        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;
+    }
+}
+
diff --git a/plugins/NoticeTitle/Notice_title.php b/plugins/NoticeTitle/Notice_title.php
new file mode 100644
index 000000000..b3b4fcc57
--- /dev/null
+++ b/plugins/NoticeTitle/Notice_title.php
@@ -0,0 +1,138 @@
+<?php
+/**
+ * Data class for notice titles
+ *
+ * PHP version 5
+ *
+ * @category Data
+ * @package  StatusNet
+ * @author   Evan Prodromou <evan@status.net>
+ * @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 <http://www.gnu.org/licenses/>.
+ */
+
+if (!defined('STATUSNET')) {
+    exit(1);
+}
+
+require_once INSTALLDIR . '/classes/Memcached_DataObject.php';
+
+/**
+ * Data class for notice titles
+ *
+ * @category Action
+ * @package  StatusNet
+ * @author   Evan Prodromou <evan@status.net>
+ * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
+ * @link     http://status.net/
+ *
+ * @see      DB_DataObject
+ */
+
+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)
+
+    /**
+     * 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
+     *
+     * @return array list mapping field names to key types
+     */
+
+    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);
+    }
+
+    /**
+     * 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;
+        }
+    }
+}