* refactor: Remove duplication in UserLoginService where most of the emergency region login code is a cut and paste job of the preceding normal region login code

* also, properly tell the user if no region can be contacted, rather than letting the login proceed only to fail later when authentication fails on the region side
* copying and pasting code... it makes me cry inside... so sad...
0.6.0-stable
Justin Clarke Casey 2008-09-07 04:20:47 +00:00
parent 94195c4927
commit 260b141306
1 changed files with 169 additions and 259 deletions

View File

@ -137,12 +137,6 @@ namespace OpenSim.Grid.UserServer
/// <param name="startLocationRequest">Destination of the user</param> /// <param name="startLocationRequest">Destination of the user</param>
public override void CustomiseResponse(LoginResponse response, UserProfileData theUser, public override void CustomiseResponse(LoginResponse response, UserProfileData theUser,
string startLocationRequest) string startLocationRequest)
{
bool tryDefault = false;
//CFK: Since the try is always "tried", the "Home Location" message should always appear, so comment this one.
//CFK: m_log.Info("[LOGIN]: Load information from the gridserver");
try
{ {
RegionProfileData SimInfo; RegionProfileData SimInfo;
RegionProfileData HomeInfo; RegionProfileData HomeInfo;
@ -208,6 +202,12 @@ namespace OpenSim.Grid.UserServer
start_x = Convert.ToInt32(startLocationRequestParsed[1]); start_x = Convert.ToInt32(startLocationRequestParsed[1]);
start_y = Convert.ToInt32(startLocationRequestParsed[2]); start_y = Convert.ToInt32(startLocationRequestParsed[2]);
start_z = Convert.ToInt32(startLocationRequestParsed[3]); start_z = Convert.ToInt32(startLocationRequestParsed[3]);
if (start_x >= 0 && start_y >= 0 && start_z >= 0)
{
Vector3 tmp_v = new Vector3(start_x, start_y, start_z);
theUser.CurrentAgent.Position = tmp_v;
}
} }
} }
} }
@ -243,126 +243,21 @@ namespace OpenSim.Grid.UserServer
regionX, regionY); regionX, regionY);
} }
// Destination if (!PrepareLoginToRegion(SimInfo, theUser, response))
//CFK: The "Notifying" message always seems to appear, so subsume the data from this message into
//CFK: the next one for X & Y and comment this one.
//CFK: m_log.Info("[LOGIN]: CUSTOMISERESPONSE: Region X: " + SimInfo.regionLocX +
//CFK: "; Region Y: " + SimInfo.regionLocY);
response.SimAddress = Util.GetHostFromURL(SimInfo.serverURI).ToString();
response.SimPort = uint.Parse(SimInfo.serverURI.Split(new char[] {'/', ':'})[4]);
response.RegionX = SimInfo.regionLocX;
response.RegionY = SimInfo.regionLocY;
//Not sure if the + "/CAPS/" should in fact be +"CAPS/" depending if there is already a / as part of httpServerURI
string capsPath = Util.GetRandomCapsPath();
response.SeedCapability = SimInfo.httpServerURI + "CAPS/" + capsPath + "0000/";
m_log.DebugFormat(
"[LOGIN]: Sending new CAPS seed url {0} to client {1}",
response.SeedCapability, response.AgentID);
// Notify the target of an incoming user
//CFK: The "Notifying" message always seems to appear, so subsume the data from this message into
//CFK: the next one for X & Y and comment this one.
//CFK: m_log.Info("[LOGIN]: " + SimInfo.regionName + " (" + SimInfo.serverURI + ") " +
//CFK: SimInfo.regionLocX + "," + SimInfo.regionLocY);
theUser.CurrentAgent.Region = SimInfo.UUID;
theUser.CurrentAgent.Handle = SimInfo.regionHandle;
if (start_x >= 0 && start_y >= 0 && start_z >= 0)
{
Vector3 tmp_v = new Vector3(start_x, start_y, start_z);
theUser.CurrentAgent.Position = tmp_v;
}
// Prepare notification
Hashtable SimParams = new Hashtable();
SimParams["session_id"] = theUser.CurrentAgent.SessionID.ToString();
SimParams["secure_session_id"] = theUser.CurrentAgent.SecureSessionID.ToString();
SimParams["firstname"] = theUser.FirstName;
SimParams["lastname"] = theUser.SurName;
SimParams["agent_id"] = theUser.ID.ToString();
SimParams["circuit_code"] = (Int32) Convert.ToUInt32(response.CircuitCode);
SimParams["startpos_x"] = theUser.CurrentAgent.Position.X.ToString();
SimParams["startpos_y"] = theUser.CurrentAgent.Position.Y.ToString();
SimParams["startpos_z"] = theUser.CurrentAgent.Position.Z.ToString();
SimParams["regionhandle"] = theUser.CurrentAgent.Handle.ToString();
SimParams["caps_path"] = capsPath;
ArrayList SendParams = new ArrayList();
SendParams.Add(SimParams);
// Update agent with target sim
m_log.InfoFormat(
"[LOGIN]: Telling region {0} @ {1},{2} ({3}) to expect user connection",
SimInfo.regionName, response.RegionX, response.RegionY, SimInfo.httpServerURI);
XmlRpcRequest GridReq = new XmlRpcRequest("expect_user", SendParams);
XmlRpcResponse GridResp = GridReq.Send(SimInfo.httpServerURI, 6000);
if (GridResp.IsFault)
{
m_log.ErrorFormat(
"[LOGIN]: XMLRPC request for {0} failed, fault code: {1}, reason: {2}",
SimInfo.httpServerURI, GridResp.FaultCode, GridResp.FaultString);
}
if (!GridResp.IsFault)
{
bool responseSuccess = true;
if (GridResp.Value != null)
{
Hashtable resp = (Hashtable) GridResp.Value;
if (resp.ContainsKey("success"))
{
if ((string) resp["success"] == "FALSE")
{
responseSuccess = false;
tryDefault = true;
}
}
}
if (responseSuccess)
{
handlerUserLoggedInAtLocation = OnUserLoggedInAtLocation;
if (handlerUserLoggedInAtLocation != null)
{
//m_log.Info("[LOGIN]: Letting other objects know about login");
handlerUserLoggedInAtLocation(theUser.ID, theUser.CurrentAgent.SessionID,
theUser.CurrentAgent.Region,
theUser.CurrentAgent.Handle, theUser.CurrentAgent.Position.X,
theUser.CurrentAgent.Position.Y,
theUser.CurrentAgent.Position.Z,
theUser.FirstName, theUser.SurName);
}
}
}
}
catch (Exception e)
{
m_log.ErrorFormat("[LOGIN]: Requested region for login not available, {0}", e);
tryDefault = true;
}
if (tryDefault)
{ {
// Send him to default region instead // Send him to default region instead
// Load information from the gridserver // Load information from the gridserver
ulong defaultHandle = (((ulong) m_config.DefaultX * Constants.RegionSize) << 32) | ulong defaultHandle = (((ulong) m_config.DefaultX * Constants.RegionSize) << 32) |
((ulong) m_config.DefaultY * Constants.RegionSize); ((ulong) m_config.DefaultY * Constants.RegionSize);
m_log.Warn( m_log.Warn(
"[LOGIN]: Sending user to default region " + defaultHandle + " instead"); "[LOGIN]: Sending user to default region " + defaultHandle + " instead");
try SimInfo = RegionProfileData.RequestSimProfileData(
{
RegionProfileData SimInfo = RegionProfileData.RequestSimProfileData(
defaultHandle, m_config.GridServerURL, defaultHandle, m_config.GridServerURL,
m_config.GridSendKey, m_config.GridRecvKey); m_config.GridSendKey, m_config.GridRecvKey);
// Customise the response // Customise the response
m_log.Info("[LOGIN]: Home Location");
response.Home = response.Home =
string.Format( string.Format(
"{{'region_handle':[r{0},r{1}], 'position':[r{2},r{3},r{4}], 'look_at':[r{5},r{6},r{7}]}}", "{{'region_handle':[r{0},r{1}], 'position':[r{2},r{3},r{4}], 'look_at':[r{5},r{6},r{7}]}}",
@ -371,53 +266,68 @@ namespace OpenSim.Grid.UserServer
theUser.HomeLocation.X, theUser.HomeLocation.Y, theUser.HomeLocation.Z, theUser.HomeLocation.X, theUser.HomeLocation.Y, theUser.HomeLocation.Z,
theUser.HomeLookAt.X, theUser.HomeLookAt.Y, theUser.HomeLookAt.Z); theUser.HomeLookAt.X, theUser.HomeLookAt.Y, theUser.HomeLookAt.Z);
if (!PrepareLoginToRegion(SimInfo, theUser, response))
response.CreateDeadRegionResponse();
}
}
/// <summary>
/// Prepare a login to the given region. This involves both telling the region to expect a connection
/// and appropriately customising the response to the user.
/// </summary>
/// <param name="sim"></param>
/// <param name="user"></param>
/// <param name="response"></param>
/// <returns>true if the region was successfully contacted, false otherwise</returns>
private bool PrepareLoginToRegion(RegionProfileData sim, UserProfileData user, LoginResponse response)
{
try
{
// Destination // Destination
m_log.Info("[LOGIN]: " + m_log.Info("[LOGIN]: CUSTOMISERESPONSE: Region X: " + sim.regionLocX + "; Region Y: " + sim.regionLocY);
"CUSTOMISERESPONSE: Region X: " + SimInfo.regionLocX + "; Region Y: " +
SimInfo.regionLocY); response.SimAddress = Util.GetHostFromURL(sim.serverURI).ToString();
response.SimAddress = Util.GetHostFromURL(SimInfo.serverURI).ToString(); response.SimPort = uint.Parse(sim.serverURI.Split(new char[] {'/', ':'})[4]);
response.SimPort = uint.Parse(SimInfo.serverURI.Split(new char[] {'/', ':'})[4]); response.RegionX = sim.regionLocX;
response.RegionX = SimInfo.regionLocX; response.RegionY = sim.regionLocY;
response.RegionY = SimInfo.regionLocY;
//Not sure if the + "/CAPS/" should in fact be +"CAPS/" depending if there is already a / as part of httpServerURI //Not sure if the + "/CAPS/" should in fact be +"CAPS/" depending if there is already a / as part of httpServerURI
string capsPath = Util.GetRandomCapsPath(); string capsPath = Util.GetRandomCapsPath();
response.SeedCapability = SimInfo.httpServerURI + "CAPS/" + capsPath + "0000/"; response.SeedCapability = sim.httpServerURI + "CAPS/" + capsPath + "0000/";
// Notify the target of an incoming user // Notify the target of an incoming user
m_log.Info("[LOGIN]: Notifying " + SimInfo.regionName + " (" + SimInfo.serverURI + ")"); m_log.Info("[LOGIN]: Telling " + sim.regionName + " (" + sim.serverURI + ") to prepare for client connection");
// Update agent with target sim // Update agent with target sim
theUser.CurrentAgent.Region = SimInfo.UUID; user.CurrentAgent.Region = sim.UUID;
theUser.CurrentAgent.Handle = SimInfo.regionHandle; user.CurrentAgent.Handle = sim.regionHandle;
// Prepare notification // Prepare notification
Hashtable SimParams = new Hashtable(); Hashtable SimParams = new Hashtable();
SimParams["session_id"] = theUser.CurrentAgent.SessionID.ToString(); SimParams["session_id"] = user.CurrentAgent.SessionID.ToString();
SimParams["secure_session_id"] = theUser.CurrentAgent.SecureSessionID.ToString(); SimParams["secure_session_id"] = user.CurrentAgent.SecureSessionID.ToString();
SimParams["firstname"] = theUser.FirstName; SimParams["firstname"] = user.FirstName;
SimParams["lastname"] = theUser.SurName; SimParams["lastname"] = user.SurName;
SimParams["agent_id"] = theUser.ID.ToString(); SimParams["agent_id"] = user.ID.ToString();
SimParams["circuit_code"] = (Int32) Convert.ToUInt32(response.CircuitCode); SimParams["circuit_code"] = (Int32) Convert.ToUInt32(response.CircuitCode);
SimParams["startpos_x"] = theUser.CurrentAgent.Position.X.ToString(); SimParams["startpos_x"] = user.CurrentAgent.Position.X.ToString();
SimParams["startpos_y"] = theUser.CurrentAgent.Position.Y.ToString(); SimParams["startpos_y"] = user.CurrentAgent.Position.Y.ToString();
SimParams["startpos_z"] = theUser.CurrentAgent.Position.Z.ToString(); SimParams["startpos_z"] = user.CurrentAgent.Position.Z.ToString();
SimParams["regionhandle"] = theUser.CurrentAgent.Handle.ToString(); SimParams["regionhandle"] = user.CurrentAgent.Handle.ToString();
SimParams["caps_path"] = capsPath; SimParams["caps_path"] = capsPath;
ArrayList SendParams = new ArrayList(); ArrayList SendParams = new ArrayList();
SendParams.Add(SimParams); SendParams.Add(SimParams);
m_log.Info("[LOGIN]: Informing region at " + SimInfo.httpServerURI); m_log.Info("[LOGIN]: Informing region at " + sim.httpServerURI);
// Send // Send
XmlRpcRequest GridReq = new XmlRpcRequest("expect_user", SendParams); XmlRpcRequest GridReq = new XmlRpcRequest("expect_user", SendParams);
XmlRpcResponse GridResp = GridReq.Send(SimInfo.httpServerURI, 6000); XmlRpcResponse GridResp = GridReq.Send(sim.httpServerURI, 6000);
if (!GridResp.IsFault) if (!GridResp.IsFault)
{ {
bool responseSuccess = true; bool responseSuccess = true;
if (GridResp.Value != null) if (GridResp.Value != null)
{ {
Hashtable resp = (Hashtable) GridResp.Value; Hashtable resp = (Hashtable) GridResp.Value;
@ -435,33 +345,33 @@ namespace OpenSim.Grid.UserServer
handlerUserLoggedInAtLocation = OnUserLoggedInAtLocation; handlerUserLoggedInAtLocation = OnUserLoggedInAtLocation;
if (handlerUserLoggedInAtLocation != null) if (handlerUserLoggedInAtLocation != null)
{ {
m_log.Info("[LOGIN]: Letting other objects know about login"); m_log.Info("[LOGIN]: Letting listeners know about successful login");
handlerUserLoggedInAtLocation(theUser.ID, theUser.CurrentAgent.SessionID, handlerUserLoggedInAtLocation(user.ID, user.CurrentAgent.SessionID,
theUser.CurrentAgent.Region, user.CurrentAgent.Region,
theUser.CurrentAgent.Handle, user.CurrentAgent.Handle,
theUser.CurrentAgent.Position.X, user.CurrentAgent.Position.X,
theUser.CurrentAgent.Position.Y, user.CurrentAgent.Position.Y,
theUser.CurrentAgent.Position.Z, user.CurrentAgent.Position.Z,
theUser.FirstName, theUser.SurName); user.FirstName, user.SurName);
} }
} }
else else
{ {
response.CreateDeadRegionResponse(); return false;
} }
} }
else else
{ {
response.CreateDeadRegionResponse(); return false;
} }
} }
catch (Exception e) catch (Exception e)
{ {
m_log.Warn("[LOGIN]: Default region also not available"); m_log.ErrorFormat("[LOGIN]: Region not available for login, {0}", e);
m_log.Warn("[LOGIN]: " + e); return false;
}
} }
return true;
} }
// See LoginService // See LoginService