diff --git a/src/api/middleware.ts b/src/api/middleware.ts index ef292ac5f..66767de89 100644 --- a/src/api/middleware.ts +++ b/src/api/middleware.ts @@ -51,15 +51,15 @@ export function serveFavicon(config: Config) { debug('no read permissions to read: %o, reason:', logoConf, err?.message); return res.status(HTTP_STATUS.NOT_FOUND).end(); } else { - res.setHeader('Content-Type', 'image/x-icon'); + res.setHeader('content-type', 'image/x-icon'); fs.createReadStream(faviconPath).pipe(res); debug('rendered custom ico'); } }); } } else { - res.setHeader('Content-Type', 'image/x-icon'); - fs.createReadStream(path.join(__dirname, './web/html/favicon.ico')).pipe(res); + res.setHeader('content-type', 'image/x-icon'); + fs.createReadStream(path.posix.join(__dirname, './web/html/favicon.ico')).pipe(res); debug('rendered ico'); } } catch (err) { diff --git a/src/api/web/html/renderHTML.ts b/src/api/web/html/renderHTML.ts index c1eed8832..ed93611d7 100644 --- a/src/api/web/html/renderHTML.ts +++ b/src/api/web/html/renderHTML.ts @@ -1,9 +1,10 @@ import { URL } from 'url'; +import path from 'path'; import buildDebug from 'debug'; import LRU from 'lru-cache'; import { HEADERS } from '@verdaccio/commons-api'; -import { getPublicUrl } from '../../../lib/utils'; +import { getPublicUrl, isHTTPProtocol } from '../../../lib/utils'; import { WEB_TITLE } from '../../../lib/constants'; import renderTemplate from './template'; @@ -28,6 +29,18 @@ export function validatePrimaryColor(primaryColor) { return primaryColor; } +export function resolveLogo(config, req) { + const isLocalFile = config?.web?.logo && !isHTTPProtocol(config?.web?.logo); + + if (isLocalFile) { + return `${getPublicUrl(config?.url_prefix, req)}-/static/${path.basename(config?.web?.logo)}`; + } else if (isHTTPProtocol(config?.web?.logo)) { + return config?.web?.logo; + } else { + return ''; + } +} + export default function renderHTML(config, manifest, manifestFiles, req, res) { const { url_prefix } = config; const base = getPublicUrl(config?.url_prefix, req); @@ -36,7 +49,7 @@ export default function renderHTML(config, manifest, manifestFiles, req, res) { const darkMode = config?.web?.darkMode ?? false; const title = config?.web?.title ?? WEB_TITLE; const scope = config?.web?.scope ?? ''; - let logoURI = config?.web?.logo ?? ''; + const logoURI = resolveLogo(config, req); const version = pkgJSON.version; const primaryColor = validatePrimaryColor(config?.web?.primary_color) ?? '#4b5e40'; const { scriptsBodyAfter, metaScripts, scriptsbodyBefore } = Object.assign( diff --git a/src/api/web/index.ts b/src/api/web/index.ts index eab763ed5..d1a7978f9 100644 --- a/src/api/web/index.ts +++ b/src/api/web/index.ts @@ -1,10 +1,15 @@ +import fs from 'fs'; +import path from 'path'; import _ from 'lodash'; + import express from 'express'; import buildDebug from 'debug'; import Search from '../../lib/search'; import { HTTP_STATUS } from '../../lib/constants'; import loadPlugin from '../../lib/plugin-loader'; +import { isHTTPProtocol } from '../../lib/utils'; +import { logger } from '../../lib/logger'; import renderHTML from './html/renderHTML'; const { setSecurityWebHeaders } = require('../middleware'); @@ -66,14 +71,43 @@ export default function (config, auth, storage) { res.sendFile(file, sendFileCallback(next)); }); + // logo + if (config?.web?.logo && !isHTTPProtocol(config?.web?.logo)) { + // URI related to a local file + const absoluteLocalFile = path.posix.resolve(config.web.logo); + debug('serve local logo %s', absoluteLocalFile); + try { + if (fs.existsSync(absoluteLocalFile) && typeof fs.accessSync(absoluteLocalFile, fs.constants.R_OK) === 'undefined') { + // Note: `path.join` will break on Windows, because it transforms `/` to `\` + // Use POSIX version `path.posix.join` instead. + config.web.logo = path.posix.join('/-/static/', path.basename(config.web.logo)); + router.get(config.web.logo, function (_req, res, next) { + debug('serve custom logo web:%s - local:%s', config.web.logo, absoluteLocalFile); + res.sendFile(absoluteLocalFile, sendFileCallback(next)); + }); + debug('enabled custom logo %s', config.web.logo); + } else { + config.web.logo = undefined; + logger.warn(`web logo is wrong, path ${absoluteLocalFile} does not exist or is not readable`); + } + } catch { + config.web.logo = undefined; + logger.warn(`web logo is wrong, path ${absoluteLocalFile} does not exist or is not readable`); + } + } + router.get('/-/web/:section/*', function (req, res) { renderHTML(config, manifest, manifestFiles, req, res); debug('render html section'); }); - router.get('/', function (req, res) { - renderHTML(config, manifest, manifestFiles, req, res); - debug('render root'); + router.get('/', function (req, res, next) { + try { + renderHTML(config, manifest, manifestFiles, req, res); + debug('render root'); + } catch { + next(new Error('boom')); + } }); return router; diff --git a/test/unit/modules/web/__snapshots__/template.spec.ts.snap b/test/unit/modules/web/__snapshots__/template.spec.ts.snap index a372acb5e..cc961041e 100644 --- a/test/unit/modules/web/__snapshots__/template.spec.ts.snap +++ b/test/unit/modules/web/__snapshots__/template.spec.ts.snap @@ -50,6 +50,31 @@ exports[`template custom body before 1`] = ` " `; +exports[`template custom logo 1`] = ` +" + + + + + + + + + + + + + +
+ + + + + " +`; + exports[`template custom render 1`] = ` " diff --git a/test/unit/modules/web/template.spec.ts b/test/unit/modules/web/template.spec.ts index 3f3621685..03b37ee25 100644 --- a/test/unit/modules/web/template.spec.ts +++ b/test/unit/modules/web/template.spec.ts @@ -1,4 +1,4 @@ -import renderTemplate from "../../../../src/api/web/html/template"; +import renderTemplate from '../../../../src/api/web/html/template'; const manifest = require('./partials/manifest/manifest.json'); @@ -10,38 +10,36 @@ const exampleManifest = { describe('template', () => { test('custom render', () => { - expect(renderTemplate({ options: {base: 'http://domain.com'}, manifest: exampleManifest }, manifest)).toMatchSnapshot(); + expect(renderTemplate({ options: { base: 'http://domain.com' }, manifest: exampleManifest }, manifest)).toMatchSnapshot(); }); test('custom title', () => { - expect( - renderTemplate({ options: {base: 'http://domain.com', title: 'foo title' }, manifest: exampleManifest }, manifest) - ).toMatchSnapshot(); + expect(renderTemplate({ options: { base: 'http://domain.com', title: 'foo title' }, manifest: exampleManifest }, manifest)).toMatchSnapshot(); }); test('custom title', () => { - expect( - renderTemplate({ options: {base: 'http://domain.com', title: 'foo title' }, manifest: exampleManifest }, manifest) - ).toMatchSnapshot(); + expect(renderTemplate({ options: { base: 'http://domain.com', title: 'foo title' }, manifest: exampleManifest }, manifest)).toMatchSnapshot(); + }); + + test('custom logo', () => { + expect(renderTemplate({ options: { base: 'http://domain.com', logo: 'http://domain/logo.png' }, manifest: exampleManifest }, manifest)).toMatchSnapshot(); }); test('meta scripts', () => { expect( - renderTemplate({ options: {base: 'http://domain.com'}, metaScripts: [``], manifest: exampleManifest }, manifest) + renderTemplate({ options: { base: 'http://domain.com' }, metaScripts: [``], manifest: exampleManifest }, manifest) ).toMatchSnapshot(); }); test('custom body after', () => { - expect( - renderTemplate({ options: {base: 'http://domain.com'}, scriptsBodyAfter: [`