Changeset 1399 for extensions

Timestamp:

Oct 10, 2011, 3:32:34 PM (12 years ago)

Author:

Nicklas Nordborg

Message:

Fixes #329: Set active project when using FTP

I have implemented the third alternative. A project can be set active when logging in by using a login name as: username<projectname>.

Location:

extensions/net.sf.basedb.ftp/trunk

Files:

• .classpath (modified) (1 diff)
• README (modified) (1 diff)
• build.xml (modified) (1 diff)
• src/net/sf/basedb/clients/ftp/BaseUser.java (modified) (4 diffs)
• src/net/sf/basedb/clients/ftp/BaseUserManager.java (modified) (2 diffs)

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

@@ -3 +3 @@
   <classpathentry kind="src" path="src"/>
   <classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER"/>
-  <classpathentry kind="lib" path="lib/compile/BASE2Core.jar" sourcepath="/Base2/src/core"/>
-  <classpathentry kind="lib" path="lib/compile/BASE2Webclient.jar"/>
   <classpathentry kind="lib" path="lib/compile/slf4j-api-1.5.2.jar"/>
   <classpathentry kind="lib" path="META-INF/lib/ftplet-api-1.0.5.jar"/>

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

@@ -46 +46 @@
 == Tips and tricks ==
 
+ * To activate a project when logging in via FTP, use a login name like
+   `username<projectname>`, where `username` is the usual login and 
+   `projectname` is the name of the project to set active. This is useful
+   to access files that has been shared to a project, but note that
+   the path must be accessible all they way from the root. If no project
+   with the given name can be found, the user is logged in without an
+   active project.
+
  * If you want to try out an SSL enabled FTP server, but doesn't have
    a certificate, you may create one with the following command:

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

@@ -131 +131 @@
   </target>
   
+  <target 
+    name="install"
+    depends="jar"
+    >
+    <fail unless="base.plugins" message="base.plugins is not set to the path of BASE plug-ins directory." />
+    <copy todir="${base.plugins}">
+      <fileset file="${jar.name}" />
+    </copy>
+    <echo>Copied '${jar.name}' to '${base.plugins}'.</echo>
+  </target>
+
   <target name="update-version">
     <echo>Setting version to: ${version}</echo>

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

@@ -36 +36 @@
 import net.sf.basedb.core.DbControl;
 import net.sf.basedb.core.Directory;
+import net.sf.basedb.core.Include;
+import net.sf.basedb.core.ItemQuery;
 import net.sf.basedb.core.PermissionDeniedException;
+import net.sf.basedb.core.Project;
 import net.sf.basedb.core.SessionControl;
 import net.sf.basedb.core.SystemItems;
+import net.sf.basedb.core.Type;
 import net.sf.basedb.core.User;
+import net.sf.basedb.core.query.Expressions;
+import net.sf.basedb.core.query.Hql;
+import net.sf.basedb.core.query.Restrictions;
 
 /**
@@ -59 +66 @@
   SessionControl sc;
   private User user;
+  private Project project;
   private BaseFtpFile home;
   
@@ -93 +101 @@
   
   /**
-    Get the {@link Application#sessionCacheTimeout() value
+    Get the {@link Application#sessionCacheTimeout()} value
     and convert it to seconds.
   */
@@ -261 +269 @@
   
   /**
+    Activate the project with the given name.
+    @param name The name of the project, or null to deactive 
+  */
+  public void setProject(String name)
+  {
+    if (!isLoggedIn()) return;
+    
+    if (name == null)
+    {
+      log.info("Deactivating current project: " + project);
+      this.project = null;
+      sc.setActiveProject(null);
+      return;
+    }
+    
+    log.info("Looking up project: " + name);
+    
+    ItemQuery<Project> projectQuery = Project.getQuery();
+    projectQuery.include(Include.MINE, Include.SHARED);
+    projectQuery.restrict(Restrictions.eq(Hql.property("name"), Expressions.parameter("name", name, Type.STRING)));
+
+    DbControl dc = null;
+    try
+    {
+      dc = sc.newDbControl();
+      List<Project> projects = projectQuery.list(dc);
+      log.debug("Found " + projects.size() + " projects for name: " + name);
+      if (projects.size() > 0) 
+      {
+        this.project = projects.get(0);
+        log.info("Activating project: " + project);
+        sc.setActiveProject(project);
+      }
+    }
+    catch (RuntimeException ex)
+    {
+      log.error("Failed to activate project: name=" + name, ex);
+      throw ex;
+    }
+    finally
+    {
+      if (dc != null) dc.close();
+    }   
+  }
+
+  
+  /**
     Logout and close the session.
   */

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

@@ -175 +175 @@
         String login = auth.getUsername();
         String pwd = auth.getPassword();
+        String project = null;
         String ip = auth.getUserMetadata().getInetAddress().getHostAddress();
+        
+        /* 
+          If login has pattern like 'username<project>' we extract the
+          login and project from it.
+         */
+        if (login != null && login.endsWith(">"))
+        {
+          int index = login.indexOf("<");
+          if (index > 0 && index < login.length()-1)
+          {
+            project = login.substring(index+1, login.length()-1);
+            login = login.substring(0,  index);
+          }
+        }
         
         log.info("Trying to authenticate: login=" + login);
         log.debug("password=" + pwd);
+        log.debug("project=" + project);
         log.debug("ip=" + ip);
         
@@ -186 +202 @@
           user.login(pwd, ip, ftpClientIsInstalled ? BaseFtpServer.CLIENT_ID : null);
           log.info("Login successful: login=" + login);
+          if (project != null) user.setProject(project);
         }
         catch (Exception ex)