File: create_plugin.sh

package info (click to toggle)
syslog-ng 4.8.1-6
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 20,456 kB
  • sloc: ansic: 177,631; python: 13,035; cpp: 11,611; makefile: 7,012; sh: 5,147; java: 3,651; xml: 3,344; yacc: 1,377; lex: 599; perl: 193; awk: 190; objc: 162
file content (129 lines) | stat: -rwxr-xr-x 4,000 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
#!/bin/bash
#############################################################################
# Copyright (c) 2016 Balabit
#
# This program is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License version 2 as published
# by the Free Software Foundation, 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, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
#
# As an additional exemption you are allowed to compile & link against the
# OpenSSL libraries as published by the OpenSSL project. See the file
# COPYING for details.
#
#############################################################################

top_srcdir="$(git rev-parse --show-toplevel)"
current_year="$(date +%Y)"
git_user_name="$(git config --get user.name)"
year_and_author="$current_year $git_user_name"

function print_help {
  echo "This script helps to create new plugin by creating a skeleton"
  echo "Parameters:"
  echo -e "\t-n\tName of the plugin (required)"
  echo -e "\t-k\tThe keyword in config file (default: name of the plugin)"
  echo -e "\t-t\tType of the plugin (default: LL_CONTEXT_DESTINATION)"
  echo -e "\t-d\tPlugin root dir (default: ${top_srcdir}/modules)"
  echo -e "\t-h\tPrint this help message"
}


plugin_name=''
plugin_key=''
plugin_type=LL_CONTEXT_DESTINATION
plugin_root="${top_srcdir}/modules"
template_dir="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"

help=0
file_list="plugin_template_grammar.ym
           plugin_template_Makefile.am
           plugin_template_CMakeLists.txt
           plugin_template_parser.c
           plugin_template_parser.h
           plugin_template_plugin.c"

while getopts "k:n:t:d:h" opt; do
  case ${opt} in
    h)
      help=1
      ;;
    n)
      plugin_name="${OPTARG}"
      ;;
    t)
      plugin_type="${OPTARG}"
      ;;
    k)
      plugin_key="${OPTARG}"
      ;;
    d)
      plugin_root="${OPTARG}"
      ;;
  esac
done

if test "${help}" -gt 0; then
  print_help
  exit 0
fi

if [ -z "${plugin_name}" ]; then
  echo "Please set the plugin name"
  print_help
  exit 1
fi

plugin_dir=${plugin_root}/${plugin_name}

if ! [ -d "${plugin_root}" ]; then
  echo "Plugin root directory does not exists: ${plugin_root}"
  echo "Please set with -d parameter"
  print_help
  exit 1
fi

if [ -d "${plugin_dir}" ]; then
  echo "Plugin already exists: ${plugin_dir}"
  exit 1
fi

if [ -z "${plugin_key}" ]; then
  plugin_key=${plugin_name}
fi

echo "plugin name = ${plugin_name}"
echo "plugin type = ${plugin_type}"
echo "plugin key = ${plugin_key}"


mkdir "${plugin_dir}"

for filename in ${file_list}; do
  plugin_name_under_score=$(echo "${plugin_name}" | sed "s/-/_/g")
  plugin_name_under_score_uppercase="${plugin_name_under_score^^}"
  if [ "${filename}" == "plugin_template_Makefile.am" ]; then
    dst_filename="Makefile.am"
  elif [ "${filename}" == "plugin_template_CMakeLists.txt" ]; then
    dst_filename="CMakeLists.txt"
  else
      dst_filename=$(echo ${filename} | sed "s/plugin_template_/${plugin_name}-/g")
  fi
  dst_filename="${plugin_dir}"/"${dst_filename}"
  cp "${template_dir}/${filename}" "${dst_filename}"
  sed -i "s/@PLUGIN_NAME@/${plugin_name}/g" "${dst_filename}"
  sed -i "s/@PLUGIN_NAME_US@/${plugin_name_under_score}/g" "${dst_filename}"
  sed -i "s/@PLUGIN_NAME_USUC@/${plugin_name_under_score_uppercase}/g" "${dst_filename}"
  sed -i "s/@PLUGIN_TYPE@/${plugin_type}/g" "${dst_filename}"
  sed -i "s/@PLUGIN_KEY@/${plugin_key}/g" "${dst_filename}"
  sed -i "s/@YEAR_AND_AUTHOR@/${year_and_author}/g" "${dst_filename}"
done
echo "Done: new plugin skeleton is created in ${plugin_dir}"