-
Notifications
You must be signed in to change notification settings - Fork 5.9k
/
ApiController.groovy
executable file
·1968 lines (1720 loc) · 69.4 KB
/
ApiController.groovy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**
** BigBlueButton open source conferencing system - http://www.bigbluebutton.org/
*
* Copyright (c) 2012 BigBlueButton Inc. and by respective authors (see below).
*
* This program is free software; you can redistribute it and/or modify it under the
* terms of the GNU Lesser General Public License as published by the Free Software
* Foundation; either version 3.0 of the License, or (at your option) any later
* version.
*
* BigBlueButton is distributed in the hope that it will be useful, but WITHOUT ANY
* WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
* PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License along
* with BigBlueButton; if not, see <http://www.gnu.org/licenses/>.
*
*/
package org.bigbluebutton.web.controllers
import com.google.gson.Gson
import grails.web.context.ServletContextHolder
import groovy.json.JsonBuilder
import groovy.xml.MarkupBuilder
import org.apache.commons.codec.binary.Base64
import org.apache.commons.codec.digest.DigestUtils
import org.apache.commons.io.FilenameUtils
import org.apache.commons.lang.RandomStringUtils
import org.apache.commons.lang.StringUtils
import org.bigbluebutton.api.*
import org.bigbluebutton.api.domain.GuestPolicy
import org.bigbluebutton.api.domain.Meeting
import org.bigbluebutton.api.domain.UserSession
import org.bigbluebutton.api.service.ValidationService
import org.bigbluebutton.api.service.ServiceUtils
import org.bigbluebutton.api.util.ParamsUtil
import org.bigbluebutton.api.util.ResponseBuilder
import org.bigbluebutton.presentation.PresentationUrlDownloadService
import org.bigbluebutton.presentation.UploadedPresentation
import org.bigbluebutton.presentation.SupportedFileTypes;
import org.bigbluebutton.web.services.PresentationService
import org.bigbluebutton.web.services.turn.StunTurnService
import org.bigbluebutton.web.services.turn.TurnEntry
import org.bigbluebutton.web.services.turn.StunServer
import org.bigbluebutton.web.services.turn.RemoteIceCandidate
import org.json.JSONArray
import javax.servlet.ServletRequest
class ApiController {
private static final String CONTROLLER_NAME = 'ApiController'
protected static final String RESP_CODE_SUCCESS = 'SUCCESS'
protected static final String RESP_CODE_FAILED = 'FAILED'
private static final String ROLE_MODERATOR = "MODERATOR"
private static final String ROLE_ATTENDEE = "VIEWER"
protected static Boolean REDIRECT_RESPONSE = true
MeetingService meetingService;
PresentationService presentationService
ParamsProcessorUtil paramsProcessorUtil
PresentationUrlDownloadService presDownloadService
StunTurnService stunTurnService
HTML5LoadBalancingService html5LoadBalancingService
ResponseBuilder responseBuilder = initResponseBuilder()
ValidationService validationService
def initResponseBuilder = {
String protocol = this.getClass().getResource("").getProtocol();
if (Objects.equals(protocol, "jar")) {
// Application running inside a JAR file
responseBuilder = new ResponseBuilder(getClass().getClassLoader(), "/WEB-INF/freemarker")
} else if (Objects.equals(protocol, "file")) {
// Application unzipped and running outside a JAR file
String templateLoc = ServletContextHolder.servletContext.getRealPath("/WEB-INF/freemarker")
// We should never have a null `templateLoc`
responseBuilder = new ResponseBuilder(new File(templateLoc))
}
}
/* general methods */
def index = {
log.debug CONTROLLER_NAME + "#index"
response.addHeader("Cache-Control", "no-cache")
withFormat {
xml {
render(text: responseBuilder.buildMeetingVersion(paramsProcessorUtil.getApiVersion(), paramsProcessorUtil.getBbbVersion(), RESP_CODE_SUCCESS), contentType: "text/xml")
}
}
}
/***********************************
* CREATE (API)
***********************************/
def create = {
String API_CALL = 'create'
log.debug CONTROLLER_NAME + "#${API_CALL}"
log.debug request.getParameterMap().toMapString()
log.debug request.getQueryString()
String[] ap = request.getParameterMap().get("attendeePW")
String attendeePW
if(ap == null) log.info("No attendeePW provided")
else attendeePW = ap[0]
String[] mp = request.getParameterMap().get("moderatorPW")
String moderatorPW
if(mp == null) log.info("No moderatorPW provided")
else moderatorPW = mp[0]
log.info("attendeePW [${attendeePW}]")
log.info("moderatorPW [${moderatorPW}]")
if(attendeePW.equals("")) log.info("attendeePW is empty")
if(moderatorPW.equals("")) log.info("moderatorPW is empty")
Map.Entry<String, String> validationResponse = validateRequest(
ValidationService.ApiCall.CREATE,
request.getParameterMap(),
request.getQueryString()
)
if(!(validationResponse == null)) {
invalid(validationResponse.getKey(), validationResponse.getValue())
return
} else if (ParamsUtil.sanitizeString(params.meetingID) != params.meetingID) {
invalid("validationError", "Invalid meeting ID")
return
}
if(params.isBreakout && !params.parentIdMeetingId) {
invalid("parentMeetingIdMissing", "No parent meeting ID was provided for the breakout room")
return
}
// Ensure unique TelVoice. Uniqueness is not guaranteed by paramsProcessorUtil.
if (!params.voiceBridge) {
// Try up to 10 times. We should find a valid telVoice quickly unless
// the server hosts ~100k meetings (default 5-digit telVoice)
for (int i in 1..10) {
String telVoice = paramsProcessorUtil.processTelVoice("");
if (!meetingService.getNotEndedMeetingWithTelVoice(telVoice)) {
params.voiceBridge = telVoice;
break;
}
}
// Still no unique voiceBridge found? Let createMeeting handle it.
}
params.html5InstanceId = html5LoadBalancingService.findSuitableHTML5ProcessByRoundRobin().toString()
Meeting newMeeting = paramsProcessorUtil.processCreateParams(params)
ApiErrors errors = new ApiErrors()
if (meetingService.createMeeting(newMeeting)) {
// See if the request came with pre-uploading of presentation.
uploadDocuments(newMeeting, false); //
respondWithConference(newMeeting, null, null)
} else {
// Translate the external meeting id into an internal meeting id.
String internalMeetingId = paramsProcessorUtil.convertToInternalMeetingId(params.meetingID);
Meeting existing = meetingService.getNotEndedMeetingWithId(internalMeetingId);
if (existing != null) {
log.debug "Existing conference found"
Map<String, Object> updateParams = paramsProcessorUtil.processUpdateCreateParams(params);
if (
(existing.getViewerPassword().equals(params.get("attendeePW")) && existing.getModeratorPassword().equals(params.get("moderatorPW")))
||
(!params.attendeePW && !params.moderatorPW)
) {
//paramsProcessorUtil.updateMeeting(updateParams, existing);
// trying to create a conference a second time, return success, but give extra info
// Ignore pre-uploaded presentations. We only allow uploading of presentation once.
//uploadDocuments(existing);
respondWithConference(existing, "duplicateWarning", "This conference was already in existence and may currently be in progress.");
} else {
// BEGIN - backward compatibility
invalid("idNotUnique", "A meeting already exists with that meeting ID. Please use a different meeting ID.");
return
// END - backward compatibility
// enforce meetingID unique-ness
errors.nonUniqueMeetingIdError()
respondWithErrors(errors)
}
return
} else {
Meeting existingTelVoice = meetingService.getNotEndedMeetingWithTelVoice(newMeeting.getTelVoice());
Meeting existingWebVoice = meetingService.getNotEndedMeetingWithWebVoice(newMeeting.getWebVoice());
if (existingTelVoice != null || existingWebVoice != null) {
log.error "VoiceBridge already in use by another meeting (different meetingId)"
errors.nonUniqueVoiceBridgeError()
respondWithErrors(errors)
}
}
}
}
/**********************************************
* JOIN API
*********************************************/
def join = {
String API_CALL = 'join'
log.debug CONTROLLER_NAME + "#${API_CALL}"
log.debug request.getParameterMap().toMapString()
log.debug request.getQueryString()
Map.Entry<String, String> validationResponse = validateRequest(
ValidationService.ApiCall.JOIN,
request.getParameterMap(),
request.getQueryString()
)
HashMap<String, String> roles = new HashMap<String, String>();
roles.put("moderator", ROLE_MODERATOR)
roles.put("viewer", ROLE_ATTENDEE)
//check if exists the param redirect
boolean redirectClient = REDIRECT_RESPONSE
String clientURL = paramsProcessorUtil.getDefaultHTML5ClientUrl();
if (!StringUtils.isEmpty(params.redirect)) {
try {
redirectClient = Boolean.parseBoolean(params.redirect);
} catch (Exception ignored) {}
}
if(!(validationResponse == null)) {
invalid(validationResponse.getKey(), validationResponse.getValue(), redirectClient)
return
}
Boolean authenticated = false;
Boolean guest = false;
if (!StringUtils.isEmpty(params.guest)) {
guest = Boolean.parseBoolean(params.guest)
} else {
// guest param has not been passed. Make user as
// authenticated by default. (ralam july 3, 2018)
authenticated = true
}
if (!StringUtils.isEmpty(params.auth)) {
authenticated = Boolean.parseBoolean(params.auth)
}
String fullName = ParamsUtil.stripControlChars(params.fullName)
String attPW = params.password
Meeting meeting = ServiceUtils.findMeetingFromMeetingID(params.meetingID);
String errorRedirectUrl = ""
if(!StringUtils.isEmpty(params.errorRedirectUrl)) {
errorRedirectUrl = params.errorRedirectUrl
}
// the createTime mismatch with meeting's createTime, complain
// In the future, the createTime param will be required
if (params.createTime != null) {
long createTime = 0;
try {
createTime = Long.parseLong(params.createTime);
} catch (Exception e) {
log.warn("could not parse createTime param");
createTime = -1;
}
if (createTime != meeting.getCreateTime()) {
// BEGIN - backward compatibility
invalid("mismatchCreateTimeParam", "The createTime parameter submitted mismatches with the current meeting.", redirectClient, errorRedirectUrl);
return
// END - backward compatibility
errors.mismatchCreateTimeParam();
respondWithErrors(errors, REDIRECT_RESPONSE);
return
}
}
// Now determine if this user is a moderator or a viewer.
String role = null;
// First Case: send a valid role
if (!StringUtils.isEmpty(params.role) && roles.containsKey(params.role.toLowerCase())) {
role = roles.get(params.role.toLowerCase());
// Second case: role is not present or valid BUT there is password
} else if (attPW != null && !attPW.isEmpty()){
// Check if the meeting has passwords
if ((meeting.getModeratorPassword() != null && !meeting.getModeratorPassword().isEmpty())
&& (meeting.getViewerPassword() != null && !meeting.getViewerPassword().isEmpty())){
// Check which role does the user belong
if (meeting.getModeratorPassword().equals(attPW)) {
role = Meeting.ROLE_MODERATOR
} else if (meeting.getViewerPassword().equals(attPW)) {
role = Meeting.ROLE_ATTENDEE
} else {
log.debug("Password does not match any of the registered ones");
response.addHeader("Cache-Control", "no-cache")
withFormat {
xml {
render(text: responseBuilder.buildError("Params required", "You must enter a valid password",
RESP_CODE_FAILED), contentType: "text/xml")
}
}
return
}
// In this case, the meeting doesn't have any password registered and there is no role param
} else {
log.debug("This meeting doesn't have any password");
response.addHeader("Cache-Control", "no-cache")
withFormat {
xml {
render(text: responseBuilder.buildError("Params required", "You must send the 'role' parameter, since " +
"this meeting doesn't have any password.", RESP_CODE_FAILED), contentType: "text/xml")
}
}
return
}
// Third case: No valid role + no valid password
} else {
log.debug("No matching params encountered");
response.addHeader("Cache-Control", "no-cache")
withFormat {
xml {
render(text: responseBuilder.buildError("Params required", "You must either send the valid role of the user, or " +
"the password, sould the meeting has one.", RESP_CODE_FAILED), contentType: "text/xml")
}
}
return
}
// We preprend "w_" to our internal meeting Id to indicate that this is a web user.
// For users joining using the phone, we will prepend "v_" so it will be easier
// to distinguish users who doesn't have a web client. (ralam june 12, 2017)
String internalUserID = "w_" + RandomStringUtils.randomAlphanumeric(12).toLowerCase()
String authToken = RandomStringUtils.randomAlphanumeric(12).toLowerCase()
log.debug "Auth token: " + authToken
String sessionToken = RandomStringUtils.randomAlphanumeric(16).toLowerCase()
log.debug "Session token: " + sessionToken
String externUserID = params.userID
if (StringUtils.isEmpty(externUserID)) {
externUserID = internalUserID
}
//Return a Map with the user custom data
Map<String, String> userCustomData = meetingService.getUserCustomData(meeting, externUserID, params);
//Currently, it's associated with the externalUserID
if (userCustomData.size() > 0)
meetingService.addUserCustomData(meeting.getInternalId(), externUserID, userCustomData);
String guestStatusVal = meeting.calcGuestStatus(role, guest, authenticated)
UserSession us = new UserSession();
us.authToken = authToken;
us.internalUserId = internalUserID
us.conferencename = meeting.getName()
us.meetingID = meeting.getInternalId()
us.externMeetingID = meeting.getExternalId()
us.externUserID = externUserID
us.fullname = fullName
us.role = role
us.conference = meeting.getInternalId()
us.room = meeting.getInternalId()
us.voicebridge = meeting.getTelVoice()
us.webvoiceconf = meeting.getWebVoice()
us.mode = "LIVE"
us.record = meeting.isRecord()
us.welcome = meeting.getWelcomeMessage()
us.guest = guest
us.authed = authenticated
us.guestStatus = guestStatusVal
us.logoutUrl = meeting.getLogoutUrl()
us.defaultLayout = meeting.getMeetingLayout()
us.leftGuestLobby = false
if (!StringUtils.isEmpty(params.defaultLayout)) {
us.defaultLayout = params.defaultLayout;
}
if (!StringUtils.isEmpty(params.avatarURL)) {
us.avatarURL = params.avatarURL;
} else {
us.avatarURL = meeting.defaultAvatarURL
}
if (!StringUtils.isEmpty(params.excludeFromDashboard)) {
try {
us.excludeFromDashboard = Boolean.parseBoolean(params.excludeFromDashboard)
} catch (Exception e) {
// Do nothing, prop excludeFromDashboard was already initialized
}
}
String meetingId = meeting.getInternalId()
if (hasReachedMaxParticipants(meeting, us)) {
// BEGIN - backward compatibility
invalid("maxParticipantsReached", "The number of participants allowed for this meeting has been reached.", redirectClient, errorRedirectUrl)
return
// END - backward compatibility
errors.maxParticipantsReached();
respondWithErrors(errors, REDIRECT_RESPONSE);
return;
}
// Register user into the meeting.
meetingService.registerUser(
us.meetingID,
us.internalUserId,
us.fullname,
us.role,
us.externUserID,
us.authToken,
us.avatarURL,
us.guest,
us.authed,
guestStatusVal,
us.excludeFromDashboard,
us.leftGuestLobby
)
session.setMaxInactiveInterval(paramsProcessorUtil.getDefaultHttpSessionTimeout())
String msgKey = "successfullyJoined"
String msgValue = "You have joined successfully."
// Keep track of the client url in case this needs to wait for
// approval as guest. We need to be able to send the user to the
// client after being approved by moderator.
us.clientUrl = clientURL + "?sessionToken=" + sessionToken
session[sessionToken] = sessionToken
meetingService.addUserSession(sessionToken, us)
//Identify which of these to logs should be used. sessionToken or user-token
log.info("Session sessionToken for " + us.fullname + " [" + session[sessionToken] + "]")
log.info("Session user-token for " + us.fullname + " [" + session['user-token'] + "]")
log.info("Session token: ${sessionToken}")
// Process if we send the user directly to the client or
// have it wait for approval.
String destUrl = clientURL + "?sessionToken=" + sessionToken
if (guestStatusVal.equals(GuestPolicy.WAIT)) {
String guestWaitUrl = paramsProcessorUtil.getDefaultGuestWaitURL();
destUrl = guestWaitUrl + "?sessionToken=" + sessionToken
// Check if the user has her/his default locale overridden by an userdata
String customLocale = userCustomData.get("bbb_override_default_locale")
if (customLocale != null) {
destUrl += "&locale=" + customLocale
}
msgKey = "guestWait"
msgValue = "Guest waiting for approval to join meeting."
} else if (guestStatusVal.equals(GuestPolicy.DENY)) {
invalid("guestDeniedAccess", "You have been denied access to this meeting based on the meeting's guest policy", redirectClient, errorRedirectUrl)
return
}
Map<String, Object> logData = new HashMap<String, Object>();
logData.put("meetingid", us.meetingID);
logData.put("extMeetingid", us.externMeetingID);
logData.put("name", us.fullname);
logData.put("userid", us.internalUserId);
logData.put("sessionToken", sessionToken);
logData.put("logCode", "join_api");
logData.put("description", "Handle JOIN API.");
Gson gson = new Gson();
String logStr = gson.toJson(logData);
log.info(" --analytics-- data=" + logStr);
if (redirectClient) {
log.info("Redirecting to ${destUrl}");
redirect(url: destUrl);
} else {
log.info("Successfully joined. Sending XML response.");
response.addHeader("Cache-Control", "no-cache")
withFormat {
xml {
render(text: responseBuilder.buildJoinMeeting(us, session[sessionToken], guestStatusVal, destUrl, msgKey, msgValue, RESP_CODE_SUCCESS), contentType: "text/xml")
}
}
}
}
/*******************************************
* IS_MEETING_RUNNING API
*******************************************/
def isMeetingRunning = {
String API_CALL = 'isMeetingRunning'
log.debug CONTROLLER_NAME + "#${API_CALL}"
log.debug request.getParameterMap().toMapString()
log.debug request.getQueryString()
Map.Entry<String, String> validationResponse = validateRequest(
ValidationService.ApiCall.MEETING_RUNNING,
request.getParameterMap(),
request.getQueryString()
)
if(!(validationResponse == null)) {
invalid(validationResponse.getKey(), validationResponse.getValue())
return
}
Meeting meeting = ServiceUtils.findMeetingFromMeetingID(params.meetingID);
boolean isRunning = meeting != null && meeting.isRunning();
response.addHeader("Cache-Control", "no-cache")
withFormat {
xml {
render(contentType: "text/xml") {
render(text: responseBuilder.buildIsMeetingRunning(isRunning, RESP_CODE_SUCCESS), contentType: "text/xml")
}
}
}
}
/************************************
* END API
************************************/
def end = {
String API_CALL = "end"
log.debug CONTROLLER_NAME + "#${API_CALL}"
Map.Entry<String, String> validationResponse = validateRequest(
ValidationService.ApiCall.END,
request.getParameterMap(),
request.getQueryString()
)
if(!(validationResponse == null)) {
invalid(validationResponse.getKey(), validationResponse.getValue())
return
}
Meeting meeting = ServiceUtils.findMeetingFromMeetingID(params.meetingID);
Map<String, Object> logData = new HashMap<String, Object>();
logData.put("meetingid", meeting.getInternalId());
logData.put("extMeetingid", meeting.getExternalId());
logData.put("name", meeting.getName());
logData.put("logCode", "end_api");
logData.put("description", "Handle END API.");
Gson gson = new Gson();
String logStr = gson.toJson(logData);
log.info(" --analytics-- data=" + logStr);
meetingService.endMeeting(meeting.getInternalId());
response.addHeader("Cache-Control", "no-cache")
withFormat {
xml {
render(contentType: "text/xml") {
render(text: responseBuilder.buildEndRunning("sentEndMeetingRequest", "A request to end the meeting was sent. Please wait a few seconds, and then use the getMeetingInfo or isMeetingRunning API calls to verify that it was ended.", RESP_CODE_SUCCESS), contentType: "text/xml")
}
}
}
}
/*****************************************
* GETMEETINGINFO API
*****************************************/
def getMeetingInfo = {
String API_CALL = "getMeetingInfo"
log.debug CONTROLLER_NAME + "#${API_CALL}"
Map.Entry<String, String> validationResponse = validateRequest(
ValidationService.ApiCall.GET_MEETING_INFO,
request.getParameterMap(),
request.getQueryString()
)
if(!(validationResponse == null)) {
invalid(validationResponse.getKey(), validationResponse.getValue())
return
}
Meeting meeting = ServiceUtils.findMeetingFromMeetingID(params.meetingID);
withFormat {
xml {
render(text: responseBuilder.buildGetMeetingInfoResponse(meeting, RESP_CODE_SUCCESS), contentType: "text/xml")
}
}
}
/************************************
* GETMEETINGS API
************************************/
def getMeetingsHandler = {
String API_CALL = "getMeetings"
log.debug CONTROLLER_NAME + "#${API_CALL}"
Map.Entry<String, String> validationResponse = validateRequest(
ValidationService.ApiCall.GET_MEETINGS,
request.getParameterMap(),
request.getQueryString()
)
if(!(validationResponse == null)) {
invalid(validationResponse.getKey(), validationResponse.getValue())
return
}
Collection<Meeting> mtgs = meetingService.getMeetings();
if (mtgs == null || mtgs.isEmpty()) {
response.addHeader("Cache-Control", "no-cache")
withFormat {
xml {
render(text: responseBuilder.buildGetMeetingsResponse(mtgs, "noMeetings", "no meetings were found on this server", RESP_CODE_SUCCESS), contentType: "text/xml")
}
}
} else {
response.addHeader("Cache-Control", "no-cache")
withFormat {
xml {
render(text: responseBuilder.buildGetMeetingsResponse(mtgs, null, null, RESP_CODE_SUCCESS), contentType: "text/xml")
}
}
}
}
/************************************
* GETSESSIONS API
************************************/
def getSessionsHandler = {
String API_CALL = "getSessions"
log.debug CONTROLLER_NAME + "#${API_CALL}"
Map.Entry<String, String> validationResponse = validateRequest(
ValidationService.ApiCall.GET_SESSIONS,
request.getParameterMap(),
request.getQueryString()
)
if(!(validationResponse == null)) {
invalid(validationResponse.getKey(), validationResponse.getValue())
return
}
Collection<UserSession> sssns = meetingService.getSessions()
if (sssns == null || sssns.isEmpty()) {
response.addHeader("Cache-Control", "no-cache")
withFormat {
xml {
render(text: responseBuilder.buildGetSessionsResponse(sssns, "noSessions", "no sessions were found on this serverr", RESP_CODE_SUCCESS), contentType: "text/xml")
}
}
} else {
response.addHeader("Cache-Control", "no-cache")
withFormat {
xml {
render(contentType: "text/xml") {
render(text: responseBuilder.buildGetSessionsResponse(sssns, null, null, RESP_CODE_SUCCESS), contentType: "text/xml")
}
}
}
}
}
private static Map<String, String[]> getParameters(ServletRequest request) {
// Copy the parameters into our own Map as we can't pass the paramMap
// from the request as it's an unmodifiable map.
Map<String, String[]> reqParams = new HashMap<String, String[]>();
Map<String, String[]> unModReqParams = request.getParameterMap();
SortedSet<String> keys = new TreeSet<String>(unModReqParams.keySet());
for(String key : keys) {
reqParams.put(key, unModReqParams.get(key));
}
return reqParams;
}
/**********************************************
* GUEST WAIT API
*********************************************/
def guestWaitHandler = {
String API_CALL = 'guestWait'
log.debug CONTROLLER_NAME + "#${API_CALL}"
String msgKey = "defaultKey"
String msgValue = "defaultValue"
String destURL = paramsProcessorUtil.getDefaultLogoutUrl()
Map.Entry<String, String> validationResponse = validateRequest(
ValidationService.ApiCall.GUEST_WAIT,
request.getParameterMap(),
request.getQueryString()
)
if(!(validationResponse == null)) {
msgKey = validationResponse.getKey()
msgValue = validationResponse.getValue()
respondWithJSONError(msgKey, msgValue, destURL)
return
}
String sessionToken = sanitizeSessionToken(params.sessionToken)
UserSession us = getUserSession(sessionToken)
Meeting meeting = meetingService.getMeeting(us.meetingID)
String status = us.guestStatus
destURL = us.clientUrl
String posInWaitingQueue = meeting.getWaitingPositionsInWaitingQueue(us.internalUserId)
String lobbyMsg = meeting.getGuestLobbyMessage(us.internalUserId)
Boolean redirectClient = true
if (!StringUtils.isEmpty(params.redirect)) {
try {
redirectClient = Boolean.parseBoolean(params.redirect)
} catch (Exception e) {
redirectClient = true
}
}
String guestURL = paramsProcessorUtil.getDefaultGuestWaitURL() + "?sessionToken=" + sessionToken
switch (status) {
case GuestPolicy.WAIT:
meetingService.guestIsWaiting(us.meetingID, us.internalUserId)
destURL = guestURL
msgKey = "guestWait"
msgValue = "Please wait for a moderator to approve you joining the meeting."
// We force the response to not do a redirect. Otherwise,
// the client would just be redirecting into this endpoint.
redirectClient = false
break
case GuestPolicy.DENY:
destURL = meeting.getLogoutUrl()
msgKey = "guestDeny"
msgValue = "Guest denied of joining the meeting."
redirectClient = false
break
case GuestPolicy.ALLOW:
// IF the user was allowed to join but there is no room available in
// the meeting we must hold his approval
if (hasReachedMaxParticipants(meeting, us)) {
meetingService.guestIsWaiting(us.meetingID, us.internalUserId)
destURL = guestURL
msgKey = "seatWait"
msgValue = "Guest waiting for a seat in the meeting."
redirectClient = false
status = GuestPolicy.WAIT
}
break
default:
break
}
if(meeting.didGuestUserLeaveGuestLobby(us.internalUserId)){
destURL = meeting.getLogoutUrl()
msgKey = "guestInvalid"
msgValue = "Invalid user"
status = GuestPolicy.DENY
redirectClient = false
}
if (redirectClient) {
// User may join the meeting
redirect(url: destURL)
} else {
response.addHeader("Cache-Control", "no-cache")
withFormat {
json {
def builder = new JsonBuilder()
builder.response {
returncode RESP_CODE_SUCCESS
messageKey msgKey
message msgValue
meeting_id us.meetingID
user_id us.internalUserId
auth_token us.authToken
session_token session[sessionToken]
guestStatus status
lobbyMessage lobbyMsg
url destURL
positionInWaitingQueue posInWaitingQueue
}
render(contentType: "application/json", text: builder.toPrettyString())
}
}
}
}
/***********************************************
* ENTER API
***********************************************/
def enter = {
String API_CALL = 'enter'
log.debug CONTROLLER_NAME + "#${API_CALL}"
String respMessage = "Session not found."
String respMessageKey = "missingSession"
boolean reject = false;
String sessionToken
UserSession us
Meeting meeting
Map.Entry<String, String> validationResponse = validateRequest(
ValidationService.ApiCall.ENTER,
request.getParameterMap(),
request.getQueryString(),
)
if(!(validationResponse == null)) {
respMessage = validationResponse.getValue()
respMessageKey = validationResponse.getKey()
reject = true
} else {
sessionToken = sanitizeSessionToken(params.sessionToken)
us = getUserSession(sessionToken)
meeting = meetingService.getMeeting(us.meetingID)
if (!hasValidSession(sessionToken)) {
reject = true;
} else {
if(hasReachedMaxParticipants(meeting, us)) {
reject = true
respMessage = "The maximum number of participants allowed for this meeting has been reached."
respMessageKey = "maxParticipantsReached"
} else {
log.info("User ${us.internalUserId} has entered")
meeting.userEntered(us.internalUserId)
}
}
}
if (reject) {
// Determine the logout url so we can send the user there.
String logoutUrl = paramsProcessorUtil.getDefaultLogoutUrl()
if(us != null) {
logoutUrl = us.logoutUrl
}
log.info("Session token: ${sessionToken}")
response.addHeader("Cache-Control", "no-cache")
withFormat {
json {
def builder = new JsonBuilder()
builder.response {
returncode RESP_CODE_FAILED
message respMessage
messageKey respMessageKey
sessionToken
logoutURL logoutUrl
}
render(contentType: "application/json", text: builder.toPrettyString())
}
}
} else {
Map<String, String> userCustomData = paramsProcessorUtil.getUserCustomData(params);
// Generate a new userId for this user. This prevents old connections from
// removing the user when the user reconnects after being disconnected. (ralam jan 22, 2015)
// We use underscore (_) to associate userid with the user. We are also able to track
// how many times a user reconnects or refresh the browser.
String newInternalUserID = us.internalUserId //+ "_" + us.incrementConnectionNum()
Map<String, Object> logData = new HashMap<String, Object>();
logData.put("meetingid", us.meetingID);
logData.put("extMeetingid", us.externMeetingID);
logData.put("name", us.fullname);
logData.put("userid", newInternalUserID);
logData.put("sessionToken", sessionToken);
logData.put("logCode", "handle_enter_api");
logData.put("description", "Handling ENTER API.");
Gson gson = new Gson();
String logStr = gson.toJson(logData);
log.info(" --analytics-- data=" + logStr);
response.addHeader("Cache-Control", "no-cache")
withFormat {
json {
def builder = new JsonBuilder()
builder.response {
returncode RESP_CODE_SUCCESS
fullname us.fullname
confname us.conferencename
meetingID us.meetingID
externMeetingID us.externMeetingID
externUserID us.externUserID
internalUserID newInternalUserID
authToken us.authToken
role us.role
guest us.guest
guestStatus us.guestStatus
conference us.conference
room us.room
voicebridge us.voicebridge
dialnumber meeting.getDialNumber()
webvoiceconf us.webvoiceconf
mode us.mode
record us.record
isBreakout meeting.isBreakout()
logoutTimer meeting.getLogoutTimer()
allowStartStopRecording meeting.getAllowStartStopRecording()
recordFullDurationMedia meeting.getRecordFullDurationMedia()
welcome us.welcome
if (!StringUtils.isEmpty(meeting.moderatorOnlyMessage) && us.role.equals(ROLE_MODERATOR)) {
modOnlyMessage meeting.moderatorOnlyMessage
}
if (!StringUtils.isEmpty(meeting.bannerText)) {
bannerText meeting.getBannerText()
bannerColor meeting.getBannerColor()
}
customLogoURL meeting.getCustomLogoURL()
customCopyright meeting.getCustomCopyright()
muteOnStart meeting.getMuteOnStart()
allowModsToUnmuteUsers meeting.getAllowModsToUnmuteUsers()
logoutUrl us.logoutUrl
defaultLayout us.defaultLayout
avatarURL us.avatarURL
if (meeting.breakoutRoomsParams != null) {
breakoutRooms {
record meeting.breakoutRoomsParams.record
privateChatEnabled meeting.breakoutRoomsParams.privateChatEnabled
captureNotes meeting.breakoutRoomsParams.captureNotes
captureSlides meeting.breakoutRoomsParams.captureSlides
captureNotesFilename meeting.breakoutRoomsParams.captureNotesFilename
captureSlidesFilename meeting.breakoutRoomsParams.captureSlidesFilename
}
}
customdata (
meeting.getUserCustomData(us.externUserID).collect { k, v ->
["$k": v]
}
)
metadata (
meeting.getMetadata().collect { k, v ->
["$k": v]
}
)
}
render(contentType: "application/json", text: builder.toPrettyString())
}
}
}
}
/***********************************************
* STUN/TURN API
***********************************************/
def stuns = {
String API_CALL = 'stuns'
log.debug CONTROLLER_NAME + "#${API_CALL}"
boolean reject = false;
String sessionToken
UserSession us
Meeting meeting
Map.Entry<String, String> validationResponse = validateRequest(
ValidationService.ApiCall.STUNS,
request.getParameterMap(),
request.getQueryString(),
)
if(!(validationResponse == null)) {
reject = true
} else {
sessionToken = sanitizeSessionToken(params.sessionToken)
us = getUserSession(sessionToken)
meeting = meetingService.getMeeting(us.meetingID)
if (!hasValidSession(sessionToken)) {
reject = true;
}
}
if (reject) {
String logoutUrl = paramsProcessorUtil.getDefaultLogoutUrl()