Admin: Add config "multiple_access_url_show_shared_course_marker"

Add icon in userportal.php if course was shared in other portals Add url list in course_edit.php See BT#17783
5 years ago · ea5a077157
parent 7c94fa061b
commit ea5a077157
12 changed files with 118 additions and 53 deletions
--- a/main/admin/course_edit.php
+++ b/main/admin/course_edit.php
@ -320,6 +320,15 @@ $extra = $extra_field->addElements(
    true
 );

+if (api_get_configuration_value('multiple_access_url_show_shared_course_marker')) {
+    $urls = UrlManager::get_access_url_from_course($courseId);
+    $urlToString = '';
+    foreach ($urls as $url) {
+        $urlToString .= $url['url'];
+    }
+    $form->addLabel('URLs', $urlToString);
+}
+
 $htmlHeadXtra[] = '
 <script>
 $(function() {
@ -554,7 +563,6 @@ function valide() {
 }
 </script>";

-// Display the form
 $form->display();

-Display:: display_footer();
+Display::display_footer();
--- a/main/inc/lib/course.lib.php
+++ b/main/inc/lib/course.lib.php
@ -3833,6 +3833,9 @@ class CourseManager

        $courseList = [];
        if ($number_of_courses > 0) {
+            $hideCourseNotification = api_get_configuration_value('hide_course_notification');
+            $showUrlMarker = api_get_configuration_value('multiple_access_url_show_shared_course_marker') &&
+                (api_is_platform_admin() || api_is_teacher());
            while ($course = Database::fetch_array($rs_special_course)) {
                $course_info = api_get_course_info($course['code']);
                $courseId = $course_info['real_id'];
@ -3841,7 +3844,7 @@ class CourseManager
                }

                $params = [];
-                //Param (course_code) needed to get the student info in page "My courses"
+                // Param (course_code) needed to get the student info in page "My courses"
                $params['course_code'] = $course['code'];
                $params['code'] = $course['code'];
                // Get notifications.
@ -3853,9 +3856,7 @@ class CourseManager
                } else {
                    $course_info['status'] = $courseUserInfo['status'];
                }
-                $show_notification = !api_get_configuration_value('hide_course_notification')
-                    ? Display::show_notification($course_info)
-                    : '';
+                $show_notification = !$hideCourseNotification ? Display::show_notification($course_info) : '';
                $params['edit_actions'] = '';
                $params['document'] = '';
                if (api_is_platform_admin()) {
@ -3885,7 +3886,12 @@ class CourseManager
                    null
                );

-                if (api_get_setting('display_coursecode_in_courselist') == 'true') {
+                $params['url_marker'] = '';
+                if ($showUrlMarker) {
+                    $params['url_marker'] = self::getUrlMarker($courseId);
+                }
+
+                if (api_get_setting('display_coursecode_in_courselist') === 'true') {
                    $params['code_course'] = '('.$course_info['visual_code'].')';
                }

@ -4082,6 +4088,9 @@ class CourseManager
        // Browse through all courses.
        $courseAdded = [];
        $courseList = [];
+        $hideNotification = api_get_configuration_value('hide_course_notification');
+        $showUrlMarker = api_get_configuration_value('multiple_access_url_show_shared_course_marker') &&
+            (api_is_platform_admin() || api_is_teacher());

        while ($row = Database::fetch_array($result)) {
            $course_info = api_get_course_info_by_id($row['id']);
@ -4103,13 +4112,11 @@ class CourseManager
            $course_info['status'] = $row['status'];
            // For each course, get if there is any notification icon to show
            // (something that would have changed since the user's last visit).
-            $showNotification = !api_get_configuration_value('hide_course_notification')
-                ? Display::show_notification($course_info)
-                : '';
+            $showNotification = !$hideNotification ? Display::show_notification($course_info) : '';
            $iconName = basename($course_info['course_image']);

            $params = [];
-            //Param (course_code) needed to get the student process
+            // Param (course_code) needed to get the student process
            $params['course_code'] = $row['course_code'];
            $params['code'] = $row['course_code'];

@ -4177,6 +4184,11 @@ class CourseManager
                $params['code_course'] = '('.$course_info['visual_code'].') ';
            }

+            $params['url_marker'] = '';
+            if ($showUrlMarker) {
+                $params['url_marker'] = self::getUrlMarker($course_info['real_id']);
+            }
+
            $params['current_user_is_teacher'] = false;
            /** @var array $teacher */
            foreach ($teachers as $teacher) {
@ -7112,4 +7124,19 @@ class CourseManager
        $courseFieldValue = new ExtraFieldValue('course');
        $courseFieldValue->saveFieldValues($params);
    }
+
+    public static function getUrlMarker($courseId)
+    {
+        if (UrlManager::getCountAccessUrlFromCourse($courseId) > 1) {
+            return '&nbsp;'.Display::returnFontAwesomeIcon(
+                'link',
+                null,
+                null,
+                null,
+                get_lang('CourseUsedInOtherURL')
+            );
+        }
+
+        return '';
+    }
 }
--- a/main/inc/lib/display.lib.php
+++ b/main/inc/lib/display.lib.php
@ -2639,15 +2639,16 @@ class Display
     * @param string     $name            The icon name. Example: "mail-reply"
     * @param int|string $size            Optional. The size for the icon. (Example: lg, 2, 3, 4, 5)
     * @param bool       $fixWidth        Optional. Whether add the fw class
-     * @param string     $additionalClass Optional. Additional class
-     *
+     * @param string     $additionalClass
+     * @param string     $title
     * @return string
     */
    public static function returnFontAwesomeIcon(
        $name,
        $size = '',
        $fixWidth = false,
-        $additionalClass = ''
+        $additionalClass = '',
+        $title = ''
    ) {
        $className = "fa fa-$name";

@ -2671,7 +2672,7 @@ class Display
            $className .= " $additionalClass";
        }

-        $icon = self::tag('em', null, ['class' => $className]);
+        $icon = self::tag('em', null, ['class' => $className, 'title' => $title]);

        return "$icon ";
    }
--- a/main/inc/lib/urlmanager.lib.php
+++ b/main/inc/lib/urlmanager.lib.php
@ -479,7 +479,7 @@ class UrlManager
    {
        $table = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_USERGROUP);
        $sql = "SELECT usergroup_id FROM $table
-               WHERE 
+                WHERE
                    access_url_id = ".intval($urlId)." AND
                    usergroup_id = ".intval($userGroupId);
        $result = Database::query($sql);
@ -534,8 +534,8 @@ class UrlManager
                    $count = self::relation_url_user_exist($user_id, $urlId);
                    if (0 == $count) {
                        $sql = "INSERT INTO $table
-                                SET 
-                                    user_id = ".intval($user_id).", 
+                                SET
+                                    user_id = ".intval($user_id).",
                                    access_url_id = ".intval($urlId);
                        $result = Database::query($sql);
                        if ($result) {
@ -672,7 +672,7 @@ class UrlManager
    {
        $table = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_COURSE_CATEGORY);
        $sql = "SELECT course_category_id FROM $table
-                WHERE 
+                WHERE
                    access_url_id = ".intval($urlId)." AND
                    course_category_id = ".intval($categoryCourseId);
        $result = Database::query($sql);
@ -861,8 +861,8 @@ class UrlManager
        $result = true;
        if (!empty($user_id) && !empty($urlId)) {
            $sql = "DELETE FROM $table
-                   WHERE 
-                        user_id = ".intval($user_id)." AND 
+                   WHERE
+                        user_id = ".intval($user_id)." AND
                        access_url_id = ".intval($urlId);
            $result = Database::query($sql);
        }
@ -947,7 +947,7 @@ class UrlManager
    {
        $table = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_COURSE_CATEGORY);
        $sql = "DELETE FROM $table
-                WHERE 
+                WHERE
                    course_category_id = '".intval($userGroupId)."' AND
                    access_url_id=".intval($urlId)."  ";
        $result = Database::query($sql);
@ -969,8 +969,8 @@ class UrlManager
    {
        $table = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_SESSION);
        $sql = "DELETE FROM $table
-                WHERE 
-                    session_id = ".intval($session_id)." AND 
+                WHERE
+                    session_id = ".intval($session_id)." AND
                    access_url_id=".intval($urlId)."  ";
        $result = Database::query($sql, 'ASSOC');

@ -992,8 +992,8 @@ class UrlManager
        $table = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_USER);
        $urlId = (int) $urlId;

-        $sql = "SELECT user_id 
-                FROM $table 
+        $sql = "SELECT user_id
+                FROM $table
                WHERE access_url_id = $urlId";
        $result = Database::query($sql);
        $existing_users = [];
@ -1087,7 +1087,7 @@ class UrlManager
    {
        $table = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_USERGROUP);

-        $sql = "SELECT usergroup_id FROM $table 
+        $sql = "SELECT usergroup_id FROM $table
                WHERE access_url_id = ".intval($urlId);
        $result = Database::query($sql);
        $existingItems = [];
@ -1121,8 +1121,8 @@ class UrlManager
    public static function updateUrlRelCourseCategory($list, $urlId)
    {
        $table = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_COURSE_CATEGORY);
-        $sql = "SELECT course_category_id 
-                FROM $table 
+        $sql = "SELECT course_category_id
+                FROM $table
                WHERE access_url_id = ".intval($urlId);
        $result = Database::query($sql);
        $existingItems = [];
@ -1171,7 +1171,7 @@ class UrlManager
    {
        $table = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_SESSION);

-        $sql = "SELECT session_id FROM $table 
+        $sql = "SELECT session_id FROM $table
                WHERE access_url_id=".intval($urlId);
        $result = Database::query($sql);
        $existing_sessions = [];
@ -1211,15 +1211,14 @@ class UrlManager
    {
        $table = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_USER);
        $table_url = Database::get_main_table(TABLE_MAIN_ACCESS_URL);
-        $sql = "SELECT url, access_url_id 
-                FROM $table url_rel_user 
+        $sql = "SELECT url, access_url_id
+                FROM $table url_rel_user
                INNER JOIN $table_url u
                ON (url_rel_user.access_url_id = u.id)
                WHERE user_id = ".intval($user_id);
        $result = Database::query($sql);
-        $url_list = Database::store_result($result, 'ASSOC');

-        return $url_list;
+        return Database::store_result($result, 'ASSOC');
    }

    /**
@ -1231,15 +1230,35 @@ class UrlManager
    {
        $table = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_COURSE);
        $table_url = Database::get_main_table(TABLE_MAIN_ACCESS_URL);
-        $sql = "SELECT url, access_url_id FROM $table c 
+        $courseId = (int) $courseId;
+        $sql = "SELECT url, access_url_id FROM $table c
                INNER JOIN $table_url u
                ON (c.access_url_id = u.id)
-                WHERE c_id = ".intval($courseId);
+                WHERE c_id = $courseId";

        $result = Database::query($sql);
-        $url_list = Database::store_result($result, 'ASSOC');

-        return $url_list;
+        return Database::store_result($result, 'ASSOC');
+    }
+
+    public static function getCountAccessUrlFromCourse($courseId)
+    {
+        $courseId = (int) $courseId;
+        $table = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_COURSE);
+        $table_url = Database::get_main_table(TABLE_MAIN_ACCESS_URL);
+        $sql = "SELECT count(u.id) count FROM $table c
+                INNER JOIN $table_url u
+                ON (c.access_url_id = u.id)
+                WHERE c_id = $courseId ";
+
+        $result = Database::query($sql);
+        if ($result) {
+            $row = Database::fetch_array($result, 'ASSOC');
+
+            return (int) $row['count'];
+        }
+
+        return 0;
    }

    /**
@ -1251,8 +1270,8 @@ class UrlManager
    {
        $table_url_rel_session = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_SESSION);
        $table_url = Database::get_main_table(TABLE_MAIN_ACCESS_URL);
-        $sql = "SELECT url, access_url_id 
-                FROM $table_url_rel_session url_rel_session 
+        $sql = "SELECT url, access_url_id
+                FROM $table_url_rel_session url_rel_session
                INNER JOIN $table_url u
                ON (url_rel_session.access_url_id = u.id)
                WHERE session_id = ".intval($sessionId);
@ -1270,7 +1289,7 @@ class UrlManager
    public static function get_url_id($url)
    {
        $table = Database::get_main_table(TABLE_MAIN_ACCESS_URL);
-        $sql = "SELECT id FROM $table 
+        $sql = "SELECT id FROM $table
                WHERE url = '".Database::escape_string($url)."'";
        $result = Database::query($sql);
        $urlId = Database::result($result, 0, 0);
@ -1294,10 +1313,10 @@ class UrlManager
            $needle = api_convert_encoding($needle, $charset, 'utf-8');
            $needle = Database::escape_string($needle);
            // search courses where username or firstname or lastname begins likes $needle
-            $sql = 'SELECT id, name 
+            $sql = 'SELECT id, name
                    FROM '.Database::get_main_table(TABLE_MAIN_CATEGORY).' u
-                    WHERE 
-                        name LIKE "'.$needle.'%" AND 
+                    WHERE
+                        name LIKE "'.$needle.'%" AND
                        (parent_id IS NULL or parent_id = 0)
                    ORDER BY name
                    LIMIT 11';
--- a/main/install/configuration.dist.php
+++ b/main/install/configuration.dist.php
@ -1616,7 +1616,7 @@ $_configuration['auth_password_links'] = [
 //$_configuration['show_my_lps_page'] = false;

 // When exercise is finished send results by email to users, depending the settings below:
-$_configuration['exercise_finished_email_settings'] = [
+/*$_configuration['exercise_finished_email_settings'] = [
    'send_by_status' => [
        [
            'status' => 5, // 5 = student that is doing the exercise send to the Chamilo inbox + email
@ -1633,7 +1633,10 @@ $_configuration['exercise_finished_email_settings'] = [
            'type' => 'only_score',
        ],
    ],
-];
+];*/
+
+// Shows a marker if the course was shared in other portals.
+//$_configuration['multiple_access_url_show_shared_course_marker'] = false;

 // KEEP THIS AT THE END
 // -------- Custom DB changes
--- a/main/lang/english/trad4all.inc.php
+++ b/main/lang/english/trad4all.inc.php
@ -8672,4 +8672,5 @@ $RedirectToPortalHome = "Redirect to the platform home page";
 $MyLps = "My learning paths";
 $LastVisitedLp = "Last visited learning path";
 $YouDidNotVisitALpHereTheLpList = "You haven't visited any learning paths yet, here is the list of your learning paths.";
+$CourseUsedInOtherURL = "This course is used in at least one other portal";
 ?>
--- a/main/lang/french/trad4all.inc.php
+++ b/main/lang/french/trad4all.inc.php
@ -8604,4 +8604,5 @@ $RedirectToPortalHome = "Rediriger vers la page d'accueil de la plateforme";
 $MyLps = "Mes parcours";
 $LastVisitedLp = "Dernier parcours visité";
 $YouDidNotVisitALpHereTheLpList = "Vous n'avez encore visité aucun parcours, voici la liste de vos parcours.";
+$CourseUsedInOtherURL = "Ce cours est utilisé sur au moins un autre portail";
 ?>
--- a/main/lang/spanish/trad4all.inc.php
+++ b/main/lang/spanish/trad4all.inc.php
@ -8700,4 +8700,5 @@ $RedirectToPortalHome = "Redirigir a la página de inicio de la plataforma";
 $MyLps = "Mis lecciones";
 $LastVisitedLp = "Última lección visitada";
 $YouDidNotVisitALpHereTheLpList = "Aún no ha visitado una lección, aquí está la lista de sus lecciones.";
+$CourseUsedInOtherURL = "Este curso es usado en otro portal";
 ?>
--- a/main/template/default/user_portal/classic_courses_with_category.tpl
+++ b/main/template/default/user_portal/classic_courses_with_category.tpl
@ -47,10 +47,10 @@
                            {% endif %}
                            <h4 class="course-items-title">
                                {% if item.visibility == constant('COURSE_VISIBILITY_CLOSED') and not item.current_user_is_teacher %}
-                                    {{ item.title }} {{ item.code_course }}
+                                    {{ item.title }} {{ item.code_course }} {{ item.url_marker }}
                                {% else %}
                                    <a href="{{ item.link }}">
-                                        {{ item.title }} {{ item.code_course }}
+                                        {{ item.title }} {{ item.code_course }} {{ item.url_marker }}
                                    </a>
                                    {{ item.notifications }}
                                {% endif %}
--- a/main/template/default/user_portal/classic_courses_without_category.tpl
+++ b/main/template/default/user_portal/classic_courses_without_category.tpl
@ -45,11 +45,12 @@
                        </div>
                        <h4 class="course-items-title">
                            {% if item.visibility == constant('COURSE_VISIBILITY_CLOSED') and not item.current_user_is_teacher %}
-                                {{ item.title }} {{ item.code_course }}
+                                {{ item.title }} {{ item.code_course }} {{ item.url_marker }}
                            {% else %}
                                <a href="{{ item.link }}">
                                    {{ item.title }} {{ item.code_course }}
                                </a>
+                                {{ item.url_marker }}
                                {{ item.notifications }}
                                {% if item.is_special_course %}
                                    {{ 'klipper.png' | img(22, 'CourseAutoRegister'|get_lang ) }}
--- a/main/template/default/user_portal/grid_courses_with_category.tpl
+++ b/main/template/default/user_portal/grid_courses_with_category.tpl
@ -58,9 +58,12 @@
                                <div class="description">
                                    <h4 class="title">
                                        {% if item.visibility == constant('COURSE_VISIBILITY_CLOSED') and not item.current_user_is_teacher %}
-                                            {{ item.title }} {{ item.code_course }}
+                                            {{ item.title }} {{ item.code_course }} {{ item.url_marker }}
                                        {% else %}
-                                            <a href="{{ item.link }}">{{ item.title }} {{ item.code_course }}</a>
+                                            <a href="{{ item.link }}">
+                                                {{ item.title }} {{ item.code_course }}
+                                            </a>
+                                            {{ item.url_marker }}
                                        {% endif %}
                                    </h4>
                                    {% if item.notifications %}
--- a/main/template/default/user_portal/grid_courses_without_category.tpl
+++ b/main/template/default/user_portal/grid_courses_without_category.tpl
@ -42,10 +42,10 @@
                                <h4 class="title" title="{{ item.title }}">
                                    {% if item.visibility == constant('COURSE_VISIBILITY_CLOSED') and not item.current_user_is_teacher %}
                                        {{ item.title_cut }}
-                                        <span class="code-title">{{ item.code_course }}</span>
+                                        <span class="code-title">{{ item.code_course }}</span>{{ item.url_marker }}
                                    {% else %}
                                        <a title="{{ item.title }}" href="{{ item.link }}">{{ item.title_cut }}</a>
-                                        <span class="code-title">{{ item.code_course }}</span>
+                                        <span class="code-title">{{ item.code_course }}</span>{{ item.url_marker }}
                                    {% endif %}
                                </h4>
                            </div>