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
  44 class BitlyadminpanelAction extends AdminPanelAction
  45 {
  46     /**
  47      * Returns the page title
  48      *
  49      * @return string page title
  50      */
  51
  52     function title()
  53     {
  54         return _m('bit.ly URL shortening');
  55     }
  56
  57     /**
  58      * Instructions for using this form.
  59      *
  60      * @return string instructions
  61      */
  62
  63     function getInstructions()
  64     {
  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
  77     function showForm()
  78     {
  79         $form = new BitlyAdminPanelForm($this);
  80         $form->show();
  81         return;
  82     }
  83
  84     /**
  85      * Save settings from the form
  86      *
  87      * @return void
  88      */
  89
  90     function saveSettings()
  91     {
  92         static $settings = array(
  93             'bitly' => array('default_login', 'default_apikey')
  94         );
  95
  96         $values = array();
  97
  98         foreach ($settings as $section => $parts) {
  99             foreach ($parts as $setting) {
 100                 $values[$section][$setting]
 101                     = $this->trimmed($setting);
 102             }
 103         }
 104
 105         // This throws an exception on validation errors
 106
 107         $this->validate($values);
 108
 109         // assert(all values are valid);
 110
 111         $config = new Config();
 112
 113         $config->query('BEGIN');
 114
 115         foreach ($settings as $section => $parts) {
 116             foreach ($parts as $setting) {
 117                 Config::save($section, $setting, $values[$section][$setting]);
 118             }
 119         }
 120
 121         $config->query('COMMIT');
 122
 123         return;
 124     }
 125
 126     function validate(&$values)
 127     {
 128         // Validate consumer key and secret (can't be too long)
 129
 130         if (mb_strlen($values['bitly']['default_apikey']) > 255) {
 131             $this->clientError(
 132                 _m("Invalid login. Max length is 255 characters.")
 133             );
 134         }
 135
 136         if (mb_strlen($values['bitly']['default_apikey']) > 255) {
 137             $this->clientError(
 138                 _m("Invalid API key. Max 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
 152     function id()
 153     {
 154         return 'bitlyadminpanel';
 155     }
 156
 157     /**
 158      * class of the form
 159      *
 160      * @return string class of the form
 161      */
 162
 163     function formClass()
 164     {
 165         return 'form_settings';
 166     }
 167
 168     /**
 169      * Action of the form
 170      *
 171      * @return string URL of the action
 172      */
 173
 174     function action()
 175     {
 176         return common_local_url('bitlyadminpanel');
 177     }
 178
 179     /**
 180      * Data elements of the form
 181      *
 182      * @return void
 183      */
 184
 185     function formData()
 186     {
 187         $this->out->elementStart(
 188             'fieldset',
 189             array('id' => 'settings_bitly')
 190         );
 191         $this->out->element('legend', null, _m('Credentials'));
 192
 193         // Do we have global defaults to fall back on?
 194         $login = $apiKey = false;
 195         Event::handle('BitlyDefaultCredentials', array(&$login, &$apiKey));
 196         $haveGlobalDefaults = ($login && $apiKey);
 197         if ($login && $apiKey) {
 198             $this->out->element('p', 'form_guide',
 199                 _m('Leave these empty to use global default credentials.'));
 200         } else {
 201             $this->out->element('p', 'form_guide',
 202                 _m('If you leave these empty, bit.ly will be unavailable to users.'));
 203         }
 204         $this->out->elementStart('ul', 'form_data');
 205
 206         $this->li();
 207         $this->input(
 208             'default_login',
 209             _m('Login name'),
 210             null,
 211             'bitly'
 212         );
 213         $this->unli();
 214
 215         $this->li();
 216         $this->input(
 217             'default_apikey',
 218              _m('API key'),
 219             null,
 220             'bitly'
 221         );
 222         $this->unli();
 223
 224         $this->out->elementEnd('ul');
 225         $this->out->elementEnd('fieldset');
 226     }
 227
 228     /**
 229      * Action elements
 230      *
 231      * @return void
 232      */
 233
 234     function formActions()
 235     {
 236         $this->out->submit('submit',
 237                            _m('BUTTON','Save'),
 238                            'submit',
 239                            null,
 240                            _m('Save bit.ly settings'));
 241     }
 242 }