Skip to content

Commit

Permalink
Update Configure Display Language command
Browse files Browse the repository at this point in the history
  • Loading branch information
msujew committed Jun 13, 2022
1 parent fb13143 commit 4553660
Show file tree
Hide file tree
Showing 9 changed files with 278 additions and 25 deletions.
1 change: 1 addition & 0 deletions dev-packages/ovsx-client/src/ovsx-types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ export interface VSXSearchEntry {
readonly url: string;
readonly files: {
download: string
manifest?: string
readme?: string
license?: string
icon?: string
Expand Down
29 changes: 9 additions & 20 deletions packages/core/src/browser/common-frontend-contribution.ts
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ import { isPinned, Title, togglePinned, Widget } from './widgets';
import { SaveResourceService } from './save-resource-service';
import { UserWorkingDirectoryProvider } from './user-working-directory-provider';
import { createUntitledURI } from '../common';
import { LanguageQuickPickService } from './i18n/language-quick-pick-service';

export namespace CommonMenus {

Expand Down Expand Up @@ -399,6 +400,9 @@ export class CommonFrontendContribution implements FrontendApplicationContributi
@inject(UserWorkingDirectoryProvider)
protected readonly workingDirProvider: UserWorkingDirectoryProvider;

@inject(LanguageQuickPickService)
protected readonly languageQuickPickService: LanguageQuickPickService;

protected pinnedKey: ContextKey<boolean>;

async configure(app: FrontendApplication): Promise<void> {
Expand Down Expand Up @@ -1141,27 +1145,12 @@ export class CommonFrontendContribution implements FrontendApplicationContributi
}

protected async configureDisplayLanguage(): Promise<void> {
const availableLanguages = await this.localizationProvider.getAvailableLanguages();
const items: QuickPickItem[] = [];
for (const languageId of ['en', ...availableLanguages.map(e => e.languageId)]) {
if (typeof languageId === 'string') {
items.push({
label: languageId,
execute: async () => {
if (languageId !== nls.locale && await this.confirmRestart()) {
this.windowService.setSafeToShutDown();
window.localStorage.setItem(nls.localeId, languageId);
this.windowService.reload();
}
}
});
}
const languageId = await this.languageQuickPickService.pickDisplayLanguage();
if (languageId && !nls.isSelectedLocale(languageId) && await this.confirmRestart()) {
nls.setLocale(languageId);
this.windowService.setSafeToShutDown();
this.windowService.reload();
}
this.quickInputService?.showQuickPick(items,
{
placeholder: CommonCommands.CONFIGURE_DISPLAY_LANGUAGE.label,
activeItem: items.find(item => item.label === (nls.locale || 'en'))
});
}

protected async confirmRestart(): Promise<boolean> {
Expand Down
2 changes: 2 additions & 0 deletions packages/core/src/browser/i18n/i18n-frontend-module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,11 @@
import { ContainerModule } from 'inversify';
import { AsyncLocalizationProvider, localizationPath } from '../../common/i18n/localization';
import { WebSocketConnectionProvider } from '../messaging/ws-connection-provider';
import { LanguageQuickPickService } from './language-quick-pick-service';

export default new ContainerModule(bind => {
bind(AsyncLocalizationProvider).toDynamicValue(
ctx => ctx.container.get(WebSocketConnectionProvider).createProxy(localizationPath)
).inSingletonScope();
bind(LanguageQuickPickService).toSelf().inSingletonScope();
});
123 changes: 123 additions & 0 deletions packages/core/src/browser/i18n/language-quick-pick-service.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
// *****************************************************************************
// Copyright (C) 2022 TypeFox and others.
//
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License v. 2.0 which is available at
// http://www.eclipse.org/legal/epl-2.0.
//
// This Source Code may also be made available under the following Secondary
// Licenses when the conditions for such availability set forth in the Eclipse
// Public License v. 2.0 are satisfied: GNU General Public License, version 2
// with the GNU Classpath Exception which is available at
// https://www.gnu.org/software/classpath/license.html.
//
// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
// *****************************************************************************

import { inject, injectable } from 'inversify';
import { nls } from '../../common/nls';
import { AsyncLocalizationProvider, LanguageInfo } from '../../common/i18n/localization';
import { QuickInputService, QuickPickItem, QuickPickSeparator } from '../quick-input';
import { WindowService } from '../window/window-service';

export interface LanguageQuickPickItem extends QuickPickItem {
languageId: string
execute?(): Promise<void>
}

@injectable()
export class LanguageQuickPickService {

@inject(QuickInputService) protected readonly quickInputService: QuickInputService;
@inject(AsyncLocalizationProvider) protected readonly localizationProvider: AsyncLocalizationProvider;
@inject(WindowService) protected readonly windowService: WindowService;

async pickDisplayLanguage(): Promise<string | undefined> {
const quickInput = this.quickInputService.createQuickPick();
const installedItems = await this.getInstalledLanguages();
const quickInputItems: (QuickPickItem | QuickPickSeparator)[] = [
{
type: 'separator',
label: nls.localize('theia/core/installedLanguages', 'Installed languages')
},
...installedItems
];
quickInput.items = quickInputItems;
quickInput.busy = true;
const selected = installedItems.find(item => nls.isSelectedLocale(item.languageId));
if (selected) {
quickInput.activeItems = [selected];
}
quickInput.placeholder = nls.localizeByDefault('Configure Display Language');
quickInput.show();

this.getAvailableLanguages().then(availableItems => {
if (availableItems.length > 0) {
quickInputItems.push({
type: 'separator',
label: nls.localize('theia/core/availableLanguages', 'Available languages')
});
for (const available of availableItems) {
// Exclude already installed languages
if (!installedItems.some(e => e.languageId === available.languageId)) {
quickInputItems.push(available);
}
}
quickInput.items = quickInputItems;
}
}).finally(() => {
quickInput.busy = false;
});

return new Promise(resolve => {
quickInput.onDidAccept(async () => {
const selectedItem = quickInput.selectedItems[0] as LanguageQuickPickItem;
// Some language quick pick items want to install additional languages
// We have to await that before returning the selected locale
await selectedItem.execute?.();
resolve(selectedItem.languageId);
});
quickInput.onDidHide(() => {
resolve(undefined);
});
});
}

protected async getInstalledLanguages(): Promise<LanguageQuickPickItem[]> {
const languageInfos = await this.localizationProvider.getAvailableLanguages();
const items: LanguageQuickPickItem[] = [];
const en: LanguageInfo = {
languageId: 'en',
languageName: 'English',
localizedLanguageName: 'English'
};
languageInfos.push(en);
for (const language of languageInfos.filter(e => !!e.languageId)) {
items.push(this.createLanguageQuickPickItem(language));
}
return items;
}

protected async getAvailableLanguages(): Promise<LanguageQuickPickItem[]> {
return [];
}

protected createLanguageQuickPickItem(language: LanguageInfo): LanguageQuickPickItem {
let label: string;
let description: string | undefined;
const languageName = language.localizedLanguageName || language.languageName;
const id = language.languageId;
const idLabel = id + (nls.isSelectedLocale(id) ? ` (${nls.localizeByDefault('Current')})` : '');
if (languageName) {
label = languageName;
description = idLabel;
} else {
label = idLabel;
}
return {
label,
description,
languageId: id
};
}
}
11 changes: 11 additions & 0 deletions packages/core/src/common/nls.ts
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,17 @@ export namespace nls {
export function localize(key: string, defaultValue: string, ...args: FormatType[]): string {
return Localization.localize(localization, key, defaultValue, ...args);
}

export function isSelectedLocale(id: string): boolean {
if (locale === undefined && id === 'en') {
return true;
}
return locale === id;
}

export function setLocale(id: string): void {
window.localStorage.setItem(localeId, id);
}
}

interface NlsKeys {
Expand Down
18 changes: 16 additions & 2 deletions packages/monaco/src/browser/monaco-quick-input-service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -488,19 +488,21 @@ class MonacoQuickPick<T extends QuickPickItem> extends MonacoQuickInput implemen
}

set items(itms: readonly (T | QuickPickSeparator)[]) {
const active = this.activeItems;
this.wrapped.items = itms.map(item => QuickPickSeparator.is(item) ? item : new MonacoQuickPickItem<T>(item, this.keybindingRegistry));
this.activeItems = active;
}

set activeItems(itms: readonly T[]) {
this.wrapped.activeItems = itms.map(item => new MonacoQuickPickItem<T>(item, this.keybindingRegistry));
this.wrapped.activeItems = findActualItems(this.wrapped.items, itms);
}

get activeItems(): readonly (T)[] {
return this.wrapped.activeItems.map(item => item.item);
}

set selectedItems(itms: readonly T[]) {
this.wrapped.selectedItems = itms.map(item => new MonacoQuickPickItem<T>(item, this.keybindingRegistry));
this.wrapped.selectedItems = findActualItems(this.wrapped.items, itms);
}

get selectedItems(): readonly (T)[] {
Expand All @@ -522,6 +524,18 @@ class MonacoQuickPick<T extends QuickPickItem> extends MonacoQuickInput implemen
this.wrapped.onDidChangeSelection, (items: MonacoQuickPickItem<T>[]) => items.map(item => item.item));
}

function findActualItems<T extends QuickPickItem>(source: readonly (MonacoQuickPickItem<T> | IQuickPickSeparator)[], items: readonly QuickPickItem[]): MonacoQuickPickItem<T>[] {
const actualItems: MonacoQuickPickItem<T>[] = [];
for (const item of items) {
for (const wrappedItem of source) {
if (!QuickPickSeparator.is(wrappedItem) && wrappedItem.item === item) {
actualItems.push(wrappedItem);
}
}
}
return actualItems;
}

export class MonacoQuickPickItem<T extends QuickPickItem> implements IQuickPickItem {
readonly type?: 'item';
readonly id?: string;
Expand Down
103 changes: 103 additions & 0 deletions packages/vsx-registry/src/browser/vsx-language-quick-pick-service.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
// *****************************************************************************
// Copyright (C) 2022 TypeFox and others.
//
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License v. 2.0 which is available at
// http://www.eclipse.org/legal/epl-2.0.
//
// This Source Code may also be made available under the following Secondary
// Licenses when the conditions for such availability set forth in the Eclipse
// Public License v. 2.0 are satisfied: GNU General Public License, version 2
// with the GNU Classpath Exception which is available at
// https://www.gnu.org/software/classpath/license.html.
//
// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
// *****************************************************************************

import { LanguageQuickPickItem, LanguageQuickPickService } from '@theia/core/lib/browser/i18n/language-quick-pick-service';
import { RequestContext, RequestService } from '@theia/core/shared/@theia/request';
import { inject, injectable } from '@theia/core/shared/inversify';
import { LanguageInfo } from '@theia/core/lib/common/i18n/localization';
import { PluginPackage, PluginServer } from '@theia/plugin-ext';
import { OVSXClientProvider } from '../common/ovsx-client-provider';
import { VSXSearchEntry } from '@theia/ovsx-client';
import { VSXExtensionUri } from '../common/vsx-extension-uri';

@injectable()
export class VSXLanguageQuickPickService extends LanguageQuickPickService {

@inject(OVSXClientProvider)
protected readonly clientProvider: OVSXClientProvider;

@inject(RequestService)
protected readonly requestService: RequestService;

@inject(PluginServer)
protected readonly pluginServer: PluginServer;

protected override async getAvailableLanguages(): Promise<LanguageQuickPickItem[]> {
const client = await this.clientProvider();
const searchResult = await client.search({
category: 'Language Packs',
sortBy: 'downloadCount',
sortOrder: 'desc',
size: 20
});
if (searchResult.error) {
throw new Error('Error while loading available languages: ' + searchResult.error);
}

const extensionLanguages = await Promise.all(
searchResult.extensions.map(async extension => ({
extension,
languages: await this.loadExtensionLanguages(extension)
}))
);

const languages = new Map<string, { language: LanguageInfo, extensionUri: string }>();

for (const extension of extensionLanguages) {
for (const localizationContribution of extension.languages) {
if (!languages.has(localizationContribution.languageId)) {
languages.set(localizationContribution.languageId, {
language: localizationContribution,
extensionUri: VSXExtensionUri.toUri(extension.extension.name, extension.extension.namespace).toString()
});
}
}
}
const items: LanguageQuickPickItem[] = [];

for (const { language, extensionUri } of Array.from(languages.values())) {
const item: LanguageQuickPickItem = {
...this.createLanguageQuickPickItem(language),
execute: async () => {
await this.pluginServer.deploy(extensionUri);
}
};
items.push(item);
}
return items;
}

protected async loadExtensionLanguages(extension: VSXSearchEntry): Promise<LanguageInfo[]> {
// When searching for extensions on ovsx, we don't receive the `manifest` property.
// This property is only set when querying a specific extension.
// To improve performance, we assume that a manifest exists at `/package.json`.
const downloadUrl = extension.files.download;
const parentUrl = downloadUrl.substring(0, downloadUrl.lastIndexOf('/'));
const manifestUrl = parentUrl + '/package.json';
const manifestRequest = await this.requestService.request({ url: manifestUrl });
const manifestContent = RequestContext.asJson<PluginPackage>(manifestRequest);
const localizations = manifestContent.contributes?.localizations;
if (localizations) {
return localizations.map(e => ({
languageId: e.languageId,
languageName: e.languageName,
localizedLanguageName: e.localizedLanguageName,
languagePack: true
}));
}
return [];
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,10 @@ import { bindPreferenceProviderOverrides } from './recommended-extensions/prefer
import { OVSXClientProvider, createOVSXClient } from '../common/ovsx-client-provider';
import { VSXEnvironment, VSX_ENVIRONMENT_PATH } from '../common/vsx-environment';
import { RequestService } from '@theia/core/shared/@theia/request';
import { LanguageQuickPickService } from '@theia/core/lib/browser/i18n/language-quick-pick-service';
import { VSXLanguageQuickPickService } from './vsx-language-quick-pick-service';

export default new ContainerModule((bind, unbind) => {
export default new ContainerModule((bind, unbind, _, rebind) => {
bind<OVSXClientProvider>(OVSXClientProvider).toDynamicValue(ctx => {
const clientPromise = createOVSXClient(ctx.container.get(VSXEnvironment), ctx.container.get(RequestService));
return () => clientPromise;
Expand Down Expand Up @@ -100,6 +102,8 @@ export default new ContainerModule((bind, unbind) => {
bind(VSXExtensionsSearchModel).toSelf().inSingletonScope();
bind(VSXExtensionsSearchBar).toSelf().inSingletonScope();

rebind(LanguageQuickPickService).to(VSXLanguageQuickPickService).inSingletonScope();

bindViewContribution(bind, VSXExtensionsContribution);
bind(FrontendApplicationContribution).toService(VSXExtensionsContribution);
bind(ColorContribution).toService(VSXExtensionsContribution);
Expand Down
10 changes: 8 additions & 2 deletions packages/vsx-registry/src/common/vsx-extension-uri.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,14 @@
import URI from '@theia/core/lib/common/uri';

export namespace VSXExtensionUri {
export function toUri(id: string): URI {
return new URI(`vscode:extension/${id}`);
export function toUri(name: string, namespace: string): URI;
export function toUri(id: string): URI;
export function toUri(idOrName: string, namespace?: string): URI {
if (typeof namespace === 'string') {
return new URI(`vscode:extension/${namespace}.${idOrName}`);
} else {
return new URI(`vscode:extension/${idOrName}`);
}
}
export function toId(uri: URI): string | undefined {
if (uri.scheme === 'vscode' && uri.path.dir.toString() === 'extension') {
Expand Down

0 comments on commit 4553660

Please sign in to comment.