Jail integration

[hitechwizard]

I'm trying to integrate Jail with my Swear Jar plugin so that a player that doesn't have the money to pay the Swear Jar they will be jailed for x minutes. Between the Bukkit wiki and digging through source I got this far, but jailPrisoner() is protected vs. public, and I don't see anywhere to get the prisoner instance to set the jail time. Any help would be appreciated.

               if (donation < fine) {
                    Plugin plugin = getServer().getPluginManager().getPlugin("Jail");
                    if (plugin != null)
                    {
                        JailMain jailPlugin = (JailMain) plugin;
                        Jail jail = jailPlugin.getJailManager().getNearestJail(player);
                        PrisonerManager jailPM = jailPlugin.getPrisonerManager();
                        jailPlugin.getPrisonerManager().jailPrisoner(jail, null, player, "Potty Mouth");
                    }
                    else
                    {
                        Bukkit.getServer().getScheduler().callSyncMethod(this, new KickPlayer(player, "You ran out of money for the swear jar."));
                    }
                }

[graywolf336]

I'm assuming you're using the newest version, 3.0 development?

Edit: You are, I can tell by the code.

[hitechwizard]

[INFO] Downloading: http://repo.graywolf336.com/content/repositories/snapshots/com/graywolf336/Jail/3.0.0-SNAPSHOT/Jail-3.0.0-20150521.200617-182.jar

[graywolf336]

Give me a few minutes and I'll have an example for you. 😄

[graywolf336]

package com.graywolf336.jail;

import org.bukkit.entity.Player;

import com.graywolf336.jail.beans.Jail;
import com.graywolf336.jail.beans.Prisoner;

public class JailAPIHitechwizardExample {
    private boolean useJailAPI;

    //JailMain is the main class, switch it to your own.
    public JailAPIHitechwizardExample(JailMain mainClass) {
        //Determine if the jail plugin is here or not
        if(mainClass.getServer().getPluginManager().getPlugin("Jail") == null) {
            useJailAPI = false;
        }else {
            useJailAPI = true;
        }
    }

    public void jailPlayerForSwearing(Player player) throws Exception {
        //Check if we're using the jail api, this way if the jail api doesn't
        //exist and this method gets called then we don't get a ton of errors
        if(useJailAPI) {
            //Create the instance of the prisoner with the reason
            //and the time, passing in the player instance
            Prisoner p = new Prisoner(player, JailsAPI.getTimeFromString("30m"), "Potty Mouth");
            //Get the jail closest to the player
            Jail j = JailsAPI.getJailManager().getNearestJail(player);
            //Send the information off to the jail plugin to have it handle the
            //jailing and all that lovely information
            JailsAPI.getPrisonerManager().prepareJail(j, null, player, p);
            //If the player is online, they should now be sent to jail
            //if they are offline, they'll be queued for when they come back online
        }else {
            //Do something when the jail plugin isn't on the server
        }
    }
}

Let me know if that doesn't make sense. I just committed some changes to the Prisoner class which enables the example above, so you'll have to be use and have the latest to be able to use it.

[hitechwizard]

The lightbulb came on - I was thinking the plugin would handle creating the Prisoner object, so the code above helped. The Swear jar plugin is at least 4 years old, so I just cobbled the following in, the only issue I have is this only puts the player at the telein position and not into a cell. Should passing null for the cell select an empty cell?

[14:22:06] [Server thread/INFO]: [Jail] Loading Jail v3.0.0-SNAPSHOT-b191
[14:22:21] [Server thread/INFO]: [Jail] Enabling Jail v3.0.0-SNAPSHOT-b191
[14:22:22] [Server thread/INFO]: [Jail] Storage type selected: flatfile
[14:22:22] [Server thread/INFO]: [Jail] Loaded the language: en
[14:22:22] [Server thread/INFO]: [Jail] Loaded jail techlandia with 0 prisoners and 1 cells.
[14:22:22] [Server thread/INFO]: [Jail] Loaded 1 jail.
[14:22:22] [Server thread/INFO]: [Jail] Loaded 1 cell.
[14:22:22] [Server thread/INFO]: [Jail] Loaded 0 prisoners.
[14:22:22] [Server thread/INFO]: [Jail] Using the Bukkit Scheduler.
[14:22:22] [Server thread/INFO]: [Jail] Loaded 2 jail sticks.
[14:22:22] [Server thread/INFO]: [Jail] Completed enablement.
....
[14:26:17] [Async Chat Thread - #0/INFO]: drewper has been jailed for 5 minutes for: Potty Mouth
[14:26:17] [Async Chat Thread - #0/INFO]: Drewper has made a donation to the swear jar.
[14:26:17] [Async Chat Thread - #0/INFO]: drewper has made a donation to the swear jar for saying testword

                if (useJailAPI)
                    {
                        try {
                            Prisoner prisoner = new Prisoner(player, JailsAPI.getTimeFromString("5m"), "Potty Mouth");
                            Jail jail = JailsAPI.getJailManager().getNearestJail(player);                       
                            JailsAPI.getPrisonerManager().prepareJail(jail, null, player, prisoner);
                        }
                        catch (Exception e) {
                            log.warning("Attempt to jail player failed");
                            log.warning(e.getMessage());
                        }
                    }else{
                        Bukkit.getServer().getScheduler().callSyncMethod(this, new KickPlayer(player, "You ran out of money for the swear jar."));
                    }
                }

[hitechwizard]

Another strange error that showed up on our test server (Jail-3.0.0-20150522.161010-183) that doesn't show up on our production server (Jail-3.0.0-SNAPSHOT)

[14:26:16] [Async Chat Thread - #0/ERROR]: [Jail] Your jailedgamemode setting is incorrect, please fix.

but the config is the default, and gameMode matches the production setting:

[minecraft@testing Jail]$ cat config.yml | grep -i mode
    gameMode: adventure
    restorePreviousGameMode: false
[minecraft@testing Jail]$ 

[hitechwizard]

Traced through the Jail code... found the reason it did what it did (noCellPrisoners), so was able to get the cell situation figured out:

Prisoner prisoner = new Prisoner(player, JailsAPI.getTimeFromString("5m"), "Potty Mouth");
Jail jail = JailsAPI.getJailManager().getNearestJail(player);
Cell cell = jail.getFirstEmptyCell();
JailsAPI.getPrisonerManager().prepareJail(jail, cell, player, prisoner);

[graywolf336]

Yeah, you'll need to pass in the cell you want the prisoner jailed to. The cell value of null means no cell, the easiest way to do that is to do:

JailsAPI.getPrisonerManager().prepareJail(jail, jail.getFirstEmptyCell(), player, prisoner);

I'm changing up how plugins can handle jailing to cells. Making an interface for the cells then implementing it in three ways:

• Cell
• AnyCell
• NoCell

And then people using the api can easily do the following:

JailsAPI.getPrisonerManager().prepareJail(jail, new AnyCell(), player, prisoner);

And it'll jail the prison in any open cell if there is one open or the following for no cell (along with null):

JailsAPI.getPrisonerManager().prepareJail(jail, new NoCell(), player, prisoner);

As for the reason of your error, open a new issue about that.

[hitechwizard]

Will do. Also, testing found an edge case - had to add a check to verify the player wasn't already jailed. Figured I'd post here as an example:

try {
    if (!JailsAPI.getJailManager().isPlayerJailed(player.getUniqueId())) { 
        Prisoner prisoner = new Prisoner(player, JailsAPI.getTimeFromString("5m"), "Potty Mouth");
        Jail jail = JailsAPI.getJailManager().getNearestJail(player);
        JailsAPI.getPrisonerManager().prepareJail(jail, jail.getFirstEmptyCell(), player, prisoner);
    }else{
        JailsAPI.getJailManager().getPrisoner(player.getUniqueId()).addTime(JailsAPI.getTimeFromString("1m"));
    }
}
catch (Exception e) {
    log.warning("Attempt to jail player failed");
    log.warning(e.getMessage());
}

[graywolf336]

Thanks for the code. So yeah, the exception comes from malformatted time string. I might add an item to the JailsAPI to make it easier to jail someone and the plugin assumes many things. Might make it like:
JailsAPI.jailPlayer(player, JailOptions.ANYJAIL, JailOptions.ANYCELL, time, reason)
And if the player is already jailed, then the api adds time and things like that. This way it is super easy, but I'll leave what's currently there in case someone wants more control over how people are jailed...yeah I've sold myself on it. 😄