mprins / dokuwiki-plugin-dokusioc

action.php

<?php
/**
 * DokuSIOC - SIOC plugin for DokuWiki
 *
 * version 0.1.2
 *
 * DokuSIOC integrates the SIOC ontology within DokuWiki and provides an
 * alternate RDF/XML views of the wiki documents.
 *
 * For DokuWiki we can't use the Triplify script because DokuWiki has not a RDBS
 * backend. But the wiki API provides enough methods to get the data out, so
 * DokuSIOC as a plugin uses the export hook to provide accessible data as
 * RDF/XML, using the SIOC ontology as vocabulary.
 *
 * METADATA
 *
 * @author    Michael Haschke @ eye48.com
 * @copyright 2009 Michael Haschke
 * @license   http://www.gnu.org/licenses/old-licenses/gpl-2.0.html GNU General Public License 2.0 (GPLv2)
 * @version   0.1.2
 *
 * WEBSITES
 *
 * @link      http://eye48.com/go/dokusioc Plugin Website and Overview
 * @link      http://github.com/haschek/DokuWiki-Plugin-DokuSIOC/issues Issue tracker
 *
 * LICENCE
 *
 * This program is free software: you can redistribute it and/or modify it under
 * the terms of the GNU General Public License as published by the Free Software
 * Foundation, version 2 of the License.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
 *
 * @link      http://www.gnu.org/licenses/old-licenses/gpl-2.0.html GNU General Public License 2.0 (GPLv2)
 *
 * CHANGELOG
 *
 * 0.1.2
 * - fix: meta link to post type is standard use now (issue 9)
 * - mod: titles for SIOC documents (issue 10)
 * - mod: use sioc:UserAccount instead of deprecated sioc:User (issue 2)
 * 0.1.1 (bugfix release)
 * - fix header output for content negotiation
 * - fix URIs for profile and SIOC ressource
 * - better dc:title for revisions
 * - add complete URI to rdf:about for foaf:Document (Profile) to make it explicit
 * - add rel="canonical" for URIs with type parameter, to prevent double content
 * 0.1
 * - exchange licence b/c CC-BY-SA was incompatible with GPL
 * - restructuring code base
 * - fix: wrong meta link for revisions
 * - add: possibility to send noindex by x-robots-tag via HTTP header
 * - add: soft check for requested application type
 * - mod: use search method to get container content on next sub level
 * - mod: better dc:title for foaf:document,
 * - mod: better distinction between user/container/post resources
 * - mod: normalize URIs
 * - fix: URIs for SIOC documents
 * - mod: use dcterms:created and sioc:has_creator only for first revision of wiki page b/c of inadequate meta data
 * - add: backlinks from wiki via dcterms:isReferencedBy
 * - add: contributors by sioc:has_modifier (only for last revision b/c of wrong meta data for older revisions)
 * - rem: foaf:person link in sioct:WikiArticle b/c it routes to same data like sioc:has_creater/modifier
 * - rem: Talis SIOC widget for comments b/c incompatibility with DokuWiki JS
 * poc
 * - proof of concept release under CC-BY-SA
 **/

class action_plugin_dokusioc extends DokuWiki_Action_Plugin
{

    private $agentlink = 'http://eye48.com/go/dokusioc?v=0.1.2';

    /* -- Methods to manage plugin ------------------------------------------ */

    /**
     * Register it's handlers with the DokuWiki's event controller
     */
    public function register(Doku_Event_Handler $controller): void
    {
        //print_r(headers_list()); die();
        // test the requested action
        $controller->register_hook('ACTION_ACT_PREPROCESS', 'BEFORE', $this, 'checkAction', $controller);
    }

    /* -- Event handlers ---------------------------------------------------- */

    public function checkAction($action, $controller)
    {
        global $INFO;
        //print_r($INFO); die();
        //print_r(headers_list()); die();

        if ($action->data === 'export_siocxml') {
            // give back rdf
            $this->exportSioc();
        } elseif (($action->data === 'show' || $action->data === 'index') && $INFO['perm'] && !defined(
                'DOKU_MEDIADETAIL'
            ) && ($INFO['exists'] || getDwUserInfo($INFO['id'], $this)) && !isHiddenPage($INFO['id'])) {

The function getDwUserInfo() has been deprecated: cleanup, use build-in function

            if ($this->isRdfXmlRequest()) {
                // forward to rdfxml document if requested
                // print_r(headers_list()); die();
                $location = $this->createRdfLink();
                if (function_exists('header_remove')) {
                    header_remove();
                }
                header('Location: ' . $location['href'], true, 303);
                exit();
            } else {
                // add meta link to html head
                $controller->register_hook('TPL_METAHEADER_OUTPUT', 'BEFORE', $this, 'createRdfLink');
            }
        }
        /*
        else
        {
            print_r(array($action->data, $INFO['perm'], defined('DOKU_MEDIADETAIL'), $INFO['exists'],
                    getDwUserInfo($INFO['id'],$this), isHiddenPage($INFO['id'])));
            die();
        }
        */
    }

    public function exportSioc()
    {
        global $ID, $INFO;

        if (isHiddenPage($ID)) {
            $this->exit("HTTP/1.0 404 Not Found");
        }

        $sioc_type = $this->getContenttype();

        // Test for valid types
        if (!(($sioc_type == 'post' && $INFO['exists']) || $sioc_type == 'user' || $sioc_type == 'container')) {
            $this->exit("HTTP/1.0 404 Not Found");
        }

        // Test for permission
        if (!$INFO['perm']) {
            // not enough rights to see the wiki page
            $this->exit("HTTP/1.0 401 Unauthorized");
        }

        // Forward to URI with explicit type attribut
        if (!isset($_GET['type'])) {
            header('Location:' . $_SERVER['REQUEST_URI'] . '&type=' . $sioc_type, true, 302);
        }

        // Include SIOC libs
        require_once(__DIR__ . DIRECTORY_SEPARATOR . 'lib' . DIRECTORY_SEPARATOR . 'sioc_inc.php');
        require_once(__DIR__ . DIRECTORY_SEPARATOR . 'lib' . DIRECTORY_SEPARATOR . 'sioc_dokuwiki.php');

        // Create exporter

        $rdf              = new SIOCExporter();
        $rdf->profile_url = normalizeUri(

The function normalizeUri() has been deprecated: cleanup, use build-in function

            getAbsUrl(

The function getAbsUrl() has been deprecated: cleanup, use build-in function

                exportlink(
                    $ID,
                    'siocxml',
                    array('type' => $sioc_type),
                    false,
                    '&'
                )
            )
        );
        $rdf->setURLParameters('type', 'id', 'page', false);

        // Create SIOC-RDF content

        switch ($sioc_type) {
            case 'container':
                $rdf = $this->exportContainercontent($rdf);
                break;

            case 'user':
                $rdf = $this->exportUsercontent($rdf);
                break;

            case 'post':
            default:
                $rdf = $this->exportPostcontent($rdf);
                break;
        }

        // export
        if ($this->getConf('noindx')) {
            header("X-Robots-Tag: noindex", true);
        }
        $rdf->export();

        //print_r(headers_list()); die();
        die();
    }

    private function exit($headermsg)
    {
        header($headermsg);
        die();
    }

    /* -- public class methods ---------------------------------------------- */

    private function getContenttype()
    {
        global $ID, $conf;

        // check for type if unknown
        if (!($_GET['type'] ?? "")) {
            $userinfo = getDwUserInfo($ID, $this);

The function getDwUserInfo() has been deprecated: cleanup, use build-in function

            if ($userinfo) {
                $type = 'user';
            } elseif (isset($_GET['do']) && $_GET['do'] == 'index') {
                $type = 'container';
            } else {
                $type = 'post';
            }
        } else {
            $type = $_GET['type'];
        }

        return $type;
    }

    private function exportContainercontent($exporter)
    {
        global $ID, $INFO, $conf;

        if ($ID == $conf['start']) {
            $title = $conf['title'];
        } elseif (isset($INFO['meta']['title'])) {
            $title = $INFO['meta']['title'];
        } else {
            $title = $ID;
        }

        $exporter->setParameters(
            'Container: ' . $title,
            getAbsUrl(),

The function getAbsUrl() has been deprecated: cleanup, use build-in function

            getAbsUrl() . 'doku.php?',

The function getAbsUrl() has been deprecated: cleanup, use build-in function

            'utf-8',
            $this->agentlink
        );

        // create container object
        $wikicontainer = new SIOCDokuWikiContainer(
            $ID, normalizeUri($exporter->siocURL('container', $ID))

The function normalizeUri() has been deprecated: cleanup, use build-in function

        );

        /* container is type=wiki */
        if ($ID == $conf['start']) {
            $wikicontainer->isWiki();
        }
        /* sioc:name              */
        if ($INFO['exists']) {
            $wikicontainer->addTitle($INFO['meta']['title']);
        }
        /* has_parent             */
        if ($INFO['namespace']) {
            $wikicontainer->addParent($INFO['namespace']);
        }

        // search next level entries (posts, sub containers) in container
        require_once(DOKU_INC . 'inc/search.php');
        $dir        = utf8_encodeFN(str_replace(':', '/', $ID));
        $entries    = array();
        $posts      = array();
        $containers = array();
        search($entries, $conf['datadir'], 'search_index', array('ns' => $ID), $dir);
        foreach ($entries as $entry) {
            if ($entry['type'] === 'f') {
                // wikisite
                $posts[] = $entry;
            } elseif ($entry['type'] === 'd') {
                // sub container
                $containers[] = $entry;
            }
        }

        // without sub content it can't be a container (so it does not exist as a container)
        if (count($posts) + count($containers) == 0) {
            $this->exit("HTTP/1.0 404 Not Found");
        }

        if (count($posts) > 0) {
            $wikicontainer->addArticles($posts);
        }
        if (count($containers) > 0) {
            $wikicontainer->addContainers($containers);
        }

        //print_r($containers);die();

        // add container to exporter
        $exporter->addObject($wikicontainer);

        return $exporter;
    }

    /* -- private helpers --------------------------------------------------- */

    private function exportUsercontent($exporter)
    {
        global $ID;

        // get user info
        $userinfo = getDwUserInfo($ID, $this);

The function getDwUserInfo() has been deprecated: cleanup, use build-in function

        // no userinfo means there is no user space or user does not exists
        if ($userinfo === false) {
            $this->exit("HTTP/1.0 404 Not Found");
        }

        $exporter->setParameters(
            'Account: ' . $userinfo['name'],
            getAbsUrl(),

The function getAbsUrl() has been deprecated: cleanup, use build-in function

            getAbsUrl() . 'doku.php?',

The function getAbsUrl() has been deprecated: cleanup, use build-in function

            'utf-8',
            $this->agentlink
        );
        // create user object
        //print_r($userinfo); die();
        // $id, $url, $userid, $name, $email
        $wikiuser = new SIOCDokuWikiUser(
            $ID, normalizeUri($exporter->siocURL('user', $ID)), $userinfo['user'], $userinfo['name'], $userinfo['mail']

The function normalizeUri() has been deprecated: cleanup, use build-in function

        );
        /* TODO: avatar (using Gravatar) */ /* TODO: creator_of */
        // add user to exporter
        $exporter->addObject($wikiuser);

        //print_r(headers_list());die();
        return $exporter;
    }

    private function exportPostcontent($exporter)
    {
        global $ID, $INFO, $REV, $conf;

        $exporter->setParameters(
            'Article: ' . $INFO['meta']['title'] . ($REV ? ' (rev ' . $REV . ')' : ''),
            $this->getDokuUrl(),
            $this->getDokuUrl() . 'doku.php?',
            'utf-8',
            $this->agentlink
        );

        // create user object
        // $id, $uri, $name, $email, $homepage='', $foaf_uri='', $role=false, $nick='', $sioc_url='', $foaf_url=''
        $dwuserpage_id = cleanID($this->getConf('userns')) . ($conf['useslash'] ? '/' : ':') . $INFO['editor'];
        /*
        if ($INFO['editor'] && $this->getConf('userns'))
            $pageuser = new SIOCUser($INFO['editor'],
                                        normalizeUri(getAbsUrl(exportlink($dwuserpage_id, 'siocxml',
                                            array('type'=>'user'), false, '&'))), // user page
                                        $INFO['meta']['contributor'][$INFO['editor']],
                                        getDwUserInfo($dwuserpage_id,$this,'mail'),
                                        '', // no homepage is saved for dokuwiki user
                                        '#'.$INFO['editor'], // local uri
                                        false, // no roles right now
                                        '', // no nick name is saved for dokuwiki user
                                        normalizeUri($exporter->siocURL('user', $dwuserpage_id))
                                    );
        */

        // create wiki page object
        $wikipage = new SIOCDokuWikiArticle(
            $ID, // id
            normalizeUri(

The function normalizeUri() has been deprecated: cleanup, use build-in function

                $exporter->siocURL(
                    'post',
                    $ID . ($REV ? $exporter->_urlseparator . 'rev' . $exporter->_urlequal . $REV : '')
                )
            ), // url
            $INFO['meta']['title'] . ($REV ? ' (rev ' . $REV . ')' : ''), // subject
            rawWiki($ID, $REV) // body (content)
        );
        /* encoded content   */
        $wikipage->addContentEncoded(p_cached_output(wikiFN($ID, $REV), 'xhtml'));
        /* created           */
        if (isset($INFO['meta']['date']['created'])) {
            $wikipage->addCreated(date('c', $INFO['meta']['date']['created']));
        }
        /* or modified       */
        if (isset($INFO['meta']['date']['modified'])) {
            $wikipage->addModified(date('c', $INFO['meta']['date']['modified']));
        }
        /* creator/modifier  */
        if ($INFO['editor'] && $this->getConf('userns')) {
            $wikipage->addCreator(array('foaf:maker' => '#' . $INFO['editor'], 'sioc:modifier' => $dwuserpage_id));
        }
        /* is creator        */
        if (isset($INFO['meta']['date']['created'])) {
            $wikipage->isCreator();
        }
        /* intern wiki links */
        $wikipage->addLinks($INFO['meta']['relation']['references']);

        // contributors - only for last revision b/c of wrong meta data for older revisions
        if (!$REV && $this->getConf('userns') && isset($INFO['meta']['contributor'])) {
            $cont_temp = array();
            $cont_ns   = $this->getConf('userns') . ($conf['useslash'] ? '/' : ':');
            foreach ($INFO['meta']['contributor'] as $cont_id => $cont_name) {
                $cont_temp[$cont_ns . $cont_id] = $cont_name;
            }
            $wikipage->addContributors($cont_temp);
        }

        // backlinks - only for last revision
        if (!$REV) {
            require_once(DOKU_INC . 'inc/fulltext.php');
            $backlinks = ft_backlinks($ID);
            if (count($backlinks) > 0) {
                $wikipage->addBacklinks($backlinks);
            }
        }

        // TODO: addLinksExtern

        /* previous and next revision */
        $changelog = new PageChangeLog($ID);
        $pagerevs  = $changelog->getRevisions(0, $conf['recent'] + 1);
        $prevrev   = false;
        $nextrev   = false;
        if (!$REV) {
            // latest revision, previous rev is on top in array
            $prevrev = 0;
        } else {
            // other revision
            $currentrev = array_search($REV, $pagerevs);
            if ($currentrev !== false) {
                $prevrev = $currentrev + 1;
                $nextrev = $currentrev - 1;
            }
        }
        if ($prevrev !== false && $prevrev > -1 && page_exists($ID, $pagerevs[$prevrev])) {
            /* previous revision*/
            $wikipage->addVersionPrevious($pagerevs[$prevrev]);
        }
        if ($nextrev !== false && $nextrev > -1 && page_exists($ID, $pagerevs[$nextrev])) {
            /* next revision*/
            $wikipage->addVersionNext($pagerevs[$nextrev]);
        }

        /* latest revision   */
        if ($REV) {
            $wikipage->addVersionLatest();
        }
        // TODO: topics
        /* has_container     */
        if ($INFO['namespace']) {
            $wikipage->addContainer($INFO['namespace']);
        }
        /* has_space         */
        if ($this->getConf('owners')) {
            $wikipage->addSite($this->getConf('owners'));
        }
        // TODO: dc:contributor / has_modifier
        // TODO: attachment (e.g. pictures in that dwns)

        // add wiki page to exporter
        $exporter->addObject($wikipage);
        //if ($INFO['editor'] && $this->getConf('userns')) $exporter->addObject($pageuser);

        return $exporter;
    }

    private function getDokuUrl($url = null)
    {
        return getAbsUrl($url);

The function getAbsUrl() has been deprecated: cleanup, use build-in function

    }

    public function isRdfXmlRequest(): bool
    {
        // get accepted types
        $http_accept = trim($_SERVER['HTTP_ACCEPT']);

        // save accepted types in array
        $accepted = explode(',', $http_accept);

        /*
        $debuginfo = implode(' // ', array(date('c',$_SERVER['REQUEST_TIME']), $_SERVER['HTTP_REFERER'],
        $_SERVER['REMOTE_ADDR'], $_SERVER['REMOTE_HOST'], $_SERVER['HTTP_USER_AGENT'], $_SERVER['HTTP_ACCEPT']));
        global $conf; //print_r($conf); die();
        //die($debuginfo);
        $debuglog = @fopen($conf['tmpdir'].DIRECTORY_SEPARATOR.'requests.log', 'ab');
        @fwrite($debuglog, $debuginfo."\n");
        @fclose($debuglog);
        @chmod($conf['tmpdir'].DIRECTORY_SEPARATOR.'requests.log', 0777);
        */

        // soft check, route to RDF when client requests it (don't check quality of request)

        if ($this->getConf('softck') && strpos($_SERVER['HTTP_ACCEPT'], 'application/rdf+xml') !== false) {
            return true;
        }

        if (count($accepted) > 0) {
            // hard check, only serve RDF if it is requested first or equal to first type

            // extract accepting ratio
            $test_accept = array();
            foreach ($accepted as $format) {
                $formatspec = explode(';', $format);
                $k          = trim($formatspec[0]);
                if (count($formatspec) === 2) {
                    $test_accept[$k] = trim($formatspec[1]);
                } else {
                    $test_accept[$k] = 'q=1.0';
                }
            }

            // sort by ratio
            arsort($test_accept);
            $accepted_order = array_keys($test_accept);

            if ($accepted_order[0] === 'application/rdf+xml' || (array_key_exists(
                        'application/rdf+xml',
                        $test_accept
                    ) && $test_accept['application/rdf+xml'] === 'q=1.0')) {
                return true;
            }
        }

        // print_r($accepted_order);print_r($test_accept);die();

        return false;
    }

    /**
     */
    public function createRdfLink($event = null, $param = null)
    {
        global $ID, $INFO, $conf;

        // Test for hidden pages

        if (isHiddenPage($ID)) {
            return false;
        }

        // Get type of SIOC content

        $sioc_type = $this->getContenttype();

        // Test for valid types

        if (!(($sioc_type === 'post' && $INFO['exists']) || $sioc_type === 'user' || $sioc_type === 'container')) {
            return false;
        }

        // Test for permission

        if (!$INFO['perm']) {
            // not enough rights to see the wiki page
            return false;
        }

        $userinfo = getDwUserInfo($ID, $this);

The function getDwUserInfo() has been deprecated: cleanup, use build-in function

        // Create attributes for meta link

        $metalink['type'] = 'application/rdf+xml';
        $metalink['rel']  = 'meta';

        switch ($sioc_type) {
            case 'container':
                $title     = htmlentities(
                    "Container '" . ($INFO['meta']['title'] ?? $ID) . "' (SIOC document as RDF/XML)"
                );
                $queryAttr = array('type' => 'container');
                break;

            case 'user':
                $title     = htmlentities("User account '" . $userinfo['name'] . "' (SIOC document as RDF/XML)");
                $queryAttr = array('type' => 'user');
                break;

            case 'post':
            default:
                $title     = htmlentities("Article '" . $INFO['meta']['title'] . "' (SIOC document as RDF/XML)");
                $queryAttr = array('type' => 'post');
                if (isset($_GET['rev']) && $_GET['rev'] === (int)$_GET['rev']) {
                    $queryAttr['rev'] = $_GET['rev'];
                }
                break;
        }

        $metalink['title'] = $title;
        $metalink['href']  = normalizeUri(getAbsUrl(exportlink($ID, 'siocxml', $queryAttr, false, '&')));

The function normalizeUri() has been deprecated: cleanup, use build-in function

The function getAbsUrl() has been deprecated: cleanup, use build-in function

        if ($event !== null) {
            $event->data['link'][] = $metalink;

            // set canocial link for type URIs to prevent indexing double content
            if ($_GET['type'] ?? "") {
                $event->data['link'][] = array('rel' => 'canonical', 'href' => getAbsUrl(wl($ID)));

The function getAbsUrl() has been deprecated: cleanup, use build-in function

            }
        }

        return $metalink;
    }
}

// TODO cleanup and just have this unconditionally
if (!function_exists('getAbsUrl')) {
    /**
     * @param $url
     * @return string
     * @deprecated cleanup, use build-in function
     */
    function getAbsUrl($url = null): string
    {
        if ($url === null) {
            $url = DOKU_BASE;
        }
        return str_replace(DOKU_BASE, DOKU_URL, $url);
    }
}

if (!function_exists('getDwUserEmail')) {
    /**
     * @param $user
     * @return string
     * @deprecated not used, will be removed
     */
    function getDwUserEmail($user): string
    {
        global $auth;
        if ($info = $auth->getUserData($user)) {
            return $info['mail'];
        } else {
            return false;

The expression return false returns the type false which is incompatible with the type-hinted return string.

        }
    }
}

if (!function_exists('getDwUserInfo')) {
    /**
     * @param $id
     * @param $pobj
     * @param $key
     * @return array|false
     * @deprecated cleanup, use build-in function
     */
    function getDwUserInfo($id, $pobj, $key = null)
    {
        global $auth, $conf;

        if (!$pobj->getConf('userns')) {
            return false;
        }

        // get user id
        $userid = str_replace(cleanID($pobj->getConf('userns')) . ($conf['useslash'] ? '/' : ':'), '', $id);

        if ($info = $auth->getUserData($userid)) {
            if ($key) {
                return $info['key'];
            } else {
                return $info;
            }
        } else {
            return false;
        }
    }
}

// sort query attributes by name
if (!function_exists('normalizeUri')) {
    /**
     * @param $uri
     * @return string
     * @deprecated cleanup, use build-in function
     */
    function normalizeUri($uri): string
    {
        // part URI
        $parts = explode('?', $uri);

        // part query
        if (isset($parts[1])) {
            $query = $parts[1];

            // test separator
            $sep = '&';
            if (strpos($query, '&') !== false) {
                $sep = '&';
            }
            $attr = explode($sep, $query);

            sort($attr);

            $parts[1] = implode($sep, $attr);
        }

        return implode('?', $parts);
    }
}