TomaHost/Chamilo
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

upgrade

Browse Source
This commit is contained in:
Xes
2025-08-14 22:39:38 +02:00
parent 3641e93527
commit 5403f346e3
3370 changed files with 327179 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

552
plugin/courselegal/CourseLegalPlugin.php Normal file
View File

@@ -0,0 +1,552 @@
<?php
/* For licensing terms, see /license.txt */
/**
* Class CourseLegalPlugin.
*/
class CourseLegalPlugin extends Plugin
{
public $isCoursePlugin = true;
// When creating a new course this settings are added to the course
public $course_settings = [
[
'name' => 'courselegal',
'type' => 'text',
],
];
protected function __construct()
{
parent::__construct(
'0.1',
'Julio Montoya',
[
'tool_enable' => 'boolean',
]
);
}
/**
* @return CourseLegalPlugin
*/
public static function create()
{
static $result = null;
return $result ? $result : $result = new self();
}
/**
* @return string
*/
public function getTeacherLink()
{
$link = null;
if (api_is_allowed_to_edit()) {
$url = api_get_path(WEB_PLUGIN_PATH).'courselegal/start.php?'.api_get_cidreq();
$link = Display::url(
$this->get_lang('CourseLegal'),
$url,
['class' => 'btn']
);
}
return $link;
}
/**
* @param int $userId
* @param int $courseId
* @param int $sessionId
*
* @return array
*/
public function getUserAcceptedLegal($userId, $courseId, $sessionId)
{
$userId = intval($userId);
$courseId = intval($courseId);
$sessionId = intval($sessionId);
$table = Database::get_main_table('session_rel_course_rel_user_legal');
$sql = "SELECT *
FROM $table
WHERE user_id = $userId AND c_id = $courseId AND session_id = $sessionId";
$result = Database::query($sql);
$data = [];
if (Database::num_rows($result) > 0) {
$data = Database::fetch_array($result, 'ASSOC');
}
return $data;
}
/**
* @param int $userId
* @param string $courseCode
* @param int $sessionId
*
* @return bool
*/
public function isUserAcceptedLegal($userId, $courseCode, $sessionId)
{
$courseInfo = api_get_course_info($courseCode);
$courseId = $courseInfo['real_id'];
$result = $this->getUserAcceptedLegal($userId, $courseId, $sessionId);
if (!empty($result)) {
if ($result['mail_agreement'] == 1 &&
$result['web_agreement'] == 1
) {
return true;
}
}
return false;
}
/**
* @param int $userId
* @param int $courseCode
* @param int $sessionId
* @param bool $sendEmail Optional. Indicate whether the mail must be sent. Default is true
*
* @return mixed
*/
public function saveUserLegal($userId, $courseCode, $sessionId, $sendEmail = true)
{
$courseInfo = api_get_course_info($courseCode);
$courseId = $courseInfo['real_id'];
$data = $this->getUserAcceptedLegal($userId, $courseId, $sessionId);
$id = false;
if (empty($data)) {
$table = Database::get_main_table(
'session_rel_course_rel_user_legal'
);
$uniqueId = api_get_unique_id();
$values = [
'user_id' => $userId,
'c_id' => $courseId,
'session_id' => $sessionId,
'web_agreement' => 1,
'web_agreement_date' => api_get_utc_datetime(),
'mail_agreement_link' => $uniqueId,
];
$id = Database::insert($table, $values);
if ($sendEmail) {
$this->sendMailLink($uniqueId, $userId, $courseId, $sessionId);
}
}
return $id;
}
/**
* @param int $userId
* @param int $courseId
* @param int $sessionId
*/
public function updateMailAgreementLink($userId, $courseId, $sessionId)
{
$data = $this->getUserAcceptedLegal($userId, $courseId, $sessionId);
if (!empty($data)) {
$table = Database::get_main_table(
'session_rel_course_rel_user_legal'
);
$uniqueId = api_get_unique_id();
Database::update(
$table,
['mail_agreement_link' => $uniqueId],
['id = ? ' => [$data['id']]]
);
$this->sendMailLink($uniqueId, $userId, $courseId, $sessionId);
}
}
/**
* @param int $userId
* @param int $courseId
* @param int $sessionId
*/
public function deleteUserAgreement($userId, $courseId, $sessionId)
{
$data = $this->getUserAcceptedLegal($userId, $courseId, $sessionId);
if (!empty($data)) {
$table = Database::get_main_table(
'session_rel_course_rel_user_legal'
);
Database::delete(
$table,
['id = ? ' => [$data['id']]]
);
}
}
/**
* @param string $uniqueId
* @param int $userId
* @param int $courseId
* @param int $sessionId
*/
public function sendMailLink($uniqueId, $userId, $courseId, $sessionId)
{
$courseInfo = api_get_course_info_by_id($courseId);
$courseCode = $courseInfo['code'];
$url = api_get_path(WEB_CODE_PATH).'course_info/legal.php?web_agreement_link='.$uniqueId.'&course_code='.Security::remove_XSS($courseCode).'&session_id='.$sessionId;
$courseUrl = Display::url($url, $url);
$sessionInfo = api_get_session_info($sessionId);
$sesstionTitle = null;
if (!empty($sessionInfo)) {
$sesstionTitle = ' ('.$sessionInfo['name'].')';
}
$courseTitle = $courseInfo['title'].$sesstionTitle;
$subject = $this->get_lang("MailAgreement");
$message = sprintf($this->get_lang("MailAgreementWasSentWithClickX"), $courseTitle, $courseUrl);
MessageManager::send_message_simple($userId, $subject, $message);
}
/**
* @param string $link
* @param int $userId
* @param int $courseId
* @param int $sessionId
*
* @return bool
*/
public function saveUserMailLegal($link, $userId, $courseId, $sessionId)
{
$data = $this->getUserAcceptedLegal($userId, $courseId, $sessionId);
if (empty($data)) {
return null;
}
if ($data['mail_agreement_link'] == $link) {
$table = Database::get_main_table('session_rel_course_rel_user_legal');
$id = $data['id'];
$values = [
'mail_agreement' => 1,
'mail_agreement_date' => api_get_utc_datetime(),
];
Database::update($table, $values, ['id = ?' => [$id]]);
}
}
/**
* @param int $courseId
* @param int $sessionId
* @param string $filePath
*/
public function warnUsersByEmail($courseId, $sessionId, $filePath = null)
{
$courseInfo = api_get_course_info_by_id($courseId);
$courseCode = $courseInfo['code'];
if (empty($sessionId)) {
$students = CourseManager::get_student_list_from_course_code($courseCode, false);
} else {
$students = CourseManager::get_student_list_from_course_code($courseCode, true, $sessionId);
}
$url = api_get_course_url($courseCode, $sessionId);
$url = Display::url($url, $url);
$subject = $this->get_lang("AgreementUpdated");
$message = sprintf($this->get_lang("AgreementWasUpdatedClickHere"), $url);
$dataFile = [];
if (!empty($filePath)) {
$dataFile = [
'path' => $filePath,
'filename' => basename($filePath),
];
$message = sprintf($this->get_lang("AgreementWasUpdatedClickHere"), $url)." \n";
$message .= $this->get_lang("TheAgreementIsAttachedInThisEmail");
}
if (!empty($students)) {
foreach ($students as $student) {
$userInfo = api_get_user_info($student['user_id']);
api_mail_html(
$userInfo['complete_name'],
$userInfo['email'],
$subject,
$message,
null,
null,
null,
$dataFile
);
//MessageManager::send_message_simple($student['user_id'], $subject, $message);
}
}
}
/**
* @param int $courseId
* @param int $sessionId
* @param string $order
*
* @return array
*/
public function getUserAgreementList($courseId, $sessionId, $order = null)
{
$courseId = intval($courseId);
$sessionId = intval($sessionId);
$table = Database::get_main_table('session_rel_course_rel_user_legal');
$userTable = Database::get_main_table(TABLE_MAIN_USER);
$sql = "SELECT *
FROM $table s INNER JOIN $userTable u
ON u.user_id = s.user_id
WHERE c_id = $courseId AND session_id = $sessionId ";
if (!empty($order)) {
$sql .= $order;
}
$result = Database::query($sql);
$data = [];
if (Database::num_rows($result) > 0) {
$data = Database::store_result($result, 'ASSOC');
}
return $data;
}
/**
* @param int $courseId
* @param int $sessionId
*/
public function removePreviousAgreements($courseId, $sessionId)
{
$table = Database::get_main_table('session_rel_course_rel_user_legal');
$sessionId = intval($sessionId);
$courseId = intval($courseId);
$sql = "DELETE FROM $table
WHERE c_id = '$courseId' AND session_id = $sessionId ";
Database::query($sql);
}
/**
* @param array $values
* @param array $file $_FILES['uploaded_file']
* @param bool $deleteFile
*/
public function save($values, $file = [], $deleteFile = false)
{
$table = Database::get_main_table('session_rel_course_legal');
$courseId = $values['c_id'];
$sessionId = $values['session_id'];
$conditions = [
'c_id' => $courseId,
'session_id' => $sessionId,
];
$course = api_get_course_info_by_id($courseId);
$legalData = $this->getData($courseId, $sessionId);
$coursePath = api_get_path(SYS_COURSE_PATH).$course['directory'].'/courselegal';
$uploadResult = $coursePath.'/'.$legalData['filename'];
if (!is_dir($coursePath)) {
mkdir($coursePath, api_get_permissions_for_new_directories());
}
$uploadOk = process_uploaded_file($file, false);
$fileName = null;
if ($uploadOk) {
$uploadResult = handle_uploaded_document(
$course,
$file,
$coursePath,
'/',
api_get_user_id(),
api_get_group_id(),
null,
false,
false,
false,
true
);
if ($uploadResult) {
$fileName = basename($uploadResult);
// Delete old one if exists.
if ($legalData) {
if (!empty($legalData['filename'])) {
$fileToDelete = $coursePath.'/'.$legalData['filename'];
if (file_exists($fileToDelete)) {
unlink($fileToDelete);
}
}
}
}
}
$conditions['content'] = $values['content'];
$conditions['filename'] = $fileName;
if (empty($legalData)) {
$id = Database::insert($table, $conditions);
} else {
$id = $legalData['id'];
$updateParams = [
'content' => $values['content'],
];
if (!empty($fileName)) {
$updateParams['filename'] = $fileName;
}
Database::update(
$table,
$updateParams,
['id = ? ' => $id]
);
}
if ($deleteFile) {
Database::update(
$table,
['filename' => ''],
['id = ? ' => $id]
);
if (!empty($legalData['filename'])) {
$fileToDelete = $coursePath.'/'.$legalData['filename'];
if (file_exists($fileToDelete)) {
unlink($fileToDelete);
}
}
}
if (isset($values['remove_previous_agreements']) &&
!empty($values['remove_previous_agreements'])
) {
$this->removePreviousAgreements($courseId, $sessionId);
}
$warnUsers = isset($values['warn_users_by_email']) ? $values['warn_users_by_email'] : null;
switch ($warnUsers) {
case '1':
// Nothing
break;
case '2':
// Send mail
$this->warnUsersByEmail($courseId, $sessionId);
break;
case '3':
// Send mail + attachment if exists.
if (!empty($legalData['filename'])) {
$this->warnUsersByEmail(
$courseId,
$sessionId,
$uploadResult
);
}
break;
}
}
/**
* @param int $courseId
* @param int $sessionId
*
* @return array|mixed
*/
public function getData($courseId, $sessionId)
{
$table = Database::get_main_table('session_rel_course_legal');
$conditions = [
'c_id = ? AND session_id = ? ' => [
$courseId,
$sessionId,
],
];
$result = Database::select('*', $table, ['where' => $conditions]);
$legalData = isset($result) && !empty($result) ? current($result) : [];
return $legalData;
}
/**
* @param int $courseId
* @param int $sessionId
*
* @return string
*/
public function getCurrentFile($courseId, $sessionId)
{
$data = $this->getData($courseId, $sessionId);
if (isset($data['filename']) && !empty($data['filename'])) {
$course = api_get_course_info_by_id($courseId);
$coursePath = api_get_path(SYS_COURSE_PATH).$course['directory'].'/courselegal';
$file = $coursePath.'/'.$data['filename'];
if (file_exists($file)) {
return Display::url(
$data['filename'],
api_get_path(WEB_COURSE_PATH).$course['directory'].'/courselegal/'.$data['filename'],
['target' => '_blank']
);
}
}
}
public function install()
{
$table = Database::get_main_table('session_rel_course_legal');
$sql = "CREATE TABLE IF NOT EXISTS $table (
id int PRIMARY KEY AUTO_INCREMENT,
c_id int,
session_id int,
content text,
filename varchar(255)
)";
Database::query($sql);
$table = Database::get_main_table('session_rel_course_rel_user_legal');
$sql = "CREATE TABLE IF NOT EXISTS $table (
id int PRIMARY KEY AUTO_INCREMENT,
user_id int,
c_id int,
session_id int,
web_agreement varchar(255),
web_agreement_date datetime,
mail_agreement varchar(255),
mail_agreement_date datetime,
mail_agreement_link varchar(255)
)";
Database::query($sql);
// Installing course settings
$this->install_course_fields_in_all_courses(false);
}
public function uninstall()
{
$table = Database::get_main_table('session_rel_course_legal');
$sql = "DROP TABLE $table ";
Database::query($sql);
$table = Database::get_main_table('session_rel_course_rel_user_legal');
$sql = "DROP TABLE $table ";
Database::query($sql);
// Deleting course settings
$this->uninstall_course_fields_in_all_courses($this->course_settings);
}
}