action.php

<?php
/**
 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
 * @author     Danny Lin <danny.0838@gmail.com>
 */

// must be run within Dokuwiki
if(!defined('DOKU_INC')) die();
if (!defined('DOKU_PLUGIN')) define('DOKU_PLUGIN', DOKU_INC . 'lib/plugins/');
require_once (DOKU_PLUGIN . 'action.php');
require_once(DOKU_INC.'inc/fulltext.php');

class action_plugin_editx extends DokuWiki_Action_Plugin {

    /**
     * register the eventhandlers
     */
    function register(Doku_Event_Handler $contr) {
        $contr->register_hook('TPL_ACT_RENDER', 'AFTER', $this, '_append_to_edit', array());
        $contr->register_hook('ACTION_ACT_PREPROCESS', 'BEFORE', $this, '_handle_act', array());
        $contr->register_hook('TPL_ACT_UNKNOWN', 'BEFORE', $this, '_handle_tpl_act', array());
    }

    /**
     * main hooks
     */ 
    function _append_to_edit(&$event, $param) {
        global $ID;
        if ($event->data != 'edit') return;
        if (!$this->_auth_check_all($ID)) return;
        $link = sprintf('<a href="%s" class="action editx" rel="nofollow">%s</a>', wl($ID,'do=editx'), $this->getLang('pagemanagement'));
        $intro = $this->locale_xhtml('intro');
        $intro = str_replace( '@LINK@', $link, $intro );
        print $intro;
    }

    function _handle_act(&$event, $param) {
        if($event->data != 'editx') return;
        $event->preventDefault();
    }

    function _handle_tpl_act(&$event, $param) {
        if($event->data != 'editx') return;
        $event->preventDefault();

        switch ($_REQUEST['work']) {
            case 'rename':
                $opts['oldpage'] = cleanID($_REQUEST['oldpage']);
                $opts['newpage'] = cleanID($_REQUEST['newpage']);
                $opts['summary'] = $_REQUEST['summary'];
                $opts['rp_nr'] = $_REQUEST['rp_nr'];
                $opts['confirm'] = $_REQUEST['rp_confirm'];
                $this->_rename_page($opts);
                break;
            case 'delete':
                $opts['oldpage'] = cleanID($_REQUEST['oldpage']);
                $opts['summary'] = $_REQUEST['summary'];
                $opts['purge'] = $_REQUEST['dp_purge'];
                $opts['confirm'] = $_REQUEST['dp_confirm'];
                $this->_delete_page($opts);
                break;
            default:
                $this->_print_form();
                break;
        }
    }

    /**
     * helper functions
     */
    function _auth_check_list($list) {
        global $conf;
        global $USERINFO;

        if(!$conf['useacl']) return true; //no ACL - then no checks

        $allowed = explode(',',$list);
        $allowed = array_map('trim', $allowed);
        $allowed = array_unique($allowed);
        $allowed = array_filter($allowed);

        if(!count($allowed)) return true; //no restrictions

        $user   = $_SERVER['REMOTE_USER'];
        $groups = (array) $USERINFO['grps'];

        if(in_array($user,$allowed)) return true; //user explicitly mentioned

        //check group memberships
        foreach($groups as $group){
            if(in_array('@'.$group,$allowed)) return true;
        }

        //still here? no access!
        return false;
    }
    
    function _auth_check_all($id) {
        return $this->_auth_can_rename($id) ||
            $this->_auth_can_delete($id);
    }
    
    function _auth_can_rename($id) {
        static $cache = null;
        if (!$cache[$id]) {
            $cache[$id] = auth_quickaclcheck($id)>=AUTH_EDIT &&
                $this->_auth_check_list($this->getConf('user_rename'));
        }
        return $cache[$id];
    }

    function _auth_can_rename_nr($id) {
        static $cache = null;
        if (!$cache[$id]) {
            $cache[$id] = auth_quickaclcheck($id)>=AUTH_DELETE &&
                $this->_auth_check_list($this->getConf('user_rename_nr'));
        }
        return $cache[$id];
    }

    function _auth_can_delete($id) {
        static $cache = null;
        if (!$cache[$id]) {
            $cache[$id] = auth_quickaclcheck($id)>=AUTH_DELETE &&
                $this->_auth_check_list($this->getConf('user_delete'));
        }
        return $cache[$id];
    }

    function _locate_filepairs(&$opts, $dir, $regex ){
        global $conf;
        $oldpath = $conf[$dir].'/'.str_replace(':','/',$opts['oldns']);
        $newpath = $conf[$dir].'/'.str_replace(':','/',$opts['newns']);
        if (!$opts['oldfiles']) $opts['oldfiles'] = array();
        if (!$opts['newfiles']) $opts['newfiles'] = array();
        $dh = @opendir($oldpath);
        if($dh) {
            while(($file = readdir($dh)) !== false){
                if ($file{0}=='.') continue;
                $oldfile = $oldpath.$file;
                if (is_file($oldfile) && preg_match($regex,$file)){
                    $opts['oldfiles'][] = $oldfile;
                    if ($opts['move']) {
                        $newfilebase = str_replace($opts['oldname'], $opts['newname'], $file);
                        $newfile = $newpath.$newfilebase;
                        if (@file_exists($newfile)) {
                            $this->errors[] = sprintf( $this->getLang('rp_msg_file_conflict'), '<a href="'. wl($opts['newpage']) . '">'.$opts['newpage'].'</a>', $newfilebase );
                            return false;
                        }
                        $opts['newfiles'][] = $newfile;
                    }
                }
            }
            closedir($dh);
            return true;
        }
        return false;
    }

    function _apply_moves(&$opts) {
        foreach ($opts['oldfiles'] as $i => $oldfile) {
            $newfile = $opts['newfiles'][$i];
            $newdir = dirname($newfile);
            if (!io_mkdir_p($newdir)) continue;
            io_rename($oldfile, $newfile);
        }
    }

    function _apply_deletes(&$opts) {
        foreach ($opts['oldfiles'] as $oldfile) {
            unlink($oldfile);
        }
    }

    function _FN($id) {
        $id = str_replace(':','/',$id);
        $id = utf8_encodeFN($id);
        return $id;
    }

    function _custom_delete_page($id, $summary) {
        global $ID, $INFO, $conf;
        // mark as nonexist to prevent indexerWebBug
        if ($id==$ID) $INFO['exists'] = 0;
        // delete page, meta and attic
        $file = wikiFN($id);
        $old = @filemtime($file); // from page
        if (file_exists($file)) unlink($file);
        $opts['oldname'] = $this->_FN(noNS($id));
        $opts['oldns'] = $this->_FN(getNS($id));
        if ($opts['oldns']) $opts['oldns'] .= '/';
        $this->_locate_filepairs( $opts, 'metadir', '/^'.$opts['oldname'].'\.(?!mlist)\w*?$/' );
        $this->_locate_filepairs( $opts, 'olddir', '/^'.$opts['oldname'].'\.\d{10}\.txt(\.gz|\.bz2)?$/' );
        $this->_apply_deletes($opts);
        io_sweepNS($id, 'datadir');
        io_sweepNS($id, 'metadir');
        io_sweepNS($id, 'olddir');
        // send notify mails
        notify($id,'admin',$old,$summary);
        notify($id,'subscribers',$old,$summary);
        // update the purgefile (timestamp of the last time anything within the wiki was changed)
        io_saveFile($conf['cachedir'].'/purgefile',time());
        // if useheading is enabled, purge the cache of all linking pages
        if(useHeading('content')){
            $pages = ft_backlinks($id);
            foreach ($pages as $page) {
                $cache = new cache_renderer($page, wikiFN($page), 'xhtml');
                $cache->removeCache();
            }
        }
    }

    /**
     * main functions
     */
    function _rename_page(&$opts) {
        // check confirmation
        if (!$opts['confirm']) {
            $this->errors[] = $this->getLang('rp_msg_unconfirmed');
        }
        // check old page
        if (!$opts['oldpage']) {
            $this->errors[] = $this->getLang('rp_msg_old_empty');
        } else if (!page_exists($opts['oldpage'])) {
            $this->errors[] = sprintf( $this->getLang('rp_msg_old_noexist'), $opts['oldpage'] );
        } else if (!$this->_auth_can_rename($opts['oldpage'])) {
            $this->errors[] = sprintf( $this->getLang('rp_msg_auth'), $opts['oldpage'] );
        } else if (checklock($opts['oldpage'])) {
            $this->errors[] = sprintf( $this->getLang('rp_msg_locked'), $opts['oldpage'] );
        }
        // check noredirect
        if ($opts['rp_nr'] && !$this->_auth_can_rename_nr($opts['oldpage']))
            $this->errors[] = $this->getLang('rp_msg_auth_nr');
        // check new page
        if (!$opts['newpage']) {
            $this->errors[] = $this->getLang('rp_msg_new_empty');
        } else if (page_exists($opts['newpage'])) {
            $this->errors[] = sprintf( $this->getLang('rp_msg_new_exist'), '<a href="'. wl($opts['newpage']) . '">'.$opts['newpage'].'</a>' );
        } else if (!$this->_auth_can_rename($opts['newpage'])) {
            $this->errors[] = sprintf( $this->getLang('rp_msg_auth'), $opts['newpage'] );
        } else if (checklock($opts['newpage'])) {
            $this->errors[] = sprintf( $this->getLang('rp_msg_locked'), $opts['newpage'] );
        }
        // try to locate moves
        if (!$this->errors) {
            $opts['move'] = true;
            $opts['oldname'] = $this->_FN(noNS($opts['oldpage']));
            $opts['newname'] = $this->_FN(noNS($opts['newpage']));
            $opts['oldns'] = $this->_FN(getNS($opts['oldpage']));
            $opts['newns'] = $this->_FN(getNS($opts['newpage']));
            if ($opts['oldns']) $opts['oldns'] .= '/';
            if ($opts['newns']) $opts['newns'] .= '/';
            $this->_locate_filepairs( $opts, 'metadir', '/^'.$opts['oldname'].'\.(?!mlist|meta|indexed)\w*?$/' );
            $this->_locate_filepairs( $opts, 'olddir', '/^'.$opts['oldname'].'\.\d{10}\.txt(\.gz|\.bz2)?$/' );
        }
        // if no error do rename
        if (!$this->errors) {
            // move meta and attic
            $this->_apply_moves($opts);
            // save to newpage
            $text = rawWiki($opts['oldpage']);
            if ($opts['summary'])
                $summary = sprintf( $this->getLang('rp_newsummaryx'), $opts['oldpage'], $opts['newpage'], $opts['summary'] );
            else
                $summary = sprintf( $this->getLang('rp_newsummary'), $opts['oldpage'], $opts['newpage'] );
            saveWikiText($opts['newpage'],$text,$summary);
            // purge or recreate old page
            $summary = $opts['summary'] ?
                sprintf( $this->getLang('rp_oldsummaryx'), $opts['oldpage'], $opts['newpage'], $opts['summary'] ) :
                sprintf( $this->getLang('rp_oldsummary'), $opts['oldpage'], $opts['newpage'] );
            if ($opts['rp_nr']) {
                $this->_custom_delete_page( $opts['oldpage'], $summary );
                // write change log afterwards, or it would be deleted
                addLogEntry( null, $opts['oldpage'], DOKU_CHANGE_TYPE_DELETE, $summary ); // also writes to global changes
                unlink(metaFN($opts['oldpage'],'.changes')); // purge page changes
            }
            else {
                $text = $this->getConf('redirecttext');
                if (!$text) $text = $this->getLang('redirecttext');
                $text = str_replace( '@ID@', $opts['newpage'], $text );
                @unlink(wikiFN($opts['oldpage']));  // remove old page file so no additional history
                saveWikiText($opts['oldpage'],$text,$summary);
            }
        }
        // show messages
        if ($this->errors) {
            foreach ($this->errors as $error) msg( $error, -1 );
        }
        else {
            $msg = sprintf( $this->getLang('rp_msg_success'), $opts['oldpage'], '<a href="'. wl($opts['newpage']) . '">'.$opts['newpage'].'</a>' );
            msg( $msg, 1 );
        }
        // display form and table
        $data = array( rp_newpage => $opts['newpage'], rp_summary => $opts['summary'], rp_nr => $opts['rp_nr'] );
        $this->_print_form($data);
    }

    function _delete_page(&$opts) {
        // check confirm
        if (!$opts['confirm']) {
            $this->errors[] = $this->getLang('dp_msg_unconfirmed');
        }
        // check old page
        if (!$opts['oldpage']) {
            $this->errors[] = $this->getLang('dp_msg_old_empty');
        } else if (!$this->_auth_can_delete($opts['oldpage'])) {
            $this->errors[] = sprintf( $this->getLang('dp_msg_auth'), $opts['oldpage'] );
        }
        // if no error do delete
        if (!$this->errors) {
            $summary = $opts['summary'] ? 
                sprintf( $this->getLang('dp_oldsummaryx'), $opts['summary'] ) :
                $this->getLang('dp_oldsummary');
            $this->_custom_delete_page( $opts['oldpage'], $summary );
            // write change log afterwards, or it would be deleted
            addLogEntry( null, $opts['oldpage'], DOKU_CHANGE_TYPE_DELETE, $summary ); // also writes to global changes
            if ($opts['purge']) unlink(metaFN($opts['oldpage'],'.changes')); // purge page changes
        }
        // show messages
        if ($this->errors) {
            foreach ($this->errors as $error) msg( $error, -1 );
        }
        else {
            $msg = sprintf( $this->getLang('dp_msg_success'), $opts['oldpage'] );
            msg( $msg, 1 );
        }
        // display form and table
        $data = array( dp_purge => $opts['purge'], dp_summary => $opts['summary'] );
        $this->_print_form($data);
    }

    function _print_form($data=null) {
        global $ID, $lang;
        $chk = ' checked="checked"';
?>
<h1><?php echo sprintf( $this->getLang('title'), $ID); ?></h1>
<div id="config__manager">
<?php 
    if ($this->_auth_can_rename($ID)) {
?>
    <form action="<?php echo wl($ID); ?>" method="post">
    <fieldset>
    <legend><?php echo $this->getLang('rp_title'); ?></legend>
        <input type="hidden" name="do" value="editx" />
        <input type="hidden" name="work" value="rename" />
        <input type="hidden" name="oldpage" value="<?php echo $ID; ?>" />
        <table class="inline">
            <tr>
                <td class="label"><?php echo $this->getLang('rp_newpage'); ?></td>
                <td class="value"><input class="edit" type="input" name="newpage" value="<?php echo $data['rp_newpage']; ?>" /></td>
            </tr>
            <tr>
                <td class="label"><?php echo $this->getLang('rp_summary'); ?></td>
                <td class="value"><input class="edit" type="input" name="summary" value="<?php echo $data['rp_summary']; ?>" /></td>
            </tr>
<?php 
        if ($this->_auth_can_rename_nr($ID)) {
?>
            <tr>
                <td class="label"><?php echo $this->getLang('rp_nr'); ?></td>
                <td class="value"><input type="checkbox" name="rp_nr" value="1"<?php if ($data['rp_nr']) echo $chk; ?> /></td>
            </tr>
<?php
    }
?>
            <tr>
                <td class="label"><?php echo $this->getLang('rp_confirm'); ?></td>
                <td class="value"><input type="checkbox" name="rp_confirm" value="1" /></td>
            </tr>
        </table>
        <p>
            <input type="submit" class="button" value="<?php echo $lang['btn_save']; ?>" />
            <input type="reset" class="button" value="<?php echo $lang['btn_reset']; ?>" />
        </p>
    </fieldset>
    </form>
<?php
    }
    if ($this->_auth_can_delete($ID)) {
?>
    <form action="<?php echo wl($ID); ?>" method="post">
    <fieldset>
    <legend><?php echo $this->getLang('dp_title'); ?></legend>
        <input type="hidden" name="do" value="editx" />
        <input type="hidden" name="work" value="delete" />
        <input type="hidden" name="oldpage" value="<?php echo $ID; ?>" />
        <table class="inline">
            <tr>
                <td class="label"><?php echo $this->getLang('dp_summary'); ?></td>
                <td class="value"><input class="edit" type="input" name="summary" value="<?php echo $data['dp_summary']; ?>" /></td>
            </tr>
            <tr>
                <td class="label"><?php echo $this->getLang('dp_purge'); ?></td>
                <td class="value"><input type="checkbox" name="dp_purge" value="1"<?php if ($data['dp_purge']) echo $chk; ?> /></td>
            </tr>
            <tr>
                <td class="label"><?php echo $this->getLang('dp_confirm'); ?></td>
                <td class="value"><input type="checkbox" name="dp_confirm" value="1" /></td>
            </tr>
        </table>
        <p>
            <input type="submit" class="button" value="<?php echo $lang['btn_save']; ?>" />
            <input type="reset" class="button" value="<?php echo $lang['btn_reset']; ?>" />
        </p>
    </fieldset>
    </form>
<?php
    }
?>
</div>
<?php
    }
}
// vim:ts=4:sw=4:et:enc=utf-8: