├── _config.yml ├── shared ├── .qpkg_icon.gif ├── .qpkg_icon_gray.gif └── runlast.sh ├── images ├── RunLast.readme.png └── runlast.original.jpg ├── .editorconfig ├── check.sh ├── qpkg.cfg ├── README.md ├── changelog.txt ├── package_routines └── LICENSE /_config.yml: -------------------------------------------------------------------------------- 1 | theme: jekyll-theme-modernist -------------------------------------------------------------------------------- /shared/.qpkg_icon.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OneCDOnly/RunLast/HEAD/shared/.qpkg_icon.gif -------------------------------------------------------------------------------- /images/RunLast.readme.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OneCDOnly/RunLast/HEAD/images/RunLast.readme.png -------------------------------------------------------------------------------- /images/runlast.original.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OneCDOnly/RunLast/HEAD/images/runlast.original.jpg -------------------------------------------------------------------------------- /shared/.qpkg_icon_gray.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OneCDOnly/RunLast/HEAD/shared/.qpkg_icon_gray.gif -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | end_of_line = lf 5 | insert_final_newline = true 6 | 7 | [*.sh] 8 | charset = utf-8 9 | indent_style = tab 10 | indent_size = 4 11 | -------------------------------------------------------------------------------- /check.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | echo -n "checking ... " 4 | 5 | shellcheck --shell=bash --exclude=1003,1090,1117,2012,2016,2018,2019,2021,2086,2119,2120,2155,2181,2206,2207 ./shared/runlast.sh && echo 'passed!' || echo 'failed!' 6 | -------------------------------------------------------------------------------- /qpkg.cfg: -------------------------------------------------------------------------------- 1 | QPKG_NAME="RunLast" 2 | QPKG_VER="250927" 3 | QPKG_AUTHOR="OneCD" 4 | QPKG_RC_NUM="999" 5 | QPKG_SERVICE_PROGRAM="runlast.sh" 6 | QTS_MINI_VERSION="4.0.0" 7 | QPKG_WEBUI="/RunLast.log" 8 | QPKG_DISPLAY_NAME="RunLast (CLI)" 9 | QPKG_LICENSE="GPLV3" 10 | 11 | # Optional. 1 means to open the QPKG's Web UI on QTS desktop. 12 | QPKG_DESKTOP_APP="1" 13 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ![icon](images/RunLast.readme.png) 2 | 3 | ## Description 4 | 5 | **RunLast** creates an environment to run commands or shell-scripts after QPKG re-integration during QTS NAS bootup. 6 | 7 | This allows you to run scripts dependent on QPKGs during QTS startup. 8 | 9 | The aim of this project is to support **all** QNAP NAS models and **all** QTS & QuTS hero versions from v4.0.0 onwards. Please advise if you encounter any errors when running it on your NAS. 10 | 11 | ## What it does 12 | 13 | This package creates two scripts directories in the package installation path: 14 | - `init.d` 15 | - `scripts` 16 | 17 | Place your SysV-style scripts in the `init.d` directory. These will be executed with a `start` parameter after NAS startup, and with a `stop` parameter before NAS shutdown. 18 | Scripts in the `scripts` directory will be executed only during startup, and always after the custom `init.d` start script execution. 19 | 20 | ## Installation 21 | 22 | - available in the [MyQNAP repo](https://www.myqnap.org/product/runlast), and can also be installed via the [sherpa](https://github.com/OneCDOnly/sherpa) package manager. 23 | 24 | 25 | ## Notes 26 | 27 | - When this package is installed, there's not much to see. Find the package icon and click the 'Open' button to display the current log file - any stdout and stderr from your scripts will be shown here. 28 | 29 | - The log file is viewable via your web browser but is not a real web document, so it can change without your browser noticing. Whenever viewing the log, ensure you force a page refresh: CTRL+F5. 30 | 31 | - To jump to the `scripts` directory: 32 | 33 | ``` 34 | cd $(getcfg RunLast Scripts_Path -f /etc/config/qpkg.conf) 35 | ``` 36 | 37 | - Or, to jump to the `init.d` directory: 38 | 39 | ``` 40 | cd $(getcfg RunLast SysV_Path -f /etc/config/qpkg.conf) 41 | ``` 42 | 43 | - The source for this project can be found on [GitHub](https://onecdonly.github.io/RunLast/). 44 | 45 | - [Changelog](changelog.txt) 46 | -------------------------------------------------------------------------------- /changelog.txt: -------------------------------------------------------------------------------- 1 | * Minor update: (250927) 2 | - code: update post-install func to include action and result. 3 | 4 | * Minor update: (250712) 5 | - code: include startup process timeout, improve log format, make log this-session-only, add arg to show log. 6 | 7 | * Minor update: (250708) 8 | - code: optimise whitespace bytes. 9 | 10 | * Minor update: (250707) 11 | - add support for QTS 5.2.0-and-later. 12 | - package: remove max version. 13 | - code: general refresh. 14 | 15 | * Minor update: (241204) 16 | - package: set QTS 5.1.9 as max version. 17 | 18 | * Minor update: (240922) 19 | - package: set QTS 5.1.8 as max version. 20 | 21 | * Minor update: (240731) 22 | - update compatibility with sherpa package manager. 23 | - code: refresh. 24 | 25 | * Minor update: (230224) 26 | - update package icon. 27 | 28 | * Minor update: (230131) 29 | - add support for 'restart' init action. 30 | 31 | * Minor update: (230112) 32 | - Update ref to myqnap.org 33 | 34 | * Minor update: (220809) 35 | - Include service script operation status logging. 36 | 37 | * Minor update: (220426) 38 | - Use better keynames for scripts and sysv paths. 39 | 40 | * Minor update: (220425) 41 | - Add Scripts and SysV paths to qpkg.conf for easier access. 42 | 43 | * Minor update: (210809) 44 | - Ensure SortMyQPKGs version check works correctly with alpha characters after the datecode. 45 | - Remove max QTS version. 46 | 47 | * Minor update: (210328) 48 | - Open runtime log in a new QTS window instead of a new page. 49 | 50 | * Minor update: (201225) 51 | - use '--clean' instead of '--cancel' with App Center notifier (thanks @pedropombeiro for finding this!) 52 | 53 | * Minor update: (201223) 54 | - ensure service script always exits with zero (thank you @pedropombeiro for identifying this!) 55 | 56 | * Minor update: (201220) 57 | - don't run 'stop' operations when upgrading package (fixed). 58 | - use better rendering for base package icon. 59 | 60 | * Minor update: (201215) 61 | - don't run 'stop' operations when upgrading package. 62 | - ensure QTS 4.5.1 correctly enables package icon in App Center. 63 | 64 | * Minor update: (201119) 65 | - ensure symlink to /dev/fd is created so stderr can be captured separately from stdout. 66 | 67 | * Minor update: (201106) 68 | - a few wording and formatting changes for accuracy, and to keep ShellCheck happy. 69 | - include a link to logfile in [/var/log/] 70 | 71 | * Minor update: (201104) 72 | - downgrade logged warning when sorting QPKG order, 73 | - include 'start' and 'stop' operations in logs. 74 | 75 | * Minor update: (201101) 76 | - improve log format. 77 | 78 | * Minor update: (201029) 79 | - add support for SysV-style init scripts. Thank you @mickroll for this great suggestion! 80 | 81 | * Minor update: (190106) 82 | - tidy-up a few logged and interactive display messages. 83 | 84 | * Initial release: (190101) 85 | - first public script release. 86 | -------------------------------------------------------------------------------- /package_routines: -------------------------------------------------------------------------------- 1 | ###################################################################### 2 | # List of available definitions (it's not necessary to uncomment them) 3 | ###################################################################### 4 | ###### Command definitions ##### 5 | #CMD_AWK="/bin/awk" 6 | #CMD_CAT="/bin/cat" 7 | #CMD_CHMOD="/bin/chmod" 8 | #CMD_CHOWN="/bin/chown" 9 | #CMD_CP="/bin/cp" 10 | #CMD_CUT="/bin/cut" 11 | #CMD_DATE="/bin/date" 12 | #CMD_ECHO="/bin/echo" 13 | #CMD_EXPR="/usr/bin/expr" 14 | #CMD_FIND="/usr/bin/find" 15 | #CMD_GETCFG="/sbin/getcfg" 16 | #CMD_GREP="/bin/grep" 17 | #CMD_GZIP="/bin/gzip" 18 | #CMD_HOSTNAME="/bin/hostname" 19 | #CMD_LN="/bin/ln" 20 | #CMD_LOG_TOOL="/sbin/log_tool" 21 | #CMD_MD5SUM="/bin/md5sum" 22 | #CMD_MKDIR="/bin/mkdir" 23 | #CMD_MV="/bin/mv" 24 | #CMD_RM="/bin/rm" 25 | #CMD_RMDIR="/bin/rmdir" 26 | #CMD_SED="/bin/sed" 27 | #CMD_SETCFG="/sbin/setcfg" 28 | #CMD_SLEEP="/bin/sleep" 29 | #CMD_SORT="/usr/bin/sort" 30 | #CMD_SYNC="/bin/sync" 31 | #CMD_TAR="/bin/tar" 32 | #CMD_TOUCH="/bin/touch" 33 | #CMD_WGET="/usr/bin/wget" 34 | #CMD_WLOG="/sbin/write_log" 35 | #CMD_XARGS="/usr/bin/xargs" 36 | #CMD_7Z="/usr/local/sbin/7z" 37 | # 38 | ###### System definitions ##### 39 | #SYS_EXTRACT_DIR="$(pwd)" 40 | #SYS_CONFIG_DIR="/etc/config" 41 | #SYS_INIT_DIR="/etc/init.d" 42 | #SYS_STARTUP_DIR="/etc/rcS.d" 43 | #SYS_SHUTDOWN_DIR="/etc/rcK.d" 44 | #SYS_RSS_IMG_DIR="/home/httpd/RSS/images" 45 | #SYS_QPKG_DATA_FILE_GZIP="./data.tar.gz" 46 | #SYS_QPKG_DATA_FILE_BZIP2="./data.tar.bz2" 47 | #SYS_QPKG_DATA_FILE_7ZIP="./data.tar.7z" 48 | #SYS_QPKG_DATA_CONFIG_FILE="./conf.tar.gz" 49 | #SYS_QPKG_DATA_MD5SUM_FILE="./md5sum" 50 | #SYS_QPKG_DATA_PACKAGES_FILE="./Packages.gz" 51 | #SYS_QPKG_CONFIG_FILE="$SYS_CONFIG_DIR/qpkg.conf" 52 | #SYS_QPKG_CONF_FIELD_QPKGFILE="QPKG_File" 53 | #SYS_QPKG_CONF_FIELD_NAME="Name" 54 | #SYS_QPKG_CONF_FIELD_VERSION="Version" 55 | #SYS_QPKG_CONF_FIELD_ENABLE="Enable" 56 | #SYS_QPKG_CONF_FIELD_DATE="Date" 57 | #SYS_QPKG_CONF_FIELD_SHELL="Shell" 58 | #SYS_QPKG_CONF_FIELD_INSTALL_PATH="Install_Path" 59 | #SYS_QPKG_CONF_FIELD_CONFIG_PATH="Config_Path" 60 | #SYS_QPKG_CONF_FIELD_WEBUI="WebUI" 61 | #SYS_QPKG_CONF_FIELD_WEBPORT="Web_Port" 62 | #SYS_QPKG_CONF_FIELD_SERVICEPORT="Service_Port" 63 | #SYS_QPKG_CONF_FIELD_SERVICE_PIDFILE="Pid_File" 64 | #SYS_QPKG_CONF_FIELD_AUTHOR="Author" 65 | #SYS_QPKG_CONF_FIELD_RC_NUMBER="RC_Number" 66 | ## The following variables are assigned values at run-time. 67 | #SYS_HOSTNAME=$($CMD_HOSTNAME) 68 | ## Data file name (one of SYS_QPKG_DATA_FILE_GZIP, SYS_QPKG_DATA_FILE_BZIP2, 69 | ## or SYS_QPKG_DATA_FILE_7ZIP) 70 | #SYS_QPKG_DATA_FILE= 71 | ## Base location. 72 | #SYS_QPKG_BASE="" 73 | ## Base location of QPKG installed packages. 74 | #SYS_QPKG_INSTALL_PATH="" 75 | ## Location of installed software. 76 | #SYS_QPKG_DIR="" 77 | ## If the QPKG should be enabled or disabled after the installation/upgrade. 78 | #SYS_QPKG_SERVICE_ENABLED="" 79 | ## Architecture of the device the QPKG is installed on. 80 | #SYS_CPU_ARCH="" 81 | ## Name and location of system shares 82 | #SYS_PUBLIC_SHARE="" 83 | #SYS_PUBLIC_PATH="" 84 | #SYS_DOWNLOAD_SHARE="" 85 | #SYS_DOWNLOAD_PATH="" 86 | #SYS_MULTIMEDIA_SHARE="" 87 | #SYS_MULTIMEDIA_PATH="" 88 | #SYS_RECORDINGS_SHARE="" 89 | #SYS_RECORDINGS_PATH="" 90 | #SYS_USB_SHARE="" 91 | #SYS_USB_PATH="" 92 | #SYS_WEB_SHARE="" 93 | #SYS_WEB_PATH="" 94 | ## Path to ipkg or opkg package tool if installed. 95 | #CMD_PKG_TOOL="/opt/bin/ipkg" 96 | # 97 | ###################################################################### 98 | # All package specific functions shall call 'err_log MSG' if an error 99 | # is detected that shall terminate the installation. 100 | ###################################################################### 101 | # 102 | ###################################################################### 103 | # Define any package specific operations that shall be performed when 104 | # the package is removed. 105 | ###################################################################### 106 | PKG_PRE_REMOVE="{ 107 | 108 | export package_status=REMOVING 109 | 110 | }" 111 | 112 | pkg_init() 113 | { 114 | 115 | export package_status=INSTALLING 116 | 117 | } 118 | 119 | ###################################################################### 120 | # Define any package specific operations that shall be performed when 121 | # the package is installed. 122 | ###################################################################### 123 | #pkg_pre_install() 124 | # { 125 | # 126 | # } 127 | 128 | pkg_post_install() 129 | { 130 | 131 | $CMD_SETCFG -f $SYS_QPKG_CONFIG_FILE $QPKG_NAME Web_Port $($CMD_GETCFG System "Web Access Port") 132 | $CMD_SETCFG -f $SYS_QPKG_CONFIG_FILE $QPKG_NAME Scripts_Path $SYS_QPKG_DIR/scripts 133 | $CMD_SETCFG -f $SYS_QPKG_CONFIG_FILE $QPKG_NAME SysV_Path $SYS_QPKG_DIR/init.d 134 | 135 | # If here, assume install/reinstall/upgrade worked OK. Reset service action. 136 | 137 | readonly r_service_action_pathfile=/var/log/$QPKG_NAME.action 138 | readonly r_service_result_pathfile=/var/log/$QPKG_NAME.result 139 | local service_result=ok 140 | 141 | if [[ ${REINSTALL_QPKG:=false} = true ]]; then 142 | service_action=reinstall 143 | elif [[ ${UPGRADE_QPKG:=false} = true ]]; then 144 | service_action=upgrade 145 | else 146 | service_action=install 147 | fi 148 | 149 | echo "$service_action" > "$r_service_action_pathfile" 150 | echo "$service_result" > "$r_service_result_pathfile" 151 | 152 | } 153 | -------------------------------------------------------------------------------- /shared/runlast.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | ############################################################################### 3 | # runlast.sh 4 | # Copyright 2019-2025 OneCD 5 | # 6 | # Contact: 7 | # one.cd.only@gmail.com 8 | # 9 | # Description: 10 | # This script is part of the 'RunLast' package 11 | # 12 | # Available in the MyQNAP store: 13 | # https://www.myqnap.org/product/runlast 14 | # 15 | # And via the sherpa package manager: 16 | # https://git.io/sherpa 17 | # 18 | # Project source: 19 | # https://github.com/OneCDOnly/RunLast 20 | # 21 | # Community forum: 22 | # https://community.qnap.com/t/qpkg-runlast/1102 23 | # 24 | # This program is free software: you can redistribute it and/or modify it under 25 | # the terms of the GNU General Public License as published by the Free Software 26 | # Foundation, either version 3 of the License, or (at your option) any later 27 | # version. 28 | # 29 | # This program is distributed in the hope that it will be useful, but WITHOUT 30 | # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 31 | # FOR A PARTICULAR PURPOSE. See the GNU General Public License for more 32 | # details. 33 | # 34 | # You should have received a copy of the GNU General Public License along with 35 | # this program. If not, see http://www.gnu.org/licenses/. 36 | ############################################################################### 37 | 38 | set -o nounset -o pipefail 39 | shopt -s extglob 40 | ln -fns /proc/self/fd /dev/fd # KLUDGE: `/dev/fd` isn't always created by QTS. 41 | readonly r_user_args_raw=$* 42 | 43 | Init() 44 | { 45 | 46 | readonly r_qpkg_name=RunLast 47 | 48 | # KLUDGE: mark QPKG installation as complete. 49 | 50 | /sbin/setcfg $r_qpkg_name Status complete -f /etc/config/qpkg.conf 51 | 52 | # KLUDGE: 'clean' the QTS 4.5.1+ App Center notifier status. 53 | 54 | [[ -e /sbin/qpkg_cli ]] && /sbin/qpkg_cli --clean $r_qpkg_name &> /dev/null 55 | 56 | local -r r_qpkg_path=$(/sbin/getcfg $r_qpkg_name Install_Path -f /etc/config/qpkg.conf) 57 | readonly r_script_store_path=$r_qpkg_path/scripts 58 | readonly r_sysv_store_path=$r_qpkg_path/init.d 59 | 60 | local -r r_gui_log_pathfile=/home/httpd/$r_qpkg_name.log 61 | readonly r_log_pathfile=/var/log/$r_qpkg_name.log 62 | readonly r_qpkg_version=$(/sbin/getcfg $r_qpkg_name Version -f /etc/config/qpkg.conf) 63 | readonly r_service_action_pathfile=/var/log/$r_qpkg_name.action 64 | readonly r_service_result_pathfile=/var/log/$r_qpkg_name.result 65 | readonly r_sleeper_log_pathfile=/var/log/$r_qpkg_name-sleeper.log 66 | 67 | [[ ! -e $r_log_pathfile ]] && touch "$r_log_pathfile" 68 | [[ ! -L $r_gui_log_pathfile ]] && ln -s "$r_log_pathfile" "$r_gui_log_pathfile" 69 | [[ ! -d $r_sysv_store_path ]] && mkdir -p "$r_sysv_store_path" 70 | [[ ! -d $r_script_store_path ]] && mkdir -p "$r_script_store_path" 71 | 72 | SetOsFirmwareVer 73 | 74 | } 75 | 76 | StartQPKG() 77 | { 78 | 79 | if [[ ${package_status:=none} = INSTALLING ]]; then 80 | operation=installation 81 | RecordStart "$operation" 82 | RecordEnd "$operation" 83 | return 84 | fi 85 | 86 | if IsNotQPKGEnabled; then 87 | echo -e "This QPKG is disabled. Please enable it first with:\n\tqpkg_service enable $r_qpkg_name" 88 | return 1 89 | fi 90 | 91 | local -i start_seconds=$(/bin/date +%s) 92 | local -i timeout_seconds=1800 93 | local -i timeout_limit_seconds=$((start_seconds+timeout_seconds)) 94 | local -i recheck_seconds=10 95 | local -i now_seconds=0 96 | 97 | WriteToSleeperLog 'initial QPKG startup check ...' 98 | 99 | while true; do 100 | now_seconds=$(/bin/date +%s) 101 | 102 | if IsOsStartingPackages; then 103 | if [[ $now_seconds -ge $timeout_limit_seconds ]]; then 104 | AppendToSleeperLog "$(GetOsName) startup timeout reached ($timeout_seconds seconds). Unable to execute userscripts." 105 | return 1 106 | fi 107 | 108 | AppendToSleeperLog "$(GetOsName) is starting packages (recheck in $recheck_seconds seconds)." 109 | /bin/sleep $recheck_seconds 110 | else 111 | AppendToSleeperLog "$(GetOsName) is NOT starting packages (after $((now_seconds-start_seconds)) seconds)." 112 | 113 | operation="'start' scripts" 114 | RecordStart "$operation" 115 | ProcessSysV start 116 | ProcessScripts 117 | RecordEnd "$operation" 118 | break 119 | fi 120 | done 121 | 122 | } 123 | 124 | StopQPKG() 125 | { 126 | 127 | if [[ ${package_status:=none} != INSTALLING ]]; then 128 | if IsQPKGEnabled SortMyQPKGs; then 129 | testver=$(/sbin/getcfg SortMyQPKGs Version -d 0 -f /etc/config/qpkg.conf) 130 | 131 | if [[ ${testver:0:6} -ge 181217 ]]; then 132 | RecordInfo 'SortMyQPKGs will reorder this package' 133 | else 134 | RecordWarning 'your SortMyQPKGs version is incompatible with this package' 135 | fi 136 | elif ! IsOsCanAsyncQpkgActions; then 137 | operation='package reorder' 138 | RecordStart "$operation" 139 | MoveConfigToBottom $r_qpkg_name 140 | RecordEnd "$operation" 141 | fi 142 | 143 | operation="'stop' scripts" 144 | RecordStart "$operation" 145 | ProcessSysV stop 146 | RecordEnd "$operation" 147 | fi 148 | 149 | } 150 | 151 | StatusQPKG() 152 | { 153 | 154 | if IsQPKGEnabled; then 155 | echo active 156 | exit 0 157 | else 158 | echo inactive 159 | exit 1 160 | fi 161 | 162 | } 163 | 164 | ProcessSysV() 165 | { 166 | 167 | # Inputs: (local) 168 | # $1 = 'start' or 'stop' 169 | 170 | [[ -z ${1:-} ]] && return 171 | 172 | local script_pathname='' 173 | 174 | case ${1:-} in 175 | start) 176 | # Execute 'init.d' script names in-order. 177 | 178 | ls "$r_sysv_store_path"/* 2>/dev/null | while read -r script_pathname; do 179 | [[ -x $script_pathname ]] && RunAndLog "$script_pathname start" 180 | done 181 | ;; 182 | stop) 183 | # Execute 'init.d' script names in reverse-order. 184 | 185 | ls -r "$r_sysv_store_path"/* 2>/dev/null | while read -r script_pathname; do 186 | [[ -x $script_pathname ]] && RunAndLog "$script_pathname stop" 187 | done 188 | ;; 189 | *) 190 | return 1 191 | esac 192 | 193 | } 194 | 195 | ProcessScripts() 196 | { 197 | 198 | local script_pathname='' 199 | 200 | # Read 'scripts' script names in order and execute. 201 | 202 | ls "$r_script_store_path"/* 2>/dev/null | while read -r script_pathname; do 203 | [[ -x $script_pathname ]] && RunAndLog "$script_pathname" 204 | done 205 | 206 | } 207 | 208 | ShowTitle() 209 | { 210 | 211 | echo "$(ShowAsTitleName) $(ShowAsVersion)" 212 | 213 | } 214 | 215 | ShowAsTitleName() 216 | { 217 | 218 | TextBrightWhite $r_qpkg_name 219 | 220 | } 221 | 222 | ShowAsVersion() 223 | { 224 | 225 | printf '%s' "v$r_qpkg_version" 226 | 227 | } 228 | 229 | ShowAsUsage() 230 | { 231 | 232 | echo -e "\nUsage: $0 {start|stop|restart|status|log}" 233 | echo -e "\nTo execute files in the $r_qpkg_name 'init.d' path, then files in the 'scripts' path:\n\t$0 start" 234 | echo -e "\nTo execute files in the $r_qpkg_name 'init.d' path in reverse order:\n\t$0 stop" 235 | echo -e "\nTo stop, then start this QPKG:\n\t$0 restart" 236 | 237 | } 238 | 239 | ShowLog() 240 | { 241 | 242 | if [[ -e $r_log_pathfile ]]; then 243 | /bin/less -~ "$r_log_pathfile" 244 | else 245 | echo 'no log to display.' 246 | fi 247 | 248 | } 249 | 250 | RunAndLog() 251 | { 252 | 253 | # Inputs: (local) 254 | # $1 = command to run 255 | 256 | # Inputs: (global) 257 | # $r_log_pathfile 258 | 259 | if [[ -z ${1:-} ]]; then 260 | echo 'command not specified' 261 | return 1 262 | fi 263 | 264 | local stdout='' 265 | local stderr='' 266 | 267 | FormatAsLog "-> execute: '$1' ..." | /usr/bin/tee -a "$r_log_pathfile" 268 | 269 | { # https://unix.stackexchange.com/a/430182/110015 270 | 271 | stdout=$(eval "$1" 2> /dev/fd/3) 272 | exitcode=$? 273 | stderr=$(/bin/cat<&3) 274 | 275 | } 3< exitcode: '$exitcode'" 281 | FormatAsLog "==> stdout: \"$stdout\"" 282 | FormatAsLog "==> stderr: \"$stderr\"" 283 | 284 | } | /usr/bin/tee -a "$r_log_pathfile" 285 | 286 | return 0 287 | 288 | } 289 | 290 | MoveConfigToBottom() 291 | { 292 | 293 | # Move $1 (QPKG name) to the bottom of /etc/config/qpkg.conf 294 | 295 | [[ -n ${1:-} ]] || return 296 | 297 | local a='' 298 | 299 | a=$(GetConfigBlock ${1:-}) 300 | [[ -n $a ]] || return 301 | 302 | /sbin/rmcfg ${1:-} -f /etc/config/qpkg.conf 303 | echo -e "\n${a}" >> /etc/config/qpkg.conf 304 | 305 | } 306 | 307 | GetConfigBlock() 308 | { 309 | 310 | # Output the config block for $1 (QPKG name). 311 | 312 | [[ -n ${1:-} ]] || return 313 | 314 | local -i sl=0 # start line number of config block. 315 | local -i ll=0 # last line number in file. 316 | local -i tl=0 # total lines in config block. 317 | local -i el=0 # end line number of config block. 318 | 319 | sl=$(/bin/grep -n "^\[${1:-}\]" /etc/config/qpkg.conf | /usr/bin/cut -f1 -d':') 320 | [[ -n $sl ]] || return 321 | 322 | ll=$(/usr/bin/wc -l < /etc/config/qpkg.conf | /bin/tr -d ' ') 323 | tl=$(/usr/bin/tail -n$((ll-sl)) < /etc/config/qpkg.conf | /bin/grep -n '^\[' | /usr/bin/head -n1 | /usr/bin/cut -f1 -d':') 324 | 325 | [[ $tl -ne 0 ]] && el=$((sl+tl-1)) || el=$ll 326 | [[ -n $el ]] || return 327 | 328 | echo -e "$(/bin/sed -n "$sl,${el}p" /etc/config/qpkg.conf)" # Output this with 'echo' to strip trailing LFs from config block. 329 | 330 | } 331 | 332 | RecordStart() 333 | { 334 | 335 | # Inputs: (local) 336 | # $1 = operation 337 | 338 | # Inputs: (global) 339 | # $r_qpkg_name 340 | # $r_qpkg_version 341 | 342 | [[ -n ${1:-} ]] || return 343 | 344 | local a="begin processing $1 ..." 345 | 346 | if [[ -s $r_log_pathfile ]]; then 347 | local -i spacer_width=80 348 | local b='' 349 | printf -v b "%${spacer_width}s" 350 | AppendToLog "${b// /─}" 351 | fi 352 | 353 | FormatAsLog "$a" 354 | AppendToLog "$r_qpkg_name ($r_qpkg_version)" 355 | AppendToLog "$a" 356 | AppendToQTSLog "$a" 0 357 | 358 | } 359 | 360 | RecordEnd() 361 | { 362 | 363 | # Inputs: (local) 364 | # $1 = operation 365 | 366 | [[ -n ${1:-} ]] || return 367 | 368 | local a="end of processing $1" 369 | 370 | FormatAsLog "$a" 371 | AppendToLog "$a" 372 | AppendToQTSLog "$a" 0 373 | 374 | SetServiceResultAsOK 375 | 376 | } 377 | 378 | RecordInfo() 379 | { 380 | 381 | # Inputs: (local) 382 | # $1 = message 383 | 384 | [[ -n ${1:-} ]] || return 385 | 386 | AppendToLog "$1" 387 | AppendToQTSLog "$1" 0 388 | 389 | } 390 | 391 | RecordWarning() 392 | { 393 | 394 | # Inputs: (local) 395 | # $1 = message 396 | 397 | [[ -n ${1:-} ]] || return 398 | 399 | AppendToLog "$1" 400 | AppendToQTSLog "$1" 1 401 | 402 | } 403 | 404 | FormatAsLog() 405 | { 406 | 407 | [[ -n ${1:-} ]] || return 408 | 409 | printf '%s - %s\n' "$(/bin/date)" "$1" 410 | 411 | } 412 | 413 | FormatAsQTSLog() 414 | { 415 | 416 | [[ -n ${1:-} ]] || return 417 | 418 | printf '[%s] %s\n' "$r_qpkg_name" "$1" 419 | 420 | } 421 | 422 | AppendToLog() 423 | { 424 | 425 | # Inputs: (local) 426 | # $1 = message to add to temporary log 427 | 428 | [[ -n ${1:-} ]] || return 429 | 430 | FormatAsLog "$1" >> "$r_log_pathfile" 431 | 432 | } 433 | 434 | AppendToSleeperLog() 435 | { 436 | 437 | # Inputs: (local) 438 | # $1 = message to add to sleeper log 439 | 440 | [[ -n ${1:-} ]] || return 441 | 442 | FormatAsLog "$1" >> "$r_sleeper_log_pathfile" 443 | 444 | } 445 | 446 | AppendToQTSLog() 447 | { 448 | 449 | # Inputs: (local) 450 | # $1 = message to add to NAS system log 451 | # $2 = event type: 452 | # 0 : Information 453 | # 1 : Warning 454 | # 2 : Error 455 | 456 | [[ -n ${1:-} && -n ${2:-} ]] || return 457 | 458 | /sbin/log_tool --append "$(FormatAsQTSLog "$1")" --type "$2" 459 | 460 | } 461 | 462 | WriteToSleeperLog() 463 | { 464 | 465 | # Inputs: (local) 466 | # $1 = message to write into sleeper log 467 | 468 | [[ -n ${1:-} ]] || return 469 | 470 | [[ -e $r_sleeper_log_pathfile ]] && rm "$r_sleeper_log_pathfile" 471 | 472 | AppendToSleeperLog "$1" 473 | 474 | } 475 | 476 | IsQuTS() 477 | { 478 | 479 | /bin/grep zfs /proc/filesystems 480 | 481 | } &> /dev/null 482 | 483 | IsQPKGEnabled() 484 | { 485 | 486 | # Inputs: (local) 487 | # $1 = (optional) package name to check. If unspecified, default is $r_qpkg_name 488 | 489 | # Outputs: (local) 490 | # $? = 0 : true 491 | # $? = 1 : false 492 | 493 | [[ $(Lowercase "$(/sbin/getcfg ${1:-$r_qpkg_name} Enable -d false -f /etc/config/qpkg.conf)") = true ]] 494 | 495 | } 496 | 497 | IsNotQPKGEnabled() 498 | { 499 | 500 | # Inputs: (local) 501 | # $1 = (optional) package name to check. If unspecified, default is $r_qpkg_name 502 | 503 | # Outputs: (local) 504 | # $? = 0 : true 505 | # $? = 1 : false 506 | 507 | ! IsQPKGEnabled "${1:-$r_qpkg_name}" 508 | 509 | } 510 | 511 | IsOsCanAsyncQpkgActions() 512 | { 513 | 514 | # Inputs: (global) 515 | # $r_nas_firmware_ver 516 | 517 | SetOsFirmwareVer 518 | 519 | [[ $r_nas_firmware_ver -ge 520 ]] 520 | 521 | } 522 | 523 | IsOsStarting() 524 | { 525 | 526 | /bin/ps | /bin/grep '/bin/sh /etc/init.d/rcS' | /bin/grep -v grep 527 | 528 | } &> /dev/null 529 | 530 | IsOsStartingPackages() 531 | { 532 | 533 | if IsOsCanAsyncQpkgActions; then 534 | /bin/ps | /bin/grep '/usr/local/sbin/qpkg_service start' | /bin/grep -v grep | /bin/grep -v $r_qpkg_name 535 | else 536 | IsOsStarting 537 | fi 538 | 539 | } &> /dev/null 540 | 541 | GetOsName() 542 | { 543 | 544 | # Outputs: (local) 545 | # stdout = text string. 546 | 547 | if IsQuTS; then 548 | printf 'QuTS hero' 549 | else 550 | printf QTS 551 | fi 552 | 553 | } 554 | 555 | GetOsFirmwareVer() 556 | { 557 | 558 | # Same as firmware version, but an integer-only (no periods). 559 | 560 | # Outputs: (local) 561 | # stdout = integer. 562 | # $? = 0 if found, 250 if not. 563 | 564 | /sbin/getcfg System Version -d undefined -f /etc/config/uLinux.conf | /bin/tr -d '.' 565 | 566 | } 567 | 568 | SetOsFirmwareVer() 569 | { 570 | 571 | # Same as firmware version, but as an integer-only (no periods). 572 | 573 | # Outputs: (global) 574 | # $r_nas_firmware_ver 575 | 576 | [[ ${r_nas_firmware_ver:-unset} = unset ]] && readonly r_nas_firmware_ver=$(GetOsFirmwareVer) 577 | 578 | } 579 | 580 | SetServiceAction() 581 | { 582 | 583 | service_action=${1:-none} 584 | CommitServiceAction 585 | SetServiceResultAsInProgress 586 | 587 | } 588 | 589 | SetServiceResultAsOK() 590 | { 591 | 592 | service_result=ok 593 | CommitServiceResult 594 | 595 | } 596 | 597 | SetServiceResultAsFailed() 598 | { 599 | 600 | service_result=failed 601 | CommitServiceResult 602 | 603 | } 604 | 605 | SetServiceResultAsInProgress() 606 | { 607 | 608 | # Selected action is in-progress and hasn't generated a result yet. 609 | 610 | service_result=in-progress 611 | CommitServiceResult 612 | 613 | } 614 | 615 | CommitServiceAction() 616 | { 617 | 618 | echo "$service_action" > "$r_service_action_pathfile" 619 | 620 | } 621 | 622 | CommitServiceResult() 623 | { 624 | 625 | echo "$service_result" > "$r_service_result_pathfile" 626 | 627 | } 628 | 629 | TextBrightWhite() 630 | { 631 | 632 | [[ -n ${1:-} ]] || return 633 | 634 | printf '\033[1;97m%s\033[0m' "${1:-}" 635 | 636 | } 637 | 638 | Lowercase() 639 | { 640 | 641 | /bin/tr 'A-Z' 'a-z' <<< "${1:-}" 642 | 643 | } 644 | 645 | Init 646 | 647 | user_arg=${r_user_args_raw%% *} # Only process first argument. 648 | 649 | case $user_arg in 650 | l|log) 651 | ShowLog 652 | ;; 653 | ?(-)r|?(--)restart) 654 | SetServiceAction restart 655 | 656 | if StopQPKG && StartQPKG; then 657 | SetServiceResultAsOK 658 | else 659 | SetServiceResultAsFailed 660 | fi 661 | ;; 662 | ?(--)start) 663 | SetServiceAction start 664 | 665 | if StartQPKG; then 666 | SetServiceResultAsOK 667 | else 668 | SetServiceResultAsFailed 669 | fi 670 | ;; 671 | ?(-)s|?(--)status) 672 | StatusQPKG 673 | ;; 674 | ?(--)stop) 675 | SetServiceAction stop 676 | 677 | if StopQPKG; then 678 | SetServiceResultAsOK 679 | else 680 | SetServiceResultAsFailed 681 | fi 682 | ;; 683 | *) 684 | ShowTitle 685 | ShowAsUsage 686 | esac 687 | 688 | exit 0 689 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------