cortex-reaver 0.0.1 → 0.0.2

data/README

@@ -1,44 +1,74 @@
 CORTEX REAVER - A dangerous Ruby blog engine, with a photographic memory.
+=========================================================================
 
-Cortex Reaver is a blog engine for textual journals, photographs, and projects;
-written using Ramaze and Sequel. Supports tags, comments, and simple
-attachments. Features canonically named URLs (/journals/show/a-post-title) with
-conflict resolution, useful formatting modules for content (HTML sanitizing,
-attachment references, BlueCloth, etc), and custom pages.
+Cortex Reaver is a terrifying machine which stalks the corridors of Citadel
+Station, searching for humans to assimilate into Shodan's perfection.
 
-GETTING STARTED
+Cortex Reaver is also a blog engine for textual journals, photographs, and
+projects; written using Ramaze and Sequel. It supports tags, comments, and
+simple attachments. Features include canonically named URLs
+(/journals/show/a-post-title) with conflict resolution, useful formatting
+modules for content (HTML sanitizing, attachment references, BlueCloth, etc),
+and custom pages.
 
-Dependencies
+Getting Started
+---------------
 
-First, you'll need a database. For MySQL:
+mkdir cortex_reaver     # Create an empty directory for Cortex Reaver to lurk in.
+cd cortex_reaver
+cortex_reaver --migrate # Initialize an SQLite database.
+cortex_reaver --start   # Start the daemon.
 
-create database cortex_reaver;
-grant all privileges on cortex_reaver.* to 'cortex_reaver'@'localhost' 
-  identified by 'some-password' with grant option;
+Then point your web browser at localhost:7000, hit control-x, and log in with
+username "shodan", password "shodan".
+
+You can check Cortex Reaver's status with --status, and when you're done, shut
+it down with --stop.
+
+Configuration
+-------------
 
 You'll need a YAML configuration file to define Cortex Reaver's configuration.
 See proto/cortex_reaver.yaml. If no config file is specified on the command
-line, Cortex Reaver assumes you mean cortex_reaver.yaml in the working
-directory. Copy lib/proto/cortex_reaver.yaml to a fresh directory, and run
+line with --config, Cortex Reaver assumes you mean cortex_reaver.yaml in the
+working directory. Copy lib/proto/cortex_reaver.yaml to get started.
+
+Databases
+---------
 
-bin/cortex_reaver -m -c path/to/cortex_reaver.yaml
+Cortex Reaver uses Sequel (http://sequel.rubyforge.org/), so you can (in
+theory) use any database Sequel supports. By default, Cortex Reaver builds an
+SQLite database in the working directory, but you can set a different database
+in the config file, either as a Sequel string or with hash of options.
+
+For MySQL:
+
+create database cortex_reaver;
+grant all privileges on cortex_reaver.* to 'cortex_reaver'@'localhost' 
+  identified by 'some-password' with grant option;
 
-To wipe the database and set up a fresh schema. Then run
+When you've set up a new database, run cortex_reaver --migrate to update it to
+the latest version. If you need to wipe your database and start over, use
+cortex_reaver --blank to drop the schema and rebuild it.
 
-bin/cortex_reaver -s -c path/to/cortex_reaver.yaml
+Customization
+-------------
 
-To start the server. Cortex Reaver runs on port 7000 by default, and uses the
-Mongrel adapter; you can change both of those in your configuration file.
+You may find development mode useful: it reloads source files when they're
+changed, displays traces for errors instead of 404 and 500 responses, logs
+more, and runs in the console instead of detaching by default. Just set :mode
+=> :development in your configuration.
 
-When you visit your new site, hit control-x (or visit /users/login) to bring up
-a login prompt. The default username and password are both 'shodan'. Then start
-posting journals, photographs, projects, and pages!
+Requests for static objects (images, css, javascript, etc.) is pulled from
+public/, which can be specified in your configuration or defaults to
+`cwd`/public. If a request for a file can't be found there, it's retrieved from
+Cortex Reaver's own public directory in lib/public.
 
-Presumably you'll want to start changing images, stylesheets, etc. around. Just
-create a directory called 'public' and specify its path in your config file.
-Anything in that directory overrides Cortex Reaver's default public files.
+You can also set up your own view templates: copy lib/view to some other
+directory, and specify :view_root in your configuration.
 
-CREDITS
+Credits
+-------
 
 I am indebted to the good folks of #sequel and #ramaze for their many
 suggestions in writing Cortex Reaver, and also to Ryan Grove

data/bin/cortex_reaver

@@ -25,7 +25,7 @@ module CortexReaver
   @values = {}
   parser = OptionParser.new do |o|
     o.on '-c', '--config file', 'Configuration file' do |file|
-      @values[:config_file] = file
+      self.config_file = file
     end
 
     o.on '-f', '--force', 'Just do it' do
@@ -47,23 +47,40 @@ module CortexReaver
       @values[:schema_version] = version ? version.to_i : nil
     end
 
-    o.on '-r', '--reset',
+    o.on '-b', '--blank',
       'Wipes the database and sets up a clean copy of the latest version.' do
-      @action = :reset
+      @action = :blank
+    end
+
+    o.on '-r', '--restart', 'Restart CortexReaver' do
+      @action = :restart
+    end
+
+    o.on '-k', '--stop', 'Stop CortexReaver' do
+      @action = :stop
+    end
+
+    o.on '--status', 'Check CortexReaver status.' do
+      @action = :status
     end
   end
 
   parser.parse! ARGV
 
+
   # Main
   case @action
+  when :status
+    # Make a quick HTTP request to see how we're doing.
+    require 'open-uri'
+    reload_config
+    response = open("http://#{config[:host] || 'localhost'}:#{config[:port]}/")
+    puts response.status.join(' ');
   when :migrate
     version = @values[:schema_version]
 
-    self.config_file = @values[:config_file]
-    self.reload_config
-    self.setup_db
-
+    reload_config
+    setup_db false
     puts "Using database #{config[:database][:host]}/#{config[:database][:database]}."
 
     current_version = Sequel::Migrator.get_current_migration_version(db)
@@ -93,17 +110,22 @@ module CortexReaver
       exit
     end
 
-  when :reset
+  when :blank
     if confirm "Are you sure you wish to wipe the database?"
       # Strangely, calling Migrator.apply to go down and then up doesn't seem to work. :-/
       system($0, '-f', '-m', '0')
       system($0, '-f', '-m')
     end
 
+  when :restart
+    restart
+
   when :start
-    self.config_file = @values[:config_file]
     start
 
+  when :stop
+    stop
+
   else
     abort("Unknown action: #{@action}")
   end

data/lib/cortex_reaver.rb

@@ -5,6 +5,7 @@ begin
   require 'ramaze'
   require 'sequel'
   require 'yaml'
+  require 'socket'
 rescue LoadError => e
   puts e
   puts "You probably need to install some packages Cortex Reaver needs. Try: 
@@ -16,6 +17,7 @@ end
 module CortexReaver
   ROOT = File.expand_path(__DIR__/'..')
   LIB_DIR = ROOT/:lib/:cortex_reaver
+  HOME_DIR = Dir.pwd
   
   # We need the configuration class before everything.
   require LIB_DIR/:config
@@ -33,24 +35,77 @@ module CortexReaver
     @config_file = file
   end
 
-  # Sets the configuration file and reloads
-  def self.configure(file = nil)
-    if file
-      self.config_file = file
-    end
-    reload_config
-  end
-
   def self.db
     @db
   end
 
-  # Load libraries
-  def self.load
-    # Prepare Ramaze
+  # Prepare Ramaze, create directories, etc.
+  def self.init
+    # Tell Ramaze where to find public files and views
     Ramaze::Global.public_root = LIB_DIR/:public
     Ramaze::Global.view_root = config[:view_root]
 
+    # Check directories
+    if config[:public_root] and not File.directory? config[:public_root]
+      # Try to create a public directory
+      begin
+        FileUtils.mkdir_p config[:public_root]
+      rescue => e
+        Ramaze::Log.warn "Unable to create a public directory at #{config[:public_root]}: #{e}."
+      end
+    end
+    if config[:log_root] and not File.directory? config[:log_root]
+      # Try to create a log directory
+      begin
+        FileUtils.mkdir_p config[:log_root]
+        File.chmod 0750, config[:log_root]
+      rescue => e
+        Ramaze::Log.warn "Unable to create a log directory at #{config[:log_root]}: #{e}. File logging disabled."
+        # Disable logging
+        config[:log_root] = nil
+      end
+    end
+
+    # Clear loggers
+    Ramaze::Log.loggers.clear
+
+    unless config[:daemon]
+      # Log to console
+      Ramaze::Log.loggers << Ramaze::Logger::Informer.new
+    end 
+
+    case config[:mode]
+    when :production
+      if config[:log_root]
+        # Log to file
+        Ramaze::Log.loggers << Ramaze::Logger::Informer.new(
+          File.join(config[:log_root], 'production.log'),
+          [:error, :info, :notice]
+        )
+      end
+
+      # Don't reload source code
+      Ramaze::Global.sourcereload = false
+
+      # Don't expose errors
+      Ramaze::Dispatcher::Error::HANDLE_ERROR.update({
+        ArgumentError => [404, 'error_404'],
+        Exception     => [500, 'error_500']
+      })
+    when :development
+      if config[:log_root]
+        # Log to file
+        Ramaze::Log.loggers << Ramaze::Logger::Informer.new(
+          File.join(config[:log_root], 'development.log')
+        )
+      end
+    else
+      raise ArgumentError.new("unknown Cortex Reaver mode #{config[:mode].inspect}. Expected one of [:production, :development].")
+    end
+  end
+
+  # Load libraries
+  def self.load
     # Load controllers and models
     acquire LIB_DIR/:snippets/'**'/'*'
     acquire LIB_DIR/:support/'*'
@@ -65,45 +120,74 @@ module CortexReaver
     @config = CortexReaver::Config.new(config_file)
   end
 
-  def self.start
-    # Load configuration
-    reload_config
-    
-    # Connect to db
-    setup_db
+  # Restart Cortex Reaver
+  def self.restart
+    begin
+      stop
+      sleep 5
+    ensure
+      start
+    end
+  end
 
-    # Load library
-    self.load
+  # Once environment is prepared, run Ramaze
+  def self.run
+    # Shutdown callback
+    at_exit do
+      FileUtils.rm(config[:pidfile]) if File.exist? config[:pidfile]
+    end
 
-    # Go!
-    Ramaze.start :adapter => config[:adapter], :port => config[:port]
-  end
+    Ramaze::Log.info "Cortex Reaver #{Process.pid} stalking victims."
 
-  # Load CortexReaver environment; do everything except start Ramaze
-  def self.setup(file)
-    # Load config
-    @config_file = file
-    reload_config
+    # Run Ramaze
+    Ramaze.startup(
+      :adapter => config[:adapter],
+      :host => config[:host],
+      :port => config[:port]
+    )
+
+    puts "Cortex Reaver finished."
+  end
 
+  # Load Cortex Reaver environment; do everything except start Ramaze
+  def self.setup
     # Connect to DB
     setup_db
 
+    # Prepare Ramaze, check directories, etc.
+    init
+
     # Load library
     self.load
   end
 
-  # Connect to DB
-  def self.setup_db
+  # Connect to DB. If check_schema is false, doesn't check to see that the schema
+  # version is up to date.
+  def self.setup_db(check_schema = true)
     unless config
       raise RuntimeError.new("no configuration available!")
     end
 
+    # Build Sequel connection string
     unless (string = config[:database]).is_a? String
       d = config[:database]
       string = "#{d[:driver]}://#{d[:user]}:#{d[:password]}@#{d[:host]}/#{d[:database]}"
     end
 
-    @db = Sequel.connect(string)
+    begin
+      @db = Sequel.connect(string)
+    rescue => e
+      Ramaze::Log.error("Unable to connect to database: #{e}.")
+      abort
+    end
+
+    # Check schema
+    if check_schema and
+       Sequel::Migrator.get_current_migration_version(@db) !=
+       Sequel::Migrator.latest_migration_version(LIB_DIR/:migrations)
+
+      raise RuntimeError.new("database schema missing or out of date. Please run `cortex_reaver --migrate`.")
+    end
   end
 
   # Disconnect from DB
@@ -111,4 +195,110 @@ module CortexReaver
     @db.disconnect
     @db = nil
   end
+
+  def self.start
+    reload_config
+
+    # Check PID
+    if File.file? config[:pidfile]
+      pid = File.read(config[:pidfile], 20).strip
+      abort "Cortex Reaver already running? (#{pid})"
+    end
+
+    puts "Activating Cortex Reaver."
+    setup
+
+    # Check port availability
+    begin
+      socket = Socket.new(Socket::AF_INET, Socket::SOCK_STREAM, 0)
+      sockaddr = Socket.pack_sockaddr_in(*[config[:port], config[:host]])
+      socket.bind(sockaddr)
+      socket.close
+    rescue => e
+      abort "Unable to bind to port #{config[:host]}:#{config[:port]} (#{e})"
+    end
+
+    if config[:daemon]
+      fork do
+        # Drop console, create new session
+        Process.setsid
+        exit if fork
+
+        # Write pidfile
+        File.open(config[:pidfile], 'w') do |file|
+          file << Process.pid
+        end
+
+        # Move to homedir; drop creation mask
+        Dir.chdir HOME_DIR
+        File.umask 0000
+
+        # Drop stream handles
+        STDIN.reopen('/dev/null')
+        STDOUT.reopen('/dev/null', 'a')
+        STDERR.reopen(STDOUT)
+
+        # Go!
+        run
+      end
+    else
+      # Run in foreground.
+      run
+    end
+  end
+
+  def self.stop
+    reload_config
+
+    unless config[:pidfile]
+      abort "No pidfile to stop."
+    end
+
+    unless File.file? config[:pidfile]
+      abort "Cortex Reaver not running? (check #{config[:pidfile]})"
+    end
+
+    # Get PID
+    pid = File.read(config[:pidfile], 20).strip
+    unless (pid = pid.to_i) != 0
+      abort "Invalid process ID in pidfile (#{pid})."
+    end
+
+    puts "Shutting down Cortex Reaver #{pid}..."
+    
+    # Attempt to end Ramaze nicely.
+    begin
+      # Try to shut down Ramaze nicely.
+      Process.kill('INT', pid)
+      puts "Shut down."
+      killed = true
+    rescue Errno::ESRCH
+      # The process doesn't exist.
+      puts "No Cortex Reaver with pid #{pid}."
+      killed = true
+    rescue => e
+      begin
+        # Try to end the process forcibly.
+        puts "Cortex Reaver #{pid} has gone rogue (#{e}); forcibly terminating..."
+        Process.kill('KILL', pid)
+        puts "Killed."
+        killed = true
+      rescue => e2
+        # That failed, too.
+        puts "Unable to terminate Cortex Reaver: #{e2}."
+        killed = false
+      end
+    end
+
+    # Remove pidfile if killed.
+    if killed
+      begin
+        FileUtils.rm(config[:pidfile])
+      rescue Errno::ENOENT
+        # Pidfile gone
+      rescue => e
+        puts "Unable to remove pidfile #{config[:pidfile]}: #{e}."
+      end
+    end
+  end
 end

data/lib/cortex_reaver/config.rb

@@ -2,20 +2,66 @@ module CortexReaver
   # Contains site-specific configuration information for a CortexReaver site.
   class Config < Hash
     # Pass a YAML file with configuration options. At a minimum, it should specify
-    # database = {:proto, :username, :pasword, :host, :database}
-    # or database = "sequel_connect_string"
+    # :database = {:proto, :username, :pasword, :host, :database}
+    # or :database = "sequel_connect_string"
+    #
+    # :public_root - The directory public files are hosted from. Defaults to
+    #                HOME_DIR/public.
+    # :view_root   - The directory containing erubis view templates. Defaults to
+    #                Cortex Reaver's builtin templates.
+    # :log_root    - The directory that Cortex Reaver should log to. Defaults to
+    #                HOME_DIR/log. If nil, file logging disabled.
+    # :mode        - Cortex Reaver mode: either :development or :production
+    # :daemon      - Whether to daemonize or not. Defaults to :true if :mode
+    #                is :production, otherwise nil.
+    # :adapter     - The Ramaze adapter name (default 'mongrel')
+    # :host        - Host to bind to 
+    # :port        - Port to bind to (default 7000)
+    # :pidfile     - Process ID file for this server. Defaults to 
+    #                HOME_DIR/cortex_reaver_<host>_<port>.pid
+    #
+    # Site configuration options
+    # :site = {
+    #   :name        - The name of the site
+    #   :author      - The site author's name
+    #   :keywords    - Keywords describing the site
+    #   :description - A short description of the site.
+    # }
     def initialize(file)
       # Defaults
-      self[:public_root] = File.join(CortexReaver::LIB_DIR, 'public')
+      self[:database] = 'sqlite:////' + File.join(
+        File.expand_path(CortexReaver::HOME_DIR),
+       'cortex_reaver.db'
+      )
+      self[:public_root] = File.join(CortexReaver::HOME_DIR, 'public')
       self[:view_root] = File.join(CortexReaver::LIB_DIR, 'view')
+      self[:log_root] = File.join(CortexReaver::HOME_DIR, 'log')
+      self[:mode] = :production
       self[:adapter] = 'mongrel'
+      self[:host] = nil
       self[:port] = 7000
 
-      begin
-        self.merge!(YAML.load(File.read(file)))
-      rescue => e
-        raise RuntimeError.new("unable to load local configuration file #{file}: (#{e.message})")
+      self[:site] = {
+        :name => 'Cortex Reaver',
+        :description => "Stalks the dark corridors of this station, converting humans to Shodan's perfection.",
+        :keywords => 'Cortex Reaver, blog',
+        :author => 'Shodan'
+      }
+
+      # Load from file
+      if File.exists? file
+        begin
+          self.merge!(YAML.load(File.read(file)))
+        rescue => e
+          raise RuntimeError.new("unable to load local configuration file #{file}: (#{e.message})")
+        end
       end
+
+      # Pidfile
+      self[:pidfile] ||= File.join(CortexReaver::HOME_DIR, "cortex_reaver_#{self[:host] ? self[:host].to_s + '_' : ''}#{self[:port]}.pid")
+
+      # Daemon mode
+      self[:daemon] ||= true if self[:mode] == :production
     end
   end
 end

data/lib/cortex_reaver/public/css/main.css

@@ -112,7 +112,7 @@ th {
   background: #c6c6c6;
   padding: 6px;
   border-left: 1px solid #bbb;
-  width: 170px;
+  width: 158px;
 }
 
 #sidebar .box {

data/lib/cortex_reaver/version.rb

@@ -1,6 +1,6 @@
 module CortexReaver
   APP_NAME = 'Cortex Reaver'
-  APP_VERSION = '0.0.1'
+  APP_VERSION = '0.0.2'
   APP_AUTHOR = 'aphyr'
   APP_EMAIL = 'aphyr@aphyr.com'
   APP_URL = 'http://aphyr.com'

data/lib/cortex_reaver/view/text_layout.rhtml

@@ -8,7 +8,7 @@
     <meta http-equiv="Content-Style-Type" content="text/css" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     <meta http-equiv="expires" content="0" />
-    <meta name="description" content="<%=attr_h CortexReaver.config[:site][:description] %>" />
+    <meta name="description" content="<%= attr_h CortexReaver.config[:site][:description] %>" />
     <meta name="generator" content="Cortex Reaver <%= CortexReaver::APP_VERSION %>" />
     <meta name="keywords" content="<%= attr_h CortexReaver.config[:site][:keywords] %>" />
     <meta name="author" content="<%= attr_h CortexReaver.config[:site][:author] %>" />

data/lib/proto/cortex_reaver.yaml

@@ -1,11 +1,14 @@
 ---
 # Database connection. You can also just use a Sequel connect() string.
-  :database:
-    :driver: 'mysql'
-    :host: 'localhost'
-    :user: 'cortex_reaver'
-    :password: 'some-password'
-    :database: 'cortex_reaver'
+#  :database:
+#    :driver: 'mysql'
+#    :host: 'localhost'
+#    :user: 'cortex_reaver'
+#    :password: 'some-password'
+#    :database: 'cortex_reaver'
+#
+#  Or something like...
+#  :database: 'sqlite:////tmp/cortex_reaver.db'
 
 # Site-specific configuration parameters
   :site:
@@ -14,15 +17,32 @@
     :keywords: 'Cortex Reaver, Citadel Station'
     :author: 'Shodan'
 
-# Ramaze port and adapter
-#  :adapter: 'ramaze'
-#  :port: 7000
-
 # The static files overlay of your site. You need to own this directory if you
-# want to use attachments.
+# want to use attachments. It will be created for you, if it does not exist.
 #  :public_root: '/var/www/public'
 
 # The directory that contains Cortex Reaver templates. You can copy this from
 # the lib/cortex_reaver directory and customize to your liking, then reference
 # that directory here.
 #  :view_root: '/var/www/view'
+
+# The directory for CortexReaver log files. Defaults to HOME_DIR/log.
+#  :log_root: '/var/www/log'
+
+# Cortex Reaver has two modes: production and development. Production disables debugging
+# error messages (returning 404 and 500 errors instead), daemonizes by default, and logs
+# less.
+#  :mode: :production
+
+# Whether to daemonize (detach from console and lurk silently, awaiting innocent hackers).
+# Defaults to true in production mode, false in development mode.
+#  :daemon: true
+
+# Ramaze host, port, and adapter. Defaults to nil (listens on all interfaces), mongrel,
+# and port 7000.
+#  :host: 127.0.0.1
+#  :adapter: 'mongrel'
+#  :port: 7000
+
+# Process ID file: stores each Cortex Reaver's process ID, so you can control it later.
+#  :pidfile: /var/www/cortex_reaver.pid

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: cortex-reaver
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - aphyr