def publisher_snap_metrics(snap_name): """ A view to display the snap metrics page for specific snaps. This queries the snapcraft API (api.snapcraft.io) and passes some of the data through to the publisher/metrics.html template, with appropriate sanitation. """ try: details = api.get_snap_info(snap_name, flask.session) except ApiResponseErrorList as api_response_error_list: if api_response_error_list.status_code == 404: return flask.abort(404, "No snap named {}".format(snap_name)) else: return _handle_error_list(api_response_error_list.errors) except ApiError as api_error: return _handle_error(api_error) metric_requested = logic.extract_metrics_period( flask.request.args.get("period", default="30d", type=str)) installed_base_metric = logic.verify_base_metrics( flask.request.args.get("active-devices", default="version", type=str)) installed_base = logic.get_installed_based_metric(installed_base_metric) metrics_query_json = metrics_helper.build_metrics_json( snap_id=details["snap_id"], installed_base=installed_base, metric_period=metric_requested["int"], metric_bucket=metric_requested["bucket"], ) try: metrics_response = api.get_publisher_metrics(flask.session, json=metrics_query_json) except ApiResponseErrorList as api_response_error_list: if api_response_error_list.status_code == 404: return flask.abort(404, "No snap named {}".format(snap_name)) else: return _handle_error_list(api_response_error_list.errors) except ApiError as api_error: return _handle_error(api_error) active_metrics = metrics_helper.find_metric(metrics_response["metrics"], installed_base) active_devices = metrics.ActiveDevices( name=active_metrics["metric_name"], series=active_metrics["series"], buckets=active_metrics["buckets"], status=active_metrics["status"], ) latest_active = 0 if active_devices: latest_active = active_devices.get_number_latest_active_devices() country_metric = metrics_helper.find_metric( metrics_response["metrics"], "weekly_installed_base_by_country") country_devices = metrics.CountryDevices( name=country_metric["metric_name"], series=country_metric["series"], buckets=country_metric["buckets"], status=country_metric["status"], private=True, ) territories_total = 0 if country_devices: territories_total = country_devices.get_number_territories() nodata = not any([country_devices, active_devices]) # until default tracks are supported by the API we special case node # to use 10, rather then latest default_track = helpers.get_default_track(snap_name) annotations = {"name": "annotations", "series": [], "buckets": []} for category in details["categories"]["items"]: date = category["since"].split("T")[0] new_date = logic.convert_date(category["since"]) if date not in annotations["buckets"]: annotations["buckets"].append(date) index_of_date = annotations["buckets"].index(date) single_series = { "values": [0] * (len(annotations)), "name": category["name"], "display_name": category["name"].capitalize().replace("-", " "), "display_date": new_date, "date": date, } single_series["values"][index_of_date] = 1 annotations["series"].append(single_series) annotations["series"] = sorted(annotations["series"], key=lambda k: k["date"]) context = { # Data direct from details API "snap_name": snap_name, "snap_title": details["title"], "metric_period": metric_requested["period"], "active_device_metric": installed_base_metric, "default_track": default_track, "private": details["private"], # Metrics data "nodata": nodata, "latest_active_devices": latest_active, "active_devices": dict(active_devices), "territories_total": territories_total, "territories": country_devices.country_data, "active_devices_annotations": annotations, # Context info "is_linux": "Linux" in flask.request.headers["User-Agent"], } return flask.render_template("publisher/metrics.html", **context)
def _get_context_snap_details(snap_name): try: details = api.get_item_details(snap_name, api_version=2) except StoreApiTimeoutError as api_timeout_error: flask.abort(504, str(api_timeout_error)) except StoreApiResponseDecodeError as api_response_decode_error: flask.abort(502, str(api_response_decode_error)) except StoreApiResponseErrorList as api_response_error_list: if api_response_error_list.status_code == 404: flask.abort(404, "No snap named {}".format(snap_name)) else: if api_response_error_list.errors: error_messages = ", ".join( api_response_error_list.errors.key()) else: error_messages = "An error occurred." flask.abort(502, error_messages) except StoreApiResponseError as api_response_error: flask.abort(502, str(api_response_error)) except StoreApiCircuitBreaker: flask.abort(503) except (StoreApiError, ApiError) as api_error: flask.abort(502, str(api_error)) # When removing all the channel maps of an existing snap the API, # responds that the snaps still exists with data. # Return a 404 if not channel maps, to avoid having a error. # For example: mir-kiosk-browser if not details.get("channel-map"): flask.abort(404, "No snap named {}".format(snap_name)) clean_description = bleach.clean(details["snap"]["description"], tags=[]) formatted_description = parse_markdown_description(clean_description) channel_maps_list = logic.convert_channel_maps( details.get("channel-map")) latest_channel = logic.get_last_updated_version( details.get("channel-map")) last_updated = latest_channel["created-at"] last_version = latest_channel["version"] binary_filesize = latest_channel["download"]["size"] # filter out banner and banner-icon images from screenshots screenshots = logic.filter_screenshots(details["snap"]["media"]) icons = logic.get_icon(details["snap"]["media"]) publisher_info = helpers.get_yaml( "{}{}.yaml".format( flask.current_app.config["CONTENT_DIRECTORY"] ["PUBLISHER_PAGES"], details["snap"]["publisher"]["username"], ), typ="safe", ) publisher_snaps = helpers.get_yaml( "{}{}-snaps.yaml".format( flask.current_app.config["CONTENT_DIRECTORY"] ["PUBLISHER_PAGES"], details["snap"]["publisher"]["username"], ), typ="safe", ) publisher_featured_snaps = None if publisher_info: publisher_featured_snaps = publisher_info.get("featured_snaps") publisher_snaps = logic.get_n_random_snaps( publisher_snaps["snaps"], 4) videos = logic.get_videos(details["snap"]["media"]) # until default tracks are supported by the API we special case node # to use 10, rather then latest default_track = helpers.get_default_track(details["name"]) if not default_track: default_track = (details.get("default-track") if details.get("default-track") else "latest") lowest_risk_available = logic.get_lowest_available_risk( channel_maps_list, default_track) confinement = logic.get_confinement(channel_maps_list, default_track, lowest_risk_available) last_version = logic.get_version(channel_maps_list, default_track, lowest_risk_available) is_users_snap = False if authentication.is_authenticated(flask.session): if (flask.session.get("openid").get("nickname") == details["snap"]["publisher"]["username"] ) or ("user_shared_snaps" in flask.session and snap_name in flask.session.get("user_shared_snaps")): is_users_snap = True # build list of categories of a snap categories = logic.get_snap_categories(details["snap"]["categories"]) developer = logic.get_snap_developer(details["name"]) context = { "snap-id": details.get("snap-id"), # Data direct from details API "snap_title": details["snap"]["title"], "package_name": details["name"], "categories": categories, "icon_url": icons[0] if icons else None, "version": last_version, "license": details["snap"]["license"], "publisher": details["snap"]["publisher"]["display-name"], "username": details["snap"]["publisher"]["username"], "screenshots": screenshots, "videos": videos, "publisher_snaps": publisher_snaps, "publisher_featured_snaps": publisher_featured_snaps, "has_publisher_page": publisher_info is not None, "prices": details["snap"]["prices"], "contact": details["snap"].get("contact"), "website": details["snap"].get("website"), "summary": details["snap"]["summary"], "description": formatted_description, "channel_map": channel_maps_list, "has_stable": logic.has_stable(channel_maps_list), "developer_validation": details["snap"]["publisher"]["validation"], "default_track": default_track, "lowest_risk_available": lowest_risk_available, "confinement": confinement, "trending": details["snap"]["trending"], # Transformed API data "filesize": humanize.naturalsize(binary_filesize), "last_updated": logic.convert_date(last_updated), "last_updated_raw": last_updated, "is_users_snap": is_users_snap, "unlisted": details["snap"]["unlisted"], "developer": developer, # TODO: This is horrible and hacky "appliances": { "adguard-home": "adguard", "mosquitto": "mosquitto", "nextcloud": "nextcloud", "plexmediaserver": "plex", "openhab": "openhab", }, } return context
def _get_context_snap_details(snap_name): try: details = api.get_snap_details(snap_name) except ApiTimeoutError as api_timeout_error: flask.abort(504, str(api_timeout_error)) except ApiResponseDecodeError as api_response_decode_error: flask.abort(502, str(api_response_decode_error)) except ApiResponseErrorList as api_response_error_list: if api_response_error_list.status_code == 404: flask.abort(404, "No snap named {}".format(snap_name)) else: if api_response_error_list.errors: error_messages = ", ".join( api_response_error_list.errors.key()) else: error_messages = "An error occurred." flask.abort(502, error_messages) except ApiResponseError as api_response_error: flask.abort(502, str(api_response_error)) except ApiCircuitBreaker: flask.abort(503) except ApiError as api_error: flask.abort(502, str(api_error)) # When removing all the channel maps of an exsting snap the API, # responds that the snaps still exists with data. # Return a 404 if not channel maps, to avoid having a error. # For example: mir-kiosk-browser if not details.get("channel-map"): flask.abort(404, "No snap named {}".format(snap_name)) clean_description = bleach.clean(details["snap"]["description"], tags=[]) formatted_description = parse_markdown_description(clean_description) channel_maps_list = logic.convert_channel_maps( details.get("channel-map")) latest_channel = logic.get_last_updated_version( details.get("channel-map")) last_updated = latest_channel["created-at"] last_version = latest_channel["version"] binary_filesize = latest_channel["download"]["size"] # filter out banner and banner-icon images from screenshots screenshots = logic.filter_screenshots(details["snap"]["media"]) icons = logic.get_icon(details["snap"]["media"]) videos = logic.get_videos(details["snap"]["media"]) # until default tracks are supported by the API we special case node # to use 10, rather then latest default_track = helpers.get_default_track(details["name"]) lowest_risk_available = logic.get_lowest_available_risk( channel_maps_list, default_track) confinement = logic.get_confinement(channel_maps_list, default_track, lowest_risk_available) last_version = logic.get_version(channel_maps_list, default_track, lowest_risk_available) is_users_snap = False if flask.session and "openid" in flask.session: if (flask.session.get("openid").get("nickname") == details["snap"] ["publisher"]["username"]): is_users_snap = True # build list of categories of a snap categories = logic.get_snap_categories(details["snap"]["categories"]) context = { "snap-id": details.get("snap-id"), # Data direct from details API "snap_title": details["snap"]["title"], "package_name": details["name"], "categories": categories, "icon_url": icons[0] if icons else None, "version": last_version, "license": details["snap"]["license"], "publisher": details["snap"]["publisher"]["display-name"], "username": details["snap"]["publisher"]["username"], "screenshots": screenshots, "videos": videos, "prices": details["snap"]["prices"], "contact": details["snap"].get("contact"), "website": details["snap"].get("website"), "summary": details["snap"]["summary"], "description": formatted_description, "channel_map": channel_maps_list, "has_stable": logic.has_stable(channel_maps_list), "developer_validation": details["snap"]["publisher"]["validation"], "default_track": default_track, "lowest_risk_available": lowest_risk_available, "confinement": confinement, # Transformed API data "filesize": humanize.naturalsize(binary_filesize), "last_updated": logic.convert_date(last_updated), "last_updated_raw": last_updated, "is_users_snap": is_users_snap, } return context
def _get_context_snap_details(snap_name): try: details = api.get_snap_details(snap_name) except ApiTimeoutError as api_timeout_error: flask.abort(504, str(api_timeout_error)) except ApiResponseDecodeError as api_response_decode_error: flask.abort(502, str(api_response_decode_error)) except ApiResponseErrorList as api_response_error_list: if api_response_error_list.status_code == 404: flask.abort(404, "No snap named {}".format(snap_name)) else: if api_response_error_list.errors: error_messages = ", ".join( api_response_error_list.errors.key() ) else: error_messages = "An error occurred." flask.abort(502, error_messages) except ApiResponseError as api_response_error: flask.abort(502, str(api_response_error)) except ApiCircuitBreaker: flask.abort(503) except ApiError as api_error: flask.abort(502, str(api_error)) # When removing all the channel maps of an exsting snap the API, # responds that the snaps still exists with data. # Return a 404 if not channel maps, to avoid having a error. # For example: mir-kiosk-browser if not details.get("channel-map"): flask.abort(404, "No snap named {}".format(snap_name)) clean_description = bleach.clean(details["snap"]["description"]) formatted_description = parse_markdown_description(clean_description) channel_maps_list = logic.convert_channel_maps( details.get("channel-map") ) latest_channel = logic.get_last_updated_version( details.get("channel-map") ) last_updated = latest_channel["created-at"] last_version = latest_channel["version"] binary_filesize = latest_channel["download"]["size"] # filter out banner and banner-icon images from screenshots screenshots = logic.filter_screenshots(details["snap"]["media"]) icons = logic.get_icon(details["snap"]["media"]) videos = logic.get_videos(details["snap"]["media"]) # until default tracks are supported by the API we special case node # to use 10, rather then latest default_track = helpers.get_default_track(details["name"]) lowest_risk_available = logic.get_lowest_available_risk( channel_maps_list, default_track ) confinement = logic.get_confinement( channel_maps_list, default_track, lowest_risk_available ) last_version = logic.get_version( channel_maps_list, default_track, lowest_risk_available ) is_users_snap = False if flask.session and "openid" in flask.session: if ( flask.session.get("openid").get("nickname") == details["snap"]["publisher"]["username"] ): is_users_snap = True # build list of categories of a snap categories = logic.get_snap_categories(details["snap"]["categories"]) context = { "snap-id": details.get("snap-id"), # Data direct from details API "snap_title": details["snap"]["title"], "package_name": details["name"], "categories": categories, "icon_url": icons[0] if icons else None, "version": last_version, "license": details["snap"]["license"], "publisher": details["snap"]["publisher"]["display-name"], "username": details["snap"]["publisher"]["username"], "screenshots": screenshots, "videos": videos, "prices": details["snap"]["prices"], "contact": details["snap"].get("contact"), "website": details["snap"].get("website"), "summary": details["snap"]["summary"], "description": formatted_description, "channel_map": channel_maps_list, "has_stable": logic.has_stable(channel_maps_list), "developer_validation": details["snap"]["publisher"]["validation"], "default_track": default_track, "lowest_risk_available": lowest_risk_available, "confinement": confinement, # Transformed API data "filesize": humanize.naturalsize(binary_filesize), "last_updated": logic.convert_date(last_updated), "last_updated_raw": last_updated, "is_users_snap": is_users_snap, } return context
def publisher_snap_metrics(snap_name): """ A view to display the snap metrics page for specific snaps. This queries the snapcraft API (api.snapcraft.io) and passes some of the data through to the publisher/metrics.html template, with appropriate sanitation. """ try: details = api.get_snap_info(snap_name, flask.session) except ApiResponseErrorList as api_response_error_list: if api_response_error_list.status_code == 404: return flask.abort(404, "No snap named {}".format(snap_name)) else: return _handle_error_list(api_response_error_list.errors) except ApiError as api_error: return _handle_errors(api_error) metric_requested = logic.extract_metrics_period( flask.request.args.get("period", default="30d", type=str) ) installed_base_metric = logic.verify_base_metrics( flask.request.args.get("active-devices", default="version", type=str) ) installed_base = logic.get_installed_based_metric(installed_base_metric) metrics_query_json = metrics_helper.build_metrics_json( snap_id=details["snap_id"], installed_base=installed_base, metric_period=metric_requested["int"], metric_bucket=metric_requested["bucket"], ) try: metrics_response = api.get_publisher_metrics( flask.session, json=metrics_query_json ) except ApiResponseErrorList as api_response_error_list: if api_response_error_list.status_code == 404: return flask.abort(404, "No snap named {}".format(snap_name)) else: return _handle_error_list(api_response_error_list.errors) except ApiError as api_error: return _handle_errors(api_error) active_metrics = metrics_helper.find_metric( metrics_response["metrics"], installed_base ) active_devices = metrics.ActiveDevices( name=active_metrics["metric_name"], series=active_metrics["series"], buckets=active_metrics["buckets"], status=active_metrics["status"], ) latest_active = 0 if active_devices: latest_active = active_devices.get_number_latest_active_devices() country_metric = metrics_helper.find_metric( metrics_response["metrics"], "weekly_installed_base_by_country" ) country_devices = metrics.CountryDevices( name=country_metric["metric_name"], series=country_metric["series"], buckets=country_metric["buckets"], status=country_metric["status"], private=True, ) territories_total = 0 if country_devices: territories_total = country_devices.get_number_territories() nodata = not any([country_devices, active_devices]) # until default tracks are supported by the API we special case node # to use 10, rather then latest default_track = helpers.get_default_track(snap_name) annotations = {"name": "annotations", "series": [], "buckets": []} for category in details["categories"]["items"]: date = category["since"].split("T")[0] new_date = logic.convert_date(category["since"]) if date not in annotations["buckets"]: annotations["buckets"].append(date) index_of_date = annotations["buckets"].index(date) single_series = { "values": [0] * (len(annotations)), "name": category["name"], "display_name": category["name"].capitalize().replace("-", " "), "display_date": new_date, "date": date, } single_series["values"][index_of_date] = 1 annotations["series"].append(single_series) annotations["series"] = sorted( annotations["series"], key=lambda k: k["date"] ) context = { # Data direct from details API "snap_name": snap_name, "snap_title": details["title"], "metric_period": metric_requested["period"], "active_device_metric": installed_base_metric, "default_track": default_track, "private": details["private"], # Metrics data "nodata": nodata, "latest_active_devices": latest_active, "active_devices": dict(active_devices), "territories_total": territories_total, "territories": country_devices.country_data, "active_devices_annotations": annotations, # Context info "is_linux": "Linux" in flask.request.headers["User-Agent"], } return flask.render_template("publisher/metrics.html", **context)