Re: [PATCH] gnun-validate-html may break on ASCII art

[Ineiev]

On 08/19/2011 02:53 PM, Ineiev wrote:
> Next revision: expand also includes like '<!--#include file="...',
> make it work with relative paths of the included files, support
> ' and ` as well as " to quote the file name.

Few more refinements in gnun-validate-html.in.diff;
also, we'll need a change in validate-html-notify.in to be able
to link it to the gnun-validate-html version installed with
validate-html-notify rather than first found in $(PATH)
(validate-html-notify.in.diff). To do this, we need another
variable expanded in Makefile.am (edit), namely, $(bindir).
the last change is about making stamp-config.mk target work
with VPATH builds.

Index: gnun-validate-html.in
===================================================================
RCS file: 
/sources/trans-coord/trans-coord/gnun/server/gnun/gnun-validate-html.in,v
retrieving revision 1.9
diff -U 2 -r1.9 gnun-validate-html.in
--- gnun-validate-html.in       7 Jan 2010 14:43:04 -0000       1.9
+++ gnun-validate-html.in       20 Aug 2011 12:39:15 -0000
@@ -1,5 +1,5 @@
 #!/bin/bash
 
-# Copyright (C) 2008, 2009, 2010 Free Software Foundation, Inc.
+# Copyright (C) 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
 
 # This file is part of GNUnited Nations.
@@ -21,5 +21,5 @@
 cat <<EOF
 gnun-validate-html (@PACKAGE_NAME@) @PACKAGE_VERSION@
-Copyright (C) 2010 Free Software Foundation, Inc.
+Copyright (C) 2011 Free Software Foundation, Inc.
 You may redistribute copies of @PACKAGE_NAME@
 under the terms of the GNU General Public License.
@@ -69,18 +69,59 @@
 TMP1=`mktemp -t gnun.1.XXXXXX`
 TMP2=`mktemp -t gnun.2.XXXXXX`
-TMP3=`mktemp -t gnun.3.XXXXXX`
-trap "rm -f $TMP1 $TMP2 $TMP3" EXIT
+trap "rm -f $TMP1 $TMP2" EXIT
 
 # Expand input file's #include directives and save the result in
 # $TMP1.
-cat $1 > $TMP1
+cat > $TMP2 <<"EOF"
+# Limitations: CGI includes would be expanded in a wrong way
+BEGIN {
+  relative_dir_name = ARGV[1];
+  sub (/[^\/]*$/, "", relative_dir_name);
+  sub (/\/*$/, "/", relative_dir_name);
+}
+
+/<!--#include +(virtual)|(file)=["`']/ {
+  n = split ($0, names, "<!--#include ");
+  printf ("%s", names[1]);
+  for (i = 2; i <= n; i++)
+    {
+      # Extract the next included file name
+      if (names[i] !~ /^ *(virtual)|(file)=["'`]/)
+        {
+          # Pass it unchanged: this is not an Apache include directive
+          printf ("<!--#include %s", names[i]);
+          continue;
+        }
+      m = index (names[i], "-->");
+      if (m == 0) # This shouldn't happen: the "-->" must be on the same line
+        m = length (names[i]) + 1;
+      name = substr (names[i], 1, m-1);
+      # Absolute paths are not allowed with "file=" type of includes,
+      # but we process them in the same way for simplicity
+      sub (/^ *((virtual)|(file))=/, "", name);
+      quote_symbol = substr (name, 1, 1);
+      name = substr (name, 2);
+      sub (quote_symbol "[^" quote_symbol "]*$", "", name);
+
+      # Construct the real path to the file
+      if (name ~ /^\//)
+        name = root name;
+      else
+        name = relative_dir_name name;
+
+      # Invoke the script recursively
+      system ("@AWK@ -v script_name='" script_name "' -v root='" \
+               root "' -f '" script_name "' " name);
+
+      # Output the part remaining after the include directive
+      print (substr (names[i], m + 3));
+    }
+  next;
+}
+
+{ print; }
+EOF
 
-while true; do
-    grep --quiet '<!--#include virtual' $TMP1 || break
-    sed --in-place \
-      "s/<\!--#include virtual=\"\/\?\(.*\)\" -->/m4_include(\`\1')/g" $TMP1
-    @M4@ -P -EE -I $ROOT $TMP1 > $TMP3
-    cp $TMP3 $TMP1
-done
address@hidden@ -v script_name=$TMP2 -v root="$ROOT" -f $TMP2 $1 > $TMP1
 
 # Execute xmllint on $TMP1 and save its output to $TMP2.
@@ -98,5 +139,5 @@
 # expanded #include directives) and the translator can not easily look
 # up for references in it.
-cat $TMP2 | sed '
+cat $TMP2 | @SED@ '
   /line [[:digit:]]\+/ {
      p

Index: validate-html-notify.in
===================================================================
RCS file: 
/sources/trans-coord/trans-coord/gnun/server/gnun/validate-html-notify.in,v
retrieving revision 1.6
diff -U 2 -r1.6 validate-html-notify.in
--- validate-html-notify.in     7 Jan 2010 14:43:04 -0000       1.6
+++ validate-html-notify.in     20 Aug 2011 12:39:15 -0000
@@ -1,5 +1,5 @@
 #!/bin/bash
 
-# Copyright (C) 2008, 2009, 2010 Free Software Foundation, Inc.
+# Copyright (C) 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
 
 # This file is part of GNUnited Nations.
@@ -50,3 +50,4 @@
 SUBJ="[GNUN Error] ${FILE#../../} is not valid XHTML"
 
address@hidden@/mailfail $DRY_RUN "$RCPT" "$SUBJ" gnun-validate-html "$FILE"
address@hidden@/mailfail $DRY_RUN "$RCPT" "$SUBJ" \
+  @bindir@/gnun-validate-html "$FILE"

RCS file: /sources/trans-coord/trans-coord/gnun/server/gnun/Makefile.am,v
retrieving revision 1.17
diff -U 2 -r1.17 Makefile.am
--- Makefile.am 2 Aug 2010 13:54:11 -0000       1.17
+++ Makefile.am 20 Aug 2011 12:39:15 -0000
@@ -1,3 +1,3 @@
-# Copyright (C) 2008, 2009, 2010 Free Software Foundation, Inc.
+# Copyright (C) 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
 
 # This file is part of GNUnited Nations.
@@ -49,8 +49,12 @@
        -e 's|@address@hidden|$(PACKAGE_BUGREPORT)|g' \
        -e 's|@address@hidden|$(PACKAGE_URL)|g' \
+       -e 's|@address@hidden|$(bindir)|g' \
        -e 's|@address@hidden|$(pkgdatadir)|g' \
        -e 's|@address@hidden|$(prefix)|g' \
        -e 's|@address@hidden|$(pkglibexecdir)|g' \
-       -e 's|@address@hidden|$(M4)|g'
+       -e 's|@address@hidden|$(AWK)|g' \
+       -e 's|@address@hidden|$(GREP)|g' \
+       -e 's|@address@hidden|$(M4)|g' \
+       -e 's|@address@hidden|$(SED)|g'
 
 gnun-validate-html validate-html-notify: Makefile
@@ -60,5 +64,5 @@
        $(AM_V_at)mv address@hidden $@
 
-stamp-config.mk: $(srcdir)/config.mk
+stamp-config.mk: config.mk
        $(AM_V_GEN)$(edit) $< >$<.tmp
        $(AM_V_at)mv $<.tmp $<