plugins/TinyMCE/TinyMCEPlugin.php

   1 <?php
   2
   3 /**
   4  * StatusNet - the distributed open-source microblogging tool
   5  * Copyright (C) 2010, StatusNet, Inc.
   6  *
   7  * Use TinyMCE library to allow rich text editing in the browser
   8  *
   9  * PHP version 5
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Affero General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Affero General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU Affero General Public License
  22  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  23  *
  24  * @category  WYSIWYG
  25  * @package   StatusNet
  26  * @author    Evan Prodromou <evan@status.net>
  27  * @copyright 2010 StatusNet, Inc.
  28  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  29  * @link      http://status.net/
  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 class TinyMCEPlugin extends Plugin
  50 {
  51     var $html;
  52
  53     function onEndShowScripts($action)
  54     {
  55         if (common_logged_in ()) {
  56             $action->script(common_path('plugins/TinyMCE/js/jquery.tinymce.js'));
  57             $action->inlineScript($this->_inlineScript());
  58         }
  59
  60         return true;
  61     }
  62
  63     function onEndShowStyles($action)
  64     {
  65         $action->style('span#notice_data-text_container, span#notice_data-text_parent { float: left }');
  66         return true;
  67     }
  68
  69     function onPluginVersion(&$versions)
  70     {
  71         $versions[] = array('name' => 'TinyMCE',
  72             'version' => STATUSNET_VERSION,
  73             'author' => 'Evan Prodromou',
  74             'homepage' => 'http://status.net/wiki/Plugin:TinyMCE',
  75             'rawdescription' =>
  76             _m('Use TinyMCE library to allow rich text editing in the browser.'));
  77         return true;
  78     }
  79
  80     /**
  81      * Sanitize HTML input and strip out potentially dangerous bits.
  82      *
  83      * @param string $raw HTML
  84      * @return string HTML
  85      */
  86     private function sanitizeHtml($raw)
  87     {
  88         require_once INSTALLDIR . '/extlib/htmLawed/htmLawed.php';
  89
  90         $config = array('safe' => 1,
  91             'deny_attribute' => 'id,style,on*');
  92
  93         return htmLawed($raw, $config);
  94     }
  95
  96     /**
  97      * Strip HTML to plaintext string
  98      *
  99      * @param string $html HTML
 100      * @return string plaintext, single line
 101      */
 102     private function stripHtml($html)
 103     {
 104         return str_replace("\n", " ", html_entity_decode(strip_tags($html), ENT_QUOTES, 'UTF-8'));
 105     }
 106
 107     /**
 108      * Hook for new-notice form processing to take our HTML goodies;
 109      * won't affect API posting etc.
 110      *
 111      * @param NewNoticeAction $action
 112      * @param User $user
 113      * @param string $content
 114      * @param array $options
 115      * @return boolean hook return
 116      */
 117     function onStartSaveNewNoticeWeb($action, $user, &$content, &$options)
 118     {
 119         if ($action->arg('richedit')) {
 120             $html = $this->sanitizeHtml($content);
 121             $options['rendered'] = $html;
 122             $content = $this->stripHtml($html);
 123         }
 124         return true;
 125     }
 126
 127     /**
 128      * Hook for new-notice form processing to process file upload appending...
 129      *
 130      * @param NewNoticeAction $action
 131      * @param MediaFile $media
 132      * @param string $content
 133      * @param array $options
 134      * @return boolean hook return
 135      */
 136     function onStartSaveNewNoticeAppendAttachment($action, $media, &$content, &$options)
 137     {
 138         if ($action->arg('richedit')) {
 139             // See if we've got a placeholder inline image; if so, fill it!
 140             $dom = new DOMDocument();
 141
 142             if ($dom->loadHTML($options['rendered'])) {
 143                 $imgs = $dom->getElementsByTagName('img');
 144                 foreach ($imgs as $img) {
 145                     if (preg_match('/(^| )placeholder( |$)/', $img->getAttribute('class'))) {
 146                         // Create a link to the attachment page...
 147                         $this->formatAttachment($img, $media);
 148                     }
 149                 }
 150                 $options['rendered'] = $this->saveHtml($dom);
 151             }
 152
 153             // The regular code will append the short URL to the plaintext content.
 154             // Carry on and let it through...
 155         }
 156         return true;
 157     }
 158
 159     /**
 160      * Format the attachment placeholder img with the final version.
 161      *
 162      * @param DOMElement $img
 163      * @param MediaFile $media
 164      */
 165     private function formatAttachment($img, $media)
 166     {
 167         $parent = $img->parentNode;
 168         $dom = $img->ownerDocument;
 169
 170         $link = $dom->createElement('a');
 171         $link->setAttribute('href', $media->fileurl);
 172         $link->setAttribute('title', File::url($media->filename));
 173
 174         if ($this->isEmbeddable($media)) {
 175             // Fix the the <img> attributes and wrap the link around it...
 176             $this->insertImage($img, $media);
 177             $parent->replaceChild($link, $img); //it dies in here?!
 178             $link->appendChild($img);
 179         } else {
 180             // Not an image? Replace it with a text link.
 181             $link->setAttribute('rel', 'external');
 182             $link->setAttribute('class', 'attachment');
 183             $link->setAttribute('id', 'attachment-' . $media->fileRecord->id);
 184             $text = $dom->createTextNode($media->shortUrl());
 185             $link->appendChild($text);
 186             $parent->replaceChild($link, $img);
 187         }
 188     }
 189
 190     /**
 191      * Is this media file a type we can display inline?
 192      *
 193      * @param MediaFile $media
 194      * @return boolean
 195      */
 196     private function isEmbeddable($media)
 197     {
 198         $showable = array('image/png',
 199                           'image/gif',
 200                           'image/jpeg');
 201         return in_array($media->mimetype, $showable);
 202     }
 203
 204     /**
 205      * Rewrite and resize a placeholder image element to match the uploaded
 206      * file. If the holder is smaller than the file, the file is scaled to fit
 207      * with correct aspect ratio (but will be loaded at full resolution).
 208      *
 209      * @param DOMElement $img
 210      * @param MediaFile $media
 211      */
 212     private function insertImage($img, $media)
 213     {
 214         $img->setAttribute('src', $media->fileRecord->url);
 215
 216         $holderWidth = intval($img->getAttribute('width'));
 217         $holderHeight = intval($img->getAttribute('height'));
 218
 219         $path = File::path($media->filename);
 220         $imgInfo = getimagesize($path);
 221
 222         if ($imgInfo) {
 223             $origWidth = $imgInfo[0];
 224             $origHeight = $imgInfo[1];
 225
 226             list($width, $height) = $this->sizeBox(
 227                     $origWidth, $origHeight,
 228                     $holderWidth, $holderHeight);
 229
 230             $img->setAttribute('width', $width);
 231             $img->setAttribute('height', $height);
 232         }
 233     }
 234
 235     /**
 236      *
 237      * @param int $origWidth
 238      * @param int $origHeight
 239      * @param int $holderWidth
 240      * @param int $holderHeight
 241      * @return array($width, $height)
 242      */
 243     private function sizeBox($origWidth, $origHeight, $holderWidth, $holderHeight)
 244     {
 245         $holderAspect = $holderWidth / $holderHeight;
 246         $origAspect = $origWidth / $origHeight;
 247         if ($origAspect >= 1.0) {
 248             // wide image
 249             if ($origWidth > $holderWidth) {
 250                 return array($holderWidth, intval($holderWidth / $origAspect));
 251             } else {
 252                 return array($origWidth, $origHeight);
 253             }
 254         } else {
 255             if ($origHeight > $holderHeight) {
 256                 return array(intval($holderWidth * $origAspect), $holderHeight);
 257             } else {
 258                 return array($origWidth, $origHeight);
 259             }
 260         }
 261     }
 262
 263     private function saveHtml($dom)
 264     {
 265         $html = $dom->saveHTML();
 266         // hack to remove surrounding crap added to the dom
 267         // all we wanted was a fragment
 268         $stripped = preg_replace('/^.*<body[^>]*>(.*)<\/body.*$/is', '$1', $html);
 269         return $stripped;
 270     }
 271
 272     function _inlineScript()
 273     {
 274         $path = common_path('plugins/TinyMCE/js/tiny_mce.js');
 275         $placeholder = common_path('plugins/TinyMCE/icons/placeholder.png');
 276
 277         // Note: the normal on-submit triggering to save data from
 278         // the HTML editor into the textarea doesn't play well with
 279         // our AJAX form submission. Manually moving it to trigger
 280         // on our send button click.
 281         $scr = <<<END_OF_SCRIPT
 282         $().ready(function() {
 283             var noticeForm = $('#form_notice');
 284             $('textarea#notice_data-text').tinymce({
 285                 script_url : '{$path}',
 286                 // General options
 287                 theme : "advanced",
 288                 plugins : "paste,fullscreen,autoresize,inlinepopups,tabfocus,linkautodetect",
 289                 theme_advanced_buttons1 : "bold,italic,strikethrough,|,undo,redo,|,link,unlink,image,|,fullscreen",
 290                 theme_advanced_buttons2 : "",
 291                 theme_advanced_buttons3 : "",
 292                 add_form_submit_trigger : false,
 293                 theme_advanced_resizing : true,
 294                 tabfocus_elements: ":prev,:next",
 295                 setup: function(ed) {
 296                     noticeForm.append('<input type="hidden" name="richedit" value="1">');
 297
 298                     $('#notice_action-submit').click(function() {
 299                         tinymce.triggerSave();
 300                     });
 301
 302                     var origCounter = SN.U.CharacterCount;
 303                     SN.U.CharacterCount = function(form) {
 304                         var text = $(ed.getDoc()).text();
 305                         return text.length;
 306                     };
 307                     ed.onKeyUp.add(function (ed, e) {
 308                         SN.U.Counter(noticeForm);
 309                     });
 310
 311                     $('#'+SN.C.S.NoticeDataAttach).change(function() {
 312                         var img = '<img src="{$placeholder}" class="placeholder" width="320" height="240">';
 313                         var html = tinyMCE.activeEditor.getContent();
 314                         ed.setContent(html + img);
 315                     });
 316                 }
 317             });
 318         });
 319 END_OF_SCRIPT;
 320
 321         return $scr;
 322     }
 323 }