/*==========================================================================*\
 |  $Id: ICalView.java,v 1.1 2010/05/11 14:51:40 aallowat Exp $
 |*-------------------------------------------------------------------------*|
 |  Copyright (C) 2006-2008 Virginia Tech
 |
 |  This file is part of Web-CAT.
 |
 |  Web-CAT is free software; you can redistribute it and/or modify
 |  it under the terms of the GNU Affero General Public License as published
 |  by the Free Software Foundation; either version 3 of the License, or
 |  (at your option) any later version.
 |
 |  Web-CAT 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 Affero General Public License
 |  along with Web-CAT; if not, see <http://www.gnu.org/licenses/>.
\*==========================================================================*/

package org.webcat.grader.actions;

import org.webcat.grader.*;
import com.webobjects.appserver.*;
import com.webobjects.foundation.*;

//-------------------------------------------------------------------------
/**
 * This page generates an ical-compatible list of assignment due dates.
 *
 * @author Stephen Edwards
 * @version $Id: ICalView.java,v 1.1 2010/05/11 14:51:40 aallowat Exp $
 */
public class ICalView
    extends BlueJSubmitterDefinitions
{
    //~ Constructors ..........................................................

    // ----------------------------------------------------------
    /**
     * Creates a new ICalView page.
     *
     * @param context The context for this page
     */
    public ICalView( WOContext context )
    {
        super( context );
    }


    //~ Methods ...............................................................

    // Was using this template for events:
    // ------------------------
//    BEGIN:VEVENT
//    DTSTART:<wo:str value="$startTime" formatter="$formatter"/>
//    DTEND:<wo:str value="$anAssignmentOffering.dueDate" formatter="$formatter"/>
//    SUMMARY:<wo:str value="$anAssignmentOffering.courseOffering.course.deptNumber"/>: <wo:str value="$assignmentName"/>
//    URL:<wo:str value="$application.properties.base.url"/>
//    END:VEVENT


    // ----------------------------------------------------------
    public String mimeType()
    {
        return "text/calendar";
    }


    // ----------------------------------------------------------
    public boolean showAll()
    {
        return true;
    }


    // ----------------------------------------------------------
    public boolean preserveDateDifferences()
    {
        return true;
    }


    // ----------------------------------------------------------
    public int submitterEngine()
    {
        return 0;
    }


    // ----------------------------------------------------------
    public boolean useCRN()
    {
        boolean result = groupByCRN;
        if (!result)
        {
            if (multipleOfferings == null)
            {
                multipleOfferings =
                    new NSMutableDictionary<Assignment, Boolean>();
                for (AssignmentOffering ao : assignmentsToDisplay)
                {
                    if (multipleOfferings.containsKey(ao.assignment()))
                    {
                        multipleOfferings.put(ao.assignment(), Boolean.TRUE);
                    }
                    else
                    {
                        multipleOfferings.put(ao.assignment(), Boolean.FALSE);
                    }
                }
            }
            result = multipleOfferings.get(anAssignmentOffering.assignment());
        }
        return result;
    }


    // ----------------------------------------------------------
    public String submitURLParams()
    {
        String result = "?page=UploadSubmission&";
        if ( groupByCRN )
        {
            result += AssignmentOffering.ID_FORM_KEY + "="
                + anAssignmentOffering.id();
        }
        else
        {
            result += Assignment.ID_FORM_KEY + "="
                + anAssignmentOffering.assignment().id();
        }
        return result;
    }


    // ----------------------------------------------------------
    public NSTimestamp startTime()
    {
        return new NSTimestamp( anAssignmentOffering.dueDate().getTime()
            - 1000 * 60 * 60 );  // subtract one hour
    }


    // ----------------------------------------------------------
    public NSTimestampFormatter formatter()
    {
        if ( formatter == null )
        {
            // This field is initialized lazily, since its time zone
            // settings cannot be initialized in its constructor.
            formatter = new NSTimestampFormatter( "%Y%m%dT%H%M%SZ" );
            formatter.setDefaultFormatTimeZone( NSTimeZone.getGMT() );
            formatter.setDefaultParseTimeZone( NSTimeZone.getGMT() );
        }
        return formatter;
    }


    //~ Instance/static variables .............................................

    private static NSTimestampFormatter formatter;
    private NSMutableDictionary<Assignment, Boolean> multipleOfferings;
}