Source for file document.php
Documentation is available at document.php
<?php // $Id: document.php 15525 2008-06-09 06:24:20Z yannoo $
==============================================================================
Dokeos - elearning and course management software
Copyright (c) 2004-2008 Dokeos SPRL
Copyright (c) 2003 Ghent University (UGent)
Copyright (c) 2001 Universite catholique de Louvain (UCL)
Copyright (c) various contributors
For a full list of contributors, see "credits.txt".
The full license can be read in "license.txt".
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
See the GNU General Public License for more details.
Contact address: Dokeos, rue du Corbeau, 108, B-1030 Brussels, Belgium
==============================================================================
==============================================================================
* Main script for the documents tool
* This script allows the user to manage files and directories on a remote http server.
* The user can : - navigate through files and directories.
* - delete, copy a file or a directory
* - edit properties & content (name, comments, html content)
* The script is organised in four sections.
* 1) Execute the command called by the user
* Note: somme commands of this section are organised in two steps.
* The script always begins with the second step,
* so it allows to return more easily to the first step.
* Note (March 2004) some editing functions (renaming, commenting)
* are moved to a separate page, edit_document.php. This is also
* where xml and other stuff should be added.
* 2) Define the directory to display
* 3) Read files and directories from the directory defined in part 2
* 4) Display all of that on an HTML page
* @todo eliminate code duplication between
* document/document.php, scormdocument.php
* @package dokeos.document
==============================================================================
==============================================================================
==============================================================================
// name of the language file that needs to be included
$language_file[] = 'document';
$language_file[] = 'slideshow';
require ("../inc/global.inc.php");
require ('document.inc.php');
if(isset ($_GET['id_session']))
$_SESSION['id_session'] = $_GET['id_session'];
"<script type=\"text/javascript\">
function confirmation (name)
if (confirm(\" ". get_lang("AreYouSureToDelete") . " \"+ name + \" ?\"))
-----------------------------------------------------------
- some need defining before inclusion of libraries
-----------------------------------------------------------
//what's the current path?
//we will verify this a bit further down
if(isset ($_GET['curdirpath']) && $_GET['curdirpath']!= '')
$curdirpath = $_GET['curdirpath'];
elseif (isset ($_POST['curdirpath']) && $_POST['curdirpath']!= '')
$curdirpath = $_POST['curdirpath'];
$course_dir = $_course['path']. "/document";
$base_work_dir = $sys_course_path. $course_dir;
$http_www = api_get_path('WEB_COURSE_PATH'). $_course['path']. '/document';
$dbl_click_id = 0; // used to avoid double-click
$group_member_with_upload_rights = false;
//if the group id is set, we show them group documents
if(isset ($_SESSION['_gid']) && $_SESSION['_gid']!= '')
//needed for group related stuff
include_once(api_get_path(LIBRARY_PATH) . 'groupmanager.lib.php');
//let's assume the user cannot upload files for the group
$group_member_with_upload_rights = false;
if($group_properties['doc_state']== 2) //documents are private
if($is_allowed_to_edit || GroupManager :: is_user_in_group($_user['user_id'],$_SESSION['_gid'])) //only courseadmin or group members (members + tutors) allowed
$to_group_id = $_SESSION['_gid'];
$req_gid = '&gidReq='. $_SESSION['_gid'];
$interbreadcrumb[]= array ("url"=> "../group/group.php", "name"=> get_lang('Groups'));
$interbreadcrumb[]= array ("url"=> "../group/group_space.php?gidReq=". $_SESSION['_gid'], "name"=> get_lang('GroupSpace'). ' ('. $group_properties['name']. ')');
//they are allowed to upload
$group_member_with_upload_rights = true;
elseif($group_properties['doc_state']== 1) //documents are public
$to_group_id = $_SESSION['_gid'];
$req_gid = '&gidReq='. $_SESSION['_gid'];
$interbreadcrumb[]= array ("url"=> "../group/group_space.php?gidReq=". $_SESSION['_gid'], "name"=> get_lang('GroupSpace'). ' ('. $group_properties['name']. ')');
if($is_allowed_to_edit || GroupManager::is_subscribed($_user['user_id'],$_SESSION['_gid'])) //only courseadmin or group members can upload
$group_member_with_upload_rights = true;
else //documents not active for this group
$_SESSION['group_member_with_upload_rights'] = $group_member_with_upload_rights;
-----------------------------------------------------------
-----------------------------------------------------------
//the main_api.lib.php, database.lib.php and display.lib.php
//libraries are included by default
include_once(api_get_path(LIBRARY_PATH) . 'fileDisplay.lib.php');
include_once(api_get_path(LIBRARY_PATH) . 'events.lib.inc.php');
include_once(api_get_path(LIBRARY_PATH) . 'document.lib.php');
include_once(api_get_path(LIBRARY_PATH) . 'tablesort.lib.php');
include_once(api_get_path(LIBRARY_PATH) . 'fileUpload.lib.php');
//-----------------------------------------------------------
//if the path is not found (no document id), set the path to /
//if they are looking at group documents they can't see the root
if($to_group_id!= 0 && $curdirpath== '/')
$curdirpath = $group_properties['directory'];
$curdirpathurl = urlencode($group_properties['directory']);
//-----------------------------------------------------------
-----------------------------------------------------------
-----------------------------------------------------------
==============================================================================
==============================================================================
//-------------------------------------------------------------------//
if (isset ($_GET['action']) && $_GET['action']== "download")
//check if the document is in the database
header('HTTP/1.0 404 Not Found');
$error404 = '<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">';
$error404 .= '<html><head>';
$error404 .= '<title>404 Not Found</title>';
$error404 .= '</head><body>';
$error404 .= '<h1>Not Found</h1>';
$error404 .= '<p>The requested URL was not found on this server.</p>';
$error404 .= '</body></html>';
$full_file_name = $base_work_dir. $doc_url;
//-------------------------------------------------------------------//
//download of an completed folder
if(isset ($_GET['action']) && $_GET['action']== "downloadfolder")
include('downloadfolder.inc.php');
//-------------------------------------------------------------------//
// slideshow inititalisation
$_SESSION['image_files_only']= '';
-----------------------------------------------------------
-----------------------------------------------------------
$interbreadcrumb[]= array ('url'=> '#', 'name'=> get_lang('Document'));
//------interbreadcrumb for the current directory root path
$dir_array= explode("/",$curdirpath);
$array_len= count($dir_array);
if(empty($_SESSION['_gid']))
$url_dir= 'document.php?&curdirpath=/';
$interbreadcrumb[]= array ('url'=> $url_dir, 'name'=> get_lang('HomeDirectory'));
for ($i= 0; $i< $array_len;$i++ )
$url_dir= 'document.php?&curdirpath='. $dir_acum. $dir_array[$i];
$interbreadcrumb[]= array ('url'=> $url_dir, 'name'=> $dir_array[$i]);
$dir_acum.= $dir_array[$i]. '/';
* Lib for event log, stats & tracking
* plus record of the access
==============================================================================
==============================================================================
if($to_group_id != 0) //add group name after for group documents
$add_group_to_title = ' ('. $group_properties['name']. ')';
//api_display_tool_title($tool_name.$add_group_to_title);
-----------------------------------------------------------
(editable by course admins)
-----------------------------------------------------------
if(!empty($_SESSION['_gid']))
/*============================================================================*/
if($is_allowed_to_edit || $group_member_with_upload_rights) // TEACHER ONLY
/*======================================
======================================*/
if (isset ($_GET['move']) && $_GET['move']!= '')
if (isset ($_POST['move_to']) && isset ($_POST['move_file']))
include_once(api_get_path(LIBRARY_PATH) . 'fileManage.lib.php');
//this is needed for the update_db_info function
//$dbTable = $_course['dbNameGlu']."document";
//security fix: make sure they can't move files that are not in the document table
if ( move($base_work_dir. $_POST['move_file'],$base_work_dir. $_POST['move_to']) )
$curdirpath = $_POST['move_to'];
$curdirpathurl = urlencode($_POST['move_to']);
/*======================================
======================================*/
if ( isset ($_GET['delete']) )
include_once(api_get_path(LIBRARY_PATH) . 'fileManage.lib.php');
if( isset ($_POST['action']))
foreach($_POST['path'] as $index => $path)
/*======================================
======================================*/
//create directory with $_POST data
if(isset ($_POST['create_dir']) && $_POST['dirname']!= '')
//needed for directory creation
include_once(api_get_path(LIBRARY_PATH) . 'fileUpload.lib.php');
$post_dir_name= $_POST['dirname'];
if ($post_dir_name== '../' || $post_dir_name== '.' || $post_dir_name== '..')
$added_slash = ($curdirpath== '/')? '': '/';
$dir_check= $base_work_dir. ''. $dir_name;
$created_dir = create_unexisting_directory($_course,$_user['user_id'],$to_group_id,$to_user_id,$base_work_dir,$dir_name,$post_dir_name);
//uncomment if you want to enter the created dir
//$curdirpath = $created_dir;
//$curdirpathurl = urlencode($curdirpath);
//show them the form for the directory name
if(isset ($_GET['createdir']))
//create the form that asks for the directory name
$new_folder_text = '<form action="'. api_get_self(). '" method="post">';
$new_folder_text .= '<input type="hidden" name="curdirpath" value="'. $curdirpath. '" />';
$new_folder_text .= get_lang('NewDir') . ' ';
$new_folder_text .= '<input type="text" name="dirname" />';
$new_folder_text .= '<input type="submit" name="create_dir" value="'. get_lang('Ok'). '" />';
$new_folder_text .= '</form>';
/*======================================
======================================*/
if ((isset ($_GET['set_invisible']) && !empty($_GET['set_invisible'])) || (isset ($_GET['set_visible']) && !empty($_GET['set_visible'])) AND $_GET['set_visible']<> '*' AND $_GET['set_invisible']<> '*')
//make visible or invisible?
if(isset ($_GET['set_visible']))
$update_id = $_GET['set_visible'];
$visibility_command = 'visible';
$update_id = $_GET['set_invisible'];
$visibility_command = 'invisible';
//update item_property to change visibility
/*======================================
======================================*/
if(isset ($_GET['add_as_template']) && !isset ($_POST['create_template'])){
$document_id_for_template = intval($_GET['add_as_template']);
//create the form that asks for the directory name
$new_folder_text = '<form name="set_document_as_new_template" action="'. api_get_self(). '?add_as_template='. $document_id_for_template. '" method="post">';
$new_folder_text .= '<input type="hidden" name="curdirpath" value="'. $curdirpath. '" />';
$new_folder_text .= '<table><tr><td>';
$new_folder_text .= get_lang('TemplateName'). ' : </td>';
$new_folder_text .= '<td><input type="text" name="template_title" /></td></tr>';
$new_folder_text .= '<tr><td>'. get_lang('TemplateDescription'). ' : </td>';
$new_folder_text .= '<td><textarea name="template_description"></textarea></td></tr></table>';
$new_folder_text .= '<input type="submit" name="create_template" value="'. get_lang('Ok'). '" />';
$new_folder_text .= '</form>';
elseif(isset ($_GET['add_as_template']) && isset ($_POST['create_template']))
if(isset ($_GET['remove_as_template'])){
$document_id_for_template = intval($_GET['remove_as_template']);
} // END is allowed to edit
-----------------------------------------------------------
GET ALL DOCUMENT DATA FOR CURDIRPATH
-----------------------------------------------------------
<div id="folderselector" style="float:left;margin-right:10px;margin-top:5px;">
echo (build_directory_selector($folders,$curdirpath,(isset ($group_properties['directory'])? $group_properties['directory']: array()),true));
echo '<div id="doc_links">';
/* GO TO PARENT DIRECTORY */
if ($curdirpath!= '/'&& $curdirpath!= $group_properties['directory'])
<img src="../img/folder_up.gif" border="0" align="absbottom" hspace="5" alt="" />
if ($is_allowed_to_edit || $group_member_with_upload_rights)
/* CREATE NEW DOCUMENT OR NEW DIRECTORY / GO TO UPLOAD / DOWNLOAD ZIPPED FOLDER */
<!-- create new document or directory -->
<a href="create_document.php? <?php echo api_get_cidreq();?>&dir= <?php echo $curdirpathurl. $req_gid; ?>"><img src="../img/filenew.gif" border="0" alt="" title=" <?php echo get_lang('CreateDoc'); ?>" /></a>
<a href="create_document.php? <?php echo api_get_cidreq();?>&dir= <?php echo $curdirpathurl. $req_gid; ?>"> <?php echo get_lang("CreateDoc"); ?></a>
<!-- file upload link -->
<a href="upload.php? <?php echo api_get_cidreq();?>&path= <?php echo $curdirpathurl. $req_gid; ?>"><img src="../img/submit_file.gif" border="0" title=" <?php echo get_lang('UplUploadDocument'); ?>" alt="" /></a>
<a href="upload.php? <?php echo api_get_cidreq();?>&path= <?php echo $curdirpathurl. $req_gid; ?>"> <?php echo get_lang('UplUploadDocument'); ?></a>
<!-- create directory -->
<a href=" <?php echo api_get_self(); ?>? <?php echo api_get_cidreq();?>&curdirpath= <?php echo $curdirpathurl. $req_gid; ?>&createdir=1"><img src="../img/folder_new.gif" border="0" alt ="" /></a>
<a href=" <?php echo api_get_self(); ?>? <?php echo api_get_cidreq();?>&curdirpath= <?php echo $curdirpathurl. $req_gid; ?>&createdir=1"> <?php echo get_lang("CreateDir"); ?></a>
<!-- download zipped folder -->
<a href=" <?php echo api_get_self(); ?>? <?php echo api_get_cidreq();?>&action=downloadfolder&path= <?php echo $curdirpathurl. $req_gid; ?>"><img src="../img/zip_save.gif" border="0" title=" <?php echo get_lang("Save"); ?> (ZIP)" alt="" /></a>
<a href=" <?php echo api_get_self(); ?>? <?php echo api_get_cidreq();?>&action=downloadfolder&path= <?php echo $curdirpathurl. $req_gid; ?>"> <?php echo get_lang("Save"); ?> (ZIP)</a>
// Slideshow by Patrick Cool, May 2004
include("document_slideshow.inc.php");
echo "<a href=\"slideshow.php?". api_get_cidreq(). "&curdirpath=". $curdirpathurl. "\"><img src=\"../img/images_gallery.gif\" border=\"0\" title=\"". get_lang('ViewSlideshow'). "\"/> ". get_lang('ViewSlideshow') . "</a>";
//==============================================================================
if(isset ($docs_and_folders) && is_array($docs_and_folders))
//print_r($docs_and_folders);
//*************************************************************************************************
//do we need the title field for the document name or not?
//we get the setting here, so we only have to do it once
$use_document_title = get_setting('use_document_title');
//create a sortable table with our data
$sortable_data = array();
while (list ($key, $id) = each($docs_and_folders))
//if the item is invisible, wrap it in a span with class invisible
$invisibility_span_open = ($id['visibility']== 0)? '<span class="invisible">': '';
$invisibility_span_close = ($id['visibility']== 0)? '</span>': '';
//size (or total size of a directory)
$size = $id['filetype']== 'folder' ? get_total_folder_size($id['path'],$is_allowed_to_edit) : $id['size'];
//get the title or the basename depending on what we're using
if ($use_document_title== 'true' AND $id['title']<> '')
$document_name= $id['title'];
if (($is_allowed_to_edit || $group_member_with_upload_rights) AND count($docs_and_folders)> 1)
//document title with hyperlink
$row[] = create_document_link($http_www,$document_name,$id['path'],$id['filetype'],$size,$id['visibility']). '<br />'. $invisibility_span_open. nl2br(htmlspecialchars($id['comment'],ENT_QUOTES,$charset)). $invisibility_span_close;
//comments => display comment under the document name
//$row[] = $invisibility_span_open.nl2br(htmlspecialchars($id['comment'])).$invisibility_span_close;
$row[] = '<span style="display:none;">'. $size. '</span>'. $invisibility_span_open. $display_size. $invisibility_span_close;
$last_edit_date= $id['lastedit_date'];
$display_date = date_to_str_ago($last_edit_date). '<br><span class="dropbox_date">'. $last_edit_date. '</span>';
$row[] = $invisibility_span_open. $display_date. $invisibility_span_close;
//admins get an edit column
if ($is_allowed_to_edit || $group_member_with_upload_rights)
$is_template = (isset ($id['is_template'])? $id['is_template']: false);
// if readonly, check if it the owner of the file or if the user is an admin
$edit_icons = build_edit_icons($curdirpath,$id['filetype'],$id['path'],$id['visibility'],$key, $is_template,0);
$edit_icons = build_edit_icons($curdirpath,$id['filetype'],$id['path'],$id['visibility'],$key, $is_template,$id['readonly']);
//*******************************************************************************************
$table_footer= '<div style="text-align:center;"><strong>'. get_lang('NoDocsInFolder'). '</strong></div>';
if (($is_allowed_to_edit || $group_member_with_upload_rights) AND count($docs_and_folders)> 1)
if ($is_allowed_to_edit || $group_member_with_upload_rights)
$query_vars['curdirpath'] = $curdirpath;
if(isset ($_SESSION['_gid']))
$query_vars['gidReq'] = $_SESSION['_gid'];
$table->set_additional_parameters($query_vars);
if (($is_allowed_to_edit || $group_member_with_upload_rights) AND count($docs_and_folders)> 1)
$table->set_header($column++ ,'',false);
$table->set_header($column++ ,get_lang('Type'));
$table->set_header($column++ ,get_lang('Name'));
//$column_header[] = array(get_lang('Comment'),true); => display comment under the document name
$table->set_header($column++ ,get_lang('Size'));
$table->set_header($column++ ,get_lang('Date'));
//admins get an edit column
if ($is_allowed_to_edit || $group_member_with_upload_rights)
$table->set_header($column++ ,'',false);
//actions on multiple selected documents
//currently only delete action -> take only DELETE right into account
if (count($docs_and_folders)> 1)
if ($is_allowed_to_edit || $group_member_with_upload_rights)
$form_action['delete'] = get_lang('Delete');
$table->set_form_actions($form_action,'path');
if(!empty($table_footer))
==============================================================================
Proposal: perhaps move/add the quota display to another section, e.g. course info
==============================================================================
==============================================================================
==============================================================================
|