ChestShop Notifier

Table of Contents

Note: The latest version of this plugin works with every UUID-compatible CraftBukkit or Spigot version!

CSN (ChestShop Notifier) is a plugin that records ChestShop transactions to a SQLite or MySQL database. When a shop owner logs onto the server, they will be presented with an option to view sales from when they were offline.

Installation Instructions

Commands

/csn help → Shows available commands
/csn history [<page>] → Shows unread sale history from database
/csn history [<username> [<page>]] → Shows sale history of another player
/csn clear [<usernamse>] → Marks all sale history as read for your user
/csn cleandatabase → Remove database entries. Parameters:
--older-than, -o days → Removes entries older than days
--user, -user username/uuid → Removes entries from a single user only
--read-only, -r → Removes only read entries, default behaviour
--all, -a → Removes all entries
/csn upload → Forces the plugin to upload all data to the database (in v1.1 and higher this should be only used after database connection problems!)
/csn reload → Reloads configuration and connects to database using new config
/csn convert → Converts the database table csn to UUIDs. (table csn gets converted in csnUUID and the username table renamed to csnOLD)

Permissions

csn.user → Allows user to receive notifications when they log in, and access to /csn history.
csn.admin → Super permission node. Access to all commands. (especially upload, reload and convert)

For all permissions take a look at the plugin.yml

Config

# Chest Shop Notifier<br />

logging:
  admin-shop: true

notifications:
  notify-on-user-join: true
  delay-seconds: 5

history:
  max-rows: 10
  query-limit: 10000

debugging:
  verbose: true

database:
  # Possible types: SQLite and MySQL
  type: sqlite
  dbname: 'database'
  # MySQL specific settings
  host: 'localhost'
  port: 3306
  username: 'dbadmin'
  password: '123456'
  ssl: false

clean-on-startup:
  enabled: false
  parameters: "--older-than 30 --all"

messages:
  sales: "&amp;c ** You made &amp;f{sales} sales&amp;c since you last checked."
  history-cmd: "&amp;c ** To see them, type &amp;f/csn history&amp;c."
  history-caption: "&amp;dChestShop Notifier // &amp;7Latest Commissions"
  history-empty: "&amp;cNothing to show."
  history-bought: "&amp;a+ &amp;9{player} &amp;7bought &amp;a{count}x&amp;9{item} &amp;f{timeago}&amp;7 ago &amp;a(+{money})"
  history-bought-read: "&amp;a+ &amp;7{player} &amp;8bought &amp;a{count}x&amp;7{item} &amp;7{timeago}&amp;8 ago &amp;a(+{money})"
  history-sold: "&amp;c- &amp;9{player} &amp;7sold you &amp;c{count}x&amp;9{item} &amp;f{timeago}&amp;7 ago &amp;c(-{money})"
  history-sold-read: "&amp;c- &amp;7{player} &amp;8sold you &amp;c{count}x&amp;7{item} &amp;7{timeago}&amp;8 ago &amp;c(-{money})"
  history-footer-page: "&amp;c- Page &amp;f{current}&amp;c/&amp;f{pages}&amp;6 - &amp;7/csn history &lt;page&gt;"
  history-footer-clear: "&amp;f- &amp;cTo remove all old entries, type /csn clear"
  history-clear: "&amp;cHistory cleared! New sales will continue to be recorded."
  history-marked-read: "&amp;cUnread entries marked read!"
  history-others-not-allowed: "&amp;cYou are not allowed to check the history of {username}"
  # new translations
  reload-cmd: "&amp;dChestShop Notifier // &amp;7Reloading, please wait..."
  reload-success: "&amp;aReloaded!"
  reload-database-success: "&amp;aDatabase connected!"
  reload-database-fail: "&amp;cDatabase failed to connect!"
  user-not-found: "&amp;cThe user '{player}' was not found."
  page-not-found: "&amp;e{page} &amp;cis not a valid page number input for /csn history &lt;page&gt;!"
  page-not-found-other: "&amp;e{page} &amp;cis not a valid page number input for /csn history &lt;user&gt; &lt;page&gt;!"
  database-error: "&amp;cInvalid database connection. Please edit config and /csn reload."
  database-error-oncommand: "&amp;cDatabase error while executing this command!"
  database-cleaned: "&amp;cCleaned database from {amount} entries!"
  database-uploaded: "&amp;cBatch executed!"
  database-convert: "&amp;cAttempting to convert database..."
  database-convert-fail: "&amp;cError while trying to convert! Maybe you don't have a 'csn' table?"
  database-converted: "&amp;cDatabase converted!"
  unrecognized-command: "&amp;cCommand not recognized. Type /csn help for help."
  missing-arguments: "&amp;cMissing parameter arguments: {usage}"
  invalid-number: "&amp;c{typo} is not a valid number input for {usage}!"
  invalid-username: "&amp;c{typo} is not a valid username/uuid input for {usage}!"
  missing-permission: "&amp;cYou don't have the permission {permission}!"
  help:
    header: "&amp;dChestShop Notifier // &amp;7Commands"
    help: "&amp;7 /csn &amp;dhelp &amp;f- Plugin usage &amp; commands"
    history: "&amp;7 /csn &amp;dhistory [&lt;page&gt;]&amp;f- View sales"
    clear: "&amp;7 /csn &amp;dclear &amp;f- Remove read sales"
    history-others: "&amp;7 /csn &amp;dhistory &lt;username&gt; [&lt;page&gt;]&amp;f- View sales of another account"
    clear-others: "&amp;7 /csn &amp;dclear &lt;username&gt;&amp;f- Remove read sales of another account"
    cleandatabase: "&amp;7 /csn &amp;ccleandatabase &amp;f- Remove database entries. Parameters:"
    cleandatabase-older-than: "&amp;c --older-than, -o &lt;days&gt; &amp;f- Removes entries older than &lt;days&gt;"
    cleandatabase-user: "&amp;c --user, -user &lt;username/uuid&gt; &amp;f- Removes entries from a single user only"
    cleandatabase-read-only: "&amp;c --read-only, -r &amp;f- Removes only read entries, default behaviour"
    cleandatabase-all: "&amp;c --all, -a &amp;f- Removes all entries"
    upload: "&amp;7 /csn &amp;cupload &amp;f- Force update databases"
    convert: "&amp;7 /csn &amp;cconvert &amp;f- Convert database to UUIDs"
    reload: "&amp;7 /csn &amp;creload &amp;f- Reload configuration"

Requirements

ChestShop installed and running.
Optionally: MySQL server if you want to store the information in a real database/share it between servers.

Planned Features

~~UUID support~~ done in v1.1.2
~~Look up the sales of offline players~~ done in v1.1.2
~~Ignore ChestShop's Admin Shop~~ done in v1.1.2
~~History pagination~~ done in v1.2
~~SQLite support~~ done in v1.3.3
Auto updater & version checker
Translation system (partially done in v1.1.2, you can set your own messages in the config)

For more features and suggestion use the GitHub issues page!

Source Code & Dev Builds

You can view the source code online at:
https://github.com/ChestShop-authors/ChestShopNotifier
Development builds are available on the Minebench.de Jenkins build server:
http://ci.minebench.de/job/ChestShopNotifier/

Donations

Feel free to comment with your ideas, bugs, or requests, ideally by opening an issue on the github repo.
If you really want to monetarily then click here.

Demonstration

History command

Comments

_ForgeUser22255581
- Join Date: 10/22/2015
- Posts: 1
- Member Details
#30 _ForgeUser22255581

View User Profile

Send Message

Posted Oct 21, 2015
Thank you so much for this plugin! I have a suggestion. Would it be possible to also show the history of when someone tries to buy an item of yours while it's out-of-stock? It would be useful in a way that we would know if we should restock something because it has a demand again.

Rollback Post to Revision RollBack
_ForgeUser18664086
- Join Date: 1/17/2015
- Posts: 54
- Member Details
#29 _ForgeUser18664086

View User Profile

Send Message

Posted Sep 23, 2015
What should I fill in the database line? The ip only? Or can someone post his config here? Thanks :)

Rollback Post to Revision RollBack
Forge_User_80075269
- Join Date: 2/9/2012
- Posts: 433
- Member Details
#28 Forge_User_80075269

View User Profile

Send Message

Posted Jul 24, 2015
Hi ! Could you add possibility to modify variables "days", "minutes" and "seconds" please ?

Rollback Post to Revision RollBack
_ForgeUser8762258
- Join Date: 4/18/2012
- Posts: 219
- Member Details
#27 _ForgeUser8762258

View User Profile

Send Message

Posted Jul 20, 2015
Thanks, But i was thinkig more in line of seeing the spesific server to. So when you log into one server you see the following:

You made 10 sales on SERVER-A since you last checked. You made 5 sales on SERVER-B since you last checked.

Another thing, could you please make it so that the plugin does not use the main thread?

[Server thread/WARN]: [AutoSaveWorld] Plugin ChestShopNotifier attempted to establish connection socket://localhost:3306 in main server thread

Thanks.

Rollback Post to Revision RollBack
Phoenix616
- Join Date: 9/16/2012
- Posts: 303
- Member Details
#26 Phoenix616

View User Profile

Send Message

Posted Jul 15, 2015
@erik1988

CSN works totally fine when you run it on multiple servers with the same database. Instant Bungee-wide transaction notifications however should be a feature ChestShop itself or a separate plugin implements as this plugin focuses on storing information on transactions when the player is offline.

@TheOnlyOmlet

This plugin only manages notifications of transactions occurring while a player is offline. The feature you are requesting would have to be implemented in ChestShop or directly in your economy plugin. (most already do have a bank functionality nowadays)

Also on a personal note: A player should be smart enough to not make it possible to get broke by buying items. One guide on how to do that can even be found on the ChestShop's plugin page here.

Rollback Post to Revision RollBack
_ForgeUser20158950
- Join Date: 5/7/2015
- Posts: 1
- Member Details
#25 _ForgeUser20158950

View User Profile

Send Message

Posted Jul 15, 2015
Really like this plugin. I have a request, but I'm not sure how difficult it would be on your end to code. Is it possible to make separate bank accounts for the chestshop? So as not to run the owner dry if someone sells them a large quantity of items.

Rollback Post to Revision RollBack
_ForgeUser8762258
- Join Date: 4/18/2012
- Posts: 219
- Member Details
#24 _ForgeUser8762258

View User Profile

Send Message

Posted Jul 15, 2015
would it be possible to make this into a bungee plugin? So that if you are on another server in the network you will get a notification if someone is buying from one of your shops even if you are not on that server.

Rollback Post to Revision RollBack
Phoenix616
- Join Date: 9/16/2012
- Posts: 303
- Member Details
#23 Phoenix616

View User Profile

Send Message

Posted Apr 10, 2015
@Kane_Hart

This plugin works fine with 1.8 and 1.8.3. Bukkit plugins generally don't need an update if they only use the Bukkit API (which this plugin does).

Rollback Post to Revision RollBack
Stone_Legion
- Location: Barrie, Ontario, Canada
- Join Date: 6/13/2008
- Posts: 222
- Member Details
#22 Stone_Legion

View User Profile

Send Message

Posted Apr 8, 2015
Does this work for 1.8.1?

Rollback Post to Revision RollBack
_ForgeUser11034172
- Join Date: 4/25/2013
- Posts: 4
- Member Details
#21 _ForgeUser11034172

View User Profile

Send Message

Posted Feb 12, 2015
Hi, i like to know why the plugin is not working in my server beacuse i test in my computer and the plugin work, when i change the server to a Centos 6 (64 bits) VPS the plugin not working, can anyone help me ?
Thank´s :)

Rollback Post to Revision RollBack
_ForgeUser12574206
- Join Date: 11/8/2013
- Posts: 24
- Member Details
#20 _ForgeUser12574206

View User Profile

Send Message

Posted Dec 5, 2014
Please add the ability to delete certain date and time previous data regularly.

Rollback Post to Revision RollBack
_ForgeUser10983085
- Join Date: 4/17/2013
- Posts: 45
- Member Details
#19 _ForgeUser10983085

View User Profile

Send Message

Posted Sep 2, 2014
@Phoenix616

I will wait and record data on it at peek server hours and record timings with old version and new versions. I had an sql problem around the same time I updated this plugin, so assumption was this plugin, since then I have repaired the issue and no problems. But I am interested to see about its performance.

Rollback Post to Revision RollBack
Phoenix616
- Join Date: 9/16/2012
- Posts: 303
- Member Details
#18 Phoenix616

View User Profile

Send Message

Posted Sep 1, 2014
@asmit119

This was intended because in my opinion inserting into a MySQL database has no real impact on the performance as you don't have to search the whole table like you do with an update for example. Actually I think that using a batch would use more resourced because you have to schedule an reoccurring event.

But if you can provide me with some hard evidence that this change resulted in a performance loss I am willing to implement a config option for this.

Rollback Post to Revision RollBack
_ForgeUser10983085
- Join Date: 4/17/2013
- Posts: 45
- Member Details
#17 _ForgeUser10983085

View User Profile

Send Message

Posted Aug 31, 2014
Batch's are upload for EACH item sold. Instantly. Rather than sending them in waves. This is very demanding of a SQL system. Was this intended in the update? Can we have an update timer?

Rollback Post to Revision RollBack
Phoenix616
- Join Date: 9/16/2012
- Posts: 303
- Member Details
#16 Phoenix616

View User Profile

Send Message

Posted Aug 25, 2014
To everyone waiting for the 1.1.2 UUID update:

The file got uploaded 7 days ago but has not been confirmed by the Bukkit Dev staff yet. I guess this delay is because of the recent Bukkit/Mojang kerfuffle. If you really need UUIDs I would suggest that you get the source from the github repo and built it yourself.

Rollback Post to Revision RollBack
Phoenix616
- Join Date: 9/16/2012
- Posts: 303
- Member Details
#15 Phoenix616

View User Profile

Send Message

Posted Aug 15, 2014
As you can see from the github commits I have more or less taken over the development of this plugin. I will be updating it here to UUIDs as soon as I finished writing a converter and testing it.

The next version will also implement the ability to disable logging for ChestShop's Admin Shop, like Durand1w suggested, and the ability to setup your own messages in the config.

Last edited by Phoenix616: Aug 15, 2014

Rollback Post to Revision RollBack
_ForgeUser12706264
- Join Date: 11/27/2013
- Posts: 17
- Member Details
#14 _ForgeUser12706264

View User Profile

Send Message

Posted Jul 8, 2014
@Durand1w

Not right now, but sounds like a good idea. I'm going to be working on an update sometime this week which will fix the 'Unread' bug as well as add an option to ignore certain users.

Rollback Post to Revision RollBack
Durand1w
- Join Date: 9/18/2011
- Posts: 47
- Member Details
#13 Durand1w

View User Profile

Send Message

Posted Jul 8, 2014
Is there a method to disable logging for a specific user (server account)? I don't think this will be an issue for a while and I can probably drop the specific account information manually, but disabling server shops would be useful.

Rollback Post to Revision RollBack
Durand1w
- Join Date: 9/18/2011
- Posts: 47
- Member Details
#12 Durand1w

View User Profile

Send Message

Posted Jun 27, 2014
@Erbros

Thank you for posting the fix. This worked for me as well.

Rollback Post to Revision RollBack
_ForgeUser7443017
- Join Date: 8/25/2011
- Posts: 96
- Member Details
#11 _ForgeUser7443017

View User Profile

Send Message

Posted Jun 18, 2014
I just added a field named 'Unread' with smallint length 1 default 0 to the table and it works just fine.

Rollback Post to Revision RollBack
To post a comment, please login or register a new account.

Project ID

79114
Created

Apr 28, 2014
Last Released File

Jun 6, 2021
Total Downloads

10,707
License

Public Domain

Bukkit

ChestShop Notifier

Bukkit Plugins