Nemcio/NodeBB
1
0
Fork 0
mirror of https://github.com/NodeBB/NodeBB.git synced 2026-05-07 14:16:25 +02:00
Code Issues Packages Projects Releases Wiki Activity

feat: screenshot upload in ACP, send fallback brand icons in manifest, serve assets for richer PWA install UI

Browse Source
This commit is contained in:
Julian Lam
2026-03-12 14:28:21 -04:00
parent 7903d17418
commit 75a6dfffdc
6 changed files with 101 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
src/controllers/admin/uploads.js
View File

@@ -198,7 +198,6 @@ uploadsController.uploadTouchIcon = async function (req, res, next) {
}
};
uploadsController.uploadMaskableIcon = async function (req, res, next) {
const uploadedFile = req.files[0];
const allowedTypes = ['image/png'];
@@ -214,6 +213,21 @@ uploadsController.uploadMaskableIcon = async function (req, res, next) {
}
};
uploadsController.uploadScreenshot = async function (req, res, next) {
const uploadedFile = req.files[0];
const allowedTypes = ['image/png', 'image/jpeg'];
await validateUpload(uploadedFile, allowedTypes);
try {
const imageObj = await file.saveFileToLocal('screenshot.png', 'system', uploadedFile.path);
res.json([{ name: uploadedFile.name, url: imageObj.url }]);
} catch (err) {
next(err);
} finally {
file.delete(uploadedFile.path);
}
};
uploadsController.uploadFile = async function (req, res, next) {
const uploadedFile = req.files[0];
let params;

68
src/controllers/index.js
View File

@@ -1,11 +1,14 @@
'use strict';
const path = require('path');
const nconf = require('nconf');
const validator = require('validator');
const mime = require('mime');
const meta = require('../meta');
const user = require('../user');
const plugins = require('../plugins');
const image = require('../image');
const privilegesHelpers = require('../privileges/helpers');
const helpers = require('./helpers');
@@ -271,6 +274,7 @@ Controllers.manifest = async function (req, res) {
const manifest = {
name: meta.config.title || 'NodeBB',
short_name: meta.config['title:short'] || meta.config.title || 'NodeBB',
...(meta.config.description && { description: meta.config.description }),
start_url: nconf.get('url'),
display: 'standalone',
orientation: 'portrait',
@@ -279,6 +283,33 @@ Controllers.manifest = async function (req, res) {
icons: [],
};
if (meta.config['brand:screenshot']) {
let sizes;
try {
const { width, height } = await image.size(path.join(nconf.get('base_dir'), meta.config['brand:screenshot'].replace('assets', 'public')));
sizes = `${width}x${height}`;
} catch (e) {
// noop
}
manifest.screenshots = [
{
src: `${nconf.get('relative_path')}${meta.config['brand:screenshot']}`,
...(sizes && { sizes }),
type: mime.getType(meta.config['brand:screenshot']),
},
];
} else {
manifest.screenshots = [
{
src: `${nconf.get('relative_path')}/assets/images/screenshot-default.png`,
sizes: '446x778',
type: 'image/png',
form_factor: 'narrow',
label: 'Default home page of a vanilla NodeBB installation.',
},
];
}
if (meta.config['brand:touchIcon']) {
manifest.icons.push({
src: `${nconf.get('relative_path')}/assets/uploads/system/touchicon-36.png`,
@@ -316,6 +347,43 @@ Controllers.manifest = async function (req, res) {
type: 'image/png',
density: 10.0,
});
} else {
manifest.icons.push({
src: `${nconf.get('relative_path')}/assets/images/touch/36.png`,
sizes: '36x36',
type: 'image/png',
density: 0.75,
}, {
src: `${nconf.get('relative_path')}/assets/images/touch/48.png`,
sizes: '48x48',
type: 'image/png',
density: 1.0,
}, {
src: `${nconf.get('relative_path')}/assets/images/touch/72.png`,
sizes: '72x72',
type: 'image/png',
density: 1.5,
}, {
src: `${nconf.get('relative_path')}/assets/images/touch/96.png`,
sizes: '96x96',
type: 'image/png',
density: 2.0,
}, {
src: `${nconf.get('relative_path')}/assets/images/touch/144.png`,
sizes: '144x144',
type: 'image/png',
density: 3.0,
}, {
src: `${nconf.get('relative_path')}/assets/images/touch/192.png`,
sizes: '192x192',
type: 'image/png',
density: 4.0,
}, {
src: `${nconf.get('relative_path')}/assets/images/touch/512.png`,
sizes: '512x512',
type: 'image/png',
density: 10.0,
});
}

1
src/privileges/admin.js
View File

@@ -67,6 +67,7 @@ privsAdmin.routeMap = {
uploadfavicon: 'admin:settings',
uploadTouchIcon: 'admin:settings',
uploadMaskableIcon: 'admin:settings',
uploadScreenshot: 'admin:settings',
uploadlogo: 'admin:settings',
uploadOgImage: 'admin:settings',
uploadDefaultAvatar: 'admin:settings',

1
src/routes/admin.js
View File

@@ -106,6 +106,7 @@ function apiRoutes(router, name, middleware, controllers) {
router.post(`/api/${name}/uploadfavicon`, middlewares, helpers.tryRoute(controllers.admin.uploads.uploadFavicon));
router.post(`/api/${name}/uploadTouchIcon`, middlewares, helpers.tryRoute(controllers.admin.uploads.uploadTouchIcon));
router.post(`/api/${name}/uploadMaskableIcon`, middlewares, helpers.tryRoute(controllers.admin.uploads.uploadMaskableIcon));
router.post(`/api/${name}/uploadScreenshot`, middlewares, helpers.tryRoute(controllers.admin.uploads.uploadScreenshot));
router.post(`/api/${name}/uploadlogo`, middlewares, helpers.tryRoute(controllers.admin.uploads.uploadLogo));
router.post(`/api/${name}/uploadOgImage`, middlewares, helpers.tryRoute(controllers.admin.uploads.uploadOgImage));
router.post(`/api/${name}/upload/file`, middlewares, helpers.tryRoute(controllers.admin.uploads.uploadFile));

13
src/views/admin/settings/general.tpl
View File

@@ -153,6 +153,19 @@
[[admin/settings/general:maskable-icon.help]]
</p>
</div>
<div class="mb-3">
<label class="form-label" for="screenshotUrl">[[admin/settings/general:screenshot]]</label>
<div class="d-flex gap-1">
<input id="screenshotUrl" type="text" class="form-control" data-field="brand:screenshot" />
<input data-action="upload" data-target="screenshotUrl" data-route="{config.relative_path}/api/admin/uploadScreenshot" type="button" class="btn btn-light" value="[[admin/settings/general:touch-icon.upload]]" />
<button data-action="removeMaskableIcon" type="button" class="btn btn-light"><i class="fa fa-trash text-danger"></i></button>
</div>
<p class="form-text">
[[admin/settings/general:screenshot.help]]
</p>
</div>
</div>
<hr/>