icalparser.java

本系统有十分强大的功能

/*******************************************************************************
 * ***** BEGIN LICENSE BLOCK Version: MPL 1.1
 * 
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with the
 * License. You may obtain a copy of the License at http://www.mozilla.org/MPL/
 * 
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for
 * the specific language governing rights and limitations under the License.
 * 
 * The Original Code is the OpenCustomer CRM.
 * 
 * The Initial Developer of the Original Code is Thomas Bader (Bader & Jene
 * Software-Ingenieurb黵o). Portions created by the Initial Developer are
 * Copyright (C) 2005 the Initial Developer. All Rights Reserved.
 * 
 * Contributor(s): Thomas Bader <[e-mail]>
 *                 Felix Breske <[e-mail]>
 * 
 * ***** END LICENSE BLOCK *****
 */

package org.opencustomer.connector.ical;

import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.text.ParseException;
import java.util.ArrayList;
import java.util.GregorianCalendar;
import java.util.List;

import net.fortuna.ical4j.data.CalendarBuilder;
import net.fortuna.ical4j.data.CalendarOutputter;
import net.fortuna.ical4j.data.ParserException;
import net.fortuna.ical4j.model.Calendar;
import net.fortuna.ical4j.model.Component;
import net.fortuna.ical4j.model.Date;
import net.fortuna.ical4j.model.DateTime;
import net.fortuna.ical4j.model.Property;
import net.fortuna.ical4j.model.Recur;
import net.fortuna.ical4j.model.ValidationException;
import net.fortuna.ical4j.model.WeekDay;
import net.fortuna.ical4j.model.component.VEvent;
import net.fortuna.ical4j.model.parameter.Value;
import net.fortuna.ical4j.model.property.CalScale;
import net.fortuna.ical4j.model.property.Created;
import net.fortuna.ical4j.model.property.Description;
import net.fortuna.ical4j.model.property.DtEnd;
import net.fortuna.ical4j.model.property.DtStamp;
import net.fortuna.ical4j.model.property.DtStart;
import net.fortuna.ical4j.model.property.LastModified;
import net.fortuna.ical4j.model.property.Method;
import net.fortuna.ical4j.model.property.ProdId;
import net.fortuna.ical4j.model.property.RRule;
import net.fortuna.ical4j.model.property.Summary;
import net.fortuna.ical4j.model.property.Transp;
import net.fortuna.ical4j.model.property.Uid;
import net.fortuna.ical4j.model.property.Version;
import net.fortuna.ical4j.model.property.XProperty;
import net.fortuna.ical4j.util.CompatibilityHints;

import org.apache.log4j.Logger;
import org.opencustomer.db.vo.calendar.CalendarVO;
import org.opencustomer.db.vo.calendar.EventCalendarVO;
import org.opencustomer.db.vo.calendar.EventVO;
import org.opencustomer.db.vo.calendar.EventVO.RecurrenceInMonth;
import org.opencustomer.db.vo.calendar.EventVO.RecurrenceInWeek;
import org.opencustomer.db.vo.calendar.EventVO.RecurrenceType;
import org.opencustomer.db.vo.calendar.EventVO.RecurrenceUnit;

/**
 * The class IcalParser generates iCalendar files out of OpenCustomer EventVOs, or EventVO out of iCalendar files.
 * @author fbreske
 *
 */

public class IcalParser
{
    private static Logger log = Logger.getLogger(IcalParser.class);
    
    private static IcalParser INSTANCE = new IcalParser();
    
    public static IcalParser getInstance()
    {
        return INSTANCE;
    }
    
    /**
     * Generate an iCalendar file out of events, and writes the iCalendar file to the Output Stream.
     * @param events List of EventVO
     * @param out OutputStream for the iCalendar file
     * @throws IOException
     * @throws ValidationException
     * @throws ParseException 
     * @throws IOException the OutoutStream cannot be written
     */
    public void toIcal(List<EventVO> events, OutputStream out) throws ValidationException, ParseException, IOException
    {
        Calendar icalendar = new Calendar();
        icalendar.getProperties().add(new ProdId("-//OpenCustomer 0.3.0//iCal4j 1.0//DE"));
        icalendar.getProperties().add(Version.VERSION_2_0);
        icalendar.getProperties().add(CalScale.GREGORIAN);
        icalendar.getProperties().add(Method.PUBLISH);
        List<VEvent> vevents = new ArrayList<VEvent>();
        int i = 0;
        for(EventVO event : events)
        {
            VEvent vevent = new VEvent();
            if(!event.isAllDay()){
                vevent.getProperties().add(new DtStart(new DateTime(event.getStartDate())));
                vevent.getProperties().add(new DtEnd(new DateTime(event.getEndDate().getTime())));
            }
            else
            {
                vevent.getProperties().add(new DtStart(new Date(event.getStartDate())));
                vevent.getProperties().getProperty(Property.DTSTART).getParameters().add(Value.DATE);
                vevent.getProperties().add(new DtEnd(new Date(event.getEndDate().getTime())));
                vevent.getProperties().getProperty(Property.DTEND).getParameters().add(Value.DATE);
            }
            
            if(event.isOccupied())
                vevent.getProperties().add(new Transp("OPAQUE"));
            else
                vevent.getProperties().add(new Transp("TRANSPARENT"));
            vevent.getProperties().add(new Summary(event.getTitle()));
            vevent.getProperties().add(new Created(new DateTime(event.getCreateDate())));
            vevent.getProperties().add(new DtStamp(new DateTime(event.getModifyDate())));
            vevent.getProperties().add(new LastModified(new DateTime(event.getModifyDate())));
            vevent.getProperties().add(new Description(event.getDescription()));
            vevent.getProperties().add(new Uid(event.getId().toString() + "@opencustomer"));
            vevent.getProperties().add(new XProperty("X-OC-ID",event.getId().toString()));
            if(event.getRecurrenceType() != EventVO.RecurrenceType.NONE)
                vevent.getProperties().add(getRRule(event));
            vevents.add(vevent);
        }
        icalendar.getComponents().addAll(vevents);
        CalendarOutputter calout = new CalendarOutputter();
        if(!vevents.isEmpty()) // no calendar output if there is no component
            calout.output(icalendar,out);
    }
    
    /**
     * Generates a list of EventsVO out of an iCalendar file.
     * @param ical the InputStream of the iCalendar file
     * @return list of EventVO out of the iCalendar file
     * @throws IOException
     * @throws ParserException
     * @throws ParseException
     */
    public List<EventVO> fromIcal(InputStream ical) throws IOException, ParserException, ParseException
    {
        
//        System.setProperty("ical4j.unfolding.relaxed", "true");  // relaxed parsing
        

        CompatibilityHints.setHintEnabled(CompatibilityHints.KEY_RELAXED_UNFOLDING, true); 
        CompatibilityHints.setHintEnabled(CompatibilityHints.KEY_RELAXED_PARSING, true);
        CompatibilityHints.setHintEnabled(CompatibilityHints.KEY_OUTLOOK_COMPATIBILITY, true); 
        
        List<EventVO> events = new ArrayList<EventVO>();
        Calendar icalendar = new CalendarBuilder().build(ical);
        List<Component> components = icalendar.getComponents();
        for(Component comp : components)
        {
            EventVO event = new EventVO();
            if(log.isDebugEnabled())
                log.debug("import component: " + comp);
            if(comp instanceof VEvent)  //only VEvent are parsed
            {
                if(comp.getProperties().getProperty((Property.DESCRIPTION)) != null)
                    event.setDescription(comp.getProperties().getProperty(Property.DESCRIPTION).getValue());
                if(comp.getProperties().getProperty((Property.SUMMARY)) != null)
                    event.setTitle(comp.getProperties().getProperty(Property.SUMMARY).getValue());
                else
                    event.setTitle("XXX");
                if(comp.getProperties().getProperty((Property.DTSTART)) != null)
                    if(comp.getProperties().getProperty(Property.DTSTART).getParameter("VALUE") != null 
                       && comp.getProperties().getProperty(Property.DTSTART).getParameter("VALUE").getValue().equals("DATE"))
                    {
                        event.setStartDate(new Date(comp.getProperties().getProperty(Property.DTSTART).getValue()));
                        event.setAllDay(true);