/**
* OLAT - Online Learning and Training<br>
* http://www.olat.org
* <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
* <p>
* http://www.apache.org/licenses/LICENSE-2.0
* <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>
* Copyright (c) since 2004 at Multimedia- & E-Learning Services (MELS),<br>
* University of Zurich, Switzerland.
* <hr>
* <a href="http://www.openolat.org">
* OpenOLAT - Online Learning and Training</a><br>
* This file has been modified by the OpenOLAT community. Changes are licensed
* under the Apache 2.0 license as the original file.
*/
package org.olat.course.nodes;
import java.io.File;
import java.util.ArrayList;
import java.util.List;
import java.util.Locale;
import org.olat.core.commons.modules.bc.FolderConfig;
import org.olat.core.commons.modules.bc.vfs.OlatNamedContainerImpl;
import org.olat.core.commons.modules.bc.vfs.OlatRootFolderImpl;
import org.olat.core.commons.services.notifications.NotificationsManager;
import org.olat.core.commons.services.notifications.SubscriptionContext;
import org.olat.core.gui.UserRequest;
import org.olat.core.gui.components.stack.BreadcrumbPanel;
import org.olat.core.gui.control.Controller;
import org.olat.core.gui.control.WindowControl;
import org.olat.core.gui.control.generic.tabbable.TabbableController;
import org.olat.core.gui.translator.PackageTranslator;
import org.olat.core.id.Identity;
import org.olat.core.id.IdentityEnvironment;
import org.olat.core.util.FileUtils;
import org.olat.core.util.StringHelper;
import org.olat.core.util.Util;
import org.olat.core.util.vfs.VFSContainer;
import org.olat.core.util.vfs.VFSItem;
import org.olat.core.util.vfs.callbacks.VFSSecurityCallback;
import org.olat.core.util.vfs.filters.SystemItemFilter;
import org.olat.course.CourseModule;
import org.olat.course.ICourse;
import org.olat.course.condition.Condition;
import org.olat.course.condition.interpreter.ConditionExpression;
import org.olat.course.condition.interpreter.ConditionInterpreter;
import org.olat.course.editor.CourseEditorEnv;
import org.olat.course.editor.NodeEditController;
import org.olat.course.editor.StatusDescription;
import org.olat.course.export.CourseEnvironmentMapper;
import org.olat.course.nodes.bc.BCCourseNodeEditController;
import org.olat.course.nodes.bc.BCCourseNodeRunController;
import org.olat.course.nodes.bc.BCPeekviewController;
import org.olat.course.nodes.bc.BCPreviewController;
import org.olat.course.nodes.bc.FolderNodeCallback;
import org.olat.course.run.environment.CourseEnvironment;
import org.olat.course.run.navigation.NodeRunConstructionResult;
import org.olat.course.run.userview.NodeEvaluation;
import org.olat.course.run.userview.TreeEvaluation;
import org.olat.course.run.userview.UserCourseEnvironment;
import org.olat.course.run.userview.UserCourseEnvironmentImpl;
import org.olat.course.run.userview.VisibleTreeFilter;
import org.olat.modules.ModuleConfiguration;
import org.olat.repository.RepositoryEntry;
/**
* Description:<br>
* @author Felix Jost
*/
public class BCCourseNode extends AbstractAccessableCourseNode {
private static final long serialVersionUID = 6887400715976544402L;
private static final String PACKAGE_BC = Util.getPackageName(BCCourseNodeRunController.class);
private static final String TYPE = "bc";
/**
* Condition.getCondition() == null means no precondition, always accessible
*/
private Condition preConditionUploaders, preConditionDownloaders;
/**
* Constructor for a course building block of type briefcase (folder)
*/
public BCCourseNode() {
super(TYPE);
updateModuleConfigDefaults(true);
preConditionUploaders = getPreConditionUploaders();
preConditionUploaders.setEasyModeCoachesAndAdmins(true);
preConditionUploaders.setConditionExpression(preConditionUploaders.getConditionFromEasyModeConfiguration());
preConditionUploaders.setExpertMode(false);
}
/**
* @see org.olat.course.nodes.CourseNode#createEditController(org.olat.core.gui.UserRequest,
* org.olat.core.gui.control.WindowControl, org.olat.course.ICourse)
*/
@Override
public TabbableController createEditController(UserRequest ureq, WindowControl wControl, BreadcrumbPanel stackPanel, ICourse course, UserCourseEnvironment euce) {
updateModuleConfigDefaults(false);
BCCourseNodeEditController childTabCntrllr = new BCCourseNodeEditController(this, course, ureq, wControl, euce);
CourseNode chosenNode = course.getEditorTreeModel().getCourseNode(euce.getCourseEditorEnv().getCurrentCourseNodeId());
return new NodeEditController(ureq, wControl, course.getEditorTreeModel(), course, chosenNode, euce, childTabCntrllr);
}
/**
* @see org.olat.course.nodes.CourseNode#createNodeRunConstructionResult(org.olat.core.gui.UserRequest,
* org.olat.core.gui.control.WindowControl,
* org.olat.course.run.userview.UserCourseEnvironment,
* org.olat.course.run.userview.NodeEvaluation)
*/
@Override
public NodeRunConstructionResult createNodeRunConstructionResult(UserRequest ureq, WindowControl wControl,
UserCourseEnvironment userCourseEnv, NodeEvaluation ne, String nodecmd) {
updateModuleConfigDefaults(false);
BCCourseNodeRunController bcCtrl = new BCCourseNodeRunController(ureq, wControl, userCourseEnv, this, ne);
if (StringHelper.containsNonWhitespace(nodecmd)) {
bcCtrl.activatePath(ureq, nodecmd);
}
Controller titledCtrl = TitledWrapperHelper.getWrapper(ureq, wControl, bcCtrl, this, "o_bc_icon");
return new NodeRunConstructionResult(titledCtrl);
}
/**
* @see org.olat.course.nodes.GenericCourseNode#createPeekViewRunController(org.olat.core.gui.UserRequest,
* org.olat.core.gui.control.WindowControl,
* org.olat.course.run.userview.UserCourseEnvironment,
* org.olat.course.run.userview.NodeEvaluation)
*/
@Override
public Controller createPeekViewRunController(UserRequest ureq, WindowControl wControl, UserCourseEnvironment userCourseEnv,
NodeEvaluation ne) {
if (ne.isAtLeastOneAccessible()) {
updateModuleConfigDefaults(false);
// Create a folder peekview controller that shows the latest two entries
VFSContainer rootFolder = null;
if(getModuleConfiguration().getBooleanSafe(BCCourseNodeEditController.CONFIG_AUTO_FOLDER)) {
rootFolder = getNodeFolderContainer(this, userCourseEnv.getCourseEnvironment());
} else {
String subPath = getModuleConfiguration().getStringValue(BCCourseNodeEditController.CONFIG_SUBPATH, "");
VFSItem item = userCourseEnv.getCourseEnvironment().getCourseFolderContainer().resolve(subPath);
if(item instanceof VFSContainer) {
rootFolder = (VFSContainer)item;
}
}
if(rootFolder == null) {
return super.createPeekViewRunController(ureq, wControl, userCourseEnv, ne);
}
rootFolder.setDefaultItemFilter(new SystemItemFilter());
return new BCPeekviewController(ureq, wControl, rootFolder, getIdent(), 4);
} else {
// use standard peekview
return super.createPeekViewRunController(ureq, wControl, userCourseEnv, ne);
}
}
/**
* @see org.olat.course.nodes.GenericCourseNode#createPreviewController(org.olat.core.gui.UserRequest,
* org.olat.core.gui.control.WindowControl,
* org.olat.course.run.userview.UserCourseEnvironment,
* org.olat.course.run.userview.NodeEvaluation)
*/
@Override
public Controller createPreviewController(UserRequest ureq, WindowControl wControl, UserCourseEnvironment userCourseEnv, NodeEvaluation ne) {
return new BCPreviewController(ureq, wControl, this, userCourseEnv.getCourseEnvironment(), ne);
}
/**
* @param courseEnv
* @param node
* @return the relative folder base path for this folder node
*/
public static String getFoldernodePathRelToFolderBase(CourseEnvironment courseEnv, CourseNode node) {
return getFoldernodesPathRelToFolderBase(courseEnv) + "/" + node.getIdent();
}
/**
* @param courseEnv
* @return the relative folder base path for folder nodes
*/
public static String getFoldernodesPathRelToFolderBase(CourseEnvironment courseEnv) {
return courseEnv.getCourseBaseContainer().getRelPath() + "/foldernodes";
}
public boolean isSharedFolder(){
return getModuleConfiguration().getStringValue(BCCourseNodeEditController.CONFIG_SUBPATH, "")
.startsWith("/_sharedfolder");
}
/**
* Get a named container of a node with the node title as its name.
* @param node
* @param courseEnv
* @return
*/
public static OlatNamedContainerImpl getNodeFolderContainer(BCCourseNode node, CourseEnvironment courseEnv) {
String path = getFoldernodePathRelToFolderBase(courseEnv, node);
OlatRootFolderImpl rootFolder = new OlatRootFolderImpl(path, null);
OlatNamedContainerImpl namedFolder = new OlatNamedContainerImpl(node.getShortTitle(), rootFolder);
return namedFolder;
}
public static OlatNamedContainerImpl getSecurisedNodeFolderContainer(BCCourseNode node, CourseEnvironment courseEnv, IdentityEnvironment ienv) {
boolean isOlatAdmin = ienv.getRoles().isOLATAdmin();
boolean isGuestOnly = ienv.getRoles().isGuestOnly();
UserCourseEnvironmentImpl uce = new UserCourseEnvironmentImpl(ienv, courseEnv);
NodeEvaluation ne = node.eval(uce.getConditionInterpreter(), new TreeEvaluation(), new VisibleTreeFilter());
OlatNamedContainerImpl container = getNodeFolderContainer(node, courseEnv);
VFSSecurityCallback secCallback = new FolderNodeCallback(container.getRelPath(), ne, isOlatAdmin, isGuestOnly, null);
container.setLocalSecurityCallback(secCallback);
return container;
}
@Override
public void exportNode(File exportDirectory, ICourse course) {
// this is the node folder, a folder with the node's ID, so we can just copy
// the contents over to the export folder
File fFolderNodeData = new File(FolderConfig.getCanonicalRoot() + getFoldernodePathRelToFolderBase(course.getCourseEnvironment(), this));
File fNodeExportDir = new File(exportDirectory, this.getIdent());
fNodeExportDir.mkdirs();
FileUtils.copyDirContentsToDir(fFolderNodeData, fNodeExportDir, false, "export course node");
}
@Override
public void importNode(File importDirectory, ICourse course, Identity owner, Locale locale, boolean withReferences) {
// the export has copies the files under the node's ID
File fFolderNodeData = new File(importDirectory, this.getIdent());
// the whole folder can be moved back to the root direcotry of foldernodes
// of this course
File fFolderNodeDir = new File(FolderConfig.getCanonicalRoot() + getFoldernodePathRelToFolderBase(course.getCourseEnvironment(), this));
fFolderNodeDir.mkdirs();
FileUtils.copyDirContentsToDir(fFolderNodeData, fFolderNodeDir, true, "import course node");
}
/**
* @see org.olat.course.nodes.GenericCourseNode#calcAccessAndVisibility(org.olat.course.condition.interpreter.ConditionInterpreter,
* org.olat.course.run.userview.NodeEvaluation)
*/
@Override
protected void calcAccessAndVisibility(ConditionInterpreter ci, NodeEvaluation nodeEval) {
boolean uploadability = (getPreConditionUploaders().getConditionExpression() == null ? true : ci
.evaluateCondition(getPreConditionUploaders()));
nodeEval.putAccessStatus("upload", uploadability);
boolean downloadability = (getPreConditionDownloaders().getConditionExpression() == null ? true : ci
.evaluateCondition(getPreConditionDownloaders()));
nodeEval.putAccessStatus("download", downloadability);
boolean visible = (getPreConditionVisibility().getConditionExpression() == null ? true : ci
.evaluateCondition(getPreConditionVisibility()));
nodeEval.setVisible(visible);
}
/**
* @return Returns the preConditionDownloaders.
*/
public Condition getPreConditionDownloaders() {
if (preConditionDownloaders == null) {
preConditionDownloaders = new Condition();
}
preConditionDownloaders.setConditionId("downloaders");
return preConditionDownloaders;
}
/**
* @param preConditionDownloaders The preConditionDownloaders to set.
*/
public void setPreConditionDownloaders(Condition preConditionDownloaders) {
if (preConditionDownloaders == null) {
preConditionDownloaders = getPreConditionDownloaders();
}
this.preConditionDownloaders = preConditionDownloaders;
preConditionDownloaders.setConditionId("downloaders");
}
/**
* @return Returns the preConditionUploaders.
*/
public Condition getPreConditionUploaders() {
if (preConditionUploaders == null) {
preConditionUploaders = new Condition();
}
preConditionUploaders.setConditionId("uploaders");
return preConditionUploaders;
}
/**
* @param preConditionUploaders The preConditionUploaders to set.
*/
public void setPreConditionUploaders(Condition preConditionUploaders) {
if (preConditionUploaders == null) {
preConditionUploaders = getPreConditionUploaders();
}
preConditionUploaders.setConditionId("uploaders");
this.preConditionUploaders = preConditionUploaders;
}
/**
* @see org.olat.course.nodes.CourseNode#isConfigValid()
*/
@Override
public StatusDescription isConfigValid() {
updateModuleConfigDefaults(false);
StatusDescription sd = StatusDescription.NOERROR;
if(!getModuleConfiguration().getBooleanSafe(BCCourseNodeEditController.CONFIG_AUTO_FOLDER)){
String subpath = getModuleConfiguration().getStringValue(BCCourseNodeEditController.CONFIG_SUBPATH,"");
if(!StringHelper.containsNonWhitespace(subpath)){
String shortKey = "error.missingfolder.short";
String longKey = "error.missingfolder.long";
String[] params = new String[] { this.getShortTitle() };
String translPackage = Util.getPackageName(BCCourseNodeEditController.class);
sd = new StatusDescription(StatusDescription.ERROR, shortKey, longKey, params, translPackage);
sd.setDescriptionForUnit(getIdent());
// set which pane is affected by error
sd.setActivateableViewIdentifier(BCCourseNodeEditController.PANE_TAB_FOLDER);
}
}
if(oneClickStatusCache!=null) {
return oneClickStatusCache[0];
}
return sd;
}
/**
* @see org.olat.course.nodes.CourseNode#isConfigValid(org.olat.course.run.userview.UserCourseEnvironment)
*/
@Override
public StatusDescription[] isConfigValid(CourseEditorEnv cev) {
//only here we know which translator to take for translating condition error messages
oneClickStatusCache = null;
String translatorStr = Util.getPackageName(BCCourseNodeEditController.class);
List<StatusDescription> statusDescs =isConfigValidWithTranslator(cev, translatorStr,getConditionExpressions());
oneClickStatusCache = StatusDescriptionHelper.sort(statusDescs);
return oneClickStatusCache;
}
/**
* @see org.olat.course.nodes.CourseNode#getReferencedRepositoryEntry()
*/
@Override
public RepositoryEntry getReferencedRepositoryEntry() {
return null;
}
/**
* @see org.olat.course.nodes.CourseNode#needsReferenceToARepositoryEntry()
*/
@Override
public boolean needsReferenceToARepositoryEntry() {
return false;
}
/**
* @see org.olat.course.nodes.CourseNode#informOnDelete(org.olat.core.gui.UserRequest,
* org.olat.course.ICourse)
*/
@Override
public String informOnDelete(Locale locale, ICourse course) {
return new PackageTranslator(PACKAGE_BC, locale).translate("warn.folderdelete");
}
/**
* Delete the folder if node is deleted.
*
* @see org.olat.course.nodes.CourseNode#cleanupOnDelete(org.olat.course.ICourse)
*/
@Override
public void cleanupOnDelete(ICourse course) {
// mark the subscription to this node as deleted
SubscriptionContext folderSubContext = CourseModule.createTechnicalSubscriptionContext(course.getCourseEnvironment(), this);
NotificationsManager.getInstance().delete(folderSubContext);
// delete filesystem
File fFolderRoot = new File(FolderConfig.getCanonicalRoot() + getFoldernodePathRelToFolderBase(course.getCourseEnvironment(), this));
if (fFolderRoot.exists()) FileUtils.deleteDirsAndFiles(fFolderRoot, true, true);
}
@Override
protected void postImportCopyConditions(CourseEnvironmentMapper envMapper) {
super.postImportCopyConditions(envMapper);
postImportCondition(preConditionUploaders, envMapper);
postImportCondition(preConditionDownloaders, envMapper);
}
@Override
public void postExport(CourseEnvironmentMapper envMapper, boolean backwardsCompatible) {
super.postExport(envMapper, backwardsCompatible);
postExportCondition(preConditionUploaders, envMapper, backwardsCompatible);
postExportCondition(preConditionDownloaders, envMapper, backwardsCompatible);
}
/**
* @see org.olat.course.nodes.GenericCourseNode#getConditionExpressions()
*/
public List<ConditionExpression> getConditionExpressions() {
List<ConditionExpression> retVal;
List<ConditionExpression> parentsConditions = super.getConditionExpressions();
if (parentsConditions.size() > 0) {
retVal = new ArrayList<ConditionExpression>(parentsConditions);
}else {
retVal = new ArrayList<ConditionExpression>();
}
//
String coS = getPreConditionDownloaders().getConditionExpression();
if (coS != null && !coS.equals("")) {
// an active condition is defined
ConditionExpression ce = new ConditionExpression(getPreConditionDownloaders().getConditionId());
ce.setExpressionString(getPreConditionDownloaders().getConditionExpression());
retVal.add(ce);
}
//
coS = getPreConditionUploaders().getConditionExpression();
if (coS != null && !coS.equals("")) {
// an active condition is defined
ConditionExpression ce = new ConditionExpression(getPreConditionUploaders().getConditionId());
ce.setExpressionString(getPreConditionUploaders().getConditionExpression());
retVal.add(ce);
}
//
return retVal;
}
@Override
public void updateModuleConfigDefaults(boolean isNewNode) {
ModuleConfiguration config = getModuleConfiguration();
if(isNewNode){
//set autofolder as default and set newest config version
config.setBooleanEntry(BCCourseNodeEditController.CONFIG_AUTO_FOLDER, true);
config.setStringValue(BCCourseNodeEditController.CONFIG_SUBPATH, "");
config.setConfigurationVersion(2);
}else{
int version = config.getConfigurationVersion();
if(version < 2) {
config.setBooleanEntry(BCCourseNodeEditController.CONFIG_AUTO_FOLDER, true);
config.setStringValue(BCCourseNodeEditController.CONFIG_SUBPATH, "");
config.setConfigurationVersion(2);
}
}
super.updateModuleConfigDefaults(isNewNode);
}
}