#!/usr/bin/env bash # BashBlog, a simple blog system written in a single bash script # Copyright: Carlos Fenollosa , 2011-2014 # With contributions from many others: # https://github.com/carlesfe/bashblog/contributors ######################################################################################### # # README # ######################################################################################### # # This is a very basic blog system # # Basically it asks the user to create a text file, then converts it into a .html file # and then rebuilds the index.html and feed.rss. # # Comments are supported via external service (Disqus). # Markdown syntax is supported via third party library (e.g. Gruber's Markdown.pl) # # This script is standalone, it doesn't require any other file to run # # Files that this script generates: # - main.css (inherited from my web page) and blog.css (blog-specific stylesheet) # - one .html for each post # - one tag_*.html file for each tag # - index.html (regenerated each run) # - feed.rss (idem) # - all_posts.html (idem) # - all_tags.html (idem) # - it also generates temporal files, which are removed afterwards # # It generates valid html and rss files, so keep care to use valid xhtml when editing a post # # There are many loops which iterate on '*.html' so make sure not to manually put other # html files on this folder. # # Read more: https://github.com/cfenollosa/bashblog ######################################################################################### # # LICENSE # ######################################################################################### # # 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 . ######################################################################################### # # CHANGELOG # ######################################################################################### # # 2.1 Support for tags/categories # 'delete' command # 2.0.3 Support for other analytics code, via external file # 2.0.2 Fixed bug when $body_begin_file was empty # Added extra line in the footer linking to the github project # 2.0.1 Allow personalized header/footer files # 2.0 Added Markdown support # Fully support BSD date # 1.6.4 Fixed bug in localized dates # 1.6.3 Now supporting BSD date # 1.6.2 Simplified some functions and variables to avoid duplicated information # 1.6.1 'date' fix when hours are 1 digit. # 1.6.0 Disqus comments. External configuration file. Check of 'date' command version. # 1.5.1 Misc bugfixes and parameter checks # 1.5 Đurađ Radojičić (djura-san) refactored some code and added flexibility and i18n # 1.4.2 Now issues are handled at Github # 1.4.1 Some code refactoring # 1.4 Using twitter for comments, improved 'rebuild' command # 1.3 'edit' command # 1.2.2 Feedburner support # 1.2.1 Fixed the timestamps bug # 1.2 'list' command # 1.1 Draft and preview support # 1.0 Read http://is.gd/Bkdoru ######################################################################################### # # CODE # ######################################################################################### # # As usual with bash scripts, scroll all the way to the bottom for the main routine # All other functions are declared above main. # Global variables # It is recommended to perform a 'rebuild' after changing any of this in the code # Config file. Any settings "key=value" written there will override the # global_variables defaults. Useful to avoid editing bb.sh and having to deal # with merges in VCS global_config=".config" # This function will load all the variables defined here. They might be overriden # by the 'global_config' file contents global_variables() { global_software_name="BashBlog" global_software_version="2.1" # Blog title global_title="My fancy blog" # The typical subtitle for each blog global_description="A blog about turtles and carrots" # The public base URL for this blog global_url="http://example.com/blog" # Your name global_author="John Smith" # You can use twitter or facebook or anything for global_author_url global_author_url="http://twitter.com/example" # Your email global_email="john@smith.com" # CC by-nc-nd is a good starting point, you can change this to "©" for Copyright global_license="CC by-nc-nd" # If you have a Google Analytics ID (UA-XXXXX) and wish to use the standard # embedding code, put it on global_analytics # If you have custom analytics code (i.e. non-google) or want to use the Universal # code, leave global_analytics empty and specify a global_analytics_file global_analytics="" global_analytics_file="" # Leave this empty (i.e. "") if you don't want to use feedburner, # or change it to your own URL global_feedburner="" # Change this to your username if you want to use twitter for comments global_twitter_username="" # Change this to your disqus username to use disqus for comments global_disqus_username="" # Blog generated files # index page of blog (it is usually good to use "index.html" here) index_file="index.html" number_of_index_articles="8" # global archive archive_index="all_posts.html" tags_index="all_tags.html" # feed file (rss in this case) blog_feed="feed.rss" number_of_feed_articles="10" # "cut" blog entry when putting it to index page # i.e. include only up to first
(---- in markdown) # possible values: "cut", "" cut_do="cut" # Regexp matching the HTML line where to do the cut # note that slash is regexp separator so you need to prepend it with backslash cut_line='
' # prefix for tags/categories files # please make sure that no other html file starts with this prefix prefix_tags="tag_" # personalized header and footer (only if you know what you're doing) # DO NOT name them .header.html, .footer.html or they will be overwritten # leave blank to generate them, recommended header_file="" footer_file="" # extra content to add just after we open the tag # and before the actual blog content body_begin_file="" # CSS files to include on every page, f.ex. css_include=('main.css' 'blog.css') # leave empty to use generated css_include=() # Localization and i18n # "Comments?" (used in twitter link after every post) template_comments="Comments?" # "Read more..." (link under cut article on index page) template_read_more="Read more..." # "View more posts" (used on bottom of index page as link to archive) template_archive="View more posts" # "All posts" (title of archive page) template_archive_title="All posts" # "All tags" template_tags_title="All tags" # "posts" (on "All tags" page, text at the end of each tag line, like "2. Music - 15 posts") template_tags_posts="posts" # "Posts tagged" (text on a title of a page with index of one tag, like "My Blog - Posts tagged "Music"") template_tag_title="Posts tagged" # "Tags:" (beginning of line in HTML file with list of all tags for this article) template_tags_line_header="Tags:" # "Back to the index page" (used on archive page, it is link to blog index) template_archive_index_page="Back to the index page" # "Subscribe" (used on bottom of index page, it is link to RSS feed) template_subscribe="Subscribe" # "Subscribe to this page..." (used as text for browser feed button that is embedded to html) template_subscribe_browser_button="Subscribe to this page..." # "Tweet" (used as twitter text button for posting to twitter) template_twitter_button="Tweet" template_twitter_comment="<Type your comment here but please leave the URL so that other people can follow the comments>" # The locale to use for the dates displayed on screen (not for the timestamps) date_format="%B %d, %Y" date_locale="C" # Markdown location. Trying to autodetect by default. # The invocation must support the signature 'markdown_bin in.html > out.md' markdown_bin="$(which Markdown.pl)" } # Check for the validity of some variables # DO NOT EDIT THIS FUNCTION unless you know what you're doing global_variables_check() { [[ "$header_file" == ".header.html" ]] && echo "Please check your configuration. '.header.html' is not a valid value for the setting 'header_file'" && exit [[ "$footer_file" == ".footer.html" ]] && echo "Please check your configuration. '.footer.html' is not a valid value for the setting 'footer_file'" && exit } # Test if the markdown script is working correctly test_markdown() { [[ -z "$markdown_bin" ]] && return 1 [[ -z "$(which diff)" ]] && return 1 in="/tmp/md-in-$(echo $RANDOM).md" out="/tmp/md-out-$(echo $RANDOM).html" good="/tmp/md-good-$(echo $RANDOM).html" echo -e "line 1\n\nline 2" > $in echo -e "

line 1

\n\n

line 2

" > $good $markdown_bin $in > $out 2> /dev/null diff $good $out &> /dev/null # output is irrelevant, we'll check $? if [[ $? -ne 0 ]]; then rm -f $in $good $out return 1 fi rm -f $in $good $out return 0 } # Parse a Markdown file into HTML and return the generated file markdown() { out="$(echo $1 | sed 's/md$/html/g')" while [ -f "$out" ]; do out="$(echo $out | sed 's/\.html$/\.'$RANDOM'\.html')"; done $markdown_bin $1 > $out echo $out } # Prints the required google analytics code google_analytics() { [[ -z "$global_analytics" ]] && [[ -z "$global_analytics_file" ]] && return if [[ -z "$global_analytics_file" ]]; then echo "" else cat "$global_analytics_file" fi } # Prints the required code for disqus comments disqus_body() { [[ -z "$global_disqus_username" ]] && return echo '
comments powered by Disqus' } # Prints the required code for disqus in the footer disqus_footer() { [[ -z "$global_disqus_username" ]] && return echo '' } # Reads HTML file from stdin, prints its content to stdout # $1 where to start ("text" or "entry") # $2 where to stop ("text" or "entry") # $3 "cut" to remove text from
to # note that this does not remove
line itself, # so you can see if text was cut or not get_html_file_content() { awk '//, //{ if (!// && !//) print if ("'$3'" == "cut" && /'"$cut_line"'/){ if ("'$2'" == "text") exit # no need to read further while (getline > 0 && !//) {} } }' } # Edit an existing, published .html file while keeping its original timestamp # Please note that this function does not automatically republish anything, as # it is usually called from 'main'. # # Note that it edits HTML file, even if you wrote the post as markdown originally # Note that if you edit title then filename might also change # # $1 the file to edit # $2 (optional) edit mode: # "keep" to keep old filename # "full" to edit full HTML, and not only text part (keeps old filename) # leave empty for default behavior (edit only text part and change name) edit() { # Original post timestamp edit_timestamp="$(LC_ALL=$date_locale date -r $1 +"%a, %d %b %Y %H:%M:%S %z" )" touch_timestamp="$(LC_ALL=$date_locale date -r $1 +'%Y%m%d%H%M')" if [ "$2" = "full" ]; then $EDITOR "$1" filename="$1" else # Create the content file TMPFILE="$(basename $1).$RANDOM.html" # Title echo "$(get_post_title $1)" > "$TMPFILE" # Post text with plaintext tags get_html_file_content 'text' 'text' <$1 | sed "s|\\1|\\1|g" >> "$TMPFILE" rm $1 $EDITOR "$TMPFILE" parse_file "$TMPFILE" "$edit_timestamp" # this command sets $filename as the html processed file rm "$TMPFILE" if [ "$2" = "keep" ]; then mv $filename $1 filename="$1" fi fi touch -t "$touch_timestamp" "$filename" chmod 644 "$filename" echo "Posted $filename" } # Adds the code needed by the twitter button # # $1 the post URL twitter() { [[ -z "$global_twitter_username" ]] && return if [[ -z "$global_disqus_username" ]]; then echo "

$template_comments " else echo "

$template_comments  " fi echo "$template_twitter_button " echo "

" } # Check if the file is a 'boilerplate' (i.e. not a post) # The return values are designed to be used like this inside a loop: # is_boilerplate_file && continue # # $1 the file # # Return 0 (bash return value 'true') if the input file is am index, feed, etc # or 1 (bash return value 'false') if it is a blogpost is_boilerplate_file() { if [[ "$1" == "$index_file" ]] || [[ "$1" == "$archive_index" ]] || [[ "$1" == "$tags_index" ]] || [[ "$1" == "$footer_file" ]] || [[ "$1" == "$header_file" ]] || [[ "$1" == "$global_analytics_file" ]] || [[ "$1" = "$prefix_tags"* ]] ; then return 0 else return 1 fi } # Adds all the bells and whistles to format the html page # Every blog post is marked with a and # which is parsed afterwards in the other functions. There is also a marker # to determine just the beginning of the text body of the post # # $1 a file with the body of the content # $2 the output file # $3 "yes" if we want to generate the index.html, # "no" to insert new blog posts # $4 title for the html header # $5 original blog timestamp create_html_page() { content="$1" filename="$2" index="$3" title="$4" timestamp="$5" # Create the actual blog post # html, head cat ".header.html" > "$filename" echo "$title" >> "$filename" google_analytics >> "$filename" echo "" >> "$filename" # stuff to add before the actual body content [[ -n "$body_begin_file" ]] && cat "$body_begin_file" >> "$filename" # body divs echo '
' >> "$filename" echo '
' >> "$filename" # blog title echo '
' >> "$filename" cat .title.html >> "$filename" echo '
' >> "$filename" # title, header, headerholder echo '
' >> "$filename" file_url="$(sed 's/.rebuilt//g' <<< $filename)" # Get the correct URL when rebuilding # one blog entry if [[ "$index" == "no" ]]; then echo '' >> "$filename" # marks the beginning of the whole post echo '

' >> "$filename" # remove possible

's on the title because of markdown conversion echo "$(echo "$title" | sed 's/<\/*p>//g')" >> "$filename" echo '

' >> "$filename" if [[ "$timestamp" == "" ]]; then echo '
'$(LC_ALL=$date_locale date +"$date_format")' — ' >> "$filename" else echo '
'$(LC_ALL=$date_locale date +"$date_format" --date="$timestamp") ' — ' >> "$filename" fi echo "$global_author
" >> "$filename" echo '' >> "$filename" # This marks the text body, after the title, date... fi cat "$content" >> "$filename" # Actual content if [[ "$index" == "no" ]]; then echo '' >> "$filename" twitter "$global_url/$file_url" >> "$filename" echo '' >> "$filename" # absolute end of the post fi echo '
' >> "$filename" # content # Add disqus commments except for index and all_posts pages if [[ ${filename%.*.*} != "index" && ${filename%.*.*} != "all_posts" ]]; then disqus_body >> "$filename" fi # page footer cat .footer.html >> "$filename" # close divs echo '
' >> "$filename" # divbody and divbodyholder disqus_footer >> "$filename" echo '' >> "$filename" } # Parse the plain text file into an html file # # $1 file name # $2 (optional) timestamp for the file parse_file() { # Read for the title and check that the filename is ok title="" while IFS='' read line; do if [[ "$title" == "" ]]; then # set title and # remove extra

and

added by markdown title=$(echo "$line" | sed 's/<\/*p>//g') filename="$(echo $title | tr [:upper:] [:lower:])" filename="$(echo $filename | sed 's/\ /-/g')" filename="$(echo $filename | sed 'y/йцукенгшщзхъфывапролджэячсмитьбю/jcukengsszh-fyvaproldzeahsmit-by/')" filename="$(echo $filename | sed 'y/ЙЦУКЕНГШЩЗХЪФЫВАПРОЛДЖЭЯЧСМИТЬБЮ/jcukengsszh-fyvaproldzeahsmit-by/')" filename="$(echo $filename | tr -dc '[:alnum:]-')" # html likes alphanumeric filename="$(echo $filename | sed 's/^-*//')" # unix utilities are unhappy if filename starts with - [ "$filename" ] || filename=$RANDOM # if filename gets empty, put something in it filename="$filename.html" content="$filename.tmp" # Check for duplicate file names while [ -f "$filename" ]; do suffix="$RANDOM" filename="$(echo $filename | sed 's/\.html/'$suffix'\.html/g')" done # Parse possible tags elif [[ "$line" = "

$template_tags_line_header"* ]]; then tags="$(echo "$line" | cut -d ":" -f 2- | sed -e 's/<\/p>//g' -e 's/^ *//' -e 's/ *$//' -e 's/, /,/g')" IFS=, read -r -a array <<< "$tags" echo -n "

$template_tags_line_header " >> "$content" (for item in "${array[@]}"; do echo -n "$item, " done ) | sed 's/, $//g' >> "$content" echo -e "

" >> "$content" else echo "$line" >> "$content" fi done < "$1" # Create the actual html page create_html_page "$content" "$filename" no "$title" "$2" rm "$content" } # Manages the creation of the text file and the parsing to html file # also the drafts write_entry() { fmt="html"; f="$2" [[ "$2" == "-m" ]] && fmt="md" && f="$3" if [[ "$fmt" == "md" ]]; then test_markdown if [[ "$?" -ne 0 ]]; then echo "Markdown is not working, please use HTML. Press a key to continue..." fmt="html" read fi fi if [[ "$f" != "" ]]; then TMPFILE="$f" if [[ ! -f "$TMPFILE" ]]; then echo "The file doesn't exist" delete_includes exit fi # check if TMPFILE is markdown even though the user didn't specify it extension="${TMPFILE##*.}" [[ "$extension" == "md" ]] && fmt="md" else TMPFILE=".entry-$RANDOM.$fmt" echo -e "Title on this line\n" >> "$TMPFILE" [[ "$fmt" == "html" ]] && cat << EOF >> "$TMPFILE"

The rest of the text file is an html blog post. The process will continue as soon as you exit your editor.

$template_tags_line_header keep-this-tag-format, tags-are-optional, example

EOF [[ "$fmt" == "md" ]] && cat << EOF >> "$TMPFILE" The rest of the text file is a **Markdown** blog post. The process will continue as soon as you exit your editor. $template_tags_line_header keep-this-tag-format, tags-are-optional, beware-with-underscores-in-markdown, example EOF fi chmod 600 "$TMPFILE" post_status="E" while [ "$post_status" != "p" ] && [ "$post_status" != "P" ]; do $EDITOR "$TMPFILE" if [[ "$fmt" == "md" ]]; then html_from_md="$(markdown "$TMPFILE")" parse_file "$html_from_md" rm "$html_from_md" else parse_file "$TMPFILE" # this command sets $filename as the html processed file fi chmod 600 "$filename" echo -n "Preview? (Y/n) " read p if [[ "$p" != "n" ]] && [[ "$p" != "N" ]]; then chmod 644 "$filename" echo "Open $global_url/$filename in your browser" fi echo -n "[P]ost this entry, [E]dit again, [D]raft for later? (p/E/d) " read post_status if [[ "$post_status" == "d" ]] || [[ "$post_status" == "D" ]]; then mkdir -p "drafts/" chmod 700 "drafts/" title="$(head -n 1 $TMPFILE)" title="$(echo $title | tr [:upper:] [:lower:])" title="$(echo $title | sed 's/\ /-/g')" title="$(echo $title | tr -dc '[:alnum:]-')" draft="drafts/$title.$fmt" while [ -f "$draft" ]; do draft="drafts/$title-$RANDOM.$fmt"; done mv "$TMPFILE" "$draft" chmod 600 "$draft" rm "$filename" delete_includes echo "Saved your draft as '$draft'" exit fi if [[ "$post_status" == "e" ]] || [[ "$post_status" == "E" ]]; then rm "$filename" # Delete the html file as it will be generated again fi done rm "$TMPFILE" chmod 644 "$filename" echo "Posted $filename" } # Create an index page with all the posts all_posts() { echo -n "Creating an index page with all the posts " contentfile="$archive_index.$RANDOM" while [ -f "$contentfile" ]; do contentfile="$archive_index.$RANDOM" done echo "

$template_archive_title

" >> "$contentfile" echo "
    " >> "$contentfile" for i in $(ls -t *.html); do is_boilerplate_file "$i" && continue echo -n "." # Title title="$(get_post_title "$i")" echo -n '
  • '$title' —' >> "$contentfile" # Date date="$(LC_ALL=$date_locale date -r "$i" +"$date_format")" echo " $date
  • " >> "$contentfile" done echo "" echo "
" >> "$contentfile" echo '' >> "$contentfile" create_html_page "$contentfile" "$archive_index.tmp" yes "$global_title — All posts" mv "$archive_index.tmp" "$archive_index" chmod 644 "$archive_index" rm "$contentfile" } # Create an index page with all the tags all_tags() { echo -n "Creating an index page with all the tags " contentfile="$tags_index.$RANDOM" while [ -f "$contentfile" ]; do contentfile="$tags_index.$RANDOM" done echo "

$template_tags_title

" >> "$contentfile" echo "
    " >> "$contentfile" for i in $(ls $prefix_tags*.html); do echo -n "." nposts="$(grep -c "<\!-- text begin -->" $i)" tagname="$(echo $i | cut -c $((${#prefix_tags}+1))- | sed 's/\.html//g')" echo "
  • $tagname — $nposts $template_tags_posts
  • " >> "$contentfile" done echo "" echo "
" >> "$contentfile" echo '' >> "$contentfile" create_html_page "$contentfile" "$tags_index.tmp" yes "$global_title — $template_tags_title" mv "$tags_index.tmp" "$tags_index" chmod 644 "$tags_index" rm "$contentfile" } # Generate the index.html with the content of the latest posts rebuild_index() { echo -n "Rebuilding the index " newindexfile="$index_file.$RANDOM" contentfile="$newindexfile.content" while [ -f "$newindexfile" ]; do newindexfile="$index_file.$RANDOM" contentfile="$newindexfile.content" done # Create the content file n=0 for i in $(ls -t *.html); do # sort by date, newest first is_boilerplate_file "$i" && continue; if [[ "$n" -ge "$number_of_index_articles" ]]; then break; fi if [ "$cut_do" ]; then get_html_file_content 'entry' 'entry' 'cut' <$i | awk '/'"$cut_line"'/ { print "

'"$template_read_more"'

" ; next } 1' >> "$contentfile" else get_html_file_content 'entry' 'entry' <$i >> "$contentfile" fi echo -n "." n=$(( $n + 1 )) done feed="$blog_feed" if [[ "$global_feedburner" != "" ]]; then feed="$global_feedburner"; fi echo '' >> "$contentfile" echo "" create_html_page "$contentfile" "$newindexfile" yes "$global_title" rm "$contentfile" mv "$newindexfile" "$index_file" chmod 644 "$index_file" } # Rebuilds all tag_*.html files rebuild_tags() { echo -n "Rebuilding tag pages " n=0 rm $prefix_tags*.html &> /dev/null # First we will process all files and create temporal tag files # with just the content of the posts for i in $(ls -t *.html); do is_boilerplate_file "$i" && continue; echo -n "." tmpfile="$(mktemp tmp.XXX)" if [ "$cut_do" ]; then get_html_file_content 'entry' 'entry' 'cut' <$i | awk '/'"$cut_line"'/ { print "

'"$template_read_more"'

" ; next } 1' >> "$tmpfile" else get_html_file_content 'entry' 'entry' <$i >> "$tmpfile" fi while IFS='' read line; do if [[ "$line" = "

$template_tags_line_header"* ]]; then # 'split' tags by commas echo "$line" | cut -c 10- | while IFS="," read -a tags; do for dirty_tag in "${tags[@]}"; do # extract html around it tag="$(echo $dirty_tag | grep -o ">.*" | awk '{print substr($0, 2, length($0)-5)}' | tr " " "_")" # Add the content of this post to the tag file cat "$tmpfile" >> "$prefix_tags$tag".tmp.html done done fi done < "$i" rm "$tmpfile" done # Now generate the tag files with headers, footers, etc for i in $(ls -t $prefix_tags*.tmp.html); do tagname="$(echo $i | cut -c $((${#prefix_tags}+1))- | sed 's/\.tmp\.html//g')" create_html_page "$i" "$prefix_tags$tagname.html" yes "$global_title — $template_tag_title \"$tagname\"" rm "$i" done echo } # Return the post title # # $1 the html file get_post_title() { awk '/

/, /<\/a><\/h3>/{if (!/

/ && !/<\/a><\/h3>/) print}' "$1" } # Displays a list of the posts list_posts() { ls *.html &> /dev/null [[ $? -ne 0 ]] && echo "No posts yet. Use 'bb.sh post' to create one" && return lines="" n=1 for i in $(ls -t *.html); do is_boilerplate_file "$i" && continue line="$n # $(get_post_title "$i") # $(LC_ALL=$date_locale date -r $i +"$date_format")" lines="${lines}""$line""\n" # Weird stuff needed for the newlines n=$(( $n + 1 )) done echo -e "$lines" | column -t -s "#" } # Generate the feed file make_rss() { echo -n "Making RSS " rssfile="$blog_feed.$RANDOM" while [ -f "$rssfile" ]; do rssfile="$blog_feed.$RANDOM"; done echo '' >> "$rssfile" echo '' >> "$rssfile" echo ''$global_title''$global_url'' >> "$rssfile" echo ''$global_description'en' >> "$rssfile" echo ''$(date +"%a, %d %b %Y %H:%M:%S %z")'' >> "$rssfile" echo ''$(date +"%a, %d %b %Y %H:%M:%S %z")'' >> "$rssfile" echo '' >> "$rssfile" n=0 for i in $(ls -t *.html); do is_boilerplate_file "$i" && continue [[ "$n" -ge "$number_of_feed_articles" ]] && break # max 10 items echo -n "." echo '' >> "$rssfile" echo "$(get_post_title "$i")" >> "$rssfile" echo '> "$rssfile" echo "$(get_html_file_content 'text' 'entry' $cut_do <$i)" >> "$rssfile" echo "]]>$global_url/$i" >> "$rssfile" echo "$global_url/$i" >> "$rssfile" echo "$global_author" >> "$rssfile" echo ''$(date -r "$i" +"%a, %d %b %Y %H:%M:%S %z")'' >> "$rssfile" n=$(( $n + 1 )) done echo '' >> "$rssfile" echo "" mv "$rssfile" "$blog_feed" chmod 644 "$blog_feed" } # generate headers, footers, etc create_includes() { echo '

'$global_title'

' > ".title.html" echo '
'$global_description'
' >> ".title.html" if [[ -f "$header_file" ]]; then cp "$header_file" .header.html else echo '' > ".header.html" echo '' >> ".header.html" echo '' >> ".header.html" for css_file in ${css_include[*]}; do echo '' >> ".header.html" done if [[ "$global_feedburner" == "" ]]; then echo '' >> ".header.html" else echo '' >> ".header.html" fi fi if [[ -f "$footer_file" ]]; then cp "$footer_file" .footer.html else protected_mail="$(echo "$global_email" | sed 's/@/\@/g' | sed 's/\./\./g')" echo '' >> ".footer.html" fi } # Delete the temporarily generated include files delete_includes() { rm ".title.html" ".footer.html" ".header.html" } # Create the css file from scratch create_css() { # To avoid overwriting manual changes. However it is recommended that # this function is modified if the user changes the blog.css file [ $css_include ] && return || css_include=('main.css' 'blog.css') if [[ ! -f "blog.css" ]]; then # blog.css directives will be loaded after main.css and thus will prevail echo '#title{font-size: x-large;} a.ablack{color:black !important;} li{margin-bottom:8px;} ul,ol{margin-left:24px;margin-right:24px;} #all_posts{margin-top:24px;text-align:center;} .subtitle{font-size:small;margin:12px 0px;} .content p{margin-left:24px;margin-right:24px;} h1{margin-bottom:12px !important;} #description{font-size:large;margin-bottom:12px;} h3{margin-top:42px;margin-bottom:8px;} h4{margin-left:24px;margin-right:24px;} #twitter{line-height:20px;vertical-align:top;text-align:right;font-style:italic;color:#333;margin-top:24px;font-size:14px;}' > blog.css fi # If there is a style.css from the parent page (i.e. some landing page) # then use it. This directive is here for compatibility with my own # home page. Feel free to edit it out, though it doesn't hurt if [[ -f "../style.css" ]] && [[ ! -f "main.css" ]]; then ln -s "../style.css" "main.css" elif [[ ! -f "main.css" ]]; then echo 'body{font-family:Georgia,"Times New Roman",Times,serif;margin:0;padding:0;background-color:#F3F3F3;} #divbodyholder{padding:5px;background-color:#DDD;width:874px;margin:24px auto;} #divbody{width:776px;border:solid 1px #ccc;background-color:#fff;padding:0px 48px 24px 48px;top:0;} .headerholder{background-color:#f9f9f9;border-top:solid 1px #ccc;border-left:solid 1px #ccc;border-right:solid 1px #ccc;} .header{width:800px;margin:0px auto;padding-top:24px;padding-bottom:8px;} .content{margin-bottom:45px;} .nomargin{margin:0;} .description{margin-top:10px;border-top:solid 1px #666;padding:10px 0;} h3{font-size:20pt;width:100%;font-weight:bold;margin-top:32px;margin-bottom:0;} .clear{clear:both;} #footer{padding-top:10px;border-top:solid 1px #666;color:#333333;text-align:center;font-size:small;font-family:"Courier New","Courier",monospace;} a{text-decoration:none;color:#003366 !important;} a:visited{text-decoration:none;color:#336699 !important;} blockquote{background-color:#f9f9f9;border-left:solid 4px #e9e9e9;margin-left:12px;padding:12px 12px 12px 24px;} blockquote img{margin:12px 0px;} blockquote iframe{margin:12px 0px;}' > main.css fi } # Regenerates all the single post entries, keeping the post content but modifying # the title, html structure, etc rebuild_all_entries() { echo -n "Rebuilding all entries " for i in *.html; do # no need to sort is_boilerplate_file "$i" && continue; contentfile=".tmp.$RANDOM" while [ -f "$contentfile" ]; do contentfile=".tmp.$RANDOM"; done echo -n "." # Get the title and entry, and rebuild the html structure from scratch (divs, title, description...) title="$(get_post_title "$i")" get_html_file_content 'text' 'text' <$i >> "$contentfile" # Original post timestamp timestamp="$(LC_ALL=$date_locale date -r $i +"%a, %d %b %Y %H:%M:%S %z" )" create_html_page "$contentfile" "$i.rebuilt" no "$title" "$timestamp" # keep the original timestamp! timestamp="$(LC_ALL=$date_locale date -r $i +'%Y%m%d%H%M')" mv "$i.rebuilt" "$i" chmod 644 "$i" touch -t $timestamp "$i" rm "$contentfile" done echo "" } # Displays the help function usage() { echo "$global_software_name v$global_software_version" echo "Usage: $0 command [filename]" echo "" echo "Commands:" echo " post [-m] [filename] insert a new blog post, or the filename of a draft to continue editing it" echo " use '-m' to edit the post as Markdown text" echo " edit [-n|-f] [filename] edit an already published .html file. **NEVER** edit manually a published .html file," echo " always use this function as it keeps internal data and rebuilds the blog" echo " use '-n' to give the file a new name, if title was changed" echo " use '-f' to edit full html file, instead of just text part (also preserves name)" echo " delete [filename] deletes the post and rebuilds the blog" echo " rebuild regenerates all the pages and posts, preserving the content of the entries" echo " reset deletes everything except this script. Use with a lot of caution and back up first!" echo " list list all posts" echo "" echo "For more information please open $0 in a code editor and read the header and comments" } # Delete all generated content, leaving only this script reset() { echo "Are you sure you want to delete all blog entries? Please write \"Yes, I am!\" " read line if [[ "$line" == "Yes, I am!" ]]; then rm .*.html *.html *.css *.rss &> /dev/null echo echo "Deleted all posts, stylesheets and feeds." echo "Kept your old '.backup.tar.gz' just in case, please delete it manually if needed." else echo "Phew! You dodged a bullet there. Nothing was modified." fi } # Detects if GNU date is installed date_version_detect() { date --version >/dev/null 2>&1 if [[ $? -ne 0 ]]; then # date utility is BSD. Test if gdate is installed if gdate --version >/dev/null 2>&1 ; then date() { gdate "$@" } else # BSD date date() { if [[ "$1" == "-r" ]]; then # Fall back to using stat for 'date -r' format=$(echo $3 | sed 's/\+//g') stat -f "%Sm" -t "$format" "$2" elif [[ $(echo $@ | grep '\-\-date') ]]; then # convert between dates using BSD date syntax /bin/date -j -f "%a, %d %b %Y %H:%M:%S %z" "$(echo $2 | sed 's/\-\-date\=//g')" "$1" else # acceptable format for BSD date /bin/date -j "$@" fi } fi fi } # Main function # Encapsulated on its own function for readability purposes # # $1 command to run # $2 file name of a draft to continue editing (optional) do_main() { # Detect if using BSD date or GNU date date_version_detect # Load default configuration, then override settings with the config file global_variables [[ -f "$global_config" ]] && source "$global_config" &> /dev/null global_variables_check # Check for $EDITOR [[ -z "$EDITOR" ]] && echo "Please set your \$EDITOR environment variable" && exit # Check for validity of argument [[ "$1" != "reset" ]] && [[ "$1" != "post" ]] && [[ "$1" != "rebuild" ]] && [[ "$1" != "list" ]] && [[ "$1" != "edit" ]] && [[ "$1" != "delete" ]] && usage && exit [[ "$1" == "list" ]] && list_posts && exit if [[ "$1" == "edit" ]]; then if [[ $# -lt 2 ]] || [[ ! -f "${!#}" ]]; then echo "Please enter a valid html file to edit" exit fi fi # Test for existing html files ls *.html &> /dev/null [[ $? -ne 0 ]] && [[ "$1" == "rebuild" ]] && echo "Can't find any html files, nothing to rebuild" && exit # We're going to back up just in case ls *.html &> /dev/null [[ $? -eq 0 ]] && tar cfz ".backup.tar.gz" *.html && chmod 600 ".backup.tar.gz" # Keep first backup of this day containing yesterday's version of the blog [ "$(date -r .yesterday.tar.gz +'%d')" != "$(date +'%d')" ] && cp .backup.tar.gz .yesterday.tar.gz &> /dev/null [[ "$1" == "reset" ]] && reset && exit create_css create_includes [[ "$1" == "post" ]] && write_entry "$@" [[ "$1" == "rebuild" ]] && rebuild_all_entries [[ "$1" == "delete" ]] && rm "$2" &> /dev/null if [[ "$1" == "edit" ]]; then if [[ "$2" == "-n" ]]; then edit "$3" elif [[ "$2" == "-f" ]]; then edit "$3" full else edit "$2" keep fi fi rebuild_index all_posts rebuild_tags all_tags make_rss delete_includes } # # MAIN # Do not change anything here. If you want to modify the code, edit do_main() # do_main $* # vim: set shiftwidth=4 tabstop=4 expandtab: