Metacat

/**

 *

 * 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 javax.xml.xpath.XPathExpressionException;

import org.apache.commons.logging.LogFactory;

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

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

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

    private static final int FOURTH = 3;

    public static final int MAXWAITNUMBER = 180;

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

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

    private IMap<Identifier, SystemMetadata> systemMetadataMap;

    private IMap<Identifier, String> objectPathMap;

    /**

     * Constructor

     * @param solrIndex

     * @param systemMetadataListener

     */

    /**

     * @throws ServiceFailure

     * @throws NotImplemented

     * @throws NotAuthorized

     * @throws InvalidToken

     * @throws InvalidRequest

     * @throws IllegalAccessException

     * @throws InstantiationException

     * @throws ClassNotFoundException

     * @throws SAXException

     * @throws IOException

     * @throws UnsupportedType

     * @throws NotFound

     * @throws XPathExpressionException

        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

     * @throws SAXException

     * @throws IOException

     * @throws UnsupportedType

     * @throws NotFound

     * @throws XPathExpressionException

    /**

     *  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

     * @throws SAXException

     * @throws IOException

     * @throws UnsupportedType

     * @throws NotFound

     * @throws XPathExpressionException

        initObjectPathMap();

        List<String> otherMetacatIds = metacatIds[FIRST];

        List<String> resourceMapIds =  metacatIds[SECOND];

        //List<String> resourceMapDeletedIds = metacatIds[FOURTH];

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

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

            int size = otherMetacatIds.size();

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

            SystemMetadata sysmeta = getSystemMetadata(id);

            latestOtherId = sysmeta.getDateSysMetadataModified();

            int size = otherDeletedMetacatIds.size();

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

            SystemMetadata sysmeta = getSystemMetadata(id);

            latestDeletedOtherIds = sysmeta.getDateSysMetadataModified();

            maxCollection.add(new Long(latestDeletedOtherIds.getTime()));

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

            int size = resourceMapIds.size();

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

            SystemMetadata sysmeta = getSystemMetadata(id);

            latestResourceId = sysmeta.getDateSysMetadataModified();

            int size = resourceMapDeletedIds.size();

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

            SystemMetadata sysmeta = getSystemMetadata(id);

            latestDeletedResourceId = sysmeta.getDateSysMetadataModified();

            maxCollection.add(new Long(latestDeletedResourceId.getTime()));

        if(!maxCollection.isEmpty()) {

            Long max = Collections.max(maxCollection);

            processedDate = new Date(max.longValue());

        }

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

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

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

            for(IndexEvent event : failedEvents) {

            	String id = event.getIdentifier().getValue();

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

                }

            }

        }

        //indexFailedIds(failedResourceMapIds);

        index(failedResourceMapIds);

        } else {

            failedOtherIds = otherMetacatIds;

        }

        if(!failedResourceMapIds.isEmpty()) {

            failedResourceMapIds.addAll(resourceMapIds);

        } else {

            failedResourceMapIds = resourceMapIds;

        //log.info("the resourcemap ids in index_event for reindex =====================================\n "+failedResourceMapIds);

        if(processedDate != null) {

            EventlogFactory.createIndexEventLog().setLastProcessDate(processedDate);

        }

    /*

     */

                String tempDir = System.getProperty("java.io.tmpdir");

                log.info("the temp dir is ===================== "+tempDir);

                    idsForIndex.createNewFile();

                SimpleDateFormat format = new SimpleDateFormat("yyyy.MM.dd G 'at' HH:mm:ss z");

                String dateStr = format.format(date);

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

                dateList.add(dateStr);

                Boolean append = true;

                FileUtils.writeLines(idsForIndex, dateList, append);//write time string

                FileUtils.writeLines(idsForIndex, ids, append);

            } catch (Exception e) {

                log.warn("IndexGenerator.logFile - Couldn't log the ids which will be indexed since - "+e.getMessage());

                if(metacatId != null) {

            }

     * Index those ids which failed in the process (We got them from the EventLog)

     */

            for(IndexEvent event : events) {

                if(event != null) {

                    Identifier identifier = event.getIdentifier();

                    if(identifier != null) {

                        String id = identifier.getValue();

                        if(id != null) {

                            Event action = event.getAction();

                                    generateIndex(id);

                                    EventlogFactory.createIndexEventLog().remove(identifier);

                                } catch (Exception e) {

                                    log.error("IndexGenerator.indexFailedIds - Metacat Index couldn't generate the index for the id - "+id+" because "+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());

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

            // 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 (NotFound e) {

            // TODO Auto-generated catch block

            e.printStackTrace();

        } catch (UnsupportedType 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 (IOException 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 (SAXException 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 (ParserConfigurationException 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());

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

    /*

     *

     * 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[] ids = new List[2];

        ids[SECOND] = resourceMapIds;

        //ids[FOURTH] = resourceMapDeletedIds;

            for(Identifier identifier : metacatIds) {

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

                    idLog.add(identifier.getValue());

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

                            }

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

                            }

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

                            }

                        }

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

                                if(!resourceMapDeletedIds.isEmpty()) {

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

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

                                        resourceMapDeletedPreviousDate = sysDate;//reset resourceMapPreviousDate to the bigger one

                                    } else {

                                        int size = resourceMapDeletedIds.size();//

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

                                    }

                                    resourceMapDeletedPreviousDate = sysDate;//init resourcemapPreviousDate

                                // for all ids

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

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

                                        resourceMapPreviousDate = sysDate;//reset resourceMapPreviousDate to the bigger 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;//init resourcemapPreviousDate

                                }

                                if(!otherDeletedIds.isEmpty()) {

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

                                        otherDeletedIds.add(identifier.getValue());

                                        otherDeletedPreviousDate = sysDate;//reset otherDeletedPreviousDate to the bigger one

                                    } else {

                                        int size = otherDeletedIds.size();

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

                                    }

                                    otherDeletedPreviousDate = sysDate;//init otherDeletedPreviousDate

                                //for all ids

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

                                        otherIds.add(identifier.getValue());

                                        otherPreviousDate = sysDate;//reset otherPreviousDate to the bigger one

                                    } else {

                                        int size = otherIds.size();

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

                                    }

                                } else {

                                    otherIds.add(identifier.getValue());

                                    otherPreviousDate = sysDate;//init otherPreviousDate

                                }

                }

            }

    }

    /*

     */

       return ResourceMapNamespaces.isResourceMap(formatId);

    /*

     * Generate index for the id.

     */

        SystemMetadata sysmeta = getSystemMetadata(id);

        Identifier pid = new Identifier();

        pid.setValue(id);

        solrIndex.update(pid, sysmeta);

    /*

     */

            for(String id :ids) {

                    removeIndex(id);

                } catch (Exception e) {

                    IndexEvent event = new IndexEvent();

                    Identifier pid = new Identifier();

                    pid.setValue(id);

                    event.setIdentifier(pid);

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

                    event.setAction(Event.DELETE);

                    String error = "IndexGenerator.index - Metacat Index couldn't remove the index for the id - "+id+" because "+e.getMessage();

                    event.setDescription(error);

                    try {

                        EventlogFactory.createIndexEventLog().write(event);

                    } catch (Exception ee) {

                        log.error("SolrIndex.insertToIndex - IndexEventLog can't log the index deleting event :"+ee.getMessage());

                    }

                    log.error(error);

                }

        }

    /*

     */

    /*

     */

    private void initSystemMetadataMap() throws FileNotFoundException, ServiceFailure{

        int times = 0;

        if(systemMetadataMap == null) {

    }

    /*

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

        }

    }

    /*

     * Initialize the index queue

     */

    private void initIndexQueue() throws FileNotFoundException, ServiceFailure {

        if(indexQueue == null) {

            indexQueue = DistributedMapsFactory.getIndexQueue();

        }

    }

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

    }