mirror of
https://gh.wpcy.net/https://github.com/discourse/discourse.git
synced 2026-05-21 16:06:12 +08:00
98e62df173
In the admin search, links to site settings for plugins that are not using the new show page for plugins were pointing to the admin route for the plugin. This is not useful, because most plugins do not show their site settings here. Instead, we should link to the plugin category on the /admin/site_settings route.
442 lines
13 KiB
JavaScript
Vendored
442 lines
13 KiB
JavaScript
Vendored
import { tracked } from "@glimmer/tracking";
|
|
import Service, { service } from "@ember/service";
|
|
import { adminRouteValid } from "discourse/lib/admin-utilities";
|
|
import { ajax } from "discourse/lib/ajax";
|
|
import escapeRegExp from "discourse/lib/escape-regexp";
|
|
import getURL from "discourse/lib/get-url";
|
|
import PreloadStore from "discourse/lib/preload-store";
|
|
import I18n, { i18n } from "discourse-i18n";
|
|
import { ADMIN_SEARCH_RESULT_TYPES } from "admin/lib/constants";
|
|
|
|
const SEPARATOR = ">";
|
|
const MIN_FILTER_LENGTH = 2;
|
|
const MAX_TYPE_RESULT_COUNT_LOW = 15;
|
|
const MAX_TYPE_RESULT_COUNT_HIGH = 50;
|
|
|
|
const SEARCH_SCORES = {
|
|
labelStart: 20,
|
|
labelPartial: 15,
|
|
exactKeyword: 10,
|
|
partialKeyword: 7,
|
|
fallback: 5,
|
|
pageBonusScore: 20,
|
|
};
|
|
|
|
function labelOrText(obj, fallback = "") {
|
|
return obj.text || (obj.label ? i18n(obj.label) : fallback);
|
|
}
|
|
|
|
function buildKeywords(...keywords) {
|
|
return keywords
|
|
.map((kw) => {
|
|
if (Array.isArray(kw)) {
|
|
return kw.join(" ");
|
|
}
|
|
return kw;
|
|
})
|
|
.join(" ")
|
|
.toLowerCase();
|
|
}
|
|
|
|
export class PageLinkFormatter {
|
|
/**
|
|
* @param {DiscourseRouter} router - The ember router service
|
|
* @param {Object} navMapSection - The section of the admin nav map that the link belongs to,
|
|
* used for the parent label.
|
|
* @param {Object} link - The link object from the admin nav map, with name/route/label etc.
|
|
* @param {String} parentLabel - The parent label of the link, if any, this should be translated.
|
|
*/
|
|
constructor(router, navMapSection, link, parentLabel = null) {
|
|
this.router = router;
|
|
this.navMapSection = navMapSection;
|
|
this.link = link;
|
|
this.parentLabel = parentLabel;
|
|
}
|
|
|
|
format() {
|
|
let url;
|
|
if (this.link.route) {
|
|
if (this.link.routeModels) {
|
|
url = this.router.urlFor(this.link.route, ...this.link.routeModels);
|
|
} else {
|
|
url = this.router.urlFor(this.link.route);
|
|
}
|
|
} else if (this.link.href) {
|
|
url = getURL(this.link.href);
|
|
}
|
|
|
|
const sectionLabel = labelOrText(this.navMapSection);
|
|
const linkLabel = labelOrText(this.link);
|
|
|
|
let label;
|
|
if (this.parentLabel) {
|
|
label = `${this.parentLabel} ${SEPARATOR} ${linkLabel}`;
|
|
} else {
|
|
label = sectionLabel;
|
|
if (sectionLabel !== linkLabel) {
|
|
label = label + (sectionLabel ? ` ${SEPARATOR} ` : "") + linkLabel;
|
|
}
|
|
}
|
|
|
|
let keywords = this.link.keywords
|
|
? i18n(this.link.keywords).toLowerCase().replaceAll("|", " ")
|
|
: "";
|
|
const description = this.link.description
|
|
? this.link.description.includes(" ")
|
|
? this.link.description
|
|
: i18n(this.link.description)
|
|
: "";
|
|
|
|
keywords = buildKeywords(
|
|
keywords,
|
|
url,
|
|
label.replace(SEPARATOR, "").toLowerCase().replace(/ +/g, " "),
|
|
description
|
|
);
|
|
|
|
return { url, label, keywords, description };
|
|
}
|
|
}
|
|
|
|
export class SettingLinkFormatter {
|
|
/**
|
|
* @param {DiscourseRouter} router - The ember router service
|
|
* @param {Object} setting - The setting object from the site settings API
|
|
* @param {Object} plugins - The plugins object built from the visible plugins in preload store
|
|
* @param {Object} settingPageMap - The setting page map object with categories and areas.
|
|
* This points to the URL of the relevant setting page
|
|
*/
|
|
constructor(router, setting, plugins, settingPageMap) {
|
|
this.router = router;
|
|
this.setting = setting;
|
|
this.plugins = plugins;
|
|
this.settingPageMap = settingPageMap;
|
|
this.settingPluginNames = {};
|
|
}
|
|
|
|
format() {
|
|
if (this.setting.plugin) {
|
|
if (!this.settingPluginNames[this.setting.plugin]) {
|
|
this.settingPluginNames[this.setting.plugin] =
|
|
this.setting.plugin.replaceAll("_", "-");
|
|
}
|
|
}
|
|
|
|
const [rootLabel, fullLabel] = this.buildLabel();
|
|
const url = this.buildURL();
|
|
|
|
const keywords = buildKeywords(
|
|
this.setting.setting,
|
|
this.setting.humanized_name,
|
|
this.setting.description,
|
|
this.setting.keywords,
|
|
rootLabel
|
|
);
|
|
|
|
return {
|
|
label: fullLabel,
|
|
description: this.setting.description,
|
|
url,
|
|
keywords,
|
|
};
|
|
}
|
|
|
|
buildLabel() {
|
|
let rootLabel;
|
|
|
|
if (this.setting.plugin) {
|
|
const plugin = this.plugins[this.settingPluginNames[this.setting.plugin]];
|
|
if (plugin) {
|
|
rootLabel = plugin.admin_route?.label
|
|
? i18n(plugin.admin_route?.label)
|
|
: i18n("admin.plugins.title");
|
|
} else {
|
|
rootLabel = i18n("admin.plugins.title");
|
|
}
|
|
} else if (this.setting.primary_area) {
|
|
rootLabel =
|
|
I18n.lookup(`admin.config.${this.setting.primary_area}.title`) ||
|
|
i18n(`admin.site_settings.categories.${this.setting.category}`);
|
|
} else {
|
|
rootLabel = i18n(
|
|
`admin.site_settings.categories.${this.setting.category}`
|
|
);
|
|
}
|
|
|
|
return [
|
|
rootLabel,
|
|
`${rootLabel} ${SEPARATOR} ${this.setting.humanized_name}`,
|
|
];
|
|
}
|
|
|
|
buildURL() {
|
|
// TODO (martin) These URLs will need to change eventually to anchors
|
|
// to focus/highlight on a specific element on the page, for now though the filter is fine.
|
|
let url;
|
|
if (this.setting.plugin) {
|
|
const plugin = this.plugins[this.settingPluginNames[this.setting.plugin]];
|
|
const settingPluginCategoryName = this.setting.plugin.replace(/-/g, "_");
|
|
|
|
if (plugin && plugin.admin_route.use_new_show_route) {
|
|
url = this.router.urlFor(
|
|
`adminPlugins.show.settings`,
|
|
plugin.admin_route.location,
|
|
{ queryParams: { filter: this.setting.setting } }
|
|
);
|
|
} else {
|
|
url = getURL(
|
|
`/admin/site_settings/category/${settingPluginCategoryName}?filter=${this.setting.setting}`
|
|
);
|
|
}
|
|
} else if (this.settingPageMap.areas[this.setting.primary_area]) {
|
|
url =
|
|
this.settingPageMap.areas[this.setting.primary_area] +
|
|
`?filter=${this.setting.setting}`;
|
|
} else if (this.settingPageMap.categories[this.setting.category]) {
|
|
url =
|
|
this.settingPageMap.categories[this.setting.category] +
|
|
`?filter=${this.setting.setting}`;
|
|
} else {
|
|
url = getURL(
|
|
`/admin/site_settings/category/all_results?filter=${this.setting.setting}`
|
|
);
|
|
}
|
|
return url;
|
|
}
|
|
}
|
|
|
|
export default class AdminSearchDataSource extends Service {
|
|
@service router;
|
|
@service siteSettings;
|
|
@service adminNavManager;
|
|
|
|
plugins = {};
|
|
pageDataSourceItems = [];
|
|
settingDataSourceItems = [];
|
|
themeDataSourceItems = [];
|
|
componentDataSourceItems = [];
|
|
reportDataSourceItems = [];
|
|
settingPageMap = {
|
|
categories: {},
|
|
areas: {},
|
|
};
|
|
@tracked _mapCached = false;
|
|
|
|
async buildMap() {
|
|
if (this._mapCached) {
|
|
return;
|
|
}
|
|
|
|
this.adminNavManager.filteredNavMap.forEach((navMapSection) => {
|
|
navMapSection.links.forEach((link) => {
|
|
let parentLabel = this.#addPageLink(navMapSection, link);
|
|
|
|
link.links?.forEach((subLink) => {
|
|
this.#addPageLink(navMapSection, subLink, parentLabel);
|
|
});
|
|
});
|
|
});
|
|
|
|
this.plugins = this.buildPluginsMap();
|
|
|
|
const allItems = await ajax("/admin/search/all.json");
|
|
this.#processSettings(allItems.settings);
|
|
this.#processThemesAndComponents(allItems.themes_and_components);
|
|
this.#processReports(allItems.reports);
|
|
this._mapCached = true;
|
|
}
|
|
|
|
buildPluginsMap() {
|
|
const pluginsMap = {};
|
|
|
|
// TODO (martin) Handle plugin enabling/disabling via MessageBus for this
|
|
// and the setting list?
|
|
(PreloadStore.get("visiblePlugins") || []).forEach((plugin) => {
|
|
if (
|
|
plugin.admin_route &&
|
|
plugin.enabled &&
|
|
adminRouteValid(this.router, plugin.admin_route)
|
|
) {
|
|
pluginsMap[plugin.name] = plugin;
|
|
}
|
|
});
|
|
|
|
return pluginsMap;
|
|
}
|
|
|
|
search(filter) {
|
|
if (filter.length < MIN_FILTER_LENGTH) {
|
|
return [];
|
|
}
|
|
|
|
let filteredResults = [];
|
|
const escapedFilterRegExp = escapeRegExp(
|
|
filter.toLowerCase().trim().replace(/\s+/g, " ")
|
|
);
|
|
|
|
// Pointless to render heaps of settings if the filter is quite low.
|
|
const perTypeLimit =
|
|
filter.length < MIN_FILTER_LENGTH + 1
|
|
? MAX_TYPE_RESULT_COUNT_LOW
|
|
: MAX_TYPE_RESULT_COUNT_HIGH;
|
|
|
|
const labelStartRegex = new RegExp(`^${escapedFilterRegExp}`, "i");
|
|
const labelPartialRegex = new RegExp(`\\b${escapedFilterRegExp}`, "i");
|
|
const exactKeywordRegexes = escapedFilterRegExp
|
|
.split(" ")
|
|
.filter((keyword) => keyword.length > 3)
|
|
.map((keyword) => new RegExp(`(${keyword})\\b`, "i"));
|
|
const partialKeywordRegexes = escapedFilterRegExp
|
|
.split(" ")
|
|
.filter((keyword) => keyword.length > 3)
|
|
.map((keyword) => new RegExp(`\\b${keyword}`, "i"));
|
|
const fallbackRegex = new RegExp(`${escapedFilterRegExp}`, "i");
|
|
|
|
ADMIN_SEARCH_RESULT_TYPES.forEach((type) => {
|
|
const typeResults = [];
|
|
this[`${type}DataSourceItems`].forEach((dataSourceItem) => {
|
|
dataSourceItem.score = 0;
|
|
|
|
if (dataSourceItem.label.match(labelStartRegex)) {
|
|
dataSourceItem.score += SEARCH_SCORES.labelStart;
|
|
} else if (dataSourceItem.label.match(labelPartialRegex)) {
|
|
dataSourceItem.score += SEARCH_SCORES.labelPartial;
|
|
}
|
|
if (
|
|
exactKeywordRegexes.length > 0 &&
|
|
exactKeywordRegexes.every((regex) => {
|
|
return dataSourceItem.keywords.match(regex);
|
|
})
|
|
) {
|
|
dataSourceItem.score = dataSourceItem.score +=
|
|
SEARCH_SCORES.exactKeyword;
|
|
} else if (
|
|
partialKeywordRegexes.length > 0 &&
|
|
partialKeywordRegexes.every((regex) => {
|
|
return dataSourceItem.keywords.match(regex);
|
|
})
|
|
) {
|
|
dataSourceItem.score = dataSourceItem.score +=
|
|
SEARCH_SCORES.partialKeyword;
|
|
}
|
|
if (filter.length > 3 && dataSourceItem.keywords.match(fallbackRegex)) {
|
|
dataSourceItem.score += SEARCH_SCORES.fallback;
|
|
}
|
|
|
|
if (dataSourceItem.score > 0) {
|
|
if (type === "page") {
|
|
dataSourceItem.score += SEARCH_SCORES.pageBonusScore;
|
|
}
|
|
|
|
typeResults.push(dataSourceItem);
|
|
}
|
|
});
|
|
filteredResults = filteredResults.concat(
|
|
typeResults.sort((a, b) => b.score - a.score).slice(0, perTypeLimit)
|
|
);
|
|
});
|
|
return filteredResults.sort((a, b) => b.score - a.score);
|
|
}
|
|
|
|
#addPageLink(navMapSection, link, parentLabel = null) {
|
|
const formattedPageLink = new PageLinkFormatter(
|
|
this.router,
|
|
navMapSection,
|
|
link,
|
|
parentLabel
|
|
).format();
|
|
|
|
// Cache the setting area + category URLs for later use
|
|
// when building the setting list via #processSettings.
|
|
if (link.settings_area && !this.settingPageMap.areas[link.settings_area]) {
|
|
this.settingPageMap.areas[link.settings_area] = link.multi_tabbed
|
|
? `${formattedPageLink.url}/settings`
|
|
: formattedPageLink.url;
|
|
}
|
|
|
|
if (
|
|
link.settings_category &&
|
|
!this.settingPageMap.categories[link.settings_category]
|
|
) {
|
|
this.settingPageMap.categories[link.settings_category] = link.multi_tabbed
|
|
? `${formattedPageLink.url}/settings`
|
|
: formattedPageLink.url;
|
|
}
|
|
|
|
this.pageDataSourceItems.push({
|
|
label: formattedPageLink.label,
|
|
url: formattedPageLink.url,
|
|
keywords: formattedPageLink.keywords,
|
|
type: "page",
|
|
icon: link.icon,
|
|
description: formattedPageLink.description,
|
|
});
|
|
|
|
return formattedPageLink.label;
|
|
}
|
|
|
|
#processSettings(settings) {
|
|
settings.forEach((setting) => {
|
|
const formattedSettingLink = new SettingLinkFormatter(
|
|
this.router,
|
|
setting,
|
|
this.plugins,
|
|
this.settingPageMap
|
|
).format();
|
|
|
|
this.settingDataSourceItems.push({
|
|
label: formattedSettingLink.label,
|
|
description: formattedSettingLink.description,
|
|
url: formattedSettingLink.url,
|
|
keywords: formattedSettingLink.keywords,
|
|
type: "setting",
|
|
icon: "gear",
|
|
});
|
|
});
|
|
}
|
|
|
|
#processThemesAndComponents(themesAndComponents) {
|
|
themesAndComponents.forEach((themeOrComponent) => {
|
|
if (themeOrComponent.component) {
|
|
this.componentDataSourceItems.push({
|
|
label: themeOrComponent.name,
|
|
description: themeOrComponent.description,
|
|
url: getURL(`/admin/customize/components/${themeOrComponent.id}`),
|
|
keywords: buildKeywords(
|
|
"component",
|
|
themeOrComponent.description,
|
|
themeOrComponent.name
|
|
),
|
|
type: "component",
|
|
icon: "puzzle-piece",
|
|
});
|
|
} else {
|
|
this.themeDataSourceItems.push({
|
|
label: themeOrComponent.name,
|
|
description: themeOrComponent.description,
|
|
url: getURL(`/admin/customize/themes/${themeOrComponent.id}`),
|
|
keywords: buildKeywords(
|
|
"theme",
|
|
themeOrComponent.description,
|
|
themeOrComponent.name
|
|
),
|
|
type: "theme",
|
|
icon: "paintbrush",
|
|
});
|
|
}
|
|
});
|
|
}
|
|
|
|
#processReports(reports) {
|
|
reports.forEach((report) => {
|
|
this.reportDataSourceItems.push({
|
|
label: report.title,
|
|
description: report.description,
|
|
url: getURL(`/admin/reports/${report.type}`),
|
|
icon: "chart-bar",
|
|
keywords: buildKeywords(report.title, report.description, report.type),
|
|
type: "report",
|
|
});
|
|
});
|
|
}
|
|
}
|
