[SEC] Lockette - Simple chest and door lock, no databases! [Moved to BukkitDev]

Discussion in 'Inactive/Unsupported Plugins' started by Acru, Feb 14, 2011.

  1. Offline


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

    ElgarL has been assigned as the current maintainer of this project, please forward any important issues to him as well. This post is abandoned, but proceed to BukkitDev for updates.

    Download it at BukkitDev! (Alternate) (JAR) (Source), also view the Change Log on BukkitDev.

    Supported external plugins:
    • Permissions - Permissions/Groups
    • GroupManager - Permissions/Groups
    • PermissionsBukkit - SuperPerms/Groups
    • PermissionsEx - SuperPerms/Groups
    • bPermissions- SuperPerms/Groups
    • Towny - Groups/Zones
    • SimpleClans - Groups
    • mcMMO - Groups (Disabled by default now, due to issues.)
    • Factions - Groups
    • LWC - Zones
    • Register - Economy
    Alternate languages included:
    Confirmed compatible plugins: ColorSign, SpeedSign.
    Conflicting plugins: ChestShop, Most sign editors!

    The active Lockette information page will commute to BukkitDev soon, but the forum thread is still the best place for discussion.


    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.

    • No passwords or databases needed!
    • Permission checks run in constant time, no matter how many protected containers.
      • One owner and up to 11 additional users supported. (17 for double chests!)
      • Allows access to [Everyone] while still protecting the container from vandalism.
      • Allows group names in conjunction with many other plugins.
    • Special powers for ops or admins, configurable with permissions.
      • Reports when an admin does something naughty.
    • Protects single and double chests, dispensers, and furnaces.
      • 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!
      • Double doors are handled automatically, with no redstone.
      • Doors can be set to close automatically, via a timer setting.
      • Redstone hacking is disabled for protected doors.
    • Prevents creation of chests larger than 2 blocks.
    • Informative or helpful messages when interacting with containers.
      • The first time a chest is placed, a help message will be shown.
      • Types of messages shown are configurable in settings.
      • Additional language support.

    Advanced Setup (Permissions) (open)

    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-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.
    • 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.
    • 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 ANSI format. If you need characters not in ANSI then you might try UTF-8 format, though it seems bugged tight now. 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. All non-ops will be able to create protected containers for themselves.

    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 (open)

    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 (open)

    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, perhaps, but if you need the details now then go poke through the source~

    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, and there are permissions to restrict who can create locked chests. Perhaps only allow Moderators to create locked chests for other users, if you don't want to allow infinite locked chests.

    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.
    • Worldguard connection.
    • [Protected] tag for viewing only.
    • Specific time range that doors can be opened.
    • DataLog plugin support.
    • More types of protected blocks, such as brewing stands.
    If you want any of the above features sooner than never, let me know! However, I currently see Lockette as functionally complete, for the most part, in that it already has all the functionality it needs. Future updates will mostly be to account for changes in Minecraft and Bukkit.

    Final Note:

    Please leave a reply if there are any bugs or suggestions, and if you like this plugin you can click the like button at the bottom of this post~ Thanks to those few that have donated! [​IMG]
  2. Offline


    Seams to work with 1.8 fine just have not tried fences.
  3. Offline


    yes ive been using it for like 2 months (both together)
  4. Offline


    Melonking likes this.
  5. Offline


    Im not using this plugin. But the idea not using a database but using your solution is fantastic.
    Great job.
  6. Offline


    TY Acru for this plugin! It has helped so many of our players keep griefers at bay ever since I started our server. I epically like the feature where now, all you have to do is right click on the chest, furnace, etc. and it locks it automatically! I was wondering though, is it possible to do this with doors? Or are you still working on that? Oh and one other thing of a more purrrsonal nature... You a Furry?
  7. It's also pretty much commandless and you can visibly see what is locked by whom, that's why I prefer this to LWC.
  8. Offline


    I'm looking into adding towny support for groups and wilds tonight.

    The instant locking works by clicking a container with a sign. Usually you put the sign above or below the door, and I can't suppress the text entry dialog in the same way for non-interactable blocks.

    As to fur, yes, but you could prolly tell that from my profile posts, heh~

    EDIT by Moderator: merged posts, please use the edit button instead of double posting.
    Last edited by a moderator: Jul 18, 2016
    Melonking likes this.
  9. Offline


    not applicable to the way this plugin works, but even if it used a database you wouldn't have a noticeable performance issue accessing chests unless you had _millions_
  10. Offline



    Are you going to be adding PermissionsBukkit support for this? We currently use Lockette and LWC, but Lockette doesn't read the groups people are in with PermissionsBukkit making it pretty frustrating as you can only make things private or have to list a massive list of users you'd like to grant access to.
  11. Offline


    it says u can lock a piston but how?!??!?! i dont know how!??!
  12. Offline


    I believe the 'full piston protection for doors and trap doors' means that pistons can't be used to destroy them if protected, not that you can protect pistons themselves. :)
    nunber1_Master likes this.
  13. Offline


    Why did you quote something 7 months ago derpy?
  14. trunks can not explode or anything Lockette sealed in versions 1.8.1 or above at least as I have seen
    enable-messages-help: true
    broadcast-snoop-target: '[Everyone]'
    broadcast-reload-target: '[Operators]'
    broadcast-break-target: '[Everyone]'
    enable-messages-error: true
    enable-quick-protect: true
    enable-messages-user: true
    enable-messages-owner: false
    enable-messages-admin: true
    enable-protection-doors: true
    default-door-timer: 0
    explosion-protection-all: false
    enable-permissions: true
    enable-protection-trapdoors: true
    strings-file-name: strings.yml
    allow-admin-bypass: false
    allow-admin-snoop: false

    (me admin, all permissions and not explode!!!)
  15. Offline


    Ah. Reason I was asking is because some of my members like to put the sign directly on the door instead of on a block around it and last time I checked you couldn't do that. As to your other response, I wanted to hear it from you. I don't like spreading or making rumors. :3
  16. Offline


    Does this work with the 1157# build?
  17. Offline


    I looked into it and the problem is that PermissionsBukkit doesn't provide any simple way to check if a given player is in a given group, and as I had mentioned before, SuperpermsBridge doesn't implement the inGroup function either. I added a bukkitdev ticket as Space hasn't yet responded to my conversation, though no telling if that will be noticed any time soon either. I do see one possibility for doing the check externally, but it will still be clunky and slow if it works.

    Edit: I poked in some PermissionsBukkit group support, do you want to test it for me?

    Protected chests can never be blown up, to allow this would be the opposite of protected. :3

    It is still a possibility, if it'd be useful, though more of a pain for me, hee~

    I don't test with non-recommended builds unless I am alerted to an issue. Fence gates may or may not work but everything else should be ok, unless the bukkit team made an error in the transition. You tell me if it works? :3

    Okay, I just put out a new version with some of the things asked for, but I'm reeeealy tired right now so I may have made mistakes~

    • Experimental Towny support, though not tested. I need someone to help with testing!
      • Core: Towny group support for towns/nations.
      • New permission lockette.towny.wilds for protecting in the wilds.
    • Fixed quick-protect throwing an exception when another plugin removed the placed sign.
    • Core: New support of build zones.
    • Core: Improved handling when using multiple permission/group plugins.
    • Core: Added PermissionsBukkit group support.

    EDIT by Moderator: merged posts, please use the edit button instead of double posting.
    Last edited by a moderator: Jul 18, 2016
  18. Acru, I reverted the Static change on WorldHolder in GroupManager to make things easier. Sorry for breaking things.

    Next push of GM will be back to normal ;).
  19. Offline


    No worries, in 1.4 I had put in a workaround so it works whether static or not.

    And incidentally, just poked out 1.4.1, trying to get some proper Towny support in.
    Perhaps you could help test while you are here? o3o

    Edit: Actually, nevermind. You prolly have enough to do already and I'm sure a user of both plugins will turn up to help~ :3

    Can you try 1.4.1 and tell me if groups work now? The bridge is still needed for permissions though.

    EDIT by Moderator: merged posts, please use the edit button instead of double posting.
    Last edited by a moderator: Jul 18, 2016
  20. Offline


    I don't want the players to lock doors (because some problems I had). How do I do that?
  21. Offline


    LoL I'm sorry, your first message was at 6:15 AM my time, so this is the first I've been on the forums today. Yeah I'll download it now and give it a whirl. :)

    1.4.1 I'm afraid to report, breaks PermissionsBukkit. It seems to overwrite the permissions, no players (even ops or console) have any permissions, can't reload the server or the permissions file and nobody can build. Removed the Jar and everything works again. Space may not be overly quick at replying (he seems to leave most of the work to the others on the project now), you could always take a look at Acru's source for LWC though as he managed to hook it into PermissionsBukkit.

    I really appreciate you trying to fix this problem, I miss being able to add groups to my signs. :)

    EDIT by Moderator: merged posts, please use the edit button instead of double posting.
    Last edited by a moderator: Jul 18, 2016
  22. Offline


    I forgot I edited that first post, I was quite tired. XD

    Well that is unexpected, were there any errors in the console?
    Edit: If you can send me a console log it would help, plus it should tell me what version everything is.

    Edit 2:
    Perhaps I won't need a log after all.
    I was able to reproduce this with an empty permissions.yml and versions 1.2/1060.
    For some reason it is ignoring commands from the console, saying no permission, only while Lockette is linked.
    I am looking into the cause of this.

    You can completely disable door protection in the configuration file, or else just not give permission to lock doors.

    EDIT by Moderator: merged posts, please use the edit button instead of double posting.
    Last edited by a moderator: Jul 18, 2016
  23. Offline


    Sorry, I went off to do something else again haha. So easily distracted. Nothing really in the log, and since you've recreated the issue it's probably pointless but here you go anyway just in case. :)

    Attached Files:

  24. Offline


    I traced the problem to an issue in bukkit. It seems if you call the plugin manager to enable another plugin (and the plugin is not yet enabled), it doesn't read the super permissions out of the correct plugin.yml file... For now I guess the solution is to not try and enable plugins that use super permissions, and file a bukkit bug report. Fix incoming.
    khamseen_air likes this.
  25. Offline


    Hello Acru. Thanks for a great plugin! but I am having an issue getting it to work. I've installed it and whenever I try to lock a door or instant-lock on a chest it says that I do not have permissions. I am the admin on my server and also defined as Operator. I am using Towny, HeroChat, MCmmo, Multicurrency, Borderguard and im using PermissionEx. Now I've defined my admin group to have the right nodes to create chests for other people and modify them, but I still can't lock these objects. - Can you please suggest what the problem might be?? Thanks alot!
  26. Offline


    Try the fix I just released, 1.4.2, and let me know if it is better~ (Towny and PermissionsEx were effected.)

    Edit: Also, it needs the PermissionsEx bridge at the moment, 'PermissionsCompat', called just Permissions.jar in the download.
  27. Offline


    Hello Acru. Im having a problem with making lockette work, everytime i try to edit a sign to lock a chest, the following message pops up in the server consol.

    01:02:04 [SEVERE] Could not pass event SIGN_CHANGE to Lockette
    java.lang.NoClassDefFoundError: com/palmergames/bukkit/towny/Towny
    at org.yi.acru.bukkit.PluginCore.canBuild(PluginCore.java:394)
    at org.yi.acru.bukkit.Lockette.LocketteBlockListener.onSignChange(Locket
  28. Offline


    Edit: Also, it needs the PermissionsEx bridge at the moment, 'PermissionsCompat', called just Permissions.jar in the download.

    I'm not sure where to get this bridge you're talking about??
  29. Offline


    Blah! Thanks though, seems I overlooked something trying to fix another bug... Lockette 1.4.3 shortly... >.<

    When you download the PermissionsEx 1.13 zip, it is in there.
  30. Offline


    Alright I've downloaded the bridge that was in the permex zip and instaleld the jar into the plugins folder and rebooted the serve, reopped myself, rechecked permissions and removed and added myself to admin group on my server and I still cant use lockette. :L its nearly 5 am, but I just cant go to sleep until this is working xD please help me! T_T

Share This Page