Zarządzanie kontaktami
W tej sekcji przedstawiono, jak znaleźć i dodać kontakt z DHT do klienta.
Obecność w sieci
Ogłaszaj obecność na DHT
Obecność jest dość prosta do ogłoszenia na DHT. W rzeczywistości jest to tylko wartość zawierająca hash urządzenia (patrz poprzedni rozdział, Zarządzanie kontami) na hash odpowiadającym odciskowi palca klucza. Więc, jeśli mamy konto bf5f1e21d3eb2c1246946aa49d5dcf3e5b9cb1b9 z urządzeniem 62fbdff0ce86f368c7d3c2682539e5ba9e06404f, następująca zdefiniowana wartość zostanie wysłana przez DHT:
/**
* Device announcement stored on DHT.
*/
struct DeviceAnnouncement : public dht::SignedValue<DeviceAnnouncement>
{
private:
using BaseClass = dht::SignedValue<DeviceAnnouncement>;
public:
static const constexpr dht::ValueType& TYPE = dht::ValueType::USER_DATA;
dht::InfoHash dev;
std::shared_ptr<dht::crypto::PublicKey> pk;
MSGPACK_DEFINE_MAP(dev, pk)
};
(Ta wartość można umieścić z dht_.put(h, VALUE, dht::DoneCallback{}, {}, true);, jako stały wstawiony). Jeśli urządzenie jest ogłoszone, urządzenie jest obecne.
/Zapisz, jeśli jest kontakt /
Teraz nasza obecność w sieci, nadszedł czas, aby sprawdzić, czy ktoś jest obecny w DHT. Dzięki poprzedniej sekcji łatwo jest wykonać proces odwrotny. Aby dowiedzieć się, czy ktoś jest obecny na DHT (np. bf5f1e21d3eb2c1246946aa49d5dcf3e5b9cb1b9), musimy uzyskać wartość w bf5f1e21d3eb2c1246946aa49d5dcf3e5b9cb1b9 i pobrać DeviceAnnouncement z tego hasha. Powiązany kod w demonie znajduje się w jamiaccount.cpp:
auto shared = std::static_pointer_cast<RingAccount>(shared_from_this());
auto treatedDevices = std::make_shared<std::set<dht::InfoHash>>();
dht_.get<dht::crypto::RevocationList>(to, [to](dht::crypto::RevocationList&& crl){
tls::CertificateStore::instance().pinRevocationList(to.toString(), std::move(crl));
return true;
});
dht_.get<DeviceAnnouncement>(to, [shared,to,treatedDevices,op](DeviceAnnouncement&& dev) {
if (dev.from != to)
return true;
if (treatedDevices->emplace(dev.dev).second)
op(shared, dev.dev);
return true;
}, [=](bool /*ok*/){
{
std::lock_guard<std::recursive_mutex> lock(shared->buddyInfoMtx);
auto buddy_info_it = shared->trackedBuddies_.find(to);
if (buddy_info_it != shared->trackedBuddies_.end()) {
if (not treatedDevices->empty()) {
for (auto& device_id : *treatedDevices)
shared->onTrackedBuddyOnline(buddy_info_it, device_id);
} else
shared->onTrackedBuddyOffline(buddy_info_it);
}
}
RING_DBG("[Account %s] found %lu devices for %s",
getAccountID().c_str(), treatedDevices->size(), to.to_c_str());
if (end) end(shared, not treatedDevices->empty());
});
I to wszystko.
Perspektywa klienta
<method name="subscribeBuddy" tp:name-for-bindings="subscribeBuddy">
<tp:docstring>
Ask be be notified when 'uri' presence change
</tp:docstring>
<tp:added version="1.3.0"/>
<arg type="s" name="accountID" direction="in">
<tp:docstring>
An account from which get request presence informations
</tp:docstring>
</arg>
<arg type="s" name="uri" direction="in">
<tp:docstring>
A SIP uri to watch
</tp:docstring>
</arg>
<arg type="b" name="flag" direction="in">
<tp:docstring>
</tp:docstring>
</arg>
</method>
<signal name="newBuddyNotification" tp:name-for-bindings="newBuddyNotification">
<tp:added version="1.3.0"/>
<tp:docstring>
Notify when a registered presence uri presence informations changes
</tp:docstring>
<arg type="s" name="accountID">
<tp:docstring>
The associated account
</tp:docstring>
</arg>
<arg type="s" name="buddyUri">
<tp:docstring>
The registered URI
</tp:docstring>
</arg>
<arg type="i" name="status">
<tp:docstring>
Is the URI present or not
</tp:docstring>
</arg>
<arg type="s" name="lineStatus">
<tp:docstring>
A string containing informations from the user (human readable)
</tp:docstring>
</arg>
</signal>
<method name="publish" tp:name-for-bindings="publish">
<tp:added version="1.3.0"/>
<arg type="s" name="accountID" direction="in">
<tp:docstring>
The account from which the presence will be emitted
</tp:docstring>
</arg>
<arg type="b" name="status" direction="in">
<tp:docstring>
Is this account present or not
</tp:docstring>
</arg>
<arg type="s" name="note" direction="in">
<tp:docstring>
A message transmitted by the server to other users
</tp:docstring>
</arg>
</method>
Są to główne interfejsy API dla klientów. subscribeBuddy będzie nasłuchiwać na DHT, aby wykryć zmiany obecności, a newBuddyNotification zostanie wysłane za każdym razem, gdy zostanie wykryty nowy status:
Status wysyłany do klienta to teraz 0=offline (nie znaleziono urządzenia na DHT), 1=dht_presence (przynajmniej urządzenie zostało znalezione na DHT), 2=connected (z kanałem TCP + SIP, więc gotowe do wymiany danych).
lineStatusbędzie zawierać dowolny niestandardowy status wysłany przez peera (np. Lunch Time!).
publish służy do publikowania niestandardowej notatki (status jest ignorowany dla kont Jami, notatka będzie zawierać niestandardowy status).
RFC3863 służy do wysyłania statusu przez połączenie SIP.
Wniosek w trybie widocznym
Wysyłać wniosek
Zapytanie na statki TODO
Wreszcie, po wypracowaniu wniosku o zaufanie, możemy przesunąć wniosek do następującego hash: InfoHash("box:" + deviceId)
W daemonie używany jest następujący kod:
dht_.putEncrypted(dht::InfoHash::get("inbox:"+dev.toString()), dev, dht::TrustRequest(DHT_TYPE_NS, payload));
Otrzymanie wniosku
TDO
(Akceptacja/blokowanie/odchylenie)
API Daemon
Wszystkie metody śledzenia obecności przyjaciela znajdują się w PresenceManager, np.:
<signal name="newBuddyNotification" tp:name-for-bindings="newBuddyNotification">
<tp:added version="1.3.0"/>
<tp:docstring>
Notify when a registered presence uri presence informations changes
</tp:docstring>
<arg type="s" name="accountID">
<tp:docstring>
The associated account
</tp:docstring>
</arg>
<arg type="s" name="buddyUri">
<tp:docstring>
The registered URI
</tp:docstring>
</arg>
<arg type="b" name="status">
<tp:docstring>
Is the URI present or not
</tp:docstring>
</arg>
<arg type="s" name="lineStatus">
<tp:docstring>
A string containing informations from the user (human readable)
</tp:docstring>
</arg>
</signal>
Wszystkie metody i sygnały wykorzystywane do zarządzania prośbami o zaufanie i kontaktami znajdują się w KonfigurationManager, np.:
<method name="getTrustRequests" tp:name-for-bindings="getTrustRequests">
<tp:added version="2.2.0"/>
<arg type="s" name="accountID" direction="in">
</arg>
<annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="VectorMapStringString"/>
<arg type="aa{ss}" name="requests" direction="out" >
<tp:docstring>
A list of contact request details. Details:
- from: account ID of sender
- received: UNIX timestamp of reception date
- payload: attached payload
</tp:docstring>
</arg>
</method>
<method name="acceptTrustRequest" tp:name-for-bindings="acceptTrustRequest">
<tp:added version="2.2.0"/>
<arg type="s" name="accountID" direction="in">
</arg>
<arg type="s" name="from" direction="in">
</arg>
<arg type="b" name="success" direction="out" tp:type="Boolean">
<tp:docstring>
True if the operation succeeded.
</tp:docstring>
</arg>
</method>
<method name="discardTrustRequest" tp:name-for-bindings="discardTrustRequest">
<tp:added version="2.2.0"/>
<arg type="s" name="accountID" direction="in">
</arg>
<arg type="s" name="from" direction="in">
</arg>
<arg type="b" name="success" direction="out" tp:type="Boolean">
<tp:docstring>
True if the operation succeeded.
</tp:docstring>
</arg>
</method>
<signal name="incomingTrustRequest" tp:name-for-bindings="incomingTrustRequest">
<tp:added version="2.2.0"/>
<tp:docstring>
Notify clients that a new contact request has been received.
</tp:docstring>
<arg type="s" name="accountID">
</arg>
<arg type="s" name="from">
</arg>
<arg type="ay" name="payload">
</arg>
<arg type="t" name="receiveTime">
</arg>
</signal>
<method name="sendTrustRequest" tp:name-for-bindings="sendTrustRequest">
<tp:added version="2.2.0"/>
<arg type="s" name="accountID" direction="in">
</arg>
<arg type="s" name="to" direction="in">
</arg>
<arg type="ay" name="payload" direction="in">
</arg>
</method>
<method name="addContact" tp:name-for-bindings="addContact">
<tp:added version="3.0.0"/>
<arg type="s" name="accountID" direction="in">
</arg>
<arg type="s" name="uri" direction="in">
</arg>
</method>
<method name="removeContact" tp:name-for-bindings="removeContact">
<tp:added version="3.0.0"/>
<arg type="s" name="accountID" direction="in">
</arg>
<arg type="s" name="uri" direction="in">
</arg>
<arg type="b" name="ban" direction="in" tp:type="Boolean">
<tp:docstring>
True if the the contact should be banned.
If false, the contact is removed from the contact list (banned or not).
</tp:docstring>
</arg>
</method>
Jeśli chcesz kilka przykładów, te metody są używane w contactmodel.cpp w LRC.