cortex-reaver 0.2.8 → 0.2.9

data/README

@@ -5,7 +5,7 @@ Cortex Reaver is a terrifying machine which stalks the corridors of Citadel
 Station, searching for humans to assimilate into Shodan's perfection.
 
 Cortex Reaver is also a blog engine for textual journals, photographs, and
-projects; written using Ramaze and Sequel. It supports tags, comments, and
+pages, 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),
@@ -17,29 +17,29 @@ Why Cortex Reaver
 - Adaptible. Runs on every web server and database Ramaze and Sequel support.
 - Visual. Large, beautiful photographs, with concise EXIF support.
 - Comprehensive. Comments, file attachments, and tags on everything.
-- Devastating. The main page of Aphyr.com scales to ~400 requests/second.
+- Devastating. The main page of aphyr.com scales to ~400 requests/second.
 
 Getting Started
 ---------------
 
 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.
+cortex_reaver migrate # Initialize an SQLite database.
+cortex_reaver start   # Start the daemon.
 
 Then point your web browser at localhost:7000, hit control-x, and log in with
 username "shodan", password "citadelstation".
 
-You can check Cortex Reaver's status with --status, and when you're done, shut
-it down with --stop.
+You can check Cortex Reaver's status with status, and when you're done, shut
+it down with cortex_reaver stop.
 
 Configuration
 -------------
 
-You'll need a YAML configuration file to define Cortex Reaver's configuration.
+You can use 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 with --config, Cortex Reaver assumes you mean cortex_reaver.yaml in the
-working directory. Copy lib/proto/cortex_reaver.yaml to get started.
+working directory.
 
 Databases
 ---------
@@ -55,26 +55,39 @@ create database cortex_reaver;
 grant all privileges on cortex_reaver.* to 'cortex_reaver'@'localhost' 
   identified by 'some-password' with grant option;
 
-When you've set up a new database, run cortex_reaver --migrate to update it to
+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.
+cortex_reaver blank to drop the schema and rebuild it.
+
+You can export your database to an SQLite file with cortex_reaver dump, and restore it with cortex_reaver load. This can help with migrating between database systems.
 
 Customization
 -------------
 
 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.
+more, and runs in the console instead of detaching by default. Just set mode =>
+:development in your configuration.
+
+Cortex Reaver includes Erubis layouts and templates, static resources, CSS, and
+javascript files in lib/cortex_reaver/layout, lib/cortex_reaver/view, and
+lib/cortex_reaver/public. CR will override these resources with your local
+directory: if you request /images/foo.png, it will check
+<local_dir>/public/images/foo.png first, then
+<cortex_reaver_dir>/public/images/foo.png. CSS and JS files are compiled into
+single cached files from several smaller files. If you want, you can
+selectively replace parts of the default theme by creating css files with the
+same names in <local_dir>/public/css/. The same applies to views and layouts.
+You can also create new resources; they will be merged for you.
+
+You can control the paths and search patterns in the configuration: see
+lib/cortex_reaver/config.rb.
 
 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.
 
-You can also set up your own view templates: copy lib/view to some other
-directory, and specify :view_root in your configuration.
-
 Credits
 -------
 

data/bin/cortex_reaver

@@ -1,14 +1,27 @@
 #!/usr/bin/ruby
 
 require 'rubygems'
-require 'optparse'
+require 'trollop'
 require 'ramaze'
 require __DIR__ + '/../lib/cortex_reaver'
+require 'irb'
+
+# IRB monkeypatch to let us load a custom context object
+class IRB::Irb
+  alias initialize_orig initialize
+  def initialize(workspace = nil, *args)
+    default = IRB.conf[:DEFAULT_OBJECT]
+    workspace ||= IRB::WorkSpace.new default if default
+    initialize_orig(workspace, *args)
+  end
+end
+
+class CortexReaver::Runner
+  COMMANDS = ['blank', 'start', 'status', 'reload', 'restart', 'stop', 'console', 'dump', 'load']
 
-module CortexReaver
   # Asks a question and returns a true_false answer
-  def self.confirm(question)
-    return true if @values[:force]
+  def confirm(question)
+    return true if @global_opts[:force]
 
     puts question + " (yes/no)"
     print '> '
@@ -21,86 +34,95 @@ module CortexReaver
     end
   end
 
-  # Parse options
-  @values = {}
-  parser = OptionParser.new do |o|
-    o.on '-b', '--blank',
-      'Wipes the database and sets up a clean copy of the latest version.' do
-      @action = :blank
-    end
-
-    o.on '-c', '--config file', 'Configuration file' do |file|
-      self.config_file = file
-    end
-
-    o.on '-d', '--dump file', 'Dump database' do |file|
-      @action = :dump
-      @values[:dump_file] = file
-    end
-
-    o.on '-f', '--force', 'Just do it' do
-      @values[:force] = true
-    end
-
-    o.on '-h', '--help', 'Show help' do
-      @action = :help
-    end
-
-    o.on '-i', '--irb', 'Start an IRB session' do
-      @action = :irb
-    end
-
-    o.on '-k', '--stop', 'Stop Cortex Reaver' do
-      @action = :stop
-    end
-
-    o.on '-l', '--load file', 'Load database' do |file|
-      @action = :load
-      @values[:load_file] = file
-    end
-
-    o.on '-m', '--migrate [version]',
-      'Migrate the database to schema version, or to the latest version' do |version|
-      @action = :migrate
-      @values[:schema_version] = version ? version.to_i : nil
-    end
-
-    o.on '-r', '--restart', 'Restart Cortex Reaver' do
-      @action = :restart
+  def initialize
+    # Parse options
+    @global_opts = Trollop::options do
+      banner "#{CortexReaver::APP_NAME} #{CortexReaver::APP_VERSION}"
+      version CortexReaver::APP_VERSION
+      banner <<EOF
+Syntax: cortex_reaver [opts] command [command_opts]
+
+blank               Wipes the database and sets up a clean copy of the
+                    latest version
+console             Starts an IRB session
+dump <to_file>      Dump database to file
+load <from_file>    Load a database dump
+migrate [version]   Migrate the database to the given schema version, or to 
+                    the latest schema
+reload              Reload CSS, JS, configuration, etc.
+restart             Restart Cortex Reaver
+start               Start Cortex Reaver
+status              Check the status of the local CortexReaver via HTTP.
+stop                Stop Cortex Reaver
+
+Options:
+
+EOF
+
+      opt :force, "Just do it", :default => false
+      opt :config, "Configuration file"
+      stop_on COMMANDS
     end
 
-    o.on '-s', '--start',
-      'Start the Cortex Reaver server' do
-      @action = :start
+    if file = @global_opts[:config]
+      CortexReaver.config_file = file
     end
 
-    o.on '-t', '--test',
-      'Run tests' do
-      @action = :test
-    end
-
-    o.on '--status', 'Check Cortex Reaver status' do
-      @action = :status
+    @command = ARGV.shift
+    @opts = case @command
+      when "blank"
+        blank
+      when 'console'
+        console 
+      when "dump"
+        if file = ARGV.shift
+          dump file
+        else
+          abort "No dump file given"
+        end
+      when "load"
+        if file = ARGV.shift
+          self.load file
+        else
+          abort "No load file given"
+        end
+      when "migrate"
+        if version = ARGV.shift
+          migrate version.to_i
+        else
+          migrate
+        end
+      when 'restart'
+        restart
+      when 'reload'
+        reload
+      when 'start'
+        start
+        @opts = Trollop::options do
+          opt :daemon, :type => :boolean, :default => nil
+        end
+      when 'status'
+        status
+      when 'stop'
+        stop
+      when 'test'
+      else
+        Trollop::die "unknown subcommand #{@command.inspect}"
     end
   end
 
-  parser.parse! ARGV
-
-  # Main
-  case @action
-  when :dump
-    # Dump the database to disk
+  # Dump the database to disk
+  def dump(file)
+    require 'sequel/extensions/migration'
     
     # Connect to current DB
-    reload_config
-    setup_db false
-    require 'sequel/extensions/migration'
-    current_version = Sequel::Migrator.get_current_migration_version(db)
+    CortexReaver.reload_config
+    CortexReaver.setup_db false
+    current_version = Sequel::Migrator.get_current_migration_version(CortexReaver.db)
 
-    puts "Using database #{config[:database][:host]}/#{config[:database][:database]}."
+    puts "Using database #{CortexReaver.config[:database][:host]}/#{CortexReaver.config[:database][:database]}."
 
     # Prepare dump file
-    file = @values[:dump_file]
     if File.file? file
       exit unless confirm("Overwrite #{File.expand_path(file)} with current Cortex Reaver database?")
       FileUtils.rm file
@@ -108,10 +130,10 @@ module CortexReaver
 
     # Connect to dump DB
     dump = Sequel.connect "sqlite:////#{File.expand_path(file)}"
-    Sequel::Migrator.apply dump, File.join(LIB_DIR, 'migrations'), current_version
+    Sequel::Migrator.apply dump, File.join(CortexReaver::LIB_DIR, 'migrations'), current_version
 
     # Copy tables
-    db.tables.each do |table|
+    CortexReaver.db.tables.each do |table|
       puts "Table #{table} (#{db[table].count} rows)..."
       dump_table = dump[table]
       db[table].each do |row|
@@ -120,61 +142,62 @@ module CortexReaver
     end   
         
     puts "Dumped database to #{file}."
+  end
 
-  when :load
-    # Load an SQLite database from disk.
-
+  # Load an SQLite database from disk.
+  def load(file)
+    require 'sequel/extensions/migration'
+    
     # Connect to dump DB
-    file = @values[:load_file]
     dump = Sequel.connect "sqlite:////#{File.expand_path(file)}"
-    require 'sequel/extensions/migration'
     current_version = Sequel::Migrator.get_current_migration_version(dump)
 
     # Connect to current DB
-    reload_config
-    setup_db false
-    puts "Using database #{config[:database][:host]}/#{config[:database][:database]}."
+    CortexReaver.reload_config
+    CortexReaver.setup_db false
+    puts "Using database #{CortexReaver.config[:database][:host]}/#{CortexReaver.config[:database][:database]}."
 
     unless confirm("Overwrite current database with #{File.expand_path(file)}?")
       exit
     end
      
     # Drop current migrations and move to the dump's version
-    system($0, '-f', '-m', '0')
-    Sequel::Migrator.apply db, File.join(LIB_DIR, 'migrations'), current_version
+    system($0, '-f', 'migrate', '0')
+    Sequel::Migrator.apply CortexReaver.db, File.join(CortexReaver::LIB_DIR, 'migrations'), current_version
 
     # Copy tables
     dump.tables.each do |table|
       puts "Table #{table} (#{dump[table].count} rows)..."
-      db_table = db[table]
+      db_table = CortexReaver.db[table]
       dump[table].each do |row|
         db_table << row
       end
     end   
         
     puts "Database #{file} loaded."
+  end
 
-  when :status
-    # Make a quick HTTP request to see how we're doing.
+  # Make a quick HTTP request to see how we're doing.
+  def status
     require 'open-uri'
-    reload_config
-    response = open("http://#{config[:host] || 'localhost'}:#{config[:port]}/")
+    CortexReaver.reload_config
+    response = open("http://#{CortexReaver.config[:host] || 'localhost'}:#{CortexReaver.config[:port]}/")
     puts response.status.join(' ');
+  end
 
-  when :migrate
-    version = @values[:schema_version]
-
+  def migrate(version = nil)
+    require 'sequel/extensions/migration'
+    
     # Get ready
-    reload_config
-    setup_db false
-    self.load
-    init
+    CortexReaver.reload_config
+    CortexReaver.setup_db false
+    CortexReaver.load
+    CortexReaver.init
 
-    puts "Using database #{config[:database][:host]}/#{config[:database][:database]}."
+    puts "Using database #{CortexReaver.config[:database][:host]}/#{CortexReaver.config[:database][:database]}."
 
-    require 'sequel/extensions/migration'
-    current_version = Sequel::Migrator.get_current_migration_version(db)
-    latest_version = Sequel::Migrator.latest_migration_version(File.join(LIB_DIR, 'migrations'))
+    current_version = Sequel::Migrator.get_current_migration_version(CortexReaver.db)
+    latest_version = Sequel::Migrator.latest_migration_version(File.join(CortexReaver::LIB_DIR, 'migrations'))
 
     if version == current_version and current_version == latest_version
       puts "The database is already at the latest version (#{latest_version})."
@@ -194,61 +217,56 @@ module CortexReaver
 
     if confirm message
       puts "Migrating database from version #{current_version} to version #{version}..."
-      Sequel::Migrator.apply(db, File.join(LIB_DIR, 'migrations'), version)
+      Sequel::Migrator.apply(CortexReaver.db, File.join(CortexReaver::LIB_DIR, 'migrations'), version)
       puts "Done."
     else
       exit
     end
+  end
 
-  when :blank
+  def 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')
+      system($0, '-f', 'migrate', '0')
+      system($0, '-f', 'migrate')
     end
+  end
 
-  when :help
-    puts "Cortex Reaver #{APP_VERSION}: A dangerous Ruby blog engine, with a photographic memory."
-    puts parser.help
-
-  when :irb
+  def console
+    require 'irb'
+    require 'irb/completion'
+    
     # Start an IRB session
-    reload_config
-    setup
+    CortexReaver.reload_config
+    CortexReaver.setup
 
     # Don't let IRB try to interpret our command line
     ARGV.clear
 
-    require 'irb'
-    require 'irb/completion'
-
-    # IRB monkeypatch to let us load a custom context object
-    class IRB::Irb
-      alias initialize_orig initialize
-      def initialize(workspace = nil, *args)
-        default = IRB.conf[:DEFAULT_OBJECT]
-        workspace ||= IRB::WorkSpace.new default if default
-        initialize_orig(workspace, *args)
-      end
-    end
-
     IRB.conf[:DEFAULT_OBJECT] = CortexReaver
     IRB.start
+  end
 
-  when :restart
-    restart
+  def reload
+    CortexReaver.reload
+  end
 
-  when :start
-    start
+  def restart
+    CortexReaver.restart
+  end
 
-  when :stop
-    stop
+  def start
+    CortexReaver.start
+  end
 
-  when :test
-    require File.join(LIB_DIR, '..', '..', 'spec', 'spec')
+  def stop
+    CortexReaver.stop
+  end
 
-  else
-    abort("Unknown action: #{@action}")
+  def test
+    require File.join(CortexReaver::LIB_DIR, '..', '..', 'spec', 'spec')
   end
 end
+
+CortexReaver::Runner.new

data/lib/cortex_reaver.rb

@@ -33,6 +33,11 @@ module CortexReaver
   require File.join(LIB_DIR, 'version')
   require File.join(LIB_DIR, 'config')
 
+  # Reload on sighup
+  trap 'HUP' do
+    reload_app
+  end
+
   # Reads files from stock_dir and custom_dir matching pattern, and appends
   # their contents. Returns a string.
   def self.collect_files(stock_dir, custom_dir, pattern = /^[^\.].+/, opts = {})
@@ -306,6 +311,48 @@ module CortexReaver
     end
   end
 
+  # Tells the running CortexReaver to reload.
+  def self.reload
+    reload_config
+
+    unless config.pidfile
+      abort "No pidfile to reload."
+    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 "Reloading Cortex Reaver #{pid}..."
+    
+    begin
+      # Try to shut down Ramaze nicely.
+      Process.kill('HUP', pid)
+      puts "Done."
+    rescue Errno::ESRCH
+      # The process doesn't exist.
+      puts "No Cortex Reaver with pid #{pid}."
+    rescue => e
+      # That failed, too.
+      puts "Unable to reload Cortex Reaver: #{e}."
+    end
+  end
+
+  # Reloads the app without restarting.
+  def self.reload_app
+    self.reload_config
+    self.load
+    self.init
+    self.compile_css
+    self.compile_js
+  end
+
   # Reloads the site configuration
   def self.reload_config
     begin
@@ -483,6 +530,11 @@ module CortexReaver
         run
       end
     else
+      # Write pidfile
+      File.open(config.pidfile, 'w') do |file|
+        file << Process.pid
+      end
+      
       # Run in foreground.
       run
     end

data/lib/cortex_reaver/controller/main.rb

@@ -28,7 +28,7 @@ module CortexReaver
       :pages
 
     cache_action(:method => :index, :ttl => 120) do
-      user.id.to_i.to_s + flash.inspect + request.path_info
+      user.id.to_i.to_s + flash.inspect
     end
     cache_action(:method => :sitemap, :ttl => 300) do
       request.path_info

data/lib/cortex_reaver/helper/error.rb

@@ -3,11 +3,11 @@ module Ramaze
     # Provides some error pages
     module Error
       def error_404
-        respond 'Page not found', 404
+        respond! 'Page not found', 404, "Content-Type" => "text/plain"
       end
 
       def error_403
-        respond 'Forbidden', 403
+        respond! 'Forbidden', 403, "Content-Type" => "text/plain"
       end
     end
   end

data/lib/cortex_reaver/version.rb

@@ -1,6 +1,6 @@
 module CortexReaver
   APP_NAME = 'Cortex Reaver'
-  APP_VERSION = '0.2.8'
+  APP_VERSION = '0.2.9'
   APP_AUTHOR = 'Kyle Kingsbury'
   APP_EMAIL = 'aphyr@aphyr.com'
   APP_URL = 'http://aphyr.com'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: cortex-reaver
 version: !ruby/object:Gem::Version 
-  version: 0.2.8
+  version: 0.2.9
 platform: ruby
 authors: 
 - Kyle Kingsbury
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-24 00:00:00 -08:00
+date: 2010-02-09 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -142,6 +142,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.1.9
     version: 
+- !ruby/object:Gem::Dependency 
+  name: trollop
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.15"
+    version: 
 description: 
 email: aphyr@aphyr.com
 executables: