diff options
author | magnus <mfeuer@jaguarlandrover.com> | 2014-10-05 16:05:36 -0700 |
---|---|---|
committer | magnus <mfeuer@jaguarlandrover.com> | 2014-10-05 16:05:36 -0700 |
commit | 3551afc90057f93bcacb944eda2a712acdba3141 (patch) | |
tree | b2e26a679061a10367a1972d29be6a381510c7e2 | |
parent | 709d6b2096a1328025d5de9baf00e95f225b9093 (diff) | |
parent | 3ccb792cdc374fa6056335a800724facc1884e8f (diff) | |
download | rvi_core-3551afc90057f93bcacb944eda2a712acdba3141.tar.gz |
Add 'components/service_edge/' from commit '3ccb792cdc374fa6056335a800724facc1884e8f'
git-subtree-dir: components/service_edge
git-subtree-mainline: 709d6b2096a1328025d5de9baf00e95f225b9093
git-subtree-split: 3ccb792cdc374fa6056335a800724facc1884e8f
-rw-r--r-- | components/service_edge/.gitignore | 1 | ||||
-rw-r--r-- | components/service_edge/LICENSE | 354 | ||||
-rw-r--r-- | components/service_edge/Makefile | 40 | ||||
-rw-r--r-- | components/service_edge/README.md | 1 | ||||
-rw-r--r-- | components/service_edge/curl_scripts/register_service.sh | 31 | ||||
-rwxr-xr-x | components/service_edge/find_setup_gen.sh | 17 | ||||
-rw-r--r-- | components/service_edge/priv/setup.config | 57 | ||||
-rw-r--r-- | components/service_edge/rebar.config | 11 | ||||
-rw-r--r-- | components/service_edge/src/service_edge.app.src | 24 | ||||
-rw-r--r-- | components/service_edge/src/service_edge_app.erl | 31 | ||||
-rw-r--r-- | components/service_edge/src/service_edge_rpc.erl | 333 | ||||
-rw-r--r-- | components/service_edge/src/service_edge_sup.erl | 40 |
12 files changed, 940 insertions, 0 deletions
diff --git a/components/service_edge/.gitignore b/components/service_edge/.gitignore new file mode 100644 index 0000000..cfb2329 --- /dev/null +++ b/components/service_edge/.gitignore @@ -0,0 +1 @@ +ebin diff --git a/components/service_edge/LICENSE b/components/service_edge/LICENSE new file mode 100644 index 0000000..c33dcc7 --- /dev/null +++ b/components/service_edge/LICENSE @@ -0,0 +1,354 @@ +Mozilla Public License, version 2.0 + +1. Definitions + +1.1. “Contributor” + + means each individual or legal entity that creates, contributes to the + creation of, or owns Covered Software. + +1.2. “Contributor Version” + + means the combination of the Contributions of others (if any) used by a + Contributor and that particular Contributor’s Contribution. + +1.3. “Contribution” + + means Covered Software of a particular Contributor. + +1.4. “Covered Software” + + means Source Code Form to which the initial Contributor has attached the + notice in Exhibit A, the Executable Form of such Source Code Form, and + Modifications of such Source Code Form, in each case including portions + thereof. + +1.5. “Incompatible With Secondary Licenses” + means + + a. that the initial Contributor has attached the notice described in + Exhibit B to the Covered Software; or + + b. that the Covered Software was made available under the terms of version + 1.1 or earlier of the License, but not also under the terms of a + Secondary License. + +1.6. “Executable Form” + + means any form of the work other than Source Code Form. + +1.7. “Larger Work” + + means a work that combines Covered Software with other material, in a separate + file or files, that is not Covered Software. + +1.8. “License” + + means this document. + +1.9. “Licensable” + + means having the right to grant, to the maximum extent possible, whether at the + time of the initial grant or subsequently, any and all of the rights conveyed by + this License. + +1.10. “Modifications” + + means any of the following: + + a. any file in Source Code Form that results from an addition to, deletion + from, or modification of the contents of Covered Software; or + + b. any new file in Source Code Form that contains any Covered Software. + +1.11. “Patent Claims” of a Contributor + + means any patent claim(s), including without limitation, method, process, + and apparatus claims, in any patent Licensable by such Contributor that + would be infringed, but for the grant of the License, by the making, + using, selling, offering for sale, having made, import, or transfer of + either its Contributions or its Contributor Version. + +1.12. “Secondary License” + + means either the GNU General Public License, Version 2.0, the GNU Lesser + General Public License, Version 2.1, the GNU Affero General Public + License, Version 3.0, or any later versions of those licenses. + +1.13. “Source Code Form” + + means the form of the work preferred for making modifications. + +1.14. “You” (or “Your”) + + means an individual or a legal entity exercising rights under this + License. For legal entities, “You” includes any entity that controls, is + controlled by, or is under common control with You. For purposes of this + definition, “control” means (a) the power, direct or indirect, to cause + the direction or management of such entity, whether by contract or + otherwise, or (b) ownership of more than fifty percent (50%) of the + outstanding shares or beneficial ownership of such entity. + + +2. License Grants and Conditions + +2.1. Grants + + Each Contributor hereby grants You a world-wide, royalty-free, + non-exclusive license: + + a. under intellectual property rights (other than patent or trademark) + Licensable by such Contributor to use, reproduce, make available, + modify, display, perform, distribute, and otherwise exploit its + Contributions, either on an unmodified basis, with Modifications, or as + part of a Larger Work; and + + b. under Patent Claims of such Contributor to make, use, sell, offer for + sale, have made, import, and otherwise transfer either its Contributions + or its Contributor Version. + +2.2. Effective Date + + The licenses granted in Section 2.1 with respect to any Contribution become + effective for each Contribution on the date the Contributor first distributes + such Contribution. + +2.3. Limitations on Grant Scope + + The licenses granted in this Section 2 are the only rights granted under this + License. No additional rights or licenses will be implied from the distribution + or licensing of Covered Software under this License. Notwithstanding Section + 2.1(b) above, no patent license is granted by a Contributor: + + a. for any code that a Contributor has removed from Covered Software; or + + b. for infringements caused by: (i) Your and any other third party’s + modifications of Covered Software, or (ii) the combination of its + Contributions with other software (except as part of its Contributor + Version); or + + c. under Patent Claims infringed by Covered Software in the absence of its + Contributions. + + This License does not grant any rights in the trademarks, service marks, or + logos of any Contributor (except as may be necessary to comply with the + notice requirements in Section 3.4). + +2.4. Subsequent Licenses + + No Contributor makes additional grants as a result of Your choice to + distribute the Covered Software under a subsequent version of this License + (see Section 10.2) or under the terms of a Secondary License (if permitted + under the terms of Section 3.3). + +2.5. Representation + + Each Contributor represents that the Contributor believes its Contributions + are its original creation(s) or it has sufficient rights to grant the + rights to its Contributions conveyed by this License. + +2.6. Fair Use + + This License is not intended to limit any rights You have under applicable + copyright doctrines of fair use, fair dealing, or other equivalents. + +2.7. Conditions + + Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted in + Section 2.1. + + +3. Responsibilities + +3.1. Distribution of Source Form + + All distribution of Covered Software in Source Code Form, including any + Modifications that You create or to which You contribute, must be under the + terms of this License. You must inform recipients that the Source Code Form + of the Covered Software is governed by the terms of this License, and how + they can obtain a copy of this License. You may not attempt to alter or + restrict the recipients’ rights in the Source Code Form. + +3.2. Distribution of Executable Form + + If You distribute Covered Software in Executable Form then: + + a. such Covered Software must also be made available in Source Code Form, + as described in Section 3.1, and You must inform recipients of the + Executable Form how they can obtain a copy of such Source Code Form by + reasonable means in a timely manner, at a charge no more than the cost + of distribution to the recipient; and + + b. You may distribute such Executable Form under the terms of this License, + or sublicense it under different terms, provided that the license for + the Executable Form does not attempt to limit or alter the recipients’ + rights in the Source Code Form under this License. + +3.3. Distribution of a Larger Work + + You may create and distribute a Larger Work under terms of Your choice, + provided that You also comply with the requirements of this License for the + Covered Software. If the Larger Work is a combination of Covered Software + with a work governed by one or more Secondary Licenses, and the Covered + Software is not Incompatible With Secondary Licenses, this License permits + You to additionally distribute such Covered Software under the terms of + such Secondary License(s), so that the recipient of the Larger Work may, at + their option, further distribute the Covered Software under the terms of + either this License or such Secondary License(s). + +3.4. Notices + + You may not remove or alter the substance of any license notices (including + copyright notices, patent notices, disclaimers of warranty, or limitations + of liability) contained within the Source Code Form of the Covered + Software, except that You may alter any license notices to the extent + required to remedy known factual inaccuracies. + +3.5. Application of Additional Terms + + You may choose to offer, and to charge a fee for, warranty, support, + indemnity or liability obligations to one or more recipients of Covered + Software. However, You may do so only on Your own behalf, and not on behalf + of any Contributor. You must make it absolutely clear that any such + warranty, support, indemnity, or liability obligation is offered by You + alone, and You hereby agree to indemnify every Contributor for any + liability incurred by such Contributor as a result of warranty, support, + indemnity or liability terms You offer. You may include additional + disclaimers of warranty and limitations of liability specific to any + jurisdiction. + +4. Inability to Comply Due to Statute or Regulation + + If it is impossible for You to comply with any of the terms of this License + with respect to some or all of the Covered Software due to statute, judicial + order, or regulation then You must: (a) comply with the terms of this License + to the maximum extent possible; and (b) describe the limitations and the code + they affect. Such description must be placed in a text file included with all + distributions of the Covered Software under this License. Except to the + extent prohibited by statute or regulation, such description must be + sufficiently detailed for a recipient of ordinary skill to be able to + understand it. + +5. Termination + +5.1. The rights granted under this License will terminate automatically if You + fail to comply with any of its terms. However, if You become compliant, + then the rights granted under this License from a particular Contributor + are reinstated (a) provisionally, unless and until such Contributor + explicitly and finally terminates Your grants, and (b) on an ongoing basis, + if such Contributor fails to notify You of the non-compliance by some + reasonable means prior to 60 days after You have come back into compliance. + Moreover, Your grants from a particular Contributor are reinstated on an + ongoing basis if such Contributor notifies You of the non-compliance by + some reasonable means, this is the first time You have received notice of + non-compliance with this License from such Contributor, and You become + compliant prior to 30 days after Your receipt of the notice. + +5.2. If You initiate litigation against any entity by asserting a patent + infringement claim (excluding declaratory judgment actions, counter-claims, + and cross-claims) alleging that a Contributor Version directly or + indirectly infringes any patent, then the rights granted to You by any and + all Contributors for the Covered Software under Section 2.1 of this License + shall terminate. + +5.3. In the event of termination under Sections 5.1 or 5.2 above, all end user + license agreements (excluding distributors and resellers) which have been + validly granted by You or Your distributors under this License prior to + termination shall survive termination. + +6. Disclaimer of Warranty + + Covered Software is provided under this License on an “as is” basis, without + warranty of any kind, either expressed, implied, or statutory, including, + without limitation, warranties that the Covered Software is free of defects, + merchantable, fit for a particular purpose or non-infringing. The entire + risk as to the quality and performance of the Covered Software is with You. + Should any Covered Software prove defective in any respect, You (not any + Contributor) assume the cost of any necessary servicing, repair, or + correction. This disclaimer of warranty constitutes an essential part of this + License. No use of any Covered Software is authorized under this License + except under this disclaimer. + +7. Limitation of Liability + + Under no circumstances and under no legal theory, whether tort (including + negligence), contract, or otherwise, shall any Contributor, or anyone who + distributes Covered Software as permitted above, be liable to You for any + direct, indirect, special, incidental, or consequential damages of any + character including, without limitation, damages for lost profits, loss of + goodwill, work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses, even if such party shall have been + informed of the possibility of such damages. This limitation of liability + shall not apply to liability for death or personal injury resulting from such + party’s negligence to the extent applicable law prohibits such limitation. + Some jurisdictions do not allow the exclusion or limitation of incidental or + consequential damages, so this exclusion and limitation may not apply to You. + +8. Litigation + + Any litigation relating to this License may be brought only in the courts of + a jurisdiction where the defendant maintains its principal place of business + and such litigation shall be governed by laws of that jurisdiction, without + reference to its conflict-of-law provisions. Nothing in this Section shall + prevent a party’s ability to bring cross-claims or counter-claims. + +9. Miscellaneous + + This License represents the complete agreement concerning the subject matter + hereof. If any provision of this License is held to be unenforceable, such + provision shall be reformed only to the extent necessary to make it + enforceable. Any law or regulation which provides that the language of a + contract shall be construed against the drafter shall not be used to construe + this License against a Contributor. + + +10. Versions of the License + +10.1. New Versions + + Mozilla Foundation is the license steward. Except as provided in Section + 10.3, no one other than the license steward has the right to modify or + publish new versions of this License. Each version will be given a + distinguishing version number. + +10.2. Effect of New Versions + + You may distribute the Covered Software under the terms of the version of + the License under which You originally received the Covered Software, or + under the terms of any subsequent version published by the license + steward. + +10.3. Modified Versions + + If you create software not governed by this License, and you want to + create a new license for such software, you may create and use a modified + version of this License if you rename the license and remove any + references to the name of the license steward (except to note that such + modified license differs from this License). + +10.4. Distributing Source Code Form that is Incompatible With Secondary Licenses + If You choose to distribute Source Code Form that is Incompatible With + Secondary Licenses under the terms of this version of the License, the + notice described in Exhibit B of this License must be attached. + +Exhibit A - Source Code Form License Notice + + This Source Code Form is subject to the + terms of the Mozilla Public License, v. + 2.0. If a copy of the MPL was not + distributed with this file, You can + obtain one at + http://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular file, then +You may include the notice in a location (such as a LICENSE file in a relevant +directory) where a recipient would be likely to look for such a notice. + +You may add additional accurate notices of copyright ownership. + +Exhibit B - “Incompatible With Secondary Licenses” Notice + + This Source Code Form is “Incompatible + With Secondary Licenses”, as defined by + the Mozilla Public License, v. 2.0. + diff --git a/components/service_edge/Makefile b/components/service_edge/Makefile new file mode 100644 index 0000000..4da5223 --- /dev/null +++ b/components/service_edge/Makefile @@ -0,0 +1,40 @@ +.PHONY: all deps compile setup clean doc + + +NAME=service_edge +export KVDB_BACKENDS=ets + +SETUP_GEN=$(shell ./find_setup_gen.sh) + +all: deps compile + +deps: + rebar get-deps + +compile: + rebar compile + +recomp: + rebar compile skip_deps=true + +setup: + ERL_LIBS=$(PWD)/deps:$(ERL_LIBS):$(PWD) \ + $(SETUP_GEN) $(NAME) priv/setup.config setup + +target: + ERL_LIBS=$(PWD)/deps:$(ERL_LIBS) \ + $(SETUP_GEN) $(NAME) priv/setup.config setup -pz $(PWD)/ebin \ + -target rel -vsn 0.1 + +run: setup + erl -boot setup/start -config setup/sys + +doc: + REBAR_DOC=1 rebar skip_deps=true get-deps doc + +clean: + rebar clean + + + + diff --git a/components/service_edge/README.md b/components/service_edge/README.md new file mode 100644 index 0000000..9c0852f --- /dev/null +++ b/components/service_edge/README.md @@ -0,0 +1 @@ +Better documentation will come. diff --git a/components/service_edge/curl_scripts/register_service.sh b/components/service_edge/curl_scripts/register_service.sh new file mode 100644 index 0000000..ed6400e --- /dev/null +++ b/components/service_edge/curl_scripts/register_service.sh @@ -0,0 +1,31 @@ +#!/bin/sh +# Create new accounts, like the ga account +# But other accounts may be create +. $HOME/.exodmrc + + #if [ $# != 2 ] +#then +# echo "Usage: $0 temperature" +# exit 255 +#fi +# the password (actually erlang node cookie) must be 100% hidden +# so this is only for testing!!!!! + +URL=http://localhost:8800/exodm/rpc +curl -u $USER_AUTH -k -X POST $URL -d @- << EOF +{ + "jsonrpc": "2.0", + + "method": "service_edge:register_service", + "id": "1", + "params": + { + "service": "hvac", + "address": "http://localhost:8901", + "methods": [ + { "access_type": "rpc", "method": "set_temperature" }, + { "access_type": "rpc", "method": "set_fan_speed" } + ] + } +} +EOF diff --git a/components/service_edge/find_setup_gen.sh b/components/service_edge/find_setup_gen.sh new file mode 100755 index 0000000..72cc213 --- /dev/null +++ b/components/service_edge/find_setup_gen.sh @@ -0,0 +1,17 @@ +#!/bin/sh + +if [ -z $ERL_LIBS ]; then + L=`pwd`/deps +else + L=`pwd`/deps:$ERL_LIBS +fi + +dirs=`echo $L | sed 's/\:/ /g'` + +for d in $dirs; do + f=$d/setup/setup_gen + if [ -f $f ]; then + echo "$f" + exit 0 + fi +done diff --git a/components/service_edge/priv/setup.config b/components/service_edge/priv/setup.config new file mode 100644 index 0000000..f68ece5 --- /dev/null +++ b/components/service_edge/priv/setup.config @@ -0,0 +1,57 @@ +%% -*- erlang -*- +[ + %% Put include first, making it possible to override any defaults below + {include_lib, "exoport/priv/setup.config"}, + %% + %% Add our own app(s) + {add_apps, [asn1, + ssl, + rvi_common, + service_edge + ]}, + %% + %% Custom environment settings + {env, + [ + {service_edge, + [ + { components, + [ + { service_discovery, "http://localhost:8801" }, + { store_and_forward, "http://localhost:8802" } + ] + } + ]}, + + {setup, [{data_dir, "db"}]}, + %% Tell exoport where to find our config file + {exoport, + [ + {bert_port, 9990}, %% 9999 was taken. + {config, filename:join(CWD, "exoport.config")}, + {access, + [{redirect, [{service_edge, service_edge_rpc}]}, + {accept, service_edge_rpc} + ]}, + {exo_http, + [{port, 8800}, + {appmod, {exoport_exo_http, service_edge_rpc}}]}, + {kvdb_databases, + [{kvdb_conf, + [{file,"$DATA_DIR/kvdb_conf.db"}, + {backend,ets}, + {log_dir, "$DATA_DIR/kvdb_conf.log"}, + {log_threshold, [{writes, 1000}]}, + {save_mode, [on_switch, on_close]}, + {tables,[data]}, + {encoding,{raw,term,term}}, + {schema,kvdb_schema_events}]} + ]} + ]} + %% %% We run with a logging ETS backend in the database + %% {kvdb, + %% [ + %% ]} + %% ]} + ]} +]. diff --git a/components/service_edge/rebar.config b/components/service_edge/rebar.config new file mode 100644 index 0000000..4c64ab8 --- /dev/null +++ b/components/service_edge/rebar.config @@ -0,0 +1,11 @@ +%% -*- erlang -*- + +{erl_opts, [debug_info]}. + +{deps, + [ + {setup, ".*", {git, "https://github.com/uwiger/setup.git", "HEAD"}}, + {rvi_common, ".*", {git, "https://gerrit.automotivelinux.org/gerrit/RVI/rvi_common", "HEAD"}}, + {resource, ".*", {git, "https://github.com/tonyrog/resource.git", "HEAD"}}, + {wse, ".*", {git, "https://github.com/tonyrog/wse.git", "HEAD"}} +]}. diff --git a/components/service_edge/src/service_edge.app.src b/components/service_edge/src/service_edge.app.src new file mode 100644 index 0000000..5c19df8 --- /dev/null +++ b/components/service_edge/src/service_edge.app.src @@ -0,0 +1,24 @@ +%% +%% Copyright (C) 2014, Jaguar Land Rover +%% +%% This program is licensed under the terms and conditions of the +%% Mozilla Public License, version 2.0. The full text of the +%% Mozilla Public License is at https://www.mozilla.org/MPL/2.0/ +%% + + +%% -*- erlang -*- +{application, service_edge, + [ + {description, ""}, + {vsn, "0.1"}, + {registered, []}, + {applications, [ + kernel, + stdlib, + rvi_common, + wse + ]}, + {mod, { service_edge_app, []}}, + {start_phases, [{init, []}]} + ]}. diff --git a/components/service_edge/src/service_edge_app.erl b/components/service_edge/src/service_edge_app.erl new file mode 100644 index 0000000..56b88af --- /dev/null +++ b/components/service_edge/src/service_edge_app.erl @@ -0,0 +1,31 @@ +%% +%% Copyright (C) 2014, Jaguar Land Rover +%% +%% This program is licensed under the terms and conditions of the +%% Mozilla Public License, version 2.0. The full text of the +%% Mozilla Public License is at https://www.mozilla.org/MPL/2.0/ +%% + + +-module(service_edge_app). + +-behaviour(application). + +%% Application callbacks +-export([start/2, + start_phase/3, + stop/1]). + +%% =================================================================== +%% Application callbacks +%% =================================================================== + +start(_StartType, _StartArgs) -> + service_edge_sup:start_link(). + +start_phase(init, _, _) -> + service_edge_rpc:init(), + ok. + +stop(_State) -> + ok. diff --git a/components/service_edge/src/service_edge_rpc.erl b/components/service_edge/src/service_edge_rpc.erl new file mode 100644 index 0000000..3b95e11 --- /dev/null +++ b/components/service_edge/src/service_edge_rpc.erl @@ -0,0 +1,333 @@ +%% +%% Copyright (C) 2014, Jaguar Land Rover +%% +%% This program is licensed under the terms and conditions of the +%% Mozilla Public License, version 2.0. The full text of the +%% Mozilla Public License is at https://www.mozilla.org/MPL/2.0/ +%% + + +-module(service_edge_rpc). + + +-export([handle_rpc/2]). +-export([wse_register_service/2]). +-export([wse_message/5]). +-export([init/0]). + +%%-include_lib("lhttpc/include/lhttpc.hrl"). +-include_lib("lager/include/log.hrl"). + +%% Called by service_edge_app:start_phase(). +init() -> + ?notice("---- Service Edge URL: ~s", [ rvi_common:find_component_address(service_edge)]), + ?notice("---- Node Service Prefix: ~s", [ rvi_common:local_service_prefix()]), + case rvi_common:get_component_config(service_edge, exo_http_opts) of + { ok, ExoHttpOpts } -> + exoport_exo_http:instance(service_edge_sup, + service_edge_rpc, + ExoHttpOpts); + Err -> Err + end, + + %% + %% Fire up the websocket subsystem, if configured + %% + case rvi_common:get_component_config(service_edge, websocket) of + { ok, WSOpts } -> + case proplists:get_value(port, WSOpts, undefined ) of + undefined -> + {error, { missing_config, service_edge, port}}; + + Port -> + %% FIXME: MONITOR AND RESTART + wse_server:start(Port, proplists:delete(port, WSOpts)), + ok + end; + + WSErr -> WSErr + end. + + +register_service(Service, Address) -> + ?debug("service_edge_rpc:register_service(): service: ~p ", [Service]), + ?debug("service_edge_rpc:register_service(): address: ~p ", [Address]), + + case + %% Register the service at service discovery + rvi_common:send_component_request(service_discovery, register_local_service, + [ + {service, Service}, + {network_address, Address} + ], [service]) of + { ok, JSONStatus, [ FullSvcName], _JSON} -> + + %% Announce the new service + rvi_common:send_component_request(data_link, announce_new_local_service, + [ + %% Convert /some/svc to jlr.com/some/svc + {service, rvi_common:local_service_to_string(Service)} + ], [service]), + { ok, [ {service, FullSvcName}, + {status, rvi_common:json_rpc_status(JSONStatus)} ] }; + + Err -> + ?debug("service_edge_rpc:register_service() Failed at service_discovery(): ~p", + [ Err ]), + Err + end. + + +%% +%% Handle a message, delivered from a locally connected service, that is +%% to be forwarded to a remote service. +%% +handle_local_message(ServiceName, Timeout, Parameters, CallingService) -> + ?debug("service_edge_rpc:local_msg: service_name: ~p", [ServiceName]), + ?debug("service_edge_rpc:local_msg: timeout: ~p", [Timeout]), + ?debug("service_edge_rpc:local_msg: parameters: ~p", [Parameters]), + ?debug("service_edge_rpc:local_msg: calling_service: ~p", [CallingService]), + + + case + %% + %% Authorize local message and retrieve a certificate / signature + %% that will be accepted by the receiving node that will deliver + %% the messaage to its locally connected service_name service. + %% + rvi_common:send_component_request(authorize, authorize_local_message, + [ + {calling_service, CallingService}, + {service_name, ServiceName} + ], + [ certificate, signature ]) of + { ok, ok, [Certificate, Signature], _AuthJSON } -> + + %% + %% Check if this is a local service. If so, just forward it to its service_name. + %% + case rvi_common:is_local_service(ServiceName) of + true -> %% ServiceName is local. Forward message + ?debug("service_edge_rpc:local_msg(): Service is local. Forwarding."), + forward_message_to_local_service(ServiceName, Parameters); + + false -> %% ServiceName is remote + %% Ask Schedule the request to resolve the network address + ?debug("service_edge_rpc:local_msg(): Service is remote. Scheduling."), + forward_message_to_scheduler(ServiceName, Timeout, Parameters, Certificate, Signature) + end; + + Err -> + ?warning(" service_edge_rpc:local_msg() Failed at authorize: ~p", + [ Err ]), + Err + end. + + +%% +%% Handle a message, delivered from a remote node through protocol, that is +%% to be forwarded to a locally connected service. +%% +handle_remote_message(ServiceName, Timeout, Parameters, Signature, Certificate) -> + ?debug("service_edge:remote_msg(): service_name: ~p", [ServiceName]), + ?debug("service_edge:remote_msg(): timeout: ~p", [Timeout]), + ?debug("service_edge:remote_msg(): parameters: ~p", [Parameters]), + ?debug("service_edge:remote_msg(): signature: ~p", [Signature]), + ?debug("service_edge:remote_msg(): certificate: ~p", [Certificate]), + case + rvi_common:send_component_request(authorize, authorize_remote_message, + [ + {service_name, ServiceName}, + {certificate, Certificate}, + {signature, Signature} + ]) of + { ok, ok, _AuthJSON } -> + forward_message_to_local_service(ServiceName, Parameters); + + %% Authorization failed. + { ok, Err, _} -> + ?warning(" service_edge:remote_msg(): Authorization failed: ~p", [Err]), + {error, { authorization, Err }}; + + %% Authorization component error (HTTP, or similar). + Err -> + ?warning(" service_edge:remote_msg(): Authorization failed: ~p", [Err]), + Err + end. + +%% +%% Depending on the format of NetworkAddress +%% Dispatch to websocket or JSON-RPC server +%% FIXME: Should be a pluggable setup where +%% different dispatchers are triggered depending +%% on prefix in NetworkAddress +%% + +flatten_ws_args([ { _, [{ struct, List}] } | T], Acc ) when is_list(List) -> + flatten_ws_args(List ++ T, Acc); + +flatten_ws_args([{ _, Val}| T], Acc ) -> + flatten_ws_args(T, [ Val | Acc]); + + +flatten_ws_args([], Acc) -> + lists:reverse(Acc). + + +flatten_ws_args(Args) -> + flatten_ws_args(Args, []). + +dispatch_to_local_service([ $w, $s, $: | WSPidStr], Command, Args) -> + ?debug("service_edge:dispatch_to_local_service(): Websocket!: ~p, ~p", [ Command, Args]), + wse:call(list_to_pid(WSPidStr), wse:window(), + Command, flatten_ws_args(Args)), + ok; + +%% Dispatch to regular JSON-RPC over HTTP. +dispatch_to_local_service(NetworkAddress, Command, Args) -> + rvi_common:send_http_request(NetworkAddress, Command, Args). + + +forward_message_to_local_service(ServiceName, Parameters) -> + %% + %% Resolve the local service name to an URL that we can send the + %% request to + %% + ?debug("service_edge:forward_to_local(): service_name: ~p", [ServiceName]), + + case rvi_common:send_component_request(service_discovery, + resolve_local_service, + [ {service, ServiceName} ], + [ network_address ]) of + { ok, ok, [ NetworkAddress], _SDJSON } -> + ?debug("service_edge:forward_to_local(): URL: ~p", [NetworkAddress]), + + %% + %% Strip our node prefix from service_name so that + %% the service receiving the JSON rpc call will have + %% a service_name that is identical to the service name + %% it registered with. + %% + SvcName = string:substr(ServiceName, + length(rvi_common:local_service_prefix())), + + %% Deliver the message to the local service, which can + %% be either a wse websocket, or a regular HTTP JSON-RPC call + case rvi_common:get_request_result( + dispatch_to_local_service(NetworkAddress, + "message", + [ { service_name, SvcName }, + { parameters, Parameters }])) of + + %% Request delivered. + { ok, ok, _ } -> + { ok, [ { status, rvi_common:json_rpc_status(ok)} ] }; + + %% status returned was an error code. + { ok, undefined } -> + ?warning("service_edge:forward_to_local(): " + "Local Service ~p at ~p not available.", + [ServiceName, NetworkAddress]), + { ok, [ { status, rvi_common:json_rpc_status(not_available)}]}; + + { ok, Status } -> + ?warning(" service_edge:forward_to_local(): Status: ~p", + [Status]), + { error, [{ status, rvi_common:json_rpc_status(Status)}]}; + + %% HTTP or similar error. + Err -> + ?warning("service_edge:forward_to_local(): Local service failed: ~p", [Err]), + Err + end; + + %% Local service could not be resolved to an URL + {ok, not_found, _, _} -> + ?info(" service_edge_rpc:local_msg() Local service ~p not found.", + [ ServiceName ]), + { ok, [ { status, rvi_common:json_rpc_status(not_found)} ] }; + + Err -> + ?debug("service_edge_rpc:local_msg() Failed at service discovery: ~p", + [ Err ]), + { ok, [ { status, rvi_common:json_rpc_status(internal)} ] } + end. + + +forward_message_to_scheduler(ServiceName, Timeout, Parameters, Certificate, Signature) -> + %% Resolve the service_name. + case + rvi_common:send_component_request(schedule, schedule_message, + [ + { timeout, Timeout }, + { parameters, Parameters }, + { certificate, Certificate }, + { signature, Signature }, + { service_name, ServiceName } + ]) of + + { ok, ok, _SchJSON } -> + %% We are happy. Return. + { ok, [ { status, rvi_common:json_rpc_status(ok)} ] }; + + Err -> + ?debug("service_edge_rpc:local_msg() Failed at scheduling: ~p", + [ Err ]), + { ok, [ { status, rvi_common:json_rpc_status(internal)} ] } + end. + + + +%% JSON-RPC entry point +%% Called by local exo http server +handle_rpc("register_service", Args) -> + {ok, Service} = rvi_common:get_json_element(["service"], Args), + {ok, Address} = rvi_common:get_json_element(["network_address"], Args), + register_service(Service, Address); + + +handle_rpc("register_remote_services", Args) -> + {ok, _Services} = rvi_common:get_json_element(["services"], Args), + %% FIXME: Report all available services to the connected local services + { ok, [ { status, rvi_common:json_rpc_status(ok)} ] }; + +handle_rpc("unregister_remote_services", Args) -> + {ok, _Services} = rvi_common:get_json_element(["services"], Args), + %% FIXME: Report all available services to the connected local services + { ok, [ { status, rvi_common:json_rpc_status(ok)} ] }; + +handle_rpc("message", Args) -> + {ok, ServiceName} = rvi_common:get_json_element(["service_name"], Args), + {ok, Timeout} = rvi_common:get_json_element(["timeout"], Args), + {ok, Parameters} = rvi_common:get_json_element(["parameters"], Args), + {ok, CallingService} = rvi_common:get_json_element(["calling_service"], Args), + handle_local_message( ServiceName, Timeout, Parameters, CallingService); + +handle_rpc("handle_remote_message", Args) -> + { ok, ServiceName } = rvi_common:get_json_element(["service_name"], Args), + { ok, Timeout } = rvi_common:get_json_element(["timeout"], Args), + { ok, Parameters } = rvi_common:get_json_element(["parameters"], Args), + { ok, Certificate } = rvi_common:get_json_element(["certificate"], Args), + { ok, Signature } = rvi_common:get_json_element(["signature"], Args), + handle_remote_message( ServiceName, Timeout, Parameters, Certificate, Signature); + + +handle_rpc(Other, _Args) -> + ?debug("service_edge_rpc:handle_rpc(~p): unknown command", [ Other ]), + { ok, [ { status, rvi_common:json_rpc_status(invalid_command)} ] }. + + +%% Websocket iface +wse_register_service(Ws, Service ) -> + ?debug("service_edge_rpc:wse_register_service(~p) service: ~p", [ Ws, Service ]), + register_service(Service, "ws:" ++ pid_to_list(Ws)). + + +wse_message(Ws, ServiceName, Timeout, JSONParameters, CallingService) -> + %% Parameters are delivered as JSON. Decode into tuple + { ok, Parameters } = exo_json:decode_string(JSONParameters), + ?debug("service_edge_rpc:wse_message(~p) ServiceName: ~p", [ Ws, ServiceName ]), + ?debug("service_edge_rpc:wse_message(~p) Timeout: ~p", [ Ws, Timeout]), + ?debug("service_edge_rpc:wse_message(~p) CallingService: ~p", [ Ws, CallingService ]), + ?debug("service_edge_rpc:wse_message(~p) Parameters: ~p", [ Ws, Parameters ]), + handle_local_message( ServiceName, Timeout, [Parameters] , CallingService). diff --git a/components/service_edge/src/service_edge_sup.erl b/components/service_edge/src/service_edge_sup.erl new file mode 100644 index 0000000..63f111b --- /dev/null +++ b/components/service_edge/src/service_edge_sup.erl @@ -0,0 +1,40 @@ +%% +%% Copyright (C) 2014, Jaguar Land Rover +%% +%% This program is licensed under the terms and conditions of the +%% Mozilla Public License, version 2.0. The full text of the +%% Mozilla Public License is at https://www.mozilla.org/MPL/2.0/ +%% + + +-module(service_edge_sup). + +-behaviour(supervisor). + +%% API +-export([start_link/0]). + +%% Supervisor callbacks +-export([init/1]). + +%% Helper macro for declaring children of supervisor +-define(CHILD(I, Type), {I, {I, start_link, []}, permanent, 5000, Type, [I]}). + +%% =================================================================== +%% API functions +%% =================================================================== + +start_link() -> + supervisor:start_link({local, ?MODULE}, ?MODULE, []). + +%% =================================================================== +%% Supervisor callbacks +%% =================================================================== + +init([]) -> + {ok, { {one_for_one, 5, 10}, + [ + %% ?CHILD(some_module, worker), + %% ?CHILD(exodmo_config, worker) + ]} }. + |