summaryrefslogtreecommitdiff
path: root/src/components/application_manager/rpc_plugins/vehicle_info_plugin/src/vehicle_info_app_extension.cc
blob: dd6d797e39dd7bd72e8c8175fb0c87cacf15e20d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
/*
 Copyright (c) 2018, Ford Motor Company
 All rights reserved.

 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:

 Redistributions of source code must retain the above copyright notice, this
 list of conditions and the following disclaimer.

 Redistributions in binary form must reproduce the above copyright notice,
 this list of conditions and the following
 disclaimer in the documentation and/or other materials provided with the
 distribution.

 Neither the name of the Ford Motor Company nor the names of its contributors
 may be used to endorse or promote products derived from this software
 without specific prior written permission.

 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 POSSIBILITY OF SUCH DAMAGE.
 */

#include "vehicle_info_plugin/vehicle_info_app_extension.h"
#include "vehicle_info_plugin/vehicle_info_plugin.h"

SDL_CREATE_LOG_VARIABLE("VehicleInfoPlugin")

namespace vehicle_info_plugin {
namespace strings = application_manager::strings;

unsigned VehicleInfoAppExtension::VehicleInfoAppExtensionUID = 146;

VehicleInfoAppExtension::VehicleInfoAppExtension(
    VehicleInfoPlugin& plugin, application_manager::Application& app)
    : app_mngr::AppExtension(
          VehicleInfoAppExtension::VehicleInfoAppExtensionUID)
    , subscribed_data_lock_(std::make_shared<sync_primitives::Lock>())
    , pending_subscriptions_lock_(std::make_shared<sync_primitives::Lock>())
    , plugin_(plugin)
    , app_(app) {
  SDL_LOG_AUTO_TRACE();
}

VehicleInfoAppExtension::~VehicleInfoAppExtension() {
  SDL_LOG_AUTO_TRACE();
}

bool VehicleInfoAppExtension::subscribeToVehicleInfo(
    const std::string& vehicle_data) {
  SDL_LOG_DEBUG(vehicle_data);
  sync_primitives::AutoLock lock(*subscribed_data_lock_);
  return subscribed_data_.insert(vehicle_data).second;
}

bool VehicleInfoAppExtension::unsubscribeFromVehicleInfo(
    const std::string& vehicle_data) {
  SDL_LOG_DEBUG(vehicle_data);
  sync_primitives::AutoLock lock(*subscribed_data_lock_);
  auto it = subscribed_data_.find(vehicle_data);
  if (it != subscribed_data_.end()) {
    subscribed_data_.erase(it);
    return true;
  }
  return false;
}

void VehicleInfoAppExtension::unsubscribeFromVehicleInfo() {
  SDL_LOG_AUTO_TRACE();
  sync_primitives::AutoLock lock(*subscribed_data_lock_);
  subscribed_data_.clear();
}

bool VehicleInfoAppExtension::isSubscribedToVehicleInfo(
    const std::string& vehicle_data) const {
  SDL_LOG_DEBUG(vehicle_data);
  sync_primitives::AutoLock lock(*subscribed_data_lock_);
  return subscribed_data_.find(vehicle_data) != subscribed_data_.end();
}

bool VehicleInfoAppExtension::isPendingSubscriptionToVehicleInfo(
    const std::string& vehicle_data) const {
  SDL_LOG_DEBUG(vehicle_data);
  sync_primitives::AutoLock lock(*pending_subscriptions_lock_);
  return pending_subscriptions_.find(vehicle_data) !=
         pending_subscriptions_.end();
}

const DataAccessor<VehicleInfoSubscriptions>
VehicleInfoAppExtension::Subscriptions() {
  DataAccessor<VehicleInfoSubscriptions> data_accessor(subscribed_data_,
                                                       subscribed_data_lock_);
  return data_accessor;
}

bool VehicleInfoAppExtension::AddPendingSubscription(
    const std::string& vehicle_data) {
  sync_primitives::AutoLock lock(*pending_subscriptions_lock_);
  return pending_subscriptions_.insert(vehicle_data).second;
}

bool VehicleInfoAppExtension::RemovePendingSubscription(
    const std::string& vehicle_data) {
  SDL_LOG_DEBUG(vehicle_data);
  sync_primitives::AutoLock lock(*pending_subscriptions_lock_);
  auto it = pending_subscriptions_.find(vehicle_data);
  if (it != pending_subscriptions_.end()) {
    pending_subscriptions_.erase(it);
    return true;
  }
  return false;
}

void VehicleInfoAppExtension::RemovePendingSubscriptions() {
  sync_primitives::AutoLock lock(*pending_subscriptions_lock_);
  pending_subscriptions_.clear();
}

const DataAccessor<VehicleInfoSubscriptions>
VehicleInfoAppExtension::PendingSubscriptions() {
  return DataAccessor<VehicleInfoSubscriptions>(pending_subscriptions_,
                                                pending_subscriptions_lock_);
}

void VehicleInfoAppExtension::SaveResumptionData(
    smart_objects::SmartObject& resumption_data) {
  resumption_data[strings::application_vehicle_info] =
      smart_objects::SmartObject(smart_objects::SmartType_Array);
  int i = 0;
  sync_primitives::AutoLock lock(*subscribed_data_lock_);
  for (const auto& subscription : subscribed_data_) {
    resumption_data[strings::application_vehicle_info][i++] = subscription;
  }
}

void VehicleInfoAppExtension::ProcessResumption(
    const smart_objects::SmartObject& saved_app) {
  SDL_LOG_AUTO_TRACE();

  if (!saved_app.keyExists(strings::application_subscriptions)) {
    SDL_LOG_DEBUG("application_subscriptions section is not exists");
    return;
  }

  const smart_objects::SmartObject& resumption_data =
      saved_app[strings::application_subscriptions];

  if (!resumption_data.keyExists(strings::application_vehicle_info)) {
    SDL_LOG_DEBUG("application_vehicle_info section is not exists");
    return;
  }

  const auto subscriptions_ivi =
      resumption_data[strings::application_vehicle_info].asArray();
  for (const auto& ivi : *subscriptions_ivi) {
    AddPendingSubscription(ivi.asString());
  }
  if (!subscriptions_ivi->empty()) {
    plugin_.ProcessResumptionSubscription(app_, *this);
  }
}

void VehicleInfoAppExtension::RevertResumption(
    const smart_objects::SmartObject& resumption_data) {
  SDL_LOG_AUTO_TRACE();

  unsubscribeFromVehicleInfo();

  if (!resumption_data.keyExists(
          application_manager::hmi_interface::vehicle_info)) {
    SDL_LOG_DEBUG("No resumption vahicle data subscription to revert");
    return;
  }
  const auto& resumption_vd_data =
      resumption_data[application_manager::hmi_interface::vehicle_info];

  std::set<std::string> ivi_subscriptions_to_revert;
  const auto ivi_subscriptions_keys = resumption_vd_data.enumerate();
  for (const auto& key : ivi_subscriptions_keys) {
    // Only boolean keys in subscriptions list are true vehicle data
    // subscriptions
    if (smart_objects::SmartType::SmartType_Boolean ==
        resumption_vd_data.getElement(key).getType()) {
      ivi_subscriptions_to_revert.insert(key);
    }
  }

  plugin_.RevertResumption(app_, ivi_subscriptions_to_revert);
}

VehicleInfoAppExtension& VehicleInfoAppExtension::ExtractVIExtension(
    application_manager::Application& app) {
  auto ext_ptr =
      app.QueryInterface(VehicleInfoAppExtension::VehicleInfoAppExtensionUID);
  DCHECK(ext_ptr);
  DCHECK(dynamic_cast<VehicleInfoAppExtension*>(ext_ptr.get()));
  auto vi_app_extension =
      std::static_pointer_cast<VehicleInfoAppExtension>(ext_ptr);
  DCHECK(vi_app_extension);
  return *vi_app_extension;
}
}  // namespace vehicle_info_plugin