c24950b261
Conflicts: indra/newview/llfloateravatarpicker.cpp - Includes to v-d style, since plain alphabetical just won't cut it. Shyotl's changes for name system, here. indra/newview/llpanelgroupinvite.cpp - Shyotl's changes for name system, here. Also corrected new README to have less typos and be slightly more accurate.
115 lines
4.1 KiB
C++
115 lines
4.1 KiB
C++
/**
|
|
* @file llavatarnamecache.h
|
|
* @brief Provides lookup of avatar SLIDs ("bobsmith123") and display names
|
|
* ("James Cook") from avatar UUIDs.
|
|
*
|
|
* $LicenseInfo:firstyear=2010&license=viewerlgpl$
|
|
* Second Life Viewer Source Code
|
|
* Copyright (C) 2010, Linden Research, Inc.
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation;
|
|
* version 2.1 of the License only.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|
*
|
|
* Linden Research, Inc., 945 Battery Street, San Francisco, CA 94111 USA
|
|
* $/LicenseInfo$
|
|
*/
|
|
|
|
#ifndef LLAVATARNAMECACHE_H
|
|
#define LLAVATARNAMECACHE_H
|
|
|
|
#include "llavatarname.h" // for convenience
|
|
|
|
#include <boost/signals2.hpp>
|
|
|
|
class LLUUID;
|
|
class AIHTTPReceivedHeaders;
|
|
|
|
namespace LLAvatarNameCache
|
|
{
|
|
|
|
typedef boost::signals2::signal<void (void)> use_display_name_signal_t;
|
|
|
|
// Until the cache is set running, immediate lookups will fail and
|
|
// async lookups will be queued. This allows us to block requests
|
|
// until we know if the first region supports display names.
|
|
void initClass(bool running);
|
|
void cleanupClass();
|
|
|
|
void importFile(std::istream& istr);
|
|
void exportFile(std::ostream& ostr);
|
|
|
|
// On the viewer, usually a simulator capabilitity
|
|
// If empty, name cache will fall back to using legacy name
|
|
// lookup system
|
|
void setNameLookupURL(const std::string& name_lookup_url);
|
|
|
|
// Do we have a valid lookup URL, hence are we trying to use the
|
|
// new display name lookup system?
|
|
bool hasNameLookupURL();
|
|
|
|
// Periodically makes a batch request for display names not already in
|
|
// cache. Call once per frame.
|
|
void idle();
|
|
|
|
// If name is in cache, returns true and fills in provided LLAvatarName
|
|
// otherwise returns false
|
|
bool get(const LLUUID& agent_id, LLAvatarName *av_name);
|
|
// If get() succeeds, returns true and fills in name string
|
|
// via void function below, otherwise returns false
|
|
bool getPNSName(const LLUUID& agent_id, std::string& name);
|
|
// Perform a filling of name string according to Phoenix Name System,
|
|
// when we have an LLAvatarName already.
|
|
void getPNSName(const LLAvatarName& avatar_name, std::string& name);
|
|
|
|
// Callback types for get() below
|
|
typedef boost::signals2::signal<
|
|
void (const LLUUID& agent_id, const LLAvatarName& av_name)>
|
|
callback_signal_t;
|
|
typedef callback_signal_t::slot_type callback_slot_t;
|
|
typedef boost::signals2::connection callback_connection_t;
|
|
|
|
// Fetches name information and calls callback.
|
|
// If name information is in cache, callback will be called immediately.
|
|
callback_connection_t get(const LLUUID& agent_id, callback_slot_t slot);
|
|
|
|
// Allow display names to be explicitly disabled for testing.
|
|
void setUseDisplayNames(bool use);
|
|
bool useDisplayNames();
|
|
|
|
// [RLVa:KB] - Checked: 2010-12-08 (RLVa-1.4.0a) | Added: RLVa-1.2.2c
|
|
bool getForceDisplayNames();
|
|
void setForceDisplayNames(bool force);
|
|
// [/RLVa:KB]
|
|
|
|
void erase(const LLUUID& agent_id);
|
|
|
|
/// Provide some fallback for agents that return errors
|
|
void handleAgentError(const LLUUID& agent_id);
|
|
|
|
void insert(const LLUUID& agent_id, const LLAvatarName& av_name);
|
|
|
|
// Compute name expiration time from HTTP Cache-Control header,
|
|
// or return default value, in seconds from epoch.
|
|
F64 nameExpirationFromHeaders(AIHTTPReceivedHeaders const& headers);
|
|
|
|
void addUseDisplayNamesCallback(const use_display_name_signal_t::slot_type& cb);
|
|
}
|
|
|
|
// Parse a cache-control header to get the max-age delta-seconds.
|
|
// Returns true if header has max-age param and it parses correctly.
|
|
// Exported here to ease unit testing.
|
|
bool max_age_from_cache_control(const std::string& cache_control, S32 *max_age);
|
|
|
|
#endif
|