ra/runelite
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

Merge pull request #1321 from SoyChai/screenshot-exception-fix

Browse Source 
Fix ArrayIndexOutOfBounds errors in screenshot plugin
This commit is contained in:
Adam
2018-04-08 14:55:45 -04:00
committed by GitHub
parent 58c9a55a37 deb70796da
commit 8e3a1b40e0
2 changed files with 49 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
runelite-client/src/main/java/net/runelite/client/plugins/screenshot/ScreenshotPlugin.java
View File

@@ -102,6 +102,7 @@ public class ScreenshotPlugin extends Plugin
private static final DateFormat TIME_FORMAT = new SimpleDateFormat("yyyy-MM-dd_HH-mm-ss", Locale.US); private static final DateFormat TIME_FORMAT = new SimpleDateFormat("yyyy-MM-dd_HH-mm-ss", Locale.US);
private static final Pattern NUMBER_PATTERN = Pattern.compile("([0-9]+)"); private static final Pattern NUMBER_PATTERN = Pattern.compile("([0-9]+)");
private static final Pattern LEVEL_UP_PATTERN = Pattern.compile("Your ([a-zA-Z]+) (?:level is|are)? now (\\d+)\\.");
private String clueType; private String clueType;
private Integer clueNumber; private Integer clueNumber;
@@ -264,12 +265,12 @@ public class ScreenshotPlugin extends Plugin
{ {
case LEVEL_UP_GROUP_ID: case LEVEL_UP_GROUP_ID:
{ {
fileName = parseLevelUpWidget(WidgetInfo.LEVEL_UP_SKILL, WidgetInfo.LEVEL_UP_LEVEL); fileName = parseLevelUpWidget(WidgetInfo.LEVEL_UP_LEVEL);
break; break;
} }
case DIALOG_SPRITE_GROUP_ID: case DIALOG_SPRITE_GROUP_ID:
{ {
fileName = parseLevelUpWidget(WidgetInfo.DIALOG_SPRITE_SPRITE, WidgetInfo.DIALOG_SPRITE_TEXT); fileName = parseLevelUpWidget(WidgetInfo.DIALOG_SPRITE_TEXT);
break; break;
} }
case QUEST_COMPLETED_GROUP_ID: case QUEST_COMPLETED_GROUP_ID:
@@ -333,28 +334,40 @@ public class ScreenshotPlugin extends Plugin
takeScreenshot(fileName, config.displayDate()); takeScreenshot(fileName, config.displayDate());
} }
public String parseLevelUpWidget(WidgetInfo levelUpSkill, WidgetInfo levelUpLevel) /**
* Receives a WidgetInfo pointing to the middle widget of the level-up dialog,
* and parses it into a shortened string for filename usage.
*
* @param levelUpLevel WidgetInfo pointing to the required text widget,
* with the format "Your Skill (level is/are) now 99."
* @return Shortened string in the format "Skill(99)"
*/
String parseLevelUpWidget(WidgetInfo levelUpLevel)
{ {
Widget skillChild = client.getWidget(levelUpSkill);
Widget levelChild = client.getWidget(levelUpLevel); Widget levelChild = client.getWidget(levelUpLevel);
if (levelChild == null)
if (skillChild == null || levelChild == null)
{ {
return null; return null;
} }
// "Congratulations, you just advanced a Firemaking level." Matcher m = LEVEL_UP_PATTERN.matcher(levelChild.getText());
String skillText = skillChild.getText(); if (!m.matches())
// "Your Firemaking level is now 9." {
String levelText = levelChild.getText(); return null;
}
String[] splitSkillName = skillText.split(" ");
String skillName = splitSkillName[splitSkillName.length - 2];
String skillLevel = levelText.substring(levelText.lastIndexOf(" ") + 1, levelText.length() - 1);
String skillName = m.group(1);
String skillLevel = m.group(2);
return skillName + "(" + skillLevel + ")"; return skillName + "(" + skillLevel + ")";
} }
/**
* Saves a screenshot of the client window to the screenshot folder as a PNG,
* and optionally uploads it to an image-hosting service.
*
* @param fileName Filename to use, without file extension.
* @param displayDate Whether to show today's date on the report button as the screenshot is taken.
*/
private void takeScreenshot(String fileName, boolean displayDate) private void takeScreenshot(String fileName, boolean displayDate)
{ {
if (client.getGameState() == GameState.LOGIN_SCREEN) if (client.getGameState() == GameState.LOGIN_SCREEN)
@@ -463,6 +476,13 @@ public class ScreenshotPlugin extends Plugin
}); });
} }
/**
* Uploads a screenshot to the Imgur image-hosting service,
* and copies the image link to the clipboard.
*
* @param screenshotFile Image file to upload.
* @throws IOException Thrown if the file cannot be read.
*/
private void uploadScreenshot(File screenshotFile) throws IOException private void uploadScreenshot(File screenshotFile) throws IOException
{ {
String json = RuneLiteAPI.GSON.toJson(new ImageUploadRequest(screenshotFile)); String json = RuneLiteAPI.GSON.toJson(new ImageUploadRequest(screenshotFile));

48
runelite-client/src/test/java/net/runelite/client/plugins/screenshot/ScreenshotPluginTest.java
View File

@@ -37,10 +37,8 @@ import net.runelite.api.events.WidgetHiddenChanged;
import net.runelite.api.widgets.Widget; import net.runelite.api.widgets.Widget;
import static net.runelite.api.widgets.WidgetID.DIALOG_SPRITE_GROUP_ID; import static net.runelite.api.widgets.WidgetID.DIALOG_SPRITE_GROUP_ID;
import static net.runelite.api.widgets.WidgetID.LEVEL_UP_GROUP_ID; import static net.runelite.api.widgets.WidgetID.LEVEL_UP_GROUP_ID;
import static net.runelite.api.widgets.WidgetInfo.DIALOG_SPRITE_SPRITE;
import static net.runelite.api.widgets.WidgetInfo.DIALOG_SPRITE_TEXT; import static net.runelite.api.widgets.WidgetInfo.DIALOG_SPRITE_TEXT;
import static net.runelite.api.widgets.WidgetInfo.LEVEL_UP_LEVEL; import static net.runelite.api.widgets.WidgetInfo.LEVEL_UP_LEVEL;
import static net.runelite.api.widgets.WidgetInfo.LEVEL_UP_SKILL;
import static net.runelite.api.widgets.WidgetInfo.PACK; import static net.runelite.api.widgets.WidgetInfo.PACK;
import net.runelite.client.Notifier; import net.runelite.client.Notifier;
import net.runelite.client.config.RuneLiteConfig; import net.runelite.client.config.RuneLiteConfig;
@@ -66,14 +64,14 @@ public class ScreenshotPluginTest
@Mock @Mock
@Bind @Bind
Client client; private Client client;
@Inject @Inject
ScreenshotPlugin screenshotPlugin; private ScreenshotPlugin screenshotPlugin;
@Mock @Mock
@Bind @Bind
ScreenshotConfig screenshotConfig; private ScreenshotConfig screenshotConfig;
@Mock @Mock
@Bind @Bind
@@ -85,7 +83,7 @@ public class ScreenshotPluginTest
@Mock @Mock
@Bind @Bind
OverlayRenderer overlayRenderer; private OverlayRenderer overlayRenderer;
@Mock @Mock
@Bind @Bind
@@ -104,7 +102,7 @@ public class ScreenshotPluginTest
} }
@Test @Test
public void testcluescroll() public void testClueScroll()
{ {
ChatMessage chatMessageEvent = new ChatMessage(SERVER, "Seth", CLUE_SCROLL, null); ChatMessage chatMessageEvent = new ChatMessage(SERVER, "Seth", CLUE_SCROLL, null);
screenshotPlugin.onChatMessage(chatMessageEvent); screenshotPlugin.onChatMessage(chatMessageEvent);
@@ -114,7 +112,7 @@ public class ScreenshotPluginTest
} }
@Test @Test
public void testbarrowschest() public void testBarrowsChest()
{ {
ChatMessage chatMessageEvent = new ChatMessage(SERVER, "Seth", BARROWS_CHEST, null); ChatMessage chatMessageEvent = new ChatMessage(SERVER, "Seth", BARROWS_CHEST, null);
screenshotPlugin.onChatMessage(chatMessageEvent); screenshotPlugin.onChatMessage(chatMessageEvent);
@@ -123,7 +121,7 @@ public class ScreenshotPluginTest
} }
@Test @Test
public void testraidschest() public void testRaidsChest()
{ {
ChatMessage chatMessageEvent = new ChatMessage(SERVER, "Seth", RAIDS_CHEST, null); ChatMessage chatMessageEvent = new ChatMessage(SERVER, "Seth", RAIDS_CHEST, null);
screenshotPlugin.onChatMessage(chatMessageEvent); screenshotPlugin.onChatMessage(chatMessageEvent);
@@ -132,21 +130,17 @@ public class ScreenshotPluginTest
} }
@Test @Test
public void testHitpoints() public void testHitpointsLevel99()
{ {
Widget widget = mock(Widget.class); Widget widget = mock(Widget.class);
when(widget.getId()).thenReturn(PACK(LEVEL_UP_GROUP_ID, 0)); when(widget.getId()).thenReturn(PACK(LEVEL_UP_GROUP_ID, 0));
Widget skillChild = mock(Widget.class);
when(client.getWidget(Matchers.eq(LEVEL_UP_SKILL))).thenReturn(skillChild);
Widget levelChild = mock(Widget.class); Widget levelChild = mock(Widget.class);
when(client.getWidget(Matchers.eq(LEVEL_UP_LEVEL))).thenReturn(levelChild); when(client.getWidget(Matchers.eq(LEVEL_UP_LEVEL))).thenReturn(levelChild);
when(skillChild.getText()).thenReturn("Congratulations, you just advanced a Hitpoints level.");
when(levelChild.getText()).thenReturn("Your Hitpoints are now 99."); when(levelChild.getText()).thenReturn("Your Hitpoints are now 99.");
assertEquals("Hitpoints(99)", screenshotPlugin.parseLevelUpWidget(LEVEL_UP_SKILL, LEVEL_UP_LEVEL)); assertEquals("Hitpoints(99)", screenshotPlugin.parseLevelUpWidget(LEVEL_UP_LEVEL));
WidgetHiddenChanged event = new WidgetHiddenChanged(); WidgetHiddenChanged event = new WidgetHiddenChanged();
event.setWidget(widget); event.setWidget(widget);
@@ -156,21 +150,17 @@ public class ScreenshotPluginTest
} }
@Test @Test
public void testFiremaking() public void testFiremakingLevel9()
{ {
Widget widget = mock(Widget.class); Widget widget = mock(Widget.class);
when(widget.getId()).thenReturn(PACK(LEVEL_UP_GROUP_ID, 0)); when(widget.getId()).thenReturn(PACK(LEVEL_UP_GROUP_ID, 0));
Widget skillChild = mock(Widget.class);
when(client.getWidget(Matchers.eq(LEVEL_UP_SKILL))).thenReturn(skillChild);
Widget levelChild = mock(Widget.class); Widget levelChild = mock(Widget.class);
when(client.getWidget(Matchers.eq(LEVEL_UP_LEVEL))).thenReturn(levelChild); when(client.getWidget(Matchers.eq(LEVEL_UP_LEVEL))).thenReturn(levelChild);
when(skillChild.getText()).thenReturn("Congratulations, you just advanced a Firemaking level.");
when(levelChild.getText()).thenReturn("Your Firemaking level is now 9."); when(levelChild.getText()).thenReturn("Your Firemaking level is now 9.");
assertEquals("Firemaking(9)", screenshotPlugin.parseLevelUpWidget(LEVEL_UP_SKILL, LEVEL_UP_LEVEL)); assertEquals("Firemaking(9)", screenshotPlugin.parseLevelUpWidget(LEVEL_UP_LEVEL));
WidgetHiddenChanged event = new WidgetHiddenChanged(); WidgetHiddenChanged event = new WidgetHiddenChanged();
event.setWidget(widget); event.setWidget(widget);
@@ -180,21 +170,17 @@ public class ScreenshotPluginTest
} }
@Test @Test
public void testAttack() public void testAttackLevel70()
{ {
Widget widget = mock(Widget.class); Widget widget = mock(Widget.class);
when(widget.getId()).thenReturn(PACK(LEVEL_UP_GROUP_ID, 0)); when(widget.getId()).thenReturn(PACK(LEVEL_UP_GROUP_ID, 0));
Widget skillChild = mock(Widget.class);
when(client.getWidget(Matchers.eq(LEVEL_UP_SKILL))).thenReturn(skillChild);
Widget levelChild = mock(Widget.class); Widget levelChild = mock(Widget.class);
when(client.getWidget(Matchers.eq(LEVEL_UP_LEVEL))).thenReturn(levelChild); when(client.getWidget(Matchers.eq(LEVEL_UP_LEVEL))).thenReturn(levelChild);
when(skillChild.getText()).thenReturn("Congratulations, you just advanced an Attack level.");
when(levelChild.getText()).thenReturn("Your Attack level is now 70."); when(levelChild.getText()).thenReturn("Your Attack level is now 70.");
assertEquals("Attack(70)", screenshotPlugin.parseLevelUpWidget(LEVEL_UP_SKILL, LEVEL_UP_LEVEL)); assertEquals("Attack(70)", screenshotPlugin.parseLevelUpWidget(LEVEL_UP_LEVEL));
WidgetHiddenChanged event = new WidgetHiddenChanged(); WidgetHiddenChanged event = new WidgetHiddenChanged();
event.setWidget(widget); event.setWidget(widget);
@@ -204,21 +190,17 @@ public class ScreenshotPluginTest
} }
@Test @Test
public void testHunter() public void testHunterLevel2()
{ {
Widget widget = mock(Widget.class); Widget widget = mock(Widget.class);
when(widget.getId()).thenReturn(PACK(DIALOG_SPRITE_GROUP_ID, 0)); when(widget.getId()).thenReturn(PACK(DIALOG_SPRITE_GROUP_ID, 0));
Widget skillChild = mock(Widget.class);
when(client.getWidget(Matchers.eq(DIALOG_SPRITE_SPRITE))).thenReturn(skillChild);
Widget levelChild = mock(Widget.class); Widget levelChild = mock(Widget.class);
when(client.getWidget(Matchers.eq(DIALOG_SPRITE_TEXT))).thenReturn(levelChild); when(client.getWidget(Matchers.eq(DIALOG_SPRITE_TEXT))).thenReturn(levelChild);
when(skillChild.getText()).thenReturn("Congratulations, you just advanced a Hunter level.");
when(levelChild.getText()).thenReturn("Your Hunter level is now 2."); when(levelChild.getText()).thenReturn("Your Hunter level is now 2.");
assertEquals("Hunter(2)", screenshotPlugin.parseLevelUpWidget(DIALOG_SPRITE_SPRITE, DIALOG_SPRITE_TEXT)); assertEquals("Hunter(2)", screenshotPlugin.parseLevelUpWidget(DIALOG_SPRITE_TEXT));
WidgetHiddenChanged event = new WidgetHiddenChanged(); WidgetHiddenChanged event = new WidgetHiddenChanged();
event.setWidget(widget); event.setWidget(widget);