You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
7481 lines
227 KiB
7481 lines
227 KiB
<?php
|
|
|
|
/* For licensing terms, see /license.txt */
|
|
|
|
use Chamilo\CoreBundle\Entity\AccessUrl;
|
|
use Chamilo\CoreBundle\Entity\Course;
|
|
use Chamilo\CoreBundle\Entity\Language;
|
|
use Chamilo\CoreBundle\Entity\Session as SessionEntity;
|
|
use Chamilo\CoreBundle\Entity\SettingsCurrent;
|
|
use Chamilo\CoreBundle\Entity\User;
|
|
use Chamilo\CoreBundle\Entity\UserCourseCategory;
|
|
use Chamilo\CoreBundle\Exception\NotAllowedException;
|
|
use Chamilo\CoreBundle\Framework\Container;
|
|
use Chamilo\CoreBundle\ServiceHelper\AccessUrlHelper;
|
|
use Chamilo\CoreBundle\ServiceHelper\MailHelper;
|
|
use Chamilo\CoreBundle\ServiceHelper\PermissionServiceHelper;
|
|
use Chamilo\CoreBundle\ServiceHelper\ThemeHelper;
|
|
use Chamilo\CourseBundle\Entity\CGroup;
|
|
use Chamilo\CourseBundle\Entity\CLp;
|
|
use ChamiloSession as Session;
|
|
use Symfony\Bridge\Twig\Mime\TemplatedEmail;
|
|
use Symfony\Component\Finder\Finder;
|
|
use Symfony\Component\Mime\Address;
|
|
use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
|
|
use Symfony\Component\Security\Core\User\UserInterface;
|
|
use Symfony\Component\Validator\Constraints as Assert;
|
|
use ZipStream\Option\Archive;
|
|
use ZipStream\ZipStream;
|
|
use Chamilo\CoreBundle\Component\Utils\ActionIcon;
|
|
use Chamilo\CoreBundle\Component\Utils\ObjectIcon;
|
|
|
|
/**
|
|
* This is a code library for Chamilo.
|
|
* It is included by default in every Chamilo file (through including the global.inc.php)
|
|
* This library is in process of being transferred to src/Chamilo/CoreBundle/Component/Utils/ChamiloApi.
|
|
* Whenever a function is transferred to the ChamiloApi class, the places where it is used should include
|
|
* the "use Chamilo\CoreBundle\Component\Utils\ChamiloApi;" statement.
|
|
*/
|
|
|
|
// PHP version requirement.
|
|
define('REQUIRED_PHP_VERSION', '8.2');
|
|
define('REQUIRED_MIN_MEMORY_LIMIT', '128');
|
|
define('REQUIRED_MIN_UPLOAD_MAX_FILESIZE', '10');
|
|
define('REQUIRED_MIN_POST_MAX_SIZE', '10');
|
|
|
|
// USER STATUS CONSTANTS
|
|
/** global status of a user: student */
|
|
define('STUDENT', 5);
|
|
/** global status of a user: course manager */
|
|
define('COURSEMANAGER', 1);
|
|
/** global status of a user: session admin */
|
|
define('SESSIONADMIN', 3);
|
|
/** global status of a user: human resources manager */
|
|
define('DRH', 4);
|
|
/** global status of a user: anonymous visitor */
|
|
define('ANONYMOUS', 6);
|
|
/** global status of a user: low security, necessary for inserting data from
|
|
* the teacher through HTMLPurifier */
|
|
define('COURSEMANAGERLOWSECURITY', 10);
|
|
// Soft user status
|
|
define('PLATFORM_ADMIN', 11);
|
|
define('SESSION_COURSE_COACH', 12);
|
|
define('SESSION_GENERAL_COACH', 13);
|
|
define('COURSE_STUDENT', 14); //student subscribed in a course
|
|
define('SESSION_STUDENT', 15); //student subscribed in a session course
|
|
define('COURSE_TUTOR', 16); // student is tutor of a course (NOT in session)
|
|
define('STUDENT_BOSS', 17); // student is boss
|
|
define('INVITEE', 20);
|
|
define('HRM_REQUEST', 21); //HRM has request for vinculation with user
|
|
|
|
// COURSE VISIBILITY CONSTANTS
|
|
/** only visible for course admin */
|
|
define('COURSE_VISIBILITY_CLOSED', 0);
|
|
/** only visible for users registered in the course */
|
|
define('COURSE_VISIBILITY_REGISTERED', 1);
|
|
/** Open for all registered users on the platform */
|
|
define('COURSE_VISIBILITY_OPEN_PLATFORM', 2);
|
|
/** Open for the whole world */
|
|
define('COURSE_VISIBILITY_OPEN_WORLD', 3);
|
|
/** Invisible to all except admin */
|
|
define('COURSE_VISIBILITY_HIDDEN', 4);
|
|
|
|
define('COURSE_REQUEST_PENDING', 0);
|
|
define('COURSE_REQUEST_ACCEPTED', 1);
|
|
define('COURSE_REQUEST_REJECTED', 2);
|
|
define('DELETE_ACTION_ENABLED', false);
|
|
|
|
// EMAIL SENDING RECIPIENT CONSTANTS
|
|
define('SEND_EMAIL_EVERYONE', 1);
|
|
define('SEND_EMAIL_STUDENTS', 2);
|
|
define('SEND_EMAIL_TEACHERS', 3);
|
|
|
|
// SESSION VISIBILITY CONSTANTS
|
|
define('SESSION_VISIBLE_READ_ONLY', 1);
|
|
define('SESSION_VISIBLE', 2);
|
|
define('SESSION_INVISIBLE', 3); // not available
|
|
define('SESSION_AVAILABLE', 4);
|
|
|
|
define('SESSION_LINK_TARGET', '_self');
|
|
|
|
define('SUBSCRIBE_ALLOWED', 1);
|
|
define('SUBSCRIBE_NOT_ALLOWED', 0);
|
|
define('UNSUBSCRIBE_ALLOWED', 1);
|
|
define('UNSUBSCRIBE_NOT_ALLOWED', 0);
|
|
|
|
// SURVEY VISIBILITY CONSTANTS
|
|
define('SURVEY_VISIBLE_TUTOR', 0);
|
|
define('SURVEY_VISIBLE_TUTOR_STUDENT', 1);
|
|
define('SURVEY_VISIBLE_PUBLIC', 2);
|
|
|
|
// CONSTANTS defining all tools, using the english version
|
|
/* When you add a new tool you must add it into function api_get_tools_lists() too */
|
|
define('TOOL_DOCUMENT', 'document');
|
|
define('TOOL_LP_FINAL_ITEM', 'final_item');
|
|
define('TOOL_READOUT_TEXT', 'readout_text');
|
|
define('TOOL_THUMBNAIL', 'thumbnail');
|
|
define('TOOL_HOTPOTATOES', 'hotpotatoes');
|
|
define('TOOL_CALENDAR_EVENT', 'calendar_event');
|
|
define('TOOL_LINK', 'link');
|
|
define('TOOL_LINK_CATEGORY', 'link_category');
|
|
define('TOOL_COURSE_DESCRIPTION', 'course_description');
|
|
define('TOOL_SEARCH', 'search');
|
|
define('TOOL_LEARNPATH', 'learnpath');
|
|
define('TOOL_LEARNPATH_CATEGORY', 'learnpath_category');
|
|
define('TOOL_AGENDA', 'agenda');
|
|
define('TOOL_ANNOUNCEMENT', 'announcement');
|
|
define('TOOL_FORUM', 'forum');
|
|
define('TOOL_FORUM_CATEGORY', 'forum_category');
|
|
define('TOOL_FORUM_THREAD', 'forum_thread');
|
|
define('TOOL_FORUM_POST', 'forum_post');
|
|
define('TOOL_FORUM_ATTACH', 'forum_attachment');
|
|
define('TOOL_FORUM_THREAD_QUALIFY', 'forum_thread_qualify');
|
|
define('TOOL_THREAD', 'thread');
|
|
define('TOOL_POST', 'post');
|
|
define('TOOL_DROPBOX', 'dropbox');
|
|
define('TOOL_QUIZ', 'quiz');
|
|
define('TOOL_TEST_CATEGORY', 'test_category');
|
|
define('TOOL_USER', 'user');
|
|
define('TOOL_GROUP', 'group');
|
|
define('TOOL_BLOGS', 'blog_management');
|
|
define('TOOL_CHAT', 'chat');
|
|
define('TOOL_STUDENTPUBLICATION', 'student_publication');
|
|
define('TOOL_TRACKING', 'tracking');
|
|
define('TOOL_HOMEPAGE_LINK', 'homepage_link');
|
|
define('TOOL_COURSE_SETTING', 'course_setting');
|
|
define('TOOL_BACKUP', 'backup');
|
|
define('TOOL_COPY_COURSE_CONTENT', 'copy_course_content');
|
|
define('TOOL_RECYCLE_COURSE', 'recycle_course');
|
|
define('TOOL_COURSE_HOMEPAGE', 'course_homepage');
|
|
define('TOOL_COURSE_RIGHTS_OVERVIEW', 'course_rights');
|
|
define('TOOL_UPLOAD', 'file_upload');
|
|
define('TOOL_COURSE_MAINTENANCE', 'course_maintenance');
|
|
define('TOOL_SURVEY', 'survey');
|
|
//define('TOOL_WIKI', 'wiki');
|
|
define('TOOL_GLOSSARY', 'glossary');
|
|
define('TOOL_GRADEBOOK', 'gradebook');
|
|
define('TOOL_NOTEBOOK', 'notebook');
|
|
define('TOOL_ATTENDANCE', 'attendance');
|
|
define('TOOL_COURSE_PROGRESS', 'course_progress');
|
|
define('TOOL_PORTFOLIO', 'portfolio');
|
|
define('TOOL_PLAGIARISM', 'compilatio');
|
|
define('TOOL_XAPI', 'xapi');
|
|
|
|
// CONSTANTS defining Chamilo interface sections
|
|
define('SECTION_CAMPUS', 'mycampus');
|
|
define('SECTION_COURSES', 'mycourses');
|
|
define('SECTION_CATALOG', 'catalog');
|
|
define('SECTION_MYPROFILE', 'myprofile');
|
|
define('SECTION_MYAGENDA', 'myagenda');
|
|
define('SECTION_COURSE_ADMIN', 'course_admin');
|
|
define('SECTION_PLATFORM_ADMIN', 'platform_admin');
|
|
define('SECTION_MYGRADEBOOK', 'mygradebook');
|
|
define('SECTION_TRACKING', 'session_my_space');
|
|
define('SECTION_SOCIAL', 'social-network');
|
|
define('SECTION_DASHBOARD', 'dashboard');
|
|
define('SECTION_REPORTS', 'reports');
|
|
define('SECTION_GLOBAL', 'global');
|
|
define('SECTION_INCLUDE', 'include');
|
|
define('SECTION_CUSTOMPAGE', 'custompage');
|
|
|
|
// CONSTANT name for local authentication source
|
|
define('PLATFORM_AUTH_SOURCE', 'platform');
|
|
define('CAS_AUTH_SOURCE', 'cas');
|
|
define('LDAP_AUTH_SOURCE', 'extldap');
|
|
|
|
// event logs types
|
|
define('LOG_COURSE_DELETE', 'course_deleted');
|
|
define('LOG_COURSE_CREATE', 'course_created');
|
|
define('LOG_COURSE_SETTINGS_CHANGED', 'course_settings_changed');
|
|
|
|
// @todo replace 'soc_gr' with social_group
|
|
define('LOG_GROUP_PORTAL_CREATED', 'soc_gr_created');
|
|
define('LOG_GROUP_PORTAL_UPDATED', 'soc_gr_updated');
|
|
define('LOG_GROUP_PORTAL_DELETED', 'soc_gr_deleted');
|
|
define('LOG_GROUP_PORTAL_USER_DELETE_ALL', 'soc_gr_delete_users');
|
|
|
|
define('LOG_GROUP_PORTAL_ID', 'soc_gr_portal_id');
|
|
define('LOG_GROUP_PORTAL_REL_USER_ARRAY', 'soc_gr_user_array');
|
|
|
|
define('LOG_GROUP_PORTAL_USER_SUBSCRIBED', 'soc_gr_u_subs');
|
|
define('LOG_GROUP_PORTAL_USER_UNSUBSCRIBED', 'soc_gr_u_unsubs');
|
|
define('LOG_GROUP_PORTAL_USER_UPDATE_ROLE', 'soc_gr_update_role');
|
|
|
|
define('LOG_MESSAGE_DATA', 'message_data');
|
|
define('LOG_MESSAGE_DELETE', 'msg_deleted');
|
|
|
|
define('LOG_USER_DELETE', 'user_deleted');
|
|
define('LOG_USER_PREDELETE', 'user_predeleted');
|
|
define('LOG_USER_CREATE', 'user_created');
|
|
define('LOG_USER_UPDATE', 'user_updated');
|
|
define('LOG_USER_PASSWORD_UPDATE', 'user_password_updated');
|
|
define('LOG_USER_ENABLE', 'user_enable');
|
|
define('LOG_USER_DISABLE', 'user_disable');
|
|
define('LOG_USER_ANONYMIZE', 'user_anonymized');
|
|
define('LOG_USER_FIELD_CREATE', 'user_field_created');
|
|
define('LOG_USER_FIELD_DELETE', 'user_field_deleted');
|
|
define('LOG_SESSION_CREATE', 'session_created');
|
|
define('LOG_SESSION_DELETE', 'session_deleted');
|
|
define('LOG_SESSION_ADD_USER_COURSE', 'session_add_user_course');
|
|
define('LOG_SESSION_DELETE_USER_COURSE', 'session_delete_user_course');
|
|
define('LOG_SESSION_ADD_USER', 'session_add_user');
|
|
define('LOG_SESSION_DELETE_USER', 'session_delete_user');
|
|
define('LOG_SESSION_ADD_COURSE', 'session_add_course');
|
|
define('LOG_SESSION_DELETE_COURSE', 'session_delete_course');
|
|
define('LOG_SESSION_CATEGORY_CREATE', 'session_cat_created'); //changed in 1.9.8
|
|
define('LOG_SESSION_CATEGORY_DELETE', 'session_cat_deleted'); //changed in 1.9.8
|
|
define('LOG_CONFIGURATION_SETTINGS_CHANGE', 'settings_changed');
|
|
define('LOG_PLATFORM_LANGUAGE_CHANGE', 'platform_lng_changed'); //changed in 1.9.8
|
|
define('LOG_SUBSCRIBE_USER_TO_COURSE', 'user_subscribed');
|
|
define('LOG_UNSUBSCRIBE_USER_FROM_COURSE', 'user_unsubscribed');
|
|
define('LOG_ATTEMPTED_FORCED_LOGIN', 'attempted_forced_login');
|
|
define('LOG_PLUGIN_CHANGE', 'plugin_changed');
|
|
define('LOG_HOMEPAGE_CHANGED', 'homepage_changed');
|
|
define('LOG_PROMOTION_CREATE', 'promotion_created');
|
|
define('LOG_PROMOTION_DELETE', 'promotion_deleted');
|
|
define('LOG_CAREER_CREATE', 'career_created');
|
|
define('LOG_CAREER_DELETE', 'career_deleted');
|
|
define('LOG_USER_PERSONAL_DOC_DELETED', 'user_doc_deleted');
|
|
//define('LOG_WIKI_ACCESS', 'wiki_page_view');
|
|
// All results from an exercise
|
|
define('LOG_EXERCISE_RESULT_DELETE', 'exe_result_deleted');
|
|
// Logs only the one attempt
|
|
define('LOG_EXERCISE_ATTEMPT_DELETE', 'exe_attempt_deleted');
|
|
define('LOG_LP_ATTEMPT_DELETE', 'lp_attempt_deleted');
|
|
define('LOG_QUESTION_RESULT_DELETE', 'qst_attempt_deleted');
|
|
define('LOG_QUESTION_SCORE_UPDATE', 'score_attempt_updated');
|
|
|
|
define('LOG_MY_FOLDER_CREATE', 'my_folder_created');
|
|
define('LOG_MY_FOLDER_CHANGE', 'my_folder_changed');
|
|
define('LOG_MY_FOLDER_DELETE', 'my_folder_deleted');
|
|
define('LOG_MY_FOLDER_COPY', 'my_folder_copied');
|
|
define('LOG_MY_FOLDER_CUT', 'my_folder_cut');
|
|
define('LOG_MY_FOLDER_PASTE', 'my_folder_pasted');
|
|
define('LOG_MY_FOLDER_UPLOAD', 'my_folder_uploaded');
|
|
|
|
// Event logs data types (max 20 chars)
|
|
define('LOG_COURSE_CODE', 'course_code');
|
|
define('LOG_COURSE_ID', 'course_id');
|
|
define('LOG_USER_ID', 'user_id');
|
|
define('LOG_USER_OBJECT', 'user_object');
|
|
define('LOG_USER_FIELD_VARIABLE', 'user_field_variable');
|
|
define('LOG_SESSION_ID', 'session_id');
|
|
|
|
define('LOG_QUESTION_ID', 'question_id');
|
|
define('LOG_SESSION_CATEGORY_ID', 'session_category_id');
|
|
define('LOG_CONFIGURATION_SETTINGS_CATEGORY', 'settings_category');
|
|
define('LOG_CONFIGURATION_SETTINGS_VARIABLE', 'settings_variable');
|
|
define('LOG_PLATFORM_LANGUAGE', 'default_platform_language');
|
|
define('LOG_PLUGIN_UPLOAD', 'plugin_upload');
|
|
define('LOG_PLUGIN_ENABLE', 'plugin_enable');
|
|
define('LOG_PLUGIN_SETTINGS_CHANGE', 'plugin_settings_change');
|
|
define('LOG_CAREER_ID', 'career_id');
|
|
define('LOG_PROMOTION_ID', 'promotion_id');
|
|
define('LOG_GRADEBOOK_LOCKED', 'gradebook_locked');
|
|
define('LOG_GRADEBOOK_UNLOCKED', 'gradebook_unlocked');
|
|
define('LOG_GRADEBOOK_ID', 'gradebook_id');
|
|
//define('LOG_WIKI_PAGE_ID', 'wiki_page_id');
|
|
define('LOG_EXERCISE_ID', 'exercise_id');
|
|
define('LOG_EXERCISE_AND_USER_ID', 'exercise_and_user_id');
|
|
define('LOG_LP_ID', 'lp_id');
|
|
define('LOG_EXERCISE_ATTEMPT_QUESTION_ID', 'exercise_a_q_id');
|
|
define('LOG_EXERCISE_ATTEMPT', 'exe_id');
|
|
|
|
define('LOG_WORK_DIR_DELETE', 'work_dir_delete');
|
|
define('LOG_WORK_FILE_DELETE', 'work_file_delete');
|
|
define('LOG_WORK_DATA', 'work_data_array');
|
|
|
|
define('LOG_MY_FOLDER_PATH', 'path');
|
|
define('LOG_MY_FOLDER_NEW_PATH', 'new_path');
|
|
|
|
define('LOG_TERM_CONDITION_ACCEPTED', 'term_condition_accepted');
|
|
define('LOG_USER_CONFIRMED_EMAIL', 'user_confirmed_email');
|
|
define('LOG_USER_REMOVED_LEGAL_ACCEPT', 'user_removed_legal_accept');
|
|
|
|
define('LOG_USER_DELETE_ACCOUNT_REQUEST', 'user_delete_account_request');
|
|
|
|
define('LOG_QUESTION_CREATED', 'question_created');
|
|
define('LOG_QUESTION_UPDATED', 'question_updated');
|
|
define('LOG_QUESTION_DELETED', 'question_deleted');
|
|
define('LOG_QUESTION_REMOVED_FROM_QUIZ', 'question_removed_from_quiz');
|
|
|
|
define('LOG_SURVEY_ID', 'survey_id');
|
|
define('LOG_SURVEY_CREATED', 'survey_created');
|
|
define('LOG_SURVEY_DELETED', 'survey_deleted');
|
|
define('LOG_SURVEY_CLEAN_RESULTS', 'survey_clean_results');
|
|
define('USERNAME_PURIFIER', '/[^0-9A-Za-z_\.@\$-]/');
|
|
|
|
//used when login_is_email setting is true
|
|
define('USERNAME_PURIFIER_MAIL', '/[^0-9A-Za-z_\.@]/');
|
|
define('USERNAME_PURIFIER_SHALLOW', '/\s/');
|
|
|
|
// This constant is a result of Windows OS detection, it has a boolean value:
|
|
// true whether the server runs on Windows OS, false otherwise.
|
|
define('IS_WINDOWS_OS', api_is_windows_os());
|
|
|
|
// Patterns for processing paths. Examples.
|
|
define('REPEATED_SLASHES_PURIFIER', '/\/{2,}/'); // $path = preg_replace(REPEATED_SLASHES_PURIFIER, '/', $path);
|
|
define('VALID_WEB_PATH', '/https?:\/\/[^\/]*(\/.*)?/i'); // $is_valid_path = preg_match(VALID_WEB_PATH, $path);
|
|
// $new_path = preg_replace(VALID_WEB_SERVER_BASE, $new_base, $path);
|
|
define('VALID_WEB_SERVER_BASE', '/https?:\/\/[^\/]*/i');
|
|
// Constants for api_get_path() and api_get_path_type(), etc. - registered path types.
|
|
// basic (leaf elements)
|
|
define('REL_CODE_PATH', 'REL_CODE_PATH');
|
|
define('REL_COURSE_PATH', 'REL_COURSE_PATH');
|
|
define('REL_HOME_PATH', 'REL_HOME_PATH');
|
|
|
|
// Constants for api_get_path() and api_get_path_type(), etc. - registered path types.
|
|
define('WEB_PATH', 'WEB_PATH');
|
|
define('SYS_PATH', 'SYS_PATH');
|
|
define('SYMFONY_SYS_PATH', 'SYMFONY_SYS_PATH');
|
|
|
|
define('REL_PATH', 'REL_PATH');
|
|
define('WEB_COURSE_PATH', 'WEB_COURSE_PATH');
|
|
define('WEB_CODE_PATH', 'WEB_CODE_PATH');
|
|
define('SYS_CODE_PATH', 'SYS_CODE_PATH');
|
|
define('SYS_LANG_PATH', 'SYS_LANG_PATH');
|
|
define('WEB_IMG_PATH', 'WEB_IMG_PATH');
|
|
define('WEB_CSS_PATH', 'WEB_CSS_PATH');
|
|
define('WEB_PUBLIC_PATH', 'WEB_PUBLIC_PATH');
|
|
define('SYS_CSS_PATH', 'SYS_CSS_PATH');
|
|
define('SYS_PLUGIN_PATH', 'SYS_PLUGIN_PATH');
|
|
define('WEB_PLUGIN_PATH', 'WEB_PLUGIN_PATH');
|
|
define('WEB_PLUGIN_ASSET_PATH', 'WEB_PLUGIN_ASSET_PATH');
|
|
define('SYS_ARCHIVE_PATH', 'SYS_ARCHIVE_PATH');
|
|
define('WEB_ARCHIVE_PATH', 'WEB_ARCHIVE_PATH');
|
|
define('LIBRARY_PATH', 'LIBRARY_PATH');
|
|
define('CONFIGURATION_PATH', 'CONFIGURATION_PATH');
|
|
define('WEB_LIBRARY_PATH', 'WEB_LIBRARY_PATH');
|
|
define('WEB_LIBRARY_JS_PATH', 'WEB_LIBRARY_JS_PATH');
|
|
define('WEB_AJAX_PATH', 'WEB_AJAX_PATH');
|
|
define('SYS_TEST_PATH', 'SYS_TEST_PATH');
|
|
define('SYS_TEMPLATE_PATH', 'SYS_TEMPLATE_PATH');
|
|
define('SYS_PUBLIC_PATH', 'SYS_PUBLIC_PATH');
|
|
define('SYS_FONTS_PATH', 'SYS_FONTS_PATH');
|
|
|
|
// Relations type with Course manager
|
|
define('COURSE_RELATION_TYPE_COURSE_MANAGER', 1);
|
|
|
|
// Relations type with Human resources manager
|
|
define('COURSE_RELATION_TYPE_RRHH', 1);
|
|
|
|
// User image sizes
|
|
define('USER_IMAGE_SIZE_ORIGINAL', 1);
|
|
define('USER_IMAGE_SIZE_BIG', 2);
|
|
define('USER_IMAGE_SIZE_MEDIUM', 3);
|
|
define('USER_IMAGE_SIZE_SMALL', 4);
|
|
|
|
// Gradebook link constants
|
|
// Please do not change existing values, they are used in the database !
|
|
define('GRADEBOOK_ITEM_LIMIT', 1000);
|
|
|
|
define('LINK_EXERCISE', 1);
|
|
define('LINK_DROPBOX', 2);
|
|
define('LINK_STUDENTPUBLICATION', 3);
|
|
define('LINK_LEARNPATH', 4);
|
|
define('LINK_FORUM_THREAD', 5);
|
|
//define('LINK_WORK',6);
|
|
define('LINK_ATTENDANCE', 7);
|
|
define('LINK_SURVEY', 8);
|
|
define('LINK_HOTPOTATOES', 9);
|
|
define('LINK_PORTFOLIO', 10);
|
|
|
|
// Score display types constants
|
|
define('SCORE_DIV', 1); // X / Y
|
|
define('SCORE_PERCENT', 2); // XX %
|
|
define('SCORE_DIV_PERCENT', 3); // X / Y (XX %)
|
|
define('SCORE_AVERAGE', 4); // XX %
|
|
define('SCORE_DECIMAL', 5); // 0.50 (X/Y)
|
|
define('SCORE_BAR', 6); // Uses the Display::bar_progress function
|
|
define('SCORE_SIMPLE', 7); // X
|
|
define('SCORE_IGNORE_SPLIT', 8); // ??
|
|
define('SCORE_DIV_PERCENT_WITH_CUSTOM', 9); // X / Y (XX %) - Good!
|
|
define('SCORE_CUSTOM', 10); // Good!
|
|
define('SCORE_DIV_SIMPLE_WITH_CUSTOM', 11); // X - Good!
|
|
define('SCORE_DIV_SIMPLE_WITH_CUSTOM_LETTERS', 12); // X - Good!
|
|
define('SCORE_ONLY_SCORE', 13); // X - Good!
|
|
define('SCORE_NUMERIC', 14);
|
|
|
|
define('SCORE_BOTH', 1);
|
|
define('SCORE_ONLY_DEFAULT', 2);
|
|
define('SCORE_ONLY_CUSTOM', 3);
|
|
|
|
// From display.lib.php
|
|
|
|
define('MAX_LENGTH_BREADCRUMB', 100);
|
|
define('ICON_SIZE_ATOM', 8);
|
|
define('ICON_SIZE_TINY', 16);
|
|
define('ICON_SIZE_SMALL', 22);
|
|
define('ICON_SIZE_MEDIUM', 32);
|
|
define('ICON_SIZE_LARGE', 48);
|
|
define('ICON_SIZE_BIG', 64);
|
|
define('ICON_SIZE_HUGE', 128);
|
|
define('SHOW_TEXT_NEAR_ICONS', false);
|
|
|
|
// Session catalog
|
|
define('CATALOG_COURSES', 0);
|
|
define('CATALOG_SESSIONS', 1);
|
|
define('CATALOG_COURSES_SESSIONS', 2);
|
|
|
|
// Hook type events, pre-process and post-process.
|
|
// All means to be executed for both hook event types
|
|
define('HOOK_EVENT_TYPE_PRE', 0);
|
|
define('HOOK_EVENT_TYPE_POST', 1);
|
|
define('HOOK_EVENT_TYPE_ALL', 10);
|
|
|
|
// Group permissions
|
|
define('GROUP_PERMISSION_OPEN', '1');
|
|
define('GROUP_PERMISSION_CLOSED', '2');
|
|
|
|
// Group user permissions
|
|
define('GROUP_USER_PERMISSION_ADMIN', 1); // the admin of a group
|
|
define('GROUP_USER_PERMISSION_READER', 2); // a normal user
|
|
define('GROUP_USER_PERMISSION_PENDING_INVITATION', 3); // When an admin/moderator invites a user
|
|
define('GROUP_USER_PERMISSION_PENDING_INVITATION_SENT_BY_USER', 4); // an user joins a group
|
|
define('GROUP_USER_PERMISSION_MODERATOR', 5); // a moderator
|
|
define('GROUP_USER_PERMISSION_ANONYMOUS', 6); // an anonymous user
|
|
define('GROUP_USER_PERMISSION_HRM', 7); // a human resources manager
|
|
|
|
define('GROUP_IMAGE_SIZE_ORIGINAL', 1);
|
|
define('GROUP_IMAGE_SIZE_BIG', 2);
|
|
define('GROUP_IMAGE_SIZE_MEDIUM', 3);
|
|
define('GROUP_IMAGE_SIZE_SMALL', 4);
|
|
define('GROUP_TITLE_LENGTH', 50);
|
|
|
|
// Exercise
|
|
// @todo move into a class
|
|
define('ALL_ON_ONE_PAGE', 1);
|
|
define('ONE_PER_PAGE', 2);
|
|
|
|
define('EXERCISE_FEEDBACK_TYPE_END', 0); //Feedback - show score and expected answers
|
|
define('EXERCISE_FEEDBACK_TYPE_DIRECT', 1); //DirectFeedback - Do not show score nor answers
|
|
define('EXERCISE_FEEDBACK_TYPE_EXAM', 2); // NoFeedback - Show score only
|
|
define('EXERCISE_FEEDBACK_TYPE_POPUP', 3); // Popup BT#15827
|
|
|
|
define('RESULT_DISABLE_SHOW_SCORE_AND_EXPECTED_ANSWERS', 0); //show score and expected answers
|
|
define('RESULT_DISABLE_NO_SCORE_AND_EXPECTED_ANSWERS', 1); //Do not show score nor answers
|
|
define('RESULT_DISABLE_SHOW_SCORE_ONLY', 2); //Show score only
|
|
define('RESULT_DISABLE_SHOW_FINAL_SCORE_ONLY_WITH_CATEGORIES', 3); //Show final score only with categories
|
|
define('RESULT_DISABLE_SHOW_SCORE_ATTEMPT_SHOW_ANSWERS_LAST_ATTEMPT', 4);
|
|
define('RESULT_DISABLE_DONT_SHOW_SCORE_ONLY_IF_USER_FINISHES_ATTEMPTS_SHOW_ALWAYS_FEEDBACK', 5);
|
|
define('RESULT_DISABLE_RANKING', 6);
|
|
define('RESULT_DISABLE_SHOW_ONLY_IN_CORRECT_ANSWER', 7);
|
|
define('RESULT_DISABLE_SHOW_SCORE_AND_EXPECTED_ANSWERS_AND_RANKING', 8);
|
|
define('RESULT_DISABLE_RADAR', 9);
|
|
define('RESULT_DISABLE_SHOW_SCORE_ATTEMPT_SHOW_ANSWERS_LAST_ATTEMPT_NO_FEEDBACK', 10);
|
|
|
|
define('EXERCISE_MAX_NAME_SIZE', 80);
|
|
|
|
// Question types (edit next array as well when adding values)
|
|
// @todo move into a class
|
|
define('UNIQUE_ANSWER', 1);
|
|
define('MULTIPLE_ANSWER', 2);
|
|
define('FILL_IN_BLANKS', 3);
|
|
define('MATCHING', 4);
|
|
define('FREE_ANSWER', 5);
|
|
define('HOT_SPOT', 6);
|
|
define('HOT_SPOT_ORDER', 7);
|
|
define('HOT_SPOT_DELINEATION', 8);
|
|
define('MULTIPLE_ANSWER_COMBINATION', 9);
|
|
define('UNIQUE_ANSWER_NO_OPTION', 10);
|
|
define('MULTIPLE_ANSWER_TRUE_FALSE', 11);
|
|
define('MULTIPLE_ANSWER_COMBINATION_TRUE_FALSE', 12);
|
|
define('ORAL_EXPRESSION', 13);
|
|
define('GLOBAL_MULTIPLE_ANSWER', 14);
|
|
define('MEDIA_QUESTION', 15);
|
|
define('CALCULATED_ANSWER', 16);
|
|
define('UNIQUE_ANSWER_IMAGE', 17);
|
|
define('DRAGGABLE', 18);
|
|
define('MATCHING_DRAGGABLE', 19);
|
|
define('ANNOTATION', 20);
|
|
define('READING_COMPREHENSION', 21);
|
|
define('MULTIPLE_ANSWER_TRUE_FALSE_DEGREE_CERTAINTY', 22);
|
|
|
|
define('EXERCISE_CATEGORY_RANDOM_SHUFFLED', 1);
|
|
define('EXERCISE_CATEGORY_RANDOM_ORDERED', 2);
|
|
define('EXERCISE_CATEGORY_RANDOM_DISABLED', 0);
|
|
|
|
// Question selection type
|
|
define('EX_Q_SELECTION_ORDERED', 1);
|
|
define('EX_Q_SELECTION_RANDOM', 2);
|
|
define('EX_Q_SELECTION_CATEGORIES_ORDERED_QUESTIONS_ORDERED', 3);
|
|
define('EX_Q_SELECTION_CATEGORIES_RANDOM_QUESTIONS_ORDERED', 4);
|
|
define('EX_Q_SELECTION_CATEGORIES_ORDERED_QUESTIONS_RANDOM', 5);
|
|
define('EX_Q_SELECTION_CATEGORIES_RANDOM_QUESTIONS_RANDOM', 6);
|
|
define('EX_Q_SELECTION_CATEGORIES_RANDOM_QUESTIONS_ORDERED_NO_GROUPED', 7);
|
|
define('EX_Q_SELECTION_CATEGORIES_RANDOM_QUESTIONS_RANDOM_NO_GROUPED', 8);
|
|
define('EX_Q_SELECTION_CATEGORIES_ORDERED_BY_PARENT_QUESTIONS_ORDERED', 9);
|
|
define('EX_Q_SELECTION_CATEGORIES_ORDERED_BY_PARENT_QUESTIONS_RANDOM', 10);
|
|
|
|
// Used to save the skill_rel_item table
|
|
define('ITEM_TYPE_EXERCISE', 1);
|
|
define('ITEM_TYPE_HOTPOTATOES', 2);
|
|
define('ITEM_TYPE_LINK', 3);
|
|
define('ITEM_TYPE_LEARNPATH', 4);
|
|
define('ITEM_TYPE_GRADEBOOK', 5);
|
|
define('ITEM_TYPE_STUDENT_PUBLICATION', 6);
|
|
//define('ITEM_TYPE_FORUM', 7);
|
|
define('ITEM_TYPE_ATTENDANCE', 8);
|
|
define('ITEM_TYPE_SURVEY', 9);
|
|
define('ITEM_TYPE_FORUM_THREAD', 10);
|
|
define('ITEM_TYPE_PORTFOLIO', 11);
|
|
|
|
// Course description blocks.
|
|
define('ADD_BLOCK', 8);
|
|
|
|
// one big string with all question types, for the validator in pear/HTML/QuickForm/Rule/QuestionType
|
|
define(
|
|
'QUESTION_TYPES',
|
|
UNIQUE_ANSWER.':'.
|
|
MULTIPLE_ANSWER.':'.
|
|
FILL_IN_BLANKS.':'.
|
|
MATCHING.':'.
|
|
FREE_ANSWER.':'.
|
|
HOT_SPOT.':'.
|
|
HOT_SPOT_ORDER.':'.
|
|
HOT_SPOT_DELINEATION.':'.
|
|
MULTIPLE_ANSWER_COMBINATION.':'.
|
|
UNIQUE_ANSWER_NO_OPTION.':'.
|
|
MULTIPLE_ANSWER_TRUE_FALSE.':'.
|
|
MULTIPLE_ANSWER_COMBINATION_TRUE_FALSE.':'.
|
|
ORAL_EXPRESSION.':'.
|
|
GLOBAL_MULTIPLE_ANSWER.':'.
|
|
MEDIA_QUESTION.':'.
|
|
CALCULATED_ANSWER.':'.
|
|
UNIQUE_ANSWER_IMAGE.':'.
|
|
DRAGGABLE.':'.
|
|
MATCHING_DRAGGABLE.':'.
|
|
MULTIPLE_ANSWER_TRUE_FALSE_DEGREE_CERTAINTY.':'.
|
|
ANNOTATION
|
|
);
|
|
|
|
//Some alias used in the QTI exports
|
|
define('MCUA', 1);
|
|
define('TF', 1);
|
|
define('MCMA', 2);
|
|
define('FIB', 3);
|
|
|
|
// Message
|
|
define('MESSAGE_STATUS_INVITATION_PENDING', 5);
|
|
define('MESSAGE_STATUS_INVITATION_ACCEPTED', 6);
|
|
define('MESSAGE_STATUS_INVITATION_DENIED', 7);
|
|
define('MESSAGE_STATUS_WALL', 8);
|
|
|
|
define('MESSAGE_STATUS_WALL_DELETE', 9);
|
|
define('MESSAGE_STATUS_WALL_POST', 10);
|
|
|
|
define('MESSAGE_STATUS_FORUM', 12);
|
|
define('MESSAGE_STATUS_PROMOTED', 13);
|
|
|
|
// Images
|
|
define('IMAGE_WALL_SMALL_SIZE', 200);
|
|
define('IMAGE_WALL_MEDIUM_SIZE', 500);
|
|
define('IMAGE_WALL_BIG_SIZE', 2000);
|
|
define('IMAGE_WALL_SMALL', 'small');
|
|
define('IMAGE_WALL_MEDIUM', 'medium');
|
|
define('IMAGE_WALL_BIG', 'big');
|
|
|
|
// Social PLUGIN PLACES
|
|
define('SOCIAL_LEFT_PLUGIN', 1);
|
|
define('SOCIAL_CENTER_PLUGIN', 2);
|
|
define('SOCIAL_RIGHT_PLUGIN', 3);
|
|
define('CUT_GROUP_NAME', 50);
|
|
|
|
/**
|
|
* FormValidator Filter.
|
|
*/
|
|
define('NO_HTML', 1);
|
|
define('STUDENT_HTML', 2);
|
|
define('TEACHER_HTML', 3);
|
|
define('STUDENT_HTML_FULLPAGE', 4);
|
|
define('TEACHER_HTML_FULLPAGE', 5);
|
|
|
|
// Timeline
|
|
define('TIMELINE_STATUS_ACTIVE', '1');
|
|
define('TIMELINE_STATUS_INACTIVE', '2');
|
|
|
|
// Event email template class
|
|
define('EVENT_EMAIL_TEMPLATE_ACTIVE', 1);
|
|
define('EVENT_EMAIL_TEMPLATE_INACTIVE', 0);
|
|
|
|
// Course home
|
|
define('SHORTCUTS_HORIZONTAL', 0);
|
|
define('SHORTCUTS_VERTICAL', 1);
|
|
|
|
// Course copy
|
|
define('FILE_SKIP', 1);
|
|
define('FILE_RENAME', 2);
|
|
define('FILE_OVERWRITE', 3);
|
|
define('UTF8_CONVERT', false); //false by default
|
|
|
|
define('DOCUMENT', 'file');
|
|
define('FOLDER', 'folder');
|
|
|
|
define('RESOURCE_ASSET', 'asset');
|
|
define('RESOURCE_DOCUMENT', 'document');
|
|
define('RESOURCE_GLOSSARY', 'glossary');
|
|
define('RESOURCE_EVENT', 'calendar_event');
|
|
define('RESOURCE_LINK', 'link');
|
|
define('RESOURCE_COURSEDESCRIPTION', 'course_description');
|
|
define('RESOURCE_LEARNPATH', 'learnpath');
|
|
define('RESOURCE_LEARNPATH_CATEGORY', 'learnpath_category');
|
|
define('RESOURCE_ANNOUNCEMENT', 'announcement');
|
|
define('RESOURCE_FORUM', 'forum');
|
|
define('RESOURCE_FORUMTOPIC', 'thread');
|
|
define('RESOURCE_FORUMPOST', 'post');
|
|
define('RESOURCE_QUIZ', 'quiz');
|
|
define('RESOURCE_TEST_CATEGORY', 'test_category');
|
|
define('RESOURCE_QUIZQUESTION', 'Exercise_Question');
|
|
define('RESOURCE_TOOL_INTRO', 'Tool introduction');
|
|
define('RESOURCE_LINKCATEGORY', 'Link_Category');
|
|
define('RESOURCE_FORUMCATEGORY', 'Forum_Category');
|
|
define('RESOURCE_SCORM', 'Scorm');
|
|
define('RESOURCE_SURVEY', 'survey');
|
|
define('RESOURCE_SURVEYQUESTION', 'survey_question');
|
|
define('RESOURCE_SURVEYINVITATION', 'survey_invitation');
|
|
//define('RESOURCE_WIKI', 'wiki');
|
|
define('RESOURCE_THEMATIC', 'thematic');
|
|
define('RESOURCE_ATTENDANCE', 'attendance');
|
|
define('RESOURCE_WORK', 'work');
|
|
define('RESOURCE_SESSION_COURSE', 'session_course');
|
|
define('RESOURCE_GRADEBOOK', 'gradebook');
|
|
define('ADD_THEMATIC_PLAN', 6);
|
|
|
|
// Max online users to show per page (whoisonline)
|
|
define('MAX_ONLINE_USERS', 12);
|
|
|
|
define('TOOL_AUTHORING', 'toolauthoring');
|
|
define('TOOL_INTERACTION', 'toolinteraction');
|
|
define('TOOL_COURSE_PLUGIN', 'toolcourseplugin'); //all plugins that can be enabled in courses
|
|
define('TOOL_ADMIN', 'tooladmin');
|
|
define('TOOL_ADMIN_PLATFORM', 'tooladminplatform');
|
|
define('TOOL_DRH', 'tool_drh');
|
|
define('TOOL_STUDENT_VIEW', 'toolstudentview');
|
|
define('TOOL_ADMIN_VISIBLE', 'tooladminvisible');
|
|
|
|
// Search settings (from main/inc/lib/search/IndexableChunk.class.php )
|
|
// some constants to avoid serialize string keys on serialized data array
|
|
define('SE_COURSE_ID', 0);
|
|
define('SE_TOOL_ID', 1);
|
|
define('SE_DATA', 2);
|
|
define('SE_USER', 3);
|
|
|
|
// in some cases we need top differenciate xapian documents of the same tool
|
|
define('SE_DOCTYPE_EXERCISE_EXERCISE', 0);
|
|
define('SE_DOCTYPE_EXERCISE_QUESTION', 1);
|
|
|
|
// xapian prefixes
|
|
define('XAPIAN_PREFIX_COURSEID', 'C');
|
|
define('XAPIAN_PREFIX_TOOLID', 'O');
|
|
|
|
// User active field constants
|
|
define('USER_ACTIVE', 1);
|
|
define('USER_INACTIVE', 0);
|
|
define('USER_INACTIVE_AUTOMATIC', -1);
|
|
define('USER_SOFT_DELETED', -2);
|
|
|
|
/**
|
|
* Returns a path to a certain resource within Chamilo.
|
|
*
|
|
* @param string $path A path which type is to be converted. Also, it may be a defined constant for a path.
|
|
*
|
|
* @return string the requested path or the converted path
|
|
*
|
|
* Notes about the current behaviour model:
|
|
* 1. Windows back-slashes are converted to slashes in the result.
|
|
* 2. A semi-absolute web-path is detected by its leading slash. On Linux systems, absolute system paths start with
|
|
* a slash too, so an additional check about presence of leading system server base is implemented. For example, the function is
|
|
* able to distinguish type difference between /var/www/chamilo/courses/ (SYS) and /chamilo/courses/ (REL).
|
|
* 3. The function api_get_path() returns only these three types of paths, which in some sense are absolute. The function has
|
|
* no a mechanism for processing relative web/system paths, such as: lesson01.html, ./lesson01.html, ../css/my_styles.css.
|
|
* It has not been identified as needed yet.
|
|
* 4. Also, resolving the meta-symbols "." and ".." within paths has not been implemented, it is to be identified as needed.
|
|
*
|
|
* Vchamilo changes : allow using an alternate configuration
|
|
* to get vchamilo instance paths
|
|
*/
|
|
function api_get_path($path = '', $configuration = [])
|
|
{
|
|
global $paths;
|
|
|
|
// get proper configuration data if exists
|
|
global $_configuration;
|
|
|
|
$emptyConfigurationParam = false;
|
|
if (empty($configuration)) {
|
|
$configuration = (array) $_configuration;
|
|
$emptyConfigurationParam = true;
|
|
}
|
|
|
|
$root_sys = Container::getProjectDir();
|
|
$root_web = '';
|
|
if (isset(Container::$container)) {
|
|
$root_web = Container::$container->get('router')->generate(
|
|
'index',
|
|
[],
|
|
UrlGeneratorInterface::ABSOLUTE_URL
|
|
);
|
|
}
|
|
|
|
/*if (api_get_multiple_access_url()) {
|
|
// To avoid that the api_get_access_url() function fails since global.inc.php also calls the main_api.lib.php
|
|
if (isset($configuration['access_url']) && !empty($configuration['access_url'])) {
|
|
// We look into the DB the function api_get_access_url
|
|
$urlInfo = api_get_access_url($configuration['access_url']);
|
|
// Avoid default value
|
|
$defaultValues = ['http://localhost/', 'https://localhost/'];
|
|
if (!empty($urlInfo['url']) && !in_array($urlInfo['url'], $defaultValues)) {
|
|
$root_web = 1 == $urlInfo['active'] ? $urlInfo['url'] : $configuration['root_web'];
|
|
}
|
|
}
|
|
}*/
|
|
|
|
$paths = [
|
|
WEB_PATH => $root_web,
|
|
SYMFONY_SYS_PATH => $root_sys,
|
|
SYS_PATH => $root_sys.'public/',
|
|
REL_PATH => '',
|
|
CONFIGURATION_PATH => 'app/config/',
|
|
LIBRARY_PATH => $root_sys.'public/main/inc/lib/',
|
|
|
|
REL_COURSE_PATH => '',
|
|
REL_CODE_PATH => '/main/',
|
|
|
|
SYS_CODE_PATH => $root_sys.'public/main/',
|
|
SYS_CSS_PATH => $root_sys.'public/build/css/',
|
|
SYS_PLUGIN_PATH => $root_sys.'public/plugin/',
|
|
SYS_ARCHIVE_PATH => $root_sys.'var/cache/',
|
|
SYS_TEST_PATH => $root_sys.'tests/',
|
|
SYS_TEMPLATE_PATH => $root_sys.'public/main/template/',
|
|
SYS_PUBLIC_PATH => $root_sys.'public/',
|
|
SYS_FONTS_PATH => $root_sys.'public/fonts/',
|
|
|
|
WEB_CODE_PATH => $root_web.'main/',
|
|
WEB_PLUGIN_ASSET_PATH => $root_web.'plugins/',
|
|
WEB_COURSE_PATH => $root_web.'course/',
|
|
WEB_IMG_PATH => $root_web.'img/',
|
|
WEB_CSS_PATH => $root_web.'build/css/',
|
|
WEB_AJAX_PATH => $root_web.'main/inc/ajax/',
|
|
WEB_LIBRARY_PATH => $root_web.'main/inc/lib/',
|
|
WEB_LIBRARY_JS_PATH => $root_web.'main/inc/lib/javascript/',
|
|
WEB_PLUGIN_PATH => $root_web.'plugin/',
|
|
WEB_PUBLIC_PATH => $root_web,
|
|
];
|
|
|
|
$root_rel = '';
|
|
|
|
global $virtualChamilo;
|
|
if (!empty($virtualChamilo)) {
|
|
$paths[SYS_ARCHIVE_PATH] = api_add_trailing_slash($virtualChamilo[SYS_ARCHIVE_PATH]);
|
|
//$paths[SYS_UPLOAD_PATH] = api_add_trailing_slash($virtualChamilo[SYS_UPLOAD_PATH]);
|
|
//$paths[$root_web][WEB_UPLOAD_PATH] = api_add_trailing_slash($virtualChamilo[WEB_UPLOAD_PATH]);
|
|
$paths[WEB_ARCHIVE_PATH] = api_add_trailing_slash($virtualChamilo[WEB_ARCHIVE_PATH]);
|
|
//$paths[$root_web][WEB_COURSE_PATH] = api_add_trailing_slash($virtualChamilo[WEB_COURSE_PATH]);
|
|
|
|
// WEB_UPLOAD_PATH should be handle by apache htaccess in the vhost
|
|
|
|
// RewriteEngine On
|
|
// RewriteRule /app/upload/(.*)$ http://localhost/other/upload/my-chamilo111-net/$1 [QSA,L]
|
|
|
|
//$paths[$root_web][WEB_UPLOAD_PATH] = api_add_trailing_slash($virtualChamilo[WEB_UPLOAD_PATH]);
|
|
//$paths[$root_web][REL_PATH] = $virtualChamilo[REL_PATH];
|
|
//$paths[$root_web][REL_COURSE_PATH] = $virtualChamilo[REL_COURSE_PATH];
|
|
}
|
|
|
|
$path = trim($path);
|
|
|
|
// Retrieving a common-purpose path.
|
|
if (isset($paths[$path])) {
|
|
return $paths[$path];
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Adds to a given path a trailing slash if it is necessary (adds "/" character at the end of the string).
|
|
*
|
|
* @param string $path the input path
|
|
*
|
|
* @return string returns the modified path
|
|
*/
|
|
function api_add_trailing_slash($path)
|
|
{
|
|
return '/' === substr($path, -1) ? $path : $path.'/';
|
|
}
|
|
|
|
/**
|
|
* Removes from a given path the trailing slash if it is necessary (removes "/" character from the end of the string).
|
|
*
|
|
* @param string $path the input path
|
|
*
|
|
* @return string returns the modified path
|
|
*/
|
|
function api_remove_trailing_slash($path)
|
|
{
|
|
return '/' === substr($path, -1) ? substr($path, 0, -1) : $path;
|
|
}
|
|
|
|
/**
|
|
* Checks the RFC 3986 syntax of a given URL.
|
|
*
|
|
* @param string $url the URL to be checked
|
|
* @param bool $absolute whether the URL is absolute (beginning with a scheme such as "http:")
|
|
*
|
|
* @return string|false Returns the URL if it is valid, FALSE otherwise.
|
|
* This function is an adaptation from the function valid_url(), Drupal CMS.
|
|
*
|
|
* @see http://drupal.org
|
|
* Note: The built-in function filter_var($urs, FILTER_VALIDATE_URL) has a bug for some versions of PHP.
|
|
* @see http://bugs.php.net/51192
|
|
*/
|
|
function api_valid_url($url, $absolute = false)
|
|
{
|
|
if ($absolute) {
|
|
if (preg_match("
|
|
/^ # Start at the beginning of the text
|
|
(?:ftp|https?|feed):\/\/ # Look for ftp, http, https or feed schemes
|
|
(?: # Userinfo (optional) which is typically
|
|
(?:(?:[\w\.\-\+!$&'\(\)*\+,;=]|%[0-9a-f]{2})+:)* # a username or a username and password
|
|
(?:[\w\.\-\+%!$&'\(\)*\+,;=]|%[0-9a-f]{2})+@ # combination
|
|
)?
|
|
(?:
|
|
(?:[a-z0-9\-\.]|%[0-9a-f]{2})+ # A domain name or a IPv4 address
|
|
|(?:\[(?:[0-9a-f]{0,4}:)*(?:[0-9a-f]{0,4})\]) # or a well formed IPv6 address
|
|
)
|
|
(?::[0-9]+)? # Server port number (optional)
|
|
(?:[\/|\?]
|
|
(?:[\w#!:\.\?\+=&@$'~*,;\/\(\)\[\]\-]|%[0-9a-f]{2}) # The path and query (optional)
|
|
*)?
|
|
$/xi", $url)) {
|
|
return $url;
|
|
}
|
|
|
|
return false;
|
|
} else {
|
|
return preg_match("/^(?:[\w#!:\.\?\+=&@$'~*,;\/\(\)\[\]\-]|%[0-9a-f]{2})+$/i", $url) ? $url : false;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Checks whether a given string looks roughly like an email address.
|
|
*
|
|
* @param string $address the e-mail address to be checked
|
|
*
|
|
* @return mixed returns the e-mail if it is valid, FALSE otherwise
|
|
*/
|
|
function api_valid_email($address)
|
|
{
|
|
return filter_var($address, FILTER_VALIDATE_EMAIL);
|
|
}
|
|
|
|
/**
|
|
* Function used to protect a course script.
|
|
* The function blocks access when
|
|
* - there is no $_SESSION["_course"] defined; or
|
|
* - $is_allowed_in_course is set to false (this depends on the course
|
|
* visibility and user status).
|
|
*
|
|
* This is only the first proposal, test and improve!
|
|
*
|
|
* @param bool Option to print headers when displaying error message. Default: false
|
|
* @param bool whether session admins should be allowed or not
|
|
* @param string $checkTool check if tool is available for users (user, group)
|
|
*
|
|
* @return bool True if the user has access to the current course or is out of a course context, false otherwise
|
|
*
|
|
* @todo replace global variable
|
|
*
|
|
* @author Roan Embrechts
|
|
*/
|
|
function api_protect_course_script($print_headers = false, $allow_session_admins = false, string $checkTool = '', $cid = null): bool
|
|
{
|
|
$course_info = api_get_course_info();
|
|
if (empty($course_info) && isset($_REQUEST['cid'])) {
|
|
$course_info = api_get_course_info_by_id((int) $_REQUEST['cid']);
|
|
}
|
|
|
|
if (isset($cid)) {
|
|
$course_info = api_get_course_info_by_id($cid);
|
|
}
|
|
|
|
if (empty($course_info)) {
|
|
api_not_allowed($print_headers);
|
|
|
|
return false;
|
|
}
|
|
|
|
if (api_is_drh()) {
|
|
return true;
|
|
}
|
|
|
|
// Session admin has access to course
|
|
$sessionAccess = ('true' === api_get_setting('session.session_admins_access_all_content'));
|
|
if ($sessionAccess) {
|
|
$allow_session_admins = true;
|
|
}
|
|
|
|
if (api_is_platform_admin($allow_session_admins)) {
|
|
return true;
|
|
}
|
|
|
|
$isAllowedInCourse = api_is_allowed_in_course();
|
|
$is_visible = false;
|
|
if (isset($course_info) && isset($course_info['visibility'])) {
|
|
switch ($course_info['visibility']) {
|
|
default:
|
|
case Course::CLOSED:
|
|
// Completely closed: the course is only accessible to the teachers. - 0
|
|
if ($isAllowedInCourse && api_get_user_id() && !api_is_anonymous()) {
|
|
$is_visible = true;
|
|
}
|
|
break;
|
|
case Course::REGISTERED:
|
|
// Private - access authorized to course members only - 1
|
|
if ($isAllowedInCourse && api_get_user_id() && !api_is_anonymous()) {
|
|
$is_visible = true;
|
|
}
|
|
break;
|
|
case Course::OPEN_PLATFORM:
|
|
// Open - access allowed for users registered on the platform - 2
|
|
if ($isAllowedInCourse && api_get_user_id() && !api_is_anonymous()) {
|
|
$is_visible = true;
|
|
}
|
|
break;
|
|
case Course::OPEN_WORLD:
|
|
//Open - access allowed for the whole world - 3
|
|
$is_visible = true;
|
|
break;
|
|
case Course::HIDDEN:
|
|
//Completely closed: the course is only accessible to the teachers. - 0
|
|
if (api_is_platform_admin()) {
|
|
$is_visible = true;
|
|
}
|
|
break;
|
|
}
|
|
|
|
//If password is set and user is not registered to the course then the course is not visible
|
|
if (false === $isAllowedInCourse &&
|
|
isset($course_info['registration_code']) &&
|
|
!empty($course_info['registration_code'])
|
|
) {
|
|
$is_visible = false;
|
|
}
|
|
}
|
|
|
|
if (!empty($checkTool)) {
|
|
if (!api_is_allowed_to_edit(true, true, true)) {
|
|
$toolInfo = api_get_tool_information_by_name($checkTool);
|
|
if (!empty($toolInfo) && isset($toolInfo['visibility']) && 0 == $toolInfo['visibility']) {
|
|
api_not_allowed(true);
|
|
|
|
return false;
|
|
}
|
|
}
|
|
}
|
|
|
|
// Check session visibility
|
|
$session_id = api_get_session_id();
|
|
|
|
if (!empty($session_id)) {
|
|
// $isAllowedInCourse was set in local.inc.php
|
|
if (!$isAllowedInCourse) {
|
|
$is_visible = false;
|
|
}
|
|
// Check if course is inside session.
|
|
if (!SessionManager::relation_session_course_exist($session_id, $course_info['real_id'])) {
|
|
$is_visible = false;
|
|
}
|
|
}
|
|
|
|
if (!$is_visible) {
|
|
api_not_allowed($print_headers);
|
|
|
|
return false;
|
|
}
|
|
|
|
if ($is_visible && 'true' === api_get_plugin_setting('positioning', 'tool_enable')) {
|
|
$plugin = Positioning::create();
|
|
$block = $plugin->get('block_course_if_initial_exercise_not_attempted');
|
|
if ('true' === $block) {
|
|
$currentPath = $_SERVER['PHP_SELF'];
|
|
// Allowed only this course paths.
|
|
$paths = [
|
|
'/plugin/positioning/start.php',
|
|
'/plugin/positioning/start_student.php',
|
|
'/main/course_home/course_home.php',
|
|
'/main/exercise/overview.php',
|
|
];
|
|
|
|
if (!in_array($currentPath, $paths, true)) {
|
|
// Check if entering an exercise.
|
|
// @todo remove global $current_course_tool
|
|
/*global $current_course_tool;
|
|
if ('quiz' !== $current_course_tool) {
|
|
$initialData = $plugin->getInitialExercise($course_info['real_id'], $session_id);
|
|
if ($initialData && isset($initialData['exercise_id'])) {
|
|
$results = Event::getExerciseResultsByUser(
|
|
api_get_user_id(),
|
|
$initialData['exercise_id'],
|
|
$course_info['real_id'],
|
|
$session_id
|
|
);
|
|
if (empty($results)) {
|
|
api_not_allowed($print_headers);
|
|
|
|
return false;
|
|
}
|
|
}
|
|
}*/
|
|
}
|
|
}
|
|
}
|
|
|
|
api_block_inactive_user();
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Function used to protect an admin script.
|
|
*
|
|
* The function blocks access when the user has no platform admin rights
|
|
* with an error message printed on default output
|
|
*
|
|
* @param bool Whether to allow session admins as well
|
|
* @param bool Whether to allow HR directors as well
|
|
* @param string An optional message (already passed through get_lang)
|
|
*
|
|
* @return bool True if user is allowed, false otherwise.
|
|
* The function also outputs an error message in case not allowed
|
|
*
|
|
* @author Roan Embrechts (original author)
|
|
*/
|
|
function api_protect_admin_script($allow_sessions_admins = false, $allow_drh = false, $message = null)
|
|
{
|
|
if (!api_is_platform_admin($allow_sessions_admins, $allow_drh)) {
|
|
api_not_allowed(true, $message);
|
|
|
|
return false;
|
|
}
|
|
api_block_inactive_user();
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Blocks inactive users with a currently active session from accessing more pages "live".
|
|
*
|
|
* @return bool Returns true if the feature is disabled or the user account is still enabled.
|
|
* Returns false (and shows a message) if the feature is enabled *and* the user is disabled.
|
|
*/
|
|
function api_block_inactive_user()
|
|
{
|
|
$data = true;
|
|
if ('true' !== api_get_setting('security.security_block_inactive_users_immediately')) {
|
|
return $data;
|
|
}
|
|
|
|
$userId = api_get_user_id();
|
|
$homeUrl = api_get_path(WEB_PATH);
|
|
if (0 == $userId) {
|
|
return $data;
|
|
}
|
|
|
|
$sql = "SELECT active FROM ".Database::get_main_table(TABLE_MAIN_USER)."
|
|
WHERE id = $userId";
|
|
|
|
$result = Database::query($sql);
|
|
if (Database::num_rows($result) > 0) {
|
|
$result_array = Database::fetch_array($result);
|
|
$data = (bool) $result_array['active'];
|
|
}
|
|
if (false == $data) {
|
|
$tpl = new Template(null, true, true, false, true, false, true, 0);
|
|
$tpl->assign('hide_login_link', 1);
|
|
|
|
//api_not_allowed(true, get_lang('Account inactive'));
|
|
// we were not in a course, return to home page
|
|
$msg = Display::return_message(
|
|
get_lang('Account inactive'),
|
|
'error',
|
|
false
|
|
);
|
|
|
|
$msg .= '<p class="text-center">
|
|
<a class="btn btn--plain" href="'.$homeUrl.'">'.get_lang('Back to Home Page.').'</a></p>';
|
|
|
|
$tpl->assign('content', $msg);
|
|
$tpl->display_one_col_template();
|
|
exit;
|
|
}
|
|
|
|
return $data;
|
|
}
|
|
|
|
/**
|
|
* Function used to protect a teacher script.
|
|
* The function blocks access when the user has no teacher rights.
|
|
*
|
|
* @return bool True if the current user can access the script, false otherwise
|
|
*
|
|
* @author Yoselyn Castillo
|
|
*/
|
|
function api_protect_teacher_script()
|
|
{
|
|
if (!api_is_allowed_to_edit()) {
|
|
api_not_allowed(true);
|
|
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Function used to prevent anonymous users from accessing a script.
|
|
*
|
|
* @param bool $printHeaders
|
|
*
|
|
* @return bool
|
|
*/
|
|
function api_block_anonymous_users($printHeaders = true)
|
|
{
|
|
$isAuth = Container::getAuthorizationChecker()->isGranted('IS_AUTHENTICATED');
|
|
|
|
if (false === $isAuth) {
|
|
api_not_allowed($printHeaders);
|
|
|
|
return false;
|
|
}
|
|
|
|
api_block_inactive_user();
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Returns a rough evaluation of the browser's name and version based on very
|
|
* simple regexp.
|
|
*
|
|
* @return array with the navigator name and version ['name' => '...', 'version' => '...']
|
|
*/
|
|
function api_get_navigator()
|
|
{
|
|
$navigator = 'Unknown';
|
|
$version = 0;
|
|
|
|
if (!isset($_SERVER['HTTP_USER_AGENT'])) {
|
|
return ['name' => 'Unknown', 'version' => '0.0.0'];
|
|
}
|
|
|
|
if (false !== strpos($_SERVER['HTTP_USER_AGENT'], 'Opera')) {
|
|
$navigator = 'Opera';
|
|
[, $version] = explode('Opera', $_SERVER['HTTP_USER_AGENT']);
|
|
} elseif (false !== strpos($_SERVER['HTTP_USER_AGENT'], 'Edge')) {
|
|
$navigator = 'Edge';
|
|
[, $version] = explode('Edge', $_SERVER['HTTP_USER_AGENT']);
|
|
} elseif (false !== strpos($_SERVER['HTTP_USER_AGENT'], 'MSIE')) {
|
|
$navigator = 'Internet Explorer';
|
|
[, $version] = explode('MSIE ', $_SERVER['HTTP_USER_AGENT']);
|
|
} elseif (false !== strpos($_SERVER['HTTP_USER_AGENT'], 'Chrome')) {
|
|
$navigator = 'Chrome';
|
|
[, $version] = explode('Chrome', $_SERVER['HTTP_USER_AGENT']);
|
|
} elseif (false !== stripos($_SERVER['HTTP_USER_AGENT'], 'Safari')) {
|
|
$navigator = 'Safari';
|
|
if (false !== stripos($_SERVER['HTTP_USER_AGENT'], 'Version/')) {
|
|
// If this Safari does have the "Version/" string in its user agent
|
|
// then use that as a version indicator rather than what's after
|
|
// "Safari/" which is rather a "build number" or something
|
|
[, $version] = explode('Version/', $_SERVER['HTTP_USER_AGENT']);
|
|
} else {
|
|
[, $version] = explode('Safari/', $_SERVER['HTTP_USER_AGENT']);
|
|
}
|
|
} elseif (false !== strpos($_SERVER['HTTP_USER_AGENT'], 'Firefox')) {
|
|
$navigator = 'Firefox';
|
|
[, $version] = explode('Firefox', $_SERVER['HTTP_USER_AGENT']);
|
|
} elseif (false !== strpos($_SERVER['HTTP_USER_AGENT'], 'Netscape')) {
|
|
$navigator = 'Netscape';
|
|
if (false !== stripos($_SERVER['HTTP_USER_AGENT'], 'Netscape/')) {
|
|
[, $version] = explode('Netscape', $_SERVER['HTTP_USER_AGENT']);
|
|
} else {
|
|
[, $version] = explode('Navigator', $_SERVER['HTTP_USER_AGENT']);
|
|
}
|
|
} elseif (false !== strpos($_SERVER['HTTP_USER_AGENT'], 'Konqueror')) {
|
|
$navigator = 'Konqueror';
|
|
[, $version] = explode('Konqueror', $_SERVER['HTTP_USER_AGENT']);
|
|
} elseif (false !== stripos($_SERVER['HTTP_USER_AGENT'], 'applewebkit')) {
|
|
$navigator = 'AppleWebKit';
|
|
[, $version] = explode('Version/', $_SERVER['HTTP_USER_AGENT']);
|
|
} elseif (false !== strpos($_SERVER['HTTP_USER_AGENT'], 'Gecko')) {
|
|
$navigator = 'Mozilla';
|
|
[, $version] = explode('; rv:', $_SERVER['HTTP_USER_AGENT']);
|
|
}
|
|
|
|
// Now cut extra stuff around (mostly *after*) the version number
|
|
$version = preg_replace('/^([\/\s])?([\d\.]+)?.*/', '\2', $version);
|
|
|
|
if (false === strpos($version, '.')) {
|
|
$version = number_format(doubleval($version), 1);
|
|
}
|
|
|
|
return ['name' => $navigator, 'version' => $version];
|
|
}
|
|
|
|
/**
|
|
* This function returns the id of the user which is stored in the $_user array.
|
|
*
|
|
* example: The function can be used to check if a user is logged in
|
|
* if (api_get_user_id())
|
|
*
|
|
* @return int the id of the current user, 0 if is empty
|
|
*/
|
|
function api_get_user_id()
|
|
{
|
|
$userInfo = Session::read('_user');
|
|
if ($userInfo && isset($userInfo['user_id'])) {
|
|
return (int) $userInfo['user_id'];
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
/**
|
|
* Formats user information into a standard array
|
|
* This function should be only used inside api_get_user_info().
|
|
*
|
|
* @param array Non-standard user array
|
|
* @param bool $add_password
|
|
* @param bool $loadAvatars turn off to improve performance
|
|
*
|
|
* @return array Standard user array
|
|
*/
|
|
function _api_format_user($user, $add_password = false, $loadAvatars = true)
|
|
{
|
|
$result = [];
|
|
|
|
if (!isset($user['id'])) {
|
|
return [];
|
|
}
|
|
|
|
$result['firstname'] = null;
|
|
$result['lastname'] = null;
|
|
|
|
if (isset($user['firstname']) && isset($user['lastname'])) {
|
|
// with only lowercase
|
|
$result['firstname'] = $user['firstname'];
|
|
$result['lastname'] = $user['lastname'];
|
|
} elseif (isset($user['firstName']) && isset($user['lastName'])) {
|
|
// with uppercase letters
|
|
$result['firstname'] = isset($user['firstName']) ? $user['firstName'] : null;
|
|
$result['lastname'] = isset($user['lastName']) ? $user['lastName'] : null;
|
|
}
|
|
|
|
if (isset($user['email'])) {
|
|
$result['mail'] = isset($user['email']) ? $user['email'] : null;
|
|
$result['email'] = isset($user['email']) ? $user['email'] : null;
|
|
} else {
|
|
$result['mail'] = isset($user['mail']) ? $user['mail'] : null;
|
|
$result['email'] = isset($user['mail']) ? $user['mail'] : null;
|
|
}
|
|
|
|
$result['complete_name'] = api_get_person_name($result['firstname'], $result['lastname']);
|
|
$result['complete_name_with_username'] = $result['complete_name'];
|
|
|
|
if (!empty($user['username']) && 'false' === api_get_setting('profile.hide_username_with_complete_name')) {
|
|
$result['complete_name_with_username'] = $result['complete_name'].' ('.$user['username'].')';
|
|
}
|
|
|
|
$showEmail = 'true' === api_get_setting('show_email_addresses');
|
|
if (!empty($user['email'])) {
|
|
$result['complete_name_with_email_forced'] = $result['complete_name'].' ('.$user['email'].')';
|
|
if ($showEmail) {
|
|
$result['complete_name_with_email'] = $result['complete_name'].' ('.$user['email'].')';
|
|
}
|
|
} else {
|
|
$result['complete_name_with_email'] = $result['complete_name'];
|
|
$result['complete_name_with_email_forced'] = $result['complete_name'];
|
|
}
|
|
|
|
// Kept for historical reasons
|
|
$result['firstName'] = $result['firstname'];
|
|
$result['lastName'] = $result['lastname'];
|
|
|
|
$attributes = [
|
|
'phone',
|
|
'address',
|
|
'picture_uri',
|
|
'official_code',
|
|
'status',
|
|
'active',
|
|
'auth_source',
|
|
'username',
|
|
'theme',
|
|
'language',
|
|
'locale',
|
|
'creator_id',
|
|
'registration_date',
|
|
'hr_dept_id',
|
|
'expiration_date',
|
|
'last_login',
|
|
'user_is_online',
|
|
'profile_completed',
|
|
];
|
|
|
|
if ('true' === api_get_setting('extended_profile')) {
|
|
$attributes[] = 'competences';
|
|
$attributes[] = 'diplomas';
|
|
$attributes[] = 'teach';
|
|
$attributes[] = 'openarea';
|
|
}
|
|
|
|
foreach ($attributes as $attribute) {
|
|
$result[$attribute] = $user[$attribute] ?? null;
|
|
}
|
|
|
|
$user_id = (int) $user['id'];
|
|
// Maintain the user_id index for backwards compatibility
|
|
$result['user_id'] = $result['id'] = $user_id;
|
|
|
|
$hasCertificates = Certificate::getCertificateByUser($user_id);
|
|
$result['has_certificates'] = 0;
|
|
if (!empty($hasCertificates)) {
|
|
$result['has_certificates'] = 1;
|
|
}
|
|
|
|
$result['icon_status'] = '';
|
|
$result['icon_status_medium'] = '';
|
|
$result['is_admin'] = UserManager::is_admin($user_id);
|
|
|
|
// Getting user avatar.
|
|
if ($loadAvatars) {
|
|
$result['avatar'] = '';
|
|
$result['avatar_no_query'] = '';
|
|
$result['avatar_small'] = '';
|
|
$result['avatar_medium'] = '';
|
|
|
|
if (empty($user['avatar'])) {
|
|
$originalFile = UserManager::getUserPicture(
|
|
$user_id,
|
|
USER_IMAGE_SIZE_ORIGINAL,
|
|
null,
|
|
$result
|
|
);
|
|
$result['avatar'] = $originalFile;
|
|
$avatarString = explode('?', $result['avatar']);
|
|
$result['avatar_no_query'] = reset($avatarString);
|
|
} else {
|
|
$result['avatar'] = $user['avatar'];
|
|
$avatarString = explode('?', $user['avatar']);
|
|
$result['avatar_no_query'] = reset($avatarString);
|
|
}
|
|
|
|
if (!isset($user['avatar_small'])) {
|
|
$smallFile = UserManager::getUserPicture(
|
|
$user_id,
|
|
USER_IMAGE_SIZE_SMALL,
|
|
null,
|
|
$result
|
|
);
|
|
$result['avatar_small'] = $smallFile;
|
|
} else {
|
|
$result['avatar_small'] = $user['avatar_small'];
|
|
}
|
|
|
|
if (!isset($user['avatar_medium'])) {
|
|
$mediumFile = UserManager::getUserPicture(
|
|
$user_id,
|
|
USER_IMAGE_SIZE_MEDIUM,
|
|
null,
|
|
$result
|
|
);
|
|
$result['avatar_medium'] = $mediumFile;
|
|
} else {
|
|
$result['avatar_medium'] = $user['avatar_medium'];
|
|
}
|
|
|
|
$urlImg = api_get_path(WEB_IMG_PATH);
|
|
$iconStatus = '';
|
|
$iconStatusMedium = '';
|
|
$label = '';
|
|
|
|
switch ($result['status']) {
|
|
case STUDENT:
|
|
if ($result['has_certificates']) {
|
|
$iconStatus = $urlImg.'icons/svg/identifier_graduated.svg';
|
|
$label = get_lang('Graduated');
|
|
} else {
|
|
$iconStatus = $urlImg.'icons/svg/identifier_student.svg';
|
|
$label = get_lang('Student');
|
|
}
|
|
break;
|
|
case COURSEMANAGER:
|
|
if ($result['is_admin']) {
|
|
$iconStatus = $urlImg.'icons/svg/identifier_admin.svg';
|
|
$label = get_lang('Admin');
|
|
} else {
|
|
$iconStatus = $urlImg.'icons/svg/identifier_teacher.svg';
|
|
$label = get_lang('Teacher');
|
|
}
|
|
break;
|
|
case STUDENT_BOSS:
|
|
$iconStatus = $urlImg.'icons/svg/identifier_teacher.svg';
|
|
$label = get_lang('StudentBoss');
|
|
break;
|
|
}
|
|
|
|
if (!empty($iconStatus)) {
|
|
$iconStatusMedium = '<img src="'.$iconStatus.'" width="32px" height="32px">';
|
|
$iconStatus = '<img src="'.$iconStatus.'" width="22px" height="22px">';
|
|
}
|
|
|
|
$result['icon_status'] = $iconStatus;
|
|
$result['icon_status_label'] = $label;
|
|
$result['icon_status_medium'] = $iconStatusMedium;
|
|
}
|
|
|
|
if (isset($user['user_is_online'])) {
|
|
$result['user_is_online'] = true == $user['user_is_online'] ? 1 : 0;
|
|
}
|
|
if (isset($user['user_is_online_in_chat'])) {
|
|
$result['user_is_online_in_chat'] = (int) $user['user_is_online_in_chat'];
|
|
}
|
|
|
|
if ($add_password) {
|
|
$result['password'] = $user['password'];
|
|
}
|
|
|
|
if (isset($result['profile_completed'])) {
|
|
$result['profile_completed'] = $user['profile_completed'];
|
|
}
|
|
|
|
$result['profile_url'] = api_get_path(WEB_CODE_PATH).'social/profile.php?u='.$user_id;
|
|
|
|
// Send message link
|
|
$sendMessage = api_get_path(WEB_AJAX_PATH).'user_manager.ajax.php?a=get_user_popup&user_id='.$user_id;
|
|
$result['complete_name_with_message_link'] = Display::url(
|
|
$result['complete_name_with_username'],
|
|
$sendMessage,
|
|
['class' => 'ajax']
|
|
);
|
|
|
|
if (isset($user['extra'])) {
|
|
$result['extra'] = $user['extra'];
|
|
}
|
|
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* Finds all the information about a user.
|
|
* If no parameter is passed you find all the information about the current user.
|
|
*
|
|
* @param int $user_id
|
|
* @param bool $checkIfUserOnline
|
|
* @param bool $showPassword
|
|
* @param bool $loadExtraData
|
|
* @param bool $loadOnlyVisibleExtraData Get the user extra fields that are visible
|
|
* @param bool $loadAvatars turn off to improve performance and if avatars are not needed
|
|
* @param bool $updateCache update apc cache if exists
|
|
*
|
|
* @return mixed $user_info user_id, lastname, firstname, username, email, etc or false on error
|
|
*
|
|
* @author Patrick Cool <patrick.cool@UGent.be>
|
|
* @author Julio Montoya
|
|
*
|
|
* @version 21 September 2004
|
|
*/
|
|
function api_get_user_info(
|
|
$user_id = 0,
|
|
$checkIfUserOnline = false,
|
|
$showPassword = false,
|
|
$loadExtraData = false,
|
|
$loadOnlyVisibleExtraData = false,
|
|
$loadAvatars = true,
|
|
$updateCache = false
|
|
) {
|
|
// Make sure user_id is safe
|
|
$user_id = (int) $user_id;
|
|
$user = false;
|
|
if (empty($user_id)) {
|
|
$userFromSession = Session::read('_user');
|
|
if (isset($userFromSession) && !empty($userFromSession)) {
|
|
return $userFromSession;
|
|
/*
|
|
return _api_format_user(
|
|
$userFromSession,
|
|
$showPassword,
|
|
$loadAvatars
|
|
);*/
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
$sql = "SELECT * FROM ".Database::get_main_table(TABLE_MAIN_USER)."
|
|
WHERE id = $user_id";
|
|
$result = Database::query($sql);
|
|
if (Database::num_rows($result) > 0) {
|
|
$result_array = Database::fetch_array($result);
|
|
$result_array['user_is_online_in_chat'] = 0;
|
|
if ($checkIfUserOnline) {
|
|
$use_status_in_platform = user_is_online($user_id);
|
|
$result_array['user_is_online'] = $use_status_in_platform;
|
|
$user_online_in_chat = 0;
|
|
if ($use_status_in_platform) {
|
|
$user_status = UserManager::get_extra_user_data_by_field(
|
|
$user_id,
|
|
'user_chat_status',
|
|
false,
|
|
true
|
|
);
|
|
if (1 == (int) $user_status['user_chat_status']) {
|
|
$user_online_in_chat = 1;
|
|
}
|
|
}
|
|
$result_array['user_is_online_in_chat'] = $user_online_in_chat;
|
|
}
|
|
|
|
if ($loadExtraData) {
|
|
$fieldValue = new ExtraFieldValue('user');
|
|
$result_array['extra'] = $fieldValue->getAllValuesForAnItem(
|
|
$user_id,
|
|
$loadOnlyVisibleExtraData
|
|
);
|
|
}
|
|
$user = _api_format_user($result_array, $showPassword, $loadAvatars);
|
|
}
|
|
|
|
return $user;
|
|
}
|
|
|
|
function api_get_user_info_from_entity(
|
|
User $user,
|
|
$checkIfUserOnline = false,
|
|
$showPassword = false,
|
|
$loadExtraData = false,
|
|
$loadOnlyVisibleExtraData = false,
|
|
$loadAvatars = true,
|
|
$loadCertificate = false
|
|
) {
|
|
if (!$user instanceof UserInterface) {
|
|
return false;
|
|
}
|
|
|
|
// Make sure user_id is safe
|
|
$user_id = (int) $user->getId();
|
|
|
|
if (empty($user_id)) {
|
|
$userFromSession = Session::read('_user');
|
|
|
|
if (isset($userFromSession) && !empty($userFromSession)) {
|
|
return $userFromSession;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
$result = [];
|
|
$result['user_is_online_in_chat'] = 0;
|
|
if ($checkIfUserOnline) {
|
|
$use_status_in_platform = user_is_online($user_id);
|
|
$result['user_is_online'] = $use_status_in_platform;
|
|
$user_online_in_chat = 0;
|
|
if ($use_status_in_platform) {
|
|
$user_status = UserManager::get_extra_user_data_by_field(
|
|
$user_id,
|
|
'user_chat_status',
|
|
false,
|
|
true
|
|
);
|
|
if (1 == (int) $user_status['user_chat_status']) {
|
|
$user_online_in_chat = 1;
|
|
}
|
|
}
|
|
$result['user_is_online_in_chat'] = $user_online_in_chat;
|
|
}
|
|
|
|
if ($loadExtraData) {
|
|
$fieldValue = new ExtraFieldValue('user');
|
|
$result['extra'] = $fieldValue->getAllValuesForAnItem(
|
|
$user_id,
|
|
$loadOnlyVisibleExtraData
|
|
);
|
|
}
|
|
|
|
$result['username'] = $user->getUsername();
|
|
$result['status'] = $user->getStatus();
|
|
$result['firstname'] = $user->getFirstname();
|
|
$result['lastname'] = $user->getLastname();
|
|
$result['email'] = $result['mail'] = $user->getEmail();
|
|
$result['complete_name'] = api_get_person_name($result['firstname'], $result['lastname']);
|
|
$result['complete_name_with_username'] = $result['complete_name'];
|
|
|
|
if (!empty($result['username']) && 'false' === api_get_setting('profile.hide_username_with_complete_name')) {
|
|
$result['complete_name_with_username'] = $result['complete_name'].' ('.$result['username'].')';
|
|
}
|
|
|
|
$showEmail = 'true' === api_get_setting('show_email_addresses');
|
|
if (!empty($result['email'])) {
|
|
$result['complete_name_with_email_forced'] = $result['complete_name'].' ('.$result['email'].')';
|
|
if ($showEmail) {
|
|
$result['complete_name_with_email'] = $result['complete_name'].' ('.$result['email'].')';
|
|
}
|
|
} else {
|
|
$result['complete_name_with_email'] = $result['complete_name'];
|
|
$result['complete_name_with_email_forced'] = $result['complete_name'];
|
|
}
|
|
|
|
// Kept for historical reasons
|
|
$result['firstName'] = $result['firstname'];
|
|
$result['lastName'] = $result['lastname'];
|
|
|
|
$attributes = [
|
|
'picture_uri',
|
|
'last_login',
|
|
'user_is_online',
|
|
];
|
|
|
|
$result['phone'] = $user->getPhone();
|
|
$result['address'] = $user->getAddress();
|
|
$result['official_code'] = $user->getOfficialCode();
|
|
$result['active'] = $user->isActive();
|
|
$result['auth_source'] = $user->getAuthSource();
|
|
$result['language'] = $user->getLocale();
|
|
$result['creator_id'] = $user->getCreatorId();
|
|
$result['registration_date'] = $user->getRegistrationDate()->format('Y-m-d H:i:s');
|
|
$result['hr_dept_id'] = $user->getHrDeptId();
|
|
$result['expiration_date'] = '';
|
|
if ($user->getExpirationDate()) {
|
|
$result['expiration_date'] = $user->getExpirationDate()->format('Y-m-d H:i:s');
|
|
}
|
|
|
|
$result['last_login'] = null;
|
|
if ($user->getLastLogin()) {
|
|
$result['last_login'] = $user->getLastLogin()->format('Y-m-d H:i:s');
|
|
}
|
|
|
|
$result['competences'] = $user->getCompetences();
|
|
$result['diplomas'] = $user->getDiplomas();
|
|
$result['teach'] = $user->getTeach();
|
|
$result['openarea'] = $user->getOpenarea();
|
|
$user_id = (int) $user->getId();
|
|
|
|
// Maintain the user_id index for backwards compatibility
|
|
$result['user_id'] = $result['id'] = $user_id;
|
|
|
|
if ($loadCertificate) {
|
|
$hasCertificates = Certificate::getCertificateByUser($user_id);
|
|
$result['has_certificates'] = 0;
|
|
if (!empty($hasCertificates)) {
|
|
$result['has_certificates'] = 1;
|
|
}
|
|
}
|
|
|
|
$result['icon_status'] = '';
|
|
$result['icon_status_medium'] = '';
|
|
$result['is_admin'] = UserManager::is_admin($user_id);
|
|
|
|
// Getting user avatar.
|
|
if ($loadAvatars) {
|
|
$result['avatar'] = '';
|
|
$result['avatar_no_query'] = '';
|
|
$result['avatar_small'] = '';
|
|
$result['avatar_medium'] = '';
|
|
$urlImg = '/';
|
|
$iconStatus = '';
|
|
$iconStatusMedium = '';
|
|
|
|
switch ($user->getStatus()) {
|
|
case STUDENT:
|
|
if (isset($result['has_certificates']) && $result['has_certificates']) {
|
|
$iconStatus = $urlImg.'icons/svg/identifier_graduated.svg';
|
|
} else {
|
|
$iconStatus = $urlImg.'icons/svg/identifier_student.svg';
|
|
}
|
|
break;
|
|
case COURSEMANAGER:
|
|
if ($result['is_admin']) {
|
|
$iconStatus = $urlImg.'icons/svg/identifier_admin.svg';
|
|
} else {
|
|
$iconStatus = $urlImg.'icons/svg/identifier_teacher.svg';
|
|
}
|
|
break;
|
|
case STUDENT_BOSS:
|
|
$iconStatus = $urlImg.'icons/svg/identifier_teacher.svg';
|
|
break;
|
|
}
|
|
|
|
if (!empty($iconStatus)) {
|
|
$iconStatusMedium = '<img src="'.$iconStatus.'" width="32px" height="32px">';
|
|
$iconStatus = '<img src="'.$iconStatus.'" width="22px" height="22px">';
|
|
}
|
|
|
|
$result['icon_status'] = $iconStatus;
|
|
$result['icon_status_medium'] = $iconStatusMedium;
|
|
}
|
|
|
|
if (isset($result['user_is_online'])) {
|
|
$result['user_is_online'] = true == $result['user_is_online'] ? 1 : 0;
|
|
}
|
|
if (isset($result['user_is_online_in_chat'])) {
|
|
$result['user_is_online_in_chat'] = $result['user_is_online_in_chat'];
|
|
}
|
|
|
|
$result['password'] = '';
|
|
if ($showPassword) {
|
|
$result['password'] = $user->getPassword();
|
|
}
|
|
|
|
if (isset($result['profile_completed'])) {
|
|
$result['profile_completed'] = $result['profile_completed'];
|
|
}
|
|
|
|
$result['profile_url'] = api_get_path(WEB_CODE_PATH).'social/profile.php?u='.$user_id;
|
|
|
|
// Send message link
|
|
$sendMessage = api_get_path(WEB_AJAX_PATH).'user_manager.ajax.php?a=get_user_popup&user_id='.$user_id;
|
|
$result['complete_name_with_message_link'] = Display::url(
|
|
$result['complete_name_with_username'],
|
|
$sendMessage,
|
|
['class' => 'ajax']
|
|
);
|
|
|
|
if (isset($result['extra'])) {
|
|
$result['extra'] = $result['extra'];
|
|
}
|
|
|
|
return $result;
|
|
}
|
|
|
|
function api_get_lp_entity(int $id): ?CLp
|
|
{
|
|
return Database::getManager()->getRepository(CLp::class)->find($id);
|
|
}
|
|
|
|
function api_get_user_entity(int $userId = 0): ?User
|
|
{
|
|
$userId = $userId ?: api_get_user_id();
|
|
$repo = Container::getUserRepository();
|
|
|
|
return $repo->find($userId);
|
|
}
|
|
|
|
function api_get_current_user(): ?User
|
|
{
|
|
$isLoggedIn = Container::getAuthorizationChecker()->isGranted('IS_AUTHENTICATED_REMEMBERED');
|
|
if (false === $isLoggedIn) {
|
|
return null;
|
|
}
|
|
|
|
$token = Container::getTokenStorage()->getToken();
|
|
|
|
if (null !== $token) {
|
|
return $token->getUser();
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Finds all the information about a user from username instead of user id.
|
|
*
|
|
* @param string $username
|
|
*
|
|
* @return mixed $user_info array user_id, lastname, firstname, username, email or false on error
|
|
*
|
|
* @author Yannick Warnier <yannick.warnier@beeznest.com>
|
|
*/
|
|
function api_get_user_info_from_username($username)
|
|
{
|
|
if (empty($username)) {
|
|
return false;
|
|
}
|
|
$username = trim($username);
|
|
|
|
$sql = "SELECT * FROM ".Database::get_main_table(TABLE_MAIN_USER)."
|
|
WHERE username='".Database::escape_string($username)."'";
|
|
$result = Database::query($sql);
|
|
if (Database::num_rows($result) > 0) {
|
|
$resultArray = Database::fetch_array($result);
|
|
|
|
return _api_format_user($resultArray);
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Get first user with an email.
|
|
*
|
|
* @param string $email
|
|
*
|
|
* @return array|bool
|
|
*/
|
|
function api_get_user_info_from_email($email = '')
|
|
{
|
|
if (empty($email)) {
|
|
return false;
|
|
}
|
|
$sql = "SELECT * FROM ".Database::get_main_table(TABLE_MAIN_USER)."
|
|
WHERE email ='".Database::escape_string($email)."' LIMIT 1";
|
|
$result = Database::query($sql);
|
|
if (Database::num_rows($result) > 0) {
|
|
$resultArray = Database::fetch_array($result);
|
|
|
|
return _api_format_user($resultArray);
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* @return string
|
|
*/
|
|
function api_get_course_id()
|
|
{
|
|
return Session::read('_cid', null);
|
|
}
|
|
|
|
/**
|
|
* Returns the current course id (integer).
|
|
*
|
|
* @param ?string $code Optional course code
|
|
*
|
|
* @return int
|
|
*/
|
|
function api_get_course_int_id(?string $code = null): int
|
|
{
|
|
if (!empty($code)) {
|
|
$code = Database::escape_string($code);
|
|
$row = Database::select(
|
|
'id',
|
|
Database::get_main_table(TABLE_MAIN_COURSE),
|
|
['where' => ['code = ?' => [$code]]],
|
|
'first'
|
|
);
|
|
|
|
if (is_array($row) && isset($row['id'])) {
|
|
return $row['id'];
|
|
} else {
|
|
return 0;
|
|
}
|
|
}
|
|
|
|
$cid = Session::read('_real_cid', 0);
|
|
if (empty($cid) && isset($_REQUEST['cid'])) {
|
|
$cid = (int) $_REQUEST['cid'];
|
|
}
|
|
|
|
return $cid;
|
|
}
|
|
|
|
/**
|
|
* Gets a course setting from the current course_setting table. Try always using integer values.
|
|
*
|
|
* @param string $settingName The name of the setting we want from the table
|
|
* @param Course|array $courseInfo
|
|
* @param bool $force force checking the value in the database
|
|
*
|
|
* @return mixed The value of that setting in that table. Return -1 if not found.
|
|
*/
|
|
function api_get_course_setting($settingName, $courseInfo = null, $force = false)
|
|
{
|
|
if (empty($courseInfo)) {
|
|
$courseInfo = api_get_course_info();
|
|
}
|
|
|
|
if (empty($courseInfo) || empty($settingName)) {
|
|
return -1;
|
|
}
|
|
|
|
if ($courseInfo instanceof Course) {
|
|
$courseId = $courseInfo->getId();
|
|
} else {
|
|
$courseId = isset($courseInfo['real_id']) && !empty($courseInfo['real_id']) ? $courseInfo['real_id'] : 0;
|
|
}
|
|
|
|
if (empty($courseId)) {
|
|
return -1;
|
|
}
|
|
|
|
static $courseSettingInfo = [];
|
|
|
|
if ($force) {
|
|
$courseSettingInfo = [];
|
|
}
|
|
|
|
if (!isset($courseSettingInfo[$courseId])) {
|
|
$table = Database::get_course_table(TABLE_COURSE_SETTING);
|
|
$settingName = Database::escape_string($settingName);
|
|
|
|
$sql = "SELECT variable, value FROM $table
|
|
WHERE c_id = $courseId ";
|
|
$res = Database::query($sql);
|
|
if (Database::num_rows($res) > 0) {
|
|
$result = Database::store_result($res, 'ASSOC');
|
|
$courseSettingInfo[$courseId] = array_column($result, 'value', 'variable');
|
|
|
|
if (isset($courseSettingInfo[$courseId]['email_alert_manager_on_new_quiz'])) {
|
|
$value = $courseSettingInfo[$courseId]['email_alert_manager_on_new_quiz'];
|
|
if (!is_null($value)) {
|
|
$result = explode(',', $value);
|
|
$courseSettingInfo[$courseId]['email_alert_manager_on_new_quiz'] = $result;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
if (isset($courseSettingInfo[$courseId]) && isset($courseSettingInfo[$courseId][$settingName])) {
|
|
return $courseSettingInfo[$courseId][$settingName];
|
|
}
|
|
|
|
return -1;
|
|
}
|
|
|
|
function api_get_course_plugin_setting($plugin, $settingName, $courseInfo = [])
|
|
{
|
|
$value = api_get_course_setting($settingName, $courseInfo, true);
|
|
|
|
if (-1 === $value) {
|
|
// Check global settings
|
|
$value = api_get_plugin_setting($plugin, $settingName);
|
|
if ('true' === $value) {
|
|
return 1;
|
|
}
|
|
if ('false' === $value) {
|
|
return 0;
|
|
}
|
|
if (null === $value) {
|
|
return -1;
|
|
}
|
|
}
|
|
|
|
return $value;
|
|
}
|
|
|
|
/**
|
|
* Gets an anonymous user ID.
|
|
*
|
|
* For some tools that need tracking, like the learnpath tool, it is necessary
|
|
* to have a usable user-id to enable some kind of tracking, even if not
|
|
* perfect. An anonymous ID is taken from the users table by looking for a
|
|
* status of "6" (anonymous).
|
|
*
|
|
* @return int User ID of the anonymous user, or O if no anonymous user found
|
|
*/
|
|
function api_get_anonymous_id()
|
|
{
|
|
// Find if another anon is connected now
|
|
$table = Database::get_main_table(TABLE_STATISTIC_TRACK_E_LOGIN);
|
|
$tableU = Database::get_main_table(TABLE_MAIN_USER);
|
|
$ip = Database::escape_string(api_get_real_ip());
|
|
$max = (int) api_get_setting('admin.max_anonymous_users');
|
|
if ($max >= 2) {
|
|
$sql = "SELECT * FROM $table as TEL
|
|
JOIN $tableU as U
|
|
ON U.id = TEL.login_user_id
|
|
WHERE TEL.user_ip = '$ip'
|
|
AND U.status = ".ANONYMOUS."
|
|
AND U.id != 2 ";
|
|
|
|
$result = Database::query($sql);
|
|
if (empty(Database::num_rows($result))) {
|
|
$login = uniqid('anon_');
|
|
$anonList = UserManager::get_user_list(['status' => ANONYMOUS], ['registration_date ASC']);
|
|
if (count($anonList) >= $max) {
|
|
foreach ($anonList as $userToDelete) {
|
|
UserManager::delete_user($userToDelete['user_id']);
|
|
break;
|
|
}
|
|
}
|
|
|
|
return UserManager::create_user(
|
|
$login,
|
|
'anon',
|
|
ANONYMOUS,
|
|
' anonymous@localhost',
|
|
$login,
|
|
$login
|
|
);
|
|
} else {
|
|
$row = Database::fetch_assoc($result);
|
|
|
|
return $row['id'];
|
|
}
|
|
}
|
|
|
|
$table = Database::get_main_table(TABLE_MAIN_USER);
|
|
$sql = "SELECT id
|
|
FROM $table
|
|
WHERE status = ".ANONYMOUS." ";
|
|
$res = Database::query($sql);
|
|
if (Database::num_rows($res) > 0) {
|
|
$row = Database::fetch_assoc($res);
|
|
|
|
return $row['id'];
|
|
}
|
|
|
|
// No anonymous user was found.
|
|
return 0;
|
|
}
|
|
|
|
/**
|
|
* @param int $courseId
|
|
* @param int $sessionId
|
|
* @param int $groupId
|
|
*
|
|
* @return string
|
|
*/
|
|
function api_get_cidreq_params($courseId, $sessionId = 0, $groupId = 0)
|
|
{
|
|
$courseId = !empty($courseId) ? (int) $courseId : 0;
|
|
$sessionId = !empty($sessionId) ? (int) $sessionId : 0;
|
|
$groupId = !empty($groupId) ? (int) $groupId : 0;
|
|
|
|
$url = 'cid='.$courseId;
|
|
$url .= '&sid='.$sessionId;
|
|
$url .= '&gid='.$groupId;
|
|
|
|
return $url;
|
|
}
|
|
|
|
/**
|
|
* Returns the current course url part including session, group, and gradebook params.
|
|
*
|
|
* @param bool $addSessionId
|
|
* @param bool $addGroupId
|
|
* @param string $origin
|
|
*
|
|
* @return string Course & session references to add to a URL
|
|
*/
|
|
function api_get_cidreq($addSessionId = true, $addGroupId = true, $origin = '')
|
|
{
|
|
$courseId = api_get_course_int_id();
|
|
if (0 === $courseId && isset($_REQUEST['cid'])) {
|
|
$courseId = (int) $_REQUEST['cid'];
|
|
}
|
|
$url = empty($courseId) ? '' : 'cid='.$courseId;
|
|
$origin = empty($origin) ? api_get_origin() : Security::remove_XSS($origin);
|
|
|
|
if ($addSessionId) {
|
|
if (!empty($url)) {
|
|
$sessionId = api_get_session_id();
|
|
if (0 === $sessionId && isset($_REQUEST['sid'])) {
|
|
$sessionId = (int) $_REQUEST['sid'];
|
|
}
|
|
$url .= 0 === $sessionId ? '&sid=0' : '&sid='.$sessionId;
|
|
}
|
|
}
|
|
|
|
if ($addGroupId) {
|
|
if (!empty($url)) {
|
|
$url .= 0 == api_get_group_id() ? '&gid=0' : '&gid='.api_get_group_id();
|
|
}
|
|
}
|
|
|
|
if (!empty($url)) {
|
|
$url .= '&gradebook='.(int) api_is_in_gradebook();
|
|
if (false !== $origin) {
|
|
$url .= '&origin=' . $origin;
|
|
}
|
|
}
|
|
|
|
return $url;
|
|
}
|
|
|
|
/**
|
|
* Get if we visited a gradebook page.
|
|
*
|
|
* @return bool
|
|
*/
|
|
function api_is_in_gradebook()
|
|
{
|
|
return Session::read('in_gradebook', false);
|
|
}
|
|
|
|
/**
|
|
* Set that we are in a page inside a gradebook.
|
|
*/
|
|
function api_set_in_gradebook()
|
|
{
|
|
Session::write('in_gradebook', true);
|
|
}
|
|
|
|
/**
|
|
* Remove gradebook session.
|
|
*/
|
|
function api_remove_in_gradebook()
|
|
{
|
|
Session::erase('in_gradebook');
|
|
}
|
|
|
|
/**
|
|
* Returns the current course info array see api_format_course_array()
|
|
* If the course_code is given, the returned array gives info about that
|
|
* particular course, if none given it gets the course info from the session.
|
|
*
|
|
* @param string $courseCode
|
|
*
|
|
* @return array
|
|
*/
|
|
function api_get_course_info($courseCode = null)
|
|
{
|
|
if (!empty($courseCode)) {
|
|
$course = Container::getCourseRepository()->findOneByCode($courseCode);
|
|
|
|
return api_format_course_array($course);
|
|
}
|
|
|
|
$course = Session::read('_course');
|
|
if ('-1' == $course) {
|
|
$course = [];
|
|
}
|
|
|
|
if (empty($course) && isset($_REQUEST['cid'])) {
|
|
$course = api_get_course_info_by_id((int) $_REQUEST['cid']);
|
|
}
|
|
|
|
return $course;
|
|
}
|
|
|
|
/**
|
|
* @param int $courseId
|
|
*/
|
|
function api_get_course_entity($courseId = 0): ?Course
|
|
{
|
|
if (empty($courseId)) {
|
|
$courseId = api_get_course_int_id();
|
|
}
|
|
|
|
if (empty($courseId)) {
|
|
return null;
|
|
}
|
|
|
|
return Container::getCourseRepository()->find($courseId);
|
|
}
|
|
|
|
/**
|
|
* @param int $id
|
|
*/
|
|
function api_get_session_entity($id = 0): ?SessionEntity
|
|
{
|
|
if (empty($id)) {
|
|
$id = api_get_session_id();
|
|
}
|
|
|
|
if (empty($id)) {
|
|
return null;
|
|
}
|
|
|
|
return Container::getSessionRepository()->find($id);
|
|
}
|
|
|
|
/**
|
|
* @param int $id
|
|
*/
|
|
function api_get_group_entity($id = 0): ?CGroup
|
|
{
|
|
if (empty($id)) {
|
|
$id = api_get_group_id();
|
|
}
|
|
|
|
return Container::getGroupRepository()->find($id);
|
|
}
|
|
|
|
/**
|
|
* @param int $id
|
|
*/
|
|
function api_get_url_entity($id = 0): ?AccessUrl
|
|
{
|
|
if (empty($id)) {
|
|
$id = api_get_current_access_url_id();
|
|
}
|
|
|
|
return Container::getAccessUrlRepository()->find($id);
|
|
}
|
|
|
|
/**
|
|
* Returns the current course info array.
|
|
|
|
* Now if the course_code is given, the returned array gives info about that
|
|
* particular course, not specially the current one.
|
|
*
|
|
* @param int $id Numeric ID of the course
|
|
*
|
|
* @return array The course info as an array formatted by api_format_course_array, including category.title
|
|
*/
|
|
function api_get_course_info_by_id(?int $id = 0)
|
|
{
|
|
if (empty($id)) {
|
|
$course = Session::read('_course', []);
|
|
|
|
return $course;
|
|
}
|
|
|
|
$course = Container::getCourseRepository()->find($id);
|
|
if (empty($course)) {
|
|
return [];
|
|
}
|
|
|
|
return api_format_course_array($course);
|
|
}
|
|
|
|
/**
|
|
* Reformat the course array (output by api_get_course_info()) in order, mostly,
|
|
* to switch from 'code' to 'id' in the array.
|
|
*
|
|
* @return array
|
|
*
|
|
* @todo eradicate the false "id"=code field of the $_course array and use the int id
|
|
*/
|
|
function api_format_course_array(Course $course = null)
|
|
{
|
|
if (empty($course)) {
|
|
return [];
|
|
}
|
|
|
|
$courseData = [];
|
|
$courseData['id'] = $courseData['real_id'] = $course->getId();
|
|
|
|
// Added
|
|
$courseData['code'] = $courseData['sysCode'] = $course->getCode();
|
|
$courseData['name'] = $courseData['title'] = $course->getTitle(); // 'name' only used for backwards compatibility - should be removed in the long run
|
|
$courseData['official_code'] = $courseData['visual_code'] = $course->getVisualCode();
|
|
$courseData['creation_date'] = $course->getCreationDate()->format('Y-m-d H:i:s');
|
|
$courseData['titular'] = $course->getTutorName();
|
|
$courseData['language'] = $courseData['course_language'] = $course->getCourseLanguage();
|
|
$courseData['extLink']['url'] = $courseData['department_url'] = $course->getDepartmentUrl();
|
|
$courseData['extLink']['name'] = $courseData['department_name'] = $course->getDepartmentName();
|
|
|
|
$courseData['visibility'] = $course->getVisibility();
|
|
$courseData['subscribe_allowed'] = $courseData['subscribe'] = $course->getSubscribe();
|
|
$courseData['unsubscribe'] = $course->getUnsubscribe();
|
|
$courseData['activate_legal'] = $course->getActivateLegal();
|
|
$courseData['legal'] = $course->getLegal();
|
|
$courseData['show_score'] = $course->getShowScore(); //used in the work tool
|
|
$courseData['video_url'] = $course->getVideoUrl();
|
|
$courseData['sticky'] = (int) $course->isSticky();
|
|
|
|
$coursePath = '/course/';
|
|
$webCourseHome = $coursePath.$courseData['real_id'].'/home';
|
|
|
|
// Course password
|
|
$courseData['registration_code'] = $course->getRegistrationCode();
|
|
$courseData['disk_quota'] = $course->getDiskQuota();
|
|
$courseData['course_public_url'] = $webCourseHome;
|
|
$courseData['about_url'] = $coursePath.$courseData['real_id'].'/about';
|
|
$courseData['add_teachers_to_sessions_courses'] = $course->isAddTeachersToSessionsCourses();
|
|
|
|
$image = Display::getMdiIcon(
|
|
ObjectIcon::COURSE,
|
|
'ch-tool-icon',
|
|
null,
|
|
ICON_SIZE_BIG
|
|
);
|
|
|
|
$illustration = Container::getIllustrationRepository()->getIllustrationUrl($course);
|
|
if (!empty($illustration)) {
|
|
$image = $illustration;
|
|
}
|
|
|
|
$courseData['course_image'] = $image.'?filter=course_picture_small';
|
|
$courseData['course_image_large'] = $image.'?filter=course_picture_medium';
|
|
|
|
if ('true' === api_get_setting('course.show_course_duration') && null !== $course->getDuration()) {
|
|
$courseData['duration'] = $course->getDuration();
|
|
}
|
|
|
|
return $courseData;
|
|
}
|
|
|
|
/**
|
|
* Returns a difficult to guess password.
|
|
*/
|
|
function api_generate_password(int $length = 8, $useRequirements = true): string
|
|
{
|
|
if ($length < 2) {
|
|
$length = 2;
|
|
}
|
|
|
|
$charactersLowerCase = 'abcdefghijkmnopqrstuvwxyz';
|
|
$charactersUpperCase = 'ABCDEFGHJKLMNPQRSTUVWXYZ';
|
|
$charactersSpecials = '!@#$%^&*()_+-=[]{}|;:,.<>?';
|
|
$minNumbers = 2;
|
|
$length = $length - $minNumbers;
|
|
$minLowerCase = round($length / 2);
|
|
$minUpperCase = $length - $minLowerCase;
|
|
$minSpecials = 1; // Default minimum special characters
|
|
|
|
$password = '';
|
|
$passwordRequirements = $useRequirements ? Security::getPasswordRequirements() : [];
|
|
|
|
$factory = new RandomLib\Factory();
|
|
$generator = $factory->getGenerator(new SecurityLib\Strength(SecurityLib\Strength::MEDIUM));
|
|
|
|
if (!empty($passwordRequirements)) {
|
|
$length = $passwordRequirements['min']['length'];
|
|
$minNumbers = $passwordRequirements['min']['numeric'];
|
|
$minLowerCase = $passwordRequirements['min']['lowercase'];
|
|
$minUpperCase = $passwordRequirements['min']['uppercase'];
|
|
$minSpecials = $passwordRequirements['min']['specials'];
|
|
|
|
$rest = $length - $minNumbers - $minLowerCase - $minUpperCase - $minSpecials;
|
|
// Add the rest to fill the length requirement
|
|
if ($rest > 0) {
|
|
$password .= $generator->generateString($rest, $charactersLowerCase.$charactersUpperCase);
|
|
}
|
|
}
|
|
|
|
// Min digits default 2
|
|
for ($i = 0; $i < $minNumbers; $i++) {
|
|
$password .= $generator->generateInt(2, 9);
|
|
}
|
|
|
|
// Min lowercase
|
|
$password .= $generator->generateString($minLowerCase, $charactersLowerCase);
|
|
|
|
// Min uppercase
|
|
$password .= $generator->generateString($minUpperCase, $charactersUpperCase);
|
|
|
|
// Min special characters
|
|
$password .= $generator->generateString($minSpecials, $charactersSpecials);
|
|
|
|
// Shuffle the password to ensure randomness
|
|
$password = str_shuffle($password);
|
|
|
|
return $password;
|
|
}
|
|
|
|
/**
|
|
* Checks a password to see wether it is OK to use.
|
|
*
|
|
* @param string $password
|
|
*
|
|
* @return bool if the password is acceptable, false otherwise
|
|
* Notes about what a password "OK to use" is:
|
|
* 1. The password should be at least 5 characters long.
|
|
* 2. Only English letters (uppercase or lowercase, it doesn't matter) and digits are allowed.
|
|
* 3. The password should contain at least 3 letters.
|
|
* 4. It should contain at least 2 digits.
|
|
* Settings will change if the configuration value is set: password_requirements
|
|
*/
|
|
function api_check_password($password)
|
|
{
|
|
$passwordRequirements = Security::getPasswordRequirements();
|
|
|
|
$minLength = $passwordRequirements['min']['length'];
|
|
$minNumbers = $passwordRequirements['min']['numeric'];
|
|
// Optional
|
|
$minLowerCase = $passwordRequirements['min']['lowercase'];
|
|
$minUpperCase = $passwordRequirements['min']['uppercase'];
|
|
|
|
$minLetters = $minLowerCase + $minUpperCase;
|
|
$passwordLength = api_strlen($password);
|
|
|
|
$conditions = [
|
|
'min_length' => $passwordLength >= $minLength,
|
|
];
|
|
|
|
$digits = 0;
|
|
$lowerCase = 0;
|
|
$upperCase = 0;
|
|
|
|
for ($i = 0; $i < $passwordLength; $i++) {
|
|
$currentCharacterCode = api_ord(api_substr($password, $i, 1));
|
|
if ($currentCharacterCode >= 65 && $currentCharacterCode <= 90) {
|
|
$upperCase++;
|
|
}
|
|
|
|
if ($currentCharacterCode >= 97 && $currentCharacterCode <= 122) {
|
|
$lowerCase++;
|
|
}
|
|
if ($currentCharacterCode >= 48 && $currentCharacterCode <= 57) {
|
|
$digits++;
|
|
}
|
|
}
|
|
|
|
// Min number of digits
|
|
$conditions['min_numeric'] = $digits >= $minNumbers;
|
|
|
|
if (!empty($minUpperCase)) {
|
|
// Uppercase
|
|
$conditions['min_uppercase'] = $upperCase >= $minUpperCase;
|
|
}
|
|
|
|
if (!empty($minLowerCase)) {
|
|
// Lowercase
|
|
$conditions['min_lowercase'] = $upperCase >= $minLowerCase;
|
|
}
|
|
|
|
// Min letters
|
|
$letters = $upperCase + $lowerCase;
|
|
$conditions['min_letters'] = $letters >= $minLetters;
|
|
|
|
$isPasswordOk = true;
|
|
foreach ($conditions as $condition) {
|
|
if (false === $condition) {
|
|
$isPasswordOk = false;
|
|
break;
|
|
}
|
|
}
|
|
|
|
if (false === $isPasswordOk) {
|
|
$output = get_lang('The new password does not match the minimum security requirements').'<br />';
|
|
$output .= Security::getPasswordRequirementsToString($conditions);
|
|
|
|
Display::addFlash(Display::return_message($output, 'warning', false));
|
|
}
|
|
|
|
return $isPasswordOk;
|
|
}
|
|
|
|
/**
|
|
* Gets the current Chamilo (not PHP/cookie) session ID.
|
|
*
|
|
* @return int O if no active session, the session ID otherwise
|
|
*/
|
|
function api_get_session_id()
|
|
{
|
|
return (int) Session::read('sid', 0);
|
|
}
|
|
|
|
/**
|
|
* Gets the current Chamilo (not social network) group ID.
|
|
*
|
|
* @return int O if no active session, the session ID otherwise
|
|
*/
|
|
function api_get_group_id()
|
|
{
|
|
return Session::read('gid', 0);
|
|
}
|
|
|
|
/**
|
|
* Gets the current or given session name.
|
|
*
|
|
* @param int Session ID (optional)
|
|
*
|
|
* @return string The session name, or null if not found
|
|
*/
|
|
function api_get_session_name($session_id = 0)
|
|
{
|
|
if (empty($session_id)) {
|
|
$session_id = api_get_session_id();
|
|
if (empty($session_id)) {
|
|
return null;
|
|
}
|
|
}
|
|
$t = Database::get_main_table(TABLE_MAIN_SESSION);
|
|
$s = "SELECT title FROM $t WHERE id = ".(int) $session_id;
|
|
$r = Database::query($s);
|
|
$c = Database::num_rows($r);
|
|
if ($c > 0) {
|
|
//technically, there can be only one, but anyway we take the first
|
|
$rec = Database::fetch_array($r);
|
|
|
|
return $rec['title'];
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Gets the session info by id.
|
|
*
|
|
* @param int $id Session ID
|
|
*
|
|
* @return array information of the session
|
|
*/
|
|
function api_get_session_info($id)
|
|
{
|
|
return SessionManager::fetch($id);
|
|
}
|
|
|
|
/**
|
|
* Gets the session visibility by session id.
|
|
*
|
|
* @param int $session_id
|
|
* @param int $courseId
|
|
* @param bool $ignore_visibility_for_admins
|
|
*
|
|
* @return int
|
|
* 0 = session still available,
|
|
* SESSION_VISIBLE_READ_ONLY = 1,
|
|
* SESSION_VISIBLE = 2,
|
|
* SESSION_INVISIBLE = 3
|
|
*/
|
|
function api_get_session_visibility(
|
|
$session_id,
|
|
$courseId = null,
|
|
$ignore_visibility_for_admins = true,
|
|
$userId = 0
|
|
) {
|
|
if (api_is_platform_admin()) {
|
|
if ($ignore_visibility_for_admins) {
|
|
return SESSION_AVAILABLE;
|
|
}
|
|
}
|
|
$userId = empty($userId) ? api_get_user_id() : (int) $userId;
|
|
|
|
$now = time();
|
|
if (empty($session_id)) {
|
|
return 0; // Means that the session is still available.
|
|
}
|
|
|
|
$session_id = (int) $session_id;
|
|
$tbl_session = Database::get_main_table(TABLE_MAIN_SESSION);
|
|
|
|
$result = Database::query("SELECT * FROM $tbl_session WHERE id = $session_id");
|
|
|
|
if (Database::num_rows($result) <= 0) {
|
|
return SESSION_INVISIBLE;
|
|
}
|
|
|
|
$row = Database::fetch_assoc($result);
|
|
$visibility = $row['visibility'];
|
|
|
|
// I don't care the session visibility.
|
|
if (empty($row['access_start_date']) && empty($row['access_end_date'])) {
|
|
// Session duration per student.
|
|
if (isset($row['duration']) && !empty($row['duration'])) {
|
|
$duration = $row['duration'] * 24 * 60 * 60;
|
|
$courseAccess = CourseManager::getFirstCourseAccessPerSessionAndUser($session_id, $userId);
|
|
|
|
// If there is a session duration but there is no previous
|
|
// access by the user, then the session is still available
|
|
if (0 == count($courseAccess)) {
|
|
return SESSION_AVAILABLE;
|
|
}
|
|
|
|
$currentTime = time();
|
|
$firstAccess = isset($courseAccess['login_course_date'])
|
|
? api_strtotime($courseAccess['login_course_date'], 'UTC')
|
|
: 0;
|
|
$userDurationData = SessionManager::getUserSession($userId, $session_id);
|
|
$userDuration = isset($userDurationData['duration'])
|
|
? (intval($userDurationData['duration']) * 24 * 60 * 60)
|
|
: 0;
|
|
|
|
$totalDuration = $firstAccess + $duration + $userDuration;
|
|
|
|
return $totalDuration > $currentTime ? SESSION_AVAILABLE : SESSION_VISIBLE_READ_ONLY;
|
|
}
|
|
|
|
return SESSION_AVAILABLE;
|
|
}
|
|
|
|
// If start date was set.
|
|
if (!empty($row['access_start_date'])) {
|
|
$visibility = $now > api_strtotime($row['access_start_date'], 'UTC') ? SESSION_AVAILABLE : SESSION_INVISIBLE;
|
|
} else {
|
|
// If there's no start date, assume it's available until the end date
|
|
$visibility = SESSION_AVAILABLE;
|
|
}
|
|
|
|
// If the end date was set.
|
|
if (!empty($row['access_end_date'])) {
|
|
// Only if date_start said that it was ok
|
|
if (SESSION_AVAILABLE === $visibility) {
|
|
$visibility = $now < api_strtotime($row['access_end_date'], 'UTC')
|
|
? SESSION_AVAILABLE // Date still available
|
|
: $row['visibility']; // Session ends
|
|
}
|
|
}
|
|
|
|
// If I'm a coach the visibility can change in my favor depending in the coach dates.
|
|
$isCoach = api_is_coach($session_id, $courseId);
|
|
|
|
if ($isCoach) {
|
|
// Test start date.
|
|
if (!empty($row['coach_access_start_date'])) {
|
|
$start = api_strtotime($row['coach_access_start_date'], 'UTC');
|
|
$visibility = $start < $now ? SESSION_AVAILABLE : SESSION_INVISIBLE;
|
|
}
|
|
|
|
// Test end date.
|
|
if (!empty($row['coach_access_end_date'])) {
|
|
if (SESSION_AVAILABLE === $visibility) {
|
|
$endDateCoach = api_strtotime($row['coach_access_end_date'], 'UTC');
|
|
$visibility = $endDateCoach >= $now ? SESSION_AVAILABLE : $row['visibility'];
|
|
}
|
|
}
|
|
}
|
|
|
|
return $visibility;
|
|
}
|
|
|
|
/**
|
|
* This function returns a (star) session icon if the session is not null and
|
|
* the user is not a student.
|
|
*
|
|
* @param int $sessionId
|
|
* @param int $statusId User status id - if 5 (student), will return empty
|
|
*
|
|
* @return string Session icon
|
|
*/
|
|
function api_get_session_image($sessionId, User $user)
|
|
{
|
|
$sessionId = (int) $sessionId;
|
|
$image = '';
|
|
if (!$user->hasRole('ROLE_STUDENT')) {
|
|
// Check whether is not a student
|
|
if ($sessionId > 0) {
|
|
$image = ' '.Display::getMdiIcon(
|
|
ObjectIcon::STAR,
|
|
'ch-tool-icon',
|
|
'align:absmiddle;',
|
|
ICON_SIZE_SMALL,
|
|
get_lang('Session-specific resource')
|
|
);
|
|
}
|
|
}
|
|
|
|
return $image;
|
|
}
|
|
|
|
/**
|
|
* This function add an additional condition according to the session of the course.
|
|
*
|
|
* @param int $session_id session id
|
|
* @param bool $and optional, true if more than one condition false if the only condition in the query
|
|
* @param bool $with_base_content optional, true to accept content with session=0 as well,
|
|
* false for strict session condition
|
|
* @param string $session_field
|
|
*
|
|
* @return string condition of the session
|
|
*/
|
|
function api_get_session_condition(
|
|
$session_id,
|
|
$and = true,
|
|
$with_base_content = false,
|
|
$session_field = 'session_id'
|
|
) {
|
|
$session_id = (int) $session_id;
|
|
|
|
if (empty($session_field)) {
|
|
$session_field = 'session_id';
|
|
}
|
|
// Condition to show resources by session
|
|
$condition_add = $and ? ' AND ' : ' WHERE ';
|
|
|
|
if ($with_base_content) {
|
|
$condition_session = $condition_add." ( $session_field = $session_id OR $session_field = 0 OR $session_field IS NULL) ";
|
|
} else {
|
|
if (empty($session_id)) {
|
|
$condition_session = $condition_add." ($session_field = $session_id OR $session_field IS NULL)";
|
|
} else {
|
|
$condition_session = $condition_add." $session_field = $session_id ";
|
|
}
|
|
}
|
|
|
|
return $condition_session;
|
|
}
|
|
|
|
/**
|
|
* Returns the value of a setting from the web-adjustable admin config settings.
|
|
*
|
|
* WARNING true/false are stored as string, so when comparing you need to check e.g.
|
|
* if (api_get_setting('show_navigation_menu') == 'true') //CORRECT
|
|
* instead of
|
|
* if (api_get_setting('show_navigation_menu') == true) //INCORRECT
|
|
*
|
|
* @param string $variable The variable name
|
|
*
|
|
* @return string|array
|
|
*/
|
|
function api_get_setting($variable, $isArray = false, $key = null)
|
|
{
|
|
$settingsManager = Container::getSettingsManager();
|
|
if (empty($settingsManager)) {
|
|
return '';
|
|
}
|
|
$variable = trim($variable);
|
|
|
|
switch ($variable) {
|
|
case 'server_type':
|
|
$test = ['dev', 'test'];
|
|
$environment = Container::getEnvironment();
|
|
if (in_array($environment, $test)) {
|
|
return 'test';
|
|
}
|
|
|
|
return 'prod';
|
|
// deprecated settings
|
|
// no break
|
|
case 'openid_authentication':
|
|
case 'service_ppt2lp':
|
|
case 'formLogin_hide_unhide_label':
|
|
return false;
|
|
break;
|
|
case 'tool_visible_by_default_at_creation':
|
|
$values = $settingsManager->getSetting($variable);
|
|
$newResult = [];
|
|
foreach ($values as $parameter) {
|
|
$newResult[$parameter] = 'true';
|
|
}
|
|
|
|
return $newResult;
|
|
break;
|
|
default:
|
|
$settingValue = $settingsManager->getSetting($variable, true);
|
|
if (is_string($settingValue) && $isArray && !empty($settingValue)) {
|
|
// Check if the value is a valid JSON string
|
|
$decodedValue = json_decode($settingValue, true);
|
|
|
|
// If it's a valid JSON string and the result is an array, return it
|
|
if (is_array($decodedValue)) {
|
|
return $decodedValue;
|
|
}
|
|
|
|
// If it's not an array, continue with the normal flow
|
|
// Optional: If you need to evaluate the value using eval
|
|
$strArrayValue = rtrim($settingValue, ';');
|
|
$value = eval("return $strArrayValue;");
|
|
if (is_array($value)) {
|
|
return $value;
|
|
}
|
|
}
|
|
|
|
// If the value is not a JSON array or wasn't returned previously, continue with the normal flow
|
|
if (!empty($key) && isset($settingValue[$variable][$key])) {
|
|
return $settingValue[$variable][$key];
|
|
}
|
|
|
|
return $settingValue;
|
|
break;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param string $variable
|
|
* @param string $option
|
|
*
|
|
* @return bool
|
|
*/
|
|
function api_get_setting_in_list($variable, $option)
|
|
{
|
|
$value = api_get_setting($variable);
|
|
|
|
return in_array($option, $value);
|
|
}
|
|
|
|
/**
|
|
* @param string $plugin
|
|
* @param string $variable
|
|
*
|
|
* @return string
|
|
*/
|
|
function api_get_plugin_setting($plugin, $variable)
|
|
{
|
|
$variableName = $plugin.'_'.$variable;
|
|
//$result = api_get_setting($variableName);
|
|
$params = [
|
|
'category = ? AND subkey = ? AND variable = ?' => [
|
|
'Plugins',
|
|
$plugin,
|
|
$variableName,
|
|
],
|
|
];
|
|
$table = Database::get_main_table(TABLE_MAIN_SETTINGS);
|
|
$result = Database::select(
|
|
'selected_value',
|
|
$table,
|
|
['where' => $params],
|
|
'one'
|
|
);
|
|
if ($result) {
|
|
$value = $result['selected_value'];
|
|
$serializedValue = @unserialize($result['selected_value'], []);
|
|
if (false !== $serializedValue) {
|
|
$value = $serializedValue;
|
|
}
|
|
|
|
return $value;
|
|
}
|
|
|
|
return null;
|
|
/// Old code
|
|
|
|
$variableName = $plugin.'_'.$variable;
|
|
$result = api_get_setting($variableName);
|
|
|
|
if (isset($result[$plugin])) {
|
|
$value = $result[$plugin];
|
|
|
|
$unserialized = UnserializeApi::unserialize('not_allowed_classes', $value, true);
|
|
|
|
if (false !== $unserialized) {
|
|
$value = $unserialized;
|
|
}
|
|
|
|
return $value;
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Returns the value of a setting from the web-adjustable admin config settings.
|
|
*/
|
|
function api_get_settings_params($params)
|
|
{
|
|
$table = Database::get_main_table(TABLE_MAIN_SETTINGS);
|
|
|
|
return Database::select('*', $table, ['where' => $params]);
|
|
}
|
|
|
|
/**
|
|
* @param array $params example: [id = ? => '1']
|
|
*
|
|
* @return array
|
|
*/
|
|
function api_get_settings_params_simple($params)
|
|
{
|
|
$table = Database::get_main_table(TABLE_MAIN_SETTINGS);
|
|
|
|
return Database::select('*', $table, ['where' => $params], 'one');
|
|
}
|
|
|
|
/**
|
|
* Returns the value of a setting from the web-adjustable admin config settings.
|
|
*/
|
|
function api_delete_settings_params($params)
|
|
{
|
|
$table = Database::get_main_table(TABLE_MAIN_SETTINGS);
|
|
|
|
return Database::delete($table, $params);
|
|
}
|
|
|
|
/**
|
|
* Returns an escaped version of $_SERVER['PHP_SELF'] to avoid XSS injection.
|
|
*
|
|
* @return string Escaped version of $_SERVER['PHP_SELF']
|
|
*/
|
|
function api_get_self()
|
|
{
|
|
return htmlentities($_SERVER['PHP_SELF']);
|
|
}
|
|
|
|
/**
|
|
* Checks whether current user is a platform administrator.
|
|
*
|
|
* @param bool $allowSessionAdmins Whether session admins should be considered admins or not
|
|
* @param bool $allowDrh Whether HR directors should be considered admins or not
|
|
*
|
|
* @return bool true if the user has platform admin rights,
|
|
* false otherwise
|
|
*
|
|
* @see usermanager::is_admin(user_id) for a user-id specific function
|
|
*/
|
|
function api_is_platform_admin($allowSessionAdmins = false, $allowDrh = false)
|
|
{
|
|
$currentUser = api_get_current_user();
|
|
|
|
if (null === $currentUser) {
|
|
return false;
|
|
}
|
|
|
|
$isAdmin = $currentUser->hasRole('ROLE_ADMIN') || $currentUser->hasRole('ROLE_SUPER_ADMIN');
|
|
|
|
if ($isAdmin) {
|
|
return true;
|
|
}
|
|
|
|
if ($allowSessionAdmins && $currentUser->hasRole('ROLE_SESSION_MANAGER')) {
|
|
return true;
|
|
}
|
|
|
|
if ($allowDrh && $currentUser->hasRole('ROLE_HR')) {
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Checks whether the user given as user id is in the admin table.
|
|
*
|
|
* @param int $user_id If none provided, will use current user
|
|
* @param int $url URL ID. If provided, also check if the user is active on given URL
|
|
*
|
|
* @return bool True if the user is admin, false otherwise
|
|
*/
|
|
function api_is_platform_admin_by_id($user_id = null, $url = null)
|
|
{
|
|
$user_id = (int) $user_id;
|
|
if (empty($user_id)) {
|
|
$user_id = api_get_user_id();
|
|
}
|
|
$admin_table = Database::get_main_table(TABLE_MAIN_ADMIN);
|
|
$sql = "SELECT * FROM $admin_table WHERE user_id = $user_id";
|
|
$res = Database::query($sql);
|
|
$is_admin = 1 === Database::num_rows($res);
|
|
if (!$is_admin || !isset($url)) {
|
|
return $is_admin;
|
|
}
|
|
// We get here only if $url is set
|
|
$url = (int) $url;
|
|
$url_user_table = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_USER);
|
|
$sql = "SELECT * FROM $url_user_table
|
|
WHERE access_url_id = $url AND user_id = $user_id";
|
|
$res = Database::query($sql);
|
|
|
|
return 1 === Database::num_rows($res);
|
|
}
|
|
|
|
/**
|
|
* Checks whether current user is allowed to create courses.
|
|
*
|
|
* @return bool true if the user has course creation rights,
|
|
* false otherwise
|
|
*/
|
|
function api_is_allowed_to_create_course()
|
|
{
|
|
if (api_is_platform_admin()) {
|
|
return true;
|
|
}
|
|
|
|
// Teachers can only create courses
|
|
if (api_is_teacher()) {
|
|
if ('true' === api_get_setting('allow_users_to_create_courses')) {
|
|
return true;
|
|
} else {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
return Session::read('is_allowedCreateCourse');
|
|
}
|
|
|
|
/**
|
|
* Checks whether the current user is a course administrator.
|
|
*
|
|
* @return bool True if current user is a course administrator
|
|
*/
|
|
function api_is_course_admin()
|
|
{
|
|
if (api_is_platform_admin()) {
|
|
return true;
|
|
}
|
|
|
|
$user = api_get_current_user();
|
|
if ($user) {
|
|
if (
|
|
$user->hasRole('ROLE_CURRENT_COURSE_SESSION_TEACHER') ||
|
|
$user->hasRole('ROLE_CURRENT_COURSE_TEACHER')
|
|
) {
|
|
return true;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Checks whether the current user is a course coach
|
|
* Based on the presence of user in session_rel_user.relation_type (as session general coach, value 3).
|
|
*
|
|
* @return bool True if current user is a course coach
|
|
*/
|
|
function api_is_session_general_coach()
|
|
{
|
|
return Session::read('is_session_general_coach');
|
|
}
|
|
|
|
/**
|
|
* Checks whether the current user is a course tutor
|
|
* Based on the presence of user in session_rel_course_rel_user.user_id with status = 2.
|
|
*
|
|
* @return bool True if current user is a course tutor
|
|
*/
|
|
function api_is_course_tutor()
|
|
{
|
|
return Session::read('is_courseTutor');
|
|
}
|
|
|
|
/**
|
|
* @param int $user_id
|
|
* @param int $courseId
|
|
* @param int $session_id
|
|
*
|
|
* @return bool
|
|
*/
|
|
function api_is_course_session_coach($user_id, $courseId, $session_id)
|
|
{
|
|
$session_table = Database::get_main_table(TABLE_MAIN_SESSION);
|
|
$session_rel_course_rel_user_table = Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER);
|
|
|
|
$user_id = (int) $user_id;
|
|
$session_id = (int) $session_id;
|
|
$courseId = (int) $courseId;
|
|
|
|
$sql = "SELECT DISTINCT session.id
|
|
FROM $session_table
|
|
INNER JOIN $session_rel_course_rel_user_table session_rc_ru
|
|
ON session.id = session_rc_ru.session_id
|
|
WHERE
|
|
session_rc_ru.user_id = '".$user_id."' AND
|
|
session_rc_ru.c_id = '$courseId' AND
|
|
session_rc_ru.status = ".SessionEntity::COURSE_COACH." AND
|
|
session_rc_ru.session_id = '$session_id'";
|
|
$result = Database::query($sql);
|
|
|
|
return Database::num_rows($result) > 0;
|
|
}
|
|
|
|
/**
|
|
* Checks whether the current user is a course or session coach.
|
|
*
|
|
* @param int $session_id
|
|
* @param int $courseId
|
|
* @param bool Check whether we are in student view and, if we are, return false
|
|
* @param int $userId
|
|
*
|
|
* @return bool True if current user is a course or session coach
|
|
*/
|
|
function api_is_coach($session_id = 0, $courseId = null, $check_student_view = true, $userId = 0)
|
|
{
|
|
$userId = empty($userId) ? api_get_user_id() : (int) $userId;
|
|
|
|
if (!empty($session_id)) {
|
|
$session_id = (int) $session_id;
|
|
} else {
|
|
$session_id = api_get_session_id();
|
|
}
|
|
|
|
// The student preview was on
|
|
if ($check_student_view && api_is_student_view_active()) {
|
|
return false;
|
|
}
|
|
|
|
if (!empty($courseId)) {
|
|
$courseId = (int) $courseId;
|
|
} else {
|
|
$courseId = api_get_course_int_id();
|
|
}
|
|
|
|
$session_table = Database::get_main_table(TABLE_MAIN_SESSION);
|
|
$session_rel_course_rel_user_table = Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER);
|
|
$tblSessionRelUser = Database::get_main_table(TABLE_MAIN_SESSION_USER);
|
|
$sessionIsCoach = [];
|
|
|
|
if (!empty($courseId)) {
|
|
$sql = "SELECT DISTINCT s.id, title, access_start_date, access_end_date
|
|
FROM $session_table s
|
|
INNER JOIN $session_rel_course_rel_user_table session_rc_ru
|
|
ON session_rc_ru.session_id = s.id AND session_rc_ru.user_id = '".$userId."'
|
|
WHERE
|
|
session_rc_ru.c_id = '$courseId' AND
|
|
session_rc_ru.status =".SessionEntity::COURSE_COACH." AND
|
|
session_rc_ru.session_id = '$session_id'";
|
|
$result = Database::query($sql);
|
|
$sessionIsCoach = Database::store_result($result);
|
|
}
|
|
|
|
if (!empty($session_id)) {
|
|
$sql = "SELECT DISTINCT s.id
|
|
FROM $session_table AS s
|
|
INNER JOIN $tblSessionRelUser sru
|
|
ON s.id = sru.session_id
|
|
WHERE
|
|
sru.user_id = $userId AND
|
|
s.id = $session_id AND
|
|
sru.relation_type = ".SessionEntity::GENERAL_COACH."
|
|
ORDER BY s.access_start_date, s.access_end_date, s.title";
|
|
$result = Database::query($sql);
|
|
if (!empty($sessionIsCoach)) {
|
|
$sessionIsCoach = array_merge(
|
|
$sessionIsCoach,
|
|
Database::store_result($result)
|
|
);
|
|
} else {
|
|
$sessionIsCoach = Database::store_result($result);
|
|
}
|
|
}
|
|
|
|
return count($sessionIsCoach) > 0;
|
|
}
|
|
|
|
function api_user_has_role(string $role, ?User $user = null): bool
|
|
{
|
|
if (null === $user) {
|
|
$user = api_get_current_user();
|
|
}
|
|
|
|
if (null === $user) {
|
|
return false;
|
|
}
|
|
|
|
return $user->hasRole($role);
|
|
}
|
|
|
|
function api_is_allowed_in_course(): bool
|
|
{
|
|
if (api_is_platform_admin()) {
|
|
return true;
|
|
}
|
|
|
|
$user = api_get_current_user();
|
|
if ($user instanceof User) {
|
|
if ($user->hasRole('ROLE_CURRENT_COURSE_SESSION_STUDENT') ||
|
|
$user->hasRole('ROLE_CURRENT_COURSE_SESSION_TEACHER') ||
|
|
$user->hasRole('ROLE_CURRENT_COURSE_STUDENT') ||
|
|
$user->hasRole('ROLE_CURRENT_COURSE_TEACHER')
|
|
) {
|
|
return true;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Checks whether current user is a student boss.
|
|
*/
|
|
function api_is_student_boss(?User $user = null): bool
|
|
{
|
|
return api_user_has_role('ROLE_STUDENT_BOSS', $user);
|
|
}
|
|
|
|
/**
|
|
* Checks whether the current user is a session administrator.
|
|
*
|
|
* @return bool True if current user is a course administrator
|
|
*/
|
|
function api_is_session_admin(?User $user = null)
|
|
{
|
|
return api_user_has_role('ROLE_SESSION_MANAGER', $user);
|
|
}
|
|
|
|
/**
|
|
* Checks whether the current user is a human resources manager.
|
|
*
|
|
* @return bool True if current user is a human resources manager
|
|
*/
|
|
function api_is_drh()
|
|
{
|
|
return api_user_has_role('ROLE_HR');
|
|
}
|
|
|
|
/**
|
|
* Checks whether the current user is a student.
|
|
*
|
|
* @return bool True if current user is a human resources manager
|
|
*/
|
|
function api_is_student()
|
|
{
|
|
return api_user_has_role('ROLE_STUDENT');
|
|
}
|
|
|
|
/**
|
|
* Checks whether the current user has the status 'teacher'.
|
|
*
|
|
* @return bool True if current user is a human resources manager
|
|
*/
|
|
function api_is_teacher()
|
|
{
|
|
return api_user_has_role('ROLE_TEACHER');
|
|
}
|
|
|
|
/**
|
|
* Checks whether the current user is a invited user.
|
|
*
|
|
* @return bool
|
|
*/
|
|
function api_is_invitee()
|
|
{
|
|
return api_user_has_role('ROLE_INVITEE');
|
|
}
|
|
|
|
/**
|
|
* This function checks whether a session is assigned into a category.
|
|
*
|
|
* @param int - session id
|
|
* @param string - category name
|
|
*
|
|
* @return bool - true if is found, otherwise false
|
|
*/
|
|
function api_is_session_in_category($session_id, $category_name)
|
|
{
|
|
$session_id = (int) $session_id;
|
|
$category_name = Database::escape_string($category_name);
|
|
$tbl_session = Database::get_main_table(TABLE_MAIN_SESSION);
|
|
$tbl_session_category = Database::get_main_table(TABLE_MAIN_SESSION_CATEGORY);
|
|
|
|
$sql = "SELECT 1
|
|
FROM $tbl_session
|
|
WHERE $session_id IN (
|
|
SELECT s.id FROM $tbl_session s, $tbl_session_category sc
|
|
WHERE
|
|
s.session_category_id = sc.id AND
|
|
sc.name LIKE '%$category_name'
|
|
)";
|
|
$rs = Database::query($sql);
|
|
|
|
if (Database::num_rows($rs) > 0) {
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Displays options for switching between student view and course manager view.
|
|
*
|
|
* Changes in version 1.2 (Patrick Cool)
|
|
* Student view switch now behaves as a real switch. It maintains its current state until the state
|
|
* is changed explicitly
|
|
*
|
|
* Changes in version 1.1 (Patrick Cool)
|
|
* student view now works correctly in subfolders of the document tool
|
|
* student view works correctly in the new links tool
|
|
*
|
|
* Example code for using this in your tools:
|
|
* //if ($is_courseAdmin && api_get_setting('student_view_enabled') == 'true') {
|
|
* // display_tool_view_option($isStudentView);
|
|
* //}
|
|
* //and in later sections, use api_is_allowed_to_edit()
|
|
*
|
|
* @author Roan Embrechts
|
|
* @author Patrick Cool
|
|
* @author Julio Montoya, changes added in Chamilo
|
|
*
|
|
* @version 1.2
|
|
*
|
|
* @todo rewrite code so it is easier to understand
|
|
*/
|
|
function api_display_tool_view_option()
|
|
{
|
|
if ('true' != api_get_setting('student_view_enabled')) {
|
|
return '';
|
|
}
|
|
|
|
$sourceurl = '';
|
|
$is_framed = false;
|
|
// Exceptions apply for all multi-frames pages
|
|
if (false !== strpos($_SERVER['REQUEST_URI'], 'chat/chat_banner.php')) {
|
|
// The chat is a multiframe bit that doesn't work too well with the student_view, so do not show the link
|
|
return '';
|
|
}
|
|
|
|
// Uncomment to remove student view link from document view page
|
|
if (false !== strpos($_SERVER['REQUEST_URI'], 'lp/lp_header.php')) {
|
|
if (empty($_GET['lp_id'])) {
|
|
return '';
|
|
}
|
|
$sourceurl = substr($_SERVER['REQUEST_URI'], 0, strpos($_SERVER['REQUEST_URI'], '?'));
|
|
$sourceurl = str_replace(
|
|
'lp/lp_header.php',
|
|
'lp/lp_controller.php?'.api_get_cidreq().'&action=view&lp_id='.intval($_GET['lp_id']).'&isStudentView='.('studentview' == $_SESSION['studentview'] ? 'false' : 'true'),
|
|
$sourceurl
|
|
);
|
|
//showinframes doesn't handle student view anyway...
|
|
//return '';
|
|
$is_framed = true;
|
|
}
|
|
|
|
// Check whether the $_SERVER['REQUEST_URI'] contains already url parameters (thus a questionmark)
|
|
if (!$is_framed) {
|
|
if (false === strpos($_SERVER['REQUEST_URI'], '?')) {
|
|
$sourceurl = api_get_self().'?'.api_get_cidreq();
|
|
} else {
|
|
$sourceurl = $_SERVER['REQUEST_URI'];
|
|
}
|
|
}
|
|
|
|
$output_string = '';
|
|
if (!empty($_SESSION['studentview'])) {
|
|
if ('studentview' == $_SESSION['studentview']) {
|
|
// We have to remove the isStudentView=true from the $sourceurl
|
|
$sourceurl = str_replace('&isStudentView=true', '', $sourceurl);
|
|
$sourceurl = str_replace('&isStudentView=false', '', $sourceurl);
|
|
$output_string .= '<a class="btn btn--primary btn-sm" href="'.$sourceurl.'&isStudentView=false" target="_self">'.
|
|
Display::getMdiIcon('eye').' '.get_lang('Switch to teacher view').'</a>';
|
|
} elseif ('teacherview' == $_SESSION['studentview']) {
|
|
// Switching to teacherview
|
|
$sourceurl = str_replace('&isStudentView=true', '', $sourceurl);
|
|
$sourceurl = str_replace('&isStudentView=false', '', $sourceurl);
|
|
$output_string .= '<a class="btn btn--plain btn-sm" href="'.$sourceurl.'&isStudentView=true" target="_self">'.
|
|
Display::getMdiIcon('eye').' '.get_lang('Switch to student view').'</a>';
|
|
}
|
|
} else {
|
|
$output_string .= '<a class="btn btn--plain btn-sm" href="'.$sourceurl.'&isStudentView=true" target="_self">'.
|
|
Display::getMdiIcon('eye').' '.get_lang('Switch to student view').'</a>';
|
|
}
|
|
$output_string = Security::remove_XSS($output_string);
|
|
$html = Display::tag('div', $output_string, ['class' => 'view-options']);
|
|
|
|
return $html;
|
|
}
|
|
|
|
/**
|
|
* Function that removes the need to directly use is_courseAdmin global in
|
|
* tool scripts. It returns true or false depending on the user's rights in
|
|
* this particular course.
|
|
* Optionally checking for tutor and coach roles here allows us to use the
|
|
* student_view feature altogether with these roles as well.
|
|
*
|
|
* @param bool Whether to check if the user has the tutor role
|
|
* @param bool Whether to check if the user has the coach role
|
|
* @param bool Whether to check if the user has the session coach role
|
|
* @param bool check the student view or not
|
|
*
|
|
* @author Roan Embrechts
|
|
* @author Patrick Cool
|
|
* @author Julio Montoya
|
|
*
|
|
* @version 1.1, February 2004
|
|
*
|
|
* @return bool true: the user has the rights to edit, false: he does not
|
|
*/
|
|
function api_is_allowed_to_edit(
|
|
$tutor = false,
|
|
$coach = false,
|
|
$session_coach = false,
|
|
$check_student_view = true
|
|
) {
|
|
$allowSessionAdminEdit = 'true' === api_get_setting('session.session_admins_edit_courses_content');
|
|
// Admins can edit anything.
|
|
if (api_is_platform_admin($allowSessionAdminEdit)) {
|
|
//The student preview was on
|
|
if ($check_student_view && api_is_student_view_active()) {
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
$sessionId = api_get_session_id();
|
|
|
|
if ($sessionId && 'true' === api_get_setting('session.session_courses_read_only_mode')) {
|
|
$efv = new ExtraFieldValue('course');
|
|
$lockExrafieldField = $efv->get_values_by_handler_and_field_variable(
|
|
api_get_course_int_id(),
|
|
'session_courses_read_only_mode'
|
|
);
|
|
|
|
if (!empty($lockExrafieldField['value'])) {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
$is_allowed_coach_to_edit = api_is_coach(null, null, $check_student_view);
|
|
$session_visibility = api_get_session_visibility($sessionId);
|
|
$is_courseAdmin = api_is_course_admin();
|
|
|
|
if (!$is_courseAdmin && $tutor) {
|
|
// If we also want to check if the user is a tutor...
|
|
$is_courseAdmin = $is_courseAdmin || api_is_course_tutor();
|
|
}
|
|
|
|
if (!$is_courseAdmin && $coach) {
|
|
// If we also want to check if the user is a coach...';
|
|
// Check if session visibility is read only for coaches.
|
|
if (SESSION_VISIBLE_READ_ONLY == $session_visibility) {
|
|
$is_allowed_coach_to_edit = false;
|
|
}
|
|
|
|
if ('true' === api_get_setting('allow_coach_to_edit_course_session')) {
|
|
// Check if coach is allowed to edit a course.
|
|
$is_courseAdmin = $is_courseAdmin || $is_allowed_coach_to_edit;
|
|
}
|
|
}
|
|
|
|
if (!$is_courseAdmin && $session_coach) {
|
|
$is_courseAdmin = $is_courseAdmin || $is_allowed_coach_to_edit;
|
|
}
|
|
|
|
// Check if the student_view is enabled, and if so, if it is activated.
|
|
if ('true' === api_get_setting('student_view_enabled')) {
|
|
$studentView = api_is_student_view_active();
|
|
if (!empty($sessionId)) {
|
|
// Check if session visibility is read only for coaches.
|
|
if (SESSION_VISIBLE_READ_ONLY == $session_visibility) {
|
|
$is_allowed_coach_to_edit = false;
|
|
}
|
|
|
|
$is_allowed = false;
|
|
if ('true' === api_get_setting('allow_coach_to_edit_course_session')) {
|
|
// Check if coach is allowed to edit a course.
|
|
$is_allowed = $is_allowed_coach_to_edit;
|
|
}
|
|
if ($check_student_view) {
|
|
$is_allowed = $is_allowed && false === $studentView;
|
|
}
|
|
} else {
|
|
$is_allowed = $is_courseAdmin;
|
|
if ($check_student_view) {
|
|
$is_allowed = $is_courseAdmin && false === $studentView;
|
|
}
|
|
}
|
|
|
|
return $is_allowed;
|
|
} else {
|
|
return $is_courseAdmin;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns true if user is a course coach of at least one course in session.
|
|
*
|
|
* @param int $sessionId
|
|
*
|
|
* @return bool
|
|
*/
|
|
function api_is_coach_of_course_in_session($sessionId)
|
|
{
|
|
if (api_is_platform_admin()) {
|
|
return true;
|
|
}
|
|
|
|
$userId = api_get_user_id();
|
|
$courseList = UserManager::get_courses_list_by_session(
|
|
$userId,
|
|
$sessionId
|
|
);
|
|
|
|
// Session visibility.
|
|
$visibility = api_get_session_visibility(
|
|
$sessionId,
|
|
null,
|
|
false
|
|
);
|
|
|
|
if (SESSION_VISIBLE != $visibility && !empty($courseList)) {
|
|
// Course Coach session visibility.
|
|
$blockedCourseCount = 0;
|
|
$closedVisibilityList = [
|
|
COURSE_VISIBILITY_CLOSED,
|
|
COURSE_VISIBILITY_HIDDEN,
|
|
];
|
|
|
|
foreach ($courseList as $course) {
|
|
// Checking session visibility
|
|
$sessionCourseVisibility = api_get_session_visibility(
|
|
$sessionId,
|
|
$course['real_id']
|
|
);
|
|
|
|
$courseIsVisible = !in_array(
|
|
$course['visibility'],
|
|
$closedVisibilityList
|
|
);
|
|
if (false === $courseIsVisible || SESSION_INVISIBLE == $sessionCourseVisibility) {
|
|
$blockedCourseCount++;
|
|
}
|
|
}
|
|
|
|
// If all courses are blocked then no show in the list.
|
|
if ($blockedCourseCount === count($courseList)) {
|
|
$visibility = SESSION_INVISIBLE;
|
|
} else {
|
|
$visibility = SESSION_VISIBLE;
|
|
}
|
|
}
|
|
|
|
switch ($visibility) {
|
|
case SESSION_VISIBLE_READ_ONLY:
|
|
case SESSION_VISIBLE:
|
|
case SESSION_AVAILABLE:
|
|
return true;
|
|
break;
|
|
case SESSION_INVISIBLE:
|
|
return false;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Checks if a student can edit contents in a session depending
|
|
* on the session visibility.
|
|
*
|
|
* @param bool $tutor Whether to check if the user has the tutor role
|
|
* @param bool $coach Whether to check if the user has the coach role
|
|
*
|
|
* @return bool true: the user has the rights to edit, false: he does not
|
|
*/
|
|
function api_is_allowed_to_session_edit($tutor = false, $coach = false)
|
|
{
|
|
if (api_is_allowed_to_edit($tutor, $coach)) {
|
|
// If I'm a teacher, I will return true in order to not affect the normal behaviour of Chamilo tools.
|
|
return true;
|
|
} else {
|
|
$sessionId = api_get_session_id();
|
|
|
|
if (0 == $sessionId) {
|
|
// I'm not in a session so i will return true to not affect the normal behaviour of Chamilo tools.
|
|
return true;
|
|
} else {
|
|
// I'm in a session and I'm a student
|
|
// Get the session visibility
|
|
$session_visibility = api_get_session_visibility($sessionId);
|
|
// if 5 the session is still available
|
|
switch ($session_visibility) {
|
|
case SESSION_VISIBLE_READ_ONLY: // 1
|
|
return false;
|
|
case SESSION_VISIBLE: // 2
|
|
return true;
|
|
case SESSION_INVISIBLE: // 3
|
|
return false;
|
|
case SESSION_AVAILABLE: //5
|
|
return true;
|
|
}
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Current user is anon?
|
|
*
|
|
* @return bool true if this user is anonymous, false otherwise
|
|
*/
|
|
function api_is_anonymous()
|
|
{
|
|
return !Container::getAuthorizationChecker()->isGranted('IS_AUTHENTICATED');
|
|
}
|
|
|
|
/**
|
|
* Displays message "You are not allowed here..." and exits the entire script.
|
|
*
|
|
* @param bool $print_headers Whether to print headers (default = false -> does not print them)
|
|
* @param string $message
|
|
* @param int $responseCode
|
|
*
|
|
* @throws Exception
|
|
*/
|
|
function api_not_allowed(
|
|
$print_headers = false,
|
|
$message = null,
|
|
$responseCode = 0
|
|
): never {
|
|
throw new NotAllowedException($message ?: 'You are not allowed', null, $responseCode);
|
|
}
|
|
|
|
/**
|
|
* @param string $languageIsoCode
|
|
*
|
|
* @return string
|
|
*/
|
|
function languageToCountryIsoCode($languageIsoCode)
|
|
{
|
|
$allow = ('true' === api_get_setting('language.language_flags_by_country'));
|
|
|
|
// @todo save in DB
|
|
switch ($languageIsoCode) {
|
|
case 'ar':
|
|
$country = 'ae';
|
|
break;
|
|
case 'bs':
|
|
$country = 'ba';
|
|
break;
|
|
case 'ca':
|
|
$country = 'es';
|
|
if ($allow) {
|
|
$country = 'catalan';
|
|
}
|
|
break;
|
|
case 'cs':
|
|
$country = 'cz';
|
|
break;
|
|
case 'da':
|
|
$country = 'dk';
|
|
break;
|
|
case 'el':
|
|
$country = 'ae';
|
|
break;
|
|
case 'en':
|
|
$country = 'gb';
|
|
break;
|
|
case 'eu': // Euskera
|
|
$country = 'es';
|
|
if ($allow) {
|
|
$country = 'basque';
|
|
}
|
|
break;
|
|
case 'gl': // galego
|
|
$country = 'es';
|
|
if ($allow) {
|
|
$country = 'galician';
|
|
}
|
|
break;
|
|
case 'he':
|
|
$country = 'il';
|
|
break;
|
|
case 'ja':
|
|
$country = 'jp';
|
|
break;
|
|
case 'ka':
|
|
$country = 'ge';
|
|
break;
|
|
case 'ko':
|
|
$country = 'kr';
|
|
break;
|
|
case 'ms':
|
|
$country = 'my';
|
|
break;
|
|
case 'pt-BR':
|
|
$country = 'br';
|
|
break;
|
|
case 'qu':
|
|
$country = 'pe';
|
|
break;
|
|
case 'sl':
|
|
$country = 'si';
|
|
break;
|
|
case 'sv':
|
|
$country = 'se';
|
|
break;
|
|
case 'uk': // Ukraine
|
|
$country = 'ua';
|
|
break;
|
|
case 'zh-TW':
|
|
case 'zh':
|
|
$country = 'cn';
|
|
break;
|
|
default:
|
|
$country = $languageIsoCode;
|
|
break;
|
|
}
|
|
$country = strtolower($country);
|
|
|
|
return $country;
|
|
}
|
|
|
|
/**
|
|
* Returns a list of all the languages that are made available by the admin.
|
|
*
|
|
* @return array An array with all languages. Structure of the array is
|
|
* array['name'] = An array with the name of every language
|
|
* array['folder'] = An array with the corresponding names of the language-folders in the filesystem
|
|
*/
|
|
function api_get_languages()
|
|
{
|
|
$table = Database::get_main_table(TABLE_MAIN_LANGUAGE);
|
|
$sql = "SELECT * FROM $table WHERE available='1'
|
|
ORDER BY original_name ASC";
|
|
$result = Database::query($sql);
|
|
$languages = [];
|
|
while ($row = Database::fetch_assoc($result)) {
|
|
$languages[$row['isocode']] = $row['original_name'];
|
|
}
|
|
|
|
return $languages;
|
|
}
|
|
|
|
/**
|
|
* Returns the id (the database id) of a language.
|
|
*
|
|
* @param string language name (the corresponding name of the language-folder in the filesystem)
|
|
*
|
|
* @return int id of the language
|
|
*/
|
|
function api_get_language_id($language)
|
|
{
|
|
$tbl_language = Database::get_main_table(TABLE_MAIN_LANGUAGE);
|
|
if (empty($language)) {
|
|
return null;
|
|
}
|
|
|
|
// We check the language by iscocode
|
|
$langInfo = api_get_language_from_iso($language);
|
|
if (null !== $langInfo && !empty($langInfo->getId())) {
|
|
return $langInfo->getId();
|
|
}
|
|
|
|
$language = Database::escape_string($language);
|
|
$sql = "SELECT id FROM $tbl_language
|
|
WHERE english_name = '$language' LIMIT 1";
|
|
$result = Database::query($sql);
|
|
$row = Database::fetch_array($result);
|
|
|
|
return $row['id'];
|
|
}
|
|
|
|
/**
|
|
* Get the language information by its id.
|
|
*
|
|
* @param int $languageId
|
|
*
|
|
* @throws Exception
|
|
*
|
|
* @return array
|
|
*/
|
|
function api_get_language_info($languageId)
|
|
{
|
|
if (empty($languageId)) {
|
|
return [];
|
|
}
|
|
|
|
$language = Database::getManager()->find(Language::class, $languageId);
|
|
|
|
if (!$language) {
|
|
return [];
|
|
}
|
|
|
|
return [
|
|
'id' => $language->getId(),
|
|
'original_name' => $language->getOriginalName(),
|
|
'english_name' => $language->getEnglishName(),
|
|
'isocode' => $language->getIsocode(),
|
|
'available' => $language->getAvailable(),
|
|
'parent_id' => $language->getParent() ? $language->getParent()->getId() : null,
|
|
];
|
|
}
|
|
|
|
/**
|
|
* @param string $code
|
|
*
|
|
* @return Language
|
|
*/
|
|
function api_get_language_from_iso($code)
|
|
{
|
|
$em = Database::getManager();
|
|
|
|
return $em->getRepository(Language::class)->findOneBy(['isocode' => $code]);
|
|
}
|
|
|
|
/**
|
|
* Shortcut to ThemeHelper::getVisualTheme()
|
|
*/
|
|
function api_get_visual_theme(): string
|
|
{
|
|
$themeHelper = Container::$container->get(ThemeHelper::class);
|
|
|
|
return $themeHelper->getVisualTheme();
|
|
}
|
|
|
|
/**
|
|
* Returns a list of CSS themes currently available in the CSS folder
|
|
* The folder must have a default.css file.
|
|
*
|
|
* @param bool $getOnlyThemeFromVirtualInstance Used by the vchamilo plugin
|
|
*
|
|
* @return array list of themes directories from the css folder
|
|
* Note: Directory names (names of themes) in the file system should contain ASCII-characters only
|
|
*/
|
|
function api_get_themes($getOnlyThemeFromVirtualInstance = false)
|
|
{
|
|
// This configuration value is set by the vchamilo plugin
|
|
$virtualTheme = api_get_configuration_value('virtual_css_theme_folder');
|
|
|
|
$readCssFolder = function ($dir) use ($virtualTheme) {
|
|
$finder = new Finder();
|
|
$themes = $finder->directories()->in($dir)->depth(0)->sortByName();
|
|
$list = [];
|
|
/** @var Symfony\Component\Finder\SplFileInfo $theme */
|
|
foreach ($themes as $theme) {
|
|
$folder = $theme->getFilename();
|
|
// A theme folder is consider if there's a default.css file
|
|
if (!file_exists($theme->getPathname().'/default.css')) {
|
|
continue;
|
|
}
|
|
$name = ucwords(str_replace('_', ' ', $folder));
|
|
if ($folder == $virtualTheme) {
|
|
continue;
|
|
}
|
|
$list[$folder] = $name;
|
|
}
|
|
|
|
return $list;
|
|
};
|
|
|
|
$dir = Container::getProjectDir().'var/themes/';
|
|
$list = $readCssFolder($dir);
|
|
|
|
if (!empty($virtualTheme)) {
|
|
$newList = $readCssFolder($dir.'/'.$virtualTheme);
|
|
if ($getOnlyThemeFromVirtualInstance) {
|
|
return $newList;
|
|
}
|
|
$list = $list + $newList;
|
|
asort($list);
|
|
}
|
|
|
|
return $list;
|
|
}
|
|
|
|
/**
|
|
* Find the largest sort value in a given user_course_category
|
|
* This function is used when we are moving a course to a different category
|
|
* and also when a user subscribes to courses (the new course is added at the end of the main category.
|
|
*
|
|
* @param int $courseCategoryId the id of the user_course_category
|
|
* @param int $userId
|
|
*
|
|
* @return int the value of the highest sort of the user_course_category
|
|
*/
|
|
function api_max_sort_value($courseCategoryId, $userId)
|
|
{
|
|
$user = api_get_user_entity($userId);
|
|
$userCourseCategory = Database::getManager()->getRepository(UserCourseCategory::class)->find($courseCategoryId);
|
|
|
|
return null === $user ? 0 : $user->getMaxSortValue($userCourseCategory);
|
|
}
|
|
|
|
/**
|
|
* Transforms a number of seconds in hh:mm:ss format.
|
|
*
|
|
* @author Julian Prud'homme
|
|
*
|
|
* @param int $seconds number of seconds
|
|
* @param string $space
|
|
* @param bool $showSeconds
|
|
* @param bool $roundMinutes
|
|
*
|
|
* @return string the formatted time
|
|
*/
|
|
function api_time_to_hms($seconds, $space = ':', $showSeconds = true, $roundMinutes = false)
|
|
{
|
|
// $seconds = -1 means that we have wrong data in the db.
|
|
if (-1 == $seconds) {
|
|
return
|
|
get_lang('Unknown').
|
|
Display::getMdiIcon(
|
|
ActionIcon::INFORMATION,
|
|
'ch-tool-icon',
|
|
'align: absmiddle; hspace: 3px',
|
|
ICON_SIZE_SMALL,
|
|
get_lang('The datas about this user were registered when the calculation of time spent on the platform wasn\'t possible.')
|
|
);
|
|
}
|
|
|
|
// How many hours ?
|
|
$hours = floor($seconds / 3600);
|
|
|
|
// How many minutes ?
|
|
$min = floor(($seconds - ($hours * 3600)) / 60);
|
|
|
|
if ($roundMinutes) {
|
|
if ($min >= 45) {
|
|
$min = 45;
|
|
}
|
|
|
|
if ($min >= 30 && $min <= 44) {
|
|
$min = 30;
|
|
}
|
|
|
|
if ($min >= 15 && $min <= 29) {
|
|
$min = 15;
|
|
}
|
|
|
|
if ($min >= 0 && $min <= 14) {
|
|
$min = 0;
|
|
}
|
|
}
|
|
|
|
// How many seconds
|
|
$sec = floor($seconds - ($hours * 3600) - ($min * 60));
|
|
|
|
if ($hours < 10) {
|
|
$hours = "0$hours";
|
|
}
|
|
|
|
if ($sec < 10) {
|
|
$sec = "0$sec";
|
|
}
|
|
|
|
if ($min < 10) {
|
|
$min = "0$min";
|
|
}
|
|
|
|
$seconds = '';
|
|
if ($showSeconds) {
|
|
$seconds = $space.$sec;
|
|
}
|
|
|
|
return $hours.$space.$min.$seconds;
|
|
}
|
|
|
|
/**
|
|
* Returns the permissions to be assigned to every newly created directory by the web-server.
|
|
* The return value is based on the platform administrator's setting
|
|
* "Administration > Configuration settings > Security > Permissions for new directories".
|
|
*
|
|
* @return int returns the permissions in the format "Owner-Group-Others, Read-Write-Execute", as an integer value
|
|
*/
|
|
function api_get_permissions_for_new_directories()
|
|
{
|
|
static $permissions;
|
|
if (!isset($permissions)) {
|
|
$permissions = trim(api_get_setting('permissions_for_new_directories'));
|
|
// The default value 0777 is according to that in the platform administration panel after fresh system installation.
|
|
$permissions = octdec(!empty($permissions) ? $permissions : '0777');
|
|
}
|
|
|
|
return $permissions;
|
|
}
|
|
|
|
/**
|
|
* Returns the permissions to be assigned to every newly created directory by the web-server.
|
|
* The return value is based on the platform administrator's setting
|
|
* "Administration > Configuration settings > Security > Permissions for new files".
|
|
*
|
|
* @return int returns the permissions in the format
|
|
* "Owner-Group-Others, Read-Write-Execute", as an integer value
|
|
*/
|
|
function api_get_permissions_for_new_files()
|
|
{
|
|
static $permissions;
|
|
if (!isset($permissions)) {
|
|
$permissions = trim(api_get_setting('permissions_for_new_files'));
|
|
// The default value 0666 is according to that in the platform
|
|
// administration panel after fresh system installation.
|
|
$permissions = octdec(!empty($permissions) ? $permissions : '0666');
|
|
}
|
|
|
|
return $permissions;
|
|
}
|
|
|
|
/**
|
|
* Deletes a file, or a folder and its contents.
|
|
*
|
|
* @author Aidan Lister <aidan@php.net>
|
|
*
|
|
* @version 1.0.3
|
|
*
|
|
* @param string $dirname Directory to delete
|
|
* @param bool Deletes only the content or not
|
|
* @param bool $strict if one folder/file fails stop the loop
|
|
*
|
|
* @return bool Returns TRUE on success, FALSE on failure
|
|
*
|
|
* @see http://aidanlister.com/2004/04/recursively-deleting-a-folder-in-php/
|
|
*
|
|
* @author Yannick Warnier, adaptation for the Chamilo LMS, April, 2008
|
|
* @author Ivan Tcholakov, a sanity check about Directory class creation has been added, September, 2009
|
|
*/
|
|
function rmdirr($dirname, $delete_only_content_in_folder = false, $strict = false)
|
|
{
|
|
$res = true;
|
|
// A sanity check.
|
|
if (!file_exists($dirname)) {
|
|
return false;
|
|
}
|
|
$php_errormsg = '';
|
|
// Simple delete for a file.
|
|
if (is_file($dirname) || is_link($dirname)) {
|
|
$res = unlink($dirname);
|
|
if (false === $res) {
|
|
error_log(__FILE__.' line '.__LINE__.': '.((bool) ini_get('track_errors') ? $php_errormsg : 'Error not recorded because track_errors is off in your php.ini'), 0);
|
|
}
|
|
|
|
return $res;
|
|
}
|
|
|
|
// Loop through the folder.
|
|
$dir = dir($dirname);
|
|
// A sanity check.
|
|
$is_object_dir = is_object($dir);
|
|
if ($is_object_dir) {
|
|
while (false !== $entry = $dir->read()) {
|
|
// Skip pointers.
|
|
if ('.' == $entry || '..' == $entry) {
|
|
continue;
|
|
}
|
|
|
|
// Recurse.
|
|
if ($strict) {
|
|
$result = rmdirr("$dirname/$entry");
|
|
if (false == $result) {
|
|
$res = false;
|
|
break;
|
|
}
|
|
} else {
|
|
rmdirr("$dirname/$entry");
|
|
}
|
|
}
|
|
}
|
|
|
|
// Clean up.
|
|
if ($is_object_dir) {
|
|
$dir->close();
|
|
}
|
|
|
|
if (false == $delete_only_content_in_folder) {
|
|
$res = rmdir($dirname);
|
|
if (false === $res) {
|
|
error_log(__FILE__.' line '.__LINE__.': '.((bool) ini_get('track_errors') ? $php_errormsg : 'error not recorded because track_errors is off in your php.ini'), 0);
|
|
}
|
|
}
|
|
|
|
return $res;
|
|
}
|
|
|
|
// TODO: This function is to be simplified. File access modes to be implemented.
|
|
/**
|
|
* function adapted from a php.net comment
|
|
* copy recursively a folder.
|
|
*
|
|
* @param the source folder
|
|
* @param the dest folder
|
|
* @param an array of excluded file_name (without extension)
|
|
* @param copied_files the returned array of copied files
|
|
* @param string $source
|
|
* @param string $dest
|
|
*/
|
|
function copyr($source, $dest, $exclude = [], $copied_files = [])
|
|
{
|
|
if (empty($dest)) {
|
|
return false;
|
|
}
|
|
// Simple copy for a file
|
|
if (is_file($source)) {
|
|
$path_info = pathinfo($source);
|
|
if (!in_array($path_info['filename'], $exclude)) {
|
|
copy($source, $dest);
|
|
}
|
|
|
|
return true;
|
|
} elseif (!is_dir($source)) {
|
|
//then source is not a dir nor a file, return
|
|
return false;
|
|
}
|
|
|
|
// Make destination directory.
|
|
if (!is_dir($dest)) {
|
|
mkdir($dest, api_get_permissions_for_new_directories());
|
|
}
|
|
|
|
// Loop through the folder.
|
|
$dir = dir($source);
|
|
while (false !== $entry = $dir->read()) {
|
|
// Skip pointers
|
|
if ('.' == $entry || '..' == $entry) {
|
|
continue;
|
|
}
|
|
|
|
// Deep copy directories.
|
|
if ($dest !== "$source/$entry") {
|
|
$files = copyr("$source/$entry", "$dest/$entry", $exclude, $copied_files);
|
|
}
|
|
}
|
|
// Clean up.
|
|
$dir->close();
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* @todo: Using DIRECTORY_SEPARATOR is not recommended, this is an obsolete approach.
|
|
* Documentation header to be added here.
|
|
*
|
|
* @param string $pathname
|
|
* @param string $base_path_document
|
|
* @param int $session_id
|
|
*
|
|
* @return mixed True if directory already exists, false if a file already exists at
|
|
* the destination and null if everything goes according to plan
|
|
*/
|
|
function copy_folder_course_session(
|
|
$pathname,
|
|
$base_path_document,
|
|
$session_id,
|
|
$course_info,
|
|
$document,
|
|
$source_course_id
|
|
) {
|
|
$table = Database::get_course_table(TABLE_DOCUMENT);
|
|
$session_id = intval($session_id);
|
|
$source_course_id = intval($source_course_id);
|
|
|
|
// Check whether directory already exists.
|
|
if (is_dir($pathname) || empty($pathname)) {
|
|
return true;
|
|
}
|
|
|
|
// Ensure that a file with the same name does not already exist.
|
|
if (is_file($pathname)) {
|
|
trigger_error('copy_folder_course_session(): File exists', E_USER_WARNING);
|
|
|
|
return false;
|
|
}
|
|
|
|
$course_id = $course_info['real_id'];
|
|
$folders = explode(DIRECTORY_SEPARATOR, str_replace($base_path_document.DIRECTORY_SEPARATOR, '', $pathname));
|
|
$new_pathname = $base_path_document;
|
|
$path = '';
|
|
|
|
foreach ($folders as $folder) {
|
|
$new_pathname .= DIRECTORY_SEPARATOR.$folder;
|
|
$path .= DIRECTORY_SEPARATOR.$folder;
|
|
|
|
if (!file_exists($new_pathname)) {
|
|
$path = Database::escape_string($path);
|
|
|
|
$sql = "SELECT * FROM $table
|
|
WHERE
|
|
c_id = $source_course_id AND
|
|
path = '$path' AND
|
|
filetype = 'folder' AND
|
|
session_id = '$session_id'";
|
|
$rs1 = Database::query($sql);
|
|
$num_rows = Database::num_rows($rs1);
|
|
|
|
if (0 == $num_rows) {
|
|
mkdir($new_pathname, api_get_permissions_for_new_directories());
|
|
|
|
// Insert new folder with destination session_id.
|
|
$params = [
|
|
'c_id' => $course_id,
|
|
'path' => $path,
|
|
'comment' => $document->comment,
|
|
'title' => basename($new_pathname),
|
|
'filetype' => 'folder',
|
|
'size' => '0',
|
|
'session_id' => $session_id,
|
|
];
|
|
Database::insert($table, $params);
|
|
}
|
|
}
|
|
} // en foreach
|
|
}
|
|
|
|
// TODO: chmodr() is a better name. Some corrections are needed. Documentation header to be added here.
|
|
/**
|
|
* @param string $path
|
|
*/
|
|
function api_chmod_R($path, $filemode)
|
|
{
|
|
if (!is_dir($path)) {
|
|
return chmod($path, $filemode);
|
|
}
|
|
|
|
$handler = opendir($path);
|
|
while ($file = readdir($handler)) {
|
|
if ('.' != $file && '..' != $file) {
|
|
$fullpath = "$path/$file";
|
|
if (!is_dir($fullpath)) {
|
|
if (!chmod($fullpath, $filemode)) {
|
|
return false;
|
|
}
|
|
} else {
|
|
if (!api_chmod_R($fullpath, $filemode)) {
|
|
return false;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
closedir($handler);
|
|
|
|
return chmod($path, $filemode);
|
|
}
|
|
|
|
// TODO: Where the following function has been copy/pased from? There is no information about author and license. Style, coding conventions...
|
|
/**
|
|
* Parse info file format. (e.g: file.info).
|
|
*
|
|
* Files should use an ini-like format to specify values.
|
|
* White-space generally doesn't matter, except inside values.
|
|
* e.g.
|
|
*
|
|
* @verbatim
|
|
* key = value
|
|
* key = "value"
|
|
* key = 'value'
|
|
* key = "multi-line
|
|
*
|
|
* value"
|
|
* key = 'multi-line
|
|
*
|
|
* value'
|
|
* key
|
|
* =
|
|
* 'value'
|
|
* @endverbatim
|
|
*
|
|
* Arrays are created using a GET-like syntax:
|
|
*
|
|
* @verbatim
|
|
* key[] = "numeric array"
|
|
* key[index] = "associative array"
|
|
* key[index][] = "nested numeric array"
|
|
* key[index][index] = "nested associative array"
|
|
* @endverbatim
|
|
*
|
|
* PHP constants are substituted in, but only when used as the entire value:
|
|
*
|
|
* Comments should start with a semi-colon at the beginning of a line.
|
|
*
|
|
* This function is NOT for placing arbitrary module-specific settings. Use
|
|
* variable_get() and variable_set() for that.
|
|
*
|
|
* Information stored in the module.info file:
|
|
* - name: The real name of the module for display purposes.
|
|
* - description: A brief description of the module.
|
|
* - dependencies: An array of shortnames of other modules this module depends on.
|
|
* - package: The name of the package of modules this module belongs to.
|
|
*
|
|
* Example of .info file:
|
|
* <code>
|
|
* @verbatim
|
|
* name = Forum
|
|
* description = Enables threaded discussions about general topics.
|
|
* dependencies[] = taxonomy
|
|
* dependencies[] = comment
|
|
* package = Core - optional
|
|
* version = VERSION
|
|
* @endverbatim
|
|
* </code>
|
|
*
|
|
* @param string $filename
|
|
* The file we are parsing. Accepts file with relative or absolute path.
|
|
*
|
|
* @return
|
|
* The info array
|
|
*/
|
|
function api_parse_info_file($filename)
|
|
{
|
|
$info = [];
|
|
|
|
if (!file_exists($filename)) {
|
|
return $info;
|
|
}
|
|
|
|
$data = file_get_contents($filename);
|
|
if (preg_match_all('
|
|
@^\s* # Start at the beginning of a line, ignoring leading whitespace
|
|
((?:
|
|
[^=;\[\]]| # Key names cannot contain equal signs, semi-colons or square brackets,
|
|
\[[^\[\]]*\] # unless they are balanced and not nested
|
|
)+?)
|
|
\s*=\s* # Key/value pairs are separated by equal signs (ignoring white-space)
|
|
(?:
|
|
("(?:[^"]|(?<=\\\\)")*")| # Double-quoted string, which may contain slash-escaped quotes/slashes
|
|
(\'(?:[^\']|(?<=\\\\)\')*\')| # Single-quoted string, which may contain slash-escaped quotes/slashes
|
|
([^\r\n]*?) # Non-quoted string
|
|
)\s*$ # Stop at the next end of a line, ignoring trailing whitespace
|
|
@msx', $data, $matches, PREG_SET_ORDER)) {
|
|
$key = $value1 = $value2 = $value3 = '';
|
|
foreach ($matches as $match) {
|
|
// Fetch the key and value string.
|
|
$i = 0;
|
|
foreach (['key', 'value1', 'value2', 'value3'] as $var) {
|
|
$$var = isset($match[++$i]) ? $match[$i] : '';
|
|
}
|
|
$value = stripslashes(substr($value1, 1, -1)).stripslashes(substr($value2, 1, -1)).$value3;
|
|
|
|
// Parse array syntax.
|
|
$keys = preg_split('/\]?\[/', rtrim($key, ']'));
|
|
$last = array_pop($keys);
|
|
$parent = &$info;
|
|
|
|
// Create nested arrays.
|
|
foreach ($keys as $key) {
|
|
if ('' == $key) {
|
|
$key = count($parent);
|
|
}
|
|
if (!isset($parent[$key]) || !is_array($parent[$key])) {
|
|
$parent[$key] = [];
|
|
}
|
|
$parent = &$parent[$key];
|
|
}
|
|
|
|
// Handle PHP constants.
|
|
if (defined($value)) {
|
|
$value = constant($value);
|
|
}
|
|
|
|
// Insert actual value.
|
|
if ('' == $last) {
|
|
$last = count($parent);
|
|
}
|
|
$parent[$last] = $value;
|
|
}
|
|
}
|
|
|
|
return $info;
|
|
}
|
|
|
|
/**
|
|
* Gets Chamilo version from the configuration files.
|
|
*
|
|
* @return string A string of type "1.8.4", or an empty string if the version could not be found
|
|
*/
|
|
function api_get_version()
|
|
{
|
|
return (string) api_get_configuration_value('system_version');
|
|
}
|
|
|
|
/**
|
|
* Gets the software name (the name/brand of the Chamilo-based customized system).
|
|
*
|
|
* @return string
|
|
*/
|
|
function api_get_software_name()
|
|
{
|
|
$name = api_get_configuration_value('software_name');
|
|
if (!empty($name)) {
|
|
return $name;
|
|
} else {
|
|
return 'Chamilo';
|
|
}
|
|
}
|
|
|
|
function api_get_status_list()
|
|
{
|
|
$list = [];
|
|
// Table of status
|
|
$list[COURSEMANAGER] = 'teacher'; // 1
|
|
$list[SESSIONADMIN] = 'session_admin'; // 3
|
|
$list[DRH] = 'drh'; // 4
|
|
$list[STUDENT] = 'user'; // 5
|
|
$list[ANONYMOUS] = 'anonymous'; // 6
|
|
$list[INVITEE] = 'invited'; // 20
|
|
|
|
return $list;
|
|
}
|
|
|
|
/**
|
|
* Checks whether status given in parameter exists in the platform.
|
|
*
|
|
* @param mixed the status (can be either int either string)
|
|
*
|
|
* @return bool if the status exists, else returns false
|
|
*/
|
|
function api_status_exists($status_asked)
|
|
{
|
|
$list = api_get_status_list();
|
|
|
|
return in_array($status_asked, $list) ? true : isset($list[$status_asked]);
|
|
}
|
|
|
|
/**
|
|
* Checks whether status given in parameter exists in the platform. The function
|
|
* returns the status ID or false if it does not exist, but given the fact there
|
|
* is no "0" status, the return value can be checked against
|
|
* if(api_status_key()) to know if it exists.
|
|
*
|
|
* @param mixed The status (can be either int or string)
|
|
*
|
|
* @return mixed Status ID if exists, false otherwise
|
|
*/
|
|
function api_status_key($status)
|
|
{
|
|
$list = api_get_status_list();
|
|
|
|
return isset($list[$status]) ? $status : array_search($status, $list);
|
|
}
|
|
|
|
/**
|
|
* Gets the status langvars list.
|
|
*
|
|
* @return string[] the list of status with their translations
|
|
*/
|
|
function api_get_status_langvars()
|
|
{
|
|
return [
|
|
COURSEMANAGER => get_lang('Teacher'),
|
|
SESSIONADMIN => get_lang('Sessions administrator'),
|
|
DRH => get_lang('Human Resources Manager'),
|
|
STUDENT => get_lang('Learner'),
|
|
ANONYMOUS => get_lang('Anonymous'),
|
|
STUDENT_BOSS => get_lang('Student boss'),
|
|
INVITEE => get_lang('Invited'),
|
|
];
|
|
}
|
|
|
|
/**
|
|
* The function that retrieves all the possible settings for a certain config setting.
|
|
*
|
|
* @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
|
|
*/
|
|
function api_get_settings_options($var)
|
|
{
|
|
$table_settings_options = Database::get_main_table(TABLE_MAIN_SETTINGS_OPTIONS);
|
|
$var = Database::escape_string($var);
|
|
$sql = "SELECT * FROM $table_settings_options
|
|
WHERE variable = '$var'
|
|
ORDER BY id";
|
|
$result = Database::query($sql);
|
|
$settings_options_array = [];
|
|
while ($row = Database::fetch_assoc($result)) {
|
|
$settings_options_array[] = $row;
|
|
}
|
|
|
|
return $settings_options_array;
|
|
}
|
|
|
|
/**
|
|
* @param array $params
|
|
*/
|
|
function api_set_setting_option($params)
|
|
{
|
|
$table = Database::get_main_table(TABLE_MAIN_SETTINGS_OPTIONS);
|
|
if (empty($params['id'])) {
|
|
Database::insert($table, $params);
|
|
} else {
|
|
Database::update($table, $params, ['id = ? ' => $params['id']]);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param array $params
|
|
*/
|
|
function api_set_setting_simple($params)
|
|
{
|
|
$table = Database::get_main_table(TABLE_MAIN_SETTINGS);
|
|
$url_id = api_get_current_access_url_id();
|
|
|
|
if (empty($params['id'])) {
|
|
$params['access_url'] = $url_id;
|
|
Database::insert($table, $params);
|
|
} else {
|
|
Database::update($table, $params, ['id = ? ' => [$params['id']]]);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param int $id
|
|
*/
|
|
function api_delete_setting_option($id)
|
|
{
|
|
$table = Database::get_main_table(TABLE_MAIN_SETTINGS_OPTIONS);
|
|
if (!empty($id)) {
|
|
Database::delete($table, ['id = ? ' => $id]);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Sets a platform configuration setting to a given value.
|
|
*
|
|
* @param string The variable we want to update
|
|
* @param string The value we want to record
|
|
* @param string The sub-variable if any (in most cases, this will remain null)
|
|
* @param string The category if any (in most cases, this will remain null)
|
|
* @param int The access_url for which this parameter is valid
|
|
* @param string $cat
|
|
*
|
|
* @return bool|null
|
|
*/
|
|
function api_set_setting($var, $value, $subvar = null, $cat = null, $access_url = 1)
|
|
{
|
|
if (empty($var)) {
|
|
return false;
|
|
}
|
|
$t_settings = Database::get_main_table(TABLE_MAIN_SETTINGS);
|
|
$var = Database::escape_string($var);
|
|
$value = Database::escape_string($value);
|
|
$access_url = (int) $access_url;
|
|
if (empty($access_url)) {
|
|
$access_url = 1;
|
|
}
|
|
$select = "SELECT id FROM $t_settings WHERE variable = '$var' ";
|
|
if (!empty($subvar)) {
|
|
$subvar = Database::escape_string($subvar);
|
|
$select .= " AND subkey = '$subvar'";
|
|
}
|
|
if (!empty($cat)) {
|
|
$cat = Database::escape_string($cat);
|
|
$select .= " AND category = '$cat'";
|
|
}
|
|
if ($access_url > 1) {
|
|
$select .= " AND access_url = $access_url";
|
|
} else {
|
|
$select .= " AND access_url = 1 ";
|
|
}
|
|
|
|
$res = Database::query($select);
|
|
if (Database::num_rows($res) > 0) {
|
|
// Found item for this access_url.
|
|
$row = Database::fetch_array($res);
|
|
$sql = "UPDATE $t_settings SET selected_value = '$value'
|
|
WHERE id = ".$row['id'];
|
|
Database::query($sql);
|
|
} else {
|
|
// Item not found for this access_url, we have to check if it exist with access_url = 1
|
|
$select = "SELECT * FROM $t_settings
|
|
WHERE variable = '$var' AND access_url = 1 ";
|
|
// Just in case
|
|
if (1 == $access_url) {
|
|
if (!empty($subvar)) {
|
|
$select .= " AND subkey = '$subvar'";
|
|
}
|
|
if (!empty($cat)) {
|
|
$select .= " AND category = '$cat'";
|
|
}
|
|
$res = Database::query($select);
|
|
if (Database::num_rows($res) > 0) {
|
|
// We have a setting for access_url 1, but none for the current one, so create one.
|
|
$row = Database::fetch_array($res);
|
|
$insert = "INSERT INTO $t_settings (variable, subkey, type,category, selected_value, title, comment, scope, subkeytext, access_url)
|
|
VALUES
|
|
('".$row['variable']."',".(!empty($row['subkey']) ? "'".$row['subkey']."'" : "NULL").",".
|
|
"'".$row['type']."','".$row['category']."',".
|
|
"'$value','".$row['title']."',".
|
|
"".(!empty($row['comment']) ? "'".$row['comment']."'" : "NULL").",".(!empty($row['scope']) ? "'".$row['scope']."'" : "NULL").",".
|
|
"".(!empty($row['subkeytext']) ? "'".$row['subkeytext']."'" : "NULL").",$access_url)";
|
|
Database::query($insert);
|
|
} else {
|
|
// Such a setting does not exist.
|
|
//error_log(__FILE__.':'.__LINE__.': Attempting to update setting '.$var.' ('.$subvar.') which does not exist at all', 0);
|
|
}
|
|
} else {
|
|
// Other access url.
|
|
if (!empty($subvar)) {
|
|
$select .= " AND subkey = '$subvar'";
|
|
}
|
|
if (!empty($cat)) {
|
|
$select .= " AND category = '$cat'";
|
|
}
|
|
$res = Database::query($select);
|
|
|
|
if (Database::num_rows($res) > 0) {
|
|
// We have a setting for access_url 1, but none for the current one, so create one.
|
|
$row = Database::fetch_array($res);
|
|
if (1 == $row['access_url_changeable']) {
|
|
$insert = "INSERT INTO $t_settings (variable,subkey, type,category, selected_value,title, comment,scope, subkeytext,access_url, access_url_changeable) VALUES
|
|
('".$row['variable']."',".
|
|
(!empty($row['subkey']) ? "'".$row['subkey']."'" : "NULL").",".
|
|
"'".$row['type']."','".$row['category']."',".
|
|
"'$value','".$row['title']."',".
|
|
"".(!empty($row['comment']) ? "'".$row['comment']."'" : "NULL").",".
|
|
(!empty($row['scope']) ? "'".$row['scope']."'" : "NULL").",".
|
|
"".(!empty($row['subkeytext']) ? "'".$row['subkeytext']."'" : "NULL").",$access_url,".$row['access_url_changeable'].")";
|
|
Database::query($insert);
|
|
}
|
|
} else { // Such a setting does not exist.
|
|
//error_log(__FILE__.':'.__LINE__.': Attempting to update setting '.$var.' ('.$subvar.') which does not exist at all. The access_url is: '.$access_url.' ',0);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Sets a whole category of settings to one specific value.
|
|
*
|
|
* @param string Category
|
|
* @param string Value
|
|
* @param int Access URL. Optional. Defaults to 1
|
|
* @param array Optional array of filters on field type
|
|
* @param string $category
|
|
* @param string $value
|
|
*
|
|
* @return bool
|
|
*/
|
|
function api_set_settings_category($category, $value = null, $access_url = 1, $fieldtype = [])
|
|
{
|
|
if (empty($category)) {
|
|
return false;
|
|
}
|
|
$category = Database::escape_string($category);
|
|
$t_s = Database::get_main_table(TABLE_MAIN_SETTINGS);
|
|
$access_url = (int) $access_url;
|
|
if (empty($access_url)) {
|
|
$access_url = 1;
|
|
}
|
|
if (isset($value)) {
|
|
$value = Database::escape_string($value);
|
|
$sql = "UPDATE $t_s SET selected_value = '$value'
|
|
WHERE category = '$category' AND access_url = $access_url";
|
|
if (is_array($fieldtype) && count($fieldtype) > 0) {
|
|
$sql .= " AND ( ";
|
|
$i = 0;
|
|
foreach ($fieldtype as $type) {
|
|
if ($i > 0) {
|
|
$sql .= ' OR ';
|
|
}
|
|
$type = Database::escape_string($type);
|
|
$sql .= " type='".$type."' ";
|
|
$i++;
|
|
}
|
|
$sql .= ")";
|
|
}
|
|
$res = Database::query($sql);
|
|
|
|
return false !== $res;
|
|
} else {
|
|
$sql = "UPDATE $t_s SET selected_value = NULL
|
|
WHERE category = '$category' AND access_url = $access_url";
|
|
if (is_array($fieldtype) && count($fieldtype) > 0) {
|
|
$sql .= " AND ( ";
|
|
$i = 0;
|
|
foreach ($fieldtype as $type) {
|
|
if ($i > 0) {
|
|
$sql .= ' OR ';
|
|
}
|
|
$type = Database::escape_string($type);
|
|
$sql .= " type='".$type."' ";
|
|
$i++;
|
|
}
|
|
$sql .= ")";
|
|
}
|
|
$res = Database::query($sql);
|
|
|
|
return false !== $res;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Gets all available access urls in an array (as in the database).
|
|
*
|
|
* @return array An array of database records
|
|
*/
|
|
function api_get_access_urls($from = 0, $to = 1000000, $order = 'url', $direction = 'ASC')
|
|
{
|
|
$table = Database::get_main_table(TABLE_MAIN_ACCESS_URL);
|
|
$from = (int) $from;
|
|
$to = (int) $to;
|
|
$order = Database::escape_string($order);
|
|
$direction = Database::escape_string($direction);
|
|
$direction = !in_array(strtolower(trim($direction)), ['asc', 'desc']) ? 'asc' : $direction;
|
|
$sql = "SELECT id, url, description, active, created_by, tms
|
|
FROM $table
|
|
ORDER BY `$order` $direction
|
|
LIMIT $to OFFSET $from";
|
|
$res = Database::query($sql);
|
|
|
|
return Database::store_result($res);
|
|
}
|
|
|
|
/**
|
|
* Gets the access url info in an array.
|
|
*
|
|
* @param int $id Id of the access url
|
|
* @param bool $returnDefault Set to false if you want the real URL if URL 1 is still 'http://localhost/'
|
|
*
|
|
* @return array All the info (url, description, active, created_by, tms)
|
|
* from the access_url table
|
|
*
|
|
* @author Julio Montoya
|
|
*/
|
|
function api_get_access_url($id, $returnDefault = true)
|
|
{
|
|
static $staticResult;
|
|
$id = (int) $id;
|
|
|
|
if (isset($staticResult[$id])) {
|
|
$result = $staticResult[$id];
|
|
} else {
|
|
// Calling the Database:: library dont work this is handmade.
|
|
$table_access_url = Database::get_main_table(TABLE_MAIN_ACCESS_URL);
|
|
$sql = "SELECT url, description, active, created_by, tms
|
|
FROM $table_access_url WHERE id = '$id' ";
|
|
$res = Database::query($sql);
|
|
$result = @Database::fetch_array($res);
|
|
$staticResult[$id] = $result;
|
|
}
|
|
|
|
// If the result url is 'http://localhost/' (the default) and the root_web
|
|
// (=current url) is different, and the $id is = 1 (which might mean
|
|
// api_get_current_access_url_id() returned 1 by default), then return the
|
|
// root_web setting instead of the current URL
|
|
// This is provided as an option to avoid breaking the storage of URL-specific
|
|
// homepages in home/localhost/
|
|
if (1 === $id && false === $returnDefault) {
|
|
$currentUrl = api_get_current_access_url_id();
|
|
// only do this if we are on the main URL (=1), otherwise we could get
|
|
// information on another URL instead of the one asked as parameter
|
|
if (1 === $currentUrl) {
|
|
$rootWeb = api_get_path(WEB_PATH);
|
|
$default = AccessUrl::DEFAULT_ACCESS_URL;
|
|
if ($result['url'] === $default && $rootWeb != $default) {
|
|
$result['url'] = $rootWeb;
|
|
}
|
|
}
|
|
}
|
|
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* Gets all the current settings for a specific access url.
|
|
*
|
|
* @param string The category, if any, that we want to get
|
|
* @param string Whether we want a simple list (display a category) or
|
|
* a grouped list (group by variable as in settings.php default). Values: 'list' or 'group'
|
|
* @param int Access URL's ID. Optional. Uses 1 by default, which is the unique URL
|
|
*
|
|
* @return array Array of database results for the current settings of the current access URL
|
|
*/
|
|
function &api_get_settings($cat = null, $ordering = 'list', $access_url = 1, $url_changeable = 0)
|
|
{
|
|
$table = Database::get_main_table(TABLE_MAIN_SETTINGS);
|
|
$access_url = (int) $access_url;
|
|
$where_condition = '';
|
|
if (1 == $url_changeable) {
|
|
$where_condition = " AND access_url_changeable= '1' ";
|
|
}
|
|
if (empty($access_url) || -1 == $access_url) {
|
|
$access_url = 1;
|
|
}
|
|
$sql = "SELECT * FROM $table
|
|
WHERE access_url = $access_url $where_condition ";
|
|
|
|
if (!empty($cat)) {
|
|
$cat = Database::escape_string($cat);
|
|
$sql .= " AND category='$cat' ";
|
|
}
|
|
if ('group' == $ordering) {
|
|
$sql .= " ORDER BY id ASC";
|
|
} else {
|
|
$sql .= " ORDER BY 1,2 ASC";
|
|
}
|
|
$result = Database::query($sql);
|
|
if (null === $result) {
|
|
$result = [];
|
|
return $result;
|
|
}
|
|
$result = Database::store_result($result, 'ASSOC');
|
|
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* @param string $value The value we want to record
|
|
* @param string $variable The variable name we want to insert
|
|
* @param string $subKey The subkey for the variable we want to insert
|
|
* @param string $type The type for the variable we want to insert
|
|
* @param string $category The category for the variable we want to insert
|
|
* @param string $title The title
|
|
* @param string $comment The comment
|
|
* @param string $scope The scope
|
|
* @param string $subKeyText The subkey text
|
|
* @param int $accessUrlId The access_url for which this parameter is valid
|
|
* @param int $visibility The changeability of this setting for non-master urls
|
|
*
|
|
* @return int The setting ID
|
|
*/
|
|
function api_add_setting(
|
|
$value,
|
|
$variable,
|
|
$subKey = '',
|
|
$type = 'textfield',
|
|
$category = '',
|
|
$title = '',
|
|
$comment = '',
|
|
$scope = '',
|
|
$subKeyText = '',
|
|
$accessUrlId = 1,
|
|
$visibility = 0
|
|
) {
|
|
$em = Database::getManager();
|
|
|
|
$settingRepo = $em->getRepository(SettingsCurrent::class);
|
|
$accessUrlId = (int) $accessUrlId ?: 1;
|
|
|
|
if (is_array($value)) {
|
|
$value = serialize($value);
|
|
} else {
|
|
$value = trim($value);
|
|
}
|
|
|
|
$criteria = ['variable' => $variable, 'url' => $accessUrlId];
|
|
|
|
if (!empty($subKey)) {
|
|
$criteria['subkey'] = $subKey;
|
|
}
|
|
|
|
// Check if this variable doesn't exist already
|
|
/** @var SettingsCurrent $setting */
|
|
$setting = $settingRepo->findOneBy($criteria);
|
|
|
|
if ($setting) {
|
|
$setting->setSelectedValue($value);
|
|
|
|
$em->persist($setting);
|
|
$em->flush();
|
|
|
|
return $setting->getId();
|
|
}
|
|
|
|
// Item not found for this access_url, we have to check if the whole thing is missing
|
|
// (in which case we ignore the insert) or if there *is* a record but just for access_url = 1
|
|
$setting = new SettingsCurrent();
|
|
$url = api_get_url_entity();
|
|
|
|
$setting
|
|
->setVariable($variable)
|
|
->setSelectedValue($value)
|
|
->setType($type)
|
|
->setCategory($category)
|
|
->setSubkey($subKey)
|
|
->setTitle($title)
|
|
->setComment($comment)
|
|
->setScope($scope)
|
|
->setSubkeytext($subKeyText)
|
|
->setUrl(api_get_url_entity())
|
|
->setAccessUrlChangeable($visibility);
|
|
|
|
$em->persist($setting);
|
|
$em->flush();
|
|
|
|
return $setting->getId();
|
|
}
|
|
|
|
/**
|
|
* Checks wether a user can or can't view the contents of a course.
|
|
*
|
|
* @deprecated use CourseManager::is_user_subscribed_in_course
|
|
*
|
|
* @param int $userid User id or NULL to get it from $_SESSION
|
|
* @param int $cid course id to check whether the user is allowed
|
|
*
|
|
* @return bool
|
|
*/
|
|
function api_is_course_visible_for_user($userid = null, $cid = null)
|
|
{
|
|
if (null === $userid) {
|
|
$userid = api_get_user_id();
|
|
}
|
|
if (empty($userid) || strval(intval($userid)) != $userid) {
|
|
if (api_is_anonymous()) {
|
|
$userid = api_get_anonymous_id();
|
|
} else {
|
|
return false;
|
|
}
|
|
}
|
|
$cid = Database::escape_string($cid);
|
|
|
|
$courseInfo = api_get_course_info($cid);
|
|
$courseId = $courseInfo['real_id'];
|
|
$is_platformAdmin = api_is_platform_admin();
|
|
|
|
$course_table = Database::get_main_table(TABLE_MAIN_COURSE);
|
|
$course_cat_table = Database::get_main_table(TABLE_MAIN_CATEGORY);
|
|
|
|
$sql = "SELECT
|
|
$course_cat_table.code AS category_code,
|
|
$course_table.visibility,
|
|
$course_table.code,
|
|
$course_cat_table.code
|
|
FROM $course_table
|
|
LEFT JOIN $course_cat_table
|
|
ON $course_table.category_id = $course_cat_table.id
|
|
WHERE
|
|
$course_table.code = '$cid'
|
|
LIMIT 1";
|
|
|
|
$result = Database::query($sql);
|
|
|
|
if (Database::num_rows($result) > 0) {
|
|
$visibility = Database::fetch_array($result);
|
|
$visibility = $visibility['visibility'];
|
|
} else {
|
|
$visibility = 0;
|
|
}
|
|
// Shortcut permissions in case the visibility is "open to the world".
|
|
if (COURSE_VISIBILITY_OPEN_WORLD === $visibility) {
|
|
return true;
|
|
}
|
|
|
|
$tbl_course_user = Database::get_main_table(TABLE_MAIN_COURSE_USER);
|
|
|
|
$sql = "SELECT
|
|
is_tutor, status
|
|
FROM $tbl_course_user
|
|
WHERE
|
|
user_id = '$userid' AND
|
|
relation_type <> '".COURSE_RELATION_TYPE_RRHH."' AND
|
|
c_id = $courseId
|
|
LIMIT 1";
|
|
|
|
$result = Database::query($sql);
|
|
|
|
if (Database::num_rows($result) > 0) {
|
|
// This user has got a recorded state for this course.
|
|
$cuData = Database::fetch_array($result);
|
|
$is_courseMember = true;
|
|
$is_courseAdmin = (1 == $cuData['status']);
|
|
}
|
|
|
|
if (!$is_courseAdmin) {
|
|
// This user has no status related to this course.
|
|
// Is it the session coach or the session admin?
|
|
$tbl_session = Database::get_main_table(TABLE_MAIN_SESSION);
|
|
$tbl_session_course = Database::get_main_table(TABLE_MAIN_SESSION_COURSE);
|
|
$tblSessionRelUser = Database::get_main_table(TABLE_MAIN_SESSION_USER);
|
|
$tbl_session_course_user = Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER);
|
|
|
|
$sql = "SELECT sru_2.user_id AS session_admin_id, sru_1.user_id AS session_coach_id
|
|
FROM $tbl_session AS s
|
|
INNER JOIN $tblSessionRelUser sru_1
|
|
ON (sru_1.session_id = s.id AND sru_1.relation_type = ".SessionEntity::GENERAL_COACH.")
|
|
INNER JOIN $tblSessionRelUser sru_2
|
|
ON (sru_2.session_id = s.id AND sru_2.relation_type = ".SessionEntity::SESSION_ADMIN.")
|
|
INNER JOIN $tbl_session_course src
|
|
ON (src.session_id = s.id AND src.c_id = $courseId)";
|
|
|
|
$result = Database::query($sql);
|
|
$row = Database::store_result($result);
|
|
$sessionAdminsId = array_column($row, 'session_admin_id');
|
|
$sessionCoachesId = array_column($row, 'session_coach_id');
|
|
|
|
if (in_array($userid, $sessionCoachesId)) {
|
|
$is_courseMember = true;
|
|
$is_courseAdmin = false;
|
|
} elseif (in_array($userid, $sessionAdminsId)) {
|
|
$is_courseMember = false;
|
|
$is_courseAdmin = false;
|
|
} else {
|
|
// Check if the current user is the course coach.
|
|
$sql = "SELECT 1
|
|
FROM $tbl_session_course
|
|
WHERE session_rel_course.c_id = '$courseId'
|
|
AND session_rel_course.id_coach = '$userid'
|
|
LIMIT 1";
|
|
|
|
$result = Database::query($sql);
|
|
|
|
//if ($row = Database::fetch_array($result)) {
|
|
if (Database::num_rows($result) > 0) {
|
|
$is_courseMember = true;
|
|
$tbl_user = Database::get_main_table(TABLE_MAIN_USER);
|
|
|
|
$sql = "SELECT status FROM $tbl_user
|
|
WHERE id = $userid
|
|
LIMIT 1";
|
|
|
|
$result = Database::query($sql);
|
|
|
|
if (1 == Database::result($result, 0, 0)) {
|
|
$is_courseAdmin = true;
|
|
} else {
|
|
$is_courseAdmin = false;
|
|
}
|
|
} else {
|
|
// Check if the user is a student is this session.
|
|
$sql = "SELECT id
|
|
FROM $tbl_session_course_user
|
|
WHERE
|
|
user_id = '$userid' AND
|
|
c_id = '$courseId'
|
|
LIMIT 1";
|
|
|
|
if (Database::num_rows($result) > 0) {
|
|
// This user haa got a recorded state for this course.
|
|
while ($row = Database::fetch_array($result)) {
|
|
$is_courseMember = true;
|
|
$is_courseAdmin = false;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
switch ($visibility) {
|
|
case Course::OPEN_WORLD:
|
|
return true;
|
|
case Course::OPEN_PLATFORM:
|
|
return isset($userid);
|
|
case Course::REGISTERED:
|
|
case Course::CLOSED:
|
|
return $is_platformAdmin || $is_courseMember || $is_courseAdmin;
|
|
case Course::HIDDEN:
|
|
return $is_platformAdmin;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Returns whether an element (forum, message, survey ...) belongs to a session or not.
|
|
*
|
|
* @param string the tool of the element
|
|
* @param int the element id in database
|
|
* @param int the session_id to compare with element session id
|
|
*
|
|
* @return bool true if the element is in the session, false else
|
|
*/
|
|
function api_is_element_in_the_session($tool, $element_id, $session_id = null)
|
|
{
|
|
if (is_null($session_id)) {
|
|
$session_id = api_get_session_id();
|
|
}
|
|
|
|
$element_id = (int) $element_id;
|
|
|
|
if (empty($element_id)) {
|
|
return false;
|
|
}
|
|
|
|
// Get information to build query depending of the tool.
|
|
switch ($tool) {
|
|
case TOOL_SURVEY:
|
|
$table_tool = Database::get_course_table(TABLE_SURVEY);
|
|
$key_field = 'survey_id';
|
|
break;
|
|
case TOOL_ANNOUNCEMENT:
|
|
$table_tool = Database::get_course_table(TABLE_ANNOUNCEMENT);
|
|
$key_field = 'id';
|
|
break;
|
|
case TOOL_AGENDA:
|
|
$table_tool = Database::get_course_table(TABLE_AGENDA);
|
|
$key_field = 'id';
|
|
break;
|
|
case TOOL_GROUP:
|
|
$table_tool = Database::get_course_table(TABLE_GROUP);
|
|
$key_field = 'id';
|
|
break;
|
|
default:
|
|
return false;
|
|
}
|
|
$course_id = api_get_course_int_id();
|
|
|
|
$sql = "SELECT session_id FROM $table_tool
|
|
WHERE c_id = $course_id AND $key_field = ".$element_id;
|
|
$rs = Database::query($sql);
|
|
if ($element_session_id = Database::result($rs, 0, 0)) {
|
|
if ($element_session_id == intval($session_id)) {
|
|
// The element belongs to the session.
|
|
return true;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Replaces "forbidden" characters in a filename string.
|
|
*
|
|
* @param string $filename
|
|
* @param bool $treat_spaces_as_hyphens
|
|
*
|
|
* @return string
|
|
*/
|
|
function api_replace_dangerous_char($filename, $treat_spaces_as_hyphens = true)
|
|
{
|
|
// Some non-properly encoded file names can cause the whole file to be
|
|
// skipped when uploaded. Avoid this by detecting the encoding and
|
|
// converting to UTF-8, setting the source as ASCII (a reasonably
|
|
// limited characters set) if nothing could be found (BT#
|
|
$encoding = api_detect_encoding($filename);
|
|
if (empty($encoding)) {
|
|
$encoding = 'ASCII';
|
|
if (!api_is_valid_ascii($filename)) {
|
|
// try iconv and try non standard ASCII a.k.a CP437
|
|
// see BT#15022
|
|
if (function_exists('iconv')) {
|
|
$result = iconv('CP437', 'UTF-8', $filename);
|
|
if (api_is_valid_utf8($result)) {
|
|
$filename = $result;
|
|
$encoding = 'UTF-8';
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
$filename = api_to_system_encoding($filename, $encoding);
|
|
|
|
$url = URLify::filter(
|
|
$filename,
|
|
250,
|
|
'',
|
|
true,
|
|
false,
|
|
false
|
|
);
|
|
|
|
// Replace multiple dots at the end.
|
|
$regex = "/\.+$/";
|
|
|
|
return preg_replace($regex, '', $url);
|
|
}
|
|
|
|
/**
|
|
* Fixes the $_SERVER['REQUEST_URI'] that is empty in IIS6.
|
|
*
|
|
* @author Ivan Tcholakov, 28-JUN-2006.
|
|
*/
|
|
function api_request_uri()
|
|
{
|
|
if (!empty($_SERVER['REQUEST_URI'])) {
|
|
return $_SERVER['REQUEST_URI'];
|
|
}
|
|
$uri = $_SERVER['SCRIPT_NAME'];
|
|
if (!empty($_SERVER['QUERY_STRING'])) {
|
|
$uri .= '?'.$_SERVER['QUERY_STRING'];
|
|
}
|
|
$_SERVER['REQUEST_URI'] = $uri;
|
|
|
|
return $uri;
|
|
}
|
|
|
|
/**
|
|
* Gets the current access_url id of the Chamilo Platform.
|
|
*
|
|
* @return int access_url_id of the current Chamilo Installation
|
|
*
|
|
* @author Julio Montoya <gugli100@gmail.com>
|
|
* @throws Exception
|
|
*/
|
|
function api_get_current_access_url_id(): int
|
|
{
|
|
if (false === api_get_multiple_access_url()) {
|
|
return 1;
|
|
}
|
|
|
|
static $id;
|
|
if (!empty($id)) {
|
|
return $id;
|
|
}
|
|
|
|
$table = Database::get_main_table(TABLE_MAIN_ACCESS_URL);
|
|
$path = Database::escape_string(api_get_path(WEB_PATH));
|
|
$sql = "SELECT id FROM $table WHERE url = '".$path."'";
|
|
$result = Database::query($sql);
|
|
if (Database::num_rows($result) > 0) {
|
|
$id = Database::result($result, 0, 0);
|
|
if (false === $id) {
|
|
return -1;
|
|
}
|
|
|
|
return (int) $id;
|
|
}
|
|
|
|
$id = 1;
|
|
|
|
//if the url in WEB_PATH was not found, it can only mean that there is
|
|
// either a configuration problem or the first URL has not been defined yet
|
|
// (by default it is http://localhost/). Thus the more sensible thing we can
|
|
// do is return 1 (the main URL) as the user cannot hack this value anyway
|
|
return 1;
|
|
}
|
|
|
|
/**
|
|
* Gets the registered urls from a given user id.
|
|
*
|
|
* @author Julio Montoya <gugli100@gmail.com>
|
|
*
|
|
* @param int $user_id
|
|
*
|
|
* @return array
|
|
*/
|
|
function api_get_access_url_from_user($user_id)
|
|
{
|
|
$user_id = (int) $user_id;
|
|
$table_url_rel_user = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_USER);
|
|
$table_url = Database::get_main_table(TABLE_MAIN_ACCESS_URL);
|
|
$sql = "SELECT access_url_id
|
|
FROM $table_url_rel_user url_rel_user
|
|
INNER JOIN $table_url u
|
|
ON (url_rel_user.access_url_id = u.id)
|
|
WHERE user_id = ".$user_id;
|
|
$result = Database::query($sql);
|
|
$list = [];
|
|
while ($row = Database::fetch_assoc($result)) {
|
|
$list[] = $row['access_url_id'];
|
|
}
|
|
|
|
return $list;
|
|
}
|
|
|
|
/**
|
|
* Checks whether the curent user is in a group or not.
|
|
*
|
|
* @param string The group id - optional (takes it from session if not given)
|
|
* @param string The course code - optional (no additional check by course if course code is not given)
|
|
*
|
|
* @return bool
|
|
*
|
|
* @author Ivan Tcholakov
|
|
*/
|
|
function api_is_in_group($groupIdParam = null, $courseCodeParam = null)
|
|
{
|
|
if (!empty($courseCodeParam)) {
|
|
$courseCode = api_get_course_id();
|
|
if (!empty($courseCode)) {
|
|
if ($courseCodeParam != $courseCode) {
|
|
return false;
|
|
}
|
|
} else {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
$groupId = api_get_group_id();
|
|
|
|
if (isset($groupId) && '' != $groupId) {
|
|
if (!empty($groupIdParam)) {
|
|
return $groupIdParam == $groupId;
|
|
} else {
|
|
return true;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Checks whether a secret key is valid.
|
|
*
|
|
* @param string $original_key_secret - secret key from (webservice) client
|
|
* @param string $security_key - security key from Chamilo
|
|
*
|
|
* @return bool - true if secret key is valid, false otherwise
|
|
*/
|
|
function api_is_valid_secret_key($original_key_secret, $security_key)
|
|
{
|
|
if (empty($original_key_secret) || empty($security_key)) {
|
|
return false;
|
|
}
|
|
|
|
return (string) $original_key_secret === sha1($security_key);
|
|
}
|
|
|
|
/**
|
|
* Checks whether the server's operating system is Windows (TM).
|
|
*
|
|
* @return bool - true if the operating system is Windows, false otherwise
|
|
*/
|
|
function api_is_windows_os()
|
|
{
|
|
if (function_exists('php_uname')) {
|
|
// php_uname() exists as of PHP 4.0.2, according to the documentation.
|
|
// We expect that this function will always work for Chamilo 1.8.x.
|
|
$os = php_uname();
|
|
}
|
|
// The following methods are not needed, but let them stay, just in case.
|
|
elseif (isset($_ENV['OS'])) {
|
|
// Sometimes $_ENV['OS'] may not be present (bugs?)
|
|
$os = $_ENV['OS'];
|
|
} elseif (defined('PHP_OS')) {
|
|
// PHP_OS means on which OS PHP was compiled, this is why
|
|
// using PHP_OS is the last choice for detection.
|
|
$os = PHP_OS;
|
|
} else {
|
|
return false;
|
|
}
|
|
|
|
return 'win' == strtolower(substr((string) $os, 0, 3));
|
|
}
|
|
|
|
/**
|
|
* This function informs whether the sent request is XMLHttpRequest.
|
|
*/
|
|
function api_is_xml_http_request()
|
|
{
|
|
return isset($_SERVER['HTTP_X_REQUESTED_WITH']) && 'xmlhttprequest' == strtolower($_SERVER['HTTP_X_REQUESTED_WITH']);
|
|
}
|
|
|
|
/**
|
|
* Returns a list of Chamilo's tools or
|
|
* checks whether a given identificator is a valid Chamilo's tool.
|
|
*
|
|
* @author Isaac flores paz
|
|
*
|
|
* @param string The tool name to filter
|
|
*
|
|
* @return mixed Filtered string or array
|
|
*/
|
|
function api_get_tools_lists($my_tool = null)
|
|
{
|
|
$tools_list = [
|
|
TOOL_DOCUMENT,
|
|
TOOL_THUMBNAIL,
|
|
TOOL_HOTPOTATOES,
|
|
TOOL_CALENDAR_EVENT,
|
|
TOOL_LINK,
|
|
TOOL_COURSE_DESCRIPTION,
|
|
TOOL_SEARCH,
|
|
TOOL_LEARNPATH,
|
|
TOOL_ANNOUNCEMENT,
|
|
TOOL_FORUM,
|
|
TOOL_THREAD,
|
|
TOOL_POST,
|
|
TOOL_DROPBOX,
|
|
TOOL_QUIZ,
|
|
TOOL_USER,
|
|
TOOL_GROUP,
|
|
TOOL_BLOGS,
|
|
TOOL_CHAT,
|
|
TOOL_STUDENTPUBLICATION,
|
|
TOOL_TRACKING,
|
|
TOOL_HOMEPAGE_LINK,
|
|
TOOL_COURSE_SETTING,
|
|
TOOL_BACKUP,
|
|
TOOL_COPY_COURSE_CONTENT,
|
|
TOOL_RECYCLE_COURSE,
|
|
TOOL_COURSE_HOMEPAGE,
|
|
TOOL_COURSE_RIGHTS_OVERVIEW,
|
|
TOOL_UPLOAD,
|
|
TOOL_COURSE_MAINTENANCE,
|
|
TOOL_SURVEY,
|
|
//TOOL_WIKI,
|
|
TOOL_GLOSSARY,
|
|
TOOL_GRADEBOOK,
|
|
TOOL_NOTEBOOK,
|
|
TOOL_ATTENDANCE,
|
|
TOOL_COURSE_PROGRESS,
|
|
];
|
|
if (empty($my_tool)) {
|
|
return $tools_list;
|
|
}
|
|
|
|
return in_array($my_tool, $tools_list) ? $my_tool : '';
|
|
}
|
|
|
|
/**
|
|
* Checks whether we already approved the last version term and condition.
|
|
*
|
|
* @param int user id
|
|
*
|
|
* @return bool true if we pass false otherwise
|
|
*/
|
|
function api_check_term_condition($userId)
|
|
{
|
|
if ('true' === api_get_setting('allow_terms_conditions')) {
|
|
// Check if exists terms and conditions
|
|
if (0 == LegalManager::count()) {
|
|
return true;
|
|
}
|
|
|
|
$extraFieldValue = new ExtraFieldValue('user');
|
|
$data = $extraFieldValue->get_values_by_handler_and_field_variable(
|
|
$userId,
|
|
'legal_accept'
|
|
);
|
|
|
|
if (!empty($data) && isset($data['value']) && !empty($data['value'])) {
|
|
$result = $data['value'];
|
|
$user_conditions = explode(':', $result);
|
|
$version = $user_conditions[0];
|
|
$langId = $user_conditions[1];
|
|
$realVersion = LegalManager::get_last_version($langId);
|
|
|
|
return $version >= $realVersion;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Gets all information of a tool into course.
|
|
*
|
|
* @param int The tool id
|
|
*
|
|
* @return array
|
|
*/
|
|
function api_get_tool_information_by_name($name)
|
|
{
|
|
$t_tool = Database::get_course_table(TABLE_TOOL_LIST);
|
|
$course_id = api_get_course_int_id();
|
|
|
|
$sql = "SELECT id FROM tool
|
|
WHERE title = '".Database::escape_string($name)."' ";
|
|
$rs = Database::query($sql);
|
|
$data = Database::fetch_array($rs);
|
|
if ($data) {
|
|
$tool = $data['id'];
|
|
$sql = "SELECT * FROM $t_tool
|
|
WHERE c_id = $course_id AND tool_id = '".$tool."' ";
|
|
$rs = Database::query($sql);
|
|
|
|
return Database::fetch_assoc($rs);
|
|
}
|
|
|
|
return [];
|
|
}
|
|
|
|
/**
|
|
* Function used to protect a "global" admin script.
|
|
* The function blocks access when the user has no global platform admin rights.
|
|
* Global admins are the admins that are registered in the main.admin table
|
|
* AND the users who have access to the "principal" portal.
|
|
* That means that there is a record in the main.access_url_rel_user table
|
|
* with his user id and the access_url_id=1.
|
|
*
|
|
* @author Julio Montoya
|
|
*
|
|
* @param int $user_id
|
|
*
|
|
* @return bool
|
|
*/
|
|
function api_is_global_platform_admin($user_id = null)
|
|
{
|
|
$user_id = (int) $user_id;
|
|
if (empty($user_id)) {
|
|
$user_id = api_get_user_id();
|
|
}
|
|
if (api_is_platform_admin_by_id($user_id)) {
|
|
$urlList = api_get_access_url_from_user($user_id);
|
|
// The admin is registered in the first "main" site with access_url_id = 1
|
|
if (in_array(1, $urlList)) {
|
|
return true;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* @param int $admin_id_to_check
|
|
* @param int $userId
|
|
* @param bool $allow_session_admin
|
|
*
|
|
* @return bool
|
|
*/
|
|
function api_global_admin_can_edit_admin(
|
|
$admin_id_to_check,
|
|
$userId = 0,
|
|
$allow_session_admin = false
|
|
) {
|
|
if (empty($userId)) {
|
|
$userId = api_get_user_id();
|
|
}
|
|
|
|
$iam_a_global_admin = api_is_global_platform_admin($userId);
|
|
$user_is_global_admin = api_is_global_platform_admin($admin_id_to_check);
|
|
|
|
if ($iam_a_global_admin) {
|
|
// Global admin can edit everything
|
|
return true;
|
|
}
|
|
|
|
// If i'm a simple admin
|
|
$is_platform_admin = api_is_platform_admin_by_id($userId);
|
|
|
|
if ($allow_session_admin && !$is_platform_admin) {
|
|
$user = api_get_user_entity($userId);
|
|
$is_platform_admin = $user->hasRole('ROLE_SESSION_MANAGER');
|
|
}
|
|
|
|
if ($is_platform_admin) {
|
|
if ($user_is_global_admin) {
|
|
return false;
|
|
} else {
|
|
return true;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* @param int $admin_id_to_check
|
|
* @param int $userId
|
|
* @param bool $allow_session_admin
|
|
*
|
|
* @return bool|null
|
|
*/
|
|
function api_protect_super_admin($admin_id_to_check, $userId = null, $allow_session_admin = false)
|
|
{
|
|
if (api_global_admin_can_edit_admin($admin_id_to_check, $userId, $allow_session_admin)) {
|
|
return true;
|
|
} else {
|
|
api_not_allowed();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Function used to protect a global admin script.
|
|
* The function blocks access when the user has no global platform admin rights.
|
|
* See also the api_is_global_platform_admin() function wich defines who's a "global" admin.
|
|
*
|
|
* @author Julio Montoya
|
|
*/
|
|
function api_protect_global_admin_script()
|
|
{
|
|
if (!api_is_global_platform_admin()) {
|
|
api_not_allowed();
|
|
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Check browser support for specific file types or features
|
|
* This function checks if the user's browser supports a file format or given
|
|
* feature, or returns the current browser and major version when
|
|
* $format=check_browser. Only a limited number of formats and features are
|
|
* checked by this method. Make sure you check its definition first.
|
|
*
|
|
* @param string $format Can be a file format (extension like svg, webm, ...) or a feature (like autocapitalize, ...)
|
|
*
|
|
* @deprecated
|
|
*
|
|
* @return bool or return text array if $format=check_browser
|
|
*
|
|
* @author Juan Carlos Raña Trabado
|
|
*/
|
|
function api_browser_support($format = '')
|
|
{
|
|
return true;
|
|
|
|
$browser = new Browser();
|
|
$current_browser = $browser->getBrowser();
|
|
$a_versiontemp = explode('.', $browser->getVersion());
|
|
$current_majorver = $a_versiontemp[0];
|
|
|
|
static $result;
|
|
|
|
if (isset($result[$format])) {
|
|
return $result[$format];
|
|
}
|
|
|
|
// Native svg support
|
|
if ('svg' == $format) {
|
|
if (('Internet Explorer' == $current_browser && $current_majorver >= 9) ||
|
|
('Firefox' == $current_browser && $current_majorver > 1) ||
|
|
('Safari' == $current_browser && $current_majorver >= 4) ||
|
|
('Chrome' == $current_browser && $current_majorver >= 1) ||
|
|
('Opera' == $current_browser && $current_majorver >= 9)
|
|
) {
|
|
$result[$format] = true;
|
|
|
|
return true;
|
|
} else {
|
|
$result[$format] = false;
|
|
|
|
return false;
|
|
}
|
|
} elseif ('pdf' == $format) {
|
|
// native pdf support
|
|
if ('Chrome' == $current_browser && $current_majorver >= 6) {
|
|
$result[$format] = true;
|
|
|
|
return true;
|
|
} else {
|
|
$result[$format] = false;
|
|
|
|
return false;
|
|
}
|
|
} elseif ('tif' == $format || 'tiff' == $format) {
|
|
//native tif support
|
|
if ('Safari' == $current_browser && $current_majorver >= 5) {
|
|
$result[$format] = true;
|
|
|
|
return true;
|
|
} else {
|
|
$result[$format] = false;
|
|
|
|
return false;
|
|
}
|
|
} elseif ('ogg' == $format || 'ogx' == $format || 'ogv' == $format || 'oga' == $format) {
|
|
//native ogg, ogv,oga support
|
|
if (('Firefox' == $current_browser && $current_majorver >= 3) ||
|
|
('Chrome' == $current_browser && $current_majorver >= 3) ||
|
|
('Opera' == $current_browser && $current_majorver >= 9)) {
|
|
$result[$format] = true;
|
|
|
|
return true;
|
|
} else {
|
|
$result[$format] = false;
|
|
|
|
return false;
|
|
}
|
|
} elseif ('mpg' == $format || 'mpeg' == $format) {
|
|
//native mpg support
|
|
if (('Safari' == $current_browser && $current_majorver >= 5)) {
|
|
$result[$format] = true;
|
|
|
|
return true;
|
|
} else {
|
|
$result[$format] = false;
|
|
|
|
return false;
|
|
}
|
|
} elseif ('mp4' == $format) {
|
|
//native mp4 support (TODO: Android, iPhone)
|
|
if ('Android' == $current_browser || 'iPhone' == $current_browser) {
|
|
$result[$format] = true;
|
|
|
|
return true;
|
|
} else {
|
|
$result[$format] = false;
|
|
|
|
return false;
|
|
}
|
|
} elseif ('mov' == $format) {
|
|
//native mov support( TODO:check iPhone)
|
|
if ('Safari' == $current_browser && $current_majorver >= 5 || 'iPhone' == $current_browser) {
|
|
$result[$format] = true;
|
|
|
|
return true;
|
|
} else {
|
|
$result[$format] = false;
|
|
|
|
return false;
|
|
}
|
|
} elseif ('avi' == $format) {
|
|
//native avi support
|
|
if ('Safari' == $current_browser && $current_majorver >= 5) {
|
|
$result[$format] = true;
|
|
|
|
return true;
|
|
} else {
|
|
$result[$format] = false;
|
|
|
|
return false;
|
|
}
|
|
} elseif ('wmv' == $format) {
|
|
//native wmv support
|
|
if ('Firefox' == $current_browser && $current_majorver >= 4) {
|
|
$result[$format] = true;
|
|
|
|
return true;
|
|
} else {
|
|
$result[$format] = false;
|
|
|
|
return false;
|
|
}
|
|
} elseif ('webm' == $format) {
|
|
//native webm support (TODO:check IE9, Chrome9, Android)
|
|
if (('Firefox' == $current_browser && $current_majorver >= 4) ||
|
|
('Opera' == $current_browser && $current_majorver >= 9) ||
|
|
('Internet Explorer' == $current_browser && $current_majorver >= 9) ||
|
|
('Chrome' == $current_browser && $current_majorver >= 9) ||
|
|
'Android' == $current_browser
|
|
) {
|
|
$result[$format] = true;
|
|
|
|
return true;
|
|
} else {
|
|
$result[$format] = false;
|
|
|
|
return false;
|
|
}
|
|
} elseif ('wav' == $format) {
|
|
//native wav support (only some codecs !)
|
|
if (('Firefox' == $current_browser && $current_majorver >= 4) ||
|
|
('Safari' == $current_browser && $current_majorver >= 5) ||
|
|
('Opera' == $current_browser && $current_majorver >= 9) ||
|
|
('Internet Explorer' == $current_browser && $current_majorver >= 9) ||
|
|
('Chrome' == $current_browser && $current_majorver > 9) ||
|
|
'Android' == $current_browser ||
|
|
'iPhone' == $current_browser
|
|
) {
|
|
$result[$format] = true;
|
|
|
|
return true;
|
|
} else {
|
|
$result[$format] = false;
|
|
|
|
return false;
|
|
}
|
|
} elseif ('mid' == $format || 'kar' == $format) {
|
|
//native midi support (TODO:check Android)
|
|
if ('Opera' == $current_browser && $current_majorver >= 9 || 'Android' == $current_browser) {
|
|
$result[$format] = true;
|
|
|
|
return true;
|
|
} else {
|
|
$result[$format] = false;
|
|
|
|
return false;
|
|
}
|
|
} elseif ('wma' == $format) {
|
|
//native wma support
|
|
if ('Firefox' == $current_browser && $current_majorver >= 4) {
|
|
$result[$format] = true;
|
|
|
|
return true;
|
|
} else {
|
|
$result[$format] = false;
|
|
|
|
return false;
|
|
}
|
|
} elseif ('au' == $format) {
|
|
//native au support
|
|
if ('Safari' == $current_browser && $current_majorver >= 5) {
|
|
$result[$format] = true;
|
|
|
|
return true;
|
|
} else {
|
|
$result[$format] = false;
|
|
|
|
return false;
|
|
}
|
|
} elseif ('mp3' == $format) {
|
|
//native mp3 support (TODO:check Android, iPhone)
|
|
if (('Safari' == $current_browser && $current_majorver >= 5) ||
|
|
('Chrome' == $current_browser && $current_majorver >= 6) ||
|
|
('Internet Explorer' == $current_browser && $current_majorver >= 9) ||
|
|
'Android' == $current_browser ||
|
|
'iPhone' == $current_browser ||
|
|
'Firefox' == $current_browser
|
|
) {
|
|
$result[$format] = true;
|
|
|
|
return true;
|
|
} else {
|
|
$result[$format] = false;
|
|
|
|
return false;
|
|
}
|
|
} elseif ('autocapitalize' == $format) {
|
|
// Help avoiding showing the autocapitalize option if the browser doesn't
|
|
// support it: this attribute is against the HTML5 standard
|
|
if ('Safari' == $current_browser || 'iPhone' == $current_browser) {
|
|
return true;
|
|
} else {
|
|
return false;
|
|
}
|
|
} elseif ("check_browser" == $format) {
|
|
$array_check_browser = [$current_browser, $current_majorver];
|
|
|
|
return $array_check_browser;
|
|
} else {
|
|
$result[$format] = false;
|
|
|
|
return false;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* This function checks if exist path and file browscap.ini
|
|
* In order for this to work, your browscap configuration setting in php.ini
|
|
* must point to the correct location of the browscap.ini file on your system
|
|
* http://php.net/manual/en/function.get-browser.php.
|
|
*
|
|
* @return bool
|
|
*
|
|
* @author Juan Carlos Raña Trabado
|
|
*/
|
|
function api_check_browscap()
|
|
{
|
|
$setting = ini_get('browscap');
|
|
if ($setting) {
|
|
$browser = get_browser($_SERVER['HTTP_USER_AGENT'], true);
|
|
if (strpos($setting, 'browscap.ini') && !empty($browser)) {
|
|
return true;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Returns the <script> HTML tag.
|
|
*/
|
|
function api_get_js($file)
|
|
{
|
|
return '<script src="'.api_get_path(WEB_LIBRARY_PATH).'javascript/'.$file.'"></script>'."\n";
|
|
}
|
|
|
|
function api_get_build_js($file)
|
|
{
|
|
return '<script src="'.api_get_path(WEB_PUBLIC_PATH).'build/'.$file.'"></script>'."\n";
|
|
}
|
|
|
|
function api_get_build_css($file, $media = 'screen')
|
|
{
|
|
return '<link
|
|
href="'.api_get_path(WEB_PUBLIC_PATH).'build/'.$file.'" rel="stylesheet" media="'.$media.'" type="text/css" />'."\n";
|
|
}
|
|
|
|
/**
|
|
* Returns the <script> HTML tag.
|
|
*
|
|
* @return string
|
|
*/
|
|
function api_get_asset($file)
|
|
{
|
|
return '<script src="'.api_get_path(WEB_PUBLIC_PATH).'build/libs/'.$file.'"></script>'."\n";
|
|
}
|
|
|
|
/**
|
|
* Returns the <script> HTML tag.
|
|
*
|
|
* @param string $file
|
|
* @param string $media
|
|
*
|
|
* @return string
|
|
*/
|
|
function api_get_css_asset($file, $media = 'screen')
|
|
{
|
|
return '<link
|
|
href="'.api_get_path(WEB_PUBLIC_PATH).'build/libs/'.$file.'"
|
|
rel="stylesheet" media="'.$media.'" type="text/css" />'."\n";
|
|
}
|
|
|
|
/**
|
|
* Returns the <link> HTML tag.
|
|
*
|
|
* @param string $file
|
|
* @param string $media
|
|
*/
|
|
function api_get_css($file, $media = 'screen')
|
|
{
|
|
return '<link href="'.$file.'" rel="stylesheet" media="'.$media.'" type="text/css" />'."\n";
|
|
}
|
|
|
|
function api_get_bootstrap_and_font_awesome($returnOnlyPath = false, $returnFileLocation = false)
|
|
{
|
|
$url = api_get_path(WEB_PUBLIC_PATH).'build/css/bootstrap.css';
|
|
|
|
if ($returnOnlyPath) {
|
|
if ($returnFileLocation) {
|
|
return api_get_path(SYS_PUBLIC_PATH).'build/css/bootstrap.css';
|
|
}
|
|
|
|
return $url;
|
|
}
|
|
|
|
return '<link href="'.$url.'" rel="stylesheet" type="text/css" />'."\n";
|
|
}
|
|
|
|
/**
|
|
* Returns the js header to include the jquery library.
|
|
*/
|
|
function api_get_jquery_js()
|
|
{
|
|
return api_get_asset('jquery/jquery.min.js');
|
|
}
|
|
|
|
/**
|
|
* Returns the jquery path.
|
|
*
|
|
* @return string
|
|
*/
|
|
function api_get_jquery_web_path()
|
|
{
|
|
return api_get_path(WEB_PUBLIC_PATH).'assets/jquery/jquery.min.js';
|
|
}
|
|
|
|
/**
|
|
* @return string
|
|
*/
|
|
function api_get_jquery_ui_js_web_path()
|
|
{
|
|
return api_get_path(WEB_PUBLIC_PATH).'assets/jquery-ui/jquery-ui.min.js';
|
|
}
|
|
|
|
/**
|
|
* @return string
|
|
*/
|
|
function api_get_jquery_ui_css_web_path()
|
|
{
|
|
return api_get_path(WEB_PUBLIC_PATH).'assets/jquery-ui/themes/smoothness/jquery-ui.min.css';
|
|
}
|
|
|
|
/**
|
|
* Returns the jquery-ui library js headers.
|
|
*
|
|
* @return string html tags
|
|
*/
|
|
function api_get_jquery_ui_js()
|
|
{
|
|
$libraries = [];
|
|
|
|
return api_get_jquery_libraries_js($libraries);
|
|
}
|
|
|
|
function api_get_jqgrid_js()
|
|
{
|
|
return api_get_build_css('legacy_free-jqgrid.css').PHP_EOL
|
|
.api_get_build_js('legacy_free-jqgrid.js');
|
|
}
|
|
|
|
/**
|
|
* Returns the jquery library js and css headers.
|
|
*
|
|
* @param array list of jquery libraries supported jquery-ui
|
|
* @param bool add the jquery library
|
|
*
|
|
* @return string html tags
|
|
*/
|
|
function api_get_jquery_libraries_js($libraries)
|
|
{
|
|
$js = '';
|
|
|
|
//Document multiple upload funcionality
|
|
if (in_array('jquery-uploadzs', $libraries)) {
|
|
$js .= api_get_asset('blueimp-load-image/js/load-image.all.min.js');
|
|
$js .= api_get_asset('blueimp-canvas-to-blob/js/canvas-to-blob.min.js');
|
|
$js .= api_get_asset('jquery-file-upload/js/jquery.iframe-transport.js');
|
|
$js .= api_get_asset('jquery-file-upload/js/jquery.fileupload.js');
|
|
$js .= api_get_asset('jquery-file-upload/js/jquery.fileupload-process.js');
|
|
$js .= api_get_asset('jquery-file-upload/js/jquery.fileupload-image.js');
|
|
$js .= api_get_asset('jquery-file-upload/js/jquery.fileupload-audio.js');
|
|
$js .= api_get_asset('jquery-file-upload/js/jquery.fileupload-video.js');
|
|
$js .= api_get_asset('jquery-file-upload/js/jquery.fileupload-validate.js');
|
|
|
|
$js .= api_get_css(api_get_path(WEB_PUBLIC_PATH).'assets/jquery-file-upload/css/jquery.fileupload.css');
|
|
$js .= api_get_css(api_get_path(WEB_PUBLIC_PATH).'assets/jquery-file-upload/css/jquery.fileupload-ui.css');
|
|
}
|
|
|
|
// jquery datepicker
|
|
if (in_array('datepicker', $libraries)) {
|
|
$languaje = 'en-GB';
|
|
$platform_isocode = strtolower(api_get_language_isocode());
|
|
|
|
$datapicker_langs = [
|
|
'af', 'ar', 'ar-DZ', 'az', 'bg', 'bs', 'ca', 'cs', 'cy-GB', 'da', 'de', 'el', 'en-AU', 'en-GB', 'en-NZ', 'eo', 'es', 'et', 'eu', 'fa', 'fi', 'fo', 'fr', 'fr-CH', 'gl', 'he', 'hi', 'hr', 'hu', 'hy', 'id', 'is', 'it', 'ja', 'ka', 'kk', 'km', 'ko', 'lb', 'lt', 'lv', 'mk', 'ml', 'ms', 'nl', 'nl-BE', 'no', 'pl', 'pt', 'pt-BR', 'rm', 'ro', 'ru', 'sk', 'sl', 'sq', 'sr', 'sr-SR', 'sv', 'ta', 'th', 'tj', 'tr', 'uk', 'vi', 'zh-CN', 'zh-HK', 'zh-TW',
|
|
];
|
|
if (in_array($platform_isocode, $datapicker_langs)) {
|
|
$languaje = $platform_isocode;
|
|
}
|
|
|
|
$js .= api_get_js('jquery-ui/jquery-ui-i18n.min.js');
|
|
$script = '<script>
|
|
$(function(){
|
|
$.datepicker.setDefaults($.datepicker.regional["'.$languaje.'"]);
|
|
$.datepicker.regional["local"] = $.datepicker.regional["'.$languaje.'"];
|
|
});
|
|
</script>
|
|
';
|
|
$js .= $script;
|
|
}
|
|
|
|
return $js;
|
|
}
|
|
|
|
/**
|
|
* Returns the URL to the course or session, removing the complexity of the URL
|
|
* building piece by piece.
|
|
*
|
|
* This function relies on api_get_course_info()
|
|
*
|
|
* @param int $courseId The course code - optional (takes it from context if not given)
|
|
* @param int $sessionId The session ID - optional (takes it from context if not given)
|
|
* @param int $groupId The group ID - optional (takes it from context if not given)
|
|
*
|
|
* @return string The URL to a course, a session, or empty string if nothing works
|
|
* e.g. https://localhost/courses/ABC/index.php?session_id=3&gidReq=1
|
|
*
|
|
* @author Julio Montoya
|
|
*/
|
|
function api_get_course_url($courseId = null, $sessionId = null, $groupId = null)
|
|
{
|
|
$url = '';
|
|
// If courseCode not set, get context or []
|
|
if (empty($courseId)) {
|
|
$courseId = api_get_course_int_id();
|
|
}
|
|
|
|
// If sessionId not set, get context or 0
|
|
if (empty($sessionId)) {
|
|
$sessionId = api_get_session_id();
|
|
}
|
|
|
|
// If groupId not set, get context or 0
|
|
if (empty($groupId)) {
|
|
$groupId = api_get_group_id();
|
|
}
|
|
|
|
// Build the URL
|
|
if (!empty($courseId)) {
|
|
$webCourseHome = '/course/'.$courseId.'/home';
|
|
// directory not empty, so we do have a course
|
|
$url = $webCourseHome.'?sid='.$sessionId.'&gid='.$groupId;
|
|
} else {
|
|
if (!empty($sessionId) && 'true' !== api_get_setting('session.remove_session_url')) {
|
|
// if the course was unset and the session was set, send directly to the session
|
|
$url = api_get_path(WEB_CODE_PATH).'session/index.php?session_id='.$sessionId;
|
|
}
|
|
}
|
|
|
|
// if not valid combination was found, return an empty string
|
|
return $url;
|
|
}
|
|
|
|
/**
|
|
* Check if there is more than the default URL defined in the access_url table.
|
|
*/
|
|
function api_get_multiple_access_url(): bool
|
|
{
|
|
return Container::$container->get(AccessUrlHelper::class)->isMultiple();
|
|
}
|
|
|
|
/**
|
|
* @deprecated Use AccessUrlHelper::isMultiple
|
|
*/
|
|
function api_is_multiple_url_enabled(): bool
|
|
{
|
|
return api_get_multiple_access_url();
|
|
}
|
|
|
|
/**
|
|
* Returns a md5 unique id.
|
|
*
|
|
* @todo add more parameters
|
|
*/
|
|
function api_get_unique_id()
|
|
{
|
|
return md5(time().uniqid().api_get_user_id().api_get_course_id().api_get_session_id());
|
|
}
|
|
|
|
/**
|
|
* @param int Course id
|
|
* @param int tool id: TOOL_QUIZ, TOOL_FORUM, TOOL_STUDENTPUBLICATION, TOOL_LEARNPATH
|
|
* @param int the item id (tool id, exercise id, lp id)
|
|
*
|
|
* @return bool
|
|
*/
|
|
function api_resource_is_locked_by_gradebook($item_id, $link_type, $course_code = null)
|
|
{
|
|
if (api_is_platform_admin()) {
|
|
return false;
|
|
}
|
|
if ('true' === api_get_setting('gradebook_locking_enabled')) {
|
|
if (empty($course_code)) {
|
|
$course_code = api_get_course_id();
|
|
}
|
|
$table = Database::get_main_table(TABLE_MAIN_GRADEBOOK_LINK);
|
|
$item_id = (int) $item_id;
|
|
$link_type = (int) $link_type;
|
|
$course_code = Database::escape_string($course_code);
|
|
$sql = "SELECT locked FROM $table
|
|
WHERE locked = 1 AND ref_id = $item_id AND type = $link_type AND course_code = '$course_code' ";
|
|
$result = Database::query($sql);
|
|
if (Database::num_rows($result)) {
|
|
return true;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Blocks a page if the item was added in a gradebook.
|
|
*
|
|
* @param int exercise id, work id, thread id,
|
|
* @param int LINK_EXERCISE, LINK_STUDENTPUBLICATION, LINK_LEARNPATH LINK_FORUM_THREAD, LINK_ATTENDANCE
|
|
* see gradebook/lib/be/linkfactory
|
|
* @param string course code
|
|
*
|
|
* @return false|null
|
|
*/
|
|
function api_block_course_item_locked_by_gradebook($item_id, $link_type, $course_code = null)
|
|
{
|
|
if (api_is_platform_admin()) {
|
|
return false;
|
|
}
|
|
|
|
if (api_resource_is_locked_by_gradebook($item_id, $link_type, $course_code)) {
|
|
$message = Display::return_message(
|
|
get_lang(
|
|
'This option is not available because this activity is contained by an assessment, which is currently locked. To unlock the assessment, ask your platform administrator.'
|
|
),
|
|
'warning'
|
|
);
|
|
api_not_allowed(true, $message);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Checks the PHP version installed is enough to run Chamilo.
|
|
*
|
|
* @param string Include path (used to load the error page)
|
|
*/
|
|
function api_check_php_version()
|
|
{
|
|
if (!function_exists('version_compare') ||
|
|
version_compare(PHP_VERSION, REQUIRED_PHP_VERSION, '<')
|
|
) {
|
|
throw new Exception('Wrong PHP version');
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Checks whether the Archive directory is present and writeable. If not,
|
|
* prints a warning message.
|
|
*/
|
|
function api_check_archive_dir()
|
|
{
|
|
if (is_dir(api_get_path(SYS_ARCHIVE_PATH)) && !is_writable(api_get_path(SYS_ARCHIVE_PATH))) {
|
|
$message = Display::return_message(
|
|
get_lang(
|
|
'The var/cache/ directory, used by this tool, is not writeable. Please contact your platform administrator.'
|
|
),
|
|
'warning'
|
|
);
|
|
api_not_allowed(true, $message);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns an array of global configuration settings which should be ignored
|
|
* when printing the configuration settings screens.
|
|
*
|
|
* @return array Array of strings, each identifying one of the excluded settings
|
|
*/
|
|
function api_get_locked_settings()
|
|
{
|
|
return [
|
|
'permanently_remove_deleted_files',
|
|
'account_valid_duration',
|
|
'service_ppt2lp',
|
|
'wcag_anysurfer_public_pages',
|
|
'upload_extensions_list_type',
|
|
'upload_extensions_blacklist',
|
|
'upload_extensions_whitelist',
|
|
'upload_extensions_skip',
|
|
'upload_extensions_replace_by',
|
|
'hide_dltt_markup',
|
|
'split_users_upload_directory',
|
|
'permissions_for_new_directories',
|
|
'permissions_for_new_files',
|
|
'platform_charset',
|
|
'ldap_description',
|
|
'cas_activate',
|
|
'cas_server',
|
|
'cas_server_uri',
|
|
'cas_port',
|
|
'cas_protocol',
|
|
'cas_add_user_activate',
|
|
'update_user_info_cas_with_ldap',
|
|
'languagePriority1',
|
|
'languagePriority2',
|
|
'languagePriority3',
|
|
'languagePriority4',
|
|
'login_is_email',
|
|
'chamilo_database_version',
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Guess the real ip for register in the database, even in reverse proxy cases.
|
|
* To be recognized, the IP has to be found in either $_SERVER['REMOTE_ADDR'] or
|
|
* in $_SERVER['HTTP_X_FORWARDED_FOR'], which is in common use with rproxies.
|
|
* Note: the result of this function is not SQL-safe. Please escape it before
|
|
* inserting in a database.
|
|
*
|
|
* @return string the user's real ip (unsafe - escape it before inserting to db)
|
|
*
|
|
* @author Jorge Frisancho Jibaja <jrfdeft@gmail.com>, USIL - Some changes to allow the use of real IP using reverse proxy
|
|
*
|
|
* @version CEV CHANGE 24APR2012
|
|
* @throws RuntimeException
|
|
*/
|
|
function api_get_real_ip(): string
|
|
{
|
|
if ('cli' === PHP_SAPI) {
|
|
$ip = '127.0.0.1';
|
|
} else {
|
|
$ip = trim($_SERVER['REMOTE_ADDR']);
|
|
if (empty($ip)) {
|
|
throw new RuntimeException("Unable to retrieve remote IP address.");
|
|
}
|
|
}
|
|
if (!empty($_SERVER['HTTP_X_FORWARDED_FOR'])) {
|
|
if (preg_match('/,/', $_SERVER['HTTP_X_FORWARDED_FOR'])) {
|
|
@list($ip1, $ip2) = @explode(',', $_SERVER['HTTP_X_FORWARDED_FOR']);
|
|
} else {
|
|
$ip1 = $_SERVER['HTTP_X_FORWARDED_FOR'];
|
|
}
|
|
$ip = trim($ip1);
|
|
}
|
|
|
|
return $ip;
|
|
}
|
|
|
|
/**
|
|
* Checks whether an IP is included inside an IP range.
|
|
*
|
|
* @param string IP address
|
|
* @param string IP range
|
|
* @param string $ip
|
|
*
|
|
* @return bool True if IP is in the range, false otherwise
|
|
*
|
|
* @author claudiu at cnixs dot com on http://www.php.net/manual/fr/ref.network.php#55230
|
|
* @author Yannick Warnier for improvements and managment of multiple ranges
|
|
*
|
|
* @todo check for IPv6 support
|
|
*/
|
|
function api_check_ip_in_range($ip, $range)
|
|
{
|
|
if (empty($ip) or empty($range)) {
|
|
return false;
|
|
}
|
|
$ip_ip = ip2long($ip);
|
|
// divide range param into array of elements
|
|
if (false !== strpos($range, ',')) {
|
|
$ranges = explode(',', $range);
|
|
} else {
|
|
$ranges = [$range];
|
|
}
|
|
foreach ($ranges as $range) {
|
|
$range = trim($range);
|
|
if (empty($range)) {
|
|
continue;
|
|
}
|
|
if (false === strpos($range, '/')) {
|
|
if (0 === strcmp($ip, $range)) {
|
|
return true; // there is a direct IP match, return OK
|
|
}
|
|
continue; //otherwise, get to the next range
|
|
}
|
|
// the range contains a "/", so analyse completely
|
|
[$net, $mask] = explode("/", $range);
|
|
|
|
$ip_net = ip2long($net);
|
|
// mask binary magic
|
|
$ip_mask = ~((1 << (32 - $mask)) - 1);
|
|
|
|
$ip_ip_net = $ip_ip & $ip_mask;
|
|
if ($ip_ip_net == $ip_net) {
|
|
return true;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
function api_check_user_access_to_legal($courseInfo)
|
|
{
|
|
if (empty($courseInfo)) {
|
|
return false;
|
|
}
|
|
|
|
$visibility = (int) $courseInfo['visibility'];
|
|
$visibilityList = [COURSE_VISIBILITY_OPEN_WORLD, COURSE_VISIBILITY_OPEN_PLATFORM];
|
|
|
|
return
|
|
in_array($visibility, $visibilityList) ||
|
|
api_is_drh() ||
|
|
(COURSE_VISIBILITY_REGISTERED === $visibility && 1 === (int) $courseInfo['subscribe']);
|
|
}
|
|
|
|
/**
|
|
* Checks if the global chat is enabled or not.
|
|
*
|
|
* @return bool
|
|
*/
|
|
function api_is_global_chat_enabled()
|
|
{
|
|
return
|
|
!api_is_anonymous() &&
|
|
'true' === api_get_setting('allow_global_chat') &&
|
|
'true' === api_get_setting('allow_social_tool');
|
|
}
|
|
|
|
/**
|
|
* @param int $item_id
|
|
* @param int $tool_id
|
|
* @param int $group_id id
|
|
* @param array $courseInfo
|
|
* @param int $sessionId
|
|
* @param int $userId
|
|
*
|
|
* @deprecated
|
|
*/
|
|
function api_set_default_visibility(
|
|
$item_id,
|
|
$tool_id,
|
|
$group_id = 0,
|
|
$courseInfo = [],
|
|
$sessionId = 0,
|
|
$userId = 0
|
|
) {
|
|
$courseInfo = empty($courseInfo) ? api_get_course_info() : $courseInfo;
|
|
$courseId = $courseInfo['real_id'];
|
|
$courseCode = $courseInfo['code'];
|
|
$sessionId = empty($sessionId) ? api_get_session_id() : $sessionId;
|
|
$userId = empty($userId) ? api_get_user_id() : $userId;
|
|
|
|
// if group is null force group_id = 0, this force is needed to create a LP folder with group = 0
|
|
if (is_null($group_id)) {
|
|
$group_id = 0;
|
|
} else {
|
|
$group_id = empty($group_id) ? api_get_group_id() : $group_id;
|
|
}
|
|
|
|
$groupInfo = [];
|
|
if (!empty($group_id)) {
|
|
$groupInfo = GroupManager::get_group_properties($group_id);
|
|
}
|
|
$original_tool_id = $tool_id;
|
|
|
|
switch ($tool_id) {
|
|
case TOOL_LINK:
|
|
case TOOL_LINK_CATEGORY:
|
|
$tool_id = 'links';
|
|
break;
|
|
case TOOL_DOCUMENT:
|
|
$tool_id = 'documents';
|
|
break;
|
|
case TOOL_LEARNPATH:
|
|
$tool_id = 'learning';
|
|
break;
|
|
case TOOL_ANNOUNCEMENT:
|
|
$tool_id = 'announcements';
|
|
break;
|
|
case TOOL_FORUM:
|
|
case TOOL_FORUM_CATEGORY:
|
|
case TOOL_FORUM_THREAD:
|
|
$tool_id = 'forums';
|
|
break;
|
|
case TOOL_QUIZ:
|
|
$tool_id = 'quiz';
|
|
break;
|
|
}
|
|
$setting = api_get_setting('tool_visible_by_default_at_creation');
|
|
|
|
if (isset($setting[$tool_id])) {
|
|
$visibility = 'invisible';
|
|
if ('true' === $setting[$tool_id]) {
|
|
$visibility = 'visible';
|
|
}
|
|
|
|
// Read the portal and course default visibility
|
|
if ('documents' === $tool_id) {
|
|
$visibility = DocumentManager::getDocumentDefaultVisibility($courseInfo);
|
|
}
|
|
|
|
// Fixes default visibility for tests
|
|
switch ($original_tool_id) {
|
|
case TOOL_QUIZ:
|
|
if (empty($sessionId)) {
|
|
$objExerciseTmp = new Exercise($courseId);
|
|
$objExerciseTmp->read($item_id);
|
|
if ('visible' === $visibility) {
|
|
$objExerciseTmp->enable();
|
|
$objExerciseTmp->save();
|
|
} else {
|
|
$objExerciseTmp->disable();
|
|
$objExerciseTmp->save();
|
|
}
|
|
}
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
function api_get_roles()
|
|
{
|
|
$hierarchy = Container::$container->getParameter('security.role_hierarchy.roles');
|
|
$roles = [];
|
|
array_walk_recursive($hierarchy, function ($role) use (&$roles) {
|
|
$roles[$role] = $role;
|
|
});
|
|
|
|
return $roles;
|
|
}
|
|
|
|
function api_get_user_roles(): array
|
|
{
|
|
$permissionService = Container::$container->get(PermissionServiceHelper::class);
|
|
|
|
$roles = $permissionService->getUserRoles();
|
|
|
|
return array_combine($roles, $roles);
|
|
}
|
|
|
|
/**
|
|
* @param string $file
|
|
*
|
|
* @return string
|
|
*/
|
|
function api_get_js_simple($file)
|
|
{
|
|
return '<script type="text/javascript" src="'.$file.'"></script>'."\n";
|
|
}
|
|
|
|
/**
|
|
* Modify default memory_limit and max_execution_time limits
|
|
* Needed when processing long tasks.
|
|
*/
|
|
function api_set_more_memory_and_time_limits()
|
|
{
|
|
if (function_exists('ini_set')) {
|
|
api_set_memory_limit('256M');
|
|
ini_set('max_execution_time', 1800);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Tries to set memory limit, if authorized and new limit is higher than current.
|
|
*
|
|
* @param string $mem New memory limit
|
|
*
|
|
* @return bool True on success, false on failure or current is higher than suggested
|
|
* @assert (null) === false
|
|
* @assert (-1) === false
|
|
* @assert (0) === true
|
|
* @assert ('1G') === true
|
|
*/
|
|
function api_set_memory_limit($mem)
|
|
{
|
|
//if ini_set() not available, this function is useless
|
|
if (!function_exists('ini_set') || is_null($mem) || -1 == $mem) {
|
|
return false;
|
|
}
|
|
|
|
$memory_limit = ini_get('memory_limit');
|
|
if (api_get_bytes_memory_limit($mem) > api_get_bytes_memory_limit($memory_limit)) {
|
|
ini_set('memory_limit', $mem);
|
|
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Gets memory limit in bytes.
|
|
*
|
|
* @param string The memory size (128M, 1G, 1000K, etc)
|
|
*
|
|
* @return int
|
|
* @assert (null) === false
|
|
* @assert ('1t') === 1099511627776
|
|
* @assert ('1g') === 1073741824
|
|
* @assert ('1m') === 1048576
|
|
* @assert ('100k') === 102400
|
|
*/
|
|
function api_get_bytes_memory_limit($mem)
|
|
{
|
|
$size = strtolower(substr($mem, -1));
|
|
|
|
switch ($size) {
|
|
case 't':
|
|
$mem = (int) substr($mem, -1) * 1024 * 1024 * 1024 * 1024;
|
|
break;
|
|
case 'g':
|
|
$mem = (int) substr($mem, 0, -1) * 1024 * 1024 * 1024;
|
|
break;
|
|
case 'm':
|
|
$mem = (int) substr($mem, 0, -1) * 1024 * 1024;
|
|
break;
|
|
case 'k':
|
|
$mem = (int) substr($mem, 0, -1) * 1024;
|
|
break;
|
|
default:
|
|
// we assume it's integer only
|
|
$mem = (int) $mem;
|
|
break;
|
|
}
|
|
|
|
return $mem;
|
|
}
|
|
|
|
/**
|
|
* Finds all the information about a user from username instead of user id.
|
|
*
|
|
* @param string $officialCode
|
|
*
|
|
* @return array $user_info user_id, lastname, firstname, username, email, ...
|
|
*
|
|
* @author Yannick Warnier <yannick.warnier@beeznest.com>
|
|
*/
|
|
function api_get_user_info_from_official_code($officialCode)
|
|
{
|
|
if (empty($officialCode)) {
|
|
return false;
|
|
}
|
|
$sql = "SELECT * FROM ".Database::get_main_table(TABLE_MAIN_USER)."
|
|
WHERE official_code ='".Database::escape_string($officialCode)."'";
|
|
$result = Database::query($sql);
|
|
if (Database::num_rows($result) > 0) {
|
|
$result_array = Database::fetch_array($result);
|
|
|
|
return _api_format_user($result_array);
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* @param string $usernameInputId
|
|
* @param string $passwordInputId
|
|
*
|
|
* @return string|null
|
|
*/
|
|
function api_get_password_checker_js($usernameInputId, $passwordInputId)
|
|
{
|
|
$checkPass = api_get_setting('allow_strength_pass_checker');
|
|
$useStrengthPassChecker = 'true' === $checkPass;
|
|
|
|
if (false === $useStrengthPassChecker) {
|
|
return null;
|
|
}
|
|
|
|
$minRequirements = Security::getPasswordRequirements()['min'];
|
|
|
|
$options = [
|
|
'rules' => [],
|
|
];
|
|
|
|
if ($minRequirements['length'] > 0) {
|
|
$options['rules'][] = [
|
|
'minChar' => $minRequirements['length'],
|
|
'pattern' => '.',
|
|
'helpText' => sprintf(
|
|
get_lang('Minimum %s characters in total'),
|
|
$minRequirements['length']
|
|
),
|
|
];
|
|
}
|
|
|
|
if ($minRequirements['lowercase'] > 0) {
|
|
$options['rules'][] = [
|
|
'minChar' => $minRequirements['lowercase'],
|
|
'pattern' => '[a-z]',
|
|
'helpText' => sprintf(
|
|
get_lang('Minimum %s lowercase characters'),
|
|
$minRequirements['lowercase']
|
|
),
|
|
];
|
|
}
|
|
|
|
if ($minRequirements['uppercase'] > 0) {
|
|
$options['rules'][] = [
|
|
'minChar' => $minRequirements['uppercase'],
|
|
'pattern' => '[A-Z]',
|
|
'helpText' => sprintf(
|
|
get_lang('Minimum %s uppercase characters'),
|
|
$minRequirements['uppercase']
|
|
),
|
|
];
|
|
}
|
|
|
|
if ($minRequirements['numeric'] > 0) {
|
|
$options['rules'][] = [
|
|
'minChar' => $minRequirements['numeric'],
|
|
'pattern' => '[0-9]',
|
|
'helpText' => sprintf(
|
|
get_lang('Minimum %s numerical (0-9) characters'),
|
|
$minRequirements['numeric']
|
|
),
|
|
];
|
|
}
|
|
|
|
if ($minRequirements['specials'] > 0) {
|
|
$options['rules'][] = [
|
|
'minChar' => $minRequirements['specials'],
|
|
'pattern' => '[!"#$%&\'()*+,\-./\\\:;<=>?@[\\]^_`{|}~]',
|
|
'helpText' => sprintf(
|
|
get_lang('Minimum %s special characters'),
|
|
$minRequirements['specials']
|
|
),
|
|
];
|
|
}
|
|
|
|
$js = api_get_js('password-checker/password-checker.js');
|
|
$js .= "<script>
|
|
$(function() {
|
|
$('".$passwordInputId."').passwordChecker(".json_encode($options).");
|
|
});
|
|
</script>";
|
|
|
|
return $js;
|
|
}
|
|
|
|
/**
|
|
* create an user extra field called 'captcha_blocked_until_date'.
|
|
*
|
|
* @param string $username
|
|
*
|
|
* @return bool
|
|
*/
|
|
function api_block_account_captcha($username)
|
|
{
|
|
$userInfo = api_get_user_info_from_username($username);
|
|
if (empty($userInfo)) {
|
|
return false;
|
|
}
|
|
$minutesToBlock = api_get_setting('captcha_time_to_block');
|
|
$time = time() + $minutesToBlock * 60;
|
|
UserManager::update_extra_field_value(
|
|
$userInfo['user_id'],
|
|
'captcha_blocked_until_date',
|
|
api_get_utc_datetime($time)
|
|
);
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* @param string $username
|
|
*
|
|
* @return bool
|
|
*/
|
|
function api_clean_account_captcha($username)
|
|
{
|
|
$userInfo = api_get_user_info_from_username($username);
|
|
if (empty($userInfo)) {
|
|
return false;
|
|
}
|
|
Session::erase('loginFailedCount');
|
|
UserManager::update_extra_field_value(
|
|
$userInfo['user_id'],
|
|
'captcha_blocked_until_date',
|
|
null
|
|
);
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* @param string $username
|
|
*
|
|
* @return bool
|
|
*/
|
|
function api_get_user_blocked_by_captcha($username)
|
|
{
|
|
$userInfo = api_get_user_info_from_username($username);
|
|
if (empty($userInfo)) {
|
|
return false;
|
|
}
|
|
$data = UserManager::get_extra_user_data_by_field(
|
|
$userInfo['user_id'],
|
|
'captcha_blocked_until_date'
|
|
);
|
|
if (isset($data) && isset($data['captcha_blocked_until_date'])) {
|
|
return $data['captcha_blocked_until_date'];
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* If true, the drh can access all content (courses, users) inside a session.
|
|
*
|
|
* @return bool
|
|
*/
|
|
function api_drh_can_access_all_session_content()
|
|
{
|
|
return 'true' === api_get_setting('drh_can_access_all_session_content');
|
|
}
|
|
|
|
/**
|
|
* Checks if user can login as another user.
|
|
*
|
|
* @param int $loginAsUserId the user id to log in
|
|
* @param int $userId my user id
|
|
*
|
|
* @return bool
|
|
*/
|
|
function api_can_login_as($loginAsUserId, $userId = null)
|
|
{
|
|
$loginAsUserId = (int) $loginAsUserId;
|
|
|
|
if (empty($loginAsUserId)) {
|
|
return false;
|
|
}
|
|
|
|
if (empty($userId)) {
|
|
$userId = api_get_user_id();
|
|
}
|
|
|
|
if ($loginAsUserId == $userId) {
|
|
return false;
|
|
}
|
|
|
|
// Check if the user to login is an admin
|
|
if (api_is_platform_admin_by_id($loginAsUserId)) {
|
|
// Only super admins can login to admin accounts
|
|
if (!api_global_admin_can_edit_admin($loginAsUserId)) {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
$userInfo = api_get_user_info($loginAsUserId);
|
|
|
|
$isDrh = function () use ($loginAsUserId) {
|
|
if (api_is_drh()) {
|
|
if (api_drh_can_access_all_session_content()) {
|
|
$users = SessionManager::getAllUsersFromCoursesFromAllSessionFromStatus(
|
|
'drh_all',
|
|
api_get_user_id()
|
|
);
|
|
$userList = [];
|
|
if (is_array($users)) {
|
|
foreach ($users as $user) {
|
|
$userList[] = $user['id'];
|
|
}
|
|
}
|
|
if (in_array($loginAsUserId, $userList)) {
|
|
return true;
|
|
}
|
|
} else {
|
|
if (api_is_drh() &&
|
|
UserManager::is_user_followed_by_drh($loginAsUserId, api_get_user_id())
|
|
) {
|
|
return true;
|
|
}
|
|
}
|
|
}
|
|
|
|
return false;
|
|
};
|
|
|
|
$loginAsStatusForSessionAdmins = [STUDENT];
|
|
|
|
if ('true' === api_get_setting('session.allow_session_admin_login_as_teacher')) {
|
|
$loginAsStatusForSessionAdmins[] = COURSEMANAGER;
|
|
}
|
|
|
|
return api_is_platform_admin() ||
|
|
(api_is_session_admin() && in_array($userInfo['status'], $loginAsStatusForSessionAdmins)) ||
|
|
$isDrh();
|
|
}
|
|
|
|
/**
|
|
* Return true on https install.
|
|
*
|
|
* @return bool
|
|
*/
|
|
function api_is_https()
|
|
{
|
|
if (!empty($_SERVER['HTTP_X_FORWARDED_PROTO']) &&
|
|
'https' == $_SERVER['HTTP_X_FORWARDED_PROTO'] || !empty(api_get_configuration_value('force_https_forwarded_proto'))
|
|
) {
|
|
$isSecured = true;
|
|
} else {
|
|
if (!empty($_SERVER['HTTPS']) && 'off' != $_SERVER['HTTPS']) {
|
|
$isSecured = true;
|
|
} else {
|
|
$isSecured = false;
|
|
// last chance
|
|
if (!empty($_SERVER['SERVER_PORT']) && 443 == $_SERVER['SERVER_PORT']) {
|
|
$isSecured = true;
|
|
}
|
|
}
|
|
}
|
|
|
|
return $isSecured;
|
|
}
|
|
|
|
/**
|
|
* Return protocol (http or https).
|
|
*
|
|
* @return string
|
|
*/
|
|
function api_get_protocol()
|
|
{
|
|
return api_is_https() ? 'https' : 'http';
|
|
}
|
|
|
|
/**
|
|
* Get origin.
|
|
*
|
|
* @param string
|
|
*
|
|
* @return string
|
|
*/
|
|
function api_get_origin()
|
|
{
|
|
return isset($_REQUEST['origin']) ? urlencode(Security::remove_XSS(urlencode($_REQUEST['origin']))) : '';
|
|
}
|
|
|
|
/**
|
|
* Warns an user that the portal reach certain limit.
|
|
*
|
|
* @param string $limitName
|
|
*/
|
|
function api_warn_hosting_contact($limitName)
|
|
{
|
|
$hostingParams = api_get_configuration_value(1);
|
|
$email = null;
|
|
|
|
if (!empty($hostingParams)) {
|
|
if (isset($hostingParams['hosting_contact_mail'])) {
|
|
$email = $hostingParams['hosting_contact_mail'];
|
|
}
|
|
}
|
|
|
|
if (!empty($email)) {
|
|
$subject = get_lang('Hosting warning reached');
|
|
$body = get_lang('Portal name').': '.api_get_path(WEB_PATH)." \n ";
|
|
$body .= get_lang('Portal\'s limit type').': '.$limitName." \n ";
|
|
if (isset($hostingParams[$limitName])) {
|
|
$body .= get_lang('Value').': '.$hostingParams[$limitName];
|
|
}
|
|
api_mail_html(null, $email, $subject, $body);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Gets value of a variable from config/configuration.php
|
|
* Variables that are not set in the configuration.php file but set elsewhere:
|
|
* - virtual_css_theme_folder (vchamilo plugin)
|
|
* - access_url (global.inc.php)
|
|
* - apc/apc_prefix (global.inc.php).
|
|
*
|
|
* @param string $variable
|
|
*
|
|
* @return bool|mixed
|
|
*/
|
|
function api_get_configuration_value($variable)
|
|
{
|
|
global $_configuration;
|
|
// Check the current url id, id = 1 by default
|
|
$urlId = isset($_configuration['access_url']) ? (int) $_configuration['access_url'] : 1;
|
|
|
|
$variable = trim($variable);
|
|
|
|
// Check if variable exists
|
|
if (isset($_configuration[$variable])) {
|
|
if (is_array($_configuration[$variable])) {
|
|
// Check if it exists for the sub portal
|
|
if (array_key_exists($urlId, $_configuration[$variable])) {
|
|
return $_configuration[$variable][$urlId];
|
|
} else {
|
|
// Try to found element with id = 1 (master portal)
|
|
if (array_key_exists(1, $_configuration[$variable])) {
|
|
return $_configuration[$variable][1];
|
|
}
|
|
}
|
|
}
|
|
|
|
return $_configuration[$variable];
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Retreives and returns a value in a hierarchical configuration array
|
|
* api_get_configuration_sub_value('a/b/c') returns api_get_configuration_value('a')['b']['c'].
|
|
*
|
|
* @param string $path the successive array keys, separated by the separator
|
|
* @param mixed $default value to be returned if not found, null by default
|
|
* @param string $separator '/' by default
|
|
* @param array $array the active configuration array by default
|
|
*
|
|
* @return mixed the found value or $default
|
|
*/
|
|
function api_get_configuration_sub_value($path, $default = null, $separator = '/', $array = null)
|
|
{
|
|
$pos = strpos($path, $separator);
|
|
if (false === $pos) {
|
|
if (is_null($array)) {
|
|
return api_get_configuration_value($path);
|
|
}
|
|
if (is_array($array) && array_key_exists($path, $array)) {
|
|
return $array[$path];
|
|
}
|
|
|
|
return $default;
|
|
}
|
|
$key = substr($path, 0, $pos);
|
|
if (is_null($array)) {
|
|
$newArray = api_get_configuration_value($key);
|
|
} elseif (is_array($array) && array_key_exists($key, $array)) {
|
|
$newArray = $array[$key];
|
|
} else {
|
|
return $default;
|
|
}
|
|
if (is_array($newArray)) {
|
|
$newPath = substr($path, $pos + 1);
|
|
|
|
return api_get_configuration_sub_value($newPath, $default, $separator, $newArray);
|
|
}
|
|
|
|
return $default;
|
|
}
|
|
|
|
/**
|
|
* Retrieves and returns a value in a hierarchical configuration array
|
|
* api_array_sub_value($array, 'a/b/c') returns $array['a']['b']['c'].
|
|
*
|
|
* @param array $array the recursive array that contains the value to be returned (or not)
|
|
* @param string $path the successive array keys, separated by the separator
|
|
* @param mixed $default the value to be returned if not found
|
|
* @param string $separator the separator substring
|
|
*
|
|
* @return mixed the found value or $default
|
|
*/
|
|
function api_array_sub_value($array, $path, $default = null, $separator = '/')
|
|
{
|
|
$pos = strpos($path, $separator);
|
|
if (false === $pos) {
|
|
if (is_array($array) && array_key_exists($path, $array)) {
|
|
return $array[$path];
|
|
}
|
|
|
|
return $default;
|
|
}
|
|
$key = substr($path, 0, $pos);
|
|
if (is_array($array) && array_key_exists($key, $array)) {
|
|
$newArray = $array[$key];
|
|
} else {
|
|
return $default;
|
|
}
|
|
if (is_array($newArray)) {
|
|
$newPath = substr($path, $pos + 1);
|
|
|
|
return api_array_sub_value($newArray, $newPath, $default);
|
|
}
|
|
|
|
return $default;
|
|
}
|
|
|
|
/**
|
|
* Returns supported image extensions in the portal.
|
|
*
|
|
* @param bool $supportVectors Whether vector images should also be accepted or not
|
|
*
|
|
* @return array Supported image extensions in the portal
|
|
*/
|
|
function api_get_supported_image_extensions($supportVectors = true)
|
|
{
|
|
// jpg can also be called jpeg, jpe, jfif and jif. See https://en.wikipedia.org/wiki/JPEG#JPEG_filename_extensions
|
|
$supportedImageExtensions = ['jpg', 'jpeg', 'png', 'gif', 'jpe', 'jfif', 'jif'];
|
|
if ($supportVectors) {
|
|
array_push($supportedImageExtensions, 'svg');
|
|
}
|
|
if (version_compare(PHP_VERSION, '5.5.0', '>=')) {
|
|
array_push($supportedImageExtensions, 'webp');
|
|
}
|
|
|
|
return $supportedImageExtensions;
|
|
}
|
|
|
|
/**
|
|
* This setting changes the registration status for the campus.
|
|
*
|
|
* @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
|
|
*
|
|
* @version August 2006
|
|
*
|
|
* @param bool $listCampus Whether we authorize
|
|
*
|
|
* @todo the $_settings should be reloaded here. => write api function for this and use this in global.inc.php also.
|
|
*/
|
|
function api_register_campus($listCampus = true)
|
|
{
|
|
$tbl_settings = Database::get_main_table(TABLE_MAIN_SETTINGS);
|
|
|
|
$sql = "UPDATE $tbl_settings SET selected_value='true' WHERE variable='registered'";
|
|
Database::query($sql);
|
|
|
|
if (!$listCampus) {
|
|
$sql = "UPDATE $tbl_settings SET selected_value='true' WHERE variable='donotlistcampus'";
|
|
Database::query($sql);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Check whether the user type should be exclude.
|
|
* Such as invited or anonymous users.
|
|
*
|
|
* @param bool $checkDB Optional. Whether check the user status
|
|
* @param int $userId Options. The user id
|
|
*
|
|
* @return bool
|
|
*/
|
|
function api_is_excluded_user_type($checkDB = false, $userId = 0)
|
|
{
|
|
if ($checkDB) {
|
|
$userId = empty($userId) ? api_get_user_id() : (int) $userId;
|
|
|
|
if (0 == $userId) {
|
|
return true;
|
|
}
|
|
|
|
$userInfo = api_get_user_info($userId);
|
|
|
|
switch ($userInfo['status']) {
|
|
case INVITEE:
|
|
case ANONYMOUS:
|
|
return true;
|
|
default:
|
|
return false;
|
|
}
|
|
}
|
|
|
|
$isInvited = api_is_invitee();
|
|
$isAnonymous = api_is_anonymous();
|
|
|
|
if ($isInvited || $isAnonymous) {
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Get the user status to ignore in reports.
|
|
*
|
|
* @param string $format Optional. The result type (array or string)
|
|
*
|
|
* @return array|string
|
|
*/
|
|
function api_get_users_status_ignored_in_reports($format = 'array')
|
|
{
|
|
$excludedTypes = [
|
|
INVITEE,
|
|
ANONYMOUS,
|
|
];
|
|
|
|
if ('string' == $format) {
|
|
return implode(', ', $excludedTypes);
|
|
}
|
|
|
|
return $excludedTypes;
|
|
}
|
|
|
|
/**
|
|
* Set the Site Use Cookie Warning for 1 year.
|
|
*/
|
|
function api_set_site_use_cookie_warning_cookie()
|
|
{
|
|
setcookie('ChamiloUsesCookies', 'ok', time() + 31556926);
|
|
}
|
|
|
|
/**
|
|
* Return true if the Site Use Cookie Warning Cookie warning exists.
|
|
*
|
|
* @return bool
|
|
*/
|
|
function api_site_use_cookie_warning_cookie_exist()
|
|
{
|
|
return isset($_COOKIE['ChamiloUsesCookies']);
|
|
}
|
|
|
|
/**
|
|
* Given a number of seconds, format the time to show hours, minutes and seconds.
|
|
*
|
|
* @param int $time The time in seconds
|
|
* @param string $originFormat Optional. PHP o JS
|
|
*
|
|
* @return string (00h00'00")
|
|
*/
|
|
function api_format_time($time, $originFormat = 'php')
|
|
{
|
|
$h = get_lang('h');
|
|
$hours = $time / 3600;
|
|
$mins = ($time % 3600) / 60;
|
|
$secs = ($time % 60);
|
|
|
|
if ($time < 0) {
|
|
$hours = 0;
|
|
$mins = 0;
|
|
$secs = 0;
|
|
}
|
|
|
|
if ('js' === $originFormat) {
|
|
$formattedTime = trim(sprintf("%02d : %02d : %02d", $hours, $mins, $secs));
|
|
} else {
|
|
$formattedTime = trim(sprintf("%02d$h%02d'%02d\"", $hours, $mins, $secs));
|
|
}
|
|
|
|
return $formattedTime;
|
|
}
|
|
|
|
function api_set_noreply_and_from_address_to_mailer(
|
|
TemplatedEmail $email,
|
|
array $sender,
|
|
array $replyToAddress = []
|
|
): void {
|
|
$validator = Container::getLegacyHelper()->getValidator();
|
|
$emailConstraint = new Assert\Email();
|
|
|
|
$noReplyAddress = api_get_setting('noreply_email_address');
|
|
$avoidReplyToAddress = false;
|
|
|
|
if (!empty($noReplyAddress)) {
|
|
// $avoidReplyToAddress = api_get_configuration_value('mail_no_reply_avoid_reply_to');
|
|
}
|
|
|
|
// Default values
|
|
$notification = new Notification();
|
|
$defaultSenderName = $notification->getDefaultPlatformSenderName();
|
|
$defaultSenderEmail = $notification->getDefaultPlatformSenderEmail();
|
|
|
|
// If the parameter is set don't use the admin.
|
|
$senderName = !empty($sender['name']) ? $sender['name'] : $defaultSenderName;
|
|
$senderEmail = !empty($sender['email']) ? $sender['email'] : $defaultSenderEmail;
|
|
|
|
// Send errors to the platform admin
|
|
$adminEmail = api_get_setting('admin.administrator_email');
|
|
|
|
$adminEmailValidation = $validator->validate($adminEmail, $emailConstraint);
|
|
|
|
if (!empty($adminEmail) && 0 === $adminEmailValidation->count()) {
|
|
$email
|
|
->getHeaders()
|
|
->addIdHeader('Errors-To', $adminEmail)
|
|
;
|
|
}
|
|
|
|
if (!$avoidReplyToAddress && !empty($replyToAddress)) {
|
|
$replyToEmailValidation = $validator->validate($replyToAddress['mail'], $emailConstraint);
|
|
|
|
if (0 === $replyToEmailValidation->count()) {
|
|
$email->addReplyTo(new Address($replyToAddress['mail'], $replyToAddress['name']));
|
|
}
|
|
}
|
|
|
|
if ('true' === api_get_setting('mail.smtp_unique_sender')) {
|
|
$senderName = $defaultSenderName;
|
|
$senderEmail = $defaultSenderEmail;
|
|
|
|
$email->sender(new Address($senderEmail, $senderName));
|
|
}
|
|
|
|
if ($senderEmail) {
|
|
$email->from(new Address($senderEmail, $senderName));
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Sends an email
|
|
* Sender name and email can be specified, if not specified
|
|
* name and email of the platform admin are used.
|
|
*
|
|
* @param string name of recipient
|
|
* @param string email of recipient
|
|
* @param string email subject
|
|
* @param string email body
|
|
* @param string sender name
|
|
* @param string sender e-mail
|
|
* @param array extra headers in form $headers = array($name => $value) to allow parsing
|
|
* @param array data file (path and filename)
|
|
* @param bool True for attaching a embedded file inside content html (optional)
|
|
* @param array Additional parameters
|
|
*
|
|
* @return bool true if mail was sent
|
|
*/
|
|
function api_mail_html(
|
|
$recipientName,
|
|
$recipientEmail,
|
|
$subject,
|
|
$body,
|
|
$senderName = '',
|
|
$senderEmail = '',
|
|
$extra_headers = [],
|
|
$data_file = [],
|
|
$embeddedImage = false,
|
|
$additionalParameters = [],
|
|
string $sendErrorTo = null
|
|
) {
|
|
$mailHelper = Container::$container->get(MailHelper::class);
|
|
|
|
return $mailHelper->send(
|
|
$recipientName,
|
|
$recipientEmail,
|
|
$subject,
|
|
$body,
|
|
$senderName,
|
|
$senderEmail,
|
|
$extra_headers,
|
|
$data_file,
|
|
$embeddedImage,
|
|
$additionalParameters,
|
|
$sendErrorTo
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @param int $tool Possible values: GroupManager::GROUP_TOOL_*
|
|
* @param bool $showHeader
|
|
*/
|
|
function api_protect_course_group($tool, $showHeader = true)
|
|
{
|
|
$groupId = api_get_group_id();
|
|
if (!empty($groupId)) {
|
|
if (api_is_platform_admin()) {
|
|
return true;
|
|
}
|
|
|
|
if (api_is_allowed_to_edit(false, true, true)) {
|
|
return true;
|
|
}
|
|
|
|
$userId = api_get_user_id();
|
|
$sessionId = api_get_session_id();
|
|
if (!empty($sessionId)) {
|
|
if (api_is_coach($sessionId, api_get_course_int_id())) {
|
|
return true;
|
|
}
|
|
|
|
if (api_is_drh()) {
|
|
if (SessionManager::isUserSubscribedAsHRM($sessionId, $userId)) {
|
|
return true;
|
|
}
|
|
}
|
|
}
|
|
|
|
$group = api_get_group_entity($groupId);
|
|
|
|
// Group doesn't exists
|
|
if (null === $group) {
|
|
api_not_allowed($showHeader);
|
|
}
|
|
|
|
// Check group access
|
|
$allow = GroupManager::userHasAccess(
|
|
$userId,
|
|
$group,
|
|
$tool
|
|
);
|
|
|
|
if (!$allow) {
|
|
api_not_allowed($showHeader);
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Check if a date is in a date range.
|
|
*
|
|
* @param datetime $startDate
|
|
* @param datetime $endDate
|
|
* @param datetime $currentDate
|
|
*
|
|
* @return bool true if date is in rage, false otherwise
|
|
*/
|
|
function api_is_date_in_date_range($startDate, $endDate, $currentDate = null)
|
|
{
|
|
$startDate = strtotime(api_get_local_time($startDate));
|
|
$endDate = strtotime(api_get_local_time($endDate));
|
|
$currentDate = strtotime(api_get_local_time($currentDate));
|
|
|
|
if ($currentDate >= $startDate && $currentDate <= $endDate) {
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Eliminate the duplicates of a multidimensional array by sending the key.
|
|
*
|
|
* @param array $array multidimensional array
|
|
* @param int $key key to find to compare
|
|
*
|
|
* @return array
|
|
*/
|
|
function api_unique_multidim_array($array, $key)
|
|
{
|
|
$temp_array = [];
|
|
$i = 0;
|
|
$key_array = [];
|
|
|
|
foreach ($array as $val) {
|
|
if (!in_array($val[$key], $key_array)) {
|
|
$key_array[$i] = $val[$key];
|
|
$temp_array[$i] = $val;
|
|
}
|
|
$i++;
|
|
}
|
|
|
|
return $temp_array;
|
|
}
|
|
|
|
/**
|
|
* Limit the access to Session Admins when the limit_session_admin_role
|
|
* configuration variable is set to true.
|
|
*/
|
|
function api_protect_limit_for_session_admin()
|
|
{
|
|
$limitAdmin = api_get_setting('limit_session_admin_role');
|
|
if (api_is_session_admin() && 'true' === $limitAdmin) {
|
|
api_not_allowed(true);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Limits that a session admin has access to list users.
|
|
* When limit_session_admin_list_users configuration variable is set to true.
|
|
*/
|
|
function api_protect_session_admin_list_users()
|
|
{
|
|
$limitAdmin = ('true' === api_get_setting('session.limit_session_admin_list_users'));
|
|
|
|
if (api_is_session_admin() && true === $limitAdmin) {
|
|
api_not_allowed(true);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @return bool
|
|
*/
|
|
function api_is_student_view_active(): bool
|
|
{
|
|
$studentView = Session::read('studentview');
|
|
|
|
return 'studentview' === $studentView;
|
|
}
|
|
|
|
/**
|
|
* Converts string value to float value.
|
|
*
|
|
* 3.141516 => 3.141516
|
|
* 3,141516 => 3.141516
|
|
*
|
|
* @todo WIP
|
|
*
|
|
* @param string $number
|
|
*
|
|
* @return float
|
|
*/
|
|
function api_float_val($number)
|
|
{
|
|
return (float) str_replace(',', '.', trim($number));
|
|
}
|
|
|
|
/**
|
|
* Converts float values
|
|
* Example if $decimals = 2.
|
|
*
|
|
* 3.141516 => 3.14
|
|
* 3,141516 => 3,14
|
|
*
|
|
* @param string $number number in iso code
|
|
* @param int $decimals
|
|
* @param string $decimalSeparator
|
|
* @param string $thousandSeparator
|
|
*
|
|
* @return bool|string
|
|
*/
|
|
function api_number_format($number, $decimals = 0, $decimalSeparator = '.', $thousandSeparator = ',')
|
|
{
|
|
$number = api_float_val($number);
|
|
|
|
return number_format($number, $decimals, $decimalSeparator, $thousandSeparator);
|
|
}
|
|
|
|
/**
|
|
* Set location url with a exit break by default.
|
|
*
|
|
* @param string $url
|
|
* @param bool $exit
|
|
*/
|
|
function api_location($url, $exit = true)
|
|
{
|
|
header('Location: '.$url);
|
|
|
|
if ($exit) {
|
|
exit;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param string $from
|
|
* @param string $to
|
|
*
|
|
* @return string
|
|
*/
|
|
function api_get_relative_path($from, $to)
|
|
{
|
|
// some compatibility fixes for Windows paths
|
|
$from = is_dir($from) ? rtrim($from, '\/').'/' : $from;
|
|
$to = is_dir($to) ? rtrim($to, '\/').'/' : $to;
|
|
$from = str_replace('\\', '/', $from);
|
|
$to = str_replace('\\', '/', $to);
|
|
|
|
$from = explode('/', $from);
|
|
$to = explode('/', $to);
|
|
$relPath = $to;
|
|
|
|
foreach ($from as $depth => $dir) {
|
|
// find first non-matching dir
|
|
if ($dir === $to[$depth]) {
|
|
// ignore this directory
|
|
array_shift($relPath);
|
|
} else {
|
|
// get number of remaining dirs to $from
|
|
$remaining = count($from) - $depth;
|
|
if ($remaining > 1) {
|
|
// add traversals up to first matching dir
|
|
$padLength = (count($relPath) + $remaining - 1) * -1;
|
|
$relPath = array_pad($relPath, $padLength, '..');
|
|
break;
|
|
} else {
|
|
$relPath[0] = './'.$relPath[0];
|
|
}
|
|
}
|
|
}
|
|
|
|
return implode('/', $relPath);
|
|
}
|
|
|
|
/**
|
|
* @param string $template
|
|
*
|
|
* @return string
|
|
*/
|
|
function api_find_template($template)
|
|
{
|
|
return Template::findTemplateFilePath($template);
|
|
}
|
|
|
|
/**
|
|
* @return array
|
|
*/
|
|
function api_get_language_list_for_flag()
|
|
{
|
|
$table = Database::get_main_table(TABLE_MAIN_LANGUAGE);
|
|
$sql = "SELECT english_name, isocode FROM $table
|
|
ORDER BY original_name ASC";
|
|
static $languages = [];
|
|
if (empty($languages)) {
|
|
$result = Database::query($sql);
|
|
while ($row = Database::fetch_array($result)) {
|
|
$languages[$row['english_name']] = $row['isocode'];
|
|
}
|
|
$languages['english'] = 'gb';
|
|
}
|
|
|
|
return $languages;
|
|
}
|
|
|
|
function api_create_zip(string $name): ZipStream
|
|
{
|
|
$zipStreamOptions = new Archive();
|
|
$zipStreamOptions->setSendHttpHeaders(true);
|
|
$zipStreamOptions->setContentDisposition('attachment');
|
|
$zipStreamOptions->setContentType('application/x-zip');
|
|
|
|
return new ZipStream($name, $zipStreamOptions);
|
|
}
|
|
|
|
function api_get_language_translate_html(): string
|
|
{
|
|
$translate = 'true' === api_get_setting('editor.translate_html');
|
|
|
|
if (!$translate) {
|
|
return '';
|
|
}
|
|
|
|
/*$languageList = api_get_languages();
|
|
$hideAll = '';
|
|
foreach ($languageList as $isocode => $name) {
|
|
$hideAll .= '
|
|
$(".mce-translatehtml").hide();
|
|
$("span:lang('.$isocode.')").filter(
|
|
function(e, val) {
|
|
// Only find the spans if they have set the lang
|
|
if ($(this).attr("lang") == null) {
|
|
return false;
|
|
}
|
|
// Ignore ckeditor classes
|
|
return !this.className.match(/cke(.*)/);
|
|
}).hide();'."\n";
|
|
}*/
|
|
|
|
$userInfo = api_get_user_info();
|
|
if (!empty($userInfo['language'])) {
|
|
$isoCode = $userInfo['language'];
|
|
|
|
return '
|
|
$(function() {
|
|
$(".mce-translatehtml").hide();
|
|
var defaultLanguageFromUser = "'.$isoCode.'";
|
|
$("span:lang('.$isoCode.')").show();
|
|
});
|
|
';
|
|
}
|
|
|
|
return '';
|
|
}
|
|
|
|
function api_protect_webservices()
|
|
{
|
|
if (api_get_configuration_value('disable_webservices')) {
|
|
echo "Webservices are disabled. \n";
|
|
echo "To enable, add \$_configuration['disable_webservices'] = true; in configuration.php";
|
|
exit;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Checks if a set of roles have a specific permission.
|
|
*
|
|
* @param string $permissionSlug The slug of the permission to check.
|
|
* @param array $roles An array of role codes to check against.
|
|
* @return bool True if any of the roles have the permission, false otherwise.
|
|
*/
|
|
function api_get_permission(string $permissionSlug, array $roles): bool
|
|
{
|
|
$permissionService = Container::$container->get(PermissionServiceHelper::class);
|
|
|
|
return $permissionService->hasPermission($permissionSlug, $roles);
|
|
}
|
|
|