helper.php

<?php
/**
 * DokuWiki Plugin top (Helper Component)
 *
 * @license GPL 2 http://www.gnu.org/licenses/gpl-2.0.html
 * @author  Andreas Gohr <gohr@cosmocode.de>
 */

class helper_plugin_top extends DokuWiki_Plugin {

    /** @var helper_plugin_sqlite */
    protected $sqlite = null;

    public function __construct()
    {
        $this->sqlite = plugin_load('helper', 'sqlite');
        if (!$this->sqlite) {
            msg('The top plugin requires the sqlite plugin', -1);
            return null;
        }

        if (!$this->sqlite->init('top', __DIR__ . '/db')) {
            msg('top plugin: sqlite initialization failed', -1);
            return null;
        }
    }

    /**
     * Access to plugin's database
     * @return helper_plugin_sqlite
     */
    public function getDBHelper()
    {
       return $this->sqlite;
    }

    /**
     * Adds a hit for the given page
     *
     * @param string $page the page id
     */
    public function add($page)
    {
        // ignore any bot accesses
        if (!class_exists('Jaybizzle\CrawlerDetect\CrawlerDetect')){
            require (__DIR__ . '/CrawlerDetect.php');
        }
        $CrawlerDetect = new Jaybizzle\CrawlerDetect\CrawlerDetect();
        if ($CrawlerDetect->isCrawler()) return;

        $translation = plugin_load('helper', 'translation');
        if (!$translation) {
            $lang = '';
        } else {
            $lang = $translation->getLangPart($page);
        }

        $month = date('Ym');

        $sql = "INSERT OR REPLACE INTO toppages (page, value, lang, month)
                  VALUES ( ?, COALESCE( (SELECT value FROM toppages WHERE page = ? and month = ? ) + 1, 1), ?, ?)";
        $res = $this->sqlite->query($sql, $page, $page, $month, $lang, $month);
        $this->sqlite->res_close($res);
    }

    /**
     * Get the most visited pages
     *
     * @param string|null $lang
     * @param string|null $month
     * @param int $num
     * @return array
     */
    public function best($lang, $month, $num = 10)
    {
        $sqlbegin  = "SELECT SUM(value) as value, page FROM toppages ";
        $sqlend = "GROUP BY page ORDER BY value DESC LIMIT ?";
        if ($lang === null && $month === null){
            $sql = $sqlbegin . $sqlend;
            $res  = $this->sqlite->query($sql, $num);
        } elseif ($lang !== null && $month === null) {
            $sql = $sqlbegin . "WHERE lang = ? " . $sqlend;
            $res  = $this->sqlite->query($sql, $lang, $num);
        } elseif ($lang === null && $month !== null){
            $sql = $sqlbegin . "WHERE month >= ? " . $sqlend;
            $res  = $this->sqlite->query($sql, intval($month), $num);
        } else {
            $sql = $sqlbegin . "WHERE lang = ? AND month >= ? " . $sqlend;
            $res  = $this->sqlite->query($sql, $lang, intval($month), $num);
        }
        $list = $this->sqlite->res2arr($res);
        $this->sqlite->res_close($res);

        if ($this->getConf('hide_start_pages')) {
            $list = $this->removeStartPages($list);
        }
        return $list;
    }

    /**
     * @param array $list
     * @return array
     */
    public function removeStartPages($list) {
        global $conf;
        $start = $conf['start'];
        $startpages = array();
        $startpages[] = $start;

        if ($conf['plugin']['translation']['translations'] !== '') {
            $translations = explode(' ', $conf['plugin']['translation']['translations']);
            foreach($translations as $translation) {
                $startpages[] = $translation . ':' . $start;
            }
        }

        foreach ($list as $index => $listitem) {
            if (in_array($listitem['page'],$startpages, true) === true ) {
                unset($list[$index]);
            }
        }
        $list = array_values($list);
        return $list;
    }

    /**
     * Returns true if the given page can be read by current user
     *
     * @param $id
     * @return bool
     */
    public function isReadable($id)
    {
        if ($this->getConf('show_only_public')) {
            if (auth_aclcheck($id, '', null) < AUTH_READ) return false;
        } else {
            if (auth_quickaclcheck($id) < AUTH_READ) return false;
        }
        if (!page_exists($id)) return false;
        if (isHiddenPage($id)) return false;

        return true;
    }
}
// vim:ts=4:sw=4:et: