OO-289: catch the error reading the CP and show an error message and not a red screen

src/main/java/org/olat/modules/cp/CPDisplayController.java

@@ -25,6 +25,7 @@
 
 package org.olat.modules.cp;
 
+import java.io.IOException;
 import java.util.List;
 
 import org.olat.core.CoreSpringFactory;
@@ -139,10 +140,17 @@ public class CPDisplayController extends BasicController implements Activateable
 		// even if we do not show the menu, we need to build parse the manifest and
 		// find the first node to display at startup
 		VFSItem mani = rootContainer.resolve("imsmanifest.xml");
-		if (mani == null || !(mani instanceof VFSLeaf)) { throw new OLATRuntimeException("error.manifest.missing", null, this.getClass()
-				.getPackage().getName(), "CP " + rootContainer + " has no imsmanifest", null); }
+		if (mani == null || !(mani instanceof VFSLeaf)) {
+			showError("error.manifest.missing");
+			return;
+		}
 		// initialize tree model in any case
-		ctm = new CPManifestTreeModel((VFSLeaf) mani);
+		try {
+			ctm = new CPManifestTreeModel((VFSLeaf) mani);
+		} catch (IOException e) {
+			showError("error.manifest.corrupted");
+			return;
+		}
 
 		if (showMenu) {
 			// the menu is only initialized when needed.

src/main/java/org/olat/modules/cp/CPManifestTreeModel.java

@@ -35,6 +35,7 @@ import java.util.Iterator;
 import java.util.List;
 import java.util.Map;
 
+import org.apache.commons.io.IOUtils;
 import org.dom4j.Document;
 import org.dom4j.Element;
 import org.dom4j.XPath;
@@ -42,7 +43,6 @@ import org.olat.core.gui.components.tree.GenericTreeModel;
 import org.olat.core.gui.components.tree.GenericTreeNode;
 import org.olat.core.gui.components.tree.TreeNode;
 import org.olat.core.logging.AssertException;
-import org.olat.core.logging.OLATRuntimeException;
 import org.olat.core.util.vfs.VFSLeaf;
 import org.olat.core.util.xml.XMLParser;
 import org.olat.ims.resources.IMSEntityResolver;
@@ -63,7 +63,7 @@ public class CPManifestTreeModel extends GenericTreeModel {
 	 * Constructor of the content packaging tree model
 	 * @param manifest the imsmanifest.xml file
 	 */
-	CPManifestTreeModel(VFSLeaf manifest) {
+	CPManifestTreeModel(VFSLeaf manifest) throws IOException {
 		Document doc = loadDocument(manifest);
 		// get all organization elements. need to set namespace
 		rootElement = doc.getRootElement();
@@ -182,7 +182,7 @@ public class CPManifestTreeModel extends GenericTreeModel {
 		return gtn;
 	}
 	
-	private Document loadDocument(VFSLeaf documentF) {
+	private Document loadDocument(VFSLeaf documentF) throws IOException {
 		InputStream in = null;
 		Document doc = null;
 		try {
@@ -190,20 +190,14 @@ public class CPManifestTreeModel extends GenericTreeModel {
 			XMLParser xmlParser = new XMLParser(new IMSEntityResolver());
 			doc = xmlParser.parse(in, false);
 			in.close();
-		}
-		catch (IOException e) {
-			throw new OLATRuntimeException(CPManifestTreeModel.class, "could not read and parse from file " + documentF, e);
+		} catch (IOException e) {
+			throw e;
+		} catch(Exception e) {
+			throw new IOException("could not read and parse from file " + documentF, e);
 		}
 		finally {
-			try {
-				if (in != null)
-					in.close();
-			}
-			catch (Exception e) {
-				// we did our best to close the inputStream
-			}
+			IOUtils.closeQuietly(in);
 		}
 		return doc;
 	}
-
 }

src/main/java/org/olat/modules/cp/CPOfflineReadableManager.java

@@ -65,7 +65,7 @@ import org.olat.fileresource.FileResourceManager;
 public class CPOfflineReadableManager {
 	private static CPOfflineReadableManager instance = new CPOfflineReadableManager();
 
-	OLog logger = Tracing.createLoggerFor(CPOfflineReadableManager.class);
+	private static final OLog log = Tracing.createLoggerFor(CPOfflineReadableManager.class);
 	
 	private static final String DIRNAME_CPOFFLINEMENUMAT = "cp_offline_menu_mat";
 	private static final String FILENAME_START = "_START_.html";
@@ -115,9 +115,13 @@ public class CPOfflineReadableManager {
 	 *            the resulting zip-filename
 	 */
 	public void makeCPOfflineReadable(File unzippedDir, File targetZip) {
-		writeOfflineCPStartHTMLFile(unzippedDir);
-		File cpOfflineMat = new File(WebappHelper.getContextRoot() + "/static/" + DIRNAME_CPOFFLINEMENUMAT);
-		zipOfflineReadableCP(unzippedDir, targetZip, cpOfflineMat);
+		try {
+			writeOfflineCPStartHTMLFile(unzippedDir);
+			File cpOfflineMat = new File(WebappHelper.getContextRoot() + "/static/" + DIRNAME_CPOFFLINEMENUMAT);
+			zipOfflineReadableCP(unzippedDir, targetZip, cpOfflineMat);
+		} catch (IOException e) {
+			log.error("", e);
+		}
 	}
 
 	/**
@@ -132,17 +136,21 @@ public class CPOfflineReadableManager {
 	 *            the resulting zip-filename
 	 */
 	public void makeCPOfflineReadable(OLATResourceable ores, String zipName) {
-		String repositoryHome = FolderConfig.getCanonicalRepositoryHome();
-		FileResourceManager fm = FileResourceManager.getInstance();
-		String relPath = fm.getUnzippedDirRel(ores);
-		String resId = ores.getResourceableId().toString();
+		try {
+			String repositoryHome = FolderConfig.getCanonicalRepositoryHome();
+			FileResourceManager fm = FileResourceManager.getInstance();
+			String relPath = fm.getUnzippedDirRel(ores);
+			String resId = ores.getResourceableId().toString();
 
-		File unzippedDir = new File(repositoryHome + "/" + relPath);
-		File targetZip = new File(repositoryHome + "/" + resId + "/" + zipName);
-		File cpOfflineMat = new File(WebappHelper.getContextRoot() + "/static/" + DIRNAME_CPOFFLINEMENUMAT);
+			File unzippedDir = new File(repositoryHome + "/" + relPath);
+			File targetZip = new File(repositoryHome + "/" + resId + "/" + zipName);
+			File cpOfflineMat = new File(WebappHelper.getContextRoot() + "/static/" + DIRNAME_CPOFFLINEMENUMAT);
 
-		writeOfflineCPStartHTMLFile(unzippedDir);
-		zipOfflineReadableCP(unzippedDir, targetZip, cpOfflineMat);
+			writeOfflineCPStartHTMLFile(unzippedDir);
+			zipOfflineReadableCP(unzippedDir, targetZip, cpOfflineMat);
+		} catch (IOException e) {
+			log.error("", e);
+		}
 	}
 
 	/**
@@ -154,7 +162,7 @@ public class CPOfflineReadableManager {
 	 * @param unzippedDir
 	 *            the directory that contains the unzipped CP
 	 */
-	private void writeOfflineCPStartHTMLFile(File unzippedDir) {
+	private void writeOfflineCPStartHTMLFile(File unzippedDir) throws IOException {
 
 		/* first, we do the menu-tree */
 		File mani = new File(unzippedDir, FILENAME_IMSMANIFEST);
@@ -178,9 +186,9 @@ public class CPOfflineReadableManager {
 			String template = FileUtils.load(CPOfflineReadableManager.class.getResourceAsStream("_content/cpofflinereadable.html"), "utf-8");
 			boolean evalResult = velocityEngine.evaluate(ctx, sw, "cpexport", template);
 			if (!evalResult)
-				logger.error("Could not evaluate velocity template for CP Export");
+				log.error("Could not evaluate velocity template for CP Export");
 		} catch (IOException e) {
-			logger.error("Error while evaluating velovity template for CP Export",e);
+			log.error("Error while evaluating velovity template for CP Export",e);
 		}
 		
 		File f = new File(unzippedDir, FILENAME_START);
@@ -270,7 +278,7 @@ public class CPOfflineReadableManager {
 		boolean zipResult = ZipUtil.zip(allFilesInUnzippedDir, unzippedDir, targetZip, true);
 
 		if(!targetZip.exists()){
-			logger.warn("targetZip does not exists after zipping. zip-result is: "+ zipResult);
+			log.warn("targetZip does not exists after zipping. zip-result is: "+ zipResult);
 		}
 	}
 

src/main/java/org/olat/modules/cp/_i18n/LocalStrings_de.properties

@@ -4,4 +4,5 @@ print.node=Drucken
 print.node.list=Seite
 print.node.list.title=Druckkonfiguration
 print.node.list.desc=W\u00E4hlen Sie eine oder mehrere Seiten f\u00FCr den Ausdruck aus
-error.manifest.missing=Dieser CP-Lerninhalt ist ung\u00FCltig\: Fehlendes imsmanifest.xml. Mehr Informationen dazu finden Sie unter http\://www.imsglobal.org.
+error.manifest.missing=Dieser CP-Lerninhalt ist ung\u00FCltig\: Fehlendes imsmanifest.xml. Mehr Informationen dazu finden Sie unter http\://www.imsglobal.org.
\ No newline at end of file
+error.manifest.corrupted=Dieser CP-Lerninhalt ist ung\u00FCltig\: imsmanifest.xml ist  ung\u00FCltig. Mehr Informationen dazu finden Sie unter http\://www.imsglobal.org.
\ No newline at end of file

src/main/java/org/olat/modules/cp/_i18n/LocalStrings_en.properties

 #Mon May 16 17:33:59 CEST 2011
 error.manifest.missing=This CP learning content is invalid\: missing imsmanifest.xml. For more information see http\://www.imsglobal.org.
+error.manifest.corrupted=This CP learning content is invalid\: imsmanifest.xml is probably invalid. For more information see http\://www.imsglobal.org.
 previous=Back
 print.node=Print
 print.node.list=Page