/*
 * Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
 * All rights reserved.
 * This component and the accompanying materials are made available
 * under the terms of "Eclipse Public License v1.0"
 * which accompanies this distribution, and is available
 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
 *
 * Initial Contributors:
 * Nokia Corporation - initial contribution.
 *
 * Contributors:
 *
 * Description:  This class has been implemented for playing the GIF animation
 * Earlier implementation were dependent on native API, but now AnimationPlayer
 * will be not use any native code, and all the implementation here is using eswt API
 *
 */

package com.nokia.microedition.media.animation;

import java.io.IOException;
import javax.microedition.io.Connection;
import javax.microedition.io.HttpConnection;

import javax.microedition.media.MediaException;
import javax.microedition.media.protocol.DataSource;

import org.eclipse.swt.SWTException;

import com.nokia.microedition.media.InternalPlayer;
import com.nokia.microedition.media.PlugIn;
import com.nokia.mj.impl.utils.Logger;

/**
 * This class is used for playing GIF image animation. This class also
 * implements PlugIn interface which is used from ManagerImpl.
 * Entire Animation playing is written using eSWT API.
 * There is no call to native.
 */
public class AnimationPlayerFactory implements PlugIn
{

    // Used to recognize supported locators.
    // private static final String ANIMATION_FILE_EXTENSION = ".gif";
    // Used to get supported protocols and content type.
    private static final String ANIMATION_CONTENT_TYPE = "image/gif";
    private static final String ANIMATION_HTTP_PROTOCOL = "http";
    private static final String ANIMATION_HTTPS_PROTOCOL = "https";
    private static final String ANIMATION_FILE_PROTOCOL = "file";
    private static final String CONTENT_TYPE_HEADER = "Content-Type";

    /**
     * From PlugIn
     */
    public InternalPlayer createPlayer(DataSource aDataSource)
    throws MediaException, IOException
    {
        final String DEBUG_STR="AnimationPlayerFactory::createPlayer()";
        Logger.LOG(Logger.EJavaMMAPI, Logger.EInfo,DEBUG_STR+"+");
        InternalPlayer player = null;
        String contentType = aDataSource.getContentType();
        // There is no difference in if and else block
        // in first if block only checking if the content type is available
        // Player is being created in the same way

        // First try to create player from content type
        if (contentType != null)
        {
            if (contentType.equals(ANIMATION_CONTENT_TYPE))
            {
                player = new AnimationPlayer(aDataSource);
            }
        } //Since it was not possible to identify the player from content type, identify it from it's header
        else
        {
            // This case is for locator for "http://" protocol
            // get the httpconnection object, and get the content-type header
            // if the content-type header matches to "image/gif" then invoke animation player.
            try
            {
                Connection con = aDataSource.getConnection();
                HttpConnection httpcon = (HttpConnection) con;

                if (con != null)
                {
                    String type = httpcon.getHeaderField(CONTENT_TYPE_HEADER);
                    if (type != null)
                    {
                        if (type.equalsIgnoreCase(ANIMATION_CONTENT_TYPE))
                        {
                            Logger.LOG(Logger.EJavaMMAPI, Logger.EInfo,"AnimationPlayerplayerfactory::createPlayer() content type is mage/gif");
                            player = new AnimationPlayer(aDataSource);
                        }
                    }
                }
            }
            catch (SWTException e)
            {
                // Simply ignore the exception
                //e.printStackTrace();
            }
        }
        Logger.LOG(Logger.EJavaMMAPI, Logger.EInfo,DEBUG_STR+"-");
        return player;
    }

    /**
     * @param locator, path of the GIF file.
     * @return InternalPlayer object
     * @throws IOException if it is not possible to read the file from location specified
     */
    public InternalPlayer createPlayer(String locator) throws IOException, MediaException
    {
        final String DEBUG_STR="AnimationPlayerFactory::createPlayer(String locator )";
        Logger.LOG(Logger.EJavaMMAPI, Logger.EInfo,DEBUG_STR+"+");
        InternalPlayer player = null;
        try
        {
            player = new AnimationPlayer(locator);
        }
        catch (SWTException e)
        {
            Logger.LOG(Logger.EJavaMMAPI, Logger.EInfo,DEBUG_STR+" SWTException thrown "+e);
            e.printStackTrace();
            if (e.throwable instanceof java.io.IOException)
            {
                // TODO remove hardcoding for checking whether it is permission
                // related exceptioon
                if (e.getCause().toString().indexOf("Permission") != -1)
                    // TODO Copied the exception message from
                    throw new SecurityException(
                        "Application not authorized to access the restricted API");
                // For all other remaining IOException throw it as it is
                else
                    // if
                    // (e.getCause().toString().indexOf((IOException.class.getName()))!=-1)
                    throw new IOException();
            }
            // if exception is due to any other reason, just ignore it
        }
        Logger.LOG(Logger.EJavaMMAPI, Logger.EInfo,DEBUG_STR+"-");
        return player;
    }


    /**
     * From PlugIn
     */
    public String[] getSupportedContentTypes(String aProtocol)
    {
        //if aProtocol is not supported, we need to return the string array of zero length
        String[] types = new String[0];
        if (aProtocol == null || aProtocol.equals(ANIMATION_HTTP_PROTOCOL)
                || aProtocol.equals(ANIMATION_HTTPS_PROTOCOL)
                || aProtocol.equals(ANIMATION_FILE_PROTOCOL))
        {
            types = new String[1];
            types[0] = ANIMATION_CONTENT_TYPE;
        }
        return types;
    }

    /**
     * From PlugIn
     */
    public String[] getSupportedProtocols(String aContentType)
    {
        // if aContentType is not supported, we need to return the string array of zero length
        String[] protocols = new String[0];
        if ((aContentType == null)
                || aContentType.equals(ANIMATION_CONTENT_TYPE))
        {
            protocols = new String[3];
            protocols[0] = ANIMATION_HTTP_PROTOCOL;
            protocols[1] = ANIMATION_HTTPS_PROTOCOL;
            protocols[2] = ANIMATION_FILE_PROTOCOL;
        }
        // else empty array is returned
        return protocols;
    }

    /**
     * From PlugIn. Empty implementation.
     */
    public void preparePlayer(InternalPlayer aPlayer) throws MediaException
    {

    }
}