Adding upstream version 4:24.2.0.upstream/4%24.2.0

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 216 insertions, 0 deletions

diff --git a/vcl/source/app/IconThemeScanner.cxx b/vcl/source/app/IconThemeScanner.cxx
new file mode 100644
index 0000000000..c8f6a1ac7e
--- /dev/null
+++ b/vcl/source/app/IconThemeScanner.cxx
@@ -0,0 +1,216 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+
+#include <sal/config.h>
+#include <sal/log.hxx>
+
+#include <deque>
+
+#include <IconThemeScanner.hxx>
+
+#include <osl/file.hxx>
+#include <salhelper/linkhelper.hxx>
+#include <unotools/pathoptions.hxx>
+#include <vcl/IconThemeInfo.hxx>
+#include <o3tl/string_view.hxx>
+
+namespace vcl {
+
+namespace {
+
+// set the status of a file. Returns false if the status could not be determined.
+bool set_file_status(osl::FileStatus& status, const OUString& file)
+{
+    osl::DirectoryItem dirItem;
+    osl::FileBase::RC retvalGet = osl::DirectoryItem::get(file, dirItem);
+    if (retvalGet != osl::FileBase::E_None) {
+        SAL_WARN("vcl.app", "Could not determine status for file '" << file << "'.");
+        return false;
+    }
+    osl::FileBase::RC retvalStatus = dirItem.getFileStatus(status);
+    if (retvalStatus != osl::FileBase::E_None) {
+        SAL_WARN("vcl.app", "Could not determine status for file '" << file << "'.");
+        return false;
+    }
+    return true;
+}
+
+OUString convert_to_absolute_path(const OUString& path)
+{
+    salhelper::LinkResolver resolver(0);
+    osl::FileBase::RC rc = resolver.fetchFileStatus(path);
+    if (rc != osl::FileBase::E_None) {
+        SAL_WARN("vcl.app", "Could not resolve path '" << path << "' to search for icon themes.");
+        if (rc == osl::FileBase::E_MULTIHOP)
+        {
+            throw std::runtime_error("Provided a recursive symlink to an icon theme directory that could not be resolved.");
+        }
+    }
+    return resolver.m_aStatus.getFileURL();
+}
+
+}
+
+IconThemeScanner::IconThemeScanner()
+{}
+
+void IconThemeScanner::ScanDirectoryForIconThemes(std::u16string_view paths)
+{
+    mFoundIconThemes.clear();
+
+    std::deque<OUString> aPaths;
+
+    sal_Int32 nIndex = 0;
+    do
+    {
+        aPaths.push_front(OUString(o3tl::getToken(paths, 0, ';', nIndex)));
+    }
+    while (nIndex >= 0);
+
+    for (const auto& path : aPaths)
+    {
+        osl::FileStatus fileStatus(osl_FileStatus_Mask_Type);
+        bool couldSetFileStatus = set_file_status(fileStatus, path);
+        if (!couldSetFileStatus) {
+            continue;
+        }
+
+        if (!fileStatus.isDirectory()) {
+            SAL_INFO("vcl.app", "Cannot search for icon themes in '"<< path << "'. It is not a directory.");
+            continue;
+        }
+
+        std::vector<OUString> iconThemePaths = ReadIconThemesFromPath(path);
+        if (iconThemePaths.empty()) {
+            SAL_WARN("vcl.app", "Could not find any icon themes in the provided directory ('" <<path<<"'.");
+            continue;
+        }
+        for (auto const& iconThemePath : iconThemePaths)
+        {
+            AddIconThemeByPath(iconThemePath);
+        }
+    }
+}
+
+bool
+IconThemeScanner::AddIconThemeByPath(const OUString &url)
+{
+    if (!IconThemeInfo::UrlCanBeParsed(url)) {
+        return false;
+    }
+    SAL_INFO("vcl.app", "Found a file that seems to be an icon theme: '" << url << "'" );
+    IconThemeInfo newTheme(url);
+    mFoundIconThemes.push_back(newTheme);
+    SAL_INFO("vcl.app", "Adding the file as '" << newTheme.GetDisplayName() <<
+            "' with id '" << newTheme.GetThemeId() << "'.");
+    return true;
+}
+
+/*static*/ std::vector<OUString>
+IconThemeScanner::ReadIconThemesFromPath(const OUString& dir)
+{
+    std::vector<OUString> found;
+    SAL_INFO("vcl.app", "Scanning directory '" << dir << " for icon themes.");
+
+    osl::Directory dirToScan(dir);
+    osl::FileBase::RC retvalOpen = dirToScan.open();
+    if (retvalOpen != osl::FileBase::E_None) {
+        return found;
+    }
+
+    osl::DirectoryItem directoryItem;
+    while (dirToScan.getNextItem(directoryItem) == osl::FileBase::E_None) {
+        osl::FileStatus status(osl_FileStatus_Mask_Type | osl_FileStatus_Mask_FileURL | osl_FileStatus_Mask_FileName);
+        osl::FileBase::RC retvalStatus = directoryItem.getFileStatus(status);
+        if (retvalStatus != osl::FileBase::E_None) {
+            continue;
+        }
+
+        OUString filename = convert_to_absolute_path(status.getFileURL());
+        if (!FileIsValidIconTheme(filename)) {
+            continue;
+        }
+        found.push_back(filename);
+    }
+    return found;
+}
+
+/*static*/ bool
+IconThemeScanner::FileIsValidIconTheme(const OUString& filename)
+{
+    // check whether we can construct an IconThemeInfo from it
+    if (!IconThemeInfo::UrlCanBeParsed(filename)) {
+        SAL_INFO("vcl.app", "File '" << filename << "' does not seem to be an icon theme.");
+        return false;
+    }
+
+    osl::FileStatus fileStatus(osl_FileStatus_Mask_Type);
+    bool couldSetFileStatus = set_file_status(fileStatus, filename);
+    if (!couldSetFileStatus) {
+        return false;
+    }
+
+    if (!fileStatus.isRegular()) {
+        return false;
+    }
+    return true;
+}
+
+bool
+IconThemeScanner::IconThemeIsInstalled(const OUString& themeId) const
+{
+    return IconThemeInfo::IconThemeIsInVector(mFoundIconThemes, themeId);
+}
+
+/*static*/ std::shared_ptr<IconThemeScanner>
+IconThemeScanner::Create(std::u16string_view path)
+{
+    std::shared_ptr<IconThemeScanner> retval(new IconThemeScanner);
+    retval->ScanDirectoryForIconThemes(path);
+    return retval;
+}
+
+/*static*/ OUString
+IconThemeScanner::GetStandardIconThemePath()
+{
+    SvtPathOptions aPathOptions;
+    return aPathOptions.GetIconsetPath();
+}
+
+namespace
+{
+    class SameTheme
+    {
+    private:
+        const OUString& m_rThemeId;
+    public:
+        explicit SameTheme(const OUString &rThemeId) : m_rThemeId(rThemeId) {}
+        bool operator()(const vcl::IconThemeInfo &rInfo)
+        {
+            return m_rThemeId == rInfo.GetThemeId();
+        }
+    };
+}
+
+const vcl::IconThemeInfo&
+IconThemeScanner::GetIconThemeInfo(const OUString& themeId)
+{
+    std::vector<IconThemeInfo>::iterator info = std::find_if(mFoundIconThemes.begin(), mFoundIconThemes.end(),
+        SameTheme(themeId));
+    if (info == mFoundIconThemes.end()) {
+        SAL_WARN("vcl.app", "Requested information for icon theme with id '" << themeId
+                << "' which does not exist.");
+        throw std::runtime_error("Requested information on not-installed icon theme");
+    }
+    return *info;
+}
+
+} // end namespace vcl
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */