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