lib-src/rcs2log

   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,v 1.15 1993/09/24 01:03:32 eggert Exp eggert $
  16
  17 # Copyright 1992, 1993 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
  31 # the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
  32
  33 nl='
  34 '
  35
  36 # Parse options.
  37
  38 # defaults
  39 : ${TMPDIR=/tmp}
  40 hostname= # name of local host (if empty, will deduce it later)
  41 indent=8 # indent of log line
  42 initialize_fullname= # awk assignments to set up fullname array
  43 initialize_mailaddr= # awk assignments to set up mailaddr array
  44 length=79 # suggested max width of log line
  45 logins= # login names for people we know fullnames and mailaddresses of
  46 loginsout= # temporary file holding sorted logins
  47 rlog_options= # options to pass to rlog
  48 tabwidth=8 # width of horizontal tab
  49
  50 while :
  51 do
  52         case $1 in
  53         -i)     indent=${2?};;
  54         -h)     hostname=${2?};;
  55         -l)     length=${2?};;
  56         -n)     logins=$logins$nl${2?}
  57                 loginsout=$TMPDIR/rcs2log$$l
  58                 case $2${3?}${4?} in
  59                 *\"* | *\\* | *"$nl"*)
  60                         echo >&2 "$0: -n '$2' '$3' '$4': special characters not allowed"
  61                         exit 1
  62                 esac
  63                 initialize_fullname="$initialize_fullname
  64                         fullname[\"$2\"] = \"$3\""
  65                 initialize_mailaddr="$initialize_mailaddr
  66                         mailaddr[\"$2\"] = \"$4\""
  67                 shift; shift;;
  68         -r)     rlog_options=$rlog_options$nl${2?};;
  69         -t)     tabwidth=${2?};;
  70         -*)     echo >&2 "$0: usage: $0 [options] [file ...]
  71 Options:
  72         [-h hostname] [-i indent] [-l length] [-n login fullname mailaddr]...
  73         [-r rlog_option]... [-t tabwidth]"
  74                 exit 1;;
  75         *)      break
  76         esac
  77         shift; shift
  78 done
  79
  80 month_data='
  81         m[0]="Jan"; m[1]="Feb"; m[2]="Mar"
  82         m[3]="Apr"; m[4]="May"; m[5]="Jun"
  83         m[6]="Jul"; m[7]="Aug"; m[8]="Sep"
  84         m[9]="Oct"; m[10]="Nov"; m[11]="Dec"
  85
  86         # days in non-leap year thus far, indexed by month (0-12)
  87         mo[0]=0; mo[1]=31; mo[2]=59; mo[3]=90
  88         mo[4]=120; mo[5]=151; mo[6]=181; mo[7]=212
  89         mo[8]=243; mo[9]=273; mo[10]=304; mo[11]=334
  90         mo[12]=365
  91 '
  92
  93
  94 # Log into $rlogout the revisions checked in since the first ChangeLog entry.
  95
  96 date=1970
  97 if test -s ChangeLog
  98 then
  99         # Add 1 to seconds to avoid duplicating most recent log.
 100         e='
 101                 /^... ... [ 0-9][0-9] [ 0-9][0-9]:[0-9][0-9]:[0-9][0-9] [0-9]+ /{
 102                         '"$month_data"'
 103                         year = $5
 104                         for (i=0; i<=11; i++) if (m[i] == $2) break
 105                         dd = $3
 106                         hh = substr($0,12,2)
 107                         mm = substr($0,15,2)
 108                         ss = substr($0,18,2)
 109                         ss++
 110                         if (ss == 60) {
 111                                 ss = 0
 112                                 mm++
 113                                 if (mm == 60) {
 114                                         mm = 0
 115                                         hh++
 116                                         if (hh == 24) {
 117                                                 hh = 0
 118                                                 dd++
 119                                                 monthdays = mo[i+1] - mo[i]
 120                                                 if (i == 1 && year%4 == 0 && (year%100 != 0 || year%400 == 0)) monthdays++
 121                                                 if (dd == monthdays + 1) {
 122                                                         dd = 1
 123                                                         i++
 124                                                         if (i == 12) {
 125                                                                 i = 0
 126                                                                 year++
 127                                                         }
 128                                                 }
 129                                         }
 130                                 }
 131                         }
 132                         printf "%d/%02d/%02d %02d:%02d:%02d\n", year, i+1, dd, hh, mm, ss
 133                         exit
 134                 }
 135         '
 136         d=`awk "$e" <ChangeLog` || exit
 137         case $d in
 138         ?*) date=$d
 139         esac
 140 fi
 141 datearg="-d>$date"
 142
 143 # With no arguments, examine all files under the RCS directory.
 144 case $# in
 145 0)
 146         files=
 147         for file in RCS/.* RCS/* .*,v *,v
 148         do
 149                 case $file in
 150                 RCS/. | RCS/..) continue;;
 151                 RCS/.\* | RCS/\* | .\*,v | \*,v) test -f "$file" || continue
 152                 esac
 153                 files=$files$nl$file
 154         done
 155         case $files in
 156         '') exit 0
 157         esac
 158         oldIFS=$IFS
 159         IFS=$nl
 160         set $files
 161         IFS=$oldIFS
 162 esac
 163
 164 rlogout=$TMPDIR/rcs2log$$r
 165 trap exit 1 2 13 15
 166 trap "rm -f $loginsout $rlogout; exit 1" 0
 167
 168 rlog "$datearg" $rlog_options "$@" >$rlogout || exit
 169
 170
 171 # Get the full name of each author the logs mention, and set initialize_fullname
 172 # to awk code that initializes the `fullname' awk associative array.
 173 # Warning: foreign authors (i.e. not known in the passwd file) are mishandled;
 174 # you have to fix the resulting output by hand.
 175
 176 case $loginsout in
 177 ?*) sort -u -o $loginsout <<EOF || exit
 178 $logins
 179 EOF
 180 esac
 181 authors=`
 182         sed -n 's|^date: *[0-9]*/[0-9][0-9]/[0-9][0-9] [0-9][0-9]:[0-9][0-9]:[0-9][0-9]; *author: *\([^; ]*\).*|\1|p' <$rlogout |
 183         case $loginsout in
 184         '') sort -u;;
 185         ?*) sort -u | comm -23 - $loginsout
 186         esac
 187 `
 188 case $authors in
 189 ?*)
 190         initialize_author=
 191         for author in $authors
 192         do
 193                 initialize_author="$initialize_author
 194                         author[\"$author\"] = 1
 195                 "
 196         done
 197         awkscript='
 198                 BEGIN {
 199                         alphabet = "abcdefghijklmnopqrstuvwxyz"
 200                         ALPHABET = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
 201                         '"$initialize_author"'
 202                 }
 203                 {
 204                         if (author[$1]) {
 205                                 fullname = $5
 206                                 if (fullname ~ /[0-9]+-[^(]*\([0-9]+\)$/) {
 207                                         # Remove the junk from fullnames like "0000-Admin(0000)".
 208                                         fullname = substr(fullname, index(fullname, "-") + 1)
 209                                         fullname = substr(fullname, 1, index(fullname, "(") - 1)
 210                                 }
 211                                 if (fullname ~ /,[^ ]/) {
 212                                         # Some sites put comma-separated junk after the fullname.
 213                                         # Remove it, but leave "Bill Gates, Jr" alone.
 214                                         fullname = substr(fullname, 1, index(fullname, ",") - 1)
 215                                 }
 216                                 abbr = index(fullname, "&")
 217                                 if (abbr) {
 218                                         a = substr($1, 1, 1)
 219                                         A = a
 220                                         i = index(alphabet, a)
 221                                         if (i) A = substr(ALPHABET, i, 1)
 222                                         fullname = substr(fullname, 1, abbr-1) A substr($1, 2) substr(fullname, abbr+1)
 223                                 }
 224                                 printf "fullname[\"%s\"] = \"%s\"\n", $1, fullname
 225                                 author[$1] = 0
 226                         }
 227                 }
 228         '
 229
 230         initialize_fullname=`
 231                 (cat /etc/passwd; ypmatch $authors passwd) 2>/dev/null |
 232                 awk -F: "$awkscript"
 233         `$initialize_fullname
 234 esac
 235
 236
 237 # Function to print a single log line.
 238 # We don't use awk functions, to stay compatible with old awk versions.
 239 # `Log' is the log message (with \n replaced by \r).
 240 # `files' contains the affected files.
 241 printlogline='{
 242
 243         # Following the GNU coding standards, rewrite
 244         #       * file: (function): comment
 245         # to
 246         #       * file (function): comment
 247         if (Log ~ /^\([^)]*\): /) {
 248                 i = index(Log, ")")
 249                 files = files " " substr(Log, 1, i)
 250                 Log = substr(Log, i+3)
 251         }
 252
 253         # If "label: comment" is too long, break the line after the ":".
 254         sep = " "
 255         if ('"$length"' <= '"$indent"' + 1 + length(files) + index(Log, CR)) sep = "\n" indent_string
 256
 257         # Print the label.
 258         printf "%s*%s:", indent_string, files
 259
 260         # Print each line of the log, transliterating \r to \n.
 261         while ((i = index(Log, CR)) != 0) {
 262                 logline = substr(Log, 1, i-1)
 263                 if (logline ~ /[^        ]/) {
 264                         printf "%s%s\n", sep, logline
 265                 } else {
 266                         print ""
 267                 }
 268                 sep = indent_string
 269                 Log = substr(Log, i+1)
 270         }
 271 }'
 272
 273 case $hostname in
 274 '')
 275         hostname=`(
 276                 hostname || uname -n || uuname -l || cat /etc/whoami
 277         ) 2>/dev/null` || {
 278                 echo >&2 "$0: cannot deduce hostname"
 279                 exit 1
 280         }
 281 esac
 282
 283
 284 # Process the rlog output, generating ChangeLog style entries.
 285
 286 # First, reformat the rlog output so that each line contains one log entry.
 287 # Transliterate \n to \r so that multiline entries fit on a single line.
 288 # Discard irrelevant rlog output.
 289 awk <$rlogout '
 290         /^Working file:/ { filename = $3 }
 291         /^date: /, /^(-----------*|===========*)$/ {
 292                 if ($0 ~ /^branches: /) { next }
 293                 if ($0 ~ /^date: [0-9][ \/0-9:]*;/) {
 294                         time = substr($3, 1, length($3)-1)
 295                         author = substr($5, 1, length($5)-1)
 296                         printf "%s %s %s %s %c", filename, $2, time, author, 13
 297                         next
 298                 }
 299                 if ($0 ~ /^(-----------*|===========*)$/) { print ""; next }
 300                 printf "%s%c", $0, 13
 301         }
 302 ' |
 303
 304 # Now each line is of the form
 305 # FILENAME YYYY/MM/DD HH:MM:SS AUTHOR \rLOG
 306 #       where \r stands for a carriage return,
 307 #       and each line of the log is terminated by \r instead of \n.
 308 # Sort the log entries, first by date+time (in reverse order),
 309 # then by author, then by log entry, and finally by file name (just in case).
 310 sort +1 -3r +3 +0 |
 311
 312 # Finally, reformat the sorted log entries.
 313 awk '
 314         BEGIN {
 315                 # Some awks do not understand "\r" or "\013", so we have to
 316                 # put a carriage return directly in the file.
 317                 CR="
" # <-- There is a single CR between the " chars here.
 318
 319                 # Initialize the fullname and mailaddr associative arrays.
 320                 '"$initialize_fullname"'
 321                 '"$initialize_mailaddr"'
 322
 323                 # Initialize indent string.
 324                 indent_string = ""
 325                 i = '"$indent"'
 326                 if (0 < '"$tabwidth"')
 327                         for (;  '"$tabwidth"' <= i;  i -= '"$tabwidth"')
 328                                 indent_string = indent_string "\t"
 329                 while (1 <= i--)
 330                         indent_string = indent_string " "
 331
 332                 # Set up date conversion tables.
 333                 # RCS uses a nice, clean, sortable format,
 334                 # but ChangeLog wants the traditional, ugly ctime format.
 335
 336                 # January 1, 0 AD (Gregorian) was Saturday = 6
 337                 EPOCH_WEEKDAY = 6
 338                 # Of course, there was no 0 AD, but the algorithm works anyway.
 339
 340                 w[0]="Sun"; w[1]="Mon"; w[2]="Tue"; w[3]="Wed"
 341                 w[4]="Thu"; w[5]="Fri"; w[6]="Sat"
 342
 343                 '"$month_data"'
 344         }
 345
 346         {
 347                 newlog = substr($0, 1 + index($0, CR))
 348
 349                 # Ignore log entries prefixed by "#".
 350                 if (newlog ~ /^#/) { next }
 351
 352                 if (Log != newlog || date != $2 || author != $4) {
 353
 354                         # The previous log and this log differ.
 355
 356                         # Print the old log.
 357                         if (date != "") '"$printlogline"'
 358
 359                         # Logs that begin with "{clumpname} " should be grouped together,
 360                         # and the clumpname should be removed.
 361                         # Extract the new clumpname from the log header,
 362                         # and use it to decide whether to output a blank line.
 363                         newclumpname = ""
 364                         sep = "\n"
 365                         if (date == "") sep = ""
 366                         if (newlog ~ /^\{[^      }]*}[   ]/) {
 367                                 i = index(newlog, "}")
 368                                 newclumpname = substr(newlog, 1, i)
 369                                 while (substr(newlog, i+1) ~ /^[         ]/) i++
 370                                 newlog = substr(newlog, i+1)
 371                                 if (clumpname == newclumpname) sep = ""
 372                         }
 373                         printf sep
 374                         clumpname = newclumpname
 375
 376                         # Get ready for the next log.
 377                         Log = newlog
 378                         if (files != "")
 379                                 for (i in filesknown)
 380                                         filesknown[i] = 0
 381                         files = ""
 382                 }
 383                 if (date != $2  ||  author != $4) {
 384                         # The previous date+author and this date+author differ.
 385                         # Print the new one.
 386                         date = $2
 387                         author = $4
 388
 389                         # Convert nice RCS date like "1992/01/03 00:03:44"
 390                         # into ugly ctime date like "Fri Jan  3 00:03:44 1992".
 391                         # Calculate day of week from Gregorian calendar.
 392                         i = index($2, "/")
 393                         year = substr($2, 1, i-1) + 0
 394                         monthday = substr($2, i+1)
 395                         i = index(monthday, "/")
 396                         month = substr(monthday, 1, i-1) + 0
 397                         day = substr(monthday, i+1) + 0
 398                         leap = 0
 399                         if (2 < month && year%4 == 0 && (year%100 != 0 || year%400 == 0)) leap = 1
 400                         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
 401
 402                         # Print "date  fullname  (email address)".
 403                         # Get fullname and email address from associative arrays;
 404                         # default to author and author@hostname if not in arrays.
 405                         if (fullname[author])
 406                                 auth = fullname[author]
 407                         else
 408                                 auth = author
 409                         printf "%s %s %2d %s %d  %s  ", w[days_since_Sunday_before_epoch%7], m[month-1], day, $3, year, auth
 410                         if (mailaddr[author])
 411                                 printf "(%s)\n\n", mailaddr[author]
 412                         else
 413                                 printf "(%s@%s)\n\n", author, "'"$hostname"'"
 414                 }
 415                 if (! filesknown[$1]) {
 416                         filesknown[$1] = 1
 417                         if (files == "") files = " " $1
 418                         else files = files ", " $1
 419                 }
 420         }
 421         END {
 422                 # Print the last log.
 423                 if (date != "") {
 424                         '"$printlogline"'
 425                         printf "\n"
 426                 }
 427         }
 428 ' &&
 429
 430
 431 # Exit successfully.
 432
 433 exec rm -f $loginsout $rlogout