Use function flagging in plugins

Author: shortcutme

plugins/Bigfile/BigfilePlugin.py

@@ -21,6 +21,7 @@
 
 from util import helper
 from util import Msgpack
+from util.Flag import flag
 import util
 from .BigfilePiecefield import BigfilePiecefield, BigfilePiecefieldPacked
 
@@ -167,6 +168,7 @@ def actionBigfileUploadInit(self, to, inner_path, size):
             "file_relative_path": file_relative_path
         }
 
+    @flag.no_multiuser
     def actionSiteSetAutodownloadBigfileLimit(self, to, limit):
         permissions = self.getPermissions(to)
         if "ADMIN" not in permissions:

plugins/Chart/ChartPlugin.py

@@ -5,6 +5,7 @@
 
 from Config import config
 from util import helper
+from util.Flag import flag
 from Plugin import PluginManager
 from .ChartDb import ChartDb
 from .ChartCollector import ChartCollector
@@ -28,10 +29,8 @@ def delete(self, address, *args, **kwargs):
 
 @PluginManager.registerTo("UiWebsocket")
 class UiWebsocketPlugin(object):
+    @flag.admin
     def actionChartDbQuery(self, to, query, params=None):
-        if not "ADMIN" in self.permissions:
-            return {"error": "No permission"}
-
         if config.debug or config.verbose:
             s = time.time()
         rows = []
@@ -49,10 +48,8 @@ def actionChartDbQuery(self, to, query, params=None):
             self.log.debug("Slow query: %s (%.3fs)" % (query, time.time() - s))
         return rows
 
+    @flag.admin
     def actionChartGetPeerLocations(self, to):
-        if not "ADMIN" in self.permissions:
-            return {"error": "No permission"}
-
         peers = {}
         for site in self.server.sites.values():
             peers.update(site.peers)

plugins/ContentFilter/ContentFilterPlugin.py

@@ -7,6 +7,7 @@
 from Plugin import PluginManager
 from Translate import Translate
 from Config import config
+from util.Flag import flag
 
 from .ContentFilterStorage import ContentFilterStorage
 
@@ -36,6 +37,7 @@ def cbMuteAdd(self, to, auth_address, cert_user_id, reason):
         filter_storage.changeDbs(auth_address, "remove")
         self.response(to, "ok")
 
+    @flag.no_multiuser
     def actionMuteAdd(self, to, auth_address, cert_user_id, reason):
         if "ADMIN" in self.getPermissions(to):
             self.cbMuteAdd(to, auth_address, cert_user_id, reason)
@@ -46,12 +48,14 @@ def actionMuteAdd(self, to, auth_address, cert_user_id, reason):
                 lambda res: self.cbMuteAdd(to, auth_address, cert_user_id, reason)
             )
 
+    @flag.no_multiuser
     def cbMuteRemove(self, to, auth_address):
         del filter_storage.file_content["mutes"][auth_address]
         filter_storage.save()
         filter_storage.changeDbs(auth_address, "load")
         self.response(to, "ok")
 
+    @flag.no_multiuser
     def actionMuteRemove(self, to, auth_address):
         if "ADMIN" in self.getPermissions(to):
             self.cbMuteRemove(to, auth_address)
@@ -63,34 +67,31 @@ def actionMuteRemove(self, to, auth_address):
                 lambda res: self.cbMuteRemove(to, auth_address)
             )
 
+    @flag.admin
     def actionMuteList(self, to):
-        if "ADMIN" in self.getPermissions(to):
-            self.response(to, filter_storage.file_content["mutes"])
-        else:
-            return self.response(to, {"error": "Forbidden: Only ADMIN sites can list mutes"})
+        self.response(to, filter_storage.file_content["mutes"])
 
     # Siteblock
+    @flag.no_multiuser
+    @flag.admin
     def actionSiteblockAdd(self, to, site_address, reason=None):
-        if "ADMIN" not in self.getPermissions(to):
-            return self.response(to, {"error": "Forbidden: Only ADMIN sites can add to blocklist"})
         filter_storage.file_content["siteblocks"][site_address] = {"date_added": time.time(), "reason": reason}
         filter_storage.save()
         self.response(to, "ok")
 
+    @flag.no_multiuser
+    @flag.admin
     def actionSiteblockRemove(self, to, site_address):
-        if "ADMIN" not in self.getPermissions(to):
-            return self.response(to, {"error": "Forbidden: Only ADMIN sites can remove from blocklist"})
         del filter_storage.file_content["siteblocks"][site_address]
         filter_storage.save()
         self.response(to, "ok")
 
+    @flag.admin
     def actionSiteblockList(self, to):
-        if "ADMIN" in self.getPermissions(to):
-            self.response(to, filter_storage.file_content["siteblocks"])
-        else:
-            return self.response(to, {"error": "Forbidden: Only ADMIN sites can list blocklists"})
+        self.response(to, filter_storage.file_content["siteblocks"])
 
     # Include
+    @flag.no_multiuser
     def actionFilterIncludeAdd(self, to, inner_path, description=None, address=None):
         if address:
             if "ADMIN" not in self.getPermissions(to):
@@ -122,6 +123,7 @@ def cbFilterIncludeAdd(self, to, res, address, inner_path, description):
         filter_storage.includeAdd(address, inner_path, description)
         self.response(to, "ok")
 
+    @flag.no_multiuser
     def actionFilterIncludeRemove(self, to, inner_path, address=None):
         if address:
             if "ADMIN" not in self.getPermissions(to):

plugins/MergerSite/MergerSitePlugin.py

@@ -7,6 +7,7 @@
 from Translate import Translate
 from util import RateLimit
 from util import helper
+from util.Flag import flag
 from Debug import Debug
 try:
     import OptionalManager.UiWebsocketPlugin  # To make optioanlFileInfo merger sites compatible
@@ -86,6 +87,7 @@ def cbMergerSiteAdd(self, to, addresses):
         site_manager.updateMergerSites()
 
     # Delete a merged site
+    @flag.no_multiuser
     def actionMergerSiteDelete(self, to, address):
         site = self.server.sites.get(address)
         if not site:

plugins/Newsfeed/NewsfeedPlugin.py

@@ -5,6 +5,7 @@
 from Db.DbQuery import DbQuery
 from Debug import Debug
 from util import helper
+from util.Flag import flag
 
 
 @PluginManager.registerTo("UiWebsocket")
@@ -27,10 +28,8 @@ def actionFeedListFollow(self, to):
         feeds = self.user.sites.get(self.site.address, {}).get("follow", {})
         self.response(to, feeds)
 
+    @flag.admin
     def actionFeedQuery(self, to, limit=10, day_limit=3):
-        if "ADMIN" not in self.site.settings["permissions"]:
-            return self.response(to, "FeedQuery not allowed")
-
         from Site import SiteManager
         rows = []
         stats = []

plugins/OptionalManager/UiWebsocketPlugin.py

@@ -8,6 +8,7 @@
 from Plugin import PluginManager
 from Config import config
 from util import helper
+from util.Flag import flag
 from Translate import Translate
 
 
@@ -214,6 +215,7 @@ def setPin(self, inner_path, is_pinned, address=None):
 
         return "ok"
 
+    @flag.no_multiuser
     def actionOptionalFilePin(self, to, inner_path, address=None):
         if type(inner_path) is not list:
             inner_path = [inner_path]
@@ -226,6 +228,7 @@ def actionOptionalFilePin(self, to, inner_path, address=None):
                 self.cmd("notification", ["done", _["Pinned %s files"] % num_file, 5000])
         self.response(to, back)
 
+    @flag.no_multiuser
     def actionOptionalFileUnpin(self, to, inner_path, address=None):
         if type(inner_path) is not list:
             inner_path = [inner_path]
@@ -238,6 +241,7 @@ def actionOptionalFileUnpin(self, to, inner_path, address=None):
                 self.cmd("notification", ["done", _["Removed pin from %s files"] % num_file, 5000])
         self.response(to, back)
 
+    @flag.no_multiuser
     def actionOptionalFileDelete(self, to, inner_path, address=None):
         if not address:
             address = self.site.address
@@ -275,20 +279,18 @@ def actionOptionalFileDelete(self, to, inner_path, address=None):
 
     # Limit functions
 
+    @flag.admin
     def actionOptionalLimitStats(self, to):
-        if "ADMIN" not in self.site.settings["permissions"]:
-            return self.response(to, "Forbidden")
-
         back = {}
         back["limit"] = config.optional_limit
         back["used"] = self.site.content_manager.contents.db.getOptionalUsedBytes()
         back["free"] = helper.getFreeSpace()
 
         self.response(to, back)
 
+    @flag.no_multiuser
+    @flag.admin
     def actionOptionalLimitSet(self, to, limit):
-        if "ADMIN" not in self.site.settings["permissions"]:
-            return self.response(to, {"error": "Forbidden"})
         config.optional_limit = re.sub(r"\.0+$", "", limit)  # Remove unnecessary digits from end
         config.saveValue("optional_limit", limit)
         self.response(to, "ok")
@@ -306,6 +308,7 @@ def actionOptionalHelpList(self, to, address=None):
 
         self.response(to, site.settings.get("optional_help", {}))
 
+    @flag.no_multiuser
     def actionOptionalHelp(self, to, directory, title, address=None):
         if not address:
             address = self.site.address
@@ -342,6 +345,7 @@ def actionOptionalHelp(self, to, directory, title, address=None):
 
         self.response(to, dict(stats))
 
+    @flag.no_multiuser
     def actionOptionalHelpRemove(self, to, directory, address=None):
         if not address:
             address = self.site.address
@@ -361,6 +365,7 @@ def cbOptionalHelpAll(self, to, site, value):
         site.settings["autodownloadoptional"] = value
         self.response(to, value)
 
+    @flag.no_multiuser
     def actionOptionalHelpAll(self, to, value, address=None):
         if not address:
             address = self.site.address

plugins/OptionalManager/__init__.py

@@ -1 +1,2 @@
-from . import OptionalManagerPlugin
+from . import OptionalManagerPlugin
+from . import UiWebsocketPlugin

plugins/Sidebar/ConsolePlugin.py

@@ -5,6 +5,7 @@
 from Config import config
 from Debug import Debug
 from util import SafeRe
+from util.Flag import flag
 
 
 class WsLogStreamer(logging.StreamHandler):
@@ -37,10 +38,11 @@ def stop(self):
 @PluginManager.registerTo("UiWebsocket")
 class UiWebsocketPlugin(object):
     def __init__(self, *args, **kwargs):
-        self.admin_commands.update(["consoleLogRead", "consoleLogStream", "consoleLogStreamRemove"])
         self.log_streamers = {}
         return super(UiWebsocketPlugin, self).__init__(*args, **kwargs)
 
+    @flag.no_multiuser
+    @flag.admin
     def actionConsoleLogRead(self, to, filter=None, read_size=32 * 1024, limit=500):
         log_file_path = "%s/debug.log" % config.log_dir
         log_file = open(log_file_path, encoding="utf-8")
@@ -74,11 +76,15 @@ def addLogStreamer(self, stream_id, filter=None):
         logging.getLogger('').addHandler(logger)
         return logger
 
+    @flag.no_multiuser
+    @flag.admin
     def actionConsoleLogStream(self, to, filter=None):
         stream_id = to
         self.log_streamers[stream_id] = self.addLogStreamer(stream_id, filter)
         self.response(to, {"stream_id": stream_id})
 
+    @flag.no_multiuser
+    @flag.admin
     def actionConsoleLogStreamRemove(self, to, stream_id):
         try:
             self.log_streamers[stream_id].stop()

plugins/Sidebar/SidebarPlugin.py

@@ -16,6 +16,7 @@
 from Debug import Debug
 from Translate import Translate
 from util import helper
+from util.Flag import flag
 from .ZipStream import ZipStream
 
 plugin_dir = os.path.dirname(__file__)
@@ -85,10 +86,6 @@ def streamZip(self, dir_path):
 
 @PluginManager.registerTo("UiWebsocket")
 class UiWebsocketPlugin(object):
-    def __init__(self, *args, **kwargs):
-        self.async_commands.add("sidebarGetPeers")
-        return super(UiWebsocketPlugin, self).__init__(*args, **kwargs)
-
     def sidebarRenderPeerStats(self, body, site):
         connected = len([peer for peer in list(site.peers.values()) if peer.connection and peer.connection.connected])
         connectable = len([peer_id for peer_id in list(site.peers.keys()) if not peer_id.endswith(":0")])
@@ -511,11 +508,8 @@ def sidebarRenderContents(self, body, site):
         body.append("</div>")
         body.append("</li>")
 
+    @flag.admin
     def actionSidebarGetHtmlTag(self, to):
-        permissions = self.getPermissions(to)
-        if "ADMIN" not in permissions:
-            return self.response(to, "You don't have permission to run this command")
-
         site = self.site
 
         body = []
@@ -706,11 +700,9 @@ def getPeerLocations(self, peers):
 
         return peer_locations
 
-
+    @flag.admin
+    @flag.async_run
     def actionSidebarGetPeers(self, to):
-        permissions = self.getPermissions(to)
-        if "ADMIN" not in permissions:
-            return self.response(to, "You don't have permission to run this command")
         try:
             peer_locations = self.getPeerLocations(self.site.peers)
             globe_data = []
@@ -739,53 +731,43 @@ def actionSidebarGetPeers(self, to):
             self.log.debug("sidebarGetPeers error: %s" % Debug.formatException(err))
             self.response(to, {"error": str(err)})
 
+    @flag.admin
+    @flag.no_multiuser
     def actionSiteSetOwned(self, to, owned):
-        permissions = self.getPermissions(to)
-        if "ADMIN" not in permissions:
-            return self.response(to, "You don't have permission to run this command")
-
         if self.site.address == config.updatesite:
             return self.response(to, "You can't change the ownership of the updater site")
 
         self.site.settings["own"] = bool(owned)
         self.site.updateWebsocket(owned=owned)
 
+    @flag.admin
+    @flag.no_multiuser
     def actionUserSetSitePrivatekey(self, to, privatekey):
-        permissions = self.getPermissions(to)
-        if "ADMIN" not in permissions:
-            return self.response(to, "You don't have permission to run this command")
-
         site_data = self.user.sites[self.site.address]
         site_data["privatekey"] = privatekey
         self.site.updateWebsocket(set_privatekey=bool(privatekey))
 
         return "ok"
 
+    @flag.admin
+    @flag.no_multiuser
     def actionSiteSetAutodownloadoptional(self, to, owned):
-        permissions = self.getPermissions(to)
-        if "ADMIN" not in permissions:
-            return self.response(to, "You don't have permission to run this command")
-
         self.site.settings["autodownloadoptional"] = bool(owned)
         self.site.bad_files = {}
         gevent.spawn(self.site.update, check_files=True)
         self.site.worker_manager.removeSolvedFileTasks()
 
+    @flag.no_multiuser
+    @flag.admin
     def actionDbReload(self, to):
-        permissions = self.getPermissions(to)
-        if "ADMIN" not in permissions:
-            return self.response(to, "You don't have permission to run this command")
-
         self.site.storage.closeDb()
         self.site.storage.getDb()
 
         return self.response(to, "ok")
 
+    @flag.no_multiuser
+    @flag.admin
     def actionDbRebuild(self, to):
-        permissions = self.getPermissions(to)
-        if "ADMIN" not in permissions:
-            return self.response(to, "You don't have permission to run this command")
-
         try:
             self.site.storage.rebuildDb()
         except Exception as err: