Lockette v1.3.7 - The sign-based container and door lock for Bukkit! - by Acru Jovian


Overview:

The purpose of this plugin is to restrict access to the contents of chests, dispensers, furnaces, and doors without the use of a database to track containers.

To use, simply place a signpost on the floor directly beside a chest or other container to be locked. Enter [Private] as the first line. Your own name will automatically be entered on line 2 as the chest owner. Optionally type in the full names of two other users allowed to access the chest's inventory on lines 3 and 4.

When done correctly, the sign will automatically fix itself to the side the target chest, protecting it from unauthorized access! Only the chest's owner can then break the sign or chest. (Warning: Anyone with permission to use WorldEdit commands or similar can circumvent the protection by removing the sign.)

Additionally, you can enter [Everyone] on lines 3 or 4 instead of a user name to allow everyone access to the contents of a private container, or [Operators] to allow ops access. If a Permissions plugin is available, you can use groups like [Moderator] or [Admins] or others as defined in the Permissions settings files.

The owner of a container can add more users by placing additional signs beside the container with the heading [More Users], where lines 2-4 specify the names of the additional users. You can edit the users on previously placed signs by right clicking the sign, and using the command '/lockette <line number> <text>' to change it.


Working with Doors:

To protect a door, you can use the same method as protecting a container, the sign will attach to the door automatically. In addition, you can attach a [Private] wall sign to any side of the blocks just above or just below a door. For double doors only one side needs a sign. Door support is enabled by default in the config file.

Once a door is protected it will only open for someone listed as a user, and will not respond to redstone power or switches unless [Everyone] is listed as a user. Iron doors which usually won't open from clicking will work just as wooden doors. In addition, double doors will open together automatically!

You can also use [More Users] signs as with containers, with the caveat that the sign cannot be placed on the block above the door if the [Private] sign is not above the door as well! (This is done to prevent a security uncertainty issue.)

Protected doors will be closed automatically if a timer is set. A timer can be set globally with a configuration option, or individually for each door by using the tag [Timer: #] on line 3 or 4 of the [Private] sign, where # is the number of seconds that the door should remain open. If the timer is set to 0, this means the door will never automatically close. If no timer is specified, protected doors will use a global timer set in the configuration file. If the server is shut down cleanly any open doors will be closed, but in the event of a server crash while a door is open, it may remain so.  Note that the initial state of a door is assumed to be closed.

Care must me taken to place protected doors on a stable block. Building a door on sand, gravel, leaves, TNT and et cetera are allowed by the plugin, but cannot be secured fully. :3 Additionally, it should be noted that most status messages still refer to locked blocks as containers, so for the purpose of simplicity, doors should be considered as a type of container.


Features:

    * No passwords or databases needed!
    * Permission checks run in constant time, no matter how many protected containers.
          o One owner and up to 11 additional users supported. (17 for double chests!)
          o Allows access to [Everyone] while still protecting the container from vandalism.
          o Allows group names in conjunction with a Permissions plugin.
                + Native support for GroupManager.
    * Special powers for ops or admins, configurable with permissions.
          o Reports when an admin does something naughty.
    * Protects single and double chests, dispensers, and furnaces.
          o Explosion and block-break protection for the protected container and sign.
                + Option to protect all containers from explosions.
    * Full support for doors, both wooden and iron!
          o Double doors are handled automatically, with no redstone.
          o Doors can be set to close automatically, via a timer setting.
          o Redstone hacking is disabled for protected doors.
    * Prevents creation of chests larger than 2 blocks.
    * Informative or helpful messages when interacting with containers.
          o The first time a chest is placed, a help message will be shown.
          o Types of messages shown are configurable in settings.
          o Additional language support.


Advanced Setup:

There are a few things you can now customize in the configuration files for the plugin, found in the plugins/Lockette folder. After running the plugin for the first time, two files will be created, config.yml and strings.yml. The first holds the following settings:

    * enable-messages-* - Enables or disables groups of messages listed in the strings.yml file. Not counting the broadcast ones.
    * broadcast-*-target - Sets the group or player that specific broadcast messages should be sent to. This can be set to "" for no one.
    * explosion-protection-all - Enabling this extends explosion protection to all containers on the server, not just [Private] ones. Default is disabled.
    * enable-permissions - Allows the use of permission nodes to specify who can do what. If this is disabled, groups will still be used but admin status is taken from the ops file. Defaults to false.
    * allow-admin-bypass - Allows admins to go though any protected door. Default is true.
    * allow-admin-snoop - Allows admins to peek into chests owned by other people. Default is false, and this setting is recommended! A broadcast message will be sent each time an admin snoops in a protected container where the admin doesn't have permission to. The message will be sent to a player or group as specified in another option. Admins can still break protection on chests if this is disabled, however.
    * enable-protection-doors - Enables support for private doors, defaults to true.
    * default-door-timer - Sets the door closing timer for all protected doors on the server, unless overridden by a specific sign. Defaults to 0, which disables the door closing timer.

In the strings.yml file, you can set alternate language tags for [Private] and such, in UTF-8 format. The default alternate tags are in French, but server ops are free to translate the whole file into the language of their choice. If you do this, please share it back to me~ :3 If you want to disable only a specific message, you can set it to "", the empty string. Admins can use the command '/lockette reload' after editing the configuration files, to reload them.

If a Permissions plugin is not available or the enable-permissions option is set to false, Lockette will use the ops file to determine who are admins. Admins can break the protection on any chest, and look inside protected chests (only if the related option is set), as well as reload the plugins configuration files.

If a Permissions plugin is available and the enable-permissions option is set to true, the following nodes will be used instead of the ops file and are included by default in the '*' node:

    * lockette.user.create.* - Permission required to create a protected container or door. Possible sub-nodes include chest, dispenser, furnace, and door.  (The permission lockette.create.all is still supported, but obsolete.)
    * lockette.admin.create.* - Allows admins to create containers and doors for other users. Possible sub-nodes include chest, dispenser, furnace, and door. Leave line 2 blank for the default behavior or enter the name of your choice. Capitalization matters.
    * lockette.admin.break - Allows breaking protection on containers.
    * lockette.admin.bypass - Allows opening of any locked door.
    * lockette.admin.snoop - Allows peeking in protected containers. (The setting allow-admin-snoop must be true.)
    * lockette.admin.reload - Allows use of the reload command.


Technical Information:

This plugin has been tested and shown to be working for many builds of CraftBucket though a number of the more recent builds had a serious issue, so I'm suggesting a minimum build of 561 now. If you update past what is listed in the post's title and the plugin seems to break, it is probably not my fault. Post a note anyway and I'll see about fixing. I'll try and keep up with the new recommended build system, but for latest builds that break things, you should expect some time to pass before I take care of the issue, as this plugin is now mature. :3

If there are multiple containers by the placed sign, the plugin will use the NESW rule to choose the first container that is not yet private. To elaborate, the plugin will check to the north of the sign first, and if no container or door is available to the north, it will continue checking clockwise around the sign.

Due to the current implementation of the explosion event, this plugin will cancel all explosions that would damage the container or sign, rather than just remove the container and sign from the blocks to be damaged. Canceled explosions still knock signs off the walls. Canceled explosions leave signs looking blank, but this is just a graphic glitch, reconnect to fix.

Bonus: This plugin will prevent chests bigger than 2 blocks from being created via glitches. (Again, this could be circumvented using WorldEdit commands, so take care who has access to such a plugin.)

This plugin was inspired by the old hmod plugins Lock by Roman "kingseta" Pramberger and ChestCapsule by Fernando "Fergo".


Hooking into Lockette:

If you are a plugin author and want to connect to Lockette, you can use a public static function to get information about the protected status of a block.  More info later.


Future Possibilities:

There are a number of things that have been suggested, and they tend to be added to the list below if I think they might be a good idea. However, some sort of locked container limit is requested often but this is not possible without a database to track the number of locked containers someone has. All things considered, this will not be supported. On the up side, without a database you can have literally millions of locked containers without any sort of lag.

Aside what has already been implemented, the following may or may not appear in future versions:

    * Furnace/dispenser clusters, protected by a single sign.
    * [Log] sign to list recent users of a container or door.
    * iConomy fee for protecting containers/doors.
    * Automatic tagging of keywords with color codes.

If you want any of the above features sooner than never, let me know!


Changelog:

Version 1.3.7
    * Worked around a change in MinecartManiaAdminControls breaking door signs.
    * Changed the default value for enable-permissions to false.
          o Too many people had Permissions/GroupManager installed but didn't know how to use.
          o This will not effect existing configuration files.

Version 1.3.6
    * Fixed a config file option forcing permissions on if there are no permission plugins.
    * Added an internal warning about builds 685-703.

Version 1.3.5
    * Automatically closing doors! (Eg.: Use [Timer: 5] on the private sign.)
          o The global configuration setting can be overridden using an option on the sign.
    * Added a check to see if a user is online, when creating a container for another user.
          o Allowed a group to be set as an owner, but with no permission to modify.
    * Support for using GroupManager and Permissions simultaneously.
          o Fix for some dated or fake versions of permissions plugins.
    * Separate permissions for creating protection on different types of blocks.
          o Also for the admin version.
          o Changed lockette.create.* to lockette.user.create.*, but left in support for the old node.
    * Added a number of new configuration options.
          o Several options to specify who to send the broadcast messages to.
                + Support for either a group or a specific player.
          o Options for disabling permissions and door bypassing.
    * Fixed a case where the bypass message reported the wrong user.
    * Added a workaround for an mcMMO bug.
    * New undocumented command '/lockette version'.

Version 1.3.4
    * Native support for GroupManager, up to date Permissions handling, and three new permissions nodes!
          o Changed snoop behavior for doors, with a new permission, no longer broadcasts.
          o Added a permission for creating locked containers at all.
          o Added an admin permission for creating locked containers for anyone.
    * Improved player listener effeciency in builds 588+.
    * Fixed an exception that was throwing for builds 561-587.
    * Wooden door breakage security fix for change in builds 561+.
    * Blocked tilling dirt under a door in builds 561+.
    * Blocked placing of doors by owned doors in builds 561+.
    * Updated internal minimum recommended build to 561... :3
          o Added an internal warning about builds 605-612.

Version 1.3.3
    * Fixed plugin for a breaking change in CB build 600, though backwards compatible.
    * Added a second undocumented public function, for connectivity.

Version 1.3.2
    * Enabled redstone for protected doors with [Everyone] as a user.
    * Improved detection of conflicting private doors, when creating new ones.
    * Relaxed restrictions on the placement of [More Users] signs on doors. (See doors section.)
    * Blocked a possible security issue with double doors.
    * Added support for CraftBukkit build 561 and up.

Version 1.3.1
    * Increased the internal recommended build version from 522 to 552. (Oops.)
    * Added a config file option to globally enable/disable door support.
    * Slightly changed container search to use the NESW rule, disregarding block types.

Version 1.3
    * Full support for protected doors, including double doors.
    * Added [Operators] keyword as a built in user group.
    * Color codes are stripped from signs before processing, for color compatibility.
    * Prevents an issue where one could replace sign text, in CB builds prior to 522.
    * Catches issues with out of date Permissions plugin.
    * Exposes an interface for other plugins to access, to check Lockette protected blocks.
    * Some general speed improvements.

Version 1.2.2
    * Workaround for Craftbukkit 454+, though this may break again in the future.
    * Fixed a bug I noticed in sign editing.

Version 1.2.1
    * Built against a newer version of Bukkit.

Version 1.2
    * Added configurations file for settings, and a strings file for additional language support.
    * Full Nijikokun's Permissions support, both versions 2.0 and 2.1, for groups and admin powers.
          o Defaults to using the ops file, if the plugin isn't available.
    * Allowed the editing of previously placed signs.
    * More helpful messages, and options to disable them if you don't like messages.
    * Many other small details.

Version 1.1.4
    * Added a check for the server's CraftBukkit build version on enable. Enable will be aborted if it detects an unsupported version, and says so clearly in the log. (Auto-detects builds 231-326 only.)
    * Strengthened the owner's username check to be case sensitive. (Entered automatically, so no need to be insensitive here.)
    * Removed one unnecessary server log message.

Version 1.1.3
    * Added informational server log messages.
    * Added preliminary support for Nijikokun's Permissions plugin. (Not functional yet.)
    * Thought up a better namespace, so changed it again.

Version 1.1.2
    * Relaxed all user name checks to be case insensitive.
    * Updated plugin to use a more personal namespace. (Required by craftbukkit soon.)

Version 1.1.1
    * Made the check for [Everyone] case insensitive.

Version 1.1
    * Protection extended to Dispensers and Furnaces.
    * Explicitly blocked the creation of illegal sized chests. (Chests are 1 or 2 blocks in size only.)
    * Allowed [Everyone] as a user that lets anyone into the container.
    * Allowed more users via additional signs, headed [More Users].

Version 1.0.1
    * Improved handling of long user names. (Name matches to 15 characters.)
    * Improved status messages from the plugin.

Version 1.0
    * First public release.