https://wiki.fogproject.org/wiki/index.php?action=history&feed=atom&title=Hook_System
Hook System - Revision history
2026-04-30T03:57:48Z
Revision history for this page on the wiki
MediaWiki 1.30.0
https://wiki.fogproject.org/wiki/index.php?title=Hook_System&diff=4199&oldid=prev
Chad-bisd: Undo revision 4196 by Erscott (talk) ----- Spam added by user Erscott
2011-10-02T22:41:35Z
<p>Undo revision 4196 by <a href="/wiki/index.php?title=Special:Contributions/Erscott" title="Special:Contributions/Erscott">Erscott</a> (<a href="/wiki/index.php?title=User_talk:Erscott&action=edit&redlink=1" class="new" title="User talk:Erscott (page does not exist)">talk</a>) ----- Spam added by user Erscott</p>
<p><b>New page</b></p><div>== Hook System Overview ==<br />
From SVN version 741 (yet to be released as an official version) FOG has the ability to be "hooked" and extended using an Object Orientated approach.<br />
<br />
Events are called throughout FOG, allowing developers to hook into FOG at certain code points without editing FOG's base code. <br />
<br />
Right now the Event list gives you the ability modify Data and Styling on all Management Search & List pages.<br />
<br />
Keep in mind that this code is still experimental and may change at any time.<br />
<br />
== Critical Files ==<br />
<pre><br />
lib/fog/Hook.class.php<br />
lib/fog/HookManager.class.php<br />
lib/hooks/*.hook.php<br />
</pre><br />
<br />
== Hook Class Variables & Methods ==<br />
'''Variables'''<br />
<pre><br />
class ExampleHook extends Hook<br />
{<br />
// Required<br />
var $name = 'string';<br />
var $description = 'string';<br />
var $author = 'string';<br />
<br />
<br />
// Optional with defaults<br />
var $active = true;<br />
var $logLevel = 0;<br />
var $logToFile = false;<br />
var $logToBrowser = true;<br />
}<br />
</pre><br />
<br />
'''Inherited Methods'''<br />
<br />
Methods that are available within your Hook Class<br />
<pre><br />
Function: void log( string $txt [, int $level = 1] )<br />
Example: $this->log('Debug alert !! Run for the hills !!');<br />
<br />
Function: bool isAJAXRequest()<br />
Example: if (!$this->isAJAXRequest()) print_r($debug);<br />
</pre><br />
<br />
== Enabling / Disabling Hooks ==<br />
Hooks can be enabled and disabled by changing the variable $active inside of the class you wish to enable / disable;<br /><br /><br />
'''To Enable''':<br />
<pre><br />
var $active = true;<br />
</pre><br />
'''To Disable''':<br />
<pre><br />
var $active = false;<br />
</pre><br />
<br />
== How to Hook Events ==<br />
Hook Events are called in various parts of the FOG code. Hooking these Events is very simple.<br />
<br />
'''Example for Event: HostData'''<br />
<pre><br />
$ExampleHook = new ExampleHook();<br />
$HookManager->register('HostData', array($ExampleHook, 'HostData')); // This will call the function HostData( array $arguments ) in $ExampleHook<br />
</pre><br />
<br />
''A full list of Events can be found here: http://www.fogproject.org/wiki/index.php?title=Hook_System#Events''<br />
<br />
== Function Arguments ==<br />
When an Event Hook is fired, various arguments are passed to the function specified. These arguments may vary.<br />
<br />
'''Returned argument indexes'''<br />
<br />
'event' : Always returned. Returns the name of the event fired to get here<br />
<br />
'data' : Contains data variables used to replace %name% strings in 'templates'<br />
<br />
'templates' : Each index will become a new column. Using %name% variables will be converted to the matching key index in 'data'<br />
<br />
'attributes' : Array of attributes to apply to each column wrapper. i.e. class, width, height, style<br />
<br />
'''Example'''<br />
<br />
Here is an example showing the data passed from the HostData Event<br />
<br />
''Code''<br />
<pre><br />
function run($arguments)<br />
{<br />
$this->log(print_r($arguments, 1));<br />
}<br />
</pre><br />
<br />
''Output''<br />
<pre><br />
Array<br />
(<br />
[event] => 'HostData'<br />
[data] => Array<br />
(<br />
[0] => Array<br />
(<br />
[id] => '968'<br />
[hostname] => '12583-M780'<br />
[mac] => '00:23:18:ef:b4:8d'<br />
)<br />
[1] => Array<br />
(<br />
[id] => '966'<br />
[hostname] => '12700-M780'<br />
[mac] => '00:23:18:72:50:8d'<br />
) <br />
[2] => Array<br />
(<br />
[id] => '1011'<br />
[hostname] => '12703-M780'<br />
[mac] => '00:23:18:97:a8:8d'<br />
)<br />
[3] => Array<br />
(<br />
[id] => '1251'<br />
[hostname] => '12705-M780'<br />
[mac] => '00:23:18:60:26:96'<br />
)<br />
)<br />
[templates] => Array<br />
(<br />
[0] => '<input type="checkbox" name="HID%id%" checked="checked" />'<br />
[1] => '<span class="icon ping"></span>'<br />
[2] => '<a href="?node=host&sub=edit&id=%id%" title="Edit">%hostname%</a>'<br />
[3] => '%mac%'<br />
[4] => '%ip%'<br />
[5] => '<a href="?node=host&sub=edit&id=%id%"><span class="icon icon-edit" title="Edit: %hostname%"></span></a>'<br />
)<br />
[attributes] => Array<br />
(<br />
[0] => Array ( )<br />
[1] => Array ( )<br />
[2] => Array ( )<br />
[3] => Array ( )<br />
[4] => Array ( )<br />
[5] => Array ( ['class'] => 'c' )<br />
)<br />
)<br />
</pre><br />
<br />
== Hook Template ==<br />
This is the most basic hook template<br /><br />
Your hook MUST extend the FOG Hook Class 'Hook' otherwise HookManager will fail to Hook the Event<br /><br /><br />
Location: '''lib/hooks/Template.hook.php'''<br /><br />
<pre><br />
<?php<br />
/****************************************************<br />
* FOG Hook: Template<br />
* Author: Blackout<br />
* Created: 8:57 AM 31/08/2011<br />
* Revision: $Revision: 743 $<br />
* Last Update: $LastChangedDate: 2011-09-04 11:50:55 +1000 (Sun, 04 Sep 2011) $<br />
***/<br />
<br />
// Hook Template<br />
class HookTemplate extends Hook<br />
{<br />
var $name = 'Hook Name';<br />
var $description = 'Hook Description';<br />
var $author = 'Hook Author';<br />
<br />
var $active = false;<br />
<br />
function HostData($arguments)<br />
{<br />
$this->log(print_r($arguments, 1));<br />
}<br />
}<br />
<br />
// Init class<br />
$HookTemplate = new HookTemplate();<br />
<br />
// Hook Event<br />
$HookManager->register('HostData', array($HookTemplate, 'HostData'));<br />
</pre><br />
<br />
== Events ==<br />
Hook Events allow you to jump into the FOG code at a certain point. When an event is fired, data and styling information related to that event can be made available to the Hook Developer for modification.<br /><br /><br />
Adding hooking points can be a time consuming process as the HTML, Data and Styling needs to be (re-)written in a particular way to allow hooking.<br /><br /><br />
More events will be added. If you require a particular hooking point, please contact Blackout with where the Hook needs to be made and any code you have developed :)<br />
<pre><br />
// Global<br />
CSS<br />
JavaScript<br />
MainMenuData // data => array<br />
SubMenuData // FOGSubMenu => FOGSubMenu Object<br />
MessageBox // data => string<br />
<br />
// Host Management<br />
// List / Search<br />
HostTableHeader<br />
HostData<br />
HostAfterTable<br />
// Edit<br />
HostEditUpdate // host => Host Object<br />
HostEditUpdateSuccess // host => Host Object<br />
HostEditUpdateFail // host => Host Object<br />
HostEditConfirmMACUpdate // host => Host Object<br />
HostEditConfirmMACUpdateSuccess // host => Host Object, mac = MACAddress Object<br />
HostEditConfirmMACUpdateFail // host => Host Object, mac = MACAddress Object<br />
HostEditADUpdate<br />
HostEditADUpdateSuccess<br />
HostEditADUpdateFail<br />
HostEditAddSnapinUpdate<br />
HostEditAddSnapinUpdateSuccess<br />
HostEditAddSnapinUpdateFail<br />
HostEditRemoveSnapinUpdate<br />
HostEditRemoveSnapinUpdateSuccess<br />
HostEditRemoveSnapinUpdateFail<br />
<br />
// Group Management<br />
GroupTableHeader<br />
GroupData<br />
GroupAfterTable<br />
<br />
// Image Management<br />
ImageTableHeader<br />
ImageData<br />
ImageAfterTable<br />
<br />
// Storage Node Management<br />
// All Storage Nodes<br />
StorageGroupTableHeader<br />
StorageGroupData<br />
StorageGroupAfterTable<br />
// All Storage Groups<br />
StorageNodeTableHeader<br />
StorageNodeData<br />
StorageNodeAfterTable<br />
<br />
// Snapin Management<br />
SnapinTableHeader<br />
SnapinData<br />
SnapinAfterTable<br />
<br />
// Printer Management<br />
PrinterTableHeader<br />
PrinterData<br />
PrinterAfterTable<br />
<br />
// Task Management<br />
// Active Tasks<br />
TasksActiveTableHeader<br />
TasksActiveData<br />
TasksActiveAfterTable<br />
TasksActiveRemove<br />
TasksActiveRemoveSuccess<br />
TasksActiveRemoveFail<br />
TasksActiveForce<br />
TasksActiveForceSuccess<br />
TasksActiveForceFail<br />
// Search<br />
TaskData<br />
TasksSearchTableHeader<br />
// List Hosts<br />
TasksListHostTableHeader<br />
TasksListHostData<br />
TasksListHostAfterTable<br />
// List Group<br />
TasksListGroupTableHeader<br />
TasksListGroupData<br />
TasksListGroupAfterTable<br />
// Scheduled Tasks<br />
TasksScheduledTableHeader<br />
TasksScheduledData<br />
TasksScheduledAfterTable<br />
TasksScheduledRemove<br />
TasksScheduledRemoveSuccess<br />
TasksScheduledRemoveFail<br />
// Active Multicast Tasks<br />
TasksActiveMulticastTableHeader<br />
TasksActiveMulticastData<br />
TasksActiveMulticastAfterTable<br />
// Active Snapins<br />
TasksActiveSnapinsTableHeader<br />
TasksActiveSnapinsData<br />
TasksActiveSnapinsAfterTable<br />
TasksActiveSnapinsRemove // id => snapinID, hostID => hostID<br />
TasksActiveSnapinsRemoveSuccess // id => snapinID, hostID => hostID<br />
TasksActiveSnapinsRemoveFail // id => snapinID, hostID => hostID<br />
<br />
// Login<br />
Login // username => string, password => string<br />
LoginSuccess // username => string, password => string, user => User Object<br />
LoginFail // username => string, password => string<br />
<br />
// Logout<br />
Logout<br />
</pre><br />
''Up to date as of SVN r759''<br />
<br />
== Examples ==<br />
'''HostVNCLink'''<br />
<br />
Adds a "VNC" link to the Host Lists<br />
<br />
Location: '''lib/hooks/HostVNCLink.hook.php'''<br />
<pre><br />
<?php<br />
/****************************************************<br />
* FOG Hook: HostVNCLink<br />
* Author: Blackout<br />
* Created: 9:26 AM 3/09/2011<br />
* Revision: $Revision: 743 $<br />
* Last Update: $LastChangedDate: 2011-09-04 11:50:55 +1000 (Sun, 04 Sep 2011) $<br />
***/<br />
<br />
// HostVNCLink - custom hook class<br />
class HostVNCLink extends Hook<br />
{<br />
// Class variables<br />
var $name = 'HostVNCLink';<br />
var $description = 'Adds a "VNC" link to the Host Lists';<br />
var $author = 'Blackout';<br />
<br />
var $active = false;<br />
<br />
// Custom variable<br />
var $port = 5800;<br />
<br />
function HostData($arguments)<br />
{<br />
// Add column template into 'templates' array<br />
$arguments['templates'][] = sprintf('<a href="http://%s:%d" target="_blank">VNC</a>', '%hostname%', $this->port);<br />
// Add these HTML attributes to that column<br />
$arguments['attributes'][] = array('class' => 'c');<br />
}<br />
<br />
function HostTableHeader($arguments)<br />
{<br />
// Add new Header column with the content 'VNC'<br />
$arguments['templates'][] = 'VNC';<br />
// Add these HTML attributes to that column<br />
$arguments['attributes'][] = array('width' => '40', 'class' => 'c');<br />
}<br />
}<br />
<br />
// Init<br />
$HostVNCLink = new HostVNCLink();<br />
<br />
// Register hooks with HookManager on desired events<br />
$HookManager->register('HostData', array($HostVNCLink, 'HostData'));<br />
$HookManager->register('HostTableHeader', array($HostVNCLink, 'HostTableHeader'));<br />
</pre><br />
'''RemoveIPAddressColumn'''<br />
<br />
Removes the "IP Address" column from Host Lists<br />
<br />
Location: '''lib/hooks/RemoveIPAddressColumn.hook.php'''<br />
<pre><br />
<?php<br />
/****************************************************<br />
* FOG Hook: Remove 'IP Address' column<br />
* Author: Blackout<br />
* Created: 1:52 PM 3/09/2011<br />
* Revision: $Revision: 743 $<br />
* Last Update: $LastChangedDate: 2011-09-04 11:50:55 +1000 (Sun, 04 Sep 2011) $<br />
***/<br />
<br />
// RemoveIPAddressColumn class<br />
class RemoveIPAddressColumn extends Hook<br />
{<br />
var $name = 'RemoveIPAddressColumn';<br />
var $description = 'Removes the "IP Address" column from Host Lists';<br />
var $author = 'Blackout';<br />
<br />
var $active = false;<br />
<br />
function HostTableHeader($arguments)<br />
{<br />
// Remove IP Address column by removing its column template<br />
unset($arguments['templates'][4]);<br />
}<br />
<br />
function HostData($arguments)<br />
{<br />
// Remove IP Address column by removing its column template<br />
unset($arguments['templates'][4]);<br />
}<br />
}<br />
<br />
// Init<br />
$RemoveIPAddressColumn = new RemoveIPAddressColumn();<br />
<br />
// Register hooks<br />
$HookManager->register('HostTableHeader', array($RemoveIPAddressColumn, 'HostTableHeader'));<br />
$HookManager->register('HostData', array($RemoveIPAddressColumn, 'HostData'));<br />
</pre><br />
'''Example.ChangeTableHeader'''<br />
<br />
Remove & add table header columns<br />
<br />
Location: '''lib/hooks/Example.ChangeTableHeader.hook.php'''<br />
<pre><br />
<?php<br />
/****************************************************<br />
* FOG Hook: Example Change Table Header<br />
* Author: Blackout<br />
* Created: 8:57 AM 31/08/2011<br />
* Revision: $Revision: 743 $<br />
* Last Update: $LastChangedDate: 2011-09-04 11:50:55 +1000 (Sun, 04 Sep 2011) $<br />
***/<br />
<br />
// Example class<br />
class TestHookChangeTableHeader extends Hook<br />
{<br />
var $name = 'ChangeTableHeader';<br />
var $description = 'Remove & add table header columns';<br />
var $author = 'Blackout';<br />
<br />
var $active = false;<br />
<br />
function HostTableHeader($arguments)<br />
{<br />
// DEBUG output<br />
foreach ($arguments['templates'] AS $i => $data)<br />
{<br />
$this->log(sprintf('Table Rows: i: %s Data: %s', $i, print_r($data, 1)));<br />
}<br />
<br />
// Rename column 'Host Name' -> 'Chicken Sandwiches'<br />
$arguments['templates'][2] = 'Chicken Sandwiches';<br />
<br />
// Override column values & attributes<br />
$arguments['templates'][5] = 'Edit Me !!';<br />
$arguments['attributes'][5] = array('width' => '40', 'class' => 'c');<br />
}<br />
}<br />
<br />
// Example: Change Table Header and Data<br />
$HookManager->register('HostTableHeader', array(new TestHookChangeTableHeader(), 'HostTableHeader'));<br />
</pre><br />
'''Example.ChangeData'''<br />
<br />
Appends "Chicken-" to all hostnames<br />
<br />
Location: '''lib/hooks/Example.ChangeData.hook.php'''<br />
<pre><br />
<?php<br />
/****************************************************<br />
* FOG Hook: Example Change Hostname<br />
* Author: Blackout<br />
* Created: 8:57 AM 31/08/2011<br />
* Revision: $Revision: 743 $<br />
* Last Update: $LastChangedDate: 2011-09-04 11:50:55 +1000 (Sun, 04 Sep 2011) $<br />
***/<br />
<br />
// Example class<br />
class TestHookChangeHostname extends Hook<br />
{<br />
var $name = 'ChangeHostname';<br />
var $description = 'Appends "Chicken-" to all hostnames ';<br />
var $author = 'Blackout';<br />
<br />
var $active = false;<br />
<br />
function HostData($arguments)<br />
{<br />
foreach ($arguments['data'] AS $i => $data)<br />
{<br />
// DEBUG<br />
//$this->log(sprintf('Renaming Host: i: %s Data: %s', $i, print_r($data, 1)));<br />
<br />
// Rename host<br />
$arguments['data'][$i]['hostname'] = 'Chicken-' . $data['hostname'];<br />
}<br />
}<br />
}<br />
<br />
// Example: Test by changing all hostnames in Host Management<br />
$HookManager->register('HostData', array(new TestHookChangeHostname(), 'HostData'));<br />
</pre><br />
<br />
'''Example.SideMenuChange'''<br />
<br />
Example showing how to manipulate SubMenu Data. Adds Menu items under "Host Management"<br />
<br />
Location: '''lib/hooks/Example.SideMenuChange.hook.php'''<br />
<pre><br />
<?php<br />
/****************************************************<br />
* FOG Hook: Example.SideMenuChange<br />
* Author: Blackout<br />
* Created: 12:10 PM 4/09/2011<br />
* Revision: $Revision: 743 $<br />
* Last Update: $LastChangedDate: 2011-09-04 11:50:55 +1000 (Sun, 04 Sep 2011) $<br />
***/<br />
<br />
// Hook Template<br />
class HookSubMenuData extends Hook<br />
{<br />
var $name = 'SubMenuData';<br />
var $description = 'Example showing how to manipulate SubMenu Data. Adds Menu items under "Host Management"';<br />
var $author = 'Blackout';<br />
<br />
var $active = false;<br />
<br />
function SubMenuData($arguments)<br />
{<br />
if ($GLOBALS['node'] == 'host')<br />
{<br />
// Add a new item under 'Host Management'<br />
$arguments['FOGSubMenu']->addItems('host', array(_('New Hook Item') => 'http://www.google.com', _('New Hook Item 2') => "newhookitem2"));<br />
<br />
if ($GLOBALS['id'])<br />
{<br />
// Add a new item under 'Host Management' per Host<br />
$arguments['FOGSubMenu']->addItems('host', array(_('New Hook Item') => "http://www.google.com", _('New Hook Item 2') => "newhookitem2"), 'id', $GLOBALS['hostname']);<br />
}<br />
}<br />
}<br />
}<br />
<br />
// Init class<br />
$HookSubMenuData = new HookSubMenuData();<br />
<br />
// Hook Event<br />
$HookManager->register('SubMenuData', array($HookSubMenuData, 'SubMenuData'));<br />
</pre><br />
<br />
== Debugging ==<br />
<br />
Using the 'Hook Debugger' hook, you can debug all hook events to browser and/or log file<br />
<br />
Location: '''lib/hooks/HookDebugger.hook.php'''<br />
<br />
'''You must enable this hook''' ''See: http://www.fogproject.org/wiki/index.php?title=Hook_System#Enabling_.2F_Disabling_Hooks''<br />
<pre><br />
<?php<br />
/****************************************************<br />
* FOG Hook: HookDebugger<br />
* Author: Blackout<br />
* Created: 8:57 AM 31/08/2011<br />
* Revision: $Revision: 744 $<br />
* Last Update: $LastChangedDate: 2011-09-04 12:02:48 +1000 (Sun, 04 Sep 2011) $<br />
***/<br />
<br />
// HookDebugger class<br />
class HookDebugger extends Hook<br />
{<br />
var $name = 'HookDebugger';<br />
var $description = 'Prints all Hook data to the web page and/or file when a hook is encountered';<br />
var $author = 'Blackout';<br />
<br />
var $active = false;<br />
<br />
var $logLevel = 9;<br />
var $logToFile = false; // Logs to: lib/hooks/HookDebugger.log<br />
var $logToBrowser = true;<br />
<br />
function run($arguments)<br />
{<br />
$this->log(print_r($arguments, 1));<br />
}<br />
}<br />
<br />
// Debug all events<br />
$HookDebugger = new HookDebugger();<br />
foreach ($HookManager->events AS $event)<br />
{<br />
$HookManager->register($event, array($HookDebugger, 'run'));<br />
}<br />
</pre><br />
[[Category:Development]]</div>
Chad-bisd