For a sample plugin called 'hide_aargh':
/plugins/hide_aargh/index.php
<?php
include_once("classes/cls.pluginapi.php");
class plugin_hide_aargh
{
public function on_message($message_forum_id, $message, $message_id, $sender_id, $recipient_id, $sender_name, $sender_email, $sender_phone)
{
//Do your thing in here. Here is a sample.
$api = new cls_plugin_api();
//e.g. hide the message we have just posted if it includes the string 'aargh' in it.
if(strpos($message, 'aargh') !== false) {
$api->hide_message($message_id);
}
return true;
}
}
?>
Add the entry "hide_aargh" to the "plugins" array in config/config.json to activate the plugin.
$table //AtomJump Loop Server ('atomjump' by default) database table name eg. "tbl_email"
$insert_field_names_str //Insert string e.g. "(var_layers, var_title, var_body, date_when_received, var_whisper)"
$insert_field_data_str //Insert values e.g. "(?,?,?, NOW(), ?)" )
$params //Optional (but recommended for security): parameterized values, use question marks '?' for each param in the SQL $insert_field_data_str. Pass an array of params: e.g. [["s", $some-string], ["i", $some-integer]]
$error_log_sql //Optional: can use this field to output the final filled query to the Apache error log. It only needs to contain a string of some sort. e.g. "TEST", so that you know to remove the test later on.
$sql //An ordinary SELECT SQL query. $params //Optional (but recommended for security): parameterized values, use question marks '?' for each param in the SQL $sql. Pass an array of params: e.g. [["s", $some-string], ["i", $some-integer]] $error_log_sql //Optional: can use this field to output the final filled query to the Apache error log. It only needs to contain a string of some sort. e.g. "TEST", so that you know to remove the test later on.
$table //The table name to update $update_set //The SQL string after an 'UPDATE table SET' e.g. "var_title = 'test' WHERE var_title = ?" - can have multiple fields $params //Optional (but recommended for security): parameterized values, use question marks '?' for each param in the SQL $sql. Pass an array of params: e.g. [["s", $some-string], ["i", $some-integer]] $error_log_sql //Optional: can use this field to output the final filled query to the Apache error log. It only needs to contain a string of some sort. e.g. "TEST", so that you know to remove the test later on.
Output is an array:
[ forum_id, access_type, forum_group_user_id, requires_password ]
Where 'forum_id' e.g. 34
'access_type' eg. "readwrite", "read"
'forum_owner_user_id' is the user id to send a message to, to become visible to all the private forum owners.
'requires_password' is 'true' if the forum is password protected, or 'false' if not. (Server >= 2.3.4)
?>Your settings HTML<?php
?>Your settings HTML<?php
1. init - this call occurs once the first notification in a group is reached 2. addrecipient - this occurs for each recipient in the group 3. send - this occurs on being ready to send
$message_details will be an array in the following format:
array("observe_message" => $observe_message, //This is the message to be written next to the visual link to the forum
"observe_url" => $observe_url, //This is the URL of the visual link to the forum
"forum_message" => $layer_message, //A message that preceeds the name of the forum the message was sent from
"forum_name" => $layer_name, //The name of the forum the message was sent from
"remove_message" => $remove_message, //A description of what to do to remove the message
"remove_url" => $remove_url); //The URL to remove the message
$sender_name_str, //e.g. 'Fred'
$message, //Message being sent e.g "Hello world!"
$recipient_id, //User id of recipient e.g. "123.123.123.123:436"
$sender_email, //Sender's email address e.g. "fred@company.com"
$sender_ip, //Sender's ip address eg. "123.123.123.123"
$message_forum_id, //Forum id e.g. 23, which is derived from a forum name e.g. 'aj_test'
$options //Options array, see below
Options
$sender_still_typing = false; //Set to true if this is a partially completed message
$known_message_id = null; //If received an id from this function in the past
$sender_phone = null; //Include the phone number for configuration purposes
$javascript_client_msg_id = null; //Browser id for this message.
$forum_owner_id = null; //User id of forum owner
$social_post_short_code = null; //eg 'twt' for twitter, 'fcb' for facebook
$social_recipient_handle_str = null; //eg. 'atomjump' for '@atomjump' on Twitter
$date_override = null; //optional string for a custom date (as opposed to now)
$latitude = 0.0; //for potential future location expansion
$longitude = 0.0; //for potential future location expansion
$login_as = false; //Also login as this user
$allow_plugins = false; //To prevent infinite message sending loops, we don't refer to any other plugins
//after a message send
$allowed_plugins = null; //Use the standard plugins (null), or an array of approved plugins from the plugin
//developer. However, plugins that work with before_msg will continue to work
$notification = true; //Set to false to switch off notifications from this message
$always_send_email = false; //Set to true to ensure an email will always be sent to the recipient(s). Usually, messages within around 20 minutes won't multiple-email the user (when false).
$strip_tags = true; //By default we strip any tags in a new message
$non_interface_plugin = false; //This is an override of the security block, so that a back-end type plugin can potentially still post messages
//onto a group it is not authorised via the interface to do
Usage example:
$options = array('notification' => false); //turn off any notifications from these messages
$new_message_id = $api->new_message($helper, $new_message, $sender_ip . ":" . $sender_id, $helper_email, $sender_ip, $message_forum_id, $options);
Warning: if your plugin is a standalone script (as opposed to being called from the main server), you will need to also call
$api->complete_parallel_calls();
if you want the notifications to be sent, as these happen in parallel.
$notify = true;
$api->complete_parallel_calls();
global $root_server_url;
global $cnf;
global $msg;
global $lang;
global $db_cnf;