Feature: User Service Announcement Channel

.gitignore

@@ -35,6 +35,9 @@
 .*.swp
 *.bak
 
+# meson temporary files
+subprojects/.wraplock
+
 # common build directories
 build
 install

ATTRIBUTION_NOTICE

@@ -1,4 +1,4 @@
-5G-MAG RT MBS Function uses the following open source software:
+5G-MAG Reference Tools MBS Function uses the following open source software:
 
 - open5gs - Opensource 5G Core implementation
   available from https://open5gs.org/

meson.build

@@ -10,7 +10,7 @@
 # Meson module fs and its functions like fs.hash_file require atleast meson 0.59.0 
 
 project('rt-mbs-function', 'c', 'cpp', 
-    version : '0.2.0',
+    version : '1.0.0',
     license : '5G-MAG Public',
     meson_version : '>= 1.4.0',
     default_options : [
@@ -33,8 +33,8 @@ int main(int argc, char *argv[])
 endif
 
 open5gs_project=subproject('open5gs', required: true)
-svc_consumers_project=subproject('rt-5gc-service-consumers',required:true)
-
+common_shared_project=subproject('rt-common-shared', required: true)
+svc_consumers_project=subproject('rt-5gc-service-consumers', required: true)
 
 #subdir('lib')
 subdir('src')

src/mbsf/ActivePeriods.cc

@@ -165,6 +165,14 @@ std::optional<std::list<std::shared_ptr<ServiceScheduleDesc> > > ActivePeriods::
     return ret_val;
 }
 
+ActivePeriods::TimeRange ActivePeriods::activeTimeRange() const
+{
+    if (m_actPeriodsTP.empty()) return TimeRange(std::nullopt, std::nullopt);
+    return TimeRange(m_actPeriodsTP.front().start, m_actPeriodsTP.back().end);
+}
+
+// private:
+
 void ActivePeriods::convertActPeriods(const ActPeriodsType& act_periods,
                                       const std::shared_ptr<ActivePeriodsBase> &old_active_periods,
                                       UserDataIngSession &user_data_ing_session)

src/mbsf/ActivePeriods.hh

@@ -59,6 +59,7 @@ public:
     };
     using ActPeriodsType = reftools::mbsf::MBSUserDataIngSession::ActPeriodsType;
     using MbsDistSessStateType = reftools::mbsf::MBSDistributionSessionInfo::MbsDistSessStateType;
+    using TimeRange = ActivePeriodsBase::TimeRange;
 
     ActivePeriods(const ActPeriodsType &act_periods, const std::shared_ptr<ActivePeriodsBase> &old_active_periods, UserDataIngSession &user_data_ing_session);
     ActivePeriods(ActPeriodsType &&act_periods, const std::shared_ptr<ActivePeriodsBase> &old_active_periods, UserDataIngSession &user_data_ing_session);
@@ -68,6 +69,7 @@ public:
     virtual const DistSessionState &currentState(const MbsDistSessStateType &dist_session_state) const;
     virtual TimestampAndActiveFlag nextTransition() const;
     virtual std::optional<std::list<std::shared_ptr<ServiceScheduleDesc> > > serviceScheduleDescriptions() const;
+    virtual TimeRange activeTimeRange() const;
 
 private:
     void convertActPeriods(const ActPeriodsType& act_periods, const std::shared_ptr<ActivePeriodsBase> &old_active_periods,

src/mbsf/ActivePeriodsBase.hh

@@ -25,6 +25,8 @@
 #include "ogs-sbi.h"
 
 #include <chrono>
+#include <optional>
+#include <utility>
 
 #include "openapi/model/DistSessionState.h"
 #include "openapi/model/MBSDistributionSessionInfo.h"
@@ -43,13 +45,15 @@ public:
     using TimestampAndActiveFlag = std::pair<std::optional<SysTimeMS>, DistSessionState >;
     using ActPeriodsType = reftools::mbsf::MBSUserDataIngSession::ActPeriodsType;
     using MbsDistSessStateType = reftools::mbsf::MBSDistributionSessionInfo::MbsDistSessStateType;
+    using TimeRange = std::pair<std::optional<SysTimeMS>, std::optional<SysTimeMS>>;
 
     ActivePeriodsBase(const std::string &user_data_ing_sess_id) : m_id(user_data_ing_sess_id) {};
 
     virtual ~ActivePeriodsBase() = default;
     virtual const DistSessionState &currentState(const MbsDistSessStateType &dist_session_state) const = 0;
     virtual TimestampAndActiveFlag nextTransition() const = 0;
     virtual std::optional<std::list<std::shared_ptr<ServiceScheduleDesc> > > serviceScheduleDescriptions() const = 0;
+    virtual TimeRange activeTimeRange() const = 0;
 
 protected:
     std::string m_id;

src/mbsf/ActivePeriodsRepRule.cc

@@ -26,6 +26,7 @@
 #include <list>
 #include <memory>
 #include <optional>
+#include <iomanip>
 #include <iostream>
 
 #include "common.hh"
@@ -175,6 +176,12 @@ TimestampAndActiveFlag ActivePeriodsRepRule::nextTransition () const
     return {std::nullopt, dist_session_state_inactive};
 }
 
+ActivePeriodsRepRule::TimeRange ActivePeriodsRepRule::activeTimeRange() const
+{
+    if (!m_repetitionRule) return TimeRange(std::nullopt, std::nullopt);
+    return TimeRange(parse_date_time(m_repetitionRule->second->getStartTime()), std::nullopt);
+}
+
 std::optional<std::list<std::shared_ptr<ServiceScheduleDesc> > > ActivePeriodsRepRule::serviceScheduleDescriptions() const
 {
     if (!m_repetitionRule) return std::nullopt;
@@ -207,14 +214,12 @@ static std::optional<std::chrono::system_clock::time_point> parse_date_time(cons
     std::istringstream ss(main_time);
     ss >> std::get_time(&tm, "%Y-%m-%dT%H:%M:%S");
     if (ss.fail()) {
-        ogs_info("PARSE TIME SS FAIL");
         return std::nullopt;
     }
 
     std::time_t time = std::mktime(&tm);
     if (time == -1) {
 
-        ogs_info("PARSE TIME MKTIME RETURNS -1");
         return std::nullopt;
     }
 

src/mbsf/ActivePeriodsRepRule.hh

@@ -57,13 +57,15 @@ public:
     using MbsDistSessStateType = reftools::mbsf::MBSDistributionSessionInfo::MbsDistSessStateType;
     using RepetitionRule = reftools::mbsf::RepetitionRule;
     using VersionedRepetitionRule = std::pair<int32_t, std::shared_ptr<RepetitionRule> >;
+    using TimeRange = ActivePeriodsBase::TimeRange;
 
     ActivePeriodsRepRule(const ActPeriodsRepRuleType &act_periods_rep_rule, const std::shared_ptr<ActivePeriodsBase> &old_active_periods, UserDataIngSession &user_data_ingest_session);
 
     virtual ~ActivePeriodsRepRule() {};
     virtual const DistSessionState &currentState(const MbsDistSessStateType &dist_session_state) const;
     virtual TimestampAndActiveFlag nextTransition() const;
     virtual std::optional<std::list<std::shared_ptr<ServiceScheduleDesc> > > serviceScheduleDescriptions() const;
+    virtual TimeRange activeTimeRange() const;
 
 private:
     std::shared_ptr<VersionedRepetitionRule> m_repetitionRule;

src/mbsf/AlwaysActive.hh

@@ -52,6 +52,7 @@ public:
     using DistSessionState = ActivePeriodsBase::DistSessionState;
     using ActPeriodsType = reftools::mbsf::MBSUserDataIngSession::ActPeriodsType;
     using MbsDistSessStateType = reftools::mbsf::MBSDistributionSessionInfo::MbsDistSessStateType;
+    using TimeRange = ActivePeriodsBase::TimeRange;
 
     AlwaysActive()  = delete;
     AlwaysActive(const std::string &user_data_ing_sess_id) : ActivePeriodsBase(user_data_ing_sess_id) {};
@@ -60,6 +61,7 @@ public:
     virtual const DistSessionState &currentState(const MbsDistSessStateType &dist_session_state) const;
     virtual TimestampAndActiveFlag nextTransition() const;
     virtual std::optional<std::list<std::shared_ptr<ServiceScheduleDesc> > > serviceScheduleDescriptions() const;
+    virtual TimeRange activeTimeRange() const { return TimeRange{std::nullopt, std::nullopt}; };
 };
 
 MBSF_NAMESPACE_STOP

src/mbsf/AnnouncementBundleIndexHandler.cc

@@ -0,0 +1,81 @@
+/******************************************************************************
+ * 5G-MAG Reference Tools: MBS Function: AnnouncementBundleIndexHandler class
+ ******************************************************************************
+ * Copyright: (C)2026 British Broadcasting Corporation
+ * Author(s): David Waring <david.waring2@bbc.co.uk>
+ * License: 5G-MAG Public License v1
+ *
+ * Licensed under the License terms and conditions for use, reproduction, and
+ * distribution of 5G-MAG software (the “License”).  You may not use this file
+ * except in compliance with the License.  You may obtain a copy of the License at
+ * https://www.5g-mag.com/reference-tools.  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.
+ */
+
+#include <dirent.h>
+
+#include <filesystem>
+#include <list>
+#include <string>
+#include <vector>
+
+#include "ogs-core.h"
+#include "ogs-sbi.h"
+
+#include "common.hh"
+#include <DocrootHTTPRequestHandler.hh>
+#include <HTTPResponse.hh>
+#include <HTTPServer.hh>
+#include "MultipartMime.hh"
+#include "UserDataIngSession.hh"
+
+#include "AnnouncementBundleIndexHandler.hh"
+
+HTTPXPP_NAMESPACE_USING(DocrootHTTPRequestHandler);
+HTTPXPP_NAMESPACE_USING(HTTPResponse);
+HTTPXPP_NAMESPACE_USING(HTTPServer);
+
+MBSF_NAMESPACE_START
+
+HTTPResponse AnnouncementBundleIndexHandler::makeResponseForDir(const std::string &dir_path, const std::string &url_path, const HTTPServer &server)
+{
+    if (url_path == "/" || url_path.starts_with("/.")) {
+        return server.makeResponse().statusCode(403);
+    }
+
+    std::filesystem::path dp(dir_path);
+    if (!dp.has_filename()) dp = dp.parent_path();
+    auto user_data_ing_sess_id = dp.filename().string();
+
+    MultipartMime bundle(MultipartMime::RELATED);
+
+    try {
+        auto user_dat_ing_session = UserDataIngSession::find(user_data_ing_sess_id);
+        auto &filenames = user_dat_ing_session->getUserServiceAnnBundleFilesList();
+        if (filenames.empty()) {
+            return server.makeResponse().statusCode(404);
+        }
+        for (const auto &filename : filenames) {
+            bundle.addFile(dp, filename);
+        }
+    } catch (std::out_of_range &ex) {
+        return server.makeResponse().statusCode(404);
+    }
+
+    HTTPResponse resp = server.makeResponse(bundle.body());
+    for (const auto &hdr : bundle.headers()) {
+        resp.addHeader(hdr.first, hdr.second);
+    }
+
+    return resp;
+}
+
+MBSF_NAMESPACE_STOP
+
+/* vim:ts=8:sts=4:sw=4:expandtab:
+ */

src/mbsf/AnnouncementBundleIndexHandler.hh

@@ -0,0 +1,53 @@
+#ifndef _MBSF_ANNOUNCEMENT_BUNDLE_INDEX_HANDLER_HH_
+#define _MBSF_ANNOUNCEMENT_BUNDLE_INDEX_HANDLER_HH_
+/******************************************************************************
+ * 5G-MAG Reference Tools: MBS Function: AnnouncementBundleIndexHandler class
+ ******************************************************************************
+ * Copyright: (C)2026 British Broadcasting Corporation
+ * Author(s): David Waring <david.waring2@bbc.co.uk>
+ * License: 5G-MAG Public License v1
+ *
+ * Licensed under the License terms and conditions for use, reproduction, and
+ * distribution of 5G-MAG software (the “License”).  You may not use this file
+ * except in compliance with the License.  You may obtain a copy of the License at
+ * https://www.5g-mag.com/reference-tools.  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.
+ */
+
+#include <string>
+#include <vector>
+
+#include "common.hh"
+#include <DocrootHTTPRequestHandler.hh>
+
+HTTPXPP_NAMESPACE_START
+class HTTPResponse;
+class HTTPServer;
+HTTPXPP_NAMESPACE_STOP
+
+MBSF_NAMESPACE_START
+
+class AnnouncementBundleIndexHandler : public HTTPXPP_NAMESPACE_NAME(DocrootHTTPRequestHandler::IndexHandler) {
+public:
+    AnnouncementBundleIndexHandler() :HTTPXPP_NAMESPACE_NAME(DocrootHTTPRequestHandler::IndexHandler)() {};
+    AnnouncementBundleIndexHandler(const AnnouncementBundleIndexHandler &other) = delete;
+    AnnouncementBundleIndexHandler(AnnouncementBundleIndexHandler &&other) = delete;
+
+    virtual ~AnnouncementBundleIndexHandler() {};
+
+    AnnouncementBundleIndexHandler &operator=(const AnnouncementBundleIndexHandler &other) = delete;
+    AnnouncementBundleIndexHandler &operator=(AnnouncementBundleIndexHandler &&other) = delete;
+
+    virtual HTTPXPP_NAMESPACE_NAME(HTTPResponse) makeResponseForDir(const std::string &dir_path, const std::string &url_path, const HTTPXPP_NAMESPACE_NAME(HTTPServer) &server);
+};
+
+MBSF_NAMESPACE_STOP
+
+/* vim:ts=8:sts=4:sw=4:expandtab:
+ */
+#endif /* _MBSF_ANNOUNCEMENT_BUNDLE_INDEX_HANDLER_HH_ */

src/mbsf/CarouselObject.cc

@@ -0,0 +1,83 @@
+/******************************************************************************
+ * 5G-MAG Reference Tools: MBS Function: MBS Carousel Object class
+ ******************************************************************************
+ * Copyright: (C)2026 British Broadcasting Corporation
+ * Author(s): Dev Audsin <dev.audsin@bbc.co.uk>
+ * License: 5G-MAG Public License v1
+ *
+ * Licensed under the License terms and conditions for use, reproduction, and
+ * distribution of 5G-MAG software (the “License”).  You may not use this file
+ * except in compliance with the License.  You may obtain a copy of the License at
+ * https://www.5g-mag.com/reference-tools.  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.
+ */
+
+// Open5GS includes
+#include "ogs-app.h"
+#include "ogs-sbi.h"
+
+// standard template library includes
+#include <memory>
+#include <stdexcept>
+#include <stdio.h>
+#include <string>
+#include <stdlib.h>
+#include <cstdint>
+#include <iostream>
+
+// App header includes
+#include "common.hh"
+#include "App.hh"
+#include "Context.hh"
+
+#include "openapi/model/Object.h"
+
+// Header include for this class
+#include "CarouselObject.hh"
+
+using fiveg_mag_reftools::CJson;
+using fiveg_mag_reftools::ModelException;
+using reftools::mbsf::Object;
+
+MBSF_NAMESPACE_START
+
+CarouselObject::CarouselObject(CJson &json, bool as_request)
+    :m_object(new Object(json, as_request))
+{
+}
+
+CarouselObject::CarouselObject(const std::shared_ptr<reftools::mbsf::Object> &object)
+    :m_object(object)
+{
+}
+
+CarouselObject::CarouselObject(const std::string &locator, std::optional<int32_t > repetition_interval,
+                    std::optional<int32_t > keep_updated_interval, std::optional<std::string > earliest_fetch_time)
+{
+    m_object.reset(new Object());
+    m_object->setLocator(locator);
+    m_object->setRepetitionInterval(repetition_interval);
+    m_object->setKeepUpdatedInterval(keep_updated_interval);
+    m_object->setEarliestFetchTime(earliest_fetch_time);
+}
+
+
+CarouselObject::~CarouselObject()
+{
+}
+
+CJson CarouselObject::json(bool as_request = false) const
+{
+    return m_object->toJSON(as_request);
+}
+
+MBSF_NAMESPACE_STOP
+
+/* vim:ts=8:sts=4:sw=4:expandtab:
+ */
+