net_nemein_wiki_wikipage

Complexity

Total Complexity

24

Size/Duplication

Total Lines	173
Duplicated Lines	0 %

Test Coverage

Coverage

54.55%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	_on_updating()	0	11	3
A	_on_creating()	0	22	5
A	_on_loaded()	0	6	2
A	_on_updated()	0	5	1
A	list_watchers()	0	13	1
A	update_link_cache()	0	26	4
A	get_diff()	0	21	3
A	update_watchers()	0	40	5

<?php
/**
 * @package net.nemein.wiki
 * @author The Midgard Project, http://www.midgard-project.org
 * @copyright The Midgard Project, http://www.midgard-project.org
 * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License
 */

/**
 * Wiki note helper class to be used by other components
 *
 * @package net.nemein.wiki
 */
class net_nemein_wiki_wikipage extends midcom_db_article
{
    public array $autodelete_dependents = [
        net_nemein_wiki_link_dba::class => 'frompage'
    ];

    public function _on_loaded()
    {
        // Backwards compatibility
        if ($this->name == '') {
            $this->name = midcom_helper_misc::urlize($this->title);
            $this->update();
        }
    }

    public function _on_creating() : bool
    {
        if (   $this->title == ''
            || !$this->topic) {
            // We must have wikiword and topic at this stage
            return false;
        }

        // Check for duplicates
        $qb = self::new_query_builder();
        $qb->add_constraint('topic', '=', $this->topic);
        $qb->add_constraint('title', '=', $this->title);
        if ($qb->count() > 0) {
            midcom_connection::set_error(MGD_ERR_OBJECT_NAME_EXISTS);
            return false;
        }

        // Generate URL-clean name
        if ($this->name != 'index') {
            $this->name = midcom_helper_misc::urlize($this->title);
        }
        return true;
    }

    public function _on_updating() : bool
    {
        if ($guid = midcom::get()->auth->user?->guid) {
            // Place current user in the page authors list
            $authors = explode('|', substr($this->metadata->authors, 1, -1));
            if (!in_array($guid, $authors)) {
                $authors[] = $guid;
                $this->metadata->authors = '|' . implode('|', $authors) . '|';
            }
        }
        return parent::_on_updating();
    }

    public function _on_updated()
    {
        parent::_on_updated();
        $this->update_watchers();
        $this->update_link_cache();
    }

    /**
     * Caches links in the wiki page into database for faster "what links here" queries
     */
    private function update_link_cache()
    {
        $parser = new net_nemein_wiki_parser($this);
        $links_in_content = $parser->find_links_in_content();

        $qb = net_nemein_wiki_link_dba::new_query_builder();
        $qb->add_constraint('frompage', '=', $this->id);

        // Check links in DB versus links in content to see what needs to be removed
        foreach ($qb->execute() as $link) {
            if (!array_key_exists($link->topage, $links_in_content)) {
                // This link is not any more in content, remove
                $link->delete();
                continue;
            }
            //no change for this link
            unset($links_in_content[$link->topage]);
        }

        // What is still left needs to be added
        foreach (array_keys($links_in_content) as $wikilink) {
            $link = new net_nemein_wiki_link_dba();
            $link->frompage = $this->id;
            $link->topage = $wikilink;
            debug_add("Creating net_nemein_wiki_link_dba: from page #{$link->frompage}, to page: '$link->topage'");
            $link->create();
        }
    }

    /**
     * Get list of people watching this page
     */
    private function list_watchers() : array
    {
        $topic = new midcom_db_topic($this->topic);
        $qb = new midgard_query_builder('midgard_parameter');
        $qb->add_constraint('domain', '=', 'net.nemein.wiki:watch');
        $qb->begin_group('OR');
            // List people watching the whole wiki
            $qb->add_constraint('parentguid', '=', $topic->guid);
            // List people watching this particular page
            $qb->add_constraint('parentguid', '=', $this->guid);
        $qb->end_group();

        return array_unique(array_column($qb->execute(), 'name'));
    }

    private function update_watchers()
    {
        $watchers = $this->list_watchers();
        if (empty($watchers)) {
            return;
        }

        $diff = $this->get_diff();
        if (empty($diff)) {
            // No sense to email empty diffs
            return;
        }

        // Construct the message
        $message = [];
        $user_string = midcom::get()->i18n->get_string('anonymous', 'net.nemein.wiki');
        if ($user = midcom::get()->auth->user?->get_storage()) {
            $user_string = $user->name;
        }
        // Title for long notifications
        $message['title'] = sprintf(midcom::get()->i18n->get_string('page %s has been updated by %s', 'net.nemein.wiki'), $this->title, $user_string);
        // Content for long notifications
        $message['content']  = "{$message['title']}\n\n";

        $message['content'] .= midcom::get()->i18n->get_string('page modifications', 'net.nemein.wiki') . ":\n";
        $message['content'] .= "\n{$diff}\n\n";

        $message['content'] .= midcom::get()->i18n->get_string('link to page', 'net.nemein.wiki') . ":\n";
        $message['content'] .= midcom::get()->permalinks->create_permalink($this->guid);

        // Content for short notifications
        $topic = new midcom_db_topic($this->topic);
        $message['abstract'] = sprintf(midcom::get()->i18n->get_string('page %s has been updated by %s in wiki %s', 'net.nemein.wiki'), $this->title, $user_string, $topic->extra);

        debug_add("Processing list of Wiki subscribers");

        // Send the message out
        foreach ($watchers as $recipient) {
            debug_add("Notifying {$recipient}...");
            org_openpsa_notifications::notify('net.nemein.wiki:page_updated', $recipient, $message);
        }
    }

    private function get_diff() : string
    {
        // Load the RCS handler
        $rcs_handler = midcom::get()->rcs->load_backend($this);

        // Find out what versions to diff
        $history = $rcs_handler->get_history();
        if (count($history->all()) < 2) {
            return '';
        }
        $this_version = $history->get_last()['revision'];
        $prev_version = $history->get_previous($this_version)['revision'];

        try {
            $diff_fields = $rcs_handler->get_diff($prev_version, $this_version);
        } catch (midcom_error $e) {
            $e->log();
            return '';
        }

        return $diff_fields['content']['diff'] ?? '';
    }
}