[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

    Acru

    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.



    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.)

    [​IMG]

    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.
      • 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

    L3nnyBoss

    Does this work with 953?????
     
  3. Offline

    Makan747

    When will you update to 953 ?

    // Makan
     
  4. Offline

    fneyret

    Yep, seems to work with 953 :)
     
  5. Offline

    Jadedwolf

    There is no stored data, other then the map data, as that is where the sign data is stored and thus where lockette gets its data. The sign has the data that says whats on it and thus lockette reads that and does actions accordingly.
     
  6. Offline

    madcrazydrumma

    Yeh everything basically works... its just that i would like to have a command as well as signs... because the signs get in the way and a bit annoying with some of my other plugins...
     
  7. Offline

    Pasukaru

    @madcrazydrumma
    if you want commands to lock your chests - this definitely the wrong plugin for you.
    You should use LWC instead.
     
  8. Offline

    madcrazydrumma

    True , but it would be nice for lockette also
     
  9. Offline

    Bluebomb

    Does this work with the latest update?
     
  10. Offline

    Scyfi

    Works for me with the 948 build

    That is what makes lockette better then others is no databases to read from.

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

    Noucki

    It's a very nice plugin bug the developer don't update his awesome plugin :(
     
  12. Offline

    cole2

    Apparently there is a bug with pistons where you can push a door away and destroy it, as well as a sign.
    Screenshots (open)

    [​IMG]
    [​IMG]
    [​IMG]
    [​IMG]

    If you could make it so that pistons cannot be built in a 3 radius of a Lockette sign that would be awesome :)
     
  13. Offline

    Digi

    The bigger problem would be with chests and double chests... what would happen if you push a chest or a part of double chest ? I guess the same.

    Still, if you can actually block pistons from moving something, you should do that instead of disallowing of building them.
     
  14. Offline

    cole2

    You can't push chests because they are tile entities. Also, I haven't heard of a PISTON_MOVE hook or anything related for plugins.
     
  15. Offline

    Jadedwolf

    Pistons cannot push blocks with data values, chests, signs, etc.. So no you can not break a chest with pistons anytime regardless of lockette.
     
  16. Offline

    Chasingu

    Is this CraftBukkit #953 Compatible?
     
  17. Offline

    korin125

    Would love to see 'iConomy fee for protecting containers/doors.'
     
  18. Offline

    Maxis010

    Yes
     
  19. Offline

    GiantSponge

    I can't seam to get groups to work. It doesn't seam to recognise them in permissions. Could this be because I am running permissions 3.x?

    Edit:
    Also, when i put my name on the sign it says i am offline and i can't open it.
     
  20. Offline

    Maxis010

    Permissions 3 is compatable, check your server log for errors
    Don't put your name on the 2nd line, let it fill in automatically, if that isn't an option because you have the existing protection conflict then remember that it is Cap specific
     
  21. Offline

    ಠ_ಠ

    I would love to see hatches be protected :D
     
  22. Offline

    mjsdabeast

    Hey, i have had some trouble setting up the broadcast function, so what i want to do is i have two seperate permissions groups, Admin and Owner. So, for the broadcast i want both groups to hear the messages, currently i have it setup like this:

    broadcast-snoop-target: '[Admin]'
    broadcast-reload-target: '[Owner]'
    broadcast-break-target: '[Admin]'

    The only problem is is that only the Admins get notified when someone opens a chest, and only i(the Owner) gets notified when they open a door. I'm not sure what the problem is but i would definitely like both groups to hear both messages. Thanks
     
  23. Offline

    Maxis010

    Create a 3rd group called Broadcast, give it no permissions or inheritanc, ensure that all of your Admins and Owners are part of that groupand set them as the target for all broadcasts
     
  24. Offline

    dbizzzle

    Hello, for some reason if I place a sign in front of a door it will attach to the door and work but when i try and put the sign above the door it says: "Lockette: Conflict with an existing protected door." do you know what is causing this?
     
  25. Offline

    engise

    I cant lock chests ... it says Permission to lock chest denied

    I am using Permissions 3
     
  26. Offline

    Maxis010

    Put a name on the 2nd line to fix this conflict, the origin of the conflict is unknown, MinecartMania is one of the causes, just not sure how
     
  27. Offline

    dbizzzle

    Oh, okay, thank you, but i don't have MinecartMania?

    And also how does the timer option work?

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

    Maxis010

    As I said, one of the causes
     
  29. Offline

    dbizzzle

    Ah, I see, btw how does the timer option work?
     
  30. Offline

    Maxis010

    Player opens door, Lockette counts off the timer, Lockette closes door, if a player closes the door abort timer

    If timer is 5 seconds then you have 5 seconds to get through the door, very useful when being chased by zombies to have a timed double door as you open it, charge in and watch as the zombie is shut out
     
  31. Offline

    iTroubl3

    wow :D nice one :)
     

Share This Page