3 * MediaWikiPlugin Class
5 * Copyright 2000-2011, Fusionforge Team
6 * Copyright 2012,2014,2016, 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');
35 require_once $gfcommon.'include/SysTasksQ.class.php';
37 class MediaWikiPlugin extends Plugin {
38 public $systask_types = array(
39 'MEDIAWIKI_CREATE_WIKI' => 'create-wikis.php',
40 'MEDIAWIKI_CREATE_IMAGEDIR' => 'create-imagedirs.php'
43 function __construct ($id=0) {
44 parent::__construct($id) ;
45 $this->name = "mediawiki" ;
46 $this->text = _("Mediawiki") ; // To show in the tabs, use...
48 _("This plugin allows each project to embed Mediawiki under a tab.");
49 $this->_addHook("groupmenu") ; // To put into the project tabs
50 $this->_addHook("groupisactivecheckbox") ; // The "use ..." checkbox in editgroupinfo
51 $this->_addHook("groupisactivecheckboxpost") ; //
52 $this->_addHook("project_public_area");
53 $this->_addHook("role_get");
54 $this->_addHook("role_normalize");
55 $this->_addHook("role_unlink_project");
56 $this->_addHook("role_translate_strings");
57 $this->_addHook("role_has_permission");
58 $this->_addHook("role_get_setting");
59 $this->_addHook("list_roles_by_permission");
60 $this->_addHook("project_admin_plugins"); // to show up in the admin page for group
61 $this->_addHook("clone_project_from_template") ;
62 $this->_addHook('group_delete');
66 echo '<h1>Mediawiki</h1>';
67 echo $this->getPluginInfo()->getpropVal('answer');
70 function &getPluginInfo() {
71 if (!is_a($this->pluginInfo, 'MediaWikiPluginInfo')) {
72 require_once 'MediaWikiPluginInfo.class.php';
73 $this->pluginInfo = new MediaWikiPluginInfo($this);
75 return $this->pluginInfo;
78 function CallHook($hookname, &$params) {
79 if (isset($params['group_id'])) {
80 $group_id=$params['group_id'];
81 } elseif (isset($params['group'])) {
82 $group_id=$params['group'];
86 if ($hookname == "groupmenu") {
87 $project = group_get_object($group_id);
88 if (!$project || !is_object($project)) {
91 if ($project->isError()) {
94 if ( $project->usesPlugin ( $this->name ) ) {
95 $params['TITLES'][]=$this->text;
96 $params['DIRS'][]=util_make_url('/plugins/mediawiki/wiki/'.$project->getUnixName().'/index.php');
97 if (session_loggedin()) {
98 $user = session_get_user();
99 $userperm = $project->getPermission();
100 if ($userperm->isAdmin()) {
101 $params['ADMIN'][] = util_make_url('/plugins/mediawiki/plugin_admin.php?group_id='.$project->getID());
104 $params['TOOLTIPS'][] = _('Mediawiki Space');
106 (($params['toptab'] == $this->name) ? $params['selected']=(count($params['TITLES'])-1) : '' );
107 } elseif ($hookname == "project_public_area") {
108 $project = group_get_object($group_id);
109 if (!$project || !is_object($project)) {
112 if ($project->isError()) {
115 if ( $project->usesPlugin ( $this->name ) ) {
116 $params['result'] .= '<div class="public-area-box">';
117 $params['result'] .= util_make_link('/plugins/mediawiki/wiki/'.$project->getUnixName().'/index.php',
118 html_abs_image(util_make_url('/plugins/mediawiki/wiki/'.$project->getUnixName().'/skins/monobook/wiki.png'),'20','20',array('alt'=>'Mediawiki')).
119 ' '.'Mediawiki');
120 $params['result'] .= '</div>';
122 } elseif ($hookname == "role_get") {
123 $role =& $params['role'] ;
126 $right = new PluginSpecificRoleSetting ($role,
127 'plugin_mediawiki_read') ;
128 $right->SetAllowedValues (array ('0', '1')) ;
129 $right->SetDefaultValues (array ('Admin' => '1',
130 'Senior Developer' => '1',
131 'Junior Developer' => '1',
133 'Support Tech' => '1')) ;
136 $right = new PluginSpecificRoleSetting ($role,
137 'plugin_mediawiki_edit') ;
138 $right->SetAllowedValues (array ('0', '1', '2', '3')) ;
139 $right->SetDefaultValues (array ('Admin' => '3',
140 'Senior Developer' => '2',
141 'Junior Developer' => '1',
143 'Support Tech' => '0')) ;
145 // File upload privileges
146 $right = new PluginSpecificRoleSetting ($role,
147 'plugin_mediawiki_upload') ;
148 $right->SetAllowedValues (array ('0', '1', '2')) ;
149 $right->SetDefaultValues (array ('Admin' => '2',
150 'Senior Developer' => '2',
151 'Junior Developer' => '1',
153 'Support Tech' => '0')) ;
155 // Administrative tasks
156 $right = new PluginSpecificRoleSetting ($role,
157 'plugin_mediawiki_admin') ;
158 $right->SetAllowedValues (array ('0', '1')) ;
159 $right->SetDefaultValues (array ('Admin' => '1',
160 'Senior Developer' => '0',
161 'Junior Developer' => '0',
163 'Support Tech' => '0')) ;
165 } elseif ($hookname == "role_normalize") {
166 $role =& $params['role'] ;
167 $new_pa =& $params['new_pa'] ;
169 $projects = $role->getLinkedProjects() ;
170 foreach ($projects as $p) {
171 $role->normalizePermsForSection ($new_pa, 'plugin_mediawiki_read', $p->getID()) ;
172 $role->normalizePermsForSection ($new_pa, 'plugin_mediawiki_edit', $p->getID()) ;
173 $role->normalizePermsForSection ($new_pa, 'plugin_mediawiki_upload', $p->getID()) ;
174 $role->normalizePermsForSection ($new_pa, 'plugin_mediawiki_admin', $p->getID()) ;
176 } elseif ($hookname == "role_unlink_project") {
177 $role =& $params['role'] ;
178 $project =& $params['project'] ;
180 $settings = array('plugin_mediawiki_read', 'plugin_mediawiki_edit', 'plugin_mediawiki_upload', 'plugin_mediawiki_admin');
182 foreach ($settings as $s) {
183 db_query_params('DELETE FROM pfo_role_setting WHERE role_id=$1 AND section_name=$2 AND ref_id=$3',
184 array($role->getID(),
188 } elseif ($hookname == "role_translate_strings") {
189 $right = new PluginSpecificRoleSetting ($role,
190 'plugin_mediawiki_read') ;
191 $right->setDescription (_('Mediawiki read access')) ;
192 $right->setValueDescriptions (array ('0' => _('No reading'),
193 '1' => _('Read access'))) ;
195 $right = new PluginSpecificRoleSetting ($role,
196 'plugin_mediawiki_edit') ;
197 $right->setDescription (_('Mediawiki write access')) ;
198 $right->setValueDescriptions (array ('0' => _('No editing'),
199 '1' => _('Edit existing pages only'),
200 '2' => _('Edit and create pages'),
201 '3' => _('Edit, create, move, delete pages'))) ;
203 $right = new PluginSpecificRoleSetting ($role,
204 'plugin_mediawiki_upload') ;
205 $right->setDescription (_('Mediawiki file upload')) ;
206 $right->setValueDescriptions (array ('0' => _('No uploading'),
207 '1' => _('Upload permitted'),
208 '2' => _('Upload and re-upload'))) ;
210 $right = new PluginSpecificRoleSetting ($role,
211 'plugin_mediawiki_admin') ;
212 $right->setDescription (_('Mediawiki administrative tasks')) ;
213 $right->setValueDescriptions (array ('0' => _('No administrative access'),
214 '1' => _('Edit interface, import XML dumps'))) ;
215 } elseif ($hookname == "role_get_setting") {
216 $role = $params['role'] ;
217 $reference = $params['reference'] ;
218 $value = $params['value'] ;
220 switch ($params['section']) {
221 case 'plugin_mediawiki_read':
222 if ($role->hasPermission('project_admin', $reference)) {
223 $params['result'] = 1 ;
225 $params['result'] = $value ;
228 case 'plugin_mediawiki_edit':
229 if ($role->hasPermission('project_admin', $reference)) {
230 $params['result'] = 3 ;
232 $params['result'] = $value ;
235 case 'plugin_mediawiki_upload':
236 if ($role->hasPermission('project_admin', $reference)) {
237 $params['result'] = 2 ;
239 $params['result'] = $value ;
242 case 'plugin_mediawiki_admin':
243 if ($role->hasPermission('project_admin', $reference)) {
244 $params['result'] = 1 ;
246 $params['result'] = $value ;
250 } elseif ($hookname == "role_has_permission") {
251 $value = $params['value'];
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 } elseif ($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")) .
343 } elseif ($hookname == "clone_project_from_template") {
344 $template = $params['template'] ;
345 $project = $params['project'] ;
346 $id_mappings = $params['id_mappings'] ;
348 $sections = array ('plugin_mediawiki_read', 'plugin_mediawiki_edit', 'plugin_mediawiki_upload', 'plugin_mediawiki_admin') ;
350 foreach ($template->getRoles() as $oldrole) {
351 $newrole = RBACEngine::getInstance()->getRoleById ($id_mappings['role'][$oldrole->getID()]) ;
352 $oldsettings = $oldrole->getSettingsForProject ($template) ;
354 foreach ($sections as $section) {
355 if (isset ($oldsettings[$section][$template->getID()])) {
356 $newrole->setSetting ($section, $project->getID(), $oldsettings[$section][$template->getID()]) ;
360 } elseif ($hookname == 'group_delete') {
361 $projectId = $params['group_id'];
362 $projectObject = group_get_object($projectId);
363 if ($projectObject->usesPlugin($this->name)) {
364 //delete the files and db schema
365 $schema = 'plugin_mediawiki_'.$projectObject->getUnixName();
366 // Sanitize schema name
367 $schema = strtr($schema, "-", "_");
368 db_query_params('drop schema $1 cascade', array($schema));
369 exec('/bin/rm -rf '.forge_get_config('projects_path', 'mediawiki').'/'.$projectObject->getUnixName());
374 function groupisactivecheckboxpost(&$params) {
375 if (!parent::groupisactivecheckboxpost($params))
377 if (getIntFromRequest('use_mediawiki') == 1) {
378 $systasksq = new SystasksQ();
379 $group_id = $params['group'];
380 $systasksq->add($this->getID(), 'MEDIAWIKI_CREATE_WIKI', $group_id);
381 $systasksq->add($this->getID(), 'MEDIAWIKI_CREATE_IMAGEDIR', $group_id);
389 // c-file-style: "bsd"