public/main/glossary/index.php
<?php
/* For licensing terms, see /license.txt */
use Chamilo\CoreBundle\Framework\Container;
use Chamilo\CourseBundle\Entity\CGlossary;
use ChamiloSession as Session;
use Chamilo\CoreBundle\Component\Utils\ActionIcon;
/**
* @author Christian Fasanando, initial version
* @author Bas Wijnen import/export to CSV
*/
require_once __DIR__.'/../inc/global.inc.php';
$current_course_tool = TOOL_GLOSSARY;
// Notification for unauthorized people.
$this_section = SECTION_COURSES;
api_protect_course_script(true);
// Additional javascripts.
$htmlHeadXtra[] = GlossaryManager::javascript_glossary();
$htmlHeadXtra[] = '<script>
function setFocus(){
$("#glossary_title").focus();
}
$(function() {
setFocus();
$( "#dialog:ui-dialog" ).dialog( "destroy" );
$( "#dialog-confirm" ).dialog({
autoOpen: false,
show: "blind",
resizable: false,
height:300,
modal: true
});
$("#export_opener").click(function() {
var targetUrl = $(this).attr("href");
$( "#dialog-confirm" ).dialog({
width:400,
height:300,
buttons: {
"'.addslashes(get_lang('Download')).'": function() {
var export_format = $("input[name=export_format]:checked").val();
location.href = targetUrl+"&export_format="+export_format;
$( this ).dialog( "close" );
}
}
});
$( "#dialog-confirm" ).dialog("open");
return false;
});
});
</script>';
// Tracking
Event::event_access_tool(TOOL_GLOSSARY);
/*
function sorter($item1, $item2)
{
if ($item1[2] == $item2[2]) {
return 0;
}
return $item1[2] < $item2[2] ? -1 : 1;
}
*/
// Displaying the header
$action = isset($_GET['action']) ? Security::remove_XSS($_GET['action']) : '';
$currentUrl = api_get_self().'?'.api_get_cidreq();
$interbreadcrumb[] = ['url' => 'index.php?'.api_get_cidreq(), 'name' => get_lang('Glossary')];
$content = '';
$tool_name = '';
switch ($action) {
case 'addglossary':
if (!api_is_allowed_to_edit(null, true)) {
api_not_allowed(true);
}
$tool_name = get_lang('Add');
$form = new FormValidator(
'glossary',
'post',
api_get_self().'?action=addglossary&'.api_get_cidreq()
);
// Setting the form elements
$form->addElement('header', get_lang('Add new glossary term'));
if ('true' === api_get_setting('editor.save_titles_as_html')) {
$form->addHtmlEditor(
'title',
get_lang('Term'),
false,
false,
['ToolbarSet' => 'TitleAsHtml']
);
} else {
$form->addElement('text', 'title', get_lang('Term'), ['id' => 'glossary_title']);
}
$form->addHtmlEditor(
'description',
get_lang('Term definition'),
true,
false,
['ToolbarSet' => 'Glossary', 'Height' => '300']
);
$form->addButtonCreate(get_lang('Save term'), 'SubmitGlossary');
// setting the rules
$form->addRule('title', get_lang('Required field'), 'required');
// The validation or display
if ($form->validate()) {
$check = Security::check_token('post');
if ($check) {
$values = $form->exportValues();
GlossaryManager::save_glossary($values);
}
Security::clear_token();
header('Location: '.$currentUrl);
exit;
} else {
$token = Security::get_token();
$form->addElement('hidden', 'sec_token');
$form->setConstants(['sec_token' => $token]);
$content = Display::toolbarAction(
'add_glossary',
[
Display::url(
Display::getMdiIcon(ActionIcon::BACK, 'ch-tool-icon', null, ICON_SIZE_MEDIUM, get_lang('Back')),
api_get_self().'?'.api_get_cidreq()
),
]
);
$content .= $form->returnForm();
}
break;
case 'edit_glossary':
if (!api_is_allowed_to_edit(null, true)) {
api_not_allowed(true);
}
$tool_name = get_lang('Edit');
$glossaryId = isset($_GET['glossary_id']) ? (int) $_GET['glossary_id'] : 0;
if (!empty($glossaryId)) {
// initiate the object
$form = new FormValidator(
'glossary',
'post',
api_get_self().'?action=edit_glossary&glossary_id='.$glossaryId.'&'.api_get_cidreq()
);
// Setting the form elements
$form->addElement('header', get_lang('Edit term'));
$form->addElement('hidden', 'glossary_id');
if ('true' === api_get_setting('editor.save_titles_as_html')) {
$form->addHtmlEditor(
'title',
get_lang('Term'),
false,
false,
['ToolbarSet' => 'TitleAsHtml']
);
} else {
$form->addElement('text', 'title', get_lang('Term'), ['id' => 'glossary_title']);
}
$form->addElement(
'html_editor',
'description',
get_lang('Term definition'),
null,
['ToolbarSet' => 'Glossary', 'Height' => '300']
);
$repo = Container::getGlossaryRepository();
/** @var CGlossary $glossaryData */
$glossaryData = $repo->find($glossaryId);
/*
// setting the defaults
$glossary_data = GlossaryManager::get_glossary_information($glossaryId);
// Date treatment for timezones
if (!empty($glossary_data['insert_date'])) {
$glossary_data['insert_date'] = Display::dateToStringAgoAndLongDate($glossary_data['insert_date']);
} else {
$glossary_data['insert_date'] = '';
}
if (!empty($glossary_data['update_date'])) {
$glossary_data['update_date'] = Display::dateToStringAgoAndLongDate($glossary_data['update_date']);
} else {
$glossary_data['update_date'] = '';
}
$form->addLabel(get_lang('Creation date'), $glossary_data['insert_date']);
$form->addLabel(get_lang('Updated'), $glossary_data['update_date']);
*/
$form->addButtonUpdate(get_lang('Update term'), 'SubmitGlossary');
$default = [
'glossary_id' => $glossaryData->getIid(),
'title' => $glossaryData->getTitle(),
'description' => $glossaryData->getDescription(),
];
$form->setDefaults($default);
// setting the rules
$form->addRule('title', get_lang('Required field'), 'required');
// The validation or display
if ($form->validate()) {
$check = Security::check_token('post');
if ($check) {
$values = $form->exportValues();
GlossaryManager::update_glossary($values);
}
Security::clear_token();
header('Location: '.$currentUrl);
exit;
} else {
$token = Security::get_token();
$form->addElement('hidden', 'sec_token');
$form->setConstants(['sec_token' => $token]);
$content = Display::toolbarAction(
'edit_glossary',
[
Display::url(
Display::getMdiIcon(ActionIcon::BACK, 'ch-tool-icon', null, ICON_SIZE_MEDIUM, get_lang('Back')),
api_get_self().'?'.api_get_cidreq()
),
]
);
$content .= $form->returnForm();
}
}
break;
case 'delete_glossary':
if (!api_is_allowed_to_edit(null, true)) {
api_not_allowed(true);
}
GlossaryManager::delete_glossary($_GET['glossary_id']);
Security::clear_token();
header('Location: '.$currentUrl);
exit;
break;
case 'moveup':
//GlossaryManager::move_glossary('up',$_GET['glossary_id']); //actions not available
GlossaryManager::display_glossary();
break;
case 'movedown':
//GlossaryManager::move_glossary('down',$_GET['glossary_id']); //actions not available
GlossaryManager::display_glossary();
break;
case 'import':
if (!api_is_allowed_to_edit(null, true)) {
api_not_allowed(true);
}
$tool_name = get_lang('Import glossary');
$form = new FormValidator(
'glossary',
'post',
api_get_self().'?action=import&'.api_get_cidreq()
);
$form->addHeader(get_lang('Import glossary'));
$form->addElement('file', 'file', get_lang('File'));
$group = [];
$group[] = $form->createElement(
'radio',
'file_type',
'',
'CSV',
'csv'
);
$group[] = $form->createElement(
'radio',
'file_type',
'',
'XLS',
'xls'
);
$form->addGroup($group, '', get_lang('File type'), null);
$form->addElement('checkbox', 'replace', null, get_lang('Delete all terms before import.'));
$form->addElement('checkbox', 'update', null, get_lang('Update existing terms.'));
$form->addButtonImport(get_lang('Import'), 'SubmitImport');
$form->setDefaults(['file_type' => 'csv']);
$content = $form->returnForm();
$content .= get_lang('The CSV file must look like this').' ('.get_lang('Fields in <strong>bold</strong> are mandatory.').')';
$content .= '<pre>
<strong>term</strong>;<strong>definition</strong>;
"Hello";"Hola";
"Goodbye";"Adiós";
</pre>';
if ($form->validate()) {
$values = $form->getSubmitValues();
$termsDeleted = [];
//this is a bad idea //jm
if (isset($_POST['replace']) && $_POST['replace']) {
foreach (GlossaryManager::get_glossary_terms() as $term) {
if (!GlossaryManager::delete_glossary($term['id'], false)) {
Display::addFlash(
Display::return_message(get_lang('Cannot delete glossary').':'.$term['id'], 'error')
);
} else {
$termsDeleted[] = $term['title'];
}
}
}
$updateTerms = isset($_POST['update']) && $_POST['update'] ? true : false;
$format = $values['file_type'];
switch ($format) {
case 'csv':
$data = Import::csvToArray($_FILES['file']['tmp_name']);
break;
case 'xls':
$data = Import::xlsToArray($_FILES['file']['tmp_name']);
break;
}
$updatedList = [];
$addedList = [];
$badList = [];
$doubles = [];
$termsPerKey = [];
if ($data) {
$termsToAdd = [];
foreach ($data as $item) {
if (!isset($item['term'])) {
continue;
}
$items = [
'title' => $item['term'],
'description' => $item['definition'],
];
$termsToAdd[] = $items;
$termsPerKey[$item['term']] = $items;
}
if (empty($termsToAdd)) {
Display::addFlash(
Display::return_message(get_lang('Nothing to add'), 'warning')
);
header('Location: '.$currentUrl);
exit;
}
$repeatItems = array_count_values(array_column($termsToAdd, 'title'));
foreach ($repeatItems as $item => $count) {
if ($count > 1) {
$doubles[] = $item;
}
}
$uniqueTerms = array_unique(array_keys($repeatItems));
foreach ($uniqueTerms as $itemTerm) {
$item = $termsPerKey[$itemTerm];
if ($updateTerms) {
$glossaryInfo = GlossaryManager::get_glossary_term_by_glossary_name($item['title']);
if (!empty($glossaryInfo)) {
$glossaryInfo['description'] = $item['description'];
GlossaryManager::update_glossary($glossaryInfo, false);
$updatedList[] = $item['title'];
} else {
$result = GlossaryManager::save_glossary($item, false);
if ($result) {
$addedList[] = $item['title'];
} else {
$badList[] = $item['title'];
}
}
} else {
$result = GlossaryManager::save_glossary($item, false);
if ($result) {
$addedList[] = $item['title'];
} else {
$badList[] = $item['title'];
}
}
}
}
if (count($termsDeleted) > 0) {
Display::addFlash(
Display::return_message(get_lang('Term removed').': '.implode(', ', $termsDeleted))
);
}
if (count($updatedList) > 0) {
Display::addFlash(
Display::return_message(get_lang('Terms updated').': '.implode(', ', $updatedList))
);
}
if (count($addedList) > 0) {
Display::addFlash(
Display::return_message(get_lang('Terms added').': '.implode(', ', $addedList))
);
}
if (count($badList) > 0) {
Display::addFlash(
Display::return_message(
get_lang('Term already exists').': '.implode(', ', $badList),
'error'
)
);
}
if (count($doubles) > 0) {
Display::addFlash(
Display::return_message(
get_lang('Terms duplicated in file').': '.implode(', ', $doubles),
'warning'
)
);
}
header('Location: '.$currentUrl);
exit;
}
break;
case 'export':
if (!api_is_allowed_to_edit(null, true)) {
api_not_allowed(true);
}
$format = isset($_GET['export_format']) ? $_GET['export_format'] : 'csv';
GlossaryManager::exportToFormat($format);
break;
case 'changeview':
if (in_array($_GET['view'], ['list', 'table'])) {
Session::write('glossary_view', $_GET['view']);
} else {
$view = Session::read('glossary_view');
$defaultView = api_get_setting('glossary.default_glossary_view');
if (empty($defaultView)) {
$defaultView = 'table';
}
if (empty($view)) {
Session::write('glossary_view', $defaultView);
}
}
header('Location: '.$currentUrl);
exit;
break;
case 'export_documents':
GlossaryManager::movePdfToDocuments();
header('Location: '.$currentUrl);
exit;
break;
default:
$tool_name = get_lang('List');
$htmlHeadXtra[] = '<script src="'.api_get_path(WEB_CODE_PATH).'glossary/glossary.js.php?add_ready=1&'.api_get_cidreq().'"></script>';
$htmlHeadXtra[] = api_get_js('jquery.highlight.js');
$content = GlossaryManager::display_glossary();
break;
}
Display::display_header($tool_name);
Display::display_introduction_section(TOOL_GLOSSARY);
echo $content;
$extra = '<div id="dialog-confirm" title="'.get_lang('Please confirm your choice').'">';
$form = new FormValidator(
'report',
'post',
api_get_self().'?'.api_get_cidreq(),
null,
['class' => 'form-vertical']
);
$form->addElement(
'radio',
'export_format',
null,
get_lang('CSV export'),
'csv',
['id' => 'export_format_csv_label']
);
$form->addElement(
'radio',
'export_format',
null,
get_lang('Excel export'),
'xls',
['id' => 'export_format_xls_label']
);
$form->addElement(
'radio',
'export_format',
null,
get_lang('Export to PDF'),
'pdf',
['id' => 'export_format_pdf_label']
);
$form->setDefaults(['export_format' => 'csv']);
$extra .= $form->returnForm();
$extra .= '</div>';
echo $extra;
Display::display_footer();