R-sharp/R#/System/Components/ZipFolder.vb

#Region "Microsoft.VisualBasic::bf3679d459fd1b046e239235c691bca8, R#\System\Components\ZipFolder.vb"

    ' Author:
    ' 
    '       asuka (amethyst.asuka@gcmodeller.org)
    '       xie (genetics@smrucc.org)
    '       xieguigang (xie.guigang@live.com)
    ' 
    ' Copyright (c) 2018 GPL3 Licensed
    ' 
    ' 
    ' GNU GENERAL PUBLIC LICENSE (GPL3)
    ' 
    ' 
    ' This program is free software: you can redistribute it and/or modify
    ' it under the terms of the GNU General Public License as published by
    ' the Free Software Foundation, either version 3 of the License, or
    ' (at your option) any later version.
    ' 
    ' This program is distributed in the hope that it will be useful,
    ' but WITHOUT ANY WARRANTY; without even the implied warranty of
    ' MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    ' GNU General Public License for more details.
    ' 
    ' You should have received a copy of the GNU General Public License
    ' along with this program. If not, see <http://www.gnu.org/licenses/>.



    ' /********************************************************************************/

    ' Summaries:


    ' Code Statistics:

    '   Total Lines: 100
    '    Code Lines: 58 (58.00%)
    ' Comment Lines: 25 (25.00%)
    '    - Xml Docs: 40.00%
    ' 
    '   Blank Lines: 17 (17.00%)
    '     File Size: 3.51 KB


    '     Class ZipFolder
    ' 
    '         Properties: ls
    ' 
    '         Constructor: (+2 Overloads) Sub New
    ' 
    '         Function: ToString
    ' 
    '         Sub: (+2 Overloads) Dispose
    ' 
    ' 
    ' /********************************************************************************/

#End Region

Imports System.IO
Imports System.IO.Compression
Imports Microsoft.VisualBasic.ApplicationServices.Zip

Namespace Development.Components

    ''' <summary>
    ''' open zip for read data.
    ''' </summary>
    Public Class ZipFolder : Implements IDisposable

        Default Public ReadOnly Property Item(fileName As String) As Stream
            Get
                fileName = fileName.TrimStart("/"c, "\"c).Replace("\"c, "/"c)

                If allFiles.ContainsKey(fileName) Then
                    Return ZipStreamReader.Decompress(allFiles(fileName))
                Else
                    Return Nothing
                End If
            End Get
        End Property

        ReadOnly zip As ZipArchive
        ReadOnly allFiles As Dictionary(Of String, ZipArchiveEntry)

        ''' <summary>
        ''' populate all files inside internal of this zip file.
        ''' </summary>
        ''' <returns></returns>
        Public ReadOnly Property ls As String()
            Get
                Return allFiles.Keys.ToArray
            End Get
        End Property

        ''' <summary>
        ''' 
        ''' </summary>
        ''' <param name="zipFile"></param>
        Sub New(zipFile As String)
            Call Me.New(zipFile.Open(doClear:=False, [readOnly]:=True))
        End Sub

        Sub New(zipFile As Stream)
            zip = New ZipArchive(zipFile, ZipArchiveMode.Read)
            allFiles = New Dictionary(Of String, ZipArchiveEntry)

            For Each item As ZipArchiveEntry In zip.Entries
                Dim key As String = item.FullName _
                    .TrimStart("/"c, "\"c) _
                    .Replace("\"c, "/"c)

                If allFiles.ContainsKey(key) Then
                    Throw New DuplicateNameException(key)
                Else
                    allFiles.Add(key, item)
                End If
            Next
        End Sub

        Public Overrides Function ToString() As String
            Return zip.ToString
        End Function

#Region "IDisposable Support"
        Private disposedValue As Boolean ' 要检测冗余调用

        ' IDisposable
        Protected Overridable Sub Dispose(disposing As Boolean)
            If Not disposedValue Then
                If disposing Then
                    ' TODO: 释放托管状态(托管对象)。
                    zip.Dispose()
                End If

                ' TODO: 释放未托管资源(未托管对象)并在以下内容中替代 Finalize()。
                ' TODO: 将大型字段设置为 null。
            End If
            disposedValue = True
        End Sub

        ' TODO: 仅当以上 Dispose(disposing As Boolean)拥有用于释放未托管资源的代码时才替代 Finalize()。
        'Protected Overrides Sub Finalize()
        '    ' 请勿更改此代码。将清理代码放入以上 Dispose(disposing As Boolean)中。
        '    Dispose(False)
        '    MyBase.Finalize()
        'End Sub

        ' Visual Basic 添加此代码以正确实现可释放模式。
        Public Sub Dispose() Implements IDisposable.Dispose
            ' 请勿更改此代码。将清理代码放入以上 Dispose(disposing As Boolean)中。
            Dispose(True)
            ' TODO: 如果在以上内容中替代了 Finalize()，则取消注释以下行。
            ' GC.SuppressFinalize(Me)
        End Sub
#End Region

    End Class
End Namespace