[OSP] Punishments Manager (Name Server Addon)

• Web Hosted ban list
• No waiting time on unban
• Custom Ban Time (1 Hour, 3 Hours, 12 Hours, 1 Day, 3 Days, 1 Week, 2 Weeks, 3 Weeks, 1 Month)
• Every Punishment Saved
• Welcome message on join (different if the player is banned) with variables (such as player uid, unban date, player name etc..)
• Every Punishment Saved And readable at any time
• Account Permissions Managing (can give or remove access to tabs of the name server / punishments manager)
• Player Unbans Saved

Vornne's Readme said:

To install, you need a web server with PHP and MySQL installed; I use Linux and Apache (LAMP) so the instructions will be tailored to that. Lines starting with "$" represent commands to run in the shell prompt, and lines starting with "mysql>" represent queries to run in the mysql command line tool.

Click to expand...

• *name* = Display Player Name
• *uid* = Display Player UID

• *name* = Display Player Name
• *uid* = Display Player UID
• *invoker* = Display Ban Invoker
• *invoker_uid* = Display Ban Invoker UID
• *ban_date* = Display date the player got banned on
• *unban_date* = Display date the player will be unbanned on

Vornne said:

Looks good, based on a quick glance. I never really bothered to flesh out the web server part of PW further than various bits that took my fancy at times, so it is good to see other people releasing features that they find useful in practice.

Though one thing: the tag "OSP" stands for Open Source Pack, but you have not released the source code for the module system part, making it the wrong term to use for this case. Releasing only .txt files also means that people should not use it unless they are using totally unmodified PW 4.4.0 (or whatever you have based it on), because the .txt file format is not designed to be merged, with loads of potential bugs and crashes for anyone that tries - unlike module system code.

Click to expand...

Vornne said:

Looks good, based on a quick glance. I never really bothered to flesh out the web server part of PW further than various bits that took my fancy at times, so it is good to see other people releasing features that they find useful in practice.

Though one thing: the tag "OSP" stands for Open Source Pack, but you have not released the source code for the module system part, making it the wrong term to use for this case. Releasing only .txt files also means that people should not use it unless they are using totally unmodified PW 4.4.0 (or whatever you have based it on), because the .txt file format is not designed to be merged, with loads of potential bugs and crashes for anyone that tries - unlike module system code.

Click to expand...

AleksanderTheGreat said:

Well if I ask about "Why didn't you put it under OSP" Then it's logical that I know what it is. And yea, for sure it's only based on PW system so it can't go further for other mods, if it isn't modified though.

Click to expand...

Ra'Jiska said:

And nope, if the Module Would be released, it could easily be ported to any other mod (of course, it would need a lot more work if it's not PW based).
Also, people might want to do their own edit to the code wich is pretty understandable and justify the need of having the Module System code.
Thanks people

Click to expand...

Vornne said:

I had time to take a quick look at the module system today: well done, the code is quite well integrated with existing systems in PW, rather than the common messy beginner hacks.

A couple of small notes, though (having a perfectionist attention to detail I will have opinions about basically any PW based code, so don't take it the wrong way):

Click to expand...

Vornne said:

You have defined a bunch of slot_player_admin_temp_ban_* in module_constants, but numerically after slot_player_admin_end, so they will not be included in the permissions feature of standard PW. Note that the design packs all the permission flags into one network "int" which is signed 32 bit, so there should only be 31 different admin permissions unless the code is changed to pack the flags into two values, or something else; 17 are currently used by official PW, which leaves 14, so I would suggest just using the existing "temporary_ban" and "permanent_ban" permissions, using one for bans less than a certain time, and the other for longer bans. But you could split each ban duration into a different permission if you think that would be necessary; just remember to add the columns to the "admin_permissions" database field. The other permission slots are named slot_player_admin_no_*, since they are only set to 1, or true, when the name server denies the permission, defaulting to 0 ("not no permission") with no name server.

Click to expand...

Vornne said:

I discourage the practice of distinguishing web server replies by the number of parameters, i.e. the (eq, ":integer_count", 2), (eq, ":string_count", 1) added in the first else_try block of script game_receive_url_response. It has somehow become popular with people writing simple guides for web servers with Warband, but it is a bad idea: no other message types can then use 2 integers and 1 string, having to add useless extra parameters to avoid conflicting, confusing anyone trying to merge different features that use a web server. You have a "status" value in reg0, which is very close to the right idea: it should be a unique "return code" to work in with the official name server and any other web server feature desired, so like the slots in module_constants, people only need to check one place for conflicts when merging code (that all the "return code" / "message type" numbers are unique). I didn't define the return code constants in the module system, because the languages of the module system and web server are different (Python, PHP) making it seemingly impractical to try use the same list; so the return codes are only named in the web server configuration, manually using the same numbers in script game_receive_url_response (you might have a better idea).

Click to expand...

Vornne said:

Aside from my usual nit picking about the use of mixed tabs and spaces for indentation (makes the code look wrong to anyone using different settings), the code looks nice. I didn't check the PHP code very deeply though, since I don't really know it very well (the name server was basically my first time learning a bit of PHP, HTML, CSS, so it might not be ideal).

Click to expand...

Vornne said:

I have created a new sticky topic linking to this thread, also for any useful and well written code posted by other people.

Click to expand...

  ("game_receive_url_response", # called by the game when a response is received from a web server, if used
   [(store_script_param, ":integer_count", 1),
    (store_script_param, ":string_count", 2),

    (assign, "$g_name_server_enabled", 1),
	
	  # Link: http://localhost/pwnameserver/server-request/check-player.php?uid=1000&id=5&name=User | Result: 1|0|Welcome|5 | Const: reg0{Identifier}
	  (try_begin),
		  (eq, 1, reg0), # Identifier: 1 -> Punishments Manager
	    (assign, ":status", reg1),
	    (assign, ":player_id", reg2),
	    (player_is_active, ":player_id"),
	    (multiplayer_send_string_to_player, ":player_id", server_event_local_chat, s0),
	    (try_begin),
	      (eq, ":status", 1),
		    (store_mission_timer_a, ":time"),
		    (val_add, ":time", name_server_kick_delay_interval),
		    (player_set_slot, ":player_id", slot_player_kick_at_time, ":time"),
	    (try_end),
			
	  (else_try),
		
		  (eq, 2, reg0), # Identifier: 2 -> Names Server
      (ge, ":integer_count", 2),
      (assign, ":return_code", reg1),
      (try_begin), # negative return codes are internal or configuration errors, not requiring action
        (lt, ":return_code", 0),
        (server_add_message_to_log, "str_name_server_error_code_reg0"),
      (else_try), # return code 0 is success, don't kick the player
        (eq, ":return_code", 0),
        (this_or_next|lt, ":integer_count", 4), # admin permissions not received
        (eq, reg4, -1), # admin permissions not set
      (else_try),
        (ge, ":integer_count", 3),
        (ge, ":string_count", 1),
        (assign, ":player_id", reg2),
        (assign, ":unique_id", reg3),
        (player_is_active, ":player_id"),
        (player_get_unique_id, ":player_unique_id", ":player_id"),
        (eq, ":player_unique_id", ":unique_id"),
        (try_begin), # positive return codes are for rejecting the player
          (gt, ":return_code", 0),
          (try_begin),
            (eq, ":return_code", 4),
            (assign, ":rejection_string_id", "str_kicked_not_registered"),
          (else_try),
            (eq, ":return_code", 3),
            (assign, ":rejection_string_id", "str_kicked_using_invalid_name"),
          (else_try),
            (eq, ":return_code", 2),
            (assign, ":rejection_string_id", "str_kicked_using_other_clan_tag"),
          (else_try),
            (assign, ":rejection_string_id", "str_kicked_using_other_players_name"),
          (try_end),
          (multiplayer_send_2_int_to_player, ":player_id", server_event_preset_message, ":rejection_string_id", preset_message_error|preset_message_log),
          (store_mission_timer_a, ":time"), # kick the player after a short delay to try ensure they see the rejection message
          (val_add, ":time", name_server_kick_delay_interval),
          (player_set_slot, ":player_id", slot_player_kick_at_time, ":time"),
          (str_store_string, s10, ":rejection_string_id"),
          (server_add_message_to_log, "str_name_server_log_s10"),
        (try_end),
        (try_begin), # admin permissions were received
          (ge, ":integer_count", 4),
          (player_is_admin, ":player_id"),
          (assign, ":admin_permissions", reg4),
          (val_max, ":admin_permissions", 0),
          (call_script, "script_player_set_admin_permissions", ":player_id", ":admin_permissions"),
          (multiplayer_send_int_to_player, ":player_id", server_event_admin_set_permissions, ":admin_permissions"),
        (try_end),
      (else_try),
        (server_add_message_to_log, "str_name_server_invalid_response"),
      (try_end),
    (try_end),
    ]),

Vornne said:

though you could always send something like 50 as the first integer for all punshments manager replies (use any random number that doesn't and isn't likely to conflict with name server return codes), and sending a second integer to distinguish between welcome and banned messages.

Click to expand...

Heavy_Bob said:

This would be great for NW Line Battles.

Click to expand...