Back - Standardlized operations on reserved keys

Author: Colin Yang

backend/class/api/Getvalue.class.php

@@ -3,7 +3,7 @@
 class ApiGetvalue extends Api {
 
   static function checkAllowBrowser() {
-    if (json_decode(DbProvider::getDb()->get(DbBase::$KEY_MANAGE_SETTINGS), true)['allow_browser'] === 'false'
+    if (json_decode(DbProvider::getDb()->getReserved(DbBase::$KEY_MANAGE_SETTINGS), true)['allow_browser'] === 'false'
         && (isset($_SERVER['HTTP_ORIGIN'])
          || isset($_SERVER['HTTP_REFERER'])
          || isset($_SERVER['HTTP_USER_AGENT'])
@@ -15,7 +15,7 @@ static function checkAllowBrowser() {
   }
 
   private function handleSpecialTags($key) {
-    $settings = json_decode(DbProvider::getDb()->get(DbBase::$KEY_MANAGE_SETTINGS), true);
+    $settings = json_decode(DbProvider::getDb()->getReserved(DbBase::$KEY_MANAGE_SETTINGS), true);
     $special_tags = isset($settings['special_tags']) ? json_decode($settings['special_tags'], true) : [];
     $tag_count = !isset($special_tags['count'])
         ? 'disabled'

backend/class/api/Manage.class.php

@@ -3,7 +3,7 @@
 class ApiManage extends Api {
 
   private static function password() {
-    return DbProvider::getDb()->get(DbBase::$KEY_MANAGE_PASSWORD);
+    return DbProvider::getDb()->getReserved(DbBase::$KEY_MANAGE_PASSWORD);
   }
   private static function initialized() {
     return self::password() !== false;
@@ -29,12 +29,12 @@ private static function saltPassword($pwd) {
   }
 
   private static function settings() {
-    return json_decode(DbProvider::getDb()->get(DbBase::$KEY_MANAGE_SETTINGS), true);
+    return json_decode(DbProvider::getDb()->getReserved(DbBase::$KEY_MANAGE_SETTINGS), true);
   }
   private static function updateSetting($settingId, $value) {
     $settings = self::settings();
     $settings[$settingId] = $value;
-    DbProvider::getDb()->set(DbBase::$KEY_MANAGE_SETTINGS, json_encode($settings));
+    DbProvider::getDb()->setReserved(DbBase::$KEY_MANAGE_SETTINGS, json_encode($settings));
   }
 
   function handle() {
@@ -78,7 +78,7 @@ function handle() {
             return [ 'status' => STATUS_PASSWORD_INVALID, 'result' => 'Password should contains at least two of [0-9] [a-z] [!@#$%^&*]' ];
           }
           $pwd = self::saltPassword($pwd);
-          DbProvider::getDb()->set(DbBase::$KEY_MANAGE_PASSWORD, $pwd);
+          DbProvider::getDb()->setReserved(DbBase::$KEY_MANAGE_PASSWORD, $pwd);
           return [ 'result' => $generateSession($pwd) ];
         }
       }
@@ -144,7 +144,7 @@ function handle() {
         return [ 'result' => 'All data erased (except for reserved keys)' ];
       }
       case 'erase_pwd': {
-        DbProvider::getDb()->delete(DbBase::$KEY_MANAGE_PASSWORD);
+        DbProvider::getDb()->deleteReserved(DbBase::$KEY_MANAGE_PASSWORD);
         return [ 'result' => 'Password deleted, please set a new one ASAP' ];
       }
       case 'export': {

backend/class/db/Base.class.php

@@ -3,14 +3,27 @@
 abstract class DbBase {
 
   public static $KEY_RESERVED_PREFIX = '___RESERVED_';
-  public static $KEY_MANAGE_SETTINGS = '___RESERVED_MANAGE_SETTINGS';
-  public static $KEY_MANAGE_PASSWORD = '___RESERVED_MANAGE_PASSWORD';
+  public static $KEY_MANAGE_SETTINGS = 'MANAGE_SETTINGS';
+  public static $KEY_MANAGE_PASSWORD = 'MANAGE_PASSWORD';
 
   public static function keyReserved ($key) {
     $len = strlen(self::$KEY_RESERVED_PREFIX);
     return strlen($key) >= $len && substr($key, 0, $len) == self::$KEY_RESERVED_PREFIX;
   }
 
+  function hasReserved(string $key) {
+    return $this->has(self::$KEY_RESERVED_PREFIX . $key);
+  }
+  function getReserved(string $key) {
+    return $this->get(self::$KEY_RESERVED_PREFIX . $key);
+  }
+  function setReserved(string $key, string $value) {
+    return $this->set(self::$KEY_RESERVED_PREFIX . $key, $value);
+  }
+  function deleteReserved(string $key) {
+    return $this->delete(self::$KEY_RESERVED_PREFIX . $key);
+  }
+
   public static $SEARCH_RESULT_PER_PAGE = 20;
 
   /**