Passed
Pull Request — master (#23)
by Jacob
01:26
created

yui/src/recording/js/audiomodule.js   A

Complexity

Total Complexity 17
Complexity/F 1.55

Size

Lines of Code 129
Function Count 11

Duplication

Duplicated Lines 129
Ratio 100 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 0
c 1
b 0
f 0
nc 6
dl 129
loc 129
rs 10
wmc 17
mnd 2
bc 16
fnc 11
bpm 1.4544
cpm 1.5454
noi 0

3 Functions

Rating   Name   Duplication   Size   Complexity  
A M.atto_recordrtc.audiomodule.stopRecording 9 9 1
A M.atto_recordrtc.audiomodule.capture_audio 21 21 1
B M.atto_recordrtc.audiomodule.init 89 89 1

How to fix   Duplicated Code   

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

1
// This file is part of Moodle - http://moodle.org/
2
//
3
// Moodle is free software: you can redistribute it and/or modify
4
// it under the terms of the GNU General Public License as published by
5
// the Free Software Foundation, either version 3 of the License, or
6
// (at your option) any later version.
7
//
8
// Moodle is distributed in the hope that it will be useful,
9
// but WITHOUT ANY WARRANTY; without even the implied warranty of
10
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
// GNU General Public License for more details.
12
//
13
// You should have received a copy of the GNU General Public License
14
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
15
//
16
17
/**
18
 * Atto recordrtc library functions
19
 *
20
 * @package    atto_recordrtc
21
 * @author     Jesus Federico (jesus [at] blindsidenetworks [dt] com)
22
 * @author     Jacob Prud'homme (jacob [dt] prudhomme [at] blindsidenetworks [dt] com)
23
 * @copyright  2017 Blindside Networks Inc.
24
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25
 */
26
27
// JSHint directives.
28
/*jshint es5: true */
29
/*jshint onevar: false */
30
/*jshint shadow: true */
31
/*global M */
32
33
// Scrutinizer CI directives.
34
/** global: M */
35
/** global: Y */
36
37 View Code Duplication
M.atto_recordrtc = M.atto_recordrtc || {};
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated in your project.
Loading history...
38
39
// Shorten access to M.atto_recordrtc.commonmodule namespace.
40
var cm = M.atto_recordrtc.commonmodule;
41
42
M.atto_recordrtc.audiomodule = {
43
    init: function(scope) {
44
        // Assignment of global variables.
45
        cm.editorScope = scope; // Allows access to the editor's "this" context.
46
        cm.alertWarning = Y.one('div#alert-warning');
47
        cm.alertDanger = Y.one('div#alert-danger');
48
        cm.player = Y.one('audio#player');
49
        cm.playerDOM = document.querySelector('audio#player');
50
        cm.startStopBtn = Y.one('button#start-stop');
51
        cm.uploadBtn = Y.one('button#upload');
52
        cm.recType = 'audio';
53
        cm.olderMoodle = scope.get('oldermoodle');
54
        // Extract the numbers from the string, and convert to bytes.
55
        cm.maxUploadSize = window.parseInt(scope.get('maxrecsize').match(/\d+/)[0], 10) * Math.pow(1024, 2);
56
57
        // Show alert and close plugin if WebRTC is not supported.
58
        cm.check_has_gum();
59
        // Show alert and redirect user if connection is not secure.
60
        cm.check_secure();
61
        // Show alert if using non-ideal browser.
62
        cm.check_browser();
63
64
        // Run when user clicks on "record" button.
65
        cm.startStopBtn.on('click', function() {
66
            cm.startStopBtn.set('disabled', true);
67
68
            // If button is displaying "Start Recording" or "Record Again".
69
            if ((cm.startStopBtn.get('textContent') === M.util.get_string('startrecording', 'atto_recordrtc')) ||
70
                (cm.startStopBtn.get('textContent') === M.util.get_string('recordagain', 'atto_recordrtc')) ||
71
                (cm.startStopBtn.get('textContent') === M.util.get_string('recordingfailed', 'atto_recordrtc'))) {
72
                // Make sure the audio player and upload button are not shown.
73
                cm.player.ancestor().ancestor().addClass('hide');
74
                cm.uploadBtn.ancestor().ancestor().addClass('hide');
75
76
                // Change look of recording button.
77
                if (!cm.olderMoodle) {
78
                    cm.startStopBtn.replaceClass('btn-outline-danger', 'btn-danger');
79
                }
80
81
                // Empty the array containing the previously recorded chunks.
82
                cm.chunks = [];
83
                cm.blobSize = 0;
84
85
                // Initialize common configurations.
86
                var commonConfig = {
87
                    // When the stream is captured from the microphone/webcam.
88
                    onMediaCaptured: function(stream) {
89
                        // Make audio stream available at a higher level by making it a property of the common module.
90
                        cm.stream = stream;
91
92
                        cm.start_recording(cm.recType, cm.stream);
93
                    },
94
95
                    // Revert button to "Record Again" when recording is stopped.
96
                    onMediaStopped: function(btnLabel) {
97
                        cm.startStopBtn.set('textContent', btnLabel);
98
                        cm.startStopBtn.set('disabled', false);
99
                        if (!cm.olderMoodle) {
100
                            cm.startStopBtn.replaceClass('btn-danger', 'btn-outline-danger');
101
                        }
102
                    },
103
104
                    // Handle recording errors.
105
                    onMediaCapturingFailed: function(error) {
106
                        cm.handle_gum_errors(error, commonConfig);
107
                    }
108
                };
109
110
                // Capture audio stream from microphone.
111
                M.atto_recordrtc.audiomodule.capture_audio(commonConfig);
112
            } else { // If button is displaying "Stop Recording".
113
                // First of all clears the countdownTicker.
114
                window.clearInterval(cm.countdownTicker);
115
116
                // Disable "Record Again" button for 1s to allow background processing (closing streams).
117
                window.setTimeout(function() {
118
                    cm.startStopBtn.set('disabled', false);
119
                }, 1000);
120
121
                // Stop recording.
122
                M.atto_recordrtc.audiomodule.stopRecording(cm.stream);
123
124
                // Change button to offer to record again.
125
                cm.startStopBtn.set('textContent', M.util.get_string('recordagain', 'atto_recordrtc'));
126
                if (!cm.olderMoodle) {
127
                    cm.startStopBtn.replaceClass('btn-danger', 'btn-outline-danger');
128
                }
129
            }
130
        });
131
    },
132
133
    // Setup to get audio stream from microphone.
134
    capture_audio: function(config) {
135
        cm.capture_user_media(
136
            // Media constraints.
137
            {
138
                audio: true
139
            },
140
141
            // Success callback.
142
            function(audioStream) {
143
                // Set audio player source to microphone stream.
144
                cm.playerDOM.srcObject = audioStream;
145
146
                config.onMediaCaptured(audioStream);
147
            },
148
149
            // Error callback.
150
            function(error) {
151
                config.onMediaCapturingFailed(error);
152
            }
153
        );
154
    },
155
156
    stopRecording: function(stream) {
157
        // Stop recording microphone stream.
158
        cm.mediaRecorder.stop();
159
160
        // Stop each individual MediaTrack.
161
        stream.getTracks().forEach(function(track) {
162
            track.stop();
163
        });
164
    }
165
};
166