martinzink commented on code in PR #1634: URL: https://github.com/apache/nifi-minifi-cpp/pull/1634#discussion_r1320103057
########## extensions/smb/ListSmb.h: ########## @@ -0,0 +1,152 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +#pragma once + +#include <memory> +#include <optional> +#include <regex> +#include <string> +#include <utility> + +#include "SmbConnectionControllerService.h" +#include "core/Processor.h" +#include "core/ProcessSession.h" +#include "core/Property.h" +#include "core/PropertyDefinition.h" +#include "core/PropertyDefinitionBuilder.h" +#include "core/OutputAttributeDefinition.h" +#include "core/logging/LoggerConfiguration.h" +#include "utils/Enum.h" +#include "utils/ListingStateManager.h" +#include "utils/file/ListedFile.h" +#include "utils/file/FileUtils.h" + +namespace org::apache::nifi::minifi::extensions::smb { + +class ListSmb : public core::Processor { + public: + explicit ListSmb(std::string name, const utils::Identifier& uuid = {}) + : core::Processor(std::move(name), uuid) { + } + + EXTENSIONAPI static constexpr const char* Description = "Retrieves a listing of files from an SMB share. For each file that is listed, " + "creates a FlowFile that represents the file so that it can be fetched in conjunction with FetchSmb."; + + EXTENSIONAPI static constexpr auto ConnectionControllerService = core::PropertyDefinitionBuilder<>::createProperty("SMB Connection Controller Service") + .withDescription("Specifies the SMB connection controller service to use for connecting to the SMB server.") + .isRequired(true) + .withAllowedTypes<SmbConnectionControllerService>() + .build(); + EXTENSIONAPI static constexpr auto InputDirectory = core::PropertyDefinitionBuilder<>::createProperty("Input Directory") + .withDescription("The input directory from which files to pull files") + .isRequired(false) + .build(); + EXTENSIONAPI static constexpr auto RecurseSubdirectories = core::PropertyDefinitionBuilder<>::createProperty("Recurse Subdirectories") + .withDescription("Indicates whether to list files from subdirectories of the directory") + .withPropertyType(core::StandardPropertyTypes::BOOLEAN_TYPE) + .withDefaultValue("true") + .isRequired(true) + .build(); + EXTENSIONAPI static constexpr auto FileFilter = core::PropertyDefinitionBuilder<>::createProperty("File Filter") + .withDescription("Only files whose names match the given regular expression will be picked up") + .build(); + EXTENSIONAPI static constexpr auto PathFilter = core::PropertyDefinitionBuilder<>::createProperty("Path Filter") + .withDescription("When Recurse Subdirectories is true, then only subdirectories whose path matches the given regular expression will be scanned") + .build(); + EXTENSIONAPI static constexpr auto MinimumFileAge = core::PropertyDefinitionBuilder<>::createProperty("Minimum File Age") + .withDescription("The minimum age that a file must be in order to be pulled; any file younger than this amount of time (according to last modification date) will be ignored") + .isRequired(true) + .withPropertyType(core::StandardPropertyTypes::TIME_PERIOD_TYPE) + .withDefaultValue("0 sec") + .build(); + EXTENSIONAPI static constexpr auto MaximumFileAge = core::PropertyDefinitionBuilder<>::createProperty("Maximum File Age") + .withDescription("The maximum age that a file must be in order to be pulled; any file older than this amount of time (according to last modification date) will be ignored") + .build(); + EXTENSIONAPI static constexpr auto MinimumFileSize = core::PropertyDefinitionBuilder<>::createProperty("Minimum File Size") + .withDescription("The minimum size that a file must be in order to be pulled") + .isRequired(true) + .withPropertyType(core::StandardPropertyTypes::DATA_SIZE_TYPE) + .withDefaultValue("0 B") + .build(); + EXTENSIONAPI static constexpr auto MaximumFileSize = core::PropertyDefinitionBuilder<>::createProperty("Maximum File Size") + .withDescription("The maximum size that a file can be in order to be pulled") + .build(); + EXTENSIONAPI static constexpr auto IgnoreHiddenFiles = core::PropertyDefinitionBuilder<>::createProperty("Ignore Hidden Files") + .withDescription("Indicates whether or not hidden files should be ignored") + .withPropertyType(core::StandardPropertyTypes::BOOLEAN_TYPE) + .withDefaultValue("true") + .isRequired(true) + .build(); + + EXTENSIONAPI static constexpr auto Properties = std::array<core::PropertyReference, 10>{ + ConnectionControllerService, + InputDirectory, + RecurseSubdirectories, + FileFilter, + PathFilter, + MinimumFileAge, + MaximumFileAge, + MinimumFileSize, + MaximumFileSize, + IgnoreHiddenFiles + }; + + EXTENSIONAPI static constexpr auto Success = core::RelationshipDefinition{"success", "All FlowFiles that are received are routed to success"}; + EXTENSIONAPI static constexpr auto Relationships = std::array{Success}; + + EXTENSIONAPI static constexpr auto Filename = core::OutputAttributeDefinition<>{"filename", { Success }, "The name of the file that was read from filesystem."}; + EXTENSIONAPI static constexpr auto Path = core::OutputAttributeDefinition<>{"path", { Success }, + "The path is set to the relative path of the file's directory on the remote filesystem compared to the Share root directory. " + "For example, for a given remote locationsmb://HOSTNAME:PORT/SHARE/DIRECTORY, and a file is being listed from smb://HOSTNAME:PORT/SHARE/DIRECTORY/sub/folder/file " Review Comment: Good catch fixed it in https://github.com/apache/nifi-minifi-cpp/pull/1634/commits/3b513dcd2120d5e5ab361e8230060721450c6551#diff-757bec9ee5fa8c5898f294c1acee9d73a9092f19e072ef248646342bb39d5810R114 ########## extensions/smb/ListSmb.h: ########## @@ -0,0 +1,152 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +#pragma once + +#include <memory> +#include <optional> +#include <regex> +#include <string> +#include <utility> + +#include "SmbConnectionControllerService.h" +#include "core/Processor.h" +#include "core/ProcessSession.h" +#include "core/Property.h" +#include "core/PropertyDefinition.h" +#include "core/PropertyDefinitionBuilder.h" +#include "core/OutputAttributeDefinition.h" +#include "core/logging/LoggerConfiguration.h" +#include "utils/Enum.h" +#include "utils/ListingStateManager.h" +#include "utils/file/ListedFile.h" +#include "utils/file/FileUtils.h" + +namespace org::apache::nifi::minifi::extensions::smb { + +class ListSmb : public core::Processor { + public: + explicit ListSmb(std::string name, const utils::Identifier& uuid = {}) + : core::Processor(std::move(name), uuid) { + } + + EXTENSIONAPI static constexpr const char* Description = "Retrieves a listing of files from an SMB share. For each file that is listed, " + "creates a FlowFile that represents the file so that it can be fetched in conjunction with FetchSmb."; + + EXTENSIONAPI static constexpr auto ConnectionControllerService = core::PropertyDefinitionBuilder<>::createProperty("SMB Connection Controller Service") + .withDescription("Specifies the SMB connection controller service to use for connecting to the SMB server.") + .isRequired(true) + .withAllowedTypes<SmbConnectionControllerService>() + .build(); + EXTENSIONAPI static constexpr auto InputDirectory = core::PropertyDefinitionBuilder<>::createProperty("Input Directory") + .withDescription("The input directory from which files to pull files") + .isRequired(false) + .build(); + EXTENSIONAPI static constexpr auto RecurseSubdirectories = core::PropertyDefinitionBuilder<>::createProperty("Recurse Subdirectories") + .withDescription("Indicates whether to list files from subdirectories of the directory") + .withPropertyType(core::StandardPropertyTypes::BOOLEAN_TYPE) + .withDefaultValue("true") + .isRequired(true) + .build(); + EXTENSIONAPI static constexpr auto FileFilter = core::PropertyDefinitionBuilder<>::createProperty("File Filter") + .withDescription("Only files whose names match the given regular expression will be picked up") + .build(); + EXTENSIONAPI static constexpr auto PathFilter = core::PropertyDefinitionBuilder<>::createProperty("Path Filter") + .withDescription("When Recurse Subdirectories is true, then only subdirectories whose path matches the given regular expression will be scanned") + .build(); + EXTENSIONAPI static constexpr auto MinimumFileAge = core::PropertyDefinitionBuilder<>::createProperty("Minimum File Age") + .withDescription("The minimum age that a file must be in order to be pulled; any file younger than this amount of time (according to last modification date) will be ignored") + .isRequired(true) + .withPropertyType(core::StandardPropertyTypes::TIME_PERIOD_TYPE) + .withDefaultValue("0 sec") + .build(); + EXTENSIONAPI static constexpr auto MaximumFileAge = core::PropertyDefinitionBuilder<>::createProperty("Maximum File Age") + .withDescription("The maximum age that a file must be in order to be pulled; any file older than this amount of time (according to last modification date) will be ignored") + .build(); + EXTENSIONAPI static constexpr auto MinimumFileSize = core::PropertyDefinitionBuilder<>::createProperty("Minimum File Size") + .withDescription("The minimum size that a file must be in order to be pulled") + .isRequired(true) + .withPropertyType(core::StandardPropertyTypes::DATA_SIZE_TYPE) + .withDefaultValue("0 B") + .build(); + EXTENSIONAPI static constexpr auto MaximumFileSize = core::PropertyDefinitionBuilder<>::createProperty("Maximum File Size") + .withDescription("The maximum size that a file can be in order to be pulled") + .build(); + EXTENSIONAPI static constexpr auto IgnoreHiddenFiles = core::PropertyDefinitionBuilder<>::createProperty("Ignore Hidden Files") + .withDescription("Indicates whether or not hidden files should be ignored") + .withPropertyType(core::StandardPropertyTypes::BOOLEAN_TYPE) + .withDefaultValue("true") + .isRequired(true) + .build(); + + EXTENSIONAPI static constexpr auto Properties = std::array<core::PropertyReference, 10>{ + ConnectionControllerService, + InputDirectory, + RecurseSubdirectories, + FileFilter, + PathFilter, + MinimumFileAge, + MaximumFileAge, + MinimumFileSize, + MaximumFileSize, + IgnoreHiddenFiles + }; + + EXTENSIONAPI static constexpr auto Success = core::RelationshipDefinition{"success", "All FlowFiles that are received are routed to success"}; + EXTENSIONAPI static constexpr auto Relationships = std::array{Success}; + + EXTENSIONAPI static constexpr auto Filename = core::OutputAttributeDefinition<>{"filename", { Success }, "The name of the file that was read from filesystem."}; + EXTENSIONAPI static constexpr auto Path = core::OutputAttributeDefinition<>{"path", { Success }, + "The path is set to the relative path of the file's directory on the remote filesystem compared to the Share root directory. " + "For example, for a given remote locationsmb://HOSTNAME:PORT/SHARE/DIRECTORY, and a file is being listed from smb://HOSTNAME:PORT/SHARE/DIRECTORY/sub/folder/file " + "then the path attribute will be set to \"DIRECTORY/sub/folder\"."}; Review Comment: Yeah should be. Thanks I've fixed it in https://github.com/apache/nifi-minifi-cpp/pull/1634/commits/3b513dcd2120d5e5ab361e8230060721450c6551#diff-757bec9ee5fa8c5898f294c1acee9d73a9092f19e072ef248646342bb39d5810R114 -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
