PortfolioArtefactIndexer.java

/**
 * <a href="http://www.openolat.org">
 * OpenOLAT - Online Learning and Training</a><br>
 * <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 the
 * <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache homepage</a>
 * <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>
 * Initial code contributed and copyrighted by<br>
 * frentix GmbH, http://www.frentix.com
 * <p>
 */

package org.olat.search.service.indexer.identity;

import java.io.IOException;
import java.util.List;

import org.olat.core.id.Identity;
import org.olat.core.id.OLATResourceable;
import org.olat.core.id.Roles;
import org.olat.core.id.context.BusinessControl;
import org.olat.core.id.context.ContextEntry;
import org.olat.core.util.resource.OresHelper;
import org.olat.portfolio.EPArtefactHandler;
import org.olat.portfolio.PortfolioModule;
import org.olat.portfolio.manager.EPFrontendManager;
import org.olat.portfolio.model.artefacts.AbstractArtefact;
import org.olat.search.model.OlatDocument;
import org.olat.search.service.SearchResourceContext;
import org.olat.search.service.indexer.AbstractHierarchicalIndexer;
import org.olat.search.service.indexer.OlatFullIndexer;

/**
 * 
 * Description:<br>
 * Index artefacts
 * 
 * <P>
 * Initial Date:  12 nov. 2010 <br>
 * @author srosse, stephane.rosse@frentix.com, http://www.frentix.com
 */
public class PortfolioArtefactIndexer extends AbstractHierarchicalIndexer {
	
	public static final String TYPE = "type.identity." + AbstractArtefact.class.getSimpleName();
		
	private static final int MAX_RESULTS = 500;
	
	private PortfolioModule portfolioModule;
	private EPFrontendManager frontendManager;
	
	/**
	 * [used by Spring]
	 * @param frontendManager
	 */
	public void setFrontendManager(EPFrontendManager frontendManager) {
		this.frontendManager = frontendManager;
	}
	
	/**
	 * [used by Spring]
	 * @param portfolioModule
	 */
	public void setPortfolioModule(PortfolioModule portfolioModule) {
		this.portfolioModule = portfolioModule;
	}

	@Override
	public String getSupportedTypeName() {
		return AbstractArtefact.class.getSimpleName();
	}
	
	@Override
	public void doIndex(SearchResourceContext searchResourceContext, Object object, OlatFullIndexer indexerWriter)
	throws IOException, InterruptedException {
		if(!portfolioModule.isEnabled()) return;
		Identity identity = (Identity)object;
//		SearchResourceContext resourceContext = new SearchResourceContext(searchResourceContext); // dont do this way, as it would then try to open an artefact over visiting card -> not possible!
		SearchResourceContext resourceContext = new SearchResourceContext();
		resourceContext.setDocumentType(TYPE);
		resourceContext.setParentContextType(null);
		
		int currentPosition = 0;
		List<AbstractArtefact> artefacts;
		do {
			artefacts = frontendManager.getArtefacts(identity, currentPosition, MAX_RESULTS);
			for(AbstractArtefact artefact:artefacts) {
				OLATResourceable ores = OresHelper.createOLATResourceableInstance(AbstractArtefact.class.getSimpleName(), artefact.getKey());
				EPArtefactHandler<?> handler = portfolioModule.getArtefactHandler(artefact.getResourceableTypeName());
				resourceContext.setBusinessControlFor(ores);
				OlatDocument doc = handler.getIndexerDocument(resourceContext, artefact, frontendManager);
				Identity author = artefact.getAuthor();
				if(author != null && author.getUser() != null) {
					doc.setReservedTo(author.getKey().toString());
				}
				if(doc != null) {
					indexerWriter.addDocument(doc.getLuceneDocument());
				}
			}
			currentPosition += artefacts.size();
		} while (artefacts.size() == MAX_RESULTS);

		super.doIndex(searchResourceContext, object, indexerWriter);
	}

	@Override
	public boolean checkAccess(ContextEntry contextEntry, BusinessControl businessControl, Identity identity, Roles roles) {
		//reserved, check made by indexer with the RESERVEDTO field
		return super.checkAccess(contextEntry, businessControl, identity, roles);
	}
}