qsgen2/qsgen2

730 lines
26 KiB
Plaintext
Raw Normal View History

2024-01-28 18:24:38 +01:00
#!/usr/bin/zsh
# Quick Site Generator 2 is a static website generator inspired by Nikola.
# It is written for the Z shell (zsh) because that's what I use and also because I like it better than Bash.
#
# This script is an almost complete rewrite of my old script because it became overly complicated and
# had way too many bugs, even though it worked on simple sites.
#
# qsgen2 uses different templates and its own formattings tags to generate the static HTML pages.
#
# The file structure in the project directory should look like this:
#
# .blog_cache
# .pages_cache
# config
# index.tpl
# templates/
# templates/<theme>/pages.tpl
# templates/<theme>/blogs.tpl
# templates/<theme>/blog_index.tpl
# blog/
# blog/2024-01-26-1.blog
#
# Explanation of the file structure.
# The file 'config' contains the settings for this specific project.
# The file 'index.tpl' is what becomes index.html that is served to the public.
# The 'templates/' directory contains the templates used to generate the pages and blog posts.
# The 'blog/' directory contains the blog posts. The date format of the files are used to create a blog/index.html with the newest post first.
#
# Contents of the file 'config' --> CHANGE THESE <--
# export site_name="The name of the website"
# - This is the project directory
# export project_dir=${HOME}/www/vikingo
# - This is where the generated files will be put
# export www_root=${HOME}/www_root/smelror.com
# #################################################################################################
# I don't think these need to be here as they'll always be in the same place with the same names
# export pages=${project_dir}/templates/<theme>/pages.tpl
# export blogs=${project_dir}/templates/<theme>/blogs.tpl
# export blog_list=${project_dir}/templates/<theme>/blog_list.tpl
# export blog_index=${project_dir}/templates/<theme>/blog_index.tpl
###################################################################################################
# export blog_in_index=false
2024-01-29 15:41:09 +01:00
VERSION="0.0.1 alpha" # Mon-2024-01-29
QSGEN="Quick Site Generator 2"
2024-01-28 18:24:38 +01:00
# Set to true or false
# This will show debug information from almost every function in this script
2024-01-29 21:41:48 +01:00
debug=false
2024-01-28 18:24:38 +01:00
function include () {
2024-01-29 15:06:36 +01:00
# This function is used to include other functions that will normally be in
# ${HOME}/bin/include/
2024-01-28 18:24:38 +01:00
# Edit this path to reflect your installation
2024-01-29 15:06:36 +01:00
local inc_file=${HOME}/bin/include/${1}.inc
2024-01-28 18:24:38 +01:00
if [[ ! -f ${inc_file} ]]; then
2024-01-29 15:06:36 +01:00
local inc_opt=$( echo ${1} | cut -d\/ -f2 )
echo "Supplied option \"${inc_opt}\" is not a valid include."
2024-01-28 18:24:38 +01:00
else
builtin source ${inc_file} ${2}
fi
}
2024-01-29 15:06:36 +01:00
# Including some colors to the script
2024-01-28 18:24:38 +01:00
include common/colors
2024-01-28 19:34:30 +01:00
echo "${magenta}${QSGEN} ${VERSION}${end}"
function _version() {
echo "${yellow}- Created by kekePower - 2018-$(date +%Y)${end}"
2024-01-28 19:33:09 +01:00
echo "${yellow}- https://github.com/kekePower/qsgen2/${end}"
2024-01-29 15:51:30 +01:00
echo "${yellow}- See '${1} help' for more information."
2024-01-28 19:33:09 +01:00
exit
}
2024-01-28 19:33:09 +01:00
function _help() {
echo "This is where I'll write the Help documentation."
2024-01-28 18:24:38 +01:00
exit
}
if [[ "$1" == "version" || "$1" == "-v" || "$1" == "--version" ]]; then
_version ${0:t}
elif [[ "$1" == "help" || "$1" == "-h" || "$1" == "--help" ]]; then
_help ${0:t}
fi
2024-01-28 18:24:38 +01:00
# Loading Zsh modules
zmodload zsh/files
# Check for, an source, the config file for this specific website
if [[ -f $(pwd)/config ]]; then
if (${debug}) echo "${red}Config file found and sourced${end}\n${yellow} - $(pwd)/config${end}"
# CONFIG=$(pwd)/config
builtin source $(pwd)/config
else
echo "${red}Cannot find configuration file.${end}"
echo "${yellow} - Please create the file 'config' in your project directory.${end}"
exit
fi
if (${debug}); then
echo "${red}Contents of Config file:${end}"
echo "${yellow} - site_name=${site_name}${end}"
echo "${yellow} - site_tagline=${site_tagline}${end}"
2024-01-28 18:24:38 +01:00
echo "${yellow} - theme=${theme}${end}"
echo "${yellow} - project_dir=${project_dir}${end}"
echo "${yellow} - www_root=${www_root}${end}"
echo "${yellow} - blog_in_index=${blog_in_index}${end}"
echo "${yellow} - generator=${generator}${end}"
fi
# Let's check if qsgen2 can generate this site by checking if 'generator' is available
if [[ ! ${generator} ]]; then
echo "${0:t} cannot parse this site. Exiting."
exit
fi
# We define the variable 'engine' based on what's in the 'config' file.
2024-01-28 18:24:38 +01:00
if [[ ${generator} == "native" ]]; then
# Usage: ${engine} ${1} - Where 1 is the file you want to convert
2024-01-28 18:24:38 +01:00
engine=_html
elif [[ ${generator} == "markdown" ]]; then
if [[ ! -f /usr/bin/markdown ]]; then
echo "Please install the 'discount' package to use Markdown."
exit
else
# Let's make sure that the Markdown executable gets all its variables: 1 and 2
if [[ ! ${2} ]] || [[ ${2} == "" ]]; then
echo "Engine: To use Markdown, please provide a second variable, the output file."
echo "Engine: Example: engine file.tpl www_root/file.html"
exit
else
# Usage: ${engine} ${1} - Where 1 is the file you want parsed
engine=$( /usr/bin/markdown ${1} -d )
fi
fi
2024-01-28 18:24:38 +01:00
fi
2024-01-29 19:05:36 +01:00
if (${debug}) echo "${red}Using the ${generator} engine${end}"
2024-01-28 18:24:38 +01:00
2024-01-29 19:05:36 +01:00
# Define cache files for blogs and pages
2024-01-28 18:24:38 +01:00
blog_cache_file="${project_dir}/.blog_cache"
pages_cache_file="${project_dir}/.pages_cache"
builtin cd ${project_dir}
# Let's put these here for now.
export today=$( date "+%Y-%m-%d - %T" )
export blogdate=$( date +%a-%Y-%b-%d )
2024-01-28 18:24:38 +01:00
# Let's create arrays of all the files we'll be working on
function _list_blog_idx() {
ls -har blog/*.idx | while read -r file; do
blog_idx_array+=($file)
done
}
function _list_blog_tmp_idx() {
ls -har blog/*.tmp.html | while read -r file; do
blog_tmp_idx_array+=($file)
done
}
function _list_blog() {
ls -1btar blog/*.blog | while read -r file; do
blog_index_file_array+=($file)
done
}
# BLOG CACHE
function _blog_cache() {
local debug=false
# Create an associative array for the blog cache
typeset -A blog_cache
# Load the existing blog cache
if [[ -f $blog_cache_file ]]; then
while IFS=':' read -r name hash; do
blog_cache[$name]=$hash
if (${debug}) echo "${red}HASH VALUE: ${blog_cache[${name}]}${end}"
done < "$blog_cache_file"
fi
2024-01-28 18:24:38 +01:00
# Initialize the array for storing blog files to process
make_blog_array=()
2024-01-28 18:24:38 +01:00
# Process blog files
for blog_file in $(ls -har blog/*.blog); do
# Compute the current blog file hash
current_hash=$(md5sum "$blog_file" | awk '{print $1}')
2024-01-28 18:24:38 +01:00
if (${debug}) echo "${red}1. blog_cache: ${blog_file}${end}"
if (${debug}) echo "${red}2. current_cache: ${current_hash}${end}"
# Check if the blog file is new or has changed
if [[ ${blog_cache[$blog_file]} != "$current_hash" ]]; then
if (${debug}) echo "${red}3. new_cache_file: ${blog_file}${end}"
if (${debug}) echo "${red}4. new_current_cache: ${current_hash}${end}"
# Blog file is new or has changed; add it to the processing array
make_blog_array+=("$blog_file")
# Update the blog cache with the new hash
blog_cache[$blog_file]=$current_hash
fi
done
2024-01-28 18:24:38 +01:00
# Rebuild the blog cache file from scratch
: >| "$blog_cache_file" # Truncate the file before writing
for name in "${(@k)blog_cache}"; do
echo "$name:${blog_cache[$name]}" >> "$blog_cache_file"
done
2024-01-28 18:24:38 +01:00
}
# PAGES CACHE
# Returns the array pages_array()
2024-01-28 18:24:38 +01:00
function _pages_cache() {
local debug=false
# Create an associative array for the pages cache
typeset -A pages_cache
# Load the existing pages cache
if [[ -f $pages_cache_file ]]; then
while IFS=':' read -r name hash; do
pages_cache[$name]=$hash
if (${debug}) echo "${red}PAGES HASH VALUE: ${pages_cache[${name}]}${end}"
done < "$pages_cache_file"
2024-01-28 18:24:38 +01:00
fi
# Initialize the array for storing pages files to process
pages_array=()
# Process pages files
for file in $(ls -1bt *tpl); do
# Compute the current blog file hash
current_hash=$(md5sum "$file" | awk '{print $1}')
if (${debug}) echo "${red}1. pages_cache: ${pages_cache[$file]}${end}"
if (${debug}) echo "${red}1. current_cache: ${current_hash}${end}"
# Check if the pages file is new or has changed
if [[ ${pages_cache[$file]} != "$current_hash" ]]; then
if (${debug}) echo "${red}2. pages_file: ${pages_cache[$file]}${end}"
if (${debug}) echo "${red}2. current_cache: ${current_hash}${end}"
# Pages file is new or has changed; add it to the processing array
pages_array+=("$file")
# Update the pages cache with the new hash
pages_cache[$file]=$current_hash
fi
done
# Rebuild the pages cache file from scratch
: >| "$pages_cache_file" # Truncate the file before writing
for name in "${(@k)pages_cache}"; do
echo "$name:${pages_cache[$name]}" >> "$pages_cache_file"
done
2024-01-28 18:24:38 +01:00
}
function _last_updated() {
2024-01-30 09:26:34 +01:00
# This function updates #updated and #version tags in the provided string
local content="${1}"
local debug=false
if (${debug}) echo "${red}_last_updated: Setting date and version in footer${end}"
# Perform the replacements
local updated_content=$(echo "${content}" | sed \
-e "s|#updated|${TODAY}|" \
-e "s|#version|${QSGEN} ${VERSION}|")
# Return the updated content
echo "${updated_content}"
2024-01-28 18:24:38 +01:00
}
function _file_to_lower() {
local filename=${1}
# Replace spaces with dashes
filename="${filename// /-}"
# Convert to lowercase and remove invalid characters
filename=$(echo "${filename}" | sed -e 's/^[^a-zA-Z0-9_.]+//g' -e 's/[^a-zA-Z0-9_-]+/-/g')
2024-01-29 23:28:03 +01:00
echo ${filename}
}
2024-01-28 18:24:38 +01:00
function _pages() {
# This function generates all the new and updated Pages
2024-01-28 18:24:38 +01:00
2024-01-29 22:21:58 +01:00
local debug=true
2024-01-28 18:24:38 +01:00
2024-01-30 00:39:30 +01:00
# Load the cache for Pages
if (${debug}) echo "_pages: Running function _pages_cache"
_pages_cache
if (( ${#pages_array[@]} > 0 )); then
2024-01-30 00:38:25 +01:00
if (${debug}) echo "_pages: Setting Pages template"
2024-01-28 18:24:38 +01:00
local pages=${project_dir}/templates/${theme}/pages.tpl
# Let's check if we can access the pages.tpl file.
# It not, exit script.
if [[ ! -f ${pages} ]]; then
echo "Unable to find the Pages template: ${pages}"
exit
else
# Read template once
2024-01-30 00:38:25 +01:00
if (${debug}) echo "_pages: Reading Pages template into pages_tpl"
pages_tpl="$(<${pages})"
fi
# If pages_array is not empty, we do work
2024-01-29 22:21:58 +01:00
if (${debug}) echo "_pages: pages_array is not empty"
for pages_in_array in ${pages_array[@]}
do
echo "${green}Generating Page: ${pages_in_array}${end}"
# Read the file once
2024-01-29 22:35:17 +01:00
if (${debug}) echo "_pages: Loading page_content once"
local page_content="$(<${pages_in_array})"
2024-01-29 22:39:05 +01:00
# Grab the title from the Page
2024-01-29 22:21:58 +01:00
if (${debug}) echo "_pages: Grepping for page_title"
2024-01-30 01:16:42 +01:00
page_title=$( echo ${page_content} | head -2 | grep \#title | cut -d= -f2 )
2024-01-30 00:42:34 +01:00
# Remove the #title line from the buffer. No longer needed.
if (${debug}) echo "_pages: Removing #title line from page_content"
page_content=$( echo ${page_content} | grep -v \#title )
# Replace every #pagetitle in pages_tpl
2024-01-29 23:05:21 +01:00
if (${debug}) echo "_pages: Replacing #pagetitle in pages_tpl"
2024-01-30 00:01:35 +01:00
pages_tpl=$( echo ${pages_tpl} | sed -e "s|#pagetitle|${page_title}|g" )
# Replace every #tagline in pages_tpl
2024-01-29 23:05:21 +01:00
if (${debug}) echo "_pages: Replacing tagline"
2024-01-30 00:05:43 +01:00
pages_tpl=$( echo ${pages_tpl} | sed -e "s|#tagline|${site_tagline}|g" )
2024-01-29 23:45:53 +01:00
# Insert page_content into pages_tpl by replacing the BODY tag present there
if (${debug}) echo "_pages: Replacing BODY with page_content in pages_tpl using Perl"
# Use Perl for multi-line and special character handling
pages_tpl=$( echo "${pages_tpl}" | perl -pe "s|BODY|${page_content}|gs" )
2024-01-30 01:18:48 +01:00
2024-01-30 01:15:19 +01:00
# HTML'ify the page content
if (${debug}) echo "_pages: Running engine on ${pages_in_array}"
pages_tpl=$( ${engine} ${page_content} )
2024-01-30 00:32:59 +01:00
# Replace #updated with today's date and #version with Name and Version to footer
if (${debug}) echo "_pages: _last_updated in pages_tpl"
2024-01-30 09:26:34 +01:00
pages_tpl=$( _last_updated ${pages_tpl} )
2024-01-29 22:57:49 +01:00
# Look for links, images and videos and convert them if present.
if (${debug}) echo "_pages: Checking for #link, #showimg and #ytvideo in page_content"
2024-01-30 09:26:34 +01:00
if [[ $( grep \#link ${pages_tpl} > /dev/null ) ]]; then
echo "If #link is present, run _link: pages_tpl"
page_content=$( _link "${pages_tpl}" )
2024-01-30 09:30:13 +01:00
fi
if [[ $( grep \#showimg ${pages_tpl} > /dev/null ) ]]; then
2024-01-30 09:26:34 +01:00
echo "If #showimg is present, run _image: pages_tpl"
page_content=$( _image "${pages_tpl}" )
2024-01-30 09:30:13 +01:00
fi
if [[ $( grep \#ytvideo ${pages_tpl} > /dev/null ) ]]; then
2024-01-30 09:26:34 +01:00
echo "If #ytvideo is present, run _youtube: pages_tpl"
page_content=$( _youtube "${pages_tpl}" )
2024-01-29 22:57:49 +01:00
fi
# Clean up unused tags, if any
if (${debug}) echo "_pages: Running _cleanup"
2024-01-30 09:26:34 +01:00
page_content=$( _cleanup "${pages_tpl}" )
# Always use lowercase for file names
if (${debug}) echo "_pages: Lowercase filnames, always"
pages_title_lower=$( _file_to_lower "${pages_in_array}" )
# Write pages_tpl to disk
echo "${green}Writing ${www_root}/${pages_title_lower%.*}.html to disk.${end}"
echo "${pages_tpl}" > ${www_root}/${pages_title_lower%.*}.html
done
2024-01-30 00:38:25 +01:00
else
echo "${yellow}No new or updated Pages${end}"
fi
2024-01-28 18:24:38 +01:00
}
function _blogs() {
# This function generates the blog files
local debug=true
# Running function _list_blog
# It returns the array: blog_index_file_array
echo "_blogs: Running function _list_blog"
_list_blog
# Running function _blog_cache
# It returns the array: make_blog_array
echo "_blogs: Running function _blog_cache"
_blog_cache
if (( ${#make_blog_array[@]} > 0 )); then
local blog_tpl=${project_dir}/templates/${theme}/blogs.tpl
if [[ ! -f ${blog_tpl} ]]; then
echo "Unable to find the Blog template: ${blog_tpl}"
exit
fi
2024-01-28 18:24:38 +01:00
local sdate btitle ingress body blog_index blog_dir blog_url
if (${debug}) echo "_blogs: _blog_list_for_index: Just before the for loop: make_blog_array"
2024-01-28 18:24:38 +01:00
for blog in ${make_blog_array[@]}
do
if (${debug}) echo "0001: ${red}_blogs: _blog_list_for_index: Processing ${blog}${end}"
# Read the file once
if (${debug}) echo "0002: ${red}_blogs: _blog_list_for_index: Reading blog from array into content: ${blog}${end}"
local content="$(<${blog})"
sed -i "s/GETDATE/${BLOGDATE}/" ${blog}
# Array sdate = Name day=4, Year=2, Month=3, Number day=1
sdate=( $( echo ${content} | grep DATE | sed "s|DATE\ ||" | sed "s|\-|\ |g" ) )
btitle=$( echo ${content} | grep BLOG_TITLE | cut -d' ' -f2- )
ingress=$( echo ${content} | sed "s/'/\\\'/g" | xargs | grep -Po "#INGRESS_START\K(.*?)#INGRESS_STOP" | sed "s|\ \#INGRESS_STOP||" | sed "s|^\ ||" )
body=$( echo ${content} | sed "s/'/\\\'/g" | xargs | grep -Po "#BODY_START\K(.*?)#BODY_STOP" | sed "s|\ \#BODY_STOP||" | sed "s|^\ ||" )
blog_index=$( echo ${btitle:l} | sed -e "s|-|_|" | sed -e "s|\ |-|g" | sed -e "s|\,||g" | sed -e "s|\.||" )
blog_dir="/blog/${sdate[2]}/${sdate[3]}/${sdate[4]}"
blog_url="${blog_dir}/${blog_index}.html"
if [[ ! -d ${www_root}${blog_dir} ]]; then
if (${debug}) echo "0003: ${red}_blogs: Creating blog directory: ${www_root}${blog_dir}${end}"
mkdir -p ${www_root}${blog_dir}
fi
if (${debug}) echo "0004: ${cyan}_blogs: blog_index: ${blog_tpl}${end}"
tee < ${blog_tpl} | sed \
-e "s|BLOGTITLE|${btitle}|" \
-e "s|CALADAY|${sdate[1]}|" \
-e "s|CALNDAY|${sdate[4]}|" \
-e "s|CALMONTH|${sdate[3]}|" \
-e "s|CALYEAR|${sdate[2]}|" \
-e "s|BLOGURL|${blog_url}|" \
-e "s|INGRESS|${ingress}|" \
-e "s|DATE ||" \
> ${blog%.*}.idx
2024-01-29 14:54:23 +01:00
if (${debug}) echo "0005: ---------- ${red}_blogs: TO_IDX_FILE: ${blog%.*}.idx${end}"
2024-01-28 18:24:38 +01:00
if (${debug}) echo "0006: ${cyan}_blogs: BLOG_URL_TPL: ${www_root}${blog_url}${end}"
tee < ${blog_tpl} | sed \
-e "s|BLOGTITLE|${btitle}|" \
-e "s|CALADAY|${sdate[1]}|" \
-e "s|CALNDAY|${sdate[4]}|" \
-e "s|CALMONTH|${sdate[3]}|" \
-e "s|CALYEAR|${sdate[2]}|" \
-e "s|INGRESS|${ingress}|" \
-e "s|BODY|${body}|" \
-e "s|DATE ||" \
-e "s|\#title||" \
>> ${www_root}${blog_url}
2024-01-29 14:54:23 +01:00
if (${debug}) echo "0007: ---------- ${red}_blogs: ${blog_tpl} -- TO_BLOG_URL_FILE: ${www_root}${blog_url}${end}"
2024-01-28 18:24:38 +01:00
echo "_blogs: _last_updated: Updating footer for ${www_root}${blog_url}"
_last_updated ${www_root}${blog_url}
echo "_blogs: Running HTML engine: ${engine}"
${engine} ${blog_url}
if [[ $( grep \#link ${www_root}${blog_url} ) ]]; then
echo "If #link is present, run _link: ${www_root}${blog_url}"
_link ${blog_url}
elif [[ $( grep \#showimg ${www_root}${blog_url} ) ]]; then
echo "If #showimg is present, run _image: ${www_root}${blog_url}"
_image ${blog_url}
elif [[ $( grep \#ytvideo ${www_root}${blog_url} ) ]]; then
echo "If #ytvideo is present, run _youtube: ${www_root}${blog_url}"
_youtube ${blog_url}
fi
_cleanup ${blog_url}
done
else
echo "${yellow}No new or updated Blogs detected.${end}"
fi
}
function _blog_idx_for_index() {
# This function generates the file blog/index.idx
local debug=false
if [[ -f ${project_dir}/blog/index.tmp.html ]]; then
echo "Remove temporary file: ${project_dir}/blog/index.tmp.html"
rm -f ${project_dir}/blog/index.tmp.html
fi
}
function _blog_index() {
# This function generates the /blog/index.html file that gets its data from _blog_list_for_index()
local debug=false
local pages=${project_dir}/templates/${theme}/pages.tpl
if [[ ! -f ${pages} ]]; then
echo "Unable to find the Pages template: ${pages}"
exit
fi
2024-01-28 18:24:38 +01:00
local blog_index_title="Blog"
# Running function _list_blog_idx
# It returns the array: blog_tmp_idx_array
_list_blog_tmp_idx
if (( ${#blog_tmp_idx_array[@]} > 0 )); then
local blog_list=${project_dir}/templates/${theme}/blog_list.tpl
if [[ ! -f ${blog_list} ]]; then
echo "Unable to find the Pages template: ${blog_list}"
exit
fi
2024-01-28 18:24:38 +01:00
for blog_files in ${blog_tmp_idx_array[@]}
do
local content="$(<${blog_files})"
sed -i "s/GETDATE/${BLOGDATE}/" ${blog_files}
# Array sdate = Name day=4, Year=2, Month=3, Number day=1
sdate=( $( echo ${content} | grep DATE | sed "s|DATE\ ||" | sed "s|\-|\ |g" ) )
ingress=$( echo ${content} | sed "s/'/\\\'/g" | xargs | grep -Po "#INGRESS_START\K(.*?)#INGRESS_STOP" | sed "s|\ \#INGRESS_STOP||" | sed "s|^\ ||" )
body=$( echo ${content} | sed "s/'/\\\'/g" | xargs | grep -Po "#BODY_START\K(.*?)#BODY_STOP" | sed "s|\ \#BODY_STOP||" | sed "s|^\ ||" )
blog_date="${sdate[1]} ${sdate[4]}-${sdate[3]}-${sdate[2]}"
sed \
-e "s|BLOGDATE|${blog_date}|" \
-e "s|BLOGURL|${blog_url}|" \
-e "s|INGRESS|${ingress}|"
> ${project_dir}/blog/index.tmp.x
done
fi
tee < ${pages} | sed \
-e "s|BODY|$(cat ${project_dir}/blog/index.tmp.x)|" \
-s "s|#pagetitle|${blog_index_title}|g" \
> ${www_root}/blog/index.html
_last_updated ${www_root}/blog/index.html
${engine} ${www_root}/blog/index.html
}
function _link() {
# This converts #link tags to actual clickable links in a provided string
2024-01-28 18:24:38 +01:00
local content="${1}"
local modified_content=""
2024-01-28 18:24:38 +01:00
local debug=false
# Process the content line by line
echo "${content}" | while IFS= read -r line; do
2024-01-28 18:24:38 +01:00
if [[ ${line} == *"#link"* ]]; then
if (${debug}) echo "${red}URL_MAIN(line): ${line}${end}"
2024-01-28 18:24:38 +01:00
# Extract the URL and the link text
local url_full=$(echo "${line}" | awk -F'#link ' '{print $2}' | awk -F'¤' '{print $1 "¤" $2}')
local url_dest=$(echo "${url_full}" | awk -F'¤' '{print $1}')
local url_txt=$(echo "${url_full}" | awk -F'¤' '{print $2}')
2024-01-28 18:24:38 +01:00
if (${debug}) echo "${red}URL: ${url_dest}${end}"
if (${debug}) echo "${red}Text: ${url_txt}${end}"
# Form the replacement HTML link
local modified_link="<a href=\"${url_dest}\">${url_txt}"
if [[ ${url_dest} =~ ^https?:// ]]; then
# Add external link icon for external URLs
modified_link+="<img class=\"exticon\" alt=\"External site icon\" src=\"/images/ext-url.png\" width=\"16\" />"
fi
modified_link+="</a>"
line=${line//"#link ${url_full}"/${modified_link}}
2024-01-28 18:24:38 +01:00
fi
modified_content+="${line}\n"
done
2024-01-28 18:24:38 +01:00
# Return the modified content
echo -e "${modified_content}"
2024-01-28 18:24:38 +01:00
}
function _image() {
# This replaces #showimg tags with actual HTML img tags in a provided string
2024-01-28 18:24:38 +01:00
local content="${1}"
local modified_content=""
local debug=false
# Process the content line by line
echo "${content}" | while IFS= read -r line; do
if [[ ${line} == *"#showimg"* ]]; then
if (${debug}) echo "${red}_image: Processing line: ${line}${end}"
# Extract image link and alt text
local img_link=$(echo "${line}" | awk -F'#showimg ' '{print $2}')
local image=$(echo "${img_link}" | awk -F'¤' '{print $1}')
local img_alt=$(echo "${img_link}" | awk -F'¤' '{print $2}')
# Determine the source of the image
local real_image=""
if [[ ${image} =~ ^https?:// ]]; then
real_image=${image}
elif [[ ${image} =~ ^\/ ]]; then
real_image=${image}
else
real_image="/images/${image}"
fi
# Form the replacement HTML image tag
local img_tag="<img src=\"${real_image}\" alt=\"${img_alt}\" width=\"500\" />"
line=${line//"#showimg ${img_link}"/${img_tag}}
fi
modified_content+="${line}\n"
done
# Return the modified content
echo -e "${modified_content}"
2024-01-28 18:24:38 +01:00
}
function _youtube() {
# This embeds a YouTube video in a provided string
2024-01-28 18:24:38 +01:00
local content="${1}"
local modified_content=""
local debug=false
# Process the content line by line
echo "${content}" | while IFS= read -r line; do
if [[ ${line} == *"#ytvideo"* ]]; then
if (${debug}) echo "${red}_youtube: Processing line: ${line}${end}"
# Extract YouTube video ID
local yt_id=$(echo "${line}" | awk -F'#ytvideo ' '{print $2}')
# Form the replacement YouTube iframe embed
local yt_iframe="<iframe width=\"560\" height=\"315\" src=\"https://www.youtube.com/embed/${yt_id}\" title=\"YouTube video player\" frameborder=\"0\" allow=\"accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share\" allowfullscreen></iframe>"
line=${line//"#ytvideo ${yt_id}"/${yt_iframe}}
fi
modified_content+="${line}\n"
done
2024-01-28 18:24:38 +01:00
# Return the modified content
echo -e "${modified_content}"
2024-01-28 18:24:38 +01:00
}
function _cleanup() {
# This removes tags used in the templates that may be left over for some reason
local content="${1}"
local debug=false
2024-01-28 18:24:38 +01:00
if (${debug}) echo "${red}_cleanup: Cleaning up tags in content${end}"
# Perform the cleanup
local cleaned_content=$(echo "${content}" | sed \
-e "s|¤||g" \
-e "s|#showimg\ ||g" \
-e "s|#ytvideo\ ||g" \
-e "s|#link\ ||g")
2024-01-28 18:24:38 +01:00
# Return the cleaned content
echo "${cleaned_content}"
2024-01-28 18:24:38 +01:00
}
function _html() {
# This converts the formatting tags into their HTML equivalents
2024-01-30 00:44:15 +01:00
local debug=false
2024-01-29 23:50:01 +01:00
if (${debug}) echo "${red}_html: Generating HTML${end}"
2024-01-28 18:24:38 +01:00
2024-01-29 23:14:33 +01:00
echo ${1} | sed \
2024-01-29 22:43:45 +01:00
-e "s|\#BR|<br/>\n|g" \
2024-01-29 22:41:03 +01:00
-e "s|\#BD|<b>|g" \
-e "s|\#EBD|</b>|g" \
-e "s|\#UN|<u>|g" \
-e "s|\#EUN|</u>\n|g" \
-e "s|\#P|<p>\n|g" \
-e "s|\#EP|</p>\n|g" \
-e "s|\#Q|<blockquote>|g" \
-e "s|\#EQ|</blockquote>|g" \
-e "s|\#STRONG|<strong>|g" \
-e "s|\#ESTRONG|</strong>|g" \
-e "s|\#I|<i>|g" \
-e "s|\#EI|</i>|g" \
-e "s|\#C|<code>\n|g" \
-e "s|\#EC|</code>\n|g" \
-e "s|\#EM|<em>|g" \
-e "s|\#SEM|</em>|g" \
-e "s|\#OT|\&quot;|g" \
-e "s|\#UL|\n<ul>\n|g" \
-e "s|\#OL|<ol>\n|g" \
-e "s|\#LI|<li class=\"libody\">|g" \
-e "s|\#ELI|</li>\n|g" \
-e "s|\#EUL|\n</ul>\n|g" \
-e "s|\#EOL|</ol>\n|g" \
-e "s|\#H1|<h1>|g" \
-e "s|\#H2|<h2>|g" \
-e "s|\#H3|<h3>|g" \
-e "s|\#H4|<h4>|g" \
-e "s|\#H5|<h5>|g" \
-e "s|\#H6|<h6>|g" \
-e "s|\#EH1|</h1>\n|g" \
-e "s|\#EH2|</h2>\n|g" \
-e "s|\#EH3|</h3>\n|g" \
-e "s|\#EH4|</h4>\n|g" \
-e "s|\#EH5|</h5>\n|g" \
-e "s|\#EH6|</h6>\n|g" \
-e "s|\#LT|\&lt;|g" \
-e "s|\#GT|\&gt;|g" \
2024-01-29 23:50:40 +01:00
-e "s|\#NUM|\&num;|g"
2024-01-28 18:24:38 +01:00
}
# Time to test the first function
echo "${green}Running function _blogs${end}"
_blogs
2024-01-29 21:54:20 +01:00
echo "${green}Running function _pages${end}"
_pages