1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2023-05-15
 * Description : geolocation engine based on Marble.
 *               (c) 2007-2022 Marble Team
 *               https://invent.kde.org/education/marble/-/raw/master/data/credits_authors.html
 *
 * SPDX-FileCopyrightText: 2023-2026 by Gilles Caulier <caulier dot gilles at gmail dot com>
 *
 * SPDX-License-Identifier: LGPL-2.1-or-later
 *
 * ============================================================ */

#include "MarbleDirs.h"

// Qt includes

#include <QFile>
#include <QCoreApplication>
#include <QLibraryInfo>
#include <QStandardPaths>

// Local includes

#include "digikam_debug.h"

namespace Marble
{

QString MarbleDirs::path(const QString& relativePath)
{
    QString localpath  = localPath()       +
                         QDir::separator() +
                         relativePath;   // local path
    QString systempath = systemPath()      +
                         QDir::separator() +
                         relativePath;   // system path
    QString fullpath   = systempath;

    if (QFile::exists(localpath))
    {
        fullpath = localpath;
    }

    return QDir(fullpath).canonicalPath();
}

QString MarbleDirs::pluginPath(const QString& relativePath)
{
    const QString localpath  = pluginLocalPath()  +
                               QDir::separator()  +
                               relativePath; // local path
    const QString systempath = pluginSystemPath() +
                               QDir::separator()  +
                               relativePath; // system path
    QString fullpath         = systempath;

    if (QFile::exists(localpath))
    {
        fullpath = localpath;
    }

    return QDir(fullpath).canonicalPath();
}

QStringList MarbleDirs::entryList(const QString& relativePath, QDir::Filters filters)
{
    QStringList filesLocal  = QDir(MarbleDirs::localPath()  +
                                   QDir::separator()             +
                                   relativePath).entryList(filters);
    QStringList filesSystem = QDir(MarbleDirs::systemPath() +
                                   QDir::separator()             +
                                   relativePath).entryList(filters);
    QStringList allFiles(filesLocal);
    allFiles << filesSystem;

    // remove duplicate entries

    allFiles.sort();

    for (int i = 1 ; i < allFiles.size() ; ++i)
    {
        if (allFiles.at(i) == allFiles.at(i - 1))
        {
            allFiles.removeAt(i);
            --i;
        }
    }

    return allFiles;
}

QStringList MarbleDirs::pluginEntryList(const QString& relativePath, QDir::Filters filters)
{
    QStringList allFiles;

    // First we try to load in first the local plugin if DK_PLUG_PATH variable is declared.
    // Else, we will load plugins from the system using the standard Qt plugin path.

    QByteArray  dkenv = qgetenv("DK_PLUGIN_PATH");

    if (dkenv.isEmpty())
    {
        allFiles        = QDir(MarbleDirs::pluginLocalPath() +
                               QDir::separator()             +
                               relativePath).entryList(filters);
        auto const pluginSystemPath = MarbleDirs::pluginSystemPath();<--- Shadow variable

        if (!pluginSystemPath.isEmpty())
        {
            allFiles << QDir(pluginSystemPath + QDir::separator() + relativePath).entryList(filters);
        }
    }
    else
    {
        qCWarning(DIGIKAM_GEOENGINE_LOG) << "DK_PLUGIN_PATH env.variable detected. "
                                         "We will use it to load Geolocation plugin...";

        const auto pathList = QString::fromUtf8(dkenv).split(QLatin1Char(';'),
                                                             Qt::SkipEmptyParts);

        for (const QString& pth : pathList)
        {
            allFiles << QDir(pth).entryList(filters);
        }
    }

    // remove duplicate entries

    allFiles.sort();

    for (int i = 1 ; i < allFiles.size() ; ++i)
    {
        if (allFiles.at(i) == allFiles.at(i - 1))
        {
            allFiles.removeAt(i);
            --i;
        }
    }

    return allFiles;
}

QString MarbleDirs::systemPath()
{
    QString path = QStandardPaths::locate(QStandardPaths::GenericDataLocation,<--- Shadow variable
                                          QLatin1String("digikam/marble"),
                                          QStandardPaths::LocateDirectory);

    return path;
}

QString MarbleDirs::localPath()
{
    return (
               QStandardPaths::writableLocation(QStandardPaths::GenericDataLocation) +
               QLatin1String("/digikam/marble_data")
           );
}

QString MarbleDirs::pluginLocalPath()
{
    return (
               QStandardPaths::writableLocation(QStandardPaths::GenericDataLocation) +
               QLatin1String("/digikam/marble_plugins")
           );
}

QString MarbleDirs::pluginSystemPath()
{

#if (QT_VERSION >= QT_VERSION_CHECK(6, 0, 0))

    return (
               QLibraryInfo::path(QLibraryInfo::PluginsPath) +
               QLatin1String("/digikam/marble")
           );

#else

    return (
               QLibraryInfo::location(QLibraryInfo::PluginsPath) +
               QLatin1String("/digikam/marble")
           );

#endif

}

void MarbleDirs::debug()
{
    qCDebug(DIGIKAM_GEOENGINE_LOG) << "=== MarbleDirs: ===";
    qCDebug(DIGIKAM_GEOENGINE_LOG) << "Local Path        :" << localPath();
    qCDebug(DIGIKAM_GEOENGINE_LOG) << "Plugin Local Path :" << pluginLocalPath();
    qCDebug(DIGIKAM_GEOENGINE_LOG) << "System Path       :" << systemPath();
    qCDebug(DIGIKAM_GEOENGINE_LOG) << "Plugin System Path:" << pluginSystemPath();
    qCDebug(DIGIKAM_GEOENGINE_LOG) << "===================";
}

} // namespace Marble