howler-api 2.10.0.dev255__py3-none-any.whl → 2.13.0.dev344__py3-none-any.whl

howler/api/v1/view.py

@@ -1,15 +1,7 @@
 from flask import request
 from mergedeep.mergedeep import merge
 
-from howler.api import (
-    bad_request,
-    created,
-    forbidden,
-    make_subapi_blueprint,
-    no_content,
-    not_found,
-    ok,
-)
+from howler.api import bad_request, created, forbidden, make_subapi_blueprint, no_content, not_found, ok
 from howler.common.exceptions import HowlerException
 from howler.common.loader import datastore
 from howler.common.logging import get_logger
@@ -46,9 +38,7 @@ def get_views(user: User, **kwargs):
     try:
         return ok(
             datastore().view.search(
-                f"type:global OR owner:({user['uname']} OR none)",
-                as_obj=False,
-                rows=1000,
+                f"type:global OR owner:({user['uname']} OR none)", as_obj=False, rows=1000, sort="title asc"
             )["items"]
         )
     except ValueError as e:
@@ -118,13 +108,13 @@ def create_view(**kwargs):
 
 
 @generate_swagger_docs()
-@view_api.route("/<id>", methods=["DELETE"])
+@view_api.route("/<view_id>", methods=["DELETE"])
 @api_login(required_priv=["W"])
-def delete_view(id: str, user: User, **kwargs):
+def delete_view(view_id: str, user: User, **kwargs):
     """Delete a view
 
     Variables:
-    id => The id of the view to delete
+    view_id => The id of the view to delete
 
     Optional Arguments:
     None
@@ -139,7 +129,7 @@ def delete_view(id: str, user: User, **kwargs):
     """
     storage = datastore()
 
-    existing_view: View = storage.view.get_if_exists(id)
+    existing_view: View = storage.view.get_if_exists(view_id)
     if not existing_view:
         return not_found(err="This view does not exist")
 
@@ -149,7 +139,7 @@ def delete_view(id: str, user: User, **kwargs):
     if existing_view.type == "readonly":
         return forbidden(err="You cannot delete built-in views.")
 
-    success = storage.view.delete(id)
+    success = storage.view.delete(view_id)
 
     storage.view.commit()
 
@@ -157,13 +147,13 @@ def delete_view(id: str, user: User, **kwargs):
 
 
 @generate_swagger_docs()
-@view_api.route("/<id>", methods=["PUT"])
+@view_api.route("/<view_id>", methods=["PUT"])
 @api_login(required_priv=["R", "W"])
-def update_view(id: str, user: User, **kwargs):
+def update_view(view_id: str, user: User, **kwargs):
     """Update a view
 
     Variables:
-    id => The id of the view to modify
+    view_id => The view_id of the view to modify
 
     Optional Arguments:
     None
@@ -185,10 +175,10 @@ def update_view(id: str, user: User, **kwargs):
     if not isinstance(new_data, dict):
         return bad_request(err="Invalid data format")
 
-    if set(new_data.keys()) - {"title", "query", "span", "sort", "settings"}:
-        return bad_request(err="Only title, query, span and sort can be updated.")
+    if set(new_data.keys()) & {"view_id", "owner"}:
+        return bad_request(err="You cannot change the owner or id of a view.")
 
-    existing_view: View = storage.view.get_if_exists(id)
+    existing_view: View = storage.view.get_if_exists(view_id)
     if not existing_view:
         return not_found(err="This view does not exist")
 
@@ -220,13 +210,13 @@ def update_view(id: str, user: User, **kwargs):
 
 
 @generate_swagger_docs()
-@view_api.route("/<id>/favourite", methods=["POST"])
+@view_api.route("/<view_id>/favourite", methods=["POST"])
 @api_login(required_priv=["R", "W"])
-def set_as_favourite(id: str, **kwargs):
+def set_as_favourite(view_id: str, **kwargs):
     """Add a view to a list of the user's favourites
 
     Variables:
-    id => The id of the view to add as a favourite
+    view_id => The id of the view to add as a favourite
 
     Optional Arguments:
     None
@@ -241,7 +231,7 @@ def set_as_favourite(id: str, **kwargs):
     """
     storage = datastore()
 
-    existing_view: View = storage.view.get_if_exists(id)
+    existing_view: View = storage.view.get_if_exists(view_id)
     if not existing_view:
         return not_found(err="This view does not exist")
 
@@ -253,7 +243,7 @@ def set_as_favourite(id: str, **kwargs):
     try:
         current_user = storage.user.get_if_exists(kwargs["user"]["uname"])
 
-        current_user["favourite_views"] = list(set(current_user.get("favourite_views", []) + [id]))
+        current_user["favourite_views"] = list(set(current_user.get("favourite_views", []) + [view_id]))
 
         storage.user.save(current_user["uname"], current_user)
 
@@ -263,9 +253,9 @@ def set_as_favourite(id: str, **kwargs):
 
 
 @generate_swagger_docs()
-@view_api.route("/<id>/favourite", methods=["DELETE"])
+@view_api.route("/<view_id>/favourite", methods=["DELETE"])
 @api_login(required_priv=["R", "W"])
-def remove_as_favourite(id, **kwargs):
+def remove_as_favourite(view_id: str, **kwargs):
     """Remove a view from a list of the user's favourites
 
     Variables:
@@ -281,13 +271,15 @@ def remove_as_favourite(id, **kwargs):
     """
     storage = datastore()
 
-    if not storage.view.exists(id):
-        return not_found(err="This view does not exist")
-
     try:
         current_user = storage.user.get_if_exists(kwargs["user"]["uname"])
 
-        current_user["favourite_views"] = list(filter(lambda f: f != id, current_user.get("favourite_views", [])))
+        current_favourites: list[str] = current_user.get("favourite_views", [])
+
+        if view_id not in current_favourites:
+            return not_found(err="View is not favourited.")
+
+        current_user["favourite_views"] = [favourite for favourite in current_favourites if favourite != view_id]
 
         storage.user.save(current_user["uname"], current_user)
 

howler/app.py

@@ -138,11 +138,11 @@ if HWL_USE_REST_API or DEBUG:
         logger.debug("Enabled Notebook Integration")
         app.register_blueprint(notebook_api)
 
-    if config.core.borealis.enabled:
-        from howler.api.v1.borealis import borealis_api
+    if config.core.clue.enabled:
+        from howler.api.v1.clue import clue_api
 
-        logger.debug("Enabled Borealis Integration")
-        app.register_blueprint(borealis_api)
+        logger.debug("Enabled Clue Integration")
+        app.register_blueprint(clue_api)
 
     logger.info("Checking plugins for additional routes")
     for plugin in get_plugins():

howler/cronjobs/view_cleanup.py

@@ -0,0 +1,88 @@
+import os
+from datetime import datetime
+from typing import Any, List
+
+from apscheduler.schedulers.base import BaseScheduler
+from apscheduler.triggers.cron import CronTrigger
+from pytz import timezone
+
+from howler.common.logging import get_logger
+from howler.config import DEBUG, config
+
+logger = get_logger(__file__)
+
+
+def execute():
+    """Delete any pinned views that no longer exist"""
+    from howler.common.loader import datastore
+
+    # Initialize datastore
+    ds = datastore()
+    # fetch the first result from user ds (needed to initialize total)
+    result = ds.user.search("*:*", rows=250, fl="*")
+    total_user_count = result["total"]
+    user_list: List[Any] = result["items"]
+    # Do the same thing for the views
+    result = ds.view.search("*:*", rows=250)
+    total_view_count = result["total"]
+    view_list: List[Any] = result["items"]
+    view_ids: List[str] = []
+
+    # Collect all views
+    while len(view_list) < total_view_count:
+        view_list.extend(ds.view.search("*:*", rows=250, offset=len(user_list)))
+
+    # Collect all users
+    while len(user_list) < total_user_count:
+        user_list.extend(ds.user.search("*:*", rows=250, offset=len(user_list)))
+
+    for view in view_list:
+        view_ids.append(view["view_id"])
+
+    # Iterate over each user to see if the dashboard contains invalid entries (deleted views)
+    for user in user_list:
+        valid_entries = []
+        # No views/analytics saved to the dashboard? Skip it
+        if user["dashboard"] == []:
+            continue
+        for dashboard_entry in user["dashboard"]:
+            if dashboard_entry["type"] != "view" or (
+                dashboard_entry["type"] == "view" and dashboard_entry["entry_id"] in view_ids
+            ):
+                valid_entries.append(dashboard_entry)
+        # If the length of valid entries is less than the current dashboard, one or more pins are invalid
+        if len(valid_entries) < len(user["dashboard"]):
+            # set the user dashboard to valid entries
+            user["dashboard"] = valid_entries
+            # update the user
+            ds.user.save(user["uname"], user)
+
+
+def setup_job(sched: BaseScheduler):
+    """Initialize the view cleanup job"""
+    if not config.system.view_cleanup.enabled:
+        if not DEBUG or config.system.type == "production":
+            logger.warning("view cleanup cronjob disabled! This is not recommended for a production settings.")
+
+        return
+
+    logger.debug(f"Initializing view cleanup cronjob with cron {config.system.view_cleanup.crontab}")
+
+    if DEBUG:
+        _kwargs: dict[str, Any] = {"next_run_time": datetime.now()}
+    else:
+        _kwargs = {}
+
+    if sched.get_job("view_cleanup"):
+        logger.debug("view cleanup job already running!")
+        return
+
+    sched.add_job(
+        id="view_cleanup",
+        func=execute,
+        trigger=CronTrigger.from_crontab(
+            config.system.view_cleanup.crontab, timezone=timezone(os.getenv("SCHEDULER_TZ", "America/Toronto"))
+        ),
+        **_kwargs,
+    )
+    logger.debug("Initialization complete")

howler/datastore/README.md

@@ -83,8 +83,6 @@ class MyDatastore(object):
 Once you've setup your own datastore object, you can start using the different functions that each collection offers. Here's a breakdown:
 
 - `archive(query)`: Send all meatching documents to the archive of the collection
-- `get_bulk_plan()`: Create a bulk plan to be executed later using the bulk function
-- `bulk(bulk_plan)`: Execute the bulk plan
 - `multiget(id_list)`: Get multiple documents for the id_list
 - `exists(id)`: Check if a document matching this id exists
 - `get(id)`: Get a document matching the id (retry twice if missing)