Source code for PyFunceble.status.availability.url

"""
The tool to check the availability or syntax of domain, IP or URL.

::


    ██████╗ ██╗   ██╗███████╗██╗   ██╗███╗   ██╗ ██████╗███████╗██████╗ ██╗     ███████╗
    ██╔══██╗╚██╗ ██╔╝██╔════╝██║   ██║████╗  ██║██╔════╝██╔════╝██╔══██╗██║     ██╔════╝
    ██████╔╝ ╚████╔╝ █████╗  ██║   ██║██╔██╗ ██║██║     █████╗  ██████╔╝██║     █████╗
    ██╔═══╝   ╚██╔╝  ██╔══╝  ██║   ██║██║╚██╗██║██║     ██╔══╝  ██╔══██╗██║     ██╔══╝
    ██║        ██║   ██║     ╚██████╔╝██║ ╚████║╚██████╗███████╗██████╔╝███████╗███████╗
    ╚═╝        ╚═╝   ╚═╝      ╚═════╝ ╚═╝  ╚═══╝ ╚═════╝╚══════╝╚═════╝ ╚══════╝╚══════╝

Provides the status interface for URL availability check.

Author:
    Nissar Chababy, @funilrys, contactTATAfunilrysTODTODcom

Special thanks:
    https://pyfunceble.github.io/special-thanks.html

Contributors:
    https://pyfunceble.github.io/contributors.html

Project link:
    https://github.com/funilrys/PyFunceble

Project documentation:
    https://pyfunceble.readthedocs.io/en/master/

Project homepage:
    https://pyfunceble.github.io/

License:
::


    Copyright 2017, 2018, 2019, 2020 Nissar Chababy

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

        http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
"""

import PyFunceble

from ..gatherer_base import GathererBase


[docs]class Url(GathererBase): """ Gather the availability of the given URL. """ # pylint: disable=no-member def __init__(self, subject, filename=None, whois_db=None, inactive_db=None): super().__init__( subject, filename=filename, whois_db=whois_db, inactive_db=inactive_db ) self.subject_type += "url" # We initiate the list of active status code. self.active_list = [] self.active_list.extend(PyFunceble.HTTP_CODE.list.potentially_up) self.active_list.extend(PyFunceble.HTTP_CODE.list.up) # We initiate the list of inactive status code. self.inactive_list = [] self.inactive_list.extend(PyFunceble.HTTP_CODE.list.potentially_down) self.inactive_list.append(PyFunceble.HTTP_CODE.not_found_default) self.__gather() def __gather(self): """ Process the gathering. """ self.gather_http_status_code() self.status["_status_source"] = self.status.status_source = "HTTP Code" if PyFunceble.CONFIGURATION.local or self.status.url_syntax_validation: if self.status.http_status_code in self.active_list: self.status[ "_status" ] = self.status.status = PyFunceble.STATUS.official.up elif self.status.http_status_code in self.inactive_list: self.status[ "_status" ] = self.status.status = PyFunceble.STATUS.official.down else: self.status["_status_source"] = self.status.status_source = "SYNTAX" self.status[ "_status" ] = self.status.status = PyFunceble.STATUS.official.invalid PyFunceble.output.Generate( self.subject, self.subject_type, self.status.status, source=self.status.status_source, http_status_code=self.status.http_status_code, filename=self.filename, ).status_file( exclude_file_generation=( self.exclude_file_generation and self.status.status not in [PyFunceble.STATUS.official.up] ) ) PyFunceble.LOGGER.debug(f"[{self.subject}] State:\n{self.status.get()}")