Implement TinyMCE imagebrowser plugin

This is a TinyMCE plugin which allows for browsing and embedding of
Mahara-hosted images as well as the embedding of external web-hosted
images. This makes adding inline images to WYSIWYG text boxes more
user-friendly.

Viewing permissions for these embedded files is set by adding references
to them to a new database table, artefact_file_embedded, then checking
for the existence of the references in the table when serving the files
via artefact/file/download.php. For content blocks in views, such as
text and textboxes, any embedded images are saved as view artefacts, and
viewing permission is granted for those files accordingly via previously
existing checks in artefact/file/download.php.

This patch is designed to allow image embedding in all WYSIWYG text
boxes throughout Mahara, hence the table structure, with resourcetype
and resourceid providing the context for checking the validity of the
image file to be served.

Change-Id: Idcc5ab3495eed44eea6ced171d670ba4c73884f6
Signed-off-by: Mike Kelly <m.f.kelly@arts.ac.uk>

htdocs/artefact/blog/index.php

@@ -45,6 +45,7 @@ $smarty->display('artefact:blog:index.tpl');
 
 function delete_blog_submit(Pieform $form, $values) {
     global $SESSION;
+    require_once('embeddedimage.php');
     $blog = new ArtefactTypeBlog($values['delete']);
     $blog->check_permission();
     if ($blog->get('locked')) {
@@ -52,6 +53,7 @@ function delete_blog_submit(Pieform $form, $values) {
     }
     else {
         $blog->delete();
+        EmbeddedImage::delete_embedded_images('blog', $blog->get('id'));
         $SESSION->add_ok_msg(get_string('blogdeleted', 'artefact.blog'));
     }
     redirect('/artefact/blog/index.php');

htdocs/artefact/blog/lib.php

@@ -327,6 +327,8 @@ class ArtefactTypeBlog extends ArtefactType {
      * @param array
      */
     public static function new_blog(User $user, array $values) {
+        require_once('embeddedimage.php');
+        db_begin();
         $artefact = new ArtefactTypeBlog();
         $artefact->set('title', $values['title']);
         $artefact->set('description', $values['description']);
@@ -338,6 +340,10 @@ class ArtefactTypeBlog extends ArtefactType {
             $artefact->set('licensorurl', $values['licensorurl']);
         }
         $artefact->commit();
+        $blogid = $artefact->get('id');
+        $newdescription = EmbeddedImage::prepare_embedded_images($artefact->get('description'), 'blog', $blogid);
+        $artefact->set('description', $newdescription);
+        db_commit();
     }
 
     /**
@@ -347,6 +353,7 @@ class ArtefactTypeBlog extends ArtefactType {
      * @param array
      */
     public static function edit_blog(User $user, array $values) {
+        require_once('embeddedimage.php');
         if (empty($values['id']) || !is_numeric($values['id'])) {
             return;
         }
@@ -357,7 +364,8 @@ class ArtefactTypeBlog extends ArtefactType {
         }
 
         $artefact->set('title', $values['title']);
-        $artefact->set('description', $values['description']);
+        $newdescription = EmbeddedImage::prepare_embedded_images($values['description'], 'blog', $values['id']);
+        $artefact->set('description', $newdescription);
         $artefact->set('tags', $values['tags']);
         if (get_config('licensemetadata')) {
             $artefact->set('license', $values['license']);
@@ -579,10 +587,11 @@ class ArtefactTypeBlogPost extends ArtefactType {
             return;
         }
 
+        require_once('embeddedimage.php');
         db_begin();
         $this->detach(); // Detach all file attachments
         delete_records('artefact_blog_blogpost', 'blogpost', $this->id);
-
+        EmbeddedImage::delete_embedded_images('blogpost', $this->id);
         parent::delete();
         db_commit();
     }

htdocs/artefact/blog/post.php

@@ -183,7 +183,7 @@ EOF;
 
 $smarty = smarty(array(), array(), array(), array(
     'tinymceconfig' => '
-        plugins: "tooltoggle,textcolor,link,maharaimage,table,emoticons,spellchecker,paste,code,fullscreen,directionality,searchreplace,nonbreaking,charmap",
+        plugins: "tooltoggle,textcolor,link,imagebrowser,table,emoticons,spellchecker,paste,code,fullscreen,directionality,searchreplace,nonbreaking,charmap",
         image_filebrowser: "editpost_filebrowser",
     ',
     'sideblocks' => array(

htdocs/artefact/comment/edit.php

@@ -103,15 +103,16 @@ function edit_comment_validate(Pieform $form, $values) {
 
 function edit_comment_submit(Pieform $form, $values) {
     global $viewid, $comment, $SESSION, $goto, $USER;
+    require_once('embeddedimage.php');
 
     db_begin();
-
-    $comment->set('description', $values['message']);
     $comment->set('rating', valid_rating($values['rating']));
     require_once(get_config('libroot') . 'view.php');
     $view = new View($viewid);
     $owner = $view->get('owner');
     $group = $comment->get('group');
+    $newdescription = EmbeddedImage::prepare_embedded_images($values['message'], 'comment', $comment->get('id'), $group);
+    $comment->set('description', $newdescription);
     $approvecomments = $view->get('approvecomments');
     if (!empty($group) && ($approvecomments || (!$approvecomments && $view->user_comments_allowed($USER) == 'private')) && $values['ispublic'] && !$USER->can_edit_view($view)) {
         $comment->set('requestpublic', 'author');

htdocs/artefact/comment/lib.php

@@ -1017,6 +1017,7 @@ function make_public_submit(Pieform $form, $values) {
 
 function delete_comment_submit(Pieform $form, $values) {
     global $SESSION, $USER, $view;
+    require_once('embeddedimage.php');
 
     $comment = new ArtefactTypeComment((int) $values['comment']);
 
@@ -1084,6 +1085,7 @@ function delete_comment_submit(Pieform $form, $values) {
         activity_occurred('feedback', $data, 'artefact', 'comment');
     }
 
+    EmbeddedImage::delete_embedded_images('comment', $comment->get('id'));
     db_commit();
 
     $SESSION->add_ok_msg(get_string('commentremoved', 'artefact.comment'));
@@ -1091,8 +1093,8 @@ function delete_comment_submit(Pieform $form, $values) {
 }
 
 function add_feedback_form_validate(Pieform $form, $values) {
-    require_once(get_config('libroot') . 'antispam.php');
     if ($form->get_property('spam')) {
+        require_once(get_config('libroot') . 'antispam.php');
         $spamtrap = new_spam_trap(array(
             array(
                 'type' => 'body',
@@ -1120,6 +1122,7 @@ function add_feedback_form_validate(Pieform $form, $values) {
 
 function add_feedback_form_submit(Pieform $form, $values) {
     global $view, $artefact, $USER;
+    require_once('embeddedimage.php');
     $data = (object) array(
         'title'       => get_string('Comment', 'artefact.comment'),
         'description' => $values['message'],
@@ -1174,6 +1177,15 @@ function add_feedback_form_submit(Pieform $form, $values) {
 
     $comment->commit();
 
+    $newdescription = EmbeddedImage::prepare_embedded_images($values['message'], 'comment', $comment->get('id'), $data->group);
+
+    if ($newdescription !== $values['message']) {
+        $updatedcomment = new stdClass();
+        $updatedcomment->id = $comment->get('id');
+        $updatedcomment->description = $newdescription;
+        update_record('artefact', $updatedcomment, 'id');
+    }
+
     $url = $comment->get_view_url($view->get('id'), true, false);
     $goto = get_config('wwwroot') . $url;
 

htdocs/artefact/file/db/install.xml

@@ -28,14 +28,26 @@
             <KEY NAME="artefactfk" TYPE="foreign" FIELDS="artefact" REFTABLE="artefact" REFFIELDS="id" />
         </KEYS>
     </TABLE>
-        <TABLE NAME="artefact_file_mime_types">
-            <FIELDS>
-                <FIELD NAME="mimetype" TYPE="char" LENGTH="128" NOTNULL="true"/>
-                <FIELD NAME="description" TYPE="char" LENGTH="32" NOTNULL="true"/>
-            </FIELDS>
-            <KEYS>
-                <KEY NAME="primary" TYPE="primary" FIELDS="mimetype"/>
-            </KEYS>
-        </TABLE>
+    <TABLE NAME="artefact_file_mime_types">
+        <FIELDS>
+            <FIELD NAME="mimetype" TYPE="char" LENGTH="128" NOTNULL="true"/>
+            <FIELD NAME="description" TYPE="char" LENGTH="32" NOTNULL="true"/>
+        </FIELDS>
+        <KEYS>
+            <KEY NAME="primary" TYPE="primary" FIELDS="mimetype"/>
+        </KEYS>
+    </TABLE>
+    <TABLE NAME="artefact_file_embedded">
+        <FIELDS>
+            <FIELD NAME="id" TYPE="int" LENGTH="10" NOTNULL="true" SEQUENCE="true" />
+            <FIELD NAME="fileid" TYPE="int" LENGTH="10" NOTNULL="true" />
+            <FIELD NAME="resourcetype" TYPE="char" LENGTH="100" NOTNULL="true" />
+            <FIELD NAME="resourceid" TYPE="int" LENGTH="10" NOTNULL="true" />
+        </FIELDS>
+        <KEYS>
+            <KEY NAME="primary" TYPE="primary" FIELDS="id" />
+            <KEY NAME="artefactfk" TYPE="foreign" FIELDS="fileid" REFTABLE="artefact" REFFIELDS="id" />
+        </KEYS>
+    </TABLE>
 </TABLES>
 </XMLDB>

htdocs/artefact/file/db/upgrade.php

@@ -400,5 +400,20 @@ function xmldb_artefact_file_upgrade($oldversion=0) {
         execute_sql($sql);
     }
 
+    if ($oldversion < 2014111200) {
+        // Create embedded images table
+        $table = new XMLDBTable('artefact_file_embedded');
+
+        $table->addFieldInfo('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE);
+        $table->addFieldInfo('fileid', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL);
+        $table->addFieldInfo('resourcetype', XMLDB_TYPE_CHAR, '100', XMLDB_UNSIGNED, XMLDB_NOTNULL);
+        $table->addFieldInfo('resourceid', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL);
+
+        $table->addKeyInfo('primary', XMLDB_KEY_PRIMARY, array('id'));
+        $table->addKeyInfo('artefactfk', XMLDB_KEY_FOREIGN, array('fileid'), 'artefact', array('id'));
+
+        $status = $status && create_table($table);
+    }
+
     return $status;
 }

htdocs/artefact/file/download.php

@@ -14,8 +14,10 @@ define('PUBLIC', 1);
 require(dirname(dirname(dirname(__FILE__))) . '/init.php');
 safe_require('artefact', 'file');
 require_once('file.php');
+require_once('embeddedimage.php');
 
 $fileid = param_integer('file');
+$groupid = param_integer('group', 0);
 $viewid = param_integer('view', null);
 $postid = param_integer('post', null);
 $size   = get_imagesize_parameters();
@@ -99,7 +101,7 @@ else {
         // If the file is in the logged in menu and the user is logged in then
         // they can view it
         $fileinloggedinmenu = $file->get('institution') == 'mahara';
-        // check if users are allowed to access files in subfolders
+        // check if users are allowed to access files in subfolders      
         if (!get_config('sitefilesaccess')) {
             $fileinloggedinmenu = $fileinloggedinmenu && $file->get('parent') == null;
         }
@@ -110,15 +112,36 @@ else {
             // Alternatively, if you own the file or you are an admin, it should always work
 
             if (!$USER->can_view_artefact($file)) {
+            	
+            	$imagevisible = false;
+
+                // Check for resume elements in pages
+                $resumelements = array('resumecoverletter','resumeinterest','personalgoal','academicgoal','careergoal','personalskill','academicskill','workskill','profileintrotext');
+                foreach ($resumelements as $element) {    
+                	$resourceid = param_integer($element, null);
+                	if ($resourceid && $file instanceof ArtefactTypeImage) {
+                		$imagevisible = EmbeddedImage::can_see_embedded_image($fileid, $element, $resourceid);
+                	}
+                	if ($imagevisible) {
+                		break;
+                	}
+                }
 
                 // Check for images sitting in visible forum posts
-                $visibleinpost = false;
-                if ($postid && $file instanceof ArtefactTypeImage) {
+                if (!$imagevisible && $postid && $file instanceof ArtefactTypeImage) {
                     safe_require('interaction', 'forum');
-                    $visibleinpost = PluginInteractionForum::can_see_attached_file($file, $postid);
+                    $imagevisible = PluginInteractionForum::can_see_attached_file($file, $postid);
+                }
+
+                if (!$imagevisible && $groupid) {
+                    // check for public embedded image
+                    if (!group_user_access($groupid)){
+                        throw new AccessDeniedException(get_string('accessdenied', 'error'));
+                    }
+                    $imagevisible = EmbeddedImage::can_see_embedded_image($fileid, 'group', $groupid);
                 }
 
-                if (!$visibleinpost) {
+                if (!$imagevisible) {
                     throw new AccessDeniedException(get_string('accessdenied', 'error'));
                 }
             }

htdocs/artefact/file/js/filebrowser.js

@@ -779,6 +779,11 @@ function FileBrowser(idprefix, folderid, config, globalconfig) {
             addElementClass(self.id + '_empty_selectlist', 'hidden');
         }
         this.update_metadata_to_selected_list();
+        // are we running inside tinymce imagebrowser plugin?
+    	if (window.imgbrowserconf_artefactid) {
+    		// propagate the click
+    		jQuery('#filebrowserupdatetarget').click();
+    	}
     }
 
     this.unselect = function (e) {

htdocs/artefact/file/version.php

@@ -12,6 +12,6 @@
 defined('INTERNAL') || die();
 
 $config = new StdClass;
-$config->version = 2014061000;
+$config->version = 2014111200;
 $config->release = '1.2.4';
 

htdocs/artefact/internal/blocktype/textbox/lib.php

@@ -412,8 +412,20 @@ EOF;
         return $elements;
     }
 
+    public static function delete_instance($instance) {
+        require_once('embeddedimage.php');
+        $configdata = $instance->get('configdata');
+        if (!empty($configdata)) {
+            $artefactid = $configdata['artefactid'];
+            if (!empty($artefactid)) {
+                EmbeddedImage::delete_embedded_images($instance->get('blocktype'), $artefactid);
+            }
+        }
+    }
+
     public static function instance_config_save($values, $instance) {
         global $USER;
+        require_once('embeddedimage.php');
         $data = array();
         $view = $instance->get_view();
         foreach (array('owner', 'group', 'institution') as $f) {
@@ -462,7 +474,8 @@ EOF;
                 && $artefact->get('institution') === $data['institution']
                 && !$artefact->get('locked')
                 && $USER->can_edit_artefact($artefact)) {
-                $artefact->set('description', $values['text']);
+                $newdescription = EmbeddedImage::prepare_embedded_images($values['text'], 'textbox', (int)$values['artefactid'], $view->get('group'));
+                $artefact->set('description', $newdescription);
                 if (get_config('licensemetadata')) {
                     $artefact->set('license', $values['license']);
                     $artefact->set('licensor', $values['licensor']);
@@ -475,6 +488,15 @@ EOF;
 
         $artefact->commit();
 
+        $newdescription = EmbeddedImage::prepare_embedded_images($values['text'], 'textbox', $artefact->get('id'), $view->get('group'));
+
+        if ($newdescription !== $values['text']) {
+            $updatedartefact = new stdClass();
+            $updatedartefact->id = $artefact->get('id');
+            $updatedartefact->description = $newdescription;
+            update_record('artefact', $updatedartefact, 'id');
+        }
+
         // Add attachments, if there are any...
         $old = $artefact->attachment_id_list();
         $new = is_array($values['artefactids']) ? $values['artefactids'] : array();

htdocs/artefact/internal/editnote.php

@@ -164,10 +164,12 @@ $smarty->display('form.tpl');
 
 function editnote_submit(Pieform $form, array $values) {
     global $SESSION, $artefact, $goto;
+    require_once('embeddedimage.php');
 
     db_begin();
     $artefact->set('title', $values['title']);
-    $artefact->set('description', $values['description']);
+    $newdescription = EmbeddedImage::prepare_embedded_images($values['description'], 'editnote', $artefact->get('id'), $artefact->get('group'));
+    $artefact->set('description', $newdescription);
     $artefact->set('tags', $values['tags']);
     $artefact->set('allowcomments', (int) $values['allowcomments']);
     if (isset($values['perms'])) {

htdocs/artefact/internal/index.php

@@ -257,6 +257,7 @@ function profileform_submit(Pieform $form, $values) {
     global $USER;
     global $element_list;
     global $profilefields;
+    require_once('embeddedimage.php');
 
     db_begin();
 
@@ -399,6 +400,11 @@ function profileform_submit(Pieform $form, $values) {
         }
         else {
             if (!isset($profilefields[$element]) || $values[$element] != $profilefields[$element]) {
+
+                if ($element == 'introduction') {
+                    $newintroduction = EmbeddedImage::prepare_embedded_images($values[$element], 'profileintrotext', $USER->get('id'));
+                    $values[$element] = $newintroduction;
+                }
                 $classname = generate_artefact_class_name($element);
                 $profile = new $classname(0, array('owner' => $USER->get('id')));
                 $profile->set('title', $values[$element]);

htdocs/artefact/internal/notes.php

@@ -231,9 +231,11 @@ function deletenote_form($id, $notedata) {
 
 function deletenote_submit(Pieform $form, array $values) {
     global $SESSION, $data, $baseurl;
+    require_once('embeddedimage.php');
     $id = $data[$values['delete']]->id;
     $note = new ArtefactTypeHtml($id);
     $note->delete();
+    EmbeddedImage::delete_embedded_images('editnote', $id);
     $SESSION->add_ok_msg(get_string('notedeleted', 'artefact.internal'));
     redirect($baseurl);
 }

htdocs/artefact/resume/editgoalsandskills.php

@@ -149,10 +149,13 @@ $smarty->display('artefact:resume:editgoalsandskills.tpl');
 
 function editgoalsandskills_submit(Pieform $form, array $values) {
     global $SESSION, $artefact, $USER;
+    require_once('embeddedimage.php');
+
+    $newdescription = EmbeddedImage::prepare_embedded_images($values['description'], $values['artefacttype'], $USER->get('id'));
 
     db_begin();
     $artefact->set('title', get_string($values['artefacttype'], 'artefact.resume'));
-    $artefact->set('description', $values['description']);
+    $artefact->set('description', $newdescription);
     $artefact->commit();
 
     // Attachments

htdocs/artefact/resume/lib.php

@@ -2105,8 +2105,18 @@ function simple_resumefield_form($defaults, $goto, $options = array()) {
 
 function simple_resumefield_submit(Pieform $form, $values) {
     global $simple_resume_types, $simple_resume_artefacts, $USER;
+    require_once('embeddedimage.php');
     $owner = $USER->get('id');
 
+    if (isset($values['coverletter'])) {
+        $newcoverletter = EmbeddedImage::prepare_embedded_images($values['coverletter'], 'resumecoverletter', $USER->get('id'));
+        $values['coverletter'] = $newcoverletter;
+    }
+    else if (isset($values['interest'])) {
+        $newinterest = EmbeddedImage::prepare_embedded_images($values['interest'], 'resumeinterest', $USER->get('id'));
+        $values['interest'] = $newinterest;
+    }
+
     foreach ($simple_resume_types as $t) {
         if (isset($values[$t . 'submit']) && isset($values[$t])) {
             if (!isset($simple_resume_artefacts[$t])) {

htdocs/blocktype/text/lib.php

@@ -25,11 +25,22 @@ class PluginBlocktypeText extends SystemBlocktype {
         return array('shortcut');
     }
 
+    public static function get_artefacts(BlockInstance $instance) {
+        safe_require('artefact', 'file');
+        $configdata = $instance->get('configdata');
+        // Add all artefacts found in the text
+        $text = $configdata['text'];
+        $artefacts = array_unique(artefact_get_references_in_html($text));
+        return $artefacts;
+    }
+
     public static function render_instance(BlockInstance $instance, $editing=false) {
+        safe_require('artefact', 'file');
         $configdata = $instance->get('configdata');
         $smarty = smarty_core();
         if (array_key_exists('text', $configdata)) {
-            $smarty->assign('text', $configdata['text']);
+            $newtext = ArtefactTypeFolder::append_view_url($configdata['text'], $instance->get('view'));
+            $smarty->assign('text', $newtext);
         }
         else {
             $smarty->assign('text', '');
@@ -68,6 +79,13 @@ class PluginBlocktypeText extends SystemBlocktype {
         return $elements;
     }
 
+    public static function instance_config_save($values, $instance) {
+        require_once('embeddedimage.php');
+        $newtext = EmbeddedImage::prepare_embedded_images($values['text'], 'text', $instance->get('id'));
+        $values['text'] = $newtext;
+        return $values;
+    }
+
     public static function default_copy_type() {
         return 'full';
     }

htdocs/group/delete.php

@@ -50,8 +50,10 @@ $smarty->assign('form', $form);
 $smarty->display('group/delete.tpl');
 
 function deletegroup_submit(Pieform $form, $values) {
+    require_once('embeddedimage.php');
     global $SESSION, $USER, $groupid;
     group_delete($groupid);
+    EmbeddedImage::delete_embedded_images('group', $groupid);
     $SESSION->add_ok_msg(get_string('deletegroup', 'group'));
     redirect('/group/mygroups.php');
 }

htdocs/group/edit.php

@@ -15,6 +15,7 @@ require(dirname(dirname(__FILE__)) . '/init.php');
 require_once('pieforms/pieform.php');
 require_once('group.php');
 require_once(get_config('libroot') . 'antispam.php');
+require_once('embeddedimage.php');
 
 if ($id = param_integer('id', null)) {
     define('TITLE', get_string('editgroup', 'group'));
@@ -516,6 +517,10 @@ function editgroup_submit(Pieform $form, $values) {
         $USER->reset_grouproles();
     }
 
+    $newvalues['description'] = EmbeddedImage::prepare_embedded_images($newvalues['description'], 'group', $group_data->id, $group_data->id);
+    $newvalues['id'] = $group_data->id;
+    group_update((object)$newvalues);
+
     $SESSION->add_ok_msg(get_string('groupsaved', 'group'));
 
     db_commit();

htdocs/interaction/forum/deletetopic.php

@@ -20,6 +20,7 @@ safe_require('interaction' ,'forum');
 require_once('group.php');
 require_once('pieforms/pieform.php');
 require_once(get_config('docroot') . 'interaction/lib.php');
+require_once('embeddedimage.php');
 
 $topicid = param_integer('id');
 $returnto = param_alpha('returnto', 'topic');
@@ -109,6 +110,7 @@ function deletetopic_submit(Pieform $form, $values) {
         array('deleted' => 1),
         array('id' => $topicid)
     );
+    EmbeddedImage::delete_embedded_images('topic', $topicid);
     // mark relevant posts as deleted
     update_record(
         'interaction_forum_post',