sisu 7.0.0

data/lib/sisu/cgi_sqlite.rb

@@ -0,0 +1,244 @@
+# encoding: utf-8
+=begin
+
+* Name: SiSU
+
+** Description: documents, structuring, processing, publishing, search
+*** generates naive cgi search form for search of sisu database (sqlite)
+
+** Author: Ralph Amissah
+  <ralph@amissah.com>
+  <ralph.amissah@gmail.com>
+
+** Copyright: (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
+  2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015 Ralph Amissah,
+  All Rights Reserved.
+
+** License: GPL 3 or later:
+
+  SiSU, a framework for document structuring, publishing and search
+
+  Copyright (C) Ralph Amissah
+
+  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/>.
+
+  If you have Internet connection, the latest version of the GPL should be
+  available at these locations:
+  <http://www.fsf.org/licensing/licenses/gpl.html>
+  <http://www.gnu.org/licenses/gpl.html>
+
+  <http://www.sisudoc.org/sisu/en/manifest/gpl.fsf.html>
+
+** SiSU uses:
+  * Standard SiSU markup syntax,
+  * Standard SiSU meta-markup syntax, and the
+  * Standard SiSU object citation numbering and system
+
+** Hompages:
+  <http://www.jus.uio.no/sisu>
+  <http://www.sisudoc.org>
+
+** Git
+  <http://git.sisudoc.org/gitweb/?p=code/sisu.git;a=summary>
+  <http://git.sisudoc.org/gitweb/?p=code/sisu.git;a=blob;f=lib/sisu/cgi_sql_sqlite.rb;hb=HEAD>
+
+=end
+module  SiSU_CGI_SQLite                                 #% database building documents
+  require_relative 'se'                                 # se.rb
+  require_relative 'cgi_sql_common'                     # cgi_sql_common.rb
+    include SiSU_CGI_SQL
+  class SearchSQLite < CGI_Common
+    def initialize(opt,webserv)
+      @opt,@webserv=opt,webserv
+      @cX=SiSU_Screen::Ansi.new(opt.act[:color_state][:set]).cX
+      @env=SiSU_Env::InfoEnv.new('',opt)
+      @image_src="#{@env.url.webserv_cgi(opt)}/_sisu/image_sys"
+      @name_of={}
+      @name_of[:output_dir_structure]=if opt.dir_structure_by.to_s =~/(?:language|filetype|filename)/
+        opt.dir_structure_by.to_s
+      else 'language'
+      end
+      @name_of[:lingual]=if opt.lingual.to_s =~/(?:mono|multi)/
+        opt.lingual.to_s
+      else 'multi'
+      end
+      @name_of[:host_url_cgi]=%q{http://#{ENV['HTTP_HOST']}#{ENV['PATH_INFO']}}
+      @name_of[:host_url_docs]=%q{http://#{ENV['HTTP_HOST']}}
+      @name_of[:cgi_script]=%q{#{ENV['SCRIPT_NAME']}}
+      @image_src=%q{http://#{ENV['HTTP_HOST']}/_sisu/image_sys}
+      @common=SiSU_CGI_SQL::CGI_Common.new(@webserv,opt,@image_src,@env)
+      @cgi_file_name=@env.url.cgi_sample_search_form_name(opt)
+      @name_of_sqlite_db_file='sisu_sqlite.db'
+    end
+    def sqlite
+      serve=[]
+      Dir.foreach(@env.path.webserv) do |x|
+        if x !~/^\./ \
+        and FileTest.directory?("#{@env.path.webserv}/#{x}")
+          if FileTest.file?("#{@env.path.webserv}/#{x}/#{@name_of_sqlite_db_file}")
+            serve << x unless x =~/^_\S+/
+          end
+        end
+      end
+      serve=serve.sort
+      f1,f2,f3='','',''
+      serve.each do |x|
+        f1 << %{              <option value="#{Db[:name_prefix]}#{x}">#{x}</option>\n}
+      end
+      f2 <<  %{          selected_db=case cgi['db']\n}
+      serve.each do |x|
+        f2 << %{           when /#{Db[:name_prefix]}#{x}/ then '<option value="#{Db[:name_prefix]}#{x}">#{x}</option>'\n}
+      end
+      f2 << "          end\n"
+      f3 << %{          db_name='#{@name_of_sqlite_db_file}'\n}
+      f3 << %{          db_sqlite=case cgi['db']\n}
+      serve.each do |x|
+        f3 << %{          when /#{Db[:name_prefix]}#{x}/ then "#{@env.path.webserv}/#{x}/\#{db_name}"\n}
+      end
+      f3 << %{           else  "#{@env.path.webserv}/#{serve[0]}/\#{db_name}"\n          end\n}
+      if FileTest.writable?('.')
+        output=File.open(@cgi_file_name,'w')
+        output << header0 << header1 << header_desc << header2 << f1 << buttons1 << buttons2 << search_request << search_statement << search_statement_common << search_query1 << @common.pages << search_query2 << @common.tail << @common.main1 << f2 << f3 << dbi_connect << @common.main2 << @common.dir_structure << @common.main3
+        puts <<-WOK
+            generated sample search form: #{@cX.green}#{@cgi_file_name}#{@cX.off}
+            default database name:     #{@cX.green}#{Db[:name_prefix]}#{@env.path.base_markup_dir_stub}#{@cX.off} (#{@env.path.base_markup_dir_stub})
+            cgi & db host on:          #{@cX.blue}#{@env.url.webserv_base_cgi(@opt)}#{@cX.off}
+              to modify use:           #{@cX.brown}sisu --db-sqlite --webserv-search='#{@env.url.webserv_base_cgi(@opt)}'#{@cX.off}
+            sisu output on:            #{@cX.blue}#{@env.url.webserv_files_from_db(@opt)}#{@cX.off}
+              to modify use:           #{@cX.brown}sisu --db-sqlite --webserv-output='#{@env.url.webserv_files_from_db(@opt)}'#{@cX.off}
+            cgi search form link name: #{@cX.green}#{@env.url.cgi_sample_search_form_name(@opt)}#{@cX.off}
+              to modify use:           #{@cX.brown}sisu --db-sqlite --cgi-search-form-name='#{@env.url.cgi_sample_search_form_name(@opt)}'#{@cX.off}
+            #{@cX.fuchsia}(settings priority: command line; sisurc.yml; else defaults)#{@cX.off}
+
+            #{@cX.fuchsia}NOTE it is first necessary to create the database and tables and populate it#{@cX.off}
+
+            sisu --sqlite --dropall                          # removes existing postgresql db & tables
+            sisu --sqlite --createall -v                     # creates postgresql db & tables
+            sisu --sqlite --update -v *.sst  *.ssm           # populate the db
+            sisu --sample-search-form --sqlite               # creates the postgresql search form
+                                                             # this should be done after creating the db
+                                                             # to be searched
+            sisu --webrick &                                 # starts ruby webrick web server
+
+            # if necessary make the directory '/usr/lib/cgi-bin'
+            # here we copy the postgresql search form to cgi-bin
+            # (copy #{@cgi_file_name} to your cgi directory)
+            # set file permissions to 755
+        WOK
+        a=case @webserv
+        when /pwd/ then ''
+        else <<-WOK
+
+              sudo cp -vi #{Dir.pwd}/#{@cgi_file_name} /usr/lib/cgi-bin/.; \\
+              sudo chmod -v 755  /usr/lib/cgi-bin/#{@cgi_file_name}
+          WOK
+        end
+        b='(to create and populate sisu sqlite database see "man sisu" and in particular the -d flag)'
+        SiSU_Screen::Ansi.new(@opt.act[:color_state][:set],a,b).warn
+        a=<<-WOK
+
+              #{@env.webserv_base_cgi(@opt)}/cgi-bin/#{@cgi_file_name}
+
+        WOK
+        SiSU_Screen::Ansi.new(@opt.act[:color_state][:set],a).print_blue
+      else puts "failed in attempt to write #{@cgi_file_name} to present directory, is directory writable?"
+      end
+    end
+    def header0
+      <<-WOK_SQL
+#!/usr/bin/env ruby
+=begin
+#{about}
+ * Description: generates naive cgi search form for search of sisu database (sqlite)
+#{gpl}
+=end
+      begin
+        require 'cgi'
+        require 'fcgi'
+        require 'sqlite3'
+      rescue LoadError
+        puts 'cgi, fcgi or sqlite3 NOT FOUND (LoadError)'
+      end
+      @stub_default='sisu_sqlite'
+      @image_src="#{@image_src}"
+      @hosturl_cgi="#{@name_of[:host_url_cgi]}"
+      @hosturl_files="#{@name_of[:host_url_docs]}"
+      @output_dir_structure_by='#{@name_of[:output_dir_structure]}'
+      @lingual='#{@name_of[:lingual]}'
+      @db_name_prefix='#{Db[:name_prefix]}'
+      @base="#{@name_of[:host_url_cgi]}#{@name_of[:cgi_script]}"
+      WOK_SQL
+    end
+    def search_statement
+      <<-'WOK_SQL'
+      class DBI_SearchString
+        def initialize(l,t,q,cse=false)
+          @l,@t,@q=l,t,q
+        end
+        def string
+          search={ search: [], flag: false }
+          if @t =~/\S+/ or @q =~/\S+/
+            if @t =~/\S+/    then unescaped_search=CGI.unescape(@t)
+            elsif @q =~/\S+/ then unescaped_search=CGI.unescape(@q)
+            end
+            search_construct=[]
+            unescaped_search=unescaped_search.gsub(/\s*(AND|OR)\s*/,"%' \) \\1 #{@l} LIKE \( '%").
+              gsub(/(.+)/,"#{@l} LIKE \( '%\\1%' \)")
+            search_construct << unescaped_search
+            search_construct=search_construct.join(' ')
+            search[:search]                    << search_construct
+            search[:flag]=true
+            search
+          end
+          search
+        end
+      end
+      WOK_SQL
+    end
+    def search_query1
+      <<-'WOK_SQL'
+          @search_text=''
+          @search_text=search[:text].flatten.join(' AND ')
+          @search_text=@search_text.gsub(/(doc_objects\.clean\s+LIKE\s+\(\s*'%[^']+%'\s*\)\s+(?:(?:AND|OR)\s+doc_objects\.clean\s+LIKE\s+\(\s*'%[^']+%'\s*\))+)/,'(\1)')
+        end
+      WOK_SQL
+    end
+    def search_query2
+      <<-'WOK_SQL'
+        def sql_select_body
+          limit ||=@@limit
+          offset ||=@@offset
+          @sql_statement[:body]=%{SELECT metadata_and_text.title, metadata_and_text.creator_author, metadata_and_text.src_filename, metadata_and_text.language_document_char, metadata_and_text.notes_suffix, doc_objects.body, doc_objects.seg, doc_objects.ocn, metadata_and_text.tid FROM doc_objects, metadata_and_text WHERE #{@search_text} AND doc_objects.metadata_tid = metadata_and_text.tid ORDER BY metadata_and_text.language_document_char, metadata_and_text.title, metadata_and_text.src_filename, doc_objects.ocn}
+          @sql_statement[:range]=%{LIMIT #{limit} OFFSET #{offset} ;}
+          select=@sql_statement[:body] + ' ' + @sql_statement[:range]
+          select
+        end
+        def sql_select_body_format
+          %{<font color="#666666" size="2">#{sql_select_body}</font>}
+        end
+        def contents
+          @conn.execute(sql_select_body)
+        end
+      end
+      WOK_SQL
+    end
+    def dbi_connect
+      <<-'WOK_SQL'
+          @conn=SQLite3::Database.new(db_sqlite)
+          @conn.results_as_hash=true
+      WOK_SQL
+    end
+  end
+end
+__END__

data/lib/sisu/conf.rb

@@ -0,0 +1,287 @@
+# encoding: utf-8
+=begin
+
+* Name: SiSU
+
+** Description: documents, structuring, processing, publishing, search
+*** configuration
+
+** Author: Ralph Amissah
+  <ralph@amissah.com>
+  <ralph.amissah@gmail.com>
+
+** Copyright: (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
+  2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015 Ralph Amissah,
+  All Rights Reserved.
+
+** License: GPL 3 or later:
+
+  SiSU, a framework for document structuring, publishing and search
+
+  Copyright (C) Ralph Amissah
+
+  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/>.
+
+  If you have Internet connection, the latest version of the GPL should be
+  available at these locations:
+  <http://www.fsf.org/licensing/licenses/gpl.html>
+  <http://www.gnu.org/licenses/gpl.html>
+
+  <http://www.sisudoc.org/sisu/en/manifest/gpl.fsf.html>
+
+** SiSU uses:
+  * Standard SiSU markup syntax,
+  * Standard SiSU meta-markup syntax, and the
+  * Standard SiSU object citation numbering and system
+
+** Hompages:
+  <http://www.jus.uio.no/sisu>
+  <http://www.sisudoc.org>
+
+** Git
+  <http://git.sisudoc.org/gitweb/?p=code/sisu.git;a=summary>
+  <http://git.sisudoc.org/gitweb/?p=code/sisu.git;a=blob;f=lib/sisu/conf.rb;hb=HEAD>
+
+=end
+module SiSU_Initialize
+  require_relative 'se'                                 # se.rb
+    include SiSU_Env
+    include SiSU_Screen
+  require_relative 'relaxng'                            # relaxng.rb
+    include SiSU_Relaxng
+  require_relative 'css'                                # css.rb
+    include SiSU_Style
+  class Source
+    def initialize(opt)
+      @opt=opt
+    end
+    def read
+      ConfigSite.new(@opt).make_homepage
+      ConfigSite.new(@opt).css
+      ConfigSite.new(@opt).dtd
+      ConfigSite.new(@opt).cp_local_images
+      ConfigSite.new(@opt).cp_external_images
+      ConfigSite.new(@opt).cp_webserver_images
+    end
+  end
+  class ConfigSite #config files such as css are not updated if they already exist unless forced using the --init=site modifier
+    require_relative 'se'                               # se.rb
+    def initialize(opt)
+      @opt=opt
+      @env=SiSU_Env::InfoEnv.new(@opt.fns)
+      @suffix={
+        rnc: 'rnc',
+        rng: 'rng',
+        xsd: 'xsd',
+      }
+      @path={
+        xml: @env.path.output + '/_sisu/xml',
+        xsd: @env.path.output + '/_sisu/xml/xsd',
+        rnc: @env.path.output + '/_sisu/xml/rnc',
+        rng: @env.path.output + '/_sisu/xml/rng',
+        style: @env.path.output + '/' + @env.path.style,
+      }
+      @pwd,@home=Dir.pwd,@env.path.home
+    end
+    def make_homepage
+      SiSU_Screen::Ansi.new(
+        @opt.act[:color_state][:set],
+        'invert',
+        'Make homepage',
+        ''
+      ).colorize unless @opt.act[:quiet][:set]==:on
+      SiSU_Env::CreateSite.new(@opt).homepage
+    end
+    def cp_local_images
+      SiSU_Screen::Ansi.new(
+        @opt.act[:color_state][:set],
+        'invert',
+        'Copy images',
+        ''
+      ).colorize unless @opt.act[:quiet][:set]==:on
+      SiSU_Env::CreateSite.new(@opt).cp_local_images
+      SiSU_Env::CreateSite.new(@opt).cp_webserver_images_local #this should not have been necessary
+      SiSU_Env::CreateSite.new(@opt).cp_base_images #base images (nav etc.) used by all html
+    end
+    def cp_external_images
+      SiSU_Screen::Ansi.new(
+        @opt.act[:color_state][:set],
+        'invert',
+        'Copy external images',
+        ''
+      ).colorize if @opt.act[:verbose_plus][:set]==:on
+      SiSU_Env::CreateSite.new(@opt).cp_external_images
+    end
+    def cp_webserver_images
+      SiSU_Screen::Ansi.new(
+        @opt.act[:color_state][:set],
+        'invert',
+        'Copy webserver/output file images',
+        ''
+      ).colorize unless @opt.act[:quiet][:set]==:on
+      SiSU_Env::CreateSite.new(@opt).cp_webserver_images
+    end
+    def css
+      SiSU_Screen::Ansi.new(
+        @opt.act[:color_state][:set],
+        'invert',
+        'Configuring CSSs',
+        ''
+      ).colorize unless @opt.act[:quiet][:set]==:on
+      SiSU_Env::CreateSite.new(@opt).cp_css
+    end
+    def dtd
+      SiSU_Screen::Ansi.new(
+        @opt.act[:color_state][:set],
+        'invert',
+        'Configuring DTDs',
+        ''
+      ).colorize unless @opt.act[:quiet][:set]==:on
+      @rxng=SiSU_Relaxng::RelaxNG.new
+      @path.each { |d| FileUtils::mkdir_p(d[1]) \
+      unless FileTest.directory?(d[1]) }
+      #ugly code, sort later
+      if @rxng.methods.join =~/[^_]dtd_sax\b/
+        if @rxng.dtd_sax.length > 200
+          dtd=File.new("#{@path[:style]}/#{@rxng.rng_name.output_sax}",'w')
+          dtd << @rxng.dtd_sax
+          dtd.close
+        else trang_rnc_model_output_sax
+        end
+      else trang_rnc_model_output_sax
+      end
+      if @rxng.methods.join =~/[^_]dtd_dom\b/
+        if @rxng.dtd_dom.length > 200
+          dtd=File.new("#{@path[:style]}/#{@rxng.rng_name.output_dom}",'w')
+          dtd << @rxng.dtd_dom
+          dtd.close
+        else trang_rnc_model_output_dom
+        end
+      else trang_rnc_model_output_dom
+      end
+      if @rxng.methods.join =~/[^_]dtd_node\b/
+        if @rxng.dtd_node.length > 200
+          dtd=File.new("#{@path[:style]}/#{@rxng.rng_name.input_node}",'w')
+          dtd << @rxng.dtd_node
+          dtd.close
+        else trang_rnc_model_input_node
+        end
+      else trang_rnc_model_input_node
+      end
+      if @rxng.methods.join =~/[^_]dtd_xhtml\b/
+        if @rxng.dtd_xhtml.length > 200
+          dtd=File.new("#{@path[:style]}/#{@rxng.rng_name.output_xhtml}",'w')
+          dtd << @rxng.dtd_xhtml
+          dtd.close
+        else trang_rnc_model_output_xhtml
+        end
+      else trang_rnc_model_output_xhtml
+      end
+    end
+    def trang_rnc_model_output_sax
+      s=@suffix
+      rnc_src=@env.processing_path.ao + '/sax.' + s[:rnc]
+      rnc_file=@path[:rnc] + '/' + @rxng.rnc_name.output_sax
+      rng_file=@path[:rng] + '/' + @rxng.rng_name.output_sax
+      xsd_file=@path[:xsd] + '/' + @rxng.xsd_name.output_sax
+      rnc=File.new(rnc_src,'w')
+      rnc << @rxng.rnc_model_output_sax
+      rnc.close
+      #xsd
+      schema=SiSU_Env::SystemCall.new(rnc_src,xsd_file)
+      schema.relaxng(@opt.selections.str)
+      #rng
+      schema=SiSU_Env::SystemCall.new(rnc_src,rng_file)
+      schema.relaxng(@opt.selections.str)
+      #rnc
+      if FileTest.file?(rnc_src)
+        FileUtils::cp(rnc_src,rnc_file)
+        FileUtils::chmod(0644,rnc_file)
+      else STDERR.puts %{\t*WARN* did not find rnc - "#{rnc_src}" [#{__FILE__}:#{__LINE__}]}
+      end
+    end
+    def trang_rnc_model_output_dom
+      s=@suffix
+      rnc_src=@env.processing_path.ao + '/dom.' + s[:rnc]
+      rnc_file=@path[:rnc] + '/' + @rxng.rnc_name.output_dom
+      rng_file=@path[:rng] + '/' + @rxng.rng_name.output_dom
+      xsd_file=@path[:xsd] + '/' + @rxng.xsd_name.output_dom
+      rnc=File.new(rnc_src,'w')
+      rnc << @rxng.rnc_model_output_dom
+      rnc.close
+      #xsd
+      schema=SiSU_Env::SystemCall.new(rnc_src,xsd_file)
+      schema.relaxng(@opt.selections.str)
+      #rng
+      schema=SiSU_Env::SystemCall.new(rnc_src,rng_file)
+      schema.relaxng(@opt.selections.str)
+      #rnc
+      if FileTest.file?(rnc_src)
+        FileUtils::cp(rnc_src,rnc_file)
+        FileUtils::chmod(0644,rnc_file)
+      else STDERR.puts %{\t*WARN* did not find rnc - "#{rnc_src}" [#{__FILE__}:#{__LINE__}]}
+      end
+    end
+    def trang_rnc_model_output_xhtml
+      s=@suffix
+      rnc_src=@env.processing_path.ao + '/xhtml.' + s[:rnc]
+      rnc_file=@path[:rnc] + '/' + @rxng.rnc_name.output_xhtml
+      rng_file=@path[:rng] + '/' + @rxng.rng_name.output_xhtml
+      xsd_file=@path[:xsd] + '/' + @rxng.xsd_name.output_xhtml
+      rnc=File.new(rnc_src,'w')
+      rnc << @rxng.rnc_model_output_xhtml
+      rnc.close
+      #xsd
+      schema=SiSU_Env::SystemCall.new(rnc_src,xsd_file)
+      schema.relaxng(@opt.selections.str)
+      #rng
+      schema=SiSU_Env::SystemCall.new(rnc_src,rng_file)
+      schema.relaxng(@opt.selections.str)
+      #rnc
+      if FileTest.file?(rnc_src)
+        FileUtils::cp(rnc_src,rnc_file)
+        FileUtils::chmod(0644,rnc_file)
+      else STDERR.puts %{\t*WARN* did not find rnc - "#{rnc_src}" [#{__FILE__}:#{__LINE__}]}
+      end
+    end
+    def trang_rnc_model_input_sax
+      rnc_file=@env.processing_path.ao + '/sax.rnc'
+      dtd_file=@path[:xsd] + '/' + @rxng.rng_name.input_sax
+      rnc=File.new(rnc_file,'w')
+      rnc << @rxng.rnc_model_output_sax
+      rnc.close
+      schema=SiSU_Env::SystemCall.new(rnc_file,dtd_file)
+      schema.relaxng(@opt.selections.str)
+    end
+    def trang_rnc_model_input_dom
+      rnc_file=@env.processing_path.ao + '/dom.rnc'
+      dtd_file=@path[:xsd] + '/' + @rxng.rng_name.input_dom
+      rnc=File.new(rnc_file,'w')
+      rnc << @rxng.rnc_model_output_dom
+      rnc.close
+      schema=SiSU_Env::SystemCall.new(rnc_file,dtd_file)
+      schema.relaxng(@opt.selections.str)
+    end
+    def trang_rnc_model_input_node
+      rnc_file=@env.processing_path.ao + '/node.rnc'
+      dtd_file=@path[:xsd] + '/' + @rxng.rng_name.input_node
+      rnc=File.new(rnc_file,'w')
+      rnc << @rxng.rnc_model_input_node
+      rnc.close
+      schema=SiSU_Env::SystemCall.new(rnc_file,dtd_file)
+      schema.relaxng(@opt.selections.str)
+    end
+  end
+end
+__END__