cortex-reaver 0.1.0 → 0.2.0

data/lib/cortex_reaver/cache.rb

@@ -0,0 +1,23 @@
+# A little no-op cache
+module CortexReaver
+  class Cache
+    class Noop
+      include Innate::Cache::API
+      def cache_clear; end
+
+      def cached_delete(key, *keys)
+        nil
+      end
+      
+      def cache_fetch(key, default = nil)
+        default
+      end
+
+      def cache_setup(host, user, app, cache); end
+    
+      def cache_store(key, value, options = {})
+        value
+      end
+    end
+  end
+end

data/lib/cortex_reaver/config.rb

@@ -1,92 +1,196 @@
 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"
-    # :root        - The directory containing public/, layout/, and view/. 
-    #                Defaults to HOME_DIR.
-    # :log_root    - The directory that Cortex Reaver should log to. Defaults to
-    #                HOME_DIR/log. If nil, file logging disabled.
-    # :plugin_root - The directory that Cortex Reaver plugins live in. Defaults
-    #                to HOME_DIR/plugins.
-    # :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 'thin')
-    # :cache       - The Ramaze cache to use (default: :memory)
-    # :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
-    # :compile_views - Whether to cache compiled view templates. Defaults to
-    #                  true in production mode.
-    # :plugins     - Which plugins to enable. Defaults to [].
-    #
-    # 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)
+  class Config < Construct
+    def initialize(*args)
+      super *args
+
       # Defaults
-      self[:database] = 'sqlite:////' + File.join(
-        File.expand_path(CortexReaver::HOME_DIR),
-       'cortex_reaver.db'
-      )
-      self[:root] = CortexReaver::HOME_DIR
-      self[:log_root] = File.join(CortexReaver::HOME_DIR, 'log')
-      self[:plugin_root] = File.join(CortexReaver::HOME_DIR, 'plugins')
-      self[:mode] = :production
-      self[:adapter] = 'thin'
-      self[:cache] = :memory
-      self[:host] = nil
-      self[:port] = 7000
-      self[:plugins] = []
-
-      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})")
+      define :root,
+        :desc => 'The local directory where CortexReaver runs.',
+        :default => CortexReaver::HOME_DIR
+      define :log_root,
+        :desc => 'Directory where logs are stored.',
+        :default => File.join(root, 'log')
+      define :layout_root,
+        :desc => 'Local directory where layouts are found.',
+        :default => File.join(root, 'layout')
+      define :plugin_root,
+        :desc => 'Local directory where plugins are found.',
+        :default => File.join(root, 'plugins')
+      define :public_root,
+        :desc => 'Local directory where public files are found.',
+        :default => File.join(root, 'public')
+      define :view_root,
+        :desc => 'Local directory where views are found.',
+        :default => File.join(root, 'view')
+
+
+      define :database, :default => Construct.new
+      database.define :adapter,
+        :desc => 'Database adapter',
+        :default => 'sqlite'
+      database.define :username,
+        :desc => 'Username',
+        :default => nil
+      database.define :password,
+        :desc => 'Database password',
+        :default => nil
+      database.define :host,
+        :desc => 'Host to connect to for the database.',
+        :default => nil
+      database.define :port,
+        :desc => 'Database port',
+        :default => nil
+      database.define :database,
+        :desc => 'The database on the server to connect to.',
+        :default => '/' + File.expand_path(File.join(root, 'cortex_reaver.db'))
+      database.define :string,
+        :desc => 'A Sequel connection string. If present, overrides the other DB fields.',
+        :default => nil
+
+      def database.str
+        if string
+          string
+        else
+          str = ''
+          str << adapter + '://' if adapter
+          str << username if username
+          str << ':' + password if username and password
+          str << '@' if username or password
+          str << host if host
+          str << ':' + port if host and port
+          str << '/'
+          str << database if database
         end
       end
 
-      # Pidfile
-      self[:pidfile] ||= File.join(CortexReaver::HOME_DIR, "cortex_reaver_#{self[:host] ? self[:host].to_s + '_' : ''}#{self[:port]}.pid")
+      define :mode,
+        :desc => 'Development or production mode.',
+        :default => :production
+      define :adapter,
+        :desc => 'The web server adapter used for Cortex Reaver.',
+        :default => 'thin'
+      define :cache,
+        :desc => 'The caching system used. One of :memory or :memcache',
+        :default => :memory
+      define :host,
+        :desc => 'Host address to bind to.',
+        :default => nil
+      define :port,
+        :desc => 'Port to bind to.',
+        :default => 7000
+
+      define :memcache,
+        :desc => "Memcache options",
+        :default => Construct.new
+
+      memcache.define :servers,
+        :desc => "Servers to use. An array of strings like 'host:port:weight'",
+        :default => ['localhost']
+
+      define :plugins,
+        :desc => 'Plugins configuration space.',
+        :default => Construct.new
+      plugins.define :enabled, 
+        :desc => 'Plugin names to enable.',
+        :default => []
+
+      define :site,
+        :desc => 'Site configuration options',
+        :default => Construct.new
+      site.define :url,
+        :desc => 'The URL base for the web site. No trailing /.',
+        :default => 'http://localhost'
+      site.define :name,
+        :desc => 'The name of this web site. Used in titles, metadata, etc.',
+        :default => 'Cortex Reaver'
+      site.define :description,
+        :desc => 'A brief description of this site.',
+        :default => "Stalks the dark corridors of this station, converting humans to Shodan's perfection."
+      site.define :keywords,
+        :desc => 'Site keywords',
+        :default => 'Cortex Reaver, blog'
+      site.define :author,
+        :desc => 'The primary author of this site, used in copyright & metadata.',
+        :default => 'Shodan'
 
-      # Daemon mode
-      self[:daemon] ||= true if self[:mode] == :production
+      define :pidfile,
+        :desc => 'Filename which stores the process ID of Cortex Reaver.',
+        :default => File.join(root, "cortex_reaver_#{host ? host.to_s + '_' : ''}#{port}.pid")
+      define :daemon,
+        :desc => "Whether to daemonize. Enabled by default in production mode."
+      define :compile_views,
+        :desc => 'Whether to compile views. Enabled by default in production.'
 
-      # Compile views
-      self[:compile_views] ||= true if self[:mode] == :production
+      define :view, 
+        :desc => "Configuration options for content display.",
+        :default => Construct.new
+      view.define :sections,
+        :desc => "A list of top-level sections for navigation. First is the human-readable name, and second is the URI for the link.",
+        :default => [
+          ['Journals', '/journals'],
+          ['Photographs', '/photographs'],
+          ['Tags', '/tags'],
+          ['Comments', '/comments'],
+          ['About', '/about']
+        ]
+      view.define :sidebar,
+        :desc => "An array of sidebars: [path, view]. Path is matched against the current request path. * globs to any non-slash characters, ** globs to all characters. The view is a string referencing the view in view/sidebar/ to render.
+        
+For example, if you wanted to render view/sidebar/tweet.rhtml using the twitter plugin, but only on the main page, you could do:
+
+  ['/', 'twitter']
+
+Or to render a related entries box on all photograph pages...
+
+  ['/photographs/show/*', 'related']
+
+You can also just provide a regex for the path, in which case it is matched directly against path_info. For example, here's how I show some custom tags on /photographs and other photo index pages:
+
+  [/^\/photographs(\/(page|tagged))?/, 'explore_photos']
+  [/^\/journals(\/(page|tagged))?/, 'explore_journals']
+",
+        :default => [
+          ['**', 'sections'],
+          ['/', 'photographs']
+        ]
+
+      define :css,
+        :desc => "An array of CSS files to load first, in order.",
+        :default => []
+      define :js,
+        :desc => "An array of Javascript files to load first, in order.",
+        :default => [
+          'jquery.js',
+          'jquery.color.js',
+          'jquery.dimensions.js',
+          'jquery.corners.min.js',
+          'jquery.hotkeys-0.7.9.js',
+          'cookie.js'
+        ]
     end
-    
-    def public_root
-      if self[:root]
-        File.join(self[:root], 'public')
+
+    def compile_views
+      if include? :compile_views
+        self[:compile_views]
+      else
+        mode == :production
       end
     end
 
-    def view_root
-      if self[:root]
-        File.join(self[:root], 'view')
+    def daemon
+      if include? :daemon
+        self[:daemon]
+      else
+        mode == :production
       end
     end
 
-    def layout_root
-      if self[:root]
-        File.join(self[:root], 'layout')
+    # Saves self to disk
+    def save
+      Ramaze::Log.info "Saving config #{to_yaml}"
+      File.open(CortexReaver.config_file, 'w') do |file|
+        file.write to_yaml
       end
     end
   end

data/lib/cortex_reaver/controller/admin.rb

@@ -1,6 +1,5 @@
 module CortexReaver
-  class AdminController < Controller
-    
+  class AdminController < Controller    
     map '/admin'
 
     layout(:text) do
@@ -13,17 +12,44 @@ module CortexReaver
       require_roles :admin
     end
 
+    def self.jobs
+      @jobs ||= {}
+    end
+
     def index
     end
 
+    def configuration
+      if request.post?
+        begin
+          # Update config
+          # View sections
+          CortexReaver.config.view.sections = []
+          request['view.sections'].split("\n").each do |line|
+            parts = line.strip.split(' ')
+            if parts.size > 1
+              CortexReaver.config.view.sections << [parts[0..-2].join(' '), parts[-1]]
+            end
+          end
+
+          # Save
+          CortexReaver.config.save
+          flash[:notice] = "Configuration saved."
+        rescue => e
+          Ramaze::Log.error e.inspect + e.backtrace.join("\n")
+          flash[:error] = "Unable to update configuration: #{h e}"
+        end
+      end
+    end
+
     # Recalculate comment counts
     def update_comments
-      [Journal, Page, Project, Photograph].each do |klass|
+      [Journal, Page, Photograph].each do |klass|
         klass.refresh_comment_counts
       end
 
       flash[:notice] = "Comment counts updated."
-      redirect Rs()
+      redirect rs()
     end
 
     # Recalculate tag counts and vacuum unused tags
@@ -34,5 +60,39 @@ module CortexReaver
         @deleted << tag.destroy
       end
     end
+
+    def regenerate_caches
+      [Journal, Page, Comment].each do |klass|
+        klass.refresh_render_caches
+      end
+      redirect rs()
+    end
+
+    def regenerate_photo_sizes_status
+      if job = self.class.jobs[:regenerate_photo_sizes]
+        respond "{'i':#{job[:i]},'total':#{job[:total]}}"
+      else
+        respond '{}'
+      end
+    end
+
+    # Regenerates thumbnails on photographs
+    def regenerate_photo_sizes
+      unless self.class.jobs[:regenerate_photo_sizes]
+        self.class.jobs[:regenerate_photo_sizes] = Thread.new do
+          Thread.current.priority = -2
+          Thread.current[:total] = Photograph.count
+          while photo = (photo ? photo.next : Photograph.first)
+            Thread.current[:photo] = photo
+            Thread.current[:i] = photo.position
+            photo.regenerate_sizes
+          end
+
+          # Done
+          self.class.jobs[:regenerate_photo_sizes] = nil
+          Thread.exit
+        end
+      end
+    end
   end
 end

data/lib/cortex_reaver/controller/comment.rb

@@ -29,7 +29,6 @@ module CortexReaver
       comment.comment_id = request[:comment_id]
       comment.journal_id = request[:journal_id]
       comment.photograph_id = request[:photograph_id]
-      comment.project_id = request[:project_id]
     end
 
     on_create do |comment, request|
@@ -49,8 +48,10 @@ module CortexReaver
       journal.updater = session[:user]
     end
 
-    for_feed do |comment, x|
-      x.content comment.body_cache, :type => 'html'
+    for_feed do |comment, entry|
+      entry << (content = LibXML::XML::Node.new('content'))
+      entry['type'] = 'html'
+      entry << comment.body_cache.to_s
     end
 
     # We only really care about tracking recent comments.
@@ -84,7 +85,6 @@ module CortexReaver
           @comment.comment_id = request[:comment_id]
           @comment.journal_id = request[:journal_id]
           @comment.photograph_id = request[:photograph_id]
-          @comment.project_id = request[:project_id]
 
           if session[:user]
             # A user is logged in. Use their account.

data/lib/cortex_reaver/controller/controller.rb

@@ -1,9 +1,10 @@
 module CortexReaver
   class Controller < Ramaze::Controller
-    trait :app => :cortex_reaver
+    # TODO: This breaks now. Why?
+    # trait :app => :cortex_reaver
     engine :Erubis
     layout :text
-    helper :form, :auth, :navigation, :template, :workflow, :error
+    helper :form, :auth, :navigation, :workflow, :error, :sidebar, :aspect
   end
 end
 
@@ -14,7 +15,6 @@ module CortexReaver
   require File.join(LIB_DIR, 'controller', 'page')
   require File.join(LIB_DIR, 'controller', 'journal')
   require File.join(LIB_DIR, 'controller', 'photograph')
-  require File.join(LIB_DIR, 'controller', 'project')
   require File.join(LIB_DIR, 'controller', 'comment')
   require File.join(LIB_DIR, 'controller', 'tag')
   require File.join(LIB_DIR, 'controller', 'documentation')

data/lib/cortex_reaver/controller/journal.rb

@@ -45,8 +45,10 @@ module CortexReaver
       journal.updater = session[:user]
     end
 
-    for_feed do |journal, x|
-      x.content journal.body_cache, :type => 'html'
+    for_feed do |journal, entry|
+      entry << (content = LibXML::XML::Node.new('content'))
+      content << journal.body_cache.to_s
+      content['type'] = 'html'
     end
   end
 end