RepoMirrors
/
osu
mirror of https://github.com/ppy/osu
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #40 from peppy/api-channels-messages 

API: channels & messages
This commit is contained in:
Dean Herbert 2016-10-01 17:07:05 +09:00 committed by GitHub
parent 24837a0af3 b110a879a7
commit cdbc47ef7a
12 changed files with 256 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

128
osu.Desktop.VisualTests/Tests/TestCaseChatDisplay.cs Normal file
View File

@ -0,0 +1,128 @@
//Copyright (c) 2007-2016 ppy Pty Ltd <contact@ppy.sh>.
//Licensed under the MIT Licence - https://raw.githubusercontent.com/ppy/osu/master/LICENCE
using OpenTK;
using osu.Framework.GameModes.Testing;
using osu.Framework.Graphics;
using osu.Framework.Graphics.Containers;
using osu.Framework.Graphics.Transformations;
using osu.Framework.Threading;
using osu.Game;
using osu.Game.Online.API;
using osu.Game.Online.API.Requests;
using osu.Game.Online.Chat;
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
using osu.Framework.Graphics.Sprites;
using osu.Game.Online.Chat.Display.osu.Online.Social;
namespace osu.Desktop.Tests
{
class TestCaseChatDisplay : TestCase
{
private ScheduledDelegate messageRequest;
public override string Name => @"Chat";
public override string Description => @"Testing API polling";
private List<Channel> channels = new List<Channel>();
private FlowContainer flow;
private Scheduler scheduler = new Scheduler();
private APIAccess api => ((OsuGameBase)Game).API;
private long? lastMessageId;
public override void Reset()
{
base.Reset();
lastMessageId = null;
if (api.State != APIAccess.APIState.Online)
api.OnStateChange += delegate { initializeChannels(); };
else
initializeChannels();
Add(new ScrollContainer()
{
Size = new Vector2(1, 0.5f),
Children = new Drawable[]
{
flow = new FlowContainer
{
Direction = FlowDirection.VerticalOnly,
SizeMode = InheritMode.X,
LayoutDuration = 100,
LayoutEasing = EasingTypes.Out,
Padding = new Vector2(1, 1)
}
}
});
}
protected override void Update()
{
scheduler.Update();
base.Update();
}
private void initializeChannels()
{
if (api.State != APIAccess.APIState.Online)
return;
messageRequest?.Cancel();
ListChannelsRequest req = new ListChannelsRequest();
req.Success += delegate (List<Channel> channels)
{
this.channels = channels;
messageRequest = scheduler.AddDelayed(requestNewMessages, 1000, true);
};
api.Queue(req);
}
private void requestNewMessages()
{
messageRequest.Wait();
Channel channel = channels.Find(c => c.Name == "#osu");
GetMessagesRequest gm = new GetMessagesRequest(new List<Channel> { channel }, lastMessageId);
gm.Success += delegate (List<Message> messages)
{
foreach (Message m in messages)
{
//m.LineWidth = this.Size.X; //this is kinda ugly.
//m.Drawable.Depth = m.Id;
//m.Drawable.FadeInFromZero(800);
//flow.Add(m.Drawable);
//if (osu.Messages.Count > 50)
//{
// osu.Messages[0].Drawable.Expire();
// osu.Messages.RemoveAt(0);
//}
flow.Add(new ChatLine(m));
channel.Messages.Add(m);
}
lastMessageId = messages.LastOrDefault()?.Id ?? lastMessageId;
Debug.Write("success!");
messageRequest.Continue();
};
gm.Failure += delegate
{
Debug.Write("failure!");
messageRequest.Continue();
};
api.Queue(gm);
}
}
}

1
osu.Desktop.VisualTests/osu.Desktop.VisualTests.csproj
View File

@ -150,6 +150,7 @@
</ItemGroup>
<ItemGroup>
<Compile Include="Program.cs" />
<Compile Include="Tests\TestCaseChatDisplay.cs" />
<Compile Include="Tests\TestCaseGamefield.cs" />
<Compile Include="Tests\TestCaseKeyCounter.cs" />
<Compile Include="Tests\TestCaseMenuButtonSystem.cs" />

27
osu.Game/Online/API/APIAccess.cs
View File

@ -5,21 +5,25 @@
using System.Collections.Concurrent;
using System.Net;
using System.Threading;
using osu.Framework;
using osu.Framework.Logging;
using osu.Framework.Threading;
using osu.Game.Online.API.Requests;
namespace osu.Game.Online.API
{
internal class APIAccess
public class APIAccess : IUpdateable
{
private OAuth authentication;
internal string Endpoint = @"https://new.ppy.sh";
public string Endpoint = @"https://new.ppy.sh";
const string ClientId = @"daNBnfdv7SppRVc61z0XuOI13y6Hroiz";
const string ClientSecret = @"d6fgZuZeQ0eSXkEj5igdqQX6ztdtS6Ow";
ConcurrentQueue<APIRequest> queue = new ConcurrentQueue<APIRequest>();
public Scheduler Scheduler = new Scheduler();
public string Username;
private SecurePassword password;
@ -52,7 +56,7 @@ public string Token
Logger log;
internal APIAccess()
public APIAccess()
{
authentication = new OAuth(ClientId, ClientSecret, Endpoint);
log = Logger.GetLogger(LoggingTarget.Network);
@ -61,7 +65,7 @@ internal APIAccess()
thread.Start();
}
internal string AccessToken => authentication.RequestAccessToken();
public string AccessToken => authentication.RequestAccessToken();
/// <summary>
/// Number of consecutive requests which failed due to network issues.
@ -221,16 +225,16 @@ public APIState State
}
}
internal void Queue(APIRequest request)
public void Queue(APIRequest request)
{
queue.Enqueue(request);
}
internal event StateChangeDelegate OnStateChange;
public event StateChangeDelegate OnStateChange;
internal delegate void StateChangeDelegate(APIState oldState, APIState newState);
public delegate void StateChangeDelegate(APIState oldState, APIState newState);
internal enum APIState
public enum APIState
{
/// <summary>
/// We cannot login (not enough credentials).
@ -268,10 +272,15 @@ private void flushQueue(bool failOldRequests = true)
}
}
internal void Logout()
public void Logout()
{
authentication.Clear();
State = APIState.Offline;
}
public void Update()
{
Scheduler.Update();
}
}
}

21
osu.Game/Online/API/APIRequest.cs
View File

@ -11,7 +11,7 @@ namespace osu.Game.Online.API
/// An API request with a well-defined response type.
/// </summary>
/// <typeparam name="T">Type of the response (used for deserialisation).</typeparam>
internal class APIRequest<T> : APIRequest
public class APIRequest<T> : APIRequest
{
protected override WebRequest CreateWebRequest() => new JsonWebRequest<T>(Uri);
@ -36,7 +36,7 @@ public class APIRequest
/// <summary>
/// The maximum amount of time before this request will fail.
/// </summary>
internal int Timeout = WebRequest.DEFAULT_TIMEOUT;
public int Timeout = WebRequest.DEFAULT_TIMEOUT;
protected virtual string Target => string.Empty;
@ -46,11 +46,11 @@ public class APIRequest
private double remainingTime => Math.Max(0, Timeout - (DateTime.Now.TotalMilliseconds() - (startTime ?? 0)));
internal bool ExceededTimeout => remainingTime == 0;
public bool ExceededTimeout => remainingTime == 0;
private double? startTime;
internal double StartTime => startTime ?? -1;
public double StartTime => startTime ?? -1;
private APIAccess api;
protected WebRequest WebRequest;
@ -58,7 +58,7 @@ public class APIRequest
public event APISuccessHandler Success;
public event APIFailureHandler Failure;
internal void Perform(APIAccess api)
public void Perform(APIAccess api)
{
if (startTime == null)
startTime = DateTime.Now.TotalMilliseconds();
@ -74,17 +74,16 @@ internal void Perform(APIAccess api)
WebRequest.BlockingPerform();
//OsuGame.Scheduler.Add(delegate {
Success?.Invoke();
//});
api.Scheduler.Add(delegate { Success?.Invoke(); });
}
internal void Fail(Exception e)
public void Fail(Exception e)
{
WebRequest?.Abort();
//OsuGame.Scheduler.Add(delegate {
api.Scheduler.Add(delegate
{
Failure?.Invoke(e);
//});
});
}
}

2
osu.Game/Online/API/Requests/GetMessagesRequest.cs
View File

@ -7,7 +7,7 @@
namespace osu.Game.Online.API.Requests
{
internal class GetMessagesRequest : APIRequest<List<Message>>
public class GetMessagesRequest : APIRequest<List<Message>>
{
List<Channel> channels;
long? since;

2
osu.Game/Online/API/Requests/ListChannels.cs
View File

@ -6,7 +6,7 @@
namespace osu.Game.Online.API.Requests
{
internal class ListChannelsRequest : APIRequest<List<Channel>>
public class ListChannelsRequest : APIRequest<List<Channel>>
{
protected override string Target => @"chat/channels";
}

62
osu.Game/Online/Chat/Display/ChatLine.cs Normal file
View File

@ -0,0 +1,62 @@
//Copyright (c) 2007-2016 ppy Pty Ltd <contact@ppy.sh>.
//Licensed under the MIT Licence - https://raw.githubusercontent.com/ppy/osu/master/LICENCE
using osu.Framework.Graphics;
using osu.Framework.Graphics.Containers;
using osu.Framework.Graphics.Drawables;
using osu.Framework.Graphics.Sprites;
using OpenTK;
using OpenTK.Graphics;
namespace osu.Game.Online.Chat.Display
{
namespace osu.Online.Social
{
public class ChatLine : AutoSizeContainer
{
private readonly Message msg;
public ChatLine(Message msg)
{
this.msg = msg;
}
public override void Load()
{
base.Load();
SizeMode = InheritMode.X;
Add(new Box
{
SizeMode = InheritMode.XY,
Colour = Color4.Aqua,
Alpha = 0.2f
});
Add(new SpriteText
{
Text = msg.Timestamp.ToLocalTime().ToLongTimeString(),
Colour = new Color4(128, 128, 128, 255)
});
Add(new SpriteText
{
Text = msg.User.Name,
Origin = Anchor.TopRight,
PositionMode = InheritMode.X,
Position = new Vector2(0.14f,0),
});
Add(new SpriteText
{
Text = msg.Content,
PositionMode = InheritMode.X,
Position = new Vector2(0.15f, 0),
SizeMode = InheritMode.X,
Size = new Vector2(0.85f, 1),
});
}
}
}
}

2
osu.Game/Online/Chat/Message.cs
View File

@ -24,7 +24,7 @@ public class Message
public string Content;
[JsonProperty(@"sender")]
public string User;
public User User;
[JsonConstructor]
public Message()

16
osu.Game/Online/User.cs Normal file
View File

@ -0,0 +1,16 @@
//Copyright (c) 2007-2016 ppy Pty Ltd <contact@ppy.sh>.
//Licensed under the MIT Licence - https://raw.githubusercontent.com/ppy/osu/master/LICENCE
using Newtonsoft.Json;
namespace osu.Game.Online
{
public class User
{
[JsonProperty(@"username")]
public string Name;
[JsonProperty(@"colour")]
public string Colour;
}
}

8
osu.Game/OsuGame.cs
View File

@ -26,14 +26,6 @@ public override void Load()
Add(new MainMenu());
}
protected override void Dispose(bool isDisposing)
{
//refresh token may have changed.
Config.Set(OsuConfig.Token, API.Token);
base.Dispose(isDisposing);
}
public override bool Invalidate(Invalidation invalidation = Invalidation.All, Drawable source = null, bool shallPropagate = true)
{
if (!base.Invalidate(invalidation, source, shallPropagate)) return false;

17
osu.Game/OsuGameBase.cs
View File

@ -16,7 +16,7 @@ public class OsuGameBase : Framework.Game
protected override string MainResourceFile => @"osu.Game.Resources.dll";
internal APIAccess API;
public APIAccess API;
protected override Container AddTarget => ratioContainer?.IsLoaded == true ? ratioContainer : base.AddTarget;
@ -50,5 +50,20 @@ public override void Load()
}
});
}
protected override void Update()
{
base.Update();
API.Update();
}
protected override void Dispose(bool isDisposing)
{
//refresh token may have changed.
Config.Set(OsuConfig.Token, API.Token);
Config.Save();
base.Dispose(isDisposing);
}
}
}

2
osu.Game/osu.Game.csproj
View File

@ -99,7 +99,9 @@
<Compile Include="Online\API\SecurePassword.cs" />
<Compile Include="Online\API\Requests\ListChannels.cs" />
<Compile Include="Online\Chat\Channel.cs" />
<Compile Include="Online\Chat\Display\ChatLine.cs" />
<Compile Include="Online\Chat\Message.cs" />
<Compile Include="Online\User.cs" />
<Compile Include="OsuGame.cs" />
<Compile Include="OsuGameBase.cs" />
<Compile Include="Properties\AssemblyInfo.cs" />