Merge branch 'emailsitesetup' into 1.0.x

[quix0rs-gnu-social.git] / plugins / NoticeTitle / NoticeTitlePlugin.php

diff --git a/plugins/NoticeTitle/NoticeTitlePlugin.php b/plugins/NoticeTitle/NoticeTitlePlugin.php
index dea0417f5fd758375685746649e94f9d590ac2d3..39df2621acacd1b90923ebd4db352578474d68ee 100644 (file)
--- a/plugins/NoticeTitle/NoticeTitlePlugin.php
+++ b/plugins/NoticeTitle/NoticeTitlePlugin.php
@@ -48,9 +48,14 @@ define('NOTICE_TITLE_PLUGIN_VERSION', '0.1');
  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  * @link      http://status.net/
  */
-
 class NoticeTitlePlugin extends Plugin
 {
+
+    // By default, notice-title widget will be available to all users.
+    // With restricted on, only users who have been granted the
+    // "richedit" role get it.
+    public $restricted = false;
+
     /**
      * Database schema setup
      *
@@ -61,7 +66,6 @@ class NoticeTitlePlugin extends Plugin
      *
      * @return boolean hook value; true means continue processing, false means stop.
      */
-
     function onCheckSchema()
     {
         $schema = Schema::get();
@@ -89,7 +93,6 @@ class NoticeTitlePlugin extends Plugin
      *
      * @return boolean hook value; true means continue processing, false means stop.
      */
-
     function onAutoload($cls)
     {
         $dir = dirname(__FILE__);
@@ -113,7 +116,6 @@ class NoticeTitlePlugin extends Plugin
      *
      * @return boolean hook value
      */
-
     function onPluginVersion(&$versions)
     {
         $url = 'http://status.net/wiki/Plugin:NoticeTitle';
@@ -123,6 +125,7 @@ class NoticeTitlePlugin extends Plugin
                             'author' => 'Evan Prodromou',
                             'homepage' => $url,
                             'rawdescription' =>
+                            // TRANS: Plugin description.
                             _m('Adds optional titles to notices.'));
         return true;
     }
@@ -134,17 +137,18 @@ class NoticeTitlePlugin extends Plugin
      *
      * @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));
+        if ($this->isAllowedRichEdit()) {
+            $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;
     }
 
@@ -158,14 +162,17 @@ class NoticeTitlePlugin extends Plugin
      *
      * @return boolean hook value
      */
-
     function onStartNoticeSaveWeb($action, &$authorId, &$text, &$options)
     {
         $title = $action->trimmed('notice_title');
-        if (!empty($title)) {
+        if (!empty($title) && $this->isAllowedRichEdit()) {
             if (mb_strlen($title) > Notice_title::MAXCHARS) {
-                throw new Exception(sprintf(_m("The notice title is too long (max %d characters).",
-                                               Notice_title::MAXCHARS)));
+                // TRANS: Exception thrown when a notice title is too long.
+                // TRANS: %d is the maximum number of characters allowed in a title (used for plural).
+                throw new Exception(sprintf(_m('The notice title is too long (maximum %d character).',
+                                               'The notice title is too long (maximum %d characters).',
+                                               Notice_title::MAXCHARS),
+                                            Notice_title::MAXCHARS));
             }
         }
         return true;
@@ -179,14 +186,13 @@ class NoticeTitlePlugin extends Plugin
      *
      * @return boolean hook value
      */
-
     function onEndNoticeSaveWeb($action, $notice)
     {
         if (!empty($notice)) {
 
             $title = $action->trimmed('notice_title');
 
-            if (!empty($title)) {
+            if (!empty($title) && $this->isAllowedRichEdit()) {
 
                 $nt = new Notice_title();
 
@@ -207,13 +213,14 @@ class NoticeTitlePlugin extends Plugin
      *
      * @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);
+            $nli->out->elementStart('h4', array('class' => 'notice_title'));
+            $nli->out->element('a', array('href' => $nli->notice->bestUrl()), $title);
+            $nli->out->elementEnd('h4');
         }
 
         return true;
@@ -227,7 +234,6 @@ class NoticeTitlePlugin extends Plugin
      *
      * @return boolean hook value
      */
-
     function onEndRssEntryArray($notice, &$entry)
     {
         $title = Notice_title::fromNotice($notice);
@@ -248,13 +254,17 @@ class NoticeTitlePlugin extends Plugin
      *
      * @return boolean hook value
      */
-
-    function onStartActivityTitle(&$notice, &$xs, &$output)
+    function onEndNoticeAsActivity($notice, &$activity)
     {
         $title = Notice_title::fromNotice($notice);
 
         if (!empty($title)) {
-            $output = $title;
+            foreach ($activity->objects as $obj) {
+                if ($obj->id == $notice->uri) {
+                    $obj->title = $title;
+                    break;
+                }
+            }
         }
 
         return true;
@@ -267,7 +277,6 @@ class NoticeTitlePlugin extends Plugin
      *
      * @return boolean hook value
      */
-
     function onNoticeDeleteRelated($notice)
     {
         $nt = Notice_title::staticGet('notice_id', $notice->id);
@@ -286,7 +295,6 @@ class NoticeTitlePlugin extends Plugin
      *
      * @return boolean hook value
      */
-
     function onStartShowHeadTitle($action)
     {
         $actionName = $action->trimmed('action');
@@ -312,7 +320,6 @@ class NoticeTitlePlugin extends Plugin
      *
      * @return boolean hook value
      */
-
     function onStartShowPageTitle($action)
     {
         $actionName = $action->trimmed('action');
@@ -327,4 +334,23 @@ class NoticeTitlePlugin extends Plugin
 
         return true;
     }
+
+    /**
+     * Does the current user have permission to use the notice-title widget?
+     * Always true unless the plugin's "restricted" setting is on, in which
+     * case it's limited to users with the "richedit" role.
+     *
+     * @todo FIXME: make that more sanely configurable :)
+     *
+     * @return boolean
+     */
+    private function isAllowedRichEdit()
+    {
+        if ($this->restricted) {
+            $user = common_current_user();
+            return !empty($user) && $user->hasRole('richedit');
+        } else {
+            return true;
+        }
+    }
 }