microengine 0.0.1

data/lib/microengine/file_cache.rb

@@ -0,0 +1,62 @@
+=begin
+Load cached pages directly from files.
+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
+  # Load cached pages directly from files. MemoryCache is more faster.
+  class FileCache
+    # Available languages
+    attr_reader :langs
+    
+    # Refresh cache
+    def refresh
+      @langs = {}
+      cache '/'
+    end
+    
+    # Return XHTML page content
+    def get(path, lang)
+      lang.sub!(/[^[:alpha:]_-]/, '')
+      IO.read MICROENGINE_ROOT + '/cache/' + path + 'content.' + lang + '.html'
+    end
+    
+    protected
+    
+    # Load to memory neccasary resourses
+    def cache(dir)
+      langs = []
+      path = MICROENGINE_ROOT + '/cache/' + dir
+      Dir.foreach path do |entry|
+        if '.' == entry[0..0]
+          next
+        elsif File.directory? path + entry + '/'
+          cache dir + entry + '/'
+        elsif 'content.' == entry[0..7] and '.html' == entry[-5..-1]
+          langs.push entry[8..-6]
+        end
+      end
+      if not langs.empty?
+        cache_content dir, langs
+      end
+    end
+    
+    # Cache directory languages
+    def cache_content(dir, langs)
+      @langs[dir] = langs
+    end
+  end
+end

data/lib/microengine/html/deleter.rhtml

@@ -0,0 +1,11 @@
+<form id="admin-deleter" method="post" action="/admin/do/delete<%= @path %>">
+    <input type="hidden" name="lang" value="<%= @lang %>" />
+    <div>
+        <% if @show_password %>
+        <%= @translation['password'] %>:
+        <input type="password" name="password" />
+        <% end %>
+        <input type="submit" value="<%= @translation['deleter']['delete'] %>" />
+    </div>
+</form>
+<%= @body %>

data/lib/microengine/html/editor.rhtml

@@ -0,0 +1,34 @@
+<form id="admin-editor" method="post" action="/admin/do/save<%= @path %>">
+    <input type="hidden" name="lang" value="<%= @lang %>" />
+    <div>
+        <%= @translation['editor']['layout'] %>:
+        <select name="layout">
+        <% @layouts.each do |layout| %>
+            <% if @layout == layout %>
+            <option selected="selected"><%= layout %></option>
+            <% elsif @untranslated_layouts.include? layout %>
+            <option disabled="disabled">
+                <%= layout %>
+                (<%= @translation['editor']['untranslated'].sub('%langs', @untranslated_layouts[layout].join(', ')) %>)
+            </option>
+            <% else %>
+            <option><%= layout %></option>
+            <% end %>
+        <% end %>
+        </select>
+    </div>
+    <div>
+        <%= @translation['editor']['header'] %>:
+        <textarea name="header" rows="3" style="width: 100%;"><%= @header %></textarea>
+    </div>
+    <div>
+        <textarea name="body" rows="40" style="width: 100%"><%= @body %></textarea>
+    </div>
+    <div style="margin-top: 5px;">
+        <% if @show_password %>
+        <%= @translation['password'] %>:
+        <input type="password" name="password" />
+        <% end %>
+        <input type="submit" value="<%= @translation['editor']['save'] %>" />
+    </div>
+</form>

data/lib/microengine/html/en.yaml

@@ -0,0 +1,33 @@
+# English global translation
+
+password: Password
+
+error:
+  title: Error
+  untranslated_layout: Layout %layout isn't translated to %lang.
+  no_lang: Variable 'lang' with page language wasn't sended.
+  no_body: Variable 'body' with page content wasn't sended.
+  no_header: Variable 'header' with page header wasn't sended.
+  admin_subdir: You can't edit /admin/ subdirs.
+  cant_write: Microengine can't change files. Ensure, that all files in /content/ is chmod 0666.
+  delete_system: This is system page and you can't deleted it.
+  cant_cache: Cache wasn't refreshed. See system log for details.
+
+editor:
+  title: Edit
+  header: Header
+  layout: Layout
+  untranslated: Untranslated on %langs
+  save: Save
+
+untranslater:
+  title: Delete translation
+  delete: Delete translation
+
+deleter:
+  title: Delete page
+  delete: Delete page and all it's translations
+
+refresher:
+  title: Refresh cache
+  refresh: Refresh page cache

data/lib/microengine/html/error.rhtml

@@ -0,0 +1,6 @@
+<h1><%= @translation['error']['title'] %></h1>
+<% if 'untranslated_layout' == @code %>
+<p><%= @translation['error'][@code].sub('%layout', @layout).sub('%lang', @old_lang) %></p>
+<% else %>
+<p><%= @translation['error'][@code] %></p>
+<% end %>

data/lib/microengine/html/refresher.rhtml

@@ -0,0 +1,7 @@
+<form id="admin-refresher" method="post" action="/admin/do/refresh/">
+    <% if @show_password %>
+    <%= @translation['password'] %>:
+    <input type="password" name="password" />
+    <% end %>
+    <input type="submit" value="<%= @translation['refresher']['refresh'] %>" />
+</form>

data/lib/microengine/html/ru.yaml

@@ -0,0 +1,33 @@
+# Russian global translation
+
+password: Пароль
+
+error:
+  title: Ошибка
+  untranslated_layout: Шаблон %layout не переведён на %lang.
+  no_lang: Не передана переменная lang с языком страницы.
+  no_body: Не передана переменная body с содержимым страницы.
+  no_header: Не передана переменная header с заголовком страницы.
+  admin_subdir: Вы не можете изменять подкаталоги /admin/ .
+  cant_write: Microengine не может изменить файл. Убедитесь, что все файлы в /content/ имеют права доступа 0666.
+  delete_system: Это системная страница и вы не можете её удалить.
+  cant_cache: Кеш не был обновлён. Смотрите детали в системном журнале. 
+
+editor:
+  title: Правка
+  header: Заголовок
+  layout: Шаблон
+  untranslated: Непереведён на %langs
+  save: Сохранить
+
+untranslater:
+  title: Удаление перевода
+  delete: Удалить перевод
+
+deleter:
+  title: Удаление страницы
+  delete: Удалить страницу и все её переводы
+
+refresher:
+  title: Обновление кеша
+  refresh: Обновить кеш

data/lib/microengine/html/untranslater.rhtml

@@ -0,0 +1,11 @@
+<form id="admin-untranslater" method="post" action="/admin/do/untranslate<%= @path %>">
+    <input type="hidden" name="lang" value="<%= @lang %>" />
+    <div>
+        <% if @show_password %>
+        <%= @translation['password'] %>:
+        <input type="password" name="password" />
+        <% end %>
+        <input type="submit" value="<%= @translation['untranslater']['delete'] %>" />
+    </div>
+</form>
+<%= @body %>

data/lib/microengine/http.rb

@@ -0,0 +1,213 @@
+=begin
+API to easy work with HTTP.
+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 'cgi'
+
+module Microengine
+  # Basic operation with HTTP request
+  class HTTP
+    attr_reader :env
+    attr_reader :url
+    attr_reader :post
+    attr_reader :langs
+    attr_reader :agent
+    attr_reader :ip
+    attr_reader :cookie
+    attr_reader :get
+    attr_accessor :status
+    attr_accessor :content
+    
+    def initialize(request)
+        @out = request.out
+        @env = request.env
+        @agent = request.env['HTTP_USER_AGENT']
+        @ip = request.env['REMOTE_ADDR']
+        @langs = format_langs request.env['HTTP_ACCEPT_LANGUAGE']
+        @url = normalize_url format_url(request.env['REQUEST_URI'])
+        @get = format_get request.env['QUERY_STRING']
+        @cookie = format_cookie request.env['HTTP_COOKIE']
+        @headers = []
+        @status = '200 OK'
+        @content = 'text/html'
+        @request = request
+    end
+    
+    def post
+      if @post.nil?
+        @post = format_post @request.in
+      end
+      @post
+    end
+    
+    # Is URL start with string
+    def url_start?(string)
+      @url[0...string.length] == string
+    end
+    
+    # Is HTTP headers already sended to user
+    def header_sended?
+      @header_sended
+    end
+    
+    # Send content to user
+    def << (content)
+      if not header_sended?
+        send_headers
+      end
+      @out.print content
+    end
+    
+    # Redirect to another URL
+    def redirect(url)
+      @status = '301 Moved Permanently'
+      if '/' == url[0]
+        url = 'http://' + @env['HTTP_HOST'] + url
+      end
+      header 'Location', url
+      send_headers
+      finish
+    end
+    
+    # Set header
+    def header(name, value)
+      if header_sended?
+        Initializer.logger.warning 'Header already sended'
+      end
+      @headers << [name, value]
+    end
+    
+    # Set cookie
+    def set_cookie(name, value, days=nil)
+      cookie = name + '=' + value + '; path=/'
+      if not days.nil?
+        time = Time.now + (days * 86400)
+        cookie += '; expires=' + time.gmtime.strftime('%a %d-%b-%Y %H:%M:S %Z')
+      end
+      header 'Set-Cookie', cookie
+      @cookie[name] = value
+    end
+    
+    # Finish HTTP request
+    def finish
+      @request.finish
+    end
+    
+    private
+    
+    # Format accept languages from string to array
+    def format_langs(langs)
+      if langs.nil? or '' == langs
+        return []
+      end
+      langs = langs.split(',')
+      langs.map! do |lang|
+        index = lang.index(';')
+        if not index.nil?
+          lang[0...index]
+        else
+          lang
+        end
+      end
+    end
+
+    # Format GET variables in URI as array
+    def format_get(query)
+      if query.empty?
+        return {}
+      end
+      
+      vars = {}
+      query = query.split('&').each do |var|
+        var = var.split('=')
+        if 2 == var.length
+          vars[var[0]] = var[1]
+        else
+          vars[var[0]] = true
+        end
+      end
+      vars
+    end
+
+    # Remove GET variables from URI
+    def format_url(url)
+      index = url.index('?')
+      if index.nil?
+        url
+      else
+        url[0...index]
+      end
+    end
+
+    # Format cookies as array
+    def format_cookie(string)
+      if string.nil? or string.empty?
+        return {}
+      end
+      
+      cookies = {}
+      string = string.split(';')
+      string.each do |item|
+        index = item.index('=')
+        cookies[item[0...index].strip] = item[index+1..-1].strip
+      end
+      cookies
+    end
+    
+    # Format POST variables
+    def format_post(input)
+      if 'application/x-www-form-urlencoded' != @env['CONTENT_TYPE']
+        return {}
+      end
+      
+      post = input.read
+      if post.nil?
+        return {}
+      end
+      
+      vars = {}
+      post.split('&').each do |var|
+        var = var.split '='
+        if var[1].nil?
+          var[1] = ''
+        end
+        vars[var[0]] = CGI.unescape(var[1].nil? ? '' : var[1])
+      end
+      
+      vars
+    end
+
+    # Send HTTP headers
+    def send_headers
+      @headers.each do |header|
+        @out.print header.join(': ') + "\r\n"
+      end
+      @out.print "Content-type: #{@content}\r\n"
+      @out.print "Status: #{@status}\r\n"
+      @out.print "\r\n"
+      @header_sended = true
+    end
+    
+    # Security check and normalizing URL
+    def normalize_url(url)
+      if '/' != url[-1..-1]
+        url += '/'
+      end
+      url.sub(/\/\.?\.\//, '/')
+    end
+  end
+end

data/lib/microengine/initializer.rb

@@ -0,0 +1,93 @@
+=begin
+Initialize system constants, load modules and start Microengine.
+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 'logger'
+require 'yaml'
+require 'dispatcher'
+require 'assambler'
+require 'file_cache'
+require 'memory_cache'
+
+module Microengine
+  # Load configs, create pages cache if necessary
+  class Initializer
+    
+    # Initialize microengine
+    def initialize
+      logger = Logger.new(STDERR)
+      logger.level = Logger::WARN
+      config = load_config
+      
+      admin = Admin.new
+      dispatcher = Dispatcher.new
+      assambler = Assambler.new
+      if 'memory' == config['cache']
+        cache = MemoryCache.new
+      elsif 'file' == config['cache']
+        cache = FileCache.new
+      else
+        logger.warn "Unknown value '#{config['cache']}' for 'cache' in config/settings.yaml . Will be used file cache."
+        cache = MemoryCache.new
+      end
+      
+      [admin, dispatcher, assambler].each do |object|
+        object.logger = logger
+        object.config = config
+      end
+      [admin, dispatcher].each do |object|
+        object.cache = cache
+      end
+      admin.shadow = load_shadow
+      admin.dispatcher = dispatcher
+      admin.assambler = assambler
+      dispatcher.spiders = load_seach_spiders
+      dispatcher.admin = admin
+      
+      begin
+        assambler.refresh
+        cache.refresh
+      rescue Exception => e
+        logger.error "Cache was not created. " + e.message + "\n" + e.backtrace.join("\n")
+      end
+      dispatcher.run
+    rescue Exception => e
+      logger.error(e)
+    end
+    
+    # Load settings
+    def load_config
+      YAML::load_file(MICROENGINE_ROOT + '/config/settings.yaml')
+    rescue
+      raise "Can't open settings file. Please ensure that config/settings.yaml exists and can be read by engine."
+    end
+    
+    # Load admin password
+    def load_shadow
+      YAML::load_file(MICROENGINE_ROOT + '/config/shadow.yaml')
+    rescue
+      raise "Can't open shadow file. Please ensure that config/shadow.yaml exists and can be read by engine."
+    end
+    
+    # Load search spider list
+    def load_seach_spiders
+      IO.readlines(MICROENGINE_ROOT + '/config/search spiders')
+    rescue
+      raise "Can't open spiders file. Please ensure that '/config/search spiders' exists and can be read by engine."
+    end
+  end
+end