plugins/TinyMCE/TinyMCEPlugin.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2010, StatusNet, Inc.
   5  *
   6  * Use TinyMCE library to allow rich text editing in the browser
   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  WYSIWYG
  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 /**
  38  * Use TinyMCE library to allow rich text editing in the browser
  39  *
  40  * Converts the notice form in browser to a rich-text editor.
  41  *
  42  * @category  WYSIWYG
  43  * @package   StatusNet
  44  * @author    Evan Prodromou <evan@status.net>
  45  * @copyright 2010 StatusNet, Inc.
  46  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  47  * @link      http://status.net/
  48  */
  49
  50 class TinyMCEPlugin extends Plugin
  51 {
  52     var $html;
  53
  54     function onEndShowScripts($action)
  55     {
  56         if (common_logged_in()) {
  57             $action->script(common_path('plugins/TinyMCE/js/jquery.tinymce.js'));
  58             $action->inlineScript($this->_inlineScript());
  59         }
  60
  61         return true;
  62     }
  63
  64     function onEndShowStyles($action)
  65     {
  66         $action->style('span#notice_data-text_container, span#notice_data-text_parent { float: left }');
  67         return true;
  68     }
  69
  70     function onPluginVersion(&$versions)
  71     {
  72         $versions[] = array('name' => 'TinyMCE',
  73                             'version' => STATUSNET_VERSION,
  74                             'author' => 'Evan Prodromou',
  75                             'homepage' => 'http://status.net/wiki/Plugin:TinyMCE',
  76                             'rawdescription' =>
  77                             _m('Use TinyMCE library to allow rich text editing in the browser'));
  78         return true;
  79     }
  80
  81     /**
  82      * Sanitize HTML input and strip out potentially dangerous bits.
  83      *
  84      * @param string $raw HTML
  85      * @return string HTML
  86      */
  87     private function sanitizeHtml($raw)
  88     {
  89         require_once INSTALLDIR.'/extlib/htmLawed/htmLawed.php';
  90
  91         $config = array('safe' => 1,
  92                         'deny_attribute' => 'id,style,on*');
  93
  94         return htmLawed($raw, $config);
  95     }
  96
  97     /**
  98      * Strip HTML to plaintext string
  99      *
 100      * @param string $html HTML
 101      * @return string plaintext, single line
 102      */
 103     private function stripHtml($html)
 104     {
 105         return str_replace("\n", " ", html_entity_decode(strip_tags($html)));
 106     }
 107
 108     /**
 109      * Hook for new-notice form processing to take our HTML goodies;
 110      * won't affect API posting etc.
 111      *
 112      * @param NewNoticeAction $action
 113      * @param User $user
 114      * @param string $content
 115      * @param array $options
 116      * @return boolean hook return
 117      */
 118     function onSaveNewNoticeWeb($action, $user, &$content, &$options)
 119     {
 120         $html = $this->sanitizeHtml($action->arg('status_textarea'));
 121         $options['rendered'] = $html;
 122         $content = $this->stripHtml($html);
 123         return true;
 124     }
 125
 126     function _inlineScript()
 127     {
 128         $path = common_path('plugins/TinyMCE/js/tiny_mce.js');
 129
 130         // Note: the normal on-submit triggering to save data from
 131         // the HTML editor into the textarea doesn't play well with
 132         // our AJAX form submission. Manually moving it to trigger
 133         // on our send button click.
 134         $scr = <<<END_OF_SCRIPT
 135         $().ready(function() {
 136             $('textarea#notice_data-text').tinymce({
 137                 script_url : '{$path}',
 138                 // General options
 139                 theme : "advanced",
 140                 plugins : "paste,fullscreen,autoresize,inlinepopups,tabfocus,linkautodetect",
 141                 theme_advanced_buttons1 : "bold,italic,strikethrough,|,undo,redo,|,link,unlink,image,|,fullscreen",
 142                 theme_advanced_buttons2 : "",
 143                 theme_advanced_buttons3 : "",
 144                 add_form_submit_trigger : false,
 145                 theme_advanced_resizing : true,
 146                 tabfocus_elements: ":prev,:next"
 147             });
 148             $('#notice_action-submit').click(function() {
 149                 tinymce.triggerSave();
 150             });
 151         });
 152 END_OF_SCRIPT;
 153
 154         return $scr;
 155     }
 156 }
 157