WaarpActionLogger.java

/**
 * Copyright 2009, Frederic Bregier, and individual contributors by the @author tags. See the
 * COPYRIGHT.txt in the distribution for a full listing of individual contributors.
 * 
 * This is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser
 * General Public License as published by the Free Software Foundation; either version 3.0 of the
 * License, or (at your option) any later version.
 * 
 * This software 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 Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License along with this
 * software; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
 * Boston, MA 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.waarp.gateway.ftp.control;

import org.waarp.common.command.ReplyCode;
import org.waarp.common.command.exception.CommandAbstractException;
import org.waarp.common.database.DbSession;
import org.waarp.common.database.data.AbstractDbData.UpdatedInfo;
import org.waarp.common.database.exception.WaarpDatabaseException;
import org.waarp.common.logging.WaarpLogger;
import org.waarp.common.logging.WaarpLoggerFactory;
import org.waarp.ftp.core.command.FtpCommandCode;
import org.waarp.ftp.core.control.BusinessHandler;
import org.waarp.ftp.core.data.FtpTransfer;
import org.waarp.ftp.core.exception.FtpNoFileException;
import org.waarp.ftp.core.session.FtpSession;
import org.waarp.gateway.ftp.config.FileBasedConfiguration;
import org.waarp.gateway.ftp.database.DbConstant;
import org.waarp.gateway.ftp.database.data.DbTransferLog;

/**
 * Class to help to log any actions through the interface of Waarp
 * 
 * @author Frederic Bregier
 * 
 */
public class WaarpActionLogger {
    /**
     * Internal Logger
     */
    private static final WaarpLogger logger = WaarpLoggerFactory
            .getLogger(WaarpActionLogger.class);

    /**
     * Log the action
     * 
     * @param ftpSession
     * @param message
     * @param file
     * @param handler
     */
    public static long logCreate(DbSession ftpSession,
            String message, String file, BusinessHandler handler) {
        FtpSession session = handler.getFtpSession();
        String sessionContexte = session.toString();
        logger.info(message + " " + sessionContexte);
        if (ftpSession != null) {
            FtpCommandCode code = session.getCurrentCommand().getCode();
            if (FtpCommandCode.isStorOrRetrLikeCommand(code)) {
                boolean isSender =
                        FtpCommandCode.isRetrLikeCommand(code);
                try {
                    // Insert new one
                    DbTransferLog log =
                            new DbTransferLog(ftpSession,
                                    session.getAuth().getUser(),
                                    session.getAuth().getAccount(),
                                    DbConstant.ILLEGALVALUE,
                                    isSender, file,
                                    code.name(),
                                    ReplyCode.REPLY_000_SPECIAL_NOSTATUS, message,
                                    UpdatedInfo.TOSUBMIT);
                    logger.debug("Create FS: " + log.toString());
                    if (FileBasedConfiguration.fileBasedConfiguration.monitoring != null) {
                        if (isSender) {
                            FileBasedConfiguration.fileBasedConfiguration.monitoring
                                    .updateLastOutBand();
                        } else {
                            FileBasedConfiguration.fileBasedConfiguration.monitoring
                                    .updateLastInBound();
                        }
                    }
                    return log.getSpecialId();
                } catch (WaarpDatabaseException e1) {
                    // Do nothing
                }
            }
        }
        return DbConstant.ILLEGALVALUE;
    }

    /**
     * Log the action
     * 
     * @param ftpSession
     * @param specialId
     * @param message
     * @param handler
     * @param rcode
     * @param info
     */
    public static long logAction(DbSession ftpSession, long specialId,
            String message, BusinessHandler handler, ReplyCode rcode,
            UpdatedInfo info) {
        FtpSession session = handler.getFtpSession();
        String sessionContexte = session.toString();
        logger.info(message + " " + sessionContexte);
        if (ftpSession != null && specialId != DbConstant.ILLEGALVALUE) {
            FtpCommandCode code = session.getCurrentCommand().getCode();
            if (FtpCommandCode.isStorOrRetrLikeCommand(code)) {
                try {
                    // Try load
                    DbTransferLog log =
                            new DbTransferLog(ftpSession,
                                    session.getAuth().getUser(),
                                    session.getAuth().getAccount(), specialId);
                    log.changeUpdatedInfo(info);
                    log.setInfotransf(message);
                    log.setReplyCodeExecutionStatus(rcode);
                    log.update();
                    logger.debug("Update FS: " + log.toString());
                    return log.getSpecialId();
                } catch (WaarpDatabaseException e) {
                    // Do nothing
                }
            } else {
                if (FileBasedConfiguration.fileBasedConfiguration.monitoring != null) {
                    FileBasedConfiguration.fileBasedConfiguration.monitoring.
                            updateCodeNoTransfer(rcode);
                }
            }
        } else {
            if (FileBasedConfiguration.fileBasedConfiguration.monitoring != null) {
                FileBasedConfiguration.fileBasedConfiguration.monitoring.
                        updateCodeNoTransfer(rcode);
            }
        }
        return specialId;
    }

    /**
     * Log the action in error
     * 
     * @param ftpSession
     * @param specialId
     * @param transfer
     * @param message
     * @param rcode
     * @param handler
     */
    public static void logErrorAction(DbSession ftpSession, long specialId,
            FtpTransfer transfer,
            String message, ReplyCode rcode, BusinessHandler handler) {
        FtpSession session = handler.getFtpSession();
        String sessionContexte = session.toString();
        logger.error(rcode.getCode() + ":" + message + " " + sessionContexte);
        logger.debug("Log",
                new Exception("Log"));
        if (ftpSession != null && specialId != DbConstant.ILLEGALVALUE) {
            FtpCommandCode code = session.getCurrentCommand().getCode();
            if (FtpCommandCode.isStorOrRetrLikeCommand(code)) {
                String file = null;
                if (transfer != null) {
                    try {
                        file = transfer.getFtpFile().getFile();
                    } catch (CommandAbstractException e1) {
                    } catch (FtpNoFileException e1) {
                    }
                } else {
                    file = null;
                }
                UpdatedInfo info = UpdatedInfo.INERROR;
                try {
                    // Try load
                    DbTransferLog log =
                            new DbTransferLog(ftpSession,
                                    session.getAuth().getUser(),
                                    session.getAuth().getAccount(), specialId);
                    log.changeUpdatedInfo(info);
                    log.setInfotransf(message);
                    if (rcode.getCode() < 400) {
                        log.setReplyCodeExecutionStatus(ReplyCode.REPLY_426_CONNECTION_CLOSED_TRANSFER_ABORTED);
                    } else {
                        log.setReplyCodeExecutionStatus(rcode);
                    }
                    if (file != null) {
                        log.setFilename(file);
                    }
                    log.update();
                    if (FileBasedConfiguration.fileBasedConfiguration.ftpMib != null) {
                        FileBasedConfiguration.fileBasedConfiguration.ftpMib.
                                notifyInfoTask(message, log);
                    }
                    logger.debug("Update FS: " + log.toString());
                } catch (WaarpDatabaseException e) {
                    // Do nothing
                }
            } else {
                if (FileBasedConfiguration.fileBasedConfiguration.monitoring != null) {
                    FileBasedConfiguration.fileBasedConfiguration.monitoring.
                            updateCodeNoTransfer(rcode);
                }
                if (rcode != ReplyCode.REPLY_450_REQUESTED_FILE_ACTION_NOT_TAKEN &&
                        rcode != ReplyCode.REPLY_550_REQUESTED_ACTION_NOT_TAKEN) {
                    if (FileBasedConfiguration.fileBasedConfiguration.ftpMib != null) {
                        FileBasedConfiguration.fileBasedConfiguration.ftpMib.
                                notifyWarning(rcode.getMesg(), message);
                    }
                }
            }
        } else {
            if (FileBasedConfiguration.fileBasedConfiguration.monitoring != null) {
                FileBasedConfiguration.fileBasedConfiguration.monitoring.
                        updateCodeNoTransfer(rcode);
            }
            if (rcode != ReplyCode.REPLY_450_REQUESTED_FILE_ACTION_NOT_TAKEN &&
                    rcode != ReplyCode.REPLY_550_REQUESTED_ACTION_NOT_TAKEN) {
                if (FileBasedConfiguration.fileBasedConfiguration.ftpMib != null) {
                    FileBasedConfiguration.fileBasedConfiguration.ftpMib.
                            notifyWarning(rcode.getMesg(), message);
                }
            }
        }
    }
}