Method FollowSymlinkIfRequired

PathCopyCopy/src/PluginUtils.cpp:145–191

If the provided path or one of its parents points to a symbolic link, follow the symlink and return the path to its target. @param p_rPath Path to follow symlink for, if required. @return true if p_rPath or one of its parents pointed to a symlink.

    // @return true if p_rPath or one of its parents pointed to a symlink.
    //
    bool PluginUtils::FollowSymlinkIfRequired(std::wstring& p_rPath)
    {
        using namespace coveo::linq;

        // Check if path or one of its parent points to a symlink.
        const auto isSymlink = [](const std::wstring& path) noexcept {
            const auto attributes = ::GetFileAttributesW(path.c_str());
            return attributes != INVALID_FILE_ATTRIBUTES && (attributes & FILE_ATTRIBUTE_REPARSE_POINT) != 0;
        };
        const bool symlink = from(coveo::enumerate_one(p_rPath))
                           | concat(EnumerateParents(p_rPath))
                           | any(isSymlink);
        if (symlink) {
            // In order to follow the symlink, we need a handle.
            DWORD flagsAndAttributes = FILE_ATTRIBUTE_NORMAL;
            if ((::GetFileAttributesW(p_rPath.c_str()) & FILE_ATTRIBUTE_DIRECTORY) != 0) {
                // Need this flag to open directory handles according to MSDN
                flagsAndAttributes |= FILE_FLAG_BACKUP_SEMANTICS;
            }
            StHandle hFile = ::CreateFileW(p_rPath.c_str(),
                                           GENERIC_READ,
                                           FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
                                           nullptr,
                                           OPEN_EXISTING,
                                           flagsAndAttributes,
                                           nullptr);
            if (hFile != nullptr) {
                const auto bufferSize = ::GetFinalPathNameByHandleW(hFile, nullptr, 0, FILE_NAME_NORMALIZED | VOLUME_NAME_DOS);
                if (bufferSize != 0) {
                    std::wstring finalPath(bufferSize + 1, L'\0');
                    const auto finalPathRes = ::GetFinalPathNameByHandleW(hFile,
                                                                          &*finalPath.begin(),
                                                                          bufferSize + 1,
                                                                          FILE_NAME_NORMALIZED | VOLUME_NAME_DOS);
                    if (finalPathRes != 0) {
                        p_rPath = finalPath.c_str();

                        // Fetching symlink target probably left us with a weird path, fix it
                        // because Explorer can't handle paths with \\?\ in them.
                        StringUtils::ReplaceAll(p_rPath, UNC_DRIVE_SYMLINK_PREFIX, L"");
                        StringUtils::ReplaceAll(p_rPath, LOCAL_DRIVE_SYMLINK_PREFIX, L"");
                    }
                }
            }
        }
        return symlink;
    }

    //
    // Checks if the given path is a UNC path in the form