tazbug view web/bugs.cgi @ rev 44

bugs.cgi: multiligne description
author Pascal Bellard <pascal.bellard@slitaz.org>
date Sat Mar 09 09:36:43 2013 +0100 (2013-03-09)
parents e404b4141804
children bba8b666cc0e
line source
1 #!/bin/sh
2 #
3 # TazBug Web interface
4 #
5 # Copyright (C) 2012 SliTaz GNU/Linux - BSD License
6 #
7 . /usr/lib/slitaz/httphelper
8 [ -f "/etc/slitaz/bugs.conf" ] && . /etc/slitaz/bugs.conf
10 # Internal variable
11 bugdir="$TAZBUG/bug"
12 plugins="plugins"
13 sessions="/tmp/bugs/sessions"
14 po=""
16 # Content negotiation for Gettext
17 IFS=","
18 for lang in $HTTP_ACCEPT_LANGUAGE
19 do
20 lang=${lang%;*} lang=${lang# } lang=${lang%-*}
21 case "$lang" in
22 en) LANG="C" ;;
23 de) LANG="de_DE" ;;
24 es) LANG="es_ES" ;;
25 fr) LANG="fr_FR" ;;
26 it) LANG="it_IT" ;;
27 pt) LANG="pt_BR" ;;
28 ru) LANG="ru_RU" ;;
29 zh) LANG="zh_TW" ;;
30 esac
31 if echo "$po" | fgrep -q "$lang"; then
32 break
33 fi
34 done
35 unset IFS
36 export LANG LC_ALL=$LANG
38 # Internationalization: $(gettext "")
39 . /usr/bin/gettext.sh
40 TEXTDOMAIN='tazbug'
41 export TEXTDOMAIN
48 #
49 # Functions
50 #
52 # HTML 5 header.
53 html_header() {
54 cat lib/header.html
55 }
57 # HTML 5 footer.
58 html_footer() {
59 cat << EOT
60 </div>
62 <div id="footer">
63 <a href="$WEB_URL">SliTaz Bugs</a> -
64 <a href="$WEB_URL?README">README</a>
65 </div>
67 </body>
68 </html>
69 EOT
70 }
72 GETfiltered()
73 {
74 GET $1 | sed -e "s/'/\&#39;/g; s|\n|<br/>|g; s/\t/\&#09;/g;s/\%22/\"/g"
75 }
77 js_redirection_to()
78 {
79 js_log "Redirecting to $1"
80 echo "<script type=\"text/javascript\"> document.location = \"$1\"; </script>"
81 }
84 js_log()
85 {
86 echo "<script type=\"text/javascript\">console.log('$1')</script>";
87 }
90 js_set_cookie()
91 {
92 name=$1
93 value=$2
95 js_log 'Setting cookie.'
96 echo "<script type=\"text/javascript\">"
97 echo "document.cookie = \"$name=$value; expires=0; path=/\"";
98 echo "</script>"
99 }
102 js_unset_cookie()
103 {
104 name=$1
106 js_log 'Unsetting cookie.'
107 echo "<script type=\"text/javascript\">"
108 echo "document.cookie = \"$1=\"\"; expires=-1; path=/";
109 echo "</script>"
110 }
113 # Check if user is auth
114 check_auth() {
115 auth="$(COOKIE auth)"
116 user="$(echo $auth | cut -d ":" -f 1)"
117 md5cookie="$(echo $auth | cut -d ":" -f 2)"
118 [ -f "$sessions/$user" ] && md5session="$(cat $sessions/$user)"
119 if [ "$md5cookie" == "$md5session" ] && [ "$auth" ]; then
120 return 0
121 else
122 return 1
123 fi
124 }
127 # Authentified or not
128 user_box() {
130 IDLOC=""
131 if [[ "$(GET id)" ]] ;then
132 IDLOC="&id=$(GET id)"
133 fi
135 if check_auth; then
136 . $PEOPLE/$user/account.conf
137 cat << EOT
138 <div id="user">
139 <a href="?user=$user">$(get_gravatar $MAIL 20)</a>
140 <a href="?logout">$(gettext 'Log out')</a>
141 </div>
142 EOT
143 else
144 cat << EOT
145 <div id="user">
146 <a href="?login$IDLOC"><img src="images/avatar.png" alt="[ User ]" /></a>
147 <a href="?login$IDLOC">$(gettext 'Log in')</a>
148 </div>
149 EOT
150 fi
151 cat << EOT
153 <div id="search">
154 <form method="get" action="$WEB_URL">
155 <input type="text" name="search" placeholder="$(gettext 'Search')" />
156 <!-- <input type="submit" value="$(gettext 'Search')" /> -->
157 </form>
158 </div>
160 <!-- Content -->
161 <div id="content">
163 EOT
164 }
167 # Login page
168 login_page() {
169 IDLOC=""
170 if [[ "$(GET id)" ]] ;then
171 IDLOC="?id=$(GET id)"
172 fi
174 cat << EOT
175 <h2>$(gettext 'Login')</h2>
177 <div id="account-info">
178 <p>$(gettext "No account yet? Please signup using the SliTaz Bugs reporter \
179 on your SliTaz system.")</p>
180 <p>$(gettext "Tip: to attach big files or images, you can use SliTaz Paste \
181 services:") <a href="http://paste.slitaz.org/">paste.slitaz.org</a></p>
182 </div>
184 <div id="login">
185 <form method="post" action="$SCRIPT_NAME">
186 <input type="text" name="auth" placeholder="$(gettext 'User name')" />
187 <input type="password" name="pass" placeholder="$(gettext 'Password')" />
188 <div>
189 <input type="submit" value="$(gettext 'Log in')" />
190 $error
191 </div>
192 </form>
193 </div>
195 <div style="clear: both;"></div>
196 EOT
197 }
200 # Display user public profile.
201 public_people() {
202 cat << EOT
203 <pre>
204 $(eval_gettext 'Real name : $NAME')
205 </pre>
206 EOT
207 }
210 # Display authentified user profile. TODO: change password
211 auth_people() {
212 cat << EOT
213 <pre>
214 $(eval_gettext 'Real name : $NAME')
215 $(eval_gettext 'Email : $MAIL')
216 $(eval_gettext 'Secure key : $KEY')
217 </pre>
218 EOT
219 }
222 # Usage: list_bugs STATUS
223 list_bugs() {
224 bug="$1"
225 echo "<h3>$(eval_gettext '$bug Bug')</h3>"
226 for pr in critical standard
227 do
228 for bug in $(fgrep -H "$1" $bugdir/*/bug.conf | cut -d ":" -f 1)
229 do
230 . $bug
231 id=$(basename $(dirname $bug))
232 if [ "$PRIORITY" == "$pr" ]; then
233 cat << EOT
234 <pre>
235 $(gettext 'Bug title :') <strong>$BUG</strong> <a href="?id=$id">$(gettext 'Show')</a>
236 $(gettext 'ID - Date :') $id - $DATE
237 $(gettext 'Creator :') <a href="?user=$CREATOR">$CREATOR</a>
238 </pre>
239 EOT
240 fi
241 done
242 done
243 }
246 # Stripped down Wiki parser for bug desc and messages which are simply
247 # displayed in <pre>
248 wiki_parser() {
249 sed \
250 -e s"#http://\([^']*\).png#<img src='\0' alt='[ Image ]' />#"g \
251 -e s"#http://\([^']*\).*# <a href='\0'>\1</a>#"g \
252 -e 's#\\\\n#\n#g;s#%22#"#g'
253 }
256 # Bug page
257 bug_page() {
258 if [ -f "$PEOPLE/$CREATOR/account.conf" ]; then
259 . $PEOPLE/$CREATOR/account.conf
260 else
261 MAIL="default"
262 fi
263 cat << EOT
264 <h2>$(eval_gettext 'Bug $id')</h2>
265 <form method="get" action="$WEB_URL">
267 <p>
268 $(get_gravatar $MAIL 32)
269 <strong>$STATUS</strong>
270 $BUG - $DATE -
271 $(eval_gettext 'Priority $PRIORITY') -
272 $(eval_ngettext '$msgs message' '$msgs messages' $msgs)
273 </p>
275 <pre>
276 $(echo "$DESC" | wiki_parser)
277 </pre>
279 <div id="tools">
280 EOT
281 if check_auth; then
282 if [ "$STATUS" == "OPEN" ]; then
283 cat << EOT
284 <a href="?id=$id&amp;close">$(gettext "Close bug")</a>
285 <a href="?edit=$id">$(gettext "Edit bug")</a>
286 EOT
287 else
288 cat << EOT
289 <a href="?id=$id&amp;open">$(gettext "Re open bug")</a>
290 EOT
291 fi
292 fi
293 cat << EOT
294 </div>
296 <h3>$(gettext "Messages")</h3>
297 EOT
298 [ "$msgs" == "0" ] && gettext "No messages"
299 for msg in $(ls -1tr $bugdir/$id/msg.*)
300 do
301 . $msg
302 if [ "$MSG" ]; then
303 msgid=$(echo $msg | cut -d "." -f 2)
304 del=""
305 # User can delete his post.
306 [ "$user" == "$USER" ] && \
307 del="<a href=\"?id=$id&amp;delmsg=$msgid\">delete</a>"
308 cat << EOT
309 <p><strong>$USER</strong> $DATE $del</p>
310 <pre>
311 $(echo "$MSG" | wiki_parser)
312 </pre>
313 EOT
314 fi
315 unset NAME DATE MSG
316 done
317 if check_auth; then
318 cat << EOT
319 <div>
320 <h3>$(gettext "New message")</h3>
322 <input type="hidden" name="id" value="$id" />
323 <textarea name="msg" rows="8"></textarea>
324 <p><input type="submit" value="$(gettext 'Send message')" /></p>
325 </form>
326 </div>
327 EOT
328 fi
329 }
332 # Write a new message
333 new_msg() {
334 date=$(date "+%Y-%m-%d %H:%M")
335 msgs=$(ls -1 $bugdir/$id/msg.* | wc -l)
336 count=$(($msgs + 1))
337 if check_auth; then
338 USER="$user"
339 fi
340 js_log "Will write message in $bugdir/$id/msg.$count "
341 sed "s/$(echo -en '\r') /\n/g" > $bugdir/$id/msg.$count << EOT
342 USER="$USER"
343 DATE="$date"
344 MSG="$(GETfiltered msg)"
345 EOT
346 }
349 # Create a new Bug
350 new_bug() {
351 count=$(ls -1 $bugdir | wc -l)
352 date=$(date "+%Y-%m-%d %H:%M")
353 # Sanity check, JS may be disabled.
354 [ ! "$(GET bug)" ] && echo "Missing bug title" && exit 1
355 [ ! "$(GET desc)" ] && echo "Missing bug description" && exit 1
356 if check_auth; then
357 USER="$user"
358 fi
359 mkdir -p $bugdir/$count
360 sed "s/$(echo -en '\r') /\n/g" > $bugdir/$count/bug.conf << EOT
361 # SliTaz Bug configuration
363 BUG="$(GETfiltered bug)"
364 STATUS="OPEN"
365 PRIORITY="$(GET priority)"
366 CREATOR="$USER"
367 DATE="$date"
368 PKGS="$(GETfiltered pkgs)"
370 DESC="$(GETfiltered desc)"
371 EOT
372 }
375 # New bug page for the web interface
376 new_bug_page() {
377 cat << EOT
378 <h2>$(gettext "New Bug")</h2>
379 <div id="newbug">
381 <form method="get" action="$WEB_URL" onsubmit="return checkNewBug();">
382 <input type="hidden" name="addbug" />
383 <table>
384 <tbody>
385 <tr>
386 <td>$(gettext "Bug title")*</td>
387 <td><input type="text" name="bug" /></td>
388 </tr>
389 <tr>
390 <td>$(gettext "Description")*</td>
391 <td><textarea name="desc"></textarea></td>
392 </tr>
393 <tr>
394 <td>$(gettext "Packages")</td>
395 <td><input type="text" name="pkgs" /></td>
396 </tr>
397 <tr>
398 <td>$(gettext "Priority")</td>
399 <td>
400 <select name="priority">
401 <option value="standard">$(gettext "Standard")</option>
402 <option value="critical">$(gettext "Critical")</option>
403 </select>
404 <input type="submit" value="$(gettext "Create Bug")" />
405 </td>
406 </tr>
407 </tbody>
408 </table>
409 </form>
411 <p>
412 $(gettext "* field is obligatory. You can also specify affected packages.")
413 </p>
415 </div>
416 EOT
417 }
420 # Edit/Save a bug configuration file
421 edit_bug() {
422 cat << EOT
423 <h2>$(eval_gettext 'Edit Bug $bug')</h2>
424 <div id="edit">
426 <form method="get" action="$WEB_URL">
427 <textarea name="bugconf">$(cat $bugdir/$bug/bug.conf)</textarea>
428 <input type="hidden" name="bug" value="$bug" />
429 <input type="submit" value="$(gettext 'Save configuration')" />
430 </form>
432 </div>
433 EOT
434 }
437 save_bug() {
438 bug="$(GET bug)"
439 content="$(GET bugconf)"
440 sed "s|\"|'|" | sed "s/$(echo -en '\r') /\n/g" > $bugdir/$bug/bug.conf << EOT
441 $content
442 EOT
443 }
446 # Close a fixed bug
447 close_bug() {
448 sed -i s'/OPEN/CLOSED/' $bugdir/$id/bug.conf
449 }
452 # Re open an old bug
453 open_bug() {
454 sed -i s'/CLOSED/OPEN/' $bugdir/$id/bug.conf
455 }
458 # Get and display Gravatar image: get_gravatar email size
459 # Link to profile: <a href="http://www.gravatar.com/$md5">...</a>
460 get_gravatar() {
461 email=$1
462 size=$2
463 [ "$size" ] || size=48
464 url="http://www.gravatar.com/avatar"
465 md5=$(md5crypt $email)
466 echo "<img src=\"$url/$md5?d=identicon&amp;s=$size\" alt=\"\" />"
467 }
470 # Create a new user in AUTH_FILE and PEOPLE
471 new_user_config() {
472 mail="$(GET mail)"
473 pass="$(GET pass)"
474 key=$(echo -n "$user:$mail:$pass" | md5sum | awk '{print $1}')
475 echo "Server Key generated"
476 echo "$user:$pass" >> $AUTH_FILE
477 mkdir -pm0700 $PEOPLE/$user/
478 cat > $PEOPLE/$user/account.conf << EOT
479 # SliTaz user configuration
480 #
482 NAME="$(GET name)"
483 USER="$user"
484 MAIL="$mail"
485 KEY="$key"
487 COMMUNITY="$(GET scn)"
488 LOCATION="$(GET location)"
489 RELEASES="$(GET releases)"
490 PACKAGES="$(GET packages)"
491 EOT
492 chmod 0600 $PEOPLE/$user/account.conf
493 if [ ! -f $PEOPLE/$user/account.conf ]; then
494 echo "ERROR: User creation failed!"
495 fi;
496 }
501 ###################################################
502 # POST actions
503 ###################################################
505 case " $(POST) " in
506 *\ auth\ *)
507 header
508 html_header
509 # Authenticate user. Create a session file in $sessions to be used
510 # by check_auth. We have the user login name and a peer session
511 # md5 string in the COOKIE.
512 user="$(POST auth)"
513 pass="$(echo -n "$(POST pass)" | md5sum | awk '{print $1}')"
515 IDLOC=""
516 if [[ "$(GET id)" ]] ;then
517 IDLOC="&id=$(GET id)"
518 fi
520 if [ ! -f $AUTH_FILE ] ; then
521 js_log "$AUTH_FILE (defined in \$AUTH_FILE) have not been found."
522 js_redirection_to "$WEB_URL?login$IDLOC"
523 fi;
525 valid=$(fgrep "${user}:" $AUTH_FILE | cut -d ":" -f 2)
526 if [ "$pass" == "$valid" ] && [ "$pass" != "" ]; then
527 if [[ "$(GET id)" ]] ;then
528 IDLOC="?id=$(GET id)"
529 fi
530 md5session=$(echo -n "$$:$user:$pass:$$" | md5sum | awk '{print $1}')
531 mkdir -p $sessions
532 echo "$md5session" > $sessions/$user
533 js_set_cookie 'auth' "$user:$md5session"
534 js_log "Login authentification have been executed & accepted :)"
535 js_redirection_to "$WEB_URL$IDLOC"
536 else
537 js_log "Login authentification have been executed & refused"
538 js_redirection_to "$WEB_URL?login&error$IDLOC"
539 fi
541 html_footer
542 ;;
543 esac
546 ###################################################
547 # GET actions
548 ###################################################
550 case " $(GET) " in
551 *\ README\ *)
552 header
553 html_header
554 user_box
555 echo '<h2>README</h2>'
556 echo '<pre>'
557 cat /usr/share/doc/tazbug/README
558 echo '</pre>'
559 html_footer ;;
560 *\ closed\ *)
561 # Show all closed bugs.
562 header
563 html_header
564 user_box
565 list_bugs CLOSED
566 html_footer ;;
567 *\ login\ *)
568 # The login page
569 [ "$(GET error)" ] && \
570 error="<span class='error'>$(gettext 'Bad login or pass')</span>"
571 header
572 html_header
573 user_box
574 login_page
575 html_footer ;;
576 *\ logout\ *)
577 header
578 html_header
579 if check_auth; then
580 rm -f "$sessions/$user"
581 js_unset_cookie 'auth'
582 js_redirection_to "$WEB_URL"
584 fi ;;
585 *\ user\ *)
586 # User profile
587 header
588 html_header
589 user_box
590 . $PEOPLE/"$(GET user)"/account.conf
591 echo "<h2>$(get_gravatar $MAIL) $(GET user)</h2>"
592 if check_auth && [ "$(GET user)" == "$user" ]; then
593 auth_people
594 else
595 public_people
596 fi
597 html_footer ;;
598 *\ newbug\ *)
599 # Add a bug from web interface.
600 header
601 html_header
602 user_box
603 if check_auth; then
604 new_bug_page
605 else
606 echo "<p>$(gettext 'You must be logged in to post a new bug')</p>"
607 fi
608 html_footer ;;
609 *\ addbug\ *)
610 # Add a bug from web interface.
611 header
612 html_header
613 if check_auth; then
614 new_bug
615 js_redirection_to "$WEB_URL?id=$count"
616 fi ;;
617 *\ edit\ *)
618 bug="$(GET edit)"
619 header
620 html_header
621 user_box
622 edit_bug
623 html_footer ;;
624 *\ bugconf\ *)
625 header
626 html_header
627 if check_auth; then
628 save_bug
629 js_redirection_to "$WEB_URL?id=$bug"
630 fi ;;
631 *\ id\ *)
632 # Empty deleted messages to keep msg count working.
633 header
634 html_header
635 id="$(GET id)"
636 [ "$(GET close)" ] && close_bug
637 [ "$(GET open)" ] && open_bug
638 [ "$(GET msg)" ] && new_msg
639 [ "$(GET delmsg)" ] && rm -f $bugdir/$id/msg.$(GET delmsg) && \
640 touch $bugdir/$id/msg.$(GET delmsg)
641 msgs=$(fgrep MSG= $bugdir/$id/msg.* | wc -l)
642 user_box
643 . $bugdir/$id/bug.conf
644 bug_page
645 html_footer ;;
646 *\ signup\ *)
647 # Signup
648 header "Content-type: text/plain;"
649 user="$(GET signup)"
650 echo "Requested user login : $user"
651 if fgrep -q "$user:" $AUTH_FILE; then
652 echo "ERROR: User already exists" && exit 1
653 else
655 echo "Creating account for : $(GET name)"
656 new_user_config
657 fi ;;
658 *\ key\ *)
659 # Let user post new bug or message with crypted key (no gettext)
660 #
661 # Testing only and is security acceptable ?
662 #
663 key="$(GET key)"
664 id="$(GET bug)"
665 header "Content-type: text/plain;"
666 echo "Checking secure key..."
667 if fgrep -qH $key $PEOPLE/*/account.conf; then
668 conf=$(fgrep -H $key $PEOPLE/*/account.conf | cut -d ":" -f 1)
669 . $conf
670 echo "Authentified: $NAME ($USER)"
671 case " $(GET) " in
672 *\ msg\ *)
673 [ ! "$id" ] && echo "Missing bug ID" && exit 0
674 echo "Posting new message to bug: $id"
675 echo "Message: $(GET msg)"
676 new_msg ;;
677 *\ bug\ *)
678 echo "Adding new bug: $(GET bug)"
679 echo "Description: $(GET desc)"
680 new_bug ;;
681 esac
682 else
683 echo "Not a valid SliTaz user key"
684 exit 0
685 fi ;;
686 *\ search\ *)
687 header
688 html_header
689 user_box
690 cat << EOT
691 <h2>$(gettext "Search")</h2>
692 <form method="get" action="$WEB_URL">
693 <input type="text" name="search" />
694 <input type="submit" value="$(gettext 'Search')" />
695 </form>
696 <div>
697 EOT
699 #found=0 JS to notify or write results nb under the search box.
700 for bug in $bugdir/*
701 do
702 result=$(fgrep -i "$(GET search)" $bug/*)
703 if [ "$result" ]; then
704 #found=$(($found + 1))
705 id=${bug#bug/}
706 echo "<p><strong>Bug $id</strong> <a href=\"?id=$id\">"$(gettext 'Show')"</a></p>"
707 echo '<pre>'
708 fgrep -i "$(GET search)" $bugdir/$id/* | \
709 sed s"/$(GET search)/<span class='ok'>$(GET search)<\/span>/"g
710 echo '</pre>'
711 else
712 get_search=$(GET search)
713 echo "<p>$(eval_gettext 'No result found for: $get_search')</p>"
714 fi
715 done
716 echo '</div>'
717 html_footer ;;
718 *)
719 # Default page.
720 bugs=$(ls -1 $bugdir | wc -l)
721 close=$(fgrep "CLOSED" $bugdir/*/bug.conf | wc -l)
722 fixme=$(fgrep "OPEN" $bugdir/*/bug.conf | wc -l)
723 msgs=$(find $bugdir -name msg.* ! -size 0 | wc -l)
724 pct=0
725 [ $bugs -gt 0 ] && pct=$(( ($close * 100) / $bugs ))
726 header
727 html_header
728 user_box
729 cat << EOT
731 <h2>$(gettext "Summary")</h2>
733 <p>
734 $(eval_ngettext 'Bug: $bugs in total -' 'Bugs: $bugs in total -' $bugs)
735 $(eval_ngettext '$close fixed -' '$close fixed -' $close)
736 $(eval_ngettext '$fixme to fix -' '$fixme to fix -' $fixme)
737 $(eval_ngettext '$msgs message' '$msgs messages' $msgs)
738 </p>
740 <div class="pctbar">
741 <div class="pct" style="width: ${pct}%;">${pct}%</div>
742 </div>
744 <p>$(gettext "Please read the <a href=\"?README\">README</a> for help and more \
745 information. You may also be interested by the SliTaz \
746 <a href=\"http://roadmap.slitaz.org/\">Roadmap</a> and the packages \
747 <a href=\"http://cook.slitaz.org/\">Cooker</a>. To perform a search \
748 enter your term and press ENTER.")
749 </p>
751 <div id="tools">
752 <a href="?closed">$(gettext 'View closed bugs')</a>
753 EOT
754 if check_auth; then
755 echo "<a href='?newbug'>$(gettext 'Create a new bug')</a>"
756 fi
757 cat << EOT
758 </div>
759 EOT
760 list_bugs OPEN
761 html_footer ;;
762 esac
765 ###################################################
766 # Plugins
767 ###################################################
769 for p in $(ls -1 $plugins)
770 do
771 [ -f "$plugins/$p/$p.conf" ] && . $plugins/$p/$p.conf
772 [ -x "$plugins/$p/$p.cgi" ] && . $plugins/$p/$p.cgi
773 done
776 exit 0