Skip to content

Commit

Permalink
TICKET 0007595: Event Signal System (by Collabnet)
Browse files Browse the repository at this point in the history 
TICKET 	0007596: Plugin System (by Collabnet)
  • Loading branch information
@fmancardi
fmancardi committed Jun 12, 2016
1 parent 4a6bed4 commit 3f629c0
Show file tree
Hide file tree
Showing 19 changed files with 1,212 additions and 59 deletions.
68 changes: 68 additions & 0 deletions README.plugins
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
===============================================================
TestLink - README.plugins
===============================================================

Writing Plugins:

To create a new plugin, create a new folder with the name of the plugin under
"plugins" folder at the base dir, for e.g. TLTest as provided in the
distribution. This should be a unique named plugin in the system. The name of
the folder acts as the name of the plugin.

The structure inside the plugin folder will be
+ plugins
+--< Name of Plugin >
+------ <Plugin Main Class File>
+------ pages
+---------< Smarty Template files >
+---------< PHP Files to process Smarty templates>

Plugin Main Class:
The plugin main class should reside directly under the plugins/<pluginname>
folder. This class should extend from core TestlinkPlugin class and expose
the following properties
* name
* description
* version
* author
* url
These information will be displayed in the Plugins page, which can be used to
enable or disable a plugin in the current Testlink installation (This has not
yet been implemented).

The plugin main class also needs to have the following methods:
* register: The basic information about the plugin including name, description,
version, author, url are maintained here. This method is mandatory
* config: Returns an array of the default configuration fields that are required
for the plugin. These values are stored in Globals against the plugin and act
as defaults whenever they are requested using plugin_config_get (See below)
* hooks: Returns an array of the hooks that this plugin listens to. The list of
hooks are defined in events_inc.php. The array value will be the method in the
plugin class that defines what needs to be done when that plugin happens.

Utilities that will help in writing the plugin class and support files:
* $db : This variable will be available for the plugins to do any DB related
operations. The users can directly do a `doDBConnect($db)` to connect to the
$db and then use any of the methods available in database.class.php
* plugin_file_path: Function to get an absolute path to a file inside of the
plugin. For e.g. any reference to a file from one php file to another can be
done using this. This avoids the user understanding how to reference files
inside the plugin.
* plugin_config_set: Set a configuration value in the Database. The values are
stored in the plugins_configuration table. You can set a value at two levels:
Either at a testproject level or available to all test projects
* plugin_config_get: Get a configuration value from the database. The value will
be fetched from the requested testprojectId (Passed in as a paramter) and if its
not there, it will fetch a value available at "All projects" level. If its not
available there, then it picks it up from the Global Defaults (Setup through the
`config` method of the plugin) and then default to the "default" parameter provided
in the method definition. See `plugin_config_get` in `plugin_api.php` for details

Writing Templates that will help in Plugin Configuration:
The user might want to create pages that will help in configuring a plugin at a
testproject level or for all projects. These template files will need to reside
inside `pages` folder. We have exported the tlSmarty class so that users can write
smarty templates. The php file to support the smarty templates are also inside the
`pages` folder. Please see config.php and config.tpl inside
plugins/TLTest/pages for an example

22 changes: 20 additions & 2 deletions cfg/const.inc.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
* @filesource const.inc.php
* @package TestLink
* @author Martin Havlat
* @copyright 2007-2015, TestLink community
* @copyright 2007-2016, TestLink community
* @see config.inc.php
*
* @internal revisions
Expand All @@ -35,7 +35,7 @@
// want to point to root install dir, need to remove fixed part
if (!defined('TL_ABS_PATH'))
{
define('TL_ABS_PATH', str_replace('cfg','',dirname(__FILE__)));
define('TL_ABS_PATH', str_replace('cfg','',dirname(__FILE__)));
}

/** Setting up the global include path for testlink */
Expand Down Expand Up @@ -181,6 +181,24 @@

define('REMOVEME', 'd8ba8cfb-ca92-4fa5-83c2-551977d405fb');

/** Constants for plugins */
/** Plugin configuration types */
define('CONFIG_TYPE_STRING', 0);
define('CONFIG_TYPE_INT', 1);
define('CONFIG_TYPE_FLOAT', 2);
define('CONFIG_TYPE_COMPLEX', 3);

/** To indicate the plugin configuration belongs to ANY PROJECT */
define('TL_ANY_PROJECT', -1);

/** Constants for events */
define('EVENT_TYPE_CREATE', 1);
define('EVENT_TYPE_UPDATE', 2);
define('EVENT_TYPE_DELETE', 3);
define('EVENT_TYPE_OUTPUT', 4);




// --------------------------------------------------------------------------------------
/* [GUI] */
Expand Down
14 changes: 14 additions & 0 deletions config.inc.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1661,6 +1661,8 @@
$tlCfg->proxy->password = null;


/** Plugins feature */
define('TL_PLUGIN_PATH', dirname(__FILE__) . DIRECTORY_SEPARATOR . 'plugins' . DIRECTORY_SEPARATOR);

// ----- End of Config ------------------------------------------------------------------
// --------------------------------------------------------------------------------------
Expand Down Expand Up @@ -1785,4 +1787,16 @@
$tlCfg->gui->title_separator_2 = $tlCfg->gui_title_separator_2;
$tlCfg->gui->role_separator_open = $tlCfg->gui_separator_open;
$tlCfg->gui->role_separator_close = $tlCfg->gui_separator_close;


/**
* Globals for Events storage
*/
$g_event_cache = array();

/**
* Globals for Plugins
*/
$g_plugin_config_cache = array();

// ----- END OF FILE --------------------------------------------------------------------
35 changes: 27 additions & 8 deletions gui/templates/mainPage.tpl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,31 +10,41 @@
{include file="inc_ext_js.tpl"}
<script language="JavaScript" src="{$basehref}gui/niftycube/niftycube.js" type="text/javascript"></script>
<script type="text/javascript">
window.onload=function()
window.onload=function()
{
/* with typeof display_left_block_1 I'm checking is function exists */
if( typeof display_left_block_1 != 'undefined')
if(typeof display_left_block_top != 'undefined')
{
display_left_block_top();
}
if(typeof display_left_block_1 != 'undefined')
{
display_left_block_1();
}
if( typeof display_left_block_2 != 'undefined')
if(typeof display_left_block_2 != 'undefined')
{
display_left_block_2();
}
if( typeof display_left_block_3 != 'undefined')
if(typeof display_left_block_3 != 'undefined')
{
display_left_block_3();
}
if( typeof display_left_block_4 != 'undefined')
if(typeof display_left_block_4 != 'undefined')
{
display_left_block_4();
}
if( typeof display_left_block_5 != 'undefined')
if(typeof display_left_block_bottom != 'undefined')
{
display_left_block_bottom();
}
if(typeof display_left_block_5 != 'undefined')
{
display_left_block_5();
}
Expand All @@ -53,7 +63,16 @@ window.onload=function()
{
display_right_block_3();
}
if( typeof display_right_block_top != 'undefined')
{
display_right_block_top();
}
if( typeof display_right_block_bottom != 'undefined')
{
display_right_block_bottom();
}
}
</script>
</head>
Expand Down
64 changes: 61 additions & 3 deletions gui/templates/mainPageLeft.tpl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
href_search_req, href_search_req_spec,href_inventory,
href_platform_management, href_inventory_management,
href_print_tc,href_keywords_assign, href_req_overview,
href_print_req, title_documentation,href_issuetracker_management,
href_print_req,title_plugins,title_documentation,href_issuetracker_management,
href_reqmgrsystem_management,href_req_monitor_overview'}

{$menuLayout=$tlCfg->gui->layoutMainPageLeft}
Expand All @@ -27,6 +27,8 @@
{$display_left_block_3=false}
{$display_left_block_4=false}
{$display_left_block_5=$tlCfg->userDocOnDesktop}
{$display_left_block_top = false}
{$display_left_block_bottom = false}

{if $gui->testprojectID &&
($gui->grants.project_edit == "yes" ||
Expand Down Expand Up @@ -122,12 +124,20 @@
</script>
{/if}

{if $gui->plugins.EVENT_LEFTMENU_TOP }
{$display_left_block_top=true}
{/if}
{if $gui->plugins.EVENT_LEFTMENU_BOTTOM }
{$display_left_block_bottom=true}
{/if}

<div class="vertical_menu" style="float: left">
<div id='menu_left_block_top'></div><br />
<div id='menu_left_block_2'></div><br />
<div id='menu_left_block_1'></div><br />
<div id="menu_left_block_3"></div><br />
<div id="menu_left_block_4"></div><br />
<div id='menu_left_block_bottom'></div><br />
<div id="menu_left_block_5"></div><br />

{if $display_left_block_1}
Expand Down Expand Up @@ -235,6 +245,56 @@
</div>
{/if}

{if $display_left_block_top}
<script type="text/javascript">
function display_left_block_top()
{
var pt = new Ext.Panel({
title: '{$labels.title_plugins}',
collapsible:false,
collapsed: false,
draggable: false,
contentEl: 'plugin_left_top',
baseCls: 'x-tl-panel',
bodyStyle: "background:#c8dce8;padding:3px;",
renderTo: 'menu_left_block_top',
width:'100%'
});
}
</script>
<div id="plugin_left_top">
{foreach from=$gui->plugins.EVENT_LEFTMENU_TOP item=menu_item}
{$menu_item}
<br />
{/foreach}
</div>
{/if}


{if $display_left_block_bottom}
<script type="text/javascript">
function display_left_block_bottom()
{
var pb = new Ext.Panel({
title: '{$labels.title_plugins}',
collapsible:false,
collapsed: false,
draggable: false,
contentEl: 'plugin_left_bottom',
baseCls: 'x-tl-panel',
bodyStyle: "background:#c8dce8;padding:3px;",
renderTo: 'menu_left_block_bottom',
width:'100%'
});
}
</script>
<div id="plugin_left_bottom">
{foreach from=$gui->plugins.EVENT_LEFTMENU_BOTTOM item=menu_item}
{$menu_item}
<br />
{/foreach}
</div>
{/if}

{if $display_left_block_5}
<script type="text/javascript">
Expand Down Expand Up @@ -270,6 +330,4 @@
</form>
</div>
{/if}


</div>
Loading

0 comments on commit 3f629c0

Please sign in to comment.