';
$return .= ''.$title.'';
$return .= '';
} 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_enabled') !== 'true') {
return false;
}
if (empty($docid) or $docid != intval($docid)) {
return false;
}
if (empty($session_id)) {
$session_id = api_get_session_id();
}
$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_id 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
$tbl_se_ref = Database::get_main_table(TABLE_MAIN_SEARCH_ENGINE_REF);
$sql = 'SELECT * FROM %s WHERE course_code=\'%s\' AND tool_id=\'%s\' AND ref_id_high_level=%s LIMIT 1';
$sql = sprintf($sql, $tbl_se_ref, $course_code, TOOL_DOCUMENT, $docid);
$res = Database::query($sql);
if (Database::num_rows($res) > 0) {
$se_ref = Database::fetch_array($res);
if (!$simulation) {
$di->remove_document($se_ref['search_did']);
}
$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
$tbl_se_ref = Database::get_main_table(TABLE_MAIN_SEARCH_ENGINE_REF);
$sql = 'UPDATE %s SET search_did=%d WHERE id=%d LIMIT 1';
$sql = sprintf($sql, $tbl_se_ref, (int) $did, (int) $se_ref['id']);
Database::query($sql);
}
}
}
} 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
$tbl_se_ref = Database::get_main_table(TABLE_MAIN_SEARCH_ENGINE_REF);
$sql = 'INSERT INTO %s (id, course_code, tool_id, ref_id_high_level, search_did)
VALUES (NULL , \'%s\', \'%s\', %s, %s)';
$sql = sprintf($sql, $tbl_se_ref, $course_code, TOOL_DOCUMENT, $docid, $did);
Database::query($sql);
} 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('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('show_default_folders') == 'false') {
$foldersToAvoid[] = '/images';
$foldersToAvoid[] = '/flash';
$foldersToAvoid[] = '/audio';
$foldersToAvoid[] = '/video';
}
// Admin setting for Hide/Show chat history folder
if (api_get_setting('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('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('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['code']);
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)
{
require_once '../../../../vendor/autoload.php';
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['temp_audio_nanogong'] = $to_sys;
return api_get_path(WEB_ARCHIVE_PATH).'temp/audio/'.$file_crip;
}
/**
* Erase temp nanogong audio.
*/
public static function removeGeneratedAudioTempFile()
{
if (isset($_SESSION['temp_audio_nanogong'])
&& !empty($_SESSION['temp_audio_nanogong'])
&& is_file($_SESSION['temp_audio_nanogong'])) {
unlink($_SESSION['temp_audio_nanogong']);
unset($_SESSION['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
*/
public static function generateDefaultCertificate($courseData)
{
global $css, $img_dir, $default_course_dir, $js;
$codePath = api_get_path(REL_CODE_PATH);
$dir = '/certificates';
// Create certificates directory if it doesn't exist
DocumentManager::create_directory_certificate_in_course($courseData['code']);
$title = get_lang('DefaultCertificate');
$comment = null;
$fileName = 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());
}
$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);
$defaultCertificateId = self::get_default_certificate_id($courseData['code']);
if (!isset($defaultCertificateId)) {
self::attach_gradebook_certificate($courseData['code'], $documentId);
}
}
/**
* 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,
$useSuffix = true
) {
$courseId = $courseInfo['real_id'];
if (empty($courseId)) {
return false;
}
$sessionId = intval($sessionId);
$folderWithSuffix = $folder;
if ($useSuffix) {
$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;
}
/**
* @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;
}
}
}