summaryrefslogtreecommitdiff
path: root/src/fs/virtfs/virtfszip.cpp
blob: c4ce6f9e8bade42718a12033f479104c7ec1cb6b (plain) (blame)
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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
/*
 *  The ManaPlus Client
 *  Copyright (C) 2013-2017  The ManaPlus Developers
 *
 *  This file is part of The ManaPlus Client.
 *
 *  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
 *  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/>.
 */

#include "fs/virtfs/virtfszip.h"

#include "fs/files.h"
#include "fs/paths.h"
#include "fs/virtfsfuncs.h"
#include "fs/virtfile.h"
#include "fs/virtlist.h"

#include "fs/virtfs/virtfileprivate.h"
#include "fs/virtfs/virtzipentry.h"
#include "fs/virtfs/zip.h"
#include "fs/virtfs/ziplocalheader.h"

#include "utils/checkutils.h"
#include "utils/dtor.h"
#include "utils/stringutils.h"

#include "debug.h"

extern const char *dirSeparator;

namespace
{
    std::vector<VirtZipEntry*> mEntries;
    VirtFsFuncs funcs;
}  // namespace

namespace VirtFsZip
{
    VirtZipEntry *searchEntryByArchive(const std::string &restrict archiveName)
    {
        FOR_EACH (std::vector<VirtZipEntry*>::const_iterator, it, mEntries)
        {
            if ((*it)->mArchiveName == archiveName)
                return *it;
        }
        return nullptr;
    }

    ZipLocalHeader *searchHeaderByName(const std::string &restrict filename)
    {
        FOR_EACH (std::vector<VirtZipEntry*>::const_iterator, it, mEntries)
        {
            VirtZipEntry *const entry = *it;
            FOR_EACH (std::vector<ZipLocalHeader*>::const_iterator,
                      it2,
                      entry->mHeaders)
            {
                if ((*it2)->fileName == filename)
                    return *it2;;
            }
        }
        return nullptr;
    }

    bool addToSearchPathSilent(std::string newDir,
                               const Append append)
    {
        prepareFsPath(newDir);
        if (Files::existsLocal(newDir) == false)
        {
            logger->log("VirtFsZip::addToSearchPath file not exists: %s",
                newDir.c_str());
            return false;
        }
        if (findLast(newDir, ".zip") == false)
        {
            reportAlways("Called VirtFsZip::addToSearchPath without "
                "zip archive");
            return false;
        }
        VirtZipEntry *entry = VirtFsZip::searchEntryByArchive(newDir);
        if (entry != nullptr)
        {
            reportAlways("VirtFsZip::addToSearchPath already exists: %s",
                newDir.c_str());
            return false;
        }
        entry = new VirtZipEntry(newDir);
        if (Zip::readArchiveInfo(entry) == false)
        {
            delete entry;
            return false;
        }

        logger->log("Add virtual zip: " + newDir);
        if (append == Append_true)
            mEntries.push_back(entry);
        else
        {
            mEntries.insert(mEntries.begin(),
                entry);
        }
        return true;
    }

    bool addToSearchPath(std::string newDir,
                         const Append append)
    {
        prepareFsPath(newDir);
        if (Files::existsLocal(newDir) == false)
        {
            reportAlways("VirtFsZip::addToSearchPath directory not exists: %s",
                newDir.c_str());
            return false;
        }
        if (findLast(newDir, ".zip") == false)
        {
            reportAlways("Called VirtFsZip::addToSearchPath without "
                "zip archive");
            return false;
        }
        VirtZipEntry *entry = VirtFsZip::searchEntryByArchive(newDir);
        if (entry != nullptr)
        {
            reportAlways("VirtFsZip::addToSearchPath already exists: %s",
                newDir.c_str());
            return false;
        }
        entry = new VirtZipEntry(newDir);
        if (Zip::readArchiveInfo(entry) == false)
        {
            delete entry;
            return false;
        }

        logger->log("Add virtual zip: " + newDir);
        if (append == Append_true)
            mEntries.push_back(entry);
        else
        {
            mEntries.insert(mEntries.begin(),
                entry);
        }
        return true;
    }

    bool removeFromSearchPathSilent(std::string oldDir)
    {
        prepareFsPath(oldDir);
        if (findLast(oldDir, ".zip") == false)
        {
            reportAlways("Called removeFromSearchPath without zip archive");
            return false;
        }
        FOR_EACH (std::vector<VirtZipEntry*>::iterator, it, mEntries)
        {
            VirtZipEntry *const entry = *it;
            if (entry->mArchiveName == oldDir)
            {
                logger->log("Remove virtual zip: " + oldDir);
                mEntries.erase(it);
                delete entry;
                return true;
            }
        }

        logger->log("VirtFsZip::removeFromSearchPath not exists: %s",
            oldDir.c_str());
        return false;
    }

    bool removeFromSearchPath(std::string oldDir)
    {
        prepareFsPath(oldDir);
        if (findLast(oldDir, ".zip") == false)
        {
            reportAlways("Called removeFromSearchPath without zip archive");
            return false;
        }
        FOR_EACH (std::vector<VirtZipEntry*>::iterator, it, mEntries)
        {
            VirtZipEntry *const entry = *it;
            if (entry->mArchiveName == oldDir)
            {
                logger->log("Remove virtual zip: " + oldDir);
                mEntries.erase(it);
                delete entry;
                return true;
            }
        }

        reportAlways("VirtFsZip::removeFromSearchPath not exists: %s",
            oldDir.c_str());
        return false;
    }

    std::vector<VirtZipEntry*> &getEntries()
    {
        return mEntries;
    }

    void deinit()
    {
        delete_all(mEntries);
        mEntries.clear();
    }

    void init()
    {
        initFuncs(&funcs);
    }

    void initFuncs(VirtFsFuncs *restrict const ptr)
    {
        ptr->close = &VirtFsZip::close;
        ptr->read = &VirtFsZip::read;
        ptr->write = &VirtFsZip::write;
        ptr->fileLength = &VirtFsZip::fileLength;
        ptr->tell = &VirtFsZip::tell;
        ptr->seek = &VirtFsZip::seek;
        ptr->eof = &VirtFsZip::eof;
    }

    std::string getRealDir(std::string filename)
    {
        prepareFsPath(filename);
        if (checkPath(filename) == false)
        {
            reportAlways("VirtFsZip::exists invalid path: %s",
                filename.c_str());
            return std::string();
        }
        return getRealDirInternal(filename);
    }

    std::string getRealDirInternal(const std::string &filename)
    {
        ZipLocalHeader *restrict const header = searchHeaderByName(filename);
        if (header != nullptr)
            return header->zipEntry->mArchiveName;
        return std::string();
    }

    bool exists(std::string name)
    {
        prepareFsPath(name);
        if (checkPath(name) == false)
        {
            reportAlways("VirtFsZip::exists invalid path: %s",
                name.c_str());
            return false;
        }
        ZipLocalHeader *restrict const header = searchHeaderByName(name);
        if (header != nullptr)
            return true;
        return false;
    }

    VirtList *enumerateFiles(std::string dirName)
    {
        VirtList *const list = new VirtList;
        prepareFsPath(dirName);
        if (checkPath(dirName) == false)
        {
            reportAlways("VirtFsZip::enumerateFiles invalid path: %s",
                dirName.c_str());
            return list;
        }
        return enumerateFiles(dirName, list);
    }

    VirtList *enumerateFiles(std::string dirName,
                             VirtList *restrict const list)
    {
        if (findLast(dirName, std::string(dirSeparator)) == false)
            dirName += dirSeparator;
        StringVect &names = list->names;
        if (dirName == "/")
        {
            FOR_EACH (std::vector<VirtZipEntry*>::const_iterator, it, mEntries)
            {
                VirtZipEntry *const entry = *it;
                FOR_EACH (std::vector<ZipLocalHeader*>::const_iterator,
                          it2,
                          entry->mHeaders)
                {
                    ZipLocalHeader *const header = *it2;
                    std::string fileName = header->fileName;
                    // skip subdirs from enumeration
                    const size_t idx = fileName.find(dirSeparator);
                    if (idx != std::string::npos)
                        fileName.erase(idx);
                    bool found(false);
                    FOR_EACH (StringVectCIter, itn, names)
                    {
                        if (*itn == fileName)
                        {
                            found = true;
                            break;
                        }
                    }
                    if (found == false)
                        names.push_back(fileName);
                }
            }
        }
        else
        {
            FOR_EACH (std::vector<VirtZipEntry*>::const_iterator, it, mEntries)
            {
                VirtZipEntry *const entry = *it;
                FOR_EACH (std::vector<ZipLocalHeader*>::const_iterator,
                          it2,
                          entry->mHeaders)
                {
                    ZipLocalHeader *const header = *it2;
                    std::string fileName = header->fileName;
                    if (findCutFirst(fileName, dirName) == true)
                    {
                        // skip subdirs from enumeration
                        const size_t idx = fileName.find(dirSeparator);
                        if (idx != std::string::npos)
                            fileName.erase(idx);
                        bool found(false);
                        FOR_EACH (StringVectCIter, itn, names)
                        {
                            if (*itn == fileName)
                            {
                                found = true;
                                break;
                            }
                        }
                        if (found == false)
                            names.push_back(fileName);
                    }
                }
            }
        }

        return list;
    }

    bool isDirectory(std::string dirName)
    {
        prepareFsPath(dirName);
        if (checkPath(dirName) == false)
        {
            reportAlways("VirtFsZip::isDirectory invalid path: %s",
                dirName.c_str());
            return false;
        }
        return isDirectoryInternal(dirName);
    }

    bool isDirectoryInternal(std::string dirName)
    {
        if (findLast(dirName, std::string(dirSeparator)) == false)
            dirName += dirSeparator;
        FOR_EACH (std::vector<VirtZipEntry*>::const_iterator, it, mEntries)
        {
            VirtZipEntry *const entry = *it;
            FOR_EACH (std::vector<std::string>::const_iterator,
                      it2,
                      entry->mDirs)
            {
                if (*it2 == dirName)
                    return true;
            }
        }
        return false;
    }

    bool isSymbolicLink(std::string name)
    {
        prepareFsPath(name);
        if (checkPath(name) == false)
        {
            reportAlways("VirtFsZip::isSymbolicLink invalid path: %s",
                name.c_str());
            return false;
        }
        // look like in zip files can be symlinks, but here they useless
        return false;
    }

    void freeList(VirtList *restrict const handle)
    {
        delete handle;
    }

    VirtFile *openRead(std::string filename)
    {
        prepareFsPath(filename);
        if (checkPath(filename) == false)
        {
            reportAlways("VirtFsZip::openRead invalid path: %s",
                filename.c_str());
            return nullptr;
        }
        return openReadInternal(filename);
    }

    VirtFile *openReadInternal(const std::string &filename)
    {
        ZipLocalHeader *restrict const header = searchHeaderByName(filename);
        if (header != nullptr)
        {
            uint8_t *restrict const buf = Zip::readFile(header);
            if (buf == nullptr)
                return nullptr;
            VirtFile *restrict const file = new VirtFile(&funcs);
            file->mPrivate = new VirtFilePrivate(buf,
                header->uncompressSize);
            return file;
        }
        return nullptr;
    }

    VirtFile *openWrite(const std::string &restrict filename A_UNUSED)
    {
        return nullptr;
    }

    VirtFile *openAppend(const std::string &restrict filename A_UNUSED)
    {
        return nullptr;
    }

    bool setWriteDir(const std::string &restrict newDir A_UNUSED)
    {
        return false;
    }

    bool mkdir(const std::string &restrict dirname A_UNUSED)
    {
        return false;
    }

    bool remove(const std::string &restrict filename A_UNUSED)
    {
        return false;
    }

    void permitLinks(const bool val A_UNUSED)
    {
    }

    const char *getLastError()
    {
        return nullptr;
    }

    int close(VirtFile *restrict const file)
    {
        if (file == nullptr)
            return 0;
        delete file;
        return 1;
    }

    int64_t read(VirtFile *restrict const file,
                 void *restrict const buffer,
                 const uint32_t objSize,
                 const uint32_t objCount)
    {
        if (file == nullptr ||
            objSize == 0 ||
            objCount == 0)
        {
            return 0;
        }
        if (buffer == nullptr)
        {
            reportAlways("VirtFsZip::read buffer is null");
            return 0;
        }
        VirtFilePrivate *restrict const priv = file->mPrivate;
        const uint32_t pos = priv->mPos;
        const uint32_t sz = priv->mSize;
        // if outside of buffer, return
        if (pos >= sz)
            return 0;
        // pointer to start for buffer ready to read
        const uint8_t *restrict const memPtr = priv->mBuf + pos;
        // left buffer size from pos to end
        const uint32_t memSize = sz - pos;
        // number of objects possible to read
        uint32_t memCount = memSize / objSize;
        if (memCount == 0)
            return 0;
        // limit number of possible objects to read to objCount
        if (memCount > objCount)
            memCount = objCount;
        // number of bytes to read from buffer
        const uint32_t memEnd = memCount * objSize;
        memcpy(buffer, memPtr, memEnd);
        priv->mPos += memEnd;
        return memCount;
    }

    int64_t write(VirtFile *restrict const file A_UNUSED,
                  const void *restrict const buffer A_UNUSED,
                  const uint32_t objSize A_UNUSED,
                  const uint32_t objCount A_UNUSED)
    {
        return 0;
    }

    int64_t fileLength(VirtFile *restrict const file)
    {
        if (file == nullptr)
            return -1;

        return file->mPrivate->mSize;
    }

    int64_t tell(VirtFile *restrict const file)
    {
        if (file == nullptr)
            return -1;

        return file->mPrivate->mPos;
    }

    int seek(VirtFile *restrict const file,
             const uint64_t pos)
    {
        if (file == nullptr)
            return 0;

        if (pos > file->mPrivate->mSize)
            return 0;
        file->mPrivate->mPos = pos;
        return 1;
    }

    int eof(VirtFile *restrict const file)
    {
        if (file == nullptr)
            return -1;

        return file->mPrivate->mPos >= file->mPrivate->mSize;
    }
}  // namespace VirtFsZip