// // ======================================================================== // Copyright (c) 1995-2017 Mort Bay Consulting Pty. Ltd. // ------------------------------------------------------------------------ // All rights reserved. This program and the accompanying materials // are made available under the terms of the Eclipse Public License v1.0 // and Apache License v2.0 which accompanies this distribution. // // The Eclipse Public License is available at // http://www.eclipse.org/legal/epl-v10.html // // The Apache License v2.0 is available at // http://www.opensource.org/licenses/apache2.0.php // // You may elect to redistribute this code under either of these licenses. // ======================================================================== // package org.eclipse.jetty.util; import java.io.File; import java.io.FileOutputStream; import java.io.FilterOutputStream; import java.io.IOException; import java.io.OutputStream; import java.text.SimpleDateFormat; import java.time.ZonedDateTime; import java.time.temporal.ChronoUnit; import java.util.Date; import java.util.Locale; import java.util.TimeZone; import java.util.Timer; import java.util.TimerTask; /** * RolloverFileOutputStream. * * <p> * This output stream puts content in a file that is rolled over every 24 hours. * The filename must include the string "yyyy_mm_dd", which is replaced with the * actual date when creating and rolling over the file. * </p> * <p> * Old files are retained for a number of days before being deleted. * </p> */ public class RolloverFileOutputStream extends FilterOutputStream { private static Timer __rollover; final static String YYYY_MM_DD="yyyy_mm_dd"; final static String ROLLOVER_FILE_DATE_FORMAT = "yyyy_MM_dd"; final static String ROLLOVER_FILE_BACKUP_FORMAT = "HHmmssSSS"; final static int ROLLOVER_FILE_RETAIN_DAYS = 31; private RollTask _rollTask; private SimpleDateFormat _fileBackupFormat; private SimpleDateFormat _fileDateFormat; private String _filename; private File _file; private boolean _append; private int _retainDays; /* ------------------------------------------------------------ */ /** * @param filename The filename must include the string "yyyy_mm_dd", * which is replaced with the actual date when creating and rolling over the file. * @throws IOException if unable to create output */ public RolloverFileOutputStream(String filename) throws IOException { this(filename,true,ROLLOVER_FILE_RETAIN_DAYS); } /* ------------------------------------------------------------ */ /** * @param filename The filename must include the string "yyyy_mm_dd", * which is replaced with the actual date when creating and rolling over the file. * @param append If true, existing files will be appended to. * @throws IOException if unable to create output */ public RolloverFileOutputStream(String filename, boolean append) throws IOException { this(filename,append,ROLLOVER_FILE_RETAIN_DAYS); } /* ------------------------------------------------------------ */ /** * @param filename The filename must include the string "yyyy_mm_dd", * which is replaced with the actual date when creating and rolling over the file. * @param append If true, existing files will be appended to. * @param retainDays The number of days to retain files before deleting them. 0 to retain forever. * @throws IOException if unable to create output */ public RolloverFileOutputStream(String filename, boolean append, int retainDays) throws IOException { this(filename,append,retainDays,TimeZone.getDefault()); } /* ------------------------------------------------------------ */ /** * @param filename The filename must include the string "yyyy_mm_dd", * which is replaced with the actual date when creating and rolling over the file. * @param append If true, existing files will be appended to. * @param retainDays The number of days to retain files before deleting them. 0 to retain forever. * @param zone the timezone for the output * @throws IOException if unable to create output */ public RolloverFileOutputStream(String filename, boolean append, int retainDays, TimeZone zone) throws IOException { this(filename,append,retainDays,zone,null,null,ZonedDateTime.now(zone.toZoneId())); } /* ------------------------------------------------------------ */ /** * @param filename The filename must include the string "yyyy_mm_dd", * which is replaced with the actual date when creating and rolling over the file. * @param append If true, existing files will be appended to. * @param retainDays The number of days to retain files before deleting them. 0 to retain forever. * @param zone the timezone for the output * @param dateFormat The format for the date file substitution. The default is "yyyy_MM_dd". * @param backupFormat The format for the file extension of backup files. The default is "HHmmssSSS". * @throws IOException if unable to create output */ public RolloverFileOutputStream(String filename, boolean append, int retainDays, TimeZone zone, String dateFormat, String backupFormat) throws IOException { this(filename,append,retainDays,zone,dateFormat,backupFormat,ZonedDateTime.now(zone.toZoneId())); } RolloverFileOutputStream(String filename, boolean append, int retainDays, TimeZone zone, String dateFormat, String backupFormat, ZonedDateTime now) throws IOException { super(null); if (dateFormat==null) dateFormat=ROLLOVER_FILE_DATE_FORMAT; _fileDateFormat = new SimpleDateFormat(dateFormat); if (backupFormat==null) backupFormat=ROLLOVER_FILE_BACKUP_FORMAT; _fileBackupFormat = new SimpleDateFormat(backupFormat); _fileBackupFormat.setTimeZone(zone); _fileDateFormat.setTimeZone(zone); if (filename!=null) { filename=filename.trim(); if (filename.length()==0) filename=null; } if (filename==null) throw new IllegalArgumentException("Invalid filename"); _filename=filename; _append=append; _retainDays=retainDays; synchronized(RolloverFileOutputStream.class) { if (__rollover==null) __rollover=new Timer(RolloverFileOutputStream.class.getName(),true); // Calculate Today's Midnight, based on Configured TimeZone (will be in past, even if by a few milliseconds) setFile(now); // This will schedule the rollover event to the next midnight scheduleNextRollover(now); } } /* ------------------------------------------------------------ */ /** * Get the "start of day" for the provided DateTime at the zone specified. * * @param now the date time to calculate from * @return start of the day of the date provided */ public static ZonedDateTime toMidnight(ZonedDateTime now) { return now.toLocalDate().atStartOfDay(now.getZone()).plus(1, ChronoUnit.DAYS); } /* ------------------------------------------------------------ */ private void scheduleNextRollover(ZonedDateTime now) { _rollTask = new RollTask(); // Get tomorrow's midnight based on Configured TimeZone ZonedDateTime midnight = toMidnight(now); // Schedule next rollover event to occur, based on local machine's Unix Epoch milliseconds long delay = midnight.toInstant().toEpochMilli() - now.toInstant().toEpochMilli(); __rollover.schedule(_rollTask,delay); } /* ------------------------------------------------------------ */ public String getFilename() { return _filename; } /* ------------------------------------------------------------ */ public String getDatedFilename() { if (_file==null) return null; return _file.toString(); } /* ------------------------------------------------------------ */ public int getRetainDays() { return _retainDays; } /* ------------------------------------------------------------ */ synchronized void setFile(ZonedDateTime now) throws IOException { // Check directory File file = new File(_filename); _filename=file.getCanonicalPath(); file=new File(_filename); File dir= new File(file.getParent()); if (!dir.isDirectory() || !dir.canWrite()) throw new IOException("Cannot write log directory "+dir); // Is this a rollover file? String filename=file.getName(); int i=filename.toLowerCase(Locale.ENGLISH).indexOf(YYYY_MM_DD); if (i>=0) { file=new File(dir, filename.substring(0,i)+ _fileDateFormat.format(new Date(now.toInstant().toEpochMilli()))+ filename.substring(i+YYYY_MM_DD.length())); } if (file.exists()&&!file.canWrite()) throw new IOException("Cannot write log file "+file); // Do we need to change the output stream? if (out==null || !file.equals(_file)) { // Yep _file=file; if (!_append && file.exists()) file.renameTo(new File(file.toString()+"."+_fileBackupFormat.format(new Date(now.toInstant().toEpochMilli())))); OutputStream oldOut=out; out=new FileOutputStream(file.toString(),_append); if (oldOut!=null) oldOut.close(); //if(log.isDebugEnabled())log.debug("Opened "+_file); } } /* ------------------------------------------------------------ */ void removeOldFiles(ZonedDateTime now) { if (_retainDays>0) { // Establish expiration time, based on configured TimeZone long expired = now.minus(_retainDays, ChronoUnit.DAYS).toInstant().toEpochMilli(); File file= new File(_filename); File dir = new File(file.getParent()); String fn=file.getName(); int s=fn.toLowerCase(Locale.ENGLISH).indexOf(YYYY_MM_DD); if (s<0) return; String prefix=fn.substring(0,s); String suffix=fn.substring(s+YYYY_MM_DD.length()); String[] logList=dir.list(); for (int i=0;i<logList.length;i++) { fn = logList[i]; if(fn.startsWith(prefix)&&fn.indexOf(suffix,prefix.length())>=0) { File f = new File(dir,fn); if(f.lastModified() < expired) { f.delete(); } } } } } /* ------------------------------------------------------------ */ @Override public void write (byte[] buf) throws IOException { out.write (buf); } /* ------------------------------------------------------------ */ @Override public void write (byte[] buf, int off, int len) throws IOException { out.write (buf, off, len); } /* ------------------------------------------------------------ */ @Override public void close() throws IOException { synchronized(RolloverFileOutputStream.class) { try{super.close();} finally { out=null; _file=null; } if (_rollTask != null) { _rollTask.cancel(); } } } /* ------------------------------------------------------------ */ private class RollTask extends TimerTask { @Override public void run() { try { synchronized(RolloverFileOutputStream.class) { ZonedDateTime now = ZonedDateTime.now(_fileDateFormat.getTimeZone().toZoneId()); RolloverFileOutputStream.this.setFile(now); RolloverFileOutputStream.this.scheduleNextRollover(now); RolloverFileOutputStream.this.removeOldFiles(now); } } catch(Throwable t) { // Cannot log this exception to a LOG, as RolloverFOS can be used by logging t.printStackTrace(System.err); } } } }