-
Notifications
You must be signed in to change notification settings - Fork 242
/
Copy pathDocsCoServer.js
3185 lines (3026 loc) · 130 KB
/
DocsCoServer.js
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
/*
* (c) Copyright Ascensio System SIA 2010-2019
*
* This program is a free software product. You can redistribute it and/or
* modify it under the terms of the GNU Affero General Public License (AGPL)
* version 3 as published by the Free Software Foundation. In accordance with
* Section 7(a) of the GNU AGPL its Section 15 shall be amended to the effect
* that Ascensio System SIA expressly excludes the warranty of non-infringement
* of any third-party rights.
*
* This program is distributed WITHOUT ANY WARRANTY; without even the implied
* warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. For
* details, see the GNU AGPL at: http://www.gnu.org/licenses/agpl-3.0.html
*
* You can contact Ascensio System SIA at 20A-12 Ernesta Birznieka-Upisha
* street, Riga, Latvia, EU, LV-1050.
*
* The interactive user interfaces in modified source and object code versions
* of the Program must display Appropriate Legal Notices, as required under
* Section 5 of the GNU AGPL version 3.
*
* Pursuant to Section 7(b) of the License you must retain the original Product
* logo when distributing the program. Pursuant to Section 7(e) we decline to
* grant you any rights under trademark law for use of our trademarks.
*
* All the Product's GUI elements, including illustrations and icon sets, as
* well as technical writing content are licensed under the terms of the
* Creative Commons Attribution-ShareAlike 4.0 International. See the License
* terms at http://creativecommons.org/licenses/by-sa/4.0/legalcode
*
*/
/*
----------------------------------------------------view-режим---------------------------------------------------------
* 1) Для view-режима обновляем страницу (без быстрого перехода), чтобы пользователь не считался за редактируемого и не
* держал документ для сборки (если не ждать, то непонятен быстрый переход из view в edit, когда документ уже собрался)
* 2) Если пользователь во view-режиме, то он не участвует в редактировании (только в chat-е). При открытии он получает
* все актуальные изменения в документе на момент открытия. Для view-режима не принимаем изменения и не отправляем их
* view-пользователям (т.к. непонятно что делать в ситуации, когда 1-пользователь наделал изменений,
* сохранил и сделал undo).
*-----------------------------------------------------------------------------------------------------------------------
*------------------------------------------------Схема сохранения-------------------------------------------------------
* а) Один пользователь - первый раз приходят изменения без индекса, затем изменения приходят с индексом, можно делать
* undo-redo (история не трется). Если автосохранение включено, то оно на любое действие (не чаще 5-ти секунд).
* b) Как только заходит второй пользователь, начинается совместное редактирование. На документ ставится lock, чтобы
* первый пользователь успел сохранить документ (либо прислать unlock)
* c) Когда пользователей 2 или больше, каждое сохранение трет историю и присылается целиком (без индекса). Если
* автосохранение включено, то сохраняется не чаще раз в 10-минут.
* d) Когда пользователь остается один, после принятия чужих изменений начинается пункт 'а'
*-----------------------------------------------------------------------------------------------------------------------
*--------------------------------------------Схема работы с сервером----------------------------------------------------
* а) Когда все уходят, спустя время cfgAscSaveTimeOutDelay на сервер документов шлется команда на сборку.
* b) Если приходит статус '1' на CommandService.ashx, то удалось сохранить и поднять версию. Очищаем callback-и и
* изменения из базы и из памяти.
* с) Если приходит статус, отличный от '1'(сюда можно отнести как генерацию файла, так и работа внешнего подписчика
* с готовым результатом), то трем callback-и, а изменения оставляем. Т.к. можно будет зайти в старую
* версию и получить несобранные изменения. Также сбрасываем статус у файла на несобранный, чтобы его можно было
* открывать без сообщения об ошибке версии.
*-----------------------------------------------------------------------------------------------------------------------
*------------------------------------------------Старт сервера----------------------------------------------------------
* 1) Загружаем информацию о сборщике
* 2) Загружаем информацию о callback-ах
* 3) Собираем только те файлы, у которых есть callback и информация для сборки
*-----------------------------------------------------------------------------------------------------------------------
*------------------------------------------Переподключение при разрыве соединения---------------------------------------
* 1) Проверяем файл на сборку. Если она началась, то останавливаем.
* 2) Если сборка уже завершилась, то отправляем пользователю уведомление о невозможности редактировать дальше
* 3) Далее проверяем время последнего сохранения и lock-и пользователя. Если кто-то уже успел сохранить или
* заблокировать объекты, то мы не можем дальше редактировать.
*-----------------------------------------------------------------------------------------------------------------------
* */
'use strict';
const sockjs = require('sockjs');
const _ = require('underscore');
const url = require('url');
const os = require('os');
const cluster = require('cluster');
const cron = require('cron');
const co = require('co');
const jwt = require('jsonwebtoken');
const jwa = require('jwa');
const ms = require('ms');
const deepEqual = require('deep-equal');
const bytes = require('bytes');
const storage = require('./../../Common/sources/storage-base');
const logger = require('./../../Common/sources/logger');
const constants = require('./../../Common/sources/constants');
const utils = require('./../../Common/sources/utils');
const commonDefines = require('./../../Common/sources/commondefines');
const statsDClient = require('./../../Common/sources/statsdclient');
const configCommon = require('config');
const config = configCommon.get('services.CoAuthoring');
const sqlBase = require('./baseConnector');
const canvasService = require('./canvasservice');
const converterService = require('./converterservice');
const taskResult = require('./taskresult');
const gc = require('./gc');
const shutdown = require('./shutdown');
const pubsubService = require('./pubsubRabbitMQ');
const queueService = require('./../../Common/sources/taskqueueRabbitMQ');
const rabbitMQCore = require('./../../Common/sources/rabbitMQCore');
const activeMQCore = require('./../../Common/sources/activeMQCore');
const editorDataStorage = require('./' + configCommon.get('services.CoAuthoring.server.editorDataStorage'));
let cfgEditor = JSON.parse(JSON.stringify(config.get('editor')));
cfgEditor['reconnection']['delay'] = ms(cfgEditor['reconnection']['delay']);
cfgEditor['websocketMaxPayloadSize'] = bytes.parse(cfgEditor['websocketMaxPayloadSize']);
//websocket payload size is limited by https://github.com/faye/faye-websocket-node#initialization-options (64 MiB)
//xhr payload size is limited by nginx param client_max_body_size (current 100MB)
//"1.5MB" is choosen to avoid disconnect(after 25s) while downloading/uploading oversized changes with 0.5Mbps connection
const cfgWebsocketMaxPayloadSize = cfgEditor['websocketMaxPayloadSize'];
const cfgCallbackRequestTimeout = config.get('server.callbackRequestTimeout');
//The waiting time to document assembly when all out(not 0 in case of F5 in the browser)
const cfgAscSaveTimeOutDelay = config.get('server.savetimeoutdelay');
const cfgPubSubMaxChanges = config.get('pubsub.maxChanges');
const cfgExpSaveLock = config.get('expire.saveLock');
const cfgExpLockDoc = config.get('expire.lockDoc');
const cfgExpDocumentsCron = config.get('expire.documentsCron');
const cfgExpSessionIdle = ms(config.get('expire.sessionidle'));
const cfgExpSessionAbsolute = ms(config.get('expire.sessionabsolute'));
const cfgExpSessionCloseCommand = ms(config.get('expire.sessionclosecommand'));
const cfgExpUpdateVersionStatus = ms(config.get('expire.updateVersionStatus'));
const cfgSockjs = config.get('sockjs');
const cfgTokenEnableBrowser = config.get('token.enable.browser');
const cfgTokenEnableRequestInbox = config.get('token.enable.request.inbox');
const cfgTokenEnableRequestOutbox = config.get('token.enable.request.outbox');
const cfgTokenSessionAlgorithm = config.get('token.session.algorithm');
const cfgTokenSessionExpires = ms(config.get('token.session.expires'));
const cfgTokenInboxHeader = config.get('token.inbox.header');
const cfgTokenInboxPrefix = config.get('token.inbox.prefix');
const cfgTokenInboxInBody = config.get('token.inbox.inBody');
const cfgTokenOutboxInBody = config.get('token.outbox.inBody');
const cfgTokenBrowserSecretFromInbox = config.get('token.browser.secretFromInbox');
const cfgSecretBrowser = config.get('secret.browser');
const cfgSecretInbox = config.get('secret.inbox');
const cfgSecretSession = config.get('secret.session');
const cfgForceSaveEnable = config.get('autoAssembly.enable');
const cfgForceSaveInterval = ms(config.get('autoAssembly.interval'));
const cfgForceSaveStep = ms(config.get('autoAssembly.step'));
const cfgQueueType = configCommon.get('queue.type');
const cfgQueueRetentionPeriod = configCommon.get('queue.retentionPeriod');
const cfgForgottenFiles = config.get('server.forgottenfiles');
const cfgMaxRequestChanges = config.get('server.maxRequestChanges');
const cfgWarningLimitPercents = configCommon.get('license.warning_limit_percents') / 100;
const cfgErrorFiles = configCommon.get('FileConverter.converter.errorfiles');
const EditorTypes = {
document : 0,
spreadsheet : 1,
presentation : 2
};
const defaultHttpPort = 80, defaultHttpsPort = 443; // Порты по умолчанию (для http и https)
const editorData = new editorDataStorage();
const clientStatsD = statsDClient.getClient();
let connections = []; // Активные соединения
let lockDocumentsTimerId = {};//to drop connection that can't unlockDocument
let pubsub;
let queue;
let licenseInfo = {type: constants.LICENSE_RESULT.Error, light: false, branding: false, customization: false, plugins: false};
let shutdownFlag = false;
const MIN_SAVE_EXPIRATION = 60000;
const FORCE_SAVE_EXPIRATION = Math.min(Math.max(cfgForceSaveInterval, MIN_SAVE_EXPIRATION),
cfgQueueRetentionPeriod * 1000);
const HEALTH_CHECK_KEY_MAX = 10000;
const PRECISION = [{name: 'hour', val: ms('1h')}, {name: 'day', val: ms('1d')}, {name: 'week', val: ms('7d')},
{name: 'month', val: ms('31d')},
];
function getIsShutdown() {
return shutdownFlag;
}
function DocumentChanges(docId) {
this.docId = docId;
this.arrChanges = [];
return this;
}
DocumentChanges.prototype.getLength = function() {
return this.arrChanges.length;
};
DocumentChanges.prototype.push = function(change) {
this.arrChanges.push(change);
};
DocumentChanges.prototype.splice = function(start, deleteCount) {
this.arrChanges.splice(start, deleteCount);
};
DocumentChanges.prototype.slice = function(start, end) {
return this.arrChanges.splice(start, end);
};
DocumentChanges.prototype.concat = function(item) {
this.arrChanges = this.arrChanges.concat(item);
};
const c_oAscServerStatus = {
NotFound: 0,
Editing: 1,
MustSave: 2,
Corrupted: 3,
Closed: 4,
MailMerge: 5,
MustSaveForce: 6,
CorruptedForce: 7
};
const c_oAscChangeBase = {
No: 0,
Delete: 1,
All: 2
};
const c_oAscLockTimeOutDelay = 500; // Время ожидания для сохранения, когда зажата база данных
const c_oAscRecalcIndexTypes = {
RecalcIndexAdd: 1,
RecalcIndexRemove: 2
};
/**
* lock types
* @const
*/
const c_oAscLockTypes = {
kLockTypeNone: 1, // никто не залочил данный объект
kLockTypeMine: 2, // данный объект залочен текущим пользователем
kLockTypeOther: 3, // данный объект залочен другим(не текущим) пользователем
kLockTypeOther2: 4, // данный объект залочен другим(не текущим) пользователем (обновления уже пришли)
kLockTypeOther3: 5 // данный объект был залочен (обновления пришли) и снова стал залочен
};
const c_oAscLockTypeElem = {
Range: 1,
Object: 2,
Sheet: 3
};
const c_oAscLockTypeElemSubType = {
DeleteColumns: 1,
InsertColumns: 2,
DeleteRows: 3,
InsertRows: 4,
ChangeProperties: 5
};
const c_oAscLockTypeElemPresentation = {
Object: 1,
Slide: 2,
Presentation: 3
};
function CRecalcIndexElement(recalcType, position, bIsSaveIndex) {
if (!(this instanceof CRecalcIndexElement)) {
return new CRecalcIndexElement(recalcType, position, bIsSaveIndex);
}
this._recalcType = recalcType; // Тип изменений (удаление или добавление)
this._position = position; // Позиция, в которой произошли изменения
this._count = 1; // Считаем все изменения за простейшие
this.m_bIsSaveIndex = !!bIsSaveIndex; // Это индексы из изменений других пользователей (которые мы еще не применили)
return this;
}
CRecalcIndexElement.prototype = {
constructor: CRecalcIndexElement,
// Пересчет для других
getLockOther: function(position, type) {
var inc = (c_oAscRecalcIndexTypes.RecalcIndexAdd === this._recalcType) ? +1 : -1;
if (position === this._position && c_oAscRecalcIndexTypes.RecalcIndexRemove === this._recalcType &&
true === this.m_bIsSaveIndex) {
// Мы еще не применили чужие изменения (поэтому для insert не нужно отрисовывать)
// RecalcIndexRemove (потому что перевертываем для правильной отработки, от другого пользователя
// пришло RecalcIndexAdd
return null;
} else if (position === this._position &&
c_oAscRecalcIndexTypes.RecalcIndexRemove === this._recalcType &&
c_oAscLockTypes.kLockTypeMine === type && false === this.m_bIsSaveIndex) {
// Для пользователя, который удалил столбец, рисовать залоченные ранее в данном столбце ячейки
// не нужно
return null;
} else if (position < this._position) {
return position;
}
else {
return (position + inc);
}
},
// Пересчет для других (только для сохранения)
getLockSaveOther: function(position, type) {
if (this.m_bIsSaveIndex) {
return position;
}
var inc = (c_oAscRecalcIndexTypes.RecalcIndexAdd === this._recalcType) ? +1 : -1;
if (position === this._position && c_oAscRecalcIndexTypes.RecalcIndexRemove === this._recalcType &&
true === this.m_bIsSaveIndex) {
// Мы еще не применили чужие изменения (поэтому для insert не нужно отрисовывать)
// RecalcIndexRemove (потому что перевертываем для правильной отработки, от другого пользователя
// пришло RecalcIndexAdd
return null;
} else if (position === this._position &&
c_oAscRecalcIndexTypes.RecalcIndexRemove === this._recalcType &&
c_oAscLockTypes.kLockTypeMine === type && false === this.m_bIsSaveIndex) {
// Для пользователя, который удалил столбец, рисовать залоченные ранее в данном столбце ячейки
// не нужно
return null;
} else if (position < this._position) {
return position;
}
else {
return (position + inc);
}
},
// Пересчет для себя
getLockMe: function(position) {
var inc = (c_oAscRecalcIndexTypes.RecalcIndexAdd === this._recalcType) ? -1 : +1;
if (position < this._position) {
return position;
}
else {
return (position + inc);
}
},
// Только когда от других пользователей изменения (для пересчета)
getLockMe2: function(position) {
var inc = (c_oAscRecalcIndexTypes.RecalcIndexAdd === this._recalcType) ? -1 : +1;
if (true !== this.m_bIsSaveIndex || position < this._position) {
return position;
}
else {
return (position + inc);
}
}
};
function CRecalcIndex() {
if (!(this instanceof CRecalcIndex)) {
return new CRecalcIndex();
}
this._arrElements = []; // Массив CRecalcIndexElement
return this;
}
CRecalcIndex.prototype = {
constructor: CRecalcIndex,
add: function(recalcType, position, count, bIsSaveIndex) {
for (var i = 0; i < count; ++i)
this._arrElements.push(new CRecalcIndexElement(recalcType, position, bIsSaveIndex));
},
clear: function() {
this._arrElements.length = 0;
},
// Пересчет для других
getLockOther: function(position, type) {
var newPosition = position;
var count = this._arrElements.length;
for (var i = 0; i < count; ++i) {
newPosition = this._arrElements[i].getLockOther(newPosition, type);
if (null === newPosition) {
break;
}
}
return newPosition;
},
// Пересчет для других (только для сохранения)
getLockSaveOther: function(position, type) {
var newPosition = position;
var count = this._arrElements.length;
for (var i = 0; i < count; ++i) {
newPosition = this._arrElements[i].getLockSaveOther(newPosition, type);
if (null === newPosition) {
break;
}
}
return newPosition;
},
// Пересчет для себя
getLockMe: function(position) {
var newPosition = position;
var count = this._arrElements.length;
for (var i = count - 1; i >= 0; --i) {
newPosition = this._arrElements[i].getLockMe(newPosition);
if (null === newPosition) {
break;
}
}
return newPosition;
},
// Только когда от других пользователей изменения (для пересчета)
getLockMe2: function(position) {
var newPosition = position;
var count = this._arrElements.length;
for (var i = count - 1; i >= 0; --i) {
newPosition = this._arrElements[i].getLockMe2(newPosition);
if (null === newPosition) {
break;
}
}
return newPosition;
}
};
function sendData(conn, data) {
conn.write(JSON.stringify(data));
const type = data ? data.type : null;
logger.debug('sendData: docId = %s;type = %s', conn.docId, type);
}
function sendDataWarning(conn, msg) {
sendData(conn, {type: "warning", message: msg});
}
function sendDataMessage(conn, msg) {
sendData(conn, {type: "message", messages: msg});
}
function sendDataCursor(conn, msg) {
sendData(conn, {type: "cursor", messages: msg});
}
function sendDataMeta(conn, msg) {
sendData(conn, {type: "meta", messages: msg});
}
function sendDataSession(conn, msg) {
sendData(conn, {type: "session", messages: msg});
}
function sendDataRefreshToken(conn, msg) {
sendData(conn, {type: "refreshToken", messages: msg});
}
function sendReleaseLock(conn, userLocks) {
sendData(conn, {type: "releaseLock", locks: _.map(userLocks, function(e) {
return {
block: e.block,
user: e.user,
time: Date.now(),
changes: null
};
})});
}
function getParticipants(docId, excludeClosed, excludeUserId, excludeViewer) {
return _.filter(connections, function(el) {
return el.docId === docId && el.isCloseCoAuthoring !== excludeClosed &&
el.user.id !== excludeUserId && el.user.view !== excludeViewer;
});
}
function getParticipantUser(docId, includeUserId) {
return _.filter(connections, function(el) {
return el.docId === docId && el.user.id === includeUserId;
});
}
function* updateEditUsers(userId) {
if (!licenseInfo.usersCount) {
return;
}
const now = new Date();
const expireAt = (Date.UTC(now.getUTCFullYear(), now.getUTCMonth(), now.getUTCDate() + 1)) / 1000 +
licenseInfo.usersExpire - 1;
yield editorData.addPresenceUniqueUser(userId, expireAt);
}
function* getEditorsCount(docId, opt_hvals) {
var elem, editorsCount = 0;
var hvals;
if(opt_hvals){
hvals = opt_hvals;
} else {
hvals = yield editorData.getPresence(docId, connections);
}
for (var i = 0; i < hvals.length; ++i) {
elem = JSON.parse(hvals[i]);
if(!elem.view && !elem.isCloseCoAuthoring) {
editorsCount++;
break;
}
}
return editorsCount;
}
function* hasEditors(docId, opt_hvals) {
let editorsCount = yield* getEditorsCount(docId, opt_hvals);
return editorsCount > 0;
}
function* isUserReconnect(docId, userId, connectionId) {
var elem;
var hvals = yield editorData.getPresence(docId, connections);
for (var i = 0; i < hvals.length; ++i) {
elem = JSON.parse(hvals[i]);
if (userId === elem.id && connectionId !== elem.connectionId) {
return true;
}
}
return false;
}
function* publish(data, optDocId, optUserId, opt_pubsub) {
var needPublish = true;
if(optDocId && optUserId) {
needPublish = false;
var hvals = yield editorData.getPresence(optDocId, connections);
for (var i = 0; i < hvals.length; ++i) {
var elem = JSON.parse(hvals[i]);
if(optUserId != elem.id) {
needPublish = true;
break;
}
}
}
if(needPublish) {
var msg = JSON.stringify(data);
var realPubsub = opt_pubsub ? opt_pubsub : pubsub;
if (realPubsub) {
realPubsub.publish(msg);
}
}
return needPublish;
}
function* addTask(data, priority, opt_queue, opt_expiration) {
var realQueue = opt_queue ? opt_queue : queue;
yield realQueue.addTask(data, priority, opt_expiration);
}
function* addResponse(data, opt_queue) {
var realQueue = opt_queue ? opt_queue : queue;
yield realQueue.addResponse(data);
}
function* addDelayed(data, ttl, opt_queue) {
var realQueue = opt_queue ? opt_queue : queue;
yield realQueue.addDelayed(data, ttl);
}
function* removeResponse(data) {
yield queue.removeResponse(data);
}
function* getOriginalParticipantsId(docId) {
var result = [], tmpObject = {};
var hvals = yield editorData.getPresence(docId, connections);
for (var i = 0; i < hvals.length; ++i) {
var elem = JSON.parse(hvals[i]);
if (!elem.view && !elem.isCloseCoAuthoring) {
tmpObject[elem.idOriginal] = 1;
}
}
for (var name in tmpObject) if (tmpObject.hasOwnProperty(name)) {
result.push(name);
}
return result;
}
function* sendServerRequest(docId, uri, dataObject, opt_checkAuthorization) {
logger.debug('postData request: docId = %s;url = %s;data = %j', docId, uri, dataObject);
let auth;
if (cfgTokenEnableRequestOutbox) {
auth = utils.fillJwtForRequest(dataObject);
if (cfgTokenOutboxInBody) {
dataObject = {token: auth};
auth = undefined;
} else if (opt_checkAuthorization && !opt_checkAuthorization(auth, dataObject)) {
auth = utils.fillJwtForRequest(dataObject);
logger.warn('authorization reduced to: docId = %s; length=%d', docId, auth.length);
}
}
let res = yield utils.postRequestPromise(uri, JSON.stringify(dataObject), cfgCallbackRequestTimeout, auth);
logger.debug('postData response: docId = %s;data = %s', docId, res);
return res;
}
// Парсинг ссылки
function parseUrl(callbackUrl) {
var result = null;
try {
//делать decodeURIComponent не нужно http://expressjs.com/en/4x/api.html#app.settings.table
//по умолчанию express использует 'query parser' = 'extended', но даже в 'simple' версии делается decode
//percent-encoded characters within the query string will be assumed to use UTF-8 encoding
var parseObject = url.parse(callbackUrl);
var isHttps = 'https:' === parseObject.protocol;
var port = parseObject.port;
if (!port) {
port = isHttps ? defaultHttpsPort : defaultHttpPort;
}
result = {
'https': isHttps,
'host': parseObject.hostname,
'port': port,
'path': parseObject.path,
'href': parseObject.href
};
} catch (e) {
logger.error("error parseUrl %s:\r\n%s", callbackUrl, e.stack);
result = null;
}
return result;
}
function* getCallback(id, opt_userIndex) {
var callbackUrl = null;
var baseUrl = null;
var selectRes = yield taskResult.select(id);
if (selectRes.length > 0) {
var row = selectRes[0];
if (row.callback) {
callbackUrl = sqlBase.UserCallback.prototype.getCallbackByUserIndex(id, row.callback, opt_userIndex);
}
if (row.baseurl) {
baseUrl = row.baseurl;
}
}
if (null != callbackUrl && null != baseUrl) {
return {server: parseUrl(callbackUrl), baseUrl: baseUrl};
} else {
return null;
}
}
function* getChangesIndex(docId) {
var res = 0;
var getRes = yield sqlBase.getChangesIndexPromise(docId);
if (getRes && getRes.length > 0 && null != getRes[0]['change_id']) {
res = getRes[0]['change_id'] + 1;
}
return res;
}
function* setForceSave(docId, forceSave, cmd, success) {
if (success) {
yield editorData.checkAndSetForceSave(docId, forceSave.getTime(), forceSave.getIndex(), true, true);
} else {
yield editorData.checkAndSetForceSave(docId, forceSave.getTime(), forceSave.getIndex(), false, false);
}
let forceSaveType = forceSave.getType();
if (commonDefines.c_oAscForceSaveTypes.Command !== forceSaveType) {
yield* publish({
type: commonDefines.c_oPublishType.forceSave, docId: docId,
data: {type: forceSaveType, time: forceSave.getTime(), success: success}
}, cmd.getUserConnectionId());
}
}
function* startForceSave(docId, type, opt_userdata, opt_userConnectionId, opt_baseUrl, opt_queue, opt_pubsub) {
logger.debug('startForceSave start:docId = %s', docId);
let res = {code: commonDefines.c_oAscServerCommandErrors.NoError, time: null};
let startedForceSave;
if (!shutdownFlag) {
startedForceSave = yield editorData.checkAndStartForceSave(docId);
}
logger.debug('startForceSave canStart:docId = %s; startedForceSave = %j', docId, startedForceSave);
if (startedForceSave) {
let baseUrl = opt_baseUrl || startedForceSave.baseUrl;
let forceSave = new commonDefines.CForceSaveData(startedForceSave);
forceSave.setType(type);
if (commonDefines.c_oAscForceSaveTypes.Timeout === type) {
yield* publish({
type: commonDefines.c_oPublishType.forceSave, docId: docId,
data: {type: type, time: forceSave.getTime(), start: true}
}, undefined, undefined, opt_pubsub);
}
let priority;
let expiration;
if (commonDefines.c_oAscForceSaveTypes.Timeout === type) {
priority = constants.QUEUE_PRIORITY_VERY_LOW;
expiration = FORCE_SAVE_EXPIRATION;
} else {
priority = constants.QUEUE_PRIORITY_LOW;
}
//start new convert
let status = yield* converterService.convertFromChanges(docId, baseUrl, forceSave, opt_userdata,
opt_userConnectionId, priority, expiration, opt_queue);
if (constants.NO_ERROR === status.err) {
res.time = forceSave.getTime();
} else {
res.code = commonDefines.c_oAscServerCommandErrors.UnknownError;
}
logger.debug('startForceSave convertFromChanges:docId = %s; status = %d', docId, status.err);
} else {
res.code = commonDefines.c_oAscServerCommandErrors.NotModified;
}
logger.debug('startForceSave end:docId = %s', docId);
return res;
}
function handleDeadLetter(data, ack) {
return co(function*() {
let docId = 'null';
try {
var isRequeued = false;
let task = new commonDefines.TaskQueueData(JSON.parse(data));
if (task) {
let cmd = task.getCmd();
docId = cmd.getDocId();
logger.warn('handleDeadLetter start: docId = %s %s', docId, data);
let forceSave = cmd.getForceSave();
if (forceSave && commonDefines.c_oAscForceSaveTypes.Timeout == forceSave.getType()) {
let actualForceSave = yield editorData.getForceSave(docId);
//check that there are no new changes
if (actualForceSave && forceSave.getTime() === actualForceSave.time && forceSave.getIndex() === actualForceSave.index) {
//requeue task
yield* addTask(task, constants.QUEUE_PRIORITY_VERY_LOW, undefined, FORCE_SAVE_EXPIRATION);
isRequeued = true;
}
} else if(cmd.getAttempt()) {
logger.warn('handleDeadLetter addResponse delayed = %d: docId = %s', cmd.getAttempt(), docId);
yield* addResponse(task);
} else {
//simulate error response
cmd.setStatusInfo(constants.CONVERT_DEAD_LETTER);
canvasService.receiveTask(JSON.stringify(task), function(){});
}
}
logger.warn('handleDeadLetter end: docId = %s; requeue = %s', docId, isRequeued);
} catch (err) {
logger.error('handleDeadLetter error: docId = %s\r\n%s', docId, err.stack);
} finally {
ack();
}
});
}
/**
* Отправка статуса, чтобы знать когда документ начал редактироваться, а когда закончился
* @param docId
* @param {number} bChangeBase
* @param callback
* @param baseUrl
*/
function* sendStatusDocument(docId, bChangeBase, opt_userAction, opt_userIndex, opt_callback, opt_baseUrl, opt_userData, opt_forceClose) {
if (!opt_callback) {
var getRes = yield* getCallback(docId, opt_userIndex);
if (getRes) {
opt_callback = getRes.server;
if (!opt_baseUrl) {
opt_baseUrl = getRes.baseUrl;
}
}
}
if (null == opt_callback) {
return;
}
var status = c_oAscServerStatus.Editing;
var participants = yield* getOriginalParticipantsId(docId);
if (0 === participants.length) {
var puckerIndex = yield* getChangesIndex(docId);
if (!(puckerIndex > 0) || opt_forceClose) {
status = c_oAscServerStatus.Closed;
}
}
if (c_oAscChangeBase.No !== bChangeBase) {
//update callback even if the connection is closed to avoid script:
//open->make changes->disconnect->subscription from community->reconnect
if (c_oAscChangeBase.All === bChangeBase) {
//always override callback to avoid expired callbacks
var updateTask = new taskResult.TaskResultData();
updateTask.key = docId;
updateTask.callback = opt_callback.href;
updateTask.baseurl = opt_baseUrl;
var updateIfRes = yield taskResult.update(updateTask);
if (updateIfRes.affectedRows > 0) {
logger.debug('sendStatusDocument updateIf: docId = %s', docId);
} else {
logger.debug('sendStatusDocument updateIf no effect: docId = %s', docId);
}
}
}
var sendData = new commonDefines.OutputSfcData();
sendData.setKey(docId);
sendData.setStatus(status);
if (c_oAscServerStatus.Closed !== status) {
sendData.setUsers(participants);
}
if (opt_userAction) {
sendData.setActions([opt_userAction]);
}
if (opt_userData) {
sendData.setUserData(opt_userData);
}
var uri = opt_callback.href;
var replyData = null;
try {
replyData = yield* sendServerRequest(docId, uri, sendData);
} catch (err) {
replyData = null;
logger.error('postData error: docId = %s;url = %s;data = %j\r\n%s', docId, uri, sendData, err.stack);
}
yield* onReplySendStatusDocument(docId, replyData);
return opt_callback;
}
function parseReplyData(docId, replyData) {
var res = null;
if (replyData) {
try {
res = JSON.parse(replyData);
} catch (e) {
logger.error("error parseReplyData: docId = %s; data = %s\r\n%s", docId, replyData, e.stack);
res = null;
}
}
return res;
}
function* onReplySendStatusDocument(docId, replyData) {
var oData = parseReplyData(docId, replyData);
if (!(oData && commonDefines.c_oAscServerCommandErrors.NoError == oData.error)) {
// Ошибка подписки на callback, посылаем warning
yield* publish({type: commonDefines.c_oPublishType.warning, docId: docId, description: 'Error on save server subscription!'});
}
}
function* publishCloseUsersConnection(docId, users, isOriginalId, code, description) {
if (Array.isArray(users)) {
let usersMap = users.reduce(function(map, val) {
map[val] = 1;
return map;
}, {});
yield* publish({
type: commonDefines.c_oPublishType.closeConnection, docId: docId, usersMap: usersMap,
isOriginalId: isOriginalId, code: code, description: description
});
}
}
function closeUsersConnection(docId, usersMap, isOriginalId, code, description) {
let elConnection;
for (let i = connections.length - 1; i >= 0; --i) {
elConnection = connections[i];
if (elConnection.docId === docId) {
if (isOriginalId ? usersMap[elConnection.user.idOriginal] : usersMap[elConnection.user.id]) {
elConnection.close(code, description);
}
}
}
}
function* dropUsersFromDocument(docId, users) {
if (Array.isArray(users)) {
yield* publish({type: commonDefines.c_oPublishType.drop, docId: docId, users: users, description: ''});
}
}
function dropUserFromDocument(docId, userId, description) {
var elConnection;
for (var i = 0, length = connections.length; i < length; ++i) {
elConnection = connections[i];
if (elConnection.docId === docId && userId === elConnection.user.idOriginal && !elConnection.isCloseCoAuthoring) {
sendData(elConnection,
{
type: "drop",
description: description
});//Or 0 if fails
}
}
}
// Подписка на эвенты:
function* bindEvents(docId, callback, baseUrl, opt_userAction, opt_userData) {
// Подписка на эвенты:
// - если пользователей нет и изменений нет, то отсылаем статус "закрыто" и в базу не добавляем
// - если пользователей нет, а изменения есть, то отсылаем статус "редактируем" без пользователей, но добавляем в базу
// - если есть пользователи, то просто добавляем в базу
var bChangeBase;
var oCallbackUrl;
if (!callback) {
var getRes = yield* getCallback(docId);
if (getRes) {
oCallbackUrl = getRes.server;
bChangeBase = c_oAscChangeBase.Delete;
}
} else {
oCallbackUrl = parseUrl(callback);
bChangeBase = c_oAscChangeBase.All;
if (null !== oCallbackUrl) {
let filterStatus = yield* utils.checkHostFilter(oCallbackUrl.host);
if (filterStatus > 0) {
logger.warn('checkIpFilter error: docId = %s;url = %s', docId, callback);
//todo add new error type
oCallbackUrl = null;
}
}
}
if (null === oCallbackUrl) {
return commonDefines.c_oAscServerCommandErrors.ParseError;
} else {
yield* sendStatusDocument(docId, bChangeBase, opt_userAction, undefined, oCallbackUrl, baseUrl, opt_userData);
return commonDefines.c_oAscServerCommandErrors.NoError;
}
}
function* cleanDocumentOnExit(docId, deleteChanges) {
//clean redis (redisKeyPresenceSet and redisKeyPresenceHash removed with last element)
yield editorData.cleanDocumentOnExit(docId);
//remove changes
if (deleteChanges) {
sqlBase.deleteChanges(docId, null);
//delete forgotten after successful send on callbackUrl
yield storage.deletePath(cfgForgottenFiles + '/' + docId);
}
}
function* cleanDocumentOnExitNoChanges(docId, opt_userId, opt_userIndex, opt_forceClose) {
var userAction = opt_userId ? new commonDefines.OutputAction(commonDefines.c_oAscUserAction.Out, opt_userId) : null;
// Отправляем, что все ушли и нет изменений (чтобы выставить статус на сервере об окончании редактирования)
yield* sendStatusDocument(docId, c_oAscChangeBase.No, userAction, opt_userIndex, undefined, undefined, undefined, opt_forceClose);
//если пользователь зашел в документ, соединение порвалось, на сервере удалилась вся информация,
//при восстановлении соединения userIndex сохранится и он совпадет с userIndex следующего пользователя
yield* cleanDocumentOnExit(docId, false);
}
function* _createSaveTimer(docId, opt_userId, opt_userIndex, opt_queue, opt_noDelay) {
var updateMask = new taskResult.TaskResultData();
updateMask.key = docId;
updateMask.status = taskResult.FileStatus.Ok;
var updateTask = new taskResult.TaskResultData();
updateTask.status = taskResult.FileStatus.SaveVersion;
updateTask.statusInfo = utils.getMillisecondsOfHour(new Date());
var updateIfRes = yield taskResult.updateIf(updateTask, updateMask);
if (updateIfRes.affectedRows > 0) {
if(!opt_noDelay){
yield utils.sleep(cfgAscSaveTimeOutDelay);
}
while (true) {
if (!sqlBase.isLockCriticalSection(docId)) {
canvasService.saveFromChanges(docId, updateTask.statusInfo, null, opt_userId, opt_userIndex, opt_queue);
break;
}
yield utils.sleep(c_oAscLockTimeOutDelay);
}
} else {
//если не получилось - значит FileStatus=SaveVersion(кто-то другой начал сборку) или UpdateVersion(сборка закончена)
//в этом случае ничего делать не надо
logger.debug('_createSaveTimer updateIf no effect');
}
}
function checkJwt(docId, token, type) {
var res = {decoded: null, description: null, code: null, token: token};
var secret;
switch (type) {
case commonDefines.c_oAscSecretType.Browser:
secret = utils.getSecret(docId, cfgTokenBrowserSecretFromInbox ? cfgSecretInbox : cfgSecretBrowser, null, token);
break;
case commonDefines.c_oAscSecretType.Inbox:
secret = utils.getSecret(docId, cfgSecretInbox, null, token);
break;
case commonDefines.c_oAscSecretType.Session:
secret = utils.getSecretByElem(cfgSecretSession);
break;
}
if (undefined == secret) {
logger.warn('empty secret: docId = %s token = %s', docId, token);
}
try {
res.decoded = jwt.verify(token, secret);
logger.debug('checkJwt success: docId = %s decoded = %j', docId, res.decoded);
} catch (err) {
logger.warn('checkJwt error: docId = %s name = %s message = %s token = %s', docId, err.name, err.message, token);
if ('TokenExpiredError' === err.name) {
res.code = constants.JWT_EXPIRED_CODE;
res.description = constants.JWT_EXPIRED_REASON + err.message;
} else if ('JsonWebTokenError' === err.name) {
res.code = constants.JWT_ERROR_CODE;
res.description = constants.JWT_ERROR_REASON + err.message;
}
}
return res;
}
function checkJwtHeader(docId, req) {
var authorization = req.get(cfgTokenInboxHeader);
if (authorization && authorization.startsWith(cfgTokenInboxPrefix)) {
var token = authorization.substring(cfgTokenInboxPrefix.length);
return checkJwt(docId, token, commonDefines.c_oAscSecretType.Inbox);
}
return null;
}
function checkJwtPayloadHash(docId, hash, body, token) {
var res = false;
if (body && Buffer.isBuffer(body)) {
var decoded = jwt.decode(token, {complete: true});
var hmac = jwa(decoded.header.alg);
var secret = utils.getSecret(docId, cfgSecretInbox, null, token);
var signature = hmac.sign(body, secret);
res = (hash === signature);
}
return res;
}
function getRequestParams(docId, req, opt_isNotInBody, opt_tokenAssign) {
let res = {code: constants.NO_ERROR, params: undefined};
if (req.body && Buffer.isBuffer(req.body) && !opt_isNotInBody) {
res.params = JSON.parse(req.body.toString('utf8'));
} else {
res.params = req.query;
}
if (cfgTokenEnableRequestInbox) {
res.code = constants.VKEY;
let checkJwtRes;
if (cfgTokenInboxInBody && !opt_isNotInBody) {
checkJwtRes = checkJwt(docId, res.params.token, commonDefines.c_oAscSecretType.Inbox);
} else {
//for compatibility
checkJwtRes = checkJwtHeader(docId, req);