001/*
002 * (C) Copyright 2014 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     <a href="mailto:grenard@nuxeo.com">Guillaume</a>
018 */
019package org.nuxeo.ecm.collections.core;
020
021import java.util.Locale;
022import java.util.MissingResourceException;
023
024import org.nuxeo.common.utils.i18n.I18NUtils;
025import org.nuxeo.ecm.collections.api.CollectionManager;
026import org.nuxeo.ecm.collections.api.FavoritesConstants;
027import org.nuxeo.ecm.collections.api.FavoritesManager;
028import org.nuxeo.ecm.core.api.CoreSession;
029import org.nuxeo.ecm.core.api.DocumentModel;
030import org.nuxeo.ecm.core.api.security.ACE;
031import org.nuxeo.ecm.core.api.security.ACL;
032import org.nuxeo.ecm.core.api.security.ACP;
033import org.nuxeo.ecm.core.api.security.SecurityConstants;
034import org.nuxeo.ecm.core.api.security.impl.ACLImpl;
035import org.nuxeo.ecm.core.api.security.impl.ACPImpl;
036import org.nuxeo.ecm.platform.userworkspace.api.UserWorkspaceService;
037import org.nuxeo.ecm.platform.web.common.locale.LocaleProvider;
038import org.nuxeo.runtime.api.Framework;
039import org.nuxeo.runtime.model.DefaultComponent;
040
041/**
042 * @since 5.9.4
043 */
044public class FavoritesManagerImpl extends DefaultComponent implements FavoritesManager {
045
046    @Override
047    public void addToFavorites(DocumentModel document, CoreSession session) {
048        final CollectionManager collectionManager = Framework.getService(CollectionManager.class);
049        collectionManager.addToCollection(getFavorites(document, session), document, session);
050    }
051
052    @Override
053    public boolean canAddToFavorites(DocumentModel document) {
054        final CollectionManager collectionManager = Framework.getService(CollectionManager.class);
055        return collectionManager.isCollectable(document);
056    }
057
058    protected DocumentModel createFavorites(CoreSession session, DocumentModel userWorkspace) {
059        DocumentModel doc = session.createDocumentModel(userWorkspace.getPath().toString(),
060                FavoritesConstants.DEFAULT_FAVORITES_NAME, FavoritesConstants.FAVORITES_TYPE);
061        String title = null;
062        try {
063            title = I18NUtils.getMessageString("messages", FavoritesConstants.DEFAULT_FAVORITES_TITLE, new Object[0],
064                    getLocale(session));
065        } catch (MissingResourceException e) {
066            title = FavoritesConstants.DEFAULT_FAVORITES_NAME;
067        }
068        doc.setPropertyValue("dc:title", title);
069        doc.setPropertyValue("dc:description", "");
070        return doc;
071    }
072
073    protected DocumentModel initCreateFavorites(CoreSession session, DocumentModel favorites) {
074        ACP acp = new ACPImpl();
075        ACE denyEverything = new ACE(SecurityConstants.EVERYONE, SecurityConstants.EVERYTHING, false);
076        ACE allowEverything = new ACE(session.getPrincipal().getName(), SecurityConstants.EVERYTHING, true);
077        ACL acl = new ACLImpl();
078        acl.setACEs(new ACE[] { allowEverything, denyEverything });
079        acp.addACL(acl);
080        favorites.setACP(acp, true);
081        return favorites;
082    }
083
084    @Override
085    public DocumentModel getFavorites(final DocumentModel context, final CoreSession session) {
086        final UserWorkspaceService userWorkspaceService = Framework.getService(UserWorkspaceService.class);
087        final DocumentModel userWorkspace = userWorkspaceService.getCurrentUserPersonalWorkspace(session, context);
088        if (userWorkspace == null) {
089            // no user workspace => no favorites (transient user for instance)
090            return null;
091        }
092        DocumentModel favorites = createFavorites(session, userWorkspace);
093        return session.getOrCreateDocument(favorites, doc -> initCreateFavorites(session, doc));
094    }
095
096    protected Locale getLocale(final CoreSession session) {
097        Locale locale = null;
098        locale = Framework.getService(LocaleProvider.class).getLocale(session);
099        if (locale == null) {
100            locale = Locale.getDefault();
101        }
102        return new Locale(Locale.getDefault().getLanguage());
103    }
104
105    @Override
106    public boolean isFavorite(DocumentModel document, CoreSession session) {
107        final CollectionManager collectionManager = Framework.getService(CollectionManager.class);
108        return collectionManager.isInCollection(getFavorites(document, session), document, session);
109    }
110
111    @Override
112    public void removeFromFavorites(DocumentModel document, CoreSession session) {
113        final CollectionManager collectionManager = Framework.getService(CollectionManager.class);
114        collectionManager.removeFromCollection(getFavorites(document, session), document, session);
115    }
116
117}