Merge pull request #243 from introlab/dev

Main merge for 1.2.5 release

Author: SBriere

.gitignore

@@ -51,49 +51,34 @@ docs/_build/
 docs/--no-check-certificate
 docs/swagger.json
 
-build-teraplus-Desktop_Qt_5_12_0_MSVC2017_64bit-Debug
 *.user
-build-teraserver-Desktop_Qt_5_12_0_MSVC2017_64bit-Debug
 .idea
-python-3.6
 
 # Docker
 docker/prod/certificates/*.pem
 
 # Node modules
 node_modules/
-/teraplus/CMakeLists.txt.user.4.9-pre1
-/teraserver/CMakeLists.txt.user.4.9-pre1
-/teraserver/python/config/TeraServerConfig.ini~0b30c4625222f7c8696ca353a9e47d17d15d6cb5
 /teraserver/python/messages/python/*
 /teraserver/python/certificates/ca_cert.pem
 /teraserver/python/certificates/ca_key.pem
 /teraserver/python/certificates/devices/client_certificate.pem
 /teraserver/python/certificates/devices/client_key.pem
 /teraserver/python/certificates/site_cert.pem
 /teraserver/python/certificates/site_key.pem
-/teraplus/client/resources/icons/device.psd
 /teraserver/python/uploads
-build-teraplus-Desktop_Qt_5_13_1_MSVC2017_64bit-Debug
-build-teraserver-Desktop_Qt_5_13_1_MSVC2017_64bit-Debug
-build-teraplus-Desktop_Qt_5_13_1_MSVC2017_64bit-Release
-build-teraserver-Desktop_Qt_5_13_2_MSVC2017_64bit-Debug
-build-teraserver-Desktop_Qt_5_14_0_MSVC2017_64bit-Debug
-build-teraserver-Desktop_Qt_5_14_1_MSVC2017_64bit-Debug
 protobuf
-teraserver/python/env/_python-3.6
-build-teraserver-Desktop_Qt_5_14_2_MSVC2017_64bit-Debug
-python-3.8
-teraserver/python/services/BureauActif/uploads/
 /teraserver/python/OpenTeraServerVersion.py
 /teraserver/python/services/FileTransferService/upload
 files
 build-teraserver-Desktop_Qt_5_15_2_MSVC2019_64bit-Debug
-python-3.10
 /teraserver/easyrtc/package-lock.json
 venv
 joss-paper/paper.jats
 joss-paper/paper.pdf
 /.vscode
-_python-3.10
 python-3.11
+build-teraserver-Desktop_Qt_6_6_1_MSVC2019_64bit-Debug
+python-3.10
+/teraserver/python/config/certificates
+/teraserver/python/tests/*.pem

README.md

@@ -56,6 +56,7 @@ You are welcome to participate in this effort. Leave us comments or report [Issu
 
 ## Publication(s)
 
+* [![DOI](https://joss.theoj.org/papers/10.21105/joss.05497/status.svg)](https://doi.org/10.21105/joss.05497) Létourneau, D., Brière , S.,  et al., [OpenTera: A Framework for Telehealth Applications](https://doi.org/10.21105/joss.05497), Journal of Open Source Software, vol. 8, no 91, p. 5497 (2023)
 * Panchea, A.M., Létourneau, D., Brière, S. et al., [OpenTera: A microservice architecture solution for rapid prototyping of robotic solutions to COVID-19 challenges in care facilities](https://rdcu.be/cHzmf),  Health Technol. 12, 583–596 (2022)
 
 ## Videos

docs/conf.py

@@ -7,9 +7,9 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
 project = 'OpenTera'
-copyright = '2023, Simon Brière, Dominic Létourneau'
+copyright = '2024, Simon Brière, Dominic Létourneau'
 author = 'Simon Brière, Dominic Létourneau'
-release = '1.2.4'
+release = '1.2.5'
 version = release
 
 html_logo = 'images/LogoOpenTera200px.png'

teraserver/CMakeLists.txt

@@ -10,7 +10,7 @@ endif(NOT CMAKE_BUILD_TYPE)
 # Software version
 SET(OPENTERA_VERSION_MAJOR "1")
 SET(OPENTERA_VERSION_MINOR "2")
-SET(OPENTERA_VERSION_PATCH "4")
+SET(OPENTERA_VERSION_PATCH "5")
 
 SET(OPENTERA_SERVER_VERSION OpenTera_v${OPENTERA_VERSION_MAJOR}.${OPENTERA_VERSION_MINOR}.${OPENTERA_VERSION_PATCH})
 

teraserver/easyrtc/protected/index_users.html

@@ -130,7 +130,7 @@ <h5 class="modal-title" id="chronosDialogLongTitle" data-i18n="chronosDialog.tit
                         </select>
                     </div>
                     <div class="form-group row pr-2">
-                        <label for="chronosTypeRadio" class="col-form-label col-4" data-i18n="chronosDialog.chrono-type">Type: </label>
+                        <label class="col-form-label col-4" data-i18n="chronosDialog.chrono-type">Type: </label>
                         <div id="chronosTypeRadio" class="col col-form-label pl-0">
                             <input id="optChronoType1" value=1 class="mr-1" type="radio" name="optChronoType" data-i18n="chronosDialog.chrono-countdown" checked /><label class="radio-inline pr-2" for="optChronoType1">Décompte</label>
                             <input id="optChronoType2" value=2 class="mr-1" type="radio" name="optChronoType" data-i18n="chronosDialog.chrono-countup" /><label class="radio-inline" for="optChronoType2">Chronomètre</label>

teraserver/easyrtc/static/js/tera_layout_participants.js

@@ -98,7 +98,7 @@ function updateUserLocalViewLayout(){
     let remote_num = usedRemoteVideosIndexes.length;
     let usedLocalVideosIndexes = getVideoStreamsIndexes(localStreams);
     let local_num = usedLocalVideosIndexes.length;
-    //console.log(usedLocalVideosIndexes);
+
 
     if (currentLargeViewId.startsWith('local') && local_num === 1){
         setColWidth(largeView, 10);
@@ -112,6 +112,7 @@ function updateUserLocalViewLayout(){
     }
 
     switch(local_num){
+        case 0:
         case 1:
             selfViewRow2.hide();
             break;

teraserver/easyrtc/static/js/tera_medias.js

@@ -11,28 +11,61 @@ async function fillDefaultSourceList(){
     videoSources.length=0;
     audioSources.length=0;
 
-    // Open a stream to ask for permissions and allow listing of full name of devices.
-    try{
-        /*await navigator.mediaDevices.getUserMedia({
-            audio: true,
-            video: {
-                width: {ideal: 1280, max: 1920 },
-                height: {ideal: 720, max: 1080 },
-                frameRate: {min: 15}//, ideal: 30}
-            }
-        });*/
-        await navigator.mediaDevices.getUserMedia({
-            audio: true,
-            video: true
-        });
+    // Get devices ids in case the first camera returned by getUserMedia isn't valid (we use usermedia here only to get
+    // camera names
+    let all_devices;
+    try {
+        all_devices = await navigator.mediaDevices.enumerateDevices();
     }catch(err) {
-        showError("fillDefaultSourceList() - getUserMedia",
-            translator.translateForKey("errors.no-media-access", currentLang) + "<br><br>" +
-            translator.translateForKey("errors.error-msg", currentLang) +
-            ":<br>" + err.name + " - " + err.message, true);
+        showError("fillDefaultSourceList() - enumerate Initial Devices", err.name + " - " + err.message, true);
         throw err;
     }
 
+    // Open a stream to ask for permissions and allow listing of full name of devices.
+    if (all_devices.length === 0){
+        showError(translator.translateForKey("errors.no-media-access", currentLang),
+            translator.translateForKey("errors.error-msg", currentLang), true);
+        return;
+    }
+    let current_dev_index = 0;
+    let ready = false;
+    let devices_anom = [];
+    all_devices.forEach(device => {
+        if (device.kind === "videoinput"){
+            devices_anom.push(device);
+        }
+    });
+    while(!ready){
+        try{
+            // await navigator.mediaDevices.getUserMedia({
+            //     audio: true,
+            //     video: {
+            //         width: {ideal: 1280, max: 1920 },
+            //         height: {ideal: 720, max: 1080 },
+            //         frameRate: {min: 15}//, ideal: 30}
+            //     }
+            // });
+            await navigator.mediaDevices.getUserMedia({
+                audio: true,
+                video: {
+                    deviceId: devices_anom[current_dev_index].deviceId
+                }
+            }).then(function() {
+                ready = true;
+            });
+        }catch(err) {
+            current_dev_index+=1; // Will try next source
+            if (current_dev_index >= devices_anom.length){
+                // Tried every device
+                showError("fillDefaultSourceList() - getUserMedia",
+                    translator.translateForKey("errors.no-media-access", currentLang) + "<br><br>" +
+                    translator.translateForKey("errors.error-msg", currentLang) +
+                    ":<br>" + err.name + " - " + err.message, true);
+                throw err;
+            }
+        }
+    }
+
     try {
         let devices = await navigator.mediaDevices.enumerateDevices();
         devices.forEach(device => {

teraserver/easyrtc/static/js/tera_webrtc.js

@@ -12,10 +12,13 @@ let localStreams = []; // {peerid, streamname, stream: MediaStream}, order is im
 var connected = false;
 var needToCallOtherUsers = false;
 
+let preinitCameras = true;
+
 function connect() {
 
     console.log("Connecting...");
-    playSound("audioCalling");
+    if (!preinitCameras)
+        playSound("audioCalling");
 
     /*var localFilter = easyrtc.buildLocalSdpFilter( {
         audioRecvBitrate:20, videoRecvBitrate:30 ,videoRecvCodec:"h264"
@@ -41,11 +44,61 @@ function connect() {
     //Post-connect Event listeners
     //easyrtc.setOnHangup(streamDisconnected);
     //easyrtc.setOnCall(newStreamStarted);
+    if (preinitCameras)
+        preloadCameras();
+    else{
+        connected = true;
+        updateLocalAudioVideoSource(1);
+        showLayout(true);
+    }
 
-    connected = true;
-    updateLocalAudioVideoSource(1);
 
-    showLayout(true);
+}
+
+// On some devices, there's a strange bug that delays access to the camera, unless we try to access it at least once...
+function preloadCameras(){
+    navigator.mediaDevices.enumerateDevices()
+        .then(function(devices) {
+            let preload_devices = [];
+            devices.forEach(function(device) {
+                if (device.kind === "videoinput"){
+                    if (!device.label.includes(" IR ")) { // Filter "IR" camera, since they won't work.
+                        preload_devices.push(device);
+                    }
+                }
+                //console.log(device.kind + ": " + device.label + " id = " + device.deviceId);
+            });
+            preloadCamera(preload_devices, 0);
+        })
+        .catch(function(err) {
+            console.log(err.name + ": " + err.message);
+        });
+
+}
+
+function preloadCamera(devices, current_index){
+    if (current_index >= devices.length || current_index < 0){
+        return;
+    }
+
+    navigator.mediaDevices.getUserMedia({video: {deviceId: { exact: devices[current_index].deviceId }},
+        audio: false}).then(function(stream){
+            console.log("Preloaded camera " + devices[current_index].label + "(" + devices[current_index].deviceId + ")");
+            stream.getTracks().forEach(track => track.stop());
+            // Did we get at least the first stream? If so, start everything!
+            //if (current_index === 0){
+            if (!connected){
+                playSound("audioCalling");
+                connected = true;
+                updateLocalAudioVideoSource(1);
+                showLayout(true);
+            }
+            preloadCamera(devices, current_index + 1);
+    }).catch(async function() {
+        console.log("Can't preload camera: " + devices[current_index].label);
+        /*await new Promise(resolve => setTimeout(resolve, 1000))*/
+        preloadCamera(devices, current_index + 1);
+    });
 }
 
 function muteMicro(local, index, new_state){
@@ -264,14 +317,15 @@ function setPrimaryView(peer_id, streamname){
     setPrimaryViewIcon(primaryView.peerid, primaryView.streamName);
 }
 
-function updateLocalAudioVideoSource(streamindex){
+async function updateLocalAudioVideoSource(streamindex){
     if (connected === true){
         let streamname = "localStream" + streamindex;
         if (streamindex === 1) // Default stream = no name.
             streamname = "";
-        if (streamindex < localStreams.length){
+        if (streamindex <= localStreams.length){
             console.log("Updating audio/video source: " + streamname);
-
+            // Stopping previous stream
+            localStreams[streamindex-1].stream.getTracks().forEach(track => track.stop());
         }else {
             console.log("Creating audio/video source: " + streamname);
         }
@@ -398,7 +452,13 @@ function localVideoStreamSuccess(stream){
 }
 
 function localVideoStreamError(errorCode, errorText){
-    showError("initMediaSource", "Error #" + errorCode + ": " + errorText, true);
+    if (currentConfig.currentVideoSourceIndex + 1 < videoSources.length){
+        console.log("initMediaSource - Unable to open current source " + videoSources[currentConfig.currentVideoSourceIndex].label + " - Trying next one..." );
+        currentConfig.currentVideoSourceIndex += 1;
+        updateLocalAudioVideoSource(1);
+    }else{
+        showError("initMediaSource", "Error #" + errorCode + ": " + errorText, true);
+    }
 }
 
 function forwardData(data)

teraserver/python/README.md

@@ -10,7 +10,7 @@ External microservices can use this package as a base.
 OpenTera is licensed under [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0.txt) . 
 
 # Documentation
-Please visit our [WiKi documentation on GitHub](https://github.com/introlab/opentera/wiki)
+Please visit our [Documentation on GitHub](https://introlab.github.io/opentera/)
 
 # Dependencies
 OpenTera is based or uses the following Open Source technologies :

teraserver/python/TeraServer.py

@@ -95,6 +95,7 @@ def init_opentera_service(config: ConfigManager):
 if __name__ == '__main__':
     parser = argparse.ArgumentParser(description='OpenTera Server')
     parser.add_argument('--enable_tests', help='Test mode for server.', default=False)
+    parser.add_argument('--create_defaults', help='Create default server values (test mode)', default=False)
     args = parser.parse_args()
 
     config_man = ConfigManager()
@@ -147,7 +148,7 @@ def init_opentera_service(config: ConfigManager):
             Globals.db_man.open(config_man.server_config['debug_mode'])
 
             # Create minimal values, if required
-            Globals.db_man.create_defaults(config=config_man, test=False)
+            Globals.db_man.create_defaults(config=config_man, test=args.create_defaults)
 
     except OperationalError as e:
         print("Unable to connect to database - please check settings in config file!", e)
@@ -168,7 +169,7 @@ def init_opentera_service(config: ConfigManager):
         init_opentera_service(config=config_man)
 
         # Main Flask module
-        flask_module = FlaskModule(config_man)
+        flask_module = FlaskModule(config_man, test_mode=args.enable_tests)
 
         # LOGIN MANAGER, must be initialized after Flask
         #################################################

teraserver/python/alembic/versions/e6ee93ef205b_add_device_register_key.py

@@ -0,0 +1,24 @@
+"""Add device register key
+
+Revision ID: e6ee93ef205b
+Revises: f41b70d6513e
+Create Date: 2024-01-23 08:15:07.224075
+
+"""
+from opentera.db.models.TeraServerSettings import TeraServerSettings
+
+
+# revision identifiers, used by Alembic.
+revision = 'e6ee93ef205b'
+down_revision = 'f41b70d6513e'
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    TeraServerSettings.set_server_setting(TeraServerSettings.ServerDeviceRegisterKey,
+                                          TeraServerSettings.generate_token_key(10))
+
+
+def downgrade():
+    pass