github-36: support default settings

Author: ArturMoczulski

src/Plugin.php

@@ -81,20 +81,29 @@ private function fetchSettings() {
                 trim($options['client_side_access_token']) : 
                 '',
 
-            'environment' => (!empty($options['environment'])) ? 
-                esc_attr(trim($options['environment'])) : 
-                '',
-            
             'logging_level' => (!empty($options['logging_level'])) ? 
                 esc_attr(trim($options['logging_level'])) : 
                 Settings::DEFAULT_LOGGING_LEVEL
         );
 
         foreach (\Rollbar\Config::listOptions() as $option) {
 
-            $settings[$option] = (!empty($options[$option])) ? 
-                esc_attr(trim($options[$option])) : 
-                '';
+            $value = $options[$option];
+            
+            if (!empty($value)) {
+                
+                if (is_string($value)) {
+                    $value = esc_attr(trim($value));
+                } else if (is_array($value)) {
+                    // TODO: convert array to PHP code
+                    $value = $value;
+                }
+                
+            } else {
+                $value = $this->getDefaultOption($option);
+            }
+            
+            $settings[$option] = $value;
 
         }
 
@@ -261,6 +270,42 @@ public function buildJsConfig()
 
         return $rollbarJsConfig;
     }
+    
+    public function updateSettings(array $settings)
+    {
+        $option = get_option('rollbar_wp');
+        
+        $option = array_merge($option, $settings);
+        
+        foreach ($settings as $setting => $value) {
+            $this->settings[$setting] = $value;
+        }
+        
+        update_option('rollbar_wp', $option);
+    }
+    
+    public function restoreDefaults()
+    {
+        $settings = array();
+        
+        foreach (\Rollbar\Config::listOptions() as $option) {
+            $settings[$option] = $this->getDefaultOption($option);
+        }
+        
+        $this->updateSettings($settings);
+    }
+    
+    public function getDefaultOption($setting)
+    {
+        $defaults = \Rollbar\Defaults::get();
+        $method = lcfirst(str_replace('_', '', ucwords($setting, '_')));
+        
+        if (method_exists($defaults, $method)) {
+            return $defaults->$method();
+        }
+        
+        return null;
+    }
 }
 
 \add_action( 'plugins_loaded', '\Rollbar\Wordpress\Plugin::load' );

src/Settings.php

@@ -33,7 +33,6 @@ public static function init() {
         $instance = self::instance();
         \add_action('admin_menu', array(&$instance, 'addAdminMenu'));
         \add_action('admin_init', array(&$instance, 'addSettings'));
-        
         \add_action('admin_enqueue_scripts', function($hook) {
 
             if ($hook != 'settings_page_rollbar_wp') {
@@ -82,7 +81,17 @@ public static function init() {
             );
             \wp_enqueue_style('RollbarWordpressSettings');
         });
+        
+        \add_action('init', array(get_called_class(), 'registerSession'));
 
+        \add_action('admin_post_rollbar_wp_restore_defaults', array(get_called_class(), 'restoreDefaultsAction'));
+    }
+    
+    public static function registerSession()
+    {
+        if( !session_id() ) {
+            session_start();
+        }
     }
 
     function addAdminMenu()
@@ -252,7 +261,16 @@ function accessTokenRender()
 
     function optionsPage()
     {
-
+        
+        if (isset($_SESSION['rollbar_wp_flash_message'])) {
+            ?>
+            <div class="<?php echo $_SESSION['rollbar_wp_flash_message']['type']; ?> notice is-dismissable">
+                <p><?php echo $_SESSION['rollbar_wp_flash_message']['message']; ?></p>
+            </div>
+            <?php
+            unset($_SESSION['rollbar_wp_flash_message']);
+        }
+        
         ?>
         <form action='options.php' method='post'>
 
@@ -267,16 +285,27 @@ function optionsPage()
             <?php
             \submit_button();
             ?>
-            
-            <button 
-                type="button" 
-                class="button button-secondary"
-                name="test-logging"
-                id="rollbar_wp_test_logging">
-                Send test message to Rollbar
-            </button>
 
         </form>
+        
+        <form action="<?php echo esc_url( admin_url('admin-post.php') ); ?>" method="post">
+            <input type="hidden" name="action" value="rollbar_wp_restore_defaults" />
+            <input 
+                type="submit" 
+                class="button button-secondary"
+                name="restore-defaults"
+                id="rollbar_wp_restore_defaults"
+                value="Restore defaults"
+            />
+        </form>
+        
+        <button
+            type="button" 
+            class="button button-secondary"
+            name="test-logging"
+            id="rollbar_wp_test_logging">
+            Send test message to Rollbar
+        </button>
         <?php
     }
 
@@ -298,6 +327,38 @@ private function parseOptionDetails($option)
 
         return $desc;
     }
+    
+    public function getDefaultSetting($setting)
+    {
+        $defaults = \Rollbar\Defaults::get();
+        $method = lcfirst(str_replace('_', '', ucwords($setting, '_')));
+        
+        if (method_exists($defaults, $method)) {
+            return $defaults->$method();
+        }
+        
+        return null;
+    }
+    
+    public static function restoreDefaultsAction()
+    {
+        \Rollbar\Wordpress\Plugin::instance()->restoreDefaults();
+        
+        self::flashRedirect(
+            "updated", 
+            __("Default Rollbar settings restored.", "rollbar")
+        );
+    }
+    
+    public static function flashRedirect($type, $message)
+    {
+        $_SESSION['rollbar_wp_flash_message'] = array(
+            "type" => $type,
+            "message" => $message
+        );
+        
+        wp_redirect(admin_url('/options-general.php?page=rollbar_wp'));
+    }
 }
 
 ?>

src/UI.php

@@ -193,7 +193,7 @@ public function getIncludedErrnoDescriptions($value)
         'base_api_url' => self::SETTING_INPUT_TYPE_SKIP,
         'branch' => self::SETTING_INPUT_TYPE_TEXT,
         'capture_error_stacktraces' => self::SETTING_INPUT_TYPE_BOOLEAN,
-        'checkIgnore' => self::SETTING_INPUT_TYPE_PHP,
+        'check_ignore' => self::SETTING_INPUT_TYPE_PHP,
         'code_version' => self::SETTING_INPUT_TYPE_TEXT,
         'custom' => self::SETTING_INPUT_TYPE_PHP,
         'enable_utf8_sanitization' => self::SETTING_INPUT_TYPE_BOOLEAN,

tests/SettingsTest.php

@@ -0,0 +1,25 @@
+<?php
+namespace Rollbar\Wordpress\Tests;
+
+use Rollbar\Payload\Level;
+
+/**
+ * Class SettingsTest
+ *
+ * @package Rollbar\Wordpress\Tests
+ */
+class SettingsTest extends BaseTestCase {
+    
+    private $subject;
+    
+    public function setUp()
+    {
+        $this->subject = \Rollbar\Wordpress\Settings::instance();
+    }
+    
+    public function testGetDefaultSetting()
+    {
+        $this->assertEquals('production', $this->subject->getDefaultSetting('environment'));
+        $this->assertTrue($this->subject->getDefaultSetting('capture_error_stacktraces'));
+    }
+}