diff --git a/smb/CMakeLists.txt b/smb/CMakeLists.txt index 29ba7ab0..69d77336 100644 --- a/smb/CMakeLists.txt +++ b/smb/CMakeLists.txt @@ -1,62 +1,84 @@ +option(BUILD_KDSoapWSDiscoveryClient "Automatically build WSD client if a system one isn't found." ON) +find_package(KDSoapWSDiscoveryClient QUIET) +set(INTERNAL_WSDCLIENT ${BUILD_KDSoapWSDiscoveryClient}) +if(KDSoapWSDiscoveryClient_FOUND) + set(INTERNAL_WSDCLIENT OFF) +endif() +if(INTERNAL_WSDCLIENT) + # Special internal version, mangled to be a STATIC lib. + # This is only useful and necessary until the library has + # its API finalized and gotten a stable release. + add_subdirectory(kdsoap-ws-discovery-client) +endif() +add_feature_info("Internal KDSoapWSDiscoveryClient" INTERNAL_WSDCLIENT + "Building using internal client because a system-provided version could not be found.") + add_feature_info("SMB DNS-SD Discovery" HAVE_KDNSSD_WITH_SIGNAL_RACE_PROTECTION "Discover SMB hosts via DNS-SD/Avahi/Bonjour. KF5DNSSD >= 5.54 is required to support this.") add_definitions(-DTRANSLATION_DOMAIN=\"kio5_smb\") include(CheckIncludeFile) set(CMAKE_AUTOMAKE ON) if(NOT WIN32) check_include_file(utime.h HAVE_UTIME_H) configure_file(config-smb.h.cmake ${CMAKE_CURRENT_BINARY_DIR}/config-smb.h) set(kio_smb_PART_SRCS kio_smb.cpp kio_smb_auth.cpp kio_smb_browse.cpp kio_smb_config.cpp kio_smb_dir.cpp kio_smb_file.cpp kio_smb_internal.cpp - kio_smb_mount.cpp ) + kio_smb_mount.cpp + wsdiscoverer.cpp + dnssddiscoverer.cpp + discovery.cpp +) ecm_qt_declare_logging_category(kio_smb_PART_SRCS HEADER smb-logsettings.h IDENTIFIER KIO_SMB_LOG CATEGORY_NAME log_kio_smb) include_directories(${SAMBA_INCLUDE_DIR}) add_library(kio_smb MODULE ${kio_smb_PART_SRCS}) target_link_libraries(kio_smb KF5::KIOCore KF5::I18n ${SAMBA_LIBRARIES} Qt5::Network - KF5::DNSSD) + KF5::DNSSD + KDSoap::WSDiscoveryClient +) else() set(kio_smb_PART_SRCS kio_smb_win.cpp) add_library(kio_smb MODULE ${kio_smb_PART_SRCS}) target_link_libraries(kio_smb KF5::KIOCore KF5::I18n mpr Qt5::Network KF5::DNSSD) endif() set_target_properties(kio_smb PROPERTIES OUTPUT_NAME "smb") +set_target_properties(kio_smb PROPERTIES LIBRARY_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/bin/kf5/kio") install(TARGETS kio_smb DESTINATION ${KDE_INSTALL_PLUGINDIR}/kf5/kio) ########### install files ############### install( FILES smb-network.desktop DESTINATION ${KDE_INSTALL_DATADIR}/konqueror/dirtree/remote ) install( FILES smb-network.desktop DESTINATION ${KDE_INSTALL_DATADIR}/remoteview ) diff --git a/smb/discovery.cpp b/smb/discovery.cpp new file mode 100644 index 00000000..918662e3 --- /dev/null +++ b/smb/discovery.cpp @@ -0,0 +1,31 @@ +/* + Copyright 2019 Harald Sitter + + This program 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 any later version accepted by the membership of + KDE e.V. (or its successor approved by the membership of KDE + e.V.), which shall act as a proxy defined in Section 14 of + version 3 of the license. + + This program 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 this program. If not, see . +*/ + +#include "discovery.h" + +Discovery::Discovery() +{ + qRegisterMetaType("Discovery::Ptr"); +} + +Discovery::~Discovery() = default; + +Discoverer::Discoverer() = default; +Discoverer::~Discoverer() = default; diff --git a/smb/discovery.h b/smb/discovery.h new file mode 100644 index 00000000..f5db5336 --- /dev/null +++ b/smb/discovery.h @@ -0,0 +1,53 @@ +/* + Copyright 2019 Harald Sitter + + This program 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 any later version accepted by the membership of + KDE e.V. (or its successor approved by the membership of KDE + e.V.), which shall act as a proxy defined in Section 14 of + version 3 of the license. + + This program 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 this program. If not, see . +*/ + +#ifndef DISCOVERY_H +#define DISCOVERY_H + +#include +#include + +class Discovery +{ +public: + typedef QSharedPointer Ptr; + + Discovery(); + virtual ~Discovery(); + virtual KIO::UDSEntry toEntry() const = 0; +}; + +class Discoverer +{ +public: + Discoverer(); + virtual ~Discoverer(); + + virtual void start() = 0; + virtual void stop() = 0; + virtual bool isFinished() const = 0; + + // Implement as signal! + virtual void newDiscovery(Discovery::Ptr discovery) = 0; + virtual void finished() = 0; +}; + +#endif // DISCOVERY_H + diff --git a/smb/dnssddiscoverer.cpp b/smb/dnssddiscoverer.cpp new file mode 100644 index 00000000..cb694f42 --- /dev/null +++ b/smb/dnssddiscoverer.cpp @@ -0,0 +1,118 @@ +/* + Copyright 2019 Harald Sitter + + This program 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 any later version accepted by the membership of + KDE e.V. (or its successor approved by the membership of KDE + e.V.), which shall act as a proxy defined in Section 14 of + version 3 of the license. + + This program 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 this program. If not, see . +*/ + +#include "dnssddiscoverer.h" +#include "kio_smb.h" + +DNSSDDiscovery::DNSSDDiscovery(KDNSSD::RemoteService::Ptr service) + : m_service(service) +{ +} + +KIO::UDSEntry DNSSDDiscovery::toEntry() const +{ + KIO::UDSEntry entry; + entry.fastInsert(KIO::UDSEntry::UDS_NAME, m_service->serviceName()); + + entry.fastInsert(KIO::UDSEntry::UDS_FILE_TYPE, S_IFDIR); + entry.fastInsert(KIO::UDSEntry::UDS_ACCESS, (S_IRUSR | S_IXUSR | S_IRGRP | S_IXGRP | S_IROTH | S_IXOTH)); + entry.fastInsert(KIO::UDSEntry::UDS_ICON_NAME, "network-server"); + + // TODO: it may be better to resolve the host to an ip address. dnssd + // being able to find a service doesn't mean name resolution is + // properly set up for its domain. So, we may not be able to resolve + // this without help from avahi. OTOH KDNSSD doesn't have API for this + // and from a platform POV we should probably assume that if avahi + // is functional it is also set up as resolution provider. + // Given the plugin design on glibc's libnss however I am not sure + // that assumption will be true all the time. ~sitter, 2018 + QUrl u; + u.setScheme(QStringLiteral("smb")); + u.setHost(m_service->hostName()); + if (m_service->port() > 0 && m_service->port() != 445 /* default smb */) { + u.setPort(m_service->port()); + } + u.setPath("/"); // https://bugs.kde.org/show_bug.cgi?id=388922 + + entry.fastInsert(KIO::UDSEntry::UDS_URL, u.url()); + entry.fastInsert(KIO::UDSEntry::UDS_MIME_TYPE, + QStringLiteral("application/x-smb-server")); + return entry; +} + +DNSSDDiscoverer::DNSSDDiscoverer() +{ + connect(&m_browser, &KDNSSD::ServiceBrowser::serviceAdded, + this, [=](KDNSSD::RemoteService::Ptr service){ + qCDebug(KIO_SMB_LOG) << "DNSSD added:" + << service->serviceName() + << service->type() + << service->domain() + << service->hostName() + << service->port(); + // Manual contains check. We need to use the == of the underlying + // objects, not the pointers. The same service may have >1 + // RemoteService* instances representing it, so the == impl of + // RemoteService::Ptr is useless here. + for (const auto &servicePtr : qAsConst(m_services)) { + if (*service == *servicePtr) { + return; + } + } + + connect(service.data(), &KDNSSD::RemoteService::resolved, + this, [=] { + ++m_resolvedCount; + emit newDiscovery(Discovery::Ptr(new DNSSDDiscovery(service))); + maybeFinish(); + }); + + // Schedule resolution of hostname. We'll later call resolve + // which will block until the resolution is done. This basically + // gives us a head start on discovery. + service->resolveAsync(); + m_services.append(service); + }); + connect(&m_browser, &KDNSSD::ServiceBrowser::finished, this, &DNSSDDiscoverer::stop); +} + +void DNSSDDiscoverer::start() +{ + m_browser.startBrowse(); +} + +void DNSSDDiscoverer::stop() +{ + m_browser.disconnect(); + m_disconnected = true; + maybeFinish(); +} + +bool DNSSDDiscoverer::isFinished() const +{ + return m_disconnected && m_services.count() == m_resolvedCount; +} + +void DNSSDDiscoverer::maybeFinish() +{ + if (isFinished()) { + emit finished(); + } +} diff --git a/smb/dnssddiscoverer.h b/smb/dnssddiscoverer.h new file mode 100644 index 00000000..ea05aba0 --- /dev/null +++ b/smb/dnssddiscoverer.h @@ -0,0 +1,64 @@ +/* + Copyright 2019 Harald Sitter + + This program 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 any later version accepted by the membership of + KDE e.V. (or its successor approved by the membership of KDE + e.V.), which shall act as a proxy defined in Section 14 of + version 3 of the license. + + This program 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 this program. If not, see . +*/ + +#ifndef DNSSDDISCOVERER_H +#define DNSSDDISCOVERER_H + +#include + +#include +#include + +#include "discovery.h" + +class DNSSDDiscovery : public Discovery +{ +public: + DNSSDDiscovery(KDNSSD::RemoteService::Ptr service); + KIO::UDSEntry toEntry() const override; + +private: + KDNSSD::RemoteService::Ptr m_service; +}; + +class DNSSDDiscoverer : public QObject, public Discoverer +{ + Q_OBJECT +public: + DNSSDDiscoverer(); + + void start() override; + bool isFinished() const override; + +signals: + void newDiscovery(Discovery::Ptr discovery) override; + void finished() override; + +private: + void stop() override; + void maybeFinish(); + + KDNSSD::ServiceBrowser m_browser { QStringLiteral("_smb._tcp") }; + QList m_services; + int m_resolvedCount = 0; + bool m_disconnected = false; +}; + +#endif // DNSSDDISCOVERER_H diff --git a/smb/kdsoap-ws-discovery-client/.gitignore b/smb/kdsoap-ws-discovery-client/.gitignore new file mode 100644 index 00000000..567609b1 --- /dev/null +++ b/smb/kdsoap-ws-discovery-client/.gitignore @@ -0,0 +1 @@ +build/ diff --git a/smb/kdsoap-ws-discovery-client/.gitlab-ci.yml b/smb/kdsoap-ws-discovery-client/.gitlab-ci.yml new file mode 100644 index 00000000..598ccbdd --- /dev/null +++ b/smb/kdsoap-ws-discovery-client/.gitlab-ci.yml @@ -0,0 +1,17 @@ +fedora: + image: registry.gitlab.com/caspermeijn/docker-images/fedora-build-onvifviewer:latest + stage: build + script: + - cd .. + - git clone https://github.com/KDAB/KDSoap.git + - mkdir build-KDSoap + - cd build-KDSoap/ + - cmake ../KDSoap/ -DCMAKE_INSTALL_PREFIX=/usr/local + - make + - make install + - cd .. + - mkdir build-kdsoap-ws-discovery-client + - cd build-kdsoap-ws-discovery-client + - cmake $CI_PROJECT_DIR + - make + - make install diff --git a/smb/kdsoap-ws-discovery-client/CMakeLists.txt b/smb/kdsoap-ws-discovery-client/CMakeLists.txt new file mode 100644 index 00000000..04eb7258 --- /dev/null +++ b/smb/kdsoap-ws-discovery-client/CMakeLists.txt @@ -0,0 +1,105 @@ +# Copyright (C) 2019 Casper Meijn +# +# This program 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. +# +# This program 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 this program. If not, see . + +cmake_minimum_required(VERSION 3.7) + +project(kdsoap-ws-discovery-client VERSION 0.1) + +include(FeatureSummary) +find_package(ECM 5.54.0 NO_MODULE) +set_package_properties(ECM PROPERTIES TYPE REQUIRED DESCRIPTION "Extra CMake Modules." URL "https://projects.kde.org/projects/kdesupport/extra-cmake-modules") +feature_summary(WHAT REQUIRED_PACKAGES_NOT_FOUND FATAL_ON_MISSING_REQUIRED_PACKAGES) +set(CMAKE_MODULE_PATH ${ECM_MODULE_PATH} ${ECM_KDE_MODULE_DIR}) + +include(KDEInstallDirs) +include(KDECompilerSettings NO_POLICY_SCOPE) +include(KDECMakeSettings) + +include(GenerateExportHeader) + +set(REQUIRED_QT_VERSION 5.9.0) +find_package(Qt5 ${REQUIRED_QT_VERSION} REQUIRED NO_MODULE COMPONENTS Core Network Xml) + +find_package(KDSoap 1.8.50 REQUIRED) +set_package_properties(KDSoap PROPERTIES + DESCRIPTION "A Qt-based client-side and server-side SOAP component" + URL "http://www.kdab.com/products/kd-soap" + TYPE REQUIRED + PURPOSE "Support for SOAP client protocol" +) + +include(ECMSetupVersion) +include(ECMGenerateHeaders) +include(ECMQtDeclareLoggingCategory) +include(ECMAddQch) + +option(BUILD_QCH "Build API documentation in QCH format (for e.g. Qt Assistant, Qt Creator & KDevelop)" OFF) +add_feature_info(QCH ${BUILD_QCH} "API documentation in QCH format (for e.g. Qt Assistant, Qt Creator & KDevelop)") + +ecm_setup_version(PROJECT + VARIABLE_PREFIX WSDISCOVERY + VERSION_HEADER "${CMAKE_CURRENT_BINARY_DIR}/kdsoap_wsdiscovery_client_version.h" + PACKAGE_VERSION_FILE "${CMAKE_CURRENT_BINARY_DIR}/KDSoapWSDiscoveryClientConfigVersion.cmake" +) + + +add_subdirectory(src) +#add_subdirectory(examples) +#if (BUILD_TESTING) +# add_subdirectory(autotests) +# add_subdirectory(tests) +#endif() + +## create a Config.cmake and a ConfigVersion.cmake file and install them +#set(CMAKECONFIG_INSTALL_DIR "${KDE_INSTALL_CMAKEPACKAGEDIR}/KDSoapWSDiscoveryClient") + +#if (BUILD_QCH) +# ecm_install_qch_export( +# TARGETS KDSoapWSDiscoveryClient_QCH +# FILE KDSoapWSDiscoveryClientQchTargets.cmake +# DESTINATION "${CMAKECONFIG_INSTALL_DIR}" +# COMPONENT Devel +# ) +# set(PACKAGE_INCLUDE_QCHTARGETS "include(\"\${CMAKE_CURRENT_LIST_DIR}/KDSoapWSDiscoveryClientQchTargets.cmake\")") +#endif() + +##include(CMakePackageConfigHelpers) + +##configure_package_config_file( +## "${CMAKE_CURRENT_SOURCE_DIR}/KDSoapWSDiscoveryClientConfig.cmake.in" +## "${CMAKE_CURRENT_BINARY_DIR}/KDSoapWSDiscoveryClientConfig.cmake" +## INSTALL_DESTINATION ${CMAKECONFIG_INSTALL_DIR} +##) + +## install(FILES ${CMAKE_CURRENT_BINARY_DIR}/kdsoap_wsdiscovery_client_version.h +## DESTINATION ${KDE_INSTALL_INCLUDEDIR}/KDSoapWSDiscoveryClient +## COMPONENT Devel) + +## install(FILES +## "${CMAKE_CURRENT_BINARY_DIR}/KDSoapWSDiscoveryClientConfig.cmake" +## "${CMAKE_CURRENT_BINARY_DIR}/KDSoapWSDiscoveryClientConfigVersion.cmake" +## DESTINATION "${CMAKECONFIG_INSTALL_DIR}" +## COMPONENT Devel) + +## install(EXPORT KDSoapWSDiscoveryClientTargets +## DESTINATION "${CMAKECONFIG_INSTALL_DIR}" +## FILE KDSoapWSDiscoveryClientTargets.cmake +## NAMESPACE KDSoap::) + + +##feature_summary( +## WHAT ALL +## FATAL_ON_MISSING_REQUIRED_PACKAGES +##) diff --git a/smb/kdsoap-ws-discovery-client/KDSoapWSDiscoveryClientConfig.cmake.in b/smb/kdsoap-ws-discovery-client/KDSoapWSDiscoveryClientConfig.cmake.in new file mode 100644 index 00000000..5d9999c9 --- /dev/null +++ b/smb/kdsoap-ws-discovery-client/KDSoapWSDiscoveryClientConfig.cmake.in @@ -0,0 +1,5 @@ +@PACKAGE_INIT@ + +find_dependency(Qt5Core @REQUIRED_QT_VERSION@) + +include("${CMAKE_CURRENT_LIST_DIR}/KDSoapWSDiscoveryClientTargets.cmake") diff --git a/smb/kdsoap-ws-discovery-client/LICENSE b/smb/kdsoap-ws-discovery-client/LICENSE new file mode 100644 index 00000000..a6508838 --- /dev/null +++ b/smb/kdsoap-ws-discovery-client/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + KDSoap WS-Discovery client + Copyright (C) 2019 Casper Meijn + + This program 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. + + This program 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 this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + KDSoap WS-Discovery client Copyright (C) 2019 Casper Meijn + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/smb/kdsoap-ws-discovery-client/README.md b/smb/kdsoap-ws-discovery-client/README.md new file mode 100644 index 00000000..31b44acd --- /dev/null +++ b/smb/kdsoap-ws-discovery-client/README.md @@ -0,0 +1,52 @@ +# KDSoap WS-Discovery client + +This project is trying to create a WS-Discovery client library based on the KDSoap +library. It uses modern C++ 11 and Qt 5. The initial development is done for +[ONVIFViewer](https://gitlab.com/caspermeijn/onvifviewer), a ONVIF camera viewer. +However the library is designed to be useful as a generic WS-Discovery client. + +## Current state + +The library is not yet ready for production. It needs patches to KDSoap, most are +applied to [this tree](https://github.com/caspermeijn/KDSoap). It also needs some +internal KDSoap headers. + +## Contributions + +Contributions to the project are appreciated. See the +[issue tracker](https://gitlab.com/caspermeijn/kdsoap-ws-discovery-client/issues) +to open tasks and feel free to open a merge request for the changes you made. + +Compatibility testing with devices you own is also useful. These could be ONVIF +cameras, printers or other WS-Discovery devices. Open an issue in the +[issue tracker](https://gitlab.com/caspermeijn/kdsoap-ws-discovery-client/issues) +to report your test result (good and bad result are both welcome). + +## Example + +The onif-discover example will send out a Probe message for ONVIF devices and will list the properties of the responding devices. + +``` +$ onvif-discover +Starting ONVIF discovery for 5 seconds +ProbeMatch received: + Endpoint reference: "urn:uuid:5f5a69c2-e0ae-504f-829b-00AFA538AC17" + Type: "NetworkVideoTransmitter" in namespace "http://www.onvif.org/ver10/network/wsdl" + Scope: "onvif://www.onvif.org/Profile/Streaming" + Scope: "onvif://www.onvif.org/model/C6F0SiZ0N0P0L0" + Scope: "onvif://www.onvif.org/name/IPCAM" + Scope: "onvif://www.onvif.org/location/country/china" + XAddr: "http://192.168.128.248:8080/onvif/devices" +``` + +## Building + +To build this project you need a copy of KDSoap and have extra-cmake-modules installed. + +``` +$ sudo apt install extra-cmake-modules +$ git checkout https://github.com/caspermeijn/KDSoap.git +$ git checkout https://gitlab.com/caspermeijn/kdsoap-ws-discovery-client.git +$ cd kdsoap-ws-discovery-client && mkdir build && cd build +$ cmake .. && make && make install +``` diff --git a/smb/kdsoap-ws-discovery-client/examples/CMakeLists.txt b/smb/kdsoap-ws-discovery-client/examples/CMakeLists.txt new file mode 100644 index 00000000..c1f4e327 --- /dev/null +++ b/smb/kdsoap-ws-discovery-client/examples/CMakeLists.txt @@ -0,0 +1,16 @@ +# Copyright (C) 2019 Casper Meijn +# +# This program 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. +# +# This program 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 this program. If not, see . + +add_subdirectory(onvif-discover) diff --git a/smb/kdsoap-ws-discovery-client/examples/onvif-discover/CMakeLists.txt b/smb/kdsoap-ws-discovery-client/examples/onvif-discover/CMakeLists.txt new file mode 100644 index 00000000..5aa66ed0 --- /dev/null +++ b/smb/kdsoap-ws-discovery-client/examples/onvif-discover/CMakeLists.txt @@ -0,0 +1,24 @@ +# Copyright (C) 2019 Casper Meijn +# +# This program 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. +# +# This program 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 this program. If not, see . + +cmake_minimum_required(VERSION 3.7) + +project(onvif-discover) + +add_executable(${PROJECT_NAME} + "main.cpp" + "onvifdiscover.cpp" +) +target_link_libraries(${PROJECT_NAME} KDSoapWSDiscoveryClient) diff --git a/smb/kdsoap-ws-discovery-client/examples/onvif-discover/main.cpp b/smb/kdsoap-ws-discovery-client/examples/onvif-discover/main.cpp new file mode 100644 index 00000000..085a9ade --- /dev/null +++ b/smb/kdsoap-ws-discovery-client/examples/onvif-discover/main.cpp @@ -0,0 +1,32 @@ +/* Copyright (C) 2019 Casper Meijn + * + * This program 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. + * + * This program 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 this program. If not, see . + */ +#include +#include +#include +#include "onvifdiscover.h" + +Q_DECL_EXPORT int main(int argc, char *argv[]) +{ + QCoreApplication app(argc, argv); + + qDebug() << "Starting ONVIF discovery for 5 seconds"; + QTimer::singleShot(5000, &app, &QCoreApplication::quit); + + OnvifDiscover * onvifDiscover = new OnvifDiscover(&app); + onvifDiscover->start(); + + return app.exec(); +} diff --git a/smb/kdsoap-ws-discovery-client/examples/onvif-discover/onvifdiscover.cpp b/smb/kdsoap-ws-discovery-client/examples/onvif-discover/onvifdiscover.cpp new file mode 100644 index 00000000..cd69e0c1 --- /dev/null +++ b/smb/kdsoap-ws-discovery-client/examples/onvif-discover/onvifdiscover.cpp @@ -0,0 +1,56 @@ +/* Copyright (C) 2019 Casper Meijn + * + * This program 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. + * + * This program 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 this program. If not, see . + */ +#include "onvifdiscover.h" + +#include +#include +#include +#include +#include + +OnvifDiscover::OnvifDiscover(QObject *parent) : QObject(parent) +{ + m_client = new WSDiscoveryClient(this); + + m_probeJob = new WSDiscoveryProbeJob(m_client); + connect(m_probeJob, &WSDiscoveryProbeJob::matchReceived, this, &OnvifDiscover::matchReceived); + KDQName type("tdn:NetworkVideoTransmitter"); + type.setNameSpace("http://www.onvif.org/ver10/network/wsdl"); + m_probeJob->addType(type); +} + +OnvifDiscover::~OnvifDiscover() = default; + +void OnvifDiscover::start() +{ + m_client->start(); + m_probeJob->start(); +} + +void OnvifDiscover::matchReceived(const QSharedPointer &matchedService) +{ + qDebug() << "ProbeMatch received:"; + qDebug() << " Endpoint reference:" << matchedService->endpointReference(); + for(auto type : matchedService->typeList()) { + qDebug() << " Type:" << type.localName() << "in namespace" << type.nameSpace(); + } + for(auto scope : matchedService->scopeList()) { + qDebug() << " Scope:" << scope.toString(); + } + for(auto xAddr : matchedService->xAddrList()) { + qDebug() << " XAddr:" << xAddr.toString(); + } +} diff --git a/smb/kdsoap-ws-discovery-client/examples/onvif-discover/onvifdiscover.h b/smb/kdsoap-ws-discovery-client/examples/onvif-discover/onvifdiscover.h new file mode 100644 index 00000000..9fdc4a22 --- /dev/null +++ b/smb/kdsoap-ws-discovery-client/examples/onvif-discover/onvifdiscover.h @@ -0,0 +1,43 @@ +/* Copyright (C) 2019 Casper Meijn + * + * This program 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. + * + * This program 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 this program. If not, see . + */ +#ifndef ONVIFDISCOVER_H +#define ONVIFDISCOVER_H + +#include + +class WSDiscoveryClient; +class WSDiscoveryProbeJob; +class WSDiscoveryTargetService; + +class OnvifDiscover : public QObject +{ + Q_OBJECT +public: + explicit OnvifDiscover(QObject *parent = nullptr); + ~OnvifDiscover(); + +public slots: + void start(); + +private slots: + void matchReceived(const QSharedPointer& matchedService); + +private: + WSDiscoveryClient * m_client; + WSDiscoveryProbeJob * m_probeJob; +}; + +#endif // ONVIFDISCOVER_H diff --git a/smb/kdsoap-ws-discovery-client/src/CMakeLists.txt b/smb/kdsoap-ws-discovery-client/src/CMakeLists.txt new file mode 100644 index 00000000..86c9a883 --- /dev/null +++ b/smb/kdsoap-ws-discovery-client/src/CMakeLists.txt @@ -0,0 +1,102 @@ +# Copyright (C) 2019 Casper Meijn +# +# This program 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. +# +# This program 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 this program. If not, see . + +cmake_minimum_required(VERSION 3.7) + +set(GLOBAL_KSWSDL2CPP_OPTION) +get_filename_component(KDWSDL_IMPORT_PATH ../wsdl/ ABSOLUTE) +set(GLOBAL_KSWSDL2CPP_OPTION -import-path ${KDWSDL_IMPORT_PATH} -use-local-files-only) + +set(KSWSDL2CPP_OPTION -namespace WSDiscovery200901 ${GLOBAL_KSWSDL2CPP_OPTION}) +KDSOAP_GENERATE_WSDL(KDSoapWSDiscoveryClient_WSDL ${KDWSDL_IMPORT_PATH}/docs.oasis-open.org/ws-dd/discovery/1.1/os/wsdd-discovery-1.1-wsdl-os.wsdl) +set(KSWSDL2CPP_OPTION -namespace WSDiscovery200504 ${GLOBAL_KSWSDL2CPP_OPTION}) +KDSOAP_GENERATE_WSDL(KDSoapWSDiscoveryClient_WSDL ${KDWSDL_IMPORT_PATH}/schemas.xmlsoap.org/ws/2005/04/discovery/ws-discovery.wsdl) + +#set(KSWSDL2CPP_OPTION -namespace WSTransfer200409 ${GLOBAL_KSWSDL2CPP_OPTION}) +#KDSOAP_GENERATE_WSDL(KDSoapWSDiscoveryClient_WSDL ${KDWSDL_IMPORT_PATH}/schemas.xmlsoap.org/ws/2004/09/transfer/transfer.wsdl) + +set(KDSoapWSDiscoveryClient_SRCS + "wsdiscoveryclient.cpp" + "wsdiscoveryprobejob.cpp" + "wsdiscoverytargetservice.cpp" +) + +ecm_qt_declare_logging_category(KDSoapWSDiscoveryClient_SRCS + HEADER loggingcategory.h + IDENTIFIER KDSoapWSDiscoveryClient + CATEGORY_NAME kdsoap.wsdiscoveryclient + DEFAULT_SEVERITY Warning +) + +add_library(KDSoapWSDiscoveryClient STATIC ${KDSoapWSDiscoveryClient_SRCS} ${KDSoapWSDiscoveryClient_WSDL}) +generate_export_header(KDSoapWSDiscoveryClient BASE_NAME WSDiscoveryClient) +add_library(KDSoap::WSDiscoveryClient ALIAS KDSoapWSDiscoveryClient) +target_include_directories(KDSoapWSDiscoveryClient + INTERFACE "$" +) + +target_link_libraries(KDSoapWSDiscoveryClient + PUBLIC + Qt5::Core + KDSoap::kdsoap + PRIVATE +) + +set_target_properties(KDSoapWSDiscoveryClient PROPERTIES + VERSION ${WSDISCOVERY_VERSION_STRING} + SOVERSION ${WSDISCOVERY_SOVERSION} + EXPORT_NAME "WSDiscoveryClient" +) + +ecm_generate_headers(KDSoapWSDiscoveryClient_HEADERS + HEADER_NAMES + WSDiscoveryClient + WSDiscoveryProbeJob + WSDiscoveryTargetService + + REQUIRED_HEADERS KDSoapWSDiscoveryClient_HEADERS +) + +# install(TARGETS KDSoapWSDiscoveryClient +# EXPORT KDSoapWSDiscoveryClientTargets +# ${KDE_INSTALL_TARGETS_DEFAULT_ARGS}) +# +# install(FILES +# ${CMAKE_CURRENT_BINARY_DIR}/wsdiscoveryclient_export.h +# ${KDSoapWSDiscoveryClient_HEADERS} +# DESTINATION ${KDE_INSTALL_INCLUDEDIR}/KDSoapWSDiscoveryClient +# COMPONENT Devel) + +if(BUILD_QCH) + ecm_add_qch( + KDSoapWSDiscoveryClient_QCH + NAME KDSoapWSDiscoveryClient + BASE_NAME KDSoapWSDiscoveryClient + VERSION ${WSDISCOVERY_VERSION} + ORG_DOMAIN net.meijn + SOURCES # using only public headers, to cover only public API + ${KDSoapWSDiscoveryClient_HEADERS} + MD_MAINPAGE "${CMAKE_SOURCE_DIR}/README.md" + LINK_QCHS + Qt5Core_QCH + KDSoap_QCH + BLANK_MACROS + KARCHIVE_EXPORT + KARCHIVE_DEPRECATED + TAGFILE_INSTALL_DESTINATION ${KDE_INSTALL_QTQCHDIR} + QCH_INSTALL_DESTINATION ${KDE_INSTALL_QTQCHDIR} + COMPONENT Devel + ) +endif() diff --git a/smb/kdsoap-ws-discovery-client/src/wsdiscoveryclient.cpp b/smb/kdsoap-ws-discovery-client/src/wsdiscoveryclient.cpp new file mode 100644 index 00000000..6998fc32 --- /dev/null +++ b/smb/kdsoap-ws-discovery-client/src/wsdiscoveryclient.cpp @@ -0,0 +1,161 @@ +/* Copyright (C) 2019 Casper Meijn + * + * This program 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. + * + * This program 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 this program. If not, see . + */ +#include "wsdiscoveryclient.h" + +#include "loggingcategory.h" +#include "wsdiscoverytargetservice.h" + +#include +#include +#include +#include +#include +#include +#include + +#include "wsdl_wsdd-discovery-1.h" +#include "wsdl_ws-discovery.h" + +static const int DISCOVERY_PORT = 3702; +static const QHostAddress DISCOVERY_ADDRESS_IPV4 = QHostAddress(QStringLiteral("239.255.255.250")); +static const QHostAddress DISCOVERY_ADDRESS_IPV6 = QHostAddress(QStringLiteral("FF02::C")); + +WSDiscoveryClient::WSDiscoveryClient(QObject *parent) : + QObject(parent) +{ + m_soapUdpClient = new KDSoapUdpClient(this); + connect(m_soapUdpClient, &KDSoapUdpClient::receivedMessage, this, &WSDiscoveryClient::receivedMessage); +} + +WSDiscoveryClient::~WSDiscoveryClient() = default; + +void WSDiscoveryClient::start() +{ + bool rc = m_soapUdpClient->bind(DISCOVERY_PORT, QAbstractSocket::ShareAddress); + Q_ASSERT(rc); +} + +void WSDiscoveryClient::sendProbe(const QList &typeList, const QList &scopeList) +{ + WSDiscovery200504::TNS__ProbeType probe; + if(!typeList.isEmpty()) { + WSDiscovery200504::TNS__QNameListType types; + types.setEntries(typeList); + probe.setTypes(types); + } + if(!scopeList.isEmpty()) { + WSDiscovery200504::TNS__UriListType scopeValues; + scopeValues.setEntries(QUrl::toStringList(scopeList)); + WSDiscovery200504::TNS__ScopesType scopes; + scopes.setValue(scopeValues); + probe.setScopes(scopes); + } + + KDSoapMessage message; + message = probe.serialize(QStringLiteral("Probe")); + message.setUse(KDSoapMessage::LiteralUse); + message.setNamespaceUri(QStringLiteral("http://schemas.xmlsoap.org/ws/2005/04/discovery")); + + KDSoapMessageAddressingProperties addressing; + addressing.setAddressingNamespace(KDSoapMessageAddressingProperties::Addressing200408); + addressing.setAction(QStringLiteral("http://schemas.xmlsoap.org/ws/2005/04/discovery/Probe")); + addressing.setMessageID(QStringLiteral("urn:uuid:") + QUuid::createUuid().toString(QUuid::WithoutBraces)); + addressing.setDestination(QStringLiteral("urn:schemas-xmlsoap-org:ws:2005:04:discovery")); + addressing.setReplyEndpointAddress(KDSoapMessageAddressingProperties::predefinedAddressToString(KDSoapMessageAddressingProperties::Anonymous)); + message.setMessageAddressingProperties(addressing); + + auto rc = m_soapUdpClient->sendMessage(message, KDSoapHeaders(), DISCOVERY_ADDRESS_IPV4, DISCOVERY_PORT); + Q_ASSERT(rc); + rc = m_soapUdpClient->sendMessage(message, KDSoapHeaders(), DISCOVERY_ADDRESS_IPV6, DISCOVERY_PORT); + Q_ASSERT(rc); +} + +void WSDiscoveryClient::sendResolve(const QString &endpointReferenceString) +{ + WSDiscovery200504::TNS__ResolveType resolve; + + WSDiscovery200504::WSA__AttributedURI endpointReferenceAddress; + endpointReferenceAddress.setValue(endpointReferenceString); + WSDiscovery200504::WSA__EndpointReferenceType endpointReference; + endpointReference.setAddress(endpointReferenceAddress); + resolve.setEndpointReference(endpointReference); + + KDSoapMessage message; + message = resolve.serialize(QStringLiteral("Resolve")); + message.setUse(KDSoapMessage::LiteralUse); + message.setNamespaceUri(QStringLiteral("http://schemas.xmlsoap.org/ws/2005/04/discovery")); + + KDSoapMessageAddressingProperties addressing; + addressing.setAddressingNamespace(KDSoapMessageAddressingProperties::Addressing200408); + addressing.setAction(QStringLiteral("http://schemas.xmlsoap.org/ws/2005/04/discovery/Resolve")); + addressing.setMessageID(QStringLiteral("urn:uuid:") + QUuid::createUuid().toString(QUuid::WithoutBraces)); + addressing.setDestination(QStringLiteral("urn:schemas-xmlsoap-org:ws:2005:04:discovery")); + addressing.setReplyEndpointAddress(KDSoapMessageAddressingProperties::predefinedAddressToString(KDSoapMessageAddressingProperties::Anonymous)); + message.setMessageAddressingProperties(addressing); + + auto rc = m_soapUdpClient->sendMessage(message, KDSoapHeaders(), DISCOVERY_ADDRESS_IPV4, DISCOVERY_PORT); + Q_ASSERT(rc); + rc = m_soapUdpClient->sendMessage(message, KDSoapHeaders(), DISCOVERY_ADDRESS_IPV6, DISCOVERY_PORT); + Q_ASSERT(rc); +} + +void WSDiscoveryClient::receivedMessage(const KDSoapMessage &replyMessage, const KDSoapHeaders &replyHeaders, const QHostAddress &senderAddress, quint16 senderPort) +{ + Q_UNUSED(replyHeaders); + Q_UNUSED(senderAddress); + Q_UNUSED(senderPort); + if(replyMessage.messageAddressingProperties().action() == QStringLiteral("http://schemas.xmlsoap.org/ws/2005/04/discovery/Probe")) { + // NO-OP + } else if(replyMessage.messageAddressingProperties().action() == QStringLiteral("http://schemas.xmlsoap.org/ws/2005/04/discovery/Resolve")) { + // NO-OP + } else if(replyMessage.messageAddressingProperties().action() == QStringLiteral("http://schemas.xmlsoap.org/ws/2005/04/discovery/ResolveMatches")) { + WSDiscovery200504::TNS__ResolveMatchesType resolveMatches; + resolveMatches.deserialize(replyMessage); + + auto resolveMatch = resolveMatches.resolveMatch(); + const QString& endpointReference = resolveMatch.endpointReference().address(); + QSharedPointer service = m_targetServiceMap.value(endpointReference); + if(service.isNull()) { + service = QSharedPointer::create(endpointReference); + m_targetServiceMap.insert(endpointReference, service); + } + service->setTypeList(resolveMatch.types().entries()); + service->setScopeList(QUrl::fromStringList(resolveMatch.scopes().value().entries())); + service->setXAddrList(QUrl::fromStringList(resolveMatch.xAddrs().entries())); + service->updateLastSeen(); + emit resolveMatchReceived(service); + } else if(replyMessage.messageAddressingProperties().action() == QStringLiteral("http://schemas.xmlsoap.org/ws/2005/04/discovery/ProbeMatches")) { + WSDiscovery200504::TNS__ProbeMatchesType probeMatches; + probeMatches.deserialize(replyMessage); + + for(const WSDiscovery200504::TNS__ProbeMatchType& probeMatch : probeMatches.probeMatch()) { + const QString& endpointReference = probeMatch.endpointReference().address(); + QSharedPointer service = m_targetServiceMap.value(endpointReference); + if(service.isNull()) { + service = QSharedPointer::create(endpointReference); + m_targetServiceMap.insert(endpointReference, service); + } + service->setTypeList(probeMatch.types().entries()); + service->setScopeList(QUrl::fromStringList(probeMatch.scopes().value().entries())); + service->setXAddrList(QUrl::fromStringList(probeMatch.xAddrs().entries())); + service->updateLastSeen(); + emit probeMatchReceived(service); + } + } else { + qCDebug(KDSoapWSDiscoveryClient) << "Received message with unknown action:" << replyMessage.messageAddressingProperties().action(); + } +} + diff --git a/smb/kdsoap-ws-discovery-client/src/wsdiscoveryclient.h b/smb/kdsoap-ws-discovery-client/src/wsdiscoveryclient.h new file mode 100644 index 00000000..f531bab7 --- /dev/null +++ b/smb/kdsoap-ws-discovery-client/src/wsdiscoveryclient.h @@ -0,0 +1,54 @@ +/* Copyright (C) 2019 Casper Meijn + * + * This program 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. + * + * This program 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 this program. If not, see . + */ +#ifndef WSDISCOVERYCLIENT_H +#define WSDISCOVERYCLIENT_H + +#include "wsdiscoveryclient_export.h" +#include +#include + +class KDSoapHeaders; +class KDSoapMessage; +class KDQName; +class KDSoapUdpClient; +class QHostAddress; +class WSDiscoveryTargetService; + +class WSDISCOVERYCLIENT_EXPORT WSDiscoveryClient : public QObject +{ + Q_OBJECT +public: + explicit WSDiscoveryClient(QObject *parent = nullptr); + ~WSDiscoveryClient(); + +signals: + void probeMatchReceived(const QSharedPointer& probeMatchService); + void resolveMatchReceived(const QSharedPointer& probeMatchService); + +public slots: + void start(); + void sendProbe(const QList& typeList, const QList &scopeList); + void sendResolve(const QString& endpointReference); + +private slots: + void receivedMessage(const KDSoapMessage& replyMessage, const KDSoapHeaders& replyHeaders, const QHostAddress& senderAddress, quint16 senderPort); + +private: + KDSoapUdpClient * m_soapUdpClient; + QHash> m_targetServiceMap; +}; + +#endif // WSDISCOVERYCLIENT_H diff --git a/smb/kdsoap-ws-discovery-client/src/wsdiscoveryprobejob.cpp b/smb/kdsoap-ws-discovery-client/src/wsdiscoveryprobejob.cpp new file mode 100644 index 00000000..d4b95d0d --- /dev/null +++ b/smb/kdsoap-ws-discovery-client/src/wsdiscoveryprobejob.cpp @@ -0,0 +1,104 @@ +/* Copyright (C) 2019 Casper Meijn + * + * This program 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. + * + * This program 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 this program. If not, see . + */ +#include "wsdiscoveryprobejob.h" + +#include "loggingcategory.h" +#include "wsdiscoveryclient.h" +#include "wsdiscoverytargetservice.h" +#include +#include + +WSDiscoveryProbeJob::WSDiscoveryProbeJob(WSDiscoveryClient *parent) : + QObject(parent), + m_client(parent) +{ + connect(m_client, &WSDiscoveryClient::probeMatchReceived, this, &WSDiscoveryProbeJob::probeMatchReceived); + + m_timer.setInterval(30000); + connect(&m_timer, &QTimer::timeout, this, &WSDiscoveryProbeJob::timeout); +} + +QList WSDiscoveryProbeJob::typeList() const +{ + return m_typeList; +} + +void WSDiscoveryProbeJob::setTypeList(const QList &typeList) +{ + m_typeList = typeList; +} + +void WSDiscoveryProbeJob::addType(const KDQName &type) +{ + m_typeList.append(type); +} + +QList WSDiscoveryProbeJob::scopeList() const +{ + return m_scopeList; +} + +void WSDiscoveryProbeJob::setScopeList(const QList &scopeList) +{ + m_scopeList = scopeList; +} + +void WSDiscoveryProbeJob::addScope(const QUrl &scope) +{ + m_scopeList.append(scope); +} + +int WSDiscoveryProbeJob::interval() const +{ + return m_timer.interval(); +} + +void WSDiscoveryProbeJob::setInterval(int interval) +{ + m_timer.setInterval(interval); +} + +void WSDiscoveryProbeJob::start() +{ + timeout(); + m_timer.start(); +} + +void WSDiscoveryProbeJob::stop() +{ + m_timer.stop(); +} + +void WSDiscoveryProbeJob::timeout() +{ + m_client->sendProbe(m_typeList, m_scopeList); +} + +void WSDiscoveryProbeJob::probeMatchReceived(const QSharedPointer &probeMatchService) +{ + bool isMatch = true; + for(const KDQName& type : m_typeList) { + isMatch = probeMatchService->isMatchingType(type) && isMatch; + } + for(const QUrl& scope : m_scopeList) { + isMatch = probeMatchService->isMatchingScope(scope) && isMatch; + } + if(isMatch) { + emit matchReceived(probeMatchService); + } else { + qCDebug(KDSoapWSDiscoveryClient) << "Received probe match that didn't match the probe job"; + } +} diff --git a/smb/kdsoap-ws-discovery-client/src/wsdiscoveryprobejob.h b/smb/kdsoap-ws-discovery-client/src/wsdiscoveryprobejob.h new file mode 100644 index 00000000..69649336 --- /dev/null +++ b/smb/kdsoap-ws-discovery-client/src/wsdiscoveryprobejob.h @@ -0,0 +1,63 @@ +/* Copyright (C) 2019 Casper Meijn + * + * This program 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. + * + * This program 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 this program. If not, see . + */ +#ifndef WSDISCOVERYPROBEJOB_H +#define WSDISCOVERYPROBEJOB_H + +#include "wsdiscoveryclient_export.h" +#include +#include +#include +#include + +class WSDiscoveryClient; +class WSDiscoveryTargetService; + +class WSDISCOVERYCLIENT_EXPORT WSDiscoveryProbeJob : public QObject +{ + Q_OBJECT +public: + explicit WSDiscoveryProbeJob(WSDiscoveryClient *parent = nullptr); + + QList typeList() const; + void setTypeList(const QList &typeList); + void addType(const KDQName& type); + + QList scopeList() const; + void setScopeList(const QList &scopeList); + void addScope(const QUrl& scope); + + int interval() const; + void setInterval(int interval); + +signals: + void matchReceived(const QSharedPointer& matchedService); + +public slots: + void start(); + void stop(); + +private slots: + void timeout(); + void probeMatchReceived(const QSharedPointer& probeMatchService); + +private: + WSDiscoveryClient * m_client; + QList m_typeList; + QList m_scopeList; + QTimer m_timer; +}; + +#endif // WSDISCOVERYPROBEJOB_H diff --git a/smb/kdsoap-ws-discovery-client/src/wsdiscoverytargetservice.cpp b/smb/kdsoap-ws-discovery-client/src/wsdiscoverytargetservice.cpp new file mode 100644 index 00000000..d6d9e13e --- /dev/null +++ b/smb/kdsoap-ws-discovery-client/src/wsdiscoverytargetservice.cpp @@ -0,0 +1,90 @@ +/* Copyright (C) 2019 Casper Meijn + * + * This program 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. + * + * This program 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 this program. If not, see . + */ +#include "wsdiscoverytargetservice.h" + +WSDiscoveryTargetService::WSDiscoveryTargetService(const QString &endpointReference) : + m_endpointReference(endpointReference) +{ +} + +QDateTime WSDiscoveryTargetService::lastSeen() const +{ + return m_lastSeen; +} + +void WSDiscoveryTargetService::setLastSeen(const QDateTime &lastSeen) +{ + m_lastSeen = lastSeen; +} + +void WSDiscoveryTargetService::updateLastSeen() +{ + setLastSeen(QDateTime::currentDateTime()); +} + +bool WSDiscoveryTargetService::isMatchingType(const KDQName &matchingType) +{ + for(const KDQName &type : m_typeList) { + if(matchingType.nameSpace() == type.nameSpace() && + matchingType.localName() == type.localName()) + return true; + } + return false; +} + +bool WSDiscoveryTargetService::isMatchingScope(const QUrl &matchingScope) +{ + for(const QUrl &scope : m_scopeList) { + if(matchingScope == scope) + return true; + } + return false; +} + +QList WSDiscoveryTargetService::xAddrList() const +{ + return m_xAddrList; +} + +void WSDiscoveryTargetService::setXAddrList(const QList &xAddrList) +{ + m_xAddrList = xAddrList; +} + +QList WSDiscoveryTargetService::scopeList() const +{ + return m_scopeList; +} + +void WSDiscoveryTargetService::setScopeList(const QList &scopeList) +{ + m_scopeList = scopeList; +} + +QList WSDiscoveryTargetService::typeList() const +{ + return m_typeList; +} + +void WSDiscoveryTargetService::setTypeList(const QList &typeList) +{ + m_typeList = typeList; +} + +QString WSDiscoveryTargetService::endpointReference() const +{ + return m_endpointReference; +} diff --git a/smb/kdsoap-ws-discovery-client/src/wsdiscoverytargetservice.h b/smb/kdsoap-ws-discovery-client/src/wsdiscoverytargetservice.h new file mode 100644 index 00000000..1e0f6ea9 --- /dev/null +++ b/smb/kdsoap-ws-discovery-client/src/wsdiscoverytargetservice.h @@ -0,0 +1,51 @@ +/* Copyright (C) 2019 Casper Meijn + * + * This program 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. + * + * This program 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 this program. If not, see . + */ +#ifndef WSDISCOVERYTARGETSERVICE_H +#define WSDISCOVERYTARGETSERVICE_H + +#include "wsdiscoveryclient_export.h" +#include +#include +#include + +class WSDISCOVERYCLIENT_EXPORT WSDiscoveryTargetService +{ +public: + explicit WSDiscoveryTargetService(const QString &endpointReference); + + QString endpointReference() const; + QList typeList() const; + void setTypeList(const QList &typeList); + QList scopeList() const; + void setScopeList(const QList &scopeList); + QList xAddrList() const; + void setXAddrList(const QList &xAddrList); + QDateTime lastSeen() const; + void setLastSeen(const QDateTime &lastSeen); + void updateLastSeen(); + + bool isMatchingType(const KDQName &matchingType); + bool isMatchingScope(const QUrl &matchingScope); + +private: + QString m_endpointReference; + QList m_typeList; + QList m_scopeList; + QList m_xAddrList; + QDateTime m_lastSeen; +}; + +#endif // WSDISCOVERYTARGETSERVICE_H diff --git a/smb/kdsoap-ws-discovery-client/wsdl/docs.oasis-open.org/ws-dd/discovery/1.1/os/wsdd-discovery-1.1-schema-os.xsd b/smb/kdsoap-ws-discovery-client/wsdl/docs.oasis-open.org/ws-dd/discovery/1.1/os/wsdd-discovery-1.1-schema-os.xsd new file mode 100644 index 00000000..d53e1798 --- /dev/null +++ b/smb/kdsoap-ws-discovery-client/wsdl/docs.oasis-open.org/ws-dd/discovery/1.1/os/wsdd-discovery-1.1-schema-os.xsd @@ -0,0 +1,230 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/smb/kdsoap-ws-discovery-client/wsdl/docs.oasis-open.org/ws-dd/discovery/1.1/os/wsdd-discovery-1.1-wsdl-os.wsdl b/smb/kdsoap-ws-discovery-client/wsdl/docs.oasis-open.org/ws-dd/discovery/1.1/os/wsdd-discovery-1.1-wsdl-os.wsdl new file mode 100644 index 00000000..e17169bb --- /dev/null +++ b/smb/kdsoap-ws-discovery-client/wsdl/docs.oasis-open.org/ws-dd/discovery/1.1/os/wsdd-discovery-1.1-wsdl-os.wsdl @@ -0,0 +1,136 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/smb/kdsoap-ws-discovery-client/wsdl/download.sh b/smb/kdsoap-ws-discovery-client/wsdl/download.sh new file mode 100755 index 00000000..e9b8a466 --- /dev/null +++ b/smb/kdsoap-ws-discovery-client/wsdl/download.sh @@ -0,0 +1,30 @@ +#!/bin/bash +set -eu + +# Copyright (C) 2019 Casper Meijn +# +# This program 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. +# +# This program 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 this program. If not, see . + +# First download WS-Discovery 2005-04 +wget --no-verbose -r http://schemas.xmlsoap.org/ws/2005/04/discovery/ws-discovery.xsd +wget --no-verbose -r http://schemas.xmlsoap.org/ws/2004/08/addressing +# Apperently the original file is not available anymore: http://schemas.xmlsoap.org/ws/2005/04/discovery/ws-discovery.wsdl +wget --no-verbose https://web.archive.org/web/20070225062601/http://schemas.xmlsoap.org/ws/2005/04/discovery/ws-discovery.wsdl +mv -v ws-discovery.wsdl schemas.xmlsoap.org/ws/2005/04/discovery/ws-discovery.wsdl + +# Then download OASIS WS-Discovery 2009-01 +wget --no-verbose -r http://docs.oasis-open.org/ws-dd/discovery/1.1/os/wsdd-discovery-1.1-wsdl-os.wsdl +wget --no-verbose -r http://docs.oasis-open.org/ws-dd/discovery/1.1/os/wsdd-discovery-1.1-schema-os.xsd +wget --no-verbose -r http://www.w3.org/2006/03/addressing/ws-addr.xsd + diff --git a/smb/kdsoap-ws-discovery-client/wsdl/schemas.xmlsoap.org/ws/2004/08/addressing b/smb/kdsoap-ws-discovery-client/wsdl/schemas.xmlsoap.org/ws/2004/08/addressing new file mode 100644 index 00000000..50bab467 --- /dev/null +++ b/smb/kdsoap-ws-discovery-client/wsdl/schemas.xmlsoap.org/ws/2004/08/addressing @@ -0,0 +1,149 @@ + + + + + + + + + + + + + + + + + If "Policy" elements from namespace "http://schemas.xmlsoap.org/ws/2002/12/policy#policy" are used, they must appear first (before any extensibility elements). + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/smb/kdsoap-ws-discovery-client/wsdl/schemas.xmlsoap.org/ws/2004/09/transfer/transfer.wsdl b/smb/kdsoap-ws-discovery-client/wsdl/schemas.xmlsoap.org/ws/2004/09/transfer/transfer.wsdl new file mode 100644 index 00000000..acc3d433 --- /dev/null +++ b/smb/kdsoap-ws-discovery-client/wsdl/schemas.xmlsoap.org/ws/2004/09/transfer/transfer.wsdl @@ -0,0 +1,92 @@ + + + + + + + + + + + + + + + + + + + + + + + + This port type defines a resource that may be read, + written, and deleted. + + + + + + + + + + + + + + + + + + This port type defines a Web service that can create new + resources. + + + + + + + diff --git a/smb/kdsoap-ws-discovery-client/wsdl/schemas.xmlsoap.org/ws/2004/09/transfer/transfer.xsd b/smb/kdsoap-ws-discovery-client/wsdl/schemas.xmlsoap.org/ws/2004/09/transfer/transfer.xsd new file mode 100644 index 00000000..134eb163 --- /dev/null +++ b/smb/kdsoap-ws-discovery-client/wsdl/schemas.xmlsoap.org/ws/2004/09/transfer/transfer.xsd @@ -0,0 +1,73 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/smb/kdsoap-ws-discovery-client/wsdl/schemas.xmlsoap.org/ws/2005/04/discovery/ws-discovery.wsdl b/smb/kdsoap-ws-discovery-client/wsdl/schemas.xmlsoap.org/ws/2005/04/discovery/ws-discovery.wsdl new file mode 100644 index 00000000..fb308b24 --- /dev/null +++ b/smb/kdsoap-ws-discovery-client/wsdl/schemas.xmlsoap.org/ws/2005/04/discovery/ws-discovery.wsdl @@ -0,0 +1,140 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/smb/kdsoap-ws-discovery-client/wsdl/schemas.xmlsoap.org/ws/2005/04/discovery/ws-discovery.xsd b/smb/kdsoap-ws-discovery-client/wsdl/schemas.xmlsoap.org/ws/2005/04/discovery/ws-discovery.xsd new file mode 100644 index 00000000..4a7e08cf --- /dev/null +++ b/smb/kdsoap-ws-discovery-client/wsdl/schemas.xmlsoap.org/ws/2005/04/discovery/ws-discovery.xsd @@ -0,0 +1,272 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/smb/kdsoap-ws-discovery-client/wsdl/www.w3.org/2006/03/addressing/ws-addr.xsd b/smb/kdsoap-ws-discovery-client/wsdl/www.w3.org/2006/03/addressing/ws-addr.xsd new file mode 100644 index 00000000..47362edb --- /dev/null +++ b/smb/kdsoap-ws-discovery-client/wsdl/www.w3.org/2006/03/addressing/ws-addr.xsd @@ -0,0 +1,137 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/smb/kio_smb.h b/smb/kio_smb.h index 7891d07a..079d9947 100644 --- a/smb/kio_smb.h +++ b/smb/kio_smb.h @@ -1,323 +1,322 @@ ///////////////////////////////////////////////////////////////////////////// // // Project: SMB kioslave for KDE // // File: kio_smb.h // // Abstract: The main kio slave class declaration. For convenience, // in concurrent development, the implementation for this class // is separated into several .cpp files -- the file containing // the implementation should be noted in the comments for each // member function. // // Author(s): Matthew Peterson // //--------------------------------------------------------------------------- // // Copyright (c) 2000 Caldera Systems, Inc. // // This program 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 2.1 of the License, or // (at your option) any later version. // // This program 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 Lesser General Public License for more details. // // You should have received a copy of the GNU General Public License // along with this program; see the file COPYING. If not, please obtain // a copy from https://www.gnu.org/copyleft/gpl.html // ///////////////////////////////////////////////////////////////////////////// #ifndef KIO_SMB_H_INCLUDED #define KIO_SMB_H_INCLUDED #include #include "smb-logsettings.h" //-------------- // KDE includes //-------------- #include #include //----------------------------- // Standard C library includes //----------------------------- #include #include #include #include #include #include #include #include #include #include //----------------------------- // Qt includes //----------------------------- #include #include #include //------------------------------- // Samba client library includes //------------------------------- extern "C" { #include } //--------------------------- // kio_smb internal includes //--------------------------- #include "kio_smb_internal.h" #define MAX_XFER_BUF_SIZE 65534 using namespace KIO; //=========================================================================== class SMBSlave : public QObject, public KIO::SlaveBase { Q_OBJECT private: class SMBError { public: int kioErrorId; QString errorString; }; //--------------------------------------------------------------------- // please make sure your private data does not duplicate existing data //--------------------------------------------------------------------- bool m_initialized_smbc; /** * From Controlcenter */ QString m_default_user; QString m_default_workgroup = QStringLiteral("WORKGROUP"); // overwritten with value from smbc QString m_default_password; QString m_default_encoding; /** * we store the current url, it's needed for * callback authorization method */ SMBUrl m_current_url; /** * From Controlcenter, show SHARE$ or not */ // bool m_showHiddenShares; //currently unused, Alex /** * libsmbclient need global variables to store in, * else it crashes on exit next method after use cache_stat, * looks like gcc (C/C++) failure */ struct stat st; protected: //--------------------------------------------- // Authentication functions (kio_smb_auth.cpp) //--------------------------------------------- // (please prefix functions with auth) /** * Description : Initializes the libsmbclient * Return : true on success false with errno set on error */ bool auth_initialize_smbc(); int checkPassword(SMBUrl &url); //--------------------------------------------- // Cache functions (kio_smb_auth.cpp) //--------------------------------------------- //Stat methods //----------------------------------------- // Browsing functions (kio_smb_browse.cpp) //----------------------------------------- // (please prefix functions with browse) /** * Description : Return a stat of given SMBUrl. Calls cache_stat and * pack it in UDSEntry. UDSEntry will not be cleared * Parameter : SMBUrl the url to stat * Return : cache_stat() return code */ int browse_stat_path(const SMBUrl& url, UDSEntry& udsentry); /** * Description : call smbc_stat and return stats of the url * Parameter : SMBUrl the url to stat * Return : stat* of the url * Note : it has some problems with stat in method, looks like * something leave(or removed) on the stack. If your * method segfault on returning try to change the stat* * variable */ int cache_stat( const SMBUrl& url, struct stat* st ); //--------------------------------------------- // Configuration functions (kio_smb_config.cpp) //--------------------------------------------- // (please prefix functions with config) //--------------------------------------- // Directory functions (kio_smb_dir.cpp) //--------------------------------------- // (please prefix functions with dir) //-------------------------------------- // File IO functions (kio_smb_file.cpp) //-------------------------------------- // (please prefix functions with file) //---------------------------- // Misc functions (this file) //---------------------------- /** * Description : correct a given URL * valid URL's are * * smb://[[domain;]user[:password]@]server[:port][/share[/path[/file]]] * smb:/[[domain;]user[:password]@][group/[server[/share[/path[/file]]]]] * domain = workgroup(domain) of the user * user = username * password = password of useraccount * group = workgroup(domain) of server * server = host to connect * share = a share of the server (host) * path = a path of the share * Parameter : QUrl the url to check * Return : new QUrl if it is corrected. else the same QUrl */ QUrl checkURL(const QUrl& kurl) const; void reportError(const SMBUrl& url, const int errNum); void reportWarning(const SMBUrl& url, const int errNum); public: //----------------------------------------------------------------------- // smbclient authentication callback (note that this is called by the // global ::auth_smbc_get_data() call. void auth_smbc_get_data(const char *server,const char *share, char *workgroup, int wgmaxlen, char *username, int unmaxlen, char *password, int pwmaxlen); //----------------------------------------------------------------------- // Overwritten functions from the base class that define the operation of // this slave. (See the base class headerfile slavebase.h for more // details) //----------------------------------------------------------------------- // Functions overwritten in kio_smb.cpp SMBSlave(const QByteArray& pool, const QByteArray& app); ~SMBSlave() override; // Functions overwritten in kio_smb_browse.cpp void listDir( const QUrl& url ) override; void stat( const QUrl& url ) override; // Functions overwritten in kio_smb_config.cpp void reparseConfiguration() override; // Functions overwritten in kio_smb_dir.cpp void copy( const QUrl& src, const QUrl &dest, int permissions, KIO::JobFlags flags ) override; void del( const QUrl& kurl, bool isfile) override; void mkdir( const QUrl& kurl, int permissions ) override; void rename( const QUrl& src, const QUrl& dest, KIO::JobFlags flags ) override; // Functions overwritten in kio_smb_file.cpp void get( const QUrl& kurl ) override; void put( const QUrl& kurl, int permissions, KIO::JobFlags flags ) override; void open( const QUrl& kurl, QIODevice::OpenMode mode ) override; void read( KIO::filesize_t bytesRequested ) override; void write( const QByteArray &fileData ) override; void seek( KIO::filesize_t offset ) override; void truncate( KIO::filesize_t length ); void close() override; // Functions not implemented (yet) //virtual void setHost(const QString& host, int port, const QString& user, const QString& pass); //virtual void openConnection(); //virtual void closeConnection(); //virtual void slave_status(); void special( const QByteArray & ) override; protected: void virtual_hook(int id, void *data) override; private: SMBError errnumToKioError(const SMBUrl& url, const int errNum); void smbCopy(const QUrl& src, const QUrl &dest, int permissions, KIO::JobFlags flags); void smbCopyGet(const QUrl& src, const QUrl& dest, int permissions, KIO::JobFlags flags); void smbCopyPut(const QUrl& src, const QUrl& dest, int permissions, KIO::JobFlags flags); bool workaroundEEXIST(const int errNum) const; - void listDNSSD(UDSEntry &udsentry, const QUrl &url, const uint direntCount); void fileSystemFreeSpace(const QUrl &url); /** * Used in open(), read(), write(), and close() * FIXME Placing these in the private section above causes m_openUrl = kurl * to fail in SMBSlave::open. Need to find out why this is. */ int m_openFd; SMBUrl m_openUrl; const bool m_enableEEXISTWorkaround; /* Enables a workaround for some broken libsmbclient versions */ // Close without calling finish(). Use this to close after error. void closeWithoutFinish(); }; //========================================================================== // the global libsmbclient authentication callback function extern "C" { void auth_smbc_get_data(SMBCCTX * context, const char *server,const char *share, char *workgroup, int wgmaxlen, char *username, int unmaxlen, char *password, int pwmaxlen); } //=========================================================================== // Main slave entrypoint (see kio_smb.cpp) extern "C" { int kdemain( int argc, char **argv ); } #endif //#endif KIO_SMB_H_INCLUDED diff --git a/smb/kio_smb_browse.cpp b/smb/kio_smb_browse.cpp index 6fc90449..9e2441ec 100644 --- a/smb/kio_smb_browse.cpp +++ b/smb/kio_smb_browse.cpp @@ -1,722 +1,681 @@ ///////////////////////////////////////////////////////////////////////////// // // Project: SMB kioslave for KDE2 // // File: kio_smb_browse.cpp // // Abstract: member function implementations for SMBSlave that deal with // SMB browsing // // Author(s): Matthew Peterson // //--------------------------------------------------------------------------- // // Copyright (c) 2000 Caldera Systems, Inc. -// Copyright (c) 2018 Harald Sitter +// Copyright (c) 2018-2020 Harald Sitter // // This program 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 2.1 of the License, or // (at your option) any later version. // // This program 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 Lesser General Public License for more details. // // You should have received a copy of the GNU General Public License // along with this program; see the file COPYING. If not, please obtain // a copy from https://www.gnu.org/copyleft/gpl.html // ///////////////////////////////////////////////////////////////////////////// #include "kio_smb.h" #include "kio_smb_internal.h" #include #include #include #include #include +#include + #include #include #include +#include "wsdiscoverer.h" +#include "dnssddiscoverer.h" using namespace KIO; int SMBSlave::cache_stat(const SMBUrl &url, struct stat* st ) { int cacheStatErr; int result = smbc_stat( url.toSmbcUrl(), st); if (result == 0){ cacheStatErr = 0; } else { cacheStatErr = errno; } qCDebug(KIO_SMB_LOG) << "size " << (KIO::filesize_t)st->st_size; return cacheStatErr; } //--------------------------------------------------------------------------- int SMBSlave::browse_stat_path(const SMBUrl& _url, UDSEntry& udsentry) { SMBUrl url = _url; int cacheStatErr = cache_stat(url, &st); if(cacheStatErr == 0) { if(!S_ISDIR(st.st_mode) && !S_ISREG(st.st_mode)) { qCDebug(KIO_SMB_LOG) << "mode: "<< st.st_mode; warning(i18n("%1:\n" "Unknown file type, neither directory or file.", url.toDisplayString())); return EINVAL; } if (!S_ISDIR(st.st_mode)) { // Awkwardly documented at // https://www.samba.org/samba/docs/using_samba/ch08.html // libsmb_stat.c assigns special meaning to +x permissions // (obviously only on files, all dirs are +x so this hacky representation // wouldn't work!): // - S_IXUSR = DOS archive: This file has been touched since the last DOS backup was performed on it. // - S_IXGRP = DOS system: This file has a specific purpose required by the operating system. // - S_IXOTH = DOS hidden: This file has been marked to be invisible to the user, unless the operating system is explicitly set to show it. // Only hiding has backing through KIO right now. if (st.st_mode & S_IXOTH) { // DOS hidden udsentry.fastInsert(KIO::UDSEntry::UDS_HIDDEN, true); } } // UID and GID **must** not be mapped. The values returned by libsmbclient are // simply the getuid/getgid of the process. They mean absolutely nothing. // Also see libsmb_stat.c. // Related: https://bugs.kde.org/show_bug.cgi?id=212801 // POSIX Access mode must not be mapped either! // It's meaningless for smb shares and downright disadvantagous. // The mode attributes outside the ones used and document above are // useless. The only one actively set is readonlyness. // // BUT the READONLY attribute does nothing on NT systems: // https://support.microsoft.com/en-us/help/326549/you-cannot-view-or-change-the-read-only-or-the-system-attributes-of-fo // The Read-only and System attributes is only used by Windows Explorer to determine // whether the folder is a special folder, such as a system folder that has its view // customized by Windows (for example, My Documents, Favorites, Fonts, Downloaded Program Files), // or a folder that you customized by using the Customize tab of the folder's Properties dialog box. // // As such respecting it on a KIO level is actually wrong as it doesn't indicate actual // readonlyness since the 90s and causes us to show readonly UI states when in fact // the directory is perfectly writable. // https://bugs.kde.org/show_bug.cgi?id=414482 // // Should we ever want to parse desktop.ini like we do .directory we'd only want to when a // dir is readonly as per the above microsoft support article. // Also see: // https://docs.microsoft.com/en-us/windows/win32/shell/how-to-customize-folders-with-desktop-ini udsentry.fastInsert(KIO::UDSEntry::UDS_ACCESS, -1); udsentry.fastInsert(KIO::UDSEntry::UDS_FILE_TYPE, st.st_mode & S_IFMT); udsentry.fastInsert(KIO::UDSEntry::UDS_SIZE, st.st_size); udsentry.fastInsert(KIO::UDSEntry::UDS_MODIFICATION_TIME, st.st_mtime); udsentry.fastInsert(KIO::UDSEntry::UDS_ACCESS_TIME, st.st_atime); // No, st_ctime is not UDS_CREATION_TIME... } return cacheStatErr; } //=========================================================================== void SMBSlave::stat( const QUrl& kurl ) { qCDebug(KIO_SMB_LOG) << kurl; // make a valid URL QUrl url = checkURL(kurl); // if URL is not valid we have to redirect to correct URL if (url != kurl) { qCDebug(KIO_SMB_LOG) << "redirection " << url; redirection(url); finished(); return; } m_current_url = url; UDSEntry udsentry; // Set name udsentry.fastInsert( KIO::UDSEntry::UDS_NAME, kurl.fileName() ); switch(m_current_url.getType()) { case SMBURLTYPE_UNKNOWN: error(ERR_MALFORMED_URL, url.toDisplayString()); return; case SMBURLTYPE_ENTIRE_NETWORK: case SMBURLTYPE_WORKGROUP_OR_SERVER: udsentry.fastInsert(KIO::UDSEntry::UDS_FILE_TYPE, S_IFDIR); break; case SMBURLTYPE_SHARE_OR_PATH: { int ret = browse_stat_path(m_current_url, udsentry); if (ret == EPERM || ret == EACCES || workaroundEEXIST(ret)) { SMBUrl smbUrl(url); const int passwordError = checkPassword(smbUrl); if (passwordError == KJob::NoError) { redirection(smbUrl); finished(); } else if (passwordError == KIO::ERR_USER_CANCELED) { reportError(url, ret); } else { error(passwordError, url.toString()); } return; } else if (ret != 0) { qCDebug(KIO_SMB_LOG) << "stat() error" << ret << url; reportError(url, ret); return; } break; } default: qCDebug(KIO_SMB_LOG) << "UNKNOWN " << url; finished(); return; } statEntry(udsentry); finished(); } //=========================================================================== // TODO: complete checking <-- what does that even mean? // TODO: why is this not part of SMBUrl or at the very least URL validation should // be 100% shared between this and SMBUrl. Notably SMBUrl has code that looks // to do a similar thing but is much less complete. QUrl SMBSlave::checkURL(const QUrl &kurl_) const { qCDebug(KIO_SMB_LOG) << "checkURL " << kurl_; QUrl kurl(kurl_); // We treat cifs as an alias but need to translate it to smb. // https://bugs.kde.org/show_bug.cgi?id=327295 // It's not IANA registered and also libsmbc internally expects // smb URIs so we do very broadly coerce cifs to smb. // Also see SMBUrl. if (kurl.scheme() == "cifs") { kurl.setScheme("smb"); } QString surl = kurl.url(); //transform any links in the form smb:/ into smb:// if (surl.startsWith(QLatin1String("smb:/"))) { if (surl.length() == 5) { return QUrl("smb://"); } if (surl.at(5) != '/') { surl = "smb://" + surl.mid(5); qCDebug(KIO_SMB_LOG) << "checkURL return1 " << surl << " " << QUrl(surl); return QUrl(surl); } } if (surl == QLatin1String("smb://")) { return kurl; //unchanged } // smb:// normally have no userinfo // we must redirect ourself to remove the username and password if (surl.contains('@') && !surl.contains("smb://")) { QUrl url(kurl); url.setPath('/'+kurl.url().right( kurl.url().length()-kurl.url().indexOf('@') -1)); QString userinfo = kurl.url().mid(5, kurl.url().indexOf('@')-5); if(userinfo.contains(':')) { url.setUserName(userinfo.left(userinfo.indexOf(':'))); url.setPassword(userinfo.right(userinfo.length()-userinfo.indexOf(':')-1)); } else { url.setUserName(userinfo); } qCDebug(KIO_SMB_LOG) << "checkURL return2 " << url; return url; } //if there's a valid host, don't have an empty path QUrl url(kurl); if (url.path().isEmpty()) url.setPath("/"); qCDebug(KIO_SMB_LOG) << "checkURL return3 " << url; return url; } SMBSlave::SMBError SMBSlave::errnumToKioError(const SMBUrl &url, const int errNum) { qCDebug(KIO_SMB_LOG) << "errNum" << errNum; switch(errNum) { case ENOENT: if (url.getType() == SMBURLTYPE_ENTIRE_NETWORK) return SMBError{ ERR_SLAVE_DEFINED, i18n("Unable to find any workgroups in your local network. This might be caused by an enabled firewall.") }; else return SMBError{ ERR_DOES_NOT_EXIST, url.toDisplayString() }; #ifdef ENOMEDIUM case ENOMEDIUM: return SMBError{ ERR_SLAVE_DEFINED, i18n("No media in device for %1", url.toDisplayString()) }; #endif #ifdef EHOSTDOWN case EHOSTDOWN: #endif case ECONNREFUSED: return SMBError{ ERR_SLAVE_DEFINED, i18n("Could not connect to host for %1", url.toDisplayString()) }; break; case ENOTDIR: return SMBError{ ERR_CANNOT_ENTER_DIRECTORY, url.toDisplayString() }; case EFAULT: case EINVAL: return SMBError{ ERR_DOES_NOT_EXIST, url.toDisplayString() }; case EPERM: case EACCES: return SMBError{ ERR_ACCESS_DENIED, url.toDisplayString() }; case EIO: case ENETUNREACH: if ( url.getType() == SMBURLTYPE_ENTIRE_NETWORK || url.getType() == SMBURLTYPE_WORKGROUP_OR_SERVER ) return SMBError{ ERR_SLAVE_DEFINED, i18n("Error while connecting to server responsible for %1", url.toDisplayString()) }; else return SMBError{ ERR_CONNECTION_BROKEN, url.toDisplayString() }; case ENOMEM: return SMBError{ ERR_OUT_OF_MEMORY, url.toDisplayString() }; case ENODEV: return SMBError{ ERR_SLAVE_DEFINED, i18n("Share could not be found on given server") }; case EBADF: return SMBError{ ERR_INTERNAL, i18n("Bad file descriptor") }; case ETIMEDOUT: return SMBError{ ERR_SERVER_TIMEOUT, url.host() }; case ENOTEMPTY: return SMBError{ ERR_CANNOT_RMDIR, url.toDisplayString() }; #ifdef ENOTUNIQ case ENOTUNIQ: return SMBError{ ERR_SLAVE_DEFINED, i18n("The given name could not be resolved to a unique server. " "Make sure your network is setup without any name conflicts " "between names used by Windows and by UNIX name resolution." ) }; #endif case ECONNABORTED: return SMBError{ ERR_CONNECTION_BROKEN, url.host() }; case EHOSTUNREACH: return SMBError{ ERR_CANNOT_CONNECT, i18nc("@info:status smb failed to reach the server (e.g. server offline or network failure). %1 is an ip address or hostname", "%1: Host unreachable", url.host()) }; case 0: // success return SMBError{ ERR_INTERNAL, i18n("libsmbclient reported an error, but did not specify " "what the problem is. This might indicate a severe problem " "with your network - but also might indicate a problem with " "libsmbclient.\n" "If you want to help us, please provide a tcpdump of the " "network interface while you try to browse (be aware that " "it might contain private data, so do not post it if you are " "unsure about that - you can send it privately to the developers " "if they ask for it)") }; default: return SMBError{ ERR_INTERNAL, i18n("Unknown error condition in stat: %1", QString::fromLocal8Bit( strerror(errNum))) }; } } void SMBSlave::reportError(const SMBUrl& url, const int errNum) { const SMBError smbErr = errnumToKioError(url, errNum); error(smbErr.kioErrorId, smbErr.errorString); } void SMBSlave::reportWarning(const SMBUrl& url, const int errNum) { const SMBError smbErr = errnumToKioError(url, errNum); const QString errorString = buildErrorString(smbErr.kioErrorId, smbErr.errorString); warning(xi18n("Error occurred while trying to access %1%2", url.url(), errorString)); } //=========================================================================== void SMBSlave::listDir( const QUrl& kurl ) { qCDebug(KIO_SMB_LOG) << kurl; int errNum = 0; // check (correct) URL QUrl url = checkURL(kurl); // if URL is not valid we have to redirect to correct URL if (url != kurl) { redirection(url); finished(); return; } m_current_url = kurl; int dirfd; struct smbc_dirent *dirp = nullptr; UDSEntry udsentry; bool dir_is_root = true; dirfd = smbc_opendir( m_current_url.toSmbcUrl() ); if (dirfd > 0){ errNum = 0; } else { errNum = errno; } qCDebug(KIO_SMB_LOG) << "open " << m_current_url.toSmbcUrl() << " " << m_current_url.getType() << " " << dirfd; if(dirfd >= 0) { uint direntCount = 0; do { qCDebug(KIO_SMB_LOG) << "smbc_readdir "; dirp = smbc_readdir(dirfd); if(dirp == nullptr) break; ++direntCount; // Set name QString udsName; const QString dirpName = QString::fromUtf8( dirp->name ); // We cannot trust dirp->commentlen has it might be with or without the NUL character // See KDE bug #111430 and Samba bug #3030 const QString comment = QString::fromUtf8( dirp->comment ); if ( dirp->smbc_type == SMBC_SERVER || dirp->smbc_type == SMBC_WORKGROUP ) { udsName = dirpName.toLower(); udsName[0] = dirpName.at( 0 ).toUpper(); if ( !comment.isEmpty() && dirp->smbc_type == SMBC_SERVER ) udsName += " (" + comment + ')'; } else udsName = dirpName; qCDebug(KIO_SMB_LOG) << "dirp->name " << dirp->name << " " << dirpName << " '" << comment << "'" << " " << dirp->smbc_type; udsentry.fastInsert( KIO::UDSEntry::UDS_NAME, udsName ); udsentry.fastInsert(KIO::UDSEntry::UDS_COMMENT, QString::fromUtf8(dirp->comment)); // Mark all administrative shares, e.g ADMIN$, as hidden. #197903 if (dirpName.endsWith(QLatin1Char('$'))) { //qCDebug(KIO_SMB_LOG) << dirpName << "marked as hidden"; udsentry.fastInsert(KIO::UDSEntry::UDS_HIDDEN, 1); } if (udsName == ".") { // Skip the "." entry // Mind the way m_current_url is handled in the loop } else if (udsName == "..") { dir_is_root = false; // fprintf(stderr,"----------- hide: -%s-\n",dirp->name); // do nothing and hide the hidden shares } else if (dirp->smbc_type == SMBC_FILE || dirp->smbc_type == SMBC_DIR) { // Set stat information m_current_url.addPath(dirpName); const int statErr = browse_stat_path(m_current_url, udsentry); if (statErr) { if (statErr == ENOENT || statErr == ENOTDIR) { reportWarning(m_current_url, statErr); } } else { // Call base class to list entry listEntry(udsentry); } m_current_url.cd(".."); } else if(dirp->smbc_type == SMBC_SERVER || dirp->smbc_type == SMBC_FILE_SHARE) { // Set type udsentry.fastInsert( KIO::UDSEntry::UDS_FILE_TYPE, S_IFDIR ); if (dirp->smbc_type == SMBC_SERVER) { udsentry.fastInsert(KIO::UDSEntry::UDS_ACCESS, (S_IRUSR | S_IXUSR | S_IRGRP | S_IXGRP | S_IROTH | S_IXOTH)); // QString workgroup = m_current_url.host().toUpper(); QUrl u("smb://"); u.setHost(dirpName); // when libsmbclient knows // u = QString("smb://%1?WORKGROUP=%2").arg(dirpName).arg(workgroup.toUpper()); qCDebug(KIO_SMB_LOG) << "list item " << u; udsentry.fastInsert(KIO::UDSEntry::UDS_URL, u.url()); udsentry.fastInsert(KIO::UDSEntry::UDS_MIME_TYPE, QString::fromLatin1("application/x-smb-server")); } else udsentry.fastInsert(KIO::UDSEntry::UDS_ACCESS, (S_IRWXU | S_IRWXG | S_IROTH | S_IXOTH)); // Call base class to list entry listEntry(udsentry); } else if(dirp->smbc_type == SMBC_WORKGROUP) { // Set type udsentry.fastInsert(KIO::UDSEntry::UDS_FILE_TYPE, S_IFDIR); // Set permissions udsentry.fastInsert(KIO::UDSEntry::UDS_ACCESS, (S_IRUSR | S_IRGRP | S_IROTH | S_IXUSR | S_IXGRP | S_IXOTH)); udsentry.fastInsert(KIO::UDSEntry::UDS_MIME_TYPE, QString::fromLatin1("application/x-smb-workgroup")); // QString workgroup = m_current_url.host().toUpper(); QUrl u("smb://"); u.setHost(dirpName); udsentry.fastInsert(KIO::UDSEntry::UDS_URL, u.url()); // Call base class to list entry listEntry(udsentry); } else { qCDebug(KIO_SMB_LOG) << "SMBC_UNKNOWN :" << dirpName; // TODO: we don't handle SMBC_IPC_SHARE, SMBC_PRINTER_SHARE // SMBC_LINK, SMBC_COMMS_SHARE //SlaveBase::error(ERR_INTERNAL, TEXT_UNSUPPORTED_FILE_TYPE); // continue; } udsentry.clear(); } while (dirp); // checked already in the head - listDNSSD(udsentry, url, direntCount); + // Run service discovery if the path is root. This augments + // "native" results from libsmbclient. + auto normalizedUrl = url.adjusted(QUrl::NormalizePathSegments); + if (normalizedUrl.path().isEmpty()) { + qCDebug(KIO_SMB_LOG) << "Trying modern discovery (dnssd/wsdiscovery)"; + + QEventLoop e; + + UDSEntryList list; + + const auto flushEntries = [this, &list]() { + if (list.isEmpty()) { + return; + } + listEntries(list); + list.clear(); + }; + + const auto quitLoop = [&e, &flushEntries]() { + flushEntries(); + e.quit(); + }; + + // Since slavebase has no eventloop it wont publish results + // on a timer, since we do not know how long our discovery + // will take this is super meh because we may appear + // stuck for a while. Implement our own listing system + // based on QTimer to mitigate. + QTimer sendTimer; + sendTimer.setInterval(300); + connect(&sendTimer, &QTimer::timeout, this, flushEntries); + sendTimer.start(); + + DNSSDDiscoverer d; + WSDiscoverer w; + + const QList discoverers {&d, &w}; + + auto appendDiscovery = [&](Discovery::Ptr discovery) { + list.append(discovery->toEntry()); + }; + + auto maybeFinished = [&] { // finishes if all discoveries finished + bool allFinished = true; + for (auto discoverer : discoverers) { + allFinished = allFinished && discoverer->isFinished(); + } + if (allFinished) { + quitLoop(); + } + }; + + connect(&d, &DNSSDDiscoverer::newDiscovery, this, appendDiscovery); + connect(&w, &WSDiscoverer::newDiscovery, this, appendDiscovery); + + connect(&d, &DNSSDDiscoverer::finished, this, maybeFinished); + connect(&w, &WSDiscoverer::finished, this, maybeFinished); + + d.start(); + w.start(); + + QTimer::singleShot(16000, &e, quitLoop); // max execution time! + e.exec(); + + qCDebug(KIO_SMB_LOG) << "Modern discovery finished."; + } if (dir_is_root) { udsentry.fastInsert(KIO::UDSEntry::UDS_FILE_TYPE, S_IFDIR); udsentry.fastInsert(KIO::UDSEntry::UDS_NAME, "."); udsentry.fastInsert(KIO::UDSEntry::UDS_ACCESS, (S_IRUSR | S_IRGRP | S_IROTH | S_IXUSR | S_IXGRP | S_IXOTH)); } else { udsentry.fastInsert(KIO::UDSEntry::UDS_NAME, "."); const int statErr = browse_stat_path(m_current_url, udsentry); if (statErr) { if (statErr == ENOENT || statErr == ENOTDIR) { reportWarning(m_current_url, statErr); } // Create a default UDSEntry if we could not stat the actual directory udsentry.fastInsert(KIO::UDSEntry::UDS_FILE_TYPE, S_IFDIR); udsentry.fastInsert(KIO::UDSEntry::UDS_ACCESS, (S_IRWXU | S_IRWXG | S_IROTH | S_IXOTH)); } } listEntry(udsentry); udsentry.clear(); // clean up smbc_closedir(dirfd); } else { if (errNum == EPERM || errNum == EACCES || workaroundEEXIST(errNum)) { const int passwordError = checkPassword(m_current_url); if (passwordError == KJob::NoError) { redirection( m_current_url ); finished(); } else if (passwordError == KIO::ERR_USER_CANCELED) { reportError(m_current_url, errNum); } else { error(passwordError, m_current_url.toString()); } return; } reportError(m_current_url, errNum); return; } finished(); } -void SMBSlave::listDNSSD(UDSEntry &udsentry, const QUrl &url, const uint direntCount) -{ - // Certain versions of KDNSSD suffer from signal races which can easily - // deadlock the slave. -#ifndef HAVE_KDNSSD_WITH_SIGNAL_RACE_PROTECTION - return; -#endif // HAVE_KDNSSD_WITH_SIGNAL_RACE_PROTECTION - - // This entire method act as fallback logic iff SMB discovery is not working - // (for example when using a protocol version that doesn't have discovery). - // As such we can return if entries were discovered or the URL is not '/' - auto normalizedUrl = url.adjusted(QUrl::NormalizePathSegments); - if (direntCount > 0 || !normalizedUrl.path().isEmpty()) { - return; - } - - // Slaves have no event loop, start one for the poll. - // KDNSSD has an internal timeout which may trigger if this takes too long - // so in theory this should not ever be able to get stuck. - // The eventloop runs until the discovery is finished. The finished slot - // will quit it. - QList services; - QEventLoop e; - KDNSSD::ServiceBrowser browser(QStringLiteral("_smb._tcp")); - connect(&browser, &KDNSSD::ServiceBrowser::serviceAdded, - this, [&services](KDNSSD::RemoteService::Ptr service){ - qCDebug(KIO_SMB_LOG) << "DNSSD added:" - << service->serviceName() - << service->type() - << service->domain() - << service->hostName() - << service->port(); - // Manual contains check. We need to use the == of the underlying - // objects, not the pointers. The same service may have >1 - // RemoteService* instances representing it, so the == impl of - // RemoteService::Ptr is useless here. - for (const auto &it : services) { - if (*service == *it) { - return; - } - } - // Schedule resolution of hostname. We'll later call resolve - // which will block until the resolution is done. This basically - // gives us a head start. - service->resolveAsync(); - services.append(service); - }); - connect(&browser, &KDNSSD::ServiceBrowser::serviceRemoved, - this, [&services](KDNSSD::RemoteService::Ptr service){ - qCDebug(KIO_SMB_LOG) << "DNSSD removed:" - << service->serviceName() - << service->type() - << service->domain() - << service->hostName() - << service->port(); - services.removeAll(service); - }); - connect(&browser, &KDNSSD::ServiceBrowser::finished, - this, [&]() { - browser.disconnect(); // Stop sending anything, we'll exit here. - // Resolution still requires an event loop. So, let the resolutions - // finish and then quit the loop. Services that fail resolution - // get dropped since we won't be able to access them properly. - for (auto it = services.begin(); it != services.end(); ++it) { - auto service = *it; - if (!service->resolve()) { - qCWarning(KIO_SMB_LOG) << "Failed to resolve DNSSD service" - << service->serviceName(); - it = services.erase(it); - } - } - e.quit(); - }); - browser.startBrowse(); - e.exec(); - - for (const auto &service : services) { - udsentry.fastInsert(KIO::UDSEntry::UDS_NAME, service->serviceName()); - - udsentry.fastInsert(KIO::UDSEntry::UDS_FILE_TYPE, S_IFDIR); - udsentry.fastInsert(KIO::UDSEntry::UDS_ACCESS, (S_IRUSR | S_IXUSR | S_IRGRP | S_IXGRP | S_IROTH | S_IXOTH)); - - // TODO: it may be better to resolve the host to an ip address. dnssd - // being able to find a service doesn't mean name resolution is - // properly set up for its domain. So, we may not be able to resolve - // this without help from avahi. OTOH KDNSSD doesn't have API for this - // and from a platform POV we should probably assume that if avahi - // is functional it is also set up as resolution provider. - // Given the plugin design on glibc's libnss however I am not sure - // that assumption will be true all the time. ~sitter, 2018 - QUrl u(QStringLiteral("smb://")); - u.setHost(service->hostName()); - if (service->port() > 0 && service->port() != 445 /* default smb */) { - u.setPort(service->port()); - } - - udsentry.fastInsert(KIO::UDSEntry::UDS_URL, u.url()); - udsentry.fastInsert(KIO::UDSEntry::UDS_MIME_TYPE, - QStringLiteral("application/x-smb-server")); - - listEntry(udsentry); - udsentry.clear(); - } - - // NOTE: workgroups cannot be properly resolved because libsmbclient - // seems to lack the appropriate API to pull this data out of netbios. - // Netbios is also not working on IPv6 and its replacement (LLMNR) - // doesn't support the concept of workgroups. -} - void SMBSlave::fileSystemFreeSpace(const QUrl& url) { qCDebug(KIO_SMB_LOG) << url; // Avoid crashing in smbc_fstatvfs below when // requesting free space for smb:// which doesn't // make sense to do to begin with if (url.host().isEmpty()) { error(KIO::ERR_CANNOT_STAT, url.url()); return; } SMBUrl smbcUrl = url; struct statvfs dirStat; memset(&dirStat, 0, sizeof(struct statvfs)); const int err = smbc_statvfs(smbcUrl.toSmbcUrl().data(), &dirStat); if (err < 0) { error(KIO::ERR_CANNOT_STAT, url.url()); return; } // libsmb_stat.c has very awkward conditional branching that results // in data meaning different things based on context: // A samba host with unix extensions has f_frsize==0 and the f_bsize is // the actual block size. Any other server (such as windows) has a non-zero // f_frsize denoting the amount of sectors in a block and the f_bsize is // the amount of bytes in a sector. As such frsize*bsize is the actual // block size. // This was also broken in different ways throughout history, so depending // on the specific libsmbc versions the milage will vary. 4.7 to 4.11 are // at least behaving as described though. // https://bugs.kde.org/show_bug.cgi?id=298801 const auto frames = (dirStat.f_frsize == 0) ? 1 : dirStat.f_frsize; const auto blockSize = dirStat.f_bsize * frames; // Further more on older versions of samba f_bavail may not be set... const auto total = blockSize * dirStat.f_blocks; const auto available = blockSize * ((dirStat.f_bavail != 0) ? dirStat.f_bavail : dirStat.f_bfree); setMetaData("total", QString::number(total)); setMetaData("available", QString::number(available)); finished(); } bool SMBSlave::workaroundEEXIST(const int errNum) const { return (errNum == EEXIST) && m_enableEEXISTWorkaround; } diff --git a/smb/wsdiscoverer.cpp b/smb/wsdiscoverer.cpp new file mode 100644 index 00000000..bd7fbb94 --- /dev/null +++ b/smb/wsdiscoverer.cpp @@ -0,0 +1,315 @@ +/* + Copyright 2019-2020 Harald Sitter + + This program 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 any later version accepted by the membership of + KDE e.V. (or its successor approved by the membership of KDE + e.V.), which shall act as a proxy defined in Section 14 of + version 3 of the license. + + This program 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 this program. If not, see . +*/ + +#include "wsdiscoverer.h" + +#include +#include +#include +#include +#include + +#include +#include + +#include +#include +#include +#include + +#include +#include + +#include "kio_smb.h" + +// Publication service data resolver! +// Specifically we'll ask the endpoint for PBSData via ws-transfer/Get. +// The implementation is the bare minimum for our purposes! +// https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-pbsd +class PBSDResolver : public QObject +{ + Q_OBJECT +signals: + void resolved(Discovery::Ptr discovery); + +public: + /** + * @param endpointUrl valid xaddr as advertised over ws-discovery (http://$ip/$referenceUuid) + * @param destination endpoint reference urn as sent over ws-discovery ($referenceUuid) + */ + PBSDResolver(const QUrl &endpointUrl, const QString &destination, QObject *parent = nullptr) + : QObject(parent) + , m_endpointUrl(endpointUrl) + , m_destination(destination) + { + } + + static QString nameFromComputerInfo(const QString &info) + { + // NB: spec says to use \ or / based on context, but in reality they are used + // interchangibly in implementations. + static QRegularExpression domainExpression("(?.+)[\\/]Domain:(?.+)"); + static QRegularExpression workgroupExpression("(?.+)[\\/]Workgroup:(?.+)"); + static QRegularExpression notJoinedExpression("(?.+)[\\/]NotJoined"); + + // We don't do anything with WG or domain info because windows10 doesn't seem to either. + const auto joinedMatch = notJoinedExpression.match(info); + if (joinedMatch.hasMatch()) { + return joinedMatch.captured("name"); + } + + const auto domainMatch = domainExpression.match(info); + if (domainMatch.hasMatch()) { + return domainMatch.captured("name"); + } + + const auto workgroupMatch = workgroupExpression.match(info); + if (workgroupMatch.hasMatch()) { + return workgroupMatch.captured("name"); + } + + return info; + } + + // This must always set m_discovery and it must also time out on its own! + void run() + { + // NB: when windows talks to windows they use lms:LargeMetadataSupport we probably don't + // need this for the data we want, so it's left out. The actual messagse a windows + // machine creates would be using "http://schemas.microsoft.com/windows/lms/2007/08" + // as messageNamespace and set an additional header on the message. + // https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-dpwssn/f700463d-cbbf-4545-ab47-b9a6fbf1ac7b + + KDSoapClientInterface client(m_endpointUrl.toString(), + QStringLiteral("http://schemas.xmlsoap.org/ws/2004/09/transfer")); + client.setSoapVersion(KDSoapClientInterface::SoapVersion::SOAP1_2); + client.setTimeout(8000); + + KDSoapMessage message; + KDSoapMessageAddressingProperties addressing; + addressing.setAddressingNamespace(KDSoapMessageAddressingProperties::Addressing200408); + addressing.setAction(QStringLiteral("http://schemas.xmlsoap.org/ws/2004/09/transfer/Get")); + addressing.setMessageID(QStringLiteral("urn:uuid:") + QUuid::createUuid().toString(QUuid::WithoutBraces)); + addressing.setDestination(m_destination); + addressing.setReplyEndpointAddress(KDSoapMessageAddressingProperties::predefinedAddressToString( + KDSoapMessageAddressingProperties::Anonymous, + KDSoapMessageAddressingProperties::Addressing200408)); + addressing.setSourceEndpointAddress(QStringLiteral("urn:uuid:") + + QUuid::createUuid().toString(QUuid::WithoutBraces)); + message.setMessageAddressingProperties(addressing); + + QString computer; + + KDSoapMessage response = client.call(QString(), message); + if (response.isFault()) { + qCDebug(KIO_SMB_LOG) << "Failed to obtain PBSD response" + << response.arguments() + << response.faultAsString(); + // No return! We'd disqualify systems that do not implement pbsd. + } else { + // The response xml would be nesting Metdata%1"); + } + + m_discovery.reset(new WSDiscovery(computer, m_endpointUrl.host())); + emit resolved(m_discovery); + } + +private: + const QUrl m_endpointUrl; + const QString m_destination; + Discovery::Ptr m_discovery; +}; + +// Utilizes WSDiscoveryClient to probe and resolve WSD services. +WSDiscoverer::WSDiscoverer() + : m_client(new WSDiscoveryClient(this)) +{ + connect(m_client, &WSDiscoveryClient::probeMatchReceived, + this, &WSDiscoverer::matchReceived); + connect(m_client, &WSDiscoveryClient::resolveMatchReceived, + this, &WSDiscoverer::resolveReceived); + + // If we haven't had a probematch in some seconds there's likely no more replies + // coming and all hosts are known. Naturally resolvers may still be running and + // get blocked on during stop(). Resolvers themselves have a timeout via + // kdsoap. + // NB: only started after first match! If we have no matches the slave will + // stop us eventually anyway. + m_probeMatchTimer.setInterval(2000); + m_probeMatchTimer.setSingleShot(true); + connect(&m_probeMatchTimer, &QTimer::timeout, this, &WSDiscoverer::stop); +} + +void WSDiscoverer::start() +{ + m_client->start(); + + // We only want devices. + // We technically would probably also want to filter pub:Computer. + // But! I am not sure if e.g. a NAS would publish itself as computer. + // https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-pbsd + KDQName type("wsdp:Device"); + type.setNameSpace("http://schemas.xmlsoap.org/ws/2006/02/devprof"); + m_client->sendProbe({ type }, {}); +} + +void WSDiscoverer::stop() +{ + m_startedTimer = true; + disconnect(&m_probeMatchTimer); + m_probeMatchTimer.stop(); + maybeFinish(); +} + +bool WSDiscoverer::isFinished() const +{ + return m_startedTimer && !m_probeMatchTimer.isActive() && m_resolvers.count() == m_resolvedCount; +} + +void WSDiscoverer::matchReceived(const QSharedPointer &matchedService) +{ + // (re)start match timer to finish-early if at all possible. + m_probeMatchTimer.start(); + m_startedTimer = true; + + if (matchedService->xAddrList().isEmpty()) { + // Has no addresses -> needs resolving still + m_client->sendResolve(matchedService->endpointReference()); + return; + } + + resolveReceived(matchedService); +} + +void WSDiscoverer::resolveReceived(const QSharedPointer &service) +{ + // (re)start match timer to finish-early if at all possible. + m_probeMatchTimer.start(); + m_startedTimer = true; + + if (m_seenEndpoints.contains(service->endpointReference())) { + return; + } + m_seenEndpoints << service->endpointReference(); + + QUrl addr; + for (const auto &xAddr : service->xAddrList()) { + // https://docs.microsoft.com/en-us/windows/win32/wsdapi/xaddr-validation-rules + // "At least one IP address included in the XAddrs (or IP address resolved from + // a hostname included in the XAddrs) must be on the same subnet as the adapter + // over which the ProbeMatches or ResolveMatches message was received." + const auto hostInfo = QHostInfo::fromName(xAddr.host()); + if (hostInfo.error() == QHostInfo::NoError) { + addr = xAddr; + break; + } + } + + if (addr.isEmpty()) { + qCWarning(KIO_SMB_LOG) << "Failed to resolve any WS transport address." + << "This suggests that DNS resolution may be broken." + << service->xAddrList(); + return; + } + + PBSDResolver *resolver = new PBSDResolver(addr, service->endpointReference()); + connect(resolver, &PBSDResolver::resolved, this, [this](Discovery::Ptr discovery) { + ++m_resolvedCount; + emit newDiscovery(discovery); + maybeFinish(); + }); + QTimer::singleShot(0, resolver, &PBSDResolver::run); + m_resolvers << resolver; +} + +void WSDiscoverer::maybeFinish() +{ + if (isFinished()) { + emit finished(); + } +} + +WSDiscovery::WSDiscovery(const QString &computer, const QString &remote) + : m_computer(computer) + , m_remote(remote) +{ +} + +KIO::UDSEntry WSDiscovery::toEntry() const +{ + KIO::UDSEntry entry; + entry.fastInsert(KIO::UDSEntry::UDS_NAME, m_computer); + + entry.fastInsert(KIO::UDSEntry::UDS_FILE_TYPE, S_IFDIR); + entry.fastInsert(KIO::UDSEntry::UDS_ACCESS, (S_IRUSR | S_IXUSR | S_IRGRP | S_IXGRP | S_IROTH | S_IXOTH)); + entry.fastInsert(KIO::UDSEntry::UDS_ICON_NAME, "network-server"); + + QUrl u; + u.setScheme(QStringLiteral("smb")); + u.setHost(m_remote); + u.setPath("/"); // https://bugs.kde.org/show_bug.cgi?id=388922 + + entry.fastInsert(KIO::UDSEntry::UDS_URL, u.url()); + entry.fastInsert(KIO::UDSEntry::UDS_MIME_TYPE, + QStringLiteral("application/x-smb-server")); + return entry; +} + +#include "wsdiscoverer.moc" diff --git a/smb/wsdiscoverer.h b/smb/wsdiscoverer.h new file mode 100644 index 00000000..408bc9b9 --- /dev/null +++ b/smb/wsdiscoverer.h @@ -0,0 +1,76 @@ +/* + Copyright 2019-2020 Harald Sitter + + This program 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 any later version accepted by the membership of + KDE e.V. (or its successor approved by the membership of KDE + e.V.), which shall act as a proxy defined in Section 14 of + version 3 of the license. + + This program 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 this program. If not, see . +*/ + +#ifndef WSDISCOVERER_H +#define WSDISCOVERER_H + +#include +#include +#include "discovery.h" + +class WSDiscoveryClient; +class WSDiscoveryTargetService; +class PBSDResolver; + +namespace KIO { +class UDSEntry; +} + +class WSDiscovery : public Discovery +{ + const QString m_computer; + const QString m_remote; + +public: + WSDiscovery(const QString &computer, const QString &remote); + + KIO::UDSEntry toEntry() const override; +}; + +class WSDiscoverer : public QObject, public Discoverer +{ + Q_OBJECT +public: + WSDiscoverer(); + + void start() override; + bool isFinished() const override; + +signals: + void newDiscovery(Discovery::Ptr discovery) override; + void finished() override; + +private slots: + void matchReceived(const QSharedPointer &matchedService); + void resolveReceived(const QSharedPointer &matchedService); + +private: + void stop() override; + void maybeFinish(); + + WSDiscoveryClient *m_client = nullptr; + bool m_startedTimer = false; + QTimer m_probeMatchTimer; + QStringList m_seenEndpoints; + QList m_resolvers; + int m_resolvedCount = 0; +}; + +#endif // WSDISCOVERER_H