support src folder in archive
[idea/community.git] / python / educational-core / course-creator / src / com / jetbrains / edu / coursecreator / actions / CCCreateCourseArchive.java
1 package com.jetbrains.edu.coursecreator.actions;
2
3 import com.google.gson.Gson;
4 import com.google.gson.GsonBuilder;
5 import com.intellij.ide.projectView.ProjectView;
6 import com.intellij.openapi.actionSystem.AnActionEvent;
7 import com.intellij.openapi.actionSystem.CommonDataKeys;
8 import com.intellij.openapi.actionSystem.LangDataKeys;
9 import com.intellij.openapi.actionSystem.Presentation;
10 import com.intellij.openapi.application.ApplicationManager;
11 import com.intellij.openapi.diagnostic.Logger;
12 import com.intellij.openapi.module.Module;
13 import com.intellij.openapi.project.DumbAwareAction;
14 import com.intellij.openapi.project.Project;
15 import com.intellij.openapi.ui.DialogWrapper;
16 import com.intellij.openapi.ui.Messages;
17 import com.intellij.openapi.util.io.FileUtil;
18 import com.intellij.openapi.vfs.VfsUtil;
19 import com.intellij.openapi.vfs.VirtualFile;
20 import com.intellij.openapi.vfs.VirtualFileManager;
21 import com.intellij.util.io.ZipUtil;
22 import com.jetbrains.edu.coursecreator.CCLanguageManager;
23 import com.jetbrains.edu.coursecreator.CCUtils;
24 import com.jetbrains.edu.coursecreator.ui.CreateCourseArchiveDialog;
25 import com.jetbrains.edu.learning.StudyTaskManager;
26 import com.jetbrains.edu.learning.core.EduNames;
27 import com.jetbrains.edu.learning.core.EduUtils;
28 import com.jetbrains.edu.learning.courseFormat.Course;
29 import com.jetbrains.edu.learning.courseFormat.Lesson;
30 import com.jetbrains.edu.learning.courseFormat.Task;
31 import com.jetbrains.edu.learning.statistics.EduUsagesCollector;
32 import org.jetbrains.annotations.NotNull;
33
34 import java.io.*;
35 import java.util.zip.ZipOutputStream;
36
37 public class CCCreateCourseArchive extends DumbAwareAction {
38   private static final Logger LOG = Logger.getInstance(CCCreateCourseArchive.class.getName());
39   public static final String GENERATE_COURSE_ARCHIVE = "Generate Course Archive";
40   private String myZipName;
41   private String myLocationDir;
42
43   public void setZipName(String zipName) {
44     myZipName = zipName;
45   }
46
47   public void setLocationDir(String locationDir) {
48     myLocationDir = locationDir;
49   }
50
51   public CCCreateCourseArchive() {
52     super(GENERATE_COURSE_ARCHIVE, GENERATE_COURSE_ARCHIVE, null);
53   }
54
55   @Override
56   public void update(@NotNull AnActionEvent e) {
57     Presentation presentation = e.getPresentation();
58     Project project = e.getProject();
59     presentation.setEnabledAndVisible(project != null && CCUtils.isCourseCreator(project));
60   }
61
62   @Override
63   public void actionPerformed(@NotNull AnActionEvent e) {
64     final Project project = e.getData(CommonDataKeys.PROJECT);
65     final Module module = e.getData(LangDataKeys.MODULE);
66     if (project == null || module == null) {
67       return;
68     }
69     CreateCourseArchiveDialog dlg = new CreateCourseArchiveDialog(project, this);
70     dlg.show();
71     if (dlg.getExitCode() != DialogWrapper.OK_EXIT_CODE) {
72       return;
73     }
74     createCourseArchive(project, module, myZipName, myLocationDir, true);
75     EduUsagesCollector.createdCourseArchive();
76   }
77
78   public static void createCourseArchive(final Project project, Module module, String zipName, String locationDir, boolean showMessage) {
79     final Course course = StudyTaskManager.getInstance(project).getCourse();
80     if (course == null) return;
81     final VirtualFile baseDir = project.getBaseDir();
82     VirtualFile archiveFolder = CCUtils.generateFolder(project, module, zipName);
83     if (archiveFolder == null) {
84       return;
85     }
86
87     CCLanguageManager manager = CCUtils.getStudyLanguageManager(course);
88     if (manager == null) {
89       return;
90     }
91     FileFilter filter = pathname -> !manager.doNotPackFile(pathname);
92
93     for (VirtualFile child : baseDir.getChildren()) {
94       String name = child.getName();
95       File fromFile = new File(child.getPath());
96       if (CCUtils.GENERATED_FILES_FOLDER.equals(name) || ".idea".equals(name)
97           || name.contains("iml") || manager.doNotPackFile(fromFile)) {
98         continue;
99       }
100       copyChild(archiveFolder, filter, child, fromFile);
101     }
102
103     ApplicationManager.getApplication().runWriteAction(new Runnable() {
104       @Override
105       public void run() {
106         Course courseCopy = course.copy();
107         replaceAnswerFilesWithTaskFiles(courseCopy);
108         generateJson(archiveFolder, courseCopy);
109         VirtualFileManager.getInstance().refreshWithoutFileWatcher(false);
110         packCourse(archiveFolder, locationDir, zipName, showMessage);
111         synchronize(project);
112       }
113
114       private void replaceAnswerFilesWithTaskFiles(Course courseCopy) {
115         for (Lesson lesson : courseCopy.getLessons()) {
116           final VirtualFile lessonDir = baseDir.findChild(EduNames.LESSON + String.valueOf(lesson.getIndex()));
117           if (lessonDir == null) continue;
118           for (Task task : lesson.getTaskList()) {
119             final VirtualFile taskDir = task.getTaskDir(project);
120             if (taskDir == null) continue;
121             String taskDirName = EduNames.TASK + String.valueOf(task.getIndex());
122             VirtualFile studentFileDir = VfsUtil.findRelativeFile(archiveFolder, lessonDir.getName(), taskDirName);
123             if (studentFileDir == null) {
124               continue;
125             }
126             VirtualFile srcDir = studentFileDir.findChild(EduNames.SRC);
127             if (srcDir != null) {
128               studentFileDir = srcDir;
129             }
130             for (String taskFile : task.getTaskFiles().keySet()) {
131               VirtualFile answerFile = taskDir.findChild(taskFile);
132               if (answerFile == null) {
133                 continue;
134               }
135               EduUtils.createStudentFile(this, project, answerFile, studentFileDir, task, 0);
136             }
137         }
138       }
139     }
140     });
141   }
142
143   private static void copyChild(VirtualFile archiveFolder, FileFilter filter, VirtualFile child, File fromFile) {
144     File toFile = new File(archiveFolder.getPath(), child.getName());
145
146     try {
147       if (child.isDirectory()) {
148         FileUtil.copyDir(fromFile, toFile, filter);
149       }
150       else {
151         if (filter.accept(fromFile)) {
152           FileUtil.copy(fromFile, toFile);
153         }
154       }
155     }
156     catch (IOException e) {
157       LOG.info("Failed to copy" + fromFile.getPath(), e);
158     }
159   }
160
161   private static void synchronize(@NotNull final Project project) {
162     VirtualFileManager.getInstance().refreshWithoutFileWatcher(true);
163     ProjectView.getInstance(project).refresh();
164   }
165
166   private static void packCourse(@NotNull final VirtualFile baseDir, String locationDir, String zipName, boolean showMessage) {
167     try {
168       final File zipFile = new File(locationDir, zipName + ".zip");
169       ZipOutputStream zos = new ZipOutputStream(new BufferedOutputStream(new FileOutputStream(zipFile)));
170       VirtualFile[] courseFiles = baseDir.getChildren();
171       for (VirtualFile file : courseFiles) {
172         ZipUtil.addFileOrDirRecursively(zos, null, new File(file.getPath()), file.getName(), null, null);
173       }
174       zos.close();
175       if (showMessage) {
176         Messages.showInfoMessage("Course archive was saved to " + zipFile.getPath(), "Course Archive Was Created Successfully");
177       }
178     }
179     catch (IOException e1) {
180       LOG.error(e1);
181     }
182   }
183
184   @SuppressWarnings("IOResourceOpenedButNotSafelyClosed")
185   private static void generateJson(VirtualFile parentDir, Course course) {
186     final Gson gson = new GsonBuilder().setPrettyPrinting().excludeFieldsWithoutExposeAnnotation().create();
187     final String json = gson.toJson(course);
188     final File courseJson = new File(parentDir.getPath(), EduNames.COURSE_META_FILE);
189     OutputStreamWriter outputStreamWriter = null;
190     try {
191       outputStreamWriter = new OutputStreamWriter(new FileOutputStream(courseJson), "UTF-8");
192       outputStreamWriter.write(json);
193     }
194     catch (Exception e) {
195       Messages.showErrorDialog(e.getMessage(), "Failed to Generate Json");
196       LOG.info(e);
197     }
198     finally {
199       try {
200         if (outputStreamWriter != null) {
201           outputStreamWriter.close();
202         }
203       }
204       catch (IOException e1) {
205         //close silently
206       }
207     }
208   }
209 }