Changeset 716

Timestamp:

Jun 2, 2008, 2:29:02 PM (15 years ago)

Author:

Nicklas Nordborg

Message:

References #114: Implement FTP Server

Cleaned up code and documentation. Added lots of debugging/logging. Added license text to source files.

Location:

extensions/net.sf.basedb.ftp/trunk

Files:

• META-INF/extensions.xml (modified) (1 diff)
• build.xml (modified) (1 diff)
• ftp.config (modified) (3 diffs)
• src/net/sf/basedb/clients/ftp/BaseFileObject.java (modified) (24 diffs)
• src/net/sf/basedb/clients/ftp/BaseFileSystem.java (modified) (4 diffs)
• src/net/sf/basedb/clients/ftp/BaseFileSystemView.java (modified) (14 diffs)
• src/net/sf/basedb/clients/ftp/BaseFtpServer.java (modified) (9 diffs)
• src/net/sf/basedb/clients/ftp/BaseFtplet.java (modified) (5 diffs)
• src/net/sf/basedb/clients/ftp/BaseUser.java (modified) (12 diffs)
• src/net/sf/basedb/clients/ftp/BaseUserManager.java (modified) (4 diffs)
• src/net/sf/basedb/clients/ftp/FtpServiceController.java (modified) (4 diffs)
• src/net/sf/basedb/clients/ftp/FtpServiceControllerFactory.java (modified) (5 diffs)
• src/net/sf/basedb/clients/ftp/TransactionalOutputStream.java (modified) (2 diffs)

extensions/net.sf.basedb.ftp/trunk/META-INF/extensions.xml

@@ -1 +1 @@
 <?xml version="1.0" encoding="UTF-8" ?>
+<!-- 
+  $Id $
+
+  Copyright (C) 2008 Nicklas Nordborg
+
+  This file is part of FTP extension for BASE.
+  Available at http://baseplugins.thep.lu.se/
+
+  BASE is free software; you can redistribute it and/or
+  modify it under the terms of the GNU General Public License
+  as published by the Free Software Foundation; either version 2
+  of the License, or (at your option) any later version.
+
+  BASE 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 General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with this program; if not, write to the Free Software
+  Foundation, Inc., 59 Temple Place - Suite 330,
+  Boston, MA  02111-1307, USA.
+-->
 <extensions xmlns="http://base.thep.lu.se/extensions.xsd">
   <about>

extensions/net.sf.basedb.ftp/trunk/build.xml

@@ -1 +1 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+  $Id $
+
+  Copyright (C) 2008 Nicklas Nordborg
+
+  This file is part of FTP extension for BASE.
+  Available at http://baseplugins.thep.lu.se/
+
+  BASE is free software; you can redistribute it and/or
+  modify it under the terms of the GNU General Public License
+  as published by the Free Software Foundation; either version 2
+  of the License, or (at your option) any later version.
+
+  BASE 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 General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with this program; if not, write to the Free Software
+  Foundation, Inc., 59 Temple Place - Suite 330,
+  Boston, MA  02111-1307, USA.
+-->
 <project 
   name="MevLauncher" 

extensions/net.sf.basedb.ftp/trunk/ftp.config

@@ +1 @@
+# $Id $
+#
+# Copyright (C) 2008 Nicklas Nordborg
+#
+# This file is part of FTP extension for BASE.
+# Available at http://baseplugins.thep.lu.se/
+#
+# BASE is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# BASE 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place - Suite 330,
+# Boston, MA  02111-1307, USA.
+# -------------------------------------------------------------
 # Licensed to the Apache Software Foundation (ASF) under one
 # or more contributor license agreements.  See the NOTICE file
@@ -58 +80 @@
 
 ##-----------------------------------------------------------------------------
+## BASE User manager configuration
+## Class name is hardcoded into the API and is displayed here just for reference
+##-----------------------------------------------------------------------------
+#config.user-manager.class=net.sf.basedb.clients.ftp.BaseUserManager
+#config.user-manager.max-download-rate=0
+#config.user-manager.max-upload-rate=0
+
+
+##-----------------------------------------------------------------------------
 ## Ftp message configuration block
 ##-----------------------------------------------------------------------------
@@ -71 +102 @@
 config.connection-manager.max-login=10
 config.connection-manager.anonymous-login-enabled=false
-#config.connection-manager.max-anonymous-login=10
 config.connection-manager.default-idle-time=60
 config.connection-manager.timeout-poll-inverval=60

extensions/net.sf.basedb.ftp/trunk/src/net/sf/basedb/clients/ftp/BaseFileObject.java

@@ +1 @@
+/**
+  $Id $
+
+  Copyright (C) 2008 Nicklas Nordborg
+
+  This file is part of FTP extension for BASE.
+  Available at http://baseplugins.thep.lu.se/
+
+  BASE is free software; you can redistribute it and/or
+  modify it under the terms of the GNU General Public License
+  as published by the Free Software Foundation; either version 2
+  of the License, or (at your option) any later version.
+
+  BASE 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 General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with this program; if not, write to the Free Software
+  Foundation, Inc., 59 Temple Place - Suite 330,
+  Boston, MA  02111-1307, USA.
+*/
 package net.sf.basedb.clients.ftp;
 
@@ -19 +42 @@
 import net.sf.basedb.core.query.Orders;
 
+import org.apache.ftpserver.filesystem.NativeFileObject;
 import org.apache.ftpserver.ftplet.FileObject;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 /**
@@ -29 +55 @@
     a directory (MKDIR) or file (STOR)
   </ol>
+  @author Nicklas
+  @version 1.0
 */
 public class BaseFileObject 
   implements FileObject 
 {
+  private static final Logger log = LoggerFactory.getLogger(BaseFileObject.class);
 
   private BaseUser user;
@@ -77 +106 @@
     this.name = path.substring(path.lastIndexOf('/')+1);
     this.owner = user.getName();
-    
   }
   
@@ -147 +175 @@
 
   /**
-    3 for directories, 1 for files (TODO - I don't understand why!)
+    3 for directories, 1 for files (TODO - I don't understand why, but this is how
+    the {@link NativeFileObject} object does it).
   */
   @Override
@@ -171 +200 @@
 
   /**
-    If it is a file, get it's last update time, if it is a
-    directory, return the current time, otherwise, return 0.
+    If it is a file, get it's last update time. 
+    If it is a directory, return the current time.
+    Otherwise, return 0.
   */
   @Override
@@ -243 +273 @@
   public FileObject[] listFiles() 
   {
+    if (log.isDebugEnabled())
+    {
+      log.debug("List files");
+      log.debug("   dir=" + this);
+    }
     if (directory == null) return null;
     
@@ -253 +288 @@
       dirQuery.order(Orders.asc(Hql.property("name")));
       dirQuery.include(Include.ALL);
-      dirQuery.exclude(Include.REMOVED);
       for (Directory dir : dirQuery.list(dc))
       {
@@ -262 +296 @@
       fileQuery.order(Orders.asc(Hql.property("name")));
       fileQuery.include(Include.ALL);
-      fileQuery.exclude(Include.REMOVED);
       for (File file : fileQuery.list(dc))
       {
@@ -268 +301 @@
       }
     }
+    catch (RuntimeException ex)
+    {
+      log.error("Could not list files in directory: " + this, ex);
+      throw ex;
+    }
     finally
     {
       if (dc != null) dc.close();
+    }
+    if (log.isDebugEnabled())
+    {
+      log.debug("List files ok: size=" + all.size());
     }
     return all.toArray(new FileObject[all.size()]);
@@ -282 +324 @@
   public boolean mkdir() 
   {
+    if (log.isDebugEnabled())
+    {
+      log.debug("Make directory");
+      log.debug("   dir=" + this);
+    }
     if (file != null || directory != null) return false;
     if (!user.sc.hasPermission(Permission.CREATE, Item.DIRECTORY)) return false;
@@ -292 +339 @@
       dc.commit();
     }
+    catch (RuntimeException ex)
+    {
+      log.error("Could not create directory: " + this, ex);
+      throw ex;
+    }
     finally
     {
       if (dc != null) dc.close();
+    }
+    if (log.isDebugEnabled())
+    {
+      log.debug("Make directory ok: " + this);
     }
     return true;
@@ -306 +362 @@
   public boolean delete() 
   {
+    if (log.isDebugEnabled())
+    {
+      log.debug("Delete");
+      log.debug("   file/dir=" + this);
+    }
     if (!hasDeletePermission()) return false;
     
@@ -322 +383 @@
       }
       dc.commit();
+      file = null;
+      directory = null;
+    }
+    catch (RuntimeException ex)
+    {
+      log.error("Could not delete file/directory: " + this, ex);
+      throw ex;
     }
     finally
@@ -327 +395 @@
       if (dc != null) dc.close();
     }
+    if (log.isDebugEnabled())
+    {
+      log.debug("Delete ok: " + this);
+    }
     return true;
   }
@@ -336 +408 @@
   public boolean move(FileObject dest)
   {
+    if (log.isDebugEnabled())
+    {
+      log.debug("Move");
+      log.debug("   this=" + this);
+      log.debug("   dest=" + dest);
+    }
     if (!doesExist() || dest.doesExist()) return false;
     DbControl dc = user.sc.newDbControl();
@@ -341 +419 @@
     {
       Directory newParentDir = null;
+      // Do we need to change the parent directory?
+      // If we don't have to we should not call File.setDirectory since it
+      // may cause a PermissionDeniedException
       if (!hasSameParentDirectory(this, dest))
       {
@@ -346 +427 @@
         newParentDir = Directory.getByPath(dc, to.getParent());
       }
-      System.out.println("new parent=" + newParentDir);
+      if (log.isDebugEnabled())
+      {
+        log.debug("   new parent directory=" + newParentDir);
+      }
       if (file != null)
       {
@@ -361 +445 @@
       dc.commit();
     }
+    catch (RuntimeException ex)
+    {
+      log.error("Could not move: " + this + " --> " + dest, ex);
+      throw ex;
+    }
     finally
     {
       if (dc != null) dc.close();
+    }
+    if (log.isDebugEnabled())
+    {
+      log.debug("Move ok: " + this + " --> " + dest);
     }
     return true;
@@ -373 +466 @@
     throws IOException 
   {
+    if (log.isDebugEnabled())
+    {
+      log.debug("Reading from file " + this + "[offset="+offset + "]");
+    }
     if (file == null)
     {
@@ -390 +487 @@
     throws IOException 
   {
+    if (log.isDebugEnabled())
+    {
+      log.debug("Writing to file " + this + "[offset="+offset + "]");
+    }
     if (directory != null) return null;
     
-    System.out.println("Create output stream. offset="+offset);
     OutputStream upload = null;
     DbControl dc = user.sc.newDbControl();
@@ -409 +509 @@
         offset = 0;
       }
+      
+      if (log.isDebugEnabled())
+      {
+        log.debug("Uploading to BASE file: " + file);
+      }
+      
       file.setMimeTypeAuto(null, null);
       InputStream in = offset > 0 ? file.getDownloadStream(0) : null;
       
       // The TransactionOutputStream will make sure DbControl is committed
-      upload = new TransactionalOutputStream(dc, file.getUploadStream(false));
+      upload = new TransactionalOutputStream(dc, file.getUploadStream(false), toString());
       if (in != null)
       {
-        while (offset > 0)
+        long remain = offset;
+        while (remain > 0)
         {
           int b = in.read();
-          if (b != -1) upload.write(b);
-          offset--;
+          if (b == -1) break;
+          upload.write(b);
+          remain--;
         }
         in.close();
+        log.debug((offset - remain) + " bytes copied from existing file");
       }
       dc.disconnect();
@@ -428 +537 @@
     catch (RuntimeException ex)
     {
+      log.error("Could not create upload stream to " + this, ex);
       if (dc != null) dc.close();
       throw ex;
@@ -434 +544 @@
   }
   // -------------------------------------------
+  
+  /*
+    From the Object class
+    ---------------------
+  */
+  @Override
+  public String toString() 
+  {
+    String type = "path";
+    if (file != null) 
+    {
+      type = "file";
+    }
+    else if (directory != null) 
+    {
+      type = "dir";
+    }
+    return "BaseFileObject[" + type + "=" + path + "]";
+  }
+  // -------------------------------------------
+  
   
   private String getOwner(OwnedItem item)

extensions/net.sf.basedb.ftp/trunk/src/net/sf/basedb/clients/ftp/BaseFileSystem.java

@@ +1 @@
+/**
+  $Id $
+
+  Copyright (C) 2008 Nicklas Nordborg
+
+  This file is part of FTP extension for BASE.
+  Available at http://baseplugins.thep.lu.se/
+
+  BASE is free software; you can redistribute it and/or
+  modify it under the terms of the GNU General Public License
+  as published by the Free Software Foundation; either version 2
+  of the License, or (at your option) any later version.
+
+  BASE 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 General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with this program; if not, write to the Free Software
+  Foundation, Inc., 59 Temple Place - Suite 330,
+  Boston, MA  02111-1307, USA.
+*/
 package net.sf.basedb.clients.ftp;
 
@@ -8 +31 @@
 /**
   Implements the file system manager for BASE.
+  @author Nicklas
+  @version 1.0
 */
 public class BaseFileSystem 
@@ -13 +38 @@
 {
 
+  /**
+    Creates the file system manager.
+  */
+  public BaseFileSystem()
+  {}
+  
+  /*
+    From the FileSystemManager interface
+    ------------------------------------
+  */
   @Override
   public FileSystemView createFileSystemView(User user) 
@@ -19 +54 @@
     return new BaseFileSystemView((BaseUser)user);
   }
+  // ---------------------------------------
 
 }

extensions/net.sf.basedb.ftp/trunk/src/net/sf/basedb/clients/ftp/BaseFileSystemView.java

@@ +1 @@
+/**
+  $Id $
+
+  Copyright (C) 2008 Nicklas Nordborg
+
+  This file is part of FTP extension for BASE.
+  Available at http://baseplugins.thep.lu.se/
+
+  BASE is free software; you can redistribute it and/or
+  modify it under the terms of the GNU General Public License
+  as published by the Free Software Foundation; either version 2
+  of the License, or (at your option) any later version.
+
+  BASE 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 General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with this program; if not, write to the Free Software
+  Foundation, Inc., 59 Temple Place - Suite 330,
+  Boston, MA  02111-1307, USA.
+*/
 package net.sf.basedb.clients.ftp;
 
@@ -9 +32 @@
 import org.apache.ftpserver.ftplet.FileSystemView;
 import org.apache.ftpserver.ftplet.FtpException;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 /**
@@ -14 +39 @@
   Users will start out in their home directory if they have one, otherwise in
   the root.
+  
+  @author Nicklas
+  @version 1.0
 */
 public class BaseFileSystemView 
@@ -19 +47 @@
 {
 
+  private static final Logger log = LoggerFactory.getLogger(BaseFileSystemView.class);
+
   private BaseUser user;
-  
   private BaseFileObject currentDir;
   
+  /**
+    Create a new file system view for the specified user.
+  */
   public BaseFileSystemView(BaseUser user)
   {
@@ -38 +70 @@
     throws FtpException 
   {
-    System.out.println("gcd: current=" + currentDir.getFullName());
+    if (log.isDebugEnabled()) log.debug("Current directory: " + currentDir);
     return currentDir;
   }
@@ -56 +88 @@
     throws FtpException 
   {
-    System.out.println("cd: " + path);
+    if (log.isDebugEnabled()) 
+    {
+      log.debug("Change directory");
+      log.debug("   path=" + path);
+      log.debug("   current="+currentDir);
+      log.debug("   user=" + user);
+    }
     Path changeTo = null;
     if (path.startsWith("/"))
@@ -73 +111 @@
       changeTo = new Path(append(currentDir.getFullName(), path), Path.Type.DIRECTORY);
     }
+    if (log.isDebugEnabled()) 
+    {
+      log.debug("   to="+changeTo);
+    }
     DbControl dc = user.sc.newDbControl();
     try
     {
       currentDir = new BaseFileObject(user, Directory.getByPath(dc, changeTo));
+      log.debug("Directory changed to: " + currentDir);
       return true;
     }
     catch (RuntimeException ex)
     {
-      ex.printStackTrace();
+      log.error("Could not change to directory: " + path, ex);
       return false;
     }
@@ -126 +169 @@
     throws FtpException 
   {
-    System.out.println("gfo: " + fileName);
+    if (log.isDebugEnabled()) 
+    {
+      log.debug("Get file object");
+      log.debug("   name=" + fileName);
+      log.debug("   current="+currentDir);
+      log.debug("   user=" + user);
+    }
     if (fileName.startsWith("./"))
     {
@@ -137 +186 @@
     
     BaseFileObject fo = null;
-    
     DbControl dc = user.sc.newDbControl();
     try
     {
-      // Try to get a file
+      if (log.isDebugEnabled()) 
+      {
+        log.debug("   full path=" + fileName);
+      }
+      
+      // Check if the path represents a file
       try
       {
@@ -149 +202 @@
       }
       catch (Exception ex)
-      {}
+      {
+        if (log.isDebugEnabled())
+        {
+          log.debug("Not a file: " + fileName, ex);
+        }
+      }
 
       if (fo == null)
       {
-        // Try to get a directory
+        // Check if the path represents a directory
         try
         {
@@ -161 +219 @@
         }
         catch (Exception ex)
-        {}
+        {
+          if (log.isDebugEnabled())
+          {
+            log.debug("Not a directory: " + fileName, ex);
+          }
+        }
       }
     }
@@ -169 +232 @@
     }
     if (fo == null) fo = new BaseFileObject(user, fileName);
+    if (log.isDebugEnabled())
+    {
+      log.debug("Get file object: " + fo);
+    }
     return fo;
   }
+
+  @Override
+  public FileObject getHomeDirectory() 
+    throws FtpException 
+  {
+    return user.getHome();
+  }
   // ----------------------------------------
-
-  @Override
-  public FileObject getHomeDirectory() 
-    throws FtpException 
-  {
-    return user.getHome();
-  }
 
   /**
@@ -187 +254 @@
   private String append(String path1, String path2)
   {
-    System.out.println("append: p1=" + path1 + "; p2=" + path2);
     boolean atEnd = path1.endsWith("/");
     boolean atStart = path2.startsWith("/");
@@ -209 +275 @@
       result = result.substring(0, result.length() - 1);
     }
-    System.out.println("append: " + result);
+    if (log.isDebugEnabled())
+    {
+      log.debug("append: path1=" + path1 + "; path2=" + path2 + "; result=" + result);
+    }
     return result;
   }

extensions/net.sf.basedb.ftp/trunk/src/net/sf/basedb/clients/ftp/BaseFtpServer.java

@@ +1 @@
+/**
+  $Id $
+
+  Copyright (C) 2008 Nicklas Nordborg
+
+  This file is part of FTP extension for BASE.
+  Available at http://baseplugins.thep.lu.se/
+
+  BASE is free software; you can redistribute it and/or
+  modify it under the terms of the GNU General Public License
+  as published by the Free Software Foundation; either version 2
+  of the License, or (at your option) any later version.
+
+  BASE 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 General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with this program; if not, write to the Free Software
+  Foundation, Inc., 59 Temple Place - Suite 330,
+  Boston, MA  02111-1307, USA.
+*/
 package net.sf.basedb.clients.ftp;
 
 import java.util.EnumSet;
+import java.util.Iterator;
 import java.util.Properties;
 
@@ -8 +32 @@
 import org.apache.ftpserver.config.PropertiesConfiguration;
 import org.apache.ftpserver.ftplet.Configuration;
+import org.apache.ftpserver.ftplet.FtpException;
 import org.apache.ftpserver.ftplet.Ftplet;
 import org.apache.ftpserver.interfaces.FtpServerContext;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import net.sf.basedb.core.Application;
@@ -22 +49 @@
 import net.sf.basedb.core.SystemItems;
 
+/**
+  The main FTP Server class for BASE. It encapsulates the
+  {@link FtpServer} from Apache, and forces some BASE-specific
+  configuration settings. Eg.
+
+  <ul>
+  <li>User manager: {@link BaseUserManager}
+  <li>File system manager: {@link BaseFileSystem}
+  <li>Ftplet: {@link BaseFtplet}
+  <li>Anonymous login is disabled
+  </ul>
+  
+  This class also has some utility method for checking if the
+  <code>net.sf.basedb.clients.ftp</code> {@link Client} has been
+  registered in BASE. If not, only the root user is allowed to connect,
+  but once the root user does that, the ftp client is automatically
+  registereded and made available to everyone.
+  
+  @author Nicklas
+  @version 1.0
+*/
 public class BaseFtpServer 
 {
 
+  private static final Logger log = LoggerFactory.getLogger(BaseFtpServer.class);
+  
+  /**
+    The {@link Client#getExternalId()} for FTP server.
+  */
   public static final String CLIENT_ID = "net.sf.basedb.clients.ftp";
-  
-  public static BaseFtpServer DEFAULT;
   
   /**
@@ -34 +85 @@
     @return TRUE if the FTP server is registered, FALSE otherwise
   */
-  public static boolean isClientInstalled()
+  public static boolean isRegisteredAsClient()
   {
     boolean installed = false;
@@ -44 +95 @@
     }
     catch (ItemNotFoundException ex)
-    {}
+    {
+      log.info("FTP Server is not registered as BASE client application", ex);
+    }
     return installed;
   }
   
-  public static void installClient(SessionControl sc)
+  /**
+    Register the FTP server as a client application in BASE. The 
+    application will be shared to {@link Group#EVERYONE}.
+    @param sc The session control of a logged in user which must have
+      permissions to create a {@link Client} item
+  */
+  public static void registerAsClient(SessionControl sc)
   {
     Client client = null;
@@ -55 +114 @@
     {
       client = Client.getByExternalId(dc, CLIENT_ID);
+      log.info("FTP Server is already registered as BASE client application");
     }
     catch (ItemNotFoundException ex)
     {
+      log.info("Registering FTP Server as BASE client application with ID:" + CLIENT_ID);
       Group everyone = Group.getById(dc, SystemItems.getId(Group.EVERYONE));
       GroupPermissions gp = new GroupPermissions();
@@ -69 +130 @@
       dc.saveItem(client);
       dc.commit();
+      log.info("FTP Server successfully registered as BASE client application");
     }
     finally
@@ -79 +141 @@
   private FtpServer server;
   
+  /**
+    Create a new FTP Server. The configuration properties will be copied and
+    BASE-specific settings as described in the class documentation will be 
+    added. To start the FTP server call {@link #start()}.
+    
+    @param config The configuration settings
+    @throws Exception If there is any problem
+  */
   public BaseFtpServer(Properties config)
     throws Exception
   {
     this.config = setPropertiesRequiredByBase(config);
-    start();
-  }
-  
-  private Configuration setPropertiesRequiredByBase(Properties config)
-  {
-    Properties cfg = (Properties)config.clone();
-    cfg.setProperty("config.create-default-user", "false");
-    cfg.setProperty("config.user-manager.class", "net.sf.basedb.clients.ftp.BaseUserManager");
-    cfg.setProperty("config.file-system-manager.class", "net.sf.basedb.clients.ftp.BaseFileSystem");
-    return new PropertiesConfiguration(cfg);
-  }
-  
+  }
+
+  /**
+    Checks if the FTP Server is running.
+  */
   public boolean isRunning()
   {
     return server != null && !server.isStopped() && !server.isSuspended();
   }
-  
+
+  /**
+    Starts the FTP server if it is not already running.
+  */
   public void start()
   {
     if (isRunning()) return;
+    log.info("Starting BASE FTP Server");
+    if (log.isDebugEnabled())
+    {
+      Iterator<String> keys = config.getKeys();
+      while (keys.hasNext())
+      {
+        String key = keys.next();
+        try
+        {
+          log.debug(key + "=" + config.getString(key));
+        }
+        catch (FtpException ex)
+        {} // Should never happen
+      }
+    }
     try
     {
@@ -114 +195 @@
     catch (Exception ex)
     {
+      log.error("Could not start FTP Server", ex);
       throw new RuntimeException(ex);
     }
-  }
-  
+    log.info("BASE FTP Server has been started");
+  }
+  
+  /**
+    Stop the FTP server.
+  */
   public void stop()
   {
-    if (!isRunning()) return;
-    server.stop();
-    server = null;
-  }
+    log.info("Stopping BASE FTP Server");
+    if (server != null)
+    {
+      server.stop();
+      server = null;
+    }
+    log.info("BASE FTP Server has been stopped");
+  }
+
+  /**
+    Makes a copy of the properties and set BASE-specific ones. Returned
+    as a {@link Configuration} object.
+  */
+  private Configuration setPropertiesRequiredByBase(Properties config)
+  {
+    Properties cfg = (Properties)config.clone();
+    cfg.setProperty("config.create-default-user", "false");
+    cfg.setProperty("config.connection-manager.anonymous-login-enabled", "false");
+    cfg.setProperty("config.user-manager.class", "net.sf.basedb.clients.ftp.BaseUserManager");
+    cfg.setProperty("config.file-system-manager.class", "net.sf.basedb.clients.ftp.BaseFileSystem");
+    if (log.isDebugEnabled())
+    {
+      log.debug("Creating new FTP Server configuration");
+      for (Object key : cfg.keySet())
+      {
+        log.debug(key + "=" + cfg.getProperty(key.toString()));
+      }
+    }
+    return new PropertiesConfiguration(cfg);
+  }
+  
   
 }

extensions/net.sf.basedb.ftp/trunk/src/net/sf/basedb/clients/ftp/BaseFtplet.java

@@ +1 @@
+/**
+  $Id $
+
+  Copyright (C) 2008 Nicklas Nordborg
+
+  This file is part of FTP extension for BASE.
+  Available at http://baseplugins.thep.lu.se/
+
+  BASE is free software; you can redistribute it and/or
+  modify it under the terms of the GNU General Public License
+  as published by the Free Software Foundation; either version 2
+  of the License, or (at your option) any later version.
+
+  BASE 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 General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with this program; if not, write to the Free Software
+  Foundation, Inc., 59 Temple Place - Suite 330,
+  Boston, MA  02111-1307, USA.
+*/
 package net.sf.basedb.clients.ftp;
 
@@ -6 +29 @@
 import org.apache.ftpserver.ftplet.FtpException;
 import org.apache.ftpserver.ftplet.FtpSession;
+import org.apache.ftpserver.ftplet.Ftplet;
 import org.apache.ftpserver.ftplet.FtpletEnum;
 import org.apache.ftpserver.ftplet.User;
-
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 /**
   We need this ftplet to catch disconnection events and logout the
-  logged in user from BASE.
-  @see {@link #onDisconnect(FtpSession)}
+  logged in user from BASE. We extend the {@link DefaultFtplet} 
+  which is just an empty implementation so we don't have to implement
+  all methods in the {@link Ftplet} interface.
+  
+  @author Nicklas
+  @version 1.0
 */
 public class BaseFtplet 
@@ -19 +48 @@
 {
 
+  private static final Logger log = LoggerFactory.getLogger(BaseFtplet.class);
+
   public BaseFtplet()
   {}
 
+  /*
+    From the Ftplet interface
+    -------------------------
+  */
   /**
     If a BASE user is currently logged in, log out.
@@ -29 +64 @@
     throws FtpException, IOException 
   {
-    System.out.println("onDisconnect: " + session);
+    log.debug("Disconnecting: ip=" + session.getClientAddress());
     User user = session.getUser();
-    System.out.println("onDisconnect: " + user);
+    log.debug("Disconnecting: user=" + user);
     if (user instanceof BaseUser)
     {
@@ -38 +73 @@
     return super.onDisconnect(session);
   }
+
+  /**
+    We just log connections at DEBUG level.
+  */
+  @Override
+  public FtpletEnum onConnect(FtpSession session)
+    throws FtpException, IOException 
+  {
+    if (log.isDebugEnabled())
+    {
+      log.debug("New connection from: " + session.getClientAddress());
+      log.debug("Server address: " + session.getServerAddress() + ":" + session.getServerPort());
+    }
+    return super.onConnect(session);
+  }
+  // -------------------------------------
+  
   
 }

extensions/net.sf.basedb.ftp/trunk/src/net/sf/basedb/clients/ftp/BaseUser.java

@@ +1 @@
+/**
+  $Id $
+
+  Copyright (C) 2008 Nicklas Nordborg
+
+  This file is part of FTP extension for BASE.
+  Available at http://baseplugins.thep.lu.se/
+
+  BASE is free software; you can redistribute it and/or
+  modify it under the terms of the GNU General Public License
+  as published by the Free Software Foundation; either version 2
+  of the License, or (at your option) any later version.
+
+  BASE 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 General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with this program; if not, write to the Free Software
+  Foundation, Inc., 59 Temple Place - Suite 330,
+  Boston, MA  02111-1307, USA.
+*/
 package net.sf.basedb.clients.ftp;
 
@@ -6 +29 @@
 import org.apache.ftpserver.ftplet.Authority;
 import org.apache.ftpserver.ftplet.AuthorizationRequest;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import net.sf.basedb.core.Application;
@@ -19 +44 @@
   a user that has not yet logged in, so we don't
   know if the user exists or not.
+  @author Nicklas
+  @version 1.0
 */
 public class BaseUser 
@@ -24 +51 @@
 {
 
+  private static final Logger log = LoggerFactory.getLogger(BaseUser.class);
+
   private final String login;
   private final Authority[] authorities;
@@ -31 +60 @@
   private BaseFileObject home;
   
+  /**
+    Creates a new, not yet logged in, user object.
+    
+    @param login The login of the user
+    @param authorities The permissions of the user
+  */
   public BaseUser(String login, Authority[] authorities)
   {
@@ -85 +120 @@
   }
   
+  /**
+    Checks if the permissions for a user contains the requested
+    permission. This method returns the <code>request</code>
+    parameter if there is at least one permission that can
+    authorize the request ({@link Authority#canAuthorize(AuthorizationRequest)}
+    and all that can must accept it ({@link Authority#authorize(AuthorizationRequest)}).
+    <p>
+    If there is no permission that accepts the request, null is
+    returned.
+  */
   @Override
   public AuthorizationRequest authorize(AuthorizationRequest request) 
   {
-    System.out.println("authorize(): login=" +login + "; request=" + request);
+    boolean debug = log.isDebugEnabled();
+    if (debug)
+    {
+      log.debug("Trying to authorize: login=" + login + "; request="+request);
+    }
     boolean authorized = false;
     /*
@@ -100 +149 @@
       if (auth.canAuthorize(request))
       {
-        if (auth.authorize(request) == null) return null;
+        if (debug) log.debug("Can authorize: auth=" + auth);
+        if (auth.authorize(request) == null) 
+        {
+          if (debug) log.debug("Permission denied: auth=" + auth + "; request=" + request);
+          return null;
+        }
+        if (debug) log.debug("Accepted: auth=" + auth + "; request=" + request);
         authorized = true;
       }
+      else
+      {
+        if (debug) log.debug("Can't authorize: auth=" + auth);
+      }
+    }
+    if (debug)
+    {
+      log.debug(authorized ? "Accepted: " + request : "Permission denied: " + request);
     }
     return authorized ? request : null;
@@ -113 +176 @@
   }
 
-  /**
-    For now, return an empty array. It seems like this method is never
-    called from the FTP server core.
-  */
   @Override
   public Authority[] getAuthorities(Class<Authority> clazz) 
@@ -132 +191 @@
   // ------------------------
   
+  /*
+    From the Object class
+    ---------------------
+  */
+  @Override
+  public String toString() 
+  {
+    return "BaseUser[login=" + login + "]";
+  }
+  // ------------------------
+  
+  
   /**
     Check if this object represents a logged in user
@@ -149 +220 @@
   {
     if (isLoggedIn()) return;
-    System.out.println("login: " + login);
+    log.info("Trying to login: " + login + "; ip="+remoteId);
+    log.debug("Password:" + password);
     SessionControl sc = Application.newSessionControl(clientId, remoteId, null);
     sc.login(login, password, null, false);
-    System.out.println("login: ID=" + sc.getId());
+    log.debug("Login ok, loading user info and home directory. SessionID=" + sc.getId());
     
     // Login was ok
@@ -158 +230 @@
     if (clientId == null && sc.getLoggedInUserId() != SystemItems.getId(User.ROOT))
     {
+      log.warn("FTP Server not registered, only ROOT is allowed to login");
       throw new PermissionDeniedException("Only root is allowed to login");
     }
@@ -174 +247 @@
       this.home = new BaseFileObject(this, homeDir);
     }
+    catch (RuntimeException ex)
+    {
+      log.error("Failed to load user info and home directory: login=" + login, ex);
+      throw ex;
+    }
     finally
     {
       if (dc != null) dc.close();
     }
-  }
-  
-  /**
-    Logout and close the 
-   */
+    log.debug("Login complete: login="+login);
+  }
+  
+  /**
+    Logout and close the session.
+  */
   public void logout()
   {
     if (sc != null)
     {
-      System.out.println("logout: ID=" + sc.getId());
+      log.info("Logging out: login=" + login + "; SessionID=" + sc.getId());
       sc.logout();
       sc.close();

extensions/net.sf.basedb.ftp/trunk/src/net/sf/basedb/clients/ftp/BaseUserManager.java

@@ +1 @@
+/**
+  $Id $
+
+  Copyright (C) 2008 Nicklas Nordborg
+
+  This file is part of FTP extension for BASE.
+  Available at http://baseplugins.thep.lu.se/
+
+  BASE is free software; you can redistribute it and/or
+  modify it under the terms of the GNU General Public License
+  as published by the Free Software Foundation; either version 2
+  of the License, or (at your option) any later version.
+
+  BASE 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 General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with this program; if not, write to the Free Software
+  Foundation, Inc., 59 Temple Place - Suite 330,
+  Boston, MA  02111-1307, USA.
+*/
 package net.sf.basedb.clients.ftp;
-
 
 import org.apache.ftpserver.ftplet.Authentication;
@@ -13 +35 @@
 import org.apache.ftpserver.usermanager.UsernamePasswordAuthentication;
 import org.apache.ftpserver.usermanager.WritePermission;
-
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+  A user manager implementation for hooking into BASE. This is a read-only
+  user manager, and all methods that makes modifications will throw an
+  {@link UnsupportedOperationException}. A lot of the other methods are
+  also hampered, eg {@link #doesExist(String), {@link #getAllUserNames()}, etc., 
+  since before we can get information out from BASE a user must be logged in.
+  <p>
+  
+  The only method that really does what it is intended to is the 
+  {@link #authenticate(Authentication)} method. This is probably no harm
+  since this is the only method are really interested in.
+  <p>
+  
+  As long as the BASE FTP Server hasn't been registered as a client
+  application with BASE, only the root user is allowed to login. Once
+  the root user does that, the 
+  {@link BaseFtpServer#registerAsClient(net.sf.basedb.core.SessionControl)}
+  is called to register the FTP Server. After that everybody can use the FTP
+  Server.
+  
+  @author Nicklas
+  @version 1.0
+*/
 public class BaseUserManager 
   implements UserManager 
 {
+  private static final Logger log = LoggerFactory.getLogger(BaseUserManager.class);
 
   private boolean ftpClientIsInstalled;
-
+  
+  private int maxUploadRate = 0;
+  private int maxDownloadRate = 0;
+
+  /**
+    Creates a new user manager for BASE.
+  */
   public BaseUserManager()
   {
-    this.ftpClientIsInstalled = BaseFtpServer.isClientInstalled();
+    this.ftpClientIsInstalled = BaseFtpServer.isRegisteredAsClient();
   }
   
@@ -119 +173 @@
         String ip = auth.getUserMetadata().getInetAddress().getHostAddress();
         
+        log.info("Trying to authenticate: login=" + login);
+        log.debug("password=" + pwd);
+        log.debug("ip=" + ip);
+        
         user = getBaseUser(login);
         try
         {
           user.login(pwd, ip, ftpClientIsInstalled ? BaseFtpServer.CLIENT_ID : null);
-          if (!ftpClientIsInstalled) 
-          {
-            BaseFtpServer.installClient(user.sc);
-            ftpClientIsInstalled = true;
-          }
+          log.info("Login successful: login=" + login);
         }
         catch (Exception ex)
         {
-          ex.printStackTrace();
+          log.warn("Login failed: login="+login, ex);
           throw new AuthenticationFailedException(ex.getMessage(), ex);
         }
+      if (!ftpClientIsInstalled) 
+      {
+        log.info("Registering BASE FTP Server");
+        try
+        {
+          BaseFtpServer.registerAsClient(user.sc);
+          ftpClientIsInstalled = true;
+        }
+        catch (Exception ex)
+        {
+          log.warn("Could not register FTP Server", ex);
+        }
+      }
         }
         else if (authentication instanceof AnonymousAuthentication) 
         {
-          throw new AuthenticationFailedException("Anonymous login is not allowed.");
+          String msg = "Anonymous login is not allowed.";
+          log.warn(msg);
+          throw new AuthenticationFailedException(msg);
         } 
         else 
         {
-            throw new IllegalArgumentException("Unsupported authentication method: " + authentication);
+          String msg = "Unsupported authentication method: " + authentication;
+          log.warn(msg);
+            throw new IllegalArgumentException(msg);
         }
     return user;
@@ -147 +218 @@
   // -------------------------------
   
+  /**
+    Get the current maximum transfer rate for uploads.
+    @return The transfer rate in bytes/second, or 0 if unlimited
+  */
+  public int getMaxUploadRate()
+  {
+    return maxUploadRate;
+  }
+  
+  /**
+    Set the maximum transfer rate for uploads. This will only affect
+    new users. 
+    @param uploadRate The transfer rate in bytes/second, or 0 if unlimited
+  */
+  public void setMaxUploadRate(int uploadRate)
+  {
+    this.maxUploadRate = uploadRate;
+  }
+  
+  /**
+    Get the current maximum transfer rate for downloads.
+    @return The transfer rate in bytes/second, or 0 if unlimited
+  */
+  public int getMaxDownloadRate()
+  {
+    return maxDownloadRate;
+  }
+  
+  /**
+    Set the maximum transfer rate for downloads. This will only affect
+    new users. 
+    @param downloadRate The transfer rate in bytes/second, or 0 if unlimited
+  */
+  public void setMaxDownloadRate(int downloadRate)
+  {
+    this.maxDownloadRate = downloadRate;
+  }
+  
+  /**
+    Set the maximum transfer rate for uploads and downloads. 
+    This will only affect new users. 
+    @param transferRate The transfer rate in bytes/second, or 0 if unlimited
+  */
+  public void setTransferRate(int transferRate)
+  {
+    this.maxDownloadRate = transferRate;
+    this.maxUploadRate = transferRate;
+  }
+
   private BaseUser getBaseUser(String login)
   {
+    if (log.isDebugEnabled())
+    {
+      log.debug("Creating new user: login=" + login);
+      log.debug("Transfer rate: upload=" + maxUploadRate + "; download=" + maxDownloadRate);
+    }
     Authority[] auth = new Authority[3];
     auth[0] = new ConcurrentLoginPermission(0, 0);
     auth[1] = new WritePermission();
-    auth[2] = new TransferRatePermission(0, 0);
+    auth[2] = new TransferRatePermission(maxDownloadRate, maxUploadRate);
     BaseUser u = new BaseUser(login, auth);   
     return u;

extensions/net.sf.basedb.ftp/trunk/src/net/sf/basedb/clients/ftp/FtpServiceController.java

@@ +1 @@
+/**
+  $Id $
+
+  Copyright (C) 2008 Nicklas Nordborg
+
+  This file is part of FTP extension for BASE.
+  Available at http://baseplugins.thep.lu.se/
+
+  BASE is free software; you can redistribute it and/or
+  modify it under the terms of the GNU General Public License
+  as published by the Free Software Foundation; either version 2
+  of the License, or (at your option) any later version.
+
+  BASE 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 General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with this program; if not, write to the Free Software
+  Foundation, Inc., 59 Temple Place - Suite 330,
+  Boston, MA  02111-1307, USA.
+*/
 package net.sf.basedb.clients.ftp;
 
 import net.sf.basedb.clients.web.extensions.service.ServiceControllerAction;
 
+/**
+  Action for hooking into the BASE extensions system. This action
+  is used to control a single {@link BaseFtpServer} instance, which
+  should already exist. Actions are created by 
+  {@link FtpServiceControllerFactory}.
+  
+  @author Nicklas
+  @version 1.0
+  @see FtpServiceControllerFactory
+*/
 public class FtpServiceController 
   implements ServiceControllerAction 
@@ -9 +42 @@
   private final BaseFtpServer server;
   
+  /**
+    Creates a new service controller action for controlling
+    a single ftp server service
+    @param server The server to control with this action
+  */
   public FtpServiceController(BaseFtpServer server)
   {
@@ -14 +52 @@
   }
   
+  /*
+    From the ServiceControllerAction interface
+    -------------------------------------------
+  */
   @Override
   public boolean isRunning() 
@@ -31 +73 @@
     server.stop();
   }
+  // ----------------------------------------------
+
+  /*
+    From the Object class
+    ---------------------
+  */
+  @Override
+  public String toString() 
+  {
+    return "BASE FTP Server";
+  }
+  // ----------------------------------------------
+  
+  
 
 }

extensions/net.sf.basedb.ftp/trunk/src/net/sf/basedb/clients/ftp/FtpServiceControllerFactory.java

@@ +1 @@
+/**
+  $Id $
+
+  Copyright (C) 2008 Nicklas Nordborg
+
+  This file is part of FTP extension for BASE.
+  Available at http://baseplugins.thep.lu.se/
+
+  BASE is free software; you can redistribute it and/or
+  modify it under the terms of the GNU General Public License
+  as published by the Free Software Foundation; either version 2
+  of the License, or (at your option) any later version.
+
+  BASE 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 General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with this program; if not, write to the Free Software
+  Foundation, Inc., 59 Temple Place - Suite 330,
+  Boston, MA  02111-1307, USA.
+*/
 package net.sf.basedb.clients.ftp;
 
@@ -5 +28 @@
 import java.util.Properties;
 
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 import net.sf.basedb.clients.web.extensions.service.ServiceControllerAction;
-import net.sf.basedb.core.Config;
 import net.sf.basedb.core.ConfigurationException;
 import net.sf.basedb.util.extensions.ActionFactory;
 import net.sf.basedb.util.extensions.InvokationContext;
 
+/**
+  An action factory for creating {@link FtpServiceController} actions.
+  A single factory is tied to a single {@link BaseFtpServer}, which is
+  created lazily when it is first needed. This usually happens when
+  the {@link #getActions(InvokationContext)} method is called.
+  <p>
+  The action factory accepts the following parameters:
+  <ul>
+  <li>{@link #setConfig(String)}: The path to the configuration file. The
+    default is: <code>/ftp.config</code>
+  </ul>
+  
+  @author Nicklas
+  @version 1.0
+*/
 public class FtpServiceControllerFactory 
   implements ActionFactory<ServiceControllerAction> 
 {
+  private static final Logger log = LoggerFactory.getLogger(FtpServiceControllerFactory.class);
 
-  private FtpServiceController controller;
+  private FtpServiceController[] controller;
   private BaseFtpServer server;
+  private String config;
   
+  /**
+    Creates a new factory instance.
+  */
   public FtpServiceControllerFactory()
   {}
   
+  /*
+    From the ActionFactory interface
+    -------------------------------------------
+  */
   @Override
   public ServiceControllerAction[] getActions(InvokationContext context)
   {
-    return new ServiceControllerAction[] { getController() };
+    return getController();
   }
 
+  /**
+    Always TRUE.
+  */
   @Override
   public boolean prepareContext(InvokationContext context) 
@@ -32 +84 @@
     return true;
   }
+  // -----------------------------------------------
 
-  private FtpServiceController getController()
+  /**
+    Set the path to the configuration file to use. The path
+    should be a path on the CLASSPATH. 
+    @param config The path, or null to use the default path (/ftp.config)
+  */
+  public void setConfig(String config)
+  {
+    this.config = config;
+  }
+
+  private FtpServiceController[] getController()
   {
     if (controller == null)
     {
-      controller = new FtpServiceController(getServer());
+      controller = new FtpServiceController[1];
+      controller[0] = new FtpServiceController(getServer());
     }
     return controller;
   }
   
+  /**
+    Get or create the {@link BaseFtpServer}. A factory can only be associated
+    with a single ftp server.
+  */
   private BaseFtpServer getServer()
   {
     if (server == null)
     {
+      log.info("Creating BASE FTP Server");
       try
       {
-        URL configUrl = Config.class.getResource("/ftp.config");
+        if (config == null) config = "/ftp.config";
+        log.debug("config=" + config);
+        URL configUrl = BaseFtpServer.class.getResource(config);
         InputStream is = configUrl == null ? null : configUrl.openStream();
         if (is == null)
         {
-          throw new ConfigurationException("Can't find the properties file. Make sure '/ftp.config' is in the CLASSPATH.");
+          throw new ConfigurationException("Can't find the properties file. " +
+              "Make sure '" + config + "' is in the CLASSPATH.");
         }
         Properties config = new Properties();
@@ -58 +130 @@
         is.close();
         server = new BaseFtpServer(config);
+        log.info("BASE FTP Server created successfully");
       }
       catch (RuntimeException ex)
       {
+        log.error("Could not create BASE FTP Server", ex);
         throw ex;
       }
       catch (Exception ex)
       {
+        log.error("Could not create BASE FTP Server", ex);
         throw new RuntimeException(ex);
       }
@@ -71 +146 @@
   }
   
+
 }

extensions/net.sf.basedb.ftp/trunk/src/net/sf/basedb/clients/ftp/TransactionalOutputStream.java

@@ +1 @@
+/**
+  $Id $
+
+  Copyright (C) 2008 Nicklas Nordborg
+
+  This file is part of FTP extension for BASE.
+  Available at http://baseplugins.thep.lu.se/
+
+  BASE is free software; you can redistribute it and/or
+  modify it under the terms of the GNU General Public License
+  as published by the Free Software Foundation; either version 2
+  of the License, or (at your option) any later version.
+
+  BASE 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 General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with this program; if not, write to the Free Software
+  Foundation, Inc., 59 Temple Place - Suite 330,
+  Boston, MA  02111-1307, USA.
+*/
 package net.sf.basedb.clients.ftp;
 
@@ -5 +28 @@
 import java.io.OutputStream;
 
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 import net.sf.basedb.core.DbControl;
 
+/**
+  An output stream implementation that has a {@link DbControl} attached
+  to it. When the stream is {@link #close()}:ed the DbControl will be
+  {@link DbControl#commit()}:ed. If the stream is never closed, the finalize
+  method will rollback the transaction.
+  
+  @author Nicklas
+  @version 1.0
+*/
 public class TransactionalOutputStream 
   extends FilterOutputStream 
 {
 
-  private final DbControl dc;
+  private static final Logger log = LoggerFactory.getLogger(TransactionalOutputStream.class);
+  private DbControl dc;
+  private final String filename;
   
-  public TransactionalOutputStream(DbControl dc, OutputStream out)
+  /**
+    Create a new stream.
+    @param dc The DbControl which should be committed when
+      the stream is closed
+    @param out The stream to write to
+  */
+  public TransactionalOutputStream(DbControl dc, OutputStream out, String filename)
   {
     super(out);
     this.dc = dc;
+    this.filename = filename;
   }
   
+  /*
+    From the OutputStream class
+    ---------------------------
+  */
   @Override
   public void close() 
     throws IOException 
   {
+    log.debug("Closing upload to: " + filename);
     super.close();
-    dc.reconnect();
+    if (!dc.isConnected()) dc.reconnect();
     dc.commit();
+    dc = null;
   }
+  // ------------------------------
+
+  /*
+    From the Object class
+    ---------------------------
+  */
+  /**
+    Make sure the DbControl is closed.
+  */
+  @Override
+  protected void finalize() 
+    throws Throwable 
+  {
+    if (dc != null) dc.close();
+    super.finalize();
+  }
+  // ------------------------------
   
 }