]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - actions/userdesignsettings.php
Merge remote branch 'origin/1.0.x' into 1.0.x
[quix0rs-gnu-social.git] / actions / userdesignsettings.php
index ec688d36dbbbe8a269ccfd9f3cf39517f4de001c..c83815412ad1407605f5cb048b9c7f2c7de9ef1a 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/designsettings.php';
 
+/**
+ * Set a user's design
+ *
+ * Saves a design for a given user
+ *
+ * @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 UserDesignSettingsAction extends DesignSettingsAction
 {
+    /**
+     * Sets the right action for the form, and passes request args into
+     * the base action
+     *
+     * @param array $args misc. arguments
+     *
+     * @return boolean true
+     */
 
     function prepare($args)
     {
@@ -49,9 +69,9 @@ class UserDesignSettingsAction extends DesignSettingsAction
      *
      * @return string Title of the page
      */
-
     function title()
     {
+        // TRANS: Title for profile design page.
         return _('Profile design');
     }
 
@@ -60,9 +80,9 @@ class UserDesignSettingsAction extends DesignSettingsAction
      *
      * @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.');
     }
@@ -72,16 +92,10 @@ class UserDesignSettingsAction extends DesignSettingsAction
      *
      * @return Design
      */
-
-    function getWorkingDesign() {
-
-        $user = common_current_user();
+    function getWorkingDesign()
+    {
+        $user   = common_current_user();
         $design = $user->getDesign();
-
-        if (empty($design)) {
-            $design = $this->defaultDesign();
-        }
-
         return $design;
     }
 
@@ -92,10 +106,29 @@ class UserDesignSettingsAction extends DesignSettingsAction
      *
      * @return void
      */
-
     function showContent()
     {
-        $this->showDesignForm($this->getWorkingDesign());
+        $design = $this->getWorkingDesign();
+
+        if (empty($design)) {
+            $design = Design::siteDesign();
+        }
+
+        $this->showDesignForm($design);
+    }
+
+    /**
+     * Shows the design settings form
+     *
+     * @param Design $design a working design to show
+     *
+     * @return nothing
+     */
+
+    function showDesignForm($design)
+    {
+        $form = new UserDesignForm($this, $design, $this->submitaction);
+        $form->show();
     }
 
     /**
@@ -103,9 +136,10 @@ class UserDesignSettingsAction extends DesignSettingsAction
      *
      * @return void
      */
-
     function saveDesign()
     {
+        $this->saveDesignPreferences();
+
         foreach ($this->args as $key => $val) {
             if (preg_match('/(#ho|ho)Td.*g/i', $val)) {
                 $this->sethd();
@@ -143,10 +177,10 @@ class UserDesignSettingsAction extends DesignSettingsAction
         }
 
         $user = common_current_user();
+
         $design = $user->getDesign();
 
         if (!empty($design)) {
-
             $original = clone($design);
 
             $design->backgroundcolor = $bgcolor->intValue();
@@ -161,13 +195,12 @@ class UserDesignSettingsAction extends DesignSettingsAction
 
             if ($result === false) {
                 common_log_db_error($design, 'UPDATE', __FILE__);
-                $this->showForm(_('Couldn\'t update your design.'));
+                // TRANS: Form validation error on Profile design page when updating design settings has failed.
+                $this->showForm(_('Could not update your design.'));
                 return;
             }
-
             // update design
         } else {
-
             $user->query('BEGIN');
 
             // save new design
@@ -185,17 +218,19 @@ class UserDesignSettingsAction extends DesignSettingsAction
 
             if (empty($id)) {
                 common_log_db_error($id, 'INSERT', __FILE__);
-                $this->showForm(_('Unable to save your design settings!'));
+                // TRANS: Form validation error on Profile design page when saving design settings has failed.
+                $this->showForm(_('Unable to save your design settings.'));
                 return;
             }
 
-            $original = clone($user);
+            $original        = clone($user);
             $user->design_id = $id;
-            $result = $user->update($original);
+            $result          = $user->update($original);
 
             if (empty($result)) {
                 common_log_db_error($original, 'UPDATE', __FILE__);
-                $this->showForm(_('Unable to save your design settings!'));
+                // TRANS: Form validation error on Profile design page when saving design settings has failed.
+                $this->showForm(_('Unable to save your design settings.'));
                 $user->query('ROLLBACK');
                 return;
             }
@@ -206,6 +241,7 @@ class UserDesignSettingsAction extends DesignSettingsAction
 
         $this->saveBackgroundImage($design);
 
+        // TRANS: Confirmation message on Profile design page when saving design settings has succeeded.
         $this->showForm(_('Design preferences saved.'), true);
     }
 
@@ -214,10 +250,9 @@ class UserDesignSettingsAction extends DesignSettingsAction
      *
      * @return nothing
      */
-
-    function sethd() {
-
-        $user = common_current_user();
+    function sethd()
+    {
+        $user   = common_current_user();
         $design = $user->getDesign();
 
         $user->query('BEGIN');
@@ -237,17 +272,19 @@ class UserDesignSettingsAction extends DesignSettingsAction
 
         if (empty($id)) {
             common_log_db_error($id, 'INSERT', __FILE__);
-            $this->showForm(_('Unable to save your design settings!'));
+            // TRANS: Form validation error on Profile design page when saving design settings has failed.
+            $this->showForm(_('Unable to save your design settings.'));
             return;
         }
 
-        $original = clone($user);
+        $original        = clone($user);
         $user->design_id = $id;
-        $result = $user->update($original);
+        $result          = $user->update($original);
 
         if (empty($result)) {
             common_log_db_error($original, 'UPDATE', __FILE__);
-            $this->showForm(_('Unable to save your design settings!'));
+            // TRANS: Form validation error on Profile design page when updating design settings has failed.
+            $this->showForm(_('Unable to save your design settings.'));
             $user->query('ROLLBACK');
             return;
         }
@@ -256,7 +293,73 @@ class UserDesignSettingsAction extends DesignSettingsAction
 
         $this->saveBackgroundImage($design);
 
+        // TRANS: Succes message on Profile design page when finding an easter egg.
         $this->showForm(_('Enjoy your hotdog!'), true);
     }
 
+    function saveDesignPreferences()
+    {
+        $viewdesigns = $this->boolean('viewdesigns');
+
+        $user = common_current_user();
+
+        $original = clone($user);
+
+        $user->viewdesigns = $viewdesigns;
+
+        $result = $user->update($original);
+
+        if ($result === false) {
+            common_log_db_error($user, 'UPDATE', __FILE__);
+            // TRANS: Server exception thrown on Profile design page when updating design settings fails.
+            throw new ServerException(_('Could not update user.'));
+        }
+    }
+}
+
+class UserDesignForm extends DesignForm
+{
+    function __construct($out, $design, $actionurl)
+    {
+        parent::__construct($out, $design, $actionurl);
+    }
+
+    /**
+     * Legend of the Form
+     *
+     * @return void
+     */
+    function formLegend()
+    {
+        // TRANS: Form legend on Profile design page.
+        $this->out->element('legend', null, _('Design settings'));
+    }
+
+    /**
+     * Data elements of the form
+     *
+     * @return void
+     */
+
+    function formData()
+    {
+        $user = common_current_user();
+
+        $this->out->elementStart('ul', 'form_data');
+        $this->out->elementStart('li');
+        // TRANS: Checkbox label on Profile design page.
+        $this->out->checkbox('viewdesigns', _('View profile designs'),
+                                                  // TRANS: Title for checkbox on Profile design page.
+                         -                        $user->viewdesigns, _('Show or hide profile designs.'));
+        $this->out->elementEnd('li');
+        $this->out->elementEnd('ul');
+
+        $this->out->elementEnd('fieldset');
+
+        $this->out->elementStart('fieldset');
+        // TRANS: Form legend on Profile design page for form to choose a background image.
+        $this->out->element('legend', null, _('Background file'));
+
+        parent::formData();
+    }
 }