AlliedModders - [DEV] Autoreload plugins

Description:

By default, SourceMod reloads plugin on map change only (in case its file modification time is changed).
This plugin does the same every 2 seconds (adjustable).

*New features:

- Notify in chat about reloading, loading, unloading.
- Show plugin load status in chat
- Can load newly added plugins (you must set it in ConVars!!!)
- Can reload plugin even if the previous time it is failed
- Can reload translation files cache (when some plugin is changed)
- Scan in subfolders (recursively)
- Ensure plugin is really loaded in case it was fault due to attempt to reload it in middle-time of file uploading
- ConVars allowing to select delay (shorter, to track changes faster - for dev., or vice versa, longer delay to decrease CPU load - for production server)
- Ability to show part of error log in chat when plugin failed to load
- More optimized.

Commands:

PHP Code:

// Forcibly check plugin files for newly updated and reload if any sm_pluginsreload

Settings (ConVars):

Located at: cfg/sourcemod/sm_autoreload.cfg

PHP Code:

// Enable this plugin? (1 - Yes, 0 - No) sm_autoreload_enable "1" // * Delay between updates (in sec.). Set 0 to disable timer at all. sm_autoreload_delay "2.0" // ** Do we need to check for new plugin files appearing? (1 - Yes, 0 - No). sm_autoreload_track_new "0" // Where to show info about the reloaded plugin? (0 - Nowhere, 1 - Server, 2 - Chat, 4 - Console. Sum them to combine several options) sm_autoreload_show_info "3" // How many lines of error log to display when the plugin is failed to load? (0 - to disable) sm_autoreload_error_lines "4" // Display chat message to admins only defined by these admin flags (leave empty - to display for all users) sm_autoreload_msg_flag ""

*Notice 1: I would suggest setting like 5.0 - 10.0 sec. delay for production server where you don't need so quick plugin check.
**Notice 2: track new files cause more disk operations since the entire folder has re-read each time. Leave disabled to improve performance.

Forwards:

Spoiler

See details in scripting/include/autoreload.inc
See examples in scripting/include/test_forwards.sp

List:

PHP Code:


		
			
/**

 * Called once, before and after all other forwards raised during single update cycle

 *

 * @param pre            1 - plugins update sequence is started

 *                        0 - plugins update sequence is ended

 *    -

 * @noreturn

 */

forward void AP_OnPluginUpdate(int pre);



/**

 * Called before and after each single plugin is loaded

 *

 * @param path            path of the plugin operated, relative to /plugins/ folder

 * @param pre            1 - plugin is about to load (you can block plugin loading in this call)

 *                        0 - plugin loading is finished, with any status (see the "status" value in this call)

 * @param status        See the "PluginStatusEx" enum. Only "Plugin_Running" value should be considered as successful.

 *    -

 * @return                Plugin_Stop (or any non-zero value) - to block plugin from loading

 *                        Plugin_Continue - don't interfere with default behavior

 */

forward Action AP_OnPluginLoad(char[] path, int pre, int status);



/**

 * Called before and after each single plugin is reloaded

 *

 * @param path            path of the plugin operated, relative to /plugins/ folder

 * @param pre            1 - plugin is about to reload (you can block plugin reloading in this call)

 *                        0 - plugin reloading is finished, with any status (see the "status" value in this call)

 * @param status        See the "PluginStatusEx" enum. Only "Plugin_Running" value should be considered as successful.

 *    -

 * @return                Plugin_Stop (or any non-zero value) - to block plugin from loading

 *                        Plugin_Continue - don't interfere with default behavior

 */

forward Action AP_OnPluginReload(char[] path, int pre, int status);



/**

 * Called before and after each single plugin is unloaded

 *

 * @param path            path of the plugin operated, relative to /plugins/ folder

 * @param pre            1 - plugin is about to unload (you can prevent plugin unloading in this call)

 *                        0 - plugin is unloaded

 *    -

 * @return                Plugin_Stop (or any non-zero value) - to block plugin from loading

 *                        Plugin_Continue - don't interfere with default behavior

 */

forward Action AP_OnPluginUnload(char[] path, int pre);



/*

    Notice:

    

     - these forwards doesn't report about actions made by other plugins including sourcemod itself, like:

     

      > when you manually load/reload/unload plugin via console;

      > when SM load/reload/unload plugin between OnMapEnd and OnMapStart events (map transition).



*/





enum PluginStatusEx        // most constants are defined as "PluginStatus" enum in core.inc

{

    Plugin_Running        // successful load/reload operation

    Plugin_Paused        

    Plugin_Error        

    Plugin_Loaded        

    Plugin_Failed        

    Plugin_Created        

    Plugin_Uncompiled    

    Plugin_BadLoad        

    Plugin_Evicted        

    -1                    // for INVALID_HANDLE, like <DISABLED> plugins (also, it's a default value for "pre"-forwards)

}

Using:

Place smx in "plugins" folder.

Credits:

- Timiditas - author of idea and original plugin
- SilverShot - testing, give me some ideas and forcing me find solutions ^^
- Marttt - reload translation cache suggestion

Full changelog:

// TODO:
- Integrity check.
- Adding dynamically loaded/unloaded plugins to tracking list. Also, need help in issue #1482.

Donate

Donates are very appreciated and welcomed for further inspiration, make me happy, and make next updates came out more often:
- Patreon (Paypal)
- BitCoin
- Ю.Money