class.homepage.php

Go to the documentation of this file.

<?php
/*
 * Copyright (c) 2021-2024 Bearsampp
 * License:  GNU General Public License version 3 or later; see LICENSE.txt
 * Author: Bear
 * Website: https://bearsampp.com
 * Github: https://github.com/Bearsampp
 */
 
/**
 * Class Homepage
 *
 * This class handles the homepage functionalities of the Bearsampp application.
 * It manages the page navigation, resource paths, and content refresh operations.
 */
class Homepage
{
    const PAGE_INDEX = 'index';
    const PAGE_PHPINFO = 'phpinfo';
    const PAGE_STDL_APC = 'apc.php';
 
    private $page;
 
    /**
     * @var array List of valid pages for the homepage.
     */
    private $pageList = array(
        self::PAGE_INDEX,
        self::PAGE_PHPINFO,
    );
 
    /**
     * @var array List of standard pages for the homepage.
     */
    private $pageStdl = array(
        self::PAGE_STDL_APC
    );
 
    /**
     * Homepage constructor.
     * Initializes the homepage class and sets the current page based on the query parameter.
     */
    public function __construct()
    {
        Util::logInitClass($this);
 
        $page = Util::cleanGetVar('p');
        $this->page = !empty($page) && in_array($page, $this->pageList) ? $page : self::PAGE_INDEX;
    }
 
    /**
     * Gets the current page.
     *
     * @return string The current page.
     */
    public function getPage()
    {
        return $this->page;
    }
 
    /**
     * Constructs the page query string based on the provided query.
     *
     * @param string $query The query string to construct.
     * @return string The constructed page query string.
     */
    public function getPageQuery($query)
    {
        $request = '';
        if (!empty($query) && in_array($query, $this->pageList) && $query != self::PAGE_INDEX) {
            $request = '?p=' . $query;
        } elseif (!empty($query) && in_array($query, $this->pageStdl)) {
            $request = $query;
        } elseif (!empty($query) && self::PAGE_INDEX) {
            $request = "index.php";
        }
        return $request;
    }
 
    /**
     * Constructs the full URL for the given page query.
     *
     * @param string $query The query string to construct the URL for.
     * @return string The constructed page URL.
     */
    public function getPageUrl($query)
    {
        global $bearsamppRoot;
        return $bearsamppRoot->getLocalUrl($this->getPageQuery($query));
    }
 
    /**
     * Gets the path to the homepage directory.
     *
     * @return string The homepage directory path.
     */
    public function getHomepagePath()
    {
        global $bearsamppCore;
        return $bearsamppCore->getResourcesPath(false) . '/homepage';
    }
 
    /**
     * Gets the path to the images directory.
     *
     * @return string The images directory path.
     */
    public function getImagesPath()
    {
        return $this->getResourcesPath(false) . '/img/';
    }
 
    /**
     * Gets the path to the icons directory.
     *
     * @return string The icons directory path.
     */
    public function getIconsPath()
    {
        return $this->getResourcesPath(false) . '/img/icons/';
    }
 
    /**
     * Gets the path to the resources directory.
     *
     * @return string The resources directory path.
     */
    public function getResourcesPath()
    {
        global $bearsamppCore;
        return md5(APP_TITLE);
    }
 
    /**
     * Gets the URL to the resources directory.
     *
     * @return string The resources directory URL.
     */
    public function getResourcesUrl()
    {
        global $bearsamppRoot;
        return $bearsamppRoot->getLocalUrl($this->getResourcesPath());
    }
 
    /**
     * Refreshes the alias content by updating the alias configuration file.
     *
     * @return bool True if the alias content was successfully refreshed, false otherwise.
     */
    public function refreshAliasContent()
    {
        global $bearsamppBins;
 
        $result = $bearsamppBins->getApache()->getAliasContent(
            $this->getResourcesPath(),
            $this->getHomepagePath()
        );
 
        return file_put_contents($this->getHomepagePath() . '/alias.conf', $result) !== false;
    }
 
    /**
     * Refreshes the commons JavaScript content by updating the _commons.js file.
     */
    public function refreshCommonsJsContent()
    {
        Util::replaceInFile($this->getHomepagePath() . '/js/_commons.js', array(
            '/^\s\surl:.*/' => '  url: "' . $this->getResourcesPath() . '/ajax.php"',
            '/AJAX_URL.*=.*/' => 'const AJAX_URL = "' . $this->getResourcesPath() . '/ajax.php"',
        ));
    }
}