CORE-POS/IS4C

<?php
/*******************************************************************************

    Copyright 2014 Whole Foods Co-op

    This file is part of CORE-POS.

    CORE-POS 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; either version 2 of the License, or
    (at your option) any later version.

    CORE-POS 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.

    You should have received a copy of the GNU General Public License
    in the file license.txt along with IT CORE; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

*********************************************************************************/

include(dirname(__FILE__) . '/../config.php');
if (!class_exists('FannieAPI')) {
    include_once(__DIR__ . '/../classlib2.0/FannieAPI.php');
}

class SiteMap extends FannieRESTfulPage
{
    protected $header = 'Fannie :: Site Map';
    protected $title = 'Site Map';

    public $must_authenticate = true;
    public $auth_classes = array('admin', 'sitemap');
    public $themed = true;

    public $description = '[Site Map] is a list of all known pages. It\'s very likely the page
    you\'re on right now!';

    private function getPages()
    {
        $pages = FannieAPI::listModules('FanniePage');
        $sets = array();
        $help = array(
            'done' => 0,
            'total' => 0,
        );
        foreach ($pages as $p) {
            $obj = new $p();
            if (!$obj->discoverable) {
                continue;
            }
            $obj->setConfig($this->config);
            $obj->setLogger($this->logger);
            $obj->setConnection($this->connection);
            $reflect = new ReflectionClass($obj);
            $file = $reflect->getFileName();
            if (DIRECTORY_SEPARATOR == '\\') {
                $file = str_replace(DIRECTORY_SEPARATOR, '/', $file);
            }
            $url = $this->config->get('URL') . str_replace($this->config->get('ROOT'), '', $file);
            if (!isset($sets[$obj->page_set])) {
                $sets[$obj->page_set] = array();
            }
            $sets[$obj->page_set][$p] = array(
               'url' => $url,
               'info' => $obj->description, 
            );
            $help['total']++;
            if ($obj->helpContent() && substr($obj->helpContent(),0,17) != '<!-- need doc -->') {
                $help['done']++;
                $sets[$obj->page_set][$p]['help'] = 'collapse';
            } else {
                $sets[$obj->page_set][$p]['help'] = 'alert-danger';
            }
        }

        return array($sets, $help);
    }

    private function printPageSet($sets, $set_name)
    {
        $ret = '<li>' . $set_name;
        $ret .= '<ul>';
        $page_keys = array_keys($sets[$set_name]);
        sort($page_keys);
        foreach ($page_keys as $page_key) {
            $description = $sets[$set_name][$page_key]['info'];
            $url = $sets[$set_name][$page_key]['url'];
            $linked = preg_replace('/\[(.+)\]/', '<a href="' . $url . '">\1</a>', $description);
            if ($linked === $description) {
                $linked .= ' (<a href="' . $url . '">Link</a>)';
            }
            $ret .= sprintf('<li>%s 
                <span class="%s">Internal Help Missing</span>
                </li>',
                $linked,
                $sets[$set_name][$page_key]['help']
            );
        }
        $ret .= '</ul>';
        $ret .= '</li>';

        return $ret;
    }

    public function get_view()
    {
        list($sets, $help) = $this->getPages();

        $ret = '';
        $ret .= '<div class="alert alert-info">';
        $ret .= sprintf('New UI help content percent: <strong>%.2f%%</strong><br />', 
            ((float)$help['done']) / $help['total'] * 100);
        $ret .= '</div>';

        $keys = array_keys($sets);
        sort($keys);
        $ret .= '<ul>';
        foreach ($keys as $set_name) {
            $ret .= $this->printPageSet($sets, $set_name);
        }
        $ret .= '</ul>';

        return $ret;
    }

    public function helpContent()
    {
        return _('<p>A list of all known Fannie tools and reports including those
            provided by plugins. Pages <em>may</em> opt out of this list but the
            vast majority do not. This is provided to ensure users can locate
            most everything regardless of how the menus are set up.</p>');
    }

    public function unitTest($phpunit)
    {
        $phpunit->assertNotEquals(0, strlen($this->get_view()));
    }
}

FannieDispatch::conditionalExec();