Skip to content

Ip

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

::

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

Provides the IP availability checker.

Author: Nissar Chababy, @funilrys, contactTATAfunilrysTODTODcom

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

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

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

Project documentation: https://docs.pyfunceble.com

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

License: ::

Copyright 2017, 2018, 2019, 2020, 2022, 2023, 2024 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

    https://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.

IPAvailabilityChecker

Bases: AvailabilityCheckerBase

Provides the interface for checking the availability of a given IP.

Parameters:

Name Type Description Default
subject str

Optional, The subject to work with.

None
use_extra_rules bool

Optional, Activates/Disables the usage of our own set of extra rules.

None
use_whois_lookup bool

Optional, Activates/Disables the usage of the WHOIS lookup to gather the status of the given :code:subject.

None
use_dns_lookup bool

Optional, Activates/Disables the usage of the DNS lookup to gather the status of the given :code:subject.

None
use_netinfo_lookup bool

Optional, Activates/Disables the usage of the network information lookup module to gather the status of the given :code:subject.

None
use_http_code_lookup bool

Optional, Activates/Disables the usage of the HTTP status code lookup to gather the status of the given :code:subject.

None
use_reputation_lookup bool

Optional, Activates/Disables the usage of the reputation dataset lookup to gather the status of the given :code:subject.

None
do_syntax_check_first bool

Optional, Activates/Disables the check of the status before the actual status gathering.

None
use_whois_db bool

Optional, Activates/Disable the usage of a local database to store the WHOIS datasets.

None
Source code in PyFunceble/checker/availability/ip.py
class IPAvailabilityChecker(AvailabilityCheckerBase):
    """
    Provides the interface for checking the availability of a given IP.

    :param str subject:
        Optional, The subject to work with.
    :param bool use_extra_rules:
        Optional, Activates/Disables the usage of our own set of extra rules.
    :param bool use_whois_lookup:
        Optional, Activates/Disables the usage of the WHOIS lookup to gather
        the status of the given :code:`subject`.
    :param bool use_dns_lookup:
        Optional, Activates/Disables the usage of the DNS lookup to gather the
        status of the given :code:`subject`.
    :param bool use_netinfo_lookup:
        Optional, Activates/Disables the usage of the network information
        lookup module to gather the status of the given :code:`subject`.
    :param bool use_http_code_lookup:
        Optional, Activates/Disables the usage of the HTTP status code lookup
        to gather the status of the given :code:`subject`.
    :param bool use_reputation_lookup:
        Optional, Activates/Disables the usage of the reputation dataset
        lookup to gather the status of the given :code:`subject`.
    :param bool do_syntax_check_first:
        Optional, Activates/Disables the check of the status before the actual
        status gathering.
    :param bool use_whois_db:
        Optional, Activates/Disable the usage of a local database to store the
        WHOIS datasets.
    """

    def try_to_query_status_from_reputation(self) -> "IPAvailabilityChecker":
        """
        Tries to query the status from the reputation lookup.
        """

        PyFunceble.facility.Logger.info(
            "Started to try to query the status of %r from: Reputation Lookup",
            self.status.idna_subject,
        )

        lookup_result = IPReputationChecker(self.status.idna_subject).get_status()

        # pylint: disable=no-member
        if lookup_result and lookup_result.is_malicious():
            self.status.status = PyFunceble.storage.STATUS.up
            self.status.status_source = "REPUTATION"

            PyFunceble.facility.Logger.info(
                "Could define the status of %r from: Reputation Lookup",
                self.status.idna_subject,
            )

        PyFunceble.facility.Logger.info(
            "Started to try to query the status of %r from: Reputation Lookup",
            self.status.idna_subject,
        )

        return self

    @AvailabilityCheckerBase.ensure_subject_is_given
    @AvailabilityCheckerBase.update_status_date_after_query
    def query_status(
        self,
    ) -> "IPAvailabilityChecker":  # pragma: no cover
        """
        Queries the result without anything more.
        """

        ## Test Methods are more important.

        status_post_syntax_checker = None

        if self.do_syntax_check_first and self.should_we_continue_test(
            status_post_syntax_checker
        ):
            self.try_to_query_status_from_syntax_lookup()

            if self.status.status:
                status_post_syntax_checker = self.status.status

        if self.use_dns_lookup and self.should_we_continue_test(
            status_post_syntax_checker
        ):
            self.try_to_query_status_from_dns()

        if self.use_netinfo_lookup and self.should_we_continue_test(
            status_post_syntax_checker
        ):
            self.try_to_query_status_from_netinfo()

        if self.use_reputation_lookup and self.should_we_continue_test(
            status_post_syntax_checker
        ):
            self.try_to_query_status_from_reputation()

        if self.use_http_code_lookup and self.should_we_continue_test(
            status_post_syntax_checker
        ):
            self.try_to_query_status_from_http_status_code()

        if not self.status.status:
            self.status.status = PyFunceble.storage.STATUS.down
            self.status.status_source = "STDLOOKUP"

            PyFunceble.facility.Logger.info(
                "Could not define status the status of %r. Setting to %r",
                self.status.idna_subject,
                self.status.status,
            )

        if self.use_extra_rules:
            self.try_to_query_status_from_extra_rules()

        return self

    @staticmethod
    def is_valid() -> bool:  # pylint: disable=arguments-differ
        raise NotImplementedError()

query_status()

Queries the result without anything more.

Source code in PyFunceble/checker/availability/ip.py
@AvailabilityCheckerBase.ensure_subject_is_given
@AvailabilityCheckerBase.update_status_date_after_query
def query_status(
    self,
) -> "IPAvailabilityChecker":  # pragma: no cover
    """
    Queries the result without anything more.
    """

    ## Test Methods are more important.

    status_post_syntax_checker = None

    if self.do_syntax_check_first and self.should_we_continue_test(
        status_post_syntax_checker
    ):
        self.try_to_query_status_from_syntax_lookup()

        if self.status.status:
            status_post_syntax_checker = self.status.status

    if self.use_dns_lookup and self.should_we_continue_test(
        status_post_syntax_checker
    ):
        self.try_to_query_status_from_dns()

    if self.use_netinfo_lookup and self.should_we_continue_test(
        status_post_syntax_checker
    ):
        self.try_to_query_status_from_netinfo()

    if self.use_reputation_lookup and self.should_we_continue_test(
        status_post_syntax_checker
    ):
        self.try_to_query_status_from_reputation()

    if self.use_http_code_lookup and self.should_we_continue_test(
        status_post_syntax_checker
    ):
        self.try_to_query_status_from_http_status_code()

    if not self.status.status:
        self.status.status = PyFunceble.storage.STATUS.down
        self.status.status_source = "STDLOOKUP"

        PyFunceble.facility.Logger.info(
            "Could not define status the status of %r. Setting to %r",
            self.status.idna_subject,
            self.status.status,
        )

    if self.use_extra_rules:
        self.try_to_query_status_from_extra_rules()

    return self

try_to_query_status_from_reputation()

Tries to query the status from the reputation lookup.

Source code in PyFunceble/checker/availability/ip.py
def try_to_query_status_from_reputation(self) -> "IPAvailabilityChecker":
    """
    Tries to query the status from the reputation lookup.
    """

    PyFunceble.facility.Logger.info(
        "Started to try to query the status of %r from: Reputation Lookup",
        self.status.idna_subject,
    )

    lookup_result = IPReputationChecker(self.status.idna_subject).get_status()

    # pylint: disable=no-member
    if lookup_result and lookup_result.is_malicious():
        self.status.status = PyFunceble.storage.STATUS.up
        self.status.status_source = "REPUTATION"

        PyFunceble.facility.Logger.info(
            "Could define the status of %r from: Reputation Lookup",
            self.status.idna_subject,
        )

    PyFunceble.facility.Logger.info(
        "Started to try to query the status of %r from: Reputation Lookup",
        self.status.idna_subject,
    )

    return self