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.FileNotFoundException;

import java.util.ArrayList;

import java.util.List;

import org.apache.commons.logging.Log;

import org.apache.commons.logging.LogFactory;

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

import org.dataone.client.MNode;

import org.dataone.configuration.Settings;

import org.dataone.service.exceptions.InvalidRequest;

import org.dataone.service.exceptions.InvalidToken;

import org.dataone.service.exceptions.NotAuthorized;

import org.dataone.service.exceptions.NotImplemented;

import org.dataone.service.exceptions.ServiceFailure;

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

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

import edu.ucsb.nceas.metacat.index.event.IndexEvent;

 * A class represents the object to generate massive solr indexes.

 * This can happen during an update of Metacat (generating index for all existing documents)

 * or regenerate index for those documents

 * failing to build index during the insert or update.

 *

 * @author tao

 *

 */

    private static final int SECOND =1;

    public static final int MAXWAITNUMBER = 180;

    private static final String MNAPPENDIX = "/d1/mn";

    public static final String MAXATTEMPTSPROPERTYNAME = "index.regenerate.start.maxattempts";

    private static int waitingTime = WAITTIME;

    private static int maxAttempts = MAXWAITNUMBER;

    private IMap<Identifier, SystemMetadata> systemMetadataMap;

    private IMap<Identifier, String> objectPathMap;

    /**

     * Constructor

     * @param solrIndex

     * @param systemMetadataListener

     */

            waitingTime = Settings.getConfiguration().getInt(WAITIMEPOPERTYNAME);

            maxAttempts = Settings.getConfiguration().getInt(MAXATTEMPTSPROPERTYNAME);

        } catch (Exception e) {

            log.warn("IndexGenerator.constructor - couldn't read the waiting time or maxattempts from the metacat.properties file since : "+e.getMessage()+". Default values will be used");

            waitingTime = WAITTIME;

            maxAttempts = MAXWAITNUMBER;

        }

    /**

     * Build the index for all documents in Metacat without overwriting.

     * @throws SolrServerException

     * @throws ServiceFailure

     * @throws NotImplemented

     * @throws NotAuthorized

     * @throws InvalidToken

     * @throws InvalidRequest

     * @throws IllegalAccessException

     * @throws InstantiationException

     * @throws ClassNotFoundException

                            NotImplemented, ServiceFailure, SolrServerException, FileNotFoundException, ClassNotFoundException, InstantiationException, IllegalAccessException, IndexEventLogException {

        indexAll(force);

    /**

     * @throws ServiceFailure

     * @throws NotImplemented

     * @throws NotAuthorized

     * @throws InvalidToken

     * @throws InvalidRequest

     * @throws IllegalAccessException

     * @throws InstantiationException

     * @throws ClassNotFoundException

                NotAuthorized, NotImplemented, ServiceFailure, SolrServerException, FileNotFoundException, ClassNotFoundException, InstantiationException, IllegalAccessException, IndexEventLogException {

        Date until = null;

    /**

     * Build the index for the docs which have been modified since the specified date.

     * @param since

     * @throws SolrServerException

     * @throws ServiceFailure

     * @throws NotImplemented

     * @throws NotAuthorized

     * @throws InvalidToken

     * @throws InvalidRequest

     * @throws IllegalAccessException

     * @throws InstantiationException

     * @throws ClassNotFoundException

                    NotAuthorized, NotImplemented, ServiceFailure, SolrServerException, FileNotFoundException, ClassNotFoundException, InstantiationException, IllegalAccessException, IndexEventLogException {

    /**

     *  Build the index for the docs which have been modified between the specified date.s

     * @param since

     * @param until

     * @throws SolrServerException

     * @throws ServiceFailure

     * @throws NotImplemented

     * @throws NotAuthorized

     * @throws InvalidToken

     * @throws InvalidRequest

     * @throws IllegalAccessException

     * @throws InstantiationException

     * @throws ClassNotFoundException

                                                InvalidToken, NotAuthorized, NotImplemented, ServiceFailure, FileNotFoundException, ClassNotFoundException, InstantiationException, IllegalAccessException, IndexEventLogException {

        Date processedDate = null;

        initObjectPathMap();

        List<String> otherMetacatIds = metacatIds[FIRST];

        List<String> resourceMapIds =  metacatIds[SECOND];

        //figure out the procesedDate by comparing the last element of otherMetacatIds and resourceMapIds.

        Date latestOtherId = null;

        if (otherMetacatIds != null && !otherMetacatIds.isEmpty()) {

            int size = otherMetacatIds.size();

            String id = otherMetacatIds.get(size-1);

            SystemMetadata sysmeta = getSystemMetadata(id);

            latestOtherId = sysmeta.getDateSysMetadataModified();

        if (resourceMapIds != null && !resourceMapIds.isEmpty()) {

            int size = resourceMapIds.size();

            String id = resourceMapIds.get(size-1);

            SystemMetadata sysmeta = getSystemMetadata(id);

            latestResourceId = sysmeta.getDateSysMetadataModified();

        }

        if(latestOtherId != null && latestResourceId != null && latestOtherId.getTime() > latestResourceId.getTime()) {

            processedDate = latestOtherId;

        } else if (latestOtherId != null && latestResourceId != null && latestOtherId.getTime()  <= latestResourceId.getTime()) {

            processedDate = latestResourceId;

        } else if (latestOtherId == null && latestResourceId != null) {

            processedDate = latestResourceId;

        } else if (latestOtherId != null && latestResourceId == null) {

            processedDate = latestOtherId;

        }

        //add the failedPids

        List<String> failedPids = EventlogFactory.createIndexEventLog().getFailedPids();

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

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

        if(failedPids != null) {

            for(String id : failedPids) {

                SystemMetadata sysmeta = getSystemMetadata(id);

                if(sysmeta != null && !sysmeta.getArchived()) {

                    ObjectFormatIdentifier formatId =sysmeta.getFormatId();

                    if(formatId != null && formatId.getValue() != null && resourceMapNamespaces != null && isResourceMap(formatId)) {

                        failedResourceMapIds.add(id);

                    } else {

                        failedOtherIds.add(id);

                    }

                }

            }

        }

        if(!failedOtherIds.isEmpty()) {

            failedOtherIds.addAll(otherMetacatIds);

        } else {

            failedOtherIds = otherMetacatIds;

        }

        if(!failedResourceMapIds.isEmpty()) {

            failedResourceMapIds.addAll(resourceMapIds);

        } else {

            failedResourceMapIds = resourceMapIds;

        }

        log.info("the metacat ids (exception resource map -----------------------------"+failedOtherIds);

        log.info("the metacat resroucemap ids -----------------------------"+failedResourceMapIds);

        index(failedOtherIds);

        index(failedResourceMapIds);

        if(processedDate != null) {

            EventlogFactory.createIndexEventLog().setLastProcessDate(processedDate);

        }

    /*

                if(metacatId != null) {

                        try {

                            generateIndex(metacatId);

                        } catch (Exception e) {

                            log.error("IndexGenerator.index - Metacat Index couldn't generate the index for the id - "+metacatId+" because "+e.getMessage());

                        }

            }

        event.setType(IndexEvent.STARTTIMEDINDEX);

        event.setDescription("Start the timed index job");

        } catch (Exception e) {

            log.error("IndexGenerator.run - IndexEventLog can't log the timed indexing start event :"+e.getMessage());

            index(since);

            // TODO Auto-generated catch block

            //e.printStackTrace();

            log.error("IndexGenerator.run - Metadata-Index couldn't generate indexes for those documents which haven't been indexed : "+e.getMessage());

        } catch (InvalidToken e) {

            // TODO Auto-generated catch block

            //e.printStackTrace();

            log.error("IndexGenerator.run - Metadata-Index couldn't generate indexes for those documents which haven't been indexed : "+e.getMessage());

        } catch (NotAuthorized e) {

            // TODO Auto-generated catch block

            //e.printStackTrace();

        } catch (NotImplemented e) {

            // TODO Auto-generated catch block

            //e.printStackTrace();

            log.error("IndexGenerator.run - Metadata-Index couldn't generate indexes for those documents which haven't been indexed : "+e.getMessage());

        } catch (ServiceFailure e) {

            // TODO Auto-generated catch block

            //e.printStackTrace();

            log.error("IndexGenerator.run - Metadata-Index couldn't generate indexes for those documents which haven't been indexed : "+e.getMessage());

        } catch (SolrServerException e) {

            // TODO Auto-generated catch block

            //e.printStackTrace();

            log.error("IndexGenerator.run - Metadata-Index couldn't generate indexes for those documents which haven't been indexed : "+e.getMessage());

            log.error("IndexGenerator.run - Metadata-Index couldn't generate indexes for those documents which haven't been indexed : "+e.getMessage());

        event.setDescription("Finish the timed index job");

        try {

            EventlogFactory.createIndexEventLog().write(event);

        } catch (Exception e) {

            log.error("IndexGenerator.run - IndexEventLog can't log the timed indexing finish event :"+e.getMessage());

            // TODO Auto-generated catch block

            log.error("IndexGenerator.run - Metadata-Index couldn't generate indexes for those documents which haven't been indexed : "+e.getMessage());

        } catch (InstantiationException e) {

            // TODO Auto-generated catch block

            log.error("IndexGenerator.run - Metadata-Index couldn't generate indexes for those documents which haven't been indexed : "+e.getMessage());

        } catch (IllegalAccessException e) {

            // TODO Auto-generated catch block

            log.error("IndexGenerator.run - Metadata-Index couldn't generate indexes for those documents which haven't been indexed : "+e.getMessage());

        } catch (IndexEventLogException e) {

            // TODO Auto-generated catch block

            log.error("IndexGenerator.run - Metadata-Index couldn't generate indexes for those documents which haven't been indexed : "+e.getMessage());

        }

     * Get the indexed ids list from the solr server.

     * An empty list will be returned if there is no ids.

     */

    private List<String> getSolrDocIds() throws SolrServerException {

        List<String> ids = solrIndex.getSolrIds();

        return ids;

    }

    /*

     *

     * If since and util are null, it will return all of them.

     * The last element in the each list has the latest SystemMetadata modification date. But they are not sorted.

                        InvalidToken, NotAuthorized, NotImplemented, ServiceFailure, FileNotFoundException {

        List<String> resourceMapIds = new ArrayList();

        List<String> otherIds = new ArrayList();

        List[] ids = new List[2];

        ids[FIRST]= otherIds;

        ids[SECOND] = resourceMapIds;

        Date resourceMapPreviousDate = null;

            for(Identifier identifier : metacatIds) {

                if(identifier != null && identifier.getValue() != null && !identifier.getValue().equals("")) {

                    SystemMetadata sysmeta = getSystemMetadata(identifier.getValue());

                    if(sysmeta != null && !sysmeta.getArchived()) {

                        ObjectFormatIdentifier formatId =sysmeta.getFormatId();

                        //System.out.println("the object format id is "+formatId.getValue());

                        //System.out.println("the ============ resourcMapNamespaces"+resourceMapNamespaces);

                        boolean correctTimeRange = false;

                        Date sysDate = sysmeta.getDateSysMetadataModified();

                        if(since == null && until == null) {

                            correctTimeRange = true;

                        } else if (since != null && until == null) {

                            if(sysDate.getTime() >= since.getTime()) {

                                correctTimeRange = true;

                            }

                        } else if (since == null && until != null) {

                            if(sysDate.getTime() <= until.getTime()) {

                                correctTimeRange = true;

                            }

                        } else if (since != null && until != null) {

                            if(sysDate.getTime() >= since.getTime() && sysDate.getTime() <= until.getTime()) {

                                correctTimeRange = true;

                            }

                        }

                        if(correctTimeRange && formatId != null && formatId.getValue() != null && resourceMapNamespaces != null && isResourceMap(formatId)) {

                            if(!resourceMapIds.isEmpty()) {

                                if(sysDate.getTime() > resourceMapPreviousDate.getTime()) {

                                    resourceMapIds.add(identifier.getValue());//append to the end of the list if current is later than the previous one

                                } else {

                                    int size = resourceMapIds.size();//

                                    resourceMapIds.add(size -1, identifier.getValue());//keep the previous one at the end of the list.

                                }

                            } else {

                                resourceMapIds.add(identifier.getValue());

                            }

                            resourceMapPreviousDate = sysDate;

                                if(sysDate.getTime() > otherPreviousDate.getTime()) {

                                    otherIds.add(identifier.getValue());

                                    otherIds.add(size-1, identifier.getValue());

                                otherIds.add(identifier.getValue());

                }

            }

    }

    /*

     */

        if(formatId != null && resourceMapNamespaces != null) {

            for(String namespace : resourceMapNamespaces) {

                if(namespace != null && formatId.getValue() != null && !formatId.getValue().trim().equals("") && formatId.getValue().equals(namespace)) {

                    isResourceMap = true;

                    break;

                }

            }

        }

        return isResourceMap;

    }

    /*

     * Generate index for the id.

     */

    private void generateIndex(String id) throws Exception {

        if(id != null)  {

                //only update none-archived id.

                if(sysmeta != null && !sysmeta.getArchived()) {

                        InputStream data = getDataObject(id);

                        solrIndex.update(id, obsoleteChain, sysmeta, data);

                    throw new Exception("IndexGenerator.generate - there is no found SystemMetadata associated with the id "+id);

                }

        }

    }

    /*

     * Initialize the system metadata map

     */

    private void initSystemMetadataMap() throws FileNotFoundException, ServiceFailure{

        int times = 0;

        if(systemMetadataMap == null) {

            /*while(true) {

                    systemMetadataMap = DistributedMapsFactory.getSystemMetadataMap();

                    break;

                } catch (FileNotFoundException e) {

                    throw e;

                } catch (ServiceFailure e) {

                    } else {

                }

                times++;

    }

    /*

     * We should call this method after calling initSystemMetadataMap since this method doesn't have the mechanism to wait the readiness of the hazelcast service

     */

    private void initObjectPathMap() throws FileNotFoundException, ServiceFailure {

        if(objectPathMap == null) {

            objectPathMap = DistributedMapsFactory.getObjectPathMap();

        }

    }

    /**

     * Get an InputStream as the data object for the specific pid.

     * @param pid

     * @return

     * @throws FileNotFoundException

     */

    private InputStream getDataObject(String pid) throws FileNotFoundException {

        Identifier identifier = new Identifier();

        identifier.setValue(pid);

        String objectPath = objectPathMap.get(identifier);

        InputStream data = null;

        data = new FileInputStream(objectPath);

        return data;

    }

    /**

     * Get the SystemMetadata for the specified id from the distributed Map.

     * The null maybe is returned if there is no system metadata found.

     * @param id  the specified id.

     * @return the SystemMetadata associated with the id.

     */

    private SystemMetadata getSystemMetadata(String id) {

        SystemMetadata metadata = null;

        if(systemMetadataMap != null && id != null) {

            Identifier identifier = new Identifier();

            identifier.setValue(id);

            metadata = systemMetadataMap.get(identifier);

        }

        return metadata;

    }

    /**

     * Get the obsoletes chain of the specified id. The returned list doesn't include

     * the specified id itself. The newer version has the lower index number in the list.

     * Empty list will be returned if there is no document to be obsoleted by this id.

     * @param id

     * @return

     */

    private List<String> getObsoletes(String id) {

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

        while (id != null) {

            SystemMetadata metadata = getSystemMetadata(id);

            id = null;//set it to be null in order to stop the while loop if the id can't be assinged to a new value in the following code.

            if(metadata != null) {

                Identifier identifier = metadata.getObsoletes();

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

                    obsoletes.add(identifier.getValue());

                    id = identifier.getValue();

                }

            }

        }

        return obsoletes;

    }

    /**

     * Overwrite and do nothing

     */

    public boolean cancel() {

        return true;

    }