dokuwiki-plugin-userhomepage/action.php

<?php
/**
 * Userhomepage plugin main file
 * Previous authors: James GuanFeng Lin, Mikhail I. Izmestev, Daniel Stonier
 * @author: Simon Delage <simon.geekitude@gmail.com>
 * @license: CC Attribution-Share Alike 3.0 Unported <http://creativecommons.org/licenses/by-sa/3.0/>
 */

// 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_PLUGIN . '/acl/admin.php');

class action_plugin_userhomepage extends DokuWiki_Action_Plugin{

    function register(&$controller) {
        $controller->register_hook('DOKUWIKI_STARTED', 'AFTER', $this, 'init',array());
        $controller->register_hook('ACTION_ACT_PREPROCESS', 'BEFORE', $this, 'redirect',array());
        $controller->register_hook('ACTION_ACT_PREPROCESS', 'AFTER', $this, 'acl',array());
    }

    function init(&$event, $param) {
        global $conf;
        // CREATE PRIVATE NAMESPACE START PAGE TEMPLATES IF NEEDED
        if (($this->getConf('create_private_ns')) && (!is_file(DOKU_CONF.'../'.$this->getConf('templates_path').'/userhomepage_private.txt')) && ($_SERVER['REMOTE_USER'] != null)) {
            // If old template exists, use it as source to create userhomepage_private.txt in templates_path
            if ((is_file(DOKU_INC.$this->getConf('templatepath'))) && ($this->getConf('templatepath') != null)) {
                $source = $this->getConf('templatepath');
            } else {
                $source = 'lib/plugins/userhomepage/lang/'.$conf['lang'].'/userhomepage_private.default';
            }
            $this->copyFile($source, $this->getConf('templates_path'), 'userhomepage_private.txt');
        }
        // CREATE PUBLIC PAGE TEMPLATES IF NEEDED
        if (($this->getConf('create_public_page')) && (!is_file(DOKU_CONF.'../'.$this->getConf('templates_path').'/userhomepage_public.txt')) && ($_SERVER['REMOTE_USER'] != null)) {
            $source = 'lib/plugins/userhomepage/lang/'.$conf['lang'].'/userhomepage_public.default';
            $this->copyFile($source, $this->getConf('templates_path'), 'userhomepage_public.txt');
        }
        // TARGETS
        if ($this->getConf('group_by_name')) {
            // private:s:simon or private:s:simon_delage
            $this->private_ns = cleanID($this->getConf('users_namespace').':'.substr($this->privateNamespace(), 0, 1).':'. $this->privateNamespace());
        } else {
            // private:simon or private:simon_delage
            $this->private_ns = cleanID($this->getConf('users_namespace').':'. $this->privateNamespace());
        }
        // ...:start.txt or ...:simon_delage.txt
        $this->private_page = $this->private_ns . ':' . $this->privateStart();
        // user:simon.txt
        $this->public_page = cleanID($this->getConf('public_pages_ns').':'. $_SERVER['REMOTE_USER']);
        // If a user is logged in, store timestamp (if it wasn't stored yet)
        if (($_SERVER['REMOTE_USER']!=null) && (!isset($_SESSION['uhptimestamp']))) {
            $_SESSION['uhptimestamp'] = time();
        // If no user is logged in and a timestamp exists, set timestamp to null (ensures that redirection will work if user just logged out and comes back before closing browser)
        } elseif (($_SERVER['REMOTE_USER']==null) && (isset($_SESSION['uhptimestamp']))) {
            $_SESSION['uhptimestamp'] = null;
        }
    }

    function redirect(&$event, $param) {
        global $conf;
        global $lang;
        $created = array();
        // If a user is logged in and not allready requesting his private namespace start page
        if (($_SERVER['REMOTE_USER']!=null)&&($_REQUEST['id']!=$this->private_page)) {
            // if private page doesn't exists, create it (from template)
            if ($this->getConf('create_private_ns') && !page_exists($this->private_page) && !checklock($this->private_page) && !checkwordblock()) {
                // Target private start page template
                $this->private_page_template = DOKU_CONF.'../'.$this->getConf('templates_path').'/userhomepage_private.txt';
                // Create private page
                lock($this->private_page);
                saveWikiText($this->private_page,$this->applyTemplate('private'),'Automatically created');
                unlock($this->private_page);
                // Announce private namespace was created
                msg($this->getLang('createdprivatens').' ('.$this->private_page.')', 0);
                // Note that we created private page
                $created['private'] = page_exists($this->private_page);
            }
            // Public page?
            // If public page doesn't exists, create it (from template)
            if ($this->getConf('create_public_page') && !page_exists($this->public_page) && !checklock($this->public_page) && !checkwordblock()) {
                // Target public page template
                $this->public_page_template = DOKU_CONF.'../'.$this->getConf('templates_path').'/userhomepage_public.txt';
                // Create public page
                lock($this->public_page);
                saveWikiText($this->public_page,$this->applyTemplate('public'),'Automatically created');
                unlock($this->public_page);
                // Announce plubic page was created
                msg($this->getLang('createdpublicpage').' ('.$this->public_page.')', 0);
                // Note that we created public page
                $created['public'] = page_exists($this->public_page);
            }
            // List IDs that can match wiki start
            $wikistart = array($conf['start'], ':'.$conf['start']);
            // If Translation plugin is active, wiki start page can also be '??:start'
            if (!plugin_isdisabled('translation')) {
                // For each language in Translation settings
                foreach (explode(' ',$conf['plugin']['translation']['translations']) as $language){
                    array_push($wikistart, $language.':'.$conf['start'], ':'.$language.':'.$conf['start']);
                }
            }
            // If Public page was just created, redirect to it and edit
            if ($created['public']) {
                send_redirect(wl($this->public_page, 'do=edit', false, '&'));
            // Else if private start page was just created and edit option is set, redirect to it and edit
            } elseif (($created['private']) && ($this->getConf('edit_before_create'))) {
                send_redirect(wl($this->private_page, 'do=edit', false, '&'));
            // Else if user's private page exists AND [(user isn't requesting a specific page OR he's requesting wiki start page) AND logged in 2sec ago max]
            } elseif ((page_exists($this->private_page)) && (((!isset($_GET['id'])) or (in_array($_GET['id'], $wikistart))) && (time()-$_SESSION["uhptimestamp"] <= 2))) {
                send_redirect(wl($this->private_page));
            }
        }
    }

    function acl(&$event, $param) {
        global $conf;
        if (!$this->getConf('no_acl')) {
            // ACL
            $acl = new admin_plugin_acl();
            // On private namespace
            if ($this->getConf('create_private_ns')) {
                // For known users
                // If use_name_string or group_by_name is enabled, we can't use ACL wildcards so let's create ACL for current user on his private ns
                if (($this->getConf('use_name_string')) or ($this->getConf('group_by_name'))) {
                    $ns = $this->private_ns.':*';
                    if ($_SERVER['REMOTE_USER'] != null) $acl->_acl_add($ns, strtolower($_SERVER['REMOTE_USER']), AUTH_DELETE);
                // Otherwise we can set ACL for all known users at once
                } else {
                    $acl->_acl_add(cleanID($this->getConf('users_namespace')).':%USER%:*', '%USER%', AUTH_DELETE);
                }
                // For @ALL
                if ($this->getConf('acl_all_private') != 'noacl') {
                    $acl->_acl_add(cleanID($this->getConf('users_namespace')).':*', '@ALL', (int)$this->getConf('acl_all_private'));
                }
                // For @user
                if (($this->getConf('acl_user_private') != 'noacl') && ($this->getConf('acl_user_private') !== $this->getConf('acl_all_private'))) {
                    $acl->_acl_add(cleanID($this->getConf('users_namespace')).':*', '@user', (int)$this->getConf('acl_user_private'));
                }
            } // end of private namespaces acl
            // On public user pages
            if ($this->getConf('create_public_page')) {
                // For known users
                $acl->_acl_add(cleanID($this->getConf('public_pages_ns')).':%USER%', '%USER%', AUTH_EDIT);
                // For others
                if ($this->getConf('acl_all_public') != 'noacl') {
                    // If both private and public namespaces are identical, we need to force rights for @ALL and/or @user on each public page
                    if ($this->getConf('users_namespace') == $this->getConf('public_pages_ns')) {
                        foreach (glob("data/pages/".$this->getConf('public_pages_ns')."/*.txt") as $filename) {
                            // ACL on templates will be managed another way
                            if (strpos($filename, 'userhomepage_p') == false) {
                                // @ALL
                                $acl->_acl_add($this->getConf('public_pages_ns').':'.explode('.', end(explode('/', $filename)))[0], '@ALL', $this->getConf('acl_all_public'));
                                // @user
                                if (($this->getConf('acl_user_public') != 'noacl') && ($this->getConf('acl_user_public') !== $this->getConf('acl_all_public'))) {
                                    $acl->_acl_add($this->getConf('public_pages_ns').':'.explode('.', end(explode('/', $filename)))[0], '@user', $this->getConf('acl_user_public'));
                                }
                            }
                        }
                    // Otherwise we just need to give the right permission to each group on public pages namespace
                    } else {
                        // @ALL
                        $acl->_acl_add(cleanID($this->getConf('public_pages_ns')).':*', '@ALL', $this->getConf('acl_all_public'));
                        // @user
                        if (($this->getConf('acl_user_public') != 'noacl') && ($this->getConf('acl_user_public') !== $this->getConf('acl_all_public'))) {
                            $acl->_acl_add(cleanID($this->getConf('public_pages_ns')).':*', '@user', $this->getConf('acl_user_public'));
                        }
                    }
                }
            } // end for public pages acl
            // On templates if they're in data/pages
            if (strpos($this->getConf('templates_path'),'data/pages') !== false) {
                // For @ALL
                if (($this->getConf('acl_all_templates') != 'noacl') && (($this->getConf('create_private_ns')) or ($this->getConf('create_public_page')))) {
                    $acl->_acl_add(end(explode('/',$this->getConf('templates_path'))).':userhomepage_private', '@ALL', (int)$this->getConf('acl_all_templates'));
                    $acl->_acl_add(end(explode('/',$this->getConf('templates_path'))).':userhomepage_public', '@ALL', (int)$this->getConf('acl_all_templates'));
                }
                // For @user
                if (($this->getConf('acl_user_templates') != 'noacl') && ($this->getConf('acl_user_templates') !== $this->getConf('acl_all_templates')) && (($this->getConf('create_private_ns')) or ($this->getConf('create_public_page')))) {
                    $acl->_acl_add(end(explode('/',$this->getConf('templates_path'))).':userhomepage_private', '@user', (int)$this->getConf('acl_user_templates'));
                    $acl->_acl_add(end(explode('/',$this->getConf('templates_path'))).':userhomepage_public', '@user', (int)$this->getConf('acl_user_templates'));
                }
            } // end of templates acl
            // Cleaning duplicated lines in acl
            $lines = file(DOKU_CONF.'acl.auth.php');
            // And only keep unique lines (OK, we loose an empty comment line...)
            $lines = array_unique($lines);
            // Write things back to conf/acl.auth.php
            file_put_contents(DOKU_CONF.'acl.auth.php', implode($lines));
        }
    }

    function copyFile($source = null, $target_dir = null, $target_file = null) {
        if(!@is_dir($target_dir)){
            io_mkdir_p($target_dir) || msg("Creating directory $target_dir failed",-1);
        }
        if (!copy(DOKU_INC.$source, DOKU_CONF.'../'.$target_dir.'/'.$target_file)) {
            msg($this->getLang('copyerror').' ('.$source.' > '.$target_dir.'/'.$target_file.')', -1);
        } else {
            msg($this->getLang('copysuccess').' ('.$source.' > '.$target_dir.'/'.$target_file.')', 1);
        }
    }

    function privateNamespace() {
        if ( $this->getConf('use_name_string')) {
            global $INFO;
            $raw_string = cleanID($INFO['userinfo']['name']);
            // simon_delage
            return $raw_string;
        } else {
            // simon
            return strtolower($_SERVER['REMOTE_USER']);
        }
    }

    function privateStart() {
        if ($this->getConf('use_start_page')) {
            global $conf;
            return cleanID($conf['start']);
        } else {
            return $this->privateNamespace();
        }
    }

    function applyTemplate($type) {
        if ($type == 'private') {
            $content = io_readFile($this->private_page_template, false);
        } elseif ($type == 'public') {
            $content = io_readFile($this->public_page_template, false);
        }
        $content = str_replace('@TARGETPRIVATEPAGE@', $this->private_page, $content);
        $content = str_replace('@TARGETPRIVATENS@', $this->private_ns, $content);
        $content = str_replace('@TARGETPUBLICPAGE@', $this->public_page, $content);
        $content = str_replace('@TARGETPUBLICNS@', cleanID($this->getConf('public_pages_ns')), $content);
        // Improved template process to use standard replacement patterns from https://www.dokuwiki.org/namespace_templates based on code proposed by Christian Nancy
        // Build a fake data structure for the parser
        $data = array('tpl' => $content, 'id' => $this->private_page);
        // Use the built-in parser
        $content = parsePageTemplate($data);
        return $content;
    }

}