cmdbox 0.6.2.3__tar.gz → 0.6.3__tar.gz

{cmdbox-0.6.2.3/cmdbox.egg-info → cmdbox-0.6.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cmdbox
-Version: 0.6.2.3
+Version: 0.6.3
 Summary: cmdbox: It is a command line application with a plugin mechanism.
 Home-page: https://github.com/hamacom2004jp/cmdbox
 Download-URL: https://github.com/hamacom2004jp/cmdbox

{cmdbox-0.6.2.3 → cmdbox-0.6.3}/cmdbox/app/auth/signin.py

@@ -931,7 +931,8 @@ async def create_request_scope(req:Request=None, res:Response=None, websocket:We
     sess = None
     if req is not None:
         sess = req.session if hasattr(req, 'session') else None
-    request_scope.set(dict(req=req, res=res, websocket=websocket))
+    from cmdbox.app.web import Web
+    request_scope.set(dict(req=req, res=res, websocket=websocket, web=Web.getInstance()))
     try:
         yield # リクエストの処理
     finally:
@@ -954,4 +955,4 @@ def get_request_scope() -> Dict[str, Any]:
     Returns:
         Dict[str, Any]: リクエストとレスポンスとWebSocket接続
     """
-    return request_scope.get() if request_scope.get() is not None else dict(req=None, res=None, session=None, websocket=None)
+    return request_scope.get() if request_scope.get() is not None else dict(req=None, res=None, session=None, websocket=None, web=None)

{cmdbox-0.6.2.3 → cmdbox-0.6.3}/cmdbox/app/common.py

@@ -13,6 +13,7 @@ import asyncio
 import datetime
 import logging
 import logging.config
+import locale
 import hashlib
 import inspect
 import json
@@ -498,19 +499,23 @@ def print_format(data:dict, format:bool, tm:float, output_json:str=None, output_
     Returns:
         str: 生成された文字列
     """
-    if type(data) is dict and "success" in data and type(data["success"]) is dict and "performance" in data["success"] and type(data["success"]["performance"]) is list and pf is not None:
+    is_data_dict = isinstance(data, dict)
+    in_data_success = is_data_dict and 'success' in data
+    is_success_dict = in_data_success and isinstance(data['success'], dict)
+    is_data_list = isinstance(data, list)
+    if is_success_dict and "performance" in data["success"] and isinstance(data["success"]["performance"], list) and pf is not None:
         data["success"]["performance"] += pf
     txt = ''
     if format:
-        if 'success' in data and type(data["success"]) is dict:
-            data = data['success']['data'] if 'data' in data['success'] else data['success']
-            if type(data) == list:
-                txt = tabulate(data, headers='keys', tablefmt=tablefmt)
-            elif type(data) == dict:
-                txt = tabulate([data], headers='keys', tablefmt=tablefmt)
+        if is_success_dict:
+            _data = data['success']['data'] if 'data' in data['success'] else data['success']
+            if isinstance(_data, list):
+                txt = tabulate(_data, headers='keys', tablefmt=tablefmt)
+            elif isinstance(_data, dict):
+                txt = tabulate([_data], headers='keys', tablefmt=tablefmt)
             else:
-                txt = str(data)
-        elif type(data) == list:
+                txt = str(_data)
+        elif is_data_list:
             txt = tabulate(data, headers='keys', tablefmt=tablefmt)
         else:
             txt = tabulate([data], headers='keys', tablefmt=tablefmt)
@@ -521,13 +526,13 @@ def print_format(data:dict, format:bool, tm:float, output_json:str=None, output_
             except BrokenPipeError:
                 pass
     else:
-        if 'success' in data and type(data['success']) is dict:
+        if is_success_dict:
             if "performance" not in data["success"]:
                 data["success"]["performance"] = []
             performance = data["success"]["performance"]
             performance.append(dict(key="app_proc", val=f"{time.perf_counter() - tm:.03f}s"))
         try:
-            if type(data) == dict:
+            if is_data_dict:
                 txt = json.dumps(data, default=default_json_enc, ensure_ascii=False)
             else:
                 txt = data
@@ -685,6 +690,17 @@ def chopdq(target:str):
         return target
     return target[1:-1] if target.startswith('"') and target.endswith('"') else target
 
+def is_japan() -> bool:
+    """
+    日本語環境かどうかを判定します
+
+    Returns:
+        bool: 日本語環境ならTrue、そうでなければFalse
+    """
+    language, _ = locale.getlocale()
+    is_japan = language.find('Japan') >= 0 or language.find('ja_JP') >= 0
+    return is_japan
+
 def is_event_loop_running() -> bool:
     """
     イベントループが実行中かどうかを取得します。
@@ -721,7 +737,7 @@ def exec_sync(apprun, logger:logging.Logger, args:argparse.Namespace, tm:float,
             th.start()
             th.join()
             result = ctx[0] if ctx else None
-            return 0, result, None
+            return result
         return asyncio.run(apprun(logger, args, tm, pf))
     return apprun(logger, args, tm, pf)
 

{cmdbox-0.6.2.3 → cmdbox-0.6.3}/cmdbox/app/features/cli/cmdbox_audit_search.py

@@ -144,6 +144,12 @@ class AuditSearch(audit_base.AuditBase):
         Returns:
             Tuple[int, Dict[str, Any], Any]: 終了コード, 結果, オブジェクト
         """
+        if not hasattr(args, 'format') or not args.format:
+            args.format = False
+        if not hasattr(args, 'output_json') or not args.output_json:
+            args.output_json = None
+        if not hasattr(args, 'output_json_append') or not args.output_json_append:
+            args.output_json_append = False
         if args.svname is None:
             msg = dict(warn=f"Please specify the --svname option.")
             common.print_format(msg, args.format, tm, None, False, pf=pf)

cmdbox-0.6.3/cmdbox/app/features/cli/cmdbox_client_http.py

@@ -0,0 +1,154 @@
+from cmdbox.app import common, client, feature, filer
+from cmdbox.app.commons import convert, redis_client
+from cmdbox.app.options import Options
+from pathlib import Path
+from typing import Dict, Any, Tuple, List, Union
+import argparse
+import logging
+import requests
+import urllib.parse
+
+
+class ClientHttp(feature.ResultEdgeFeature):
+    def get_mode(self) -> Union[str, List[str]]:
+        """
+        この機能のモードを返します
+
+        Returns:
+            Union[str, List[str]]: モード
+        """
+        return 'client'
+
+    def get_cmd(self):
+        """
+        この機能のコマンドを返します
+
+        Returns:
+            str: コマンド
+        """
+        return 'http'
+    
+    def get_option(self):
+        """
+        この機能のオプションを返します
+
+        Returns:
+            Dict[str, Any]: オプション
+        """
+        return dict(
+            use_redis=self.USE_REDIS_MEIGHT, nouse_webmode=False,
+            description_ja="HTTPサーバーに対してリクエストを送信し、レスポンスを取得します。",
+            description_en="Sends a request to the HTTP server and gets a response.",
+            choice=[
+                dict(opt="url", type=Options.T_STR, default=None, required=True, multi=False, hide=False, choice=None,
+                     description_ja="リクエスト先URLを指定します。",
+                     description_en="Specify the URL to request."),
+                dict(opt="proxy", type=Options.T_STR, default="no", required=False, multi=False, hide=False, choice=['no', 'yes'],
+                     choice_show=dict(no=["send_method", "send_content_type", "send_apikey", "send_header",],
+                                      yes=[]),
+                     description_ja="webモードで呼び出された場合、受信したリクエストパラメータをリクエスト先URLに送信するかどうかを指定します。",
+                     description_en="Specifies whether or not to send the received request parameters to the destination URL when invoked in web mode."),
+                dict(opt="send_method", type=Options.T_STR, default="GET", required=True, multi=False, hide=False,
+                     choice=['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'HEAD', 'OPTIONS'],
+                     description_ja="リクエストメソッドを指定します。",
+                     description_en="Specifies the request method."),
+                dict(opt="send_content_type", type=Options.T_STR, default=None, required=False, multi=False, hide=False,
+                     choice=['', 'application/octet-stream', 'application/json', 'multipart/form-data'],
+                     choice_show={'application/octet-stream':["send_param", "send_data",],
+                                  'application/json':["send_data",],
+                                  'multipart/form-data':["send_param",],},
+                     description_ja="送信するデータのContent-Typeを指定します。",
+                     description_en="Specifies the Content-Type of the data to be sent."),
+                dict(opt="send_apikey", type=Options.T_TEXT, default=None, required=False, multi=False, hide=False, choice=None,
+                     description_ja="リクエスト先の認証で使用するAPIキーを指定します。",
+                     description_en="Specify the API key to be used for authentication of the request destination."),
+                dict(opt="send_header", type=Options.T_DICT, default=None, required=False, multi=True, hide=False, choice=None,
+                     description_ja="リクエストヘッダーを指定します。",
+                     description_en="Specifies the request header."),
+                dict(opt="send_param", type=Options.T_DICT, default=None, required=False, multi=True, hide=False, choice=None,
+                     description_ja="送信するパラメータを指定します。",
+                     description_en="Specifies parameters to be sent."),
+                dict(opt="send_data", type=Options.T_TEXT, default=None, required=False, multi=False, hide=False, choice=None,
+                     description_ja="送信するデータを指定します。",
+                     description_en="Specifies the data to be sent."),
+                dict(opt="send_verify", type=Options.T_BOOL, default=False, required=False, multi=False, hide=True, choice=[False, True],
+                     description_ja="レスポンスを受け取るまでのタイムアウトを指定します。",
+                     description_en="Specifies the timeout before a response is received."),
+                dict(opt="send_timeout", type=Options.T_INT, default=30, required=False, multi=False, hide=True, choice=None,
+                     description_ja="レスポンスを受け取るまでのタイムアウトを指定します。",
+                     description_en="Specifies the timeout before a response is received."),
+                dict(opt="stdout_log", type=Options.T_BOOL, default=True, required=False, multi=False, hide=True, choice=[True, False],
+                     description_ja="GUIモードでのみ使用可能です。コマンド実行時の標準出力をConsole logに出力します。",
+                     description_en="Available only in GUI mode. Outputs standard output during command execution to Console log."),
+                dict(opt="capture_stdout", type=Options.T_BOOL, default=True, required=False, multi=False, hide=True, choice=[True, False],
+                     description_ja="GUIモードでのみ使用可能です。コマンド実行時の標準出力をキャプチャーし、実行結果画面に表示します。",
+                     description_en="Available only in GUI mode. Captures standard output during command execution and displays it on the execution result screen."),
+                dict(opt="capture_maxsize", type=Options.T_INT, default=self.DEFAULT_CAPTURE_MAXSIZE, required=False, multi=False, hide=True, choice=None,
+                     description_ja="GUIモードでのみ使用可能です。コマンド実行時の標準出力の最大キャプチャーサイズを指定します。",
+                     description_en="Available only in GUI mode. Specifies the maximum capture size of standard output when executing commands."),
+            ]
+        )
+
+    async def apprun(self, logger:logging.Logger, args:argparse.Namespace, tm:float, pf:List[Dict[str, float]]=[]) -> Tuple[int, Dict[str, Any], Any]:
+        """
+        この機能の実行を行います
+
+        Args:
+            logger (logging.Logger): ロガー
+            args (argparse.Namespace): 引数
+            tm (float): 実行開始時間
+            pf (List[Dict[str, float]]): 呼出元のパフォーマンス情報
+
+        Returns:
+            Tuple[int, Dict[str, Any], Any]: 終了コード, 結果, オブジェクト
+        """
+        if args.url is None:
+            msg = dict(warn=f"Please specify the --url option.")
+            common.print_format(msg, args.format, tm, None, False, pf=pf)
+            return 1, msg, None
+        query_param = {}
+        if args.proxy == 'yes':
+            from cmdbox.app.auth import signin
+            from fastapi import Request
+            scope = signin.get_request_scope()
+            if scope is None:
+                msg = dict(warn=f"Request scope is not set. Please set the request scope.")
+                common.print_format(msg, args.format, tm, None, False, pf=pf)
+                return 1, msg, None
+            req:Request = scope['req']
+            args.send_method = req.method
+            args.send_content_type = req.headers.get('Content-Type', None)
+            args.send_apikey = req.headers.get('Authorization', '').replace('Bearer ', '')
+            args.send_header = {k:v for k, v in req.headers.items() \
+                                if k.lower() not in ['connection', 'proxy-authorization', 'proxy-connection', 'keep-alive',
+                                                     'transfer-encoding', 'te', 'trailer', 'upgrade', 'content-length']}
+            query_param = {k:v for k, v in req.query_params.items()}
+            args.send_data = await req.body()
+
+        url = urllib.parse.urlparse(args.url)
+        query = urllib.parse.parse_qs(url.query)
+        query = {**query, **query_param} if query else query_param
+        args.url = urllib.parse.urlunparse((url.scheme, url.netloc, url.path, url.params, urllib.parse.urlencode(query), url.fragment))
+        args.send_header = {**args.send_header, 'Authorization':f'Bearer {args.send_apikey}'} if args.send_apikey else args.send_header
+        res = requests.request(method=args.send_method, url=args.url, headers=args.send_header,
+                                   verify=args.send_verify, timeout=args.send_timeout, allow_redirects=True,
+                                   data=args.send_data, params=args.send_param)
+        if res.status_code != 200:
+            msg = dict(error=f"Request failed with status code {res.status_code}.")
+            common.print_format(msg, False, tm, None, False, pf=pf)
+            return 1, msg, None
+        content_type = res.headers.get('Content-Type', '')
+        if content_type.startswith('application/json'):
+            try:
+                msg = res.json()
+            except ValueError as e:
+                msg = res.text
+            common.print_format(msg, False, tm, None, False, pf=pf)
+            return 0, msg, None
+        elif content_type.startswith('text/'):
+            msg = res.text
+            common.print_format(msg, False, tm, None, False, pf=pf)
+            return 0, msg, None
+        common.print_format(res.content, False, tm, None, False, pf=pf)
+
+        return 0, res.content, None

{cmdbox-0.6.2.3 → cmdbox-0.6.3}/cmdbox/app/features/cli/cmdbox_cmd_list.py

@@ -1,4 +1,4 @@
-from cmdbox.app import common, feature
+from cmdbox.app import common, feature, options
 from cmdbox.app.auth import signin
 from cmdbox.app.options import Options
 from pathlib import Path
@@ -45,10 +45,10 @@ class CmdList(feature.OneshotResultEdgeFeature):
                 dict(opt="kwd", type=Options.T_STR, default=None, required=False, multi=False, hide=False, choice=None,
                      description_ja=f"検索したいコマンド名を指定します。中間マッチで検索します。",
                      description_en=f"Specify the name of the command you want to search. Search with intermediate matches."),
-                dict(opt="signin_file", type=Options.T_FILE, default=f".{self.ver.__appid__}/user_list.yml", required=False, multi=False, hide=True, choice=None, fileio="in",
+                dict(opt="signin_file", type=Options.T_FILE, default=f".{self.ver.__appid__}/user_list.yml", required=False, multi=False, hide=False, choice=None, fileio="in",
                      description_ja="サインイン可能なユーザーとパスワードを記載したファイルを指定します。",
                      description_en="Specify a file containing users and passwords with which they can signin."),
-                dict(opt="groups", type=Options.T_STR, default=None, required=False, multi=True, hide=True, choice=None,
+                dict(opt="groups", type=Options.T_STR, default=None, required=False, multi=True, hide=False, choice=None,
                      description_ja="`signin_file` を指定した場合に、このユーザーグループに許可されているコマンドリストを返すように指定します。",
                      description_en="Specifies that `signin_file`, if specified, should return the list of commands allowed for this user group."),
                 dict(opt="output_json", short="o", type=Options.T_FILE, default=None, required=False, multi=False, hide=True, choice=None, fileio="out",
@@ -92,11 +92,15 @@ class CmdList(feature.OneshotResultEdgeFeature):
         if not hasattr(self, 'signin_file_data') or self.signin_file_data is None:
             self.signin_file_data = signin.Signin.load_signin_file(args.signin_file, None, self=self)
         paths = glob.glob(str(Path(args.data) / ".cmds" / f"cmd-{kwd}.json"))
-        ret = [common.loadopt(path, True) for path in paths]
-        ret = sorted(ret, key=lambda cmd: cmd["title"])
-        ret = [dict(title=r.get('title',''), mode=r.get('mode',''), cmd=r.get('cmd',''), description=r.get('description',''), tag=r.get('tag','')) for r in ret \
+        cmd_list = [common.loadopt(path, True) for path in paths]
+        cmd_list = sorted(cmd_list, key=lambda cmd: cmd["title"])
+        is_japan = common.is_japan()
+        options = Options.getInstance()
+        cmd_list = [dict(title=r.get('title',''), mode=r['mode'], cmd=r['cmd'],
+                    description=r.get('description','') + options.get_cmd_attr(r['mode'], r['cmd'], 'description_ja' if is_japan else 'description_en'),
+                    tag=r.get('tag','')) for r in cmd_list \
                if signin.Signin._check_cmd(self.signin_file_data, args.groups, r['mode'], r['cmd'], logger)]
-        ret = dict(success=ret)
+        ret = dict(success=cmd_list)
 
         common.print_format(ret, args.format, tm, args.output_json, args.output_json_append, pf=pf)
 

{cmdbox-0.6.2.3 → cmdbox-0.6.3}/cmdbox/app/features/cli/cmdbox_web_start.py

@@ -183,7 +183,7 @@ class WebStart(feature.UnsupportEdgeFeature, agent_base.AgentBase):
         Returns:
             web.Web: Webオブジェクト
         """
-        w = web.Web(logger, Path(args.data), appcls=self.appcls, ver=self.ver,
+        w = web.Web.getInstance(logger, Path(args.data), appcls=self.appcls, ver=self.ver,
                     redis_host=args.host, redis_port=args.port, redis_password=args.password, svname=args.svname,
                     client_only=args.client_only, doc_root=args.doc_root, gui_html=args.gui_html, filer_html=args.filer_html,
                     result_html=args.result_html, users_html=args.users_html,