action_plugin_pwaoffline

Complexity

Total Complexity

10

Size/Duplication

Total Lines	102
Duplicated Lines	0 %

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	writeConfigToJSINFO()	0	22	3
A	add144pxImageToManifest()	0	5	1
B	collectPagesToCache()	0	29	5
A	register()	0	5	1

<?php

class action_plugin_pwaoffline extends DokuWiki_Action_Plugin

The type DokuWiki_Action_Plugin was not found. Maybe you did not declare it correctly or list all dependencies?

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

{

    /**
     * Registers a callback function for a given event
     *
     * @param Doku_Event_Handler $controller DokuWiki's event controller object
     *
     * @return void
     */
    public function register(Doku_Event_Handler $controller)

The type Doku_Event_Handler was not found. Maybe you did not declare it correctly or list all dependencies?

    {
        $controller->register_hook('MANIFEST_SEND', 'BEFORE', $this, 'add144pxImageToManifest');
        $controller->register_hook('AJAX_CALL_UNKNOWN', 'BEFORE', $this, 'collectPagesToCache');
        $controller->register_hook('DOKUWIKI_STARTED', 'BEFORE', $this, 'writeConfigToJSINFO');

    }

    /**
     * [Custom event handler which performs action]
     *
     * Event: MANIFEST_SEND
     *
     * @param Doku_Event $event  event object by reference
     * @param mixed      $param  [the parameters passed as fifth argument to register_hook() when this
     *                           handler was registered]
     *
     * @return void
     */
    public function add144pxImageToManifest(Doku_Event $event, $param)

The type Doku_Event was not found. Maybe you did not declare it correctly or list all dependencies?

    {
        $event->data['icons'][] = [
            'src' => DOKU_BASE . 'lib/plugins/pwaoffline/144.png',

The constant DOKU_BASE was not found. Maybe you did not declare it correctly or list all dependencies?

            'sizes' => '144x144',
        ];
    }

    /**
     * Event: AJAX_CALL_UNKNOWN
     *
     * @param Doku_Event $event
     * @param            $param
     */
    public function collectPagesToCache(Doku_Event $event, $param)
    {
        if ($event->data !== 'plugin_pwaoffline') {
            return;
        }

        global $conf, $INPUT;

Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

        // fixme do a full resync if the config was saved?
        $ts = $INPUT->has('ts') ? $INPUT->int('ts') : 0;

        search($pages, $conf['datadir'], 'search_allpages', ['skipacl' => false]);

The function search was not found. Maybe you did not declare it correctly or list all dependencies?

The variable $pages seems to be never defined.

        $pagesToCache = [];
        foreach ($pages as $pageData) {
            if ($pageData['mtime'] < $ts) {
                continue;
            }
            $pagesToCache[] = [
                'link' => wl($pageData['id']),

The function wl was not found. Maybe you did not declare it correctly or list all dependencies?

                'lastmod' => $pageData['mtime'],
            ];
        }

        header('Content-Type:application/json');
        echo json_encode($pagesToCache);

        $event->preventDefault();
        $event->stopPropagation();
    }

    /**
     * Event: DOKUWIKI_STARTED
     *
     * @param Doku_Event $event
     * @param            $param
     */
    public function writeConfigToJSINFO(Doku_Event $event, $param)
    {
        global $ACT;

Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

        if (act_clean($ACT) === 'pwaoffline_serviceworker') {

The function act_clean was not found. Maybe you did not declare it correctly or list all dependencies?

            header('Content-Type:application/javascript');
            $swjs = file_get_contents(__DIR__ . '/sw.js');
            echo $swjs;
            echo "const swHashVersion = '" . md5($swjs) . "';\n";
            $idbKeyVal = file_get_contents(__DIR__ . '/node_modules/idb-keyval/dist/idb-keyval-iife.min.js');
            echo $idbKeyVal;
            exit();

Using exit here is not recommended.

        }

        global $JSINFO;

Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

        header('X-DWPLUGIN-PWAOFFLINE-ACT:' . act_clean($ACT));
        if (empty($JSINFO['plugins'])) {
            $JSINFO['plugins'] = [];
        }

        $JSINFO['plugins']['pwaoffline'] = [
            'ts' => time(),
            'swHashVersion' => md5(file_get_contents(__DIR__ . '/sw.js')),
        ];
    }

}