Changeset 1255

Timestamp:

Oct 22, 2010, 2:50:11 PM (13 years ago)

Author:

Nicklas Nordborg

Message:

It is now possible to upload a torrent file and register it with the bittorrent client. Sometimes it will start downloading, sometimes not. No progress reporting is done and no uploading of files to BASE.

Location:

extensions/net.sf.basedb.torrent/trunk

Files:

• .classpath (modified) (1 diff)
• META-INF/extensions.xml (modified) (2 diffs)
• META-INF/servlets.xml (added)
• lib/compile/servlet-api.jar (added)
• resources (added)
• resources/upload_torrent.jsp (added)
• src/main/net/sf/basedb/clients/torrent/service/TorrentManager.java (added)
• src/main/net/sf/basedb/clients/torrent/service/TorrentService.java (modified) (7 diffs)
• src/main/net/sf/basedb/clients/torrent/service/TorrentServiceStateCheckerTask.java (added)
• src/main/net/sf/basedb/clients/torrent/service/TorrentState.java (added)
• src/main/net/sf/basedb/clients/torrent/servlet (added)
• src/main/net/sf/basedb/clients/torrent/servlet/UploadTorrentServlet.java (added)
• torrent.properties (modified) (1 diff)

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

@@ -7 +7 @@
   <classpathentry kind="lib" path="lib/compile/BASE2Webclient.jar"/>
   <classpathentry kind="lib" path="lib/compile/slf4j-api-1.5.2.jar"/>
+  <classpathentry kind="lib" path="lib/compile/servlet-api.jar"/>
   <classpathentry kind="output" path="bin"/>
 </classpath>

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

@@ -38 +38 @@
   </about>
   <extension
-    id="net.sf.basedb.clients.torrent.service.TorrentService"
+    id="net.sf.basedb.clients.torrent.service"
     extends="net.sf.basedb.clients.web.services"
     >
@@ -48 +48 @@
     </action-factory>
   </extension>
+  <extension
+    id="net.sf.basedb.clients.bittorrent.upload"
+    extends="net.sf.basedb.clients.web.toolbar.list.file"
+    >
+    <about>
+      <name>Upload torrent</name>
+      <description>Adds a 'Upload torrent' button to the File manager</description>
+    </about>
+    <index>10</index>
+    <action-factory>
+      <factory-class>net.sf.basedb.clients.web.extensions.toolbar.FixedButtonFactory</factory-class>
+      <parameters>
+        <title>Upload torrent</title>
+        <onClick>Main.openPopup('$HOME$/upload_torrent.jsp?ID=' + getSessionId(), 'UploadTorrent', 600, 400)</onClick>
+      </parameters>
+    </action-factory>
+  </extension>
 </extensions>

extensions/net.sf.basedb.torrent/trunk/src/main/net/sf/basedb/clients/torrent/service/TorrentService.java

@@ -26 +26 @@
 
 import hpbtc.protocol.processor.Client;
-
+import hpbtc.protocol.torrent.Torrent;
+
+import java.io.File;
 import java.io.IOException;
+import java.io.InputStream;
 import java.net.InetAddress;
 import java.net.InetSocketAddress;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
 import java.util.Properties;
-
+import java.util.TimerTask;
+
+import net.sf.basedb.core.Application;
 import net.sf.basedb.core.Config;
 import net.sf.basedb.core.ConfigurationException;
+import net.sf.basedb.core.DbControl;
+import net.sf.basedb.core.SessionControl;
+import net.sf.basedb.util.FileUtil;
 import net.sf.basedb.util.Values;
 
@@ -89 +100 @@
   private final String address;
   private final int port;
+  private final String username;
+  private final String password;
+  
   private volatile boolean isRunning;
   private Client btClient;
   private InetSocketAddress listenAddress;
+  private List<TorrentManager> torrentManagers;
+  private SessionControl sc;
+  private volatile TimerTask serviceTask;
   
   /**
@@ -106 +123 @@
     this.address = Values.getStringOrNull(properties.getProperty("torrents.listen-address"));
     this.port = Values.getInt(properties.getProperty("torrents.listen-port"));
+    this.username = "root";
+    this.password = "root";
   }
 
@@ -126 +145 @@
     log.debug("Listen address: " + address);
     log.debug("Listen port: " + port);
+    log.debug("Username: " + username);
     
     // Check if the working directory exists...
@@ -142 +162 @@
       try
       {
-        tmpClient = new Client();
+        // Login to BASE
+        log.debug("Logging in to BASE as user '" + username + "'");
+        sc = Application.newSessionControl(null, "local-bittorrent", null);
+        sc.login(username, password, "Bittorrent download service", false);
+        log.debug("Login successful");
+
+        // Create a bittorrent client
         InetAddress tmpAddress = null;
         if (address != null) tmpAddress = InetAddress.getByName(address);
         InetSocketAddress socketAddress = new InetSocketAddress(tmpAddress, port);
+        log.debug("Creating bittorrent client on " + socketAddress);
+        tmpClient = new Client();
         listenAddress = tmpClient.startProtocol(socketAddress);
         log.debug("Connected to: " + listenAddress);
@@ -155 +183 @@
       }
       
-      btClient = tmpClient;
-      
-    isRunning = true;
+      this.btClient = tmpClient;
+    this.torrentManagers = Collections.synchronizedList(new ArrayList<TorrentManager>());
+    this.isRunning = true;
     log.info("Bittorrent Download Service has been started");
   }
@@ -169 +197 @@
     if (!isRunning()) return;
     log.info("Stopping Bittorrent Download Service");
-    
+
+    isRunning = false;
+
+    if (serviceTask != null) serviceTask.cancel();
+    serviceTask = null;
+    if (sc != null) closeSessionControl();
+    sc = null;
+    if (btClient != null) closeBtClient();
+    btClient = null;
+    torrentManagers.clear();
+    torrentManagers = null;
+    service = null;
+    log.info("Bittorrent Download Service has been stopped");
+  }
+
+  /**
+    Safely close the session control. Catches all exceptions but log
+    them to the logger.
+  */
+  private void closeSessionControl()
+  {
     try
     {
-      if (btClient != null)
-      {
-        btClient.stopProtocol();
-        btClient = null;
-      }
-    }
-    finally
-    {
-      isRunning = false;
-      service = null;
-      log.info("Bittorrent Download Service has been stopped");
-    }
-  }
-
+      sc.close();
+    }
+    catch (Throwable t)
+    {
+      log.warn("Exception when closing SessionControl" , t);
+    }
+  }
+  
+  /**
+    Safely close the Bittorrent client. Catches all exceptions but log
+    them to the logger.
+  */
+  private void closeBtClient()
+  {
+    try
+    {
+      btClient.stopProtocol();
+    }
+    catch (Throwable t)
+    {
+      log.warn("Exception when closing Bittorrent client" , t);
+    }
+  }
+
+  
+  /**
+    Create a new torrent manager for the torrent with the given name.
+    This method will create a new temporary working directory for the
+    torrent manager to store the torrent, the downloaded files and
+    other data.
+    
+    @param torrentName Usually the filename of the torrent file
+    @return A new torrent manager
+    @throws IOException If the temporary working directory can't be
+      created
+    @throws IllegalStateException If the service has not been started
+  */
+  public synchronized TorrentManager newTorrentManager(String torrentName)
+    throws IOException
+  {
+    if (!isRunning()) throw new IllegalStateException("The service has not been started.");
+    
+    // Create a sub-dir for this torrent
+    String tmpDir = torrentName;
+    if (torrentName.endsWith(".torrent"))
+    {
+      tmpDir = torrentName.substring(0, torrentName.length()-8);
+    }
+    File subDir = FileUtil.createTempDirectory(tmpDir, ".torrent", workDir);
+    
+    // Create a Torrent manager
+    TorrentManager manager = new TorrentManager(this, subDir, torrentName);
+    torrentManagers.add(manager);
+    
+    // Create the service task if needed
+      if (serviceTask == null)
+      {
+          serviceTask = Application.getScheduler().schedule(new TorrentServiceStateCheckerTask(this), 10000, 10000, false);
+      }
+    return manager;
+  }
+
+  /**
+    Remove an existing torrent manager. If this is the last one,
+    the service task will be closed.
+  */
+  synchronized void remove(TorrentManager manager)
+  {
+    torrentManagers.remove(manager);
+    if (torrentManagers.size() == 0)
+    {
+      serviceTask.cancel();
+      serviceTask = null;
+    }
+  }
+
+  /**
+    Get a cloned list of torrent managers since the original list
+    may be modified at any time by other threads.
+  */
+  List<TorrentManager> getManagers()
+  {
+    return new ArrayList<TorrentManager>(torrentManagers);
+  }
+  
+  /**
+    Create a new DbControl.
+  */
+  DbControl newDbControl()
+  {
+    return sc.newDbControl();
+  }
+  
+  /**
+    Start the actual download of a torrent. Called by the {@link TorrentServiceStateCheckerTask} 
+    when it has detected a {@link TorrentManager} with {@link TorrentState#READY_TO_DOWNLOAD}
+    state.
+  */
+  void startDownload(TorrentManager manager)
+  {
+
+    try
+    {
+      // Register torrent with btClient
+      File downloadDir = manager.getDownloadDir();
+      downloadDir.mkdir();
+      InputStream in = FileUtil.getInputStream(manager.getTorrentFile());
+      Torrent torrent = btClient.download(in, downloadDir.getAbsolutePath());
+      
+      // Set torrent manager state to DOWNLOADING
+      manager.setTorrent(torrent);
+    }
+    catch (Exception ex)
+    {
+      // Close the torrent manager
+      manager.close(ex);
+      log.warn("Could not start download of " + manager.getName(), ex);
+    }
+  }
 }

extensions/net.sf.basedb.torrent/trunk/torrent.properties

@@ -15 +15 @@
 torrents.listen-port  = 
 
+# Username and password that the service should use to login to BASE.
+# The user needs the same permissions as a job agent user.
+torrents.username = 
+torrents.password =