From 6927fd4c934591e4a23f217f2f0ad8c51d93d463 Mon Sep 17 00:00:00 2001 From: lucidiot Date: Tue, 19 Jul 2022 04:37:51 +0200 Subject: [PATCH] Initial commit --- .gitignore | 374 ++++++++++ LICENSE | 674 ++++++++++++++++++ .../Lucidiot.Magellan.Extract.csproj | 56 ++ Lucidiot.Magellan.Extract/Program.cs | 165 +++++ .../Properties/AssemblyInfo.cs | 35 + Lucidiot.Magellan/Helpers.cs | 10 + Lucidiot.Magellan/Lucidiot.Magellan.csproj | 62 ++ Lucidiot.Magellan/MapArchive.cs | 97 +++ Lucidiot.Magellan/MapArchiveEntry.cs | 131 ++++ Lucidiot.Magellan/MapArchiveStorage.cs | 55 ++ Lucidiot.Magellan/Properties/AssemblyInfo.cs | 37 + Lucidiot.Magellan/Substream.cs | 155 ++++ Lucidiot.Raima/DatabaseSchema.cs | 131 ++++ Lucidiot.Raima/FieldEntry.cs | 163 +++++ Lucidiot.Raima/FileEntry.cs | 52 ++ Lucidiot.Raima/FilesystemStorage.cs | 44 ++ Lucidiot.Raima/Helpers.cs | 44 ++ Lucidiot.Raima/IDatabaseStorage.cs | 19 + Lucidiot.Raima/KeyEntry.cs | 24 + Lucidiot.Raima/Lucidiot.Raima.csproj | 58 ++ Lucidiot.Raima/MemberEntry.cs | 18 + Lucidiot.Raima/MemoryStorage.cs | 41 ++ Lucidiot.Raima/NullDatabaseStorage.cs | 34 + Lucidiot.Raima/Properties/AssemblyInfo.cs | 37 + Lucidiot.Raima/ReadOnlyDatabaseStorage.cs | 30 + Lucidiot.Raima/RecordEntry.cs | 33 + Lucidiot.Raima/SetEntry.cs | 39 + Lucidiot.Raima/SortEntry.cs | 12 + Magellan.sln | 32 + 29 files changed, 2662 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 Lucidiot.Magellan.Extract/Lucidiot.Magellan.Extract.csproj create mode 100644 Lucidiot.Magellan.Extract/Program.cs create mode 100644 Lucidiot.Magellan.Extract/Properties/AssemblyInfo.cs create mode 100644 Lucidiot.Magellan/Helpers.cs create mode 100644 Lucidiot.Magellan/Lucidiot.Magellan.csproj create mode 100644 Lucidiot.Magellan/MapArchive.cs create mode 100644 Lucidiot.Magellan/MapArchiveEntry.cs create mode 100644 Lucidiot.Magellan/MapArchiveStorage.cs create mode 100644 Lucidiot.Magellan/Properties/AssemblyInfo.cs create mode 100644 Lucidiot.Magellan/Substream.cs create mode 100644 Lucidiot.Raima/DatabaseSchema.cs create mode 100644 Lucidiot.Raima/FieldEntry.cs create mode 100644 Lucidiot.Raima/FileEntry.cs create mode 100644 Lucidiot.Raima/FilesystemStorage.cs create mode 100644 Lucidiot.Raima/Helpers.cs create mode 100644 Lucidiot.Raima/IDatabaseStorage.cs create mode 100644 Lucidiot.Raima/KeyEntry.cs create mode 100644 Lucidiot.Raima/Lucidiot.Raima.csproj create mode 100644 Lucidiot.Raima/MemberEntry.cs create mode 100644 Lucidiot.Raima/MemoryStorage.cs create mode 100644 Lucidiot.Raima/NullDatabaseStorage.cs create mode 100644 Lucidiot.Raima/Properties/AssemblyInfo.cs create mode 100644 Lucidiot.Raima/ReadOnlyDatabaseStorage.cs create mode 100644 Lucidiot.Raima/RecordEntry.cs create mode 100644 Lucidiot.Raima/SetEntry.cs create mode 100644 Lucidiot.Raima/SortEntry.cs create mode 100644 Magellan.sln diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..d2e908e --- /dev/null +++ b/.gitignore @@ -0,0 +1,374 @@ +# User-specific files +*.rsuser +*.suo +*.user +*.userosscache +*.sln.docstates + +# User-specific files (MonoDevelop/Xamarin Studio) +*.userprefs + +# Mono auto generated files +mono_crash.* + +# Build results +[Dd]ebug/ +[Dd]ebugPublic/ +[Rr]elease/ +[Rr]eleases/ +x64/ +x86/ +[Aa][Rr][Mm]/ +[Aa][Rr][Mm]64/ +bld/ +[Bb]in/ +[Oo]bj/ +[Ll]og/ +[Ll]ogs/ + +# Visual Studio 2015/2017 cache/options directory +.vs/ +# Uncomment if you have tasks that create the project's static files in wwwroot +#wwwroot/ + +# Visual Studio 2017 auto generated files +Generated\ Files/ + +# MSTest test Results +[Tt]est[Rr]esult*/ +[Bb]uild[Ll]og.* + +# NUnit +*.VisualState.xml +TestResult.xml +nunit-*.xml + +# Build Results of an ATL Project +[Dd]ebugPS/ +[Rr]eleasePS/ +dlldata.c + +# Benchmark Results +BenchmarkDotNet.Artifacts/ + +# .NET Core +project.lock.json +project.fragment.lock.json +artifacts/ + +# StyleCop +StyleCopReport.xml + +# Files built by Visual Studio +*_i.c +*_p.c +*_h.h +*.ilk +*.meta +*.obj +*.iobj +*.pch +*.pdb +*.ipdb +*.pgc +*.pgd +*.rsp +*.sbr +*.tlb +*.tli +*.tlh +*.tmp +*.tmp_proj +*_wpftmp.csproj +*.log +*.vspscc +*.vssscc +.builds +*.pidb +*.svclog +*.scc + +# Chutzpah Test files +_Chutzpah* + +# Visual C++ cache files +ipch/ +*.aps +*.ncb +*.opendb +*.opensdf +*.sdf +*.cachefile +*.VC.db +*.VC.VC.opendb + +# Visual Studio profiler +*.psess +*.vsp +*.vspx +*.sap + +# Visual Studio Trace Files +*.e2e + +# TFS 2012 Local Workspace +$tf/ + +# Guidance Automation Toolkit +*.gpState + +# ReSharper is a .NET coding add-in +_ReSharper*/ +*.[Rr]e[Ss]harper +*.DotSettings.user + +# TeamCity is a build add-in +_TeamCity* + +# DotCover is a Code Coverage Tool +*.dotCover + +# AxoCover is a Code Coverage Tool +.axoCover/* +!.axoCover/settings.json + +# Coverlet is a free, cross platform Code Coverage Tool +coverage*[.json, .xml, .info] + +# Visual Studio code coverage results +*.coverage +*.coveragexml + +# NCrunch +_NCrunch_* +.*crunch*.local.xml +nCrunchTemp_* + +# MightyMoose +*.mm.* +AutoTest.Net/ + +# Web workbench (sass) +.sass-cache/ + +# Installshield output folder +[Ee]xpress/ + +# DocProject is a documentation generator add-in +DocProject/buildhelp/ +DocProject/Help/*.HxT +DocProject/Help/*.HxC +DocProject/Help/*.hhc +DocProject/Help/*.hhk +DocProject/Help/*.hhp +DocProject/Help/Html2 +DocProject/Help/html + +# Click-Once directory +publish/ + +# Publish Web Output +*.[Pp]ublish.xml +*.azurePubxml +# Note: Comment the next line if you want to checkin your web deploy settings, +# but database connection strings (with potential passwords) will be unencrypted +*.pubxml +*.publishproj + +# Microsoft Azure Web App publish settings. Comment the next line if you want to +# checkin your Azure Web App publish settings, but sensitive information contained +# in these scripts will be unencrypted +PublishScripts/ + +# NuGet Packages +*.nupkg +# NuGet Symbol Packages +*.snupkg +# The packages folder can be ignored because of Package Restore +**/[Pp]ackages/* +# except build/, which is used as an MSBuild target. +!**/[Pp]ackages/build/ +# Uncomment if necessary however generally it will be regenerated when needed +#!**/[Pp]ackages/repositories.config +# NuGet v3's project.json files produces more ignorable files +*.nuget.props +*.nuget.targets + +# Microsoft Azure Build Output +csx/ +*.build.csdef + +# Microsoft Azure Emulator +ecf/ +rcf/ + +# Windows Store app package directories and files +AppPackages/ +BundleArtifacts/ +Package.StoreAssociation.xml +_pkginfo.txt +*.appx +*.appxbundle +*.appxupload + +# Visual Studio cache files +# files ending in .cache can be ignored +*.[Cc]ache +# but keep track of directories ending in .cache +!?*.[Cc]ache/ + +# Others +ClientBin/ +~$* +*~ +*.dbmdl +*.dbproj.schemaview +*.jfm +*.pfx +*.publishsettings +orleans.codegen.cs + +# Including strong name files can present a security risk +# (https://github.com/github/gitignore/pull/2483#issue-259490424) +#*.snk + +# Since there are multiple workflows, uncomment next line to ignore bower_components +# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) +#bower_components/ + +# RIA/Silverlight projects +Generated_Code/ + +# Backup & report files from converting an old project file +# to a newer Visual Studio version. Backup files are not needed, +# because we have git ;-) +_UpgradeReport_Files/ +Backup*/ +UpgradeLog*.XML +UpgradeLog*.htm +ServiceFabricBackup/ +*.rptproj.bak + +# SQL Server files +*.mdf +*.ldf +*.ndf + +# Business Intelligence projects +*.rdl.data +*.bim.layout +*.bim_*.settings +*.rptproj.rsuser +*- [Bb]ackup.rdl +*- [Bb]ackup ([0-9]).rdl +*- [Bb]ackup ([0-9][0-9]).rdl + +# Microsoft Fakes +FakesAssemblies/ + +# GhostDoc plugin setting file +*.GhostDoc.xml + +# Node.js Tools for Visual Studio +.ntvs_analysis.dat +node_modules/ + +# Visual Studio 6 build log +*.plg + +# Visual Studio 6 workspace options file +*.opt + +# Visual Studio 6 auto-generated workspace file (contains which files were open etc.) +*.vbw + +# Visual Studio LightSwitch build output +**/*.HTMLClient/GeneratedArtifacts +**/*.DesktopClient/GeneratedArtifacts +**/*.DesktopClient/ModelManifest.xml +**/*.Server/GeneratedArtifacts +**/*.Server/ModelManifest.xml +_Pvt_Extensions + +# Paket dependency manager +.paket/paket.exe +paket-files/ + +# FAKE - F# Make +.fake/ + +# CodeRush personal settings +.cr/personal + +# Python Tools for Visual Studio (PTVS) +__pycache__/ +*.pyc + +# Cake - Uncomment if you are using it +# tools/** +# !tools/packages.config + +# Tabs Studio +*.tss + +# Telerik's JustMock configuration file +*.jmconfig + +# BizTalk build output +*.btp.cs +*.btm.cs +*.odx.cs +*.xsd.cs + +# OpenCover UI analysis results +OpenCover/ + +# Azure Stream Analytics local run output +ASALocalRun/ + +# MSBuild Binary and Structured Log +*.binlog + +# NVidia Nsight GPU debugger configuration file +*.nvuser + +# MFractors (Xamarin productivity tool) working folder +.mfractor/ + +# Local History for Visual Studio +.localhistory/ + +# BeatPulse healthcheck temp database +healthchecksdb + +# Backup folder for Package Reference Convert tool in Visual Studio 2017 +MigrationBackup/ + +# Ionide (cross platform F# VS Code tools) working folder +.ionide/ + +### Windows ### +# Windows thumbnail cache files +Thumbs.db +Thumbs.db:encryptable +ehthumbs.db +ehthumbs_vista.db + +# Dump file +*.stackdump + +# Folder config file +[Dd]esktop.ini + +# Recycle Bin used on file shares +$RECYCLE.BIN/ + +# Windows Installer files +*.cab +*.msi +*.msix +*.msm +*.msp + +# Windows shortcuts +*.lnk diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + 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 . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/Lucidiot.Magellan.Extract/Lucidiot.Magellan.Extract.csproj b/Lucidiot.Magellan.Extract/Lucidiot.Magellan.Extract.csproj new file mode 100644 index 0000000..9dd47eb --- /dev/null +++ b/Lucidiot.Magellan.Extract/Lucidiot.Magellan.Extract.csproj @@ -0,0 +1,56 @@ + + + Debug + AnyCPU + 8.0.50727 + 2.0 + {6C32D3BF-C756-4780-BF6D-339D6F93590C} + Exe + Properties + Lucidiot.Magellan.Extract + MagellanExtract + + + true + full + false + bin\Debug\ + DEBUG;TRACE + prompt + 4 + false + + + pdbonly + true + bin\Release\ + TRACE + prompt + 4 + + + + + + + + + + + {B2936486-ADBD-4E7A-8811-03DCA10D1C3F} + Lucidiot.Magellan + + + {DA44BDE7-2CF1-4D71-A50C-C3409FE4A0B9} + Lucidiot.Raima + + + + + diff --git a/Lucidiot.Magellan.Extract/Program.cs b/Lucidiot.Magellan.Extract/Program.cs new file mode 100644 index 0000000..14c875a --- /dev/null +++ b/Lucidiot.Magellan.Extract/Program.cs @@ -0,0 +1,165 @@ +using System; +using System.Collections.Generic; +using System.IO; +using Lucidiot.Raima; + +namespace Lucidiot.Magellan.Extract { + class Program { + static int Main(string[] args) { + if (args.Length < 1) { + Console.WriteLine("Usage: thing.exe [ ...]"); + return 1; + } + + foreach (string arg in args) { + DumpMGI(arg); + } + return 0; + } + + static void DumpMGI(string MGIPath) { + Console.WriteLine("Magellan Map archive contents - {0}", MGIPath); + MapArchiveEntry[] entries; + try { + entries = MapArchive.ReadHeader(MGIPath); + } catch (Exception e) { + ConsoleColor current = Console.ForegroundColor; + Console.ForegroundColor = ConsoleColor.Red; + Console.WriteLine(e.ToString()); + Console.ForegroundColor = current; + Console.WriteLine(); + Console.WriteLine("--------------------------------------------------"); + return; + } + List databases = new List(); + foreach (MapArchiveEntry entry in entries) { + Console.WriteLine("{0,-16} {1} bytes starting at offset {2}", entry.FullName, entry.Length, entry.Offset); + if (entry.Extension.ToLowerInvariant() == "dbd") { + Console.WriteLine(" Looks like a Raima database, will attempt to dump its schema below."); + databases.Add(entry); + } + } + Console.WriteLine(); + Console.WriteLine("--------------------------------------------------"); + + foreach (MapArchiveEntry db in databases) { + DumpDatabase(MGIPath, db.FullName); + } + } + + static void DumpDatabase(string MGIPath, string fileName) { + Console.WriteLine("Raima Database Manager Embedded V3.00 Database Schema Dump"); + Console.WriteLine("Database {0} in archive {1}", fileName, MGIPath); + DatabaseSchema ds; + try { + ds = DatabaseSchema.Load(fileName, new MapArchiveStorage(MGIPath)); + } catch (Exception e) { + ConsoleColor current = Console.ForegroundColor; + Console.ForegroundColor = ConsoleColor.Red; + Console.WriteLine(e.ToString()); + Console.ForegroundColor = current; + Console.WriteLine(); + Console.WriteLine("--------------------------------------------------"); + return; + } + Console.WriteLine("PageSize: {0}", ds.PageSize); + Console.WriteLine("--- FILE ENTRIES ---------------------------------"); + for (int i = 0; i < ds.FileEntries.Count; i++) { + FileEntry entry = ds.FileEntries[i]; + Console.WriteLine(" #{0}: {1}", i, entry.Name); + Console.WriteLine(" {0}, {1}", entry.Type, entry.Status); + Console.WriteLine(" Descriptor {0}, page size {1}", entry.Descriptor, entry.PageSize); + Console.WriteLine(" {0} record slots of size {1}", entry.Slots, entry.SlotSize); + if ((entry.Options & FileEntryOptions.Compressed) == FileEntryOptions.Compressed) + Console.WriteLine(" Compressed"); + if ((entry.Options & FileEntryOptions.Local) == FileEntryOptions.Local) + Console.WriteLine(" Local"); + if ((entry.Options & FileEntryOptions.Static) == FileEntryOptions.Static) + Console.WriteLine(" Static"); + } + if (ds.FileEntries.Count < 1) + Console.WriteLine(" No entries found."); + Console.WriteLine(); + Console.WriteLine("--- RECORD ENTRIES -------------------------------"); + for (int i = 0; i < ds.RecordEntries.Count; i++) { + RecordEntry entry = ds.RecordEntries[i]; + Console.WriteLine(" #{0}: Record from file #{1}", i, entry.FileEntryIndex); + Console.WriteLine(" {0} field entries starting at #{1}", entry.FieldEntryCount, entry.FirstFieldEntryIndex); + if ((entry.Options & RecordEntryOptions.Timestamped) == RecordEntryOptions.Timestamped) + Console.WriteLine(" Timestamped"); + if ((entry.Options & RecordEntryOptions.Local) == RecordEntryOptions.Local) + Console.WriteLine(" Local"); + if ((entry.Options & RecordEntryOptions.Static) == RecordEntryOptions.Static) + Console.WriteLine(" Static"); + if ((entry.Options & RecordEntryOptions.ContainsCompoundKey) == RecordEntryOptions.ContainsCompoundKey) + Console.WriteLine(" Contains a compound key"); + } + if (ds.RecordEntries.Count < 1) + Console.WriteLine(" No entries found."); + Console.WriteLine(); + Console.WriteLine("--- FIELD ENTRIES --------------------------------"); + for (int i = 0; i < ds.FieldEntries.Count; i++) { + FieldEntry entry = ds.FieldEntries[i]; + Console.WriteLine(" #{0}: Field from record #{1}", i, entry.RecordEntryIndex); + Console.WriteLine(" Type: {0}[{1},{2},{3}]", entry.Type, entry.Dimension1, entry.Dimension2, entry.Dimension3); + if (entry.Type == FieldType.CompoundKey) { + Console.WriteLine(" First field of the compound key: #{0}", entry.Offset); + Console.WriteLine(" Length: {0}", entry.Length); + } else + Console.WriteLine(" Found in rows at offset {0}, length {1}", entry.Offset, entry.Length); + Console.WriteLine(" B-Tree index: {0}", entry.KeyType == FieldKeyType.None ? "No" : "Yes" + (entry.KeyType == FieldKeyType.Unique ? ", with unique constraint" : "")); + if (entry.KeyType != FieldKeyType.None) + Console.WriteLine(" Key file #{0}, key number #{1}", entry.KeyFileIndex, entry.KeyNumber); + if ((entry.Options & FieldEntryOptions.Unsigned) == FieldEntryOptions.Unsigned) + Console.WriteLine(" Type is unsigned"); + if ((entry.Options & FieldEntryOptions.Optional) == FieldEntryOptions.Optional) + Console.WriteLine(" Optional"); + if ((entry.Options & FieldEntryOptions.StructField) == FieldEntryOptions.StructField) + Console.WriteLine(" Part of a previously listed GroupedField"); + if ((entry.Options & FieldEntryOptions.CompoundKeyMember) == FieldEntryOptions.CompoundKeyMember) + Console.WriteLine(" Part of a compound key"); + if ((entry.Options & FieldEntryOptions.SortField) == FieldEntryOptions.SortField) + Console.WriteLine(" Part of a sort entry"); + } + if (ds.FieldEntries.Count < 1) + Console.WriteLine(" No entries found."); + Console.WriteLine(); + Console.WriteLine("--- SET ENTRIES ----------------------------------"); + for (int i = 0; i < ds.SetEntries.Count; i++) { + SetEntry entry = ds.SetEntries[i]; + Console.WriteLine(" #{0}: Set from record #{1}", i, entry.RecordEntryIndex); + Console.WriteLine(" {0} member entries starting at #{1}", entry.MemberCount, entry.FirstMemberEntryIndex); + Console.WriteLine(" Offset: {0}", entry.Offset); + Console.WriteLine(" Ordering: {0}", entry.Ordering); + if ((entry.Options & SetEntryOptions.Timestamped) == SetEntryOptions.Timestamped) + Console.WriteLine(" Timestamped"); + } + if (ds.SetEntries.Count < 1) + Console.WriteLine(" No entries found."); + Console.WriteLine(); + Console.WriteLine("--- MEMBER ENTRIES -------------------------------"); + for (int i = 0; i < ds.MemberEntries.Count; i++) { + MemberEntry entry = ds.MemberEntries[i]; + Console.WriteLine(" #{0}: member entry from record #{1}", i, entry.RecordIndex); + Console.WriteLine(" Offset: ", entry.Offset); + Console.WriteLine(" {0} sort entries starting at #{1}", entry.SortEntryCount, entry.FirstSortEntryIndex); + } + if (ds.MemberEntries.Count < 1) + Console.WriteLine(" No entries found."); + Console.WriteLine(); + Console.WriteLine("--- SORT ENTRIES ---------------------------------"); + for (int i = 0; i < ds.SortEntries.Count; i++) { + SortEntry entry = ds.SortEntries[i]; + Console.WriteLine(" #{0}: set #{1} - field #{2}", i, entry.SetIndex, entry.FieldIndex); + } + if (ds.SortEntries.Count < 1) + Console.WriteLine(" No entries found."); + Console.WriteLine(); + Console.WriteLine("--- KEY ENTRIES ----------------------------------"); + if (ds.KeyEntries.Count < 1) + Console.WriteLine(" No entries found."); + Console.WriteLine(); + Console.WriteLine("--------------------------------------------------"); + } + } +} diff --git a/Lucidiot.Magellan.Extract/Properties/AssemblyInfo.cs b/Lucidiot.Magellan.Extract/Properties/AssemblyInfo.cs new file mode 100644 index 0000000..ccc6458 --- /dev/null +++ b/Lucidiot.Magellan.Extract/Properties/AssemblyInfo.cs @@ -0,0 +1,35 @@ +using System.Reflection; +using System.Runtime.CompilerServices; +using System.Runtime.InteropServices; +using System.Resources; + +// General Information about an assembly is controlled through the following +// set of attributes. Change these attribute values to modify the information +// associated with an assembly. +[assembly: AssemblyTitle("Lucidiot.Magellan.Extract")] +[assembly: AssemblyDescription("")] +[assembly: AssemblyConfiguration("")] +[assembly: AssemblyCompany("lucidiot")] +[assembly: AssemblyProduct("Lucidiot.Magellan.Extract")] +[assembly: AssemblyCopyright("GNU GPL 3 - lucidiot 2022")] +[assembly: AssemblyTrademark("")] +[assembly: AssemblyCulture("")] + +// Setting ComVisible to false makes the types in this assembly not visible +// to COM components. If you need to access a type in this assembly from +// COM, set the ComVisible attribute to true on that type. +[assembly: ComVisible(false)] + +// The following GUID is for the ID of the typelib if this project is exposed to COM +[assembly: Guid("d36f06e6-1b3e-4582-913c-5a5d4add24fd")] + +// Version information for an assembly consists of the following four values: +// +// Major Version +// Minor Version +// Build Number +// Revision +// +[assembly: AssemblyVersion("1.0.0.0")] +[assembly: AssemblyFileVersion("1.0.0.0")] +[assembly: NeutralResourcesLanguageAttribute("en")] diff --git a/Lucidiot.Magellan/Helpers.cs b/Lucidiot.Magellan/Helpers.cs new file mode 100644 index 0000000..6ccaabc --- /dev/null +++ b/Lucidiot.Magellan/Helpers.cs @@ -0,0 +1,10 @@ +using System; +using System.Text; + +namespace Lucidiot.Magellan { + internal static class Helpers { + internal static bool IsASCII(string value) { + return Encoding.UTF8.GetByteCount(value) == value.Length; + } + } +} diff --git a/Lucidiot.Magellan/Lucidiot.Magellan.csproj b/Lucidiot.Magellan/Lucidiot.Magellan.csproj new file mode 100644 index 0000000..ea44516 --- /dev/null +++ b/Lucidiot.Magellan/Lucidiot.Magellan.csproj @@ -0,0 +1,62 @@ + + + Debug + AnyCPU + 8.0.50727 + 2.0 + {B2936486-ADBD-4E7A-8811-03DCA10D1C3F} + Library + Properties + Lucidiot.Magellan + MagellanLibrary + + + true + full + false + bin\Debug\ + DEBUG;TRACE + prompt + 4 + + + pdbonly + true + bin\Release\ + TRACE + prompt + 4 + + + + + + + + + + + + + + + + + + + + + + {DA44BDE7-2CF1-4D71-A50C-C3409FE4A0B9} + Lucidiot.Raima + + + + + diff --git a/Lucidiot.Magellan/MapArchive.cs b/Lucidiot.Magellan/MapArchive.cs new file mode 100644 index 0000000..254369d --- /dev/null +++ b/Lucidiot.Magellan/MapArchive.cs @@ -0,0 +1,97 @@ +using System; +using System.IO; + +namespace Lucidiot.Magellan { + public static class MapArchive { + public static MapArchiveEntry[] ReadHeader(string path) { + if (!File.Exists(path)) throw new FileNotFoundException("Archive file not found.", path); + using (FileStream stream = File.Open(path, FileMode.Open)) { + return ReadHeader(stream); + } + } + + public static MapArchiveEntry[] ReadHeader(Stream stream) { + if (!stream.CanSeek) + throw new ArgumentException("Reading capability is required on the stream in order to read the header.", "stream"); + using (BinaryReader br = new BinaryReader(stream)) { + return ReadHeader(br); + } + } + + public static MapArchiveEntry[] ReadHeader(BinaryReader br) { + uint length1 = br.ReadUInt32(); + uint length2 = br.ReadUInt32(); + if (length1 != length2) + throw new NotSupportedException("Unexpected header: Two different entry counts found."); + + MapArchiveEntry[] entries = new MapArchiveEntry[length1]; + for (int i = 0; i < length1; i++) { + entries[i] = MapArchiveEntry.Parse(br); + } + return entries; + } + + public static void ExtractAll(string path, string destination) { + if (!File.Exists(path)) + throw new FileNotFoundException("MGI file not found.", path); + if (!Directory.Exists(destination)) + throw new DirectoryNotFoundException("Destination path is not a valid directory."); + + using (FileStream stream = File.Open(path, FileMode.Open)) { + ExtractAll(stream, destination); + } + } + + public static void ExtractAll(Stream stream, string destination) { + if (!stream.CanSeek) + throw new ArgumentException("Seeking capability is required on the stream in order to extract.", "stream"); + if (!stream.CanRead) + throw new ArgumentException("Reading capability is required on the stream in order to extract.", "stream"); + + using (BinaryReader br = new BinaryReader(stream)) { + ExtractAll(br, destination); + } + } + + public static void ExtractAll(BinaryReader br, string destination) { + if (!br.BaseStream.CanSeek) + throw new ArgumentException("Seeking capability is required on the stream reader in order to extract.", "br"); + + ExtractAll(br, ReadHeader(br), destination); + } + + public static void ExtractAll(string path, MapArchiveEntry[] entries, string destination) { + if (!File.Exists(path)) + throw new FileNotFoundException("Archive file not found.", path); + if (!Directory.Exists(destination)) + throw new DirectoryNotFoundException("Destination path is not a valid directory."); + + using (FileStream stream = File.Open(path, FileMode.Open)) { + ExtractAll(stream, entries, destination); + } + } + + public static void ExtractAll(Stream stream, MapArchiveEntry[] entries, string destination) { + if (!stream.CanSeek) + throw new ArgumentException("Seeking capability is required on the stream in order to extract.", "stream"); + if (!stream.CanRead) + throw new ArgumentException("Reading capability is required on the stream in order to extract.", "stream"); + + using (BinaryReader br = new BinaryReader(stream)) { + ExtractAll(br, entries, destination); + } + } + + public static void ExtractAll(BinaryReader br, MapArchiveEntry[] entries, string destination) { + if (!br.BaseStream.CanSeek) + throw new ArgumentException("Seeking capability is required on the stream reader in order to extract.", "br"); + if (!br.BaseStream.CanRead) + throw new ArgumentException("Reading capability is required on the stream reader in order to extract.", "br"); + + foreach (MapArchiveEntry entry in entries) { + string path = Path.Combine(destination, entry.FullName.Replace('\0', '_')); + entry.Extract(br, path); + } + } + } +} diff --git a/Lucidiot.Magellan/MapArchiveEntry.cs b/Lucidiot.Magellan/MapArchiveEntry.cs new file mode 100644 index 0000000..e20ee3d --- /dev/null +++ b/Lucidiot.Magellan/MapArchiveEntry.cs @@ -0,0 +1,131 @@ +using System; +using System.IO; + +namespace Lucidiot.Magellan { + /// + /// Represents a single file entry in an Magellan map archive. + /// + public struct MapArchiveEntry { + private string _name; + + /// + /// Name of the file, without the extension. Up to 8 ASCII characters. + /// + public string Name { + get { return _name; } + set { + CheckString("Name", value, 8); + _name = value; + } + } + + private string _ext; + + /// + /// File extension. Up to 7 ASCII characters. + /// + /// + /// While the format allows enough space for file extensions that go up to 7 ASCII characters, + /// only two to three characters have been seen in the wild. Not all existing implementations + /// of the format might support more than three characters. + /// + public string Extension { + get { return _ext; } + set { + CheckString("Extension", value, 7); + _ext = value; + } + } + + public string FullName { + get { + if (Extension == null || Extension == String.Empty) + return Name; + return String.Format("{0}.{1}", Name, Extension); + } + } + + private uint _offset; + + /// + /// Offset of the file's contents within the archive. + /// Should be an even number. + /// + public uint Offset { + get { return _offset; } + set { _offset = value; } + } + + private uint _length; + + /// + /// Length of the file's contents within the archive. + /// If the length is an odd number, an extra null byte is added after the file's contents + /// to ensure an even offset for the next file. + /// + public uint Length { + get { return _length; } + set { _length = value; } + } + + private static void CheckString(string paramName, string value, int maxLength) { + if (value.Length > maxLength || !Helpers.IsASCII(value)) + throw new ArgumentOutOfRangeException(paramName, "Only " + maxLength + " ASCII characters are supported."); + } + + public MapArchiveEntry(string Name, string Extension, uint Offset, uint Length) { + CheckString("Name", Name, 8); + CheckString("Extension", Extension, 7); + + this._name = Name; + this._ext = Extension; + this._offset = Offset; + this._length = Length; + } + + /// + /// Parse a single MapArchiveEntry from a BinaryReader, leaving the reader's cursor positioned right after the entry. + /// + /// The BinaryReader to read from. + /// A parsed MapArchiveEntry. + public static MapArchiveEntry Parse(BinaryReader br) { + string name = new string(br.ReadChars(8)).Trim("\0".ToCharArray()); + br.ReadByte(); + string ext = new string(br.ReadChars(7)).Trim("\0".ToCharArray()); + uint offset = br.ReadUInt32(); + uint length = br.ReadUInt32(); + return new MapArchiveEntry(name, ext, offset, length); + } + + /// + /// Maximum size of the buffer used to transfer data from a BinaryReader to a BinaryWriter during extraction. + /// Note that the buffer may be smaller if the MapArchiveEntry's length is lower than this size. + /// + private const int EXTRACT_BUFFER_SIZE = 32768; + + /// + /// Extract the file designated by this entry from the archive into a file on the filesystem, + /// named after the name and extension set in the entry. + /// + /// The BinaryReader to extract from. + /// Existing directory where the file will be extracted. + /// An error occurred while reading from the archive, creating the new file, or writing to the new file. + public void Extract(BinaryReader br, string destination) { + if (Length == 0) { + File.Create(destination).Close(); + return; + } + + br.BaseStream.Seek(Offset, SeekOrigin.Begin); + using (BinaryWriter bw = new BinaryWriter(File.Open(destination, FileMode.Create))) { + byte[] buffer = new byte[Math.Min(Length, EXTRACT_BUFFER_SIZE)]; + uint copied = 0; + while (copied < Length) { + int toCopy = (int)Math.Min(Length - copied, EXTRACT_BUFFER_SIZE); + copied += (uint)br.Read(buffer, 0, toCopy); + bw.Write(buffer, 0, toCopy); + } + } + } + } +} diff --git a/Lucidiot.Magellan/MapArchiveStorage.cs b/Lucidiot.Magellan/MapArchiveStorage.cs new file mode 100644 index 0000000..0667d1b --- /dev/null +++ b/Lucidiot.Magellan/MapArchiveStorage.cs @@ -0,0 +1,55 @@ +using System; +using System.Collections.Generic; +using System.IO; +using Lucidiot.Raima; + +namespace Lucidiot.Magellan { + public class MapArchiveStorage : ReadOnlyDatabaseStorage, IDisposable { + private Dictionary entriesCache; + private readonly Stream ArchiveStream; + + public MapArchiveStorage(string path) { + if (!File.Exists(path)) + throw new FileNotFoundException("Archive file not found.", path); + this.ArchiveStream = File.OpenRead(path); + } + + public MapArchiveStorage(Stream stream) { + if (!stream.CanSeek) + throw new ArgumentException("Seeking capability is required on the stream in order to use it as database storage.", "br"); + if (!stream.CanRead) + throw new ArgumentException("Reading capability is required on the stream in order to use it as database storage.", "br"); + this.ArchiveStream = stream; + } + + public MapArchiveEntry? TryFindEntry(string fileName) { + if (entriesCache == null) { + ArchiveStream.Seek(0, SeekOrigin.Begin); + entriesCache = new Dictionary(); + foreach (MapArchiveEntry entry in MapArchive.ReadHeader(new BinaryReader(ArchiveStream))) { + entriesCache[entry.FullName] = entry; + } + } + + MapArchiveEntry result; + if (!entriesCache.TryGetValue(fileName, out result)) + return null; + return result; + } + + public override bool Exists(string fileName) { + return TryFindEntry(fileName) != null; + } + + public override BinaryReader GetReader(string fileName) { + MapArchiveEntry? entry = TryFindEntry(fileName); + if (entry == null) + throw new FileNotFoundException("File does not exist", fileName); + return new BinaryReader(new Substream(ArchiveStream, entry.Value.Offset, entry.Value.Length)); + } + + public void Dispose() { + ArchiveStream.Dispose(); + } + } +} \ No newline at end of file diff --git a/Lucidiot.Magellan/Properties/AssemblyInfo.cs b/Lucidiot.Magellan/Properties/AssemblyInfo.cs new file mode 100644 index 0000000..99de32c --- /dev/null +++ b/Lucidiot.Magellan/Properties/AssemblyInfo.cs @@ -0,0 +1,37 @@ +using System.Reflection; +using System.Runtime.CompilerServices; +using System.Runtime.InteropServices; +using System.Resources; + +// General Information about an assembly is controlled through the following +// set of attributes. Change these attribute values to modify the information +// associated with an assembly. +[assembly: AssemblyTitle("Lucidiot.Magellan")] +[assembly: AssemblyDescription("")] +[assembly: AssemblyConfiguration("")] +[assembly: AssemblyCompany("")] +[assembly: AssemblyProduct("Lucidiot.Magellan")] +[assembly: AssemblyCopyright("GNU GPL 3 - lucidiot 2022")] +[assembly: AssemblyTrademark("")] +[assembly: AssemblyCulture("")] + +// Setting ComVisible to false makes the types in this assembly not visible +// to COM components. If you need to access a type in this assembly from +// COM, set the ComVisible attribute to true on that type. +[assembly: ComVisible(false)] + +// The following GUID is for the ID of the typelib if this project is exposed to COM +[assembly: Guid("3488b158-5a0b-4c37-908c-1abe5e062e2e")] + +// Version information for an assembly consists of the following four values: +// +// Major Version +// Minor Version +// Build Number +// Revision +// +// You can specify all the values or you can default the Revision and Build Numbers +// by using the '*' as shown below: +[assembly: AssemblyVersion("1.0.0.0")] +[assembly: AssemblyFileVersion("1.0.0.0")] +[assembly: NeutralResourcesLanguageAttribute("en")] diff --git a/Lucidiot.Magellan/Substream.cs b/Lucidiot.Magellan/Substream.cs new file mode 100644 index 0000000..8031c01 --- /dev/null +++ b/Lucidiot.Magellan/Substream.cs @@ -0,0 +1,155 @@ +using System; +using System.IO; + +namespace Lucidiot.Magellan { + /// + /// A stream based on a slice of an existing . + /// + internal class Substream : Stream { + private readonly Stream BaseStream; + private readonly long Offset; + private readonly long Limit; + + // To support streams whose position cannot be accessed, we need to keep track of the stream's current position ourselves. + // We will keep the position without the offset for simpler calculations. + private long CachedPosition = 0; + + public Substream(Stream baseStream, long offset) + : this(baseStream, offset, long.MaxValue) { } + + public Substream(Stream baseStream, long offset, long limit) { + this.BaseStream = baseStream; + this.Offset = offset; + this.Limit = limit; + + if (offset > 0) { + if (baseStream.CanSeek) + baseStream.Seek(offset, SeekOrigin.Begin); + else + throw new NotSupportedException("Cannot use a non-zero offset on streams that are not seekable."); + } + } + + public override bool CanRead { + get { return BaseStream.CanRead; } + } + + public override bool CanSeek { + get { return BaseStream.CanSeek; } + } + + public override bool CanWrite { + get { return BaseStream.CanWrite; } + } + + public override bool CanTimeout { + get { return BaseStream.CanTimeout; } + } + + public override int ReadTimeout { + get { + return BaseStream.ReadTimeout; + } + set { + BaseStream.ReadTimeout = value; + } + } + + public override int WriteTimeout { + get { + return BaseStream.WriteTimeout; + } + set { + BaseStream.WriteTimeout = value; + } + } + + public override void Flush() { + BaseStream.Flush(); + } + + public override long Length { + get { return Math.Min(Limit, BaseStream.Length); } + } + + public override long Position { + get { + // Do not use CachedPosition here: just let the operation fail if the stream is not supposed to support accessing its position. + return BaseStream.Position - Offset; + } + set { + if (value < 0) + throw new ArgumentOutOfRangeException("Position", "Cannot set the position to a negative value."); + if (value > Limit) + throw new EndOfStreamException("Cannot seek beyond the end of the stream."); + BaseStream.Position = value + Offset; + CachedPosition = value; + } + } + + public override int Read(byte[] buffer, int offset, int count) { + int bytesRead = BaseStream.Read(buffer, offset, (int)Math.Min(Limit - CachedPosition, count)); + CachedPosition += bytesRead; + return bytesRead; + } + + public override int ReadByte() { + if (CachedPosition >= Limit) + return -1; + int result = BaseStream.ReadByte(); + if (result >= 0) + CachedPosition += result; + return result; + } + + public override long Seek(long offset, SeekOrigin origin) { + // Compute the new expected position within the slice to make boundary checks + long newSlicePosition = offset; + if (origin == SeekOrigin.Current) { + newSlicePosition += CachedPosition; + } else if (origin == SeekOrigin.End) { + newSlicePosition += Length; + } + + if (newSlicePosition < 0) + throw new ArgumentOutOfRangeException("offset", "Cannot seek before the beginning of the stream."); + if (newSlicePosition > Limit) + throw new EndOfStreamException("Cannot seek beyond the end of the stream."); + + // Transform the arguments to match the whole base stream. + if (origin == SeekOrigin.Begin) { + // When starting from the beginning of the stream, add the slice's offset. + offset += this.Offset; + } else if (origin == SeekOrigin.End) { + /* + * When starting from the end, since we do not know where the stream ends, + * we transform the arguments into a seek from the beginning of the stream, + * but with both the offset and the length added to the seek offset, + * causing the seek offset to actually start from the end of our slice. + */ + offset += this.Offset + this.Length; + origin = SeekOrigin.Begin; + } + + BaseStream.Seek(offset, origin); + throw new NotImplementedException(); + } + + public override void SetLength(long value) { + throw new NotSupportedException("This stream does not support resizing."); + } + + public override void Write(byte[] buffer, int offset, int count) { + count = (int)Math.Min(Limit - CachedPosition, count); + BaseStream.Write(buffer, offset, count); + CachedPosition += count; + } + + public override void WriteByte(byte value) { + if (CachedPosition >= Limit) + throw new NotSupportedException("Cannot write beyond the end of the stream."); + BaseStream.WriteByte(value); + CachedPosition++; + } + } +} \ No newline at end of file diff --git a/Lucidiot.Raima/DatabaseSchema.cs b/Lucidiot.Raima/DatabaseSchema.cs new file mode 100644 index 0000000..1efbce7 --- /dev/null +++ b/Lucidiot.Raima/DatabaseSchema.cs @@ -0,0 +1,131 @@ +using System; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.IO; +using System.Text; + +namespace Lucidiot.Raima { + public enum DatabaseVersion { + /// + /// Version 3.00, with a V3.00 + 0x1A file magic. + /// + V300 + } + + public class DatabaseSchema { + private short _pageSize = 512; + public short PageSize { get { return _pageSize; } } + + public const DatabaseVersion Version = DatabaseVersion.V300; + + public const string Magic = "V3.00\x1a"; + + public string DatabaseFileName; + + public readonly IDatabaseStorage StorageMethod; + + private List _fileEntries = new List(); + + public ReadOnlyCollection FileEntries { + get { return _fileEntries.AsReadOnly(); } + } + + private List _recordEntries = new List(); + + public ReadOnlyCollection RecordEntries { + get { return _recordEntries.AsReadOnly(); } + } + + private List _fieldEntries = new List(); + + public ReadOnlyCollection FieldEntries { + get { return _fieldEntries.AsReadOnly(); } + } + + private List _setEntries = new List(); + + public ReadOnlyCollection SetEntries { + get { return _setEntries.AsReadOnly(); } + } + + private List _memberEntries = new List(); + + public ReadOnlyCollection MemberEntries { + get { return _memberEntries.AsReadOnly(); } + } + + private List _sortEntries = new List(); + + public ReadOnlyCollection SortEntries { + get { return _sortEntries.AsReadOnly(); } + } + + private List _keyEntries = new List(); + + public ReadOnlyCollection KeyEntries { + get { return _keyEntries.AsReadOnly(); } + } + + public DatabaseSchema(string fileName, IDatabaseStorage storage) { + this.DatabaseFileName = fileName; + this.StorageMethod = storage; + } + + public static DatabaseSchema Load(string fileName, IDatabaseStorage storage) { + if (!storage.CanRead) + throw new NotSupportedException("A readable storage method is required to load an existing database."); + DatabaseSchema ds = new DatabaseSchema(fileName, storage); + using (BinaryReader br = storage.GetReader(fileName)) { + ds.Parse(br); + } + return ds; + } + + private void Parse(BinaryReader br) { + string foundMagic = new String(Encoding.ASCII.GetChars(br.ReadBytes(Magic.Length))); + if (foundMagic != Magic) + throw new InvalidDataException("Unexpected file magic: " + foundMagic); + short pageSize = br.ReadInt16(); + if (pageSize % 512 != 0) + throw new ArgumentOutOfRangeException("Page size must be a multiple of 512 bytes."); + this._pageSize = pageSize; + + short fileCount, recordCount, fieldCount, setCount, memberCount, sortCount, keyCount; + fileCount = br.ReadInt16(); + recordCount = br.ReadInt16(); + fieldCount = br.ReadInt16(); + setCount = br.ReadInt16(); + memberCount = br.ReadInt16(); + sortCount = br.ReadInt16(); + keyCount = br.ReadInt16(); + + _fileEntries.Capacity = Math.Max(_fileEntries.Capacity, fileCount); + for (ushort i = 0; i < fileCount; i++) + _fileEntries.Add(Helpers.ReadStruct(br)); + + _recordEntries.Capacity = Math.Max(_recordEntries.Capacity, recordCount); + for (ushort i = 0; i < recordCount; i++) + _recordEntries.Add(Helpers.ReadStruct(br)); + + _fieldEntries.Capacity = Math.Max(_fieldEntries.Capacity, fieldCount); + for (ushort i = 0; i < fieldCount; i++) + _fieldEntries.Add(Helpers.ReadStruct(br)); + + _setEntries.Capacity = Math.Max(_setEntries.Capacity, setCount); + for (ushort i = 0; i < setCount; i++) + _setEntries.Add(Helpers.ReadStruct(br)); + + _memberEntries.Capacity = Math.Max(_memberEntries.Capacity, memberCount); + for (ushort i = 0; i < memberCount; i++) + _memberEntries.Add(Helpers.ReadStruct(br)); + + _sortEntries.Capacity = Math.Max(_sortEntries.Capacity, sortCount); + for (ushort i = 0; i < sortCount; i++) + _sortEntries.Add(Helpers.ReadStruct(br)); + + _keyEntries.Capacity = Math.Max(_keyEntries.Capacity, keyCount); + for (ushort i = 0; i < keyCount; i++) + _keyEntries.Add(Helpers.ReadStruct(br)); + } + } +} diff --git a/Lucidiot.Raima/FieldEntry.cs b/Lucidiot.Raima/FieldEntry.cs new file mode 100644 index 0000000..a9b9986 --- /dev/null +++ b/Lucidiot.Raima/FieldEntry.cs @@ -0,0 +1,163 @@ +using System; +using System.Runtime.InteropServices; + +namespace Lucidiot.Raima { + /// + /// Type of the key applied to a field. + /// A key is more commonly known as a B-Tree index. + /// + public enum FieldKeyType : byte { + /// + /// There is no key for this field. + /// Using this value on a field of type makes the field inoperant. + /// + None = (byte)'n', + + /// + /// A B-Tree index is built for this field, but no uniqueness checks are performed during insertions or updates. + /// + Duplicates = (byte)'d', + + /// + /// A B-Tree index is built for this field, and uniqueness checks are performed using it during insertions or updates. + /// + Unique = (byte)'u' + } + + /// + /// Data type of the value stored in a field. + /// + public enum FieldType : byte { + /// + /// A character-type field. + /// This is often changed into a string by using the field's array sizes to turn it into a char[]. + /// + Char = (byte)'c', + + /// + /// A single byte. + /// + /// + /// The character for this field type is 's', meaning "short", but this does not match the .NET definition of short. + /// + Byte = (byte)'s', + + /// + /// A 16-bit integer. + /// + /// + /// The character for this field type is 'i', meaning "int", but this does not match the .NET definition of int. + /// + Int16 = (byte)'i', + + /// + /// A 32-bit integer. + /// + /// + /// The character for this field type is 'l', meaning "long", but this does not match the .NET definition of long. + /// + Int32 = (byte)'l', + + /// + /// A single-precision IEEE 754 floating point number. + /// + Float = (byte)'f', + + /// + /// A double-precision IEEE 754 floating point number. + /// + /// + /// A header file of the Common Desktop Environment defines a double as 'F', while its comments use 'D'. + /// + Double = (byte)'F', + + DatabaseAddress = (byte)'d', + + /// + /// This field regroups multiple fields into one. This is also known as a "struct field". + /// All subsequent fields in the field table that use the flag + /// are sub-fields of this field. + /// + GroupedField = (byte)'g', + + /// + /// The field is a compound key, used to build a B-Tree index over multiple fields. + /// The attribute should not be set to . + /// + CompoundKey = (byte)'k' + } + + [Flags] + public enum FieldEntryOptions : ushort { + /// + /// No specific options are applied. + /// + None = 0x0000, + + /// + /// This field is referenced by a . + /// + SortField = 0x0001, + + /// + /// This field is part of a field that was mentioned earlier in the field table. + /// + StructField = 0x0002, + + /// + /// The field's type is unsigned. + /// + Unsigned = 0x0004, + + /// + /// The field is optional. + /// + Optional = 0x0008, + + /// + /// This field is referenced by a for another field. + /// + CompoundKeyMember = 0x0010 + } + + [StructLayout(LayoutKind.Explicit, Size = 20)] + public struct FieldEntry { + [FieldOffset(0)] + public FieldKeyType KeyType; + + [FieldOffset(1)] + public FieldType Type; + + [FieldOffset(2)] + public short Length; + + // Those would probably make more sense as an array of three `short`, but I cannot seem to make that work with marshaling... + [FieldOffset(4)] + public short Dimension1; + + [FieldOffset(6)] + public short Dimension2; + + [FieldOffset(8)] + public short Dimension3; + + [FieldOffset(10)] + public short KeyFileIndex; + + [FieldOffset(12)] + public short KeyNumber; + + /// + /// Offset to the field's data inside a record, in bytes. + /// With a type set to , this is the index of the first of the compound key. + /// + [FieldOffset(14)] + public short Offset; + + [FieldOffset(16)] + public short RecordEntryIndex; + + [FieldOffset(18)] + public FieldEntryOptions Options; + } +} diff --git a/Lucidiot.Raima/FileEntry.cs b/Lucidiot.Raima/FileEntry.cs new file mode 100644 index 0000000..63ba121 --- /dev/null +++ b/Lucidiot.Raima/FileEntry.cs @@ -0,0 +1,52 @@ +using System; +using System.Runtime.InteropServices; + +namespace Lucidiot.Raima { + public enum FileStatus : byte { + Open = (byte)'o', + Closed = (byte)'c', + } + + public enum FileType : byte { + CompressedData = (byte)'c', + Data = (byte)'d', + Key = (byte)'k', + Overflow = (byte)'o', + } + + [Flags] + public enum FileEntryOptions : ushort { + None = 0x0000, + Static = 0x0002, + Local = 0x0004, + Compressed = 0x0040, + } + + [StructLayout(LayoutKind.Explicit, Size = 60)] + public struct FileEntry { + [FieldOffset(0)] + [MarshalAs(UnmanagedType.ByValTStr, SizeConst = 48)] + public string Name; + + [FieldOffset(48)] + public short Descriptor; + + [FieldOffset(50)] + public FileStatus Status; + + [FieldOffset(51)] + public FileType Type; + + [FieldOffset(52)] + public short Slots; + + [FieldOffset(54)] + public short SlotSize; + + [FieldOffset(56)] + public short PageSize; + + [FieldOffset(58)] + public FileEntryOptions Options; + } +} diff --git a/Lucidiot.Raima/FilesystemStorage.cs b/Lucidiot.Raima/FilesystemStorage.cs new file mode 100644 index 0000000..eb76ee7 --- /dev/null +++ b/Lucidiot.Raima/FilesystemStorage.cs @@ -0,0 +1,44 @@ +using System; +using System.IO; + +namespace Lucidiot.Raima { + public class FilesystemStorage : IDatabaseStorage { + public readonly string BaseDirectory; + + public FilesystemStorage(string baseDir) { + if (!Directory.Exists(baseDir)) + throw new DirectoryNotFoundException(String.Format("The directory '{0}' was not found.", baseDir)); + this.BaseDirectory = Path.GetFullPath(baseDir); + } + + #region IDatabaseStorage Members + + public bool CanRead { + // TODO: Check the filesystem permissions! + get { return true; } + } + + public bool CanWrite { + // TODO: Check the filesystem permissions! + get { return true; } + } + + public bool Exists(string fileName) { + return File.Exists(Path.Combine(BaseDirectory, fileName)); + } + + public BinaryReader GetReader(string fileName) { + return new BinaryReader(File.OpenRead(Path.Combine(BaseDirectory, fileName))); + } + + public BinaryWriter GetWriter(string fileName) { + return new BinaryWriter(File.OpenWrite(Path.Combine(BaseDirectory, fileName))); + } + + public void Delete(string fileName) { + File.Delete(Path.Combine(BaseDirectory, fileName)); + } + + #endregion + } +} diff --git a/Lucidiot.Raima/Helpers.cs b/Lucidiot.Raima/Helpers.cs new file mode 100644 index 0000000..6cbcb21 --- /dev/null +++ b/Lucidiot.Raima/Helpers.cs @@ -0,0 +1,44 @@ +using System.IO; +using System.Runtime.InteropServices; +using System; + +namespace Lucidiot.Raima { + internal static class Helpers { + internal class ParsingException : Exception { + public readonly byte[] ErroneousBytes; + public readonly Type DestinationType; + + public ParsingException(byte[] bytes, Type type) + : this(bytes, type, String.Format("An error occurred while parsing binary data into a {0} type.", type.AssemblyQualifiedName)) { } + + public ParsingException(byte[] bytes, Type type, string message) + : base(message) { + this.ErroneousBytes = bytes; + this.DestinationType = type; + } + + public ParsingException(byte[] bytes, Type type, Exception innerException) + : this(bytes, type, String.Format("An error occurred while parsing binary data into a {0} type.", type.AssemblyQualifiedName), innerException) { } + + public ParsingException(byte[] bytes, Type type, string message, Exception innerException) + : base(message, innerException) { + this.ErroneousBytes = bytes; + this.DestinationType = type; + } + } + + internal static T ReadStruct(BinaryReader reader) where T : struct { + byte[] bytes = reader.ReadBytes(Marshal.SizeOf(typeof(T))); + GCHandle handle = GCHandle.Alloc(bytes, GCHandleType.Pinned); + T parsedStruct; + try { + parsedStruct = (T)Marshal.PtrToStructure(handle.AddrOfPinnedObject(), typeof(T)); + } catch (TypeLoadException e) { + throw new ParsingException(bytes, typeof(T), e); + } finally { + handle.Free(); + } + return parsedStruct; + } + } +} diff --git a/Lucidiot.Raima/IDatabaseStorage.cs b/Lucidiot.Raima/IDatabaseStorage.cs new file mode 100644 index 0000000..9641266 --- /dev/null +++ b/Lucidiot.Raima/IDatabaseStorage.cs @@ -0,0 +1,19 @@ +using System.IO; + +namespace Lucidiot.Raima { + /// + /// Abstraction layer to store all of the database's files. + /// + public interface IDatabaseStorage { + bool CanRead { get; } + bool CanWrite { get; } + + bool Exists(string fileName); + + BinaryReader GetReader(string fileName); + + BinaryWriter GetWriter(string fileName); + + void Delete(string fileName); + } +} diff --git a/Lucidiot.Raima/KeyEntry.cs b/Lucidiot.Raima/KeyEntry.cs new file mode 100644 index 0000000..4cde734 --- /dev/null +++ b/Lucidiot.Raima/KeyEntry.cs @@ -0,0 +1,24 @@ +using System; +using System.Runtime.InteropServices; + +namespace Lucidiot.Raima { + public enum KeyOrdering : byte { + Ascending = (byte)'a', + Descending = (byte)'d' + } + + [StructLayout(LayoutKind.Explicit, Size = 7)] + public struct KeyEntry { + [FieldOffset(0)] + public short KeyFieldIndex; + + [FieldOffset(2)] + public short FieldIndex; + + [FieldOffset(4)] + public short Offset; + + [FieldOffset(6)] + public KeyOrdering Ordering; + } +} diff --git a/Lucidiot.Raima/Lucidiot.Raima.csproj b/Lucidiot.Raima/Lucidiot.Raima.csproj new file mode 100644 index 0000000..320aeaa --- /dev/null +++ b/Lucidiot.Raima/Lucidiot.Raima.csproj @@ -0,0 +1,58 @@ + + + Debug + AnyCPU + 8.0.50727 + 2.0 + {DA44BDE7-2CF1-4D71-A50C-C3409FE4A0B9} + Library + Properties + Lucidiot.Raima + RaimaLibrary + + + true + full + false + bin\Debug\ + DEBUG;TRACE + prompt + 4 + + + pdbonly + true + bin\Release\ + TRACE + prompt + 4 + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/Lucidiot.Raima/MemberEntry.cs b/Lucidiot.Raima/MemberEntry.cs new file mode 100644 index 0000000..5469a16 --- /dev/null +++ b/Lucidiot.Raima/MemberEntry.cs @@ -0,0 +1,18 @@ +using System.Runtime.InteropServices; + +namespace Lucidiot.Raima { + [StructLayout(LayoutKind.Explicit, Size = 8)] + public struct MemberEntry { + [FieldOffset(0)] + public short RecordIndex; + + [FieldOffset(2)] + public short Offset; + + [FieldOffset(4)] + public short FirstSortEntryIndex; + + [FieldOffset(6)] + public short SortEntryCount; + } +} diff --git a/Lucidiot.Raima/MemoryStorage.cs b/Lucidiot.Raima/MemoryStorage.cs new file mode 100644 index 0000000..4ded62c --- /dev/null +++ b/Lucidiot.Raima/MemoryStorage.cs @@ -0,0 +1,41 @@ +using System; +using System.Collections.Generic; +using System.IO; + +namespace Lucidiot.Raima { + public class MemoryStorage : IDatabaseStorage { + private Dictionary _files = new Dictionary(); + + #region IDatabaseStorage Members + + public bool CanRead { + get { return true; } + } + + public bool CanWrite { + get { return true; } + } + + public bool Exists(string fileName) { + return _files.ContainsKey(fileName); + } + + public BinaryReader GetReader(string fileName) { + if (!_files.ContainsKey(fileName)) + _files[fileName] = new MemoryStream(); + return new BinaryReader(_files[fileName]); + } + + public BinaryWriter GetWriter(string fileName) { + if (!_files.ContainsKey(fileName)) + _files[fileName] = new MemoryStream(); + return new BinaryWriter(_files[fileName]); + } + + public void Delete(string fileName) { + _files.Remove(fileName); + } + + #endregion + } +} diff --git a/Lucidiot.Raima/NullDatabaseStorage.cs b/Lucidiot.Raima/NullDatabaseStorage.cs new file mode 100644 index 0000000..b6d518e --- /dev/null +++ b/Lucidiot.Raima/NullDatabaseStorage.cs @@ -0,0 +1,34 @@ +using System; +using System.IO; + +namespace Lucidiot.Raima { + public class NullDatabaseStorage : IDatabaseStorage { + #region IDatabaseStorage Members + + public bool CanRead { + get { return true; } + } + + public bool CanWrite { + get { return true; } + } + + public bool Exists(string fileName) { + return false; + } + + public BinaryReader GetReader(string fileName) { + return new BinaryReader(Stream.Null); + } + + public BinaryWriter GetWriter(string fileName) { + return new BinaryWriter(Stream.Null); + } + + public void Delete(string fileName) { + return; + } + + #endregion + } +} diff --git a/Lucidiot.Raima/Properties/AssemblyInfo.cs b/Lucidiot.Raima/Properties/AssemblyInfo.cs new file mode 100644 index 0000000..dc7b6bb --- /dev/null +++ b/Lucidiot.Raima/Properties/AssemblyInfo.cs @@ -0,0 +1,37 @@ +using System.Reflection; +using System.Runtime.CompilerServices; +using System.Runtime.InteropServices; +using System.Resources; + +// General Information about an assembly is controlled through the following +// set of attributes. Change these attribute values to modify the information +// associated with an assembly. +[assembly: AssemblyTitle("Lucidiot.Raima")] +[assembly: AssemblyDescription(".NET library for Raima Database Manager databases")] +[assembly: AssemblyConfiguration("")] +[assembly: AssemblyCompany("lucidiot")] +[assembly: AssemblyProduct("Lucidiot.Raima")] +[assembly: AssemblyCopyright("GNU GPL 3 - lucidiot 2022")] +[assembly: AssemblyTrademark("")] +[assembly: AssemblyCulture("")] + +// Setting ComVisible to false makes the types in this assembly not visible +// to COM components. If you need to access a type in this assembly from +// COM, set the ComVisible attribute to true on that type. +[assembly: ComVisible(false)] + +// The following GUID is for the ID of the typelib if this project is exposed to COM +[assembly: Guid("9779d303-43b0-47a3-8837-ea227b1bdda7")] + +// Version information for an assembly consists of the following four values: +// +// Major Version +// Minor Version +// Build Number +// Revision +// +// You can specify all the values or you can default the Revision and Build Numbers +// by using the '*' as shown below: +[assembly: AssemblyVersion("1.0.0.0")] +[assembly: AssemblyFileVersion("1.0.0.0")] +[assembly: NeutralResourcesLanguageAttribute("en")] diff --git a/Lucidiot.Raima/ReadOnlyDatabaseStorage.cs b/Lucidiot.Raima/ReadOnlyDatabaseStorage.cs new file mode 100644 index 0000000..6ccc6fc --- /dev/null +++ b/Lucidiot.Raima/ReadOnlyDatabaseStorage.cs @@ -0,0 +1,30 @@ +using System; +using System.IO; + +namespace Lucidiot.Raima { + public abstract class ReadOnlyDatabaseStorage : IDatabaseStorage { + #region IDatabaseStorage Members + + public bool CanRead { + get { return true; } + } + + public bool CanWrite { + get { return false; } + } + + public abstract bool Exists(string fileName); + + public abstract BinaryReader GetReader(string fileName); + + public BinaryWriter GetWriter(string fileName) { + throw new NotSupportedException(); + } + + public void Delete(string fileName) { + throw new NotSupportedException(); + } + + #endregion + } +} diff --git a/Lucidiot.Raima/RecordEntry.cs b/Lucidiot.Raima/RecordEntry.cs new file mode 100644 index 0000000..e600586 --- /dev/null +++ b/Lucidiot.Raima/RecordEntry.cs @@ -0,0 +1,33 @@ +using System; +using System.Runtime.InteropServices; + +namespace Lucidiot.Raima { + public enum RecordEntryOptions : ushort { + None = 0x0000, + Timestamped = 0x0001, + Static = 0x0002, + Local = 0x0004, + ContainsCompoundKey = 0x0010, + } + + [StructLayout(LayoutKind.Explicit, Size = 12)] + public struct RecordEntry { + [FieldOffset(0)] + public ushort FileEntryIndex; + + [FieldOffset(2)] + public ushort Length; + + [FieldOffset(4)] + public ushort DataOffset; + + [FieldOffset(6)] + public ushort FirstFieldEntryIndex; + + [FieldOffset(8)] + public ushort FieldEntryCount; + + [FieldOffset(10)] + public RecordEntryOptions Options; + } +} diff --git a/Lucidiot.Raima/SetEntry.cs b/Lucidiot.Raima/SetEntry.cs new file mode 100644 index 0000000..184901b --- /dev/null +++ b/Lucidiot.Raima/SetEntry.cs @@ -0,0 +1,39 @@ +using System; +using System.Runtime.InteropServices; + +namespace Lucidiot.Raima { + public enum SetOrdering : byte { + Ascending = (byte)'a', + Descending = (byte)'d', + First = (byte)'f', + Last = (byte)'l', + None = (byte)'n' + } + + [Flags] + public enum SetEntryOptions : ushort { + None = 0x0000, + Timestamped = 0x0001 + } + + [StructLayout(LayoutKind.Explicit, Size = 11)] + public struct SetEntry { + [FieldOffset(0)] + public SetOrdering Ordering; + + [FieldOffset(1)] + public short RecordEntryIndex; + + [FieldOffset(3)] + public short Offset; + + [FieldOffset(5)] + public short FirstMemberEntryIndex; + + [FieldOffset(7)] + public short MemberCount; + + [FieldOffset(9)] + public SetEntryOptions Options; + } +} \ No newline at end of file diff --git a/Lucidiot.Raima/SortEntry.cs b/Lucidiot.Raima/SortEntry.cs new file mode 100644 index 0000000..012f615 --- /dev/null +++ b/Lucidiot.Raima/SortEntry.cs @@ -0,0 +1,12 @@ +using System.Runtime.InteropServices; + +namespace Lucidiot.Raima { + [StructLayout(LayoutKind.Explicit, Size = 4)] + public struct SortEntry { + [FieldOffset(0)] + public short FieldIndex; + + [FieldOffset(2)] + public short SetIndex; + } +} diff --git a/Magellan.sln b/Magellan.sln new file mode 100644 index 0000000..db4b28c --- /dev/null +++ b/Magellan.sln @@ -0,0 +1,32 @@ + +Microsoft Visual Studio Solution File, Format Version 9.00 +# Visual Studio 2005 +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Lucidiot.Magellan", "Lucidiot.Magellan\Lucidiot.Magellan.csproj", "{B2936486-ADBD-4E7A-8811-03DCA10D1C3F}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Lucidiot.Magellan.Extract", "Lucidiot.Magellan.Extract\Lucidiot.Magellan.Extract.csproj", "{6C32D3BF-C756-4780-BF6D-339D6F93590C}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Lucidiot.Raima", "Lucidiot.Raima\Lucidiot.Raima.csproj", "{DA44BDE7-2CF1-4D71-A50C-C3409FE4A0B9}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Release|Any CPU = Release|Any CPU + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {B2936486-ADBD-4E7A-8811-03DCA10D1C3F}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {B2936486-ADBD-4E7A-8811-03DCA10D1C3F}.Debug|Any CPU.Build.0 = Debug|Any CPU + {B2936486-ADBD-4E7A-8811-03DCA10D1C3F}.Release|Any CPU.ActiveCfg = Release|Any CPU + {B2936486-ADBD-4E7A-8811-03DCA10D1C3F}.Release|Any CPU.Build.0 = Release|Any CPU + {6C32D3BF-C756-4780-BF6D-339D6F93590C}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {6C32D3BF-C756-4780-BF6D-339D6F93590C}.Debug|Any CPU.Build.0 = Debug|Any CPU + {6C32D3BF-C756-4780-BF6D-339D6F93590C}.Release|Any CPU.ActiveCfg = Release|Any CPU + {6C32D3BF-C756-4780-BF6D-339D6F93590C}.Release|Any CPU.Build.0 = Release|Any CPU + {DA44BDE7-2CF1-4D71-A50C-C3409FE4A0B9}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {DA44BDE7-2CF1-4D71-A50C-C3409FE4A0B9}.Debug|Any CPU.Build.0 = Debug|Any CPU + {DA44BDE7-2CF1-4D71-A50C-C3409FE4A0B9}.Release|Any CPU.ActiveCfg = Release|Any CPU + {DA44BDE7-2CF1-4D71-A50C-C3409FE4A0B9}.Release|Any CPU.Build.0 = Release|Any CPU + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection +EndGlobal