xref: /plugin/farmer/admin/config.php (revision 1da41c8bdb9ce0b590d5b69552c4ddb4d0aef860)
1da0ae2c0SAndreas Gohr<?php
2*1da41c8bSAndreas Gohr
3*1da41c8bSAndreas Gohruse dokuwiki\Extension\AdminPlugin;
4*1da41c8bSAndreas Gohruse dokuwiki\Form\Form;
5*1da41c8bSAndreas Gohr
6da0ae2c0SAndreas Gohr/**
7da0ae2c0SAndreas Gohr * DokuWiki Plugin farmer (Admin Component)
8da0ae2c0SAndreas Gohr *
9*1da41c8bSAndreas Gohr * Configuration Interface for farm.ini
10*1da41c8bSAndreas Gohr *
11da0ae2c0SAndreas Gohr * @license GPL 2 http://www.gnu.org/licenses/gpl-2.0.html
12da0ae2c0SAndreas Gohr * @author  Michael Große <grosse@cosmocode.de>
130a5d2da2SAndreas Gohr * @author  Andreas Gohr <gohr@cosmocode.de>
14da0ae2c0SAndreas Gohr */
15*1da41c8bSAndreas Gohrclass admin_plugin_farmer_config extends AdminPlugin
16*1da41c8bSAndreas Gohr{
17b96c66ccSAndreas Gohr    /** @var  helper_plugin_farmer */
18b96c66ccSAndreas Gohr    protected $helper;
19b96c66ccSAndreas Gohr
20da0ae2c0SAndreas Gohr    /**
21da0ae2c0SAndreas Gohr     * @return bool admin only!
22da0ae2c0SAndreas Gohr     */
23*1da41c8bSAndreas Gohr    public function forAdminOnly()
24*1da41c8bSAndreas Gohr    {
25da0ae2c0SAndreas Gohr        return false;
26da0ae2c0SAndreas Gohr    }
27da0ae2c0SAndreas Gohr
28da0ae2c0SAndreas Gohr    /**
29b96c66ccSAndreas Gohr     * admin_plugin_farmer_config constructor.
30b96c66ccSAndreas Gohr     */
31*1da41c8bSAndreas Gohr    public function __construct()
32*1da41c8bSAndreas Gohr    {
33b96c66ccSAndreas Gohr        $this->helper = plugin_load('helper', 'farmer');
34b96c66ccSAndreas Gohr    }
35b96c66ccSAndreas Gohr
36b96c66ccSAndreas Gohr    /**
37da0ae2c0SAndreas Gohr     * Should carry out any processing required by the plugin.
38da0ae2c0SAndreas Gohr     */
39*1da41c8bSAndreas Gohr    public function handle()
40*1da41c8bSAndreas Gohr    {
41da0ae2c0SAndreas Gohr        global $INPUT;
42da0ae2c0SAndreas Gohr        global $ID;
43da0ae2c0SAndreas Gohr        if (!$INPUT->has('farmconf')) return;
44da0ae2c0SAndreas Gohr        if (!checkSecurityToken()) return;
45da0ae2c0SAndreas Gohr
46b96c66ccSAndreas Gohr        $farmconf = $this->helper->getConfig();
47c4c8e953SAndreas Gohr        $farmdir = $farmconf['base']['farmdir'];
48a646d519SAndreas Gohr        $farmconf = array_merge($farmconf, $INPUT->arr('farmconf'));
49c4c8e953SAndreas Gohr        $farmconf['base']['farmdir'] = $farmdir;
50c4c8e953SAndreas Gohr
51c4c8e953SAndreas Gohr        $farmconf['base']['basedomain'] = trim(trim($farmconf['base']['basedomain'], '.'));
52a646d519SAndreas Gohr
53da0ae2c0SAndreas Gohr        $ini = DOKU_INC . 'conf/farm.ini';
54da0ae2c0SAndreas Gohr        $data = "; Farm config created by the farmer plugin\n";
55a646d519SAndreas Gohr        $data .= $this->createIni($farmconf);
56da0ae2c0SAndreas Gohr        io_saveFile($ini, $data);
57da0ae2c0SAndreas Gohr
58*1da41c8bSAndreas Gohr        $self = wl($ID, ['do' => 'admin', 'page' => 'farmer', 'sub' => 'config'], true, '&');
59da0ae2c0SAndreas Gohr        send_redirect($self);
60da0ae2c0SAndreas Gohr    }
61da0ae2c0SAndreas Gohr
62da0ae2c0SAndreas Gohr    /**
63da0ae2c0SAndreas Gohr     * Render HTML output, e.g. helpful text and a form
64da0ae2c0SAndreas Gohr     */
65*1da41c8bSAndreas Gohr    public function html()
66*1da41c8bSAndreas Gohr    {
67b96c66ccSAndreas Gohr        $farmconf = $this->helper->getConfig();
68da0ae2c0SAndreas Gohr
69*1da41c8bSAndreas Gohr        $form = new Form(['method' => 'post']);
70c4c8e953SAndreas Gohr
71c4c8e953SAndreas Gohr        $form->addFieldsetOpen($this->getLang('base'));
72c4c8e953SAndreas Gohr        $form->addHTML('<label><span>' . $this->getLang('farm dir') . '</span>' . DOKU_FARMDIR);
73*1da41c8bSAndreas Gohr        $form->addTextInput('farmconf[base][farmhost]', $this->getLang('farm host'))
74*1da41c8bSAndreas Gohr            ->val($farmconf['base']['farmhost']);
75*1da41c8bSAndreas Gohr        $form->addTextInput('farmconf[base][basedomain]', $this->getLang('base domain'))
76*1da41c8bSAndreas Gohr            ->val($farmconf['base']['basedomain']);
77c4c8e953SAndreas Gohr        $form->addFieldsetClose();
78c4c8e953SAndreas Gohr
79da0ae2c0SAndreas Gohr        $form->addFieldsetOpen($this->getLang('conf_inherit'));
80da0ae2c0SAndreas Gohr        foreach ($farmconf['inherit'] as $key => $val) {
81da0ae2c0SAndreas Gohr            $form->setHiddenField("farmconf[inherit][$key]", 0);
82*1da41c8bSAndreas Gohr            $chk = $form->addCheckbox("farmconf[inherit][$key]", $this->getLang('conf_inherit_' . $key))
83*1da41c8bSAndreas Gohr                ->useInput(false);
84da0ae2c0SAndreas Gohr            if ($val) $chk->attr('checked', 'checked');
85da0ae2c0SAndreas Gohr        }
86da0ae2c0SAndreas Gohr        $form->addFieldsetClose();
87da0ae2c0SAndreas Gohr
88*1da41c8bSAndreas Gohr        $options = [
8955aab17cSAndreas Gohr            'farmer' => $this->getLang('conf_notfound_farmer'),
9055aab17cSAndreas Gohr            '404' => $this->getLang('conf_notfound_404'),
9155aab17cSAndreas Gohr            'list' => $this->getLang('conf_notfound_list'),
9255aab17cSAndreas Gohr            'redirect' => $this->getLang('conf_notfound_redirect')
93*1da41c8bSAndreas Gohr        ];
9455aab17cSAndreas Gohr
9555aab17cSAndreas Gohr        $form->addFieldsetOpen($this->getLang('conf_notfound'));
96*1da41c8bSAndreas Gohr        $form->addDropdown('farmconf[notfound][show]', $options, $this->getLang('conf_notfound'))
97*1da41c8bSAndreas Gohr            ->val($farmconf['notfound']['show']);
98*1da41c8bSAndreas Gohr        $form->addTextInput('farmconf[notfound][url]', $this->getLang('conf_notfound_url'))
99*1da41c8bSAndreas Gohr            ->val($farmconf['notfound']['url']);
100da0ae2c0SAndreas Gohr        $form->addFieldsetClose();
101da0ae2c0SAndreas Gohr
102da0ae2c0SAndreas Gohr        $form->addButton('save', $this->getLang('save'));
103da0ae2c0SAndreas Gohr        echo $form->toHTML();
104da0ae2c0SAndreas Gohr    }
105da0ae2c0SAndreas Gohr
106da0ae2c0SAndreas Gohr    /**
107da0ae2c0SAndreas Gohr     * Simple function to create an ini file
108da0ae2c0SAndreas Gohr     *
109da0ae2c0SAndreas Gohr     * Does no escaping, but should suffice for our use case
110da0ae2c0SAndreas Gohr     *
111da0ae2c0SAndreas Gohr     * @link http://stackoverflow.com/a/5695202/172068
112da0ae2c0SAndreas Gohr     * @param array $data The data to transform
113da0ae2c0SAndreas Gohr     * @return string
114da0ae2c0SAndreas Gohr     */
115*1da41c8bSAndreas Gohr    public function createIni($data)
116*1da41c8bSAndreas Gohr    {
117*1da41c8bSAndreas Gohr        $res = [];
118da0ae2c0SAndreas Gohr        foreach ($data as $key => $val) {
119da0ae2c0SAndreas Gohr            if (is_array($val)) {
120da0ae2c0SAndreas Gohr                $res[] = '';
121da0ae2c0SAndreas Gohr                $res[] = "[$key]";
122da0ae2c0SAndreas Gohr                foreach ($val as $skey => $sval) {
123da0ae2c0SAndreas Gohr                    $res[] = "$skey = " . (is_numeric($sval) ? $sval : '"' . $sval . '"');
124da0ae2c0SAndreas Gohr                }
125da0ae2c0SAndreas Gohr            } else {
126da0ae2c0SAndreas Gohr                $res[] = "$key = " . (is_numeric($val) ? $val : '"' . $val . '"');
127da0ae2c0SAndreas Gohr            }
128da0ae2c0SAndreas Gohr        }
129da0ae2c0SAndreas Gohr        $res[] = '';
130*1da41c8bSAndreas Gohr        return implode("\n", $res);
131da0ae2c0SAndreas Gohr    }
132da0ae2c0SAndreas Gohr}
133