3 * StatusNet, the distributed open-source microblogging tool
5 * Admin panel for plugin to use bit.ly URL shortening services.
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 Brion Vibber <brion@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')) {
35 * Administer global bit.ly URL shortener settings
39 * @author Brion Vibber <brion@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/
44 class BitlyadminpanelAction extends AdminPanelAction
47 * Returns the page title
49 * @return string page title
54 return _m('bit.ly URL shortening');
58 * Instructions for using this form.
60 * @return string instructions
63 function getInstructions()
65 return _m('URL shortening with bit.ly requires ' .
66 '[a bit.ly account and API key](http://bit.ly/a/your_api_key). ' .
67 'This verifies that this is an authorized account, and ' .
68 'allow you to use bit.ly\'s tracking features and custom domains.');
72 * Show the bit.ly admin panel form
79 $form = new BitlyAdminPanelForm($this);
85 * Save settings from the form
90 function saveSettings()
92 static $settings = array(
93 'bitly' => array('default_login', 'default_apikey')
96 static $booleans = array(
97 'bitly' => array('allow_override')
102 foreach ($settings as $section => $parts) {
103 foreach ($parts as $setting) {
104 $values[$section][$setting]
105 = $this->trimmed($setting);
109 foreach ($booleans as $section => $parts) {
110 foreach ($parts as $setting) {
111 $values[$section][$setting]
112 = ($this->boolean($setting)) ? 1 : 0;
116 // This throws an exception on validation errors
118 $this->validate($values);
120 // assert(all values are valid);
122 $config = new Config();
124 $config->query('BEGIN');
126 foreach ($settings as $section => $parts) {
127 foreach ($parts as $setting) {
128 Config::save($section, $setting, $values[$section][$setting]);
132 foreach ($booleans as $section => $parts) {
133 foreach ($parts as $setting) {
134 Config::save($section, $setting, $values[$section][$setting]);
138 $config->query('COMMIT');
143 function validate(&$values)
145 // Validate consumer key and secret (can't be too long)
147 if (mb_strlen($values['bitly']['default_apikey']) > 255) {
149 _m("Invalid login. Max length is 255 characters.")
153 if (mb_strlen($values['bitly']['default_apikey']) > 255) {
155 _m("Invalid API key. Max length is 255 characters.")
161 class BitlyAdminPanelForm extends AdminForm
166 * @return int ID of the form
171 return 'bitlyadminpanel';
177 * @return string class of the form
182 return 'form_settings';
188 * @return string URL of the action
193 return common_local_url('bitlyadminpanel');
197 * Data elements of the form
204 $this->out->elementStart(
206 array('id' => 'settings_bitly')
208 $this->out->element('legend', null, _m('Default credentials'));
210 // Do we have global defaults to fall back on?
211 $login = $apiKey = false;
212 Event::handle('BitlyDefaultCredentials', array(&$login, &$apiKey));
213 $haveGlobalDefaults = ($login && $apiKey);
214 if ($login && $apiKey) {
215 $this->out->element('p', 'form_guide',
216 _m('Leave these empty to use the default credentials.'));
218 $this->out->element('p', 'form_guide',
219 _m('If you leave these empty, bit.ly will be unavailable to users.'));
221 $this->out->elementStart('ul', 'form_data');
241 $this->out->elementEnd('ul');
242 $this->out->elementEnd('fieldset');
244 $this->out->elementStart(
246 array('id' => 'settings_bitly-options')
248 $this->out->element('legend', null, _m('Options'));
250 $this->out->elementStart('ul', 'form_data');
254 $this->out->checkbox(
255 'allow_override', _m('Allow users to specify their own API key.'),
256 (bool) $this->value('bitly', 'allow_override'),
257 _m('If set, users will be able to specify their own bit.ly login and API key ' .
258 'to be used for shortening their links.'),
263 $this->out->elementEnd('ul');
265 $this->out->elementEnd('fieldset');
274 function formActions()
276 $this->out->submit('submit', _('Save'), 'submit', null, _m('Save bit.ly settings'));