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
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
|
/**
* @file LLSyntaxId
* @author Ima Mechanique
* @brief Handles downloading, saving, and checking of LSL keyword/syntax files
* for each region.
*
* $LicenseInfo:firstyear=2013&license=viewerlgpl$
* Second Life Viewer Source Code
* Copyright (C) 2013, 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 "llviewerprecompiledheaders.h"
#include "llhttpclient.h"
#include "llagent.h"
#include "llappviewer.h"
#include "llsdserialize.h"
#include "llsyntaxid.h"
//-----------------------------------------------------------------------------
// fetchKeywordsFileResponder
//-----------------------------------------------------------------------------
fetchKeywordsFileResponder::fetchKeywordsFileResponder(std::string filespec)
{
mFileSpec = filespec;
LL_WARNS("LSLSyntax")
<< "Instantiating with file saving to: '" << filespec << "'"
<< LL_ENDL;
}
void fetchKeywordsFileResponder::errorWithContent(U32 status,
const std::string& reason,
const LLSD& content)
{
LL_WARNS("LSLSyntax")
<< "fetchKeywordsFileResponder error [status:"
<< status
<< "]: "
<< content
<< LL_ENDL;
}
void fetchKeywordsFileResponder::result(const LLSD& content_ref)
{
LLSyntaxIdLSL::setKeywordsXml(content_ref);
std::stringstream str;
LLSDSerialize::toPrettyXML(content_ref, str);
const std::string xml = str.str();
// save the str to disc
llofstream file(mFileSpec, std::ios_base::out);
file.write(xml.c_str(), str.str().size());
file.close();
LL_WARNS("LSLSyntax")
<< "Syntax file received, saving as: '" << mFileSpec << "'"
<< LL_ENDL;
}
LLSD LLSyntaxIdLSL::sKeywordsXml;
//-----------------------------------------------------------------------------
// LLSyntaxIdLSL
//-----------------------------------------------------------------------------
/**
* @brief LLSyntaxIdLSL constructor
*/
LLSyntaxIdLSL::LLSyntaxIdLSL() :
// Move these to signature?
mFileNameDefault("keywords_lsl_default.xml"),
mSimulatorFeature("LSLSyntaxId"),
mCapabilityName("LSLSyntax"),
mCapabilityURL(""),
mFilePath(LL_PATH_APP_SETTINGS)
{
mSyntaxIdCurrent = LLUUID();
mFileNameCurrent = mFileNameDefault;
}
std::string LLSyntaxIdLSL::buildFileNameNew()
{
std::string filename = "keywords_lsl_";
if (!mSyntaxIdNew.isNull())
{
filename += gLastVersionChannel + "_" + mSyntaxIdNew.asString();
}
else
{
filename += mFileNameDefault;
}
mFileNameNew = filename + ".llsd.xml";
return mFileNameNew;
}
std::string LLSyntaxIdLSL::buildFullFileSpec()
{
ELLPath path = mSyntaxIdNew.isNull() ? LL_PATH_APP_SETTINGS : LL_PATH_CACHE;
buildFileNameNew();
mFullFileSpec = gDirUtilp->getExpandedFilename(path, mFileNameNew);
return mFullFileSpec;
}
//-----------------------------------------------------------------------------
// checkSyntaxIdChange()
//-----------------------------------------------------------------------------
bool LLSyntaxIdLSL::checkSyntaxIdChanged()
{
bool changed = false;
LLViewerRegion* region = gAgent.getRegion();
if (region)
{
if (!region->capabilitiesReceived())
{ // Shouldn't be possible, but experience shows that it's needed
//region->setCapabilitiesReceivedCallback(boost::bind(&LLSyntaxIdLSL::checkSyntaxIdChange, this));
LL_WARNS("LSLSyntax")
<< "region '" << region->getName()
<< "' has not received capabilities yet! Setting a callback for when they arrive."
<< LL_ENDL;
}
else
{
// get and check the hash
LLSD simFeatures;
region->getSimulatorFeatures(simFeatures);
if (simFeatures.has("LSLSyntaxId"))
{
mSyntaxIdNew = simFeatures["LSLSyntaxId"].asUUID();
mCapabilityURL = region->getCapability(mCapabilityName);
if (mSyntaxIdCurrent != mSyntaxIdNew)
{
LL_WARNS("LSLSyntax")
<< "Region changed to '" << region->getName()
<< "' it has LSLSyntaxId capability, and the new hash is '"
<< mSyntaxIdNew << "'"
<< LL_ENDL;
changed = true;
}
else
{
LL_WARNS("LSLSyntax")
<< "Region changed to '" << region->getName()
<< "' it has the same LSLSyntaxId! Leaving hash as '"
<< mSyntaxIdCurrent << "'"
<< LL_ENDL;
}
}
else
{
// Set the hash to NULL_KEY to indicate use of default keywords file
if ( mSyntaxIdCurrent.isNull() )
{
LL_WARNS("LSLSyntax")
<< "Region changed to '" << region->getName()
<< " it does not have LSLSyntaxId capability, remaining with default keywords file!"
<< LL_ENDL;
}
else
{
mSyntaxIdNew = LLUUID();
LL_WARNS("LSLSyntax")
<< "Region changed to '" << region->getName()
<< " it does not have LSLSyntaxId capability, using default keywords file!"
<< LL_ENDL;
changed = true;
}
}
}
}
return changed;
}
//-----------------------------------------------------------------------------
// fetchKeywordsFile
//-----------------------------------------------------------------------------
void LLSyntaxIdLSL::fetchKeywordsFile()
{
if ( !mCapabilityURL.empty() )
{
//buildFullFileSpec();
LLHTTPClient::get(mCapabilityURL,
new fetchKeywordsFileResponder(mFullFileSpec),
LLSD(), 30.f
);
LL_WARNS("LSLSyntax")
<< "LSLSyntaxId capability URL is: " << mCapabilityURL
<< ". Filename to use is: '" << mFullFileSpec << "'."
<< LL_ENDL;
}
else
{
LL_WARNS("LSLSyntax")
<< "LSLSyntaxId capability URL is empty using capability: '"
<< mCapabilityName << "'"
<< LL_ENDL;
}
}
void LLSyntaxIdLSL::initialise()
{
if (checkSyntaxIdChanged())
{
LL_WARNS("LSLSyntax")
<< "Change to syntax, setting up new file."
<< LL_ENDL;
// Need a full spec built regardless of file source
buildFullFileSpec();
if ( !mSyntaxIdNew.isNull() )
{
LL_WARNS("LSLSyntax")
<< "ID is not null so must be processed!"
<< LL_ENDL;
if ( !gDirUtilp->fileExists(mFullFileSpec) )
{ // Does not exist, so fetch it from the capability
fetchKeywordsFile();
LL_WARNS("LSLSyntax")
<< "Filename is not cached, we will try to download it!"
<< LL_ENDL;
}
else
{
LL_WARNS("LSLSyntax")
<< "Filename is cached, no need to download!"
<< LL_ENDL;
openKeywordsFile();
}
}
else
{ // Need to open the default
LL_WARNS("LSLSyntax")
<< "ID is null so SyntaxID does not need to be processed!"
<< LL_ENDL;
openKeywordsFile();
}
// TODO add a signal here to tell the editor the hash has changed?
}
else
{
LL_WARNS("LSLSyntax")
<< "No change to Syntax! Nothing to see here. Move along now!"
<< LL_ENDL;
}
//LLEnvManagerNew::instance().setRegionChangeCallback(boost::bind(&LLSyntaxIdLSL::checkSyntaxIdChange(), this));
}
//-----------------------------------------------------------------------------
// openKeywordsFile
//-----------------------------------------------------------------------------
void LLSyntaxIdLSL::openKeywordsFile()
{
LL_WARNS("LSLSyntax")
<< "Trying to open default or cached keyword file ;-)"
<< LL_ENDL;
// TODO Open the file and load LLSD into sKeywordsXml
}
|
