summaryrefslogtreecommitdiff
path: root/indra/llmessage/llavatarname.cpp
blob: d12f15791002dccfe538177a743890e98fb9fb1b (plain)
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
/** 
 * @file llavatarname.cpp
 * @brief Represents name-related data for an avatar, such as the
 * username/SLID ("bobsmith123" or "james.linden") and the display
 * name ("James Cook")
 *
 * $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$
 */
#include "linden_common.h"

#include "llavatarname.h"

#include "lldate.h"
#include "llframetimer.h"
#include "llsd.h"

// Store these in pre-built std::strings to avoid memory allocations in
// LLSD map lookups
static const std::string USERNAME("username");
static const std::string DISPLAY_NAME("display_name");
static const std::string LEGACY_FIRST_NAME("legacy_first_name");
static const std::string LEGACY_LAST_NAME("legacy_last_name");
static const std::string IS_DISPLAY_NAME_DEFAULT("is_display_name_default");
static const std::string DISPLAY_NAME_EXPIRES("display_name_expires");
static const std::string DISPLAY_NAME_NEXT_UPDATE("display_name_next_update");

bool LLAvatarName::sUseDisplayNames = true;
bool LLAvatarName::sUseUsernames = true;

// Minimum time-to-live (in seconds) for a name entry.
// Avatar name should always guarantee to expire reasonably soon by default
// so if the failure to get a valid expiration time was due to something temporary 
// we will eventually request and get the right data.
const F64 MIN_ENTRY_LIFETIME = 60.0;

LLAvatarName::LLAvatarName()
:	mUsername(),
	mDisplayName(),
	mLegacyFirstName(),
	mLegacyLastName(),
	mIsDisplayNameDefault(false),
	mIsTemporaryName(false),
	mExpires(F64_MAX),
	mNextUpdate(0.0)
{ }

bool LLAvatarName::operator<(const LLAvatarName& rhs) const
{
	if (mUsername == rhs.mUsername)
		return mDisplayName < rhs.mDisplayName;
	else
		return mUsername < rhs.mUsername;
}

//static 
void LLAvatarName::setUseDisplayNames(bool use)
{
	sUseDisplayNames = use;
}
//static 
bool LLAvatarName::useDisplayNames() 
{ 
	return sUseDisplayNames; 
}

void LLAvatarName::setUseUsernames(bool use)
{
	sUseUsernames = use;
}

bool LLAvatarName::useUsernames()
{
	return sUseUsernames;
}

LLSD LLAvatarName::asLLSD() const
{
	LLSD sd;
	sd[USERNAME] = mUsername;
	sd[DISPLAY_NAME] = mDisplayName;
	sd[LEGACY_FIRST_NAME] = mLegacyFirstName;
	sd[LEGACY_LAST_NAME] = mLegacyLastName;
	sd[IS_DISPLAY_NAME_DEFAULT] = mIsDisplayNameDefault;
	sd[DISPLAY_NAME_EXPIRES] = LLDate(mExpires);
	sd[DISPLAY_NAME_NEXT_UPDATE] = LLDate(mNextUpdate);
	return sd;
}

void LLAvatarName::fromLLSD(const LLSD& sd)
{
	mUsername = sd[USERNAME].asString();
	mDisplayName = sd[DISPLAY_NAME].asString();
	mLegacyFirstName = sd[LEGACY_FIRST_NAME].asString();
	mLegacyLastName = sd[LEGACY_LAST_NAME].asString();
	mIsDisplayNameDefault = sd[IS_DISPLAY_NAME_DEFAULT].asBoolean();
	LLDate expires = sd[DISPLAY_NAME_EXPIRES];
	mExpires = expires.secondsSinceEpoch();
	LLDate next_update = sd[DISPLAY_NAME_NEXT_UPDATE];
	mNextUpdate = next_update.secondsSinceEpoch();
	
	// Some avatars don't have explicit display names set. Force a legible display name here.
	if (mDisplayName.empty())
	{
		mDisplayName = mUsername;
	}
}

// Transform a string (typically provided by the legacy service) into a decent
// avatar name instance.
void LLAvatarName::fromString(const std::string& full_name)
{
	mDisplayName = full_name;
	std::string::size_type index = full_name.find(' ');
	if (index != std::string::npos)
	{
		// The name is in 2 parts (first last)
		mLegacyFirstName = full_name.substr(0, index);
		mLegacyLastName = full_name.substr(index+1);
		if (mLegacyLastName != "Resident")
		{
			mUsername = mLegacyFirstName + "." + mLegacyLastName;
			mDisplayName = full_name;
			LLStringUtil::toLower(mUsername);
		}
		else
		{
			// Very old names do have a dummy "Resident" last name 
			// that we choose to hide from users.
			mUsername = mLegacyFirstName;
			mDisplayName = mLegacyFirstName;
		}
	}
	else
	{
		mLegacyFirstName = full_name;
		mLegacyLastName = "";
		mUsername = full_name;
		mDisplayName = full_name;
	}
	mIsDisplayNameDefault = true;
	mIsTemporaryName = true;
	setExpires(MIN_ENTRY_LIFETIME);
}

void LLAvatarName::setExpires(F64 expires)
{
	mExpires = LLFrameTimer::getTotalSeconds() + expires;
}

std::string LLAvatarName::getCompleteName() const
{
	std::string name;
	if (sUseDisplayNames)
	{
		if (mUsername.empty() || mIsDisplayNameDefault)
		{
			// If this particular display name is defaulted (i.e. based on user name),
			// then display only the easier to read instance of the person's name.
			name = mDisplayName;
		}
		else
		{
			name = mDisplayName;
			if(sUseUsernames)
			{
				name += " (" + mUsername + ")";
			}
		}
	}
	else
	{
		name = getUserName();
	}
	return name;
}

std::string LLAvatarName::getLegacyName() const
{
	if (mLegacyFirstName.empty() && mLegacyLastName.empty()) // display names disabled?
	{
		return mDisplayName;
	}

	std::string name;
	name.reserve( mLegacyFirstName.size() + 1 + mLegacyLastName.size() );
	name = mLegacyFirstName;
	name += " ";
	name += mLegacyLastName;
	return name;
}

std::string LLAvatarName::getDisplayName() const
{
	if (sUseDisplayNames)
	{
		return mDisplayName;
	}
	else
	{
		return getUserName();
	}
}

std::string LLAvatarName::getUserName() const
{
	std::string name;
	if (mLegacyLastName.empty() || (mLegacyLastName == "Resident"))
	{
		if (mLegacyFirstName.empty())
		{
			// If we cannot create a user name from the legacy strings, use the display name
			name = mDisplayName;
		}
		else
		{
			// The last name might be empty if it defaulted to "Resident"
			name = mLegacyFirstName;
		}
	}
	else
	{
		name = mLegacyFirstName + " " + mLegacyLastName;
	}
	return name;
}

void LLAvatarName::dump() const
{
	LL_DEBUGS("AvNameCache") << "LLAvatarName: "
	                         << "user '" << mUsername << "' "
							 << "display '" << mDisplayName << "' "
	                         << "expires in " << mExpires - LLFrameTimer::getTotalSeconds() << " seconds"
							 << LL_ENDL;
}