winlnk 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d699909354195807a0b6d300658026db1e52e616
-  data.tar.gz: b8e3fd8963ef84caed6b84a7c63d403cb146e5b9
+  metadata.gz: 62d79fd0022714edcf75ebca7c62d4618ee7bec8
+  data.tar.gz: a415b7a951b807ce1024668944ee2d1b040c8556
 SHA512:
-  metadata.gz: 7280505f2676cc21b09add97b80cd3b1930e485868ac6eab1ec1aef497e2d257972a6794d200fa8423414defc79d4f4b014dd8dfee0055b746188807f0fd53c7
-  data.tar.gz: 9ef3ed9c34971b91ae4761981edea2ec100b3bbbc59cd9312bff95e98db13cc439bd3ae5d5ee56fc5372e3879d049a70158cc0418de24bf44bdc9da048c9c396
+  metadata.gz: 4ac603dfe9b4097ab7107703f60ad73f82c69b83b0dec231145291a6354dc258d03fa6a3f56e6ab18a978cfd2217824ef9b9acdd0d338043a8aa0245ab006d33
+  data.tar.gz: 5c5c25772657a052a916c310b8481dc0f8b2e07ecb76b2f9b71d0af461e9ff7374523498d639679d43bdaf3c8dd24473389b37db40fbab4ee365ff9dd2cd3b38

data/README

@@ -22,5 +22,5 @@ Usage
 
    To read the link target, create an instance and get its path attribute.
 
-      link = WinLnk.new("path/to/link.lnk")
+      link = WinLnk.new("path/to/link.lnk", "the ANSI code page")
       p link.path

data/lib/winlnk.rb

@@ -64,6 +64,22 @@ class WinLnk
 
   # Returns the LinkFlags of the link.
   attr_reader :flags
+  # Returns the attributes of the link target.
+  attr_reader :attributes
+  # Returns the creation time of the link target.
+  attr_reader :btime
+  # Returns the access time of the link target.
+  attr_reader :atime
+  # Returns the write time of the link target.
+  attr_reader :mtime
+  # Returns the least significant 32 bits of the size of the link target.
+  attr_reader :file_size
+  # Returns the index of the icon within the given icon location.
+  attr_reader :icon_index
+  # Returns the expected window state of an application launched by the link.
+  attr_reader :show_cmd
+  # Returns the shortcut key to activate the application launched by the link.
+  attr_reader :hot_key
   # Returns the path pointed to by the link.
   attr_reader :path
   # Returns the description of the link.
@@ -125,11 +141,13 @@ class WinLnk
     @atime = filetime2posixtime(times[3] << 32 | times[2])
     @mtime = filetime2posixtime(times[5] << 32 | times[4])
     @file_size, @icon_index, @show_cmd, @hot_key = data(0x34, 16).unpack("V3v")
-    reserved = data(0x44, 8).unpack("vV2")
+    _reserved = data(0x44, 8).unpack("vV2")
     return 0x4c
   end
 
   def filetime2posixtime(filetime)
+    # If the value is 0, the time is not set.
+    return nil if filetime == 0
     # Windows FILETIME is the time from 1601-01-01 in 100-nanosecond unit.
     filetime -= 116444736000000000
     return Time.at(filetime / 10000000, filetime % 10000000 / 10)
@@ -149,26 +167,41 @@ class WinLnk
   end
 
   def read_link_info(off)
-    len, = data(off, 4).unpack("V")
-    raise ParseError.new("Too short LinkInfo") if len < 0x1c
-    header_len, li_flags, vol_id_off, base_path_off,
-      net_rel_link_off, suffix_off = data(off + 4, 24).unpack("V6")
+    len, header_len = data(off, 8).unpack("V2")
+    raise ParseError.new("Too short LinkInfo header") if header_len < 0x1c
+    (li_flags, _vol_id_off, base_path_off, net_rel_link_off, suffix_off,
+     base_path_unicode_off, suffix_unicode_off) =
+      data(off + 8, header_len - 8).unpack("V7")
     if @@debug
       printf("LinkInfo header size: %u\n", header_len)
       printf("LinkInfo flags: %b\n", li_flags)
     end
 
+    printf("Unicode LocalBasePath: %p\n", base_path_unicode_off) if @@debug
+    printf("Unicode Suffix: %p\n", suffix_unicode_off) if @@debug
+    suffix = suffix_unicode_off ?
+               utf16z(off + suffix_unicode_off) : asciz(off + suffix_off)
     if li_flags & LI_FLAG_LOCAL != 0
-      base_path, = data_all(off + base_path_off).unpack("Z*")
-      suffix, = data_all(off + suffix_off).unpack("Z*")
-      @path = (base_path + suffix).force_encoding(@codepage)
-    end
-    if li_flags & LI_FLAG_NETWORK != 0
+      base_path = base_path_unicode_off ?
+                    utf16z(off + base_path_unicode_off) :
+                    asciz(off + base_path_off)
+      make_encodings_be_compatible(base_path, suffix)
+      @path = base_path << suffix
+    elsif li_flags & LI_FLAG_NETWORK != 0
       # Parse the CommonNetworkRelativeLink structure.
-      net_name_off, = data(off + net_rel_link_off + 8, 2).unpack("v")
-      net_name, = data_all(off + net_rel_link_off + net_name_off).unpack("Z*")
-      suffix, = data_all(off + suffix_off).unpack("Z*")
-      @path = (net_name + "\\" + suffix).force_encoding(@codepage)
+      net_name_off, = data(off + net_rel_link_off + 8, 4).unpack("V")
+      (_common_net_rel_link_size, _common_net_rel_link_flags,
+       net_name_off, _dev_name_off, _net_provider_type,
+       net_name_unicode_off, _dev_name_unicode_off) =
+        data(off + net_rel_link_off, net_name_off).unpack("V7")
+      printf("Unicode NetName: %p\n", net_name_unicode_off) if @@debug
+      net_name = net_name_unicode_off ?
+                   utf16z(off + net_rel_link_off + net_name_unicode_off) :
+                   asciz(off + net_rel_link_off + net_name_off)
+      make_encodings_be_compatible(net_name, suffix)
+      @path = net_name << "\\" << suffix
+    else
+      raise ParseError.new("Unknown LinkInfoFlags")
     end
     return off + len
   end
@@ -185,14 +218,35 @@ class WinLnk
     end
   end
 
+  def asciz(off)
+    # Check if "@#{off}" does not go out of the string.
+    raise ParseError.new("Truncated file") if @data.size < off
+    str = @data.unpack("@#{off} Z*")[0]
+    # Check if the terminating null character existed.
+    raise ParseError.new("Truncated file") if @data.size - off <= str.bytesize
+    return str.force_encoding(@codepage)
+  end
+
+  def utf16z(off)
+    zz = off
+    while @data.size >= zz + 2
+      if @data.getbyte(zz) == 0 && @data.getbyte(zz + 1) == 0
+        return @data[off...zz].encode!("UTF-8", "UTF-16LE")
+      end
+      zz += 2
+    end
+    raise ParseError.new("Truncated file")
+  end
+
   def data(off, len)
     raise ParseError.new("Truncated file") if @data.size < off + len
     return @data[off, len]
   end
 
-  def data_all(off)
-    raise ParseError.new("Truncated file") if @data.size < off
-    return @data[off..-1]
+  def make_encodings_be_compatible(a, b)
+    return if Encoding::compatible?(a, b)
+    a.encode!("UTF-8")
+    b.encode!("UTF-8")
   end
 
   # This exception is raised when failed to parse a link.

data/test/test_internal.rb

@@ -0,0 +1,85 @@
+#
+# Copyright (c) 2019 KAMADA Ken'ichi.
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+# 1. Redistributions of source code must retain the above copyright
+#    notice, this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright
+#    notice, this list of conditions and the following disclaimer in the
+#    documentation and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+# SUCH DAMAGE.
+#
+
+require "test/unit"
+require "winlnk"
+
+class TestInternal < Test::Unit::TestCase
+  def test_filetime2posixtime
+    # A dummy file.
+    lnk = WinLnk.new("test/local_cmd.lnk", "US-ASCII")
+    assert_equal(Time.utc(1970, 1, 1, 0, 0, 0),
+                 lnk.send(:filetime2posixtime, 116444736000000000))
+    assert_equal(Time.utc(1970, 1, 1, 0, 0, 0),
+                 lnk.send(:filetime2posixtime, 116444736000000009))
+    assert_equal(Time.utc(1970, 1, 1, 0, 0, 0, 1),
+                 lnk.send(:filetime2posixtime, 116444736000000010))
+    assert_equal(Time.utc(1970, 1, 1, 0, 0, 0, 999999),
+                 lnk.send(:filetime2posixtime, 116444736009999990))
+    assert_equal(Time.utc(1970, 1, 1, 0, 0, 0, 999999),
+                 lnk.send(:filetime2posixtime, 116444736009999999))
+    assert_equal(Time.utc(1970, 1, 1, 0, 0, 1),
+                 lnk.send(:filetime2posixtime, 116444736010000000))
+    assert_equal(Time.utc(2014, 6, 21, 4, 36, 55),
+                 lnk.send(:filetime2posixtime, 130477990150000000))
+  end
+
+  def test_asciz
+    lnk = WinLnk.new("test/local_cmd.lnk", "US-ASCII")
+    asciz = ->(data, off) do
+      lnk.instance_variable_set(:@data, data)
+      return lnk.send(:asciz, off)
+    end
+
+    assert_equal("abc", asciz.call("abc\0def\0".b, 0))
+    assert_equal("bc", asciz.call("abc\0def\0".b, 1))
+    assert_equal("", asciz.call("abc\0def\0".b, 3))
+    assert_equal("def", asciz.call("abc\0def\0".b, 4))
+    assert_equal("", asciz.call("abc\0def\0".b, 7))
+    assert_raise(WinLnk::ParseError) { asciz.call("abc\0def\0".b, 8) }
+    assert_raise(WinLnk::ParseError) { asciz.call("".b, 1) }
+    assert_raise(WinLnk::ParseError) { asciz.call("abc".b, 0) }
+  end
+
+  def test_utf16z
+    lnk = WinLnk.new("test/local_cmd.lnk", "US-ASCII")
+    utf16z = ->(data, off) do
+      lnk.instance_variable_set(:@data, data)
+      return lnk.send(:utf16z, off)
+    end
+
+    assert_equal("ab", utf16z.call("a\0b\0\0\0c\0d\0\0\0".b, 0))
+    assert_equal("ab", utf16z.call("\0a\0b\0\0\0c\0d\0\0\0".b, 1))
+    assert_equal("cd", utf16z.call("a\0b\0\0\0c\0d\0\0\0".b, 6))
+    assert_equal("abc\0\0def".encode("UTF-8", "UTF-16LE"),
+                 utf16z.call("abc\0\0def\0\0".b, 0))
+    assert_equal("", utf16z.call("\0\0".b, 0))
+    assert_equal("a", utf16z.call("\n\0a\0\0\0".b, 2))
+    assert_raise(WinLnk::ParseError) { utf16z.call("\0", 0) }
+    assert_raise(WinLnk::ParseError) { utf16z.call("", 0) }
+    assert_raise(WinLnk::ParseError) { utf16z.call("", 1) }
+  end
+end

data/test/test_specimen.rb

@@ -0,0 +1,156 @@
+#
+# Copyright (c) 2019 KAMADA Ken'ichi.
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+# 1. Redistributions of source code must retain the above copyright
+#    notice, this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright
+#    notice, this list of conditions and the following disclaimer in the
+#    documentation and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+# SUCH DAMAGE.
+#
+
+require "test/unit"
+require "winlnk"
+
+class TestSpecimen < Test::Unit::TestCase
+  def test_local_cmd
+    lnk = WinLnk.new("test/local_cmd.lnk", "Windows-31J")
+
+    assert_equal('C:\Windows\System32\cmd with space.exe', lnk.path)
+    assert_equal('This is a comment.', lnk.description)
+    assert_equal('..\Windows\System32\cmd with space.exe', lnk.relative_path)
+    assert_equal('C:\Windows\System32', lnk.working_directory)
+    assert_equal('arg1 "arg 2"', lnk.arguments)
+    assert_equal(nil, lnk.icon_location)
+
+    assert_equal(0x2020, lnk.attributes)
+    assert_equal(Time.utc(2019,  7,  1, 14, 00, 40, 918391), lnk.btime)
+    assert_equal(Time.utc(2019,  7,  1, 14, 00, 40, 918391), lnk.atime)
+    assert_equal(Time.utc(2014, 10, 29,  1, 28, 18, 835387), lnk.mtime)
+    assert_equal(357376, lnk.file_size)
+    assert_equal(0, lnk.icon_index)
+    assert_equal(WinLnk::SW_SHOWNORMAL, lnk.show_cmd)
+    assert_equal(0, lnk.hot_key)
+  end
+
+  def test_local_win31j
+    lnk = WinLnk.new("test/local_win31j.lnk", "Windows-31J")
+
+    # Default code page
+    assert_equal('C:\Temp\リンク先.txt'.encode("Windows-31J"), lnk.path)
+    # UTF-8
+    assert_equal('コメント', lnk.description)
+    assert_equal('.\リンク先.txt', lnk.relative_path)
+    assert_equal('C:\Temp', lnk.working_directory)
+    assert_equal(nil, lnk.arguments)
+    assert_equal('%SystemRoot%\system32\SHELL32.dll', lnk.icon_location)
+
+    assert_equal(0x2020, lnk.attributes)
+    assert_equal(Time.utc(2019,  6, 30, 13, 51, 53, 537221), lnk.btime)
+    assert_equal(Time.utc(2019,  6, 30, 13, 51, 53, 537221), lnk.atime)
+    assert_equal(Time.utc(2019,  6, 30, 13, 52,  1, 861622), lnk.mtime)
+    assert_equal(10, lnk.file_size)
+    assert_equal(70, lnk.icon_index)
+    assert_equal(WinLnk::SW_SHOWNORMAL, lnk.show_cmd)
+    assert_equal(0, lnk.hot_key)
+  end
+
+  def test_local_unicode
+    lnk = WinLnk.new("test/local_unicode.lnk", "Windows-31J")
+
+    assert_equal('C:\Temp\💎.txt', lnk.path)
+    assert_equal(nil, lnk.description)
+    assert_equal('.\💎.txt', lnk.relative_path)
+    assert_equal('C:\Temp', lnk.working_directory)
+    assert_equal(nil, lnk.arguments)
+    assert_equal(nil, lnk.icon_location)
+
+    assert_equal(0x2020, lnk.attributes)
+    assert_equal(Time.utc(2019,  7,  8, 14,  5, 42, 626696), lnk.btime)
+    assert_equal(Time.utc(2019,  7,  8, 14,  5, 42, 626696), lnk.atime)
+    assert_equal(Time.utc(2019,  7,  8, 14,  5, 42, 626696), lnk.mtime)
+    assert_equal(0, lnk.file_size)
+    assert_equal(0, lnk.icon_index)
+    assert_equal(WinLnk::SW_SHOWNORMAL, lnk.show_cmd)
+    assert_equal(0, lnk.hot_key)
+  end
+
+  def test_net_win31j
+    lnk = WinLnk.new("test/net_win31j.lnk", "Windows-31J")
+
+    # Default code page
+    assert_equal('\\\\TEST\SHARE\リンク先.txt'.encode("Windows-31J"), lnk.path)
+    # UTF-8
+    assert_equal(nil, lnk.description)
+    assert_equal(nil, lnk.relative_path)
+    assert_equal('\\\\test\share', lnk.working_directory)
+    assert_equal(nil, lnk.arguments)
+    assert_equal(nil, lnk.icon_location)
+
+    assert_equal(0x80, lnk.attributes)
+    assert_equal(Time.utc(2019,  7,  8, 14,  4, 50,  25776), lnk.btime)
+    assert_equal(Time.utc(2019,  7,  8, 14,  5, 30, 183680), lnk.atime)
+    assert_equal(Time.utc(2019,  7,  8, 14,  4, 50,  25776), lnk.mtime)
+    assert_equal(10, lnk.file_size)
+    assert_equal(0, lnk.icon_index)
+    assert_equal(WinLnk::SW_SHOWNORMAL, lnk.show_cmd)
+    assert_equal(0, lnk.hot_key)
+  end
+
+  # Unicode in Suffix.
+  def test_net_unicode
+    lnk = WinLnk.new("test/net_unicode.lnk", "Windows-31J")
+
+    assert_equal('\\\\TEST\SHARE\💎.txt', lnk.path)
+    assert_equal(nil, lnk.description)
+    assert_equal(nil, lnk.relative_path)
+    assert_equal('\\\\test\share', lnk.working_directory)
+    assert_equal(nil, lnk.arguments)
+    assert_equal(nil, lnk.icon_location)
+
+    assert_equal(0x80, lnk.attributes)
+    assert_equal(Time.utc(2019,  7,  8, 14,  5, 42, 626696), lnk.btime)
+    assert_equal(Time.utc(2019,  7,  8, 14,  6, 30, 215037), lnk.atime)
+    assert_equal(Time.utc(2019,  7,  8, 14,  5, 42, 626696), lnk.mtime)
+    assert_equal(0, lnk.file_size)
+    assert_equal(0, lnk.icon_index)
+    assert_equal(WinLnk::SW_SHOWNORMAL, lnk.show_cmd)
+    assert_equal(0, lnk.hot_key)
+  end
+
+  # Unicode in NetName.
+  def test_net_unicode2
+    lnk = WinLnk.new("test/net_unicode2.lnk", "Windows-31J")
+
+    assert_equal('\\\\TEST\📂\リンク先.txt', lnk.path)
+    assert_equal(nil, lnk.description)
+    assert_equal(nil, lnk.relative_path)
+    assert_equal('\\\\test\📂', lnk.working_directory)
+    assert_equal(nil, lnk.arguments)
+    assert_equal(nil, lnk.icon_location)
+
+    assert_equal(0x80, lnk.attributes)
+    assert_equal(Time.utc(2019,  7,  8, 14,  4, 50,  25776), lnk.btime)
+    assert_equal(Time.utc(2019,  7,  9, 13, 31,  7, 978921), lnk.atime)
+    assert_equal(Time.utc(2019,  7,  8, 14,  4, 50,  25776), lnk.mtime)
+    assert_equal(10, lnk.file_size)
+    assert_equal(0, lnk.icon_index)
+    assert_equal(WinLnk::SW_SHOWNORMAL, lnk.show_cmd)
+    assert_equal(0, lnk.hot_key)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: winlnk
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - KAMADA Ken'ichi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-26 00:00:00.000000000 Z
+date: 2019-07-10 00:00:00.000000000 Z
 dependencies: []
 description: |
   This is a library to parse Windows Shell Link (shortcut or .lnk) files
@@ -21,7 +21,15 @@ files:
 - README
 - Rakefile
 - lib/winlnk.rb
+- test/local_cmd.lnk
+- test/local_unicode.lnk
+- test/local_win31j.lnk
+- test/net_unicode.lnk
+- test/net_unicode2.lnk
+- test/net_win31j.lnk
 - test/test_error.rb
+- test/test_internal.rb
+- test/test_specimen.rb
 homepage: https://github.com/kamadak/winlnk-rb
 licenses:
 - BSD-2-Clause
@@ -34,7 +42,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -42,7 +50,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.14.4
 signing_key: 
 specification_version: 4
 summary: Library to read Windows Shell Link (shortcut or .lnk) files