# VFSUtils.java

    /*
    *  Licensed to the Apache Software Foundation (ASF) under one
    *  or more contributor license agreements.  See the NOTICE file
    *  distributed with this work for additional information
    *  regarding copyright ownership.  The ASF licenses this file
    *  to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
    *
    *  Unless required by applicable law or agreed to in writing,
    *  software distributed under the License is distributed on an
    *   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    *  KIND, either express or implied.  See the License for the
    *  specific language governing permissions and limitations
    *  under the License.
    */
    package org.apache.synapse.commons.vfs;

    import org.apache.axis2.AxisFault;
    import org.apache.axis2.context.MessageContext;
    import org.apache.axis2.description.Parameter;
    import org.apache.axis2.description.ParameterInclude;
    import org.apache.axis2.transport.base.ParamUtils;
    import org.apache.commons.lang.WordUtils;
    import org.apache.commons.logging.Log;
    import org.apache.commons.logging.LogFactory;
    import org.apache.commons.net.ftp.FTP;
    import org.apache.commons.vfs2.FileContent;
    import org.apache.commons.vfs2.FileObject;
    import org.apache.commons.vfs2.FileSystemException;
    import org.apache.commons.vfs2.FileSystemManager;
    import org.apache.commons.vfs2.FileSystemOptions;
    import org.apache.commons.vfs2.provider.UriParser;
    import org.apache.commons.vfs2.util.DelegatingFileSystemOptionsBuilder;

    import java.io.IOException;
    import java.io.InputStream;
    import java.io.OutputStream;
    import java.net.InetAddress;
    import java.net.UnknownHostException;
    import java.text.SimpleDateFormat;
    import java.util.Arrays;
    import java.util.Date;
    import java.util.HashMap;
    import java.util.Map;
    import java.util.Random;
    import java.util.regex.Matcher;
    import java.util.regex.Pattern;

    public class VFSUtils {

        private static final Log log = LogFactory.getLog(VFSUtils.class);

        private static final String STR_SPLITER = ":";

        /**
         * URL pattern
         */
        private static final Pattern URL_PATTERN = Pattern.compile("[a-z]+://.*");

        /**
         * Password pattern
         */
        private static final Pattern PASSWORD_PATTERN = Pattern.compile(":(?:[^/]+)@");

        /**
         * Get a String property from FileContent message
         *
         * @param message the File message
         * @param property property name
         * @return property value
         */
        public static String getProperty(FileContent message, String property) {
            try {
                Object o = message.getAttributes().get(property);
                if (o instanceof String) {
                    return (String) o;
                }
            } catch (FileSystemException ignored) {}
            return null;
        }

        public static String getFileName(MessageContext msgCtx, VFSOutTransportInfo vfsOutInfo) {
            String fileName = null;

            // first preference to a custom filename set on the current message context
            Map transportHeaders = (Map) msgCtx.getProperty(MessageContext.TRANSPORT_HEADERS);
            if (transportHeaders != null) {
                fileName = (String) transportHeaders.get(VFSConstants.REPLY_FILE_NAME);
            }

            // if not, does the service (in its service.xml) specify one?
            if (fileName == null) {
                Parameter param = msgCtx.getAxisService().getParameter(VFSConstants.REPLY_FILE_NAME);
                if (param != null) {
                    fileName = (String) param.getValue();
                }
            }

            // next check if the OutTransportInfo specifies one
            if (fileName == null) {
                fileName = vfsOutInfo.getOutFileName();
            }

            // if none works.. use default
            if (fileName == null) {
                fileName = VFSConstants.DEFAULT_RESPONSE_FILE;
            }
            return fileName;
        }

        /**
         * Acquires a file item lock before processing the item, guaranteing that the file is not
         * processed while it is being uploaded and/or the item is not processed by two listeners
         *
         * @param fsManager used to resolve the processing file
         * @param fo representing the processing file item
         * @param fso represents file system options used when resolving file from file system manager.
         * @return boolean true if the lock has been acquired or false if not
         */
        public synchronized static boolean acquireLock(FileSystemManager fsManager, FileObject fo, FileSystemOptions fso, boolean isListener) {
            return acquireLock(fsManager, fo, null, fso, isListener);
        }

        /**
         * Acquires a file item lock before processing the item, guaranteing that
         * the file is not processed while it is being uploaded and/or the item is
         * not processed by two listeners
         *
         * @param fsManager
         *            used to resolve the processing file
         * @param fo
         *            representing the processing file item
         * @param fso
         *            represents file system options used when resolving file from file system manager.
         * @return boolean true if the lock has been acquired or false if not
         */
        public synchronized static boolean acquireLock(FileSystemManager fsManager, FileObject fo, VFSParamDTO paramDTO,
                                                       FileSystemOptions fso, boolean isListener) {

            // generate a random lock value to ensure that there are no two parties
            // processing the same file
            Random random = new Random();
            // Lock format random:hostname:hostip:time
            String strLockValue = String.valueOf(random.nextLong());
            try {
                strLockValue += STR_SPLITER + InetAddress.getLocalHost().getHostName();
                strLockValue += STR_SPLITER + InetAddress.getLocalHost().getHostAddress();
            } catch (UnknownHostException ue) {
                if (log.isDebugEnabled()) {
                    log.debug("Unable to get the Hostname or IP.");
                }
            }
            strLockValue += STR_SPLITER + (new Date()).getTime();
            byte[] lockValue = strLockValue.getBytes();
            FileObject lockObject = null;

            try {
                // check whether there is an existing lock for this item, if so it is assumed
                // to be processed by an another listener (downloading) or a sender (uploading)
                // lock file is derived by attaching the ".lock" second extension to the file name
                String fullPath = fo.getName().getURI();
                int pos = fullPath.indexOf("?");
                if (pos != -1) {
                    fullPath = fullPath.substring(0, pos);
                }
                lockObject = fsManager.resolveFile(fullPath + ".lock", fso);
                if (lockObject.exists()) {
                    log.debug("There seems to be an external lock, aborting the processing of the file "
                            + maskURLPassword(fo.getName().getURI())
                            + ". This could possibly be due to some other party already "
                            + "processing this file or the file is still being uploaded");
                    if(paramDTO != null && paramDTO.isAutoLockRelease()){
                        releaseLock(lockValue, strLockValue, lockObject, paramDTO.isAutoLockReleaseSameNode(),
                                paramDTO.getAutoLockReleaseInterval());
                    }
                } else {
                    if (isListener) {
                        //Check the original file existence before the lock file to handle concurrent access scenario
                        FileObject originalFileObject = fsManager.resolveFile(fullPath, fso);
                        if (!originalFileObject.exists()) {
                            return false;
                        }
                    }
                    // write a lock file before starting of the processing, to ensure that the
                    // item is not processed by any other parties
                    lockObject.createFile();
                    OutputStream stream = lockObject.getContent().getOutputStream();
                    try {
                        stream.write(lockValue);
                        stream.flush();
                        stream.close();
                    } catch (IOException e) {
                        lockObject.delete();
                        log.error("Couldn't create the lock file before processing the file "
                                + maskURLPassword(fullPath), e);
                        return false;
                    } finally {
                        lockObject.close();
                    }

                    // check whether the lock is in place and is it me who holds the lock. This is
                    // required because it is possible to write the lock file simultaneously by
                    // two processing parties. It checks whether the lock file content is the same
                    // as the written random lock value.
                    // NOTE: this may not be optimal but is sub optimal
                    FileObject verifyingLockObject = fsManager.resolveFile(
                            fullPath + ".lock", fso);
                    if (verifyingLockObject.exists() && verifyLock(lockValue, verifyingLockObject)) {
                        return true;
                    }
                }
            } catch (FileSystemException fse) {
                log.error("Cannot get the lock for the file : " + maskURLPassword(fo.getName().getURI()) + " before processing", fse);
                if (lockObject != null) {
                    try {
                        fsManager.closeFileSystem(lockObject.getParent().getFileSystem());
                    } catch (FileSystemException e) {
                        log.warn("Unable to close the lockObject parent file system");
                    }
                }
            }
            return false;
        }

        /**
         * Release a file item lock acquired either by the VFS listener or a sender
         *
         * @param fsManager which is used to resolve the processed file
         * @param fo representing the processed file
         * @param fso represents file system options used when resolving file from file system manager.
         */
        public static void releaseLock(FileSystemManager fsManager, FileObject fo, FileSystemOptions fso) {
            String fullPath = fo.getName().getURI();

            try {
                int pos = fullPath.indexOf("?");
                if (pos > -1) {
                    fullPath = fullPath.substring(0, pos);
                }
                FileObject lockObject = fsManager.resolveFile(fullPath + ".lock", fso);
                if (lockObject.exists()) {
                    lockObject.delete();
                }
            } catch (FileSystemException e) {
                log.error("Couldn't release the lock for the file : "
                        + maskURLPassword(fo.getName().getURI()) + " after processing");
            }
        }

        /**
         * Mask the password of the connection url with ***
         * @param url the actual url
         * @return the masked url
         */
        public static String maskURLPassword(String url) {
            final Matcher urlMatcher = URL_PATTERN.matcher(url);
            String maskUrl;
            if (urlMatcher.find()) {
                final Matcher pwdMatcher = PASSWORD_PATTERN.matcher(url);
                maskUrl = pwdMatcher.replaceFirst("\":***@\"");
                return maskUrl;
            }
            return url;
        }

        public static String getSystemTime(String dateFormat) {
            return new SimpleDateFormat(dateFormat).format(new Date());
        }

        private static boolean verifyLock(byte[] lockValue, FileObject lockObject) {
            try {
                InputStream is = lockObject.getContent().getInputStream();
                byte[] val = new byte[lockValue.length];
                // noinspection ResultOfMethodCallIgnored
                is.read(val);
                if (Arrays.equals(lockValue, val) && is.read() == -1) {
                    return true;
                } else {
                    log.debug("The lock has been acquired by an another party");
                }
            } catch (FileSystemException e) {
                log.error("Couldn't verify the lock", e);
                return false;
            } catch (IOException e) {
                log.error("Couldn't verify the lock", e);
                return false;
            }
            return false;
        }

        /**
         * Helper method to get last modified date from msgCtx
         *
         * @param msgCtx
         * @return lastModifiedDate
         */
        public static Long getLastModified(MessageContext msgCtx) {
            Object lastModified;
            Map transportHeaders = (Map) msgCtx.getProperty(MessageContext.TRANSPORT_HEADERS);
            if (transportHeaders != null) {
                lastModified = transportHeaders.get(VFSConstants.LAST_MODIFIED);
                if (lastModified != null) {
                    if (lastModified instanceof Long) {
                        return (Long)lastModified;
                    } else if (lastModified instanceof String) {
                        try {
                            return Long.parseLong((String) lastModified);
                        } catch (Exception e) {
                            log.warn("Cannot create last modified.", e);
                            return null;
                        }
                    }
                }
            }
            return null;
        }

        public synchronized static void markFailRecord(FileSystemManager fsManager, FileObject fo) {

            // generate a random fail value to ensure that there are no two parties
            // processing the same file
            byte[] failValue = (Long.toString((new Date()).getTime())).getBytes();

            try {
    	        String fullPath = fo.getName().getURI();
                int pos = fullPath.indexOf("?");
                if (pos != -1) {
                    fullPath = fullPath.substring(0, pos);
                }
                FileObject failObject = fsManager.resolveFile(fullPath + ".fail");
                if (!failObject.exists()) {
                	failObject.createFile();
                }

                 // write a lock file before starting of the processing, to ensure that the
                 // item is not processed by any other parties

                 OutputStream stream = failObject.getContent().getOutputStream();
                 try {
                     stream.write(failValue);
                     stream.flush();
                     stream.close();
                 } catch (IOException e) {
                  	 failObject.delete();
                     log.error("Couldn't create the fail file before processing the file " + maskURLPassword(fullPath), e);
                 } finally {
                 	failObject.close();
                 }
            } catch (FileSystemException fse) {
                log.error("Cannot get the lock for the file : " + maskURLPassword(fo.getName().getURI()) + " before processing");
            }
        }
        public static boolean isFailRecord(FileSystemManager fsManager, FileObject fo) {
            try {
    	    String fullPath = fo.getName().getURI();
                int pos = fullPath.indexOf("?");
                if (pos > -1) {
                    fullPath = fullPath.substring(0, pos);
                }
                FileObject failObject = fsManager.resolveFile(fullPath + ".fail");
                if (failObject.exists()) {
                	return true;
                }
            } catch (FileSystemException e) {
                log.error("Couldn't release the fail for the file : " + maskURLPassword(fo.getName().getURI()));
            }
            return false;
        }

        public static void releaseFail(FileSystemManager fsManager, FileObject fo) {
            try {
    	    String fullPath = fo.getName().getURI();
                int pos = fullPath.indexOf("?");
                if (pos > -1) {
                    fullPath = fullPath.substring(0, pos);
                }
                FileObject failObject = fsManager.resolveFile(fullPath + ".fail");
                if (failObject.exists()) {
                	failObject.delete();
                }
            } catch (FileSystemException e) {
                log.error("Couldn't release the fail for the file : " + maskURLPassword(fo.getName().getURI()));
            }
        }

        private static boolean releaseLock(byte[] bLockValue, String sLockValue, FileObject lockObject,
            Boolean autoLockReleaseSameNode, Long autoLockReleaseInterval) {
            try {
                InputStream is = lockObject.getContent().getInputStream();
                byte[] val = new byte[bLockValue.length];
                // noinspection ResultOfMethodCallIgnored
                is.read(val);
                String strVal = new String(val);
                // Lock format random:hostname:hostip:time
                String[] arrVal = strVal.split(":");
                String[] arrValNew = sLockValue.split(STR_SPLITER);
                if (arrVal.length == 4 && arrValNew.length == 4) {
                    if (!autoLockReleaseSameNode
                            || (arrVal[1].equals(arrValNew[1]) && arrVal[2].equals(arrValNew[2]))) {
                        long lInterval = 0;
                        try{
                            lInterval = Long.parseLong(arrValNew[3]) - Long.parseLong(arrVal[3]);
                        }catch(NumberFormatException nfe){}
                        if (autoLockReleaseInterval == null
                                || autoLockReleaseInterval <= lInterval) {
                            try {
                                lockObject.delete();
                            } catch (Exception e) {
                                log.warn("Unable to delete the lock file during auto release cycle.", e);
                            } finally {
                                lockObject.close();
                            }
                            return true;
                        }
                    }
                }
            } catch (FileSystemException e) {
                log.error("Couldn't verify the lock", e);
                return false;
            } catch (IOException e) {
                log.error("Couldn't verify the lock", e);
                return false;
            }
            return false;
        }

        public static Map<String, String> parseSchemeFileOptions(String fileURI, ParameterInclude params) {
            String scheme = UriParser.extractScheme(fileURI);
            if (scheme == null) {
                return null;
            }

            HashMap<String, String> schemeFileOptions = new HashMap<String, String>();
            schemeFileOptions.put(VFSConstants.SCHEME, scheme);

            try {
                addOptions(scheme, schemeFileOptions, params);
            } catch (AxisFault axisFault) {
                log.error("Error while loading VFS parameter. " + axisFault.getMessage());
            }

            return schemeFileOptions;
        }

        private static void addOptions(String scheme, Map<String, String> schemeFileOptions, ParameterInclude params) throws AxisFault {
            if (scheme.equals(VFSConstants.SCHEME_SFTP)) {
                for (VFSConstants.SFTP_FILE_OPTION option : VFSConstants.SFTP_FILE_OPTION.values()) {
                    schemeFileOptions.put(option.toString(), ParamUtils.getOptionalParam(
                            params, VFSConstants.SFTP_PREFIX + WordUtils.capitalize(option.toString())));
                }

                return;
            }
        }

        public static FileSystemOptions attachFileSystemOptions(Map<String, String> options, FileSystemManager fsManager) throws FileSystemException, InstantiationException, IllegalAccessException {
            if (options == null) {
                return null;
            }

            FileSystemOptions opts = new FileSystemOptions();
            DelegatingFileSystemOptionsBuilder delegate = new DelegatingFileSystemOptionsBuilder(fsManager);

            if (VFSConstants.SCHEME_SFTP.equals(options.get(VFSConstants.SCHEME))) {
                for (String key: options.keySet()) {
                    for (VFSConstants.SFTP_FILE_OPTION o: VFSConstants.SFTP_FILE_OPTION.values()) {
                        if (key.equals(o.toString()) && null != options.get(key)) {
                            delegate.setConfigString(opts, VFSConstants.SCHEME_SFTP, key.toLowerCase(), options.get(key));
                        }
                    }
                }
            }

            if (options.get(VFSConstants.FILE_TYPE) != null) {
                delegate.setConfigString(opts, options.get(VFSConstants.SCHEME), VFSConstants.FILE_TYPE,
                        options.get(VFSConstants.FILE_TYPE));
            }

            return opts;
        }

        /**
         * Function to resolve hostname of the vfs uri
         * @param uri URI need to resolve
         * @return hostname resolved uri
         * @throws FileSystemException Unable to decode due to malformed URI
         * @throws UnknownHostException Error occurred while resolving hostname of URI
         */
        public static String resolveUriHost (String uri) throws FileSystemException, UnknownHostException {
            return resolveUriHost(uri, new StringBuilder());
        }

        /**
         * Function to resolve the hostname of uri to ip for following vfs protocols. if not the protocol listed, return
         * same uri provided for {uri}
         * Protocols resolved : SMB
         * @param uri URI need to resolve
         * @param strBuilder string builder to use to build the resulting uri
         * @return hostname resolved uri
         * @throws FileSystemException Unable to decode due to malformed URI
         * @throws UnknownHostException Error occurred while resolving hostname of URI
         */
        public static String resolveUriHost (String uri, StringBuilder strBuilder)
                throws FileSystemException, UnknownHostException {

            if (uri != null && strBuilder != null) {
                // Extract the scheme
                String scheme = UriParser.extractScheme(uri, strBuilder);

                //need to resolve hosts of smb URIs due to limitation in jcifs library
                if (scheme != null && (scheme.equals("smb"))) {
                    // Expecting "//"
                    if (strBuilder.length() < 2 || strBuilder.charAt(0) != '/' || strBuilder.charAt(1) != '/') {
                        throw new FileSystemException("vfs.provider/missing-double-slashes.error", uri);
                    }
                    strBuilder.delete(0, 2);

                    // Extract userinfo
                    String userInfo = extractUserInfo(strBuilder);

                    // Extract hostname
                    String hostName = extractHostName(strBuilder);

                    //resolve host name
                    InetAddress hostAddress = InetAddress.getByName(hostName);
                    String resolvedHostAddress = hostAddress.getHostAddress();

                    //build resolved uri
                    StringBuilder uriStrBuilder = new StringBuilder();
                    uriStrBuilder.append(scheme).append("://");

                    if (userInfo != null) {
                        //user information can be null since it's optional
                        uriStrBuilder.append(userInfo).append("@");
                    }

                    uriStrBuilder.append(resolvedHostAddress).append(strBuilder);

                    return uriStrBuilder.toString();
                }
            }

            return uri;
        }

        /**
         * Extracts the hostname from a URI.  The scheme://userinfo@ part has
         * been removed.
         * extracted hostname will be reoved from the StringBuilder
         */
        private static String extractHostName(StringBuilder name) {
            final int maxlen = name.length();
            int pos = 0;
            for (; pos < maxlen; pos++) {
                char ch = name.charAt(pos);
                //if /;?:@&=+$, characters found means, we have passed the hostname, hence break
                if (ch == '/' || ch == ';' || ch == '?' || ch == ':'
                        || ch == '@' || ch == '&' || ch == '=' || ch == '+'
                        || ch == '$' || ch == ',') {
                    break;
                }
            }
            if (pos == 0) {
                //haven't found the hostname
                return null;
            }

            String hostname = name.substring(0, pos);
            name.delete(0, pos);
            return hostname;
        }

        /**
         * Extracts the user info from a URI.  The scheme:// part has been removed
         * already.
         * extracted user info will be removed from the StringBuilder
         */
        private static String extractUserInfo(StringBuilder name) {
            int maxlen = name.length();
            for (int pos = 0; pos < maxlen; pos++) {
                char ch = name.charAt(pos);
                if (ch == '@') {
                    // Found the end of the user info
                    String userInfo = name.substring(0, pos);
                    name.delete(0, pos + 1);
                    return userInfo;
                }
                if (ch == '/' || ch == '?') {
                    // Not allowed in user info
                    break;
                }
            }

            // Not found
            return null;
        }

        private static Integer getFileType(String fileType) {

            fileType = fileType.toUpperCase();

            if (VFSConstants.ASCII_TYPE.equals(fileType)) {
                return FTP.ASCII_FILE_TYPE;
            } else if (VFSConstants.BINARY_TYPE.equals(fileType)) {
                return FTP.BINARY_FILE_TYPE;
            } else if (VFSConstants.EBCDIC_TYPE.equals(fileType)) {
                return FTP.EBCDIC_FILE_TYPE;
            } else if (VFSConstants.LOCAL_TYPE.equals(fileType)) {
                return FTP.LOCAL_FILE_TYPE;
            } else {
                return FTP.BINARY_FILE_TYPE;
            }
        }
    }