4 * MediaWikiPlugin Class
7 * This file is part of FusionForge.
9 * FusionForge 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 forge_define_config_item('src_path','mediawiki', "/usr/share/mediawiki");
26 forge_define_config_item('mwdata_path', 'mediawiki', '$core/data_path/plugins/mediawiki');
27 forge_define_config_item('projects_path', 'mediawiki', '$mediawiki/mwdata_path/projects');
28 forge_define_config_item('master_path', 'mediawiki', '$mediawiki/mwdata_path/master');
30 forge_define_config_item('enable_uploads', 'mediawiki', false);
31 forge_set_config_item_bool('enable_uploads', 'mediawiki');
32 forge_define_config_item('use_frame', 'mediawiki', false);
33 forge_set_config_item_bool('use_frame', 'mediawiki');
36 class MediaWikiPlugin extends Plugin {
37 function MediaWikiPlugin () {
39 $this->name = "mediawiki" ;
40 $this->text = "Mediawiki" ; // To show in the tabs, use...
41 $this->hooks[] = "groupmenu" ; // To put into the project tabs
42 $this->hooks[] = "groupisactivecheckbox" ; // The "use ..." checkbox in editgroupinfo
43 $this->hooks[] = "groupisactivecheckboxpost" ; //
44 $this->hooks[] = "project_public_area";
45 $this->hooks[] = "role_get";
46 $this->hooks[] = "role_normalize";
47 $this->hooks[] = "role_translate_strings";
48 $this->hooks[] = "role_has_permission";
49 $this->hooks[] = "role_get_setting";
50 $this->hooks[] = "list_roles_by_permission";
51 $this->hooks[] = "project_admin_plugins"; // to show up in the admin page for group
54 function CallHook ($hookname, $params) {
55 if (isset($params['group_id'])) {
56 $group_id=$params['group_id'];
57 } elseif (isset($params['group'])) {
58 $group_id=$params['group'];
62 if ($hookname == "groupmenu") {
63 $project = &group_get_object($group_id);
64 if (!$project || !is_object($project)) {
67 if ($project->isError()) {
70 if (!$project->isProject()) {
73 if ( $project->usesPlugin ( $this->name ) ) {
74 $params['TITLES'][]=$this->text;
75 if (forge_get_config('use_frame', 'mediawiki')){
76 $params['DIRS'][]=util_make_url ('/plugins/mediawiki/frame.php?group_id=' . $project->getID()) ;
78 $params['DIRS'][]=util_make_url('/plugins/mediawiki/wiki/'.$project->getUnixName().'/index.php');
81 (($params['toptab'] == $this->name) ? $params['selected']=(count($params['TITLES'])-1) : '' );
82 } elseif ($hookname == "groupisactivecheckbox") {
83 //Check if the group is active
84 // this code creates the checkbox in the project edit public info page to activate/deactivate the plugin
85 $group = &group_get_object($group_id);
88 echo ' <input type="checkbox" name="use_mediawikiplugin" value="1" ';
89 // checked or unchecked?
90 if ( $group->usesPlugin ( $this->name ) ) {
96 echo "<strong>Use ".$this->text." Plugin</strong>";
99 } elseif ($hookname == "groupisactivecheckboxpost") {
100 // this code actually activates/deactivates the plugin after the form was submitted in the project edit public info page
101 $group = &group_get_object($group_id);
102 $use_mediawikiplugin = getStringFromRequest('use_mediawikiplugin');
103 if ( $use_mediawikiplugin == 1 ) {
104 $group->setPluginUse ( $this->name );
106 $group->setPluginUse ( $this->name, false );
108 } elseif ($hookname == "project_public_area") {
109 $project = &group_get_object($group_id);
110 if (!$project || !is_object($project)) {
113 if ($project->isError()) {
116 if (!$project->isProject()) {
119 if ( $project->usesPlugin ( $this->name ) ) {
120 echo '<div class="public-area-box">';
121 print '<a href="'. util_make_url ('/plugins/mediawiki/wiki/'.$project->getUnixName().'/index.php').'">';
122 print html_abs_image(util_make_url ('/plugins/mediawiki/wiki/'.$project->getUnixName().'/skins/fusionforge/wiki.png'),'20','20',array('alt'=>'Mediawiki'));
127 } elseif ($hookname == "role_get") {
128 $role =& $params['role'] ;
131 $right = new PluginSpecificRoleSetting ($role,
132 'plugin_mediawiki_read') ;
133 $right->SetAllowedValues (array ('0', '1')) ;
134 $right->SetDefaultValues (array ('Admin' => '1',
135 'Senior Developer' => '1',
136 'Junior Developer' => '1',
138 'Support Tech' => '1')) ;
141 $right = new PluginSpecificRoleSetting ($role,
142 'plugin_mediawiki_edit') ;
143 $right->SetAllowedValues (array ('0', '1', '2', '3')) ;
144 $right->SetDefaultValues (array ('Admin' => '3',
145 'Senior Developer' => '2',
146 'Junior Developer' => '1',
148 'Support Tech' => '0')) ;
150 // File upload privileges
151 $right = new PluginSpecificRoleSetting ($role,
152 'plugin_mediawiki_upload') ;
153 $right->SetAllowedValues (array ('0', '1', '2')) ;
154 $right->SetDefaultValues (array ('Admin' => '2',
155 'Senior Developer' => '2',
156 'Junior Developer' => '1',
158 'Support Tech' => '0')) ;
160 // Administrative tasks
161 $right = new PluginSpecificRoleSetting ($role,
162 'plugin_mediawiki_admin') ;
163 $right->SetAllowedValues (array ('0', '1')) ;
164 $right->SetDefaultValues (array ('Admin' => '1',
165 'Senior Developer' => '0',
166 'Junior Developer' => '0',
168 'Support Tech' => '0')) ;
170 } elseif ($hookname == "role_normalize") {
171 $role =& $params['role'] ;
172 $new_sa =& $params['new_sa'] ;
173 $new_pa =& $params['new_pa'] ;
176 $projects = $role->getLinkedProjects() ;
177 foreach ($projects as $p) {
178 $role->normalizePermsForSection ($new_pa, 'plugin_mediawiki_read', $p->getID()) ;
179 $role->normalizePermsForSection ($new_pa, 'plugin_mediawiki_edit', $p->getID()) ;
180 $role->normalizePermsForSection ($new_pa, 'plugin_mediawiki_upload', $p->getID()) ;
181 $role->normalizePermsForSection ($new_pa, 'plugin_mediawiki_admin', $p->getID()) ;
184 $role->normalizeDataForSection ($new_sa, 'plugin_mediawiki_read') ;
185 $role->normalizeDataForSection ($new_sa, 'plugin_mediawiki_edit') ;
186 $role->normalizeDataForSection ($new_sa, 'plugin_mediawiki_upload') ;
187 $role->normalizeDataForSection ($new_sa, 'plugin_mediawiki_admin') ;
189 } elseif ($hookname == "role_translate_strings") {
190 $right = new PluginSpecificRoleSetting ($role,
191 'plugin_mediawiki_read') ;
192 $right->setDescription (_('Mediawiki read access')) ;
193 $right->setValueDescriptions (array ('0' => _('No reading'),
194 '1' => _('Read access'))) ;
196 $right = new PluginSpecificRoleSetting ($role,
197 'plugin_mediawiki_edit') ;
198 $right->setDescription (_('Mediawiki write access')) ;
199 $right->setValueDescriptions (array ('0' => _('No editing'),
200 '1' => _('Edit existing pages only'),
201 '2' => _('Edit and create pages'),
202 '3' => _('Edit, create, move, delete pages'))) ;
204 $right = new PluginSpecificRoleSetting ($role,
205 'plugin_mediawiki_upload') ;
206 $right->setDescription (_('Mediawiki file upload')) ;
207 $right->setValueDescriptions (array ('0' => _('No uploading'),
208 '1' => _('Upload permitted'),
209 '2' => _('Upload and re-upload'))) ;
211 $right = new PluginSpecificRoleSetting ($role,
212 'plugin_mediawiki_admin') ;
213 $right->setDescription (_('Mediawiki administrative tasks')) ;
214 $right->setValueDescriptions (array ('0' => _('No administrative access'),
215 '1' => _('Edit interface, import XML dumps'))) ;
216 } elseif ($hookname == "role_get_setting") {
217 $role = $params['role'] ;
218 $reference = $params['reference'] ;
219 $value = $params['value'] ;
221 switch ($params['section']) {
222 case 'plugin_mediawiki_read':
223 if ($role->hasPermission('project_admin', $reference)) {
224 $params['result'] = 1 ;
226 $params['result'] = $value ;
229 case 'plugin_mediawiki_edit':
230 if ($role->hasPermission('project_admin', $reference)) {
231 $params['result'] = 3 ;
233 $params['result'] = $value ;
236 case 'plugin_mediawiki_upload':
237 if ($role->hasPermission('project_admin', $reference)) {
238 $params['result'] = 2 ;
240 $params['result'] = $value ;
243 case 'plugin_mediawiki_admin':
244 if ($role->hasPermission('project_admin', $reference)) {
245 $params['result'] = 1 ;
247 $params['result'] = $value ;
251 } elseif ($hookname == "role_has_permission") {
252 switch ($params['section']) {
253 case 'plugin_mediawiki_read':
254 switch ($params['action']) {
257 $params['result'] |= ($value >= 1) ;
261 case 'plugin_mediawiki_edit':
262 switch ($params['action']) {
264 $params['result'] |= ($value >= 1) ;
267 $params['result'] |= ($value >= 2) ;
270 $params['result'] |= ($value >= 3) ;
274 case 'plugin_mediawiki_upload':
275 switch ($params['action']) {
277 $params['result'] |= ($value >= 1) ;
280 $params['result'] |= ($value >= 2) ;
284 case 'plugin_mediawiki_admin':
285 switch ($params['action']) {
288 $params['result'] |= ($value >= 1) ;
293 } elseif ($hookname == "list_roles_by_permission") {
294 switch ($params['section']) {
295 case 'plugin_mediawiki_read':
296 switch ($params['action']) {
299 $params['qpa'] = db_construct_qpa ($params['qpa'], ' AND perm_val >= 1') ;
303 case 'plugin_mediawiki_edit':
304 switch ($params['action']) {
306 $params['qpa'] = db_construct_qpa ($params['qpa'], ' AND perm_val >= 1') ;
309 $params['qpa'] = db_construct_qpa ($params['qpa'], ' AND perm_val >= 2') ;
312 $params['qpa'] = db_construct_qpa ($params['qpa'], ' AND perm_val >= 3') ;
316 case 'plugin_mediawiki_upload':
317 switch ($params['action']) {
319 $params['qpa'] = db_construct_qpa ($params['qpa'], ' AND perm_val >= 1') ;
322 $params['qpa'] = db_construct_qpa ($params['qpa'], ' AND perm_val >= 2') ;
326 case 'plugin_mediawiki_admin':
327 switch ($params['action']) {
330 $params['qpa'] = db_construct_qpa ($params['qpa'], ' AND perm_val >= 1') ;
335 } else if ($hookname == "project_admin_plugins") {
336 $group_id = $params['group_id'];
337 $group = &group_get_object($group_id);
338 if ($group->usesPlugin($this->name))
340 "/plugins/mediawiki/plugin_admin.php?group_id=" .
341 $group->getID(), _("MediaWiki Plugin admin")) .
349 // c-file-style: "bsd"