Merge pull request #69 from Laur0r/nohisconnection

Nohisconnection

Author: Laur0r

addcourse.php

@@ -15,7 +15,7 @@
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 require_once('../../config.php');
-require_once('classes/add_course_form.php');
+//require_once('classes/add_course_form.php');
 $id = required_param('id', PARAM_INT);
 
 require_course_login($id);
@@ -26,11 +26,17 @@
 $PAGE->set_title(get_string('add_course_header', 'block_evasys_sync'));
 
 $record = $DB->get_record('block_evasys_sync_courseeval', array('course' => $id));
-if ($record !== false and ($record->state > \block_evasys_sync\course_evaluation_allocation::STATE_AUTO_NOTOPENED) and !is_siteadmin()) {
+if ($record !== false and ($record->state > \block_evasys_sync\course_evaluation_allocation::STATE_AUTO_NOTOPENED) and
+    !is_siteadmin() or !get_config('block_evasys_sync', 'default_his_connection')) {
     echo $OUTPUT->header();
     echo get_string('forbidden', 'block_evasys_sync');
     echo $OUTPUT->footer();
     return;
+} else if(!array_key_exists('lsf_unification', core_plugin_manager::instance()->get_plugins_of_type('local'))){
+    echo $OUTPUT->header();
+    throw new \moodle_exception('nohisconnection_error', 'block_evasys_sync');
+    echo $OUTPUT->footer();
+    return;
 }
 
 $mform = new \block_evasys_sync\add_course_form();

adminsettings.php

@@ -95,6 +95,11 @@
             } else {
                 set_config('default_evasys_mode', 0, 'block_evasys_sync');
             }
+            if (isset($data->default_his_connection)) {
+                set_config('default_his_connection', $data->default_his_connection, 'block_evasys_sync');
+            } else {
+                set_config('default_his_connection', 0, 'block_evasys_sync');
+            }
 
             $records = \block_evasys_sync\user_cat_allocation::get_records();
             foreach ($records as $allocation) {

block_evasys_sync.php

@@ -91,7 +91,7 @@ public function get_content() {
         }
         $evasyssynchronizer = new \block_evasys_sync\evasys_synchronizer($this->page->course->id);
         try {
-            $evasyscourses = $evasyssynchronizer->get_courses_from_lsf();
+            $evasyscourses = $evasyssynchronizer->get_allocated_courses();
         } catch (Exception $exception) {
             \core\notification::warning(get_string('syncnotpossible', 'block_evasys_sync'));
             $this->content->text .= html_writer::div(get_string('syncnotpossible', 'block_evasys_sync'));
@@ -169,11 +169,11 @@ public function get_content() {
         // Query course data (put in function).
         foreach ($evasyscourses as $evasyscourseinfo) {
             $course = array();
-            $course['evasyscoursetitle'] = $evasyssynchronizer->get_course_name($evasyscourseinfo['id']);
-            $course['technicalid'] = $evasyssynchronizer->get_course_id($evasyscourseinfo['id']);
-            $course['evasyscourseid'] = $evasyscourseinfo['id'];
-            $course['c_participants'] = format_string($evasyssynchronizer->get_amount_participants($evasyscourseinfo['id']));
-            $rawsurveys = $evasyssynchronizer->get_surveys($evasyscourseinfo['id']);
+            $course['evasyscoursetitle'] = $evasyssynchronizer->get_course_name($evasyscourseinfo);
+            $course['technicalid'] = $evasyssynchronizer->get_course_id($evasyscourseinfo);
+            $course['evasyscourseid'] = $evasyscourseinfo;
+            $course['c_participants'] = format_string($evasyssynchronizer->get_amount_participants($evasyscourseinfo));
+            $rawsurveys = $evasyssynchronizer->get_surveys($evasyscourseinfo);
             $surveys = array();
             foreach ($rawsurveys as $rawsurvey) {
                 $survey = array();
@@ -213,6 +213,7 @@ public function get_content() {
         }
 
         $standardttimemode = (!$ismodeautomated && $recordhasstandardtime && !$record);
+        $hisconnection = get_config('block_evasys_sync', 'default_his_connection');
 
         // Create the data object for the mustache table.
         $data = array(
@@ -234,7 +235,7 @@ public function get_content() {
             // If the evaluation hasn't ended yet, display option to restart it.
             'startoption' => $startoption,
             // Only allow coursemapping before starting an evaluation.
-            'coursemappingenabled' => !$startdisabled or is_siteadmin(),
+            'coursemappingenabled' => $hisconnection and (!$startdisabled or is_siteadmin()),
             'nostudents' => $nostudents,
             'emailsentnotice' => $emailsentnotice,
             'evaluationperiodsetnotice' => $periodsetnotice,

classes/admin_form.php

@@ -74,6 +74,14 @@ protected function definition() {
         $mform->setType($name, PARAM_BOOL);
         $mform->setDefault($name, get_config('block_evasys_sync', 'default_evasys_mode'));
 
+        // Default Mode.
+        $name = 'default_his_connection';
+        $title = get_string('his_connection', 'block_evasys_sync');
+        $mform->addElement('checkbox', $name, $title);
+        $mform->setType($name, PARAM_BOOL);
+        $mform->addHelpButton('default_his_connection','his_connection', 'block_evasys_sync');
+        $mform->setDefault($name, get_config('block_evasys_sync', 'default_his_connection'));
+
         // Heading Add Category.
         $mform->addElement('html', '<h3>' . get_string('hd_user_cat', 'block_evasys_sync') . '</h3>');
 

classes/evasys_inviter.php

@@ -17,7 +17,7 @@
 namespace block_evasys_sync;
 
 defined('MOODLE_INTERNAL') || die();
-require_once($CFG->dirroot . "/local/lsf_unification/lib_his.php");
+
 require_once($CFG->libdir . '/adminlib.php');
 require_once($CFG->dirroot . '/course/lib.php');
 /**
@@ -55,27 +55,16 @@ public static function get_evasysids($courseid) {
             $extras = [];
         }
         $extras = array_filter($extras);
-        establish_secondary_DB_connection();
-        // Fetch the Evasysids for the courses.
-        $relevantcourses = array();
-        foreach ($extras as $course) {
-            $courseinfo = get_course_by_veranstid(intval($course));
-            if (!is_object($courseinfo)) {
-                throw new \Exception('Cannot sync: Connection to LSF could not be established. Please try again later.');
-            }
-            $relevantcourses[] = trim($courseinfo->veranstnr) . ' ' . trim($courseinfo->semestertxt);
-        }
-        // Maybe add entry via the $course->idnumber.
+
+	// Maybe add entry via the $course->idnumber.
         $course = get_course($courseid);
         if ($course->idnumber) {
-            $courseinfo = get_course_by_veranstid(intval($course->idnumber));
-            $maincourse = trim($courseinfo->veranstnr) . ' ' . trim($courseinfo->semestertxt);
+            $maincourse = $course->idnumber;
         }
-        if (!in_array($maincourse, $relevantcourses)) {
-            $relevantcourses[] = $maincourse;
+        if (!in_array($maincourse, $extras)) {
+            $extras[] = $maincourse;
         }
-        close_secondary_DB_connection();
-        return $relevantcourses;
+        return $extras;
     }
 
     /**
@@ -363,4 +352,4 @@ public static function alert_coordinator($courseid, $startdate, $enddate) {
         email_to_user($usercoordinator, $USER, $subject, $message, '', '' , '',
                                     true, $USER->email, $USER->firstname . " " . $USER->lastname);
     }
-}
+}

classes/evasys_synchronizer.php

@@ -18,7 +18,6 @@
 
 defined('MOODLE_INTERNAL') || die();
 
-require_once($CFG->dirroot . "/local/lsf_unification/lib_his.php");
 require_once($CFG->libdir . '/adminlib.php');
 require_once($CFG->dirroot . '/course/lib.php');
 
@@ -27,7 +26,7 @@ class evasys_synchronizer {
     protected $soapclient;
     private $blockcontext;
     private $courseinformation;
-    private $lsfcourses;
+    private $evasyscourses;
 
     public function __construct($courseid) {
         $this->courseid = $courseid;
@@ -36,26 +35,20 @@ public function __construct($courseid) {
         $this->courseinformation = $this->get_course_information();
     }
 
-    public function get_courses_from_lsf() {
+    public function get_allocated_courses() {
         global $DB;
-        if ($this->lsfcourses !== null) {
-            return $this->lsfcourses;
+
+        if ($this->evasyscourses !== null) {
+            return $this->evasyscourses;
         }
         $course = get_course($this->courseid);
 
-        // Fetch veranstnr from LSF view.
         if ($course->idnumber) {
-            establish_secondary_DB_connection();
-            $lsfentry = get_course_by_veranstid(intval($course->idnumber));
-            close_secondary_DB_connection();
-
-            if (!is_object($lsfentry)) {
-                throw new \Exception('Cannot sync: Connection to LSF could not be established. Please try again later.');
-            }
-            $maincourse = trim($lsfentry->veranstid);
+            $maincourse = $course->idnumber;
         }
         // Fetch persistent object id.
         $pid = $DB->get_field('block_evasys_sync_courses', 'id', array('course' => $this->courseid));
+
         // Get all associated courses.
         if (!$pid === false) {
             $extras = new \block_evasys_sync\course_evasys_courses_allocation($pid);
@@ -70,18 +63,8 @@ public function get_courses_from_lsf() {
             }
         }
         $extras = array_filter($extras);
-        establish_secondary_DB_connection();
-        // Fetch metadata (id, title) for the courses.
-        $result = array();
-        foreach ($extras as $course) {
-            $courseinfo = get_course_by_veranstid(intval($course));
-            $result[] = array(
-                'title' => $courseinfo->titel,
-                'id' => trim($courseinfo->veranstnr) . ' ' . trim($courseinfo->semestertxt));
-        }
-        close_secondary_DB_connection();
-        $this->lsfcourses = $result;
-        return $this->lsfcourses;
+        $this->evasyscourses = $extras;
+        return $this->evasyscourses;
     }
 
     private function init_soap_client() {
@@ -101,15 +84,16 @@ private function init_soap_client() {
 
     private function get_course_information() {
         $result = [];
-        foreach ($this->get_courses_from_lsf() as $course) {
-            $soapresult = $this->soapclient->GetCourse($course['id'], 'PUBLIC', true, true);
+        foreach ($this->get_allocated_courses() as $course) {
+            $soapresult = $this->soapclient->GetCourse($course, 'PUBLIC', true, true);
             if (is_soap_fault($soapresult)) {
+                //var_dump("soap verbindung nicht funktioniert");
                 // This happens e.g. if there is no corresponding course in EvaSys.
                 return null;
             }
-            $result[$course['id']] = $soapresult;
+	    $result[$course] = $soapresult;
         }
-        return $result;
+	return $result;
     }
 
     /**
@@ -145,7 +129,7 @@ public function get_surveys($courseid) {
     public function get_all_surveys() {
         // Gets all surveys from the associated evasys courses.
         $surveys = [];
-        foreach ($this->lsfcourses as $course) {
+        foreach ($this->evasyscourses as $course) {
             $surveys = array_merge($surveys, $this->get_surveys($course['id']));
         }
         return $surveys;

lang/de/block_evasys_sync.php

@@ -55,6 +55,7 @@
 $string['coursename'] = "Kursname";
 $string['associated'] = "zugeordnet";
 $string['forbidden'] = "Die Aktion ist im aktuellen Status des Kurses nicht zulässig";
+$string['hisconnection_error'] = "Um diese Funktion nutzen zu können, muss das lokale Plugin lsf_unification installiert werden";
 $string['maincoursepredefined'] = 'Vordefinierte Zuordnung.';
 $string['maincoursepredefined_help'] = 'Dieser LSF-Kurs ist fest zugeordnet, da dies der entsprechende Learnweb-Kurs ist. Falls Sie dies für nicht korrekt halten, wenden Sie sich bitte an den Learnweb-Support.';
 
@@ -154,6 +155,10 @@
 $string['settings_wsdl_url'] = 'EvaSys WSDL URL';
 $string['settings_moodleuser'] = 'Standard Nutzer-ID des Benachrichtigungsempfängers nach Sync';
 $string['settings_mode'] = 'Standardmodus für Kategorien';
+$string['his_connection'] = 'Aktiviere Mehrfach-Evaluationen (Achtung, externes Plugin notwendig!)';
+$string['his_connection_help'] = 'Optionales Feature, dass es ermöglicht einem Kurs mehrere evasys Evaluationen zuzuordnen.
+Dazu wird ein externes lokale Plugin lsf_unification (https://github.com/learnweb/his_unification) und 
+eine Anbindung an das CMS Software HIS LSF benötigt um weitere Veranstaltungen von den verantwortlichen Lehrenden zu identifizieren.';
 $string['settings_moodleuser_select'] = 'Kurskategorien';
 $string['settings_cc_select'] = 'Kurskategorie auswählen';
 $string['settings_cc_user'] = 'Nutzer-ID des Empfängers für die gewählte Kurskategorie';

lang/en/block_evasys_sync.php

@@ -54,6 +54,7 @@
 $string['coursename'] = "Course name";
 $string['associated'] = "associated";
 $string['forbidden'] = "This action is currently prohibited.";
+$string['nohisconnection_error'] = "To be able to use this feature, the local plugin lsf_unification needs to be installed.";
 $string['maincoursepredefined'] = 'Fixed association.';
 $string['maincoursepredefined_help'] = 'This LSF course is fixed, as it has been directly associated with this Moodle course. If you think that this is incorrect, please contact the support team.';
 
@@ -161,6 +162,10 @@
 $string['settings_wsdl_url'] = 'EvaSys WSDL URL';
 $string['settings_moodleuser'] = 'Default user ID of mail recipient after sync';
 $string['settings_mode'] = 'Default mode for categories';
+$string['his_connection'] = 'Enable multiple evaluations (Caution, this requires an external plugin)';
+$string['his_connection_help'] = 'Optional Feature which enables to assign multiple evasys evaluations to one course. This
+requires the external local plugin lsf_unification (https://github.com/learnweb/his_unification) and a connection to the CMS Software HIS LSF
+to identify further lectures of the corresponding teachers.';
 $string['settings_moodleuser_select'] = 'Course categories';
 $string['settings_cc_select'] = 'Select course category';
 $string['settings_cc_user'] = 'Recipient (moodle user id) for selected course category';

version.php

@@ -21,7 +21,3 @@
 $plugin->version = 2019203100;  // YYYYMMDDHH (year, month, day, 24-hr time).
 $plugin->requires = 2017111300; // YYYmoYMMDDHH (This is the release version for Moodle 2.0).
 $plugin->maturity = MATURITY_RC;
-
-$plugin->dependencies = array(
-    'local_lsf_unification' => 2013090304,   // The lsf_unification module is needed for retrieving the lsf id.
-);