fargo 0.3.0 → 0.4.0

data/README.md

@@ -6,7 +6,51 @@ This gem is an implementation of the [Direct Connect (DC) protocol](http://en.wi
 
 `gem install fargo`
 
-## Usage
+## Configuration
+
+For a full list of configuration options, see [the source](http://github.com/alexcrichton/fargo/blob/master/lib/fargo/client.rb).
+
+Whatever the configuration directory is (by default `~/.fargo`), if there is a file called 'config' located in it, it will be eval'ed when Fargo is started. This way you can call `Fargo.configure` to set a nick, the hub address, share directories, and such.
+
+The configuration directory will also be used as a location to store the local file list caches.
+
+## CLI Usage
+
+The CLI for Fargo works like an IRB session (it actually is an IRB session!). It's got helper methods and tab completion, however, to make things a lot easier.
+
+Here's a synopsis of what the console has for you:
+
+  * `search 'str'` - search for a string on the hub. You will be notified when results arrive
+  * `results 'str'` - see the results for the given search
+  * `download 0, str=nil` - download the 0th numbered result from the search for 'str'. By default this uses the last given search
+  * `get 0, str=nil` - same as `download`
+  * `who 'str'=nil` - show a list of users on the hub when no argument is given. Otherwise print out specific information for the given user. If the user is 'name' or 'size', the users will be sorted based off of that attribute
+  * `browse 'nick'` - download nick's file list and begin browsing them. This works like a regular shell where you have a current directory and you 'cd' and 'ls' all the time
+  * `cd 'dir'` - change directorires
+  * `ls 'dir'` - list a directory
+  * `get 'file'` - begin downloading of a file (relative to the current dir)
+  * `download 'file'` - same as 'get "file"'
+  * `transfers` - see what's being downloaded/uploaded (percentages included)
+  * `status` - show some information about what you're sharing
+  * `say 'msg'` - say 'msg' on the hub (also `send_chat`)
+
+All of the methods are just wrappers around the `client` object available in the IRB session. They just manipulate the return values, provide tab completion, and format results.
+
+If you wanna get lower level access, the `client` method returns the client to interact with.
+
+### Multiple Instances
+
+By default, the CLI tries to connect to an instance of Fargo over DRb at 'localhost:8082'. If this fails, the CLI spawns a new thread with the EventMachine reactor running inside of it to use.
+
+If you would like to have multiple applications using the same instance of Fargo on the same machine, simply have one process start up and call
+
+<pre>
+  DRb.start_service 'druby://localhost:8082', Fargo::Client.new
+</pre>
+
+You can also [configure it](http://github.com/alexcrichton/cohort_radio/blob/master/lib/fargo/daemon.rb) or do whatever in the process as well.
+
+## Programmatic Usage
 
 <pre>
 require 'fargo'
@@ -38,6 +82,10 @@ EventMachine.run {
 
 See `lib/fargo/client.rb` for a full list of configuration options
 
+## Compatibility
+
+Fargo should run on both ruby 1.8 and ruby 1.9. It's been tested on 1.8.7 and 1.9.2
+
 ## MIT License
 
 Copyright (c) 2010 Alex Crichton

data/bin/fargo

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'fargo'
+
+Fargo::CLI.start

data/ext/fargo/base32.c

@@ -34,28 +34,3 @@ char* base32_encode(const unsigned char* buffer, int len)
     }
     return digest;
 }
-
-#if 0
-char* base32_decode(const unsigned char* buffer, int len)
-{
-    int i, j = 0;
-    int bits_remain = 0;
-    unsigned short value = 0;
-
-    for (i = 0; i < len; i++) {
-        value |= (buffer[i] << bits_remain);
-        bits_remain += 8;
-        while (bits_remain > 5 && j < 1023) {
-            base32_digest[j++] = (value & 0x1F) < 26 ? 'A'+(value & 0x1F) : '2' + (value & 0x1F);
-            value >>= 5;
-            bits_remain -= 5;
-        }
-    }
-    if (bits_remain > 0) {
-        base32_digest[j++] = (value & 0x1F) < 26 ? 'A'+(value & 0x1F) : '2' + (value & 0x1F);
-    }
-    base32_digest[j] = '\0';
-    return base32_digest;
-}
-
-#endif

data/ext/fargo/base32.h

@@ -1,16 +1,8 @@
 #ifndef __BASE32_H
 #define __BASE32_H
 
-#if defined(__cplusplus)
-extern "C" {
-#endif
-
 // user must call free() funtion on pointer returned from these functions
 
 char* base32_encode(const unsigned char* in, int inlen);
 
-#if defined(__cplusplus)
-}
-#endif
-
 #endif // ifndef __BASE32_H

data/ext/fargo/tiger.c

@@ -134,30 +134,6 @@ extern word64 table[4*256];
       feedforward
 #endif
 
-/*
-#define tiger_compress_macro(str, state) \
-{ \
-  register word64 a, b, c, tmpa; \
-  word64 aa, bb, cc; \
-  register word64 x0, x1, x2, x3, x4, x5, x6, x7; \
-  register word32 i; \
-  int pass_no; \
-\
-  a = state[0]; \
-  b = state[1]; \
-  c = state[2]; \
-\
-  x0=str[0]; x1=str[1]; x2=str[2]; x3=str[3]; \
-  x4=str[4]; x5=str[5]; x6=str[6]; x7=str[7]; \
-\
-  compress; \
-\
-  state[0] = a; \
-  state[1] = b; \
-  state[2] = c; \
-}
-*/
-
 #define tiger_compress_macro(str, state) \
 { \
   register word64 a, b, c, tmpa; \

data/ext/fargo/tiger.h

@@ -28,14 +28,6 @@ typedef u_int16_t  word16;
 typedef unsigned char  byte;
 #endif
 
-#if defined(__cplusplus)
-extern "C" {
-#endif
-
 void tiger(word64 *str, word64 length, word64 *res);
 
-#if defined(__cplusplus)
-}
-#endif
-
 #endif

data/ext/fargo/tigertree.c

@@ -109,43 +109,7 @@ void tt_digest(TT_CONTEXT *ctx, byte *s)
     word64 tmp, cnt;
     tt_final(ctx);
 
-    /*
-    dth_top0 = 0;
-    cnt = ctx->count;
-    tmp = cnt;
-    while(tmp == ((tmp >> 1)<<1)) {
-        dth_top0++;
-        tmp >>= 1;
-    }
-    cnt -= ((word64)1 << dth_top0);
-
-    TRACE(("ctx->top-TIGERSIZE - ctx->nodes == %d\n", ctx->top-TIGERSIZE - ctx->nodes));
-    */
-
     while( (ctx->top-TIGERSIZE) > ctx->nodes) {
-        /*
-        assert(cnt > 0);
-
-        dth_top1 = 0;
-        tmp = cnt;
-        while (tmp == ((tmp >> 1)<<1)) {
-            dth_top1++;
-            tmp >>= 1;
-        }
-        cnt -= ((word64)1 << dth_top1);
-
-        if ((ctx->depth <= dth_top1) && (ctx->depth >= dth_top0)) {
-            if ( dth_top1 == ctx->depth) {
-                TRACE(("depth = %d, dth_top0 == %d, dth_top1 == %d\n", ctx->depth, dth_top0, dth_top1));
-                memmove(ctx->tthl, ctx->top - 2*TIGERSIZE, 2*TIGERSIZE);
-                ctx->tthl += 2*TIGERSIZE;
-            } else {
-                TRACE(("depth = %d, dth_top0 == %d, dth_top1 == %d\n", ctx->depth, dth_top0, dth_top1));
-                memmove(ctx->tthl, ctx->top - TIGERSIZE, TIGERSIZE);
-                ctx->tthl += TIGERSIZE;
-            }
-        }
-        */
         tt_compose(ctx);
         dth_top0 = dth_top1 + 1;
     }

data/ext/fargo/tigertree.h

@@ -35,14 +35,8 @@ typedef struct tt_context {
   unsigned char nodes[STACKSIZE]; /* stack of interim node values */
 } TT_CONTEXT;
 
-#if defined(__cplusplus)
-extern "C" {
-#endif
 void tt_init(TT_CONTEXT *ctx, unsigned char *tthl, unsigned depth);
 //void tt_update(TT_CONTEXT *ctx, unsigned char *buffer, word32 len);
 void tt_block(TT_CONTEXT *ctx);
 void tt_digest(TT_CONTEXT *ctx, unsigned char *hash);
 void tt_copy(TT_CONTEXT *dest, TT_CONTEXT *src);
-#if defined(__cplusplus)
-}
-#endif

data/ext/fargo/tth.h

@@ -3,16 +3,8 @@
 
 #include "tiger.h"
 
-#if defined(__cplusplus)
-extern "C" {
-#endif
-
 // user must call free() funtion on pointer returned from these functions
 
 char* tth(const char* filename, char **tthl, size_t *tthl_len);
 
-#if defined(__cplusplus)
-}
-#endif
-
 #endif // ifndef __TTH_H

data/ext/readline/extconf.rb

@@ -0,0 +1,9 @@
+require 'mkmf'
+
+if RUBY_VERSION =~ /1\.9/
+  $CFLAGS << ' -DRUBY_19'
+end
+
+if have_header('readline/readline.h') || have_header('readline.h')
+  create_makefile('extra_utils')
+end

data/ext/readline/fargo_cli.c

@@ -0,0 +1,28 @@
+#include <ruby.h>
+#include "screen.h"
+
+VALUE rb_readline_clear_rl(VALUE self) {
+  clear_rl();
+
+  return Qtrue;
+}
+
+VALUE rb_readline_restore(VALUE self) {
+  restore_rl();
+
+  return Qtrue;
+}
+
+VALUE rb_readline_input(VALUE self) {
+  char *input = get_readline_input();
+
+  return rb_str_new(input, strlen(input));
+}
+
+Init_extra_utils() {
+  VALUE cReadline = rb_define_module("Readline");
+
+  rb_define_singleton_method(cReadline, "clear_rl", rb_readline_clear_rl, 0);
+  rb_define_singleton_method(cReadline, "restore", rb_readline_restore, 0);
+  rb_define_singleton_method(cReadline, "get_input", rb_readline_input, 0);
+}

data/ext/readline/screen.c

@@ -0,0 +1,77 @@
+/* screen.c - User interface management (Readline)
+ *
+ * Copyright (C) 2004, 2005 Oskar Liljeblad
+ *
+ * This program 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.
+ *
+ * This program 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 Library 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ */
+/* This piece of code was snatched from lftp, and modified somewhat by me.
+ * I suggest a function called rl_clear() be added to readline. The
+ * function clears the prompt and everything the user has written so far on
+ * the line. The cursor is positioned at the beginning of the line that
+ * contained the prompt. Note: This function doesn't modify the screen_state
+ * variable.
+ */
+
+#include <unistd.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <signal.h>
+
+#if defined(HAVE_READLINE_READLINE_H)
+# include <readline/readline.h>
+#elif defined(HAVE_READLINE_H)
+# include <readline.h>
+#endif
+
+#include "screen.h"
+
+void clear_rl() {
+
+    extern char *rl_display_prompt;
+#if HAVE__RL_MARK_MODIFIED_LINES
+    extern int _rl_mark_modified_lines;
+    int old_mark = _rl_mark_modified_lines;
+#endif
+    int old_end = rl_end;
+    char *old_prompt = rl_display_prompt;
+
+    rl_end = 0;
+    rl_display_prompt = (char*) "";
+    rl_expand_prompt(rl_display_prompt);
+#if HAVE__RL_MARK_MODIFIED_LINES
+    _rl_mark_modified_lines = 0;
+#endif
+
+    rl_redisplay();
+
+    rl_end = old_end;
+    rl_display_prompt = old_prompt;
+#if HAVE__RL_MARK_MODIFIED_LINES
+    _rl_mark_modified_lines = old_mark;
+#endif
+    if (rl_display_prompt == rl_prompt)
+        rl_expand_prompt(rl_prompt);
+}
+
+void restore_rl() {
+  rl_forced_update_display();
+}
+
+char* get_readline_input() {
+  struct readline_state state;
+  rl_save_state(&state);
+
+  return state.buffer;
+}

data/ext/readline/screen.h

@@ -0,0 +1,3 @@
+void clear_rl();
+void restore_rl();
+char* get_readline_input();

data/lib/fargo.rb

@@ -5,7 +5,6 @@ require 'active_support/core_ext/module/attribute_accessors'
 require 'active_support/core_ext/module/delegation'
 require 'active_support/buffered_logger'
 require 'active_support/concern'
-require 'active_support/configurable'
 
 module Fargo
   extend ActiveSupport::Autoload
@@ -15,6 +14,7 @@ module Fargo
   mattr_accessor :logger
   self.logger = ActiveSupport::BufferedLogger.new STDOUT
 
+  autoload :CLI
   autoload :Utils
   autoload :Parser
   autoload :Client
@@ -53,3 +53,5 @@ module Fargo
     delegate :config, :configure, :to => Client
   end
 end
+
+require 'fargo/ext/struct'

data/lib/fargo/cli.rb

@@ -0,0 +1,84 @@
+require 'fargo/ext/irb'
+
+module Fargo
+  module CLI
+    extend ActiveSupport::Autoload
+
+    autoload :Completion
+    autoload :Downloads
+    autoload :Help
+    autoload :Info
+    autoload :Logging
+    autoload :NickBrowser
+    autoload :Searches
+    autoload :Stats
+
+    def self.start
+      Fargo.logger = ActiveSupport::BufferedLogger.new WrappingLogger.new
+      Fargo.logger.level = ActiveSupport::BufferedLogger::INFO
+
+      console = Console.new
+
+      EventMachine.error_handler { |e|
+        if e.message =~ /no acceptor/
+          puts "Couldn't open sockets for listening"
+          puts "  Ports in question:"
+          [console.client.config.active_port, console.client.config.search_port,
+              console.client.config.websocket_port].each do |p|
+            puts "\t#{p}"
+          end
+          exit
+        else
+          Readline.above_prompt {
+            puts "ERROR!!!", e.message, e.backtrace.join("\n")
+          }
+        end
+      }
+
+      begin
+        console.client.connected?
+      rescue DRb::DRbConnError
+        current = Thread.current # Wait for the reactor to start
+        Thread.start{ EventMachine.run{
+          console.client = Fargo::Client.new
+          console.client.connect
+          current.wakeup
+        } }
+        sleep
+      end
+
+      console.log_published_messages
+
+      if !console.client.connected?
+        puts "Client couldn't connect!"
+        exit
+      end
+
+      IRB.start_session console.instance_eval{ binding } do
+        console.setup_console
+      end
+
+      EventMachine.stop
+    end
+
+    class WrappingLogger
+      def write str
+        Readline.above_prompt{ puts str }
+      end
+    end
+
+    class Console
+
+      include Completion
+      include Logging
+      include Searches
+      include Info
+      include Downloads
+      include Stats
+      include NickBrowser
+      include Help
+
+    end
+
+  end
+end