]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - lib/designsettings.php
Fixes for ticket #3052: some commands started triggering when extra text is supposed...
[quix0rs-gnu-social.git] / lib / designsettings.php
index 9650679ac5b620c51f356c1d57d07e3235abfbac..d7da0b77d8cf3ca2811e1c35c8ce0d05c7d3c7b9 100644 (file)
@@ -1,6 +1,6 @@
 <?php
 /**
- * Laconica, the distributed open-source microblogging tool
+ * StatusNet, the distributed open-source microblogging tool
  *
  * Change user password
  *
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  *
  * @category  Settings
- * @package   Laconica
- * @author    Sarven Capadisli <csarven@controlyourself.ca>
- * @author    Zach Copley <zach@controlyourself.ca>
- * @copyright 2008-2009 Control Yourself, Inc.
+ * @package   StatusNet
+ * @author    Sarven Capadisli <csarven@status.net>
+ * @author    Zach Copley <zach@status.net>
+ * @copyright 2008-2009 StatusNet, Inc.
  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
- * @link      http://laconi.ca/
+ * @link      http://status.net/
  */
 
-if (!defined('LACONICA')) {
+if (!defined('STATUSNET') && !defined('LACONICA')) {
     exit(1);
 }
 
 require_once INSTALLDIR . '/lib/accountsettingsaction.php';
 require_once INSTALLDIR . '/lib/webcolor.php';
 
+/**
+ * Base class for setting a user or group design
+ *
+ * Shows the design setting form and also handles some things like saving
+ * background images, and fetching a default design
+ *
+ * @category Settings
+ * @package  StatusNet
+ * @author   Zach Copley <zach@status.net>
+ * @author   Sarven Capadisli <csarven@status.net>
+ * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link     http://status.net/
+ */
 class DesignSettingsAction extends AccountSettingsAction
 {
-
     var $submitaction = null;
 
     /**
@@ -45,9 +57,9 @@ class DesignSettingsAction extends AccountSettingsAction
      *
      * @return string Title of the page
      */
-
     function title()
     {
+        // TRANS: Page title for profile design page.
         return _('Profile design');
     }
 
@@ -56,16 +68,22 @@ class DesignSettingsAction extends AccountSettingsAction
      *
      * @return instructions for use
      */
-
     function getInstructions()
     {
+        // TRANS: Instructions for profile design page.
         return _('Customize the way your profile looks ' .
         'with a background image and a colour palette of your choice.');
     }
 
+    /**
+     * Shows the design settings form
+     *
+     * @param Design $design a working design to show
+     *
+     * @return nothing
+     */
     function showDesignForm($design)
     {
-
         $this->elementStart('form', array('method' => 'post',
                                           'enctype' => 'multipart/form-data',
                                           'id' => 'form_settings_design',
@@ -76,25 +94,29 @@ class DesignSettingsAction extends AccountSettingsAction
 
         $this->elementStart('fieldset', array('id' =>
             'settings_design_background-image'));
+        // TRANS: Fieldset legend on profile design page.
         $this->element('legend', null, _('Change background image'));
         $this->elementStart('ul', 'form_data');
         $this->elementStart('li');
+        $this->element('input', array('name' => 'MAX_FILE_SIZE',
+                                      'type' => 'hidden',
+                                      'id' => 'MAX_FILE_SIZE',
+                                      'value' => ImageFile::maxFileSizeInt()));
         $this->element('label', array('for' => 'design_background-image_file'),
+                                // TRANS: Label in form on profile design page.
+                                // TRANS: Field contains file name on user's computer that could be that user's custom profile background image.
                                 _('Upload file'));
         $this->element('input', array('name' => 'design_background-image_file',
                                       'type' => 'file',
                                       'id' => 'design_background-image_file'));
+        // TRANS: Instructions for form on profile design page.
         $this->element('p', 'form_guide', _('You can upload your personal ' .
-            'background image. The maximum file size is 2Mb.'));
-        $this->element('input', array('name' => 'MAX_FILE_SIZE',
-                                      'type' => 'hidden',
-                                      'id' => 'MAX_FILE_SIZE',
-                                      'value' => ImageFile::maxFileSizeInt()));
+            'background image. The maximum file size is 2MB.'));
         $this->elementEnd('li');
 
         if (!empty($design->backgroundimage)) {
-
-            $this->elementStart('li', array('id' => 'design_background-image_onoff'));
+            $this->elementStart('li', array('id' =>
+                'design_background-image_onoff'));
 
             $this->element('img', array('src' =>
                 Design::url($design->backgroundimage)));
@@ -113,7 +135,8 @@ class DesignSettingsAction extends AccountSettingsAction
 
             $this->element('label', array('for' => 'design_background-image_on',
                                           'class' => 'radio'),
-                                          _('On'));
+                                          // TRANS: Radio button on profile design page that will enable use of the uploaded profile image.
+                                          _m('RADIO','On'));
 
             $attrs = array('name' => 'design_background-image_onoff',
                            'type' => 'radio',
@@ -129,14 +152,18 @@ class DesignSettingsAction extends AccountSettingsAction
 
             $this->element('label', array('for' => 'design_background-image_off',
                                           'class' => 'radio'),
-                                          _('Off'));
+                                          // TRANS: Radio button on profile design page that will disable use of the uploaded profile image.
+                                          _m('RADIO','Off'));
+            // TRANS: Form guide for a set of radio buttons on the profile design page that will enable or disable
+            // TRANS: use of the uploaded profile image.
             $this->element('p', 'form_guide', _('Turn background image on or off.'));
             $this->elementEnd('li');
 
             $this->elementStart('li');
             $this->checkbox('design_background-image_repeat',
+                            // TRANS: Checkbox label on profile design page that will cause the profile image to be tiled.
                             _('Tile background image'),
-                            ($design->disposition & BACKGROUND_TILE) ? true : false );
+                            ($design->disposition & BACKGROUND_TILE) ? true : false);
             $this->elementEnd('li');
         }
 
@@ -144,14 +171,15 @@ class DesignSettingsAction extends AccountSettingsAction
         $this->elementEnd('fieldset');
 
         $this->elementStart('fieldset', array('id' => 'settings_design_color'));
+        // TRANS: Fieldset legend on profile design page to change profile page colours.
         $this->element('legend', null, _('Change colours'));
         $this->elementStart('ul', 'form_data');
 
         try {
-
             $bgcolor = new WebColor($design->backgroundcolor);
 
             $this->elementStart('li');
+            // TRANS: Label on profile design page for setting a profile page background colour.
             $this->element('label', array('for' => 'swatch-1'), _('Background'));
             $this->element('input', array('name' => 'design_background',
                                           'type' => 'text',
@@ -159,12 +187,13 @@ class DesignSettingsAction extends AccountSettingsAction
                                           'class' => 'swatch',
                                           'maxlength' => '7',
                                           'size' => '7',
-                                          'value' => '#' . $bgcolor->hexValue()));
+                                          'value' => ''));
             $this->elementEnd('li');
 
             $ccolor = new WebColor($design->contentcolor);
 
             $this->elementStart('li');
+            // TRANS: Label on profile design page for setting a profile page content colour.
             $this->element('label', array('for' => 'swatch-2'), _('Content'));
             $this->element('input', array('name' => 'design_content',
                                           'type' => 'text',
@@ -172,12 +201,13 @@ class DesignSettingsAction extends AccountSettingsAction
                                           'class' => 'swatch',
                                           'maxlength' => '7',
                                           'size' => '7',
-                                          'value' => '#' . $ccolor->hexValue()));
+                                          'value' => ''));
             $this->elementEnd('li');
 
             $sbcolor = new WebColor($design->sidebarcolor);
 
             $this->elementStart('li');
+            // TRANS: Label on profile design page for setting a profile page sidebar colour.
             $this->element('label', array('for' => 'swatch-3'), _('Sidebar'));
             $this->element('input', array('name' => 'design_sidebar',
                                         'type' => 'text',
@@ -185,12 +215,13 @@ class DesignSettingsAction extends AccountSettingsAction
                                         'class' => 'swatch',
                                         'maxlength' => '7',
                                         'size' => '7',
-                                        'value' => '#' . $sbcolor->hexValue()));
+                                        'value' => ''));
             $this->elementEnd('li');
 
             $tcolor = new WebColor($design->textcolor);
 
             $this->elementStart('li');
+            // TRANS: Label on profile design page for setting a profile page text colour.
             $this->element('label', array('for' => 'swatch-4'), _('Text'));
             $this->element('input', array('name' => 'design_text',
                                         'type' => 'text',
@@ -198,12 +229,13 @@ class DesignSettingsAction extends AccountSettingsAction
                                         'class' => 'swatch',
                                         'maxlength' => '7',
                                         'size' => '7',
-                                        'value' => '#' . $tcolor->hexValue()));
+                                        'value' => ''));
             $this->elementEnd('li');
 
             $lcolor = new WebColor($design->linkcolor);
 
             $this->elementStart('li');
+            // TRANS: Label on profile design page for setting a profile page links colour.
             $this->element('label', array('for' => 'swatch-5'), _('Links'));
             $this->element('input', array('name' => 'design_links',
                                          'type' => 'text',
@@ -211,25 +243,32 @@ class DesignSettingsAction extends AccountSettingsAction
                                          'class' => 'swatch',
                                          'maxlength' => '7',
                                          'size' => '7',
-                                         'value' => '#' . $lcolor->hexValue()));
+                                         'value' => ''));
+            $this->elementEnd('li');
 
-           $this->elementEnd('li');
+        } catch (WebColorException $e) {
+            common_log(LOG_ERR, 'Bad color values in design ID: ' .$design->id);
+        }
 
-       } catch (WebColorException $e) {
-           common_log(LOG_ERR, 'Bad color values in design ID: ' .
-               $design->id);
-       }
+        $this->elementEnd('ul');
+        $this->elementEnd('fieldset');
 
-       $this->elementEnd('ul');
-       $this->elementEnd('fieldset');
+        // TRANS: Button text on profile design page to immediately reset all colour settings to default.
+        $this->submit('defaults', _('Use defaults'), 'submit form_action-default',
+            // TRANS: Title for button on profile design page to reset all colour settings to default.
+            'defaults', _('Restore default designs'));
 
-       $this->element('input', array('id' => 'settings_design_reset',
+        $this->element('input', array('id' => 'settings_design_reset',
                                      'type' => 'reset',
-                                     'value' => 'Reset',
+                                     // TRANS: Button text on profile design page to reset all colour settings to default without saving.
+                                     'value' => _m('BUTTON','Reset'),
                                      'class' => 'submit form_action-primary',
+                                     // TRANS: Title for button on profile design page to reset all colour settings to default without saving.
                                      'title' => _('Reset back to default')));
 
-        $this->submit('save', _('Save'), 'submit form_action-secondary',
+        // TRANS: Button text on profile design page to save settings.
+        $this->submit('save', _m('BUTTON','Save'), 'submit form_action-secondary',
+            // TRANS: Title for button on profile design page to save settings.
             'save', _('Save design'));
 
         $this->elementEnd('fieldset');
@@ -244,20 +283,24 @@ class DesignSettingsAction extends AccountSettingsAction
      *
      * @return void
      */
-
     function handlePost()
     {
-        // XXX: Robin's workaround for a bug in PHP where $_POST
-        // and $_FILE are empty in the case that the uploaded
-        // file is bigger than PHP is configured to handle.
-
         if ($_SERVER['REQUEST_METHOD'] == 'POST') {
-            if (empty($_POST) && $_SERVER['CONTENT_LENGTH']) {
 
-                $msg = _('The server was unable to handle that much POST ' .
-                    'data (%s bytes) due to its current configuration.');
+            // Workaround for PHP returning empty $_POST and $_FILES when POST
+            // length > post_max_size in php.ini
+
+            if (empty($_FILES)
+                && empty($_POST)
+                && ($_SERVER['CONTENT_LENGTH'] > 0)
+            ) {
+                // TRANS: Form validation error in design settings form. POST should remain untranslated.
+                $msg = _m('The server was unable to handle that much POST data (%s byte) due to its current configuration.',
+                          'The server was unable to handle that much POST data (%s bytes) due to its current configuration.',
+                          intval($_SERVER['CONTENT_LENGTH']));
 
                 $this->showForm(sprintf($msg, $_SERVER['CONTENT_LENGTH']));
+                return;
             }
         }
 
@@ -271,9 +314,10 @@ class DesignSettingsAction extends AccountSettingsAction
 
         if ($this->arg('save')) {
             $this->saveDesign();
-        } else if ($this->arg('reset')) {
-            $this->resetDesign();
+        } else if ($this->arg('defaults')) {
+            $this->restoreDefaults();
         } else {
+            // TRANS: Unknown form validation error in design settings form.
             $this->showForm(_('Unexpected form submission.'));
         }
     }
@@ -283,17 +327,10 @@ class DesignSettingsAction extends AccountSettingsAction
      *
      * @return void
      */
-
     function showStylesheets()
     {
         parent::showStylesheets();
-        $farbtasticStyle =
-          common_path('theme/base/css/farbtastic.css?version='.LACONICA_VERSION);
-
-        $this->element('link', array('rel' => 'stylesheet',
-                                     'type' => 'text/css',
-                                     'href' => $farbtasticStyle,
-                                     'media' => 'screen, projection, tv'));
+        $this->cssLink('js/farbtastic/farbtastic.css',null,'screen, projection, tv');
     }
 
     /**
@@ -301,65 +338,25 @@ class DesignSettingsAction extends AccountSettingsAction
      *
      * @return void
      */
-
     function showScripts()
     {
         parent::showScripts();
 
-        $farbtasticPack = common_path('js/farbtastic/farbtastic.js');
-        $userDesignGo   = common_path('js/userdesign.go.js');
+        $this->script('farbtastic/farbtastic.js');
+        $this->script('userdesign.go.js');
 
-        $this->element('script', array('type' => 'text/javascript',
-                                       'src' => $farbtasticPack));
-        $this->element('script', array('type' => 'text/javascript',
-                                       'src' => $userDesignGo));
+        $this->autofocus('design_background-image_file');
     }
 
     /**
-     * Get a default user design
+     * Save the background image, if any, and set its disposition
+     *
+     * @param Design $design a working design to attach the img to
      *
-     * @return Design design
+     * @return nothing
      */
-
-    function defaultDesign()
+    function saveBackgroundImage($design)
     {
-        $defaults = common_config('site', 'design');
-
-        $design = new Design();
-
-        try {
-
-            $color = new WebColor();
-
-            $color->parseColor($defaults['backgroundcolor']);
-            $design->backgroundcolor = $color->intValue();
-
-            $color->parseColor($defaults['contentcolor']);
-            $design->contentcolor = $color->intValue();
-
-            $color->parseColor($defaults['sidebarcolor']);
-            $design->sidebarcolor = $color->intValue();
-
-            $color->parseColor($defaults['textcolor']);
-            $design->textcolor = $color->intValue();
-
-            $color->parseColor($defaults['linkcolor']);
-            $design->linkcolor = $color->intValue();
-
-            $design->backgroundimage = $defaults['backgroundimage'];
-
-            $design->disposition = $defaults['disposition'];
-
-        } catch (WebColorException $e) {
-            common_log(LOG_ERR, _('Bad default color settings: ' .
-                $e->getMessage()));
-        }
-
-        return $design;
-    }
-
-    function saveBackgroundImage($design) {
-
         // Now that we have a Design ID we can add a file to the design.
         // XXX: This is an additional DB hit, but figured having the image
         // associated with the Design rather than the User was worth
@@ -371,12 +368,12 @@ class DesignSettingsAction extends AccountSettingsAction
             $filepath = null;
 
             try {
-                    $imagefile =
-                        ImageFile::fromUpload('design_background-image_file');
-                } catch (Exception $e) {
-                    $this->showForm($e->getMessage());
-                    return;
-                }
+                $imagefile =
+                    ImageFile::fromUpload('design_background-image_file');
+            } catch (Exception $e) {
+                $this->showForm($e->getMessage());
+                return;
+            }
 
             $filename = Design::filename($design->id,
                 image_type_to_extension($imagefile->type),
@@ -386,7 +383,14 @@ class DesignSettingsAction extends AccountSettingsAction
 
             move_uploaded_file($imagefile->filepath, $filepath);
 
+            // delete any old backround img laying around
+
+            if (isset($design->backgroundimage)) {
+                @unlink(Design::path($design->backgroundimage));
+            }
+
             $original = clone($design);
+
             $design->backgroundimage = $filename;
 
             // default to on, no tile
@@ -397,10 +401,35 @@ class DesignSettingsAction extends AccountSettingsAction
 
             if ($result === false) {
                 common_log_db_error($design, 'UPDATE', __FILE__);
+                // TRANS: Error message displayed if design settings could not be saved.
                 $this->showForm(_('Couldn\'t update your design.'));
                 return;
             }
         }
     }
 
+    /**
+     * Restore the user or group design to system defaults
+     *
+     * @return nothing
+     */
+    function restoreDefaults()
+    {
+        $design = $this->getWorkingDesign();
+
+        if (!empty($design)) {
+
+            $result = $design->delete();
+
+            if ($result === false) {
+                common_log_db_error($design, 'DELETE', __FILE__);
+                // TRANS: Error message displayed if design settings could not be saved after clicking "Use defaults".
+                $this->showForm(_('Couldn\'t update your design.'));
+                return;
+            }
+        }
+
+        // TRANS: Success message displayed if design settings were saved after clicking "Use defaults".
+        $this->showForm(_('Design defaults restored.'), true);
+    }
 }