redcar-dev 0.12.17dev

data/plugins/connection_manager/lib/connection_manager/controller.rb

@@ -0,0 +1,100 @@
+
+module Redcar
+  class ConnectionManager
+    
+    class Controller
+      include Redcar::HtmlController
+      
+      attr_reader :store, :private_key_store
+      
+      def initialize
+        @store = ConnectionStore.new
+        @private_key_store = PrivateKeyStore.new
+      end
+      
+      def title
+        "Connections"
+      end
+      
+      def index
+        rhtml = ERB.new(File.read(File.join(File.dirname(__FILE__), "..", "..", "views", "index.html.erb")))
+        rhtml.result(binding)
+      end
+      
+      def add_connection(name, protocol, host, port, user, path)
+        store.add_connection(name, protocol, host, port, user, path)
+
+        success_response
+      rescue ConnectionStore::AlreadyExistsError
+        { 
+          'success' => false, 
+          'error' => "Connection #{name} already exists. Choose another name and try again." 
+        }
+      rescue ConnectionStore::ValidationFailedError => e
+        validation_failed_response(e)
+      end
+
+      def update_connection(name, protocol, host, port, user, path)
+        store.update_connection(name, protocol, host, port, user, path)
+
+        success_response
+      rescue ConnectionStore::ValidationFailedError => e
+        validation_failed_response(e)
+      end
+      
+      def delete_connection(name)
+        store.delete_connection(name)
+        
+        success_response
+      end
+      
+      def get_connection(name)
+        store.find(name).to_hash
+      end
+      
+      def add_private_key_file(path)
+        private_key_store.add_private_key(path)
+      rescue PrivateKeyStore::ValidationError => e
+        validation_failed_response(e)
+      end
+
+      def remove_private_key_file(path)
+        private_key_store.remove_private_key(path)
+      end
+
+      def activate_connection(name)
+        connection = store.find(name)
+        Project::Manager.connect_to_remote(
+            connection.protocol, connection.host,
+            connection.user, connection.path,
+            PrivateKeyStore.paths
+          )
+      end
+      
+      private
+      
+      def connections
+        store.connections
+      end
+      
+      def auto_detected_private_key_files
+        PrivateKeyStore.auto_detected_keys
+      end
+      
+      def private_key_files
+        private_key_store.paths
+      end
+      
+      def success_response
+        { 'success' => true }
+      end
+      
+      def validation_failed_response(e)
+        {
+          'success' => false,
+          'error' => "Please fix the following errors:<ul>#{e.errors.map {|msg| "<li>#{msg}</li>"}}<ul>"
+        }
+      end
+    end
+  end
+end

data/plugins/connection_manager/lib/connection_manager/filter_dialog.rb

@@ -0,0 +1,38 @@
+module Redcar
+  class ConnectionManager
+    class FilterDialog < FilterListDialog
+      MANAGER_NAME = "(Connection Manager)"
+      
+      def initialize
+        super
+      end
+      
+      def update_list(query)
+        if query == ""
+          connection_names
+        else
+          filter_and_rank_by(connection_names, query, 1000)
+        end
+      end
+      
+      def selected(text, _)
+        close
+        open_connection(text)
+      end
+      
+      private
+      
+      def open_connection(name)
+        ConnectionManager.open_connection(store.find(name))
+      end
+      
+      def store
+        ConnectionManager::ConnectionStore.new
+      end
+      
+      def connection_names
+        ["(Connection Manager)"] + store.connections.map {|con| con.name }
+      end
+    end
+  end
+end

data/plugins/connection_manager/lib/connection_manager/private_key_store.rb

@@ -0,0 +1,93 @@
+
+module Redcar
+  class ConnectionManager
+    
+    class PrivateKeyStore
+      def self.paths
+        auto_detected_keys + store_keys
+      end
+      
+      def self.auto_detected_keys
+        paths = []
+        default_key_globs.each do |default_key_glob|
+          Dir[default_key_glob].each do |filename|
+            unless File.directory?(filename) || !File.readable?(filename)
+              first = File.open(filename).read(100)
+              if first =~ /PRIVATE KEY/
+                paths << filename
+              end
+            end
+          end
+        end
+        paths
+      end
+      
+      def self.store_keys
+        PrivateKeyStore.new.paths
+      end
+      
+      def self.default_key_globs
+        [File.join(Redcar.home_dir, ".ssh", "*")]
+      end
+      
+      class ValidationError < StandardError
+        def errors
+          @errors ||= []
+        end
+      end
+      
+      def initialize
+        @private_key_files = load_private_key_files
+      end
+      
+      def paths
+        @private_key_files
+      end
+      
+      def add_private_key(path)
+        path = File.expand_path(path)
+        validate_private_key(path)
+        
+        @private_key_files << path
+        
+        save_private_key_files
+      end
+      
+      def remove_private_key(path)
+        path = File.expand_path(path)
+        @private_key_files.delete(path)
+        
+        save_private_key_files
+      end
+      
+      def validate_private_key(path)
+        validation_error = ValidationError.new
+        unless File.exist?(path) and File.file?(path)
+          validation_error.errors << "File not found."
+          raise validation_error
+        end
+        
+        begin
+          Net::SSH::KeyFactory.load_private_key(path)
+        rescue OpenSSL::PKey::PKeyError
+          validation_error.errors << "File does not contain a private key."
+          raise validation_error
+        end
+      end
+        
+      private
+      
+      def load_private_key_files
+        storage["private_keys"] || []
+      end
+
+      def save_private_key_files
+        storage["private_keys"] = @private_key_files
+      end
+      
+      def storage
+        Redcar::Plugin::Storage.new('connection_manager')
+      end
+    end
+  end
+end

data/plugins/connection_manager/plugin.rb

@@ -0,0 +1,12 @@
+
+Plugin.define do
+  name "connection_manager"
+  version "0.0.1"
+  
+  object "Redcar::ConnectionManager"
+  file "lib", "connection_manager"
+  
+  dependencies "core", ">0",
+               "HTML View", ">=0.3.2"  
+  
+end

data/plugins/connection_manager/views/index.html.erb

@@ -0,0 +1,284 @@
+
+<% jquery_path = File.expand_path(File.join(Redcar.root, %w(plugins html_view assets jquery-1.4.min.js))) %>
+<% watermark  = File.expand_path(File.join(Redcar.root, %w(plugins html_view views watermark-48.png))) %>
+<% redcar_css = File.expand_path(File.join(Redcar.root, %w(plugins html_view views default.css))) %>
+<script type="text/javascript" src="file://<%= jquery_path %>"></script>
+<link rel="stylesheet" href="file://<%= redcar_css %>" type="text/css" media="screen">
+<div id="top">
+  <img src="file://<%=watermark%>" id="watermark"/>
+  <h1>Connection Manager</h1>
+</div>
+<div class="main">
+  <h4>Connections</h4>
+  <div class="inset">
+  <div id='connections'>
+  <% if connections and connections.any? %>
+    <table id='table'>
+      <tr class='grey' style='font-weight:bold;'>
+        <th>Name</th>
+        <th>Protocol</th>
+        <th>Host</th>
+        <th>Port</th>
+        <th>User</th>
+        <th>Remote Path</th>
+      </tr>
+
+      <% connections.each do |c| %>
+        <tr id='row-<%= c.name %>'>
+          <td><a href='javascript:void(0);' class='activate connection-name'><%= c.name %></a></td>
+          <td><%= c.protocol %></td>
+          <td><%= c.host %></td>
+          <td><%= c.port %></td>
+          <td><%= c.user %></td>
+          <td><%= c.path %></td>
+          <td>
+            <a href='javascript:void(0);' class='delete'">Delete</a>
+            <a href='javascript:void(0);' class='modify'">Modify</a>
+          </td>
+        </tr>
+      <% end %>
+    </table>
+  <% else %>
+    <p>No connections</p>
+  <% end %>
+    <p>
+      <input id='add' type='button' value='Add Connection'>
+    </p>
+  </div>
+  <p>
+    <div id='add_div' style='display:none;'>
+      <div id='error' style='display:none;color:red;text-weight:bold;margin-bottom:20px;'></div>
+      <form id='new_connection'>
+        <input type='hidden' name='operation' id='operation'>
+        <table>
+          <tr class='grey'>
+            <th colspan=2><b><span id='conn_name'>New Connection</span></b></th>
+          </tr>
+          <tr><td>Name:     </td><td><input size='30' type='text' name='name' id='name'></td></tr>
+          <tr>
+            <td>Protocol: </td>
+            <td>
+              <select name='protocol' id='protocol'>
+                <option></option>
+                <option>SFTP</option>
+                <option>FTP</option>
+              </select>
+            </td>
+          </tr>
+          <tr><td>Host:        </td><td><input size="30" type='text' name='host' id='host'></td></tr>
+          <tr><td>Port:        </td><td><input type='text' name='port' id='port' size=2></td></tr>
+          <tr><td>User:        </td><td><input size="30" type='text' name='user' id='user'></td></tr>
+          <tr><td>Remote Path: </td><td><input size="30" type='text' name='path' id='path'></td></tr>
+          <tr>
+            <td colspan=2>
+              <input id='save' type='submit' value='Save'>
+              <input id='cancel' type='button' value='Cancel'>
+            </td>
+          </tr>
+        </table>
+      </form>
+    </div>
+  </p>
+</div>
+
+  <h4>Private Keys</h4>
+<div class="inset">
+  <div id="private-keys">
+    <div class="list">
+      <% if (private_key_files + auto_detected_private_key_files).any? %>
+        <table>
+        <% auto_detected_private_key_files.each do |private_key| %>
+          <tr>
+            <td><%= private_key %></td>
+          </tr>
+        <% end %>
+        <% private_key_files.each do |private_key| %>
+          <tr>
+            <td><%= private_key %></td>
+            <td>
+              <a href='javascript:void(0);' class='delete-key' data-name="<%= private_key %>">Delete</a>
+            </td>
+          </tr>
+        <% end %>
+        </table>
+      <% else %>
+        No private keys.
+      <% end %>
+    </div>
+    <br />
+    <input id='add-private-key-button' type='button' value='Add Private Key'>
+
+    <div id='add-private-key' style='display:none;'>
+      <div class='error' style='display:none;color:red;text-weight:bold;margin-bottom:20px;'></div>
+
+      <form id='add-private-key-form'>
+        <input type='hidden' name='operation' class='operation'>
+        <table>
+          <tr class='grey'>
+            <td colspan=2><b><span>New Private Key</span></b></td>
+          </tr>
+          <tr><td>Key file: </td><td><input size="30" type='text' class="path" name='path'></td></tr>
+          <tr>
+            <td colspan=2>
+              <input class='save' type='submit' value='Save'>
+              <input class='cancel' type='button' value='Cancel'>
+            </td>
+          </tr>
+        </table>
+      </form>
+    </div>
+  </div>
+</div>
+</div>
+
+<script type="text/javascript">
+$(document).ready(function() {
+  function showMain() {
+    $(':input','#new_connection')
+      .not(':button, :submit, :reset, :hidden')
+      .val('')
+      .removeAttr('checked')
+      .removeAttr('selected');
+
+    $('#add_div').hide();
+    $('#connections').show();
+  };
+
+  var PORTS = {
+    'FTP': 21, 'SFTP': 22
+  };
+
+  $('.delete').live('click', function() {
+    var name = $(this).parent().parent().find(".connection-name").text();
+    try {
+      if (confirm('Do you really want to delete connection ' + name + '?')) {
+        Controller.deleteConnection(name);
+        Controller.reloadIndex();
+      }
+    }
+    catch(err) {
+      alert("Error: " + err.message);
+    }
+  });
+
+  $('.modify').live('click', function() {
+    var name = $(this).parent().parent().find(".connection-name").text();
+    $('#error').html("");
+    $('#conn_name').text('Editing ' + name);
+    $('#connections').hide();
+    $('#add_div').show();
+    $('#protocol').focus();
+    $('#name').attr('disabled', 'disabled');
+
+    var data = Controller.getConnection(name);
+    if (data) {
+      $('#operation').val('update');
+      $('#name').val(name);
+      $('#protocol').val(data.protocol);
+      $('#host').val(data.host);
+      $('#port').val(data.port);
+      $('#user').val(data.user);
+      $('#path').val(data.path);
+    }
+  });
+
+  $('#protocol').change(function(e) {
+    $('#port').val(PORTS[$(this).val()]);
+  });
+
+  $('#add').click(function() {
+    $('#error').html("");
+    $('#conn_name').text('New Connection');
+    $('#operation').val('insert');
+    $('#connections').hide();
+    $('#add_div').show();
+    $('#name').focus();
+  });
+
+  $('#cancel').click(function() {
+    $('#error').html("");
+    showMain();
+  });
+
+  $("#new_connection").submit(function(e) {
+    try {
+      $('#name').removeAttr('disabled');
+      var name = $('#name').val();
+      var protocol = $('#protocol').val();
+      var host = $('#host').val();
+      var port = $('#port').val();
+      var user = $('#user').val();
+      var path = $('#path').val();
+
+      if ($('#operation').val() == 'insert') {
+        result = Controller.addConnection(name, protocol, host, port, user, path);
+      }
+      else {
+        result = Controller.updateConnection(name, protocol, host, port, user, path);
+      }
+
+      if (result.success === false) {
+        $('#error').html(result.error);
+        $('#error').show();
+        $('#name').focus();
+      }
+      else {
+        Controller.reloadIndex();
+      }
+    }
+    catch(err) {
+      alert("Error: " + error.message);
+    }
+    return false;
+  });
+
+  $(".activate").click(function(e) {
+    var name = $(this).parent().parent().find(".connection-name").text();
+    Controller.activateConnection(name);
+  });
+
+  $("#add-private-key-button").click(function() {
+    $("#add-private-key-button").hide();
+    $("#add-private-key").show();
+    $("#private-keys .list").hide();
+  });
+
+  $("#add-private-key-form .cancel").click(function() {
+    $("#add-private-key-button").show();
+    $("#add-private-key").hide();
+    $("#private-keys .list").show();
+  });
+
+  $("#add-private-key-form").submit(function(e) {
+    try {
+      var result = Controller.addPrivateKeyFile($("#add-private-key-form .path").val());
+
+      if (result.success === false) {
+        $('#add-private-key .error').html(result.error);
+        $('#add-private-key .error').show();
+        $('#add-private-key-form .path').focus();
+      }
+      else {
+        Controller.reloadIndex();
+      }
+    }
+    catch(err) {
+      alert("Error: " + error.message);
+    }
+    return false;
+  });
+
+  $("#private-keys .list .delete-key").click(function() {
+    var path = $(this).attr('data-name');
+    try {
+      Controller.removePrivateKeyFile(path);
+      Controller.reloadIndex();
+    }
+    catch(err) {
+      alert("Error: " + err.message);
+    }
+  });
+
+});
+
+</script>