From 75e3bf86382edf99275a25895b362647158e25c1 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Tue, 10 Jan 2012 22:37:26 -0500 Subject: v3dv, add dev branch (use to make some changes to module & class names & test) * (intended as) short term branch, merge back into v3 once tested * sisu --dev (to invoke) --- lib/sisu/v3dv/sitemaps.rb | 215 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 215 insertions(+) create mode 100644 lib/sisu/v3dv/sitemaps.rb (limited to 'lib/sisu/v3dv/sitemaps.rb') diff --git a/lib/sisu/v3dv/sitemaps.rb b/lib/sisu/v3dv/sitemaps.rb new file mode 100644 index 00000000..7f81b6be --- /dev/null +++ b/lib/sisu/v3dv/sitemaps.rb @@ -0,0 +1,215 @@ +# encoding: utf-8 +=begin + + * Name: SiSU + + * Description: a framework for document structuring, publishing and search + + * Author: Ralph Amissah + + * Copyright: (C) 1997 - 2012, 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 . + + If you have Internet connection, the latest version of the GPL should be + available at these locations: + + + + + + + + * SiSU uses: + * Standard SiSU markup syntax, + * Standard SiSU meta-markup syntax, and the + * Standard SiSU object citation numbering and system + + * Hompages: + + + + * Download: + + + * Ralph Amissah + + + + ** Description: sitemap created from parameters extracted from input file(s) + +=end +module SiSU_Sitemaps + require_relative 'param' # param.rb + include SiSU_Param + require_relative 'sysenv' # sysenv.rb + include SiSU_Env + require_relative 'shared_xml' # shared_xml.rb + include SiSU_XML_munge + class Source + def initialize(opt) + @opt=opt + end + def read + songsheet + end + def songsheet + begin + @sys=SiSU_Env::System_call.new + fn_set_lang=SiSU_Env::Standardise_language.new(@opt.lng).language + @fn=SiSU_Env::Env_call.new(@opt.fns).lang(fn_set_lang[:c]) + if @opt.cmd =~/Y/ + @md=SiSU_Param::Parameters.new(@opt).get + @trans=SiSU_XML_munge::Trans.new(@md) #check @md is required + @env=SiSU_Env::Info_env.new(@md.fns) +# @file=SiSU_Env::SiSU_file.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 #% utf8 + output_map(sitemap) + elsif @opt.mod.inspect =~/--sitemaps/ + @sitemap_idx_fn='sitemapindex.xml' + @env=SiSU_Env::Info_env.new + output_idx(sitemap_index) + SiSU_Screen::Ansi.new(@opt.cmd,"sitemap index:","#{@env.path.output}/#{@sitemap_idx_fn}").result unless @opt.cmd =~/q/ + end + rescue; SiSU_Errors::Info_error.new($!,$@,@opt.cmd,@opt.fns).error + ensure + end + end + def make_file(path,filename) + if File.writable?("#{path}/."); File.new("#{path}/#{filename}",'w+') + else + SiSU_Screen::Ansi.new('',"is the file or directory writable?, could not create #{filename}").warn + end + 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::SiSU_file.new(@md).make_path(path) + file=SiSU_Env::SiSU_file.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 + sitemap_files.each do |s| + f=s.gsub(/.+?\/sitemap_([^\/]+?)\.xml$/,'\1') + @trans.char_enc.utf8(f) if @sys.locale =~/utf-?8/i #% utf8 +sitemap_idx <<< + #{@env.path.url.remote}/#{f}/sitemap.xml + +WOK + end + sitemap_idx <<< +WOK + idx=sitemap_idx.join + end + def sitemap + map=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 +< + +#{@rdf.comment_xml} + + #{@env.path.url.remote}/#{@fnb_utf8_xml}/#{@fn[:toc]} + #{@md.date.modified} + monthly + 0.7 + + + #{@env.path.url.remote}/#{@fnb_utf8_xml}/#{@fn[:doc]} + #{@md.date.modified} + 0.5 + + + #{@env.path.url.remote}/#{@fnb_utf8_xml}/#{@fn[:manifest]} + #{@md.date.modified} + 0.5 + + +WOK + end + def sitemap_no_date +< + +#{@rdf.comment_xml} + + #{@env.path.url.remote}/#{@fnb_utf8_xml}/#{@fn[:toc]} + monthly + 0.7 + + + #{@env.path.url.remote}/#{@fnb_utf8_xml}/#{@fn[:doc]} + 0.5 + + + #{@env.path.url.remote}/#{@fnb_utf8_xml}/#{@fn[:manifest]} + 0.5 + + +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 + + -- cgit v1.2.3 From 51ba2d70af41137ddc3323d79e01b28fbcb40082 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Tue, 10 Jan 2012 22:44:24 -0500 Subject: v3dv: module names, use more CamelCase --- lib/sisu/v3dv/sitemaps.rb | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'lib/sisu/v3dv/sitemaps.rb') diff --git a/lib/sisu/v3dv/sitemaps.rb b/lib/sisu/v3dv/sitemaps.rb index 7f81b6be..a96c239e 100644 --- a/lib/sisu/v3dv/sitemaps.rb +++ b/lib/sisu/v3dv/sitemaps.rb @@ -62,7 +62,7 @@ module SiSU_Sitemaps require_relative 'sysenv' # sysenv.rb include SiSU_Env require_relative 'shared_xml' # shared_xml.rb - include SiSU_XML_munge + include SiSU_XML_Munge class Source def initialize(opt) @opt=opt @@ -77,10 +77,10 @@ module SiSU_Sitemaps @fn=SiSU_Env::Env_call.new(@opt.fns).lang(fn_set_lang[:c]) if @opt.cmd =~/Y/ @md=SiSU_Param::Parameters.new(@opt).get - @trans=SiSU_XML_munge::Trans.new(@md) #check @md is required + @trans=SiSU_XML_Munge::Trans.new(@md) #check @md is required @env=SiSU_Env::Info_env.new(@md.fns) # @file=SiSU_Env::SiSU_file.new(@md) - @rdf=SiSU_XML_tags::RDF.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 #% utf8 output_map(sitemap) -- cgit v1.2.3 From 732dca2b21d2261349e639c37e6ed1431e65250c Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Tue, 10 Jan 2012 22:47:40 -0500 Subject: v3dv: class names, remove "SiSU_" (reserve for module names for consistency) --- lib/sisu/v3dv/sitemaps.rb | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'lib/sisu/v3dv/sitemaps.rb') diff --git a/lib/sisu/v3dv/sitemaps.rb b/lib/sisu/v3dv/sitemaps.rb index a96c239e..b3e9169d 100644 --- a/lib/sisu/v3dv/sitemaps.rb +++ b/lib/sisu/v3dv/sitemaps.rb @@ -79,7 +79,7 @@ module SiSU_Sitemaps @md=SiSU_Param::Parameters.new(@opt).get @trans=SiSU_XML_Munge::Trans.new(@md) #check @md is required @env=SiSU_Env::Info_env.new(@md.fns) -# @file=SiSU_Env::SiSU_file.new(@md) +# @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 #% utf8 @@ -105,8 +105,8 @@ module SiSU_Sitemaps filename=@fn[:sitemap] touch_path=@md.file.output_path.sitemaps.dir touch_filename=@fn[:sitemap_touch] - SiSU_Env::SiSU_file.new(@md).make_path(path) - file=SiSU_Env::SiSU_file.new(@md).make_file(path,filename) + 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}") -- cgit v1.2.3 From df67ee1079d074dc2af54aa87187c6538e73d5d7 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Tue, 10 Jan 2012 22:50:12 -0500 Subject: v3dv: class names, use more CamelCase --- lib/sisu/v3dv/sitemaps.rb | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) (limited to 'lib/sisu/v3dv/sitemaps.rb') diff --git a/lib/sisu/v3dv/sitemaps.rb b/lib/sisu/v3dv/sitemaps.rb index b3e9169d..cefdba8e 100644 --- a/lib/sisu/v3dv/sitemaps.rb +++ b/lib/sisu/v3dv/sitemaps.rb @@ -72,13 +72,13 @@ module SiSU_Sitemaps end def songsheet begin - @sys=SiSU_Env::System_call.new - fn_set_lang=SiSU_Env::Standardise_language.new(@opt.lng).language - @fn=SiSU_Env::Env_call.new(@opt.fns).lang(fn_set_lang[:c]) + @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.cmd =~/Y/ @md=SiSU_Param::Parameters.new(@opt).get @trans=SiSU_XML_Munge::Trans.new(@md) #check @md is required - @env=SiSU_Env::Info_env.new(@md.fns) + @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 @@ -86,11 +86,11 @@ module SiSU_Sitemaps output_map(sitemap) elsif @opt.mod.inspect =~/--sitemaps/ @sitemap_idx_fn='sitemapindex.xml' - @env=SiSU_Env::Info_env.new + @env=SiSU_Env::InfoEnv.new output_idx(sitemap_index) SiSU_Screen::Ansi.new(@opt.cmd,"sitemap index:","#{@env.path.output}/#{@sitemap_idx_fn}").result unless @opt.cmd =~/q/ end - rescue; SiSU_Errors::Info_error.new($!,$@,@opt.cmd,@opt.fns).error + rescue; SiSU_Errors::InfoError.new($!,$@,@opt.cmd,@opt.fns).error ensure end end -- cgit v1.2.3