3 * StatusNet, the distributed open-source microblogging tool
5 * Dump of configuration variables
9 * LICENCE: This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU Affero General Public License as published by
11 * the Free Software Foundation, either version 3 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU Affero General Public License for more details.
19 * You should have received a copy of the GNU Affero General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 * @author Evan Prodromou <evan@status.net>
25 * @author Zach Copley <zach@status.net>
26 * @copyright 2009 StatusNet, Inc.
27 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
28 * @link http://status.net/
31 if (!defined('STATUSNET')) {
36 * Gives a full dump of configuration variables for this instance
37 * of StatusNet, minus variables that may be security-sensitive (like
39 * URL: http://identi.ca/api/statusnet/config.(xml|json)
44 * @author Evan Prodromou <evan@status.net>
45 * @author Zach Copley <zach@status.net>
46 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
47 * @link http://status.net/
50 class ApiStatusnetConfigAction extends ApiAction
53 'site' => array('name', 'server', 'theme', 'path', 'logo', 'fancy', 'language',
54 'email', 'broughtby', 'broughtbyurl', 'timezone', 'closed',
55 'inviteonly', 'private', 'textlimit', 'ssl', 'sslserver', 'shorturllength'),
56 'license' => array('type', 'owner', 'url', 'title', 'image'),
57 'nickname' => array('featured'),
58 'profile' => array('biolimit'),
59 'group' => array('desclimit'),
60 'notice' => array('contentlimit'),
61 'throttle' => array('enabled', 'count', 'timespan'),
62 'xmpp' => array('enabled', 'server', 'port', 'user'),
63 'integration' => array('source')
67 * Take arguments for running
69 * @param array $args $_REQUEST args
71 * @return boolean success flag
75 function prepare($args)
77 parent::prepare($args);
84 * @param array $args $_REQUEST data (unused)
89 function handle($args)
91 parent::handle($args);
93 switch ($this->format) {
95 $this->initDocument('xml');
96 $this->elementStart('config');
98 // XXX: check that all sections and settings are legal XML elements
100 foreach ($this->keys as $section => $settings) {
101 $this->elementStart($section);
102 foreach ($settings as $setting) {
103 $value = common_config($section, $setting);
104 if (is_array($value)) {
105 $value = implode(',', $value);
106 } else if ($value === false || $value == '0') {
108 } else if ($value === true || $value == '1') {
112 // return theme logo if there's no site specific one
114 if ($section == 'site' && $setting == 'logo') {
115 $value = Theme::path('logo.png');
119 $this->element($setting, null, $value);
121 $this->elementEnd($section);
123 $this->elementEnd('config');
124 $this->endDocument('xml');
128 foreach ($this->keys as $section => $settings) {
129 $result[$section] = array();
130 foreach ($settings as $setting) {
131 $result[$section][$setting]
132 = common_config($section, $setting);
135 $this->initDocument('json');
136 $this->showJsonObjects($result);
137 $this->endDocument('json');
141 _('API method not found.'),
150 * Return true if read only.
154 * @param array $args other arguments
156 * @return boolean is read only action?
159 function isReadOnly($args)