phoenix-firestorm/indra/newview/llteleporthistorystorage.cpp

307 lines
8.6 KiB
C++

/**
* @file llteleporthistorystorage.cpp
* @brief Teleport history
*
* $LicenseInfo:firstyear=2009&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 "llviewerprecompiledheaders.h"
#include "llteleporthistorystorage.h"
#include "llsd.h"
#include "llsdserialize.h"
#include "lldir.h"
#include "llteleporthistory.h"
#include "llagent.h"
#include "llfloaterreg.h"
#include "llfloaterworldmap.h"
// [RLVa:KB] - Checked: 2010-09-03 (RLVa-1.2.1b)
#include "rlvactions.h"
// [/RLVa:KB]
// Max offset for two global positions to consider them as equal
const F64 MAX_GLOBAL_POS_OFFSET = 5.0f;
LLTeleportHistoryPersistentItem::LLTeleportHistoryPersistentItem(const LLSD& val)
{
mTitle = val["title"].asString();
mGlobalPos.setValue(val["global_pos"]);
mDate = val["date"];
}
LLSD LLTeleportHistoryPersistentItem::toLLSD() const
{
LLSD val;
val["title"] = mTitle;
val["global_pos"] = mGlobalPos.getValue();
val["date"] = mDate;
return val;
}
struct LLSortItemsByDate
{
bool operator()(const LLTeleportHistoryPersistentItem& a, const LLTeleportHistoryPersistentItem& b)
{
return a.mDate < b.mDate;
}
};
LLTeleportHistoryStorage::LLTeleportHistoryStorage() :
mFilename("teleport_history.txt")
{
mItems.clear();
LLTeleportHistory *th = LLTeleportHistory::getInstance();
if (th)
th->setHistoryChangedCallback(boost::bind(&LLTeleportHistoryStorage::onTeleportHistoryChange, this));
load();
}
LLTeleportHistoryStorage::~LLTeleportHistoryStorage()
{
}
void LLTeleportHistoryStorage::onTeleportHistoryChange()
{
LLTeleportHistory *th = LLTeleportHistory::getInstance();
if (!th)
return;
// Hacky sanity check. (EXT-6798)
if (th->getItems().size() == 0)
{
llassert(!"Inconsistent teleport history state");
return;
}
const LLTeleportHistoryItem &item = th->getItems()[th->getCurrentItemIndex()];
// [RLVa:KB] - Checked: 2010-09-03 (RLVa-1.2.1b) | Added: RLVa-1.2.1b
// Make sure we don't attempt to save zero'ed out teleport history items
if (item.mGlobalPos.isExactlyZero())
{
return;
}
// [/RLVa:KB]
addItem(item.mTitle, item.mGlobalPos);
save();
}
void LLTeleportHistoryStorage::purgeItems()
{
mItems.clear();
mHistoryChangedSignal(-1);
}
void LLTeleportHistoryStorage::addItem(const std::string title, const LLVector3d& global_pos)
{
addItem(title, global_pos, LLDate::now());
}
bool LLTeleportHistoryStorage::compareByTitleAndGlobalPos(const LLTeleportHistoryPersistentItem& a, const LLTeleportHistoryPersistentItem& b)
{
return a.mTitle == b.mTitle && (a.mGlobalPos - b.mGlobalPos).length() < MAX_GLOBAL_POS_OFFSET;
}
void LLTeleportHistoryStorage::addItem(const std::string title, const LLVector3d& global_pos, const LLDate& date)
{
// [RLVa:KB] - Checked: 2010-09-03 (RLVa-1.2.1b) | Added: RLVa-1.2.1b
if (!RlvActions::canShowLocation())
{
return;
}
// [/RLVa:KB]
LLTeleportHistoryPersistentItem item(title, global_pos, date);
slurl_list_t::iterator item_iter = std::find_if(mItems.begin(), mItems.end(),
boost::bind(&LLTeleportHistoryStorage::compareByTitleAndGlobalPos, this, _1, item));
// If there is such item already, remove it, since new item is more recent
S32 removed_index = -1;
if (item_iter != mItems.end())
{
// When teleporting via history it's possible that there can be
// an offset applied to the position, so each new teleport can
// be a meter higher than the last.
// Avoid it by preserving original position.
item.mGlobalPos = item_iter->mGlobalPos;
removed_index = (S32)(item_iter - mItems.begin());
mItems.erase(item_iter);
}
mItems.push_back(item);
// Check whether sorting is needed
if (mItems.size() > 1)
{
item_iter = mItems.end();
item_iter--;
item_iter--;
// If second to last item is more recent than last, then resort items
if (item_iter->mDate > item.mDate)
{
removed_index = -1;
std::sort(mItems.begin(), mItems.end(), LLSortItemsByDate());
}
}
mHistoryChangedSignal(removed_index);
}
void LLTeleportHistoryStorage::removeItem(S32 idx)
{
if (idx < 0 || idx >= (S32)mItems.size())
return;
mItems.erase (mItems.begin() + idx);
}
void LLTeleportHistoryStorage::save()
{
// build filename for each user
std::string resolvedFilename = gDirUtilp->getExpandedFilename(LL_PATH_PER_SL_ACCOUNT, mFilename);
// open the history file for writing
llofstream file(resolvedFilename.c_str());
if (!file.is_open())
{
LL_WARNS() << "can't open teleport history file \"" << mFilename << "\" for writing" << LL_ENDL;
return;
}
for (size_t i=0; i<mItems.size(); i++)
{
LLSD s_item = mItems[i].toLLSD();
file << LLSDOStreamer<LLSDNotationFormatter>(s_item) << std::endl;
}
file.close();
}
void LLTeleportHistoryStorage::load()
{
// build filename for each user
std::string resolved_filename = gDirUtilp->getExpandedFilename(LL_PATH_PER_SL_ACCOUNT, mFilename);
// open the history file for reading
llifstream file(resolved_filename.c_str());
if (!file.is_open())
{
LL_WARNS() << "can't load teleport history from file \"" << mFilename << "\"" << LL_ENDL;
return;
}
// remove current entries before we load over them
mItems.clear();
// the parser's destructor is protected so we cannot create in the stack.
LLPointer<LLSDParser> parser = new LLSDNotationParser();
std::string line;
while (std::getline(file, line))
{
if (line.empty())
{
LL_WARNS() << "Teleport history contains empty line."<< LL_ENDL;
continue;
}
LLSD s_item;
std::istringstream iss(line);
if (parser->parse(iss, s_item, line.length()) == LLSDParser::PARSE_FAILURE)
{
LL_INFOS() << "Parsing saved teleport history failed" << LL_ENDL;
break;
}
mItems.push_back(s_item);
}
file.close();
std::sort(mItems.begin(), mItems.end(), LLSortItemsByDate());
mHistoryChangedSignal(-1);
}
void LLTeleportHistoryStorage::dump() const
{
LL_INFOS() << "Teleport history storage dump (" << mItems.size() << " items):" << LL_ENDL;
for (size_t i=0; i<mItems.size(); i++)
{
std::stringstream line;
line << i << ": " << mItems[i].mTitle;
line << " global pos: " << mItems[i].mGlobalPos;
line << " date: " << mItems[i].mDate;
LL_INFOS() << line.str() << LL_ENDL;
}
}
boost::signals2::connection LLTeleportHistoryStorage::setHistoryChangedCallback(history_callback_t cb)
{
return mHistoryChangedSignal.connect(cb);
}
void LLTeleportHistoryStorage::goToItem(S32 idx)
{
// Validate specified index.
if (idx < 0 || idx >= (S32)mItems.size())
{
LL_WARNS() << "Invalid teleport history index (" << idx << ") specified" << LL_ENDL;
dump();
return;
}
// Attempt to teleport to the requested item.
gAgent.teleportViaLocation(mItems[idx].mGlobalPos);
}
void LLTeleportHistoryStorage::showItemOnMap(S32 idx)
{
// Validate specified index.
if (idx < 0 || idx >= (S32)mItems.size())
{
LL_WARNS() << "Invalid teleport history index (" << idx << ") specified" << LL_ENDL;
dump();
return;
}
LLVector3d landmark_global_pos = mItems[idx].mGlobalPos;
LLFloaterWorldMap* worldmap_instance = LLFloaterWorldMap::getInstance();
if (!landmark_global_pos.isExactlyZero() && worldmap_instance)
{
worldmap_instance->trackLocation(landmark_global_pos);
LLFloaterReg::showInstance("world_map", "center");
}
}