/*
* Copyright 2000-2015 JetBrains s.r.o.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.intellij.lang.properties.create;
import com.intellij.icons.AllIcons;
import com.intellij.ide.fileTemplates.FileTemplate;
import com.intellij.ide.fileTemplates.FileTemplateManager;
import com.intellij.ide.fileTemplates.FileTemplateUtil;
import com.intellij.ide.util.PropertiesComponent;
import com.intellij.lang.properties.*;
import com.intellij.lang.properties.ResourceBundle;
import com.intellij.lang.properties.psi.PropertiesFile;
import com.intellij.lang.properties.xml.XmlPropertiesFile;
import com.intellij.openapi.application.ReadAction;
import com.intellij.openapi.command.WriteCommandAction;
import com.intellij.openapi.diagnostic.Logger;
import com.intellij.openapi.project.Project;
import com.intellij.openapi.ui.DialogWrapper;
import com.intellij.openapi.ui.InputValidatorEx;
import com.intellij.openapi.ui.Messages;
import com.intellij.openapi.ui.ValidationInfo;
import com.intellij.openapi.util.Computable;
import com.intellij.psi.PsiDirectory;
import com.intellij.psi.PsiElement;
import com.intellij.psi.PsiFile;
import com.intellij.psi.search.GlobalSearchScope;
import com.intellij.ui.*;
import com.intellij.ui.components.JBList;
import com.intellij.util.NotNullFunction;
import com.intellij.util.PathUtil;
import com.intellij.util.containers.ContainerUtil;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import javax.swing.*;
import javax.swing.event.ListSelectionEvent;
import javax.swing.event.ListSelectionListener;
import java.awt.event.*;
import java.util.*;
/**
* @author Dmitry Batkovich
*/
public class CreateResourceBundleDialogComponent {
private final static Logger LOG = Logger.getInstance(CreateResourceBundleDialogComponent.class);
private static final Comparator<Locale> LOCALE_COMPARATOR = (l1, l2) -> {
if (l1 == PropertiesUtil.DEFAULT_LOCALE) {
return -1;
}
if (l2 == PropertiesUtil.DEFAULT_LOCALE) {
return 1;
}
return l1.toString().compareTo(l2.toString());
};
private final Project myProject;
private final PsiDirectory myDirectory;
private final ResourceBundle myResourceBundle;
private JPanel myPanel;
private JTextField myResourceBundleBaseNameTextField;
private JButton myAddLocaleFromExistButton;
private JPanel myNewBundleLocalesPanel;
private JPanel myProjectExistLocalesPanel;
private JButton myAddAllButton;
private JPanel myResourceBundleNamePanel;
private JCheckBox myUseXMLBasedPropertiesCheckBox;
private CollectionListModel<Locale> myLocalesModel;
public CreateResourceBundleDialogComponent(Project project, PsiDirectory directory, ResourceBundle resourceBundle) {
myProject = project;
myDirectory = directory;
myResourceBundle = resourceBundle;
if (resourceBundle != null) {
myResourceBundleNamePanel.setVisible(false);
myUseXMLBasedPropertiesCheckBox.setVisible(false);
} else {
final String checkBoxSelectedStateKey = getClass() + ".useXmlPropertiesFiles";
myUseXMLBasedPropertiesCheckBox.setSelected(PropertiesComponent.getInstance().getBoolean(checkBoxSelectedStateKey));
myUseXMLBasedPropertiesCheckBox.addContainerListener(new ContainerAdapter() {
@Override
public void componentRemoved(ContainerEvent e) {
PropertiesComponent.getInstance().setValue(checkBoxSelectedStateKey, myUseXMLBasedPropertiesCheckBox.isSelected());
}
});
}
}
public static class Dialog extends DialogWrapper {
@Nullable private final Project myProject;
@NotNull private final PsiDirectory myDirectory;
private CreateResourceBundleDialogComponent myComponent;
private PsiElement[] myCreatedFiles;
protected Dialog(@Nullable Project project, @Nullable PsiDirectory directory, @Nullable ResourceBundle resourceBundle) {
super(project);
if (directory == null) {
LOG.assertTrue(resourceBundle != null && getResourceBundlePlacementDirectory(resourceBundle) != null);
}
myProject = project;
myDirectory = directory == null ? resourceBundle.getDefaultPropertiesFile().getContainingFile().getContainingDirectory() : directory;
myComponent = new CreateResourceBundleDialogComponent(myProject, myDirectory, resourceBundle);
init();
initValidation();
setTitle(resourceBundle == null ? "Create resource bundle" : String.format("Add locales to resource bundle \'%s\'", resourceBundle.getBaseName()));
}
@Override
protected void doOKAction() {
final String errorString = myComponent.canCreateAllFilesForAllLocales();
if (errorString != null) {
Messages.showErrorDialog(getContentPanel(), errorString);
} else {
final List<PsiFile> createFiles = myComponent.createPropertiesFiles();
myCreatedFiles = createFiles.toArray(new PsiElement[createFiles.size()]);
super.doOKAction();
}
}
@Nullable
@Override
protected ValidationInfo doValidate() {
for (String fileName : myComponent.getFileNamesToCreate()) {
if (!PathUtil.isValidFileName(fileName)) {
return new ValidationInfo(String.format("File name for properties file '%s' is invalid", fileName));
} else {
if (myDirectory.findFile(fileName) != null) {
return new ValidationInfo(String.format("File with name '%s' already exist", fileName));
}
}
}
return null;
}
@Nullable
@Override
protected JComponent createCenterPanel() {
return myComponent.getPanel();
}
@Nullable
@Override
public JComponent getPreferredFocusedComponent() {
return myComponent.myResourceBundleBaseNameTextField;
}
public PsiElement[] getCreatedFiles() {
return myCreatedFiles;
}
}
private List<PsiFile> createPropertiesFiles() {
final Set<String> fileNames = getFileNamesToCreate();
final List<PsiFile> createdFiles = WriteCommandAction.runWriteCommandAction(myProject,
(Computable<List<PsiFile>>)() -> ReadAction.compute(() -> ContainerUtil.map(fileNames, n -> {
final boolean isXml = myResourceBundle == null
? myUseXMLBasedPropertiesCheckBox.isSelected()
: myResourceBundle.getDefaultPropertiesFile() instanceof XmlPropertiesFile;
if (isXml) {
FileTemplate template = FileTemplateManager.getInstance(myProject).getInternalTemplate("XML Properties File.xml");
LOG.assertTrue(template != null);
try {
return (PsiFile)FileTemplateUtil.createFromTemplate(template, n, null, myDirectory);
}
catch (Exception e) {
throw new RuntimeException(e);
}
} else {
return myDirectory.createFile(n);
}
})));
combineToResourceBundleIfNeed(createdFiles);
return createdFiles;
}
@NotNull
private Set<String> getFileNamesToCreate() {
final String name = getBaseName();
final String suffix = getPropertiesFileSuffix();
return ContainerUtil.map2Set(myLocalesModel.getItems(),
locale -> name + (locale == PropertiesUtil.DEFAULT_LOCALE ? "" : ("_" + locale.toString())) + suffix);
}
private void combineToResourceBundleIfNeed(Collection<PsiFile> files) {
Collection<PropertiesFile> createdFiles = ContainerUtil.map(files, (NotNullFunction<PsiFile, PropertiesFile>)dom -> {
final PropertiesFile file = PropertiesImplUtil.getPropertiesFile(dom);
LOG.assertTrue(file != null, dom.getName());
return file;
});
ResourceBundle mainBundle = myResourceBundle;
final Set<ResourceBundle> allBundles = new HashSet<>();
if (mainBundle != null) {
allBundles.add(mainBundle);
}
boolean needCombining = false;
for (PropertiesFile file : createdFiles) {
final ResourceBundle rb = file.getResourceBundle();
if (mainBundle == null) {
mainBundle = rb;
}
else if (!mainBundle.equals(rb)) {
needCombining = true;
}
allBundles.add(rb);
}
if (needCombining) {
final List<PropertiesFile> toCombine = new ArrayList<>(createdFiles);
final String baseName = getBaseName();
if (myResourceBundle != null) {
toCombine.addAll(myResourceBundle.getPropertiesFiles());
}
ResourceBundleManager manager = ResourceBundleManager.getInstance(mainBundle.getProject());
for (ResourceBundle bundle : allBundles) {
manager.dissociateResourceBundle(bundle);
}
manager.combineToResourceBundle(toCombine, baseName);
}
}
private String getBaseName() {
return myResourceBundle == null ? myResourceBundleBaseNameTextField.getText() : myResourceBundle.getBaseName();
}
private String canCreateAllFilesForAllLocales() {
final String name = getBaseName();
if (name.isEmpty()) {
return "Base name is empty";
}
final Set<String> files = getFileNamesToCreate();
if (files.isEmpty()) {
return "No locales added";
}
for (PsiElement element : myDirectory.getChildren()) {
if (element instanceof PsiFile) {
if (element instanceof PropertiesFile) {
PropertiesFile propertiesFile = (PropertiesFile)element;
final String propertiesFileName = propertiesFile.getName();
if (files.contains(propertiesFileName)) {
return "Some of files already exist";
}
}
}
}
return null;
}
private String getPropertiesFileSuffix() {
if (myResourceBundle == null) {
return myUseXMLBasedPropertiesCheckBox.isSelected() ? ".xml" : ".properties";
}
return "." + myResourceBundle.getDefaultPropertiesFile().getContainingFile().getFileType().getDefaultExtension();
}
public JPanel getPanel() {
return myPanel;
}
@Nullable
private static List<Locale> extractLocalesFromString(final String rawLocales) {
if (rawLocales.isEmpty()) {
return Collections.emptyList();
}
final String[] splitRawLocales = rawLocales.split(",");
final List<Locale> locales = new ArrayList<>(splitRawLocales.length);
for (String rawLocale : splitRawLocales) {
final Locale locale = PropertiesUtil.getLocale("_" + rawLocale + ".properties");
if (locale == PropertiesUtil.DEFAULT_LOCALE) {
return null;
}
else if (!locales.contains(locale)) {
locales.add(locale);
}
}
return locales;
}
@SuppressWarnings("unchecked")
private void createUIComponents() {
final JBList projectExistLocalesList = new JBList();
final MyExistLocalesListModel existLocalesListModel = new MyExistLocalesListModel();
projectExistLocalesList.setModel(existLocalesListModel);
projectExistLocalesList.setCellRenderer(getLocaleRenderer());
myProjectExistLocalesPanel = ToolbarDecorator.createDecorator(projectExistLocalesList)
.disableRemoveAction()
.disableUpDownActions()
.createPanel();
myProjectExistLocalesPanel.setBorder(IdeBorderFactory.createTitledBorder("Project locales", false));
final JBList localesToAddList = new JBList();
final List<Locale> locales;
final List<Locale> restrictedLocales;
if (myResourceBundle == null) {
locales = Collections.singletonList(PropertiesUtil.DEFAULT_LOCALE);
restrictedLocales = Collections.emptyList();
} else {
locales = Collections.emptyList();
restrictedLocales = ContainerUtil.map(myResourceBundle.getPropertiesFiles(), PropertiesFile::getLocale);
}
myLocalesModel = new CollectionListModel<Locale>(locales) {
@Override
public void add(@NotNull List<? extends Locale> elements) {
final List<Locale> currentItems = getItems();
elements = ContainerUtil.filter(elements,
locale -> !restrictedLocales.contains(locale) && !currentItems.contains(locale));
super.add(elements);
}
};
localesToAddList.setModel(myLocalesModel);
localesToAddList.setCellRenderer(getLocaleRenderer());
localesToAddList.addFocusListener(new FocusAdapter() {
@Override
public void focusGained(FocusEvent e) {
projectExistLocalesList.clearSelection();
}
});
projectExistLocalesList.addFocusListener(new FocusAdapter() {
@Override
public void focusGained(FocusEvent e) {
localesToAddList.clearSelection();
}
});
myNewBundleLocalesPanel = ToolbarDecorator.createDecorator(localesToAddList).setAddAction(new AnActionButtonRunnable() {
@Override
public void run(AnActionButton button) {
final String rawAddedLocales = Messages.showInputDialog(myProject,
PropertiesBundle.message("create.resource.bundle.dialog.add.locales.validator.message"),
PropertiesBundle.message("create.resource.bundle.dialog.add.locales.validator.title"),
null, null, new InputValidatorEx() {
@Nullable
@Override
public String getErrorText(String inputString) {
return checkInput(inputString) ? null : "Invalid locales";
}
@Override
public boolean checkInput(String inputString) {
return extractLocalesFromString(inputString) != null;
}
@Override
public boolean canClose(String inputString) {
return checkInput(inputString);
}
});
if (rawAddedLocales != null) {
final List<Locale> locales = extractLocalesFromString(rawAddedLocales);
LOG.assertTrue(locales != null);
myLocalesModel.add(locales);
}
}
}).setAddActionName("Add locales by suffix")
.disableUpDownActions().createPanel();
myNewBundleLocalesPanel.setBorder(IdeBorderFactory.createTitledBorder("Locales to add", false));
myAddLocaleFromExistButton = new JButton(AllIcons.Actions.Forward);
new ClickListener(){
@Override
public boolean onClick(@NotNull MouseEvent event, int clickCount) {
if (clickCount == 1) {
myLocalesModel.add(ContainerUtil.map(projectExistLocalesList.getSelectedValues(), o -> (Locale)o));
return true;
}
return false;
}
}.installOn(myAddLocaleFromExistButton);
projectExistLocalesList.addListSelectionListener(new ListSelectionListener() {
@Override
public void valueChanged(ListSelectionEvent e) {
final List<Locale> currentItems = myLocalesModel.getItems();
for (Object o : projectExistLocalesList.getSelectedValues()) {
Locale l = (Locale) o;
if (!restrictedLocales.contains(l) && !currentItems.contains(l)) {
myAddLocaleFromExistButton.setEnabled(true);
return;
}
}
myAddLocaleFromExistButton.setEnabled(false);
}
});
myAddLocaleFromExistButton.setEnabled(false);
myAddAllButton = new JButton("Add All");
new ClickListener() {
@Override
public boolean onClick(@NotNull MouseEvent event, int clickCount) {
if (clickCount == 1) {
myLocalesModel.add(existLocalesListModel.getLocales());
}
return false;
}
}.installOn(myAddAllButton);
}
@NotNull
private static ColoredListCellRenderer<Locale> getLocaleRenderer() {
return new ColoredListCellRenderer<Locale>() {
@Override
protected void customizeCellRenderer(@NotNull JList list, Locale locale, int index, boolean selected, boolean hasFocus) {
if (PropertiesUtil.DEFAULT_LOCALE == locale) {
append("Default locale");
} else {
append(locale.toString());
append(PropertiesUtil.getPresentableLocale(locale), SimpleTextAttributes.GRAY_ATTRIBUTES);
}
}
};
}
private class MyExistLocalesListModel extends AbstractListModel {
private final List<Locale> myLocales;
private MyExistLocalesListModel() {
myLocales = new ArrayList<>();
myLocales.add(PropertiesUtil.DEFAULT_LOCALE);
PropertiesReferenceManager.getInstance(myProject).processPropertiesFiles(GlobalSearchScope.projectScope(myProject), new PropertiesFileProcessor() {
@Override
public boolean process(String baseName, PropertiesFile propertiesFile) {
final Locale locale = propertiesFile.getLocale();
if (locale != PropertiesUtil.DEFAULT_LOCALE && !myLocales.contains(locale)) {
myLocales.add(locale);
}
return true;
}
}, BundleNameEvaluator.DEFAULT);
Collections.sort(myLocales, LOCALE_COMPARATOR);
}
@Override
public int getSize() {
return myLocales.size();
}
@Override
public Locale getElementAt(int index) {
return myLocales.get(index);
}
public List<Locale> getLocales() {
return myLocales;
}
}
@Nullable
static PsiDirectory getResourceBundlePlacementDirectory(ResourceBundle resourceBundle) {
PsiDirectory containingDirectory = null;
for (PropertiesFile propertiesFile : resourceBundle.getPropertiesFiles()) {
if (containingDirectory == null) {
containingDirectory = propertiesFile.getContainingFile().getContainingDirectory();
} else if (!containingDirectory.isEquivalentTo(propertiesFile.getContainingFile().getContainingDirectory())) {
return null;
}
}
LOG.assertTrue(containingDirectory != null);
return containingDirectory;
}
}