swh.web package

Subpackages:

• swh.web.add_forge_now package
  • swh.web.add_forge_now.admin_views module
    • add_forge_now_requests_moderation_dashboard()
    • add_forge_now_request_dashboard()
  • swh.web.add_forge_now.api_views module
    • AddForgeNowRequestForm
    • AddForgeNowRequestHistoryForm
    • AddForgeNowRequestSerializer
    • AddForgeNowRequestPublicSerializer
    • AddForgeNowRequestHistorySerializer
    • AddForgeNowRequestHistoryPublicSerializer
    • api_add_forge_request_create()
    • api_add_forge_request_update()
    • api_add_forge_request_list()
    • api_add_forge_request_get()
  • swh.web.add_forge_now.apps module
    • AddForgeNowConfig
  • swh.web.add_forge_now.models module
    • RequestStatus
    • RequestActorRole
    • RequestHistory
    • Request
  • swh.web.add_forge_now.signal_receivers module
    • handle_inbound_message()
  • swh.web.add_forge_now.urls module
  • swh.web.add_forge_now.utils module
    • trigger_request_processing_pipeline()
  • swh.web.add_forge_now.views module
    • add_forge_request_list_datatables()
    • create_request_create()
    • create_request_list()
    • create_request_help()
    • create_request_message_source()
• swh.web.admin package
  • swh.web.admin.apps module
    • AdminConfig
  • swh.web.admin.urls module
• swh.web.alter package
  • swh.web.alter.templatetags package
    • swh.web.alter.templatetags.alter_extras module
  • swh.web.alter.apps module
    • AlterConfig
  • swh.web.alter.emails module
    • send_alteration_notification()
    • send_alteration_confirmation()
    • send_message_notification()
    • send_alteration_magic_link()
    • send_email_magic_link()
  • swh.web.alter.forms module
    • MultipleOriginField
    • EmailVerificationForm
    • OriginSearchForm
    • OriginSelectForm
    • ReasonsForm
    • ConfirmationForm
    • CategoryForm
    • AlterationAccessForm
    • AlterationSearchForm
    • OriginAdminForm
    • AlterationForm
    • AlterationAdminForm
    • MessageForm
    • MessageAdminForm
    • EventAdminForm
  • swh.web.alter.models module
    • BaseModel
    • OriginOutcome
    • OriginOwnership
    • Origin
    • AlterationManager
    • AlterationStatus
    • AlterationCategory
    • Alteration
    • EventRecipient
    • EventCategory
    • EventManager
    • Event
    • TOKEN_TTL
    • TOKEN_NBYTES
    • Token
    • validate_email_or_domain()
    • LowerCharField
    • BlockList
  • swh.web.alter.urls module
  • swh.web.alter.utils module
    • Step
    • get_django_group_emails()
    • get_keycloak_group_emails()
    • get_group_emails()
    • SESSION_ALTERATION_IDS
    • SESSION_VERIFIED_EMAIL
    • has_access()
    • set_access()
    • set_verified_email()
    • verified_email()
    • requestors_restricted()
    • generate_origin_changelog()
    • generate_alteration_changelog()
    • generate_changelog()
    • process_state()
    • redirect_to_step()
    • cleanup_session()
    • tunnel_step()
  • swh.web.alter.views module
    • content_policies()
    • assistant_email()
    • assistant_email_verification()
    • assistant_category()
    • assistant_origins()
    • assistant_reasons()
    • assistant_summary()
    • alteration_details()
    • alteration_message()
    • alteration_access()
    • alteration_link()
    • admin_dashboard()
    • admin_alteration()
    • admin_origin()
    • admin_message()
    • admin_event()
• swh.web.api package
  • swh.web.api.views package
    • swh.web.api.views.citation module
    • swh.web.api.views.content module
    • swh.web.api.views.directory module
    • swh.web.api.views.extid module
    • swh.web.api.views.graph module
    • swh.web.api.views.identifiers module
    • swh.web.api.views.metadata module
    • swh.web.api.views.origin module
    • swh.web.api.views.ping module
    • swh.web.api.views.raw module
    • swh.web.api.views.release module
    • swh.web.api.views.revision module
    • swh.web.api.views.snapshot module
    • swh.web.api.views.stat module
    • swh.web.api.views.utils module
  • swh.web.api.apidoc module
    • APIDocException
    • api_doc()
    • get_doc_data()
    • format_docstring()
  • swh.web.api.apiresponse module
    • compute_link_header()
    • filter_by_fields()
    • transform()
    • make_api_response()
    • error_response()
    • error_response_handler()
  • swh.web.api.apiurls module
    • APIUrls
    • api_route()
  • swh.web.api.parsers module
    • YAMLParser
  • swh.web.api.renderers module
    • YAMLRenderer
    • PlainTextRenderer
  • swh.web.api.serializers module
    • SoftLimitsIntegerField
    • SWHIDField
    • IRIField
  • swh.web.api.throttling module
    • SwhWebRateThrottle
    • SwhWebUserRateThrottle
    • throttle_scope()
  • swh.web.api.urls module
  • swh.web.api.utils module
    • filter_field_keys()
    • person_to_string()
    • enrich_object()
    • enrich_release()
    • enrich_directory_entry()
    • enrich_metadata_endpoint()
    • enrich_content()
    • enrich_revision()
    • enrich_snapshot()
    • enrich_origin()
    • enrich_origin_search_result()
    • enrich_origin_visit()
    • enrich_extid()
• swh.web.archive_coverage package
  • swh.web.archive_coverage.urls module
  • swh.web.archive_coverage.views module
    • get_listers_metrics()
    • swh_coverage()
• swh.web.auth package
  • swh.web.auth.apps module
    • AuthConfig
  • swh.web.auth.models module
    • OIDCUserOfflineTokens
  • swh.web.auth.urls module
    • logout_page()
  • swh.web.auth.utils module
    • encrypt_data()
    • decrypt_data()
    • privileged_user()
    • any_permission_required()
    • is_add_forge_now_moderator()
    • get_or_create_django_permission()
  • swh.web.auth.views module
    • oidc_generate_bearer_token()
    • oidc_generate_bearer_token_complete()
    • oidc_list_bearer_tokens()
    • oidc_get_bearer_token()
    • oidc_revoke_bearer_tokens()
    • oidc_profile_view()
• swh.web.badges package
  • swh.web.badges.urls module
  • get_logo_data()
  • swh_badge()
  • swh_badge_swhid()
• swh.web.banners package
  • swh.web.banners.urls module
  • swh.web.banners.views module
    • fundraising_banner()
    • hiring_banner()
    • downtime_banner()
• swh.web.browse package
  • swh.web.browse.views package
    • swh.web.browse.views.content module
    • swh.web.browse.views.directory module
    • swh.web.browse.views.iframe module
    • swh.web.browse.views.origin module
    • swh.web.browse.views.release module
    • swh.web.browse.views.revision module
    • swh.web.browse.views.search module
    • swh.web.browse.views.snapshot module
  • swh.web.browse.browseurls module
    • browse_route()
  • swh.web.browse.identifiers module
    • swhid_browse()
  • swh.web.browse.snapshot_context module
    • process_snapshot_branches()
    • get_snapshot_content()
    • get_origin_visit_snapshot()
    • get_snapshot_context()
    • browse_snapshot_directory()
    • browse_snapshot_log()
    • browse_snapshot_branches()
    • browse_snapshot_releases()
  • swh.web.browse.urls module
  • swh.web.browse.utils module
    • get_directory_entries()
    • get_mimetype_and_encoding_for_content()
    • re_encode_content()
    • request_content()
    • prepare_content_for_display()
    • gen_link()
    • gen_revision_url()
    • gen_revision_link()
    • gen_directory_link()
    • gen_snapshot_link()
    • gen_content_link()
    • get_revision_log_url()
    • gen_revision_log_link()
    • gen_person_mail_link()
    • gen_release_link()
    • format_log_entries()
    • get_readme_to_display()
    • pygments_iframe_height_for_content()
    • is_textual_content()
• swh.web.client package
  • swh.web.client.cli module
  • swh.web.client.client module
    • typify_json()
    • WebAPIClient
• swh.web.deposit package
  • swh.web.deposit.urls module
    • can_list_deposits()
    • admin_deposit()
    • admin_deposit_list()
• swh.web.inbound_email package
  • swh.web.inbound_email.management package
    • swh.web.inbound_email.management.commands package
  • swh.web.inbound_email.apps module
    • InboundEmailConfig
  • swh.web.inbound_email.handle_message module
    • MessageHandler
  • swh.web.inbound_email.signals module
    • email_received
    • EmailProcessingStatus
  • swh.web.inbound_email.urls module
  • swh.web.inbound_email.utils module
    • extract_recipients()
    • AddressMatch
    • single_recipient_matches()
    • recipient_matches()
    • ADDRESS_SIGNER_SEP
    • ADDRESS_SIGNER_DEFAULT
    • ADDRESS_SIGNER_SUPPORTED
    • get_address_signer()
    • get_address_for_pk()
    • get_pk_from_extension()
    • get_pks_from_message()
    • get_message_plaintext()
  • swh.web.inbound_email.views module
    • InboundEmailForm
    • InboundEmailView
• swh.web.jslicenses package
  • swh.web.jslicenses.urls module
    • jslicenses()
• swh.web.mailmap package
  • swh.web.mailmap.management package
    • swh.web.mailmap.management.commands package
  • swh.web.mailmap.apps module
    • MailmapConfig
  • swh.web.mailmap.models module
    • UserMailmapManager
    • UserMailmap
    • UserMailmapEvent
  • swh.web.mailmap.urls module
  • swh.web.mailmap.views module
    • UserMailmapSerializer
    • profile_list_mailmap()
    • profile_add_mailmap()
    • profile_update_mailmap()
    • profile_list_mailmap_datatables()
    • admin_mailmap()
• swh.web.metrics package
  • swh.web.metrics.prometheus module
    • compute_save_requests_metrics()
  • swh.web.metrics.urls module
  • swh.web.metrics.views module
    • prometheus_metrics()
• swh.web.provenance package
  • swh.web.provenance.api_views module
    • api_provenance_whereis()
    • api_provenance_whereare()
  • swh.web.provenance.apps module
    • ProvenanceConfig
  • swh.web.provenance.urls module
• swh.web.save_bulk package
  • swh.web.save_bulk.api_views module
    • OriginsDataCSVParser
    • api_origin_save_bulk()
    • SumbittedOriginInfo
    • api_origin_save_bulk_request_info()
    • api_origin_save_bulk_requests()
  • swh.web.save_bulk.apps module
    • SaveBulkConfig
  • swh.web.save_bulk.models module
    • SaveBulkRequest
    • SaveBulkOrigin
  • swh.web.save_bulk.urls module
  • swh.web.save_bulk.views module
    • api_save_bulk_origins_list()
• swh.web.save_code_now package
  • swh.web.save_code_now.management package
    • swh.web.save_code_now.management.commands package
  • swh.web.save_code_now.admin_views module
    • admin_origin_save_requests()
    • admin_origin_save_filters()
    • admin_origin_save_authorized_urls_list()
    • admin_origin_save_add_authorized_url()
    • admin_origin_save_remove_authorized_url()
    • admin_origin_save_unauthorized_urls_list()
    • admin_origin_save_add_unauthorized_url()
    • admin_origin_save_remove_unauthorized_url()
    • admin_origin_save_request_accept()
    • admin_origin_save_request_reject()
    • admin_origin_save_request_remove()
    • admin_origin_save_requests_csv_dump()
  • swh.web.save_code_now.api_views module
    • OriginSaveQuerySerializer
    • api_save_origin()
  • swh.web.save_code_now.apps module
    • SaveCodeNowConfig
  • swh.web.save_code_now.models module
    • SaveAuthorizedOrigin
    • SaveUnauthorizedOrigin
    • SaveOriginRequest
  • swh.web.save_code_now.origin_save module
    • get_origin_save_authorized_urls()
    • get_origin_save_unauthorized_urls()
    • can_save_origin()
    • get_scheduler_load_task_types()
    • get_savable_visit_types_dict()
    • get_savable_visit_types()
    • validate_origin_url()
    • origin_exists()
    • create_save_origin_request()
    • update_save_origin_requests_from_queryset()
    • get_save_origin_requests_to_update()
    • refresh_save_origin_request_statuses()
    • get_save_origin_requests()
    • get_save_origin_request()
    • get_save_origin_task_info()
    • schedule_origins_recurrent_visits()
    • has_pending_save_code_now_requests()
  • swh.web.save_code_now.origin_visit_webhook module
    • save_origin_visit_webhook()
  • swh.web.save_code_now.urls module
  • swh.web.save_code_now.views module
    • origin_save_help_view()
    • origin_save_list_view()
    • origin_save_requests_list()
    • save_origin_task_info()
• swh.web.save_origin_webhooks package
  • swh.web.save_origin_webhooks.bitbucket module
    • BitbucketOriginSaveWebhookReceiver
  • swh.web.save_origin_webhooks.forgejo module
    • ForgejoOriginSaveWebhookReceiver
  • swh.web.save_origin_webhooks.generic_receiver module
    • OriginSaveWebhookReceiver
  • swh.web.save_origin_webhooks.gitea module
    • GiteaOriginSaveWebhookReceiver
  • swh.web.save_origin_webhooks.github module
    • GitHubOriginSaveWebhookReceiver
  • swh.web.save_origin_webhooks.gitlab module
    • GitlabOriginSaveWebhookReceiver
  • swh.web.save_origin_webhooks.gogs module
    • GogsOriginSaveWebhookReceiver
  • swh.web.save_origin_webhooks.sourceforge module
    • SourceforgeOriginSaveWebhookReceiver
  • swh.web.save_origin_webhooks.urls module
• swh.web.utils package
  • swh.web.utils.management package
    • swh.web.utils.management.commands package
  • swh.web.utils.archive module
    • lookup_multiple_hashes()
    • lookup_hash()
    • search_hash()
    • lookup_content_filetype()
    • lookup_content_language()
    • lookup_content_license()
    • lookup_origin()
    • lookup_origins()
    • lookup_origin_snapshots()
    • search_origin()
    • search_origin_metadata()
    • count_origins()
    • lookup_origin_intrinsic_metadata()
    • lookup_origin_intrinsic_citation_metadata()
    • lookup_intrinsic_citation_metadata_by_target_swhid()
    • lookup_origin_extrinsic_metadata()
    • directory_exists()
    • lookup_directory()
    • lookup_directory_with_path()
    • lookup_release()
    • lookup_release_multiple()
    • lookup_revision()
    • lookup_revision_multiple()
    • lookup_revision_message()
    • lookup_revision_by()
    • lookup_revision_log()
    • lookup_revision_log_by()
    • lookup_revision_with_context_by()
    • lookup_revision_with_context()
    • lookup_directory_with_revision()
    • lookup_content()
    • stat_counters()
    • lookup_origin_visits()
    • lookup_origin_visit_latest()
    • lookup_origin_visit()
    • origin_visit_find_by_date()
    • lookup_snapshot_sizes()
    • lookup_snapshot()
    • lookup_latest_origin_snapshot()
    • lookup_snapshot_alias()
    • lookup_revision_through()
    • lookup_directory_through_revision()
    • vault_cook()
    • vault_download()
    • vault_download_url()
    • vault_progress()
    • diff_revision()
    • get_revisions_walker()
    • lookup_object()
    • lookup_known_swhids()
    • lookup_origins_by_sha1s()
    • encode_extid()
    • decode_extid()
    • lookup_extid()
    • lookup_extid_by_target()
    • lookup_raw_extrinsic_metadata()
  • swh.web.utils.bootstrap module
    • CustomValidationClassFieldRenderer
  • swh.web.utils.citation module
    • get_citation_from_origin()
    • get_citation_from_swhid()
  • swh.web.utils.converters module
    • fmap()
    • from_swh()
    • from_origin()
    • from_release()
    • SWHDjangoJSONEncoder
    • SWHMetadataEncoder
    • convert_metadata()
    • from_revision()
    • from_raw_extrinsic_metadata()
    • from_content()
    • from_person()
    • from_origin_visit()
    • from_snapshot()
    • from_partial_branches()
    • from_directory_entry()
    • from_filetype()
  • swh.web.utils.exc module
    • BadInputExc
    • NotFoundExc
    • ForbiddenExc
    • UnauthorizedExc
    • LargePayloadExc
    • masked_to_common_types()
    • swh_handle400()
    • swh_handle403()
    • swh_handle404()
    • swh_handle500()
    • sentry_capture_exception()
    • HttpResponseUnauthorized
    • HttpResponseTooManyRequests
    • handle_view_exception()
  • swh.web.utils.highlightjs module
    • get_hljs_language_from_filename()
    • get_hljs_language_from_mime_type()
    • get_supported_languages()
  • swh.web.utils.identifiers module
    • parse_object_type()
    • gen_swhid()
    • ResolvedSWHID
    • resolve_swhid()
    • get_qualified_swhid()
    • parse_core_swhid()
    • get_swhids_info()
  • swh.web.utils.middlewares module
    • ThrottlingHeadersMiddleware
    • ExceptionMiddleware
  • swh.web.utils.origin_visits module
    • get_origin_visits()
    • get_origin_visit()
  • swh.web.utils.query module
    • parse_hash()
    • parse_hash_with_algorithms_or_throws()
  • swh.web.utils.swh_templatetags module
    • docstring_display()
    • urlize_links_and_mails()
    • urlize_header_links()
    • swh_json_script()
    • sub()
    • mul()
    • key_value()
    • visit_type_savable()
    • split()
    • static_path_exists()
    • is_markdown()
    • is_notebook()
  • swh.web.utils.typing module
    • OriginInfo
    • OriginMetadataInfo
    • OriginVisitInfo
    • SnapshotBranchInfo
    • SnapshotReleaseInfo
    • SnapshotContext
    • SWHObjectInfo
    • SWHIDContext
    • SWHIDInfo
    • SWHObjectInfoMetadata
    • ContentMetadata
    • DirectoryMetadata
    • ReleaseMetadata
    • RevisionMetadata
    • SaveOriginRequestInfo
    • OriginExistenceCheckInfo
    • IntrinsicMetadataFiletype
    • IntrinsicMetadataFile
    • Citation
  • swh.web.utils.url_path_converters module
    • SWHIDConverter
    • register_url_path_converters()
  • swh.web.utils.urlsindex module
    • UrlsIndex
  • reverse()
  • datetime_to_utc()
  • parse_iso8601_date_to_utc()
  • shorten_path()
  • format_utc_iso_date()
  • gen_path_info()
  • parse_rst()
  • get_client_ip()
  • webpack_stats()
  • mathjax_js_library()
  • context_processor()
  • resolve_branch_alias()
  • rst_to_html()
  • cache_set()
  • cache_get()
  • django_cache()
  • origin_visit_types()
  • redirect_to_new_route()
  • demangle_url()
  • datatables_order_params()
  • datatables_pagination_params()
  • strtobool()
• swh.web.vault package
  • swh.web.vault.api_views module
    • api_vault_cook_flat()
    • api_vault_cook_directory()
    • api_vault_download_flat()
    • api_vault_download_directory()
    • api_vault_cook_gitfast()
    • api_vault_cook_revision_gitfast()
    • api_vault_download_revision_gitfast()
    • api_vault_cook_git_bare()
    • api_vault_download_revision_git_bare()
  • swh.web.vault.urls module
    • vault_view()
    • browse_vault_view()
• swh.web.webapp package
  • swh.web.webapp.urls module
    • default_view()

Submodules:

• swh.web.config module
  • ConfigurationError
  • SWHWebConfig
  • get_config()
  • oidc_enabled()
  • search()
  • storage()
  • vault()
  • indexer_storage()
  • scheduler()
  • counters()
• swh.web.gunicorn_config module
  • post_fork()
• swh.web.manage module
• swh.web.urls module
  • insecure_serve()

Module contents: