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

import java.io.FileNotFoundException;

import java.io.InputStream;

import java.util.ArrayList;

import java.util.Calendar;

import java.util.Date;

import java.util.List;

import java.util.TimerTask;

import java.util.Vector;

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

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

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

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

import com.hazelcast.core.IMap;

import com.hazelcast.core.ISet;

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

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

 *

 */

public class IndexGenerator extends TimerTask {

    private static final int FIRST =0;

    private static final int SECOND =1;

    public static final int WAITTIME = 10000;

    public static final int MAXWAITNUMBER = 180;

    private static final String HTTP = "http://";

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

    private static final String RESOURCEMAPPROPERYNAME = "index.resourcemap.namespace";

    public static final String WAITIMEPOPERTYNAME = "index.regenerate.start.waitingtime";

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

    private static int waitingTime = WAITTIME;

    private static int maxAttempts = MAXWAITNUMBER;

    private SolrIndex solrIndex = null;

    //private SystemMetadataEventListener systemMetadataListener = null;

    private IMap<Identifier, SystemMetadata> systemMetadataMap;

    private IMap<Identifier, String> objectPathMap;

    private Log log = LogFactory.getLog(IndexGenerator.class);

    //private MNode mNode = null;

    private static List<String> resourceMapNamespaces = null;

    /**

     * Constructor

     * @param solrIndex

     * @param systemMetadataListener

     */

    public IndexGenerator(SolrIndex solrIndex) {

        this.solrIndex = solrIndex;

        resourceMapNamespaces = Settings.getConfiguration().getList(RESOURCEMAPPROPERYNAME);

        //this.systemMetadataListener = systemMetadataListener;

        //this.mNode = new MNode(buildMNBaseURL());

        try {

            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 

     */

    public void indexAll() throws InvalidRequest, InvalidToken, NotAuthorized, 

                            NotImplemented, ServiceFailure, SolrServerException, FileNotFoundException {

        boolean force = false;

        indexAll(force);

    }

    /**

     * Build the index for all documents. If force is true, the existed index for documents

     * will be overwritten. 

     * @param force

     * @throws SolrServerException 

     * @throws ServiceFailure 

     * @throws NotImplemented 

     * @throws NotAuthorized 

     * @throws InvalidToken 

     * @throws InvalidRequest 

     */

    public void indexAll(boolean force) throws InvalidRequest, InvalidToken,

                NotAuthorized, NotImplemented, ServiceFailure, SolrServerException, FileNotFoundException {

        Date since = null;

        Date until = null;

        index(since, until, force);

    }

    /**

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

     * @param since

     * @param force 

     * @throws SolrServerException 

     * @throws ServiceFailure 

     * @throws NotImplemented 

     * @throws NotAuthorized 

     * @throws InvalidToken 

     * @throws InvalidRequest 

     */

    public void index(Date since, boolean force) throws InvalidRequest, InvalidToken, 

                    NotAuthorized, NotImplemented, ServiceFailure, SolrServerException, FileNotFoundException {

        Date until = null;

        index(since, until, force);

    }

    /**

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

     * @param since

     * @param until

     * @param force

     * @throws SolrServerException 

     * @throws ServiceFailure 

     * @throws NotImplemented 

     * @throws NotAuthorized 

     * @throws InvalidToken 

     * @throws InvalidRequest 

     * @throws FileNotFoundException 

     */

    public void index(Date since, Date until, boolean force) throws SolrServerException, InvalidRequest, 

                                                InvalidToken, NotAuthorized, NotImplemented, ServiceFailure, FileNotFoundException {

        List<String> solrIds = null;

        initSystemMetadataMap();

        initObjectPathMap();

        List[] allMetacatIds = getMetacatIds(since, until);

        List<String> otherMetacatIds = allMetacatIds[FIRST];

        List<String> resourceMapIds = allMetacatIds[SECOND];

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

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

        if(!force) {

            solrIds = getSolrDocIds();

        }

        log.info("the solr ids -----------------------------"+solrIds);

        index(otherMetacatIds, solrIds, force);

        index(resourceMapIds, solrIds, force);

    }

    /*

     * Doing index when it is necessary when compare metacatids and solrids.

     */

    private void index(List<String> metacatIds, List<String>solrIds, boolean force) {

        if(metacatIds != null) {

            for(String metacatId : metacatIds) {

                if(metacatId != null) {

                    boolean buildIndex = true;

                    if(!force && solrIds != null && solrIds.contains(metacatId)) {

                        //solr already indexs the id and we don't force it to rebuild it, so set the buildIndex to be false

                        buildIndex = false;

                    }

                    if(buildIndex) {

                        try {

                            generateIndex(metacatId);

                        } catch (Exception e) {

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

                        }

                    }

                }

            }

        }

    }

    public void run() {

        IndexEvent event = new IndexEvent();

        event.setDate(Calendar.getInstance().getTime());

        event.setType(IndexEvent.STARTTIMEDINDEX);

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

        try {

            EventlogFactory.createIndexEventLog().write(event);

        } catch (Exception e) {

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

        }

        try {

            indexAll();

        } catch (InvalidRequest 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 (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());

        } catch (FileNotFoundException e) {

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

        }

        event.setDate(Calendar.getInstance().getTime());

        event.setType(IndexEvent.FINISHTIMEDINDEX);

        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());

        }

    }

    /*

     * 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;

    }

    /*

     * Get an array of the list of ids of the metacat. If since and util are null, it will return all of them.

     * The first element of the list is the ids except the resource map. The second elements of the list is the ids of the resource map.

     * The reason to split them is when we index the resource map, we need the index of the document in the resource map ready.

     */

    private List[] getMetacatIds(Date since, Date until) throws InvalidRequest, 

                        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;

        ISet<Identifier> metacatIds = DistributedMapsFactory.getIdentifiersSet();

        if(metacatIds != 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)) {

                            resourceMapIds.add(identifier.getValue());

                        } else {

                            otherIds.add(identifier.getValue());

                        }

                    }

                }

            }

        }

        /*if(objects != null) {

            List<ObjectInfo> objectInfoList = objects.getObjectInfoList();

            if(objectInfoList != null) {

                for(ObjectInfo info : objectInfoList) {

                    if(info != null) {

                        Identifier identifier = info.getIdentifier();

                        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);

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

                                    resourceMapIds.add(identifier.getValue());

                                } else {

                                    otherIds.add(identifier.getValue());

                                }

                            }

                            //ids.add(identifier.getValue());

                        }

                    }

                }

            }

        }*/

        return ids;

    }

    /*

     * If the specified ObjectFormatIdentifier is a resrouce map namespace.

     */

    public static boolean isResourceMap(ObjectFormatIdentifier formatId) {

        boolean isResourceMap = false;

        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)  {

                SystemMetadata sysmeta = getSystemMetadata(id);

                //only update none-archived id.

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

                        InputStream data = getDataObject(id);

                        Identifier obsolete = sysmeta.getObsoletes();

                        List<String> obsoleteChain = null;

                        if(obsolete != null) {

                            obsoleteChain = getObsoletes(id);

                        } 

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

                } else {

                    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) {

            systemMetadataMap = DistributedMapsFactory.getSystemMetadataMap();

            /*while(true) {

                try {

                    systemMetadataMap = DistributedMapsFactory.getSystemMetadataMap();

                    break;

                } catch (FileNotFoundException e) {

                    throw e;

                } catch (ServiceFailure e) {

                    if(times <= maxAttempts) {

                        log.warn("IndexGenerator.initSystemMetadataMap - the hazelcast service is not ready : "

                                         +e.getMessage()+"\nWe will try to access it "+waitingTime/1000+" seconds later ");

                        try {

                            Thread.sleep(waitingTime);

                        } catch (Exception ee) {

                            log.warn("IndexGenerator.initSystemMetadataMap - the thread can't sleep for "+waitingTime/1000+" seconds to wait the hazelcast service");

                        }

                    } else {

                        throw new ServiceFailure("0000", "IndexGenerator.initSystemMetadataMap - the hazelcast service is not ready even though Metacat-index wailted for "+maxAttempts*waitingTime/1000+" seconds. We can't get the system metadata from it and the building index can't happen this time");

                    }

                }

                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;

    }

}