jaaql-middleware-python 4.22.4__tar.gz → 4.22.5__tar.gz

{jaaql-middleware-python-4.22.4/jaaql_middleware_python.egg-info → jaaql-middleware-python-4.22.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: jaaql-middleware-python
-Version: 4.22.4
+Version: 4.22.5
 Summary: The jaaql package, allowing for rapid development and deployment of RESTful HTTP applications
 Home-page: https://github.com/JAAQL/JAAQL-middleware-python
 Author: Software Quality Measurement and Improvement bv

{jaaql-middleware-python-4.22.4 → jaaql-middleware-python-4.22.5}/jaaql/constants.py

@@ -43,6 +43,14 @@ KEY__oauth_token = "oauth_token"
 KEY__accounts = "accounts"
 KEY__registered = "registered"
 KEY__restrictions = "restrictions"
+KEY__command = "command"
+
+CRON_minute = "minute"
+CRON_hour = "hour"
+CRON_dayOfMonth = "dayOfMonth"
+CRON_month = "month"
+CRON_dayOfWeek = "dayOfWeek"
+CRON_year = "year"
 
 REGEX__dmbs_object_name = r'^[0-9a-zA-Z_]{1,32}$'
 
@@ -170,5 +178,5 @@ ROLE__postgres = "postgres"
 
 PROTOCOL__postgres = "postgresql://"
 
-VERSION = "4.22.4"
+VERSION = "4.22.5"
 

{jaaql-middleware-python-4.22.4 → jaaql-middleware-python-4.22.5}/jaaql/documentation/documentation_internal.py

@@ -215,3 +215,61 @@ DOCUMENTATION__set_web_config = SwaggerDocumentation(
         method=REST__POST
     )
 )
+
+DOCUMENTATION__cron = SwaggerDocumentation(
+    tags="Cron",
+    methods=SwaggerMethod(
+        name="Set cron jobs for application",
+        description="Will add a cron jobs pertaining to an application",
+        method=REST__POST,
+        body=[
+            SwaggerArgumentResponse(
+                name=KEY__application,
+                description="The application of the cron job",
+                arg_type=str,
+                example=["out-and-about"]
+            ),
+            SwaggerArgumentResponse(
+                name=KEY__command,
+                description="The command to execute as root",
+                arg_type=str,
+                example=["node /path/to/my/script.js"]
+            ),
+            SwaggerArgumentResponse(
+                name=CRON_minute,
+                description="The minute of cron expression",
+                arg_type=ARG_RESP__allow_all,
+                required=False,
+                condition="Is supplied"
+            ),
+            SwaggerArgumentResponse(
+                name=CRON_hour,
+                description="The hour of cron expression",
+                arg_type=ARG_RESP__allow_all,
+                required=False,
+                condition="Is supplied"
+            ),
+            SwaggerArgumentResponse(
+                name=CRON_dayOfMonth,
+                description="The day of month of cron expression",
+                arg_type=ARG_RESP__allow_all,
+                required=False,
+                condition="Is supplied"
+            ),
+            SwaggerArgumentResponse(
+                name=CRON_month,
+                description="The month of cron expression",
+                arg_type=ARG_RESP__allow_all,
+                required=False,
+                condition="Is supplied"
+            ),
+            SwaggerArgumentResponse(
+                name=CRON_dayOfWeek,
+                description="The day of week of cron expression",
+                arg_type=ARG_RESP__allow_all,
+                required=False,
+                condition="Is supplied"
+            )
+        ]
+    )
+)

{jaaql-middleware-python-4.22.4 → jaaql-middleware-python-4.22.5}/jaaql/exceptions/jaaql_interpretable_handled_errors.py

@@ -307,3 +307,17 @@ class IncorrectPasswordVerification(JaaqlInterpretableHandledError):
             index=None,
             descriptor=descriptor
         )
+
+
+class UnhandledRemoteProcedureError(JaaqlInterpretableHandledError):
+    def __init__(self, message, descriptor=None):
+        super().__init__(
+            error_code=1023,
+            http_response_code=500,
+            table_name=None,
+            message=message,
+            column_name=None,
+            _set=None,
+            index=None,
+            descriptor=descriptor
+        )

{jaaql-middleware-python-4.22.4 → jaaql-middleware-python-4.22.5}/jaaql/mvc/controller.py

@@ -65,10 +65,9 @@ class JAAQLController(BaseJAAQLController):
 
         @self.publish_route('/accounts', DOCUMENTATION__create_account)
         def accounts(connection: DBInterface, http_inputs: dict):
-            registered = http_inputs[KEY__registered]
-            if registered is None:
-                registered = True
-            http_inputs.pop(KEY__registered)
+            registered = http_inputs.get(KEY__registered, True)
+            if KEY__registered in http_inputs:
+                http_inputs.pop(KEY__registered)
             self.model.create_account_with_potential_password(connection, **http_inputs, registered=registered)
 
         @self.publish_route('/accounts/batch', DOCUMENTATION__create_account_batch)
@@ -122,6 +121,10 @@ class JAAQLController(BaseJAAQLController):
             else:
                 return self.model.finish_security_event(http_inputs)
 
+        @self.publish_route('/cron', DOCUMENTATION__cron)
+        def cron(connection: DBInterface, http_inputs: dict):
+            self.model.add_cron_job_to_application(connection, http_inputs)
+
         @self.publish_route('/internal/set-web-config', DOCUMENTATION__set_web_config)
         def set_web_config(connection: DBInterface):
             self.model.set_web_config(connection)

{jaaql-middleware-python-4.22.4 → jaaql-middleware-python-4.22.5}/jaaql/mvc/exception_queries.py

@@ -1,5 +1,5 @@
 """
-This script was generated from jaaql.exceptions.fxli at 2024-03-22, 22:17:50
+This script was generated from jaaql.exceptions.fxli at 2024-03-29, 04:52:17
 """
 
 from jaaql.utilities.crypt_utils import get_repeatable_salt

{jaaql-middleware-python-4.22.4 → jaaql-middleware-python-4.22.5}/jaaql/mvc/generated_queries.py

@@ -1,5 +1,5 @@
 """
-This script was generated from jaaql.fxli at 2024-03-22, 22:17:50
+This script was generated from jaaql.fxli at 2024-03-29, 04:52:17
 """
 
 from jaaql.db.db_interface import DBInterface

{jaaql-middleware-python-4.22.4 → jaaql-middleware-python-4.22.5}/jaaql/mvc/model.py

@@ -1,3 +1,4 @@
+import sys
 import uuid
 
 import re
@@ -127,12 +128,9 @@ class JAAQLModel(BaseJAAQLModel):
 
     def create_account_batch_with_potential_password(self, connection: DBInterface, accounts: list):
         for cur_input in accounts:
-            registered = cur_input[KEY__registered]
-            if registered is None:
-                registered = True
             self.create_account_with_potential_password(
                 connection, cur_input[KEY__username], cur_input[KEY__attach_as],
-                cur_input[KEY__password], allow_already_exists=True, registered=registered
+                cur_input[KEY__password], allow_already_exists=True, registered=cur_input.get(KEY__registered, True)
             )
 
     def validate_query(self, queries: list, query, allow_list=True):
@@ -394,6 +392,7 @@ WHERE
             if not self.vault.get_obj(VAULT_KEY__allow_jaaql_uninstall):
                 raise HttpStatusException("JAAQL not permitted to uninstall itself")
             DBPGInterface.close_all_pools()
+            subprocess.run("crontab -l | grep -v '# jaaql__' | crontab -", check=True, shell=True)
             subprocess.call("./pg_reboot.sh", cwd="/")
         else:
             subprocess.call("docker kill jaaql_pg")
@@ -1143,6 +1142,41 @@ WHERE
 
             raise err
 
+    @staticmethod
+    def cron_expression_to_string(cron: dict) -> str:
+        """
+        Converts a CronExpression object into a cron expression string.
+        """
+
+        def format_field(field):
+            if isinstance(field, list):
+                return ','.join(map(str, field))
+            elif field is None:
+                return '*'
+            return str(field)
+
+        parts = [
+            format_field(cron.get(CRON_minute)),
+            format_field(cron.get(CRON_hour)),
+            format_field(cron.get(CRON_dayOfMonth)),
+            format_field(cron.get(CRON_month)),
+            format_field(cron.get(CRON_dayOfWeek)),
+            format_field(cron.get(CRON_year))
+        ]
+        return ' '.join(parts)
+
+    def add_cron_job_to_application(self, connection: DBInterface, cron_input: dict):
+        self.is_super_admin(connection)
+        if self.is_container:
+            application = cron_input.pop(KEY__application)
+            application__select(connection, application)
+            command = cron_input.pop(KEY__command)
+            cron_string = self.cron_expression_to_string(cron_input)
+            cron_command = '(crontab - l 2 > /dev/null; echo "' + cron_string + ' ' + command + '  # jaaql__' + application + '") | crontab -'
+            subprocess.run(cron_command, check=True, shell=True)
+        else:
+            print("Cron not supported in debugging mode", file=sys.stderr)
+
     def submit(self, inputs: dict, account_id: str, verification_hook: Queue = None, as_objects: bool = False, singleton: bool = False):
         return submit(self.vault, self.config, self.get_db_crypt_key(), self.jaaql_lookup_connection, inputs, account_id, verification_hook,
                       self.cached_canned_query_service, as_objects=as_objects, singleton=singleton)

{jaaql-middleware-python-4.22.4 → jaaql-middleware-python-4.22.5/jaaql_middleware_python.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: jaaql-middleware-python
-Version: 4.22.4
+Version: 4.22.5
 Summary: The jaaql package, allowing for rapid development and deployment of RESTful HTTP applications
 Home-page: https://github.com/JAAQL/JAAQL-middleware-python
 Author: Software Quality Measurement and Improvement bv