[seiscomp, scanloc] Install, add .gitignore

include/seiscomp/plugins/dataavailabilty/collector/sds.h

@@ -0,0 +1,157 @@
+/***************************************************************************
+ * Copyright (C) 2020 by gempa GmbH                                        *
+ * All rights reserved.                                                    *
+ *                                                                         *
+ * GNU Affero General Public License Usage                                 *
+ * This file may be used under the terms of the GNU Affero                 *
+ * Public License version 3.0 as published by the Free Software Foundation *
+ * and appearing in the file LICENSE included in the packaging of this     *
+ * file. Please review the following information to ensure the GNU Affero  *
+ * Public License version 3.0 requirements will be met:                    *
+ * https://www.gnu.org/licenses/agpl-3.0.html.                             *
+ ***************************************************************************/
+
+#ifndef SEISCOMP_DATAAVAILABILITY_COLLECTOR_SDS_H
+#define SEISCOMP_DATAAVAILABILITY_COLLECTOR_SDS_H
+
+#include <seiscomp/plugins/dataavailability/collector.h>
+
+#include <seiscomp/core/defs.h>
+#include <seiscomp/core/record.h>
+#include <seiscomp/core/datetime.h>
+
+#include <seiscomp/datamodel/dataextent.h>
+#include <seiscomp/datamodel/datasegment.h>
+#include <seiscomp/datamodel/waveformstreamid.h>
+
+#include <seiscomp/io/recordinput.h>
+#include <seiscomp/io/recordstream/file.h>
+
+#include <boost/filesystem/path.hpp>
+
+#include <vector>
+
+
+namespace Seiscomp {
+namespace DataAvailability {
+
+
+DEFINE_SMARTPOINTER(SDSCollector);
+
+
+class SDSCollector : public Collector {
+
+	public:
+		class RecordIterator : public Collector::RecordIterator {
+			public:
+				/**
+				 * @brief RecordIterator
+				 * @param file The absolute file path
+				 * @param wid StreamID the file is expected to contain data for
+				 */
+				RecordIterator(std::string file,
+				               const DataModel::WaveformStreamID &wid);
+
+			public:
+				~RecordIterator() override = default;
+
+				bool valid() const override;
+				bool next() override;
+				const Core::Time& startTime() const override;
+				const Core::Time& endTime() const override;
+				double sampleRate() const override;
+				const std::string& quality() const override;
+
+			protected:
+				std::string         _file;
+				std::string         _sid;
+				RecordStream::File  _stream;
+				IO::RecordInput     _input;
+
+				RecordPtr           _rec;
+				Core::Time          _endTime;
+				std::string         _quality;
+		};
+
+
+	public:
+		SDSCollector() = default;
+		~SDSCollector() override = default;
+
+		bool setSource(const char *source) override;
+		void setStartTime(Core::Time startTime) override;
+		void setEndTime(Core::Time endTime) override;
+
+		void reset() override;
+		void collectWaveformIDs(WaveformIDs &wids) override;
+		void collectChunks(DataChunks &chunks,
+		                   const DataModel::WaveformStreamID &wid) override;
+		bool chunkTimeWindow(Core::TimeWindow &window,
+		                     const std::string &chunk) override;
+		Core::Time chunkMTime(const std::string &chunk) override;
+		Collector::RecordIterator* begin(
+		        const std::string &chunk,
+		        const DataModel::WaveformStreamID &wid) override;
+		bool threadSafe() const override;
+
+	protected:
+		struct IDDate {
+			std::string streamID;
+			int year{0};
+			int doy{0}; // 0 = 1st of January
+		};
+
+		/**
+		 * @brief Scan an archive recursively for available WaveformIDs.
+		 * @param wids The collected waveform IDs.
+		 * @param dir Current directory path.
+		 * @param depth Remaining directory depth. If 0 the current directory
+		 * is scanned for files.
+		 */
+		virtual void scanDirectory(WaveformIDs &wids,
+		                           const boost::filesystem::path &dir,
+		                           uint16_t depth = 3);
+
+		/**
+		 * @brief Scan a directory for available WaveformIDs.
+		 * @param wids The collected waveform IDs.
+		 * @param dir The directory path in which to search files.
+		 */
+		virtual void scanFiles(WaveformIDs &wids,
+		                       const boost::filesystem::path &dir);
+
+		/**
+		 * @brief Return the stream ID and date for a given file name.
+		 * @param filename The file name to extract the stream ID from.
+		 * @return An IDDate object holding the stream ID and file date or an
+		 * default contructed IDDate with an empty streamID.
+		 */
+		virtual IDDate fileStreamID(const std::string &filename);
+
+		/**
+		 * @brief Check if a specific date is covered by the startTime and
+		 * endTime boundaries.
+		 * @param year The year of the date.
+		 * @param doy The day of the year as days since January 1st.
+		 * @return true If the specified date is within the timewindow
+		 * boundaries (if any) else false.
+		 */
+		virtual bool checkTimeWindow(int year, int doy);
+
+	protected:
+		using ArchiveYearItem = std::pair<int, boost::filesystem::path>;
+		using ArchiveYears = std::vector<ArchiveYearItem>;
+
+		boost::filesystem::path _basePath;
+		ArchiveYears            _archiveYears;
+
+		OPT(int)                _startYear;
+		OPT(int)                _startDOY;              // 0 = 1st of January
+		OPT(int)                _endYear;
+		OPT(int)                _endDOY;                // 0 = 1st of January
+};
+
+} // ns DataAvailability
+} // ns Seiscomp
+
+#endif // SEISCOMP_DATAAVAILABILITY_COLLECTOR_SDS_H