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

Upgrade 1-11.38

Browse Source
This commit is contained in:
xesmyd
2026-03-30 14:10:30 +02:00
parent f2a7e6d1fc
commit ac648ef29d
24665 changed files with 69682 additions and 2205004 deletions
Download Patch File Download Diff File Expand all files Collapse all files
main/inc/lib/webservices/Rest.php
+524 -38
View File
@@ -3,12 +3,12 @@
/* For licensing terms, see /license.txt */
use Chamilo\CoreBundle\Entity\Course;
use Chamilo\CoreBundle\Entity\ExtraFieldValues;
use Chamilo\CoreBundle\Entity\Session;
use Chamilo\CourseBundle\Entity\CLpCategory;
use Chamilo\CourseBundle\Entity\CNotebook;
use Chamilo\CourseBundle\Entity\Repository\CNotebookRepository;
use Chamilo\UserBundle\Entity\User;
use Symfony\Component\HttpFoundation\ParameterBag;
use Symfony\Component\HttpFoundation\Request as HttpRequest;
/**
@@ -61,7 +61,9 @@ class Rest extends WebService
public const GET_COURSE_LINKS = 'course_links';
public const GET_COURSE_WORKS = 'course_works';
public const GET_COURSE_EXERCISES = 'course_exercises';
public const GET_COURSE_GRADEBOOK = 'course_gradebook';
public const GET_COURSES_DETAILS_BY_EXTRA_FIELD = 'courses_details_by_extra_field';
public const GET_COURSE_BY_CODE = 'course_details_by_code';
public const SAVE_COURSE_NOTEBOOK = 'save_course_notebook';
@@ -127,6 +129,7 @@ class Rest extends WebService
public const ADD_USERS_SESSION = 'add_users_session';
public const SUBSCRIBE_USER_TO_SESSION_FROM_USERNAME = 'subscribe_user_to_session_from_username';
public const SUBSCRIBE_USERS_TO_SESSION = 'subscribe_users_to_session';
public const ADD_SESSION_COURSE_COACHES = 'add_session_course_coaches';
public const UNSUBSCRIBE_USERS_FROM_SESSION = 'unsubscribe_users_from_session';
public const GET_USERS_SUBSCRIBED_TO_SESSION = 'get_users_subscribed_to_session';
@@ -154,6 +157,9 @@ class Rest extends WebService
public const DELETE_GROUP_SUB_COURSE = 'delete_group_sub_course';
public const DELETE_GROUP_SUB_SESSION = 'delete_group_sub_session';
public const GET_AUDIT_ITEMS = 'get_audit_items';
public const SUBSCRIBE_COURSE_TO_SESSION_FROM_EXTRA_FIELD = 'subscribe_course_to_session_from_extra_field';
public const SUBSCRIBE_USER_TO_SESSION_FROM_EXTRA_FIELD = 'subscribe_user_to_session_from_extra_field';
public const UPDATE_SESSION_FROM_EXTRA_FIELD = 'update_session_from_extra_field';
/**
* @var Session
@@ -181,7 +187,7 @@ class Rest extends WebService
*
* @param int $userId
*/
private function __getConfiguredUsernameById(int $userId = null): string
private function __getConfiguredUsernameById(?int $userId = null): string
{
if (empty($userId)) {
return '';
@@ -238,12 +244,7 @@ class Rest extends WebService
}
}
/**
* @param string $encoded
*
* @return array
*/
public static function decodeParams($encoded)
public static function decodeParams(string $encoded): array
{
return json_decode($encoded);
}
@@ -500,6 +501,40 @@ class Rest extends WebService
return $data;
}
/**
* @throws Exception
*/
public function getCourseByCode(string $q, int $sessionId = 0): array
{
if (!api_is_teacher() && !api_is_platform_admin()) {
self::throwNotAllowedException();
}
if (strlen($q) < 3) {
throw new Exception(get_lang('TooShort'));
}
$courseList = CourseManager::searchCourse($q, $sessionId);
$em = Database::getManager();
return array_map(
function ($courseInfo) use ($em) {
/** @var Course $course */
$course = $em->find(Course::class, $courseInfo['id']);
return [
'id' => $course->getId(),
'title' => $course->getTitle(),
'code' => $course->getCode(),
'directory' => $course->getDirectory(),
'urlPicture' => CourseManager::getPicturePath($course, true),
'teachers' => CourseManager::getTeacherListFromCourseCodeToString($course->getCode()),
];
},
$courseList
);
}
/**
* @throws Exception
*
@@ -1235,20 +1270,11 @@ class Rest extends WebService
'username' => $this->user->getUsername(),
'officialCode' => $this->user->getOfficialCode(),
'phone' => $this->user->getPhone(),
'extra' => [],
];
$fieldValue = new ExtraFieldValue('user');
$extraInfo = $fieldValue->getAllValuesForAnItem($this->user->getId(), true);
$extraInfo = (new ExtraFieldValue('user'))->getAllValuesForAnItem($this->user->getId(), true);
foreach ($extraInfo as $extra) {
/** @var ExtraFieldValues $extraValue */
$extraValue = $extra['value'];
$result['extra'][] = [
'title' => $extraValue->getField()->getDisplayText(true),
'value' => $extraValue->getValue(),
];
}
$result['extra'] = ExtraFieldValue::formatValues($extraInfo);
return $result;
}
@@ -1828,25 +1854,23 @@ class Rest extends WebService
return $out;
}
public function addCourse(array $courseParam): array
/**
* @throws Exception
*/
public function addCourse(ParameterBag $request): array
{
self::protectAdminEndpoint();
$idCampus = isset($courseParam['id_campus']) ? $courseParam['id_campus'] : 1;
$title = isset($courseParam['title']) ? $courseParam['title'] : '';
$wantedCode = isset($courseParam['wanted_code']) ? $courseParam['wanted_code'] : null;
$diskQuota = isset($courseParam['disk_quota']) ? $courseParam['disk_quota'] : '100';
$visibility = isset($courseParam['visibility']) ? (int) $courseParam['visibility'] : null;
$removeCampusId = $courseParam['remove_campus_id_from_wanted_code'] ?? 0;
$language = $courseParam['language'] ?? '';
$idCampus = $request->getInt('id_campus', 1);
$title = $request->get('title');
$wantedCode = $request->get('wanted_code');
$diskQuota = $request->getInt('disk_quota', 100);
$visibility = $request->getInt('visibility');
$removeCampusId = $request->getBoolean('remove_campus_id_from_wanted_code');
$language = $request->get('language');
if (isset($courseParam['visibility'])) {
if ($courseParam['visibility'] &&
$courseParam['visibility'] >= 0 &&
$courseParam['visibility'] <= 3
) {
$visibility = (int) $courseParam['visibility'];
}
if (!isset(Course::getStatusList()[$visibility])) {
throw new Exception(get_lang('VisibilityCannotBeChanged'));
}
$params = [];
@@ -1860,12 +1884,16 @@ class Rest extends WebService
$params['disk_quota'] = $diskQuota;
$params['course_language'] = $language;
foreach ($courseParam as $key => $value) {
foreach ($request->all() as $key => $value) {
if (substr($key, 0, 6) === 'extra_') { //an extra field
$params[$key] = $value;
}
}
if ('true' === api_get_setting('teacher_can_select_course_template')) {
$params['course_template'] = $request->getInt('course_template');
}
$courseInfo = CourseManager::create_course($params, $params['user_id'], $idCampus);
$results = [];
if (!empty($courseInfo)) {
@@ -2545,7 +2573,7 @@ class Rest extends WebService
*
* @return int The matching session id, or an array with details about the session
*/
public function getSessionFromExtraField(string $fieldName, string $fieldValue)
public function getSessionFromExtraField(string $fieldName, string $fieldValue): int
{
// find sessions that have that value in the given field
$valueModel = new ExtraFieldValue('session');
@@ -2568,7 +2596,7 @@ class Rest extends WebService
}
// return sessionId
return intval($sessionIdList[0]['item_id']);
return (int) $sessionIdList[0]['item_id'];
}
/**
@@ -2679,10 +2707,26 @@ class Rest extends WebService
throw new Exception(get_lang('NoData'));
}
if (!api_is_platform_admin() && $userId != $this->user->getId()) {
$isAdmin = api_is_platform_admin();
if (!$isAdmin && $userId != $this->user->getId()) {
self::throwNotAllowedException();
}
// Fields that only platform admins may change
$adminOnlyFields = [
'status',
'roles',
'auth_source',
'enabled',
'active',
'creator_id',
'registration_date',
'expiration_date',
'hr_dept_id',
'official_code',
];
if (!empty($parameters['new_login_name'])) {
// Make sure the new username, if set, is available
if (!UserManager::is_username_available($parameters['new_login_name'])) {
@@ -2704,6 +2748,9 @@ class Rest extends WebService
// apply submitted modifications
foreach ($parameters as $name => $value) {
if (!$isAdmin && in_array(strtolower($name), $adminOnlyFields, true)) {
self::throwNotAllowedException();
}
switch (strtolower($name)) {
case 'email':
$user->setEmail($value);
@@ -4381,6 +4428,384 @@ class Rest extends WebService
];
}
/**
* Subscribe a specific course to a specific session, identified via extra field values.
*
* This method:
* - Locates the session ID using the provided session extra field name/value via ExtraFieldValue('session').
* - Locates the course c_id using the provided course extra field name/value via ExtraFieldValue('course').
* - Adds the course to the session using SessionManager::add_courses_to_session() (similar to addCoursesSession()).
*
* Required parameters:
* - session_field_name: Name of the extra field for sessions (e.g., 'peoplesoft_sid').
* - session_field_value: Value of the session extra field (e.g., '123450').
* - course_field_name: Name of the extra field for courses (e.g., 'peoplesoft_cid').
* - course_field_value: Value of the course extra field (e.g., '1').
*
* @param array $params Associative array of POST parameters.
*
* @throws Exception
*
* @return array Response in format: ['error' => bool, 'data' => array] on success, or ['error' => true, 'message' => string] on failure.
*/
public function subscribeCourseToSessionFromExtraField($params)
{
// Validate required parameters (redundant with v2.php but for safety)
$required = ['session_field_name', 'session_field_value', 'course_field_name', 'course_field_value'];
foreach ($required as $key) {
if (empty($params[$key])) {
return [
'error' => true,
'message' => 'Missing required parameter: '.$key,
];
}
}
$sessionFieldName = $params['session_field_name'];
$sessionFieldValue = $params['session_field_value'];
$courseFieldName = $params['course_field_name'];
$courseFieldValue = $params['course_field_value'];
// Get session ID from extra field value using ExtraFieldValue model
$sessionValueModel = new ExtraFieldValue('session');
$sessionIdList = $sessionValueModel->get_item_id_from_field_variable_and_field_value(
$sessionFieldName,
$sessionFieldValue,
false,
false,
true
);
if (empty($sessionIdList)) {
return [
'error' => true,
'message' => 'No session found with extra field value "'.$sessionFieldValue.'".',
];
}
$sessionId = (int) $sessionIdList[0]['item_id']; // Assume single match
// Get course c_id from extra field value using ExtraFieldValue model
$courseValueModel = new ExtraFieldValue('course');
$courseIdList = $courseValueModel->get_item_id_from_field_variable_and_field_value(
$courseFieldName,
$courseFieldValue,
false,
false,
true
);
if (empty($courseIdList)) {
return [
'error' => true,
'message' => 'No course found with extra field value "'.$courseFieldValue.'".',
];
}
$cId = (int) $courseIdList[0]['item_id']; // Assume single match
// Add course to session using existing core method (mirrors addCoursesSession logic)
$success = SessionManager::add_courses_to_session($sessionId, [$cId], false);
if ($success) {
return [
'error' => false,
'data' => [
'status' => true,
'message' => 'Course subscribed to session',
'id_session' => $sessionId,
'c_id' => $cId,
],
];
} else {
return [
'error' => true,
'message' => 'Failed to subscribe course to session.',
];
}
}
/**
* Subscribe a specific user to a specific session, identified via extra field values.
*
* This method:
* - Locates the session ID using the provided session extra field name/value via ExtraFieldValue('session').
* - Locates the user ID using the provided user extra field name/value via ExtraFieldValue('user').
* - Adds the user to the session using SessionManager::subscribe_users_to_session() (similar to subscribeUsersToSession()).
*
* Required parameters:
* - session_field_name: Name of the extra field for sessions (e.g., 'peoplesoft_sid').
* - session_field_value: Value of the session extra field (e.g., '123450').
* - user_field_name: Name of the extra field for users (e.g., 'peoplesoft_uid').
* - user_field_value: Value of the user extra field (e.g., '1').
*
* @param array $params Associative array of POST parameters.
*
* @return array Response in format: ['error' => bool, 'data' => array] on success, or ['error' => true, 'message' => string] on failure.
*/
public function subscribeUserToSessionFromExtraField($params)
{
// Validate required parameters (redundant with v2.php but for safety)
$required = ['session_field_name', 'session_field_value', 'user_field_name', 'user_field_value'];
foreach ($required as $key) {
if (empty($params[$key])) {
return [
'error' => true,
'message' => 'Missing required parameter: '.$key,
];
}
}
$sessionFieldName = $params['session_field_name'];
$sessionFieldValue = $params['session_field_value'];
$userFieldName = $params['user_field_name'];
$userFieldValue = $params['user_field_value'];
// Get session ID from extra field value using ExtraFieldValue model
$sessionValueModel = new ExtraFieldValue('session');
$sessionIdList = $sessionValueModel->get_item_id_from_field_variable_and_field_value(
$sessionFieldName,
$sessionFieldValue,
false,
false,
true
);
if (empty($sessionIdList)) {
return [
'error' => true,
'message' => 'No session found with extra field value "'.$sessionFieldValue.'".',
];
}
$sessionId = (int) $sessionIdList[0]['item_id']; // Extract item_id from sub-array, assume single match
// Get user ID from extra field value using ExtraFieldValue model
$userValueModel = new ExtraFieldValue('user');
$userIdList = $userValueModel->get_item_id_from_field_variable_and_field_value(
$userFieldName,
$userFieldValue,
false,
false,
true
);
if (empty($userIdList)) {
return [
'error' => true,
'message' => 'No user found with extra field value "'.$userFieldValue.'".',
];
}
$userId = (int) $userIdList[0]['item_id']; // Extract item_id from sub-array, assume single match
// Add user to session using existing core method (mirrors subscribeUsersToSession logic)
$success = SessionManager::subscribeUsersToSession($sessionId, [$userId]);
if ($success) {
return [
'error' => false,
'data' => [
'status' => true,
'message' => 'User subscribed to session',
'id_session' => $sessionId,
'user_id' => $userId,
],
];
} else {
return [
'error' => true,
'message' => 'Failed to subscribe user to session.',
];
}
}
/**
* Update a specific session, identified via extra field value.
*
* This method:
* - Locates the session ID using the provided extra field name/value via ExtraFieldValue('session').
* - Calls updateSession() with the located ID and provided update parameters (e.g., name, coach_username, dates).
*
* Required parameters:
* - field_name: Name of the extra field for sessions (e.g., 'peoplesoft_sid').
* - field_value: Value of the session extra field (e.g., PeopleSoft ID).
* - Optional update fields: name, coach_username, access_start_date, access_end_date, etc.
*
* @param array $params Associative array of POST parameters.
*
* @return array Response in format: ['error' => bool, 'data' => array] on success, or ['error' => true, 'message' => string] on failure.
*/
public function updateSessionFromExtraField($params)
{
// Validate required parameters (redundant with v2.php but for safety)
$required = ['field_name', 'field_value'];
foreach ($required as $key) {
if (empty($params[$key])) {
return [
'error' => true,
'message' => 'Missing required parameter: '.$key,
];
}
}
$fieldName = $params['field_name'];
$fieldValue = $params['field_value'];
// Get session ID from extra field value using ExtraFieldValue model
$sessionValueModel = new ExtraFieldValue('session');
$sessionIdList = $sessionValueModel->get_item_id_from_field_variable_and_field_value(
$fieldName,
$fieldValue,
false,
false,
true
);
if (empty($sessionIdList)) {
return [
'error' => true,
'message' => 'No session found with extra field value "'.$fieldValue.'".',
];
}
$sessionId = (int) $sessionIdList[0]['item_id']; // Extract item_id from sub-array, assume single match
// Prepare params for updateSession() by adding the located ID
$params['id_session'] = $sessionId;
// Get coach ID if we got it as username
if (!empty($params['coach_username'])) {
$params['id_coach'] = UserManager::get_user_id_from_username($params['coach_username']);
}
// Delegate to existing updateSession() method (mirrors its logic)
$result = $this->updateSession($params);
// Override message and include ID in data if successful
if (!$result['error']) {
$result['data']['id_session'] = $sessionId;
$result['data']['message'] = 'Session updated';
}
return $result;
}
/**
* @throws Exception
*/
public function addSessionCourseCoaches(ParameterBag $request)
{
$sessionId = $request->getInt('id_session');
$courseId = $request->getInt('course_id');
$em = Database::getManager();
$countSession = $em->getRepository(Session::class)->count(['id' => $sessionId]);
if (!$countSession) {
throw new Exception(get_lang('NoSession'));
}
if (!SessionManager::cantEditSession($sessionId)) {
throw new Exception(get_lang('NotAllowed'));
}
$countCourse = $em->getRepository(Course::class)->count(['id' => $courseId]);
if (!$countCourse) {
throw new Exception(get_lang('NoCourse'));
}
$coachesToSubscribe = array_filter(
array_map(fn ($coachId) => (int) $coachId, $request->get('coach_id', []))
);
$subscribedCoaches = SessionManager::getCoachesByCourseSession($sessionId, $courseId);
$coachesToRemove = array_diff($subscribedCoaches, $coachesToSubscribe);
foreach ($coachesToSubscribe as $coachId) {
SessionManager::set_coach_to_course_session(
$coachId,
$sessionId,
$courseId
);
}
foreach ($coachesToRemove as $coachId) {
SessionManager::set_coach_to_course_session($coachId, $sessionId, $courseId, true);
}
Event::addEvent(
LOG_WS.self::ADD_SESSION_COURSE_COACHES,
'session_id-course_id-coach_ids',
(int) $_POST['id_session'].':'.implode(',', $coachesToSubscribe)
);
}
/**
* @throws Exception
*/
public function getCourseGradebook(): array
{
$isDrhOfCourse = CourseManager::isUserSubscribedInCourseAsDrh(
$this->user->getId(),
api_get_course_info($this->course->getCode())
);
$isDrhOfSession = $this->session
&& !empty(SessionManager::getSessionFollowedByDrh($this->user->getId(), $this->session->getId()));
if (!$isDrhOfCourse && !$isDrhOfSession) {
GradebookUtils::block_students();
}
Event::event_access_tool(TOOL_GRADEBOOK);
$cats = Category::load(
null,
null,
$this->course->getCode(),
null,
null,
$this->session ? $this->session->getId() : null,
false
);
$cats = array_filter(
$cats,
fn ($cat) => $cat->get_parent_id() == 0
);
if (empty($cats)) {
throw new Exception(get_lang('NoCategory'));
}
$cat = array_shift($cats);
$allEval = $cat->get_evaluations(0, true);
$allLinks = $cat->get_links(0, true);
$users = GradebookUtils::get_all_users($allEval, $allLinks);
$mainCourseCategory = Category::load(
null,
null,
$this->course->getCode(),
null,
null,
$this->session ? $this->session->getId() : null
);
$flatViewTable = new FlatViewTable(
$cat,
$users,
$allEval,
$allLinks,
true,
0,
null,
$mainCourseCategory[0]
);
$flatViewTable->setAutoFill(false);
$flatViewTable->set_additional_parameters(['export_pdf' => true]);
$headers = $this->formatGradebookHeaders($flatViewTable->datagen);
$rows = $this->formatGradebookRows($headers, $flatViewTable->datagen);
return [
'headers' => $headers,
'rows' => $rows,
];
}
/**
* Generate an API key for webservices access for the given user ID.
*/
@@ -4429,4 +4854,65 @@ class Rest extends WebService
return api_get_self().'?'
.http_build_query(array_merge($queryParams, $additionalParams));
}
private function formatGradebookHeaders(FlatViewDataGenerator $dataGen): array
{
$result = [];
$colIndex = 0;
foreach ($dataGen->get_header_names() as $header) {
if (is_array($header)) {
$groupLabel = preg_replace(
'/<a[^>]*>(.*?)<\/a>\s*(.*?)<\/span>/i',
"$1\n$2",
$header['header'] ?? 'group_'.$colIndex
);
$groupLabel = strip_tags($groupLabel);
foreach ($header['items'] as $item) {
$item = preg_replace('/<br>\s*<small>(.*?)<\/small>/', "\n$1", $item);
$item = strip_tags($item);
$result[] = [
'key' => 'col_'.$colIndex,
'label' => trim($item),
'group_label' => trim($groupLabel),
];
$colIndex++;
}
} else {
$header = strip_tags($header);
$result[] = [
'key' => 'col_'.$colIndex,
'label' => trim($header),
'group_label' => null,
];
$colIndex++;
}
}
return $result;
}
private function formatGradebookRows(array $headers, FlatViewDataGenerator $dataGen): array
{
$keys = array_column($headers, 'key');
$rows = [];
foreach ($dataGen->get_data() as $row) {
array_shift($row);
$cleaned = array_map(static fn ($v) => is_string($v) ? trim(strip_tags($v)) : $v, $row);
$mapped = [];
foreach ($keys as $i => $key) {
$mapped[$key] = $cleaned[$i] ?? null;
}
$rows[] = $mapped;
}
return $rows;
}
}