Skip to content

Commit

Permalink
Fix leading '/' leftover during URL path normalization in some cases,…
Browse files Browse the repository at this point in the history 
… see mikke89#161. Add unit tests for URL.
  • Loading branch information
@mikke89
mikke89 committed Mar 19, 2021
1 parent 1636330 commit 3986029
Show file tree
Hide file tree
Showing 2 changed files with 236 additions and 2 deletions.
6 changes: 4 additions & 2 deletions Source/Core/URL.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -222,15 +222,17 @@ bool URL::SetURL(const String& _url)

// Normalise the path, stripping any ../'s from it
size_t parent_dir_pos = String::npos;
while ((parent_dir_pos = path.find("/..")) != String::npos && parent_dir_pos != 0)
while ((parent_dir_pos = path.find("/../")) != String::npos && parent_dir_pos != 0)
{
// Find the start of the parent directory.
size_t parent_dir_start_pos = path.rfind('/', parent_dir_pos - 1);
if (parent_dir_start_pos == String::npos)
parent_dir_start_pos = 0;
else
parent_dir_start_pos += 1;

// Strip out the parent dir and the /..
path.erase(parent_dir_start_pos, parent_dir_pos - parent_dir_start_pos + 3);
path.erase(parent_dir_start_pos, parent_dir_pos - parent_dir_start_pos + 4);

// We've altered the URL, mark it dirty
url_dirty = true;
Expand Down
232 changes: 232 additions & 0 deletions Tests/Source/UnitTests/URL.cpp
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,232 @@
/*
* This source file is part of RmlUi, the HTML/CSS Interface Middleware
*
* For the latest information, see http://github.com/mikke89/RmlUi
*
* Copyright (c) 2008-2010 CodePoint Ltd, Shift Technology Ltd
* Copyright (c) 2019 The RmlUi Team, and contributors
*
* 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.
*
*/

#include <RmlUi/Core/Core.h>
#include <RmlUi/Core/Log.h>
#include <RmlUi/Core/SystemInterface.h>
#include <RmlUi/Core/Types.h>
#include <RmlUi/Core/URL.h>
#include <doctest.h>
#include <algorithm>

using namespace Rml;

class BasicSystemInterface : public Rml::SystemInterface
{
public:
double GetElapsedTime() override { return 0.0; }
bool LogMessage(Log::Type type, const String& message) override
{
CHECK(type > Log::LT_WARNING);
return Rml::SystemInterface::LogMessage(type == Log::LT_ASSERT ? Log::LT_ERROR : type, message);
}
};

static BasicSystemInterface basic_system_interface;


static inline String Normalize(const char* url_str)
{
URL url(url_str);
const String rml_path = url.GetURL();
return rml_path;
}

static inline String JoinPath(const char* document_path, const char* path)
{
String result;
basic_system_interface.JoinPath(result, document_path, path);
return result;
}

TEST_CASE("url.normalize")
{
SystemInterface* old_system_interface = Rml::GetSystemInterface();
Rml::SetSystemInterface(&basic_system_interface);

CHECK(Normalize("blue") == "blue");
CHECK(Normalize("blue.png") == "blue.png");
CHECK(Normalize("/blue.png") == "/blue.png");
CHECK(Normalize("/data/blue.png") == "/data/blue.png");
CHECK(Normalize("/data/gui/../../data/images/icons/blue.png") == "/data/images/icons/blue.png");

CHECK(Normalize("../data/blue.png") == "../data/blue.png");
CHECK(Normalize("data/blue.png") == "data/blue.png");
CHECK(Normalize("data/../blue.png") == "blue.png");

CHECK(Normalize("x./data/blue.png") == "x./data/blue.png");
CHECK(Normalize("x./data/../blue.png") == "x./blue.png");
CHECK(Normalize("/x./data/blue.png") == "/x./data/blue.png");
CHECK(Normalize("/x./data/../blue.png") == "/x./blue.png");

CHECK(Normalize("/data/blue.png") == "/data/blue.png");
CHECK(Normalize("/data/../blue.png") == "/blue.png");

CHECK(Normalize("test/data/../blue.png") == "test/blue.png");
CHECK(Normalize("data/../blue.png") == "blue.png");
CHECK(Normalize("data/gui/../../data/images/icons/blue.png") == "data/images/icons/blue.png");
CHECK(Normalize("data/gui/images/../../blue.png") == "data/blue.png");

CHECK(Normalize("file://data/blue.png") == "file://data/blue.png");


/*** These ones are supported now, but we may want to revise them later ***/

CHECK(Normalize("") == "");
CHECK(Normalize("./") == "./");
CHECK(Normalize("../") == "../");
CHECK(Normalize("/") == "/");
CHECK(Normalize("/../") == "/../");


/*** We may want to support these later. ***/

//CHECK(Normalize("./data/blue.png") == "data/blue.png");
//CHECK(Normalize("./data/../blue.png") == "blue.png");

//CHECK(Normalize("/./data/blue.png") == "/data/blue.png");
//CHECK(Normalize("/./data/../blue.png") == "/blue.png");

//CHECK(Normalize("data/../../blue.png") == "../blue.png");
//CHECK(Normalize("data/../../../blue.png") == "../../blue.png");
//CHECK(Normalize("./data/../../blue.png") == "../blue.png");
//CHECK(Normalize("./data/../../../blue.png") == "../../blue.png");

//CHECK(Normalize("data/gui/../../data/images/icons/blue.png") == "data/images/icons/blue.png");

//CHECK(Normalize("data//blue.png") == "data/blue.png");
//CHECK(Normalize("data//./blue.png") == "data/blue.png");
//CHECK(Normalize("data//../blue.png") == "blue.png");

//CHECK(Normalize("file://data/../blue.png") == "file://data/blue.png");
//CHECK(Normalize("file:///data/../blue.png") == "file:///blue.png");

//CHECK(Normalize("file://data/blue.png") == "file://data/blue.png");
//CHECK(Normalize("file://data/blue.png") == "file://data/blue.png");
//CHECK(Normalize("file://data/../blue.png") == "file://blue.png");

//CHECK(Normalize("C:/data/blue.png") == "C:/data/blue.png");
//CHECK(Normalize("C:/data/./blue.png") == "C:/data/blue.png");
//CHECK(Normalize("C:/data./blue.png") == "C:/data./blue.png");
//CHECK(Normalize("C:/data/../blue.png") == "C:/blue.png");

//CHECK(Normalize(R"(C:\data\blue.png)") == "C:/data/blue.png");
//CHECK(Normalize(R"(C:\data\.\blue.png)") == "C:/data/blue.png");
//CHECK(Normalize(R"(C:\data.\blue.png)") == "C:/data./blue.png");
//CHECK(Normalize(R"(C:\data\..\blue.png)") == "C:/blue.png");

Rml::SetSystemInterface(old_system_interface);
}

TEST_CASE("url.join")
{
SystemInterface* old_system_interface = Rml::GetSystemInterface();
Rml::SetSystemInterface(&basic_system_interface);

CHECK(JoinPath("data/gui/d.rml", "blue.png") == "data/gui/blue.png");
CHECK(JoinPath("data/gui/d.rml", "../../data/images/icons/blue.png") == "data/images/icons/blue.png");
CHECK(JoinPath("/data/d.rml", "../images/icons/blue.png") == "/images/icons/blue.png");

CHECK(JoinPath(R"(C:\data\d.rml)", R"(blue.png)") == R"(C:/data/blue.png)");
CHECK(JoinPath(R"(C:\data\d.rml)", R"(../blue.png)") == R"(C:/blue.png)");
CHECK(JoinPath(R"(C:\data\d.rml)", R"(..\blue.png)") == R"(C:/blue.png)");

CHECK(JoinPath("file://C:/data/d.rml", "img/blue.png") == "file://C:/data/img/blue.png");
CHECK(JoinPath("file://data/d.rml", "img/blue.png") == "file://data/img/blue.png");
CHECK(JoinPath("file://C:/data/d.rml", "img/../blue.png") == "file://C:/data/blue.png");
CHECK(JoinPath("file://data/d.rml", "img/../../blue.png") == "file://blue.png");

CHECK(JoinPath("file://data/d.rml", "file://C:/data/blue.png") == "file://C:/data/blue.png");
CHECK(JoinPath("file://data/d.rml", "file://data/blue.png") == "file://data/blue.png");

CHECK(JoinPath("file:///data/d.rml", "../blue.png") == "file:///blue.png");
CHECK(JoinPath("file:///data/d.rml", "img/../blue.png") == "file:///data/blue.png");


/*** These ones are supported now, but we may want to revise them later ***/

CHECK(JoinPath("/d.rml", "../data/images/icons/blue.png") == "/../data/images/icons/blue.png");
CHECK(JoinPath("/data/d.rml", "../../images/icons/blue.png") == "/../images/icons/blue.png");


/*** We may want to support these later ***/

//CHECK(JoinPath("data/gui/d.rml", "/images/icons/blue.png") == "/images/icons/blue.png");
//CHECK(JoinPath("/data/gui/d.rml", "/images/icons/blue.png") == "/images/icons/blue.png");

//CHECK(JoinPath("data/gui/d.rml", "/images/../icons/blue.png") == "/icons/blue.png");
//CHECK(JoinPath("data/gui/d.rml", "/images/./icons/../../blue.png") == "/blue.png");
//CHECK(JoinPath("/data/gui/d.rml", "/../../images/icons/../blue.png") == "/../../images/blue.png");
//CHECK(JoinPath("/data/gui/d.rml", "/images/./icons/blue.png") == "/images/icons/blue.png");

//CHECK(JoinPath("data/gui/d.rml", "./../images/icons/blue.png") == "data/images/icons/blue.png");
//CHECK(JoinPath("/d.rml", "./data/images/icons/blue.png") == "/data/images/icons/blue.png");
//CHECK(JoinPath("/data/d.rml", "./images/icons/blue.png") == "/data/images/icons/blue.png");
//CHECK(JoinPath("/data/d.rml", "./../images/icons/blue.png") == "/images/icons/blue.png");
//CHECK(JoinPath("/data/d.rml", "./../../images/icons/blue.png") == "/../images/icons/blue.png");

//CHECK(JoinPath(R"(C:\data\d.rml)", R"(/blue.png)") == R"(/blue.png)");

//CHECK(JoinPath("file://C:/data/d.rml", "/img/blue.png") == "file://C:/img/blue.png");
//CHECK(JoinPath("file://data/d.rml", "/img/blue.png") == "file://data/img/blue.png");
//CHECK(JoinPath("file://C:/data/d.rml", "/img/../blue.png") == "file://C:/blue.png");
//CHECK(JoinPath("file://data/d.rml", "/img/../../blue.png") == "file://data/blue.png");

//CHECK(JoinPath("file://data/d.rml", "file://C:/data/../blue.png") == "file://C:/blue.png");

//CHECK(JoinPath("file://data/d.rml", "file://data/./blue.png") == "file://data/blue.png");
//CHECK(JoinPath("file://data/d.rml", "file://data/../blue.png") == "file://data/blue.png");
//CHECK(JoinPath("file://data/d.rml", "file:///data/../blue.png") == "file:///blue.png");

//CHECK(JoinPath("file://data/d.rml", "../blue.png") == "file://data/blue.png");
//CHECK(JoinPath("file://data/d.rml", "img/../blue.png") == "file://data/blue.png");
//CHECK(JoinPath("file://data/d.rml", "/img/blue.png") == "file://data/img/blue.png");
//CHECK(JoinPath("file://data/d.rml", "/img/../blue.png") == "file://data/blue.png");

//CHECK(JoinPath("file:///data/d.rml", "/img/blue.png") == "file:///img/blue.png");
//CHECK(JoinPath("file:///data/d.rml", "/img/../blue.png") == "file:///blue.png");

//CHECK(JoinPath("file:data/d.rml", "../blue.png") == "file:blue.png");
//CHECK(JoinPath("file:data/d.rml", "img/../blue.png") == "file:data/blue.png");
//CHECK(JoinPath("file:data/d.rml", "/img/blue.png") == "file:img/blue.png");
//CHECK(JoinPath("file:data/d.rml", "/img/../blue.png") == "file:blue.png");

//CHECK(JoinPath("file:C:/data/d.rml", "../blue.png") == "file:C:/blue.png");
//CHECK(JoinPath("file:C:/data/d.rml", "img/../blue.png") == "file:C:/data/blue.png");
//CHECK(JoinPath("file:C:/data/d.rml", "/img/blue.png") == "file:img/blue.png");
//CHECK(JoinPath("file:C:/data/d.rml", "/img/../blue.png") == "file:blue.png");

/*** Not sure about these, maybe report as invalid? ***/

//CHECK(JoinPath(R"(C:\data\d.rml)", R"(../../blue.png)") == R"(C:/blue.png)");
//CHECK(JoinPath(R"(C:\data\d.rml)", R"(/../blue.png)") == R"(/../blue.png)");
//CHECK(JoinPath(R"(C:\data\d.rml)", R"(/..\blue.png)") == R"(/../blue.png)");
//CHECK(JoinPath(R"(C:\data\d.rml)", R"(/../../blue.png)") == R"(/../../blue.png)");

Rml::SetSystemInterface(old_system_interface);
}

0 comments on commit 3986029

Please sign in to comment.