[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


    If you are using a permissions plugin, you now need a permission lockette.create.* to protect things.

    That was only from using an out of date version of bukkit. (Prior to build 537 I think.)
    Redstone current has to be disabled for protected doors, as it is anonymous, unless [Everyone] is a user.
  3. Offline


    Is there any way to limit the amount of objects someone can lock at once? And to have it different depending on the permission group?
  4. Offline


  5. Offline


    Ah, yes, some sort of limit is requested often, but this is not possible without some sort of database to track the number of locked containers someone has. On the up side, without a database you can have literally millions of locked containers without any sort of lag.

    I am wondering though, why would you need to limit the number if there are zero lag issues for lots of them?
  6. Offline


    I am sorry if this has been answered but is their a way to limit how many chests a user can lock? Again I am sorry if this has been answered or if I am just missing it in the instructions but I cannot seem to find an answer D:
  7. Offline


    Read the message just before yours.. Heh, I gotta add it to the main post..
  8. Offline


    /smack :D It is always the last post! I read to page 9 I think :d

    And to answer you question, I want to run more of a hardcore server.. I want to be able to give everyone just one large chest at the faction area and everything else is free game and or donation for more chests(Not much ofc!). I cannot rely on everyone to follow the rules and I am sure I will end up with more bans than users D:
  9. Offline


    Great script only problem is the world-wide message of admin snooping, should be disabled. With permissons, the admin
    can only set "admins" to snoops and not moderators, after all it was the admins to grab this script for their players, why would they want to steal even-so with the commands they have and yes I know you posted a response to why, but your are talking as everyone is a criminal, if you cant trust an admin on your server, you should leave.
  10. Offline


    Ah, though you can do this by only allowing admins to create the chests for each user that should have one, via the appropriate permissions. See the advanced setup section. Mind you, it is some extra work for admins, though you can control better where locked chests can be placed.

    In case you missed it, to disable the message you can set the line as follows in strings.yml:
    msg-admin-snoop: ""

    As for the bit about trust, to me it is more a matter of privacy~ From a user's point of view, a private chest shoud be... private, and I try to respect the privacy of chest users foremost.

    In any case, it is hard to keep everyone happy. :3
  11. Offline


    But im in admin group and that has '*' = everything And i am op...

    I tryed to add what u said but still nothing..
  12. Offline


    same thing for me it always say "Lockette:permission to lock container denied" but I AM THE ADMIN
  13. Offline


    Hmm, I wasn't aware people were having problems, yes permission should be included in '*'. You'd better tell me the specifics of your setup, like Craftbukkit build, what permissions plugin and what version, etc.

    It could be an issue with a specific permissions plugin and version, but looking at the code, it may be a multiworld related configuration issue as well. You need to have '*' for each world, to have permission there. (Are either of you using a multiworld setup?)
  14. Offline


    Is this compatible with with 670 yet?
  15. Offline


    I am also having that problem????? do you now what is wrong. Do you know when you could fix it????? :confused:
  16. Offline


    You gotta be kidding me. Acru just said in what you QUOTED to mention what your setup was (bukkit version, permission version) to be able to help fix the issue and you mentionned nothing in your post.
  17. Offline


    I only have one world
    I got craftbukkit 646 (I think...)
    I got the newest version of Permissions 2.6
    But Lockette was working before the update

    EDIT: ah the problem was that i was running groupmanager with permissions
    try running only one at time...
  18. Offline


    has anyone tested this with 670?
  19. Offline


    I just gave it a whirl in build 670, and it seems all is still okay~ Let me know if I am wrong. :3

    Indeed~ :3

    Ah, true, that would do it.

    As things are setup now, Lockette will favor GroupManager over Permissions, as GM includes a fake permissions jar. If GM is not available, then it will try and load Permissions.

    Is this the case for you, @jjplay175 and @tcvs? The console log will say which permissions system it is connecting to. Be sure it is the same permissions in which you are giving yourself the node '*'. It may possibly have something to do with using GroupManager along with a Permissions compatible config file?
  20. Offline


    Ah, true, that would do it.

    As things are setup now, Lockette will favor GroupManager over Permissions, as GM includes a fake permissions jar. If GM is not available, then it will try and load Permissions.

    Is this the case for you, @jjplay175, @heroanth2345, and @tcvs? The console log will say which permissions system it is connecting to. Be sure it is the same permissions in which you are giving yourself the node '*'. It may possibly have something to do with using GroupManager along with a Permissions compatible config file?[/quote]

    yep you got it all
  21. Offline


    I don't quite take your meaning. :3
    And oops, I put your name in the tag list though you said you fixed~
  22. Offline


    Could you add the option that chest protection can be disabled in the config?
  23. Offline


    nope Only one world I have the newer permissions 2.6 I think (off the top of my head) And bukkit 617

    So it should work.. But like i said before its saying access denied :/

    -------- Edit ---------

    Just read a few other posts and ye groupmanager is in there.. I will remove it now and see if it fixes.

    ---- Fixed ----

    Ty :) my server is now safe from Thiefs :eek:

    Ps: i can now disable other people using the lock system.. hmm... Idea for a bank! :D lol
  24. Offline


    By the way, is it prossible to set "lockette.create.door"?
  25. Offline


    Okay, good. I'll see about catching this automatically in the future.

    Currently this is not possible, but I left open the possibility for a future version. If added, it would come in the latter form, different sub-permissions for locking doors, chests, etc. Would you consider this a useful feature?
  26. Offline


    I'm saying it in the way that you were right (you need to add permissions in groupmanager and not in permissions if you have the two ones)
    And yeah I fixed it :)
  27. Offline


    Would it be possible at all to make the locks expire after a set time? Maybe with a built-in timer on the [Private] line, counting down?
  28. Offline


    This is not possible without some sort of database to track them. It seems an odd thing to ask for though, what use did you have in mind?
  29. Offline


    I put the bypass permission for only the admin group however it seems that other groups are available to bypass all locks/doors. Could you please help out? Thanks in advance.
  30. Offline


  31. Offline


    I'd consider it a very useful feature.

Share This Page