3 * StatusNet, the distributed open-source microblogging tool
5 * License administration panel
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 Zach Copley <zach@status.net>
25 * @copyright 2010 StatusNet, Inc.
26 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
27 * @link http://status.net/
30 if (!defined('STATUSNET')) {
39 * @author Zach Copley <zach@status.net>
40 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
41 * @link http://status.net/
43 class LicenseadminpanelAction extends AdminPanelAction
47 * Returns the page title
49 * @return string page title
54 // TRANS: User admin panel title
55 return _m('TITLE', 'License');
59 * Instructions for using this form.
61 * @return string instructions
63 function getInstructions()
65 return _('License for this StatusNet site');
69 * Show the site admin panel form
75 $form = new LicenseAdminPanelForm($this);
81 * Save settings from the form
85 function saveSettings()
87 static $settings = array(
88 'license' => array('type', 'owner', 'url', 'title', 'image')
93 foreach ($settings as $section => $parts) {
94 foreach ($parts as $setting) {
95 $values[$section][$setting] = $this->trimmed($setting);
99 // This throws an exception on validation errors
101 $this->validate($values);
103 // assert(all values are valid);
105 $config = new Config();
107 $config->query('BEGIN');
109 foreach ($settings as $section => $parts) {
110 foreach ($parts as $setting) {
111 Config::save($section, $setting, $values[$section][$setting]);
115 $config->query('COMMIT');
121 * Validate License admin form values
123 * @param array &$values from the form
127 function validate(&$values)
129 // Validate license type (shouldn't have to do it, but just in case)
131 $types = array('private', 'allrightsreserved', 'cc');
133 if (!in_array($values['license']['type'], $types)) {
134 $this->clientError(_("Invalid license selection."));
137 // Make sure the user has set an owner if the site has a private
140 if ($values['license']['type'] == 'allrightsreserved'
141 && empty($values['license']['owner'])
144 _("You must specify the owner of the content when using the All Rights Reserved license.")
148 // Make sure the license title is not too long
149 if (mb_strlen($values['license']['type']) > 255) {
151 _('Invalid license title. Maximum length is 255 characters.')
155 // make sure the license URL and license image URL are valid URLs
157 $options = array('allowed_schemes' => array('http', 'https'));
159 // URLs should be set for cc license
161 if ($values['license']['type'] == 'cc') {
162 if (!Validate::uri($values['license']['url'], $options)) {
163 $this->clientError(_("Invalid license URL."));
165 if (!Validate::uri($values['license']['image'], $options)) {
166 $this->clientError(_("Invalid license image URL."));
170 // can be either blank or a valid URL for private & allrightsreserved
172 if (!empty($values['license']['url'])) {
173 if (!Validate::uri($values['license']['url'], $options)) {
174 $this->clientError(_("License URL must be blank or a valid URL."));
178 // can be either blank or a valid URL for private & allrightsreserved
180 if (!empty($values['license']['image'])) {
181 if (!Validate::uri($values['license']['image'], $options)) {
182 $this->clientError(_("License image must be blank or valid URL."));
188 class LicenseAdminPanelForm extends AdminForm
193 * @return int ID of the form
197 return 'licenseadminpanel';
203 * @return string class of the form
207 return 'form_settings';
213 * @return string URL of the action
218 return common_local_url('licenseadminpanel');
222 * Data elements of the form
229 $this->out->elementStart(
230 'fieldset', array('id' => 'settings_license-selection')
232 $this->out->element('legend', null, _('License selection'));
233 $this->out->elementStart('ul', 'form_data');
238 'private' => _('Private'),
239 'allrightsreserved' => _('All Rights Reserved'),
240 'cc' => _('Creative Commons')
243 $this->out->dropdown(
249 $this->value('type', 'license')
254 $this->out->elementEnd('ul');
255 $this->out->elementEnd('fieldset');
257 $this->out->elementStart(
259 array('id' => 'settings_license-details')
261 $this->out->element('legend', null, _('License details'));
262 $this->out->elementStart('ul', 'form_data');
268 _('Name of the owner of the site\'s content (if applicable).'),
277 _('The title of the license.'),
286 _('URL for more information about the license.'),
293 'image', _('License Image URL'),
294 _('URL for an image to display with the license.'),
299 $this->out->elementEnd('ul');
300 $this->out->elementEnd('fieldset');
308 function formActions()
311 'submit', _('Save'), 'submit', null, _('Save license settings')