From 95980860e5effdb383e9995565b7820bf1539a09 Mon Sep 17 00:00:00 2001 From: Oliver Hamlet Date: Sun, 23 Jan 2022 20:41:54 +0000 Subject: [PATCH] Remove all Git-related functionality LOOT no longer uses Git to keep its copies of the masterlists up to date, so this functionality is no longer needed. The removed API items are: - UpdateFile() - GetFileRevision() - IsLatestFile() - libgit2_category() - GitStateError --- .github/workflows/ci.yml | 4 - .github/workflows/release.yml | 2 - CMakeLists.txt | 33 +- docs/api/credits.rst | 3 +- docs/api/miscellaneous.rst | 3 - docs/api/reference.rst | 11 - docs/licenses/GNU GPL v2 (libgit2).txt | 930 ------------------ docs/licenses/texts.rst | 8 - include/loot/api.h | 69 -- include/loot/exception/error_categories.h | 7 - include/loot/exception/git_state_error.h | 41 - src/api/api.cpp | 23 - src/api/error_categories.cpp | 16 - src/api/helpers/git.cpp | 737 -------------- src/api/helpers/git.h | 118 --- src/api/helpers/text.cpp | 6 +- .../api/interface/file_versioning_test.h | 196 ---- src/tests/api/interface/main.cpp | 1 - src/tests/api/internals/helpers/git_test.h | 377 ------- src/tests/api/internals/main.cpp | 1 - 20 files changed, 10 insertions(+), 2576 deletions(-) delete mode 100644 docs/licenses/GNU GPL v2 (libgit2).txt delete mode 100644 include/loot/exception/git_state_error.h delete mode 100644 src/api/helpers/git.cpp delete mode 100644 src/api/helpers/git.h delete mode 100644 src/tests/api/interface/file_versioning_test.h delete mode 100644 src/tests/api/internals/helpers/git_test.h diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 3567f001..478bb2e9 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -118,8 +118,6 @@ jobs: - name: Run tests run: | cd build - git config --global user.email "github@github-actions" - git config --global user.name "GitHub" ./libloot_internals_tests ./libloot_tests @@ -200,8 +198,6 @@ jobs: - name: Run tests run: | cd build/${{ env.MSVC_CONFIG }} - git config --global user.email "github@github-actions" - git config --global user.name "GitHub" .\libloot_internals_tests.exe .\libloot_tests.exe diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 32ebebf6..3a8e6897 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -94,8 +94,6 @@ jobs: - name: Run tests run: | cd build - git config --global user.email "github@github-actions" - git config --global user.name "GitHub" ./libloot_internals_tests ./libloot_tests diff --git a/CMakeLists.txt b/CMakeLists.txt index e06b2fdc..35d5fbbc 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -81,22 +81,6 @@ ELSE () set (ESPLUGIN_LIBRARIES ${ESPLUGIN_LIBRARIES} dl) ENDIF () -IF (CMAKE_SYSTEM_NAME MATCHES "Windows") - set(LIBGIT2_BUILD_COMMAND ${CMAKE_COMMAND} --build . --target git2 --config $(CONFIGURATION)) -ELSE () - set(LIBGIT2_BUILD_COMMAND ${CMAKE_COMMAND} --build . --target git2) -ENDIF() - -ExternalProject_Add(libgit2 - PREFIX "external" - URL "https://github.com/libgit2/libgit2/archive/v1.3.0.tar.gz" - CMAKE_ARGS -DBUILD_SHARED_LIBS=OFF -DBUILD_CLAR=OFF -DUSE_SSH=OFF -DSTATIC_CRT=OFF -DCMAKE_POSITION_INDEPENDENT_CODE=${CMAKE_POSITION_INDEPENDENT_CODE} -DREGEX_BACKEND=builtin - BUILD_COMMAND ${LIBGIT2_BUILD_COMMAND} - INSTALL_COMMAND "") -ExternalProject_Get_Property(libgit2 SOURCE_DIR BINARY_DIR) -set(LIBGIT2_INCLUDE_DIRS "${SOURCE_DIR}/include") -set(LIBGIT2_LIBRARIES "${BINARY_DIR}/${CMAKE_CFG_INTDIR}/${CMAKE_STATIC_LIBRARY_PREFIX}git2${CMAKE_STATIC_LIBRARY_SUFFIX}") - ExternalProject_Add(libloadorder PREFIX "external" URL "https://github.com/Ortham/libloadorder/archive/13.0.0.tar.gz" @@ -206,7 +190,6 @@ set (LIBLOOT_SRC "${CMAKE_BINARY_DIR}/generated/loot_version.cpp" "${CMAKE_SOURCE_DIR}/src/api/sorting/plugin_graph.cpp" "${CMAKE_SOURCE_DIR}/src/api/sorting/plugin_sorting_data.cpp" "${CMAKE_SOURCE_DIR}/src/api/helpers/crc.cpp" - "${CMAKE_SOURCE_DIR}/src/api/helpers/git.cpp" "${CMAKE_SOURCE_DIR}/src/api/helpers/text.cpp" "${CMAKE_SOURCE_DIR}/src/api/vertex.cpp" "${CMAKE_SOURCE_DIR}/src/api/resource.rc") @@ -218,7 +201,6 @@ set (LIBLOOT_HEADERS "${CMAKE_SOURCE_DIR}/include/loot/api.h" "${CMAKE_SOURCE_DIR}/include/loot/exception/condition_syntax_error.h" "${CMAKE_SOURCE_DIR}/include/loot/exception/cyclic_interaction_error.h" "${CMAKE_SOURCE_DIR}/include/loot/exception/file_access_error.h" - "${CMAKE_SOURCE_DIR}/include/loot/exception/git_state_error.h" "${CMAKE_SOURCE_DIR}/include/loot/exception/undefined_group_error.h" "${CMAKE_SOURCE_DIR}/include/loot/enum/edge_type.h" "${CMAKE_SOURCE_DIR}/include/loot/enum/game_type.h" @@ -260,7 +242,6 @@ set (LIBLOOT_HEADERS "${CMAKE_SOURCE_DIR}/include/loot/api.h" "${CMAKE_SOURCE_DIR}/src/api/sorting/plugin_sort.h" "${CMAKE_SOURCE_DIR}/src/api/sorting/plugin_graph.h" "${CMAKE_SOURCE_DIR}/src/api/sorting/plugin_sorting_data.h" - "${CMAKE_SOURCE_DIR}/src/api/helpers/git.h" "${CMAKE_SOURCE_DIR}/src/api/helpers/collections.h" "${CMAKE_SOURCE_DIR}/src/api/helpers/crc.h" "${CMAKE_SOURCE_DIR}/src/api/helpers/logging.h" @@ -271,7 +252,6 @@ set (LOOT_TESTS_SRC "${CMAKE_SOURCE_DIR}/src/tests/api/internals/main.cpp") set (LOOT_TESTS_HEADERS "${CMAKE_SOURCE_DIR}/src/tests/api/internals/game/game_test.h" "${CMAKE_SOURCE_DIR}/src/tests/api/internals/game/game_cache_test.h" "${CMAKE_SOURCE_DIR}/src/tests/api/internals/game/load_order_handler_test.h" - "${CMAKE_SOURCE_DIR}/src/tests/api/internals/helpers/git_test.h" "${CMAKE_SOURCE_DIR}/src/tests/api/internals/helpers/crc_test.h" "${CMAKE_SOURCE_DIR}/src/tests/api/internals/helpers/text_test.h" "${CMAKE_SOURCE_DIR}/src/tests/api/internals/helpers/yaml_set_helpers_test.h" @@ -299,7 +279,6 @@ set(LIBLOOT_TESTS_SRC "${CMAKE_SOURCE_DIR}/src/tests/api/interface/main.cpp") set(LIBLOOT_TESTS_HEADERS "${CMAKE_SOURCE_DIR}/src/tests/api/interface/api_game_operations_test.h" "${CMAKE_SOURCE_DIR}/src/tests/api/interface/create_game_handle_test.h" "${CMAKE_SOURCE_DIR}/src/tests/api/interface/database_interface_test.h" - "${CMAKE_SOURCE_DIR}/src/tests/api/interface/file_versioning_test.h" "${CMAKE_SOURCE_DIR}/src/tests/api/interface/game_interface_test.h" "${CMAKE_SOURCE_DIR}/src/tests/api/interface/is_compatible_test.h" "${CMAKE_SOURCE_DIR}/src/tests/common_game_test_fixture.h") @@ -316,7 +295,6 @@ source_group("Source Files\\tests" FILES ${LIBLOOT_TESTS_SRC}) include_directories ("${CMAKE_SOURCE_DIR}/src" "${CMAKE_SOURCE_DIR}/include" ${LIBLOADORDER_INCLUDE_DIRS} - ${LIBGIT2_INCLUDE_DIRS} ${ESPLUGIN_INCLUDE_DIRS} ${LCI_INCLUDE_DIRS} ${Boost_INCLUDE_DIRS} @@ -366,7 +344,8 @@ IF (MSVC) shlwapi winhttp crypt32 - Rpcrt4) + Rpcrt4 + bcrypt) ENDIF () @@ -376,13 +355,13 @@ ENDIF () # Build tests. add_executable (libloot_internals_tests ${LIBLOOT_SRC} ${LIBLOOT_HEADERS} ${LOOT_TESTS_SRC} ${LOOT_TESTS_HEADERS}) -add_dependencies (libloot_internals_tests esplugin libgit2 libloadorder loot-condition-interpreter spdlog yaml-cpp GTest testing-metadata testing-plugins) -target_link_libraries(libloot_internals_tests ${LIBGIT2_LIBRARIES} ${ESPLUGIN_LIBRARIES} ${LIBLOADORDER_LIBRARIES} ${LOOT_LIBS} ${LCI_LIBRARIES} ${YAML_CPP_LIBRARIES} ${GTEST_LIBRARIES} ${ICU_LIBRARIES}) +add_dependencies (libloot_internals_tests esplugin libloadorder loot-condition-interpreter spdlog yaml-cpp GTest testing-metadata testing-plugins) +target_link_libraries(libloot_internals_tests ${ESPLUGIN_LIBRARIES} ${LIBLOADORDER_LIBRARIES} ${LOOT_LIBS} ${LCI_LIBRARIES} ${YAML_CPP_LIBRARIES} ${GTEST_LIBRARIES} ${ICU_LIBRARIES}) # Build API. add_library (loot ${LIBLOOT_SRC} ${LIBLOOT_HEADERS}) -add_dependencies (loot esplugin libgit2 libloadorder loot-condition-interpreter spdlog yaml-cpp) -target_link_libraries(loot ${LIBGIT2_LIBRARIES} ${ESPLUGIN_LIBRARIES} ${LIBLOADORDER_LIBRARIES} ${LOOT_LIBS} ${LCI_LIBRARIES} ${YAML_CPP_LIBRARIES} ${ICU_LIBRARIES}) +add_dependencies (loot esplugin libloadorder loot-condition-interpreter spdlog yaml-cpp) +target_link_libraries(loot ${ESPLUGIN_LIBRARIES} ${LIBLOADORDER_LIBRARIES} ${LOOT_LIBS} ${LCI_LIBRARIES} ${YAML_CPP_LIBRARIES} ${ICU_LIBRARIES}) # Build API tests. add_executable (libloot_tests ${LIBLOOT_TESTS_SRC} ${LIBLOOT_TESTS_HEADERS}) diff --git a/docs/api/credits.rst b/docs/api/credits.rst index dbd37973..733e3f41 100644 --- a/docs/api/credits.rst +++ b/docs/api/credits.rst @@ -3,14 +3,13 @@ Credits ******* libloot is written by `Ortham`_ in C++ and makes use of the `Boost`_, -`esplugin`_, `libgit2`_, `libloadorder`_, `loot-condition-interpreter`_, +`esplugin`_, `libloadorder`_, `loot-condition-interpreter`_, `spdlog`_ and `yaml-cpp`_ libraries. The copyright licenses for all of these and libloot itself in :doc:`../licenses/texts`. .. _Ortham: https://github.com/Ortham .. _Boost: http://www.boost.org/ .. _esplugin: https://github.com/Ortham/esplugin -.. _libgit2: https://github.com/libgit2/libgit2 .. _libloadorder: https://github.com/Ortham/libloadorder .. _loot-condition-interpreter: https://github.com/loot/loot-condition-interpreter .. _spdlog: https://github.com/gabime/spdlog diff --git a/docs/api/miscellaneous.rst b/docs/api/miscellaneous.rst index d78666c3..161d086b 100644 --- a/docs/api/miscellaneous.rst +++ b/docs/api/miscellaneous.rst @@ -78,9 +78,6 @@ data from the filesystem: Evaluating conditions may also involve filesystem read access. -:cpp:any:`UpdateFile()` may involve network communication if given the URL of a -remote server. - :cpp:any:`GameInterface::SortPlugins()` is expensive, as it involves loading all the content of all the plugins, apart from the game's main master file, which is skipped as an optimisation (it doesn't depend on anything else and is much bigger than any other plugin, so is unnecessary and slow to load). diff --git a/docs/api/reference.rst b/docs/api/reference.rst index c043259a..c4431f1a 100644 --- a/docs/api/reference.rst +++ b/docs/api/reference.rst @@ -33,12 +33,6 @@ Functions .. doxygenfunction:: loot::CreateGameHandle -.. doxygenfunction:: loot::UpdateFile - -.. doxygenfunction:: loot::GetFileRevision - -.. doxygenfunction:: loot::IsLatestFile - Interfaces ========== @@ -96,9 +90,6 @@ Exceptions .. doxygenclass:: loot::CyclicInteractionError :members: -.. doxygenclass:: loot::GitStateError - :members: - .. doxygenclass:: loot::ConditionSyntaxError :members: @@ -115,5 +106,3 @@ LOOT uses error category objects to identify errors with codes that originate in lower-level libraries. .. doxygenfunction:: loot::libloadorder_category - -.. doxygenfunction:: loot::libgit2_category diff --git a/docs/licenses/GNU GPL v2 (libgit2).txt b/docs/licenses/GNU GPL v2 (libgit2).txt deleted file mode 100644 index e0fed073..00000000 --- a/docs/licenses/GNU GPL v2 (libgit2).txt +++ /dev/null @@ -1,930 +0,0 @@ - libgit2 is Copyright (C) the libgit2 contributors, - unless otherwise stated. See the AUTHORS file for details. - - Note that the only valid version of the GPL as far as this project - is concerned is _this_ particular version of the license (ie v2, not - v2.2 or v3.x or whatever), unless explicitly otherwise stated. - ----------------------------------------------------------------------- - - LINKING EXCEPTION - - In addition to the permissions in the GNU General Public License, - the authors give you unlimited permission to link the compiled - version of this library into combinations with other programs, - and to distribute those combinations without any restriction - coming from the use of this file. (The General Public License - restrictions do apply in other respects; for example, they cover - modification of the file, and distribution when not linked into - a combined executable.) - ----------------------------------------------------------------------- - - GNU GENERAL PUBLIC LICENSE - Version 2, June 1991 - - Copyright (C) 1989, 1991 Free Software Foundation, Inc. - 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The licenses for most software are designed to take away your -freedom to share and change it. By contrast, the GNU General Public -License is intended to guarantee your freedom to share and change free -software--to make sure the software is free for all its users. This -General Public License applies to most of the Free Software -Foundation's software and to any other program whose authors commit to -using it. (Some other Free Software Foundation software is covered by -the GNU Library General Public License instead.) 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 -this service 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 make restrictions that forbid -anyone to deny you these rights or to ask you to surrender the rights. -These restrictions translate to certain responsibilities for you if you -distribute copies of the software, or if you modify it. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must give the recipients all the rights that -you have. 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. - - We protect your rights with two steps: (1) copyright the software, and -(2) offer you this license which gives you legal permission to copy, -distribute and/or modify the software. - - Also, for each author's protection and ours, we want to make certain -that everyone understands that there is no warranty for this free -software. If the software is modified by someone else and passed on, we -want its recipients to know that what they have is not the original, so -that any problems introduced by others will not reflect on the original -authors' reputations. - - Finally, any free program is threatened constantly by software -patents. We wish to avoid the danger that redistributors of a free -program will individually obtain patent licenses, in effect making the -program proprietary. To prevent this, we have made it clear that any -patent must be licensed for everyone's free use or not licensed at all. - - The precise terms and conditions for copying, distribution and -modification follow. - - GNU GENERAL PUBLIC LICENSE - TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION - - 0. This License applies to any program or other work which contains -a notice placed by the copyright holder saying it may be distributed -under the terms of this General Public License. The "Program", below, -refers to any such program or work, and a "work based on the Program" -means either the Program or any derivative work under copyright law: -that is to say, a work containing the Program or a portion of it, -either verbatim or with modifications and/or translated into another -language. (Hereinafter, translation is included without limitation in -the term "modification".) Each licensee is addressed as "you". - -Activities other than copying, distribution and modification are not -covered by this License; they are outside its scope. The act of -running the Program is not restricted, and the output from the Program -is covered only if its contents constitute a work based on the -Program (independent of having been made by running the Program). -Whether that is true depends on what the Program does. - - 1. You may copy and distribute 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 and disclaimer of warranty; keep intact all the -notices that refer to this License and to the absence of any warranty; -and give any other recipients of the Program a copy of this License -along with the Program. - -You may charge a fee for the physical act of transferring a copy, and -you may at your option offer warranty protection in exchange for a fee. - - 2. You may modify your copy or copies of the Program or any portion -of it, thus forming a work based on the Program, and copy and -distribute such modifications or work under the terms of Section 1 -above, provided that you also meet all of these conditions: - - a) You must cause the modified files to carry prominent notices - stating that you changed the files and the date of any change. - - b) You must cause any work that you distribute or publish, that in - whole or in part contains or is derived from the Program or any - part thereof, to be licensed as a whole at no charge to all third - parties under the terms of this License. - - c) If the modified program normally reads commands interactively - when run, you must cause it, when started running for such - interactive use in the most ordinary way, to print or display an - announcement including an appropriate copyright notice and a - notice that there is no warranty (or else, saying that you provide - a warranty) and that users may redistribute the program under - these conditions, and telling the user how to view a copy of this - License. (Exception: if the Program itself is interactive but - does not normally print such an announcement, your work based on - the Program is not required to print an announcement.) - -These requirements apply to the modified work as a whole. If -identifiable sections of that work are not derived from the Program, -and can be reasonably considered independent and separate works in -themselves, then this License, and its terms, do not apply to those -sections when you distribute them as separate works. But when you -distribute the same sections as part of a whole which is a work based -on the Program, the distribution of the whole must be on the terms of -this License, whose permissions for other licensees extend to the -entire whole, and thus to each and every part regardless of who wrote it. - -Thus, it is not the intent of this section to claim rights or contest -your rights to work written entirely by you; rather, the intent is to -exercise the right to control the distribution of derivative or -collective works based on the Program. - -In addition, mere aggregation of another work not based on the Program -with the Program (or with a work based on the Program) on a volume of -a storage or distribution medium does not bring the other work under -the scope of this License. - - 3. You may copy and distribute the Program (or a work based on it, -under Section 2) in object code or executable form under the terms of -Sections 1 and 2 above provided that you also do one of the following: - - a) Accompany it with the complete corresponding machine-readable - source code, which must be distributed under the terms of Sections - 1 and 2 above on a medium customarily used for software interchange; or, - - b) Accompany it with a written offer, valid for at least three - years, to give any third party, for a charge no more than your - cost of physically performing source distribution, a complete - machine-readable copy of the corresponding source code, to be - distributed under the terms of Sections 1 and 2 above on a medium - customarily used for software interchange; or, - - c) Accompany it with the information you received as to the offer - to distribute corresponding source code. (This alternative is - allowed only for noncommercial distribution and only if you - received the program in object code or executable form with such - an offer, in accord with Subsection b above.) - -The source code for a work means the preferred form of the work for -making modifications to it. For an executable work, complete source -code means all the source code for all modules it contains, plus any -associated interface definition files, plus the scripts used to -control compilation and installation of the executable. However, as a -special exception, the source code distributed need not include -anything that is normally distributed (in either source or binary -form) with the major components (compiler, kernel, and so on) of the -operating system on which the executable runs, unless that component -itself accompanies the executable. - -If distribution of executable or object code is made by offering -access to copy from a designated place, then offering equivalent -access to copy the source code from the same place counts as -distribution of the source code, even though third parties are not -compelled to copy the source along with the object code. - - 4. You may not copy, modify, sublicense, or distribute the Program -except as expressly provided under this License. Any attempt -otherwise to copy, modify, sublicense or distribute the Program is -void, and will automatically terminate your rights under this License. -However, parties who have received copies, or rights, from you under -this License will not have their licenses terminated so long as such -parties remain in full compliance. - - 5. You are not required to accept this License, since you have not -signed it. However, nothing else grants you permission to modify or -distribute the Program or its derivative works. These actions are -prohibited by law if you do not accept this License. Therefore, by -modifying or distributing the Program (or any work based on the -Program), you indicate your acceptance of this License to do so, and -all its terms and conditions for copying, distributing or modifying -the Program or works based on it. - - 6. Each time you redistribute the Program (or any work based on the -Program), the recipient automatically receives a license from the -original licensor to copy, distribute or modify the Program subject to -these terms and conditions. You may not impose any further -restrictions on the recipients' exercise of the rights granted herein. -You are not responsible for enforcing compliance by third parties to -this License. - - 7. If, as a consequence of a court judgment or allegation of patent -infringement or for any other reason (not limited to patent issues), -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 -distribute so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you -may not distribute the Program at all. For example, if a patent -license would not permit royalty-free redistribution of the Program by -all those who receive copies directly or indirectly through you, then -the only way you could satisfy both it and this License would be to -refrain entirely from distribution of the Program. - -If any portion of this section is held invalid or unenforceable under -any particular circumstance, the balance of the section is intended to -apply and the section as a whole is intended to apply in other -circumstances. - -It is not the purpose of this section to induce you to infringe any -patents or other property right claims or to contest validity of any -such claims; this section has the sole purpose of protecting the -integrity of the free software distribution system, which is -implemented by public license practices. Many people have made -generous contributions to the wide range of software distributed -through that system in reliance on consistent application of that -system; it is up to the author/donor to decide if he or she is willing -to distribute software through any other system and a licensee cannot -impose that choice. - -This section is intended to make thoroughly clear what is believed to -be a consequence of the rest of this License. - - 8. If the distribution and/or use of the Program is restricted in -certain countries either by patents or by copyrighted interfaces, the -original copyright holder who places the Program under this License -may add an explicit geographical distribution limitation excluding -those countries, so that distribution is permitted only in or among -countries not thus excluded. In such case, this License incorporates -the limitation as if written in the body of this License. - - 9. The Free Software Foundation may publish revised and/or new versions -of the 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 a version number of this License which applies to it and "any -later version", you have the option of following the terms and conditions -either of that version or of any later version published by the Free -Software Foundation. If the Program does not specify a version number of -this License, you may choose any version ever published by the Free Software -Foundation. - - 10. If you wish to incorporate parts of the Program into other free -programs whose distribution conditions are different, write to the author -to ask for permission. For software which is copyrighted by the Free -Software Foundation, write to the Free Software Foundation; we sometimes -make exceptions for this. Our decision will be guided by the two goals -of preserving the free status of all derivatives of our free software and -of promoting the sharing and reuse of software generally. - - NO WARRANTY - - 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, 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. - - 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR -REDISTRIBUTE 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. - - 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 -convey 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 2 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - - -Also add information on how to contact you by electronic and paper mail. - -If the program is interactive, make it output a short notice like this -when it starts in an interactive mode: - - Gnomovision version 69, Copyright (C) year name of author - Gnomovision 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, the commands you use may -be called something other than `show w' and `show c'; they could even be -mouse-clicks or menu items--whatever suits your program. - -You should also get your employer (if you work as a programmer) or your -school, if any, to sign a "copyright disclaimer" for the program, if -necessary. Here is a sample; alter the names: - - Yoyodyne, Inc., hereby disclaims all copyright interest in the program - `Gnomovision' (which makes passes at compilers) written by James Hacker. - - , 1 April 1989 - Ty Coon, President of Vice - -This 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 Library General -Public License instead of this License. - ----------------------------------------------------------------------- - -The bundled ZLib code is licensed under the ZLib license: - -Copyright (C) 1995-2010 Jean-loup Gailly and Mark Adler - - This software is provided 'as-is', without any express or implied - warranty. In no event will the authors be held liable for any damages - arising from the use of this software. - - Permission is granted to anyone to use this software for any purpose, - including commercial applications, and to alter it and redistribute it - freely, subject to the following restrictions: - - 1. The origin of this software must not be misrepresented; you must not - claim that you wrote the original software. If you use this software - in a product, an acknowledgment in the product documentation would be - appreciated but is not required. - 2. Altered source versions must be plainly marked as such, and must not be - misrepresented as being the original software. - 3. This notice may not be removed or altered from any source distribution. - - Jean-loup Gailly Mark Adler - jloup@gzip.org madler@alumni.caltech.edu - ----------------------------------------------------------------------- - -The priority queue implementation is based on code licensed under the -Apache 2.0 license: - - Copyright 2010 Volkan Yazıcı - Copyright 2006-2010 The Apache Software Foundation - -The full text of the Apache 2.0 license is available at: - - http://www.apache.org/licenses/LICENSE-2.0 - ----------------------------------------------------------------------- - -The Clay framework is licensed under the MIT license: - -Copyright (C) 2011 by Vicent Marti - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in -all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -THE SOFTWARE. - ----------------------------------------------------------------------- - -The regex library (deps/regex/) is licensed under the GNU LGPL - - GNU LESSER GENERAL PUBLIC LICENSE - Version 2.1, February 1999 - - Copyright (C) 1991, 1999 Free Software Foundation, Inc. - 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - -[This is the first released version of the Lesser GPL. It also counts - as the successor of the GNU Library Public License, version 2, hence - the version number 2.1.] - - Preamble - - The licenses for most software are designed to take away your -freedom to share and change it. By contrast, the GNU General Public -Licenses are intended to guarantee your freedom to share and change -free software--to make sure the software is free for all its users. - - This license, the Lesser General Public License, applies to some -specially designated software packages--typically libraries--of the -Free Software Foundation and other authors who decide to use it. You -can use it too, but we suggest you first think carefully about whether -this license or the ordinary General Public License is the better -strategy to use in any particular case, based on the explanations below. - - When we speak of free software, we are referring to freedom of use, -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 this service if you wish); that you receive source code or can get -it if you want it; that you can change the software and use pieces of -it in new free programs; and that you are informed that you can do -these things. - - To protect your rights, we need to make restrictions that forbid -distributors to deny you these rights or to ask you to surrender these -rights. These restrictions translate to certain responsibilities for -you if you distribute copies of the library or if you modify it. - - For example, if you distribute copies of the library, whether gratis -or for a fee, you must give the recipients all the rights that we gave -you. You must make sure that they, too, receive or can get the source -code. If you link other code with the library, you must provide -complete object files to the recipients, so that they can relink them -with the library after making changes to the library and recompiling -it. And you must show them these terms so they know their rights. - - We protect your rights with a two-step method: (1) we copyright the -library, and (2) we offer you this license, which gives you legal -permission to copy, distribute and/or modify the library. - - To protect each distributor, we want to make it very clear that -there is no warranty for the free library. Also, if the library is -modified by someone else and passed on, the recipients should know -that what they have is not the original version, so that the original -author's reputation will not be affected by problems that might be -introduced by others. - - Finally, software patents pose a constant threat to the existence of -any free program. We wish to make sure that a company cannot -effectively restrict the users of a free program by obtaining a -restrictive license from a patent holder. Therefore, we insist that -any patent license obtained for a version of the library must be -consistent with the full freedom of use specified in this license. - - Most GNU software, including some libraries, is covered by the -ordinary GNU General Public License. This license, the GNU Lesser -General Public License, applies to certain designated libraries, and -is quite different from the ordinary General Public License. We use -this license for certain libraries in order to permit linking those -libraries into non-free programs. - - When a program is linked with a library, whether statically or using -a shared library, the combination of the two is legally speaking a -combined work, a derivative of the original library. The ordinary -General Public License therefore permits such linking only if the -entire combination fits its criteria of freedom. The Lesser General -Public License permits more lax criteria for linking other code with -the library. - - We call this license the "Lesser" General Public License because it -does Less to protect the user's freedom than the ordinary General -Public License. It also provides other free software developers Less -of an advantage over competing non-free programs. These disadvantages -are the reason we use the ordinary General Public License for many -libraries. However, the Lesser license provides advantages in certain -special circumstances. - - For example, on rare occasions, there may be a special need to -encourage the widest possible use of a certain library, so that it becomes -a de-facto standard. To achieve this, non-free programs must be -allowed to use the library. A more frequent case is that a free -library does the same job as widely used non-free libraries. In this -case, there is little to gain by limiting the free library to free -software only, so we use the Lesser General Public License. - - In other cases, permission to use a particular library in non-free -programs enables a greater number of people to use a large body of -free software. For example, permission to use the GNU C Library in -non-free programs enables many more people to use the whole GNU -operating system, as well as its variant, the GNU/Linux operating -system. - - Although the Lesser General Public License is Less protective of the -users' freedom, it does ensure that the user of a program that is -linked with the Library has the freedom and the wherewithal to run -that program using a modified version of the Library. - - The precise terms and conditions for copying, distribution and -modification follow. Pay close attention to the difference between a -"work based on the library" and a "work that uses the library". The -former contains code derived from the library, whereas the latter must -be combined with the library in order to run. - - GNU LESSER GENERAL PUBLIC LICENSE - TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION - - 0. This License Agreement applies to any software library or other -program which contains a notice placed by the copyright holder or -other authorized party saying it may be distributed under the terms of -this Lesser General Public License (also called "this License"). -Each licensee is addressed as "you". - - A "library" means a collection of software functions and/or data -prepared so as to be conveniently linked with application programs -(which use some of those functions and data) to form executables. - - The "Library", below, refers to any such software library or work -which has been distributed under these terms. A "work based on the -Library" means either the Library or any derivative work under -copyright law: that is to say, a work containing the Library or a -portion of it, either verbatim or with modifications and/or translated -straightforwardly into another language. (Hereinafter, translation is -included without limitation in the term "modification".) - - "Source code" for a work means the preferred form of the work for -making modifications to it. For a library, complete source code means -all the source code for all modules it contains, plus any associated -interface definition files, plus the scripts used to control compilation -and installation of the library. - - Activities other than copying, distribution and modification are not -covered by this License; they are outside its scope. The act of -running a program using the Library is not restricted, and output from -such a program is covered only if its contents constitute a work based -on the Library (independent of the use of the Library in a tool for -writing it). Whether that is true depends on what the Library does -and what the program that uses the Library does. - - 1. You may copy and distribute verbatim copies of the Library's -complete source code as you receive it, in any medium, provided that -you conspicuously and appropriately publish on each copy an -appropriate copyright notice and disclaimer of warranty; keep intact -all the notices that refer to this License and to the absence of any -warranty; and distribute a copy of this License along with the -Library. - - You may charge a fee for the physical act of transferring a copy, -and you may at your option offer warranty protection in exchange for a -fee. - - 2. You may modify your copy or copies of the Library or any portion -of it, thus forming a work based on the Library, and copy and -distribute such modifications or work under the terms of Section 1 -above, provided that you also meet all of these conditions: - - a) The modified work must itself be a software library. - - b) You must cause the files modified to carry prominent notices - stating that you changed the files and the date of any change. - - c) You must cause the whole of the work to be licensed at no - charge to all third parties under the terms of this License. - - d) If a facility in the modified Library refers to a function or a - table of data to be supplied by an application program that uses - the facility, other than as an argument passed when the facility - is invoked, then you must make a good faith effort to ensure that, - in the event an application does not supply such function or - table, the facility still operates, and performs whatever part of - its purpose remains meaningful. - - (For example, a function in a library to compute square roots has - a purpose that is entirely well-defined independent of the - application. Therefore, Subsection 2d requires that any - application-supplied function or table used by this function must - be optional: if the application does not supply it, the square - root function must still compute square roots.) - -These requirements apply to the modified work as a whole. If -identifiable sections of that work are not derived from the Library, -and can be reasonably considered independent and separate works in -themselves, then this License, and its terms, do not apply to those -sections when you distribute them as separate works. But when you -distribute the same sections as part of a whole which is a work based -on the Library, the distribution of the whole must be on the terms of -this License, whose permissions for other licensees extend to the -entire whole, and thus to each and every part regardless of who wrote -it. - -Thus, it is not the intent of this section to claim rights or contest -your rights to work written entirely by you; rather, the intent is to -exercise the right to control the distribution of derivative or -collective works based on the Library. - -In addition, mere aggregation of another work not based on the Library -with the Library (or with a work based on the Library) on a volume of -a storage or distribution medium does not bring the other work under -the scope of this License. - - 3. You may opt to apply the terms of the ordinary GNU General Public -License instead of this License to a given copy of the Library. To do -this, you must alter all the notices that refer to this License, so -that they refer to the ordinary GNU General Public License, version 2, -instead of to this License. (If a newer version than version 2 of the -ordinary GNU General Public License has appeared, then you can specify -that version instead if you wish.) Do not make any other change in -these notices. - - Once this change is made in a given copy, it is irreversible for -that copy, so the ordinary GNU General Public License applies to all -subsequent copies and derivative works made from that copy. - - This option is useful when you wish to copy part of the code of -the Library into a program that is not a library. - - 4. You may copy and distribute the Library (or a portion or -derivative of it, under Section 2) in object code or executable form -under the terms of Sections 1 and 2 above provided that you accompany -it with the complete corresponding machine-readable source code, which -must be distributed under the terms of Sections 1 and 2 above on a -medium customarily used for software interchange. - - If distribution of object code is made by offering access to copy -from a designated place, then offering equivalent access to copy the -source code from the same place satisfies the requirement to -distribute the source code, even though third parties are not -compelled to copy the source along with the object code. - - 5. A program that contains no derivative of any portion of the -Library, but is designed to work with the Library by being compiled or -linked with it, is called a "work that uses the Library". Such a -work, in isolation, is not a derivative work of the Library, and -therefore falls outside the scope of this License. - - However, linking a "work that uses the Library" with the Library -creates an executable that is a derivative of the Library (because it -contains portions of the Library), rather than a "work that uses the -library". The executable is therefore covered by this License. -Section 6 states terms for distribution of such executables. - - When a "work that uses the Library" uses material from a header file -that is part of the Library, the object code for the work may be a -derivative work of the Library even though the source code is not. -Whether this is true is especially significant if the work can be -linked without the Library, or if the work is itself a library. The -threshold for this to be true is not precisely defined by law. - - If such an object file uses only numerical parameters, data -structure layouts and accessors, and small macros and small inline -functions (ten lines or less in length), then the use of the object -file is unrestricted, regardless of whether it is legally a derivative -work. (Executables containing this object code plus portions of the -Library will still fall under Section 6.) - - Otherwise, if the work is a derivative of the Library, you may -distribute the object code for the work under the terms of Section 6. -Any executables containing that work also fall under Section 6, -whether or not they are linked directly with the Library itself. - - 6. As an exception to the Sections above, you may also combine or -link a "work that uses the Library" with the Library to produce a -work containing portions of the Library, and distribute that work -under terms of your choice, provided that the terms permit -modification of the work for the customer's own use and reverse -engineering for debugging such modifications. - - You must give prominent notice with each copy of the work that the -Library is used in it and that the Library and its use are covered by -this License. You must supply a copy of this License. If the work -during execution displays copyright notices, you must include the -copyright notice for the Library among them, as well as a reference -directing the user to the copy of this License. Also, you must do one -of these things: - - a) Accompany the work with the complete corresponding - machine-readable source code for the Library including whatever - changes were used in the work (which must be distributed under - Sections 1 and 2 above); and, if the work is an executable linked - with the Library, with the complete machine-readable "work that - uses the Library", as object code and/or source code, so that the - user can modify the Library and then relink to produce a modified - executable containing the modified Library. (It is understood - that the user who changes the contents of definitions files in the - Library will not necessarily be able to recompile the application - to use the modified definitions.) - - b) Use a suitable shared library mechanism for linking with the - Library. A suitable mechanism is one that (1) uses at run time a - copy of the library already present on the user's computer system, - rather than copying library functions into the executable, and (2) - will operate properly with a modified version of the library, if - the user installs one, as long as the modified version is - interface-compatible with the version that the work was made with. - - c) Accompany the work with a written offer, valid for at - least three years, to give the same user the materials - specified in Subsection 6a, above, for a charge no more - than the cost of performing this distribution. - - d) If distribution of the work is made by offering access to copy - from a designated place, offer equivalent access to copy the above - specified materials from the same place. - - e) Verify that the user has already received a copy of these - materials or that you have already sent this user a copy. - - For an executable, the required form of the "work that uses the -Library" must include any data and utility programs needed for -reproducing the executable from it. However, as a special exception, -the materials to be distributed need not include anything that is -normally distributed (in either source or binary form) with the major -components (compiler, kernel, and so on) of the operating system on -which the executable runs, unless that component itself accompanies -the executable. - - It may happen that this requirement contradicts the license -restrictions of other proprietary libraries that do not normally -accompany the operating system. Such a contradiction means you cannot -use both them and the Library together in an executable that you -distribute. - - 7. You may place library facilities that are a work based on the -Library side-by-side in a single library together with other library -facilities not covered by this License, and distribute such a combined -library, provided that the separate distribution of the work based on -the Library and of the other library facilities is otherwise -permitted, and provided that you do these two things: - - a) Accompany the combined library with a copy of the same work - based on the Library, uncombined with any other library - facilities. This must be distributed under the terms of the - Sections above. - - b) Give prominent notice with the combined library of the fact - that part of it is a work based on the Library, and explaining - where to find the accompanying uncombined form of the same work. - - 8. You may not copy, modify, sublicense, link with, or distribute -the Library except as expressly provided under this License. Any -attempt otherwise to copy, modify, sublicense, link with, or -distribute the Library is void, and will automatically terminate your -rights under this License. However, parties who have received copies, -or rights, from you under this License will not have their licenses -terminated so long as such parties remain in full compliance. - - 9. You are not required to accept this License, since you have not -signed it. However, nothing else grants you permission to modify or -distribute the Library or its derivative works. These actions are -prohibited by law if you do not accept this License. Therefore, by -modifying or distributing the Library (or any work based on the -Library), you indicate your acceptance of this License to do so, and -all its terms and conditions for copying, distributing or modifying -the Library or works based on it. - - 10. Each time you redistribute the Library (or any work based on the -Library), the recipient automatically receives a license from the -original licensor to copy, distribute, link with or modify the Library -subject to these terms and conditions. You may not impose any further -restrictions on the recipients' exercise of the rights granted herein. -You are not responsible for enforcing compliance by third parties with -this License. - - 11. If, as a consequence of a court judgment or allegation of patent -infringement or for any other reason (not limited to patent issues), -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 -distribute so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you -may not distribute the Library at all. For example, if a patent -license would not permit royalty-free redistribution of the Library by -all those who receive copies directly or indirectly through you, then -the only way you could satisfy both it and this License would be to -refrain entirely from distribution of the Library. - -If any portion of this section is held invalid or unenforceable under any -particular circumstance, the balance of the section is intended to apply, -and the section as a whole is intended to apply in other circumstances. - -It is not the purpose of this section to induce you to infringe any -patents or other property right claims or to contest validity of any -such claims; this section has the sole purpose of protecting the -integrity of the free software distribution system which is -implemented by public license practices. Many people have made -generous contributions to the wide range of software distributed -through that system in reliance on consistent application of that -system; it is up to the author/donor to decide if he or she is willing -to distribute software through any other system and a licensee cannot -impose that choice. - -This section is intended to make thoroughly clear what is believed to -be a consequence of the rest of this License. - - 12. If the distribution and/or use of the Library is restricted in -certain countries either by patents or by copyrighted interfaces, the -original copyright holder who places the Library under this License may add -an explicit geographical distribution limitation excluding those countries, -so that distribution is permitted only in or among countries not thus -excluded. In such case, this License incorporates the limitation as if -written in the body of this License. - - 13. The Free Software Foundation may publish revised and/or new -versions of the Lesser 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 Library -specifies a version number of this License which applies to it and -"any later version", you have the option of following the terms and -conditions either of that version or of any later version published by -the Free Software Foundation. If the Library does not specify a -license version number, you may choose any version ever published by -the Free Software Foundation. - - 14. If you wish to incorporate parts of the Library into other free -programs whose distribution conditions are incompatible with these, -write to the author to ask for permission. For software which is -copyrighted by the Free Software Foundation, write to the Free -Software Foundation; we sometimes make exceptions for this. Our -decision will be guided by the two goals of preserving the free status -of all derivatives of our free software and of promoting the sharing -and reuse of software generally. - - NO WARRANTY - - 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO -WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. -EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR -OTHER PARTIES PROVIDE THE LIBRARY "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 -LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME -THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN -WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY -AND/OR REDISTRIBUTE THE LIBRARY 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 -LIBRARY (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 LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF -SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH -DAMAGES. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Libraries - - If you develop a new library, and you want it to be of the greatest -possible use to the public, we recommend making it free software that -everyone can redistribute and change. You can do so by permitting -redistribution under these terms (or, alternatively, under the terms of the -ordinary General Public License). - - To apply these terms, attach the following notices to the library. It is -safest to attach them to the start of each source file to most effectively -convey 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 library is free software; you can redistribute it and/or - modify it under the terms of the GNU Lesser General Public - License as published by the Free Software Foundation; either - version 2.1 of the License, or (at your option) any later version. - - This library 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 - Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General Public - License along with this library; if not, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA - -Also add information on how to contact you by electronic and paper mail. - -You should also get your employer (if you work as a programmer) or your -school, if any, to sign a "copyright disclaimer" for the library, if -necessary. Here is a sample; alter the names: - - Yoyodyne, Inc., hereby disclaims all copyright interest in the - library `Frob' (a library for tweaking knobs) written by James Random Hacker. - - , 1 April 1990 - Ty Coon, President of Vice - -That's all there is to it! diff --git a/docs/licenses/texts.rst b/docs/licenses/texts.rst index a236b636..a94a7f11 100644 --- a/docs/licenses/texts.rst +++ b/docs/licenses/texts.rst @@ -12,14 +12,6 @@ Copyright License Texts .. include:: Boost Software License v1.0.txt :literal: -`libgit2`_ -========== - -.. _libgit2: https://github.com/libgit2/libgit2 - -.. include:: GNU GPL v2 (libgit2).txt - :literal: - libloot, `esplugin`_ & `Libloadorder`_ ====================================== diff --git a/include/loot/api.h b/include/loot/api.h index f34c9f82..be9e3ea3 100644 --- a/include/loot/api.h +++ b/include/loot/api.h @@ -37,7 +37,6 @@ #include "loot/exception/cyclic_interaction_error.h" #include "loot/exception/error_categories.h" #include "loot/exception/file_access_error.h" -#include "loot/exception/git_state_error.h" #include "loot/exception/undefined_group_error.h" #include "loot/game_interface.h" #include "loot/loot_version.h" @@ -110,74 +109,6 @@ LOOT_API std::shared_ptr CreateGameHandle( const GameType game, const std::filesystem::path& game_path, const std::filesystem::path& game_local_path = ""); - - -/**@}*/ -/**********************************************************************/ /** - * @name File Versioning Functions - *************************************************************************/ -/**@{*/ - -/** - * @brief Update the given masterlist or masterlist prelude file. - * @details Uses Git to update the given file using a given remote. - * If the file doesn't exist, this will create it. This - * function also initialises a Git repository in the given - * file's parent folder. - * - * If a Git repository is already present, it will be used to - * perform a diff-only update, but if for any reason a - * fast-forward merge update is not possible, the existing - * repository will be deleted and a new repository cloned from - * the given remote. - * @param file_path - * The relative or absolute path to the file that should be - * updated. The filename must match the filename of the file in the - * given remote repository, otherwise it will not be updated - * correctly. The file must be present in the repository's root - * directory. - * @param remote_url - * The URL of the remote from which to fetch updates. This can also be - * a relative or absolute path to a local repository. - * @param remote_branch - * The branch of the remote from which to apply updates. - * @returns `true` if the file was updated. `false` if no update was - * necessary, ie. it was already up-to-date. - */ -LOOT_API bool UpdateFile(const std::filesystem::path& file_path, - const std::string& remote_url, - const std::string& remote_branch); - -/** - * @brief Get the given masterlist or masterlist prelude file's revision. - * @details Getting a file's revision is only possible if it is found - * in the root of a local Git repository. - * @param file_path - * The relative or absolute path to the file that should be queried. - * @param get_short_id - * If `true`, the shortest unique hexadecimal revision hash that is at - * least 7 characters long will be outputted. Otherwise, the full 40 - * character hash will be outputted. - * @returns The revision data. - */ -LOOT_API FileRevision GetFileRevision(const std::filesystem::path& file_path, - const bool get_short_id); - -/** - * Check if the given masterlist or masterlist prelude file is the latest - * available for a given branch. - * @param file_path - * The relative or absolute path to the file for which the latest - * revision should be obtained. It needs to be in the root of a local - * Git repository. - * @param branch - * The branch to check against. - * @return True if the file's current revision matches its latest revision - * for the given branch, and false otherwise. - */ -LOOT_API bool IsLatestFile(const std::filesystem::path& file_path, - const std::string& branch); - } #endif diff --git a/include/loot/exception/error_categories.h b/include/loot/exception/error_categories.h index 5518dc34..5e4f0bba 100644 --- a/include/loot/exception/error_categories.h +++ b/include/loot/exception/error_categories.h @@ -36,13 +36,6 @@ namespace loot { derived from std::error_category. */ LOOT_API const std::error_category& libloadorder_category(); - -/** @brief Get the error category that can be used to identify system_error - * exceptions that are due to libgit2 errors. - * @returns A reference to the static object of unspecified runtime type, - derived from std::error_category. - */ -LOOT_API const std::error_category& libgit2_category(); } #endif diff --git a/include/loot/exception/git_state_error.h b/include/loot/exception/git_state_error.h deleted file mode 100644 index b269e67f..00000000 --- a/include/loot/exception/git_state_error.h +++ /dev/null @@ -1,41 +0,0 @@ -/* LOOT - - A load order optimisation tool for Oblivion, Skyrim, Fallout 3 and - Fallout: New Vegas. - - Copyright (C) 2012-2016 WrinklyNinja - - This file is part of LOOT. - - LOOT 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. - - LOOT 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 LOOT. If not, see - . - */ - -#ifndef LOOT_EXCEPTION_GIT_STATE_ERROR -#define LOOT_EXCEPTION_GIT_STATE_ERROR - -#include - -namespace loot { -/** - * @brief An exception class thrown if an error occurs when performing - * an operation on a Git repository due to invalid state. - */ -class GitStateError : public std::logic_error { -public: - using std::logic_error::logic_error; -}; -} - -#endif diff --git a/src/api/api.cpp b/src/api/api.cpp index 77eb79b5..5aa7d14e 100644 --- a/src/api/api.cpp +++ b/src/api/api.cpp @@ -28,7 +28,6 @@ #include "api/game/game.h" #include "api/helpers/logging.h" -#include "api/helpers/git.h" namespace fs = std::filesystem; @@ -98,26 +97,4 @@ LOOT_API std::shared_ptr CreateGameHandle( return std::make_shared(game, resolvedGamePath, resolvedGameLocalPath); } - -bool UpdateFile(const std::filesystem::path& masterlistPath, - const std::string& remoteURL, - const std::string& remoteBranch) { - if (!std::filesystem::is_directory(masterlistPath.parent_path())) - throw std::invalid_argument("The path \"" + masterlistPath.u8string() + - "\" does not have a valid parent directory."); - - return git::UpdateFile(masterlistPath, remoteURL, remoteBranch); -} - -FileRevision GetFileRevision( - const std::filesystem::path& masterlistPath, - const bool getShortID) { - return git::GetVersionInfo(masterlistPath, getShortID); -} - -bool IsLatestFile( - const std::filesystem::path& masterlist_path, - const std::string& branch) { - return git::IsLatest(masterlist_path, branch); -} } diff --git a/src/api/error_categories.cpp b/src/api/error_categories.cpp index ceaef001..8ca5fd75 100644 --- a/src/api/error_categories.cpp +++ b/src/api/error_categories.cpp @@ -38,26 +38,10 @@ class libloadorder_category : public std::error_category { return code.category().name() == name(); } }; - -class libgit2_category : public std::error_category { - virtual const char* name() const noexcept { return "libgit2"; } - - virtual std::string message(int ev) const { return "libgit2 error"; } - - virtual bool equivalent(const std::error_code& code, int condition) const - noexcept { - return code.category().name() == name(); - } -}; } LOOT_API const std::error_category& libloadorder_category() { static detail::libloadorder_category instance; return instance; } - -LOOT_API const std::error_category& libgit2_category() { - static detail::libgit2_category instance; - return instance; -} } diff --git a/src/api/helpers/git.cpp b/src/api/helpers/git.cpp deleted file mode 100644 index ff6d2b1d..00000000 --- a/src/api/helpers/git.cpp +++ /dev/null @@ -1,737 +0,0 @@ -/* LOOT - - A load order optimisation tool for Oblivion, Skyrim, Fallout 3 and - Fallout: New Vegas. - - Copyright (C) 2012-2016 WrinklyNinja - - This file is part of LOOT. - - LOOT 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. - - LOOT 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 LOOT. If not, see - . - */ - -#include "api/helpers/git.h" - -#include -#include - -#include -#include -#include - -#include "api/helpers/logging.h" -#include "loot/exception/error_categories.h" -#include "loot/exception/file_access_error.h" -#include "loot/exception/git_state_error.h" - -using std::string; - -namespace fs = std::filesystem; - -namespace loot { -namespace git { - -bool UpdateFile(const std::filesystem::path& path, - const std::string& repoUrl, - const std::string& repoBranch) { - GitHelper git; - auto logger = getLogger(); - fs::path repoPath = path.parent_path(); - string filename = path.filename().u8string(); - - if (path.empty() || repoUrl.empty() || repoBranch.empty()) - throw std::invalid_argument("Repository path, URL and branch must not be empty."); - - git.InitialiseOptions(repoBranch, filename); - - // Now try to access the repository if it exists, or clone one if it doesn't. - if (logger) { - logger->trace("Checking for Git repository at: {}", repoPath.u8string()); - } - if (!GitHelper::IsRepository(repoPath)) { - git.Clone(repoPath, repoUrl); - } else { - git.Open(repoPath); - - // Set the remote URL. This assumes a single-URL remote called "origin" - // exists. - git.SetRemoteUrl("origin", repoUrl); - - // Now fetch updates from the remote. - git.Fetch("origin"); - - if (logger) { - logger->debug( - "Checking if branch {} is up to date and checked out without edits", - repoBranch); - } - - if (git.BranchExists(repoBranch)) { - if (git.IsBranchUpToDate(repoBranch) && - git.IsBranchCheckedOut(repoBranch) && - !GitHelper::IsFileDifferent(repoPath, filename)) { - if (logger) { - logger->info( - "Local branch and masterlist file are already up to date."); - } - return false; - } - - git.DeleteBranch(repoBranch); - } - - // No local branch exists, create and checkout a new one from the remote. - git.CheckoutNewBranch("origin", repoBranch); - } - - // Now whether the repository was cloned or updated, the working directory - // contains the latest masterlist. - return true; -} - -FileRevision GetVersionInfo(const std::filesystem::path& path, - bool shortID) { - // Compare HEAD and working copy, and get revision info. - GitHelper git; - FileRevision revision; - - auto logger = getLogger(); - - if (!fs::exists(path)) { - if (logger) { - logger->info("Unknown masterlist revision: No masterlist present."); - } - throw FileAccessError(string("N/A: No masterlist present at ") + - path.u8string()); - } else if (!git.IsRepository(path.parent_path())) { - if (logger) { - logger->info("Unknown masterlist revision: Git repository missing."); - } - throw GitStateError(string("Unknown: \"") + path.parent_path().u8string() + - "\" is not a Git repository."); - } - - git.Open(path.parent_path()); - - revision.id = git.GetHeadCommitId(shortID); - revision.date = git.GetHeadCommitDate(); - - if (logger) { - logger->trace("Diffing masterlist HEAD and working copy."); - } - revision.is_modified = - GitHelper::IsFileDifferent(path.parent_path(), path.filename().u8string()); - - return revision; -} - -bool IsLatest(const std::filesystem::path& path, - const std::string& repoBranch) { - if (repoBranch.empty()) - throw std::invalid_argument("Repository branch must not be empty."); - - GitHelper git; - auto logger = getLogger(); - - if (!git.IsRepository(path.parent_path())) { - if (logger) { - logger->info( - "Cannot get latest masterlist revision: Git repository missing."); - } - throw GitStateError(string("Unknown: \"") + path.parent_path().u8string() + - "\" is not a Git repository."); - } - - git.Open(path.parent_path()); - - git.Fetch("origin"); - - return git.BranchExists(repoBranch) && git.IsBranchUpToDate(repoBranch) && - git.IsBranchCheckedOut(repoBranch); -} -} - - -GitHelper::GitData::GitData() : - repo(nullptr), - remote(nullptr), - config(nullptr), - object(nullptr), - commit(nullptr), - reference(nullptr), - reference2(nullptr), - blob(nullptr), - annotated_commit(nullptr), - tree(nullptr), - diff(nullptr), - buffer({0}) { - // Init threading system and OpenSSL (for Linux builds). - git_libgit2_init(); - - checkout_options = GIT_CHECKOUT_OPTIONS_INIT; - clone_options = GIT_CLONE_OPTIONS_INIT; -} - -GitHelper::GitData::~GitData() { - git_commit_free(commit); - git_object_free(object); - git_config_free(config); - git_remote_free(remote); - git_repository_free(repo); - git_reference_free(reference); - git_reference_free(reference2); - git_blob_free(blob); - git_annotated_commit_free(annotated_commit); - git_tree_free(tree); - git_diff_free(diff); - git_buf_free(&buffer); - git_strarray_free(&checkout_options.paths); - - git_libgit2_shutdown(); -} - -void GitHelper::InitialiseOptions(const std::string& branch, - const std::string& filenameToCheckout) { - auto logger = getLogger(); - if (logger) { - logger->debug( - "Setting up checkout options using branch {} and filename {}.", - branch, - filenameToCheckout); - } - - data_.checkout_options.checkout_strategy = - GIT_CHECKOUT_FORCE | GIT_CHECKOUT_DONT_REMOVE_EXISTING; - - char** paths = new char*[1]; - paths[0] = new char[filenameToCheckout.length() + 1]; - strcpy(paths[0], filenameToCheckout.c_str()); - - data_.checkout_options.paths.strings = paths; - data_.checkout_options.paths.count = 1; - - // Initialise clone options. - data_.clone_options.checkout_opts = data_.checkout_options; - data_.clone_options.bare = 0; - data_.clone_options.checkout_branch = branch.c_str(); -} - -void GitHelper::Open(const std::filesystem::path& repoRoot) { - auto logger = getLogger(); - if (logger) { - logger->info("Attempting to open Git repository at: {}", - repoRoot.u8string()); - } - Call(git_repository_open(&data_.repo, repoRoot.u8string().c_str())); -} - -void GitHelper::SetRemoteUrl(const std::string& remote, - const std::string& url) { - if (data_.repo == nullptr) { - throw GitStateError( - "Cannot set remote URL for repository that has not been opened."); - } - - auto logger = getLogger(); - if (logger) { - logger->info("Setting URL for remote {} to {}", remote, url); - } - - Call(git_remote_set_url(data_.repo, remote.c_str(), url.c_str())); -} - -void GitHelper::Call(int error_code) { - if (!error_code) - return; - - const git_error* last_error = giterr_last(); - std::string gitError; - if (last_error == nullptr) - gitError = std::to_string(error_code) + "."; - else - gitError = std::to_string(error_code) + "; " + last_error->message; - giterr_clear(); - - auto message = "Git operation failed. Details: " + gitError; - - throw std::system_error(error_code, libgit2_category(), message); -} - -bool GitHelper::IsRepository(const std::filesystem::path& path) { - return git_repository_open_ext(NULL, - path.u8string().c_str(), - GIT_REPOSITORY_OPEN_NO_SEARCH, - NULL) == 0; -} - -int GitHelper::DiffFileCallback(const git_diff_delta* delta, - float progress, - void* payload) { - auto logger = getLogger(); - if (logger) { - logger->trace("Checking diff for: {}", delta->old_file.path); - } - - DiffPayload* gdp = (DiffPayload*)payload; - if (strcmp(delta->old_file.path, gdp->fileToFind) == 0) { - if (logger) { - logger->warn("Edited masterlist found."); - } - gdp->fileFound = true; - } - - return 0; -} - -// Clones a repository and opens it. -void GitHelper::Clone(const std::filesystem::path& path, - const std::string& url) { - if (data_.repo != nullptr) - throw GitStateError( - "Cannot clone repository that has already been opened."); - - // Clone the remote repository. - auto logger = getLogger(); - if (logger) { - logger->info("Repository doesn't exist, cloning the remote repository at \"{}\".", url); - } - - fs::create_directories(path.parent_path()); - - // If the target path is not an empty directory, clone into a temporary - // directory. - fs::path repoPath; - if (fs::exists(path) && !fs::is_empty(path)) { - if (logger) { - logger->trace("Target repo path not empty, cloning into temporary directory."); - } - auto directory = "LOOT-" + path.filename().u8string() + "-" + - boost::lexical_cast((boost::uuids::random_generator())()); - repoPath = fs::temp_directory_path() / directory; - - // Remove path in case it already exists. - fs::remove_all(repoPath); - } else { - repoPath = path; - } - - // Perform the clone. - Call(git_clone(&data_.repo, - url.c_str(), - repoPath.u8string().c_str(), - &data_.clone_options)); - - // If repo was cloned into a temporary directory, move it into the target - // path. - if (repoPath != path) { - // Free the repository to ensure all file handles are closed. - git_repository_free(data_.repo); - data_.repo = nullptr; - - if (logger) { - logger->trace( - "Target repo path not empty, moving cloned files in."); - } - - std::vector filenamesToMove; - for (fs::directory_iterator it(repoPath); - it != fs::directory_iterator(); - ++it) { - // libgit2 v0.28.1 creates a _git2_ symlink on clone. - if (!it->is_regular_file() && !it->is_directory()) { - continue; - } - - auto targetPath = path / it->path().filename(); - if (fs::exists(targetPath)) { - fs::remove_all(targetPath); - } - filenamesToMove.push_back(it->path().filename()); - } - - for (const auto& filename : filenamesToMove) { - fs::copy(repoPath / filename, path / filename, std::filesystem::copy_options::recursive); - } - - try { - fs::remove_all(repoPath); - } catch (std::exception& e) { - if (logger) { - logger->error( - "Could not delete temporary repository path \"{}\": {}", - repoPath.u8string(), e.what()); - } - } - - // Open the repo again. - Open(path); - } -} - -void GitHelper::Fetch(const std::string& remote) { - if (data_.repo == nullptr) - throw GitStateError( - "Cannot fetch updates for repository that has not been opened."); - - auto logger = getLogger(); - if (logger) { - logger->trace("Fetching updates from remote."); - } - - // Get the origin remote. - Call(git_remote_lookup(&data_.remote, data_.repo, remote.c_str())); - - // Now fetch any updates. - git_fetch_options fetch_options = GIT_FETCH_OPTIONS_INIT; - Call(git_remote_fetch(data_.remote, nullptr, &fetch_options, nullptr)); - - // Log some stats on what was fetched either during update or clone. - const git_transfer_progress* stats = git_remote_stats(data_.remote); - if (logger) { - logger->trace("Received {} of {} objects in {} bytes.", - stats->indexed_objects, - stats->total_objects, - stats->received_bytes); - } - - git_remote_free(data_.remote); - data_.remote = nullptr; -} - -void GitHelper::CheckoutNewBranch(const std::string& remote, - const std::string& branch) { - if (data_.repo == nullptr) - throw GitStateError( - "Cannot fetch updates for repository that has not been opened."); - else if (data_.commit != nullptr) - throw GitStateError( - "Cannot fetch repository updates, commit memory already allocated."); - else if (data_.object != nullptr) - throw GitStateError( - "Cannot fetch repository updates, object memory already allocated."); - else if (data_.reference != nullptr) - throw GitStateError( - "Cannot fetch repository updates, reference memory already allocated."); - - auto logger = getLogger(); - if (logger) { - logger->trace("Looking up commit referred to by the remote branch \"{}\".", - branch); - } - Call(git_revparse_single( - &data_.object, data_.repo, (remote + "/" + branch).c_str())); - const git_oid* commit_id = git_object_id(data_.object); - - if (logger) { - logger->trace("Creating the new branch."); - } - Call(git_commit_lookup(&data_.commit, data_.repo, commit_id)); - Call(git_branch_create( - &data_.reference, data_.repo, branch.c_str(), data_.commit, 1)); - - if (logger) { - logger->trace("Setting the upstream for the new branch."); - } - Call(git_branch_set_upstream(data_.reference, - (remote + "/" + branch).c_str())); - - // Check if HEAD points to the desired branch and set it to if not. - if (!git_branch_is_head(data_.reference)) { - if (logger) { - logger->trace("Setting HEAD to follow branch: {}", branch); - } - Call(git_repository_set_head(data_.repo, - (string("refs/heads/") + branch).c_str())); - } - - if (logger) { - logger->trace("Performing a Git checkout of HEAD."); - } - Call(git_checkout_head(data_.repo, &data_.checkout_options)); - - // Free tree and commit pointers. Reference pointer is still used below. - git_object_free(data_.object); - git_commit_free(data_.commit); - git_reference_free(data_.reference); - data_.commit = nullptr; - data_.object = nullptr; - data_.reference = nullptr; -} - -void GitHelper::DeleteBranch(const std::string& branch) { - if (data_.repo == nullptr) { - throw GitStateError( - "Cannot delete branch for repository that has not been opened."); - } else if (data_.reference != nullptr) { - throw GitStateError( - "Cannot delete branch, reference memory already allocated."); - } - - Call(git_branch_lookup( - &data_.reference, data_.repo, branch.c_str(), GIT_BRANCH_LOCAL)); - - auto logger = getLogger(); - int ret = git_branch_is_head(data_.reference); - if (ret == 1) { - if (logger) { - logger->debug("Detaching HEAD before deleting branch."); - } - git_repository_detach_head(data_.repo); - } else { - Call(ret); - } - - if (logger) { - logger->debug("Deleting branch."); - } - - Call(git_branch_delete(data_.reference)); - - git_reference_free(data_.reference); - data_.reference = nullptr; -} - -bool GitHelper::BranchExists(const std::string& branch) { - if (data_.repo == nullptr) { - throw GitStateError( - "Cannot check branch existence for repository that has not been " - "opened."); - } else if (data_.reference != nullptr) { - throw GitStateError( - "Cannot check branch existence, reference memory already allocated."); - } - - int ret = git_branch_lookup( - &data_.reference, data_.repo, branch.c_str(), GIT_BRANCH_LOCAL); - if (ret != GIT_ENOTFOUND) { - // Handle other errors from preceding branch lookup. - Call(ret); - - git_reference_free(data_.reference); - data_.reference = nullptr; - - return true; - } - - return false; -} - -bool GitHelper::IsBranchUpToDate(const std::string& branch) { - if (data_.repo == nullptr) { - throw GitStateError( - "Cannot check branch existence for repository that has not been " - "opened."); - } else if (data_.reference != nullptr) { - throw GitStateError( - "Cannot check branch existence, reference memory already allocated."); - } else if (data_.reference2 != nullptr) { - throw GitStateError( - "Cannot check branch existence, reference2 memory already allocated."); - } - - Call(git_branch_lookup( - &data_.reference, data_.repo, branch.c_str(), GIT_BRANCH_LOCAL)); - - // Get remote branch reference. - Call(git_branch_lookup(&data_.reference2, - data_.repo, - ("origin/" + branch).c_str(), - GIT_BRANCH_REMOTE)); - - // Get the branch tips' commit IDs. - auto local_commit_id = GetCommitId(data_.reference); - auto remote_commit_id = GetCommitId(data_.reference2); - - bool upToDate = memcmp(local_commit_id->id, remote_commit_id->id, 20) == 0; - - // Free the remote branch reference. - git_reference_free(data_.reference2); - data_.reference2 = nullptr; - - git_reference_free(data_.reference); - data_.reference = nullptr; - - return upToDate; -} - -bool GitHelper::IsBranchCheckedOut(const std::string& branch) { - if (data_.repo == nullptr) { - throw GitStateError( - "Cannot check branch existence for repository that has not been " - "opened."); - } else if (data_.reference != nullptr) { - throw GitStateError( - "Cannot check branch existence, reference memory already allocated."); - } - - Call(git_branch_lookup( - &data_.reference, data_.repo, branch.c_str(), GIT_BRANCH_LOCAL)); - - bool isCheckedOut = git_branch_is_checked_out(data_.reference); - - git_reference_free(data_.reference); - data_.reference = nullptr; - - return isCheckedOut; -} - -const git_oid* GitHelper::GetCommitId(git_reference* reference) { - if (reference == nullptr) - throw GitStateError( - "Cannot get the commit ID of a null git_reference pointer."); - else if (data_.object != nullptr) - throw GitStateError( - "Cannot fetch repository updates, object memory already allocated."); - - Call(git_reference_peel(&data_.object, reference, GIT_OBJ_COMMIT)); - const git_oid* remote_commit_id = git_object_id(data_.object); - - git_object_free(data_.object); - data_.object = nullptr; - - return remote_commit_id; -} - -std::string GitHelper::GetHeadCommitId(bool shortId) { - if (data_.repo == nullptr) - throw GitStateError( - "Cannot checkout revision for repository that has not been opened."); - else if (data_.object != nullptr) - throw GitStateError( - "Cannot fetch repository updates, object memory already allocated."); - else if (data_.reference != nullptr) - throw GitStateError( - "Cannot fetch repository updates, reference memory already allocated."); - else if (data_.buffer.ptr != nullptr) - throw GitStateError( - "Cannot fetch repository updates, buffer memory already allocated."); - - auto logger = getLogger(); - if (logger) { - logger->trace("Getting the Git object for HEAD."); - } - Call(git_repository_head(&data_.reference, data_.repo)); - - std::string id; - if (shortId) { - Call(git_reference_peel(&data_.object, data_.reference, GIT_OBJ_COMMIT)); - - if (logger) { - logger->trace("Generating hex string for Git object ID."); - } - Call(git_object_short_id(&data_.buffer, data_.object)); - id = data_.buffer.ptr; - - git_object_free(data_.object); - git_buf_free(&data_.buffer); - data_.object = nullptr; - data_.buffer = {0}; - } else { - auto commit_id = GetCommitId(data_.reference); - char c_rev[GIT_OID_HEXSZ + 1]; - - id = git_oid_tostr(c_rev, GIT_OID_HEXSZ + 1, commit_id); - } - - git_reference_free(data_.reference); - data_.reference = nullptr; - - return id; -} - -std::string GitHelper::GetHeadCommitDate() { - if (data_.repo == nullptr) { - throw GitStateError( - "Cannot get HEAD commit date for repository that has not been opened."); - } else if (data_.commit != nullptr) { - throw GitStateError( - "Cannot get HEAD commit date, commit memory already allocated."); - } else if (data_.reference != nullptr) { - throw GitStateError( - "Cannot get HEAD commit date, reference memory already allocated."); - } - - auto logger = getLogger(); - if (logger) { - logger->trace("Getting the Git reference for HEAD."); - } - Call(git_repository_head(&data_.reference, data_.repo)); - - auto commit_id = GetCommitId(data_.reference); - - git_reference_free(data_.reference); - data_.reference = nullptr; - - if (logger) { - logger->trace("Getting commit for ID."); - } - - Call(git_commit_lookup(&data_.commit, data_.repo, commit_id)); - git_time_t time = git_commit_time(data_.commit); - - git_commit_free(data_.commit); - data_.commit = nullptr; - - std::ostringstream out; - out << std::put_time(std::gmtime(&time), "%Y-%m-%d"); - return out.str(); -} - -bool GitHelper::IsFileDifferent(const std::filesystem::path& repoRoot, - const std::string& filename) { - auto logger = getLogger(); - - if (!IsRepository(repoRoot)) { - if (logger) { - logger->info("Unknown masterlist revision: Git repository missing."); - } - throw GitStateError("Cannot check if the \"" + filename + - "\" working copy is edited, Git repository missing."); - } - - if (logger) { - logger->trace("Existing repository found, attempting to open it."); - } - GitHelper git; - git.Call(git_repository_open(&git.data_.repo, repoRoot.u8string().c_str())); - - // Perform a git diff, then iterate the deltas to see if one exists for the - // masterlist. - if (logger) { - logger->trace("Getting the tree for the HEAD revision."); - } - git.Call( - git_revparse_single(&git.data_.object, git.data_.repo, "HEAD^{tree}")); - git.Call(git_tree_lookup( - &git.data_.tree, git.data_.repo, git_object_id(git.data_.object))); - - if (logger) { - logger->trace("Performing git diff."); - } - git.Call(git_diff_tree_to_workdir_with_index( - &git.data_.diff, git.data_.repo, git.data_.tree, NULL)); - - if (logger) { - logger->trace("Iterating over git diff deltas."); - } - GitHelper::DiffPayload payload; - payload.fileFound = false; - payload.fileToFind = filename.c_str(); - git.Call(git_diff_foreach( - git.data_.diff, &git.DiffFileCallback, NULL, NULL, NULL, &payload)); - - return payload.fileFound; -} -} diff --git a/src/api/helpers/git.h b/src/api/helpers/git.h deleted file mode 100644 index 1fcf3fb9..00000000 --- a/src/api/helpers/git.h +++ /dev/null @@ -1,118 +0,0 @@ -/* LOOT - - A load order optimisation tool for Oblivion, Skyrim, Fallout 3 and - Fallout: New Vegas. - - Copyright (C) 2012-2016 WrinklyNinja - - This file is part of LOOT. - - LOOT 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. - - LOOT 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 LOOT. If not, see - . - */ - -#ifndef LOOT_API_HELPERS_GIT -#define LOOT_API_HELPERS_GIT - -#include -#include - -#include -#include - -#include "loot/struct/file_revision.h" - -namespace loot { -namespace git { -// The given path must be to a file in the root of a Git repository. -bool UpdateFile(const std::filesystem::path& path, - const std::string& repoURL, - const std::string& repoBranch); - -// The given path must be to a file in the root of a Git repository. -FileRevision GetVersionInfo(const std::filesystem::path& path, bool shortID); - -// The given path must be to a file in the root of a Git repository. -bool IsLatest(const std::filesystem::path& path, const std::string& repoBranch); -} - -class GitHelper { -public: - void InitialiseOptions(const std::string& branch, - const std::string& filenameToCheckout); - void Open(const std::filesystem::path& repoRoot); - void SetRemoteUrl(const std::string& remote, const std::string& url); - - static bool IsRepository(const std::filesystem::path& path); - static bool IsFileDifferent(const std::filesystem::path& repoRoot, - const std::string& filename); - - void Clone(const std::filesystem::path& path, const std::string& url); - void Fetch(const std::string& remote); - - void CheckoutNewBranch(const std::string& remote, const std::string& branch); - - // Deletes the branch, detaching HEAD if it's currently set to the branch. - void DeleteBranch(const std::string& branch); - - bool BranchExists(const std::string& branch); - bool IsBranchUpToDate(const std::string& branch); - bool IsBranchCheckedOut(const std::string& branch); - - std::string GetHeadCommitId(bool shortId); - std::string GetHeadCommitDate(); - -private: - struct DiffPayload { - bool fileFound; - const char* fileToFind; - }; - - struct GitData { - GitData(); - ~GitData(); - - git_repository* repo; - git_remote* remote; - git_config* config; - git_object* object; - git_commit* commit; - git_reference* reference; - git_reference* reference2; - git_blob* blob; - git_annotated_commit* annotated_commit; - git_tree* tree; - git_diff* diff; - git_buf buffer; - - git_checkout_options checkout_options; - git_clone_options clone_options; - }; - - static int DiffFileCallback(const git_diff_delta* delta, - float progress, - void* payload); - - // Removes the read-only flag from some files in git repositories - // created by libgit2. - void GrantWritePermissions(const std::filesystem::path& path); - - void Call(int error_code); - - const git_oid* GetCommitId(git_reference* reference); - - GitData data_; -}; -} -#endif diff --git a/src/api/helpers/text.cpp b/src/api/helpers/text.cpp index f06a44a2..5228b0f3 100644 --- a/src/api/helpers/text.cpp +++ b/src/api/helpers/text.cpp @@ -23,9 +23,8 @@ */ #include "api/helpers/text.h" -#include - #include +#include #ifdef _WIN32 #include "windows.h" @@ -72,7 +71,8 @@ const std::vector versionRegexes({ }); // As defined by . -const regex asciiPunctuationCharacters("([!\"#$%&'()*+,\\-./:;<=>?@\\[\\\\\\]^_`{|}~])"); +const regex asciiPunctuationCharacters( + "([!\"#$%&'()*+,\\-./:;<=>?@\\[\\\\\\]^_`{|}~])"); std::string EscapeMarkdownASCIIPunctuation(const std::string& text) { return std::regex_replace(text, asciiPunctuationCharacters, "\\$1"); diff --git a/src/tests/api/interface/file_versioning_test.h b/src/tests/api/interface/file_versioning_test.h deleted file mode 100644 index 47957c81..00000000 --- a/src/tests/api/interface/file_versioning_test.h +++ /dev/null @@ -1,196 +0,0 @@ -/* LOOT - -A load order optimisation tool for Oblivion, Skyrim, Fallout 3 and -Fallout: New Vegas. - -Copyright (C) 2014-2016 WrinklyNinja - -This file is part of LOOT. - -LOOT 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. - -LOOT 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 LOOT. If not, see -. -*/ - -#ifndef LOOT_TESTS_API_INTERFACE_FILE_VERSIONING_TEST -#define LOOT_TESTS_API_INTERFACE_FILE_VERSIONING_TEST - -#include "loot/api.h" -#include "tests/api/interface/api_game_operations_test.h" - -namespace loot { -namespace test { -class FileVersioningTest : public ApiGameOperationsTest { -protected: - FileVersioningTest() : - url_("./testing-metadata.git"), - branch_("master"), - oldBranch_("old-branch") {} - - const std::string url_; - const std::string branch_; - const std::string oldBranch_; -}; - -// Pass an empty first argument, as it's a prefix for the test instantation, -// but we only have the one so no prefix is necessary. -INSTANTIATE_TEST_SUITE_P(, - FileVersioningTest, - ::testing::Values(GameType::tes4, - GameType::tes5, - GameType::fo3, - GameType::fonv, - GameType::fo4, - GameType::tes5se)); - -TEST_P(FileVersioningTest, - updateFileShouldThrowIfTheMasterlistPathGivenIsInvalid) { - EXPECT_THROW(UpdateFile("//\?", url_, branch_), std::exception); -} - -TEST_P(FileVersioningTest, - updateFileShouldThrowIfTheMasterlistPathGivenIsEmpty) { - EXPECT_THROW(UpdateFile("", url_, branch_), std::invalid_argument); -} - -TEST_P(FileVersioningTest, - updateFileShouldThrowIfTheRepositoryUrlGivenCannotBeFound) { - EXPECT_THROW(UpdateFile( - masterlistPath, - "https://github.com/loot/oblivion-does-not-exist.git", - branch_), - std::system_error); -} - -TEST_P(FileVersioningTest, - updateFileShouldThrowIfTheRepositoryUrlGivenIsEmpty) { - EXPECT_THROW(UpdateFile(masterlistPath, "", branch_), - std::invalid_argument); -} - -TEST_P(FileVersioningTest, - updateFileShouldThrowIfTheRepositoryBranchGivenCannotBeFound) { - EXPECT_THROW(UpdateFile(masterlistPath, url_, "missing-branch"), - std::system_error); -} - -TEST_P(FileVersioningTest, - updateFileShouldThrowIfTheRepositoryBranchGivenIsEmpty) { - EXPECT_THROW(UpdateFile(masterlistPath, url_, ""), - std::invalid_argument); -} - -TEST_P( - FileVersioningTest, - updateFileShouldSucceedIfPassedValidParametersAndOutputTrueIfTheMasterlistWasUpdated) { - bool updated = false; - EXPECT_NO_THROW(updated = - UpdateFile(masterlistPath, url_, branch_)); - EXPECT_TRUE(updated); - EXPECT_TRUE(std::filesystem::exists(masterlistPath)); -} - -TEST_P( - FileVersioningTest, - updateFileShouldSucceedIfCalledRepeatedlyButOnlyOutputTrueForTheFirstCall) { - bool updated = false; - EXPECT_NO_THROW(updated = - UpdateFile(masterlistPath, url_, branch_)); - EXPECT_TRUE(updated); - - EXPECT_NO_THROW(updated = - UpdateFile(masterlistPath, url_, branch_)); - EXPECT_FALSE(updated); - EXPECT_TRUE(std::filesystem::exists(masterlistPath)); -} - -TEST_P(FileVersioningTest, - getFileRevisionShouldThrowIfNoMasterlistIsPresent) { - FileRevision revision; - EXPECT_THROW(revision = GetFileRevision(masterlistPath, false), - FileAccessError); - EXPECT_TRUE(revision.id.empty()); - EXPECT_TRUE(revision.date.empty()); - EXPECT_FALSE(revision.is_modified); -} - -TEST_P( - FileVersioningTest, - getFileRevisionShouldThrowIfANonVersionControlledMasterlistIsPresent) { - ASSERT_NO_THROW(GenerateMasterlist()); - - FileRevision revision; - EXPECT_THROW(revision = GetFileRevision(masterlistPath, false), - GitStateError); - EXPECT_TRUE(revision.id.empty()); - EXPECT_TRUE(revision.date.empty()); - EXPECT_FALSE(revision.is_modified); -} - -TEST_P( - FileVersioningTest, - getFileRevisionShouldOutputLongStringsAndBooleanFalseIfAVersionControlledMasterlistIsPresentAndGetShortIdParameterIsFalse) { - ASSERT_NO_THROW(UpdateFile(masterlistPath, url_, branch_)); - - FileRevision revision; - EXPECT_NO_THROW(revision = GetFileRevision(masterlistPath, false)); - EXPECT_EQ(40, revision.id.length()); - EXPECT_EQ(10, revision.date.length()); - EXPECT_FALSE(revision.is_modified); -} - -TEST_P( - FileVersioningTest, - getFileRevisionShouldOutputShortStringsAndBooleanFalseIfAVersionControlledMasterlistIsPresentAndGetShortIdParameterIsTrue) { - ASSERT_NO_THROW(UpdateFile(masterlistPath, url_, branch_)); - - FileRevision revision; - EXPECT_NO_THROW(revision = GetFileRevision(masterlistPath, false)); - EXPECT_GE(size_t(40), revision.id.length()); - EXPECT_LE(size_t(7), revision.id.length()); - EXPECT_EQ(10, revision.date.length()); - EXPECT_FALSE(revision.is_modified); -} - -TEST_P( - FileVersioningTest, - getFileRevisionShouldSucceedIfAnEditedVersionControlledMasterlistIsPresent) { - ASSERT_NO_THROW(UpdateFile(masterlistPath, url_, branch_)); - ASSERT_NO_THROW(GenerateMasterlist()); - - FileRevision revision; - EXPECT_NO_THROW(revision = GetFileRevision(masterlistPath, false)); - EXPECT_EQ(40, revision.id.length()); - EXPECT_EQ(10, revision.date.length()); - EXPECT_TRUE(revision.is_modified); -} - -TEST_P( - FileVersioningTest, - isLatestFileShouldReturnFalseIfTheCurrentRevisionIsNotTheLatestRevisionInTheGivenBranch) { - ASSERT_NO_THROW(UpdateFile(masterlistPath, url_, oldBranch_)); - - EXPECT_FALSE(IsLatestFile(masterlistPath, branch_)); -} - -TEST_P( - FileVersioningTest, - isLatestFileShouldReturnTrueIfTheCurrentRevisionIsTheLatestRevisioninTheGivenBranch) { - ASSERT_NO_THROW(UpdateFile(masterlistPath, url_, branch_)); - - EXPECT_TRUE(IsLatestFile(masterlistPath, branch_)); -} -} -} - -#endif diff --git a/src/tests/api/interface/main.cpp b/src/tests/api/interface/main.cpp index c70ba92b..f468c0d8 100644 --- a/src/tests/api/interface/main.cpp +++ b/src/tests/api/interface/main.cpp @@ -27,7 +27,6 @@ #include "loot/api.h" #include "tests/api/interface/create_game_handle_test.h" #include "tests/api/interface/database_interface_test.h" -#include "tests/api/interface/file_versioning_test.h" #include "tests/api/interface/game_interface_test.h" #include "tests/api/interface/is_compatible_test.h" diff --git a/src/tests/api/internals/helpers/git_test.h b/src/tests/api/internals/helpers/git_test.h deleted file mode 100644 index 5f244948..00000000 --- a/src/tests/api/internals/helpers/git_test.h +++ /dev/null @@ -1,377 +0,0 @@ -/* LOOT - -A load order optimisation tool for Oblivion, Skyrim, Fallout 3 and -Fallout: New Vegas. - -Copyright (C) 2014-2016 WrinklyNinja - -This file is part of LOOT. - -LOOT 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. - -LOOT 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 LOOT. If not, see -. -*/ - -#ifndef LOOT_TESTS_API_INTERNALS_HELPERS_GIT_TEST -#define LOOT_TESTS_API_INTERNALS_HELPERS_GIT_TEST - -#include "api/helpers/git.h" - -#include - -#include "loot/exception/git_state_error.h" -#include "tests/common_game_test_fixture.h" - -namespace loot { -namespace test { -class GitHelperTest : public ::testing::Test { -protected: - GitHelperTest() : - rootTestPath(getRootTestPath()), - repoRoot(rootTestPath / "testing-metadata"), - repoSubdirectory(repoRoot / "invalid"), - changedFile("LICENSE"), - unchangedFile("README.md"), - untrackedFile("untracked.txt") {} - - inline void SetUp() { - using std::filesystem::exists; - - copy(std::filesystem::absolute("./testing-metadata"), repoRoot); - ASSERT_TRUE(exists(repoRoot)); - ASSERT_TRUE(exists(repoSubdirectory)); - ASSERT_TRUE(std::filesystem::exists(repoRoot / unchangedFile)); - - // Run git reset --hard to ensure there are no changes in the working copy. - // The initial checkout can detect changes due to line ending mismatch. - auto currentPath = std::filesystem::current_path(); - std::filesystem::current_path(repoRoot); - system("git reset --hard"); - std::filesystem::current_path(currentPath); - - // Edit a tracked file - std::ofstream changedOut(repoRoot / changedFile); - changedOut.close(); - ASSERT_TRUE(exists(repoRoot / changedFile)); - - // Create a new file in the repository - std::ofstream untrackedOut(repoRoot / untrackedFile); - untrackedOut.close(); - ASSERT_TRUE(exists(repoRoot / untrackedFile)); - - // Create a new file outside the repository - std::ofstream outOfRepoOut(rootTestPath / untrackedFile); - outOfRepoOut.close(); - ASSERT_TRUE(exists(rootTestPath / untrackedFile)); - } - - inline void TearDown() { - // Grant write permissions to everything in rootTestPath - // in case the test made anything read only. - for (const auto& path : std::filesystem::recursive_directory_iterator(rootTestPath)) { - std::filesystem::permissions(path, std::filesystem::perms::all); - } - std::filesystem::remove_all(rootTestPath); - } - - GitHelper git_; - - const std::filesystem::path rootTestPath; - const std::filesystem::path repoRoot; - const std::filesystem::path repoSubdirectory; - - const std::string changedFile; - const std::string unchangedFile; - const std::string untrackedFile; - -private: - void copy(const std::filesystem::path& from, const std::filesystem::path& to) { - if (std::filesystem::is_directory(from)) { - std::filesystem::create_directories(to); - for (auto entry : std::filesystem::directory_iterator(from)) { - copy(entry.path(), to / entry.path().filename()); - } - } else { - std::filesystem::copy(from, to); - } - } -}; - -TEST_F(GitHelperTest, destructorShouldCallLibgit2CleanupFunction) { - ASSERT_EQ(2, git_libgit2_init()); - - GitHelper* gitPointer = new GitHelper(); - ASSERT_EQ(4, git_libgit2_init()); - - delete gitPointer; - EXPECT_EQ(2, git_libgit2_shutdown()); -} - -TEST_F(GitHelperTest, isRepositoryShouldReturnTrueForARepositoryRoot) { - EXPECT_TRUE(GitHelper::IsRepository(repoRoot)); -} - -TEST_F(GitHelperTest, isRepositoryShouldReturnFalseForRepositorySubdirectory) { - EXPECT_FALSE(GitHelper::IsRepository(repoSubdirectory)); -} - -TEST_F(GitHelperTest, isFileDifferentShouldThrowIfGivenANonRepositoryPath) { - EXPECT_THROW(GitHelper::IsFileDifferent(rootTestPath, untrackedFile), - GitStateError); -} - -TEST_F(GitHelperTest, isFileDifferentShouldReturnFalseForAnUntrackedFile) { - // New files not in the index are not tracked by Git, so aren't considered - // different. - EXPECT_FALSE(GitHelper::IsFileDifferent(repoRoot, untrackedFile)); -} - -TEST_F(GitHelperTest, - isFileDifferentShouldReturnFalseForAnUnchangedTrackedFile) { - EXPECT_FALSE(GitHelper::IsFileDifferent(repoRoot, unchangedFile)); -} - -TEST_F(GitHelperTest, - isFileDifferentShouldReturnTrueForAChangedTrackedFile) { - EXPECT_TRUE(GitHelper::IsFileDifferent(repoRoot, changedFile)); -} - -class GitTest : public ::testing::Test { -protected: - GitTest() : - repoBranch("master"), - oldBranch("old-branch"), - remoteRepoPath("./testing-metadata.git"), - rootTestPath(getRootTestPath()), - metadataFilesPath(rootTestPath / "metadata"), - masterlistPath(rootTestPath / "masterlist.yaml"), - nonAsciiMasterlistPath( - rootTestPath / std::filesystem::u8path(u8"masterl\u00EDst.yaml")) {} - - void SetUp() { - create_directories(metadataFilesPath); - ASSERT_TRUE(exists(metadataFilesPath)); - - auto sourceDirectory = std::filesystem::absolute("./testing-metadata"); - std::filesystem::copy(sourceDirectory / "masterlist.yaml", - metadataFilesPath / "masterlist.yaml"); - ASSERT_TRUE(std::filesystem::exists(metadataFilesPath / "masterlist.yaml")); - - ASSERT_FALSE(std::filesystem::exists(masterlistPath)); - ASSERT_FALSE(std::filesystem::exists(nonAsciiMasterlistPath)); - ASSERT_FALSE(std::filesystem::exists(rootTestPath / ".git")); - } - - void TearDown() { - // Grant write permissions to everything in rootTestPath - // in case the test made anything read only. - for (const auto& path : - std::filesystem::recursive_directory_iterator(rootTestPath)) { - std::filesystem::permissions(path, std::filesystem::perms::all); - } - std::filesystem::remove_all(rootTestPath); - } - - void runRepoCommand(const std::string& command) { - auto testPath = std::filesystem::current_path(); - std::filesystem::current_path(masterlistPath.parent_path()); - system(command.c_str()); - std::filesystem::current_path(testPath); - } - - const std::string remoteRepoPath; - const std::string repoBranch; - const std::string oldBranch; - - const std::filesystem::path rootTestPath; - const std::filesystem::path metadataFilesPath; - const std::filesystem::path masterlistPath; - const std::filesystem::path nonAsciiMasterlistPath; -}; - -TEST_F(GitTest, updateFileShouldThrowIfAnInvalidPathIsGiven) { - EXPECT_THROW(git::UpdateFile("//\?", remoteRepoPath, repoBranch), - std::system_error); -} - -TEST_F(GitTest, updateFileShouldThrowIfABlankPathIsGiven) { - EXPECT_THROW(git::UpdateFile("", remoteRepoPath, repoBranch), - std::invalid_argument); -} - -TEST_F(GitTest, updateFileShouldThrowIfABranchThatDoesNotExistIsGiven) { - EXPECT_THROW(git::UpdateFile(masterlistPath, remoteRepoPath, "missing-branch"), - std::system_error); -} - -TEST_F(GitTest, updateFileShouldThrowIfABlankBranchIsGiven) { - EXPECT_THROW(git::UpdateFile(masterlistPath, remoteRepoPath, ""), - std::invalid_argument); -} - -TEST_F(GitTest, updateFileShouldThrowIfAUrlThatDoesNotExistIsGiven) { - EXPECT_THROW(git::UpdateFile(masterlistPath, - "https://github.com/loot/does-not-exist.git", - repoBranch), - std::system_error); -} - -TEST_F(GitTest, updateFileShouldThrowIfABlankUrlIsGiven) { - EXPECT_THROW(git::UpdateFile(masterlistPath, "", repoBranch), - std::invalid_argument); -} - -TEST_F(GitTest, updateFileShouldBeAbleToCloneAGitHubRepository) { - EXPECT_NO_THROW( - git::UpdateFile(masterlistPath, - "https://github.com/loot/testing-metadata.git", - repoBranch)); - EXPECT_TRUE(std::filesystem::exists(masterlistPath)); -} - -TEST_F(GitTest, updateFileShouldBeAbleToCloneALocalRepository) { - EXPECT_NO_THROW(git::UpdateFile(masterlistPath, remoteRepoPath, repoBranch)); - EXPECT_TRUE(std::filesystem::exists(masterlistPath)); -} - -TEST_F(GitTest, updateFileShouldReturnTrueIfNoMasterlistExists) { - EXPECT_TRUE(git::UpdateFile(masterlistPath, remoteRepoPath, repoBranch)); - EXPECT_TRUE(std::filesystem::exists(masterlistPath)); -} - -TEST_F(GitTest, updateFileShouldReturnFalseIfAnUpToDateMasterlistExists) { - EXPECT_TRUE(git::UpdateFile(masterlistPath, remoteRepoPath, repoBranch)); - - EXPECT_FALSE(git::UpdateFile(masterlistPath, remoteRepoPath, repoBranch)); - EXPECT_TRUE(std::filesystem::exists(masterlistPath)); -} - -TEST_F( - GitTest, - updateFileShouldReturnFalseIfAnUpToDateMasterlistWithANonAsciiFilenameExists) { - EXPECT_TRUE(git::UpdateFile(nonAsciiMasterlistPath, remoteRepoPath, repoBranch)); - EXPECT_TRUE(std::filesystem::exists(nonAsciiMasterlistPath)); - - EXPECT_FALSE(git::UpdateFile(nonAsciiMasterlistPath, remoteRepoPath, repoBranch)); - EXPECT_TRUE(std::filesystem::exists(nonAsciiMasterlistPath)); -} - -TEST_F(GitTest, - updateFileShouldDiscardLocalHistoryIfRemoteHistoryIsDifferent) { - ASSERT_TRUE(git::UpdateFile(masterlistPath, remoteRepoPath, repoBranch)); - - runRepoCommand("git config commit.gpgsign false"); - runRepoCommand("git commit --amend -m \"changing local history\""); - - EXPECT_TRUE(git::UpdateFile(masterlistPath, remoteRepoPath, repoBranch)); - EXPECT_TRUE(std::filesystem::exists(masterlistPath)); -} - -TEST_F(GitTest, getVersionInfoShouldThrowIfNoMasterlistExistsAtTheGivenPath) { - EXPECT_THROW(git::GetVersionInfo(masterlistPath, false), FileAccessError); -} - -TEST_F(GitTest, - getVersionInfoShouldThrowIfTheGivenPathDoesNotBelongToAGitRepository) { - ASSERT_NO_THROW(std::filesystem::copy(metadataFilesPath / "masterlist.yaml", - masterlistPath)); - EXPECT_THROW(git::GetVersionInfo(masterlistPath, false), GitStateError); -} - -TEST_F( - GitTest, - getVersionInfoShouldReturnRevisionAndDateStringsOfTheCorrectLengthsWhenRequestingALongId) { - ASSERT_TRUE(git::UpdateFile(masterlistPath, remoteRepoPath, repoBranch)); - - FileRevision revision = git::GetVersionInfo(masterlistPath, false); - EXPECT_EQ(40, revision.id.length()); - EXPECT_EQ(10, revision.date.length()); - EXPECT_FALSE(revision.is_modified); -} - -TEST_F( - GitTest, - getVersionInfoShouldReturnRevisionAndDateStringsOfTheCorrectLengthsWhenRequestingAShortId) { - ASSERT_TRUE(git::UpdateFile(masterlistPath, remoteRepoPath, repoBranch)); - - FileRevision revision = git::GetVersionInfo(masterlistPath, true); - EXPECT_GE((unsigned)40, revision.id.length()); - EXPECT_LE((unsigned)7, revision.id.length()); - EXPECT_EQ(10, revision.date.length()); - EXPECT_FALSE(revision.is_modified); -} - -TEST_F( - GitTest, - getVersionInfoShouldAppendSuffixesToReturnedStringsIfTheMasterlistHasBeenEdited) { - ASSERT_TRUE(git::UpdateFile(masterlistPath, remoteRepoPath, repoBranch)); - std::ofstream out(masterlistPath); - out.close(); - - FileRevision revision = git::GetVersionInfo(masterlistPath, false); - EXPECT_EQ(40, revision.id.length()); - EXPECT_EQ(10, revision.date.length()); - EXPECT_TRUE(revision.is_modified); -} - -TEST_F(GitTest, - getVersionInfoShouldDetectWhenAMasterlistWithANonAsciiFilenameHasBeenEdited) { - ASSERT_TRUE(git::UpdateFile(masterlistPath, remoteRepoPath, repoBranch)); - - auto nonAsciiPath = masterlistPath.parent_path() / - std::filesystem::u8path(u8"non\u00C1scii.yaml"); - std::filesystem::copy_file(masterlistPath, nonAsciiPath); - - runRepoCommand("git add " + nonAsciiPath.string()); - std::ofstream out(nonAsciiPath); - out.close(); - - FileRevision revision = git::GetVersionInfo(nonAsciiPath, false); - EXPECT_EQ(40, revision.id.length()); - EXPECT_EQ(10, revision.date.length()); - EXPECT_TRUE(revision.is_modified); -} - -TEST_F(GitTest, - isLatestShouldThrowIfTheGivenPathDoesNotBelongToAGitRepository) { - ASSERT_NO_THROW(std::filesystem::copy(metadataFilesPath / "masterlist.yaml", - masterlistPath)); - - EXPECT_THROW(git::IsLatest(masterlistPath, repoBranch), GitStateError); -} - -TEST_F(GitTest, isLatestShouldThrowIfTheGivenBranchIsAnEmptyString) { - ASSERT_TRUE(git::UpdateFile(masterlistPath, remoteRepoPath, repoBranch)); - - EXPECT_THROW(git::IsLatest(masterlistPath, ""), std::invalid_argument); -} - -TEST_F( - GitTest, - isLatestShouldReturnFalseIfTheCurrentRevisionIsNotTheLatestRevisionInTheGivenBranch) { - ASSERT_TRUE(git::UpdateFile(masterlistPath, remoteRepoPath, oldBranch)); - - EXPECT_FALSE(git::IsLatest(masterlistPath, repoBranch)); -} - -TEST_F( - GitTest, - isLatestShouldReturnTrueIfTheCurrentRevisionIsTheLatestRevisioninTheGivenBranch) { - ASSERT_TRUE(git::UpdateFile(masterlistPath, remoteRepoPath, repoBranch)); - - EXPECT_TRUE(git::IsLatest(masterlistPath, repoBranch)); -} -} -} - -#endif diff --git a/src/tests/api/internals/main.cpp b/src/tests/api/internals/main.cpp index 888c3ec4..e0deec58 100644 --- a/src/tests/api/internals/main.cpp +++ b/src/tests/api/internals/main.cpp @@ -26,7 +26,6 @@ #include "tests/api/internals/game/game_test.h" #include "tests/api/internals/game/load_order_handler_test.h" #include "tests/api/internals/helpers/crc_test.h" -#include "tests/api/internals/helpers/git_test.h" #include "tests/api/internals/helpers/text_test.h" #include "tests/api/internals/helpers/yaml_set_helpers_test.h" #include "tests/api/internals/metadata/condition_evaluator_test.h"