3 * MediaWikiPlugin Class
5 * Copyright 2000-2011, Fusionforge Team
6 * Copyright 2012, Franck Villaume - TrivialDev
7 * http://fusionforge.org
9 * This file is part of FusionForge.
11 * FusionForge is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * FusionForge is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License along
22 * with this program; if not, write to the Free Software Foundation, Inc.,
23 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
26 require_once 'plugins_utils.php';
27 if(is_dir("/usr/share/mediawiki")){
28 forge_define_config_item('src_path','mediawiki', "/usr/share/mediawiki");
29 forge_define_config_item('mwdata_path', 'mediawiki', '$core/data_path/plugins/mediawiki');
30 forge_define_config_item('projects_path', 'mediawiki', '$mediawiki/mwdata_path/projects');
31 forge_define_config_item('master_path', 'mediawiki', '$mediawiki/mwdata_path/master');
32 forge_define_config_item('enable_uploads', 'mediawiki', false);
33 forge_set_config_item_bool('enable_uploads', 'mediawiki');
36 class MediaWikiPlugin extends Plugin {
37 function __construct ($id=0) {
39 $this->name = "mediawiki" ;
40 $this->text = "Mediawiki" ; // To show in the tabs, use...
41 $this->_addHook("groupmenu") ; // To put into the project tabs
42 $this->_addHook("groupisactivecheckbox") ; // The "use ..." checkbox in editgroupinfo
43 $this->_addHook("groupisactivecheckboxpost") ; //
44 $this->_addHook("project_public_area");
45 $this->_addHook("role_get");
46 $this->_addHook("role_normalize");
47 $this->_addHook("role_translate_strings");
48 $this->_addHook("role_has_permission");
49 $this->_addHook("role_get_setting");
50 $this->_addHook("list_roles_by_permission");
51 $this->_addHook("project_admin_plugins"); // to show up in the admin page for group
52 $this->_addHook("clone_project_from_template") ;
53 $this->_addHook('group_delete');
57 echo '<h1>Mediawiki</h1>';
58 echo $this->getPluginInfo()->getpropVal('answer');
61 function &getPluginInfo() {
62 if (!is_a($this->pluginInfo, 'MediaWikiPluginInfo')) {
63 require_once 'MediaWikiPluginInfo.class.php';
64 $this->pluginInfo = new MediaWikiPluginInfo($this);
66 return $this->pluginInfo;
69 function CallHook ($hookname, &$params) {
70 if (isset($params['group_id'])) {
71 $group_id=$params['group_id'];
72 } elseif (isset($params['group'])) {
73 $group_id=$params['group'];
77 if ($hookname == "groupmenu") {
78 $project = group_get_object($group_id);
79 if (!$project || !is_object($project)) {
82 if ($project->isError()) {
85 if (!$project->isProject()) {
88 if ( $project->usesPlugin ( $this->name ) ) {
89 $params['TITLES'][]=$this->text;
90 $params['DIRS'][]=util_make_url('/plugins/mediawiki/wiki/'.$project->getUnixName().'/index.php');
91 $params['ADMIN'][]='';
92 $params['TOOLTIPS'][] = _('Mediawiki Space');
94 (($params['toptab'] == $this->name) ? $params['selected']=(count($params['TITLES'])-1) : '' );
95 } elseif ($hookname == "groupisactivecheckbox") {
96 //Check if the group is active
97 // this code creates the checkbox in the project edit public info page to activate/deactivate the plugin
98 $group = group_get_object($group_id);
101 echo ' <input type="checkbox" name="use_mediawikiplugin" value="1" ';
102 // checked or unchecked?
103 if ( $group->usesPlugin ( $this->name ) ) {
109 echo "<strong>Use ".$this->text." Plugin</strong>";
112 } elseif ($hookname == "groupisactivecheckboxpost") {
113 // this code actually activates/deactivates the plugin after the form was submitted in the project edit public info page
114 $group = group_get_object($group_id);
115 $use_mediawikiplugin = getStringFromRequest('use_mediawikiplugin');
116 if ( $use_mediawikiplugin == 1 ) {
117 $group->setPluginUse ( $this->name );
119 $group->setPluginUse ( $this->name, false );
121 } elseif ($hookname == "project_public_area") {
122 $project = group_get_object($group_id);
123 if (!$project || !is_object($project)) {
126 if ($project->isError()) {
129 if (!$project->isProject()) {
132 if ( $project->usesPlugin ( $this->name ) ) {
133 echo '<div class="public-area-box">';
134 print '<a href="'. util_make_url ('/plugins/mediawiki/wiki/'.$project->getUnixName().'/index.php').'">';
135 print html_abs_image(util_make_url ('/plugins/mediawiki/wiki/'.$project->getUnixName().'/skins/fusionforge/wiki.png'),'20','20',array('alt'=>'Mediawiki'));
140 } elseif ($hookname == "role_get") {
141 $role =& $params['role'] ;
144 $right = new PluginSpecificRoleSetting ($role,
145 'plugin_mediawiki_read') ;
146 $right->SetAllowedValues (array ('0', '1')) ;
147 $right->SetDefaultValues (array ('Admin' => '1',
148 'Senior Developer' => '1',
149 'Junior Developer' => '1',
151 'Support Tech' => '1')) ;
154 $right = new PluginSpecificRoleSetting ($role,
155 'plugin_mediawiki_edit') ;
156 $right->SetAllowedValues (array ('0', '1', '2', '3')) ;
157 $right->SetDefaultValues (array ('Admin' => '3',
158 'Senior Developer' => '2',
159 'Junior Developer' => '1',
161 'Support Tech' => '0')) ;
163 // File upload privileges
164 $right = new PluginSpecificRoleSetting ($role,
165 'plugin_mediawiki_upload') ;
166 $right->SetAllowedValues (array ('0', '1', '2')) ;
167 $right->SetDefaultValues (array ('Admin' => '2',
168 'Senior Developer' => '2',
169 'Junior Developer' => '1',
171 'Support Tech' => '0')) ;
173 // Administrative tasks
174 $right = new PluginSpecificRoleSetting ($role,
175 'plugin_mediawiki_admin') ;
176 $right->SetAllowedValues (array ('0', '1')) ;
177 $right->SetDefaultValues (array ('Admin' => '1',
178 'Senior Developer' => '0',
179 'Junior Developer' => '0',
181 'Support Tech' => '0')) ;
183 } elseif ($hookname == "role_normalize") {
184 $role =& $params['role'] ;
185 $new_pa =& $params['new_pa'] ;
187 $projects = $role->getLinkedProjects() ;
188 foreach ($projects as $p) {
189 $role->normalizePermsForSection ($new_pa, 'plugin_mediawiki_read', $p->getID()) ;
190 $role->normalizePermsForSection ($new_pa, 'plugin_mediawiki_edit', $p->getID()) ;
191 $role->normalizePermsForSection ($new_pa, 'plugin_mediawiki_upload', $p->getID()) ;
192 $role->normalizePermsForSection ($new_pa, 'plugin_mediawiki_admin', $p->getID()) ;
194 } elseif ($hookname == "role_translate_strings") {
195 $right = new PluginSpecificRoleSetting ($role,
196 'plugin_mediawiki_read') ;
197 $right->setDescription (_('Mediawiki read access')) ;
198 $right->setValueDescriptions (array ('0' => _('No reading'),
199 '1' => _('Read access'))) ;
201 $right = new PluginSpecificRoleSetting ($role,
202 'plugin_mediawiki_edit') ;
203 $right->setDescription (_('Mediawiki write access')) ;
204 $right->setValueDescriptions (array ('0' => _('No editing'),
205 '1' => _('Edit existing pages only'),
206 '2' => _('Edit and create pages'),
207 '3' => _('Edit, create, move, delete pages'))) ;
209 $right = new PluginSpecificRoleSetting ($role,
210 'plugin_mediawiki_upload') ;
211 $right->setDescription (_('Mediawiki file upload')) ;
212 $right->setValueDescriptions (array ('0' => _('No uploading'),
213 '1' => _('Upload permitted'),
214 '2' => _('Upload and re-upload'))) ;
216 $right = new PluginSpecificRoleSetting ($role,
217 'plugin_mediawiki_admin') ;
218 $right->setDescription (_('Mediawiki administrative tasks')) ;
219 $right->setValueDescriptions (array ('0' => _('No administrative access'),
220 '1' => _('Edit interface, import XML dumps'))) ;
221 } elseif ($hookname == "role_get_setting") {
222 $role = $params['role'] ;
223 $reference = $params['reference'] ;
224 $value = $params['value'] ;
226 switch ($params['section']) {
227 case 'plugin_mediawiki_read':
228 if ($role->hasPermission('project_admin', $reference)) {
229 $params['result'] = 1 ;
231 $params['result'] = $value ;
234 case 'plugin_mediawiki_edit':
235 if ($role->hasPermission('project_admin', $reference)) {
236 $params['result'] = 3 ;
238 $params['result'] = $value ;
241 case 'plugin_mediawiki_upload':
242 if ($role->hasPermission('project_admin', $reference)) {
243 $params['result'] = 2 ;
245 $params['result'] = $value ;
248 case 'plugin_mediawiki_admin':
249 if ($role->hasPermission('project_admin', $reference)) {
250 $params['result'] = 1 ;
252 $params['result'] = $value ;
256 } elseif ($hookname == "role_has_permission") {
257 $value = $params['value'];
258 switch ($params['section']) {
259 case 'plugin_mediawiki_read':
260 switch ($params['action']) {
263 $params['result'] |= ($value >= 1) ;
267 case 'plugin_mediawiki_edit':
268 switch ($params['action']) {
270 $params['result'] |= ($value >= 1) ;
273 $params['result'] |= ($value >= 2) ;
276 $params['result'] |= ($value >= 3) ;
280 case 'plugin_mediawiki_upload':
281 switch ($params['action']) {
283 $params['result'] |= ($value >= 1) ;
286 $params['result'] |= ($value >= 2) ;
290 case 'plugin_mediawiki_admin':
291 switch ($params['action']) {
294 $params['result'] |= ($value >= 1) ;
299 } elseif ($hookname == "list_roles_by_permission") {
300 switch ($params['section']) {
301 case 'plugin_mediawiki_read':
302 switch ($params['action']) {
305 $params['qpa'] = db_construct_qpa ($params['qpa'], ' AND perm_val >= 1') ;
309 case 'plugin_mediawiki_edit':
310 switch ($params['action']) {
312 $params['qpa'] = db_construct_qpa ($params['qpa'], ' AND perm_val >= 1') ;
315 $params['qpa'] = db_construct_qpa ($params['qpa'], ' AND perm_val >= 2') ;
318 $params['qpa'] = db_construct_qpa ($params['qpa'], ' AND perm_val >= 3') ;
322 case 'plugin_mediawiki_upload':
323 switch ($params['action']) {
325 $params['qpa'] = db_construct_qpa ($params['qpa'], ' AND perm_val >= 1') ;
328 $params['qpa'] = db_construct_qpa ($params['qpa'], ' AND perm_val >= 2') ;
332 case 'plugin_mediawiki_admin':
333 switch ($params['action']) {
336 $params['qpa'] = db_construct_qpa ($params['qpa'], ' AND perm_val >= 1') ;
341 } elseif ($hookname == "project_admin_plugins") {
342 $group_id = $params['group_id'];
343 $group = group_get_object($group_id);
344 if ($group->usesPlugin($this->name))
346 "/plugins/mediawiki/plugin_admin.php?group_id=" .
347 $group->getID(), _("MediaWiki Plugin admin")) .
349 } elseif ($hookname == "clone_project_from_template") {
350 $template = $params['template'] ;
351 $project = $params['project'] ;
352 $id_mappings = $params['id_mappings'] ;
354 $sections = array ('plugin_mediawiki_read', 'plugin_mediawiki_edit', 'plugin_mediawiki_upload', 'plugin_mediawiki_admin') ;
356 foreach ($template->getRoles() as $oldrole) {
357 $newrole = RBACEngine::getInstance()->getRoleById ($id_mappings['role'][$oldrole->getID()]) ;
358 $oldsettings = $oldrole->getSettingsForProject ($template) ;
360 foreach ($sections as $section) {
361 if (isset ($oldsettings[$section][$template->getID()])) {
362 $newrole->setSetting ($section, $project->getID(), $oldsettings[$section][$template->getID()]) ;
366 } elseif ($hookname == 'group_delete') {
367 $projectId = $params['group_id'];
368 $projectObject = group_get_object($projectId);
369 if ($projectObject->usesPlugin($this->name)) {
370 //delete the files and db schema
371 $schema = 'plugin_mediawiki_'.$projectObject->getUnixName();
372 // Sanitize schema name
373 $schema = strtr($schema, "-", "_");
374 db_query_params('drop schema $1 cascade', array($schema));
375 exec('/bin/rm -rf '.forge_get_config('projects_path', 'mediawiki').'/'.$projectObject->getUnixName());
383 // c-file-style: "bsd"