From 9ace5f90621a1dc95a490f465c2cccc7fa15f511 Mon Sep 17 00:00:00 2001 From: WrinklyNinja Date: Mon, 10 Jun 2013 03:05:35 +0100 Subject: [PATCH] Started work on issue #8. Decided to use subversion as otherwise handling version numbers while updating is tricky. Decided to call subversion binaries instead of using the API because I tried the API first but found that it was crashing and the docs being all reference didn't help me figure out what I was doing wrong. Current implementation is messy and doesn't have error handling. --- CMakeLists.txt | 2 +- README.md | 25 ++++ docs/Licenses.txt | 287 ++++++++++++++++++++++++++++++++++++++++ src/backend/error.h | 1 + src/backend/network.cpp | 80 +++++++++++ src/backend/network.h | 39 ++++-- src/gui/main.cpp | 5 + 7 files changed, 430 insertions(+), 9 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 9b5cdbd1..1822b160 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -11,7 +11,7 @@ cmake_minimum_required (VERSION 2.8.9) project (boss) -set (BOSS_SRC "${CMAKE_SOURCE_DIR}/src/backend/metadata.cpp" "${CMAKE_SOURCE_DIR}/src/backend/game.cpp" "${CMAKE_SOURCE_DIR}/src/backend/helpers.cpp" "${PROJECT_LIBS_DIR}/pugixml/src/pugixml.cpp") +set (BOSS_SRC "${CMAKE_SOURCE_DIR}/src/backend/metadata.cpp" "${CMAKE_SOURCE_DIR}/src/backend/game.cpp" "${CMAKE_SOURCE_DIR}/src/backend/helpers.cpp" "${CMAKE_SOURCE_DIR}/src/backend/network.cpp" "${PROJECT_LIBS_DIR}/pugixml/src/pugixml.cpp") # Include source and library directories. include_directories ("${PROJECT_LIBS_DIR}/alphanum" "${PROJECT_LIBS_DIR}/boost" "${PROJECT_LIBS_DIR}/yaml-cpp/include" "${CMAKE_SOURCE_DIR}/src" "${PROJECT_LIBS_DIR}/libloadorder/src" "${PROJECT_LIBS_DIR}/libespm" "${PROJECT_LIBS_DIR}/zlib" "${PROJECT_LIBS_DIR}/pugixml/src" "${PROJECT_LIBS_DIR}/wxWidgets/include") diff --git a/README.md b/README.md index c9fe32fc..d800ad82 100644 --- a/README.md +++ b/README.md @@ -30,10 +30,35 @@ BOSS requires the following libraries: * [yaml-cpp](http://code.google.com/p/yaml-cpp/) v0.5.1 or later. * [zlib](http://zlib.net) v1.2.7 or later. + BOSS expects all libraries' folders to be present alongside the BOSS repository folder that contains this readme, or otherwise installed such that the compiler and linker used can find them without suppling additional paths. All paths below are relative to the folder(s) containing the libraries and BOSS. +BOSS also requires Subversion binaries, which can be obtained [here](http://sourceforge.net/projects/win32svn) and should be installed as detailed below. + Alphanum, Libespm and PugiXML do not require any additional setup. The rest of the libraries must be built separately. +### Subversion + +Put the following binaries into ```resources/svn/``` in the BOSS repository root. + +* int3_svn.dll +* libapr-1.dll +* libapriconv-1.dll +* libaprutil-1.dll +* libdb48.dll +* libeay32.dll +* libsasl.dll +* libsvn_client-1.dll +* libsvn_delta-1.dll +* libsvn_diff-1.dll +* libsvn_fs-1.dll +* libsvn_ra-1.dll +* libsvn_repos-1.dll +* libsvn_subr-1.dll +* libsvn_wc-1.dll +* ssleay32.dll +* svn.exe + ### Boost ``` diff --git a/docs/Licenses.txt b/docs/Licenses.txt index 7736779d..4d15ecdb 100644 --- a/docs/Licenses.txt +++ b/docs/Licenses.txt @@ -1,3 +1,20 @@ +Licenses +======== + +This file contains the texts of the following licenses: + +1. GNU GENERAL PUBLIC LICENSE, Version 3 +2. GNU Free Documentation License, Version 1.3 +3. Apache License, Version 2.0 + + + +============================================================================= +============================================================================= +============================================================================= + + + GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 @@ -1131,3 +1148,273 @@ If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software. + + + +============================================================================= +============================================================================= +============================================================================= + + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + +SUBVERSION SUBCOMPONENTS: + +Subversion includes a number of subcomponents with separate copyright +notices and license terms. Your use of the source code for the these +subcomponents is subject to the terms and conditions of the following +licenses. + +For portions of the Python bindings test suite at +subversion/bindings/swig/python/tests/trac/: + + I. Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + + II. Copyright (C) 2003, 2004, 2005 Edgewall Software + Copyright (C) 2003, 2004, 2005 Jonas Borgström + Copyright (C) 2005 Christopher Lenz + + All rights reserved. + + Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions + are met: + + 1. Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + 2. Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + the documentation and/or other materials provided with the + distribution. + 3. The name of the author may not be used to endorse or promote + products derived from this software without specific prior written + permission. + + THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS + OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED + WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY + DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE + GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS + INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER + IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR + OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN + IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + diff --git a/src/backend/error.h b/src/backend/error.h index ce6056c3..b604454d 100644 --- a/src/backend/error.h +++ b/src/backend/error.h @@ -40,6 +40,7 @@ namespace boss { const unsigned int ERROR_NO_TAG_MAP = 8; const unsigned int ERROR_PATH_NOT_FOUND = 9; const unsigned int ERROR_NO_GAME_DETECTED = 10; + const unsigned int ERROR_SUBVERSION_ERROR = 11; class error : public std::exception { public: diff --git a/src/backend/network.cpp b/src/backend/network.cpp index e69de29b..d9d1be09 100644 --- a/src/backend/network.cpp +++ b/src/backend/network.cpp @@ -0,0 +1,80 @@ +/* BOSS + + A plugin load order optimiser for games that use the esp/esm plugin system. + + Copyright (C) 2012-2013 WrinklyNinja + + This file is part of BOSS. + + BOSS 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. + + BOSS 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 BOSS. If not, see + . +*/ + +#include "network.h" +#include "error.h" +#include "parsers.h" + +#include + +using namespace std; + +namespace fs = boost::filesystem; + +namespace boss { + + unsigned int UpdateMasterlist(const Game& game) { + //First check if the working copy is set up or not. + int ret = system(("resources\\svn\\svn.exe info " + game.MasterlistPath().parent_path().string() + " > svn.log").c_str()); + + if (ret != 0) { + //Working copy not set up, perform a checkout. + ret = system(("resources\\svn\\svn.exe co --depth empty " + game.URL().substr(0, game.URL().rfind('/')) + " " + game.MasterlistPath().parent_path().string() + "/. > svn.log").c_str()); + } + + //Now update masterlist. + ret = system(("resources\\svn\\svn.exe update " + game.MasterlistPath().string() + " > svn.log").c_str()); + + //Now test masterlist to see if it parses OK. + ret = 1; + while (ret == 1) { + try { + YAML::Node mlist = YAML::LoadFile(game.MasterlistPath().string()); + ret = 0; + } catch (YAML::Exception& e) { + //Roll back one revision if there's an error. + ret = system(("resources\\svn\\svn.exe update --revision PREV " + game.MasterlistPath().string() + " > svn.log").c_str()); + ret = 1; + } + } + + //Now get the masterlist revision. Can either create a pipe using the Win32 API (http://msdn.microsoft.com/en-us/library/ms682499.aspx), or output to a file, read it, then delete it. + ret = system(("resources\\svn\\svn.exe info " + game.MasterlistPath().string() + " > svn.log").c_str()); + + ifstream in("svn.log"); + + int revision; + while (in.good()) { + string line; + getline(in, line); + + if (line.substr(0, 10) == "Revision: ") + revision = atoi(line.substr(10).c_str()); + } + in.close(); + + fs::remove("svn.log"); + + return revision; + } +} diff --git a/src/backend/network.h b/src/backend/network.h index c51e2c27..421b304e 100644 --- a/src/backend/network.h +++ b/src/backend/network.h @@ -24,16 +24,39 @@ #ifndef __BOSS_NETWORK__ #define __BOSS_NETWORK__ +#include +#include + +#include "game.h" + namespace boss { - /* Need to be able to: + /* Masterlist updating is carried out using subversion. Haven't decided whether to use its API (which is in C and a bit complex) or call its executables via system(). - - Check if there's an internet connection. - - Get the revision number for the local masterlist, if present. - - Get the revision number for the remote masterlist. - - Compare the two revision numbers. - - Download the remote masterlist if it has a higher revision number. - - Test that the downloaded masterlist is valid by parsing it to see if any errors come up. - - If the downloaded masterlist is parsed OK, replace the local masterlist with it. + Basic workflow is: + + 1. Check if there's a working copy present in the masterlist's directory. + 2. If not, perform a sparse checkout of the remote folder containing the masterlist, at a folder-only depth. + 3. SVN update the masterlist to the latest available revision. + 4. Check whether the masterlist parses without errors. + 5. If not, revert the masterlist back one revision. Loop back to step 4 until it parses OK. + 6. Record the revision of the masterlist for display in the BOSS report. + + Also need to record error messages for display in the BOSS report, including any parsing errors encountered in step 4, even if a working masterlist was found. + + ```svn info``` on a non-working-copy returns "svn: '.' is not a working copy". + + ```svn co --depth empty http://better-oblivion-sorting-software.googlecode.com/svn/data/boss-skyrim/ .``` + followed by + ```svn update masterlist.txt``` + works as desired when in BOSS's Skyrim folder. + + ```svn update --revision PREV masterlist.txt``` + would then roll the masterlist back one revision. + + ```svn info masterlist.txt``` returns a bunch of info: the line "Revision: XXXX" contains the revision number. */ + + unsigned int UpdateMasterlist(const Game& game); } +#endif diff --git a/src/gui/main.cpp b/src/gui/main.cpp index 2bee9ce4..99619850 100644 --- a/src/gui/main.cpp +++ b/src/gui/main.cpp @@ -31,6 +31,7 @@ #include "../backend/error.h" #include "../backend/helpers.h" #include "../backend/generators.h" +#include "../backend/network.h" #include #include @@ -319,6 +320,10 @@ void Launcher::OnSortPlugins(wxCommandEvent& event) { ofstream out("out.txt"); + out << "Updating masterlist..." << endl; + + UpdateMasterlist(_game); + out << "Reading plugins in Data folder..." << endl; time_t start, end; start = time(NULL);