cmdbox 0.5.0.7__py3-none-any.whl → 0.5.1__py3-none-any.whl

cmdbox/extensions/sample_project/sample/extensions/features.yml

@@ -1,17 +1,19 @@
 features:
-  cli:
-    - package: sample.app.features.cli
-      prefix: sample_
-  web:
-    - package: sample.app.features.web
-      prefix: sample_web_
-args:
-  cli:
-    - rule:
-        mode: web
-      default:
-      coercion:
-        assets:
+  cli:                                  # Specify a list of package names in which the module implementing the command is located.
+    - package: sample.app.features.cli  # Package Name. Classes inheriting from cmdbox.app.feature.Feature.
+      prefix: sample_                   # Module name prefix. Modules that begin with this letter are eligible.
+      exclude_modules: []               # Specify the module name to exclude from the list of modules to be loaded.
+  web:                                  # Specify a list of package names with modules that implement web screens and RESTAPIs.
+    - package: sample.app.features.web  # Package Name. Classes inheriting from cmdbox.app.feature.WebFeature .
+      prefix: sample_web_               # Module name prefix. Modules that begin with this letter are eligible.
+args:                                   # Specifies default or forced arguments for the specified command.
+  cli:                                  # Specify rules to apply default values or force arguments.
+    - rule:                             # Specify the rules for applying default values and forced arguments for each command line option.
+        mode: web                       #   e.g. mode: web
+      default:                          # Specify a default value for each item to be set when a rule is matched.
+                                        #   e.g. doc_root: f"{Path(self.ver.__file__).parent / 'web'}"
+      coercion:                         # Specify a coercion value for each item to be set when a rule is matched.
+        assets:                         #   e.g. doc_root: f"{Path(self.ver.__file__).parent / 'web'}"
           - f"{Path(self.ver.__file__).parent / 'web' / 'assets'}"
         doc_root: f"{Path(self.ver.__file__).parent / 'web'}"
     - rule:
@@ -21,3 +23,26 @@ args:
         assets:
           - f"{Path(self.ver.__file__).parent / 'web' / 'assets'}"
         doc_root: f"{Path(self.ver.__file__).parent / 'web'}"
+aliases:                                # Specify the alias for the specified command.
+  cli:                                  # Specify the alias for the command line.
+    - source:                           # Specifies the command from which the alias originates.
+        mode:                           # Specify the mode of the source command. The exact match "mode" is selected.
+                                        #   e.g. client
+        cmd:                            # Specify the source command to be aliased. The regex match "cmd" is selected.
+                                        #   e.g. (.+)_(.+)
+      target:                           # Specifies the command to be aliased to.
+        mode:                           # Specify the mode of the target command. Create an alias for this “mode”.
+                                        #   e.g. CLIENT
+        cmd:                            # Specify the target command to be aliased. Create an alias for this “cmd”, referring to the regular expression group of source by "{n}".
+                                        #   e.g. {2}_{1}
+        move:                           # Specify whether to move the regular expression group of the source to the target.
+                                        #   e.g. true
+  web:                                  # Specify the alias for the RESTAPI.
+    - source:                           # Specifies the RESTAPI from which the alias originates.
+        path:                           # Specify the path of the source RESTAPI. The regex match "path" is selected.
+                                        #   e.g. /exec_(.+)
+      target:                           # Specifies the RESTAPI to be aliased to.
+        path:                           # Specify the path of the target RESTAPI. Create an alias for this “path”, referring to the regular expression group of source by "{n}".
+                                        #   e.g. /{1}_exec
+        move:                           # Specify whether to move the regular expression group of the source to the target.
+                                        #   e.g. true

cmdbox/extensions/sample_project/sample/extensions/user_list.yml

@@ -1,10 +1,10 @@
-users:
-- uid: 1
-  name: admin
-  password: admin
-  hash: plain
-  groups: [admin]
-  email: admin@aaa.bbb.jp
+users:                         # A list of users, each of which is a map that contains the following fields.
+- uid: 1                       # An ID that identifies a user. No two users can have the same ID.
+  name: admin                  # A name that identifies the user. No two users can have the same name.
+  password: admin              # The user's password. The value is hashed with the hash function specified in the next hash field.
+  hash: plain                  # The hash function used to hash the password, which can be plain, md5, sha1, or sha256, or oauth2.
+  groups: [admin]              # A list of groups to which the user belongs, as specified in the groups field.
+  email: admin@aaa.bbb.jp      # The email address of the user, used when authenticating using the provider specified in the oauth2 field.
 - uid: 101
   name: user01
   password: b75705d7e35e7014521a46b532236ec3
@@ -23,42 +23,53 @@ users:
   hash: sha256
   groups: [editor]
   email: user03@aaa.bbb.jp
-groups:
-- gid: 1
-  name: admin
+groups:                        # A list of groups, each of which is a map that contains the following fields.
+- gid: 1                       # An ID that identifies a group. No two groups can have the same ID.
+  name: admin                  # A name that identifies the group. No two groups can have the same name.
+- gid: 2
+  name: guest
 - gid: 101
   name: user
 - gid: 102
   name: readonly
-  parent: user
+  parent: user                 # The parent group of the group. If the parent group is not specified, the group is a top-level group.
 - gid: 103
   name: editor
   parent: user
-cmdrule:
-  policy: deny # allow, deny
-  rules:
+
+cmdrule:                       # A list of command rules, Specify a rule that determines whether or not a command is executable when executed by a user in web mode.
+  policy: deny                 # Specify the default policy for the rule. The value can be allow or deny.
+  rules:                       # Specify rules to allow or deny execution of the command, depending on the group the user belongs to.
   - groups: [admin]
     rule: allow
-  - groups: [user]
-    mode: client
-    cmds: [file_download, file_list, server_info]
-    rule: allow
+  - groups: [user]             # Specify the groups to which the rule applies.
+    mode: client               # Specify the "mode" as the condition for applying the rule.
+    cmds: [file_download, file_list, server_info] # Specify the "cmd" to which the rule applies. Multiple items can be specified in a list.
+    rule: allow                # Specifies whether or not the specified command is allowed for the specified group. The value can be allow or deny.
   - groups: [user]
     mode: server
     cmds: [list]
     rule: allow
+  - groups: [user, guest]
+    mode: web
+    cmds: [genpass]
+    rule: allow
   - groups: [editor]
     mode: client
     cmds: [file_copy, file_mkdir, file_move, file_remove, file_rmdir, file_upload]
     rule: allow
-pathrule:
-  policy: deny # allow, deny
-  rules:
-  - groups: [admin]
-    paths: [/]
+pathrule:                      # List of RESTAPI rules, rules that determine whether or not a RESTAPI can be executed when a user in web mode accesses it.
+  policy: deny                 # Specify the default policy for the rule. The value can be allow or deny.
+  rules:                       # Specify rules to allow or deny execution of the RESTAPI, depending on the group the user belongs to.
+  - groups: [admin]            # Specify the groups to which the rule applies.
+    paths: [/]                 # Specify the "path" to which the rule applies. Multiple items can be specified in a list.
+    rule: allow                # Specifies whether or not the specified RESTAPI is allowed for the specified group. The value can be allow or deny.
+  - groups: [guest]
+    paths: [/signin, /assets, /copyright, /dosignin, /dosignout, /password/change,
+            /gui, /get_server_opt, /usesignout, /versions_cmdbox, /versions_used]
     rule: allow
   - groups: [user]
-    paths: [/signin, /assets, /bbforce_cmd, /copyright, /dosignin, /dosignout,
+    paths: [/signin, /assets, /bbforce_cmd, /copyright, /dosignin, /dosignout, /password/change,
             /exec_cmd, /exec_pipe, /filer, /gui, /get_server_opt, /usesignout, /versions_cmdbox, /versions_used]
     rule: allow
   - groups: [readonly]
@@ -67,21 +78,52 @@ pathrule:
   - groups: [editor]
     paths: [/gui/del_cmd, /gui/del_pipe, /gui/save_cmd, /gui/save_pipe]
     rule: allow
-oauth2:
-  providers:
-    google:
-      enabled: false
-      client_id: XXXXXXXXXXX
-      client_secret: XXXXXXXXXXX
-      redirect_uri: https://localhost:8443/oauth2/google/callback
-      scope: ['email']
-      note:
+password:                       # Password settings.
+  policy:                       # Password policy settings.
+    enabled: true               # Specify whether or not to enable password policy.
+    not_same_before: true       # Specify whether or not to allow the same password as the previous one.
+    min_length: 16              # Specify the minimum length of the password.
+    max_length: 64              # Specify the maximum length of the password.
+    min_lowercase: 1            # Specify the minimum number of lowercase letters in the password.
+    min_uppercase: 1            # Specify the minimum number of uppercase letters in the password.
+    min_digit: 1                # Specify the minimum number of digits in the password.
+    min_symbol: 1               # Specify the minimum number of symbol characters in the password.
+    not_contain_username: true  # Specify whether or not to include the username in the password.
+  expiration:                   # Password expiration settings.
+    enabled: true               # Specify whether or not to enable password expiration.
+    period: 90                  # Specify the number of days after which the password will expire.
+    notify: 7                   # Specify the number of days before the password expires that a notification will be sent.
+  lockout:                      # Account lockout settings.
+    enabled: true               # Specify whether or not to enable account lockout.
+    threshold: 5                # Specify the number of failed login attempts before the account is locked.
+    reset: 30                   # Specify the number of minutes after which the failed login count will be reset.
+oauth2:                             # OAuth2 settings.
+  providers:                        # This is a per-provider setting for OAuth2.
+    google:                         # Google's OAuth2 configuration.
+      enabled: false                # Specify whether to enable Google's OAuth2.
+      client_id: XXXXXXXXXXX        # Specify Google's OAuth2 client ID.
+      client_secret: XXXXXXXXXXX    # Specify Google's OAuth2 client secret.
+      redirect_uri: https://localhost:8443/oauth2/google/callback # Specify Google's OAuth2 redirect URI.
+      scope: ['email']              # Specify the scope you want to retrieve with Google's OAuth2. Usually, just reading the email is sufficient.
+      signin_module:                # Specify the module name that implements the sign-in. see, cmdbox.app.signin.SignIn
+      note:                         # Specify a description such as Google's OAuth2 reference site.
       - https://developers.google.com/identity/protocols/oauth2/web-server?hl=ja#httprest
-    github:
-      enabled: false
-      client_id: XXXXXXXXXXX
-      client_secret: XXXXXXXXXXX
-      redirect_uri: https://localhost:8443/oauth2/github/callback
-      scope: ['user:email']
-      note:
+    github:                         # OAuth2 settings for GitHub.
+      enabled: false                # Specify whether to enable OAuth2 for GitHub.
+      client_id: XXXXXXXXXXX        # Specify the OAuth2 client ID for GitHub.
+      client_secret: XXXXXXXXXXX    # Specify the GitHub OAuth2 client secret.
+      redirect_uri: https://localhost:8443/oauth2/github/callback # Specify the OAuth2 redirect URI for GitHub.
+      scope: ['user:email']         # Specify the scope you want to get from GitHub's OAuth2. Usually, just reading the email is sufficient.
+      signin_module:                # Specify the module name that implements the sign-in. see, cmdbox.app.signin.SignIn
+      note:                         # Specify a description, such as a reference site for OAuth2 on GitHub.
       - https://docs.github.com/ja/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps#scopes
+    azure:                          # OAuth2 settings for Azure AD.
+      enabled: false                # Specify whether to enable OAuth2 for Azure AD.
+      tenant_id: XXXXXXXXXXX        # Specify the tenant ID for Azure AD.
+      client_id: XXXXXXXXXXX        # Specify the OAuth2 client ID for Azure AD.
+      client_secret: XXXXXXXXXXX    # Specify the Azure AD OAuth2 client secret.
+      redirect_uri: https://localhost:8443/oauth2/azure/callback # Specify the OAuth2 redirect URI for Azure AD.
+      scope: ['openid', 'profile', 'email', 'https://graph.microsoft.com/mail.read']
+      signin_module:                # Specify the module name that implements the sign-in. see, cmdbox.app.signin.SignIn
+      note:                         # Specify a description, such as a reference site for Azure AD's OAuth2.
+      - https://learn.microsoft.com/ja-jp/entra/identity-platform/v2-oauth2-auth-code-flow

cmdbox/extensions/user_list.yml

@@ -116,3 +116,13 @@ oauth2:                             # OAuth2 settings.
       signin_module:                # Specify the module name that implements the sign-in. see, cmdbox.app.signin.SignIn
       note:                         # Specify a description, such as a reference site for OAuth2 on GitHub.
       - https://docs.github.com/ja/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps#scopes
+    azure:                          # OAuth2 settings for Azure AD.
+      enabled: false                # Specify whether to enable OAuth2 for Azure AD.
+      tenant_id: XXXXXXXXXXX        # Specify the tenant ID for Azure AD.
+      client_id: XXXXXXXXXXX        # Specify the OAuth2 client ID for Azure AD.
+      client_secret: XXXXXXXXXXX    # Specify the Azure AD OAuth2 client secret.
+      redirect_uri: https://localhost:8443/oauth2/azure/callback # Specify the OAuth2 redirect URI for Azure AD.
+      scope: ['openid', 'profile', 'email', 'https://graph.microsoft.com/mail.read']
+      signin_module:                # Specify the module name that implements the sign-in. see, cmdbox.app.signin.SignIn
+      note:                         # Specify a description, such as a reference site for Azure AD's OAuth2.
+      - https://learn.microsoft.com/ja-jp/entra/identity-platform/v2-oauth2-auth-code-flow

cmdbox/version.py

@@ -1,9 +1,9 @@
 import datetime
 
-dt_now = datetime.datetime(2025, 3, 13)
+dt_now = datetime.datetime(2025, 3, 26)
 __appid__ = 'cmdbox'
 __title__ = 'cmdbox (Command Development Application)'
-__version__ = '0.5.0.7'
+__version__ = '0.5.1'
 __copyright__ = f'Copyright © 2023-{dt_now.strftime("%Y")} hamacom2004jp'
 __pypiurl__ = 'https://pypi.org/project/cmdbox/'
 __srcurl__ = 'https://github.com/hamacom2004jp/cmdbox'

cmdbox/web/assets/cmdbox/list_cmd.js

@@ -15,11 +15,58 @@ const list_cmd_func = async () => {
         }
         elem.find('.cmd_title').text(row.title);
         elem.find('.cmd_mode').text(row.mode);
-        elem.find('.cmd_cmd').text(row.cmd);
+        elem.find('.cmd_cmd').text(row.cmd)
+        if (row.tag && Array.isArray(row.tag)) {
+            const tags = new Set([...row.tag]);
+            elem.find('.cmd_card').attr('data-tags', Array.from(tags).join(','));
+        }
         $('#cmd_items').append(elem);
     };
     py_list_cmd.forEach(row => {card_func(row, true)});
     py_list_cmd.forEach(row => {card_func(row, false)});
+    $('#cmd_item_tags').html('');
+    py_list_cmd.forEach(row => {
+        if (!row.tag || !Array.isArray(row.tag)) return;
+        const cmd_item_tags = $('#cmd_item_tags');
+        row.tag.forEach(tag => {
+            if (tag=='') return;
+            if (cmd_item_tags.find(`[data-tag="${tag}"]`).length > 0) return;
+            const elem = $(`<button type="button" class="btn btn-outline-secondary btn-sm btn-tag me-2">${tag}</button>`);
+            elem.attr('data-tag', tag);
+            elem.text(tag);
+            elem.click((e) => {
+                const ct = $(e.currentTarget);
+                const cmd_items = $('#cmd_items').find('.cmd_card:not(.cmd_add)');
+                if (ct.hasClass('btn-secondary')) {
+                    ct.removeClass('btn-secondary');
+                    ct.addClass('btn-outline-secondary');
+                }
+                else if (ct.hasClass('btn-outline-secondary')) {
+                    ct.removeClass('btn-outline-secondary');
+                    ct.addClass('btn-secondary');
+                }
+                const tags = new Set();
+                cmd_item_tags.find('.btn-tag').each((i, elem) => {
+                    if ($(elem).hasClass('btn-secondary')) tags.add($(elem).attr('data-tag'));
+                });
+                if (tags.size == 0) {
+                    cmd_items.parent().show();
+                    return;
+                }
+                cmd_items.parent().hide();
+                tags.forEach(tag => {
+                    cmd_items.each((i, elem) => {
+                        const el = $(elem);
+                        const itags = el.attr('data-tags');
+                        if (!itags) return;
+                        else if (itags.split(',').includes(tag)) el.parent().show();
+                    });
+                });
+            });
+            cmd_item_tags.append(elem);
+        });
+        
+    });
 }
 // コマンドファイルの取得が出来た時の処理
 const list_cmd_func_then = () => {
@@ -71,6 +118,7 @@ const list_cmd_func_then = () => {
                 const target_name = row.opt;
                 let input_elem, elem;
                 if(!row.choice) {
+                    // 選択肢がない場合
                     if(row.type=='text') {
                         elem = $(cmd_modal.find('.row_content_template_text').html());
                     } else if(row.type=='dict') {
@@ -85,11 +133,16 @@ const list_cmd_func_then = () => {
                     input_elem.val(row.default);
                 }
                 else {
-                    elem = $(cmd_modal.find('.row_content_template_choice').html());
+                    // 選択肢がある場合
+                    if(row.type=='dict') {
+                        elem = $(cmd_modal.find('.row_content_template_dict_choice').html());
+                    } else {
+                        elem = $(cmd_modal.find('.row_content_template_choice').html());
+                    }
                     if (next_elem) next_elem.after(elem);
                     else row_content.append(elem);
-                    input_elem = elem.find('.row_content_template_select');
-                    input_elem.removeClass('row_content_template_select');
+                    input_elem = elem.find('.row_content_template_select,.row_content_template_input');
+                    input_elem.removeClass('row_content_template_select').removeClass('row_content_template_input');
                     if (row.choice_show) {
                         input_elem.addClass('choice_show');
                         input_elem.change(() => {
@@ -109,7 +162,7 @@ const list_cmd_func_then = () => {
                         });
                     }
                     input_elem.html(mkopt(row.choice));
-                    input_elem.val(`${row.default}`);
+                    input_elem.val(`${row.default!=null?row.default:''}`);
                 }
                 let index = 0;
                 if (cmd_modal.find(`[name="${target_name}"]`).length > 0) {
@@ -205,7 +258,8 @@ const list_cmd_func_then = () => {
                 }
                 title.append(`<span>${row.opt}</span>`);
                 if (row.hide) {
-                    elem.addClass('row_content_hide').hide();
+                    if (row_content.find('.row_content_hide').is(':hidden')) elem.hide();
+                    elem.addClass('row_content_hide');
                 } else {
                     title.addClass('text-decoration-underline');
                 }
@@ -478,6 +532,7 @@ const get_param = (modal_elem) => {
                 $(elem).addClass('is-valid');
             }
         } else if (data_type=='dict') {
+            data_val = data_val ? data_val : '';
             if(data_val.indexOf(' ')>=0) $(elem).addClass('is-invalid');
             else {
                 $(elem).removeClass('is-invalid');

cmdbox/web/assets/cmdbox/signin.js

@@ -58,6 +58,7 @@ $(() => {
     });
     const btn_google = $('.btn-google');
     const btn_github = $('.btn-github');
+    const btn_azure = $('.btn-azure');
     btn_google.off('click').on('click', async (event) => {
         const path = window.location.pathname.replace('/signin', '');
         window.location.href = `../oauth2/google${path}?n=${cmdbox.randam_string(8)}`;
@@ -66,11 +67,17 @@ $(() => {
         const path = window.location.pathname.replace('/signin', '');
         window.location.href = `../oauth2/github${path}?n=${cmdbox.randam_string(8)}`;
     });
+    btn_azure.off('click').on('click', async (event) => {
+        const path = window.location.pathname.replace('/signin', '');
+        window.location.href = `../oauth2/azure${path}?n=${cmdbox.randam_string(8)}`;
+    });
     oauth2_enabled().then((res) => {
         if (res.google) btn_google.show();
         else btn_google.hide();
         if (res.github) btn_github.show();
         else btn_github.hide();
+        if (res.azure) btn_azure.show();
+        else btn_azure.hide();
     });
 });
 const get_client_data = async () => {

cmdbox/web/gui.html

@@ -113,6 +113,7 @@
             Commands : 
             <input id="cmd_kwd" name="cmd_kwd" type="text" class="form-control d-inline-block" style="width:200px;" placeholder="Search title">
         </h2>
+        <div id="cmd_item_tags" class="mb-2"></div>
         <div id="cmd_items" class="row">
         </div>
         <div class="d-none">
@@ -251,6 +252,17 @@
                             </div>
                         </div>
                     </div>
+                    <div class="row d-none row_content_template_dict_choice">
+                        <div class="col-12 mb-3">
+                            <div class="input-group">
+                                <label class="input-group-text row_content_template_title">title</label>
+                                <input type="text" class="form-control row_content_key row_content_template_input">
+                                <label class="input-group-text">=</label>
+                                <select class="form-select row_content_template_select">
+                                </select>
+                            </div>
+                        </div>
+                    </div>
                     <div class="row d-none row_content_template_choice">
                         <div class="col-6 mb-3">
                             <div class="input-group">

cmdbox/web/signin.html

@@ -30,6 +30,9 @@
         <symbol id="github" viewBox="0 0 16 16">
             <path d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27s1.36.09 2 .27c1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.01 8.01 0 0 0 16 8c0-4.42-3.58-8-8-8"/>
         </symbol>
+        <symbol id="azure" viewBox="0 0 16 16">
+            <path d="M7.462 0H0v7.19h7.462zM16 0H8.538v7.19H16zM7.462 8.211H0V16h7.462zm8.538 0H8.538V16H16z"/>
+        </symbol>
         <symbol id="svg_eye_btn" viewBox="0 0 16 16">
             <path d="M16 8s-3-5.5-8-5.5S0 8 0 8s3 5.5 8 5.5S16 8 16 8M1.173 8a13 13 0 0 1 1.66-2.043C4.12 4.668 5.88 3.5 8 3.5s3.879 1.168 5.168 2.457A13 13 0 0 1 14.828 8q-.086.13-.195.288c-.335.48-.83 1.12-1.465 1.755C11.879 11.332 10.119 12.5 8 12.5s-3.879-1.168-5.168-2.457A13 13 0 0 1 1.172 8z"/>
             <path d="M8 5.5a2.5 2.5 0 1 0 0 5 2.5 2.5 0 0 0 0-5M4.5 8a3.5 3.5 0 1 1 7 0 3.5 3.5 0 0 1-7 0"/>
@@ -91,6 +94,10 @@
             </div>
             <button class="btn btn-primary w-100 py-2" type="submit">Sign in</button>
             <div class="mt-3">
+                <button class="btn btn-outline-primary w-100 py-2 mb-3 btn-azure" type="button" style="display:none;">
+                    <svg class="bi my-1 theme-icon-active" fill="currentColor" width="16" height="16"><use href="#azure"></use></svg>
+                    Sign in with Microsoft
+                </button>
                 <button class="btn btn-outline-primary w-100 py-2 mb-3 btn-google" type="button" style="display:none;">
                     <svg class="bi my-1 theme-icon-active" fill="currentColor" width="16" height="16"><use href="#google"></use></svg>
                     Sign in with Google

{cmdbox-0.5.0.7.dist-info → cmdbox-0.5.1.dist-info}/METADATA

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