4 * Copyright 2004 $ThePhpWikiProgrammingTeam
5 * Copyright 2009 Marc-Etienne Vargenau, Alcatel-Lucent
7 * This file is part of PhpWiki.
9 * PhpWiki 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 * PhpWiki 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 PhpWiki; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
25 * Set individual PagePermissions
27 * Usage: <<WikiAdminSetAcl >> or called via WikiAdminSelect
28 * Author: Reini Urban <rurban@x-ray.at>
30 * TODO: UI to add custom group/username.
31 * Currently it's easier to dump a page, fix it manually and
32 * import it, than use Setacl
34 require_once 'lib/PageList.php';
35 require_once 'lib/plugin/WikiAdminSelect.php';
37 class WikiPlugin_WikiAdminSetAcl
38 extends WikiPlugin_WikiAdminSelect
41 return _("WikiAdminSetAcl");
44 function getDescription() {
45 return _("Set individual page permissions.");
48 function getDefaultArguments() {
51 WikiPlugin_WikiAdminSelect::getDefaultArguments(),
53 'p' => "[]", // list of pages
54 /* Columns to include in listing */
55 'info' => 'pagename,perm,mtime,owner,author',
59 function setaclPages(&$request, $pages, $acl) {
60 $result = HTML::div();
62 $dbi =& $request->_dbi;
63 // check new_group and new_perm
64 if (isset($acl['_add_group'])) {
65 //add groups with perm
66 foreach ($acl['_add_group'] as $access => $dummy) {
67 $group = $acl['_new_group'][$access];
68 $acl[$access][$group] = isset($acl['_new_perm'][$access]) ? 1 : 0;
70 unset($acl['_add_group']);
72 unset($acl['_new_group']); unset($acl['_new_perm']);
73 if (isset($acl['_del_group'])) {
74 //del groups with perm
75 foreach ($acl['_del_group'] as $access => $del) {
76 while (list($group,$dummy) = each($del))
77 unset($acl[$access][$group]);
79 unset($acl['_del_group']);
81 if ($perm = new PagePermission($acl)) {
83 foreach ($pages as $pagename) {
84 // check if unchanged? we need a deep array_equal
85 $page = $dbi->getPage($pagename);
86 $oldperm = getPagePermissions($page);
89 if ($oldperm and $perm->equal($oldperm->perm)) {
90 $result->setAttr('class', 'error');
91 $result->pushContent(HTML::p(fmt("ACL not changed for page '%s'.",$pagename)));
92 } elseif (mayAccessPage('change', $pagename)) {
93 setPagePermissions ($page, $perm);
94 $result->setAttr('class', 'feedback');
95 $result->pushContent(HTML::p(fmt("ACL changed for page '%s'",
97 $result->pushContent(HTML::p(fmt("from '%s'",
98 $oldperm ? $oldperm->asAclLines() : "None")));
99 $result->pushContent(HTML::p(fmt("to '%s'.",
100 $perm->asAclLines())));
102 // Create new revision so that ACL change appears in history.
103 $current = $page->getCurrentRevision();
104 $version = $current->getVersion();
105 $meta = $current->_data;
106 $text = $current->getPackedContent();
107 $meta['summary'] = sprintf(_("ACL changed for page '%s' from '%s' to '%s'."),
109 $oldperm ? $oldperm->asAclLines() : "None",
110 $perm->asAclLines());
111 $meta['is_minor_edit'] = 1;
112 $meta['author'] = $request->_user->UserName();
113 unset($meta['mtime']); // force new date
114 $page->save($text, $version + 1, $meta);
118 $result->setAttr('class', 'error');
119 $result->pushContent(HTML::p(fmt("Access denied to change page '%s'.",$pagename)));
123 $result->pushContent(HTML::p(_("Invalid ACL")));
127 $result->setAttr('class', 'feedback');
129 $result->pushContent(HTML::p(fmt("%d pages have been changed.", $count)));
132 $result->setAttr('class', 'error');
133 $result->pushContent(HTML::p(_("No pages changed.")));
138 function run($dbi, $argstr, &$request, $basepage) {
139 if ($request->getArg('action') != 'browse') {
140 if ($request->getArg('action') != _("PhpWikiAdministration/SetAcl")) {
141 return $this->disabled(_("Plugin not run: not in browse mode"));
144 if (!ENABLE_PAGEPERM) {
145 return $this->disabled("ENABLE_PAGEPERM = false");
148 $args = $this->getArgs($argstr, $request);
149 $this->_args = $args;
150 $this->preSelectS($args, $request);
152 $p = $request->getArg('p');
153 $post_args = $request->getArg('admin_setacl');
154 $next_action = 'select';
156 if ($p && !$request->isPost())
158 elseif ($this->_list)
159 $pages = $this->_list;
160 $header = HTML::fieldset();
161 if ($p && $request->isPost() &&
162 !empty($post_args['acl']) && empty($post_args['cancel'])) {
163 // without individual PagePermissions:
164 if (!ENABLE_PAGEPERM and !$request->_user->isAdmin()) {
165 $request->_notAuthorized(WIKIAUTH_ADMIN);
166 $this->disabled("! user->isAdmin");
168 if ($post_args['action'] == 'verify') {
170 return $this->setaclPages($request, array_keys($p), $request->getArg('acl'));
172 if ($post_args['action'] == 'select') {
173 if (!empty($post_args['acl']))
174 $next_action = 'verify';
175 foreach ($p as $name => $c) {
180 if ($next_action == 'select' and empty($pages)) {
181 // List all pages to select from.
182 $pages = $this->collectPages($pages, $dbi, $args['sortby'], $args['limit'], $args['exclude']);
184 if ($next_action == 'verify') {
185 $args['info'] = "checkbox,pagename,perm,mtime,owner,author";
187 $pagelist = new PageList_Selectable($args['info'],
189 array('types' => array(
191 => new _PageList_Column_perm('perm', _("Permission")),
193 => new _PageList_Column_acl('acl', _("ACL")))));
195 $pagelist->addPageList($pages);
196 if ($next_action == 'verify') {
197 $button_label = _("Yes");
198 $header = $this->setaclForm($header, $post_args, $pages);
199 $header->pushContent(
200 HTML::p(HTML::strong(
201 _("Are you sure you want to permanently change access rights to the selected files?"))));
204 $button_label = _("Change Access Rights");
205 $header = $this->setaclForm($header, $post_args, $pages);
206 $header->pushContent(HTML::legend(_("Select the pages where to change access rights")));
209 $buttons = HTML::p(Button('submit:admin_setacl[acl]', $button_label, 'wikiadmin'),
210 Button('submit:admin_setacl[cancel]', _("Cancel"), 'button'));
211 $header->pushContent($buttons);
213 return HTML::form(array('action' => $request->getPostURL(),
216 $pagelist->getContent(),
217 HiddenInputs($request->getArgs(),
219 array('admin_setacl')),
220 HiddenInputs(array('admin_setacl[action]' => $next_action)),
223 : HiddenInputs(array('require_authority_for_post' => WIKIAUTH_ADMIN)));
226 function setaclForm(&$header, $post_args, $pagehash) {
227 $acl = $post_args['acl'];
229 //FIXME: find intersection of all pages perms, not just from the last pagename
231 foreach ($pagehash as $name => $checked) {
232 if ($checked) $pages[] = $name;
234 $perm_tree = pagePermissions($name);
235 $table = pagePermissionsAclFormat($perm_tree, !empty($pages));
236 $header->pushContent(HTML::strong(_("Selected Pages: ")), HTML::tt(join(', ',$pages)), HTML::br());
237 $first_page = $GLOBALS['request']->_dbi->getPage($name);
238 $owner = $first_page->getOwner();
239 list($type, $perm) = pagePermissionsAcl($perm_tree[0], $perm_tree);
240 //if (DEBUG) $header->pushContent(HTML::pre("Permission tree for $name:\n",print_r($perm_tree,true)));
241 if ($type == 'inherited')
242 $type = sprintf(_("page permission inherited from %s"), $perm_tree[1][0]);
243 elseif ($type == 'page')
244 $type = _("individual page permission");
245 elseif ($type == 'default')
246 $type = _("default page permission");
247 $header->pushContent(HTML::strong(_("Type")._(": ")), HTML::tt($type),HTML::br());
248 $header->pushContent(HTML::strong(_("ACL")._(": ")), HTML::tt($perm->asAclLines()),HTML::br());
250 $header->pushContent(HTML::p(HTML::strong(_("Description")._(": ")),
251 _("Selected Grant checkboxes allow access, unselected checkboxes deny access."),
252 _("To ignore delete the line."),
253 _("To add check 'Add' near the dropdown list.")
255 $header->pushContent($table);
257 // display array of checkboxes for existing perms
258 // and a dropdown for user/group to add perms.
259 // disabled if inherited,
260 // checkbox to disable inheritance,
261 // another checkbox to progate new permissions to all childs (if there exist some)
263 // warn if more pages are selected and they have different perms
264 //$header->pushContent(HTML::input(array('name' => 'admin_setacl[acl]',
265 // 'value' => $post_args['acl'])));
266 $header->pushContent(HTML::br());
267 if (!empty($pages) and defined('EXPERIMENTAL') and EXPERIMENTAL) {
268 $checkbox = HTML::input(array('type' => 'checkbox',
269 'name' => 'admin_setacl[updatechildren]',
271 if (!empty($post_args['updatechildren'])) $checkbox->setAttr('checked','checked');
272 $header->pushContent($checkbox,
273 _("Propagate new permissions to all subpages?"),
274 HTML::raw(" "),
275 HTML::em(_("(disable individual page permissions, enable inheritance)?")),
276 HTML::br(),HTML::em(_("(Currently not working)"))
279 $header->pushContent(HTML::hr());
288 // c-hanging-comment-ender-p: nil
289 // indent-tabs-mode: nil