45f8d8ba8b8110be4f3027ca64e76856fe358c21
[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 = lessonDir.findChild(EduNames.TASK + String.valueOf(task.getIndex()));
120             if (taskDir == null) continue;
121             VirtualFile studentFileDir = VfsUtil.findRelativeFile(archiveFolder, lessonDir.getName(), taskDir.getName());
122             if (studentFileDir == null) {
123               continue;
124             }
125             for (String taskFile : task.getTaskFiles().keySet()) {
126               VirtualFile answerFile = taskDir.findChild(taskFile);
127               if (answerFile == null) {
128                 continue;
129               }
130               EduUtils.createStudentFile(this, project, answerFile, studentFileDir, task, 0);
131             }
132         }
133       }
134     }
135     });
136   }
137
138   private static void copyChild(VirtualFile archiveFolder, FileFilter filter, VirtualFile child, File fromFile) {
139     File toFile = new File(archiveFolder.getPath(), child.getName());
140
141     try {
142       if (child.isDirectory()) {
143         FileUtil.copyDir(fromFile, toFile, filter);
144       }
145       else {
146         if (filter.accept(fromFile)) {
147           FileUtil.copy(fromFile, toFile);
148         }
149       }
150     }
151     catch (IOException e) {
152       LOG.info("Failed to copy" + fromFile.getPath(), e);
153     }
154   }
155
156   private static void synchronize(@NotNull final Project project) {
157     VirtualFileManager.getInstance().refreshWithoutFileWatcher(true);
158     ProjectView.getInstance(project).refresh();
159   }
160
161   private static void packCourse(@NotNull final VirtualFile baseDir, String locationDir, String zipName, boolean showMessage) {
162     try {
163       final File zipFile = new File(locationDir, zipName + ".zip");
164       ZipOutputStream zos = new ZipOutputStream(new BufferedOutputStream(new FileOutputStream(zipFile)));
165       VirtualFile[] courseFiles = baseDir.getChildren();
166       for (VirtualFile file : courseFiles) {
167         ZipUtil.addFileOrDirRecursively(zos, null, new File(file.getPath()), file.getName(), null, null);
168       }
169       zos.close();
170       if (showMessage) {
171         Messages.showInfoMessage("Course archive was saved to " + zipFile.getPath(), "Course Archive Was Created Successfully");
172       }
173     }
174     catch (IOException e1) {
175       LOG.error(e1);
176     }
177   }
178
179   @SuppressWarnings("IOResourceOpenedButNotSafelyClosed")
180   private static void generateJson(VirtualFile parentDir, Course course) {
181     final Gson gson = new GsonBuilder().setPrettyPrinting().excludeFieldsWithoutExposeAnnotation().create();
182     final String json = gson.toJson(course);
183     final File courseJson = new File(parentDir.getPath(), EduNames.COURSE_META_FILE);
184     OutputStreamWriter outputStreamWriter = null;
185     try {
186       outputStreamWriter = new OutputStreamWriter(new FileOutputStream(courseJson), "UTF-8");
187       outputStreamWriter.write(json);
188     }
189     catch (Exception e) {
190       Messages.showErrorDialog(e.getMessage(), "Failed to Generate Json");
191       LOG.info(e);
192     }
193     finally {
194       try {
195         if (outputStreamWriter != null) {
196           outputStreamWriter.close();
197         }
198       }
199       catch (IOException e1) {
200         //close silently
201       }
202     }
203   }
204 }