sporada/nopaque
1
0
Fork 0
mirror of https://gitlab.ub.uni-bielefeld.de/sfb1288inf/nopaque.git synced 2025-11-04 04:12:45 +00:00
Code Issues Projects Releases Wiki Activity

Reorganize Socket.IO code

Browse Source
This commit is contained in:
Patrick Jentsch
2024-11-18 12:36:37 +01:00
parent 9f56647cf7
commit 1e5c26b8e3
13 changed files with 95 additions and 100 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
app/__init__.py
View File

@@ -132,9 +132,6 @@ def create_app(config: Config = Config) -> Flask:
# region SocketIO Namespaces
from .namespaces.cqi_over_sio import CQiOverSocketIONamespace
socketio.on_namespace(CQiOverSocketIONamespace('/cqi_over_sio'))
from .namespaces.users import UsersNamespace
socketio.on_namespace(UsersNamespace('/users'))
# endregion SocketIO Namespaces
# region Database event Listeners

2
app/blueprints/users/__init__.py
View File

@@ -15,4 +15,4 @@ def before_request():
pass
from . import cli, json_routes, routes, settings
from . import cli, events, json_routes, routes, settings

82
app/blueprints/users/events.py Normal file
View File

@@ -0,0 +1,82 @@
from flask_login import current_user
from flask_socketio import join_room, leave_room
from app import hashids, socketio
from app.decorators import socketio_login_required
from app.models import User
@socketio.on('users.get_user')
@socketio_login_required
def get_user(user_hashid: str) -> dict:
user_id = hashids.decode(user_hashid)
if not isinstance(user_id, int):
return {'status': 400, 'statusText': 'Bad Request'}
user = User.query.get(user_id)
if user is None:
return {'status': 404, 'statusText': 'Not found'}
if not (
user == current_user
or current_user.is_administrator
):
return {'status': 403, 'statusText': 'Forbidden'}
return {
'body': user.to_json_serializeable(
backrefs=True,
relationships=True
),
'status': 200,
'statusText': 'OK'
}
@socketio.on('users.subscribe_user')
@socketio_login_required
def subscribe_user(user_hashid: str) -> dict:
user_id = hashids.decode(user_hashid)
if not isinstance(user_id, int):
return {'status': 400, 'statusText': 'Bad Request'}
user = User.query.get(user_id)
if user is None:
return {'status': 404, 'statusText': 'Not found'}
if not (
user == current_user
or current_user.is_administrator
):
return {'status': 403, 'statusText': 'Forbidden'}
join_room(f'/users/{user.hashid}')
return {'status': 200, 'statusText': 'OK'}
@socketio.on('users.unsubscribe_user')
@socketio_login_required
def on_unsubscribe_user(user_hashid: str) -> dict:
user_id = hashids.decode(user_hashid)
if not isinstance(user_id, int):
return {'status': 400, 'statusText': 'Bad Request'}
user = User.query.get(user_id)
if user is None:
return {'status': 404, 'statusText': 'Not found'}
if not (
user == current_user
or current_user.is_administrator
):
return {'status': 403, 'statusText': 'Forbidden'}
leave_room(f'/users/{user.hashid}')
return {'status': 200, 'statusText': 'OK'}

78
app/namespaces/users/__init__.py
View File

@@ -1,78 +0,0 @@
from flask_login import current_user
from flask_socketio import join_room, leave_room, Namespace
from app import hashids
from app.decorators import socketio_login_required
from app.models import User
class UsersNamespace(Namespace):
@socketio_login_required
def on_get_user(self, user_hashid: str) -> dict:
user_id = hashids.decode(user_hashid)
if not isinstance(user_id, int):
return {'status': 400, 'statusText': 'Bad Request'}
user = User.query.get(user_id)
if user is None:
return {'status': 404, 'statusText': 'Not found'}
if not (
user == current_user
or current_user.is_administrator
):
return {'status': 403, 'statusText': 'Forbidden'}
return {
'body': user.to_json_serializeable(
backrefs=True,
relationships=True
),
'status': 200,
'statusText': 'OK'
}
@socketio_login_required
def on_subscribe_user(self, user_hashid: str) -> dict:
user_id = hashids.decode(user_hashid)
if not isinstance(user_id, int):
return {'status': 400, 'statusText': 'Bad Request'}
user = User.query.get(user_id)
if user is None:
return {'status': 404, 'statusText': 'Not found'}
if not (
user == current_user
or current_user.is_administrator
):
return {'status': 403, 'statusText': 'Forbidden'}
join_room(f'/users/{user.hashid}')
return {'status': 200, 'statusText': 'OK'}
@socketio_login_required
def on_unsubscribe_user(self, user_hashid: str) -> dict:
user_id = hashids.decode(user_hashid)
if not isinstance(user_id, int):
return {'status': 400, 'statusText': 'Bad Request'}
user = User.query.get(user_id)
if user is None:
return {'status': 404, 'statusText': 'Not found'}
if not (
user == current_user
or current_user.is_administrator
):
return {'status': 403, 'statusText': 'Forbidden'}
leave_room(f'/users/{user.hashid}')
return {'status': 200, 'statusText': 'OK'}

14
app/static/js/app.js
View File

@@ -11,11 +11,9 @@ nopaque.App = class App {
subscribeUser: {}
};
this.sockets = {
users: io('/users', {transports: ['websocket'], upgrade: false})
};
this.socket = io({transports: ['websocket'], upgrade: false});
this.sockets.users.on('patch_user', (patch) => {this.onPatch(patch);});
this.socket.on('patch_user', (patch) => {this.onPatch(patch);});
}
getUser(userId) {
@@ -23,10 +21,8 @@ nopaque.App = class App {
return this.#promises.getUser[userId];
}
let socket = this.sockets.users;
this.#promises.getUser[userId] = new Promise((resolve, reject) => {
socket.emit('get_user', userId, (response) => {
this.socket.emit('users.get_user', userId, (response) => {
if (response.status === 200) {
this.data.users[userId] = response.body;
resolve(this.data.users[userId]);
@@ -44,10 +40,8 @@ nopaque.App = class App {
return this.#promises.subscribeUser[userId];
}
let socket = this.sockets.users;
this.#promises.subscribeUser[userId] = new Promise((resolve, reject) => {
socket.emit('subscribe_user', userId, (response) => {
this.socket.emit('users.subscribe_user', userId, (response) => {
if (response.status === 200) {
resolve(response);
} else {

2
app/static/js/resource-displays/resource-display.js
View File

@@ -8,7 +8,7 @@ nopaque.resource_displays.ResourceDisplay = class ResourceDisplay {
if (this.userId) {
app.subscribeUser(this.userId)
.then((response) => {
app.sockets.users.on('patch_user', (patch) => {
app.socket.on('patch_user', (patch) => {
if (this.isInitialized) {this.onPatch(patch);}
});
});

2
app/static/js/resource-lists/corpus-file-list.js
View File

@@ -15,7 +15,7 @@ nopaque.resource_lists.CorpusFileList = class CorpusFileList extends nopaque.res
this.hasPermissionManageFiles = listContainerElement.dataset?.hasPermissionManageFiles == 'true' || false;
if (this.userId === undefined || this.corpusId === undefined) {return;}
app.subscribeUser(this.userId).then((response) => {
app.sockets.users.on('patch_user', (patch) => {
app.socket.on('patch_user', (patch) => {
if (this.isInitialized) {this.onPatch(patch);}
});
});

2
app/static/js/resource-lists/corpus-follower-list.js
View File

@@ -13,7 +13,7 @@ nopaque.resource_lists.CorpusFollowerList = class CorpusFollowerList extends nop
this.corpusId = listContainerElement.dataset.corpusId;
if (this.userId === undefined || this.corpusId === undefined) {return;}
app.subscribeUser(this.userId).then((response) => {
app.sockets.users.on('patch_user', (patch) => {
app.socket.on('patch_user', (patch) => {
if (this.isInitialized) {this.onPatch(patch);}
});
});

2
app/static/js/resource-lists/corpus-list.js
View File

@@ -12,7 +12,7 @@ nopaque.resource_lists.CorpusList = class CorpusList extends nopaque.resource_li
this.userId = listContainerElement.dataset.userId;
if (this.userId === undefined) {return;}
app.subscribeUser(this.userId).then((response) => {
app.sockets.users.on('patch_user', (patch) => {
app.socket.on('patch_user', (patch) => {
if (this.isInitialized) {this.onPatch(patch);}
});
});

2
app/static/js/resource-lists/job-list.js
View File

@@ -13,7 +13,7 @@ nopaque.resource_lists.JobList = class JobList extends nopaque.resource_lists.Re
this.userId = listContainerElement.dataset.userId;
if (this.userId === undefined) {return;}
app.subscribeUser(this.userId).then((response) => {
app.sockets.users.on('patch_user', (patch) => {
app.socket.on('patch_user', (patch) => {
if (this.isInitialized) {this.onPatch(patch);}
});
});

2
app/static/js/resource-lists/job-result-list.js
View File

@@ -9,7 +9,7 @@ nopaque.resource_lists.JobResultList = class JobResultList extends nopaque.resou
this.jobId = listContainerElement.dataset.jobId;
if (this.userId === undefined || this.jobId === undefined) {return;}
app.subscribeUser(this.userId).then((response) => {
app.sockets.users.on('patch_user', (patch) => {
app.socket.on('patch_user', (patch) => {
if (this.isInitialized) {this.onPatch(patch);}
});
});

2
app/static/js/resource-lists/spacy-nlp-pipeline-model-list.js
View File

@@ -9,7 +9,7 @@ nopaque.resource_lists.SpaCyNLPPipelineModelList = class SpaCyNLPPipelineModelLi
this.userId = listContainerElement.dataset.userId;
if (this.userId === undefined) {return;}
app.subscribeUser(this.userId).then((response) => {
app.sockets.users.on('patch_user', (patch) => {
app.socket.on('patch_user', (patch) => {
if (this.isInitialized) {this.onPatch(patch);}
});
});

2
app/static/js/resource-lists/tesseract-ocr-pipeline-model-list.js
View File

@@ -9,7 +9,7 @@ nopaque.resource_lists.TesseractOCRPipelineModelList = class TesseractOCRPipelin
this.userId = listContainerElement.dataset.userId;
if (this.userId === undefined) {return;}
app.subscribeUser(this.userId).then((response) => {
app.sockets.users.on('patch_user', (patch) => {
app.socket.on('patch_user', (patch) => {
if (this.isInitialized) {this.onPatch(patch);}
});
});