* http://helm.cs.unibo.it/
*)
+open Hbugs_common;;
open Hbugs_types;;
open Printf;;
let global_debug = true;;
-class hbugsClient =
+ (**
+ @param on_use_hint function invoked when an hint is used, argumnet is the hint
+ to use
+ @param on_exit function invoked when client is exiting (e.g. window is
+ destroyed, if it's None "self#quit" is invoked
+ *)
+class hbugsClient
+ ?(use_hint_callback: hint -> unit = (fun _ -> ()))
+ ()
+ =
let http_url_RE = Pcre.regexp "^(http://)?(.*):(\\d+)" in
let port_of_http_url url =
object (self)
- inherit Gui.hbugsMainWindow ()
-
- val subscribeWindow = new Gui.subscribeWindow ()
- val messageDialog = new Gui.messageDialog ()
+ val mainWindow = new Hbugs_client_gui.hbugsMainWindow ()
+ val subscribeWindow = new Hbugs_client_gui.subscribeWindow ()
+ val messageDialog = new Hbugs_client_gui.messageDialog ()
val myOwnId = Hbugs_id_generator.new_client_id ()
+ val mutable use_hint_callback = use_hint_callback
val mutable myOwnUrl = "localhost:49082"
val mutable brokerUrl = "localhost:49081"
val mutable brokerId: broker_id option = None
+ (* all available tutors, saved last time a List_tutors message was sent to
+ broker *)
+ val mutable availableTutors: tutor_dsc list = []
+ (* id of highlighted tutors in tutor subscription window *)
val mutable selectedTutors: tutor_id list = []
val mutable statusContext = None
val mutable subscribeWindowStatusContext = None
val mutable debug = false (* enable/disable debugging buttons *)
+ val mutable hints = [] (* actually available hints *)
initializer
-(* self#setDebug global_debug; *)
self#initGui;
self#startLocalHttpDaemon ();
self#testLocalHttpDaemon ();
self#testBroker ();
- self#registerClient ();
+ self#registerToBroker ();
self#reconfigDebuggingButtons
- method debugButtons =
+ method show = mainWindow#hbugsMainWindow#show
+ method hide = mainWindow#hbugsMainWindow#misc#hide
+
+ method setUseHintCallback callback =
+ use_hint_callback <- callback
+
+ method private debugButtons =
List.map
(fun (b: GButton.button) -> new GObj.misc_ops b#as_widget)
- [ self#startLocalHttpDaemonButton; self#testLocalHttpDaemonButton;
- self#testBrokerButton; self#registerClientButton;
- self#unregisterClientButton ]
+ [ mainWindow#startLocalHttpDaemonButton;
+ mainWindow#testLocalHttpDaemonButton; mainWindow#testBrokerButton;
+ mainWindow#registerClientButton; mainWindow#unregisterClientButton ]
method private initGui =
(* GUI: main window *)
- ignore (self#hbugsMainWindow#connect#destroy self#quit);
+ let on_exit = fun () -> self#quit (); false in
+ ignore (mainWindow#hbugsMainWindow#event#connect#destroy
+ (fun _ -> on_exit ()));
+ ignore (mainWindow#hbugsMainWindow#event#connect#delete
+ (fun _ -> on_exit ()));
(* GUI main window's menu *)
- self#toggleDebuggingMenuItem#set_active debug;
- ignore (self#toggleDebuggingMenuItem#connect#toggled self#toggleDebug);
+ mainWindow#toggleDebuggingMenuItem#set_active debug;
+ ignore (mainWindow#toggleDebuggingMenuItem#connect#toggled
+ self#toggleDebug);
(* GUI: local HTTP daemon settings *)
- ignore (self#clientUrlEntry#connect#changed
- (fun _ -> myOwnUrl <- self#clientUrlEntry#text));
- self#clientUrlEntry#set_text myOwnUrl;
- ignore (self#startLocalHttpDaemonButton#connect#clicked
+ ignore (mainWindow#clientUrlEntry#connect#changed
+ (fun _ -> myOwnUrl <- mainWindow#clientUrlEntry#text));
+ mainWindow#clientUrlEntry#set_text myOwnUrl;
+ ignore (mainWindow#startLocalHttpDaemonButton#connect#clicked
self#startLocalHttpDaemon);
- ignore (self#testLocalHttpDaemonButton#connect#clicked
+ ignore (mainWindow#testLocalHttpDaemonButton#connect#clicked
self#testLocalHttpDaemon);
(* GUI: broker choice *)
- ignore (self#brokerUrlEntry#connect#changed
- (fun _ -> brokerUrl <- self#brokerUrlEntry#text));
- self#brokerUrlEntry#set_text brokerUrl;
- ignore (self#testBrokerButton#connect#clicked self#testBroker);
- self#clientIdLabel#set_text myOwnId;
+ ignore (mainWindow#brokerUrlEntry#connect#changed
+ (fun _ -> brokerUrl <- mainWindow#brokerUrlEntry#text));
+ mainWindow#brokerUrlEntry#set_text brokerUrl;
+ ignore (mainWindow#testBrokerButton#connect#clicked self#testBroker);
+ mainWindow#clientIdLabel#set_text myOwnId;
(* GUI: client registration *)
- ignore (self#registerClientButton#connect#clicked self#registerClient);
- ignore (self#unregisterClientButton#connect#clicked
- self#unregisterClient);
+ ignore (mainWindow#registerClientButton#connect#clicked
+ self#registerToBroker);
+ ignore (mainWindow#unregisterClientButton#connect#clicked
+ self#unregisterFromBroker);
(* GUI: subscriptions *)
- ignore (self#showSubscriptionWindowButton#connect#clicked
+ ignore (mainWindow#showSubscriptionWindowButton#connect#clicked
(fun () ->
self#listTutors ();
subscribeWindow#subscribeWindow#show ()));
- (* GUI: DEBUG state change *)
- ignore (self#stateChangeButton#connect#clicked self#stateChange);
-
(* GUI: hints list *)
- ignore (self#useHintButton#connect#clicked self#useHint);
+ ignore (mainWindow#hintsCList#connect#select_row
+ (fun ~row ~column ~event ->
+ match event with
+ | Some event when GdkEvent.get_type event = `TWO_BUTTON_PRESS ->
+ use_hint_callback (self#hint row)
+ | _ -> ()));
(* GUI: main status bar *)
- let ctxt = self#mainWindowStatusBar#new_context "0" in
+ let ctxt = mainWindow#mainWindowStatusBar#new_context "0" in
statusContext <- Some ctxt;
ignore (ctxt#push "Ready");
(fun ~row ~column ~event ->
selectedTutors <-
List.filter ((<>) (tutor_id_of_row row)) selectedTutors));
- ignore (subscribeWindow#subscribeButton#connect#clicked self#subscribe);
+ ignore (subscribeWindow#subscribeButton#connect#clicked
+ self#subscribeSelected);
+ ignore (subscribeWindow#subscribeAllButton#connect#clicked
+ self#subscribeAll);
let ctxt = subscribeWindow#subscribeWindowStatusBar#new_context "0" in
subscribeWindowStatusContext <- Some ctxt;
ignore (ctxt#push "Ready");
(** create a new thread which sends msg to broker, wait for an answer and
invoke callback passing response message as argument *)
- method private sendReq ~msg callback =
+ method private sendReq ?(wait = false) ~msg callback =
let thread () =
try
callback (Hbugs_messages.submit_req ~url:(brokerUrl ^ "/act") msg)
"Parse_error, unable to fullfill request. Details follow.
Request: %s
Error: %s"
- (Hbugs_messages.string_of_msg msg) (Printexc.to_string e))
+ (Hbugs_messages.string_of_msg msg) (Printexc.to_string e));
| (Unix.Unix_error _) as e ->
self#showDialog
(sprintf
Url: %s
Error: %s"
brokerUrl (Printexc.to_string e))
+ | e ->
+ self#showDialog
+ (sprintf "hbugsClient#sendReq: Uncaught exception: %s"
+ (Printexc.to_string e))
in
- ignore (Thread.create thread ())
+ let th = Thread.create thread () in
+ if wait then
+ Thread.join th
+ else ()
(** check if a broker is authenticated using its broker_id
[ Background: during client registration, client save broker_id of its
(* actions *)
- method startLocalHttpDaemon () =
+ method private startLocalHttpDaemon =
+ (* flatten an hint tree to an hint list *)
+ let rec flatten_hint = function
+ | Hints hints -> List.concat (List.map flatten_hint hints)
+ | hint -> [hint]
+ in
+ fun () ->
let callback req outchan =
try
(match Hbugs_messages.msg_of_string req#body with
Hbugs_messages.respond_msg
(Usage "Local Http Daemon up and running!") outchan
| Hint (broker_id, hint) ->
- if self#isAuthenticated broker_id then
- ignore (self#hintsCList#append [hint])
- else
+ if self#isAuthenticated broker_id then begin
+ let received_hints = flatten_hint hint in
+ List.iter
+ (fun h ->
+ (match h with Hints _ -> assert false | _ -> ());
+ ignore (mainWindow#hintsCList#append [string_of_hint h]))
+ received_hints;
+ hints <- hints @ received_hints;
+ Hbugs_messages.respond_msg (Wow myOwnId) outchan
+ end else (* msg from unauthorized broker *)
Hbugs_messages.respond_exc "forbidden" broker_id outchan
| msg ->
Hbugs_messages.respond_exc
only as a value to be sent to broker, local HTTP
daemon will listen on "0.0.0.0", port is parsed
from My URL though *)
- let thread () =
+ let httpDaemonThread () =
try
Http_daemon.start'
~addr ~port:(port_of_http_url myOwnUrl) ~mode:`Single callback
self#showDialog (sprintf "Can't start local HTTP daemon: %s"
(Printexc.to_string e))
in
- ignore (Thread.create thread ())
+ ignore (Thread.create httpDaemonThread ())
- method testLocalHttpDaemon () =
+ method private testLocalHttpDaemon () =
try
let msg =
Hbugs_misc.http_post ~body:(Hbugs_messages.string_of_msg Help)
"Handshake with local HTTP daemon failed, can't connect: \"%s\""
(Printexc.to_string e))
- method testBroker () =
+ method private testBroker () =
self#sendReq ~msg:Help
(function
| Usage _ -> ()
"Handshake with HBugs Broker failed, unexpected message:\n%s"
(Hbugs_messages.string_of_msg unexpected_msg)))
- method registerClient () =
+ method registerToBroker () =
self#sendReq ~msg:(Register_client (myOwnId, myOwnUrl))
(function
| Client_registered broker_id ->
(sprintf "Client NOT registered, unexpected message:\n%s"
(Hbugs_messages.string_of_msg unexpected_msg)))
- method unregisterClient () =
- self#sendReq ~msg:(Unregister_client myOwnId)
+ method unregisterFromBroker () =
+ self#sendReq ~wait:true ~msg:(Unregister_client myOwnId)
self#showMsgInDialog
- method stateChange () =
- let state = (* TODO fill with a real state representation! *)
- self#stateText#get_chars 0 (self#stateText#length)
- in
- self#sendReq ~msg:(State_change (myOwnId, state))
- self#showMsgInDialog
+ method stateChange new_state =
+ self#sendReq
+ ~msg:(State_change (myOwnId, new_state))
+ (function
+ | State_accepted _ ->
+ mainWindow#hintsCList#clear ();
+ hints <- []
+ | unexpected_msg ->
+ self#showDialog
+ (sprintf "State NOT accepted by Hbugs, unexpected message:\n%s"
+ (Hbugs_messages.string_of_msg unexpected_msg)))
- method listTutors () =
- self#sendReq ~msg:(List_tutors myOwnId)
+ method hint = List.nth hints
+
+ method private listTutors () =
+ (* wait is set to true just to make sure that after invoking listTutors
+ "availableTutors" is correctly filled *)
+ self#sendReq ~wait:true ~msg:(List_tutors myOwnId)
(function
| Tutor_list (_, descriptions) ->
+ availableTutors <- (* sort accordingly to tutor description *)
+ List.sort (fun (a,b) (c,d) -> compare (b,a) (d,c)) descriptions;
selectedTutors <- [];
subscribeWindow#tutorsCList#clear ();
List.iter
(fun (id, dsc) ->
ignore (subscribeWindow#tutorsCList#append [id; dsc]))
- descriptions
+ availableTutors
| unexpected_msg ->
self#showDialog
(sprintf "Can't list tutors, unexpected message:\n%s"
(Hbugs_messages.string_of_msg unexpected_msg)))
- method subscribe () =
- let selectedTutors = List.sort compare selectedTutors in
- self#sendReq ~msg:(Subscribe (myOwnId, selectedTutors))
+ (* low level used by subscribeSelected and subscribeAll *)
+ method private subscribe' tutors_id =
+ self#sendReq ~msg:(Subscribe (myOwnId, tutors_id))
(function
- | (Subscribed (_, tutors)) as msg ->
- let msg_string = Hbugs_messages.string_of_msg msg in
- let subscribedTutors = List.sort compare tutors in
- let msg =
- if subscribedTutors = selectedTutors then
- sprintf "Subscription OK\n: %s" msg_string
- else
- sprintf "Subscription mismatch\n: %s" msg_string
- in
- self#showDialog msg;
- subscribeWindow#subscribeWindow#misc#hide ()
+ | (Subscribed (_, subscribedTutors)) as msg ->
+ let sort = List.sort compare in
+ mainWindow#subscriptionCList#clear ();
+ List.iter
+ (fun tutor_id ->
+ ignore
+ (mainWindow#subscriptionCList#append
+ [ try
+ List.assoc tutor_id availableTutors;
+ with Not_found -> assert false ]))
+ tutors_id;
+ subscribeWindow#subscribeWindow#misc#hide ();
+ if sort subscribedTutors <> sort tutors_id then
+ self#showDialog
+ (sprintf "Subscription mismatch\n: %s"
+ (Hbugs_messages.string_of_msg msg))
| unexpected_msg ->
+ mainWindow#subscriptionCList#clear ();
self#showDialog
(sprintf "Subscription FAILED, unexpected message:\n%s"
(Hbugs_messages.string_of_msg unexpected_msg)))
- method useHint () = failwith "useHint: TODO not implemented" (* TODO *)
+ method private subscribeSelected () = self#subscribe' selectedTutors
+
+ method subscribeAll () =
+ self#listTutors (); (* this fills 'availableTutors' field *)
+ self#subscribe' (List.map fst availableTutors)
method private quit () =
- self#unregisterClient ();
+ self#unregisterFromBroker ();
GMain.Main.quit ()
- (** enable/disable debugging buttons *)
- method setDebug ?(force = false) value =
- if (debug <> value) || force then
- debug <- value
+ (** enable/disable debugging *)
+ method private setDebug value = debug <- value
method private reconfigDebuggingButtons =
List.iter (* debug value changed, reconfigure buttons *)
(fun (b: GObj.misc_ops) -> if debug then b#show () else b#hide ())
self#debugButtons;
- method toggleDebug () =
+ method private toggleDebug () =
self#setDebug (not debug);
self#reconfigDebuggingButtons
end
;;
-ignore (new hbugsClient);
-GtkThread.main ()
-
projects / helm.git / blobdiff