OO-2636: archive in one big excel file

src/main/java/org/olat/core/util/openxml/OpenXMLWorkbook.java

@@ -561,7 +561,11 @@ public class OpenXMLWorkbook implements Closeable {
 			int count = 1;
 			for(OpenXMLWorksheet sheet:worksheets) {
 				writer.writeStartElement("sheet");
-				writer.writeAttribute("name", "Sheet " + count);
+				if(StringHelper.containsNonWhitespace(sheet.getName())) {
+					writer.writeAttribute("name", sheet.getName());
+				} else {
+					writer.writeAttribute("name", "Sheet " + count);
+				}
 				writer.writeAttribute("sheetId", Integer.toString(count++));
 				writer.writeAttribute("r:id", sheet.getId());
 				writer.writeEndElement();

src/main/java/org/olat/core/util/openxml/OpenXMLWorksheet.java

@@ -51,6 +51,7 @@ public class OpenXMLWorksheet {
 	}
 	
 	private String id;
+	private String name;
 	private final OpenXMLWorkbook workbook;
 	private final ZipOutputStream zout;
 	private XMLStreamWriter writer;
@@ -72,6 +73,14 @@ public class OpenXMLWorksheet {
 		return id;
 	}
 	
+	public String getName() {
+		return name;
+	}
+
+	public void setName(String name) {
+		this.name = name;
+	}
+
 	public int getHeaderRows() {
 		return headerRows;
 	}

src/main/java/org/olat/course/run/CourseRuntimeController.java

@@ -1383,7 +1383,7 @@ public class CourseRuntimeController extends RepositoryEntryRuntimeController im
 
 				OLATResourceable ores = OresHelper.createOLATResourceableType("lecturesAdmin");
 				WindowControl swControl = addToHistory(ureq, ores, null);
-				LectureRepositoryAdminController ctrl = new LectureRepositoryAdminController(ureq, swControl, getRepositoryEntry());
+				LectureRepositoryAdminController ctrl = new LectureRepositoryAdminController(ureq, swControl, toolbarPanel, getRepositoryEntry());
 				listenTo(ctrl);
 				lecturesAdminCtrl = pushController(ureq, translate("command.options.lectures.admin"), ctrl);
 				setActiveTool(lecturesAdminLink);

src/main/java/org/olat/modules/lecture/LectureBlock.java

@@ -109,6 +109,8 @@ public interface LectureBlock extends LectureBlockRef, ModifiedInfo, CreateInfo,
 	 * @param rollCallStatus Cannot be null
 	 */
 	public void setRollCallStatus(LectureRollCallStatus rollCallStatus);
+	
+	public Date getAutoClosedDate();
 
 	public RepositoryEntry getEntry();
 

src/main/java/org/olat/modules/lecture/ui/LectureListRepositoryController.java

@@ -148,7 +148,7 @@ public class LectureListRepositoryController extends FormBasicController {
 		FlexiTableSortOptions options = new FlexiTableSortOptions();
 		options.setDefaultOrderBy(new SortKey(BlockCols.date.name(), false));
 		tableEl.setSortSettings(options);
-		//TODO absence tableEl.setAndLoadPersistedPreferences(ureq, "repo-lecture-block-list");
+		tableEl.setAndLoadPersistedPreferences(ureq, "repo-lecture-block-list");
 	}
 	
 	private void loadModel() {

src/main/java/org/olat/modules/lecture/ui/LectureRepositoryAdminController.java

@@ -26,11 +26,15 @@ import org.olat.core.gui.components.link.LinkFactory;
 import org.olat.core.gui.components.segmentedview.SegmentViewComponent;
 import org.olat.core.gui.components.segmentedview.SegmentViewEvent;
 import org.olat.core.gui.components.segmentedview.SegmentViewFactory;
+import org.olat.core.gui.components.stack.TooledController;
+import org.olat.core.gui.components.stack.TooledStackedPanel;
+import org.olat.core.gui.components.stack.TooledStackedPanel.Align;
 import org.olat.core.gui.components.velocity.VelocityContainer;
 import org.olat.core.gui.control.Controller;
 import org.olat.core.gui.control.Event;
 import org.olat.core.gui.control.WindowControl;
 import org.olat.core.gui.control.controller.BasicController;
+import org.olat.modules.lecture.ui.export.LecturesBlocksEntryExport;
 import org.olat.repository.RepositoryEntry;
 
 /**
@@ -39,10 +43,12 @@ import org.olat.repository.RepositoryEntry;
  * @author srosse, stephane.rosse@frentix.com, http://www.frentix.com
  *
  */
-public class LectureRepositoryAdminController extends BasicController {
+public class LectureRepositoryAdminController extends BasicController implements TooledController {
 	
+	private Link archiveLink;
 	private final VelocityContainer mainVC;
 	private final SegmentViewComponent segmentView;
+	private final TooledStackedPanel stackPanel;
 	private final Link lecturesLink, settingsLink, participantsLink;
 	
 	private LectureListRepositoryController lecturesCtrl;
@@ -52,9 +58,11 @@ public class LectureRepositoryAdminController extends BasicController {
 	private RepositoryEntry entry;
 	private boolean configurationChanges = false;
 	
-	public LectureRepositoryAdminController(UserRequest ureq, WindowControl wControl, RepositoryEntry entry) {
+	public LectureRepositoryAdminController(UserRequest ureq, WindowControl wControl, TooledStackedPanel stackPanel,
+			RepositoryEntry entry) {
 		super(ureq, wControl);
 		this.entry = entry;
+		this.stackPanel = stackPanel;
 		
 		mainVC = createVelocityContainer("admin_repository");
 		
@@ -93,6 +101,14 @@ public class LectureRepositoryAdminController extends BasicController {
 		//
 	}
 
+	@Override
+	public void initTools() {
+		archiveLink = LinkFactory.createToolLink("archive.entry", translate("archive.entry"), this);
+		archiveLink.setIconLeftCSS("o_icon o_icon_archive_tool");
+		archiveLink.setVisible(settingsCtrl.isLectureEnabled());
+		stackPanel.addTool(archiveLink, Align.right);
+	}
+
 	@Override
 	protected void event(UserRequest ureq, Component source, Event event) {
 		if(source == segmentView) {
@@ -108,6 +124,8 @@ public class LectureRepositoryAdminController extends BasicController {
 					doOpenParticipants(ureq);
 				}
 			}
+		} else if(archiveLink == source) {
+			doExportArchive(ureq);
 		}
 	}
 	
@@ -156,4 +174,9 @@ public class LectureRepositoryAdminController extends BasicController {
 		}
 		mainVC.put("segmentCmp", participantsCtrl.getInitialComponent());
 	}
+	
+	private void doExportArchive(UserRequest ureq) {
+		LecturesBlocksEntryExport archive = new LecturesBlocksEntryExport(entry, getTranslator());
+		ureq.getDispatchResult().setResultingMediaResource(archive);
+	}
 }
\ No newline at end of file

src/main/java/org/olat/modules/lecture/ui/ParticipantListRepositoryController.java

@@ -69,7 +69,7 @@ import org.springframework.beans.factory.annotation.Autowired;
  */
 public class ParticipantListRepositoryController extends FormBasicController {
 	
-	protected static final String USER_PROPS_ID = ParticipantListRepositoryController.class.getCanonicalName();
+	public static final String USER_PROPS_ID = ParticipantListRepositoryController.class.getCanonicalName();
 
 	public static final int USER_PROPS_OFFSET = 500;
 	

src/main/java/org/olat/modules/lecture/ui/TeacherLecturesTableController.java

@@ -66,6 +66,8 @@ import org.olat.modules.lecture.model.LectureBlockRow;
 import org.olat.modules.lecture.model.RollCallSecurityCallbackImpl;
 import org.olat.modules.lecture.ui.TeacherOverviewDataModel.TeachCols;
 import org.olat.modules.lecture.ui.component.LectureBlockStatusCellRenderer;
+import org.olat.modules.lecture.ui.export.LectureBlockExport;
+import org.olat.modules.lecture.ui.export.LecturesBlockPDFExport;
 import org.olat.user.UserManager;
 import org.springframework.beans.factory.annotation.Autowired;
 

src/main/java/org/olat/modules/lecture/ui/TeacherRollCallController.java

@@ -71,6 +71,7 @@ import org.olat.modules.lecture.LectureService;
 import org.olat.modules.lecture.RollCallSecurityCallback;
 import org.olat.modules.lecture.ui.TeacherRollCallDataModel.RollCols;
 import org.olat.modules.lecture.ui.component.LectureBlockRollCallStatusItem;
+import org.olat.modules.lecture.ui.export.LecturesBlockPDFExport;
 import org.olat.user.UserManager;
 import org.olat.user.propertyhandlers.UserPropertyHandler;
 import org.springframework.beans.factory.annotation.Autowired;

src/main/java/org/olat/modules/lecture/ui/_i18n/LocalStrings_de.properties

@@ -16,6 +16,7 @@ attendance.list=Anwesenheitsliste
 authorized.absence=Entschuldigt
 authorized.absence.reason=Begr\u00FCndung
 autoclosed=Autoerledigt
+archive.entry=Archivierung
 bulk=Benutzername, $org.olat.user.propertyhandlers\:table.name.email oder $org.olat.user.propertyhandlers\:table.name.institutionalUserIdentifier
 bulk.example=test01<br>author02<br>test@openolat.org
 bulk.hint=Sie k\u00F6nenn eine Liste von Benutzername oder Email Adresse von Benutzer geben.
@@ -188,6 +189,7 @@ table.header.absent.lectures=Abwesend
 table.header.actions=<i class\='o_icon o_icon_actions o_icon-lg'> </i>
 table.header.attended.lectures=Anwesend
 table.header.authorized.absence=Entschuldigt
+table.header.auto.close.date=Auto closed am
 table.header.comment=Kommentar
 table.header.compulsory=<i class\='o_icon o_icon_compulsory o_icon-lg'> </i>
 table.header.date=Datum

src/main/java/org/olat/modules/lecture/ui/_i18n/LocalStrings_en.properties

@@ -16,6 +16,7 @@ attendance.list=Attendance list
 authorized.absence=Authorized
 authorized.absence.reason=Reason
 autoclosed=Auto-closed
+archive.entry=Archive
 bulk=User names, $org.olat.user.propertyhandlers\:table.name.email oder $org.olat.user.propertyhandlers\:table.name.institutionalUserIdentifier
 bulk.example=test01<br>author02<br>test@openolat.org
 bulk.hint=You can give a list of user names or email addresses separated by a return.
@@ -187,6 +188,7 @@ table.header.absent.lectures=Absent
 table.header.actions=<i class\='o_icon o_icon_actions o_icon-lg'> </i>
 table.header.attended.lectures=Attended
 table.header.authorized.absence=Excused
+table.header.auto.close.date=Auto closed at
 table.header.comment=Comment
 table.header.compulsory=<i class\='o_icon o_icon_compulsory o_icon-lg'> </i>
 table.header.date=Date

src/main/java/org/olat/modules/lecture/ui/LectureBlockExport.java → src/main/java/org/olat/modules/lecture/ui/export/LectureBlockExport.java

@@ -17,7 +17,7 @@
  * frentix GmbH, http://www.frentix.com
  * <p>
  */
-package org.olat.modules.lecture.ui;
+package org.olat.modules.lecture.ui.export;
 
 import java.io.IOException;
 import java.io.OutputStream;
@@ -40,6 +40,7 @@ import org.olat.core.util.openxml.OpenXMLWorksheet.Row;
 import org.olat.modules.lecture.LectureBlock;
 import org.olat.modules.lecture.LectureBlockRollCall;
 import org.olat.modules.lecture.LectureService;
+import org.olat.modules.lecture.ui.ParticipantListRepositoryController;
 import org.olat.user.UserManager;
 import org.olat.user.propertyhandlers.UserPropertyHandler;
 
@@ -86,17 +87,21 @@ public class LectureBlockExport extends OpenXMLWorkbookResource {
 	protected void generate(OutputStream out) {
 		try(OpenXMLWorkbook workbook = new OpenXMLWorkbook(out, 1)) {
 			OpenXMLWorksheet exportSheet = workbook.nextWorksheet();
-			exportSheet.setHeaderRows(3);
-			addHeaders_1(exportSheet);
-			addHeaders_2(exportSheet);
-			addHeaders_3(exportSheet);
-			addContent(exportSheet);
-			addFooter(exportSheet);
+			generate(exportSheet);
 		} catch (IOException e) {
 			log.error("", e);
 		}
 	}
 	
+	protected void generate(OpenXMLWorksheet exportSheet) {
+		exportSheet.setHeaderRows(3);
+		addHeaders_1(exportSheet);
+		addHeaders_2(exportSheet);
+		addHeaders_3(exportSheet);
+		addContent(exportSheet);
+		addFooter(exportSheet);
+	}
+	
 	private void addFooter(OpenXMLWorksheet exportSheet) {
 		exportSheet.newRow();
 		exportSheet.newRow();
@@ -230,6 +235,4 @@ public class LectureBlockExport extends OpenXMLWorkbookResource {
 			}
 		}
 	}
-	
-
 }

src/main/java/org/olat/modules/lecture/ui/LecturesBlockPDFExport.java → src/main/java/org/olat/modules/lecture/ui/export/LecturesBlockPDFExport.java

@@ -17,7 +17,7 @@
  * frentix GmbH, http://www.frentix.com
  * <p>
  */
-package org.olat.modules.lecture.ui;
+package org.olat.modules.lecture.ui.export;
 
 import java.io.IOException;
 import java.io.InputStream;

src/main/java/org/olat/modules/lecture/ui/export/LecturesBlocksEntryExport.java

+/**
+ * <a href="http://www.openolat.org">
+ * OpenOLAT - Online Learning and Training</a><br>
+ * <p>
+ * Licensed under the Apache License, Version 2.0 (the "License"); <br>
+ * you may not use this file except in compliance with the License.<br>
+ * You may obtain a copy of the License at the
+ * <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache homepage</a>
+ * <p>
+ * Unless required by applicable law or agreed to in writing,<br>
+ * software distributed under the License is distributed on an "AS IS" BASIS, <br>
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. <br>
+ * See the License for the specific language governing permissions and <br>
+ * limitations under the License.
+ * <p>
+ * Initial code contributed and copyrighted by<br>
+ * frentix GmbH, http://www.frentix.com
+ * <p>
+ */
+package org.olat.modules.lecture.ui.export;
+
+import java.io.IOException;
+import java.io.OutputStream;
+import java.util.Collections;
+import java.util.Comparator;
+import java.util.Date;
+import java.util.List;
+
+import org.olat.core.CoreSpringFactory;
+import org.olat.core.gui.translator.Translator;
+import org.olat.core.id.Identity;
+import org.olat.core.logging.OLog;
+import org.olat.core.logging.Tracing;
+import org.olat.core.util.Formatter;
+import org.olat.core.util.StringHelper;
+import org.olat.core.util.openxml.OpenXMLWorkbook;
+import org.olat.core.util.openxml.OpenXMLWorkbookResource;
+import org.olat.core.util.openxml.OpenXMLWorksheet;
+import org.olat.core.util.openxml.OpenXMLWorksheet.Row;
+import org.olat.modules.lecture.LectureBlock;
+import org.olat.modules.lecture.LectureService;
+import org.olat.modules.lecture.Reason;
+import org.olat.modules.lecture.model.LectureBlockWithTeachers;
+import org.olat.repository.RepositoryEntry;
+import org.olat.user.UserManager;
+
+/**
+ * 
+ * Initial date: 6 juil. 2017<br>
+ * @author srosse, stephane.rosse@frentix.com, http://www.frentix.com
+ *
+ */
+public class LecturesBlocksEntryExport extends OpenXMLWorkbookResource {
+	
+	private static final OLog log = Tracing.createLoggerFor(LecturesBlocksEntryExport.class);
+	
+	private final Formatter formatter;
+	private final RepositoryEntry entry;
+	private final Translator translator;
+	private List<LectureBlockWithTeachers> blocks;
+
+	private final UserManager userManager;
+	private final LectureService lectureService;
+	
+	public LecturesBlocksEntryExport(RepositoryEntry entry, Translator translator) {
+		super(label(entry));
+		this.entry = entry;
+		this.translator = translator;
+		userManager = CoreSpringFactory.getImpl(UserManager.class);
+		lectureService = CoreSpringFactory.getImpl(LectureService.class);
+		formatter = Formatter.getInstance(translator.getLocale());
+	}
+	
+	private static final String label(RepositoryEntry entry) {
+		return StringHelper.transformDisplayNameToFileSystemName(entry.getDisplayname())
+				+ "_" + Formatter.formatDatetimeFilesystemSave(new Date(System.currentTimeMillis()))
+				+ ".xlsx";
+	}
+
+	@Override
+	protected void generate(OutputStream out) {
+		blocks = lectureService.getLectureBlocksWithTeachers(entry);
+		Collections.sort(blocks, new LectureBlockWithTeachersComparator());
+		
+		try(OpenXMLWorkbook workbook = new OpenXMLWorkbook(out, 1 + blocks.size())) {
+			//overview of all lecture blocks
+			OpenXMLWorksheet exportSheet = workbook.nextWorksheet();
+			exportSheet.setHeaderRows(1);
+			addHeaders(exportSheet);
+			addContent(exportSheet);
+
+			for(LectureBlockWithTeachers block:blocks) {
+				OpenXMLWorksheet exportBlockSheet = workbook.nextWorksheet();
+				LectureBlockExport lectureBlockExport = new LectureBlockExport(block.getLectureBlock(), block.getTeachers(), true, translator);
+				lectureBlockExport.generate(exportBlockSheet);
+			}
+		} catch (IOException e) {
+			log.error("", e);
+		}
+	}
+	
+	private void addHeaders(OpenXMLWorksheet exportSheet) {
+		Row headerRow = exportSheet.newRow();
+		
+		int pos = 0;
+		headerRow.addCell(pos++, translator.translate("lecture.title", null));
+		headerRow.addCell(pos++, translator.translate("lecture.location", null));
+		headerRow.addCell(pos++, translator.translate("lecture.date", null));
+		headerRow.addCell(pos++, translator.translate("table.header.start.time", null));
+		headerRow.addCell(pos++, translator.translate("table.header.end.time", null));
+		headerRow.addCell(pos++, translator.translate("table.header.teachers", null));
+		headerRow.addCell(pos++, translator.translate("table.header.status", null));
+		headerRow.addCell(pos++, translator.translate("table.header.auto.close.date", null));
+		headerRow.addCell(pos++, translator.translate("planned.lectures", null));
+		headerRow.addCell(pos++, translator.translate("table.header.effective.lectures", null));
+		headerRow.addCell(pos++, translator.translate("lecture.block.effective.end", null));
+		headerRow.addCell(pos++, translator.translate("lecture.block.effective.reason", null));
+		headerRow.addCell(pos++, translator.translate("table.header.comment", null));
+	}
+	
+	private void addContent(OpenXMLWorksheet exportSheet) {
+		for(LectureBlockWithTeachers block:blocks) {
+				Row row = exportSheet.newRow();
+				LectureBlock lectureBlock = block.getLectureBlock();
+				
+				int pos = 0;
+				row.addCell(pos++, lectureBlock.getTitle());
+				row.addCell(pos++, lectureBlock.getLocation());
+				row.addCell(pos++, formatDate(lectureBlock.getStartDate()));
+				row.addCell(pos++, formatTime(lectureBlock.getStartDate()));
+				row.addCell(pos++, formatTime(lectureBlock.getEndDate()));
+				
+				StringBuilder teachers = new StringBuilder();
+				for(Identity teacher:block.getTeachers()) {
+					if(teachers.length() > 0) teachers.append(", ");
+					teachers.append(userManager.getUserDisplayName(teacher));
+				}
+				row.addCell(pos++, teachers.toString());
+				if(lectureBlock.getRollCallStatus() == null) {
+					pos++;
+				} else {
+					row.addCell(pos++, translator.translate(lectureBlock.getRollCallStatus().name()));
+				}
+				row.addCell(pos++, formatter.formatDate(lectureBlock.getAutoClosedDate()));
+				
+				row.addCell(pos++, toInt(lectureBlock.getPlannedLecturesNumber()));
+				row.addCell(pos++, toInt(lectureBlock.getEffectiveLecturesNumber()));
+				row.addCell(pos++, formatTime(lectureBlock.getEffectiveEndDate()));
+				
+				Reason reason = lectureBlock.getReasonEffectiveEnd();
+				if(reason == null) {
+					pos++;
+				} else {
+					row.addCell(pos++, reason.getTitle());
+				}
+				row.addCell(pos++, lectureBlock.getComment());
+
+		}
+	}
+	
+	private String toInt(int number) {
+		return number < 0 ? null : Integer.toString(number);
+	}
+	
+	private String formatTime(Date time) {
+		return time == null ? null : formatter.formatTimeShort(time);
+	}
+	
+	private String formatDate(Date date) {
+		return date == null ? null : formatter.formatDate(date);
+	}
+	
+	private static class LectureBlockWithTeachersComparator implements Comparator<LectureBlockWithTeachers> {
+
+		@Override
+		public int compare(LectureBlockWithTeachers o1, LectureBlockWithTeachers o2) {
+			Date s1 = o1.getLectureBlock().getStartDate();
+			Date s2 = o2.getLectureBlock().getStartDate();
+			if(s1 == null && s2 == null) return 0;
+			if(s1 == null) return 1;
+			if(s2 == null) return -1;
+			return s1.compareTo(s2);
+		}
+	}
+}