Merge lp:~broder/ubuntu/precise/pkgbinarymangler/relative-symlinks-899520 into lp:ubuntu/precise/pkgbinarymangler

[Evan Broder]

This merge adds a helper function for generating Policy-compliant symlinks to pkgstriptranslations and then uses it when creating the gnome-help and mallard langpack symlinks.

The original merge was right, but only by accident.

I used "<" instead of "<=" in two of the for loops. It turns out, though, that dh_link was using the $# sigil, which means "the index of the last element of the array" - i.e. "length minus 1", so "<" instead of "<=" is actually correct. Now that I've fulfilled my daily quotient of Perl insanity, I added a comment so that other people could follow along.

On further investigation, I realized the symlinks it was generating were right. Because the foo -> foo-langpack symlinks are between files at the same hierarchy level, you can verify that the symlinks are correct by noting that the number of ".." entries in the path is the same as the number of non-".." entries.

[Martin Pitt (pitti)]

Thank you!

review: Approve

=== modified file 'debian/changelog'
--- debian/changelog	2011-12-12 08:42:41 +0000
+++ debian/changelog	2011-12-12 10:13:34 +0000
@@ -1,8 +1,15 @@
 pkgbinarymangler (110) UNRELEASED; urgency=low
 
+  [ Martin Pitt ]
   * pkgstripfiles: Log how many seconds the PNG optimization took.
 
- -- Martin Pitt <[e-mail]>  Mon, 12 Dec 2011 09:42:25 +0100
+  [ Evan Broder ]
+  * pkgstriptranslations: Use a copy of the code from dh_link to make sure
+    pkgstriptranslations creates symlinks compliant with Debian
+    Policy. (LP: #899520)
+  * test/run: Adjust tests to expect relative symlinks.
+
+ -- Evan Broder <[e-mail]>  Mon, 12 Dec 2011 01:41:41 -0800
 
 pkgbinarymangler (109) precise; urgency=low
 

=== modified file 'pkgstriptranslations'
--- pkgstriptranslations	2011-11-15 14:24:07 +0000
+++ pkgstriptranslations	2011-12-12 10:13:34 +0000
@@ -4,6 +4,58 @@
 
 . ${PKGBINARYMANGLER_COMMON_PATH:-/usr/share/pkgbinarymangler}/common
 
+compliant_symlink() {
+    # Shell port of lines 184-222 of dh_link from debhelper
+    # 8.9.0ubuntu1
+    #
+    # This function must be called from the top-level of the package
+    local tmp src dest src_dirs dest_dirs x i
+
+    src="$(echo "$1" | sed -e 's,/+,/,g; s,^/,,')"
+    dest="$(echo "$2" | sed -e 's,/+,/,g; s,^/,,')"
+
+    # Make sure the directory the link will be in exists
+    mkdir -p "$(dirname "$dest")"
+
+    # Policy says that if the link is all within one toplevel
+    # directory, it should be relative. If it's between top level
+    # directories, leave it absolute.
+    IFS="/" read -ra src_dirs <<< "$src"
+    IFS="/" read -ra dest_dirs <<< "$dest"
+
+    if [ ${#src_dirs[@]} -gt 0 ] && [ "${src_dirs[0]}" = "${dest_dirs[0]}" ]; then
+        # Figure out how much of a path $src and $dest share in common
+        for (( x = 0; x < ${#src_dirs[@]}; x++ )); do
+            [ "${src_dirs[$x]}" = "${dest_dirs[$x]}" ] || break
+        done
+
+        # Build up the new src
+        src=""
+        # Note: use of < and not <= is deliberate here - the Perl
+        # version used $#dest_dirs, which is "the index of dest_dirs'
+        # last element" - i.e. length minus 1
+        for (( i = 1; i < (${#dest_dirs[@]} - x); i++ )); do
+            src="${src}../"
+        done
+        for (( i = x; i < ${#src_dirs[@]}; i++ )); do
+            src="${src}${src_dirs[$i]}/"
+        done
+        if [ $x -gt ${#src_dirs[@]} ] && [ "$src" = "" ]; then
+            src="." # special case
+        fi
+        src="${src%/}"
+    else
+        # Make sure it's properly absolute
+        src="/$src"
+    fi
+
+    if [ -d "$dest" ] && ! [ -L "$dest" ]; then
+        echo "pkgstriptranslations: link destination $dest is a directory"
+    fi
+    rm -f "$dest"
+    ln -sf "$src" "$dest"
+}
+
 # strip translations from .desktop files if they have a gettext domain (since
 # inline translations are preferred)
 desktop_files()
@@ -66,10 +118,9 @@
     pushd "$PKGDIR" >/dev/null
     (find usr/share/gnome/help -type f ! -wholename '*/C/*'; [ ! -d usr/share/omf ] || find usr/share/omf -type f -name '*.omf' ! -name '*-C.omf') | while read f; do
         install -D -m 644 "$f" "$tmp/_static/$PKGNAME/$f"
-        rm "$f"
         dest=${f/gnome\/help/gnome\/help-langpack}
         dest=${dest/share\/omf/share\/omf-langpack}
-        ln -s "/$dest" "$f"
+        compliant_symlink "$dest" "$f"
         [ ! -f DEBIAN/md5sums ] || sed -i "\& $f$&d" DEBIAN/md5sums
     done
     popd >/dev/null
@@ -116,9 +167,8 @@
     pushd "$PKGDIR" >/dev/null
     find usr/share/help -type f ! -wholename '*/C/*' | while read f; do
         install -D -m 644 "$f" "$tmp/_static/$PKGNAME/$f"
-        rm "$f"
         dest=${f/share\/help/share\/help-langpack}
-        ln -s "/$dest" "$f"
+        compliant_symlink "$dest" "$f"
         [ ! -f DEBIAN/md5sums ] || sed -i "\& $f$&d" DEBIAN/md5sums
     done
     popd >/dev/null

=== modified file 'test/run'
--- test/run	2011-11-29 09:18:32 +0000
+++ test/run	2011-12-12 10:13:34 +0000
@@ -1026,9 +1026,9 @@
 
         # translated de will be replaced with symlink to langpack
         self.assertEqual(c['vanilla']['./usr/share/gnome/help/vanilla/de/index.html']['linkto'],
-                '/usr/share/gnome/help-langpack/vanilla/de/index.html')
+                '../../../help-langpack/vanilla/de/index.html')
         self.assertEqual(c['vanilla']['./usr/share/gnome/help/vanilla/de/figures/main.png']['linkto'],
-                '/usr/share/gnome/help-langpack/vanilla/de/figures/main.png')
+                '../../../../help-langpack/vanilla/de/figures/main.png')
 
         # untranslated es will be replace with a symlink to C file
         self.assertEqual(c['vanilla']['./usr/share/gnome/help/vanilla/es/index.html']['linkto'],
@@ -1092,9 +1092,9 @@
 
         # translated de will be replaced with symlink to langpack
         self.assertEqual(c['vanilla']['./usr/share/help/de/vanilla/index.page']['linkto'],
-                '/usr/share/help-langpack/de/vanilla/index.page')
+                '../../../help-langpack/de/vanilla/index.page')
         self.assertEqual(c['vanilla']['./usr/share/help/de/vanilla/figures/main.png']['linkto'],
-                '/usr/share/help-langpack/de/vanilla/figures/main.png')
+                '../../../../help-langpack/de/vanilla/figures/main.png')
 
         # untranslated es will be replace with a symlink to C file
         self.assertEqual(c['vanilla']['./usr/share/help/es/vanilla/index.page']['linkto'],