microengine 0.0.1

data/lib/microengine/admin_exception.rb

@@ -0,0 +1,31 @@
+=begin
+Logic to edit site from web interface.
+Copyright (C) 2008 Andrey "A.I." Sitnik <andrey@sitnik.ru>
+
+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 3 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 General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+=end
+
+module Microengine
+  # Exception in admin page ot action. 
+  # Contain message and code to translate message in error page.
+  class AdminException < Exception
+    
+    attr_reader :code
+    
+    def initialize(msg = nil, code = nil)
+      super(msg)
+      @code = code
+    end
+  end
+end

data/lib/microengine/admin_page.rb

@@ -0,0 +1,199 @@
+=begin
+Logic to edit site from web interface.
+Copyright (C) 2008 Andrey "A.I." Sitnik <andrey@sitnik.ru>
+
+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 3 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 General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+=end
+
+module Microengine
+  # Admin interface
+  class AdminPage
+    
+    def initialize(http, path, admin)
+      @http = http
+      @path = '/' + path
+      @admin = admin
+      @show_password = http.cookie['password'].nil?
+      
+      #TODO Layout for /admin/refresh/
+      if not @http.post['layout'].nil?
+        @layout = @admin.config['default_layout']
+      elsif File.exists? MICROENGINE_ROOT + "/content#{@path}layout"
+        begin
+          @layout = IO.read MICROENGINE_ROOT + "/content#{@path}layout"
+        rescue
+          @layout = @admin.config['default_layout']
+        end
+      else
+        @layout = @admin.config['default_layout']
+      end
+      @layout_langs = []
+      Dir.glob(MICROENGINE_ROOT + "/layouts/#{@layout}/*.yaml") do |lang|
+        @layout_langs.push File.basename(lang, '.yaml')
+      end
+      
+      @lang = language
+      load_translation
+    end
+    
+    # Show interface to edit page
+    def editor
+      if '/admin/' == @path[0..6]
+        error 'admin_subdir'
+        return
+      end
+      
+      if not File.exists? MICROENGINE_ROOT + "/layouts/#{@layout}/#{@lang}.yaml"
+        @old_lang = @lang
+        @lang = @admin.dispatcher.language(@http, @layout_langs)
+        error 'untranslated_layout'
+        return
+      end
+      
+      @layouts = []
+      @untranslated_layouts = {}
+      if @admin.cache.langs[@path].nil?
+        langs = [@lang]
+      else
+        langs = @admin.cache.langs[@path] + [@lang]
+      end
+      Dir.glob(MICROENGINE_ROOT + '/layouts/*/layout.rhtml') do |file|
+        layout = file.split('/')[-2]
+        @layouts.push layout
+        layout_langs = []
+        Dir.glob(MICROENGINE_ROOT + "/layouts/#{layout}/*.yaml") do |lang|
+          layout_langs.push File.basename(lang, '.yaml')
+        end
+        untranslated = langs - layout_langs
+        if not untranslated.empty?
+          @untranslated_layouts[layout] = untranslated
+        end
+      end
+      
+      if @http.post['body'].nil?
+        begin
+          @body = IO.read MICROENGINE_ROOT + "/content#{@path}#{@lang}.body"
+        rescue
+          @body = ''
+        end
+      else
+        @body = @http.post['body']
+      end
+      
+      if @http.post['header'].nil?
+        begin
+          @header = IO.read MICROENGINE_ROOT + "/content#{@path}#{@lang}.header"
+        rescue
+          @header = ''
+        end
+      else
+        @header = @http.post['header']
+      end
+      
+      display 'editor'
+    end
+    
+    # Show interface to delete page
+    def deleter
+      if '/admin/' == @path[0..6]
+        error 'admin_subdir'
+        return
+      end
+      if @admin.cache.langs[@path].nil?
+        @admin.dispatcher.not_found @http
+        return
+      end
+      if ['/404/', '/403/', '/'].include? @path
+        error 'delete_system'
+        return
+      end
+      @body = IO.read MICROENGINE_ROOT + "/content#{@path}#{@lang}.body"
+      display 'deleter'
+    end
+    
+    # Show interface to delete translation
+    def untranslater
+      if '/admin/' == @path[0..6]
+        error 'admin_subdir'
+        return
+      end
+      if @admin.cache.langs[@path].nil?
+        @admin.dispatcher.not_found @http
+        return
+      end
+      
+      @body = IO.read MICROENGINE_ROOT + "/content#{@path}#{@lang}.body"
+      display 'untranslater'
+    end
+    
+    # Show interface to input password for refresh cache
+    def refresher
+      display 'refresher'
+    end
+    
+    # Error
+    def error(code)
+      @code = code
+      display 'error'
+    end
+    
+    private
+    
+    # Return page language to admin action
+    def language
+      if @http.get['lang'].nil?
+        langs = @admin.cache.langs[@path]
+        if langs.nil?
+          langs = @layout_langs
+        end
+        @admin.dispatcher.language(@http, langs)
+      else
+        @http.get['lang']
+      end
+    end
+    
+    def load_translation
+      @admin_langs = []
+      Dir.glob(MICROENGINE_ROOT + '/lib/microengine/html/*.yaml') do |file|
+        @admin_langs.push File.basename(file, '.yaml')
+      end
+      
+      if @admin_langs.include? @lang
+        lang = @lang
+      else
+        lang = @admin.dispatcher.language(@http, @admin_langs)
+      end
+      
+      @translation = YAML::load_file MICROENGINE_ROOT + "/lib/microengine/html/#{lang}.yaml"
+    end
+    
+    # Display admin HTML in page layout
+    def display(view)
+      header = "<title>#{@translation[view]['title']}</title>"
+      rhtml = IO.read MICROENGINE_ROOT + "/lib/microengine/html/#{view}.rhtml"
+      body = ERB.new(rhtml).result(binding)
+      
+      if 'editor' == view
+        langs = @layout_langs
+      elsif 'error' == view
+        langs = []
+      else
+        langs = @admin.cache.langs[@path]
+      end
+      
+      @http << @admin.assambler.assamble(@path, @layout, @lang, header, body, langs)
+    end
+    
+  end
+end

data/lib/microengine/assambler.rb

@@ -0,0 +1,192 @@
+=begin
+Create XHTML pages from  layouts and content.
+Copyright (C) 2008 Andrey "A.I." Sitnik <andrey@sitnik.ru>
+
+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 3 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 General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+=end
+
+require 'erb'
+require 'yaml'
+require 'fileutils'
+
+module Microengine
+  # Create XHTML pages from layouts and content
+  class Assambler
+    
+    attr_writer :config
+    attr_writer :logger
+    
+    # Create XHTML pages from layouts and content
+    def refresh
+      @layouts = {}
+      
+      begin
+        if not File.directory? MICROENGINE_ROOT + '/cache/'
+          FileUtils.mkdir MICROENGINE_ROOT + '/cache/'
+        end
+        FileUtils.rm_r Dir.glob(MICROENGINE_ROOT + '/cache/*')
+      rescue
+        raise "Can't delete and create /cache/ dir. Ensure that it is chmod 0666."
+      end
+      
+      cache_dir '/'
+    end
+    
+    # Cache content for some lang in path
+    def cache_file(path, lang, langs)
+      file_path = MICROENGINE_ROOT + '/content' + path
+      
+      begin
+        layout =  IO.read(file_path + 'layout').strip
+      rescue
+        raise "Can't read layout file in /content#{path}. Please ensure that #{path}layout exists and is chmod 644"
+      end
+      begin
+        header = IO.read(file_path + lang + '.header')
+      rescue
+        raise "Can't read #{lang}.header file in /content#{path}. Please ensure that #{path}#{lang}.header exists and is chmod 644"
+      end
+      begin
+        body = IO.read(file_path + lang + '.body')
+      rescue
+        raise "Can't read #{lang}.body file in /content#{path}. Please ensure that #{path}#{lang}.body exists and is chmod 644"
+      end
+      
+      begin
+        content = assamble path, layout, lang, header, body, langs
+      rescue Exception => e
+        raise "Error in /content#{path}: " + e.message
+      end
+      
+      begin
+        io = File.new(MICROENGINE_ROOT + "/cache#{path}content.#{lang}.html", 'w')
+        io.write content
+        io.close
+      rescue
+        raise "Can't write to /cache#{path}content.#{lang}.html . Ensure that /cache/ dir and all files inside is chmod 0666."
+      end
+    end
+    
+    # Create XHTML page by layout and content
+    def assamble(path, layout_name, lang, header, body, langs)
+      layout = get_layout layout_name
+      if layout[lang].nil?
+        raise "There isn't translation in '#{lang}' for #{layout_name}"
+      end
+      translation = layout[lang]
+      languages = languages_html langs, lang, layout
+      layout[:layout].result(binding)
+    end
+    
+    private
+    
+    # Create languages list HTML
+    def languages_html(langs, selected, translations)
+      html = '<ul id="languages">'
+      langs.sort.each do |lang|
+        if lang == selected
+          html += '<li><span class="selected">' + translations[lang]['language']['title'] + '</span></li>';
+        else
+          html += '<li><a href="?lang=' + lang + '">' + translations[lang]['language']['title'] + '</a></li>'
+        end
+      end
+      html += '</ul>'
+    end
+    
+    # Cache directory and it's subdirectory of content
+    def cache_dir(dir)
+      path = MICROENGINE_ROOT + '/content' + dir
+      cache = MICROENGINE_ROOT + '/cache' + dir
+      if not File.directory? cache
+        begin
+          Dir.mkdir cache
+        rescue
+          raise "Can't create dir #{cache} . Please ensure that cache dir  is chmod 0777."
+        end
+      end
+      
+      langs = []
+      Dir.foreach path do |entry|
+        if '.' == entry[0..0]
+          next
+        elsif File.directory? path + entry + '/'
+          begin
+            cache_dir dir + entry + '/'
+          rescue
+            @logger.error e.message
+          end
+        elsif '.body' == entry[-5..-1]
+          langs.push entry[0..entry.index('.')-1].downcase
+        end
+      end
+      
+      langs.each do |lang|
+        begin
+          cache_file dir, lang, langs
+        rescue Exception => e
+          @logger.error e.message
+        end
+      end
+    end
+    
+    # Get hash with layouts XML object
+    def get_layout(name)
+      if @layouts[name].nil?
+        @layouts[name] = load_layout name
+      end
+      return @layouts[name]
+    end
+    
+    # Load layout from XML file and create translated versions
+    def load_layout(name)
+      # Check name and layout
+      name = name.sub(/(^|\/)\.\.?/, '')
+      dir = MICROENGINE_ROOT + '/layouts/' + name + '/';
+      if not File.directory?(dir) or not File.exists? dir + 'layout.rhtml'
+        raise "Can't find layout #{name} ."
+      end
+      
+      # Load layout
+      layout = {
+        :layout => ERB::new(IO.read(dir + 'layout.rhtml'))
+      }
+      
+      # Load translation
+      Dir.glob(dir + '**.yaml') do |file|
+        lang = File.basename file, '.yaml'
+        if 'layout' == lang
+          next
+        end
+        layout[lang] = load_translation(file)
+      end
+      layout
+    end
+    
+    # Load translation
+    def load_translation(file)
+      translation = YAML::load_file(file)
+      lang = File.basename(file, '.yaml')
+      
+      # Restore require fields if necessary
+      if translation['language'].nil? or translation['language']['title'].nil?
+        translation['language'] = {'code' => lang, 'title' => lang}
+      else
+        if lang != translation['language']['code']
+          translation['language']['code'] = lang
+        end
+      end
+      translation
+    end
+  end
+end

data/lib/microengine/dispatcher.rb

@@ -0,0 +1,125 @@
+=begin
+FastCGI dispatcher to return XHTML pages by HTTP request.
+Copyright (C) 2008 Andrey "A.I." Sitnik <andrey@sitnik.ru>
+
+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 3 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 General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+=end
+
+require 'fcgi'
+require 'admin'
+require 'http'
+
+module Microengine
+  # Use FastCGI to return XHTML by HTTP request
+  class Dispatcher
+    
+    attr_writer :config
+    attr_writer :logger
+    attr_writer :spiders
+    attr_writer :cache
+    attr_writer :admin
+    
+    # Start FastCGI
+    def run
+      FCGI.each do |request|
+        http = HTTP.new(request)
+        
+        if @admin.dispatch(http)
+          request.finish
+          next
+        else
+          langs = @cache.langs[http.url]
+          if langs.nil?
+            not_found http
+            request.finish
+            next
+          end
+          
+          if spider? http.agent
+            # Search engine spiders (another i18n logic)
+            if http.get['lang'].nil?
+              if langs.include? http.get['lang']
+                http << @cache.get(http.url, http.get['lang'])
+                request.finish
+                next
+              end
+            end
+            http.redirect http.url + '?lang=' + language(http, langs)
+          else
+            # Human visitor
+            if http.get['lang']
+              http.set_cookie 'lang', http.get['lang'], 30
+              if not langs.include? http.get['lang']
+                http.redirect http.url
+                request.finish
+                next
+              end
+            end
+            http << @cache.get(http.url, language(http, langs))
+          end
+          request.finish
+        end
+      end
+    end
+    
+    # Forward to 404 error
+    def not_found(http)
+      http.status = '404 Not Found'
+      http << @cache.get('/404/', language(http, @cache.langs['/404/']))
+      http.finish
+    end
+    
+    # Select best language for user
+    def language(http, available)
+      # Language selected manually
+      if not http.get['lang'].nil?
+        if available.include? http.get['lang']
+          return http.get['lang']
+        end
+      elsif http.cookie['lang']
+        if available.include? http.cookie['lang']
+          return http.cookie['lang']
+        end
+      end
+      
+      # Select user language
+      http.langs.each do |lang|
+        lang.downcase!
+        if available.include? lang
+          return lang
+        end
+      end
+      
+      # Select any language
+      if available.include? @config['default_language']
+        @config['default_language']
+      else
+        available.first
+      end
+    end
+    
+    private
+    
+    # Check HTTP_USER_AGENT value for search engine spiders
+    def spider?(agent)
+      @spiders.each do |spider|
+        if agent.include? spider
+          return true
+        end
+      end
+      false
+    end
+    
+  end
+end