001/**
002 * Copyright 2005-2017 The Kuali Foundation
003 *
004 * Licensed under the Educational Community 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.opensource.org/licenses/ecl2.php
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 */
016package org.kuali.rice.kew.impl.document.attribute;
017
018import org.apache.commons.lang.StringUtils;
019import org.apache.log4j.Logger;
020import org.apache.log4j.MDC;
021import org.joda.time.DateTime;
022import org.kuali.rice.core.api.exception.RiceIllegalArgumentException;
023import org.kuali.rice.kew.api.KewApiServiceLocator;
024import org.kuali.rice.kew.api.WorkflowRuntimeException;
025import org.kuali.rice.kew.api.document.Document;
026import org.kuali.rice.kew.api.document.DocumentContent;
027import org.kuali.rice.kew.api.document.DocumentWithContent;
028import org.kuali.rice.kew.api.document.WorkflowDocumentService;
029import org.kuali.rice.kew.api.document.attribute.DocumentAttribute;
030import org.kuali.rice.kew.api.document.attribute.DocumentAttributeDateTime;
031import org.kuali.rice.kew.api.document.attribute.DocumentAttributeDecimal;
032import org.kuali.rice.kew.api.document.attribute.DocumentAttributeIndexingQueue;
033import org.kuali.rice.kew.api.document.attribute.DocumentAttributeInteger;
034import org.kuali.rice.kew.api.document.attribute.DocumentAttributeString;
035import org.kuali.rice.kew.docsearch.SearchableAttributeDateTimeValue;
036import org.kuali.rice.kew.docsearch.SearchableAttributeFloatValue;
037import org.kuali.rice.kew.docsearch.SearchableAttributeLongValue;
038import org.kuali.rice.kew.docsearch.SearchableAttributeStringValue;
039import org.kuali.rice.kew.docsearch.SearchableAttributeValue;
040import org.kuali.rice.kew.doctype.bo.DocumentType;
041import org.kuali.rice.kew.framework.document.attribute.SearchableAttribute;
042import org.kuali.rice.kew.service.KEWServiceLocator;
043
044import java.math.BigInteger;
045import java.sql.Timestamp;
046import java.util.ArrayList;
047import java.util.List;
048
049/**
050 * Reference implementation of the DocumentAttributeIndexingQueue.
051 *
052 * @author Kuali Rice Team (rice.collab@kuali.org)
053 */
054public class DocumentAttributeIndexingQueueImpl implements DocumentAttributeIndexingQueue {
055
056        private static Logger LOG = Logger.getLogger(DocumentAttributeIndexingQueueImpl.class);
057
058    @Override
059    public void indexDocument(String documentId) {
060        if (StringUtils.isBlank(documentId)) {
061            throw new RiceIllegalArgumentException("documentId was null or blank");
062        }
063        MDC.put("docId", documentId);
064        try {
065            long t1 = System.currentTimeMillis();
066            LOG.info("Indexing document attributes for document " + documentId);
067            Document document = getWorkflowDocumentService().getDocument(documentId);
068            if (document == null) {
069                throw new RiceIllegalArgumentException("Failed to locate document with the given id: " + documentId);
070            }
071            DocumentContent documentContent =
072                    KewApiServiceLocator.getWorkflowDocumentService().getDocumentContent(documentId);
073            List<SearchableAttributeValue> attributes = buildSearchableAttributeValues(document, documentContent);
074            KEWServiceLocator.getRouteHeaderService().updateRouteHeaderSearchValues(documentId, attributes);
075            long t2 = System.currentTimeMillis();
076            LOG.info("...finished indexing document " + documentId + " for document search, total time = " + (t2 - t1) +
077                    " ms.");
078        } finally {
079            MDC.remove("docId");
080        }
081    }
082
083    /**
084     * Determines the {@link DocumentAttribute}s for the given document and returns a List of SearchableAttributeValue
085     * which will be saved.
086     */
087        private List<SearchableAttributeValue> buildSearchableAttributeValues(Document document, DocumentContent documentContent) {
088                List<SearchableAttributeValue> searchableAttributeValues = new ArrayList<SearchableAttributeValue>();
089        DocumentType documentTypeBo = KEWServiceLocator.getDocumentTypeService().findByName(document.getDocumentTypeName());
090                for (DocumentType.ExtensionHolder<SearchableAttribute> searchableAttributeHolder : documentTypeBo.loadSearchableAttributes()) {
091            DocumentWithContent documentWithContent = DocumentWithContent.create(document, documentContent);
092            SearchableAttribute searchableAttribute = searchableAttributeHolder.getExtension();
093            if ( searchableAttribute == null ) {
094                LOG.warn( "Encountered a 'null' SearchableAttribute on " + document.getDocumentTypeName() + " : " + searchableAttributeHolder.getExtensionDefinition().getName() );
095                continue;
096            }
097            List<DocumentAttribute> documentAttributes = searchableAttribute.extractDocumentAttributes(
098                    searchableAttributeHolder.getExtensionDefinition(), documentWithContent);
099                        if (documentAttributes != null) {
100                for (DocumentAttribute documentAttribute : documentAttributes) {
101                    if (documentAttribute == null) {
102                        LOG.warn("Encountered a 'null' DocumentAttribute on " + document.getDocumentTypeName() + " from searchable attribute: " + searchableAttribute);
103                        continue;
104                    }
105                    SearchableAttributeValue searchableAttributeValue = null;
106                    if (documentAttribute instanceof DocumentAttributeString) {
107                        searchableAttributeValue = new SearchableAttributeStringValue();
108                        ((SearchableAttributeStringValue)searchableAttributeValue).setSearchableAttributeValue(((DocumentAttributeString)documentAttribute).getValue());
109                    } else if (documentAttribute instanceof DocumentAttributeDateTime) {
110                        searchableAttributeValue = new SearchableAttributeDateTimeValue();
111                        DateTime dateTimeValue = ((DocumentAttributeDateTime)documentAttribute).getValue();
112                        Timestamp timestamp = (dateTimeValue == null ? null : new Timestamp(dateTimeValue.getMillis()));
113                        ((SearchableAttributeDateTimeValue)searchableAttributeValue).setSearchableAttributeValue(timestamp);
114                    } else if (documentAttribute instanceof DocumentAttributeInteger) {
115                        searchableAttributeValue = new SearchableAttributeLongValue();
116                        BigInteger bigIntegerValue = ((DocumentAttributeInteger)documentAttribute).getValue();
117                        Long longValue = (bigIntegerValue == null ? null : bigIntegerValue.longValue());
118                        ((SearchableAttributeLongValue)searchableAttributeValue).setSearchableAttributeValue(longValue);
119                    } else if (documentAttribute instanceof DocumentAttributeDecimal) {
120                        searchableAttributeValue = new SearchableAttributeFloatValue();
121                        ((SearchableAttributeFloatValue)searchableAttributeValue).setSearchableAttributeValue(((DocumentAttributeDecimal)documentAttribute).getValue());
122                    } else {
123                        throw new WorkflowRuntimeException("Encountered an invalid instance of DocumentAttribute, was: " + documentAttribute.getClass());
124                    }
125                    searchableAttributeValue.setSearchableAttributeKey(documentAttribute.getName());
126                    searchableAttributeValue.setDocumentId(document.getDocumentId());
127                    searchableAttributeValue.setRouteHeader(null); // let the documentId we set represent this reference
128                    searchableAttributeValues.add(searchableAttributeValue);
129                }
130                        }
131                }
132                return searchableAttributeValues;
133        }
134
135    protected WorkflowDocumentService getWorkflowDocumentService() {
136        return KewApiServiceLocator.getWorkflowDocumentService();
137    }
138}