tazpanel view lib/libtazpanel @ rev 538

Speed-up interface: cache xhtml header; need to use 'tazpanel cc' to clean cache when TazPanel menu changes (in post-install and post-remove functions for TazPanel modules)
author Aleksej Bobylev <al.bobylev@gmail.com>
date Sun Aug 30 23:46:37 2015 +0300 (2015-08-30)
parents c0f8e615df7d
children 71e797397c58
line source
1 #!/bin/sh
2 #
3 # Common functions for TazPanel CGI and cmdline interface
4 #
5 # Copyright (C) 2011-2015 SliTaz GNU/Linux - BSD License
6 #
8 . /lib/libtaz.sh
11 # Redefine gettext functions
13 _() { local T="$1"; shift; printf "$(gettext "$T")" "$@"; echo; }
14 _n() { local T="$1"; shift; printf "$(gettext "$T")" "$@"; }
17 GUI_USER=nobody
18 [ "$HTTP_HOST" == "127.0.0.1:82" ] &&
19 for i in "$HTTP_COOKIE" "$QUERY_STRING" ; do
20 v="$(echo "$i" | sed '/guiuser=/!d;s/.*guiuser=\([A-Za-z0-9_]*\).*/\1/')"
21 [ "$v" ] || continue
22 busybox ps | sed '/d;/d;/127\.0\.0\.1:82/!d' | grep -q " $v " || continue
23 GUI_USER="$v"
24 done
25 [ "$(id -un)" == "${REMOTE_USER:=$GUI_USER}" ] || exec su -s /bin/sh -c "$(realpath $0) $@" $REMOTE_USER
28 # Get parameters with GET, POST, COOKIE and FILE functions
30 . /usr/lib/slitaz/httphelper
33 # I18n
35 . /etc/locale.conf
36 export TEXTDOMAIN='tazpanel' LANG LC_ALL
39 # We need a config file first
41 get_config() {
42 CONFIG='/etc/slitaz/tazpanel.conf'
43 if [ -f "$CONFIG" ]; then
44 . $CONFIG
45 else
46 echo "No config file found: $CONFIG"
47 exit 1
48 fi
49 }
52 # Display < > &
54 htmlize() {
55 sed -e 's|\&|\&amp;|g; s|<|\&lt;|g; s|>|\&gt;|g'
56 }
59 # Syntax highlighting for config file and SHell scripts
61 syntax_highlighter() {
62 case $1 in
63 conf)
64 htmlize | sed \
65 -e 's|^\([ \t]*[A-Za-z0-9_][A-Za-z0-9_]*\)\(="*.*\)|<span class="conf-var">\1</span><span class="conf-val">\2</span>|g' \
66 -e 's|^[ \t]*#.*|<span class="conf-comment">\0</span>|g' ;;
67 #-e s"#^\#\([^']*\)#<span class='conf-comment'>\0</span>#"g \
68 #-e s"#^[A-Z]\([^']*\)=#<span class='conf-var'>\0</span>#"g \
69 #-e s"#^[a-z]\([^']*\)#<span class='conf-var'>\0</span>#"g \
70 #-e s"#[\"']\([^']*\)[\"']#<span class='conf-val'>\0</span>#"g ;;
71 sh)
72 htmlize | sed \
73 -e 's|^\([ \t]*[A-Za-z0-9_][A-Za-z0-9_]*\)\(="*.*\)|<span class="sh-var">\1</span><span class="sh-val">\2</span>|g' \
74 -e 's|^#.*|<span class="sh-comment">\0</span>|g' ;;
75 #-e s"#^\#\([^']*\)#<span class='sh-comment'>\0</span>#"g \
76 #-e s"#\"\([^']*\)\"#<span class='sh-val'>\0</span>#"g ;;
77 diff)
78 htmlize | sed \
79 -e 's|^-.*|<span class="diff-rm">\0</span>|g' \
80 -e 's|^+.*|<span class="diff-add">\0</span>|g' \
81 -e 's|^@.*|<span class="diff-at">\0</span>|g' ;;
82 activity)
83 # realize lazy quantification
84 sed -e "s|: |ⓒ|; s|^\(.*\)ⓒ|<span class='activity-log'>\1:</span> |" ;;
85 kernel)
86 # line with "ⓒ": realize lazy quantification
87 htmlize | sed \
88 -e "s|\([^0-9]\)\(0x[0-9a-f]\+\)|\1<span class='kernel-hex'>\2</span>|g" \
89 -e "s|: |ⓒ|; s|^\(.*\)ⓒ|<span class='kernel-id'>\1:</span> |" \
90 -e "s|\(\[[^ ]\+\]\)|<span class='kernel-id2'>\0</span>|g" \
91 -e "s|Call Trace:|<span class='kernel-trace'>\0</span>|" ;;
92 lsusb)
93 htmlize | sed \
94 -e 's|^[^:]*:[ x0-9a-f^:]*$|<span class="lsusb-t">\0</span>|g' \
95 -e 's|^Bus.*$|<span class="lsusb-h">\0</span>|g' ;;
96 lspci)
97 htmlize | sed \
98 -e 's|^[0-9a-f].*$|<span class="lspci-t">\0</span>|g' \
99 -e 's|^ \([^:]*:\)| <span class="lspci-h">\1</span>|g' ;;
100 xlog)
101 htmlize | sed \
102 -e 's|^[^]]*]|<span class="xlog xlog-timestamp">\0</span>|' \
103 -e 's|(--)|<span class="xlog xlog-probed" title="probed">\0</span>|' \
104 -e 's|(\*\*)|<span class="xlog xlog-config" title="from config file">\0</span>|' \
105 -e 's|(==)|<span class="xlog xlog-default" title="default setting">\0</span>|' \
106 -e 's|(++)|<span class="xlog xlog-cmdline" title="from command line">\0</span>|' \
107 -e 's|(!!)|<span class="xlog xlog-notice" title="notice">\0</span>|' \
108 -e 's|(II)|<span class="xlog xlog-info" title="informational">\0</span>|' \
109 -e 's|(WW)|<span class="xlog xlog-warn" title="warning">\0</span>|' \
110 -e 's|(EE)|<span class="xlog xlog-error" title="error">\0</span>|' \
111 -e 's|(NI)|<span class="xlog xlog-ni" title="not implemented">\0</span>|' \
112 -e 's|(??)|<span class="xlog xlog-unknown" title="unknown">\0</span>|' \
113 ;;
114 esac
115 }
118 # Remove status and ESC char from tazpkg/tazlito commands output
120 filter_taztools_msgs() {
121 sed \
122 -e 's|\\[0m|</span>|g' \
123 -e 's|\\[0;39m|</span>|g' \
124 -e 's|\\[0*\([0-7]*\);\([0-7]*\)m|<span class="color\1 color\2">|g' \
125 -e ':a;s/^\(.\{0,69\}\)\(\\[[0-9]*G\[\)/\1 \2/;ta' \
126 -e ':b;s|^\([^\]*\)\\[\([0-9]*\)G|<span style="display:inline-block;width:\2ex">\1</span>|;tb' \
127 -e 's/\[^Gm]*.//g'
128 }
131 # LOG activities
133 log() {
134 date=$(date "+%F %R")
135 filter_taztools_msgs | sed "s|[^']*|$date : \0|" >> $LOG_FILE
136 }
139 ok_status() {
140 echo '[<span class="diff-add"> OK </span>]'
141 }
144 # Network interface status
146 interface_status() {
147 ip="----"
148 status="----"
149 scan=""
150 if ifconfig | grep -A1 $1 | grep -q inet; then
151 ip=$(ifconfig | grep -A1 $1 | grep inet | awk '{ print $2 }' | cut -d: -f2)
152 [ "$(cat /sys/class/net/$1/carrier)" == "1" ] &&
153 scan='<a data-icon="scan" href="network.cgi?scan='$ip'&amp;back=network.cgi">'$(_ 'Scan')'</a>'
154 fi
155 [ "$(cat /sys/class/net/$1/carrier)" == "1" ] &&
156 status="$(_ 'connected')" &&
157 speed="$(cat /sys/class/net/$1/speed 2> /dev/null)" &&
158 [ "$speed" ] && status="$status ${speed}M"
159 echo "<td>$status</td><td>$ip</td><td>$scan</td>"
160 }
163 # Catch network interface (used in summary and network main page)
165 list_network_interfaces() {
166 cat <<EOT
167 <table class="wide zebra center">
168 <thead>
169 <tr>
170 <td>$(_ 'Interface')</td>
171 <td>$(_ 'Name')</td>
172 <td>$(_ 'Status')</td>
173 <td>$(_ 'IP Address')</td>
174 <td>$(_ 'Scan ports')</td>
175 </tr>
176 </thead>
177 <tbody>
178 EOT
179 for i in $(ls /sys/class/net); do
180 case $i in
181 eth*)
182 echo '<tr><td><a data-icon="eth" href="network.cgi?eth">'$i'</a></td>
183 <td>Ethernet</td> '$(interface_status $i)'</tr>';;
184 wlan*|ath*|ra*)
185 echo '<tr><td><a data-icon="wifi" href="network.cgi?wifi">'$i'</a></td>
186 <td>Wireless</td> '$(interface_status $i)'</tr>';;
187 ppp*)
188 echo '<tr><td><a data-icon="removable" href="ppp.cgi">'$i'</a></td>
189 <td>Point to point</td> '$(interface_status $i)'</tr>';;
190 tap[0-9]*|tun[0-9]*)
191 echo '<tr><td><span data-icon="removable">'$i'</span></td>
192 <td>User space</td> '$(interface_status $i)'</tr>';;
193 lo)
194 echo '<tr><td><span data-icon="loopback">'$i'</span></td>
195 <td>Loopback</td> '$(interface_status $i)'</tr>';;
196 *)
197 continue ;;
198 esac
199 done
200 cat <<EOT
201 </tbody>
202 </table>
203 EOT
204 }
207 # Get the list of panel styles
209 list_styles() {
210 for style in $PANEL/styles/*; do
211 style=$(basename $style)
212 echo "<option value='$style'>$style</option>"
213 done
214 }
217 # Get the list of system locales
219 list_locales() {
220 for locale in $(find /usr/share/i18n/locales -type f -name "[a-z][a-z]_[A-Z][A-Z]")
221 do
222 echo "<option value=\"$locale\">$locale</option>"
223 done
224 }
227 # Get the list of console keymaps
229 list_keymaps() {
230 if [ -d /usr/share/kbd ]; then
231 # kbd-base
232 find /usr/share/kbd/keymaps/i386 -type f -name '*.map*' ! -path '*include*' | \
233 awk -F/ '{gsub(/.map.gz/, ""); printf "<option value=\"%s\">%s (%s)\n", $8, $8, $7}'
234 else
235 # kbd-busybox
236 ls /usr/share/kmap/*.kmap | \
237 sed 's|.*kmap/\(.*\).kmap|<option value="\1">\1|'
238 fi | sort
239 }
242 #
243 # xHTML 5 (header and footer skel are from the style)
244 #
246 loading_msg() {
247 [ -n "$(GET noheader)" ] && return
248 local MSG=${1:-$LOADING_MSG}
249 [ -z "$MSG" ] && MSG="$(_ 'Please wait')"
250 cat <<EOT
251 <script type="text/javascript">statusbar("$MSG", 1)</script>
252 EOT
253 }
256 xhtml_header() {
257 [ -n "$(GET noheader)" ] && return
259 local subtitle="$1" header="/var/cache/tazpanel/header.$(id -un)"
261 # Cache header
262 if [ ! -f "$header" ]; then
263 SUBTITLE='@@SUBTITLE@@'
264 . ${PANEL}$HEADER > "$header"
265 cat >> "$header" <<EOT
266 <script type="text/javascript">
267 document.cookie = "guiuser=; expires=Thu, 01 Jan 1970 00:00:00 UTC";
268 document.cookie = "guiuser=$GUI_USER";
269 </script>
270 EOT
271 fi
272 sed "s|@@SUBTITLE@@|$subtitle|" "$header"
274 # Show debug output
275 if [ "$DEBUG" -eq 1 ]; then
276 local i j x
277 args=''
278 for x in GET POST COOKIE; do
279 for i in $($x); do
280 if [ $($x $i count) -gt 1 ]; then
281 for j in $(seq 1 $($x $i count)); do
282 args="$args $x($i,$j)='$($x $i $j)'"
283 done
284 else
285 args="$args $x($i)='$($x $i)'"
286 fi
287 done
288 done
289 for i in $(FILE); do
290 for j in name size type tmpname; do
291 args="$args FILE($i,$j)=$(FILE $i $j)"
292 done
293 done
294 cat <<EOT
295 <pre class="debug">
296 QUERY_STRING="$QUERY_STRING"$args
297 </pre>
298 EOT
299 fi
300 }
303 xhtml_footer() {
304 [ -n "$(GET noheader)" ] && return
306 export TEXTDOMAIN='tazpkg'
307 . ${PANEL}$FOOTER
308 }
311 table_start() { echo '<table>'; }
312 table_end() { echo '</table>'; }
315 df_thead() {
316 cat <<EOT
317 <thead>
318 <tr>
319 <td>$(_ 'Disk')</td>
320 <td>$(_ 'Label')</td>
321 <td>$(_ 'Type')</td>
322 <td>$(_ 'Size')</td>
323 <td>$(_ 'Available')</td>
324 <td>$(_ 'Used')</td>
325 <td>$(_ 'Mount point')</td>
326 <td>UUID</td>
327 </tr>
328 </thead>
329 EOT
330 }
333 msg() {
334 msgtype="$1"; shift
335 case "$msgtype" in
336 tip) I='data-icon="msgtip"';;
337 warn|warning) I='data-icon="msgwarn"';;
338 err|error) I='data-icon="msgerr"';;
339 up) I='data-icon="msgup"';;
340 *) I='data-icon="msg"';;
341 esac
342 echo "<section class=\"box\"><span $I></span>$@</section>"
343 }
346 is_installed() {
347 [ -d "$INSTALLED/$1" ]
348 }
351 blk2h() {
352 if [ "$1" ]; then
353 echo $1
354 else
355 cat
356 fi | awk '{
357 n = $0/2
358 for (i = 1; n > 1024; i++)
359 n /= 1024
360 f = "%1.0f%c"
361 if (n < 100)
362 f = "%1.1f%c"
363 printf f,n,substr("KMGT", i, 1)
364 }'
365 }
368 # Show "Back" button
370 back_button() {
371 #FIXME: can't encode data-icon
372 printf '<form action="%s" method="post"><button data-icon="%s">%s</button></form>' \
373 "${1:-javascript:history.go(-1)}" "${3:-back}" "${2:-$(_ 'Back')}"
374 }
377 # Show "Edit" button
379 edit_button() {
380 [ -w "$1" ] && cat <<EOT
381 <form action="index.cgi">
382 <input type="hidden" name="file" value="$1"/>
383 <button name="action" value="edit" data-icon="edit">${2:-$(_ 'Edit')}</button>
384 </form>
385 EOT
386 }
388 # Mark select option as checked
390 selected() {
391 [ "$1" == "$2" ] && echo -n 'selected'
392 }
395 check_root_tazpanel() {
396 if [ $(id -u) != '0' ]; then
397 msg err "$(_ 'You must be root to show this page.')"
398 xhtml_footer; exit 0
399 fi
400 }
402 # Get system database. NSS compatible.
404 getdb() {
405 if [ -n "$(which getent)" ]; then
406 getent "$1"
407 else
408 cat "/etc/$1" | sed '/^#/d'
409 fi
410 }