gnusocial/actions/pathsadminpanel.php

<?php
// This file is part of GNU social - https://www.gnu.org/software/social
//
// GNU social is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// GNU social 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 Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with GNU social.  If not, see <http://www.gnu.org/licenses/>.

/**
 * Paths administration panel
 *
 * @category  Settings
 * @package   GNUsocial
 * @author    Evan Prodromou <evan@status.net>
 * @author    Zach Copley <zach@status.net>
 * @author    Sarven Capadisli <csarven@status.net>
 * @copyright 2008-2011 StatusNet, Inc.
 * @license   https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
 */

defined('GNUSOCIAL') || die();

/**
 * Paths settings
 *
 * @category  Admin
 * @package   GNUsocial
 * @author    Evan Prodromou <evan@status.net>
 * @author    Zach Copley <zach@status.net>
 * @author    Sarven Capadisli <csarven@status.net>
 * @license   https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
 */
class PathsadminpanelAction extends AdminPanelAction
{
    /**
     * Returns the page title
     *
     * @return string page title
     */

    public function title()
    {
        // TRANS: Title for Paths admin panel.
        return _('Paths');
    }

    /**
     * Instructions for using this form.
     *
     * @return string instructions
     */
    public function getInstructions()
    {
        // TRANS: Form instructions for Path admin panel.
        return _('Path and server settings for this StatusNet site');
    }

    /**
     * Show the paths admin panel form
     *
     * @return void
     */
    public function showForm()
    {
        $form = new PathsAdminPanelForm($this);
        $form->show();
        return;
    }

    /**
     * Save settings from the form
     *
     * @return void
     */
    public function saveSettings()
    {
        static $settings = [
            'site'        => ['path', 'locale_path', 'ssl', 'sslserver'],
            'theme'       => ['server', 'dir', 'path', 'sslserver', 'sslpath'],
            'avatar'      => ['server', 'dir', 'path'],
            'attachments' => ['server', 'dir', 'path', 'sslserver', 'sslpath'],
        ];

        // XXX: If we're only going to have one boolean on thi page we
        // can remove some of the boolean processing code --Z

        static $booleans = array('site' => array('fancy'));

        $values = array();

        foreach ($settings as $section => $parts) {
            foreach ($parts as $setting) {
                $values[$section][$setting] = $this->trimmed("$section-$setting");
            }
        }

        foreach ($booleans as $section => $parts) {
            foreach ($parts as $setting) {
                $values[$section][$setting] = ($this->boolean($setting)) ? 1 : 0;
            }
        }

        $this->validate($values);

        // assert(all values are valid);

        $config = new Config();

        $config->query('START TRANSACTION');

        foreach ($settings as $section => $parts) {
            foreach ($parts as $setting) {
                Config::save($section, $setting, $values[$section][$setting]);
            }
        }

        foreach ($booleans as $section => $parts) {
            foreach ($parts as $setting) {
                Config::save($section, $setting, $values[$section][$setting]);
            }
        }

        $config->query('COMMIT');

        return;
    }

    /**
     * Attempt to validate setting values
     *
     * @return void
     */
    public function validate(&$values)
    {
        // Validate theme dir

        if (!empty($values['theme']['dir']) && !is_readable($values['theme']['dir'])) {
            // TRANS: Client error in Paths admin panel.
            // TRANS: %s is the directory that could not be read from.
            $this->clientError(sprintf(_('Theme directory not readable: %s.'), $values['theme']['dir']));
        }

        // Validate avatar dir

        if (empty($values['avatar']['dir']) || !is_writable($values['avatar']['dir'])) {
            // TRANS: Client error in Paths admin panel.
            // TRANS: %s is the avatar directory that could not be written to.
            $this->clientError(sprintf(_('Avatar directory not writable: %s.'), $values['avatar']['dir']));
        }

        // Validate locales dir

        // XXX: What else do we need to validate for lacales path here? --Z

        if (!empty($values['site']['locale_path']) && !is_readable($values['site']['locale_path'])) {
            // TRANS: Client error in Paths admin panel.
            // TRANS: %s is the locales directory that could not be read from.
            $this->clientError(sprintf(_('Locales directory not readable: %s.'), $values['site']['locale_path']));
        }

        // Validate SSL setup

        if (mb_strlen($values['site']['sslserver']) > 255) {
            // TRANS: Client error in Paths admin panel.
            // TRANS: %s is the SSL server URL that is too long.
            $this->clientError(_('Invalid SSL server. The maximum length is 255 characters.'));
        }
    }
}

class PathsAdminPanelForm extends AdminForm
{
    /**
     * ID of the form
     *
     * @return int ID of the form
     */
    public function id()
    {
        return 'form_paths_admin_panel';
    }

    /**
     * class of the form
     *
     * @return string class of the form
     */
    public function formClass()
    {
        return 'form_settings';
    }

    /**
     * Action of the form
     *
     * @return string URL of the action
     */
    public function action()
    {
        return common_local_url('pathsadminpanel');
    }

    /**
     * Data elements of the form
     *
     * @return void
     */
    public function formData()
    {
        $this->out->elementStart('fieldset', array('id' => 'settings_paths_locale'));
        // TRANS: Fieldset legend in Paths admin panel.
        $this->out->element('legend', null, _('Site'), 'site');
        $this->out->elementStart('ul', 'form_data');

        $this->li();
        $this->input(
            'server',
            // TRANS: Field label in Paths admin panel.
            _('Server'),
            // TRANS: Field title in Paths admin panel.
            _('Site\'s server hostname.')
        );
        $this->unli();

        $this->li();
        $this->input(
            'path',
            // TRANS: Field label in Paths admin panel.
            _('Path'),
            // TRANS: Field title in Paths admin panel.
            _('Site path.')
        );
        $this->unli();

        $this->li();
        $this->input(
            'locale_path',
            // TRANS: Field label in Paths admin panel.
            _('Locale directory'),
            // TRANS: Field title in Paths admin panel.
            _('Directory path to locales.'),
            'site'
        );
        $this->unli();

        $this->li();
        $this->out->checkbox(
            'fancy',
            // TRANS: Checkbox label in Paths admin panel.
            _('Fancy URLs'),
            (bool) $this->value('fancy'),
            // TRANS: Field title in Paths admin panel.
            _('Use fancy URLs (more readable and memorable)?')
        );
        $this->unli();

        $this->out->elementEnd('ul');
        $this->out->elementEnd('fieldset');

        $this->out->elementStart('fieldset', array('id' => 'settings_paths_theme'));
        // TRANS: Fieldset legend in Paths admin panel.
        $this->out->element('legend', null, _m('LEGEND', 'Theme'));

        $this->out->elementStart('ul', 'form_data');

        $this->li();
        $this->input(
            'server',
            // TRANS: Field label in Paths admin panel.
            _('Server'),
            // TRANS: Tooltip for field label in Paths admin panel.
            _('Server for themes.'),
            'theme'
        );
        $this->unli();

        $this->li();
        $this->input(
            'path',
            // TRANS: Field label in Paths admin panel.
            _('Path'),
            // TRANS: Tooltip for field label in Paths admin panel.
            _('Web path to themes.'),
            'theme'
        );
        $this->unli();

        $this->li();
        $this->input(
            'sslserver',
            // TRANS: Field label in Paths admin panel.
            _('SSL server'),
            // TRANS: Tooltip for field label in Paths admin panel.
            _('SSL server for themes (default: SSL server).'),
            'theme'
        );
        $this->unli();

        $this->li();
        $this->input(
            'sslpath',
            // TRANS: Field label in Paths admin panel.
            _('SSL path'),
            // TRANS: Tooltip for field label in Paths admin panel.
            _('SSL path to themes (default: /theme/).'),
            'theme'
        );
        $this->unli();

        $this->li();
        $this->input(
            'dir',
            // TRANS: Field label in Paths admin panel.
            _('Directory'),
            // TRANS: Tooltip for field label in Paths admin panel.
            _('Directory where themes are located.'),
            'theme'
        );
        $this->unli();

        $this->out->elementEnd('ul');

        $this->out->elementEnd('fieldset');
        $this->out->elementStart(
            'fieldset',
            ['id' => 'settings_avatar-paths']
        );
        // TRANS: Fieldset legend in Paths admin panel.
        $this->out->element('legend', null, _('Avatars'));

        $this->out->elementStart('ul', 'form_data');

        $this->li();
        $this->input(
            'server',
            // TRANS: Field label in Paths admin panel.
            _('Avatar server'),
            // TRANS: Tooltip for field label in Paths admin panel.
            _('Server for avatars.'),
            'avatar'
        );
        $this->unli();

        $this->li();
        $this->input(
            'path',
            // TRANS: Field label in Paths admin panel.
            _('Avatar path'),
            // TRANS: Tooltip for field label in Paths admin panel.
            _('Web path to avatars.'),
            'avatar'
        );
        $this->unli();

        $this->li();
        $this->input(
            'dir',
            // TRANS: Field label in Paths admin panel.
            _('Avatar directory'),
            // TRANS: Tooltip for field label in Paths admin panel.
            _('Directory where avatars are located.'),
            'avatar'
        );
        $this->unli();

        $this->out->elementEnd('ul');

        $this->out->elementEnd('fieldset');

        $this->out->elementStart(
            'fieldset',
            ['id' => 'settings_attachments-paths']
        );

        // TRANS: Fieldset legens in Paths admin panel.
        $this->out->element('legend', null, _('Attachments'));
        $this->out->elementStart('ul', 'form_data');

        $this->li();
        $this->input(
            'server',
            // TRANS: Field label in Paths admin panel.
            _('Server'),
            // TRANS: Tooltip for field label in Paths admin panel.
            _('Server for attachments.'),
            'attachments'
        );
        $this->unli();

        $this->li();
        $this->input(
            'path',
            // TRANS: Field label in Paths admin panel.
            _('Path'),
            // TRANS: Tooltip for field label in Paths admin panel.
            _('Web path to attachments.'),
            'attachments'
        );
        $this->unli();

        $this->li();
        $this->input(
            'sslserver',
            // TRANS: Field label in Paths admin panel.
            _('SSL server'),
            // TRANS: Tooltip for field label in Paths admin panel.
            _('Server for attachments on SSL pages.'),
            'attachments'
        );
        $this->unli();

        $this->li();
        $this->input(
            'sslpath',
            // TRANS: Field label in Paths admin panel.
            _('SSL path'),
            // TRANS: Tooltip for field label in Paths admin panel.
            _('Web path to attachments on SSL pages.'),
            'attachments'
        );
        $this->unli();

        $this->li();
        $this->input(
            'dir',
            // TRANS: Field label in Paths admin panel.
            _('Directory'),
            // TRANS: Tooltip for field label in Paths admin panel.
            _('Directory where attachments are located.'),
            'attachments'
        );
        $this->unli();

        $this->out->elementEnd('ul');
        $this->out->elementEnd('fieldset');

        $this->out->elementStart('fieldset', array('id' => 'settings_admin_ssl'));
        // TRANS: Fieldset legend in Paths admin panel.
        $this->out->element('legend', null, _m('LEGEND', 'SSL'));
        $this->out->elementStart('ul', 'form_data');
        $this->li();

        // TRANS: Drop down option in Paths admin panel (option for "When to use SSL").
        $ssl = [
            'never' => _('Never'),
            // TRANS: Drop down option in Paths admin panel (option for "When to use SSL").
            'always' => _('Always'),
        ];

        $this->out->dropdown(
            'site-ssl',
            // TRANS: Drop down label in Paths admin panel.
            _('Use SSL'),
            // TRANS: Tooltip for field label in Paths admin panel.
            $ssl,
            _('When to use SSL.'),
            false,
            $this->value('ssl', 'site')
        );
        $this->unli();

        $this->li();
        $this->input(
            'sslserver',
            // TRANS: Field label in Paths admin panel.
            _('SSL server'),
            // TRANS: Tooltip for field label in Paths admin panel.
            _('Server to direct SSL requests to.'),
            'site'
        );
        $this->unli();
        $this->out->elementEnd('ul');
        $this->out->elementEnd('fieldset');
    }

    /**
     * Action elements
     *
     * @return void
     */
    public function formActions()
    {
        // TRANS: Button text to store form data in the Paths admin panel.
        $this->out->submit(
            'save',
            _m('BUTTON', 'Save'),
            'submit',
            // TRANS: Button title text to store form data in the Paths admin panel.
            'save',
            _('Save path settings.')
        );
    }

    /**
     * Utility to simplify some of the duplicated code around
     * params and settings. Overriding the input() in the base class
     * to handle a whole bunch of cases of settings with the same
     * name under different sections.
     *
     * @param string $setting      Name of the setting
     * @param string $title        Title to use for the input
     * @param string $instructions Instructions for this field
     * @param string $section      config section, default = 'site'
     *
     * @return void
     */
    public function input($setting, $title, $instructions, $section='site')
    {
        $this->out->input("$section-$setting", $title, $this->value($setting, $section), $instructions);
    }
}