/* A default implementation of Queryable.
 * 
 * Copyright (c) 2015 The Regents of the University of California.
 * All rights reserved.
 *
 * '$Author: crawl $'
 * '$Date: 2017-08-23 20:27:50 +0000 (Wed, 23 Aug 2017) $' 
 * '$Revision: 34619 $'
 * 
 * Permission is hereby granted, without written agreement and without
 * license or royalty fees, to use, copy, modify, and distribute this
 * software and its documentation for any purpose, provided that the above
 * copyright notice and the following two paragraphs appear in all copies
 * of this software.
 *
 * IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
 * FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
 * THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
 * PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
 * CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
 * ENHANCEMENTS, OR MODIFICATIONS.
 *
 */
package org.kepler.provenance;

import java.io.IOException;
import java.lang.ref.WeakReference;
import java.util.Date;
import java.util.HashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;

import org.kepler.objectmanager.lsid.KeplerLSID;
import org.kepler.sms.NamedOntClass;
import org.kepler.util.WorkflowRun;
import org.kepler.util.WorkflowRun.type;

import ptolemy.data.StringToken;
import ptolemy.data.Token;
import ptolemy.data.expr.ASTPtRootNode;
import ptolemy.data.expr.ParseTreeEvaluator;
import ptolemy.data.expr.PtParser;
import ptolemy.kernel.util.NamedObj;
import ptolemy.moml.MoMLParser;

/** A default implementation of Queryable. Most methods do nothing
 *  and return null.
 * 
 *  @author Daniel Crawl
 *  @version $Id: DefaultQuery.java 34619 2017-08-23 20:27:50Z crawl $
 */
public abstract class DefaultQuery implements Queryable {

    @Override
    public void close() throws IOException {
        try {
            disconnect();
        } catch (QueryException e) {
            throw new IOException("Error closing query interface.", e);
        }
    }

    @Override
    public void disconnect() throws QueryException {
        // TODO Auto-generated method stub

    }

    @Override
    public List<String> getWorkflows() throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    @Override
    public String getWorkflowName(KeplerLSID lsid) throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    @Override
    public String getWorkflowNameForExecution(KeplerLSID lsid) throws QueryException {
        // TODO
        return null;
    }

    @Override
    public List<Integer> getExecutions() throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    @Override
    public List<KeplerLSID> getExecutionLSIDs() throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    @Override
    public List<Integer> getExecutionsForWorkflow(String workflow)
            throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    @Override
    public Integer getExecutionForExecutionLSID(KeplerLSID runLSID)
            throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    @Override
    public KeplerLSID getExecutionLSIDForExecution(Integer execId)
            throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    @Override
    public List<Integer> getExecutionsForAnnotation(String annotation)
            throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    @Override
    public Date[] getTimestampsForExecution(int execId) throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    @Override
    public String getMoMLForExecution(int execId) throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    @Override
    public String getMoMLForExecution(KeplerLSID lsid) throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    @Override
    public List<String> getMoMLForExecutionLSIDs(List<KeplerLSID> lsids)
            throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    /** Get the workflow object for a execution id. */
    @Override
    public NamedObj getWorkflowForExecution(Integer execId) 
        throws QueryException {

        // sychronizing on the static _executionToWorkflowMap map prevents
        // MoMLParsing from being performed concurrently. MoMLParser is not
        // thread-safe, even using different instances.
        synchronized(_executionToWorkflowMap) {
            NamedObj workflow = null;
            WeakReference<NamedObj> weakWorkflow = _executionToWorkflowMap.get(execId);
            if(weakWorkflow != null) {
                workflow = weakWorkflow.get();
            }
            
            if(workflow == null) { 
                //System.out.println("parsing for " + execId);
                MoMLParser parser = new MoMLParser();
                String momlStr = getMoMLForExecution(execId);                
                try {
                    workflow = parser.parse(momlStr);
                } catch (Exception e) {
                    throw new QueryException("Error parsing workflow MoML.", e);
                }
                _executionToWorkflowMap.put(execId, new WeakReference<NamedObj>(workflow));
            }            
            
            // return a copy of the workflow since the caller may modify
            // the workflow.
            try {
                return (NamedObj) workflow.clone();
            } catch (CloneNotSupportedException e) {
                throw new QueryException("Error cloning workflow.", e);
            }
        }        
    }

    @Override
    public List<Integer> getExecutionsForTimespan(Date start, Date end)
            throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    @Override
    public List<Integer> getExecutionsForWorkflowRuns(String workflowName,
            String userName) throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    @Override
    public List<Integer> getExecutionsForWorkflowRunsAfter(String workflowName,
            String userName, Date after) throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    @Override
    public List<Integer> getExecutionsForWorkflowRuns(String workflowName,
            String userName, Date after, Date before, int execIdAfter,
            int execIdBefore) throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    @Override
    public List<KeplerLSID> getExecutionLSIDsForWorkflowRuns(
            String workflowName, String userName, Date after, Date before,
            int execIdAfter, int execIdBefore) throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    @Override
    public List<Integer> getExecutionsForWorkflowRunsBefore(
            String workflowName, String userName, Date before)
            throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    @Override
    public Integer getLastExecutionForWorkflow(KeplerLSID lsid)
            throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    @Override
    public Integer getLastExecutionForWorkflow(String workflow)
            throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    @Override
    public KeplerLSID getLastExecutionLSIDForWorkflow(String workflow)
            throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    @Override
    public KeplerLSID getLastExecutionLSIDForWorkflow(KeplerLSID lsid)
            throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    @Override
    public String getErrorForExecution(KeplerLSID lsid) throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    @Override
    public boolean isErrorForExecution(KeplerLSID executionLSID)
            throws QueryException {
        // TODO Auto-generated method stub
        return false;
    }

    /** Get an sequence of tokens for an execution.
     *  @param execId the execution id
     *  @param last if true, the sequence starts at the last token created
     *  and goes backwards to the first; otherwise the sequence starts at
     *  the first.
     */
    @Override
    public List<Integer> getTokensForExecution(int execId, boolean last)
        throws QueryException
    {   
        return getTokensForExecution(execId, null, last);
    }

    /** Get an sequence of tokens for an execution.
     *  @param execId the execution id
     *  @param portId the port id. If null, returns the ids of
     *  tokens read in entire execution.
     *  @param last if true, the sequence starts at the last token created
     *  and goes backwards to the first; otherwise the sequence starts at
     *  the first.
     */
    @Override
    public List<Integer> getTokensForExecution(int execId, Integer portId,
            boolean last) throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    /** Get the firing id(s) of the actor(s) that read or wrote a token.
     *  @param tokenId the token id
     *  @param read If true, return the actor(s) firing id(s) that read
     *  the token. Otherwise, return the actor firing that wrote the token.
     */
    @Override
    public List<Integer> getActorFiringForToken(int tokenId, boolean read)
            throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    @Override
    public List<Integer> getTokensForFiring(int fireId, boolean read)
            throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    /** Get the Token. */
    @Override
    public Token getToken(int tokenId) throws QueryException
    {
        Token token = null;
        //get the type
        String type = getTokenType(tokenId);
        //get the value
        String value = getTokenValue(tokenId);
        
        if(_stringTokenValuesHaveSurroundingQuotes()) {
            // if the token is a StringToken, then the value is surrounded
            // by double-quotes. the quotes should be removed from the value
            // otherwise they are in the contents of the new StringToken, which
            // is not identical to the one recorded to provenance.
            if(type.equals(StringToken.class.getName()) && value.length() >= 2) {
                value = value.substring(1, value.length() - 1);
            }
        }

        if(type.equals(_stringTokenClassName)) {
            
            //put it together - requires token to have a string constructor
            try 
            {
                Class<?> clazz = Class.forName(type);
                token = (Token) clazz.getConstructor(String.class).newInstance(value);
            } 
            catch (Exception e) 
            {
                System.err.println("WARNING: Token could not be constructed for type: " +
                        type + ": " + e.getMessage());
                e.printStackTrace();
            }

            
        } else {
            try {
                synchronized(_parserLock) {
                    if (_parser == null) {
                        _parser = new PtParser();
                    }
        
                    if (_parseTreeEvaluator == null) {
                        _parseTreeEvaluator = new ParseTreeEvaluator();
                    }
        
                    ASTPtRootNode parseTree = _parser.generateParseTree(value);
                    token = _parseTreeEvaluator.evaluateParseTree(parseTree);
                }
            } catch (Throwable e) {
                System.err.println("Warning: Token value invalid: " + e.getMessage());
            }
        }
        
        return token;
    }

    
    @Override
    public String getTokenValue(int tokenId) throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    @Override
    public String getTokenType(int tokenId) throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    /** Get the channel that a token was read or written on.
     *  @param tokenId the token id
     *  @param read if true, return the channel the token was read on.
     *  otherwise, return the channel the token was written on.
     *  @param fireId the actor firing id. can be null for writes, but
     *  must be specified for reads.
     *  @return the channel the token was read or written on.
     */
    @Override
    public Integer getChannelForToken(int tokenId, boolean read, Integer fireId)
        throws QueryException {
        // TODO
        return null;
    }

    @Override
    public String getActorName(int fireId) throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    @Override
    public String getActorType(int fireId) throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    @Override
    public Integer getEntityId(String entityName, KeplerLSID lsid)
            throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    @Override
    public Integer getEntityId(String entityName, String workflowName)
            throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    @Override
    public String getEntityType(Integer entityId) throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    @Override
    public Integer getEntityWorkflowId(Integer entityId) throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    @Override
    public Map<String, String> getParameterNameValuesForFiring(int fireId)
            throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    @Override
    public Map<String, String> getParameterNameValuesForExecution(int execId)
            throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    @Override
    public String getParameterValueLatest(String parameter, KeplerLSID lsid)
            throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    @Override
    public String getParameterValueAtTime(Date timestamp, String parameter,
            KeplerLSID lsid) throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    @Override
    public List<Integer> getImmediateDependencies(int tokenId)
            throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    @Override
    public List<byte[]> getAssociatedDataForExecution(int execId,
            Map<String, String> metadataMap, boolean matchAny)
            throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    /** Get any associated keys-values for an execution. */
    @Override
    public Map<String,String> getAssociatedKeysValuesForExecution(int execId)
        throws QueryException {
        // TODO
        return null;
    }

    @Override
    public Map<KeplerLSID, WorkflowRun> getWorkflowRunsForExecutionLSIDs(
            List<KeplerLSID> executions) throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    /** Get workflow runs for a user. */
    @Override
    public List<WorkflowRun> getWorkflowRunsForUser(String user) throws QueryException {
        return new LinkedList<WorkflowRun>();
    }

    @Override
    public List<Integer> getExecutionIdsForTags(String tagsSearchString)
            throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    @Override
    public List<String> getTagsForExecutionId(int execId) throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    @Override
    public String getTypeForTag(String conceptId) {
        // TODO Auto-generated method stub
        return null;
    }

    @Override
    public Map<NamedOntClass, String> getTagClassesForExecutionId(int execId)
            throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    @Override
    public Integer getExecutionForExecutionLSIDWithoutRevision(
            String execLSIDWithoutRevision) throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    @Override
    public Integer getExecutionForOldestReferralExecutionLSIDWithoutRevision(
            String stringWithoutRevision) throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    @Override
    public List<KeplerLSID> getExecutionsForType(type type)
            throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    @Override
    public boolean isImportedExecution(KeplerLSID executionLSID)
            throws QueryException {
        // TODO Auto-generated method stub
        return false;
    }

    @Override
    public List<String> getPortsForActor(KeplerLSID workflow, String actor)
            throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    @Override
    public String getUserForExecution(Integer execId) throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    @Override
    public String getUserForExecution(KeplerLSID execLSID) throws QueryException {
        // TODO Auto-generated method stub
        return null;        
    }

    @Override
    public String getHostIdForExecution(Integer execId) throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    @Override
    public String getOutputRoleToken(int tokenId) throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    @Override
    public String getInputRoleForTokenAndFireId(int tokenId, int fireId)
            throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    @Override
    public Map<String, String> getParameterNameValuesOfSpecificTypeForExecution(
            int execId) throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    @Override
    public Date[] getTimestampsForActorFiring(int fireId) throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    @Override
    public List<Integer> getActorFiringIds(String actorName, Integer wfExecId)
            throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    @Override
    public Map<String, String> getParameterAndPortParameterNameValuesForFiring(
            int fireId) throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }

    @Override
    public List<Integer> getActorFirings(int wfExecId) throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }
    
    /** Get the total execution time for an actor.
    *
    *  @param workflow the workflow LSID. If null, must specify execution id.
    *  @param execLSID the execution id. If null, use the last execution of the workflow.
    *  @param actor the full actor name.
    *  @return the total time execution time of the actor, in milliseconds.
    */
    @Override
    public long getTotalExecutionTimeForActor(KeplerLSID workflow, KeplerLSID execLSID,
        String actor) throws QueryException
    {
        Map<String,Long> map = getExecutionTimesForActor(workflow, execLSID, actor);
        long sum = 0;
        for(Long time : map.values())
        {
            sum += time;
        }
        return sum;
    }
    
    /** Get the execution times for an actor.
    *
    * @param workflow the workflow LSID. If null, must specify execution id.
    * @param execLSID the execution LSID. If null, the last execution of the workflow
    * is used.
    * @param actor the full actor name.
    * @return a map of actor fire id to execution time pairs. if a firing does not
    * have a valid start or stop time, the firing is not included in the result.
    */
    @Override
    public Map<String,Long> getExecutionTimesForActor(KeplerLSID workflow,
            KeplerLSID execLSID, String actor) throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }
    
    /** Get the number of bytes read or written by a port.
    *
    *  @param workflow the workflow LSID. If null, must specify execution id.
    *  @param execId the execution id. If null, the last execution of the workflow
    *  is used.
    *  @param port the full port name.
    *  @param read If true, get the bytes read. Otherwise, get the bytes written.
    *  @return a map of port event id to bytes read/written.
    */
    @Override
    public Map<Integer,Integer> getIOBytesForPort(KeplerLSID workflow, Integer execId,
        String port, boolean read) throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }
    
    /** Get the total number of bytes read or or written by an actor over all its ports.
     *  @param workflow the workflow LSID. If null, specify the execution id.
     *  @param execId the execution id. If null, the last execution of the workflow
     *  is used.
     *  @param actor the full actor name.
     *  @param read If true, get the bytes read. Otherwise, get the bytes written.
     */
    @Override
    public Integer getTotalIOBytesForActor(KeplerLSID workflow, Integer execId, String actor,
        boolean read) throws QueryException
    {
        Integer retval = 0;
        
        if(execId == null)
        {
            execId = _getLastExecutionId(workflow);
        }
        
        List<String> portsList = getPortsForActor(workflow, actor);
        
        for(String port : portsList)
        {
            Map<Integer,Integer> map = getIOBytesForPort(workflow, execId, port, read);
            for(Integer size : map.values())
            {
                retval += size;
            }
        }
        
        return retval;
    }
        
    /*
    @Override
    public List<LinkIO> getLinksIO(KeplerLSID workflow, Integer execId) throws QueryException {
        // TODO Auto-generated method stub
        return null;
    }
    */

    /** Get the timestamp(s) when a token was read. If a token was
     *  never read, this can return null or an empty array.
     */
    @Override
    public Date[] getTimestampsForTokenRead(Integer tokenId) throws QueryException {
        return null;
    }

    /** Get the timestamp when a token was written. */
    @Override
    public Date getTimestampForTokenWrite(Integer tokenId) throws QueryException {
        return null;
    }

    /** Get the last execution id for a workflow. If no execution id found,
     *  throws exception.
     */
    protected Integer _getLastExecutionId(KeplerLSID workflow)
        throws QueryException
    {   
        if(workflow == null)
        {
            throw new QueryException("Must specify either workflow LSID or execution id.");
        }
        
        // get the last execution id for the workflow
        Integer execId = getLastExecutionForWorkflow(workflow);

        if(execId == null)
        {
            throw new QueryException("Could not find last execution for workflow.");
        }
        return execId;
    }

    /** Returns true if getTokenValue() for StringTokens has
     *  surrounding double-quotes. i.e., the value was saved
     *  using StringToken.toString() (which adds double-quotes)
     *  instead of StringToken.stringValue().
     */
    abstract protected boolean _stringTokenValuesHaveSurroundingQuotes();
    
    /** A mapping of execution id to workflow objects. We use weak
     *  references for the workflow objects so that they can be garbage
     *  collected.
     */
    private static Map<Integer,WeakReference<NamedObj>> _executionToWorkflowMap =
            new HashMap<Integer,WeakReference<NamedObj>>();

    private static final Object _parserLock = new Object();
    private ParseTreeEvaluator _parseTreeEvaluator = null;
    private PtParser _parser = null;
    private static final String _stringTokenClassName = StringToken.class.getName();

}