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/
43 class BitlyadminpanelAction extends AdminPanelAction
46 * Returns the page title
48 * @return string page title
52 // TRANS: Title of administration panel.
53 return _m('bit.ly URL shortening');
57 * Instructions for using this form.
59 * @return string instructions
61 function getInstructions()
63 // TRANS: Instructions for administration panel.
64 // TRANS: This message contains Markdown links in the form [decsription](link).
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
78 $form = new BitlyAdminPanelForm($this);
84 * Save settings from the form
88 function saveSettings()
90 static $settings = array(
91 'bitly' => array('default_login', 'default_apikey')
96 foreach ($settings as $section => $parts) {
97 foreach ($parts as $setting) {
98 $values[$section][$setting]
99 = $this->trimmed($setting);
103 // This throws an exception on validation errors
105 $this->validate($values);
107 // assert(all values are valid);
109 $config = new Config();
111 $config->query('BEGIN');
113 foreach ($settings as $section => $parts) {
114 foreach ($parts as $setting) {
115 Config::save($section, $setting, $values[$section][$setting]);
119 $config->query('COMMIT');
124 function validate(&$values)
126 // Validate consumer key and secret (can't be too long)
128 if (mb_strlen($values['bitly']['default_apikey']) > 255) {
130 // TRANS: Client error displayed when using too long a key.
131 _m('Invalid login. Maximum length is 255 characters.')
135 if (mb_strlen($values['bitly']['default_apikey']) > 255) {
137 // TRANS: Client error displayed when using too long a key.
138 _m('Invalid API key. Maximum length is 255 characters.')
144 class BitlyAdminPanelForm extends AdminForm
149 * @return int ID of the form
153 return 'bitlyadminpanel';
159 * @return string class of the form
163 return 'form_settings';
169 * @return string URL of the action
173 return common_local_url('bitlyadminpanel');
177 * Data elements of the form
183 $this->out->elementStart(
185 array('id' => 'settings_bitly')
187 // TRANS: Fieldset legend in administration panel for bit.ly username and API key.
188 $this->out->element('legend', null, _m('LEGEND','Credentials'));
190 // Do we have global defaults to fall back on?
191 $login = $apiKey = false;
192 Event::handle('BitlyDefaultCredentials', array(&$login, &$apiKey));
193 $haveGlobalDefaults = ($login && $apiKey);
194 if ($login && $apiKey) {
195 $this->out->element('p', 'form_guide',
196 // TRANS: Form guide in administration panel for bit.ly URL shortening.
197 _m('Leave these empty to use global default credentials.'));
199 $this->out->element('p', 'form_guide',
200 // TRANS: Form guide in administration panel for bit.ly URL shortening.
201 _m('If you leave these empty, bit.ly will be unavailable to users.'));
203 $this->out->elementStart('ul', 'form_data');
208 // TRANS: Field label in administration panel for bit.ly URL shortening.
218 // TRANS: Field label in administration panel for bit.ly URL shortening.
225 $this->out->elementEnd('ul');
226 $this->out->elementEnd('fieldset');
234 function formActions()
236 $this->out->submit('submit',
237 // TRANS: Button text to save setting in administration panel for bit.ly URL shortening.
241 // TRANS: Button title to save setting in administration panel for bit.ly URL shortening.
242 _m('Save bit.ly settings'));