#!/bin/bash
-# Copyright (C) 2016 Ian Kelling
+# I, Ian Kelling, follow the GNU license recommendations at
+# https://www.gnu.org/licenses/license-recommendations.en.html. They
+# recommend that small programs, < 300 lines, be licensed under the
+# Apache License 2.0. This file contains or is part of one or more small
+# programs. If a small program grows beyond 300 lines, I plan to switch
+# its license to GPL.
+
+# Copyright 2024 Ian Kelling
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# limitations under the License.
cedit() {
- local help="Usage: [-h|--help ] [-v] [SECTION_NAME] FILE
-Create/modify a section in a config file
+ local help="Usage: [-h|--help ] [-v] [SECTION_NAME] FILE
+Create/modify a comment-delimited section in a config file
+
+Returns 1 if the file is modified by this command, 2 or higher
+for other problems.
The section is #comment delimited. Reads STDIN for the contents of the
section. Without SECTION_NAME, it acts on a global unnamed
section. cedit is short for config edit.
+-b Keep backup file
+-e Exit 0 on modified file.
+-s Silent. Quiet and exit 0 on modified file.
+-q Quiet
-v Verbose
-h|--help Help"
- local s diff name init
- local file_dir="$(dirname "$file")"
- local exists=true
- local verbose=false
-
- case $1 in
- -h|--help) echo "$help"; return ;;
- esac
-
- if [[ $1 == -v ]]; then
- verbose=true
- shift
- fi
- if (( $# == 2 )); then
- name=": $1"
- shift
- fi
-
- local file="$1"
- local file_name="${file##*/}"
-
- local begin="#_#_# start delimiter of cedit section$name. do not modify. #_#_#"
- local end="#_#_# end delimiter of cedit section$name. do not modify. #_#_#"
-
- if [[ ! -e $file_dir ]]; then
- if ! mkdir -p $file_dir; then
- s=sudo
- $s mkdir -p $file_dir || return 1
- fi
+ local s diff name init file_dir exists verbose backup quiet silent
+ file_dir="$(dirname "$file")"
+ exists=true
+ verbose=false
+ backup=false
+ quiet=false
+ silent=false
+ exit_status=true
+
+ case $1 in
+ -b) backup=true; shift ;;
+ -e) exit_status=false; shift ;;
+ -s) quiet=true; silent=true; exit_status=false; shift ;;
+ -q) quiet=true; shift ;;
+ -v) verbose=true; shift ;;
+ -h|--help) echo "$help"; return ;;
+ esac
+
+ if (( $# == 2 )); then
+ name=": $1"
+ shift
+ fi
+
+ local file="$1"
+ local file_name="${file##*/}"
+
+ local comment
+ comment="#_#_#"
+
+ # bind zone files use ; for comments yes, a little hacky detection.
+ if [[ $file_name == db.* ]]; then
+ comment=";;_;_;"
+ fi
+ local begin="$comment start delimiter of cedit section$name. do not modify. $comment"
+ local end="$comment end delimiter of cedit section$name. do not modify. $comment"
+
+ if [[ ! -e $file_dir ]]; then
+ if ! mkdir -p $file_dir; then
+ s=sudo
+ $s mkdir -p $file_dir || return 2
fi
- if [[ ! -e $file ]]; then
- exists=false
- if ! $s touch $file; then
- s=sudo
- $s touch $file || return 1
- fi
+ fi
+ if [[ ! -e $file ]]; then
+ exists=false
+ if ! $s touch $file; then
+ s=sudo
+ $s touch $file || return 2
fi
-
- [[ -w $file ]] || s=sudo
-
-
- if $exists; then
- local temp="$(mktemp -d)/$file_name"
- cp "$file" "$temp"
- cp /dev/null "$file"
- local in_section=false
- while IFS= read -r line; do
- if [[ $line == $begin ]]; then
- in_section=true;
- fi
- if ! $in_section; then
- printf '%s\n' "$line" >> $file
- fi
- if [[ $line == $end ]]; then
- in_section=false;
- fi
- done < "$temp"
+ fi
+
+ [[ -w $file ]] || s=sudo
+
+
+ local in_section=false
+ if $exists; then
+ local tailn=1
+ local temp="$(mktemp -d)/$file_name"
+ cp "$file" "$temp"
+ cp /dev/null "$file"
+ while IFS= read -r line; do
+ tailn=$(( tailn + 1 ))
+ if [[ $line == "$begin" ]]; then
+ in_section=true;
+ break
+ fi
+ printf '%s\n' "$line" >> $file
+ done < "$temp"
+ fi
+
+ IFS= read -d '' -n 1 -r init
+ if [[ $init ]]; then
+ $s tee -a "$file" >/dev/null <<<"$begin"
+ printf '%s' "$init" | $s tee -a "$file" >/dev/null
+ $s tee -a "$file" >/dev/null
+ $s tee -a "$file" >/dev/null <<<"$end"
+ fi
+
+ if $exists && $in_section; then
+ while IFS= read -r line; do
+ if [[ $line == "$begin" ]]; then
+ in_section=true;
+ fi
+ if ! $in_section; then
+ printf '%s\n' "$line" >> $file
+ fi
+ if [[ $line == $end ]]; then
+ in_section=false;
+ fi
+ done < <(tail -n +$tailn "$temp")
+ fi
+
+
+ if ! $exists; then
+ ret=1
+ if $verbose; then
+ echo "New file $file:"
+ cat "$file"
fi
-
- IFS= read -d '' -n 1 -r init
- if [[ $init ]]; then
- $s tee -a "$file" >/dev/null <<<"$begin"
- printf '%s' "$init" | $s tee -a "$file" >/dev/null
- $s tee -a "$file" >/dev/null
- $s tee -a "$file" >/dev/null <<<"$end"
+ elif type -t diff &>/dev/null; then
+ diff=$(diff -u "$temp" "$file")
+ ret=$?
+ if (( $ret )) && ! $quiet; then
+ echo "backup of original at $temp"
+ echo diff -u "$temp" "$file":
+ echo "$diff"
+ #elif $debug; then
+ # echo "No changes made to $file"
fi
-
- if ! $exists; then
- ret=0
- if $verbose; then
- echo "New file $file:"
- cat "$file"
- fi
- elif type -t diff &>/dev/null; then
- diff=$(diff -u "$temp" "$file")
- ret=$?
- if $verbose; then
- if (( $ret == 0 )); then
- echo "No changes made to $file"
- fi
- else
-
- echo "backup of original at $temp"
- echo diff -u "$temp" "$file":
- echo "$diff"
- fi
- else
- diff=$(cmp "$temp" "$file")
- ret=$?
- if $verbose; then
- echo "$diff"
- fi
+ else
+ # for systems like openwrt which don't have diff
+ diff=$(cmp "$temp" "$file")
+ ret=$?
+ if $verbose; then
+ echo "$diff"
fi
+ fi
+ if ! $backup && $exists; then
+ rm -r "$temp"
+ fi
+ if ! $exit_status; then
+ case $ret in
+ 0|1) return 0 ;;
+ *) return $ret ;;
+ esac
+ else
return $ret
+ fi
}
cedit "$@"