external system: use ExternalSystemApiUtil.isOneToOneMapping method after modules...
[idea/community.git] / platform / external-system-impl / src / com / intellij / openapi / externalSystem / service / project / manage / AbstractModuleDataService.java
1 /*
2  * Copyright 2000-2015 JetBrains s.r.o.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package com.intellij.openapi.externalSystem.service.project.manage;
17
18 import com.intellij.compiler.CompilerConfiguration;
19 import com.intellij.ide.util.projectWizard.ModuleBuilder;
20 import com.intellij.openapi.application.ApplicationManager;
21 import com.intellij.openapi.diagnostic.Logger;
22 import com.intellij.openapi.externalSystem.model.DataNode;
23 import com.intellij.openapi.externalSystem.model.ProjectKeys;
24 import com.intellij.openapi.externalSystem.model.ProjectSystemId;
25 import com.intellij.openapi.externalSystem.model.project.ExternalSystemSourceType;
26 import com.intellij.openapi.externalSystem.model.project.ModuleData;
27 import com.intellij.openapi.externalSystem.model.project.OrderAware;
28 import com.intellij.openapi.externalSystem.model.project.ProjectData;
29 import com.intellij.openapi.externalSystem.service.project.IdeModifiableModelsProvider;
30 import com.intellij.openapi.externalSystem.util.ExternalSystemApiUtil;
31 import com.intellij.openapi.externalSystem.util.ExternalSystemBundle;
32 import com.intellij.openapi.externalSystem.util.ExternalSystemConstants;
33 import com.intellij.openapi.externalSystem.util.ExternalSystemUiUtil;
34 import com.intellij.openapi.module.ModifiableModuleModel;
35 import com.intellij.openapi.module.Module;
36 import com.intellij.openapi.project.Project;
37 import com.intellij.openapi.roots.*;
38 import com.intellij.openapi.ui.DialogWrapper;
39 import com.intellij.openapi.util.Computable;
40 import com.intellij.openapi.util.Key;
41 import com.intellij.openapi.util.Pair;
42 import com.intellij.openapi.util.io.FileUtil;
43 import com.intellij.openapi.vfs.VfsUtilCore;
44 import com.intellij.pom.java.LanguageLevel;
45 import com.intellij.ui.CheckBoxList;
46 import com.intellij.ui.IdeBorderFactory;
47 import com.intellij.ui.components.JBScrollPane;
48 import com.intellij.util.ArrayUtil;
49 import com.intellij.util.Consumer;
50 import com.intellij.util.Function;
51 import com.intellij.util.SmartList;
52 import com.intellij.util.containers.ContainerUtil;
53 import com.intellij.util.containers.ContainerUtilRt;
54 import org.jetbrains.annotations.NotNull;
55 import org.jetbrains.annotations.Nullable;
56
57 import javax.swing.*;
58 import java.awt.*;
59 import java.util.*;
60 import java.util.List;
61
62 /**
63  * @author Vladislav.Soroka
64  * @since 8/5/2015
65  */
66 public abstract class AbstractModuleDataService<E extends ModuleData> extends AbstractProjectDataService<E, Module> {
67
68   public static final Key<ModuleData> MODULE_DATA_KEY = Key.create("MODULE_DATA_KEY");
69   public static final Key<Module> MODULE_KEY = Key.create("LINKED_MODULE");
70   public static final Key<Map<OrderEntry, OrderAware>> ORDERED_DATA_MAP_KEY = Key.create("ORDER_ENTRY_DATA_MAP");
71   public static final Key<Set<String>> ORPHAN_MODULE_FILES = Key.create("ORPHAN_FILES");
72
73   private static final Logger LOG = Logger.getInstance(AbstractModuleDataService.class);
74
75   @Override
76   public void importData(@NotNull final Collection<DataNode<E>> toImport,
77                          @Nullable ProjectData projectData,
78                          @NotNull final Project project,
79                          @NotNull IdeModifiableModelsProvider modelsProvider) {
80     if (toImport.isEmpty()) {
81       return;
82     }
83
84     final Collection<DataNode<E>> toCreate = filterExistingModules(toImport, modelsProvider, project);
85     if (!toCreate.isEmpty()) {
86       createModules(toCreate, modelsProvider, project);
87     }
88
89     for (DataNode<E> node : toImport) {
90       Module module = node.getUserData(MODULE_KEY);
91       if (module != null) {
92         setModuleOptions(module, node);
93         ModifiableRootModel modifiableRootModel = modelsProvider.getModifiableRootModel(module);
94         syncPaths(module, modifiableRootModel, node.getData());
95         setLanguageLevel(modifiableRootModel, node.getData());
96       }
97     }
98
99     final boolean isOneToOneMapping = projectData != null && ExternalSystemApiUtil.isOneToOneMapping(project, projectData);
100     for (DataNode<E> node : toImport) {
101       Module module = node.getUserData(MODULE_KEY);
102       if (module != null) {
103         final String[] groupPath;
104         if (isOneToOneMapping || projectData == null) {
105           groupPath = node.getData().getIdeModuleGroup();
106         }
107         else {
108           final String externalProjectGroup = projectData.getInternalName() + " modules";
109           groupPath = node.getData().getIdeModuleGroup() == null
110                       ? new String[]{externalProjectGroup}
111                       : ArrayUtil.prepend(externalProjectGroup, node.getData().getIdeModuleGroup());
112         }
113         final ModifiableModuleModel modifiableModel = modelsProvider.getModifiableModuleModel();
114         modifiableModel.setModuleGroupPath(module, groupPath);
115       }
116     }
117   }
118
119   private void createModules(@NotNull Collection<DataNode<E>> toCreate,
120                              @NotNull IdeModifiableModelsProvider modelsProvider,
121                              @NotNull Project project) {
122     for (final DataNode<E> module : toCreate) {
123       ModuleData data = module.getData();
124       final Module created = modelsProvider.newModule(data.getModuleFilePath(), data.getModuleTypeId());
125       module.putUserData(MODULE_KEY, created);
126       Set<String> orphanFiles = project.getUserData(ORPHAN_MODULE_FILES);
127       if (orphanFiles != null) {
128         orphanFiles.remove(created.getModuleFilePath());
129       }
130
131       // Ensure that the dependencies are clear (used to be not clear when manually removing the module and importing it via gradle)
132       final ModifiableRootModel modifiableRootModel = modelsProvider.getModifiableRootModel(created);
133       modifiableRootModel.inheritSdk();
134
135       RootPolicy<Object> visitor = new RootPolicy<Object>() {
136         @Override
137         public Object visitLibraryOrderEntry(LibraryOrderEntry libraryOrderEntry, Object value) {
138           modifiableRootModel.removeOrderEntry(libraryOrderEntry);
139           return value;
140         }
141
142         @Override
143         public Object visitModuleOrderEntry(ModuleOrderEntry moduleOrderEntry, Object value) {
144           modifiableRootModel.removeOrderEntry(moduleOrderEntry);
145           return value;
146         }
147       };
148
149       for (OrderEntry orderEntry : modifiableRootModel.getOrderEntries()) {
150         orderEntry.accept(visitor, null);
151       }
152     }
153   }
154
155   @NotNull
156   private Collection<DataNode<E>> filterExistingModules(@NotNull Collection<DataNode<E>> modules,
157                                                         @NotNull IdeModifiableModelsProvider modelsProvider,
158                                                         @NotNull Project project) {
159     Collection<DataNode<E>> result = ContainerUtilRt.newArrayList();
160     for (DataNode<E> node : modules) {
161       ModuleData moduleData = node.getData();
162       Module module = modelsProvider.findIdeModule(moduleData.getInternalName());
163       if (module == null) {
164         result.add(node);
165       }
166       else {
167         if (!FileUtil.pathsEqual(module.getModuleFilePath(), moduleData.getModuleFilePath())) {
168           modelsProvider.getModifiableModuleModel().disposeModule(module);
169           result.add(node);
170           Set<String> orphanFiles = project.getUserData(ORPHAN_MODULE_FILES);
171           if (orphanFiles == null) {
172             project.putUserData(ORPHAN_MODULE_FILES, orphanFiles = ContainerUtil.newHashSet());
173           }
174           orphanFiles.add(module.getModuleFilePath());
175         }
176         else {
177           node.putUserData(MODULE_KEY, module);
178         }
179       }
180     }
181     return result;
182   }
183
184   private static void syncPaths(@NotNull Module module, @NotNull ModifiableRootModel modifiableModel, @NotNull ModuleData data) {
185     CompilerModuleExtension extension = modifiableModel.getModuleExtension(CompilerModuleExtension.class);
186     if (extension == null) {
187       //modifiableModel.dispose();
188       LOG.warn(String.format("Can't sync paths for module '%s'. Reason: no compiler extension is found for it", module.getName()));
189       return;
190     }
191     String compileOutputPath = data.getCompileOutputPath(ExternalSystemSourceType.SOURCE);
192     extension.setCompilerOutputPath(compileOutputPath != null ? VfsUtilCore.pathToUrl(compileOutputPath) : null);
193
194     String testCompileOutputPath = data.getCompileOutputPath(ExternalSystemSourceType.TEST);
195     extension.setCompilerOutputPathForTests(testCompileOutputPath != null ? VfsUtilCore.pathToUrl(testCompileOutputPath) : null);
196
197     extension.inheritCompilerOutputPath(data.isInheritProjectCompileOutputPath());
198   }
199
200   @Override
201   public void removeData(@NotNull final Computable<Collection<Module>> toRemoveComputable,
202                          @NotNull final Collection<DataNode<E>> toIgnore,
203                          @NotNull final ProjectData projectData,
204                          @NotNull final Project project,
205                          @NotNull final IdeModifiableModelsProvider modelsProvider) {
206     final Collection<Module> toRemove = toRemoveComputable.compute();
207     final List<Module> modules = new SmartList<Module>(toRemove);
208     for (DataNode<E> moduleDataNode : toIgnore) {
209       final Module module = modelsProvider.findIdeModule(moduleDataNode.getData());
210       ContainerUtil.addIfNotNull(modules, module);
211     }
212
213     if (modules.isEmpty()) {
214       return;
215     }
216
217     ContainerUtil.removeDuplicates(modules);
218
219     for (Module module : modules) {
220       if (module.isDisposed()) continue;
221       unlinkModuleFromExternalSystem(module);
222     }
223
224     ruleOrphanModules(modules, project, projectData.getOwner(), new Consumer<List<Module>>() {
225       @Override
226       public void consume(final List<Module> modules) {
227         for (Module module : modules) {
228           if (module.isDisposed()) continue;
229           String path = module.getModuleFilePath();
230           final ModifiableModuleModel moduleModel = modelsProvider.getModifiableModuleModel();
231           moduleModel.disposeModule(module);
232           ModuleBuilder.deleteModuleFile(path);
233         }
234       }
235     });
236   }
237
238   /**
239    * There is a possible case that an external module has been un-linked from ide project. There are two ways to process
240    * ide modules which correspond to that external project:
241    * <pre>
242    * <ol>
243    *   <li>Remove them from ide project as well;</li>
244    *   <li>Keep them at ide project as well;</li>
245    * </ol>
246    * </pre>
247    * This method handles that situation, i.e. it asks a user what should be done and acts accordingly.
248    *
249    * @param orphanModules    modules which correspond to the un-linked external project
250    * @param project          current ide project
251    * @param externalSystemId id of the external system which project has been un-linked from ide project
252    */
253   private static void ruleOrphanModules(@NotNull final List<Module> orphanModules,
254                                         @NotNull final Project project,
255                                         @NotNull final ProjectSystemId externalSystemId,
256                                         @NotNull final Consumer<List<Module>> result) {
257     ExternalSystemApiUtil.executeOnEdt(true, new Runnable() {
258       @Override
259       public void run() {
260         List<Module> toRemove = ContainerUtil.newSmartList();
261         if (ApplicationManager.getApplication().isHeadlessEnvironment()) {
262           toRemove.addAll(orphanModules);
263         }
264         else {
265           final JPanel content = new JPanel(new GridBagLayout());
266           content.add(new JLabel(ExternalSystemBundle.message("orphan.modules.text", externalSystemId.getReadableName())),
267                       ExternalSystemUiUtil.getFillLineConstraints(0));
268
269           final CheckBoxList<Module> orphanModulesList = new CheckBoxList<Module>();
270           orphanModulesList.setSelectionMode(ListSelectionModel.MULTIPLE_INTERVAL_SELECTION);
271           orphanModulesList.setItems(orphanModules, new Function<Module, String>() {
272             @Override
273             public String fun(Module module) {
274               return module.getName();
275             }
276           });
277           for (Module module : orphanModules) {
278             orphanModulesList.setItemSelected(module, true);
279           }
280           orphanModulesList.setBorder(IdeBorderFactory.createEmptyBorder(8));
281           content.add(orphanModulesList, ExternalSystemUiUtil.getFillLineConstraints(0));
282           content.setBorder(IdeBorderFactory.createEmptyBorder(0, 0, 8, 0));
283
284           DialogWrapper dialog = new DialogWrapper(project) {
285             {
286               setTitle(ExternalSystemBundle.message("import.title", externalSystemId.getReadableName()));
287               init();
288             }
289
290             @Nullable
291             @Override
292             protected JComponent createCenterPanel() {
293               return new JBScrollPane(content);
294             }
295
296             @NotNull
297             protected Action[] createActions() {
298               return new Action[]{getOKAction()};
299             }
300           };
301
302           dialog.showAndGet();
303
304           for (int i = 0; i < orphanModules.size(); i++) {
305             Module module = orphanModules.get(i);
306             if (orphanModulesList.isItemSelected(i)) {
307               toRemove.add(module);
308             }
309           }
310         }
311         result.consume(toRemove);
312       }
313     });
314   }
315
316   public static void unlinkModuleFromExternalSystem(@NotNull Module module) {
317     module.clearOption(ExternalSystemConstants.EXTERNAL_SYSTEM_ID_KEY);
318     module.clearOption(ExternalSystemConstants.LINKED_PROJECT_ID_KEY);
319     module.clearOption(ExternalSystemConstants.LINKED_PROJECT_PATH_KEY);
320     module.clearOption(ExternalSystemConstants.ROOT_PROJECT_PATH_KEY);
321     module.clearOption(ExternalSystemConstants.EXTERNAL_SYSTEM_MODULE_GROUP_KEY);
322     module.clearOption(ExternalSystemConstants.EXTERNAL_SYSTEM_MODULE_VERSION_KEY);
323   }
324
325   protected void setModuleOptions(Module module, DataNode<E> moduleDataNode) {
326     ModuleData moduleData = moduleDataNode.getData();
327     module.putUserData(MODULE_DATA_KEY, moduleData);
328
329     module.setOption(ExternalSystemConstants.EXTERNAL_SYSTEM_ID_KEY, moduleData.getOwner().toString());
330     module.setOption(ExternalSystemConstants.LINKED_PROJECT_ID_KEY, moduleData.getId());
331     module.setOption(ExternalSystemConstants.LINKED_PROJECT_PATH_KEY, moduleData.getLinkedExternalProjectPath());
332     final ProjectData projectData = moduleDataNode.getData(ProjectKeys.PROJECT);
333     module.setOption(ExternalSystemConstants.ROOT_PROJECT_PATH_KEY, projectData != null ? projectData.getLinkedExternalProjectPath() : "");
334
335     if (moduleData.getGroup() != null) {
336       module.setOption(ExternalSystemConstants.EXTERNAL_SYSTEM_MODULE_GROUP_KEY, moduleData.getGroup());
337     }
338     if (moduleData.getVersion() != null) {
339       module.setOption(ExternalSystemConstants.EXTERNAL_SYSTEM_MODULE_VERSION_KEY, moduleData.getVersion());
340     }
341
342     // clear maven option
343     module.clearOption("org.jetbrains.idea.maven.project.MavenProjectsManager.isMavenModule");
344   }
345
346   @Override
347   public void postProcess(@NotNull Collection<DataNode<E>> toImport,
348                           @Nullable ProjectData projectData,
349                           @NotNull Project project,
350                           @NotNull IdeModifiableModelsProvider modelsProvider) {
351     for (DataNode<E> moduleDataNode : toImport) {
352       final Module module = moduleDataNode.getUserData(MODULE_KEY);
353       if (module == null) continue;
354       final Map<OrderEntry, OrderAware> orderAwareMap = moduleDataNode.getUserData(ORDERED_DATA_MAP_KEY);
355       if (orderAwareMap != null) {
356         rearrangeOrderEntries(orderAwareMap, modelsProvider.getModifiableRootModel(module));
357       }
358       setBytecodeTargetLevel(project, module, moduleDataNode.getData());
359     }
360   }
361
362   @Override
363   public void onSuccessImport(@NotNull Project project) {
364     final Set<String> orphanFiles = project.getUserData(ORPHAN_MODULE_FILES);
365     if (orphanFiles != null && !orphanFiles.isEmpty()) {
366       ExternalSystemApiUtil.executeOnEdt(false, new Runnable() {
367         @Override
368         public void run() {
369           for (String orphanFile : orphanFiles) {
370             ModuleBuilder.deleteModuleFile(orphanFile);
371           }
372         }
373       });
374       project.putUserData(ORPHAN_MODULE_FILES, null);
375     }
376   }
377
378   protected void rearrangeOrderEntries(@NotNull Map<OrderEntry, OrderAware> orderEntryDataMap,
379                                        @NotNull ModifiableRootModel modifiableRootModel) {
380     final OrderEntry[] orderEntries = modifiableRootModel.getOrderEntries();
381     final int length = orderEntries.length;
382     final OrderEntry[] newOrder = new OrderEntry[length];
383     final PriorityQueue<Pair<OrderEntry, OrderAware>> priorityQueue = new PriorityQueue<Pair<OrderEntry, OrderAware>>(
384       11, new Comparator<Pair<OrderEntry, OrderAware>>() {
385       @Override
386       public int compare(Pair<OrderEntry, OrderAware> o1, Pair<OrderEntry, OrderAware> o2) {
387         int order1 = o1.second.getOrder();
388         int order2 = o2.second.getOrder();
389         return order1 != order2 ? order1 < order2 ? -1 : 1 : 0;
390       }
391     });
392
393     int shift = 0;
394     for (int i = 0; i < length; i++) {
395       OrderEntry orderEntry = orderEntries[i];
396       final OrderAware orderAware = orderEntryDataMap.get(orderEntry);
397       if (orderAware == null) {
398         newOrder[i] = orderEntry;
399         shift++;
400       }
401       else {
402         priorityQueue.add(Pair.create(orderEntry, orderAware));
403       }
404     }
405
406     Pair<OrderEntry, OrderAware> pair;
407     while ((pair = priorityQueue.poll()) != null) {
408       final OrderEntry orderEntry = pair.first;
409       final OrderAware orderAware = pair.second;
410       final int order = orderAware.getOrder() != -1 ? orderAware.getOrder() : length - 1;
411       final int newPlace = findNewPlace(newOrder, order - shift);
412       assert newPlace != -1;
413       newOrder[newPlace] = orderEntry;
414     }
415
416     if (LOG.isDebugEnabled()) {
417       final boolean changed = !ArrayUtil.equals(orderEntries, newOrder, new Comparator<OrderEntry>() {
418         @Override
419         public int compare(OrderEntry o1, OrderEntry o2) {
420           return o1.compareTo(o2);
421         }
422       });
423       LOG.debug(String.format("rearrange status (%s): %s", modifiableRootModel.getModule(), changed ? "modified" : "not modified"));
424     }
425     modifiableRootModel.rearrangeOrderEntries(newOrder);
426   }
427
428   private static int findNewPlace(OrderEntry[] newOrder, int newIndex) {
429     int idx = newIndex;
430     while (idx < 0 || (idx < newOrder.length && newOrder[idx] != null)) {
431       idx++;
432     }
433     if (idx >= newOrder.length) {
434       idx = newIndex - 1;
435       while (idx >= 0 && (idx >= newOrder.length || newOrder[idx] != null)) {
436         idx--;
437       }
438     }
439     return idx == -1 ? -1 : idx;
440   }
441
442   private void setLanguageLevel(@NotNull ModifiableRootModel modifiableRootModel, E data) {
443     LanguageLevel level = LanguageLevel.parse(data.getSourceCompatibility());
444     if (level != null) {
445       try {
446         modifiableRootModel.getModuleExtension(LanguageLevelModuleExtension.class).setLanguageLevel(level);
447       }
448       catch (IllegalArgumentException e) {
449         LOG.debug(e);
450       }
451     }
452   }
453
454   private void setBytecodeTargetLevel(@NotNull Project project, @NotNull Module module, @NotNull E data) {
455     String targetLevel = data.getTargetCompatibility();
456     if (targetLevel != null) {
457       CompilerConfiguration configuration = CompilerConfiguration.getInstance(project);
458       configuration.setBytecodeTargetLevel(module, targetLevel);
459     }
460   }
461 }