/**
* 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) frentix GmbH<br>
* http://www.frentix.com<br>
* <p>
*/
package org.olat.repository.handlers;
import java.util.ArrayList;
import java.util.List;
import org.olat.core.commons.fullWebApp.LayoutMain3ColsController;
import org.olat.core.gui.UserRequest;
import org.olat.core.gui.components.Component;
import org.olat.core.gui.control.Controller;
import org.olat.core.gui.control.WindowControl;
import org.olat.core.gui.control.generic.layout.MainLayoutController;
import org.olat.core.gui.media.MediaResource;
import org.olat.core.gui.translator.Translator;
import org.olat.core.id.Identity;
import org.olat.core.id.OLATResourceable;
import org.olat.core.logging.AssertException;
import org.olat.core.util.Util;
import org.olat.core.util.coordinate.CoordinatorManager;
import org.olat.core.util.coordinate.LockResult;
import org.olat.core.util.resource.OLATResourceableJustBeforeDeletedEvent;
import org.olat.fileresource.FileResourceManager;
import org.olat.fileresource.types.PodcastFileResource;
import org.olat.modules.webFeed.FeedResourceSecurityCallback;
import org.olat.modules.webFeed.FeedSecurityCallback;
import org.olat.modules.webFeed.managers.FeedManager;
import org.olat.modules.webFeed.ui.podcast.PodcastUIFactory;
import org.olat.repository.RepositoryEntry;
import org.olat.repository.RepositoryManager;
import org.olat.repository.controllers.AddFileResourceController;
import org.olat.repository.controllers.IAddController;
import org.olat.repository.controllers.RepositoryAddCallback;
import org.olat.repository.controllers.WizardCloseResourceController;
import org.olat.resource.references.ReferenceManager;
/**
* Responsible class for handling any actions involving podcast resources.
*
* <P>
* Initial Date: Feb 25, 2009 <br>
*
* @author Gregor Wassmann
*/
// Loads of parameters are unused
@SuppressWarnings("unused")
public class PodcastHandler implements RepositoryHandler {
public static final String PROCESS_CREATENEW = "create_new";
public static final String PROCESS_UPLOAD = "upload";
private static final boolean DOWNLOADABLE = true;
private static final boolean EDITABLE = true;
private static final boolean LAUNCHABLE = true;
private static final List<String> supportedTypes;
static { // initialize supported types
supportedTypes = new ArrayList<String>(1);
supportedTypes.add(PodcastFileResource.TYPE_NAME);
}
/**
* @see org.olat.repository.handlers.RepositoryHandler#acquireLock(org.olat.core.id.OLATResourceable,
* org.olat.core.id.Identity)
*/
public LockResult acquireLock(OLATResourceable ores, Identity identity) {
return FeedManager.getInstance().acquireLock(ores, identity);
}
/**
* @see org.olat.repository.handlers.RepositoryHandler#archive(java.lang.String,
* org.olat.repository.RepositoryEntry)
*/
public String archive(Identity archiveOnBehalfOf, String archivFilePath, RepositoryEntry repoEntry) {
// Apperantly, this method is used for backing up any user related content
// (comments etc.) on deletion. Up to now, this doesn't exist in podcasts.
return null;
}
/**
* @see org.olat.repository.handlers.RepositoryHandler#cleanupOnDelete(org.olat.core.id.OLATResourceable,
* org.olat.core.gui.UserRequest,
* org.olat.core.gui.control.WindowControl)
*/
public boolean cleanupOnDelete(OLATResourceable res, UserRequest ureq, WindowControl control) {
CoordinatorManager.getCoordinator().getEventBus().fireEventToListenersOf(new OLATResourceableJustBeforeDeletedEvent(res), res);
// For now, notifications are not implemented since a podcast feed is meant
// to be subscriped to anyway.
// NotificationsManager.getInstance().deletePublishersOf(res);
FeedManager.getInstance().delete(res);
return true;
}
/**
* @see org.olat.repository.handlers.RepositoryHandler#createCopy(org.olat.core.id.OLATResourceable,
* org.olat.core.gui.UserRequest)
*/
public OLATResourceable createCopy(OLATResourceable res, UserRequest ureq) {
FeedManager manager = FeedManager.getInstance();
return manager.copy(res);
}
/**
* @see org.olat.repository.handlers.RepositoryHandler#getAddController(org.olat.repository.controllers.RepositoryAddCallback,
* java.lang.Object, org.olat.core.gui.UserRequest,
* org.olat.core.gui.control.WindowControl)
*/
public IAddController getAddController(RepositoryAddCallback callback, Object userObject, UserRequest ureq, WindowControl wControl) {
IAddController addCtr = null;
if (userObject == null || userObject.equals(PROCESS_UPLOAD)) {
addCtr = new AddFileResourceController(callback, supportedTypes, new String[] { "zip" }, ureq, wControl);
} else {
addCtr = PodcastUIFactory.getInstance(ureq.getLocale()).createAddController(callback, ureq, wControl);
}
return addCtr;
}
/**
* @see org.olat.repository.handlers.RepositoryHandler#getAsMediaResource(org.olat.core.id.OLATResourceable)
*/
public MediaResource getAsMediaResource(OLATResourceable res) {
FeedManager manager = FeedManager.getInstance();
return manager.getFeedArchiveMediaResource(res);
}
/**
* @see org.olat.repository.handlers.RepositoryHandler#getDetailsComponent(org.olat.core.id.OLATResourceable,
* org.olat.core.gui.UserRequest)
*/
public Component getDetailsComponent(OLATResourceable res, UserRequest ureq) {
return FileResourceManager.getInstance().getDetailsComponent(res, ureq.getLocale());
}
/**
* @see org.olat.repository.handlers.RepositoryHandler#getEditorController(org.olat.core.id.OLATResourceable,
* org.olat.core.gui.UserRequest,
* org.olat.core.gui.control.WindowControl)
*/
public Controller getEditorController(OLATResourceable res, UserRequest ureq, WindowControl control) {
// Return the launch controller. Owners and admins will be able to edit the
// podcast 'inline'.
return getLaunchController(res, null, ureq, control);
}
/**
* @see org.olat.repository.handlers.RepositoryHandler#getLaunchController(org.olat.core.id.OLATResourceable,
* java.lang.String, org.olat.core.gui.UserRequest,
* org.olat.core.gui.control.WindowControl)
*/
public MainLayoutController getLaunchController(OLATResourceable res, String initialViewIdentifier, UserRequest ureq,
WindowControl wControl) {
RepositoryEntry repoEntry = RepositoryManager.getInstance().lookupRepositoryEntry(res, false);
boolean isAdmin = ureq.getUserSession().getRoles().isOLATAdmin();
boolean isOwner = RepositoryManager.getInstance().isOwnerOfRepositoryEntry(ureq.getIdentity(), repoEntry);
FeedSecurityCallback callback = new FeedResourceSecurityCallback(isAdmin, isOwner);
Controller podcastCtr = PodcastUIFactory.getInstance(ureq.getLocale()).createMainController(res, ureq, wControl, callback);
LayoutMain3ColsController layoutCtr = new LayoutMain3ColsController(ureq, wControl, null, null, podcastCtr.getInitialComponent(), null);
layoutCtr.addDisposableChildController(podcastCtr);
return layoutCtr;
}
/**
* @see org.olat.repository.handlers.RepositoryHandler#getSupportedTypes()
*/
public List<String> getSupportedTypes() {
return supportedTypes;
}
/**
* @see org.olat.repository.handlers.RepositoryHandler#readyToDelete(org.olat.core.id.OLATResourceable,
* org.olat.core.gui.UserRequest,
* org.olat.core.gui.control.WindowControl)
*/
public boolean readyToDelete(OLATResourceable res, UserRequest ureq, WindowControl wControl) {
ReferenceManager refM = ReferenceManager.getInstance();
String referencesSummary = refM.getReferencesToSummary(res, ureq.getLocale());
if (referencesSummary != null) {
Translator translator = Util.createPackageTranslator(RepositoryManager.class, ureq.getLocale());
wControl.setError(translator.translate("details.delete.error.references", new String[] { referencesSummary }));
return false;
}
return true;
}
/**
* @see org.olat.repository.handlers.RepositoryHandler#releaseLock(org.olat.core.util.coordinate.LockResult)
*/
public void releaseLock(LockResult lockResult) {
FeedManager.getInstance().releaseLock(lockResult);
}
/**
* @see org.olat.repository.handlers.RepositoryHandler#supportsDownload()
*/
public boolean supportsDownload() {
return DOWNLOADABLE;
}
/**
* @see org.olat.repository.handlers.RepositoryHandler#supportsEdit()
*/
public boolean supportsEdit() {
return EDITABLE;
}
/**
* @see org.olat.repository.handlers.RepositoryHandler#supportsLaunch()
*/
public boolean supportsLaunch() {
return LAUNCHABLE;
}
/**
* @see org.olat.repository.handlers.RepositoryHandler#getCloseResourceController(org.olat.core.gui.UserRequest,
* org.olat.core.gui.control.WindowControl,
* org.olat.repository.RepositoryEntry)
*/
public WizardCloseResourceController getCloseResourceController(UserRequest ureq, WindowControl control, RepositoryEntry repositoryEntry) {
// This was copied from WikiHandler. No specific close wizard is
// implemented.
throw new AssertException("not implemented");
}
/**
* @see org.olat.repository.handlers.RepositoryHandler#isLocked(org.olat.core.id.OLATResourceable)
*/
public boolean isLocked(OLATResourceable ores) {
return FeedManager.getInstance().isLocked(ores);
}
}