Metacat

/**

 *  '$RCSfile$'

 *    Purpose: A class that gets Accession Number, check for uniqueness

 *             and register it into db

 *  Copyright: 2000 Regents of the University of California and the

 *             National Center for Ecological Analysis and Synthesis

 *    Authors: Jivka Bojilova, Matt Jones

 *

 *   '$Author: leinfelder $'

 *     '$Date: 2011-11-02 20:40:12 -0700 (Wed, 02 Nov 2011) $'

 * '$Revision: 6595 $'

 *

 * This program is free software; you can redistribute it and/or modify

 * it under the terms of the GNU General Public License as published by

 * the Free Software Foundation; either version 2 of the License, or

 * (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

 */

package edu.ucsb.nceas.metacat.index;

import java.io.ByteArrayInputStream;

import java.io.IOException;

import java.io.InputStream;

import java.util.ArrayList;

import java.util.HashMap;

import java.util.Iterator;

import java.util.List;

import java.util.Map;

import java.util.Set;

import javax.xml.parsers.DocumentBuilder;

import javax.xml.parsers.DocumentBuilderFactory;

import javax.xml.parsers.ParserConfigurationException;

import javax.xml.xpath.XPath;

import javax.xml.xpath.XPathExpressionException;

import javax.xml.xpath.XPathFactory;

import org.apache.commons.codec.EncoderException;

import org.apache.commons.io.output.ByteArrayOutputStream;

import org.apache.commons.logging.Log;

import org.apache.commons.logging.LogFactory;

import org.apache.solr.client.solrj.SolrQuery;

import org.apache.solr.client.solrj.SolrServer;

import org.apache.solr.client.solrj.SolrServerException;

import org.apache.solr.client.solrj.response.QueryResponse;

import org.apache.solr.client.solrj.response.UpdateResponse;

import org.apache.solr.common.SolrDocument;

import org.apache.solr.common.SolrDocumentList;

import org.apache.solr.common.SolrInputDocument;

import org.apache.solr.common.util.NamedList;

import org.dataone.cn.indexer.XMLNamespaceConfig;

import org.dataone.cn.indexer.parser.IDocumentSubprocessor;

import org.dataone.cn.indexer.parser.SolrField;

import org.dataone.cn.indexer.solrhttp.SolrDoc;

import org.dataone.cn.indexer.solrhttp.SolrElementField;

import org.dataone.service.exceptions.NotFound;

import org.dataone.service.exceptions.NotImplemented;

import org.dataone.service.exceptions.UnsupportedType;

import org.dataone.service.types.v1.Identifier;

import org.dataone.service.types.v1.SystemMetadata;

import org.dataone.service.util.TypeMarshaller;

import org.jibx.runtime.JiBXException;

import org.w3c.dom.Document;

import org.w3c.dom.NameList;

import org.xml.sax.SAXException;

import edu.ucsb.nceas.metacat.index.resourcemap.ResourceMapSubprocessor;

/**

 * A class does insert, update and remove indexes to a SOLR server

 * @author tao

 *

 */

public class SolrIndex {

    public static final String ID = "id";

    private static final String IDQUERY = ID+":*";

    private List<IDocumentSubprocessor> subprocessors = null;

    private SolrServer solrServer = null;

    private XMLNamespaceConfig xmlNamespaceConfig = null;

    private List<SolrField> sysmetaSolrFields = null;

    private static DocumentBuilderFactory documentBuilderFactory = null;

    private static DocumentBuilder builder = null;

    private static XPathFactory xpathFactory = null;

    private static XPath xpath = null;

    Log log = LogFactory.getLog(SolrIndex.class);

    static {

        documentBuilderFactory = DocumentBuilderFactory.newInstance();

        documentBuilderFactory.setNamespaceAware(true);

        try {

            builder = documentBuilderFactory.newDocumentBuilder();

        } catch (ParserConfigurationException e) {

            e.printStackTrace();

        }

        xpathFactory = XPathFactory.newInstance();

        xpath = xpathFactory.newXPath();

    }

    /**

     * Constructor

     * @throws SAXException 

     * @throws IOException 

     */

    public SolrIndex(List<SolrField> sysmetaSolrFields, XMLNamespaceConfig xmlNamespaceConfig)

                    throws XPathExpressionException, ParserConfigurationException, IOException, SAXException {

         this.xmlNamespaceConfig = xmlNamespaceConfig;

         this.sysmetaSolrFields = sysmetaSolrFields;

         init();

    }

    private void init() throws ParserConfigurationException, XPathExpressionException {

        xpath.setNamespaceContext(xmlNamespaceConfig);

        initExpressions();

    }

    private void initExpressions() throws XPathExpressionException {

        for (SolrField field : sysmetaSolrFields) {

            field.initExpression(xpath);

        }

    }

    /**

     * Get the list of the Subprocessors in this index.

     * @return the list of the Subprocessors.

     */

    public List<IDocumentSubprocessor> getSubprocessors() {

        return subprocessors;

    }

    /**

     * Set the list of Subprocessors.

     * @param subprocessorList  the list will be set.

     */

    public void setSubprocessors(List<IDocumentSubprocessor> subprocessorList) {

        for (IDocumentSubprocessor subprocessor : subprocessorList) {

            subprocessor.initExpression(xpath);

        }

        this.subprocessors = subprocessorList;

    }

    /**

     * Generate the index for the given information

     * @param id

     * @param systemMetadata

     * @param dataStream

     * @return

     * @throws IOException

     * @throws SAXException

     * @throws ParserConfigurationException

     * @throws XPathExpressionException

     * @throws JiBXException 

     * @throws SolrServerException 

     * @throws EncoderException

     * @throws UnsupportedType 

     * @throws NotFound 

     * @throws NotImplemented 

     */

    private Map<String, SolrDoc> process(String id, SystemMetadata systemMetadata, InputStream dataStream)

                    throws IOException, SAXException, ParserConfigurationException,

                    XPathExpressionException, JiBXException, EncoderException, SolrServerException, NotImplemented, NotFound, UnsupportedType{

        // Load the System Metadata document

        ByteArrayOutputStream systemMetadataOutputStream = new ByteArrayOutputStream();

        TypeMarshaller.marshalTypeToOutputStream(systemMetadata, systemMetadataOutputStream);

        ByteArrayInputStream systemMetadataStream = new ByteArrayInputStream(systemMetadataOutputStream.toByteArray());

        Document sysMetaDoc = generateXmlDocument(systemMetadataStream);

        if (sysMetaDoc == null) {

            log.error("Could not load System metadata for ID: " + id);

            return null;

        }

        // Extract the field values from the System Metadata

        List<SolrElementField> sysSolrFields = processSysmetaFields(sysMetaDoc, id);

        SolrDoc indexDocument = new SolrDoc(sysSolrFields);

        Map<String, SolrDoc> docs = new HashMap<String, SolrDoc>();

        docs.put(id, indexDocument);

        // Determine if subprocessors are available for this ID

        if (subprocessors != null) {

                    // for each subprocessor loaded from the spring config

                    for (IDocumentSubprocessor subprocessor : subprocessors) {

                        // Does this subprocessor apply?

                        if (subprocessor.canProcess(sysMetaDoc)) {

                            // if so, then extract the additional information from the

                            // document.

                            try {

                                // docObject = the resource map document or science

                                // metadata document.

                                // note that resource map processing touches all objects

                                // referenced by the resource map.

                                Document docObject = generateXmlDocument(dataStream);

                                if (docObject == null) {

                                    log.error("Could not load OBJECT for ID " + id );

                                } else {

                                    docs = subprocessor.processDocument(id, docs, docObject);

                                }

                            } catch (Exception e) {

                                log.error(e.getStackTrace().toString());

                            }

                        }

                    }

       }

       // TODO: in the XPathDocumentParser class in d1_cn_index_process module,

       // merge is only for resource map. We need more work here.

       for (SolrDoc mergeDoc : docs.values()) {

           if (!mergeDoc.isMerged()) {

                 mergeWithIndexedDocument(mergeDoc);

           }

       }

       //SolrElementAdd addCommand = getAddCommand(new ArrayList<SolrDoc>(docs.values()));

       return docs;

    }

    /**

     * Merge updates with existing solr documents

     * 

     * This method appears to re-set the data package field data into the

     * document about to be updated in the solr index. Since packaging

     * information is derived from the package document (resource map), this

     * information is not present when processing a document contained in a data

     * package. This method replaces those values from the existing solr index

     * record for the document being processed. -- sroseboo, 1-18-12

     * 

     * @param indexDocument

     * @return

     * @throws IOException

     * @throws EncoderException

     * @throws XPathExpressionException

     * @throws SAXException 

     * @throws ParserConfigurationException 

     * @throws SolrServerException 

     * @throws UnsupportedType 

     * @throws NotFound 

     * @throws NotImplemented 

     */

    // TODO:combine merge function with resourcemap merge function

    private SolrDoc mergeWithIndexedDocument(SolrDoc indexDocument) throws IOException,

            EncoderException, XPathExpressionException, SolrServerException, ParserConfigurationException, SAXException, NotImplemented, NotFound, UnsupportedType {

        List<String> ids = new ArrayList<String>();

        ids.add(indexDocument.getIdentifier());

        List<SolrDoc> indexedDocuments = ResourceMapSubprocessor.getSolrDocs(ids);

        SolrDoc indexedDocument = indexedDocuments == null || indexedDocuments.size() <= 0 ? null

                : indexedDocuments.get(0);

        if (indexedDocument == null || indexedDocument.getFieldList().size() <= 0) {

            return indexDocument;

        } else {

            for (SolrElementField field : indexedDocument.getFieldList()) {

                if ((field.getName().equals(SolrElementField.FIELD_ISDOCUMENTEDBY)

                        || field.getName().equals(SolrElementField.FIELD_DOCUMENTS) || field

                        .getName().equals(SolrElementField.FIELD_RESOURCEMAP))

                        && !indexDocument.hasFieldWithValue(field.getName(), field.getValue())) {

                    indexDocument.addField(field);

                }

            }

            indexDocument.setMerged(true);

            return indexDocument;

        }

    }

    /*

     * Generate a Document from the InputStream

     */

    private Document generateXmlDocument(InputStream smdStream) throws SAXException {

        Document doc = null;

        try {

            doc = builder.parse(smdStream);

        } catch (IOException e) {

            log.error(e.getMessage(), e);

        }

        return doc;

    }

    /*

     * Index the fields of the system metadata

     */

    private List<SolrElementField> processSysmetaFields(Document doc, String identifier) {

        List<SolrElementField> fieldList = new ArrayList<SolrElementField>();

        // solrFields is the list of fields defined in the application context

        for (SolrField field : sysmetaSolrFields) {

            try {

                // the field.getFields method can return a single value or

                // multiple values for multi-valued fields

                // or can return multiple SOLR document fields.

                fieldList.addAll(field.getFields(doc, identifier));

            } catch (Exception e) {

                e.printStackTrace();

            }

        }

        return fieldList;

    }

    /**

     * Check the parameters of the insert or update methods.

     * @param pid

     * @param systemMetadata

     * @param data

     * @throws SolrServerException

     */

    private void checkParams(String pid, SystemMetadata systemMetadata, InputStream data) throws SolrServerException {

        if(pid == null || pid.trim().equals("")) {

            throw new SolrServerException("The identifier of the indexed document should not be null or blank.");

        }

        if(systemMetadata == null) {

            throw new SolrServerException("The system metadata of the indexed document should not be null.");

        }

        if(data == null) {

            throw new SolrServerException("The indexed document itself should not be null.");

        }

    }

    /**

     * Insert the indexes for a document.

     * @param pid  the id of this document

     * @param systemMetadata  the system metadata associated with the data object

     * @param data  the data object itself

     * @throws SolrServerException 

     * @throws JiBXException 

     * @throws EncoderException 

     * @throws UnsupportedType 

     * @throws NotFound 

     * @throws NotImplemented 

     */

    private synchronized void insert(String pid, SystemMetadata systemMetadata, InputStream data) 

                    throws IOException, SAXException, ParserConfigurationException,

                    XPathExpressionException, SolrServerException, JiBXException, EncoderException, NotImplemented, NotFound, UnsupportedType {

        checkParams(pid, systemMetadata, data);

        Map<String, SolrDoc> docs = process(pid, systemMetadata, data);

        //transform the Map to the SolrInputDocument which can be used by the solr server

        if(docs != null) {

            Set<String> ids = docs.keySet();

            for(String id : ids) {

                SolrInputDocument solrDoc = new SolrInputDocument();

                if(id != null) {

                    SolrDoc doc = docs.get(id);

                    if(doc != null) {

                        List<SolrElementField> list = doc.getFieldList();

                        if(list != null) {

                            //solrDoc.addField(METACATPIDFIELD, pid);

                            Iterator<SolrElementField> iterator = list.iterator();

                            while (iterator.hasNext()) {

                                SolrElementField field = iterator.next();

                                if(field != null) {

                                    String value = field.getValue();

                                    String name = field.getName();

                                    //System.out.println("add name/value pair - "+name+"/"+value);

                                    solrDoc.addField(name, value);

                                }

                            }

                        }

                    }

                }

                if(!solrDoc.isEmpty()) {

                    UpdateResponse response = solrServer.add(solrDoc);

                    solrServer.commit();

                    //System.out.println("=================the response is:\n"+response.toString());

                }

            }

        }

    }

    /**

     * Update the solr index. This method handles the three scenarios:

     * 1. Archive (or delete) - if the the system metadata shows the value of the archive is true,

     *    remove the index for the document and its previous versions if it has.

     * 2. Update an existing doc - if the the system metadata shows the value of the archive is false and it has an obsoletes,

     *    remove the index for the previous version(s) and generate new index for the doc.

     * 3. Add a new doc - if the system metadata shows the value of the archive is false and it hasn't an obsoletes, generate the

     *    index for the doc.

     * @param pid  the id of the document

     * @param obsoleteIds  the chain of the obsoletes by this id

     * @param systemMetadata  the system metadata associated with the data object

     * @param data  the data object itself

     * @throws SolrServerException 

     * @throws JiBXException 

     * @throws EncoderException 

     * @throws UnsupportedType 

     * @throws NotFound 

     * @throws NotImplemented 

     */

    public void update(String pid, List<String> obsoleteIds, SystemMetadata systemMetadata, InputStream data) 

                    throws IOException, SAXException, ParserConfigurationException,

                    XPathExpressionException, SolrServerException, JiBXException, EncoderException, NotImplemented, NotFound, UnsupportedType {

        checkParams(pid, systemMetadata, data);

        boolean isArchive = systemMetadata.getArchived();

        if(isArchive) {

            //archive(delete)

            Identifier obsolete = systemMetadata.getObsoletes();

            if(obsolete != null) {

                removeObsoletesChain(obsolete.getValue(), obsoleteIds);

            }

            remove(pid);

            log.info("============================= archive the idex for the identifier "+pid);

        } else {

            Identifier obsolete = systemMetadata.getObsoletes();

            if(obsolete != null) {

                removeObsoletesChain(obsolete.getValue(), obsoleteIds);

            }

            //generate index for either add or update.

            insert(pid, systemMetadata, data);

            log.info("============================= insert index for the identifier "+pid);

        }

    }

    private void removeObsoletesChain(String obsoleteId, List<String> obsoleteIdChain) throws SolrServerException, IOException {

        if(obsoleteId != null && !obsoleteId.trim().equals("")) {

            if(obsoleteIdChain == null || obsoleteIdChain.isEmpty()) {

                throw new SolrServerException("SolrIndex.removeObsoletesChain - The obsoletes chain can't be null or empty since the system metadata already has the obsoletes element."); 

            }

            if(!obsoleteIdChain.contains(obsoleteId)) {

                throw new SolrServerException("SolrIndex.removeObsoletesChain - The obsoletes elment in the system metadata is not in the obsoleteId chain"); 

            }

            remove(obsoleteIdChain);

        } else {

            throw new SolrServerException("SolrIndex.removeObsoletesChain - The obsolete id should be null."); 

        }  

    }

    /**

     * Remove all the indexes associated with the pids in the list.

     * @param pidList

     * @throws IOException

     * @throws SolrServerException

     */

    private void remove(List<String> pidList) throws IOException, SolrServerException {

        if(pidList != null) {

            for(String id : pidList) {

                remove(id);

            }

        }

    }

    /**

     * Remove the indexed associated with specified pid.

     * @param pid  the pid which the indexes are associated with

     * @throws IOException

     * @throws SolrServerException

     */

    public void remove(String pid) throws IOException, SolrServerException {

        if(pid != null && !pid.trim().equals("")) {

            solrServer.deleteById(pid);

            solrServer.commit();

        }

    }

    /**

     * Get the solrServer

     * @return

     */

    public SolrServer getSolrServer() {

        return solrServer;

    }

    /**

     * Set the solrServer. 

     * @param solrServer

     */

    public void setSolrServer(SolrServer solrServer) {

        this.solrServer = solrServer;

    }

    /**

     * Get all indexed ids in the solr server. 

     * @return an empty list if there is no index.

     * @throws SolrServerException

     */

    public List<String> getSolrIds() throws SolrServerException {

        List<String> list = new ArrayList<String>();

        SolrQuery query = new SolrQuery(IDQUERY); 

        query.setRows(Integer.MAX_VALUE); 

        query.setFields(ID); 

        QueryResponse response = solrServer.query(query); 

        SolrDocumentList docs = response.getResults();

        if(docs != null) {

            for(SolrDocument doc :docs) {

                String identifier = (String)doc.getFieldValue(ID);

                //System.out.println("======================== "+identifier);

                list.add(identifier);

            }

        }

        return list;

    }

}