chamilo-lms2/main/document/edit_document.php

<?php
/* For licensing terms, see /license.txt */

/**
 * This file allows editing documents.
 *
 * Based on create_document, this file allows
 * - edit name
 * - edit comments
 * - edit metadata (requires a document table entry)
 * - edit html content (only for htm/html files)
 *
 * For all files
 * - show editable name field
 * - show editable comments field
 * Additionally, for html and text files
 * - show RTE
 *
 * Remember, all files and folders must always have an entry in the
 * database, regardless of wether they are visible/invisible, have
 * comments or not.
 *
 * @package chamilo.document
 * @todo improve script structure (FormValidator is used to display form, but
 * not for validation at the moment)
 */
/**
 * Code
 */

// Name of the language file that needs to be included
$language_file = array('document', 'gradebook');

/*	Included libraries */

require_once '../inc/global.inc.php';

// Template's javascript
$htmlHeadXtra[] = '
<script>
var hide_bar = function() {
    $("#template_col").hide();
    $("#doc_form").removeClass("span9");
    $("#doc_form").addClass("span11");
    $("#hide_bar_template").css({"background-image" : \'url("../img/hide2.png")\'})
}

$(document).ready(function() {
    if ($(window).width() <= 785 ) {
        hide_bar();
    }

    $("#hide_bar_template").toggle(
        function() {
            hide_bar();
        },
        function() {
            $("#template_col").show();
            $("#doc_form").removeClass("span11");
            $("#doc_form").addClass("span9");
            $(this).css("background-image", \'url("../img/hide0.png")\');
        }
    );
});

function InnerDialogLoaded() {
	/*
	var B=new window.frames[0].FCKToolbarButton(\'Templates\',window.frames[0].FCKLang.Templates);
	return B.ClickFrame();
	*/
	var isIE  = (navigator.appVersion.indexOf(\'MSIE\') != -1) ? true : false ;
	var EditorFrame = null ;

	if ( !isIE ) {
		EditorFrame = window.frames[0] ;
	} else {
		// For this dynamic page window.frames[0] enumerates frames in a different order in IE.
		// We need a sure method to locate the frame that contains the online editor.
		for ( var i = 0, n = window.frames.length ; i < n ; i++ ) {
			if ( window.frames[i].location.toString().indexOf(\'InstanceName=content\') != -1 ) {
				EditorFrame = window.frames[i] ;
			}
		}
	}

	if ( !EditorFrame ) {
		return null ;
	}

	var B = new EditorFrame.FCKToolbarButton(\'Templates\', EditorFrame.FCKLang.Templates);
	return B.ClickFrame();
};

function FCKeditor_OnComplete( editorInstance) {
	document.getElementById(\'frmModel\').innerHTML = "<iframe style=\'height: 525px; width: 180px;\' scrolling=\'no\' frameborder=\'0\' src=\''.api_get_path(
    WEB_LIBRARY_PATH
).'fckeditor/editor/fckdialogframe.html \'>";
}
</script>';

$_SESSION['whereami'] = 'document/create';
$this_section = SECTION_COURSES;
$lib_path = api_get_path(LIBRARY_PATH);

require_once api_get_path(SYS_CODE_PATH).'document/document.inc.php';

$course_info = api_get_course_info();
$group_id = api_get_group_id();

if (api_is_in_group()) {
    $group_properties = GroupManager::get_group_properties($group_id);
}

$dir = '/';

if (isset($_GET['id'])) {
    $document_data = DocumentManager::get_document_data_by_id($_GET['id'], api_get_course_id(), true);
    $document_id = $document_data['id'];
    $file = $document_data['path'];
    $parent_id = DocumentManager::get_document_id($course_info, dirname($file));
    $dir = dirname($document_data['path']);
    $dir_original = $dir;

    $doc = basename($file);
    $my_cur_dir_path = Security::remove_XSS($_GET['curdirpath']);
    $readonly = $document_data['readonly'];
}

if (empty($document_data)) {
    api_not_allowed();
}

$is_certificate_mode = DocumentManager::is_certificate_mode($dir);

//Call from
$call_from_tool = Security::remove_XSS($_GET['origin']);
$slide_id = Security::remove_XSS($_GET['origin_opt']);
$file_name = $doc;

$group_document = false;

$current_session_id = api_get_session_id();
$user_id = api_get_user_id();


$doc_tree = explode('/', $file);
$count_dir = count($doc_tree) - 2; // "2" because at the begin and end there are 2 "/"

// Level correction for group documents.
if (!empty($group_properties['directory'])) {
    $count_dir = $count_dir > 0 ? $count_dir - 1 : 0;
}
$relative_url = '';
for ($i = 0; $i < ($count_dir); $i++) {
    $relative_url .= '../';
}

$html_editor_config = array(
    'ToolbarSet' => (api_is_allowed_to_edit(null, true) ? 'Documents' : 'DocumentsStudent'),
    'Width' => '100%',
    'Height' => '600',
    'FullPage' => true,
    'InDocument' => true,
    'CreateDocumentDir' => $relative_url,
    'CreateDocumentWebDir' => (empty($group_properties['directory']))
        ? api_get_path(WEB_COURSE_PATH).$_course['path'].'/document/'
        : api_get_path(WEB_COURSE_PATH).api_get_course_path().'/document'.$group_properties['directory'].'/',
    'BaseHref' => api_get_path(WEB_COURSE_PATH).$_course['path'].'/document'.$dir
);

if ($is_certificate_mode) {
    $html_editor_config['CreateDocumentDir'] = api_get_path(WEB_COURSE_PATH).$_course['path'].'/document/';
    $html_editor_config['CreateDocumentWebDir'] = api_get_path(WEB_COURSE_PATH).$_course['path'].'/document/';
    $html_editor_config['BaseHref'] = api_get_path(WEB_COURSE_PATH).$_course['path'].'/document'.$dir;
}

$is_allowed_to_edit = api_is_allowed_to_edit(null, true) || $_SESSION['group_member_with_upload_rights'] || is_my_shared_folder(api_get_user_id(), $dir, $current_session_id);
$noPHP_SELF = true;

/*	Other initialization code */

$dbTable = Database::get_course_table(TABLE_DOCUMENT);
$course_id = api_get_course_int_id();

if (!empty($group_id)) {
    $req_gid = '&amp;gidReq='.$group_id;
    $interbreadcrumb[] = array('url' => '../group/group_space.php?gidReq='.$group_id, 'name' => get_lang('GroupSpace'));
    $group_document = true;
    $noPHP_SELF = true;
}

if (!$is_certificate_mode) {
    $interbreadcrumb[] = array(
        "url" => "./document.php?curdirpath=".urlencode($my_cur_dir_path).$req_gid,
        "name" => get_lang('Documents')
    );
} else {
    $interbreadcrumb[] = array(
        'url' => '../gradebook/'.$_SESSION['gradebook_dest'],
        'name' => get_lang('Gradebook')
    );
}

// Interbreadcrumb for the current directory root path
if (empty($document_data['parents'])) {
    $interbreadcrumb[] = array('url' => '#', 'name' => $document_data['title']);
} else {
    foreach ($document_data['parents'] as $document_sub_data) {
        if ($document_data['title'] == $document_sub_data['title']) {
            continue;
        }
        $interbreadcrumb[] = array('url' => $document_sub_data['document_url'], 'name' => $document_sub_data['title']);
    }
}

if (!$is_allowed_to_edit) {
    api_not_allowed(true);
}

event_access_tool(TOOL_DOCUMENT);

//TODO:check the below code and his functionality
if (!is_allowed_to_edit()) {
    if (DocumentManager::check_readonly($course_info, $user_id, $file)) {
        api_not_allowed();
    }
}

/* MAIN TOOL CODE */

/*	Code to change the comment	*/

if (isset($_POST['comment'])) {
    // Fixing the path if it is wrong
    $comment = trim(Database::escape_string($_POST['comment']));
    $title = trim(Database::escape_string($_POST['title']));
    //Just in case see BT#3525
    if (empty($title)) {
        $title = $documen_data['title'];
    }
    if (empty($title)) {
        $title = FileManager::get_document_title($_POST['filename']);
    }
    if (!empty($document_id)) {
        $query = "UPDATE $dbTable SET comment='".$comment."', title='".$title."' WHERE c_id = $course_id AND id = ".$document_id;
        Database::query($query);
        $info_message = get_lang('fileModified');
    }
}

/*	WYSIWYG HTML EDITOR - Program Logic */
if ($is_allowed_to_edit) {
    if ($_POST['formSent'] == 1) {

        $filename = stripslashes($_POST['filename']);
        $extension = $_POST['extension'];

        $content = trim(str_replace(array("\r", "\n"), '', stripslashes($_POST['content'])));
        $content = Security::remove_XSS($content, COURSEMANAGERLOWSECURITY);

        if (!strstr($content, '/css/frames.css')) {
            $content = str_replace(
                '</title></head>',
                '</title><link rel="stylesheet" href="../css/frames.css" type="text/css" /></head>',
                $content
            );
        }
        if ($dir == '/') {
            $dir = '';
        }

        $file = $dir.'/'.$filename.'.'.$extension;
        $read_only_flag = $_POST['readonly'];
        $read_only_flag = empty($read_only_flag) ? 0 : 1;

        if (empty($filename)) {
            $msgError = get_lang('NoFileName');
        } else {

            $file_size = filesize($document_data['absolute_path']);

            if ($read_only_flag == 0) {
                if (!empty($content)) {
                    if ($fp = @fopen($document_data['absolute_path'], 'w')) {
                        // For flv player, change absolute path temporarely to prevent from erasing it in the following lines
                        $content = str_replace(array('flv=h', 'flv=/'), array('flv=h|', 'flv=/|'), $content);

                        // Change the path of mp3 to absolute
                        // The first regexp deals with ../../../ urls
                        // Disabled by Ivan Tcholakov.
                        //$content = preg_replace("|(flashvars=\"file=)(\.+/)+|","$1".api_get_path(REL_COURSE_PATH).$_course['path'].'/document/',$content);
                        // The second regexp deals with audio/ urls
                        // Disabled by Ivan Tcholakov.
                        //$content = preg_replace("|(flashvars=\"file=)([^/]+)/|","$1".api_get_path(REL_COURSE_PATH).$_course['path'].'/document/$2/',$content);

                        fputs($fp, $content);
                        fclose($fp);

                        $filepath = $document_data['absolute_parent_path'];

                        if (!is_dir($filepath.'css')) {
                            mkdir($filepath.'css', api_get_permissions_for_new_directories());
                            $doc_id = FileManager::add_document($_course, $dir.'css', 'folder', 0, 'css');
                            api_item_property_update(
                                $_course,
                                TOOL_DOCUMENT,
                                $doc_id,
                                'FolderCreated',
                                api_get_user_id(),
                                null,
                                null,
                                null,
                                null,
                                $current_session_id
                            );
                            api_item_property_update(
                                $_course,
                                TOOL_DOCUMENT,
                                $doc_id,
                                'invisible',
                                api_get_user_id(),
                                null,
                                null,
                                null,
                                null,
                                $current_session_id
                            );
                        }

                        if (!is_file($filepath.'css/frames.css')) {
                            $platform_theme = api_get_setting('stylesheets');
                            if (file_exists(api_get_path(SYS_CODE_PATH).'css/'.$platform_theme.'/frames.css')) {
                                copy(
                                    api_get_path(SYS_CODE_PATH).'css/'.$platform_theme.'/frames.css',
                                    $filepath.'css/frames.css'
                                );
                                $doc_id = FileManager::add_document(
                                    $_course,
                                    $dir.'css/frames.css',
                                    'file',
                                    filesize($filepath.'css/frames.css'),
                                    'frames.css'
                                );
                                api_item_property_update(
                                    $_course,
                                    TOOL_DOCUMENT,
                                    $doc_id,
                                    'DocumentAdded',
                                    api_get_user_id(),
                                    null,
                                    null,
                                    null,
                                    null,
                                    $current_session_id
                                );
                                api_item_property_update(
                                    $_course,
                                    TOOL_DOCUMENT,
                                    $doc_id,
                                    'invisible',
                                    api_get_user_id(),
                                    null,
                                    null,
                                    null,
                                    null,
                                    $current_session_id
                                );
                            }
                        }

                        // "WHAT'S NEW" notification: update table item_property
                        $document_id = DocumentManager::get_document_id($_course, $file);

                        if ($document_id) {
                            FileManager::update_existing_document($_course, $document_id, $file_size, $read_only_flag);
                            api_item_property_update(
                                $_course,
                                TOOL_DOCUMENT,
                                $document_id,
                                'DocumentUpdated',
                                api_get_user_id(),
                                null,
                                null,
                                null,
                                null,
                                $current_session_id
                            );
                            // Update parent folders
                            FileManager::item_property_update_on_folder($_course, $dir, api_get_user_id());
                            header('Location: document.php?id='.$document_data['parent_id']);
                            exit;
                        } else {
                            $msgError = get_lang('Impossible');
                        }
                    } else {
                        $msgError = get_lang('Impossible');
                    }
                } else {
                    if ($document_id) {
                        FileManager::update_existing_document($_course, $document_id, $file_size, $read_only_flag);
                    }
                }
            } else {
                if ($document_id) {
                    FileManager::update_existing_document($_course, $document_id, $file_size, $read_only_flag);
                }
            }
        }
    }
}

// Replace relative paths by absolute web paths (e.g. './' => 'http://www.chamilo.org/courses/ABC/document/')
if (file_exists($document_data['absolute_path'])) {
    $path_info = pathinfo($document_data['absolute_path']);
    $filename = $path_info['filename'];
    $extension = $path_info['extension'];

    if (in_array($extension, array('html', 'htm'))) {
        $content = file($document_data['absolute_path']);
        $content = implode('', $content);
        //$path_to_append = api_get_path(WEB_COURSE_PATH).$_course['path'].'/document'.$dir;
        //	$content = str_replace('="./', '="'.$path_to_append, $content);
        //$content = str_replace('mp3player.swf?son=.%2F', 'mp3player.swf?son='.urlencode($path_to_append), $content);
    }
}

/*	Display user interface */

// Display the header
$nameTools = get_lang('EditDocument').': '.Security::remove_XSS($document_data['title']);
Display::display_header($nameTools, 'Doc');

if (isset($msgError)) {
    Display::display_error_message($msgError);
}

if (isset($info_message)) {
    Display::display_confirmation_message($info_message);
    if (isset($_POST['origin'])) {
        $slide_id = $_POST['origin_opt'];
        $call_from_tool = $_POST['origin'];
    }
}

// Owner
$document_info = api_get_item_property_info(api_get_course_int_id(), 'document', $document_id);
$owner_id = $document_info['insert_user_id'];
$last_edit_date = $document_info['lastedit_date'];

if ($owner_id == api_get_user_id() || api_is_platform_admin(
) || $is_allowed_to_edit || GroupManager :: is_user_in_group(api_get_user_id(), api_get_group_id())
) {
    $action = api_get_self().'?id='.$document_data['id'];
    $form = new FormValidator('formEdit', 'post', $action, null, array('class' => 'form-vertical'));

    // Form title
    $form->addElement('header', $nameTools);
    $form->addElement('hidden', 'filename');
    $form->addElement('hidden', 'extension');
    $form->addElement('hidden', 'file_path');
    $form->addElement('hidden', 'commentPath');
    $form->addElement('hidden', 'showedit');
    $form->addElement('hidden', 'origin');
    $form->addElement('hidden', 'origin_opt');

    $form->add_textfield('title', get_lang('Title'));

    $defaults['title'] = $document_data['title'];

    $form->addElement('hidden', 'formSent');
    $defaults['formSent'] = 1;

    $read_only_flag = $_POST['readonly'];

    // Desactivation of IE proprietary commenting tags inside the text before loading it on the online editor.
    // This fix has been proposed by Hubert Borderiou, see Bug #573, http://support.chamilo.org/issues/573
    $defaults['content'] = str_replace('<!--[', '<!-- [', $content);

    //if ($extension == 'htm' || $extension == 'html')
    // HotPotatoes tests are html files, but they should not be edited in order their functionality to be preserved.
    if (($extension == 'htm' || $extension == 'html') && stripos($dir, '/HotPotatoes_files') === false) {
        if (empty($readonly) && $readonly == 0) {
            $_SESSION['showedit'] = 1;
            $form->add_html_editor('content', '', false, false, $html_editor_config);
            //$renderer->setElementTemplate('<div class="row"><div class="label" id="frmModel" style="overflow: visible;"></div><div class="formw">{element}</div></div>', 'content');
            //$form->add_html_editor('content', '', false, true, $html_editor_config);
        }
    }

    if (!$group_document && !is_my_shared_folder(api_get_user_id(), $my_cur_dir_path, $current_session_id)) {
        $metadata_link = '<a href="../metadata/index.php?eid='.urlencode(
            'Document.'.$document_data['id']
        ).'">'.get_lang('AddMetadata').'</a>';

        //Updated on field
        $last_edit_date = api_get_local_time($last_edit_date);
        $display_date = date_to_str_ago($last_edit_date).' <span class="dropbox_date">'.api_format_date(
            $last_edit_date
        ).'</span>';
        $form->addElement('static', null, get_lang('Metadata'), $metadata_link);
        $form->addElement('static', null, get_lang('UpdatedOn'), $display_date);
    }

    $form->addElement('textarea', 'comment', get_lang('Comment'), 'rows="3" style="width:300px;"');

    if ($owner_id == api_get_user_id() || api_is_platform_admin()) {
        $checked =& $form->addElement('checkbox', 'readonly', null, get_lang('ReadOnly'));
        if ($readonly == 1) {
            $checked->setChecked(true);
        }
    }

    if ($is_certificate_mode) {
        $form->addElement('style_submit_button', 'submit', get_lang('SaveCertificate'), 'class="save"');
    } else {
        $form->addElement('style_submit_button', 'submit', get_lang('SaveDocument'), 'class="save"');
    }

    $defaults['filename'] = $filename;
    $defaults['extension'] = $extension;
    $defaults['file_path'] = Security::remove_XSS($_GET['file']);
    $defaults['commentPath'] = $file;
    $defaults['renameTo'] = $file_name;
    $defaults['comment'] = $document_data['comment'];
    $defaults['origin'] = Security::remove_XSS($_GET['origin']);
    $defaults['origin_opt'] = Security::remove_XSS($_GET['origin_opt']);

    $form->setDefaults($defaults);

    show_return($parent_id, $dir_original, $call_from_tool, $slide_id, $is_certificate_mode);

    if ($is_certificate_mode) {
        $all_information_by_create_certificate = DocumentManager::get_all_info_to_certificate(
            api_get_user_id(),
            api_get_course_id()
        );
        $str_info = '';
        foreach ($all_information_by_create_certificate[0] as $info_value) {
            $str_info .= $info_value.'<br/>';
        }
        $create_certificate = get_lang('CreateCertificateWithTags');
        Display::display_normal_message($create_certificate.': <br /><br />'.$str_info, false);
    }

    if ($extension == 'svg' && !api_browser_support('svg') && api_get_setting('enabled_support_svg') == 'true') {
        Display::display_warning_message(get_lang('BrowserDontSupportsSVG'));
    }
    echo '<div class="row-fluid" style="overflow:hidden">
            <div id="template_col" class="span2" style="width:162px">
                <div id="frmModel" style="overflow: visible;"></div>
            </div>
            <div id="hide_bar_template"></div>
            <div id="doc_form" class="span9">
                    '.$form->return_form().'
            </div>
          </div>';
}

Display::display_footer();


/* General functions */

/*
	Workhorse functions

	These do the actual work that is expected from of this tool, other functions
	are only there to support these ones.
*/

/**
This function changes the name of a certain file.
It needs no global variables, it takes all info from parameters.
It returns nothing.
@todo check if this function is used
 */
function change_name($base_work_dir, $source_file, $rename_to, $dir, $doc)
{

    $file_name_for_change = $base_work_dir.$dir.$source_file;
    //api_display_debug_info("call FileManager::my_rename: params $file_name_for_change, $rename_to");
    $rename_to = FileManager::disable_dangerous_file($rename_to); // Avoid renaming to .htaccess file
    $rename_to = FileManager::my_rename($file_name_for_change, stripslashes($rename_to)); // fileManage API

    if ($rename_to) {
        if (isset($dir) && $dir != '') {
            $source_file = $dir.$source_file;
            $new_full_file_name = dirname($source_file).'/'.$rename_to;
        } else {
            $source_file = '/'.$source_file;
            $new_full_file_name = '/'.$rename_to;
        }

        FileManager::update_db_info('update', $source_file, $new_full_file_name); // fileManage API
        $name_changed = get_lang('ElRen');
        $info_message = get_lang('fileModified');

        $GLOBALS['file_name'] = $rename_to;
        $GLOBALS['doc'] = $rename_to;

        return $info_message;
    } else {
        $dialogBox = get_lang('FileExists'); // TODO: This variable is not used.

        /* Return to step 1 */
        $rename = $source_file;
        unset($source_file);
    }
}

//return button back to
function show_return($document_id, $path, $call_from_tool = '', $slide_id = 0, $is_certificate_mode = false)
{
    global $parent_id;
    $pathurl = urlencode($path);
    echo '<div class="actions">';

    if ($is_certificate_mode) {
        echo '<a href="document.php?curdirpath='.Security::remove_XSS(
            $_GET['curdirpath']
        ).'&selectcat='.Security::remove_XSS($_GET['selectcat']).'">'.Display::return_icon(
            'back.png',
            get_lang('Back').' '.get_lang('To').' '.get_lang('CertificateOverview'),
            '',
            ICON_SIZE_MEDIUM
        ).'</a>';
    } elseif ($call_from_tool == 'slideshow') {
        echo '<a href="'.api_get_path(
            WEB_PATH
        ).'main/document/slideshow.php?slide_id='.$slide_id.'&curdirpath='.Security::remove_XSS(
            urlencode($_GET['curdirpath'])
        ).'">'.Display::return_icon(
            'slideshow.png',
            get_lang('BackTo').' '.get_lang('ViewSlideshow'),
            '',
            ICON_SIZE_MEDIUM
        ).'</a>';
    } elseif ($call_from_tool == 'editdraw') {
        echo '<a href="document.php?action=exit_slideshow&id='.$parent_id.'">'.Display::return_icon(
            'back.png',
            get_lang('BackTo').' '.get_lang('DocumentsOverview'),
            '',
            ICON_SIZE_MEDIUM
        ).'</a>';
        echo '<a href="javascript:history.back(1)">'.Display::return_icon(
            'draw.png',
            get_lang('BackTo').' '.get_lang('Draw'),
            array(),
            32
        ).'</a>';
    } elseif ($call_from_tool == 'editpaint') {
        echo '<a href="document.php?action=exit_slideshow&id='.$parent_id.'">'.Display::return_icon(
            'back.png',
            get_lang('BackTo').' '.get_lang('DocumentsOverview'),
            array(),
            ICON_SIZE_MEDIUM
        ).'</a>';
        echo '<a href="javascript:history.back(1)">'.Display::return_icon(
            'paint.png',
            get_lang('BackTo').' '.get_lang('Paint'),
            array(),
            32
        ).'</a>';
    } else {
        echo '<a href="document.php?action=exit_slideshow&id='.$parent_id.'">'.Display::return_icon(
            'back.png',
            get_lang('BackTo').' '.get_lang('DocumentsOverview'),
            '',
            ICON_SIZE_MEDIUM
        ).'</a>';
    }
    echo '</div>';
}