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 * FusionForge 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 along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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
52 $this->hooks[] = "clone_project_from_template" ;
55 function CallHook ($hookname, &$params) {
56 if (isset($params['group_id'])) {
57 $group_id=$params['group_id'];
58 } elseif (isset($params['group'])) {
59 $group_id=$params['group'];
63 if ($hookname == "groupmenu") {
64 $project = group_get_object($group_id);
65 if (!$project || !is_object($project)) {
68 if ($project->isError()) {
71 if (!$project->isProject()) {
74 if ( $project->usesPlugin ( $this->name ) ) {
75 $params['TITLES'][]=$this->text;
76 if (forge_get_config('use_frame', 'mediawiki')){
77 $params['DIRS'][]=util_make_url ('/plugins/mediawiki/frame.php?group_id=' . $project->getID()) ;
79 $params['DIRS'][]=util_make_url('/plugins/mediawiki/wiki/'.$project->getUnixName().'/index.php');
82 (($params['toptab'] == $this->name) ? $params['selected']=(count($params['TITLES'])-1) : '' );
83 } elseif ($hookname == "groupisactivecheckbox") {
84 //Check if the group is active
85 // this code creates the checkbox in the project edit public info page to activate/deactivate the plugin
86 $group = group_get_object($group_id);
89 echo ' <input type="checkbox" name="use_mediawikiplugin" value="1" ';
90 // checked or unchecked?
91 if ( $group->usesPlugin ( $this->name ) ) {
97 echo "<strong>Use ".$this->text." Plugin</strong>";
100 } elseif ($hookname == "groupisactivecheckboxpost") {
101 // this code actually activates/deactivates the plugin after the form was submitted in the project edit public info page
102 $group = group_get_object($group_id);
103 $use_mediawikiplugin = getStringFromRequest('use_mediawikiplugin');
104 if ( $use_mediawikiplugin == 1 ) {
105 $group->setPluginUse ( $this->name );
107 $group->setPluginUse ( $this->name, false );
109 } elseif ($hookname == "project_public_area") {
110 $project = group_get_object($group_id);
111 if (!$project || !is_object($project)) {
114 if ($project->isError()) {
117 if (!$project->isProject()) {
120 if ( $project->usesPlugin ( $this->name ) ) {
121 echo '<div class="public-area-box">';
122 print '<a href="'. util_make_url ('/plugins/mediawiki/wiki/'.$project->getUnixName().'/index.php').'">';
123 print html_abs_image(util_make_url ('/plugins/mediawiki/wiki/'.$project->getUnixName().'/skins/fusionforge/wiki.png'),'20','20',array('alt'=>'Mediawiki'));
128 } elseif ($hookname == "role_get") {
129 $role =& $params['role'] ;
132 $right = new PluginSpecificRoleSetting ($role,
133 'plugin_mediawiki_read') ;
134 $right->SetAllowedValues (array ('0', '1')) ;
135 $right->SetDefaultValues (array ('Admin' => '1',
136 'Senior Developer' => '1',
137 'Junior Developer' => '1',
139 'Support Tech' => '1')) ;
142 $right = new PluginSpecificRoleSetting ($role,
143 'plugin_mediawiki_edit') ;
144 $right->SetAllowedValues (array ('0', '1', '2', '3')) ;
145 $right->SetDefaultValues (array ('Admin' => '3',
146 'Senior Developer' => '2',
147 'Junior Developer' => '1',
149 'Support Tech' => '0')) ;
151 // File upload privileges
152 $right = new PluginSpecificRoleSetting ($role,
153 'plugin_mediawiki_upload') ;
154 $right->SetAllowedValues (array ('0', '1', '2')) ;
155 $right->SetDefaultValues (array ('Admin' => '2',
156 'Senior Developer' => '2',
157 'Junior Developer' => '1',
159 'Support Tech' => '0')) ;
161 // Administrative tasks
162 $right = new PluginSpecificRoleSetting ($role,
163 'plugin_mediawiki_admin') ;
164 $right->SetAllowedValues (array ('0', '1')) ;
165 $right->SetDefaultValues (array ('Admin' => '1',
166 'Senior Developer' => '0',
167 'Junior Developer' => '0',
169 'Support Tech' => '0')) ;
171 } elseif ($hookname == "role_normalize") {
172 $role =& $params['role'] ;
173 $new_sa =& $params['new_sa'] ;
174 $new_pa =& $params['new_pa'] ;
177 $projects = $role->getLinkedProjects() ;
178 foreach ($projects as $p) {
179 $role->normalizePermsForSection ($new_pa, 'plugin_mediawiki_read', $p->getID()) ;
180 $role->normalizePermsForSection ($new_pa, 'plugin_mediawiki_edit', $p->getID()) ;
181 $role->normalizePermsForSection ($new_pa, 'plugin_mediawiki_upload', $p->getID()) ;
182 $role->normalizePermsForSection ($new_pa, 'plugin_mediawiki_admin', $p->getID()) ;
185 $role->normalizeDataForSection ($new_sa, 'plugin_mediawiki_read') ;
186 $role->normalizeDataForSection ($new_sa, 'plugin_mediawiki_edit') ;
187 $role->normalizeDataForSection ($new_sa, 'plugin_mediawiki_upload') ;
188 $role->normalizeDataForSection ($new_sa, 'plugin_mediawiki_admin') ;
190 } elseif ($hookname == "role_translate_strings") {
191 $right = new PluginSpecificRoleSetting ($role,
192 'plugin_mediawiki_read') ;
193 $right->setDescription (_('Mediawiki read access')) ;
194 $right->setValueDescriptions (array ('0' => _('No reading'),
195 '1' => _('Read access'))) ;
197 $right = new PluginSpecificRoleSetting ($role,
198 'plugin_mediawiki_edit') ;
199 $right->setDescription (_('Mediawiki write access')) ;
200 $right->setValueDescriptions (array ('0' => _('No editing'),
201 '1' => _('Edit existing pages only'),
202 '2' => _('Edit and create pages'),
203 '3' => _('Edit, create, move, delete pages'))) ;
205 $right = new PluginSpecificRoleSetting ($role,
206 'plugin_mediawiki_upload') ;
207 $right->setDescription (_('Mediawiki file upload')) ;
208 $right->setValueDescriptions (array ('0' => _('No uploading'),
209 '1' => _('Upload permitted'),
210 '2' => _('Upload and re-upload'))) ;
212 $right = new PluginSpecificRoleSetting ($role,
213 'plugin_mediawiki_admin') ;
214 $right->setDescription (_('Mediawiki administrative tasks')) ;
215 $right->setValueDescriptions (array ('0' => _('No administrative access'),
216 '1' => _('Edit interface, import XML dumps'))) ;
217 } elseif ($hookname == "role_get_setting") {
218 $role = $params['role'] ;
219 $reference = $params['reference'] ;
220 $value = $params['value'] ;
222 switch ($params['section']) {
223 case 'plugin_mediawiki_read':
224 if ($role->hasPermission('project_admin', $reference)) {
225 $params['result'] = 1 ;
227 $params['result'] = $value ;
230 case 'plugin_mediawiki_edit':
231 if ($role->hasPermission('project_admin', $reference)) {
232 $params['result'] = 3 ;
234 $params['result'] = $value ;
237 case 'plugin_mediawiki_upload':
238 if ($role->hasPermission('project_admin', $reference)) {
239 $params['result'] = 2 ;
241 $params['result'] = $value ;
244 case 'plugin_mediawiki_admin':
245 if ($role->hasPermission('project_admin', $reference)) {
246 $params['result'] = 1 ;
248 $params['result'] = $value ;
252 } elseif ($hookname == "role_has_permission") {
253 $value = $params['value'];
254 switch ($params['section']) {
255 case 'plugin_mediawiki_read':
256 switch ($params['action']) {
259 $params['result'] |= ($value >= 1) ;
263 case 'plugin_mediawiki_edit':
264 switch ($params['action']) {
266 $params['result'] |= ($value >= 1) ;
269 $params['result'] |= ($value >= 2) ;
272 $params['result'] |= ($value >= 3) ;
276 case 'plugin_mediawiki_upload':
277 switch ($params['action']) {
279 $params['result'] |= ($value >= 1) ;
282 $params['result'] |= ($value >= 2) ;
286 case 'plugin_mediawiki_admin':
287 switch ($params['action']) {
290 $params['result'] |= ($value >= 1) ;
295 } elseif ($hookname == "list_roles_by_permission") {
296 switch ($params['section']) {
297 case 'plugin_mediawiki_read':
298 switch ($params['action']) {
301 $params['qpa'] = db_construct_qpa ($params['qpa'], ' AND perm_val >= 1') ;
305 case 'plugin_mediawiki_edit':
306 switch ($params['action']) {
308 $params['qpa'] = db_construct_qpa ($params['qpa'], ' AND perm_val >= 1') ;
311 $params['qpa'] = db_construct_qpa ($params['qpa'], ' AND perm_val >= 2') ;
314 $params['qpa'] = db_construct_qpa ($params['qpa'], ' AND perm_val >= 3') ;
318 case 'plugin_mediawiki_upload':
319 switch ($params['action']) {
321 $params['qpa'] = db_construct_qpa ($params['qpa'], ' AND perm_val >= 1') ;
324 $params['qpa'] = db_construct_qpa ($params['qpa'], ' AND perm_val >= 2') ;
328 case 'plugin_mediawiki_admin':
329 switch ($params['action']) {
332 $params['qpa'] = db_construct_qpa ($params['qpa'], ' AND perm_val >= 1') ;
337 } else if ($hookname == "project_admin_plugins") {
338 $group_id = $params['group_id'];
339 $group = group_get_object($group_id);
340 if ($group->usesPlugin($this->name))
342 "/plugins/mediawiki/plugin_admin.php?group_id=" .
343 $group->getID(), _("MediaWiki Plugin admin")) .
345 } elseif ($hookname == "clone_project_from_template") {
346 $template = $params['template'] ;
347 $project = $params['project'] ;
348 $id_mappings = $params['id_mappings'] ;
350 $sections = array ('plugin_mediawiki_read', 'plugin_mediawiki_edit', 'plugin_mediawiki_upload', 'plugin_mediawiki_admin') ;
352 foreach ($template->getRoles() as $oldrole) {
353 $newrole = RBACEngine::getInstance()->getRoleById ($id_mappings['role'][$oldrole->getID()]) ;
354 $oldsettings = $oldrole->getSettingsForProject ($template) ;
356 foreach ($sections as $section) {
357 if (isset ($oldsettings[$section][$template->getID()])) {
358 $newrole->setSetting ($section, $project->getID(), $oldsettings[$section][$template->getID()]) ;
368 // c-file-style: "bsd"