File: HDF5ArchiveTraverser.java

package info (click to toggle)
libsis-jhdf5-java 19.04.0%2Bdfsg-4
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 8,668 kB
  • sloc: java: 79,644; ansic: 18,986; sh: 309; makefile: 49; xml: 12
file content (187 lines) | stat: -rw-r--r-- 6,813 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
/*
 * Copyright 2007 - 2018 ETH Zuerich, CISD and SIS.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package ch.systemsx.cisd.hdf5.h5ar;

import java.io.File;
import java.io.IOException;

import hdf.hdf5lib.exceptions.HDF5Exception;

import ch.systemsx.cisd.base.exceptions.IErrorStrategy;
import ch.systemsx.cisd.hdf5.IHDF5Reader;

/**
 * A traverser for <code>h5ar</code> archives.
 * 
 * @author Bernd Rinn
 */
class HDF5ArchiveTraverser
{
    interface IDirectoryChecker
    {
        boolean isDirectoryFollowSymlinks(ArchiveEntry entry);
    }

    private final IHDF5Reader hdf5Reader;

    private final IDirectoryIndexProvider indexProvider;

    private final IErrorStrategy errorStrategy;

    private final IdCache idCache;

    private final IDirectoryChecker directoryChecker;

    public HDF5ArchiveTraverser(IDirectoryChecker directoryChecker, IHDF5Reader hdf5Reader,
            IDirectoryIndexProvider indexProvider, IdCache idCache)
    {
        this.directoryChecker = directoryChecker;
        this.hdf5Reader = hdf5Reader;
        this.indexProvider = indexProvider;
        this.errorStrategy = indexProvider.getErrorStrategy();
        this.idCache = idCache;
    }

    public void process(String fileOrDir, boolean recursive, boolean readLinkTargets,
            boolean followSymlinks, IArchiveEntryProcessor processor)
    {
        final String normalizedPath = Utils.normalizePath(fileOrDir);
        final boolean isDirectory = hdf5Reader.object().isGroup(normalizedPath, followSymlinks);
        final boolean effectiveReadLinkTargets = readLinkTargets | followSymlinks;

        final String parentPath = Utils.getParentPath(normalizedPath);
        LinkRecord link = null;
        if (parentPath.length() > 0)
        {
            link =
                    indexProvider.get(parentPath, effectiveReadLinkTargets).tryGetLink(
                            getNameFromPath(normalizedPath, parentPath));
            if (link == null)
            {
                errorStrategy.dealWithError(processor.createException(normalizedPath,
                        "Object not found in archive."));
                return;
            }
            try
            {
                if (processor.process(parentPath, normalizedPath, link, hdf5Reader, idCache,
                        errorStrategy) == false)
                {
                    return;
                }
            } catch (IOException ex)
            {
                final File f = new File(normalizedPath);
                errorStrategy.dealWithError(processor.createException(f, ex));
            } catch (HDF5Exception ex)
            {
                errorStrategy.dealWithError(processor.createException(normalizedPath, ex));
            }
        }
        if (isDirectory)
        {
            processDirectory(normalizedPath, recursive, effectiveReadLinkTargets, followSymlinks,
                    processor);
            postProcessDirectory(parentPath, normalizedPath, link, processor);
        }
    }

    private String getNameFromPath(final String normalizedPath, final String parentPath)
    {
        return normalizedPath.substring(parentPath.length() == 1 ? 1 : parentPath.length() + 1);
    }

    private void postProcessDirectory(final String parentPath, final String normalizedPath,
            LinkRecord linkOrNull, IArchiveEntryProcessor processor)
    {
        if (linkOrNull != null)
        {
            try
            {
                processor.postProcessDirectory(parentPath, normalizedPath, linkOrNull, hdf5Reader,
                        idCache, errorStrategy);
            } catch (IOException ex)
            {
                final File f = new File(normalizedPath);
                errorStrategy.dealWithError(processor.createException(f, ex));
            } catch (HDF5Exception ex)
            {
                errorStrategy.dealWithError(processor.createException(normalizedPath, ex));
            }
        }
    }

    /**
     * Provide the entries of <var>normalizedDir</var> to <var>processor</var>.
     */
    private void processDirectory(String normalizedDir, boolean recursive, boolean readLinkTargets,
            boolean followSymlinks, IArchiveEntryProcessor processor)
    {
        if (hdf5Reader.object().exists(normalizedDir, followSymlinks) == false)
        {
            if (hdf5Reader.object().exists(normalizedDir, false) == false)
            {
                errorStrategy.dealWithError(processor.createException(normalizedDir,
                        "Directory not found in archive."));
            }
            return;
        }
        for (LinkRecord link : indexProvider.get(normalizedDir, readLinkTargets))
        {
            final String path = Utils.concatLink(normalizedDir, link.getLinkName());
            try
            {
                if (processor
                        .process(normalizedDir, path, link, hdf5Reader, idCache, errorStrategy) == false)
                {
                    continue;
                }
                if (recursive && isDirectory(path, link, followSymlinks))
                {
                    processDirectory(path, recursive, readLinkTargets, followSymlinks, processor);
                    postProcessDirectory(normalizedDir, path, link, processor);
                }
            } catch (IOException ex)
            {
                final File f = new File(path);
                errorStrategy.dealWithError(processor.createException(f, ex));
            } catch (HDF5Exception ex)
            {
                errorStrategy.dealWithError(processor.createException(path, ex));
            }
        }
    }

    private boolean isDirectory(String path, LinkRecord link, boolean followSymlinks)
    {
        if (link.isDirectory() == false && followSymlinks)
        {
            return directoryChecker.isDirectoryFollowSymlinks(toArchiveEntry(path, link));
        } else
        {
            return link.isDirectory();
        }
    }

    private ArchiveEntry toArchiveEntry(String path, LinkRecord linkRecord)
    {
        final String normalizedPath = Utils.normalizePath(path);
        final String parentPath = Utils.getParentPath(normalizedPath);
        return Utils.tryToArchiveEntry(parentPath, normalizedPath, linkRecord, idCache);
    }

}