All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.filesys.server.filesys.TreeConnection Maven / Gradle / Ivy

Go to download

Java file server with SMB, FTP/FTPS and NFS support, virtual filesystems, database filesystems

The newest version!
/*
 * Copyright (C) 2006-2010 Alfresco Software Limited.
 * Copyright (C) 2018 GK Spencer
 *
 * This file is part of Alfresco
 *
 * Alfresco 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 of the License, or
 * (at your option) any later version.
 *
 * Alfresco 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 Alfresco. If not, see .
 */

package org.filesys.server.filesys;

import org.filesys.server.SrvSession;
import org.filesys.server.auth.ISMBAuthenticator;
import org.filesys.server.auth.acl.AccessControl;
import org.filesys.server.core.DeviceContext;
import org.filesys.server.core.DeviceInterface;
import org.filesys.server.core.InvalidDeviceInterfaceException;
import org.filesys.server.core.SharedDevice;
import org.filesys.smb.server.SMBSrvSession;

import java.util.Iterator;

/**
 * The tree connection class holds the details of a single SMB tree connection. A tree connection
 * is a connection to a shared device.
 *
 * @author gkspencer
 */
public class TreeConnection {

    //	Maximum number of open files allowed per connection.
    public static final int MAXFILES = 8192;

    // Number of initial file slots to allocate. Number of allocated slots will be doubled
    // when required until MAXFILES is reached.
    public static final int INITIALFILES = 32;

    //	Shared device that the connection is associated with
    private SharedDevice m_shareDev;

    //	List of open files on this connection
    private OpenFileMap m_files;

    //	Access permission that the user has been granted
    private ISMBAuthenticator.ShareStatus m_permission;

    // Tree id, unique within a session
    private int m_treeId;

    /**
     * Construct a tree connection using the specified shared device.
     *
     * @param shrDev SharedDevice
     */
    public TreeConnection(SharedDevice shrDev) {
        m_shareDev = shrDev;
        m_shareDev.incrementConnectionCount();

        m_files = new HashedOpenFileMap();
    }

    /**
     * Construct a tree connection using the specified shared device.
     *
     * @param shrDev SharedDevice
     * @param treeId int
     */
    public TreeConnection(SharedDevice shrDev, int treeId) {
        m_shareDev = shrDev;
        m_shareDev.incrementConnectionCount();

        m_treeId = treeId;

        m_files = new HashedOpenFileMap();
    }

    /**
     * Return the tree id
     *
     * @return int
     */
    public final int getId() {
         return m_treeId;
    }

    /**
     * Add a network file to the list of open files for this connection.
     *
     * @param file NetworkFile
     * @param sess SrvSession
     * @return int
     * @exception TooManyFilesException Too many open files
     */
    public synchronized int addFile(NetworkFile file, SrvSession sess)
            throws TooManyFilesException {

        // Allocate a file id handle, and store the network file
        int handle_id = m_files.addFile( file, sess);

        //	Inform listeners that a file has been opened
        NetworkFileServer fileSrv = (NetworkFileServer) sess.getServer();
        if (fileSrv != null)
            fileSrv.fireOpenFileEvent(sess, file);

        return handle_id;
    }

    /**
     * Close the tree connection, release resources.
     *
     * @param sess SrvSession
     */
    public synchronized void closeConnection(SrvSession sess) {

        //  Make sure all files are closed
        if (openFileCount() > 0) {

            //  Close all open files
            Iterator fileIter = m_files.iterateFileHandles();

            while (fileIter.hasNext()) {

                // Get the current file id handle
                Integer fileHandle = fileIter.next();

                // Get the current open file
                NetworkFile openFile = m_files.findFile( fileHandle);

                if ( openFile != null) {

                    //  Close the file
                    try {

                        //  Access the disk interface and close the file
                        DiskInterface disk = (DiskInterface) m_shareDev.getInterface();
                        openFile.setForce(true);
                        disk.closeFile(sess, this, openFile);
                        openFile.setClosed(true);
                    }
                    catch (Exception ex) {
                    }
                }
            }

            // Remove all the open files
            m_files.removeAllFiles();
        }

        //	Decrement the active connection count for the shared device
        m_shareDev.decrementConnectionCount();
    }

    /**
     * Return the specified network file.
     *
     * @param fid int
     * @return NetworkFile
     */
    public synchronized NetworkFile findFile(int fid) {
        return m_files.findFile( fid);
    }

    /**
     * Determine if the shared device has an associated context
     *
     * @return boolean
     */
    public final boolean hasContext() {
        if (m_shareDev != null)
            return m_shareDev.getContext() != null;
        return false;
    }

    /**
     * Return the interface specific context object.
     *
     * @return Device interface context object.
     */
    public final DeviceContext getContext() {
        if (m_shareDev == null)
            return null;
        return m_shareDev.getContext();
    }

    /**
     * Return the share access permissions that the user has been granted.
     *
     * @return ShareStatus
     */
    public final ISMBAuthenticator.ShareStatus getPermission() {
        return m_permission;
    }

    /**
     * Deterimine if the access permission for the shared device allows read access
     *
     * @return boolean
     */
    public final boolean hasReadAccess() {
        if (m_permission == ISMBAuthenticator.ShareStatus.READ_ONLY ||
                m_permission == ISMBAuthenticator.ShareStatus.WRITEABLE)
            return true;
        return false;
    }

    /**
     * Determine if the access permission for the shared device allows write access
     *
     * @return boolean
     */
    public final boolean hasWriteAccess() {
        if (m_permission == ISMBAuthenticator.ShareStatus.WRITEABLE)
            return true;
        return false;
    }

    /**
     * Return the shared device that this tree connection is using.
     *
     * @return SharedDevice
     */
    public final SharedDevice getSharedDevice() {
        return m_shareDev;
    }

    /**
     * Return the shared device interface
     *
     * @return DeviceInterface
     */
    public final DeviceInterface getInterface() {
        if (m_shareDev == null)
            return null;
        try {
            return m_shareDev.getInterface();
        }
        catch (InvalidDeviceInterfaceException ex) {
        }
        return null;
    }

    /**
     * Return the count of open files on this tree connection.
     *
     * @return int
     */
    public synchronized int openFileCount() {
        return m_files.openFileCount();
    }

    /**
     * Iterate the open file handles
     *
     * @return Iterator<Integer>
     */
    public final Iterator iterateOpenFileHandles() {
        return m_files.iterateFileHandles();
    }

    /**
     * Remove all files from the tree connection.
     */
    public synchronized final void removeAllFiles() {
        m_files.removeAllFiles();
    }

    /**
     * Remove a network file from the list of open files for this connection.
     *
     * @param fid  int
     * @param sess SrvSession
     */
    public synchronized void removeFile(int fid, SrvSession sess) {

        // Remove the file
        NetworkFile netFile = m_files.removeFile( fid, sess);

        if ( netFile != null) {

            //	Inform listeners of the file closure
            NetworkFileServer fileSrv = (NetworkFileServer) sess.getServer();
            if (fileSrv != null)
                fileSrv.fireCloseFileEvent(sess, netFile);
        }
    }

    /**
     * Set the access permission for this share that the user has been granted.
     *
     * @param perm ShareStatus
     */
    public final void setPermission(ISMBAuthenticator.ShareStatus perm) {
        m_permission = perm;
    }

    /**
     * Set the access permission for this share by mapping from an ACL permission
     *
     * @param aclPerm int
     */
    public final void setPermission(int aclPerm) {
        switch ( aclPerm) {
            case AccessControl.NoAccess:
                m_permission = ISMBAuthenticator.ShareStatus.NO_ACCESS;
                break;
            case AccessControl.ReadOnly:
                m_permission = ISMBAuthenticator.ShareStatus.READ_ONLY;
                break;
            case AccessControl.ReadWrite:
                m_permission = ISMBAuthenticator.ShareStatus.WRITEABLE;
                break;
        }
    }

    /**
     * Return the tree connection as a string.
     *
     * @return String
     */
    public String toString() {
        StringBuffer str = new StringBuffer();
        str.append("[");
        str.append(m_shareDev.toString());
        str.append(", id=");
        str.append(getId());
        str.append(", fileCnt=");
        str.append(openFileCount());
        str.append(", perm=");
        str.append(m_permission.name());
        str.append("]");
        return str.toString();
    }

    /**
     * Dump the open file list
     *
     * @param sess SMBSrvSession
     */
    public final void dumpOpenFiles(SMBSrvSession sess) {

        // Dump the open file list
        sess.debugPrintln("Dump open files:");

        Iterator iterHandles = iterateOpenFileHandles();

        while ( iterHandles.hasNext()) {

            // Get the next file handle
            Integer handle = iterHandles.next();
            NetworkFile netFile = findFile( handle);

            if ( netFile != null)
                sess.debugPrintln("  " + handle + ": " + netFile);
        }
    }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy