Add ranking freeze feature (#21)

* This reverts commit 627280a.

* This reverts commit 5284bdb.

* This reverts commit 688eded.

Dockerfile

@@ -12,6 +12,6 @@ COPY ./competition.yaml /etc/sok/
 
 ENV SOK_CONFIG=/etc/sok/competition.yaml
 
-EXPOSE 8080
+EXPOSE 3000
 
 CMD npm start

README.md

@@ -64,7 +64,7 @@ To get started with SOK API, follow these steps:
 
 Docker Compose will run the following containers:
 
--   **api** - The API server on `8080` port.
+-   **api** - The API server on `3000` port.
 -   **postgres** - PostgreSQL database server on port specified in `PG_PORT` environment variable.
 -   **pgadmin** - pgAdmin web interface on port `5050`.
 

competition.yaml

@@ -1,4 +1,6 @@
 title: mądrALO
 rules: <p>zasady 123123</p><p><br></p><p>123</p><p>zasady</p>
-startTime: 2023-09-06T20:55
-endTime: 2023-09-27T20:55
+startTime: 2024-04-12T20:55
+endTime: 2024-04-24T20:55
+freezeTime: 2024-04-22T00:00
+freeze: 'true'

docker-compose.yml

@@ -1,5 +1,3 @@
-version: '3.9'
-
 services:
     api:
         restart: on-failure
@@ -9,7 +7,7 @@ services:
         depends_on:
             - postgres
         ports:
-            - 8080:8080
+            - 3000:3000
         volumes:
             - ./:/app
 

index.js

@@ -9,7 +9,7 @@ const submitsRouter = require('./src/routes/submits.route');
 const competitionRouter = require('./src/routes/competition.route');
 
 const app = express();
-const port = 8080;
+const port = 3000;
 
 app.use(cors());
 app.use(

src/controllers/announcements.controller.js

@@ -1,5 +1,5 @@
 const pool = require('../services/db.service');
-const isAdmin = require('../utils/isAdmin');
+const isAdminUtil = require('../utils/isAdminUtil');
 
 const getCurrent = async (request, response) => {
     const results = await pool.query("SELECT * FROM announcements WHERE added <= now() AT TIME ZONE 'CEST' ORDER BY added DESC");
@@ -12,7 +12,7 @@ const getInactive = async (request, response) => {
         return response.status(403).send('Not permitted!');
     }
 
-    const admin = await isAdmin(id);
+    const admin = await isAdminUtil(id);
     if (!admin) {
         return response.status(403).send('Not permitted');
     }
@@ -30,7 +30,7 @@ const getById = async (request, response) => {
     const { annId } = request.query;
 
     let tmp = " AND added <= now() AT TIME ZONE 'CEST'";
-    const admin = await isAdmin(id);
+    const admin = await isAdminUtil(id);
     if (admin) {
         tmp = '';
     } else if (new Date(Date.parse(process.env.COMPETITION_START)) >= new Date().fixZone()) {
@@ -51,7 +51,7 @@ const getById = async (request, response) => {
 
 const add = async (request, response) => {
     const { id, title, content, author, added } = request.body;
-    const admin = await isAdmin(id);
+    const admin = await isAdminUtil(id);
     if (!admin) {
         return response.status(403).send('You have to be admin');
     }
@@ -70,7 +70,7 @@ const add = async (request, response) => {
 
 const edit = async (request, response) => {
     const { id, annId, title, content, author, added } = request.body;
-    const admin = await isAdmin(id);
+    const admin = await isAdminUtil(id);
     if (!admin) {
         return response.status(403).send('You have to be admin');
     }
@@ -89,7 +89,7 @@ const edit = async (request, response) => {
 
 const remove = async (request, response) => {
     const { id, annId } = request.body;
-    const admin = isAdmin(id);
+    const admin = isAdminUtil(id);
     if (!admin) {
         return response.status(403).send('You have to be admin');
     }

src/controllers/challenges.controller.js

@@ -1,7 +1,7 @@
 const fs = require('fs');
 const yaml = require('js-yaml');
 const pool = require('../services/db.service');
-const isAdmin = require('../utils/isAdmin');
+const isAdminUtil = require('../utils/isAdminUtil');
 const logSubmit = require('../utils/logSubmit');
 
 const competitionConf = yaml.load(fs.readFileSync(process.env.SOK_CONFIG, 'utf8'));
@@ -55,7 +55,7 @@ const compAnswers = async (chall, answer, usrId) => {
         const endTime = new Date(Date.parse(competitionConf.endTime));
         const currentTime = new Date().fixZone();
 
-        const admin = await isAdmin(usrId);
+        const admin = await isAdminUtil(usrId);
         if (admin) {
             if (chall.answer === answer) {
                 return { correct: true, info: '' };
@@ -93,7 +93,7 @@ const compAnswers = async (chall, answer, usrId) => {
 
 const getCurrent = async (request, response) => {
     const { id } = request.body;
-    const admin = await isAdmin(id);
+    const admin = await isAdminUtil(id);
     const startTime = new Date(Date.parse(competitionConf.startTime));
     const currentTime = new Date().fixZone();
 
@@ -117,7 +117,7 @@ const getInactive = async (request, response) => {
     if (!id) {
         return response.status(403).send('Not permited!');
     }
-    const admin = await isAdmin(id);
+    const admin = await isAdminUtil(id);
     if (!admin) {
         return response.status(403).send('Not permited');
     }
@@ -139,7 +139,7 @@ const getById = async (request, response) => {
     const startTime = new Date(Date.parse(competitionConf.startTime));
     const currentTime = new Date().fixZone();
 
-    const admin = await isAdmin(id);
+    const admin = await isAdminUtil(id);
     let tmp = " AND start <= now() AT TIME ZONE 'CEST'";
     if (admin) {
         tmp = '';
@@ -190,7 +190,7 @@ const sendAnswer = async (request, response) => {
 const correctAnswer = async (request, response) => {
     const { id } = request.body;
     const { challId } = request.query;
-    const admin = await isAdmin(id);
+    const admin = await isAdminUtil(id);
     if (!admin) {
         return response.status(403).send('You have to be admin');
     }
@@ -209,7 +209,7 @@ const correctAnswer = async (request, response) => {
 const add = async (request, response) => {
     const { id, title, content, author, points, answer, start } = request.body;
 
-    const admin = await isAdmin(id);
+    const admin = await isAdminUtil(id);
     if (!admin) {
         return response.status(403).send('You have to be admin');
     }
@@ -229,7 +229,7 @@ const add = async (request, response) => {
 const edit = async (request, response) => {
     const { id, title, content, author, points, answer, solves, start, challId } = request.body;
 
-    const admin = await isAdmin(id);
+    const admin = await isAdminUtil(id);
     if (!admin) {
         return response.status(403).send('You have to be admin');
     }
@@ -249,7 +249,7 @@ const edit = async (request, response) => {
 const remove = async (request, response) => {
     const { id, challId } = request.body;
 
-    const admin = await isAdmin(id);
+    const admin = await isAdminUtil(id);
     if (!admin) {
         return response.status(403).send('You have to be admin');
     }

src/controllers/competition.controller.js

@@ -2,7 +2,7 @@ const fs = require('fs');
 const yaml = require('js-yaml');
 const multer = require('multer');
 const path = require('path');
-const isAdmin = require('../utils/isAdmin');
+const isAdminUtil = require('../utils/isAdminUtil');
 
 const competitionConf = yaml.load(fs.readFileSync(process.env.SOK_CONFIG, 'utf8'));
 
@@ -14,17 +14,27 @@ const getTimeRange = (request, response) => {
     response.status(200).send({ start: competitionConf.startTime, end: competitionConf.endTime });
 };
 
+const getFreeze = (request, response) => {
+    response.status(200).send(competitionConf.freeze);
+};
+
+const getFreezeTime = (request, response) => {
+    response.status(200).send(competitionConf.freezeTime);
+};
+
 const edit = async (request, response) => {
-    const { id, title, rules, start, end } = request.body;
+    const { id, title, rules, start, end, freeze, freezeTime } = request.body;
 
-    const admin = await isAdmin(id);
+    const admin = await isAdminUtil(id);
     if (!admin) {
         return response.status(403).send('You dont have permissions');
     }
     competitionConf.title = title;
     competitionConf.rules = rules;
     competitionConf.startTime = start;
     competitionConf.endTime = end;
+    competitionConf.freeze = freeze;
+    competitionConf.freezeTime = freezeTime;
     fs.writeFileSync(process.env.SOK_CONFIG, yaml.dump(competitionConf));
     return response.status(201).send('Competition updated');
 };
@@ -43,7 +53,7 @@ const upload = multer({ storage });
 const uploadIcon = async (request, response) => {
     const { id } = request.body;
 
-    const admin = await isAdmin(id);
+    const admin = await isAdminUtil(id);
     if (!admin) {
         return response.status(403).send('You dont have permissions');
     }
@@ -64,6 +74,8 @@ module.exports = {
     getTitle,
     getRules,
     getTimeRange,
+    getFreeze,
+    getFreezeTime,
     edit,
     uploadIcon,
     icon,

src/controllers/submits.controller.js

@@ -1,9 +1,9 @@
 const pool = require('../services/db.service');
-const isAdmin = require('../utils/isAdmin');
+const isAdminUtil = require('../utils/isAdminUtil');
 
 const getAll = async (request, response) => {
     const { id } = request.body;
-    const admin = await isAdmin(id);
+    const admin = await isAdminUtil(id);
     if (!admin) {
         return response.status(403).send('You dont have permissions');
     }

src/controllers/users.controller.js

@@ -1,10 +1,14 @@
 const bcrypt = require('bcryptjs');
+const fs = require('fs');
+const yaml = require('js-yaml');
 const dotenv = require('dotenv');
 const jwt = require('jsonwebtoken');
 const nodemailer = require('nodemailer');
 const pool = require('../services/db.service');
+const isAdminUtil = require('../utils/isAdminUtil');
 
 dotenv.config();
+const competitionConf = yaml.load(fs.readFileSync(process.env.SOK_CONFIG, 'utf8'));
 
 const transporter = nodemailer.createTransport({
     host: process.env.SMTP_HOST,
@@ -173,25 +177,53 @@ const solves = async (request, response) => {
 };
 
 const ranking = async (request, response) => {
-    const dbRes = await pool.query(
-        `
-        SELECT
-            u.name,
-            COALESCE(SUM(CASE WHEN s.correct = true THEN c.points ELSE -1 END), 0) AS points
-        FROM
-            users u
-        JOIN
-            submits s ON u.id = s.usr_id
-        JOIN
-            challenges c ON s.chall_id = c.id
-        WHERE
-            admin = 0 AND verified = true
-        GROUP BY
-            u.id, u.name
-        ORDER BY
-            points DESC, MAX(s.sent) ASC, u.name;
-        `,
-    );
+    const { id } = request.body;
+    const admin = await isAdminUtil(id);
+    const freeze = competitionConf.endTime;
+    let dbRes;
+    if (freeze === 'true' && !admin) {
+        const freezeTime = new Date(Date.parse(competitionConf.freezeTime));
+        dbRes = await pool.query(
+            `
+            SELECT
+                u.name,
+                COALESCE(SUM(CASE WHEN s.correct = true THEN c.points ELSE -1 END), 0) AS points
+            FROM
+                users u
+            JOIN
+                submits s ON u.id = s.usr_id
+            JOIN
+                challenges c ON s.chall_id = c.id
+            WHERE
+                admin = 0 AND verified = true AND sent <= $1
+            GROUP BY
+                u.id, u.name
+            ORDER BY
+                points DESC, MAX(s.sent) ASC, u.name;
+            `,
+            [freezeTime.toISOString()],
+        );
+    } else {
+        dbRes = await pool.query(
+            `
+            SELECT
+                u.name,
+                COALESCE(SUM(CASE WHEN s.correct = true THEN c.points ELSE -1 END), 0) AS points
+            FROM
+                users u
+            JOIN
+                submits s ON u.id = s.usr_id
+            JOIN
+                challenges c ON s.chall_id = c.id
+            WHERE
+                admin = 0 AND verified = true
+            GROUP BY
+                u.id, u.name
+            ORDER BY
+                points DESC, MAX(s.sent) ASC, u.name;
+            `,
+        );
+    }
     const dbRows = dbRes.rows;
     for (let i = 0; i < dbRes.rows.length; i += 1) {
         dbRows[i].position = i + 1;

src/routes/competition.route.js

@@ -11,6 +11,8 @@ router.use('/uploadIcon', authenticateToken);
 router.get('/title', errorHandler(competitionController.getTitle));
 router.get('/rules', errorHandler(competitionController.getRules));
 router.get('/timeRange', errorHandler(competitionController.getTimeRange));
+router.get('/freeze', errorHandler(competitionController.getFreeze));
+router.get('/freezeTime', errorHandler(competitionController.getFreezeTime));
 router.get('/icon', errorHandler(competitionController.icon));
 
 router.post('/edit', errorHandler(competitionController.edit));

src/routes/users.route.js

@@ -7,6 +7,7 @@ const errorHandler = require('../middlewares/errorHandler');
 
 router.use('/solves', authenticateToken);
 router.use('/islogged', authenticateToken);
+router.use('/ranking', authenticateToken);
 router.use('/isAdmin', authenticateToken);
 
 router.get('/solves', errorHandler(usersController.solves));

src/utils/isAdmin.js → src/utils/isAdminUtil.js

@@ -1,11 +1,11 @@
 const pool = require('../services/db.service');
 
-const isAdmin = async (usrId) => {
+const isAdminUtil = async (usrId) => {
     const dbRes = await pool.query('SELECT admin FROM users WHERE id=$1 AND verified = true', [usrId]);
     if (!dbRes || !dbRes.rows || !dbRes.rows.length) {
         return false;
     }
     return dbRes.rows[0].admin === 2;
 };
 
-module.exports = isAdmin;
+module.exports = isAdminUtil;