plugins/BitlyUrl/bitlyadminpanelaction.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Admin panel for plugin to use bit.ly URL shortening services.
   6  *
   7  * PHP version 5
   8  *
   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.
  13  *
  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.
  18  *
  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/>.
  21  *
  22  * @category  Settings
  23  * @package   StatusNet
  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/
  28  */
  29
  30 if (!defined('STATUSNET')) {
  31     exit(1);
  32 }
  33
  34 /**
  35  * Administer global bit.ly URL shortener settings
  36  *
  37  * @category Admin
  38  * @package  StatusNet
  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/
  42  */
  43 class BitlyadminpanelAction extends AdminPanelAction
  44 {
  45     /**
  46      * Returns the page title
  47      *
  48      * @return string page title
  49      */
  50     function title()
  51     {
  52         // TRANS: Title of administration panel.
  53         return _m('bit.ly URL shortening');
  54     }
  55
  56     /**
  57      * Instructions for using this form.
  58      *
  59      * @return string instructions
  60      */
  61     function getInstructions()
  62     {
  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.');
  69     }
  70
  71     /**
  72      * Show the bit.ly admin panel form
  73      *
  74      * @return void
  75      */
  76     function showForm()
  77     {
  78         $form = new BitlyAdminPanelForm($this);
  79         $form->show();
  80         return;
  81     }
  82
  83     /**
  84      * Save settings from the form
  85      *
  86      * @return void
  87      */
  88     function saveSettings()
  89     {
  90         static $settings = array(
  91             'bitly' => array('default_login', 'default_apikey')
  92         );
  93
  94         $values = array();
  95
  96         foreach ($settings as $section => $parts) {
  97             foreach ($parts as $setting) {
  98                 $values[$section][$setting]
  99                     = $this->trimmed($setting);
 100             }
 101         }
 102
 103         // This throws an exception on validation errors
 104
 105         $this->validate($values);
 106
 107         // assert(all values are valid);
 108
 109         $config = new Config();
 110
 111         $config->query('BEGIN');
 112
 113         foreach ($settings as $section => $parts) {
 114             foreach ($parts as $setting) {
 115                 Config::save($section, $setting, $values[$section][$setting]);
 116             }
 117         }
 118
 119         $config->query('COMMIT');
 120
 121         return;
 122     }
 123
 124     function validate(&$values)
 125     {
 126         // Validate consumer key and secret (can't be too long)
 127
 128         if (mb_strlen($values['bitly']['default_apikey']) > 255) {
 129             $this->clientError(
 130                 // TRANS: Client error displayed when using too long a key.
 131                 _m('Invalid login. Maximum length is 255 characters.')
 132             );
 133         }
 134
 135         if (mb_strlen($values['bitly']['default_apikey']) > 255) {
 136             $this->clientError(
 137                 // TRANS: Client error displayed when using too long a key.
 138                 _m('Invalid API key. Maximum length is 255 characters.')
 139             );
 140         }
 141     }
 142 }
 143
 144 class BitlyAdminPanelForm extends AdminForm
 145 {
 146     /**
 147      * ID of the form
 148      *
 149      * @return int ID of the form
 150      */
 151     function id()
 152     {
 153         return 'bitlyadminpanel';
 154     }
 155
 156     /**
 157      * class of the form
 158      *
 159      * @return string class of the form
 160      */
 161     function formClass()
 162     {
 163         return 'form_settings';
 164     }
 165
 166     /**
 167      * Action of the form
 168      *
 169      * @return string URL of the action
 170      */
 171     function action()
 172     {
 173         return common_local_url('bitlyadminpanel');
 174     }
 175
 176     /**
 177      * Data elements of the form
 178      *
 179      * @return void
 180      */
 181     function formData()
 182     {
 183         $this->out->elementStart(
 184             'fieldset',
 185             array('id' => 'settings_bitly')
 186         );
 187         // TRANS: Fieldset legend in administration panel for bit.ly username and API key.
 188         $this->out->element('legend', null, _m('LEGEND','Credentials'));
 189
 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.'));
 198         } else {
 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.'));
 202         }
 203         $this->out->elementStart('ul', 'form_data');
 204
 205         $this->li();
 206         $this->input(
 207             'default_login',
 208             // TRANS: Field label in administration panel for bit.ly URL shortening.
 209             _m('Login name'),
 210             null,
 211             'bitly'
 212         );
 213         $this->unli();
 214
 215         $this->li();
 216         $this->input(
 217             'default_apikey',
 218             // TRANS: Field label in administration panel for bit.ly URL shortening.
 219              _m('API key'),
 220             null,
 221             'bitly'
 222         );
 223         $this->unli();
 224
 225         $this->out->elementEnd('ul');
 226         $this->out->elementEnd('fieldset');
 227     }
 228
 229     /**
 230      * Action elements
 231      *
 232      * @return void
 233      */
 234     function formActions()
 235     {
 236         $this->out->submit('submit',
 237                            // TRANS: Button text to save setting in administration panel for bit.ly URL shortening.
 238                            _m('BUTTON','Save'),
 239                            'submit',
 240                            null,
 241                            // TRANS: Button title to save setting in administration panel for bit.ly URL shortening.
 242                            _m('Save bit.ly settings'));
 243     }
 244 }