sisu 7.0.0

data/lib/sisu/sitemaps.rb

@@ -0,0 +1,224 @@
+# encoding: utf-8
+=begin
+
+* Name: SiSU
+
+** Description: documents, structuring, processing, publishing, search
+*** sitemap created from document parameters
+
+** 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/sitemaps.rb;hb=HEAD>
+
+=end
+module SiSU_Sitemaps
+  require_relative 'dp'                                 # dp.rb
+    include SiSU_Param
+  require_relative 'se'                                 # se.rb
+    include SiSU_Env
+  require_relative 'xml_shared'                         # xml_shared.rb
+    include SiSU_XML_Munge
+  class Source
+    def initialize(opt)
+      @opt=opt
+    end
+    def read
+      songsheet
+    end
+    def songsheet
+      begin
+        @sys=SiSU_Env::SystemCall.new
+        fn_set_lang=SiSU_Env::StandardiseLanguage.new(@opt.lng).language
+        @fn=SiSU_Env::EnvCall.new(@opt.fns).lang(fn_set_lang[:c])
+        if @opt.act[:sitemap][:set]==:on
+          @md=SiSU_Param::Parameters.new(@opt).get
+          @trans=SiSU_XML_Munge::Trans.new(@md) #check @md is required
+          @env=SiSU_Env::InfoEnv.new(@md.fns)
+#         @file=SiSU_Env::FileOp.new(@md)
+          @rdf=SiSU_XML_Tags::RDF.new(@md)
+          @fnb_utf8_xml=@md.fnb.dup
+          @trans.char_enc.utf8(@fnb_utf8_xml) \
+            if @sys.locale =~/utf-?8/i
+          output_map(sitemap)
+        elsif @opt.selections.str =~/--sitemaps/
+          @sitemap_idx_fn='sitemapindex.xml'
+          @env=SiSU_Env::InfoEnv.new
+          output_idx(sitemap_index)
+          SiSU_Screen::Ansi.new(
+            @opt.act[:color_state][:set],
+            'sitemap index:',
+            "#{@env.path.output}/#{@sitemap_idx_fn}"
+          ).result unless @opt.act[:quiet][:set]==:on
+        end
+      rescue
+        SiSU_Errors::Rescued.new($!,$@,@opt.cmd,@opt.fns).location do
+          __LINE__.to_s + ':' + __FILE__
+        end
+      ensure
+      end
+    end
+    def make_file(path,filename)
+      (File.writable?("#{path}/.")) \
+      ? (File.new("#{path}/#{filename}",'w+'))
+      : (SiSU_Screen::Ansi.new(
+           '',
+           "is the file or directory writable?, could not create #{filename}"
+         ).warn)
+    end
+    def output_map(sitemap)
+      path=@md.file.output_path.sitemaps.dir
+      filename=@fn[:sitemap]
+      touch_path=@md.file.output_path.sitemaps.dir
+      touch_filename=@fn[:sitemap_touch]
+      SiSU_Env::FileOp.new(@md).make_path(path)
+      file=SiSU_Env::FileOp.new(@md).make_file(path,filename)
+      file << sitemap
+      if FileTest.file?("#{touch_path}/#{touch_filename}")
+        FileUtils::rm("#{touch_path}/#{touch_filename}")
+      end
+    end
+    def output_idx(sitemap)
+      path=@env.path.output
+      filename=@sitemap_idx_fn
+      make_path(path)
+      file=make_file(path,filename)
+      file << sitemap
+    end
+    def sitemap_index
+      sitemap_files=Dir.glob("#{@env.path.sitemaps}/sitemap_*.xml")
+      sitemap_idx=[]
+      sitemap_idx << <<WOK
+<?xml version="1.0" encoding="UTF-8"?>
+<sitemapindex xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+   xsi:schemaLocation="http://www.sitemaps.org/schemas/sitemaps/0.9
+   http://www.sitemaps.org/schemas/sitemaps/sitemap.xsd"
+     xmlns="http://www.sitemaps.org/schemas/sitemapindex/0.9">
+WOK
+      sitemap_files.each do |s|
+        f=s.gsub(/.+?\/sitemap_([^\/]+?)\.xml$/,'\1')
+        @trans.char_enc.utf8(f) \
+          if @sys.locale =~/utf-?8/i
+sitemap_idx << <<WOK
+  <sitemap>
+    <loc>#{@env.path.url.remote}/#{f}/sitemap.xml</loc>
+  </sitemap>
+WOK
+      end
+      sitemap_idx << <<WOK
+</sitemapindex>
+WOK
+      sitemap_idx.join
+    end
+    def sitemap
+      if defined? @md.date.modified \
+      and @md.date.modified=~/\d{4}-\d{2}-\d{2}/
+        sitemap_date_modified
+      else sitemap_no_date
+      end
+    end
+    def sitemap_date_modified
+<<WOK
+<?xml version='1.0' encoding='UTF-8'?>
+<urlset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="http://www.sitemaps.org/schemas/sitemaps/0.9
+  http://www.sitemaps.org/schemas/sitemaps/sitemap.xsd"
+  xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+#{@rdf.comment_xml}
+  <url>
+    <loc>#{@env.path.url.remote}/#{@fnb_utf8_xml}/#{@fn[:toc]}</loc>
+    <lastmod>#{@md.date.modified}</lastmod>
+    <changefreq>monthly</changefreq>
+    <priority>0.7</priority>
+  </url>
+  <url>
+    <loc>#{@env.path.url.remote}/#{@fnb_utf8_xml}/#{@fn[:doc]}</loc>
+    <lastmod>#{@md.date.modified}</lastmod>
+    <priority>0.5</priority>
+  </url>
+  <url>
+    <loc>#{@env.path.url.remote}/#{@fnb_utf8_xml}/#{@fn[:manifest]}</loc>
+    <lastmod>#{@md.date.modified}</lastmod>
+    <priority>0.5</priority>
+  </url>
+</urlset>
+WOK
+    end
+    def sitemap_no_date
+<<WOK
+<?xml version="1.0" encoding="UTF-8"?>
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+#{@rdf.comment_xml}
+  <url>
+    <loc>#{@env.path.url.remote}/#{@fnb_utf8_xml}/#{@fn[:toc]}</loc>
+    <changefreq>monthly</changefreq>
+    <priority>0.7</priority>
+  </url>
+  <url>
+    <loc>#{@env.path.url.remote}/#{@fnb_utf8_xml}/#{@fn[:doc]}</loc>
+    <priority>0.5</priority>
+  </url>
+  <url>
+    <loc>#{@env.path.url.remote}/#{@fnb_utf8_xml}/#{@fn[:manifest]}</loc>
+    <priority>0.5</priority>
+  </url>
+</urlset>
+WOK
+    end
+  end
+end
+__END__
+* sanitize xml, pass through filter to ensure is valid - done but needs testing
+* remote placement of sitemaps --sitemaps -R (probably makes more sense than doing against -Y [filename/wildcard]) - done but needs testing
+* gzip sitemaps - not before testing / after testing
+* issue with master documnts, naming and mapping, check multilingual
+
+<!-- Document processing information:
+     * Generated by: SiSU 0.48.6 of 2006w45/6 (20061111)
+     * Ruby version: ruby 1.8.5 (2006-08-25) [i486-linux]
+     *
+     * Last Generated on: Sat Nov 18 15:28:08 +0000 2006
+     * SiSU http://www.jus.uio.no/sisu
+-->

data/lib/sisu/src_kdissert_share.rb

@@ -0,0 +1,102 @@
+# encoding: utf-8
+=begin
+
+* Name: SiSU
+
+** Description: documents, structuring, processing, publishing, search
+*** share sisu source markup file, copy it to output directory!
+
+** 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/src_share_kdissert.rb;hb=HEAD>
+
+=end
+module SiSU_KdiSource
+  require_relative 'se'                                 # se.rb
+    include SiSU_Env
+  class Source
+    begin
+      require 'fileutils'
+        include FileUtils
+    rescue LoadError
+      SiSU_Utils::CodeMarker.new(__LINE__,__FILE__,:fuchsia).
+        error('fileutils NOT FOUND (LoadError)')
+    end
+    def initialize(opt)
+      @opt=opt
+      @env=SiSU_Env::InfoEnv.new(@opt.fns)
+      @output_path="#{@env.path.output}/#{@opt.fnb}"
+    end
+    def read
+      SiSU_Screen::Ansi.new(
+        @opt.act[:color_state][:set],
+        'Share Kdissert Source Document!',
+        @opt.fnb
+      ).green_hi_blue unless @opt.act[:quiet][:set]==:on
+      SiSU_Screen::Ansi.new(
+        @opt.act[:color_state][:set],
+        "Copy kdissert file to output directory",
+        "#{@opt.fnb} -> #{@output_path}"
+      ).warn unless @opt.act[:quiet][:set]==:on
+      FileUtils::mkdir_p(@env.path.output) unless FileTest.directory?(@env.path.output)
+      FileUtils::mkdir_p(@output_path) unless FileTest.directory?(@output_path)
+      if FileTest.directory?(@output_path)
+        if @opt.fns =~/\.kdi\._sst$/ \
+        and FileTest.file?(@opt.fnb)
+          FileUtils::cp(@opt.fnb,@output_path)
+        end
+      else
+        SiSU_Screen::Ansi.new(
+          @opt.act[:color_state][:set],
+          "Output directory does not exist",
+          "#{@opt.fnb} -> #{@output_path}"
+        ).warn unless @opt.act[:quiet][:set]==:on
+        exit
+      end
+    end
+  end
+end
+__END__

data/lib/sisu/src_po4a_share.rb

@@ -0,0 +1,309 @@
+# encoding: utf-8
+=begin
+
+* Name: SiSU
+
+** Description: documents, structuring, processing, publishing, search
+*** pot file generation
+
+** 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/src_po4a_share.rb;hb=HEAD>
+
+=end
+#module SiSU_SStm_AO_SStm
+module SiSU_Languages_Selected
+  require_relative 'utils_response'                   # utils_response.rb
+  def language
+    def sisu_languages_available
+      Px[:lng_lst]
+    end
+    def source_language_selected_str
+      @opt.act[:po4a_lang][:src] \
+      ? @opt.act[:po4a_lang][:src]
+      : 'en'
+    end
+    def translation_languages_selected
+      @opt.act[:po4a_lang][:trn] \
+      ? @opt.act[:po4a_lang][:trn]
+      : []
+    end
+    def translation_languages_available
+      sisu_languages_available - [source_language_selected_str]
+    end
+    def translation_languages_selected_that_are_available
+      translation_languages_selected & sisu_languages_available
+    end
+    def translation_languages_selected_that_are_available_str
+      translation_languages_selected_that_are_available.join(' ')
+    end
+    def translation_languages_selected_str
+      @opt.act[:po4a_lang][:trn].join(' ')
+    end
+    self
+  end
+end
+module SiSU_Po4a_Project
+  class Po4aCfg
+    include SiSU_Composite_Doc_Utils                    # composite doc, .ssm, extract all related insert files, array of filenames test
+    include SiSU_Response
+    include SiSU_Languages_Selected
+    def initialize(opt,file)
+      @opt,@file=opt,file
+    end
+    def song
+      if @opt.lng==language.source_language_selected_str
+        ans=response?('po4a config file')
+        if ans
+          po4a_cfg
+        end
+      end
+    end
+    def po4a_cfg_filename
+      'po4a.cfg'
+    end
+    def dir
+      def pwd
+        Dir.pwd
+      end
+      def po4a_
+        'po4a/' # ''
+      end
+      def pot
+        #po4a_ + 'pot'
+        'pot'
+      end
+      def po
+        #po4a_ + 'po'
+        'po'
+      end
+      self
+    end
+    def po4a_cfg_file
+      File.open("#{Dir.pwd}/#{po4a_cfg_filename}",'w')
+    end
+    def po4a_cfg
+      lng=language.source_language_selected_str
+      doc_import_list=composite_and_imported_filenames_array(@opt.fno)
+      po4a_cfg_arr=[]
+      po4a_cfg_arr \
+        << "[po4a_langs] #{language.translation_languages_selected_that_are_available_str}"
+      po4a_cfg_arr \
+        << "[po4a_paths] #{dir.pot}/$master.pot $lang:#{dir.po}/$lang/$master.po"
+      doc_import_list.each do |file_src|
+        file_src_fn=
+          file_src.gsub(/#{language.source_language_selected_str}\//,'')
+        po4a_cfg_arr \
+          << "[type: text] #{lng}/#{file_src} $lang:$lang/#{file_src_fn}"
+      end
+      file=@file.write_file.po4a_cfg
+      po4a_cfg_arr.each do |txt|
+      puts txt
+        file << txt << "\n"
+      end
+      file.close
+    end
+  end
+  class Po4aProject
+    include SiSU_Languages_Selected
+    include SiSU_Response
+    def initialize(opt,file)
+      @opt,@file=opt,file
+    end
+    def song
+      make_paths
+      if FileTest.directory?(@file.output_path.po4a.dir)
+        Dir.chdir(@file.output_path.po4a.dir)
+        dirs=Dir['*/']
+        dirs_language=[]
+        dirs.each do |x|
+          dirs_language << x.gsub(/\/$/,'')
+        end
+        dirs_translation = \
+          (language.translation_languages_available & dirs_language)
+      end
+      if (language.translation_languages_available & [@opt.lng]).length == 1
+        puts %{gettext for: #{dirs_translation}
+in #{Dir.pwd}}
+        ans=response?('gettext?')
+        if ans
+          gettext_if_any_build_src_trans_po
+        end
+      end
+      ans=response?('build project?')
+      if ans
+        build_src_master_to_pot_and_po_and_srcs
+      end
+    end
+    def flags
+      def debug
+        '-d -v'
+      end
+      def normal
+        ''
+      end
+      def quiet
+        '-q'
+      end
+      self
+    end
+    def build_src_master_to_pot_and_po_and_srcs
+      if SiSU_Sys_Call::SystemCall.new.po4a
+        pwd=Dir.pwd
+        #cmd='po4a --keep 0 -M UTF-8 --no-backups ' \
+        #+ '--package-name ' \
+        #+ 'sisu-manual' + ' ' \
+        #+ flags.normal + ' ' \
+        #+ filename.po4a_cfg
+        cmd='po4a --keep 0 -M UTF-8' \
+        + flags.normal + ' ' \
+        + @file.base_filename.po4a_cfg
+        Dir.chdir(@file.output_path.po4a.dir)
+        system("
+          cd #{@file.output_path.po4a.dir}
+          #{cmd}
+          cd -
+        "); puts cmd
+        Dir.chdir(pwd)
+      end
+    end
+    def gettext_if_any_build_src_trans_po
+        Dir.chdir(@file.output_path.po4a.dir)
+        dirs=Dir['*/']
+        dirs_language=[]
+        dirs.each do |x|
+          dirs_language << x.gsub(/\/$/,'')
+        end
+        dirs_translation = \
+          (language.translation_languages_available & dirs_language)
+        files_src=Dir.glob("./#{source_language_selected_str}/*.ss[tmi]")
+        dirs_translation.each do |lng|
+          files_src.each do |file|
+            fn=file.gsub(/\.\/#{source_language_selected_str}\//,'')
+            system("
+              po4a-gettextize -f text -M utf-8 \
+              -m ./#{source_language_selected_str}/#{fn} \
+              -l ./#{lng}/#{fn} \
+              -p ./po/#{lng}/#{fn}.po
+            ")
+            puts fn
+          end
+        end
+    end
+    def dir_mk(dir)
+      unless FileTest.directory?(dir)
+        FileUtils::mkdir_p(dir)
+      end
+    end
+    def make_paths
+      dir_mk(@file.output_path.pot.dir)
+      dir_mk(@file.output_path.po.dir)
+    end
+    def clean
+      #rm -f po/*/*.po~
+      #rm -rf ../build
+      FileUtils.rm_f Dir.glob("./#{dir.po}/*/*.po~")
+    end
+    def distclean
+      #rm -f po4a.cfg
+      #rm -rf $(LANGUAGES)
+      FileUtils::rm_f(filename.po4a_cfg)
+      FileUtils::rm_r(language.possible_translations,:force => true)
+      #FileUtils::rm_r(language.translation_languages_selected_that_are_available,:force => true)
+    end
+  end
+  class Po4aDistClean
+    include SiSU_Languages_Selected
+    include SiSU_Response
+    def initialize(opt,file)
+      @opt,@file=opt,file
+    end
+    def song
+      pwd=Dir.pwd
+      if FileTest.directory?(@file.output_path.po4a.dir)
+        Dir.chdir(@file.output_path.po4a.dir)
+        dirs=Dir['*/']
+        dirs_language=[]
+        dirs.each do |x|
+          dirs_language << x.gsub(/\/$/,'')
+        end
+        dirs_translation = \
+          (language.translation_languages_available & dirs_language)
+        if dirs_translation.length > 0
+          puts %{remove language translation directorie(s): #{dirs_translation}
+in #{Dir  .pwd}}
+          ans=response?('disclean?')
+          if ans
+            FileUtils::rm_f(@file.base_filename.po4a_cfg)
+            FileUtils::rm_r(dirs_translation,:force => true)
+            #FileUtils::rm_r(language.translation_languages_available,:force => true)
+          end
+        end
+        Dir.chdir(pwd)
+      end
+    end
+  end
+end
+#end
+__END__
+REMOVE
+&#033;\|&#035;\|&&#042;\|&#045;\|&#047;\|&#095;\|&#123;\|&#125;\|&#126;\|&#
+
+tables are problematic, difficult to reconstitute instruction, check
+
+metadata, move to top? and work on
+
+footnotes, different types, asterisk, also do you want to have separate
+paragraphs, or breaks within one block?
+
+where no ocn appropriately use ~# or -# or indeed 1~name-
+
+comments in document, what to do about them, not sure they are currently
+retained in dal, could be quite valuable to keep
+
+Translate Shell
+http://www.soimort.org/translate-shell/
+translate.google.com