001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements. See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache license, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License. You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the license for the specific language governing permissions and
015 * limitations under the license.
016 */
017package org.apache.logging.log4j.core.appender.rolling.action;
018
019import java.io.File;
020import java.io.FileInputStream;
021import java.io.FileOutputStream;
022import java.io.IOException;
023import java.nio.channels.FileChannel;
024
025/**
026 * File rename action.
027 */
028public class FileRenameAction extends AbstractAction {
029
030    /**
031     * Source.
032     */
033    private final File source;
034
035    /**
036     * Destination.
037     */
038    private final File destination;
039
040    /**
041     * If true, rename empty files, otherwise delete empty files.
042     */
043    private final boolean renameEmptyFiles;
044
045    /**
046     * Creates an FileRenameAction.
047     *
048     * @param src current file name.
049     * @param dst new file name.
050     * @param renameEmptyFiles if true, rename file even if empty, otherwise delete empty files.
051     */
052    public FileRenameAction(final File src, final File dst, final boolean renameEmptyFiles) {
053        source = src;
054        destination = dst;
055        this.renameEmptyFiles = renameEmptyFiles;
056    }
057
058    /**
059     * Rename file.
060     *
061     * @return true if successfully renamed.
062     */
063    @Override
064    public boolean execute() {
065        return execute(source, destination, renameEmptyFiles);
066    }
067
068    /**
069     * Gets the destination.
070     * 
071     * @return the destination.
072     */
073    public File getDestination() {
074        return this.destination;
075    }
076
077    /**
078     * Gets the source.
079     * 
080     * @return the source.
081     */
082    public File getSource() {
083        return this.source;
084    }
085
086    /**
087     * Whether to rename empty files. If true, rename empty files, otherwise delete empty files.
088     * 
089     * @return Whether to rename empty files.
090     */
091    public boolean isRenameEmptyFiles() {
092        return renameEmptyFiles;
093    }
094
095    /**
096     * Rename file.
097     *
098     * @param source current file name.
099     * @param destination new file name.
100     * @param renameEmptyFiles if true, rename file even if empty, otherwise delete empty files.
101     * @return true if successfully renamed.
102     */
103    public static boolean execute(final File source, final File destination, final boolean renameEmptyFiles) {
104        if (renameEmptyFiles || source.length() > 0) {
105            final File parent = destination.getParentFile();
106            if (parent != null && !parent.exists()) {
107                // LOG4J2-679: ignore mkdirs() result: in multithreaded scenarios,
108                // if one thread succeeds the other thread returns false
109                // even though directories have been created. Check if dir exists instead.
110                parent.mkdirs();
111                if (!parent.exists()) {
112                    LOGGER.error("Unable to create directory {}", parent.getAbsolutePath());
113                    return false;
114                }
115            }
116            try {
117                if (!source.renameTo(destination)) {
118                    try {
119                        copyFile(source, destination);
120                        return source.delete();
121                    } catch (final IOException iex) {
122                        LOGGER.error("Unable to rename file {} to {} - {}", source.getAbsolutePath(),
123                                destination.getAbsolutePath(), iex.getMessage());
124                    }
125                }
126                return true;
127            } catch (final Exception ex) {
128                try {
129                    copyFile(source, destination);
130                    return source.delete();
131                } catch (final IOException iex) {
132                    LOGGER.error("Unable to rename file {} to {} - {}", source.getAbsolutePath(),
133                            destination.getAbsolutePath(), iex.getMessage());
134                }
135            }
136        } else {
137            try {
138                source.delete();
139            } catch (final Exception ex) {
140                LOGGER.error("Unable to delete empty file " + source.getAbsolutePath());
141            }
142        }
143
144        return false;
145    }
146
147    private static void copyFile(final File source, final File destination) throws IOException {
148        if (!destination.exists()) {
149            destination.createNewFile();
150        }
151
152        // LOG4J2-1173: Files.copy(source.toPath(), destination.toPath()) throws IOException
153        // when copying to a directory mapped to a remote Linux host
154
155        try (FileInputStream srcStream = new FileInputStream(source);
156                FileOutputStream destStream = new FileOutputStream(destination);
157                FileChannel srcChannel = srcStream.getChannel();
158                FileChannel destChannel = destStream.getChannel();) {
159
160            destChannel.transferFrom(srcChannel, 0, srcChannel.size());
161        }
162    }
163
164    @Override
165    public String toString() {
166        return FileRenameAction.class.getSimpleName() + '[' + source + " to " + destination //
167                + ", renameEmptyFiles=" + renameEmptyFiles + ']';
168    }
169
170}