-
Notifications
You must be signed in to change notification settings - Fork 4
/
chatterl_gateway.erl
656 lines (622 loc) · 21.8 KB
/
chatterl_gateway.erl
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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
%%----------------------------------------------------------------
%%% @author Yomi Colledge <yomi@boodah.net>
%%% @doc Web interface for Chatterl
%%%
%%% Chatterl Web Gateway, allowing Web based clients to interact
%%% with Chatterl over a RESTful API.
%%%
%%% Allows Chatterl to interface with any web-based interface
%%% Using JSON and XML, sending the requests off to the chatterl_serv
%%% module.
%%%
%%% All calls to CWIGA will only be allowed via a specified IP, which
%%% will be defined with the configuration file.
%%% @end
%%% @copyright 2008-2009 Yomi Akindayini
%%%---------------------------------------------------------------
-module(chatterl_gateway).
-behaviour(gen_server).
%% API
-export([start/1,dispatch_requests/1,tuple_to_xml/2]).
%% gen_server callbacks
-export([init/1, handle_call/3, handle_cast/2, handle_info/2,
terminate/2, code_change/3]).
-record(state, {}).
-record(messages, {client,message}).
%% Record used to pass our basic messages from the gateway to chatterl_web
-record(carrier, {type,message}).
-define(SERVER, ?MODULE).
%%====================================================================
%% API
%%====================================================================
%%--------------------------------------------------------------------
%% @doc
%% Starts the server
%%
%% @spec start(Port) -> {ok,Pid} | ignore | {error,Error}
%% @end
%%--------------------------------------------------------------------
start(Port) ->
gen_server:start_link({local, ?SERVER}, ?MODULE, [Port], []).
%%--------------------------------------------------------------------
%% @doc
%% Dispatches our requests to the relevant handle.
%%
%% Uses clean_path to determine what the action is.
%% @spec dispatch_requests(Request) -> void()
%% @end
%%--------------------------------------------------------------------
dispatch_requests(Req) ->
%log(Req),
[Path|Ext] = string:tokens(Req:get(path),"."),
Action = clean_path(Path),
handle(Action,Ext,Req).
%%====================================================================
%% gen_server callbacks
%%====================================================================
%%--------------------------------------------------------------------
%% @doc
%% Initiates the server
%%
%% Function: init(Port) -> {ok, State} |
%% {ok, State, Timeout} |
%% ignore |
%% {stop, Reason}
%%--------------------------------------------------------------------
init([Port]) ->
io:format("Initialising Chatterl Web Interface~n"),
process_flag(trap_exit, true),
mochiweb_http:start([{port, Port}, {loop, fun dispatch_requests/1}]),
erlang:monitor(process,mochiweb_http),
{ok, #state{}}.
%%--------------------------------------------------------------------
%% @doc
%% Description: Handling call messages
%%
%% @spec handle_call(Request, From, State) -> {reply, Reply, State} |
%% {reply, Reply, State, Timeout} |
%% {noreply, State} |
%% {noreply, State, Timeout} |
%% {stop, Reason, Reply, State} |
%% {stop, Reason, State}
%% @end
%%--------------------------------------------------------------------
handle_call({dolog,Req,Ip},_From,State) ->
stat_logger:log("~p ~p~n", [Ip, Req:get(path)]),
{reply,ok,State};
handle_call(_Request, _From, State) ->
{reply,ok,State}.
%%--------------------------------------------------------------------
%% @doc
%% Handling cast messages
%%
%% @spec handle_cast(Msg, State) -> {noreply, State} |
%% {noreply, State, Timeout} |
%% {stop, Reason, State}
%% @end
%%--------------------------------------------------------------------
handle_cast(_Msg, State) ->
{noreply, State}.
%%--------------------------------------------------------------------
%% @doc
%% Handling all non call/cast messages
%%
%% @spec handle_info(Info, State) -> {noreply, State} |
%% {noreply, State, Timeout} |
%% {stop, Reason, State}
%% @end
%%--------------------------------------------------------------------
handle_info({'DOWN', _Ref, _Process, {mochiweb_http, Host}, Reason}, State) ->
io:format("Unable to start mochiweb on ~s:~nReason: ~s~n",[Host,Reason]),
{stop,normal,State};
handle_info(_Info, State) ->
{noreply, State}.
%%--------------------------------------------------------------------
%% @doc
%% Terminates Chatterl Web Interface, making sure to shutdown mochiweb
%% along side it.
%%
%% @spec terminate({node,Reason},State) -> void()
%% @todo Needs a time out for when the port is already in use.
%% @end
%%--------------------------------------------------------------------
terminate(_Reason, _State) ->
io:format("Shutting down ChatterlWeb on: ~s...~n",[node(self())]),
mochiweb_http:stop(),
ok.
%%--------------------------------------------------------------------
%% @doc
%%
%% Convert process state when code is changed
%% @spec code_change(OldVsn, State, Extra) -> {ok, NewState}
%%
%% @end
%%--------------------------------------------------------------------
code_change(_OldVsn, State, _Extra) ->
{ok, State}.
%%--------------------------------------------------------------------
%%% Internal functions
%%--------------------------------------------------------------------
%%--------------------------------------------------------------------
%% @private
%% @doc
%%
%% Cleans up a request so we only retrieve the path.
%% @spec clean_path(Path) -> [Path]
%%
%% @end
%%--------------------------------------------------------------------
clean_path(Path) ->
case string:str(Path, "?") of
0 ->
Path;
N ->
string:substr(Path, 1, string:len(Path) - (N + 1))
end.
%%--------------------------------------------------------------------
%% @private
%% @doc
%%
%% Gets the content type, used to help CWIGA to determine what format
%% to respond in.
%% @spec get_content_type(Type) -> string()
%%
%% @end
%%--------------------------------------------------------------------
get_content_type(Type) ->
case Type of
["json"] ->
"text/plain";
["xml"] ->
"text/xml";
_ -> "text/plain"
end.
%%--------------------------------------------------------------------
%% @doc
%%
%% Handles our RESTful resquests.
%%
%% @spec handle(Action,ContentType,Req) -> void()
%%
%% @end
%%--------------------------------------------------------------------
handle("/connect/" ++ Client,ContentType,Req) ->
{Type,Record} =
case gen_server:call({global,chatterl_serv},{connect,Client}) of
{ok,_} -> {"success",Client++" now connected"};
{error,Error} -> {"failure",Error}
end,
send_response(Req,{get_content_type(ContentType),build_carrier(Type,Record)});
handle("/disconnect/" ++ Client,ContentType,Req) ->
{Type,Record} =
case gen_server:call({global,chatterl_serv},{disconnect,Client}) of
{ok,Message} -> {"success",Message};
{error,Error} -> {"failure",Error}
end,
send_response(Req, {get_content_type(ContentType),build_carrier(Type,Record)});
handle("/users/list", ContentType ,Req) ->
{Type,Result} =
case gen_server:call({global,chatterl_serv},list_users) of
[] -> {"success",build_carrier("clients","")};
Clients ->
ClientsList = [build_carrier("client",Client)||Client <- Clients],
{"success",build_carrier("clients",ClientsList)}
end,
send_response(Req,{get_content_type(ContentType),build_carrier(Type,Result)});
handle("/users/list/" ++Group,ContentType,Req) ->
{Type,Record} =
case gen_server:call({global,chatterl_serv},{group_exists,Group}) of
true -> ClientsList = [build_carrier("client",Client)
|| {Client,{_Pid,_Ref}} <- gen_server:call({global,Group},list_users)],
{"success",build_carrier("clients",ClientsList)};
false ->
build_carrier("error","Group: "++ Group ++ " doesn't exist")
end,
send_response(Req,{get_content_type(ContentType),build_carrier(Type,Record)});
handle("/groups/list",ContentType,Req) ->
{Type,Result} =
case gen_server:call({global,chatterl_serv},list_groups) of
[] -> {"success",build_carrier("groups","")};
Groups ->
GroupsList = [build_carrier("group",Group)||Group <- Groups],
{"success",build_carrier("groups",GroupsList)}
end,
send_response(Req,{get_content_type(ContentType),build_carrier(Type,Result)});
handle("/groups/join/" ++ Group,ContentType,Req) ->
[Client] = get_properties(Req,["client"]),
Record =
case gen_server:call({global,chatterl_serv},{group_exists,Group}) of
true ->
generate_record(Group,join,Client);
false ->
build_carrier("error","Group: "++ Group ++ " doesn't exist")
end,
send_response(Req,{get_content_type(ContentType),Record});
handle("/groups/leave/" ++ Group,ContentType,Req) ->
[Client] = get_properties(Req,["client"]),
Record = generate_record(Group,leave,Client),
send_response(Req,{get_content_type(ContentType),Record});
handle("/groups/send/" ++ Group, ContentType, Req) ->
[Sender,Message] = get_properties(Req,["client","msg"]),
Record = generate_record(Group,{group_msg,Message},Sender),
send_response(Req,{get_content_type(ContentType),Record});
handle("/groups/poll/" ++ Group,ContentType,Req) ->
{Type,Result} =
case gen_server:call({global,chatterl_serv},{group_exists,Group}) of
true ->
case gen_server:call({global,Group},poll_messages) of
[] -> {"success",build_carrier("messages","")};
Messages ->
MessagesList = [build_carrier("message",format_messages(Message))||Message <- Messages],
{"success",build_carrier("messages",MessagesList)}
end;
false ->
{"error","Group: "++ Group ++ " doesn't exist"}
end,
send_response(Req,{get_content_type(ContentType),build_carrier(Type,Result)});
handle(Unknown, ContentType,Req) ->
send_response(Req,{get_content_type(ContentType),build_carrier("error", "Unknown command: " ++Unknown)}).
%%--------------------------------------------------------------------
%% @private
%% @doc
%%
%% Gets a list of properties.
%% @spec get_properties(Req,WantedParams) -> [ParamValues]
%%
%% @end
%%--------------------------------------------------------------------
get_properties(Req,WantedParams) ->
Params = Req:parse_qs(),
[proplists:get_value(Property, Params)|| Property <- WantedParams].
%%--------------------------------------------------------------------
%% @private
%% @doc
%%
%% Generates the record for joining a Chatterl group.
%%
%% Have a feeling this can be cleaned up or used in other places, so
%% I have placed it here.
%% @spec generate_record(Group,Payload,Client) -> Record
%%
%% @end
%%--------------------------------------------------------------------
generate_record(Group,Payload,Client) ->
case gen_server:call({global,chatterl_serv},{user_exists,Client}) of
true ->
%% Check payload here
case Payload of
join ->
case gen_server:call({global,Group},{join,Client}) of
{ok,_} ->
build_carrier("success",Client ++ " joined group");
{error,Error} ->
build_carrier("failure",Error)
end;
leave ->
case gen_server:call({global,Group},{drop,Client}) of
{ok, _ } ->
build_carrier("success",Client ++ " has disconnected from " ++ Group);
{error,Error} ->
build_carrier("failure",Error)
end;
{group_msg,Message} ->
%% Need to check that the user is connected to the group.
case gen_server:call({global,Group},{send_msg,Client,Message}, infinity) of
{ok,Msg} ->
build_carrier("success",atom_to_list(Msg));
{error,_Error} ->
build_carrier("failure","Can not send the same message twice")
end;
_ -> io:format("Unrecognised payload: ~s~n",[Payload])
end;
false ->
Name =
case Client of
undefined -> atom_to_list(Client);
_ -> Client
end,
build_carrier("error","Client:" ++Name ++" doesn't exist")
end.
%%--------------------------------------------------------------------
%% @private
%% @doc
%%
%% Builds and returns our carrier message.
%%
%% This is used to pass around message retrieved from Chatterl.
%% @spec build_carrier(Type,Message) -> Record
%%
%% @end
%%--------------------------------------------------------------------
build_carrier(Type,Message) ->
#carrier{ type=Type, message=Message}.
%%--------------------------------------------------------------------
%% @private
%% @doc
%%
%% Generates the record for joining a Chatterl group.
%%
%% Have a feeling this can be cleaned up or used in other places, so
%% I have place it here.
%% @spec format_messages(MessageCarrier) -> [MessageRecord]
%%
%% @end
%%--------------------------------------------------------------------
format_messages({Client,Date,Message}) ->
[build_carrier("client",Client),build_carrier("date",Date),build_carrier("message",Message)].
%%--------------------------------------------------------------------
%% @private
%% @doc
%%
%% Handles our all responses.
%%
%% Sends responses based on the content type, which are JSON and XML.
%% @spec send_response(Req,{ContentType,Record}) -> void()
%%
%% @end
%%--------------------------------------------------------------------
send_response(Req, {ContentType,Record}) when is_list(ContentType) ->
Response = get_response_body(ContentType,Record),
Code = get_response_code(Record),
Req:respond({Code, [{"Content-Type", ContentType}], list_to_binary(Response)}).
%%--------------------------------------------------------------------
%% @private
%% @doc
%%
%% Gets the actual response body to return to the client.
%%
%% Responses are either in JSON or XML, if the wrong content type is passed
%% the client will recieve an error in XML format.
%% @spec get_response_body(ContentType,Record) -> [ResponseBody]
%%
%% @end
%%--------------------------------------------------------------------
get_response_body(ContentType,Record) ->
case ContentType of
"text/plain" ->
json_message(Record);
"text/xml" ->
xml_message(Record);
_ -> json_message(build_carrier("error","Illegal content type!"))
end.
%%--------------------------------------------------------------------
%% @private
%% @doc
%%
%% Gets our response code depending on the type of message passed by
%% the carrier record.
%%
%% @spec get_response_code(Record) -> integer()
%%
%% @end
%%--------------------------------------------------------------------
get_response_code(Record) ->
case Record of
{carrier,Type,_Message} ->
case Type of
"failure" -> 200;
"success" -> 200;
"error" -> 500;
_ -> 500
end
end.
%%--------------------------------------------------------------------
%% @private
%% @doc
%%
%% Converts our carrier Record into a JSON format.
%% @spec json_message(CarrierRecord) -> JSON
%%
%% @end
%%--------------------------------------------------------------------
json_message(CarrierRecord) ->
{carrier, CarrierType, Message} = CarrierRecord,
Struct =
case Message of
{carrier,Type,MessagesCarrier} ->
case Type =:= "groups"
orelse Type =:= "clients"
orelse Type =:= "messages" of
true ->
handle_messages_json(Type,MessagesCarrier,CarrierType);
false ->
io:format("dont know ~s~n",[Type])
end;
_ ->
{struct,[{CarrierType,list_to_binary(Message)}]}
end,
mochijson2:encode({struct,[{chatterl,{struct,[{response,Struct}]}}]}).
%%--------------------------------------------------------------------
%% @private
%% @doc
%%
%% Generates JSON structure needed to create message responses.
%%
%% As messages are a different format that the other responses, they
%% need to be handled uniquely. We also want to make sure that all three
%% clauses are meet (empty,single message, multiple messages).
%% @spec handle_messages_json(CarrierType,MessagesCarrier,Type) -> JSON
%%
%% @end
%%--------------------------------------------------------------------
handle_messages_json(Type,MessagesCarrier,CarrierType) ->
case Type =:= "messages" of
true ->
case MessagesCarrier of
[] -> %Empty list.
{struct,[{Type,[]}]};
[{carrier,_MessageType,MessageData}] -> % A Single message.
{struct,[{CarrierType,
{struct,[{Type,loop_json_carrier(MessageData)}]}}]};
Messages -> % Multiple messages
{struct,[{CarrierType,
{struct,[{Type,inner_loop_json_carrier(Messages)}]}}]}
end;
false ->
{struct,[{CarrierType,{struct,[{Type,loop_json_carrier(MessagesCarrier)}]}}]}
end.
%%--------------------------------------------------------------------
%% @private
%% @doc
%%
%% Generates out actual XML message.
%%
%% Takes the record and converts it into a tuple which can be further
%% converted into a valid XML format using tuple_to_xml.
%% Example of XML tuple structure.
%% <code>{carrier,"groups",[{carrier,"group","nu"},{carrier,"group","nu2"}]}</code>
%%
%% @spec xml_message(Record) -> XML
%%
%% @end
%%--------------------------------------------------------------------
xml_message(CarrierRecord) ->
{carrier, MessageType, Message} = CarrierRecord,
XMLTuple = case Message of
{carrier, Type, Record} ->
case Type =:= "groups" orelse Type =:= "clients" orelse Type =:= "messages" of
true ->
xml_tuple(Type,loop_xml_carrier(Record));
false -> io:format("dont know ~s~n",[Type])
end;
_ -> xml_tuple_single(MessageType,Message)
end,
tuple_to_xml(XMLTuple,[]).
%%--------------------------------------------------------------------
%% @private
%% @doc
%%
%% Loops over the record carrier building the tuple structure need to
%% build out XML.
%% @spec loop_xml_carrier(Carrier) -> XMLTuple
%%
%% @end
%%--------------------------------------------------------------------
loop_xml_carrier(CarrierRecord) ->
Result = [loop_xml_tuple(DataType,Data) || {carrier,DataType,Data} <- CarrierRecord],
Response = [Result],
Response.
%%--------------------------------------------------------------------
%% @private
%% @doc
%%
%% Loops over the record carrier building the tuple structure need to
%% build our JSON.
%% @spec loop_json_carrier(Carrier) -> JSONTuple
%%
%% @end
%%--------------------------------------------------------------------
loop_json_carrier(CarrierRecord) ->
[{struct,[{list_to_binary(DataType),clean_message(Data)}]} || {carrier,DataType,Data} <- CarrierRecord].
%%--------------------------------------------------------------------
%% @private
%% @doc
%%
%% Loops over the message carrier building the tuple structure need to
%% build our JSON.
%%
%% We use this to build each message retrieved from a group, as they
%% have a number of elements we need to parse those the same as the
%% outer elements.
%% @spec inner_loop_json_carrier(CarrierRecord) -> JSONTuple
%%
%% @end
%%--------------------------------------------------------------------
inner_loop_json_carrier(CarrierRecord) ->
[{struct,[{list_to_binary(MsgType),loop_json_carrier(Msg)}]} || {carrier,MsgType,Msg} <- CarrierRecord].
%%--------------------------------------------------------------------
%% @private
%% @doc
%%
%% Cleans up our messages, ready for JSON/XML construction.
%%
%% We need this so that we can clean our date format, later we will
%% format dates properly but this works as a quick fix.
%% @spec clean_message(Carrier) -> XMLTuple
%%
%% @end
%%--------------------------------------------------------------------
clean_message(Data) when is_tuple(Data) ->
{A,B,C} = Data,
[A,B,C];
clean_message(Data) ->
list_to_binary(Data).
%%--------------------------------------------------------------------
%% @private
%% @doc
%%
%% Prepares our tuple used to generate our XML.
%% @spec xml_tuple(Type,Message) -> {XmlBody}
%%
%% @end
%%--------------------------------------------------------------------
xml_tuple(Type,Message) when is_list(Message) ->
[Data] = Message,
{chatterl,[],[{response,[],[{list_to_atom(Type),[],Data}]}]}.
%%--------------------------------------------------------------------
%% @private
%% @doc
%%
%% Prepares our tuple used to generate our sinlge XML elements.
%% @spec xml_tuple_single(Type,Message) -> {XmlBody}
%%
%% @end
%%--------------------------------------------------------------------
xml_tuple_single(Type,Message) ->
{chatterl,[],[{response,[],[{list_to_atom(Type),[],[Message]}]}]}.
%%--------------------------------------------------------------------
%% @private
%% @doc
%%
%% Prepares our tuple used to generate our XML.
%% @spec loop_xml_tuple(Type,Message) -> XmlTuple
%%
%% @end
%%--------------------------------------------------------------------
loop_xml_tuple(Type,Message) ->
{list_to_atom(Type),[],[Message]}.
%%--------------------------------------------------------------------
%% @private
%% @doc
%% Converts a tuple into XML.
%%
%% Inspired by the below link.
%% <a target="_blank" href="http://arandomurl.com/post/Simple-XML-in-Erlang">Link</a>
%% @spec tuple_to_xml(Xml,Prolog) -> [XML]
%%
%% @end
%%--------------------------------------------------------------------
tuple_to_xml(XmlTuple,Prolog) ->
lists:flatten(xmerl:export_simple([XmlTuple],xmerl_xml,[{prolog,Prolog}])).
%%--------------------------------------------------------------------
%% @private
%% @doc
%% Strips out whitespaces out of out XML tuple.
%%
%% Extracted from the link below.
%% <a target="_blank" href="http://arandomurl.com/post/Simple-XML-in-Erlang">Link</a>
%% @spec strip_whitespace(XMLTuple) -> [XML]
%%
%% @end
%%--------------------------------------------------------------------
strip_whitespace({El,Attr,Children}) ->
NChild = lists:filter(fun(X) ->
case X of
" " -> false;
_ -> true
end
end,Children),
Ch = lists:map(fun(X) -> strip_whitespace(X) end,NChild),
{El,Attr,Ch}.
%%--------------------------------------------------------------------
%% @private
%% @doc
%%
%% Logs all our requests.
%% @spec log(Req) -> XmlTuple
%%
%% @end
%%--------------------------------------------------------------------
log(Req) ->
Ip = Req:get(peer),
gen_server:call(?MODULE, {dolog, Req, Ip}).