';
} else {
$return .= '';
$return .= '';
} else {
if ($resource['filetype'] == 'folder') {
$return .= self::parseFolder($folderId, $resource, $lp_id);
} else {
$return .= self::parseFile(
$course_info,
$session_id,
$resource,
$lp_id,
$add_move_button,
$target,
$overwrite_url
);
}
}
}
}
return $return;
}
/**
* @param int $doc_id
* @param string $course_code
* @param int $session_id
* @param int $user_id
* @param int $groupId
* @return bool
*/
public static function check_visibility_tree(
$doc_id,
$course_code,
$session_id,
$user_id,
$groupId = 0
) {
$document_data = self::get_document_data_by_id($doc_id, $course_code, null, $session_id);
if ($session_id != 0 && !$document_data) {
$document_data = self::get_document_data_by_id($doc_id, $course_code, null, 0);
}
if (!empty($document_data)) {
// If admin or course teacher, allow anyway
if (api_is_platform_admin() || CourseManager::is_course_teacher($user_id, $course_code)) {
return true;
}
$course_info = api_get_course_info($course_code);
if ($document_data['parent_id'] == false || empty($document_data['parent_id'])) {
if (!empty($groupId)) {
return true;
}
$visible = self::is_visible_by_id($doc_id, $course_info, $session_id, $user_id);
return $visible;
} else {
$visible = self::is_visible_by_id($doc_id, $course_info, $session_id, $user_id);
if (!$visible) {
return false;
} else {
return self::check_visibility_tree(
$document_data['parent_id'],
$course_code,
$session_id,
$user_id,
$groupId
);
}
}
} else {
return false;
}
}
/**
* Index a given document.
* @param int Document ID inside its corresponding course
* @param string Course code
* @param int Session ID (not used yet)
* @param string Language of document's content (defaults to course language)
* @param array Array of specific fields (['code'=>'value',...])
* @param string What to do if the file already exists (default or overwrite)
* @param bool When set to true, this runs the indexer without actually saving anything to any database
* @return bool Returns true on presumed success, false on failure
*/
public static function index_document(
$docid,
$course_code,
$session_id = 0,
$lang = 'english',
$specific_fields_values = array(),
$if_exists = '',
$simulation = false
) {
if (api_get_setting('search.search_enabled') !== 'true') {
return false;
}
if (empty($docid) or $docid != intval($docid)) {
return false;
}
if (empty($session_id)) {
$session_id = api_get_session_id();
}
$em = Database::getManager();
$course = $em->getRepository('ChamiloCoreBundle:Course')->findOneBy(['code' => $course_code]);
$course_info = api_get_course_info($course_code);
$course_dir = $course_info['path'] . '/document';
$sys_course_path = api_get_path(SYS_COURSE_PATH);
$base_work_dir = $sys_course_path . $course_dir;
$course_id = $course_info['real_id'];
$table_document = Database::get_course_table(TABLE_DOCUMENT);
$qry = "SELECT path, title FROM $table_document WHERE c_id = {$course->getId()} AND id = '$docid' LIMIT 1";
$result = Database::query($qry);
if (Database::num_rows($result) == 1) {
$row = Database::fetch_array($result);
$doc_path = api_get_path(SYS_COURSE_PATH) . $course_dir . $row['path'];
//TODO: mime_content_type is deprecated, fileinfo php extension is enabled by default as of PHP 5.3.0
// now versions of PHP on Debian testing(5.2.6-5) and Ubuntu(5.2.6-2ubuntu) are lower, so wait for a while
$doc_mime = mime_content_type($doc_path);
$allowed_mime_types = self::file_get_mime_type(true);
// mime_content_type does not detect correctly some formats that are going to be supported for index, so an extensions array is used for the moment
if (empty($doc_mime)) {
$allowed_extensions = array('doc', 'docx', 'ppt', 'pptx', 'pps', 'ppsx', 'xls', 'xlsx', 'odt', 'odp', 'ods', 'pdf', 'txt', 'rtf', 'msg', 'csv', 'html', 'htm');
$extensions = preg_split("/[\/\\.]/", $doc_path);
$doc_ext = strtolower($extensions[count($extensions) - 1]);
if (in_array($doc_ext, $allowed_extensions)) {
switch ($doc_ext) {
case 'ppt':
case 'pps':
$doc_mime = 'application/vnd.ms-powerpoint';
break;
case 'xls':
$doc_mime = 'application/vnd.ms-excel';
break;
}
}
}
//@todo move this nightmare in a search controller or something like that!!! J.M
if (in_array($doc_mime, $allowed_mime_types)) {
$file_title = $row['title'];
$file_content = self::get_text_content($doc_path, $doc_mime);
$course_code = Database::escape_string($course_code);
require_once api_get_path(LIBRARY_PATH) . 'search/ChamiloIndexer.class.php';
require_once api_get_path(LIBRARY_PATH) . 'search/IndexableChunk.class.php';
$ic_slide = new IndexableChunk();
$ic_slide->addValue('title', $file_title);
$ic_slide->addCourseId($course_code);
$ic_slide->addToolId(TOOL_DOCUMENT);
$xapian_data = array(
SE_COURSE_ID => $course_code,
SE_TOOL_ID => TOOL_DOCUMENT,
SE_DATA => array('doc_id' => $docid),
SE_USER => api_get_user_id(),
);
$ic_slide->xapian_data = serialize($xapian_data);
$di = new ChamiloIndexer();
$return = $di->connectDb(null, null, $lang);
require_once api_get_path(LIBRARY_PATH) . 'specific_fields_manager.lib.php';
$specific_fields = get_specific_field_list();
// process different depending on what to do if file exists
/**
* @TODO Find a way to really verify if the file had been
* overwriten. Now all work is done at
* handle_uploaded_document() and it's difficult to verify it
*/
if (!empty($if_exists) && $if_exists == 'overwrite') {
// Overwrite the file on search engine
// Actually, it consists on a delete of terms from db,
// insert new ones, create a new search engine document,
// and remove the old one
// Get search_did
$se_ref = $em->getRepository('ChamiloCoreBundle:SearchEngineRef')
->findOneBy([
'course' => $course,
'toolId' => TOOL_DOCUMEMT,
'refIdHighLevel' => $docid
]);
if ($se_ref) {
if (!$simulation) {
$di->remove_document($se_ref->getSearchDid());
}
$all_specific_terms = '';
foreach ($specific_fields as $specific_field) {
if (!$simulation) {
delete_all_specific_field_value($course_code, $specific_field['id'], TOOL_DOCUMENT, $docid);
}
// Update search engine
if (isset($specific_fields_values[$specific_field['code']])) {
$sterms = trim($specific_fields_values[$specific_field['code']]);
} else { //if the specific field is not defined, force an empty one
$sterms = '';
}
$all_specific_terms .= ' ' . $sterms;
$sterms = explode(',', $sterms);
foreach ($sterms as $sterm) {
$sterm = trim($sterm);
if (!empty($sterm)) {
$ic_slide->addTerm($sterm, $specific_field['code']);
// updated the last param here from $value to $sterm without being sure - see commit15464
if (!$simulation) {
add_specific_field_value($specific_field['id'], $course_code, TOOL_DOCUMENT, $docid, $sterm);
}
}
}
}
// Add terms also to content to make terms findable by probabilistic search
$file_content = $all_specific_terms . ' ' . $file_content;
if (!$simulation) {
$ic_slide->addValue('content', $file_content);
$di->addChunk($ic_slide);
// Index and return a new search engine document id
$did = $di->index();
if ($did) {
// update the search_did on db
$em->createQuery('
UPDATE ChamiloCoreBundle:SearchEngineRef ser
SET ser.searchDid = ?1
WHERE id = ?2
')
->setMaxResults(1)
->execute([1 => $did, 2 => $se_ref->getId()]);
}
}
}
} else {
// Add all terms
$all_specific_terms = '';
foreach ($specific_fields as $specific_field) {
if (isset($specific_fields_values[$specific_field['code']])) {
$sterms = trim($specific_fields_values[$specific_field['code']]);
} else { //if the specific field is not defined, force an empty one
$sterms = '';
}
$all_specific_terms .= ' ' . $sterms;
if (!empty($sterms)) {
$sterms = explode(',', $sterms);
foreach ($sterms as $sterm) {
if (!$simulation) {
$ic_slide->addTerm(trim($sterm), $specific_field['code']);
add_specific_field_value($specific_field['id'], $course_code, TOOL_DOCUMENT, $docid, $sterm);
}
}
}
}
// Add terms also to content to make terms findable by probabilistic search
$file_content = $all_specific_terms . ' ' . $file_content;
if (!$simulation) {
$ic_slide->addValue('content', $file_content);
$di->addChunk($ic_slide);
// Index and return search engine document id
$did = $di->index();
if ($did) {
// Save it to db
$searchEngineRef = new \Chamilo\CoreBundle\Entity\SearchEngineRef();
$searchEngineRef
->setCourse($course)
->setToolId(TOOL_DOCUMENT)
->setRefIdHighLevel($docid)
->setSearchDid($did);
$em->persist($searchEngineRef);
$em->flush();
} else {
return false;
}
}
}
} else {
return false;
}
}
return true;
}
/**
* @return array
*/
public static function get_web_odf_extension_list()
{
return array('ods', 'odt', 'odp');
}
/**
* Set of extension allowed to use Jodconverter
* @param $mode 'from'
* 'to'
* 'all'
* @param $format 'text'
* 'spreadsheet'
* 'presentation'
* 'drawing'
* 'all'
* @return array
*/
public static function getJodconverterExtensionList($mode, $format)
{
$extensionList = array();
$extensionListFromText = array(
'odt',
'sxw',
'rtf',
'doc',
'docx',
'wpd',
'txt',
);
$extensionListToText = array(
'pdf',
'odt',
'sxw',
'rtf',
'doc',
'docx',
'txt',
);
$extensionListFromSpreadsheet = array(
'ods',
'sxc',
'xls',
'xlsx',
'csv',
'tsv',
);
$extensionListToSpreadsheet = array(
'pdf',
'ods',
'sxc',
'xls',
'xlsx',
'csv',
'tsv',
);
$extensionListFromPresentation = array(
'odp',
'sxi',
'ppt',
'pptx',
);
$extensionListToPresentation = array(
'pdf',
'swf',
'odp',
'sxi',
'ppt',
'pptx',
);
$extensionListFromDrawing = array('odg');
$extensionListToDrawing = array('svg', 'swf');
if ($mode === 'from') {
if ($format === 'text') {
$extensionList = array_merge($extensionList, $extensionListFromText);
} elseif ($format === 'spreadsheet') {
$extensionList = array_merge($extensionList, $extensionListFromSpreadsheet);
} elseif ($format === 'presentation') {
$extensionList = array_merge($extensionList, $extensionListFromPresentation);
} elseif ($format === 'drawing') {
$extensionList = array_merge($extensionList, $extensionListFromDrawing);
} elseif ($format === 'all') {
$extensionList = array_merge($extensionList, $extensionListFromText);
$extensionList = array_merge($extensionList, $extensionListFromSpreadsheet);
$extensionList = array_merge($extensionList, $extensionListFromPresentation);
$extensionList = array_merge($extensionList, $extensionListFromDrawing);
}
} elseif ($mode === 'to') {
if ($format === 'text') {
$extensionList = array_merge($extensionList, $extensionListToText);
} elseif ($format === 'spreadsheet') {
$extensionList = array_merge($extensionList, $extensionListToSpreadsheet);
} elseif ($format === 'presentation') {
$extensionList = array_merge($extensionList, $extensionListToPresentation);
} elseif ($format === 'drawing') {
$extensionList = array_merge($extensionList, $extensionListToDrawing);
} elseif ($format === 'all') {
$extensionList = array_merge($extensionList, $extensionListToText);
$extensionList = array_merge($extensionList, $extensionListToSpreadsheet);
$extensionList = array_merge($extensionList, $extensionListToPresentation);
$extensionList = array_merge($extensionList, $extensionListToDrawing);
}
} elseif ($mode === 'all') {
if ($format === 'text') {
$extensionList = array_merge($extensionList, $extensionListFromText);
$extensionList = array_merge($extensionList, $extensionListToText);
} elseif ($format === 'spreadsheet') {
$extensionList = array_merge($extensionList, $extensionListFromSpreadsheet);
$extensionList = array_merge($extensionList, $extensionListToSpreadsheet);
} elseif ($format === 'presentation') {
$extensionList = array_merge($extensionList, $extensionListFromPresentation);
$extensionList = array_merge($extensionList, $extensionListToPresentation);
} elseif ($format === 'drawing') {
$extensionList = array_merge($extensionList, $extensionListFromDrawing);
$extensionList = array_merge($extensionList, $extensionListToDrawing);
} elseif ($format === 'all') {
$extensionList = array_merge($extensionList, $extensionListFromText);
$extensionList = array_merge($extensionList, $extensionListToText);
$extensionList = array_merge($extensionList, $extensionListFromSpreadsheet);
$extensionList = array_merge($extensionList, $extensionListToSpreadsheet);
$extensionList = array_merge($extensionList, $extensionListFromPresentation);
$extensionList = array_merge($extensionList, $extensionListToPresentation);
$extensionList = array_merge($extensionList, $extensionListFromDrawing);
$extensionList = array_merge($extensionList, $extensionListToDrawing);
}
}
return $extensionList;
}
/**
* Get Format type list by extension and mode
* @param string $mode Mode to search format type list
* @example 'from'
* @example 'to'
* @param string $extension file extension to check file type
* @return array
*/
public static function getFormatTypeListConvertor($mode = 'from', $extension)
{
$formatTypesList = array();
$formatTypes = array('text', 'spreadsheet', 'presentation', 'drawing');
foreach ($formatTypes as $formatType) {
if (
in_array(
$extension,
self::getJodconverterExtensionList($mode, $formatType)
)
) {
$formatTypesList[] = $formatType;
}
}
return $formatTypesList;
}
/**
* @param string $path
* @param bool $is_certificate_mode
* @return bool
*/
public static function is_folder_to_avoid($path, $is_certificate_mode = false)
{
$foldersToAvoid = array(
'/HotPotatoes_files',
'/certificates',
);
$systemFolder = api_get_course_setting('show_system_folders');
if ($systemFolder == 1) {
$foldersToAvoid = array();
}
if (basename($path) == 'css') {
return true;
}
if ($is_certificate_mode == false) {
//Certificate results
if (strstr($path, 'certificates')) {
return true;
}
}
// Admin setting for Hide/Show the folders of all users
if (api_get_setting('document.show_users_folders') == 'false') {
$foldersToAvoid[] = '/shared_folder';
if (strstr($path, 'shared_folder_session_')) {
return true;
}
}
// Admin setting for Hide/Show Default folders to all users
if (api_get_setting('document.show_default_folders') == 'false') {
$foldersToAvoid[] = '/images';
$foldersToAvoid[] = '/flash';
$foldersToAvoid[] = '/audio';
$foldersToAvoid[] = '/video';
}
// Admin setting for Hide/Show chat history folder
if (api_get_setting('chat.show_chat_folder') == 'false') {
$foldersToAvoid[] = '/chat_files';
}
if (is_array($foldersToAvoid)) {
return in_array($path, $foldersToAvoid);
} else {
return false;
}
}
/**
* @return array
*/
public static function get_system_folders()
{
return array(
'/certificates',
'/HotPotatoes_files',
'/chat_files',
'/images',
'/flash',
'/audio',
'/video',
'/shared_folder',
'/learning_path'
);
}
/**
* @return array
*/
public static function getProtectedFolderFromStudent()
{
return array(
'/certificates',
'/HotPotatoes_files',
'/chat_files',
'/shared_folder',
'/learning_path'
);
}
/**
* @param string $courseCode
* @return string 'visible' or 'invisible' string
*/
public static function getDocumentDefaultVisibility($courseCode)
{
$settings = api_get_setting(
'document.tool_visible_by_default_at_creation'
);
$defaultVisibility = 'visible';
if (isset($settings['documents'])) {
$portalDefaultVisibility = 'invisible';
if ($settings['documents'] == 'true') {
$portalDefaultVisibility = 'visible';
}
$defaultVisibility = $portalDefaultVisibility;
}
if (api_get_setting(
'document.documents_default_visibility_defined_in_course'
) == 'true'
) {
$courseVisibility = api_get_course_setting('documents_default_visibility', $courseCode);
if (!empty($courseVisibility) && in_array($courseVisibility, array('visible', 'invisible'))) {
$defaultVisibility = $courseVisibility;
}
}
return $defaultVisibility;
}
/**
* @param array $courseInfo
* @param int $id doc id
* @param string $visibility visible/invisible
* @param int $userId
*/
public static function updateVisibilityFromAllSessions($courseInfo, $id, $visibility, $userId)
{
$sessionList = SessionManager::get_session_by_course($courseInfo['real_id']);
if (!empty($sessionList)) {
foreach ($sessionList as $session) {
$sessionId = $session['id'];
api_item_property_update(
$courseInfo,
TOOL_DOCUMENT,
$id,
$visibility,
$userId,
null,
null,
null,
null,
$sessionId
);
}
}
}
/**
* @param string $file
* @return string
*/
public static function readNanogongFile($file)
{
$nanoGongJarFile = api_get_path(WEB_LIBRARY_PATH).'nanogong/nanogong.jar';
$html = '';
return $html;
}
/**
* @param string $filePath
* @param string $path
* @param array $courseInfo
* @param int $sessionId
* @param string $whatIfFileExists overwrite|rename
* @param int $userId
* @param int $groupId
* @param int $toUserId
* @param string $comment
* @return bool|path
*/
public static function addFileToDocumentTool(
$filePath,
$path,
$courseInfo,
$sessionId,
$userId,
$whatIfFileExists = 'overwrite',
$groupId = null,
$toUserId = null,
$comment = null
) {
if (!file_exists($filePath)) {
return false;
}
$fileInfo = pathinfo($filePath);
$file = array(
'name' => $fileInfo['basename'],
'tmp_name' => $filePath,
'size' => filesize($filePath),
'from_file' => true
);
$course_dir = $courseInfo['path'].'/document';
$baseWorkDir = api_get_path(SYS_COURSE_PATH).$course_dir;
$filePath = handle_uploaded_document(
$courseInfo,
$file,
$baseWorkDir,
$path,
$userId,
$groupId,
$toUserId,
false,
$whatIfFileExists,
false,
false,
$comment,
$sessionId
);
if ($filePath) {
return DocumentManager::get_document_id(
$courseInfo,
$filePath,
$sessionId
);
}
return false;
}
/**
* Converts wav to mp3 file.
* Requires the ffmpeg lib. In ubuntu: sudo apt-get install ffmpeg
* @param string $wavFile
* @param bool $removeWavFileIfSuccess
* @return bool
*/
public static function convertWavToMp3($wavFile, $removeWavFileIfSuccess = false)
{
if (file_exists($wavFile)) {
try {
$ffmpeg = \FFMpeg\FFMpeg::create();
$video = $ffmpeg->open($wavFile);
$mp3File = str_replace('wav', 'mp3', $wavFile);
$result = $video->save(new FFMpeg\Format\Audio\Mp3(), $mp3File);
if ($result && $removeWavFileIfSuccess) {
unlink($wavFile);
}
if (file_exists($mp3File)) {
return $mp3File;
}
} catch (Exception $e) {
error_log($e->getMessage());
error_log($e->getPrevious()->getMessage());
}
}
return false;
}
/**
* @param string $documentData wav document information
* @param array $courseInfo
* @param int $sessionId
* @param int $userId user that adds the document
* @param string $whatIfFileExists
* @param bool $deleteWavFile
*
* @return bool
*/
public static function addAndConvertWavToMp3(
$documentData,
$courseInfo,
$sessionId,
$userId,
$whatIfFileExists = 'overwrite',
$deleteWavFile = false
) {
if (empty($documentData)) {
return false;
}
if (isset($documentData['absolute_path']) &&
file_exists($documentData['absolute_path'])
) {
$mp3FilePath = self::convertWavToMp3($documentData['absolute_path']);
if (!empty($mp3FilePath) && file_exists($mp3FilePath)) {
$documentId = self::addFileToDocumentTool(
$mp3FilePath,
dirname($documentData['path']),
$courseInfo,
$sessionId,
$userId,
$whatIfFileExists,
null,
null,
$documentData['comment']
);
if (!empty($documentId)) {
if ($deleteWavFile) {
$coursePath = $courseInfo['directory'].'/document';
$documentPath = api_get_path(SYS_COURSE_PATH).$coursePath;
self::delete_document(
$courseInfo,
null,
$documentPath,
$sessionId,
$documentData['id']
);
}
return $documentId;
}
}
}
return false;
}
/**
* Sets
* @param string $file ($document_data['path'])
* @param string $file_url_sys
* @return string
*/
public static function generateAudioTempFile($file, $file_url_sys)
{
//make temp audio
$temp_folder = api_get_path(SYS_ARCHIVE_PATH).'temp/audio';
if (!file_exists($temp_folder)) {
@mkdir($temp_folder, api_get_permissions_for_new_directories(), true);
}
//make htaccess with allow from all, and file index.html into temp/audio
$htaccess = api_get_path(SYS_ARCHIVE_PATH).'temp/audio/.htaccess';
if (!file_exists($htaccess)) {
$htaccess_content="order deny,allow\r\nallow from all\r\nOptions -Indexes";
$fp = @ fopen(api_get_path(SYS_ARCHIVE_PATH).'temp/audio/.htaccess', 'w');
if ($fp) {
fwrite($fp, $htaccess_content);
fclose($fp);
}
}
//encript temp name file
$name_crip = sha1(uniqid());//encript
$findext= explode(".", $file);
$extension = $findext[count($findext)-1];
$file_crip = $name_crip.'.'.$extension;
//copy file to temp/audio directory
$from_sys = $file_url_sys;
$to_sys = api_get_path(SYS_ARCHIVE_PATH).'temp/audio/'.$file_crip;
if (file_exists($from_sys)) {
copy($from_sys, $to_sys);
}
//get file from tmp directory
Session::write('temp_audio_nanogong', $to_sys);
return api_get_path(WEB_ARCHIVE_PATH).'temp/audio/'.$file_crip;
}
/**
* Erase temp nanogong audio.
*/
public static function removeGeneratedAudioTempFile()
{
$tempAudio = Session::read('temp_audio_nanogong');
if (isset($tempAudio)
&& !empty($tempAudio)
&& is_file($tempAudio)
) {
unlink($tempAudio);
Session::erase('temp_audio_nanogong');
}
}
/**
* Check if the past is used in this course.
* @param array $courseInfo
* @param string $path
*
* @return array
*/
public static function getDocumentByPathInCourse($courseInfo, $path)
{
$table = Database::get_course_table(TABLE_DOCUMENT);
$path = Database::escape_string($path);
$courseId = $courseInfo['real_id'];
if (empty($courseId)) {
return false;
}
$sql = "SELECT * FROM $table WHERE c_id = $courseId AND path = '$path'";
$result = Database::query($sql);
return Database::store_result($result, 'ASSOC');
}
/**
* @param array $_course
* @return int
*/
public static function createDefaultAudioFolder($_course)
{
if (!isset($_course['path'])) {
return false;
}
$audioId = null;
$path = api_get_path(SYS_COURSE_PATH).$_course['path'].'/document/';
if (!is_dir($path.'audio')) {
mkdir($path.'audio', api_get_permissions_for_new_directories());
$audioId = add_document($_course, '/audio', 'folder', 0, 'Audio');
api_item_property_update(
$_course,
TOOL_DOCUMENT,
$audioId,
'FolderCreated',
api_get_user_id(),
null,
null,
null,
null,
api_get_session_id()
);
}
return $audioId;
}
/**
* Generate a default certificate for a courses
*
* @global string $css CSS directory
* @global string $img_dir image directory
* @global string $default_course_dir Course directory
* @global string $js JS directory
* @param array $courseData The course info
* @param bool $fromBaseCourse
* @param int $sessionId
*/
public static function generateDefaultCertificate($courseData, $fromBaseCourse = false, $sessionId = 0)
{
global $css, $img_dir, $default_course_dir, $js;
$codePath = api_get_path(REL_CODE_PATH);
$dir = '/certificates';
$title = get_lang('DefaultCertificate');
$comment = null;
$fileName = api_replace_dangerous_char($title);
$filePath = api_get_path(SYS_COURSE_PATH) . "{$courseData['path']}/document{$dir}";
$fileFullPath = "{$filePath}/{$fileName}.html";
$fileSize = 0;
$fileType = 'file';
$templateContent = file_get_contents(api_get_path(SYS_CODE_PATH).'gradebook/certificate_template/template.html');
$search = array('{CSS}', '{IMG_DIR}', '{REL_CODE_PATH}', '{COURSE_DIR}');
$replace = array($css.$js, $img_dir, $codePath, $default_course_dir);
$fileContent = str_replace($search, $replace, $templateContent);
$saveFilePath = "{$dir}/{$fileName}.html";
if (!is_dir($filePath)) {
mkdir($filePath, api_get_permissions_for_new_directories());
}
if ($fromBaseCourse) {
$defaultCertificateId = self::get_default_certificate_id($courseData['code'], 0);
if (!empty($defaultCertificateId)) {
// We have a certificate from the course base
$documentData = DocumentManager::get_document_data_by_id(
$defaultCertificateId,
$courseData['code'],
false,
0
);
if ($documentData) {
$fileContent = file_get_contents($documentData['absolute_path']);
}
}
}
$defaultCertificateFile = $fp = @fopen($fileFullPath, 'w');
if ($defaultCertificateFile != false) {
@fputs($defaultCertificateFile, $fileContent);
fclose($defaultCertificateFile);
chmod($fileFullPath, api_get_permissions_for_new_files());
$fileSize = filesize($fileFullPath);
}
$documentId = add_document(
$courseData,
$saveFilePath,
$fileType,
$fileSize,
$title,
$comment,
0,//$readonly = 0,
true, //$save_visibility = true,
null, //$group_id = null,
$sessionId
);
api_item_property_update(
$courseData,
TOOL_DOCUMENT,
$documentId,
'DocumentAdded',
api_get_user_id(),
null,
null,
null,
null,
$sessionId
);
$defaultCertificateId = self::get_default_certificate_id(
$courseData['code'],
$sessionId
);
if (!isset($defaultCertificateId)) {
self::attach_gradebook_certificate($courseData['code'], $documentId, $sessionId);
}
}
/**
* Update the document name
* @param int $documentId The document id
* @param string $newName The new name
*/
public static function renameDocument($documentId, $newName)
{
$documentId = intval($documentId);
$newName = Database::escape_string($newName);
$docuentTable = Database::get_course_table(TABLE_DOCUMENT);
$values = array(
'title' => $newName
);
$whereConditions = array(
'id = ?' => $documentId
);
Database::update($docuentTable, $values, $whereConditions);
}
/**
* Get folder/file suffix
*
* @param array $courseInfo
* @param int $sessionId
* @param int $groupId
*
* @return string
*/
public static function getDocumentSuffix($courseInfo, $sessionId, $groupId)
{
// If no session or group, then no suffix.
if (empty($sessionId) && empty($groupId)) {
return '';
}
return '__'.intval($sessionId).'__'.intval($groupId);
}
/**
* Fix a document name adding session id and group id
* Turns picture.jpg -> picture__1__2.jpg
* Where 1 = session id and 2 group id
* Of session id and group id are empty then the function returns:
* picture.jpg -> picture.jpg
*
* @param string $name folder or file name
* @param string $type 'folder' or 'file'
* @param array $courseInfo
* @param int $sessionId
* @param int $groupId
*
* @return string
*/
public static function fixDocumentName($name, $type, $courseInfo, $sessionId, $groupId)
{
$suffix = self::getDocumentSuffix($courseInfo, $sessionId, $groupId);
switch ($type) {
case 'folder':
$name = $name.$suffix;
break;
case 'file':
$name = self::addSuffixToFileName($name, $suffix);
break;
}
return $name;
}
/**
* Add a suffix to a file Example:
* /folder/picture.jpg => to /folder/picture_this.jpg
* where "_this" is the suffix
* @param string $name
* @param string $suffix
* @return string
*/
public static function addSuffixToFileName($name, $suffix)
{
$extension = pathinfo($name, PATHINFO_EXTENSION);
$fileName = pathinfo($name, PATHINFO_FILENAME);
$dir = pathinfo($name, PATHINFO_DIRNAME);
if ($dir == '.') {
$dir = null;
}
if (!empty($dir) && $dir != '/') {
$dir = $dir.'/';
}
$name = $dir.$fileName.$suffix.'.'.$extension;
return $name;
}
/**
* Check if folder exist in the course base or in the session course
* @param string $folder Example: /folder/folder2
* @param array $courseInfo
* @param int $sessionId
* @param int $groupId
*
* @return bool
*/
public static function folderExists(
$folder,
$courseInfo,
$sessionId,
$groupId
) {
$courseId = $courseInfo['real_id'];
if (empty($courseId)) {
return false;
}
$sessionId = intval($sessionId);
$folderWithSuffix = self::fixDocumentName(
$folder,
'folder',
$courseInfo,
$sessionId,
$groupId
);
$folder = Database::escape_string($folder);
$folderWithSuffix = Database::escape_string($folderWithSuffix);
// Check if pathname already exists inside document table
$tbl_document = Database::get_course_table(TABLE_DOCUMENT);
$sql = "SELECT id, path FROM $tbl_document
WHERE
filetype = 'folder' AND
c_id = $courseId AND
(path = '$folder' OR path = '$folderWithSuffix') AND
(session_id = 0 OR session_id = $sessionId)
";
$rs = Database::query($sql);
if (Database::num_rows($rs)) {
return true;
}
return false;
}
/**
* Check if file exist in the course base or in the session course
* @param string $fileName Example: /folder/picture.jpg
* @param array $courseInfo
* @param int $sessionId
* @param int $groupId
*
* @return bool
*/
public static function documentExists(
$fileName,
$courseInfo,
$sessionId,
$groupId
) {
$courseId = $courseInfo['real_id'];
if (empty($courseId)) {
return false;
}
$sessionId = intval($sessionId);
$fileNameEscape = Database::escape_string($fileName);
$fileNameWithSuffix = self::fixDocumentName(
$fileName,
'file',
$courseInfo,
$sessionId,
$groupId
);
$fileNameWithSuffix = Database::escape_string($fileNameWithSuffix);
// Check if pathname already exists inside document table
$table = Database::get_course_table(TABLE_DOCUMENT);
$sql = "SELECT id, path FROM $table
WHERE
filetype = 'file' AND
c_id = $courseId AND
(
path = '".$fileNameEscape."' OR
path = '$fileNameWithSuffix'
) AND
(session_id = 0 OR session_id = $sessionId)
";
$rs = Database::query($sql);
if (Database::num_rows($rs)) {
return true;
}
return false;
}
/**
* Undo the suffix applied to a file example:
* turns picture__1__1.jpg to picture.jpg
* @param string $name
* @param int $courseId
* @param int $sessionId
* @param int $groupId
*
* @return string
*/
public static function undoFixDocumentName(
$name,
$courseId,
$sessionId,
$groupId
) {
if (empty($sessionId) && empty($groupId)) {
return $name;
}
$suffix = self::getDocumentSuffix(
array('real_id' => $courseId),
$sessionId,
$groupId
);
$name = str_replace($suffix, '', $name);
return $name;
}
/**
* @param string $path
* @param string $name
* @param array $courseInfo
* @param int $sessionId
* @param int $groupId
*
* @return string
*/
public static function getUniqueFileName($path, $name, $courseInfo, $sessionId, $groupId)
{
$counter = 1;
$filePath = $path.$name;
$uniqueName = $name;
while ($documentExists = self::documentExists(
$filePath,
$courseInfo,
$sessionId,
$groupId
)) {
$uniqueName = self::addSuffixToFileName($name, '_' . $counter);
$filePath = $path . $uniqueName;
$counter++;
}
return $uniqueName;
}
/**
* Builds the form that enables the user to
* select a directory to browse/upload in
*
* @param array An array containing the folders we want to be able to select
* @param string The current folder (path inside of the "document" directory, including the prefix "/")
* @param string Group directory, if empty, prevents documents to be uploaded (because group documents cannot be uploaded in root)
* @param boolean Whether to change the renderer (this will add a template to the QuickForm object displaying the form)
* @todo this funcionality is really bad : jmontoya
* @return string html form
*/
public static function build_directory_selector(
$folders,
$document_id,
$group_dir = '',
$change_renderer = false,
& $form = null,
$selectName = 'id'
) {
$doc_table = Database::get_course_table(TABLE_DOCUMENT);
$course_id = api_get_course_int_id();
$folder_titles = array();
if (is_array($folders)) {
$escaped_folders = array();
foreach ($folders as $key => & $val) {
$escaped_folders[$key] = Database::escape_string($val);
}
$folder_sql = implode("','", $escaped_folders);
$sql = "SELECT * FROM $doc_table
WHERE filetype = 'folder' AND c_id = $course_id AND path IN ('" . $folder_sql . "')";
$res = Database::query($sql);
$folder_titles = array();
while ($obj = Database::fetch_object($res)) {
$folder_titles[$obj->path] = $obj->title;
}
}
$attributes = [];
if (empty($form)) {
$form = new FormValidator('selector', 'GET', api_get_self() . '?' . api_get_cidreq());
$attributes = array('onchange' => 'javascript: document.selector.submit();');
}
$form->addElement('hidden', 'cidReq', api_get_course_id());
$parent_select = $form->addSelect(
$selectName,
get_lang('CurrentDirectory'),
'',
$attributes
);
if ($change_renderer) {
$renderer = $form->defaultRenderer();
$renderer->setElementTemplate('{label} : {element} ', 'curdirpath');
}
// Group documents cannot be uploaded in the root
if (empty($group_dir)) {
$parent_select->addOption(get_lang('Documents'), '/');
if (is_array($folders)) {
foreach ($folders as $folder_id => & $folder) {
$selected = ($document_id == $folder_id) ? ' selected="selected"' : '';
$path_parts = explode('/', $folder);
$folder_titles[$folder] = cut($folder_titles[$folder], 80);
$counter = count($path_parts) - 2;
if ($counter > 0) {
$label = str_repeat(' ', $counter) . ' — ' . $folder_titles[$folder];
} else {
$label = ' — ' . $folder_titles[$folder];
}
$parent_select->addOption($label, $folder_id);
if ($selected != '') {
$parent_select->setSelected($folder_id);
}
}
}
} else {
if (!empty($folders)) {
foreach ($folders as $folder_id => & $folder) {
$selected = ($document_id == $folder_id) ? ' selected="selected"' : '';
$label = $folder_titles[$folder];
if ($folder == $group_dir) {
$label = get_lang('Documents');
} else {
$path_parts = explode('/', str_replace($group_dir, '', $folder));
$label = cut($label, 80);
$label = str_repeat(' ', count($path_parts) - 2) . ' — ' . $label;
}
$parent_select->addOption($label, $folder_id);
if ($selected != '') {
$parent_select->setSelected($folder_id);
}
}
}
}
$html = $form->toHtml();
return $html;
}
/**
* Create a html hyperlink depending on if it's a folder or a file
*
* @param array $document_data
* @param int $show_as_icon - if it is true, only a clickable icon will be shown
* @param int $visibility (1/0)
* @param int $counter
*
* @return string url
*/
public static function create_document_link(
$document_data,
$show_as_icon = false,
$counter = null,
$visibility
) {
global $dbl_click_id;
$course_info = api_get_course_info();
$www = api_get_path(WEB_COURSE_PATH) . $course_info['path'] . '/document';
$webOdflist = DocumentManager::get_web_odf_extension_list();
// Get the title or the basename depending on what we're using
if ($document_data['title'] != '') {
$title = $document_data['title'];
} else {
$title = basename($document_data['path']);
}
$filetype = $document_data['filetype'];
$size = $filetype == 'folder' ? get_total_folder_size($document_data['path'], api_is_allowed_to_edit(null, true)) : $document_data['size'];
$path = $document_data['path'];
$url_path = urlencode($document_data['path']);
// Add class="invisible" on invisible files
$visibility_class = ($visibility == false) ? ' class="muted"' : '';
$forcedownload_link = null;
$forcedownload_icon = null;
$prevent_multiple_click = null;
if (!$show_as_icon) {
// Build download link (icon)
$forcedownload_link = ($filetype == 'folder') ? api_get_self() . '?' . api_get_cidreq() . '&action=downloadfolder&id=' . $document_data['id'] : api_get_self() . '?' . api_get_cidreq() . '&action=download&id=' . $document_data['id'];
// Folder download or file download?
$forcedownload_icon = ($filetype == 'folder') ? 'save_pack.png' : 'save.png';
// Prevent multiple clicks on zipped folder download
$prevent_multiple_click = ($filetype == 'folder') ? " onclick=\"javascript: if(typeof clic_$dbl_click_id == 'undefined' || !clic_$dbl_click_id) { clic_$dbl_click_id=true; window.setTimeout('clic_" . ($dbl_click_id++) . "=false;',10000); } else { return false; }\"" : '';
}
$target = '_self';
$is_browser_viewable_file = false;
if ($filetype == 'file') {
// Check the extension
$ext = explode('.', $path);
$ext = strtolower($ext[sizeof($ext) - 1]);
// HTML-files an some other types are shown in a frameset by default.
$is_browser_viewable_file = self::is_browser_viewable($ext);
if ($is_browser_viewable_file) {
if ($ext == 'pdf' || in_array($ext, $webOdflist)) {
$url = api_get_self() . '?' . api_get_cidreq() . '&action=download&id=' . $document_data['id'];
} else {
$url = 'showinframes.php?' . api_get_cidreq() . '&id=' . $document_data['id'];
}
} else {
// url-encode for problematic characters (we may not call them dangerous characters...)
$path = str_replace('%2F', '/', $url_path) . '?' . api_get_cidreq();
$url = $www . $path;
}
/*$path = str_replace('%2F', '/', $url_path); //yox view hack otherwise the image can't be well read
$url = $www . $path;*/
} else {
$url = api_get_self() . '?' . api_get_cidreq() . '&id=' . $document_data['id'];
}
// The little download icon
$tooltip_title = $title;
$tooltip_title_alt = $tooltip_title;
if ($path == '/shared_folder') {
$tooltip_title_alt = get_lang('UserFolders');
} elseif (strstr($path, 'shared_folder_session_')) {
$tooltip_title_alt = get_lang('UserFolders') . ' (' . api_get_session_name(api_get_session_id()) . ')';
} elseif (strstr($tooltip_title, 'sf_user_')) {
$userinfo = api_get_user_info(substr($tooltip_title, 8));
$tooltip_title_alt = get_lang('UserFolder') . ' ' . $userinfo['complete_name'];
} elseif ($path == '/chat_files') {
$tooltip_title_alt = get_lang('ChatFiles');
} elseif ($path == '/learning_path') {
$tooltip_title_alt = get_lang('LearningPaths');
} elseif ($path == '/video') {
$tooltip_title_alt = get_lang('Video');
} elseif ($path == '/audio') {
$tooltip_title_alt = get_lang('Audio');
} elseif ($path == '/flash') {
$tooltip_title_alt = get_lang('Flash');
} elseif ($path == '/images') {
$tooltip_title_alt = get_lang('Images');
} elseif ($path == '/images/gallery') {
$tooltip_title_alt = get_lang('DefaultCourseImages');
}
$current_session_id = api_get_session_id();
$copy_to_myfiles = $open_in_new_window_link = null;
$curdirpath = isset($_GET['curdirpath']) ? Security::remove_XSS($_GET['curdirpath']) : null;
$send_to = null;
$checkExtension = $path;
if (!$show_as_icon) {
if ($filetype == 'folder') {
if (api_is_allowed_to_edit() ||
api_is_platform_admin() ||
api_get_setting('document.students_download_folders') == 'true'
) {
//filter when I am into shared folder, I can show for donwload only my shared folder
if (DocumentManager::is_shared_folder($curdirpath, $current_session_id)) {
if (preg_match('/shared_folder\/sf_user_' . api_get_user_id() . '$/', urldecode($forcedownload_link)) ||
preg_match('/shared_folder_session_' . $current_session_id . '\/sf_user_' . api_get_user_id() . '$/', urldecode($forcedownload_link)) ||
api_is_allowed_to_edit() || api_is_platform_admin()
) {
$force_download_html = ($size == 0) ? '' : '' .
Display::return_icon($forcedownload_icon, get_lang('Download'), array(), ICON_SIZE_SMALL) . '';
}
} elseif (!preg_match('/shared_folder/', urldecode($forcedownload_link)) ||
api_is_allowed_to_edit() ||
api_is_platform_admin()
) {
$force_download_html = ($size == 0) ? '' : '' .
Display::return_icon($forcedownload_icon, get_lang('Download'), array(), ICON_SIZE_SMALL) . '';
}
}
} else {
$force_download_html = ($size == 0) ? '' : '' .
Display::return_icon($forcedownload_icon, get_lang('Download'), array(), ICON_SIZE_SMALL) . '';
}
// Copy files to users myfiles
if (api_get_setting('social.allow_social_tool') == 'true' &&
api_get_setting('document.users_copy_files') == 'true' &&
!api_is_anonymous()
) {
$copy_myfiles_link = ($filetype == 'file') ? api_get_self() . '?' . api_get_cidreq() . '&action=copytomyfiles&id=' . $document_data['id'] : api_get_self() . '?' . api_get_cidreq();
if ($filetype == 'file') {
$copy_to_myfiles = '' .
Display::return_icon('briefcase.png', get_lang('CopyToMyFiles'), array(), ICON_SIZE_SMALL) . ' ';
if (api_get_setting('platform.allow_my_files') === 'false') {
$copy_to_myfiles = '';
}
}
if ($filetype == 'file') {
$send_to = Portfolio::share('document', $document_data['id'], array('style' => 'float:right;'));
}
}
$pdf_icon = '';
$extension = pathinfo($path, PATHINFO_EXTENSION);
if (!api_is_allowed_to_edit() &&
api_get_setting('document.students_export2pdf') == 'true' &&
$filetype == 'file' &&
in_array($extension, array('html', 'htm'))
) {
$pdf_icon = ' ' .
Display::return_icon('pdf.png', get_lang('Export2PDF'), array(), ICON_SIZE_SMALL) . ' ';
}
if ($is_browser_viewable_file) {
$open_in_new_window_link = '' .
Display::return_icon('open_in_new_window.png', get_lang('OpenInANewWindow'), array(), ICON_SIZE_SMALL) . ' ';
}
if ($filetype == 'file') {
// Sound preview with jplayer
if (preg_match('/mp3$/i', urldecode($checkExtension)) ||
(preg_match('/wav$/i', urldecode($checkExtension)) && !preg_match('/_chnano_.wav$/i', urldecode($url))) ||
preg_match('/ogg$/i', urldecode($checkExtension))
) {
return '' .
$title .
'' . $force_download_html . $send_to . $copy_to_myfiles . $open_in_new_window_link . $pdf_icon;
} elseif (
// Show preview
preg_match('/swf$/i', urldecode($checkExtension)) ||
preg_match('/png$/i', urldecode($checkExtension)) ||
preg_match('/gif$/i', urldecode($checkExtension)) ||
preg_match('/jpg$/i', urldecode($checkExtension)) ||
preg_match('/jpeg$/i', urldecode($checkExtension)) ||
preg_match('/bmp$/i', urldecode($checkExtension)) ||
preg_match('/svg$/i', urldecode($checkExtension)) ||
(
preg_match('/wav$/i', urldecode($checkExtension)) &&
preg_match('/_chnano_.wav$/i', urldecode($checkExtension)) &&
api_get_setting('document.enable_nanogong') == 'true'
)
) {
// Simpler version of showinframesmin.php with no headers
$url = 'show_content.php?' . api_get_cidreq() . '&id=' . $document_data['id'];
$class = 'ajax';
if ($visibility == false) {
$class = "ajax invisible";
}
return Display::url(
$title,
$url,
[
'class' => $class,
'title' => $tooltip_title_alt,
'data-title' => $title,
'style' => 'float: left;'
]
)
. $force_download_html . $send_to . $copy_to_myfiles
. $open_in_new_window_link . $pdf_icon;
} else {
// For PDF Download the file.
$pdfPreview = null;
if ($ext != 'pdf' && !in_array($ext, $webOdflist)) {
$url = 'showinframes.php?' . api_get_cidreq() . '&id=' . $document_data['id'];
} else {
$pdfPreview = Display::url(
Display::return_icon('preview.gif', get_lang('Preview')),
api_get_path(WEB_CODE_PATH).'document/showinframes.php?' . api_get_cidreq() . '&id=' . $document_data['id'],
array('style' => 'float:right')
);
}
// No plugin just the old and good showinframes.php page
return '' . $title . '' .
$pdfPreview.$force_download_html . $send_to . $copy_to_myfiles . $open_in_new_window_link . $pdf_icon;
}
} else {
return '' . $title . '' .
$force_download_html . $send_to . $copy_to_myfiles . $open_in_new_window_link . $pdf_icon;
}
// end copy files to users myfiles
} else {
// Icon column
if (preg_match('/shared_folder/', urldecode($checkExtension)) &&
preg_match('/shared_folder$/', urldecode($checkExtension)) == false &&
preg_match('/shared_folder_session_' . $current_session_id . '$/', urldecode($url)) == false
) {
if ($filetype == 'file') {
//Sound preview with jplayer
if (preg_match('/mp3$/i', urldecode($checkExtension)) ||
(preg_match('/wav$/i', urldecode($checkExtension)) && !preg_match('/_chnano_.wav$/i', urldecode($url))) ||
preg_match('/ogg$/i', urldecode($checkExtension))) {
$sound_preview = DocumentManager::generate_media_preview($counter);
return $sound_preview;
} elseif (
// Show preview
preg_match('/swf$/i', urldecode($checkExtension)) ||
preg_match('/png$/i', urldecode($checkExtension)) ||
preg_match('/gif$/i', urldecode($checkExtension)) ||
preg_match('/jpg$/i', urldecode($checkExtension)) ||
preg_match('/jpeg$/i', urldecode($checkExtension)) ||
preg_match('/bmp$/i', urldecode($checkExtension)) ||
preg_match('/svg$/i', urldecode($checkExtension)) ||
(
preg_match('/wav$/i', urldecode($checkExtension)) &&
preg_match('/_chnano_.wav$/i', urldecode($checkExtension)) &&
api_get_setting('document.enable_nanogong') == 'true'
)
) {
$url = 'showinframes.php?' . api_get_cidreq() . '&id=' . $document_data['id'];
return '' .
DocumentManager::build_document_icon_tag($filetype, $path) .
Display::return_icon('shared.png', get_lang('ResourceShared'), array()) . '';
} else {
return '' .
DocumentManager::build_document_icon_tag($filetype, $path) .
Display::return_icon('shared.png', get_lang('ResourceShared'), array()) . '';
}
} else {
return '' .
DocumentManager::build_document_icon_tag($filetype, $path) .
Display::return_icon('shared.png', get_lang('ResourceShared'), array()) . '';
}
} else {
if ($filetype == 'file') {
// Sound preview with jplayer
if (preg_match('/mp3$/i', urldecode($checkExtension)) ||
(preg_match('/wav$/i', urldecode($checkExtension)) && !preg_match('/_chnano_.wav$/i', urldecode($url))) ||
preg_match('/ogg$/i', urldecode($checkExtension))) {
$sound_preview = DocumentManager::generate_media_preview($counter);
return $sound_preview;
} elseif (
//Show preview
preg_match('/html$/i', urldecode($checkExtension)) ||
preg_match('/htm$/i', urldecode($checkExtension)) ||
preg_match('/swf$/i', urldecode($checkExtension)) ||
preg_match('/png$/i', urldecode($checkExtension)) ||
preg_match('/gif$/i', urldecode($checkExtension)) ||
preg_match('/jpg$/i', urldecode($checkExtension)) ||
preg_match('/jpeg$/i', urldecode($checkExtension)) ||
preg_match('/bmp$/i', urldecode($checkExtension)) ||
preg_match('/svg$/i', urldecode($checkExtension)) ||
(
preg_match('/wav$/i', urldecode($checkExtension)) &&
preg_match('/_chnano_.wav$/i', urldecode($checkExtension)) &&
api_get_setting('document.enable_nanogong') == 'true'
)
) {
$url = 'showinframes.php?' . api_get_cidreq() . '&id=' . $document_data['id']; //without preview
return '' .
DocumentManager::build_document_icon_tag($filetype, $path) . '';
} else {
return '' .
DocumentManager::build_document_icon_tag($filetype, $path) . '';
}
} else {
return '' .
DocumentManager::build_document_icon_tag($filetype, $path) . '';
}
}
}
}
/**
* Builds an img html tag for the file type
*
* @param string $type (file/folder)
* @param string $path
* @return string img html tag
*/
public static function build_document_icon_tag($type, $path)
{
$basename = basename($path);
$current_session_id = api_get_session_id();
$is_allowed_to_edit = api_is_allowed_to_edit(null, true);
$user_image = false;
if ($type == 'file') {
$icon = choose_image($basename);
if (preg_match('/_chnano_.wav$/i', $basename)) {
$icon = "jplayer_play.png";
$basename = 'wav' . ' ' . '(Nanogong)';
} else {
$basename = substr(strrchr($basename, '.'), 1);
}
} else {
if ($path == '/shared_folder') {
$icon = 'folder_users.gif';
if ($is_allowed_to_edit) {
$basename = get_lang('HelpUsersFolder');
} else {
$basename = get_lang('UserFolders');
}
} elseif (strstr($basename, 'sf_user_')) {
$userinfo = api_get_user_info(substr($basename, 8));
$icon = $userinfo['avatar_small'];
$basename = get_lang('UserFolder') . ' ' . $userinfo['complete_name'];
$user_image = true;
} elseif (strstr($path, 'shared_folder_session_')) {
if ($is_allowed_to_edit) {
$basename = '***(' . api_get_session_name($current_session_id) . ')*** ' . get_lang('HelpUsersFolder');
} else {
$basename = get_lang('UserFolders') . ' (' . api_get_session_name($current_session_id) . ')';
}
$icon = 'folder_users.gif';
} else {
$icon = 'folder_document.gif';
if ($path == '/audio') {
$icon = 'folder_audio.gif';
if (api_is_allowed_to_edit()) {
$basename = get_lang('HelpDefaultDirDocuments');
} else {
$basename = get_lang('Audio');
}
} elseif ($path == '/flash') {
$icon = 'folder_flash.gif';
if (api_is_allowed_to_edit()) {
$basename = get_lang('HelpDefaultDirDocuments');
} else {
$basename = get_lang('Flash');
}
} elseif ($path == '/images') {
$icon = 'folder_images.gif';
if (api_is_allowed_to_edit()) {
$basename = get_lang('HelpDefaultDirDocuments');
} else {
$basename = get_lang('Images');
}
} elseif ($path == '/video') {
$icon = 'folder_video.gif';
if (api_is_allowed_to_edit()) {
$basename = get_lang('HelpDefaultDirDocuments');
} else {
$basename = get_lang('Video');
}
} elseif ($path == '/images/gallery') {
$icon = 'folder_gallery.gif';
if (api_is_allowed_to_edit()) {
$basename = get_lang('HelpDefaultDirDocuments');
} else {
$basename = get_lang('Gallery');
}
} elseif ($path == '/chat_files') {
$icon = 'folder_chat.png';
if (api_is_allowed_to_edit()) {
$basename = get_lang('HelpFolderChat');
} else {
$basename = get_lang('ChatFiles');
}
} elseif ($path == '/learning_path') {
$icon = 'folder_learningpath.gif';
if (api_is_allowed_to_edit()) {
$basename = get_lang('HelpFolderLearningPaths');
} else {
$basename = get_lang('LearningPaths');
}
}
}
}
if ($user_image) {
return Display::img($icon, $basename, array(), false);
}
return Display::return_icon($icon, $basename, array());
}
/**
* Creates the row of edit icons for a file/folder
*
* @param string $curdirpath current path (cfr open folder)
* @param string $type (file/folder)
* @param string $path dbase path of file/folder
* @param int $visibility (1/0)
* @param int $id dbase id of the document
* @return string html img tags with hyperlinks
*/
public static function build_edit_icons($document_data, $id, $is_template, $is_read_only = 0, $visibility)
{
$web_odf_extension_list = DocumentManager::get_web_odf_extension_list();
$document_id = $document_data['id'];
$type = $document_data['filetype'];
$is_read_only = $document_data['readonly'];
$path = $document_data['path'];
$parent_id = DocumentManager::get_document_id(api_get_course_info(), dirname($path));
$curdirpath = dirname($document_data['path']);
$is_certificate_mode = DocumentManager::is_certificate_mode($path);
$curdirpath = urlencode($curdirpath);
$extension = pathinfo($path, PATHINFO_EXTENSION);
//@todo Implement remote support for converter
$usePpt2lp = api_get_setting(
'ppt_to_lp.active'
) == 'true' && api_get_setting('ppt_to_lp.host') == 'localhost';
$formatTypeList = DocumentManager::getFormatTypeListConvertor('from', $extension);
$formatType = current($formatTypeList);
// Build URL-parameters for table-sorting
$sort_params = array();
if (isset($_GET['column'])) {
$sort_params[] = 'column=' . Security::remove_XSS($_GET['column']);
}
if (isset($_GET['page_nr'])) {
$sort_params[] = 'page_nr=' . Security::remove_XSS($_GET['page_nr']);
}
if (isset($_GET['per_page'])) {
$sort_params[] = 'per_page=' . Security::remove_XSS($_GET['per_page']);
}
if (isset($_GET['direction'])) {
$sort_params[] = 'direction=' . Security::remove_XSS($_GET['direction']);
}
$sort_params = implode('&', $sort_params);
$visibility_icon = ($visibility == 0) ? 'invisible' : 'visible';
$visibility_command = ($visibility == 0) ? 'set_visible' : 'set_invisible';
$modify_icons = '';
// If document is read only *or* we're in a session and the document
// is from a non-session context, hide the edition capabilities
if ($is_read_only /* or ($session_id!=api_get_session_id()) */) {
if (api_is_course_admin() || api_is_platform_admin()) {
if ($extension == 'svg' && api_browser_support(
'svg'
) && api_get_setting('editor.enabled_support_svg') == 'true'
) {
$modify_icons = '' .
Display::return_icon('edit.png', get_lang('Modify'), '', ICON_SIZE_SMALL) . '';
} elseif (in_array($extension, $web_odf_extension_list) && api_get_setting('enabled_support_odf') === true) {
$modify_icons = '' .
Display::return_icon('edit.png', get_lang('Modify'), '', ICON_SIZE_SMALL) . '';
} elseif ($extension == 'png' || $extension == 'jpg' || $extension == 'jpeg' || $extension == 'bmp' || $extension == 'gif' || $extension == 'pxd' && api_get_setting(
'editor.enabled_support_pixlr'
) == 'true'
) {
$modify_icons = '' .
Display::return_icon('edit.png', get_lang('Modify'), '', ICON_SIZE_SMALL) . '';
} else {
$modify_icons = '' .
Display::return_icon('edit.png', get_lang('Modify'), '', ICON_SIZE_SMALL) . '';
}
} else {
$modify_icons = Display::return_icon('edit_na.png', get_lang('Modify'), '', ICON_SIZE_SMALL);
}
$modify_icons .= ' ' . Display::return_icon('move_na.png', get_lang('Move'), array(), ICON_SIZE_SMALL);
if (api_is_allowed_to_edit() || api_is_platform_admin()) {
$modify_icons .= ' ' . Display::return_icon($visibility_icon . '.png', get_lang('VisibilityCannotBeChanged'), '', ICON_SIZE_SMALL);
}
$modify_icons .= ' ' . Display::return_icon('delete_na.png', get_lang('Delete'), array(), ICON_SIZE_SMALL);
} else {
//Edit button
if (in_array($path, DocumentManager::get_system_folders())) {
$modify_icons = Display::return_icon('edit_na.png', get_lang('Modify'), '', ICON_SIZE_SMALL);
} elseif ($is_certificate_mode ) {
// gradebook category doesn't seem to be taken into account
$modify_icons = '' . Display::return_icon('edit.png', get_lang('Modify'), '', ICON_SIZE_SMALL) . '';
} else {
if (api_get_session_id()) {
if ($document_data['session_id'] == api_get_session_id()) {
if ($extension == 'svg' && api_browser_support(
'svg'
) && api_get_setting(
'editor.enabled_support_svg'
) == 'true'
) {
$modify_icons = '' .
Display::return_icon('edit.png', get_lang('Modify'), '', ICON_SIZE_SMALL) . '';
} elseif (in_array($extension, $web_odf_extension_list) && api_get_setting('enabled_support_odf') === true) {
$modify_icons = '' .
Display::return_icon('edit.png', get_lang('Modify'), '', ICON_SIZE_SMALL) . '';
} elseif ($extension == 'png' || $extension == 'jpg' || $extension == 'jpeg' || $extension == 'bmp' || $extension == 'gif' || $extension == 'pxd' && api_get_setting(
'editor.enabled_support_pixlr'
) == 'true'
) {
$modify_icons = '' .
Display::return_icon('edit.png', get_lang('Modify'), '', ICON_SIZE_SMALL) . '';
} else {
$modify_icons = '' .
Display::return_icon('edit.png', get_lang('Modify'), '', ICON_SIZE_SMALL) . '';
}
} else {
$modify_icons .= ' ' . Display::return_icon('edit_na.png', get_lang('Edit'), array(), ICON_SIZE_SMALL) . '';
}
} else {
if ($extension == 'svg' && api_browser_support(
'svg'
) && api_get_setting(
'editor.enabled_support_svg'
) == 'true'
) {
$modify_icons = '' .
Display::return_icon('edit.png', get_lang('Modify'), '', ICON_SIZE_SMALL) . '';
} elseif (in_array($extension, $web_odf_extension_list) && api_get_setting('enabled_support_odf') === true) {
$modify_icons = '' .
Display::return_icon('edit.png', get_lang('Modify'), '', ICON_SIZE_SMALL) . '';
} elseif ($extension == 'png' || $extension == 'jpg' || $extension == 'jpeg' || $extension == 'bmp' || $extension == 'gif' || $extension == 'pxd' && api_get_setting(
'editor.enabled_support_pixlr'
) == 'true'
) {
$modify_icons = '' .
Display::return_icon('edit.png', get_lang('Modify'), '', ICON_SIZE_SMALL) . '';
} else {
$modify_icons = '' .
Display::return_icon('edit.png', get_lang('Modify'), '', ICON_SIZE_SMALL) . '';
}
}
}
// Move button.
if ($is_certificate_mode || in_array($path, DocumentManager::get_system_folders())) {
$modify_icons .= ' ' . Display::return_icon('move_na.png', get_lang('Move'), array(), ICON_SIZE_SMALL) . '';
} else {
if (api_get_session_id()) {
if ($document_data['session_id'] == api_get_session_id()) {
$modify_icons .= ' ' .
Display::return_icon('move.png', get_lang('Move'), array(), ICON_SIZE_SMALL) . '';
} else {
$modify_icons .= ' ' . Display::return_icon('move_na.png', get_lang('Move'), array(), ICON_SIZE_SMALL) . '';
}
} else {
$modify_icons .= ' ' .
Display::return_icon('move.png', get_lang('Move'), array(), ICON_SIZE_SMALL) . '';
}
}
//Visibility button
if ($is_certificate_mode) {
$modify_icons .= ' ' . Display::return_icon($visibility_icon . '.png', get_lang('VisibilityCannotBeChanged'), array(), ICON_SIZE_SMALL) . '';
} else {
if (api_is_allowed_to_edit() || api_is_platform_admin()) {
if ($visibility_icon == 'invisible') {
$tip_visibility = get_lang('Show');
} else {
$tip_visibility = get_lang('Hide');
}
$modify_icons .= ' ' .
Display::return_icon($visibility_icon . '.png', $tip_visibility, '', ICON_SIZE_SMALL) . '';
}
}
// Delete button
if (in_array($path, DocumentManager::get_system_folders())) {
$modify_icons .= ' ' . Display::return_icon('delete_na.png', get_lang('ThisFolderCannotBeDeleted'), array(), ICON_SIZE_SMALL);
} else {
$titleToShow = addslashes(basename($document_data['title']));
if (isset($_GET['curdirpath']) &&
$_GET['curdirpath'] == '/certificates' &&
DocumentManager::get_default_certificate_id(api_get_course_id()) == $id
) {
$modify_icons .= ' ' .
Display::return_icon('delete.png', get_lang('Delete'), array(), ICON_SIZE_SMALL) . '';
} else {
if ($is_certificate_mode) {
$modify_icons .= ' ' .
Display::return_icon('delete.png', get_lang('Delete'), array(), ICON_SIZE_SMALL) . '';
} else {
if (api_get_session_id()) {
if ($document_data['session_id'] == api_get_session_id()) {
$modify_icons .= ' '.
Display::return_icon('delete.png', get_lang('Delete'), array(), ICON_SIZE_SMALL) . '';
} else {
$modify_icons .= ' ' . Display::return_icon('delete_na.png', get_lang('ThisFolderCannotBeDeleted'), array(), ICON_SIZE_SMALL);
}
} else {
$modify_icons .= ' ' .
Display::return_icon('delete.png', get_lang('Delete'), array(), ICON_SIZE_SMALL) . '';
}
}
}
}
// Add action to covert to PDF, will create a new document whit same filename but .pdf extension
// @TODO: add prompt to select a format target
if (in_array($path, DocumentManager::get_system_folders())) {
// nothing to do
} else {
if ($usePpt2lp && $formatType) {
$modify_icons .= ' ' .
Display::return_icon(
'convert.png',
get_lang('Convert'),
array(),
ICON_SIZE_SMALL
) . '';
}
}
}
if ($type == 'file' && ($extension == 'html' || $extension == 'htm')) {
if ($is_template == 0) {
if ((isset($_GET['curdirpath']) && $_GET['curdirpath'] != '/certificates') || !isset($_GET['curdirpath'])) {
$modify_icons .= ' ' .
Display::return_icon('wizard.png', get_lang('AddAsTemplate'), array(), ICON_SIZE_SMALL) . '';
}
if (isset($_GET['curdirpath']) && $_GET['curdirpath'] == '/certificates') {//allow attach certificate to course
$visibility_icon_certificate = 'nocertificate';
if (DocumentManager::get_default_certificate_id(api_get_course_id()) == $id) {
$visibility_icon_certificate = 'certificate';
$certificate = get_lang('DefaultCertificate');
$preview = get_lang('PreviewCertificate');
$is_preview = true;
} else {
$is_preview = false;
$certificate = get_lang('NoDefaultCertificate');
}
if (isset($_GET['selectcat'])) {
$modify_icons .= ' ';
$modify_icons .= Display::return_icon($visibility_icon_certificate.'.png', $certificate);
$modify_icons .= '';
if ($is_preview) {
$modify_icons .= ' ' .
Display::return_icon('preview_view.png', $preview, '', ICON_SIZE_SMALL) . '';
}
}
}
} else {
$modify_icons .= ' ' .
Display::return_icon('wizard_na.png', get_lang('RemoveAsTemplate'), '', ICON_SIZE_SMALL) . '';
}
$modify_icons .= ' ' .
Display::return_icon('pdf.png', get_lang('Export2PDF'), array(), ICON_SIZE_SMALL) . '';
}
return $modify_icons;
}
/**
* @param $folders
* @param $curdirpath
* @param $move_file
* @param string $group_dir
* @param $form
*
* @return string
*/
public static function build_move_to_selector($folders, $curdirpath, $move_file, $group_dir = '')
{
$form = new FormValidator('move_to', 'post', api_get_self().'?'.api_get_cidreq());
// Form title
$form->addElement('hidden', 'move_file', $move_file);
$options = array();
// Group documents cannot be uploaded in the root
if ($group_dir == '') {
if ($curdirpath != '/') {
$options['/'] = get_lang('Documents');
}
if (is_array($folders)) {
foreach ($folders as & $folder) {
// Hide some folders
if ($folder == '/HotPotatoes_files' ||
$folder == '/certificates' ||
basename($folder) == 'css'
) {
continue;
}
// Admin setting for Hide/Show the folders of all users
if (api_get_setting(
'document.show_users_folders'
) == 'false' &&
(strstr($folder, '/shared_folder') || strstr($folder, 'shared_folder_session_'))
) {
continue;
}
// Admin setting for Hide/Show Default folders to all users
if (api_get_setting(
'document.show_default_folders'
) == 'false' &&
(
$folder == '/images' ||
$folder == '/flash' ||
$folder == '/audio' ||
$folder == '/video' ||
strstr($folder, '/images/gallery') ||
$folder == '/video/flv'
)
) {
continue;
}
// Admin setting for Hide/Show chat history folder
if (api_get_setting('chat.show_chat_folder') == 'false' &&
$folder == '/chat_files') {
continue;
}
// You cannot move a file to:
// 1. current directory
// 2. inside the folder you want to move
// 3. inside a subfolder of the folder you want to move
if (($curdirpath != $folder) &&
($folder != $move_file) &&
(substr($folder, 0, strlen($move_file) + 1) != $move_file . '/')
) {
$path_displayed = $folder;
// If document title is used, we have to display titles instead of real paths...
$path_displayed = DocumentManager::get_titles_of_path($folder);
if (empty($path_displayed)) {
$path_displayed = get_lang('Untitled');
}
$options[$folder] = $path_displayed;
}
}
}
} else {
foreach ($folders as $folder) {
if (($curdirpath != $folder) &&
($folder != $move_file) &&
(substr($folder, 0, strlen($move_file) + 1) != $move_file . '/')
) {
// Cannot copy dir into his own subdir
$path_displayed = DocumentManager::get_titles_of_path($folder);
$display_folder = substr($path_displayed, strlen($group_dir));
$display_folder = ($display_folder == '') ? get_lang('Documents') : $display_folder;
//$form .= '';
$options[$folder] = $display_folder;
}
}
}
$form->addElement('select', 'move_to', get_lang('MoveTo'), $options);
$form->addButtonNext(get_lang('MoveElement'), 'move_file_submit');
return $form->returnForm();
}
/**
* Gets the path translated with title of docs and folders
* @param string $path the real path
* @return the path which should be displayed
*/
public static function get_titles_of_path($path)
{
global $tmp_folders_titles;
$course_id = api_get_course_int_id();
$nb_slashes = substr_count($path, '/');
$current_slash_pos = 0;
$path_displayed = '';
for ($i = 0; $i < $nb_slashes; $i++) {
// For each folder of the path, retrieve title.
$current_slash_pos = strpos($path, '/', $current_slash_pos + 1);
$tmp_path = substr($path, strpos($path, '/', 0), $current_slash_pos);
if (empty($tmp_path)) {
// If empty, then we are in the final part of the path
$tmp_path = $path;
}
if (!empty($tmp_folders_titles[$tmp_path])) {
// If this path has soon been stored here we don't need a new query
$path_displayed .= $tmp_folders_titles[$tmp_path];
} else {
$sql = 'SELECT title FROM ' . Database::get_course_table(TABLE_DOCUMENT) . '
WHERE c_id = ' . $course_id . ' AND path LIKE BINARY "' . $tmp_path . '"';
$rs = Database::query($sql);
$tmp_title = '/' . Database::result($rs, 0, 0);
$path_displayed .= $tmp_title;
$tmp_folders_titles[$tmp_path] = $tmp_title;
}
}
return $path_displayed;
}
/**
* Creates form that asks for the directory name.
* @return string html-output text for the form
*/
public static function create_dir_form($dirId)
{
global $document_id;
$form = new FormValidator('create_dir_form', 'post', api_get_self().'?'.api_get_cidreq());
$form->addElement('hidden', 'create_dir', 1);
$form->addElement('hidden', 'dir_id', intval($document_id));
$form->addElement('hidden', 'id', intval($dirId));
$form->addElement('header', get_lang('CreateDir'));
$form->addText('dirname', get_lang('NewDir'), array('autofocus' => 'autofocus'));
$form->addButtonCreate(get_lang('CreateFolder'));
return $form->returnForm();
}
/**
* Checks whether the user is in shared folder
* @return return bool Return true when user is into shared folder
*/
public static function is_shared_folder($curdirpath, $current_session_id)
{
$clean_curdirpath = Security::remove_XSS($curdirpath);
if ($clean_curdirpath == '/shared_folder') {
return true;
} elseif ($clean_curdirpath == '/shared_folder_session_' . $current_session_id) {
return true;
} else {
return false;
}
}
/**
* Checks whether the user is into any user shared folder
* @return return bool Return true when user is in any user shared folder
*/
public static function is_any_user_shared_folder($path, $current_session_id)
{
$clean_path = Security::remove_XSS($path);
if (strpos($clean_path, 'shared_folder/sf_user_')) {
return true;
} elseif (strpos($clean_path, 'shared_folder_session_' . $current_session_id . '/sf_user_')) {
return true;
} else {
return false;
}
}
/**
* Checks whether the user is into his shared folder or into a subfolder
* @return bool Return true when user is in his user shared folder or into a subfolder
*/
public static function is_my_shared_folder($user_id, $path, $current_session_id)
{
$clean_path = Security::remove_XSS($path) . '/';
//for security does not remove the last slash
$main_user_shared_folder = '/shared_folder\/sf_user_' . $user_id . '\//';
//for security does not remove the last slash
$main_user_shared_folder_session = '/shared_folder_session_' . $current_session_id . '\/sf_user_' . $user_id . '\//';
if (preg_match($main_user_shared_folder, $clean_path)) {
return true;
} elseif (preg_match($main_user_shared_folder_session, $clean_path)) {
return true;
} else {
return false;
}
}
/**
* Check if the file name or folder searched exist
* @return bool Return true when exist
*/
public static function search_keyword($document_name, $keyword)
{
if (api_strripos($document_name, $keyword) !== false) {
return true;
} else {
return false;
}
}
/**
* Checks whether a document can be previewed by using the browser.
* @param string $file_extension The filename extension of the document (it must be in lower case).
* @return bool Returns TRUE or FALSE.
*/
public static function is_browser_viewable($file_extension)
{
static $allowed_extensions = array(
'htm', 'html', 'xhtml',
'gif', 'jpg', 'jpeg', 'png', 'tif', 'tiff',
'pdf', 'svg', 'swf',
'txt', 'log',
'mp4', 'ogg', 'ogv', 'ogx', 'mpg', 'mpeg', 'mov', 'avi', 'webm', 'wmv',
'mp3', 'oga', 'wav', 'au', 'wma', 'mid', 'kar'
);
/*
//TODO: make a admin swich to strict mode
1. global default $allowed_extensions only: 'htm', 'html', 'xhtml', 'gif', 'jpg', 'jpeg', 'png', 'bmp', 'txt', 'log'
if (in_array($file_extension, $allowed_extensions)) { // Assignment + a logical check.
return true;
}
2. check native support
3. check plugins: quicktime, mediaplayer, vlc, acrobat, flash, java
*/
if (!($result = in_array($file_extension, $allowed_extensions))) { // Assignment + a logical check.
return false;
}
//check native support (Explorer, Opera, Firefox, Chrome, Safari)
if ($file_extension == "pdf") {
return api_browser_support('pdf');
} elseif ($file_extension == "mp3") {
return api_browser_support('mp3');
} elseif ($file_extension == "mp4") {
return api_browser_support('mp4');
} elseif ($file_extension == "ogg" || $file_extension == "ogx" || $file_extension == "ogv" || $file_extension == "oga") {
return api_browser_support('ogg');
} elseif ($file_extension == "svg") {
return api_browser_support('svg');
} elseif ($file_extension == "mpg" || $file_extension == "mpeg") {
return api_browser_support('mpg');
} elseif ($file_extension == "mov") {
return api_browser_support('mov');
} elseif ($file_extension == "wav") {
return api_browser_support('wav');
} elseif ($file_extension == "mid" || $file_extension == "kar") {
return api_browser_support('mid');
} elseif ($file_extension == "avi") {
return api_browser_support('avi');
} elseif ($file_extension == "wma") {
return api_browser_support('wma');
} elseif ($file_extension == "wmv") {
return api_browser_support('wmv');
} elseif ($file_extension == "tif" || $file_extension == "tiff") {
return api_browser_support('tif');
} elseif ($file_extension == "mov") {
return api_browser_support('mov');
} elseif ($file_extension == "au") {
return api_browser_support('au');
} elseif ($file_extension == "webm") {
return api_browser_support('webm');
}
return $result;
}
/**
* @param array $courseInfo
* @param int $sessionId
*
* @return array
*/
public static function getDeletedDocuments($courseInfo, $sessionId = 0)
{
$table = Database::get_course_table(TABLE_DOCUMENT);
$courseId = $courseInfo['real_id'];
$sessionCondition = api_get_session_condition($sessionId);
$sql = "SELECT * FROM $table
WHERE
path LIKE '%DELETED%' AND
c_id = $courseId
$sessionCondition
ORDER BY path
";
$result = Database::query($sql);
$files = array();
while ($document = Database::fetch_array($result, 'ASSOC')) {
$files[] = $document;
}
return $files;
}
/**
* @param int $id
* @param array $courseInfo
* @param int $sessionId
*
* @return array
*/
public static function getDeletedDocument($id, $courseInfo, $sessionId = 0)
{
if (empty($courseInfo)) {
return false;
}
$table = Database::get_course_table(TABLE_DOCUMENT);
$courseId = $courseInfo['real_id'];
$sessionCondition = api_get_session_condition($sessionId);
$sql = "SELECT * FROM $table
WHERE
path LIKE '%DELETED%' AND
id = $id AND
c_id = $courseId
$sessionCondition
LIMIT 1
";
$result = Database::query($sql);
if (Database::num_rows($result)) {
$result = Database::fetch_array($result, 'ASSOC');
return $result;
}
return array();
}
/**
* @param int $id
* @param array $courseInfo
* @param int $sessionId
* @return bool
*/
public static function purgeDocument($id, $courseInfo, $sessionId = 0)
{
$document = self::getDeletedDocument($id, $courseInfo, $sessionId);
if (!empty($document)) {
$path = $document['path'];
$coursePath = api_get_path(SYS_COURSE_PATH).$courseInfo['path'].'/document/';
my_delete($coursePath.$path);
// Hard delete.
self::deleteDocumentFromDb($id, $courseInfo, $sessionId, true);
return true;
}
return false;
}
/**
* @param array $courseInfo
* @param int $sessionId
*/
public static function purgeDocuments($courseInfo, $sessionId)
{
$files = self::getDeletedDocuments($courseInfo, $sessionId);
foreach ($files as $file) {
self::purgeDocument($file['id'], $courseInfo, $sessionId);
}
}
/**
* @param int $id
* @param array $courseInfo
* @param int $sessionId
* @return bool
*/
public static function downloadDeletedDocument($id, $courseInfo, $sessionId)
{
$document = self::getDeletedDocument($id, $courseInfo, $sessionId);
if (!empty($document)) {
$coursePath = api_get_path(SYS_COURSE_PATH).$courseInfo['path'].'/document/';
if (Security::check_abs_path($coursePath.$document['path'], $coursePath)) {
self::file_send_for_download($coursePath.$document['path']);
exit;
}
}
}
/**
* @param array $courseInfo
* @param int $sessionId
*
* @return bool
*/
public static function downloadAllDeletedDocument($courseInfo, $sessionId)
{
// Zip library for creation of the zip file.
require api_get_path(LIBRARY_PATH).'pclzip/pclzip.lib.php';
$files = self::getDeletedDocuments($courseInfo, $sessionId);
if (empty($files)) {
return false;
}
$coursePath = api_get_path(SYS_COURSE_PATH).$courseInfo['path'].'/document';
// Creating a ZIP file.
$tempZipFile = api_get_path(SYS_ARCHIVE_PATH).api_get_unique_id().".zip";
$zip = new PclZip($tempZipFile);
foreach ($files as $file) {
$zip->add(
$coursePath.$file['path'],
PCLZIP_OPT_REMOVE_PATH,
$coursePath
);
}
if (Security::check_abs_path($tempZipFile, api_get_path(SYS_ARCHIVE_PATH))) {
DocumentManager::file_send_for_download($tempZipFile, true);
@unlink($tempZipFile);
exit;
}
}
/**
*
* Delete documents from a session in a course.
* @param array $courseInfo
* @param int $sessionId
*
* @return bool
*/
public function deleteDocumentsFromSession($courseInfo, $sessionId)
{
if (empty($courseInfo)) {
return false;
}
if (empty($sessionId)) {
return false;
}
$itemPropertyTable = Database::get_course_table(TABLE_ITEM_PROPERTY);
$documentTable = Database::get_course_table(TABLE_DOCUMENT);
$conditionSession = api_get_session_condition($sessionId, true, false, 'd.session_id');
$courseId = $courseInfo['real_id'];
//get invisible folders
$sql = "SELECT DISTINCT d.id, path
FROM $itemPropertyTable i
INNER JOIN $documentTable d
ON (i.c_id = d.c_id)
WHERE
d.id = i.ref AND
i.tool = '" . TOOL_DOCUMENT . "'
$conditionSession AND
i.c_id = $courseId AND
d.c_id = $courseId ";
$result = Database::query($sql);
$documents = Database::store_result($result, 'ASSOC');
if ($documents) {
$course_dir = $courseInfo['directory'] . '/document';
$sys_course_path = api_get_path(SYS_COURSE_PATH);
$base_work_dir = $sys_course_path . $course_dir;
foreach ($documents as $document) {
$documentId = $document['id'];
DocumentManager::delete_document(
$courseInfo,
null,
$base_work_dir,
$sessionId,
$documentId
);
}
}
$sql = "DELETE FROM $documentTable
WHERE c_id = $courseId AND session_id = $sessionId";
Database::query($sql);
$sql = "DELETE FROM $itemPropertyTable
WHERE c_id = $courseId AND session_id = $sessionId AND tool = '".TOOL_DOCUMENT."'";
Database::query($sql);
}
}