rename: account identifier -> name

Author: MenxLi

lires/cmd/manageKey.py

@@ -2,26 +2,26 @@
 from lires.core.encryptClient import generateHexHash
 from lires.core.utils import randomAlphaNumeric
 from lires.server.auth.account import Account
-from lires.server.auth.encryptServer import createAccount, deleteAccount, getHashKeyByIdentifier, getAllAccounts
+from lires.server.auth.encryptServer import createAccount, deleteAccount, getHashKeyByName, getAllAccounts
 
 def run():
     parser = argparse.ArgumentParser()
     sp = parser.add_subparsers(dest = "subparser", help = "Key management")
 
     parser_gen = sp.add_parser("generate", help = "Generate key")
     parser_gen.add_argument("-l", "--length", type = int, default=6, help = "Length of the key")
-    parser_gen.add_argument("-i", "--identifier", default = "Anonymous", help = "Identifier for this key")
+    parser_gen.add_argument("-i", "--name", default = "Anonymous", help = "Identifier for this key")
     parser_gen.add_argument("-t", "--tags", nargs = "+", default = [], help = "Mandatory tag for this key")
     parser_gen.add_argument("--admin", action="store_true", help = "Set the account to admin")
 
     parser_reg = sp.add_parser("register", help = "Register key")
     parser_reg.add_argument("key", help = "Key")
-    parser_reg.add_argument("-i", "--identifier", default = "Anonymous", help = "Identifier for this key")
+    parser_reg.add_argument("-i", "--name", default = "Anonymous", help = "Identifier for this key")
     parser_reg.add_argument("-t", "--tags", nargs = "+", default = [], help = "Mandatory tag for this key")
     parser_reg.add_argument("--admin", action="store_true", help = "Set the account to administrator")
 
     parser_del = sp.add_parser("delete", help = "Delete key")
-    parser_del.add_argument("-i", "--identifier", help = "Keys with selected identifier will be deleted")
+    parser_del.add_argument("-i", "--name", help = "Keys with selected name will be deleted")
     parser_del.add_argument("-k", "--key", help = "Key to delete")
     parser_del.add_argument("--hash_key", help = "Hash key to delete")
 
@@ -32,22 +32,22 @@ def run():
 
     if args.subparser == "generate":
         k = randomAlphaNumeric(args.length)
-        res = createAccount(generateHexHash(k), args.identifier, is_admin = args.admin, mandatory_tags=args.tags)
+        res = createAccount(generateHexHash(k), args.name, is_admin = args.admin, mandatory_tags=args.tags)
         if res:
             print("Generated key: ", k)
         else:
             print("Failed")
 
     elif args.subparser == "register":
-        res = createAccount(generateHexHash(args.key), args.identifier, is_admin = args.admin, mandatory_tags=args.tags)
+        res = createAccount(generateHexHash(args.key), args.name, is_admin = args.admin, mandatory_tags=args.tags)
         if res:
             print("Success")
         else:
             print("Failed")
 
     elif args.subparser == "delete":
-        if args.identifier is not None:
-            hashkeys = getHashKeyByIdentifier(args.identifier)
+        if args.name is not None:
+            hashkeys = getHashKeyByName(args.name)
             print("This action will delete:")
             for hkey in hashkeys:
                 print("- ", hkey)

lires/server/auth/account.py

@@ -22,15 +22,15 @@
 
 class AccountPermission(TypedDict):
     is_admin: bool
-    identifier: str
+    name: str
     enc_key: str
     mandatory_tags: List[str]
 
 class Account:
     def __init__(self, **kwargs):
         # default constructor
         self.hashkey: Optional[str] = None
-        self.identifier: str = ""
+        self.name: str = ""
         self.is_admin: bool = False
         self.mandatory_tags: List[str] = []
 
@@ -41,7 +41,7 @@ def __init__(self, **kwargs):
     def permission(self) -> AccountPermission:
         return {
             "is_admin": self.is_admin,
-            "identifier": self.identifier,
+            "name": self.name,
             "enc_key": self.hashkey if self.hashkey else "",
             "mandatory_tags": self.mandatory_tags
         }
@@ -58,19 +58,19 @@ def toFile(self, fpath: str):
         assert fpath.endswith(".json")
         with open(fpath, "w") as fp:
             obj = dict()
-            for k in ["hashkey", "identifier", "is_admin", "mandatory_tags"]:
+            for k in ["hashkey", "name", "is_admin", "mandatory_tags"]:
                 obj[k] = getattr(self, k)
             json.dump(obj, fp, indent=1)
         return self
 
     def detailString(self):
         lines = []
-        for k in ["hashkey", "identifier", "is_admin", "mandatory_tags"]:
+        for k in ["hashkey", "name", "is_admin", "mandatory_tags"]:
             lines.append(f" - {k}: {getattr(self, k)}")
         return "\n".join(lines)
 
     def __str__(self) -> str:
-        ret = f"{self.hashkey} ({self.identifier})"
+        ret = f"{self.hashkey} ({self.name})"
         if self.is_admin:
             ret = "* " + ret
         return ret

lires/server/auth/encryptServer.py

@@ -7,13 +7,13 @@
 def _getAccountFilePath(hashkey):
     return os.path.join(ACCOUNT_DIR, hashkey + ".json")
 
-def createAccount(hashkey: str, identifier: str, is_admin: bool, mandatory_tags) -> bool:
+def createAccount(hashkey: str, name: str, is_admin: bool, mandatory_tags) -> bool:
     aim_file = _getAccountFilePath(hashkey)
     if os.path.exists(aim_file):
         print("Account already exists")
         return False
 
-    account = Account(hashkey = hashkey, identifier = identifier, is_admin = is_admin, mandatory_tags = mandatory_tags)
+    account = Account(hashkey = hashkey, name = name, is_admin = is_admin, mandatory_tags = mandatory_tags)
     account.toFile(aim_file)
     return True
 
@@ -36,15 +36,15 @@ def deleteAccount(hashkey: str) -> bool:
         os.remove(aim_file)
         return True
 
-def getHashKeyByIdentifier(identifier: str) -> List[str]:
+def getHashKeyByName(name: str) -> List[str]:
     ret = []
     for f in os.listdir(ACCOUNT_DIR):
         if not f.endswith(".json"):
             continue
         hashkey = f.strip(".json")
         aim_file = _getAccountFilePath(hashkey)
         account = Account().fromFile(aim_file)
-        if account.identifier == identifier:
+        if account.name == name:
             ret.append(hashkey)
     return ret
 

lires/server/handlers/_misc.py

@@ -13,7 +13,7 @@ async def post(self):
         perm = self.permission
         self.setDefaultHeader()
 
-        self.logger.info(f"Reload DB, from {perm['identifier']}({perm['enc_key']})")
+        self.logger.info(f"Reload DB, from {perm['name']}({perm['enc_key']})")
         self.initdb()
 
         self.write("OK")

lires/server/handlers/dataMan.py

@@ -163,7 +163,7 @@ def post(self):
             # only admin can rename tags
             raise tornado.web.HTTPError(403)
         self.db.renameTag(old_tag, new_tag)
-        self.logger.info(f"Tag [{old_tag}] renamed to [{new_tag}] by [{self.permission['identifier']}]")
+        self.logger.info(f"Tag [{old_tag}] renamed to [{new_tag}] by [{self.permission['name']}]")
         self.write("OK")
 
 class TagDeleteHandler(tornado.web.RequestHandler, RequestHandlerMixin):
@@ -178,5 +178,5 @@ def post(self):
             # only admin can delete tags
             raise tornado.web.HTTPError(403)
         self.db.deleteTag(tag)
-        self.logger.info(f"Tag [{tag}] deleted by [{self.permission['identifier']}]")
+        self.logger.info(f"Tag [{tag}] deleted by [{self.permission['name']}]")
         self.write("OK")

lires_web/src/core/protocalT.ts

@@ -31,7 +31,7 @@ export type DatabaseFeature = Record<string, number[]>;
 export interface AccountPermission {
     is_admin: boolean;
     mandatory_tags: string[];
-    identifier: string;
+    name: string;
     enc_key: string;
 }