4 * Copyright 2002,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 * Usage: <<WikiAdminPurge>>
27 require_once 'lib/PageList.php';
28 require_once 'lib/plugin/WikiAdminSelect.php';
30 class WikiPlugin_WikiAdminPurge
31 extends WikiPlugin_WikiAdminSelect
34 return _("WikiAdminPurge");
37 function getDescription() {
38 return _("Permanently purge all selected pages.");
41 /* getDefaultArguments() is inherited from WikiAdminSelect class */
43 function collectPages(&$list, &$dbi, $sortby, $limit=0) {
45 $allPages = $dbi->getAllPages('include_empty',$sortby,$limit);
46 while ($pagehandle = $allPages->next()) {
47 $pagename = $pagehandle->getName();
48 $current = $pagehandle->getCurrentRevision();
49 if ($current->getVersion() < 1) {
50 continue; // No versions in database
52 if (empty($list[$pagename])) {
53 $list[$pagename] = false;
59 function purgePages(&$request, $pages) {
60 $result = HTML::div();
62 $dbi = $request->getDbh(); $count = 0;
63 foreach ($pages as $name) {
64 $name = str_replace(array('%5B','%5D'),array('[',']'),$name);
65 if (mayAccessPage('purge',$name)) {
66 $dbi->purgePage($name);
67 $ul->pushContent(HTML::li(fmt("Purged page '%s' successfully.", $name)));
70 $ul->pushContent(HTML::li(fmt("Didn't purge page '%s'. Access denied.", $name)));
75 $result->setAttr('class', 'feedback');
77 $result->pushContent(HTML::p(_("One page has been permanently purged:")));
79 $result->pushContent(HTML::p(fmt("%d pages have been permanently purged:", $count)));
81 $result->pushContent($ul);
84 $result->setAttr('class', 'error');
85 $result->pushContent(HTML::p(_("No pages purged.")));
90 function run($dbi, $argstr, &$request, $basepage) {
91 if ($request->getArg('action') != 'browse') {
92 if ($request->getArg('action') != _("PhpWikiAdministration/Purge")) {
93 return $this->disabled(_("Plugin not run: not in browse mode"));
97 $args = $this->getArgs($argstr, $request);
98 $this->_args =& $args;
99 $this->preSelectS($args, $request);
101 $p = $request->getArg('p');
102 if (!$p) $p = $this->_list;
103 $post_args = $request->getArg('admin_purge');
105 $next_action = 'select';
107 if ($p && $request->isPost() &&
108 !empty($post_args['purge']) && empty($post_args['cancel'])) {
110 // check individual PagePermissions
111 if (!ENABLE_PAGEPERM and !$request->_user->isAdmin()) {
112 $request->_notAuthorized(WIKIAUTH_ADMIN);
113 $this->disabled("! user->isAdmin");
115 if ($post_args['action'] == 'verify') {
117 return $this->purgePages($request, array_keys($p));
120 if ($post_args['action'] == 'select') {
121 $next_action = 'verify';
122 foreach ($p as $name => $c) {
123 $name = str_replace(array('%5B','%5D'),array('[',']'),$name);
127 } elseif ($p && is_array($p) && !$request->isPost()) { // from WikiAdminSelect
128 $next_action = 'verify';
129 foreach ($p as $name => $c) {
130 $name = str_replace(array('%5B','%5D'),array('[',']'),$name);
133 $request->setArg('p',false);
135 if ($next_action == 'select') {
136 // List all pages to select from.
137 $pages = $this->collectPages($pages, $dbi, $args['sortby'], $args['limit'], $args['exclude']);
139 $pagelist = new PageList_Selectable($args['info'], $args['exclude'], array());
140 $pagelist->addPageList($pages);
142 $header = HTML::fieldset();
143 if ($next_action == 'verify') {
144 $button_label = _("Yes");
145 $header->pushContent(HTML::legend(_("Confirm purge")));
146 $header->pushContent(HTML::p(HTML::strong(
147 _("Are you sure you want to permanently purge the following files?"))));
150 $button_label = _("Permanently purge selected pages");
151 $header->pushContent(HTML::legend(_("Select the files to purge")));
154 $buttons = HTML::p(Button('submit:admin_purge[purge]', $button_label, 'wikiadmin'),
155 Button('submit:admin_purge[cancel]', _("Cancel"), 'button'));
156 $header->pushContent($buttons);
158 // TODO: quick select by regex javascript?
159 return HTML::form(array('action' => $request->getPostURL(),
162 $pagelist->getContent(),
163 HiddenInputs($request->getArgs(),
165 array('admin_purge')),
166 HiddenInputs(array('admin_purge[action]' => $next_action,
167 'require_authority_for_post' => WIKIAUTH_ADMIN)));
175 // c-hanging-comment-ender-p: nil
176 // indent-tabs-mode: nil