home *** CD-ROM | disk | FTP | other *** search
/ Geek Gadgets 1 / ADE-1.bin / ade-bin / lib / cvs / contrib / rcs2log < prev    next >
Encoding:
Text File  |  1996-10-13  |  15.2 KB  |  609 lines
  1. #! /bin/sh
  2.  
  3. # RCS to ChangeLog generator
  4.  
  5. # Generate a change log prefix from RCS files and the ChangeLog (if any).
  6. # Output the new prefix to standard output.
  7. # You can edit this prefix by hand, and then prepend it to ChangeLog.
  8.  
  9. # Ignore log entries that start with `#'.
  10. # Clump together log entries that start with `{topic} ',
  11. # where `topic' contains neither white space nor `}'.
  12.  
  13. # Author: Paul Eggert <eggert@twinsun.com>
  14.  
  15. # $Id: rcs2log.sh,v 1.4 1996/09/29 20:38:31 woods Exp $
  16.  
  17. # Copyright 1992, 1993, 1994, 1995 Free Software Foundation, Inc.
  18.  
  19. # This program is free software; you can redistribute it and/or modify
  20. # it under the terms of the GNU General Public License as published by
  21. # the Free Software Foundation; either version 2, or (at your option)
  22. # any later version.
  23. # 
  24. # This program is distributed in the hope that it will be useful,
  25. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  26. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  27. # GNU General Public License for more details.
  28. # 
  29. # You should have received a copy of the GNU General Public License
  30. # along with this program; see the file COPYING.  If not, write to the
  31. # Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  32. # Boston, MA 02111-1307, USA.
  33.  
  34. tab='    '
  35. nl='
  36. '
  37.  
  38. # Parse options.
  39.  
  40. # defaults
  41. : ${AWK=awk}
  42. : ${TMPDIR=/tmp}
  43. hostname= # name of local host (if empty, will deduce it later)
  44. indent=8 # indent of log line
  45. length=79 # suggested max width of log line
  46. logins= # login names for people we know fullnames and mailaddrs of
  47. loginFullnameMailaddrs= # login<tab>fullname<tab>mailaddr triplets
  48. recursive= # t if we want recursive rlog
  49. rlog_options= # options to pass to rlog
  50. tabwidth=8 # width of horizontal tab
  51.  
  52. while :
  53. do
  54.     case $1 in
  55.     -i)    indent=${2?}; shift;;
  56.     -h)    hostname=${2?}; shift;;
  57.     -l)    length=${2?}; shift;;
  58.     -[nu])    # -n is obsolescent; it is replaced by -u.
  59.         case $1 in
  60.         -n)    case ${2?}${3?}${4?} in
  61.             *"$tab"* | *"$nl"*)
  62.                 echo >&2 "$0: -n '$2' '$3' '$4': tabs, newlines not allowed"
  63.                 exit 1
  64.             esac
  65.             loginFullnameMailaddrs=$loginFullnameMailaddrs$nl$2$tab$3$tab$4
  66.             shift; shift; shift;;
  67.         -u)
  68.             # If $2 is not tab-separated, use colon for separator.
  69.             case ${2?} in
  70.             *"$nl"*)
  71.                 echo >&2 "$0: -u '$2': newlines not allowed"
  72.                 exit 1;;
  73.             *"$tab"*)
  74.                 t=$tab;;
  75.             *)
  76.                 t=:
  77.             esac
  78.             case $2 in
  79.             *"$t"*"$t"*"$t"*)
  80.                 echo >&2 "$0: -u '$2': too many fields"
  81.                 exit 1;;
  82.             *"$t"*"$t"*)
  83.                 ;;
  84.             *)
  85.                 echo >&2 "$0: -u '$2': not enough fields"
  86.                 exit 1
  87.             esac
  88.             loginFullnameMailaddrs=$loginFullnameMailaddrs$nl$2
  89.             shift
  90.         esac
  91.         logins=$logins$nl$login
  92.         ;;
  93.     -r)    rlog_options=$rlog_options$nl${2?}; shift;;
  94.     -R)    recursive=t;;
  95.     -t)    tabwidth=${2?}; shift;;
  96.     -*)    echo >&2 "$0: usage: $0 [options] [file ...]
  97. Options:
  98.     [-h hostname] [-i indent] [-l length] [-R] [-r rlog_option]
  99.     [-t tabwidth] [-u 'login<TAB>fullname<TAB>mailaddr']..."
  100.         exit 1;;
  101.     *)    break
  102.     esac
  103.     shift
  104. done
  105.  
  106. month_data='
  107.     m[0]="Jan"; m[1]="Feb"; m[2]="Mar"
  108.     m[3]="Apr"; m[4]="May"; m[5]="Jun"
  109.     m[6]="Jul"; m[7]="Aug"; m[8]="Sep"
  110.     m[9]="Oct"; m[10]="Nov"; m[11]="Dec"
  111.  
  112.     # days in non-leap year thus far, indexed by month (0-12)
  113.     mo[0]=0; mo[1]=31; mo[2]=59; mo[3]=90
  114.     mo[4]=120; mo[5]=151; mo[6]=181; mo[7]=212
  115.     mo[8]=243; mo[9]=273; mo[10]=304; mo[11]=334
  116.     mo[12]=365
  117. '
  118.  
  119.  
  120. # Put rlog output into $rlogout.
  121.  
  122. # If no rlog options are given,
  123. # log the revisions checked in since the first ChangeLog entry.
  124. case $rlog_options in
  125. '')
  126.     date=1970-01-01
  127.     if test -s ChangeLog
  128.     then
  129.         # Add 1 to seconds to avoid duplicating most recent log.
  130.         e='
  131.             /^... ... [ 0-9][0-9] [ 0-9][0-9]:[0-9][0-9]:[0-9][0-9] [0-9]+ /{
  132.                 '"$month_data"'
  133.                 year = $5
  134.                 for (i=0; i<=11; i++) if (m[i] == $2) break
  135.                 dd = $3
  136.                 hh = substr($0,12,2)
  137.                 mm = substr($0,15,2)
  138.                 ss = substr($0,18,2)
  139.                 ss++
  140.                 if (ss == 60) {
  141.                     ss = 0
  142.                     mm++
  143.                     if (mm == 60) {
  144.                         mm = 0
  145.                         hh++
  146.                         if (hh == 24) {
  147.                             hh = 0
  148.                             dd++
  149.                             monthdays = mo[i+1] - mo[i]
  150.                             if (i == 1 && year%4 == 0 && (year%100 != 0 || year%400 == 0)) monthdays++
  151.                             if (dd == monthdays + 1) {
  152.                                 dd = 1
  153.                                 i++
  154.                                 if (i == 12) {
  155.                                     i = 0
  156.                                     year++
  157.                                 }
  158.                             }
  159.                         }
  160.                     }
  161.                 }
  162.                 # Output comma instead of space to avoid CVS 1.5 bug.
  163.                 printf "%d/%02d/%02d,%02d:%02d:%02d\n", year,i+1,dd,hh,mm,ss
  164.                 exit
  165.             }
  166.         '
  167.         d=`$AWK "$e" <ChangeLog` || exit
  168.         case $d in
  169.         ?*) date=$d
  170.         esac
  171.     fi
  172.     datearg="-d>$date"
  173. esac
  174.  
  175. # If CVS is in use, examine its repository, not the normal RCS files.
  176. if test ! -f CVS/Repository
  177. then
  178.     rlog=rlog
  179.     repository=
  180. else
  181.     rlog='cvs log'
  182.     repository=`sed 1q <CVS/Repository` || exit
  183.     test ! -f CVS/Root || CVSROOT=`cat <CVS/Root` || exit
  184.     case $CVSROOT in
  185.     *:/*)
  186.         # remote repository
  187.         ;;
  188.     *)
  189.         # local repository
  190.         case $repository in
  191.         /*) ;;
  192.         *) repository=${CVSROOT?}/$repository
  193.         esac
  194.         if test ! -d "$repository"
  195.         then
  196.             echo >&2 "$0: $repository: bad repository (see CVS/Repository)"
  197.             exit 1
  198.         fi
  199.     esac
  200. fi
  201.  
  202. # With no arguments, examine all files under the RCS directory.
  203. case $# in
  204. 0)
  205.     case $repository in
  206.     '')
  207.         oldIFS=$IFS
  208.         IFS=$nl
  209.         case $recursive in
  210.         t)
  211.             RCSdirs=`find . -name RCS -type d -print`
  212.             filesFromRCSfiles='s|,v$||; s|/RCS/|/|; s|^\./||'
  213.             files=`
  214.                 {
  215.                     case $RCSdirs in
  216.                     ?*) find $RCSdirs -type f -print
  217.                     esac
  218.                     find . -name '*,v' -print
  219.                 } |
  220.                 sort -u |
  221.                 sed "$filesFromRCSfiles"
  222.             `;;
  223.         *)
  224.             files=
  225.             for file in RCS/.* RCS/* .*,v *,v
  226.             do
  227.                 case $file in
  228.                 RCS/. | RCS/..) continue;;
  229.                 RCS/.\* | RCS/\* | .\*,v | \*,v) test -f "$file" || continue
  230.                 esac
  231.                 files=$files$nl$file
  232.             done
  233.             case $files in
  234.             '') exit 0
  235.             esac
  236.         esac
  237.         set x $files
  238.         shift
  239.         IFS=$oldIFS
  240.     esac
  241. esac
  242.  
  243. llogout=$TMPDIR/rcs2log$$l
  244. rlogout=$TMPDIR/rcs2log$$r
  245. trap exit 1 2 13 15
  246. trap "rm -f $llogout $rlogout; exit 1" 0
  247.  
  248. case $rlog_options in
  249. ?*) $rlog $rlog_options ${1+"$@"} >$rlogout;;
  250. '') $rlog "$datearg" ${1+"$@"} >$rlogout
  251. esac || exit
  252.  
  253.  
  254. # Get the full name of each author the logs mention, and set initialize_fullname
  255. # to awk code that initializes the `fullname' awk associative array.
  256. # Warning: foreign authors (i.e. not known in the passwd file) are mishandled;
  257. # you have to fix the resulting output by hand.
  258.  
  259. initialize_fullname=
  260. initialize_mailaddr=
  261.  
  262. case $loginFullnameMailaddrs in
  263. ?*)
  264.     case $loginFullnameMailaddrs in
  265.     *\"* | *\\*)
  266.         sed 's/["\\]/\\&/g' >$llogout <<EOF || exit
  267. $loginFullnameMailaddrs
  268. EOF
  269.         loginFullnameMailaddrs=`cat $llogout`
  270.     esac
  271.  
  272.     oldIFS=$IFS
  273.     IFS=$nl
  274.     for loginFullnameMailaddr in $loginFullnameMailaddrs
  275.     do
  276.         case $loginFullnameMailaddr in
  277.         *"$tab"*) IFS=$tab;;
  278.         *) IFS=:
  279.         esac
  280.         set x $loginFullnameMailaddr
  281.         login=$2
  282.         fullname=$3
  283.         mailaddr=$4
  284.         initialize_fullname="$initialize_fullname
  285.             fullname[\"$login\"] = \"$fullname\""
  286.         initialize_mailaddr="$initialize_mailaddr
  287.             mailaddr[\"$login\"] = \"$mailaddr\""
  288.     done
  289.     IFS=$oldIFS
  290. esac
  291.  
  292. case $llogout in
  293. ?*) sort -u -o $llogout <<EOF || exit
  294. $logins
  295. EOF
  296. esac
  297. output_authors='/^date: / {
  298.     if ($2 ~ /^[0-9]*[-\/][0-9][0-9][-\/][0-9][0-9]$/ && $3 ~ /^[0-9][0-9]:[0-9][0-9]:[0-9][0-9][-+0-9:]*;$/ && $4 == "author:" && $5 ~ /^[^;]*;$/) {
  299.         print substr($5, 1, length($5)-1)
  300.     }
  301. }'
  302. authors=`
  303.     $AWK "$output_authors" <$rlogout |
  304.     case $llogout in
  305.     '') sort -u;;
  306.     ?*) sort -u | comm -23 - $llogout
  307.     esac
  308. `
  309. case $authors in
  310. ?*)
  311.     cat >$llogout <<EOF || exit
  312. $authors
  313. EOF
  314.     initialize_author_script='s/["\\]/\\&/g; s/.*/author[\"&\"] = 1/'
  315.     initialize_author=`sed -e "$initialize_author_script" <$llogout`
  316.     awkscript='
  317.         BEGIN {
  318.             alphabet = "abcdefghijklmnopqrstuvwxyz"
  319.             ALPHABET = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
  320.             '"$initialize_author"'
  321.         }
  322.         {
  323.             if (author[$1]) {
  324.                 fullname = $5
  325.                 if (fullname ~ /[0-9]+-[^(]*\([0-9]+\)$/) {
  326.                     # Remove the junk from fullnames like "0000-Admin(0000)".
  327.                     fullname = substr(fullname, index(fullname, "-") + 1)
  328.                     fullname = substr(fullname, 1, index(fullname, "(") - 1)
  329.                 }
  330.                 if (fullname ~ /,[^ ]/) {
  331.                     # Some sites put comma-separated junk after the fullname.
  332.                     # Remove it, but leave "Bill Gates, Jr" alone.
  333.                     fullname = substr(fullname, 1, index(fullname, ",") - 1)
  334.                 }
  335.                 abbr = index(fullname, "&")
  336.                 if (abbr) {
  337.                     a = substr($1, 1, 1)
  338.                     A = a
  339.                     i = index(alphabet, a)
  340.                     if (i) A = substr(ALPHABET, i, 1)
  341.                     fullname = substr(fullname, 1, abbr-1) A substr($1, 2) substr(fullname, abbr+1)
  342.                 }
  343.  
  344.                 # Quote quotes and backslashes properly in full names.
  345.                 # Do not use gsub; traditional awk lacks it.
  346.                 quoted = ""
  347.                 rest = fullname
  348.                 for (;;) {
  349.                     p = index(rest, "\\")
  350.                     q = index(rest, "\"")
  351.                     if (p) {
  352.                         if (q && q<p) p = q
  353.                     } else {
  354.                         if (!q) break
  355.                         p = q
  356.                     }
  357.                     quoted = quoted substr(rest, 1, p-1) "\\" substr(rest, p, 1)
  358.                     rest = substr(rest, p+1)
  359.                 }
  360.  
  361.                 printf "fullname[\"%s\"] = \"%s%s\"\n", $1, quoted, rest
  362.                 author[$1] = 0
  363.             }
  364.         }
  365.     '
  366.  
  367.     initialize_fullname=`
  368.         (
  369.             cat /etc/passwd
  370.             for author in $authors
  371.             do nismatch $author passwd.org_dir
  372.             done
  373.             ypmatch $authors passwd
  374.         ) 2>/dev/null |
  375.         $AWK -F: "$awkscript"
  376.     `$initialize_fullname
  377. esac
  378.  
  379.  
  380. # Function to print a single log line.
  381. # We don't use awk functions, to stay compatible with old awk versions.
  382. # `Log' is the log message (with \n replaced by \r).
  383. # `files' contains the affected files.
  384. printlogline='{
  385.  
  386.     # Following the GNU coding standards, rewrite
  387.     #    * file: (function): comment
  388.     # to
  389.     #    * file (function): comment
  390.     if (Log ~ /^\([^)]*\): /) {
  391.         i = index(Log, ")")
  392.         files = files " " substr(Log, 1, i)
  393.         Log = substr(Log, i+3)
  394.     }
  395.  
  396.     # If "label: comment" is too long, break the line after the ":".
  397.     sep = " "
  398.     if ('"$length"' <= '"$indent"' + 1 + length(files) + index(Log, CR)) sep = "\n" indent_string
  399.  
  400.     # Print the label.
  401.     printf "%s*%s:", indent_string, files
  402.  
  403.     # Print each line of the log, transliterating \r to \n.
  404.     while ((i = index(Log, CR)) != 0) {
  405.         logline = substr(Log, 1, i-1)
  406.         if (logline ~ /[^'"$tab"' ]/) {
  407.             printf "%s%s\n", sep, logline
  408.         } else {
  409.             print ""
  410.         }
  411.         sep = indent_string
  412.         Log = substr(Log, i+1)
  413.     }
  414. }'
  415.  
  416. case $hostname in
  417. '')
  418.     hostname=`(
  419.         hostname || uname -n || uuname -l || cat /etc/whoami
  420.     ) 2>/dev/null` || {
  421.         echo >&2 "$0: cannot deduce hostname"
  422.         exit 1
  423.     }
  424.  
  425.     case $hostname in
  426.     *.*) ;;
  427.     *)
  428.         domainname=`(domainname) 2>/dev/null` &&
  429.         case $domainname in
  430.         *.*) hostname=$hostname.$domainname
  431.         esac
  432.     esac
  433. esac
  434.  
  435.  
  436. # Process the rlog output, generating ChangeLog style entries.
  437.  
  438. # First, reformat the rlog output so that each line contains one log entry.
  439. # Transliterate \n to \r so that multiline entries fit on a single line.
  440. # Discard irrelevant rlog output.
  441. $AWK <$rlogout '
  442.     BEGIN { repository = "'"$repository"'" }
  443.     /^RCS file:/ {
  444.         if (repository != "") {
  445.             filename = $3
  446.             if (substr(filename, 1, length(repository) + 1) == repository "/") {
  447.                 filename = substr(filename, length(repository) + 2)
  448.             }
  449.             if (filename ~ /,v$/) {
  450.                 filename = substr(filename, 1, length(filename) - 2)
  451.             }
  452.         }
  453.     }
  454.     /^Working file:/ { if (repository == "") filename = $3 }
  455.     /^date: /, /^(-----------*|===========*)$/ {
  456.         if ($0 ~ /^branches: /) { next }
  457.         if ($0 ~ /^date: [0-9][- +\/0-9:]*;/) {
  458.             date = $2
  459.             if (date ~ /-/) {
  460.                 # An ISO format date.  Replace all "-"s with "/"s.
  461.                 newdate = ""
  462.                 while ((i = index(date, "-")) != 0) {
  463.                     newdate = newdate substr(date, 1, i-1) "/"
  464.                     date = substr(date, i+1)
  465.                 }
  466.                 date = newdate date
  467.             }
  468.             # Ignore any time zone; ChangeLog has no room for it.
  469.             time = substr($3, 1, 8)
  470.             author = substr($5, 1, length($5)-1)
  471.             printf "%s %s %s %s %c", filename, date, time, author, 13
  472.             next
  473.         }
  474.         if ($0 ~ /^(-----------*|===========*)$/) { print ""; next }
  475.         printf "%s%c", $0, 13
  476.     }
  477. ' |
  478.  
  479. # Now each line is of the form
  480. # FILENAME YYYY/MM/DD HH:MM:SS AUTHOR \rLOG
  481. #    where \r stands for a carriage return,
  482. #    and each line of the log is terminated by \r instead of \n.
  483. # Sort the log entries, first by date+time (in reverse order),
  484. # then by author, then by log entry, and finally by file name (just in case).
  485. sort +1 -3r +3 +0 |
  486.  
  487. # Finally, reformat the sorted log entries.
  488. $AWK '
  489.     BEGIN {
  490.         # Some awk variants do not understand "\r" or "\013", so we have to
  491.         # put a carriage return directly in the file.
  492.         CR="" # <-- There is a single CR between the " chars here.
  493.  
  494.         # Initialize the fullname and mailaddr associative arrays.
  495.         '"$initialize_fullname"'
  496.         '"$initialize_mailaddr"'
  497.  
  498.         # Initialize indent string.
  499.         indent_string = ""
  500.         i = '"$indent"'
  501.         if (0 < '"$tabwidth"')
  502.             for (;  '"$tabwidth"' <= i;  i -= '"$tabwidth"')
  503.                 indent_string = indent_string "\t"
  504.         while (1 <= i--)
  505.             indent_string = indent_string " "
  506.  
  507.         # Set up date conversion tables.
  508.         # RCS uses a nice, clean, sortable format,
  509.         # but ChangeLog wants the traditional, ugly ctime format.
  510.  
  511.         # January 1, 0 AD (Gregorian) was Saturday = 6
  512.         EPOCH_WEEKDAY = 6
  513.         # Of course, there was no 0 AD, but the algorithm works anyway.
  514.  
  515.         w[0]="Sun"; w[1]="Mon"; w[2]="Tue"; w[3]="Wed"
  516.         w[4]="Thu"; w[5]="Fri"; w[6]="Sat"
  517.  
  518.         '"$month_data"'
  519.     }
  520.  
  521.     {
  522.         newlog = substr($0, 1 + index($0, CR))
  523.  
  524.         # Ignore log entries prefixed by "#".
  525.         if (newlog ~ /^#/) { next }
  526.  
  527.         if (Log != newlog || date != $2 || author != $4) {
  528.  
  529.             # The previous log and this log differ.
  530.  
  531.             # Print the old log.
  532.             if (date != "") '"$printlogline"'
  533.  
  534.             # Logs that begin with "{clumpname} " should be grouped together,
  535.             # and the clumpname should be removed.
  536.             # Extract the new clumpname from the log header,
  537.             # and use it to decide whether to output a blank line.
  538.             newclumpname = ""
  539.             sep = "\n"
  540.             if (date == "") sep = ""
  541.             if (newlog ~ /^\{[^'"$tab"' }]*}['"$tab"' ]/) {
  542.                 i = index(newlog, "}")
  543.                 newclumpname = substr(newlog, 1, i)
  544.                 while (substr(newlog, i+1) ~ /^['"$tab"' ]/) i++
  545.                 newlog = substr(newlog, i+1)
  546.                 if (clumpname == newclumpname) sep = ""
  547.             }
  548.             printf sep
  549.             clumpname = newclumpname
  550.  
  551.             # Get ready for the next log.
  552.             Log = newlog
  553.             if (files != "")
  554.                 for (i in filesknown)
  555.                     filesknown[i] = 0
  556.             files = ""
  557.         }
  558.         if (date != $2  ||  author != $4) {
  559.             # The previous date+author and this date+author differ.
  560.             # Print the new one.
  561.             date = $2
  562.             author = $4
  563.  
  564.             # Convert nice RCS date like "1992/01/03 00:03:44"
  565.             # into ugly ctime date like "Fri Jan  3 00:03:44 1992".
  566.             # Calculate day of week from Gregorian calendar.
  567.             i = index($2, "/")
  568.             year = substr($2, 1, i-1) + 0
  569.             monthday = substr($2, i+1)
  570.             i = index(monthday, "/")
  571.             month = substr(monthday, 1, i-1) + 0
  572.             day = substr(monthday, i+1) + 0
  573.             leap = 0
  574.             if (2 < month && year%4 == 0 && (year%100 != 0 || year%400 == 0)) leap = 1
  575.             days_since_Sunday_before_epoch = EPOCH_WEEKDAY + year * 365 + int((year + 3) / 4) - int((year + 99) / 100) + int((year + 399) / 400) + mo[month-1] + leap + day - 1
  576.  
  577.             # Print "date  fullname  (email address)".
  578.             # Get fullname and email address from associative arrays;
  579.             # default to author and author@hostname if not in arrays.
  580.             if (fullname[author])
  581.                 auth = fullname[author]
  582.             else
  583.                 auth = author
  584.             printf "%s %s %2d %s %d  %s  ", w[days_since_Sunday_before_epoch%7], m[month-1], day, $3, year, auth
  585.             if (mailaddr[author])
  586.                 printf "<%s>\n\n", mailaddr[author]
  587.             else
  588.                 printf "<%s@%s>\n\n", author, "'"$hostname"'"
  589.         }
  590.         if (! filesknown[$1]) {
  591.             filesknown[$1] = 1
  592.             if (files == "") files = " " $1
  593.             else files = files ", " $1
  594.         }
  595.     }
  596.     END {
  597.         # Print the last log.
  598.         if (date != "") {
  599.             '"$printlogline"'
  600.             printf "\n"
  601.         }
  602.     }
  603. ' &&
  604.  
  605.  
  606. # Exit successfully.
  607.  
  608. exec rm -f $llogout $rlogout
  609.