File: nfileinfo.cpp

package info (click to toggle)
regina-normal 4.6-1.1
  • links: PTS
  • area: main
  • in suites: squeeze
  • size: 18,696 kB
  • ctags: 8,499
  • sloc: cpp: 71,120; ansic: 12,923; sh: 10,624; perl: 3,294; makefile: 959; python: 188
file content (209 lines) | stat: -rw-r--r-- 6,953 bytes parent folder | download
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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209

/**************************************************************************
 *                                                                        *
 *  Regina - A Normal Surface Theory Calculator                           *
 *  Computational Engine                                                  *
 *                                                                        *
 *  Copyright (c) 1999-2009, Ben Burton                                   *
 *  For further details contact Ben Burton (bab@debian.org).              *
 *                                                                        *
 *  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 2 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, write to the Free            *
 *  Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,       *
 *  MA 02110-1301, USA.                                                   *
 *                                                                        *
 **************************************************************************/

/* end stub */

#include <cstdio>
#include <cstring>
#include <sstream>
#include "file/nfile.h"
#include "file/nfileinfo.h"
#include "utilities/zstream.h"

namespace regina {

#define STARTS_FALSE 0
#define STARTS_TRUE 1
#define STARTS_COULD_NOT_OPEN 2

const int NFileInfo::TYPE_BINARY = 1;
const int NFileInfo::TYPE_XML = 2;

namespace {
    /**
     * Does the given file begin with the given set of characters?
     *
     * Returns STARTS_FALSE, STARTS_TRUE or STARTS_COULD_NOT_OPEN.
     */
    int fileStartsWith(const char* file, const char* prefix) {
        FILE* f = fopen(file, "rb");
        if (! f)
            return STARTS_COULD_NOT_OPEN;

        int ans = STARTS_FALSE;
        unsigned len = strlen(prefix);
        char* buf = new char[len];

        if (fread(buf, sizeof(char), len, f) == len)
            if (strncmp(buf, prefix, len) == 0)
                ans = STARTS_TRUE;

        delete[] buf;
        fclose(f);
        return ans;
    }
}

NFileInfo* NFileInfo::identify(const std::string& idPathname) {
    // Check for an old-style binary file.
    int starts = fileStartsWith(idPathname.c_str(), "Normal");
    if (starts == STARTS_FALSE)
        starts = fileStartsWith(idPathname.c_str(), "Regina");

    if (starts == STARTS_COULD_NOT_OPEN)
        return 0;
    else if (starts == STARTS_TRUE) {
        NFileInfo* ans = new NFileInfo();
        ans->pathname = idPathname;
        ans->type = NFileInfo::TYPE_BINARY;
        ans->typeDescription = "Binary Regina data file (obsolete format)";
        ans->compressed = false;

        regina::NFile file;
        if (! file.open(idPathname.c_str(),
                regina::NRandomAccessResource::READ)) {
            ans->invalid = true;
        } else {
            std::ostringstream out;
            out << file.getMajorVersion() << '.' << file.getMinorVersion();
            ans->engine = out.str();
            ans->invalid = false;
        }
        file.close();
        return ans;
    }

    // Check for an XML file.
    NFileInfo* ans = 0;
    if (fileStartsWith(idPathname.c_str(), "<?xml") == STARTS_TRUE) {
        ans = new NFileInfo();
        ans->compressed = false;
    } else {
        regina::DecompressionStream in(idPathname.c_str());
        if (in) {
            std::string s;
            in >> s;
            if ((! in.eof()) && (s == "<?xml")) {
                ans = new NFileInfo();
                ans->compressed = true;
            }
        }
    }

    if (ans) {
        ans->pathname = idPathname;
        ans->type = NFileInfo::TYPE_XML;
        ans->typeDescription = "XML Regina data file";

        // Make it an invalid file until we know otherwise.
        ans->invalid = true;

        regina::DecompressionStream in(idPathname.c_str());
        if (! in)
            return ans;

        std::string s;

        // Start by slurping in the opening "<?xml".
        if (in.eof())
            return ans;
        in >> s;
        if (s != "<?xml")
            return ans;

        // Hunt for the matching "...?>".
        // Try skipping through several strings in case there are extra
        // arguments in the XML prologue (such as encoding or standalone
        // declarations).
        int i;
        for (i = 0; ; i++) {
            if (in.eof())
                return ans;
            in >> s;
            if (s.length() >= 2 &&
                    s[s.length() - 2] == '?' &&
                    s[s.length() - 1] == '>')
                break;

            // If we can't find it after enough tries, just give up.
            // Ten tries should be more than sufficient, since the current XML
            // spec supports only version, encoding and standalone arguments
            // at present.
            if (i >= 10)
                return ans;
        }

        // The next thing we see should be the <reginadata ...> element.
        if (in.eof())
            return ans;
        in >> s;
        if (s != "<reginadata")
            return ans;

        // Next should be the engine version.
        if (in.eof())
            return ans;
        in >> s;
        if (s.length() < 8)
            return ans;
        if (s.substr(0, 8).compare("engine=\"") != 0)
            return ans;

        // We've found the engine attribute; extract its value.
        std::string::size_type pos = s.find('"', 8);
        if (pos == std::string::npos)
            return ans;
        ans->engine = s.substr(8, pos - 8);

        // That's as far as we need to go; we've extracted everything we want.
        ans->invalid = false;
        return ans;
    }

    // Unknown format.
    return 0;
}

void NFileInfo::writeTextShort(std::ostream& out) const {
    out << "File information: " << typeDescription;
    if (compressed)
        out << " (compressed)";
}

void NFileInfo::writeTextLong(std::ostream& out) const {
    out << "Regina data\n" << typeDescription;
    if (compressed)
        out << " (compressed)";
    out << '\n';

    if (invalid)
        out << "File contains invalid metadata.\n";
    else
        out << "Engine " << engine << '\n';
}

} // namespace regina