xref: /plugin/combo/action/analytics.php (revision d262537c0e3e167c29541034d59d4a6edf2ffecf) 
1<?php
2
3use ComboStrap\Analytics;
4use Combostrap\AnalyticsMenuItem;
5use ComboStrap\Auth;
6use ComboStrap\LogUtility;
7use ComboStrap\Page;
8use ComboStrap\Sqlite;
9
10/**
11 * Copyright (c) 2021. ComboStrap, Inc. and its affiliates. All Rights Reserved.
12 *
13 * This source code is licensed under the GPL license found in the
14 * COPYING  file in the root directory of this source tree.
15 *
16 * @license  GPL 3 (https://www.gnu.org/licenses/gpl-3.0.en.html)
17 * @author   ComboStrap <support@combostrap.com>
18 *
19 */
20
21require_once(__DIR__ . '/../class/'.'Analytics.php');
22require_once(__DIR__ . '/../class/'.'Auth.php');
23require_once(__DIR__ . '/../class/'.'AnalyticsMenuItem.php');
24
25/**
26 * Class action_plugin_combo_analytics
27 * Update the analytics data
28 */
29class action_plugin_combo_analytics extends DokuWiki_Action_Plugin
30{
31
32
33    public function register(Doku_Event_Handler $controller)
34    {
35
36        /**
37         * Analytics to refresh because they have lost or gain a backlinks
38         * are done via Sqlite table (The INDEXER_TASKS_RUN gives a way to
39         * manipulate this queue)
40         *
41         * There is no need to do it at page write
42         * https://www.dokuwiki.org/devel:event:io_wikipage_write
43         * because after the page is written, the page is shown and trigger the index tasks run
44         *
45         * We do it after because if there is an error
46         * We will not stop the Dokuwiki Processing
47         */
48        $controller->register_hook('INDEXER_TASKS_RUN', 'AFTER', $this, 'handle_refresh_analytics', array());
49
50        /**
51         * Add a icon in the page tools menu
52         * https://www.dokuwiki.org/devel:event:menu_items_assembly
53         */
54        $controller->register_hook('MENU_ITEMS_ASSEMBLY', 'AFTER', $this, 'handle_page_tools');
55
56    }
57
58    public function handle_refresh_analytics(Doku_Event $event, $param)
59    {
60
61        /**
62         * Check that the actual page has analytics data
63         * (if there is a cache, it's pretty quick)
64         */
65        global $ID;
66        Analytics::processAndGetDataAsArray($ID,true);
67
68        /**
69         * Check the analytics to refresh
70         */
71        $sqlite = Sqlite::getSqlite();
72        $res = $sqlite->query("SELECT ID FROM ANALYTICS_TO_REFRESH");
73        if (!$res) {
74            LogUtility::msg("There was a problem during the select: {$sqlite->getAdapter()->getDb()->errorInfo()}");
75        }
76        $rows = $sqlite->res2arr($res,true);
77        $sqlite->res_close($res);
78        foreach($rows as $row){
79            $page = new Page($row['ID']);
80            $page->refreshAnalytics();
81        }
82
83    }
84
85    public function handle_page_tools(Doku_Event $event, $param){
86
87        if (!Auth::isWriter()){
88            return;
89        }
90
91        /**
92         * The `view` property defines the menu that is currently built
93         * https://www.dokuwiki.org/devel:menus
94         * If this is not the page menu, return
95         */
96        if($event->data['view'] != 'page') return;
97
98        global $INFO;
99        if(!$INFO['exists']) {
100            return;
101        }
102        array_splice($event->data['items'], -1, 0, array(new AnalyticsMenuItem()));
103
104    }
105}
106
107
108
109