syndi 0.1.1-x86-mingw32

data/include/syndi.h

@@ -0,0 +1,22 @@
+/*
+ * Copyright (c) 2013, Autumn Perrault, et al. 
+ * All rights reserved.
+ * This free software is distributed under the FreeBSD license (see LICENSE).
+ *
+ */
+
+#ifndef SYNDI_H
+#define SYNDI_H
+
+#include <stdio.h>
+#include "ruby.h"
+
+/* include csyndi headers */
+#include "syndi/csyndi.h"
+#include "syndi/logger.h"
+#include "syndi/events.h"
+#include "syndi/integer.h"
+
+#endif // SYNDI_H
+
+/* vim: set ts=4 sts=4 sw=4 et cindent: */

data/include/syndi/csyndi.h

@@ -0,0 +1,38 @@
+/*
+ * Copyright (c) 2013, Autumn Perrault, et al. 
+ * All rights reserved.
+ * This free software is distributed under the FreeBSD license (see LICENSE).
+ *
+ */
+
+#ifndef __LIBSYNDI_H__
+#define __LIBSYNDI_H__
+
+/* SYM(x) returns rb_intern(x) */
+#define SYM(str) rb_intern(#str)
+
+/* variable for the Syndi module */
+extern VALUE mSyndi;
+
+/* Init_csyndi prototype */
+void Init_csyndi();
+
+/* Syndi's exceptions */
+extern VALUE eLogError;
+extern VALUE eConfigError;
+extern VALUE eDatabaseError;
+extern VALUE ePluginError;
+
+/* line ending */
+#ifdef _WIN32
+#define OS_LINE_TERM "\r\n"
+#else
+#define OS_LINE_TERM "\n"
+#endif
+
+/* fetch the Syndi directory */
+#define SYNDI_DIR RSTRING_PTR(rb_funcall(mSyndi, SYM(dir), 0))
+
+#endif
+
+/* vim: set ts=4 sts=4 sw=4 et cindent: */

data/include/syndi/events.h

@@ -0,0 +1,19 @@
+/*
+ * Copyright (c) 2013, Autumn Perrault, et al. 
+ * All rights reserved.
+ * This free software is distributed under the FreeBSD license (see LICENSE).
+ *
+ */
+
+#ifndef WIN32
+#include <pthread.h>
+#endif
+
+extern VALUE cEvents;
+
+static VALUE events_initialize(VALUE self);
+static VALUE events_on(VALUE self, VALUE event, VALUE rbpriority, VALUE prc);
+
+static void init_events();
+
+/* vim: set ts=4 sts=4 sw=4 et cindent: */

data/include/syndi/integer.h

@@ -0,0 +1,17 @@
+/*
+ * Copyright (c) 2013, Autumn Perrault, et al. 
+ * All rights reserved.
+ * This free software is distributed under the FreeBSD license (see LICENSE).
+ *
+ */
+
+#ifndef __SYNDI_INTEGER_H__
+#define __SYNDI_INTEGER_H__
+
+void init_integer();
+VALUE swar_bits_set(VALUE self);
+VALUE modular_power(VALUE self, VALUE exponent, VALUE modulus);
+
+#endif
+
+/* vim: set ts=4 sts=4 sw=4 et cindent: */

data/include/syndi/logger.h

@@ -0,0 +1,56 @@
+/*
+ * Copyright (c) 2013, Autumn Perrault, et al. 
+ * All rights reserved.
+ * This free software is distributed under the FreeBSD license (see LICENSE).
+ *
+ */
+
+#ifndef __SYNDI_LOGGER_H__
+#define __SYNDI_LOGGER_H__
+
+#include <errno.h>
+#include <sys/stat.h>
+#include <string.h>
+#include <time.h>
+#ifndef _WIN32
+#include <unistd.h>
+#endif
+
+/* Set format based on target OS. */
+#ifdef _WIN32
+#define LOG_FILE_FORMAT "logs\\%Y%m%d.log"
+#else
+#define LOG_FILE_FORMAT "logs/%Y%m%d.log"
+#endif
+
+/* This is based on the desired output give or take a few characters. */
+#define MAX_TIME_STRING_LENGTH 18
+
+/* ("YYYY-MM-DD HH:MM:SS +ZZZZ") "YEAR-MONTH-DAY HOUR:MINUTES:SECONDS UTC_OFFSET" */
+#define LOG_TIME_FORMAT_LENGTH 25
+
+extern VALUE cLogger;
+void init_syndi_logger();
+
+/* Ruby-accessible methods */
+VALUE logger_init(VALUE self);
+
+VALUE logger_fatal(VALUE self, VALUE message);
+VALUE logger_error(int argc, VALUE *argv, VALUE message);
+VALUE logger_verbose(VALUE self, VALUE message, VALUE level);
+VALUE logger_warning(VALUE self, VALUE message);
+VALUE logger_info(VALUE self, VALUE message);
+
+/* internal functions */
+static void log_out2scrn(int type, const char *message, int level);
+static void log_out2file(const char *type, const char *message);
+static void log_dircheck();
+
+/* symbolic constants for event types */
+#define TYPE_FATAL      0
+#define TYPE_ERROR      1
+#define TYPE_WARNING    2
+#define TYPE_INFO       3
+#define TYPE_DEBUG      4
+
+#endif 

data/lib/syndi.rb

@@ -0,0 +1,137 @@
+# Copyright (c) 2013, Autumn Perrault, et al. All rights reserved.
+# This free software is distributed under the FreeBSD license (see LICENSE).
+
+require 'syndi/rubyext/string'
+require 'syndi/version'
+require 'fileutils'
+
+module Syndi
+  extend self
+
+  # @return [Boolean] Whether we're installed as a gem.
+  def gem?
+    begin
+      # If we already checked, just return the result of that.
+      return @gem if defined? @gem
+
+      # Otherwise, check.
+      result = Gem.path.each do |gempath|
+        break true if __FILE__ =~ /^#{Regexp.escape gempath}/
+      end
+      @gem = (result == true ? true : false)
+    ensure
+      @gem ||= false
+    end
+  end
+
+  # @return [Boolean] Whether we're running on Microsoft Windows.
+  def windows?
+    begin
+      return @windows if defined? @windows
+      if ::RbConfig::CONFIG['host_os'] =~ /bccwin|djgpp|mswin|mingw|cygwin|wince/i
+        @windows = true
+      else
+        @windows = false
+      end
+    ensure
+      @windows ||= false
+    end
+  end
+
+  # This fixes coloring issues on Windows--or at least, the ones with which we
+  # need be concerned.
+  def windows_colored
+    colors = [:black, :red, :green, :yellow, :blue, :magenta, :cyan, :white]
+    extras = [:clear, :bold, :underline, :reversed]
+    
+    colors.each do |col|
+      String.send(:define_method, col, proc { self })
+    end
+    extras.each do |extr|
+      String.send(:define_method, extr, proc { self })
+    end
+  end
+
+  ###################
+  # central methods #
+  ###################
+
+  # Retrieve the application data directory.
+  #
+  # @return [String]
+  def dir
+    @app_dir ||= File.join ENV['HOME'], '.syndi'
+  end
+
+  # Set the application data directory.
+  def dir= directory
+    FileUtils.mkdir_p directory unless Dir.exists? directory
+    Dir.chdir directory
+    @app_dir = directory
+  end 
+
+  # Initiate Syndi with command-line +options+.
+  #
+  # @param [Slop] options The command-line options.
+  def go options
+    
+  end
+
+  # Logger access.
+  #
+  # @return [Syndi::Logger]
+  def log
+    @logger ||= Syndi::Logger.new
+  end
+
+  # Central event system access.
+  #
+  # @return [Syndi::Events]
+  def events
+    @event_manager ||= Syndi::Events.new
+  end
+
+  # Configuration access.
+  #
+  # @return [Syndi::Config]
+  def conf
+    @configuration ||= Syndi::Config.new
+  end
+
+  # Central Syndi Celluloid actor.
+  #
+  # @return [Syndi::Actress] Subclass of {Celluloid::Actor}.
+  def actress
+    @actress ||= Syndi::Actress.new
+  end
+
+  # Execute some code after the given interval.
+  #
+  # @param [Integer] interval
+  #
+  # @return [Celluloid::Timer]
+  def after interval, &prc
+    actress.after interval, &prc
+  end
+  
+  # Execute some code every +interval+.
+  #
+  # @param [Integer] interval
+  #
+  # @return [Celluloid::Timer]
+  def every interval, &prc
+    actress.every interval, &prc
+  end
+
+end
+
+if Syndi.windows?
+  Syndi.windows_colored
+else
+  require 'colored'
+end
+
+require 'csyndi'
+%w[events actress config bot].each { |lib| require "syndi/#{lib}" }
+
+# vim: set ts=4 sts=2 sw=2 et:

data/lib/syndi/actress.rb

@@ -0,0 +1,12 @@
+# Copyright (c) 2013, Autumn Perrault, et al. All rights reserved.
+# This free software is distributed under the FreeBSD license (see LICENSE).
+
+require 'celluloid'
+
+module Syndi
+  class Actress
+    include Celluloid
+  end
+end
+
+# vim: set ts=4 sts=2 sw=2 et:

data/lib/syndi/api.rb

@@ -0,0 +1,7 @@
+# Copyright (c) 2013, Autumn Perrault, et al. All rights reserved.
+# This free software is distributed under the FreeBSD license (see LICENSE).
+
+require 'syndi/api/events'
+require 'syndi/api/timers'
+
+# vim: set ts=4 sts=2 sw=2 et:

data/lib/syndi/api/object.rb

@@ -0,0 +1,29 @@
+# Copyright (c) 2013, Autumn Perrault, et al. All rights reserved.
+# This free software is distributed under the FreeBSD license (see LICENSE).
+
+# Namespace: Syndi
+module Syndi
+
+  # Namespace: API
+  module API
+
+    # A superclass for {Syndi::API::Timers} and {Syndi::API::Events}.
+    class Object
+
+      private
+
+      # Get a random character.
+      #
+      # @return [String] A random character.
+      def get_rand_char
+        chrs = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890".split(//)
+        chrs[rand(chrs.length)]
+      end
+
+    end # class Object
+
+  end # module API
+
+end # module Syndi
+
+# vim: set ts=4 sts=2 sw=2 et:

data/lib/syndi/bot.rb

@@ -0,0 +1,266 @@
+# Copyright (c) 2013, Autumn Perrault, et al. All rights reserved.
+# This free software is distributed under the FreeBSD license (see LICENSE).
+
+require 'redis'
+
+# Namespace: Syndi
+module Syndi
+
+  # This is the central class of Syndi, providing all core functionality.
+  #
+  # It should be additionally noted that for each loaded core library, a readable
+  # instance attribute of the library's name will exist, typically pointing to
+  # an instance of its respective Library class. (e.g. @irc = <Syndi::IRC::Library>)
+  #
+  # @!attribute [r] opts
+  #   @return [Slop] The options object.
+  #
+  #
+  # @!attribute [r] log
+  #   @return [Syndi::Logger] The logging instance.
+  #
+  # @!attribute [r] conf
+  #   @return [Syndi::Config] The configuration instance.
+  #
+  # @!attribute [r] events
+  #   @return [Syndi::API::Events] The event system instance.
+  #
+  # @!attribute [r] clock
+  #   @return [Syndi::API::Timers] The timer system instance.
+  #
+  # @!attribute [r] db
+  #   @return [Redis] The Redis database.
+  #
+  # @!attribute [r] libs
+  #   @return [Array<String>] List of loaded core libraries.
+  #
+  # @!attribute [r] netloop
+  #   @return [Thread] The thread in which #main_loop is running.
+  #
+  # @!attribute [r] sockets
+  #   @return [Array<Object>] A list of socket objects.
+  class Bot
+
+    attr_reader :opts, :log, :conf, :events, :clock, :db, :libs,
+                :netloop, :sockets
+
+    # Create a new instance of Syndi.
+    #
+    # @param [Hash{String => Object}] opts A hash of options.
+    def initialize opts
+      # Save options.
+      @opts = opts
+    end      
+
+    # Initialize this instance.
+    def init
+    
+      # Load configuration
+      load_config
+
+      # Initialize the central event system
+      @events = Syndi::API::Events.new
+
+      # Start the timer system.
+      @clock = Syndi::API::Timers.new
+
+      # Prepare for sockets.
+      @sockets = []
+
+      # Initialize the database
+      @db = load_database
+
+      # Load core libraries.
+      load_libraries
+
+      true
+    end
+
+    # Start the bot.
+    def start
+      
+      # Call the start event.
+      @events.call :start
+
+      # Throw the program into the main loop.
+      @events.threads.each { |thr| thr.join } # block until we're ready to go
+      $log.verbose("Producing a thread and entering the main loop...", VUSEFUL) do
+        @netloop = Thread.new { main_loop }
+        @netloop.join
+      end
+
+    end
+
+    # Daemonize the bot.
+    def daemonize
+      $log.info "Forking into the background. . . ."
+  
+      # Direct all incoming data on STDIN and outgoing data on STDOUT/STDERR to /dev/null.
+      $stdin  =           File.open '/dev/null'
+      $stdout = $stderr = File.open '/dev/null', 'w'
+      
+      # Fork and retrieve the PID.
+      pid = fork
+
+      # Save it to syndi.pid.
+      unless pid.nil?
+        File.open('syndi.pid', 'w') { |io| io.puts pid }
+        exit 0
+      end
+    end
+
+    # Main loop.
+    def main_loop
+      loop do
+        # Build a list of sockets.
+        sockets       = []
+        assoc_objects = {}
+        @sockets.each do |o|
+          unless o.socket.nil? or o.socket.closed?
+            sockets << o.socket
+            assoc_objects[o.socket] = o
+          end
+        end
+        next if sockets.empty?
+
+        # Call #select.
+        ready_read, _, _ = IO.select(sockets, [], [], nil)
+
+        # Iterate through sockets ready for reading.
+        ready_read.each do |socket|
+          @events.call :net_receive, assoc_objects[socket]
+        end
+      end
+    end
+
+    # Terminate the bot.
+    #
+    # @param [String] reason The reason for termination.
+    def terminate reason = 'Terminating'
+      info "Syndi is terminating owing to thus: #{reason}"
+
+      # Call :die
+      @events.call :die, reason
+    
+      # Close the database.
+      @db.disconnect
+
+      # When dying, allow about three seconds for hooks to execute before
+      # fully terminating.
+      sleep 3
+
+      # Delete syndi.pid
+      File.delete 'syndi.pid' unless @opts.foreground?
+
+      exit 0
+    end
+
+    #######
+    private
+    #######
+
+    # Load the configuration.
+    def load_config
+
+      # Try to find the file
+      # if we're a gem, we'll try ~/.syndi/syndi.yml
+      # else we'll try ./conf/syndi.yml
+      confpath = nil
+      if Syndi.gem?
+        confpath = File.join(SYNDI_DIR, 'syndi.yml')
+      else
+        confpath = File.join('conf', 'syndi.yml')
+      end
+      confpath = @opts[:conf] if @opts.conf? # --conf=FILE has supreme precedence
+
+      $log.info "Reading the configuration file #{confpath}..."
+      @conf = Syndi::Config.new File.expand_path(confpath)
+
+    end
+
+    # Load Syndi libraries.
+    def load_libraries
+      
+      $log.info 'Loading core libraries...'
+      @libs = []
+
+      # Iterate through each configured library.
+      @conf['libraries'].each do |lib|
+        lib.dc!
+
+        if @libs.include? lib
+          # Don't load a library more than once!
+          $log.error "Cannot load library twice (#{lib})! Please fix your configuration."
+          next
+        end
+
+        begin
+          load_library lib
+          @libs.push lib
+        rescue => e
+          $log.error_bt "Failed to load core library '#{lib}': #{e}", e.backtrace
+        end
+
+      end
+
+    end
+
+    # Load a core library.
+    def load_library lib
+      # here is where magic occurs to load a library
+      require "syndi/#{lib}"
+      instance_variable_set "@#{lib}".to_sym, Object.const_get("LIBRARY_#{lib.uc}")
+      define_singleton_method(lib.to_sym) { self.instance_variable_get("@#{__method__}".to_sym) }
+    end
+
+    # Load the Redis database.
+    def load_database
+
+      driver = @conf['database']['driver'] || 'redis'
+
+      case driver
+      when 'redis'
+        load_db_redis
+      when 'flatfile'
+        load_db_flatfile
+      end
+
+    end
+
+    # Initializes Redis.
+    def load_db_redis
+
+      config = Hash.new
+      if host = @conf['database']['address']
+        config[:host] = host
+      end
+      if port = @conf['database']['port']
+        config[:port] = port
+      end
+      if path = @conf['database']['path']
+        config[:path] = path
+      end
+
+      redis = Redis.new config
+
+      if passwd = @conf['database']['password']
+        redis.auth passwd
+      end
+      if id = @conf['database']['number']
+        redis.select id
+      end
+
+      redis
+
+    end
+
+    # Initializes Flatfile.
+    def load_db_flatfile
+      FileKV.new 'syndi.db'
+    end
+
+  end # class Bot
+  
+end # module Syndi
+
+# vim: set ts=4 sts=2 sw=2 et: