use of org.olat.resource.accesscontrol.AccessResult in project OpenOLAT by OpenOLAT.
the class RepositoryEntryDetailsController method initForm.
@Override
protected void initForm(FormItemContainer formLayout, Controller listener, UserRequest ureq) {
int cmpcount = 0;
if (formLayout instanceof FormLayoutContainer) {
FormLayoutContainer layoutCont = (FormLayoutContainer) formLayout;
layoutCont.contextPut("v", entry);
layoutCont.contextPut("guestOnly", new Boolean(guestOnly));
String cssClass = RepositoyUIFactory.getIconCssClass(entry);
layoutCont.contextPut("cssClass", cssClass);
boolean closed = entry.getRepositoryEntryStatus().isClosed() || entry.getRepositoryEntryStatus().isUnpublished();
layoutCont.contextPut("closed", new Boolean(closed));
RepositoryHandler handler = RepositoryHandlerFactory.getInstance().getRepositoryHandler(entry);
VFSContainer mediaContainer = handler.getMediaContainer(entry);
if (mediaContainer != null) {
baseUrl = registerMapper(ureq, new VFSContainerMapper(mediaContainer.getParentContainer()));
}
setText(entry.getDescription(), "description", layoutCont);
setText(entry.getRequirements(), "requirements", layoutCont);
setText(entry.getObjectives(), "objectives", layoutCont);
setText(entry.getCredits(), "credits", layoutCont);
// thumbnail and movie
VFSLeaf movie = repositoryService.getIntroductionMovie(entry);
VFSLeaf image = repositoryService.getIntroductionImage(entry);
if (image != null || movie != null) {
ImageComponent ic = new ImageComponent(ureq.getUserSession(), "thumbnail");
if (movie != null) {
ic.setMedia(movie);
ic.setMaxWithAndHeightToFitWithin(RepositoryManager.PICTURE_WIDTH, RepositoryManager.PICTURE_HEIGHT);
// add poster image
if (image != null) {
ic.setPoster(image);
}
} else {
ic.setMedia(image);
ic.setMaxWithAndHeightToFitWithin(RepositoryManager.PICTURE_WIDTH, RepositoryManager.PICTURE_HEIGHT);
}
layoutCont.put("thumbnail", ic);
}
// categories
if (repositoryModule.isCatalogEnabled()) {
List<CatalogEntry> categories = catalogManager.getCatalogEntriesReferencing(entry);
List<String> categoriesLink = new ArrayList<>(categories.size());
for (CatalogEntry category : categories) {
String id = "cat_" + ++cmpcount;
String title = StringHelper.escapeHtml(category.getParent().getName());
FormLink catLink = uifactory.addFormLink(id, "category", title, null, layoutCont, Link.LINK | Link.NONTRANSLATED);
catLink.setIconLeftCSS("o_icon o_icon-fw o_icon_catalog");
catLink.setUserObject(category.getKey());
categoriesLink.add(id);
}
layoutCont.contextPut("categories", categoriesLink);
}
if (!guestOnly) {
boolean marked;
if (row == null) {
marked = markManager.isMarked(entry, getIdentity(), null);
} else {
marked = row.isMarked();
}
markLink = uifactory.addFormLink("mark", "mark", marked ? "details.bookmark.remove" : "details.bookmark", null, layoutCont, Link.LINK);
markLink.setElementCssClass("o_bookmark");
markLink.setIconLeftCSS(marked ? Mark.MARK_CSS_LARGE : Mark.MARK_ADD_CSS_LARGE);
}
RepositoryEntryStatistics statistics = entry.getStatistics();
if (repositoryModule.isRatingEnabled()) {
Integer myRating;
if (row == null) {
myRating = userRatingsDao.getRatingValue(getIdentity(), entry, null);
} else {
myRating = row.getMyRating();
}
Double averageRating = statistics.getRating();
long numOfRatings = statistics.getNumOfRatings();
float ratingValue = myRating == null ? 0f : myRating.floatValue();
float averageRatingValue = averageRating == null ? 0f : averageRating.floatValue();
ratingEl = new RatingWithAverageFormItem("rating", ratingValue, averageRatingValue, 5, numOfRatings);
ratingEl.setEnabled(!guestOnly);
layoutCont.add("rating", ratingEl);
}
if (repositoryModule.isCommentEnabled()) {
long numOfComments = statistics.getNumOfComments();
String title = "(" + numOfComments + ")";
commentsLink = uifactory.addFormLink("comments", "comments", title, null, layoutCont, Link.NONTRANSLATED);
commentsLink.setCustomEnabledLinkCSS("o_comments");
String css = numOfComments > 0 ? "o_icon o_icon_comments o_icon-lg" : "o_icon o_icon_comments_none o_icon-lg";
commentsLink.setIconLeftCSS(css);
}
// load memberships
List<String> memberRoles = repositoryService.getRoles(getIdentity(), entry);
List<Long> authorKeys = repositoryService.getAuthors(entry);
boolean isAuthor = false;
boolean isMember = memberRoles.contains(GroupRoles.owner.name()) || memberRoles.contains(GroupRoles.coach.name()) || memberRoles.contains(GroupRoles.participant.name());
if (isMember) {
isAuthor = authorKeys.contains(getIdentity().getKey());
layoutCont.contextPut("isEntryAuthor", new Boolean(isAuthor));
}
// push roles to velocity as well
Roles roles = ureq.getUserSession().getRoles();
layoutCont.contextPut("roles", roles);
if (!guestOnly && memberRoles.contains(GroupRoles.participant.name()) && repositoryService.isParticipantAllowedToLeave(entry)) {
leaveLink = uifactory.addFormLink("sign.out", "leave", translate("sign.out"), null, formLayout, Link.BUTTON_SMALL + Link.NONTRANSLATED);
leaveLink.setElementCssClass("o_sign_out btn-danger");
leaveLink.setIconLeftCSS("o_icon o_icon_sign_out");
}
// access control
String accessI18n = null;
List<PriceMethod> types = new ArrayList<PriceMethod>();
if (entry.isMembersOnly()) {
// members only
if (isMember) {
String linkText = translate("start.with.type", translate(entry.getOlatResource().getResourceableTypeName()));
startLink = uifactory.addFormLink("start", "start", linkText, null, layoutCont, Link.BUTTON_LARGE + Link.NONTRANSLATED);
startLink.setElementCssClass("o_start btn-block");
startLink.setIconRightCSS("o_icon o_icon_start o_icon-lg");
startLink.setPrimary(true);
}
accessI18n = translate("cif.access.membersonly");
} else {
AccessResult acResult = acService.isAccessible(entry, getIdentity(), isMember, false);
if (acResult.isAccessible()) {
String linkText = translate("start.with.type", translate(entry.getOlatResource().getResourceableTypeName()));
startLink = uifactory.addFormLink("start", "start", linkText, null, layoutCont, Link.BUTTON_LARGE + Link.NONTRANSLATED);
startLink.setElementCssClass("o_start btn-block");
} else if (acResult.getAvailableMethods().size() > 0) {
for (OfferAccess access : acResult.getAvailableMethods()) {
AccessMethod method = access.getMethod();
String type = (method.getMethodCssClass() + "_icon").intern();
Price p = access.getOffer().getPrice();
String price = p == null || p.isEmpty() ? "" : PriceFormat.fullFormat(p);
AccessMethodHandler amh = acModule.getAccessMethodHandler(method.getType());
String displayName = amh.getMethodName(getLocale());
types.add(new PriceMethod(price, type, displayName));
}
String linkText = guestOnly ? translate("start.with.type", translate(entry.getOlatResource().getResourceableTypeName())) : translate("book.with.type", translate(entry.getOlatResource().getResourceableTypeName()));
startLink = uifactory.addFormLink("start", "start", linkText, null, layoutCont, Link.BUTTON_LARGE + Link.NONTRANSLATED);
// custom style
startLink.setCustomEnabledLinkCSS("btn btn-success");
startLink.setElementCssClass("o_book btn-block");
if (guestOnly) {
if (entry.getAccess() == RepositoryEntry.ACC_USERS_GUESTS) {
startLink.setVisible(true);
} else {
startLink.setVisible(false);
}
} else {
startLink.setVisible(true);
}
} else {
String linkText = translate("start.with.type", translate(entry.getOlatResource().getResourceableTypeName()));
startLink = uifactory.addFormLink("start", "start", linkText, null, layoutCont, Link.BUTTON_LARGE + Link.NONTRANSLATED);
// startLink.setEnabled(false);
startLink.setElementCssClass("o_start btn-block");
startLink.setVisible(!guestOnly);
}
startLink.setIconRightCSS("o_icon o_icon_start o_icon-lg");
startLink.setPrimary(true);
startLink.setFocus(true);
switch(entry.getAccess()) {
case 0:
accessI18n = "ERROR";
break;
case 1:
accessI18n = translate("cif.access.owners");
break;
case 2:
accessI18n = translate("cif.access.owners_authors");
break;
case 3:
accessI18n = translate("cif.access.users");
break;
case 4:
accessI18n = translate("cif.access.users_guests");
break;
}
}
layoutCont.contextPut("accessI18n", accessI18n);
if (!types.isEmpty()) {
layoutCont.contextPut("ac", types);
}
if (isMember) {
// show the list of groups
SearchBusinessGroupParams params = new SearchBusinessGroupParams(getIdentity(), true, true);
List<BusinessGroup> groups = businessGroupService.findBusinessGroups(params, entry, 0, -1);
List<String> groupLinkNames = new ArrayList<>(groups.size());
for (BusinessGroup group : groups) {
String groupLinkName = "grp_" + ++cmpcount;
String groupName = StringHelper.escapeHtml(group.getName());
FormLink link = uifactory.addFormLink(groupLinkName, "group", groupName, null, layoutCont, Link.LINK | Link.NONTRANSLATED);
link.setIconLeftCSS("o_icon o_icon-fw o_icon_group");
link.setUserObject(group.getKey());
groupLinkNames.add(groupLinkName);
}
layoutCont.contextPut("groups", groupLinkNames);
}
boolean passed = false;
boolean failed = false;
String score = null;
if (row != null) {
passed = row.isPassed();
failed = row.isFailed();
score = row.getScore();
} else {
UserEfficiencyStatement statement = effManager.getUserEfficiencyStatementLightByRepositoryEntry(entry, getIdentity());
if (statement != null) {
Boolean p = statement.getPassed();
if (p != null) {
passed = p.booleanValue();
failed = !p.booleanValue();
}
Float scoreVal = statement.getScore();
if (scoreVal != null) {
score = AssessmentHelper.getRoundedScore(scoreVal);
}
}
}
layoutCont.contextPut("passed", passed);
layoutCont.contextPut("failed", failed);
layoutCont.contextPut("score", score);
OLATResource ores = entry.getOlatResource();
Date recentLaunch = userCourseInfosManager.getRecentLaunchDate(ores, getIdentity());
layoutCont.contextPut("recentLaunch", recentLaunch);
// show how many users are currently using this resource
String numUsers;
int cnt = 0;
Long courseResId = entry.getOlatResource().getResourceableId();
OLATResourceable courseRunOres = OresHelper.createOLATResourceableInstance(RunMainController.ORES_TYPE_COURSE_RUN, courseResId);
if (ores != null)
cnt = coordinatorManager.getCoordinator().getEventBus().getListeningIdentityCntFor(courseRunOres);
numUsers = String.valueOf(cnt);
layoutCont.contextPut("numUsers", numUsers);
// Where is it in use
if (isAuthor || roles.isOLATAdmin() || roles.isInstitutionalResourceManager()) {
List<RepositoryEntry> refs = referenceManager.getRepositoryReferencesTo(entry.getOlatResource());
if (refs.size() > 0) {
List<String> refLinks = new ArrayList<>(refs.size());
int count = 0;
for (RepositoryEntry ref : refs) {
String name = "ref-" + count++;
FormLink refLink = uifactory.addFormLink(name, "ref", ref.getDisplayname(), null, formLayout, Link.NONTRANSLATED);
refLink.setUserObject(ref.getKey());
refLink.setIconLeftCSS("o_icon o_icon-fw " + RepositoyUIFactory.getIconCssClass(ref));
refLinks.add(name);
}
layoutCont.contextPut("referenceLinks", refLinks);
}
}
// Link to bookmark entry
String url = Settings.getServerContextPathURI() + "/url/RepositoryEntry/" + entry.getKey();
layoutCont.contextPut("extlink", url);
Boolean guestAllowed = (entry.getAccess() >= RepositoryEntry.ACC_USERS_GUESTS && loginModule.isGuestLoginLinksEnabled()) ? Boolean.TRUE : Boolean.FALSE;
layoutCont.contextPut("isGuestAllowed", guestAllowed);
// Owners
List<String> authorLinkNames = new ArrayList<String>(authorKeys.size());
Map<Long, String> authorNames = userManager.getUserDisplayNamesByKey(authorKeys);
int counter = 0;
for (Map.Entry<Long, String> author : authorNames.entrySet()) {
Long authorKey = author.getKey();
String authorName = StringHelper.escapeHtml(author.getValue());
FormLink authorLink = uifactory.addFormLink("owner-" + ++counter, "owner", authorName, null, formLayout, Link.NONTRANSLATED | Link.LINK);
authorLink.setUserObject(authorKey);
authorLinkNames.add(authorLink.getComponent().getComponentName());
}
layoutCont.contextPut("authorlinknames", authorLinkNames);
// License
boolean licEnabled = licenseModule.isEnabled(licenseHandler);
if (licEnabled) {
layoutCont.contextPut("licSwitch", Boolean.TRUE);
License license = licenseService.loadOrCreateLicense(entry.getOlatResource());
layoutCont.contextPut("license", LicenseUIFactory.translate(license.getLicenseType(), getLocale()));
layoutCont.contextPut("licenseIconCss", LicenseUIFactory.getCssOrDefault(license.getLicenseType()));
String licensor = StringHelper.containsNonWhitespace(license.getLicensor()) ? license.getLicensor() : "";
layoutCont.contextPut("licensor", licensor);
layoutCont.contextPut("licenseText", LicenseUIFactory.getFormattedLicenseText(license));
} else {
layoutCont.contextPut("licSwitch", Boolean.FALSE);
}
}
}
use of org.olat.resource.accesscontrol.AccessResult in project OpenOLAT by OpenOLAT.
the class RepositoryIndexer method checkAccess.
/**
* @see org.olat.search.service.indexer.Indexer#checkAccess(org.olat.core.id.context.ContextEntry, org.olat.core.id.context.BusinessControl, org.olat.core.id.Identity, org.olat.core.id.Roles)
*/
@Override
public boolean checkAccess(ContextEntry contextEntry, BusinessControl businessControl, Identity identity, Roles roles) {
boolean debug = isLogDebugEnabled();
if (debug)
logDebug("checkAccess for businessControl=" + businessControl + " identity=" + identity + " roles=" + roles);
Long repositoryKey = contextEntry.getOLATResourceable().getResourceableId();
RepositoryEntry repositoryEntry = repositoryManager.lookupRepositoryEntry(repositoryKey);
if (repositoryEntry == null) {
return false;
}
if (roles.isGuestOnly()) {
if (repositoryEntry.getAccess() != RepositoryEntry.ACC_USERS_GUESTS) {
return false;
}
}
boolean isOwner = repositoryManager.isOwnerOfRepositoryEntry(identity, repositoryEntry);
boolean isAllowedToLaunch = false;
if (!isOwner) {
isAllowedToLaunch = repositoryManager.isAllowedToLaunch(identity, roles, repositoryEntry);
if (isAllowedToLaunch) {
List<ContextEntry> entries = businessControl.getEntriesDownTheControls();
if (entries.size() > 1) {
boolean hasAccess = false;
ACService acService = CoreSpringFactory.getImpl(ACService.class);
AccessResult acResult = acService.isAccessible(repositoryEntry, identity, false);
if (acResult.isAccessible()) {
hasAccess = true;
} else if (!acResult.getAvailableMethods().isEmpty()) {
for (OfferAccess offer : acResult.getAvailableMethods()) {
String type = offer.getMethod().getType();
if (type.equals(FreeAccessHandler.METHOD_TYPE) || type.equals(PaypalAccessHandler.METHOD_TYPE)) {
hasAccess = true;
}
}
}
isAllowedToLaunch = hasAccess;
}
}
}
if (debug)
logDebug("isOwner=" + isOwner + " isAllowedToLaunch=" + isAllowedToLaunch);
if (isOwner || isAllowedToLaunch) {
Indexer repositoryEntryIndexer = getRepositoryEntryIndexer(repositoryEntry);
if (debug)
logDebug("repositoryEntryIndexer=" + repositoryEntryIndexer);
if (repositoryEntryIndexer != null) {
return super.checkAccess(contextEntry, businessControl, identity, roles) && repositoryEntryIndexer.checkAccess(contextEntry, businessControl, identity, roles);
}
}
return false;
}
use of org.olat.resource.accesscontrol.AccessResult in project OpenOLAT by OpenOLAT.
the class UserCalendarWebService method getCalendars.
private void getCalendars(CalendarVisitor calVisitor, UserRequest ureq) {
Roles roles = ureq.getUserSession().getRoles();
Identity retrievedUser = ureq.getIdentity();
CalendarModule calendarModule = CoreSpringFactory.getImpl(CalendarModule.class);
if (calendarModule.isEnabled()) {
if (calendarModule.isEnablePersonalCalendar()) {
KalendarRenderWrapper personalWrapper = getPersonalCalendar(ureq.getIdentity());
calVisitor.visit(personalWrapper);
}
if (calendarModule.isEnableCourseToolCalendar() || calendarModule.isEnableCourseElementCalendar()) {
RepositoryManager rm = RepositoryManager.getInstance();
ACService acManager = CoreSpringFactory.getImpl(ACService.class);
SearchRepositoryEntryParameters repoParams = new SearchRepositoryEntryParameters(retrievedUser, roles, "CourseModule");
repoParams.setOnlyExplicitMember(true);
repoParams.setIdentity(retrievedUser);
IdentityEnvironment ienv = new IdentityEnvironment();
ienv.setIdentity(retrievedUser);
ienv.setRoles(roles);
List<RepositoryEntry> entries = rm.genericANDQueryWithRolesRestriction(repoParams, 0, -1, true);
for (RepositoryEntry entry : entries) {
AccessResult result = acManager.isAccessible(entry, retrievedUser, false);
if (result.isAccessible()) {
try {
final ICourse course = CourseFactory.loadCourse(entry);
CourseConfig config = course.getCourseEnvironment().getCourseConfig();
UserCourseEnvironment userCourseEnv = new UserCourseEnvironmentImpl(ienv, course.getCourseEnvironment());
if (config.isCalendarEnabled()) {
KalendarRenderWrapper wrapper = CourseCalendars.getCourseCalendarWrapper(ureq, userCourseEnv, null);
calVisitor.visit(wrapper);
} else {
CalCourseNodeVisitor visitor = new CalCourseNodeVisitor();
new CourseTreeVisitor(course, ienv).visit(visitor, new VisibleTreeFilter());
if (visitor.isFound()) {
KalendarRenderWrapper wrapper = CourseCalendars.getCourseCalendarWrapper(ureq, userCourseEnv, null);
calVisitor.visit(wrapper);
}
}
} catch (Exception e) {
log.error("", e);
}
}
}
}
if (calendarModule.isEnableGroupCalendar()) {
CollaborationManager collaborationManager = CoreSpringFactory.getImpl(CollaborationManager.class);
// start found forums in groups
BusinessGroupService bgm = CoreSpringFactory.getImpl(BusinessGroupService.class);
SearchBusinessGroupParams params = new SearchBusinessGroupParams(retrievedUser, true, true);
params.addTools(CollaborationTools.TOOL_CALENDAR);
List<BusinessGroup> groups = bgm.findBusinessGroups(params, null, 0, -1);
for (BusinessGroup group : groups) {
KalendarRenderWrapper wrapper = collaborationManager.getCalendar(group, ureq, false);
calVisitor.visit(wrapper);
}
}
}
}
use of org.olat.resource.accesscontrol.AccessResult in project OpenOLAT by OpenOLAT.
the class BCWebService method getFolders.
/**
* Retrieves metadata of the course node
* @response.representation.200.qname {http://www.example.com}folderVOes
* @response.representation.200.mediaType application/xml, application/json
* @response.representation.200.doc The course node metadatas
* @response.representation.200.example {@link org.olat.restapi.support.vo.Examples#SAMPLE_FOLDERVOes}
* @response.representation.401.doc The roles of the authenticated user are not sufficient
* @response.representation.404.doc The course or parentNode not found
* @param courseId The course resourceable's id
* @param nodeId The node's id
* @param httpRequest The HTTP request
* @return The persisted structure element (fully populated)
*/
@GET
@Produces({ MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON })
public Response getFolders(@PathParam("courseId") Long courseId, @Context HttpServletRequest httpRequest) {
final ICourse course = CoursesWebService.loadCourse(courseId);
if (course == null) {
return Response.serverError().status(Status.NOT_FOUND).build();
} else if (!CourseWebService.isCourseAccessible(course, false, httpRequest)) {
return Response.serverError().status(Status.UNAUTHORIZED).build();
}
final UserRequest ureq = getUserRequest(httpRequest);
RepositoryEntry entry = RepositoryManager.getInstance().lookupRepositoryEntry(course, true);
ACService acManager = CoreSpringFactory.getImpl(ACService.class);
AccessResult result = acManager.isAccessible(entry, ureq.getIdentity(), false);
if (!result.isAccessible()) {
return Response.serverError().status(Status.UNAUTHORIZED).build();
}
final Set<String> subscribed = new HashSet<String>();
NotificationsManager man = NotificationsManager.getInstance();
List<String> notiTypes = Collections.singletonList("FolderModule");
List<Subscriber> subs = man.getSubscribers(ureq.getIdentity(), notiTypes);
for (Subscriber sub : subs) {
Long courseKey = sub.getPublisher().getResId();
if (courseId.equals(courseKey)) {
subscribed.add(sub.getPublisher().getSubidentifier());
break;
}
}
final List<FolderVO> folderVOs = new ArrayList<FolderVO>();
new CourseTreeVisitor(course, ureq.getUserSession().getIdentityEnvironment()).visit(new Visitor() {
@Override
public void visit(INode node) {
if (node instanceof BCCourseNode) {
BCCourseNode bcNode = (BCCourseNode) node;
FolderVO folder = createFolderVO(ureq.getUserSession().getIdentityEnvironment(), course, bcNode, subscribed);
folderVOs.add(folder);
}
}
}, new VisibleTreeFilter());
FolderVOes voes = new FolderVOes();
voes.setFolders(folderVOs.toArray(new FolderVO[folderVOs.size()]));
voes.setTotalCount(folderVOs.size());
return Response.ok(voes).build();
}
use of org.olat.resource.accesscontrol.AccessResult in project openolat by klemens.
the class ACFrontendManager method isAccessible.
/**
* The rule to access a business group:<br/>
* -No offer, access is free<br/>
* -Owners have always access to the resource<br/>
* -Tutors have access to the resource<br/>
* -Participants have access to the resource<br/>
* @param group
* @param forId
* @return
*/
@Override
public AccessResult isAccessible(BusinessGroup group, Identity forId, boolean allowNonInteractiveAccess) {
if (!accessModule.isEnabled()) {
return new AccessResult(true);
}
List<String> roles = businessGroupRelationDao.getRoles(forId, group);
if (roles.contains(GroupRoles.coach.name())) {
return new AccessResult(true);
}
if (roles.contains(GroupRoles.participant.name())) {
return new AccessResult(true);
}
Date now = dateNow();
OLATResource resource = OLATResourceManager.getInstance().findResourceable(group);
List<Offer> offers = accessManager.findOfferByResource(resource, true, now);
if (offers.isEmpty()) {
if (methodManager.isValidMethodAvailable(resource, null)) {
// not open for the moment: no valid offer at this date but some methods are defined
return new AccessResult(false);
} else {
return new AccessResult(true);
}
}
return isAccessible(forId, offers, allowNonInteractiveAccess);
}
Aggregations