ejabberd分析(一)

1.客戶端連接服務器，並發送消息給服務器的處理在ejabberd_c2s中。

   ejabberd_c2s 是一個gen_fsm 狀態機，在 ejabberd啟動時裝載。

   初始狀態為 wait_for_stream，接受形為 {xmlstreamstart, _Name, Attrs} 的消息，其他任何消息都會導致stop。

   接受到連接請求，發送feature 請求后狀態改為wait_for_feature_request 。

   接受到feature 再發送challenge 后，狀態改為 wait_for_sasl_response。

   經過sasl鑒權后，狀態改為 wait_for_stream， 此時 StateData#state.authenticated 已經不為false。

   客戶端重新發起<stream> 連接請求，服務器發送bind 消息，狀態改為 wait_for_bind 。

   客戶端發送bind 與資源綁定，服務器按照策略驗證是否允許相同的用戶用不同的資源連接，通過后狀態改為 wait_for_session。

   客戶端發送<iq> 消息創建session，服務器調用 ejabberd_sm:open_session 后將狀態改為 session_established。

   客戶端發送普通的通信消息<iq>，<presence>，<message> 等，都通過session_established2/2 函數處理。

%% Process packets sent by user (coming from user on c2s XMPP %% connection) session_established2(El, StateData) -> %%從變量El中取出Name,Attrs 兩個參數,El必須是一個以xmlelement 為第一個元子的元組 {xmlelement, Name, Attrs, _Els} = El, %%從StateDate中取出user,server,jid User = StateData#state.user, Server = StateData#state.server, FromJID = StateData#state.jid, %%從Attrs屬性變量中獲取to(也就是發送給誰) To = xml:get_attr_s("to", Attrs), %%將To轉換成一個標准的JID: %%#jid{user,server,resource,luser,lserver,lresource},具體參見jlib.erl中的定義 ToJID = case To of "" -> jlib:make_jid(User, Server, ""); _ -> jlib:string_to_jid(To) end, %%這里的El里的Attrs應該是一個元組組成的列表[{key1,value1},{key2,value2},{key3,value3},{key4,value4}.....] %%下面的語句會從Attrs中刪除key 為xmlns的元組，並返回新的El存放到NewEl1中 NewEl1 = jlib:remove_attr("xmlns", El), NewEl = case xml:get_attr_s("xml:lang", Attrs) of "" -> case StateData#state.lang of "" -> NewEl1; Lang -> xml:replace_tag_attr("xml:lang", Lang, NewEl1) end; _ -> NewEl1 end, %%這里根據消息類型進行不同的處理 NewState = case ToJID of error -> case xml:get_attr_s("type", Attrs) of "error" -> StateData; "result" -> StateData; _ -> Err = jlib:make_error_reply(NewEl, ?ERR_JID_MALFORMED), send_element(StateData, Err), StateData end; _ -> case Name of "presence" -> %%如果為一個presence 消息,使用函數回調c2s_updatepresence參見2 PresenceEl = ejabberd_hooks:run_fold( c2s_update_presence, Server, NewEl, [User, Server]), %%將調用結果發送回客戶端   ejabberd_hooks:run( user_send_packet, Server, [FromJID, ToJID, PresenceEl]), case ToJID of #jid{user = User, server = Server, resource = ""} -> ?DEBUG("presence_update(~p,~n\t~p,~n\t~p)", [FromJID, PresenceEl, StateData]), presence_update(FromJID, PresenceEl, StateData); _ -> presence_track(FromJID, ToJID, PresenceEl, StateData) end; "iq" -> %%iq 消息的處理.注冊,添加好友等都是通過iq消息來發送的  case jlib:iq_query_info(NewEl) of #iq{xmlns = Xmlns} = IQ when Xmlns == ?NS_PRIVACY; Xmlns == ?NS_BLOCKING -> process_privacy_iq( FromJID, ToJID, IQ, StateData); _ -> ejabberd_hooks:run( user_send_packet, Server, [FromJID, ToJID, NewEl]), check_privacy_route(FromJID, StateData, FromJID, ToJID, NewEl), StateData end; "message" -> io:format("message arrvied~n",[]), ejabberd_hooks:run(user_send_packet, Server, [FromJID, ToJID, NewEl]), check_privacy_route(FromJID, StateData, FromJID, ToJID, NewEl), StateData; _ -> StateData end end, ejabberd_hooks:run(c2s_loop_debug, [{xmlstreamelement, El}]), fsm_next_state(session_established, NewState).

2.下面是比較關鍵的ejabberd中函數調用的分析:

run_fold(Hook, Host, Val, Args) -> case ets:lookup(hooks, {Hook, Host}) of [{_, Ls}] ->run_fold1(Ls, Hook, Val, Args); [] ->Val end. <pre name="code" class="plain">PresenceEl = ejabberd_hooks:run_fold( c2s_update_presence, Server, NewEl, [User, Server])

在系統的ets庫(內存中的一個數據庫)中存有一個名為hooks的表,通過ets:lookup(hooks,{Hook,Host}) 可以找到一個 {_,Ls}的元組 (找不到就直接返回預定義的Val了),然后調用run_fold1(Ls,Hook,Val,Args).

Ls變量實際上是一個包含多個要具體調用的函數定義的列表,列表里面的元組分為兩類:[{_Seq, Node,Moudle,Function} | Ls2]  [{_Seq,Module,Function} | Ls2],

run_fold1/4 的作用就是使用Args參數依次調用這個Ls列表里的方法.

run_fold1/4 最終會返回調用的結果出來.

所以從最終結果來看 ejabberd_hooks:run_fold/4  方法就是去表hooks查找並調用所需的函數返回調用結果.

PresenceEl = ejabberd_hooks:run_fold( c2s_update_presence, Server, NewEl, [User, Server]) 針對上面的代碼就是:

        使用{c2s_update_presence,Server}作為key 在表hooks 中查找 要調用的方法列表,並使用[User,Server] 作為參數進行調用.

這個key具體找到什么樣的方法呢? 我們可以在源碼中查找下:

root@ubuntu: grep *.erl -e c2s_update_presence
查找結果中可以看到

mod_vcard_xupdate.erl               ejabberd_hooks:add(c2s_update_presence, Host

我們在mod_vcard_xupdate.erl中找到這段代碼:

start(Host, _Opts) -> mnesia:create_table(vcard_xupdate, [{disc_copies, [node()]}, {attributes, record_info(fields, vcard_xupdate)}]), ejabberd_hooks:add(c2s_update_presence, Host, ?MODULE, update_presence, 100), ejabberd_hooks:add(vcard_set, Host, ?MODULE, vcard_set, 100), ok.
update_presence就所我們所要找的方法了.