4 * ProjectImportPlugin Class
7 * This file is part of GForge.
9 * GForge is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * GForge is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with GForge; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 class ProjectImportPlugin extends Plugin {
25 function ProjectImportPlugin () {
27 $this->name = "projectimport" ;
28 $this->text = "Project import" ; // To show in the tabs, use...
29 $this->hooks[] = "groupmenu" ; // To put into the project tabs
31 $this->hooks[] = "user_personal_links";//to make a link to the user's personal part of the plugin
32 $this->hooks[] = "usermenu" ;
33 $this->hooks[] = "groupisactivecheckbox" ; // The "use ..." checkbox in editgroupinfo
34 $this->hooks[] = "groupisactivecheckboxpost" ; //
35 $this->hooks[] = "userisactivecheckbox" ; // The "use ..." checkbox in user account
36 $this->hooks[] = "userisactivecheckboxpost" ; //
37 $this->hooks[] = "project_admin_plugins"; // to show up in the admin page fro group
39 // The plugin has a link added to the Project administration part of site admin
40 $this->hooks[] = "site_admin_project_maintenance_hook";
41 $this->hooks[] = "site_admin_user_maintenance_hook";
44 function CallHook ($hookname, $params) {
45 global $use_projectimportplugin,$G_SESSION,$HTML;
46 /*if ($hookname == "usermenu") {
47 $text = $this->text; // this is what shows in the tab
48 if ($G_SESSION->usesPlugin("projectimport")) {
49 $param = '?type=user&id=' . $G_SESSION->getId() . "&pluginname=" . $this->name; // we indicate the part we're calling is the user one
50 echo ' | ' . $HTML->PrintSubMenu (array ($text),
51 array ('/plugins/projectimport/index.php' . $param ));
53 } else */ if ($hookname == "groupmenu") {
54 $group_id=$params['group'];
55 $project = &group_get_object($group_id);
56 if (!$project || !is_object($project)) {
59 if ($project->isError()) {
62 if (!$project->isProject()) {
65 if ( $project->usesPlugin ( $this->name ) ) {
66 $params['TITLES'][]=$this->text;
67 $params['DIRS'][]=util_make_url ('/plugins/projectimport/index.php?type=group&group_id=' . $group_id . "&pluginname=" . $this->name) ; // we indicate the part we're calling is the project one
69 $params['TITLES'][]=$this->text." is [Off]";
72 (($params['toptab'] == $this->name) ? $params['selected']=(count($params['TITLES'])-1) : '' );
73 } /*elseif ($hookname == "groupisactivecheckbox") {
74 //Check if the group is active
75 // this code creates the checkbox in the project edit public info page to activate/deactivate the plugin
76 $group_id=$params['group'];
77 $group = &group_get_object($group_id);
80 echo ' <input type="checkbox" name="use_projectimportplugin" value="1" ';
81 // checked or unchecked?
82 if ( $group->usesPlugin ( $this->name ) ) {
88 echo "<strong>Use ".$this->text." Plugin</strong>";
91 } elseif ($hookname == "groupisactivecheckboxpost") {
92 // this code actually activates/deactivates the plugin after the form was submitted in the project edit public info page
93 $group_id=$params['group'];
94 $group = &group_get_object($group_id);
95 $use_projectimportplugin = getStringFromRequest('use_projectimportplugin');
96 if ( $use_projectimportplugin == 1 ) {
97 $group->setPluginUse ( $this->name );
99 $group->setPluginUse ( $this->name, false );
101 } elseif ($hookname == "userisactivecheckbox") {
102 //check if user is active
103 // this code creates the checkbox in the user account manteinance page to activate/deactivate the plugin
104 $user = $params['user'];
107 echo ' <input type="checkbox" name="use_projectimportplugin" value="1" ';
108 // checked or unchecked?
109 if ( $user->usesPlugin ( $this->name ) ) {
112 echo " /> Use ".$this->text." Plugin";
115 } elseif ($hookname == "userisactivecheckboxpost") {
116 // this code actually activates/deactivates the plugin after the form was submitted in the user account manteinance page
117 $user = $params['user'];
118 $use_projectimportplugin = getStringFromRequest('use_projectimportplugin');
119 if ( $use_projectimportplugin == 1 ) {
120 $user->setPluginUse ( $this->name );
122 $user->setPluginUse ( $this->name, false );
126 echo ' <input type="checkbox" name="use_projectimportplugin" value="1" ';
127 // checked or unchecked?
128 if ( $user->usesPlugin ( $this->name ) ) {
131 echo " /> Use ".$this->text." Plugin";
134 } elseif ($hookname == "user_personal_links") {
135 // this displays the link in the user's profile page to it's personal ProjectImport (if you want other sto access it, youll have to change the permissions in the index.php
136 $userid = $params['user_id'];
137 $user = user_get_object($userid);
138 $text = $params['text'];
139 //check if the user has the plugin activated
140 if ($user->usesPlugin($this->name)) {
142 echo util_make_link ("/plugins/projectimport/index.php?id=$userid&type=user&pluginname=".$this->name,
143 _('View Personal ProjectImport')
147 } elseif ($hookname == "project_admin_plugins") {
148 // this displays the link in the project admin options page to it's ProjectImport administration
149 $group_id = $params['group_id'];
150 $group = &group_get_object($group_id);
151 if ( $group->usesPlugin ( $this->name ) ) {
152 echo util_make_link ("/plugins/projectimport/index.php?id=".$group->getID().'&type=admin&pluginname='.$this->name,
153 _('View the ProjectImport Administration')).'<br />';
156 elseif ($hookname == "blahblahblah") {
163 * Displays the link in the Project Maintenance part of the Site Admin ('site_admin_project_maintenance_hook' plugin_hook_by_reference() -style hook)
164 * @param array $params for concatenating return value in ['results']
166 function site_admin_project_maintenance_hook (&$params) {
167 $html = $params['result'];
169 util_make_link ('/plugins/'.$this->name.'/projectsimport.php',
170 _("Import projects"). ' [' . _('Project import plugin') . ']') .'</li>';
171 $params['result'] = $html;
175 * Displays the link in the User Maintenance part of the Site Admin ('site_admin_user_maintenance_hook' plugin_hook_by_reference() -style hook)
176 * @param array $params for concatenating return value in ['results']
178 function site_admin_user_maintenance_hook (&$params) {
179 $html = $params['result'];
181 util_make_link ('/plugins/'.$this->name.'/usersimport.php',
182 _("Import users"). ' [' . _('Project import plugin') . ']') .'</li>';
183 $params['result'] = $html;
191 // c-file-style: "bsd"