/**
* Copyright (c) 2003-2006, www.pdfbox.org
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
* 3. Neither the name of pdfbox; nor the names of its
* contributors may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* http://www.pdfbox.org
*
*/
package org.pdfbox.util;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.io.IOException;
import java.util.Calendar;
import java.util.Date;
import java.util.GregorianCalendar;
import java.util.SimpleTimeZone;
import java.util.TimeZone;
import org.pdfbox.cos.COSString;
/**
* This class is used to convert dates to strings and back using the PDF
* date standards. Date are described in PDFReference1.4 section 3.8.2
*
* @author <a href="mailto:ben@benlitchfield.com">Ben Litchfield</a>
* @version $Revision: 1.13 $
*/
public class DateConverter
{
private static final SimpleDateFormat PDF_DATE_FORMAT = new SimpleDateFormat( "yyyyMMddHHmmss" );
//The Date format is supposed to be the PDF_DATE_FORMAT, but not all PDF documents
//will use that date, so I have added a couple other potential formats
//to try if the original one does not work.
private static final SimpleDateFormat[] POTENTIAL_FORMATS = new SimpleDateFormat[] {
new SimpleDateFormat("EEEE, dd MMM yyyy hh:mm:ss a"),
new SimpleDateFormat("EEEE, MMM dd, yyyy hh:mm:ss a"),
new SimpleDateFormat("MM/dd/yyyy hh:mm:ss"),
new SimpleDateFormat("MM/dd/yyyy")};
private static final SimpleDateFormat ISO_8601_DATE_FORMAT = new SimpleDateFormat( "yyyy-MM-dd'T'HH:mm:ss" );
private DateConverter()
{
//utility class should not be constructed.
}
/**
* This will convert the calendar to a string.
*
* @param date The date to convert to a string.
*
* @return The date as a String to be used in a PDF document.
*/
public static String toString( Calendar date )
{
String retval = null;
if( date != null )
{
StringBuffer buffer = new StringBuffer();
TimeZone zone = date.getTimeZone();
long offsetInMinutes = zone.getOffset( date.getTimeInMillis() )/1000/60;
long hours = Math.abs( offsetInMinutes/60 );
long minutes = Math.abs( offsetInMinutes%60 );
buffer.append( "D:" );
buffer.append( PDF_DATE_FORMAT.format( date.getTime() ) );
if( offsetInMinutes == 0 )
{
buffer.append( "Z" );
}
else if( offsetInMinutes < 0 )
{
buffer.append( "-" );
}
else
{
buffer.append( "+" );
}
if( hours < 10 )
{
buffer.append( "0" );
}
buffer.append( hours );
buffer.append( "'" );
if( minutes < 10 )
{
buffer.append( "0" );
}
buffer.append( minutes );
buffer.append( "'" );
retval = buffer.toString();
}
return retval;
}
/**
* This will convert a string to a calendar.
*
* @param date The string representation of the calendar.
*
* @return The calendar that this string represents.
*
* @throws IOException If the date string is not in the correct format.
*/
public static Calendar toCalendar( COSString date ) throws IOException
{
Calendar retval = null;
if( date != null )
{
retval = toCalendar( date.getString() );
}
return retval;
}
/**
* This will convert a string to a calendar.
*
* @param date The string representation of the calendar.
*
* @return The calendar that this string represents.
*
* @throws IOException If the date string is not in the correct format.
*/
public static Calendar toCalendar( String date ) throws IOException
{
Calendar retval = null;
if( date != null && date.trim().length() > 0 )
{
//these are the default values
int year = 0;
int month = 1;
int day = 1;
int hour = 0;
int minute = 0;
int second = 0;
//first string off the prefix if it exists
try
{
SimpleTimeZone zone = null;
if( date.startsWith( "D:" ) )
{
date = date.substring( 2, date.length() );
}
if( date.length() < 4 )
{
throw new IOException( "Error: Invalid date format '" + date + "'" );
}
year = Integer.parseInt( date.substring( 0, 4 ) );
if( date.length() >= 6 )
{
month = Integer.parseInt( date.substring( 4, 6 ) );
}
if( date.length() >= 8 )
{
day = Integer.parseInt( date.substring( 6, 8 ) );
}
if( date.length() >= 10 )
{
hour = Integer.parseInt( date.substring( 8, 10 ) );
}
if( date.length() >= 12 )
{
minute = Integer.parseInt( date.substring( 10, 12 ) );
}
if( date.length() >= 14 )
{
second = Integer.parseInt( date.substring( 12, 14 ) );
}
retval = new GregorianCalendar( year, month-1, day, hour, minute, second );
if( date.length() >= 15 )
{
char sign = date.charAt( 14 );
if( sign == 'Z' )
{
zone = new SimpleTimeZone(0,"Unknown");
}
else
{
int hours = 0;
int minutes = 0;
if( date.length() >= 17 )
{
if( sign == '+' )
{
//parseInt cannot handle the + sign
hours = Integer.parseInt( date.substring( 15, 17 ) );
}
else
{
hours = Integer.parseInt( date.substring( 14, 17 ) );
}
}
if( date.length() > 20 )
{
minutes = Integer.parseInt( date.substring( 18, 20 ) );
}
zone = new SimpleTimeZone( hours*60*60*1000 + minutes*60*1000, "Unknown" );
}
retval.setTimeZone( zone );
}
}
catch( NumberFormatException e )
{
for( int i=0; retval == null && i<POTENTIAL_FORMATS.length; i++ )
{
try
{
Date utilDate = POTENTIAL_FORMATS[i].parse( date );
retval = new GregorianCalendar();
retval.setTime( utilDate );
}
catch( ParseException pe )
{
//ignore and move to next potential format
}
}
if( retval == null )
{
//we didn't find a valid date format so throw an exception
throw new IOException( "Error converting date:" + date );
}
}
}
return retval;
}
/**
* Convert the date to iso 8601 string format.
*
* @param cal The date to convert.
* @return The date represented as an ISO 8601 string.
*/
public static String toISO8601( Calendar cal )
{
StringBuffer retval = new StringBuffer();
retval.append( ISO_8601_DATE_FORMAT.format( cal.getTime() ) );
int timeZone = cal.get( Calendar.ZONE_OFFSET );
if( timeZone < 0 )
{
retval.append( "-" );
}
else
{
retval.append( "+" );
}
timeZone = Math.abs( timeZone );
//milliseconds/1000 = seconds = seconds / 60 = minutes = minutes/60 = hours
int hours = timeZone/1000/60/60;
int minutes = (timeZone - (hours*1000*60*60))/1000/1000;
if( hours < 10 )
{
retval.append( "0" );
}
retval.append( Integer.toString( hours ) );
retval.append( ":" );
if( minutes < 10 )
{
retval.append( "0" );
}
retval.append( Integer.toString( minutes ) );
return retval.toString();
}
}