Extracting FileController into a Uploader container
This commit is contained in:
parent
25f9662b3c
commit
bf797085e6
23
.github/workflows/build-and-deploy.yml
vendored
23
.github/workflows/build-and-deploy.yml
vendored
@ -79,6 +79,29 @@ jobs:
|
|||||||
tags: ${{ env.GITHUB_REF_SLUG }}
|
tags: ${{ env.GITHUB_REF_SLUG }}
|
||||||
add_git_labels: true
|
add_git_labels: true
|
||||||
|
|
||||||
|
build-uploader:
|
||||||
|
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
|
steps:
|
||||||
|
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v2
|
||||||
|
|
||||||
|
# Create a slugified value of the branch
|
||||||
|
- uses: rlespinasse/github-slug-action@3.1.0
|
||||||
|
|
||||||
|
- name: "Build and push back image"
|
||||||
|
uses: docker/build-push-action@v1
|
||||||
|
with:
|
||||||
|
dockerfile: uploader/Dockerfile
|
||||||
|
path: ./
|
||||||
|
username: ${{ secrets.DOCKER_USERNAME }}
|
||||||
|
password: ${{ secrets.DOCKER_PASSWORD }}
|
||||||
|
repository: thecodingmachine/workadventure-uploader
|
||||||
|
tags: ${{ env.GITHUB_REF_SLUG }}
|
||||||
|
add_git_labels: true
|
||||||
|
|
||||||
build-website:
|
build-website:
|
||||||
|
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
|
@ -53,6 +53,7 @@
|
|||||||
"ports": [80],
|
"ports": [80],
|
||||||
"env": {
|
"env": {
|
||||||
"API_URL": "pusher."+url,
|
"API_URL": "pusher."+url,
|
||||||
|
"UPLOADER_URL": "uploader."+url,
|
||||||
"JITSI_URL": env.JITSI_URL,
|
"JITSI_URL": env.JITSI_URL,
|
||||||
"SECRET_JITSI_KEY": env.SECRET_JITSI_KEY,
|
"SECRET_JITSI_KEY": env.SECRET_JITSI_KEY,
|
||||||
"TURN_SERVER": "turn:coturn.workadventu.re:443,turns:coturn.workadventu.re:443",
|
"TURN_SERVER": "turn:coturn.workadventu.re:443,turns:coturn.workadventu.re:443",
|
||||||
@ -61,6 +62,17 @@
|
|||||||
"JITSI_PRIVATE_MODE": if env.SECRET_JITSI_KEY != '' then "true" else "false"
|
"JITSI_PRIVATE_MODE": if env.SECRET_JITSI_KEY != '' then "true" else "false"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"uploader": {
|
||||||
|
"image": "thecodingmachine/workadventure-uploader:"+tag,
|
||||||
|
"host": {
|
||||||
|
"url": "uploader."+url,
|
||||||
|
"https": "enable",
|
||||||
|
"containerPort": 8080
|
||||||
|
},
|
||||||
|
"ports": [8080],
|
||||||
|
"env": {
|
||||||
|
}
|
||||||
|
},
|
||||||
"maps": {
|
"maps": {
|
||||||
"image": "thecodingmachine/workadventure-maps:"+tag,
|
"image": "thecodingmachine/workadventure-maps:"+tag,
|
||||||
"host": {
|
"host": {
|
||||||
|
@ -27,6 +27,7 @@ services:
|
|||||||
HOST: "0.0.0.0"
|
HOST: "0.0.0.0"
|
||||||
NODE_ENV: development
|
NODE_ENV: development
|
||||||
API_URL: pusher.workadventure.localhost
|
API_URL: pusher.workadventure.localhost
|
||||||
|
UPLOADER_URL: uploader.workadventure.localhost
|
||||||
STARTUP_COMMAND_1: yarn install
|
STARTUP_COMMAND_1: yarn install
|
||||||
TURN_SERVER: "turn:coturn.workadventu.re:443,turns:coturn.workadventu.re:443"
|
TURN_SERVER: "turn:coturn.workadventu.re:443,turns:coturn.workadventu.re:443"
|
||||||
TURN_USER: workadventure
|
TURN_USER: workadventure
|
||||||
@ -46,6 +47,7 @@ services:
|
|||||||
pusher:
|
pusher:
|
||||||
image: thecodingmachine/nodejs:12
|
image: thecodingmachine/nodejs:12
|
||||||
command: yarn dev
|
command: yarn dev
|
||||||
|
#command: yarn run prod
|
||||||
#command: yarn run profile
|
#command: yarn run profile
|
||||||
environment:
|
environment:
|
||||||
DEBUG: "*"
|
DEBUG: "*"
|
||||||
@ -114,6 +116,23 @@ services:
|
|||||||
- "traefik.http.routers.back-ssl.tls=true"
|
- "traefik.http.routers.back-ssl.tls=true"
|
||||||
- "traefik.http.routers.back-ssl.service=back"
|
- "traefik.http.routers.back-ssl.service=back"
|
||||||
|
|
||||||
|
uploader:
|
||||||
|
image: thecodingmachine/nodejs:12
|
||||||
|
command: yarn dev
|
||||||
|
#command: yarn run profile
|
||||||
|
environment:
|
||||||
|
DEBUG: "*"
|
||||||
|
STARTUP_COMMAND_1: yarn install
|
||||||
|
volumes:
|
||||||
|
- ./uploader:/usr/src/app
|
||||||
|
labels:
|
||||||
|
- "traefik.http.routers.uploader.rule=Host(`uploader.workadventure.localhost`)"
|
||||||
|
- "traefik.http.routers.uploader.entryPoints=web"
|
||||||
|
- "traefik.http.services.uploader.loadbalancer.server.port=8080"
|
||||||
|
- "traefik.http.routers.uploader-ssl.rule=Host(`uploader.workadventure.localhost`)"
|
||||||
|
- "traefik.http.routers.uploader-ssl.entryPoints=websecure"
|
||||||
|
- "traefik.http.routers.uploader-ssl.tls=true"
|
||||||
|
- "traefik.http.routers.uploader-ssl.service=uploader"
|
||||||
|
|
||||||
website:
|
website:
|
||||||
image: thecodingmachine/nodejs:12-apache
|
image: thecodingmachine/nodejs:12-apache
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
import {HtmlUtils} from "./../WebRtc/HtmlUtils";
|
import {HtmlUtils} from "./../WebRtc/HtmlUtils";
|
||||||
import {AUDIO_TYPE, MESSAGE_TYPE} from "./ConsoleGlobalMessageManager";
|
import {AUDIO_TYPE, MESSAGE_TYPE} from "./ConsoleGlobalMessageManager";
|
||||||
import {API_URL} from "../Enum/EnvironmentVariable";
|
import {API_URL, UPLOADER_URL} from "../Enum/EnvironmentVariable";
|
||||||
import {RoomConnection} from "../Connexion/RoomConnection";
|
import {RoomConnection} from "../Connexion/RoomConnection";
|
||||||
import {PlayGlobalMessageInterface} from "../Connexion/ConnexionModels";
|
import {PlayGlobalMessageInterface} from "../Connexion/ConnexionModels";
|
||||||
|
|
||||||
@ -79,7 +79,7 @@ export class GlobalMessageManager {
|
|||||||
divAudio.classList.add('active');
|
divAudio.classList.add('active');
|
||||||
}
|
}
|
||||||
const messageAudioSource : HTMLSourceElement = document.createElement('source');
|
const messageAudioSource : HTMLSourceElement = document.createElement('source');
|
||||||
messageAudioSource.src = `${API_URL}${urlMessage}`;
|
messageAudioSource.src = `${UPLOADER_URL}${urlMessage}`;
|
||||||
messageAudio.appendChild(messageAudioSource);
|
messageAudio.appendChild(messageAudioSource);
|
||||||
mainSectionDiv.appendChild(messageAudio);
|
mainSectionDiv.appendChild(messageAudio);
|
||||||
}
|
}
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
import {API_URL} from "../Enum/EnvironmentVariable";
|
import {API_URL, UPLOADER_URL} from "../Enum/EnvironmentVariable";
|
||||||
import Axios from "axios";
|
import Axios from "axios";
|
||||||
import {
|
import {
|
||||||
BatchMessage,
|
BatchMessage,
|
||||||
@ -501,7 +501,7 @@ export class RoomConnection implements RoomConnection {
|
|||||||
}
|
}
|
||||||
|
|
||||||
public uploadAudio(file : FormData){
|
public uploadAudio(file : FormData){
|
||||||
return Axios.post(`${API_URL}/upload-audio-message`, file).then((res: {data:{}}) => {
|
return Axios.post(`${UPLOADER_URL}/upload-audio-message`, file).then((res: {data:{}}) => {
|
||||||
return res.data;
|
return res.data;
|
||||||
}).catch((err) => {
|
}).catch((err) => {
|
||||||
console.error(err);
|
console.error(err);
|
||||||
|
@ -1,5 +1,6 @@
|
|||||||
const DEBUG_MODE: boolean = process.env.DEBUG_MODE == "true";
|
const DEBUG_MODE: boolean = process.env.DEBUG_MODE == "true";
|
||||||
const API_URL = (process.env.API_PROTOCOL || (typeof(window) !== 'undefined' ? window.location.protocol : 'http:')) + '//' + (process.env.API_URL || "pusher.workadventure.localhost");
|
const API_URL = (process.env.API_PROTOCOL || (typeof(window) !== 'undefined' ? window.location.protocol : 'http:')) + '//' + (process.env.API_URL || "pusher.workadventure.localhost");
|
||||||
|
const UPLOADER_URL = (process.env.API_PROTOCOL || (typeof(window) !== 'undefined' ? window.location.protocol : 'http:')) + '//' + (process.env.UPLOADER_URL || 'uploader.workadventure.localhost');
|
||||||
const ADMIN_URL = API_URL.replace('api', 'admin');
|
const ADMIN_URL = API_URL.replace('api', 'admin');
|
||||||
const TURN_SERVER: string = process.env.TURN_SERVER || "turn:numb.viagenie.ca";
|
const TURN_SERVER: string = process.env.TURN_SERVER || "turn:numb.viagenie.ca";
|
||||||
const TURN_USER: string = process.env.TURN_USER || 'g.parant@thecodingmachine.com';
|
const TURN_USER: string = process.env.TURN_USER || 'g.parant@thecodingmachine.com';
|
||||||
@ -14,6 +15,7 @@ const MAX_EXTRAPOLATION_TIME = 100; // Extrapolate a maximum of 250ms if no new
|
|||||||
export {
|
export {
|
||||||
DEBUG_MODE,
|
DEBUG_MODE,
|
||||||
API_URL,
|
API_URL,
|
||||||
|
UPLOADER_URL,
|
||||||
ADMIN_URL,
|
ADMIN_URL,
|
||||||
RESOLUTION,
|
RESOLUTION,
|
||||||
ZOOM_LEVEL,
|
ZOOM_LEVEL,
|
||||||
|
@ -45,7 +45,7 @@ module.exports = {
|
|||||||
new webpack.ProvidePlugin({
|
new webpack.ProvidePlugin({
|
||||||
Phaser: 'phaser'
|
Phaser: 'phaser'
|
||||||
}),
|
}),
|
||||||
new webpack.EnvironmentPlugin(['API_URL', 'DEBUG_MODE', 'TURN_SERVER', 'TURN_USER', 'TURN_PASSWORD', 'JITSI_URL', 'JITSI_PRIVATE_MODE'])
|
new webpack.EnvironmentPlugin(['API_URL', 'UPLOADER_URL', 'DEBUG_MODE', 'TURN_SERVER', 'TURN_USER', 'TURN_PASSWORD', 'JITSI_URL', 'JITSI_PRIVATE_MODE'])
|
||||||
],
|
],
|
||||||
|
|
||||||
};
|
};
|
||||||
|
@ -3,7 +3,6 @@ import {IoSocketController} from "./Controller/IoSocketController"; //TODO fix i
|
|||||||
import {AuthenticateController} from "./Controller/AuthenticateController"; //TODO fix import by "_Controller/..."
|
import {AuthenticateController} from "./Controller/AuthenticateController"; //TODO fix import by "_Controller/..."
|
||||||
import {MapController} from "./Controller/MapController";
|
import {MapController} from "./Controller/MapController";
|
||||||
import {PrometheusController} from "./Controller/PrometheusController";
|
import {PrometheusController} from "./Controller/PrometheusController";
|
||||||
import {FileController} from "./Controller/FileController";
|
|
||||||
import {DebugController} from "./Controller/DebugController";
|
import {DebugController} from "./Controller/DebugController";
|
||||||
import {App as uwsApp} from "./Server/sifrr.server";
|
import {App as uwsApp} from "./Server/sifrr.server";
|
||||||
|
|
||||||
@ -11,7 +10,6 @@ class App {
|
|||||||
public app: uwsApp;
|
public app: uwsApp;
|
||||||
public ioSocketController: IoSocketController;
|
public ioSocketController: IoSocketController;
|
||||||
public authenticateController: AuthenticateController;
|
public authenticateController: AuthenticateController;
|
||||||
public fileController: FileController;
|
|
||||||
public mapController: MapController;
|
public mapController: MapController;
|
||||||
public prometheusController: PrometheusController;
|
public prometheusController: PrometheusController;
|
||||||
private debugController: DebugController;
|
private debugController: DebugController;
|
||||||
@ -22,7 +20,6 @@ class App {
|
|||||||
//create socket controllers
|
//create socket controllers
|
||||||
this.ioSocketController = new IoSocketController(this.app);
|
this.ioSocketController = new IoSocketController(this.app);
|
||||||
this.authenticateController = new AuthenticateController(this.app);
|
this.authenticateController = new AuthenticateController(this.app);
|
||||||
this.fileController = new FileController(this.app);
|
|
||||||
this.mapController = new MapController(this.app);
|
this.mapController = new MapController(this.app);
|
||||||
this.prometheusController = new PrometheusController(this.app);
|
this.prometheusController = new PrometheusController(this.app);
|
||||||
this.debugController = new DebugController(this.app);
|
this.debugController = new DebugController(this.app);
|
||||||
|
30
uploader/.eslintrc.json
Normal file
30
uploader/.eslintrc.json
Normal file
@ -0,0 +1,30 @@
|
|||||||
|
{
|
||||||
|
"root": true,
|
||||||
|
"env": {
|
||||||
|
"browser": true,
|
||||||
|
"es6": true,
|
||||||
|
"node": true
|
||||||
|
},
|
||||||
|
"extends": [
|
||||||
|
"eslint:recommended",
|
||||||
|
"plugin:@typescript-eslint/eslint-recommended",
|
||||||
|
"plugin:@typescript-eslint/recommended-requiring-type-checking"
|
||||||
|
],
|
||||||
|
"globals": {
|
||||||
|
"Atomics": "readonly",
|
||||||
|
"SharedArrayBuffer": "readonly"
|
||||||
|
},
|
||||||
|
"parser": "@typescript-eslint/parser",
|
||||||
|
"parserOptions": {
|
||||||
|
"ecmaVersion": 2018,
|
||||||
|
"sourceType": "module",
|
||||||
|
"project": "./tsconfig.json"
|
||||||
|
},
|
||||||
|
"plugins": [
|
||||||
|
"@typescript-eslint"
|
||||||
|
],
|
||||||
|
"rules": {
|
||||||
|
"no-unused-vars": "off",
|
||||||
|
"@typescript-eslint/no-explicit-any": "error"
|
||||||
|
}
|
||||||
|
}
|
4
uploader/.gitignore
vendored
Normal file
4
uploader/.gitignore
vendored
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
/dist/
|
||||||
|
/node_modules/
|
||||||
|
/dist/bundle.js
|
||||||
|
/yarn-error.log
|
9
uploader/Dockerfile
Normal file
9
uploader/Dockerfile
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
FROM thecodingmachine/nodejs:12
|
||||||
|
|
||||||
|
COPY --chown=docker:docker uploader .
|
||||||
|
RUN yarn install
|
||||||
|
|
||||||
|
ENV NODE_ENV=production
|
||||||
|
RUN yarn run tsc
|
||||||
|
|
||||||
|
CMD ["yarn", "run", "runprod"]
|
691
uploader/LICENSE.txt
Normal file
691
uploader/LICENSE.txt
Normal file
@ -0,0 +1,691 @@
|
|||||||
|
NOTICE
|
||||||
|
This package contains software licensed under different
|
||||||
|
licenses, please refer to the NOTICE.txt file for further
|
||||||
|
information and LICENSES.txt for full license texts.
|
||||||
|
|
||||||
|
WorkAdventure Enterprise edition can be licensed independently from
|
||||||
|
the source under separate commercial terms.
|
||||||
|
|
||||||
|
The software ("Software") is developed and owned by TheCodingMachine
|
||||||
|
and is subject to the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, with the Commons Clause as follows:
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 19 November 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The GNU Affero General Public License is a free, copyleft license
|
||||||
|
for software and other kinds of works, specifically designed to ensure
|
||||||
|
cooperation with the community in the case of network server software.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are
|
||||||
|
designed to take away your freedom to share and change the works. By
|
||||||
|
contrast, our General Public Licenses are intended to guarantee your
|
||||||
|
freedom to share and change all versions of a program--to make sure it
|
||||||
|
remains free software for all its users.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
Developers that use our General Public Licenses protect your rights
|
||||||
|
with two steps: (1) assert copyright on the software, and (2) offer
|
||||||
|
you this License which gives you legal permission to copy, distribute
|
||||||
|
and/or modify the software.
|
||||||
|
|
||||||
|
A secondary benefit of defending all users' freedom is that
|
||||||
|
improvements made in alternate versions of the program, if they
|
||||||
|
receive widespread use, become available for other developers to
|
||||||
|
incorporate. Many developers of free software are heartened and
|
||||||
|
encouraged by the resulting cooperation. However, in the case of
|
||||||
|
software used on network servers, this result may fail to come about.
|
||||||
|
The GNU General Public License permits making a modified version and
|
||||||
|
letting the public access it on a server without ever releasing its
|
||||||
|
source code to the public.
|
||||||
|
|
||||||
|
The GNU Affero General Public License is designed specifically to
|
||||||
|
ensure that, in such cases, the modified source code becomes available
|
||||||
|
to the community. It requires the operator of a network server to
|
||||||
|
provide the source code of the modified version running there to the
|
||||||
|
users of that server. Therefore, public use of a modified version, on
|
||||||
|
a publicly accessible server, gives the public access to the source
|
||||||
|
code of the modified version.
|
||||||
|
|
||||||
|
An older license, called the Affero General Public License and
|
||||||
|
published by Affero, was designed to accomplish similar goals. This is
|
||||||
|
a different license, not a version of the Affero GPL, but Affero has
|
||||||
|
released a new version of the Affero GPL which permits relicensing under
|
||||||
|
this license.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU Affero General Public
|
||||||
|
License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds
|
||||||
|
of works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further restriction,
|
||||||
|
you may remove that term. If a license document contains a further
|
||||||
|
restriction but permits relicensing or conveying under this License, you
|
||||||
|
may add to a covered work material governed by the terms of that license
|
||||||
|
document, provided that the further restriction does not survive such
|
||||||
|
relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Remote Network Interaction; Use with the GNU General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, if you modify the
|
||||||
|
Program, your modified version must prominently offer all users
|
||||||
|
interacting with it remotely through a computer network (if your version
|
||||||
|
supports such interaction) an opportunity to receive the Corresponding
|
||||||
|
Source of your version by providing access to the Corresponding Source
|
||||||
|
from a network server at no charge, through some standard or customary
|
||||||
|
means of facilitating copying of software. This Corresponding Source
|
||||||
|
shall include the Corresponding Source for any work covered by version 3
|
||||||
|
of the GNU General Public License that is incorporated pursuant to the
|
||||||
|
following paragraph.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have permission
|
||||||
|
to link or combine any covered work with a work licensed under version 3
|
||||||
|
of the GNU General Public License into a single combined work, and to
|
||||||
|
convey the resulting work. The terms of this License will continue to
|
||||||
|
apply to the part which is the covered work, but the work with which it is
|
||||||
|
combined will remain governed by version 3 of the GNU General Public
|
||||||
|
License.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU Affero General Public License from time to time. Such new
|
||||||
|
versions will be similar in spirit to the present version, but may differ
|
||||||
|
in detail to address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU Affero
|
||||||
|
General Public License "or any later version" applies to it, you have
|
||||||
|
the option of following the terms and conditions either of that
|
||||||
|
numbered version or of any later version published by the Free
|
||||||
|
Software Foundation. If the Program does not specify a version number
|
||||||
|
of the GNU Affero General Public License, you may choose any version
|
||||||
|
ever published by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU Affero General Public License can be used, that
|
||||||
|
proxy's public statement of acceptance of a version permanently
|
||||||
|
authorizes you to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU Affero General Public License as
|
||||||
|
published by the Free Software Foundation, either version 3 of the
|
||||||
|
License, or (at your option) any later version.
|
||||||
|
|
||||||
|
This program 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 Affero General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Affero General Public License
|
||||||
|
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If your software can interact with users remotely through a computer
|
||||||
|
network, you should also make sure that it provides a way for users to
|
||||||
|
get its source. For example, if your program is a web application, its
|
||||||
|
interface could display a "Source" link that leads users to an archive
|
||||||
|
of the code. There are many ways you could offer source, and different
|
||||||
|
solutions will be better for different programs; see section 13 for the
|
||||||
|
specific requirements.
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU AGPL, see
|
||||||
|
<http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
|
||||||
|
"Commons Clause" License Condition
|
||||||
|
|
||||||
|
The Software is provided to you by the Licensor under the License, as
|
||||||
|
defined below, subject to the following condition. Without limiting
|
||||||
|
other conditions in the License, the grant of rights under the License
|
||||||
|
will not include, and the License does not grant to you, the right to
|
||||||
|
Sell the Software. For purposes of the foregoing, "Sell" means
|
||||||
|
practicing any or all of the rights granted to you under the License
|
||||||
|
to provide to third parties, for a fee or other consideration,
|
||||||
|
a product or service that consists, entirely or substantially,
|
||||||
|
of the Software or the functionality of the Software. Any license
|
||||||
|
notice or attribution required by the License must also include
|
||||||
|
this Commons Cause License Condition notice.
|
4
uploader/README.md
Normal file
4
uploader/README.md
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
# Uploader
|
||||||
|
|
||||||
|
The uploader component is in charge of accepting incoming files that can be downloaded by other users.
|
||||||
|
It is currently used by administrators of maps to send sounds/recordings to everyone on a map.
|
5
uploader/jasmine.json
Normal file
5
uploader/jasmine.json
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
{
|
||||||
|
"spec_dir": "tests",
|
||||||
|
"spec_files": ["**/*[tT]est.ts"],
|
||||||
|
"stopSpecOnExpectationFailure": false
|
||||||
|
}
|
65
uploader/package.json
Normal file
65
uploader/package.json
Normal file
@ -0,0 +1,65 @@
|
|||||||
|
{
|
||||||
|
"name": "workadventureback",
|
||||||
|
"version": "1.0.0",
|
||||||
|
"description": "",
|
||||||
|
"main": "index.js",
|
||||||
|
"scripts": {
|
||||||
|
"tsc": "tsc",
|
||||||
|
"dev": "ts-node-dev --respawn ./server.ts",
|
||||||
|
"prod": "tsc && node --max-old-space-size=4096 ./dist/server.js",
|
||||||
|
"runprod": "node --max-old-space-size=4096 ./dist/server.js",
|
||||||
|
"profile": "tsc && node --prof ./dist/server.js",
|
||||||
|
"test": "ts-node node_modules/jasmine/bin/jasmine --config=jasmine.json",
|
||||||
|
"lint": "node_modules/.bin/eslint src/ . --ext .ts",
|
||||||
|
"fix": "node_modules/.bin/eslint --fix src/ . --ext .ts"
|
||||||
|
},
|
||||||
|
"repository": {
|
||||||
|
"type": "git",
|
||||||
|
"url": "git+https://github.com/thecodingmachine/workadventure.git"
|
||||||
|
},
|
||||||
|
"contributors": [
|
||||||
|
{
|
||||||
|
"name": "Grégoire Parant",
|
||||||
|
"email": "g.parant@thecodingmachine.com"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "David Négrier",
|
||||||
|
"email": "d.negrier@thecodingmachine.com"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Arthmaël Poly",
|
||||||
|
"email": "a.poly@thecodingmachine.com"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"license": "SEE LICENSE IN LICENSE.txt",
|
||||||
|
"bugs": {
|
||||||
|
"url": "https://github.com/thecodingmachine/workadventure/issues"
|
||||||
|
},
|
||||||
|
"homepage": "https://github.com/thecodingmachine/workadventure#readme",
|
||||||
|
"dependencies": {
|
||||||
|
"body-parser": "^1.19.0",
|
||||||
|
"busboy": "^0.3.1",
|
||||||
|
"debug": "^4.3.1",
|
||||||
|
"http-status-codes": "^1.4.0",
|
||||||
|
"iterall": "^1.3.0",
|
||||||
|
"jsonwebtoken": "^8.5.1",
|
||||||
|
"multer": "^1.4.2",
|
||||||
|
"prom-client": "^12.0.0",
|
||||||
|
"query-string": "^6.13.3",
|
||||||
|
"ts-node-dev": "^1.0.0-pre.44",
|
||||||
|
"typescript": "^3.8.3",
|
||||||
|
"uWebSockets.js": "uNetworking/uWebSockets.js#v18.5.0"
|
||||||
|
},
|
||||||
|
"devDependencies": {
|
||||||
|
"@types/busboy": "^0.2.3",
|
||||||
|
"@types/circular-json": "^0.4.0",
|
||||||
|
"@types/debug": "^4.1.5",
|
||||||
|
"@types/http-status-codes": "^1.2.0",
|
||||||
|
"@types/jasmine": "^3.5.10",
|
||||||
|
"@types/jsonwebtoken": "^8.3.8",
|
||||||
|
"@typescript-eslint/eslint-plugin": "^2.26.0",
|
||||||
|
"@typescript-eslint/parser": "^2.26.0",
|
||||||
|
"eslint": "^6.8.0",
|
||||||
|
"jasmine": "^3.5.0"
|
||||||
|
}
|
||||||
|
}
|
3
uploader/server.ts
Normal file
3
uploader/server.ts
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
// lib/server.ts
|
||||||
|
import App from "./src/App";
|
||||||
|
App.listen(8080, () => console.log(`WorkAdventure starting on port 8080!`))
|
16
uploader/src/App.ts
Normal file
16
uploader/src/App.ts
Normal file
@ -0,0 +1,16 @@
|
|||||||
|
// lib/app.ts
|
||||||
|
import {FileController} from "./Controller/FileController";
|
||||||
|
import {App as uwsApp} from "./Server/sifrr.server";
|
||||||
|
|
||||||
|
class App {
|
||||||
|
public app: uwsApp;
|
||||||
|
public fileController: FileController;
|
||||||
|
|
||||||
|
constructor() {
|
||||||
|
this.app = new uwsApp();
|
||||||
|
|
||||||
|
this.fileController = new FileController(this.app);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export default new App().app;
|
10
uploader/src/Controller/BaseController.ts
Normal file
10
uploader/src/Controller/BaseController.ts
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
import {HttpRequest, HttpResponse} from "uWebSockets.js";
|
||||||
|
|
||||||
|
|
||||||
|
export class BaseController {
|
||||||
|
protected addCorsHeaders(res: HttpResponse): void {
|
||||||
|
res.writeHeader('access-control-allow-headers', 'Origin, X-Requested-With, Content-Type, Accept');
|
||||||
|
res.writeHeader('access-control-allow-methods', 'GET, POST, OPTIONS, PUT, PATCH, DELETE');
|
||||||
|
res.writeHeader('access-control-allow-origin', '*');
|
||||||
|
}
|
||||||
|
}
|
@ -105,7 +105,7 @@ export class FileController extends BaseController {
|
|||||||
this.App.get("/download-audio-message/:id", (res: HttpResponse, req: HttpRequest) => {
|
this.App.get("/download-audio-message/:id", (res: HttpResponse, req: HttpRequest) => {
|
||||||
|
|
||||||
res.onAborted(() => {
|
res.onAborted(() => {
|
||||||
console.warn('upload-audio-message request was aborted');
|
console.warn('download-audio-message request was aborted');
|
||||||
})
|
})
|
||||||
|
|
||||||
const id = req.getParameter(0);
|
const id = req.getParameter(0);
|
13
uploader/src/Server/server/app.ts
Normal file
13
uploader/src/Server/server/app.ts
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
import { App as _App, AppOptions } from 'uWebSockets.js';
|
||||||
|
import BaseApp from './baseapp';
|
||||||
|
import { extend } from './utils';
|
||||||
|
import { UwsApp } from './types';
|
||||||
|
|
||||||
|
class App extends (<UwsApp>_App) {
|
||||||
|
constructor(options: AppOptions = {}) {
|
||||||
|
super(options); // eslint-disable-line constructor-super
|
||||||
|
extend(this, new BaseApp());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export default App;
|
116
uploader/src/Server/server/baseapp.ts
Normal file
116
uploader/src/Server/server/baseapp.ts
Normal file
@ -0,0 +1,116 @@
|
|||||||
|
import { Readable } from 'stream';
|
||||||
|
import { us_listen_socket_close, TemplatedApp, HttpResponse, HttpRequest } from 'uWebSockets.js';
|
||||||
|
|
||||||
|
import formData from './formdata';
|
||||||
|
import { stob } from './utils';
|
||||||
|
import { Handler } from './types';
|
||||||
|
import {join} from "path";
|
||||||
|
|
||||||
|
const contTypes = ['application/x-www-form-urlencoded', 'multipart/form-data'];
|
||||||
|
const noOp = () => true;
|
||||||
|
|
||||||
|
const handleBody = (res: HttpResponse, req: HttpRequest) => {
|
||||||
|
const contType = req.getHeader('content-type');
|
||||||
|
|
||||||
|
res.bodyStream = function() {
|
||||||
|
const stream = new Readable();
|
||||||
|
stream._read = noOp; // eslint-disable-line @typescript-eslint/unbound-method
|
||||||
|
|
||||||
|
this.onData((ab: ArrayBuffer, isLast: boolean) => {
|
||||||
|
// uint and then slicing is bit faster than slice and then uint
|
||||||
|
stream.push(new Uint8Array(ab.slice((ab as any).byteOffset, ab.byteLength))); // eslint-disable-line @typescript-eslint/no-explicit-any
|
||||||
|
if (isLast) {
|
||||||
|
stream.push(null);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
return stream;
|
||||||
|
};
|
||||||
|
|
||||||
|
res.body = () => stob(res.bodyStream());
|
||||||
|
|
||||||
|
if (contType.includes('application/json'))
|
||||||
|
res.json = async () => JSON.parse(await res.body());
|
||||||
|
if (contTypes.map(t => contType.includes(t)).includes(true))
|
||||||
|
res.formData = formData.bind(res, contType);
|
||||||
|
};
|
||||||
|
|
||||||
|
class BaseApp {
|
||||||
|
_sockets = new Map();
|
||||||
|
ws!: TemplatedApp['ws'];
|
||||||
|
get!: TemplatedApp['get'];
|
||||||
|
_post!: TemplatedApp['post'];
|
||||||
|
_put!: TemplatedApp['put'];
|
||||||
|
_patch!: TemplatedApp['patch'];
|
||||||
|
_listen!: TemplatedApp['listen'];
|
||||||
|
|
||||||
|
post(pattern: string, handler: Handler) {
|
||||||
|
if (typeof handler !== 'function')
|
||||||
|
throw Error(`handler should be a function, given ${typeof handler}.`);
|
||||||
|
this._post(pattern, (res, req) => {
|
||||||
|
handleBody(res, req);
|
||||||
|
handler(res, req);
|
||||||
|
});
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
put(pattern: string, handler: Handler) {
|
||||||
|
if (typeof handler !== 'function')
|
||||||
|
throw Error(`handler should be a function, given ${typeof handler}.`);
|
||||||
|
this._put(pattern, (res, req) => {
|
||||||
|
handleBody(res, req);
|
||||||
|
|
||||||
|
handler(res, req);
|
||||||
|
});
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
patch(pattern: string, handler: Handler) {
|
||||||
|
if (typeof handler !== 'function')
|
||||||
|
throw Error(`handler should be a function, given ${typeof handler}.`);
|
||||||
|
this._patch(pattern, (res, req) => {
|
||||||
|
handleBody(res, req);
|
||||||
|
|
||||||
|
handler(res, req);
|
||||||
|
});
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
listen(h: string | number, p: Function | number = noOp, cb?: Function) {
|
||||||
|
if (typeof p === 'number' && typeof h === 'string') {
|
||||||
|
this._listen(h, p, socket => {
|
||||||
|
this._sockets.set(p, socket);
|
||||||
|
if (cb === undefined) {
|
||||||
|
throw new Error('cb undefined');
|
||||||
|
}
|
||||||
|
cb(socket);
|
||||||
|
});
|
||||||
|
} else if (typeof h === 'number' && typeof p === 'function') {
|
||||||
|
this._listen(h, socket => {
|
||||||
|
this._sockets.set(h, socket);
|
||||||
|
p(socket);
|
||||||
|
});
|
||||||
|
} else {
|
||||||
|
throw Error(
|
||||||
|
'Argument types: (host: string, port: number, cb?: Function) | (port: number, cb?: Function)'
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
close(port: null | number = null) {
|
||||||
|
if (port) {
|
||||||
|
this._sockets.has(port) && us_listen_socket_close(this._sockets.get(port));
|
||||||
|
this._sockets.delete(port);
|
||||||
|
} else {
|
||||||
|
this._sockets.forEach(app => {
|
||||||
|
us_listen_socket_close(app);
|
||||||
|
});
|
||||||
|
this._sockets.clear();
|
||||||
|
}
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export default BaseApp;
|
100
uploader/src/Server/server/formdata.ts
Normal file
100
uploader/src/Server/server/formdata.ts
Normal file
@ -0,0 +1,100 @@
|
|||||||
|
import { createWriteStream } from 'fs';
|
||||||
|
import { join, dirname } from 'path';
|
||||||
|
import Busboy from 'busboy';
|
||||||
|
import mkdirp from 'mkdirp';
|
||||||
|
|
||||||
|
function formData(
|
||||||
|
contType: string,
|
||||||
|
options: busboy.BusboyConfig & {
|
||||||
|
abortOnLimit?: boolean;
|
||||||
|
tmpDir?: string;
|
||||||
|
onFile?: (
|
||||||
|
fieldname: string,
|
||||||
|
file: NodeJS.ReadableStream,
|
||||||
|
filename: string,
|
||||||
|
encoding: string,
|
||||||
|
mimetype: string
|
||||||
|
) => string;
|
||||||
|
onField?: (fieldname: string, value: any) => void; // eslint-disable-line @typescript-eslint/no-explicit-any
|
||||||
|
filename?: (oldName: string) => string;
|
||||||
|
} = {}
|
||||||
|
) {
|
||||||
|
console.log('Enter form data');
|
||||||
|
options.headers = {
|
||||||
|
'content-type': contType
|
||||||
|
};
|
||||||
|
|
||||||
|
return new Promise((resolve, reject) => {
|
||||||
|
const busb = new Busboy(options);
|
||||||
|
const ret = {};
|
||||||
|
|
||||||
|
this.bodyStream().pipe(busb);
|
||||||
|
|
||||||
|
busb.on('limit', () => {
|
||||||
|
if (options.abortOnLimit) {
|
||||||
|
reject(Error('limit'));
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
busb.on('file', function(fieldname, file, filename, encoding, mimetype) {
|
||||||
|
const value: { filePath: string|undefined, filename: string, encoding:string, mimetype: string } = {
|
||||||
|
filename,
|
||||||
|
encoding,
|
||||||
|
mimetype,
|
||||||
|
filePath: undefined
|
||||||
|
};
|
||||||
|
|
||||||
|
if (typeof options.tmpDir === 'string') {
|
||||||
|
if (typeof options.filename === 'function') filename = options.filename(filename);
|
||||||
|
const fileToSave = join(options.tmpDir, filename);
|
||||||
|
mkdirp(dirname(fileToSave));
|
||||||
|
|
||||||
|
file.pipe(createWriteStream(fileToSave));
|
||||||
|
value.filePath = fileToSave;
|
||||||
|
}
|
||||||
|
if (typeof options.onFile === 'function') {
|
||||||
|
value.filePath =
|
||||||
|
options.onFile(fieldname, file, filename, encoding, mimetype) || value.filePath;
|
||||||
|
}
|
||||||
|
|
||||||
|
setRetValue(ret, fieldname, value);
|
||||||
|
});
|
||||||
|
|
||||||
|
busb.on('field', function(fieldname, value) {
|
||||||
|
if (typeof options.onField === 'function') options.onField(fieldname, value);
|
||||||
|
|
||||||
|
setRetValue(ret, fieldname, value);
|
||||||
|
});
|
||||||
|
|
||||||
|
busb.on('finish', function() {
|
||||||
|
resolve(ret);
|
||||||
|
});
|
||||||
|
|
||||||
|
busb.on('error', reject);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
function setRetValue(
|
||||||
|
ret: { [x: string]: any }, // eslint-disable-line @typescript-eslint/no-explicit-any
|
||||||
|
fieldname: string,
|
||||||
|
value: { filename: string; encoding: string; mimetype: string; filePath?: string } | any // eslint-disable-line @typescript-eslint/no-explicit-any
|
||||||
|
) {
|
||||||
|
if (fieldname.endsWith('[]')) {
|
||||||
|
fieldname = fieldname.slice(0, fieldname.length - 2);
|
||||||
|
if (Array.isArray(ret[fieldname])) {
|
||||||
|
ret[fieldname].push(value);
|
||||||
|
} else {
|
||||||
|
ret[fieldname] = [value];
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
if (Array.isArray(ret[fieldname])) {
|
||||||
|
ret[fieldname].push(value);
|
||||||
|
} else if (ret[fieldname]) {
|
||||||
|
ret[fieldname] = [ret[fieldname], value];
|
||||||
|
} else {
|
||||||
|
ret[fieldname] = value;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export default formData;
|
13
uploader/src/Server/server/sslapp.ts
Normal file
13
uploader/src/Server/server/sslapp.ts
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
import { SSLApp as _SSLApp, AppOptions } from 'uWebSockets.js';
|
||||||
|
import BaseApp from './baseapp';
|
||||||
|
import { extend } from './utils';
|
||||||
|
import { UwsApp } from './types';
|
||||||
|
|
||||||
|
class SSLApp extends (<UwsApp>_SSLApp) {
|
||||||
|
constructor(options: AppOptions) {
|
||||||
|
super(options); // eslint-disable-line constructor-super
|
||||||
|
extend(this, new BaseApp());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export default SSLApp;
|
11
uploader/src/Server/server/types.ts
Normal file
11
uploader/src/Server/server/types.ts
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
import { AppOptions, TemplatedApp, HttpResponse, HttpRequest } from 'uWebSockets.js';
|
||||||
|
|
||||||
|
export type UwsApp = {
|
||||||
|
(options: AppOptions): TemplatedApp;
|
||||||
|
new (options: AppOptions): TemplatedApp;
|
||||||
|
prototype: TemplatedApp;
|
||||||
|
};
|
||||||
|
|
||||||
|
export type Handler = (res: HttpResponse, req: HttpRequest) => void;
|
||||||
|
|
||||||
|
export {};
|
37
uploader/src/Server/server/utils.ts
Normal file
37
uploader/src/Server/server/utils.ts
Normal file
@ -0,0 +1,37 @@
|
|||||||
|
import { ReadStream } from 'fs';
|
||||||
|
|
||||||
|
function extend(who: any, from: any, overwrite = true) { // eslint-disable-line @typescript-eslint/no-explicit-any
|
||||||
|
const ownProps = Object.getOwnPropertyNames(Object.getPrototypeOf(from)).concat(
|
||||||
|
Object.keys(from)
|
||||||
|
);
|
||||||
|
ownProps.forEach(prop => {
|
||||||
|
if (prop === 'constructor' || from[prop] === undefined) return;
|
||||||
|
if (who[prop] && overwrite) {
|
||||||
|
who[`_${prop}`] = who[prop];
|
||||||
|
}
|
||||||
|
if (typeof from[prop] === 'function') who[prop] = from[prop].bind(who);
|
||||||
|
else who[prop] = from[prop];
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
function stob(stream: ReadStream): Promise<Buffer> {
|
||||||
|
return new Promise(resolve => {
|
||||||
|
const buffers: Buffer[] = [];
|
||||||
|
stream.on('data', buffers.push.bind(buffers));
|
||||||
|
|
||||||
|
stream.on('end', () => {
|
||||||
|
switch (buffers.length) {
|
||||||
|
case 0:
|
||||||
|
resolve(Buffer.allocUnsafe(0));
|
||||||
|
break;
|
||||||
|
case 1:
|
||||||
|
resolve(buffers[0]);
|
||||||
|
break;
|
||||||
|
default:
|
||||||
|
resolve(Buffer.concat(buffers));
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
export { extend, stob };
|
19
uploader/src/Server/sifrr.server.ts
Normal file
19
uploader/src/Server/sifrr.server.ts
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
import { parse } from 'query-string';
|
||||||
|
import { HttpRequest } from 'uWebSockets.js';
|
||||||
|
import App from './server/app';
|
||||||
|
import SSLApp from './server/sslapp';
|
||||||
|
import * as types from './server/types';
|
||||||
|
|
||||||
|
const getQuery = (req: HttpRequest) => {
|
||||||
|
return parse(req.getQuery());
|
||||||
|
};
|
||||||
|
|
||||||
|
export { App, SSLApp, getQuery };
|
||||||
|
export * from './server/types';
|
||||||
|
|
||||||
|
export default {
|
||||||
|
App,
|
||||||
|
SSLApp,
|
||||||
|
getQuery,
|
||||||
|
...types
|
||||||
|
};
|
115
uploader/src/Services/AdminApi.ts
Normal file
115
uploader/src/Services/AdminApi.ts
Normal file
@ -0,0 +1,115 @@
|
|||||||
|
import {ADMIN_API_TOKEN, ADMIN_API_URL} from "../Enum/EnvironmentVariable";
|
||||||
|
import Axios from "axios";
|
||||||
|
import {v4} from "uuid";
|
||||||
|
|
||||||
|
export interface AdminApiData {
|
||||||
|
organizationSlug: string
|
||||||
|
worldSlug: string
|
||||||
|
roomSlug: string
|
||||||
|
mapUrlStart: string
|
||||||
|
tags: string[]
|
||||||
|
policy_type: number
|
||||||
|
userUuid: string
|
||||||
|
messages?: unknown[],
|
||||||
|
textures: CharacterTexture[]
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface CharacterTexture {
|
||||||
|
id: number,
|
||||||
|
level: number,
|
||||||
|
url: string,
|
||||||
|
rights: string
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface FetchMemberDataByUuidResponse {
|
||||||
|
uuid: string;
|
||||||
|
tags: string[];
|
||||||
|
textures: CharacterTexture[];
|
||||||
|
messages: unknown[];
|
||||||
|
}
|
||||||
|
|
||||||
|
class AdminApi {
|
||||||
|
|
||||||
|
async fetchMapDetails(organizationSlug: string, worldSlug: string, roomSlug: string|undefined): Promise<AdminApiData> {
|
||||||
|
if (!ADMIN_API_URL) {
|
||||||
|
return Promise.reject('No admin backoffice set!');
|
||||||
|
}
|
||||||
|
|
||||||
|
const params: { organizationSlug: string, worldSlug: string, roomSlug?: string } = {
|
||||||
|
organizationSlug,
|
||||||
|
worldSlug
|
||||||
|
};
|
||||||
|
|
||||||
|
if (roomSlug) {
|
||||||
|
params.roomSlug = roomSlug;
|
||||||
|
}
|
||||||
|
|
||||||
|
const res = await Axios.get(ADMIN_API_URL + '/api/map',
|
||||||
|
{
|
||||||
|
headers: {"Authorization": `${ADMIN_API_TOKEN}`},
|
||||||
|
params
|
||||||
|
}
|
||||||
|
)
|
||||||
|
return res.data;
|
||||||
|
}
|
||||||
|
|
||||||
|
async fetchMemberDataByUuid(uuid: string): Promise<FetchMemberDataByUuidResponse> {
|
||||||
|
if (!ADMIN_API_URL) {
|
||||||
|
return Promise.reject('No admin backoffice set!');
|
||||||
|
}
|
||||||
|
try {
|
||||||
|
const res = await Axios.get(ADMIN_API_URL+'/api/membership/'+uuid,
|
||||||
|
{ headers: {"Authorization" : `${ADMIN_API_TOKEN}`} }
|
||||||
|
)
|
||||||
|
return res.data;
|
||||||
|
} catch (e) {
|
||||||
|
if (e?.response?.status == 404) {
|
||||||
|
// If we get an HTTP 404, the token is invalid. Let's perform an anonymous login!
|
||||||
|
console.warn('Cannot find user with uuid "'+uuid+'". Performing an anonymous login instead.');
|
||||||
|
return {
|
||||||
|
uuid: v4(),
|
||||||
|
tags: [],
|
||||||
|
textures: [],
|
||||||
|
messages: [],
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
throw e;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async fetchMemberDataByToken(organizationMemberToken: string): Promise<AdminApiData> {
|
||||||
|
if (!ADMIN_API_URL) {
|
||||||
|
return Promise.reject('No admin backoffice set!');
|
||||||
|
}
|
||||||
|
//todo: this call can fail if the corresponding world is not activated or if the token is invalid. Handle that case.
|
||||||
|
const res = await Axios.get(ADMIN_API_URL+'/api/login-url/'+organizationMemberToken,
|
||||||
|
{ headers: {"Authorization" : `${ADMIN_API_TOKEN}`} }
|
||||||
|
)
|
||||||
|
return res.data;
|
||||||
|
}
|
||||||
|
|
||||||
|
async fetchCheckUserByToken(organizationMemberToken: string): Promise<AdminApiData> {
|
||||||
|
if (!ADMIN_API_URL) {
|
||||||
|
return Promise.reject('No admin backoffice set!');
|
||||||
|
}
|
||||||
|
//todo: this call can fail if the corresponding world is not activated or if the token is invalid. Handle that case.
|
||||||
|
const res = await Axios.get(ADMIN_API_URL+'/api/check-user/'+organizationMemberToken,
|
||||||
|
{ headers: {"Authorization" : `${ADMIN_API_TOKEN}`} }
|
||||||
|
)
|
||||||
|
return res.data;
|
||||||
|
}
|
||||||
|
|
||||||
|
reportPlayer(reportedUserUuid: string, reportedUserComment: string, reporterUserUuid: string) {
|
||||||
|
return Axios.post(`${ADMIN_API_URL}/api/report`, {
|
||||||
|
reportedUserUuid,
|
||||||
|
reportedUserComment,
|
||||||
|
reporterUserUuid,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
headers: {"Authorization": `${ADMIN_API_TOKEN}`}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export const adminApi = new AdminApi();
|
22
uploader/src/Services/ApiClientRepository.ts
Normal file
22
uploader/src/Services/ApiClientRepository.ts
Normal file
@ -0,0 +1,22 @@
|
|||||||
|
/**
|
||||||
|
* A class to get connections to the correct "api" server given a room name.
|
||||||
|
*/
|
||||||
|
import {RoomManagerClient} from "../Messages/generated/messages_grpc_pb";
|
||||||
|
import grpc from 'grpc';
|
||||||
|
import {API_URL} from "../Enum/EnvironmentVariable";
|
||||||
|
|
||||||
|
|
||||||
|
class ApiClientRepository {
|
||||||
|
private roomManagerClient: RoomManagerClient|null = null;
|
||||||
|
|
||||||
|
public async getClient(roomId: string): Promise<RoomManagerClient> {
|
||||||
|
if (this.roomManagerClient === null) {
|
||||||
|
this.roomManagerClient = new RoomManagerClient(API_URL, grpc.credentials.createInsecure());
|
||||||
|
}
|
||||||
|
return Promise.resolve(this.roomManagerClient);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const apiClientRepository = new ApiClientRepository();
|
||||||
|
|
||||||
|
export { apiClientRepository };
|
3
uploader/src/Services/ArrayHelper.ts
Normal file
3
uploader/src/Services/ArrayHelper.ts
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
export const arrayIntersect = (array1: string[], array2: string[]) : boolean => {
|
||||||
|
return array1.filter(value => array2.includes(value)).length > 0;
|
||||||
|
}
|
32
uploader/src/Services/ClientEventsEmitter.ts
Normal file
32
uploader/src/Services/ClientEventsEmitter.ts
Normal file
@ -0,0 +1,32 @@
|
|||||||
|
const EventEmitter = require('events');
|
||||||
|
|
||||||
|
const clientJoinEvent = 'clientJoin';
|
||||||
|
const clientLeaveEvent = 'clientLeave';
|
||||||
|
|
||||||
|
class ClientEventsEmitter extends EventEmitter {
|
||||||
|
emitClientJoin(clientUUid: string, roomId: string): void {
|
||||||
|
this.emit(clientJoinEvent, clientUUid, roomId);
|
||||||
|
}
|
||||||
|
|
||||||
|
emitClientLeave(clientUUid: string, roomId: string): void {
|
||||||
|
this.emit(clientLeaveEvent, clientUUid, roomId);
|
||||||
|
}
|
||||||
|
|
||||||
|
registerToClientJoin(callback: (clientUUid: string, roomId: string) => void): void {
|
||||||
|
this.on(clientJoinEvent, callback);
|
||||||
|
}
|
||||||
|
|
||||||
|
registerToClientLeave(callback: (clientUUid: string, roomId: string) => void): void {
|
||||||
|
this.on(clientLeaveEvent, callback);
|
||||||
|
}
|
||||||
|
|
||||||
|
unregisterFromClientJoin(callback: (clientUUid: string, roomId: string) => void): void {
|
||||||
|
this.removeListener(clientJoinEvent, callback);
|
||||||
|
}
|
||||||
|
|
||||||
|
unregisterFromClientLeave(callback: (clientUUid: string, roomId: string) => void): void {
|
||||||
|
this.removeListener(clientLeaveEvent, callback);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export const clientEventsEmitter = new ClientEventsEmitter();
|
55
uploader/src/Services/CpuTracker.ts
Normal file
55
uploader/src/Services/CpuTracker.ts
Normal file
@ -0,0 +1,55 @@
|
|||||||
|
import {CPU_OVERHEAT_THRESHOLD} from "../Enum/EnvironmentVariable";
|
||||||
|
|
||||||
|
function secNSec2ms(secNSec: Array<number>|number) {
|
||||||
|
if (Array.isArray(secNSec)) {
|
||||||
|
return secNSec[0] * 1000 + secNSec[1] / 1000000;
|
||||||
|
}
|
||||||
|
return secNSec / 1000;
|
||||||
|
}
|
||||||
|
|
||||||
|
class CpuTracker {
|
||||||
|
private cpuPercent: number = 0;
|
||||||
|
private overHeating: boolean = false;
|
||||||
|
|
||||||
|
constructor() {
|
||||||
|
let time = process.hrtime.bigint()
|
||||||
|
let usage = process.cpuUsage()
|
||||||
|
setInterval(() => {
|
||||||
|
const elapTime = process.hrtime.bigint();
|
||||||
|
const elapUsage = process.cpuUsage(usage)
|
||||||
|
usage = process.cpuUsage()
|
||||||
|
|
||||||
|
const elapTimeMS = elapTime - time;
|
||||||
|
const elapUserMS = secNSec2ms(elapUsage.user)
|
||||||
|
const elapSystMS = secNSec2ms(elapUsage.system)
|
||||||
|
this.cpuPercent = Math.round(100 * (elapUserMS + elapSystMS) / Number(elapTimeMS) * 1000000)
|
||||||
|
|
||||||
|
time = elapTime;
|
||||||
|
|
||||||
|
if (!this.overHeating && this.cpuPercent > CPU_OVERHEAT_THRESHOLD) {
|
||||||
|
this.overHeating = true;
|
||||||
|
console.warn('CPU high threshold alert. Going in "overheat" mode');
|
||||||
|
} else if (this.overHeating && this.cpuPercent <= CPU_OVERHEAT_THRESHOLD) {
|
||||||
|
this.overHeating = false;
|
||||||
|
console.log('CPU is back to normal. Canceling "overheat" mode');
|
||||||
|
}
|
||||||
|
|
||||||
|
/*console.log('elapsed time ms: ', elapTimeMS)
|
||||||
|
console.log('elapsed user ms: ', elapUserMS)
|
||||||
|
console.log('elapsed system ms:', elapSystMS)
|
||||||
|
console.log('cpu percent: ', this.cpuPercent)*/
|
||||||
|
}, 100);
|
||||||
|
}
|
||||||
|
|
||||||
|
public getCpuPercent(): number {
|
||||||
|
return this.cpuPercent;
|
||||||
|
}
|
||||||
|
|
||||||
|
public isOverHeating(): boolean {
|
||||||
|
return this.overHeating;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const cpuTracker = new CpuTracker();
|
||||||
|
|
||||||
|
export { cpuTracker };
|
54
uploader/src/Services/GaugeManager.ts
Normal file
54
uploader/src/Services/GaugeManager.ts
Normal file
@ -0,0 +1,54 @@
|
|||||||
|
import {Counter, Gauge} from "prom-client";
|
||||||
|
|
||||||
|
//this class should manage all the custom metrics used by prometheus
|
||||||
|
class GaugeManager {
|
||||||
|
private nbClientsGauge: Gauge<string>;
|
||||||
|
private nbClientsPerRoomGauge: Gauge<string>;
|
||||||
|
private nbGroupsPerRoomGauge: Gauge<string>;
|
||||||
|
private nbGroupsPerRoomCounter: Counter<string>;
|
||||||
|
|
||||||
|
constructor() {
|
||||||
|
this.nbClientsGauge = new Gauge({
|
||||||
|
name: 'workadventure_nb_sockets',
|
||||||
|
help: 'Number of connected sockets',
|
||||||
|
labelNames: [ ]
|
||||||
|
});
|
||||||
|
this.nbClientsPerRoomGauge = new Gauge({
|
||||||
|
name: 'workadventure_nb_clients_per_room',
|
||||||
|
help: 'Number of clients per room',
|
||||||
|
labelNames: [ 'room' ]
|
||||||
|
});
|
||||||
|
|
||||||
|
this.nbGroupsPerRoomCounter = new Counter({
|
||||||
|
name: 'workadventure_counter_groups_per_room',
|
||||||
|
help: 'Counter of groups per room',
|
||||||
|
labelNames: [ 'room' ]
|
||||||
|
});
|
||||||
|
this.nbGroupsPerRoomGauge = new Gauge({
|
||||||
|
name: 'workadventure_nb_groups_per_room',
|
||||||
|
help: 'Number of groups per room',
|
||||||
|
labelNames: [ 'room' ]
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
incNbClientPerRoomGauge(roomId: string): void {
|
||||||
|
this.nbClientsGauge.inc();
|
||||||
|
this.nbClientsPerRoomGauge.inc({ room: roomId });
|
||||||
|
}
|
||||||
|
|
||||||
|
decNbClientPerRoomGauge(roomId: string): void {
|
||||||
|
this.nbClientsGauge.dec();
|
||||||
|
this.nbClientsPerRoomGauge.dec({ room: roomId });
|
||||||
|
}
|
||||||
|
|
||||||
|
incNbGroupsPerRoomGauge(roomId: string): void {
|
||||||
|
this.nbGroupsPerRoomCounter.inc({ room: roomId })
|
||||||
|
this.nbGroupsPerRoomGauge.inc({ room: roomId })
|
||||||
|
}
|
||||||
|
|
||||||
|
decNbGroupsPerRoomGauge(roomId: string): void {
|
||||||
|
this.nbGroupsPerRoomGauge.dec({ room: roomId })
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export const gaugeManager = new GaugeManager();
|
35
uploader/src/Services/IoSocketHelpers.ts
Normal file
35
uploader/src/Services/IoSocketHelpers.ts
Normal file
@ -0,0 +1,35 @@
|
|||||||
|
import {ExSocketInterface} from "_Model/Websocket/ExSocketInterface";
|
||||||
|
import {BatchMessage, ErrorMessage, ServerToClientMessage, SubMessage} from "../Messages/generated/messages_pb";
|
||||||
|
|
||||||
|
export function emitInBatch(socket: ExSocketInterface, payload: SubMessage): void {
|
||||||
|
socket.batchedMessages.addPayload(payload);
|
||||||
|
|
||||||
|
if (socket.batchTimeout === null) {
|
||||||
|
socket.batchTimeout = setTimeout(() => {
|
||||||
|
if (socket.disconnecting) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const serverToClientMessage = new ServerToClientMessage();
|
||||||
|
serverToClientMessage.setBatchmessage(socket.batchedMessages);
|
||||||
|
|
||||||
|
socket.send(serverToClientMessage.serializeBinary().buffer, true);
|
||||||
|
socket.batchedMessages = new BatchMessage();
|
||||||
|
socket.batchTimeout = null;
|
||||||
|
}, 100);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export function emitError(Client: ExSocketInterface, message: string): void {
|
||||||
|
const errorMessage = new ErrorMessage();
|
||||||
|
errorMessage.setMessage(message);
|
||||||
|
|
||||||
|
const serverToClientMessage = new ServerToClientMessage();
|
||||||
|
serverToClientMessage.setErrormessage(errorMessage);
|
||||||
|
|
||||||
|
if (!Client.disconnecting) {
|
||||||
|
Client.send(serverToClientMessage.serializeBinary().buffer, true);
|
||||||
|
}
|
||||||
|
console.warn(message);
|
||||||
|
}
|
||||||
|
|
76
uploader/src/Services/JWTTokenManager.ts
Normal file
76
uploader/src/Services/JWTTokenManager.ts
Normal file
@ -0,0 +1,76 @@
|
|||||||
|
import {ADMIN_API_URL, ALLOW_ARTILLERY, SECRET_KEY} from "../Enum/EnvironmentVariable";
|
||||||
|
import {uuid} from "uuidv4";
|
||||||
|
import Jwt from "jsonwebtoken";
|
||||||
|
import {TokenInterface} from "../Controller/AuthenticateController";
|
||||||
|
import {adminApi, AdminApiData} from "../Services/AdminApi";
|
||||||
|
|
||||||
|
class JWTTokenManager {
|
||||||
|
|
||||||
|
public createJWTToken(userUuid: string) {
|
||||||
|
return Jwt.sign({userUuid: userUuid}, SECRET_KEY, {expiresIn: '200d'}); //todo: add a mechanic to refresh or recreate token
|
||||||
|
}
|
||||||
|
|
||||||
|
public async getUserUuidFromToken(token: unknown): Promise<string> {
|
||||||
|
|
||||||
|
if (!token) {
|
||||||
|
throw new Error('An authentication error happened, a user tried to connect without a token.');
|
||||||
|
}
|
||||||
|
if (typeof(token) !== "string") {
|
||||||
|
throw new Error('Token is expected to be a string');
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
if(token === 'test') {
|
||||||
|
if (ALLOW_ARTILLERY) {
|
||||||
|
return uuid();
|
||||||
|
} else {
|
||||||
|
throw new Error("In order to perform a load-testing test on this environment, you must set the ALLOW_ARTILLERY environment variable to 'true'");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return new Promise<string>((resolve, reject) => {
|
||||||
|
Jwt.verify(token, SECRET_KEY, {},(err, tokenDecoded) => {
|
||||||
|
const tokenInterface = tokenDecoded as TokenInterface;
|
||||||
|
if (err) {
|
||||||
|
console.error('An authentication error happened, invalid JsonWebToken.', err);
|
||||||
|
reject(new Error('An authentication error happened, invalid JsonWebToken. ' + err.message));
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
if (tokenDecoded === undefined) {
|
||||||
|
console.error('Empty token found.');
|
||||||
|
reject(new Error('Empty token found.'));
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
//verify token
|
||||||
|
if (!this.isValidToken(tokenInterface)) {
|
||||||
|
reject(new Error('Authentication error, invalid token structure.'));
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (ADMIN_API_URL) {
|
||||||
|
//verify user in admin
|
||||||
|
adminApi.fetchCheckUserByToken(tokenInterface.userUuid).then(() => {
|
||||||
|
resolve(tokenInterface.userUuid);
|
||||||
|
}).catch((err) => {
|
||||||
|
//anonymous user
|
||||||
|
if(err.response && err.response.status && err.response.status === 404){
|
||||||
|
resolve(tokenInterface.userUuid);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
reject(err);
|
||||||
|
});
|
||||||
|
} else {
|
||||||
|
resolve(tokenInterface.userUuid);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
private isValidToken(token: object): token is TokenInterface {
|
||||||
|
return !(typeof((token as TokenInterface).userUuid) !== 'string');
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
export const jwtTokenManager = new JWTTokenManager();
|
747
uploader/src/Services/SocketManager.ts
Normal file
747
uploader/src/Services/SocketManager.ts
Normal file
@ -0,0 +1,747 @@
|
|||||||
|
import {PusherRoom} from "../Model/PusherRoom";
|
||||||
|
import {CharacterLayer, ExSocketInterface} from "../Model/Websocket/ExSocketInterface";
|
||||||
|
import {
|
||||||
|
GroupDeleteMessage,
|
||||||
|
GroupUpdateMessage,
|
||||||
|
ItemEventMessage,
|
||||||
|
ItemStateMessage,
|
||||||
|
PlayGlobalMessage,
|
||||||
|
PointMessage,
|
||||||
|
PositionMessage,
|
||||||
|
RoomJoinedMessage,
|
||||||
|
ServerToClientMessage,
|
||||||
|
SetPlayerDetailsMessage,
|
||||||
|
SilentMessage,
|
||||||
|
SubMessage,
|
||||||
|
ReportPlayerMessage,
|
||||||
|
UserJoinedMessage, UserLeftMessage,
|
||||||
|
UserMovedMessage,
|
||||||
|
UserMovesMessage,
|
||||||
|
ViewportMessage, WebRtcDisconnectMessage,
|
||||||
|
WebRtcSignalToClientMessage,
|
||||||
|
WebRtcSignalToServerMessage,
|
||||||
|
WebRtcStartMessage,
|
||||||
|
QueryJitsiJwtMessage,
|
||||||
|
SendJitsiJwtMessage,
|
||||||
|
SendUserMessage, JoinRoomMessage, CharacterLayerMessage, PusherToBackMessage
|
||||||
|
} from "../Messages/generated/messages_pb";
|
||||||
|
import {PointInterface} from "../Model/Websocket/PointInterface";
|
||||||
|
import {User} from "../Model/User";
|
||||||
|
import {ProtobufUtils} from "../Model/Websocket/ProtobufUtils";
|
||||||
|
import {Group} from "../Model/Group";
|
||||||
|
import {cpuTracker} from "./CpuTracker";
|
||||||
|
import {GROUP_RADIUS, JITSI_ISS, MINIMUM_DISTANCE, SECRET_JITSI_KEY} from "../Enum/EnvironmentVariable";
|
||||||
|
import {Movable} from "../Model/Movable";
|
||||||
|
import {PositionInterface} from "../Model/PositionInterface";
|
||||||
|
import {adminApi, CharacterTexture} from "./AdminApi";
|
||||||
|
import Direction = PositionMessage.Direction;
|
||||||
|
import {emitError, emitInBatch} from "./IoSocketHelpers";
|
||||||
|
import Jwt from "jsonwebtoken";
|
||||||
|
import {JITSI_URL} from "../Enum/EnvironmentVariable";
|
||||||
|
import {clientEventsEmitter} from "./ClientEventsEmitter";
|
||||||
|
import {gaugeManager} from "./GaugeManager";
|
||||||
|
import {apiClientRepository} from "./ApiClientRepository";
|
||||||
|
import {ServiceError} from "grpc";
|
||||||
|
import {GroupDescriptor, UserDescriptor, ZoneEventListener} from "_Model/Zone";
|
||||||
|
import Debug from "debug";
|
||||||
|
|
||||||
|
const debug = Debug('socket');
|
||||||
|
|
||||||
|
interface AdminSocketRoomsList {
|
||||||
|
[index: string]: number;
|
||||||
|
}
|
||||||
|
interface AdminSocketUsersList {
|
||||||
|
[index: string]: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface AdminSocketData {
|
||||||
|
rooms: AdminSocketRoomsList,
|
||||||
|
users: AdminSocketUsersList,
|
||||||
|
}
|
||||||
|
|
||||||
|
export class SocketManager implements ZoneEventListener {
|
||||||
|
private Worlds: Map<string, PusherRoom> = new Map<string, PusherRoom>();
|
||||||
|
private sockets: Map<number, ExSocketInterface> = new Map<number, ExSocketInterface>();
|
||||||
|
|
||||||
|
constructor() {
|
||||||
|
clientEventsEmitter.registerToClientJoin((clientUUid: string, roomId: string) => {
|
||||||
|
gaugeManager.incNbClientPerRoomGauge(roomId);
|
||||||
|
});
|
||||||
|
clientEventsEmitter.registerToClientLeave((clientUUid: string, roomId: string) => {
|
||||||
|
gaugeManager.decNbClientPerRoomGauge(roomId);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
getAdminSocketDataFor(roomId:string): AdminSocketData {
|
||||||
|
throw new Error('Not reimplemented yet');
|
||||||
|
/*const data:AdminSocketData = {
|
||||||
|
rooms: {},
|
||||||
|
users: {},
|
||||||
|
}
|
||||||
|
const room = this.Worlds.get(roomId);
|
||||||
|
if (room === undefined) {
|
||||||
|
return data;
|
||||||
|
}
|
||||||
|
const users = room.getUsers();
|
||||||
|
data.rooms[roomId] = users.size;
|
||||||
|
users.forEach(user => {
|
||||||
|
data.users[user.uuid] = true
|
||||||
|
})
|
||||||
|
return data;*/
|
||||||
|
}
|
||||||
|
|
||||||
|
async handleJoinRoom(client: ExSocketInterface): Promise<void> {
|
||||||
|
const position = client.position;
|
||||||
|
const viewport = client.viewport;
|
||||||
|
try {
|
||||||
|
|
||||||
|
const joinRoomMessage = new JoinRoomMessage();
|
||||||
|
joinRoomMessage.setUseruuid(client.userUuid);
|
||||||
|
joinRoomMessage.setRoomid(client.roomId);
|
||||||
|
joinRoomMessage.setName(client.name);
|
||||||
|
joinRoomMessage.setPositionmessage(ProtobufUtils.toPositionMessage(client.position));
|
||||||
|
for (const characterLayer of client.characterLayers) {
|
||||||
|
const characterLayerMessage = new CharacterLayerMessage();
|
||||||
|
characterLayerMessage.setName(characterLayer.name);
|
||||||
|
if (characterLayer.url !== undefined) {
|
||||||
|
characterLayerMessage.setUrl(characterLayer.url);
|
||||||
|
}
|
||||||
|
|
||||||
|
joinRoomMessage.addCharacterlayer(characterLayerMessage);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
console.log('Calling joinRoom')
|
||||||
|
const apiClient = await apiClientRepository.getClient(client.roomId);
|
||||||
|
const streamToPusher = apiClient.joinRoom();
|
||||||
|
|
||||||
|
client.backConnection = streamToPusher;
|
||||||
|
|
||||||
|
streamToPusher.on('data', (message: ServerToClientMessage) => {
|
||||||
|
if (message.hasRoomjoinedmessage()) {
|
||||||
|
client.userId = (message.getRoomjoinedmessage() as RoomJoinedMessage).getCurrentuserid();
|
||||||
|
// TODO: do we need this.sockets anymore?
|
||||||
|
this.sockets.set(client.userId, client);
|
||||||
|
|
||||||
|
// If this is the first message sent, send back the viewport.
|
||||||
|
this.handleViewport(client, viewport);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Let's pass data over from the back to the client.
|
||||||
|
if (!client.disconnecting) {
|
||||||
|
client.send(message.serializeBinary().buffer, true);
|
||||||
|
}
|
||||||
|
}).on('end', () => {
|
||||||
|
console.warn('Connection lost to back server');
|
||||||
|
// Let's close the front connection if the back connection is closed. This way, we can retry connecting from the start.
|
||||||
|
if (!client.disconnecting) {
|
||||||
|
this.closeWebsocketConnection(client, 1011, 'Connection lost to back server');
|
||||||
|
}
|
||||||
|
console.log('A user left');
|
||||||
|
}).on('error', (err: Error) => {
|
||||||
|
console.error('Error in connection to back server:', err);
|
||||||
|
if (!client.disconnecting) {
|
||||||
|
this.closeWebsocketConnection(client, 1011, 'Error while connecting to back server');
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
const pusherToBackMessage = new PusherToBackMessage();
|
||||||
|
pusherToBackMessage.setJoinroommessage(joinRoomMessage);
|
||||||
|
streamToPusher.write(pusherToBackMessage);
|
||||||
|
|
||||||
|
// TODO: analyze viewport, subscribe to correct handler
|
||||||
|
|
||||||
|
//join new previous room
|
||||||
|
//const gameRoom = this.joinRoom(client, position);
|
||||||
|
|
||||||
|
//const things = gameRoom.setViewport(client, viewport);
|
||||||
|
|
||||||
|
/*const roomJoinedMessage = new RoomJoinedMessage();
|
||||||
|
|
||||||
|
for (const thing of things) {
|
||||||
|
if (thing instanceof User) {
|
||||||
|
const player: ExSocketInterface|undefined = this.sockets.get(thing.id);
|
||||||
|
if (player === undefined) {
|
||||||
|
console.warn('Something went wrong. The World contains a user "'+thing.id+"' but this user does not exist in the sockets list!");
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
const userJoinedMessage = new UserJoinedMessage();
|
||||||
|
userJoinedMessage.setUserid(thing.id);
|
||||||
|
userJoinedMessage.setName(player.name);
|
||||||
|
userJoinedMessage.setCharacterlayersList(ProtobufUtils.toCharacterLayerMessages(player.characterLayers));
|
||||||
|
userJoinedMessage.setPosition(ProtobufUtils.toPositionMessage(player.position));
|
||||||
|
|
||||||
|
roomJoinedMessage.addUser(userJoinedMessage);
|
||||||
|
roomJoinedMessage.setTagList(client.tags);
|
||||||
|
} else if (thing instanceof Group) {
|
||||||
|
const groupUpdateMessage = new GroupUpdateMessage();
|
||||||
|
groupUpdateMessage.setGroupid(thing.getId());
|
||||||
|
groupUpdateMessage.setPosition(ProtobufUtils.toPointMessage(thing.getPosition()));
|
||||||
|
|
||||||
|
roomJoinedMessage.addGroup(groupUpdateMessage);
|
||||||
|
} else {
|
||||||
|
console.error("Unexpected type for Movable returned by setViewport");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
for (const [itemId, item] of gameRoom.getItemsState().entries()) {
|
||||||
|
const itemStateMessage = new ItemStateMessage();
|
||||||
|
itemStateMessage.setItemid(itemId);
|
||||||
|
itemStateMessage.setStatejson(JSON.stringify(item));
|
||||||
|
|
||||||
|
roomJoinedMessage.addItem(itemStateMessage);
|
||||||
|
}
|
||||||
|
|
||||||
|
roomJoinedMessage.setCurrentuserid(client.userId);
|
||||||
|
|
||||||
|
const serverToClientMessage = new ServerToClientMessage();
|
||||||
|
serverToClientMessage.setRoomjoinedmessage(roomJoinedMessage);
|
||||||
|
|
||||||
|
if (!client.disconnecting) {
|
||||||
|
client.send(serverToClientMessage.serializeBinary().buffer, true);
|
||||||
|
}*/
|
||||||
|
} catch (e) {
|
||||||
|
console.error('An error occurred on "join_room" event');
|
||||||
|
console.error(e);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private closeWebsocketConnection(client: ExSocketInterface, code: number, reason: string) {
|
||||||
|
client.disconnecting = true;
|
||||||
|
//this.leaveRoom(client);
|
||||||
|
//client.close();
|
||||||
|
client.end(code, reason);
|
||||||
|
}
|
||||||
|
|
||||||
|
handleViewport(client: ExSocketInterface, viewport: ViewportMessage.AsObject) {
|
||||||
|
try {
|
||||||
|
client.viewport = viewport;
|
||||||
|
|
||||||
|
const world = this.Worlds.get(client.roomId);
|
||||||
|
if (!world) {
|
||||||
|
console.error("In SET_VIEWPORT, could not find world with id '", client.roomId, "'");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
world.setViewport(client, client.viewport);
|
||||||
|
} catch (e) {
|
||||||
|
console.error('An error occurred on "SET_VIEWPORT" event');
|
||||||
|
console.error(e);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
handleUserMovesMessage(client: ExSocketInterface, userMovesMessage: UserMovesMessage) {
|
||||||
|
const pusherToBackMessage = new PusherToBackMessage();
|
||||||
|
pusherToBackMessage.setUsermovesmessage(userMovesMessage);
|
||||||
|
|
||||||
|
client.backConnection.write(pusherToBackMessage);
|
||||||
|
|
||||||
|
const viewport = userMovesMessage.getViewport();
|
||||||
|
if (viewport === undefined) {
|
||||||
|
throw new Error('Missing viewport in UserMovesMessage');
|
||||||
|
}
|
||||||
|
|
||||||
|
// Now, we need to listen to the correct viewport.
|
||||||
|
this.handleViewport(client, viewport.toObject())
|
||||||
|
}
|
||||||
|
|
||||||
|
// Useless now, will be useful again if we allow editing details in game
|
||||||
|
handleSetPlayerDetails(client: ExSocketInterface, playerDetailsMessage: SetPlayerDetailsMessage) {
|
||||||
|
const pusherToBackMessage = new PusherToBackMessage();
|
||||||
|
pusherToBackMessage.setSetplayerdetailsmessage(playerDetailsMessage);
|
||||||
|
|
||||||
|
client.backConnection.write(pusherToBackMessage);
|
||||||
|
}
|
||||||
|
|
||||||
|
handleSilentMessage(client: ExSocketInterface, silentMessage: SilentMessage) {
|
||||||
|
const pusherToBackMessage = new PusherToBackMessage();
|
||||||
|
pusherToBackMessage.setSilentmessage(silentMessage);
|
||||||
|
|
||||||
|
client.backConnection.write(pusherToBackMessage);
|
||||||
|
}
|
||||||
|
|
||||||
|
handleItemEvent(client: ExSocketInterface, itemEventMessage: ItemEventMessage) {
|
||||||
|
const pusherToBackMessage = new PusherToBackMessage();
|
||||||
|
pusherToBackMessage.setItemeventmessage(itemEventMessage);
|
||||||
|
|
||||||
|
client.backConnection.write(pusherToBackMessage);
|
||||||
|
|
||||||
|
/*const itemEvent = ProtobufUtils.toItemEvent(itemEventMessage);
|
||||||
|
|
||||||
|
try {
|
||||||
|
const world = this.Worlds.get(ws.roomId);
|
||||||
|
if (!world) {
|
||||||
|
console.error("Could not find world with id '", ws.roomId, "'");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const subMessage = new SubMessage();
|
||||||
|
subMessage.setItemeventmessage(itemEventMessage);
|
||||||
|
|
||||||
|
// Let's send the event without using the SocketIO room.
|
||||||
|
for (const user of world.getUsers().values()) {
|
||||||
|
const client = this.searchClientByIdOrFail(user.id);
|
||||||
|
//client.emit(SocketIoEvent.ITEM_EVENT, itemEvent);
|
||||||
|
emitInBatch(client, subMessage);
|
||||||
|
}
|
||||||
|
|
||||||
|
world.setItemState(itemEvent.itemId, itemEvent.state);
|
||||||
|
} catch (e) {
|
||||||
|
console.error('An error occurred on "item_event"');
|
||||||
|
console.error(e);
|
||||||
|
}*/
|
||||||
|
}
|
||||||
|
|
||||||
|
async handleReportMessage(client: ExSocketInterface, reportPlayerMessage: ReportPlayerMessage) {
|
||||||
|
try {
|
||||||
|
const reportedSocket = this.sockets.get(reportPlayerMessage.getReporteduserid());
|
||||||
|
if (!reportedSocket) {
|
||||||
|
throw 'reported socket user not found';
|
||||||
|
}
|
||||||
|
//TODO report user on admin application
|
||||||
|
await adminApi.reportPlayer(reportedSocket.userUuid, reportPlayerMessage.getReportcomment(), client.userUuid)
|
||||||
|
} catch (e) {
|
||||||
|
console.error('An error occurred on "handleReportMessage"');
|
||||||
|
console.error(e);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
emitVideo(socket: ExSocketInterface, data: WebRtcSignalToServerMessage): void {
|
||||||
|
const pusherToBackMessage = new PusherToBackMessage();
|
||||||
|
pusherToBackMessage.setWebrtcsignaltoservermessage(data);
|
||||||
|
|
||||||
|
socket.backConnection.write(pusherToBackMessage);
|
||||||
|
|
||||||
|
|
||||||
|
//send only at user
|
||||||
|
/*const client = this.sockets.get(data.getReceiverid());
|
||||||
|
if (client === undefined) {
|
||||||
|
console.warn("While exchanging a WebRTC signal: client with id ", data.getReceiverid(), " does not exist. This might be a race condition.");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const webrtcSignalToClient = new WebRtcSignalToClientMessage();
|
||||||
|
webrtcSignalToClient.setUserid(socket.userId);
|
||||||
|
webrtcSignalToClient.setSignal(data.getSignal());
|
||||||
|
|
||||||
|
const serverToClientMessage = new ServerToClientMessage();
|
||||||
|
serverToClientMessage.setWebrtcsignaltoclientmessage(webrtcSignalToClient);
|
||||||
|
|
||||||
|
if (!client.disconnecting) {
|
||||||
|
client.send(serverToClientMessage.serializeBinary().buffer, true);
|
||||||
|
}*/
|
||||||
|
}
|
||||||
|
|
||||||
|
emitScreenSharing(socket: ExSocketInterface, data: WebRtcSignalToServerMessage): void {
|
||||||
|
const pusherToBackMessage = new PusherToBackMessage();
|
||||||
|
pusherToBackMessage.setWebrtcscreensharingsignaltoservermessage(data);
|
||||||
|
|
||||||
|
socket.backConnection.write(pusherToBackMessage);
|
||||||
|
|
||||||
|
//send only at user
|
||||||
|
/*const client = this.sockets.get(data.getReceiverid());
|
||||||
|
if (client === undefined) {
|
||||||
|
console.warn("While exchanging a WEBRTC_SCREEN_SHARING signal: client with id ", data.getReceiverid(), " does not exist. This might be a race condition.");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const webrtcSignalToClient = new WebRtcSignalToClientMessage();
|
||||||
|
webrtcSignalToClient.setUserid(socket.userId);
|
||||||
|
webrtcSignalToClient.setSignal(data.getSignal());
|
||||||
|
|
||||||
|
const serverToClientMessage = new ServerToClientMessage();
|
||||||
|
serverToClientMessage.setWebrtcscreensharingsignaltoclientmessage(webrtcSignalToClient);
|
||||||
|
|
||||||
|
if (!client.disconnecting) {
|
||||||
|
client.send(serverToClientMessage.serializeBinary().buffer, true);
|
||||||
|
}*/
|
||||||
|
}
|
||||||
|
|
||||||
|
private searchClientByIdOrFail(userId: number): ExSocketInterface {
|
||||||
|
const client: ExSocketInterface|undefined = this.sockets.get(userId);
|
||||||
|
if (client === undefined) {
|
||||||
|
throw new Error("Could not find user with id " + userId);
|
||||||
|
}
|
||||||
|
return client;
|
||||||
|
}
|
||||||
|
|
||||||
|
leaveRoom(socket : ExSocketInterface) {
|
||||||
|
// leave previous room and world
|
||||||
|
try {
|
||||||
|
if (socket.roomId) {
|
||||||
|
try {
|
||||||
|
//user leaves room
|
||||||
|
const room: PusherRoom | undefined = this.Worlds.get(socket.roomId);
|
||||||
|
if (room) {
|
||||||
|
debug('Leaving room %s.', socket.roomId);
|
||||||
|
room.leave(socket);
|
||||||
|
if (room.isEmpty()) {
|
||||||
|
this.Worlds.delete(socket.roomId);
|
||||||
|
debug('Room %s is empty. Deleting.', socket.roomId);
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
console.error('Could not find the GameRoom the user is leaving!');
|
||||||
|
}
|
||||||
|
//user leave previous room
|
||||||
|
//Client.leave(Client.roomId);
|
||||||
|
} finally {
|
||||||
|
//delete Client.roomId;
|
||||||
|
this.sockets.delete(socket.userId);
|
||||||
|
clientEventsEmitter.emitClientLeave(socket.userUuid, socket.roomId);
|
||||||
|
console.log('A user left (', this.sockets.size, ' connected users)');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} finally {
|
||||||
|
if (socket.backConnection) {
|
||||||
|
socket.backConnection.end();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async getOrCreateRoom(roomId: string): Promise<PusherRoom> {
|
||||||
|
//check and create new world for a room
|
||||||
|
let world = this.Worlds.get(roomId)
|
||||||
|
if(world === undefined){
|
||||||
|
world = new PusherRoom(
|
||||||
|
roomId,
|
||||||
|
this
|
||||||
|
/* (user: User, group: Group) => this.joinWebRtcRoom(user, group),
|
||||||
|
(user: User, group: Group) => this.disConnectedUser(user, group),
|
||||||
|
MINIMUM_DISTANCE,
|
||||||
|
GROUP_RADIUS,
|
||||||
|
(thing: Movable, listener: User) => this.onRoomEnter(thing, listener),
|
||||||
|
(thing: Movable, position:PositionInterface, listener:User) => this.onClientMove(thing, position, listener),
|
||||||
|
(thing: Movable, listener:User) => this.onClientLeave(thing, listener)*/
|
||||||
|
);
|
||||||
|
if (!world.anonymous) {
|
||||||
|
const data = await adminApi.fetchMapDetails(world.organizationSlug, world.worldSlug, world.roomSlug)
|
||||||
|
world.tags = data.tags
|
||||||
|
world.policyType = Number(data.policy_type)
|
||||||
|
}
|
||||||
|
this.Worlds.set(roomId, world);
|
||||||
|
}
|
||||||
|
return Promise.resolve(world)
|
||||||
|
}
|
||||||
|
|
||||||
|
/* private joinRoom(client : ExSocketInterface, position: PointInterface): PusherRoom {
|
||||||
|
|
||||||
|
const roomId = client.roomId;
|
||||||
|
client.position = position;
|
||||||
|
|
||||||
|
const world = this.Worlds.get(roomId)
|
||||||
|
if(world === undefined){
|
||||||
|
throw new Error('Could not find room for ID: '+client.roomId)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Dispatch groups position to newly connected user
|
||||||
|
world.getGroups().forEach((group: Group) => {
|
||||||
|
this.emitCreateUpdateGroupEvent(client, group);
|
||||||
|
});
|
||||||
|
//join world
|
||||||
|
world.join(client, client.position);
|
||||||
|
clientEventsEmitter.emitClientJoin(client.userUuid, client.roomId);
|
||||||
|
console.log(new Date().toISOString() + ' A user joined (', this.sockets.size, ' connected users)');
|
||||||
|
return world;
|
||||||
|
}
|
||||||
|
|
||||||
|
private onClientMove(thing: Movable, position:PositionInterface, listener:User): void {
|
||||||
|
const clientListener = this.searchClientByIdOrFail(listener.id);
|
||||||
|
if (thing instanceof User) {
|
||||||
|
const clientUser = this.searchClientByIdOrFail(thing.id);
|
||||||
|
|
||||||
|
const userMovedMessage = new UserMovedMessage();
|
||||||
|
userMovedMessage.setUserid(clientUser.userId);
|
||||||
|
userMovedMessage.setPosition(ProtobufUtils.toPositionMessage(clientUser.position));
|
||||||
|
|
||||||
|
const subMessage = new SubMessage();
|
||||||
|
subMessage.setUsermovedmessage(userMovedMessage);
|
||||||
|
|
||||||
|
clientListener.emitInBatch(subMessage);
|
||||||
|
//console.log("Sending USER_MOVED event");
|
||||||
|
} else if (thing instanceof Group) {
|
||||||
|
this.emitCreateUpdateGroupEvent(clientListener, thing);
|
||||||
|
} else {
|
||||||
|
console.error('Unexpected type for Movable.');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private onClientLeave(thing: Movable, listener:User) {
|
||||||
|
const clientListener = this.searchClientByIdOrFail(listener.id);
|
||||||
|
if (thing instanceof User) {
|
||||||
|
const clientUser = this.searchClientByIdOrFail(thing.id);
|
||||||
|
this.emitUserLeftEvent(clientListener, clientUser.userId);
|
||||||
|
} else if (thing instanceof Group) {
|
||||||
|
this.emitDeleteGroupEvent(clientListener, thing.getId());
|
||||||
|
} else {
|
||||||
|
console.error('Unexpected type for Movable.');
|
||||||
|
}
|
||||||
|
}*/
|
||||||
|
|
||||||
|
private emitCreateUpdateGroupEvent(client: ExSocketInterface, group: Group): void {
|
||||||
|
const position = group.getPosition();
|
||||||
|
const pointMessage = new PointMessage();
|
||||||
|
pointMessage.setX(Math.floor(position.x));
|
||||||
|
pointMessage.setY(Math.floor(position.y));
|
||||||
|
const groupUpdateMessage = new GroupUpdateMessage();
|
||||||
|
groupUpdateMessage.setGroupid(group.getId());
|
||||||
|
groupUpdateMessage.setPosition(pointMessage);
|
||||||
|
groupUpdateMessage.setGroupsize(group.getSize);
|
||||||
|
|
||||||
|
const subMessage = new SubMessage();
|
||||||
|
subMessage.setGroupupdatemessage(groupUpdateMessage);
|
||||||
|
|
||||||
|
emitInBatch(client, subMessage);
|
||||||
|
//socket.emit(SocketIoEvent.GROUP_CREATE_UPDATE, groupUpdateMessage.serializeBinary().buffer);
|
||||||
|
}
|
||||||
|
|
||||||
|
private emitDeleteGroupEvent(client: ExSocketInterface, groupId: number): void {
|
||||||
|
const groupDeleteMessage = new GroupDeleteMessage();
|
||||||
|
groupDeleteMessage.setGroupid(groupId);
|
||||||
|
|
||||||
|
const subMessage = new SubMessage();
|
||||||
|
subMessage.setGroupdeletemessage(groupDeleteMessage);
|
||||||
|
|
||||||
|
emitInBatch(client, subMessage);
|
||||||
|
}
|
||||||
|
|
||||||
|
private emitUserLeftEvent(client: ExSocketInterface, userId: number): void {
|
||||||
|
const userLeftMessage = new UserLeftMessage();
|
||||||
|
userLeftMessage.setUserid(userId);
|
||||||
|
|
||||||
|
const subMessage = new SubMessage();
|
||||||
|
subMessage.setUserleftmessage(userLeftMessage);
|
||||||
|
|
||||||
|
emitInBatch(client, subMessage);
|
||||||
|
}
|
||||||
|
|
||||||
|
private joinWebRtcRoom(user: User, group: Group) {
|
||||||
|
/*const roomId: string = "webrtcroom"+group.getId();
|
||||||
|
if (user.socket.webRtcRoomId === roomId) {
|
||||||
|
return;
|
||||||
|
}*/
|
||||||
|
|
||||||
|
for (const otherUser of group.getUsers()) {
|
||||||
|
if (user === otherUser) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Let's send 2 messages: one to the user joining the group and one to the other user
|
||||||
|
const webrtcStartMessage1 = new WebRtcStartMessage();
|
||||||
|
webrtcStartMessage1.setUserid(otherUser.id);
|
||||||
|
webrtcStartMessage1.setName(otherUser.socket.name);
|
||||||
|
webrtcStartMessage1.setInitiator(true);
|
||||||
|
|
||||||
|
const serverToClientMessage1 = new ServerToClientMessage();
|
||||||
|
serverToClientMessage1.setWebrtcstartmessage(webrtcStartMessage1);
|
||||||
|
|
||||||
|
if (!user.socket.disconnecting) {
|
||||||
|
user.socket.send(serverToClientMessage1.serializeBinary().buffer, true);
|
||||||
|
//console.log('Sending webrtcstart initiator to '+user.socket.userId)
|
||||||
|
}
|
||||||
|
|
||||||
|
const webrtcStartMessage2 = new WebRtcStartMessage();
|
||||||
|
webrtcStartMessage2.setUserid(user.id);
|
||||||
|
webrtcStartMessage2.setName(user.socket.name);
|
||||||
|
webrtcStartMessage2.setInitiator(false);
|
||||||
|
|
||||||
|
const serverToClientMessage2 = new ServerToClientMessage();
|
||||||
|
serverToClientMessage2.setWebrtcstartmessage(webrtcStartMessage2);
|
||||||
|
|
||||||
|
if (!otherUser.socket.disconnecting) {
|
||||||
|
otherUser.socket.send(serverToClientMessage2.serializeBinary().buffer, true);
|
||||||
|
//console.log('Sending webrtcstart to '+otherUser.socket.userId)
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
//disconnect user
|
||||||
|
private disConnectedUser(user: User, group: Group) {
|
||||||
|
// Most of the time, sending a disconnect event to one of the players is enough (the player will close the connection
|
||||||
|
// which will be shut for the other player).
|
||||||
|
// However! In the rare case where the WebRTC connection is not yet established, if we close the connection on one of the player,
|
||||||
|
// the other player will try connecting until a timeout happens (during this time, the connection icon will be displayed for nothing).
|
||||||
|
// So we also send the disconnect event to the other player.
|
||||||
|
for (const otherUser of group.getUsers()) {
|
||||||
|
if (user === otherUser) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
const webrtcDisconnectMessage1 = new WebRtcDisconnectMessage();
|
||||||
|
webrtcDisconnectMessage1.setUserid(user.id);
|
||||||
|
|
||||||
|
const serverToClientMessage1 = new ServerToClientMessage();
|
||||||
|
serverToClientMessage1.setWebrtcdisconnectmessage(webrtcDisconnectMessage1);
|
||||||
|
|
||||||
|
if (!otherUser.socket.disconnecting) {
|
||||||
|
otherUser.socket.send(serverToClientMessage1.serializeBinary().buffer, true);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
const webrtcDisconnectMessage2 = new WebRtcDisconnectMessage();
|
||||||
|
webrtcDisconnectMessage2.setUserid(otherUser.id);
|
||||||
|
|
||||||
|
const serverToClientMessage2 = new ServerToClientMessage();
|
||||||
|
serverToClientMessage2.setWebrtcdisconnectmessage(webrtcDisconnectMessage2);
|
||||||
|
|
||||||
|
if (!user.socket.disconnecting) {
|
||||||
|
user.socket.send(serverToClientMessage2.serializeBinary().buffer, true);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
emitPlayGlobalMessage(client: ExSocketInterface, playglobalmessage: PlayGlobalMessage) {
|
||||||
|
const pusherToBackMessage = new PusherToBackMessage();
|
||||||
|
pusherToBackMessage.setPlayglobalmessage(playglobalmessage);
|
||||||
|
|
||||||
|
client.backConnection.write(pusherToBackMessage);
|
||||||
|
}
|
||||||
|
|
||||||
|
public getWorlds(): Map<string, PusherRoom> {
|
||||||
|
return this.Worlds;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
* @param token
|
||||||
|
*/
|
||||||
|
searchClientByUuid(uuid: string): ExSocketInterface | null {
|
||||||
|
for(const socket of this.sockets.values()){
|
||||||
|
if(socket.userUuid === uuid){
|
||||||
|
return socket;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
public handleQueryJitsiJwtMessage(client: ExSocketInterface, queryJitsiJwtMessage: QueryJitsiJwtMessage) {
|
||||||
|
const room = queryJitsiJwtMessage.getJitsiroom();
|
||||||
|
const tag = queryJitsiJwtMessage.getTag(); // FIXME: this is not secure. We should load the JSON for the current room and check rights associated to room instead.
|
||||||
|
|
||||||
|
if (SECRET_JITSI_KEY === '') {
|
||||||
|
throw new Error('You must set the SECRET_JITSI_KEY key to the secret to generate JWT tokens for Jitsi.');
|
||||||
|
}
|
||||||
|
|
||||||
|
// Let's see if the current client has
|
||||||
|
const isAdmin = client.tags.includes(tag);
|
||||||
|
|
||||||
|
const jwt = Jwt.sign({
|
||||||
|
"aud": "jitsi",
|
||||||
|
"iss": JITSI_ISS,
|
||||||
|
"sub": JITSI_URL,
|
||||||
|
"room": room,
|
||||||
|
"moderator": isAdmin
|
||||||
|
}, SECRET_JITSI_KEY, {
|
||||||
|
expiresIn: '1d',
|
||||||
|
algorithm: "HS256",
|
||||||
|
header:
|
||||||
|
{
|
||||||
|
"alg": "HS256",
|
||||||
|
"typ": "JWT"
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
const sendJitsiJwtMessage = new SendJitsiJwtMessage();
|
||||||
|
sendJitsiJwtMessage.setJitsiroom(room);
|
||||||
|
sendJitsiJwtMessage.setJwt(jwt);
|
||||||
|
|
||||||
|
const serverToClientMessage = new ServerToClientMessage();
|
||||||
|
serverToClientMessage.setSendjitsijwtmessage(sendJitsiJwtMessage);
|
||||||
|
|
||||||
|
client.send(serverToClientMessage.serializeBinary().buffer, true);
|
||||||
|
}
|
||||||
|
|
||||||
|
public emitSendUserMessage(messageToSend: {userUuid: string, message: string, type: string}): ExSocketInterface {
|
||||||
|
const socket = this.searchClientByUuid(messageToSend.userUuid);
|
||||||
|
if(!socket){
|
||||||
|
throw 'socket was not found';
|
||||||
|
}
|
||||||
|
|
||||||
|
const sendUserMessage = new SendUserMessage();
|
||||||
|
sendUserMessage.setMessage(messageToSend.message);
|
||||||
|
sendUserMessage.setType(messageToSend.type);
|
||||||
|
|
||||||
|
const serverToClientMessage = new ServerToClientMessage();
|
||||||
|
serverToClientMessage.setSendusermessage(sendUserMessage);
|
||||||
|
|
||||||
|
if (!socket.disconnecting) {
|
||||||
|
socket.send(serverToClientMessage.serializeBinary().buffer, true);
|
||||||
|
}
|
||||||
|
return socket;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Merges the characterLayers received from the front (as an array of string) with the custom textures from the back.
|
||||||
|
*/
|
||||||
|
static mergeCharacterLayersAndCustomTextures(characterLayers: string[], memberTextures: CharacterTexture[]): CharacterLayer[] {
|
||||||
|
const characterLayerObjs: CharacterLayer[] = [];
|
||||||
|
for (const characterLayer of characterLayers) {
|
||||||
|
if (characterLayer.startsWith('customCharacterTexture')) {
|
||||||
|
const customCharacterLayerId: number = +characterLayer.substr(22);
|
||||||
|
for (const memberTexture of memberTextures) {
|
||||||
|
if (memberTexture.id == customCharacterLayerId) {
|
||||||
|
characterLayerObjs.push({
|
||||||
|
name: characterLayer,
|
||||||
|
url: memberTexture.url
|
||||||
|
})
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
characterLayerObjs.push({
|
||||||
|
name: characterLayer,
|
||||||
|
url: undefined
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return characterLayerObjs;
|
||||||
|
}
|
||||||
|
|
||||||
|
public onUserEnters(user: UserDescriptor, listener: ExSocketInterface): void {
|
||||||
|
const subMessage = new SubMessage();
|
||||||
|
subMessage.setUserjoinedmessage(user.toUserJoinedMessage());
|
||||||
|
|
||||||
|
emitInBatch(listener, subMessage);
|
||||||
|
}
|
||||||
|
|
||||||
|
public onUserMoves(user: UserDescriptor, listener: ExSocketInterface): void {
|
||||||
|
const subMessage = new SubMessage();
|
||||||
|
subMessage.setUsermovedmessage(user.toUserMovedMessage());
|
||||||
|
|
||||||
|
emitInBatch(listener, subMessage);
|
||||||
|
}
|
||||||
|
|
||||||
|
public onUserLeaves(userId: number, listener: ExSocketInterface): void {
|
||||||
|
const userLeftMessage = new UserLeftMessage();
|
||||||
|
userLeftMessage.setUserid(userId);
|
||||||
|
|
||||||
|
const subMessage = new SubMessage();
|
||||||
|
subMessage.setUserleftmessage(userLeftMessage);
|
||||||
|
|
||||||
|
emitInBatch(listener, subMessage);
|
||||||
|
}
|
||||||
|
|
||||||
|
public onGroupEnters(group: GroupDescriptor, listener: ExSocketInterface): void {
|
||||||
|
const subMessage = new SubMessage();
|
||||||
|
subMessage.setGroupupdatemessage(group.toGroupUpdateMessage());
|
||||||
|
|
||||||
|
emitInBatch(listener, subMessage);
|
||||||
|
}
|
||||||
|
|
||||||
|
public onGroupMoves(group: GroupDescriptor, listener: ExSocketInterface): void {
|
||||||
|
this.onGroupEnters(group, listener);
|
||||||
|
}
|
||||||
|
|
||||||
|
public onGroupLeaves(groupId: number, listener: ExSocketInterface): void {
|
||||||
|
const groupDeleteMessage = new GroupDeleteMessage();
|
||||||
|
groupDeleteMessage.setGroupid(groupId);
|
||||||
|
|
||||||
|
const subMessage = new SubMessage();
|
||||||
|
subMessage.setGroupdeletemessage(groupDeleteMessage);
|
||||||
|
|
||||||
|
emitInBatch(listener, subMessage);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export const socketManager = new SocketManager();
|
72
uploader/tsconfig.json
Normal file
72
uploader/tsconfig.json
Normal file
@ -0,0 +1,72 @@
|
|||||||
|
{
|
||||||
|
"compilerOptions": {
|
||||||
|
"experimentalDecorators": true,
|
||||||
|
/* Basic Options */
|
||||||
|
// "incremental": true, /* Enable incremental compilation */
|
||||||
|
"target": "es5", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
|
||||||
|
"downlevelIteration": true,
|
||||||
|
"module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
|
||||||
|
// "lib": [], /* Specify library files to be included in the compilation. */
|
||||||
|
"allowJs": true, /* Allow javascript files to be compiled. */
|
||||||
|
// "checkJs": true, /* Report errors in .js files. */
|
||||||
|
// "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
|
||||||
|
// "declaration": true, /* Generates corresponding '.d.ts' file. */
|
||||||
|
// "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */
|
||||||
|
"sourceMap": true, /* Generates corresponding '.map' file. */
|
||||||
|
// "outFile": "./", /* Concatenate and emit output to single file. */
|
||||||
|
"outDir": "./dist", /* Redirect output structure to the directory. */
|
||||||
|
// "rootDir": "./", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
|
||||||
|
// "composite": true, /* Enable project compilation */
|
||||||
|
// "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */
|
||||||
|
// "removeComments": true, /* Do not emit comments to output. */
|
||||||
|
// "noEmit": true, /* Do not emit outputs. */
|
||||||
|
// "importHelpers": true, /* Import emit helpers from 'tslib'. */
|
||||||
|
// "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
|
||||||
|
// "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
|
||||||
|
|
||||||
|
/* Strict Type-Checking Options */
|
||||||
|
"strict": true, /* Enable all strict type-checking options. */
|
||||||
|
// "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */
|
||||||
|
// "strictNullChecks": true, /* Enable strict null checks. */
|
||||||
|
// "strictFunctionTypes": true, /* Enable strict checking of function types. */
|
||||||
|
// "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
|
||||||
|
// "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */
|
||||||
|
"noImplicitThis": false, /* Raise error on 'this' expressions with an implied 'any' type. */ // Disabled because of sifrr server that is monkey patching HttpResponse
|
||||||
|
// "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */
|
||||||
|
|
||||||
|
/* Additional Checks */
|
||||||
|
// "noUnusedLocals": true, /* Report errors on unused locals. */
|
||||||
|
// "noUnusedParameters": true, /* Report errors on unused parameters. */
|
||||||
|
"noImplicitReturns": true, /* Report error when not all code paths in function return a value. */
|
||||||
|
"noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */
|
||||||
|
|
||||||
|
/* Module Resolution Options */
|
||||||
|
"moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
|
||||||
|
"baseUrl": ".", /* Base directory to resolve non-absolute module names. */
|
||||||
|
"paths": {
|
||||||
|
"_Controller/*": ["src/Controller/*"],
|
||||||
|
"_Model/*": ["src/Model/*"],
|
||||||
|
"_Enum/*": ["src/Enum/*"]
|
||||||
|
}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
|
||||||
|
// "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */
|
||||||
|
// "typeRoots": [], /* List of folders to include type definitions from. */
|
||||||
|
// "types": [], /* Type declaration files to be included in compilation. */
|
||||||
|
// "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
|
||||||
|
"esModuleInterop": true, /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
|
||||||
|
// "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */
|
||||||
|
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
|
||||||
|
|
||||||
|
/* Source Map Options */
|
||||||
|
// "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */
|
||||||
|
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
|
||||||
|
// "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */
|
||||||
|
// "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
|
||||||
|
|
||||||
|
/* Experimental Options */
|
||||||
|
// "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */
|
||||||
|
// "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */
|
||||||
|
|
||||||
|
/* Advanced Options */
|
||||||
|
"forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */
|
||||||
|
}
|
||||||
|
}
|
2437
uploader/yarn.lock
Normal file
2437
uploader/yarn.lock
Normal file
File diff suppressed because it is too large
Load Diff
Loading…
Reference in New Issue
Block a user